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

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

Data Structures

struct  nrf_vregao1v8_config_static_t
 Fields for static configuration structure. More...
 
struct  nrf_vregao1v8_config_dynamic_t
 Dynamic configuration. Current limit configuration for the voltage regulator. More...
 
struct  nrf_vregao1v8_tcfg_t
 Test mode configuration. More...
 

Macros

#define NRF_VREGAO1V8_HAS_DFT_ATB0_SELMUX_SPARE0   1
 Symbol indicating whether selecting SPARE0 multiplexer input for Analog Test Bus 0 is available.
 
#define NRF_VREGAO1V8_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_VREGAO1V8_HAS_DFT_ATB1_SELMUX_SPARE0   1
 Symbol indicating whether selecting SPARE0 multiplexer input for Analog Test Bus 1 is available.
 
#define NRF_VREGAO1V8_HAS_DFT_ATB1_SELMUX_VDD_1V8_FB   1
 Symbol indicating whether setting the internal direct feedback voltage for Analog Test Bus 0 multiplexer is available.
 

Enumerations

enum  nrf_vregao1v8_event_t {
  NRF_VREGAO1V8_EVENT_READY = offsetof(NRF_VREGAO1V8_Type, EVENTS_READY) ,
  NRF_VREGAO1V8_EVENT_SETTLED = offsetof(NRF_VREGAO1V8_Type, EVENTS_SETTLED) ,
  NRF_VREGAO1V8_EVENT_IOUTCMP = offsetof(NRF_VREGAO1V8_Type, EVENTS_IOUTCMP) ,
  NRF_VREGAO1V8_EVENT_LP2HP = offsetof(NRF_VREGAO1V8_Type, EVENTS_LP2HP) ,
  NRF_VREGAO1V8_EVENT_HP2LP = offsetof(NRF_VREGAO1V8_Type, EVENTS_HP2LP)
}
 VREGAO1V8 events. More...
 
enum  nrf_vregao1v8_int_mask_t {
  NRF_VREGAO1V8_INT_READY_MASK = VREGAO1V8_INTEN_READY_Msk ,
  NRF_VREGAO1V8_INT_SETTLED_MASK = VREGAO1V8_INTEN_SETTLED_Msk ,
  NRF_VREGAO1V8_INT_IOUTCMP_MASK = VREGAO1V8_INTEN_IOUTCMP_Msk ,
  NRF_VREGAO1V8_INT_LP2HP_MASK = VREGAO1V8_INTEN_LP2HP_Msk ,
  NRF_VREGAO1V8_INT_HP2LP_MASK = VREGAO1V8_INTEN_HP2LP_Msk
}
 VREGAO1V8 interrupts. More...
 
enum  nrf_vregao1v8_status_t {
  NRF_VREGAO1V8_STATUS_HIGH_POWER = VREGAO1V8_STATUS_MODE_HighPower ,
  NRF_VREGAO1V8_STATUS_LP_REFRESH = VREGAO1V8_STATUS_MODE_LowPowerRefresh ,
  NRF_VREGAO1V8_STATUS_ULP_REFRESH = VREGAO1V8_STATUS_MODE_UltraLowPowerRefresh ,
  NRF_VREGAO1V8_STATUS_LPR_DIFF = VREGAO1V8_STATUS_MODE_LowPowerRefreshDiff
}
 STATUS register states. More...
 
enum  nrf_vregao1v8_statusana_mask_t {
  NRF_VREGAO1V8_STATUSANA_READY_MASK = VREGAO1V8_STATUSANA_READY_Msk ,
  NRF_VREGAO1V8_STATUSANA_SETTLED_MASK = VREGAO1V8_STATUSANA_SETTLED_Msk ,
  NRF_VREGAO1V8_STATUSANA_IOUTCMP_MASK = VREGAO1V8_STATUSANA_IOUTCMP_Msk
}
 STATUSANA register bit masks. More...
 
enum  nrf_vregao1v8_double_bias_t {
  NRF_VREGAO1V8_CFGDYNAMIC_DOUBLE_BIAS_AUTO = VREGAO1V8_CONFIG_CFGDYNAMIC_DOUBLEBIAS_Auto ,
  NRF_VREGAO1V8_CFGDYNAMIC_DOUBLE_BIAS_DISABLED = VREGAO1V8_CONFIG_CFGDYNAMIC_DOUBLEBIAS_Disabled ,
  NRF_VREGAO1V8_CFGDYNAMIC_DOUBLE_BIAS_ENABLED = VREGAO1V8_CONFIG_CFGDYNAMIC_DOUBLEBIAS_Enabled
}
 Double bias current configuration. More...
 
enum  nrf_vregao1v8_ilim_low_t {
  NRF_VREGAO1V8_CFGDYNAMIC_ILIM_LOW_DISABLED = VREGAO1V8_CONFIG_CFGDYNAMIC_ILIMLOW_Disabled ,
  NRF_VREGAO1V8_CFGDYNAMIC_ILIM_LOW_ENABLED = VREGAO1V8_CONFIG_CFGDYNAMIC_ILIMLOW_Enabled
}
 Current limit low configuration. More...
 
enum  nrf_vregao1v8_dcmp_t {
  NRF_VREGAO1V8_CFGDYNAMIC_DCMP_AUTO = VREGAO1V8_CONFIG_CFGDYNAMIC_DCMP_Auto ,
  NRF_VREGAO1V8_CFGDYNAMIC_DCMP_DISABLED = VREGAO1V8_CONFIG_CFGDYNAMIC_DCMP_Disabled ,
  NRF_VREGAO1V8_CFGDYNAMIC_DCMP_ENABLED = VREGAO1V8_CONFIG_CFGDYNAMIC_DCMP_Enabled
}
 Configuration for differential comparator and LPD mode. More...
 
enum  nrf_vregao1v8_trim_lpdiff_t {
  NRF_VREGAO1V8_TRIM_LPDIFF_21MV = VREGAO1V8_TRIM_LOWPOWERDIFF_VAL_21mV ,
  NRF_VREGAO1V8_TRIM_LPDIFF_27MV = VREGAO1V8_TRIM_LOWPOWERDIFF_VAL_27mV ,
  NRF_VREGAO1V8_TRIM_LPDIFF_33MV = VREGAO1V8_TRIM_LOWPOWERDIFF_VAL_33mV ,
  NRF_VREGAO1V8_TRIM_LPDIFF_39MV = VREGAO1V8_TRIM_LOWPOWERDIFF_VAL_39mV
}
 Low power differential mode output comparator trimming values. More...
 
enum  nrf_vregao1v8_vout_t {
  NRF_VREGAO1V8_VOUT_NOMINAL ,
  NRF_VREGAO1V8_VOUT_HP_HELPER ,
  NRF_VREGAO1V8_VOUT_LP
}
 Voltage output.
 
enum  nrf_vregao1v8_mode_t {
  NRF_VREGAO1V8_MODE_AUTO = VREGAO1V8_MODE_MODE_Auto ,
  NRF_VREGAO1V8_MODE_HIGH_POWER = VREGAO1V8_MODE_MODE_HighPower ,
  NRF_VREGAO1V8_MODE_LP_REFRESH = VREGAO1V8_MODE_MODE_LowPowerRefresh ,
  NRF_VREGAO1V8_MODE_ULP_REFRESH = VREGAO1V8_MODE_MODE_UltraLowPowerRefresh ,
  NRF_VREGAO1V8_MODE_LP_REFRESH_DIFF = VREGAO1V8_MODE_MODE_LowPowerRefreshDiff
}
 Voltage regulator mode. More...
 
enum  nrf_vregao1v8_analog_signal_t {
  NRF_VREGAO1V8_ANALOG_SIGNAL_PWRUP ,
  NRF_VREGAO1V8_ANALOG_SIGNAL_RETAIN ,
  NRF_VREGAO1V8_ANALOG_SIGNAL_MODE_LP ,
  NRF_VREGAO1V8_ANALOG_SIGNAL_MODE_ULP ,
  NRF_VREGAO1V8_ANALOG_SIGNAL_VOLT_HP ,
  NRF_VREGAO1V8_ANALOG_SIGNAL_READY ,
  NRF_VREGAO1V8_ANALOG_SIGNAL_SETTLED ,
  NRF_VREGAO1V8_ANALOG_SIGNAL_IOUT_CMP
}
 Analog signal to be overridden. More...
 
enum  nrf_vregao1v8_dft_atb0_selmux_t {
  NRF_VREGAO1V8_DFT_ATB0_SELMUX_SPARE0 = VREGAO1V8_DFT_ATB0CONFIG_SELMUX_Spare0 ,
  NRF_VREGAO1V8_DFT_ATB0_SELMUX_IBPSR_8U = VREGAO1V8_DFT_ATB0CONFIG_SELMUX_Ibpsr8u ,
  NRF_VREGAO1V8_DFT_ATB0_SELMUX_VDD_SW_1V8 = VREGAO1V8_DFT_ATB0CONFIG_SELMUX_VddSw1v8 ,
  NRF_VREGAO1V8_DFT_ATB0_SELMUX_IBPP_50NA = VREGAO1V8_DFT_ATB0CONFIG_SELMUX_Ibpp50n ,
  NRF_VREGAO1V8_DFT_ATB0_SELMUX_VSS = VREGAO1V8_DFT_ATB0CONFIG_SELMUX_VSS
}
 Select multiplexer for ATB0. More...
 
enum  nrf_vregao1v8_dft_atb1_selmux_t {
  NRF_VREGAO1V8_DFT_ATB1_SELMUX_SPARE0 = VREGAO1V8_DFT_ATB1CONFIG_SELMUX_Spare0 ,
  NRF_VREGAO1V8_DFT_ATB1_SELMUX_VDD_1V8_FB = VREGAO1V8_DFT_ATB1CONFIG_SELMUX_Vdd1V8fb ,
  NRF_VREGAO1V8_DFT_ATB1_SELMUX_VREF_0V9_DVT = VREGAO1V8_DFT_ATB1CONFIG_SELMUX_Vref0v9Dvt ,
  NRF_VREGAO1V8_DFT_ATB1_SELMUX_BUFFERED_VREF_0V9 = VREGAO1V8_DFT_ATB1CONFIG_SELMUX_BufferedVref0V9 ,
  NRF_VREGAO1V8_DFT_ATB1_SELMUX_BUFFERED_VFB_0V9 = VREGAO1V8_DFT_ATB1CONFIG_SELMUX_BufferedVfb0V9
}
 Select multiplexer for ATB1. More...
 
