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

Data Structures

struct  LlExtAdvParam_t
 Extended advertising parameters. More...
 
struct  LlExtAdvEnableParam_t
 Extended advertising enable parameters. More...
 
struct  LlPerAdvParam_t
 Periodic advertising parameters. More...
 

Macros

#define LL_ADDR_RANDOM_BIT   LL_ADDR_RANDOM
 
#define LL_ADDR_IDENTITY_BIT   LL_ADDR_PUBLIC_IDENTITY
 
#define LL_ADV_EVT_PROP_NON_CONN_NON_SCAN   0
 

Enumerations

Functions

void LlSetAdvTxPower (int8_t advTxPwr)
 Set advertising transmit power. More...
 
uint8_t LlGetAdvTxPower (int8_t *pAdvTxPwr)
 Get advertising transmit power. More...
 
uint8_t LlSetAdvParam (uint16_t advIntervalMin, uint16_t advIntervalMax, uint8_t advType, uint8_t ownAddrType, uint8_t peerAddrType, const uint8_t *pPeerAddr, uint8_t advChanMap, uint8_t advFiltPolicy)
 Set advertising parameter. More...
 
uint8_t LlSetAdvData (uint8_t len, const uint8_t *pData)
 Set advertising data. More...
 
uint8_t LlSetScanRespData (uint8_t len, const uint8_t *pData)
 Set scan response data. More...
 
void LlAdvEnable (uint8_t enable)
 Advertising enable. More...
 
uint8_t LlSetAdvSetRandAddr (uint8_t handle, const uint8_t *pAddr)
 Set advertising set random device address. More...
 
uint64_t LlGetPeriodicChanMap (uint16_t handle, bool_t isAdv)
 Get periodic channel map. More...
 
uint8_t LlGetAdvSetRandAddr (uint8_t handle, uint8_t *pAddr)
 Get advertising set random device address. More...
 
uint8_t LlSetExtAdvParam (uint8_t handle, LlExtAdvParam_t *pExtAdvParam)
 Set extended advertising parameters. More...
 
uint8_t LlGetExtAdvTxPowerLevel (uint16_t handle, int8_t *pLevel)
 Get extended advertising TX power level. More...
 
uint8_t LlSetExtAdvData (uint8_t handle, uint8_t op, uint8_t fragPref, uint8_t len, const uint8_t *pData)
 Set extended advertising data. More...
 
uint8_t LlSetExtScanRespData (uint8_t handle, uint8_t op, uint8_t fragPref, uint8_t len, const uint8_t *pData)
 Set extended scan response data. More...
 
void LlExtAdvEnable (uint8_t enable, uint8_t numAdvSets, LlExtAdvEnableParam_t enaParam[])
 Extended advertising enable. More...
 
uint8_t LlReadMaxAdvDataLen (uint16_t *pLen)
 Read maximum advertising data length. More...
 
uint8_t LlReadNumSupAdvSets (uint8_t *pNumSets)
 Read number of supported advertising sets. More...
 
uint8_t LlRemoveAdvSet (uint8_t handle)
 Remove advertising set. More...
 
uint8_t LlClearAdvSets (void)
 Clear advertising sets. More...
 
uint8_t LlSetPeriodicAdvParam (uint8_t handle, LlPerAdvParam_t *pPerAdvParam)
 Set periodic advertising parameters. More...
 
uint8_t LlSetPeriodicAdvData (uint8_t handle, uint8_t op, uint8_t len, const uint8_t *pData)
 Set periodic advertising data. More...
 
void LlSetPeriodicAdvEnable (uint8_t enable, uint8_t handle)
 Set periodic advertising enable. More...
 
uint8_t LlSetAuxOffsetDelay (uint8_t handle, uint32_t delayUsec)
 Set auxiliary packet offset delay. More...
 
uint8_t LlSetExtAdvDataFragLen (uint8_t handle, uint8_t fragLen)
 Set extended advertising data fragmentation length. More...
 
uint8_t LlSetExtAdvTxPhyOptions (uint8_t handle, uint8_t priPhyOpts, uint8_t secPhyOpts)
 Set extended advertising transmit PHY options. More...
 
void LlReadSupTxPower (int8_t *pMinTxPwr, int8_t *pMaxTxPwr)
 Read supported transmit power. More...
 
void LlReadRfPathComp (int16_t *pTxPathComp, int16_t *pRxPathComp)
 Read RF path compensation. More...
 
uint8_t LlWriteRfPathComp (int16_t txPathComp, int16_t rxPathComp)
 Write RF path compensation. More...
 
