WDOG - Watchdog

Description

Watchdog (WDOG) Peripheral API.

This module contains functions to control the WDOG peripheral of Silicon Labs 32-bit MCUs and SoCs. The WDOG resets the system in case of a fault condition.

Data Structures

struct  WDOG_Init_TypeDef
 Watchdog initialization structure.
 

Functions

void WDOGn_Enable (WDOG_TypeDef *wdog, bool enable)
 Enable/disable the watchdog timer.
 
void WDOGn_Feed (WDOG_TypeDef *wdog)
 Feed WDOG.
 
void WDOGn_Init (WDOG_TypeDef *wdog, const WDOG_Init_TypeDef *init)
 Initialize WDOG (assuming the WDOG configuration has not been locked).
 
void WDOGn_Lock (WDOG_TypeDef *wdog)
 Lock the WDOG configuration.
 
void WDOGn_SyncWait (WDOG_TypeDef *wdog)
 Wait for the WDOG to complete all synchronization of register changes and commands.
 
void WDOGn_Unlock (WDOG_TypeDef *wdog)
 Unlock the WDOG configuration.
 
bool WDOGn_IsEnabled (WDOG_TypeDef *wdog)
 Get enabled status of the Watchdog.
 
bool WDOGn_IsLocked (WDOG_TypeDef *wdog)
 Get locked status of the Watchdog.
 
SL_DEPRECATED_API_SDK_4_1 void WDOG_Enable (bool enable)
 Enable/disable the Watchdog timer.
 
SL_DEPRECATED_API_SDK_4_1 void WDOG_Feed (void)
 Feed the Watchdog.
 
SL_DEPRECATED_API_SDK_4_1 void WDOG_Init (const WDOG_Init_TypeDef *init)
 Initialize Watchdog (assuming the Watchdog configuration has not been locked).
 
SL_DEPRECATED_API_SDK_4_1 void WDOG_Lock (void)
 Lock the Watchdog configuration.
 
SL_DEPRECATED_API_SDK_4_1 bool WDOG_IsEnabled (void)
 Get enabled status of the Watchdog.
 
SL_DEPRECATED_API_SDK_4_1 bool WDOG_IsLocked (void)
 Get locked status of the Watchdog.
 

Macros

#define WDOG_SYNC_TIMEOUT   30000
 In some scenarioes when the watchdog is disabled the synchronization register might be set and not be cleared until the watchdog is enabled again.
 
#define DEFAULT_WDOG   WDOG
 Default WDOG instance for deprecated functions.
 
#define WDOG_INIT_DEFAULT
 Suggested default configuration for WDOG initialization structure.
 

Enumerations

enum  WDOG_ClkSel_TypeDef {
  wdogClkSelULFRCO = _WDOG_CTRL_CLKSEL_ULFRCO,
  wdogClkSelLFRCO = _WDOG_CTRL_CLKSEL_LFRCO,
  wdogClkSelLFXO = _WDOG_CTRL_CLKSEL_LFXO
}
 Watchdog clock selection.
 
enum  WDOG_PeriodSel_TypeDef {
  wdogPeriod_9 = 0x0,
  wdogPeriod_17 = 0x1,
  wdogPeriod_33 = 0x2,
  wdogPeriod_65 = 0x3,
  wdogPeriod_129 = 0x4,
  wdogPeriod_257 = 0x5,
  wdogPeriod_513 = 0x6,
  wdogPeriod_1k = 0x7,
  wdogPeriod_2k = 0x8,
  wdogPeriod_4k = 0x9,
  wdogPeriod_8k = 0xA,
  wdogPeriod_16k = 0xB,
  wdogPeriod_32k = 0xC,
  wdogPeriod_64k = 0xD,
  wdogPeriod_128k = 0xE,
  wdogPeriod_256k = 0xF
}
 Watchdog period selection.
 

Function Documentation

◆ WDOGn_Enable()

void WDOGn_Enable ( WDOG_TypeDef *  wdog,
bool  enable 
)

Enable/disable the watchdog timer.

Note
This function modifies the WDOG CTRL register which requires synchronization into the low-frequency domain. If this register is modified before a previous update to the same register has completed, this function will stall until the previous synchronization has completed.
Parameters
[in]wdogA pointer to the WDOG peripheral register block.
[in]enableTrue to enable Watchdog, false to disable. Watchdog cannot be disabled if it's been locked.

◆ WDOGn_Feed()

void WDOGn_Feed ( WDOG_TypeDef *  wdog)

Feed WDOG.

When WDOG is activated, it must be fed (i.e., clearing the counter) before it reaches the defined timeout period. Otherwise, WDOG will generate a reset.

Note
Note that WDOG is an asynchronous peripheral and when calling the WDOGn_Feed() function the hardware starts the process of clearing the counter. This process takes some time before it completes depending on the selected oscillator (up to 4 peripheral clock cycles). When using the ULFRCO for instance as the oscillator the watchdog runs on a 1 kHz clock and a watchdog clear operation might take up to 4 ms.

If the device enters EM2 or EM3 while a command is in progress then that command will be aborted. An application can use WDOGn_SyncWait() to wait for a command to complete.

Parameters
[in]wdogA pointer to the WDOG peripheral register block.

◆ WDOGn_Init()

void WDOGn_Init ( WDOG_TypeDef *  wdog,
const WDOG_Init_TypeDef init 
)

Initialize WDOG (assuming the WDOG configuration has not been locked).

Note
This function modifies the WDOG CTRL register which requires synchronization into the low-frequency domain. If this register is modified before a previous update to the same register has completed, this function will stall until the previous synchronization has completed.
Parameters
[in]wdogPointer to the WDOG peripheral register block.
[in]initThe structure holding the WDOG configuration. A default setting WDOG_INIT_DEFAULT is available for initialization.

