LPCOpen SPIFI FLASH Library (LPCSPIFILIB)
Documentation for the LPCSPIFILIB library
|
Classes | |
struct | SPIFI_FAM_NODE |
LPCSPIFILIB family data. More... | |
struct | SPIFI_FAM_DESC |
LPCSPIFILIB family descriptor, used to describe devices to non-device specific functions. More... | |
struct | SPIFI_DEV_NODE |
Register device data node. More... | |
struct | SPIFI_FAM_FX |
Device specific function pointers. More... | |
struct | SPIFI_DEVICE_ID |
Device identification data. More... | |
struct | SPIFI_DEVICE_DATA |
Register device data. More... | |
struct | SPIFI_HANDLE |
LPCSPIFILIB device handle, used with all device and info functions. More... | |
struct | SPIFI_INFODATA |
Common data applicable to all devices. More... | |
struct | SPIFI_DEV_ENUMERATOR |
Context for enumerating devices. More... | |
Macros | |
#define | SPIFI_CAP_DUAL_READ (1 << 0) |
Possible device capabilities returned from getInfo() More... | |
#define | SPIFI_CAP_DUAL_WRITE (1 << 1) |
#define | SPIFI_CAP_QUAD_READ (1 << 2) |
#define | SPIFI_CAP_QUAD_WRITE (1 << 3) |
#define | SPIFI_CAP_FULLLOCK (1 << 4) |
#define | SPIFI_CAP_BLOCKLOCK (1 << 5) |
#define | SPIFI_CAP_SUBBLKERASE (1 << 6) |
#define | SPIFI_CAP_NOBLOCK (1 << 16) |
#define | SPIFI_OPT_USE_DUAL (3 << 0) |
Possible driver options, may not be supported by all drivers. More... | |
#define | SPIFI_OPT_USE_QUAD (3 << 2) |
#define | SPIFI_OPT_NOBLOCK (1 << 16) |
#define | SPIFI_STAT_BUSY (1 << 0) |
Possible device statuses returned from getInfo() More... | |
#define | SPIFI_STAT_ISWP (1 << 1) |
#define | SPIFI_STAT_FULLLOCK (1 << 2) |
#define | SPIFI_STAT_PARTLOCK (1 << 3) |
#define | SPIFI_STAT_PROGERR (1 << 4) |
#define | SPIFI_STAT_ERASEERR (1 << 5) |
#define | SPIFI_INFO_QUADREAD_CLOCK SPIFI_INFO_MAX_HSREAD_CLOCK |
SPIFI_INFO_QUADREAD_CLOCK Depricated! Do NOT use for new development. | |
#define | SPIFI_INFO_QUADPROG_CLOCK SPIFI_INFO_MAX_HSPROG_CLOCK |
SPIFI_INFO_QUADPROG_CLOCK Depricated! Do NOT use for new development. | |
Typedefs | |
typedef struct SPIFI_FAM_NODE | SPIFI_FAM_NODE_T |
LPCSPIFILIB family data. | |
typedef struct SPIFI_FAM_DESC | SPIFI_FAM_DESC_T |
LPCSPIFILIB family descriptor, used to describe devices to non-device specific functions. | |
typedef struct SPIFI_DEV_NODE | SPIFI_DEV_NODE_T |
Register device data node. | |
typedef SPIFI_ERR_T(* | deviceInitDeInitFx )(const struct SPIFI_HANDLE *, uint32_t) |
typedef void(* | devClearStatusFx )(const struct SPIFI_HANDLE *) |
typedef uint32_t(* | devGetStatusFx )(const struct SPIFI_HANDLE *) |
typedef void(* | devSetStatusFx )(const struct SPIFI_HANDLE *, uint32_t) |
typedef SPIFI_ERR_T(* | devSetOptsFx )(const struct SPIFI_HANDLE *, uint32_t, uint32_t) |
typedef void(* | devGetReadCmdFx )(const struct SPIFI_HANDLE *, uint8_t, uint32_t *, uint32_t *) |
typedef void(* | devGetWriteCmdFx )(const struct SPIFI_HANDLE *, uint32_t *) |
typedef struct SPIFI_FAM_FX | SPIFI_FAM_FX_T |
Device specific function pointers. | |
typedef struct SPIFI_DEVICE_ID | SPIFI_DEVICE_ID_T |
Device identification data. | |
typedef struct SPIFI_DEVICE_DATA | SPIFI_DEVICE_DATA_T |
Register device data. | |
typedef struct SPIFI_HANDLE | SPIFI_HANDLE_T |
LPCSPIFILIB device handle, used with all device and info functions. | |
typedef struct SPIFI_INFODATA | SPIFI_INFODATA_T |
Common data applicable to all devices. | |
typedef struct SPIFI_DEV_ENUMERATOR | SPIFI_DEV_ENUMERATOR_T |
Context for enumerating devices. | |
#define SPIFI_CAP_BLOCKLOCK (1 << 5) |
Individual block device lock supported
#define SPIFI_CAP_DUAL_READ (1 << 0) |
Possible device capabilities returned from getInfo()
Supports DUAL read mode
#define SPIFI_CAP_DUAL_WRITE (1 << 1) |
Supports DUAL write mode
#define SPIFI_CAP_FULLLOCK (1 << 4) |
Full device lock supported
#define SPIFI_CAP_NOBLOCK (1 << 16) |
Non-blocking mode supported
#define SPIFI_CAP_QUAD_READ (1 << 2) |
Supports QUAD read mode
#define SPIFI_CAP_QUAD_WRITE (1 << 3) |
Supports QUAD write mode
#define SPIFI_CAP_SUBBLKERASE (1 << 6) |
Sub-block erase supported
#define SPIFI_OPT_NOBLOCK (1 << 16) |
Will not block on program and erase operations, poll device status manually
#define SPIFI_OPT_USE_DUAL (3 << 0) |
Possible driver options, may not be supported by all drivers.
Enable DUAL read / write if option is supported
#define SPIFI_OPT_USE_QUAD (3 << 2) |
Enable QUAD read / write if option is supported
#define SPIFI_STAT_BUSY (1 << 0) |
Possible device statuses returned from getInfo()
Device is busy erasing or programming
#define SPIFI_STAT_ERASEERR (1 << 5) |
Device status shows a erase error (non-blocking mode only)
#define SPIFI_STAT_FULLLOCK (1 << 2) |
Device is fully locked
#define SPIFI_STAT_ISWP (1 << 1) |
Device is write protected (software or hardware)
#define SPIFI_STAT_PARTLOCK (1 << 3) |
Device is partially locked (device specific)
#define SPIFI_STAT_PROGERR (1 << 4) |
Device status shows a program error (non-blocking mode only)
typedef void(* devClearStatusFx)(const struct SPIFI_HANDLE *) |
Fx* to clear status
typedef void(* devGetReadCmdFx)(const struct SPIFI_HANDLE *, uint8_t, uint32_t *, uint32_t *) |
Fx* to return read commandReg value
typedef uint32_t(* devGetStatusFx)(const struct SPIFI_HANDLE *) |
Fx* to get status
typedef void(* devGetWriteCmdFx)(const struct SPIFI_HANDLE *, uint32_t *) |
Fx* to return write commandReg value
typedef SPIFI_ERR_T(* deviceInitDeInitFx)(const struct SPIFI_HANDLE *, uint32_t) |
Fx* to handle init / de-init
typedef SPIFI_ERR_T(* devSetOptsFx)(const struct SPIFI_HANDLE *, uint32_t, uint32_t) |
Fx* to set options
typedef void(* devSetStatusFx)(const struct SPIFI_HANDLE *, uint32_t) |
Fx* to set status
enum SPIFI_DEVFX_T |
Enumeration of device specific functions.
enum SPIFI_ERR_T |
Possible error codes that can be returned from functions.
enum SPIFI_INFO_ID_T |
Possible info lookup requests.
enum SPIFI_PCMD_SUBBLK_T |