rflib
Data Fields
rfc_ble5InitiatorPar_s Struct Reference

#include <rf_ble_cmd.h>

Collaboration diagram for rfc_ble5InitiatorPar_s:
Collaboration graph
[legend]

Data Fields

dataQueue_tpRxQ
 Pointer to receive queue. More...
 
struct {
   uint8_t   bAutoFlushIgnored:1
 If 1, automatically remove ignored packets from Rx queue. More...
 
   uint8_t   bAutoFlushCrcErr:1
 If 1, automatically remove packets with CRC error from Rx queue. More...
 
   uint8_t   bAutoFlushEmpty:1
 If 1, automatically remove empty packets from Rx queue. More...
 
   uint8_t   bIncludeLenByte:1
 If 1, include the received length byte in the stored packet; otherwise discard it. More...
 
   uint8_t   bIncludeCrc:1
 If 1, include the received CRC field in the stored packet; otherwise discard it. More...
 
   uint8_t   bAppendRssi:1
 If 1, append an RSSI byte to the packet in the Rx queue. More...
 
   uint8_t   bAppendStatus:1
 If 1, append a status word to the packet in the Rx queue. More...
 
   uint8_t   bAppendTimestamp:1
 If 1, append a timestamp to the packet in the Rx queue. More...
 
rxConfig
 Configuration bits for the receive queue entries. More...
 
struct {
   uint8_t   bUseWhiteList:1
 Initiator filter policy
0: Use specific peer address
1: Use white list. More...
 
   uint8_t   bDynamicWinOffset:1
 1: Use dynamic WinOffset insertion More...
 
   uint8_t   deviceAddrType:1
 The type of the device address – public (0) or random (1) More...
 
   uint8_t   peerAddrType:1
 The type of the peer address – public (0) or random (1) More...
 
   uint8_t   bStrictLenFilter:1
 0: Accept any packet with a valid advertising packet length
1: Discard messages with illegal length for the given packet type More...
 
   uint8_t   chSel:1
 0: Do not report support of Channel Selection Algorithm #2 in CONNECT_IND
1: Report support of Channel Selection Algorithm #2 in CONNECT_IND More...
 
initConfig
 
uint16_t randomState
 State for pseudo-random number generation used in backoff procedure. More...
 
uint16_t backoffCount
 Parameter backoffCount used in backoff procedure, cf. Bluetooth spec. More...
 
struct {
   uint8_t   logUpperLimit:4
 Binary logarithm of parameter upperLimit used in scanner backoff procedure. More...
 
   uint8_t   bLastSucceeded:1
 1 if the last SCAN_RSP was successfully received and upperLimit not changed More...
 
