Voltage scaling 0.8V Voltage Detector HAL

Hardware access layer for managing the Voltage scaling 0.8V Voltage Detector (VDETVS0V8). More...

Data Structures
struct	nrf_vdetvs0v8_tcfg_t
	Test mode configuration. More...

Enumerations
enum	nrf_vdetvs0v8_task_t {   NRF_VDETVS0V8_TASK_PWR_UP = offsetof(NRF_VDETVS0V8_Type, TASKS_PWRUP) ,   NRF_VDETVS0V8_TASK_PWR_DOWN = offsetof(NRF_VDETVS0V8_Type, TASKS_PWRDOWN) ,   NRF_VDETVS0V8_TASK_START_PWR_GOOD = offsetof(NRF_VDETVS0V8_Type, TASKS_STARTPWRGOOD) ,   NRF_VDETVS0V8_TASK_CANCEL_PWR_GOOD = offsetof(NRF_VDETVS0V8_Type, TASKS_CANCELPWRGOOD) ,   NRF_VDETVS0V8_TASK_APPLY_BROWNOUT = offsetof(NRF_VDETVS0V8_Type, TASKS_APPLYBROWNOUT) }
	VDETVS0V8 tasks. More...
enum	nrf_vdetvs0v8_event_t {   NRF_VDETVS0V8_EVENT_READY = offsetof(NRF_VDETVS0V8_Type, EVENTS_READY) ,   NRF_VDETVS0V8_EVENT_SETTLED = offsetof(NRF_VDETVS0V8_Type, EVENTS_SETTLED) ,   NRF_VDETVS0V8_EVENT_PWR_GOOD = offsetof(NRF_VDETVS0V8_Type, EVENTS_PWRGOOD) ,   NRF_VDETVS0V8_EVENT_BROWNOUT = offsetof(NRF_VDETVS0V8_Type, EVENTS_BROWNOUT) }
	VDETVS0V8 events. More...
enum	nrf_vdetvs0v8_int_mask_t {   NRF_VDETVS0V8_INT_READY_MASK = VDETVS0V8_INTEN_READY_Msk ,   NRF_VDETVS0V8_INT_SETTLED_MASK = VDETVS0V8_INTEN_SETTLED_Msk ,   NRF_VDETVS0V8_INT_PWR_GOOD_MASK = VDETVS0V8_INTEN_PWRGOOD_Msk ,   NRF_VDETVS0V8_INT_BROWNOUT_MASK = VDETVS0V8_INTEN_BROWNOUT_Msk }
	VDETVS0V8 interrupts. More...
enum	nrf_vdetvs0v8_status_mode_t {   NRF_VDETVS0V8_STATUS_MODE_HIGH_POWER = VDETVS0V8_STATUS_MODE_HighPower ,   NRF_VDETVS0V8_STATUS_MODE_LOW_POWER = VDETVS0V8_STATUS_MODE_LowPower ,   NRF_VDETVS0V8_STATUS_MODE_ULP_REFRESH = VDETVS0V8_STATUS_MODE_UltraLowPowerRefresh }
	STATUS mode states. More...
enum	nrf_vdetvs0v8_statusana_mask_t {   NRF_VDETVS0V8_STATUSANA_READY_MASK = VDETVS0V8_STATUSANA_READY_Msk ,   NRF_VDETVS0V8_STATUSANA_SETTLED_MASK = VDETVS0V8_STATUSANA_SETTLED_Msk ,   NRF_VDETVS0V8_STATUSANA_BOD_MASK = VDETVS0V8_STATUSANA_BOD_Msk ,   NRF_VDETVS0V8_STATUSANA_PGD_MASK = VDETVS0V8_STATUSANA_PGD_Msk }
	STATUSANA register bit masks. More...
enum	nrf_vdetvs0v8_brownout_hyst_t {   NRF_VDETVS0V8_BROWNOUT_HYST_25_MV = VDETVS0V8_CONFIG_CFG_BROWNOUTHYST_Val0V0250 ,   NRF_VDETVS0V8_BROWNOUT_HYST_50_MV = VDETVS0V8_CONFIG_CFG_BROWNOUTHYST_Val0V0500 ,   NRF_VDETVS0V8_BROWNOUT_HYST_12_5_MV = VDETVS0V8_CONFIG_CFG_BROWNOUTHYST_Val0V0125 ,   NRF_VDETVS0V8_BROWNOUT_HYST_16_7_MV = VDETVS0V8_CONFIG_CFG_BROWNOUTHYST_Val0V0167 }
	Brown out detector hysteresis voltage value. More...
enum	nrf_vdetvs0v8_config_thr_t {   NRF_VDETVS0V8_CONFIG_THR_PWR_GOOD_LVL ,   NRF_VDETVS0V8_CONFIG_THR_BROWNOUT_LVL }
	Threshold configuration type.
