nrfx 3.3
Data Structures | Macros | Enumerations | Functions
Always-on 0.8V Voltage Regulator HAL

Hardware access layer for managing the Always-on 0.8V Voltage Regulator (VREGAO0V8). More...

Data Structures

struct  nrf_vregao0v8_config_static_t
 Fields for static configuration structure. More...
 
struct  nrf_vregao0v8_config_dynamic_t
 Dynamic configuration. Current limit configuration for the voltage regulator. More...
 
struct  nrf_vregao0v8_tcfg_t
 Test mode configuration. More...
 

Macros

#define NRF_VREGAO0V8_HAS_DFT_ATB0_SELMUX_VDD_SW_1V8   1
 Symbol indicating whether setting the VDD_SW_1V8 voltage reference for Analog Test Bus 0 multiplexer is available.
 
#define NRF_VREGAO0V8_HAS_DFT_ATB0_SELMUX_IBPSR_8UA   1
 Symbol indicating whether setting the internal 8uA current reference for Analog Test Bus 0 multiplexer is available.
 
#define NRF_VREGAO0V8_HAS_DFT_DTB0_SELMUX_SPARE0   1
 Symbol indicating whether selecting SPARE0 multiplexer input for Digital Test Bus 0 is available.
 
#define NRF_VREGAO0V8_HAS_DFT_DTB0_SELMUX_SPARE1   1
 Symbol indicating whether selecting SPARE1 multiplexer input for Digital Test Bus 0 is available.
 
#define NRF_VREGAO0V8_HAS_DFT_DTB0_SELMUX_PWRUP_IBPSR   1
 Symbol indicating whether setting the internal 4uA current reference powerup for Digital Test Bus 0 multiplexer is available.
 
#define NRF_VREGAO0V8_HAS_DFT_DTB0_SELMUX_PWRUP_CORE_HP   1
 Symbol indicating whether setting the high power core powerup signal for Digital Test Bus 0 multiplexer is available.
 

Enumerations

enum  nrf_vregao0v8_event_t {
  NRF_VREGAO0V8_EVENT_READY = offsetof(NRF_VREGAO0V8_Type, EVENTS_READY) ,
  NRF_VREGAO0V8_EVENT_SETTLED = offsetof(NRF_VREGAO0V8_Type, EVENTS_SETTLED) ,
  NRF_VREGAO0V8_EVENT_BPREADY = offsetof(NRF_VREGAO0V8_Type, EVENTS_BPREADY) ,
  NRF_VREGAO0V8_EVENT_IOUT_CMP_HP = offsetof(NRF_VREGAO0V8_Type, EVENTS_IOUTCMPHP) ,
  NRF_VREGAO0V8_EVENT_IOUT_CMP_LP = offsetof(NRF_VREGAO0V8_Type, EVENTS_IOUTCMPLP) ,
  NRF_VREGAO0V8_EVENT_LP2HP = offsetof(NRF_VREGAO0V8_Type, EVENTS_LP2HP) ,
  NRF_VREGAO0V8_EVENT_HP2LP = offsetof(NRF_VREGAO0V8_Type, EVENTS_HP2LP)
}
 VREGAO0V8 events. More...
 
enum  nrf_vregao0v8_int_mask_t {
  NRF_VREGAO0V8_INT_READY_MASK = VREGAO0V8_INTEN_READY_Msk ,
  NRF_VREGAO0V8_INT_SETTLED_MASK = VREGAO0V8_INTEN_SETTLED_Msk ,
  NRF_VREGAO0V8_INT_BPREADY_MASK = VREGAO0V8_INTEN_BPREADY_Msk ,
  NRF_VREGAO0V8_INT_IOUT_CMP_HP_MASK = VREGAO0V8_INTEN_IOUTCMPHP_Msk ,
  NRF_VREGAO0V8_INT_IOUT_CMP_LP_MASK = VREGAO0V8_INTEN_IOUTCMPLP_Msk ,
  NRF_VREGAO0V8_INT_LP2HP_MASK = VREGAO0V8_INTEN_LP2HP_Msk ,
  NRF_VREGAO0V8_INT_HP2LP_MASK = VREGAO0V8_INTEN_HP2LP_Msk
}
 VREGAO0V8 interrupts. More...
 
enum  nrf_vregao0v8_status_t {
  NRF_VREGAO0V8_STATUS_HIGH_POWER = VREGAO0V8_STATUS_MODE_HighPower ,
  NRF_VREGAO0V8_STATUS_LOW_POWER = VREGAO0V8_STATUS_MODE_LowPower ,
  NRF_VREGAO0V8_STATUS_ULP_REFRESH = VREGAO0V8_STATUS_MODE_UltraLowPowerRefresh ,
  NRF_VREGAO0V8_STATUS_BYPASS = VREGAO0V8_STATUS_MODE_Bypass
}
 STATUS register states. More...
 
enum  nrf_vregao0v8_statusana_mask_t {
  NRF_VREGAO0V8_STATUSANA_READY_MASK = VREGAO0V8_STATUSANA_READY_Msk ,
  NRF_VREGAO0V8_STATUSANA_SETTLED_MASK = VREGAO0V8_STATUSANA_SETTLED_Msk ,
  NRF_VREGAO0V8_STATUSANA_BPREADY_MASK = VREGAO0V8_STATUSANA_BPREADY_Msk ,
  NRF_VREGAO0V8_STATUSANA_IOUT_CMP_HP_MASK = VREGAO0V8_STATUSANA_IOUTCMPHP_Msk ,
  NRF_VREGAO0V8_STATUSANA_IOUT_CMP_LP_MASK = VREGAO0V8_STATUSANA_IOUTCMPLP_Msk
}
 STATUSANA register bit masks. More...
 
