nrfx 3.3
Data Structures | Enumerations | Functions
Voltage scaling 0.8V Voltage Regulator HAL

Hardware access layer for managing the voltage scaling 0.8V Voltage Regulator (VREGVS0V8). More...

Data Structures

struct  nrf_vregvs0v8_config_static_t
 Fields for static configuration structure. More...
 
struct  nrf_vregvs0v8_config_dynamic_t
 Dynamic configuration structure. More...
 
struct  nrf_vregvs0v8_tcfg_t
 Test mode configuration. More...
 

Enumerations

enum  nrf_vregvs0v8_event_t {
  NRF_VREGVS0V8_EVENT_READY = offsetof(NRF_VREGVS0V8_Type, EVENTS_READY) ,
  NRF_VREGVS0V8_EVENT_SETTLED = offsetof(NRF_VREGVS0V8_Type, EVENTS_SETTLED) ,
  NRF_VREGVS0V8_EVENT_IOUT_CMP = offsetof(NRF_VREGVS0V8_Type, EVENTS_IOUTCMP) ,
  NRF_VREGVS0V8_EVENT_LP2HP = offsetof(NRF_VREGVS0V8_Type, EVENTS_LP2HP) ,
  NRF_VREGVS0V8_EVENT_HP2LP = offsetof(NRF_VREGVS0V8_Type, EVENTS_HP2LP)
}
 VREGVS0V8 events. More...
 
enum  nrf_vregvs0v8_int_mask_t {
  NRF_VREGVS0V8_INT_READY_MASK = VREGVS0V8_INTEN_READY_Msk ,
  NRF_VREGVS0V8_INT_SETTLED_MASK = VREGVS0V8_INTEN_SETTLED_Msk ,
  NRF_VREGVS0V8_INT_IOUT_CMP_MASK = VREGVS0V8_INTEN_IOUTCMP_Msk ,
  NRF_VREGVS0V8_INT_LP2HP_MASK = VREGVS0V8_INTEN_LP2HP_Msk ,
  NRF_VREGVS0V8_INT_HP2LP_MASK = VREGVS0V8_INTEN_HP2LP_Msk
}
 VREGVS0V8 interrupts. More...
 
enum  nrf_vregvs0v8_status_t {
  NRF_VREGVS0V8_STATUS_HIGH_POWER = VREGVS0V8_STATUS_MODE_HighPower ,
  NRF_VREGVS0V8_STATUS_LOW_POWER = VREGVS0V8_STATUS_MODE_LowPower ,
  NRF_VREGVS0V8_STATUS_ULP_REFRESH = VREGVS0V8_STATUS_MODE_UltraLowPowerRefresh
}
 STATUS register states. More...
 
enum  nrf_vregvs0v8_statusana_mask_t {
  NRF_VREGVS0V8_STATUSANA_READY_MASK = VREGVS0V8_STATUSANA_READY_Msk ,
  NRF_VREGVS0V8_STATUSANA_SETTLED_MASK = VREGVS0V8_STATUSANA_SETTLED_Msk ,
  NRF_VREGVS0V8_STATUSANA_IOUT_CMP_MASK = VREGVS0V8_STATUSANA_IOUTCMP_Msk
}
 STATUSANA register bit masks. More...
 
enum  nrf_vregvs0v8_ilimval_t {
  NRF_VREGVS0V8_CFGDYNAMIC_ILIMVAL_NORMAL = VREGVS0V8_CONFIG_CFGDYNAMIC_ILIMVAL_Normal ,
  NRF_VREGVS0V8_CFGDYNAMIC_ILIMVAL_HIGH = VREGVS0V8_CONFIG_CFGDYNAMIC_ILIMVAL_IlimHigh ,
  NRF_VREGVS0V8_CFGDYNAMIC_ILIMVAL_MID = VREGVS0V8_CONFIG_CFGDYNAMIC_ILIMVAL_IlimMid ,
  NRF_VREGVS0V8_CFGDYNAMIC_ILIMVAL_LOW = VREGVS0V8_CONFIG_CFGDYNAMIC_ILIMVAL_IlimLow
}
 Current limit configuration. More...
 
enum  nrf_vregvs0v8_mode_t {
  NRF_VREGVS0V8_MODE_AUTO = VREGVS0V8_MODE_MODE_Auto ,
  NRF_VREGVS0V8_MODE_HIGH_POWER = VREGVS0V8_MODE_MODE_HighPower ,
  NRF_VREGVS0V8_MODE_LOW_POWER = VREGVS0V8_MODE_MODE_LowPower ,
  NRF_VREGVS0V8_MODE_ULP_REFRESH = VREGVS0V8_MODE_MODE_UltraLowPowerRefresh
}
 Voltage regulator mode. More...
 
