cfn_hal_wdt.h File Reference

Watchdog Timer (WDT) HAL API. More...

#include "cfn_hal.h"
#include "cfn_hal_base.h"
#include "cfn_hal_types.h"

Go to the source code of this file.

Data Structures
struct	cfn_hal_wdt_phy_t
	WDT hardware physical mapping. More...
struct	cfn_hal_wdt_config_t
	WDT configuration structure. More...
struct	cfn_hal_wdt_api_s
	WDT Virtual Method Table (VMT). More...

Typedefs
typedef struct cfn_hal_wdt_s	cfn_hal_wdt_t
typedef struct cfn_hal_wdt_api_s	cfn_hal_wdt_api_t
typedef void(*	cfn_hal_wdt_callback_t) (cfn_hal_wdt_t *driver, uint32_t event_mask, uint32_t error_mask, void *user_arg)
	WDT callback signature.

Enumerations
enum	cfn_hal_wdt_event_t { CFN_HAL_WDT_EVENT_NONE = 0 , CFN_HAL_WDT_EVENT_WARNING = CFN_HAL_BIT(0) }
	WDT nominal event flags. More...
enum	cfn_hal_wdt_error_t { CFN_HAL_WDT_ERROR_NONE = 0 , CFN_HAL_WDT_ERROR_GENERAL = CFN_HAL_BIT(0) }
	WDT exception error flags. More...
enum	cfn_hal_wdt_config_sleep_t { CFN_HAL_WDT_CONFIG_SLEEP_RUN , CFN_HAL_WDT_CONFIG_SLEEP_PAUSE , CFN_HAL_WDT_CONFIG_SLEEP_MAX }
	WDT sleep behavior. More...
enum	cfn_hal_wdt_config_reset_t { CFN_HAL_WDT_CONFIG_RESET_NONE , CFN_HAL_WDT_CONFIG_RESET_IRQ , CFN_HAL_WDT_CONFIG_RESET_CPU , CFN_HAL_WDT_CONFIG_RESET_MAX }
	WDT reset behavior. More...

Functions
	CFN_HAL_VMT_CHECK (struct cfn_hal_wdt_api_s)
	CFN_HAL_CREATE_DRIVER_TYPE (wdt, cfn_hal_wdt_config_t, cfn_hal_wdt_api_t, cfn_hal_wdt_phy_t, cfn_hal_wdt_callback_t)
CFN_HAL_INLINE void	cfn_hal_wdt_populate (cfn_hal_wdt_t *driver, uint32_t peripheral_id, struct cfn_hal_clock_s *clock, void *dependency, const cfn_hal_wdt_api_t *api, const cfn_hal_wdt_phy_t *phy, const cfn_hal_wdt_config_t *config, cfn_hal_wdt_callback_t callback, void *user_arg)
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_wdt_config_validate (cfn_hal_wdt_t *driver, const cfn_hal_wdt_config_t *config)
	Validates the Watchdog configuration.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_wdt_init (cfn_hal_wdt_t *driver)
	Initializes the Watchdog driver.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_wdt_deinit (cfn_hal_wdt_t *driver)
	Deinitializes the Watchdog driver.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_wdt_config_set (cfn_hal_wdt_t *driver, const cfn_hal_wdt_config_t *config)
	Sets the WDT configuration.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_wdt_config_get (cfn_hal_wdt_t *driver, cfn_hal_wdt_config_t *config)
	Gets the current WDT configuration.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_wdt_callback_register (cfn_hal_wdt_t *driver, const cfn_hal_wdt_callback_t callback, void *user_arg)
	Registers a callback for WDT events and errors.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_wdt_power_state_set (cfn_hal_wdt_t *driver, cfn_hal_power_state_t state)
	Sets the WDT power state.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_wdt_event_enable (cfn_hal_wdt_t *driver, uint32_t event_mask)
	Enables one or more WDT nominal events.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_wdt_event_disable (cfn_hal_wdt_t *driver, uint32_t event_mask)
	Disables one or more WDT nominal events.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_wdt_event_get (cfn_hal_wdt_t *driver, uint32_t *event_mask)
	Retrieves the current WDT nominal event status.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_wdt_error_enable (cfn_hal_wdt_t *driver, uint32_t error_mask)
	Enables one or more WDT exception errors.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_wdt_error_disable (cfn_hal_wdt_t *driver, uint32_t error_mask)
	Disables one or more WDT exception errors.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_wdt_error_get (cfn_hal_wdt_t *driver, uint32_t *error_mask)
	Retrieves the current WDT exception error status.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_wdt_start (cfn_hal_wdt_t *driver)
	Starts the watchdog timer.
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_wdt_stop (cfn_hal_wdt_t *driver)
	Stops the watchdog timer (if supported by hardware).