enum	nrf_vdetvs0v8_mode_t {   NRF_VDETVS0V8_MODE_AUTO = VDETVS0V8_MODE_MODE_Auto ,   NRF_VDETVS0V8_MODE_HIGH_POWER = VDETVS0V8_MODE_MODE_HighPower ,   NRF_VDETVS0V8_MODE_LOW_POWER = VDETVS0V8_MODE_MODE_LowPower ,   NRF_VDETVS0V8_MODE_ULP_REFRESH = VDETVS0V8_MODE_MODE_UltraLowPowerRefresh }
	Voltage detector mode. More...
enum	nrf_vdetvs0v8_analog_signal_t {   NRF_VDETVS0V8_ANALOG_SIGNAL_PWRUP ,   NRF_VDETVS0V8_ANALOG_SIGNAL_RETAIN ,   NRF_VDETVS0V8_ANALOG_SIGNAL_MODE_ULPR ,   NRF_VDETVS0V8_ANALOG_SIGNAL_MODE_LP ,   NRF_VDETVS0V8_ANALOG_SIGNAL_PGD_REQUEST ,   NRF_VDETVS0V8_ANALOG_SIGNAL_PGD_CANCEL ,   NRF_VDETVS0V8_ANALOG_SIGNAL_READY ,   NRF_VDETVS0V8_ANALOG_SIGNAL_SETTLED ,   NRF_VDETVS0V8_ANALOG_SIGNAL_BOD ,   NRF_VDETVS0V8_ANALOG_SIGNAL_PGD ,   NRF_VDETVS0V8_ANALOG_SIGNAL_BOD_VOLT_SEL }
	Analog signal to be overridden. More...
enum	nrf_vdetvs0v8_dft_atb0_selmux_t {   NRF_VDETVS0V8_DFT_ATB0_SELMUX_NONE = VDETVS0V8_DFT_ATB0CONFIG_SELMUX_None ,   NRF_VDETVS0V8_DFT_ATB0_SELMUX_CONNECT_IDBG_1U = VDETVS0V8_DFT_ATB0CONFIG_SELMUX_ConnectIDBG1U ,   NRF_VDETVS0V8_DFT_ATB0_SELMUX_CONNECT_VSS = VDETVS0V8_DFT_ATB0CONFIG_SELMUX_ConnectVSS ,   NRF_VDETVS0V8_DFT_ATB0_SELMUX_CONNECT_SENSE_VOLTAGE = VDETVS0V8_DFT_ATB0CONFIG_SELMUX_ConnectSenseVoltage }
	Select multiplexer for ATB0. More...
enum	nrf_vdetvs0v8_dft_atb1_selmux_t {   NRF_VDETVS0V8_DFT_ATB1_SELMUX_NONE = VDETVS0V8_DFT_ATB1CONFIG_SELMUX_None ,   NRF_VDETVS0V8_DFT_ATB1_SELMUX_CONNECT_VREF_BOD = VDETVS0V8_DFT_ATB1CONFIG_SELMUX_ConnectVREFBOD }
	Select multiplexer for ATB1. More...
enum	nrf_vdetvs0v8_dft_dtb0_selmux_t {   NRF_VDETVS0V8_DFT_DTB0_SELMUX_SPARE0 = VDETVS0V8_DFT_DTB0CONFIG_SELMUX_Spare0 ,   NRF_VDETVS0V8_DFT_DTB0_SELMUX_SETTLED_VDETA0V8_AO_0V8 = VDETVS0V8_DFT_DTB0CONFIG_SELMUX_SettledVDETAO0V8AO0V8 ,   NRF_VDETVS0V8_DFT_DTB0_SELMUX_PGD_COMP_OUTPUT = VDETVS0V8_DFT_DTB0CONFIG_SELMUX_PGDCompOutput ,   NRF_VDETVS0V8_DFT_DTB0_SELMUX_PGD_COMP_OUTPUT_POST = VDETVS0V8_DFT_DTB0CONFIG_SELMUX_PGDCompOutputPost ,   NRF_VDETVS0V8_DFT_DTB0_SELMUX_PWRUP_PGD_SW_1V8 = VDETVS0V8_DFT_DTB0CONFIG_SELMUX_PWRUPPGDSW1V8 ,   NRF_VDETVS0V8_DFT_DTB0_SELMUX_SPARE1 = VDETVS0V8_DFT_DTB0CONFIG_SELMUX_Spare1 ,   NRF_VDETVS0V8_DFT_DTB0_SELMUX_BOD_LOCK_ACK_SW_1V8 = VDETVS0V8_DFT_DTB0CONFIG_SELMUX_BODLockAckSW1V8 ,   NRF_VDETVS0V8_DFT_DTB0_SELMUX_SPARE2 = VDETVS0V8_DFT_DTB0CONFIG_SELMUX_Spare2 }
	Select multiplexer for DTB0. More...
