Mistake on this page? Email us
Data Structures

Data Structures

struct  hciConnSpec_t
 Connection specification type. More...
 
struct  hciExtInitParam_t
 Initiating parameters. More...
 
struct  hciExtInitScanParam_t
 Initiating scan parameters. More...
 
struct  hciExtAdvParam_t
 Extended advertising parameters. More...
 
struct  hciExtAdvEnableParam_t
 Extended advertising enable parameters. More...
 
struct  hciExtScanParam_t
 Extended scanning parameters. More...
 

HCI Command Interface Functions

HCI commands

void HciDisconnectCmd (uint16_t handle, uint8_t reason)
 HCI disconnect command. More...
 
void HciLeAddDevWhiteListCmd (uint8_t addrType, uint8_t *pAddr)
 HCI LE add device white list command. More...
 
void HciLeClearWhiteListCmd (void)
 HCI LE clear white list command. More...
 
void HciLeConnUpdateCmd (uint16_t handle, hciConnSpec_t *pConnSpec)
 HCI connection update command. More...
 
void HciLeCreateConnCmd (uint16_t scanInterval, uint16_t scanWindow, uint8_t filterPolicy, uint8_t peerAddrType, uint8_t *pPeerAddr, uint8_t ownAddrType, hciConnSpec_t *pConnSpec)
 HCI LE create connection command. More...
 
void HciLeCreateConnCancelCmd (void)
 HCI LE create connection cancel command. More...
 
void HciLeEncryptCmd (uint8_t *pKey, uint8_t *pData)
 HCI LE encrypt command. More...
 
void HciLeLtkReqNegReplCmd (uint16_t handle)
 HCI LE long term key request negative reply command. More...
 
void HciLeLtkReqReplCmd (uint16_t handle, uint8_t *pKey)
 HCI LE long term key request reply command. More...
 
void HciLeRandCmd (void)
 HCI LE random command. More...
 
void HciLeReadAdvTXPowerCmd (void)
 HCI LE read advertising TX power command. More...
 
void HciLeReadBufSizeCmd (void)
 HCI LE read buffer size command. More...
 
void HciLeReadChanMapCmd (uint16_t handle)
 HCI LE read channel map command. More...
 
void HciLeReadLocalSupFeatCmd (void)
 HCI LE read local supported feautre command. More...
 
void HciLeReadRemoteFeatCmd (uint16_t handle)
 HCI LE read remote feature command. More...
 
void HciLeReadSupStatesCmd (void)
 HCI LE read supported states command. More...
 
void HciLeReadWhiteListSizeCmd (void)
 HCI LE read white list size command. More...
 
void HciLeRemoveDevWhiteListCmd (uint8_t addrType, uint8_t *pAddr)
 HCI LE remove device white list command. More...
 
void HciLeSetAdvEnableCmd (uint8_t enable)
 HCI LE set advanced enable command. More...
 
void HciLeSetAdvDataCmd (uint8_t len, uint8_t *pData)
 HCI LE set advertising data command. More...
 
void HciLeSetAdvParamCmd (uint16_t advIntervalMin, uint16_t advIntervalMax, uint8_t advType, uint8_t ownAddrType, uint8_t peerAddrType, uint8_t *pPeerAddr, uint8_t advChanMap, uint8_t advFiltPolicy)
 HCI LE set advertising parameters command. More...
 
void HciLeSetEventMaskCmd (uint8_t *pLeEventMask)
 HCI LE set event mask command. More...
 
void HciLeSetHostChanClassCmd (uint8_t *pChanMap)
 HCI set host channel class command. More...
 
void HciLeSetRandAddrCmd (uint8_t *pAddr)
 HCI LE set random address command. More...
 
void HciLeSetScanEnableCmd (uint8_t enable, uint8_t filterDup)
 HCI LE set scan enable command. More...
 
void HciLeSetScanParamCmd (uint8_t scanType, uint16_t scanInterval, uint16_t scanWindow, uint8_t ownAddrType, uint8_t scanFiltPolicy)
 HCI set scan parameters command. More...
 
void HciLeSetScanRespDataCmd (uint8_t len, uint8_t *pData)
 HCI LE set scan response data. More...
 
void HciLeStartEncryptionCmd (uint16_t handle, uint8_t *pRand, uint16_t diversifier, uint8_t *pKey)
 HCI LE start encryption command. More...
 
void HciReadBdAddrCmd (void)
 HCI read BD address command. More...
 
void HciReadBufSizeCmd (void)
 HCI read buffer size command. More...
 
void HciReadLocalSupFeatCmd (void)
 HCI read local supported feature command. More...
 
void HciReadLocalVerInfoCmd (void)
 HCI read local version info command. More...
 
void HciReadRemoteVerInfoCmd (uint16_t handle)
 HCI read remote version info command. More...
 
void HciReadRssiCmd (uint16_t handle)
 HCI read RSSI command. More...
 