enum  nrf_vregao0v8_trim_ulp_t {
  NRF_VREGAO0V8_TRIM_ULP_5MV = VREGAO0V8_TRIM_ULTRALOWPOWER_VAL_5mV ,
  NRF_VREGAO0V8_TRIM_ULP_15MV = VREGAO0V8_TRIM_ULTRALOWPOWER_VAL_15mV ,
  NRF_VREGAO0V8_TRIM_ULP_25MV = VREGAO0V8_TRIM_ULTRALOWPOWER_VAL_25mV ,
  NRF_VREGAO0V8_TRIM_ULP_35MV = VREGAO0V8_TRIM_ULTRALOWPOWER_VAL_35mV
}
 Values for ultra low power mode ripple trimming. More...
 
enum  nrf_vregao0v8_mode_t {
  NRF_VREGAO0V8_MODE_AUTO = VREGAO0V8_MODE_MODE_Auto ,
  NRF_VREGAO0V8_MODE_HIGH_POWER = VREGAO0V8_MODE_MODE_HighPower ,
  NRF_VREGAO0V8_MODE_LOW_POWER = VREGAO0V8_MODE_MODE_LowPower ,
  NRF_VREGAO0V8_MODE_ULP_REFRESH = VREGAO0V8_MODE_MODE_UltraLowPowerRefresh ,
  NRF_VREGAO0V8_MODE_BYPASS = VREGAO0V8_MODE_MODE_Bypass
}
 Voltage regulator mode. More...
 
enum  nrf_vregao0v8_analog_signal_t {
  NRF_VREGAO0V8_ANALOG_SIGNAL_PWRUP ,
  NRF_VREGAO0V8_ANALOG_SIGNAL_RETAIN ,
  NRF_VREGAO0V8_ANALOG_SIGNAL_MODE_LP ,
  NRF_VREGAO0V8_ANALOG_SIGNAL_MODE_ULPR ,
  NRF_VREGAO0V8_ANALOG_SIGNAL_REQ_BYPASS ,
  NRF_VREGAO0V8_ANALOG_SIGNAL_READY ,
  NRF_VREGAO0V8_ANALOG_SIGNAL_SETTLED ,
  NRF_VREGAO0V8_ANALOG_SIGNAL_BPREADY ,
  NRF_VREGAO0V8_ANALOG_SIGNAL_IOUT_CMP_HP ,
  NRF_VREGAO0V8_ANALOG_SIGNAL_IOUT_CMP_LP
}
 Analog signal to be overridden. More...
 
enum  nrf_vregao0v8_dft_atb0_selmux_t {
  NRF_VREGAO0V8_DFT_ATB0_SELMUX_EXT_VREF = VREGAO0V8_DFT_ATB0CONFIG_SELMUX_ExtVref ,
  NRF_VREGAO0V8_DFT_ATB0_SELMUX_VDD_SW_1V8 = VREGAO0V8_DFT_ATB0CONFIG_SELMUX_VddSw1v8 ,
  NRF_VREGAO0V8_DFT_ATB0_SELMUX_IBPSR_8UA = VREGAO0V8_DFT_ATB0CONFIG_SELMUX_Ibpsr8u ,
  NRF_VREGAO0V8_DFT_ATB0_SELMUX_IBPP_50NA = VREGAO0V8_DFT_ATB0CONFIG_SELMUX_Ibpp50n ,
  NRF_VREGAO0V8_DFT_ATB0_SELMUX_VSS = VREGAO0V8_DFT_ATB0CONFIG_SELMUX_VSS
}
 Select multiplexer for ATB0. More...
 
enum  nrf_vregao0v8_dft_atb1_selmux_t {
  NRF_VREGAO0V8_DFT_ATB1_SELMUX_VREF_HP = VREGAO0V8_DFT_ATB1CONFIG_SELMUX_VrefHP ,
  NRF_VREGAO0V8_DFT_ATB1_SELMUX_VREF_0V9_DVT = VREGAO0V8_DFT_ATB1CONFIG_SELMUX_Vref0V9Dvt ,
  NRF_VREGAO0V8_DFT_ATB1_SELMUX_VREF_LP = VREGAO0V8_DFT_ATB1CONFIG_SELMUX_VrefLp ,
  NRF_VREGAO0V8_DFT_ATB1_SELMUX_VFP = VREGAO0V8_DFT_ATB1CONFIG_SELMUX_Vfb
}
 Select multiplexer for ATB1. More...
 
