![]() |
qspipsu
Vitis Drivers API Documentation
|
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 interrupt mode. This example works only with single mode and x1 or x2 data mode. This example will not work with x4 data mode and dual parallel or stacked configuration. The hardware which this example runs on, must have a serial Flash (Micron N25Q or MT25Q) for it to run. In order to test in single 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 neither set the required MIO to control the Write Protect pin nor the driver is setting the MIO. The MIO must be configured to be used by QSPI.This example has been tested with the Micron Serial Flash (N25Q512) and ISSI Serial Flash parts of IS25WP and IS25LP series flashes in single mode using A53 and R5 processors.
None.
MODIFICATION HISTORY:
Ver Who Date Changes
1.7 tjs 01/25/18 Added support to toggle the WP pin of flash. (PR#2448) 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.13 akm 11/30/20 Removed unwanted header files. 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 1.20 sb 09/13/24 Updated examples to configure correct baud rate value
Functions | |
int | QspiPsuWriteProtectFlashExample (XScuGic *IntcInstancePtr, XQspiPsu *QspiPsuInstancePtr, u16 QspiPsuDeviceId, u16 QspiPsuIntrId) |
The purpose of this function is to illustrate how to use the XQspiPsu device driver in single mode with x1 or x2 data mode using flash devices greater than or equal to 128Mb and drive the Write Protect pin of the flash device using GQSPI GPIO. More... | |
int | FlashReadID (XQspiPsu *QspiPsuPtr) |
Reads the flash ID and identifies the flash in FCT table. More... | |
int | FlashErase (XQspiPsu *QspiPsuPtr, u32 Address, u32 ByteCount, u8 *WriteBfrPtr) |
This function erases the sectors in the serial Flash connected to the QSPIPSU interface. More... | |
int | FlashWrite (XQspiPsu *QspiPsuPtr, u32 Address, u32 ByteCount, u8 Command, u8 *WriteBfrPtr) |
This function writes to the serial Flash connected to the QSPIPSU interface. More... | |
int | FlashRead (XQspiPsu *QspiPsuPtr, u32 Address, u32 ByteCount, u8 Command, u8 *WriteBfrPtr, u8 *ReadBfrPtr) |
This function performs a read. More... | |
u32 | GetRealAddr (XQspiPsu *QspiPsuPtr, u32 Address) |
This functions translates the address based on the type of interconnection. More... | |
int | BulkErase (XQspiPsu *QspiPsuPtr, u8 *WriteBfrPtr) |
This functions performs a bulk erase operation when the flash device has a single die. More... | |
int | DieErase (XQspiPsu *QspiPsuPtr, u8 *WriteBfrPtr) |
This functions performs a die erase operation on all the die in the flash device. More... | |
void | QspiPsuHandler (void *CallBackRef, u32 StatusEvent, unsigned int ByteCount) |
Callback handler. More... | |
int | FlashEnterExit4BAddMode (XQspiPsu *QspiPsuPtr, unsigned int Enable) |
This API enters the flash device into 4 bytes addressing mode. More... | |
int | FlashEnableQuadMode (XQspiPsu *QspiPsuPtr) |
This API enables Quad mode for the flash parts which require to enable quad mode before using Quad commands. More... | |
int | main (void) |
Main function to call the QSPIPSU Flash example. More... | |
int BulkErase | ( | XQspiPsu * | QspiPsuPtr, |
u8 * | WriteBfrPtr | ||
) |
This functions performs a bulk erase operation when the flash device has a single die.
Works for both Spansion and Micron
QspiPsuPtr | is a pointer to the QSPIPSU driver component to use. |
WriteBfrPtr | is the pointer to command+address to be sent |
int DieErase | ( | XQspiPsu * | QspiPsuPtr, |
u8 * | WriteBfrPtr | ||
) |
This functions performs a die erase operation on all the die in the flash device.
This function uses the die erase command for Micron 512Mbit and 1Gbit
QspiPsuPtr | is a pointer to the QSPIPSU driver component to use. |
WriteBfrPtr | is the pointer to command+address to be sent |
int FlashEnableQuadMode | ( | XQspiPsu * | QspiPsuPtr | ) |
This API enables Quad mode for the flash parts which require to enable quad mode before using Quad commands.
For S25FL-L series flash parts this is required as the default configuration is x1/x2 mode.
QspiPsuPtr | is a pointer to the QSPIPSU driver component to use. |
int FlashEnterExit4BAddMode | ( | XQspiPsu * | QspiPsuPtr, |
unsigned int | Enable | ||
) |
This API enters the flash device into 4 bytes addressing mode.
As per the Micron and ISSI spec, before issuing the command to enter into 4 byte addr mode, a write enable command is issued. For Macronix and Winbond flash parts write enable is not required.
QspiPsuPtr | is a pointer to the QSPIPSU driver component to use. |
Enable | is a either 1 or 0 if 1 then enters 4 byte if 0 exits. |
int FlashErase | ( | XQspiPsu * | QspiPsuPtr, |
u32 | Address, | ||
u32 | ByteCount, | ||
u8 * | WriteBfrPtr | ||
) |
This function erases the sectors in the serial Flash connected to the QSPIPSU interface.
QspiPsuPtr | is a pointer to the QSPIPSU driver component to use. |
Address | contains the address of the first sector which needs to be erased. |
ByteCount | contains the total size to be erased. |
WriteBfrPtr | is pointer to the write buffer (which is to be transmitted) |
int FlashRead | ( | XQspiPsu * | QspiPsuPtr, |
u32 | Address, | ||
u32 | ByteCount, | ||
u8 | Command, | ||
u8 * | WriteBfrPtr, | ||
u8 * | ReadBfrPtr | ||
) |
This function performs a read.
Default setting is in DMA mode.
QspiPsuPtr | is a pointer to the QSPIPSU driver component to use. |
Address | contains the address of the first sector which needs to be erased. |
ByteCount | contains the total size to be erased. |
Command | is the command used to read data from the flash. Supports normal, fast, dual and quad read commands. |
WriteBfrPtr | is pointer to the write buffer which contains data to be transmitted |
ReadBfrPtr | is pointer to the read buffer to which valid received data should be written |
int FlashReadID | ( | XQspiPsu * | QspiPsuPtr | ) |
Reads the flash ID and identifies the flash in FCT table.
QspiPsuPtr | is a pointer to the QSPIPSU driver component to use. |
int FlashWrite | ( | XQspiPsu * | QspiPsuPtr, |
u32 | Address, | ||
u32 | ByteCount, | ||
u8 | Command, | ||
u8 * | WriteBfrPtr | ||
) |
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.
QspiPsuPtr | is a pointer to the QSPIPSU driver component to use. |
Address | contains the address to write data to in the Flash. |
ByteCount | contains the number of bytes to write. |
Command | is the command used to write data to the flash. QSPIPSU device supports only Page Program command to write data to the flash. |
WriteBfrPtr | is pointer to the write buffer (which is to be transmitted) |
u32 GetRealAddr | ( | XQspiPsu * | QspiPsuPtr, |
u32 | Address | ||
) |
This functions translates the address based on the type of interconnection.
In case of stacked, this function asserts the corresponding slave select.
QspiPsuPtr | is a pointer to the QSPIPSU driver component to use. |
Address | which is to be accessed (for erase, write or read) |
int main | ( | void | ) |
Main function to call the QSPIPSU Flash example.
References QspiPsuWriteProtectFlashExample().
void QspiPsuHandler | ( | void * | CallBackRef, |
u32 | StatusEvent, | ||
unsigned int | ByteCount | ||
) |
Callback handler.
CallBackRef | is the upper layer callback reference passed back when the callback function is invoked. |
StatusEvent | is the event that just occurred. |
ByteCount | is the number of bytes transferred up until the event occurred. |
int QspiPsuWriteProtectFlashExample | ( | XScuGic * | IntcInstancePtr, |
XQspiPsu * | QspiPsuInstancePtr, | ||
u16 | QspiPsuDeviceId, | ||
u16 | QspiPsuIntrId | ||
) |
The purpose of this function is to illustrate how to use the XQspiPsu device driver in single mode with x1 or x2 data mode using flash devices greater than or equal to 128Mb and drive the Write Protect pin of the flash device using GQSPI GPIO.
IntcInstancePtr | is a pointer to the instance of the Intc device. |
QspiPsuInstancePtr | is a pointer to the instance of the QspiPsu device. |
QspiPsuDeviceId | is the Device ID of the Qspi Device and is the XPAR_<QSPI_instance>_DEVICE_ID value from xparameters.h. |
QspiPsuIntrId | is the interrupt Id for an QSPIPSU device. |
References XQspiPsu_Config::BaseAddress, XQspiPsu_Config::BaudRateDiv, XQspiPsu_Config::BusWidth, XQspiPsu::Config, XQspiPsu_Config::ConnectionMode, FlashEnterExit4BAddMode(), FlashErase(), FlashRead(), FlashReadID(), FlashWrite(), QspiPsuHandler(), XQspiPsu_CfgInitialize(), XQSPIPSU_CLK_PRESCALE_8, XQSPIPSU_CONNECTION_MODE_PARALLEL, XQspiPsu_InterruptHandler(), XQspiPsu_LookupConfig(), XQSPIPSU_MANUAL_START_OPTION, XQSPIPSU_SELECT_FLASH_BUS_LOWER, XQSPIPSU_SELECT_FLASH_CS_LOWER, XQspiPsu_SelectFlash(), XQSPIPSU_SET_WP, XQspiPsu_SetClkPrescaler(), XQspiPsu_SetOptions(), XQspiPsu_SetStatusHandler(), XQspiPsu_SetWP(), and XQspiPsu_WriteProtectToggle().
Referenced by main().