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

sl_counter1_direction_t#

sl_counter1_direction_t

sl_config_timer_config_values_t#

sl_config_timer_config_values_t

Enumeration to represent timer-config parameters values.

sl_config_timer_ocu_config_values_t#

sl_config_timer_ocu_config_values_t

Enumeration to represent timer OCU-config parameters 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 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 )

This API will initialize config-timer peripheral.

Configures its output GPIO pins and clock as 16 MHz.

Returns

• none

sl_si91x_config_timer_set_mode#

sl_status_t sl_si91x_config_timer_set_mode (sl_config_timer_mode_t mode)

This API will set Config-timer mode as 32-bit or 16-bit counters.

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

• Pre-conditions:

  • sl_si91x_config_timer_init();

Returns

• status 0 if successful, else error-code as follow

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

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

sl_si91x_config_timer_set_configuration#

sl_status_t sl_si91x_config_timer_set_configuration (sl_config_timer_config_t * timer_config_ptr)

This API will configures Config-timer parameters.

This API will set 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 is enabled to start the counter. Sync trigger enables the counter to run/active when sync is found. Buffer enable will copy buffer data to Counter Match register. Soft reset valid only when the counter is in two 16 bit counters mode, this resets the counter on the write.

• Pre-condition:

  • sl_si91x_config_timer_init();

Returns

• status 0 if successful, else error-code as follow

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

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

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

sl_si91x_config_timer_reset_configuration#

void sl_si91x_config_timer_reset_configuration (void )

This API will reset config-timer parameters and sets default parameter values.

This sets 16-bit mode, up-counter direction Disables periodic mode, soft reset, buffer, sync and software trigger of counters.

Returns

• none

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)

This API will set Config-timer OCU (Output Compare Unit) configurations.

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

• Pre-condition:

  • sl_si91x_config_timer_init();

  • sl_si91x_config_timer_set_configuration();

Returns

• status 0 if successful, else error-code as follow

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

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

sl_si91x_config_timer_reset_ocu_configuration#

void sl_si91x_config_timer_reset_ocu_configuration (void )

This API will reset config-timer OCU (Output Compare Unit) parameters.

this will set 16-bit mode, sets up-counter direction also disables DMA mode, channel sync and 8-bit mode for OCU outputs.

Returns

• none

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)

This API will set Config-timer OCU mode control params.

This Config-timer OCU mode control params Sets 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 0 if successful, else error-code as follow

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

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

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)

This API will set the Config-timer WFG mode configurations.

This API will configures the Config-timer WFG mode configurations Such as select toggle high, low and peak for counter-0 & counter-1 outputs.

• Pre-condition:

  • sl_si91x_config_timer_init();

Returns

• status 0 if successful, else error-code as follow SL_STATUS_NULL_POINTER (0x0022) - The parameter is null pointer. SL_STATUS_OK (0x0000) - Success, WFG mode configurations are set properly.

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)

This API will set Config-timer initial count as per timer mode.

Configurable timer mode are mentioned below:

• For 32-bit mode, counter0_initial_value is passes to CT count register. For 32-bit mode pass counter1 initial-value as zero.

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

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • sl_si91x_config_timer_set_configuration();

Returns

• status 0 if successful, else error-code as follow SL_STATUS_INVALID_MODE (0x0024) - 'mode' parameter value is invalid. SL_STATUS_OK (0x0000) - Success, initial-count is set properly

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)

This API will set the Config-timer match-count as per timer mode and counter-number.

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

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • l_si91x_config_timer_set_configuration();

Returns

• status 0 if successful, else error-code as follow

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

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

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

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)

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

Returns

• status 0 if successful, else error-code as follow

  • SL_STATUS_INVALID_COUNT (0x002B) - Count is invalid.

  • SL_STATUS_OK (0x0000) - Success.

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)

This API will get Config-timer current count.

This API will get Config-timer current count as per timer mode and counter-number and it updates the count value to count_value variable input parameter.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • l_si91x_config_timer_set_configuration();

Returns

• status 0 if successful, else error code SL_STATUS_INVALID_MODE (0x0024) - 'mode' parameter value is invalid.

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

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

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

sl_si91x_config_timer_reset_counter#

sl_status_t sl_si91x_config_timer_reset_counter (sl_counter_number_t counter_number)

This API will reset Config-timer counter register value.

Note

• Resets the Count values of selected counter.