void HciReadTxPwrLvlCmd (uint16_t handle, uint8_t type)
 HCI read Tx power level command. More...
 
void HciResetCmd (void)
 HCI reset command. More...
 
void HciSetEventMaskCmd (uint8_t *pEventMask)
 HCI set event mask command. More...
 
void HciSetEventMaskPage2Cmd (uint8_t *pEventMask)
 HCI set event page 2 mask command. More...
 
void HciReadAuthPayloadTimeout (uint16_t handle)
 HCI read authenticated payload timeout command. More...
 
void HciWriteAuthPayloadTimeout (uint16_t handle, uint16_t timeout)
 HCI write authenticated payload timeout command. More...
 
void HciLeAddDeviceToResolvingListCmd (uint8_t peerAddrType, const uint8_t *pPeerIdentityAddr, const uint8_t *pPeerIrk, const uint8_t *pLocalIrk)
 HCI add device to resolving list command. More...
 
void HciLeRemoveDeviceFromResolvingList (uint8_t peerAddrType, const uint8_t *pPeerIdentityAddr)
 HCI remove device from resolving list command. More...
 
void HciLeClearResolvingList (void)
 HCI clear resolving list command. More...
 
void HciLeReadResolvingListSize (void)
 HCI read resolving list command. More...
 
void HciLeReadPeerResolvableAddr (uint8_t addrType, const uint8_t *pIdentityAddr)
 HCI read peer resolvable address command. More...
 
void HciLeReadLocalResolvableAddr (uint8_t addrType, const uint8_t *pIdentityAddr)
 HCI read local resolvable address command. More...
 
void HciLeSetAddrResolutionEnable (uint8_t enable)
 HCI enable or disable address resolution command. More...
 
void HciLeSetResolvablePrivateAddrTimeout (uint16_t rpaTimeout)
 HCI set resolvable private address timeout command. More...
 
void HciLeSetPrivacyModeCmd (uint8_t addrType, uint8_t *pAddr, uint8_t mode)
 HCI LE set privacy mode command. More...
 
void HciLeReadPhyCmd (uint16_t handle)
 HCI read PHY command. More...
 
void HciLeSetDefaultPhyCmd (uint8_t allPhys, uint8_t txPhys, uint8_t rxPhys)
 HCI set default PHY command. More...
 
void HciLeSetPhyCmd (uint16_t handle, uint8_t allPhys, uint8_t txPhys, uint8_t rxPhys, uint16_t phyOptions)
 HCI set PHY command. More...
 
void HciVendorSpecificCmd (uint16_t opcode, uint8_t len, uint8_t *pData)
 HCI vencor specific command. More...
 
void HciLeRemoteConnParamReqReply (uint16_t handle, uint16_t intervalMin, uint16_t intervalMax, uint16_t latency, uint16_t timeout, uint16_t minCeLen, uint16_t maxCeLen)
 HCI Remote Connection Parameter Request Reply. More...
 
void HciLeRemoteConnParamReqNegReply (uint16_t handle, uint8_t reason)
 HCI Remote Connection Parameter Request Negative Reply. More...
 
void HciLeSetDataLen (uint16_t handle, uint16_t txOctets, uint16_t txTime)
 HCI LE Set Data Length. More...
 
void HciLeReadDefDataLen (void)
 HCI LE Read Default Data Length. More...
 
void HciLeWriteDefDataLen (uint16_t suggestedMaxTxOctets, uint16_t suggestedMaxTxTime)
 HCI LE Write Default Data Length. More...
 
void HciLeReadLocalP256PubKey (void)
 HCI LE Read Local P-256 Public Key. More...
 
void HciLeGenerateDHKey (uint8_t *pPubKeyX, uint8_t *pPubKeyY)
 HCI LE Generate DH Key. More...
 
void HciLeGenerateDHKeyV2 (uint8_t *pPubKeyX, uint8_t *pPubKeyY, uint8_t keyType)
 HCI LE Generate DH Key Version 2. More...
 
void HciLeReadMaxDataLen (void)
 HCI LE Read Maximum Data Length. More...
 
void HciLeReadTxPower (void)
 HCI LE read transmit power command. More...
 
void HciLeReadRfPathComp (void)
 HCI LE read RF path compensation command. More...
 
void HciLeWriteRfPathComp (int16_t txPathComp, int16_t rxPathComp)
 HCI LE write RF path compensation command. More...
 

HCI AE Advertiser Interface

HCI Advertising Extension functions used by the Advertiser role.

void HciLeSetAdvSetRandAddrCmd (uint8_t advHandle, const uint8_t *pAddr)
 HCI LE set advertising set random device address command. More...
 
void HciLeSetExtAdvParamCmd (uint8_t advHandle, hciExtAdvParam_t *pExtAdvParam)
 HCI LE set extended advertising parameters command. More...
 
