nrfx 3.3
Data Structures | Macros | Enumerations | Functions
1.0V Voltage Regulator HAL

Hardware access layer for managing the 1.0V Voltage Regulator. More...

Data Structures

struct  nrf_vreg1v0_config_cfgstatic_t
 Fields for static configuration structure. More...
 
struct  nrf_vreg1v0_config_cfgdynamic_t
 Dynamic configuration structure. More...
 
struct  nrf_vreg1v0_tcfg_t
 Test mode configuration. More...
 

Macros

#define NRF_VREG1V0_HAS_DFT_ATB0_SELMUX_IBPSR_4UA   1
 Symbol indicating whether setting the internal 4uA current reference for Analog Test Bus 0 multiplexer is available.
 
#define NRF_VREG1V0_HAS_DFT_ATB0_SELMUX_IBPSR_SUM   1
 Symbol indicating whether setting the sum of both internal current reference (50nA and 4uA) for Analog Test Bus 0 multiplexer is available.
 
#define NRF_VREG1V0_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_VREG1V0_HAS_DFT_ATB0_SELMUX_VSS   1
 Symbol indicating whether setting the VSS voltage reference for Analog Test Bus 0 multiplexer is available.
 
#define NRF_VREG1V0_HAS_DFT_ATB1_SELMUX_VSS   1
 Symbol indicating whether setting the VSS voltage reference for Analog Test Bus 1 multiplexer is available.
 
#define NRF_VREG1V0_HAS_DFT_ATB1_SELMUX_NONE   1
 Symbol indicating whether none selecting multiplexer for Analog Test Bus 1 is available.
 

Enumerations

enum  nrf_vreg1v0_event_t {
  NRF_VREG1V0_EVENT_READY = offsetof(NRF_VREG1V0_Type, EVENTS_READY) ,
  NRF_VREG1V0_EVENT_SETTLED = offsetof(NRF_VREG1V0_Type, EVENTS_SETTLED) ,
  NRF_VREG1V0_EVENT_IOUTCMP = offsetof(NRF_VREG1V0_Type, EVENTS_IOUTCMP) ,
  NRF_VREG1V0_EVENT_LP2HP = offsetof(NRF_VREG1V0_Type, EVENTS_LP2HP) ,
  NRF_VREG1V0_EVENT_HP2LP = offsetof(NRF_VREG1V0_Type, EVENTS_HP2LP)
}
 VREG1V0 events. More...
 
enum  nrf_vreg1v0_int_mask_t {
  NRF_VREG1V0_INT_READY_MASK = VREG1V0_INTEN_READY_Msk ,
  NRF_VREG1V0_INT_SETTLED_MASK = VREG1V0_INTEN_SETTLED_Msk ,
  NRF_VREG1V0_INT_IOUTCMP_MASK = VREG1V0_INTEN_IOUTCMP_Msk ,
  NRF_VREG1V0_INT_LP2HP_MASK = VREG1V0_INTEN_LP2HP_Msk ,
  NRF_VREG1V0_INT_HP2LP_MASK = VREG1V0_INTEN_HP2LP_Msk
}
 VREG1V0 interrupts. More...
 
enum  nrf_vreg1v0_status_t {
  NRF_VREG1V0_STATUS_HIGH_POWER = VREG1V0_STATUS_MODE_HighPower ,
  NRF_VREG1V0_STATUS_LOW_POWER = VREG1V0_STATUS_MODE_LowPower ,
  NRF_VREG1V0_STATUS_ULP_REFRESH = VREG1V0_STATUS_MODE_UltraLowPowerRefresh
}
 STATUS register states. More...
 
enum  nrf_vreg1v0_statusana_mask_t {
  NRF_VREG1V0_STATUSANA_READY_MASK = VREG1V0_STATUSANA_READY_Msk ,
  NRF_VREG1V0_STATUSANA_SETTLED_MASK = VREG1V0_STATUSANA_SETTLED_Msk ,
  NRF_VREG1V0_STATUSANA_IOUTCMP_MASK = VREG1V0_STATUSANA_IOUTCMP_Msk
}
 STATUSANA register bit masks. More...
 
enum  nrf_vreg1v0_config_softstart_t {
  NRF_VREG1V0_CFGDYNAMIC_SOFTSTART_AUTO = VREG1V0_CONFIG_CFGDYNAMIC_SOFTSTART_Auto ,
  NRF_VREG1V0_CFGDYNAMIC_SOFTSTART_NORMAL = VREG1V0_CONFIG_CFGDYNAMIC_SOFTSTART_Normal ,
  NRF_VREG1V0_CFGDYNAMIC_SOFTSTART_ILIM_HIGH = VREG1V0_CONFIG_CFGDYNAMIC_SOFTSTART_IlimHigh ,
  NRF_VREG1V0_CFGDYNAMIC_SOFTSTART_ILIM_MID = VREG1V0_CONFIG_CFGDYNAMIC_SOFTSTART_IlimMid ,
  NRF_VREG1V0_CFGDYNAMIC_SOFTSTART_ILIM_LOW = VREG1V0_CONFIG_CFGDYNAMIC_SOFTSTART_IlimLow
}
 Dynamic configuration. Current limit configuration for the voltage regulator. More...
 
