TI BLE5-Stack API Documentation  2.01.03.00
Modules | Macros | Variables
HCI Constants

Modules

 2 Mbps & Coded PHY
 
 Advertiser Channels
 
 Advertiser Commands
 
 Advertiser Type
 
 Advertiser White List Policy
 
 Device Address Type
 
 Direct Test Mode
 
 Direct Test Mode Enhanced
 
 Direct Test Mode Options
 
 Disconnect Reasons
 
 
 Fast Tx Response Time
 
 Frequency Tuning
 
 HCI Command API Parameters
 
 HCI Error Codes
 
 Host Flow Control Flow Control Options
 
 Initiator White List Policy
 
 NV in/not in use
 
 Number of Completed Packets
 
 One Packet Per Event
 
 PHY Update Complete Event
 
 Packet Error Rate Command
 
 Privacy 1.2
 
 RX Gain
 
 Read TX Power Mode
 
 Reset Type
 
 Scan Commands
 
 Scan Filtering
 
 Scan Request Report
 
 Scan Types
 
 Scan White List Policy
 
 Set User Revision Command
 
 Slave Latency Override
 
 TX Modulation
 
 TX Power Index
 

Macros

#define CONTINUING_PKT   LL_DATA_CONTINUATION_PKT
 Continuing Packet.
 
#define FIRST_PKT_CTRL_TO_HOST   LL_DATA_FIRST_PKT_CTRL_TO_HOST
 First Packet Controller to Host.
 
#define FIRST_PKT_HOST_TO_CTRL   LL_DATA_FIRST_PKT_HOST_TO_CTRL
 First Host to Controller Packet.
 
#define HCI_APTO_EXPIRED_EVENT_CODE   0x57
 event of type hciEvt_AptoExpired_t
 
#define HCI_BLE_ADV_REPORT_EVENT   0x02
 event of type hciEvt_DevInfo_t
 
#define HCI_BLE_ADV_SET_TERMINATED_EVENT   0x12
 Adv Set Terminated.
 
#define HCI_BLE_BLE_LOG_STRINGS_MAX   0x17
 
#define HCI_BLE_CHANNEL_MAP_UPDATE_EVENT   0x82
 event of type hciEvt_BLEChanMapUpdate_t
 
#define HCI_BLE_CHANNEL_SELECTION_ALGORITHM_EVENT   0x14
 Channel Selection Algorithm.
 
#define HCI_BLE_CONN_UPDATE_COMPLETE_EVENT   0x03
 event of type hciEvt_BLEConnUpdateComplete_t
 
#define HCI_BLE_CONN_UPDATE_REJECT_EVENT   0x83
 event of type hciEvt_BLEConnUpdateComplete_t
 
#define HCI_BLE_CONNECTION_COMPLETE_EVENT   0x01
 event of type hciEvt_BLEConnComplete_t
 
#define HCI_BLE_CONNECTION_IQ_REPORT_EVENT   0x16
 CTE sample connection report.
 
#define HCI_BLE_CONNECTIONLESS_IQ_REPORT_EVENT   0x15
 CTE sample connectionless report.
 
#define HCI_BLE_CTE_REQUEST_FAILED_EVENT   0x17
 CTE sample failed.
 
#define HCI_BLE_DATA_LENGTH_CHANGE_EVENT   0x07
 event of type hciEvt_BLEDataLengthChange_t
 
#define HCI_BLE_DIRECT_ADVERTISING_REPORT_EVENT   0x0B
 direct advertising report...not used
 
#define HCI_BLE_ENHANCED_CONNECTION_COMPLETE_EVENT   0x0A
 event of type hciEvt_BLEEnhConnComplete_t
 
#define HCI_BLE_EXT_CONNECTION_IQ_REPORT_EVENT   0x81
 event of type hciEvt_BLEExtCteConnectionIqReport_t
 
#define HCI_BLE_EXTENDED_ADV_REPORT_EVENT   0x0D
 Extended Adv Report.
 
#define HCI_BLE_GENERATE_DHKEY_COMPLETE_EVENT   0x09
 event of type hciEvt_BLEGenDHKeyComplete_t
 
