Hardware access layer for managing the Watchdog Timer (WDT) peripheral. More...

Macros
#define	NRF_WDT_INST_GET(idx)
	Macro getting pointer to the structure of registers of the WDT peripheral.

#define	NRF_WDT_HAS_STOP 1
	Presence of Task STOP functionality.

#define	NRF_WDT_HAS_NMI 1
	Presence of non-maskable interrupt configuration.

#define	NRF_WDT_CHANNEL_NUMBER WDT_RR_MaxCount
	Number of WDT channels.

#define	NRF_WDT_RR_VALUE WDT_RR_RR_Reload
	WDT register reload value.

#define	NRF_WDT_RR_VALUE_MS 0x07CFFFFFUL
	WDT maximum reload value in miliseconds.

Enumerations
enum	nrf_wdt_task_t { NRF_WDT_TASK_START = offsetof(NRF_WDT_Type, TASKS_START) , NRF_WDT_TASK_STOP = offsetof(NRF_WDT_Type, TASKS_STOP) }
	WDT tasks. More...

enum	nrf_wdt_event_t { NRF_WDT_EVENT_TIMEOUT = offsetof(NRF_WDT_Type, EVENTS_TIMEOUT) , NRF_WDT_EVENT_STOPPED = offsetof(NRF_WDT_Type, EVENTS_STOPPED) }
	WDT events. More...

enum	nrf_wdt_behaviour_mask_t { NRF_WDT_BEHAVIOUR_RUN_SLEEP_MASK = WDT_CONFIG_SLEEP_Msk , NRF_WDT_BEHAVIOUR_RUN_HALT_MASK = WDT_CONFIG_HALT_Msk , NRF_WDT_BEHAVIOUR_STOP_ENABLE_MASK = WDT_CONFIG_STOPEN_Msk }
	WDT behavior in the SLEEP or HALT CPU modes. More...

enum	nrf_wdt_rr_register_t { NRF_WDT_RR0 = 0 , NRF_WDT_RR1 , NRF_WDT_RR2 , NRF_WDT_RR3 , NRF_WDT_RR4 , NRF_WDT_RR5 , NRF_WDT_RR6 , NRF_WDT_RR7 }
	WDT reload request registers. More...

enum	nrf_wdt_rr_register_mask_t { NRF_WDT_RR0_MASK = (1UL << NRF_WDT_RR0) , NRF_WDT_RR1_MASK = (1UL << NRF_WDT_RR1) , NRF_WDT_RR2_MASK = (1UL << NRF_WDT_RR2) , NRF_WDT_RR3_MASK = (1UL << NRF_WDT_RR3) , NRF_WDT_RR4_MASK = (1UL << NRF_WDT_RR4) , NRF_WDT_RR5_MASK = (1UL << NRF_WDT_RR5) , NRF_WDT_RR6_MASK = (1UL << NRF_WDT_RR6) , NRF_WDT_RR7_MASK = (1UL << NRF_WDT_RR7) }
	WDT reload request registers mask. More...

enum	nrf_wdt_int_mask_t { NRF_WDT_INT_TIMEOUT_MASK = WDT_INTENSET_TIMEOUT_Msk , NRF_WDT_INT_STOPPED_MASK = WDT_INTENSET_STOPPED_Msk }
	WDT interrupts. More...

Functions
NRF_STATIC_INLINE void	nrf_wdt_behaviour_set (NRF_WDT_Type *p_reg, uint32_t mask)
	Function for configuring the watchdog behaviour when the CPU is sleeping or halted.

NRF_STATIC_INLINE void	nrf_wdt_task_trigger (NRF_WDT_Type *p_reg, nrf_wdt_task_t task)
	Function for starting the WDT task.

NRF_STATIC_INLINE void	nrf_wdt_event_clear (NRF_WDT_Type *p_reg, nrf_wdt_event_t event)
	Function for clearing the WDT event register.

NRF_STATIC_INLINE bool	nrf_wdt_event_check (NRF_WDT_Type const *p_reg, nrf_wdt_event_t event)
	Function for retrieving the state of the WDT event.

NRF_STATIC_INLINE void	nrf_wdt_int_enable (NRF_WDT_Type *p_reg, uint32_t mask)
	Function for enabling the specified interrupts.

NRF_STATIC_INLINE uint32_t	nrf_wdt_int_enable_check (NRF_WDT_Type const *p_reg, uint32_t mask)
	Function for checking if the specified interrupts are enabled.