enum  nrf_vregao0v8_dft_dtb0_selmux_t {
  NRF_VREGAO0V8_DFT_DTB0_SELMUX_ICMP_HP = VREGAO0V8_DFT_DTB0CONFIG_SELMUX_IcmpHp ,
  NRF_VREGAO0V8_DFT_DTB0_SELMUX_MBIAS_IBPSR_SETTLED = VREGAO0V8_DFT_DTB0CONFIG_SELMUX_MbiasIbpsrSettled ,
  NRF_VREGAO0V8_DFT_DTB0_SELMUX_MODE_LP = VREGAO0V8_DFT_DTB0CONFIG_SELMUX_ModeLp ,
  NRF_VREGAO0V8_DFT_DTB0_SELMUX_READY_LDO = VREGAO0V8_DFT_DTB0CONFIG_SELMUX_ReadyLdo ,
  NRF_VREGAO0V8_DFT_DTB0_SELMUX_BP_READY = VREGAO0V8_DFT_DTB0CONFIG_SELMUX_BpReady ,
  NRF_VREGAO0V8_DFT_DTB0_SELMUX_IBPP_READY = VREGAO0V8_DFT_DTB0CONFIG_SELMUX_IbppReady ,
  NRF_VREGAO0V8_DFT_DTB0_SELMUX_SPARE0 = VREGAO0V8_DFT_DTB0CONFIG_SELMUX_Spare0 ,
  NRF_VREGAO0V8_DFT_DTB0_SELMUX_SPARE1 = VREGAO0V8_DFT_DTB0CONFIG_SELMUX_Spare1 ,
  NRF_VREGAO0V8_DFT_DTB0_SELMUX_PWRUP_IBPSR = VREGAO0V8_DFT_DTB0CONFIG_SELMUX_PwrupIbpsr ,
  NRF_VREGAO0V8_DFT_DTB0_SELMUX_PWRUP_CORE_HP = VREGAO0V8_DFT_DTB0CONFIG_SELMUX_PwrupCoreHp
}
 Select multiplexer for DTB0. More...
 
enum  nrf_vregao0v8_dft_dtb1_selmux_t {
  NRF_VREGAO0V8_DFT_DTB1_SELMUX_BPDET = VREGAO0V8_DFT_DTB1CONFIG_SELMUX_Bpdet ,
  NRF_VREGAO0V8_DFT_DTB1_SELMUX_IBPSR_SETTLED = VREGAO0V8_DFT_DTB1CONFIG_SELMUX_IbpsrSettled ,
  NRF_VREGAO0V8_DFT_DTB1_SELMUX_MODE_ULP = VREGAO0V8_DFT_DTB1CONFIG_SELMUX_ModeUlp ,
  NRF_VREGAO0V8_DFT_DTB1_SELMUX_SETTLED_LDO = VREGAO0V8_DFT_DTB1CONFIG_SELMUX_SettledLdo
}
 Select multiplexer for DTB1. More...
 
enum  nrf_vregao0v8_dft_dtb2_selmux_t {
  NRF_VREGAO0V8_DFT_DTB2_SELMUX_ICMP_LP = VREGAO0V8_DFT_DTB2CONFIG_SELMUX_IcmpLp ,
  NRF_VREGAO0V8_DFT_DTB2_SELMUX_VOUT_CMP = VREGAO0V8_DFT_DTB2CONFIG_SELMUX_VoutCmp ,
  NRF_VREGAO0V8_DFT_DTB2_SELMUX_REQ_BP = VREGAO0V8_DFT_DTB2CONFIG_SELMUX_ReqBp ,
  NRF_VREGAO0V8_DFT_DTB2_SELMUX_CAL_CMP = VREGAO0V8_DFT_DTB2CONFIG_SELMUX_CalCmp
}
 Select multiplexer for DTB2. More...
 

Functions

NRF_STATIC_INLINE void nrf_vregao0v8_event_clear (NRF_VREGAO0V8_Type *p_reg, nrf_vregao0v8_event_t event)
 Function for clearing the specified VREGAO0V8 event.
 
NRF_STATIC_INLINE bool nrf_vregao0v8_event_check (NRF_VREGAO0V8_Type const *p_reg, nrf_vregao0v8_event_t event)
 Function for retrieving the state of the VREGAO0V8 event.
 
NRF_STATIC_INLINE uint32_t nrf_vregao0v8_event_address_get (NRF_VREGAO0V8_Type const *p_reg, nrf_vregao0v8_event_t event)
 Function for getting the address of the specified event register.
 
NRF_STATIC_INLINE void nrf_vregao0v8_int_enable (NRF_VREGAO0V8_Type *p_reg, uint32_t mask)
 Function for enabling specified interrupts.
 
NRF_STATIC_INLINE void nrf_vregao0v8_int_disable (NRF_VREGAO0V8_Type *p_reg, uint32_t mask)
 Function for disabling specified interrupts.
 
NRF_STATIC_INLINE uint32_t nrf_vregao0v8_int_enable_check (NRF_VREGAO0V8_Type const *p_reg, uint32_t mask)
 Function for checking if the specified interrupts are enabled.
 
NRF_STATIC_INLINE uint32_t nrf_vregao0v8_int_pending_get (NRF_VREGAO0V8_Type const *p_reg)
 Function for retrieving the state of pending interrupts.
 
NRF_STATIC_INLINE nrf_vregao0v8_status_t nrf_vregao0v8_status_get (NRF_VREGAO0V8_Type const *p_reg)
 Function for getting VREGAO0V8 status register.
 
NRF_STATIC_INLINE uint32_t nrf_vregao0v8_statusana_get (NRF_VREGAO0V8_Type const *p_reg)
 Function for getting VREGAO0V8 status of the analog module output signals.
 
NRF_STATIC_INLINE void nrf_vregao0v8_config_static_set (NRF_VREGAO0V8_Type *p_reg, nrf_vregao0v8_config_static_t cfg)
 Function for setting static and dynamic voltage regulator configuration.
 
NRF_STATIC_INLINE nrf_vregao0v8_config_static_t nrf_vregao0v8_config_static_get (NRF_VREGAO0V8_Type const *p_reg)
 Function for getting static and dynamic voltage regulator configuration.
 
NRF_STATIC_INLINE void nrf_vregao0v8_config_dynamic_set (NRF_VREGAO0V8_Type *p_reg, nrf_vregao0v8_config_dynamic_t cfg)
 Function for setting voltage regulator dynamic configuration.
 
