Detailed 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

Macros
#define	DEFAULT_WDOG WDOG

#define	WDOG_INIT_DEFAULT

#define	WDOG_SYNC_TIMEOUT 30000

Enumerations
enum	WDOG_ClkSel_TypeDef { wdogClkSelULFRCO = _WDOG_CTRL_CLKSEL_ULFRCO, wdogClkSelLFRCO = _WDOG_CTRL_CLKSEL_LFRCO, wdogClkSelLFXO = _WDOG_CTRL_CLKSEL_LFXO }

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 }

Functions
__STATIC_INLINE void	WDOG_Enable (bool enable)
	Enable/disable the watchdog timer.

__STATIC_INLINE void	WDOG_Feed (void)
	Feed the watchdog.

__STATIC_INLINE void	WDOG_Init (const WDOG_Init_TypeDef *init)
	Initialize watchdog (assuming the watchdog configuration has not been locked).

__STATIC_INLINE bool	WDOG_IsEnabled (void)
	Get enabled status of the watchdog.

__STATIC_INLINE bool	WDOG_IsLocked (void)
	Get locked status of the watchdog.

__STATIC_INLINE void	WDOG_Lock (void)
	Lock the watchdog configuration.

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).

__STATIC_INLINE bool	WDOGn_IsEnabled (WDOG_TypeDef *wdog)
	Get enabled status of the watchdog.

__STATIC_INLINE bool	WDOGn_IsLocked (WDOG_TypeDef *wdog)
	Get locked status of the watchdog.

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.

Macro Definition Documentation

#define DEFAULT_WDOG WDOG

Default WDOG instance for deprecated functions.

Definition at line 62 of file em_wdog.h .

Referenced by WDOG_Enable() , WDOG_Feed() , WDOG_Init() , WDOG_IsEnabled() , WDOG_IsLocked() , and WDOG_Lock() .

#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.

Definition at line 215 of file em_wdog.h .

Enumeration Type Documentation

enum WDOG_ClkSel_TypeDef

Watchdog clock selection.

Enumerator
wdogClkSelULFRCO	Ultra low frequency (1 kHz) clock
wdogClkSelLFRCO	Low frequency RC oscillator
wdogClkSelLFXO	Low frequency crystal oscillator

Definition at line 72 of file em_wdog.h .

enum 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

Definition at line 80 of file em_wdog.h .

Function Documentation

__STATIC_INLINE void WDOG_Enable ( bool enable )

Enable/disable the watchdog timer.

Deprecated:: Deprecated function. New code should use WDOGn_Enable() . This function uses DEFAULT_WDOG .

Parameters

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

Definition at line 414 of file em_wdog.h .

References DEFAULT_WDOG , and WDOGn_Enable() .

__STATIC_INLINE void WDOG_Feed ( void )

Feed the watchdog.

Deprecated:: Deprecated function. New code should use WDOGn_Feed() . This function uses DEFAULT_WDOG .

Definition at line 427 of file em_wdog.h .

References DEFAULT_WDOG , and WDOGn_Feed() .

__STATIC_INLINE void WDOG_Init ( const WDOG_Init_TypeDef * init )

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

Deprecated:: Deprecated function. New code should use WDOGn_Init() . This function uses DEFAULT_WDOG .

Parameters

[in] init Structure holding watchdog configuration. A default setting WDOG_INIT_DEFAULT is available for initialization.

Definition at line 445 of file em_wdog.h .

References DEFAULT_WDOG , and WDOGn_Init() .

__STATIC_INLINE bool WDOG_IsEnabled ( void )

Get enabled status of the watchdog.

Deprecated:: Deprecated function. New code should use WDOGn_IsEnabled() . This function uses DEFAULT_WDOG .

Definition at line 471 of file em_wdog.h .

References DEFAULT_WDOG , and WDOGn_IsEnabled() .

__STATIC_INLINE bool WDOG_IsLocked ( void )

Get locked status of the watchdog.

Deprecated:: Deprecated function. New code should use WDOGn_IsLocked() . This function uses DEFAULT_WDOG .

Definition at line 484 of file em_wdog.h .

References DEFAULT_WDOG , and WDOGn_IsLocked() .

__STATIC_INLINE void WDOG_Lock ( void )

Lock the watchdog configuration.

Deprecated:: Deprecated function. New code should use WDOGn_Lock() . This function uses DEFAULT_WDOG .

Definition at line 458 of file em_wdog.h .

References DEFAULT_WDOG , and WDOGn_Lock() .

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]	`wdog`	A pointer to the WDOG peripheral register block.
[in]	`enable`	True to enable Watchdog, false to disable. Watchdog cannot be disabled if it's been locked.

Definition at line 80 of file em_wdog.c .

References BUS_RegBitWrite() .

Referenced by WDOG_Enable() , and WDOGn_Init() .

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] wdog A pointer to the WDOG peripheral register block.

Definition at line 142 of file em_wdog.c .

References CORE_DECLARE_IRQ_STATE , CORE_ENTER_ATOMIC , and CORE_EXIT_ATOMIC .

Referenced by WDOG_Feed() .

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]	`wdog`	Pointer to the WDOG peripheral register block.
[in]	`init`	The structure holding the WDOG configuration. A default setting WDOG_INIT_DEFAULT is available for initialization.

Definition at line 204 of file em_wdog.c .

References WDOG_Init_TypeDef::clkSel , WDOG_Init_TypeDef::debugRun , WDOG_Init_TypeDef::em2Run , WDOG_Init_TypeDef::em3Run , WDOG_Init_TypeDef::em4Block , WDOG_Init_TypeDef::enable , WDOG_Init_TypeDef::lock , WDOG_Init_TypeDef::perSel , WDOG_Init_TypeDef::swoscBlock , WDOGn_Enable() , and WDOGn_Lock() .

Referenced by WDOG_Init() .

__STATIC_INLINE bool WDOGn_IsEnabled ( WDOG_TypeDef * wdog )

Get enabled status of the watchdog.

Parameters

[in] wdog Pointer to WDOG peripheral register block.

Definition at line 377 of file em_wdog.h .

Referenced by WDOG_IsEnabled() .

__STATIC_INLINE bool WDOGn_IsLocked ( WDOG_TypeDef * wdog )

Get locked status of the watchdog.

Parameters

[in] wdog Pointer to WDOG peripheral register block.

Definition at line 393 of file em_wdog.h .

Referenced by WDOG_IsLocked() .

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] wdog A pointer to WDOG peripheral register block.

Definition at line 285 of file em_wdog.c .

References BUS_RegBitWrite() .

Referenced by WDOG_Lock() , and WDOGn_Init() .

void WDOGn_SyncWait ( WDOG_TypeDef * wdog )

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

Parameters

[in] wdog A pointer to WDOG peripheral register block.

Definition at line 308 of file em_wdog.c .

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] wdog A pointer to WDOG peripheral register block.

Definition at line 332 of file em_wdog.c .

WDOG EMLIB

Detailed Description

Data Structures

Macros

Enumerations

Functions

Macro Definition Documentation

Enumeration Type Documentation

Function Documentation

WDOG
EMLIB