enum  nrf_vreg1v0_vout_t {
  NRF_VREG1V0_VOUT_HP_NOMINAL ,
  NRF_VREG1V0_VOUT_HP_RADIO ,
  NRF_VREG1V0_VOUT_HP_HELPER ,
  NRF_VREG1V0_VOUT_LP_NOMINAL ,
  NRF_VREG1V0_VOUT_LP_RADIO ,
  NRF_VREG1V0_VOUT_ULV
}
 Enum for selecting voltage output programming. More...
 
enum  nrf_vreg1v0_mode_t {
  NRF_VREG1V0_MODE_AUTO = VREG1V0_MODE_MODE_Auto ,
  NRF_VREG1V0_MODE_HIGH_POWER = VREG1V0_MODE_MODE_HighPower ,
  NRF_VREG1V0_MODE_LOW_POWER = VREG1V0_MODE_MODE_LowPower ,
  NRF_VREG1V0_MODE_ULP_REFRESH = VREG1V0_MODE_MODE_UltraLowPowerRefresh
}
 Voltage regulator mode. More...
 
enum  nrf_vreg1v0_analog_signal_t {
  NRF_VREG1V0_ANALOG_SIGNAL_PWRUP ,
  NRF_VREG1V0_ANALOG_SIGNAL_RETAIN ,
  NRF_VREG1V0_ANALOG_SIGNAL_MODE_LP ,
  NRF_VREG1V0_ANALOG_SIGNAL_MODE_ULPR ,
  NRF_VREG1V0_ANALOG_SIGNAL_CFG ,
  NRF_VREG1V0_ANALOG_SIGNAL_VOLT_HP ,
  NRF_VREG1V0_ANALOG_SIGNAL_VOLT_LP ,
  NRF_VREG1V0_ANALOG_SIGNAL_READY ,
  NRF_VREG1V0_ANALOG_SIGNAL_SETTLED ,
  NRF_VREG1V0_ANALOG_SIGNAL_IOUT_CMP
}
 Analog signal to be overridden. More...
 
enum  nrf_vreg1v0_dft_atb0_selmux_t {
  NRF_VREG1V0_DFT_ATB0_SELMUX_EXT_VREF = VREG1V0_DFT_ATB0CONFIG_SELMUX_ExtVref ,
  NRF_VREG1V0_DFT_ATB0_SELMUX_IBPP_50NA = VREG1V0_DFT_ATB0CONFIG_SELMUX_Ibpp50n ,
  NRF_VREG1V0_DFT_ATB0_SELMUX_IBPSR_4UA = VREG1V0_DFT_ATB0CONFIG_SELMUX_Ibpsr4u ,
  NRF_VREG1V0_DFT_ATB0_SELMUX_SUM = VREG1V0_DFT_ATB0CONFIG_SELMUX_Ibpp50nIbpsr4u ,
  NRF_VREG1V0_DFT_ATB0_SELMUX_IBPSR_8UA = VREG1V0_DFT_ATB0CONFIG_SELMUX_ibpsr8u ,
  NRF_VREG1V0_DFT_ATB0_SELMUX_VSS = VREG1V0_DFT_ATB0CONFIG_SELMUX_VSS
}
 Select multiplexer for ATB0. More...
 
enum  nrf_vreg1v0_dft_atb1_selmux_t {
  NRF_VREG1V0_DFT_ATB1_SELMUX_VSS = VREG1V0_DFT_ATB1CONFIG_SELMUX_VSS ,
  NRF_VREG1V0_DFT_ATB1_SELMUX_NONE = VREG1V0_DFT_ATB1CONFIG_SELMUX_None ,
  NRF_VREG1V0_DFT_ATB1_SELMUX_BUF_HP_VREF = VREG1V0_DFT_ATB1CONFIG_SELMUX_BufferedHPvref ,
  NRF_VREG1V0_DFT_ATB1_SELMUX_VDD_1V0 = VREG1V0_DFT_ATB1CONFIG_SELMUX_VDD1V0 ,
  NRF_VREG1V0_DFT_ATB1_SELMUX_IBPSR_4UA = VREG1V0_DFT_ATB1CONFIG_SELMUX_Ibpsr4u
}
 Select multiplexer for ATB1. More...
 
enum  nrf_vreg1v0_dft_dtb0_selmux_t {
  NRF_VREG1V0_DFT_DTB0_SELMUX_NONE = VREG1V0_DFT_DTB0CONFIG_SELMUX_None ,
  NRF_VREG1V0_DFT_DTB0_SELMUX_REFRESH_ULPR = VREG1V0_DFT_DTB0CONFIG_SELMUX_RefreshULPR ,
  NRF_VREG1V0_DFT_DTB0_SELMUX_SETTLED_IBPSR = VREG1V0_DFT_DTB0CONFIG_SELMUX_SettledIBPSR ,
  NRF_VREG1V0_DFT_DTB0_SELMUX_SPARE0 = VREG1V0_DFT_DTB0CONFIG_SELMUX_Spare0 ,
  NRF_VREG1V0_DFT_DTB0_SELMUX_CURR_CMP = VREG1V0_DFT_DTB0CONFIG_SELMUX_CurrCmp ,
  NRF_VREG1V0_DFT_DTB0_SELMUX_REQ_MODE_LP = VREG1V0_DFT_DTB0CONFIG_SELMUX_ReqModeLP ,
  NRF_VREG1V0_DFT_DTB0_SELMUX_REQ_MODE_ULPR = VREG1V0_DFT_DTB0CONFIG_SELMUX_RegModeULPR ,
  NRF_VREG1V0_DFT_DTB0_SELMUX_CAL_CMP = VREG1V0_DFT_DTB0CONFIG_SELMUX_CalCmp
}
 Select multiplexer for DTB0. More...
 