#define HCI_BLE_HARDWARE_ERROR_EVENT_CODE   0x10
 event of type hciEvt_HardwareError_t
 
#define HCI_BLE_LTK_REQUESTED_EVENT   0x05
 event of type hciEvt_BLELTKReq_t
 
#define HCI_BLE_PERIODIC_ADV_REPORT_EVENT   0x0F
 Periodic Adv Report.
 
#define HCI_BLE_PERIODIC_ADV_SYNCH_ESTABLISHED_EVENT   0x0E
 Periodic Adv Synch Established.
 
#define HCI_BLE_PERIODIC_ADV_SYNCH_LOST_EVENT   0x10
 Periodic Adv Synch Lost.
 
#define HCI_BLE_PHY_UPDATE_COMPLETE_EVENT   0x0C
 event of type hciEvt_BLEPhyUpdateComplete_t
 
#define HCI_BLE_READ_LOCAL_P256_PUBLIC_KEY_COMPLETE_EVENT   0x08
 event of type hciEvt_BLEReadP256PublicKeyComplete_t
 
#define HCI_BLE_READ_REMOTE_FEATURE_COMPLETE_EVENT   0x04
 event of type hciEvt_BLEReadRemoteFeatureComplete_t
 
#define HCI_BLE_REMOTE_CONN_PARAM_REQUEST_EVENT   0x06
 event of type hciEvt_BLERemoteConnParamReq_t
 
#define HCI_BLE_SCAN_REQ_REPORT_EVENT   0x80
 event of type hciEvt_BLEScanReqReport_t
 
#define HCI_BLE_SCAN_REQUEST_RECEIVED_EVENT   0x13
 Scan Request Received.
 
#define HCI_BLE_SCAN_TIMEOUT_EVENT   0x11
 Scan Timeout.
 
#define HCI_COMMAND_COMPLETE_EVENT_CODE   0x0E
 event of type hciEvt_CmdComplete_t
 
#define HCI_COMMAND_STATUS_EVENT_CODE   0x0F
 event of type hciEvt_CommandStatus_t
 
#define HCI_DATA_BUFFER_OVERFLOW_EVENT   0x1A
 event of type hciEvt_BufferOverflow_t
 
#define HCI_DISCONNECTION_COMPLETE_EVENT_CODE   0x05
 event of type hciEvt_DisconnComplete_t
 
#define HCI_ENCRYPTION_CHANGE_EVENT_CODE   0x08
 event of type hciEvt_EncryptChange_t
 
#define HCI_EXT_BUILD_REVISION   0xFC1B
 
#define HCI_EXT_BUILD_REVISION_EVENT   0x041B
 
#define HCI_EXT_DECRYPT   0xFC05
 opcode of HCI_EXT_DecryptCmd
 
#define HCI_EXT_DECRYPT_EVENT   0x0405
 event from HCI_EXT_DecryptCmd
 
#define HCI_EXT_DISCONNECT_IMMED   0xFC13
 opcode of HCI_EXT_DisconnectImmedCmd
 
#define HCI_EXT_DISCONNECT_IMMED_EVENT   0x0413
 event from HCI_EXT_DisconnectImmedCmd
 
#define HCI_EXT_ENABLE_PTM   0xFC0E
 opcode of HCI_EXT_EnablePTMCmd
 
#define HCI_EXT_ENABLE_PTM_EVENT   0x040E
 event from HCI_EXT_EnablePTMCmd
 
#define HCI_EXT_END_MODEM_TEST   0xFC0B
 
#define HCI_EXT_END_MODEM_TEST_EVENT   0x040B
 
#define HCI_EXT_ENHANCED_MODEM_HOP_TEST_TX   0xFC28
 opcode of HCI_EXT_EnhancedModemHopTestTxCmd
 
#define HCI_EXT_ENHANCED_MODEM_HOP_TEST_TX_EVENT   0x0428
 event from HCI_EXT_EnhancedModemHopTestTxCmd
 
#define HCI_EXT_ENHANCED_MODEM_TEST_RX   0xFC29
 opcode of HCI_EXT_EnhancedModemTestRxCmd
 
#define HCI_EXT_ENHANCED_MODEM_TEST_RX_EVENT   0x0429
 event from HCI_EXT_EnhancedModemTestRxCmd
 
