Ultra Low-Power Timer#

ulp_timer_instance_t#

ulp_timer_instance_t

Enumeration to represent ulp-timer instances.

ulp_timer_mode_t#

ulp_timer_mode_t

Enumeration to represent ULP-timer modes.

ulp_timer_type_t#

ulp_timer_type_t

Enumeration to represent ULP-timer types.

ulp_timer_clk_input_source_t#

ulp_timer_clk_input_source_t

Enumeration to represent values of clock sources to select as Timer clock.

ulp_timer_callback_t#

typedef void(* ulp_timer_callback_t) (void) )(void)

Typedef for the function pointer of the callback function.

ulp_timer_clock_t#

typedef CLK_ENABLE_T ulp_timer_clock_t

Renaming clock type enum.

ulp_timer_direction_t#

typedef ulp_timer_dir_t ulp_timer_direction_t

Renaming clock type enum.

ulp_timer_clk_type#

uint8_t ulp_timer_clk_src_config_t::ulp_timer_clk_type

true to enable static and false to enable dynamic clock type

ulp_timer_sync_to_ulpss_pclk#

boolean_t ulp_timer_clk_src_config_t::ulp_timer_sync_to_ulpss_pclk

true to enable and false to disable ULP timer in synchronous mode to ULPSS pclk

ulp_timer_clk_input_src#

uint8_t ulp_timer_clk_src_config_t::ulp_timer_clk_input_src

timer input clock source, refer ulp_timer_clk_input_source_t for possible values

ulp_timer_skip_switch_time#

boolean_t ulp_timer_clk_src_config_t::ulp_timer_skip_switch_time

true to wait and false to Skip waiting for switching timer clk

timer_num#

uint8_t ulp_timer_config_t::timer_num

timer number, SL_ULP_TIMER_NUMBER for default values

timer_mode#

uint8_t ulp_timer_config_t::timer_mode

timer mode, SL_ULP_TIMER_MODE for default values

timer_type#

uint8_t ulp_timer_config_t::timer_type

timer type, SL_ULP_TIMER_TYPE for default values

timer_match_value#

uint32_t ulp_timer_config_t::timer_match_value

timer match value SL_ULP_TIMER_MATCH_VALUE(delay time) in microseconds

timer_direction#

uint8_t ulp_timer_config_t::timer_direction

timer direction, SL_ULP_TIMER_DIRECTION for default values

release#

uint8_t sl_ulp_timer_version_t::release

Release version number.

major#

uint8_t sl_ulp_timer_version_t::major

sqa version number

minor#

uint8_t sl_ulp_timer_version_t::minor

dev version number

sl_si91x_ulp_timer_configure_clock#

sl_status_t sl_si91x_ulp_timer_configure_clock (ulp_timer_clk_src_config_t * timer_clk_ptr)

Configure the ULP-Timer input clock source.

Returns

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

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Timer clock type or timer clock source values are invalid

  • SL_STATUS_INVALID_CONFIGURATION (0x0023) - Timer clock-source configuration structure members have invalid configurations.

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

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

sl_si91x_ulp_timer_set_configuration#

sl_status_t sl_si91x_ulp_timer_set_configuration (ulp_timer_config_t * timer_config_ptr)

Configure ULP-Timer parameters such as timer number, mode, type, match-value & direction.

Also configures integral and fractional values of clock cycles per microseconds or per 256 microseconds, as per the timer-type value.

• Pre-conditions:

  • sl_si91x_ulp_timer_configure_clock();

Returns

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

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

  • SL_STATUS_INVALID_INDEX (0x0027) - Timer configuration structure member 'timer_num' has an invalid value.

  • SL_STATUS_INVALID_MODE (0x0024) - Timer configuration structure member 'timer_mode' has an invalid value.

  • SL_STATUS_INVALID_TYPE (0x0026) - Timer configuration structure member 'timer_type' has an invalid value.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Timer configuration structure member 'timer_direction' has an invalid value.

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

sl_si91x_ulp_timer_start#

sl_status_t sl_si91x_ulp_timer_start (ulp_timer_instance_t timer_num)

Start the ULP-Timer.

• Pre-conditions:

  • sl_si91x_ulp_timer_configure_clock

  • sl_si91x_ulp_timer_set_configuration

  • sl_si91x_ulp_timer_register_timeout_callback

Returns

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

  • SL_STATUS_INVALID_INDEX (0x0027) - 'timer_num' parameter value is invalid.

  • SL_STATUS_OK (0x0000) - Successfully started the timer instance

sl_si91x_ulp_timer_stop#

sl_status_t sl_si91x_ulp_timer_stop (ulp_timer_instance_t timer_num)

Stop the ULP-Timer.

• Pre-conditions:

  • sl_si91x_ulp_timer_configure_clock

  • sl_si91x_ulp_timer_set_configuration

  • sl_si91x_ulp_timer_start

