Multiprotocol#

RAIL_SchedulerStatus_t#

RAIL_SchedulerStatus_t

Multiprotocol scheduler status returned by RAIL_GetSchedulerStatus().

Multiprotocol scheduler status is a combination of the upper 4 bits which constitute the type of scheduler task and the lower 4 bits which constitute the type of scheduler error.

DeprecatedRAIL 2.x synonym of sl_rail_scheduler_status_t.

RAIL_TaskType_t#

RAIL_TaskType_t

Multiprotocol radio operation task types, used with RAIL_SetTaskPriority().

DeprecatedRAIL 2.x synonym of sl_rail_task_type_t.

sl_rail_scheduler_status_t#

sl_rail_scheduler_status_t

Multiprotocol scheduler status returned by sl_rail_get_scheduler_status().

Multiprotocol scheduler status is a combination of the upper 4 bits which constitute the type of scheduler task and the lower 4 bits which constitute the type of scheduler error.

sl_rail_task_type_t#

sl_rail_task_type_t

Multiprotocol radio operation task types, used with sl_rail_set_task_priority().

RAIL_YieldRadio#

RAIL_Status_t RAIL_YieldRadio (RAIL_Handle_t railHandle)

Yield the radio to other configurations.

Returns

• Status code indicating success of the function call.

This function is used to indicate that the previous transmit or scheduled receive operation has completed. It must be used in multiprotocol RAIL because the scheduler assumes that any transmit or receive operation that is started can go on indefinitely based on state transitions and your protocol. RAIL will not allow a lower priority tasks to run until this is called so it can negatively impact performance of those protocols if this is omitted or delayed. It is also possible to call the RAIL_Idle() API to both terminate the operation and idle the radio. In single protocol RAIL this API does nothing, however, if RAIL Power Manager is initialized, calling RAIL_YieldRadio() after scheduled TX/RX and instantaneous TX completion, is required, to indicate to the Power Manager that the the radio is no longer busy and can be idled for sleeping.

See Yielding the Radio for more details.

DeprecatedRAIL 2.x synonym of sl_rail_yield_radio().

RAIL_GetSchedulerStatus#

RAIL_SchedulerStatus_t RAIL_GetSchedulerStatus (RAIL_Handle_t railHandle)

Get the status of the RAIL scheduler.

Returns

• RAIL_SchedulerStatus_t status.

This function can only be called from a callback context after the RAIL_EVENT_SCHEDULER_STATUS event occurs.

DeprecatedThis RAIL 2.x function has been replaced in RAIL 3 by sl_rail_get_scheduler_status() with additional parameters and a broader set of sl_rail_scheduler_status_t values that can be reported.

RAIL_GetSchedulerStatusAlt#

RAIL_Status_t RAIL_GetSchedulerStatusAlt (RAIL_Handle_t railHandle, RAIL_SchedulerStatus_t * pSchedulerStatus, RAIL_Status_t * pRailStatus)

Get the status of the RAIL scheduler, specific to the radio operation, along with RAIL_Status_t returned by RAIL API invoked by the RAIL scheduler.

Returns

• Status code indicating success of the function call.

This function can only be called from a callback context after the RAIL_EVENT_SCHEDULER_STATUS event occurs.

DeprecatedRAIL 2.x synonym of sl_rail_get_scheduler_status().

RAIL_SetTaskPriority#

RAIL_Status_t RAIL_SetTaskPriority (RAIL_Handle_t railHandle, uint8_t priority, RAIL_TaskType_t taskType)

Change the priority of a specified task type in multiprotocol.

Returns

• Status code indicating success of the function call.

While the application can use this function however it likes, a major use case is being able to increase an infinite receive priority while receiving a packet. In other words, a given RAIL_Handle_t can maintain a very low priority background receive, but upon getting a RAIL_EVENT_RX_SYNC1_DETECT_SHIFT or RAIL_EVENT_RX_SYNC2_DETECT_SHIFT event, the app can call this function to increase the background RX priority to lower the risk another protocol might preempt during packet reception.

DeprecatedRAIL 2.x synonym of sl_rail_set_task_priority().

RAIL_GetTransitionTime#

RAIL_Time_t RAIL_GetTransitionTime (void )

Get the time needed to switch between protocols.

