nrfx 3.3
Data Structures | Enumerations | Functions
Always-on 5.0V Voltage Detector HAL

Hardware access layer for managing the Always-on 5.0V Voltage Detector (VDETAO5V0). More...

Data Structures

struct  nrf_vdetao5v0_tcfg_t
 Test mode configuration. More...
 

Enumerations

enum  nrf_vdetao5v0_task_t {
  NRF_VDETAO5V0_TASK_PWR_UP = offsetof(NRF_VDETAO5V0_Type, TASKS_PWRUP) ,
  NRF_VDETAO5V0_TASK_PWR_DOWN = offsetof(NRF_VDETAO5V0_Type, TASKS_PWRDOWN)
}
 VDETAO5V0 tasks. More...
 
enum  nrf_vdetao5v0_event_t {
  NRF_VDETAO5V0_EVENT_READY = offsetof(NRF_VDETAO5V0_Type, EVENTS_READY) ,
  NRF_VDETAO5V0_EVENT_SETTLED = offsetof(NRF_VDETAO5V0_Type, EVENTS_SETTLED)
}
 VDETAO5V0 events. More...
 
enum  nrf_vdetao5v0_int_mask_t {
  NRF_VDETAO5V0_INT_READY_MASK = VDETAO5V0_INTEN_READY_Msk ,
  NRF_VDETAO5V0_INT_SETTLED_MASK = VDETAO5V0_INTEN_SETTLED_Msk
}
 VDETAO5V0 interrupts. More...
 
enum  nrf_vdetao5v0_status_t {
  NRF_VDETAO5V0_STATUS_HIGH_POWER = VDETAO5V0_STATUS_MODE_HighPower ,
  NRF_VDETAO5V0_STATUS_LOW_POWER = VDETAO5V0_STATUS_MODE_LowPower ,
  NRF_VDETAO5V0_STATUS_ULP_REFRESH = VDETAO5V0_STATUS_MODE_UltraLowPowerRefresh
}
 STATUS register states. More...
 
enum  nrf_vdetao5v0_statusana_mask_t {
  NRF_VDETAO5V0_STATUSANA_READY_MASK = VDETAO5V0_STATUSANA_READY_Msk ,
  NRF_VDETAO5V0_STATUSANA_SETTLED_MASK = VDETAO5V0_STATUSANA_SETTLED_Msk ,
  NRF_VDETAO5V0_STATUSANA_PGD_MASK = VDETAO5V0_STATUSANA_PGD_Msk
}
 STATUSANA register bit masks. More...
 
enum  nrf_vdetao5v0_pwr_good_hyst_t {
  NRF_VDETAO5V0_PWR_GOOD_HYST_50_MV = VDETAO5V0_CONFIG_CFG_PWRGOODHYST_Val0V050 ,
  NRF_VDETAO5V0_PWR_GOOD_HYST_25_MV = VDETAO5V0_CONFIG_CFG_PWRGOODHYST_Val0V025 ,
  NRF_VDETAO5V0_PWR_GOOD_HYST_150_MV = VDETAO5V0_CONFIG_CFG_PWRGOODHYST_Val0V150 ,
  NRF_VDETAO5V0_PWR_GOOD_HYST_100_MV = VDETAO5V0_CONFIG_CFG_PWRGOODHYST_Val0V100
}
 Power good detector hysteresis voltage value. More...
 
enum  nrf_vdetao5v0_config_thr_t {
  NRF_VDETAO5V0_CONFIG_THR_PWR_GOOD_LVL ,
  NRF_VDETAO5V0_CONFIG_THR_BROWNOUT_HP ,
  NRF_VDETAO5V0_CONFIG_THR_BROWNOUT_LP ,
  NRF_VDETAO5V0_CONFIG_THR_BROWNOUT_ULV
}
 Threshold configuration type.
 
