Ultra Low-Power Timer#

ulp_timer_instance_t#

ulp_timer_instance_t

Enumeration to represent ULP timer instances.

This enumeration defines the possible instances of the Ultra Low-Power (ULP) timer.

ulp_timer_mode_t#

ulp_timer_mode_t

Enumeration to represent ULP timer modes.

This enumeration defines the possible modes for the Ultra Low-Power (ULP) timer.

ulp_timer_type_t#

ulp_timer_type_t

Enumeration to represent ULP timer types.

This enumeration defines the possible types for the Ultra Low-Power (ULP) timer.

ulp_timer_clk_input_source_t#

ulp_timer_clk_input_source_t

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

This enumeration defines the possible clock sources that can be selected as the timer clock for the Ultra Low-Power (ULP) timer.

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.

sl_si91x_ulp_timer_init#

sl_status_t sl_si91x_ulp_timer_init (ulp_timer_clk_src_config_t * timer_clk_ptr)

To initialize the ULP-Timer by enabling its clock source.

This API configures the clock frequency, clock type, enables/disables synchronization to ULPSS pclk, and skips/allows waiting for timer clock switching.

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 clock type or timer clock source values are invalid.

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

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

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

sl_si91x_ulp_timer_configure_clock#

sl_status_t sl_si91x_ulp_timer_configure_clock (ulp_timer_clk_src_config_t * timer_clk_ptr)

To configure and enable the ULP-Timer input clock source.

This API configures the clock frequency, clock type, enables/disables synchronization to ULPSS pclk, and determines whether to skip/allow waiting for timer clock switching. This function is invoked within the sl_si91x_ulp_timer_init API.

Note

• • There are two XTAL clock sources: internal and external. To enable the external XTAL clock source, you must configure the UULP_GPIO pins using sl_si91x_ulp_timer_configure_xtal_clock, and it should be called first.

  • To use the SOC clock source, you need to use the sl_si91x_ulp_timer_configure_soc_clock API to configure the ULPSS SOC rather than the clock configuration API.

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 clock type or timer clock source values are invalid.

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

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

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

sl_si91x_ulp_timer_set_configuration#

sl_status_t sl_si91x_ulp_timer_set_configuration (ulp_timer_config_t * timer_config_ptr)

To configure the ULP-Timer parameters.

This API configures the parameters such as timer number, mode, type, match value, and direction. Additionally, it configures the integral and fractional values of clock cycles per microsecond or per 256 microseconds as per the selected timer type.

• Pre-conditions:

  • sl_si91x_ulp_timer_init();

Returns

• sl_status_t Status code indicating the result:

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

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

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

  • 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_INDEX (0x0027) - Timer configuration structure member 'timer_num' has an invalid value.

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

sl_si91x_ulp_timer_start#

sl_status_t sl_si91x_ulp_timer_start (ulp_timer_instance_t timer_num)

To start the ULP-Timer.

This API is used to start the Ultra Low-Power (ULP) timer.

Note

• The timer instance must not be in a running state when calling this API.

• Pre-conditions:

  • sl_si91x_ulp_timer_init

  • sl_si91x_ulp_timer_set_configuration

  • sl_si91x_ulp_timer_register_timeout_callback

Returns

• sl_status_t Status code indicating the result:

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

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

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

sl_si91x_ulp_timer_stop#

sl_status_t sl_si91x_ulp_timer_stop (ulp_timer_instance_t timer_num)

To stop the ULP-Timer instance.

This API stops the Ultra Low-Power (ULP) timer instance but does not disable it. To disable the timer, use sl_si91x_ulp_timer_deinit.

• Pre-conditions:

  • sl_si91x_ulp_timer_init

  • sl_si91x_ulp_timer_set_configuration

  • sl_si91x_ulp_timer_start

Returns

• sl_status_t Status code indicating the result:

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

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

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

sl_si91x_ulp_timer_restart#

sl_status_t sl_si91x_ulp_timer_restart (ulp_timer_instance_t timer_num)

To restart the ULP-Timer.

This API restarts the Ultra Low-Power (ULP) timer instance. If the timer is running, it stops the timer first and then starts it again. If the timer is stopped, it simply starts the timer.

• Pre-conditions:

  • sl_si91x_ulp_timer_init

  • sl_si91x_ulp_timer_set_configuration

  • sl_si91x_ulp_timer_start

Returns

• sl_status_t Status code indicating the result:

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

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

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

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)

To set the ULP-Timer type.

This API sets the ULP-Timer type, which includes 256 µs, 1 µs, and count-down types.

• 1 microsecond type: The time unit is 1 µs.

• 256 microsecond type: The time unit is 256 µs.

• Count-down timer type: The time unit is one clock cycle period.

Note

• This API should be used when the timer is stopped.

• Pre-conditions:

  • sl_si91x_ulp_timer_init

  • sl_si91x_ulp_timer_stop

Returns

• sl_status_t Status code indicating the result:

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

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

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

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

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)

To set the ULP-Timer direction.

This API sets the Ultra Low-Power (ULP) timer direction as either up-counting or down-counting. By default, it operates as a down-counter.

Note

• The API should be used when the timer is stopped.

• Pre-conditions:

  • sl_si91x_ulp_timer_init

  • sl_si91x_ulp_timer_stop

Returns

• sl_status_t Status code indicating the result:

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

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

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

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

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)