enum	nrf_vdetvs0v8_dft_dtb1_selmux_t {   NRF_VDETVS0V8_DFT_DTB1_SELMUX_SPARE0 = VDETVS0V8_DFT_DTB1CONFIG_SELMUX_Spare0 ,   NRF_VDETVS0V8_DFT_DTB1_SELMUX_READY_VDETA0V8_AO_0V8 = VDETVS0V8_DFT_DTB1CONFIG_SELMUX_ReadyVDETAO0V8AO0V8 ,   NRF_VDETVS0V8_DFT_DTB1_SELMUX_BOD_COMP_OUTPUT = VDETVS0V8_DFT_DTB1CONFIG_SELMUX_BODCompOutput ,   NRF_VDETVS0V8_DFT_DTB1_SELMUX_BOD_COMP_OUTPUT_POST = VDETVS0V8_DFT_DTB1CONFIG_SELMUX_BODCompOutputPost ,   NRF_VDETVS0V8_DFT_DTB1_SELMUX_PWRUP_BOD_SW_1V8 = VDETVS0V8_DFT_DTB1CONFIG_SELMUX_PWRUPBODSW1V8 ,   NRF_VDETVS0V8_DFT_DTB1_SELMUX_PWRUP_BOD_BIAS_SW_1V8 = VDETVS0V8_DFT_DTB1CONFIG_SELMUX_PWRUPBODBIASSW1V8 ,   NRF_VDETVS0V8_DFT_DTB1_SELMUX_BOD_LOCK_REQ_SW_1V8 = VDETVS0V8_DFT_DTB1CONFIG_SELMUX_BODLockReqSW1V8 ,   NRF_VDETVS0V8_DFT_DTB1_SELMUX_READY_BOD_SW_1V8 = VDETVS0V8_DFT_DTB1CONFIG_SELMUX_ReadyBODSW1V8 }
	Select multiplexer for DTB1. More...

Functions
NRF_STATIC_INLINE void	nrf_vdetvs0v8_task_trigger (NRF_VDETVS0V8_Type *p_reg, nrf_vdetvs0v8_task_t task)
	Function for activating the specified task.
NRF_STATIC_INLINE uint32_t	nrf_vdetvs0v8_task_address_get (NRF_VDETVS0V8_Type const *p_reg, nrf_vdetvs0v8_task_t task)
	Function for getting the address of the specified task register.
NRF_STATIC_INLINE void	nrf_vdetvs0v8_event_clear (NRF_VDETVS0V8_Type *p_reg, nrf_vdetvs0v8_event_t event)
	Function for clearing the specified VDETVS0V8 event.
NRF_STATIC_INLINE bool	nrf_vdetvs0v8_event_check (NRF_VDETVS0V8_Type const *p_reg, nrf_vdetvs0v8_event_t event)
	Function for retrieving the state of the VDETVS0V8 event.
NRF_STATIC_INLINE uint32_t	nrf_vdetvs0v8_event_address_get (NRF_VDETVS0V8_Type const *p_reg, nrf_vdetvs0v8_event_t event)
	Function for getting the address of the specified event register.
NRF_STATIC_INLINE void	nrf_vdetvs0v8_int_enable (NRF_VDETVS0V8_Type *p_reg, uint32_t mask)
	Function for enabling specified interrupts.
NRF_STATIC_INLINE void	nrf_vdetvs0v8_int_disable (NRF_VDETVS0V8_Type *p_reg, uint32_t mask)
	Function for disabling specified interrupts.
NRF_STATIC_INLINE uint32_t	nrf_vdetvs0v8_int_enable_check (NRF_VDETVS0V8_Type const *p_reg, uint32_t mask)
	Function for checking if the specified interrupts are enabled.
NRF_STATIC_INLINE uint32_t	nrf_vdetvs0v8_int_pending_get (NRF_VDETVS0V8_Type const *p_reg)
	Function for retrieving the state of pending interrupts.
NRF_STATIC_INLINE void	nrf_vdetvs0v8_status_get (NRF_VDETVS0V8_Type const *p_reg, nrf_vdetvs0v8_status_mode_t *p_mode, uint8_t *p_curr_bod_lvl)
	Function for getting VDETVS0V8 status register.
NRF_STATIC_INLINE uint32_t	nrf_vdetvs0v8_statusana_get (NRF_VDETVS0V8_Type const *p_reg)
	Function for getting VDETVS0V8 status of the analog module output signals.
NRF_STATIC_INLINE void	nrf_vdetvs0v8_config_cfg_set (NRF_VDETVS0V8_Type *p_reg, nrf_vdetvs0v8_brownout_hyst_t hyst)
	Function for setting voltage detector configuration.
NRF_STATIC_INLINE nrf_vdetvs0v8_brownout_hyst_t	nrf_vdetvs0v8_config_cfg_get (NRF_VDETVS0V8_Type const *p_reg)
	Function for getting voltage detector configuration.
NRF_STATIC_INLINE void	nrf_vdetvs0v8_config_thr_set (NRF_VDETVS0V8_Type *p_reg, nrf_vdetvs0v8_config_thr_t cfg, uint8_t thr)
	Function for setting voltage detector threshold configuration.