enum  nrf_vreg1v0_dft_dtb1_selmux_t {
  NRF_VREG1V0_DFT_DTB1_SELMUX_VREF_TIMER_ACK = VREG1V0_DFT_DTB1CONFIG_SELMUX_VrefTimerAck ,
  NRF_VREG1V0_DFT_DTB1_SELMUX_REFRESH_TIMER_ACK = VREG1V0_DFT_DTB1CONFIG_SELMUX_RefreshTimerAck ,
  NRF_VREG1V0_DFT_DTB1_SELMUX_READY_IBPSR = VREG1V0_DFT_DTB1CONFIG_SELMUX_ReadyIBPSR ,
  NRF_VREG1V0_DFT_DTB1_SELMUX_READY_HP = VREG1V0_DFT_DTB1CONFIG_SELMUX_ReadyHP ,
  NRF_VREG1V0_DFT_DTB1_SELMUX_READY_LP = VREG1V0_DFT_DTB1CONFIG_SELMUX_ReadyLP ,
  NRF_VREG1V0_DFT_DTB1_SELMUX_CANCEL_LPACK = VREG1V0_DFT_DTB1CONFIG_SELMUX_CancelLPAck ,
  NRF_VREG1V0_DFT_DTB1_SELMUX_READY_IBPP5NA = VREG1V0_DFT_DTB1CONFIG_SELMUX_ReadyIBPP5n ,
  NRF_VREG1V0_DFT_DTB1_SELMUX_SETTLED = VREG1V0_DFT_DTB1CONFIG_SELMUX_Settled
}
 Select multiplexer for DTB1. More...
 
enum  nrf_vreg1v0_dft_dtb2_selmux_t {
  NRF_VREG1V0_DFT_DTB2_SELMUX_VREF_TIMER_REQ = VREG1V0_DFT_DTB2CONFIG_SELMUX_VrefTimerReq ,
  NRF_VREG1V0_DFT_DTB2_SELMUX_REFRESH_TIMER_REQ = VREG1V0_DFT_DTB2CONFIG_SELMUX_RefreshTimerReq ,
  NRF_VREG1V0_DFT_DTB2_SELMUX_PWRUP_IBPSR = VREG1V0_DFT_DTB2CONFIG_SELMUX_PwrupIBPSR ,
  NRF_VREG1V0_DFT_DTB2_SELMUX_PWRUP_HP = VREG1V0_DFT_DTB2CONFIG_SELMUX_PwrupHP ,
  NRF_VREG1V0_DFT_DTB2_SELMUX_PWRUP_LP = VREG1V0_DFT_DTB2CONFIG_SELMUX_PwrupLP ,
  NRF_VREG1V0_DFT_DTB2_SELMUX_CANCEL_LP = VREG1V0_DFT_DTB2CONFIG_SELMUX_CancelLP ,
  NRF_VREG1V0_DFT_DTB2_SELMUX_PWRUP_IBPP5NA = VREG1V0_DFT_DTB2CONFIG_SELMUX_PwrupIBPP5n ,
  NRF_VREG1V0_DFT_DTB2_SELMUX_NONE = VREG1V0_DFT_DTB2CONFIG_SELMUX_None
}
 Select multiplexer for DTB2. More...
 

Functions

NRF_STATIC_INLINE void nrf_vreg1v0_event_clear (NRF_VREG1V0_Type *p_reg, nrf_vreg1v0_event_t event)
 Function for clearing the specified VREG1V0 event.
 
NRF_STATIC_INLINE bool nrf_vreg1v0_event_check (NRF_VREG1V0_Type const *p_reg, nrf_vreg1v0_event_t event)
 Function for retrieving the state of the VREG1V0 event.
 
NRF_STATIC_INLINE uint32_t nrf_vreg1v0_event_address_get (NRF_VREG1V0_Type const *p_reg, nrf_vreg1v0_event_t event)
 Function for getting the address of the specified event register.
 
NRF_STATIC_INLINE void nrf_vreg1v0_int_enable (NRF_VREG1V0_Type *p_reg, uint32_t mask)
 Function for enabling specified interrupts.
 
NRF_STATIC_INLINE void nrf_vreg1v0_int_disable (NRF_VREG1V0_Type *p_reg, uint32_t mask)
 Function for disabling specified interrupts.
 
NRF_STATIC_INLINE uint32_t nrf_vreg1v0_int_enable_check (NRF_VREG1V0_Type const *p_reg, uint32_t mask)
 Function for checking if the specified interrupts are enabled.
 
