NVM

Non-volatile Memory. More...

Collaboration diagram for NVM:

Enumerations
enum	nvm_result_t {   NVM_RESULT_OK ,   NVM_RESULT_INVALID ,   NVM_RESULT_UNSUPPORTED ,   NVM_RESULT_BUSY ,   NVM_RESULT_ERR ,   TOTAL_NVM_RESULT }
enum	nvm_status_t {   NVM_STATUS_UNKNOWN ,   NVM_STATUS_OK ,   NVM_STATUS_BUSY ,   NVM_STATUS_STOP ,   NVM_STATUS_WRITING ,   NVM_STATUS_READING ,   NVM_STATUS_ERR ,   TOTAL_NVM_STATUS }
enum	nvm_mode_t {   NVM_MODE_PAGE_ERASE ,   NVM_MODE_ROW_PROGRAM ,   NVM_MODE_QUAD_WORD_PROGRAM ,   NVM_MODE_WORD_PROGRAM ,   TOTAL_NVM_MODE }

Functions
nvm_result_t	hal_nvm_init (void)
	Initialize NVM.
nvm_result_t	hal_nvm_read (const uint32_t address, uint32_t *rx_buffer, const size_t len)
	Read memory from address to specified length.
nvm_result_t	hal_nvm_write (const uint32_t address, const uint32_t *tx_buffer, const size_t len, const nvm_mode_t mode)
	Write to memory on specified address.
nvm_result_t	hal_nvm_erase (const uint32_t address, const nvm_mode_t mode)
	Erase memory on specified address.
nvm_status_t	hal_nvm_get_status (void)
	Get NVM operation status.
nvm_result_t	hal_nvm_mutex_take (const uint8_t channel, const uint32_t timeout_ms)
	Try acquire RTOS mutex for specified channel.
nvm_result_t	hal_nvm_mutex_give (const uint8_t channel)
	Release RTOS mutex for specified channel.

Detailed Description

Non-volatile Memory.

Enumeration Type Documentation

nvm_mode_t

enum nvm_mode_t

#include <nvm/public_inc/hal_nvm.h>

Enumerator
NVM_MODE_PAGE_ERASE
NVM_MODE_ROW_PROGRAM
NVM_MODE_QUAD_WORD_PROGRAM
NVM_MODE_WORD_PROGRAM
TOTAL_NVM_MODE

nvm_result_t

enum nvm_result_t

#include <nvm/public_inc/hal_nvm.h>

Enumerator
NVM_RESULT_OK	No error.
NVM_RESULT_INVALID	Operation invalid.
NVM_RESULT_UNSUPPORTED	Operation not supported.
NVM_RESULT_BUSY	Bus busy.
NVM_RESULT_ERR	Error occurred.
TOTAL_NVM_RESULT

nvm_status_t

enum nvm_status_t

#include <nvm/public_inc/hal_nvm.h>

Enumerator
NVM_STATUS_UNKNOWN	Unknown bus status.
NVM_STATUS_OK	No error.
NVM_STATUS_BUSY	Bus busy.
NVM_STATUS_STOP	Channel stopped.
NVM_STATUS_WRITING	Channel writing.
NVM_STATUS_READING	Channel reading.
NVM_STATUS_ERR	Error occurred.
TOTAL_NVM_STATUS

Function Documentation

hal_nvm_erase()

nvm_result_t hal_nvm_erase	(	const uint32_t	address,
		const nvm_mode_t	mode )

#include <nvm/public_inc/hal_nvm.h>

Erase memory on specified address.

uint32_t start_addr = 0x8000000UL;
 
nvm_result_t result = hal_nvm_erase( start_addr, NVM_MODE_PAGE_ERASE );

Parameters

[in]	address	Start address to be erased
[in]	mode	Erase mode

Return values

NVM_RESULT_OK	Success erase from specified address
NVM_RESULT_INVALID	Invalid address or invalid erase mode
NVM_RESULT_ERR	Erase operation failed

hal_nvm_get_status()

nvm_status_t hal_nvm_get_status

(

void

)

#include <nvm/public_inc/hal_nvm.h>

Get NVM operation status.

Example usage:

         nvm_status_t status = hal_nvm_get_status();

Returns

NVM status

hal_nvm_init()

nvm_result_t hal_nvm_init

(

void

)

#include <nvm/public_inc/hal_nvm.h>

Initialize NVM.

nvm_result_t result = hal_nvm_init();

Return values

NVM_RESULT_OK	Success initialize NVM
NVM_RESULT_UNSUPPORTED	Operation not supported
NVM_RESULT_ERR	Failed initialize NVM

hal_nvm_mutex_give()

nvm_result_t hal_nvm_mutex_give

(

const uint8_t

channel

)

#include <nvm/public_inc/hal_nvm.h>

Release RTOS mutex for specified channel.

nvm_result_t result = hal_nvm_mutex_give( BSP_NVM_CHANNEL_1 );

Parameters

[in]

channel

NVM channel's mutex to be released

Return values

NVM_RESULT_OK	Success release mutex
NVM_RESULT_INVALID	Invalid channel
NVM_RESULT_UNSUPPORTED	Operation not supported
NVM_RESULT_ERR	Failed release mutex

hal_nvm_mutex_take()

nvm_result_t hal_nvm_mutex_take	(	const uint8_t	channel,
		const uint32_t	timeout_ms )

#include <nvm/public_inc/hal_nvm.h>

Try acquire RTOS mutex for specified channel.

nvm_result_t result = hal_nvm_mutex_take( BSP_NVM_CHANNEL_1, 10U );

Parameters

[in]	channel	NVM channel's mutex to be locked
[in]	timeout_ms	Mutex acquiring timeout in milliseconds

Return values

NVM_RESULT_OK	Success acquire mutex
NVM_RESULT_INVALID	Invalid channel
NVM_RESULT_UNSUPPORTED	Operation not supported
NVM_RESULT_ERR	Failed acquire mutex

hal_nvm_read()

nvm_result_t hal_nvm_read	(	const uint32_t	address,
		uint32_t *	rx_buffer,
		const size_t	len )

#include <nvm/public_inc/hal_nvm.h>

Read memory from address to specified length.

uint32_t rx_buffer  = 0UL;
uint32_t start_addr = 0x8000000UL;
 
nvm_result_t result = hal_nvm_read( start_addr,
                                    &rx_buffer,
                                    sizeof( rx_buffer ) );

Parameters

[in]	address	Start address to be read
[out]	rx_buffer	Receiving buffer
[in]	len	Range to read from start address

Return values

NVM_RESULT_OK	Success read memory
NVM_RESULT_INVALID	Operation invalid
NVM_RESULT_ERR	Read operation failed

hal_nvm_write()

nvm_result_t hal_nvm_write	(	const uint32_t	address,
		const uint32_t *	tx_buffer,
		const size_t	len,
		const nvm_mode_t	mode )

#include <nvm/public_inc/hal_nvm.h>

Write to memory on specified address.

uint32_t tx_buffer  = 0xDEADBEEFUL;
uint32_t start_addr = 0x8000000UL;
 
nvm_result_t result = hal_nvm_write( start_addr,
                                     &tx_buffer,
                                     sizeof( tx_buffer ),
                                     BSP_NVM_MODE_ROW_PROGRAM );

Parameters

[in]	address	Start address to be written
[in]	tx_buffer	Buffer to be written to memory
[in]	len	Buffer size
[in]	mode	Write mode

Return values

NVM_RESULT_OK	Success write to specified address
NVM_RESULT_INVALID	Operation invalid
NVM_RESULT_ERR	Write operation failed