◆ WDOGn_Lock()

void WDOGn_Lock ( WDOG_TypeDef *  wdog)

Lock the WDOG configuration.

This prevents errors from overwriting the WDOG configuration, possibly disabling it. Only a reset can unlock the WDOG configuration once locked.

If the LFRCO or LFXO clocks are used to clock WDOG, consider using the option of inhibiting those clocks to be disabled. See the WDOG_Enable() initialization structure.

Note
This function modifies the WDOG CTRL register which requires synchronization into the low-frequency domain. If this register is modified before a previous update to the same register has completed, this function will stall until the previous synchronization has completed.
Parameters
[in]wdogA pointer to WDOG peripheral register block.

◆ WDOGn_SyncWait()

void WDOGn_SyncWait ( WDOG_TypeDef *  wdog)

Wait for the WDOG to complete all synchronization of register changes and commands.

Parameters
[in]wdogA pointer to WDOG peripheral register block.

◆ WDOGn_Unlock()

void WDOGn_Unlock ( WDOG_TypeDef *  wdog)

Unlock the WDOG configuration.

Note that this function will have no effect on devices where a reset is the only way to unlock the watchdog.

Parameters
[in]wdogA pointer to WDOG peripheral register block.

◆ WDOGn_IsEnabled()

bool WDOGn_IsEnabled ( WDOG_TypeDef *  wdog)
inline

Get enabled status of the Watchdog.

Parameters
[in]wdogPointer to the WDOG peripheral register block.
Returns
True if Watchdog is enabled.

◆ WDOGn_IsLocked()

bool WDOGn_IsLocked ( WDOG_TypeDef *  wdog)
inline

Get locked status of the Watchdog.

Parameters
[in]wdogPointer to the WDOG peripheral register block.
Returns
True if Watchdog is locked.

◆ WDOG_Enable()

SL_DEPRECATED_API_SDK_4_1 void WDOG_Enable ( bool  enable)
inline

Enable/disable the Watchdog timer.

Parameters
[in]enableSet to true to enable Watchdog, false to disable. Watchdog cannot be disabled if Watchdog has been locked.

◆ WDOG_Feed()

SL_DEPRECATED_API_SDK_4_1 void WDOG_Feed ( void  )
inline

Feed the Watchdog.

◆ WDOG_Init()

SL_DEPRECATED_API_SDK_4_1 void WDOG_Init ( const WDOG_Init_TypeDef init)
inline

Initialize Watchdog (assuming the Watchdog configuration has not been locked).

Parameters
[in]initStructure holding Watchdog configuration. A default setting WDOG_INIT_DEFAULT is available for initialization.

◆ WDOG_Lock()

SL_DEPRECATED_API_SDK_4_1 void WDOG_Lock ( void  )
inline

Lock the Watchdog configuration.

◆ WDOG_IsEnabled()

SL_DEPRECATED_API_SDK_4_1 bool WDOG_IsEnabled ( void  )
inline

Get enabled status of the Watchdog.

Returns
True if Watchdog is enabled.

◆ WDOG_IsLocked()

SL_DEPRECATED_API_SDK_4_1 bool WDOG_IsLocked ( void  )
inline

Get locked status of the Watchdog.

Returns
True if Watchdog is locked.

Macro Definition Documentation

◆ WDOG_SYNC_TIMEOUT

#define WDOG_SYNC_TIMEOUT   30000

In some scenarioes when the watchdog is disabled the synchronization register might be set and not be cleared until the watchdog is enabled again.

This will happen when for instance some watchdog register is modified while the watchdog clock is disabled. In these scenarioes we need to make sure that the software does not wait forever.

◆ DEFAULT_WDOG

#define DEFAULT_WDOG   WDOG

Default WDOG instance for deprecated functions.

◆ WDOG_INIT_DEFAULT

#define WDOG_INIT_DEFAULT
Value:
{ \
true, /* Start Watchdog when initialization is done. */ \
false, /* WDOG is not counting during debug halt. */ \
false, /* WDOG is not counting when in EM2. */ \
false, /* WDOG is not counting when in EM3. */ \
false, /* EM4 can be entered. */ \
false, /* Do not block disabling LFRCO/LFXO in CMU. */ \
false, /* Do not lock WDOG configuration. */ \
wdogClkSelLFRCO, /* Select 32.768 kHz WDOG oscillator. */ \
wdogPeriod_256k /* Set longest possible timeout period. */ \
}

Suggested default configuration for WDOG initialization structure.

Enumeration Type Documentation

◆ WDOG_ClkSel_TypeDef

Watchdog clock selection.

Enumerator
wdogClkSelULFRCO 

Ultra low frequency (1 kHz) clock.

wdogClkSelLFRCO 

Low frequency RC oscillator.

wdogClkSelLFXO 

Low frequency crystal oscillator.

◆ WDOG_PeriodSel_TypeDef

Watchdog period selection.

Enumerator
wdogPeriod_9 

9 clock periods

wdogPeriod_17 

17 clock periods

wdogPeriod_33 

33 clock periods

wdogPeriod_65 

65 clock periods

wdogPeriod_129 

129 clock periods

wdogPeriod_257 

257 clock periods

wdogPeriod_513 

513 clock periods

wdogPeriod_1k 

1025 clock periods

wdogPeriod_2k 

2049 clock periods

wdogPeriod_4k 

4097 clock periods

wdogPeriod_8k 

8193 clock periods

wdogPeriod_16k 

16385 clock periods

wdogPeriod_32k 

32769 clock periods

wdogPeriod_64k 

65537 clock periods

wdogPeriod_128k 

131073 clock periods

wdogPeriod_256k 

262145 clock periods