NRF_STATIC_INLINE nrf_vregao0v8_config_dynamic_t nrf_vregao0v8_config_dynamic_get (NRF_VREGAO0V8_Type const *p_reg)
 Function for getting voltage regulator dynamic configuration.
 
NRF_STATIC_INLINE void nrf_vregao0v8_trim_iref_set (NRF_VREGAO0V8_Type *p_reg, uint8_t val)
 Function for setting current reference trimming.
 
NRF_STATIC_INLINE uint8_t nrf_vregao0v8_trim_iref_get (NRF_VREGAO0V8_Type const *p_reg)
 Function for getting current reference trimming.
 
NRF_STATIC_INLINE void nrf_vregao0v8_trim_highpower_set (NRF_VREGAO0V8_Type *p_reg, uint8_t val)
 Function for setting high power mode output voltage offset trimming.
 
NRF_STATIC_INLINE uint8_t nrf_vregao0v8_trim_highpower_get (NRF_VREGAO0V8_Type const *p_reg)
 Function for getting high power mode output voltage offset trimming.
 
NRF_STATIC_INLINE void nrf_vregao0v8_trim_lowpower_set (NRF_VREGAO0V8_Type *p_reg, uint8_t val)
 Function for setting low power mode output voltage offset trimming.
 
NRF_STATIC_INLINE uint8_t nrf_vregao0v8_trim_lowpower_get (NRF_VREGAO0V8_Type const *p_reg)
 Function for getting low power mode output voltage offset trimming.
 
NRF_STATIC_INLINE void nrf_vregao0v8_trim_ultralowpower_set (NRF_VREGAO0V8_Type *p_reg, nrf_vregao0v8_trim_ulp_t val)
 Function for setting ultra low power ripple trimming.
 
NRF_STATIC_INLINE nrf_vregao0v8_trim_ulp_t nrf_vregao0v8_trim_ultralowpower_get (NRF_VREGAO0V8_Type const *p_reg)
 Function for getting ultra low power ripple trimming.
 
NRF_STATIC_INLINE void nrf_vregao0v8_trim_bpdet_set (NRF_VREGAO0V8_Type *p_reg, uint8_t val)
 Function for setting BP detector offset trimming.
 
NRF_STATIC_INLINE uint8_t nrf_vregao0v8_trim_bpdef_get (NRF_VREGAO0V8_Type const *p_reg)
 Function for getting BP detector offset trimming.
 
NRF_STATIC_INLINE void nrf_vregao0v8_mirror_lock_set (NRF_VREGAO0V8_Type *p_reg, bool lock)
 Function for locking mirrored registers.
 
NRF_STATIC_INLINE void nrf_vregao0v8_vout_set (NRF_VREGAO0V8_Type *p_reg, uint8_t val)
 Function for setting output voltage.
 
NRF_STATIC_INLINE uint8_t nrf_vregao0v8_vout_get (NRF_VREGAO0V8_Type const *p_reg)
 Function for getting output voltage.
 
NRF_STATIC_INLINE void nrf_vregao0v8_mode_set (NRF_VREGAO0V8_Type *p_reg, nrf_vregao0v8_mode_t mode)
 Function for setting voltage regulator mode.
 
NRF_STATIC_INLINE nrf_vregao0v8_mode_t nrf_vregao0v8_mode_get (NRF_VREGAO0V8_Type const *p_reg)
 Function for getting voltage regulator mode.
 
NRF_STATIC_INLINE void nrf_vregao0v8_ithreshold_set (NRF_VREGAO0V8_Type *p_reg, uint8_t thr)
 Function for setting current threshold for mode transition.
 
NRF_STATIC_INLINE uint8_t nrf_vregao0v8_ithreshold_get (NRF_VREGAO0V8_Type const *p_reg)
 Function for getting current threshold for mode transition.
 
NRF_STATIC_INLINE void nrf_vregao0v8_override_set (NRF_VREGAO0V8_Type *p_reg, nrf_vregao0v8_analog_signal_t signal, bool enable, uint8_t val)
 Function for overriding signal to the analog module.
 
NRF_STATIC_INLINE void nrf_vregao0v8_dft_atb0_config_set (NRF_VREGAO0V8_Type *p_reg, nrf_vregao0v8_dft_atb0_selmux_t selmux, bool enable)
 Function for configuring Analog Test Bus 0 (ATB0).
 
NRF_STATIC_INLINE void nrf_vregao0v8_dft_atb1_config_set (NRF_VREGAO0V8_Type *p_reg, nrf_vregao0v8_dft_atb1_selmux_t selmux, bool enable)
 Function for configuring Analog Test Bus 1 (ATB1).
 
NRF_STATIC_INLINE void nrf_vregao0v8_dft_dtb0_config_set (NRF_VREGAO0V8_Type *p_reg, nrf_vregao0v8_dft_dtb0_selmux_t selmux, bool enable)
 Function for configuring Digital Test Bus 0 (DTB0).
 
NRF_STATIC_INLINE void nrf_vregao0v8_dft_dtb1_config_set (NRF_VREGAO0V8_Type *p_reg, nrf_vregao0v8_dft_dtb1_selmux_t selmux, bool enable)
 Function for configuring Digital Test Bus 1 (DTB1).
 
NRF_STATIC_INLINE void nrf_vregao0v8_dft_dtb2_config_set (NRF_VREGAO0V8_Type *p_reg, nrf_vregao0v8_dft_dtb2_selmux_t selmux, bool enable)
 Function for configuring Digital Test Bus 2 (DTB2).
 
NRF_STATIC_INLINE void nrf_vregao0v8_dft_dtb3_config_set (NRF_VREGAO0V8_Type *p_reg, bool enable)
 Function for configuring Digital Test Bus 3 (DTB3).
 
