Mistake on this page?
Report an issue in GitHub or email us
Data Structures | Macros | Enumerations | Functions
LL_API_OBSERVER

Data Structures

struct  LlScanParam_t
 Scan parameters. More...
 
struct  LlExtScanParam_t
 Extended scan parameters. More...
 
struct  LlPerAdvCreateSyncCmd_t
 Periodic advertising create sync command. More...
 
struct  LlDevicePerAdvList_t
 Device in periodic advertiser list. More...
 

Macros

#define LL_PER_ADV_CREATE_SYNC_OPTIONS_BITS   0x03
 Periodic advertising create sync options valid bits. More...
 

Enumerations

Functions

uint8_t LlSetSetScanChanMap (uint8_t chanMap)
 Set scan channel map. More...
 
uint8_t LlSetScanParam (const LlScanParam_t *pParam)
 Set scan parameters. More...
 
void LlScanEnable (uint8_t enable, uint8_t filterDup)
 Scan enable. More...
 
uint8_t LlSetExtScanParam (uint8_t ownAddrType, uint8_t scanFiltPolicy, uint8_t scanPhys, const LlExtScanParam_t param[])
 Set extended scanning parameters. More...
 
void LlExtScanEnable (uint8_t enable, uint8_t filterDup, uint16_t duration, uint16_t period)
 Extended scan enable. More...
 
uint8_t LlPeriodicAdvCreateSync (const LlPerAdvCreateSyncCmd_t *pParam)
 Create synchronization of periodic advertising. More...
 
uint8_t LlPeriodicAdvCreateSyncCancel (void)
 Cancel pending synchronization of periodic advertising. More...
 
uint8_t LlPeriodicAdvTerminateSync (uint16_t syncHandle)
 Stop synchronization of periodic advertising. More...
 
uint8_t LlAddDeviceToPeriodicAdvList (const LlDevicePerAdvList_t *pParam)
 Add device to periodic advertiser list. More...
 
uint8_t LlRemoveDeviceFromPeriodicAdvList (const LlDevicePerAdvList_t *pParam)
 Remove device from periodic advertiser list command. More...
 
uint8_t LlClearPeriodicAdvList (void)
 Clear all devices in periodic advertiser list command. More...
 
uint8_t LlReadPeriodicAdvListSize (uint8_t *pListSize)
 Read total number of devices in periodic advertiser list command. More...
 
uint8_t LlSetPeriodicAdvRcvEnable (uint16_t syncHandle, uint8_t enable)
 Enable or disable reports for the periodic advertising sync. More...
 
void LlPastInit (void)
 Initialize LL subsystem for PAST(Periodic advertising sync transfer). More...
 
uint8_t LlPeriodicAdvSyncTransfer (uint16_t connHandle, uint16_t serviceData, uint16_t syncHandle)
 Send sync info about periodic advertising to a connected device. More...
 
uint8_t LlPeriodicAdvSetInfoTransfer (uint16_t connHandle, uint16_t serviceData, uint8_t advHandle)
 Send sync info about periodic adv in an advertising set to a connected device. More...
 
uint8_t LlSetPeriodicAdvSyncTransParams (uint16_t connHandle, uint8_t mode, uint16_t skip, uint16_t syncTimeout, uint8_t cteType)
 Set periodic advertising sync transfer parameters. More...
 
uint8_t LlSetDefaultPeriodicAdvSyncTransParams (uint8_t mode, uint16_t skip, uint16_t syncTimeout, uint8_t cteType)
 Set default periodic advertising sync transfer parameters. More...
 

Detailed Description

Macro Definition Documentation

#define LL_PER_ADV_CREATE_SYNC_OPTIONS_BITS   0x03

Periodic advertising create sync options valid bits.

Definition at line 488 of file ll_api.h.

Enumeration Type Documentation

anonymous enum

Type of scan.

Enumerator
LL_SCAN_PASSIVE 

Passive scanning.

LL_SCAN_ACTIVE 

Active scanning.

Definition at line 421 of file ll_api.h.

anonymous enum

Init filter policy.

Enumerator
LL_INIT_FILTER_PEER 