enum  nrf_vdetao5v0_mode_t {
  NRF_VDETAO5V0_MODE_AUTO = VDETAO5V0_MODE_MODE_Auto ,
  NRF_VDETAO5V0_MODE_HIGH_POWER = VDETAO5V0_MODE_MODE_HighPower ,
  NRF_VDETAO5V0_MODE_LOW_POWER = VDETAO5V0_MODE_MODE_LowPower ,
  NRF_VDETAO5V0_MODE_ULP_REFRESH = VDETAO5V0_MODE_MODE_UltraLowPowerRefresh
}
 Voltage detector mode. More...
 
enum  nrf_vdetao5v0_analog_signal_t {
  NRF_VDETAO5V0_ANALOG_SIGNAL_PWRUP ,
  NRF_VDETAO5V0_ANALOG_SIGNAL_RETAIN ,
  NRF_VDETAO5V0_ANALOG_SIGNAL_MODE_ULPR ,
  NRF_VDETAO5V0_ANALOG_SIGNAL_MODE_LP ,
  NRF_VDETAO5V0_ANALOG_SIGNAL_READY ,
  NRF_VDETAO5V0_ANALOG_SIGNAL_SETTLED ,
  NRF_VDETAO5V0_ANALOG_SIGNAL_PGD
}
 Analog signal to be overridden. More...
 
enum  nrf_vdetao5v0_dft_atb0_selmux_t {
  NRF_VDETAO5V0_DFT_ATB0_SELMUX_NONE = VDETAO5V0_DFT_ATB0CONFIG_SELMUX_None ,
  NRF_VDETAO5V0_DFT_ATB0_SELMUX_CONNECT_IDBG_1U = VDETAO5V0_DFT_ATB0CONFIG_SELMUX_ConnectIDBG1U ,
  NRF_VDETAO5V0_DFT_ATB0_SELMUX_CONNECT_VREF_VFB_DIV = VDETAO5V0_DFT_ATB0CONFIG_SELMUX_ConnectVrefVfbUnbuf ,
  NRF_VDETAO5V0_DFT_ATB0_SELMUX_CONNECT_VSS = VDETAO5V0_DFT_ATB0CONFIG_SELMUX_ConnectVSS
}
 Select multiplexer for ATB0. More...
 
enum  nrf_vdetao5v0_dft_atb1_selmux_t {
  NRF_VDETAO5V0_DFT_ATB1_SELMUX_CONNECT_VREF_BUF = VDETAO5V0_DFT_ATB1CONFIG_SELMUX_ConnectVrefBuf ,
  NRF_VDETAO5V0_DFT_ATB1_SELMUX_CONNECT_VFB_BUF = VDETAO5V0_DFT_ATB1CONFIG_SELMUX_ConnectVfbBuf
}
 Select multiplexer for ATB1. More...
 
enum  nrf_vdetao5v0_dft_dtb0_selmux_t {
  NRF_VDETAO5V0_DFT_DTB0_SELMUX_PGD_COMP_READY = VDETAO5V0_DFT_DTB0CONFIG_SELMUX_PgdCompReady ,
  NRF_VDETAO5V0_DFT_DTB0_SELMUX_PGD_UNLATCHED = VDETAO5V0_DFT_DTB0CONFIG_SELMUX_PgdUnlatched ,
  NRF_VDETAO5V0_DFT_DTB0_SELMUX_MODE_LP = VDETAO5V0_DFT_DTB0CONFIG_SELMUX_ModeLP ,
  NRF_VDETAO5V0_DFT_DTB0_SELMUX_MODE_ULPR = VDETAO5V0_DFT_DTB0CONFIG_SELMUX_ModeULPR
}
 Select multiplexer for DTB0. More...
 
enum  nrf_vdetao5v0_dft_dtb1_selmux_t {
  NRF_VDETAO5V0_DFT_DTB1_SELMUX_PDG = VDETAO5V0_DFT_DTB1CONFIG_SELMUX_Pgd ,
  NRF_VDETAO5V0_DFT_DTB1_SELMUX_PWR_UP = VDETAO5V0_DFT_DTB1CONFIG_SELMUX_Pwrup ,
  NRF_VDETAO5V0_DFT_DTB1_SELMUX_SETTLED = VDETAO5V0_DFT_DTB1CONFIG_SELMUX_Settled ,
  NRF_VDETAO5V0_DFT_DTB1_SELMUX_READY = VDETAO5V0_DFT_DTB1CONFIG_SELMUX_Ready
}
 Select multiplexer for DTB1. More...
 