NRF_STATIC_INLINE uint32_t nrf_vreg1v0_int_pending_get (NRF_VREG1V0_Type const *p_reg)
 Function for retrieving the state of pending interrupts.
 
NRF_STATIC_INLINE nrf_vreg1v0_status_t nrf_vreg1v0_status_get (NRF_VREG1V0_Type const *p_reg)
 Function for getting VREG1V0 status register.
 
NRF_STATIC_INLINE uint32_t nrf_vreg1v0_statusana_get (NRF_VREG1V0_Type const *p_reg)
 Function for getting VREG1V0 status of the analog module output signals.
 
NRF_STATIC_INLINE void nrf_vreg1v0_config_cfgstatic_set (NRF_VREG1V0_Type *p_reg, nrf_vreg1v0_config_cfgstatic_t cfgstatic)
 Function for setting static and dynamic voltage regulator configuration.
 
NRF_STATIC_INLINE nrf_vreg1v0_config_cfgstatic_t nrf_vreg1v0_config_cfgstatic_get (NRF_VREG1V0_Type const *p_reg)
 Function for getting static and dynamic voltage regulator configuration.
 
NRF_STATIC_INLINE void nrf_vreg1v0_config_cfgdynamic_set (NRF_VREG1V0_Type *p_reg, nrf_vreg1v0_config_cfgdynamic_t cfgdynamic)
 Function for setting voltage regulator dynamic configuration.
 
NRF_STATIC_INLINE nrf_vreg1v0_config_cfgdynamic_t nrf_vreg1v0_config_cfgdynamic_get (NRF_VREG1V0_Type const *p_reg)
 Function for getting voltage regulator dynamic configuration.
 
NRF_STATIC_INLINE void nrf_vreg1v0_trim_iref_set (NRF_VREG1V0_Type *p_reg, uint8_t val)
 Function for setting current reference trimming.
 
NRF_STATIC_INLINE uint8_t nrf_vreg1v0_trim_iref_get (NRF_VREG1V0_Type const *p_reg)
 Function for getting current reference trimming.
 
NRF_STATIC_INLINE void nrf_vreg1v0_trim_highpower_set (NRF_VREG1V0_Type *p_reg, uint8_t val)
 Function for setting high power mode output voltage offset trimming.
 
NRF_STATIC_INLINE uint8_t nrf_vreg1v0_trim_highpower_get (NRF_VREG1V0_Type const *p_reg)
 Function for getting high power mode output voltage offset trimming.
 
NRF_STATIC_INLINE void nrf_vreg1v0_trim_lowpower_set (NRF_VREG1V0_Type *p_reg, uint8_t val)
 Function for setting low power mode output voltage offset trimming.
 
NRF_STATIC_INLINE uint8_t nrf_vreg1v0_trim_lowpower_get (NRF_VREG1V0_Type const *p_reg)
 Function for getting low power mode output voltage offset trimming.
 
NRF_STATIC_INLINE void nrf_vreg1v0_trim_ulpr_set (NRF_VREG1V0_Type *p_reg, uint8_t val)
 Function for setting ULPR mode output voltage offset trimming.
 
NRF_STATIC_INLINE uint8_t nrf_vreg1v0_trim_ulpr_get (NRF_VREG1V0_Type const *p_reg)
 Function for getting ULPR mode output voltage offset trimming.
 
NRF_STATIC_INLINE void nrf_vreg1v0_mirror_lock_set (NRF_VREG1V0_Type *p_reg, bool lock)
 Function for locking mirrored registers.
 
NRF_STATIC_INLINE void nrf_vreg1v0_vout_set (NRF_VREG1V0_Type *p_reg, nrf_vreg1v0_vout_t vout, uint8_t val)
 Function for setting nominal high power mode output voltage.
 
NRF_STATIC_INLINE uint8_t nrf_vreg1v0_vout_get (NRF_VREG1V0_Type const *p_reg, nrf_vreg1v0_vout_t vout)
 Function for getting nominal high power mode output voltage.
 
NRF_STATIC_INLINE void nrf_vreg1v0_mode_set (NRF_VREG1V0_Type *p_reg, nrf_vreg1v0_mode_t mode)
 Function for setting voltage regulator mode.
 
NRF_STATIC_INLINE nrf_vreg1v0_mode_t nrf_vreg1v0_mode_get (NRF_VREG1V0_Type const *p_reg)
 Function for getting voltage regulator mode.
 
NRF_STATIC_INLINE void nrf_vreg1v0_ithreshold_set (NRF_VREG1V0_Type *p_reg, uint8_t thr)
 Function for setting current threshold for mode transition.
 
NRF_STATIC_INLINE uint8_t nrf_vreg1v0_ithreshold_get (NRF_VREG1V0_Type const *p_reg)
 Function for getting current threshold for mode transition.
 
NRF_STATIC_INLINE void nrf_vreg1v0_override_set (NRF_VREG1V0_Type *p_reg, nrf_vreg1v0_analog_signal_t signal, bool enable, uint8_t val)
 Function for override signal to the analog module.
 
