Watchdog Timer#

bg_pmu_clock_t#

bg_pmu_clock_t

Enumeration to represent bg-pmu clock sources.

time_delays_t#

time_delays_t

Enumeration to represent possible time delays values for WDT interrupt time and system reset time with 32 KHZ clock freq.

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.

low_freq_fsm_clock_src#

uint8_t watchdog_timer_clock_config_t::low_freq_fsm_clock_src

low frequency FSM clock source, low_freq_fsm_clock_t

high_freq_fsm_clock_src#

uint8_t watchdog_timer_clock_config_t::high_freq_fsm_clock_src

high frequency FSM clock source, high_freq_fsm_clock_t

bg_pmu_clock_source#

uint8_t watchdog_timer_clock_config_t::bg_pmu_clock_source

bg_pmu clock source, bg_pmu_clock_t

interrupt_time#

uint8_t watchdog_timer_config_t::interrupt_time

timer timeout interrupt duration, number of clock pulses = 2^(system_reset_time), time_delays_t

system_reset_time#

uint8_t watchdog_timer_config_t::system_reset_time

timer system-reset duration, number of clock pulses = 2^(system_reset_time), time_delays_t

window_time#

uint8_t watchdog_timer_config_t::window_time

timer window duration, number of clock pulses = 2^(window_time), time_delays_t, but should be less than TIME_DELAY_16

release#

uint8_t sl_watchdog_timer_version_t::release

Release version number.

major#

uint8_t sl_watchdog_timer_version_t::major

sqa version number

minor#

uint8_t sl_watchdog_timer_version_t::minor

dev version number

sl_si91x_watchdog_init_timer#

void sl_si91x_watchdog_init_timer (void )

This API will initialize the Watchdog timer.

This API will initialize the Watchdog timer by enabling the peripheral power. It also enables to run watchdog-timer during sleep mode. Also un-masks its interrupt.

Returns

• none

sl_si91x_watchdog_configure_clock#

sl_status_t sl_si91x_watchdog_configure_clock (watchdog_timer_clock_config_t * timer_clk_config_ptr)

This API will enable and configures the timer clock sources.

Configures the watchdog-timer low frequency and bg-pmu clock sources.

• Pre-condition:

  • sl_si91x_watchdog_init_timer

Returns

• status 0 if successful, else error code as follows:

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Timer configuration structure members have invalid values, for members watchdog_timer_clock_config_t

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

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

sl_si91x_watchdog_set_configuration#

sl_status_t sl_si91x_watchdog_set_configuration (watchdog_timer_config_t * timer_config_ptr)

This API configures watchdog timer parameters.

The configurable parameters are interrupt time (WDT restart time), system reset time & window time (lower time stamp for WDT restart, if required). System reset time should be greater than interrupt time. And Interrupt time should be greater than window time, else API will give an error.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

  • sl_si91x_watchdog_configure_clock

Returns

• status 0 if successful, else error code as follows:

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Timer configuration structure members have invalid values, for members watchdog_timer_config_t

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

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

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

sl_si91x_watchdog_register_timeout_callback#

sl_status_t sl_si91x_watchdog_register_timeout_callback (watchdog_timer_callback_t on_timeout_callback)

This API will register the Watchdog timer timeout callback.

Registering call back also enables its interrupts. Before registering a callback, the user must unregister if any callbacks that are already registered.

Returns

• status 0 if successful, else error code as follows:

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

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

  • SL_STATUS_OK (0x0000) - Successfully registered timer timer-out callback

sl_si91x_watchdog_set_interrupt_time#

sl_status_t sl_si91x_watchdog_set_interrupt_time (time_delays_t interrupt_time)

This API will set the Watchdog timer interrupt time (Overflow or Restart time).

This also referred as upper time-stamp for WDT restart Its maximum value is 31.

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

  • The timeout value should be less than system-reset time and greater than window time.

  • Pre-conditions:

    • sl_si91x_watchdog_init_timer

    • sl_si91x_watchdog_configure_clock

    • sl_si91x_watchdog_set_system_reset_time

  Returns

  • status 0 if successful, else error code as follows:

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

    • SL_STATUS_INVALID_CONFIGURATION (0x0023) - 'interrupt_time' value is less than window time or greater than system reset time

    • SL_STATUS_OK (0x0000) - Successfully set watchdog timer timeout time value

sl_si91x_watchdog_get_interrupt_time#

uint8_t sl_si91x_watchdog_get_interrupt_time (void )

This API will read the Watchdog timer interrupt time configured value.

It will return interrupt time in terms of power of two.

• Pre-conditions:

  • sl_si91x_watchdog_set_interrupt_time

Returns

• returns interrupt time (uint8_t) value, 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)

This API will set the Watchdog timer system-reset time duration.

Number of clock pulses for system reset time = 2^(system_reset_time). Its maximum value is 31. This value should be greater than timer interrupt time & window time.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

  • sl_si91x_watchdog_configure_clock

Returns

