rflib
Data Fields
rfc_CMD_PROP_CS_s Struct Reference

Carrier Sense Command. More...

#include <rf_prop_cmd.h>

Collaboration diagram for rfc_CMD_PROP_CS_s:
Collaboration graph
[legend]

Data Fields

uint16_t commandNo
 The command ID number 0x3805. 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
 
struct {
   uint8_t   bFsOffIdle:1
 0: Keep synth running if command ends with channel Idle
1: Turn off synth if command ends with channel Idle More...
 
   uint8_t   bFsOffBusy:1
 0: Keep synth running if command ends with channel Busy
1: Turn off synth if command ends with channel Busy More...
 
csFsConf
 
uint8_t __dummy0
 
struct {
   uint8_t   bEnaRssi:1
 If 1, enable RSSI as a criterion. More...
 
   uint8_t   bEnaCorr:1
 If 1, enable correlation as a criterion. More...
 
   uint8_t   operation:1
 0: Busy if either RSSI or correlation indicates Busy
1: Busy if both RSSI and correlation indicates Busy More...
 
   uint8_t   busyOp:1
 0: Continue carrier sense on channel Busy
1: End carrier sense on channel Busy
For an RX command, the receiver will continue when carrier sense ends, but it will then not end if channel goes Idle More...
 
   uint8_t   idleOp:1
 0: Continue on channel Idle
1: End on channel Idle More...
 
   uint8_t   timeoutRes:1
 0: Timeout with channel state Invalid treated as Busy
1: Timeout with channel state Invalid treated as Idle More...
 
csConf
 
int8_t rssiThr
 RSSI threshold. More...
 
uint8_t numRssiIdle
 Number of consecutive RSSI measurements below the threshold needed before the channel is declared Idle. More...
 
uint8_t numRssiBusy
 Number of consecutive RSSI measurements above the threshold needed before the channel is declared Busy. More...
 
uint16_t corrPeriod
 Number of RAT ticks for a correlation observation periods. More...
 
struct {
   uint8_t   numCorrInv:4
 Number of subsequent correlation tops with maximum corrPeriod RAT ticks between them needed to go from Idle to Invalid. More...
 
   uint8_t   numCorrBusy:4
 Number of subsequent correlation tops with maximum corrPeriod RAT ticks between them needed to go from Invalid to Busy. More...
 
corrConfig
 
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...
 
csEndTrigger
 Trigger classifier for ending the carrier sense. More...
 
ratmr_t csEndTime
 Time used together with csEndTrigger for ending the operation. 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
 
struct {
   uint8_t   bFsOffIdle:1
 0: Keep synth running if command ends with channel Idle
1: Turn off synth if command ends with channel Idle More...
 
   uint8_t   bFsOffBusy:1
 0: Keep synth running if command ends with channel Busy
1: Turn off synth if command ends with channel Busy More...
 
csFsConf
 
struct {
   uint8_t   bEnaRssi:1
 If 1, enable RSSI as a criterion. More...
 
   uint8_t   bEnaCorr:1
 If 1, enable correlation as a criterion. More...
 
   uint8_t   operation:1
 0: Busy if either RSSI or correlation indicates Busy
1: Busy if both RSSI and correlation indicates Busy More...
 
   uint8_t   busyOp:1
 0: Continue carrier sense on channel Busy
1: End carrier sense on channel Busy
For an RX command, the receiver will continue when carrier sense ends, but it will then not end if channel goes Idle More...
 
   uint8_t   idleOp:1
 0: Continue on channel Idle
1: End on channel Idle More...
 
   uint8_t   timeoutRes:1
 0: Timeout with channel state Invalid treated as Busy
1: Timeout with channel state Invalid treated as Idle More...
 
csConf
 
struct {
   uint8_t   numCorrInv:4
 Number of subsequent correlation tops with maximum corrPeriod RAT ticks between them needed to go from Idle to Invalid. More...
 
