rflib
Data Fields
rfc_CMD_BLE5_SLAVE_s Struct Reference

Bluetooth 5 Slave Command. More...

#include <rf_ble_cmd.h>

Collaboration diagram for rfc_CMD_BLE5_SLAVE_s:
Collaboration graph
[legend]

Data Fields

uint16_t commandNo
 The command ID number 0x1821. More...
 
uint16_t status
 An integer telling the status of the command. This value is updated by the radio CPU during operation and may be read by the system CPU at any time. More...
 
rfc_radioOp_tpNextOp
 Pointer to the next operation to run after this operation is done. More...
 
ratmr_t startTime
 Absolute or relative start time (depending on the value of startTrigger) More...
 
struct {
   uint8_t   triggerType:4
 The type of trigger. More...
 
   uint8_t   bEnaCmd:1
 0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger More...
 
   uint8_t   triggerNo:2
 The trigger number of the CMD_TRIGGER command that triggers this action. More...
 
   uint8_t   pastTrig:1
 0: A trigger in the past is never triggered, or for start of commands, give an error
1: A trigger in the past is triggered as soon as possible More...
 
startTrigger
 Identification of the trigger that starts the operation. More...
 
struct {
   uint8_t   rule:4
 Condition for running next command: Rule for how to proceed. More...
 
   uint8_t   nSkip:4
 Number of skips + 1 if the rule involves skipping. 0: same, 1: next, 2: skip next, ... More...
 
condition
 
uint8_t channel
 Channel to use
0–39: BLE advertising/data channel index
60–207: Custom frequency; (2300 + channel) MHz
255: Use existing frequency
Others: Reserved More...
 
struct {
   uint8_t   init:7
 If bOverride = 1 or custom frequency is used:
0: Do not use whitening
Other value: Initialization for 7-bit LFSR whitener. More...
 
   uint8_t   bOverride:1
 0: Use default whitening for BLE advertising/data channels
1: Override whitening initialization with value of init More...
 
whitening
 
struct {
   uint8_t   mainMode:2
 PHY to use:
0: 1 Mbps
1: 2 Mbps
2: Coded
3: Reserved More...
 
