nrfx 3.3
Data Structures | Enumerations | Functions
MRAM Voltage Regulator HAL

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...
 

Enumerations

enum  nrf_vregmram_task_t {
  NRF_VREGMRAM_TASK_PWR_UP = offsetof(NRF_VREGMRAM_Type, TASKS_PWRUP) ,
  NRF_VREGMRAM_TASK_PWR_DOWN = offsetof(NRF_VREGMRAM_Type, TASKS_PWRDOWN)
}
 VREGMRAM tasks. More...
 
enum  nrf_vregmram_event_t { NRF_VREGMRAM_EVENT_READY = offsetof(NRF_VREGMRAM_Type, EVENTS_READY) }
 VREGMRAM events. More...
 
enum  nrf_vregmram_int_mask_t { NRF_VREGMRAM_INT_READY_MASK = VREGMRAM_INTEN_READY_Msk }
 VREGMRAM interrupts. More...
 
enum  nrf_vregmram_statusana_mask_t { NRF_VREGMRAM_STATUSANA_READY_MASK = VREGMRAM_STATUSANA_READY_Msk }
 STATUSANA register bit masks. More...
 
enum  nrf_vregmram_adaptive_bias_t {
  NRF_VREGMRAM_ADAPTIVE_BIAS_VREF ,
  NRF_VREGMRAM_ADAPTIVE_BIAS_VPR
}
 Enum for selecting adaptive bias voltage target. More...
 
enum  nrf_vregmram_mode_t {
  NRF_VREGMRAM_MODE_NORMAL = VREGMRAM_MODE_MODE_Normal ,
  NRF_VREGMRAM_MODE_RETAIN = VREGMRAM_MODE_MODE_Retain
}
 Voltage regulator mode. More...
 
enum  nrf_vregmram_analog_signal_t {
  NRF_VREGMRAM_ANALOG_SIGNAL_PWR_UP ,
  NRF_VREGMRAM_ANALOG_SIGNAL_RETAIN ,
  NRF_VREGMRAM_ANALOG_SIGNAL_MODE
}
 Analog signal to be overridden. More...
 
enum  nrf_vregmram_trim_bias_t {
  NRF_VREGMRAM_TRIM_BIAS_450NA ,
  NRF_VREGMRAM_TRIM_BIAS_530NA ,
  NRF_VREGMRAM_TRIM_BIAS_400NA
}
 Enum for selecting bias trimming value. 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.
 

Detailed Description

Hardware access layer for managing the MRAM Voltage Regulator.

Enumeration Type Documentation

◆ nrf_vregmram_adaptive_bias_t

Enum for selecting adaptive bias voltage target.

Enumerator
NRF_VREGMRAM_ADAPTIVE_BIAS_VREF 

VREF Adaptive bias.

NRF_VREGMRAM_ADAPTIVE_BIAS_VPR 

VPR Adaptive bias.

◆ nrf_vregmram_analog_signal_t

Analog signal to be overridden.

Enumerator
NRF_VREGMRAM_ANALOG_SIGNAL_PWR_UP 

Override PWRUP signal.

NRF_VREGMRAM_ANALOG_SIGNAL_RETAIN 

Override RETAIN signal.

NRF_VREGMRAM_ANALOG_SIGNAL_MODE 

Override MODE signal.

◆ nrf_vregmram_event_t

VREGMRAM events.

Enumerator
NRF_VREGMRAM_EVENT_READY 

Power up done.

◆ nrf_vregmram_int_mask_t

VREGMRAM interrupts.

Enumerator
NRF_VREGMRAM_INT_READY_MASK 

Interrupt on READY.

◆ nrf_vregmram_mode_t

Voltage regulator mode.

Enumerator
NRF_VREGMRAM_MODE_NORMAL 

Normal mode.

NRF_VREGMRAM_MODE_RETAIN 

Retain mode.

◆ nrf_vregmram_statusana_mask_t

STATUSANA register bit masks.

Enumerator
NRF_VREGMRAM_STATUSANA_READY_MASK 

Current value of READY signal.

◆ nrf_vregmram_task_t

VREGMRAM tasks.

Enumerator
NRF_VREGMRAM_TASK_PWR_UP 

Power up the VREF and VPR regulator.

NRF_VREGMRAM_TASK_PWR_DOWN 

Power down the VREF and VPR regulator.

◆ nrf_vregmram_trim_bias_t

Enum for selecting bias trimming value.

Enumerator
NRF_VREGMRAM_TRIM_BIAS_450NA 

Bias trimming is 450nA.

NRF_VREGMRAM_TRIM_BIAS_530NA 

Bias trimming is 530nA.

NRF_VREGMRAM_TRIM_BIAS_400NA 

Bias trimming is 400nA.

Function Documentation

◆ nrf_vregmram_adaptive_bias_check()

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.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]adaptive_biasAdaptive bias voltage target.
Return values
trueAdaptive bias is enabled.
falseAdaptive bias is disabled.

◆ nrf_vregmram_adaptive_bias_set()

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.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]adaptive_biasAdaptive bias voltage target.
[in]enableTrue to enable adaptive bias and false to disable.

◆ nrf_vregmram_dft_atb0_config_set()

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).

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]configAnalog Test Bus 0 configuration.

◆ nrf_vregmram_dft_atb1_config_set()

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).

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]configAnalog Test Bus 1 configuration.

◆ nrf_vregmram_dft_tcfg_config_set()

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.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]configTest Mode configuration.

◆ nrf_vregmram_event_address_get()

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.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventThe specified event.
Returns
Address of specified event register.