NRF_STATIC_INLINE uint8_t	nrf_vdetvs0v8_config_thr_get (NRF_VDETVS0V8_Type const *p_reg, nrf_vdetvs0v8_config_thr_t cfg)
	Function for getting voltage detector threshold configuration.
NRF_STATIC_INLINE void	nrf_vdetvs0v8_trim_brownout_set (NRF_VDETVS0V8_Type *p_reg, uint8_t val)
	Function for setting brown out detector trimming.
NRF_STATIC_INLINE uint8_t	nrf_vdetvs0v8_trim_brownout_get (NRF_VDETVS0V8_Type const *p_reg)
	Function for getting brown out detector trimming.
NRF_STATIC_INLINE void	nrf_vdetvs0v8_trim_pwr_good_set (NRF_VDETVS0V8_Type *p_reg, uint8_t val)
	Function for setting power good detector trimming.
NRF_STATIC_INLINE uint8_t	nrf_vdetvs0v8_trim_pwr_good_get (NRF_VDETVS0V8_Type const *p_reg)
	Function for getting power good detector trimming.
NRF_STATIC_INLINE void	nrf_vdetvs0v8_mirror_lock_set (NRF_VDETVS0V8_Type *p_reg, bool lock)
	Function for locking mirrored registers.
NRF_STATIC_INLINE void	nrf_vdetvs0v8_mode_set (NRF_VDETVS0V8_Type *p_reg, nrf_vdetvs0v8_mode_t mode)
	Function for setting voltage detector mode.
NRF_STATIC_INLINE nrf_vdetvs0v8_mode_t	nrf_vdetvs0v8_mode_get (NRF_VDETVS0V8_Type const *p_reg)
	Function for getting voltage detector mode.
NRF_STATIC_INLINE void	nrf_vdetvs0v8_override_set (NRF_VDETVS0V8_Type *p_reg, nrf_vdetvs0v8_analog_signal_t signal, bool enable, uint8_t val)
	Function for overriding signal to the analog module.
NRF_STATIC_INLINE void	nrf_vdetvs0v8_dft_atb0_config_set (NRF_VDETVS0V8_Type *p_reg, nrf_vdetvs0v8_dft_atb0_selmux_t selmux, bool enable)
	Function for configuring Analog Test Bus 0 (ATB0).
NRF_STATIC_INLINE void	nrf_vdetvs0v8_dft_atb1_config_set (NRF_VDETVS0V8_Type *p_reg, nrf_vdetvs0v8_dft_atb1_selmux_t selmux, bool enable)
	Function for configuring Analog Test Bus 1 (ATB1).
NRF_STATIC_INLINE void	nrf_vdetvs0v8_dft_dtb0_config_set (NRF_VDETVS0V8_Type *p_reg, nrf_vdetvs0v8_dft_dtb0_selmux_t selmux, bool enable)
	Function for configuring Digital Test Bus 0 (DTB0).
NRF_STATIC_INLINE void	nrf_vdetvs0v8_dft_dtb1_config_set (NRF_VDETVS0V8_Type *p_reg, nrf_vdetvs0v8_dft_dtb1_selmux_t selmux, bool enable)
	Function for configuring Digital Test Bus 1 (DTB1).
NRF_STATIC_INLINE void	nrf_vdetvs0v8_dft_dtb3_config_set (NRF_VDETVS0V8_Type *p_reg, bool enable)
	Function for configuring Digital Test Bus 3 (DTB3).
NRF_STATIC_INLINE void	nrf_vdetvs0v8_dft_tcfg_config_set (NRF_VDETVS0V8_Type *p_reg, nrf_vdetvs0v8_tcfg_t tcfg)
	Function for configuring test mode.

Detailed Description

Hardware access layer for managing the Voltage scaling 0.8V Voltage Detector (VDETVS0V8).

Enumeration Type Documentation

nrf_vdetvs0v8_analog_signal_t

enum nrf_vdetvs0v8_analog_signal_t

Analog signal to be overridden.

Enumerator
NRF_VDETVS0V8_ANALOG_SIGNAL_PWRUP	Override PWRUP signal.
NRF_VDETVS0V8_ANALOG_SIGNAL_RETAIN	Override RETAIN signal.
NRF_VDETVS0V8_ANALOG_SIGNAL_MODE_ULPR	Override MODE ULPR signal.
NRF_VDETVS0V8_ANALOG_SIGNAL_MODE_LP	Override MODE LP signal.
NRF_VDETVS0V8_ANALOG_SIGNAL_PGD_REQUEST	Override PDGREQUEST signal.
NRF_VDETVS0V8_ANALOG_SIGNAL_PGD_CANCEL	Override PDGCANCEL signal.
NRF_VDETVS0V8_ANALOG_SIGNAL_READY	Override READY signal.
NRF_VDETVS0V8_ANALOG_SIGNAL_SETTLED	Override SETTLED signal.
NRF_VDETVS0V8_ANALOG_SIGNAL_BOD	Override BOD signal.
NRF_VDETVS0V8_ANALOG_SIGNAL_PGD	Override PGD signal.
NRF_VDETVS0V8_ANALOG_SIGNAL_BOD_VOLT_SEL	Override BODVOLTSEL signal.

