Radio Control Layer (RCL)
RCL_Event.h File Reference
#include <stdint.h>
+ Include dependency graph for RCL_Event.h:
+ This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Data Structures

union  RCL_Events
 
struct  RCL_Events_u.__unnamed__
 

Macros

#define RCL_EventNone   ((RCL_Events){ .value = (0U << 0U)})
 
#define RCL_EventCmdStarted   ((RCL_Events){ .value = (1U << 0U)})
 
#define RCL_EventLastCmdDone   ((RCL_Events){ .value = (1U << 1U)})
 
#define RCL_EventRxEntryAvail   ((RCL_Events){ .value = (1U << 2U)})
 
#define RCL_EventRxBufferFinished   ((RCL_Events){ .value = (1U << 3U)})
 
#define RCL_EventTxBufferFinished   ((RCL_Events){ .value = (1U << 4U)})
 
#define RCL_EventSoftwareTriggered   ((RCL_Events){ .value = (1U << 5U)})
 
#define RCL_EventTimerStart   ((RCL_Events){ .value = (1U << 6U)})
 
#define RCL_EventDescheduleStop   ((RCL_Events){ .value = (1U << 7U)})
 
#define RCL_EventGracefulStop   ((RCL_Events){ .value = (1U << 8U)})
 
#define RCL_EventHardStop   ((RCL_Events){ .value = (1U << 9U)})
 
#define RCL_EventStopDelayed   ((RCL_Events){ .value = (1U << 10U)})
 
#define RCL_EventStopRejected   ((RCL_Events){ .value = (1U << 11U)})
 
#define RCL_EventStartDelayed   ((RCL_Events){ .value = (1U << 12U)})
 
#define RCL_EventStartRejected   ((RCL_Events){ .value = (1U << 13U)})
 
#define RCL_EventSetup   ((RCL_Events){ .value = (1U << 14U)})
 
#define RCL_EventPartialSetup   ((RCL_Events){ .value = (1U << 15U)})
 
#define RCL_EventRxBufferUpdate   ((RCL_Events){ .value = (1U << 16U)})
 
#define RCL_EventTxBufferUpdate   ((RCL_Events){ .value = (1U << 17U)})
 
#define RCL_EventHandlerCmdUpdate   ((RCL_Events){ .value = (1U << 18U)})
 
#define RCL_EventCmdStepDone   ((RCL_Events){ .value = (1U << 19U)})
 
#define RCL_EventStopTimesUpdated   ((RCL_Events){ .value = (1U << 20U)})
 
#define RCL_EventPacketTimeout   ((RCL_Events){ .value = (1U << 21U)})
 
#define RCL_EventSilentlyRestartRadio   ((RCL_Events){ .value = (1U << 22U)})
 
#define RCL_EventCmdUpdateDone   ((RCL_Events){ .value = (1U << 23U)})
 
#define RCL_EventCoexNoTx   ((RCL_Events){ .value = (1U << 24U)})
 
#define RCL_EventCmdScheduleDone   ((RCL_Events){ .value = (1U << 25U)})
 
#define RCL_EventCmdStopDone   ((RCL_Events){ .value = (1U << 26U)})
 

Data Structure Documentation

§ RCL_Events_u

union RCL_Events_u
Data Fields
struct RCL_Events_u __unnamed__
uint32_t value

§ RCL_Events_u.__unnamed__

struct RCL_Events_u.__unnamed__
Data Fields
uint32_t cmdStarted: 1

Command handler has accepted and started executing

uint32_t lastCmdDone: 1

The RCL is finished with the command

uint32_t rxEntryAvail: 1

An RX entry has been made available

uint32_t rxBufferFinished: 1

An RX multi-buffer is finished

uint32_t txBufferFinished: 1

A TX buffer is finished

uint32_t swTriggered: 1

Handler is triggered from software

uint32_t timerStart: 1

Timer-based start signalled

uint32_t descheduleStop: 1

Deschedule-type stop signalled

uint32_t gracefulStop: 1

Timer/api-based graceful-stop signalled

uint32_t hardStop: 1

Timer/api-based hard-stop signalled

uint32_t stopDelayed: 1

Command was not stopped

uint32_t stopRejected: 1

Command was not stopped

uint32_t startDelayed: 1

Command start is delayed, may still happen within allowDelay

uint32_t startRejected: 1

Command start is not possible within scheduling parameters

uint32_t setup: 1

Setup has been performed

uint32_t partialSetup: 1

Partial setup has been performed or is required by the running command

uint32_t rxBufferUpdate: 1

RX buffer has been updated

uint32_t txBufferUpdate: 1

TX buffer has been updated

uint32_t handlerCmdUpdate: 1

A property of a running command has been updated, to be detailed by handler

uint32_t cmdStepDone: 1

A step of the command has been done; details are command specific

uint32_t stopTimesUpdated: 1

A change was made to the stop times

uint32_t packetTimeout: 1

A manually set packet-specific timeout has expired

uint32_t silentlyRestartRadio: 1

Restart radio to perform updates, to be detailed by handler

uint32_t cmdUpdateDone: 1

An update of the running command is finished

uint32_t coexNoTx: 1

A transmission was refused or aborted by coexistence procedure; command continues

uint32_t cmdScheduleDone: 1

Queued command has been scheduled

uint32_t cmdStopDone: 1