◆ nrf_vregmram_event_check()

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.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventEvent to be checked.
Return values
trueThe event has been generated.
falseThe event has not been generated.

◆ nrf_vregmram_event_clear()

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.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]eventEvent to be cleared.

◆ nrf_vregmram_int_disable()

NRF_STATIC_INLINE void nrf_vregmram_int_disable ( NRF_VREGMRAM_Type *  p_reg,
uint32_t  mask 
)

Function for disabling specified interrupts.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskMask of interrupts to be disabled. Use nrf_vregmram_int_mask_t values for bit masking.

◆ nrf_vregmram_int_enable()

NRF_STATIC_INLINE void nrf_vregmram_int_enable ( NRF_VREGMRAM_Type *  p_reg,
uint32_t  mask 
)

Function for enabling specified interrupts.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskMask of interrupts to be enabled. Use nrf_vregmram_int_mask_t values for bit masking.

◆ nrf_vregmram_int_enable_check()

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.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]maskMask of interrupts to be checked. Use nrf_vregmram_int_mask_t values for bit masking.
Returns
Mask of enabled interrupts.

◆ nrf_vregmram_int_pending_get()

NRF_STATIC_INLINE uint32_t nrf_vregmram_int_pending_get ( NRF_VREGMRAM_Type const *  p_reg)

Function for retrieving the state of pending interrupts.

Note
States of pending interrupt are saved as a bitmask. One set at particular position means that interrupt for event is pending.
Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Bitmask with information about pending interrupts. Use nrf_vregmram_int_mask_t values for bit masking.

◆ nrf_vregmram_mirror_lock()

NRF_STATIC_INLINE void nrf_vregmram_mirror_lock ( NRF_VREGMRAM_Type *  p_reg,
bool  lock 
)

Function for locking mirrored registers.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]lockWhen true lock is enabled. When false lock is disabled and mirrored registers can be updated at any time.

◆ nrf_vregmram_mode_get()

NRF_STATIC_INLINE nrf_vregmram_mode_t nrf_vregmram_mode_get ( NRF_VREGMRAM_Type const *  p_reg)

Function for getting MRAM voltage regulator mode.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Mode.

◆ nrf_vregmram_mode_set()

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.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]modeMode.

◆ nrf_vregmram_override()

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.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]signalSignal to be overridden.
[in]enableTrue to enable override and false to disable.
[in]valOverride value.

◆ nrf_vregmram_statusana_get()

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.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The STATUSANA register value. Use nrf_vregmram_statusana_mask_t values for bit masking.

◆ nrf_vregmram_task_address_get()

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.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]taskTask.
Returns
Task address.

◆ nrf_vregmram_task_trigger()

NRF_STATIC_INLINE void nrf_vregmram_task_trigger ( NRF_VREGMRAM_Type *  p_reg,
nrf_vregmram_task_t  task 
)

Function for triggering an VREGMRAM task.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]taskTask.

◆ nrf_vregmram_trim_bias_get()

NRF_STATIC_INLINE nrf_vregmram_trim_bias_t nrf_vregmram_trim_bias_get ( NRF_VREGMRAM_Type const *  p_reg)

Function for getting bias trimming.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Bias trimming value.

◆ nrf_vregmram_trim_bias_set()

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.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]valBias trimming value.

◆ nrf_vregmram_trim_vbg_get()

NRF_STATIC_INLINE uint8_t nrf_vregmram_trim_vbg_get ( NRF_VREGMRAM_Type const *  p_reg)

Function for getting current reference trimming.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Voltage reference trimming value. The value is 1.433V - 9.75mV steps.

◆ nrf_vregmram_trim_vbg_set()

NRF_STATIC_INLINE void nrf_vregmram_trim_vbg_set ( NRF_VREGMRAM_Type *  p_reg,
uint8_t  val 
)

Function for setting voltage reference trimming.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]valVoltage reference trimming value. The value is 1.433V - 9.75mV steps.

◆ nrf_vregmram_trim_vpr_get()

NRF_STATIC_INLINE uint8_t nrf_vregmram_trim_vpr_get ( NRF_VREGMRAM_Type const *  p_reg)

Function for getting VPR reference voltage offset trimming.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Voltage offset trimming value. The value is 1.174V + 4.75mV steps.

◆ nrf_vregmram_trim_vpr_set()

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.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]valVoltage offset trimming value. The value is 1.174V + 4.75mV steps.

◆ nrf_vregmram_trim_vref_get()

NRF_STATIC_INLINE uint8_t nrf_vregmram_trim_vref_get ( NRF_VREGMRAM_Type const *  p_reg)

Function for getting VREF reference voltage offset trimming.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Voltage offset trimming value. The value is 0.582V + 2.375mV steps.

◆ nrf_vregmram_trim_vref_set()

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.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]valVoltage offset trimming value. The value is 0.582V + 2.375mV steps.

◆ nrf_vregmram_vprbleed_get()

NRF_STATIC_INLINE bool nrf_vregmram_vprbleed_get ( NRF_VREGMRAM_Type const *  p_reg)

Function for getting VPR output load current.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Return values
trueVPR output load current is enabled.
falseVPR output load current is disabled.

◆ nrf_vregmram_vprbleed_set()

NRF_STATIC_INLINE void nrf_vregmram_vprbleed_set ( NRF_VREGMRAM_Type *  p_reg,
bool  vpr_bleed 
)

Function for setting VPR output load current.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]vpr_bleedWhen true VPR output load current is enabled. When false VPR output load current is disabled.

Documentation feedback | Developer Zone | Subscribe | Updated