NRF_STATIC_INLINE void	nrf_wdt_int_disable (NRF_WDT_Type *p_reg, uint32_t mask)
	Function for disabling the specified interrupts.

NRF_STATIC_INLINE void	nrf_wdt_nmi_int_enable (NRF_WDT_Type *p_reg, uint32_t mask)
	Function for enabling the specified non-maskable interrupts.

NRF_STATIC_INLINE uint32_t	nrf_wdt_nmi_int_enable_check (NRF_WDT_Type const *p_reg, uint32_t mask)
	Function for checking if the specified non-maskable interrupts are enabled.

NRF_STATIC_INLINE void	nrf_wdt_nmi_int_disable (NRF_WDT_Type *p_reg, uint32_t mask)
	Function for disabling a specified non-maskable interrupts.

NRF_STATIC_INLINE void	nrf_wdt_subscribe_set (NRF_WDT_Type *p_reg, nrf_wdt_task_t task, uint8_t channel)
	Function for setting the subscribe configuration for a given WDT task.

NRF_STATIC_INLINE void	nrf_wdt_subscribe_clear (NRF_WDT_Type *p_reg, nrf_wdt_task_t task)
	Function for clearing the subscribe configuration for a given WDT task.

NRF_STATIC_INLINE uint32_t	nrf_wdt_subscribe_get (NRF_WDT_Type const *p_reg, nrf_wdt_task_t task)
	Function for getting the subscribe configuration for a given WDT task.

NRF_STATIC_INLINE void	nrf_wdt_publish_set (NRF_WDT_Type *p_reg, nrf_wdt_event_t event, uint8_t channel)
	Function for setting the publish configuration for a given WDT event.

NRF_STATIC_INLINE void	nrf_wdt_publish_clear (NRF_WDT_Type *p_reg, nrf_wdt_event_t event)
	Function for clearing the publish configuration for a given WDT event.

NRF_STATIC_INLINE uint32_t	nrf_wdt_publish_get (NRF_WDT_Type const *p_reg, nrf_wdt_event_t event)
	Function for getting the publish configuration for a given WDT event.

NRF_STATIC_INLINE uint32_t	nrf_wdt_task_address_get (NRF_WDT_Type const *p_reg, nrf_wdt_task_t task)
	Function for returning the address of a specific WDT task register.

NRF_STATIC_INLINE uint32_t	nrf_wdt_event_address_get (NRF_WDT_Type const *p_reg, nrf_wdt_event_t event)
	Function for returning the address of a specific WDT event register.

NRF_STATIC_INLINE bool	nrf_wdt_started_check (NRF_WDT_Type const *p_reg)
	Function for retrieving the watchdog status.

NRF_STATIC_INLINE bool	nrf_wdt_request_status_check (NRF_WDT_Type const *p_reg, nrf_wdt_rr_register_t rr_register)
	Function for retrieving the watchdog reload request status for specified register.

NRF_STATIC_INLINE uint32_t	nrf_wdt_request_status_get (NRF_WDT_Type const *p_reg)
	Function for retrieving the watchdog reload requests status mask.

NRF_STATIC_INLINE void	nrf_wdt_reload_value_set (NRF_WDT_Type *p_reg, uint32_t reload_value)
	Function for setting the watchdog reload value.

NRF_STATIC_INLINE uint32_t	nrf_wdt_reload_value_get (NRF_WDT_Type const *p_reg)
	Function for retrieving the watchdog reload value.

NRF_STATIC_INLINE void	nrf_wdt_reload_request_enable (NRF_WDT_Type *p_reg, nrf_wdt_rr_register_t rr_register)
	Function for enabling a specific reload request register.

NRF_STATIC_INLINE void	nrf_wdt_reload_request_disable (NRF_WDT_Type *p_reg, nrf_wdt_rr_register_t rr_register)
	Function for disabling a specific reload request register.

NRF_STATIC_INLINE bool	nrf_wdt_reload_request_enable_check (NRF_WDT_Type const *p_reg, nrf_wdt_rr_register_t rr_register)
	Function for retrieving the status of a specific reload request register.

NRF_STATIC_INLINE void	nrf_wdt_reload_request_set (NRF_WDT_Type *p_reg, nrf_wdt_rr_register_t rr_register)
	Function for setting a specific reload request register.

NRF_STATIC_INLINE void	nrf_wdt_task_stop_enable_set (NRF_WDT_Type *p_reg, bool enable)
	Function for enabling or disabling stopping the watchdog.

Detailed Description

Hardware access layer for managing the Watchdog Timer (WDT) peripheral.

Macro Definition Documentation

