TI BLE5-Stack API Documentation
2.02.08.00
|
This module implements the Host Controller Interface. For a detailed usage section describing how to send these commands and receive events, see the HCI Section of the User's Guide. More...
Modules | |
HCI Events | |
HCI Function Maps | |
Files | |
file | hci_tl.h |
Types, constants, external functions etc. for the BLE HCI Transport Layer. | |
Functions | |
hciStatus_t | HCI_EXT_BuildRevisionCmd (uint8 mode, uint16 userRevNum) |
hciStatus_t | HCI_EXT_CoexEnableCmd (uint8 enable) |
hciStatus_t | HCI_EXT_ConnEventNoticeCmd (uint16 connHandle, uint8 taskID, uint16 taskEvent) |
hciStatus_t | HCI_EXT_DecryptCmd (uint8 *key, uint8 *encText) |
hciStatus_t | HCI_EXT_DisconnectImmedCmd (uint16 connHandle) |
hciStatus_t | HCI_EXT_EnablePTMCmd (void) |
hciStatus_t | HCI_EXT_EndModemTestCmd (void) |
hciStatus_t | HCI_EXT_EnhancedModemHopTestTxCmd (uint8 payloadLen, uint8 payloadType, uint8 rfPhy) |
hciStatus_t | HCI_EXT_EnhancedModemTestRxCmd (uint8 rfPhy, uint8 rfChan) |
hciStatus_t | HCI_EXT_EnhancedModemTestTxCmd (uint8 cwMode, uint8 rfPhy, uint8 rfChan) |
hciStatus_t | HCI_EXT_GetActiveConnInfoCmd (uint8 connId, hciActiveConnInfo_t *activeConnInfo) |
This API is used to get connection related information required to follow the target connection with a BLE conneciton monitor. More... | |
hciStatus_t | HCI_EXT_GetConnInfoCmd (uint8 *numAllocConns, uint8 *numActiveConns, hciConnInfo_t *activeConnInfo) |
hciStatus_t | HCI_EXT_ModemHopTestTxCmd (void) |
hciStatus_t | HCI_EXT_ModemTestRxCmd (uint8 rxChan) |
hciStatus_t | HCI_EXT_ModemTestTxCmd (uint8 cwMode, uint8 txChan) |
hciStatus_t | HCI_EXT_NumComplPktsLimitCmd (uint8 limit, uint8 flushOnEvt) |
hciStatus_t | HCI_EXT_OnePktPerEvtCmd (uint8 control) |
hciStatus_t | HCI_EXT_PacketErrorRateCmd (uint16 connHandle, uint8 command) |
hciStatus_t | HCI_EXT_PERbyChanCmd (uint16 connHandle, perByChan_t *perByChan) |
hciStatus_t | HCI_EXT_ReadRandAddrCmd (void) |
hciStatus_t | HCI_EXT_ResetSystemCmd (uint8 mode) |
hciStatus_t | HCI_EXT_SaveFreqTuneCmd (void) |
hciStatus_t | HCI_EXT_SetBDADDRCmd (uint8 *bdAddr) |
hciStatus_t | HCI_EXT_SetDtmTxPktCntCmd (uint16 txPktCnt) |
hciStatus_t | HCI_EXT_SetExtScanChannels (uint8 extScanChannelsMap) |
This API is used to set the scan channels mapping. More... | |
hciStatus_t | HCI_EXT_SetFastTxResponseTimeCmd (uint8 control) |
hciStatus_t | HCI_EXT_SetFreqTuneCmd (uint8 step) |
hciStatus_t | HCI_EXT_SetHostConnChanClassificationCmd (uint8 *chanMap, uint16 connID) |
hciStatus_t | HCI_EXT_SetHostDefChanClassificationCmd (uint8 *chanMap) |
hciStatus_t | HCI_EXT_SetLocalSupportedFeaturesCmd (uint8 *localFeatures) |
hciStatus_t | HCI_EXT_SetLocationingAccuracyCmd (uint16 handle, uint8 sampleRate1M, uint8 sampleSize1M, uint8 sampleRate2M, uint8 sampleSize2M, uint8 sampleCtrl) |
hciStatus_t | HCI_EXT_SetMaxDataLenCmd (uint16 txOctets, uint16 txTime, uint16 rxOctets, uint16 rxTime) |
hciStatus_t | HCI_EXT_SetMaxDtmTxPowerCmd (uint8 txPower) |
hciStatus_t | HCI_EXT_SetPinOutputCmd (uint8 dio, uint8 value) |
hciStatus_t | HCI_EXT_SetQOSDefaultParameters (uint32 paramDefaultVal, uint8 paramType, uint8 taskType) |
This API is used to set the Default QOS Parameters Values. More... | |
hciStatus_t | HCI_EXT_SetQOSParameters (uint8 taskType, uint8 paramType, uint32 ParamVal, uint16 taskHandle) |
This API is used to set the QOS Parameters according to the entered parameter type. More... | |
hciStatus_t | HCI_EXT_SetRxGainCmd (uint8 rxGain) |
hciStatus_t | HCI_EXT_SetSCACmd (uint16 scaInPPM) |
hciStatus_t | HCI_EXT_SetSlaveLatencyOverrideCmd (uint8 control) |
hciStatus_t | HCI_EXT_SetTxPowerCmd (uint8 txPower) |
hciStatus_t | HCI_EXT_SetVirtualAdvAddrCmd (uint8 advHandle, uint8 *bdAddr) |
This API is used to set the advertiser's virtual public address. More... | |
hciStatus_t | HCI_HostNumCompletedPktCmd (uint8 numHandles, uint16 *connHandles, uint16 *numCompletedPkts) |
hciStatus_t | HCI_LE_AddDeviceToPeriodicAdvListCmd (uint8 advAddrType, uint8 *advAddress, uint8 advSID) |
hciStatus_t | HCI_LE_AddDeviceToResolvingListCmd (uint8 peerIdAddrType, uint8 *peerIdAddr, uint8 *peerIRK, uint8 *localIRK) |
hciStatus_t | HCI_LE_AddWhiteListCmd (uint8 addrType, uint8 *devAddr) |
hciStatus_t | HCI_LE_ClearPeriodicAdvListCmd (void) |
hciStatus_t | HCI_LE_ClearResolvingListCmd (void) |
hciStatus_t | HCI_LE_ClearWhiteListCmd (void) |
hciStatus_t | HCI_LE_ConnUpdateCmd (uint16 connHandle, uint16 connIntervalMin, uint16 connIntervalMax, uint16 connLatency, uint16 connTimeout, uint16 minLen, uint16 maxLen) |
hciStatus_t | HCI_LE_CreateConnCancelCmd (void) |
hciStatus_t | HCI_LE_CreateConnCmd (uint16 scanInterval, uint16 scanWindow, uint8 initFilterPolicy, uint8 addrTypePeer, uint8 *peerAddr, uint8 ownAddrType, uint16 connIntervalMin, uint16 connIntervalMax, uint16 connLatency, uint16 connTimeout, uint16 minLen, uint16 maxLen) |
hciStatus_t | HCI_LE_EncryptCmd (uint8 *key, uint8 *plainText) |
hciStatus_t | HCI_LE_EnhancedCteRxTestCmd (uint8 rxChan, uint8 rxPhy, uint8 modIndex, uint8 expectedCteLength, uint8 expectedCteType, uint8 slotDurations, uint8 length, uint8 *pAntenna) |
hciStatus_t | HCI_LE_EnhancedCteTxTestCmd (uint8 txChan, uint8 payloadLen, uint8 payloadType, uint8 txPhy, uint8 cteLength, uint8 cteType, uint8 length, uint8 *pAntenna) |
hciStatus_t | HCI_LE_EnhancedRxTestCmd (uint8 rxChan, uint8 rxPhy, uint8 modIndex) |
hciStatus_t | HCI_LE_EnhancedTxTestCmd (uint8 txChan, uint8 payloadLen, uint8 payloadType, uint8 txPhy) |
hciStatus_t | HCI_LE_GenerateDHKeyCmd (uint8 *publicKey) |
hciStatus_t | HCI_LE_LtkReqNegReplyCmd (uint16 connHandle) |
hciStatus_t | HCI_LE_LtkReqReplyCmd (uint16 connHandle, uint8 *ltk) |
hciStatus_t | HCI_LE_PeriodicAdvCreateSyncCancelCmd (void) |
hciStatus_t | HCI_LE_PeriodicAdvCreateSyncCmd (uint8 options, uint8 advSID, uint8 advAddrType, uint8 *advAddress, uint16 skip, uint16 syncTimeout, uint8 syncCteType) |
hciStatus_t | HCI_LE_PeriodicAdvTerminateSyncCmd (uint16 syncHandle) |
hciStatus_t | HCI_LE_RandCmd (void) |
hciStatus_t | HCI_LE_ReadAdvChanTxPowerCmd (void) |
hciStatus_t | HCI_LE_ReadAntennaInformationCmd (void) |
hciStatus_t | HCI_LE_ReadBufSizeCmd (void) |
hciStatus_t | HCI_LE_ReadChannelMapCmd (uint16 connHandle) |
hciStatus_t | HCI_LE_ReadLocalP256PublicKeyCmd (void) |
hciStatus_t | HCI_LE_ReadLocalResolvableAddressCmd (uint8 localIdAddrType, uint8 *localIdAddr) |
hciStatus_t | HCI_LE_ReadLocalSupportedFeaturesCmd (void) |
hciStatus_t | HCI_LE_ReadMaxDataLenCmd (void) |
hciStatus_t | HCI_LE_ReadPeerResolvableAddressCmd (uint8 peerIdAddrType, uint8 *peerIdAddr) |
hciStatus_t | HCI_LE_ReadPeriodicAdvListSizeCmd (void) |
hciStatus_t | HCI_LE_ReadPhyCmd (uint16 connHandle) |
hciStatus_t | HCI_LE_ReadRemoteUsedFeaturesCmd (uint16 connHandle) |
hciStatus_t | HCI_LE_ReadResolvingListSizeCmd (void) |
hciStatus_t | HCI_LE_ReadRfPathCompCmd (void) |
hciStatus_t | HCI_LE_ReadSuggestedDefaultDataLenCmd (void) |
hciStatus_t | HCI_LE_ReadSupportedStatesCmd (void) |
hciStatus_t | HCI_LE_ReadTxPowerCmd (void) |
hciStatus_t | HCI_LE_ReadWhiteListSizeCmd (void) |
hciStatus_t | HCI_LE_ReceiverTestCmd (uint8 rxChan) |
hciStatus_t | HCI_LE_RemoteConnParamReqNegReplyCmd (uint16 connHandle, uint8 reason) |
hciStatus_t | HCI_LE_RemoteConnParamReqReplyCmd (uint16 connHandle, uint16 connIntervalMin, uint16 connIntervalMax, uint16 connLatency, uint16 connTimeout, uint16 minLen, uint16 maxLen) |
hciStatus_t | HCI_LE_RemoveDeviceFromPeriodicAdvListCmd (uint8 advAddrType, uint8 *advAddress, uint8 advSID) |
hciStatus_t | HCI_LE_RemoveDeviceFromResolvingListCmd (uint8 peerIdAddrType, uint8 *peerIdAddr) |
hciStatus_t | HCI_LE_RemoveWhiteListCmd (uint8 addrType, uint8 *devAddr) |
hciStatus_t | HCI_LE_SetAddressResolutionEnableCmd (uint8 addrResolutionEnable) |
hciStatus_t | HCI_LE_SetAdvDataCmd (uint8 dataLen, uint8 *pData) |
hciStatus_t | HCI_LE_SetAdvEnableCmd (uint8 advEnable) |
hciStatus_t | HCI_LE_SetAdvParamCmd (uint16 advIntervalMin, uint16 advIntervalMax, uint8 advType, uint8 ownAddrType, uint8 directAddrType, uint8 *directAddr, uint8 advChannelMap, uint8 advFilterPolicy) |
hciStatus_t | HCI_LE_SetAdvStatus (aeEnableCmd_t *pCmdParams) |
hciStatus_t | HCI_LE_SetConnectionCteReceiveParamsCmd (uint16 connHandle, uint8 samplingEnable, uint8 slotDurations, uint8 length, uint8 *pAntenna) |
hciStatus_t | HCI_LE_SetConnectionCteRequestEnableCmd (uint16 connHandle, uint8 enable, uint16 interval, uint8 length, uint8 type) |
hciStatus_t | HCI_LE_SetConnectionCteResponseEnableCmd (uint16 connHandle, uint8 enable) |
hciStatus_t | HCI_LE_SetConnectionCteTransmitParamsCmd (uint16 connHandle, uint8 types, uint8 length, uint8 *pAntenna) |
hciStatus_t | HCI_LE_SetConnectionlessCteTransmitEnableCmd (uint8 advHandle, uint8 enable) |
Used by the Host to request that the Controller enables or disables the use of Constant Tone Extensions in any periodic advertising. More... | |
hciStatus_t | HCI_LE_SetConnectionlessCteTransmitParamsCmd (uint8 advHandle, uint8 cteLen, uint8 cteType, uint8 cteCount, uint8 length, uint8 *pAntenna) |
Used by the Host to set the type, length, and antenna switching pattern for the transmission of Constant Tone Extensions in any periodic advertising. More... | |
hciStatus_t | HCI_LE_SetConnectionlessIqSamplingEnableCmd (uint16 syncHandle, uint8 samplingEnable, uint8 slotDurations, uint8 maxSampledCtes, uint8 length, uint8 *pAntenna) |
hciStatus_t | HCI_LE_SetDataLenCmd (uint16 connHandle, uint16 txOctets, uint16 txTime) |
hciStatus_t | HCI_LE_SetDefaultPhyCmd (uint8 allPhys, uint8 txPhy, uint8 rxPhy) |
hciStatus_t | HCI_LE_SetEventMaskCmd (uint8 *pEventMask) |
hciStatus_t | HCI_LE_SetExtAdvData (aeSetDataCmd_t *pCmdParams) |
hciStatus_t | HCI_LE_SetExtScanRspData (aeSetDataCmd_t *pCmdParams) |
hciStatus_t | HCI_LE_SetHostChanClassificationCmd (uint8 *chanMap) |
hciStatus_t | HCI_LE_SetPeriodicAdvDataCmd (uint8 advHandle, uint8 operation, uint8 dataLength, uint8 *data) |
Used to set the advertiser data used in periodic advertising PDUs. This command may be issued at any time after the advertising set identified by the Advertising_Handle parameter has been configured for periodic advertising using the HCI_LE_Set_Periodic_Advertising_Parameters command. More... | |
hciStatus_t | HCI_LE_SetPeriodicAdvEnableCmd (uint8 enable, uint8 advHandle) |
Used to request the advertiser to enable or disable the periodic advertising for the advertising set. More... | |
hciStatus_t | HCI_LE_SetPeriodicAdvParamsCmd (uint8 advHandle, uint16 periodicAdvIntervalMin, uint16 periodicAdvIntervalMax, uint16 periodicAdvProp) |
hciStatus_t | HCI_LE_SetPeriodicAdvReceiveEnableCmd (uint16 syncHandle, uint8 enable) |
hciStatus_t | HCI_LE_SetPhyCmd (uint16 connHandle, uint8 allPhys, uint8 txPhy, uint8 rxPhy, uint16 phyOpts) |
hciStatus_t | HCI_LE_SetPrivacyModeCmd (uint8 peerIdAddrType, uint8 *peerIdAddr, uint8 privacyMode) |
hciStatus_t | HCI_LE_SetRandomAddressCmd (uint8 *pRandAddr) |
hciStatus_t | HCI_LE_SetResolvablePrivateAddressTimeoutCmd (uint16 rpaTimeout) |
hciStatus_t | HCI_LE_SetScanEnableCmd (uint8 scanEnable, uint8 filterDuplicates) |
hciStatus_t | HCI_LE_SetScanParamCmd (uint8 scanType, uint16 scanInterval, uint16 scanWindow, uint8 ownAddrType, uint8 filterPolicy) |
hciStatus_t | HCI_LE_SetScanRspDataCmd (uint8 dataLen, uint8 *pData) |
hciStatus_t | HCI_LE_StartEncyptCmd (uint16 connHandle, uint8 *random, uint8 *encDiv, uint8 *ltk) |
hciStatus_t | HCI_LE_TestEndCmd (void) |
hciStatus_t | HCI_LE_TransmitterTestCmd (uint8 txChan, uint8 dataLen, uint8 pktPayload) |
hciStatus_t | HCI_LE_WriteRfPathCompCmd (int16 txPathParam, int16 rxPathParam) |
hciStatus_t | HCI_LE_WriteSuggestedDefaultDataLenCmd (uint16 txOctets, uint16 txTime) |
hciStatus_t | HCI_ReadAuthPayloadTimeoutCmd (uint16 connHandle, uint16 *aptoValue) |
hciStatus_t | HCI_ReadBDADDRCmd (void) |
hciStatus_t | HCI_ReadLocalSupportedCommandsCmd (void) |
hciStatus_t | HCI_ReadLocalSupportedFeaturesCmd (void) |
hciStatus_t | HCI_ReadLocalVersionInfoCmd (void) |
hciStatus_t | HCI_ReadRemoteVersionInfoCmd (uint16 connHandle) |
hciStatus_t | HCI_ReadRssiCmd (uint16 connHandle) |
hciStatus_t | HCI_ReadTransmitPowerLevelCmd (uint16 connHandle, uint8 txPwrType) |
hciStatus_t | HCI_ResetCmd (void) |
hciStatus_t | HCI_SetEventMaskCmd (uint8 *pMask) |
hciStatus_t | HCI_SetEventMaskPage2Cmd (uint8 *pMask) |
hciStatus_t | HCI_WriteAuthPayloadTimeoutCmd (uint16 connHandle, uint16 aptoValue) |
This module implements the Host Controller Interface. For a detailed usage section describing how to send these commands and receive events, see the HCI Section of the User's Guide.
hciStatus_t HCI_EXT_BuildRevisionCmd | ( | uint8 | mode, |
uint16 | userRevNum | ||
) |
Set a user revision number or read the build revision number.
This command allows the embedded user code to set their own 16-bit revision number or read the build revision number of the Bluetooth low energy stack library software. The default value of the revision number is zero. When you update a Bluetooth low energy project by adding your own code, use this API to set your own revision number. When called with mode set to HCI_EXT_SET_USER_REVISION, the stack saves this value. No event is returned from this API when used this way.
mode | Set User Revision Command |
userRevNum | user defined revision number |
hciStatus_t HCI_EXT_CoexEnableCmd | ( | uint8 | enable | ) |
Enable or disable the Coex feature.
enable | - 1 to enable and 0 to disable. |
hciStatus_t HCI_EXT_ConnEventNoticeCmd | ( | uint16 | connHandle, |
uint8 | taskID, | ||
uint16 | taskEvent | ||
) |
Connection Event Notice Command
For a given connection handle, enable or disable a notification to the specified task using the specified task event whenever a Connection event ends. A non-zero taskEvent value is taken to be "enable", while a zero valued taskEvent taken to be "disable".
If configured successfully, it will result in BLE stack events sent as shown in the following example.
connHandle | The HCI connection ID for connection event notice. |
taskID | User's task ID. |
taskEvent | User's task event. |
hciStatus_t HCI_EXT_DecryptCmd | ( | uint8 * | key, |
uint8 * | encText | ||
) |
Decrypt encrypted data using AES128.
key | Pointer to 16 byte encryption key. The most significant octet of the data corresponds to key[0] using the notation specified in FIPS 197. |
encText | Pointer to 16 byte encrypted data. The most significant octet of the key corresponds to key[0] using the notation specified in FIPS 197. |
hciStatus_t HCI_EXT_DisconnectImmedCmd | ( | uint16 | connHandle | ) |
Disconnect the connection immediately.
This command is used to disconnect a connection immediately. This command can be useful for when a connection needs to be ended without the latency associated with the normal BLE Controller Terminate control procedure.
connHandle | Connection handle. |
hciStatus_t HCI_EXT_EnablePTMCmd | ( | void | ) |
Enable Production Test Mode.
This command is used to enable Production Test Mode (PTM). This mode is used by the customer during assembly of their product to allow limited access to the BLE Controller for testing and configuration. This command is only available when the BLE Controller is built without external access to the Controller (i.e. when no transport interface such as RS232 is permitted). This mode will remain enabled until the device is reset. Please see the related application note for additional details.
hciStatus_t HCI_EXT_EndModemTestCmd | ( | void | ) |
Shutdown a modem test.
hciStatus_t HCI_EXT_EnhancedModemHopTestTxCmd | ( | uint8 | payloadLen, |
uint8 | payloadType, | ||
uint8 | rfPhy | ||
) |
Start Enhanced Modem Hop Tx Test
Start an enhanced BLE5 continuous transmitter direct test mode test using a modulated carrier wave. A test reference data packet is transmitted on a different frequency (linearly stepping through all RF channels 0..39), for a given PHY (1M, 2M, Coded S2, Coded S8), every period (depending on the payload length, as given Vol. 6, Part F, section 4.1.6). Use HCI_EXT_EndModemTestCmd command to end the test.
The BLE device will transmit at maximum power.
This modem test can be used to satisfy in part radio regulation requirements as specific in standards such as ARIB STD-T66.
payloadLen | Number bytes (0..255)in payload for each packet. |
payloadType | Direct Test Mode |
rfPhy | RF Setup PHY Parameters |
hciStatus_t HCI_EXT_EnhancedModemTestRxCmd | ( | uint8 | rfPhy, |
uint8 | rfChan | ||
) |
Start Enhanced Modem Hop RX Test
Start an enhanced BLE5 continuous receiver modem test using a modulated carrier wave tone, at the frequency that corresponds to the specific RF channel, for a given PHY (1M, 2M, Coded S2, or Coded S8). Any received data is discarded. RSSI may be read during this test by using the HCI_ReadRssiCmd. Use HCI_EXT_EndModemTestCmd command to end the test.
This modem test can be used to satisfy in part radio regulation requirements as specific in standards such as ARIB STD-T66.
rfPhy | RF Setup PHY Parameters |
rfChan | Receiver RF channel k=0..39, where BLE F=2402+(k*2MHz). |
hciStatus_t HCI_EXT_EnhancedModemTestTxCmd | ( | uint8 | cwMode, |
uint8 | rfPhy, | ||
uint8 | rfChan | ||
) |
Start Enhanced Modem TX Test
Start an enhanced BLE5 continuous transmitter modem test, using either a modulated or unmodulated carrier wave tone, at the frequency that corresponds to the specified RF channel for a given PHY (1M, 2M, Coded S2, or Coded S8). Use HCI_EXT_EndModemTestCmd command to end the test.
The BLE device will transmit at maximum power.
This modem test can be used to satisfy in part radio regulation requirements as specific in standards such as ARIB STD-T66.
cwMode | TX Modulation |
rfPhy | RF Setup PHY Parameters |
rfChan | Transmit RF channel k=0..39, where BLE F=2402+(k*2MHz). |
hciStatus_t HCI_EXT_GetActiveConnInfoCmd | ( | uint8 | connId, |
hciActiveConnInfo_t * | activeConnInfo | ||
) |
This API is used to get connection related information required to follow the target connection with a BLE conneciton monitor.
input parameters
connId | - Connection id of an active BLE connection. |
activeConnInfo | - Pointer for active connection information that is needed to track BLE connection. Note: If not NULL it is the users responsibility to allocate memory for this pointer based on sizeof(hciActiveConnInfo_t) and also to free it when done. |
output parameters
activeConnInfo | - Pointer for active connection information that is needed to track BLE connection. |
hciStatus_t HCI_EXT_GetConnInfoCmd | ( | uint8 * | numAllocConns, |
uint8 * | numActiveConns, | ||
hciConnInfo_t * | activeConnInfo | ||
) |
Get Connection Info
This API is used to get connection related information, which includes the number of allocated connections, the number of active connections, and for each active connection, the connection ID, the connection role (Master or Slave), the peer address and peer address type. The number of allocated connections is based on a default build value that can be changed using MAX_NUM_BLE_CONNS. The number of active connections refers to active BLE connections.
numAllocConns | Pointer for number of build time connections. |
numActiveConns | Pointer for number of active BLE connections. |
activeConnInfo | Pointer for active connection information. |
numAllocConns | Number of build time connections allowed. |
numActiveConns | Number of active BLE connections. |
activeConnInfo | Active connection information. |
hciStatus_t HCI_EXT_ModemHopTestTxCmd | ( | void | ) |
Start Modem Hop Tx Test
Start a continuous transmitter direct test mode test using a modulated carrier wave and transmitting a 37 byte packet of Pseudo-Random 9-bit data. A packet is transmitted on a different frequency (linearly stepping through all RF channels 0..39) every 625 us. Use HCI_EXT_EndModemTestCmd command to end the test.
The BLE device will transmit at maximum power.
This modem test can be used to satisfy in part radio regulation requirements as specific in standards such as ARIB STD-T66.
hciStatus_t HCI_EXT_ModemTestRxCmd | ( | uint8 | rxChan | ) |
Start Modem Hop RX Test
Start a continuous receiver modem test using a modulated carrier wave tone, at the frequency that corresponds to the specific RF channel. Any received data is discarded. Receiver gain may be adjusted using the HCI_EXT_SetRxGainCmd. RSSI may be read during this test by using the HCI_ReadRssiCmd. Use HCI_EXT_EndModemTestCmd command to end the test.
This modem test can be used to satisfy in part radio regulation requirements as specific in standards such as ARIB STD-T66.
rxChan | Receiver RF channel k=0..39, where BLE F=2402+(k*2MHz). |
hciStatus_t HCI_EXT_ModemTestTxCmd | ( | uint8 | cwMode, |
uint8 | txChan | ||
) |
Start Modem TX Test
Start a continuous transmitter modem test, using either a modulated or unmodulated carrier wave tone, at the frequency that corresponds to the specified RF channel. Use HCI_EXT_EndModemTestCmd command to end the test.
The BLE device will transmit at maximum power.
This modem test can be used to satisfy in part radio regulation requirements as specific in standards such as ARIB STD-T66.
cwMode | TX Modulation |
txChan | Transmit RF channel k=0..39, where BLE F=2402+(k*2MHz). |
hciStatus_t HCI_EXT_NumComplPktsLimitCmd | ( | uint8 | limit, |
uint8 | flushOnEvt | ||
) |
Set the Number of Completed Packets Limit
This command is used to set the limit on the minimum number of complete packets before a Number of Completed Packets event is returned by the Controller. If the limit is not reached by the end of a connection event, then the hciEvt_NumCompletedPkt_t event will be returned (if non-zero) based on the flushOnEvt flag. The limit can be set from one to HCI_MAX_NUM_CMD_BUFFERS (see HCI_LE_ReadBufSizeCmd). The default limit is 1; the default flushOnEvt flag is FALSE.
limit | From 1 to HCI_MAX_NUM_CMD_BUFFERS. |
flushOnEvt | Number of Completed Packets |
hciStatus_t HCI_EXT_OnePktPerEvtCmd | ( | uint8 | control | ) |
Set whether a connection will be limited to one packet per event.
Note: When set, all connections will be restricted to one packet per event.
control | One Packet Per Event |
hciStatus_t HCI_EXT_PacketErrorRateCmd | ( | uint16 | connHandle, |
uint8 | command | ||
) |
Packet Error Rate Command
Reset or Read the Packet Error Rate counters for a connection.
connHandle | The LL connection ID on which to send this data. |
command | Packet Error Rate Command |
hciStatus_t HCI_EXT_PERbyChanCmd | ( | uint16 | connHandle, |
perByChan_t * | perByChan | ||
) |
Packet Error Rate by Channel Command
This command is used to start or end Packet Error Rate by Channel counter accumulation for a connection, and can be used by an application to make Coexistence assessments. Based on the results, an application can perform an Update Channel Classification command to limit channel interference from other wireless standards.
If perByChan is NULL, counter accumulation will be discontinued. If perByChan is not NULL, then it is assumed that there is sufficient memory for the PER data of type perByChan_t (defined in ll.h)
connHandle | The LL connection ID on which to send this data. |
perByChan | Pointer to PER by Channel data, or NULL. |
hciStatus_t HCI_EXT_ReadRandAddrCmd | ( | void | ) |
Read this device's BLE Random Address.
hciStatus_t HCI_EXT_ResetSystemCmd | ( | uint8 | mode | ) |
Issue a soft or hard system reset.
This command is used to issue a hard or soft system reset. On the CC254x, a hard reset is caused by a watchdog timer timeout, while a soft reset is caused by resetting the PC to zero. On the CC264x, a hard reset is caused by setting the SYSRESET bit in the System Controller Reset Control register.
mode | Reset Type |
hciStatus_t HCI_EXT_SaveFreqTuneCmd | ( | void | ) |
Save the frequency tuning value to non-volatile memory.
This setting will be used by the BLE Controller upon reset, and when waking from Sleep.
hciStatus_t HCI_EXT_SetBDADDRCmd | ( | uint8 * | bdAddr | ) |
Set this device's BLE address (BDADDR).
This address will override the device's address determined when the device is reset (i.e. a hardware reset, not an HCI Controller Reset). To restore the device's initialized address, issue this command with an invalid address.
bdAddr | A pointer to a buffer to hold this device's address. An invalid address (i.e. all FF's) will restore this device's address to the address set at initialization. |
hciStatus_t HCI_EXT_SetDtmTxPktCntCmd | ( | uint16 | txPktCnt | ) |
Set the DTM transmit packet count.
The default system value for this feature is Direct Test Mode Options.
txPktCnt | Number of DTM packets to transmit. |
hciStatus_t HCI_EXT_SetExtScanChannels | ( | uint8 | extScanChannelsMap | ) |
This API is used to set the scan channels mapping.
input parameters
extScanChannelsMap | - channel scan definitions. Note: The parameter can receive the values - LL_SCN_ADV_MAP_CHAN_37, LL_SCN_ADV_MAP_CHAN_38, LL_SCN_ADV_MAP_CHAN_39, LL_SCN_ADV_MAP_CHAN_37_38, LL_SCN_ADV_MAP_CHAN_37_39, LL_SCN_ADV_MAP_CHAN_38_39, LL_SCN_ADV_MAP_CHAN_ALL. |
GAP_scanChannels_t.
output parameters
None. |
hciStatus_t HCI_EXT_SetFastTxResponseTimeCmd | ( | uint8 | control | ) |
Set Fast TX Response Time
This command is used to configure the Link Layer fast transmit response time feature. The default system value for this feature is HCI_EXT_ENABLE_FAST_TX_RESP_TIME. When the Host transmits data, the controller (by default) ensures the packet is sent over the LL connection with as little delay as possible, even when the connection is configured to use slave latency. That is, the transmit response time will tend to be no longer than the connection interval. This results in lower power savings since the LL may need to wake to transmit during connection events that would normally have been skipped. If saving power is more critical than fast transmit response time, then this feature can be disabled using this command. When disabled, the transmit response time will be no longer than slave latency + 1 times the connection interval.
control | Fast Tx Response Time |
hciStatus_t HCI_EXT_SetFreqTuneCmd | ( | uint8 | step | ) |
Set Frequency Tuning
Set the frequency tuning up or down.When the current setting is already at its max value, then stepping up will have no effect. When the current setting is already at its min value, then stepping down will have no effect. This setting will only remain in effect until the device is reset unless HCI_EXT_SaveFreqTuneCmd is used to save it in non-volatile memory.
step | Frequency Tuning |
hciStatus_t HCI_EXT_SetHostConnChanClassificationCmd | ( | uint8 * | chanMap, |
uint16 | connID | ||
) |
Update the channel map of specific connection.
chanMap | Pointer to the new channel map. |
connID | connection handle |
hciStatus_t HCI_EXT_SetHostDefChanClassificationCmd | ( | uint8 * | chanMap | ) |
Update the default channel map.
chanMap | Pointer to the new channel map. |
hciStatus_t HCI_EXT_SetLocalSupportedFeaturesCmd | ( | uint8 * | localFeatures | ) |
Write this device's supported features.
This command is used to set the Controller's Local Supported Features. For a complete list of supported LE features, see the BT Spec.
localFeatures | Pointer to eight bytes of local features. |
hciStatus_t HCI_EXT_SetLocationingAccuracyCmd | ( | uint16 | handle, |
uint8 | sampleRate1M, | ||
uint8 | sampleSize1M, | ||
uint8 | sampleRate2M, | ||
uint8 | sampleSize2M, | ||
uint8 | sampleCtrl | ||
) |
Set CTE accuracy for 1M and 2M PHY
/ref did_202754181
handle | - Connection handle (0x0XXX) or periodic advertising train handle (0x1XXX). |
sampleRate1M | sample rate for PHY 1M range : 1 - least accuracy (as in 5.1 spec) to 4 - most accuracy |
sampleSize1M | sample size for PHY 1M range : 1 - 8 bits (as in 5.1 spec) or 2 - 16 bits (more accurate) |
sampleRate2M | sample rate for PHY 2M range : 1 - least accuracy (as in 5.1 spec) to 4 - most accuracy |
sampleSize2M | sample size for PHY 2M range : 1 - 8 bits (as in 5.1 spec) or 2 - 16 bits (more accurate) |
sampleCtrl | - sample control flags range : range : bit0=0 - Default filtering, bit0=1 - RAW_RF(no filtering), , bit1..7=0 - spare |
hciStatus_t HCI_EXT_SetMaxDataLenCmd | ( | uint16 | txOctets, |
uint16 | txTime, | ||
uint16 | rxOctets, | ||
uint16 | rxTime | ||
) |
Set the maximum Rx and Tx Octets (in bytes) and Time (in us).
txOctets | Value of maximum supported Tx octets (in bytes). |
txTime | Value of maximum supported Tx time (in us). |
rxOctets | Value of maximum supported Rx octets (in bytes). |
rxTime | Value of maximum supported Rx time (in us). |
hciStatus_t HCI_EXT_SetMaxDtmTxPowerCmd | ( | uint8 | txPower | ) |
Set the maximum transmit output power for DTM.
This command is used to override the RF transmitter output power used by the Direct Test Mode (DTM). Normally, the maximum transmitter output power setting used by DTM is the maximum transmitter output power setting for the device (i.e. 4 dBm for the CC2540; 0 dBm for the CC2541; 5 dBm for the CC264x). This command will change the value used by DTM.
txPower | TX Power Index |
hciStatus_t HCI_EXT_SetPinOutputCmd | ( | uint8 | dio, |
uint8 | value | ||
) |
Set pin as output and initialize it.
dio | - pin number. |
value | - initialize pin value (0 or 1). 0xFF will return the pin to input. |
hciStatus_t HCI_EXT_SetQOSDefaultParameters | ( | uint32 | paramDefaultVal, |
uint8 | paramType, | ||
uint8 | taskType | ||
) |
This API is used to set the Default QOS Parameters Values.
/ref did_361975877 /ref did_408769671
input parameters
paramDefaultVal | - The default value of this qos type. For LL_QOS_TYPE_PRIORITY optional values: LL_QOS_LOW_PRIORITY, LL_QOS_MEDIUM_PRIORITY, LL_QOS_HIGH_PRIORITY. Range [0-2]. |
paramType | - The type of parameter. General: LL_QOS_TYPE_PRIORITY. For connections: LL_QOS_TYPE_CONN_MIN_LENGTH / LL_QOS_TYPE_CONN_MAX_LENGTH. |
taskType | - The type of task we would like to change it's default value. For Connections task type: LL_QOS_CONN_TASK_TYPE. For Advertise task type: LL_QOS_ADV_TASK_TYPE. For Scan task type: LL_QOS_SCN_TASK_TYPE. For Initiator task type: LL_QOS_INIT_TASK_TYPE. For Periodic Advertise task type: LL_QOS_PERIODIC_ADV_TASK_TYPE. For Periodic Scan task type: LL_QOS_PERIODIC_SCN_TASK_TYPE. output parameters |
None. |
hciStatus_t HCI_EXT_SetQOSParameters | ( | uint8 | taskType, |
uint8 | paramType, | ||
uint32 | ParamVal, | ||
uint16 | taskHandle | ||
) |
This API is used to set the QOS Parameters according to the entered parameter type.
/ref did_361975877 /ref did_408769671
input parameters
taskType | - The type of task. For Connections task type: LL_QOS_CONN_TASK_TYPE. For Advertise task type: LL_QOS_ADV_TASK_TYPE. For Scan task type: LL_QOS_SCN_TASK_TYPE. For Initiator task type: LL_QOS_INIT_TASK_TYPE. For Periodic Advertise task type: LL_QOS_PERIODIC_ADV_TASK_TYPE. For Periodic Scan task type: LL_QOS_PERIODIC_SCN_TASK_TYPE. |
paramType | - The type of parameter. General: LL_QOS_TYPE_PRIORITY. For connections: LL_QOS_TYPE_CONN_MIN_LENGTH / LL_QOS_TYPE_CONN_MAX_LENGTH. |
paramVal | - The value of the parameter. General: LL_QOS_TYPE_PRIORITY optional values: LL_QOS_LOW_PRIORITY, LL_QOS_MEDIUM_PRIORITY, LL_QOS_HIGH_PRIORITY. Range [0-2]. For connections only: LL_QOS_TYPE_CONN_MIN_LENGTH optional values: Time in [us]. for coded connection Range [LL_MIN_LINK_DATA_TIME_CODED (2704 us) - LL_MAX_LINK_DATA_TIME_CODED (17040 us)]. for uncoded connection Range [LL_MIN_LINK_DATA_TIME (328 us) - LL_MAX_LINK_DATA_TIME_UNCODED (2120 us)]. LL_QOS_TYPE_CONN_MAX_LENGTH optional values: Time in [us]. for coded connection Range [LL_MIN_LINK_DATA_TIME_CODED (2704 us) - Connection's Interval ] for uncoded connection Range [LL_MIN_LINK_DATA_TIME (328 us) - Connection's Interval ] |
Note: For the LL_QOS_TYPE_CONN_MIN_LENGTH value a margin time is added of LL_TOTAL_MARGIN_TIME_FOR_MIN_CONN_RAT_TICKS. Note: LL_QOS_TYPE_CONN_MAX_LENGTH must be larger than (LL_QOS_TYPE_CONN_MIN_LENGTH + LL_TOTAL_MARGIN_TIME_FOR_MIN_CONN_RAT_TICKS) Value.
taskHandle | - The Task Handle of which we want to update it's parameters. This variable is not relevent for LL_QOS_SCN_TASK_TYPE / LL_QOS_INIT_TASK_TYPE because There is only 1 set for scanner or initiator. |
output parameters
None. |
hciStatus_t HCI_EXT_SetRxGainCmd | ( | uint8 | rxGain | ) |
Set the receiver gain.
The default system value for this feature is HCI_EXT_RX_GAIN_STD
rxGain | RX Gain |
hciStatus_t HCI_EXT_SetSCACmd | ( | uint16 | scaInPPM | ) |
Set this device's Sleep Clock Accuracy.
For a slave device, this value is directly used, but only if power management is enabled. For a master device, this value is converted into one of eight ordinal values representing a SCA range, as specified in the BT Spec. For a Slave device, the value is directly used. The system default value for a Master and Slave device is 50ppm and 40ppm, respectively.
scaInPPM | A SCA value in PPM from 0..500. |
hciStatus_t HCI_EXT_SetSlaveLatencyOverrideCmd | ( | uint8 | control | ) |
Enable or disable suspending slave latency.
This command is used to enable or disable the Slave Latency Override, allowing the user to ensure that Slave Latency is not applied even though it is active. The default value is HCI_EXT_DISABLE_SL_OVERRIDE
control | Slave Latency Override |
hciStatus_t HCI_EXT_SetTxPowerCmd | ( | uint8 | txPower | ) |
Set the transmit power.
The 'txPower' input parameter should be an index from TX Power Index.
The default system value for this feature is HCI_EXT_TX_POWER_0_DBM
txPower | TX Power Index |
hciStatus_t HCI_EXT_SetVirtualAdvAddrCmd | ( | uint8 | advHandle, |
uint8 * | bdAddr | ||
) |
This API is used to set the advertiser's virtual public address.
Note: This command is only allowed when the advertise set is not active, and its PDU type is Legacy Non-Connectable and Non-Scanable.
/ref 239346186
input parameters
handle | - advertising handle |
bdAddr | - the address which will be assigned to the handle |
output parameters
None. |
hciStatus_t HCI_HostNumCompletedPktCmd | ( | uint8 | numHandles, |
uint16 * | connHandles, | ||
uint16 * | numCompletedPkts | ||
) |
Set the number of HCI data packets completed per connection handle
Used by the Host to notify the Controller of the number of HCI data packets that have been completed for each connection handle since this command was previously sent to the controller.
The Host_Number_Of_Conpleted_Packets command is a special command. No event is normally generated after the command has completed. The command should only be issued by the Host if flow control in the direction from controller to the host is on and there is at least one connection, or if the controller is in local loop-back mode.
numHandles | Number of connection handles. |
connHandles | Array of connection handles. |
numCompletedPkts | Array of number of completed packets. |
hciStatus_t HCI_LE_AddDeviceToPeriodicAdvListCmd | ( | uint8 | advAddrType, |
uint8 * | advAddress, | ||
uint8 | advSID | ||
) |
HCI_LE_AddDeviceToPeriodicAdvertiserListCmd
Used a scanner to add an entry, consisting of a single device address and SID, to the Periodic Advertiser list stored in the Controller.
/ref did_286039104
advAddrType | - Advertiser address type - 0x00 - Public or Public Identity Address 0x01 - Random or Random (static) Identity Address |
advAddress | - Advertiser address (6 bytes) |
advSID | - Advertising SID subfield in the ADI field used to identify the Periodic Advertising (Range: 0x00 to 0x0F) |
hciStatus_t HCI_LE_AddDeviceToResolvingListCmd | ( | uint8 | peerIdAddrType, |
uint8 * | peerIdAddr, | ||
uint8 * | peerIRK, | ||
uint8 * | localIRK | ||
) |
Add a device to the resolving list
Add one device to the list of address translations used to resolve Resolvable Private Addresses in the Controller.
peerIdAddrType | Device Address Type |
peerIdAddr | Peer device Identity Address. |
peerIRK | IRK of peer device. |
localIRK | IRK for own device. |
hciStatus_t HCI_LE_AddWhiteListCmd | ( | uint8 | addrType, |
uint8 * | devAddr | ||
) |
Add a white list entry.
addrType | Device Address Type |
devAddr | Pointer to address of device to put in white list. |
hciStatus_t HCI_LE_ClearPeriodicAdvListCmd | ( | void | ) |
HCI_LE_ClearPeriodicAdvListCmd
Used a scanner to remove all entries from the list of Periodic Advertisers in the Controller.
/ref did_286039104
hciStatus_t HCI_LE_ClearResolvingListCmd | ( | void | ) |
Remove all devices from the whitelist
Remove all devices from the list of address translations used to resolve Resolvable Private addresses in the Controller.
hciStatus_t HCI_LE_ClearWhiteListCmd | ( | void | ) |
Clear the white list.
hciStatus_t HCI_LE_ConnUpdateCmd | ( | uint16 | connHandle, |
uint16 | connIntervalMin, | ||
uint16 | connIntervalMax, | ||
uint16 | connLatency, | ||
uint16 | connTimeout, | ||
uint16 | minLen, | ||
uint16 | maxLen | ||
) |
Update the connection parameters.
connHandle | Connection handle. |
connIntervalMin | Minimum allowed connection interval. |
connIntervalMax | Maximum allowed connection interval. |
connLatency | Number of skipped events (slave latency). |
connTimeout | Connection supervision timeout. |
minLen | Info parameter about min length of conn. |
maxLen | Info parameter about max length of conn. |
hciStatus_t HCI_LE_CreateConnCancelCmd | ( | void | ) |
Cancel connection.
hciStatus_t HCI_LE_CreateConnCmd | ( | uint16 | scanInterval, |
uint16 | scanWindow, | ||
uint8 | initFilterPolicy, | ||
uint8 | addrTypePeer, | ||
uint8 * | peerAddr, | ||
uint8 | ownAddrType, | ||
uint16 | connIntervalMin, | ||
uint16 | connIntervalMax, | ||
uint16 | connLatency, | ||
uint16 | connTimeout, | ||
uint16 | minLen, | ||
uint16 | maxLen | ||
) |
Create a connection.
scanInterval | Time between Init scan events. |
scanWindow | Time of scan before Init scan event ends. |
initFilterPolicy | Initiator White List Policy |
addrTypePeer | Device Address Type |
peerAddr | Pointer to peer device's address. |
ownAddrType | Device Address Type |
connIntervalMin | Minimum allowed connection interval. |
connIntervalMax | Maximum allowed connection interval. |
connLatency | Number of skipped events (slave latency). |
connTimeout | Connection supervision timeout. |
minLen | Info parameter about min length of conn. |
maxLen | Info parameter about max length of conn. |
hciStatus_t HCI_LE_EncryptCmd | ( | uint8 * | key, |
uint8 * | plainText | ||
) |
Perform an encryption using AES128.
key | Pointer to 16 byte encryption key. |
plainText | Pointer to 16 byte plain-text data. |
hciStatus_t HCI_LE_EnhancedCteRxTestCmd | ( | uint8 | rxChan, |
uint8 | rxPhy, | ||
uint8 | modIndex, | ||
uint8 | expectedCteLength, | ||
uint8 | expectedCteType, | ||
uint8 | slotDurations, | ||
uint8 | length, | ||
uint8 * | pAntenna | ||
) |
Start Enhanced CTE RX Test
Start a test where the DUT receives reference packets at a fixed interval. The tester generates the test reference packets.
rxChan | Rx Channel k=0..39, where F=2402+(k*2MHz). |
rxPhy | Rx PHY to use. See 2 Mbps & Coded PHY |
modIndex | Direct Test Mode Enhanced |
expectedCteLength | - Expected CTE length in 8 μs units. |
expectedCteType | - Expected CTE type as bitmask (bit 0 - Allow AoA CTE Response). |
slotDurations | - Switching and sampling slots in 1 us or 2 us each (1 or 2). |
length | - The number of Antenna IDs in the pattern (2 to 75). |
pAntenna | - List of Antenna IDs in the pattern. |
hciStatus_t HCI_LE_EnhancedCteTxTestCmd | ( | uint8 | txChan, |
uint8 | payloadLen, | ||
uint8 | payloadType, | ||
uint8 | txPhy, | ||
uint8 | cteLength, | ||
uint8 | cteType, | ||
uint8 | length, | ||
uint8 * | pAntenna | ||
) |
Start Enhanced CTE TX Test
Start a test where the DUT generates test reference packets at a fixed interval. The Controller shall transmit at maximum power.
txChan | Tx RF channel k=0..39, where F=2402+(k*2MHz). |
payloadLen | Byte length (0..37) in payload for each packet. |
payloadType | Direct Test Mode |
txPhy | Tx PHY to use. See 2 Mbps & Coded PHY |
cteLength | - CTE length in 8 μs units. |
cteType | - CTE type as bitmask (bit 0 - Allow AoA CTE Response). |
length | - The number of Antenna IDs in the pattern (2 to 75). |
pAntenna | - List of Antenna IDs in the pattern. |
hciStatus_t HCI_LE_EnhancedRxTestCmd | ( | uint8 | rxChan, |
uint8 | rxPhy, | ||
uint8 | modIndex | ||
) |
Start Enhanced RX Test
Start a test where the DUT receives reference packets at a fixed interval. The tester generates the test reference packets.
rxChan | Rx Channel k=0..39, where F=2402+(k*2MHz). |
rxPhy | Rx PHY to use. See 2 Mbps & Coded PHY |
modIndex | Direct Test Mode Enhanced |
hciStatus_t HCI_LE_EnhancedTxTestCmd | ( | uint8 | txChan, |
uint8 | payloadLen, | ||
uint8 | payloadType, | ||
uint8 | txPhy | ||
) |
Start Enhanced TX Test
Start a test where the DUT generates test reference packets at a fixed interval. The Controller shall transmit at maximum power.
txChan | Tx RF channel k=0..39, where F=2402+(k*2MHz). |
payloadLen | Byte length (0..37) in payload for each packet. |
payloadType | Direct Test Mode |
txPhy | Tx PHY to use. See 2 Mbps & Coded PHY |
hciStatus_t HCI_LE_GenerateDHKeyCmd | ( | uint8 * | publicKey | ) |
Generate Diffie-Hellman Key
This LE API is used to initiate the generation of a Diffie-Hellman key in the Controller for use over the LE transport. This command takes the remote P-256 public key as input. The Diffie-Hellman key generation uses the private key generated by LE_Read_Local_P256_Public_Key command.
publicKey | The remote P-256 public key (X-Y format). |
hciStatus_t HCI_LE_LtkReqNegReplyCmd | ( | uint16 | connHandle | ) |
Send a negative LTK reply to the Controller
connHandle | Connection handle. |
hciStatus_t HCI_LE_LtkReqReplyCmd | ( | uint16 | connHandle, |
uint8 * | ltk | ||
) |
Send a positive LTK reply to the controller
connHandle | Connection handle. |
ltk | Pointer to 16 byte Long Term Key. |
hciStatus_t HCI_LE_PeriodicAdvCreateSyncCancelCmd | ( | void | ) |
HCI_LE_PeriodicAdvCreateSyncCancelCmd
Used a scanner to cancel the HCI_LE_Periodic_Advertising_Create_Sync command while it is pending.
/ref did_286039104
hciStatus_t HCI_LE_PeriodicAdvCreateSyncCmd | ( | uint8 | options, |
uint8 | advSID, | ||
uint8 | advAddrType, | ||
uint8 * | advAddress, | ||
uint16 | skip, | ||
uint16 | syncTimeout, | ||
uint8 | syncCteType | ||
) |
HCI_LE_PeriodicAdvCreateSyncCmd
Used a scanner to synchronize with a periodic advertising train from an advertiser and begin receiving periodic advertising packets.
/ref did_286039104
options | - Clear Bit 0 - Use the advSID, advAddrType, and advAddress parameters to determine which advertiser to listen to. Set Bit 0 - Use the Periodic Advertiser List to determine which advertiser to listen to. Clear Bit 1 - Reporting initially enabled. Set Bit 1 - Reporting initially disabled. |
advSID | - Advertising SID subfield in the ADI field used to identify the Periodic Advertising (Range: 0x00 to 0x0F) |
advAddrType | - Advertiser address type - 0x00 - public ; 0x01 - random |
advAddress | - Advertiser address (6 bytes) |
skip | - The maximum number of periodic advertising events that can be skipped after a successful receive (Range: 0x0000 to 0x01F3) |
syncTimeout | - Synchronization timeout for the periodic advertising train Range: 0x000A to 0x4000 Time = N*10 ms Time Range: 100 ms to 163.84 s |
syncCteType | - Set Bit 0 - Do not sync to packets with an AoA CTE Set Bit 1 - Do not sync to packets with an AoD CTE with 1 us slots Set Bit 2 - Do not sync to packets with an AoD CTE with 2 us slots Set Bit 4 - Do not sync to packets without a CTE |
hciStatus_t HCI_LE_PeriodicAdvTerminateSyncCmd | ( | uint16 | syncHandle | ) |
HCI_LE_PeriodicAdvTerminateSyncCmd
Used a scanner to stop reception of the periodic advertising train identified by the syncHandle parameter.
/ref did_286039104
syncHandle | - Handle identifying the periodic advertising train (Range: 0x0000 to 0x0EFF) The handle was assigned by the Controller while generating the LE Periodic Advertising Sync Established event |
hciStatus_t HCI_LE_RandCmd | ( | void | ) |
Generate a random number.
The random number generation will not complete until any current radio operations end. If this is the case, the "status" of the pReturnParam of the initial hciEvt_CmdComplete_t will be set to LL_STATUS_ERROR_DUE_TO_DELAYED_RESOURCES (0x12). Another hciEvt_CmdComplete_t will be sent after the radio operations end that contains the random number.
hciStatus_t HCI_LE_ReadAdvChanTxPowerCmd | ( | void | ) |
Read transmit power when Advertising.
hciStatus_t HCI_LE_ReadAntennaInformationCmd | ( | void | ) |
Read the CTE antenna information.
/ref did_202754181
hciStatus_t HCI_LE_ReadBufSizeCmd | ( | void | ) |
Determine the maximum ACL data packet size allowed by the Controller.
hciStatus_t HCI_LE_ReadChannelMapCmd | ( | uint16 | connHandle | ) |
Read a connection's data channel map.
connHandle | Connection handle. |
hciStatus_t HCI_LE_ReadLocalP256PublicKeyCmd | ( | void | ) |
Read local P-256 Public Key
Read the local P-256 public key from the Controller. The Controller shall generate a new P-256 public / private key pair upon receipt of this command.
hciStatus_t HCI_LE_ReadLocalResolvableAddressCmd | ( | uint8 | localIdAddrType, |
uint8 * | localIdAddr | ||
) |
Read Local Resolvable Private Address
Get the current local Resolvable Private Address being used for the corresponding local Public or Random (Static) Identity Address.
localIdAddrType | Device Address Type |
localIdAddr | Local device Identity Address. |
hciStatus_t HCI_LE_ReadLocalSupportedFeaturesCmd | ( | void | ) |
Read the LE locally supported features.
hciStatus_t HCI_LE_ReadMaxDataLenCmd | ( | void | ) |
Read max data length
Read the maximum supported transmit and receive payload octets and packet duration times.
hciStatus_t HCI_LE_ReadPeerResolvableAddressCmd | ( | uint8 | peerIdAddrType, |
uint8 * | peerIdAddr | ||
) |
Read the Peer Resolvable Address
Get the current peer Resolvable Private Address being used for the corresponding peer Public or Random (Static) Identity Address.
peerIdAddrType | Device Address Type |
peerIdAddr | Peer device Identity Address. |
hciStatus_t HCI_LE_ReadPeriodicAdvListSizeCmd | ( | void | ) |
HCI_LE_ReadPeriodicAdvListSizeCmd
Used a scanner to read the total number of Periodic Advertiser list entries that can be stored in the Controller.
/ref did_286039104
hciStatus_t HCI_LE_ReadPhyCmd | ( | uint16 | connHandle | ) |
Read the current transmitter and receiver PHY.
connHandle | Connection handle. |
hciStatus_t HCI_LE_ReadRemoteUsedFeaturesCmd | ( | uint16 | connHandle | ) |
Read the remote device's used features.
connHandle | Connection handle. |
hciStatus_t HCI_LE_ReadResolvingListSizeCmd | ( | void | ) |
Read Resolving List Size
Read the total number of address translation entries in the resolving list that can be stored in the Controller.
hciStatus_t HCI_LE_ReadRfPathCompCmd | ( | void | ) |
Read the Tx and Rx RF Path Compensation values.
hciStatus_t HCI_LE_ReadSuggestedDefaultDataLenCmd | ( | void | ) |
Read Suggested Default Data Length
Read the default maximum transmit packet size and the default maximum packet transmit time to be used for new connections.
hciStatus_t HCI_LE_ReadSupportedStatesCmd | ( | void | ) |
Read the Controller's supported states.
hciStatus_t HCI_LE_ReadTxPowerCmd | ( | void | ) |
Read the minimum and maximum supported Tx Power.
hciStatus_t HCI_LE_ReadWhiteListSizeCmd | ( | void | ) |
Read the white list.
hciStatus_t HCI_LE_ReceiverTestCmd | ( | uint8 | rxChan | ) |
Start the receiver Direct Test Mode test.
rxChan | Rx Channel k=0..39, where F=2402+(k*2MHz). |
hciStatus_t HCI_LE_RemoteConnParamReqNegReplyCmd | ( | uint16 | connHandle, |
uint8 | reason | ||
) |
Negatively reply to the Connection Parameter Update Request
This LE API is used to negatively reply to the HCI LE Remote Connection Parameter Request event from the Controller. This command indicates that the Host has denied the remote device's request to change connection parameters.
connHandle | Connection handle. |
reason | Reason connection parameter request was rejected. |
hciStatus_t HCI_LE_RemoteConnParamReqReplyCmd | ( | uint16 | connHandle, |
uint16 | connIntervalMin, | ||
uint16 | connIntervalMax, | ||
uint16 | connLatency, | ||
uint16 | connTimeout, | ||
uint16 | minLen, | ||
uint16 | maxLen | ||
) |
Positively reply to the Connection Parameter Update Request
This LE API is used to positively reply to the HCI LE Remote Connection Parameter Request event from the Controller. This command indicates that the Host has accepted the remote device's request to change connection parameters.
connHandle | Connection handle. |
connIntervalMin | Minimum allowed connection interval. |
connIntervalMax | Maximum allowed connection interval. |
connLatency | Number of skipped events (slave latency). |
connTimeout | Connection supervision timeout. |
minLen | Info parameter about min length of conn. |
maxLen | Info parameter about max length of conn. |
hciStatus_t HCI_LE_RemoveDeviceFromPeriodicAdvListCmd | ( | uint8 | advAddrType, |
uint8 * | advAddress, | ||
uint8 | advSID | ||
) |
HCI_LE_RemoveDeviceFromPeriodicAdvListCmd
Used a scanner to remove one entry from the list of Periodic Advertisers stored in the Controller.
/ref did_286039104
advAddrType | - Advertiser address type - 0x00 - Public or Public Identity Address 0x01 - Random or Random (static) Identity Address |
advAddress | - Advertiser address (6 bytes) |
advSID | - Advertising SID subfield in the ADI field used to identify the Periodic Advertising (Range: 0x00 to 0x0F) |
hciStatus_t HCI_LE_RemoveDeviceFromResolvingListCmd | ( | uint8 | peerIdAddrType, |
uint8 * | peerIdAddr | ||
) |
Remove a device from the whitelist
Remove one device from the list of address translations used to resolve Resolvable Private Addresses in the Controller.
peerIdAddrType | Device Address Type |
peerIdAddr | Peer device Identity Address. |
hciStatus_t HCI_LE_RemoveWhiteListCmd | ( | uint8 | addrType, |
uint8 * | devAddr | ||
) |
Remove a white list entry.
addrType | Device Address Type |
devAddr | Pointer to address of device to remove from the white list. |
hciStatus_t HCI_LE_SetAddressResolutionEnableCmd | ( | uint8 | addrResolutionEnable | ) |
Disable / Enable Address Resolution
Enable resolution of Resolvable Private Addresses in the Controller. This causes the Controller to use the resolving list whenever the Controller receives a local or peer Resolvable Private Address.
addrResolutionEnable | Privacy 1.2 |
hciStatus_t HCI_LE_SetAdvDataCmd | ( | uint8 | dataLen, |
uint8 * | pData | ||
) |
Set the Advertising data.
dataLen | Length of Advertising data. |
pData | Pointer to Advertising data. |
hciStatus_t HCI_LE_SetAdvEnableCmd | ( | uint8 | advEnable | ) |
Turn Advertising on or off.
advEnable | Advertiser Commands |
hciStatus_t HCI_LE_SetAdvParamCmd | ( | uint16 | advIntervalMin, |
uint16 | advIntervalMax, | ||
uint8 | advType, | ||
uint8 | ownAddrType, | ||
uint8 | directAddrType, | ||
uint8 * | directAddr, | ||
uint8 | advChannelMap, | ||
uint8 | advFilterPolicy | ||
) |
Set the Advertising parameters.
advIntervalMin | Minimum allowed advertising interval. |
advIntervalMax | Maximum allowed advertising interval. |
advType | Advertiser Type |
ownAddrType |
hciStatus_t HCI_LE_SetAdvStatus | ( | aeEnableCmd_t * | pCmdParams | ) |
Set the Advertising status. This function will be called only when BLE3_CMD compilation flag is set
pCmdParams | - Pointer to input parameters |
hciStatus_t HCI_LE_SetConnectionCteReceiveParamsCmd | ( | uint16 | connHandle, |
uint8 | samplingEnable, | ||
uint8 | slotDurations, | ||
uint8 | length, | ||
uint8 * | pAntenna | ||
) |
Used to enable or disable sampling received Constant Tone Extension fields on a connection and to set the antenna switching pattern and switching and sampling slot durations to be used.
/ref did_202754181
connHandle | - Connection handle. |
samplingEnable | - Sample CTE on a connection and report the samples to the Host (0 or 1). |
slotDurations | - Switching and sampling slots in 1 us or 2 us each (1 or 2). |
length | - The number of Antenna IDs in the pattern (2 to 75). |
pAntenna | - List of Antenna IDs in the pattern. |
hciStatus_t HCI_LE_SetConnectionCteRequestEnableCmd | ( | uint16 | connHandle, |
uint8 | enable, | ||
uint16 | interval, | ||
uint8 | length, | ||
uint8 | type | ||
) |
Start or stop initiating the CTE Request procedure on a connection.
/ref did_202754181
connHandle | - Connection handle. |
enable | - Enable or disable CTE Request for a connection (1 or 0). |
interval | - Requested interval for initiating the CTE Request procedure in number of connection events (1 to 0xFFFF) |
length | - Min length of the CTE being requested in 8 us units (2 to 20). |
type | - Requested CTE type (0 - AoA, 1 - AoD with 1us slots, 2 - AoD with 2us slots). |
hciStatus_t HCI_LE_SetConnectionCteResponseEnableCmd | ( | uint16 | connHandle, |
uint8 | enable | ||
) |
Set a respond to LL_CTE_REQ PDUs with LL_CTE_RSP PDUs on a connection.
/ref did_202754181
connHandle | - Connection handle. |
enable | - Enable or disable CTE Response for a connection (1 or 0). |
hciStatus_t HCI_LE_SetConnectionCteTransmitParamsCmd | ( | uint16 | connHandle, |
uint8 | types, | ||
uint8 | length, | ||
uint8 * | pAntenna | ||
) |
Set the antenna switching pattern and permitted Constant Tone Extension types used for transmitting Constant Tone Extensions requested by the peer device on a connection.
/ref did_202754181
connHandle | - Connection handle. |
types | - CTE types as bitmask (bit 0 - Allow AoA CTE Response). |
length | - The number of Antenna IDs in the pattern (2 to 75). |
pAntenna | - List of Antenna IDs in the pattern. |
hciStatus_t HCI_LE_SetConnectionlessCteTransmitEnableCmd | ( | uint8 | advHandle, |
uint8 | enable | ||
) |
Used by the Host to request that the Controller enables or disables the use of Constant Tone Extensions in any periodic advertising.
advHandle | - Used to identify a periodic advertising train |
enable | - 0x00 - Advertising with CTE is disabled (default) 0x01 - Advertising with CTE is enabled |
hciStatus_t HCI_LE_SetConnectionlessCteTransmitParamsCmd | ( | uint8 | advHandle, |
uint8 | cteLen, | ||
uint8 | cteType, | ||
uint8 | cteCount, | ||
uint8 | length, | ||
uint8 * | pAntenna | ||
) |
Used by the Host to set the type, length, and antenna switching pattern for the transmission of Constant Tone Extensions in any periodic advertising.
advHandle | - Used to identify a periodic advertising train |
cteLen | - CTE length (0x02 - 0x14) 16 usec - 160 usec |
cteType | - CTE type (0 - AoA, 1 - AoD 1usec, 2 - AoD 2usec) |
cteCount | - Number of CTE's to transmit in the same periodic event |
length | - Number of items in Antenna array (relevant to AoD only) |
pAntenna | - Pointer to Antenna array (relevant to AoD only) |
hciStatus_t HCI_LE_SetConnectionlessIqSamplingEnableCmd | ( | uint16 | syncHandle, |
uint8 | samplingEnable, | ||
uint8 | slotDurations, | ||
uint8 | maxSampledCtes, | ||
uint8 | length, | ||
uint8 * | pAntenna | ||
) |
HCI_LE_SetConnectionlessIqSamplingEnableCmd
Used by the Host to request that the Controller enables or disables capturing IQ samples from the CTE of periodic advertising packets in the periodic advertising train identified by the syncHandle parameter.
syncHandle | - Handle identifying the periodic advertising train (Range: 0x0000 to 0x0EFF) |
samplingEnable | - Sample CTE on a received periodic advertising and report the samples to the Host. |
slotDurations | - Switching and sampling slots in 1 us or 2 us each (1 or 2). |
maxSampledCtes | - 0 - Sample and report all available CTEs 1 to 16 - Max number of CTEs to sample and report in each periodic event |
length | - Number of items in Antenna array (relevant to AoA only) |
pAntenna | - Pointer to Antenna array (relevant to AoA only) |
hciStatus_t HCI_LE_SetDataLenCmd | ( | uint16 | connHandle, |
uint16 | txOctets, | ||
uint16 | txTime | ||
) |
Set Data Length
Set the maximum transmission packet size and the maximum packet transmission time for the connection.
connHandle | Connection handle. |
txOctets | Maximum transmit payload size (in bytes). |
txTime | Maximum transmit time (in us). |
hciStatus_t HCI_LE_SetDefaultPhyCmd | ( | uint8 | allPhys, |
uint8 | txPhy, | ||
uint8 | rxPhy | ||
) |
Set Default PHY
Allows the Host to specify its preferred values for the transmitter and receiver PHY to be used for all subsequent connections.
allPhys | Host preference on how to handle txPhy and rxPhy. |
txPhy | Bit field of Host preferred Tx PHY. See 2 Mbps & Coded PHY |
rxPhy | Bit field of Host preferred Rx PHY. See 2 Mbps & Coded PHY |
hciStatus_t HCI_LE_SetEventMaskCmd | ( | uint8 * | pEventMask | ) |
Set the HCI LE event mask
The event mask to determine which LE events are supported.
pEventMask | Pointer to LE event mask of 8 bytes. |
hciStatus_t HCI_LE_SetExtAdvData | ( | aeSetDataCmd_t * | pCmdParams | ) |
Set the Advertising data. This function will be called only when BLE3_CMD compilation flag is set
pCmdParams | - Pointer to input parameters |
hciStatus_t HCI_LE_SetExtScanRspData | ( | aeSetDataCmd_t * | pCmdParams | ) |
Set the Advertising Scan Response data. This function will be called only when BLE3_CMD compilation flag is set
pCmdParams | - Pointer to input parameters |
hciStatus_t HCI_LE_SetHostChanClassificationCmd | ( | uint8 * | chanMap | ) |
Update the current data channel map.
chanMap | Pointer to the new channel map. |
hciStatus_t HCI_LE_SetPeriodicAdvDataCmd | ( | uint8 | advHandle, |
uint8 | operation, | ||
uint8 | dataLength, | ||
uint8 * | data | ||
) |
Used to set the advertiser data used in periodic advertising PDUs. This command may be issued at any time after the advertising set identified by the Advertising_Handle parameter has been configured for periodic advertising using the HCI_LE_Set_Periodic_Advertising_Parameters command.
/ref did_286039104
advHandle | - Used to identify a periodic advertising train |
operation | - 0x00 - Intermediate fragment of fragmented periodic advertising data 0x01 - First fragment of fragmented periodic advertising data 0x02 - Last fragment of fragmented periodic advertising data 0x03 - Complete periodic advertising data |
dataLength | - The number of bytes in the Advertising Data parameter |
data | - Periodic advertising data |
hciStatus_t HCI_LE_SetPeriodicAdvEnableCmd | ( | uint8 | enable, |
uint8 | advHandle | ||
) |
Used to request the advertiser to enable or disable the periodic advertising for the advertising set.
/ref did_286039104
enable | - 0x00 - Periodic advertising is disabled (default) 0x01 - Periodic advertising is enabled |
advHandle | - Used to identify a periodic advertising train |
hciStatus_t HCI_LE_SetPeriodicAdvParamsCmd | ( | uint8 | advHandle, |
uint16 | periodicAdvIntervalMin, | ||
uint16 | periodicAdvIntervalMax, | ||
uint16 | periodicAdvProp | ||
) |
Used by the Host to set the advertiser parameters for periodic advertising
/ref did_286039104
advHandle | - Used to identify a periodic advertising train Created by LE Set Extended Advertising Parameters command |
periodicAdvIntervalMin | - Minimum advertising interval for periodic advertising Range: 0x0006 to 0xFFFF Time = N * 1.25 ms Time Range: 7.5ms to 81.91875 s |
periodicAdvIntervalMax | - Maximum advertising interval for periodic advertising Range: 0x0006 to 0xFFFF Time = N * 1.25 ms Time Range: 7.5ms to 81.91875 s |
periodicAdvProp | - Periodic advertising properties Set bit 6 for include TxPower in the advertising PDU |
hciStatus_t HCI_LE_SetPeriodicAdvReceiveEnableCmd | ( | uint16 | syncHandle, |
uint8 | enable | ||
) |
HCI_LE_SetPeriodicAdvReceiveEnableCmd
Used a scanner to enable or disable reports for the periodic advertising train identified by the syncHandle parameter.
/ref did_286039104
syncHandle | - Handle identifying the periodic advertising train (Range: 0x0000 to 0x0EFF) The handle was assigned by the Controller while generating the LE Periodic Advertising Sync Established event |
enable | - 0x00 - Reporting disable 0x01 - Reporting enable |
hciStatus_t HCI_LE_SetPhyCmd | ( | uint16 | connHandle, |
uint8 | allPhys, | ||
uint8 | txPhy, | ||
uint8 | rxPhy, | ||
uint16 | phyOpts | ||
) |
Request a change to the transmitter and receiver PHY for a connection.
connHandle | Connection handle. |
allPhys | Host preference on how to handle txPhy and rxPhy. |
txPhy | Bit field of Host preferred Tx PHY. |
rxPhy | Bit field of Host preferred Rx PHY. |
phyOpts | Bit field of Host preferred PHY options. |
hciStatus_t HCI_LE_SetPrivacyModeCmd | ( | uint8 | peerIdAddrType, |
uint8 * | peerIdAddr, | ||
uint8 | privacyMode | ||
) |
Set Privacy Mode
Set the Privacy Mode to either Network Privacy Mode or Device Privacy Mode. The Privacy Mode can be set for any peer in the Resolving List.
peerIdAddrType | Device Address Type |
peerIdAddr | Peer device Identity Address. |
privacyMode | HCI_NETWORK_PRIVACY_MODE HCI_DEVICE_PRIVACY_MODE |
hciStatus_t HCI_LE_SetRandomAddressCmd | ( | uint8 * | pRandAddr | ) |
Set this device's Random address.
pRandAddr | Pointer to random address. |
hciStatus_t HCI_LE_SetResolvablePrivateAddressTimeoutCmd | ( | uint16 | rpaTimeout | ) |
Set Resolvable Private Address Timeout
Set the length of time the Controller uses a Resolvable Private Address before a new Resolvable Private Address is generated and starts being used.
rpaTimeout | RPA timeout (in secs). |
hciStatus_t HCI_LE_SetScanEnableCmd | ( | uint8 | scanEnable, |
uint8 | filterDuplicates | ||
) |
Turn Scanning on or off.
scanEnable | Scan Commands |
filterDuplicates | Scan Filtering |
hciStatus_t HCI_LE_SetScanParamCmd | ( | uint8 | scanType, |
uint16 | scanInterval, | ||
uint16 | scanWindow, | ||
uint8 | ownAddrType, | ||
uint8 | filterPolicy | ||
) |
Set the Scan parameters.
scanType |
hciStatus_t HCI_LE_SetScanRspDataCmd | ( | uint8 | dataLen, |
uint8 * | pData | ||
) |
Set the Advertising Scan Response data.
dataLen | Length of Scan Response data. |
pData | Pointer to Scan Response data. |
hciStatus_t HCI_LE_StartEncyptCmd | ( | uint16 | connHandle, |
uint8 * | random, | ||
uint8 * | encDiv, | ||
uint8 * | ltk | ||
) |
Start encryption in a connection.
connHandle | Connection handle. |
random | Pointer to eight byte Random number. |
encDiv | Pointer to two byte Encrypted Diversifier. |
ltk | Pointer to 16 byte Long Term Key. |
hciStatus_t HCI_LE_TestEndCmd | ( | void | ) |
End the Direct Test Mode test.
hciStatus_t HCI_LE_TransmitterTestCmd | ( | uint8 | txChan, |
uint8 | dataLen, | ||
uint8 | pktPayload | ||
) |
This LE API is used to start the transmit Direct Test Mode test.
The Controller shall transmit at maximum power.
txChan | Tx RF frequency k=0..39, where F=2402+(k*2MHz). |
dataLen | Test data length: 0..37 bytes |
pktPayload | Direct Test Mode |
hciStatus_t HCI_LE_WriteRfPathCompCmd | ( | int16 | txPathParam, |
int16 | rxPathParam | ||
) |
Write the Tx and Rx RF Path Compensation values.
txPathParam | Tx path compensation parameter (in 0.1 dBm). |
rxPathParam | Rx path compensation parameter (in 0.1 dBm). |
hciStatus_t HCI_LE_WriteSuggestedDefaultDataLenCmd | ( | uint16 | txOctets, |
uint16 | txTime | ||
) |
Write Suggested Default Data Length
Set the default maximum transmission packet size and the default maximum packet transmission time for the connection.
txOctets | Maximum transmit payload size (in bytes). |
txTime | Maximum transmit time (in us). |
hciStatus_t HCI_ReadAuthPayloadTimeoutCmd | ( | uint16 | connHandle, |
uint16 * | aptoValue | ||
) |
Read the connection's Authenticated Payload Timeout value.
connHandle | The LL connection ID to read the APTO value from. |
aptoValue | Pointer to current APTO value, in units of 10 ms. |
hciStatus_t HCI_ReadBDADDRCmd | ( | void | ) |
Read this device's BLE address (BDADDR).
hciStatus_t HCI_ReadLocalSupportedCommandsCmd | ( | void | ) |
Read the locally supported commands.
hciStatus_t HCI_ReadLocalSupportedFeaturesCmd | ( | void | ) |
Read the locally supported features.
hciStatus_t HCI_ReadLocalVersionInfoCmd | ( | void | ) |
Read the local version information.
hciStatus_t HCI_ReadRemoteVersionInfoCmd | ( | uint16 | connHandle | ) |
Request version information from the remote device in a connection.
connHandle | Connection handle. |
hciStatus_t HCI_ReadRssiCmd | ( | uint16 | connHandle | ) |
Read RSSI of last packet
Read the RSSI of the last packet received on a connection given by the connection handle. If the Receiver Modem test is running (HCI_EXT_ModemTestRxCmd ), then the RF RSSI for the last received data will be returned. If there is no RSSI value, then HCI_RSSI_NOT_AVAILABLE will be returned.
connHandle | Connection handle. |
hciStatus_t HCI_ReadTransmitPowerLevelCmd | ( | uint16 | connHandle, |
uint8 | txPwrType | ||
) |
Read the transmit power level.
connHandle | Connection handle. |
txPwrType | ref TX_Power_Mode |
hciStatus_t HCI_ResetCmd | ( | void | ) |
Reset the Link Layer.
hciStatus_t HCI_SetEventMaskCmd | ( | uint8 * | pMask | ) |
Set the HCI event mask
The event mask is used to determine which events are supported.
pMask | Pointer to an eight byte event mask. |
hciStatus_t HCI_SetEventMaskPage2Cmd | ( | uint8 * | pMask | ) |
Set the HCI event mask page 2
The HCI Event mask page 2 is used to determine which events are supported.
pMask | Pointer to an eight byte event mask. |
hciStatus_t HCI_WriteAuthPayloadTimeoutCmd | ( | uint16 | connHandle, |
uint16 | aptoValue | ||
) |
Used to write the connection's Authenticated Payload Timeout value.
connHandle | The LL connection ID to write the APTO value to. |
aptoValue | The APTO value, in units of 10 ms. |