• Pre-conditions:

  • sl_si91x_config_timer_init();

• l_si91x_config_timer_set_configuration();

Returns

• status 0 if successful, else error-code as follow

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

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

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)

This API will start selected config-timer counter.

Note

• This API triggers the 'counter_number' counter.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • l_si91x_config_timer_set_configuration(),keep software trigger disable here

Returns

• status 0 if successful, else error-code as follow

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

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

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)

This API will select config timer input events.

This will select config timer input events for triggering selected timer-actions. Different timer actions are 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 disable here

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

Returns

• status 0 if successful, else error-code as follow

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

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

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)

This API will configure config-timer.

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

• Pre-condition:

  • sl_si91x_config_timer_init();

  • sl_si91x_config_timer_set_configuration(), keep software trigger disable here

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

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

Returns

• status 0 if successful, else error-code as follow SL_STATUS_NULL_POINTER (0x0022) - The parameter is null pointer. SL_STATUS_INVALID_PARAMETER 0x0021) - and-event or or-event or event-valid-bits value is invalid. SL_STATUS_OK (0x0000) - Success, AND event & OR event set properly
  

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_value, sl_config_timer_interrupt_flags_t * interrupt_flags)

This API will register callback of config timer interrupts.

Enabling respective interrupts as per selected interrupt flag.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • sl_si91x_config_timer_set_configuration(), keep software trigger disable here

  • sl_si91x_config_timer_unregister_timeout_callback(), if already registered for any interrupt

Returns

• status 0 if successful, else error-code as follow

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

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

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

sl_si91x_config_timer_unregister_callback#

sl_status_t sl_si91x_config_timer_unregister_callback (sl_config_timer_interrupt_flags_t * interrupt_flags)

This API will unregister timer interrupt callback.

Disables interrupts as per selected interrupt flag.

• Pre-conditions:

  • sl_si91x_config_timer_register_callback(), first register particular interrupt flag

Returns

• status 0 if successful, else error-code as follow SL_STATUS_NULL_POINTER (0x0022) - parameter is a null pointer. SL_STATUS_OK (0x0000) - Successfully unregistered timer interrupt callback.

sl_si91x_config_timer_resume_halt_event#

sl_status_t sl_si91x_config_timer_resume_halt_event (sl_counter_number_t counter_number)

This API will Resume halt operation of Config-timer counter.

Counter will start running from the count where it was halted previously.

• Pre-conditions:

  • sl_si91x_config_timer_init();

• sl_si91x_config_timer_set_configuration();

Returns

• status 0 if successful, else error-code as follow

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

  • SL_STATUS_OK (0x0000) - Success, halt operation resumed properly
    

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)

This API Gets Config-timer count value when capture occurs.

Updates the capture count value of timer to capture_value variable input parameter.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • l_si91x_config_timer_set_configuration();

  • sl_si91x_config_timer_select_action_event(), first select events for capture action

Returns

• status 0 if successful, else error-code as follow

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

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

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

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)

This API will synchronize counter output with other channels, as per sync_counter_value.

• Pre-conditions:

  • sl_si91x_config_timer_init();

  • l_si91x_config_timer_set_configuration();

Returns

• status 0 if successful, else error-code as follow SL_STATUS_INVALID_PARAMETER 0x0021) - 'counter_number' parameter value is invalid. SL_STATUS_OK (0x0000) - Success, counter output synced properly
  

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)

This API is used 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(); l_si91x_config_timer_set_configuration();

Returns

• status 0 if successful, else error-code as follow

  • SL_STATUS_INVALID_PARAMETER 0x0021) - 'pin_1' or 'pin_2' parameter value is invalid.
    

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

sl_si91x_config_timer_set_wfg_compare_values#

sl_status_t sl_si91x_config_timer_set_wfg_compare_values (sl_counter_number_t counter_number, sl_config_timer_ocu_params_t * ocu_params)

sl_si91x_config_timer_deinit#

void sl_si91x_config_timer_deinit (void )

This API de-initialize config-timer by disabling its clock.

Returns

• none

Note

• Unregisters the callback and disables all config timer interrupts.

sl_si91x_config_timer_get_version#

sl_config_timer_version_t sl_si91x_config_timer_get_version (void )

This API will get Config timer API version and it returns the same.

Returns

• (sl_config_version_t) type structure

CT#

#define CT

CT0

pointer to CT base address