NRF_STATIC_INLINE void nrf_vregao0v8_dft_tcfg_config_set (NRF_VREGAO0V8_Type *p_reg, nrf_vregao0v8_tcfg_t tcfg)
 Function for configuring test mode.
 
NRF_STATIC_INLINE void nrf_vregao0v8_dft_cal_set (NRF_VREGAO0V8_Type *p_reg, bool enable)
 Function for enabling or disabling calibration.
 
NRF_STATIC_INLINE bool nrf_vregao0v8_dft_calcmp_check (NRF_VREGAO0V8_Type const *p_reg)
 Function for checking calibration compare.
 

Detailed Description

Hardware access layer for managing the Always-on 0.8V Voltage Regulator (VREGAO0V8).

Enumeration Type Documentation

◆ nrf_vregao0v8_analog_signal_t

Analog signal to be overridden.

Enumerator
NRF_VREGAO0V8_ANALOG_SIGNAL_PWRUP 

Override PWRUP signal.

NRF_VREGAO0V8_ANALOG_SIGNAL_RETAIN 

Override RETAIN signal.

NRF_VREGAO0V8_ANALOG_SIGNAL_MODE_LP 

Override MODE LP signal.

NRF_VREGAO0V8_ANALOG_SIGNAL_MODE_ULPR 

Override MODE ULPR signal.

NRF_VREGAO0V8_ANALOG_SIGNAL_REQ_BYPASS 

Override REQ BYPASS signal.

NRF_VREGAO0V8_ANALOG_SIGNAL_READY 

Override READY signal.

NRF_VREGAO0V8_ANALOG_SIGNAL_SETTLED 

Override SETTLED signal.

NRF_VREGAO0V8_ANALOG_SIGNAL_BPREADY 

Override BPREADY signal.

NRF_VREGAO0V8_ANALOG_SIGNAL_IOUT_CMP_HP 

Override IOUTCMPHP signal.

NRF_VREGAO0V8_ANALOG_SIGNAL_IOUT_CMP_LP 

Override IOUTCMPLP signal.

◆ nrf_vregao0v8_dft_atb0_selmux_t

Select multiplexer for ATB0.

Enumerator
NRF_VREGAO0V8_DFT_ATB0_SELMUX_EXT_VREF 

External Vref.

NRF_VREGAO0V8_DFT_ATB0_SELMUX_VDD_SW_1V8 

VDD_SW_1V8.

NRF_VREGAO0V8_DFT_ATB0_SELMUX_IBPSR_8UA 

Internal 8uA current reference.

NRF_VREGAO0V8_DFT_ATB0_SELMUX_IBPP_50NA 

IBPP_50N.

NRF_VREGAO0V8_DFT_ATB0_SELMUX_VSS 

Vss.

◆ nrf_vregao0v8_dft_atb1_selmux_t

Select multiplexer for ATB1.

Enumerator
NRF_VREGAO0V8_DFT_ATB1_SELMUX_VREF_HP 

HP Vref.

NRF_VREGAO0V8_DFT_ATB1_SELMUX_VREF_0V9_DVT 

VREF_0V9_DVT.

NRF_VREGAO0V8_DFT_ATB1_SELMUX_VREF_LP 

Buffered VREF_LP.

NRF_VREGAO0V8_DFT_ATB1_SELMUX_VFP 

VFB.

◆ nrf_vregao0v8_dft_dtb0_selmux_t

Select multiplexer for DTB0.

Enumerator
NRF_VREGAO0V8_DFT_DTB0_SELMUX_ICMP_HP 

ICMP_HP.

NRF_VREGAO0V8_DFT_DTB0_SELMUX_MBIAS_IBPSR_SETTLED 

MBIAS_IBPSR_SETTLED.

NRF_VREGAO0V8_DFT_DTB0_SELMUX_MODE_LP 

MODE_LP.

NRF_VREGAO0V8_DFT_DTB0_SELMUX_READY_LDO 

READY_LDO.

NRF_VREGAO0V8_DFT_DTB0_SELMUX_BP_READY 

BP_READY.

NRF_VREGAO0V8_DFT_DTB0_SELMUX_IBPP_READY 

IBPP_READY.

NRF_VREGAO0V8_DFT_DTB0_SELMUX_SPARE0 

None selected, logic 0.

NRF_VREGAO0V8_DFT_DTB0_SELMUX_SPARE1 

None selected, logic 0.

NRF_VREGAO0V8_DFT_DTB0_SELMUX_PWRUP_IBPSR 

Internal 4uA current reference powerup.

NRF_VREGAO0V8_DFT_DTB0_SELMUX_PWRUP_CORE_HP 

High Power core powerup.

◆ nrf_vregao0v8_dft_dtb1_selmux_t

Select multiplexer for DTB1.

Enumerator
NRF_VREGAO0V8_DFT_DTB1_SELMUX_BPDET 

BPDET.

NRF_VREGAO0V8_DFT_DTB1_SELMUX_IBPSR_SETTLED 

IBPSR_SETTLED.

NRF_VREGAO0V8_DFT_DTB1_SELMUX_MODE_ULP 

MODE_ULP ready signal.

NRF_VREGAO0V8_DFT_DTB1_SELMUX_SETTLED_LDO 

SETTLED_LDO power core ready signal.

◆ nrf_vregao0v8_dft_dtb2_selmux_t

Select multiplexer for DTB2.

Enumerator
NRF_VREGAO0V8_DFT_DTB2_SELMUX_ICMP_LP 

