-
Notifications
You must be signed in to change notification settings - Fork 97
/
eepromdd.C
executable file
·2053 lines (1756 loc) · 73.7 KB
/
eepromdd.C
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
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/i2c/eepromdd.C $ */
/* */
/* OpenPOWER HostBoot Project */
/* */
/* Contributors Listed Below - COPYRIGHT 2011,2017 */
/* [+] 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 <i2c/i2cif.H>
#include "eepromdd.H"
#include "errlud_i2c.H"
// ----------------------------------------------
// 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 );
// Register the perform Op with the routing code for Nodes.
DEVICE_REGISTER_ROUTE( DeviceFW::WILDCARD,
DeviceFW::EEPROM,
TARGETING::TYPE_NODE,
eepromPerformOp );
DEVICE_REGISTER_ROUTE( DeviceFW::WILDCARD,
DeviceFW::EEPROM,
TARGETING::TYPE_MCS,
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 * i2cMasterTarget = 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=%x, len=%d",
(uint64_t) i_opType, i2cInfo.chip, i2cInfo.offset, io_buflen);
#ifdef __HOSTBOOT_RUNTIME
// At runtime the OCC sensor cache will need to be diabled to avoid I2C
// collisions. This bool indicates the sensor cache was enabled but is
// now disabled and needs to be re-enabled when the eeprom op completes.
bool scacDisabled = false;
#endif //__HOSTBOOT_RUNTIME
void * l_pBuffer = io_buffer;
size_t l_currentOpLen = io_buflen;
size_t l_remainingOpLen = io_buflen;
do
{
// Read Attributes needed to complete the operation
err = eepromReadAttributes( i_target,
i2cInfo );
if( err )
{
break;
}
size_t l_snglChipSize = (i2cInfo.devSize_KB * KILOBYTE)
/ i2cInfo.chipCount;
// Check to see if we need to find a new target for
// the I2C Master
err = eepromGetI2CMasterTarget( i_target,
i2cInfo,
i2cMasterTarget );
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;
}
// Adjust offset and devAddr to the correct starting chip
while( i2cInfo.offset >= l_snglChipSize )
{
i2cInfo.offset -= l_snglChipSize;
i2cInfo.devAddr += EEPROM_DEVADDR_INC;
}
// Keep first op length within a chip
if( ( i2cInfo.offset + io_buflen ) > l_snglChipSize )
{
l_currentOpLen = l_snglChipSize - i2cInfo.offset;
}
TRACFCOMP( g_trac_eeprom,
"eepromPerformOp(): i_opType=%d "
"C-p/e/dA=%d-%d/%d/0x%X, offset=0x%X, len=0x%X, "
"snglChipKB=0x%X, chipCount=0x%X, devSizeKB=0x%X", i_opType,
i2cInfo.chip, i2cInfo.port, i2cInfo.engine, i2cInfo.devAddr,
i2cInfo.offset, io_buflen, l_snglChipSize,
i2cInfo.chipCount, i2cInfo.devSize_KB);
#ifdef __HOSTBOOT_RUNTIME
// Disable Sensor Cache if the I2C master target is MEMBUF
if( i2cMasterTarget->getAttr<TARGETING::ATTR_TYPE>() ==
TARGETING::TYPE_MEMBUF )
{
err = I2C::i2cDisableSensorCache(i2cMasterTarget,scacDisabled);
if ( err )
{
break;
}
}
#endif //__HOSTBOOT_RUNTIME
// Do the read or write
while(l_remainingOpLen > 0)
{
if( i_opType == DeviceFW::READ )
{
err = eepromRead( i2cMasterTarget,
l_pBuffer,
l_currentOpLen,
i2cInfo );
}
else if( i_opType == DeviceFW::WRITE )
{
err = eepromWrite( i2cMasterTarget,
l_pBuffer,
l_currentOpLen,
i2cInfo );
}
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 );
}
if ( err )
{
break;
}
// Adjust the buffer pointer and remaining op length
l_pBuffer = (void *)(reinterpret_cast<uint64_t>(l_pBuffer)
+ l_currentOpLen);
l_remainingOpLen -= l_currentOpLen;
if( l_remainingOpLen > l_snglChipSize )
{
// Keep next op length within a chip
l_currentOpLen = l_snglChipSize;
}
else if( l_remainingOpLen > 0 )
{
// Set next op length to what is left to do
l_currentOpLen = l_remainingOpLen;
}
else
{
// Break if there is nothing left to do
break;
}
// Prepare the address at the start of next EEPROM
i2cInfo.offset = 0;
i2cInfo.devAddr += EEPROM_DEVADDR_INC;
} // Do the read or write
} while( 0 );
#ifdef __HOSTBOOT_RUNTIME
// Re-enable sensor cache if it was disabled before the eeprom op and
// the I2C master target is MEMBUF
if( scacDisabled &&
(i2cMasterTarget->getAttr<TARGETING::ATTR_TYPE>() == TARGETING::TYPE_MEMBUF) )
{
errlHndl_t tmp_err = NULL;
tmp_err = I2C::i2cEnableSensorCache(i2cMasterTarget);
if( err && tmp_err)
{
delete tmp_err;
TRACFCOMP(g_trac_eeprom,
ERR_MRK" Enable Sensor Cache failed for HUID=0x%.8X",
TARGETING::get_huid(i2cMasterTarget));
}
else if(tmp_err)
{
err = tmp_err;
}
}
#endif //__HOSTBOOT_RUNTIME
// 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 )
{
TRACUCOMP(g_trac_eeprom, ENTER_MRK"eepromPresence()");
errlHndl_t err = NULL;
bool l_present = false;
TARGETING::Target * i2cMasterTarget = 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,
i2cMasterTarget );
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(i2cMasterTarget,
i2cInfo.port,
i2cInfo.engine,
i2cInfo.devAddr );
if( !l_present )
{
TRACDCOMP(g_trac_eeprom,
ERR_MRK"i2cPresence returned false! chip NOT present!");
break;
}
} while( 0 );
// If there was an error commit the error log
if( err )
{
errlCommit( err, I2C_COMP_ID );
}
TRACDCOMP(g_trac_eeprom, EXIT_MRK"eepromPresence()");
return l_present;
}
#endif
// ------------------------------------------------------------------
// eepromPageOp
// ------------------------------------------------------------------
errlHndl_t eepromPageOp( TARGETING::Target * i_target,
bool i_switchPage,
bool i_lockMutex,
bool & io_pageLocked,
uint8_t i_desiredPage,
eeprom_addr_t i_i2cInfo )
{
TRACUCOMP(g_trac_eeprom,
ENTER_MRK"eepromPageOp()");
errlHndl_t l_err = NULL;
size_t l_placeHolderZero = 0;
do
{
// DDR4 requires EEPROM page to be selected before read/write operation.
// The following operation locks the EEPROM_PAGE attribute behind a
// mutex and switches all DIMMs on the I2C bus to the appropriate
// page.
if( i_i2cInfo.addrSize == ONE_BYTE_ADDR_PAGESELECT )
{
bool l_lockPage;
if( i_switchPage )
{
// we want to switch to the desired page
l_lockPage = true;
l_err = deviceOp( DeviceFW::WRITE,
i_target,
NULL,
l_placeHolderZero,
DEVICE_I2C_CONTROL_PAGE_OP(
i_i2cInfo.port,
i_i2cInfo.engine,
l_lockPage,
i_desiredPage,
i_lockMutex ));
if( l_err )
{
TRACFCOMP(g_trac_eeprom,
"eepromPageOp::Failed locking EEPROM page");
break;
}
// if we make it this far, we successfully locked the page mutex
io_pageLocked = true;
}
else
{
// we only want to unlock the page
l_lockPage = false;
l_err = deviceOp( DeviceFW::WRITE,
i_target,
NULL,
l_placeHolderZero,
DEVICE_I2C_CONTROL_PAGE_OP(
i_i2cInfo.port,
i_i2cInfo.engine,
l_lockPage,
l_placeHolderZero,
i_lockMutex ));
if( l_err )
{
TRACFCOMP( g_trac_eeprom,
"eepromPageOp()::failed unlocking EEPROM page");
break;
}
// if we make it this far, we successfully unlocked the page
io_pageLocked = false;
}
}
}while(0);
TRACUCOMP(g_trac_eeprom,
EXIT_MRK"eepromPageOp()");
return l_err;
}
// ------------------------------------------------------------------
// crossesEepromPageBoundary
// ------------------------------------------------------------------
bool crossesEepromPageBoundary( uint64_t i_originalOffset,
size_t i_originalLen,
size_t & io_newLen,
size_t & o_pageTwoBuflen,
eeprom_addr_t i_i2cInfo )
{
bool l_boundaryCrossed = false;
size_t l_higherBound = i_originalOffset + i_originalLen;
if( ( i_i2cInfo.addrSize == ONE_BYTE_ADDR_PAGESELECT ) &&
( ( i_originalOffset < EEPROM_PAGE_SIZE ) &&
( l_higherBound > EEPROM_PAGE_SIZE) ) )
{
// The read/write request crosses the boundary
l_boundaryCrossed = true;
// Calculate the new length of the page 0 buffer and the
// length of the page 1 buffer
o_pageTwoBuflen = l_higherBound - EEPROM_PAGE_SIZE;
io_newLen = i_originalLen - o_pageTwoBuflen;
}
else
{
// The read/write request does not cross the boundary.
// Update new length to be used by subsequent operations
io_newLen = i_originalLen;
o_pageTwoBuflen = 0;
}
return l_boundaryCrossed;
}
// ------------------------------------------------------------------
// eepromRead
// ------------------------------------------------------------------
errlHndl_t eepromRead ( TARGETING::Target * i_target,
void * o_buffer,
size_t i_buflen,
eeprom_addr_t i_i2cInfo )
{
errlHndl_t err = NULL;
uint8_t byteAddr[MAX_BYTE_ADDR];
size_t byteAddrSize = 0;
bool l_pageLocked = false;
uint8_t l_desiredPage = 0;
bool l_boundaryCrossed = false;
size_t l_readBuflen = 0;
size_t l_pageTwoBuflen = 0;
TRACUCOMP( g_trac_eeprom,
ENTER_MRK"eepromRead()" );
do
{
TRACUCOMP( g_trac_eepromr,
"EEPROM READ START : Chip: %02d : Offset %.2X : Len %d",
i_i2cInfo.chip, i_i2cInfo.offset, i_buflen );
// Check to see if the Read operation straddles the EEPROM page
//boundary
l_boundaryCrossed = crossesEepromPageBoundary( i_i2cInfo.offset,
i_buflen,
l_readBuflen,
l_pageTwoBuflen,
i_i2cInfo );
// Set addressing parameters
err = eepromPrepareAddress( i_target,
&byteAddr,
byteAddrSize,
l_desiredPage,
i_i2cInfo);
if( err )
{
TRACFCOMP(g_trac_eeprom,
ERR_MRK"eepromRead()::eepromPrepareAddress()");
break;
}
// Attempt to lock page mutex
bool l_switchPage = true;
bool l_lockMutex = true;
err = eepromPageOp( i_target,
l_switchPage,
l_lockMutex,
l_pageLocked,
l_desiredPage,
i_i2cInfo );
if( err )
{
TRACFCOMP(g_trac_eeprom,
"eepromRead()::eepromPageOp()::failed locking page");
break;
}
// Lock to sequence operations
mutex_lock( &g_eepromMutex );
// First Read. If Second read is necessary, this call will read
// everything from the original offset up to the 256th byte
err = eepromReadData( i_target,
o_buffer,
l_readBuflen,
&byteAddr,
byteAddrSize,
i_i2cInfo );
if( err )
{
TRACFCOMP(g_trac_eeprom,
"Failed reading data: original read");
break;
}
// Perform the second Read if necessary. Read starts at
// begining of EEPROM page 1 (offset=0x100) and reads the
// rest of the required data.
if( l_boundaryCrossed )
{
//Prepare the address to read at the start of EEPROM page one
i_i2cInfo.offset = EEPROM_PAGE_SIZE; // 0x100
err = eepromPrepareAddress( i_target,
&byteAddr,
byteAddrSize,
l_desiredPage,
i_i2cInfo );
if( err )
{
TRACFCOMP(g_trac_eeprom,
"Error preparing address: second eeprom read");
break;
}
// Switch to the second EEPROM page
l_switchPage = true;
l_lockMutex = false;
err = eepromPageOp( i_target,
l_switchPage,
l_lockMutex,
l_pageLocked,
l_desiredPage,
i_i2cInfo );
if( err )
{
TRACFCOMP( g_trac_eeprom,
"Failed switching to EEPROM page 1 for second read op");
break;
}
// Perform the second read operation
err = eepromReadData(
i_target,
&(reinterpret_cast<uint8_t*>(o_buffer)[l_readBuflen]),
l_pageTwoBuflen,
&byteAddr,
byteAddrSize,
i_i2cInfo );
if( err )
{
TRACFCOMP( g_trac_eeprom,
"Failed reading data: second read");
break;
}
}
TRACUCOMP( 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 );
// Unlock eeprom mutex no matter what
mutex_unlock( & g_eepromMutex );
// Whether we failed in the main routine or not, unlock page iff the page is locked
if( l_pageLocked )
{
errlHndl_t l_pageOpErrl = NULL;
bool l_switchPage = false;
bool l_lockMutex = false;
l_pageOpErrl = eepromPageOp( i_target,
l_switchPage,
l_lockMutex,
l_pageLocked,
l_desiredPage,
i_i2cInfo );
if( l_pageOpErrl )
{
TRACFCOMP(g_trac_eeprom,
"eepromRead()::Failed unlocking page");
errlCommit(l_pageOpErrl, I2C_COMP_ID);
}
}
TRACUCOMP( g_trac_eeprom,
EXIT_MRK"eepromRead()" );
return err;
} // end eepromRead
// ------------------------------------------------------------------
// eepromReadData
// ------------------------------------------------------------------
errlHndl_t eepromReadData( TARGETING::Target * i_target,
void * o_buffer,
size_t i_buflen,
void * i_byteAddress,
size_t i_byteAddressSize,
eeprom_addr_t i_i2cInfo )
{
errlHndl_t l_err = NULL;
errlHndl_t err_NACK = NULL;
TRACUCOMP(g_trac_eeprom,
ENTER_MRK"eepromReadData()");
do
{
/***********************************************************/
/* 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 != i_byteAddressSize )
{
// Use the I2C OFFSET Interface for the READ
l_err = deviceOp( DeviceFW::READ,
i_target,
o_buffer,
i_buflen,
DEVICE_I2C_ADDRESS_OFFSET(
i_i2cInfo.port,
i_i2cInfo.engine,
i_i2cInfo.devAddr,
i_byteAddressSize,
reinterpret_cast<uint8_t*>(i_byteAddress)));
if( l_err )
{
TRACFCOMP(g_trac_eeprom,
ERR_MRK"eepromReadData(): I2C Read-Offset failed on "
"%d/%d/0x%X aS=%d",
i_i2cInfo.port, i_i2cInfo.engine,
i_i2cInfo.devAddr, i_byteAddressSize);
TRACFBIN(g_trac_eeprom, "i_byteAddress[]",
i_byteAddress, i_byteAddressSize);
// Don't break here -- error handled below
}
}
else
{
// Do the actual read via I2C
l_err = deviceOp( DeviceFW::READ,
i_target,
o_buffer,
i_buflen,
DEVICE_I2C_ADDRESS( i_i2cInfo.port,
i_i2cInfo.engine,
i_i2cInfo.devAddr ) );
if( l_err )
{
TRACFCOMP(g_trac_eeprom,
ERR_MRK"eepromReadData(): 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 ( l_err == NULL )
{
// Operation completed successfully
// break from retry loop
break;
}
else if ( l_err->reasonCode() != I2C::I2C_NACK_ONLY_FOUND )
{
// Only retry on NACK failures: break from retry loop
TRACFCOMP( g_trac_eeprom, ERR_MRK"eepromReadData(): Non-Nack "
"Error: rc=0x%X, tgt=0x%X, No Retry (retry=%d)",
l_err->reasonCode(),
TARGETING::get_huid(i_target), retry);
l_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 = l_err;
TRACFCOMP( g_trac_eeprom, ERR_MRK"eepromReadData(): "
"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"eepromReadData(): "
"Another NACK Error rc=0x%X, eid=0x%X "
"plid=0x%X, tgt=0x%X, retry/MAX=%d/%d. "
"Delete error and retry",
l_err->reasonCode(), l_err->eid(), l_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 l_err;
l_err = NULL;
}
// continue to retry
continue;
}
else // no more retries: trace and break
{
TRACFCOMP( g_trac_eeprom, ERR_MRK"eepromReadData(): "
"Error rc=0x%X, eid=%d, tgt=0x%X. No More "
"Retries (retry/MAX=%d/%d). Returning Error",
l_err->reasonCode(), l_err->eid(),
TARGETING::get_huid(i_target),
retry, EEPROM_MAX_NACK_RETRIES);
l_err->collectTrace(EEPROM_COMP_NAME);
// break from retry loop
break;
}
}
} // end of retry loop
// Handle saved NACK error, if any
if (err_NACK)
{
if (l_err)
{
// commit original NACK error with new err PLID
err_NACK->plid(l_err->plid());
TRACFCOMP(g_trac_eeprom, "eepromReadData(): Committing saved NACK "
"l_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, "eepromReadData(): Op successful, "
"deleting saved NACK err eid=0x%X, plid=0x%X",
err_NACK->eid(), err_NACK->plid());
delete err_NACK;
err_NACK = NULL;
}
}
}while( 0 );
TRACUCOMP(g_trac_eeprom,
EXIT_MRK"eepromReadData");
return l_err;
}
// ------------------------------------------------------------------
// eepromWrite
// ------------------------------------------------------------------
errlHndl_t eepromWrite ( TARGETING::Target * i_target,
void * io_buffer,
size_t & io_buflen,
eeprom_addr_t i_i2cInfo )
{
errlHndl_t err = NULL;
uint8_t l_desiredPage = 0;
uint8_t l_originalPage = 0;
uint8_t byteAddr[MAX_BYTE_ADDR];
size_t byteAddrSize = 0;
uint8_t * newBuffer = NULL;
bool needFree = false;
bool unlock = false;
bool l_pageLocked = false;
uint32_t data_left = 0;
uint32_t diff_wps = 0;
size_t l_writeBuflen = 0;
size_t l_bytesIntoSecondPage = 0;
TRACDCOMP( g_trac_eeprom,
ENTER_MRK"eepromWrite()" );
do
{
TRACUCOMP( g_trac_eeprom,
"EEPROM WRITE START : Chip: %02d : Offset %.2X : Len %d : %016llx",
i_i2cInfo.chip, i_i2cInfo.offset, io_buflen,
*((uint64_t*)io_buffer) );
// Prepare address parameters
err = eepromPrepareAddress( i_target,
&byteAddr,
byteAddrSize,
l_desiredPage,
i_i2cInfo);
if( err )
{
TRACFCOMP(g_trac_eeprom,
ERR_MRK"eepromWrite()::eepromPrepareAddress()");
break;
}
// Save original Page
l_originalPage = l_desiredPage;
// Attempt to lock page mutex
bool l_switchPage = true; // true: Lock and switch page
// false: Just unlock page
bool l_lockMutex = true; // true: Lock mutex
// false: Skip locking mutex step
err = eepromPageOp( i_target,
l_switchPage,
l_lockMutex,
l_pageLocked,
l_desiredPage,
i_i2cInfo );
if( err )
{
TRACFCOMP(g_trac_eeprom,
"eepromWrite()::Failed locking EEPROM page");
break;
}
// Check for writePageSize of zero
if ( i_i2cInfo.writePageSize == 0 )
{
TRACFCOMP( g_trac_eeprom,
ERR_MRK"eepromWrite(): writePageSize is 0!");
/*@
* @errortype
* @reasoncode EEPROM_I2C_WRITE_PAGE_SIZE_ZERO
* @severity ERRL_SEV_UNRECOVERABLE
* @moduleid EEPROM_WRITE
* @userdata1 HUID of target
* @userdata2 Chip to Access
* @devdesc I2C write page size is zero.
*/