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
1519
|
/* IBM_PROLOG_BEGIN_TAG */
/* This is an automatically generated prolog. */
/* */
/* $Source: src/usr/pnor/pnordd.C $ */
/* */
/* IBM CONFIDENTIAL */
/* */
/* COPYRIGHT International Business Machines Corp. 2011,2012 */
/* */
/* p1 */
/* */
/* Object Code Only (OCO) source materials */
/* Licensed Internal Code Source Materials */
/* IBM HostBoot Licensed Internal Code */
/* */
/* The source code for this program is not published or otherwise */
/* divested of its trade secrets, irrespective of what has been */
/* deposited with the U.S. Copyright Office. */
/* */
/* Origin: 30 */
/* */
/* IBM_PROLOG_END_TAG */
/**
* @file pnordd.C
*
* @brief Implementation of the PNOR Device Driver
*/
/*****************************************************************************/
// I n c l u d e s
/*****************************************************************************/
#include <sys/mmio.h>
#include <sys/task.h>
#include <sys/sync.h>
#include <string.h>
#include <devicefw/driverif.H>
#include <trace/interface.H>
#include <errl/errlentry.H>
#include <targeting/common/targetservice.H>
#include <errl/errlmanager.H>
#include "pnordd.H"
#include <pnor/pnorif.H>
#include <pnor/pnor_reasoncodes.H>
#include <sys/time.h>
// Uncomment this to enable smart writing
//#define SMART_WRITE
extern trace_desc_t* g_trac_pnor;
namespace PNOR
{
enum {
VPO_MODE_MEMCPY = 0xFAC0FAC0FAC0FAC0,
VPO_MODE_MMIO = 0xDAB0DAB0DAB0DAB0,
};
/**
* @brief Performs an PNOR Read Operation
* This function performs a PNOR Read operation. It follows a pre-defined
* prototype functions in order to be registered with the device-driver
* framework.
*
* @param[in] i_opType Operation type, see DeviceFW::OperationType
* in driverif.H
* @param[in] i_target PNOR target
* @param[in/out] io_buffer Read: Pointer to output data storage
* Write: Pointer to input data storage
* @param[in/out] io_buflen Input: size of io_buffer (in bytes)
* Output:
* Read: Size of output data
* Write: Size of data written
* @param[in] i_accessType DeviceFW::AccessType enum (usrif.H)
* @param[in] i_args This is an argument list for DD framework.
* In this function, there's only one argument,
* containing the PNOR address and chip select
* @return errlHndl_t
*/
errlHndl_t ddRead(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 l_err = NULL;
uint64_t l_addr = va_arg(i_args,uint64_t);
do{
//@todo (RTC:34763) - add support for unaligned data
// Ensure we are operating on a 32-bit (4-byte) boundary
assert( reinterpret_cast<uint64_t>(io_buffer) % 4 == 0 );
assert( io_buflen % 4 == 0 );
// Read the flash
l_err = Singleton<PnorDD>::instance().readFlash(io_buffer,
io_buflen,
l_addr);
if(l_err)
{
break;
}
}while(0);
return l_err;
}
/**
* @brief Performs an PNOR Write Operation
* This function performs a PNOR Write operation. It follows a pre-defined
* prototype functions in order to be registered with the device-driver
* framework.
*
* @param[in] i_opType Operation type, see DeviceFW::OperationType
* in driverif.H
* @param[in] i_target PNOR target
* @param[in/out] io_buffer Read: Pointer to output data storage
* Write: Pointer to input data storage
* @param[in/out] io_buflen Input: size of io_buffer (in bytes)
* Output:
* Read: Size of output data
* Write: Size of data written
* @param[in] i_accessType DeviceFW::AccessType enum (usrif.H)
* @param[in] i_args This is an argument list for DD framework.
* In this function, there's only one argument,
* containing the PNOR address and chip select
* @return errlHndl_t
*/
errlHndl_t ddWrite(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 l_err = NULL;
uint64_t l_addr = va_arg(i_args,uint64_t);
do{
//@todo (RTC:34763) - add support for unaligned data
// Ensure we are operating on a 32-bit (4-byte) boundary
assert( reinterpret_cast<uint64_t>(io_buffer) % 4 == 0 );
assert( io_buflen % 4 == 0 );
// Write the flash
l_err = Singleton<PnorDD>::instance().writeFlash(io_buffer,
io_buflen,
l_addr);
if(l_err)
{
break;
}
}while(0);
return l_err;
}
// Register PNORDD access functions to DD framework
DEVICE_REGISTER_ROUTE(DeviceFW::READ,
DeviceFW::PNOR,
TARGETING::TYPE_PROC,
ddRead);
DEVICE_REGISTER_ROUTE(DeviceFW::WRITE,
DeviceFW::PNOR,
TARGETING::TYPE_PROC,
ddWrite);
}; //namespace PNOR
///////////////////////////////////////////////////////////////////////////////
///////////////////////////////////////////////////////////////////////////////
/**
* @brief Performs a PNOR Read Operation
*/
errlHndl_t PnorDD::readFlash(void* o_buffer,
size_t& io_buflen,
uint64_t i_address)
{
//TRACDCOMP(g_trac_pnor, "PnorDD::readFlash(i_address=0x%llx)> ", i_address);
errlHndl_t l_err = NULL;
do{
//mask off chip select for now, will probably break up fake PNOR into
//multiple fake chips eventually
uint64_t l_address = i_address & 0x00000000FFFFFFFF;
// skip everything in MEMCPY mode
if( MODEL_MEMCPY == iv_mode )
{
read_fake_pnor( l_address, o_buffer, io_buflen );
break;
}
//trace each page when running in VPO to show we're making progress.
//TODO: Remove after we get more PNOR runtime in VPO. RTC: 45885
if(0 != iv_vpoMode)
{
TRACFCOMP(g_trac_pnor,"PNOR read of address %.8X, size=0x%X", i_address, io_buflen);
}
//If we get here we're doing either MODEL_LPC_MEM, MODEL_REAL_CMD, or MODEL_REAL_MMIO
mutex_lock(&cv_mutex);
l_err = bufferedSfcRead(i_address, io_buflen, o_buffer);
mutex_unlock(&cv_mutex);
if(l_err) { break;}
}while(0);
return l_err;
}
/**
* @brief Performs a PNOR Write Operation
*/
errlHndl_t PnorDD::writeFlash(void* i_buffer,
size_t& io_buflen,
uint64_t i_address)
{
//TRACDCOMP(g_trac_pnor, "PnorDD::writeFlash(i_address=0x%llx)> ", i_address);
errlHndl_t l_err = NULL;
do{
TRACDCOMP(g_trac_pnor,"PNOR write %.8X", i_address);
//mask off chip select for now, will probably break up fake PNOR into
//multiple fake chips eventually
uint64_t l_address = i_address & 0x00000000FFFFFFFF;
// skip everything in MEMCPY mode
if( MODEL_MEMCPY == iv_mode )
{
write_fake_pnor( l_address, i_buffer, io_buflen );
break;
}
//If we get here we're doing either MODEL_LPC_MEM, MODEL_REAL_CMD, or MODEL_REAL_MMIO
//If we're in VPO, just do the write directly (no erases)
if(0 != iv_vpoMode)
{
mutex_lock(&cv_mutex);
//TODO: Remove trace after we get more PNOR runtime in VPO. RTC: 45885
TRACFCOMP(g_trac_pnor,"PNOR write %.8X, skipping right to bufferedSfcWrite to improve performance", i_address);
l_err = bufferedSfcWrite(static_cast<uint32_t>(l_address),
8,
i_buffer);
mutex_unlock(&cv_mutex);
break;
}
// LPC is accessed 32-bits at a time, but SFC has a 256byte buffer
// but we also need to be smart about handling erases. In NOR
// flash we can clear bits without an erase but we cannot set them.
// When we erase we have to erase an entire block of data at a time.
uint32_t cur_writeStart_addr = static_cast<uint32_t>(l_address);
uint32_t cur_blkStart_addr = findEraseBlock(cur_writeStart_addr);
uint32_t cur_blkEnd_addr = cur_blkStart_addr + iv_erasesize_bytes;
uint32_t write_bytes = iv_erasesize_bytes;
uint64_t num_blocks = getNumAffectedBlocks(cur_writeStart_addr,io_buflen);
uint64_t bytes_left = io_buflen;
// loop through erase blocks until we've gotten through all
// affected blocks
for( uint64_t block = 0;
block < num_blocks;
++block )
{
write_bytes = iv_erasesize_bytes;
if(bytes_left < iv_erasesize_bytes )
{
uint32_t end_waste = 0;
//deduct any unused space at the end of the erase block
if( cur_blkEnd_addr > (cur_writeStart_addr + bytes_left))
{
end_waste = cur_blkEnd_addr - (cur_writeStart_addr + bytes_left);
write_bytes -= end_waste;
}
//deduct any unused space at the beginning of the erase block
write_bytes = write_bytes - (cur_writeStart_addr - cur_blkStart_addr);
}
// write a single block of data out to flash efficiently
mutex_lock(&cv_mutex);
l_err = compareAndWriteBlock(cur_blkStart_addr,
cur_writeStart_addr,
write_bytes,
(void*)((uint64_t)i_buffer + ((uint64_t)cur_writeStart_addr-l_address)));
mutex_unlock(&cv_mutex);
if( l_err ) { break; }
//@todo (RTC:37744) - How should we handle PNOR errors?
cur_blkStart_addr = cur_blkEnd_addr; //move start to end of current erase block
cur_blkEnd_addr += iv_erasesize_bytes;; //increment end by erase block size.
cur_writeStart_addr += write_bytes;
bytes_left -= write_bytes;
}
if( l_err ) { break; }
}while(0);
// keeping track of every actual byte written is complicated and it can
// be misleading in the cases where we end up erasing and writing an
// entire block, instead just return zero for any failures
if( l_err )
{
io_buflen = 0;
}
return l_err;
}
/********************
Private/Protected Methods
********************/
mutex_t PnorDD::cv_mutex = MUTEX_INITIALIZER;
uint64_t PnorDD::iv_vpoMode = 0;
//
// @note fake pnor is moved up and shrunk by 1/2 meg to make room for
// the SLW image, it must be at a 1 M boundary.
// See build_winkle_images for more info.
//
#define FAKE_PNOR_START 4*MEGABYTE+512*KILOBYTE
#define FAKE_PNOR_END 8*MEGABYTE
#define FAKE_PNOR_SIZE 3*MEGABYTE+512*KILOBYTE
/**
* @brief Constructor
*/
PnorDD::PnorDD( PnorMode_t i_mode,
uint64_t i_fakeStart,
uint64_t i_fakeSize )
: iv_mode(i_mode)
{
iv_erasesize_bytes = ERASESIZE_BYTES_DEFAULT;
//Zero out erase counter
memset(iv_erases, 0xff, sizeof(iv_erases));
//Use real PNOR for everything except VPO
if(0 == iv_vpoMode)
{
iv_vpoMode = mmio_scratch_read(MMIO_SCRATCH_PNOR_MODE);
}
//In the normal case we will choose the mode for the caller
if( MODEL_UNKNOWN == iv_mode )
{
if(iv_vpoMode == PNOR::VPO_MODE_MEMCPY)
{
//VPO override set -- use fastest method -- memcpy
TRACFCOMP(g_trac_pnor,"PNORDD: Running in MEMCPY mode for VPO");
iv_mode = MODEL_MEMCPY;
}
else if(iv_vpoMode == PNOR::VPO_MODE_MMIO)
{
//VPO override set -- use MMIO mode
TRACFCOMP(g_trac_pnor,"PNORDD: Running in VPO Mode, writes will not trigger erase attempts");
iv_mode = MODEL_REAL_MMIO;
}
else
{
//Normal mode
iv_mode = MODEL_REAL_MMIO;
}
}
if( (MODEL_MEMCPY == iv_mode) ||
(MODEL_LPC_MEM == iv_mode) )
{
//Only use input fake values if they are != zero
iv_fakeStart = (i_fakeStart != 0) ? i_fakeStart : FAKE_PNOR_START;
iv_fakeSize = (i_fakeSize != 0) ? i_fakeSize : FAKE_PNOR_SIZE;
}
if( (MODEL_REAL_CMD == iv_mode) ||
(MODEL_REAL_MMIO == iv_mode) )
{
sfcInit( );
}
TRACFCOMP(g_trac_pnor, "PnorDD::PnorDD()> Using mode %d", iv_mode);
}
/**
* @brief Destructor
*/
PnorDD::~PnorDD()
{
}
bool PnorDD::cv_sfcInitDone = false; //Static flag to ensure we only init the SFC one time.
uint32_t PnorDD::cv_nor_chipid = 0; //Detected NOR Flash Type
/**
* STATIC
* @brief Static Initializer
*/
void PnorDD::sfcInit( )
{
TRACDCOMP(g_trac_pnor, "PnorDD::sfcInit> iv_mode=0x%.8x", iv_mode );
errlHndl_t l_err = NULL;
//Initial configuration settings for SFC:
#define oadrnb_init 0x04000000 //Set MMIO/Direct window to start at 64MB
#define oadrns_init 0x0000000F //Set the MMIO/Direct window size to 64MB
#define adrcbf_init 0x00000000 //Set the flash index to 0
#define adrcmf_init 0x0000000F //Set the flash size to 64MB
#define conf_init 0x00000002 //Disable Direct Access Cache
do {
mutex_lock(&cv_mutex);
if(!cv_sfcInitDone)
{
l_err = writeRegSfc(SFC_CMD_SPACE,
SFC_REG_OADRNB,
oadrnb_init);
if(l_err) { break; }
l_err = writeRegSfc(SFC_CMD_SPACE,
SFC_REG_OADRNS,
oadrns_init);
if(l_err) { break; }
l_err = writeRegSfc(SFC_CMD_SPACE,
SFC_REG_ADRCBF,
adrcbf_init);
if(l_err) { break; }
l_err = writeRegSfc(SFC_CMD_SPACE,
SFC_REG_ADRCMF,
adrcmf_init);
if(l_err) { break; }
l_err = writeRegSfc(SFC_CMD_SPACE,
SFC_REG_CONF,
conf_init);
if(l_err) { break; }
//Determine NOR Flash type, configure SFC and PNOR DD as needed
l_err = getNORChipId(cv_nor_chipid);
TRACFCOMP(g_trac_pnor, "PnorDD::sfcInit: cv_nor_chipid=0x%.8x> ", cv_nor_chipid );
//TODO: Need to add support for VPO (RTC: 42325), Spansion NOR (RTC: 42326),
// Micron NOR (RTC: 42328), Macronix (RTC: 42330), and Simics (RTC: 42331)
// There will probably be some overlap between those stories, but keeping them
// all separate for now to ensure everything is covered.
if(SIMICS_NOR_ID == cv_nor_chipid)
{
TRACFCOMP(g_trac_pnor, "PnorDD::sfcInit: Configuring SFC for SIMICS NOR> " );
uint32_t sm_erase_op = SPI_SIM_SM_ERASE_OP;
iv_erasesize_bytes = SPI_SIM_SM_ERASE_SZ;
/*Simics model doesn't currently support this*/
l_err = writeRegSfc(SFC_CMD_SPACE,
SFC_REG_CONF4,
sm_erase_op);
if(l_err) { break; }
l_err = writeRegSfc(SFC_CMD_SPACE,
SFC_REG_CONF5,
iv_erasesize_bytes);
if(l_err) { break; }
//Enable 4-byte addressing for Macronix-type device
SfcCmdReg_t sfc_cmd;
sfc_cmd.opcode = SPI_START4BA;
sfc_cmd.length = 0;
l_err = writeRegSfc(SFC_CMD_SPACE,
SFC_REG_CMD,
sfc_cmd.data32);
if(l_err) { break; }
}
else if(VPO_NOR_ID == cv_nor_chipid)
{
TRACFCOMP( g_trac_pnor, "PnorDD::sfcInit> Detected VPO NOR Chip(0x%.4X). Erase not currently supported", cv_nor_chipid );
//Set chip ID back to zero to avoid later chip specific logic.
cv_nor_chipid = 0;
}
else
{
TRACFCOMP( g_trac_pnor, "PnorDD::sfcInit> Unsupported NOR type detected : cv_nor_chipid=%.4X", cv_nor_chipid );
/*@
* @errortype
* @moduleid PNOR::MOD_PNORDD_SFCINIT
* @reasoncode PNOR::RC_UNSUPORTED_HARDWARE
* @userdata1 NOR Flash Chip ID
* @userdata2 <not used>
* @devdesc PnorDD::sfcInit>
*/
l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
PNOR::MOD_PNORDD_SFCINIT,
PNOR::RC_UNSUPORTED_HARDWARE,
TO_UINT64(cv_nor_chipid));
//@todo: Leave FFDC Breadcrumbs and assert on unsupported chip... RTC: 44146.
//Set chip ID back to zero to avoid later chip specific logic.
cv_nor_chipid = 0;
}
cv_sfcInitDone = true;
}
}while(0);
mutex_unlock(&cv_mutex);
if( l_err )
{
errlCommit(l_err,PNOR_COMP_ID);
}
}
/**
* @brief Write a SFC Register
*/
errlHndl_t PnorDD::writeRegSfc(SfcRange i_range,
uint32_t i_addr,
uint32_t i_data)
{
errlHndl_t l_err = NULL;
uint32_t lpc_addr;
if(SFC_CMD_SPACE == i_range)
{
lpc_addr = LPC_SFC_CMDREG_OFFSET | i_addr;
}
else if (SFC_CMDBUF_SPACE == i_range)
{
lpc_addr = LPC_SFC_CMDBUF_OFFSET | i_addr;
}
else
{
lpc_addr = LPC_SFC_MMIO_OFFSET | i_addr;
}
TRACDCOMP( g_trac_pnor, "PnorDD::writeRegSfc> lpc_addr=0x%.8x, i_data=0x%.8x",
lpc_addr, i_data );
l_err = writeLPC(lpc_addr, i_data);
return l_err;
}
/**
* @brief Read a SFC Register
*/
errlHndl_t PnorDD::readRegSfc(SfcRange i_range,
uint32_t i_addr,
uint32_t& o_data)
{
errlHndl_t l_err = NULL;
uint32_t lpc_addr;
if(SFC_CMD_SPACE == i_range)
{
lpc_addr = LPC_SFC_CMDREG_OFFSET | i_addr;
}
else if (SFC_CMDBUF_SPACE == i_range)
{
lpc_addr = LPC_SFC_CMDBUF_OFFSET | i_addr;
}
else
{
lpc_addr = LPC_SFC_MMIO_OFFSET | i_addr;
}
l_err = readLPC(lpc_addr, o_data);
TRACDCOMP( g_trac_pnor, "PnorDD::readRegSfc> lpc_addr=0x%.8x, o_data=0x%.8x",
lpc_addr, o_data );
return l_err;
}
/**
* @brief Poll for SFC Op Complete
*/
errlHndl_t PnorDD::pollSfcOpComplete(uint64_t i_pollTime)
{
errlHndl_t l_err = NULL;
TRACDCOMP( g_trac_pnor, "PnorDD::pollSfcOpComplete> i_pollTime=0x%.8x",
i_pollTime );
do {
//Poll for complete status
SfcStatReg_t sfc_stat;
uint64_t poll_time = 0;
uint64_t loop = 0;
while( poll_time < i_pollTime )
{
l_err = readRegSfc(SFC_CMD_SPACE,
SFC_REG_STATUS,
sfc_stat.data32);
if(l_err) { break; }
if( sfc_stat.done == 1 )
{
break;
}
// want to start out incrementing by small numbers then get bigger
// to avoid a really tight loop in an error case so we'll increase
// the wait each time through
//TODO tmp remove for VPO, need better polling strategy -- RTC43738
//nanosleep( 0, SFC_POLL_INCR_NS*(++loop) );
poll_time += SFC_POLL_INCR_NS*loop;
}
if( l_err ) { break; }
// check for errors or timeout
// TODO: What errors do we check?
if( (sfc_stat.done == 0) )
{
TRACFCOMP(g_trac_pnor, "PnorDD::pollSfcOpComplete> Error or timeout from LPC Status Register" );
/*@
* @errortype
* @moduleid PNOR::MOD_PNORDD_POLLSFCOPCOMPLETE
* @reasoncode PNOR::RC_LPC_ERROR
* @userdata1[0:31] NOR Flash Chip ID
* @userdata1[32:63] Total poll time (ns)
* @userdata2[0:31] ECCB Status Register
* @devdesc PnorDD::readLPC> Error or timeout from
* LPC Status Register
*/
l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
PNOR::MOD_PNORDD_POLLSFCOPCOMPLETE,
PNOR::RC_LPC_ERROR,
TWO_UINT32_TO_UINT64(cv_nor_chipid,poll_time),
TWO_UINT32_TO_UINT64(sfc_stat.data32,0));
l_err->collectTrace("PNOR");
l_err->collectTrace("XSCOM");
//@todo (RTC:37744) - Any cleanup or recovery needed?
break;
}
}while(0);
return l_err;
}
/**
* @brief Read the NOR FLash ChipID
*/
errlHndl_t PnorDD::getNORChipId(uint32_t& o_chipId,
uint32_t i_spiOpcode)
{
errlHndl_t l_err = NULL;
TRACDCOMP( g_trac_pnor, "PnorDD::getNORChipId> i_spiOpcode=0x%.8x",
i_spiOpcode );
do {
//Issue Get Chip ID command
SfcCmdReg_t sfc_cmd;
sfc_cmd.opcode = i_spiOpcode;
sfc_cmd.length = 0;
l_err = writeRegSfc(SFC_CMD_SPACE,
SFC_REG_CMD,
sfc_cmd.data32);
if(l_err) { break; }
//Poll for complete status
l_err = pollSfcOpComplete();
if(l_err) { break; }
//Read the ChipID from the Command Buffer
l_err = readRegSfc(SFC_CMDBUF_SPACE,
0, //Offset into CMD BUFF space in bytes
o_chipId);
if(l_err) {
break;
}
// Only look at a portion of the data that is returned
o_chipId &= ID_MASK;
}while(0);
return l_err;
}
/**
* @brief Load SFC command buffer with data from PNOR
*/
errlHndl_t PnorDD::loadSfcBuf(uint32_t i_addr,
size_t i_size)
{
errlHndl_t l_err = NULL;
TRACDCOMP( g_trac_pnor, "PnorDD::loadSfcBuf> i_addr=0x%.8x, i_size=0x%.8x",
i_addr, i_size );
do {
//Write flash address to ADR reg
l_err = writeRegSfc(SFC_CMD_SPACE,
SFC_REG_ADR,
i_addr);
if(l_err) { break; }
//Issue ReadRaw command with size to read
SfcCmdReg_t sfc_cmd;
sfc_cmd.opcode = SFC_OP_READRAW;
sfc_cmd.length = i_size;
l_err = writeRegSfc(SFC_CMD_SPACE,
SFC_REG_CMD,
sfc_cmd.data32);
if(l_err) { break; }
//Poll for complete status
l_err = pollSfcOpComplete();
if(l_err) { break; }
}while(0);
return l_err;
}
/**
* @brief Flush SFC command buffer data to PNOR Flash
*/
errlHndl_t PnorDD::flushSfcBuf(uint32_t i_addr,
size_t i_size)
{
errlHndl_t l_err = NULL;
TRACDCOMP( g_trac_pnor, "PnorDD::flushSfcBuf> i_addr=0x%.8x, i_size=0x%.8x",
i_addr, i_size );
do {
//Write flash address to ADR reg
l_err = writeRegSfc(SFC_CMD_SPACE,
SFC_REG_ADR,
i_addr);
if(l_err) { break; }
//Issue WriteRaw command + size to write
SfcCmdReg_t sfc_cmd;
sfc_cmd.opcode = SFC_OP_WRITERAW;
sfc_cmd.length = i_size;
l_err = writeRegSfc(SFC_CMD_SPACE,
SFC_REG_CMD,
sfc_cmd.data32);
if(l_err) { break; }
//Poll for complete status
l_err = pollSfcOpComplete();
if(l_err) { break; }
}while(0);
return l_err;
}
/**
* @brief Perform command based read of PNOR, maximizing use of
* SFC Command buffer..
*/
errlHndl_t PnorDD::bufferedSfcRead(uint32_t i_addr,
size_t i_size,
void* o_data)
{
errlHndl_t l_err = NULL;
TRACDCOMP( g_trac_pnor, "PnorDD::bufferedSfcRead> i_addr=0x%.8x, i_size=0x%.8x",
i_addr, i_size );
do{
switch(iv_mode)
{
case MODEL_LPC_MEM:
{
read_fake_pnor( i_addr,
o_data,
i_size );
break;
}
case MODEL_REAL_MMIO:
{
//Read directly from MMIO space
uint32_t* word_ptr = static_cast<uint32_t*>(o_data);
uint32_t word_size = i_size/4;
for( uint32_t words_read = 0;
words_read < word_size;
words_read ++ )
{
l_err = readRegSfc(SFC_MMIO_SPACE,
i_addr+words_read*4, //MMIO Address offset
word_ptr[words_read]);
if( l_err ) { break; }
}
break;
}
default:
{
// Note: If we get here then iv_mode is MODEL_REAL_CMD
// Command based reads are buffered 256 bytes at a time.
uint32_t chunk_size = 0;
uint64_t addr = i_addr;
uint64_t end_addr = i_addr + i_size;
while(addr < end_addr)
{
chunk_size = SFC_CMDBUF_SIZE;
if( (addr + SFC_CMDBUF_SIZE) > end_addr)
{
chunk_size = end_addr - addr;
}
//Read data via SFC CMD Buffer
l_err = loadSfcBuf(addr, chunk_size);
if(l_err) { break;}
//read SFC CMD Buffer via MMIO
l_err = readSfcBuffer(chunk_size,
(void*)((uint64_t)o_data + (addr-i_addr)));
if(l_err) { break;}
addr += chunk_size;
}
}
}
}while(0);
return l_err;
}
/**
* @brief Perform command based write of PNOR, maximizing use of
* SFC Command buffer..
*/
errlHndl_t PnorDD::bufferedSfcWrite(uint32_t i_addr,
size_t i_size,
void* i_data)
{
TRACDCOMP( g_trac_pnor, "PnorDD::bufferedSfcWrite> i_addr=0x%.8x, i_size=0x%.8x",
i_addr, i_size );
errlHndl_t l_err = NULL;
do{
switch(iv_mode)
{
case MODEL_LPC_MEM:
{
write_fake_pnor( i_addr,
i_data,
i_size );
break;
}
default:
{
// Note: If we got here then iv_mode is MODEL_REAL_CMD or MODEL_REAL_MMIO
// Command based reads are buffered 256 bytes at a time.
uint32_t chunk_size = 0;
uint64_t addr = i_addr;
uint64_t end_addr = i_addr + i_size;
while(addr < end_addr)
{
chunk_size = SFC_CMDBUF_SIZE;
if( (addr + SFC_CMDBUF_SIZE) > end_addr)
{
chunk_size = end_addr - addr;
}
//write data to SFC CMD Buffer via MMIO
l_err = writeSfcBuffer(chunk_size,
(void*)((uint64_t)i_data + (addr-i_addr)));
if(l_err) { break;}
//Fetch bits into SFC CMD Buffer
l_err = flushSfcBuf(addr, chunk_size);
if(l_err) { break;}
addr += chunk_size;
}
}
}
}while(0);
return l_err;
}
/**
* @brief Read data in SFC Command buffer and put into buffer
*/
errlHndl_t PnorDD::readSfcBuffer(size_t i_size,
void* o_data)
{
errlHndl_t l_err = NULL;
TRACDCOMP( g_trac_pnor, "PnorDD::readSfcBuffer> i_size=0x%.8x",
i_size );
// SFC Command Buffer is accessed 32-bits at a time
uint32_t* word_ptr = static_cast<uint32_t*>(o_data);
uint32_t word_size = i_size/4;
for( uint32_t words_read = 0;
words_read < word_size;
words_read ++ )
{
l_err = readRegSfc(SFC_CMDBUF_SPACE,
words_read*4, //Offset into CMD BUFF space in bytes
word_ptr[words_read]);
TRACDCOMP( g_trac_pnor, "PnorDD::readSfcBuffer: Read offset=0x%.8x, data_read=0x%.8x",
words_read*4, word_ptr[words_read] );
if( l_err ) { break; }
}
return l_err;
}
/**
* @brief Write data to SFC Command buffer
*/
errlHndl_t PnorDD::writeSfcBuffer(size_t i_size,
void* i_data)
{
errlHndl_t l_err = NULL;
TRACDCOMP( g_trac_pnor, "PnorDD::writeSfcBuffer> i_size=0x%.8x",
i_size );
// SFC Command Buffer is accessed 32-bits at a time
uint32_t* word_ptr = static_cast<uint32_t*>(i_data);
uint32_t word_size = i_size/4;
for( uint32_t words_read = 0;
words_read < word_size;
words_read ++ )
{
l_err = writeRegSfc(SFC_CMDBUF_SPACE,
words_read*4, //Offset into CMD BUFF space in bytes
word_ptr[words_read]);
if( l_err ) { break; }
}
return l_err;
}
/**
* @brief Read an address from LPC space
*/
errlHndl_t PnorDD::readLPC(uint32_t i_addr,
uint32_t& o_data)
{
errlHndl_t l_err = NULL;
do {
//@todo (RTC:36950) - add non-master support
TARGETING::Target* scom_target =
TARGETING::MASTER_PROCESSOR_CHIP_TARGET_SENTINEL;
// always read/write 64 bits to SCOM
size_t scom_size = sizeof(uint64_t);
// write command register with LPC address to read
ControlReg_t eccb_cmd;
eccb_cmd.read_op = 1;
eccb_cmd.address = i_addr;
l_err = deviceOp( DeviceFW::WRITE,
scom_target,
&(eccb_cmd.data64),
scom_size,
DEVICE_SCOM_ADDRESS(ECCB_CTL_REG) );
if( l_err ) { break; }
// poll for complete and get the data back
StatusReg_t eccb_stat;
uint64_t poll_time = 0;
uint64_t loop = 0;
while( poll_time < ECCB_POLL_TIME_NS )
{
l_err = deviceOp( DeviceFW::READ,
scom_target,
&(eccb_stat.data64),
scom_size,
DEVICE_SCOM_ADDRESS(ECCB_STAT_REG) );
if( l_err ) { break; }
if( eccb_stat.op_done == 1 )
{
break;
}
// want to start out incrementing by small numbers then get bigger
// to avoid a really tight loop in an error case so we'll increase
// the wait each time through
//TODO tmp remove for VPO, need better polling strategy -- RTC43738
//nanosleep( 0, ECCB_POLL_INCR_NS*(++loop) );
poll_time += ECCB_POLL_INCR_NS*loop;
}
if( l_err ) { break; }
// check for errors or timeout
if( (eccb_stat.data64 & LPC_STAT_REG_ERROR_MASK)
|| (eccb_stat.op_done == 0) )
{
TRACFCOMP(g_trac_pnor, "PnorDD::readLPC> Error or timeout from LPC Status Register : i_addr=0x%.8X, status=0x%.16X", i_addr, eccb_stat.data64 );
/*@
* @errortype
* @moduleid PNOR::MOD_PNORDD_READLPC
* @reasoncode PNOR::RC_LPC_ERROR
* @userdata1[0:31] LPC Address
* @userdata1[32:63] Total poll time (ns)
* @userdata2 ECCB Status Register
* @devdesc PnorDD::readLPC> Error or timeout from
* LPC Status Register
*/
l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
PNOR::MOD_PNORDD_READLPC,
PNOR::RC_LPC_ERROR,
TWO_UINT32_TO_UINT64(i_addr,poll_time),
eccb_stat.data64);
l_err->collectTrace("PNOR");
l_err->collectTrace("XSCOM");
//@todo (RTC:37744) - Any cleanup or recovery needed?
break;
}
// copy data out to caller's buffer
o_data = eccb_stat.read_data;
} while(0);
return l_err;
}
/**
* @brief Write an address from LPC space
*/
errlHndl_t PnorDD::writeLPC(uint32_t i_addr,
uint32_t i_data)
{
errlHndl_t l_err = NULL;
TRACDCOMP(g_trac_pnor, "writeLPC> %.8X = %.8X", i_addr, i_data );
do {
//@todo (RTC:36950) - add non-master support
TARGETING::Target* scom_target =
TARGETING::MASTER_PROCESSOR_CHIP_TARGET_SENTINEL;
// always read/write 64 bits to SCOM
size_t scom_size = sizeof(uint64_t);
// write data register
TRACDCOMP(g_trac_pnor, "writeLPC> Write ECCB data register");
uint64_t eccb_data = static_cast<uint64_t>(i_data);
eccb_data = eccb_data << 32; //left-justify my data
l_err = deviceOp( DeviceFW::WRITE,
scom_target,
&eccb_data,
scom_size,
DEVICE_SCOM_ADDRESS(ECCB_DATA_REG) );
if( l_err ) { break; }
// write command register with LPC address to write
ControlReg_t eccb_cmd;
eccb_cmd.read_op = 0;
eccb_cmd.address = i_addr;
TRACDCOMP(g_trac_pnor, "writeLPC> Write ECCB command register, cmd=0x%.16x", eccb_cmd.data64 );
l_err = deviceOp( DeviceFW::WRITE,
scom_target,
&(eccb_cmd.data64),
scom_size,
DEVICE_SCOM_ADDRESS(ECCB_CTL_REG) );
if( l_err ) { break; }
// poll for complete
StatusReg_t eccb_stat;
uint64_t poll_time = 0;
uint64_t loop = 0;
while( poll_time < ECCB_POLL_TIME_NS )
{
l_err = deviceOp( DeviceFW::READ,
scom_target,
&(eccb_stat.data64),
scom_size,
DEVICE_SCOM_ADDRESS(ECCB_STAT_REG) );
TRACDCOMP(g_trac_pnor, "writeLPC> Poll on ECCB Status, poll_time=0x%.16x, stat=0x%.16x", eccb_stat.data64, poll_time );
if( l_err ) { break; }
if( eccb_stat.op_done == 1 )
{
break;
}
// want to start out incrementing by small numbers then get bigger
// to avoid a really tight loop in an error case so we'll increase
// the wait each time through
//TODO tmp remove for VPO, need better polling strategy -- RTC43738
//nanosleep( 0, ECCB_POLL_INCR_NS*(++loop) );
poll_time += ECCB_POLL_INCR_NS*loop;
}
if( l_err ) { break; }
// check for errors
if( (eccb_stat.data64 & LPC_STAT_REG_ERROR_MASK)
|| (eccb_stat.op_done == 0) )
{
TRACFCOMP(g_trac_pnor, "PnorDD::writeLPC> Error or timeout from LPC Status Register : i_addr=0x%.8X, status=0x%.16X", i_addr, eccb_stat.data64 );
/*@
* @errortype
* @moduleid PNOR::MOD_PNORDD_WRITELPC
* @reasoncode PNOR::RC_LPC_ERROR
* @userdata1 LPC Address
* @userdata2 ECCB Status Register
* @devdesc PnorDD::writeLPC> Error or timeout from
* LPC Status Register
*/
l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
PNOR::MOD_PNORDD_WRITELPC,
PNOR::RC_LPC_ERROR,
TWO_UINT32_TO_UINT64(0,i_addr),
eccb_stat.data64);
l_err->collectTrace("PNOR");
l_err->collectTrace("XSCOM");
//@todo (RTC:37744) - Any cleanup or recovery needed?
break;
}
} while(0);
return l_err;
}
/**
* @brief Compare the existing data in 1 erase block of the flash with
* the incoming data and write or erase as needed
*/
errlHndl_t PnorDD::compareAndWriteBlock(uint32_t i_blockStart,
uint32_t i_writeStart,
size_t i_bytesToWrite,
void* i_data)
{
TRACDCOMP(g_trac_pnor,">>compareAndWriteBlock(0x%.8X,0x%.8X,0x%.8X)", i_blockStart, i_writeStart, i_bytesToWrite);
errlHndl_t l_err = NULL;
uint8_t* read_data = NULL;
do {
// remember any data we read so we don't have to reread it later
read_data = new uint8_t[iv_erasesize_bytes];
// remember if we need to erase the block or not
bool need_erase = false;
bool need_write = false;
//STEP 1: Read data in PNOR for compares (only read section we want to write)
//read_start needs to be uint32* for bitwise word compares later
uint32_t* read_start = (uint32_t*)(read_data + i_writeStart-i_blockStart);
l_err = bufferedSfcRead(i_writeStart,
i_bytesToWrite,
(void*) read_start);
if( l_err ) { break; }
//STEP 2: walk through the write data to see if we need to do an erase
const uint32_t wordsToWrite = i_bytesToWrite/4;
uint32_t* i_dataWord = (uint32_t*) i_data;
for(uint32_t cword = 0; cword < wordsToWrite; cword++)
{
// look for any bits being changed (using XOR)
if(read_start[cword] ^ i_dataWord[cword] )
{
need_write = true;
//Can only write zeros to NOR, see if any bits changed from 0->1
if( (~(read_start[cword])) & (i_dataWord[cword]) )
{
need_erase = true;
// skip comparing the rest of the block,
// just start writing it
break;
}
}
}
if(need_write == false)
{
//No write actually needed, break out here
TRACDCOMP(g_trac_pnor,"compareAndWriteBlock> NO Write Needed! Exiting FUnction");
break;
}
//STEP 3: If the need to erase was detected, read out the rest of the Erase block
if(need_erase)
{
TRACDCOMP(g_trac_pnor,"compareAndWriteBlock> Need to perform Erase");
//Get data before write section
if(i_writeStart > i_blockStart)
{
TRACDCOMP(g_trac_pnor,"compareAndWriteBlock> Reading beginning data i_blockStart=0x%.8x, readLen=0x%.8x",
i_blockStart, i_writeStart-i_blockStart);
l_err = bufferedSfcRead(i_blockStart,
i_writeStart-i_blockStart,
read_data);
}
//Get data after write section
if((i_writeStart+i_bytesToWrite) < (i_blockStart + iv_erasesize_bytes))
{
uint32_t tail_length = i_blockStart + iv_erasesize_bytes - (i_writeStart+i_bytesToWrite);
uint8_t* tail_buffer = read_data + i_writeStart-i_blockStart + i_bytesToWrite;
TRACDCOMP(g_trac_pnor,"compareAndWriteBlock> Reading tail data. addr=0x%.8x, tail_length=0x%.8x",
i_writeStart+i_bytesToWrite, tail_length);
l_err = bufferedSfcRead(i_writeStart+i_bytesToWrite,
tail_length,
tail_buffer);
if( l_err )
{
break; }
}
// erase the flash
TRACDCOMP(g_trac_pnor,"compareAndWriteBlock> Calling eraseFlash:. i_blockStart=0x%.8x", i_blockStart);
l_err = eraseFlash( i_blockStart );
if( l_err ) { break; }
//STEP 4: Write the data back out - need to write everything since we erased the block
//re-write data before new data to write
if(i_writeStart > i_blockStart)
{
TRACDCOMP(g_trac_pnor,"compareAndWriteBlock> Writing beginning data i_blockStart=0x%.8x, readLen=0x%.8x",
i_blockStart, i_writeStart-i_blockStart);
l_err = bufferedSfcWrite(i_blockStart,
i_writeStart-i_blockStart,
read_data);
}
//Write data after new data to write
if((i_writeStart+i_bytesToWrite) < (i_blockStart + iv_erasesize_bytes))
{
uint32_t tail_length = i_blockStart + iv_erasesize_bytes - (i_writeStart+i_bytesToWrite);
uint8_t* tail_buffer = read_data + i_writeStart-i_blockStart + i_bytesToWrite;
TRACDCOMP(g_trac_pnor,"compareAndWriteBlock> Writing tail data. addr=0x%.8x, tail_length=0x%.8x",
i_writeStart+i_bytesToWrite, tail_length);
l_err = bufferedSfcWrite(i_writeStart+i_bytesToWrite,
tail_length,
tail_buffer);
if( l_err ) { break; }
}
//Write the new data - always do this
l_err = bufferedSfcWrite(i_writeStart,
i_bytesToWrite,
i_data);
if( l_err ) { break; }
}
else //
{
//STEP 4 ALT: No erase needed, only write the parts that changed.
for(uint32_t cword = 0; cword < wordsToWrite; cword++)
{
// look for any bits being changed (using XOR)
if(read_start[cword] ^ i_dataWord[cword] )
{
//Write the new data - always do this
l_err = bufferedSfcWrite(i_writeStart + (cword*4),
4,
&i_dataWord[cword]);
if( l_err ) { break; }
}
if( l_err ) { break; }
}
}
} while(0);
if( read_data )
{
delete[] read_data;
}
TRACDCOMP(g_trac_pnor,"<<compareAndWriteBlock() Exit");
return l_err;
}
/**
* @brief Erase a block of flash
*/
errlHndl_t PnorDD::eraseFlash(uint32_t i_address)
{
errlHndl_t l_err = NULL;
TRACDCOMP(g_trac_pnor, ">>PnorDD::eraseFlash> Block 0x%.8X", i_address );
do {
if( findEraseBlock(i_address) != i_address )
{
/*@
* @errortype
* @moduleid PNOR::MOD_PNORDD_ERASEFLASH
* @reasoncode PNOR::RC_LPC_ERROR
* @userdata1 LPC Address
* @userdata2 Nearest Erase Boundary
* @devdesc PnorDD::eraseFlash> Address not on erase boundary
*/
l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
PNOR::MOD_PNORDD_ERASEFLASH,
PNOR::RC_LPC_ERROR,
TWO_UINT32_TO_UINT64(0,i_address),
findEraseBlock(i_address));
break;
}
for(uint32_t idx = 0; idx < ERASE_COUNT_MAX; idx++ )
{
if(iv_erases[idx].addr == i_address)
{
iv_erases[idx].count++;
TRACFCOMP(g_trac_pnor, "PnorDD::eraseFlash> Block 0x%.8X has %d erasures", i_address, iv_erases[idx].count );
break;
}
//iv_erases is init to all 0xff,
// so can use ~0 to check for an unused position
else if(iv_erases[idx].addr == ~0u)
{
iv_erases[idx].addr = i_address;
iv_erases[idx].count = 1;
TRACFCOMP(g_trac_pnor, "PnorDD::eraseFlash> Block 0x%.8X has %d erasures", i_address, iv_erases[idx].count );
break;
}
else if( idx == (ERASE_COUNT_MAX - 1))
{
TRACFCOMP(g_trac_pnor, "PnorDD::eraseFlash> Erase counter full! Block 0x%.8X Erased", i_address );
break;
}
}
if( (MODEL_MEMCPY == iv_mode) || (MODEL_LPC_MEM == iv_mode))
{
erase_fake_pnor( i_address, iv_erasesize_bytes );
break; //all done
}
if(cv_nor_chipid != 0)
{
TRACDCOMP(g_trac_pnor, "PnorDD::eraseFlash> Erasing flash for cv_nor_chipid=0x%.8x, iv_mode=0x%.8x", cv_nor_chipid, iv_mode);
//Write erase address to ADR reg
l_err = writeRegSfc(SFC_CMD_SPACE,
SFC_REG_ADR,
i_address);
//Issue Erase command
SfcCmdReg_t sfc_cmd;
sfc_cmd.opcode = SFC_OP_ERASM;
sfc_cmd.length = 0; //Not used for erase
l_err = writeRegSfc(SFC_CMD_SPACE,
SFC_REG_CMD,
sfc_cmd.data32);
if(l_err) { break; }
//Poll for complete status
l_err = pollSfcOpComplete();
if(l_err) { break; }
}
else
{
TRACFCOMP(g_trac_pnor, "PnorDD::eraseFlash> Erase not supported for cv_nor_chipid=%d", cv_nor_chipid );
/*@
* @errortype
* @moduleid PNOR::MOD_PNORDD_ERASEFLASH
* @reasoncode PNOR::RC_UNSUPPORTED_OPERATION
* @userdata1 NOR Chip ID
* @userdata2 LPC Address to erase
* @devdesc PnorDD::eraseFlash> No support for MODEL_REAL yet
*/
l_err = new ERRORLOG::ErrlEntry(ERRORLOG::ERRL_SEV_UNRECOVERABLE,
PNOR::MOD_PNORDD_ERASEFLASH,
PNOR::RC_UNSUPPORTED_OPERATION,
static_cast<uint64_t>(cv_nor_chipid),
i_address);
}
} while(0);
return l_err;
}
/*
This code is used in the MODEL_MEMCPY and MODEL_LPC_MEM modes
*/
/**
* @brief Write to fake PNOR
*/
void PnorDD::write_fake_pnor( uint64_t i_pnorAddr,
void* i_buffer,
size_t i_size )
{
//create a pointer to the offset start.
char * destPtr = (char *)(iv_fakeStart+i_pnorAddr);
if( (i_pnorAddr+i_size) > iv_fakeSize )
{
TRACFCOMP(g_trac_pnor,
"PnorDD write_fake_pnor> Write goes past end of fake-PNOR, skipping write. i_pnorAddr=0x%X, i_size=0x%X",
i_pnorAddr, i_size );
}
else
{
//copy data from memory into the buffer.
memcpy(destPtr, i_buffer, i_size);
}
}
/**
* @brief Read from fake PNOR
*/
void PnorDD::read_fake_pnor( uint64_t i_pnorAddr,
void* o_buffer,
size_t i_size )
{
//create a pointer to the offset start.
char * srcPtr = (char *)(iv_fakeStart+i_pnorAddr);
if( (i_pnorAddr+i_size) > iv_fakeSize )
{
TRACFCOMP(g_trac_pnor,
"PnorDD read_fake_pnor> Read goes past end of fake-PNOR, skipping read. i_pnorAddr=0x%X, i_size=0x%X",
i_pnorAddr, i_size );
}
else
{
//copy data from memory into the buffer.
memcpy(o_buffer, srcPtr, i_size);
}
}
/**
* @brief Erase chunk of fake PNOR
*/
void PnorDD::erase_fake_pnor( uint64_t i_pnorAddr,
size_t i_size )
{
//create a pointer to the offset start.
char * srcPtr = (char *)(iv_fakeStart+i_pnorAddr);
if( (i_pnorAddr+i_size) > iv_fakeSize )
{
TRACFCOMP(g_trac_pnor,
"PnorDD erase_fake_pnor> Erase goes past end of fake-PNOR, skipping erase. i_pnorAddr=0x%X, i_size=0x%X",
i_pnorAddr, i_size );
}
else
{
//Zero out memory
memset( srcPtr, 0, i_size );
}
}
|