void HciLeSetExtAdvDataCmd (uint8_t advHandle, uint8_t op, uint8_t fragPref, uint8_t len, const uint8_t *pData)
 HCI LE set extended advertising data command. More...
 
void HciLeSetExtScanRespDataCmd (uint8_t advHandle, uint8_t op, uint8_t fragPref, uint8_t len, const uint8_t *pData)
 HCI LE set extended scan response data command. More...
 
void HciLeSetExtAdvEnableCmd (uint8_t enable, uint8_t numSets, hciExtAdvEnableParam_t *pEnableParam)
 HCI LE set extended advertising enable command. More...
 
void HciLeReadMaxAdvDataLen (void)
 HCI LE read maximum advertising data length command. More...
 
void HciLeReadNumSupAdvSets (void)
 HCI LE read number of supported advertising sets command. More...
 
void HciLeRemoveAdvSet (uint8_t advHandle)
 HCI LE remove advertising set command. More...
 
void HciLeClearAdvSets (void)
 HCI LE clear advertising sets command. More...
 
void HciLeSetPerAdvParamCmd (uint8_t advHandle, uint16_t advIntervalMin, uint16_t advIntervalMax, uint16_t advProps)
 HCI LE set periodic advertising parameters command. More...
 
void HciLeSetPerAdvDataCmd (uint8_t advHandle, uint8_t op, uint8_t len, const uint8_t *pData)
 HCI LE set periodic advertising data command. More...
 
void HciLeSetPerAdvEnableCmd (uint8_t enable, uint8_t advHandle)
 HCI LE set periodic advertising enable command. More...
 

HCI AE Scanner Interface

HCI Advertising Extension functions used in the Scanner role.

void HciLeSetExtScanParamCmd (uint8_t ownAddrType, uint8_t scanFiltPolicy, uint8_t scanPhys, hciExtScanParam_t *pScanParam)
 HCI LE set extended scanning parameters command. More...
 
void HciLeExtScanEnableCmd (uint8_t enable, uint8_t filterDup, uint16_t duration, uint16_t period)
 HCI LE extended scan enable command. More...
 
void HciLeExtCreateConnCmd (hciExtInitParam_t *pInitParam, hciExtInitScanParam_t *pScanParam, hciConnSpec_t *pConnSpec)
 HCI LE extended create connection command. More...
 
void HciLePerAdvCreateSyncCmd (uint8_t options, uint8_t advSid, uint8_t advAddrType, uint8_t *pAdvAddr, uint16_t skip, uint16_t syncTimeout, uint8_t unused)
 HCI LE periodic advertising create sync command. More...
 
void HciLePerAdvCreateSyncCancelCmd (void)
 HCI LE periodic advertising create sync cancel command. More...
 
void HciLePerAdvTerminateSyncCmd (uint16_t syncHandle)
 HCI LE periodic advertising terminate sync command. More...
 
void HciLeAddDeviceToPerAdvListCmd (uint8_t advAddrType, uint8_t *pAdvAddr, uint8_t advSid)
 HCI LE add device to periodic advertiser list command. More...
 
void HciLeRemoveDeviceFromPerAdvListCmd (uint8_t advAddrType, uint8_t *pAdvAddr, uint8_t advSid)
 HCI LE remove device from periodic advertiser list command. More...
 
void HciLeClearPerAdvListCmd (void)
 HCI LE clear periodic advertiser list command. More...
 
void HciLeReadPerAdvListSizeCmd (void)
 HCI LE read periodic advertiser size command. More...
 
void HciLeSetPerAdvRcvEnableCmd (uint16_t syncHandle, uint8_t enable)
 HCI LE set periodic advertising receive enable command. More...
 
void HciLePerAdvSyncTrsfCmd (uint16_t connHandle, uint16_t serviceData, uint16_t syncHandle)
 HCI LE periodic advertising sync transfer command. More...
 
void HciLePerAdvSetInfoTrsfCmd (uint16_t connHandle, uint16_t serviceData, uint8_t advHandle)
 HCI LE set periodic advertising set info transfer command. More...
 
void HciLeSetPerAdvSyncTrsfParamsCmd (uint16_t connHandle, uint8_t mode, uint16_t skip, uint16_t syncTimeout, uint8_t cteType)
 HCI LE set periodic advertising sync transfer parameters command. More...
 
void HciLeSetDefaultPerAdvSyncTrsfParamsCmd (uint8_t mode, uint16_t skip, uint16_t syncTimeout, uint8_t cteType)
 HCI LE set default periodic advertising sync transfer parameters command. More...
 
void HciLeSetConnCteRxParamsCmd (uint16_t connHandle, uint8_t samplingEnable, uint8_t slotDurations, uint8_t switchPatternLen, uint8_t *pAntennaIDs)
 HCI LE set connection CTE receive parameters command. More...
 
