Hardware access layer (HAL) for managing the Non-Volatile Memory Controller (NVMC) peripheral. More...

Macros
#define	NRF_NVMC_HAS_PARTIAL_ERASE 1
	Symbol indicating whether the option of page partial erase is present.

#define	NRF_NVMC_HAS_PARTIAL_ERASE_MODE 1
	Symbol indicating whether page partial erase mode is present.

#define	NRF_NVMC_HAS_NON_SECURE_OPERATIONS 1
	Symbol indicating whether NVMC has non-secure operations available.

#define	NRF_NVMC_HAS_UICR_ERASE 1
	Symbol indicating whether NVMC has UICR erase available.

#define	NRF_NVMC_HAS_WRITE_READY_CHECK 1
	Symbol indicating whether write ready check is available.

Enumerations
enum	nrf_nvmc_mode_t { NRF_NVMC_MODE_READONLY = NVMC_CONFIG_WEN_Ren , NRF_NVMC_MODE_WRITE = NVMC_CONFIG_WEN_Wen , NRF_NVMC_MODE_ERASE = NVMC_CONFIG_WEN_Een , NRF_NVMC_MODE_PARTIAL_ERASE = NVMC_CONFIG_WEN_PEen }
	NVMC modes. More...

enum	nrf_nvmc_ns_mode_t { NRF_NVMC_NS_MODE_READONLY = NVMC_CONFIGNS_WEN_Ren , NRF_NVMC_NS_MODE_WRITE = NVMC_CONFIGNS_WEN_Wen , NRF_NVMC_NS_MODE_ERASE = NVMC_CONFIGNS_WEN_Een }
	Non-secure NVMC modes. More...

enum	nrf_nvmc_icache_config_t { NRF_NVMC_ICACHE_DISABLE = NVMC_ICACHECNF_CACHEEN_Disabled , NRF_NVMC_ICACHE_ENABLE = NVMC_ICACHECNF_CACHEEN_Enabled , NRF_NVMC_ICACHE_ENABLE_WITH_PROFILING }
	NVMC ICache configuration. More...

Functions
NRF_STATIC_INLINE bool	nrf_nvmc_ready_check (NRF_NVMC_Type const *p_reg)
	Function for checking if NVMC is ready to perform write or erase operation.

NRF_STATIC_INLINE bool	nrf_nvmc_write_ready_check (NRF_NVMC_Type const *p_reg)
	Function for checking if NVMC is ready to accept the next write operation.

NRF_STATIC_INLINE void	nrf_nvmc_mode_set (NRF_NVMC_Type *p_reg, nrf_nvmc_mode_t mode)
	Function for setting the NVMC mode.

NRF_STATIC_INLINE void	nrf_nvmc_nonsecure_mode_set (NRF_NVMC_Type *p_reg, nrf_nvmc_ns_mode_t mode)
	Function for setting the NVMC mode for non-secure Flash page operations.

NRF_STATIC_INLINE void	nrf_nvmc_word_write (uint32_t address, uint32_t value)
	Function for writing a 32-bit word to flash.

NRF_STATIC_INLINE uint8_t	nrf_nvmc_byte_read (uint32_t address)
	Function for reading a byte from the flash.

NRF_STATIC_INLINE uint16_t	nrf_nvmc_halfword_read (uint32_t address)
	Function for reading a 16-bit halfword from the flash.

NRF_STATIC_INLINE uint32_t	nrf_nvmc_word_read (uint32_t address)
	Function for reading a 32-bit word from the flash.

NRF_STATIC_INLINE void	nrf_nvmc_buffer_read (void *dst, uint32_t address, uint32_t num_bytes)
	Function for reading a given number of bytes from the flash into the specified buffer.

NRF_STATIC_INLINE void	nrf_nvmc_page_erase_start (NRF_NVMC_Type *p_reg, uint32_t page_addr)
	Function for starting a single page erase in the Flash memory.

NRF_STATIC_INLINE void	nrf_nvmc_uicr_erase_start (NRF_NVMC_Type *p_reg)
	Function for starting the user information configuration registers (UICR) erase.

NRF_STATIC_INLINE void	nrf_nvmc_erase_all_start (NRF_NVMC_Type *p_reg)
	Function for starting the erase of the whole NVM, including UICR.

