1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
|
/* Copyright 2013-2014 IBM Corp.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
* implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
#undef DEBUG
#include <opal.h>
#include <lock.h>
#include <chip.h>
#include <i2c.h>
#include <xscom.h>
#include <timebase.h>
#include <timer.h>
#ifdef DEBUG
#define DBG(fmt...) prlog(PR_ERR, "I2C: " fmt)
#define I2C_TIMEOUT_IRQ_MS 100 /* 100ms/byte timeout */
#define I2C_TIMEOUT_POLL_MS 4000 /* 4s/byte timeout */
#else
#define DBG(fmt...) prlog(PR_TRACE, "I2C: " fmt)
#define I2C_TIMEOUT_IRQ_MS 1 /* 1ms/byte timeout */
#define I2C_TIMEOUT_POLL_MS 4000 /* 4s/byte timeout */
#endif
#define USEC_PER_SEC 1000000
#define USEC_PER_MSEC 1000
#define I2C_RESET_DELAY_MS 5 /* 5 msecs */
#define I2C_FIFO_HI_LVL 4
#define I2C_FIFO_LO_LVL 4
#define I2C_PAGE_WRITE_SIZE (0x1u << 8)
#define I2C_PAGE_WRITE_MASK (I2C_PAGE_WRITE_SIZE - 1)
/*
* I2C registers set.
* Below is the offset of registers from base which is stored in the
* 'struct p8_i2c_master'
*/
/* I2C FIFO register */
#define I2C_FIFO_REG 0x4
#define I2C_FIFO_MASK PPC_BITMASK(0, 7)
#define I2C_FIFO_LSH PPC_BITLSHIFT(7)
/* I2C command register */
#define I2C_CMD_REG 0x5
#define I2C_CMD_WITH_START PPC_BIT(0)
#define I2C_CMD_WITH_ADDR PPC_BIT(1)
#define I2C_CMD_READ_CONT PPC_BIT(2)
#define I2C_CMD_WITH_STOP PPC_BIT(3)
#define I2C_CMD_DEV_ADDR_MASK PPC_BITMASK(8, 14)
#define I2C_CMD_DEV_ADDR_LSH PPC_BITLSHIFT(14)
#define I2C_CMD_READ_NOT_WRITE PPC_BIT(15)
#define I2C_CMD_LEN_BYTES_MASK PPC_BITMASK(16, 31)
#define I2C_CMD_LEN_BYTES_LSH PPC_BITLSHIFT(31)
#define I2C_MAX_TFR_LEN 0xfff0ull
/* I2C mode register */
#define I2C_MODE_REG 0x6
#define I2C_MODE_BIT_RATE_DIV_MASK PPC_BITMASK(0, 15)
#define I2C_MODE_BIT_RATE_DIV_LSH PPC_BITLSHIFT(15)
#define I2C_MODE_PORT_NUM_MASK PPC_BITMASK(16, 21)
#define I2C_MODE_PORT_NUM_LSH PPC_BITLSHIFT(21)
#define I2C_MODE_ENHANCED PPC_BIT(28)
#define I2C_MODE_DIAGNOSTIC PPC_BIT(29)
#define I2C_MODE_PACING_ALLOW PPC_BIT(30)
#define I2C_MODE_WRAP PPC_BIT(31)
/* I2C watermark register */
#define I2C_WATERMARK_REG 0x7
#define I2C_WATERMARK_HIGH_MASK PPC_BITMASK(16, 19)
#define I2C_WATERMARK_HIGH_LSH PPC_BITLSHIFT(19)
#define I2C_WATERMARK_LOW_MASK PPC_BITMASK(24, 27)
#define I2C_WATERMARK_LOW_LSH PPC_BITLSHIFT(27)
/* I2C interrupt mask, condition and interrupt registers */
#define I2C_INTR_MASK_REG 0x8
#define I2C_INTR_COND_REG 0x9
#define I2C_INTR_REG 0xa
#define I2C_INTR_ALL_MASK PPC_BITMASK(16, 31)
#define I2C_INTR_ALL_LSH PPC_BITLSHIFT(31)
#define I2C_INTR_INVALID_CMD PPC_BIT(16)
#define I2C_INTR_LBUS_PARITY_ERR PPC_BIT(17)
#define I2C_INTR_BKEND_OVERRUN_ERR PPC_BIT(18)
#define I2C_INTR_BKEND_ACCESS_ERR PPC_BIT(19)
#define I2C_INTR_ARBT_LOST_ERR PPC_BIT(20)
#define I2C_INTR_NACK_RCVD_ERR PPC_BIT(21)
#define I2C_INTR_DATA_REQ PPC_BIT(22)
#define I2C_INTR_CMD_COMP PPC_BIT(23)
#define I2C_INTR_STOP_ERR PPC_BIT(24)
#define I2C_INTR_I2C_BUSY PPC_BIT(25)
#define I2C_INTR_NOT_I2C_BUSY PPC_BIT(26)
#define I2C_INTR_SCL_EQ_1 PPC_BIT(28)
#define I2C_INTR_SCL_EQ_0 PPC_BIT(29)
#define I2C_INTR_SDA_EQ_1 PPC_BIT(30)
#define I2C_INTR_SDA_EQ_0 PPC_BIT(31)
/* I2C status register */
#define I2C_RESET_I2C_REG 0xb
#define I2C_RESET_ERRORS 0xc
#define I2C_STAT_REG 0xb
#define I2C_STAT_INVALID_CMD PPC_BIT(0)
#define I2C_STAT_LBUS_PARITY_ERR PPC_BIT(1)
#define I2C_STAT_BKEND_OVERRUN_ERR PPC_BIT(2)
#define I2C_STAT_BKEND_ACCESS_ERR PPC_BIT(3)
#define I2C_STAT_ARBT_LOST_ERR PPC_BIT(4)
#define I2C_STAT_NACK_RCVD_ERR PPC_BIT(5)
#define I2C_STAT_DATA_REQ PPC_BIT(6)
#define I2C_STAT_CMD_COMP PPC_BIT(7)
#define I2C_STAT_STOP_ERR PPC_BIT(8)
#define I2C_STAT_UPPER_THRS_MASK PPC_BITMASK(9, 15)
#define I2C_STAT_UPPER_THRS_LSH PPC_BITLSHIFT(15)
#define I2C_STAT_ANY_I2C_INTR PPC_BIT(16)
#define I2C_STAT_PORT_HISTORY_BUSY PPC_BIT(19)
#define I2C_STAT_SCL_INPUT_LEVEL PPC_BIT(20)
#define I2C_STAT_SDA_INPUT_LEVEL PPC_BIT(21)
#define I2C_STAT_PORT_BUSY PPC_BIT(22)
#define I2C_STAT_INTERFACE_BUSY PPC_BIT(23)
#define I2C_STAT_FIFO_ENTRY_COUNT_MASK PPC_BITMASK(24, 31)
#define I2C_STAT_FIFO_ENTRY_COUNT_LSH PPC_BITLSHIFT(31)
#define I2C_STAT_ANY_ERR (I2C_STAT_INVALID_CMD | I2C_STAT_LBUS_PARITY_ERR | \
I2C_STAT_BKEND_OVERRUN_ERR | \
I2C_STAT_BKEND_ACCESS_ERR | I2C_STAT_ARBT_LOST_ERR | \
I2C_STAT_NACK_RCVD_ERR | I2C_STAT_STOP_ERR)
/* I2C extended status register */
#define I2C_EXTD_STAT_REG 0xc
#define I2C_EXTD_STAT_FIFO_SIZE_MASK PPC_BITMASK(0, 7)
#define I2C_EXTD_STAT_FIFO_SIZE_LSH PPC_BITLSHIFT(7)
#define I2C_EXTD_STAT_MSM_CURSTATE_MASK PPC_BITMASK(11, 15)
#define I2C_EXTD_STAT_MSM_CURSTATE_LSH PPC_BITLSHIFT(15)
#define I2C_EXTD_STAT_SCL_IN_SYNC PPC_BIT(16)
#define I2C_EXTD_STAT_SDA_IN_SYNC PPC_BIT(17)
#define I2C_EXTD_STAT_S_SCL PPC_BIT(18)
#define I2C_EXTD_STAT_S_SDA PPC_BIT(19)
#define I2C_EXTD_STAT_M_SCL PPC_BIT(20)
#define I2C_EXTD_STAT_M_SDA PPC_BIT(21)
#define I2C_EXTD_STAT_HIGH_WATER PPC_BIT(22)
#define I2C_EXTD_STAT_LOW_WATER PPC_BIT(23)
#define I2C_EXTD_STAT_I2C_BUSY PPC_BIT(24)
#define I2C_EXTD_STAT_SELF_BUSY PPC_BIT(25)
#define I2C_EXTD_STAT_I2C_VERSION_MASK PPC_BITMASK(27, 31)
#define I2C_EXTD_STAT_I2C_VERSION_LSH PPC_BITLSHIFT(31)
/* I2C residual front end/back end length */
#define I2C_RESIDUAL_LEN_REG 0xd
#define I2C_RESIDUAL_FRONT_END_MASK PPC_BITMASK(0, 15)
#define I2C_RESIDUAL_FRONT_END_LSH PPC_BITLSHIFT(15)
#define I2C_RESIDUAL_BACK_END_MASK PPC_BITMASK(16, 31)
#define I2C_RESIDUAL_BACK_END_LSH PPC_BITLSHIFT(31)
/* Port busy register */
#define I2C_PORT_BUYS_REG 0xe
struct p8_i2c_master {
struct lock lock; /* Lock to guard the members */
uint64_t poll_timer; /* Poll timer expiration */
uint64_t poll_interval; /* Polling interval in usec */
uint64_t xscom_base; /* xscom base of i2cm */
uint32_t bit_rate_div; /* Divisor to set bus speed*/
uint32_t fifo_size; /* Maximum size of FIFO */
uint32_t chip_id; /* Chip the i2cm sits on */
uint8_t obuf[4]; /* Offset buffer */
uint32_t bytes_sent;
bool irq_ok; /* Interrupt working ? */
enum request_state {
state_idle,
state_offset,
state_data,
state_error,
state_recovery,
} state;
struct list_head req_list; /* Request queue head */
struct timer poller;
struct timer timeout;
};
struct p8_i2c_master_port {
struct i2c_bus bus; /* Abstract bus struct for the client */
struct p8_i2c_master *common;
uint32_t port_num;
};
struct p8_i2c_request {
struct i2c_request req;
uint32_t port_num;
uint64_t timeout;
};
static bool p8_i2c_has_irqs(void)
{
struct proc_chip *chip = next_chip(NULL);
/* The i2c interrurpt was only added to Murano DD2.1 and Venice
* DD2.0. When operating without interrupts, we need to bump the
* timeouts as we rely solely on the polls from Linux which can
* be up to 2s appart !
*
* Also we don't have interrupts for the Centaur i2c.
*/
switch (chip->type) {
case PROC_CHIP_P8_MURANO:
return chip->ec_level >= 0x21;
case PROC_CHIP_P8_VENICE:
return chip->ec_level >= 0x20;
default:
return false;
}
}
static int p8_i2c_enable_irqs(struct p8_i2c_master *master)
{
int rc;
/* Enable the interrupts */
rc = xscom_write(master->chip_id, master->xscom_base +
I2C_INTR_COND_REG, I2C_STAT_ANY_ERR >> 16 |
I2C_INTR_CMD_COMP | I2C_INTR_DATA_REQ);
if (rc)
prlog(PR_ERR, "I2C: Failed to enable the interrupts\n");
return rc;
}
static int p8_i2c_prog_watermark(struct p8_i2c_master *master)
{
uint64_t watermark;
int rc;
rc = xscom_read(master->chip_id, master->xscom_base + I2C_WATERMARK_REG,
&watermark);
if (rc) {
prlog(PR_ERR, "I2C: Failed to read the WATERMARK_REG\n");
return OPAL_HARDWARE;
}
/* Set the high/low watermark */
watermark = SETFIELD(I2C_WATERMARK_HIGH, watermark, I2C_FIFO_HI_LVL);
watermark = SETFIELD(I2C_WATERMARK_LOW, watermark, I2C_FIFO_LO_LVL);
rc = xscom_write(master->chip_id, master->xscom_base +
I2C_WATERMARK_REG, watermark);
if (rc) {
prlog(PR_ERR, "I2C: Failed to set high/low watermark level\n");
return OPAL_HARDWARE;
}
return 0;
}
static int p8_i2c_prog_mode(struct p8_i2c_master *master, bool enhanced_mode)
{
struct i2c_request *req = list_top(&master->req_list,
struct i2c_request, link);
struct p8_i2c_request *request =
container_of(req, struct p8_i2c_request, req);
uint64_t mode, omode;
int rc;
rc = xscom_read(master->chip_id, master->xscom_base +
I2C_MODE_REG, &mode);
if (rc) {
prlog(PR_ERR, "I2C: Failed to read the MODE_REG\n");
return OPAL_HARDWARE;
}
omode = mode;
mode = SETFIELD(I2C_MODE_PORT_NUM, mode, request->port_num);
mode = SETFIELD(I2C_MODE_BIT_RATE_DIV, mode, master->bit_rate_div);
if (enhanced_mode)
mode |= I2C_MODE_ENHANCED;
else
mode &= ~I2C_MODE_ENHANCED;
if (mode == omode)
return 0;
rc = xscom_write(master->chip_id, master->xscom_base + I2C_MODE_REG,
mode);
if (rc) {
prlog(PR_ERR, "I2C: Failed to write the MODE_REG\n");
return OPAL_HARDWARE;
}
return 0;
}
static void p8_i2c_complete_request(struct p8_i2c_master *master,
struct i2c_request *req, int ret)
{
/* We only complete the current top level request */
assert(req == list_top(&master->req_list, struct i2c_request, link));
cancel_timer_async(&master->timeout);
list_del(&req->link);
master->state = state_idle;
unlock(&master->lock);
if (req->completion)
req->completion(ret, req);
/* req might have been freed at this point */
lock(&master->lock);
}
static int p8_i2c_engine_reset(struct p8_i2c_master *master)
{
int rc;
/* Reset the i2c engine */
rc = xscom_write(master->chip_id, master->xscom_base +
I2C_RESET_I2C_REG, 0);
if (rc) {
prlog(PR_ERR, "I2C: Failed to reset the i2c engine\n");
return rc;
}
/* Reprogram the watermark and mode */
rc = p8_i2c_prog_watermark(master);
if (rc == 0)
rc = p8_i2c_prog_mode(master, false);
return rc;
}
static void p8_i2c_status_error(struct p8_i2c_master *master,
struct i2c_request *req,
uint64_t status)
{
int rc;
uint64_t estat;
/* Display any error other than I2C_INTR_NACK_RCVD_ERR since
* getting NACK's is normal if Linux is probing the bus
*/
if ((status & I2C_STAT_ANY_ERR) != I2C_STAT_NACK_RCVD_ERR)
prlog(PR_ERR, "I2C: Transfer error occured, "
"sreg=0x%016llx, state=%d\n",
status, master->state);
rc = p8_i2c_engine_reset(master);
if (rc)
goto exit;
if (status & (I2C_STAT_LBUS_PARITY_ERR | I2C_STAT_ARBT_LOST_ERR |
I2C_STAT_STOP_ERR)) {
/*
* For those errors, we also grab the extended status reg
* in order to display it
*/
rc = xscom_read(master->chip_id,
master->xscom_base + I2C_EXTD_STAT_REG,
&estat);
if (rc)
prlog(PR_ERR, "I2C: Failed to grab extende status\n");
else
prlog(PR_ERR, "I2C: Extended status=%016llx\n", estat);
/*
* Don't bother issuing a STOP command for those errors
* just get rid of the current request and start off with
* the fresh one in the list
*/
p8_i2c_complete_request(master, req, OPAL_HARDWARE);
} else {
/*
* Reset the bus by issuing a STOP command to slave.
*
* Reprogram the mode register with 'enhanced bit' set
*/
rc = p8_i2c_prog_mode(master, true);
if (rc)
goto exit;
/* Enable the interrupt */
p8_i2c_enable_irqs(master);
/* Send an immediate stop */
master->state = state_error;
rc = xscom_write(master->chip_id, master->xscom_base +
I2C_CMD_REG, I2C_CMD_WITH_STOP);
if (rc) {
prlog(PR_ERR, "I2C: Failed to issue imm. STOP\n");
goto exit;
}
}
return;
exit:
p8_i2c_complete_request(master, req, rc);
}
static int p8_i2c_fifo_read(struct p8_i2c_master *master,
uint8_t *buf, uint32_t count)
{
uint64_t fifo;
uint32_t i;
int rc = 0;
for (i = 0; i < count; i++, buf++) {
rc = xscom_read(master->chip_id, master->xscom_base +
I2C_FIFO_REG, &fifo);
if (rc) {
prlog(PR_ERR, "I2C: Failed to read the fifo\n");
break;
}
*buf = GETFIELD(I2C_FIFO, fifo);
}
return rc;
}
static int p8_i2c_fifo_write(struct p8_i2c_master *master,
uint8_t *buf, uint32_t count)
{
uint64_t fifo;
uint32_t i;
int rc = 0;
for (i = 0; i < count; i++, buf++) {
fifo = SETFIELD(I2C_FIFO, 0ull, *buf);
rc = xscom_write(master->chip_id, master->xscom_base +
I2C_FIFO_REG, fifo);
if (rc) {
prlog(PR_ERR, "I2C: Failed to write the fifo\n");
break;
}
}
return rc;
}
static void p8_i2c_status_data_request(struct p8_i2c_master *master,
struct i2c_request *req,
uint64_t status)
{
uint32_t fifo_count, fifo_free, count;
uint8_t *buf;
int rc = 0;
fifo_count = GETFIELD(I2C_STAT_FIFO_ENTRY_COUNT, status);
fifo_free = master->fifo_size - fifo_count;
DBG("Data request, state=%d fifo_count=%d/%d bytes_sent=%d\n",
master->state, fifo_count, master->fifo_size, master->bytes_sent);
switch(master->state) {
case state_offset:
/* We assume the offset can always be written in one go */
if (fifo_free < req->offset_bytes) {
prlog(PR_ERR, "I2C: Fifo too small for offset !\n");
rc = OPAL_HARDWARE;
} else {
rc = p8_i2c_fifo_write(master, master->obuf,
req->offset_bytes);
}
/* For writes, transition to data phase now */
if (rc == 0 && req->op == SMBUS_WRITE)
master->state = state_data;
break;
case state_data:
/* Sanity check */
if (master->bytes_sent >= req->rw_len) {
prlog(PR_ERR, "I2C: Data req with no data to send"
" sent=%d req=%d\n", master->bytes_sent,
req->rw_len);
rc = OPAL_HARDWARE;
break;
}
/* Get next chunk */
buf = req->rw_buf + master->bytes_sent;
count = req->rw_len - master->bytes_sent;
/* Check direction */
if (req->op == I2C_READ || req->op == SMBUS_READ) {
if (count > fifo_count)
count = fifo_count;
rc = p8_i2c_fifo_read(master, buf, count);
} else {
if (count > fifo_free)
count = fifo_free;
rc = p8_i2c_fifo_write(master, buf, count);
}
if (rc == 0)
master->bytes_sent += count;
break;
default:
prlog(PR_ERR, "I2C: Invalid state %d in data req !\n",
master->state);
rc = OPAL_HARDWARE;
}
if (rc)
p8_i2c_complete_request(master, req, rc);
else
p8_i2c_enable_irqs(master);
}
static void p8_i2c_complete_offset(struct p8_i2c_master *master,
struct i2c_request *req)
{
uint64_t cmd;
int rc = 0;
DBG("Completing offset phase\n");
/* If it's a write, we should only get here for empty
* write commands
*/
if (req->op == SMBUS_WRITE && req->rw_len != 0) {
prlog(PR_ERR, "I2C: Write completion in offset state !\n");
rc = OPAL_HARDWARE;
goto complete;
}
/* Switch to data phase */
master->state = state_data;
/* If it's not a read command, or there are no data to read,
* then we complete the command
*/
if (req->op != SMBUS_READ || req->rw_len == 0)
goto complete;
/* Otherwise, let's start the data phase */
cmd = I2C_CMD_WITH_START | I2C_CMD_WITH_ADDR |
I2C_CMD_WITH_STOP | I2C_CMD_READ_NOT_WRITE;
cmd = SETFIELD(I2C_CMD_DEV_ADDR, cmd, req->dev_addr);
cmd = SETFIELD(I2C_CMD_LEN_BYTES, cmd, req->rw_len);
DBG("Command: %016llx, state: %d\n", cmd, master->state);
/* Send command */
rc = xscom_write(master->chip_id, master->xscom_base + I2C_CMD_REG,
cmd);
if (rc) {
prlog(PR_ERR, "I2C: Failed to write the CMD_REG\n");
rc = OPAL_HARDWARE;
goto complete;
}
/* Enable the interrupts */
p8_i2c_enable_irqs(master);
return;
complete:
p8_i2c_complete_request(master, req, rc);
}
static void p8_i2c_status_cmd_completion(struct p8_i2c_master *master,
struct i2c_request *req)
{
int rc;
DBG("Command completion, state=%d bytes_sent=%d\n",
master->state, master->bytes_sent);
/* If we complete an offset, we probably need to transition
* do a data read, check if that all makes sense
*/
if (master->state == state_offset) {
p8_i2c_complete_offset(master, req);
return;
}
/* If we are not already in error state, check if we have
* completed our data transfer properly
*/
if (master->state != state_error && master->bytes_sent != req->rw_len) {
prlog(PR_ERR, "I2C: Request complete with residual data"
" req=%d done=%d\n", req->rw_len, master->bytes_sent);
/* Should we error out here ? */
}
rc = master->state == state_error ? OPAL_HARDWARE : OPAL_SUCCESS;
p8_i2c_complete_request(master, req, rc);
}
static void p8_i2c_check_status(struct p8_i2c_master *master)
{
struct i2c_request *req = list_top(&master->req_list,
struct i2c_request, link);
uint64_t status;
int rc;
/* If we are idle, just return, we'll catch error conditions
* when we next try to enqueue a request
*/
if (master->state == state_idle)
return;
/* Read status register */
rc = xscom_read(master->chip_id, master->xscom_base + I2C_STAT_REG,
&status);
if (rc) {
prlog(PR_ERR, "I2C: Failed to read the STAT_REG\n");
return;
}
/* Nothing happened ? Go back */
if (!(status & (I2C_STAT_ANY_ERR | I2C_STAT_DATA_REQ |
I2C_STAT_CMD_COMP)))
return;
DBG("Non-0 status: %016llx\n", status);
/* Mask the interrupts for this engine */
rc = xscom_write(master->chip_id, master->xscom_base + I2C_INTR_REG,
~I2C_INTR_ALL_MASK);
if (rc) {
prlog(PR_ERR, "I2C: Failed to disable the interrupts\n");
return;
}
/* No request ? That's not normal ! Bail out without re-enabling
* the interrupt
*/
if (req == NULL) {
prlog(PR_ERR, "I2C: Interrupt with no request,status=%016llx\n",
status);
return;
}
/* Handle the status in that order: errors, data requests and
* command completion.
*/
if (status & I2C_STAT_ANY_ERR)
p8_i2c_status_error(master, req, status);
else if (status & I2C_STAT_DATA_REQ)
p8_i2c_status_data_request(master, req, status);
else if (status & I2C_STAT_CMD_COMP)
p8_i2c_status_cmd_completion(master, req);
}
static int p8_i2c_check_initial_status(struct p8_i2c_master *master)
{
int rc, pass = 0;
uint64_t status, estat;
retry:
/* Read status register */
rc = xscom_read(master->chip_id, master->xscom_base + I2C_STAT_REG,
&status);
if (rc) {
prlog(PR_ERR, "I2C: Failed to read the STAT_REG\n");
return rc;
}
rc = xscom_read(master->chip_id,
master->xscom_base + I2C_EXTD_STAT_REG,
&estat);
if (rc) {
prlog(PR_ERR, "I2C: Failed to read the EXTD_STAT_REG\n");
return rc;
}
if (estat & (I2C_EXTD_STAT_I2C_BUSY | I2C_EXTD_STAT_SELF_BUSY)) {
DBG("Initial estat busy ! %016llx\n", estat);
/* Just a warning for now */
}
/* Nothing happened ? Go back */
if (status & I2C_STAT_ANY_ERR) {
prlog(PR_ERR, "I2C: Initial error status %016llx\n", status);
if (pass > 0) {
prlog(PR_ERR, "I2C: Error stuck, aborting\n");
return OPAL_HARDWARE;
}
/* Mark state as "recovery" to block any other activity */
master->state = state_recovery;
/* Reset the engine */
p8_i2c_engine_reset(master);
/* Some delay XXX use state machine to avoid blocking OS */
unlock(&master->lock);
time_wait_ms(5);
lock(&master->lock);
master->state = state_idle;
pass++;
goto retry;
}
/* Still busy ? */
if (!(status & I2C_STAT_CMD_COMP)) {
prlog(PR_ERR, "I2C: Initial commmand complete not set\n");
if (pass > 4) {
prlog(PR_ERR, "I2C: Command stuck, aborting\n");
return OPAL_HARDWARE;
}
master->state = state_recovery;
/* Some delay XXX use state machine to avoid blocking OS */
unlock(&master->lock);
time_wait_ms(5);
lock(&master->lock);
master->state = state_idle;
pass++;
goto retry;
}
return 0;
}
static int p8_i2c_start_request(struct p8_i2c_master *master,
struct i2c_request *req)
{
struct p8_i2c_request *request =
container_of(req, struct p8_i2c_request, req);
uint64_t cmd, now;
int rc, tbytes;
DBG("Starting req %d len=%d addr=%02x (offset=%x)\n",
req->op, req->rw_len, req->dev_addr, req->offset);
/* Convert the offset if needed */
if (req->offset_bytes) {
int i;
for (i = 0; i < req->offset_bytes; i++) {
uint8_t b;
b = req->offset >> (8 * (req->offset_bytes - i - 1));
master->obuf[i] = b;
}
DBG("Offset %d bytes: %02x %02x %02x %02x\n",
req->offset_bytes, master->obuf[0], master->obuf[1],
master->obuf[2], master->obuf[3]);
}
/* Program mode register */
rc = p8_i2c_prog_mode(master, false);
if (rc)
return rc;
/* Check status */
rc = p8_i2c_check_initial_status(master);
if (rc)
return rc;
/* Initialize bytes_sent */
master->bytes_sent = 0;
/* Set up the command register */
cmd = I2C_CMD_WITH_START | I2C_CMD_WITH_ADDR;
cmd = SETFIELD(I2C_CMD_DEV_ADDR, cmd, req->dev_addr);
switch (req->op) {
case I2C_READ:
cmd |= I2C_CMD_READ_NOT_WRITE;
/* Fall through */
case I2C_WRITE:
cmd |= I2C_CMD_WITH_STOP;
cmd = SETFIELD(I2C_CMD_LEN_BYTES, cmd, req->rw_len);
master->state = state_data;
break;
case SMBUS_READ:
cmd = SETFIELD(I2C_CMD_LEN_BYTES, cmd, req->offset_bytes);
master->state = state_offset;
break;
case SMBUS_WRITE:
cmd |= I2C_CMD_WITH_STOP;
cmd = SETFIELD(I2C_CMD_LEN_BYTES, cmd,
req->rw_len + req->offset_bytes);
master->state = state_offset;
break;
default:
return OPAL_PARAMETER;
}
DBG("Command: %016llx, state: %d\n", cmd, master->state);
/* Send command */
rc = xscom_write(master->chip_id, master->xscom_base + I2C_CMD_REG,
cmd);
if (rc) {
prlog(PR_ERR, "I2C: Failed to write the CMD_REG\n");
return OPAL_HARDWARE;
}
/* Enable the interrupts */
p8_i2c_enable_irqs(master);
/* If interrupts aren't working, start the poll timer. Also
* calculate the timeout differently
*/
now = mftb();
tbytes = req->rw_len + req->offset_bytes + 2;
if (!master->irq_ok) {
schedule_timer_at(&master->poller,
now + master->poll_interval);
request->timeout = now +
tbytes * msecs_to_tb(I2C_TIMEOUT_POLL_MS);
} else
request->timeout = now +
tbytes * msecs_to_tb(I2C_TIMEOUT_IRQ_MS);
/* Start the timeout */
schedule_timer_at(&master->timeout, request->timeout);
return OPAL_SUCCESS;
}
static void p8_i2c_check_work(struct p8_i2c_master *master)
{
struct i2c_request *req;
int rc;
while (master->state == state_idle && !list_empty(&master->req_list)) {
req = list_top(&master->req_list, struct i2c_request, link);
rc = p8_i2c_start_request(master, req);
if (rc)
p8_i2c_complete_request(master, req, rc);
}
}
static int p8_i2c_queue_request(struct i2c_request *req)
{
struct i2c_bus *bus = req->bus;
struct p8_i2c_master_port *port =
container_of(bus, struct p8_i2c_master_port, bus);
struct p8_i2c_master *master = port->common;
int rc = 0;
/* Parameter check */
if (req->rw_len > I2C_MAX_TFR_LEN) {
prlog(PR_ERR, "I2C: Too large transfer %d byes\n", req->rw_len);
return OPAL_PARAMETER;
}
if (req->offset_bytes > 4) {
prlog(PR_ERR, "I2C: Invalid offset size %d\n",
req->offset_bytes);
return OPAL_PARAMETER;
}
lock(&master->lock);
list_add_tail(&master->req_list, &req->link);
p8_i2c_check_work(master);
unlock(&master->lock);
return rc;
}
static struct i2c_request *p8_i2c_alloc_request(struct i2c_bus *bus)
{
struct p8_i2c_master_port *port =
container_of(bus, struct p8_i2c_master_port, bus);
struct p8_i2c_request *request;
request = zalloc(sizeof(*request));
if (!request) {
prlog(PR_ERR, "I2C: Failed to allocate i2c request\n");
return NULL;
}
request->port_num = port->port_num;
request->req.bus = bus;
return &request->req;
}
static void p8_i2c_free_request(struct i2c_request *req)
{
struct p8_i2c_request *request =
container_of(req, struct p8_i2c_request, req);
free(request);
}
static inline uint32_t p8_i2c_get_bit_rate_divisor(uint32_t lb_freq_mhz,
uint32_t bus_speed)
{
uint64_t lb_freq = lb_freq_mhz * 1000;
return (((lb_freq / bus_speed) - 1) / 4);
}
static inline uint64_t p8_i2c_get_poll_interval(uint32_t bus_speed)
{
uint64_t usec;
/* Polling Interval = 8 * (1/bus_speed) * (1/10) -> convert to uSec */
usec = ((8 * USEC_PER_SEC) / (10 * bus_speed * 1000));
return usecs_to_tb(usec);
}
static void p8_i2c_timeout(struct timer *t __unused, void *data)
{
struct p8_i2c_master *master = data;
struct p8_i2c_request *request;
struct i2c_request *req;
lock(&master->lock);
/* This could be spurrious ... */
if (master->state == state_idle) {
DBG("I2C: Timeout in idle state\n");
goto exit;
}
/* We might still be spurrious timer, we need to ensure that the
* head request is indeed old enough to be the one timing out
*/
req = list_top(&master->req_list, struct i2c_request, link);
if (req == NULL) {
DBG("I2C: Timeout with no"
" pending request state=%d\n", master->state);
goto exit;
}
request = container_of(req, struct p8_i2c_request, req);
if (tb_compare(mftb(), request->timeout) == TB_ABEFOREB) {
DBG("I2C: Timeout with request not expired\n");
goto exit;
}
/* Allright, we have a request and it has timed out ... */
prlog(PR_ERR, "I2C: Request timeout !\n");
/* Reset the engine */
p8_i2c_engine_reset(master);
/* Should we send a stop ? For now just complete */
p8_i2c_complete_request(master, req, OPAL_HARDWARE);
exit:
unlock(&master->lock);
}
static void p8_i2c_poll(struct timer *t __unused, void *data)
{
struct p8_i2c_master *master = data;
uint64_t now = mftb();
/*
* This is called when the interrupt isn't functional and
* will essentially just run the state machine from a timer
*
* There is some (mild) duplication with the OPAL poller but
* the latter is going to generally run very slowly so this
* isn't a problem. During boot they will both kick in but
* here too, this isn't a real problem.
*/
lock(&master->lock);
master->poll_timer = now + master->poll_interval;
p8_i2c_check_status(master);
if (master->state != state_idle)
schedule_timer_at(&master->poller,
now + master->poll_interval);
p8_i2c_check_work(master);
unlock(&master->lock);
}
static void p8_i2c_poll_each_master(bool interrupt)
{
struct p8_i2c_master *master = NULL;
struct p8_i2c_master_port *port;
struct i2c_bus *bus;
list_for_each(&i2c_bus_list, bus, link) {
uint64_t now = mftb();
port = container_of(bus, struct p8_i2c_master_port, bus);
/* Each master serves 1 or more ports, check for the first
* one found..
*/
if (!master || master != port->common)
master = port->common;
else
continue;
/* Lockless fast bailout for polling mode */
if (!interrupt && master->state == state_idle &&
list_empty(&master->req_list))
continue;
lock(&master->lock);
/* Run the state machine */
if (interrupt || master->poll_timer == 0 ||
tb_compare(now, master->poll_timer) == TB_AAFTERB ||
tb_compare(now, master->poll_timer) == TB_AEQUALB) {
master->poll_timer = now + master->poll_interval;
p8_i2c_check_status(master);
}
/* Check for new work */
p8_i2c_check_work(master);
unlock(&master->lock);
}
}
static void p8_i2c_opal_poll(void *data __unused)
{
p8_i2c_poll_each_master(false);
}
void p8_i2c_interrupt(void)
{
p8_i2c_poll_each_master(true);
}
void p8_i2c_init(void)
{
struct p8_i2c_master_port *port;
uint32_t bus_speed, lb_freq, count;
struct dt_node *i2cm, *i2cm_port;
struct p8_i2c_master *master;
uint64_t ex_stat;
static bool irq_printed;
int rc;
dt_for_each_compatible(dt_root, i2cm, "ibm,power8-i2cm") {
master = zalloc(sizeof(*master));
if (!master) {
prlog(PR_ERR,"I2C: Failed to allocate p8_i2c_master\n");
break;
}
/* Bus speed in KHz */
bus_speed = dt_prop_get_u32(i2cm, "bus-speed-khz");
lb_freq = dt_prop_get_u32(i2cm, "local-bus-freq-mhz");
/* Initialise the i2c master structure */
master->state = state_idle;
master->chip_id = dt_get_chip_id(i2cm);
master->xscom_base = dt_get_address(i2cm, 0, NULL);
init_timer(&master->timeout, p8_i2c_timeout, master);
rc = xscom_read(master->chip_id, master->xscom_base +
I2C_EXTD_STAT_REG, &ex_stat);
if (rc) {
prlog(PR_ERR, "I2C: Failed to read EXTD_STAT_REG\n");
free(master);
break;
}
master->fifo_size = GETFIELD(I2C_EXTD_STAT_FIFO_SIZE, ex_stat);
list_head_init(&master->req_list);
master->poll_interval = p8_i2c_get_poll_interval(bus_speed);
master->poll_timer = 0;
master->bit_rate_div = p8_i2c_get_bit_rate_divisor(lb_freq,
bus_speed);
/* Check if interrupt is usable */
init_timer(&master->poller, p8_i2c_poll, master);
master->irq_ok = p8_i2c_has_irqs();
if (!irq_printed) {
irq_printed = true;
prlog(PR_INFO, "I2C: Interrupts %sfunctional\n",
master->irq_ok ? "" : "non-");
}
/* Allocate ports driven by this master */
count = 0;
dt_for_each_child(i2cm, i2cm_port)
count++;
port = zalloc(sizeof(*port) * count);
if (!port) {
prlog(PR_ERR, "I2C: Insufficient memory\n");
free(master);
break;
}
dt_for_each_child(i2cm, i2cm_port) {
port->port_num = dt_prop_get_u32(i2cm_port, "reg");
port->common = master;
port->bus.dt_node = i2cm_port;
port->bus.queue_req = p8_i2c_queue_request;
port->bus.alloc_req = p8_i2c_alloc_request;
port->bus.free_req = p8_i2c_free_request;
i2c_add_bus(&port->bus);
port++;
}
}
/* Register the poller, one poller will cater all the masters,
* this is needed for when we operate without Linux running
* and thus no interrupts
*/
opal_add_poller(p8_i2c_opal_poll, NULL);
}
|