NRF_STATIC_INLINE void nrf_vreg1v0_dft_atb0_config_set (NRF_VREG1V0_Type *p_reg, nrf_vreg1v0_dft_atb0_selmux_t selmux, bool enable)
 Function for configuring Analog Test Bus 0 (ATB0).
 
NRF_STATIC_INLINE void nrf_vreg1v0_dft_atb1_config_set (NRF_VREG1V0_Type *p_reg, nrf_vreg1v0_dft_atb1_selmux_t selmux, bool enable)
 Function for configuring Analog Test Bus 1 (ATB1).
 
NRF_STATIC_INLINE void nrf_vreg1v0_dft_dtb0_config_set (NRF_VREG1V0_Type *p_reg, nrf_vreg1v0_dft_dtb0_selmux_t selmux, bool enable)
 Function for configuring Digital Test Bus 0 (DTB0).
 
NRF_STATIC_INLINE void nrf_vreg1v0_dft_dtb1_config_set (NRF_VREG1V0_Type *p_reg, nrf_vreg1v0_dft_dtb1_selmux_t selmux, bool enable)
 Function for configuring Digital Test Bus 1 (DTB1).
 
NRF_STATIC_INLINE void nrf_vreg1v0_dft_dtb2_config_set (NRF_VREG1V0_Type *p_reg, nrf_vreg1v0_dft_dtb2_selmux_t selmux, bool enable)
 Function for configuring Digital Test Bus 2 (DTB2).
 
NRF_STATIC_INLINE void nrf_vreg1v0_dft_dtb3_config_set (NRF_VREG1V0_Type *p_reg, bool enable)
 Function for configuring Digital Test Bus 3 (DTB3).
 
NRF_STATIC_INLINE void nrf_vreg1v0_dft_tcfg_config_set (NRF_VREG1V0_Type *p_reg, nrf_vreg1v0_tcfg_t tcfg)
 Function for configuring test mode.
 
NRF_STATIC_INLINE void nrf_vreg1v0_dft_cal_set (NRF_VREG1V0_Type *p_reg, bool enable)
 Function for enabling or disabling calibration.
 
NRF_STATIC_INLINE uint32_t nrf_vreg1v0_dft_calcmp_check (NRF_VREG1V0_Type const *p_reg)
 Function for checking calibration compare.
 

Detailed Description

Hardware access layer for managing the 1.0V Voltage Regulator.

Enumeration Type Documentation

◆ nrf_vreg1v0_analog_signal_t

Analog signal to be overridden.

Enumerator
NRF_VREG1V0_ANALOG_SIGNAL_PWRUP 

Override PWRUP signal.

NRF_VREG1V0_ANALOG_SIGNAL_RETAIN 

Override RETAIN signal.

NRF_VREG1V0_ANALOG_SIGNAL_MODE_LP 

Override MODE LP signal.

NRF_VREG1V0_ANALOG_SIGNAL_MODE_ULPR 

Override MODE ULPR signal.

NRF_VREG1V0_ANALOG_SIGNAL_CFG 

Override CFG signal.

NRF_VREG1V0_ANALOG_SIGNAL_VOLT_HP 

Override VOLT HP signal.

NRF_VREG1V0_ANALOG_SIGNAL_VOLT_LP 

Override VOLT LP signal.

NRF_VREG1V0_ANALOG_SIGNAL_READY 

Override READY signal.

NRF_VREG1V0_ANALOG_SIGNAL_SETTLED 

Override SETTLED signal.

NRF_VREG1V0_ANALOG_SIGNAL_IOUT_CMP 

Override IOUTCMP signal.

◆ nrf_vreg1v0_config_softstart_t

Dynamic configuration. Current limit configuration for the voltage regulator.

Enumerator
NRF_VREG1V0_CFGDYNAMIC_SOFTSTART_AUTO 

Automatic.

NRF_VREG1V0_CFGDYNAMIC_SOFTSTART_NORMAL 

Normal. Max 100mA.

NRF_VREG1V0_CFGDYNAMIC_SOFTSTART_ILIM_HIGH 

Max 60mA.

NRF_VREG1V0_CFGDYNAMIC_SOFTSTART_ILIM_MID 

Max 30mA.

NRF_VREG1V0_CFGDYNAMIC_SOFTSTART_ILIM_LOW 

Max 10mA.

◆ nrf_vreg1v0_dft_atb0_selmux_t

Select multiplexer for ATB0.

Enumerator
NRF_VREG1V0_DFT_ATB0_SELMUX_EXT_VREF 

Negative input of calibration comparator.

NRF_VREG1V0_DFT_ATB0_SELMUX_IBPP_50NA 

Internal 50nA current reference.

NRF_VREG1V0_DFT_ATB0_SELMUX_IBPSR_4UA 

Internal 4uA current reference.

NRF_VREG1V0_DFT_ATB0_SELMUX_SUM 

Sum both internal current reference.

NRF_VREG1V0_DFT_ATB0_SELMUX_IBPSR_8UA 

Internal 8uA current reference.

NRF_VREG1V0_DFT_ATB0_SELMUX_VSS 

VSS.

◆ nrf_vreg1v0_dft_atb1_selmux_t

Select multiplexer for ATB1.

