Non-Volatile Memory Controller (NVMC) peripheral driver. More...

Functions
int	nrfx_nvmc_page_erase (uint32_t address)
	Function for erasing a page in flash.

int	nrfx_nvmc_uicr_erase (void)
	Function for erasing the user information configuration register (UICR).

void	nrfx_nvmc_all_erase (void)
	Function for erasing the whole flash memory.

int	nrfx_nvmc_page_partial_erase_init (uint32_t address, uint32_t duration_ms)
	Function for initiating a complete page erase split into parts (also known as partial erase).

bool	nrfx_nvmc_page_partial_erase_continue (void)
	Function for performing a part of the complete page erase (also known as partial erase).

bool	nrfx_nvmc_fits_memory_check (uint32_t addr, bool uicr_allowed, uint32_t num_bytes)
	Function for checking whether the specified range of addresses fits in non-volatile memory.

bool	nrfx_nvmc_fits_uicr_check (uint32_t addr, uint32_t num_bytes)
	Function for checking whether the specified range of addresses fits in UICR.

bool	nrfx_nvmc_byte_writable_check (uint32_t address, uint8_t value)
	Function for checking whether a byte is writable at the specified address.

void	nrfx_nvmc_byte_write (uint32_t address, uint8_t value)
	Function for writing a single byte to flash.

bool	nrfx_nvmc_halfword_writable_check (uint32_t address, uint16_t value)
	Function for checking whether a halfword is writable at the specified address.

void	nrfx_nvmc_halfword_write (uint32_t address, uint16_t value)
	Function for writing a 16-bit halfword to flash.

bool	nrfx_nvmc_word_writable_check (uint32_t address, uint32_t value)
	Function for checking whether a word is writable at the specified address.

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

void	nrfx_nvmc_bytes_write (uint32_t address, void const *src, uint32_t num_bytes)
	Function for writing consecutive bytes to flash.

void	nrfx_nvmc_words_write (uint32_t address, void const *src, uint32_t num_words)
	Function for writing consecutive words to flash.

uint16_t	nrfx_nvmc_otp_halfword_read (uint32_t address)
	Function for reading a 16-bit aligned halfword from the OTP (UICR)

NRFX_STATIC_INLINE uint32_t	nrfx_nvmc_uicr_word_read (uint32_t const volatile *address)
	Function for reading a 32-bit aligned word from the UICR.

NRFX_STATIC_INLINE void	nrfx_nvmc_uicr_word_write (uint32_t volatile *address, uint32_t value)
	Function for writing a 32-bit aligned word to the UICR.

uint32_t	nrfx_nvmc_flash_size_get (void)
	Function for getting the total flash size in bytes.

uint32_t	nrfx_nvmc_flash_page_size_get (void)
	Function for getting the flash page size in bytes.

uint32_t	nrfx_nvmc_flash_page_count_get (void)
	Function for getting the flash page count.

NRFX_STATIC_INLINE bool	nrfx_nvmc_write_done_check (void)
	Function for checking if the last flash write has been completed.

NRFX_STATIC_INLINE void	nrfx_nvmc_icache_enable (void)
	Function for enabling the Instruction Cache (ICache).

NRFX_STATIC_INLINE void	nrfx_nvmc_icache_disable (void)
	Function for disabling ICache.

Detailed Description

Non-Volatile Memory Controller (NVMC) peripheral driver.

Function Documentation

◆ nrfx_nvmc_all_erase()

void nrfx_nvmc_all_erase ( void )

Function for erasing the whole flash memory.

Note: All user code and UICR will be erased.

◆ nrfx_nvmc_byte_writable_check()

bool nrfx_nvmc_byte_writable_check	(	uint32_t	address,
		uint8_t	value )

Function for checking whether a byte is writable at the specified address.

The NVMC is only able to write '0' to bits in the flash that are erased (set to '1'). It cannot rewrite a bit back to '1'. This function checks if the value currently residing at the specified address can be transformed to the desired value without any '0' to '1' transitions.

Parameters

address	Address to be checked.
value	Value to be checked.

Return values

true	Byte can be written at the specified address.
false	Byte cannot be written at the specified address. Erase the page or change the address.

◆ nrfx_nvmc_byte_write()

void nrfx_nvmc_byte_write	(	uint32_t	address,
		uint8_t	value )

Function for writing a single byte to flash.

To determine if the flash write has been completed, use nrfx_nvmc_write_done_check().

Note: Depending on the source of the code being executed, the CPU may be halted during the operation. Refer to the Product Specification for more information.

Parameters

address	Address to write to.
value	Value to write.

◆ nrfx_nvmc_bytes_write()

void nrfx_nvmc_bytes_write	(	uint32_t	address,
		void const *	src,
		uint32_t	num_bytes )

Function for writing consecutive bytes to flash.

To determine if the last flash write has been completed, use nrfx_nvmc_write_done_check().

Note: Depending on the source of the code being executed, the CPU may be halted during the operation. Refer to the Product Specification for more information.

Parameters

