Collaboration diagram for Status Codes:

Macros
#define	NVS_STATUS_SUCCESS (0)
	Successful status code returned by: NVS_control(), NVS_read(), NVS_write(), NVS_erase(), or NVS_lock(). More...

#define	NVS_STATUS_ERROR (-1)
	Generic error status code returned by: NVS_control(), NVS_erase(), or NVS_write(),. More...

#define	NVS_STATUS_UNDEFINEDCMD (-2)
	An error status code returned by NVS_control() for undefined command codes. More...

#define	NVS_STATUS_TIMEOUT (-3)
	An error status code returned by NVS_lock() More...

#define	NVS_STATUS_INV_OFFSET (-4)
	An error status code returned by NVS_read(), NVS_write(), or NVS_erase() More...

#define	NVS_STATUS_INV_ALIGNMENT (-5)
	An error status code. More...

#define	NVS_STATUS_INV_SIZE (-6)
	An error status code returned by NVS_erase() and NVS_write() More...

#define	NVS_STATUS_INV_WRITE (-7)
	An error status code returned by NVS_write() More...

#define	NVS_STATUS_VERIFYBUFFER (-8)
	An error status code returned by NVS_write() More...

Detailed Description

NVS_STATUS_* macros are general status codes returned by NVS_control()

Macro Definition Documentation

§ NVS_STATUS_SUCCESS

#define NVS_STATUS_SUCCESS (0)

Successful status code returned by: NVS_control(), NVS_read(), NVS_write(), NVS_erase(), or NVS_lock().

APIs returns NVS_STATUS_SUCCESS if the API was executed successfully.

§ NVS_STATUS_ERROR

#define NVS_STATUS_ERROR (-1)

Generic error status code returned by: NVS_control(), NVS_erase(), or NVS_write(),.

APIs return NVS_STATUS_ERROR if the API was not executed successfully.

§ NVS_STATUS_UNDEFINEDCMD

#define NVS_STATUS_UNDEFINEDCMD (-2)

An error status code returned by NVS_control() for undefined command codes.

NVS_control() returns NVS_STATUS_UNDEFINEDCMD if the control code is not recognized by the driver implementation.

§ NVS_STATUS_TIMEOUT

#define NVS_STATUS_TIMEOUT (-3)

An error status code returned by NVS_lock()

NVS_lock() will return this value if the timeout has expired

§ NVS_STATUS_INV_OFFSET

#define NVS_STATUS_INV_OFFSET (-4)

An error status code returned by NVS_read(), NVS_write(), or NVS_erase()

Error status code returned if the offset argument is invalid (e.g., when offset + bufferSize exceeds the size of the region).

§ NVS_STATUS_INV_ALIGNMENT

#define NVS_STATUS_INV_ALIGNMENT (-5)

An error status code.

Error status code returned by NVS_erase() if the offset argument is not aligned on a flash sector address.

§ NVS_STATUS_INV_SIZE

#define NVS_STATUS_INV_SIZE (-6)

An error status code returned by NVS_erase() and NVS_write()

Error status code returned by NVS_erase() if the size argument is not a multiple of the flash sector size, or if offset + size extends past the end of the region.

§ NVS_STATUS_INV_WRITE

#define NVS_STATUS_INV_WRITE (-7)

An error status code returned by NVS_write()

NVS_write() will return this value if NVS_WRITE_PRE_VERIFY is requested and a flash location can not be changed to the value desired.

§ NVS_STATUS_VERIFYBUFFER

#define NVS_STATUS_VERIFYBUFFER (-8)