enum  nrf_vregvs0v8_analog_signal_t {
  NRF_VREGVS0V8_ANALOG_SIGNAL_PWRUP ,
  NRF_VREGVS0V8_ANALOG_SIGNAL_RETAIN ,
  NRF_VREGVS0V8_ANALOG_SIGNAL_MODE_LP ,
  NRF_VREGVS0V8_ANALOG_SIGNAL_MODE_ULPR ,
  NRF_VREGVS0V8_ANALOG_SIGNAL_CFG ,
  NRF_VREGVS0V8_ANALOG_SIGNAL_READY ,
  NRF_VREGVS0V8_ANALOG_SIGNAL_SETTLED ,
  NRF_VREGVS0V8_ANALOG_SIGNAL_IOUT_CMP
}
 Analog signal to be overridden. More...
 
enum  nrf_vregvs0v8_dft_atb0_selmux_t {
  NRF_VREGVS0V8_DFT_ATB0_SELMUX_EXT_VREF = VREGVS0V8_DFT_ATB0CONFIG_SELMUX_ExtVref ,
  NRF_VREGVS0V8_DFT_ATB0_SELMUX_IBPP_50NA = VREGVS0V8_DFT_ATB0CONFIG_SELMUX_Ibpp50n ,
  NRF_VREGVS0V8_DFT_ATB0_SELMUX_IBPSR_4UA = VREGVS0V8_DFT_ATB0CONFIG_SELMUX_Ibpsr4u ,
  NRF_VREGVS0V8_DFT_ATB0_SELMUX_SUM = VREGVS0V8_DFT_ATB0CONFIG_SELMUX_Ibpp50nIbpsr4u
}
 Select multiplexer for ATB0. More...
 
enum  nrf_vregvs0v8_dft_atb1_selmux_t {
  NRF_VREGVS0V8_DFT_ATB1_SELMUX_VSS = VREGVS0V8_DFT_ATB1CONFIG_SELMUX_VSS ,
  NRF_VREGVS0V8_DFT_ATB1_SELMUX_BUFFERED_HP_VREF = VREGVS0V8_DFT_ATB1CONFIG_SELMUX_BufferedHPvref ,
  NRF_VREGVS0V8_DFT_ATB1_SELMUX_VDD_VS_0V8 = VREGVS0V8_DFT_ATB1CONFIG_SELMUX_VDDVS0V8 ,
  NRF_VREGVS0V8_DFT_ATB1_SELMUX_IBPSR_4UA = VREGVS0V8_DFT_ATB1CONFIG_SELMUX_Ibpsr4u
}
 Select multiplexer for ATB1. More...
 
enum  nrf_vregvs0v8_dft_dtb0_selmux_t {
  NRF_VREGVS0V8_DFT_DTB0_SELMUX_SPARE0 = VREGVS0V8_DFT_DTB0CONFIG_SELMUX_Spare0 ,
  NRF_VREGVS0V8_DFT_DTB0_SELMUX_REFRESH_ULPR = VREGVS0V8_DFT_DTB0CONFIG_SELMUX_RefreshULPR ,
  NRF_VREGVS0V8_DFT_DTB0_SELMUX_SETTLED_IBPSR = VREGVS0V8_DFT_DTB0CONFIG_SELMUX_SettledIBPSR ,
  NRF_VREGVS0V8_DFT_DTB0_SELMUX_SPARE1 = VREGVS0V8_DFT_DTB0CONFIG_SELMUX_Spare1 ,
  NRF_VREGVS0V8_DFT_DTB0_SELMUX_CURR_CMP = VREGVS0V8_DFT_DTB0CONFIG_SELMUX_CurrCmp ,
  NRF_VREGVS0V8_DFT_DTB0_SELMUX_REQ_MODE_LP = VREGVS0V8_DFT_DTB0CONFIG_SELMUX_ReqModeLP ,
  NRF_VREGVS0V8_DFT_DTB0_SELMUX_REQ_MODE_ULPR = VREGVS0V8_DFT_DTB0CONFIG_SELMUX_RefreshULPR ,
  NRF_VREGVS0V8_DFT_DTB0_SELMUX_CAL_CMP = VREGVS0V8_DFT_DTB0CONFIG_SELMUX_CalCmp
}
 Select multiplexer for DTB0. More...
 