◆ NRF_WDT_INST_GET

#define NRF_WDT_INST_GET ( idx )

Value:

NRFX_CONCAT(NRF_, WDT, idx)

NRFX_CONCAT

#define NRFX_CONCAT(...)

Macro for concatenating multiple arguments.

Definition nrfx_utils.h:777

Macro getting pointer to the structure of registers of the WDT peripheral.

Parameters

[in] idx WDT instance index.

Returns: Pointer to the structure of registers of the WDT peripheral.

Enumeration Type Documentation

◆ nrf_wdt_behaviour_mask_t

enum nrf_wdt_behaviour_mask_t

WDT behavior in the SLEEP or HALT CPU modes.

Enumerator
NRF_WDT_BEHAVIOUR_RUN_SLEEP_MASK	WDT will run when CPU is in SLEEP mode.
NRF_WDT_BEHAVIOUR_RUN_HALT_MASK	WDT will run when CPU is in HALT mode.
NRF_WDT_BEHAVIOUR_STOP_ENABLE_MASK	WDT allows stopping.

◆ nrf_wdt_event_t

enum nrf_wdt_event_t

WDT events.

Enumerator
NRF_WDT_EVENT_TIMEOUT	Event from WDT time-out.
NRF_WDT_EVENT_STOPPED	Event from WDT stop.

◆ nrf_wdt_int_mask_t

enum nrf_wdt_int_mask_t

WDT interrupts.

Enumerator
NRF_WDT_INT_TIMEOUT_MASK	WDT interrupt from time-out event.
NRF_WDT_INT_STOPPED_MASK	WDT interrupt from stop event.

◆ nrf_wdt_rr_register_mask_t

enum nrf_wdt_rr_register_mask_t

WDT reload request registers mask.

Enumerator
NRF_WDT_RR0_MASK	Mask for reload request register 0.
NRF_WDT_RR1_MASK	Mask for reload request register 1.
NRF_WDT_RR2_MASK	Mask for reload request register 2.
NRF_WDT_RR3_MASK	Mask for reload request register 3.
NRF_WDT_RR4_MASK	Mask for reload request register 4.
NRF_WDT_RR5_MASK	Mask for reload request register 5.
NRF_WDT_RR6_MASK	Mask for reload request register 6.
NRF_WDT_RR7_MASK	Mask for reload request register 7.

◆ nrf_wdt_rr_register_t

enum nrf_wdt_rr_register_t

WDT reload request registers.

Enumerator
NRF_WDT_RR0	Reload request register 0.
NRF_WDT_RR1	Reload request register 1.
NRF_WDT_RR2	Reload request register 2.
NRF_WDT_RR3	Reload request register 3.
NRF_WDT_RR4	Reload request register 4.
NRF_WDT_RR5	Reload request register 5.
NRF_WDT_RR6	Reload request register 6.
NRF_WDT_RR7	Reload request register 7.

◆ nrf_wdt_task_t

enum nrf_wdt_task_t

WDT tasks.

Enumerator
NRF_WDT_TASK_START	Task for starting WDT.
NRF_WDT_TASK_STOP	Task for stopping WDT.

Function Documentation

◆ nrf_wdt_behaviour_set()

NRF_STATIC_INLINE void nrf_wdt_behaviour_set	(	NRF_WDT_Type *	p_reg,
		uint32_t	mask )

Function for configuring the watchdog behaviour when the CPU is sleeping or halted.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	mask	Watchdog behaviour mask, created using nrf_wdt_behaviour_mask_t.

◆ nrf_wdt_event_address_get()

NRF_STATIC_INLINE uint32_t nrf_wdt_event_address_get	(	NRF_WDT_Type const *	p_reg,
		nrf_wdt_event_t	event )

Function for returning the address of a specific WDT event register.

Parameters

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

Returns: Address of requested event register.

◆ nrf_wdt_event_check()

NRF_STATIC_INLINE bool nrf_wdt_event_check	(	NRF_WDT_Type const *	p_reg,
		nrf_wdt_event_t	event )

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

NRF_STATIC_INLINE void nrf_wdt_event_clear	(	NRF_WDT_Type *	p_reg,
		nrf_wdt_event_t	event )

Function for clearing the WDT event register.

Parameters

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

◆ nrf_wdt_int_disable()

NRF_STATIC_INLINE void nrf_wdt_int_disable	(	NRF_WDT_Type *	p_reg,
		uint32_t	mask )

Function for disabling the 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_wdt_int_mask_t values for bit masking.

◆ nrf_wdt_int_enable()

