Radio Control Layer (RCL)
|
#include <stdint.h>
#include <stdbool.h>
#include <ti/drivers/rcl/RCL_Types.h>
#include <ti/drivers/rcl/RCL_Event.h>
#include <ti/drivers/rcl/LRF.h>
Go to the source code of this file.
Data Structures | |
struct | RCL_CommandRuntime |
Command runtime structure. More... | |
struct | RCL_CommandTiming |
Command timing structure. More... | |
struct | RCL_Command |
General command. More... | |
Typedefs | |
typedef RCL_Events(* | RCL_CommandHandler) (RCL_Command *cmd, LRF_Events lrfEvents, RCL_Events rclEvents) |
Command handler function type. More... | |
typedef void(* | RCL_Callback) (RCL_Command *cmd, LRF_Events lrfEvents, RCL_Events rclEvents) |
Callback function type. More... | |
typedef LRF_TxPowerTable_Index | RCL_Command_TxPower |
Type for TX power. More... | |
Functions | |
static void | RCL_Command_setRawTxPower (uint32_t registerSetting, uint32_t temperatureCoefficient) |
Set raw TX power. More... | |
struct RCL_CommandRuntime_s |
Command runtime structure.
Holds information on running the command
Data Fields | ||
---|---|---|
RCL_CommandHandler | handler |
Command handler to use for this command |
RCL_Client * | client |
Client |
LRF_Events | lrfCallbackMask |
Callbacks enabled for events directly from LRF |
RCL_Events | rclCallbackMask |
Callbacks enabled for events generated in RCL |
RCL_Callback | callback |
Callback function |
struct RCL_CommandTiming_s |
Command timing structure.
Holds information on the timing of the command
struct RCL_Command_s |
General command.
Fields common for all commands
Data Fields | ||
---|---|---|
uint16_t | cmdId |
Command ID |
uint16_t | phyFeatures |
PHY feature selector; use 0 if only one PHY |
RCL_ScheduleType | scheduling: 8 |
Scheduling type |
RCL_CommandStatus | status: 8 |
Status of command |
RCL_ConflictPolicy | conflictPolicy: 8 |
Conflict resolution policy |
bool | allowDelay |
Start may be delayed |
RCL_CommandRuntime | runtime |
Runtime information |
RCL_CommandTiming | timing |
Timing information |
#define RCL_CommandStatus_isAnyStop | ( | x | ) | (((x) >= RCL_CommandStatus_DescheduledApi) && ((x) <= RCL_CommandStatus_HardStopScheduling)) |
Helper macros to compare command status
#define RCL_CommandStatus_isAnyDescheduled | ( | x | ) | (((x) >= RCL_CommandStatus_DescheduledApi) && ((x) <= RCL_CommandStatus_DescheduledScheduling)) |
#define RCL_CommandStatus_isAnyGracefulStop | ( | x | ) | (((x) >= RCL_CommandStatus_GracefulStopTimeout) && ((x) <= RCL_CommandStatus_GracefulStopScheduling)) |
#define RCL_CommandStatus_isAnyHardStop | ( | x | ) | (((x) >= RCL_CommandStatus_HardStopTimeout) && ((x) <= RCL_CommandStatus_HardStopScheduling)) |
#define RCL_CommandStatus_isAnyTimeoutStop | ( | x | ) | (((x) == RCL_CommandStatus_GracefulStopTimeout) || ((x) == RCL_CommandStatus_HardStopTimeout)) |
#define RCL_CommandStatus_isAnyApiStop | ( | x | ) | (((x) == RCL_CommandStatus_DescheduledApi) || ((x) == RCL_CommandStatus_GracefulStopApi) || ((x) == RCL_CommandStatus_HardStopApi)) |
#define RCL_CommandStatus_isAnySchedulingStop | ( | x | ) | (((x) == RCL_CommandStatus_DescheduledScheduling) || ((x) == RCL_CommandStatus_GracefulStopScheduling) || ((x) == RCL_CommandStatus_HardStopScheduling)) |
#define RCL_Command_Default | ( | _id, | |
_handler | |||
) |
#define RCL_Command_DefaultRuntime | ( | _id, | |
_handler | |||
) | (RCL_Command) RCL_Command_Default(_id, _handler) |
typedef RCL_Events(* RCL_CommandHandler) (RCL_Command *cmd, LRF_Events lrfEvents, RCL_Events rclEvents) |
Command handler function type.
typedef void(* RCL_Callback) (RCL_Command *cmd, LRF_Events lrfEvents, RCL_Events rclEvents) |
Callback function type.
Type for TX power.
The wanted TX power to program; the RCL will select the highest available power smaller than or equal to the requested setting.
Special settings: LRF_TxPower_Use_Min: Use minimum available TX power LRF_TxPower_Use_Max: Use maximum available TX power LRF_TxPower_Use_Raw: Use a raw TX power register setting given with RCL_Command_setRawTxPower() LRF_TxPower_None: Do not write TX power
enum RCL_CommandStatus |
Command status.
Gives information on the command, and if finished, how it finished.
enum RCL_StopType |
Stop types.
Type of stop to perform
enum RCL_ScheduleType |
enum RCL_ConflictPolicy |
Conflict resolution policy.
How will this command interact with an already running and overlapping command
|
inlinestatic |
Set raw TX power.
Set the TX power to be written directly into the TX power register applicable to the chip. The setting only applies to commands where the TX power is set to LRF_TxPower_Use_Raw
References LRF_setRawTxPower().