Filter to only Peer addr and addr type.

LL_INIT_FILTER_WL 

Filter to only whitelist.

LL_INIT_FILTER_TOTAL 

Total number of filter policies.

Definition at line 428 of file ll_api.h.

anonymous enum

Scan filter policy.

Enumerator
LL_SCAN_FILTER_NONE 

Accept all advertising packets.

LL_SCAN_FILTER_WL_BIT 

Accept from While List only.

LL_SCAN_FILTER_RES_INIT_BIT 

Accept directed advertisements with RPAs.

LL_SCAN_FILTER_WL_OR_RES_INIT 

Accept from White List or directed advertisements with RPAs.

Definition at line 436 of file ll_api.h.

anonymous enum

Periodic scan filter policy.

Enumerator
LL_PER_SCAN_FILTER_NONE 

Use advSID, advAddrType and advAddr to filter.

LL_PER_SCAN_FILTER_PL_BIT 

Use the periodic advertiser list.

Definition at line 445 of file ll_api.h.

anonymous enum

Scan filter modes for duplicate report.

Enumerator
LL_SCAN_FILTER_DUP_DISABLE 

Duplicate filtering disabled.

LL_SCAN_FILTER_DUP_ENABLE_ONCE 

Duplicate filtering enabled.

LL_SCAN_FILTER_DUP_ENABLE_PERIODIC 

Duplicate filtering enabled, reset for each scan period.

Definition at line 470 of file ll_api.h.

anonymous enum

Advertising report event types.

Enumerator
LL_RPT_TYPE_ADV_IND 

Connectable undirected advertising (ADV_IND).

LL_RPT_TYPE_ADV_DIRECT_IND 

Connectable directed advertising (ADV_DIRECT_IND).

LL_RPT_TYPE_ADV_SCAN_IND 

Scannable undirected advertising (ADV_SCAN_IND).

LL_RPT_TYPE_ADV_NONCONN_IND 

Non connectable undirected advertising (ADV_NONCONN_IND).

LL_RPT_TYPE_SCAN_RSP 

Scan Response (SCAN_RSP).

Definition at line 478 of file ll_api.h.

Function Documentation

uint8_t LlAddDeviceToPeriodicAdvList ( const LlDevicePerAdvList_t pParam)

Add device to periodic advertiser list.

Parameters
pParamAdd to periodic list parameters.
Returns
Status error code.

Add device to periodic advertiser list.

uint8_t LlClearPeriodicAdvList ( void  )

Clear all devices in periodic advertiser list command.

Returns
Status error code.

Clear all devices in periodic advertiser list command.

void LlExtScanEnable ( uint8_t  enable,
uint8_t  filterDup,
uint16_t  duration,
uint16_t  period 
)

Extended scan enable.

Parameters
enableSet to TRUE to enable scanning, FALSE to disable scanning.
filterDupSet to TRUE to filter duplicates.
durationDuration.
periodPeriod.

Enable or disable extended scanning.

void LlPastInit ( void  )

Initialize LL subsystem for PAST(Periodic advertising sync transfer).

This function initializes the LL subsystem for PAST(Periodic advertising sync transfer).

uint8_t LlPeriodicAdvCreateSync ( const LlPerAdvCreateSyncCmd_t pParam)

Create synchronization of periodic advertising.

Parameters
pParamCreate sync parameters.
Returns
Status error code.

Create synchronization of periodic advertising.

uint8_t LlPeriodicAdvCreateSyncCancel ( void  )

Cancel pending synchronization of periodic advertising.

Returns
Status error code.

Cancel pending synchronization of periodic advertising.

uint8_t LlPeriodicAdvSetInfoTransfer ( uint16_t  connHandle,
uint16_t  serviceData,
uint8_t  advHandle 
)

Send sync info about periodic adv in an advertising set to a connected device.

Parameters
connHandleConnection handle.
serviceDataService data provided by the host.
advHandleHandle to identify an advertising set.
Returns
Status error code.

Send sync info about periodic adv in an advertising set to a connected device.

uint8_t LlPeriodicAdvSyncTransfer ( uint16_t  connHandle,
uint16_t  serviceData,
uint16_t  syncHandle 
)

