Config Timer#

sl_config_timer_mode_t#

sl_config_timer_mode_t

Enumeration to represent timer modes.

sl_counter_number_t#

sl_counter_number_t

Enumeration to represent timer counter numbers.

sl_counter0_direction_t#

sl_counter0_direction_t

Enumeration to represent timer counter 0 directions.

sl_counter1_direction_t#

sl_counter1_direction_t

Enumeration to represent timer counter 1 directions.

sl_config_timer_config_values_t#

sl_config_timer_config_values_t

Enumeration to represent timer configuration parameter values.

sl_config_timer_ocu_config_values_t#

sl_config_timer_ocu_config_values_t

Enumeration to represent timer OCU configuration parameter values.

sl_config_timer_event_t#

sl_config_timer_event_t

Enumeration to represent various timer input events.

sl_config_timer_action_t#

sl_config_timer_action_t

Enumeration to represent various timer actions.

sl_config_timer_interrupt_flags_values_t#

sl_config_timer_interrupt_flags_values_t

Enumeration to represent various timer interrupt flag values.

sl_config_timer_ocu_params_t#

typedef OCU_PARAMS_T sl_config_timer_ocu_params_t

Renaming OCU (Output Compare Unit) parameters structure type.

sl_config_timer_wfg_config_t#

typedef WFG_PARAMS_T sl_config_timer_wfg_config_t

Renaming WFG (Waveform Generator) parameters structure type.

sl_config_timer_pwm_callback_t#

typedef RSI_CT_CALLBACK_T sl_config_timer_pwm_callback_t

Renaming MCPWM callback structure.

sl_config_timer_callback_t#

typedef void(* sl_config_timer_callback_t) (void *callback_flag) )(void *callback_flag)

Typedef for the function pointer of the interrupt callback function.

sl_si91x_config_timer_init#

void sl_si91x_config_timer_init (void )

To initialize the config-timer peripheral.

Configures its output GPIO pins and clock to 16 MHz.

sl_si91x_config_timer_set_mode#

sl_status_t sl_si91x_config_timer_set_mode (sl_config_timer_mode_t mode)

To set the config-timer mode as 32-bit or 16-bit counters.

In 32-bit mode, Counter_1 and Counter_0 are merged and used as a single 32-bit counter. In this mode, Counter_0 modes/triggers/enables are used.

• Pre-conditions:

  • sl_si91x_config_timer_init();

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, timer mode is set properly.

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

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

sl_si91x_config_timer_set_configuration#

sl_status_t sl_si91x_config_timer_set_configuration (sl_config_timer_config_t * timer_config_ptr)

To configure Config-timer parameters.

This API sets the Config-timer parameters such as 32-bit or 16-bit mode, periodic mode, counter trigger enable, soft reset enable, buffer enable, sync trigger enable, and sets direction for counter0 and counter1. Counter trigger enable starts the counter. Sync trigger enables the counter to run/activate when sync is found. Buffer enable copies buffer data to the Counter Match register. Soft reset is valid only when the counter is in two 16-bit counters mode, and resets the counter on the write.

• Pre-conditions:

  • sl_si91x_config_timer_init();

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, timer configurations are set properly.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Counter direction parameter has an invalid value.

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

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

sl_si91x_config_timer_reset_configuration#

void sl_si91x_config_timer_reset_configuration (void )

To reset config-timer parameters and set default values.

This API sets the config-timer to 16-bit mode, up-counter direction, and disables periodic mode, soft reset, buffer, sync, and software trigger of counters.

sl_si91x_config_timer_set_ocu_configuration#

sl_status_t sl_si91x_config_timer_set_ocu_configuration (sl_config_timer_ocu_config_t * ocu_config_ptr)

To set Config-timer OCU (Output Compare Unit) configurations.

This API enables outputs in OCU mode, OCU-DMA mode, channel sync with OCU outputs, and 8-bit mode for OCU outputs for both counters.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • sl_si91x_config_timer_set_configuration();

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, OCU configurations are set properly.

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

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

sl_si91x_config_timer_reset_ocu_configuration#

void sl_si91x_config_timer_reset_ocu_configuration (void )

To reset config-timer OCU (Output Compare Unit) parameters.

