NVSCC32XX.h File Reference

#include <stdint.h>
#include <stdbool.h>

Include dependency graph for NVSCC32XX.h:

Go to the source code of this file.

Data Structures
struct	NVSCC32XX_CmdSetCopyBlockArgs
	NVSCC32XX command structure for setting copy block. More...
struct	NVSCC32XX_HWAttrs
	NVSCC32XX attributes. More...
struct	NVSCC32XX_Object

Macros
#define	NVSCC32XX_CMD_SET_COPYBLOCK   NVS_CMD_RESERVED + 0
	Command to set the copy block for an NVS block. More...
#define	NVSCC32XX_STATUS_ECOPYBLOCK   (NVS_STATUS_RESERVED - 1)
	Alignment error returned by NVSCC32XX_control(). More...

Variables
const NVS_FxnTable	NVSCC32XX_fxnTable

Macro Definition Documentation

NVSCC32XX_CMD_SET_COPYBLOCK

#define NVSCC32XX_CMD_SET_COPYBLOCK   NVS_CMD_RESERVED + 0

Command to set the copy block for an NVS block.

Passing NVSCC32XX_CMD_SET_COPYBLOCK to NVS_control(), along with a block of memory, is used to set the copy block for an NVSCC32XX_HWAttrs structure. The copy block is a RAM buffer used as scratch when writing to non-volatile storage.

If the copy block is not known at compile time, for example, if it is allocated from heap memory, it can be set through NVS_control() using the command NVSCC32XX_CMD_SET_COPYBLOCK. The copy block is passed in the arg parameter of NVS_control(). The size of the copy block passed to NVS_control() must be at least as large as the flash page size, and it is up to the application to ensure this.

See also

NVSCC32XX_HWAttrs

NVSCC32XX_STATUS_ECOPYBLOCK

#define NVSCC32XX_STATUS_ECOPYBLOCK   (NVS_STATUS_RESERVED - 1)

Alignment error returned by NVSCC32XX_control().

This error is returned if the copy block passed to NVSCC32XX_control() is not aligned on a 4-byte boundary, or is NULL.

See also

NVSCC32XX_HWAttrs

Variable Documentation

NVSCC32XX_fxnTable

const NVS_FxnTable NVSCC32XX_fxnTable