Multiprotocol
Multiprotocol scheduler APIs to support multiple time-sliced PHYs.
Modules | |
| EFR32 | |
| EFR32-specific multiprotocol support defines. | |
Data Structures | |
| struct | RAIL_SchedulerInfo_t |
| A structure to hold information used by the scheduler. | |
Macros | |
| #define | RAIL_SCHEDULER_STATUS_MASK 0x0FU |
| Radio Scheduler Status mask. | |
| #define | RAIL_SCHEDULER_STATUS_SHIFT 0 |
| Radio Scheduler Status shift. | |
| #define | RAIL_SCHEDULER_TASK_MASK 0xF0U |
| Radio Scheduler Task mask. | |
| #define | RAIL_SCHEDULER_TASK_SHIFT 4 |
| Radio Scheduler Task shift. | |
Functions | |
| void | RAIL_YieldRadio (RAIL_Handle_t railHandle) |
| Yield the radio to other configurations. | |
| RAIL_SchedulerStatus_t | RAIL_GetSchedulerStatus (RAIL_Handle_t railHandle) |
| Get the status of the RAIL scheduler. | |
| 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. | |
| 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. | |
| RAIL_Time_t | RAIL_GetTransitionTime (void) |
| Get time needed to switch between protocols. | |
| void | RAIL_SetTransitionTime (RAIL_Time_t transitionTime) |
| Set time needed to switch between protocols. | |
Detailed Description
Multiprotocol scheduler APIs to support multiple time-sliced PHYs.
Enumeration Type Documentation
◆ 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.
| Enumerator | |
|---|---|
| RAIL_SCHEDULER_STATUS_NO_ERROR | Lower 4 bits of uint8_t capture the different Radio Scheduler errors. Multiprotocol scheduler reports no error. |
| RAIL_SCHEDULER_STATUS_UNSUPPORTED | The scheduler is disabled or the requested scheduler operation is unsupported. |
| RAIL_SCHEDULER_STATUS_EVENT_INTERRUPTED | The scheduled task was started but was interrupted by a higher-priority event before it could be completed. |
| RAIL_SCHEDULER_STATUS_SCHEDULE_FAIL | Scheduled task could not be scheduled given its priority and the other tasks running on the system. |
| RAIL_SCHEDULER_STATUS_TASK_FAIL | Calling the RAIL API associated with the Radio scheduler task returned an error code. See RAIL_GetSchedulerStatus or RAIL_GetSchedulerStatusAlt for more information about RAIL_Status_t status. |
| RAIL_SCHEDULER_STATUS_INTERNAL_ERROR | An internal error occurred in scheduler data structures, which should not happen and indicates a problem. |
| RAIL_SCHEDULER_TASK_EMPTY | Upper 4 bits of uint8_t capture the different Radio Scheduler tasks. |
| RAIL_SCHEDULER_TASK_SCHEDULED_RX | Radio scheduler calls RAIL_ScheduleRx(). |
| RAIL_SCHEDULER_TASK_SCHEDULED_TX | Radio scheduler calls RAIL_StartScheduledTx(). |
| RAIL_SCHEDULER_TASK_SINGLE_TX | Radio scheduler calls RAIL_StartTx(). |
| RAIL_SCHEDULER_TASK_SINGLE_CCA_CSMA_TX | Radio scheduler calls RAIL_StartCcaCsmaTx(). |
| RAIL_SCHEDULER_TASK_SINGLE_CCA_LBT_TX | Radio scheduler calls RAIL_StartCcaLbtTx(). |
| RAIL_SCHEDULER_TASK_SCHEDULED_CCA_CSMA_TX | Radio scheduler calls RAIL_StartScheduledCcaCsmaTx(). |
| RAIL_SCHEDULER_TASK_SCHEDULED_CCA_LBT_TX | Radio scheduler calls RAIL_StartScheduledCcaLbtTx(). |
| RAIL_SCHEDULER_TASK_TX_STREAM | Radio scheduler calls RAIL_StartTxStream(). |
| RAIL_SCHEDULER_TASK_AVERAGE_RSSI | Radio scheduler calls RAIL_StartAverageRssi(). |
| RAIL_SCHEDULER_STATUS_SCHEDULED_TX_FAIL | RAIL_StartScheduledTx() returned error status. |
| RAIL_SCHEDULER_STATUS_SINGLE_TX_FAIL | RAIL_StartTx() returned error status. |
| RAIL_SCHEDULER_STATUS_CCA_CSMA_TX_FAIL | RAIL_StartCcaCsmaTx() returned error status. |
| RAIL_SCHEDULER_STATUS_CCA_LBT_TX_FAIL | RAIL_StartCcaLbtTx() returned error status. |
| RAIL_SCHEDULER_STATUS_SCHEDULED_RX_FAIL | RAIL_ScheduleRx() returned error status. |
| RAIL_SCHEDULER_STATUS_TX_STREAM_FAIL | RAIL_StartTxStream() returned error status. |
| RAIL_SCHEDULER_STATUS_AVERAGE_RSSI_FAIL | RAIL_StartAverageRssi() returned error status. |
| RAIL_SCHEDULER_SCHEDULED_RX_INTERNAL_ERROR | Multiprotocol scheduled receive function internal error. |
| RAIL_SCHEDULER_SCHEDULED_RX_SCHEDULING_ERROR | Multiprotocol scheduled receive scheduling error. |
| RAIL_SCHEDULER_SCHEDULED_RX_INTERRUPTED | RAIL_ScheduleRx() operation interrupted |
| RAIL_SCHEDULER_SCHEDULED_TX_INTERNAL_ERROR | Multiprotocol scheduled Tx internal error. |
| RAIL_SCHEDULER_SCHEDULED_TX_SCHEDULING_ERROR | Multiprotocol scheduled Tx scheduling error. |
| RAIL_SCHEDULER_SCHEDULED_TX_INTERRUPTED | RAIL_StartScheduledTx() operation interrupted |
| RAIL_SCHEDULER_SINGLE_TX_INTERNAL_ERROR | Multiprotocol instantaneous Tx internal error. |
| RAIL_SCHEDULER_SINGLE_TX_SCHEDULING_ERROR | Multiprotocol instantaneous Tx scheduling error. |
| RAIL_SCHEDULER_SINGLE_TX_INTERRUPTED | RAIL_StartTx() operation interrupted |
| RAIL_SCHEDULER_SINGLE_CCA_CSMA_TX_INTERNAL_ERROR | Multiprotocol single CSMA transmit function internal error. |
| RAIL_SCHEDULER_SINGLE_CCA_CSMA_TX_SCHEDULING_ERROR | Multiprotocol single CSMA transmit scheduling error. |
| RAIL_SCHEDULER_SINGLE_CCA_CSMA_TX_INTERRUPTED | RAIL_StartCcaCsmaTx() operation interrupted |
| RAIL_SCHEDULER_SINGLE_CCA_LBT_TX_INTERNAL_ERROR | Multiprotocol single LBT transmit function internal error. |
| RAIL_SCHEDULER_SINGLE_CCA_LBT_TX_SCHEDULING_ERROR | Multiprotocol single LBT transmit scheduling error. |
| RAIL_SCHEDULER_SINGLE_CCA_LBT_TX_INTERRUPTED | RAIL_StartCcaLbtTx() operation interrupted |
| RAIL_SCHEDULER_SCHEDULED_CCA_CSMA_TX_INTERNAL_ERROR | Multiprotocol scheduled CSMA transmit function internal error. |
| RAIL_SCHEDULER_SCHEDULED_CCA_CSMA_TX_FAIL | RAIL_StartScheduledCcaCsmaTx() returned error status. |
| RAIL_SCHEDULER_SCHEDULED_CCA_CSMA_TX_SCHEDULING_ERROR | Multiprotocol scheduled CSMA transmit scheduling error. |
| RAIL_SCHEDULER_SCHEDULED_CCA_CSMA_TX_INTERRUPTED | RAIL_StartScheduledCcaCsmaTx() operation interrupted |
| RAIL_SCHEDULER_SCHEDULED_CCA_LBT_TX_INTERNAL_ERROR | Multiprotocol scheduled LBT transmit function internal error. |
| RAIL_SCHEDULER_SCHEDULED_CCA_LBT_TX_FAIL | RAIL_StartScheduledCcaLbtTx() returned error status. |
| RAIL_SCHEDULER_SCHEDULED_CCA_LBT_TX_SCHEDULING_ERROR | Multiprotocol scheduled LBT transmit scheduling error. |
| RAIL_SCHEDULER_SCHEDULED_CCA_LBT_TX_INTERRUPTED | RAIL_StartScheduledCcaLbtTx() operation interrupted |
| RAIL_SCHEDULER_TX_STREAM_INTERNAL_ERROR | Multiprotocol stream transmit function internal error. |
| RAIL_SCHEDULER_TX_STREAM_SCHEDULING_ERROR | Multiprotocol stream transmit scheduling error. |
| RAIL_SCHEDULER_TX_STREAM_INTERRUPTED | RAIL_StartTxStream() operation interrupted |
| RAIL_SCHEDULER_AVERAGE_RSSI_INTERNAL_ERROR | Multiprotocol RSSI averaging function internal error. |
| RAIL_SCHEDULER_AVERAGE_RSSI_SCHEDULING_ERROR | Multiprotocol RSSI average scheduling error. |
| RAIL_SCHEDULER_AVERAGE_RSSI_INTERRUPTED | RAIL_StartAverageRssi() operation interrupted |
Definition at line 459 of file rail_types.h.
◆ RAIL_TaskType_t
| enum RAIL_TaskType_t |
Function Documentation
◆ RAIL_GetSchedulerStatus()
| RAIL_SchedulerStatus_t RAIL_GetSchedulerStatus | ( | RAIL_Handle_t | railHandle | ) |
Get the status of the RAIL scheduler.
- Parameters
-
[in] railHandleA RAIL instance handle.
- Returns
- RAIL_SchedulerStatus_t status.
This function can only be called from a callback context after the RAIL_EVENT_SCHEDULER_STATUS event occurs.
◆ 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.
- Parameters
-
[in] railHandleA RAIL instance handle. [out] pSchedulerStatusAn application-provided pointer to store RAIL_SchedulerStatus_t status. Can be NULL as long as RAIL_Status_t pointer is not NULL. [out] pRailStatusAn application-provided pointer to store RAIL_Status_t of the RAIL API invoked by the RAIL scheduler. Can be NULL as long as RAIL_SchedulerStatus_t pointer is not NULL.
- Returns
- RAIL_Status_t indicating success of the function call.
This function can only be called from a callback context after the RAIL_EVENT_SCHEDULER_STATUS event occurs.
◆ RAIL_GetTransitionTime()
| RAIL_Time_t RAIL_GetTransitionTime | ( | void | | ) |
Get time needed to switch between protocols.
- Returns
- RAIL_Time_t Time needed to switch between protocols.
◆ 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.
- Parameters
-
[in] railHandleA RAIL instance handle. [in] priorityDesired new priority for the railHandle's active task [in] taskTypeType of task whose priority should be updated
- Returns
- RAIL_Status_t 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.
◆ RAIL_SetTransitionTime()
| void RAIL_SetTransitionTime | ( | RAIL_Time_t | transitionTime | ) |
Set 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.
- Parameters
-
[in] transitionTimeTime needed to switch between protocols.
◆ RAIL_YieldRadio()
| void RAIL_YieldRadio | ( | RAIL_Handle_t | railHandle | ) |
Yield the radio to other configurations.
- Parameters
-
[in] railHandleA RAIL instance handle.
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.