NRF_STATIC_INLINE void	nrf_nvmc_partial_erase_duration_set (NRF_NVMC_Type *p_reg, uint32_t duration_ms)
	Function for configuring the page partial erase duration in milliseconds.

NRF_STATIC_INLINE uint32_t	nrf_nvmc_partial_erase_duration_get (NRF_NVMC_Type const *p_reg)
	Function for getting the current setting for the page partial erase duration.

NRF_STATIC_INLINE void	nrf_nvmc_page_partial_erase_start (NRF_NVMC_Type *p_reg, uint32_t page_addr)
	Function for starting a partial erase operation.

NRF_STATIC_INLINE void	nrf_nvmc_icache_config_set (NRF_NVMC_Type *p_reg, nrf_nvmc_icache_config_t config)
	Function for applying the Instruction Cache (ICache) configuration.

NRF_STATIC_INLINE bool	nrf_nvmc_icache_enable_check (NRF_NVMC_Type const *p_reg)
	Function for checking if ICache is enabled.

NRF_STATIC_INLINE bool	nrf_nvmc_icache_profiling_enable_check (NRF_NVMC_Type const *p_reg)
	Function for checking if the ICache profiling option is enabled.

NRF_STATIC_INLINE uint32_t	nrf_nvmc_icache_hit_get (NRF_NVMC_Type const *p_reg)
	Function for getting the number of ICache hits.

NRF_STATIC_INLINE uint32_t	nrf_nvmc_icache_miss_get (NRF_NVMC_Type const *p_reg)
	Function for getting the number of ICache misses.

NRF_STATIC_INLINE void	nrf_nvmc_icache_hit_miss_reset (NRF_NVMC_Type *p_reg)
	Function for resetting the ICache hit and miss counters.

Detailed Description

Hardware access layer (HAL) for managing the Non-Volatile Memory Controller (NVMC) peripheral.

Enumeration Type Documentation

◆ nrf_nvmc_icache_config_t

enum nrf_nvmc_icache_config_t

NVMC ICache configuration.

Enumerator
NRF_NVMC_ICACHE_DISABLE	Instruction Cache disabled.
NRF_NVMC_ICACHE_ENABLE	Instruction Cache enabled.
NRF_NVMC_ICACHE_ENABLE_WITH_PROFILING	Instruction Cache with cache profiling enabled.

◆ nrf_nvmc_mode_t

enum nrf_nvmc_mode_t

NVMC modes.

Enumerator
NRF_NVMC_MODE_READONLY	NVMC in read-only mode.
NRF_NVMC_MODE_WRITE	NVMC in read and write mode.
NRF_NVMC_MODE_ERASE	NVMC in read and erase mode.
NRF_NVMC_MODE_PARTIAL_ERASE	NVMC in read and partial erase mode.

◆ nrf_nvmc_ns_mode_t

enum nrf_nvmc_ns_mode_t

Non-secure NVMC modes.

Enumerator
NRF_NVMC_NS_MODE_READONLY	Non-secure NVMC in read-only mode.
NRF_NVMC_NS_MODE_WRITE	Non-secure NVMC in read and write mode.
NRF_NVMC_NS_MODE_ERASE	Non-secure NVMC in read and erase mode.

Function Documentation

◆ nrf_nvmc_buffer_read()

NRF_STATIC_INLINE void nrf_nvmc_buffer_read	(	void *	dst,
		uint32_t	address,
		uint32_t	num_bytes )

Function for reading a given number of bytes from the flash into the specified buffer.

Using this function when accessing the flash gives the possibility to run the code in an environment where the flash is simulated.

Parameters

[in]	dst	Pointer to the buffer to store the data.
[in]	address	Address of the first byte to read.
[in]	num_bytes	Number of bytes to read.

◆ nrf_nvmc_byte_read()

NRF_STATIC_INLINE uint8_t nrf_nvmc_byte_read ( uint32_t address )

Function for reading a byte from the flash.

Using this function when accessing the flash gives the possibility to run the code in an environment where the flash is simulated.

Parameters

[in] address Address of the byte to read.

Returns: Value read from flash.

◆ nrf_nvmc_erase_all_start()

NRF_STATIC_INLINE void nrf_nvmc_erase_all_start ( NRF_NVMC_Type * p_reg )

Function for starting the erase of the whole NVM, including UICR.

This function purges all user code.

Parameters

