ospipsv
Vitis Drivers API Documentation
|
This file contains a design example using the OSPIPSV driver (xospipsv) The example writes to flash in IO mode and reads it back in DMA mode.
It runs in polled mode. The hardware which this example runs on, must have an octal serial Flash (Micron) for it to run.
This example has been tested with the Micron Octal Serial Flash (mt35xu01gbba).
None.
MODIFICATION HISTORY:
Ver Who Date Changes
1.0 nsk 02/19/17 First release sk 01/09/19 Updated flash configuration table with supported commands. sk 02/04/19 Add support for SDR+PHY and DDR+PHY modes. 1.0 akm 03/29/19 Fixed data alignment issues on IAR compiler. 1.1 sk 07/23/19 Based on RX Tuning, updated the dummy cycles. sk 08/08/19 Issue device reset to bring back to default state. 1.3 sk 05/27/20 Added Stacked mode support. 1.4 sk 02/18/21 Added support for Macronix flash and DualByte commands. 1.7 sk 06/28/22 Added Block Protection test for Micron flash. 1.9 sb 06/06/23 Added support for system device-tree flow.
Functions | |
int | OspiPsvPolledFlashExample (XOspiPsv *OspiPsvInstancePtr, u16 OspiPsvDeviceId) |
The purpose of this function is to illustrate how to use the XOspiPsv device driver using OSPI flash devices greater than or equal to 128Mb. More... | |
int | FlashReadID (XOspiPsv *OspiPsvPtr) |
Reads the flash ID and identifies the flash in FCT table. More... | |
int | FlashErase (XOspiPsv *OspiPsvPtr, u32 Address, u32 ByteCount, u8 *WriteBfrPtr) |
This function erases the sectors in the serial Flash connected to the OSPIPSV interface. More... | |
int | FlashIoWrite (XOspiPsv *OspiPsvPtr, u32 Address, u32 ByteCount, u8 *WriteBfrPtr) |
This function writes to the serial Flash connected to the OSPIPSV interface. More... | |
int | FlashLinearWrite (XOspiPsv *OspiPsvPtr, u32 Address, u32 ByteCount, u8 *WriteBfrPtr) |
This function writes to the serial Flash connected to the OSPIPSV interface. More... | |
int | FlashRead (XOspiPsv *OspiPsvPtr, u32 Address, u32 ByteCount, u8 *WriteBfrPtr, u8 *ReadBfrPtr) |
This function performs read. More... | |
u32 | GetRealAddr (XOspiPsv *OspiPsvPtr, u32 Address) |
This functions translates the address based on the type of interconnection. More... | |
int | BulkErase (XOspiPsv *OspiPsvPtr, u8 *WriteBfrPtr) |
This functions performs a bulk erase operation when the flash device has a single die. More... | |
int | DieErase (XOspiPsv *OspiPsvPtr, u8 *WriteBfrPtr) |
This functions performs a die erase operation on all the die in the flash device. More... | |
int | FlashEnterExit4BAddMode (XOspiPsv *OspiPsvPtr, int Enable) |
This API enters the flash device into 4 bytes addressing mode. More... | |
int | FlashSetSDRDDRMode (XOspiPsv *OspiPsvPtr, int Mode) |
This API enters the flash device into Octal DDR mode or exit from octal DDR mode (switches to Extended SPI mode). More... | |
int | SetBlockProtect (XOspiPsv *OspiPsvPtr, u8 BlockProtectionVal, u8 IsBottom) |
This function set the Block Protect bits in the Status register of the device. More... | |
int | MicronBlockProtectTest (XOspiPsv *OspiPsvInstancePtr) |
This function test the Block Protect feature for Micron flash by enabling the write protect for the first sector. More... | |
int | main (void) |
Main function to call the OSPIPSV Flash Polled example. More... | |
u32 | XOspiPsv_Get_Proto (XOspiPsv *OspiPsvInstancePtr, int Read) |
The purpose of this function is to determine the number of lines used for command, address and data. More... | |
int BulkErase | ( | XOspiPsv * | OspiPsvPtr, |
u8 * | WriteBfrPtr | ||
) |
This functions performs a bulk erase operation when the flash device has a single die.
Works for both Spansion and Micron
OspiPsvPtr | is a pointer to the OSPIPSV driver component to use. |
WriteBfrPtr | is the pointer to command+address to be sent |
int DieErase | ( | XOspiPsv * | OspiPsvPtr, |
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
OspiPsvPtr | is a pointer to the OSPIPSV driver component to use. |
WriteBfrPtr | is the pointer to command+address to be sent |
int FlashEnterExit4BAddMode | ( | XOspiPsv * | OspiPsvPtr, |
int | Enable | ||
) |
This API enters the flash device into 4 bytes addressing mode.
As per the Micron spec, before issuing the command to enter into 4 byte addr mode, a write enable command is issued.
OspiPsvPtr | is a pointer to the OSPIPSV driver component to use. |
Enable | is a either 1 or 0 if 1 then enters 4 byte if 0 exits. |
int FlashErase | ( | XOspiPsv * | OspiPsvPtr, |
u32 | Address, | ||
u32 | ByteCount, | ||
u8 * | WriteBfrPtr | ||
) |
This function erases the sectors in the serial Flash connected to the OSPIPSV interface.
OspiPsvPtr | is a pointer to the OSPIPSV 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 FlashIoWrite | ( | XOspiPsv * | OspiPsvPtr, |
u32 | Address, | ||
u32 | ByteCount, | ||
u8 * | WriteBfrPtr | ||
) |
This function writes to the serial Flash connected to the OSPIPSV 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. This can be used in IO or DMA mode.
OspiPsvPtr | is a pointer to the OSPIPSV driver component to use. |
Address | contains the address to write data to in the Flash. |
ByteCount | contains the number of bytes to write. |
WriteBfrPtr | is Pointer to the write buffer (which is to be transmitted) |
int FlashLinearWrite | ( | XOspiPsv * | OspiPsvPtr, |
u32 | Address, | ||
u32 | ByteCount, | ||
u8 * | WriteBfrPtr | ||
) |
This function writes to the serial Flash connected to the OSPIPSV 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. This can be used when controller is in Linear mode.
OspiPsvPtr | is a pointer to the OSPIPSV driver component to use. |
Address | contains the address to write data to in the Flash. |
ByteCount | contains the number of bytes to write. |
WriteBfrPtr | is Pointer to the write buffer (which is to be transmitted) |
References XOspiPsv_Msg::Addr, XOspiPsv_Msg::Addrsize, XOspiPsv_Msg::Addrvalid, XOspiPsv_Msg::ByteCount, XOspiPsv::DualByteOpcodeEn, XOspiPsv_Msg::Dummy, XOspiPsv_Msg::ExtendedOpcode, XOspiPsv_Msg::Flags, XOspiPsv_Msg::IsDDROpCode, XOspiPsv_Msg::Opcode, XOspiPsv_Msg::Proto, XOspiPsv_Msg::RxBfrPtr, XOspiPsv::SdrDdrMode, XOspiPsv_Msg::TxBfrPtr, XOspiPsv_Get_Proto(), and XOspiPsv_PollTransfer().
Referenced by MicronBlockProtectTest(), OspiPsvFlashNonBlockingReadExample(), and OspiPsvPolledFlashExample().
int FlashRead | ( | XOspiPsv * | OspiPsvPtr, |
u32 | Address, | ||
u32 | ByteCount, | ||
u8 * | WriteBfrPtr, | ||
u8 * | ReadBfrPtr | ||
) |
This function performs read.
DMA is the default setting.
OspiPsvPtr | is a pointer to the OSPIPSV 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 contains data to be transmitted |
ReadBfrPtr | is Pointer to the read buffer to which valid received data should be written |
int FlashReadID | ( | XOspiPsv * | OspiPsvPtr | ) |
Reads the flash ID and identifies the flash in FCT table.
OspiPsvPtr | is a pointer to the OSPIPSV driver component to use. |
int FlashSetSDRDDRMode | ( | XOspiPsv * | OspiPsvPtr, |
int | Mode | ||
) |
This API enters the flash device into Octal DDR mode or exit from octal DDR mode (switches to Extended SPI mode).
OspiPsvPtr | is a pointer to the OSPIPSV driver component to use. |
Mode | is either 1 or 0 if 1 then enter octal DDR mode if 0 exits. |
u32 GetRealAddr | ( | XOspiPsv * | OspiPsvPtr, |
u32 | Address | ||
) |
This functions translates the address based on the type of interconnection.
In case of stacked, this function asserts the corresponding slave select.
OspiPsvPtr | is a pointer to the OSPIPSV driver component to use. |
Address | which is to be accessed (for erase, write or read) |
int main | ( | void | ) |
Main function to call the OSPIPSV Flash Polled example.
References OspiPsvPolledFlashExample().
int MicronBlockProtectTest | ( | XOspiPsv * | OspiPsvInstancePtr | ) |
This function test the Block Protect feature for Micron flash by enabling the write protect for the first sector.
OspiPsvPtr | is a pointer to the OSPIPSV driver component to use |
References FlashErase(), FlashIoWrite(), FlashLinearWrite(), FlashRead(), SetBlockProtect(), XOSPIPSV_DAC_EN_OPTION, and XOspiPsv_GetOptions().
Referenced by OspiPsvPolledFlashExample().
int OspiPsvPolledFlashExample | ( | XOspiPsv * | OspiPsvInstancePtr, |
u16 | OspiPsvDeviceId | ||
) |
The purpose of this function is to illustrate how to use the XOspiPsv device driver using OSPI flash devices greater than or equal to 128Mb.
This function reads data in either DMA or DAC mode.
OspiPsvInstancePtr | is a pointer to the OSPIPSV driver component to use. |
OspiPsvDeviceId | is the Device ID of the OSpi Device and is the XPAR_<OSPI_instance>_DEVICE_ID value from xparameters.h. |
References XOspiPsv::Config, XOspiPsv_Config::ConnectionMode, FlashEnterExit4BAddMode(), FlashErase(), FlashIoWrite(), FlashLinearWrite(), FlashRead(), FlashReadID(), FlashSetSDRDDRMode(), MicronBlockProtectTest(), XOspiPsv_CfgInitialize(), XOSPIPSV_DAC_EN_OPTION, XOspiPsv_DeviceReset(), XOspiPsv_GetOptions(), XOSPIPSV_HWPIN_RESET, XOspiPsv_LookupConfig(), XOSPIPSV_SELECT_FLASH_CS0, XOspiPsv_SelectFlash(), XOspiPsv_SetClkPrescaler(), XOspiPsv_SetOptions(), and XOspiPsv_SetSdrDdrMode().
Referenced by main().
int SetBlockProtect | ( | XOspiPsv * | OspiPsvPtr, |
u8 | BlockProtectionVal, | ||
u8 | IsBottom | ||
) |
This function set the Block Protect bits in the Status register of the device.
User has to pass the BP bits[3:0] value as an argument to this function. This function reads the status register and set the corresponding BP bits as requested by the user and write back the status register.
OspiPsvPtr | is a pointer to the OSPIPSV driver component to use. |
BlockProtectionVal | Block protection bits value (4-bit value). |
IsBottom | Indicates whether the protected memory area defined by the block protect bits starts from the top or bottom of the memory. |
References XOspiPsv_Msg::Addr, XOspiPsv_Msg::Addrsize, XOspiPsv_Msg::Addrvalid, XOspiPsv_Msg::ByteCount, XOspiPsv::DualByteOpcodeEn, XOspiPsv_Msg::Dummy, XOspiPsv_Msg::ExtendedOpcode, XOspiPsv::Extra_DummyCycle, XOspiPsv_Msg::Flags, XOspiPsv_Msg::IsDDROpCode, XOspiPsv_Msg::Opcode, XOspiPsv_Msg::Proto, XOspiPsv_Msg::RxBfrPtr, XOspiPsv::SdrDdrMode, XOspiPsv_Msg::TxBfrPtr, XOSPIPSV_MSG_FLAG_RX, and XOspiPsv_PollTransfer().
Referenced by MicronBlockProtectTest().
u32 XOspiPsv_Get_Proto | ( | XOspiPsv * | OspiPsvInstancePtr, |
int | Read | ||
) |
The purpose of this function is to determine the number of lines used for command, address and data.
OspiPsvInstancePtr | is a pointer to the OSPIPSV driver component to use. |
Read | is to tell whether a read or write |
References XOspiPsv::OpMode, XOSPIPSV_IDAC_MODE, and XOSPIPSV_READ_1_1_1.