address	Address to write to.
src	Pointer to the data to copy from.
num_bytes	Number of bytes to write.

◆ nrfx_nvmc_fits_memory_check()

bool nrfx_nvmc_fits_memory_check	(	uint32_t	addr,
		bool	uicr_allowed,
		uint32_t	num_bytes )

Function for checking whether the specified range of addresses fits in non-volatile memory.

Note: This function checks if the range fits in regular memory, or in either UICR or regular memory, depending on arguments. To check if a range fits specifically in UICR use nrfx_nvmc_fits_uicr_check.

Parameters

[in]	addr	Starting address of the range to be checked.
[in]	uicr_allowed	If true, addresses in the UICR area are considered valid.
[in]	num_bytes	Length of the range to be checked in bytes.

Return values

true	Range fits in NVM.
false	Range doesn't fit in NVM.

◆ nrfx_nvmc_fits_uicr_check()

bool nrfx_nvmc_fits_uicr_check	(	uint32_t	addr,
		uint32_t	num_bytes )

Function for checking whether the specified range of addresses fits in UICR.

Parameters

[in]	addr	Starting address of the range to be checked.
[in]	num_bytes	Length of the range to be checked in bytes.

Return values

true	Range fits in UICR.
false	Range doesn't fit in UICR.

◆ nrfx_nvmc_flash_page_count_get()

uint32_t nrfx_nvmc_flash_page_count_get ( void )

Function for getting the flash page count.

Returns: Flash page count.

◆ nrfx_nvmc_flash_page_size_get()

uint32_t nrfx_nvmc_flash_page_size_get ( void )

Function for getting the flash page size in bytes.

Returns: Flash page size in bytes.

◆ nrfx_nvmc_flash_size_get()

uint32_t nrfx_nvmc_flash_size_get ( void )

Function for getting the total flash size in bytes.

Returns: Flash total size in bytes.

◆ nrfx_nvmc_halfword_writable_check()

bool nrfx_nvmc_halfword_writable_check	(	uint32_t	address,
		uint16_t	value )

Function for checking whether a halfword is writable at the specified address.

The NVMC is only able to write '0' to bits in the Flash that are erased (set to '1'). It cannot rewrite a bit back to '1'. This function checks if the value currently residing at the specified address can be transformed to the desired value without any '0' to '1' transitions.

Parameters

address	Address to be checked. Must be halfword-aligned.
value	Value to be checked.

Return values

true	Halfword can be written at the specified address.
false	Halfword cannot be written at the specified address. Erase page or change address.

◆ nrfx_nvmc_halfword_write()

void nrfx_nvmc_halfword_write	(	uint32_t	address,
		uint16_t	value )

Function for writing a 16-bit halfword to flash.

To determine if the flash write has been completed, use nrfx_nvmc_write_done_check().

Note: Depending on the source of the code being executed, the CPU may be halted during the operation. Refer to the Product Specification for more information.

Parameters

address	Address to write to. Must be halfword-aligned.
value	Value to write.

◆ nrfx_nvmc_icache_enable()

NRFX_STATIC_INLINE void nrfx_nvmc_icache_enable ( void )

Function for enabling the Instruction Cache (ICache).

Enabling ICache reduces the amount of accesses to flash memory, which can boost performance and lower power consumption.

◆ nrfx_nvmc_otp_halfword_read()

uint16_t nrfx_nvmc_otp_halfword_read ( uint32_t address )

Function for reading a 16-bit aligned halfword from the OTP (UICR)

OTP is a region of the UICR present in some chips. This function must be used to read halfword data from this region since unaligned accesses are not available on the OTP flash area.

Parameters

address Address to read from. Must be halfword-aligned.

Return values

The	contents at `address`.

◆ nrfx_nvmc_page_erase()

int nrfx_nvmc_page_erase ( uint32_t address )

Function for erasing a page in flash.

This function blocks until the erase operation finishes.

Note: Depending on the source of the code being executed, the CPU may be halted during the operation. Refer to the Product Specification for more information.

Parameters

address Address of the first word in the page to erase.

Return values

0	Page erase complete.
-EACCES	Address is not aligned to the size of the page.

◆ nrfx_nvmc_page_partial_erase_continue()

bool nrfx_nvmc_page_partial_erase_continue ( void )

Function for performing a part of the complete page erase (also known as partial erase).

This function must be called several times to erase the whole page, once for each erase part.

Note: The actual time needed to perform each part of the page erase is longer than the partial erase duration specified in the call to nrfx_nvmc_page_partial_erase_init, since the NVMC peripheral needs certain additional amount of time to handle the process. For details regarding this additional time, see the "Electrical specification" section for the NVMC peripheral in the Product Specification.; Using a page that was not completely erased leads to undefined behavior. Depending on the source of the code being executed, the CPU may be halted during the operation. Refer to the Product Specification for more information.

Return values

true	Partial erase finished.
false	Partial erase not finished. Call the function again to process the next part.

◆ nrfx_nvmc_page_partial_erase_init()