Functions

NRF_STATIC_INLINE void nrf_vdetao5v0_task_trigger (NRF_VDETAO5V0_Type *p_reg, nrf_vdetao5v0_task_t task)
 Function for activating the specified task.
 
NRF_STATIC_INLINE uint32_t nrf_vdetao5v0_task_address_get (NRF_VDETAO5V0_Type const *p_reg, nrf_vdetao5v0_task_t task)
 Function for getting the address of the specified task register.
 
NRF_STATIC_INLINE void nrf_vdetao5v0_event_clear (NRF_VDETAO5V0_Type *p_reg, nrf_vdetao5v0_event_t event)
 Function for clearing the specified VDETAO5V0 event.
 
NRF_STATIC_INLINE bool nrf_vdetao5v0_event_check (NRF_VDETAO5V0_Type const *p_reg, nrf_vdetao5v0_event_t event)
 Function for retrieving the state of the VDETAO5V0 event.
 
NRF_STATIC_INLINE uint32_t nrf_vdetao5v0_event_address_get (NRF_VDETAO5V0_Type const *p_reg, nrf_vdetao5v0_event_t event)
 Function for getting the address of the specified event register.
 
NRF_STATIC_INLINE void nrf_vdetao5v0_int_enable (NRF_VDETAO5V0_Type *p_reg, uint32_t mask)
 Function for enabling specified interrupts.
 
NRF_STATIC_INLINE void nrf_vdetao5v0_int_disable (NRF_VDETAO5V0_Type *p_reg, uint32_t mask)
 Function for disabling specified interrupts.
 
NRF_STATIC_INLINE uint32_t nrf_vdetao5v0_int_enable_check (NRF_VDETAO5V0_Type const *p_reg, uint32_t mask)
 Function for checking if the specified interrupts are enabled.
 
NRF_STATIC_INLINE uint32_t nrf_vdetao5v0_int_pending_get (NRF_VDETAO5V0_Type const *p_reg)
 Function for retrieving the state of pending interrupts.
 
NRF_STATIC_INLINE nrf_vdetao5v0_status_t nrf_vdetao5v0_status_get (NRF_VDETAO5V0_Type const *p_reg)
 Function for getting VDETAO5V0 status register.
 
NRF_STATIC_INLINE uint32_t nrf_vdetao5v0_statusana_get (NRF_VDETAO5V0_Type const *p_reg)
 Function for getting VDETAO5V0 status of the analog module output signals.
 
NRF_STATIC_INLINE void nrf_vdetao5v0_config_cfg_set (NRF_VDETAO5V0_Type *p_reg, nrf_vdetao5v0_pwr_good_hyst_t hyst, bool sample_time)
 Function for setting voltage detector configuration.
 
NRF_STATIC_INLINE void nrf_vdetao5v0_config_cfg_get (NRF_VDETAO5V0_Type const *p_reg, nrf_vdetao5v0_pwr_good_hyst_t *p_hyst, bool *p_sample_time)
 Function for getting voltage detector configuration.
 
NRF_STATIC_INLINE void nrf_vdetao5v0_config_pwr_good_level_set (NRF_VDETAO5V0_Type *p_reg, uint8_t thr)
 Function for setting power good detector threshold voltage level.
 
NRF_STATIC_INLINE uint8_t nrf_vdetao5v0_config_pwr_good_level_get (NRF_VDETAO5V0_Type const *p_reg)
 Function for getting power good detector threshold voltage level.
 
NRF_STATIC_INLINE void nrf_vdetao5v0_trim_pwr_good_set (NRF_VDETAO5V0_Type *p_reg, uint8_t val)
 Function for setting power good detector trimming.
 
NRF_STATIC_INLINE uint8_t nrf_vdetao5v0_trim_pwr_good_get (NRF_VDETAO5V0_Type const *p_reg)
 Function for getting power good detector trimming.
 