nrf_vdetvs0v8_brownout_hyst_t

enum nrf_vdetvs0v8_brownout_hyst_t

Brown out detector hysteresis voltage value.

Enumerator
NRF_VDETVS0V8_BROWNOUT_HYST_25_MV	Hysteresis voltage is 25mV.
NRF_VDETVS0V8_BROWNOUT_HYST_50_MV	Hysteresis voltage is 50mV.
NRF_VDETVS0V8_BROWNOUT_HYST_12_5_MV	Hysteresis voltage is 12.5mV.
NRF_VDETVS0V8_BROWNOUT_HYST_16_7_MV	Hysteresis voltage is 16.7mV.

nrf_vdetvs0v8_dft_atb0_selmux_t

enum nrf_vdetvs0v8_dft_atb0_selmux_t

Select multiplexer for ATB0.

Enumerator
NRF_VDETVS0V8_DFT_ATB0_SELMUX_NONE	None selected.
NRF_VDETVS0V8_DFT_ATB0_SELMUX_CONNECT_IDBG_1U	Connect IDBG_1U to ATB0.
NRF_VDETVS0V8_DFT_ATB0_SELMUX_CONNECT_VSS	Connect VSS to ATB0.
NRF_VDETVS0V8_DFT_ATB0_SELMUX_CONNECT_SENSE_VOLTAGE	Use ARB0 as sense voltage instead of VDD_SENSE_0V8.

nrf_vdetvs0v8_dft_atb1_selmux_t

enum nrf_vdetvs0v8_dft_atb1_selmux_t

Select multiplexer for ATB1.

Enumerator
NRF_VDETVS0V8_DFT_ATB1_SELMUX_NONE	None selected.
NRF_VDETVS0V8_DFT_ATB1_SELMUX_CONNECT_VREF_BOD	Connect VREF_BOD to ATB1.

nrf_vdetvs0v8_dft_dtb0_selmux_t

enum nrf_vdetvs0v8_dft_dtb0_selmux_t

Select multiplexer for DTB0.

Enumerator
NRF_VDETVS0V8_DFT_DTB0_SELMUX_SPARE0	None selected, logic 0.
NRF_VDETVS0V8_DFT_DTB0_SELMUX_SETTLED_VDETA0V8_AO_0V8	SETTLED_VDETAO0V8_AO_0V8.
NRF_VDETVS0V8_DFT_DTB0_SELMUX_PGD_COMP_OUTPUT	PGD comparator output.
NRF_VDETVS0V8_DFT_DTB0_SELMUX_PGD_COMP_OUTPUT_POST	PGD comparator output after handshake logic.
NRF_VDETVS0V8_DFT_DTB0_SELMUX_PWRUP_PGD_SW_1V8	PWRUP_PGD_SW_1V8.
NRF_VDETVS0V8_DFT_DTB0_SELMUX_SPARE1	None selected, logic 0.
NRF_VDETVS0V8_DFT_DTB0_SELMUX_BOD_LOCK_ACK_SW_1V8	BOD_LOCK_ACK_SW_1V8.
NRF_VDETVS0V8_DFT_DTB0_SELMUX_SPARE2	None selected, logic 0.

nrf_vdetvs0v8_dft_dtb1_selmux_t

enum nrf_vdetvs0v8_dft_dtb1_selmux_t

Select multiplexer for DTB1.

Enumerator
NRF_VDETVS0V8_DFT_DTB1_SELMUX_SPARE0	None selected, logic 0.
NRF_VDETVS0V8_DFT_DTB1_SELMUX_READY_VDETA0V8_AO_0V8	READY_VDETAO0V8_AO_0V8.
NRF_VDETVS0V8_DFT_DTB1_SELMUX_BOD_COMP_OUTPUT	BOD comparator output.
NRF_VDETVS0V8_DFT_DTB1_SELMUX_BOD_COMP_OUTPUT_POST	BOD comparator output after deglitch logic.
NRF_VDETVS0V8_DFT_DTB1_SELMUX_PWRUP_BOD_SW_1V8	PWRUP_BOD_SW_1V8.
NRF_VDETVS0V8_DFT_DTB1_SELMUX_PWRUP_BOD_BIAS_SW_1V8	PWRUP_BOD_BIAS_SW_1V8.
NRF_VDETVS0V8_DFT_DTB1_SELMUX_BOD_LOCK_REQ_SW_1V8	BOD_LOCK_REQ_SW_1V8.
NRF_VDETVS0V8_DFT_DTB1_SELMUX_READY_BOD_SW_1V8	READY_BOD_SW_1V8.