void HciLeSetConnCteTxParamsCmd (uint16_t connHandle, uint8_t cteTypeBits, uint8_t switchPatternLen, uint8_t *pAntennaIDs)
 HCI LE set connection CTE transmit parameters command. More...
 
void HciLeConnCteReqEnableCmd (uint16_t connHandle, uint8_t enable, uint16_t cteReqInt, uint8_t reqCteLen, uint8_t reqCteType)
 HCI LE connection CTE request enable command. More...
 
void HciLeConnCteRspEnableCmd (uint16_t connHandle, uint8_t enable)
 HCI LE connection CTE response enable command. More...
 
void HciLeReadAntennaInfoCmd (void)
 HCI LE read antenna information command. More...
 

Detailed Description

Function Documentation

void HciDisconnectCmd ( uint16_t  handle,
uint8_t  reason 
)

HCI disconnect command.

Parameters
handleConnection handle.
reasonReason for disconnect.
Returns
None.
void HciLeAddDevWhiteListCmd ( uint8_t  addrType,
uint8_t *  pAddr 
)

HCI LE add device white list command.

Parameters
addrTypeAddress type.
pAddrPeer address.
Returns
None.
void HciLeClearWhiteListCmd ( void  )

HCI LE clear white list command.

Returns
None.
void HciLeConnUpdateCmd ( uint16_t  handle,
hciConnSpec_t pConnSpec 
)

HCI connection update command.

Parameters
handleConnection handle.
pConnSpecUpdate connection parameters.
Returns
None.
void HciLeCreateConnCmd ( uint16_t  scanInterval,
uint16_t  scanWindow,
uint8_t  filterPolicy,
uint8_t  peerAddrType,
uint8_t *  pPeerAddr,
uint8_t  ownAddrType,
hciConnSpec_t pConnSpec 
)

HCI LE create connection command.

Parameters
scanIntervalScan interval.
scanWindowScan window.
filterPolicyFilter policy.
peerAddrTypePeer address type.
pPeerAddrPeer address.
ownAddrTypeOwn address type.
pConnSpecConnecdtion parameters.
Returns
None.
void HciLeCreateConnCancelCmd ( void  )

HCI LE create connection cancel command.

Returns
None.
void HciLeEncryptCmd ( uint8_t *  pKey,
uint8_t *  pData 
)

HCI LE encrypt command.

Parameters
pKeyEncryption key.
pDataData to encrypt.
Returns
None.
void HciLeLtkReqNegReplCmd ( uint16_t  handle)

HCI LE long term key request negative reply command.

Parameters
handleConnection handle.
Returns
None.
void HciLeLtkReqReplCmd ( uint16_t  handle,
uint8_t *  pKey 
)

HCI LE long term key request reply command.

Parameters
handleConnection handle.
pKeyLTK.
Returns
None.
void HciLeRandCmd ( void  )

HCI LE random command.

Returns
None.
void HciLeReadAdvTXPowerCmd ( void  )

HCI LE read advertising TX power command.

Returns
None.
void HciLeReadBufSizeCmd ( void  )

HCI LE read buffer size command.

Returns
None.
void HciLeReadChanMapCmd ( uint16_t  handle)

HCI LE read channel map command.

Parameters
handleConnection handle.
Returns
None.
void HciLeReadLocalSupFeatCmd ( void  )

HCI LE read local supported feautre command.

Returns
None.
void HciLeReadRemoteFeatCmd ( uint16_t  handle)

HCI LE read remote feature command.

Parameters
handleConnection handle.
Returns
None.
void HciLeReadSupStatesCmd ( void  )

HCI LE read supported states command.

Returns
None.
void HciLeReadWhiteListSizeCmd ( void  )

HCI LE read white list size command.

Returns
None.
void HciLeRemoveDevWhiteListCmd ( uint8_t  addrType,
uint8_t *  pAddr 
)

HCI LE remove device white list command.

Parameters
addrTypeAddress type.
pAddrPeer address.
Returns
None.
void HciLeSetAdvEnableCmd ( uint8_t  enable)

HCI LE set advanced enable command.

Parameters
enableEnable.
Returns
None.
void HciLeSetAdvDataCmd ( uint8_t  len,
uint8_t *  pData 
)

HCI LE set advertising data command.

Parameters
lenLength of advertising data.
pDataAdvertising data.
Returns
None.
void HciLeSetAdvParamCmd ( uint16_t  advIntervalMin,
uint16_t  advIntervalMax,
uint8_t  advType,
uint8_t  ownAddrType,
uint8_t  peerAddrType,
uint8_t *  pPeerAddr,
uint8_t  advChanMap,
uint8_t  advFiltPolicy 
)

HCI LE set advertising parameters command.

Parameters
advIntervalMinAdveritsing minimum interval.
advIntervalMaxAdvertising maximum interval.
advTypeAdvertising type.
ownAddrTypeOwn address type.
peerAddrTypePeer address type.
pPeerAddrPeer address.
advChanMapAdvertising channel map.
advFiltPolicyAdvertising filter policy.
Returns
None.
void HciLeSetEventMaskCmd ( uint8_t *  pLeEventMask)