void LlScanReportEnable (uint8_t enable)
 Scan report enable. More...
 

Detailed Description

Macro Definition Documentation

#define LL_ADDR_IDENTITY_BIT   LL_ADDR_PUBLIC_IDENTITY

Address type identity bit.

Definition at line 329 of file ll_api.h.

#define LL_ADDR_RANDOM_BIT   LL_ADDR_RANDOM

Address type random or public bit.

Definition at line 328 of file ll_api.h.

#define LL_ADV_EVT_PROP_NON_CONN_NON_SCAN   0

Non-connectable and non-scannable advertising.

Definition at line 361 of file ll_api.h.

Enumeration Type Documentation

anonymous enum

The advertising type indicates the connectable and discoverable nature of the advertising packets transmitted by a device.

Enumerator
LL_ADV_CONN_UNDIRECT 

Connectable undirected advertising. Peer devices can scan and connect to this device.

LL_ADV_CONN_DIRECT_HIGH_DUTY 

Connectable directed advertising, high duty cycle. Only a specified peer device can connect to this device.

LL_ADV_SCAN_UNDIRECT 

Scannable undirected advertising. Peer devices can scan this device but cannot connect.

LL_ADV_NONCONN_UNDIRECT 

Non-connectable undirected advertising. Peer devices cannot scan or connect to this device.

LL_ADV_CONN_DIRECT_LOW_DUTY 

Connectable directed advertising, low duty cycle. Only a specified peer device can connect to this device.

Definition at line 308 of file ll_api.h.

anonymous enum

The address type indicates whether an address is public or random.

Enumerator
LL_ADDR_PUBLIC 

Public address.

LL_ADDR_RANDOM 

Random address.

LL_ADDR_PUBLIC_IDENTITY 

Public identity address.

LL_ADDR_RANDOM_IDENTITY 

Random (static) identity address.

LL_ADDR_RANDOM_UNRESOLVABLE 

Un-resolvable random address.

LL_ADDR_ANONYMOUS 

Anonymous advertiser.

Definition at line 318 of file ll_api.h.

anonymous enum

Advertising channel bit.

Enumerator
LL_ADV_CHAN_37_BIT 

Advertising channel 37.

LL_ADV_CHAN_38_BIT 

Advertising channel 38.

LL_ADV_CHAN_39_BIT 

Advertising channel 39.

LL_ADV_CHAN_ALL 

All advertising channels.

Definition at line 332 of file ll_api.h.

anonymous enum

Advertising filter policy.

Enumerator
LL_ADV_FILTER_NONE 

Scan from any device.

LL_ADV_FILTER_SCAN_WL_BIT 

Scan from White List only.

LL_ADV_FILTER_CONN_WL_BIT 

Connect from While List only.

LL_ADV_FILTER_WL_ONLY 

Scan and connect from While List only.

Definition at line 341 of file ll_api.h.

anonymous enum

Advertising event properties.

Enumerator
LL_ADV_EVT_PROP_CONN_ADV_BIT 

Connectable advertising.

LL_ADV_EVT_PROP_SCAN_ADV_BIT 

Scannable advertising.

LL_ADV_EVT_PROP_DIRECT_ADV_BIT 

Directed advertising.

LL_ADV_EVT_PROP_HIGH_DUTY_ADV_BIT 

High Duty Cycle advertising.

LL_ADV_EVT_PROP_LEGACY_ADV_BIT 

Use legacy advertising PDUs.

LL_ADV_EVT_PROP_OMIT_AA_BIT 

Omit advertiser's address from all PDUs (anonymous advertising).

LL_ADV_EVT_PROP_TX_PWR_BIT 

Include TxPower in the advertising PDU.

Definition at line 350 of file ll_api.h.

anonymous enum

Advertising data operation.

Enumerator
LL_ADV_DATA_OP_FRAG_INTER 

Intermediate fragment.

LL_ADV_DATA_OP_FRAG_FIRST 

First fragment.

LL_ADV_DATA_OP_FRAG_LAST 

Last fragment.

LL_ADV_DATA_OP_COMP 

Complete extended advertising data.

LL_ADV_DATA_OP_UNCHANGED 

Unchanged data (just update the Advertising DID).

Definition at line 399 of file ll_api.h.

anonymous enum

Advertising data fragment preference.

Enumerator
LL_ADV_DATA_FRAG_ALLOW 

Controller may fragment all Host advertising data.

LL_ADV_DATA_FRAG_DISALLOW 

Controller should not fragment nor minimize fragmentation of Host advertising data.

