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 = (0 << 0)})
 
#define RCL_EventCmdStarted   ((RCL_Events){ .value = (1 << 0)})
 
#define RCL_EventLastCmdDone   ((RCL_Events){ .value = (1 << 1)})
 
#define RCL_EventRxEntryAvail   ((RCL_Events){ .value = (1 << 2)})
 
#define RCL_EventRxBufferFinished   ((RCL_Events){ .value = (1 << 3)})
 
#define RCL_EventTxBufferFinished   ((RCL_Events){ .value = (1 << 4)})
 
#define RCL_EventSoftwareTriggered   ((RCL_Events){ .value = (1 << 5)})
 
#define RCL_EventTimerStart   ((RCL_Events){ .value = (1 << 6)})
 
#define RCL_EventDescheduleStop   ((RCL_Events){ .value = (1 << 7)})
 
#define RCL_EventGracefulStop   ((RCL_Events){ .value = (1 << 8)})
 
#define RCL_EventHardStop   ((RCL_Events){ .value = (1 << 9)})
 
#define RCL_EventStopDelayed   ((RCL_Events){ .value = (1 << 10)})
 
#define RCL_EventStopRejected   ((RCL_Events){ .value = (1 << 11)})
 
#define RCL_EventStartDelayed   ((RCL_Events){ .value = (1 << 12)})
 
#define RCL_EventStartRejected   ((RCL_Events){ .value = (1 << 13)})
 
#define RCL_EventSetup   ((RCL_Events){ .value = (1 << 14)})
 
#define RCL_EventPartialSetup   ((RCL_Events){ .value = (1 << 15)})
 
#define RCL_EventRxBufferUpdate   ((RCL_Events){ .value = (1 << 16)})
 
#define RCL_EventTxBufferUpdate   ((RCL_Events){ .value = (1 << 17)})
 
#define RCL_EventHandlerCmdUpdate   ((RCL_Events){ .value = (1 << 18)})
 
#define RCL_EventCmdStepDone   ((RCL_Events){ .value = (1 << 19)})
 
#define RCL_EventStopTimesUpdated   ((RCL_Events){ .value = (1 << 20)})
 

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

Macro Definition Documentation

§ RCL_EventNone

§ RCL_EventCmdStarted

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

Command handler has accepted and started executing

§ RCL_EventLastCmdDone

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

The RCL is finished with the command

Referenced by RCL_AdcNoise_get_samples_callback().

§ RCL_EventRxEntryAvail

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

An RX entry has been made available

§ RCL_EventRxBufferFinished

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

An RX multi-buffer is finished

§ RCL_EventTxBufferFinished

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

A TX buffer is finished

§ RCL_EventSoftwareTriggered

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

Handler is triggered from software

Referenced by RCL_Scheduler_postEvent().

§ RCL_EventTimerStart

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

Timer-based start signalled

§ RCL_EventDescheduleStop

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

Deschedule-type stop signalled

§ RCL_EventGracefulStop

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

Timer-based graceful-stop signalled

Referenced by rclStop().

§ RCL_EventHardStop

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

Timer-based hard-stop signalled

Referenced by rclStop().

§ RCL_EventStopDelayed

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

Command was not stopped

§ RCL_EventStopRejected

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

Command was not stopped

§ RCL_EventStartDelayed

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

Command start is delayed, may still happen within allowDelay

§ RCL_EventStartRejected

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

Command start is not possible within scheduling parameters

§ RCL_EventSetup

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

Setup has been performed

Referenced by RCL_Lite_Command_start(), and rclSchedulerHwi().

§ RCL_EventPartialSetup

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

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

§ RCL_EventRxBufferUpdate

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

RX buffer has been updated

Referenced by RCL_MultiBuffer_put().

§ RCL_EventTxBufferUpdate

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

TX buffer has been updated

Referenced by RCL_TxBuffer_put().

§ RCL_EventHandlerCmdUpdate

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

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

Referenced by RCL_BLE5_updateFilterList(), RCL_IEEE_Tx_stop(), RCL_IEEE_Tx_submit(), and rclCommandHwi().

§ RCL_EventCmdStepDone

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

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

§ RCL_EventStopTimesUpdated

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

A change was made to the stop times

Referenced by rclSchedulerCancelStopTime(), and rclSchedulerSetNewStopTime().