HCI LE set event mask command.

Parameters
pLeEventMaskLE Event mask.
Returns
None.
void HciLeSetHostChanClassCmd ( uint8_t *  pChanMap)

HCI set host channel class command.

Parameters
pChanMapChannel map.
Returns
None.
void HciLeSetRandAddrCmd ( uint8_t *  pAddr)

HCI LE set random address command.

Parameters
pAddrRandon address.
Returns
None.
void HciLeSetScanEnableCmd ( uint8_t  enable,
uint8_t  filterDup 
)

HCI LE set scan enable command.

Parameters
enableEnable.
filterDupFilter duplicates.
Returns
None.
void HciLeSetScanParamCmd ( uint8_t  scanType,
uint16_t  scanInterval,
uint16_t  scanWindow,
uint8_t  ownAddrType,
uint8_t  scanFiltPolicy 
)

HCI set scan parameters command.

Parameters
scanTypeScan type.
scanIntervalScan interval.
scanWindowScan window.
ownAddrTypeOwn address type.
scanFiltPolicyScanning filter policy.
Returns
None.
void HciLeSetScanRespDataCmd ( uint8_t  len,
uint8_t *  pData 
)

HCI LE set scan response data.

Parameters
lenScan response data length.
pDataScan response data.
Returns
None.
void HciLeStartEncryptionCmd ( uint16_t  handle,
uint8_t *  pRand,
uint16_t  diversifier,
uint8_t *  pKey 
)

HCI LE start encryption command.

Parameters
handleConnection handle.
pRandRandom number.
diversifierDiversifier.
pKeyEncryption key.
Returns
None.
void HciReadBdAddrCmd ( void  )

HCI read BD address command.

Returns
None.
void HciReadBufSizeCmd ( void  )

HCI read buffer size command.

Returns
None.
void HciReadLocalSupFeatCmd ( void  )

HCI read local supported feature command.

Returns
None.
void HciReadLocalVerInfoCmd ( void  )

HCI read local version info command.

Returns
None.
void HciReadRemoteVerInfoCmd ( uint16_t  handle)

HCI read remote version info command.

Parameters
handleConnection handle.
Returns
None.
void HciReadRssiCmd ( uint16_t  handle)

HCI read RSSI command.

Parameters
handleConnection handle.
Returns
None.
void HciReadTxPwrLvlCmd ( uint16_t  handle,
uint8_t  type 
)

HCI read Tx power level command.

Parameters
handleConnection handle.
typeType.
Returns
None.
void HciResetCmd ( void  )

HCI reset command.

Returns
None.
void HciSetEventMaskCmd ( uint8_t *  pEventMask)

HCI set event mask command.

Parameters
pEventMaskPage 1 of the event mask.
Returns
None.
void HciSetEventMaskPage2Cmd ( uint8_t *  pEventMask)

HCI set event page 2 mask command.

Parameters
pEventMaskPage 2 of the event mask.
Returns
None.
void HciReadAuthPayloadTimeout ( uint16_t  handle)

HCI read authenticated payload timeout command.

Parameters
handleConnection handle.
Returns
None.
void HciWriteAuthPayloadTimeout ( uint16_t  handle,
uint16_t  timeout 
)

HCI write authenticated payload timeout command.

Parameters
handleConnection handle.
timeoutTimeout value.
Returns
None.
void HciLeAddDeviceToResolvingListCmd ( uint8_t  peerAddrType,
const uint8_t *  pPeerIdentityAddr,
const uint8_t *  pPeerIrk,
const uint8_t *  pLocalIrk 
)

HCI add device to resolving list command.

Parameters
peerAddrTypePeer identity address type.
pPeerIdentityAddrPeer identity address.
pPeerIrkPeer IRK.
pLocalIrkLocal IRK.
Returns
None.
void HciLeRemoveDeviceFromResolvingList ( uint8_t  peerAddrType,
const uint8_t *  pPeerIdentityAddr 
)

HCI remove device from resolving list command.

Parameters
peerAddrTypePeer identity address type.
pPeerIdentityAddrPeer identity address.
Returns
None.
void HciLeClearResolvingList ( void  )

HCI clear resolving list command.

Returns
None.
void HciLeReadResolvingListSize ( void  )

HCI read resolving list command.

Returns
None.
void HciLeReadPeerResolvableAddr ( uint8_t  addrType,
const uint8_t *  pIdentityAddr 
)

HCI read peer resolvable address command.

Parameters
addrTypePeer identity address type.
pIdentityAddrPeer identity address.
Returns
None.
void HciLeReadLocalResolvableAddr ( uint8_t  addrType,
const uint8_t *  pIdentityAddr 
)

HCI read local resolvable address command.