• status 0 if successful, else error code as follows:

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

  • SL_STATUS_INVALID_CONFIGURATION (0x0023) - 'system_reset_time' value is less than window time or interrupt time

  • SL_STATUS_OK (0x0000) - Successfully set watchdog timer system-reset time value

sl_si91x_watchdog_get_system_reset_time#

uint8_t sl_si91x_watchdog_get_system_reset_time (void )

This API will read the Watchdog timer system-reset time configured value.

It will return system reset time in terms of power of two.

• Pre-conditions:

  • sl_si91x_watchdog_set_system_reset_time

Returns

• returns system-reset time (uint8_t) value, time_delays_t

sl_si91x_watchdog_set_window_time#

sl_status_t sl_si91x_watchdog_set_window_time (time_delays_t window_time)

This API will set the Watchdog timer window time value.

By setting this value timer becomes as Window watchdog timer, if this value is zero it act as regular WDT. It is also referred as lower time-stamp for WDT restart. Its maximum value is 15. Number of clock pulses for window time = 2^(window_time). This value should be less than 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

• status 0 if successful, else error code as follows:

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

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

  • SL_STATUS_OK (0x0000) - Successfully set watchdog timer window time value

sl_si91x_watchdog_get_window_time#

uint8_t sl_si91x_watchdog_get_window_time (void )

This API will read the Watchdog timer window time configured value.

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

• Pre-conditions:

  • sl_si91x_watchdog_set_window_time

Returns

• returns window time (uint8_t) value, time_delays_t.

sl_si91x_watchdog_get_timer_system_reset_status#

boolean_t sl_si91x_watchdog_get_timer_system_reset_status (void )

This API will read the Watchdog timer system-reset status.

This will return true when watchdog-timer resets system and returns false when it is a power-on reset.

Returns

• returns true if watchdog timer resets system, else returns false

sl_si91x_watchdog_deinit_timer#

void sl_si91x_watchdog_deinit_timer (void )

This API will de-initialize the Watchdog timer.

De-initializes, mask interrupts, unregisters the callback and disable timer.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

  • sl_si91x_watchdog_unregister_timeout_callback

Returns

• none

Note

• Unregisters the timer callback.

sl_si91x_watchdog_unregister_timeout_callback#

void sl_si91x_watchdog_unregister_timeout_callback (void )

This API will unregisters the Watchdog timer timeout callback.

It will unregister the callback, i.e., clear the callback function address and pass NULL value to the variable.

• Pre-condition:

  • sl_si91x_watchdog_register_timeout_callback

Returns

• none

sl_si91x_watchdog_get_version#

sl_watchdog_timer_version_t sl_si91x_watchdog_get_version ( none)

This API will get the API version of the Watchdog timer.

This API is used to know the API version of Watchdog timer.

Returns

• ( sl_watchdog_version_t) type structure

sl_si91x_watchdog_start_timer#

__STATIC_INLINE void sl_si91x_watchdog_start_timer (void )

This API will start and enable the Watchdog timer.

Once WDT is started interrupt time will start incrementing as it reaches set interrupt time value, WDT will generate interrupt and timer will load system reset time value and before it reaches this value WDT should be restarted (kicked) to avoid System reset.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

  • sl_si91x_watchdog_configure_clock

  • sl_si91x_watchdog_register_timeout_callback

Returns

• none

sl_si91x_watchdog_stop_timer#

__STATIC_INLINE void sl_si91x_watchdog_stop_timer (void )

This API will stop the Watchdog timer by disabling it.

Used to stop an already running timer. It disables the timer by updating 'WWD_TIMER_ENABLE' register bits. It updates 'wwd_timer_en'(23:16) bits of timer enable register by 0xF0, to disable the WDT timer.

• Pre-conditions:

  • sl_si91x_watchdog_start_timer

Returns

• none

sl_si91x_watchdog_restart_timer#

__STATIC_INLINE void sl_si91x_watchdog_restart_timer (void )

sl_si91x_watchdog_enable_system_reset_on_processor_lockup#

__STATIC_INLINE void sl_si91x_watchdog_enable_system_reset_on_processor_lockup (void )

Enables the Watchdog timer to reset the system on processor lockup.

It enables WDT to generate a system-reset when the processor got stuck or reached a lock-up state, by setting 'PROCESSOR_STUCK_RESET_EN' bit of 'WWD_ARM_STUCK_EN' register of WDT.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

Returns

• none

sl_si91x_watchdog_disable_system_reset_on_processor_lockup#

__STATIC_INLINE void sl_si91x_watchdog_disable_system_reset_on_processor_lockup (void )

This API is used to disables the watchdog timer to reset system on processor lockup or on processor stuck.

It disables the WDT to generate system-reset when processor got stuck or reached lock-up state, by writing '0' to 'PROCESSOR_STUCK_RESET_EN' bit of 'WWD_ARM_STUCK_EN' register of WDT.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

  • sl_si91x_watchdog_enable_system_reset_on_processor_lockup

Returns

• none.