LPCOpen SPIFI FLASH Library (LPCSPIFILIB)
Documentation for the LPCSPIFILIB library
|
Functions | |
uint32_t | spifiGetAddrFromBlock (const SPIFI_HANDLE_T *pHandle, uint32_t blockNum) |
Returns the starting address of a block number. More... | |
uint32_t | spifiGetAddrFromSubBlock (const SPIFI_HANDLE_T *pHandle, uint32_t subBlockNum) |
Returns the starting address of a sub-block number. More... | |
uint32_t | spifiGetBlockFromAddr (const SPIFI_HANDLE_T *pHandle, uint32_t addr) |
Returns the block number the passed address is located in. More... | |
uint32_t | spifiGetSubBlockFromAddr (const SPIFI_HANDLE_T *pHandle, uint32_t addr) |
Returns the sub-block number the passed address is located in. More... | |
uint32_t | spifiGetSubBlockFromBlock (const SPIFI_HANDLE_T *pHandle, uint32_t blockNum) |
Returns the first sub-block for a block. More... | |
SPIFI_ERR_T | spifiProgram (const SPIFI_HANDLE_T *pHandle, uint32_t addr, const uint32_t *writeBuff, uint32_t bytes) |
Program the device with the passed buffer. More... | |
SPIFI_ERR_T | spifiRead (const SPIFI_HANDLE_T *pHandle, uint32_t addr, uint32_t *readBuff, uint32_t bytes) |
Read the device into the passed buffer. More... | |
SPIFI_ERR_T | spifiErase (const SPIFI_HANDLE_T *pHandle, uint32_t firstBlock, uint32_t numBlocks) |
Erase multiple blocks. More... | |
SPIFI_ERR_T | spifiEraseByAddr (const SPIFI_HANDLE_T *pHandle, uint32_t firstAddr, uint32_t lastAddr) |
Erase multiple blocks by address range. More... | |
SPIFI_ERR_T spifiErase | ( | const SPIFI_HANDLE_T * | pHandle, |
uint32_t | firstBlock, | ||
uint32_t | numBlocks | ||
) |
Erase multiple blocks.
pHandle | : Pointer to a LPCSPIFILIB device handle |
firstBlock | : First block number to erase |
numBlocks | : Number of blocks to erase |
SPIFI_ERR_T spifiEraseByAddr | ( | const SPIFI_HANDLE_T * | pHandle, |
uint32_t | firstAddr, | ||
uint32_t | lastAddr | ||
) |
Erase multiple blocks by address range.
pHandle | : Pointer to a LPCSPIFILIB device handle |
firstAddr | : Starting address range for block erase |
lastAddr | : Ending address range for block erase |
uint32_t spifiGetAddrFromBlock | ( | const SPIFI_HANDLE_T * | pHandle, |
uint32_t | blockNum | ||
) |
Returns the starting address of a block number.
pHandle | : Pointer to a LPCSPIFILIB device handle |
blockNum | : Block number fo get starting address for |
uint32_t spifiGetAddrFromSubBlock | ( | const SPIFI_HANDLE_T * | pHandle, |
uint32_t | subBlockNum | ||
) |
Returns the starting address of a sub-block number.
pHandle | : Pointer to a LPCSPIFILIB device handle |
subBlockNum | : Sub-block number fo get starting address for |
uint32_t spifiGetBlockFromAddr | ( | const SPIFI_HANDLE_T * | pHandle, |
uint32_t | addr | ||
) |
Returns the block number the passed address is located in.
pHandle | : Pointer to a LPCSPIFILIB device handle |
addr | : Address to get block number for |
uint32_t spifiGetSubBlockFromAddr | ( | const SPIFI_HANDLE_T * | pHandle, |
uint32_t | addr | ||
) |
Returns the sub-block number the passed address is located in.
pHandle | : Pointer to a LPCSPIFILIB device handle |
addr | : Address to get sub-block number for |
uint32_t spifiGetSubBlockFromBlock | ( | const SPIFI_HANDLE_T * | pHandle, |
uint32_t | blockNum | ||
) |
Returns the first sub-block for a block.
pHandle | : Pointer to a LPCSPIFILIB device handle |
blockNum | : Block number to get first sub-block for |
SPIFI_ERR_T spifiProgram | ( | const SPIFI_HANDLE_T * | pHandle, |
uint32_t | addr, | ||
const uint32_t * | writeBuff, | ||
uint32_t | bytes | ||
) |
Program the device with the passed buffer.
pHandle | : Pointer to a LPCSPIFILIB device handle |
addr | : LPCSPIFILIB device address to start write at |
writeBuff | : Address of buffer to write, must be 32-bit aligned |
bytes | : Number of bytes to write |
SPIFI_ERR_T spifiRead | ( | const SPIFI_HANDLE_T * | pHandle, |
uint32_t | addr, | ||
uint32_t * | readBuff, | ||
uint32_t | bytes | ||
) |
Read the device into the passed buffer.
pHandle | : Pointer to a LPCSPIFILIB device handle |
addr | : LPCSPIFILIB device address to start read at |
readBuff | : Address of buffer to read into, must be 32-bit aligned |
bytes | : Number of bytes to read |