[in] p_reg Pointer to the structure of registers of the peripheral.

◆ nrf_nvmc_halfword_read()

NRF_STATIC_INLINE uint16_t nrf_nvmc_halfword_read ( uint32_t address )

Function for reading a 16-bit halfword from the flash.

Using this function when accessing the flash gives the possibility to run the code in an environment where the flash is simulated.

Parameters

[in] address Address of the halfword to read.

Returns: Value read from flash.

◆ nrf_nvmc_icache_config_set()

NRF_STATIC_INLINE void nrf_nvmc_icache_config_set	(	NRF_NVMC_Type *	p_reg,
		nrf_nvmc_icache_config_t	config )

Function for applying the Instruction Cache (ICache) configuration.

Enabling the cache can increase CPU performance and reduce power consumption by reducing the number of wait cycles and the number of flash accesses.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	config	ICache configuration.

◆ nrf_nvmc_icache_enable_check()

NRF_STATIC_INLINE bool nrf_nvmc_icache_enable_check ( NRF_NVMC_Type const * p_reg )

Function for checking if ICache is enabled.

Parameters

[in] p_reg Pointer to the structure of registers of the peripheral.

Return values

true	ICache enabled.
false	ICache disabled.

◆ nrf_nvmc_icache_hit_get()

NRF_STATIC_INLINE uint32_t nrf_nvmc_icache_hit_get ( NRF_NVMC_Type const * p_reg )

Function for getting the number of ICache hits.

Parameters

[in] p_reg Pointer to the structure of registers of the peripheral.

Return values

Number of the ICache hits.

◆ nrf_nvmc_icache_hit_miss_reset()

NRF_STATIC_INLINE void nrf_nvmc_icache_hit_miss_reset ( NRF_NVMC_Type * p_reg )

Function for resetting the ICache hit and miss counters.

Parameters

[in] p_reg Pointer to the structure of registers of the peripheral.

◆ nrf_nvmc_icache_miss_get()

NRF_STATIC_INLINE uint32_t nrf_nvmc_icache_miss_get ( NRF_NVMC_Type const * p_reg )

Function for getting the number of ICache misses.

Parameters

[in] p_reg Pointer to the structure of registers of the peripheral.

Return values

Number of the ICache misses.

◆ nrf_nvmc_icache_profiling_enable_check()

NRF_STATIC_INLINE bool nrf_nvmc_icache_profiling_enable_check ( NRF_NVMC_Type const * p_reg )

Function for checking if the ICache profiling option is enabled.

Parameters

[in] p_reg Pointer to the structure of registers of the peripheral.

Return values

true	ICache profiling enabled.
false	ICache profiling disabled.

◆ nrf_nvmc_mode_set()

NRF_STATIC_INLINE void nrf_nvmc_mode_set	(	NRF_NVMC_Type *	p_reg,
		nrf_nvmc_mode_t	mode )

Function for setting the NVMC mode.

Only activate erase and write modes when they are actively used. If Instruction Cache (ICache) is present, enabling write or erase will invalidate the cache and keep it invalidated.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mode	Desired operating mode for NVMC.

◆ nrf_nvmc_nonsecure_mode_set()

NRF_STATIC_INLINE void nrf_nvmc_nonsecure_mode_set	(	NRF_NVMC_Type *	p_reg,
		nrf_nvmc_ns_mode_t	mode )

Function for setting the NVMC mode for non-secure Flash page operations.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mode	Desired operating mode for NVMC.

◆ nrf_nvmc_page_erase_start()

NRF_STATIC_INLINE void nrf_nvmc_page_erase_start	(	NRF_NVMC_Type *	p_reg,
		uint32_t	page_addr )

Function for starting a single page erase in the Flash memory.

The NVMC mode must be correctly configured with nrf_nvmc_mode_set before starting the erase operation.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	page_addr	Address of the first word of the page to erase.

◆ nrf_nvmc_page_partial_erase_start()

NRF_STATIC_INLINE void nrf_nvmc_page_partial_erase_start	(	NRF_NVMC_Type *	p_reg,
		uint32_t	page_addr )

Function for starting a partial erase operation.

It must be called successively until the page erase time is reached.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	page_addr	Address of the first word of the page to erase.

◆ nrf_nvmc_partial_erase_duration_get()

