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
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/i2c/eepromdd.C $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2011,2015 */
/* [+] International Business Machines 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. */
/* */
/* IBM_PROLOG_END_TAG */
/**
* @file eepromdd.C
*
* @brief Implementation of the EEPROM device driver,
* which will access various EEPROMs within the
* system via the I2C device driver
*
*/
// ----------------------------------------------
// Includes
// ----------------------------------------------
#include <string.h>
#include <sys/time.h>
#include <trace/interface.H>
#include <errl/errlentry.H>
#include <errl/errlmanager.H>
#include <errl/errludtarget.H>
#include <errl/errludstring.H>
#include <targeting/common/targetservice.H>
#include <devicefw/driverif.H>
#include <i2c/eepromddreasoncodes.H>
#include <i2c/eepromif.H>
#include <i2c/i2creasoncodes.H>
#include "eepromdd.H"
#include "errlud_i2c.H"
#ifndef __HOSTBOOT_RUNTIME
#include <i2c/i2cif.H>
#endif
// ----------------------------------------------
// Globals
// ----------------------------------------------
mutex_t g_eepromMutex = MUTEX_INITIALIZER;
// ----------------------------------------------
// Trace definitions
// ----------------------------------------------
trace_desc_t* g_trac_eeprom = NULL;
TRAC_INIT( & g_trac_eeprom, EEPROM_COMP_NAME, KILOBYTE );
trace_desc_t* g_trac_eepromr = NULL;
TRAC_INIT( & g_trac_eepromr, "EEPROMR", KILOBYTE );
// Easy macro replace for unit testing
//#define TRACUCOMP(args...) TRACFCOMP(args)
#define TRACUCOMP(args...)
// ----------------------------------------------
// Defines
// ----------------------------------------------
#define MAX_BYTE_ADDR 2
#define EEPROM_MAX_NACK_RETRIES 2
// ----------------------------------------------
namespace EEPROM
{
// Register the perform Op with the routing code for Procs.
DEVICE_REGISTER_ROUTE( DeviceFW::WILDCARD,
DeviceFW::EEPROM,
TARGETING::TYPE_PROC,
eepromPerformOp );
// Register the perform Op with the routing code for DIMMs.
DEVICE_REGISTER_ROUTE( DeviceFW::WILDCARD,
DeviceFW::EEPROM,
TARGETING::TYPE_DIMM,
eepromPerformOp );
// Register the perform Op with the routing code for Memory Buffers.
DEVICE_REGISTER_ROUTE( DeviceFW::WILDCARD,
DeviceFW::EEPROM,
TARGETING::TYPE_MEMBUF,
eepromPerformOp );
// ------------------------------------------------------------------
// eepromPerformOp
// ------------------------------------------------------------------
errlHndl_t eepromPerformOp( DeviceFW::OperationType i_opType,
TARGETING::Target * i_target,
void * io_buffer,
size_t & io_buflen,
int64_t i_accessType,
va_list i_args )
{
errlHndl_t err = NULL;
TARGETING::Target * theTarget = NULL;
eeprom_addr_t i2cInfo;
i2cInfo.chip = va_arg( i_args, uint64_t );
i2cInfo.offset = va_arg( i_args, uint64_t );
TRACDCOMP( g_trac_eeprom,
ENTER_MRK"eepromPerformOp()" );
TRACUCOMP (g_trac_eeprom, ENTER_MRK"eepromPerformOp(): "
"i_opType=%d, chip=%d, offset=%d, len=%d",
(uint64_t) i_opType, i2cInfo.chip, i2cInfo.offset, io_buflen);
do
{
// Read Attributes needed to complete the operation
err = eepromReadAttributes( i_target,
i2cInfo );
if( err )
{
break;
}
// Check to see if we need to find a new target for
// the I2C Master
err = eepromGetI2CMasterTarget( i_target,
i2cInfo,
theTarget );
if( err )
{
break;
}
// Check that the offset + data length is less than device max size
if ( ( i2cInfo.offset + io_buflen ) >
( i2cInfo.devSize_KB * KILOBYTE ) )
{
TRACFCOMP( g_trac_eeprom,
ERR_MRK"eepromPerformOp(): Device Overflow! "
"C-p/e/dA=%d-%d/%d/0x%X, offset=0x%X, len=0x%X "
"devSizeKB=0x%X", i2cInfo.chip, i2cInfo.port,
i2cInfo.engine, i2cInfo.devAddr, i2cInfo.offset,
io_buflen, i2cInfo.devSize_KB);
/*@
* @errortype
* @reasoncode EEPROM_OVERFLOW_ERROR
* @severity ERRL_SEV_UNRECOVERABLE
* @moduleid EEPROM_PERFORM_OP
* @userdata1[0:31] Offset
* @userdata1[32:63] Buffer Length
* @userdata2 Device Max Size (in KB)
* @devdesc I2C Buffer Length + Offset > Max Size
* @custdesc A problem occurred during the IPL of the
* system: I2C buffer offset is too large.
*/
err = new ERRORLOG::ErrlEntry( ERRORLOG::ERRL_SEV_UNRECOVERABLE,
EEPROM_PERFORM_OP,
EEPROM_OVERFLOW_ERROR,
TWO_UINT32_TO_UINT64(
i2cInfo.offset,
io_buflen ),
i2cInfo.devSize_KB,
true /*Add HB SW Callout*/ );
err->collectTrace( EEPROM_COMP_NAME );
break;
}
// Do the read or write
if( i_opType == DeviceFW::READ )
{
err = eepromRead( theTarget,
io_buffer,
io_buflen,
i2cInfo );
if ( err )
{
break;
}
}
else if( i_opType == DeviceFW::WRITE )
{
err = eepromWrite( theTarget,
io_buffer,
io_buflen,
i2cInfo );
if ( err )
{
break;
}
}
else
{
TRACFCOMP( g_trac_eeprom,
ERR_MRK"eepromPerformOp(): Invalid EEPROM Operation!");
/*@
* @errortype
* @reasoncode EEPROM_INVALID_OPERATION
* @severity ERRL_SEV_UNRECOVERABLE
* @moduleid EEPROM_PERFORM_OP
* @userdata1 Operation Type
* @userdata2 Chip to Access
* @devdesc Invalid operation type.
*/
err = new ERRORLOG::ErrlEntry( ERRORLOG::ERRL_SEV_UNRECOVERABLE,
EEPROM_PERFORM_OP,
EEPROM_INVALID_OPERATION,
i_opType,
i2cInfo.chip,
true /*Add HB SW Callout*/ );
err->collectTrace( EEPROM_COMP_NAME );
break;
}
} while( 0 );
// If there is an error, add parameter info to log
if ( err != NULL )
{
EEPROM::UdEepromParms( i_opType,
i_target,
io_buflen,
i2cInfo )
.addToLog(err);
}
TRACDCOMP( g_trac_eeprom,
EXIT_MRK"eepromPerformOp() - %s",
((NULL == err) ? "No Error" : "With Error") );
return err;
} // end eepromPerformOp
#ifndef __HOSTBOOT_RUNTIME
//-------------------------------------------------------------------
//eepromPresence
//-------------------------------------------------------------------
bool eepromPresence ( TARGETING::Target * i_target )
{
TRACDCOMP(g_trac_eeprom, ENTER_MRK"eepromPresence()");
errlHndl_t err = NULL;
bool l_present = false;
TARGETING::Target * theTarget = NULL;
eeprom_addr_t i2cInfo;
i2cInfo.chip = EEPROM::VPD_PRIMARY;
i2cInfo.offset = 0;
do
{
// Read Attributes needed to complete the operation
err = eepromReadAttributes( i_target,
i2cInfo );
if( err )
{
TRACFCOMP(g_trac_eeprom,
ERR_MRK"Error in eepromPresence::eepromReadAttributes()");
break;
}
// Check to see if we need to find a new target for
// the I2C Master
err = eepromGetI2CMasterTarget( i_target,
i2cInfo,
theTarget );
if( err )
{
TRACFCOMP(g_trac_eeprom,
ERR_MRK"Error in eepromPresence::eepromGetI2Cmaster()");
break;
}
//Check for the target at the I2C level
l_present = I2C::i2cPresence(theTarget,
i2cInfo.port,
i2cInfo.engine,
i2cInfo.devAddr );
if( !l_present )
{
TRACDCOMP(g_trac_eeprom,
ERR_MRK"i2cPresence returned false! chip NOT present!");
break;
}
} while( 0 );
TRACDCOMP(g_trac_eeprom, EXIT_MRK"eepromPresence()");
return l_present;
}
#endif
// ------------------------------------------------------------------
// eepromRead
// ------------------------------------------------------------------
errlHndl_t eepromRead ( TARGETING::Target * i_target,
void * o_buffer,
size_t i_buflen,
eeprom_addr_t i_i2cInfo )
{
errlHndl_t err = NULL;
errlHndl_t err_NACK = NULL;
uint8_t byteAddr[MAX_BYTE_ADDR];
size_t byteAddrSize = 0;
bool unlock = false;
TRACDCOMP( g_trac_eeprom,
ENTER_MRK"eepromRead()" );
do
{
TRACSCOMP( g_trac_eepromr,
"EEPROM READ START : Chip: %02d : Offset %.2X : Len %d",
i_i2cInfo.chip, i_i2cInfo.offset, i_buflen );
err = eepromPrepareAddress( &byteAddr,
byteAddrSize,
i_i2cInfo );
if( err )
{
break;
}
// Lock to sequence operations
mutex_lock( &g_eepromMutex );
unlock = true;
/***********************************************************/
/* Attempt read multiple times ONLY on NACK fails */
/***********************************************************/
for (uint8_t retry = 0;
retry <= EEPROM_MAX_NACK_RETRIES;
retry++)
{
// Only write the byte address if we have data to write
if( 0 != byteAddrSize )
{
// Use the I2C OFFSET Interface for the READ
err = deviceOp( DeviceFW::READ,
i_target,
o_buffer,
i_buflen,
DEVICE_I2C_ADDRESS_OFFSET(
i_i2cInfo.port,
i_i2cInfo.engine,
i_i2cInfo.devAddr,
byteAddrSize,
reinterpret_cast<uint8_t*>(&byteAddr)));
if( err )
{
TRACFCOMP(g_trac_eeprom,
ERR_MRK"eepromRead(): I2C Read-Offset failed on "
"%d/%d/0x%X aS=%d",
i_i2cInfo.port, i_i2cInfo.engine,
i_i2cInfo.devAddr, byteAddrSize);
TRACFBIN(g_trac_eeprom, "byteAddr[]",
&byteAddr, byteAddrSize);
// Don't break here -- error handled below
}
}
else
{
// Do the actual read via I2C
err = deviceOp( DeviceFW::READ,
i_target,
o_buffer,
i_buflen,
DEVICE_I2C_ADDRESS( i_i2cInfo.port,
i_i2cInfo.engine,
i_i2cInfo.devAddr ) );
if( err )
{
TRACFCOMP(g_trac_eeprom,
ERR_MRK"eepromRead(): I2C Read failed on "
"%d/%d/0x%0X", i_i2cInfo.port, i_i2cInfo.engine,
i_i2cInfo.devAddr);
// Don't break here -- error handled below
}
}
if ( err == NULL )
{
// Operation completed successfully
// break from retry loop
break;
}
else if ( err->reasonCode() != I2C::I2C_NACK_ONLY_FOUND )
{
// Only retry on NACK failures: break from retry loop
TRACFCOMP( g_trac_eeprom, ERR_MRK"eepromRead(): Non-Nack "
"Error: rc=0x%X, tgt=0x%X, No Retry (retry=%d)",
err->reasonCode(),
TARGETING::get_huid(i_target), retry);
err->collectTrace(EEPROM_COMP_NAME);
// break from retry loop
break;
}
else // Handle NACK error
{
// If op will be attempted again: save log and continue
if ( retry < EEPROM_MAX_NACK_RETRIES )
{
// Only save original NACK error
if ( err_NACK == NULL )
{
// Save original NACK error
err_NACK = err;
TRACFCOMP( g_trac_eeprom, ERR_MRK"eepromRead(): "
"NACK Error rc=0x%X, eid=0x%X, tgt=0x%X, "
"retry/MAX=%d/%d. Save error and retry",
err_NACK->reasonCode(),
err_NACK->eid(),
TARGETING::get_huid(i_target),
retry, EEPROM_MAX_NACK_RETRIES);
err_NACK->collectTrace(EEPROM_COMP_NAME);
}
else
{
// Add data to original NACK error
TRACFCOMP( g_trac_eeprom, ERR_MRK"eepromRead(): "
"Another NACK Error rc=0x%X, eid=0x%X "
"plid=0x%X, tgt=0x%X, retry/MAX=%d/%d. "
"Delete error and retry",
err->reasonCode(), err->eid(), err->plid(),
TARGETING::get_huid(i_target),
retry, EEPROM_MAX_NACK_RETRIES);
ERRORLOG::ErrlUserDetailsString(
"Another NACK ERROR found")
.addToLog(err_NACK);
// Delete this new NACK error
delete err;
err = NULL;
}
// continue to retry
continue;
}
else // no more retries: trace and break
{
TRACFCOMP( g_trac_eeprom, ERR_MRK"eepromRead(): "
"Error rc=0x%X, eid=%d, tgt=0x%X. No More "
"Retries (retry/MAX=%d/%d). Returning Error",
err->reasonCode(), err->eid(),
TARGETING::get_huid(i_target),
retry, EEPROM_MAX_NACK_RETRIES);
err->collectTrace(EEPROM_COMP_NAME);
// break from retry loop
break;
}
}
} // end of retry loop
// Handle saved NACK error, if any
if (err_NACK)
{
if (err)
{
// commit original NACK error with new err PLID
err_NACK->plid(err->plid());
TRACFCOMP(g_trac_eeprom, "eepromRead(): Committing saved NACK "
"err eid=0x%X with plid of returned err: 0x%X",
err_NACK->eid(), err_NACK->plid());
ERRORLOG::ErrlUserDetailsTarget(i_target)
.addToLog(err_NACK);
errlCommit(err_NACK, EEPROM_COMP_ID);
}
else
{
// Since we eventually succeeded, delete original NACK error
TRACFCOMP(g_trac_eeprom, "eepromRead(): Op successful, "
"deleting saved NACK err eid=0x%X, plid=0x%X",
err_NACK->eid(), err_NACK->plid());
delete err_NACK;
err_NACK = NULL;
}
}
mutex_unlock( &g_eepromMutex );
unlock = false;
TRACSCOMP( g_trac_eepromr,
"EEPROM READ END : Chip: %02d : Offset %.2X : Len %d : %016llx",
i_i2cInfo.chip, i_i2cInfo.offset, i_buflen,
*((uint64_t*)o_buffer) );
} while( 0 );
// Catch it if we break out early.
if( unlock )
{
mutex_unlock( & g_eepromMutex );
}
TRACDCOMP( g_trac_eeprom,
EXIT_MRK"eepromRead()" );
return err;
} // end eepromRead
// ------------------------------------------------------------------
// eepromWrite
// ------------------------------------------------------------------
errlHndl_t eepromWrite ( TARGETING::Target * i_target,
void * io_buffer,
size_t io_buflen,
eeprom_addr_t i_i2cInfo )
{
errlHndl_t err = NULL;
errlHndl_t err_NACK = NULL;
uint8_t byteAddr[MAX_BYTE_ADDR];
size_t byteAddrSize = 0;
uint8_t * newBuffer = NULL;
bool needFree = false;
bool unlock = false;
uint32_t data_left = 0;
uint32_t diff_wps = 0;
TRACDCOMP( g_trac_eeprom,
ENTER_MRK"eepromWrite()" );
do
{
TRACSCOMP( g_trac_eepromr,
"EEPROM WRITE START : Chip: %02d : Offset %.2X : Len %d : %016llx",
i_i2cInfo.chip, i_i2cInfo.offset, io_buflen,
*((uint64_t*)io_buffer) );
err = eepromPrepareAddress( &byteAddr,
byteAddrSize,
i_i2cInfo );
if( err )
{
break;
}
// EEPROM devices have write page boundaries, so when necessary
// need to split up command into multiple write operations
// Setup a max-size buffer of writePageSize
size_t newBufLen = i_i2cInfo.writePageSize;
newBuffer = static_cast<uint8_t*>(malloc( newBufLen ));
needFree = true;
// Point a uint8_t ptr at io_buffer for array addressing below
uint8_t * l_data_ptr = reinterpret_cast<uint8_t*>(io_buffer);
// Lock for operation sequencing
mutex_lock( &g_eepromMutex );
unlock = true;
// variables to store different amount of data length
size_t loop_data_length = 0;
size_t total_bytes_written = 0;
for ( uint64_t i = 0 ;
total_bytes_written < io_buflen ;
i++ )
{
// Determine how much data can be written in this loop
// Can't go over a writePageSize boundary
// Total data left to write
data_left = io_buflen - total_bytes_written;
// Difference to next writePageSize boundary
diff_wps = i_i2cInfo.writePageSize -
(i_i2cInfo.offset % i_i2cInfo.writePageSize);
// Take the lesser of the 2 options
loop_data_length = (data_left < diff_wps ) ? data_left : diff_wps;
// Add the data the user wanted to write
memcpy( newBuffer,
&l_data_ptr[total_bytes_written],
loop_data_length );
// Setup offset/address parms
err = eepromPrepareAddress( &byteAddr,
byteAddrSize,
i_i2cInfo );
if( err )
{
break;
}
TRACUCOMP(g_trac_eeprom,"eepromWrite() Loop: %d/%d/0x%X "
"loop=%d, l_d_l=%d, offset=0x%X, bAS=%d, diffs=%d/%d",
i_i2cInfo.port, i_i2cInfo.engine, i_i2cInfo.devAddr,
i, loop_data_length, i_i2cInfo.offset, byteAddrSize,
data_left, diff_wps);
/***********************************************************/
/* Attempt write multiple times ONLY on NACK fails */
/***********************************************************/
for (uint8_t retry = 0;
retry <= EEPROM_MAX_NACK_RETRIES;
retry++)
{
// Do the actual data write
err = deviceOp( DeviceFW::WRITE,
i_target,
newBuffer,
loop_data_length,
DEVICE_I2C_ADDRESS_OFFSET(
i_i2cInfo.port,
i_i2cInfo.engine,
i_i2cInfo.devAddr,
byteAddrSize,
reinterpret_cast<uint8_t*>(
&byteAddr)));
if ( err == NULL )
{
// Operation completed successfully
// break from retry loop
break;
}
else if ( err->reasonCode() != I2C::I2C_NACK_ONLY_FOUND )
{
// Only retry on NACK failures: break from retry loop
TRACFCOMP(g_trac_eeprom, ERR_MRK"eepromWrite(): I2C "
"Write Non-NACK fail %d/%d/0x%X loop=%d, "
"ldl=%d, offset=0x%X, aS=%d, retry=%d",
i_i2cInfo.port, i_i2cInfo.engine,
i_i2cInfo.devAddr, i, loop_data_length,
i_i2cInfo.offset, i_i2cInfo.addrSize, retry);
err->collectTrace(EEPROM_COMP_NAME);
// break from retry loop
break;
}
else // Handle NACK error
{
TRACFCOMP(g_trac_eeprom, ERR_MRK"eepromWrite(): I2C "
"Write NACK fail %d/%d/0x%X loop=%d, "
"ldl=%d, offset=0x%X, aS=%d",
i_i2cInfo.port, i_i2cInfo.engine,
i_i2cInfo.devAddr, i, loop_data_length,
i_i2cInfo.offset, i_i2cInfo.addrSize);
// If op will be attempted again: save error and continue
if ( retry < EEPROM_MAX_NACK_RETRIES )
{
// Only save original NACK error
if ( err_NACK == NULL )
{
// Save original NACK error
err_NACK = err;
TRACFCOMP( g_trac_eeprom, ERR_MRK"eepromWrite(): "
"Error rc=0x%X, eid=0x%X plid=0x%X, "
"tgt=0x%X, retry/MAX=%d/%d. Save error "
"and retry",
err_NACK->reasonCode(),
err_NACK->eid(),
err_NACK->plid(),
TARGETING::get_huid(i_target),
retry, EEPROM_MAX_NACK_RETRIES);
err_NACK->collectTrace(EEPROM_COMP_NAME);
}
else
{
// Add data to original NACK error
TRACFCOMP( g_trac_eeprom, ERR_MRK"eepromWrite(): "
"Another NACK Error rc=0x%X, eid=0x%X "
"plid=0x%X, tgt=0x%X, retry/MAX=%d/%d. "
"Delete error and retry",
err->reasonCode(), err->eid(),
err->plid(),
TARGETING::get_huid(i_target),
retry, EEPROM_MAX_NACK_RETRIES);
ERRORLOG::ErrlUserDetailsString(
"Another NACK ERROR found")
.addToLog(err_NACK);
// Delete this new NACK error
delete err;
err = NULL;
}
// continue to retry
continue;
}
else // no more retries: trace and break
{
TRACFCOMP( g_trac_eeprom, ERR_MRK"eepromWrite(): "
"Error rc=0x%X, tgt=0x%X. No More Retries "
"(retry/MAX=%d/%d). Returning Error",
err->reasonCode(),
TARGETING::get_huid(i_target),
retry, EEPROM_MAX_NACK_RETRIES);
err->collectTrace(EEPROM_COMP_NAME);
// break from retry loop
break;
}
}
} // end of retry loop
/***********************************************************/
// Handle saved NACK errors, if any
if (err_NACK)
{
if (err)
{
// commit original NACK error with new err PLID
err_NACK->plid(err->plid());
TRACFCOMP(g_trac_eeprom, "eepromWrite(): Committing saved "
"NACK err eid=0x%X with plid of returned err: "
"0x%X",
err_NACK->eid(), err_NACK->plid());
ERRORLOG::ErrlUserDetailsTarget(i_target)
.addToLog(err_NACK);
errlCommit(err_NACK, EEPROM_COMP_ID);
}
else
{
// Since we eventually succeeded, delete original NACK error
TRACFCOMP(g_trac_eeprom, "eepromWrite(): Op successful, "
"deleting saved NACK err eid=0x%X, plid=0x%X",
err_NACK->eid(), err_NACK->plid());
delete err_NACK;
err_NACK = NULL;
}
}
if ( err )
{
// Can't assume that anything was written if
// there was an error, so no update to total_bytes_written
// for this loop
break;
}
// Wait for EEPROM to write data to its internal memory
// i_i2cInfo.writeCycleTime value in milliseconds
nanosleep(0, i_i2cInfo.writeCycleTime * NS_PER_MSEC);
// Update how much data was written
total_bytes_written += loop_data_length;
// Update offset
i_i2cInfo.offset += loop_data_length;
TRACUCOMP(g_trac_eeprom,"eepromWrite() Loop %d End: "
"l_d_l=%d, offset=0x%X, t_b_w=%d, io_buflen=%d",
i, loop_data_length, i_i2cInfo.offset,
total_bytes_written, io_buflen);
} // end of write for-loop
// Release mutex lock
mutex_unlock( &g_eepromMutex );
unlock = false;
// Set how much data was actually written
io_buflen = total_bytes_written;
if( err )
{
// Leave do-while loop
break;
}
TRACSCOMP( g_trac_eepromr,
"EEPROM WRITE END : Chip: %02d : Offset %.2X : Len %d",
i_i2cInfo.chip, i_i2cInfo.offset, io_buflen );
} while( 0 );
// Free memory
if( needFree )
{
free( newBuffer );
}
// Catch it if we break out early.
if( unlock )
{
mutex_unlock( & g_eepromMutex );
}
TRACDCOMP( g_trac_eeprom,
EXIT_MRK"eepromWrite()" );
return err;
} // end eepromWrite
// ------------------------------------------------------------------
// eepromPrepareAddress
// ------------------------------------------------------------------
errlHndl_t eepromPrepareAddress ( void * io_buffer,
size_t & o_bufSize,
eeprom_addr_t i_i2cInfo )
{
errlHndl_t err = NULL;
o_bufSize = 0;
TRACDCOMP( g_trac_eeprom,
ENTER_MRK"eepromPrepareAddress()" );
do
{
// --------------------------------------------------------------------
// Currently only supporting I2C devices and that use 0, 1, or 2 bytes
// to set the offset (ie, internal address) into the device.
// --------------------------------------------------------------------
switch( i_i2cInfo.addrSize )
{
case TWO_BYTE_ADDR:
o_bufSize = 2;
memset( io_buffer, 0x0, o_bufSize );
*((uint8_t*)io_buffer) = (i_i2cInfo.offset & 0xFF00ull) >> 8;
*((uint8_t*)io_buffer+1) = (i_i2cInfo.offset & 0x00FFull);
break;
case ONE_BYTE_ADDR:
o_bufSize = 1;
memset( io_buffer, 0x0, o_bufSize );
*((uint8_t*)io_buffer) = (i_i2cInfo.offset & 0xFFull);
break;
case ZERO_BYTE_ADDR:
o_bufSize = 0;
// nothing to do with the buffer in this case
break;
default:
TRACFCOMP( g_trac_eeprom,
ERR_MRK"eepromPrepareAddress() - Invalid Device "
"Address Size: 0x%08x", i_i2cInfo.addrSize);
/*@
* @errortype
* @reasoncode EEPROM_INVALID_DEVICE_TYPE
* @severity ERRL_SEV_UNRECOVERABLE
* @moduleid EEPROM_PREPAREADDRESS
* @userdata1 Address Size (aka Device Type)
* @userdata2 EEPROM chip
* @devdesc The Device type not supported (addrSize)
* @custdesc A problem was detected during the IPL of
* the system: Device type not supported.
*/
err = new ERRORLOG::ErrlEntry( ERRORLOG::ERRL_SEV_UNRECOVERABLE,
EEPROM_PREPAREADDRESS,
EEPROM_INVALID_DEVICE_TYPE,
i_i2cInfo.addrSize,
i_i2cInfo.chip,
true /*Add HB SW Callout*/ );
err->collectTrace( EEPROM_COMP_NAME );
break;
}
} while( 0 );
TRACDCOMP( g_trac_eeprom,
EXIT_MRK"eepromPrepareAddress()" );
return err;
} // end eepromPrepareAddress
// ------------------------------------------------------------------
// eepromReadAttributes
// ------------------------------------------------------------------
errlHndl_t eepromReadAttributes ( TARGETING::Target * i_target,
eeprom_addr_t & o_i2cInfo )
{
errlHndl_t err = NULL;
bool fail_reading_attribute = false;
TRACDCOMP( g_trac_eeprom,
ENTER_MRK"eepromReadAttributes()" );
// These variables will be used to hold the EEPROM attribute data
// Note: each 'EepromVpd' struct is kept the same via the attributes
// so will be copying each to eepromData to save code space
TARGETING::EepromVpdPrimaryInfo eepromData;
do
{
switch (o_i2cInfo.chip )
{
case VPD_PRIMARY:
if( !( i_target->
tryGetAttr<TARGETING::ATTR_EEPROM_VPD_PRIMARY_INFO>
( eepromData ) ) )
{
fail_reading_attribute = true;
}
break;
case VPD_BACKUP:
if( !(i_target->
tryGetAttr<TARGETING::ATTR_EEPROM_VPD_BACKUP_INFO>
( reinterpret_cast<
TARGETING::ATTR_EEPROM_VPD_BACKUP_INFO_type&>
( eepromData) ) ) )
{
fail_reading_attribute = true;
}
break;
case SBE_PRIMARY:
if( !(i_target->
tryGetAttr<TARGETING::ATTR_EEPROM_SBE_PRIMARY_INFO>
( reinterpret_cast<
TARGETING::ATTR_EEPROM_SBE_PRIMARY_INFO_type&>
( eepromData) ) ) )
{
fail_reading_attribute = true;
}
break;
case SBE_BACKUP:
if( (!i_target->
tryGetAttr<TARGETING::ATTR_EEPROM_SBE_BACKUP_INFO>
( reinterpret_cast<
TARGETING::ATTR_EEPROM_SBE_BACKUP_INFO_type&>
( eepromData) ) ) )
{
fail_reading_attribute = true;
}
break;
default:
TRACFCOMP( g_trac_eeprom,ERR_MRK"eepromReadAttributes() - "
"Invalid chip (%d) to read attributes from!",
o_i2cInfo.chip );
/*@
* @errortype
* @reasoncode EEPROM_INVALID_CHIP
* @severity ERRORLOG::ERRL_SEV_UNRECOVERABLE
* @moduleid EEPROM_READATTRIBUTES
* @userdata1 EEPROM Chip
* @userdata2 HUID of target
* @devdesc Invalid EEPROM chip to access
*/
err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
EEPROM_READATTRIBUTES,
EEPROM_INVALID_CHIP,
o_i2cInfo.chip,
TARGETING::get_huid(i_target),
true /*Add HB SW Callout*/ );
err->collectTrace( EEPROM_COMP_NAME );
break;
}
// Check if Attribute Data was found
if( fail_reading_attribute == true )
{
TRACFCOMP( g_trac_eeprom,
ERR_MRK"eepromReadAttributes() - ERROR reading "
"attributes for chip %d!",
o_i2cInfo.chip );
/*@
* @errortype
* @reasoncode EEPROM_ATTR_INFO_NOT_FOUND
* @severity ERRORLOG::ERRL_SEV_UNRECOVERABLE
* @moduleid EEPROM_READATTRIBUTES
* @userdata1 HUID of target
* @userdata2 EEPROM chip
* @devdesc EEPROM attribute was not found
*/
err = new ERRORLOG::ErrlEntry(
ERRORLOG::ERRL_SEV_UNRECOVERABLE,
EEPROM_READATTRIBUTES,
EEPROM_ATTR_INFO_NOT_FOUND,
TARGETING::get_huid(i_target),
o_i2cInfo.chip);
// Could be FSP or HB code's fault
err->addProcedureCallout(HWAS::EPUB_PRC_HB_CODE,
HWAS::SRCI_PRIORITY_MED);
err->addProcedureCallout(HWAS::EPUB_PRC_SP_CODE,
HWAS::SRCI_PRIORITY_MED);
err->collectTrace( EEPROM_COMP_NAME );
break;
}
// Successful reading of Attribute, so extract the data
o_i2cInfo.port = eepromData.port;
o_i2cInfo.devAddr = eepromData.devAddr;
o_i2cInfo.engine = eepromData.engine;
o_i2cInfo.i2cMasterPath = eepromData.i2cMasterPath;
o_i2cInfo.writePageSize = eepromData.writePageSize;
o_i2cInfo.devSize_KB = eepromData.maxMemorySizeKB;
o_i2cInfo.writeCycleTime = eepromData.writeCycleTime;
// Convert attribute info to eeprom_addr_size_t enum
if ( eepromData.byteAddrOffset == 0x2 )
{
o_i2cInfo.addrSize = TWO_BYTE_ADDR;
}
else if ( eepromData.byteAddrOffset == 0x1 )
{
o_i2cInfo.addrSize = ONE_BYTE_ADDR;
}
else if ( eepromData.byteAddrOffset == 0x0 )
{
o_i2cInfo.addrSize = ZERO_BYTE_ADDR;
}
else
{
TRACFCOMP( g_trac_eeprom,
ERR_MRK"eepromReadAttributes() - INVALID ADDRESS "
"OFFSET SIZE %d!",
o_i2cInfo.addrSize );
/*@
* @errortype
* @reasoncode EEPROM_INVALID_ADDR_OFFSET_SIZE
* @severity ERRORLOG::ERRL_SEV_UNRECOVERABLE
* @moduleid EEPROM_READATTRIBUTES
* @userdata1 HUID of target
* @userdata2 Address Offset Size
* @devdesc Invalid address offset size
*/
err = new ERRORLOG::ErrlEntry(
ERRORLOG::ERRL_SEV_UNRECOVERABLE,
EEPROM_READATTRIBUTES,
EEPROM_INVALID_ADDR_OFFSET_SIZE,
TARGETING::get_huid(i_target),
o_i2cInfo.addrSize,
true /*Add HB SW Callout*/ );
err->collectTrace( EEPROM_COMP_NAME );
break;
}
} while( 0 );
TRACUCOMP(g_trac_eeprom,"eepromReadAttributes() tgt=0x%X, %d/%d/0x%X "
"wpw=0x%X, dsKb=0x%X, aS=%d (%d), wct=%d",
TARGETING::get_huid(i_target),
o_i2cInfo.port, o_i2cInfo.engine, o_i2cInfo.devAddr,
o_i2cInfo.writePageSize, o_i2cInfo.devSize_KB,
o_i2cInfo.addrSize, eepromData.byteAddrOffset,
o_i2cInfo.writeCycleTime);
TRACDCOMP( g_trac_eeprom,
EXIT_MRK"eepromReadAttributes()" );
return err;
} // end eepromReadAttributes
// ------------------------------------------------------------------
// eepromGetI2CMasterTarget
// ------------------------------------------------------------------
errlHndl_t eepromGetI2CMasterTarget ( TARGETING::Target * i_target,
eeprom_addr_t i_i2cInfo,
TARGETING::Target * &o_target )
{
errlHndl_t err = NULL;
o_target = NULL;
TRACDCOMP( g_trac_eeprom,
ENTER_MRK"eepromGetI2CMasterTarget()" );
do
{
TARGETING::TargetService& tS = TARGETING::targetService();
// The path from i_target to its I2C Master was read from the
// attribute via eepromReadAttributes() and passed to this function
// in i_i2cInfo.i2cMasterPath
// check that the path exists
bool exists = false;
tS.exists( i_i2cInfo.i2cMasterPath,
exists );
if( !exists )
{
TRACFCOMP( g_trac_eeprom,
ERR_MRK"eepromGetI2CMasterTarget() - "
"i2cMasterPath attribute path doesn't exist!" );
// Compress the entity path
uint64_t l_epCompressed = 0;
for( uint32_t i = 0; i < i_i2cInfo.i2cMasterPath.size(); i++ )
{
// Path element: type:8 instance:8
l_epCompressed |=
i_i2cInfo.i2cMasterPath[i].type << (16*(3-i));
l_epCompressed |=
i_i2cInfo.i2cMasterPath[i].instance << ((16*(3-i))-8);
// Can only fit 4 path elements into 64 bits
if ( i == 3 )
{
break;
}
}
/*@
* @errortype
* @reasoncode EEPROM_I2C_MASTER_PATH_ERROR
* @severity ERRORLOG::ERRL_SEV_UNRECOVERABLE
* @moduleid EEPROM_GETI2CMASTERTARGET
* @userdata1[00:31] Attribute Chip Type Enum
* @userdata1[32:63] HUID of target
* @userdata2 Compressed Entity Path
* @devdesc I2C master entity path doesn't exist.
*/
err = new ERRORLOG::ErrlEntry(
ERRORLOG::ERRL_SEV_UNRECOVERABLE,
EEPROM_GETI2CMASTERTARGET,
EEPROM_I2C_MASTER_PATH_ERROR,
TWO_UINT32_TO_UINT64(
i_i2cInfo.chip,
TARGETING::get_huid(i_target) ),
l_epCompressed,
true /*Add HB SW Callout*/ );
err->collectTrace( EEPROM_COMP_NAME );
ERRORLOG::ErrlUserDetailsString(
i_i2cInfo.i2cMasterPath.toString()).addToLog(err);
break;
}
// Since it exists, convert to a target
o_target = tS.toTarget( i_i2cInfo.i2cMasterPath );
if( NULL == o_target )
{
TRACFCOMP( g_trac_eeprom,
ERR_MRK"eepromGetI2CMasterTarget() - I2C Master "
"Path target was NULL!" );
// Compress the entity path
uint64_t l_epCompressed = 0;
for( uint32_t i = 0; i < i_i2cInfo.i2cMasterPath.size(); i++ )
{
// Path element: type:8 instance:8
l_epCompressed |=
i_i2cInfo.i2cMasterPath[i].type << (16*(3-i));
l_epCompressed |=
i_i2cInfo.i2cMasterPath[i].instance << ((16*(3-i))-8);
// Can only fit 4 path elements into 64 bits
if ( i == 3 )
{
break;
}
}
/*@
* @errortype
* @reasoncode EEPROM_TARGET_NULL
* @severity ERRORLOG::ERRL_SEV_UNRECOVERABLE
* @moduleid EEPROM_GETI2CMASTERTARGET
* @userdata1[00:31] Attribute Chip Type Enum
* @userdata1[32:63] HUID of target
* @userdata2 Compressed Entity Path
* @devdesc I2C master path target is null.
*/
err = new ERRORLOG::ErrlEntry( ERRORLOG::ERRL_SEV_UNRECOVERABLE,
EEPROM_GETI2CMASTERTARGET,
EEPROM_TARGET_NULL,
TWO_UINT32_TO_UINT64(
i_i2cInfo.chip,
TARGETING::get_huid(i_target) ),
l_epCompressed,
true /*Add HB SW Callout*/ );
err->collectTrace( EEPROM_COMP_NAME );
ERRORLOG::ErrlUserDetailsString(
i_i2cInfo.i2cMasterPath.toString()).addToLog(err);
break;
}
} while( 0 );
TRACDCOMP( g_trac_eeprom,
EXIT_MRK"eepromGetI2CMasterTarget()" );
return err;
} // end eepromGetI2CMasterTarget
/**
* @brief Compare predicate for EepromInfo_t
*/
class isSameEeprom
{
public:
isSameEeprom( EepromInfo_t& i_first )
: iv_first(i_first)
{}
bool operator()( EepromInfo_t& i_second )
{
return( (iv_first.i2cMaster == i_second.i2cMaster)
&& (iv_first.engine == i_second.engine)
&& (iv_first.port == i_second.port)
&& (iv_first.devAddr == i_second.devAddr) );
}
private:
EepromInfo_t& iv_first;
};
/**
* @brief Add any new EEPROMs associated with this target
* to the list
* @param[in] i_list : list of previously discovered EEPROMs
* @param[out] i_targ : owner of EEPROMs to add
*/
void add_to_list( std::list<EepromInfo_t>& i_list,
TARGETING::Target* i_targ )
{
TRACDCOMP(g_trac_eeprom,"Targ %.8X",TARGETING::get_huid(i_targ));
// try all defined types of EEPROMs
for( eeprom_chip_types_t eep_type = FIRST_CHIP_TYPE;
eep_type < LAST_CHIP_TYPE;
eep_type = static_cast<eeprom_chip_types_t>(eep_type+1) )
{
bool found_eep = false;
TARGETING::EepromVpdPrimaryInfo eepromData;
switch( eep_type )
{
case VPD_PRIMARY:
if( i_targ->
tryGetAttr<TARGETING::ATTR_EEPROM_VPD_PRIMARY_INFO>
( eepromData ) )
{
found_eep = true;
}
break;
case VPD_BACKUP:
if( i_targ->
tryGetAttr<TARGETING::ATTR_EEPROM_VPD_BACKUP_INFO>
( reinterpret_cast<
TARGETING::ATTR_EEPROM_VPD_BACKUP_INFO_type&>
( eepromData) ) )
{
found_eep = true;
}
break;
case SBE_PRIMARY:
if( i_targ->
tryGetAttr<TARGETING::ATTR_EEPROM_SBE_PRIMARY_INFO>
( reinterpret_cast<
TARGETING::ATTR_EEPROM_SBE_PRIMARY_INFO_type&>
( eepromData) ) )
{
found_eep = true;
}
break;
case SBE_BACKUP:
if( i_targ->
tryGetAttr<TARGETING::ATTR_EEPROM_SBE_BACKUP_INFO>
( reinterpret_cast<
TARGETING::ATTR_EEPROM_SBE_BACKUP_INFO_type&>
( eepromData) ) )
{
found_eep = true;
}
break;
case LAST_CHIP_TYPE:
//only included to catch additional types later on
found_eep = false;
break;
}
if( !found_eep )
{
//nothing to do
continue;
}
// check that the path exists
bool exists = false;
TARGETING::targetService().exists( eepromData.i2cMasterPath,
exists );
if( !exists )
{
continue;
}
// Since it exists, convert to a target
TARGETING::Target* i2cm = TARGETING::targetService()
.toTarget( eepromData.i2cMasterPath );
if( NULL == i2cm )
{
//not sure how this could happen, but just skip it
continue;
}
// ignore anything with junk data
TARGETING::Target * sys = NULL;
TARGETING::targetService().getTopLevelTarget( sys );
if( i2cm == sys )
{
continue;
}
// copy all the data out
EepromInfo_t eep_info;
eep_info.i2cMaster = i2cm;
eep_info.engine = eepromData.engine;
eep_info.port = eepromData.port;
eep_info.devAddr = eepromData.devAddr;
eep_info.device = eep_type;
eep_info.assocTarg = i_targ;
eep_info.sizeKB = eepromData.maxMemorySizeKB;
eep_info.addrBytes = eepromData.byteAddrOffset;
//one more lookup for the speed
TARGETING::ATTR_I2C_BUS_SPEED_ARRAY_type speeds;
if( i2cm->tryGetAttr<TARGETING::ATTR_I2C_BUS_SPEED_ARRAY>
(speeds) )
{
if( (eep_info.engine > I2C_BUS_MAX_ENGINE(speeds))
|| (eep_info.port > I2C_BUS_MAX_PORT(speeds)) )
{
continue;
}
eep_info.busFreq = speeds[eep_info.engine][eep_info.port];
eep_info.busFreq *= 1000; //convert KHz->Hz
}
else
{
continue;
}
// check if the eeprom is already in our list
std::list<EepromInfo_t>::iterator oldeep =
find_if( i_list.begin(), i_list.end(),
isSameEeprom(eep_info) );
if( oldeep == i_list.end() )
{
// didn't find it in our list so stick it into the output list
i_list.push_back(eep_info);
TRACDCOMP(g_trac_eeprom,"--Adding i2cm=%.8X, type=%d, eng=%d, port=%d, addr=%.2X for %.8X", TARGETING::get_huid(i2cm),eep_type,eepromData.engine,eepromData.port, eep_info.devAddr, TARGETING::get_huid(eep_info.assocTarg));
}
else
{
TRACDCOMP(g_trac_eeprom,"--Skipping duplicate i2cm=%.8X, type=%d, eng=%d, port=%d, addr=%.2X for %.8X", TARGETING::get_huid(i2cm),eep_type,eepromData.engine,eepromData.port, eep_info.devAddr, TARGETING::get_huid(eep_info.assocTarg));
}
}
}
/**
* @brief Return a set of information related to every unique
* EEPROM in the system
*/
void getEEPROMs( std::list<EepromInfo_t>& o_info )
{
TRACDCOMP(g_trac_eeprom,">>getEEPROMs()");
// We only want to have a single entry in our list per
// physical EEPROM. Since multiple targets could be
// using the same EEPROM, we need to have a hierarchy
// of importance.
// node/planar > proc > membuf > dimm
// predicate to only look for this that are actually there
TARGETING::PredicateHwas isPresent;
isPresent.reset().poweredOn(true).present(true);
// #1 - Nodes
TARGETING::PredicateCTM nodes( TARGETING::CLASS_ENC,
TARGETING::TYPE_NODE,
TARGETING::MODEL_NA );
TARGETING::PredicatePostfixExpr l_nodeFilter;
l_nodeFilter.push(&isPresent).push(&nodes).And();
TARGETING::TargetRangeFilter node_itr( TARGETING::targetService().begin(),
TARGETING::targetService().end(),
&l_nodeFilter );
for( ; node_itr; ++node_itr )
{
add_to_list( o_info, *node_itr );
}
// #2 - Procs
TARGETING::PredicateCTM procs( TARGETING::CLASS_CHIP,
TARGETING::TYPE_PROC,
TARGETING::MODEL_NA );
TARGETING::PredicatePostfixExpr l_procFilter;
l_procFilter.push(&isPresent).push(&procs).And();
TARGETING::TargetRangeFilter proc_itr( TARGETING::targetService().begin(),
TARGETING::targetService().end(),
&l_procFilter );
for( ; proc_itr; ++proc_itr )
{
add_to_list( o_info, *proc_itr );
}
// #3 - Membufs
TARGETING::PredicateCTM membs( TARGETING::CLASS_CHIP,
TARGETING::TYPE_MEMBUF,
TARGETING::MODEL_NA );
TARGETING::PredicatePostfixExpr l_membFilter;
l_membFilter.push(&isPresent).push(&membs).And();
TARGETING::TargetRangeFilter memb_itr( TARGETING::targetService().begin(),
TARGETING::targetService().end(),
&l_membFilter );
for( ; memb_itr; ++memb_itr )
{
add_to_list( o_info, *memb_itr );
}
// #4 - DIMMs
TARGETING::PredicateCTM dimms( TARGETING::CLASS_CARD,
TARGETING::TYPE_DIMM,
TARGETING::MODEL_NA );
TARGETING::PredicatePostfixExpr l_dimmFilter;
l_dimmFilter.push(&isPresent).push(&dimms).And();
TARGETING::TargetRangeFilter dimm_itr( TARGETING::targetService().begin(),
TARGETING::targetService().end(),
&l_dimmFilter );
for( ; dimm_itr; ++dimm_itr )
{
add_to_list( o_info, *dimm_itr );
}
TRACDCOMP(g_trac_eeprom,"<<getEEPROMs()");
}
} // end namespace EEPROM
|