Parameters
addrTypePeer identity address type.
pIdentityAddrPeer identity address.
Returns
None.
void HciLeSetAddrResolutionEnable ( uint8_t  enable)

HCI enable or disable address resolution command.

Parameters
enableSet to TRUE to enable address resolution or FALSE to disable address resolution.
Returns
None.
void HciLeSetResolvablePrivateAddrTimeout ( uint16_t  rpaTimeout)

HCI set resolvable private address timeout command.

Parameters
rpaTimeoutTimeout measured in seconds.
Returns
None.
void HciLeSetPrivacyModeCmd ( uint8_t  addrType,
uint8_t *  pAddr,
uint8_t  mode 
)

HCI LE set privacy mode command.

Parameters
addrTypePeer identity address type.
pAddrPeer identity address.
modePrivacy mode.
Returns
None.
void HciLeReadPhyCmd ( uint16_t  handle)

HCI read PHY command.

Parameters
handleConnection handle.
Returns
None.
void HciLeSetDefaultPhyCmd ( uint8_t  allPhys,
uint8_t  txPhys,
uint8_t  rxPhys 
)

HCI set default PHY command.

Parameters
allPhysAll PHYs.
txPhysTx PHYs.
rxPhysRx PHYs.
Returns
None.
void HciLeSetPhyCmd ( uint16_t  handle,
uint8_t  allPhys,
uint8_t  txPhys,
uint8_t  rxPhys,
uint16_t  phyOptions 
)

HCI set PHY command.

Parameters
handleConnection handle.
allPhysAll PHYs.
txPhysTx PHYs.
rxPhysRx PHYs.
phyOptionsPHY options.
Returns
None.
void HciVendorSpecificCmd ( uint16_t  opcode,
uint8_t  len,
uint8_t *  pData 
)

HCI vencor specific command.

Parameters
opcodeOpcode.
lenLength of pData.
pDataCommand data.
Returns
None.
void HciLeRemoteConnParamReqReply ( uint16_t  handle,
uint16_t  intervalMin,
uint16_t  intervalMax,
uint16_t  latency,
uint16_t  timeout,
uint16_t  minCeLen,
uint16_t  maxCeLen 
)

HCI Remote Connection Parameter Request Reply.

Parameters
handleConnection handle.
intervalMinInterval minimum.
intervalMaxInterval maximum.
latencyConnection latency.
timeoutConnection timeout.
minCeLenMinimum connection event length.
maxCeLenMaximum connection event length.
Returns
None.
void HciLeRemoteConnParamReqNegReply ( uint16_t  handle,
uint8_t  reason 
)

HCI Remote Connection Parameter Request Negative Reply.

Parameters
handleConnection handle.
reasonNegative reply reason.
Returns
None.
void HciLeSetDataLen ( uint16_t  handle,
uint16_t  txOctets,
uint16_t  txTime 
)

HCI LE Set Data Length.

Parameters
handleConnection handle.
txOctetsTx octets.
txTimeTx time.
Returns
None.
void HciLeReadDefDataLen ( void  )

HCI LE Read Default Data Length.

Returns
None.
void HciLeWriteDefDataLen ( uint16_t  suggestedMaxTxOctets,
uint16_t  suggestedMaxTxTime 
)

HCI LE Write Default Data Length.

Parameters
suggestedMaxTxOctetsSuggested maximum Tx octets.
suggestedMaxTxTimeSuggested maximum Tx time.
Returns
None.
void HciLeReadLocalP256PubKey ( void  )

HCI LE Read Local P-256 Public Key.

Returns
None.
void HciLeGenerateDHKey ( uint8_t *  pPubKeyX,
uint8_t *  pPubKeyY 
)

HCI LE Generate DH Key.

Parameters
pPubKeyXPublic key X-coordinate.
pPubKeyYPublic key Y-coordinate.
Returns
None.
void HciLeGenerateDHKeyV2 ( uint8_t *  pPubKeyX,
uint8_t *  pPubKeyY,
uint8_t  keyType 
)

HCI LE Generate DH Key Version 2.

Parameters
pPubKeyXPublic key X-coordinate.
pPubKeyYPublic key Y-coordinate.
keyTypeKey type.
Returns
None.
void HciLeReadMaxDataLen ( void  )

HCI LE Read Maximum Data Length.

Returns
None.
void HciLeReadTxPower ( void  )

HCI LE read transmit power command.

Returns
None.
void HciLeReadRfPathComp ( void  )

HCI LE read RF path compensation command.

Returns
None.
void HciLeWriteRfPathComp ( int16_t  txPathComp,
int16_t  rxPathComp 
)

HCI LE write RF path compensation command.

Parameters
txPathCompRF transmit path compensation value.
rxPathCompRF receive path compensation value.
Returns
None.
void HciLeSetAdvSetRandAddrCmd ( uint8_t  advHandle,
const uint8_t *  pAddr 
)

HCI LE set advertising set random device address command.