#define HCI_EXT_ENHANCED_MODEM_TEST_TX   0xFC27
 opcode of HCI_EXT_EnhancedModemTestTxCmd
 
#define HCI_EXT_ENHANCED_MODEM_TEST_TX_EVENT   0x0427
 event from HCI_EXT_EnhancedModemTestTxCmd
 
#define HCI_EXT_LE_ADV_EVENT   0x0425
 Extended advertisement event.
 
#define HCI_EXT_LE_SCAN_EVENT   0x0426
 Extended Scanner event.
 
#define HCI_EXT_MODEM_HOP_TEST_TX   0xFC09
 opcode of HCI_EXT_ModemHopTestTxCmd
 
#define HCI_EXT_MODEM_HOP_TEST_TX_EVENT   0x0409
 event from HCI_EXT_ModemHopTestTxCmd
 
#define HCI_EXT_MODEM_TEST_RX   0xFC0A
 opcode of HCI_EXT_ModemTestRxCmd
 
#define HCI_EXT_MODEM_TEST_RX_EVENT   0x040A
 event from HCI_EXT_ModemTestRxCmd
 
#define HCI_EXT_MODEM_TEST_TX   0xFC08
 opcode of HCI_EXT_ModemTestTxCmd
 
#define HCI_EXT_MODEM_TEST_TX_EVENT   0x0408
 event from HCI_EXT_ModemTestTxCmd
 
#define HCI_EXT_NUM_COMPLETED_PKTS_LIMIT   0xFC1F
 
#define HCI_EXT_NUM_COMPLETED_PKTS_LIMIT_EVENT   0x041F
 
#define HCI_EXT_ONE_PKT_PER_EVT   0xFC02
 
#define HCI_EXT_ONE_PKT_PER_EVT_EVENT   0x0402
 
#define HCI_EXT_OVERRIDE_SL   0xFC1A
 opcode of HCI_EXT_SetSlaveLatencyOverrideCmd
 
#define HCI_EXT_PER   0xFC14
 opcode of HCI_EXT_PacketErrorRateCmd
 
#define HCI_EXT_PER_BY_CHAN   0xFC15
 
#define HCI_EXT_PER_BY_CHAN_EVENT   0x0415
 
#define HCI_EXT_PER_EVENT   0x0414
 event from HCI_EXT_PacketErrorRateCmd
 
#define HCI_EXT_RESET_SYSTEM   0xFC1D
 
#define HCI_EXT_RESET_SYSTEM_EVENT   0x041D
 
#define HCI_EXT_SAVE_FREQ_TUNE   0xFC10
 opcode of HCI_EXT_SaveFreqTuneCmd
 
#define HCI_EXT_SAVE_FREQ_TUNE_EVENT   0x0410
 event from HCI_EXT_SaveFreqTuneCmd
 
#define HCI_EXT_SET_DTM_TX_PKT_CNT   0xFC24
 
#define HCI_EXT_SET_DTM_TX_PKT_CNT_EVENT   0x0424
 
#define HCI_EXT_SET_FAST_TX_RESP_TIME   0xFC07
 opcode of HCI_EXT_SetFastTxResponseTimeCmd
 
#define HCI_EXT_SET_FAST_TX_RESP_TIME_EVENT   0x0407
 event from HCI_EXT_SetFastTxResponseTimeCmd
 
#define HCI_EXT_SET_FREQ_TUNE   0xFC0F
 opcode of HCI_EXT_SetFreqTuneCmd
 
#define HCI_EXT_SET_FREQ_TUNE_EVENT   0x040F
 event from HCI_EXT_SetFreqTuneCmd
 
#define HCI_EXT_SET_LOCAL_SUPPORTED_FEATURES   0xFC06
 opcode of HCI_EXT_SetLocalSupportedFeaturesCmd
 
#define HCI_EXT_SET_LOCAL_SUPPORTED_FEATURES_EVENT   0x0406
 event from HCI_EXT_SetLocalSupportedFeaturesCmd
 
#define HCI_EXT_SET_MAX_DATA_LENGTH   0xFC21
 opcode of HCI_EXT_SetMaxDataLenCmd
 
