|
Radio Control Layer (RCL)
|
#include <ti/drivers/rcl/RCL_Command.h>#include <ti/drivers/rcl/RCL_Buffer.h>#include <ti/drivers/rcl/handlers/generic.h>#include <ti/drivers/utils/List.h>#include <ti/devices/DeviceFamily.h>
Include dependency graph for generic.h:
This graph shows which files directly or indirectly include this file:Go to the source code of this file.
Enumerations | |
| enum | RCL_FsType { RCL_FsType_Rx, RCL_FsType_Tx } |
| RF frequency programming type object. More... | |
| struct RCL_CMD_GENERIC_FS_t |
Frequency programming command.
Command to program a synth frequency without directly starting RX or TX
| Data Fields | ||
|---|---|---|
| RCL_Command | common | |
| uint32_t | rfFrequency |
RF frequency in Hz to program |
| RCL_FsType | fsType |
Rules for synth setup |
| struct RCL_CMD_GENERIC_FS_OFF_t |
| struct RCL_CMD_GENERIC_TX_t |
Generic transmit command.
Command to transmit a packet
Collaboration diagram for RCL_CmdGenericTx:| Data Fields | ||
|---|---|---|
| RCL_Command | common | |
| uint32_t | rfFrequency |
RF frequency in Hz to program. 0: Do not program frequency |
| List_List | txBuffers |
Linked list of packets to transmit. RCL will pop the first packet when transmitted. |
| uint32_t | syncWord |
Sync word to transmit |
| RCL_Command_TxPower | txPower |
Transmit power |
| struct RCL_CMD_GENERIC_TX_t | config | |
| struct RCL_CMD_GENERIC_TX_REPEAT_t |
Generic repeated packet transmit command.
Command to transmit a packet repeatedly
Collaboration diagram for RCL_CmdGenericTxRepeat:| Data Fields | ||
|---|---|---|
| RCL_Command | common | |
| uint32_t | rfFrequency |
RF frequency in Hz to program. 0: Do not program frequency |
| RCL_Buffer_DataEntry * | txEntry |
Packet to transmit |
| uint32_t | syncWord |
Sync word to transmit |
| uint32_t | timePeriod |
Time period (0.25 us units) of repeated transmissions. 0: Back-to-back |
| uint16_t | numPackets |
Number of times to send the packet: 0: Unlimited |
| RCL_Command_TxPower | txPower |
Transmit power |
| struct RCL_CMD_GENERIC_TX_REPEAT_t | config | |
| struct RCL_CMD_GENERIC_TX_TEST_t |
Generic transmitter test command.
Command to transmit continuously, either a modulated signal or continuous wave
Collaboration diagram for RCL_CmdGenericTxTest:| Data Fields | ||
|---|---|---|
| RCL_Command | common | |
| uint32_t | rfFrequency |
RF frequency in Hz to program. 0: Do not program frequency |
| RCL_Command_TxPower | txPower |
Transmit power |
| struct RCL_CMD_GENERIC_TX_TEST_t | config | |
| struct RCL_CMD_GENERIC_RX_t |
Generic receive command.
Command to receive a packet
| Data Fields | ||
|---|---|---|
| RCL_Command | common | |
| uint32_t | rfFrequency |
RF frequency in Hz to program. 0: Do not program frequency |
| List_List | rxBuffers |
Linked list of buffers where packets are stored |
| RCL_StatsGeneric * | stats |
Pointer to statistics structure. NULL: Do not store statistics |
| uint32_t | syncWordA |
Sync word to listen for |
| uint32_t | syncWordB |
Alternate Sync word to listen for |
| uint16_t | maxPktLen |
Maximum packet length, or packet length for fixed length |
| struct RCL_CMD_GENERIC_RX_t | config | |
| struct RCL_STATS_GENERIC_t |
| Data Fields | ||
|---|---|---|
| struct RCL_STATS_GENERIC_t | config |
Configuration provided to RCL |
| uint8_t | timestampValid |
Returns 1 if lastTimestamp is updated; 0 otherwise |
| int8_t | lastRssi |
RSSI of last received packet. |
| uint32_t | lastTimestamp |
Timestamp of last successfully received packet |
| uint32_t | nRxNok |
Number of packets received with CRC error |
| uint32_t | nRxOk |
Number of correctly received packets |
| struct RCL_CMD_GENERIC_PBE_OPERATION_t |
| struct RCL_CMD_NESB_PTX_t |
NESB transmit command.
Command to transmit a packet
Collaboration diagram for RCL_CmdNesbPtx:| Data Fields | ||
|---|---|---|
| RCL_Command | common | |
| uint32_t | rfFrequency |
RF frequency in Hz to program. 0: Do not program frequency. |
| List_List | txBuffers |
Linked list of packets to transmit. RCL will pop the first packet when transmitted. |
| List_List | rxBuffers |
Linked list of buffers for storing received packets. In this case, the ACK. |
| RCL_StatsNesb * | stats |
Pointer to statistics structure. NULL: Do not store statistics |
| uint32_t | syncWord |
Sync word to transmit |
| RCL_Command_TxPower | txPower |
Transmit power |
| uint8_t | seqNo |
Sequence number to use for next packet |
| uint8_t | maxRetrans |
Maximum number of retransmissions |
| uint32_t | retransDelay |
Number of Systim ticks (250 [ns] resolution) from start of transmission of a packet to retransmission. If an unattainable retransmission delay is set, the retransmission will start as soon as possible. |
| struct RCL_CMD_NESB_PTX_t | config | |
| struct RCL_CONFIG_ADDRESS_t |
| struct RCL_CMD_NESB_PRX_t |
NESB receive command.
Command to receive a packet
Collaboration diagram for RCL_CmdNesbPrx:| Data Fields | ||
|---|---|---|
| RCL_Command | common | |
| uint32_t | rfFrequency |
RF frequency in Hz to program. 0: Do not program frequency |
| List_List | rxBuffers |
Linked list of buffers where packets are stored |
| RCL_StatsNesb * | stats |
Pointer to statistics structure. NULL: Do not store statistics |
| uint32_t | syncWordA |
Sync word to listen for |
| uint32_t | syncWordB |
Alternate Sync word to listen for |
| RCL_Command_TxPower | txPower |
Transmit power for ACKs |
| uint8_t | addrLen |
Length of address after header (0-4 bytes) |
| struct RCL_CMD_NESB_PRX_t | config | |
| union RCL_CMD_NESB_PRX_t | __unnamed__ | |
| struct RCL_STATS_NESB_t |
| Data Fields | ||
|---|---|---|
| struct RCL_STATS_NESB_t | config |
Configuration provided to RCL |
| uint8_t | timestampValid |
Returns 1 if lastTimestamp is updated; 0 otherwise |
| int8_t | lastRssi |
RSSI of last received packet. |
| uint32_t | lastTimestamp |
Timestamp of last successfully received packet |
| uint32_t | nTx |
Number of packets or acknowledgements transmitted |
| uint32_t | nRxNok |
Number of packets that have been received with CRC error |
| uint32_t | nRxOk |
Number of packets that have been received with CRC OK and not ignored |
| uint32_t | nRxIgnored |
Number of packets ignored as retransmissions |
| uint32_t | nRxAddrMismatch |
Number of packets ignored due to address mismatch |
| uint32_t | nRxBufFull |
Number of packets that have been received and discarded due to lack of buffer space |
| struct RCL_CMD_GENERIC_TX_t.config |
| struct RCL_CMD_GENERIC_TX_REPEAT_t.config |
| struct RCL_CMD_GENERIC_TX_TEST_t.config |
| struct RCL_CMD_GENERIC_RX_t.config |
| struct RCL_STATS_GENERIC_t.config |
| struct RCL_CMD_NESB_PTX_t.config |
| struct RCL_CMD_NESB_PRX_t.config |
| union RCL_CMD_NESB_PRX_t.__unnamed__ |
| Data Fields | ||
|---|---|---|
| RCL_ConfigAddress | syncWord[2] | |
| __unnamed__ | __unnamed__ | |
| struct RCL_CMD_NESB_PRX_t.__unnamed__.__unnamed__ |
| struct RCL_STATS_NESB_t.config |
| #define RCL_CMDID_GENERIC_FS 0x0001U |
| #define RCL_CMDID_GENERIC_FS_OFF 0x0002U |
| #define RCL_CMDID_GENERIC_TX 0x0003U |
| #define RCL_CMDID_GENERIC_TX_REPEAT 0x0004U |
| #define RCL_CMDID_GENERIC_TX_TEST 0x0005U |
| #define RCL_CMDID_GENERIC_RX 0x0006U |
| #define RCL_CMDID_GENERIC_PBE_OPERATION 0x0007U |
| #define RCL_CMDID_NESB_PTX 0x0008U |
| #define RCL_CMDID_NESB_PRX 0x0009U |
| #define RCL_CmdGenericFs_Default | ( | ) |
| #define RCL_CmdGenericFs_DefaultRuntime | ( | ) | (RCL_CmdGenericFs) RCL_CmdGenericFs_Default() |
| #define RCL_CmdGenericFsOff_Default | ( | ) |
| #define RCL_CmdGenericFsOff_DefaultRuntime | ( | ) | (RCL_CmdGenericFsOff) RCL_CmdGenericFsOff_Default() |
| #define RCL_CmdGenericTx_Default | ( | ) |
| #define RCL_CmdGenericTx_DefaultRuntime | ( | ) | (RCL_CmdGenericTx) RCL_CmdGenericTx_Default() |
| #define RCL_CmdGenericTxRepeat_Default | ( | ) |
| #define RCL_CmdGenericTxRepeat_DefaultRuntime | ( | ) | (RCL_CmdGenericTxRepeat) RCL_CmdGenericTxRepeat_Default() |
| #define RCL_CmdGenericTxTest_Default | ( | ) |
| #define RCL_CmdGenericTxTest_DefaultRuntime | ( | ) | (RCL_CmdGenericTxTest) RCL_CmdGenericTxTest_Default() |
| #define RCL_CMD_GENERIC_WH_MODE_NONE 0 |
config.whitenMode: No whitening
Referenced by RCL_Handler_Generic_TxTest().
| #define RCL_CMD_GENERIC_WH_MODE_DEFAULT 1 |
config.whitenMode: Default whitening
| #define RCL_CMD_GENERIC_WH_MODE_PRBS15 2 |
config.whitenMode: PRBS-15
Referenced by RCL_Handler_Generic_TxTest().
| #define RCL_CMD_GENERIC_WH_MODE_PRBS32 3 |
config.whitenMode: PRBS-32
| #define RCL_CmdGenericRx_Default | ( | ) |
| #define RCL_CmdGenericRx_DefaultRuntime | ( | ) | (RCL_CmdGenericRx) RCL_CmdGenericRx_Default() |
| #define RCL_StatsGeneric_Default | ( | ) |
| #define RCL_StatsGeneric_DefaultRuntime | ( | ) | (RCL_StatsGeneric) RCL_StatsGeneric_Default() |
| #define RCL_CmdGenericPbeOperation_Default | ( | ) |
| #define RCL_CmdGenericPbeOperation_DefaultRuntime | ( | ) | (RCL_CmdGenericPbeOperation) RCL_CmdGenericPbeOperation_Default() |
| #define RCL_CmdNesbPtx_Default | ( | ) |
| #define RCL_CmdNesbPtx_DefaultRuntime | ( | ) | (RCL_CmdNesbPtx) RCL_CmdNesbPtx_Default() |
| #define RCL_ConfigAddress_Default | ( | _addr | ) |
| #define RCL_ConfigAddress_DefaultRuntime | ( | _addr | ) | (RCL_ConfigAddress) RCL_ConfigAddress_Default(_addr) |
| #define RCL_CmdNesbPrx_Default | ( | ) |
| #define RCL_CmdNesbPrx_DefaultRuntime | ( | ) | (RCL_CmdNesbPrx) RCL_CmdNesbPrx_Default() |
| #define RCL_StatsNesb_Default | ( | ) |
| #define RCL_StatsNesb_DefaultRuntime | ( | ) | (RCL_StatsNesb) RCL_StatsNesb_Default() |
| enum RCL_FsType |