enum  nrf_vregvs0v8_dft_dtb1_selmux_t {
  NRF_VREGVS0V8_DFT_DTB1_SELMUX_VREF_TIMER_ACK = VREGVS0V8_DFT_DTB1CONFIG_SELMUX_VrefTimerAck ,
  NRF_VREGVS0V8_DFT_DTB1_SELMUX_REFRESH_TIMER_ACK = VREGVS0V8_DFT_DTB1CONFIG_SELMUX_RefreshTimerAck ,
  NRF_VREGVS0V8_DFT_DTB1_SELMUX_READY_IBPSR = VREGVS0V8_DFT_DTB1CONFIG_SELMUX_ReadyIBPSR ,
  NRF_VREGVS0V8_DFT_DTB1_SELMUX_READY_HP = VREGVS0V8_DFT_DTB1CONFIG_SELMUX_ReadyHP ,
  NRF_VREGVS0V8_DFT_DTB1_SELMUX_READY_LP = VREGVS0V8_DFT_DTB1CONFIG_SELMUX_ReadyLP ,
  NRF_VREGVS0V8_DFT_DTB1_SELMUX_CANCEL_LP_ACK = VREGVS0V8_DFT_DTB1CONFIG_SELMUX_CancelLPAck ,
  NRF_VREGVS0V8_DFT_DTB1_SELMUX_READY_IBPP_5NA = VREGVS0V8_DFT_DTB1CONFIG_SELMUX_ReadyIBPP5n ,
  NRF_VREGVS0V8_DFT_DTB1_SELMUX_SETTLED = VREGVS0V8_DFT_DTB1CONFIG_SELMUX_Settled
}
 Select multiplexer for DTB1. More...
 
enum  nrf_vregvs0v8_dft_dtb2_selmux_t {
  NRF_VREGVS0V8_DFT_DTB2_SELMUX_VREF_TIMER_REQ = VREGVS0V8_DFT_DTB2CONFIG_SELMUX_VrefTimerReq ,
  NRF_VREGVS0V8_DFT_DTB2_SELMUX_REFRESH_TIMER_REQ = VREGVS0V8_DFT_DTB2CONFIG_SELMUX_RefreshTimerReq ,
  NRF_VREGVS0V8_DFT_DTB2_SELMUX_PWRUP_IBPSR = VREGVS0V8_DFT_DTB2CONFIG_SELMUX_PwrupIBPSR ,
  NRF_VREGVS0V8_DFT_DTB2_SELMUX_PWRUP_HP = VREGVS0V8_DFT_DTB2CONFIG_SELMUX_PwrupHP ,
  NRF_VREGVS0V8_DFT_DTB2_SELMUX_PWRUP_LP = VREGVS0V8_DFT_DTB2CONFIG_SELMUX_PwrupLP ,
  NRF_VREGVS0V8_DFT_DTB2_SELMUX_CANCEL_LP = VREGVS0V8_DFT_DTB2CONFIG_SELMUX_CancelLP ,
  NRF_VREGVS0V8_DFT_DTB2_SELMUX_PWRUP_IBPP_5NA = VREGVS0V8_DFT_DTB2CONFIG_SELMUX_PwrupIBPP5n ,
  NRF_VREGVS0V8_DFT_DTB2_SELMUX_SPARE0 = VREGVS0V8_DFT_DTB2CONFIG_SELMUX_Spare0
}
 Select multiplexer for DTB2. More...
 

Functions

NRF_STATIC_INLINE void nrf_vregvs0v8_event_clear (NRF_VREGVS0V8_Type *p_reg, nrf_vregvs0v8_event_t event)
 Function for clearing the specified VREGVS0V8 event.
 
NRF_STATIC_INLINE bool nrf_vregvs0v8_event_check (NRF_VREGVS0V8_Type const *p_reg, nrf_vregvs0v8_event_t event)
 Function for retrieving the state of the VREGVS0V8 event.
 
NRF_STATIC_INLINE uint32_t nrf_vregvs0v8_event_address_get (NRF_VREGVS0V8_Type const *p_reg, nrf_vregvs0v8_event_t event)
 Function for getting the address of the specified event register.
 
NRF_STATIC_INLINE void nrf_vregvs0v8_int_enable (NRF_VREGVS0V8_Type *p_reg, uint32_t mask)
 Function for enabling specified interrupts.
 
NRF_STATIC_INLINE void nrf_vregvs0v8_int_disable (NRF_VREGVS0V8_Type *p_reg, uint32_t mask)
 Function for disabling specified interrupts.
 
NRF_STATIC_INLINE uint32_t nrf_vregvs0v8_int_enable_check (NRF_VREGVS0V8_Type const *p_reg, uint32_t mask)
 Function for checking if the specified interrupts are enabled.
 
NRF_STATIC_INLINE uint32_t nrf_vregvs0v8_int_pending_get (NRF_VREGVS0V8_Type const *p_reg)
 Function for retrieving the state of pending interrupts.
 
NRF_STATIC_INLINE nrf_vregvs0v8_status_t nrf_vregvs0v8_status_get (NRF_VREGVS0V8_Type const *p_reg)
 Function for getting VREGVS0V8 status register.
 
NRF_STATIC_INLINE uint32_t nrf_vregvs0v8_statusana_get (NRF_VREGVS0V8_Type const *p_reg)
 Function for getting VREGVS0V8 status of the analog module output signals.
 