Enumerator
NRF_VREG1V0_DFT_ATB1_SELMUX_VSS 

VSS.

NRF_VREG1V0_DFT_ATB1_SELMUX_NONE 

No multiplexer is selected.

NRF_VREG1V0_DFT_ATB1_SELMUX_BUF_HP_VREF 

Buffered HP vref.

NRF_VREG1V0_DFT_ATB1_SELMUX_VDD_1V0 

VDD_1V0.

NRF_VREG1V0_DFT_ATB1_SELMUX_IBPSR_4UA 

Internal 4uA current reference, through 225kOhm resistor.

◆ nrf_vreg1v0_dft_dtb0_selmux_t

Select multiplexer for DTB0.

Enumerator
NRF_VREG1V0_DFT_DTB0_SELMUX_NONE 

None selected, logic 0.

NRF_VREG1V0_DFT_DTB0_SELMUX_REFRESH_ULPR 

ULPR refresh pulse.

NRF_VREG1V0_DFT_DTB0_SELMUX_SETTLED_IBPSR 

BIAS_IBPSR_4U_DVT settled signal.

NRF_VREG1V0_DFT_DTB0_SELMUX_SPARE0 

None selected, logic 0.

NRF_VREG1V0_DFT_DTB0_SELMUX_CURR_CMP 

Current comparator out.

NRF_VREG1V0_DFT_DTB0_SELMUX_REQ_MODE_LP 

LP mode request.

NRF_VREG1V0_DFT_DTB0_SELMUX_REQ_MODE_ULPR 

ULPR mode request.

NRF_VREG1V0_DFT_DTB0_SELMUX_CAL_CMP 

Calibration comparator out.

◆ nrf_vreg1v0_dft_dtb1_selmux_t

Select multiplexer for DTB1.

Enumerator
NRF_VREG1V0_DFT_DTB1_SELMUX_VREF_TIMER_ACK 

Vref timer acknowledge.

NRF_VREG1V0_DFT_DTB1_SELMUX_REFRESH_TIMER_ACK 

ULPR refresh timer acknowledge.

NRF_VREG1V0_DFT_DTB1_SELMUX_READY_IBPSR 

IBPSR ready signal.

NRF_VREG1V0_DFT_DTB1_SELMUX_READY_HP 

High power core ready signal.

NRF_VREG1V0_DFT_DTB1_SELMUX_READY_LP 

Low power core ready signal.

NRF_VREG1V0_DFT_DTB1_SELMUX_CANCEL_LPACK 

Low power core cancel acknowledge signal.

NRF_VREG1V0_DFT_DTB1_SELMUX_READY_IBPP5NA 

BIAS_IBPP_5N ready signal.

NRF_VREG1V0_DFT_DTB1_SELMUX_SETTLED 

Settled signal.

◆ nrf_vreg1v0_dft_dtb2_selmux_t

Select multiplexer for DTB2.

Enumerator
NRF_VREG1V0_DFT_DTB2_SELMUX_VREF_TIMER_REQ 

Vref timer request

NRF_VREG1V0_DFT_DTB2_SELMUX_REFRESH_TIMER_REQ 

ULPR refresh timer request.

NRF_VREG1V0_DFT_DTB2_SELMUX_PWRUP_IBPSR 

IBPSR power up signal.

NRF_VREG1V0_DFT_DTB2_SELMUX_PWRUP_HP 

High power core power up signal.

NRF_VREG1V0_DFT_DTB2_SELMUX_PWRUP_LP 

Low power core power up signal.

NRF_VREG1V0_DFT_DTB2_SELMUX_CANCEL_LP 

Low power core cancel signal.

NRF_VREG1V0_DFT_DTB2_SELMUX_PWRUP_IBPP5NA 

BIAS_IBPP_5N power up signal.

NRF_VREG1V0_DFT_DTB2_SELMUX_NONE 

None selected, logic 0.

◆ nrf_vreg1v0_event_t

VREG1V0 events.

Enumerator
NRF_VREG1V0_EVENT_READY 

Power up done.

NRF_VREG1V0_EVENT_SETTLED 

Settled flag for MODE handshake.

NRF_VREG1V0_EVENT_IOUTCMP 

Analog current comparator.

NRF_VREG1V0_EVENT_LP2HP 

Current consumption above threshold.

NRF_VREG1V0_EVENT_HP2LP 

Current consumption below threshold.

◆ nrf_vreg1v0_int_mask_t

VREG1V0 interrupts.

Enumerator
NRF_VREG1V0_INT_READY_MASK 

Interrupt on READY.

NRF_VREG1V0_INT_SETTLED_MASK 

Interrupt on SETTLED.

NRF_VREG1V0_INT_IOUTCMP_MASK 

Interrupt on IOUTCMP.

NRF_VREG1V0_INT_LP2HP_MASK 

Interrupt on LP2HP.

NRF_VREG1V0_INT_HP2LP_MASK 

Interrupt on HP2LP.

◆ nrf_vreg1v0_mode_t

Voltage regulator mode.

Enumerator
NRF_VREG1V0_MODE_AUTO 

Automatically handled by the peripheral.

NRF_VREG1V0_MODE_HIGH_POWER 

High power mode.

