Hardware access layer for managing the MRAM Voltage Regulator. More...
Data Structures | |
struct | nrf_vregmram_atb0_t |
Configuration for Analog Test Bus 0 (ATB0). More... | |
struct | nrf_vregmram_atb1_t |
Configuration for Analog Test Bus 1 (ATB1). More... | |
struct | nrf_vregmram_tcfg_t |
Configuration for Test mode. More... | |
Functions | |
NRF_STATIC_INLINE void | nrf_vregmram_task_trigger (NRF_VREGMRAM_Type *p_reg, nrf_vregmram_task_t task) |
Function for triggering an VREGMRAM task. | |
NRF_STATIC_INLINE uint32_t | nrf_vregmram_task_address_get (NRF_VREGMRAM_Type const *p_reg, nrf_vregmram_task_t task) |
Function for returning the address of the specified VREGMRAM task register. | |
NRF_STATIC_INLINE void | nrf_vregmram_event_clear (NRF_VREGMRAM_Type *p_reg, nrf_vregmram_event_t event) |
Function for clearing the specified VREGMRAM event. | |
NRF_STATIC_INLINE bool | nrf_vregmram_event_check (NRF_VREGMRAM_Type const *p_reg, nrf_vregmram_event_t event) |
Function for retrieving the state of the VREGMRAM event. | |
NRF_STATIC_INLINE uint32_t | nrf_vregmram_event_address_get (NRF_VREGMRAM_Type const *p_reg, nrf_vregmram_event_t event) |
Function for returning the address of the specified VREGMRAM event register. | |
NRF_STATIC_INLINE void | nrf_vregmram_int_enable (NRF_VREGMRAM_Type *p_reg, uint32_t mask) |
Function for enabling specified interrupts. | |
NRF_STATIC_INLINE void | nrf_vregmram_int_disable (NRF_VREGMRAM_Type *p_reg, uint32_t mask) |
Function for disabling specified interrupts. | |
NRF_STATIC_INLINE uint32_t | nrf_vregmram_int_enable_check (NRF_VREGMRAM_Type const *p_reg, uint32_t mask) |
Function for checking if the specified interrupts are enabled. | |
NRF_STATIC_INLINE uint32_t | nrf_vregmram_int_pending_get (NRF_VREGMRAM_Type const *p_reg) |
Function for retrieving the state of pending interrupts. | |
NRF_STATIC_INLINE uint32_t | nrf_vregmram_statusana_get (NRF_VREGMRAM_Type const *p_reg) |
Function for getting VREGMRAM status of the analog module output signals. | |
NRF_STATIC_INLINE void | nrf_vregmram_trim_vbg_set (NRF_VREGMRAM_Type *p_reg, uint8_t val) |
Function for setting voltage reference trimming. | |
NRF_STATIC_INLINE uint8_t | nrf_vregmram_trim_vbg_get (NRF_VREGMRAM_Type const *p_reg) |
Function for getting current reference trimming. | |
NRF_STATIC_INLINE void | nrf_vregmram_trim_bias_set (NRF_VREGMRAM_Type *p_reg, nrf_vregmram_trim_bias_t val) |
Function for setting bias trimming. | |
NRF_STATIC_INLINE nrf_vregmram_trim_bias_t | nrf_vregmram_trim_bias_get (NRF_VREGMRAM_Type const *p_reg) |
Function for getting bias trimming. | |
NRF_STATIC_INLINE void | nrf_vregmram_trim_vpr_set (NRF_VREGMRAM_Type *p_reg, uint8_t val) |
Function for setting VPR reference voltage offset trimming. | |
NRF_STATIC_INLINE uint8_t | nrf_vregmram_trim_vpr_get (NRF_VREGMRAM_Type const *p_reg) |
Function for getting VPR reference voltage offset trimming. | |
NRF_STATIC_INLINE void | nrf_vregmram_trim_vref_set (NRF_VREGMRAM_Type *p_reg, uint8_t val) |
Function for setting VREF reference voltage offset trimming. | |
NRF_STATIC_INLINE uint8_t | nrf_vregmram_trim_vref_get (NRF_VREGMRAM_Type const *p_reg) |
Function for getting VREF reference voltage offset trimming. | |
NRF_STATIC_INLINE void | nrf_vregmram_mirror_lock (NRF_VREGMRAM_Type *p_reg, bool lock) |
Function for locking mirrored registers. | |
NRF_STATIC_INLINE void | nrf_vregmram_vprbleed_set (NRF_VREGMRAM_Type *p_reg, bool vpr_bleed) |
Function for setting VPR output load current. | |
NRF_STATIC_INLINE bool | nrf_vregmram_vprbleed_get (NRF_VREGMRAM_Type const *p_reg) |
Function for getting VPR output load current. | |
NRF_STATIC_INLINE void | nrf_vregmram_adaptive_bias_set (NRF_VREGMRAM_Type *p_reg, nrf_vregmram_adaptive_bias_t adaptive_bias, bool enable) |
Function for setting adaptive bias. | |
NRF_STATIC_INLINE bool | nrf_vregmram_adaptive_bias_check (NRF_VREGMRAM_Type const *p_reg, nrf_vregmram_adaptive_bias_t adaptive_bias) |
Function for checking adaptive bias. | |
NRF_STATIC_INLINE void | nrf_vregmram_mode_set (NRF_VREGMRAM_Type *p_reg, nrf_vregmram_mode_t mode) |
Function for setting MRAM voltage regulator mode. | |
NRF_STATIC_INLINE nrf_vregmram_mode_t | nrf_vregmram_mode_get (NRF_VREGMRAM_Type const *p_reg) |
Function for getting MRAM voltage regulator mode. | |
NRF_STATIC_INLINE void | nrf_vregmram_override (NRF_VREGMRAM_Type *p_reg, nrf_vregmram_analog_signal_t signal, bool enable, uint8_t val) |
Function for override signal to the analog module. | |
NRF_STATIC_INLINE void | nrf_vregmram_dft_atb0_config_set (NRF_VREGMRAM_Type *p_reg, nrf_vregmram_atb0_t config) |
Function for configuring Analog Test Bus 0 (ATB0). | |
NRF_STATIC_INLINE void | nrf_vregmram_dft_atb1_config_set (NRF_VREGMRAM_Type *p_reg, nrf_vregmram_atb1_t config) |
Function for configuring Analog Test Bus 1 (ATB1). | |
NRF_STATIC_INLINE void | nrf_vregmram_dft_tcfg_config_set (NRF_VREGMRAM_Type *p_reg, nrf_vregmram_tcfg_t config) |
Function for configuring Test Mode. | |
Hardware access layer for managing the MRAM Voltage Regulator.
enum nrf_vregmram_event_t |
enum nrf_vregmram_mode_t |
enum nrf_vregmram_task_t |
NRF_STATIC_INLINE bool nrf_vregmram_adaptive_bias_check | ( | NRF_VREGMRAM_Type const * | p_reg, |
nrf_vregmram_adaptive_bias_t | adaptive_bias | ||
) |
Function for checking adaptive bias.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | adaptive_bias | Adaptive bias voltage target. |
true | Adaptive bias is enabled. |
false | Adaptive bias is disabled. |
NRF_STATIC_INLINE void nrf_vregmram_adaptive_bias_set | ( | NRF_VREGMRAM_Type * | p_reg, |
nrf_vregmram_adaptive_bias_t | adaptive_bias, | ||
bool | enable | ||
) |
Function for setting adaptive bias.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | adaptive_bias | Adaptive bias voltage target. |
[in] | enable | True to enable adaptive bias and false to disable. |
NRF_STATIC_INLINE void nrf_vregmram_dft_atb0_config_set | ( | NRF_VREGMRAM_Type * | p_reg, |
nrf_vregmram_atb0_t | config | ||
) |
Function for configuring Analog Test Bus 0 (ATB0).
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | config | Analog Test Bus 0 configuration. |
NRF_STATIC_INLINE void nrf_vregmram_dft_atb1_config_set | ( | NRF_VREGMRAM_Type * | p_reg, |
nrf_vregmram_atb1_t | config | ||
) |
Function for configuring Analog Test Bus 1 (ATB1).
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | config | Analog Test Bus 1 configuration. |
NRF_STATIC_INLINE void nrf_vregmram_dft_tcfg_config_set | ( | NRF_VREGMRAM_Type * | p_reg, |
nrf_vregmram_tcfg_t | config | ||
) |
Function for configuring Test Mode.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | config | Test Mode configuration. |
NRF_STATIC_INLINE uint32_t nrf_vregmram_event_address_get | ( | NRF_VREGMRAM_Type const * | p_reg, |
nrf_vregmram_event_t | event | ||
) |
Function for returning the address of the specified VREGMRAM event register.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | event | The specified event. |
NRF_STATIC_INLINE bool nrf_vregmram_event_check | ( | NRF_VREGMRAM_Type const * | p_reg, |
nrf_vregmram_event_t | event | ||
) |
Function for retrieving the state of the VREGMRAM event.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | event | Event to be checked. |
true | The event has been generated. |
false | The event has not been generated. |
NRF_STATIC_INLINE void nrf_vregmram_event_clear | ( | NRF_VREGMRAM_Type * | p_reg, |
nrf_vregmram_event_t | event | ||
) |
Function for clearing the specified VREGMRAM event.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | event | Event to be cleared. |
NRF_STATIC_INLINE void nrf_vregmram_int_disable | ( | NRF_VREGMRAM_Type * | p_reg, |
uint32_t | mask | ||
) |
Function for disabling specified interrupts.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | mask | Mask of interrupts to be disabled. Use nrf_vregmram_int_mask_t values for bit masking. |
NRF_STATIC_INLINE void nrf_vregmram_int_enable | ( | NRF_VREGMRAM_Type * | p_reg, |
uint32_t | mask | ||
) |
Function for enabling specified interrupts.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | mask | Mask of interrupts to be enabled. Use nrf_vregmram_int_mask_t values for bit masking. |
NRF_STATIC_INLINE uint32_t nrf_vregmram_int_enable_check | ( | NRF_VREGMRAM_Type const * | p_reg, |
uint32_t | mask | ||
) |
Function for checking if the specified interrupts are enabled.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | mask | Mask of interrupts to be checked. Use nrf_vregmram_int_mask_t values for bit masking. |
NRF_STATIC_INLINE uint32_t nrf_vregmram_int_pending_get | ( | NRF_VREGMRAM_Type const * | p_reg | ) |
Function for retrieving the state of pending interrupts.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE void nrf_vregmram_mirror_lock | ( | NRF_VREGMRAM_Type * | p_reg, |
bool | lock | ||
) |
Function for locking mirrored registers.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | lock | When true lock is enabled. When false lock is disabled and mirrored registers can be updated at any time. |
NRF_STATIC_INLINE nrf_vregmram_mode_t nrf_vregmram_mode_get | ( | NRF_VREGMRAM_Type const * | p_reg | ) |
Function for getting MRAM voltage regulator mode.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE void nrf_vregmram_mode_set | ( | NRF_VREGMRAM_Type * | p_reg, |
nrf_vregmram_mode_t | mode | ||
) |
Function for setting MRAM voltage regulator mode.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | mode | Mode. |
NRF_STATIC_INLINE void nrf_vregmram_override | ( | NRF_VREGMRAM_Type * | p_reg, |
nrf_vregmram_analog_signal_t | signal, | ||
bool | enable, | ||
uint8_t | val | ||
) |
Function for override signal to the analog module.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | signal | Signal to be overridden. |
[in] | enable | True to enable override and false to disable. |
[in] | val | Override value. |
NRF_STATIC_INLINE uint32_t nrf_vregmram_statusana_get | ( | NRF_VREGMRAM_Type const * | p_reg | ) |
Function for getting VREGMRAM status of the analog module output signals.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE uint32_t nrf_vregmram_task_address_get | ( | NRF_VREGMRAM_Type const * | p_reg, |
nrf_vregmram_task_t | task | ||
) |
Function for returning the address of the specified VREGMRAM task register.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | task | Task. |
NRF_STATIC_INLINE void nrf_vregmram_task_trigger | ( | NRF_VREGMRAM_Type * | p_reg, |
nrf_vregmram_task_t | task | ||
) |
Function for triggering an VREGMRAM task.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | task | Task. |
NRF_STATIC_INLINE nrf_vregmram_trim_bias_t nrf_vregmram_trim_bias_get | ( | NRF_VREGMRAM_Type const * | p_reg | ) |
Function for getting bias trimming.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE void nrf_vregmram_trim_bias_set | ( | NRF_VREGMRAM_Type * | p_reg, |
nrf_vregmram_trim_bias_t | val | ||
) |
Function for setting bias trimming.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | val | Bias trimming value. |
NRF_STATIC_INLINE uint8_t nrf_vregmram_trim_vbg_get | ( | NRF_VREGMRAM_Type const * | p_reg | ) |
Function for getting current reference trimming.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE void nrf_vregmram_trim_vbg_set | ( | NRF_VREGMRAM_Type * | p_reg, |
uint8_t | val | ||
) |
Function for setting voltage reference trimming.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | val | Voltage reference trimming value. The value is 1.433V - 9.75mV steps. |
NRF_STATIC_INLINE uint8_t nrf_vregmram_trim_vpr_get | ( | NRF_VREGMRAM_Type const * | p_reg | ) |
Function for getting VPR reference voltage offset trimming.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE void nrf_vregmram_trim_vpr_set | ( | NRF_VREGMRAM_Type * | p_reg, |
uint8_t | val | ||
) |
Function for setting VPR reference voltage offset trimming.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | val | Voltage offset trimming value. The value is 1.174V + 4.75mV steps. |
NRF_STATIC_INLINE uint8_t nrf_vregmram_trim_vref_get | ( | NRF_VREGMRAM_Type const * | p_reg | ) |
Function for getting VREF reference voltage offset trimming.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
NRF_STATIC_INLINE void nrf_vregmram_trim_vref_set | ( | NRF_VREGMRAM_Type * | p_reg, |
uint8_t | val | ||
) |
Function for setting VREF reference voltage offset trimming.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | val | Voltage offset trimming value. The value is 0.582V + 2.375mV steps. |
NRF_STATIC_INLINE bool nrf_vregmram_vprbleed_get | ( | NRF_VREGMRAM_Type const * | p_reg | ) |
Function for getting VPR output load current.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
true | VPR output load current is enabled. |
false | VPR output load current is disabled. |
NRF_STATIC_INLINE void nrf_vregmram_vprbleed_set | ( | NRF_VREGMRAM_Type * | p_reg, |
bool | vpr_bleed | ||
) |
Function for setting VPR output load current.
[in] | p_reg | Pointer to the structure of registers of the peripheral. |
[in] | vpr_bleed | When true VPR output load current is enabled. When false VPR output load current is disabled. |