rflib
Data Fields
rfc_bleScannerPar_s Struct Reference

#include <rf_ble_cmd.h>

Collaboration diagram for rfc_bleScannerPar_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   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 for 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
1: Automatically set ignore bit in white list 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
 
uint8_t scanReqLen
 Size of scan request data. More...
 
uint8_t * pScanReqData
 Pointer to buffer containing SCAN_REQ data. 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 scanConfig.deviceAddrType is inverted. More...
 
rfc_bleWhiteListEntry_tpWhiteList
 Pointer to white list. More...
 
uint16_t __dummy0
 
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...
 

Field Documentation

§ pRxQ

dataQueue_t* rfc_bleScannerPar_s::pRxQ

Pointer to receive queue.

§ bAutoFlushIgnored

uint8_t rfc_bleScannerPar_s::bAutoFlushIgnored

If 1, automatically remove ignored packets from Rx queue.

§ bAutoFlushCrcErr

uint8_t rfc_bleScannerPar_s::bAutoFlushCrcErr

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

§ bAutoFlushEmpty

uint8_t rfc_bleScannerPar_s::bAutoFlushEmpty

If 1, automatically remove empty packets from Rx queue.

§ bIncludeLenByte

uint8_t rfc_bleScannerPar_s::bIncludeLenByte

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

§ bIncludeCrc

uint8_t rfc_bleScannerPar_s::bIncludeCrc

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

§ bAppendRssi

uint8_t rfc_bleScannerPar_s::bAppendRssi

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

§ bAppendStatus

uint8_t rfc_bleScannerPar_s::bAppendStatus

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

§ bAppendTimestamp

uint8_t rfc_bleScannerPar_s::bAppendTimestamp

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

§ rxConfig

struct { ... } rfc_bleScannerPar_s::rxConfig

Configuration bits for the receive queue entries.

§ scanFilterPolicy

uint8_t rfc_bleScannerPar_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.

§ bActiveScan

uint8_t rfc_bleScannerPar_s::bActiveScan

0: Passive scan
1: Active scan

§ deviceAddrType

uint8_t rfc_bleScannerPar_s::deviceAddrType

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

§ rpaFilterPolicy

uint8_t rfc_bleScannerPar_s::rpaFilterPolicy

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

§ bStrictLenFilter

uint8_t rfc_bleScannerPar_s::bStrictLenFilter

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

§ bAutoWlIgnore

uint8_t rfc_bleScannerPar_s::bAutoWlIgnore

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

§ bEndOnRpt

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

§ rpaMode

uint8_t rfc_bleScannerPar_s::rpaMode

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

§ scanConfig

struct { ... } rfc_bleScannerPar_s::scanConfig

§ randomState

uint16_t rfc_bleScannerPar_s::randomState

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

§ backoffCount

uint16_t rfc_bleScannerPar_s::backoffCount

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

§ logUpperLimit

uint8_t rfc_bleScannerPar_s::logUpperLimit

Binary logarithm of parameter upperLimit used in scanner backoff procedure.

§ bLastSucceeded

uint8_t rfc_bleScannerPar_s::bLastSucceeded

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

§ bLastFailed

uint8_t rfc_bleScannerPar_s::bLastFailed

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

§ backoffPar

struct { ... } rfc_bleScannerPar_s::backoffPar

§ scanReqLen

uint8_t rfc_bleScannerPar_s::scanReqLen

Size of scan request data.

§ pScanReqData

uint8_t* rfc_bleScannerPar_s::pScanReqData

Pointer to buffer containing SCAN_REQ data.

§ pDeviceAddress

uint16_t* rfc_bleScannerPar_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.

§ pWhiteList

rfc_bleWhiteListEntry_t* rfc_bleScannerPar_s::pWhiteList

Pointer to white list.

§ __dummy0

uint16_t rfc_bleScannerPar_s::__dummy0

§ triggerType

uint8_t rfc_bleScannerPar_s::triggerType

The type of trigger.

§ bEnaCmd

uint8_t rfc_bleScannerPar_s::bEnaCmd

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

§ triggerNo

uint8_t rfc_bleScannerPar_s::triggerNo

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

§ pastTrig

uint8_t rfc_bleScannerPar_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_bleScannerPar_s::timeoutTrigger

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

§ endTrigger

struct { ... } rfc_bleScannerPar_s::endTrigger

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

§ timeoutTime

ratmr_t rfc_bleScannerPar_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_bleScannerPar_s::endTime

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


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