enum  nrf_vregao1v8_dft_dtb0_selmux_t {
  NRF_VREGAO1V8_DFT_DTB0_SELMUX_PWRUP_IBPP = VREGAO1V8_DFT_DTB0CONFIG_SELMUX_PwrupIbpp ,
  NRF_VREGAO1V8_DFT_DTB0_SELMUX_PWRUP_IBPSR = VREGAO1V8_DFT_DTB0CONFIG_SELMUX_PwrupIbpsr ,
  NRF_VREGAO1V8_DFT_DTB0_SELMUX_MODE_LP = VREGAO1V8_DFT_DTB0CONFIG_SELMUX_ModeLp ,
  NRF_VREGAO1V8_DFT_DTB0_SELMUX_VOUT_CMP = VREGAO1V8_DFT_DTB0CONFIG_SELMUX_VoutCmp
}
 Select multiplexer for DTB0. More...
 
enum  nrf_vregao1v8_dft_dtb1_selmux_t {
  NRF_VREGAO1V8_DFT_DTB1_SELMUX_SETTLED_IBPP = VREGAO1V8_DFT_DTB1CONFIG_SELMUX_SettledIbpp ,
  NRF_VREGAO1V8_DFT_DTB1_SELMUX_READY_IBPSR = VREGAO1V8_DFT_DTB1CONFIG_SELMUX_ReadyIbpsr ,
  NRF_VREGAO1V8_DFT_DTB1_SELMUX_MODE_ULP = VREGAO1V8_DFT_DTB1CONFIG_SELMUX_ModeUlp ,
  NRF_VREGAO1V8_DFT_DTB1_SELMUX_VOUT_CMPD = VREGAO1V8_DFT_DTB1CONFIG_SELMUX_VoutCmpd
}
 Select multiplexer for DTB1. More...
 
enum  nrf_vregao1v8_dft_dtb2_selmux_t {
  NRF_VREGAO1V8_DFT_DTB2_SELMUX_PWRUP_VREG_LDO = VREGAO1V8_DFT_DTB2CONFIG_SELMUX_PwrupVregLdo ,
  NRF_VREGAO1V8_DFT_DTB2_SELMUX_SETTLED_IBPSR = VREGAO1V8_DFT_DTB2CONFIG_SELMUX_SettledIbpsr ,
  NRF_VREGAO1V8_DFT_DTB2_SELMUX_SETTLED_LDO = VREGAO1V8_DFT_DTB2CONFIG_SELMUX_SettledLdo ,
  NRF_VREGAO1V8_DFT_DTB2_SELMUX_VOUT_CMPS = VREGAO1V8_DFT_DTB2CONFIG_SELMUX_VoutCmps
}
 Select multiplexer for DTB2. More...
 
enum  nrf_vregao1v8_dft_dtb3_selmux_t {
  NRF_VREGAO1V8_DFT_DTB3_SELMUX_SET_TIMER = VREGAO1V8_DFT_DTB3CONFIG_SELMUX_SetTimer ,
  NRF_VREGAO1V8_DFT_DTB3_SELMUX_SETTLED_MBIAS = VREGAO1V8_DFT_DTB3CONFIG_SELMUX_SettledMbias ,
  NRF_VREGAO1V8_DFT_DTB3_SELMUX_READY_LDO = VREGAO1V8_DFT_DTB3CONFIG_SELMUX_ReadyLdo ,
  NRF_VREGAO1V8_DFT_DTB3_SELMUX_ICMP_5MA = VREGAO1V8_DFT_DTB3CONFIG_SELMUX_Icmp5ma
}
 Select multiplexer for DTB3. More...
 

Functions

NRF_STATIC_INLINE void nrf_vregao1v8_event_clear (NRF_VREGAO1V8_Type *p_reg, nrf_vregao1v8_event_t event)
 Function for clearing the specified VREGAO1V8 event.
 
NRF_STATIC_INLINE bool nrf_vregao1v8_event_check (NRF_VREGAO1V8_Type const *p_reg, nrf_vregao1v8_event_t event)
 Function for retrieving the state of the VREGAO1V8 event.
 
NRF_STATIC_INLINE uint32_t nrf_vregao1v8_event_address_get (NRF_VREGAO1V8_Type const *p_reg, nrf_vregao1v8_event_t event)
 Function for getting the address of the specified event register.
 
NRF_STATIC_INLINE void nrf_vregao1v8_int_enable (NRF_VREGAO1V8_Type *p_reg, uint32_t mask)
 Function for enabling specified interrupts.
 
NRF_STATIC_INLINE void nrf_vregao1v8_int_disable (NRF_VREGAO1V8_Type *p_reg, uint32_t mask)
 Function for disabling specified interrupts.
 
NRF_STATIC_INLINE uint32_t nrf_vregao1v8_int_enable_check (NRF_VREGAO1V8_Type const *p_reg, uint32_t mask)
 Function for checking if the specified interrupts are enabled.
 