nrf_vdetvs0v8_event_t

enum nrf_vdetvs0v8_event_t

VDETVS0V8 events.

Enumerator
NRF_VDETVS0V8_EVENT_READY	Power up done.
NRF_VDETVS0V8_EVENT_SETTLED	Settled flag for MODE handshake.
NRF_VDETVS0V8_EVENT_PWR_GOOD	Power good detector detected voltage above threshold level.
NRF_VDETVS0V8_EVENT_BROWNOUT	VDD_VS supply below brownout threshold.

nrf_vdetvs0v8_int_mask_t

enum nrf_vdetvs0v8_int_mask_t

VDETVS0V8 interrupts.

Enumerator
NRF_VDETVS0V8_INT_READY_MASK	Interrupt on READY.
NRF_VDETVS0V8_INT_SETTLED_MASK	Interrupt on SETTLED.
NRF_VDETVS0V8_INT_PWR_GOOD_MASK	Interrupt on PWRGOOD.
NRF_VDETVS0V8_INT_BROWNOUT_MASK	Interrupt on BROWNOUT.

nrf_vdetvs0v8_mode_t

enum nrf_vdetvs0v8_mode_t

Voltage detector mode.

Enumerator
NRF_VDETVS0V8_MODE_AUTO	Automatically handled by the peripheral.
NRF_VDETVS0V8_MODE_HIGH_POWER	High power mode.
NRF_VDETVS0V8_MODE_LOW_POWER	Low power mode.
NRF_VDETVS0V8_MODE_ULP_REFRESH	Ultra-low power refresh mode.

nrf_vdetvs0v8_status_mode_t

enum nrf_vdetvs0v8_status_mode_t

STATUS mode states.

Enumerator
NRF_VDETVS0V8_STATUS_MODE_HIGH_POWER	High power mode.
NRF_VDETVS0V8_STATUS_MODE_LOW_POWER	Low power mode.
NRF_VDETVS0V8_STATUS_MODE_ULP_REFRESH	ULP refresh mode.

nrf_vdetvs0v8_statusana_mask_t

enum nrf_vdetvs0v8_statusana_mask_t

STATUSANA register bit masks.

Enumerator
NRF_VDETVS0V8_STATUSANA_READY_MASK	Current value of READY signal.
NRF_VDETVS0V8_STATUSANA_SETTLED_MASK	Current value of SETTLED signal.
NRF_VDETVS0V8_STATUSANA_BOD_MASK	Current value of BOD signal.
NRF_VDETVS0V8_STATUSANA_PGD_MASK	Current value of PGD signal.

nrf_vdetvs0v8_task_t

enum nrf_vdetvs0v8_task_t

VDETVS0V8 tasks.

Enumerator
NRF_VDETVS0V8_TASK_PWR_UP	Power up voltage detector.
NRF_VDETVS0V8_TASK_PWR_DOWN	Power down voltage detector.
NRF_VDETVS0V8_TASK_START_PWR_GOOD	Start power good detection.
NRF_VDETVS0V8_TASK_CANCEL_PWR_GOOD	Cancel power good detection.
NRF_VDETVS0V8_TASK_APPLY_BROWNOUT	Apply value in BROWNOUTLVL to the analog module.

Function Documentation

nrf_vdetvs0v8_config_cfg_get()

NRF_STATIC_INLINE nrf_vdetvs0v8_brownout_hyst_t nrf_vdetvs0v8_config_cfg_get

(

NRF_VDETVS0V8_Type const *

p_reg

)

Function for getting voltage detector configuration.

Parameters

[in]

p_reg

Pointer to the structure of registers of the peripheral.

Returns

Brown out detector hysteresis voltage value.

nrf_vdetvs0v8_config_cfg_set()

NRF_STATIC_INLINE void nrf_vdetvs0v8_config_cfg_set	(	NRF_VDETVS0V8_Type *	p_reg,
		nrf_vdetvs0v8_brownout_hyst_t	hyst
	)

Function for setting voltage detector configuration.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	hyst	Brown out detector hysteresis voltage value.

nrf_vdetvs0v8_config_thr_get()

NRF_STATIC_INLINE uint8_t nrf_vdetvs0v8_config_thr_get	(	NRF_VDETVS0V8_Type const *	p_reg,
		nrf_vdetvs0v8_config_thr_t	cfg
	)

Function for getting voltage detector threshold configuration.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	cfg	Threshold type.

Returns

Threshold value. The value is 0.25V + 0.01V steps.

nrf_vdetvs0v8_config_thr_set()

NRF_STATIC_INLINE void nrf_vdetvs0v8_config_thr_set	(	NRF_VDETVS0V8_Type *	p_reg,
		nrf_vdetvs0v8_config_thr_t	cfg,
		uint8_t	thr
	)

Function for setting voltage detector threshold configuration.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	cfg	Threshold type.
[in]	thr	Threshold value. The value is 0.25V + 0.01V steps.

nrf_vdetvs0v8_dft_atb0_config_set()

