LPCOpen Platform for LPC18XX/43XX microcontrollers: C:/w/lpcopen_docs/software/lpcspifilib/inc/spifilib_api.h File Reference

| LPCOpen Platform for LPC18XX/43XX microcontrollers 18XX43XX LPCOpen Platform for the NXP LPC18XX/43XX family of Microcontrollers

- Main Page
- Modules
- Data Structures
- Files

- File List
- Globals

Macros | Functions
spifilib_api.h File Reference
`#include "spifilib_dev.h"`

Go to the source code of this file.

## Macros
#define | spifiDevGetFamilyName spifiDevGetDeviceName

## Functions
uint16_t | spifiGetLibVersion (void)
| Report the SPIFILIB version. More...
SPIFI_ERR_T | spifiInit (uint32_t spifiCtrlAddr, uint8_t reset)
| Initialize the SPIFILIB driver. More...
SPIFI_FAM_NODE_T * | spifiRegisterFamily (SPIFI_FAM_NODE_T *(*regFx)(void))
| Register a SPIFILIB family driver. More...
const char * | spifiReturnErrString (SPIFI_ERR_T errCode)
| Converts a SPIFILIB error code into a meaningful string. More...
uint32_t | spifiGetSuppFamilyCount (void)
| Return the number of registered device families in this driver. More...
const char * | spifiGetSuppFamilyName (uint32_t index)
| Return the driver device family name for a specific index. More...
uint32_t | spifiGetHandleMemSize (uint32_t spifiCtrlAddr)
| Detect and return memory needed for device handle at passed address. More...
SPIFI_HANDLE_T * | spifiInitDevice (void *pMem, uint32_t sizePMem, uint32_t spifiCtrlAddr, uint32_t baseAddr)
| Initialize driver and hardware for a specific device. More...
SPIFI_ERR_T | spifiDevSetOpts (SPIFI_HANDLE_T *pHandle, uint32_t options, uint8_t set)
| Set or unset driver options. More...
SPIFI_ERR_T | spifiDevRegister (const SPIFI_FAM_NODE_T *pFamily, SPIFI_DEV_NODE_T *pDevData)
| Add device to family driver. More...
static INLINE uint32_t | spifiDevGetCount (const SPIFI_FAM_NODE_T *pFamily)
| Returns the number of supported devices within a family. More...
const char * | spifiDevEnumerateName (SPIFI_DEV_ENUMERATOR_T *pContext, uint8_t reset)
| Enumerates the friendly names of supported devices. More...
SPIFI_ERR_T | spifiDevInit (const SPIFI_HANDLE_T *pHandle)
| Initialize a detected LPCSPIFILIB device. More...
SPIFI_ERR_T | spifiDevDeInit (const SPIFI_HANDLE_T *pHandle)
| De-initialize a detected LPCSPIFILIB device. More...
SPIFI_ERR_T | spifiDevSetMemMode (const SPIFI_HANDLE_T *pHandle, uint8_t enMMode)
| Sets or clears memory mode. More...
uint8_t | spifiDevGetMemoryMode (const SPIFI_HANDLE_T *pSpifi)
| Return status of memory mode. More...
static INLINE SPIFI_ERR_T | spifiDevUnlockDevice (const SPIFI_HANDLE_T *pHandle)
| Full LPCSPIFILIB device unlock. More...
static INLINE SPIFI_ERR_T | spifiDevLockDevice (const SPIFI_HANDLE_T *pHandle)
| Full LPCSPIFILIB device lock. More...
static INLINE SPIFI_ERR_T | spifiDevUnlockBlock (const SPIFI_HANDLE_T *pHandle, uint32_t block)
| Unlock a single device block. More...
static INLINE SPIFI_ERR_T | spifiDevLockBlock (const SPIFI_HANDLE_T *pHandle, uint32_t block)
| Lock a single device block. More...
static INLINE SPIFI_ERR_T | spifiDevEraseAll (const SPIFI_HANDLE_T *pHandle)
| Full LPCSPIFILIB device erase. More...
static INLINE SPIFI_ERR_T | spifiDevEraseSubBlock (const SPIFI_HANDLE_T *pHandle, uint32_t blknum)
| Erase a sub-block. More...
static INLINE SPIFI_ERR_T | spifiDevPageProgram (const SPIFI_HANDLE_T *pHandle, uint32_t addr, uint32_t *writeBuff, uint32_t bytes)
| Program up to a page of data at an address. More...
static INLINE SPIFI_ERR_T | spifiDevRead (const SPIFI_HANDLE_T *pHandle, uint32_t addr, uint32_t *readBuff, uint32_t bytes)
| Read data from a LPCSPIFILIB device. More...
static INLINE void | spifiDevReset (const SPIFI_HANDLE_T *pHandle)
| Reset the device. More...
static INLINE const char * | spifiDevGetDeviceName (const SPIFI_HANDLE_T *pHandle)
| Returns a string pointer to the generic device family name. More...
uint32_t | spifiDevGetInfo (const SPIFI_HANDLE_T *pHandle, SPIFI_INFO_ID_T infoId)
| Returns information on the device. More...
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...