This API sets the config-timer to 16-bit mode, sets the up-counter direction, and disables DMA mode, channel sync, and 8-bit mode for OCU outputs.

sl_si91x_config_timer_set_ocu_control#

sl_status_t sl_si91x_config_timer_set_ocu_control (sl_config_timer_ocu_control_t * ocu_params)

To set Config-timer OCU mode control parameters.

This API sets Config-timer OCU mode control parameters such as first and next threshold values for counter outputs. It also enables the DMA support for counters.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • sl_si91x_config_timer_set_ocu_configuration();

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, OCU mode control parameters are set properly.

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

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

sl_si91x_config_timer_set_wfg_configuration#

sl_status_t sl_si91x_config_timer_set_wfg_configuration (sl_config_timer_wfg_config_t * wfg_config_ptr)

To set Config-timer WFG (Waveform Generator) mode configurations.

This API configures the Config-timer WFG mode settings such as selecting toggle high, low, and peak for counter-0 and counter-1 outputs.

• Pre-conditions:

  • sl_si91x_config_timer_init();

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, WFG mode configurations are set properly.

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

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

sl_si91x_config_timer_set_initial_count#

sl_status_t sl_si91x_config_timer_set_initial_count (sl_config_timer_mode_t mode, uint32_t counter0_initial_value, uint32_t counter1_initial_value)

To set the Config-timer initial count based on the timer mode.

Configurable timer modes are mentioned below:

• For 32-bit mode, counter0_initial_value is passed to the CT count register. For 32-bit mode, pass counter1_initial_value as zero.

• For 16-bit mode counters, the ORed value of both initial values is passed to the register.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • sl_si91x_config_timer_set_configuration();

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, initial count is set properly.

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

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

sl_si91x_config_timer_set_match_count#

sl_status_t sl_si91x_config_timer_set_match_count (sl_config_timer_mode_t mode, sl_counter_number_t counter_number, uint32_t match_value)

To set the Config-timer match-count based on the timer mode and counter number.

If the mode is 32-bit, use counter0. If the mode is 16-bit, as per the passed counter number, it updates the match value. For 16-bit mode, it takes a 16-bit match-value only, else throws an error.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • sl_si91x_config_timer_set_configuration();

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, match-value is set properly.

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

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

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

sl_si91x_config_timer_get_match_value#

sl_status_t sl_si91x_config_timer_get_match_value (uint32_t time_period_in_us, uint32_t * match_value)

To calculate and return the match value of the timer for the desired time period.

This API calculates the match value based on the provided time period in microseconds.

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success.

  • SL_STATUS_INVALID_COUNT (0x002B) - Count is invalid.

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

sl_si91x_config_timer_get_count#

sl_status_t sl_si91x_config_timer_get_count (sl_config_timer_mode_t mode, sl_counter_number_t counter_number, uint32_t * count_value)

To get the Config-timer current count.

This API retrieves the Config-timer current count based on the timer mode and counter number, and updates the count value to the count_value variable input parameter.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • sl_si91x_config_timer_set_configuration();

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, count value is read properly.

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

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

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

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

sl_si91x_config_timer_reset_counter#

sl_status_t sl_si91x_config_timer_reset_counter (sl_counter_number_t counter_number)

To reset the Config-timer counter register value.

This API resets the count values of the selected counter.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • sl_si91x_config_timer_set_configuration();

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, counter resets properly.

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

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

sl_si91x_config_timer_start_on_software_trigger#

sl_status_t sl_si91x_config_timer_start_on_software_trigger (sl_counter_number_t counter_number)

To start the selected config-timer counter on a software trigger.

Note

• This API triggers the 'counter_number' counter.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • sl_si91x_config_timer_set_configuration(), keep software trigger disabled here

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, timer started properly.

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

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

sl_si91x_config_timer_select_action_event#

sl_status_t sl_si91x_config_timer_select_action_event (sl_config_timer_action_t action, sl_config_timer_event_t select_event_counter0, sl_config_timer_event_t select_event_counter1)

To select config timer input events for triggering selected timer actions.