#define HCI_EXT_SET_MAX_DATA_LENGTH_EVENT   0x0421
 event from HCI_EXT_SetMaxDataLenCmd
 
#define HCI_EXT_SET_MAX_DTM_TX_POWER   0xFC11
 
#define HCI_EXT_SET_MAX_DTM_TX_POWER_EVENT   0x0411
 
#define HCI_EXT_SET_RX_GAIN   0xFC00
 //NODOC More...
 
#define HCI_EXT_SET_RX_GAIN_EVENT   0x0400
 event from HCI_EXT_SetRxGainCmd
 
#define HCI_EXT_SET_SCA   0xFC0D
 opcode of HCI_EXT_SetSCACmd
 
#define HCI_EXT_SET_SCA_EVENT   0x040D
 event from HCI_EXT_SetSCACmd
 
#define HCI_EXT_SET_TX_POWER   0xFC01
 opcode of HCI_EXT_SetTxPowerCmd
 
#define HCI_EXT_SET_TX_POWER_EVENT   0x0401
 event from HCI_EXT_SetTxPowerCmd
 
#define HCI_HOST_NUM_COMPLETED_PACKETS   0x0C35
 opcode of HCI_HostNumCompletedPktCmd
 
#define HCI_KEY_REFRESH_COMPLETE_EVENT_CODE   0x30
 event of type hciPacket_t
 
#define HCI_LE_ADD_DEVICE_TO_RESOLVING_LIST   0x2027
 opcode of HCI_LE_AddDeviceToResolvingListCmd
 
#define HCI_LE_ADD_WHITE_LIST   0x2011
 opcode of HCI_LE_AddWhiteListCmd
 
#define HCI_LE_CLEAR_RESOLVING_LIST   0x2029
 opcode of HCI_LE_ClearResolvingListCmd
 
#define HCI_LE_CLEAR_WHITE_LIST   0x2010
 opcode of HCI_LE_ClearWhiteListCmd
 
#define HCI_LE_ENCRYPT   0x2017
 opcode of HCI_LE_EncryptCmd
 
#define HCI_LE_ENHANCED_RECEIVER_TEST   0x2033
 opcode of HCI_LE_EnhancedRxTestCmd
 
#define HCI_LE_ENHANCED_TRANSMITTER_TEST   0x2034
 opcode of HCI_LE_EnhancedTxTestCmd
 
#define HCI_LE_EVENT_CODE   0x3E
 LE Event.
 
#define HCI_LE_RAND   0x2018
 
#define HCI_LE_READ_BUFFER_SIZE   0x2002
 opcode of HCI_LE_ReadBufSizeCmd
 
#define HCI_LE_READ_CHANNEL_MAP   0x2015
 opcode of HCI_LE_ReadChannelMapCmd
 
#define HCI_LE_READ_LOCAL_RESOLVABLE_ADDRESS   0x202C
 
#define HCI_LE_READ_LOCAL_SUPPORTED_FEATURES   0x2003
 
#define HCI_LE_READ_MAX_DATA_LENGTH   0x202F
 opcode of HCI_LE_ReadMaxDataLenCmd
 
#define HCI_LE_READ_PEER_RESOLVABLE_ADDRESS   0x202B
 opcode of HCI_LE_ReadPeerResolvableAddressCmd
 
#define HCI_LE_READ_PHY   0x2030
 opcode of HCI_LE_ReadPhyCmd
 
#define HCI_LE_READ_REMOTE_USED_FEATURES   0x2016
 opcode of HCI_LE_ReadRemoteUsedFeaturesCmd
 
#define HCI_LE_READ_RESOLVING_LIST_SIZE   0x202A
 opcode of HCI_LE_ReadResolvingListSizeCmd
 
#define HCI_LE_READ_RF_PATH_COMPENSATION   0x204C
 opcode of HCI_LE_ReadRfPathCompCmd
 
#define HCI_LE_READ_SUGGESTED_DEFAULT_DATA_LENGTH   0x2023
 opcode of HCI_LE_ReadSuggestedDefaultDataLenCmd
 
#define HCI_LE_READ_SUPPORTED_STATES   0x201C
 opcode of HCI_LE_ReadSupportedStatesCmd
 