ICMP_LP.

NRF_VREGAO0V8_DFT_DTB2_SELMUX_VOUT_CMP 

VOUTCMP.

NRF_VREGAO0V8_DFT_DTB2_SELMUX_REQ_BP 

REQ_BP.

NRF_VREGAO0V8_DFT_DTB2_SELMUX_CAL_CMP 

CAL_CMP.

◆ nrf_vregao0v8_event_t

VREGAO0V8 events.

Enumerator
NRF_VREGAO0V8_EVENT_READY 

Power up done.

NRF_VREGAO0V8_EVENT_SETTLED 

Settled flag for MODE handshake.

NRF_VREGAO0V8_EVENT_BPREADY 

Bypass ready.

NRF_VREGAO0V8_EVENT_IOUT_CMP_HP 

HP mode analog current comparator.

NRF_VREGAO0V8_EVENT_IOUT_CMP_LP 

LP mode analog current comparator.

NRF_VREGAO0V8_EVENT_LP2HP 

Current consumption above threshold.

NRF_VREGAO0V8_EVENT_HP2LP 

Current consumption below threshold.

◆ nrf_vregao0v8_int_mask_t

VREGAO0V8 interrupts.

Enumerator
NRF_VREGAO0V8_INT_READY_MASK 

Interrupt on READY.

NRF_VREGAO0V8_INT_SETTLED_MASK 

Interrupt on SETTLED.

NRF_VREGAO0V8_INT_BPREADY_MASK 

Interrupt on BPREADY.

NRF_VREGAO0V8_INT_IOUT_CMP_HP_MASK 

Interrupt on IOUTCMPHP.

NRF_VREGAO0V8_INT_IOUT_CMP_LP_MASK 

Interrupt on IOUTCMPLP.

NRF_VREGAO0V8_INT_LP2HP_MASK 

Interrupt on LP2HP.

NRF_VREGAO0V8_INT_HP2LP_MASK 

Interrupt on HP2LP.

◆ nrf_vregao0v8_mode_t

Voltage regulator mode.

Enumerator
NRF_VREGAO0V8_MODE_AUTO 

Automatically handled by the peripheral.

NRF_VREGAO0V8_MODE_HIGH_POWER 

High power mode.

NRF_VREGAO0V8_MODE_LOW_POWER 

Low power mode.

NRF_VREGAO0V8_MODE_ULP_REFRESH 

Ultra-low power refresh mode.

NRF_VREGAO0V8_MODE_BYPASS 

Bypass mode.

◆ nrf_vregao0v8_status_t

STATUS register states.

Enumerator
NRF_VREGAO0V8_STATUS_HIGH_POWER 

High power mode.

NRF_VREGAO0V8_STATUS_LOW_POWER 

Low power mode.

NRF_VREGAO0V8_STATUS_ULP_REFRESH 

ULP refresh mode.

NRF_VREGAO0V8_STATUS_BYPASS 

Bypass forced mode.

◆ nrf_vregao0v8_statusana_mask_t

STATUSANA register bit masks.

Enumerator
NRF_VREGAO0V8_STATUSANA_READY_MASK 

Current value of READY signal.

NRF_VREGAO0V8_STATUSANA_SETTLED_MASK 

Current value of SETTLED signal.

NRF_VREGAO0V8_STATUSANA_BPREADY_MASK 

Current value of BPREADY signal.

NRF_VREGAO0V8_STATUSANA_IOUT_CMP_HP_MASK 

Current value of IOUTCMPHP signal.

NRF_VREGAO0V8_STATUSANA_IOUT_CMP_LP_MASK 

Current value of IOUTCMPLP signal.

◆ nrf_vregao0v8_trim_ulp_t

Values for ultra low power mode ripple trimming.

Enumerator
NRF_VREGAO0V8_TRIM_ULP_5MV 

5mV.

NRF_VREGAO0V8_TRIM_ULP_15MV 

15mV.

NRF_VREGAO0V8_TRIM_ULP_25MV 

25mV.

NRF_VREGAO0V8_TRIM_ULP_35MV 

35mV.

Function Documentation

◆ nrf_vregao0v8_config_dynamic_get()

NRF_STATIC_INLINE nrf_vregao0v8_config_dynamic_t nrf_vregao0v8_config_dynamic_get ( NRF_VREGAO0V8_Type const *  p_reg)

Function for getting voltage regulator dynamic configuration.

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

◆ nrf_vregao0v8_config_dynamic_set()

NRF_STATIC_INLINE void nrf_vregao0v8_config_dynamic_set ( NRF_VREGAO0V8_Type *  p_reg,
nrf_vregao0v8_config_dynamic_t  cfg 
)

Function for setting voltage regulator dynamic configuration.

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

◆ nrf_vregao0v8_config_static_get()

NRF_STATIC_INLINE nrf_vregao0v8_config_static_t nrf_vregao0v8_config_static_get ( NRF_VREGAO0V8_Type const *  p_reg)

Function for getting static and dynamic voltage regulator configuration.

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

◆ nrf_vregao0v8_config_static_set()

NRF_STATIC_INLINE void nrf_vregao0v8_config_static_set ( NRF_VREGAO0V8_Type *  p_reg,
nrf_vregao0v8_config_static_t  cfg 
)

Function for setting static and dynamic voltage regulator configuration.

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

◆ nrf_vregao0v8_dft_atb0_config_set()

NRF_STATIC_INLINE void nrf_vregao0v8_dft_atb0_config_set ( NRF_VREGAO0V8_Type *  p_reg,
nrf_vregao0v8_dft_atb0_selmux_t  selmux,
bool  enable 
)

