CC26xx Driver Library
rfc_ble5ScannerPar_s Struct Reference

#include <rf_ble_cmd.h>

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   scanFilterPolicy:1
 Scanning filter policy regarding advertiser address
0: Accept all advertisement packets
1: Accept only advertisement packets from devices where the advertiser's address is in the White list. More...
 
   uint8_t   bActiveScan:1
 0: Passive scan
1: Active scan More...
 
   uint8_t   deviceAddrType:1
 The type of the device address – public (0) or random (1) More...
 
   uint8_t   rpaFilterPolicy:1
 Filter policy for initA of ADV_DIRECT_IND messages
0: Accept only initA that matches own address
1: Also accept all resolvable private addresses. 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   bAutoWlIgnore:1
 0: Do not set ignore bit in white list from radio CPU for legacy packets
1: Automatically set ignore bit in white list for legacy packets More...
 
   uint8_t   bEndOnRpt:1
 0: Continue scanner operation after each reporting ADV*_IND or sending SCAN_RSP
1: End scanner operation after each reported ADV*_IND and potentially SCAN_RSP More...
 
   uint8_t   rpaMode:1
 Resolvable private address mode
0: Normal operation
1: Use white list for a received RPA regardless of filter policy. More...
 
scanConfig
 
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
 
struct {
   uint8_t   bCheckAdi:1
 0: Do not perform ADI filtering
1: Perform ADI filtering on packets where ADI is present More...
 
   uint8_t   bAutoAdiUpdate:1
 0: Do not update ADI entries in radio CPU
1: Automatically update ADI entry for received packets with AuxPtr More...
 
   uint8_t   bApplyDuplicateFiltering:1
 0: Do not apply duplicate filtering based on device address for extended advertiser packets
More...
 
   uint8_t   bAutoWlIgnore:1
 0: Do not set ignore bit in white list from radio CPU for extended advertising packets
1: Automatically set ignore bit in white list for extended advertising packets More...
 
extFilterConfig
 
uint32_t __dummy0
 
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 scanConfig.deviceAddrType is inverted. More...
 
rfc_bleWhiteListEntry_tpWhiteList
 Pointer to white list. More...
 
rfc_ble5AdiEntry_tpAdiList
 Pointer to advDataInfo list. 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

uint32_t rfc_ble5ScannerPar_s::__dummy0
uint16_t rfc_ble5ScannerPar_s::backoffCount

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

struct { ... } rfc_ble5ScannerPar_s::backoffPar
uint8_t rfc_ble5ScannerPar_s::bActiveScan

0: Passive scan
1: Active scan

uint8_t rfc_ble5ScannerPar_s::bAppendRssi

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

uint8_t rfc_ble5ScannerPar_s::bAppendStatus

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

uint8_t rfc_ble5ScannerPar_s::bAppendTimestamp

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

uint8_t rfc_ble5ScannerPar_s::bApplyDuplicateFiltering

0: Do not apply duplicate filtering based on device address for extended advertiser packets

1: Apply duplicate filtering based on device address for extended advertiser packets with no ADI field

uint8_t rfc_ble5ScannerPar_s::bAutoAdiUpdate

0: Do not update ADI entries in radio CPU
1: Automatically update ADI entry for received packets with AuxPtr

uint8_t rfc_ble5ScannerPar_s::bAutoFlushCrcErr

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

uint8_t rfc_ble5ScannerPar_s::bAutoFlushEmpty

If 1, automatically remove empty packets from Rx queue.

uint8_t rfc_ble5ScannerPar_s::bAutoFlushIgnored

If 1, automatically remove ignored packets from Rx queue.

uint8_t rfc_ble5ScannerPar_s::bAutoWlIgnore

0: Do not set ignore bit in white list from radio CPU for legacy packets
1: Automatically set ignore bit in white list for legacy packets

0: Do not set ignore bit in white list from radio CPU for extended advertising packets
1: Automatically set ignore bit in white list for extended advertising packets

uint8_t rfc_ble5ScannerPar_s::bCheckAdi

0: Do not perform ADI filtering
1: Perform ADI filtering on packets where ADI is present

uint8_t rfc_ble5ScannerPar_s::bEnaCmd

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

uint8_t rfc_ble5ScannerPar_s::bEndOnRpt

0: Continue scanner operation after each reporting ADV*_IND or sending SCAN_RSP
1: End scanner operation after each reported ADV*_IND and potentially SCAN_RSP

uint8_t rfc_ble5ScannerPar_s::bIncludeCrc

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

uint8_t rfc_ble5ScannerPar_s::bIncludeLenByte

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

uint8_t rfc_ble5ScannerPar_s::bLastFailed

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

uint8_t rfc_ble5ScannerPar_s::bLastSucceeded

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

uint8_t rfc_ble5ScannerPar_s::bStrictLenFilter

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

uint8_t rfc_ble5ScannerPar_s::channelNo

The channel index used for secondary advertising.

uint8_t rfc_ble5ScannerPar_s::deviceAddrType

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

ratmr_t rfc_ble5ScannerPar_s::endTime

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

struct { ... } rfc_ble5ScannerPar_s::endTrigger

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

struct { ... } rfc_ble5ScannerPar_s::extFilterConfig
uint8_t rfc_ble5ScannerPar_s::logUpperLimit

Binary logarithm of parameter upperLimit used in scanner backoff procedure.

uint16_t rfc_ble5ScannerPar_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.

rfc_ble5AdiEntry_t* rfc_ble5ScannerPar_s::pAdiList

Pointer to advDataInfo list.

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

uint16_t* rfc_ble5ScannerPar_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 scanConfig.deviceAddrType is inverted.

uint8_t rfc_ble5ScannerPar_s::phyMode

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

dataQueue_t* rfc_ble5ScannerPar_s::pRxQ

Pointer to receive queue.

rfc_bleWhiteListEntry_t* rfc_ble5ScannerPar_s::pWhiteList

Pointer to white list.

uint16_t rfc_ble5ScannerPar_s::randomState

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

uint8_t rfc_ble5ScannerPar_s::rpaFilterPolicy

Filter policy for initA of ADV_DIRECT_IND messages
0: Accept only initA that matches own address
1: Also accept all resolvable private addresses.

uint8_t rfc_ble5ScannerPar_s::rpaMode

Resolvable private address mode
0: Normal operation
1: Use white list for a received RPA regardless of filter policy.

struct { ... } rfc_ble5ScannerPar_s::rxConfig

Configuration bits for the receive queue entries.

uint16_t rfc_ble5ScannerPar_s::rxListenTime

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

ratmr_t rfc_ble5ScannerPar_s::rxStartTime

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

struct { ... } rfc_ble5ScannerPar_s::scanConfig
uint8_t rfc_ble5ScannerPar_s::scanFilterPolicy

Scanning filter policy regarding advertiser address
0: Accept all advertisement packets
1: Accept only advertisement packets from devices where the advertiser's address is in the White list.

ratmr_t rfc_ble5ScannerPar_s::timeoutTime

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

struct { ... } rfc_ble5ScannerPar_s::timeoutTrigger

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

uint8_t rfc_ble5ScannerPar_s::triggerNo

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

uint8_t rfc_ble5ScannerPar_s::triggerType

The type of trigger.