   uint8_t   bLastFailed:1
 1 if reception of the last SCAN_RSP failed and upperLimit was not changed More...
 
backoffPar
 
uint8_t connectReqLen
 Size of connect request data. More...
 
uint8_t * pConnectReqData
 Pointer to buffer containing LLData to go in the CONNECT_IND or AUX_CONNECT_REQ packet. More...
 
uint16_t * pDeviceAddress
 Pointer (with least significant bit set to 0) to device address used for this device. If least significant bit is 1, the address type given by initConfig.deviceAddrType is inverted. More...
 
rfc_bleWhiteListEntry_tpWhiteList
 Pointer (with least significant bit set to 0) to white list or peer address. If least significant bit is 1, the address type given by initConfig.peerAddrType is inverted. More...
 
ratmr_t connectTime
 Indication of timer value of the first possible start time of the first connection event. Set to the calculated value if a connection is made and to the next possible connection time if not. More...
 
uint16_t maxWaitTimeForAuxCh
 Maximum wait time for switching to secondary scanning withing the command. If the time to the start of the event is greater than this, the command will end with BLE_DONE_AUX. If it is smaller, the radio will automatically switch to the correct channel and PHY. 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...
 
timeoutTrigger
 Trigger that causes the device to stop receiving as soon as allowed. 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...
 
endTrigger
 Trigger that causes the device to stop receiving as soon as allowed. More...
 
ratmr_t timeoutTime
 Time used together with timeoutTrigger that causes the device to stop receiving as soon as allowed, ending with BLE_DONE_RXTIMEOUT. More...
 
ratmr_t endTime
 Time used together with endTrigger that causes the device to stop receiving as soon as allowed, ending with BLE_DONE_ENDED. More...
 
ratmr_t rxStartTime
 The time needed to start RX in order to receive the packet. More...
 
uint16_t rxListenTime
 The time needed to listen in order to receive the packet. 0: No AUX packet. More...
 
uint8_t channelNo
 The channel index used for secondary advertising. More...
 
uint8_t phyMode
 PHY to use on secondary channel:
0: 1 Mbps
1: 2 Mbps
2: Coded
Others: Reserved More...
 

Field Documentation

§ pRxQ

dataQueue_t* rfc_ble5InitiatorPar_s::pRxQ

Pointer to receive queue.

§ bAutoFlushIgnored

uint8_t rfc_ble5InitiatorPar_s::bAutoFlushIgnored

If 1, automatically remove ignored packets from Rx queue.

§ bAutoFlushCrcErr

uint8_t rfc_ble5InitiatorPar_s::bAutoFlushCrcErr

If 1, automatically remove packets with CRC error from Rx queue.

§ bAutoFlushEmpty

uint8_t rfc_ble5InitiatorPar_s::bAutoFlushEmpty

If 1, automatically remove empty packets from Rx queue.

§ bIncludeLenByte

uint8_t rfc_ble5InitiatorPar_s::bIncludeLenByte

If 1, include the received length byte in the stored packet; otherwise discard it.

§ bIncludeCrc

uint8_t rfc_ble5InitiatorPar_s::bIncludeCrc

If 1, include the received CRC field in the stored packet; otherwise discard it.

§ bAppendRssi

uint8_t rfc_ble5InitiatorPar_s::bAppendRssi

If 1, append an RSSI byte to the packet in the Rx queue.

§ bAppendStatus

uint8_t rfc_ble5InitiatorPar_s::bAppendStatus

If 1, append a status word to the packet in the Rx queue.

§ bAppendTimestamp

uint8_t rfc_ble5InitiatorPar_s::bAppendTimestamp

If 1, append a timestamp to the packet in the Rx queue.

§ rxConfig

struct { ... } rfc_ble5InitiatorPar_s::rxConfig

Configuration bits for the receive queue entries.

§ bUseWhiteList

uint8_t rfc_ble5InitiatorPar_s::bUseWhiteList

Initiator filter policy
0: Use specific peer address
1: Use white list.

§ bDynamicWinOffset

uint8_t rfc_ble5InitiatorPar_s::bDynamicWinOffset

1: Use dynamic WinOffset insertion

§ deviceAddrType

uint8_t rfc_ble5InitiatorPar_s::deviceAddrType

The type of the device address – public (0) or random (1)

§ peerAddrType

uint8_t rfc_ble5InitiatorPar_s::peerAddrType

The type of the peer address – public (0) or random (1)

§ bStrictLenFilter

uint8_t rfc_ble5InitiatorPar_s::bStrictLenFilter

0: Accept any packet with a valid advertising packet length
1: Discard messages with illegal length for the given packet type

§ chSel

uint8_t rfc_ble5InitiatorPar_s::chSel

0: Do not report support of Channel Selection Algorithm #2 in CONNECT_IND
1: Report support of Channel Selection Algorithm #2 in CONNECT_IND

§ initConfig

struct { ... } rfc_ble5InitiatorPar_s::initConfig

§ randomState

uint16_t rfc_ble5InitiatorPar_s::randomState

State for pseudo-random number generation used in backoff procedure.

§ backoffCount

uint16_t rfc_ble5InitiatorPar_s::backoffCount

Parameter backoffCount used in backoff procedure, cf. Bluetooth spec.

§ logUpperLimit

uint8_t rfc_ble5InitiatorPar_s::logUpperLimit

Binary logarithm of parameter upperLimit used in scanner backoff procedure.

§ bLastSucceeded

uint8_t rfc_ble5InitiatorPar_s::bLastSucceeded

1 if the last SCAN_RSP was successfully received and upperLimit not changed

§ bLastFailed

uint8_t rfc_ble5InitiatorPar_s::bLastFailed

1 if reception of the last SCAN_RSP failed and upperLimit was not changed

§ backoffPar

struct { ... } rfc_ble5InitiatorPar_s::backoffPar

§ connectReqLen

uint8_t rfc_ble5InitiatorPar_s::connectReqLen

Size of connect request data.

§ pConnectReqData

uint8_t* rfc_ble5InitiatorPar_s::pConnectReqData

Pointer to buffer containing LLData to go in the CONNECT_IND or AUX_CONNECT_REQ packet.

§ pDeviceAddress

uint16_t* rfc_ble5InitiatorPar_s::pDeviceAddress

Pointer (with least significant bit set to 0) to device address used for this device. If least significant bit is 1, the address type given by initConfig.deviceAddrType is inverted.

§ pWhiteList

rfc_bleWhiteListEntry_t* rfc_ble5InitiatorPar_s::pWhiteList

Pointer (with least significant bit set to 0) to white list or peer address. If least significant bit is 1, the address type given by initConfig.peerAddrType is inverted.

§ connectTime

ratmr_t rfc_ble5InitiatorPar_s::connectTime

Indication of timer value of the first possible start time of the first connection event. Set to the calculated value if a connection is made and to the next possible connection time if not.

§ maxWaitTimeForAuxCh

uint16_t rfc_ble5InitiatorPar_s::maxWaitTimeForAuxCh

Maximum wait time for switching to secondary scanning withing the command. If the time to the start of the event is greater than this, the command will end with BLE_DONE_AUX. If it is smaller, the radio will automatically switch to the correct channel and PHY.

§ triggerType

uint8_t rfc_ble5InitiatorPar_s::triggerType

The type of trigger.

§ bEnaCmd

uint8_t rfc_ble5InitiatorPar_s::bEnaCmd

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

§ triggerNo

uint8_t rfc_ble5InitiatorPar_s::triggerNo

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

§ pastTrig

uint8_t rfc_ble5InitiatorPar_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

§ timeoutTrigger

struct { ... } rfc_ble5InitiatorPar_s::timeoutTrigger

Trigger that causes the device to stop receiving as soon as allowed.

§ endTrigger

struct { ... } rfc_ble5InitiatorPar_s::endTrigger

Trigger that causes the device to stop receiving as soon as allowed.

§ timeoutTime

ratmr_t rfc_ble5InitiatorPar_s::timeoutTime

Time used together with timeoutTrigger that causes the device to stop receiving as soon as allowed, ending with BLE_DONE_RXTIMEOUT.

§ endTime

ratmr_t rfc_ble5InitiatorPar_s::endTime

Time used together with endTrigger that causes the device to stop receiving as soon as allowed, ending with BLE_DONE_ENDED.

§ rxStartTime

ratmr_t rfc_ble5InitiatorPar_s::rxStartTime

The time needed to start RX in order to receive the packet.

§ rxListenTime

uint16_t rfc_ble5InitiatorPar_s::rxListenTime

The time needed to listen in order to receive the packet. 0: No AUX packet.

§ channelNo

uint8_t rfc_ble5InitiatorPar_s::channelNo

The channel index used for secondary advertising.

§ phyMode

uint8_t rfc_ble5InitiatorPar_s::phyMode

PHY to use on secondary channel:
0: 1 Mbps
1: 2 Mbps
2: Coded
Others: Reserved


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