-
Notifications
You must be signed in to change notification settings - Fork 1.1k
/
xqspipsu_generic_flash_polled_example.c
2327 lines (2067 loc) · 65.3 KB
/
xqspipsu_generic_flash_polled_example.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
/******************************************************************************
* Copyright (C) 2018 - 2022 Xilinx, Inc. All rights reserved.
* Copyright (c) 2022 - 2024 Advanced Micro Devices, Inc. All Rights Reserved.
* SPDX-License-Identifier: MIT
******************************************************************************/
/*****************************************************************************/
/**
*
* @file xqspipsu_generic_flash_polled_example.c
*
*
* This file contains a design example using the QSPIPSU driver (XQspiPsu)
* with a serial Flash device greater than or equal to 128Mb.
* The example writes to flash and reads it back in DMA mode.
* This examples runs with GENFIFO Manual start. It runs in polled mode.
* This example illustrates single, parallel and stacked modes.
* Both the flash devices have to be of the same make and size.
* The hardware which this example runs on, must have a serial Flash (Micron
* N25Q or Spansion S25FL) for it to run. In order to test in single,
* parallel or stacked flash configurations the necessary HW must be present
* and QSPI_MODE (also reflected in ConnectionMode in the instance) has
* to be in sync with HW flash configuration being tested.
*
* This example has been tested with the Micron Serial Flash (N25Q512) and
* ISSI Serial Flash parts of IS25WP and IS25LP series flashes in
* single and parallel modes using A53 and R5 processors.
*
* @note
*
* None.
*
* <pre>
* MODIFICATION HISTORY:
*
* Ver Who Date Changes
* ----- --- -------- -----------------------------------------------
* 1.0 hk 08/21/14 First release
* sk 06/17/15 Used Tx/Rx flags for Transmitting/Receiving.
* sk 11/23/15 Added Support for Macronix 1Gb part.
* ms 04/05/17 Modified Comment lines in functions to
* recognize it as documentation block for doxygen
* generation.
* 1.1 tjs 06/16/17 Added support for IS25LP256D flash part (PR-4650)
* 1.5 tjs 09/15/17 Replaced \#ifdef COMMENTS to \#if USE_FOUR_BYTE (CR-984966)
* 1.6 tjs 10/16/17 \#ifdef COMMENT replaced with the flow similar to
* u-boot and linux for accessing flash parts with
* size more then 16MB (CR-984966)
* 1.7 tjs 11/16/17 Removed the unsupported 4 Byte write and sector erase
* commands.
* 1.7 tjs 12/01/17 Added support for MT25QL02G Flash from Micron. CR-990642
* 1.7 tjs 12/19/17 Added support for S25FL064L from Spansion. CR-990724
* 1.7 tjs 01/11/18 Added support for MX66L1G45G flash from Macronix CR-992367
* 1.7 tjs 26/03/18 In dual parallel mode enable both CS when issuing Write
* enable command. CR-998478
* 1.8 tjs 05/02/18 Added support for IS25LP064 and IS25WP064.
* 1.8 tjs 16/07/18 Added support for the low density ISSI flash parts.
* 1.9 akm 02/27/19 Added support for IS25LP128, IS25WP128, IS25LP256,
* IS25WP256, IS25LP512, IS25WP512 Flash Devices
* 1.9 akm 04/03/19 Fixed data alignment warnings on IAR compiler.
* 1.10 akm 09/05/19 Added Multi Die Erase and Muti Die Read support.
* 1.13 akm 11/30/20 Removed unwanted header files.
* 1.13 akm 12/10/20 Set Read command as per the qspi bus width.
* 1.14 akm 07/16/21 Enable Quad Mode for Winbond flashes.
* 1.15 akm 11/19/21 Fix read/write failures on Spansion flash parts.
* 1.15 akm 12/22/21 Initialize variables before use.
* 1.16 akm 08/16/22 Fix logical error in NumSect calculation.
* 1.17 akm 12/16/22 Add timeout in QSPIPSU driver examples.
* 1.18 sb 05/19/23 Update number of sector calculation logic
* in flash erase API.
* 1.18 sb 06/07/23 Added support for system device-tree flow.
* 1.18 sb 07/24/23 Fix wrong init sequence for spansion byte ID.
* 1.18 sb 08/02/23 Add status check for XQspiPsu_SetClkPrescaler API.
* 1.19 sb 01/12/24 Added support to set QSPI clock based on baud rate divisior
*
*</pre>
*
******************************************************************************/
/***************************** Include Files *********************************/
#include "xqspipsu_flash_config.h"
#include "xil_printf.h"
/************************** Constant Definitions *****************************/
/*
* The following constants map to the XPAR parameters created in the
* xparameters.h file. They are defined here such that a user can easily
* change all the needed parameters in one place.
*/
#ifndef SDT
#define QSPIPSU_DEVICE_ID XPAR_XQSPIPSU_0_DEVICE_ID
#endif
/*
* Number of flash pages to be written.
*/
#define PAGE_COUNT 32
/*
* Max page size to initialize write and read buffer
*/
#define MAX_PAGE_SIZE 1024
/*
* Flash address to which data is to be written.
*/
#define TEST_ADDRESS 0x000000
#define UNIQUE_VALUE 0x06
#define ENTER_4B 1
#define EXIT_4B 0
/**************************** Type Definitions *******************************/
u8 ReadCmd;
u8 WriteCmd;
u8 StatusCmd;
u8 SectorEraseCmd;
u8 FSRFlag;
/***************** Macros (Inline Functions) Definitions *********************/
/************************** Function Prototypes ******************************/
#ifndef SDT
int QspiPsuPolledFlashExample(XQspiPsu *QspiPsuInstancePtr, u16 QspiPsuDeviceId);
#else
int QspiPsuPolledFlashExample(XQspiPsu *QspiPsuInstancePtr, UINTPTR BaseAddress);
#endif
int FlashReadID(XQspiPsu *QspiPsuPtr);
int FlashErase(XQspiPsu *QspiPsuPtr, u32 Address, u32 ByteCount, u8 *WriteBfrPtr);
int FlashWrite(XQspiPsu *QspiPsuPtr, u32 Address, u32 ByteCount, u8 Command,
u8 *WriteBfrPtr);
int FlashRead(XQspiPsu *QspiPsuPtr, u32 Address, u32 ByteCount, u8 Command,
u8 *WriteBfrPtr, u8 *ReadBfrPtr);
int MultiDieRead(XQspiPsu *QspiPsuPtr, u32 Address, u32 ByteCount, u8 Command,
u8 *WriteBfrPtr, u8 *ReadBfrPtr);
u32 GetRealAddr(XQspiPsu *QspiPsuPtr, u32 Address);
int BulkErase(XQspiPsu *QspiPsuPtr, u8 *WriteBfrPtr);
int DieErase(XQspiPsu *QspiPsuPtr, u8 *WriteBfrPtr);
int FlashRegisterRead(XQspiPsu *QspiPsuPtr, u32 ByteCount, u8 Command, u8 *ReadBfrPtr);
int FlashRegisterWrite(XQspiPsu *QspiPsuPtr, u32 ByteCount, u8 Command,
u8 *WriteBfrPtr, u8 WrEn);
int FlashEnterExit4BAddMode(XQspiPsu *QspiPsuPtr, unsigned int Enable);
int FlashEnableQuadMode(XQspiPsu *QspiPsuPtr);
/************************** Variable Definitions *****************************/
u8 TxBfrPtr;
u8 ReadBfrPtr[3];
u32 FlashMake;
u32 FCTIndex; /* Flash configuration table index */
/*
* The instances to support the device drivers are global such that they
* are initialized to zero each time the program runs. They could be local
* but should at least be static so they are zeroed.
*/
static XQspiPsu QspiPsuInstance;
static XQspiPsu_Msg FlashMsg[5];
/*
* The following variable allows a test value to be added to the values that
* are written to the Flash such that unique values can be generated to
* guarantee the writes to the Flash were successful
*/
int Test = 1;
/*
* The following variables are used to read and write to the flash and they
* are global to avoid having large buffers on the stack
* The buffer size accounts for maximum page size and maximum banks -
* for each bank separate read will be performed leading to that many
* (overhead+dummy) bytes
*/
#ifdef __ICCARM__
#pragma data_alignment = 32
u8 ReadBuffer[(PAGE_COUNT * MAX_PAGE_SIZE) + (DATA_OFFSET + DUMMY_SIZE) * 8];
#else
u8 ReadBuffer[(PAGE_COUNT * MAX_PAGE_SIZE) + (DATA_OFFSET + DUMMY_SIZE) * 8] __attribute__ ((aligned(64)));
#endif
u8 WriteBuffer[(PAGE_COUNT * MAX_PAGE_SIZE) + DATA_OFFSET];
u8 CmdBfr[8];
/*
* The following constants specify the max amount of data and the size of the
* the buffer required to hold the data and overhead to transfer the data to
* and from the Flash. Initialized to single flash page size.
*/
u32 MaxData = PAGE_COUNT * 256;
/*****************************************************************************/
/**
*
* Main function to call the QSPIPSU Flash Polled example.
*
*
* @return XST_SUCCESS if successful, otherwise XST_FAILURE.
*
* @note None
*
******************************************************************************/
int main(void)
{
int Status;
xil_printf("QSPIPSU Generic Flash Polled Example Test \r\n");
/*
* Run the QspiPsu Polled example.
*/
#ifndef SDT
Status = QspiPsuPolledFlashExample(&QspiPsuInstance, QSPIPSU_DEVICE_ID);
#else
Status = QspiPsuPolledFlashExample(&QspiPsuInstance, XPAR_XQSPIPSU_0_BASEADDR);
#endif
if (Status != XST_SUCCESS) {
xil_printf("QSPIPSU Generic Flash Polled Example Failed\r\n");
return XST_FAILURE;
}
xil_printf("Successfully ran QSPIPSU Generic Flash Polled Example\r\n");
return XST_SUCCESS;
}
/*****************************************************************************/
/**
*
* The purpose of this function is to illustrate how to use the XQspiPsu
* device driver in single, parallel and stacked modes using
* flash devices greater than or equal to 128Mb.
* This function reads data in DMA mode.
*
* @param QspiPsuInstancePtr is a pointer to the instance of the QspiPsu
* device.
* @param QspiPsuDeviceId is the Device ID of the Qspi Device and is the
* XPAR_<QSPI_instance>_DEVICE_ID value from xparameters.h.
*
* @return XST_SUCCESS if successful, else XST_FAILURE.
*
* @note None.
*
*****************************************************************************/
#ifndef SDT
int QspiPsuPolledFlashExample(XQspiPsu *QspiPsuInstancePtr, u16 QspiPsuDeviceId)
#else
int QspiPsuPolledFlashExample(XQspiPsu *QspiPsuInstancePtr, UINTPTR BaseAddress)
#endif
{
int Status;
u8 UniqueValue;
int Count;
int Page;
XQspiPsu_Config *QspiPsuConfig;
int ReadBfrSize;
u32 PageSize = 0;
ReadBfrSize = (PAGE_COUNT * MAX_PAGE_SIZE) +
(DATA_OFFSET + DUMMY_SIZE) * 8;
/*
* Initialize the QSPIPSU driver so that it's ready to use
*/
#ifndef SDT
QspiPsuConfig = XQspiPsu_LookupConfig(QspiPsuDeviceId);
#else
QspiPsuConfig = XQspiPsu_LookupConfig(BaseAddress);
#endif
if (QspiPsuConfig == NULL) {
return XST_FAILURE;
}
/* To test, change connection mode here if not obtained from HDF */
Status = XQspiPsu_CfgInitialize(QspiPsuInstancePtr, QspiPsuConfig,
QspiPsuConfig->BaseAddress);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
/*
* Set Manual Start
*/
XQspiPsu_SetOptions(QspiPsuInstancePtr, XQSPIPSU_MANUAL_START_OPTION);
/* Configure qspi controller frequency based on Baud rate divisor if baud rate divisor is non zero*/
if(QspiPsuInstancePtr->Config.BaudRateDiv != (u8)0){
Status = XQspiPsu_SetClkPrescaler(QspiPsuInstancePtr, QspiPsuInstancePtr->Config.BaudRateDiv);
} else {
Status = XQspiPsu_SetClkPrescaler(QspiPsuInstancePtr, XQSPIPSU_CLK_PRESCALE_8);
}
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
XQspiPsu_SelectFlash(QspiPsuInstancePtr,
XQSPIPSU_SELECT_FLASH_CS_LOWER,
XQSPIPSU_SELECT_FLASH_BUS_LOWER);
/*
* Read flash ID and obtain all flash related information
* It is important to call the read id function before
* performing proceeding to any operation, including
* preparing the WriteBuffer
*/
Status = FlashReadID(QspiPsuInstancePtr);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
xil_printf("Flash connection mode : %d\n\r",
QspiPsuConfig->ConnectionMode);
xil_printf("where 0 - Single; 1 - Stacked; 2 - Parallel\n\r");
xil_printf("FCTIndex: %d\n\r", FCTIndex);
/*
* Initialize MaxData according to page size.
*/
if (QspiPsuInstancePtr->Config.ConnectionMode == XQSPIPSU_CONNECTION_MODE_PARALLEL) {
PageSize = Flash_Config_Table[FCTIndex].PageSize * 2;
} else {
PageSize = Flash_Config_Table[FCTIndex].PageSize;
}
MaxData = PAGE_COUNT * PageSize;
/*
* Some flash needs to enable Quad mode before using
* quad commands.
*/
Status = FlashEnableQuadMode(QspiPsuInstancePtr);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
/*
* Address size and read command selection
* Micron flash on REMUS doesn't support this 4B write/erase cmd
*/
if (QspiPsuInstancePtr->Config.BusWidth == BUSWIDTH_SINGLE) {
ReadCmd = FAST_READ_CMD;
} else if (QspiPsuInstancePtr->Config.BusWidth == BUSWIDTH_DOUBLE) {
ReadCmd = DUAL_READ_CMD;
} else {
ReadCmd = QUAD_READ_CMD;
}
WriteCmd = WRITE_CMD;
SectorEraseCmd = SEC_ERASE_CMD;
/* Status cmd - SR or FSR selection */
if ((Flash_Config_Table[FCTIndex].NumDie > 1) &&
(FlashMake == MICRON_ID_BYTE0)) {
StatusCmd = READ_FLAG_STATUS_CMD;
FSRFlag = 1;
} else {
StatusCmd = READ_STATUS_CMD;
FSRFlag = 0;
}
xil_printf("ReadCmd: 0x%x, WriteCmd: 0x%x,"
" StatusCmd: 0x%x, FSRFlag: %d\n\r",
ReadCmd, WriteCmd, StatusCmd, FSRFlag);
if (Flash_Config_Table[FCTIndex].FlashDeviceSize > SIXTEENMB) {
Status = FlashEnterExit4BAddMode(QspiPsuInstancePtr, ENTER_4B);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
if (FlashMake == SPANSION_ID_BYTE0) {
if (QspiPsuInstancePtr->Config.BusWidth == BUSWIDTH_SINGLE) {
ReadCmd = FAST_READ_CMD_4B;
} else if (QspiPsuInstancePtr->Config.BusWidth == BUSWIDTH_DOUBLE) {
ReadCmd = DUAL_READ_CMD_4B;
} else {
ReadCmd = QUAD_READ_CMD_4B;
}
WriteCmd = WRITE_CMD_4B;
SectorEraseCmd = SEC_ERASE_CMD_4B;
}
}
for (UniqueValue = UNIQUE_VALUE, Count = 0;
Count < PageSize;
Count++, UniqueValue++) {
WriteBuffer[Count] = (u8)(UniqueValue + Test);
}
for (Count = 0; Count < ReadBfrSize; Count++) {
ReadBuffer[Count] = 0;
}
Status = FlashErase(QspiPsuInstancePtr, TEST_ADDRESS, MaxData, CmdBfr);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
for (Page = 0; Page < PAGE_COUNT; Page++) {
Status = FlashWrite(QspiPsuInstancePtr,
(Page * PageSize) + TEST_ADDRESS,
PageSize, WriteCmd, WriteBuffer);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
}
Status = FlashRead(QspiPsuInstancePtr, TEST_ADDRESS, MaxData, ReadCmd,
CmdBfr, ReadBuffer);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
/*
* Setup a pointer to the start of the data that was read into the read
* buffer and verify the data read is the data that was written
*/
for (UniqueValue = UNIQUE_VALUE, Count = 0; Count < MaxData;
Count++, UniqueValue++) {
if (ReadBuffer[Count] != (u8)(UniqueValue + Test)) {
return XST_FAILURE;
}
}
if (Flash_Config_Table[FCTIndex].FlashDeviceSize > SIXTEENMB) {
Status = FlashEnterExit4BAddMode(QspiPsuInstancePtr, EXIT_4B);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
}
return XST_SUCCESS;
}
/*****************************************************************************/
/**
*
* Reads the flash ID and identifies the flash in FCT table.
*
* @param QspiPsuPtr is a pointer to the QSPIPSU driver component to use.
*
* @return XST_SUCCESS if successful, else XST_FAILURE.
*
* @note None.
*
*****************************************************************************/
int FlashReadID(XQspiPsu *QspiPsuPtr)
{
int Status;
u32 ReadId = 0;
/*
* Read ID
*/
TxBfrPtr = READ_ID;
FlashMsg[0].TxBfrPtr = &TxBfrPtr;
FlashMsg[0].RxBfrPtr = NULL;
FlashMsg[0].ByteCount = 1;
FlashMsg[0].BusWidth = XQSPIPSU_SELECT_MODE_SPI;
FlashMsg[0].Flags = XQSPIPSU_MSG_FLAG_TX;
FlashMsg[1].TxBfrPtr = NULL;
FlashMsg[1].RxBfrPtr = ReadBfrPtr;
FlashMsg[1].ByteCount = 3;
FlashMsg[1].BusWidth = XQSPIPSU_SELECT_MODE_SPI;
FlashMsg[1].Flags = XQSPIPSU_MSG_FLAG_RX;
Status = XQspiPsu_PolledTransfer(QspiPsuPtr, FlashMsg, 2);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
xil_printf("FlashID=0x%x 0x%x 0x%x\n\r", ReadBfrPtr[0], ReadBfrPtr[1],
ReadBfrPtr[2]);
/* In case of dual, read both and ensure they are same make/size */
/*
* Deduce flash make
*/
FlashMake = ReadBfrPtr[0];
ReadId = ((ReadBfrPtr[0] << 16) | (ReadBfrPtr[1] << 8) | ReadBfrPtr[2]);
/*
* Assign corresponding index in the Flash configuration table
*/
Status = CalculateFCTIndex(ReadId, &FCTIndex);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
return XST_SUCCESS;
}
/*****************************************************************************/
/**
*
* This function writes to the serial Flash connected to the QSPIPSU interface.
* All the data put into the buffer must be in the same page of the device with
* page boundaries being on 256 byte boundaries.
*
* @param QspiPsuPtr is a pointer to the QSPIPSU driver component to use.
* @param Address contains the address to write data to in the Flash.
* @param ByteCount contains the number of bytes to write.
* @param Command is the command used to write data to the flash. QSPIPSU
* device supports only Page Program command to write data to the
* flash.
* @param WriteBfrPtr is pointer to the write buffer (which is to be transmitted)
*
* @return XST_SUCCESS if successful, else XST_FAILURE.
*
* @note None.
*
******************************************************************************/
int FlashWrite(XQspiPsu *QspiPsuPtr, u32 Address, u32 ByteCount, u8 Command,
u8 *WriteBfrPtr)
{
u8 WriteEnableCmd;
u8 ReadStatusCmd;
u8 FlashStatus[2];
u8 WriteCmd[5];
u32 RealAddr;
u32 CmdByteCount;
int Status;
u32 DelayCount;
WriteEnableCmd = WRITE_ENABLE_CMD;
/*
* Translate address based on type of connection
* If stacked assert the slave select based on address
*/
RealAddr = GetRealAddr(QspiPsuPtr, Address);
/*
* Send the write enable command to the Flash so that it can be
* written to, this needs to be sent as a separate transfer before
* the write
*/
FlashMsg[0].TxBfrPtr = &WriteEnableCmd;
FlashMsg[0].RxBfrPtr = NULL;
FlashMsg[0].ByteCount = 1;
FlashMsg[0].BusWidth = XQSPIPSU_SELECT_MODE_SPI;
FlashMsg[0].Flags = XQSPIPSU_MSG_FLAG_TX;
Status = XQspiPsu_PolledTransfer(QspiPsuPtr, FlashMsg, 1);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
WriteCmd[COMMAND_OFFSET] = Command;
/* To be used only if 4B address program cmd is supported by flash */
if (Flash_Config_Table[FCTIndex].FlashDeviceSize > SIXTEENMB) {
WriteCmd[ADDRESS_1_OFFSET] =
(u8)((RealAddr & 0xFF000000) >> 24);
WriteCmd[ADDRESS_2_OFFSET] =
(u8)((RealAddr & 0xFF0000) >> 16);
WriteCmd[ADDRESS_3_OFFSET] =
(u8)((RealAddr & 0xFF00) >> 8);
WriteCmd[ADDRESS_4_OFFSET] =
(u8)(RealAddr & 0xFF);
CmdByteCount = 5;
} else {
WriteCmd[ADDRESS_1_OFFSET] =
(u8)((RealAddr & 0xFF0000) >> 16);
WriteCmd[ADDRESS_2_OFFSET] =
(u8)((RealAddr & 0xFF00) >> 8);
WriteCmd[ADDRESS_3_OFFSET] =
(u8)(RealAddr & 0xFF);
CmdByteCount = 4;
}
FlashMsg[0].TxBfrPtr = WriteCmd;
FlashMsg[0].RxBfrPtr = NULL;
FlashMsg[0].ByteCount = CmdByteCount;
FlashMsg[0].BusWidth = XQSPIPSU_SELECT_MODE_SPI;
FlashMsg[0].Flags = XQSPIPSU_MSG_FLAG_TX;
FlashMsg[1].TxBfrPtr = WriteBfrPtr;
FlashMsg[1].RxBfrPtr = NULL;
FlashMsg[1].ByteCount = ByteCount;
FlashMsg[1].BusWidth = XQSPIPSU_SELECT_MODE_SPI;
FlashMsg[1].Flags = XQSPIPSU_MSG_FLAG_TX;
if (QspiPsuPtr->Config.ConnectionMode ==
XQSPIPSU_CONNECTION_MODE_PARALLEL) {
FlashMsg[1].Flags |= XQSPIPSU_MSG_FLAG_STRIPE;
}
Status = XQspiPsu_PolledTransfer(QspiPsuPtr, FlashMsg, 2);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
/*
* Wait for the write command to the Flash to be completed, it takes
* some time for the data to be written
*/
DelayCount = 0;
while (1) {
if (DelayCount == MAX_DELAY_CNT) {
Status = XST_FAILURE;
goto ERROR_PATH;
} else {
ReadStatusCmd = StatusCmd;
FlashMsg[0].TxBfrPtr = &ReadStatusCmd;
FlashMsg[0].RxBfrPtr = NULL;
FlashMsg[0].ByteCount = 1;
FlashMsg[0].BusWidth = XQSPIPSU_SELECT_MODE_SPI;
FlashMsg[0].Flags = XQSPIPSU_MSG_FLAG_TX;
FlashMsg[1].TxBfrPtr = NULL;
FlashMsg[1].RxBfrPtr = FlashStatus;
FlashMsg[1].ByteCount = 2;
FlashMsg[1].BusWidth = XQSPIPSU_SELECT_MODE_SPI;
FlashMsg[1].Flags = XQSPIPSU_MSG_FLAG_RX;
if (QspiPsuPtr->Config.ConnectionMode ==
XQSPIPSU_CONNECTION_MODE_PARALLEL) {
FlashMsg[1].Flags |= XQSPIPSU_MSG_FLAG_STRIPE;
}
Status = XQspiPsu_PolledTransfer(QspiPsuPtr, FlashMsg, 2);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
if (QspiPsuPtr->Config.ConnectionMode ==
XQSPIPSU_CONNECTION_MODE_PARALLEL) {
if (FSRFlag) {
FlashStatus[1] &= FlashStatus[0];
} else {
FlashStatus[1] |= FlashStatus[0];
}
}
if (FSRFlag) {
if ((FlashStatus[1] & 0x80) != 0) {
break;
}
} else {
if ((FlashStatus[1] & 0x01) == 0) {
break;
}
}
/* Wait for 1 usec */
usleep(1);
DelayCount++;
}
}
ERROR_PATH:
return Status;
}
/*****************************************************************************/
/**
*
* This function erases the sectors in the serial Flash connected to the
* QSPIPSU interface.
*
* @param QspiPsuPtr is a pointer to the QSPIPSU driver component to use.
* @param Address contains the address of the first sector which needs to
* be erased.
* @param ByteCount contains the total size to be erased.
* @param WriteBfrPtr is pointer to the write buffer (which is to be transmitted)
*
* @return XST_SUCCESS if successful, else XST_FAILURE.
*
* @note None.
*
******************************************************************************/
int FlashErase(XQspiPsu *QspiPsuPtr, u32 Address, u32 ByteCount,
u8 *WriteBfrPtr)
{
u8 WriteEnableCmd;
u8 ReadStatusCmd;
u8 FlashStatus[2];
int Sector;
u32 RealAddr;
u32 NumSect;
int Status;
u32 SectSize;
u32 StartSect;
u32 EndSect;
u32 DelayCount;
WriteEnableCmd = WRITE_ENABLE_CMD;
if (QspiPsuPtr->Config.ConnectionMode == XQSPIPSU_CONNECTION_MODE_PARALLEL) {
SectSize = (Flash_Config_Table[FCTIndex]).SectSize * 2;
NumSect = (Flash_Config_Table[FCTIndex]).NumSect;
} else if (QspiPsuPtr->Config.ConnectionMode == XQSPIPSU_CONNECTION_MODE_STACKED) {
NumSect = (Flash_Config_Table[FCTIndex]).NumSect * 2;
SectSize = (Flash_Config_Table[FCTIndex]).SectSize;
} else {
SectSize = (Flash_Config_Table[FCTIndex]).SectSize;
NumSect = (Flash_Config_Table[FCTIndex]).NumSect;
}
/*
* If erase size is same as the total size of the flash, use bulk erase
* command or die erase command multiple times as required
*/
if (ByteCount == NumSect * SectSize) {
if (QspiPsuPtr->Config.ConnectionMode ==
XQSPIPSU_CONNECTION_MODE_STACKED) {
XQspiPsu_SelectFlash(QspiPsuPtr,
XQSPIPSU_SELECT_FLASH_CS_LOWER,
XQSPIPSU_SELECT_FLASH_BUS_LOWER);
}
if (Flash_Config_Table[FCTIndex].NumDie == 1) {
/*
* Call Bulk erase
*/
BulkErase(QspiPsuPtr, WriteBfrPtr);
}
if (Flash_Config_Table[FCTIndex].NumDie > 1) {
/*
* Call Die erase
*/
DieErase(QspiPsuPtr, WriteBfrPtr);
}
/*
* If stacked mode, bulk erase second flash
*/
if (QspiPsuPtr->Config.ConnectionMode ==
XQSPIPSU_CONNECTION_MODE_STACKED) {
XQspiPsu_SelectFlash(QspiPsuPtr,
XQSPIPSU_SELECT_FLASH_CS_UPPER,
XQSPIPSU_SELECT_FLASH_BUS_LOWER);
if (Flash_Config_Table[FCTIndex].NumDie == 1) {
/*
* Call Bulk erase
*/
BulkErase(QspiPsuPtr, WriteBfrPtr);
}
if (Flash_Config_Table[FCTIndex].NumDie > 1) {
/*
* Call Die erase
*/
DieErase(QspiPsuPtr, WriteBfrPtr);
}
}
return 0;
}
/*
* If the erase size is less than the total size of the flash, use
* sector erase command
*/
/*
* Calculate no. of sectors to erase based on byte count and address
* spans in sectors
*/
StartSect = Address / SectSize;
EndSect = ((Address + ByteCount) - 1) / SectSize - StartSect;
NumSect = 1 + EndSect;
for (Sector = 0; Sector < NumSect; Sector++) {
/*
* Translate address based on type of connection
* If stacked assert the slave select based on address
*/
RealAddr = GetRealAddr(QspiPsuPtr, Address);
/*
* Send the write enable command to the Flash so that it can be
* written to, this needs to be sent as a separate
* transfer before the write
*/
FlashMsg[0].TxBfrPtr = &WriteEnableCmd;
FlashMsg[0].RxBfrPtr = NULL;
FlashMsg[0].ByteCount = 1;
FlashMsg[0].BusWidth = XQSPIPSU_SELECT_MODE_SPI;
FlashMsg[0].Flags = XQSPIPSU_MSG_FLAG_TX;
Status = XQspiPsu_PolledTransfer(QspiPsuPtr, FlashMsg, 1);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
WriteBfrPtr[COMMAND_OFFSET] = SectorEraseCmd;
/*
* To be used only if 4B address sector erase cmd is
* supported by flash
*/
if (Flash_Config_Table[FCTIndex].FlashDeviceSize > SIXTEENMB) {
WriteBfrPtr[ADDRESS_1_OFFSET] =
(u8)((RealAddr & 0xFF000000) >> 24);
WriteBfrPtr[ADDRESS_2_OFFSET] =
(u8)((RealAddr & 0xFF0000) >> 16);
WriteBfrPtr[ADDRESS_3_OFFSET] =
(u8)((RealAddr & 0xFF00) >> 8);
WriteBfrPtr[ADDRESS_4_OFFSET] =
(u8)(RealAddr & 0xFF);
FlashMsg[0].ByteCount = 5;
} else {
WriteBfrPtr[ADDRESS_1_OFFSET] =
(u8)((RealAddr & 0xFF0000) >> 16);
WriteBfrPtr[ADDRESS_2_OFFSET] =
(u8)((RealAddr & 0xFF00) >> 8);
WriteBfrPtr[ADDRESS_3_OFFSET] =
(u8)(RealAddr & 0xFF);
FlashMsg[0].ByteCount = 4;
}
FlashMsg[0].TxBfrPtr = WriteBfrPtr;
FlashMsg[0].RxBfrPtr = NULL;
FlashMsg[0].BusWidth = XQSPIPSU_SELECT_MODE_SPI;
FlashMsg[0].Flags = XQSPIPSU_MSG_FLAG_TX;
Status = XQspiPsu_PolledTransfer(QspiPsuPtr, FlashMsg, 1);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
/*
* Wait for the erase command to be completed
*/
DelayCount = 0;
while (1) {
if (DelayCount == MAX_DELAY_CNT) {
Status = XST_FAILURE;
goto ERROR_PATH;
} else {
ReadStatusCmd = StatusCmd;
FlashMsg[0].TxBfrPtr = &ReadStatusCmd;
FlashMsg[0].RxBfrPtr = NULL;
FlashMsg[0].ByteCount = 1;
FlashMsg[0].BusWidth = XQSPIPSU_SELECT_MODE_SPI;
FlashMsg[0].Flags = XQSPIPSU_MSG_FLAG_TX;
FlashMsg[1].TxBfrPtr = NULL;
FlashMsg[1].RxBfrPtr = FlashStatus;
FlashMsg[1].ByteCount = 2;
FlashMsg[1].BusWidth = XQSPIPSU_SELECT_MODE_SPI;
FlashMsg[1].Flags = XQSPIPSU_MSG_FLAG_RX;
if (QspiPsuPtr->Config.ConnectionMode ==
XQSPIPSU_CONNECTION_MODE_PARALLEL) {
FlashMsg[1].Flags |= XQSPIPSU_MSG_FLAG_STRIPE;
}
Status = XQspiPsu_PolledTransfer(QspiPsuPtr,
FlashMsg, 2);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
if (QspiPsuPtr->Config.ConnectionMode ==
XQSPIPSU_CONNECTION_MODE_PARALLEL) {
if (FSRFlag) {
FlashStatus[1] &= FlashStatus[0];
} else {
FlashStatus[1] |= FlashStatus[0];
}
}
if (FSRFlag) {
if ((FlashStatus[1] & 0x80) != 0) {
break;
}
} else {
if ((FlashStatus[1] & 0x01) == 0) {
break;
}
}
/* Wait for 1 usec */
usleep(1);
DelayCount++;
}
}
Address += SectSize;
}
ERROR_PATH:
return Status;
}
/*****************************************************************************/
/**
*
* This function performs read. DMA is the default setting.
*
* @param QspiPsuPtr is a pointer to the QSPIPSU driver component to use.
* @param Address contains the address of the first sector which needs to
* be erased.
* @param ByteCount contains the total size to be erased.
* @param Command is the command used to read data from the flash.
* Supports normal, fast, dual and quad read commands.
* @param WriteBfrPtr is pointer to the write buffer which contains data to be
* transmitted
* @param ReadBfrPtr is pointer to the read buffer to which valid received data
* should be written
*
* @return XST_SUCCESS if successful, else XST_FAILURE.
*
* @note None.
*
******************************************************************************/
int FlashRead(XQspiPsu *QspiPsuPtr, u32 Address, u32 ByteCount, u8 Command,
u8 *WriteBfrPtr, u8 *ReadBfrPtr)
{
u32 RealAddr;
u32 DiscardByteCnt;
u32 FlashMsgCnt;
int Status;
/* Check die boundary conditions if required for any flash */
if (Flash_Config_Table[FCTIndex].NumDie > 1) {
Status = MultiDieRead(QspiPsuPtr, Address, ByteCount, Command,
WriteBfrPtr, ReadBfrPtr);
if (Status != XST_SUCCESS) {
return XST_FAILURE;
}
} else {
/* For Dual Stacked, split and read for boundary crossing */
/*
* Translate address based on type of connection
* If stacked assert the slave select based on address
*/
RealAddr = GetRealAddr(QspiPsuPtr, Address);
WriteBfrPtr[COMMAND_OFFSET] = Command;
if (Flash_Config_Table[FCTIndex].FlashDeviceSize > SIXTEENMB) {
WriteBfrPtr[ADDRESS_1_OFFSET] =
(u8)((RealAddr & 0xFF000000) >> 24);
WriteBfrPtr[ADDRESS_2_OFFSET] =
(u8)((RealAddr & 0xFF0000) >> 16);
WriteBfrPtr[ADDRESS_3_OFFSET] =
(u8)((RealAddr & 0xFF00) >> 8);
WriteBfrPtr[ADDRESS_4_OFFSET] =
(u8)(RealAddr & 0xFF);
DiscardByteCnt = 5;
} else {
WriteBfrPtr[ADDRESS_1_OFFSET] =
(u8)((RealAddr & 0xFF0000) >> 16);
WriteBfrPtr[ADDRESS_2_OFFSET] =
(u8)((RealAddr & 0xFF00) >> 8);
WriteBfrPtr[ADDRESS_3_OFFSET] =
(u8)(RealAddr & 0xFF);
DiscardByteCnt = 4;
}
FlashMsg[0].TxBfrPtr = WriteBfrPtr;
FlashMsg[0].RxBfrPtr = NULL;
FlashMsg[0].ByteCount = DiscardByteCnt;
FlashMsg[0].BusWidth = XQSPIPSU_SELECT_MODE_SPI;
FlashMsg[0].Flags = XQSPIPSU_MSG_FLAG_TX;
FlashMsgCnt = 1;
/* It is recommended to have a separate entry for dummy */
if (Command == FAST_READ_CMD || Command == DUAL_READ_CMD ||
Command == QUAD_READ_CMD || Command == FAST_READ_CMD_4B ||
Command == DUAL_READ_CMD_4B ||
Command == QUAD_READ_CMD_4B) {
/* Update Dummy cycles as per flash specs for QUAD IO */
/*
* It is recommended that Bus width value during dummy
* phase should be same as data phase
*/
if (Command == FAST_READ_CMD ||
Command == FAST_READ_CMD_4B)
FlashMsg[1].BusWidth =
XQSPIPSU_SELECT_MODE_SPI;
if (Command == DUAL_READ_CMD ||
Command == DUAL_READ_CMD_4B)
FlashMsg[1].BusWidth =
XQSPIPSU_SELECT_MODE_DUALSPI;
if (Command == QUAD_READ_CMD ||
Command == QUAD_READ_CMD_4B)
FlashMsg[1].BusWidth =
XQSPIPSU_SELECT_MODE_QUADSPI;
FlashMsg[1].TxBfrPtr = NULL;
FlashMsg[1].RxBfrPtr = NULL;
FlashMsg[1].ByteCount = DUMMY_CLOCKS;
FlashMsg[1].Flags = 0;
FlashMsgCnt++;
}