CFN_HAL_INLINE cfn_hal_error_code_t	cfn_hal_wdt_feed (cfn_hal_wdt_t *driver)
	Feeds (refreshes) the watchdog timer to prevent system reset.
cfn_hal_error_code_t	cfn_hal_wdt_construct (cfn_hal_wdt_t *driver, const cfn_hal_wdt_config_t *config, const cfn_hal_wdt_phy_t *phy, struct cfn_hal_clock_s *clock, void *dependency, cfn_hal_wdt_callback_t callback, void *user_arg)
cfn_hal_error_code_t	cfn_hal_wdt_destruct (cfn_hal_wdt_t *driver)

Detailed Description

Watchdog Timer (WDT) HAL API.

Copyright (c) 2026 Hisham Moussa Daou https://www.whileone.me

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Typedef Documentation

cfn_hal_wdt_api_t

typedef struct cfn_hal_wdt_api_s cfn_hal_wdt_api_t

cfn_hal_wdt_callback_t

typedef void(* cfn_hal_wdt_callback_t) (cfn_hal_wdt_t *driver, uint32_t event_mask, uint32_t error_mask, void *user_arg)

WDT callback signature.

Parameters

driver	Pointer to the WDT driver instance.
event_mask	Mask of triggered nominal events.
error_mask	Mask of triggered exception errors.
user_arg	User-defined argument passed during registration.

cfn_hal_wdt_t

typedef struct cfn_hal_wdt_s cfn_hal_wdt_t

Enumeration Type Documentation

cfn_hal_wdt_config_reset_t

enum cfn_hal_wdt_config_reset_t

WDT reset behavior.

Enumerator
CFN_HAL_WDT_CONFIG_RESET_NONE	No reset (interrupt only)
CFN_HAL_WDT_CONFIG_RESET_IRQ	Generate interrupt then reset
CFN_HAL_WDT_CONFIG_RESET_CPU	Immediate CPU reset
CFN_HAL_WDT_CONFIG_RESET_MAX

cfn_hal_wdt_config_sleep_t

enum cfn_hal_wdt_config_sleep_t

WDT sleep behavior.

Enumerator
CFN_HAL_WDT_CONFIG_SLEEP_RUN	Continue counting during sleep
CFN_HAL_WDT_CONFIG_SLEEP_PAUSE	Freeze counter during sleep
CFN_HAL_WDT_CONFIG_SLEEP_MAX

cfn_hal_wdt_error_t

enum cfn_hal_wdt_error_t

WDT exception error flags.

Enumerator
CFN_HAL_WDT_ERROR_NONE
CFN_HAL_WDT_ERROR_GENERAL	General hardware error

cfn_hal_wdt_event_t

enum cfn_hal_wdt_event_t

WDT nominal event flags.

Enumerator
CFN_HAL_WDT_EVENT_NONE
CFN_HAL_WDT_EVENT_WARNING	Early warning interrupt (before reset)

Function Documentation

CFN_HAL_CREATE_DRIVER_TYPE()

CFN_HAL_CREATE_DRIVER_TYPE	(	wdt	,
		cfn_hal_wdt_config_t	,
		cfn_hal_wdt_api_t	,
		cfn_hal_wdt_phy_t	,
		cfn_hal_wdt_callback_t
	)

CFN_HAL_VMT_CHECK()

CFN_HAL_VMT_CHECK

(

struct cfn_hal_wdt_api_s

)

cfn_hal_wdt_callback_register()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_wdt_callback_register	(	cfn_hal_wdt_t *	driver,
		const cfn_hal_wdt_callback_t	callback,
		void *	user_arg
	)

Registers a callback for WDT events and errors.

Parameters

driver	Pointer to the WDT driver instance.
callback	The callback function to register.
user_arg	User-defined argument passed to the callback.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_wdt_config_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_wdt_config_get	(	cfn_hal_wdt_t *	driver,
		cfn_hal_wdt_config_t *	config
	)

Gets the current WDT configuration.

Parameters

driver	Pointer to the WDT driver instance.
config	[out] Pointer to store the configuration.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_wdt_config_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_wdt_config_set	(	cfn_hal_wdt_t *	driver,
		const cfn_hal_wdt_config_t *	config
	)

Sets the WDT configuration.

Parameters