NRF_VREG1V0_MODE_LOW_POWER 

Low power mode.

NRF_VREG1V0_MODE_ULP_REFRESH 

Ultra-low power refresh mode.

◆ nrf_vreg1v0_status_t

STATUS register states.

Enumerator
NRF_VREG1V0_STATUS_HIGH_POWER 

High power mode.

NRF_VREG1V0_STATUS_LOW_POWER 

Low power mode.

NRF_VREG1V0_STATUS_ULP_REFRESH 

ULP refresh mode.

◆ nrf_vreg1v0_statusana_mask_t

STATUSANA register bit masks.

Enumerator
NRF_VREG1V0_STATUSANA_READY_MASK 

Current value of READY signal.

NRF_VREG1V0_STATUSANA_SETTLED_MASK 

Current value of SETTLED signal.

NRF_VREG1V0_STATUSANA_IOUTCMP_MASK 

Current value of IOUTCMP signal..

◆ nrf_vreg1v0_vout_t

Enum for selecting voltage output programming.

Enumerator
NRF_VREG1V0_VOUT_HP_NOMINAL 

Nominal high power mode.

NRF_VREG1V0_VOUT_HP_RADIO 

Radio high power mode.

NRF_VREG1V0_VOUT_HP_HELPER 

High power helper mode.

NRF_VREG1V0_VOUT_LP_NOMINAL 

Nominal low power mode.

NRF_VREG1V0_VOUT_LP_RADIO 

Radio low power mode.

NRF_VREG1V0_VOUT_ULV 

ULV output.

Function Documentation

◆ nrf_vreg1v0_config_cfgdynamic_get()