Returns

• RAIL_Time_t Approximate time, in microseconds, needed to switch between protocols.

Note

• The transition time determines how early the scheduler starts processing a protocol switch relative to a scheduled event. This value is approximate and actual transition time may vary slightly due to system overhead.

DeprecatedThis RAIL 2.x function has been replaced in RAIL 3 by sl_rail_get_transition_time() with its additional sl_rail_handle_t parameter.

RAIL_SetTransitionTime#

void RAIL_SetTransitionTime (RAIL_Time_t transitionTime)

Set the time needed to switch between protocols.

Call this API only once, before any protocol is initialized via RAIL_Init(). Changing this value during normal operation can result in improper scheduling behavior.

Note

• The transition time determines how early the scheduler starts processing a protocol switch relative to a scheduled event. This value is approximate and does not account for all system overhead. Setting this value too low may cause scheduling issues or missed events.

DeprecatedThis RAIL 2.x function has been replaced in RAIL 3 by sl_rail_set_transition_time() with its additional sl_rail_handle_t parameter.

sl_rail_yield_radio#

sl_rail_status_t sl_rail_yield_radio (sl_rail_handle_t rail_handle)

Yield the radio to other configurations.

Returns

• Status code indicating success of the function call.

This function is used to indicate that the previous transmit or scheduled receive operation has completed. It must be used in multiprotocol RAIL because the scheduler assumes that any transmit or receive operation that is started can go on indefinitely based on state transitions and your protocol. RAIL will not allow a lower priority tasks to run until this is called so it can negatively impact performance of those protocols if this is omitted or delayed. It is also possible to call the sl_rail_idle() API to both terminate the operation and idle the radio. In single protocol RAIL this API does nothing, however, if RAIL Power Manager is initialized, calling sl_rail_yield_radio() after scheduled TX/RX and instantaneous TX completion, is required, to indicate to the Power Manager that the the radio is no longer busy and can be idled for sleeping.

See Yielding the Radio for more details.

sl_rail_get_scheduler_status#

sl_rail_status_t sl_rail_get_scheduler_status (sl_rail_handle_t rail_handle, sl_rail_scheduler_status_t * p_scheduler_status, sl_rail_status_t * p_rail_status)

Get the status of the RAIL scheduler, specific to the radio operation, along with sl_rail_status_t returned by RAIL API invoked by the RAIL scheduler.

Returns

• Status code indicating success of the function call.

This function can only be called from a callback context after the SL_RAIL_EVENT_SCHEDULER_STATUS event occurs.

sl_rail_set_task_priority#

sl_rail_status_t sl_rail_set_task_priority (sl_rail_handle_t rail_handle, uint8_t priority, sl_rail_task_type_t task_type)

Change the priority of a specified task type in multiprotocol.

Returns

• Status code indicating success of the function call.

While the application can use this function however it likes, a major use case is being able to increase an infinite receive priority while receiving a packet. In other words, a given sl_rail_handle_t can maintain a very low priority background receive, but upon getting a SL_RAIL_EVENT_RX_SYNC_0_DETECT_SHIFT or SL_RAIL_EVENT_RX_SYNC_1_DETECT_SHIFT event, the app can call this function to increase the background RX priority to lower the risk another protocol might preempt during packet reception.

sl_rail_get_transition_time#

sl_rail_time_t sl_rail_get_transition_time (sl_rail_handle_t radio_handle)

Get the time needed to switch between protocols.

Returns

• sl_rail_time_t Time, in microseconds, needed to switch between protocols.

Note

• This API provides an accurate transition time by accounting for system overhead. The transition time determines how early the scheduler starts processing a protocol switch relative to a scheduled event.

sl_rail_set_transition_time#

sl_rail_status_t sl_rail_set_transition_time (sl_rail_handle_t radio_handle, sl_rail_time_t transition_time_us)

Set the time needed to switch between protocols.

Call this API only once, before any protocol is initialized via sl_rail_init(). Changing this value during normal operation can result in improper scheduling behavior.

Returns

• Status code indicating success of the function call.

Note

• This API provides an accurate transition time by accounting for system overhead. The transition time determines how early the scheduler starts processing a protocol switch relative to a scheduled event. Setting this value too low may cause scheduling issues or missed events.