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.

low_freq_fsm_clock_t#

typedef AON_CLK_T low_freq_fsm_clock_t

Renaming low frequency fsm-clock type enum.

high_freq_fsm_clock_t#

typedef FSM_CLK_T high_freq_fsm_clock_t

Renaming high frequency fsm-clock type enum.

sl_si91x_watchdog_init_timer#

void sl_si91x_watchdog_init_timer (void )

Initialize the Watchdog timer (Power-up WDT and enables it to run during sleep mode).

Also un-masks its interrupt & sets RTC clock time-period.

Returns

• none

sl_si91x_watchdog_configure_clock#

sl_status_t sl_si91x_watchdog_configure_clock (watchdog_timer_clock_config_t * timer_clk_config_ptr)

Configure timer clock sources.

• Pre-conditions:

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

Configure clock sources & timer parameters like interrupt time(WDT restart time), system reset time & window time (another time stamp for WDT restart, if required).

Also un-masks its interrupt & sets RTC clock time-period.

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

Register Watchdog timer timeout callback and enables NVIC.

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)

Set Watchdog timer interrupt time(upper time-stamp for WDT restart) duration.

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

Read Watchdog timer interrupt time set value (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)

Set Watchdog timer system-reset time duration.

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

Read Watchdog timer system-reset time set value (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)

Set Watchdog timer window time value (lower time-stamp for WDT restart).

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

Read Watchdog timer window time set value (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 )

Read Watchdog timer system-reset status.

Returns

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

sl_si91x_watchdog_deinit_timer#

void sl_si91x_watchdog_deinit_timer (void )

De-initialize Watchdog timer, mask its interrupt, de-power and disable timer.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

  • sl_si91x_watchdog_unregister_timeout_callback

Returns

• none

sl_si91x_watchdog_unregister_timeout_callback#

void sl_si91x_watchdog_unregister_timeout_callback (void )

Unregister Watchdog timer timeout callback.

• Pre-conditions:

  • sl_si91x_watchdog_register_timeout_callback

Returns

• none

sl_si91x_watchdog_get_version#

sl_watchdog_timer_version_t sl_si91x_watchdog_get_version ( none)

Get the release 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 )

Start and enable the Watchdog timer.

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

Stop Watchdog timer by disabling it.

• Pre-conditions:

  • sl_si91x_watchdog_start_timer

Returns

• none

sl_si91x_watchdog_restart_timer#

__STATIC_INLINE void sl_si91x_watchdog_restart_timer (void )

Restart (kick) an already running Watchdog timer.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

  • sl_si91x_watchdog_configure_clock

  • sl_si91x_watchdog_start_timer

Returns

• none

sl_si91x_watchdog_enable_system_reset_on_processor_lockup#

__STATIC_INLINE void sl_si91x_watchdog_enable_system_reset_on_processor_lockup (void )

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

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

Disable the Watchdog timer to reset system on processor lockup.

• Pre-conditions:

  • sl_si91x_watchdog_init_timer

  • sl_si91x_watchdog_enable_system_reset_on_processor_lockup

Returns

• none