NRF_STATIC_INLINE void nrf_vdetao5v0_mirror_lock_set (NRF_VDETAO5V0_Type *p_reg, bool lock)
 Function for locking mirrored registers.
 
NRF_STATIC_INLINE void nrf_vdetao5v0_mode_set (NRF_VDETAO5V0_Type *p_reg, nrf_vdetao5v0_mode_t mode)
 Function for setting voltage detector mode.
 
NRF_STATIC_INLINE nrf_vdetao5v0_mode_t nrf_vdetao5v0_mode_get (NRF_VDETAO5V0_Type const *p_reg)
 Function for getting voltage detector mode.
 
NRF_STATIC_INLINE void nrf_vdetao5v0_override_set (NRF_VDETAO5V0_Type *p_reg, nrf_vdetao5v0_analog_signal_t signal, bool enable, uint8_t val)
 Function for overriding signal to the analog module.
 
NRF_STATIC_INLINE void nrf_vdetao5v0_dft_atb0_config_set (NRF_VDETAO5V0_Type *p_reg, nrf_vdetao5v0_dft_atb0_selmux_t selmux, bool enable)
 Function for configuring Analog Test Bus 0 (ATB0).
 
NRF_STATIC_INLINE void nrf_vdetao5v0_dft_atb1_config_set (NRF_VDETAO5V0_Type *p_reg, nrf_vdetao5v0_dft_atb1_selmux_t selmux, bool enable)
 Function for configuring Analog Test Bus 1 (ATB1).
 
NRF_STATIC_INLINE void nrf_vdetao5v0_dft_dtb0_config_set (NRF_VDETAO5V0_Type *p_reg, nrf_vdetao5v0_dft_dtb0_selmux_t selmux, bool enable)
 Function for configuring Digital Test Bus 0 (DTB0).
 
NRF_STATIC_INLINE void nrf_vdetao5v0_dft_dtb1_config_set (NRF_VDETAO5V0_Type *p_reg, nrf_vdetao5v0_dft_dtb1_selmux_t selmux, bool enable)
 Function for configuring Digital Test Bus 1 (DTB1).
 
NRF_STATIC_INLINE void nrf_vdetao5v0_dft_dtb3_config_set (NRF_VDETAO5V0_Type *p_reg, bool enable)
 Function for configuring Digital Test Bus 3 (DTB3).
 
NRF_STATIC_INLINE void nrf_vdetao5v0_dft_tcfg_config_set (NRF_VDETAO5V0_Type *p_reg, nrf_vdetao5v0_tcfg_t tcfg)
 Function for configuring test mode.
 

Detailed Description

Hardware access layer for managing the Always-on 5.0V Voltage Detector (VDETAO5V0).

Enumeration Type Documentation

◆ nrf_vdetao5v0_analog_signal_t

Analog signal to be overridden.

Enumerator
NRF_VDETAO5V0_ANALOG_SIGNAL_PWRUP 

Override PWRUP signal.

NRF_VDETAO5V0_ANALOG_SIGNAL_RETAIN 

Override RETAIN signal.

NRF_VDETAO5V0_ANALOG_SIGNAL_MODE_ULPR 

Override MODE ULPR signal.

NRF_VDETAO5V0_ANALOG_SIGNAL_MODE_LP 

Override MODE LP signal.

NRF_VDETAO5V0_ANALOG_SIGNAL_READY 

Override READY signal.

NRF_VDETAO5V0_ANALOG_SIGNAL_SETTLED 

Override SETTLED signal.

NRF_VDETAO5V0_ANALOG_SIGNAL_PGD 

Override PGD signal.

◆ nrf_vdetao5v0_dft_atb0_selmux_t

Select multiplexer for ATB0.

Enumerator
NRF_VDETAO5V0_DFT_ATB0_SELMUX_NONE 

None selected.

NRF_VDETAO5V0_DFT_ATB0_SELMUX_CONNECT_IDBG_1U 

Connect IDBG_1U.

NRF_VDETAO5V0_DFT_ATB0_SELMUX_CONNECT_VREF_VFB_DIV 

Connect input of VREF/VFB_DIV buffer.

