WDT Interface

Interface for watch dog timer functions. More...

Data Structures
struct	wdt_callback_args_t
struct	wdt_timeout_values_t
struct	wdt_cfg_t
struct	wdt_api_t
struct	wdt_instance_t

Typedefs
typedef void	wdt_ctrl_t

Enumerations
enum	wdt_timeout_t {   WDT_TIMEOUT_128 = 0, WDT_TIMEOUT_512, WDT_TIMEOUT_1024, WDT_TIMEOUT_2048,   WDT_TIMEOUT_4096, WDT_TIMEOUT_8192, WDT_TIMEOUT_16384 }
enum	wdt_clock_division_t {   WDT_CLOCK_DIVISION_1 = 0x0000u, WDT_CLOCK_DIVISION_4 = 0x0010u, WDT_CLOCK_DIVISION_16 = 0x0020u, WDT_CLOCK_DIVISION_32 = 0x0030u,   WDT_CLOCK_DIVISION_64 = 0x0040u, WDT_CLOCK_DIVISION_128 = 0x00F0u, WDT_CLOCK_DIVISION_256 = 0x0050u, WDT_CLOCK_DIVISION_512 = 0x0060u,   WDT_CLOCK_DIVISION_2048 = 0x0070u, WDT_CLOCK_DIVISION_8192 = 0x0080u }
enum	wdt_window_start_t { WDT_WINDOW_START_25 = 0x0000u, WDT_WINDOW_START_50 = 0x1000u, WDT_WINDOW_START_75 = 0x2000u, WDT_WINDOW_START_100 = 0x3000u }
enum	wdt_window_end_t { WDT_WINDOW_END_75 = 0x0000u, WDT_WINDOW_END_50 = 0x0100u, WDT_WINDOW_END_25 = 0x0200u, WDT_WINDOW_END_0 = 0x0300u }
enum	wdt_reset_control_t { WDT_RESET_CONTROL_NMI = 0x00u, WDT_RESET_CONTROL_RESET = 0x80u }
enum	wdt_stop_control_t { WDT_STOP_CONTROL_DISABLE = 0x00u, WDT_STOP_CONTROL_ENABLE = 0x80u }
enum	wdt_status_t { WDT_STATUS_NO_ERROR = 0x00u, WDT_STATUS_UNDERFLOW_ERROR = 0x01u, WDT_STATUS_REFRESH_ERROR = 0x02u, WDT_STATUS_UNDERFLOW_AND_REFRESH_ERROR = 0x03u }
enum	wdt_start_mode_t { WDT_START_MODE_REGISTER = 0, WDT_START_MODE_AUTO, WDT_START_MODE_DISABLED }

Detailed Description

Interface for watch dog timer functions.

Summary

The WDT interface for the Watchdog Timer (WDT) peripheral provides watchdog functionality including resetting the device or generating an interrupt.

See Also WDT Interface and Thread Monitor Framework Interface

The watchdog timer interface can be implemented by:

• WDT
• IWDT

Related SSP architecture topics:

• SSP Interfaces
• SSP Predefined Layers
• Using SSP Modules

WDT Interface description: Watchdog Driver

Typedef Documentation

wdt_ctrl_t

typedef void wdt_ctrl_t

WDT control block. Allocate an instance specific control block to pass into the WDT API calls.

Implemented as

• wdt_instance_ctrl_t
• iwdt_instance_ctrl_t

Enumeration Type Documentation

wdt_clock_division_t

enum wdt_clock_division_t

WDT clock division ratio.

Enumerator
WDT_CLOCK_DIVISION_1	CLK/1.
WDT_CLOCK_DIVISION_4	CLK/4.
WDT_CLOCK_DIVISION_16	CLK/16.
WDT_CLOCK_DIVISION_32	CLK/32.
WDT_CLOCK_DIVISION_64	CLK/64.
WDT_CLOCK_DIVISION_128	CLK/128.
WDT_CLOCK_DIVISION_256	CLK/256.
WDT_CLOCK_DIVISION_512	CLK/512.
WDT_CLOCK_DIVISION_2048	CLK/2048.
WDT_CLOCK_DIVISION_8192	CLK/8192.

wdt_reset_control_t

enum wdt_reset_control_t

WDT Counter underflow and refresh error control.

Enumerator
WDT_RESET_CONTROL_NMI	NMI request when counter underflows.
WDT_RESET_CONTROL_RESET	Reset request when counter underflows.

wdt_start_mode_t

enum wdt_start_mode_t

WDT start mode. Used to check the WDT is configured correctly.

Enumerator
WDT_START_MODE_REGISTER	WDT is to be configured using the WDT registers.
WDT_START_MODE_AUTO	WDT is to be configured using OFS0 hardware register.
WDT_START_MODE_DISABLED	WDT is disabled.

wdt_status_t

enum wdt_status_t

WDT status

Enumerator
WDT_STATUS_NO_ERROR	No status flags set.
WDT_STATUS_UNDERFLOW_ERROR	Underflow flag set.
WDT_STATUS_REFRESH_ERROR	Refresh error flag set. Refresh outside of permitted.
WDT_STATUS_UNDERFLOW_AND_REFRESH_ERROR	Underflow and refresh error flags set.

wdt_stop_control_t

enum wdt_stop_control_t

WDT Counter operation in sleep mode.

Enumerator
WDT_STOP_CONTROL_DISABLE	Count will not stop when device enters sleep mode.
WDT_STOP_CONTROL_ENABLE	Count will automatically stop when device enters sleep mode.

wdt_timeout_t

enum wdt_timeout_t

WDT time-out periods.

Enumerator
WDT_TIMEOUT_128	128 clock cycles
WDT_TIMEOUT_512	512 clock cycles
WDT_TIMEOUT_1024	1024 clock cycles
WDT_TIMEOUT_2048	2048 clock cycles
WDT_TIMEOUT_4096	4096 clock cycles
WDT_TIMEOUT_8192	8192 clock cycles
WDT_TIMEOUT_16384	16384 clock cycles

wdt_window_end_t

enum wdt_window_end_t

WDT refresh permitted period window end position.

Enumerator
WDT_WINDOW_END_75	End position = 75%.
WDT_WINDOW_END_50	End position = 50%.
WDT_WINDOW_END_25	End position = 25%.
WDT_WINDOW_END_0	End position = 0%.

wdt_window_start_t

enum wdt_window_start_t

WDT refresh permitted period window start position.

Enumerator
WDT_WINDOW_START_25	Start position = 25%.
WDT_WINDOW_START_50	Start position = 50%.
WDT_WINDOW_START_75	Start position = 75%.
WDT_WINDOW_START_100	Start position = 100%.