System RTC#

sl_sysrtc_group_number_t#

sl_sysrtc_group_number_t

Enumeration to represent SYSRTC group numbers.

sl_sysrtc_channel_number_t#

sl_sysrtc_channel_number_t

Enumeration to represent SYSRTC channel numbers.

sl_clock_sources_t#

typedef rsi_sysrtc_clk_inp_t sl_clock_sources_t

sl_sysrtc_config_t#

typedef rsi_sysrtc_config_t sl_sysrtc_config_t

sl_sysrtc_group_config_t#

typedef rsi_sysrtc_group_config_t sl_sysrtc_group_config_t

sl_sysrtc_group_compare_channel_action_config_t#

typedef rsi_sysrtc_group_channel_compare_config_t sl_sysrtc_group_compare_channel_action_config_t

sl_sysrtc_group_capture_channel_input_edge_config_t#

typedef rsi_sysrtc_group_channel_capture_config_t sl_sysrtc_group_capture_channel_input_edge_config_t

sl_sysrtc_callback_t#

typedef void(* sl_sysrtc_callback_t) (void *callback_flag) )(void *callback_flag)

Typedef for the function pointer of the interrupt callback function.

sl_si91x_sysrtc_init#

sl_status_t sl_si91x_sysrtc_init (const sl_sysrtc_config_t *config_ptr)

Initializes SYSRTC and enables the peripheral.

Also configures that SYSRTC should run during debug halt, as per user input.

• Pre-condition:

  • sl_si91x_sysrtc_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_OK (0x0000) - Success, SYSRTC initialized properly.

sl_si91x_sysrtc_configure_clock#

sl_status_t sl_si91x_sysrtc_configure_clock (sl_sysrtc_clock_config_t *clk_ptr)

Configures the SYSRTC input clock source frequency.

It configures clock source as 32khz RC, 32khz RO or 1Khz RO clock source as per user input. For using 1KHz clock source, pass division factor value as '16' else pass '0'.

Returns

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

  • SL_STATUS_INVALID_PARAMETER (0x0021) - Clock source parameter has an invalid value.

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

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

sl_si91x_sysrtc_configure_group#

sl_status_t sl_si91x_sysrtc_configure_group (sl_sysrtc_group_number_t group_number, sl_sysrtc_group_config_t const *config_ptr)

To configure the SYSRTC groups of compare and capture channels.

Configures group number and enables its compare & capture channels. Also configures match out actions for respective compare channel and input events for capture

• Pre-conditions:

  • sl_si91x_sysrtc_configure_clock

  • sl_si91x_sysrtc_init

Returns

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

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

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

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

sl_si91x_sysrtc_register_callback#

sl_status_t sl_si91x_sysrtc_register_callback (sl_sysrtc_callback_t on_sysrtc_callback, void *callback_flag_value, sl_sysrtc_group_number_t group_number, sl_sysrtc_interrupt_enables_t *interrupt_enable_ptr)

To register the callback of the timer interrupt.

Also enables the respective interrupts as per selected interrupt flags.

• Pre-conditions:

  • sl_si91x_sysrtc_init

  • sl_si91x_sysrtc_configure_clock

  • sl_si91x_sysrtc_configure_group(), keep respective interrupt channel enable

  • sl_si91x_sysrtc_unregister_timeout_callback(), if already registered for any interrupt

Returns

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

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

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

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

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

sl_si91x_sysrtc_unregister_callback#

sl_status_t sl_si91x_sysrtc_unregister_callback (sl_sysrtc_group_number_t group_number, sl_sysrtc_interrupt_enables_t *interrupt_enabled_handle)

Unregisters timer interrupt callback and disables interrupts as per selected interrupt flag.

• Pre-conditions:

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

Returns

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

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

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

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

sl_si91x_sysrtc_set_compare_value#

sl_status_t sl_si91x_sysrtc_set_compare_value (sl_sysrtc_group_number_t group_number, sl_sysrtc_channel_number_t channel, uint32_t compare_value)