NRF_VDETAO5V0_DFT_ATB0_SELMUX_CONNECT_VSS 

Connect VSS.

◆ nrf_vdetao5v0_dft_atb1_selmux_t

Select multiplexer for ATB1.

Enumerator
NRF_VDETAO5V0_DFT_ATB1_SELMUX_CONNECT_VREF_BUF 

Connect buffered VREF.

NRF_VDETAO5V0_DFT_ATB1_SELMUX_CONNECT_VFB_BUF 

Connect buffered VFB_DIV.

◆ nrf_vdetao5v0_dft_dtb0_selmux_t

Select multiplexer for DTB0.

Enumerator
NRF_VDETAO5V0_DFT_DTB0_SELMUX_PGD_COMP_READY 

VDETAO5V0_PGD_COMP_READY.

NRF_VDETAO5V0_DFT_DTB0_SELMUX_PGD_UNLATCHED 

Unlatched PGD signal.

NRF_VDETAO5V0_DFT_DTB0_SELMUX_MODE_LP 

MODE_LP_PGD.

NRF_VDETAO5V0_DFT_DTB0_SELMUX_MODE_ULPR 

MODE_ULPR_PGD.

◆ nrf_vdetao5v0_dft_dtb1_selmux_t

Select multiplexer for DTB1.

Enumerator
NRF_VDETAO5V0_DFT_DTB1_SELMUX_PDG 

VDETAO5V0_PGD.

NRF_VDETAO5V0_DFT_DTB1_SELMUX_PWR_UP 

PWRUP_PGD.

NRF_VDETAO5V0_DFT_DTB1_SELMUX_SETTLED 

SETTLED_VDETAO5V0.

NRF_VDETAO5V0_DFT_DTB1_SELMUX_READY 

READY_VDETAO5V0.

◆ nrf_vdetao5v0_event_t

VDETAO5V0 events.

Enumerator
NRF_VDETAO5V0_EVENT_READY 

Power up done.

NRF_VDETAO5V0_EVENT_SETTLED 

Settled flag for MODE handshake.

◆ nrf_vdetao5v0_int_mask_t

VDETAO5V0 interrupts.

Enumerator
NRF_VDETAO5V0_INT_READY_MASK 

Interrupt on READY.

NRF_VDETAO5V0_INT_SETTLED_MASK 

Interrupt on SETTLED.

◆ nrf_vdetao5v0_mode_t

Voltage detector mode.

Enumerator
NRF_VDETAO5V0_MODE_AUTO 

Automatically handled by the peripheral.

NRF_VDETAO5V0_MODE_HIGH_POWER 

High power mode.

NRF_VDETAO5V0_MODE_LOW_POWER 

Low power mode.

NRF_VDETAO5V0_MODE_ULP_REFRESH 

Ultra-low power refresh mode.

◆ nrf_vdetao5v0_pwr_good_hyst_t

Power good detector hysteresis voltage value.

Enumerator
NRF_VDETAO5V0_PWR_GOOD_HYST_50_MV 

Hysteresis voltage is 50mV.

NRF_VDETAO5V0_PWR_GOOD_HYST_25_MV 

Hysteresis voltage is 25mV.

NRF_VDETAO5V0_PWR_GOOD_HYST_150_MV 

Hysteresis voltage is 150mV.

NRF_VDETAO5V0_PWR_GOOD_HYST_100_MV 

Hysteresis voltage is 100mV.

◆ nrf_vdetao5v0_status_t

STATUS register states.

Enumerator
NRF_VDETAO5V0_STATUS_HIGH_POWER 

High power mode.

NRF_VDETAO5V0_STATUS_LOW_POWER 

Low power mode.

NRF_VDETAO5V0_STATUS_ULP_REFRESH 

ULP refresh mode.

◆ nrf_vdetao5v0_statusana_mask_t

STATUSANA register bit masks.

Enumerator
NRF_VDETAO5V0_STATUSANA_READY_MASK 

Current value of READY signal.

NRF_VDETAO5V0_STATUSANA_SETTLED_MASK 

Current value of SETTLED signal.

NRF_VDETAO5V0_STATUSANA_PGD_MASK 