NRF_STATIC_INLINE uint32_t nrf_vregao1v8_int_pending_get (NRF_VREGAO1V8_Type const *p_reg)
 Function for retrieving the state of pending interrupts.
 
NRF_STATIC_INLINE nrf_vregao1v8_status_t nrf_vregao1v8_status_get (NRF_VREGAO1V8_Type const *p_reg)
 Function for getting VREGAO1V8 status register.
 
NRF_STATIC_INLINE uint32_t nrf_vregao1v8_statusana_get (NRF_VREGAO1V8_Type const *p_reg)
 Function for getting VREGAO1V8 status of the analog module output signals.
 
NRF_STATIC_INLINE void nrf_vregao1v8_config_static_set (NRF_VREGAO1V8_Type *p_reg, nrf_vregao1v8_config_static_t cfg)
 Function for setting static and dynamic voltage regulator configuration.
 
NRF_STATIC_INLINE nrf_vregao1v8_config_static_t nrf_vregao1v8_config_static_get (NRF_VREGAO1V8_Type const *p_reg)
 Function for getting static and dynamic voltage regulator configuration.
 
NRF_STATIC_INLINE void nrf_vregao1v8_config_dynamic_set (NRF_VREGAO1V8_Type *p_reg, nrf_vregao1v8_config_dynamic_t cfg)
 Function for setting voltage regulator dynamic configuration.
 
NRF_STATIC_INLINE nrf_vregao1v8_config_dynamic_t nrf_vregao1v8_config_dynamic_get (NRF_VREGAO1V8_Type const *p_reg)
 Function for getting voltage regulator dynamic configuration.
 
NRF_STATIC_INLINE void nrf_vregao1v8_trim_iref_set (NRF_VREGAO1V8_Type *p_reg, uint8_t val)
 Function for setting current reference trimming.
 
NRF_STATIC_INLINE uint8_t nrf_vregao1v8_trim_iref_get (NRF_VREGAO1V8_Type const *p_reg)
 Function for getting current reference trimming.
 
NRF_STATIC_INLINE void nrf_vregao1v8_trim_vref_set (NRF_VREGAO1V8_Type *p_reg, uint8_t val)
 Function for setting reference voltage trim.
 
NRF_STATIC_INLINE uint8_t nrf_vregao1v8_trim_vref_get (NRF_VREGAO1V8_Type const *p_reg)
 Function for getting reference voltage trim.
 
NRF_STATIC_INLINE void nrf_vregao1v8_trim_lowpower_set (NRF_VREGAO1V8_Type *p_reg, uint8_t val)
 Function for setting low power mode output voltage offset trimming.
 
NRF_STATIC_INLINE uint8_t nrf_vregao1v8_trim_lowpower_get (NRF_VREGAO1V8_Type const *p_reg)
 Function for getting low power mode output voltage offset trimming.
 
NRF_STATIC_INLINE void nrf_vregao1v8_trim_lpdiff_set (NRF_VREGAO1V8_Type *p_reg, nrf_vregao1v8_trim_lpdiff_t val)
 Function for setting low power differential mode output comparator trimming.
 
NRF_STATIC_INLINE nrf_vregao1v8_trim_lpdiff_t nrf_vregao1v8_trim_lpdiff_get (NRF_VREGAO1V8_Type const *p_reg)
 Function for getting low power differential mode output comparator trimming.
 
NRF_STATIC_INLINE void nrf_vregao1v8_mirror_lock_set (NRF_VREGAO1V8_Type *p_reg, bool lock)
 Function for locking mirrored registers.
 
NRF_STATIC_INLINE void nrf_vregao1v8_vout_set (NRF_VREGAO1V8_Type *p_reg, nrf_vregao1v8_vout_t vout, uint8_t val)
 Function for setting output voltage.
 
NRF_STATIC_INLINE uint8_t nrf_vregao1v8_vout_get (NRF_VREGAO1V8_Type const *p_reg, nrf_vregao1v8_vout_t vout)
 Function for getting output voltage.
 
NRF_STATIC_INLINE void nrf_vregao1v8_mode_set (NRF_VREGAO1V8_Type *p_reg, nrf_vregao1v8_mode_t mode)
 Function for setting voltage regulator mode.
 
NRF_STATIC_INLINE nrf_vregao1v8_mode_t nrf_vregao1v8_mode_get (NRF_VREGAO1V8_Type const *p_reg)
 Function for getting voltage regulator mode.
 
NRF_STATIC_INLINE void nrf_vregao1v8_ithreshold_set (NRF_VREGAO1V8_Type *p_reg, uint8_t thr)
 Function for setting current threshold for mode transition.
 
NRF_STATIC_INLINE uint8_t nrf_vregao1v8_ithreshold_get (NRF_VREGAO1V8_Type const *p_reg)
 Function for getting current threshold for mode transition.
 
NRF_STATIC_INLINE void nrf_vregao1v8_override_set (NRF_VREGAO1V8_Type *p_reg, nrf_vregao1v8_analog_signal_t signal, bool enable, uint8_t val)
 Function for override signal to the analog module.
 
NRF_STATIC_INLINE void nrf_vregao1v8_override_config_set (NRF_VREGAO1V8_Type *p_reg, bool enable, uint8_t double_bias, uint8_t dcmp)
 Function for override the dynamic config signals to the analog module.
 