Definition at line 409 of file ll_api.h.

Function Documentation

void LlAdvEnable ( uint8_t  enable)

Advertising enable.

Parameters
enableSet to TRUE to enable advertising, FALSE to disable advertising.

Enable or disable advertising.

uint8_t LlClearAdvSets ( void  )

Clear advertising sets.

Returns
Status error code.

Remove all existing advertising sets from the LL.

void LlExtAdvEnable ( uint8_t  enable,
uint8_t  numAdvSets,
LlExtAdvEnableParam_t  enaParam[] 
)

Extended advertising enable.

Parameters
enableSet to TRUE to enable advertising, FALSE to disable advertising.
numAdvSetsNumber of elements in enaParam[].
enaParamEnable parameter table.

Enable or disable extended advertising.

uint8_t LlGetAdvSetRandAddr ( uint8_t  handle,
uint8_t *  pAddr 
)

Get advertising set random device address.

Parameters
handleAdvertising handle.
pAddrRandom Bluetooth device address.
Returns
Status error code.

Get the random address to be used by a advertising set.

uint8_t LlGetAdvTxPower ( int8_t *  pAdvTxPwr)

Get advertising transmit power.

Parameters
pAdvTxPwrAdvertising transmit power level.
Returns
Status error code.

Return the advertising transmit power.

uint8_t LlGetExtAdvTxPowerLevel ( uint16_t  handle,
int8_t *  pLevel 
)

Get extended advertising TX power level.

Parameters
handleAdvertising handle.
pLevelTransmit power level.
Returns
Status error code.

Get the TX power of an advertising set.

uint64_t LlGetPeriodicChanMap ( uint16_t  handle,
bool_t  isAdv 
)

Get periodic channel map.

Parameters
handlePeriodic advertiser/scanner handle.
isAdvTRUE for periodic advertiser, FALSE for periodic scanner.
Returns
64-bit formatted channel mask.

Get the 64-bit channel mask of the channel map

uint8_t LlReadMaxAdvDataLen ( uint16_t *  pLen)

Read maximum advertising data length.

Parameters
pLenReturn buffer for Maximum data length.
Returns
Status error code.

Read maximum advertising data length.

uint8_t LlReadNumSupAdvSets ( uint8_t *  pNumSets)

Read number of supported advertising sets.

Parameters
pNumSetsReturn buffer for number of advertising sets.
Returns
Status error code.

Read number of supported advertising sets.

void LlReadRfPathComp ( int16_t *  pTxPathComp,
int16_t *  pRxPathComp 
)

Read RF path compensation.

Parameters
pTxPathCompReturn buffer for RF transmit path compensation value.
pRxPathCompReturn buffer for RF receive path compensation value.

Read the RF Path Compensation Values parameter used in the Tx Power Level and RSSI calculation.

void LlReadSupTxPower ( int8_t *  pMinTxPwr,
int8_t *  pMaxTxPwr 
)

Read supported transmit power.

Parameters
pMinTxPwrReturn buffer for minimum transmit power.
pMaxTxPwrReturn buffer for maximum transmit power.

Read the minimum and maximum transmit powers supported by the LL.

uint8_t LlRemoveAdvSet ( uint8_t  handle)

Remove advertising set.

Parameters
handleAdvertising handle.
Returns
Status error code.

Removes the an advertising set from the LL.

void LlScanReportEnable ( uint8_t  enable)

Scan report enable.

Parameters
enableSet to TRUE to enable scan reports, FALSE to disable scan reports.

Enable or disable reports about the scanners from which an advertiser receives scan requests.

uint8_t LlSetAdvData ( uint8_t  len,
const uint8_t *  pData 
)

Set advertising data.

Parameters
lenData buffer length.
pDataAdvertising data buffer.
Returns
Status error code.

Set advertising data data.

uint8_t LlSetAdvParam ( uint16_t  advIntervalMin,
uint16_t  advIntervalMax,
uint8_t  advType,
uint8_t  ownAddrType,
uint8_t  peerAddrType,
const uint8_t *  pPeerAddr,
uint8_t  advChanMap,
uint8_t  advFiltPolicy 
)

Set advertising parameter.

Parameters
advIntervalMinMinimum advertising interval.
advIntervalMaxMaximum advertising interval.
advTypeAdvertising type.
ownAddrTypeAddress type used by this device.
peerAddrTypeAddress type of peer device. Only used for directed advertising.
pPeerAddrAddress of peer device. Only used for directed advertising.
advChanMapAdvertising channel map.
advFiltPolicyAdvertising filter policy.
Returns
Status error code.