Returns

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

  • SL_STATUS_INVALID_INDEX (0x0027) - 'timer_num' parameter value is invalid.

  • SL_STATUS_OK (0x0000) - Successfully stopped the timer instance

sl_si91x_ulp_timer_restart#

sl_status_t sl_si91x_ulp_timer_restart (ulp_timer_instance_t timer_num)

Restart an already running ULP-Timer, means it will first stop the timer and then start it again.

• Pre-conditions:

  • sl_si91x_ulp_timer_configure_clock

  • sl_si91x_ulp_timer_set_configuration

  • sl_si91x_ulp_timer_start

Returns

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

  • SL_STATUS_INVALID_INDEX (0x0027) - 'timer_num' parameter value is invalid.

  • SL_STATUS_OK (0x0000) - Successfully restarted the timer instance

sl_si91x_ulp_timer_set_type#

sl_status_t sl_si91x_ulp_timer_set_type (ulp_timer_instance_t timer_num, ulp_timer_type_t timer_type)

Set the ULP-Timer type.

• Pre-conditions:

  • sl_si91x_ulp_timer_configure_clock

  • sl_si91x_ulp_timer_stop

Returns

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

  • SL_STATUS_INVALID_INDEX (0x0027) - 'timer_num' parameter value is invalid.

  • SL_STATUS_INVALID_TYPE (0x0026) - 'timer_type' parameter value is invalid.

  • SL_STATUS_OK (0x0000) - Successfully set timer-type

sl_si91x_ulp_timer_set_direction#

sl_status_t sl_si91x_ulp_timer_set_direction (ulp_timer_instance_t timer_num, ulp_timer_direction_t timer_direction)

Set the ULP-Timer direction as up-counting or down-counting.

• Pre-conditions:

  • sl_si91x_ulp_timer_configure_clock

  • sl_si91x_ulp_timer_stop

Returns

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

  • SL_STATUS_INVALID_INDEX (0x0027) - 'timer_num' parameter value is invalid.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - 'timer_direction' parameter value is invalid.

  • SL_STATUS_OK (0x0000) - Successfully set timer-direction

sl_si91x_ulp_timer_set_mode#

sl_status_t sl_si91x_ulp_timer_set_mode (ulp_timer_instance_t timer_num, ulp_timer_mode_t timer_mode)

Set ULP-Timer Mode.

• Pre-conditions:

  • sl_si91x_ulp_timer_configure_clock

  • sl_si91x_ulp_timer_stop

Returns

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

  • SL_STATUS_INVALID_INDEX (0x0027) - 'timer_num' parameter value is invalid.

  • SL_STATUS_INVALID_MODE (0x0024) - 'timer_mode' parameter value is invalid.

  • SL_STATUS_OK (0x0000) - Successfully set timer-mode

sl_si91x_ulp_timer_set_count#

sl_status_t sl_si91x_ulp_timer_set_count (ulp_timer_instance_t timer_num, uint32_t timer_match_value)

Set ULP-Timer match value.

• Pre-conditions:

  • sl_si91x_ulp_timer_configure_clock

  • sl_si91x_ulp_timer_stop

  • sl_si91x_ulp_timer_set_type

  • sl_si91x_ulp_timer_set_direction

Returns

• status 0 if successful, else error-code

  • SL_STATUS_INVALID_INDEX (0x0027) - 'timer_num' parameter value is invalid.

  • SL_STATUS_OK (0x0000) - Successfully set timer match value.

sl_si91x_ulp_timer_get_count#

sl_status_t sl_si91x_ulp_timer_get_count (ulp_timer_instance_t timer_num, uint32_t * count_value)

Read the ULP-Timer count.

• Pre-conditions:

  • sl_si91x_ulp_timer_configure_clock

  • sl_si91x_ulp_timer_start

  • sl_si91x_ulp_timer_set_count

Returns

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

  • SL_STATUS_NULL_POINTER (0x0022) - 'Pointer to count_value' parameter is a null pointer.

  • SL_STATUS_INVALID_INDEX (0x0027) - 'timer_num' parameter value is invalid.

  • SL_STATUS_OK (0x0000) - Successfully read the timer's current count value

sl_si91x_ulp_timer_get_type#

sl_status_t sl_si91x_ulp_timer_get_type (ulp_timer_instance_t timer_num, uint32_t * timer_type)

Read the ULP-Timer type.

• Pre-conditions:

  • sl_si91x_ulp_timer_configure_clock

  • sl_si91x_ulp_timer_set_type

Returns

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

  • SL_STATUS_NULL_POINTER (0x0022) - 'Pointer to timer_type' parameter is a null pointer.

  • SL_STATUS_INVALID_INDEX (0x0027) - 'timer_num' parameter value is invalid.

  • SL_STATUS_OK (0x0000) - Successfully read the timer's current count value