NRF_STATIC_INLINE void nrf_vregao1v8_dft_atb0_config_set (NRF_VREGAO1V8_Type *p_reg, nrf_vregao1v8_dft_atb0_selmux_t selmux, bool enable)
 Function for configuring Analog Test Bus 0 (ATB0).
 
NRF_STATIC_INLINE void nrf_vregao1v8_dft_atb1_config_set (NRF_VREGAO1V8_Type *p_reg, nrf_vregao1v8_dft_atb1_selmux_t selmux, bool enable)
 Function for configuring Analog Test Bus 1 (ATB1).
 
NRF_STATIC_INLINE void nrf_vregao1v8_dft_dtb0_config_set (NRF_VREGAO1V8_Type *p_reg, nrf_vregao1v8_dft_dtb0_selmux_t selmux, bool enable)
 Function for configuring Digital Test Bus 0 (DTB0).
 
NRF_STATIC_INLINE void nrf_vregao1v8_dft_dtb1_config_set (NRF_VREGAO1V8_Type *p_reg, nrf_vregao1v8_dft_dtb1_selmux_t selmux, bool enable)
 Function for configuring Digital Test Bus 1 (DTB1).
 
NRF_STATIC_INLINE void nrf_vregao1v8_dft_dtb2_config_set (NRF_VREGAO1V8_Type *p_reg, nrf_vregao1v8_dft_dtb2_selmux_t selmux, bool enable)
 Function for configuring Digital Test Bus 2 (DTB2).
 
NRF_STATIC_INLINE void nrf_vregao1v8_dft_dtb3_config_set (NRF_VREGAO1V8_Type *p_reg, nrf_vregao1v8_dft_dtb3_selmux_t selmux, bool pwrup_deltest, bool enable)
 Function for configuring Digital Test Bus 3 (DTB3).
 
NRF_STATIC_INLINE void nrf_vregao1v8_dft_tcfg_config_set (NRF_VREGAO1V8_Type *p_reg, nrf_vregao1v8_tcfg_t tcfg)
 Function for configuring test mode.
 

Detailed Description

Hardware access layer for managing the Always-on 1.8V Voltage Regulator (VREGAO1V8).

Enumeration Type Documentation

◆ nrf_vregao1v8_analog_signal_t

Analog signal to be overridden.

Enumerator
NRF_VREGAO1V8_ANALOG_SIGNAL_PWRUP 

Override PWRUP signal.

NRF_VREGAO1V8_ANALOG_SIGNAL_RETAIN 

Override RETAIN signal.

NRF_VREGAO1V8_ANALOG_SIGNAL_MODE_LP 

Override MODE LP signal.

NRF_VREGAO1V8_ANALOG_SIGNAL_MODE_ULP 

Override MODE ULP signal.

NRF_VREGAO1V8_ANALOG_SIGNAL_VOLT_HP 

Override VOLTHP signal.

NRF_VREGAO1V8_ANALOG_SIGNAL_READY 

Override READY signal.

NRF_VREGAO1V8_ANALOG_SIGNAL_SETTLED 

Override SETTLED signal.

NRF_VREGAO1V8_ANALOG_SIGNAL_IOUT_CMP 

Override IOUTCMP signal.

◆ nrf_vregao1v8_dcmp_t

Configuration for differential comparator and LPD mode.

Enumerator
NRF_VREGAO1V8_CFGDYNAMIC_DCMP_AUTO 

Auto.

NRF_VREGAO1V8_CFGDYNAMIC_DCMP_DISABLED 

Disabled.

NRF_VREGAO1V8_CFGDYNAMIC_DCMP_ENABLED 

Enabled.

◆ nrf_vregao1v8_dft_atb0_selmux_t

Select multiplexer for ATB0.

Enumerator
NRF_VREGAO1V8_DFT_ATB0_SELMUX_SPARE0 

HiZ.

NRF_VREGAO1V8_DFT_ATB0_SELMUX_IBPSR_8U 

Internal 8uA current reference.

NRF_VREGAO1V8_DFT_ATB0_SELMUX_VDD_SW_1V8 

VDD_SW_1V8.

NRF_VREGAO1V8_DFT_ATB0_SELMUX_IBPP_50NA 

IBPP_50N.

NRF_VREGAO1V8_DFT_ATB0_SELMUX_VSS 

Vss.

◆ nrf_vregao1v8_dft_atb1_selmux_t

Select multiplexer for ATB1.

Enumerator
NRF_VREGAO1V8_DFT_ATB1_SELMUX_SPARE0 

HiZ.

NRF_VREGAO1V8_DFT_ATB1_SELMUX_VDD_1V8_FB 

Internal direct feedback voltage.

NRF_VREGAO1V8_DFT_ATB1_SELMUX_VREF_0V9_DVT 

VREF_0V9_DVT.

NRF_VREGAO1V8_DFT_ATB1_SELMUX_BUFFERED_VREF_0V9 

Buffered VREF_0V9.

NRF_VREGAO1V8_DFT_ATB1_SELMUX_BUFFERED_VFB_0V9 

Buffered VFB_0V9.

