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)

Configures and enables the ULP-Timer input clock source.

By default, configures the 'reference clock source' (32 MHZ) as the timer clock source, clock-type as 'static', disables synchronization to ULPSS pclk and skips waiting for switching of timer clock. It is called inside sl_si91x_ulp_timer_init API. Note

• : There are two XTAL Clk sources one is Internal and external XTAL clk source. In order to enable the external XTAL clk source need to configure the NPSS_GPIO pins which can be done through sl_si91x_ulp_timer_configure_xtal_clock(uint8_t xtal_pin) API i.e user need to call that API first. In order to enable the soc CLK source need to configure the Ulpss soc Clk from M4 soc clk please refer sl_si91x_ulp_timer_configure_soc_clock(boolean_t div_factor_type, uint16_t div_factor )

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_init#

sl_status_t sl_si91x_ulp_timer_init (ulp_timer_clk_src_config_t * timer_clk_ptr)

Initializes the ULP-Timer module by configuring and enabling the clock source.

Initializes the ULP-Timer clock by configuring the clock source.

By default, configures the 'reference clock source' (32 MHZ) as the timer clock source, clock-type as 'static', disables synchronization to ULPSS pclk and skips waiting for switching of timer clock.

Returns

• status 0 if successful, else error code. 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 has invalid configurations. SL_STATUS_NULL_POINTER (0x0022) - The parameter is null pointer SL_STATUS_OK (0x0000) - Success, timer clock-source parameters configured properly

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)

Configures the ULP-Timer parameters such as timer number, mode, type, match-value, and direction.

Also configures the 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)

Starts the ULP-Timer.

Sets the start bit of timer control register, which is a self clearing bit. Should be called after clock & timer configurations and timeout-callback registrations. Timer instance must not be in running state when calling this API.

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

Stops the running ULP-Timer instance.

Sets the stop bit of timer control register, which is a self clearing bit. This will only stops the timer but not disables & unregisters its interrupts.

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

Restarts an already running ULP-Timer, which means it will first stop the timer instance and then starts it again .

This will only restarts the count of an already running counter.

• 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 as 256 µs type, 1µs type or Count-down timer type.

• 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. This API should be used when timer is stopped

• 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, by default, it works as down-counter This API should be used when timer is stopped.

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

Sets the ULP-Timer Mode as one-shot or periodic.

In one shot operation, the timer counts till the timeout and then generates a single interrupt after which it returns to idle state. Where as in periodic operation the timer when reaches the timeout value generates an interrupt and starts counting again from the originally set value. This API should be used when timer is stopped

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

Sets the ULP-Timer match value.

When the timer reaches the timeout value & if the interrupt is enabled the timeout condition 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 microseconds * time in microseconds) This API should be used when timer is stopped.

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

Reads the ULP-Timer current count.

If counter-down is set register bits indicate time remaining before timeout (read as 32'hFFFF_FFFF initially). If counter-up is set these bits directly gives out the up-running counter/timer value. Updates the timer current-count value to the count-value variable, passed as reference by user (2nd argument)

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

Reads the ULP-Timer type.

Updates the timer type value to the timer_type variable, passed as reference by user (2nd argument) as below : 0 for down-counter type 1 for 1us type 2 for 256us 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 type

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)

Reads the ULP-Timer mode.

Updates the timer mode value to the timer_mode variable, passed as reference by user (2nd argument) as below : 0 for one-shot mode 1 for periodic 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 mode

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

Updates the timer direction to the timer_direction variable, passed as reference by user (2nd argument) as below : 0 for down-counting 1 for up-counting

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

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)

Registers the callback for the timer timeout interrupt and enables the interrupt, as per instance.

If any callback is already registered, the user needs to unregister the callback first before registering the callback else it will return call SL_STATUS_BUSY error.

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)

Unregisters the callback for the timer timeout interrupt and disabling its interrupts as per timer instance.

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

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

This API is used to select the ULPSS processor clock source when input is soc clock source which is greater than 100MHz(used for high-power mode) To divide the clock, ensure that it should be odd number if div_factor_type is 1 & viceversa 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 timer clock config API, when using soc clock source with timer in high power mode

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)

Configures the XTAL clock, when clock source is external XTAL clock.

To enable the external XTAL clk source need to call this API before calling sl_si91x_ulp_timer_configure_clock API.

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_deinit#

void sl_si91x_ulp_timer_deinit (void )

De-Initializes the 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 )

Gets the ULP-timer version.

It returns the API version of ULP-timer.

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