#define HCI_LE_READ_TX_POWER   0x204B
 opcode of HCI_LE_ReadTxPowerCmd
 
#define HCI_LE_READ_WHITE_LIST_SIZE   0x200F
 opcode of HCI_LE_ReadWhiteListSizeCmd
 
#define HCI_LE_RECEIVER_TEST   0x201D
 opcode of HCI_LE_ReceiverTestCmd
 
#define HCI_LE_REMOVE_DEVICE_FROM_RESOLVING_LIST   0x2028
 opcode of HCI_LE_RemoveDeviceFromResolvingListCmd
 
#define HCI_LE_REMOVE_WHITE_LIST   0x2012
 
#define HCI_LE_SET_DATA_LENGTH   0x2022
 opcode of HCI_LE_SetDataLenCmd
 
#define HCI_LE_SET_DEFAULT_PHY   0x2031
 opcode of HCI_LE_SetDefaultPhyCmd
 
#define HCI_LE_SET_EVENT_MASK   0x2001
 opcode of HCI_LE_SetEventMaskCmd
 
#define HCI_LE_SET_HOST_CHANNEL_CLASSIFICATION   0x2014
 opcode of HCI_LE_SetHostChanClassificationCmd
 
#define HCI_LE_SET_PHY   0x2032
 opcode of HCI_LE_SetPhyCmd
 
#define HCI_LE_SET_PRIVACY_MODE   0x204E
 opcode of HCI_LE_SetPrivacyModeCmd
 
#define HCI_LE_SET_RESOLVABLE_PRIVATE_ADDRESS_TIMEOUT   0x202E
 opcode of HCI_LE_SetResolvablePrivateAddressTimeoutCmd
 
#define HCI_LE_TEST_END   0x201F
 opcode of HCI_LE_TestEndCmd
 
#define HCI_LE_TRANSMITTER_TEST   0x201E
 opcode of HCI_LE_TransmitterTestCmd
 
#define HCI_LE_WRITE_RF_PATH_COMPENSATION   0x204D
 opcode of HCI_LE_WriteRfPathCompCmd
 
#define HCI_LE_WRITE_SUGGESTED_DEFAULT_DATA_LENGTH   0x2024
 
#define HCI_NUM_OF_COMPLETED_PACKETS_EVENT_CODE   0x13
 event of type hciEvt_NumCompletedPkt_t
 
#define HCI_READ_AUTH_PAYLOAD_TIMEOUT   0x0C7B
 opcode of HCI_ReadAuthPayloadTimeoutCmd
 
#define HCI_READ_BDADDR   0x1009
 opcode of HCI_ReadBDADDRCmd
 
#define HCI_READ_LOCAL_SUPPORTED_COMMANDS   0x1002
 opcode of HCI_ReadLocalSupportedCommandsCmd
 
#define HCI_READ_LOCAL_SUPPORTED_FEATURES   0x1003
 opcode of HCI_ReadLocalSupportedFeaturesCmd
 
#define HCI_READ_LOCAL_VERSION_INFO   0x1001
 opcode of HCI_ReadLocalVersionInfoCmd
 
#define HCI_READ_REMOTE_INFO_COMPLETE_EVENT_CODE   0x0C
 event of type hciPacket_t
 
#define HCI_READ_REMOTE_VERSION_INFO   0x041D
 opcode of HCI_ReadRemoteVersionInfoCmd
 
#define HCI_READ_RSSI   0x1405
 opcode of HCI_ReadRssiCmd
 
#define HCI_READ_TRANSMIT_POWER   0x0C2D
 
#define HCI_RESET   0x0C03
 opcode ofHCI_ResetCmd
 
#define HCI_RSSI_NOT_AVAILABLE   LL_RSSI_NOT_AVAILABLE
 Invalid RSSI.
 
#define HCI_SET_EVENT_MASK   0x0C01
 opcode of HCI_SetEventMaskCmd
 
#define HCI_SET_EVENT_MASK_PAGE_2   0x0C63
 opcode of HCI_SetEventMaskPage2Cmd
 
#define HCI_VE_EVENT_CODE   0xFF
 event of type hciEvt_VSCmdComplete_t
 