NRF_STATIC_INLINE void nrf_wdt_int_enable	(	NRF_WDT_Type *	p_reg,
		uint32_t	mask )

Function for enabling the 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_wdt_int_mask_t values for bit masking.

◆ nrf_wdt_int_enable_check()

NRF_STATIC_INLINE uint32_t nrf_wdt_int_enable_check	(	NRF_WDT_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_wdt_int_mask_t values for bit masking.

Returns: Mask of enabled interrupts.

◆ nrf_wdt_nmi_int_disable()

NRF_STATIC_INLINE void nrf_wdt_nmi_int_disable	(	NRF_WDT_Type *	p_reg,
		uint32_t	mask )

Function for disabling a specified non-maskable interrupts.

Parameters

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

◆ nrf_wdt_nmi_int_enable()

NRF_STATIC_INLINE void nrf_wdt_nmi_int_enable	(	NRF_WDT_Type *	p_reg,
		uint32_t	mask )

Function for enabling the specified non-maskable interrupts.

Parameters

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

◆ nrf_wdt_nmi_int_enable_check()

NRF_STATIC_INLINE uint32_t nrf_wdt_nmi_int_enable_check	(	NRF_WDT_Type const *	p_reg,
		uint32_t	mask )

Function for checking if the specified non-maskable 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_wdt_int_mask_t values for bit masking.

Returns: Mask of enabled interrupts.

◆ nrf_wdt_publish_clear()

NRF_STATIC_INLINE void nrf_wdt_publish_clear	(	NRF_WDT_Type *	p_reg,
		nrf_wdt_event_t	event )

Function for clearing the publish configuration for a given WDT event.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	Event for which to clear the configuration.

◆ nrf_wdt_publish_get()

NRF_STATIC_INLINE uint32_t nrf_wdt_publish_get	(	NRF_WDT_Type const *	p_reg,
		nrf_wdt_event_t	event )

Function for getting the publish configuration for a given WDT event.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	Event for which to read the configuration.

Returns: WDT publish configuration.

◆ nrf_wdt_publish_set()

NRF_STATIC_INLINE void nrf_wdt_publish_set	(	NRF_WDT_Type *	p_reg,
		nrf_wdt_event_t	event,
		uint8_t	channel )

Function for setting the publish configuration for a given WDT event.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	event	Event for which to set the configuration.
[in]	channel	Channel through which to publish the event.

◆ nrf_wdt_reload_request_disable()

NRF_STATIC_INLINE void nrf_wdt_reload_request_disable	(	NRF_WDT_Type *	p_reg,
		nrf_wdt_rr_register_t	rr_register )

Function for disabling a specific reload request register.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	rr_register	Reload request register to be disabled.

◆ nrf_wdt_reload_request_enable()

NRF_STATIC_INLINE void nrf_wdt_reload_request_enable	(	NRF_WDT_Type *	p_reg,
		nrf_wdt_rr_register_t	rr_register )

Function for enabling a specific reload request register.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	rr_register	Reload request register to be enabled.

◆ nrf_wdt_reload_request_enable_check()

NRF_STATIC_INLINE bool nrf_wdt_reload_request_enable_check	(	NRF_WDT_Type const *	p_reg,
		nrf_wdt_rr_register_t	rr_register )

Function for retrieving the status of a specific reload request register.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	rr_register	Reload request register to be checked.

Return values

true	The reload request register is enabled.
false	The reload request register is not enabled.

◆ nrf_wdt_reload_request_set()

NRF_STATIC_INLINE void nrf_wdt_reload_request_set	(	NRF_WDT_Type *	p_reg,
		nrf_wdt_rr_register_t	rr_register )

Function for setting a specific reload request register.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	rr_register	Reload request register to set.

◆ nrf_wdt_reload_value_get()

NRF_STATIC_INLINE uint32_t nrf_wdt_reload_value_get ( NRF_WDT_Type const * p_reg )

Function for retrieving the watchdog reload value.

Parameters

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

Returns: Reload value.

◆ nrf_wdt_reload_value_set()

NRF_STATIC_INLINE void nrf_wdt_reload_value_set	(	NRF_WDT_Type *	p_reg,
		uint32_t	reload_value )

Function for setting the watchdog reload value.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	reload_value	Watchdog counter initial value.

◆ nrf_wdt_request_status_check()

NRF_STATIC_INLINE bool nrf_wdt_request_status_check	(	NRF_WDT_Type const *	p_reg,
		nrf_wdt_rr_register_t	rr_register )

Function for retrieving the watchdog reload request status for specified register.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	rr_register	Reload request register to be checked.

Return values

true	Reload request is running.
false	No reload requests are running.

◆ nrf_wdt_request_status_get()

NRF_STATIC_INLINE uint32_t nrf_wdt_request_status_get ( NRF_WDT_Type const * p_reg )

Function for retrieving the watchdog reload requests status mask.

Parameters

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

Returns: Running reload requests mask, constructed with nrf_wdt_rr_register_mask_t.

◆ nrf_wdt_started_check()

NRF_STATIC_INLINE bool nrf_wdt_started_check ( NRF_WDT_Type const * p_reg )

Function for retrieving the watchdog status.

Parameters

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

Return values

true	The watchdog is started.
false	The watchdog is not started.

◆ nrf_wdt_subscribe_clear()

NRF_STATIC_INLINE void nrf_wdt_subscribe_clear	(	NRF_WDT_Type *	p_reg,
		nrf_wdt_task_t	task )

Function for clearing the subscribe configuration for a given WDT task.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	task	Task for which to clear the configuration.

◆ nrf_wdt_subscribe_get()

NRF_STATIC_INLINE uint32_t nrf_wdt_subscribe_get	(	NRF_WDT_Type const *	p_reg,
		nrf_wdt_task_t	task )

Function for getting the subscribe configuration for a given WDT task.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	task	Task for which to read the configuration.

Returns: WDT subscribe configuration.

◆ nrf_wdt_subscribe_set()

NRF_STATIC_INLINE void nrf_wdt_subscribe_set	(	NRF_WDT_Type *	p_reg,
		nrf_wdt_task_t	task,
		uint8_t	channel )

Function for setting the subscribe configuration for a given WDT task.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	task	Task for which to set the configuration.
[in]	channel	Channel through which to subscribe events.

◆ nrf_wdt_task_address_get()

NRF_STATIC_INLINE uint32_t nrf_wdt_task_address_get	(	NRF_WDT_Type const *	p_reg,
		nrf_wdt_task_t	task )

Function for returning the address of a specific WDT task register.

Parameters

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

Returns: Address of requested task register.

◆ nrf_wdt_task_stop_enable_set()

NRF_STATIC_INLINE void nrf_wdt_task_stop_enable_set	(	NRF_WDT_Type *	p_reg,
		bool	enable )

Function for enabling or disabling stopping the watchdog.

Parameters

[in]	p_reg	Pointer to the structure of registers of the peripheral.
[in]	enable	True if stopping is to be enabled, false otherwise.

◆ nrf_wdt_task_trigger()

NRF_STATIC_INLINE void nrf_wdt_task_trigger	(	NRF_WDT_Type *	p_reg,
		nrf_wdt_task_t	task )

Function for starting the WDT task.

Parameters

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

Macros

Enumerations

Functions

Detailed Description

Macro Definition Documentation

◆ NRF_WDT_INST_GET

Enumeration Type Documentation

◆ nrf_wdt_behaviour_mask_t

◆ nrf_wdt_event_t

◆ nrf_wdt_int_mask_t

◆ nrf_wdt_rr_register_mask_t

◆ nrf_wdt_rr_register_t

◆ nrf_wdt_task_t

Function Documentation

◆ nrf_wdt_behaviour_set()

◆ nrf_wdt_event_address_get()

◆ nrf_wdt_event_check()

◆ nrf_wdt_event_clear()

◆ nrf_wdt_int_disable()

◆ nrf_wdt_int_enable()

◆ nrf_wdt_int_enable_check()

◆ nrf_wdt_nmi_int_disable()

◆ nrf_wdt_nmi_int_enable()

◆ nrf_wdt_nmi_int_enable_check()

◆ nrf_wdt_publish_clear()

◆ nrf_wdt_publish_get()

◆ nrf_wdt_publish_set()

◆ nrf_wdt_reload_request_disable()

◆ nrf_wdt_reload_request_enable()

◆ nrf_wdt_reload_request_enable_check()

◆ nrf_wdt_reload_request_set()

◆ nrf_wdt_reload_value_get()

◆ nrf_wdt_reload_value_set()

◆ nrf_wdt_request_status_check()

◆ nrf_wdt_request_status_get()

◆ nrf_wdt_started_check()

◆ nrf_wdt_subscribe_clear()

◆ nrf_wdt_subscribe_get()

◆ nrf_wdt_subscribe_set()

◆ nrf_wdt_task_address_get()

◆ nrf_wdt_task_stop_enable_set()

◆ nrf_wdt_task_trigger()