Functions

group group_wdt_functions

Functions

void Cy_WDT_Init(void)

Initializes the Watchdog timer to its default state.

The given default setting of the WDT: The WDT is unlocked and disabled. The WDT match value is 4096. None of ignore bits are set: the whole WDT counter bits are checked against the match value.

Side Effects

This function clears the WDT interrupt.

__STATIC_INLINE void Cy_WDT_Enable (void)

Enables the Watchdog timer.

Side Effects

This function clears the WDT interrupt.

__STATIC_INLINE void Cy_WDT_Disable (void)

Disables the Watchdog timer.

The Watchdog timer should be unlocked before being disabled. Call the Cy_WDT_Unlock() API to unlock the WDT.

void Cy_WDT_Lock(void)

Locks out configuration changes to the Watchdog Timer register.

After this function is called, the WDT configuration cannot be changed until Cy_WDT_Unlock() is called.

warning

The WDT lock state is not retained during system Deep Sleep. After the wakeup from system Deep Sleep the WDT is locked.

void Cy_WDT_Unlock(void)

Unlocks the Watchdog Timer configuration register.

warning

The WDT lock state is not retained during system Deep Sleep. After the wakeup from system Deep Sleep the WDT is locked.

bool Cy_WDT_Locked(void)

Returns the WDT lock state.

Return

True - if WDT is locked. False - if WDT is unlocked.

__STATIC_INLINE uint32_t Cy_WDT_GetCount (void)

Reads the current WDT counter value.

Return

A live counter value.

void Cy_WDT_SetMatch(uint32_t match)

Configures the WDT counter match comparison value.

The Watchdog timer should be unlocked before changing the match value. Call the Cy_WDT_Unlock() function to unlock the WDT.

Parameters
  • match: The valid valid range is [0-65535]. The value to be used to match against the counter.

__STATIC_INLINE uint32_t Cy_WDT_GetMatch (void)

Reads the WDT counter match comparison value.

Return

The counter match value.

void Cy_WDT_SetIgnoreBits(uint32_t bitsNum)

Configures the number of the most significant bits of the Watchdog timer that are not checked against the match.

Unlock the Watchdog timer before ignoring the bits setting. Call the Cy_WDT_Unlock() API to unlock the WDT.

The value of bitsNum controls the time-to-reset of the Watchdog timer This happens after 3 successive matches.

Parameters
  • bitsNum: The number of the most significant bits. The valid range is [0-15]. The bitsNum over 12 are considered as 12.

warning

This function changes the WDT interrupt period, therefore the device can go into an infinite WDT reset loop. This may happen if a WDT reset occurs faster that a device start-up.

__STATIC_INLINE uint32_t Cy_WDT_GetIgnoreBits (void)

Reads the number of the most significant bits of the Watchdog timer that are not checked against the match.

Return

The number of the most significant bits.

__STATIC_INLINE void Cy_WDT_MaskInterrupt (void)

After masking interrupts from the WDT, they are not passed to the CPU.

This function does not disable the WDT-reset generation.

__STATIC_INLINE void Cy_WDT_UnmaskInterrupt (void)

After unmasking interrupts from the WDT, they are passed to CPU.

This function does not impact the reset generation.

void Cy_WDT_ClearInterrupt(void)

Clears the WDT match flag which is set every time the WDT counter reaches a WDT match value.

Two unserviced interrupts lead to a system reset (i.e. at the third match).

void Cy_WDT_ClearWatchdog(void)

Clears (“feeds”) the watchdog, to prevent a XRES device reset.

This function simply call Cy_WDT_ClearInterrupt() function.

__STATIC_INLINE bool Cy_WDT_IsEnabled (void)

Reports an enable/disable state of the Watchdog timer.

Return

  • true - if the timer is enabled

  • false - if the timer is disabled