Sets SYSRTC compare value for the selected channel of the given group.

• Pre-conditions:

  • First enable the compare channel of the respective group through sl_si91x_sysrtc_configure_group.

Returns

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

  • SL_STATUS_INVALID_PARAMETER (0x0021) - group_number or channel parameter has an invalid value.

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

sl_si91x_sysrtc_get_compare_value#

sl_status_t sl_si91x_sysrtc_get_compare_value (sl_sysrtc_group_number_t group_number, sl_sysrtc_channel_number_t channel, uint32_t *compare_value)

Gets SYSRTC current compare register value for selected channel of selected group.

Returns

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

  • SL_STATUS_INVALID_PARAMETER (0x0021) - group_number or channel parameter has an invalid value.

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

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

sl_si91x_sysrtc_sets_register_capture_input#

sl_status_t sl_si91x_sysrtc_sets_register_capture_input (sl_sysrtc_group_number_t group_number)

Sets register-input for the capture channel of the selected group of SYSRTC.

In other words, configures the SYSRTC Input (Capture) from register.

• Pre-conditions:

  • First, enable and configure the capture channel of the respective group through sl_si91x_sysrtc_configure_group.

  • Disable GPIO input through sl_si91x_sysrtc_enable_input_output_gpio, by passing false.

Returns

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

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

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

sl_si91x_sysrtc_set_gpio_as_capture_input#

sl_status_t sl_si91x_sysrtc_set_gpio_as_capture_input (sl_sysrtc_group_number_t group_number)

Configures input pins for the SYSRTC capture channel of selected group.

Configures gpio-0 and gpio-1 as input pins for the capture channel of group0 & group-1 respectively. Sets pins mode, mux and direction.

• Pre-conditions:

  • First, enable and configure the capture channel of the respective group through sl_si91x_sysrtc_configure_group.

  • Enable GPIO IO through sl_si91x_sysrtc_enable_input_output_gpio, by passing true.

Returns

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

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

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

sl_si91x_sysrtc_set_compare_output_gpio#

sl_status_t sl_si91x_sysrtc_set_compare_output_gpio (sl_sysrtc_group_number_t group_number, sl_sysrtc_channel_number_t channel)

Configures the output pins of the selected compare channel of given group.

Configures gpio-3 and gpio-4 as output pins for compare channel 0 & 1 of group0 respectively. Configures gpio-1 and gpio-2 as output pins for compare channel 0 & 1 of group1 respectively.. Sets pins mode, mux and direction. Also enables pins input buffer.

• Pre-conditions:

  • First, enable and configure the output action of the compare channel of the respective group through

  • sl_si91x_sysrtc_configure_group.

Returns

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

  • SL_STATUS_INVALID_PARAMETER (0x0021) - group_number or channel parameter has an invalid value.

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

sl_si91x_sysrtc_get_count#

sl_status_t sl_si91x_sysrtc_get_count (uint32_t *count_value)

Gets the SYSRTC current counter register value.

Updates the current count of the timer to count_value input parameter. Returns

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

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

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

sl_si91x_sysrtc_get_capture_value#

sl_status_t sl_si91x_sysrtc_get_capture_value (sl_sysrtc_group_number_t group_number, uint32_t *capture_value)

Gets the SYSRTC capture register value of a given group.

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

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

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

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

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

sl_si91x_sysrtc_get_compare_output#

sl_status_t sl_si91x_sysrtc_get_compare_output (sl_sysrtc_group_number_t group_number, sl_sysrtc_channel_number_t channel, uint32_t *compare_output_bit)

Reads the SYSRTC compare channel output bit value of a given group.

Updates the bit value to compare_output_bit input parameter.

Returns

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

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

  • SL_STATUS_INVALID_PARAMETER (0x0021) - group_number or channel parameter has an invalid value.

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

sl_si91x_sysrtc_is_running#