NRF_STATIC_INLINE void nrf_vdetvs0v8_dft_atb0_config_set	(	NRF_VDETVS0V8_Type *	p_reg,
		nrf_vdetvs0v8_dft_atb0_selmux_t	selmux,
		bool	enable
	)

Function for configuring Analog Test Bus 0 (ATB0).

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	selmux	Multiplexer configuration.
[in]	enable	True to enable test bus.

nrf_vdetvs0v8_dft_atb1_config_set()

NRF_STATIC_INLINE void nrf_vdetvs0v8_dft_atb1_config_set	(	NRF_VDETVS0V8_Type *	p_reg,
		nrf_vdetvs0v8_dft_atb1_selmux_t	selmux,
		bool	enable
	)

Function for configuring Analog Test Bus 1 (ATB1).

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	selmux	Multiplexer configuration.
[in]	enable	True to enable test bus.

nrf_vdetvs0v8_dft_dtb0_config_set()

NRF_STATIC_INLINE void nrf_vdetvs0v8_dft_dtb0_config_set	(	NRF_VDETVS0V8_Type *	p_reg,
		nrf_vdetvs0v8_dft_dtb0_selmux_t	selmux,
		bool	enable
	)

Function for configuring Digital Test Bus 0 (DTB0).

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	selmux	Multiplexer configuration.
[in]	enable	True to enable test bus.

nrf_vdetvs0v8_dft_dtb1_config_set()

NRF_STATIC_INLINE void nrf_vdetvs0v8_dft_dtb1_config_set	(	NRF_VDETVS0V8_Type *	p_reg,
		nrf_vdetvs0v8_dft_dtb1_selmux_t	selmux,
		bool	enable
	)

Function for configuring Digital Test Bus 1 (DTB1).

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	selmux	Multiplexer configuration.
[in]	enable	True to enable test bus.

nrf_vdetvs0v8_dft_dtb3_config_set()

NRF_STATIC_INLINE void nrf_vdetvs0v8_dft_dtb3_config_set	(	NRF_VDETVS0V8_Type *	p_reg,
		bool	enable
	)

Function for configuring Digital Test Bus 3 (DTB3).

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	enable	True to enable PWRUP delay test circuit.

nrf_vdetvs0v8_dft_tcfg_config_set()

NRF_STATIC_INLINE void nrf_vdetvs0v8_dft_tcfg_config_set	(	NRF_VDETVS0V8_Type *	p_reg,
		nrf_vdetvs0v8_tcfg_t	tcfg
	)

Function for configuring test mode.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	tcfg	Test mode configuration.

nrf_vdetvs0v8_event_address_get()

NRF_STATIC_INLINE uint32_t nrf_vdetvs0v8_event_address_get	(	NRF_VDETVS0V8_Type const *	p_reg,
		nrf_vdetvs0v8_event_t	event
	)

Function for getting the address of the specified event register.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	The specified event.

Returns

Address of the specified event register.

nrf_vdetvs0v8_event_check()

NRF_STATIC_INLINE bool nrf_vdetvs0v8_event_check	(	NRF_VDETVS0V8_Type const *	p_reg,
		nrf_vdetvs0v8_event_t	event
	)

Function for retrieving the state of the VDETVS0V8 event.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	Event to be checked.

Return values

true	The event has been generated.
false	The event has not been generated.

nrf_vdetvs0v8_event_clear()

NRF_STATIC_INLINE void nrf_vdetvs0v8_event_clear	(	NRF_VDETVS0V8_Type *	p_reg,
		nrf_vdetvs0v8_event_t	event
	)

Function for clearing the specified VDETVS0V8 event.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	Event to be cleared.

nrf_vdetvs0v8_int_disable()

NRF_STATIC_INLINE void nrf_vdetvs0v8_int_disable	(	NRF_VDETVS0V8_Type *	p_reg,
		uint32_t	mask
	)

Function for disabling specified interrupts.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Mask of interrupts to be disabled. Use nrf_vdetvs0v8_int_mask_t values for bit masking.

nrf_vdetvs0v8_int_enable()

NRF_STATIC_INLINE void nrf_vdetvs0v8_int_enable	(	NRF_VDETVS0V8_Type *	p_reg,
		uint32_t	mask
	)

Function for enabling specified interrupts.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Mask of interrupts to be enabled. Use nrf_vdetvs0v8_int_mask_t values for bit masking.

nrf_vdetvs0v8_int_enable_check()

NRF_STATIC_INLINE uint32_t nrf_vdetvs0v8_int_enable_check	(	NRF_VDETVS0V8_Type const *	p_reg,
		uint32_t	mask
	)

Function for checking if the specified interrupts are enabled.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Mask of interrupts to be checked. Use nrf_vdetvs0v8_int_mask_t values for bit masking.

Returns

Mask of enabled interrupts.

nrf_vdetvs0v8_int_pending_get()