   uint8_t   numCorrBusy:4
 Number of subsequent correlation tops with maximum corrPeriod RAT ticks between them needed to go from Invalid to Busy. More...
 
corrConfig
 
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...
 
csEndTrigger
 Trigger classifier for ending the carrier sense. 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
 
struct {
   uint8_t   bFsOffIdle:1
 0: Keep synth running if command ends with channel Idle
1: Turn off synth if command ends with channel Idle More...
 
   uint8_t   bFsOffBusy:1
 0: Keep synth running if command ends with channel Busy
1: Turn off synth if command ends with channel Busy More...
 
csFsConf
 
struct {
   uint8_t   bEnaRssi:1
 If 1, enable RSSI as a criterion. More...
 
   uint8_t   bEnaCorr:1
 If 1, enable correlation as a criterion. More...
 
   uint8_t   operation:1
 0: Busy if either RSSI or correlation indicates Busy
1: Busy if both RSSI and correlation indicates Busy More...
 
   uint8_t   busyOp:1
 0: Continue carrier sense on channel Busy
1: End carrier sense on channel Busy
For an RX command, the receiver will continue when carrier sense ends, but it will then not end if channel goes Idle More...
 
   uint8_t   idleOp:1
 0: Continue on channel Idle
1: End on channel Idle More...
 
   uint8_t   timeoutRes:1
 0: Timeout with channel state Invalid treated as Busy
1: Timeout with channel state Invalid treated as Idle More...
 
csConf
 
struct {
   uint8_t   numCorrInv:4
 Number of subsequent correlation tops with maximum corrPeriod RAT ticks between them needed to go from Idle to Invalid. More...
 