Function for configuring Analog Test Bus 0 (ATB0).

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]selmuxMultiplexer configuration.
[in]enableTrue to enable test bus.

◆ nrf_vregao0v8_dft_atb1_config_set()

NRF_STATIC_INLINE void nrf_vregao0v8_dft_atb1_config_set ( NRF_VREGAO0V8_Type *  p_reg,
nrf_vregao0v8_dft_atb1_selmux_t  selmux,
bool  enable 
)

Function for configuring Analog Test Bus 1 (ATB1).

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]selmuxMultiplexer configuration.
[in]enableTrue to enable test bus.

◆ nrf_vregao0v8_dft_cal_set()

NRF_STATIC_INLINE void nrf_vregao0v8_dft_cal_set ( NRF_VREGAO0V8_Type *  p_reg,
bool  enable 
)

Function for enabling or disabling calibration.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]enableTrue if the calibration is to be enabled, false otherwise.

◆ nrf_vregao0v8_dft_calcmp_check()

NRF_STATIC_INLINE bool nrf_vregao0v8_dft_calcmp_check ( NRF_VREGAO0V8_Type const *  p_reg)

Function for checking calibration compare.

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

◆ nrf_vregao0v8_dft_dtb0_config_set()

NRF_STATIC_INLINE void nrf_vregao0v8_dft_dtb0_config_set ( NRF_VREGAO0V8_Type *  p_reg,
nrf_vregao0v8_dft_dtb0_selmux_t  selmux,
bool  enable 
)

Function for configuring Digital Test Bus 0 (DTB0).

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]selmuxMultiplexer configuration.
[in]enableTrue to enable test bus.

◆ nrf_vregao0v8_dft_dtb1_config_set()

NRF_STATIC_INLINE void nrf_vregao0v8_dft_dtb1_config_set ( NRF_VREGAO0V8_Type *  p_reg,
nrf_vregao0v8_dft_dtb1_selmux_t  selmux,
bool  enable 
)

Function for configuring Digital Test Bus 1 (DTB1).

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]selmuxMultiplexer configuration.
[in]enableTrue to enable test bus.

◆ nrf_vregao0v8_dft_dtb2_config_set()

NRF_STATIC_INLINE void nrf_vregao0v8_dft_dtb2_config_set ( NRF_VREGAO0V8_Type *  p_reg,
nrf_vregao0v8_dft_dtb2_selmux_t  selmux,
bool  enable 
)

Function for configuring Digital Test Bus 2 (DTB2).

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]selmuxMultiplexer configuration.
[in]enableTrue to enable test bus.

◆ nrf_vregao0v8_dft_dtb3_config_set()

NRF_STATIC_INLINE void nrf_vregao0v8_dft_dtb3_config_set ( NRF_VREGAO0V8_Type *  p_reg,
bool  enable 
)

Function for configuring Digital Test Bus 3 (DTB3).

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]enableTrue to enable PWRUP delay test circuit.

◆ nrf_vregao0v8_dft_tcfg_config_set()

NRF_STATIC_INLINE void nrf_vregao0v8_dft_tcfg_config_set ( NRF_VREGAO0V8_Type *  p_reg,
nrf_vregao0v8_tcfg_t  tcfg 
)

Function for configuring test mode.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]tcfgTest mode configuration.

◆ nrf_vregao0v8_event_address_get()

NRF_STATIC_INLINE uint32_t nrf_vregao0v8_event_address_get ( NRF_VREGAO0V8_Type const *  p_reg,
nrf_vregao0v8_event_t  event 
)

Function for getting the address of the specified event register.

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

◆ nrf_vregao0v8_event_check()

NRF_STATIC_INLINE bool nrf_vregao0v8_event_check ( NRF_VREGAO0V8_Type const *  p_reg,
nrf_vregao0v8_event_t  event 
)

Function for retrieving the state of the VREGAO0V8 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_vregao0v8_event_clear()

NRF_STATIC_INLINE void nrf_vregao0v8_event_clear ( NRF_VREGAO0V8_Type *  p_reg,
nrf_vregao0v8_event_t  event 
)

Function for clearing the specified VREGAO0V8 event.

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

◆ nrf_vregao0v8_int_disable()