NRF_STATIC_INLINE void nrf_vregvs0v8_config_static_set (NRF_VREGVS0V8_Type *p_reg, nrf_vregvs0v8_config_static_t cfg)
 Function for setting static and dynamic voltage regulator configuration.
 
NRF_STATIC_INLINE nrf_vregvs0v8_config_static_t nrf_vregvs0v8_config_static_get (NRF_VREGVS0V8_Type const *p_reg)
 Function for getting static and dynamic voltage regulator configuration.
 
NRF_STATIC_INLINE void nrf_vregvs0v8_config_dynamic_set (NRF_VREGVS0V8_Type *p_reg, nrf_vregvs0v8_config_dynamic_t cfg)
 Function for setting voltage regulator dynamic configuration.
 
NRF_STATIC_INLINE nrf_vregvs0v8_config_dynamic_t nrf_vregvs0v8_config_dynamic_get (NRF_VREGVS0V8_Type const *p_reg)
 Function for getting voltage regulator dynamic configuration.
 
NRF_STATIC_INLINE void nrf_vregvs0v8_trim_iref_set (NRF_VREGVS0V8_Type *p_reg, uint8_t val)
 Function for setting current reference trimming.
 
NRF_STATIC_INLINE uint8_t nrf_vregvs0v8_trim_iref_get (NRF_VREGVS0V8_Type const *p_reg)
 Function for getting current reference trimming.
 
NRF_STATIC_INLINE void nrf_vregvs0v8_trim_highpower_set (NRF_VREGVS0V8_Type *p_reg, uint8_t val)
 Function for setting high power mode output voltage offset trimming.
 
NRF_STATIC_INLINE uint8_t nrf_vregvs0v8_trim_highpower_get (NRF_VREGVS0V8_Type const *p_reg)
 Function for getting high power mode output voltage offset trimming.
 
NRF_STATIC_INLINE void nrf_vregvs0v8_trim_lowpower_set (NRF_VREGVS0V8_Type *p_reg, uint8_t val)
 Function for setting low power mode output voltage offset trimming.
 
NRF_STATIC_INLINE uint8_t nrf_vregvs0v8_trim_lowpower_get (NRF_VREGVS0V8_Type const *p_reg)
 Function for getting low power mode output voltage offset trimming.
 
NRF_STATIC_INLINE void nrf_vregvs0v8_trim_ulpr_set (NRF_VREGVS0V8_Type *p_reg, uint8_t val)
 Function for setting ultra low power refresh comparator offset trimming.
 
NRF_STATIC_INLINE uint8_t nrf_vregvs0v8_trim_ulpr_get (NRF_VREGVS0V8_Type const *p_reg)
 Function for getting ultra low power refresh comparator offset trimming.
 
NRF_STATIC_INLINE void nrf_vregvs0v8_mirror_lock_set (NRF_VREGVS0V8_Type *p_reg, bool lock)
 Function for locking mirrored registers.
 
NRF_STATIC_INLINE void nrf_vregvs0v8_vout_hp_set (NRF_VREGVS0V8_Type *p_reg, uint8_t val)
 Function for setting high power mode output voltage.
 
NRF_STATIC_INLINE uint8_t nrf_vregvs0v8_vout_hp_get (NRF_VREGVS0V8_Type const *p_reg)
 Function for getting high power mode output voltage.
 
NRF_STATIC_INLINE void nrf_vregvs0v8_vout_lp_set (NRF_VREGVS0V8_Type *p_reg, uint8_t val)
 Function for setting low power mode output voltage.
 
NRF_STATIC_INLINE uint8_t nrf_vregvs0v8_vout_lp_get (NRF_VREGVS0V8_Type const *p_reg)
 Function for getting low power mode output voltage.
 
NRF_STATIC_INLINE void nrf_vregvs0v8_mode_set (NRF_VREGVS0V8_Type *p_reg, nrf_vregvs0v8_mode_t mode)
 Function for setting voltage regulator mode.
 
NRF_STATIC_INLINE nrf_vregvs0v8_mode_t nrf_vregvs0v8_mode_get (NRF_VREGVS0V8_Type const *p_reg)
 Function for getting voltage regulator mode.
 
NRF_STATIC_INLINE void nrf_vregvs0v8_ithreshold_set (NRF_VREGVS0V8_Type *p_reg, uint8_t thr)
 Function for setting current threshold for mode transition.
 
NRF_STATIC_INLINE uint8_t nrf_vregvs0v8_ithreshold_get (NRF_VREGVS0V8_Type const *p_reg)
 Function for getting current threshold for mode transition.
 
NRF_STATIC_INLINE void nrf_vregvs0v8_override_set (NRF_VREGVS0V8_Type *p_reg, nrf_vregvs0v8_analog_signal_t signal, bool enable, uint8_t val)
 Function for override signal to the analog module.
 
