General Description

Provides a high-level interface for interacting with the Cypress Watchdog Timer.

This interface abstracts out the chip specific details. If any chip specific functionality is necessary, or performance is critical the low-level functions can be used directly.

Macros
#define	cy_p64_wdg_kick() Cy_WDT_ClearWatchdog()
	Call this function periodically to prevent the WDT from timing out and resetting the device. More...

#define	cy_p64_wdg_is_enabled() Cy_WDT_IsEnabled()
	Check if WDT is enabled.

Functions
cy_p64_error_codes_t	cy_p64_wdg_init (uint32_t *timeout_ms)
	Initializes the WDT. More...

void	cy_p64_wdg_free (void)
	Free the WDT. More...

void	cy_p64_wdg_start (void)
	Start (enable) the WDT. More...

void	cy_p64_wdg_stop (void)
	Stop (disable) the WDT. More...

uint32_t	cy_p64_wdg_max_timeout_ms (void)
	This function returns maximum WDT timeout in milliseconds. More...

Macro Definition Documentation

◆ cy_p64_wdg_kick

#define cy_p64_wdg_kick ( ) Cy_WDT_ClearWatchdog()

Call this function periodically to prevent the WDT from timing out and resetting the device.

Function Documentation

◆ cy_p64_wdg_init()

cy_p64_error_codes_t cy_p64_wdg_init ( uint32_t * timeout_ms )

Initializes the WDT.

Calls cy_p64_wdg_start() API to start WDT after this function.

Note: The specified timeout must be at least 1ms and at most the WDT's maximum timeout (see cy_p64_wdg_max_timeout_ms()).

Parameters

timeout_ms The time in milliseconds before the WDT times out. It is updated by function to the rounded value actually set to WDT.

Returns: CY_P64_SUCCESS for success of the init request or error code

◆ cy_p64_wdg_free()

void cy_p64_wdg_free ( void )

Free the WDT.

Make sure cy_p64_wdg_stop() is called to stops the WDT before this function. After calling this function no other WDT functions should be called except cy_p64_wdg_init().

◆ cy_p64_wdg_start()

void cy_p64_wdg_start ( void )

Start (enable) the WDT.

◆ cy_p64_wdg_stop()

void cy_p64_wdg_stop ( void )

Stop (disable) the WDT.

◆ cy_p64_wdg_max_timeout_ms()

uint32_t cy_p64_wdg_max_timeout_ms ( void )

This function returns maximum WDT timeout in milliseconds.

Returns: maximum WDT timeout in milliseconds