This API selects config timer input events for triggering selected timer actions. Different timer actions include start, stop, continue, halt, increment, capture, interrupt, and output.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • sl_si91x_config_timer_set_configuration(), keep software trigger disabled here

  • sl_si91x_config_timer_register_callback(), keep event interrupt flag enabled for respective counter

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, input event is set properly.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Selected input event or action parameter value is invalid.

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

sl_si91x_config_timer_configure_action_event#

sl_status_t sl_si91x_config_timer_configure_action_event (sl_config_action_event_t * event_config_handle)

To configure the config timer action events.

This API configures the config timer input-event's AND-event and OR-event for triggering selected timer actions. Different timer actions include start, stop, continue, halt, increment, capture, interrupt, and output.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • sl_si91x_config_timer_set_configuration(), keep software trigger disabled here

  • sl_si91x_config_timer_register_callback(), keep event interrupt flag enabled for respective counter

  • sl_si91x_config_timer_select_action_event(), first selects the input event for respective action for respective counter

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, AND event & OR event set properly.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - and-event or or-event or event-valid-bits value is invalid.

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

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

sl_si91x_config_timer_register_callback#

sl_status_t sl_si91x_config_timer_register_callback (sl_config_timer_callback_t on_config_timer_callback, void * callback_flag, sl_config_timer_interrupt_flags_t * interrupt_flags)

To register a callback for config timer interrupts.

This API registers a callback function for config timer interrupts by enabling the respective interrupts as per the selected interrupt flag.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • sl_si91x_config_timer_set_configuration(), keep software trigger disabled here

  • sl_si91x_config_timer_unregister_timeout_callback(), if already registered for any interrupt

Returns

• Status code indicating the result:

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

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

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

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

sl_si91x_config_timer_unregister_callback#

sl_status_t sl_si91x_config_timer_unregister_callback (sl_config_timer_interrupt_flags_t * interrupt_flags)

To unregister the timer interrupt callback.

This API disables interrupts as per the selected interrupt flag and unregisters the previously registered timer interrupt callback.

• Pre-conditions:

  • sl_si91x_config_timer_register_callback(), first register a particular interrupt flag.

Returns

• Status code indicating the result:

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

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

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

sl_si91x_config_timer_read_capture#

sl_status_t sl_si91x_config_timer_read_capture (sl_counter_number_t counter_number, uint16_t * capture_value)

To get the Config-timer count value when a capture event occurs.

This API updates the capture count value of the timer to the capture_value variable input parameter.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • sl_si91x_config_timer_set_configuration();

  • sl_si91x_config_timer_select_action_event(), first select events for capture action

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, capture count value is read properly.

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

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

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

sl_si91x_config_timer_set_counter_sync#

sl_status_t sl_si91x_config_timer_set_counter_sync (sl_counter_number_t counter_number, uint8_t sync_counter_value)

To synchronize counter output with other channels.

This API synchronizes the counter output with other channels as per the sync_counter_value.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • sl_si91x_config_timer_set_configuration();

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, counter output synced properly.

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

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

sl_si91x_config_timer_set_output_adc_pin#

sl_status_t sl_si91x_config_timer_set_output_adc_pin (uint8_t pin1, uint8_t pin2)

To configure config timer output events for ADC trigger.

Configures events for counter0 and counter1 outputs to trigger ADC.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • sl_si91x_config_timer_set_configuration();

Returns

• Status code indicating the result:

  • SL_STATUS_OK (0x0000) - Success, ADC trigger events set properly.

  • SL_STATUS_INVALID_PARAMETER (0x0021) - 'pin1' or 'pin2' parameter value is invalid.

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

sl_si91x_config_timer_deinit#

void sl_si91x_config_timer_deinit (void )

To de-initialize the config-timer by disabling its clock.

This API de-initializes the config-timer by disabling its clock. It also unregisters the callback and disables all config timer interrupts.

Note

• Ensure that no timer operations are pending before calling this API.

sl_si91x_config_timer_get_version#

sl_config_timer_version_t sl_si91x_config_timer_get_version (void )

To get the config timer API version.

This API retrieves the version information of the config timer API.

Returns

• Version structure ( sl_config_timer_version_t) containing the version details.

CT#

#define CT

CT0

pointer to CT base address