Current value of PGD signal.

◆ nrf_vdetao5v0_task_t

VDETAO5V0 tasks.

Enumerator
NRF_VDETAO5V0_TASK_PWR_UP 

Power up voltage detector.

NRF_VDETAO5V0_TASK_PWR_DOWN 

Power down voltage detector.

Function Documentation

◆ nrf_vdetao5v0_config_cfg_get()

NRF_STATIC_INLINE void nrf_vdetao5v0_config_cfg_get ( NRF_VDETAO5V0_Type const *  p_reg,
nrf_vdetao5v0_pwr_good_hyst_t p_hyst,
bool *  p_sample_time 
)

Function for getting voltage detector configuration.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[out]p_hystPointer to the location where power good detector hysteresis voltage value is stored.
[out]p_sample_timePointer to the location where sample time extension state is stored.

◆ nrf_vdetao5v0_config_cfg_set()

NRF_STATIC_INLINE void nrf_vdetao5v0_config_cfg_set ( NRF_VDETAO5V0_Type *  p_reg,
nrf_vdetao5v0_pwr_good_hyst_t  hyst,
bool  sample_time 
)

Function for setting voltage detector configuration.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]hystPower good detector hysteresis voltage value.
[in]sample_timeSample time 200ns extension enable.

◆ nrf_vdetao5v0_config_pwr_good_level_get()

NRF_STATIC_INLINE uint8_t nrf_vdetao5v0_config_pwr_good_level_get ( NRF_VDETAO5V0_Type const *  p_reg)

Function for getting power good detector threshold voltage level.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
Returns
Threshold value. The value is 1.85V + 0.10V steps.

◆ nrf_vdetao5v0_config_pwr_good_level_set()

NRF_STATIC_INLINE void nrf_vdetao5v0_config_pwr_good_level_set ( NRF_VDETAO5V0_Type *  p_reg,
uint8_t  thr 
)

Function for setting power good detector threshold voltage level.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]thrThreshold value. The value is 1.85V + 0.10V steps.

◆ nrf_vdetao5v0_dft_atb0_config_set()

