NVM3 Lock#

NVM3 lock functions.

This module provides data protection tools for NVM3.

The functions in this module are the default protection tools for NVM3. The application can substitute the nvm3_lockBegin and nvm3_lockEnd functions as long as the NVM3 functions are protected from being called re-entrant.

Note

These functions are used by the NVM3 and should not be used by any applications.

Functions#

void

nvm3_lockCreateMutex(void)

Create a mutex to lock and unlock section.

void

nvm3_lockBegin(void)

Begin a lock section.

void

nvm3_lockEnd(void)

End a lock section.

void

nvm3_lockDisableExecute(void *address, size_t size)

Disable execution from data area.

Function Documentation#

nvm3_lockCreateMutex#

void nvm3_lockCreateMutex (void )

Create a mutex to lock and unlock section.

Parameters

Type	Direction	Argument Name	Description
void	N/A

The Mutex creation for lock enable and disable.

It provides options for using "mutexes" for RTOS users and "core_critical" APIs for bare-metal users.

Note

RTOS users should avoid invoking the nvm3_lock APIs from within critical sections, as this may result in unexpected behavior. Please, ensure that kernel has been initialized before this API call.

nvm3_lockBegin#

void nvm3_lockBegin (void )

Begin a lock section.

Parameters

Type	Direction	Argument Name	Description
void	N/A

The default lock-begin implementation. Note

RTOS users should avoid invoking the nvm3_lock APIs from within critical sections, as this may result in unexpected behavior. Please, ensure that kernel has been initialized before this API call.

nvm3_lockEnd#

void nvm3_lockEnd (void )

End a lock section.

Parameters

Type	Direction	Argument Name	Description
void	N/A

The default lock-end implementation. Note

RTOS users should avoid invoking the nvm3_lock APIs from within critical sections, as this may result in unexpected behavior. Please, ensure that kernel has been initialized before this API call.

nvm3_lockDisableExecute#

void nvm3_lockDisableExecute (void * address, size_t size)

Disable execution from data area.

Parameters

Type	Direction	Argument Name	Description
void *	[in]	address	Start of memory range
size_t	[in]	size	Size of memory range.

Disable execution from data area.