sl_status_t sl_si91x_sysrtc_is_running (boolean_t *running_status)

Gets the SYSRTC running status, status is true if running, false if stopped.

Updates 'true' if SYSRTC is running else 'false' if not running, to the running_status input parameter.

Returns

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

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

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

sl_si91x_sysrtc_is_locked#

sl_status_t sl_si91x_sysrtc_is_locked (boolean_t *lock_status)

Gets the SYSRTC lock status.

Updates 'true' if SYSRTC is locked, 'false' if unlocked, to the lock_status input parameter.

Returns

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

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

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

sl_si91x_sysrtc_enable_input_output_gpio#

void sl_si91x_sysrtc_enable_input_output_gpio (bool is_gpio_enabled)

Sets the SYSRTC input output mode for the capture and compare channels.

If passed true, then input to capture channel and output of compare channel will be through GPIO, else disabled.

Returns

• none

sl_si91x_sysrtc_start#

__STATIC_INLINE void sl_si91x_sysrtc_start (void)

Starts the SYSRTC counter.

This function will send a start command to the SYSRTC peripheral. It waits till the start command to be executed.

• Pre-conditions:

  • sl_si91x_sysrtc_init

  • sl_si91x_sysrtc_configure_clock(), keep software trigger disable here

  • sl_si91x_sysrtc_configure_group(), keep respective interrupt channel enable

  • sl_si91x_sysrtc_register_callback, keep respective interrupt enabled

  • sl_si91x_sysrtc_set_count

Returns

• none

Note

• This function will send a start command to the SYSRTC peripheral.

• The SYSRTC peripheral will use some LF clock ticks before the command is executed.

• The rsi_sysrtc_wait_sync() function is used to wait for the start command to be executed.

sl_si91x_sysrtc_stop#

__STATIC_INLINE void sl_si91x_sysrtc_stop (void)

Stops the SYSRTC counter.

This function will send a stop command to the SYSRTC peripheral. It waits till the stop command to be executed.

Returns

• none

Note

• This function requires the SYSRTC to be enabled.

sl_si91x_sysrtc_reset#

__STATIC_INLINE void sl_si91x_sysrtc_reset (void)

Restores the SYSRTC to its reset state.

Returns

• none

sl_si91x_sysrtc_lock#

__STATIC_INLINE void sl_si91x_sysrtc_lock (void)

Locks the SYSRTC registers.

When SYSRTC registers are locked SYSRTC_EN, SYSRTC_CFG, SYSRTC_CMD, SYSRTC_SWRST, SYSRTC_CNT and SYSRTC_TOPCNT registers cannot be written to. Returns

• none

sl_si91x_sysrtc_unlock#

__STATIC_INLINE void sl_si91x_sysrtc_unlock (void)

Unlocks the SYSRTC registers.

When SYSRTC registers are locked SYSRTC_EN, SYSRTC_CFG, SYSRTC_CMD, SYSRTC_SWRST, SYSRTC_CNT and SYSRTC_TOPCNT registers cannot be written to.

• Pre-condition:

  • sl_si91x_sysrtc_lock

Returns

• none

sl_si91x_sysrtc_set_count#

__STATIC_INLINE void sl_si91x_sysrtc_set_count (uint32_t value)

Sets the SYSRTC counter register value of counter This can be used to change the count of SYSRTC, when it is stopped.

After calling this API user should start SYSRTC.

• Pre-condition:

  • sl_si91x_sysrtc_stop

Returns

• none

sl_si91x_sysrtc_get_version#

sl_sysrtc_version_t sl_si91x_sysrtc_get_version (void)

Gets the SYSRTC version It returns API version of SYSRTC.

Returns

• (sl_sysrtc_version_t) type structure.

sl_si91x_sysrtc_deinit#

void sl_si91x_sysrtc_deinit (void)

De-initializes the SYSRTC by disabling its clock.

Returns

• none

Note

• Unregisters the SYSRTC callback and disables all interrupts.