Set advertising parameters.

Note
This function must only be called when advertising is disabled.
uint8_t LlSetAdvSetRandAddr ( uint8_t  handle,
const uint8_t *  pAddr 
)

Set advertising set random device address.

Parameters
handleAdvertising handle.
pAddrRandom Bluetooth device address.
Returns
Status error code.

Set the random address to be used by a advertising set.

void LlSetAdvTxPower ( int8_t  advTxPwr)

Set advertising transmit power.

Parameters
advTxPwrAdvertising transmit power level.

Set the advertising transmit power.

uint8_t LlSetAuxOffsetDelay ( uint8_t  handle,
uint32_t  delayUsec 
)

Set auxiliary packet offset delay.

Parameters
handleAdvertising handle.
delayUsecAdditional time in microseconds. "0" to disable.
Returns
Status error code.

Additional delay given to auxiliary packets specified by AuxPtr. Offset values are limited by the advertising interval.

uint8_t LlSetExtAdvData ( uint8_t  handle,
uint8_t  op,
uint8_t  fragPref,
uint8_t  len,
const uint8_t *  pData 
)

Set extended advertising data.

Parameters
handleAdvertising handle.
opOperation.
fragPrefFragment preference.
lenData buffer length.
pDataAdvertising data buffer.
Returns
Status error code.

Set extended advertising data data.

uint8_t LlSetExtAdvDataFragLen ( uint8_t  handle,
uint8_t  fragLen 
)

Set extended advertising data fragmentation length.

Parameters
handleAdvertising handle.
fragLenFragmentation length.
Returns
Status error code.

Fragmentation size for Advertising Data and Scan Response Data when selected by the host.

uint8_t LlSetExtAdvParam ( uint8_t  handle,
LlExtAdvParam_t pExtAdvParam 
)

Set extended advertising parameters.

Parameters
handleAdvertising handle.
pExtAdvParamExtended advertising parameters.
Returns
Status error code.

Set extended advertising parameters.

Note
This function must only be called when advertising for this set is disabled.
uint8_t LlSetExtAdvTxPhyOptions ( uint8_t  handle,
uint8_t  priPhyOpts,
uint8_t  secPhyOpts 
)

Set extended advertising transmit PHY options.

Parameters
handleAdvertising handle.
priPhyOptsPrimary advertising channel PHY options.
secPhyOptsSecondary advertising channel PHY options.
Returns
Status error code.

PHY options for extended advertising transmissions. New values are applied dynamically.

uint8_t LlSetExtScanRespData ( uint8_t  handle,
uint8_t  op,
uint8_t  fragPref,
uint8_t  len,
const uint8_t *  pData 
)

Set extended scan response data.

Parameters
handleAdvertising handle.
opOperation.
fragPrefFragment preference.
lenData buffer length.
pDataScan response data buffer.
Returns
Status error code.

Set extended scan response data.

uint8_t LlSetPeriodicAdvData ( uint8_t  handle,
uint8_t  op,
uint8_t  len,
const uint8_t *  pData 
)

Set periodic advertising data.

Parameters
handleAdvertising handle.
opOperation.
lenData buffer length.
pDataAdvertising data buffer.
Returns
Status error code.

Set periodic advertising data.

void LlSetPeriodicAdvEnable ( uint8_t  enable,
uint8_t  handle 
)

Set periodic advertising enable.

Parameters
enableTRUE to enable advertising, FALSE to disable advertising.
handleAdvertising handle.
Returns
Status error code.

Enable or disable periodic advertising.

uint8_t LlSetPeriodicAdvParam ( uint8_t  handle,
LlPerAdvParam_t pPerAdvParam 
)

Set periodic advertising parameters.

Parameters
handleAdvertising handle.
pPerAdvParamPeriodic advertising parameters.
Returns
Status error code.

Set periodic advertising parameters.

Note
This function must only be called when advertising handle exists.
uint8_t LlSetScanRespData ( uint8_t  len,
const uint8_t *  pData 
)

Set scan response data.

Parameters
lenData buffer length.
pDataScan response data buffer.
Returns
Status error code.

Set scan response data.

uint8_t LlWriteRfPathComp ( int16_t  txPathComp,
int16_t  rxPathComp 
)

Write RF path compensation.

Parameters
txPathCompRF transmit path compensation value.
rxPathCompRF receive path compensation value.
Returns
Status error code.

Indicate the RF path gain or loss between the RF transceiver and the antenna contributed by intermediate components.

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.