NRF_STATIC_INLINE uint32_t nrf_nvmc_partial_erase_duration_get ( NRF_NVMC_Type const * p_reg )

Function for getting the current setting for the page partial erase duration.

Parameters

[in] p_reg Pointer to the structure of registers of the peripheral.

Return values

Interval duration setting in milliseconds.

◆ nrf_nvmc_partial_erase_duration_set()

NRF_STATIC_INLINE void nrf_nvmc_partial_erase_duration_set	(	NRF_NVMC_Type *	p_reg,
		uint32_t	duration_ms )

Function for configuring the page partial erase duration in milliseconds.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	duration_ms	Page partial erase duration in milliseconds.

◆ nrf_nvmc_ready_check()

NRF_STATIC_INLINE bool nrf_nvmc_ready_check ( NRF_NVMC_Type const * p_reg )

Function for checking if NVMC is ready to perform write or erase operation.

Parameters

[in] p_reg Pointer to the structure of registers of the peripheral.

Return values

true	NVMC can perform write or erase.
false	NVMC is busy and cannot perform next operation yet.

◆ nrf_nvmc_uicr_erase_start()

NRF_STATIC_INLINE void nrf_nvmc_uicr_erase_start ( NRF_NVMC_Type * p_reg )

Function for starting the user information configuration registers (UICR) erase.

Parameters

[in] p_reg Pointer to the structure of registers of the peripheral.

◆ nrf_nvmc_word_read()

NRF_STATIC_INLINE uint32_t nrf_nvmc_word_read ( uint32_t address )

Function for reading a 32-bit word from the flash.

Using this function when accessing the flash gives the possibility to run the code in an environment where the flash is simulated.

Parameters

[in] address Address of the word to read.

Returns: Value read from flash.

◆ nrf_nvmc_word_write()

NRF_STATIC_INLINE void nrf_nvmc_word_write	(	uint32_t	address,
		uint32_t	value )

Function for writing a 32-bit word to flash.

Note

Before calling this function, the caller must ensure that:

the address is word-aligned,
write mode is enabled, using nrf_nvmc_mode_set,
the NVMC is ready to accept another write, using nrf_nvmc_ready_check or nrf_nvmc_write_ready_check,
read-only mode is enabled as soon as writing is no longer needed, using nrf_nvmc_mode_set.

Warning: It is recommended to use nrfx_nvmc_word_write function instead.

Using this function when accessing the flash gives the possibility to run the code in an environment where the flash is simulated.

Parameters

[in]	address	Address of the word to write.
[in]	value	Value to write.

◆ nrf_nvmc_write_ready_check()

NRF_STATIC_INLINE bool nrf_nvmc_write_ready_check ( NRF_NVMC_Type const * p_reg )

Function for checking if NVMC is ready to accept the next write operation.

NVM writing time can be reduced by using this function.

Parameters

[in] p_reg Pointer to the structure of registers of the peripheral.

Return values

true	NVMC can accept the next write. It will be buffered and will be taken into account as soon as the ongoing write operation is completed.
false	NVMC is busy and cannot accept the next write yet.

Macros

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ nrf_nvmc_icache_config_t

◆ nrf_nvmc_mode_t

◆ nrf_nvmc_ns_mode_t

Function Documentation

◆ nrf_nvmc_buffer_read()

◆ nrf_nvmc_byte_read()

◆ nrf_nvmc_erase_all_start()

◆ nrf_nvmc_halfword_read()

◆ nrf_nvmc_icache_config_set()

◆ nrf_nvmc_icache_enable_check()

◆ nrf_nvmc_icache_hit_get()

◆ nrf_nvmc_icache_hit_miss_reset()

◆ nrf_nvmc_icache_miss_get()

◆ nrf_nvmc_icache_profiling_enable_check()

◆ nrf_nvmc_mode_set()

◆ nrf_nvmc_nonsecure_mode_set()

◆ nrf_nvmc_page_erase_start()

◆ nrf_nvmc_page_partial_erase_start()

◆ nrf_nvmc_partial_erase_duration_get()

◆ nrf_nvmc_partial_erase_duration_set()

◆ nrf_nvmc_ready_check()

◆ nrf_nvmc_uicr_erase_start()

◆ nrf_nvmc_word_read()

◆ nrf_nvmc_word_write()

◆ nrf_nvmc_write_ready_check()