sl_si91x_ulp_timer_get_mode#

sl_status_t sl_si91x_ulp_timer_get_mode (ulp_timer_instance_t timer_num, uint32_t * timer_mode)

Read the ULP-Timer mode.

• Pre-conditions:

  • sl_si91x_ulp_timer_configure_clock

  • sl_si91x_ulp_timer_set_mode

Returns

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

  • SL_STATUS_NULL_POINTER (0x0022) - 'Pointer to timer_mode' parameter is a null pointer.

  • SL_STATUS_INVALID_INDEX (0x0027) - 'timer_num' parameter value is invalid.

  • SL_STATUS_OK (0x0000) - Successfully read the timer's current count value

sl_si91x_ulp_timer_get_direction#

sl_status_t sl_si91x_ulp_timer_get_direction (ulp_timer_instance_t timer_num, uint32_t * timer_direction)

Read the ULP-Timer direction (up-counter or down-counter).

• Pre-conditions:

  • sl_si91x_ulp_timer_configure_clock

  • sl_si91x_ulp_timer_set_direction

Returns

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

  • SL_STATUS_NULL_POINTER (0x0022) - 'Pointer to timer_direction' parameter is a null pointer.

  • SL_STATUS_INVALID_INDEX (0x0027) - 'timer_num' parameter value is invalid.

  • SL_STATUS_OK (0x0000) - Successfully read the timer's current count value

sl_si91x_ulp_timer_register_timeout_callback#

sl_status_t sl_si91x_ulp_timer_register_timeout_callback (ulp_timer_instance_t timer_num, ulp_timer_callback_t on_timeout_callback)

Register callback of timer timeout interrupt and enabling it.

Returns

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

  • SL_STATUS_NULL_POINTER (0x0022) - 'pointer to callback_data_input' parameter is a null pointer.

  • SL_STATUS_INVALID_INDEX (0x0027) - 'timer_num' parameter value is invalid.

  • SL_STATUS_ALLOCATION_FAILED (0x0019) - Timer interrupt enabling failed.

  • SL_STATUS_BUSY (0x0004) - The callback is already registered, unregister the previous callback before registering a new one.

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

sl_si91x_ulp_timer_unregister_timeout_callback#

sl_status_t sl_si91x_ulp_timer_unregister_timeout_callback (ulp_timer_instance_t timer_num)

Unregister callback of timer timeout interrupt and disabling it.

• Pre-conditions:

  • sl_si91x_ulp_timer_register_timeout_callback

Returns

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

  • SL_STATUS_INVALID_INDEX (0x0027) - 'timer_num' parameter value is invalid.

  • SL_STATUS_ALLOCATION_FAILED (0x0019) - Timer interrupt disabling failed.

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

sl_si91x_ulp_timer_configure_soc_clock#

sl_status_t sl_si91x_ulp_timer_configure_soc_clock (boolean_t div_factor_type, uint16_t div_factor)

Configure the Ulpss SoC clock from M4 SOC clock, to enable the SOC clock source.

Returns

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

  • SL_STATUS_INVALID_PARAMETER(0x0021) - 'div_factor' is not according to div_factor_type

sl_si91x_ulp_timer_configure_xtal_clock#

sl_status_t sl_si91x_ulp_timer_configure_xtal_clock (uint8_t xtal_pin)

Configure the XTAL clock when the clock source is an external XTAL clock.

Returns

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

  • SL_STATUS_INVALID_PARAMETER(0x0021) - 'xtal_pin' parameter value is invalid.

sl_si91x_ulp_timer_init#

sl_status_t sl_si91x_ulp_timer_init (ulp_timer_clk_src_config_t * timer_clk_ptr)

Initialize ULP-Timer clock by configuring the clock source.

Returns

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

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Timer clock type or timer clock source values are invalid

  • SL_STATUS_INVALID_CONFIGURATION (0x0023) - Timer clock-source configuration structure members have invalid configurations.

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

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

sl_si91x_ulp_timer_deinit#

void sl_si91x_ulp_timer_deinit (void )

De-Initializes ULP-Timer clock by disabling the peripheral clock.

• Pre-conditions:

  • sl_si91x_ulp_timer_init

  • sl_si91x_ulp_timer_unregister_timeout_callback

Returns

• none

Note

• Unregisters the callbacks of all timer instances

sl_si91x_ulp_timer_get_version#

sl_ulp_timer_version_t sl_si91x_ulp_timer_get_version (void )

Get the ULP_TIMER version.

This function is used to know the ULP_TIMER version

Returns

• sl_ulp_timer_version_t type version

SL_TIMER_MATCH_VALUE_DEFAULT#

#define SL_TIMER_MATCH_VALUE_DEFAULT

  20000000

default 1-second timer match-value for down-counter timer-type with 20Mhz clock