Scheduled command has been stopped

Macro Definition Documentation

§ RCL_EventNone

§ RCL_EventCmdStarted

#define RCL_EventCmdStarted   ((RCL_Events){ .value = (1U << 0U)})

Command handler has accepted and started executing

§ RCL_EventLastCmdDone

#define RCL_EventLastCmdDone   ((RCL_Events){ .value = (1U << 1U)})

The RCL is finished with the command

Referenced by __attribute__(), and rclCheckNextCommandPendCallback().

§ RCL_EventRxEntryAvail

#define RCL_EventRxEntryAvail   ((RCL_Events){ .value = (1U << 2U)})

An RX entry has been made available

§ RCL_EventRxBufferFinished

#define RCL_EventRxBufferFinished   ((RCL_Events){ .value = (1U << 3U)})

An RX multi-buffer is finished

§ RCL_EventTxBufferFinished

#define RCL_EventTxBufferFinished   ((RCL_Events){ .value = (1U << 4U)})

A TX buffer is finished

§ RCL_EventSoftwareTriggered

#define RCL_EventSoftwareTriggered   ((RCL_Events){ .value = (1U << 5U)})

Handler is triggered from software

Referenced by RCL_Scheduler_postEvent().

§ RCL_EventTimerStart

#define RCL_EventTimerStart   ((RCL_Events){ .value = (1U << 6U)})

Timer-based start signalled

§ RCL_EventDescheduleStop

#define RCL_EventDescheduleStop   ((RCL_Events){ .value = (1U << 7U)})

Deschedule-type stop signalled

Referenced by rclCheckNextCommandPendCallback().

§ RCL_EventGracefulStop

#define RCL_EventGracefulStop   ((RCL_Events){ .value = (1U << 8U)})

Timer-based graceful-stop signalled

Referenced by __attribute__().

§ RCL_EventHardStop

#define RCL_EventHardStop   ((RCL_Events){ .value = (1U << 9U)})

Timer-based hard-stop signalled

Referenced by __attribute__().

§ RCL_EventStopDelayed

#define RCL_EventStopDelayed   ((RCL_Events){ .value = (1U << 10U)})

Command was not stopped

§ RCL_EventStopRejected

#define RCL_EventStopRejected   ((RCL_Events){ .value = (1U << 11U)})

Command was not stopped

§ RCL_EventStartDelayed

#define RCL_EventStartDelayed   ((RCL_Events){ .value = (1U << 12U)})

Command start is delayed, may still happen within allowDelay

§ RCL_EventStartRejected

#define RCL_EventStartRejected   ((RCL_Events){ .value = (1U << 13U)})

Command start is not possible within scheduling parameters

§ RCL_EventSetup

#define RCL_EventSetup   ((RCL_Events){ .value = (1U << 14U)})

Setup has been performed

Referenced by RCL_Lite_Command_start(), and rclSchedulerHwi().

§ RCL_EventPartialSetup

#define RCL_EventPartialSetup   ((RCL_Events){ .value = (1U << 15U)})

Partial setup has been performed or is required by the running command

§ RCL_EventRxBufferUpdate

#define RCL_EventRxBufferUpdate   ((RCL_Events){ .value = (1U << 16U)})

RX buffer has been updated

Referenced by RCL_MultiBuffer_put().

§ RCL_EventTxBufferUpdate

#define RCL_EventTxBufferUpdate   ((RCL_Events){ .value = (1U << 17U)})

TX buffer has been updated

Referenced by RCL_Handler_Ieee_txAckUpdate(), and RCL_TxBuffer_put().

§ RCL_EventHandlerCmdUpdate

#define RCL_EventHandlerCmdUpdate   ((RCL_Events){ .value = (1U << 18U)})

§ RCL_EventCmdStepDone

#define RCL_EventCmdStepDone   ((RCL_Events){ .value = (1U << 19U)})

A step of the command has been done; details are command specific

§ RCL_EventStopTimesUpdated

#define RCL_EventStopTimesUpdated   ((RCL_Events){ .value = (1U << 20U)})

A change was made to the stop times

Referenced by rclSchedulerCancelStopTime(), and rclSchedulerSetNewStopTime().

§ RCL_EventPacketTimeout

#define RCL_EventPacketTimeout   ((RCL_Events){ .value = (1U << 21U)})

A manually set packet-specific timeout has expired

§ RCL_EventSilentlyRestartRadio

#define RCL_EventSilentlyRestartRadio   ((RCL_Events){ .value = (1U << 22U)})

Restart radio to perform updates, to be detailed by handler

Referenced by LRF_temperatureNotification().

§ RCL_EventCmdUpdateDone

#define RCL_EventCmdUpdateDone   ((RCL_Events){ .value = (1U << 23U)})

An update of the running command is finished

§ RCL_EventCoexNoTx

#define RCL_EventCoexNoTx   ((RCL_Events){ .value = (1U << 24U)})

A transmission was refused or aborted by coexistence procedure; command continues

§ RCL_EventCmdScheduleDone

#define RCL_EventCmdScheduleDone   ((RCL_Events){ .value = (1U << 25U)})

Queued command has been scheduled

Referenced by rclSchedulerHwi().

§ RCL_EventCmdStopDone

#define RCL_EventCmdStopDone   ((RCL_Events){ .value = (1U << 26U)})

Queued command has been scheduled