#define HCI_WRITE_AUTH_PAYLOAD_TIMEOUT   0x0C7C
 opcode of HCI_WriteAuthPayloadTimeoutCmd
 
#define NO_FEATURES_ENABLED   0x00
 No Features Enabled.
 
#define PEER_PARAM_REJECT_ENABLED   0x01
 Peer Device Conn Param Reject Mask Enabled.
 

Variables

char * BLEEventCode_BleLogStrings []
 

Detailed Description

Macro Definition Documentation

§ HCI_EXT_BUILD_REVISION

#define HCI_EXT_BUILD_REVISION   0xFC1B

§ HCI_EXT_BUILD_REVISION_EVENT

#define HCI_EXT_BUILD_REVISION_EVENT   0x041B

§ HCI_EXT_END_MODEM_TEST

#define HCI_EXT_END_MODEM_TEST   0xFC0B

§ HCI_EXT_END_MODEM_TEST_EVENT

#define HCI_EXT_END_MODEM_TEST_EVENT   0x040B

§ HCI_EXT_NUM_COMPLETED_PKTS_LIMIT

#define HCI_EXT_NUM_COMPLETED_PKTS_LIMIT   0xFC1F

§ HCI_EXT_NUM_COMPLETED_PKTS_LIMIT_EVENT

#define HCI_EXT_NUM_COMPLETED_PKTS_LIMIT_EVENT   0x041F

§ HCI_EXT_ONE_PKT_PER_EVT

#define HCI_EXT_ONE_PKT_PER_EVT   0xFC02

§ HCI_EXT_ONE_PKT_PER_EVT_EVENT

#define HCI_EXT_ONE_PKT_PER_EVT_EVENT   0x0402

§ HCI_EXT_PER_BY_CHAN

#define HCI_EXT_PER_BY_CHAN   0xFC15

§ HCI_EXT_PER_BY_CHAN_EVENT

#define HCI_EXT_PER_BY_CHAN_EVENT   0x0415

§ HCI_EXT_RESET_SYSTEM

#define HCI_EXT_RESET_SYSTEM   0xFC1D

§ HCI_EXT_RESET_SYSTEM_EVENT

#define HCI_EXT_RESET_SYSTEM_EVENT   0x041D

§ HCI_EXT_SET_DTM_TX_PKT_CNT

#define HCI_EXT_SET_DTM_TX_PKT_CNT   0xFC24

§ HCI_EXT_SET_DTM_TX_PKT_CNT_EVENT

#define HCI_EXT_SET_DTM_TX_PKT_CNT_EVENT   0x0424

§ HCI_EXT_SET_MAX_DTM_TX_POWER

#define HCI_EXT_SET_MAX_DTM_TX_POWER   0xFC11

§ HCI_EXT_SET_MAX_DTM_TX_POWER_EVENT

#define HCI_EXT_SET_MAX_DTM_TX_POWER_EVENT   0x0411

§ HCI_EXT_SET_RX_GAIN

#define HCI_EXT_SET_RX_GAIN   0xFC00

//NODOC

opcode of HCI_EXT_SetRxGainCmd

§ HCI_LE_RAND

#define HCI_LE_RAND   0x2018

opcode of HCI_LE_RandCmd

§ HCI_LE_READ_LOCAL_RESOLVABLE_ADDRESS

#define HCI_LE_READ_LOCAL_RESOLVABLE_ADDRESS   0x202C

§ HCI_LE_READ_LOCAL_SUPPORTED_FEATURES

#define HCI_LE_READ_LOCAL_SUPPORTED_FEATURES   0x2003

§ HCI_LE_REMOVE_WHITE_LIST

#define HCI_LE_REMOVE_WHITE_LIST   0x2012

§ HCI_LE_WRITE_SUGGESTED_DEFAULT_DATA_LENGTH

#define HCI_LE_WRITE_SUGGESTED_DEFAULT_DATA_LENGTH   0x2024

§ HCI_READ_TRANSMIT_POWER

#define HCI_READ_TRANSMIT_POWER   0x0C2D
© Copyright 1995-2020, Texas Instruments Incorporated. All rights reserved.
Trademarks | Privacy policy | Terms of use | Terms of sale