int nrfx_nvmc_page_partial_erase_init	(	uint32_t	address,
		uint32_t	duration_ms )

Function for initiating a complete page erase split into parts (also known as partial erase).

This function initiates a partial erase with the specified duration. To execute each part of the partial erase, use nrfx_nvmc_page_partial_erase_continue.

Parameters

address	Address of the first word in the page to erase.
duration_ms	Time in milliseconds that each partial erase will take.

Return values

0	Partial erase started.
-EACCES	Address is not aligned to the size of the page.

See also: nrfx_nvmc_page_partial_erase_continue()

◆ nrfx_nvmc_uicr_erase()

int nrfx_nvmc_uicr_erase ( void )

Function for erasing the user information configuration register (UICR).

Note: Depending on the source of the code being executed, the CPU may be halted during the operation. Refer to the Product Specification for more information.

Return values

0	UICR has been successfully erased.
-ENOTSUP	UICR erase is not supported.

◆ nrfx_nvmc_uicr_word_read()

NRFX_STATIC_INLINE uint32_t nrfx_nvmc_uicr_word_read ( uint32_t const volatile * address )

Function for reading a 32-bit aligned word from the UICR.

This function should be used to read from the UICR since reading the flash main memory area straight after reading the UICR results in undefined behaviour for nRF9160.

Note: See anomaly 7 in the errata document.

Parameters

address Address to read from. Must be word-aligned.

Return values

The	contents at `address`.

◆ nrfx_nvmc_uicr_word_write()

NRFX_STATIC_INLINE void nrfx_nvmc_uicr_word_write	(	uint32_t volatile *	address,
		uint32_t	value )

Function for writing a 32-bit aligned word to the UICR.

This function should be used to write to the UICR since writing the flash main memory area straight after writing the UICR results in undefined behaviour for nRF9160 / nRF9151

Note: See anomaly 7 in the errata document.

Parameters

address	Address to write to. Must be word-aligned.
value	Value to write.

◆ nrfx_nvmc_word_writable_check()

bool nrfx_nvmc_word_writable_check	(	uint32_t	address,
		uint32_t	value )

Function for checking whether a word is writable at the specified address.

The NVMC is only able to write '0' to bits in the Flash that are erased (set to '1'). It cannot rewrite a bit back to '1'. This function checks if the value currently residing at the specified address can be transformed to the desired value without any '0' to '1' transitions.

Parameters

address	Address to be checked. Must be word-aligned.
value	Value to be checked.

Return values

true	Word can be written at the specified address.
false	Word cannot be written at the specified address. Erase page or change address.

◆ nrfx_nvmc_word_write()

void nrfx_nvmc_word_write	(	uint32_t	address,
		uint32_t	value )

Function for writing a 32-bit word to flash.

To determine if the flash write has been completed, use nrfx_nvmc_write_done_check().

Note: Depending on the source of the code being executed, the CPU may be halted during the operation. Refer to the Product Specification for more information.

Parameters

address	Address to write to. Must be word-aligned.
value	Value to write.

◆ nrfx_nvmc_words_write()

void nrfx_nvmc_words_write	(	uint32_t	address,
		void const *	src,
		uint32_t	num_words )

Function for writing consecutive words to flash.

To determine if the last flash write has been completed, use nrfx_nvmc_write_done_check().

Note: Depending on the source of the code being executed, the CPU may be halted during the operation. Refer to the Product Specification for more information.

Parameters

address	Address to write to. Must be word-aligned.
src	Pointer to data to copy from. Must be word-aligned.
num_words	Number of words to write.

◆ nrfx_nvmc_write_done_check()

NRFX_STATIC_INLINE bool nrfx_nvmc_write_done_check ( void )

Function for checking if the last flash write has been completed.

Return values

true	Last write completed successfully.
false	Last write is still in progress.

Functions

Detailed Description

Function Documentation

◆ nrfx_nvmc_all_erase()

◆ nrfx_nvmc_byte_writable_check()

◆ nrfx_nvmc_byte_write()

◆ nrfx_nvmc_bytes_write()

◆ nrfx_nvmc_fits_memory_check()

◆ nrfx_nvmc_fits_uicr_check()

◆ nrfx_nvmc_flash_page_count_get()

◆ nrfx_nvmc_flash_page_size_get()

◆ nrfx_nvmc_flash_size_get()

◆ nrfx_nvmc_halfword_writable_check()

◆ nrfx_nvmc_halfword_write()

◆ nrfx_nvmc_icache_enable()

◆ nrfx_nvmc_otp_halfword_read()

◆ nrfx_nvmc_page_erase()

◆ nrfx_nvmc_page_partial_erase_continue()

◆ nrfx_nvmc_page_partial_erase_init()

◆ nrfx_nvmc_uicr_erase()

◆ nrfx_nvmc_uicr_word_read()

◆ nrfx_nvmc_uicr_word_write()

◆ nrfx_nvmc_word_writable_check()

◆ nrfx_nvmc_word_write()

◆ nrfx_nvmc_words_write()

◆ nrfx_nvmc_write_done_check()