driver	Pointer to the WDT driver instance.
config	Pointer to the configuration structure.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_wdt_config_validate()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_wdt_config_validate	(	cfn_hal_wdt_t *	driver,
		const cfn_hal_wdt_config_t *	config
	)

Validates the Watchdog configuration.

Parameters

driver	Pointer to the WDT driver instance.
config	Pointer to the configuration structure.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_wdt_construct()

cfn_hal_error_code_t cfn_hal_wdt_construct	(	cfn_hal_wdt_t *	driver,
		const cfn_hal_wdt_config_t *	config,
		const cfn_hal_wdt_phy_t *	phy,
		struct cfn_hal_clock_s *	clock,
		void *	dependency,
		cfn_hal_wdt_callback_t	callback,
		void *	user_arg
	)

cfn_hal_wdt_deinit()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_wdt_deinit

(

cfn_hal_wdt_t *

driver

)

Deinitializes the Watchdog driver.

Parameters

driver

Pointer to the WDT driver instance.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_wdt_destruct()

cfn_hal_error_code_t cfn_hal_wdt_destruct

(

cfn_hal_wdt_t *

driver

)

cfn_hal_wdt_error_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_wdt_error_disable	(	cfn_hal_wdt_t *	driver,
		uint32_t	error_mask
	)

Disables one or more WDT exception errors.

Parameters

driver	Pointer to the WDT driver instance.
error_mask	Mask of errors to disable.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_wdt_error_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_wdt_error_enable	(	cfn_hal_wdt_t *	driver,
		uint32_t	error_mask
	)

Enables one or more WDT exception errors.

Parameters

driver	Pointer to the WDT driver instance.
error_mask	Mask of errors to enable.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_wdt_error_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_wdt_error_get	(	cfn_hal_wdt_t *	driver,
		uint32_t *	error_mask
	)

Retrieves the current WDT exception error status.

Parameters

driver	Pointer to the WDT driver instance.
error_mask	[out] Pointer to store the error mask.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_wdt_event_disable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_wdt_event_disable	(	cfn_hal_wdt_t *	driver,
		uint32_t	event_mask
	)

Disables one or more WDT nominal events.

Parameters

driver	Pointer to the WDT driver instance.
event_mask	Mask of events to disable.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_wdt_event_enable()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_wdt_event_enable	(	cfn_hal_wdt_t *	driver,
		uint32_t	event_mask
	)

Enables one or more WDT nominal events.

Parameters

driver	Pointer to the WDT driver instance.
event_mask	Mask of events to enable.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_wdt_event_get()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_wdt_event_get	(	cfn_hal_wdt_t *	driver,
		uint32_t *	event_mask
	)

Retrieves the current WDT nominal event status.

Parameters

driver	Pointer to the WDT driver instance.
event_mask	[out] Pointer to store the event mask.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_wdt_feed()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_wdt_feed

(

cfn_hal_wdt_t *

driver

)

Feeds (refreshes) the watchdog timer to prevent system reset.

Parameters

driver

Pointer to the WDT driver instance.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_wdt_init()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_wdt_init

(

cfn_hal_wdt_t *

driver

)

Initializes the Watchdog driver.

Parameters

driver

Pointer to the WDT driver instance.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_wdt_populate()

CFN_HAL_INLINE void cfn_hal_wdt_populate	(	cfn_hal_wdt_t *	driver,
		uint32_t	peripheral_id,
		struct cfn_hal_clock_s *	clock,
		void *	dependency,
		const cfn_hal_wdt_api_t *	api,
		const cfn_hal_wdt_phy_t *	phy,
		const cfn_hal_wdt_config_t *	config,
		cfn_hal_wdt_callback_t	callback,
		void *	user_arg
	)

cfn_hal_wdt_power_state_set()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_wdt_power_state_set	(	cfn_hal_wdt_t *	driver,
		cfn_hal_power_state_t	state
	)

Sets the WDT power state.

Parameters

driver	Pointer to the WDT driver instance.
state	Target power state.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_wdt_start()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_wdt_start

(

cfn_hal_wdt_t *

driver

)

Starts the watchdog timer.

Parameters

driver

Pointer to the WDT driver instance.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.

cfn_hal_wdt_stop()

CFN_HAL_INLINE cfn_hal_error_code_t cfn_hal_wdt_stop

(

cfn_hal_wdt_t *

driver

)

Stops the watchdog timer (if supported by hardware).

Parameters

driver

Pointer to the WDT driver instance.

Returns

CFN_HAL_ERROR_OK on success, or a specific error code on failure.