NRF_STATIC_INLINE void nrf_vregvs0v8_dft_atb0_config_set (NRF_VREGVS0V8_Type *p_reg, nrf_vregvs0v8_dft_atb0_selmux_t selmux, bool enable)
 Function for configuring Analog Test Bus 0 (ATB0).
 
NRF_STATIC_INLINE void nrf_vregvs0v8_dft_atb1_config_set (NRF_VREGVS0V8_Type *p_reg, nrf_vregvs0v8_dft_atb1_selmux_t selmux, bool enable)
 Function for configuring Analog Test Bus 1 (ATB1).
 
NRF_STATIC_INLINE void nrf_vregvs0v8_dft_dtb0_config_set (NRF_VREGVS0V8_Type *p_reg, nrf_vregvs0v8_dft_dtb0_selmux_t selmux, bool enable)
 Function for configuring Digital Test Bus 0 (DTB0).
 
NRF_STATIC_INLINE void nrf_vregvs0v8_dft_dtb1_config_set (NRF_VREGVS0V8_Type *p_reg, nrf_vregvs0v8_dft_dtb1_selmux_t selmux, bool enable)
 Function for configuring Digital Test Bus 1 (DTB1).
 
NRF_STATIC_INLINE void nrf_vregvs0v8_dft_dtb2_config_set (NRF_VREGVS0V8_Type *p_reg, nrf_vregvs0v8_dft_dtb2_selmux_t selmux, bool enable)
 Function for configuring Digital Test Bus 2 (DTB2).
 
NRF_STATIC_INLINE void nrf_vregvs0v8_dft_dtb3_config_set (NRF_VREGVS0V8_Type *p_reg, bool enable)
 Function for configuring Digital Test Bus 3 (DTB3).
 
NRF_STATIC_INLINE void nrf_vregvs0v8_dft_tcfg_config_set (NRF_VREGVS0V8_Type *p_reg, nrf_vregvs0v8_tcfg_t tcfg)
 Function for configuring test mode.
 
NRF_STATIC_INLINE void nrf_vregvs0v8_dft_cal_set (NRF_VREGVS0V8_Type *p_reg, bool enable)
 Function for enabling or disabling calibration.
 
NRF_STATIC_INLINE bool nrf_vregvs0v8_dft_cal_cmp_check (NRF_VREGVS0V8_Type const *p_reg)
 Function for checking calibration compare.
 

Detailed Description

Hardware access layer for managing the voltage scaling 0.8V Voltage Regulator (VREGVS0V8).

Enumeration Type Documentation

◆ nrf_vregvs0v8_analog_signal_t

Analog signal to be overridden.

Enumerator
NRF_VREGVS0V8_ANALOG_SIGNAL_PWRUP 

Override PWRUP signal.

NRF_VREGVS0V8_ANALOG_SIGNAL_RETAIN 

Override RETAIN signal.

NRF_VREGVS0V8_ANALOG_SIGNAL_MODE_LP 

Override MODE LP signal.

NRF_VREGVS0V8_ANALOG_SIGNAL_MODE_ULPR 

Override MODE ULPR signal.

NRF_VREGVS0V8_ANALOG_SIGNAL_CFG 

Override CFG signal.

NRF_VREGVS0V8_ANALOG_SIGNAL_READY 

Override READY signal.

NRF_VREGVS0V8_ANALOG_SIGNAL_SETTLED 

Override SETTLED signal.

NRF_VREGVS0V8_ANALOG_SIGNAL_IOUT_CMP 

Override IOUTCMP signal.

◆ nrf_vregvs0v8_dft_atb0_selmux_t

Select multiplexer for ATB0.

Enumerator
NRF_VREGVS0V8_DFT_ATB0_SELMUX_EXT_VREF 

External Vref.

NRF_VREGVS0V8_DFT_ATB0_SELMUX_IBPP_50NA 

Internal 50uA current reference.

NRF_VREGVS0V8_DFT_ATB0_SELMUX_IBPSR_4UA 

Internal 4uA current reference.

NRF_VREGVS0V8_DFT_ATB0_SELMUX_SUM 

Sum both internal current references.

◆ nrf_vregvs0v8_dft_atb1_selmux_t

Select multiplexer for ATB1.

Enumerator
NRF_VREGVS0V8_DFT_ATB1_SELMUX_VSS 

VSS.

NRF_VREGVS0V8_DFT_ATB1_SELMUX_BUFFERED_HP_VREF 

Buffered HP Vref.

NRF_VREGVS0V8_DFT_ATB1_SELMUX_VDD_VS_0V8 

VDD_VS_0V8.

NRF_VREGVS0V8_DFT_ATB1_SELMUX_IBPSR_4UA 

Internal 4uA current reference.