NRF_STATIC_INLINE void nrf_vregao0v8_int_disable ( NRF_VREGAO0V8_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_vregao0v8_int_mask_t values for bit masking.

◆ nrf_vregao0v8_int_enable()

NRF_STATIC_INLINE void nrf_vregao0v8_int_enable ( NRF_VREGAO0V8_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_vregao0v8_int_mask_t values for bit masking.

◆ nrf_vregao0v8_int_enable_check()

NRF_STATIC_INLINE uint32_t nrf_vregao0v8_int_enable_check ( NRF_VREGAO0V8_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_vregao0v8_int_mask_t values for bit masking.
Returns
Mask of enabled interrupts.

◆ nrf_vregao0v8_int_pending_get()

NRF_STATIC_INLINE uint32_t nrf_vregao0v8_int_pending_get ( NRF_VREGAO0V8_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_vregao0v8_int_mask_t values for bit masking.

◆ nrf_vregao0v8_ithreshold_get()

NRF_STATIC_INLINE uint8_t nrf_vregao0v8_ithreshold_get ( NRF_VREGAO0V8_Type const *  p_reg)

Function for getting current threshold for mode transition.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Current compare value.

◆ nrf_vregao0v8_ithreshold_set()

NRF_STATIC_INLINE void nrf_vregao0v8_ithreshold_set ( NRF_VREGAO0V8_Type *  p_reg,
uint8_t  thr 
)

Function for setting current threshold for mode transition.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]thrCompare value to match (PCRM format).

◆ nrf_vregao0v8_mirror_lock_set()

NRF_STATIC_INLINE void nrf_vregao0v8_mirror_lock_set ( NRF_VREGAO0V8_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_vregao0v8_mode_get()

NRF_STATIC_INLINE nrf_vregao0v8_mode_t nrf_vregao0v8_mode_get ( NRF_VREGAO0V8_Type const *  p_reg)

Function for getting voltage regulator mode.

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

◆ nrf_vregao0v8_mode_set()

NRF_STATIC_INLINE void nrf_vregao0v8_mode_set ( NRF_VREGAO0V8_Type *  p_reg,
nrf_vregao0v8_mode_t  mode 
)

Function for setting voltage regulator mode.

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

◆ nrf_vregao0v8_override_set()

NRF_STATIC_INLINE void nrf_vregao0v8_override_set ( NRF_VREGAO0V8_Type *  p_reg,
nrf_vregao0v8_analog_signal_t  signal,
bool  enable,
uint8_t  val 
)

Function for overriding 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_vregao0v8_status_get()

NRF_STATIC_INLINE nrf_vregao0v8_status_t nrf_vregao0v8_status_get ( NRF_VREGAO0V8_Type const *  p_reg)

Function for getting VREGAO0V8 status register.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
The STATUS register value.

◆ nrf_vregao0v8_statusana_get()

NRF_STATIC_INLINE uint32_t nrf_vregao0v8_statusana_get ( NRF_VREGAO0V8_Type const *  p_reg)

Function for getting VREGAO0V8 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_vregao0v8_statusana_mask_t values for bit masking.

◆ nrf_vregao0v8_trim_bpdef_get()

NRF_STATIC_INLINE uint8_t nrf_vregao0v8_trim_bpdef_get ( NRF_VREGAO0V8_Type const *  p_reg)

Function for getting BP detector offset trimming.

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

◆ nrf_vregao0v8_trim_bpdet_set()

NRF_STATIC_INLINE void nrf_vregao0v8_trim_bpdet_set ( NRF_VREGAO0V8_Type *  p_reg,
uint8_t  val 
)

Function for setting BP detector offset trimming.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]valOffset trimming value. The value is 2's complement value of 2.5mV +/- 5mV steps.

◆ nrf_vregao0v8_trim_highpower_get()

NRF_STATIC_INLINE uint8_t nrf_vregao0v8_trim_highpower_get ( NRF_VREGAO0V8_Type const *  p_reg)

Function for getting high power mode output voltage offset trimming.

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

◆ nrf_vregao0v8_trim_highpower_set()

NRF_STATIC_INLINE void nrf_vregao0v8_trim_highpower_set ( NRF_VREGAO0V8_Type *  p_reg,
uint8_t  val 
)

Function for setting high power mode output voltage offset trimming.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]valVoltage offset trimming value. The value is 2's complement value of 2.5mV +/- 5mV steps.

◆ nrf_vregao0v8_trim_iref_get()

NRF_STATIC_INLINE uint8_t nrf_vregao0v8_trim_iref_get ( NRF_VREGAO0V8_Type const *  p_reg)

Function for getting current reference trimming.

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

◆ nrf_vregao0v8_trim_iref_set()

NRF_STATIC_INLINE void nrf_vregao0v8_trim_iref_set ( NRF_VREGAO0V8_Type *  p_reg,
uint8_t  val 
)

Function for setting current reference trimming.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]valCurrent reference trimming value. The value is 2's complement from -48% to 61%. Default 7.2%, steps are nonlinear.

◆ nrf_vregao0v8_trim_lowpower_get()

NRF_STATIC_INLINE uint8_t nrf_vregao0v8_trim_lowpower_get ( NRF_VREGAO0V8_Type const *  p_reg)

Function for getting low power mode output voltage offset trimming.

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

◆ nrf_vregao0v8_trim_lowpower_set()

NRF_STATIC_INLINE void nrf_vregao0v8_trim_lowpower_set ( NRF_VREGAO0V8_Type *  p_reg,
uint8_t  val 
)

Function for setting low power mode output voltage offset trimming.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]valVoltage offset trimming value. The value is 2's complement value of 2.5mV +/- 5mV steps.

◆ nrf_vregao0v8_trim_ultralowpower_get()

NRF_STATIC_INLINE nrf_vregao0v8_trim_ulp_t nrf_vregao0v8_trim_ultralowpower_get ( NRF_VREGAO0V8_Type const *  p_reg)

Function for getting ultra low power ripple trimming.

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

◆ nrf_vregao0v8_trim_ultralowpower_set()

NRF_STATIC_INLINE void nrf_vregao0v8_trim_ultralowpower_set ( NRF_VREGAO0V8_Type *  p_reg,
nrf_vregao0v8_trim_ulp_t  val 
)

Function for setting ultra low power ripple trimming.

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

◆ nrf_vregao0v8_vout_get()

NRF_STATIC_INLINE uint8_t nrf_vregao0v8_vout_get ( NRF_VREGAO0V8_Type const *  p_reg)

Function for getting output voltage.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Output voltage value.

◆ nrf_vregao0v8_vout_set()

NRF_STATIC_INLINE void nrf_vregao0v8_vout_set ( NRF_VREGAO0V8_Type *  p_reg,
uint8_t  val 
)

Function for setting output voltage.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]valOutput voltage value. The value is 0.77V + 0.01V steps.

Documentation feedback | Developer Zone | Subscribe | Updated