Parameters
advHandleAdvertising handle.
pAddrRandom device address.
Returns
None.
void HciLeSetExtAdvParamCmd ( uint8_t  advHandle,
hciExtAdvParam_t pExtAdvParam 
)

HCI LE set extended advertising parameters command.

Parameters
advHandleAdvertising handle.
pExtAdvParamExtended advertising parameters.
Returns
None.
void HciLeSetExtAdvDataCmd ( uint8_t  advHandle,
uint8_t  op,
uint8_t  fragPref,
uint8_t  len,
const uint8_t *  pData 
)

HCI LE set extended advertising data command.

Parameters
advHandleAdvertising handle.
opOperation.
fragPrefFragment preference.
lenData buffer length.
pDataAdvertising data buffer.
Returns
None.
void HciLeSetExtScanRespDataCmd ( uint8_t  advHandle,
uint8_t  op,
uint8_t  fragPref,
uint8_t  len,
const uint8_t *  pData 
)

HCI LE set extended scan response data command.

Parameters
advHandleAdvertising handle.
opOperation.
fragPrefFragment preference.
lenData buffer length.
pDataScan response data buffer.
Returns
None.
void HciLeSetExtAdvEnableCmd ( uint8_t  enable,
uint8_t  numSets,
hciExtAdvEnableParam_t pEnableParam 
)

HCI LE set extended advertising enable command.

Parameters
enableSet to TRUE to enable advertising, FALSE to disable advertising.
numSetsNumber of advertising sets.
pEnableParamAdvertising enable parameter array.
Returns
None.
void HciLeReadMaxAdvDataLen ( void  )

HCI LE read maximum advertising data length command.

Returns
None.
void HciLeReadNumSupAdvSets ( void  )

HCI LE read number of supported advertising sets command.

Returns
None.
void HciLeRemoveAdvSet ( uint8_t  advHandle)

HCI LE remove advertising set command.

Parameters
advHandleAdvertising handle.
Returns
Status error code.
void HciLeClearAdvSets ( void  )

HCI LE clear advertising sets command.

Returns
None.
void HciLeSetPerAdvParamCmd ( uint8_t  advHandle,
uint16_t  advIntervalMin,
uint16_t  advIntervalMax,
uint16_t  advProps 
)

HCI LE set periodic advertising parameters command.

Parameters
advHandleAdvertising handle.
advIntervalMinPeriodic advertising interval minimum.
advIntervalMaxPeriodic advertising interval maximum.
advPropsPeriodic advertising properties.
Returns
None.
void HciLeSetPerAdvDataCmd ( uint8_t  advHandle,
uint8_t  op,
uint8_t  len,
const uint8_t *  pData 
)

HCI LE set periodic advertising data command.

Parameters
advHandleAdvertising handle.
opOperation.
lenData buffer length.
pDataAdvertising data buffer.
Returns
None.
void HciLeSetPerAdvEnableCmd ( uint8_t  enable,
uint8_t  advHandle 
)

HCI LE set periodic advertising enable command.

Parameters
enableSet to TRUE to enable advertising, FALSE to disable advertising.
advHandleAdvertising handle.
Returns
None.
void HciLeSetExtScanParamCmd ( uint8_t  ownAddrType,
uint8_t  scanFiltPolicy,
uint8_t  scanPhys,
hciExtScanParam_t pScanParam 
)

HCI LE set extended scanning parameters command.

Parameters
ownAddrTypeAddress type used by this device.
scanFiltPolicyScan filter policy.
scanPhysScanning PHYs.
pScanParamScanning parameter array.
Returns
None.
void HciLeExtScanEnableCmd ( uint8_t  enable,
uint8_t  filterDup,
uint16_t  duration,
uint16_t  period 
)

HCI LE extended scan enable command.

Parameters
enableSet to TRUE to enable scanning, FALSE to disable scanning.
filterDupSet to TRUE to filter duplicates.
durationDuration.
periodPeriod.
Returns
None.
void HciLeExtCreateConnCmd ( hciExtInitParam_t pInitParam,
hciExtInitScanParam_t pScanParam,
hciConnSpec_t pConnSpec 
)

HCI LE extended create connection command.

Parameters
pInitParamInitiating parameters.
pScanParamInitiating scan parameters.
pConnSpecConnection specification.
Returns
None.
void HciLePerAdvCreateSyncCmd ( uint8_t  options,
uint8_t  advSid,
uint8_t  advAddrType,
uint8_t *  pAdvAddr,
uint16_t  skip,
uint16_t  syncTimeout,
uint8_t  unused 
)

HCI LE periodic advertising create sync command.

Parameters
optionsoptions.
advSidAdvertising SID.
advAddrTypeAdvertiser address type.
pAdvAddrAdvertiser address.
skipNumber of periodic advertising packets that can be skipped after successful receive.
syncTimeoutSynchronization timeout.
unusedReserved for future use (must be zero).
Returns
None.
void HciLePerAdvCreateSyncCancelCmd ( void  )