◆ nrf_vregvs0v8_dft_dtb0_selmux_t

Select multiplexer for DTB0.

Enumerator
NRF_VREGVS0V8_DFT_DTB0_SELMUX_SPARE0 

None selected, logic 0.

NRF_VREGVS0V8_DFT_DTB0_SELMUX_REFRESH_ULPR 

Refresh ULPR.

NRF_VREGVS0V8_DFT_DTB0_SELMUX_SETTLED_IBPSR 

Settled IBPSR.

NRF_VREGVS0V8_DFT_DTB0_SELMUX_SPARE1 

None selected, logic 0.

NRF_VREGVS0V8_DFT_DTB0_SELMUX_CURR_CMP 

Current comparator output.

NRF_VREGVS0V8_DFT_DTB0_SELMUX_REQ_MODE_LP 

LP mode request.

NRF_VREGVS0V8_DFT_DTB0_SELMUX_REQ_MODE_ULPR 

ULPR mode request.

NRF_VREGVS0V8_DFT_DTB0_SELMUX_CAL_CMP 

Calibration comparator output.

◆ nrf_vregvs0v8_dft_dtb1_selmux_t

Select multiplexer for DTB1.

Enumerator
NRF_VREGVS0V8_DFT_DTB1_SELMUX_VREF_TIMER_ACK 

Vref timer acknowledge.

NRF_VREGVS0V8_DFT_DTB1_SELMUX_REFRESH_TIMER_ACK 

ULPR refresh timer acknowledge.

NRF_VREGVS0V8_DFT_DTB1_SELMUX_READY_IBPSR 

IBPSR ready signal.

NRF_VREGVS0V8_DFT_DTB1_SELMUX_READY_HP 

High power core ready signal.

NRF_VREGVS0V8_DFT_DTB1_SELMUX_READY_LP 

Low power core ready signal.

NRF_VREGVS0V8_DFT_DTB1_SELMUX_CANCEL_LP_ACK 

Low power core cancel acknowledge signal.

NRF_VREGVS0V8_DFT_DTB1_SELMUX_READY_IBPP_5NA 

BIAS_IBPP_5N ready signal.

NRF_VREGVS0V8_DFT_DTB1_SELMUX_SETTLED 

Settled signal.

◆ nrf_vregvs0v8_dft_dtb2_selmux_t

Select multiplexer for DTB2.

Enumerator
NRF_VREGVS0V8_DFT_DTB2_SELMUX_VREF_TIMER_REQ 

Vref timer request.

NRF_VREGVS0V8_DFT_DTB2_SELMUX_REFRESH_TIMER_REQ 

ULPR refresh timer request.

NRF_VREGVS0V8_DFT_DTB2_SELMUX_PWRUP_IBPSR 

IBPSR power up signal.

NRF_VREGVS0V8_DFT_DTB2_SELMUX_PWRUP_HP 

High power core power up signal.

NRF_VREGVS0V8_DFT_DTB2_SELMUX_PWRUP_LP 

Low power core power up signal.

NRF_VREGVS0V8_DFT_DTB2_SELMUX_CANCEL_LP 

Low power core cancel signal.

NRF_VREGVS0V8_DFT_DTB2_SELMUX_PWRUP_IBPP_5NA 

BIAS_IBPP_5N power up signal.

NRF_VREGVS0V8_DFT_DTB2_SELMUX_SPARE0 

None selected, logic 0.

◆ nrf_vregvs0v8_event_t

VREGVS0V8 events.

Enumerator
NRF_VREGVS0V8_EVENT_READY 

Power up done.

NRF_VREGVS0V8_EVENT_SETTLED 

Settled flag for MODE handshake.

NRF_VREGVS0V8_EVENT_IOUT_CMP 

Analog current comparator.

NRF_VREGVS0V8_EVENT_LP2HP 

Current consumption above threshold.

NRF_VREGVS0V8_EVENT_HP2LP 

Current consumption below threshold.

◆ nrf_vregvs0v8_ilimval_t

Current limit configuration.

Enumerator
NRF_VREGVS0V8_CFGDYNAMIC_ILIMVAL_NORMAL 

Normal operation, maximum 100mA.

NRF_VREGVS0V8_CFGDYNAMIC_ILIMVAL_HIGH 

High soft start limit, maximum 60mA.

NRF_VREGVS0V8_CFGDYNAMIC_ILIMVAL_MID 

WU soft start, maximum 30mA.

NRF_VREGVS0V8_CFGDYNAMIC_ILIMVAL_LOW 

Reset current limit, maximum 10mA.

◆ nrf_vregvs0v8_int_mask_t

VREGVS0V8 interrupts.

Enumerator
NRF_VREGVS0V8_INT_READY_MASK 

Interrupt on READY.

NRF_VREGVS0V8_INT_SETTLED_MASK 

