Watchdog Timer#

bg_pmu_clock_t#

bg_pmu_clock_t

To represent BG-PMU clock sources.

This enumeration defines the possible clock sources for the BG-PMU (Background Power Management Unit).

time_delays_t#

time_delays_t

Enumeration to represent possible time delay values for WDT interrupt time and system reset time with a 32 KHz clock frequency.

This enumeration defines the possible time delay values for the Watchdog Timer (WDT) interrupt and system reset times when using a 32-KHz clock frequency.

watchdog_timer_callback_t#

typedef void(* watchdog_timer_callback_t) (void) )(void)

Typedef for the function pointer of the callback function.

high_freq_fsm_clock_t#

typedef FSM_CLK_T high_freq_fsm_clock_t

Renaming high frequency fsm-clock type enum.

low_freq_fsm_clock_t#

typedef AON_CLK_T low_freq_fsm_clock_t

Renaming low frequency fsm-clock type enum.

sl_si91x_watchdog_init_timer#

void sl_si91x_watchdog_init_timer (void )

To initialize the Watchdog Timer.

This API initializes the Watchdog Timer by enabling the peripheral power. It also configures the Watchdog Timer to run during sleep mode and unmasks its interrupt.

Note

• This function should be called before using any other Watchdog Timer functions.

sl_si91x_watchdog_configure_clock#

sl_status_t sl_si91x_watchdog_configure_clock (watchdog_timer_clock_config_t * timer_clk_config_ptr)

To enable and configure the Watchdog Timer clock sources.

This API configures the Watchdog Timer's low frequency and BG-PMU clock sources.

• Pre-condition:

  • sl_si91x_watchdog_init_timer

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, timer clock-source parameters configured properly.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Timer configuration structure members have invalid values.

  • SL_STATUS_NULL_POINTER (0x0022) - The parameter is a null pointer.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_watchdog_set_configuration#

sl_status_t sl_si91x_watchdog_set_configuration (watchdog_timer_config_t * timer_config_ptr)

To configure Watchdog Timer parameters.

This API configures the Watchdog Timer parameters, including interrupt time (WDT restart time), system reset time, and window time (lower time stamp for WDT restart, if necessary). The interrupt time should be greater than the window time; otherwise, the API will return an error.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

  • sl_si91x_watchdog_configure_clock

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, timer parameters configured properly.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Timer configuration structure members have invalid values.

  • SL_STATUS_NULL_POINTER (0x0022) - The parameter is a null pointer.

  • SL_STATUS_INVALID_CONFIGURATION (0x0023) - Timer configuration structure member 'interrupt_time' is less than or equal to 'window_time'. It should be greater than the window time of the timer.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_watchdog_register_timeout_callback#

sl_status_t sl_si91x_watchdog_register_timeout_callback (watchdog_timer_callback_t on_timeout_callback)

To register the Watchdog Timer timeout callback.

This API registers a callback function to be called when the Watchdog Timer timeout interrupt occurs. Registering the callback also enables its interrupts. Before registering a new callback, the user must unregister any previously registered callback using the sl_si91x_watchdog_unregister_timeout_callback function.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully registered the timer timeout callback.

  • SL_STATUS_BUSY (0x0004) - The callback is already registered; the user must unregister the previous callback before registering again.

  • SL_STATUS_NULL_POINTER (0x0022) - The callback function pointer parameter is a null pointer.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_watchdog_set_interrupt_time#

sl_status_t sl_si91x_watchdog_set_interrupt_time (time_delays_t interrupt_time)

To set the Watchdog Timer interrupt time (Overflow or Restart time).

This API sets the Watchdog Timer interrupt time, also referred to as the upper time-stamp for WDT restart. The maximum value for the interrupt time is 31.

• Number of clock pulses for timer timeout = 2^(interrupt_time)

Note

• The 'interrupt_time' value should be greater than the window time.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

  • sl_si91x_watchdog_configure_clock

  • sl_si91x_watchdog_set_system_reset_time

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully set the Watchdog Timer timeout value.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - The 'interrupt_time' parameter has an invalid value.

  • SL_STATUS_INVALID_CONFIGURATION (0x0023) - The 'interrupt_time' value is less than the window time.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_watchdog_get_interrupt_time#

uint8_t sl_si91x_watchdog_get_interrupt_time (void )

To read the configured Watchdog Timer interrupt time.

This API returns the interrupt time configured for the Watchdog Timer in terms of the power of two.

• Pre-conditions:

  • sl_si91x_watchdog_set_interrupt_time

Returns

• uint8_t The configured interrupt time value, see time_delays_t.

sl_si91x_watchdog_set_system_reset_time#

sl_status_t sl_si91x_watchdog_set_system_reset_time (time_delays_t system_reset_time)

To set the Watchdog Timer system reset time duration.

This API sets the duration for the Watchdog Timer system reset. The number of clock pulses for the system reset time is calculated as 2^(system_reset_time). The maximum value for system_reset_time is 31. This value should be greater than the timer window time.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

  • sl_si91x_watchdog_configure_clock

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully set the Watchdog Timer system reset time value.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - The 'system_reset_time' parameter has an invalid value.

  • SL_STATUS_INVALID_CONFIGURATION (0x0023) - The 'system_reset_time' value is less than the window time.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_watchdog_get_system_reset_time#

uint8_t sl_si91x_watchdog_get_system_reset_time (void )

To read the configured Watchdog Timer system reset time.

This API returns the system reset time configured for the Watchdog Timer in terms of the power of two.