   uint8_t   numCorrBusy:4
 Number of subsequent correlation tops with maximum corrPeriod RAT ticks between them needed to go from Invalid to Busy. More...
 
corrConfig
 
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...
 
csEndTrigger
 Trigger classifier for ending the carrier sense. More...
 

Detailed Description

Carrier Sense Command.

Field Documentation

§ commandNo

uint16_t rfc_CMD_PROP_CS_s::commandNo

The command ID number 0x3805.

§ status

uint16_t rfc_CMD_PROP_CS_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_PROP_CS_s::pNextOp

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

§ startTime

ratmr_t rfc_CMD_PROP_CS_s::startTime

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

§ triggerType

uint8_t rfc_CMD_PROP_CS_s::triggerType

The type of trigger.

§ bEnaCmd

uint8_t rfc_CMD_PROP_CS_s::bEnaCmd

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

§ triggerNo

uint8_t rfc_CMD_PROP_CS_s::triggerNo

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

§ pastTrig

uint8_t rfc_CMD_PROP_CS_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 [1/3]

struct { ... } rfc_CMD_PROP_CS_s::startTrigger

Identification of the trigger that starts the operation.

§ rule

uint8_t rfc_CMD_PROP_CS_s::rule

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

§ nSkip

uint8_t rfc_CMD_PROP_CS_s::nSkip

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

§ condition [1/3]

struct { ... } rfc_CMD_PROP_CS_s::condition

§ bFsOffIdle

uint8_t rfc_CMD_PROP_CS_s::bFsOffIdle

0: Keep synth running if command ends with channel Idle
1: Turn off synth if command ends with channel Idle

§ bFsOffBusy

uint8_t rfc_CMD_PROP_CS_s::bFsOffBusy

0: Keep synth running if command ends with channel Busy
1: Turn off synth if command ends with channel Busy

§ csFsConf [1/3]

struct { ... } rfc_CMD_PROP_CS_s::csFsConf

§ __dummy0

uint8_t rfc_CMD_PROP_CS_s::__dummy0

§ bEnaRssi

uint8_t rfc_CMD_PROP_CS_s::bEnaRssi

If 1, enable RSSI as a criterion.

§ bEnaCorr

uint8_t rfc_CMD_PROP_CS_s::bEnaCorr

If 1, enable correlation as a criterion.

§ operation

uint8_t rfc_CMD_PROP_CS_s::operation

0: Busy if either RSSI or correlation indicates Busy
1: Busy if both RSSI and correlation indicates Busy

§ busyOp

uint8_t rfc_CMD_PROP_CS_s::busyOp

0: Continue carrier sense on channel Busy
1: End carrier sense on channel Busy
For an RX command, the receiver will continue when carrier sense ends, but it will then not end if channel goes Idle

§ idleOp

uint8_t rfc_CMD_PROP_CS_s::idleOp

0: Continue on channel Idle
1: End on channel Idle

§ timeoutRes

uint8_t rfc_CMD_PROP_CS_s::timeoutRes

0: Timeout with channel state Invalid treated as Busy
1: Timeout with channel state Invalid treated as Idle

§ csConf [1/3]

struct { ... } rfc_CMD_PROP_CS_s::csConf

§ rssiThr

int8_t rfc_CMD_PROP_CS_s::rssiThr

RSSI threshold.

§ numRssiIdle

uint8_t rfc_CMD_PROP_CS_s::numRssiIdle

Number of consecutive RSSI measurements below the threshold needed before the channel is declared Idle.

§ numRssiBusy

uint8_t rfc_CMD_PROP_CS_s::numRssiBusy

Number of consecutive RSSI measurements above the threshold needed before the channel is declared Busy.

§ corrPeriod

uint16_t rfc_CMD_PROP_CS_s::corrPeriod

Number of RAT ticks for a correlation observation periods.

§ numCorrInv

uint8_t rfc_CMD_PROP_CS_s::numCorrInv

Number of subsequent correlation tops with maximum corrPeriod RAT ticks between them needed to go from Idle to Invalid.

§ numCorrBusy

uint8_t rfc_CMD_PROP_CS_s::numCorrBusy

Number of subsequent correlation tops with maximum corrPeriod RAT ticks between them needed to go from Invalid to Busy.

§ corrConfig [1/3]

struct { ... } rfc_CMD_PROP_CS_s::corrConfig

§ csEndTrigger [1/3]

struct { ... } rfc_CMD_PROP_CS_s::csEndTrigger

Trigger classifier for ending the carrier sense.

§ csEndTime

ratmr_t rfc_CMD_PROP_CS_s::csEndTime

Time used together with csEndTrigger for ending the operation.

§ startTrigger [2/3]

struct { ... } rfc_CMD_PROP_CS_s::startTrigger

Identification of the trigger that starts the operation.

§ condition [2/3]

struct { ... } rfc_CMD_PROP_CS_s::condition

§ csFsConf [2/3]

struct { ... } rfc_CMD_PROP_CS_s::csFsConf

§ csConf [2/3]

struct { ... } rfc_CMD_PROP_CS_s::csConf

§ corrConfig [2/3]

struct { ... } rfc_CMD_PROP_CS_s::corrConfig

§ csEndTrigger [2/3]

struct { ... } rfc_CMD_PROP_CS_s::csEndTrigger

Trigger classifier for ending the carrier sense.

§ startTrigger [3/3]

struct { ... } rfc_CMD_PROP_CS_s::startTrigger

Identification of the trigger that starts the operation.

§ condition [3/3]

struct { ... } rfc_CMD_PROP_CS_s::condition

§ csFsConf [3/3]

struct { ... } rfc_CMD_PROP_CS_s::csFsConf

§ csConf [3/3]

struct { ... } rfc_CMD_PROP_CS_s::csConf

§ corrConfig [3/3]

struct { ... } rfc_CMD_PROP_CS_s::corrConfig

§ csEndTrigger [3/3]

struct { ... } rfc_CMD_PROP_CS_s::csEndTrigger

Trigger classifier for ending the carrier sense.


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