MRAMC driver

Magnetoresistive Random Access Memory Controller (MRAMC) peripheral driver. More...

Data Structures
struct	nrfx_mramc_config_t
	Configuration structure of the MRAMC driver instance. More...

Macros
#define	NRFX_MRAMC_MAP_TO_ADDR(offset)
	Macro for mapping relative MRAMC offset to absolute address.
#define	NRFX_MRAMC_DEFAULT_CONFIG()
	MRAMC driver default configuration.

Typedefs
typedef void(*	nrfx_mramc_evt_handler_t) (nrf_mramc_event_t const event_type)
	MRAMC driver event handler type.

Functions
bool	nrfx_mramc_valid_address_check (uint32_t addr, bool uicr_allowed)
	Function for checking if the address is valid.
bool	nrfx_mramc_fits_memory_check (uint32_t addr, bool uicr_allowed, uint32_t bytes)
	Function for checking if the address and size fit in MRAM memory.
void	nrfx_mramc_all_erase (void)
	Function for erasing the whole MRAM memory.
void	nrfx_mramc_word_write (uint32_t address, uint32_t value)
	Function for writing a 32-bit word to MRAM.
void	nrfx_mramc_words_write (uint32_t address, void const *src, uint32_t num_words)
	Function for writing consecutive 32-bit words to MRAM.
void	nrfx_mramc_buffer_read (void *dst, uint32_t address, uint32_t num_bytes)
	Function for reading consecutive bytes from MRAM.
void	nrfx_mramc_config_write_mode_set (nrf_mramc_mode_write_t write_mode)
	Function for setting the MRAMC write mode.
void	nrfx_mramc_config_erase_mode_set (nrf_mramc_mode_erase_t erase_mode)
	Function for setting the MRAMC erase mode.
void	nrfx_mramc_confignvr_perm_set (bool enable, uint8_t page)
	Function for setting the MRAMC NVR page write and erase permission,.
int	nrfx_mramc_init (nrfx_mramc_config_t const *p_config, nrfx_mramc_evt_handler_t handler)
	Function for initializing the MRAMC driver instance.
int	nrfx_mramc_reconfigure (nrfx_mramc_config_t const *p_config)
	Function for reconfiguring the MRAMC driver instance.
void	nrfx_mramc_uninit (void)
	Function for uninitializing the MRAMC driver instance.
uint32_t	nrfx_mramc_memory_size_get (void)
	Function for getting the total MRAM size in bytes.
void	nrfx_mramc_area_erase (uint32_t address, uint32_t size)
	Function for erasing MRAM area in given MRAM words size.
void	nrfx_mramc_erase (uint32_t address, uint32_t num_words)
	Function for erasing MRAM area in given 32-bit words size.
NRFX_STATIC_INLINE uint32_t	nrfx_mramc_word_read (uint32_t address)
	Function for reading a 32-bit word from the MRAM.
NRFX_STATIC_INLINE bool	nrfx_mramc_ready_check (void)
	Function for checking current MRAMC operation status.
NRFX_STATIC_INLINE uint32_t	nrfx_mramc_otp_word_read (uint32_t index)
	Function for reading a word from the OTP in UICR.
NRFX_STATIC_INLINE bool	nrfx_mramc_otp_word_write (uint32_t index, uint32_t value)
	Function for writing a 32-bit word at index position to OTP region in UICR.

Detailed Description

Magnetoresistive Random Access Memory Controller (MRAMC) peripheral driver.

Macro Definition Documentation

NRFX_MRAMC_DEFAULT_CONFIG

#define NRFX_MRAMC_DEFAULT_CONFIG

(

)

Value:

{                                                                     \
    .config                 = {                                       \
        .mode_write         = NRF_MRAMC_MODE_WRITE_DISABLE,           \
        .mode_erase         = NRF_MRAMC_MODE_ERASE_DISABLE,           \
        NRFX_COND_CODE_1(NRF_MRAMC_HAS_CONFIG_DISABLEECC,             \
             (.disable_ecc = false,), ())                             \
        NRFX_COND_CODE_1(NRF_MRAMC_HAS_CONFIG_ENABLEECCBUSFAULT,      \
             (.enable_ecc_bus_fault = false,), ())                    \
    },                                                                \
    .preload_timeout        = {                                       \
        .value              = NRF_MRAMC_READYNEXTTIMEOUT_DEFAULT,     \
        .direct_write       = true,                                   \
    },                                                                \
    .powerdown              = {                                       \
        .enable             = false,                                  \
        .power_down_cfg     = false,                                  \
        .timeout_value      = NRF_MRAMC_AUTOPOWERDOWN_TIMEOUT_MIN,    \
    },                                                                \
    .lowavgcurr            = {                                        \
        .read               = NRF_MRAMC_LOWAVGCURR_READ_MIN,          \
        .write              = NRF_MRAMC_LOWAVGCURR_WRITE_MIN,         \
        .erase              = NRF_MRAMC_LOWAVGCURR_ERASE_MIN,         \
    },                                                                \
    .irq_priority           = NRFX_MRAMC_DEFAULT_CONFIG_IRQ_PRIORITY, \
}

MRAMC driver default configuration.

This configuration sets up MRAMC with the following options:

• Write mode disabled
• Erase mode disabled
• ECC enabled (if present)
• Bus fault on ECC error disabled (if present)
• Preload timeout value: 0x0
• Write to the MRAM backed-to-backed on the next preload timeout in direct mode enabled
• Automatic power-down feature disabled
• Entering power-down mode when the timeout happens disabled
• Access timeout: 0x0
• Low average current read, write, and erase preload timeout values: 0x0

NRFX_MRAMC_MAP_TO_ADDR

#define NRFX_MRAMC_MAP_TO_ADDR

(

offset

)

Value:

(NRFY_MRAMC_MRAM_BASE_ADDRESS + (offset))

Macro for mapping relative MRAMC offset to absolute address.

Parameters

[in]

offset

Offset to map.

Typedef Documentation

nrfx_mramc_evt_handler_t

typedef void(* nrfx_mramc_evt_handler_t) (nrf_mramc_event_t const event_type)

MRAMC driver event handler type.

Parameters

[in]

event_type

MRAMC event.

Function Documentation

nrfx_mramc_all_erase()

void nrfx_mramc_all_erase

(

void

)

Function for erasing the whole MRAM memory.

Note

All user code and UICR will be erased.

nrfx_mramc_area_erase()

void nrfx_mramc_area_erase	(	uint32_t	address,
		uint32_t	size )

Function for erasing MRAM area in given MRAM words size.

Deprecated

Use nrfx_mramc_erase instead.

Parameters

[in]	address	Address to be erased.
[in]	size	Size to erase per number of NRF_MRAMC_BUS_SIZE in bytes.

nrfx_mramc_buffer_read()

void nrfx_mramc_buffer_read	(	void *	dst,
		uint32_t	address,
		uint32_t	num_bytes )

Function for reading consecutive bytes from MRAM.

Parameters

[out]	dst	Pointer to the buffer to store the data.
[in]	address	Address of the first byte to be read. Must be word-aligned.
[in]	num_bytes	Number of bytes to be read.

nrfx_mramc_config_erase_mode_set()

void nrfx_mramc_config_erase_mode_set

(

nrf_mramc_mode_erase_t

erase_mode

)

Function for setting the MRAMC erase mode.

Parameters

[in]

erase_mode

One of the enum in nrf_mramc_mode_erase_t.

nrfx_mramc_config_write_mode_set()

void nrfx_mramc_config_write_mode_set

(

nrf_mramc_mode_write_t

write_mode

)

Function for setting the MRAMC write mode.

Parameters

[in]

write_mode

One of the enum in nrf_mramc_mode_write_t.

nrfx_mramc_confignvr_perm_set()

void nrfx_mramc_confignvr_perm_set	(	bool	enable,
		uint8_t	page )

Function for setting the MRAMC NVR page write and erase permission,.

Note

: Setting enable allows nrf_mramc_readynext_timeout_t diret_write and preload_timeout to minimum, nrf_mramc_config_nvr_t PAGE[n] to be writtable and erasable.

Parameters

[in]	enable	True to enable write and erase permission of CONFIGNVR.PAGE[n], false to disable.
[in]	page	Page number of CONFIGNVR.PAGE[0...n].

nrfx_mramc_erase()

void nrfx_mramc_erase	(	uint32_t	address,
		uint32_t	num_words )

Function for erasing MRAM area in given 32-bit words size.

Parameters

[in]	address	Address to be erased.
[in]	num_words	Number of 32-bit words to be erased.

nrfx_mramc_fits_memory_check()

bool nrfx_mramc_fits_memory_check	(	uint32_t	addr,
		bool	uicr_allowed,
		uint32_t	bytes )

Function for checking if the address and size fit in MRAM memory.

Parameters

[in]	addr	Address to be checked.
[in]	uicr_allowed	If true, the UICR area is considered valid.
[in]	bytes	Number of bytes to be checked.

Return values

true	Address and size fit in memory.
false	Address and size not fitting in memory.

nrfx_mramc_init()

int nrfx_mramc_init	(	nrfx_mramc_config_t const *	p_config,
		nrfx_mramc_evt_handler_t	handler )

Function for initializing the MRAMC driver instance.

Parameters

[in]	p_config	Pointer to the structure containing configuration.
[in]	handler	Event handler provided by the user.

Return values

0	Initialization was successful.
-EALREADY	The driver has already been initialized.

nrfx_mramc_memory_size_get()

uint32_t nrfx_mramc_memory_size_get

(

void

)

Function for getting the total MRAM size in bytes.

Note

The function will return FICR_INFO_MRAM_MRAM_Unspecified value if the total MRAM size cannot be determined based on the FICR data.

Returns

MRAM total size in bytes.

nrfx_mramc_otp_word_read()

NRFX_STATIC_INLINE uint32_t nrfx_mramc_otp_word_read

(

uint32_t

index

)

Function for reading a word from the OTP in UICR.

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

Parameters

[in]

index

Address (index) in OTP table from which a word is to be read.

Return values

The	contents at index.

nrfx_mramc_otp_word_write()

NRFX_STATIC_INLINE bool nrfx_mramc_otp_word_write	(	uint32_t	index,
		uint32_t	value )

Function for writing a 32-bit word at index position to OTP region in UICR.

The OTP can only be written once after each Erase All is performed. This function checks if the value currently residing at the specified index can be transformed to the desired value. If yes, then performs the write operation.

Parameters

[in]	index	Address (index) in OTP table to which a word it to be written.
[in]	value	Value to be written.

Return values

true	Word can be written into the specified OTP index address.
false	Word cannot be written into the specified OTP index address. Erase UICR or change index address.

nrfx_mramc_ready_check()

NRFX_STATIC_INLINE bool nrfx_mramc_ready_check

(

void

)

Function for checking current MRAMC operation status.

The status is updated for all MRAMC operations.

Return values

true	Current operation is completed, and MRAMC is ready.
false	MRAMC is busy.

nrfx_mramc_reconfigure()

int nrfx_mramc_reconfigure

(

nrfx_mramc_config_t const *

p_config

)

Function for reconfiguring the MRAMC driver instance.

Parameters

[in]

p_config

Pointer to the structure containing configuration.

Return values

0	Reconfiguration was successful.
-EINPROGRESS	The driver is uninitialized.

nrfx_mramc_valid_address_check()

bool nrfx_mramc_valid_address_check	(	uint32_t	addr,
		bool	uicr_allowed )

Function for checking if the address is valid.

Parameters

[in]	addr	Address to be checked.
[in]	uicr_allowed	If true, the UICR area is considered valid.

Return values

true	Address is valid.
false	Address is invalid.

nrfx_mramc_word_read()

NRFX_STATIC_INLINE uint32_t nrfx_mramc_word_read

(

uint32_t

address

)

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

Use this function in case accessing the MRAM gives the possibility to run the code in an environment where the MRAM is simulated.

Parameters

[in]

address

Address of the word to be read.

Returns

Value read from MRAM.

nrfx_mramc_word_write()

void nrfx_mramc_word_write	(	uint32_t	address,
		uint32_t	value )

Function for writing a 32-bit word to MRAM.

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

[in]	address	Address to where data is to be written. Must be word-aligned.
[in]	value	Value to be written.

nrfx_mramc_words_write()

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

Function for writing consecutive 32-bit words to MRAM.

Function uses direct write mode to write to MRAM directly.

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

[in]	address	Address to where data is to be written. Must be word-aligned.
[in]	src	Pointer to data to be copied. Must be word-aligned.
[in]	num_words	Number of words to be written.