◆ nrf_vregao1v8_dft_dtb0_selmux_t

Select multiplexer for DTB0.

Enumerator
NRF_VREGAO1V8_DFT_DTB0_SELMUX_PWRUP_IBPP 

PWRUP_IBPP.

NRF_VREGAO1V8_DFT_DTB0_SELMUX_PWRUP_IBPSR 

PWRUP_IBPSR.

NRF_VREGAO1V8_DFT_DTB0_SELMUX_MODE_LP 

MODE_LP.

NRF_VREGAO1V8_DFT_DTB0_SELMUX_VOUT_CMP 

VOUTCMP.

◆ nrf_vregao1v8_dft_dtb1_selmux_t

Select multiplexer for DTB1.

Enumerator
NRF_VREGAO1V8_DFT_DTB1_SELMUX_SETTLED_IBPP 

Settled IBPP.

NRF_VREGAO1V8_DFT_DTB1_SELMUX_READY_IBPSR 

READY_IBPSR.

NRF_VREGAO1V8_DFT_DTB1_SELMUX_MODE_ULP 

MODE_ULP.

NRF_VREGAO1V8_DFT_DTB1_SELMUX_VOUT_CMPD 

VOUTCMPD.

◆ nrf_vregao1v8_dft_dtb2_selmux_t

Select multiplexer for DTB2.

Enumerator
NRF_VREGAO1V8_DFT_DTB2_SELMUX_PWRUP_VREG_LDO 

PWRUP_VREG_LDO.

NRF_VREGAO1V8_DFT_DTB2_SELMUX_SETTLED_IBPSR 

SETTLED_IBPSR.

NRF_VREGAO1V8_DFT_DTB2_SELMUX_SETTLED_LDO 

SETTLED_LDO.

NRF_VREGAO1V8_DFT_DTB2_SELMUX_VOUT_CMPS 

VOUTCMPS.

◆ nrf_vregao1v8_dft_dtb3_selmux_t

Select multiplexer for DTB3.

Enumerator
NRF_VREGAO1V8_DFT_DTB3_SELMUX_SET_TIMER 

SET_TIMER.

NRF_VREGAO1V8_DFT_DTB3_SELMUX_SETTLED_MBIAS 

SETTLED_MBIAS.

NRF_VREGAO1V8_DFT_DTB3_SELMUX_READY_LDO 

READY_LDO.

NRF_VREGAO1V8_DFT_DTB3_SELMUX_ICMP_5MA 

ICMP_5MA.

◆ nrf_vregao1v8_double_bias_t

Double bias current configuration.

Enumerator
NRF_VREGAO1V8_CFGDYNAMIC_DOUBLE_BIAS_AUTO 

Auto.

NRF_VREGAO1V8_CFGDYNAMIC_DOUBLE_BIAS_DISABLED 

Disabled.

NRF_VREGAO1V8_CFGDYNAMIC_DOUBLE_BIAS_ENABLED 

Enabled.

◆ nrf_vregao1v8_event_t

VREGAO1V8 events.

Enumerator
NRF_VREGAO1V8_EVENT_READY 

Power up done.

NRF_VREGAO1V8_EVENT_SETTLED 

Settled flag for MODE handshake.

NRF_VREGAO1V8_EVENT_IOUTCMP 

Analog current comparator.

NRF_VREGAO1V8_EVENT_LP2HP 

Current consumption above threshold.

NRF_VREGAO1V8_EVENT_HP2LP 

Current consumption below threshold.

◆ nrf_vregao1v8_ilim_low_t

Current limit low configuration.

Enumerator
NRF_VREGAO1V8_CFGDYNAMIC_ILIM_LOW_DISABLED 

Disabled.

NRF_VREGAO1V8_CFGDYNAMIC_ILIM_LOW_ENABLED 

Enabled.

◆ nrf_vregao1v8_int_mask_t

VREGAO1V8 interrupts.

Enumerator
NRF_VREGAO1V8_INT_READY_MASK 

Interrupt on READY.

NRF_VREGAO1V8_INT_SETTLED_MASK 

Interrupt on SETTLED.

NRF_VREGAO1V8_INT_IOUTCMP_MASK 

Interrupt on IOUTCMP.

NRF_VREGAO1V8_INT_LP2HP_MASK 

Interrupt on LP2HP.

NRF_VREGAO1V8_INT_HP2LP_MASK 

Interrupt on HP2LP.

◆ nrf_vregao1v8_mode_t

Voltage regulator mode.

Enumerator
NRF_VREGAO1V8_MODE_AUTO 

Automatically handled by the peripheral.

NRF_VREGAO1V8_MODE_HIGH_POWER 

High power mode.

NRF_VREGAO1V8_MODE_LP_REFRESH 

Low power refresh.

NRF_VREGAO1V8_MODE_ULP_REFRESH 

Ultra-low power refresh mode.

NRF_VREGAO1V8_MODE_LP_REFRESH_DIFF 

Low power refresh differential 5v0 and 1v8.

◆ nrf_vregao1v8_status_t

STATUS register states.

Enumerator
NRF_VREGAO1V8_STATUS_HIGH_POWER 

High power mode.

NRF_VREGAO1V8_STATUS_LP_REFRESH 

Low power refresh mode.