NRF_STATIC_INLINE nrf_vreg1v0_config_cfgdynamic_t nrf_vreg1v0_config_cfgdynamic_get ( NRF_VREG1V0_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_vreg1v0_config_cfgdynamic_set()

NRF_STATIC_INLINE void nrf_vreg1v0_config_cfgdynamic_set ( NRF_VREG1V0_Type *  p_reg,
nrf_vreg1v0_config_cfgdynamic_t  cfgdynamic 
)

Function for setting voltage regulator dynamic configuration.

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

◆ nrf_vreg1v0_config_cfgstatic_get()

NRF_STATIC_INLINE nrf_vreg1v0_config_cfgstatic_t nrf_vreg1v0_config_cfgstatic_get ( NRF_VREG1V0_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_vreg1v0_config_cfgstatic_set()

NRF_STATIC_INLINE void nrf_vreg1v0_config_cfgstatic_set ( NRF_VREG1V0_Type *  p_reg,
nrf_vreg1v0_config_cfgstatic_t  cfgstatic 
)

Function for setting static and dynamic voltage regulator configuration.

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

◆ nrf_vreg1v0_dft_atb0_config_set()

NRF_STATIC_INLINE void nrf_vreg1v0_dft_atb0_config_set ( NRF_VREG1V0_Type *  p_reg,
nrf_vreg1v0_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_vreg1v0_dft_atb1_config_set()

NRF_STATIC_INLINE void nrf_vreg1v0_dft_atb1_config_set ( NRF_VREG1V0_Type *  p_reg,
nrf_vreg1v0_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_vreg1v0_dft_cal_set()

NRF_STATIC_INLINE void nrf_vreg1v0_dft_cal_set ( NRF_VREG1V0_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_vreg1v0_dft_calcmp_check()

NRF_STATIC_INLINE uint32_t nrf_vreg1v0_dft_calcmp_check ( NRF_VREG1V0_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_vreg1v0_dft_dtb0_config_set()

NRF_STATIC_INLINE void nrf_vreg1v0_dft_dtb0_config_set ( NRF_VREG1V0_Type *  p_reg,
nrf_vreg1v0_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_vreg1v0_dft_dtb1_config_set()

NRF_STATIC_INLINE void nrf_vreg1v0_dft_dtb1_config_set ( NRF_VREG1V0_Type *  p_reg,
nrf_vreg1v0_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_vreg1v0_dft_dtb2_config_set()

NRF_STATIC_INLINE void nrf_vreg1v0_dft_dtb2_config_set ( NRF_VREG1V0_Type *  p_reg,
nrf_vreg1v0_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_vreg1v0_dft_dtb3_config_set()

NRF_STATIC_INLINE void nrf_vreg1v0_dft_dtb3_config_set ( NRF_VREG1V0_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_vreg1v0_dft_tcfg_config_set()

NRF_STATIC_INLINE void nrf_vreg1v0_dft_tcfg_config_set ( NRF_VREG1V0_Type *  p_reg,
nrf_vreg1v0_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_vreg1v0_event_address_get()

NRF_STATIC_INLINE uint32_t nrf_vreg1v0_event_address_get ( NRF_VREG1V0_Type const *  p_reg,
nrf_vreg1v0_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_vreg1v0_event_check()

NRF_STATIC_INLINE bool nrf_vreg1v0_event_check ( NRF_VREG1V0_Type const *  p_reg,
nrf_vreg1v0_event_t  event 
)

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

NRF_STATIC_INLINE void nrf_vreg1v0_event_clear ( NRF_VREG1V0_Type *  p_reg,
nrf_vreg1v0_event_t  event 
)

Function for clearing the specified VREG1V0 event.

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

◆ nrf_vreg1v0_int_disable()

NRF_STATIC_INLINE void nrf_vreg1v0_int_disable ( NRF_VREG1V0_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_vreg1v0_int_mask_t values for bit masking.

◆ nrf_vreg1v0_int_enable()

NRF_STATIC_INLINE void nrf_vreg1v0_int_enable ( NRF_VREG1V0_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_vreg1v0_int_mask_t values for bit masking.

◆ nrf_vreg1v0_int_enable_check()

NRF_STATIC_INLINE uint32_t nrf_vreg1v0_int_enable_check ( NRF_VREG1V0_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_vreg1v0_int_mask_t values for bit masking.
Returns
Mask of enabled interrupts.

◆ nrf_vreg1v0_int_pending_get()

NRF_STATIC_INLINE uint32_t nrf_vreg1v0_int_pending_get ( NRF_VREG1V0_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_vreg1v0_int_mask_t values for bit masking.

◆ nrf_vreg1v0_ithreshold_get()

NRF_STATIC_INLINE uint8_t nrf_vreg1v0_ithreshold_get ( NRF_VREG1V0_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_vreg1v0_ithreshold_set()

NRF_STATIC_INLINE void nrf_vreg1v0_ithreshold_set ( NRF_VREG1V0_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_vreg1v0_mirror_lock_set()

NRF_STATIC_INLINE void nrf_vreg1v0_mirror_lock_set ( NRF_VREG1V0_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_vreg1v0_mode_get()

NRF_STATIC_INLINE nrf_vreg1v0_mode_t nrf_vreg1v0_mode_get ( NRF_VREG1V0_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_vreg1v0_mode_set()

NRF_STATIC_INLINE void nrf_vreg1v0_mode_set ( NRF_VREG1V0_Type *  p_reg,
nrf_vreg1v0_mode_t  mode 
)

Function for setting voltage regulator mode.

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

◆ nrf_vreg1v0_override_set()

NRF_STATIC_INLINE void nrf_vreg1v0_override_set ( NRF_VREG1V0_Type *  p_reg,
nrf_vreg1v0_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_vreg1v0_status_get()

NRF_STATIC_INLINE nrf_vreg1v0_status_t nrf_vreg1v0_status_get ( NRF_VREG1V0_Type const *  p_reg)

Function for getting VREG1V0 status register.

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

◆ nrf_vreg1v0_statusana_get()

NRF_STATIC_INLINE uint32_t nrf_vreg1v0_statusana_get ( NRF_VREG1V0_Type const *  p_reg)

Function for getting VREG1V0 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_vreg1v0_statusana_mask_t values for bit masking.

◆ nrf_vreg1v0_trim_highpower_get()

NRF_STATIC_INLINE uint8_t nrf_vreg1v0_trim_highpower_get ( NRF_VREG1V0_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_vreg1v0_trim_highpower_set()

NRF_STATIC_INLINE void nrf_vreg1v0_trim_highpower_set ( NRF_VREG1V0_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_vreg1v0_trim_iref_get()

NRF_STATIC_INLINE uint8_t nrf_vreg1v0_trim_iref_get ( NRF_VREG1V0_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_vreg1v0_trim_iref_set()

NRF_STATIC_INLINE void nrf_vreg1v0_trim_iref_set ( NRF_VREG1V0_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_vreg1v0_trim_lowpower_get()

NRF_STATIC_INLINE uint8_t nrf_vreg1v0_trim_lowpower_get ( NRF_VREG1V0_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_vreg1v0_trim_lowpower_set()

NRF_STATIC_INLINE void nrf_vreg1v0_trim_lowpower_set ( NRF_VREG1V0_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_vreg1v0_trim_ulpr_get()

NRF_STATIC_INLINE uint8_t nrf_vreg1v0_trim_ulpr_get ( NRF_VREG1V0_Type const *  p_reg)

Function for getting ULPR mode output voltage offset trimming.

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

◆ nrf_vreg1v0_trim_ulpr_set()

NRF_STATIC_INLINE void nrf_vreg1v0_trim_ulpr_set ( NRF_VREG1V0_Type *  p_reg,
uint8_t  val 
)

Function for setting ULPR 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 +/- 11.8mV steps.

◆ nrf_vreg1v0_vout_get()

NRF_STATIC_INLINE uint8_t nrf_vreg1v0_vout_get ( NRF_VREG1V0_Type const *  p_reg,
nrf_vreg1v0_vout_t  vout 
)

Function for getting nominal high power mode output voltage.

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

◆ nrf_vreg1v0_vout_set()

NRF_STATIC_INLINE void nrf_vreg1v0_vout_set ( NRF_VREG1V0_Type *  p_reg,
nrf_vreg1v0_vout_t  vout,
uint8_t  val 
)

Function for setting nominal high power mode output voltage.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]voutOutput voltage target.
[in]valOutput voltage value. The value is 0.57V + 0.01V steps. Voltages below 0.6V (0x03) not to be used.

Documentation feedback | Developer Zone | Subscribe | Updated