To set the ULP-Timer mode as one-shot or periodic.

In a one-shot operation, the timer counts down to the timeout and then generates a single interrupt after which it returns to the idle state. In contrast, in periodic operation, the timer continuously generates interrupts at intervals equal to the timeout period.

Note

• This API should be used before starting the timer.

• Pre-conditions:

  • sl_si91x_ulp_timer_init

  • sl_si91x_ulp_timer_stop

Returns

• sl_status_t Status code indicating the result:

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

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

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

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

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)

To set the ULP-Timer match value.

When the timer reaches the match value and if the interrupt is enabled, it will generate an interrupt to the processor.

• For one microsecond type, match value = number of microseconds.

• For 256 microsecond type, match value = (time in microseconds) / 256.

• For normal up/down counter type, timer = (number of clock cycles per microsecond * time in microseconds).

Note

• The API should be used when the timer is stopped.

• Pre-conditions:

  • sl_si91x_ulp_timer_init

  • sl_si91x_ulp_timer_stop

  • sl_si91x_ulp_timer_set_type

  • sl_si91x_ulp_timer_set_direction

Returns

• sl_status_t Status code indicating the result:

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

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

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

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)

To get the ULP-Timer current count.

If the counter is set to down-counting, the counter register bits indicate the time remaining until the timeout, initially read as 32'hFFFF_FFFF. If the counter is set to up-counting, these bits directly show the up-running counter/timer value. The timer current-count value is updated to the count-value variable provided by the user as the second argument.

• Pre-conditions:

  • sl_si91x_ulp_timer_init

  • sl_si91x_ulp_timer_start

  • sl_si91x_ulp_timer_set_count

Returns

• sl_status_t Status code indicating the result:

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

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

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

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

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)

To get the ULP-Timer type.

This API updates the timer type value to the timer_type variable, passed as reference by the user.

• '0' for down-counter type

• '1' for 1us type

• '2' for 256us type

• Pre-conditions:

  • sl_si91x_ulp_timer_init

  • sl_si91x_ulp_timer_set_type

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully read the timer's current type.

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

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

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

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)

To get the ULP-Timer mode.

Updates the timer mode value to the timer_mode variable, passed as reference by the user.

• '0' for one-shot mode

• '1' for periodic mode

• Pre-conditions:

  • sl_si91x_ulp_timer_configure_clock

  • sl_si91x_ulp_timer_set_mode

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully read the timer's current mode.

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

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

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

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)

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

Updates the timer direction to the timer_direction variable, passed as reference by the user.

• '0' for down-counting

• '1' for up-counting

• Pre-conditions:

  • sl_si91x_ulp_timer_init

  • sl_si91x_ulp_timer_set_direction

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Successfully read the timer's current direction.

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

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

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

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)

To register the callback for the timer timeout interrupt and enable the interrupt.

This API registers the callback function for the timer timeout interrupt and enables the interrupt for the specified timer instance. If a callback is already registered, the user must first unregister the existing callback before registering a new one. Otherwise, it will return a SL_STATUS_BUSY error.

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, unregister the previous callback before registering a new one.

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

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

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

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

sl_si91x_ulp_timer_unregister_timeout_callback#

sl_status_t sl_si91x_ulp_timer_unregister_timeout_callback (ulp_timer_instance_t timer_num)

To unregister the callback for the timer interrupt and disable its interrupts.

This API is used to unregister the existing callback interrupt for the specified timer instance.

• Pre-conditions:

  • sl_si91x_ulp_timer_register_timeout_callback

Returns

• sl_status_t Status code indicating the result:

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

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

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

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

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)

To configure and enable the SOC clock source for the timer.

This API is used to select the ULPSS processor clock source as the timer input clock source, which is greater than 100MHz (used for high-power mode). If div_factor_type value is 1, the div_factor should be an odd number; otherwise, it will throw an error. The div_factor_type selects the type of divider for m4_soc_clk_2ulpss:

• '0' Even Divider is selected

• '1' Odd Divider is selected Use this API in place of the timer init API.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success.

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

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

sl_si91x_ulp_timer_configure_xtal_clock#

sl_status_t sl_si91x_ulp_timer_configure_xtal_clock (uint8_t xtal_pin)

To configure the XTAL clock when the clock source is an external XTAL clock.

This API enables the external XTAL clock source. It needs to be called before calling the sl_si91x_ulp_timer_configure_clock API.

Returns

• sl_status_t Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success.

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

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

sl_si91x_ulp_timer_deinit#

void sl_si91x_ulp_timer_deinit (void )

To de-initialize the ULP-Timer clock by disabling the peripheral clock.

This API disables the peripheral clock for the ULP-Timer and unregisters the callback for all timer instances.

• Pre-conditions:

  • sl_si91x_ulp_timer_init

  • sl_si91x_ulp_timer_unregister_timeout_callback

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 )

To get the ULP-Timer API version.

This API is used to retrieve the version information of the ULP-Timer API.

Returns

• sl_ulp_timer_version_t The version of the ULP-Timer API.

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

SL_ULP_TIMER_CLK_TYPE_STATIC#

#define SL_ULP_TIMER_CLK_TYPE_STATIC

1

Static clock type for the ULP timer.

SL_ULP_TIMER_CLK_TYPE_DYNAMIC#

#define SL_ULP_TIMER_CLK_TYPE_DYNAMIC

0

Dynamic clock type for the ULP timer.