11f504dbdSmatthias.ringwald /* 2a0c35809S[email protected] * Copyright (C) 2014 BlueKitchen GmbH 31713bceaSmatthias.ringwald * 41713bceaSmatthias.ringwald * Redistribution and use in source and binary forms, with or without 51713bceaSmatthias.ringwald * modification, are permitted provided that the following conditions 61713bceaSmatthias.ringwald * are met: 71713bceaSmatthias.ringwald * 81713bceaSmatthias.ringwald * 1. Redistributions of source code must retain the above copyright 91713bceaSmatthias.ringwald * notice, this list of conditions and the following disclaimer. 101713bceaSmatthias.ringwald * 2. Redistributions in binary form must reproduce the above copyright 111713bceaSmatthias.ringwald * notice, this list of conditions and the following disclaimer in the 121713bceaSmatthias.ringwald * documentation and/or other materials provided with the distribution. 131713bceaSmatthias.ringwald * 3. Neither the name of the copyright holders nor the names of 141713bceaSmatthias.ringwald * contributors may be used to endorse or promote products derived 151713bceaSmatthias.ringwald * from this software without specific prior written permission. 166b64433eSmatthias.ringwald * 4. Any redistribution, use, or modification is done solely for 176b64433eSmatthias.ringwald * personal benefit and not for any commercial purpose or for 186b64433eSmatthias.ringwald * monetary gain. 191713bceaSmatthias.ringwald * 20a0c35809S[email protected] * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 211713bceaSmatthias.ringwald * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 221713bceaSmatthias.ringwald * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 231713bceaSmatthias.ringwald * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 241713bceaSmatthias.ringwald * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 251713bceaSmatthias.ringwald * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 261713bceaSmatthias.ringwald * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 271713bceaSmatthias.ringwald * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 281713bceaSmatthias.ringwald * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 291713bceaSmatthias.ringwald * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 301713bceaSmatthias.ringwald * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 311713bceaSmatthias.ringwald * SUCH DAMAGE. 321713bceaSmatthias.ringwald * 33a0c35809S[email protected] * Please inquire about commercial licensing options at 34a0c35809S[email protected] * [email protected] 356b64433eSmatthias.ringwald * 361713bceaSmatthias.ringwald */ 371713bceaSmatthias.ringwald 381713bceaSmatthias.ringwald /* 391f504dbdSmatthias.ringwald * hci.h 401f504dbdSmatthias.ringwald * 411f504dbdSmatthias.ringwald * Created by Matthias Ringwald on 4/29/09. 421f504dbdSmatthias.ringwald * 431f504dbdSmatthias.ringwald */ 441f504dbdSmatthias.ringwald 4580e33422SMatthias Ringwald #ifndef HCI_H 4680e33422SMatthias Ringwald #define HCI_H 471f504dbdSmatthias.ringwald 487907f069SMatthias Ringwald #include "btstack_config.h" 4936a5e735Smatthias.ringwald 503fb36a29SMatthias Ringwald #include "btstack_chipset.h" 51af3c1ffeSMatthias Ringwald #include "btstack_control.h" 523fb36a29SMatthias Ringwald #include "btstack_linked_list.h" 533fb36a29SMatthias Ringwald #include "btstack_util.h" 54a98592bcSMatthias Ringwald #include "classic/btstack_link_key_db.h" 5556042629SMatthias Ringwald #include "hci_cmd.h" 568974fcd6SMatthias Ringwald #include "gap.h" 573edc84c5SMatthias Ringwald #include "hci_transport.h" 58f1f3f303SMatthias Ringwald #include "btstack_run_loop.h" 59ba681a6cSmatthias.ringwald 6018707219SMatthias Ringwald #ifdef ENABLE_BLE 6118707219SMatthias Ringwald #include "ble/att_db.h" 6218707219SMatthias Ringwald #endif 6318707219SMatthias Ringwald 6493b8dc03Smatthias.ringwald #include <stdint.h> 6502ea9861Smatthias.ringwald #include <stdlib.h> 661cd208adSmatthias.ringwald #include <stdarg.h> 6793b8dc03Smatthias.ringwald 68e3b6fe7eSmatthias.ringwald #if defined __cplusplus 69e3b6fe7eSmatthias.ringwald extern "C" { 70e3b6fe7eSmatthias.ringwald #endif 71e3b6fe7eSmatthias.ringwald 7236a5e735Smatthias.ringwald // packet buffer sizes 736ffe3f3eSMatthias Ringwald #define HCI_CMD_HEADER_SIZE 3 746ffe3f3eSMatthias Ringwald #define HCI_ACL_HEADER_SIZE 4 756ffe3f3eSMatthias Ringwald #define HCI_SCO_HEADER_SIZE 3 766ffe3f3eSMatthias Ringwald #define HCI_EVENT_HEADER_SIZE 2 776ffe3f3eSMatthias Ringwald 786ffe3f3eSMatthias Ringwald #define HCI_EVENT_PAYLOAD_SIZE 255 796ffe3f3eSMatthias Ringwald #define HCI_CMD_PAYLOAD_SIZE 255 80f9f2075cSMatthias Ringwald 81fcae305fSMatthias Ringwald // Max HCI Command LE payload size: 82f9f2075cSMatthias Ringwald // 64 from LE Generate DHKey command 83f9f2075cSMatthias Ringwald // 32 from LE Encrypt command 84fcae305fSMatthias Ringwald #if defined(ENABLE_LE_SECURE_CONNECTIONS) && !defined(ENABLE_MICRO_ECC_FOR_LE_SECURE_CONNECTIONS) 85f9f2075cSMatthias Ringwald #define HCI_CMD_PAYLOAD_SIZE_LE 64 86f9f2075cSMatthias Ringwald #else 87f9f2075cSMatthias Ringwald #define HCI_CMD_PAYLOAD_SIZE_LE 32 88f9f2075cSMatthias Ringwald #endif 89f9f2075cSMatthias Ringwald 9036a5e735Smatthias.ringwald // HCI_ACL_PAYLOAD_SIZE is configurable and defined in config.h 91a1ffb867SMatthias Ringwald // addition byte in even to terminate remote name request with '\0' 92a1ffb867SMatthias Ringwald #define HCI_EVENT_BUFFER_SIZE (HCI_EVENT_HEADER_SIZE + HCI_EVENT_PAYLOAD_SIZE + 1) 93f9f2075cSMatthias Ringwald 94f9f2075cSMatthias Ringwald #ifdef ENABLE_CLASSIC 9536a5e735Smatthias.ringwald #define HCI_CMD_BUFFER_SIZE (HCI_CMD_HEADER_SIZE + HCI_CMD_PAYLOAD_SIZE) 96f9f2075cSMatthias Ringwald #else 97f9f2075cSMatthias Ringwald #define HCI_CMD_BUFFER_SIZE (HCI_CMD_HEADER_SIZE + HCI_CMD_PAYLOAD_SIZE_LE) 98f9f2075cSMatthias Ringwald #endif 99f9f2075cSMatthias Ringwald 10036a5e735Smatthias.ringwald #define HCI_ACL_BUFFER_SIZE (HCI_ACL_HEADER_SIZE + HCI_ACL_PAYLOAD_SIZE) 10136a5e735Smatthias.ringwald 102fc6cde64SMatthias Ringwald // size of hci incoming buffer, big enough for event or acl packet without H4 packet type 103fc6cde64SMatthias Ringwald #ifdef HCI_INCOMING_PACKET_BUFFER_SIZE 104fc6cde64SMatthias Ringwald #if HCI_INCOMING_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE 105fc6cde64SMatthias Ringwald #error HCI_INCOMING_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE 10625c5e985S[email protected] #endif 107fc6cde64SMatthias Ringwald #if HCI_INCOMING_PACKET_BUFFER_SIZE < HCI_EVENT_BUFFER_SIZE 108fc6cde64SMatthias Ringwald #error HCI_INCOMING_PACKET_BUFFER_SIZE must be equal or larger than HCI_EVENT_BUFFER_SIZE 109fc6cde64SMatthias Ringwald #endif 110fc6cde64SMatthias Ringwald #else 111fc6cde64SMatthias Ringwald #if HCI_ACL_BUFFER_SIZE > HCI_EVENT_BUFFER_SIZE 112fc6cde64SMatthias Ringwald #define HCI_INCOMING_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE 113fc6cde64SMatthias Ringwald #else 114fc6cde64SMatthias Ringwald #define HCI_INCOMING_PACKET_BUFFER_SIZE HCI_EVENT_BUFFER_SIZE 115fc6cde64SMatthias Ringwald #endif 116fc6cde64SMatthias Ringwald #endif 117fc6cde64SMatthias Ringwald 118fc6cde64SMatthias Ringwald // size of hci outgoing buffer, big enough for command or acl packet without H4 packet type 119fc6cde64SMatthias Ringwald #ifdef HCI_OUTGOING_PACKET_BUFFER_SIZE 120fc6cde64SMatthias Ringwald #if HCI_OUTGOING_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE 121fc6cde64SMatthias Ringwald #error HCI_OUTGOING_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE 122fc6cde64SMatthias Ringwald #endif 123fc6cde64SMatthias Ringwald #if HCI_OUTGOING_PACKET_BUFFER_SIZE < HCI_CMD_BUFFER_SIZE 124fc6cde64SMatthias Ringwald #error HCI_OUTGOING_PACKET_BUFFER_SIZE must be equal or larger than HCI_CMD_BUFFER_SIZE 12525c5e985S[email protected] #endif 12625c5e985S[email protected] #else 12736a5e735Smatthias.ringwald #if HCI_ACL_BUFFER_SIZE > HCI_CMD_BUFFER_SIZE 128fc6cde64SMatthias Ringwald #define HCI_OUTGOING_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE 12936a5e735Smatthias.ringwald #else 130fc6cde64SMatthias Ringwald #define HCI_OUTGOING_PACKET_BUFFER_SIZE HCI_CMD_BUFFER_SIZE 13136a5e735Smatthias.ringwald #endif 13223ac0743Smatthias.ringwald #endif 13328c93ceeSmatthias.ringwald 134689a7eb9SMatthias Ringwald // additional pre-buffer space for packets to Bluetooth module, for now, used for HCI Transport H4 DMA 1354ccd6018SAustin Morton #ifndef HCI_OUTGOING_PRE_BUFFER_SIZE 136689a7eb9SMatthias Ringwald #ifdef HAVE_HOST_CONTROLLER_API 137689a7eb9SMatthias Ringwald #define HCI_OUTGOING_PRE_BUFFER_SIZE 0 138689a7eb9SMatthias Ringwald #else 13960da618dS[email protected] #define HCI_OUTGOING_PRE_BUFFER_SIZE 1 140689a7eb9SMatthias Ringwald #endif 1414ccd6018SAustin Morton #endif 14260da618dS[email protected] 143dfa951b1SMatthias Ringwald // BNEP may uncompress the IP Header by 16 bytes, GATT Client requires two additional bytes for long characteristic reads 144b34233c3S[email protected] #ifndef HCI_INCOMING_PRE_BUFFER_SIZE 145689a7eb9SMatthias Ringwald #ifdef ENABLE_CLASSIC 146f2e45468SMatthias Ringwald #define HCI_INCOMING_PRE_BUFFER_SIZE (16 - HCI_ACL_HEADER_SIZE - 4) 147689a7eb9SMatthias Ringwald #else 148dfa951b1SMatthias Ringwald #define HCI_INCOMING_PRE_BUFFER_SIZE 2 149689a7eb9SMatthias Ringwald #endif 150b34233c3S[email protected] #endif 151b34233c3S[email protected] 15280d52d6bSmatthias.ringwald // 153f8fbdce0SMatthias Ringwald #define IS_COMMAND(packet, command) ( little_endian_read_16(packet,0) == command.opcode ) 15480d52d6bSmatthias.ringwald 155caed94dfSMatthias Ringwald // check if command complete event for given command 1565df9dc78SMatthias Ringwald #define HCI_EVENT_IS_COMMAND_COMPLETE(event,cmd) ( (event[0] == HCI_EVENT_COMMAND_COMPLETE) && (little_endian_read_16(event,3) == cmd.opcode) ) 1575df9dc78SMatthias Ringwald #define HCI_EVENT_IS_COMMAND_STATUS(event,cmd) ( (event[0] == HCI_EVENT_COMMAND_STATUS) && (little_endian_read_16(event,4) == cmd.opcode) ) 158caed94dfSMatthias Ringwald 159caed94dfSMatthias Ringwald // Code+Len=2, Pkts+Opcode=3; total=5 160caed94dfSMatthias Ringwald #define OFFSET_OF_DATA_IN_COMMAND_COMPLETE 5 161caed94dfSMatthias Ringwald 162caed94dfSMatthias Ringwald // ACL Packet 163caed94dfSMatthias Ringwald #define READ_ACL_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff) 1642b838201SMatthias Ringwald #define READ_SCO_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff) 165caed94dfSMatthias Ringwald #define READ_ACL_FLAGS( buffer ) ( buffer[1] >> 4 ) 166caed94dfSMatthias Ringwald #define READ_ACL_LENGTH( buffer ) (little_endian_read_16(buffer, 2)) 167caed94dfSMatthias Ringwald 168caed94dfSMatthias Ringwald // Sneak peak into L2CAP Packet 169caed94dfSMatthias Ringwald #define READ_L2CAP_LENGTH(buffer) ( little_endian_read_16(buffer, 4)) 170caed94dfSMatthias Ringwald #define READ_L2CAP_CHANNEL_ID(buffer) ( little_endian_read_16(buffer, 6)) 171caed94dfSMatthias Ringwald 17206b35ec0Smatthias.ringwald /** 173da886c03S[email protected] * LE connection parameter update state 174da886c03S[email protected] */ 175da886c03S[email protected] 176da886c03S[email protected] typedef enum { 177da886c03S[email protected] CON_PARAMETER_UPDATE_NONE, 17873cd8a2aSMatthias Ringwald // L2CAP 179b68d7bc3SMatthias Ringwald CON_PARAMETER_UPDATE_SEND_REQUEST, 180da886c03S[email protected] CON_PARAMETER_UPDATE_SEND_RESPONSE, 181da886c03S[email protected] CON_PARAMETER_UPDATE_CHANGE_HCI_CON_PARAMETERS, 18273cd8a2aSMatthias Ringwald CON_PARAMETER_UPDATE_DENY, 18373cd8a2aSMatthias Ringwald // HCI - in respnose to HCI_SUBEVENT_LE_REMOTE_CONNECTION_PARAMETER_REQUEST 18473cd8a2aSMatthias Ringwald CON_PARAMETER_UPDATE_REPLY, 18573cd8a2aSMatthias Ringwald CON_PARAMETER_UPDATE_NEGATIVE_REPLY, 186da886c03S[email protected] } le_con_parameter_update_state_t; 187da886c03S[email protected] 1880414dabdS[email protected] // Authentication flags 189c01e9cbdSmatthias.ringwald typedef enum { 190dbe1a790S[email protected] AUTH_FLAGS_NONE = 0x0000, 191dbe1a790S[email protected] RECV_LINK_KEY_REQUEST = 0x0001, 192dbe1a790S[email protected] HANDLE_LINK_KEY_REQUEST = 0x0002, 193dbe1a790S[email protected] SENT_LINK_KEY_REPLY = 0x0004, 194dbe1a790S[email protected] SENT_LINK_KEY_NEGATIVE_REQUEST = 0x0008, 195dbe1a790S[email protected] RECV_LINK_KEY_NOTIFICATION = 0x0010, 196899283eaS[email protected] DENY_PIN_CODE_REQUEST = 0x0040, 197f0944df2S[email protected] RECV_IO_CAPABILITIES_REQUEST = 0x0080, 198f0944df2S[email protected] SEND_IO_CAPABILITIES_REPLY = 0x0100, 1996724cd9eS[email protected] SEND_USER_CONFIRM_REPLY = 0x0200, 2006724cd9eS[email protected] SEND_USER_PASSKEY_REPLY = 0x0400, 2016724cd9eS[email protected] 2026724cd9eS[email protected] // pairing status 203abdad579SMatthias Ringwald LEGACY_PAIRING_ACTIVE = 0x1000, 204abdad579SMatthias Ringwald SSP_PAIRING_ACTIVE = 0x2000, 205536f9994S[email protected] 206f0944df2S[email protected] // connection status 207abdad579SMatthias Ringwald CONNECTION_AUTHENTICATED = 0x4000, 2086724cd9eS[email protected] CONNECTION_ENCRYPTED = 0x8000, 209891b9fc2SMatthias Ringwald 210891b9fc2SMatthias Ringwald // errands 211891b9fc2SMatthias Ringwald READ_RSSI = 0x10000, 2126909f064SMatthias Ringwald WRITE_SUPERVISION_TIMEOUT = 0x20000, 2136909f064SMatthias Ringwald 2147fde4af9Smatthias.ringwald } hci_authentication_flags_t; 215c01e9cbdSmatthias.ringwald 2160414dabdS[email protected] /** 2170414dabdS[email protected] * Connection State 2180414dabdS[email protected] */ 219c8e4258aSmatthias.ringwald typedef enum { 220ad83dc6aS[email protected] SEND_CREATE_CONNECTION = 0, 221ad83dc6aS[email protected] SENT_CREATE_CONNECTION, 2220bf6344aS[email protected] SEND_CANCEL_CONNECTION, 2230bf6344aS[email protected] SENT_CANCEL_CONNECTION, 224c8e4258aSmatthias.ringwald RECEIVED_CONNECTION_REQUEST, 225c8e4258aSmatthias.ringwald ACCEPTED_CONNECTION_REQUEST, 226c8e4258aSmatthias.ringwald REJECTED_CONNECTION_REQUEST, 227c8e4258aSmatthias.ringwald OPEN, 2285917a5c5S[email protected] SEND_DISCONNECT, 229ccda6e14S[email protected] SENT_DISCONNECT, 230ccda6e14S[email protected] RECEIVED_DISCONNECTION_COMPLETE 231c8e4258aSmatthias.ringwald } CONNECTION_STATE; 232c8e4258aSmatthias.ringwald 2330414dabdS[email protected] // bonding flags 2340414dabdS[email protected] enum { 235ba018746SMatthias Ringwald BONDING_REQUEST_REMOTE_FEATURES_PAGE_0 = 0x0001, 236ba018746SMatthias Ringwald BONDING_REQUEST_REMOTE_FEATURES_PAGE_1 = 0x0002, 237ba018746SMatthias Ringwald BONDING_REQUEST_REMOTE_FEATURES_PAGE_2 = 0x0004, 238ba018746SMatthias Ringwald BONDING_RECEIVED_REMOTE_FEATURES = 0x0008, 239ac1d102cSMatthias Ringwald BONDING_REMOTE_SUPPORTS_SSP_CONTROLLER = 0x0010, 240ac1d102cSMatthias Ringwald BONDING_REMOTE_SUPPORTS_SSP_HOST = 0x0020, 24150c51a77SMatthias Ringwald BONDING_REMOTE_SUPPORTS_SC_CONTROLLER = 0x0040, 24250c51a77SMatthias Ringwald BONDING_REMOTE_SUPPORTS_SC_HOST = 0x0080, 24350c51a77SMatthias Ringwald BONDING_DISCONNECT_SECURITY_BLOCK = 0x0100, 24450c51a77SMatthias Ringwald BONDING_DISCONNECT_DEDICATED_DONE = 0x0200, 24550c51a77SMatthias Ringwald BONDING_SEND_AUTHENTICATE_REQUEST = 0x0400, 24650c51a77SMatthias Ringwald BONDING_SEND_ENCRYPTION_REQUEST = 0x0800, 24750c51a77SMatthias Ringwald BONDING_SEND_READ_ENCRYPTION_KEY_SIZE = 0x1000, 24850c51a77SMatthias Ringwald BONDING_DEDICATED = 0x2000, 24950c51a77SMatthias Ringwald BONDING_EMIT_COMPLETE_ON_DISCONNECT = 0x4000, 250abdad579SMatthias Ringwald BONDING_SENT_AUTHENTICATE_REQUEST = 0x8000 2510414dabdS[email protected] }; 252afd4e962S[email protected] 253afd4e962S[email protected] typedef enum { 25443bfb1bdSmatthias.ringwald BLUETOOTH_OFF = 1, 25543bfb1bdSmatthias.ringwald BLUETOOTH_ON, 25643bfb1bdSmatthias.ringwald BLUETOOTH_ACTIVE 25743bfb1bdSmatthias.ringwald } BLUETOOTH_STATE; 25843bfb1bdSmatthias.ringwald 259b04dfa37SMatthias Ringwald typedef enum { 260b04dfa37SMatthias Ringwald LE_CONNECTING_IDLE, 261*6ea9315cSMatthias Ringwald LE_CONNECTING_CANCEL, 262b04dfa37SMatthias Ringwald LE_CONNECTING_DIRECT, 263b04dfa37SMatthias Ringwald LE_CONNECTING_WHITELIST, 264b04dfa37SMatthias Ringwald } le_connecting_state_t; 265b04dfa37SMatthias Ringwald 2663a6673b6SMatthias Ringwald #ifdef ENABLE_BLE 2673a6673b6SMatthias Ringwald 26895d04d44S[email protected] // 26995d04d44S[email protected] // SM internal types and globals 27095d04d44S[email protected] // 27195d04d44S[email protected] 27295d04d44S[email protected] typedef enum { 27395d04d44S[email protected] 27495d04d44S[email protected] // general states 27595d04d44S[email protected] SM_GENERAL_IDLE, 27695d04d44S[email protected] SM_GENERAL_SEND_PAIRING_FAILED, 27795d04d44S[email protected] SM_GENERAL_TIMEOUT, // no other security messages are exchanged 27895d04d44S[email protected] 27995d04d44S[email protected] // Phase 1: Pairing Feature Exchange 28095d04d44S[email protected] SM_PH1_W4_USER_RESPONSE, 28195d04d44S[email protected] 28295d04d44S[email protected] // Phase 2: Authenticating and Encrypting 28395d04d44S[email protected] 28495d04d44S[email protected] // get random number for use as TK Passkey if we show it 28595d04d44S[email protected] SM_PH2_GET_RANDOM_TK, 28695d04d44S[email protected] SM_PH2_W4_RANDOM_TK, 28795d04d44S[email protected] 28895d04d44S[email protected] // get local random number for confirm c1 28995d04d44S[email protected] SM_PH2_C1_GET_RANDOM_A, 29095d04d44S[email protected] SM_PH2_C1_W4_RANDOM_A, 29195d04d44S[email protected] SM_PH2_C1_GET_RANDOM_B, 29295d04d44S[email protected] SM_PH2_C1_W4_RANDOM_B, 29395d04d44S[email protected] 29495d04d44S[email protected] // calculate confirm value for local side 29595d04d44S[email protected] SM_PH2_C1_GET_ENC_A, 29695d04d44S[email protected] SM_PH2_C1_W4_ENC_A, 29795d04d44S[email protected] 29895d04d44S[email protected] // calculate confirm value for remote side 29995d04d44S[email protected] SM_PH2_C1_GET_ENC_C, 30095d04d44S[email protected] SM_PH2_C1_W4_ENC_C, 30195d04d44S[email protected] 30295d04d44S[email protected] SM_PH2_C1_SEND_PAIRING_CONFIRM, 30395d04d44S[email protected] SM_PH2_SEND_PAIRING_RANDOM, 30495d04d44S[email protected] 30595d04d44S[email protected] // calc STK 30695d04d44S[email protected] SM_PH2_CALC_STK, 30795d04d44S[email protected] SM_PH2_W4_STK, 30895d04d44S[email protected] 30995d04d44S[email protected] SM_PH2_W4_CONNECTION_ENCRYPTED, 31095d04d44S[email protected] 31195d04d44S[email protected] // Phase 3: Transport Specific Key Distribution 31295d04d44S[email protected] // calculate DHK, Y, EDIV, and LTK 31395d04d44S[email protected] SM_PH3_Y_GET_ENC, 31495d04d44S[email protected] SM_PH3_Y_W4_ENC, 31595d04d44S[email protected] SM_PH3_LTK_GET_ENC, 31695d04d44S[email protected] 31795d04d44S[email protected] // exchange keys 31895d04d44S[email protected] SM_PH3_DISTRIBUTE_KEYS, 31995d04d44S[email protected] SM_PH3_RECEIVE_KEYS, 32095d04d44S[email protected] 32195d04d44S[email protected] // RESPONDER ROLE 322d7119506SMatthias Ringwald SM_RESPONDER_IDLE, 32395d04d44S[email protected] SM_RESPONDER_SEND_SECURITY_REQUEST, 32459066796SMatthias Ringwald SM_RESPONDER_PH0_RECEIVED_LTK_REQUEST, 3256c39055aSMatthias Ringwald SM_RESPONDER_PH0_RECEIVED_LTK_W4_IRK, 3269ec080fdS[email protected] SM_RESPONDER_PH0_SEND_LTK_REQUESTED_NEGATIVE_REPLY, 32795d04d44S[email protected] SM_RESPONDER_PH1_W4_PAIRING_REQUEST, 328477200f2S[email protected] SM_RESPONDER_PH1_PAIRING_REQUEST_RECEIVED, 32995d04d44S[email protected] SM_RESPONDER_PH1_SEND_PAIRING_RESPONSE, 33095d04d44S[email protected] SM_RESPONDER_PH1_W4_PAIRING_CONFIRM, 33195d04d44S[email protected] SM_RESPONDER_PH2_W4_PAIRING_RANDOM, 33295d04d44S[email protected] SM_RESPONDER_PH2_W4_LTK_REQUEST, 33395d04d44S[email protected] SM_RESPONDER_PH2_SEND_LTK_REPLY, 33495d04d44S[email protected] 3350db5c26bSMatthias Ringwald // Phase 4: re-establish previously distributed LTK 3360db5c26bSMatthias Ringwald SM_RESPONDER_PH4_Y_GET_ENC, 3370db5c26bSMatthias Ringwald SM_RESPONDER_PH4_Y_W4_ENC, 338d7471931SMatthias Ringwald SM_RESPONDER_PH4_SEND_LTK_REPLY, 3390db5c26bSMatthias Ringwald 34095d04d44S[email protected] // INITITIATOR ROLE 34195d04d44S[email protected] SM_INITIATOR_CONNECTED, 3429ec080fdS[email protected] SM_INITIATOR_PH0_HAS_LTK, 3439ec080fdS[email protected] SM_INITIATOR_PH0_SEND_START_ENCRYPTION, 34485cacb82S[email protected] SM_INITIATOR_PH0_W4_CONNECTION_ENCRYPTED, 345477200f2S[email protected] SM_INITIATOR_PH1_W2_SEND_PAIRING_REQUEST, 34695d04d44S[email protected] SM_INITIATOR_PH1_SEND_PAIRING_REQUEST, 34795d04d44S[email protected] SM_INITIATOR_PH1_W4_PAIRING_RESPONSE, 34895d04d44S[email protected] SM_INITIATOR_PH2_W4_PAIRING_CONFIRM, 34995d04d44S[email protected] SM_INITIATOR_PH2_W4_PAIRING_RANDOM, 35095d04d44S[email protected] SM_INITIATOR_PH3_SEND_START_ENCRYPTION, 351c6b7cbd9SMatthias Ringwald 352c6b7cbd9SMatthias Ringwald // LE Secure Connections 35306cd539fSMatthias Ringwald SM_SC_RECEIVED_LTK_REQUEST, 354c6b7cbd9SMatthias Ringwald SM_SC_SEND_PUBLIC_KEY_COMMAND, 355c6b7cbd9SMatthias Ringwald SM_SC_W4_PUBLIC_KEY_COMMAND, 356b90c4e75SMatthias Ringwald SM_SC_W4_LOCAL_NONCE, 357aec94140SMatthias Ringwald SM_SC_W2_CMAC_FOR_CONFIRMATION, 358aec94140SMatthias Ringwald SM_SC_W4_CMAC_FOR_CONFIRMATION, 359c6b7cbd9SMatthias Ringwald SM_SC_SEND_CONFIRMATION, 360688a08f9SMatthias Ringwald SM_SC_W2_CMAC_FOR_CHECK_CONFIRMATION, 361688a08f9SMatthias Ringwald SM_SC_W4_CMAC_FOR_CHECK_CONFIRMATION, 362c6b7cbd9SMatthias Ringwald SM_SC_W4_CONFIRMATION, 363c6b7cbd9SMatthias Ringwald SM_SC_SEND_PAIRING_RANDOM, 364c6b7cbd9SMatthias Ringwald SM_SC_W4_PAIRING_RANDOM, 365945888f5SMatthias Ringwald SM_SC_W2_CALCULATE_G2, 366945888f5SMatthias Ringwald SM_SC_W4_CALCULATE_G2, 3673cf37b8cSMatthias Ringwald SM_SC_W4_CALCULATE_DHKEY, 3680346c37cSMatthias Ringwald SM_SC_W2_CALCULATE_F5_SALT, 3690346c37cSMatthias Ringwald SM_SC_W4_CALCULATE_F5_SALT, 3700346c37cSMatthias Ringwald SM_SC_W2_CALCULATE_F5_MACKEY, 3710346c37cSMatthias Ringwald SM_SC_W4_CALCULATE_F5_MACKEY, 3720346c37cSMatthias Ringwald SM_SC_W2_CALCULATE_F5_LTK, 3730346c37cSMatthias Ringwald SM_SC_W4_CALCULATE_F5_LTK, 374dc300847SMatthias Ringwald SM_SC_W2_CALCULATE_F6_FOR_DHKEY_CHECK, 375dc300847SMatthias Ringwald SM_SC_W4_CALCULATE_F6_FOR_DHKEY_CHECK, 376019005a0SMatthias Ringwald SM_SC_W2_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK, 377019005a0SMatthias Ringwald SM_SC_W4_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK, 378c6b7cbd9SMatthias Ringwald SM_SC_W4_USER_RESPONSE, 379bd57ffebSMatthias Ringwald SM_SC_SEND_DHKEY_CHECK_COMMAND, 380901c000fSMatthias Ringwald SM_SC_W4_DHKEY_CHECK_COMMAND, 381c6b7cbd9SMatthias Ringwald SM_SC_W4_LTK_REQUEST_SC, 3822bacf595SMatthias Ringwald SM_SC_W2_CALCULATE_H6_ILK, 3832bacf595SMatthias Ringwald SM_SC_W4_CALCULATE_H6_ILK, 3842bacf595SMatthias Ringwald SM_SC_W2_CALCULATE_H6_BR_EDR_LINK_KEY, 3852bacf595SMatthias Ringwald SM_SC_W4_CALCULATE_H6_BR_EDR_LINK_KEY, 38695d04d44S[email protected] } security_manager_state_t; 38795d04d44S[email protected] 38895d04d44S[email protected] typedef enum { 3897b8f2e5cSMatthias Ringwald IRK_LOOKUP_IDLE, 3907b8f2e5cSMatthias Ringwald IRK_LOOKUP_W4_READY, 3917b8f2e5cSMatthias Ringwald IRK_LOOKUP_STARTED, 3927b8f2e5cSMatthias Ringwald IRK_LOOKUP_SUCCEEDED, 3937b8f2e5cSMatthias Ringwald IRK_LOOKUP_FAILED 3947b8f2e5cSMatthias Ringwald } irk_lookup_state_t; 39595d04d44S[email protected] 3961ad129beSMatthias Ringwald typedef uint8_t sm_pairing_packet_t[7]; 397477200f2S[email protected] 39895d04d44S[email protected] // connection info available as long as connection exists 39995d04d44S[email protected] typedef struct sm_connection { 400fc64f94aSMatthias Ringwald hci_con_handle_t sm_handle; 40195d04d44S[email protected] uint8_t sm_role; // 0 - IamMaster, 1 = IamSlave 402190e7c61SMatthias Ringwald uint8_t sm_security_request_received; 40309ea1b62SMatthias Ringwald uint8_t sm_pairing_requested; 40495d04d44S[email protected] uint8_t sm_peer_addr_type; 40578b8321eSMatthias Ringwald bd_addr_t sm_peer_address; 40695d04d44S[email protected] security_manager_state_t sm_engine_state; 4077b8f2e5cSMatthias Ringwald irk_lookup_state_t sm_irk_lookup_state; 40895d04d44S[email protected] uint8_t sm_connection_encrypted; 40995d04d44S[email protected] uint8_t sm_connection_authenticated; // [0..1] 4103dc3a67dSMatthias Ringwald uint8_t sm_connection_sc; 41195d04d44S[email protected] uint8_t sm_actual_encryption_key_size; 412477200f2S[email protected] sm_pairing_packet_t sm_m_preq; // only used during c1 41395d04d44S[email protected] authorization_state_t sm_connection_authorization_state; 4140f6219e5S[email protected] uint16_t sm_local_ediv; 4150f6219e5S[email protected] uint8_t sm_local_rand[8]; 416c5d3944dS[email protected] int sm_le_db_index; 41795d04d44S[email protected] } sm_connection_t; 4184f3229d8S[email protected] 41918707219SMatthias Ringwald // 42018707219SMatthias Ringwald // ATT Server 42118707219SMatthias Ringwald // 42218707219SMatthias Ringwald 42318707219SMatthias Ringwald // max ATT request matches L2CAP PDU -- allow to use smaller buffer 42418707219SMatthias Ringwald #ifndef ATT_REQUEST_BUFFER_SIZE 42518707219SMatthias Ringwald #define ATT_REQUEST_BUFFER_SIZE HCI_ACL_PAYLOAD_SIZE 42618707219SMatthias Ringwald #endif 42718707219SMatthias Ringwald 42818707219SMatthias Ringwald typedef enum { 42918707219SMatthias Ringwald ATT_SERVER_IDLE, 43018707219SMatthias Ringwald ATT_SERVER_REQUEST_RECEIVED, 43118707219SMatthias Ringwald ATT_SERVER_W4_SIGNED_WRITE_VALIDATION, 43218707219SMatthias Ringwald ATT_SERVER_REQUEST_RECEIVED_AND_VALIDATED, 433beb20288SMatthias Ringwald ATT_SERVER_RESPONSE_PENDING, 43418707219SMatthias Ringwald } att_server_state_t; 43518707219SMatthias Ringwald 43618707219SMatthias Ringwald typedef struct { 43718707219SMatthias Ringwald att_server_state_t state; 43818707219SMatthias Ringwald 43918707219SMatthias Ringwald uint8_t peer_addr_type; 44018707219SMatthias Ringwald bd_addr_t peer_address; 44118707219SMatthias Ringwald 44218707219SMatthias Ringwald int ir_le_device_db_index; 443760ad805SMatthias Ringwald uint8_t ir_lookup_active; 444760ad805SMatthias Ringwald uint8_t pairing_active; 44518707219SMatthias Ringwald 44618707219SMatthias Ringwald int value_indication_handle; 44718707219SMatthias Ringwald btstack_timer_source_t value_indication_timer; 44818707219SMatthias Ringwald 44918707219SMatthias Ringwald att_connection_t connection; 45018707219SMatthias Ringwald 451cbbb12d9SMatthias Ringwald btstack_linked_list_t notification_requests; 452cbbb12d9SMatthias Ringwald btstack_linked_list_t indication_requests; 453cbbb12d9SMatthias Ringwald 4547fc7cb2bSMatthias Ringwald #ifdef ENABLE_GATT_OVER_CLASSIC 4557fc7cb2bSMatthias Ringwald uint16_t l2cap_cid; 4567fc7cb2bSMatthias Ringwald #endif 4577fc7cb2bSMatthias Ringwald 45818707219SMatthias Ringwald uint16_t request_size; 45918707219SMatthias Ringwald uint8_t request_buffer[ATT_REQUEST_BUFFER_SIZE]; 46018707219SMatthias Ringwald 46118707219SMatthias Ringwald } att_server_t; 46218707219SMatthias Ringwald 4633a6673b6SMatthias Ringwald #endif 4643a6673b6SMatthias Ringwald 4651b9cb13dSMatthias Ringwald #ifdef ENABLE_L2CAP_ENHANCED_RETRANSMISSION_MODE 4661b9cb13dSMatthias Ringwald typedef enum { 4671b9cb13dSMatthias Ringwald L2CAP_INFORMATION_STATE_IDLE = 0, 4681b9cb13dSMatthias Ringwald L2CAP_INFORMATION_STATE_W2_SEND_EXTENDED_FEATURE_REQUEST, 4691b9cb13dSMatthias Ringwald L2CAP_INFORMATION_STATE_W4_EXTENDED_FEATURE_RESPONSE, 4701b9cb13dSMatthias Ringwald L2CAP_INFORMATION_STATE_DONE 4711b9cb13dSMatthias Ringwald } l2cap_information_state_t; 4721b9cb13dSMatthias Ringwald 4731b9cb13dSMatthias Ringwald typedef struct { 4741b9cb13dSMatthias Ringwald l2cap_information_state_t information_state; 4751b9cb13dSMatthias Ringwald uint16_t extended_feature_mask; 4761b9cb13dSMatthias Ringwald } l2cap_state_t; 4771b9cb13dSMatthias Ringwald #endif 4781b9cb13dSMatthias Ringwald 47918707219SMatthias Ringwald // 480c8e4258aSmatthias.ringwald typedef struct { 48106b35ec0Smatthias.ringwald // linked list - assert: first field 482665d90f2SMatthias Ringwald btstack_linked_item_t item; 483c01e9cbdSmatthias.ringwald 484c01e9cbdSmatthias.ringwald // remote side 48516833f0aSmatthias.ringwald bd_addr_t address; 48606b35ec0Smatthias.ringwald 48706b35ec0Smatthias.ringwald // module handle 48816833f0aSmatthias.ringwald hci_con_handle_t con_handle; 489c01e9cbdSmatthias.ringwald 49096a45072S[email protected] // le public, le random, classic 49196a45072S[email protected] bd_addr_type_t address_type; 49296a45072S[email protected] 4935cf766e8SMatthias Ringwald // role: 0 - master, 1 - slave 4945cf766e8SMatthias Ringwald uint8_t role; 4955cf766e8SMatthias Ringwald 496afd4e962S[email protected] // connection state 497c8e4258aSmatthias.ringwald CONNECTION_STATE state; 498c8e4258aSmatthias.ringwald 499afd4e962S[email protected] // bonding 5007bdc6798S[email protected] uint16_t bonding_flags; 5011bd5283dS[email protected] uint8_t bonding_status; 502f8ee3071SMatthias Ringwald 503573897a0SMatthias Ringwald // encryption key size (in octets) 504573897a0SMatthias Ringwald uint8_t encryption_key_size; 505573897a0SMatthias Ringwald 50634d2123cS[email protected] // requested security level 50734d2123cS[email protected] gap_security_level_t requested_security_level; 50834d2123cS[email protected] 5099ab95c90S[email protected] // 5109ab95c90S[email protected] link_key_type_t link_key_type; 5119ab95c90S[email protected] 51298a2fd1cSMatthias Ringwald // remote supported features 51376ccfb2aSMatthias Ringwald /* bit 0 - eSCO */ 51449bafb5eSMatthias Ringwald /* bit 1 - extended features */ 515b1ace6bdSMatthias Ringwald uint8_t remote_supported_features[1]; 51698a2fd1cSMatthias Ringwald 517f8ee3071SMatthias Ringwald #ifdef ENABLE_CLASSIC 518f8ee3071SMatthias Ringwald // connection mode, default ACL_CONNECTION_MODE_ACTIVE 5193dce6128SMatthias Ringwald uint8_t connection_mode; 5203dce6128SMatthias Ringwald 521f8ee3071SMatthias Ringwald // enter/exit sniff mode requests 522f8ee3071SMatthias Ringwald uint16_t sniff_min_interval; // 0: idle, 0xffff exit sniff, else enter sniff 523f8ee3071SMatthias Ringwald uint16_t sniff_max_interval; 524f8ee3071SMatthias Ringwald uint16_t sniff_attempt; 525f8ee3071SMatthias Ringwald uint16_t sniff_timeout; 526760b20efSMatthias Ringwald 5276f28d2eeSMatthias Ringwald // track SCO rx event 5286f28d2eeSMatthias Ringwald uint32_t sco_rx_ms; 5296f28d2eeSMatthias Ringwald uint8_t sco_rx_count; 5306f28d2eeSMatthias Ringwald uint8_t sco_rx_valid; 5316f28d2eeSMatthias Ringwald 5326f28d2eeSMatthias Ringwald // generate sco can send now based on received packets, using timeout below 5336f28d2eeSMatthias Ringwald uint8_t sco_tx_ready; 534f8ee3071SMatthias Ringwald 53588a03c8dSMatthias Ringwald // request role switch 53688a03c8dSMatthias Ringwald hci_role_t request_role; 53788a03c8dSMatthias Ringwald 53859c33575SMatthias Ringwald btstack_timer_source_t timeout_sco; 5396f28d2eeSMatthias Ringwald #endif /* ENABLE_CLASSIC */ 5406f28d2eeSMatthias Ringwald 541891b9fc2SMatthias Ringwald // authentication and other errands 5427bdc6798S[email protected] uint32_t authentication_flags; 543c8e4258aSmatthias.ringwald 544ec820d77SMatthias Ringwald btstack_timer_source_t timeout; 545c785ef68Smatthias.ringwald 546f316a845SMatthias Ringwald // timeout in system ticks (HAVE_EMBEDDED_TICK) or milliseconds (HAVE_EMBEDDED_TIME_MS) 547f316a845SMatthias Ringwald uint32_t timestamp; 548ee091cf1Smatthias.ringwald 549ec6321eeS[email protected] // ACL packet recombination - PRE_BUFFER + ACL Header + ACL payload 550ec6321eeS[email protected] uint8_t acl_recombination_buffer[HCI_INCOMING_PRE_BUFFER_SIZE + 4 + HCI_ACL_BUFFER_SIZE]; 551c1012e46Smatthias.ringwald uint16_t acl_recombination_pos; 552d55db49eSmatthias.ringwald uint16_t acl_recombination_length; 553d55db49eSmatthias.ringwald 554760b20efSMatthias Ringwald 555477200f2S[email protected] // number packets sent to controller 556ce41473eSMatthias Ringwald uint8_t num_packets_sent; 557c37a3166S[email protected] 5582b838201SMatthias Ringwald #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 5592b838201SMatthias Ringwald uint8_t num_packets_completed; 5602b838201SMatthias Ringwald #endif 5612b838201SMatthias Ringwald 562477200f2S[email protected] // LE Connection parameter update 563da886c03S[email protected] le_con_parameter_update_state_t le_con_parameter_update_state; 56479f53f1dSMatthias Ringwald uint8_t le_con_param_update_identifier; 565c37a3166S[email protected] uint16_t le_conn_interval_min; 566c37a3166S[email protected] uint16_t le_conn_interval_max; 567c37a3166S[email protected] uint16_t le_conn_latency; 568c37a3166S[email protected] uint16_t le_supervision_timeout; 56995d04d44S[email protected] 570a9a4c409SMatthias Ringwald #ifdef ENABLE_BLE 571c9db5c21SMilanka Ringwald uint16_t le_connection_interval; 572b90f6e0aSMatthias Ringwald 573b90f6e0aSMatthias Ringwald // LE PHY Update via set phy command 574b90f6e0aSMatthias Ringwald uint8_t le_phy_update_all_phys; // 0xff for idle 575b90f6e0aSMatthias Ringwald uint8_t le_phy_update_tx_phys; 576b90f6e0aSMatthias Ringwald uint8_t le_phy_update_rx_phys; 577b90f6e0aSMatthias Ringwald int8_t le_phy_update_phy_options; 578b90f6e0aSMatthias Ringwald 57995d04d44S[email protected] // LE Security Manager 580477200f2S[email protected] sm_connection_t sm_connection; 58118707219SMatthias Ringwald 5820f3b27c5SMatthias Ringwald #ifdef ENABLE_LE_LIMIT_ACL_FRAGMENT_BY_MAX_OCTETS 5830f3b27c5SMatthias Ringwald uint16_t le_max_tx_octets; 5840f3b27c5SMatthias Ringwald #endif 5850f3b27c5SMatthias Ringwald 58618707219SMatthias Ringwald // ATT Server 58718707219SMatthias Ringwald att_server_t att_server; 588477200f2S[email protected] #endif 58995d04d44S[email protected] 5901b9cb13dSMatthias Ringwald #ifdef ENABLE_L2CAP_ENHANCED_RETRANSMISSION_MODE 5911b9cb13dSMatthias Ringwald l2cap_state_t l2cap_state; 5921b9cb13dSMatthias Ringwald #endif 5931b9cb13dSMatthias Ringwald 59416833f0aSmatthias.ringwald } hci_connection_t; 59516833f0aSmatthias.ringwald 596556d11b3SMatthias Ringwald 597556d11b3SMatthias Ringwald /** 598556d11b3SMatthias Ringwald * HCI Inititizlization State Machine 599556d11b3SMatthias Ringwald */ 600556d11b3SMatthias Ringwald typedef enum hci_init_state{ 601556d11b3SMatthias Ringwald HCI_INIT_SEND_RESET = 0, 602556d11b3SMatthias Ringwald HCI_INIT_W4_SEND_RESET, 60376fcb19bSMatthias Ringwald HCI_INIT_SEND_READ_LOCAL_VERSION_INFORMATION, 60476fcb19bSMatthias Ringwald HCI_INIT_W4_SEND_READ_LOCAL_VERSION_INFORMATION, 605e90bae01SMatthias Ringwald HCI_INIT_SEND_READ_LOCAL_NAME, 606e90bae01SMatthias Ringwald HCI_INIT_W4_SEND_READ_LOCAL_NAME, 60776fcb19bSMatthias Ringwald 6088d29070eSMatthias Ringwald HCI_INIT_SEND_BAUD_CHANGE, 6098d29070eSMatthias Ringwald HCI_INIT_W4_SEND_BAUD_CHANGE, 610556d11b3SMatthias Ringwald HCI_INIT_CUSTOM_INIT, 611556d11b3SMatthias Ringwald HCI_INIT_W4_CUSTOM_INIT, 612e47e68c7SMatthias Ringwald HCI_INIT_SEND_RESET_CSR_WARM_BOOT, 613e47e68c7SMatthias Ringwald HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT, 6149f007422SMatthias Ringwald HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT_LINK_RESET, 615559961d0SMatthias Ringwald HCI_INIT_W4_CUSTOM_INIT_BCM_DELAY, 616556d11b3SMatthias Ringwald 617a828a756SMatthias Ringwald HCI_INIT_READ_LOCAL_SUPPORTED_COMMANDS, 618a828a756SMatthias Ringwald HCI_INIT_W4_READ_LOCAL_SUPPORTED_COMMANDS, 61974b323a9SMatthias Ringwald 620eb3a5314SMatthias Ringwald HCI_INIT_SEND_BAUD_CHANGE_BCM, 621eb3a5314SMatthias Ringwald HCI_INIT_W4_SEND_BAUD_CHANGE_BCM, 622eb3a5314SMatthias Ringwald 62353860077SMatthias Ringwald HCI_INIT_SET_BD_ADDR, 62453860077SMatthias Ringwald HCI_INIT_W4_SET_BD_ADDR, 62553860077SMatthias Ringwald 62653860077SMatthias Ringwald HCI_INIT_SEND_RESET_ST_WARM_BOOT, 62753860077SMatthias Ringwald HCI_INIT_W4_SEND_RESET_ST_WARM_BOOT, 62853860077SMatthias Ringwald 62953860077SMatthias Ringwald HCI_INIT_READ_BD_ADDR, 63053860077SMatthias Ringwald HCI_INIT_W4_READ_BD_ADDR, 63153860077SMatthias Ringwald 632556d11b3SMatthias Ringwald HCI_INIT_READ_BUFFER_SIZE, 633556d11b3SMatthias Ringwald HCI_INIT_W4_READ_BUFFER_SIZE, 63453860077SMatthias Ringwald HCI_INIT_READ_LOCAL_SUPPORTED_FEATURES, 63553860077SMatthias Ringwald HCI_INIT_W4_READ_LOCAL_SUPPORTED_FEATURES, 6362b838201SMatthias Ringwald 6372b838201SMatthias Ringwald #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 6382b838201SMatthias Ringwald HCI_INIT_HOST_BUFFER_SIZE, 6392b838201SMatthias Ringwald HCI_INIT_W4_HOST_BUFFER_SIZE, 640182c3ec8SMatthias Ringwald HCI_INIT_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, 641182c3ec8SMatthias Ringwald HCI_INIT_W4_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, 6422b838201SMatthias Ringwald #endif 6432b838201SMatthias Ringwald 644556d11b3SMatthias Ringwald HCI_INIT_SET_EVENT_MASK, 645556d11b3SMatthias Ringwald HCI_INIT_W4_SET_EVENT_MASK, 6462b838201SMatthias Ringwald 647556d11b3SMatthias Ringwald HCI_INIT_WRITE_SIMPLE_PAIRING_MODE, 648556d11b3SMatthias Ringwald HCI_INIT_W4_WRITE_SIMPLE_PAIRING_MODE, 649556d11b3SMatthias Ringwald HCI_INIT_WRITE_PAGE_TIMEOUT, 650556d11b3SMatthias Ringwald HCI_INIT_W4_WRITE_PAGE_TIMEOUT, 651c33e56d3SMatthias Ringwald HCI_INIT_WRITE_DEFAULT_LINK_POLICY_SETTING, 652c33e56d3SMatthias Ringwald HCI_INIT_W4_WRITE_DEFAULT_LINK_POLICY_SETTING, 653556d11b3SMatthias Ringwald HCI_INIT_WRITE_CLASS_OF_DEVICE, 654556d11b3SMatthias Ringwald HCI_INIT_W4_WRITE_CLASS_OF_DEVICE, 655556d11b3SMatthias Ringwald HCI_INIT_WRITE_LOCAL_NAME, 656556d11b3SMatthias Ringwald HCI_INIT_W4_WRITE_LOCAL_NAME, 657ff00ed1cSMatthias Ringwald HCI_INIT_WRITE_EIR_DATA, 658ff00ed1cSMatthias Ringwald HCI_INIT_W4_WRITE_EIR_DATA, 659f6858d14SMatthias Ringwald HCI_INIT_WRITE_INQUIRY_MODE, 660f6858d14SMatthias Ringwald HCI_INIT_W4_WRITE_INQUIRY_MODE, 6615d23aae8SMatthias Ringwald HCI_INIT_WRITE_SECURE_CONNECTIONS_HOST_ENABLE, 6625d23aae8SMatthias Ringwald HCI_INIT_W4_WRITE_SECURE_CONNECTIONS_HOST_ENABLE, 663556d11b3SMatthias Ringwald HCI_INIT_WRITE_SCAN_ENABLE, 664556d11b3SMatthias Ringwald HCI_INIT_W4_WRITE_SCAN_ENABLE, 665729ed62eSMatthias Ringwald 666577ca2d3SMatthias Ringwald // SCO over HCI 667729ed62eSMatthias Ringwald HCI_INIT_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 668729ed62eSMatthias Ringwald HCI_INIT_W4_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 669483c5078SMatthias Ringwald HCI_INIT_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 670483c5078SMatthias Ringwald HCI_INIT_W4_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 671729ed62eSMatthias Ringwald 672a42798c3SMatthias Ringwald // SCO over HCI Broadcom 673a42798c3SMatthias Ringwald HCI_INIT_BCM_WRITE_SCO_PCM_INT, 674a42798c3SMatthias Ringwald HCI_INIT_W4_BCM_WRITE_SCO_PCM_INT, 675a42798c3SMatthias Ringwald 676903ea03aSMatthias Ringwald #ifdef ENABLE_BLE 677556d11b3SMatthias Ringwald HCI_INIT_LE_READ_BUFFER_SIZE, 678556d11b3SMatthias Ringwald HCI_INIT_W4_LE_READ_BUFFER_SIZE, 679556d11b3SMatthias Ringwald HCI_INIT_WRITE_LE_HOST_SUPPORTED, 680556d11b3SMatthias Ringwald HCI_INIT_W4_WRITE_LE_HOST_SUPPORTED, 681daabb8b8SMatthias Ringwald HCI_INIT_LE_SET_EVENT_MASK, 682daabb8b8SMatthias Ringwald HCI_INIT_W4_LE_SET_EVENT_MASK, 683b435e062SMatthias Ringwald #endif 684b435e062SMatthias Ringwald 685b435e062SMatthias Ringwald #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION 686dcd678baSMatthias Ringwald HCI_INIT_LE_READ_MAX_DATA_LENGTH, 687dcd678baSMatthias Ringwald HCI_INIT_W4_LE_READ_MAX_DATA_LENGTH, 688dcd678baSMatthias Ringwald HCI_INIT_LE_WRITE_SUGGESTED_DATA_LENGTH, 689dcd678baSMatthias Ringwald HCI_INIT_W4_LE_WRITE_SUGGESTED_DATA_LENGTH, 690903ea03aSMatthias Ringwald #endif 691903ea03aSMatthias Ringwald 692903ea03aSMatthias Ringwald #ifdef ENABLE_LE_CENTRAL 6933b6d4121SMatthias Ringwald HCI_INIT_READ_WHITE_LIST_SIZE, 6943b6d4121SMatthias Ringwald HCI_INIT_W4_READ_WHITE_LIST_SIZE, 695556d11b3SMatthias Ringwald 696556d11b3SMatthias Ringwald HCI_INIT_LE_SET_SCAN_PARAMETERS, 697556d11b3SMatthias Ringwald HCI_INIT_W4_LE_SET_SCAN_PARAMETERS, 698903ea03aSMatthias Ringwald #endif 699556d11b3SMatthias Ringwald 700556d11b3SMatthias Ringwald HCI_INIT_DONE, 70174b323a9SMatthias Ringwald 70274b323a9SMatthias Ringwald HCI_FALLING_ASLEEP_DISCONNECT, 70374b323a9SMatthias Ringwald HCI_FALLING_ASLEEP_W4_WRITE_SCAN_ENABLE, 70474b323a9SMatthias Ringwald HCI_FALLING_ASLEEP_COMPLETE, 70574b323a9SMatthias Ringwald 70626fe9592SMatthias Ringwald HCI_INIT_AFTER_SLEEP, 70726fe9592SMatthias Ringwald 708beceeddeSMatthias Ringwald HCI_HALTING_DISCONNECT_ALL_NO_TIMER, 709beceeddeSMatthias Ringwald HCI_HALTING_DISCONNECT_ALL_TIMER, 71026fe9592SMatthias Ringwald HCI_HALTING_W4_TIMER, 71126fe9592SMatthias Ringwald HCI_HALTING_CLOSE, 712556d11b3SMatthias Ringwald 71374b323a9SMatthias Ringwald } hci_substate_t; 714556d11b3SMatthias Ringwald 71545c102fdSMatthias Ringwald enum { 716bbc366e6SMatthias Ringwald LE_ADVERTISEMENT_TASKS_SET_ADV_DATA = 1 << 0, 717bbc366e6SMatthias Ringwald LE_ADVERTISEMENT_TASKS_SET_SCAN_DATA = 1 << 1, 718bbc366e6SMatthias Ringwald LE_ADVERTISEMENT_TASKS_SET_PARAMS = 1 << 2, 71945c102fdSMatthias Ringwald }; 720556d11b3SMatthias Ringwald 721656bec4fSMatthias Ringwald enum { 7225877c8b7SMatthias Ringwald LE_WHITELIST_ON_CONTROLLER = 1 << 0, 7235877c8b7SMatthias Ringwald LE_WHITELIST_ADD_TO_CONTROLLER = 1 << 1, 724e83201bcSMatthias Ringwald LE_WHITELIST_REMOVE_FROM_CONTROLLER = 1 << 2, 725656bec4fSMatthias Ringwald }; 726656bec4fSMatthias Ringwald 727656bec4fSMatthias Ringwald typedef struct { 728665d90f2SMatthias Ringwald btstack_linked_item_t item; 729e83201bcSMatthias Ringwald bd_addr_t address; 730e83201bcSMatthias Ringwald bd_addr_type_t address_type; 731656bec4fSMatthias Ringwald uint8_t state; 732656bec4fSMatthias Ringwald } whitelist_entry_t; 733656bec4fSMatthias Ringwald 73406b35ec0Smatthias.ringwald /** 73506b35ec0Smatthias.ringwald * main data structure 73606b35ec0Smatthias.ringwald */ 73716833f0aSmatthias.ringwald typedef struct { 73806b35ec0Smatthias.ringwald // transport component with configuration 739fb55bd0aSMatthias Ringwald const hci_transport_t * hci_transport; 740fb55bd0aSMatthias Ringwald const void * config; 741fb55bd0aSMatthias Ringwald 742fb55bd0aSMatthias Ringwald // chipset driver 7433fb36a29SMatthias Ringwald const btstack_chipset_t * chipset; 744fb55bd0aSMatthias Ringwald 745fb55bd0aSMatthias Ringwald // hardware power controller 746fb55bd0aSMatthias Ringwald const btstack_control_t * control; 74711e23e5fSmatthias.ringwald 748d6b06661SMatthias Ringwald /* link key db */ 749d6b06661SMatthias Ringwald const btstack_link_key_db_t * link_key_db; 750d6b06661SMatthias Ringwald 7513bc639ceSMatthias Ringwald // list of existing baseband connections 7523bc639ceSMatthias Ringwald btstack_linked_list_t connections; 7533bc639ceSMatthias Ringwald 7543bc639ceSMatthias Ringwald /* callback to L2CAP layer */ 7553d50b4baSMatthias Ringwald btstack_packet_handler_t acl_packet_handler; 7563bc639ceSMatthias Ringwald 7573bc639ceSMatthias Ringwald /* callback for SCO data */ 7583d50b4baSMatthias Ringwald btstack_packet_handler_t sco_packet_handler; 7593bc639ceSMatthias Ringwald 7603bc639ceSMatthias Ringwald /* callbacks for events */ 7613bc639ceSMatthias Ringwald btstack_linked_list_t event_handlers; 7623bc639ceSMatthias Ringwald 76307e010b6SMilanka Ringwald #ifdef ENABLE_CLASSIC 76407e010b6SMilanka Ringwald /* callback for reject classic connection */ 76507e010b6SMilanka Ringwald int (*gap_classic_accept_callback)(bd_addr_t addr); 76607e010b6SMilanka Ringwald #endif 76707e010b6SMilanka Ringwald 7683bc639ceSMatthias Ringwald // hardware error callback 769c2e1fa60SMatthias Ringwald void (*hardware_error_callback)(uint8_t error); 7703bc639ceSMatthias Ringwald 771f456b2d0S[email protected] // basic configuration 7728e618f72S[email protected] const char * local_name; 773ff00ed1cSMatthias Ringwald const uint8_t * eir_data; 774e2386ba1S[email protected] uint32_t class_of_device; 775e2386ba1S[email protected] bd_addr_t local_bd_addr; 776c33e56d3SMatthias Ringwald uint8_t default_link_policy_settings; 777b4eb4420SMatthias Ringwald uint8_t allow_role_switch; 778a45d6b9fS[email protected] uint8_t ssp_enable; 779a45d6b9fS[email protected] uint8_t ssp_io_capability; 780a45d6b9fS[email protected] uint8_t ssp_authentication_requirement; 7811d6b20aeS[email protected] uint8_t ssp_auto_accept; 7825d23aae8SMatthias Ringwald bool secure_connections_enable; 783f6858d14SMatthias Ringwald inquiry_mode_t inquiry_mode; 784170fafaeSMatthias Ringwald #ifdef ENABLE_CLASSIC 785170fafaeSMatthias Ringwald // Errata-11838 mandates 7 bytes for GAP Security Level 1-3, we use 16 as default 786170fafaeSMatthias Ringwald uint8_t gap_required_encyrption_key_size; 7870c3eb48dSMatthias Ringwald uint16_t link_supervision_timeout; 78878315a58SMatthias Ringwald gap_security_level_t gap_security_level; 789170fafaeSMatthias Ringwald #endif 790e2386ba1S[email protected] 79160da618dS[email protected] // single buffer for HCI packet assembly + additional prebuffer for H4 drivers 79226a9b6daSMatthias Ringwald uint8_t * hci_packet_buffer; 793fc6cde64SMatthias Ringwald uint8_t hci_packet_buffer_data[HCI_OUTGOING_PRE_BUFFER_SIZE + HCI_OUTGOING_PACKET_BUFFER_SIZE]; 7946b4af23dS[email protected] uint8_t hci_packet_buffer_reserved; 795452cf3bbS[email protected] uint16_t acl_fragmentation_pos; 796452cf3bbS[email protected] uint16_t acl_fragmentation_total_size; 7974cec6212SMatthias Ringwald uint8_t acl_fragmentation_tx_active; 79806b35ec0Smatthias.ringwald 79916833f0aSmatthias.ringwald /* host to controller flow control */ 80016833f0aSmatthias.ringwald uint8_t num_cmd_packets; 801ee303eddS[email protected] uint8_t acl_packets_total_num; 802e2edc0c3Smatthias.ringwald uint16_t acl_data_packet_length; 803a8b12447S[email protected] uint8_t sco_packets_total_num; 804a8b12447S[email protected] uint8_t sco_data_packet_length; 805ed361f5fSMatthias Ringwald uint8_t synchronous_flow_control_enabled; 806ee303eddS[email protected] uint8_t le_acl_packets_total_num; 807ee303eddS[email protected] uint16_t le_data_packets_length; 8083bc639ceSMatthias Ringwald uint8_t sco_waiting_for_can_send_now; 809f234b250SMatthias Ringwald uint8_t sco_can_send_now; 81016833f0aSmatthias.ringwald 811559e517eS[email protected] /* local supported features */ 812559e517eS[email protected] uint8_t local_supported_features[8]; 813559e517eS[email protected] 814a828a756SMatthias Ringwald /* local supported commands summary - complete info is 64 bytes */ 815cd542ed6SMatthias Ringwald /* 0 - Read Buffer Size (Octet 14/bit 7) */ 816cd542ed6SMatthias Ringwald /* 1 - Write Le Host Supported (Octet 24/bit 6) */ 817577ca2d3SMatthias Ringwald /* 2 - Write Synchronous Flow Control Enable (Octet 10/bit 4) */ 818220006fbSMatthias Ringwald /* 3 - Write Default Erroneous Data Reporting (Octet 18/bit 3) */ 819220006fbSMatthias Ringwald /* 4 - LE Write Suggested Default Data Length (Octet 34/bit 0) */ 820220006fbSMatthias Ringwald /* 5 - LE Read Maximum Data Length (Octet 35/bit 3) */ 821cd542ed6SMatthias Ringwald /* 6 - LE Set Default PHY (Octet 35/bit 5) */ 8226e058d3fSMatthias Ringwald /* 7 - Read Encryption Key Size (Octet 20/bit 4) */ 8238d2d8af1SMatthias Ringwald /* 8 - Read Remote Extended Features (Octet 2/bit 5) */ 8245d23aae8SMatthias Ringwald /* 9 - Write Secure Connections Host (Octet 32/bit 3) */ 8258d2d8af1SMatthias Ringwald uint8_t local_supported_commands[2]; 826a828a756SMatthias Ringwald 8274696bddbSMatthias Ringwald /* bluetooth device information from hci read local version information */ 8284696bddbSMatthias Ringwald // uint16_t hci_version; 8294696bddbSMatthias Ringwald // uint16_t hci_revision; 8304696bddbSMatthias Ringwald // uint16_t lmp_version; 8314696bddbSMatthias Ringwald uint16_t manufacturer; 8324696bddbSMatthias Ringwald // uint16_t lmp_subversion; 8334696bddbSMatthias Ringwald 8348f8108aaSmatthias.ringwald // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE 8358f8108aaSmatthias.ringwald uint16_t packet_types; 8368f8108aaSmatthias.ringwald 83729d53098Smatthias.ringwald 8383429f56bSmatthias.ringwald /* hci state machine */ 8393429f56bSmatthias.ringwald HCI_STATE state; 84074b323a9SMatthias Ringwald hci_substate_t substate; 841ec820d77SMatthias Ringwald btstack_timer_source_t timeout; 842ae334e9eSMatthias Ringwald btstack_chipset_result_t chipset_result; 8433429f56bSmatthias.ringwald 8445127cc62S[email protected] uint16_t last_cmd_opcode; 8455127cc62S[email protected] 846f5875de5SMatthias Ringwald uint8_t cmds_ready; 8470a51f88bSMatthias Ringwald 8480a51f88bSMatthias Ringwald /* buffer for scan enable cmd - 0xff no change */ 8490a51f88bSMatthias Ringwald uint8_t new_scan_enable_value; 8500a51f88bSMatthias Ringwald 8510a51f88bSMatthias Ringwald uint8_t discoverable; 8520a51f88bSMatthias Ringwald uint8_t connectable; 8530a51f88bSMatthias Ringwald uint8_t bondable; 8540a51f88bSMatthias Ringwald 855f5875de5SMatthias Ringwald uint8_t inquiry_state; // see hci.c for state defines 856f5875de5SMatthias Ringwald 857b7f1ee76SMatthias Ringwald bd_addr_t remote_name_addr; 858b7f1ee76SMatthias Ringwald uint16_t remote_name_clock_offset; 859b7f1ee76SMatthias Ringwald uint8_t remote_name_page_scan_repetition_mode; 860b7f1ee76SMatthias Ringwald uint8_t remote_name_state; // see hci.c for state defines 861b7f1ee76SMatthias Ringwald 8620a51f88bSMatthias Ringwald bd_addr_t gap_pairing_addr; 8630a51f88bSMatthias Ringwald uint8_t gap_pairing_state; // see hci.c for state defines 864aad97216SMatthias Ringwald uint8_t gap_pairing_pin_len; 8650a51f88bSMatthias Ringwald union { 866aad97216SMatthias Ringwald const uint8_t * gap_pairing_pin; 8670a51f88bSMatthias Ringwald uint32_t gap_pairing_passkey; 868d504181aSMatthias Ringwald } gap_pairing_input; 869f5875de5SMatthias Ringwald 870d950d659SMatthias Ringwald uint16_t sco_voice_setting; 871ee752bb8SMatthias Ringwald uint16_t sco_voice_setting_active; 872d950d659SMatthias Ringwald 8734b3e1e19SMatthias Ringwald uint8_t loopback_mode; 8744b3e1e19SMatthias Ringwald 8753dbb95f9Smatthias.ringwald // buffer for single connection decline 8763dbb95f9Smatthias.ringwald uint8_t decline_reason; 8773dbb95f9Smatthias.ringwald bd_addr_t decline_addr; 878381fbed8Smatthias.ringwald 8792b838201SMatthias Ringwald #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 8802b838201SMatthias Ringwald uint8_t host_completed_packets; 8812b838201SMatthias Ringwald #endif 8822b838201SMatthias Ringwald 883b95a5a35SMatthias Ringwald #ifdef ENABLE_BLE 884b95a5a35SMatthias Ringwald uint8_t le_own_addr_type; 885b95a5a35SMatthias Ringwald bd_addr_t le_random_address; 886b95a5a35SMatthias Ringwald uint8_t le_random_address_set; 88713eb2a2eSMatthias Ringwald 88813eb2a2eSMatthias Ringwald // LE Whitelist Management 88913eb2a2eSMatthias Ringwald uint8_t le_whitelist_capacity; 89013eb2a2eSMatthias Ringwald btstack_linked_list_t le_whitelist; 891b95a5a35SMatthias Ringwald #endif 892e2602ea2Smatthias.ringwald 893d70217a2SMatthias Ringwald #ifdef ENABLE_LE_CENTRAL 894fde725feSMatthias Ringwald bool le_scanning_enabled; 895fde725feSMatthias Ringwald bool le_scanning_active; 8966fab74dbSMatthias Ringwald 897b04dfa37SMatthias Ringwald le_connecting_state_t le_connecting_state; 898d5b1a89eSMatthias Ringwald le_connecting_state_t le_connecting_request; 899e2602ea2Smatthias.ringwald 9008b69e4c7SMatthias Ringwald bool le_scanning_param_update; 901e2602ea2Smatthias.ringwald uint8_t le_scan_type; 9025a1ca52eSMatthias Ringwald uint8_t le_scan_filter_policy; 903e2602ea2Smatthias.ringwald uint16_t le_scan_interval; 904e2602ea2Smatthias.ringwald uint16_t le_scan_window; 905da886c03S[email protected] 90673044eb2SMatthias Ringwald // Connection parameters 90773044eb2SMatthias Ringwald uint16_t le_connection_interval_min; 90873044eb2SMatthias Ringwald uint16_t le_connection_interval_max; 90973044eb2SMatthias Ringwald uint16_t le_connection_latency; 91073044eb2SMatthias Ringwald uint16_t le_supervision_timeout; 91173044eb2SMatthias Ringwald uint16_t le_minimum_ce_length; 91273044eb2SMatthias Ringwald uint16_t le_maximum_ce_length; 913cbe54ab2SJakob Krantz uint16_t le_connection_scan_interval; 914cbe54ab2SJakob Krantz uint16_t le_connection_scan_window; 915d70217a2SMatthias Ringwald #endif 916d70217a2SMatthias Ringwald 917da886c03S[email protected] le_connection_parameter_range_t le_connection_parameter_range; 918f456b2d0S[email protected] 919d70217a2SMatthias Ringwald #ifdef ENABLE_LE_PERIPHERAL 92045c102fdSMatthias Ringwald uint8_t * le_advertisements_data; 92145c102fdSMatthias Ringwald uint8_t le_advertisements_data_len; 92245c102fdSMatthias Ringwald 923501f56b3SMatthias Ringwald uint8_t * le_scan_response_data; 924501f56b3SMatthias Ringwald uint8_t le_scan_response_data_len; 925501f56b3SMatthias Ringwald 926171293d3SMatthias Ringwald uint8_t le_advertisements_active; 92745c102fdSMatthias Ringwald uint8_t le_advertisements_enabled; 928bbc366e6SMatthias Ringwald bool le_advertisements_enabled_for_current_roles; 92945c102fdSMatthias Ringwald uint8_t le_advertisements_todo; 93045c102fdSMatthias Ringwald 93145c102fdSMatthias Ringwald uint16_t le_advertisements_interval_min; 93245c102fdSMatthias Ringwald uint16_t le_advertisements_interval_max; 93345c102fdSMatthias Ringwald uint8_t le_advertisements_type; 93445c102fdSMatthias Ringwald uint8_t le_advertisements_direct_address_type; 93545c102fdSMatthias Ringwald uint8_t le_advertisements_channel_map; 93645c102fdSMatthias Ringwald uint8_t le_advertisements_filter_policy; 93745c102fdSMatthias Ringwald bd_addr_t le_advertisements_direct_address; 9382b6ab3e6SMatthias Ringwald 9392b6ab3e6SMatthias Ringwald uint8_t le_max_number_peripheral_connections; 940d70217a2SMatthias Ringwald #endif 9413b6d4121SMatthias Ringwald 942b435e062SMatthias Ringwald #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION 943dcd678baSMatthias Ringwald // LE Data Length 944dcd678baSMatthias Ringwald uint16_t le_supported_max_tx_octets; 945dcd678baSMatthias Ringwald uint16_t le_supported_max_tx_time; 946b435e062SMatthias Ringwald #endif 947dcd678baSMatthias Ringwald 948f456b2d0S[email protected] // custom BD ADDR 949f456b2d0S[email protected] bd_addr_t custom_bd_addr; 950f456b2d0S[email protected] uint8_t custom_bd_addr_set; 951f456b2d0S[email protected] 952c4c88f1bSJakob Krantz #ifdef ENABLE_CLASSIC 953c4c88f1bSJakob Krantz uint8_t master_slave_policy; 954c4c88f1bSJakob Krantz #endif 955c4c88f1bSJakob Krantz 956229331c6SMatthias Ringwald // address and address_type of active create connection command (ACL, SCO, LE) 957229331c6SMatthias Ringwald bd_addr_t outgoing_addr; 958229331c6SMatthias Ringwald bd_addr_type_t outgoing_addr_type; 95916833f0aSmatthias.ringwald } hci_stack_t; 96016833f0aSmatthias.ringwald 96115a95bd5SMatthias Ringwald 9625e6d58c4SMilanka Ringwald /* API_START */ 9635e6d58c4SMilanka Ringwald 96495d71764SMatthias Ringwald 96515a95bd5SMatthias Ringwald // HCI init and configuration 96695d71764SMatthias Ringwald 9675e6d58c4SMilanka Ringwald 9683de95307SMilanka Ringwald /** 9693de95307SMilanka Ringwald * @brief Set up HCI. Needs to be called before any other function. 9703de95307SMilanka Ringwald */ 9712d5e09d6SMatthias Ringwald void hci_init(const hci_transport_t *transport, const void *config); 972e6cc8be2S[email protected] 9733de95307SMilanka Ringwald /** 974fb55bd0aSMatthias Ringwald * @brief Configure Bluetooth chipset driver. Has to be called before power on, or right after receiving the local version information. 975c67501cbSMatthias Ringwald */ 9763fb36a29SMatthias Ringwald void hci_set_chipset(const btstack_chipset_t *chipset_driver); 977c67501cbSMatthias Ringwald 978c67501cbSMatthias Ringwald /** 979fb55bd0aSMatthias Ringwald * @brief Configure Bluetooth hardware control. Has to be called before power on. 980fb55bd0aSMatthias Ringwald */ 981fb55bd0aSMatthias Ringwald void hci_set_control(const btstack_control_t *hardware_control); 982fb55bd0aSMatthias Ringwald 983fb55bd0aSMatthias Ringwald /** 9842d5e09d6SMatthias Ringwald * @brief Configure Bluetooth hardware control. Has to be called before power on. 9852d5e09d6SMatthias Ringwald */ 9862d5e09d6SMatthias Ringwald void hci_set_link_key_db(btstack_link_key_db_t const * link_key_db); 9872d5e09d6SMatthias Ringwald 9882d5e09d6SMatthias Ringwald /** 98915a95bd5SMatthias Ringwald * @brief Set callback for Bluetooth Hardware Error 99015a95bd5SMatthias Ringwald */ 991c2e1fa60SMatthias Ringwald void hci_set_hardware_error_callback(void (*fn)(uint8_t error)); 99215a95bd5SMatthias Ringwald 99315a95bd5SMatthias Ringwald /** 99415a95bd5SMatthias Ringwald * @brief Set Public BD ADDR - passed on to Bluetooth chipset during init if supported in bt_control_h 9953de95307SMilanka Ringwald */ 996f456b2d0S[email protected] void hci_set_bd_addr(bd_addr_t addr); 997f456b2d0S[email protected] 9983de95307SMilanka Ringwald /** 99915a95bd5SMatthias Ringwald * @brief Configure Voice Setting for use with SCO data in HSP/HFP 100015a95bd5SMatthias Ringwald */ 100115a95bd5SMatthias Ringwald void hci_set_sco_voice_setting(uint16_t voice_setting); 100215a95bd5SMatthias Ringwald 100315a95bd5SMatthias Ringwald /** 100415a95bd5SMatthias Ringwald * @brief Get SCO Voice Setting 100515a95bd5SMatthias Ringwald * @return current voice setting 100615a95bd5SMatthias Ringwald */ 100715a95bd5SMatthias Ringwald uint16_t hci_get_sco_voice_setting(void); 100815a95bd5SMatthias Ringwald 100915a95bd5SMatthias Ringwald /** 1010f6858d14SMatthias Ringwald * @brief Set inquiry mode: standard, with RSSI, with RSSI + Extended Inquiry Results. Has to be called before power on. 1011f6858d14SMatthias Ringwald * @param inquriy_mode see bluetooth_defines.h 1012f6858d14SMatthias Ringwald */ 1013f6858d14SMatthias Ringwald void hci_set_inquiry_mode(inquiry_mode_t mode); 1014f6858d14SMatthias Ringwald 1015f6858d14SMatthias Ringwald /** 101615a95bd5SMatthias Ringwald * @brief Requests the change of BTstack power mode. 101715a95bd5SMatthias Ringwald */ 101815a95bd5SMatthias Ringwald int hci_power_control(HCI_POWER_MODE mode); 101915a95bd5SMatthias Ringwald 102015a95bd5SMatthias Ringwald /** 102115a95bd5SMatthias Ringwald * @brief Shutdown HCI 102215a95bd5SMatthias Ringwald */ 102315a95bd5SMatthias Ringwald void hci_close(void); 102415a95bd5SMatthias Ringwald 102515a95bd5SMatthias Ringwald 102615a95bd5SMatthias Ringwald // Callback registration 102715a95bd5SMatthias Ringwald 102815a95bd5SMatthias Ringwald 102915a95bd5SMatthias Ringwald /** 1030d6b06661SMatthias Ringwald * @brief Add event packet handler. 1031d6b06661SMatthias Ringwald */ 1032d6b06661SMatthias Ringwald void hci_add_event_handler(btstack_packet_callback_registration_t * callback_handler); 1033d6b06661SMatthias Ringwald 1034d6b06661SMatthias Ringwald /** 1035fb37a842SMatthias Ringwald * @brief Registers a packet handler for ACL data. Used by L2CAP 10363de95307SMilanka Ringwald */ 10373d50b4baSMatthias Ringwald void hci_register_acl_packet_handler(btstack_packet_handler_t handler); 1038e6cc8be2S[email protected] 10393de95307SMilanka Ringwald /** 10408abbe8b5SMatthias Ringwald * @brief Registers a packet handler for SCO data. Used for HSP and HFP profiles. 10418abbe8b5SMatthias Ringwald */ 10423d50b4baSMatthias Ringwald void hci_register_sco_packet_handler(btstack_packet_handler_t handler); 10438abbe8b5SMatthias Ringwald 104415a95bd5SMatthias Ringwald 104515a95bd5SMatthias Ringwald // Sending HCI Commands 1046e6cc8be2S[email protected] 10473de95307SMilanka Ringwald /** 104815a95bd5SMatthias Ringwald * @brief Check if CMD packet can be sent to controller 10493de95307SMilanka Ringwald */ 105015a95bd5SMatthias Ringwald int hci_can_send_command_packet_now(void); 1051e6cc8be2S[email protected] 10523de95307SMilanka Ringwald /** 10533de95307SMilanka Ringwald * @brief Creates and sends HCI command packets based on a template and a list of parameters. Will return error if outgoing data buffer is occupied. 10543de95307SMilanka Ringwald */ 1055e6cc8be2S[email protected] int hci_send_cmd(const hci_cmd_t *cmd, ...); 1056e6cc8be2S[email protected] 1057e6cc8be2S[email protected] 105815a95bd5SMatthias Ringwald // Sending SCO Packets 1059d950d659SMatthias Ringwald 1060b3aad8daSMatthias Ringwald /** @brief Get SCO packet length for current SCO Voice setting 1061b3aad8daSMatthias Ringwald * @note Using SCO packets of the exact length is required for USB transfer 1062b3aad8daSMatthias Ringwald * @return Length of SCO packets in bytes (not audio frames) incl. 3 byte header 1063b3aad8daSMatthias Ringwald */ 1064b3aad8daSMatthias Ringwald int hci_get_sco_packet_length(void); 1065b3aad8daSMatthias Ringwald 106695d71764SMatthias Ringwald /** 1067d057580eSMatthias Ringwald * @brief Request emission of HCI_EVENT_SCO_CAN_SEND_NOW as soon as possible 1068d057580eSMatthias Ringwald * @note HCI_EVENT_SCO_CAN_SEND_NOW might be emitted during call to this function 1069d057580eSMatthias Ringwald * so packet handler should be ready to handle it 1070d057580eSMatthias Ringwald */ 1071d057580eSMatthias Ringwald void hci_request_sco_can_send_now_event(void); 1072d057580eSMatthias Ringwald 1073d057580eSMatthias Ringwald /** 1074d057580eSMatthias Ringwald * @brief Check HCI packet buffer and if SCO packet can be sent to controller 107515a95bd5SMatthias Ringwald */ 107615a95bd5SMatthias Ringwald int hci_can_send_sco_packet_now(void); 107715a95bd5SMatthias Ringwald 107815a95bd5SMatthias Ringwald /** 107915a95bd5SMatthias Ringwald * @brief Check if SCO packet can be sent to controller 108015a95bd5SMatthias Ringwald */ 108115a95bd5SMatthias Ringwald int hci_can_send_prepared_sco_packet_now(void); 108215a95bd5SMatthias Ringwald 108315a95bd5SMatthias Ringwald /** 1084d057580eSMatthias Ringwald * @brief Send SCO packet prepared in HCI packet buffer 108515a95bd5SMatthias Ringwald */ 108615a95bd5SMatthias Ringwald int hci_send_sco_packet_buffer(int size); 108715a95bd5SMatthias Ringwald 108815a95bd5SMatthias Ringwald 108915a95bd5SMatthias Ringwald // Outgoing packet buffer, also used for SCO packets 109015a95bd5SMatthias Ringwald // see hci_can_send_prepared_sco_packet_now amn hci_send_sco_packet_buffer 109115a95bd5SMatthias Ringwald 109215a95bd5SMatthias Ringwald /** 109395d71764SMatthias Ringwald * Reserves outgoing packet buffer. 109495d71764SMatthias Ringwald * @return 1 on success 109595d71764SMatthias Ringwald */ 109695d71764SMatthias Ringwald int hci_reserve_packet_buffer(void); 109795d71764SMatthias Ringwald 109895d71764SMatthias Ringwald /** 109995d71764SMatthias Ringwald * Get pointer for outgoing packet buffer 110095d71764SMatthias Ringwald */ 110195d71764SMatthias Ringwald uint8_t* hci_get_outgoing_packet_buffer(void); 110295d71764SMatthias Ringwald 110395d71764SMatthias Ringwald /** 110495d71764SMatthias Ringwald * Release outgoing packet buffer\ 110595d71764SMatthias Ringwald * @note only called instead of hci_send_preparared 110695d71764SMatthias Ringwald */ 110795d71764SMatthias Ringwald void hci_release_packet_buffer(void); 110895d71764SMatthias Ringwald 1109c4c88f1bSJakob Krantz /** 1110c4c88f1bSJakob Krantz * @brief Sets the master/slave policy 1111c4c88f1bSJakob Krantz * @param policy (0: attempt to become master, 1: let connecting device decide) 1112c4c88f1bSJakob Krantz */ 1113c4c88f1bSJakob Krantz void hci_set_master_slave_policy(uint8_t policy); 111495d71764SMatthias Ringwald 11155e6d58c4SMilanka Ringwald /* API_END */ 11162bd8b7e7S[email protected] 111715a95bd5SMatthias Ringwald 111894be1a66SMatthias Ringwald /** 1119f5e5741dSMatthias Ringwald * va_list version of hci_send_cmd, call hci_send_cmd_packet 112094be1a66SMatthias Ringwald */ 112194be1a66SMatthias Ringwald int hci_send_cmd_va_arg(const hci_cmd_t *cmd, va_list argtr); 112215a95bd5SMatthias Ringwald 112345c102fdSMatthias Ringwald /** 112495d71764SMatthias Ringwald * Get connection iterator. Only used by l2cap.c and sm.c 112595d71764SMatthias Ringwald */ 112695d71764SMatthias Ringwald void hci_connections_get_iterator(btstack_linked_list_iterator_t *it); 112795d71764SMatthias Ringwald 112895d71764SMatthias Ringwald /** 112915a95bd5SMatthias Ringwald * Get internal hci_connection_t for given handle. Used by L2CAP, SM, daemon 113015a95bd5SMatthias Ringwald */ 113115a95bd5SMatthias Ringwald hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle); 113215a95bd5SMatthias Ringwald 113315a95bd5SMatthias Ringwald /** 113415a95bd5SMatthias Ringwald * Get internal hci_connection_t for given Bluetooth addres. Called by L2CAP 113515a95bd5SMatthias Ringwald */ 113615a95bd5SMatthias Ringwald hci_connection_t * hci_connection_for_bd_addr_and_type(bd_addr_t addr, bd_addr_type_t addr_type); 113715a95bd5SMatthias Ringwald 113815a95bd5SMatthias Ringwald /** 113915a95bd5SMatthias Ringwald * Check if outgoing packet buffer is reserved. Used for internal checks in l2cap.c 114015a95bd5SMatthias Ringwald */ 114115a95bd5SMatthias Ringwald int hci_is_packet_buffer_reserved(void); 114215a95bd5SMatthias Ringwald 114315a95bd5SMatthias Ringwald /** 114495d71764SMatthias Ringwald * Check hci packet buffer is free and a classic acl packet can be sent to controller 114595d71764SMatthias Ringwald */ 114695d71764SMatthias Ringwald int hci_can_send_acl_classic_packet_now(void); 114795d71764SMatthias Ringwald 114895d71764SMatthias Ringwald /** 114995d71764SMatthias Ringwald * Check hci packet buffer is free and an LE acl packet can be sent to controller 115095d71764SMatthias Ringwald */ 115195d71764SMatthias Ringwald int hci_can_send_acl_le_packet_now(void); 115295d71764SMatthias Ringwald 115395d71764SMatthias Ringwald /** 115495d71764SMatthias Ringwald * Check hci packet buffer is free and an acl packet for the given handle can be sent to controller 115595d71764SMatthias Ringwald */ 115695d71764SMatthias Ringwald int hci_can_send_acl_packet_now(hci_con_handle_t con_handle); 115795d71764SMatthias Ringwald 115895d71764SMatthias Ringwald /** 115995d71764SMatthias Ringwald * Check if acl packet for the given handle can be sent to controller 116095d71764SMatthias Ringwald */ 116195d71764SMatthias Ringwald int hci_can_send_prepared_acl_packet_now(hci_con_handle_t con_handle); 116295d71764SMatthias Ringwald 116395d71764SMatthias Ringwald /** 116495d71764SMatthias Ringwald * Send acl packet prepared in hci packet buffer 116595d71764SMatthias Ringwald */ 116695d71764SMatthias Ringwald int hci_send_acl_packet_buffer(int size); 116795d71764SMatthias Ringwald 116895d71764SMatthias Ringwald /** 116995d71764SMatthias Ringwald * Check if authentication is active. It delays automatic disconnect while no L2CAP connection 117095d71764SMatthias Ringwald * Called by l2cap. 117195d71764SMatthias Ringwald */ 117295d71764SMatthias Ringwald int hci_authentication_active_for_handle(hci_con_handle_t handle); 117395d71764SMatthias Ringwald 117495d71764SMatthias Ringwald /** 117595d71764SMatthias Ringwald * Get maximal ACL Classic data packet length based on used buffer size. Called by L2CAP 117695d71764SMatthias Ringwald */ 117795d71764SMatthias Ringwald uint16_t hci_max_acl_data_packet_length(void); 117895d71764SMatthias Ringwald 117995d71764SMatthias Ringwald /** 118095d71764SMatthias Ringwald * Get supported packet types. Called by L2CAP 118195d71764SMatthias Ringwald */ 118295d71764SMatthias Ringwald uint16_t hci_usable_acl_packet_types(void); 118395d71764SMatthias Ringwald 118495d71764SMatthias Ringwald /** 118595d71764SMatthias Ringwald * Check if ACL packets marked as non flushable can be sent. Called by L2CAP 118695d71764SMatthias Ringwald */ 118795d71764SMatthias Ringwald int hci_non_flushable_packet_boundary_flag_supported(void); 118895d71764SMatthias Ringwald 118995d71764SMatthias Ringwald /** 11903e68d23dSMatthias Ringwald * Check if extended SCO Link is supported 11913e68d23dSMatthias Ringwald */ 11923e68d23dSMatthias Ringwald int hci_extended_sco_link_supported(void); 11933e68d23dSMatthias Ringwald 11943e68d23dSMatthias Ringwald /** 119595d71764SMatthias Ringwald * Check if SSP is supported on both sides. Called by L2CAP 119695d71764SMatthias Ringwald */ 119715a95bd5SMatthias Ringwald int gap_ssp_supported_on_both_sides(hci_con_handle_t handle); 119895d71764SMatthias Ringwald 119995d71764SMatthias Ringwald /** 120095d71764SMatthias Ringwald * Disconn because of security block. Called by L2CAP 120195d71764SMatthias Ringwald */ 120295d71764SMatthias Ringwald void hci_disconnect_security_block(hci_con_handle_t con_handle); 120395d71764SMatthias Ringwald 120495d71764SMatthias Ringwald /** 120595d71764SMatthias Ringwald * Query if remote side supports eSCO 120695d71764SMatthias Ringwald */ 120795d71764SMatthias Ringwald int hci_remote_esco_supported(hci_con_handle_t con_handle); 120895d71764SMatthias Ringwald 120995d71764SMatthias Ringwald /** 121095d71764SMatthias Ringwald * Emit current HCI state. Called by daemon 121195d71764SMatthias Ringwald */ 121295d71764SMatthias Ringwald void hci_emit_state(void); 121395d71764SMatthias Ringwald 121495d71764SMatthias Ringwald /** 1215f5e5741dSMatthias Ringwald * Send complete CMD packet. Called by daemon and hci_send_cmd_va_arg 1216f5e5741dSMatthias Ringwald * @returns 0 if command was successfully sent to HCI Transport layer 121795d71764SMatthias Ringwald */ 121895d71764SMatthias Ringwald int hci_send_cmd_packet(uint8_t *packet, int size); 121995d71764SMatthias Ringwald 122095d71764SMatthias Ringwald /** 122195d71764SMatthias Ringwald * Disconnect all HCI connections. Called by daemon 122295d71764SMatthias Ringwald */ 122395d71764SMatthias Ringwald void hci_disconnect_all(void); 122495d71764SMatthias Ringwald 122595d71764SMatthias Ringwald /** 122695d71764SMatthias Ringwald * Get number of free acl slots for packets of given handle. Called by daemon 122795d71764SMatthias Ringwald */ 122895d71764SMatthias Ringwald int hci_number_free_acl_slots_for_handle(hci_con_handle_t con_handle); 122995d71764SMatthias Ringwald 123095d71764SMatthias Ringwald /** 123145c102fdSMatthias Ringwald * @brief Set Advertisement Parameters 123245c102fdSMatthias Ringwald * @param adv_int_min 123345c102fdSMatthias Ringwald * @param adv_int_max 123445c102fdSMatthias Ringwald * @param adv_type 123545c102fdSMatthias Ringwald * @param direct_address_type 123645c102fdSMatthias Ringwald * @param direct_address 123745c102fdSMatthias Ringwald * @param channel_map 123845c102fdSMatthias Ringwald * @param filter_policy 123945c102fdSMatthias Ringwald * 1240b95a5a35SMatthias Ringwald * @note internal use. use gap_advertisements_set_params from gap.h instead. 124145c102fdSMatthias Ringwald */ 124245c102fdSMatthias Ringwald void hci_le_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 1243b95a5a35SMatthias Ringwald uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy); 124445c102fdSMatthias Ringwald 1245b95a5a35SMatthias Ringwald /** 1246b95a5a35SMatthias Ringwald * 1247b95a5a35SMatthias Ringwald * @note internal use. use gap_random_address_set_mode from gap.h instead. 1248b95a5a35SMatthias Ringwald */ 1249b95a5a35SMatthias Ringwald void hci_le_set_own_address_type(uint8_t own_address_type); 125033373e40SMatthias Ringwald 125133373e40SMatthias Ringwald /** 125233373e40SMatthias Ringwald * @brief Get Manufactured 125333373e40SMatthias Ringwald * @return manufacturer id 125433373e40SMatthias Ringwald */ 125533373e40SMatthias Ringwald uint16_t hci_get_manufacturer(void); 125695d71764SMatthias Ringwald 1257eddac615SMatthias Ringwald /** 1258eddac615SMatthias Ringwald * Defer halt. Used by btstack_crypto to allow current HCI operation to complete 1259eddac615SMatthias Ringwald */ 1260eddac615SMatthias Ringwald void hci_halting_defer(void); 1261eddac615SMatthias Ringwald 126295d71764SMatthias Ringwald // Only for PTS testing 126395d71764SMatthias Ringwald 126495d71764SMatthias Ringwald /** 126595d71764SMatthias Ringwald * Disable automatic L2CAP disconnect if no L2CAP connection is established 126695d71764SMatthias Ringwald */ 126795d71764SMatthias Ringwald void hci_disable_l2cap_timeout_check(void); 126895d71764SMatthias Ringwald 1269ec111c8bSMatthias Ringwald /** 1270b4eb4420SMatthias Ringwald * Get Classic Allow Role Switch param 1271b4eb4420SMatthias Ringwald */ 1272b4eb4420SMatthias Ringwald uint8_t hci_get_allow_role_switch(void); 1273b4eb4420SMatthias Ringwald 1274b4eb4420SMatthias Ringwald /** 1275ec111c8bSMatthias Ringwald * Get state 1276ec111c8bSMatthias Ringwald */ 1277ec111c8bSMatthias Ringwald HCI_STATE hci_get_state(void); 1278ec111c8bSMatthias Ringwald 127918976c74SMatthias Ringwald // setup test connections, used for fuzzing 128018976c74SMatthias Ringwald void hci_setup_test_connections_fuzz(void); 128118976c74SMatthias Ringwald 1282eddac615SMatthias Ringwald // free all connections, used for fuzzing 1283eddac615SMatthias Ringwald void hci_free_connections_fuzz(void); 1284beceeddeSMatthias Ringwald 12851470db0cSMatthias Ringwald // simulate stack bootup 12861470db0cSMatthias Ringwald void hci_simulate_working_fuzz(void); 12871470db0cSMatthias Ringwald 1288e3b6fe7eSmatthias.ringwald #if defined __cplusplus 1289e3b6fe7eSmatthias.ringwald } 1290e3b6fe7eSmatthias.ringwald #endif 1291f471afd8S[email protected] 129280e33422SMatthias Ringwald #endif // HCI_H 1293