Interrupt on SETTLED.

NRF_VREGVS0V8_INT_IOUT_CMP_MASK 

Interrupt on IOUTCMP.

NRF_VREGVS0V8_INT_LP2HP_MASK 

Interrupt on LP2HP.

NRF_VREGVS0V8_INT_HP2LP_MASK 

Interrupt on HP2LP.

◆ nrf_vregvs0v8_mode_t

Voltage regulator mode.

Enumerator
NRF_VREGVS0V8_MODE_AUTO 

Automatically handled by the peripheral.

NRF_VREGVS0V8_MODE_HIGH_POWER 

High power mode.

NRF_VREGVS0V8_MODE_LOW_POWER 

Low power mode.

NRF_VREGVS0V8_MODE_ULP_REFRESH 

Ultra-low power refresh mode.

◆ nrf_vregvs0v8_status_t

STATUS register states.

Enumerator
NRF_VREGVS0V8_STATUS_HIGH_POWER 

High power mode.

NRF_VREGVS0V8_STATUS_LOW_POWER 

Low power mode.

NRF_VREGVS0V8_STATUS_ULP_REFRESH 

ULP refresh mode.

◆ nrf_vregvs0v8_statusana_mask_t

STATUSANA register bit masks.

Enumerator
NRF_VREGVS0V8_STATUSANA_READY_MASK 

Current value of READY signal.

NRF_VREGVS0V8_STATUSANA_SETTLED_MASK 

Current value of SETTLED signal.

NRF_VREGVS0V8_STATUSANA_IOUT_CMP_MASK 

Current value of IOUTCMP signal.

Function Documentation

◆ nrf_vregvs0v8_config_dynamic_get()