HCI LE periodic advertising create sync cancel command.

Returns
None.
void HciLePerAdvTerminateSyncCmd ( uint16_t  syncHandle)

HCI LE periodic advertising terminate sync command.

Parameters
syncHandleSync handle.
Returns
None.
void HciLeAddDeviceToPerAdvListCmd ( uint8_t  advAddrType,
uint8_t *  pAdvAddr,
uint8_t  advSid 
)

HCI LE add device to periodic advertiser list command.

Parameters
advAddrTypeAdvertiser address type.
pAdvAddrAdvertiser address.
advSidAdvertising SID.
Returns
None.
void HciLeRemoveDeviceFromPerAdvListCmd ( uint8_t  advAddrType,
uint8_t *  pAdvAddr,
uint8_t  advSid 
)

HCI LE remove device from periodic advertiser list command.

Parameters
advAddrTypeAdvertiser address type.
pAdvAddrAdvertiser address.
advSidAdvertising SID.
Returns
None.
void HciLeClearPerAdvListCmd ( void  )

HCI LE clear periodic advertiser list command.

Returns
None.
void HciLeReadPerAdvListSizeCmd ( void  )

HCI LE read periodic advertiser size command.

Returns
None.
void HciLeSetPerAdvRcvEnableCmd ( uint16_t  syncHandle,
uint8_t  enable 
)

HCI LE set periodic advertising receive enable command.

Parameters
syncHandlePeriodic sync handle.
enableTRUE to enable reports, FALSE to disable reports.
Returns
None.
void HciLePerAdvSyncTrsfCmd ( uint16_t  connHandle,
uint16_t  serviceData,
uint16_t  syncHandle 
)

HCI LE periodic advertising sync transfer command.

Parameters
connHandleConnection handle.
serviceDataService data provided by the host.
syncHandlePeriodic sync handle.
Returns
None.
void HciLePerAdvSetInfoTrsfCmd ( uint16_t  connHandle,
uint16_t  serviceData,
uint8_t  advHandle 
)

HCI LE set periodic advertising set info transfer command.

Parameters
connHandleConnection handle.
serviceDataService data provided by the host.
advHandleHandle to identify an advertising set.
Returns
None.
void HciLeSetPerAdvSyncTrsfParamsCmd ( uint16_t  connHandle,
uint8_t  mode,
uint16_t  skip,
uint16_t  syncTimeout,
uint8_t  cteType 
)

HCI LE set periodic advertising sync transfer parameters command.

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
None.
void HciLeSetDefaultPerAdvSyncTrsfParamsCmd ( uint8_t  mode,
uint16_t  skip,
uint16_t  syncTimeout,
uint8_t  cteType 
)

HCI LE set default periodic advertising sync transfer parameters command.

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
None.
void HciLeSetConnCteRxParamsCmd ( uint16_t  connHandle,
uint8_t  samplingEnable,
uint8_t  slotDurations,
uint8_t  switchPatternLen,
uint8_t *  pAntennaIDs 
)

HCI LE set connection CTE receive parameters command.

Parameters
connHandleConnection handle.
samplingEnableTRUE to enable Connection IQ sampling, FALSE to disable it.
slotDurationsSwitching and sampling slot durations to be used while receiving CTE.
switchPatternLenNumber of Antenna IDs in switching pattern.
pAntennaIDsList of Antenna IDs in switching pattern.
Returns
None.
void HciLeSetConnCteTxParamsCmd ( uint16_t  connHandle,
uint8_t  cteTypeBits,
uint8_t  switchPatternLen,
uint8_t *  pAntennaIDs 
)

HCI LE set connection CTE transmit parameters command.

Parameters
connHandleConnection handle.
cteTypeBitsPermitted CTE type bits used for transmitting CTEs requested by peer.
switchPatternLenNumber of Antenna IDs in switching pattern.
pAntennaIDsList of Antenna IDs in switching pattern.
Returns
None.
void HciLeConnCteReqEnableCmd ( uint16_t  connHandle,
uint8_t  enable,
uint16_t  cteReqInt,
uint8_t  reqCteLen,
uint8_t  reqCteType 
)

HCI LE connection CTE request enable command.

Parameters
connHandleConnection handle.
enableTRUE to enable CTE request for connection, FALSE to disable it.
cteReqIntCTE request interval.
reqCteLenMinimum length of CTE being requested in 8 us units.
reqCteTypeRequested CTE type.
Returns
None.
void HciLeConnCteRspEnableCmd ( uint16_t  connHandle,
uint8_t  enable 
)

HCI LE connection CTE response enable command.

Parameters
connHandleConnection handle.
enableTRUE to enable CTE response for connection, FALSE to disable it.
Returns
None.
void HciLeReadAntennaInfoCmd ( void  )

HCI LE read antenna information command.

Returns
None.
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.