NVM3 HAL#

nvm3_HalPtr_t#

typedef void* nvm3_HalPtr_t

Pointer to NVM.

nvm3_HalNvmAccessCode_t#

typedef uint8_t nvm3_HalNvmAccessCode_t

Definition of the access data type.

nvm3_HalOpen_t#

typedef Ecode_t(* nvm3_HalOpen_t) (nvm3_HalPtr_t nvmAdr, size_t nvmSize) )(nvm3_HalPtr_t nvmAdr, size_t nvmSize)

Open the NVM3 HAL for usage.

This function must be run at initialization, before any other functions are called. It is used to call necessary startup routines before the hardware can be accessed.

Returns

• The result of the open call. ECODE_NVM3_OK on success or a NVM3 Ecode_t on failure.

nvm3_HalClose_t#

typedef void(* nvm3_HalClose_t) (void) )(void)

Close the NVM3 HAL for usage.

This function should be called at program termination. Should be done before any graceful halts.

nvm3_HalGetInfo_t#

typedef Ecode_t(* nvm3_HalGetInfo_t) (nvm3_HalInfo_t *info) )(nvm3_HalInfo_t *info)

Retrieve device information.

This function is used to retrieve information about the device properties, such as the device family, write size, whether the NVM is memory mapped or not, and finally the NVM page size.

nvm3_HalNvmAccess_t#

typedef void(* nvm3_HalNvmAccess_t) (nvm3_HalNvmAccessCode_t access) )(nvm3_HalNvmAccessCode_t access)

Control read and write access to the NVM.

This function is used to control the access to the NVM. It can be either read, write, or none.

nvm3_HalPageErase_t#

typedef Ecode_t(* nvm3_HalPageErase_t) (nvm3_HalPtr_t nvmAdr) )(nvm3_HalPtr_t nvmAdr)

Erase a page in the NVM.

This function is used to erase an NVM page.

Returns

• The result of the erase operation.

nvm3_HalReadWords_t#

typedef Ecode_t(* nvm3_HalReadWords_t) (nvm3_HalPtr_t nvmAdr, void *dst, size_t wordCnt) )(nvm3_HalPtr_t nvmAdr, void *dst, size_t wordCnt)

Read data from NVM.

This function is used to read data from the NVM. It will be a blocking call, since the thread asking for data to be read cannot continue without the data.

nvm3_HalWriteWords_t#

typedef Ecode_t(* nvm3_HalWriteWords_t) (nvm3_HalPtr_t nvmAdr, void const *pSrc, size_t cnt) )(nvm3_HalPtr_t nvmAdr, void const *pSrc, size_t cnt)

Write data to the NVM.

This function is used to write data to the NVM. This is a blocking function.

Returns

• The result of the write operation. ECODE_NVM3_OK on success or a NVM3 Ecode_t on failure.

nvm3_halFlashHandle#

const nvm3_HalHandle_t nvm3_halFlashHandle

The HAL flash handle.

nvm3_halFlashHandle#

const nvm3_HalHandle_t nvm3_halFlashHandle

The HAL flash handle.

nvm3_halFlashOpen#

static Ecode_t nvm3_halFlashOpen (nvm3_HalPtr_t nvmAdr, size_t flashSize)

nvm3_halFlashClose#

static void nvm3_halFlashClose (void )

nvm3_halFlashGetInfo#

static Ecode_t nvm3_halFlashGetInfo (nvm3_HalInfo_t * halInfo)

nvm3_halFlashAccess#

static void nvm3_halFlashAccess (nvm3_HalNvmAccessCode_t access)

nvm3_halFlashReadWords#

static Ecode_t nvm3_halFlashReadWords (nvm3_HalPtr_t nvmAdr, void * dst, size_t wordCnt)

nvm3_halFlashWriteWords#

static Ecode_t nvm3_halFlashWriteWords (nvm3_HalPtr_t nvmAdr, void const * src, size_t wordCnt)

nvm3_halFlashPageErase#

static Ecode_t nvm3_halFlashPageErase (nvm3_HalPtr_t nvmAdr)

CHECK_DATA#

#define CHECK_DATA

1

Macro defining if data should be checked.

NVM3_HAL_WRITE_SIZE_32#

#define NVM3_HAL_WRITE_SIZE_32

0

Only single writes are allowed.

NVM3_HAL_WRITE_SIZE_16#

#define NVM3_HAL_WRITE_SIZE_16

1

Two writes are allowed.

NVM3_HAL_NVM_ACCESS_NONE#

#define NVM3_HAL_NVM_ACCESS_NONE

0

No access.

NVM3_HAL_NVM_ACCESS_RD#

#define NVM3_HAL_NVM_ACCESS_RD

1

Read access.

NVM3_HAL_NVM_ACCESS_RDWR#

#define NVM3_HAL_NVM_ACCESS_RDWR

2

Read and write access.

NVM3_HAL_NVM_ACCESS_NOP#

#define NVM3_HAL_NVM_ACCESS_NOP

3

Ignore.