Multiprotocol Transition Time#

APIs related to Multi-Protocol Transition Time Utility component.

Modules#

sl_rail_util_mp_transition_time_entry_t

Functions#

sl_status_t
sl_rail_util_mp_transition_time_get(const sl_rail_util_mp_transition_time_entry_t *p_table, const size_t table_size, sl_rail_time_t *p_transition_time)

Retrieves the transition time for the current system clock frequency.

void
sl_rail_util_mp_transition_time_init(void)

Initializes the multi-protocol transition time utility.

Function Documentation#

sl_rail_util_mp_transition_time_get#

sl_status_t sl_rail_util_mp_transition_time_get (const sl_rail_util_mp_transition_time_entry_t * p_table, const size_t table_size, sl_rail_time_t * p_transition_time)

Retrieves the transition time for the current system clock frequency.

Parameters
TypeDirectionArgument NameDescription
const sl_rail_util_mp_transition_time_entry_t *[in]p_table

A non-NULL pointer to the transition time table.

const size_t[in]table_size

Number of entries in the transition time table.

sl_rail_time_t *[out]p_transition_time

A non-NULL pointer to store the resulting transition time (in microseconds).

Searches the provided transition time table for the entry corresponding to the current system clock frequency. The table must be sorted in descending order of frequency to ensure correct lookups. If the table is not sorted, the lookup process may yield incorrect results.

The transition time table is autogenerated during project generation. For more details, refer to the sl_rail_util_mp_transition_time.md file.

Returns

  • SL_STATUS_OK if a matching entry is found and the transition time is retrieved.

  • SL_STATUS_INVALID_PARAMETER if the input parameters are invalid.

  • SL_STATUS_NOT_FOUND if no matching entry is found for the current system clock frequency.


sl_rail_util_mp_transition_time_init#

void sl_rail_util_mp_transition_time_init (void )

Initializes the multi-protocol transition time utility.

Parameters
TypeDirectionArgument NameDescription
voidN/A

Determines the appropriate transition time for the current system clock frequency and configures the RAIL library with the calculated transition time. It uses the transition time table defined in the configuration.

The transition time table is autogenerated during project generation. For more details, refer to the sl_rail_util_mp_transition_time.md file.

If the transition time cannot be determined, the function does not configure the RAIL library.