NRF_STATIC_INLINE uint32_t nrf_vdetvs0v8_int_pending_get

(

NRF_VDETVS0V8_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_reg

Pointer to the structure of registers of the peripheral.

Returns

Bitmask with information about pending interrupts. Use nrf_vdetvs0v8_int_mask_t values for bit masking.

nrf_vdetvs0v8_mirror_lock_set()

NRF_STATIC_INLINE void nrf_vdetvs0v8_mirror_lock_set	(	NRF_VDETVS0V8_Type *	p_reg,
		bool	lock
	)

Function for locking mirrored registers.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	lock	When true lock is enabled. When false lock is disabled and mirrored registers can be updated at any time.

nrf_vdetvs0v8_mode_get()

NRF_STATIC_INLINE nrf_vdetvs0v8_mode_t nrf_vdetvs0v8_mode_get

(

NRF_VDETVS0V8_Type const *

p_reg

)

Function for getting voltage detector mode.

Parameters

[in]

p_reg

Pointer to the structure of registers of the peripheral.

Returns

Mode.

nrf_vdetvs0v8_mode_set()

NRF_STATIC_INLINE void nrf_vdetvs0v8_mode_set	(	NRF_VDETVS0V8_Type *	p_reg,
		nrf_vdetvs0v8_mode_t	mode
	)

Function for setting voltage detector mode.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mode	Mode.

nrf_vdetvs0v8_override_set()

NRF_STATIC_INLINE void nrf_vdetvs0v8_override_set	(	NRF_VDETVS0V8_Type *	p_reg,
		nrf_vdetvs0v8_analog_signal_t	signal,
		bool	enable,
		uint8_t	val
	)

Function for overriding signal to the analog module.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	signal	Signal to be overridden.
[in]	enable	True to enable override and false to disable.
[in]	val	Override value.

nrf_vdetvs0v8_status_get()

NRF_STATIC_INLINE void nrf_vdetvs0v8_status_get	(	NRF_VDETVS0V8_Type const *	p_reg,
		nrf_vdetvs0v8_status_mode_t *	p_mode,
		uint8_t *	p_curr_bod_lvl
	)

Function for getting VDETVS0V8 status register.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[out]	p_mode	Pointer to the location where mode value is stored.
[out]	p_curr_bod_lvl	Pointer to the location where the current brownout level applied to the analog module is stored.

nrf_vdetvs0v8_statusana_get()

NRF_STATIC_INLINE uint32_t nrf_vdetvs0v8_statusana_get

(

NRF_VDETVS0V8_Type const *

p_reg

)

Function for getting VDETVS0V8 status of the analog module output signals.

Parameters

[in]

p_reg

Pointer to the structure of registers of the peripheral.

Returns

The STATUSANA register value. Use nrf_vdetvs0v8_statusana_mask_t values for bit masking.

nrf_vdetvs0v8_task_address_get()

NRF_STATIC_INLINE uint32_t nrf_vdetvs0v8_task_address_get	(	NRF_VDETVS0V8_Type const *	p_reg,
		nrf_vdetvs0v8_task_t	task
	)

Function for getting the address of the specified task register.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	task	The specified task.

Returns

Address of the specified task register.

nrf_vdetvs0v8_task_trigger()

NRF_STATIC_INLINE void nrf_vdetvs0v8_task_trigger	(	NRF_VDETVS0V8_Type *	p_reg,
		nrf_vdetvs0v8_task_t	task
	)

Function for activating the specified task.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	task	Task to be activated.

nrf_vdetvs0v8_trim_brownout_get()

NRF_STATIC_INLINE uint8_t nrf_vdetvs0v8_trim_brownout_get

(

NRF_VDETVS0V8_Type const *

p_reg

)

Function for getting brown out detector trimming.

Parameters

[in]

p_reg

Pointer to the structure of registers of the peripheral.

Returns

Trimming value.

nrf_vdetvs0v8_trim_brownout_set()

NRF_STATIC_INLINE void nrf_vdetvs0v8_trim_brownout_set	(	NRF_VDETVS0V8_Type *	p_reg,
		uint8_t	val
	)

Function for setting brown out detector trimming.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	val	Trimming value. The value is 2's complement value of 0mV +/- 4mV steps.

nrf_vdetvs0v8_trim_pwr_good_get()

NRF_STATIC_INLINE uint8_t nrf_vdetvs0v8_trim_pwr_good_get

(

NRF_VDETVS0V8_Type const *

p_reg

)

Function for getting power good detector trimming.

Parameters

[in]

p_reg

Pointer to the structure of registers of the peripheral.

Returns

Trimming value.

nrf_vdetvs0v8_trim_pwr_good_set()

NRF_STATIC_INLINE void nrf_vdetvs0v8_trim_pwr_good_set	(	NRF_VDETVS0V8_Type *	p_reg,
		uint8_t	val
	)

Function for setting power good detector trimming.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	val	Trimming value. The value is 2's complement value of 0mV +/- 4mV steps.