NRF_STATIC_INLINE nrf_vregvs0v8_config_dynamic_t nrf_vregvs0v8_config_dynamic_get ( NRF_VREGVS0V8_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_vregvs0v8_config_dynamic_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_config_dynamic_set ( NRF_VREGVS0V8_Type *  p_reg,
nrf_vregvs0v8_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_vregvs0v8_config_static_get()

NRF_STATIC_INLINE nrf_vregvs0v8_config_static_t nrf_vregvs0v8_config_static_get ( NRF_VREGVS0V8_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_vregvs0v8_config_static_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_config_static_set ( NRF_VREGVS0V8_Type *  p_reg,
nrf_vregvs0v8_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_vregvs0v8_dft_atb0_config_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_dft_atb0_config_set ( NRF_VREGVS0V8_Type *  p_reg,
nrf_vregvs0v8_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_vregvs0v8_dft_atb1_config_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_dft_atb1_config_set ( NRF_VREGVS0V8_Type *  p_reg,
nrf_vregvs0v8_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_vregvs0v8_dft_cal_cmp_check()

NRF_STATIC_INLINE bool nrf_vregvs0v8_dft_cal_cmp_check ( NRF_VREGVS0V8_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_vregvs0v8_dft_cal_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_dft_cal_set ( NRF_VREGVS0V8_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_vregvs0v8_dft_dtb0_config_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_dft_dtb0_config_set ( NRF_VREGVS0V8_Type *  p_reg,
nrf_vregvs0v8_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_vregvs0v8_dft_dtb1_config_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_dft_dtb1_config_set ( NRF_VREGVS0V8_Type *  p_reg,
nrf_vregvs0v8_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_vregvs0v8_dft_dtb2_config_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_dft_dtb2_config_set ( NRF_VREGVS0V8_Type *  p_reg,
nrf_vregvs0v8_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_vregvs0v8_dft_dtb3_config_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_dft_dtb3_config_set ( NRF_VREGVS0V8_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_vregvs0v8_dft_tcfg_config_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_dft_tcfg_config_set ( NRF_VREGVS0V8_Type *  p_reg,
nrf_vregvs0v8_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_vregvs0v8_event_address_get()

NRF_STATIC_INLINE uint32_t nrf_vregvs0v8_event_address_get ( NRF_VREGVS0V8_Type const *  p_reg,
nrf_vregvs0v8_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_vregvs0v8_event_check()

NRF_STATIC_INLINE bool nrf_vregvs0v8_event_check ( NRF_VREGVS0V8_Type const *  p_reg,
nrf_vregvs0v8_event_t  event 
)

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

NRF_STATIC_INLINE void nrf_vregvs0v8_event_clear ( NRF_VREGVS0V8_Type *  p_reg,
nrf_vregvs0v8_event_t  event 
)

Function for clearing the specified VREGVS0V8 event.

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

◆ nrf_vregvs0v8_int_disable()

NRF_STATIC_INLINE void nrf_vregvs0v8_int_disable ( NRF_VREGVS0V8_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_vregvs0v8_int_mask_t values for bit masking.

◆ nrf_vregvs0v8_int_enable()

NRF_STATIC_INLINE void nrf_vregvs0v8_int_enable ( NRF_VREGVS0V8_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_vregvs0v8_int_mask_t values for bit masking.

◆ nrf_vregvs0v8_int_enable_check()

NRF_STATIC_INLINE uint32_t nrf_vregvs0v8_int_enable_check ( NRF_VREGVS0V8_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_vregvs0v8_int_mask_t values for bit masking.
Returns
Mask of enabled interrupts.

◆ nrf_vregvs0v8_int_pending_get()

NRF_STATIC_INLINE uint32_t nrf_vregvs0v8_int_pending_get ( NRF_VREGVS0V8_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_vregvs0v8_int_mask_t values for bit masking.

◆ nrf_vregvs0v8_ithreshold_get()

NRF_STATIC_INLINE uint8_t nrf_vregvs0v8_ithreshold_get ( NRF_VREGVS0V8_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 threshold value.

◆ nrf_vregvs0v8_ithreshold_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_ithreshold_set ( NRF_VREGVS0V8_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_vregvs0v8_mirror_lock_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_mirror_lock_set ( NRF_VREGVS0V8_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_vregvs0v8_mode_get()

NRF_STATIC_INLINE nrf_vregvs0v8_mode_t nrf_vregvs0v8_mode_get ( NRF_VREGVS0V8_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_vregvs0v8_mode_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_mode_set ( NRF_VREGVS0V8_Type *  p_reg,
nrf_vregvs0v8_mode_t  mode 
)

Function for setting voltage regulator mode.

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

◆ nrf_vregvs0v8_override_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_override_set ( NRF_VREGVS0V8_Type *  p_reg,
nrf_vregvs0v8_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_vregvs0v8_status_get()

NRF_STATIC_INLINE nrf_vregvs0v8_status_t nrf_vregvs0v8_status_get ( NRF_VREGVS0V8_Type const *  p_reg)

Function for getting VREGVS0V8 status register.

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

◆ nrf_vregvs0v8_statusana_get()

NRF_STATIC_INLINE uint32_t nrf_vregvs0v8_statusana_get ( NRF_VREGVS0V8_Type const *  p_reg)

Function for getting VREGVS0V8 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_vregvs0v8_statusana_mask_t values for bit masking.

◆ nrf_vregvs0v8_trim_highpower_get()

NRF_STATIC_INLINE uint8_t nrf_vregvs0v8_trim_highpower_get ( NRF_VREGVS0V8_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_vregvs0v8_trim_highpower_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_trim_highpower_set ( NRF_VREGVS0V8_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 0mV +/- 5,9mV steps.

◆ nrf_vregvs0v8_trim_iref_get()

NRF_STATIC_INLINE uint8_t nrf_vregvs0v8_trim_iref_get ( NRF_VREGVS0V8_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_vregvs0v8_trim_iref_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_trim_iref_set ( NRF_VREGVS0V8_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_vregvs0v8_trim_lowpower_get()

NRF_STATIC_INLINE uint8_t nrf_vregvs0v8_trim_lowpower_get ( NRF_VREGVS0V8_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_vregvs0v8_trim_lowpower_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_trim_lowpower_set ( NRF_VREGVS0V8_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 0mV +/- 5.9mV steps.

◆ nrf_vregvs0v8_trim_ulpr_get()

NRF_STATIC_INLINE uint8_t nrf_vregvs0v8_trim_ulpr_get ( NRF_VREGVS0V8_Type const *  p_reg)

Function for getting ultra low power refresh comparator offset trimming.

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

◆ nrf_vregvs0v8_trim_ulpr_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_trim_ulpr_set ( NRF_VREGVS0V8_Type *  p_reg,
uint8_t  val 
)

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

◆ nrf_vregvs0v8_vout_hp_get()

NRF_STATIC_INLINE uint8_t nrf_vregvs0v8_vout_hp_get ( NRF_VREGVS0V8_Type const *  p_reg)

Function for getting high power mode output voltage.

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

◆ nrf_vregvs0v8_vout_hp_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_vout_hp_set ( NRF_VREGVS0V8_Type *  p_reg,
uint8_t  val 
)

Function for setting high power mode output voltage.

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

◆ nrf_vregvs0v8_vout_lp_get()

NRF_STATIC_INLINE uint8_t nrf_vregvs0v8_vout_lp_get ( NRF_VREGVS0V8_Type const *  p_reg)

Function for getting low power mode output voltage.

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

◆ nrf_vregvs0v8_vout_lp_set()

NRF_STATIC_INLINE void nrf_vregvs0v8_vout_lp_set ( NRF_VREGVS0V8_Type *  p_reg,
uint8_t  val 
)

Function for setting low power mode output voltage.

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

Documentation feedback | Developer Zone | Subscribe | Updated