• Pre-conditions:

  • sl_si91x_watchdog_set_system_reset_time

Returns

• uint8_t The configured system reset time value, see time_delays_t.

sl_si91x_watchdog_set_window_time#

sl_status_t sl_si91x_watchdog_set_window_time (time_delays_t window_time)

To set the Watchdog Timer window time value.

This API sets the window time value for the Watchdog Timer. By setting this value, the timer becomes a window Watchdog Timer. If this value is zero, it acts as a regular WDT. It is also referred to as the lower time-stamp for WDT restart. The maximum value is 15.

• Number of clock pulses for window time = 2^(window_time).

• This value should be less than the timer interrupt time and system reset time.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

  • sl_si91x_watchdog_configure_clock

  • sl_si91x_watchdog_set_system_reset_time

  • sl_si91x_watchdog_set_interrupt_time

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully set the Watchdog Timer window time value.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - The 'window_time' parameter has an invalid value.

  • SL_STATUS_INVALID_CONFIGURATION (0x0023) - The 'window_time' value is greater than the interrupt time or system reset time.

For more information on status codes, see SL STATUS DOCUMENTATION.

sl_si91x_watchdog_get_window_time#

uint8_t sl_si91x_watchdog_get_window_time (void )

To read the configured Watchdog Timer window time.

This API returns the set window time value (not the current count) in terms of the power of two.

• Pre-conditions:

  • sl_si91x_watchdog_set_window_time

Returns

• uint8_t The configured window time value, see time_delays_t.

sl_si91x_watchdog_get_timer_system_reset_status#

boolean_t sl_si91x_watchdog_get_timer_system_reset_status (void )

To read the Watchdog Timer system reset status.

This API returns the system reset status of the Watchdog Timer. It returns true if the system was reset by the Watchdog Timer, and false if it was a power-on reset.

Returns

• boolean_t Returns true if the Watchdog Timer reset the system, otherwise returns false.

sl_si91x_watchdog_deinit_timer#

void sl_si91x_watchdog_deinit_timer (void )

To de-initialize the Watchdog Timer.

This API de-initializes the Watchdog Timer by masking interrupts, unregistering the callback, and disabling the timer.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

  • sl_si91x_watchdog_unregister_timeout_callback

sl_si91x_watchdog_unregister_timeout_callback#

void sl_si91x_watchdog_unregister_timeout_callback (void )

To unregister the Watchdog Timer timeout callback.

This API unregisters the callback function for the Watchdog Timer timeout interrupt. It clears the callback function address and sets the callback variable to NULL.

• Pre-condition:

  • sl_si91x_watchdog_register_timeout_callback

sl_si91x_watchdog_get_version#

sl_watchdog_timer_version_t sl_si91x_watchdog_get_version (void )

To get the API version of the Watchdog timer.

This API retrieves the version information of the Watchdog timer.

Returns

• sl_watchdog_timer_version_t Structure containing the version information.

sl_si91x_watchdog_start_timer#

__STATIC_INLINE void sl_si91x_watchdog_start_timer (void )

To start and enable the Watchdog Timer.

Once the Watchdog Timer (WDT) is started, the interrupt time will begin incrementing. When it reaches the set interrupt time value, the WDT will generate an interrupt, and the timer will load the system reset time value. Before it reaches this value, the WDT should be restarted (kicked) to avoid a system reset.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

  • sl_si91x_watchdog_configure_clock

  • sl_si91x_watchdog_register_timeout_callback

sl_si91x_watchdog_stop_timer#

__STATIC_INLINE void sl_si91x_watchdog_stop_timer (void )

To stop the Watchdog Timer by disabling it.

This API stops an already running Watchdog Timer. It disables the timer by updating the 'WWD_TIMER_ENABLE' register bits. Specifically, it updates the 'wwd_timer_en' (23:16) bits of the timer enable register to 0xF0, thereby disabling the WDT timer.

• Pre-conditions:

  • sl_si91x_watchdog_start_timer

sl_si91x_watchdog_restart_timer#

__STATIC_INLINE void sl_si91x_watchdog_restart_timer (void )

To restart (kick) an already running Watchdog Timer.

This API sets the restart bit of the Watchdog Timer when it is already enabled. It should be used for an already started WDT timer, not for starting a stopped timer.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

  • sl_si91x_watchdog_configure_clock

  • sl_si91x_watchdog_start_timer

sl_si91x_watchdog_enable_system_reset_on_processor_lockup#

__STATIC_INLINE void sl_si91x_watchdog_enable_system_reset_on_processor_lockup (void )

To enable the Watchdog Timer to reset the system on processor lockup.

This API enables the Watchdog Timer (WDT) to generate a system reset when the processor gets stuck or reaches a lockup state. It achieves this by setting the 'PROCESSOR_STUCK_RESET_EN' bit of the 'WWD_ARM_STUCK_EN' register of the WDT.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

sl_si91x_watchdog_disable_system_reset_on_processor_lockup#

__STATIC_INLINE void sl_si91x_watchdog_disable_system_reset_on_processor_lockup (void )

To disable the Watchdog Timer from resetting the system on processor lockup.

This API disables the Watchdog Timer (WDT) from generating a system reset when the processor gets stuck or reaches a lockup state. It achieves this by writing '0' to the 'PROCESSOR_STUCK_RESET_EN' bit of the 'WWD_ARM_STUCK_EN' register of the WDT.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

  • sl_si91x_watchdog_enable_system_reset_on_processor_lockup