These APIs try to communicate with whichever flash is connected the OSPI peripheral in 1-1-1 mode. This can be used in bringing up new flashes and mostly used for debug and diagnostic purposes
|
| int32_t | OSPI_norFlashInit1s1s1s (OSPI_Handle handle) |
| | This function initializes the NOR flash to work in 1-1-1 mode. More...
|
| |
| void | OSPI_norFlashSetCmds (uint8_t rdCmd, uint8_t wrCmd, uint8_t eraseCmd) |
| | This function sets up internal bookkeeping variables for read, write and erase commands. This API has to be called immediately before OSPI_norFlashInit1s1s1s. More...
|
| |
| int32_t | OSPI_norFlashReadId (OSPI_Handle handle, uint32_t *manufacturerId, uint32_t *deviceId) |
| | This function tries to read the JEDEC ID from the NOR flash connected to the OSPI peripheral. More...
|
| |
| int32_t | OSPI_norFlashWrite (OSPI_Handle handle, uint32_t offset, uint8_t *buf, uint32_t len) |
| | This function writes data to the flash at a specified offset. More...
|
| |
| int32_t | OSPI_norFlashRead (OSPI_Handle handle, uint32_t offset, uint8_t *buf, uint32_t len) |
| | This function reads data from the flash from a specified offset. More...
|
| |
| int32_t | OSPI_norFlashReadSfdp (OSPI_Handle handle, uint32_t offset, uint8_t *buf, uint32_t len) |
| | This function reads SFDP table from the flash from a specified offset. More...
|
| |
| int32_t | OSPI_norFlashErase (OSPI_Handle handle, uint32_t address) |
| | This function erases 1 block of data starting from a provided address. More...
|
| |
◆ OSPI_norFlashInit1s1s1s()
◆ OSPI_norFlashSetCmds()
| void OSPI_norFlashSetCmds |
( |
uint8_t |
rdCmd, |
|
|
uint8_t |
wrCmd, |
|
|
uint8_t |
eraseCmd |
|
) |
| |
This function sets up internal bookkeeping variables for read, write and erase commands. This API has to be called immediately before OSPI_norFlashInit1s1s1s.
- Precondition
- OSPI controller has been opened using OSPI_open()
- Parameters
-
| rdCmd | Command to be used in single mode read |
| wrCmd | Command to be used in single mode write/page program |
| eraseCmd | Command to be used to erase (block or sector) |
◆ OSPI_norFlashReadId()
| int32_t OSPI_norFlashReadId |
( |
OSPI_Handle |
handle, |
|
|
uint32_t * |
manufacturerId, |
|
|
uint32_t * |
deviceId |
|
) |
| |
This function tries to read the JEDEC ID from the NOR flash connected to the OSPI peripheral.
- Precondition
- OSPI controller has been opened using OSPI_open()
- Parameters
-
| handle | An OSPI_Handle returned from an OSPI_open() |
| manufacturerId | Pointer to a uint32_t variable. This will be filled with the manufacturer ID on success |
| deviceId | Pointer to a uint32_t variable. This will be filled with the device ID on success |
- Returns
- SystemP_SUCCESS on success, SystemP_FAILURE otherwise
◆ OSPI_norFlashWrite()
| int32_t OSPI_norFlashWrite |
( |
OSPI_Handle |
handle, |
|
|
uint32_t |
offset, |
|
|
uint8_t * |
buf, |
|
|
uint32_t |
len |
|
) |
| |
This function writes data to the flash at a specified offset.
- Precondition
- OSPI controller has been opened using OSPI_open()
- Parameters
-
| handle | An OSPI_Handle returned from an OSPI_open() |
| offset | Offset at which the data is to be written |
| buf | Buffer which has the data to be written to the flash |
| len | Number of bytes to be written to the flash |
- Returns
- SystemP_SUCCESS on success, SystemP_FAILURE otherwise
◆ OSPI_norFlashRead()
| int32_t OSPI_norFlashRead |
( |
OSPI_Handle |
handle, |
|
|
uint32_t |
offset, |
|
|
uint8_t * |
buf, |
|
|
uint32_t |
len |
|
) |
| |
This function reads data from the flash from a specified offset.
- Precondition
- OSPI controller has been opened using OSPI_open()
- Parameters
-
| handle | An OSPI_Handle returned from an OSPI_open() |
| offset | Offset at which the data is to be read from |
| buf | Buffer to which data will be written into |
| len | Number of bytes to be read from the flash |
- Returns
- SystemP_SUCCESS on success, SystemP_FAILURE otherwise
◆ OSPI_norFlashReadSfdp()
| int32_t OSPI_norFlashReadSfdp |
( |
OSPI_Handle |
handle, |
|
|
uint32_t |
offset, |
|
|
uint8_t * |
buf, |
|
|
uint32_t |
len |
|
) |
| |
This function reads SFDP table from the flash from a specified offset.
- Precondition
- OSPI controller has been opened using OSPI_open()
- Parameters
-
| handle | An OSPI_Handle returned from an OSPI_open() |
| offset | Offset at which the data is to be read from |
| buf | Buffer to which data will be written into |
| len | Number of bytes to be read from the flash |
- Returns
- SystemP_SUCCESS on success, SystemP_FAILURE otherwise
◆ OSPI_norFlashErase()
| int32_t OSPI_norFlashErase |
( |
OSPI_Handle |
handle, |
|
|
uint32_t |
address |
|
) |
| |
This function erases 1 block of data starting from a provided address.
- Precondition
- OSPI controller has been opened using OSPI_open()
- Parameters
-
| handle | An OSPI_Handle returned from an OSPI_open() |
| address | Address of the data block to be erased. This address should be block aligned. |
- Returns
- SystemP_SUCCESS on success, SystemP_FAILURE otherwise