NRF_STATIC_INLINE void nrf_vdetao5v0_dft_atb0_config_set ( NRF_VDETAO5V0_Type *  p_reg,
nrf_vdetao5v0_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_vdetao5v0_dft_atb1_config_set()

NRF_STATIC_INLINE void nrf_vdetao5v0_dft_atb1_config_set ( NRF_VDETAO5V0_Type *  p_reg,
nrf_vdetao5v0_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_vdetao5v0_dft_dtb0_config_set()

NRF_STATIC_INLINE void nrf_vdetao5v0_dft_dtb0_config_set ( NRF_VDETAO5V0_Type *  p_reg,
nrf_vdetao5v0_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_vdetao5v0_dft_dtb1_config_set()

NRF_STATIC_INLINE void nrf_vdetao5v0_dft_dtb1_config_set ( NRF_VDETAO5V0_Type *  p_reg,
nrf_vdetao5v0_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_vdetao5v0_dft_dtb3_config_set()

NRF_STATIC_INLINE void nrf_vdetao5v0_dft_dtb3_config_set ( NRF_VDETAO5V0_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_vdetao5v0_dft_tcfg_config_set()

NRF_STATIC_INLINE void nrf_vdetao5v0_dft_tcfg_config_set ( NRF_VDETAO5V0_Type *  p_reg,
nrf_vdetao5v0_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_vdetao5v0_event_address_get()

NRF_STATIC_INLINE uint32_t nrf_vdetao5v0_event_address_get ( NRF_VDETAO5V0_Type const *  p_reg,
nrf_vdetao5v0_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_vdetao5v0_event_check()

NRF_STATIC_INLINE bool nrf_vdetao5v0_event_check ( NRF_VDETAO5V0_Type const *  p_reg,
nrf_vdetao5v0_event_t  event 
)

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

NRF_STATIC_INLINE void nrf_vdetao5v0_event_clear ( NRF_VDETAO5V0_Type *  p_reg,
nrf_vdetao5v0_event_t  event 
)

Function for clearing the specified VDETAO5V0 event.

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

◆ nrf_vdetao5v0_int_disable()

NRF_STATIC_INLINE void nrf_vdetao5v0_int_disable ( NRF_VDETAO5V0_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_vdetao5v0_int_mask_t values for bit masking.

◆ nrf_vdetao5v0_int_enable()

NRF_STATIC_INLINE void nrf_vdetao5v0_int_enable ( NRF_VDETAO5V0_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_vdetao5v0_int_mask_t values for bit masking.

◆ nrf_vdetao5v0_int_enable_check()

NRF_STATIC_INLINE uint32_t nrf_vdetao5v0_int_enable_check ( NRF_VDETAO5V0_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_vdetao5v0_int_mask_t values for bit masking.
Returns
Mask of enabled interrupts.

◆ nrf_vdetao5v0_int_pending_get()

NRF_STATIC_INLINE uint32_t nrf_vdetao5v0_int_pending_get ( NRF_VDETAO5V0_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_vdetao5v0_int_mask_t values for bit masking.

◆ nrf_vdetao5v0_mirror_lock_set()

NRF_STATIC_INLINE void nrf_vdetao5v0_mirror_lock_set ( NRF_VDETAO5V0_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_vdetao5v0_mode_get()

NRF_STATIC_INLINE nrf_vdetao5v0_mode_t nrf_vdetao5v0_mode_get ( NRF_VDETAO5V0_Type const *  p_reg)

Function for getting voltage detector mode.

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

◆ nrf_vdetao5v0_mode_set()

NRF_STATIC_INLINE void nrf_vdetao5v0_mode_set ( NRF_VDETAO5V0_Type *  p_reg,
nrf_vdetao5v0_mode_t  mode 
)

Function for setting voltage detector mode.

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

◆ nrf_vdetao5v0_override_set()

NRF_STATIC_INLINE void nrf_vdetao5v0_override_set ( NRF_VDETAO5V0_Type *  p_reg,
nrf_vdetao5v0_analog_signal_t  signal,
bool  enable,
uint8_t  val 
)

Function for overriding signal to the analog module.

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

◆ nrf_vdetao5v0_status_get()

NRF_STATIC_INLINE nrf_vdetao5v0_status_t nrf_vdetao5v0_status_get ( NRF_VDETAO5V0_Type const *  p_reg)

Function for getting VDETAO5V0 status register.

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

◆ nrf_vdetao5v0_statusana_get()

NRF_STATIC_INLINE uint32_t nrf_vdetao5v0_statusana_get ( NRF_VDETAO5V0_Type const *  p_reg)

Function for getting VDETAO5V0 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_vdetao5v0_statusana_mask_t values for bit masking.

◆ nrf_vdetao5v0_task_address_get()

NRF_STATIC_INLINE uint32_t nrf_vdetao5v0_task_address_get ( NRF_VDETAO5V0_Type const *  p_reg,
nrf_vdetao5v0_task_t  task 
)

Function for getting the address of the specified task register.

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

◆ nrf_vdetao5v0_task_trigger()

NRF_STATIC_INLINE void nrf_vdetao5v0_task_trigger ( NRF_VDETAO5V0_Type *  p_reg,
nrf_vdetao5v0_task_t  task 
)

Function for activating the specified task.

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

◆ nrf_vdetao5v0_trim_pwr_good_get()

NRF_STATIC_INLINE uint8_t nrf_vdetao5v0_trim_pwr_good_get ( NRF_VDETAO5V0_Type const *  p_reg)

Function for getting power good detector trimming.

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

◆ nrf_vdetao5v0_trim_pwr_good_set()

NRF_STATIC_INLINE void nrf_vdetao5v0_trim_pwr_good_set ( NRF_VDETAO5V0_Type *  p_reg,
uint8_t  val 
)

Function for setting power good detector trimming.

Parameters
[in]p_regPointer to the structure of registers of the peripheral.
[in]valTrimming value. The value is 2's complement value of 0mV +/- 14.5mV steps.

Documentation feedback | Developer Zone | Subscribe | Updated