NRF_VREGAO1V8_STATUS_ULP_REFRESH 

ULP refresh mode.

NRF_VREGAO1V8_STATUS_LPR_DIFF 

Low Power Refresh Differential 5v0 and 1v8.

◆ nrf_vregao1v8_statusana_mask_t

STATUSANA register bit masks.

Enumerator
NRF_VREGAO1V8_STATUSANA_READY_MASK 

Current value of READY signal.

NRF_VREGAO1V8_STATUSANA_SETTLED_MASK 

Current value of SETTLED signal.

NRF_VREGAO1V8_STATUSANA_IOUTCMP_MASK 

Current value of IOUTCMP signal.

◆ nrf_vregao1v8_trim_lpdiff_t

Low power differential mode output comparator trimming values.

Enumerator
NRF_VREGAO1V8_TRIM_LPDIFF_21MV 

21mV.

NRF_VREGAO1V8_TRIM_LPDIFF_27MV 

27mV.

NRF_VREGAO1V8_TRIM_LPDIFF_33MV 

33mV.

NRF_VREGAO1V8_TRIM_LPDIFF_39MV 

39mV.

Function Documentation

◆ nrf_vregao1v8_config_dynamic_get()

NRF_STATIC_INLINE nrf_vregao1v8_config_dynamic_t nrf_vregao1v8_config_dynamic_get ( NRF_VREGAO1V8_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_vregao1v8_config_dynamic_set()

NRF_STATIC_INLINE void nrf_vregao1v8_config_dynamic_set ( NRF_VREGAO1V8_Type *  p_reg,
nrf_vregao1v8_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_vregao1v8_config_static_get()

NRF_STATIC_INLINE nrf_vregao1v8_config_static_t nrf_vregao1v8_config_static_get ( NRF_VREGAO1V8_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_vregao1v8_config_static_set()

NRF_STATIC_INLINE void nrf_vregao1v8_config_static_set ( NRF_VREGAO1V8_Type *  p_reg,
nrf_vregao1v8_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_vregao1v8_dft_atb0_config_set()

NRF_STATIC_INLINE void nrf_vregao1v8_dft_atb0_config_set ( NRF_VREGAO1V8_Type *  p_reg,
nrf_vregao1v8_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_vregao1v8_dft_atb1_config_set()

NRF_STATIC_INLINE void nrf_vregao1v8_dft_atb1_config_set ( NRF_VREGAO1V8_Type *  p_reg,
nrf_vregao1v8_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_vregao1v8_dft_dtb0_config_set()

NRF_STATIC_INLINE void nrf_vregao1v8_dft_dtb0_config_set ( NRF_VREGAO1V8_Type *  p_reg,
nrf_vregao1v8_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_vregao1v8_dft_dtb1_config_set()

NRF_STATIC_INLINE void nrf_vregao1v8_dft_dtb1_config_set ( NRF_VREGAO1V8_Type *  p_reg,
nrf_vregao1v8_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_vregao1v8_dft_dtb2_config_set()

NRF_STATIC_INLINE void nrf_vregao1v8_dft_dtb2_config_set ( NRF_VREGAO1V8_Type *  p_reg,
nrf_vregao1v8_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_vregao1v8_dft_dtb3_config_set()

NRF_STATIC_INLINE void nrf_vregao1v8_dft_dtb3_config_set ( NRF_VREGAO1V8_Type *  p_reg,
nrf_vregao1v8_dft_dtb3_selmux_t  selmux,
bool  pwrup_deltest,
bool  enable 
)

Function for configuring Digital Test Bus 3 (DTB3).

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

◆ nrf_vregao1v8_dft_tcfg_config_set()

NRF_STATIC_INLINE void nrf_vregao1v8_dft_tcfg_config_set ( NRF_VREGAO1V8_Type *  p_reg,
nrf_vregao1v8_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_vregao1v8_event_address_get()

NRF_STATIC_INLINE uint32_t nrf_vregao1v8_event_address_get ( NRF_VREGAO1V8_Type const *  p_reg,
nrf_vregao1v8_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_vregao1v8_event_check()

NRF_STATIC_INLINE bool nrf_vregao1v8_event_check ( NRF_VREGAO1V8_Type const *  p_reg,
nrf_vregao1v8_event_t  event 
)

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

NRF_STATIC_INLINE void nrf_vregao1v8_event_clear ( NRF_VREGAO1V8_Type *  p_reg,
nrf_vregao1v8_event_t  event 
)

Function for clearing the specified VREGAO1V8 event.

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

◆ nrf_vregao1v8_int_disable()

NRF_STATIC_INLINE void nrf_vregao1v8_int_disable ( NRF_VREGAO1V8_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_vregao1v8_int_mask_t values for bit masking.

◆ nrf_vregao1v8_int_enable()

NRF_STATIC_INLINE void nrf_vregao1v8_int_enable ( NRF_VREGAO1V8_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_vregao1v8_int_mask_t values for bit masking.

◆ nrf_vregao1v8_int_enable_check()

NRF_STATIC_INLINE uint32_t nrf_vregao1v8_int_enable_check ( NRF_VREGAO1V8_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_vregao1v8_int_mask_t values for bit masking.
Returns
Mask of enabled interrupts.

◆ nrf_vregao1v8_int_pending_get()

NRF_STATIC_INLINE uint32_t nrf_vregao1v8_int_pending_get ( NRF_VREGAO1V8_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_vregao1v8_int_mask_t values for bit masking.

◆ nrf_vregao1v8_ithreshold_get()

NRF_STATIC_INLINE uint8_t nrf_vregao1v8_ithreshold_get ( NRF_VREGAO1V8_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_vregao1v8_ithreshold_set()

NRF_STATIC_INLINE void nrf_vregao1v8_ithreshold_set ( NRF_VREGAO1V8_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_vregao1v8_mirror_lock_set()

NRF_STATIC_INLINE void nrf_vregao1v8_mirror_lock_set ( NRF_VREGAO1V8_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_vregao1v8_mode_get()

NRF_STATIC_INLINE nrf_vregao1v8_mode_t nrf_vregao1v8_mode_get ( NRF_VREGAO1V8_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_vregao1v8_mode_set()

NRF_STATIC_INLINE void nrf_vregao1v8_mode_set ( NRF_VREGAO1V8_Type *  p_reg,
nrf_vregao1v8_mode_t  mode 
)

Function for setting voltage regulator mode.

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

◆ nrf_vregao1v8_override_config_set()

NRF_STATIC_INLINE void nrf_vregao1v8_override_config_set ( NRF_VREGAO1V8_Type *  p_reg,
bool  enable,
uint8_t  double_bias,
uint8_t  dcmp 
)

Function for override the dynamic config signals to the analog module.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]enableTrue to enable override and false to disable.
[in]double_biasOverride value for double bias.
[in]dcmpOverride value for DCMP.

◆ nrf_vregao1v8_override_set()

NRF_STATIC_INLINE void nrf_vregao1v8_override_set ( NRF_VREGAO1V8_Type *  p_reg,
nrf_vregao1v8_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_vregao1v8_status_get()

NRF_STATIC_INLINE nrf_vregao1v8_status_t nrf_vregao1v8_status_get ( NRF_VREGAO1V8_Type const *  p_reg)

Function for getting VREGAO1V8 status register.

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

◆ nrf_vregao1v8_statusana_get()

NRF_STATIC_INLINE uint32_t nrf_vregao1v8_statusana_get ( NRF_VREGAO1V8_Type const *  p_reg)

Function for getting VREGAO1V8 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_vregao1v8_statusana_mask_t values for bit masking.

◆ nrf_vregao1v8_trim_iref_get()

NRF_STATIC_INLINE uint8_t nrf_vregao1v8_trim_iref_get ( NRF_VREGAO1V8_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_vregao1v8_trim_iref_set()

NRF_STATIC_INLINE void nrf_vregao1v8_trim_iref_set ( NRF_VREGAO1V8_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_vregao1v8_trim_lowpower_get()

NRF_STATIC_INLINE uint8_t nrf_vregao1v8_trim_lowpower_get ( NRF_VREGAO1V8_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_vregao1v8_trim_lowpower_set()

NRF_STATIC_INLINE void nrf_vregao1v8_trim_lowpower_set ( NRF_VREGAO1V8_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 -20mV +/- 8mV steps.

◆ nrf_vregao1v8_trim_lpdiff_get()

NRF_STATIC_INLINE nrf_vregao1v8_trim_lpdiff_t nrf_vregao1v8_trim_lpdiff_get ( NRF_VREGAO1V8_Type const *  p_reg)

Function for getting low power differential mode output comparator trimming.

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

◆ nrf_vregao1v8_trim_lpdiff_set()

NRF_STATIC_INLINE void nrf_vregao1v8_trim_lpdiff_set ( NRF_VREGAO1V8_Type *  p_reg,
nrf_vregao1v8_trim_lpdiff_t  val 
)

Function for setting low power differential mode output comparator 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 0mV +/- 11.8mV steps.

◆ nrf_vregao1v8_trim_vref_get()

NRF_STATIC_INLINE uint8_t nrf_vregao1v8_trim_vref_get ( NRF_VREGAO1V8_Type const *  p_reg)

Function for getting reference voltage trim.

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

◆ nrf_vregao1v8_trim_vref_set()

NRF_STATIC_INLINE void nrf_vregao1v8_trim_vref_set ( NRF_VREGAO1V8_Type *  p_reg,
uint8_t  val 
)

Function for setting reference voltage trim.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]valVoltage trimming value. The value is 2's complement value of -8% to +7%. Default 0%.

◆ nrf_vregao1v8_vout_get()

NRF_STATIC_INLINE uint8_t nrf_vregao1v8_vout_get ( NRF_VREGAO1V8_Type const *  p_reg,
nrf_vregao1v8_vout_t  vout 
)

Function for getting output voltage.

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

◆ nrf_vregao1v8_vout_set()

NRF_STATIC_INLINE void nrf_vregao1v8_vout_set ( NRF_VREGAO1V8_Type *  p_reg,
nrf_vregao1v8_vout_t  vout,
uint8_t  val 
)

Function for setting output voltage.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]voutVout target.
[in]valOutput voltage value. The value is 1.72V + 0.02V steps.

Documentation feedback | Developer Zone | Subscribe | Updated