Send sync info about periodic advertising to a connected device.

Parameters
connHandleConnection handle.
serviceDataService data provided by the host.
syncHandlePeriodic sync handle.
Returns
Status error code.

Send sync info about periodic advertising to a connected device.

uint8_t LlPeriodicAdvTerminateSync ( uint16_t  syncHandle)

Stop synchronization of periodic advertising.

Parameters
syncHandleSync handle.
Returns
Status error code.

Stop synchronization of periodic advertising.

uint8_t LlReadPeriodicAdvListSize ( uint8_t *  pListSize)

Read total number of devices in periodic advertiser list command.

Parameters
pListSizeReturn size value of periodic advertiser list
Returns
Status error code.

Read total number of devices in periodic advertiser list command.

uint8_t LlRemoveDeviceFromPeriodicAdvList ( const LlDevicePerAdvList_t pParam)

Remove device from periodic advertiser list command.

Parameters
pParamRemove from periodic list parameters.
Returns
Status error code.
void LlScanEnable ( uint8_t  enable,
uint8_t  filterDup 
)

Scan enable.

Parameters
enableSet to TRUE to enable scanning, FALSE to disable scanning.
filterDupSet to TRUE to filter duplicates.

Enable or disable scanning. This function is only used when operating in master role.

uint8_t LlSetDefaultPeriodicAdvSyncTransParams ( uint8_t  mode,
uint16_t  skip,
uint16_t  syncTimeout,
uint8_t  cteType 
)

Set default periodic advertising sync transfer parameters.

Parameters
modePeriodic sync advertising sync transfer mode.
skipThe number of periodic advertising packets that can be skipped after a successful receive.
syncTimeoutSynchronization timeout for the periodic advertising.
cteTypeConstant tone extension type(Used in AoD/AoA).
Returns
Status error code.

Set default periodic advertising sync transfer parameters.

uint8_t LlSetExtScanParam ( uint8_t  ownAddrType,
uint8_t  scanFiltPolicy,
uint8_t  scanPhys,
const LlExtScanParam_t  param[] 
)

Set extended scanning parameters.

Parameters
ownAddrTypeAddress type used by this device.
scanFiltPolicyScan filter policy.
scanPhysScanning PHYs bitmask.
paramScanning parameter table indexed by PHY.
Returns
Status error code.

Set the extended scan parameters to be used on the primary advertising channel.

uint8_t LlSetPeriodicAdvRcvEnable ( uint16_t  syncHandle,
uint8_t  enable 
)

Enable or disable reports for the periodic advertising sync.

Parameters
syncHandlePeriodic sync handle.
enable1 to enable reports, 0 to disable reports.
Returns
Status error code.

Enable or disable reports for the periodic advertising sync.

uint8_t LlSetPeriodicAdvSyncTransParams ( uint16_t  connHandle,
uint8_t  mode,
uint16_t  skip,
uint16_t  syncTimeout,
uint8_t  cteType 
)

Set periodic advertising sync transfer parameters.

Parameters
connHandleConnection handle.
modePeriodic sync advertising sync transfer mode.
skipThe number of periodic advertising packets that can be skipped after a successful receive.
syncTimeoutSynchronization timeout for the periodic advertising.
cteTypeConstant tone extension type(Used in AoD/AoA).
Returns
Status error code.

Set periodic advertising sync transfer parameters.

uint8_t LlSetScanParam ( const LlScanParam_t pParam)

Set scan parameters.

Parameters
pParamScan parameters.
Returns
Status error code.

Set scan parameters.

Note
This function must only be called when scanning is disabled.
uint8_t LlSetSetScanChanMap ( uint8_t  chanMap)

Set scan channel map.

Parameters
chanMapScan channel map.
Returns
Status error code.

Set scan channel map.

Note
This function must only be called when scanning is disabled.
Important Information for this Arm website

This site uses cookies to store information on your computer. By continuing to use our site, you consent to our cookies. If you are not happy with the use of these cookies, please review our Cookie Policy to learn how they can be disabled. By disabling cookies, some features of the site will not work.