   uint8_t   coding:6
 Coding to use for TX if coded PHY is selected. See the Technical Reference Manual for details. More...
 
phyMode
 
uint8_t rangeDelay
 Number of RAT ticks to add to the listening time after T_IFS. More...
 
uint16_t txPower
 Transmit power to use (overrides the one given in radio setup)
0x0000: Use default TX power
0xFFFF: 20-dBm PA only: Use TX power from tx20Power field (command structure that includes tx20Power must be used) More...
 
rfc_ble5SlavePar_tpParams
 Pointer to command specific parameter structure. More...
 
rfc_bleMasterSlaveOutput_tpOutput
 Pointer to command specific output structure. More...
 
uint32_t tx20Power
 If txPower = 0xFFFF:
If tx20Power < 0x10000000: Transmit power to use for the 20-dBm PA; overrides the one given in radio setup for the duration of the command.
If tx20Power >= 0x10000000: Pointer to PA change override structure as for CMD_CHANGE_PA ; permanently changes the PA and PA power set in radio setup.
For other values of txPower, this field is not accessed by the radio CPU and may be omitted from the structure. More...
 

Detailed Description

Bluetooth 5 Slave Command.

Field Documentation

§ commandNo

uint16_t rfc_CMD_BLE5_SLAVE_s::commandNo

The command ID number 0x1821.

§ status

uint16_t rfc_CMD_BLE5_SLAVE_s::status

An integer telling the status of the command. This value is updated by the radio CPU during operation and may be read by the system CPU at any time.

§ pNextOp

rfc_radioOp_t* rfc_CMD_BLE5_SLAVE_s::pNextOp

Pointer to the next operation to run after this operation is done.

§ startTime

ratmr_t rfc_CMD_BLE5_SLAVE_s::startTime

Absolute or relative start time (depending on the value of startTrigger)

§ triggerType

uint8_t rfc_CMD_BLE5_SLAVE_s::triggerType

The type of trigger.

§ bEnaCmd

uint8_t rfc_CMD_BLE5_SLAVE_s::bEnaCmd

0: No alternative trigger command
1: CMD_TRIGGER can be used as an alternative trigger

§ triggerNo

uint8_t rfc_CMD_BLE5_SLAVE_s::triggerNo

The trigger number of the CMD_TRIGGER command that triggers this action.

§ pastTrig

uint8_t rfc_CMD_BLE5_SLAVE_s::pastTrig

0: A trigger in the past is never triggered, or for start of commands, give an error
1: A trigger in the past is triggered as soon as possible

§ startTrigger

struct { ... } rfc_CMD_BLE5_SLAVE_s::startTrigger

Identification of the trigger that starts the operation.

§ rule

uint8_t rfc_CMD_BLE5_SLAVE_s::rule

Condition for running next command: Rule for how to proceed.

§ nSkip

uint8_t rfc_CMD_BLE5_SLAVE_s::nSkip

Number of skips + 1 if the rule involves skipping. 0: same, 1: next, 2: skip next, ...

§ condition

struct { ... } rfc_CMD_BLE5_SLAVE_s::condition

§ channel

uint8_t rfc_CMD_BLE5_SLAVE_s::channel

Channel to use
0–39: BLE advertising/data channel index
60–207: Custom frequency; (2300 + channel) MHz
255: Use existing frequency
Others: Reserved

§ init

uint8_t rfc_CMD_BLE5_SLAVE_s::init

If bOverride = 1 or custom frequency is used:
0: Do not use whitening
Other value: Initialization for 7-bit LFSR whitener.

§ bOverride

uint8_t rfc_CMD_BLE5_SLAVE_s::bOverride

0: Use default whitening for BLE advertising/data channels
1: Override whitening initialization with value of init

§ whitening

struct { ... } rfc_CMD_BLE5_SLAVE_s::whitening

§ mainMode

uint8_t rfc_CMD_BLE5_SLAVE_s::mainMode

PHY to use:
0: 1 Mbps
1: 2 Mbps
2: Coded
3: Reserved

§ coding

uint8_t rfc_CMD_BLE5_SLAVE_s::coding

Coding to use for TX if coded PHY is selected. See the Technical Reference Manual for details.

§ phyMode

struct { ... } rfc_CMD_BLE5_SLAVE_s::phyMode

§ rangeDelay

uint8_t rfc_CMD_BLE5_SLAVE_s::rangeDelay

Number of RAT ticks to add to the listening time after T_IFS.

§ txPower

uint16_t rfc_CMD_BLE5_SLAVE_s::txPower

Transmit power to use (overrides the one given in radio setup)
0x0000: Use default TX power
0xFFFF: 20-dBm PA only: Use TX power from tx20Power field (command structure that includes tx20Power must be used)

§ pParams

rfc_ble5SlavePar_t* rfc_CMD_BLE5_SLAVE_s::pParams

Pointer to command specific parameter structure.

§ pOutput

rfc_bleMasterSlaveOutput_t* rfc_CMD_BLE5_SLAVE_s::pOutput

Pointer to command specific output structure.

§ tx20Power

uint32_t rfc_CMD_BLE5_SLAVE_s::tx20Power

If txPower = 0xFFFF:
If tx20Power < 0x10000000: Transmit power to use for the 20-dBm PA; overrides the one given in radio setup for the duration of the command.
If tx20Power >= 0x10000000: Pointer to PA change override structure as for CMD_CHANGE_PA ; permanently changes the PA and PA power set in radio setup.
For other values of txPower, this field is not accessed by the radio CPU and may be omitted from the structure.


The documentation for this struct was generated from the following file:
© Copyright 1995-2021, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale