1 /* 2 * Copyright (C) 2014 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL BLUEKITCHEN 24 * GMBH OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 /** 39 * @title Host Controler Interface (HCI) 40 * 41 */ 42 43 #ifndef HCI_H 44 #define HCI_H 45 46 #include "btstack_config.h" 47 48 #include "btstack_chipset.h" 49 #include "btstack_control.h" 50 #include "btstack_linked_list.h" 51 #include "btstack_util.h" 52 #include "hci_cmd.h" 53 #include "gap.h" 54 #include "hci_transport.h" 55 #include "btstack_run_loop.h" 56 57 #ifdef ENABLE_CLASSIC 58 #include "classic/btstack_link_key_db.h" 59 #endif 60 61 #ifdef ENABLE_BLE 62 #include "ble/att_db.h" 63 #endif 64 65 #ifdef HAVE_SCO_TRANSPORT 66 #include "btstack_sco_transport.h" 67 #endif 68 69 #include <stdint.h> 70 #include <stdlib.h> 71 #include <stdarg.h> 72 73 #if defined __cplusplus 74 extern "C" { 75 #endif 76 77 // packet buffer sizes 78 #define HCI_CMD_HEADER_SIZE 3 79 #define HCI_ACL_HEADER_SIZE 4 80 #define HCI_SCO_HEADER_SIZE 3 81 #define HCI_EVENT_HEADER_SIZE 2 82 83 #define HCI_EVENT_PAYLOAD_SIZE 255 84 #define HCI_CMD_PAYLOAD_SIZE 255 85 86 // Max HCI Command LE payload size: 87 // 64 from LE Generate DHKey command 88 // 32 from LE Encrypt command 89 #if defined(ENABLE_LE_SECURE_CONNECTIONS) && !defined(ENABLE_MICRO_ECC_FOR_LE_SECURE_CONNECTIONS) 90 #define HCI_CMD_PAYLOAD_SIZE_LE 64 91 #else 92 #define HCI_CMD_PAYLOAD_SIZE_LE 32 93 #endif 94 95 // HCI_ACL_PAYLOAD_SIZE is configurable and defined in config.h 96 // addition byte in even to terminate remote name request with '\0' 97 #define HCI_EVENT_BUFFER_SIZE (HCI_EVENT_HEADER_SIZE + HCI_EVENT_PAYLOAD_SIZE + 1) 98 99 #ifdef ENABLE_CLASSIC 100 #define HCI_CMD_BUFFER_SIZE (HCI_CMD_HEADER_SIZE + HCI_CMD_PAYLOAD_SIZE) 101 #else 102 #define HCI_CMD_BUFFER_SIZE (HCI_CMD_HEADER_SIZE + HCI_CMD_PAYLOAD_SIZE_LE) 103 #endif 104 105 #define HCI_ACL_BUFFER_SIZE (HCI_ACL_HEADER_SIZE + HCI_ACL_PAYLOAD_SIZE) 106 107 // size of hci incoming buffer, big enough for event or acl packet without H4 packet type 108 #ifdef HCI_INCOMING_PACKET_BUFFER_SIZE 109 #if HCI_INCOMING_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE 110 #error HCI_INCOMING_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE 111 #endif 112 #if HCI_INCOMING_PACKET_BUFFER_SIZE < HCI_EVENT_BUFFER_SIZE 113 #error HCI_INCOMING_PACKET_BUFFER_SIZE must be equal or larger than HCI_EVENT_BUFFER_SIZE 114 #endif 115 #else 116 #if HCI_ACL_BUFFER_SIZE > HCI_EVENT_BUFFER_SIZE 117 #define HCI_INCOMING_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE 118 #else 119 #define HCI_INCOMING_PACKET_BUFFER_SIZE HCI_EVENT_BUFFER_SIZE 120 #endif 121 #endif 122 123 // size of hci outgoing buffer, big enough for command or acl packet without H4 packet type 124 #ifdef HCI_OUTGOING_PACKET_BUFFER_SIZE 125 #if HCI_OUTGOING_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE 126 #error HCI_OUTGOING_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE 127 #endif 128 #if HCI_OUTGOING_PACKET_BUFFER_SIZE < HCI_CMD_BUFFER_SIZE 129 #error HCI_OUTGOING_PACKET_BUFFER_SIZE must be equal or larger than HCI_CMD_BUFFER_SIZE 130 #endif 131 #else 132 #if HCI_ACL_BUFFER_SIZE > HCI_CMD_BUFFER_SIZE 133 #define HCI_OUTGOING_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE 134 #else 135 #define HCI_OUTGOING_PACKET_BUFFER_SIZE HCI_CMD_BUFFER_SIZE 136 #endif 137 #endif 138 139 // additional pre-buffer space for packets to Bluetooth module 140 // - H4 requires 1 byte for the packet type 141 // - h5 requires 4 bytes for H5 header 142 #ifndef HCI_OUTGOING_PRE_BUFFER_SIZE 143 #ifdef HAVE_HOST_CONTROLLER_API 144 #define HCI_OUTGOING_PRE_BUFFER_SIZE 0 145 #else 146 #ifdef ENABLE_H5 147 #define HCI_OUTGOING_PRE_BUFFER_SIZE 4 148 #else 149 #define HCI_OUTGOING_PRE_BUFFER_SIZE 1 150 #endif 151 #endif 152 #endif 153 154 // BNEP may uncompress the IP Header by 16 bytes, GATT Client requires two additional bytes for long characteristic reads 155 #ifndef HCI_INCOMING_PRE_BUFFER_SIZE 156 #ifdef ENABLE_CLASSIC 157 #define HCI_INCOMING_PRE_BUFFER_SIZE (16 - HCI_ACL_HEADER_SIZE - 4) 158 #else 159 #define HCI_INCOMING_PRE_BUFFER_SIZE 2 160 #endif 161 #endif 162 163 // 164 #define IS_COMMAND(packet, command) ( little_endian_read_16(packet,0) == command.opcode ) 165 166 // check if command complete event for given command 167 #define HCI_EVENT_IS_COMMAND_COMPLETE(event,cmd) ( (event[0] == HCI_EVENT_COMMAND_COMPLETE) && (little_endian_read_16(event,3) == cmd.opcode) ) 168 #define HCI_EVENT_IS_COMMAND_STATUS(event,cmd) ( (event[0] == HCI_EVENT_COMMAND_STATUS) && (little_endian_read_16(event,4) == cmd.opcode) ) 169 170 // Code+Len=2, Pkts+Opcode=3; total=5 171 #define OFFSET_OF_DATA_IN_COMMAND_COMPLETE 5 172 173 // ACL Packet 174 #define READ_ACL_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff) 175 #define READ_SCO_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff) 176 #define READ_ACL_FLAGS( buffer ) ( buffer[1] >> 4 ) 177 #define READ_ACL_LENGTH( buffer ) (little_endian_read_16(buffer, 2)) 178 179 // Sneak peak into L2CAP Packet 180 #define READ_L2CAP_LENGTH(buffer) ( little_endian_read_16(buffer, 4)) 181 #define READ_L2CAP_CHANNEL_ID(buffer) ( little_endian_read_16(buffer, 6)) 182 183 /** 184 * LE connection parameter update state 185 */ 186 187 typedef enum { 188 CON_PARAMETER_UPDATE_NONE, 189 // L2CAP 190 CON_PARAMETER_UPDATE_SEND_REQUEST, 191 CON_PARAMETER_UPDATE_SEND_RESPONSE, 192 CON_PARAMETER_UPDATE_CHANGE_HCI_CON_PARAMETERS, 193 CON_PARAMETER_UPDATE_DENY, 194 // HCI - in respnose to HCI_SUBEVENT_LE_REMOTE_CONNECTION_PARAMETER_REQUEST 195 CON_PARAMETER_UPDATE_REPLY, 196 CON_PARAMETER_UPDATE_NEGATIVE_REPLY, 197 } le_con_parameter_update_state_t; 198 199 // Authentication flags 200 typedef enum { 201 AUTH_FLAG_NONE = 0x0000, 202 AUTH_FLAG_HANDLE_LINK_KEY_REQUEST = 0x0001, 203 AUTH_FLAG_DENY_PIN_CODE_REQUEST = 0x0002, 204 AUTH_FLAG_RECV_IO_CAPABILITIES_REQUEST = 0x0004, 205 AUTH_FLAG_RECV_IO_CAPABILITIES_RESPONSE = 0x0008, 206 AUTH_FLAG_SEND_IO_CAPABILITIES_REPLY = 0x0010, 207 AUTH_FLAG_SEND_IO_CAPABILITIES_NEGATIVE_REPLY = 0x0020, 208 AUTH_FLAG_SEND_USER_CONFIRM_REPLY = 0x0040, 209 AUTH_FLAG_SEND_USER_CONFIRM_NEGATIVE_REPLY = 0x0080, 210 AUTH_FLAG_SEND_USER_PASSKEY_REPLY = 0x0100, 211 212 // Classic OOB 213 AUTH_FLAG_SEND_REMOTE_OOB_DATA_REPLY = 0x0200, 214 215 // pairing status 216 AUTH_FLAG_LEGACY_PAIRING_ACTIVE = 0x0400, 217 AUTH_FLAG_SSP_PAIRING_ACTIVE = 0x0800, 218 AUTH_FLAG_PAIRING_ACTIVE_MASK = (AUTH_FLAG_LEGACY_PAIRING_ACTIVE | AUTH_FLAG_SSP_PAIRING_ACTIVE), 219 220 // connection status 221 AUTH_FLAG_CONNECTION_AUTHENTICATED = 0x1000, 222 AUTH_FLAG_CONNECTION_ENCRYPTED = 0x2000, 223 224 // errands 225 AUTH_FLAG_READ_RSSI = 0x4000, 226 AUTH_FLAG_WRITE_SUPERVISION_TIMEOUT = 0x8000, 227 228 } hci_authentication_flags_t; 229 230 /** 231 * Connection State 232 */ 233 typedef enum { 234 SEND_CREATE_CONNECTION = 0, 235 SENT_CREATE_CONNECTION, 236 SEND_CANCEL_CONNECTION, 237 SENT_CANCEL_CONNECTION, 238 RECEIVED_CONNECTION_REQUEST, 239 ACCEPTED_CONNECTION_REQUEST, 240 REJECTED_CONNECTION_REQUEST, 241 OPEN, 242 SEND_DISCONNECT, 243 SENT_DISCONNECT, 244 RECEIVED_DISCONNECTION_COMPLETE 245 } CONNECTION_STATE; 246 247 // bonding flags 248 enum { 249 // remote features 250 BONDING_REMOTE_FEATURES_QUERY_ACTIVE = 0x0001, 251 BONDING_REQUEST_REMOTE_FEATURES_PAGE_0 = 0x0002, 252 BONDING_REQUEST_REMOTE_FEATURES_PAGE_1 = 0x0004, 253 BONDING_REQUEST_REMOTE_FEATURES_PAGE_2 = 0x0008, 254 BONDING_RECEIVED_REMOTE_FEATURES = 0x0010, 255 BONDING_REMOTE_SUPPORTS_SSP_CONTROLLER = 0x0020, 256 BONDING_REMOTE_SUPPORTS_SSP_HOST = 0x0040, 257 BONDING_REMOTE_SUPPORTS_SC_CONTROLLER = 0x0080, 258 BONDING_REMOTE_SUPPORTS_SC_HOST = 0x0100, 259 // other 260 BONDING_DISCONNECT_SECURITY_BLOCK = 0x0200, 261 BONDING_DISCONNECT_DEDICATED_DONE = 0x0400, 262 BONDING_SEND_AUTHENTICATE_REQUEST = 0x0800, 263 BONDING_SENT_AUTHENTICATE_REQUEST = 0x1000, 264 BONDING_SEND_ENCRYPTION_REQUEST = 0x2000, 265 BONDING_SEND_READ_ENCRYPTION_KEY_SIZE = 0x4000, 266 BONDING_DEDICATED = 0x8000, 267 BONDING_EMIT_COMPLETE_ON_DISCONNECT = 0x10000, 268 }; 269 270 typedef enum { 271 BLUETOOTH_OFF = 1, 272 BLUETOOTH_ON, 273 BLUETOOTH_ACTIVE 274 } BLUETOOTH_STATE; 275 276 typedef enum { 277 LE_CONNECTING_IDLE, 278 LE_CONNECTING_CANCEL, 279 LE_CONNECTING_DIRECT, 280 LE_CONNECTING_WHITELIST, 281 } le_connecting_state_t; 282 283 #ifdef ENABLE_BLE 284 285 // 286 // SM internal types and globals 287 // 288 289 typedef enum { 290 291 // general states 292 SM_GENERAL_IDLE, 293 SM_GENERAL_SEND_PAIRING_FAILED, 294 SM_GENERAL_TIMEOUT, // no other security messages are exchanged 295 SM_GENERAL_REENCRYPTION_FAILED, 296 297 // Phase 1: Pairing Feature Exchange 298 SM_PH1_W4_USER_RESPONSE, 299 300 // Phase 2: Authenticating and Encrypting 301 302 // get random number for use as TK Passkey if we show it 303 SM_PH2_GET_RANDOM_TK, 304 SM_PH2_W4_RANDOM_TK, 305 306 // get local random number for confirm c1 307 SM_PH2_C1_GET_RANDOM_A, 308 SM_PH2_C1_W4_RANDOM_A, 309 SM_PH2_C1_GET_RANDOM_B, 310 SM_PH2_C1_W4_RANDOM_B, 311 312 // calculate confirm value for local side 313 SM_PH2_C1_GET_ENC_A, 314 SM_PH2_C1_W4_ENC_A, 315 316 // calculate confirm value for remote side 317 SM_PH2_C1_GET_ENC_C, 318 SM_PH2_C1_W4_ENC_C, 319 320 SM_PH2_C1_SEND_PAIRING_CONFIRM, 321 SM_PH2_SEND_PAIRING_RANDOM, 322 323 // calc STK 324 SM_PH2_CALC_STK, 325 SM_PH2_W4_STK, 326 327 SM_PH2_W4_CONNECTION_ENCRYPTED, 328 329 // Phase 3: Transport Specific Key Distribution 330 // calculate DHK, Y, EDIV, and LTK 331 SM_PH3_Y_GET_ENC, 332 SM_PH3_Y_W4_ENC, 333 SM_PH3_LTK_GET_ENC, 334 335 // exchange keys 336 SM_PH3_DISTRIBUTE_KEYS, 337 SM_PH3_RECEIVE_KEYS, 338 339 // Phase 4: re-establish previously distributed LTK 340 SM_PH4_W4_CONNECTION_ENCRYPTED, 341 342 // RESPONDER ROLE 343 SM_RESPONDER_IDLE, 344 SM_RESPONDER_SEND_SECURITY_REQUEST, 345 SM_RESPONDER_PH0_RECEIVED_LTK_REQUEST, 346 SM_RESPONDER_PH0_RECEIVED_LTK_W4_IRK, 347 SM_RESPONDER_PH0_SEND_LTK_REQUESTED_NEGATIVE_REPLY, 348 SM_RESPONDER_PH1_W4_PAIRING_REQUEST, 349 SM_RESPONDER_PH1_PAIRING_REQUEST_RECEIVED, 350 SM_RESPONDER_PH1_PAIRING_REQUEST_RECEIVED_W4_IRK, 351 SM_RESPONDER_PH1_SEND_PAIRING_RESPONSE, 352 SM_RESPONDER_PH1_W4_PAIRING_CONFIRM, 353 SM_RESPONDER_PH2_W4_PAIRING_RANDOM, 354 SM_RESPONDER_PH2_W4_LTK_REQUEST, 355 SM_RESPONDER_PH2_SEND_LTK_REPLY, 356 SM_RESPONDER_PH4_Y_W4_ENC, 357 SM_RESPONDER_PH4_SEND_LTK_REPLY, 358 359 // INITIATOR ROLE 360 SM_INITIATOR_CONNECTED, 361 SM_INITIATOR_PH1_W2_SEND_PAIRING_REQUEST, 362 SM_INITIATOR_PH1_W4_PAIRING_RESPONSE, 363 SM_INITIATOR_PH2_W4_PAIRING_CONFIRM, 364 SM_INITIATOR_PH2_W4_PAIRING_RANDOM, 365 SM_INITIATOR_PH3_SEND_START_ENCRYPTION, 366 SM_INITIATOR_PH4_HAS_LTK, 367 368 // LE Secure Connections 369 SM_SC_RECEIVED_LTK_REQUEST, 370 SM_SC_SEND_PUBLIC_KEY_COMMAND, 371 SM_SC_W4_PUBLIC_KEY_COMMAND, 372 SM_SC_W4_LOCAL_NONCE, 373 SM_SC_W2_CMAC_FOR_CONFIRMATION, 374 SM_SC_W4_CMAC_FOR_CONFIRMATION, 375 SM_SC_SEND_CONFIRMATION, 376 SM_SC_W2_CMAC_FOR_CHECK_CONFIRMATION, 377 SM_SC_W4_CMAC_FOR_CHECK_CONFIRMATION, 378 SM_SC_W4_CONFIRMATION, 379 SM_SC_SEND_PAIRING_RANDOM, 380 SM_SC_W4_PAIRING_RANDOM, 381 SM_SC_W2_CALCULATE_G2, 382 SM_SC_W4_CALCULATE_G2, 383 SM_SC_W4_CALCULATE_DHKEY, 384 SM_SC_W2_CALCULATE_F5_SALT, 385 SM_SC_W4_CALCULATE_F5_SALT, 386 SM_SC_W2_CALCULATE_F5_MACKEY, 387 SM_SC_W4_CALCULATE_F5_MACKEY, 388 SM_SC_W2_CALCULATE_F5_LTK, 389 SM_SC_W4_CALCULATE_F5_LTK, 390 SM_SC_W2_CALCULATE_F6_FOR_DHKEY_CHECK, 391 SM_SC_W4_CALCULATE_F6_FOR_DHKEY_CHECK, 392 SM_SC_W2_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK, 393 SM_SC_W4_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK, 394 SM_SC_W4_USER_RESPONSE, 395 SM_SC_SEND_DHKEY_CHECK_COMMAND, 396 SM_SC_W4_DHKEY_CHECK_COMMAND, 397 SM_SC_W4_LTK_REQUEST_SC, 398 SM_SC_W2_CALCULATE_ILK_USING_H6, 399 SM_SC_W2_CALCULATE_ILK_USING_H7, 400 SM_SC_W4_CALCULATE_ILK, 401 SM_SC_W2_CALCULATE_BR_EDR_LINK_KEY, 402 SM_SC_W4_CALCULATE_BR_EDR_LINK_KEY, 403 404 // Classic 405 SM_BR_EDR_W4_ENCRYPTION_COMPLETE, 406 SM_BR_EDR_INITIATOR_SEND_PAIRING_REQUEST, 407 SM_BR_EDR_INITIATOR_W4_PAIRING_RESPONSE, 408 SM_BR_EDR_RESPONDER_W4_PAIRING_REQUEST, 409 SM_BR_EDR_RESPONDER_PAIRING_REQUEST_RECEIVED, 410 SM_BR_EDR_DISTRIBUTE_KEYS, 411 SM_BR_EDR_RECEIVE_KEYS, 412 SM_BR_EDR_W2_CALCULATE_ILK_USING_H6, 413 SM_BR_EDR_W2_CALCULATE_ILK_USING_H7, 414 SM_BR_EDR_W4_CALCULATE_ILK, 415 SM_BR_EDR_W2_CALCULATE_LE_LTK, 416 SM_BR_EDR_W4_CALCULATE_LE_LTK, 417 } security_manager_state_t; 418 419 typedef enum { 420 IRK_LOOKUP_IDLE, 421 IRK_LOOKUP_W4_READY, 422 IRK_LOOKUP_STARTED, 423 IRK_LOOKUP_SUCCEEDED, 424 IRK_LOOKUP_FAILED 425 } irk_lookup_state_t; 426 427 typedef uint8_t sm_pairing_packet_t[7]; 428 429 // connection info available as long as connection exists 430 typedef struct sm_connection { 431 hci_con_handle_t sm_handle; 432 uint16_t sm_cid; 433 uint8_t sm_role; // 0 - IamMaster, 1 = IamSlave 434 uint8_t sm_security_request_received; 435 uint8_t sm_pairing_requested; 436 uint8_t sm_peer_addr_type; 437 bd_addr_t sm_peer_address; 438 uint8_t sm_own_addr_type; 439 bd_addr_t sm_own_address; 440 security_manager_state_t sm_engine_state; 441 irk_lookup_state_t sm_irk_lookup_state; 442 uint8_t sm_pairing_failed_reason; 443 uint8_t sm_connection_encrypted; 444 uint8_t sm_connection_authenticated; // [0..1] 445 uint8_t sm_connection_sc; 446 uint8_t sm_actual_encryption_key_size; 447 sm_pairing_packet_t sm_m_preq; // only used during c1 448 authorization_state_t sm_connection_authorization_state; 449 uint16_t sm_local_ediv; 450 uint8_t sm_local_rand[8]; 451 int sm_le_db_index; 452 bool sm_pairing_active; 453 bool sm_reencryption_active; 454 } sm_connection_t; 455 456 // 457 // ATT Server 458 // 459 460 // max ATT request matches L2CAP PDU -- allow to use smaller buffer 461 #ifndef ATT_REQUEST_BUFFER_SIZE 462 #define ATT_REQUEST_BUFFER_SIZE HCI_ACL_PAYLOAD_SIZE 463 #endif 464 465 typedef enum { 466 ATT_SERVER_IDLE, 467 ATT_SERVER_REQUEST_RECEIVED, 468 ATT_SERVER_W4_SIGNED_WRITE_VALIDATION, 469 ATT_SERVER_REQUEST_RECEIVED_AND_VALIDATED, 470 ATT_SERVER_RESPONSE_PENDING, 471 } att_server_state_t; 472 473 typedef struct { 474 att_server_state_t state; 475 476 uint8_t peer_addr_type; 477 bd_addr_t peer_address; 478 479 int ir_le_device_db_index; 480 uint8_t ir_lookup_active; 481 uint8_t pairing_active; 482 483 int value_indication_handle; 484 btstack_timer_source_t value_indication_timer; 485 486 btstack_linked_list_t notification_requests; 487 btstack_linked_list_t indication_requests; 488 489 #ifdef ENABLE_GATT_OVER_CLASSIC 490 uint16_t l2cap_cid; 491 #endif 492 493 uint16_t request_size; 494 uint8_t request_buffer[ATT_REQUEST_BUFFER_SIZE]; 495 496 } att_server_t; 497 498 #endif 499 500 typedef enum { 501 L2CAP_INFORMATION_STATE_IDLE = 0, 502 L2CAP_INFORMATION_STATE_W2_SEND_EXTENDED_FEATURE_REQUEST, 503 L2CAP_INFORMATION_STATE_W4_EXTENDED_FEATURE_RESPONSE, 504 L2CAP_INFORMATION_STATE_W2_SEND_FIXED_CHANNELS_REQUEST, 505 L2CAP_INFORMATION_STATE_W4_FIXED_CHANNELS_RESPONSE, 506 L2CAP_INFORMATION_STATE_DONE 507 } l2cap_information_state_t; 508 509 typedef struct { 510 l2cap_information_state_t information_state; 511 uint16_t extended_feature_mask; 512 uint16_t fixed_channels_supported; // Core V5.3 - only first octet used 513 } l2cap_state_t; 514 515 // 516 typedef struct { 517 // linked list - assert: first field 518 btstack_linked_item_t item; 519 520 // remote side 521 bd_addr_t address; 522 523 // module handle 524 hci_con_handle_t con_handle; 525 526 // le public, le random, classic 527 bd_addr_type_t address_type; 528 529 // role: 0 - master, 1 - slave 530 uint8_t role; 531 532 // connection state 533 CONNECTION_STATE state; 534 535 // bonding 536 uint32_t bonding_flags; 537 uint8_t bonding_status; 538 539 // encryption key size (in octets) 540 uint8_t encryption_key_size; 541 542 // requested security level 543 gap_security_level_t requested_security_level; 544 545 // link key and its type 546 link_key_t link_key; 547 link_key_type_t link_key_type; 548 549 // remote supported features 550 /* bit 0 - eSCO */ 551 /* bit 1 - extended features */ 552 uint8_t remote_supported_features[1]; 553 554 #ifdef ENABLE_CLASSIC 555 // IO Capabilities Response 556 uint8_t io_cap_response_auth_req; 557 uint8_t io_cap_response_io; 558 #ifdef ENABLE_CLASSIC_PAIRING_OOB 559 uint8_t io_cap_response_oob_data; 560 #endif 561 562 // connection mode, default ACL_CONNECTION_MODE_ACTIVE 563 uint8_t connection_mode; 564 565 // enter/exit sniff mode requests 566 uint16_t sniff_min_interval; // 0: idle, 0xffff exit sniff, else enter sniff 567 uint16_t sniff_max_interval; 568 uint16_t sniff_attempt; 569 uint16_t sniff_timeout; 570 571 // sniff subrating 572 uint16_t sniff_subrating_max_latency; // 0xffff = not set 573 uint16_t sniff_subrating_min_remote_timeout; 574 uint16_t sniff_subrating_min_local_timeout; 575 576 // QoS 577 hci_service_type_t qos_service_type; 578 uint32_t qos_token_rate; 579 uint32_t qos_peak_bandwidth; 580 uint32_t qos_latency; 581 uint32_t qos_delay_variation; 582 583 #ifdef ENABLE_SCO_OVER_HCI 584 // track SCO rx event 585 uint32_t sco_rx_ms; 586 uint8_t sco_rx_count; 587 uint8_t sco_rx_valid; 588 #endif 589 // generate sco can send now based on received packets, using timeout below 590 uint8_t sco_tx_ready; 591 592 // request role switch 593 hci_role_t request_role; 594 595 btstack_timer_source_t timeout_sco; 596 #endif /* ENABLE_CLASSIC */ 597 598 // authentication and other errands 599 uint32_t authentication_flags; 600 601 btstack_timer_source_t timeout; 602 603 // timeout in system ticks (HAVE_EMBEDDED_TICK) or milliseconds (HAVE_EMBEDDED_TIME_MS) 604 uint32_t timestamp; 605 606 // ACL packet recombination - PRE_BUFFER + ACL Header + ACL payload 607 uint8_t acl_recombination_buffer[HCI_INCOMING_PRE_BUFFER_SIZE + 4 + HCI_ACL_BUFFER_SIZE]; 608 uint16_t acl_recombination_pos; 609 uint16_t acl_recombination_length; 610 611 612 // number packets sent to controller 613 uint8_t num_packets_sent; 614 615 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 616 uint8_t num_packets_completed; 617 #endif 618 619 // LE Connection parameter update 620 le_con_parameter_update_state_t le_con_parameter_update_state; 621 uint8_t le_con_param_update_identifier; 622 uint16_t le_conn_interval_min; 623 uint16_t le_conn_interval_max; 624 uint16_t le_conn_latency; 625 uint16_t le_supervision_timeout; 626 627 #ifdef ENABLE_BLE 628 uint16_t le_connection_interval; 629 630 // LE PHY Update via set phy command 631 uint8_t le_phy_update_all_phys; // 0xff for idle 632 uint8_t le_phy_update_tx_phys; 633 uint8_t le_phy_update_rx_phys; 634 int8_t le_phy_update_phy_options; 635 636 // LE Security Manager 637 sm_connection_t sm_connection; 638 639 #ifdef ENABLE_LE_LIMIT_ACL_FRAGMENT_BY_MAX_OCTETS 640 uint16_t le_max_tx_octets; 641 #endif 642 643 // ATT Connection 644 att_connection_t att_connection; 645 646 // ATT Server 647 att_server_t att_server; 648 649 #endif 650 651 l2cap_state_t l2cap_state; 652 653 #ifdef ENABLE_CLASSIC_PAIRING_OOB 654 const uint8_t * classic_oob_c_192; 655 const uint8_t * classic_oob_r_192; 656 const uint8_t * classic_oob_c_256; 657 const uint8_t * classic_oob_r_256; 658 #endif 659 660 } hci_connection_t; 661 662 663 /** 664 * HCI Inititizlization State Machine 665 */ 666 typedef enum hci_init_state{ 667 HCI_INIT_SEND_RESET = 0, 668 HCI_INIT_W4_SEND_RESET, 669 HCI_INIT_SEND_READ_LOCAL_VERSION_INFORMATION, 670 HCI_INIT_W4_SEND_READ_LOCAL_VERSION_INFORMATION, 671 672 #ifndef HAVE_HOST_CONTROLLER_API 673 HCI_INIT_SEND_READ_LOCAL_NAME, 674 HCI_INIT_W4_SEND_READ_LOCAL_NAME, 675 HCI_INIT_SEND_BAUD_CHANGE, 676 HCI_INIT_W4_SEND_BAUD_CHANGE, 677 HCI_INIT_CUSTOM_INIT, 678 HCI_INIT_W4_CUSTOM_INIT, 679 HCI_INIT_SEND_RESET_CSR_WARM_BOOT, 680 HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT, 681 HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT_LINK_RESET, 682 HCI_INIT_W4_CUSTOM_INIT_BCM_DELAY, 683 #endif 684 685 HCI_INIT_READ_LOCAL_SUPPORTED_COMMANDS, 686 HCI_INIT_W4_READ_LOCAL_SUPPORTED_COMMANDS, 687 688 HCI_INIT_SEND_BAUD_CHANGE_BCM, 689 HCI_INIT_W4_SEND_BAUD_CHANGE_BCM, 690 691 HCI_INIT_SET_BD_ADDR, 692 HCI_INIT_W4_SET_BD_ADDR, 693 694 HCI_INIT_SEND_RESET_ST_WARM_BOOT, 695 HCI_INIT_W4_SEND_RESET_ST_WARM_BOOT, 696 697 HCI_INIT_READ_BD_ADDR, 698 HCI_INIT_W4_READ_BD_ADDR, 699 700 HCI_INIT_READ_BUFFER_SIZE, 701 HCI_INIT_W4_READ_BUFFER_SIZE, 702 HCI_INIT_READ_LOCAL_SUPPORTED_FEATURES, 703 HCI_INIT_W4_READ_LOCAL_SUPPORTED_FEATURES, 704 705 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 706 HCI_INIT_HOST_BUFFER_SIZE, 707 HCI_INIT_W4_HOST_BUFFER_SIZE, 708 HCI_INIT_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, 709 HCI_INIT_W4_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, 710 #endif 711 712 HCI_INIT_SET_EVENT_MASK, 713 HCI_INIT_W4_SET_EVENT_MASK, 714 715 #ifdef ENABLE_CLASSIC 716 HCI_INIT_WRITE_SIMPLE_PAIRING_MODE, 717 HCI_INIT_W4_WRITE_SIMPLE_PAIRING_MODE, 718 HCI_INIT_WRITE_INQUIRY_MODE, 719 HCI_INIT_W4_WRITE_INQUIRY_MODE, 720 HCI_INIT_WRITE_SECURE_CONNECTIONS_HOST_ENABLE, 721 HCI_INIT_W4_WRITE_SECURE_CONNECTIONS_HOST_ENABLE, 722 723 #ifdef ENABLE_SCO_OVER_HCI 724 // SCO over HCI 725 HCI_INIT_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 726 HCI_INIT_W4_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 727 HCI_INIT_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 728 HCI_INIT_W4_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 729 #endif 730 731 #if defined(ENABLE_SCO_OVER_HCI) || defined(ENABLE_SCO_OVER_PCM) 732 // Broadcom SCO Routing and Configuration 733 HCI_INIT_BCM_WRITE_SCO_PCM_INT, 734 HCI_INIT_W4_BCM_WRITE_SCO_PCM_INT, 735 #endif 736 #ifdef ENABLE_SCO_OVER_PCM 737 HCI_INIT_BCM_WRITE_I2SPCM_INTERFACE_PARAM, 738 HCI_INIT_W4_BCM_WRITE_I2SPCM_INTERFACE_PARAM, 739 #endif 740 #endif 741 742 #ifdef ENABLE_BLE 743 HCI_INIT_LE_READ_BUFFER_SIZE, 744 HCI_INIT_W4_LE_READ_BUFFER_SIZE, 745 HCI_INIT_WRITE_LE_HOST_SUPPORTED, 746 HCI_INIT_W4_WRITE_LE_HOST_SUPPORTED, 747 HCI_INIT_LE_SET_EVENT_MASK, 748 HCI_INIT_W4_LE_SET_EVENT_MASK, 749 #endif 750 751 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION 752 HCI_INIT_LE_READ_MAX_DATA_LENGTH, 753 HCI_INIT_W4_LE_READ_MAX_DATA_LENGTH, 754 HCI_INIT_LE_WRITE_SUGGESTED_DATA_LENGTH, 755 HCI_INIT_W4_LE_WRITE_SUGGESTED_DATA_LENGTH, 756 #endif 757 758 #ifdef ENABLE_LE_CENTRAL 759 HCI_INIT_READ_WHITE_LIST_SIZE, 760 HCI_INIT_W4_READ_WHITE_LIST_SIZE, 761 762 HCI_INIT_LE_SET_SCAN_PARAMETERS, 763 HCI_INIT_W4_LE_SET_SCAN_PARAMETERS, 764 #endif 765 766 HCI_INIT_DONE, 767 768 HCI_FALLING_ASLEEP_DISCONNECT, 769 HCI_FALLING_ASLEEP_W4_WRITE_SCAN_ENABLE, 770 HCI_FALLING_ASLEEP_COMPLETE, 771 772 HCI_INIT_AFTER_SLEEP, 773 774 HCI_HALTING_DISCONNECT_ALL_NO_TIMER, 775 HCI_HALTING_DISCONNECT_ALL_TIMER, 776 HCI_HALTING_W4_TIMER, 777 HCI_HALTING_CLOSE, 778 779 } hci_substate_t; 780 781 #define GAP_TASK_SET_LOCAL_NAME 0x01 782 #define GAP_TASK_SET_EIR_DATA 0x02 783 #define GAP_TASK_SET_CLASS_OF_DEVICE 0x04 784 #define GAP_TASK_SET_DEFAULT_LINK_POLICY 0x08 785 #define GAP_TASK_WRITE_SCAN_ENABLE 0x10 786 #define GAP_TASK_WRITE_PAGE_SCAN_ACTIVITY 0x20 787 #define GAP_TASK_WRITE_PAGE_SCAN_TYPE 0x40 788 #define GAP_TASK_WRITE_PAGE_TIMEOUT 0x80 789 #define GAP_TASK_WRITE_INQUIRY_SCAN_ACTIVITY 0x100 790 791 enum { 792 // Tasks 793 LE_ADVERTISEMENT_TASKS_SET_ADV_DATA = 1 << 0, 794 LE_ADVERTISEMENT_TASKS_SET_SCAN_DATA = 1 << 1, 795 LE_ADVERTISEMENT_TASKS_SET_PARAMS = 1 << 2, 796 LE_ADVERTISEMENT_TASKS_SET_ADDRESS = 1 << 3, 797 // State 798 LE_ADVERTISEMENT_TASKS_PARAMS_SET = 1 << 7, 799 }; 800 801 enum { 802 LE_WHITELIST_ON_CONTROLLER = 1 << 0, 803 LE_WHITELIST_ADD_TO_CONTROLLER = 1 << 1, 804 LE_WHITELIST_REMOVE_FROM_CONTROLLER = 1 << 2, 805 }; 806 807 typedef struct { 808 btstack_linked_item_t item; 809 bd_addr_t address; 810 bd_addr_type_t address_type; 811 uint8_t state; 812 } whitelist_entry_t; 813 814 #define MAX_NUM_RESOLVING_LIST_ENTRIES 64 815 typedef enum { 816 LE_RESOLVING_LIST_SEND_ENABLE_ADDRESS_RESOLUTION, 817 LE_RESOLVING_LIST_READ_SIZE, 818 LE_RESOLVING_LIST_SEND_CLEAR, 819 LE_RESOLVING_LIST_REMOVE_ENTRIES, 820 LE_RESOLVING_LIST_ADD_ENTRIES, 821 LE_RESOLVING_LIST_DONE 822 } le_resolving_list_state_t; 823 824 /** 825 * main data structure 826 */ 827 typedef struct { 828 // transport component with configuration 829 const hci_transport_t * hci_transport; 830 const void * config; 831 832 // chipset driver 833 const btstack_chipset_t * chipset; 834 835 // hardware power controller 836 const btstack_control_t * control; 837 838 #ifdef ENABLE_CLASSIC 839 /* link key db */ 840 const btstack_link_key_db_t * link_key_db; 841 #endif 842 843 // list of existing baseband connections 844 btstack_linked_list_t connections; 845 846 /* callback to L2CAP layer */ 847 btstack_packet_handler_t acl_packet_handler; 848 849 /* callback for SCO data */ 850 btstack_packet_handler_t sco_packet_handler; 851 852 /* callbacks for events */ 853 btstack_linked_list_t event_handlers; 854 855 #ifdef ENABLE_CLASSIC 856 /* callback for reject classic connection */ 857 int (*gap_classic_accept_callback)(bd_addr_t addr, hci_link_type_t link_type); 858 #endif 859 860 // hardware error callback 861 void (*hardware_error_callback)(uint8_t error); 862 863 // basic configuration 864 const char * local_name; 865 const uint8_t * eir_data; 866 uint32_t class_of_device; 867 bd_addr_t local_bd_addr; 868 uint8_t default_link_policy_settings; 869 uint8_t allow_role_switch; 870 uint8_t ssp_enable; 871 uint8_t ssp_io_capability; 872 uint8_t ssp_authentication_requirement; 873 uint8_t ssp_auto_accept; 874 bool secure_connections_enable; 875 bool secure_connections_active; 876 inquiry_mode_t inquiry_mode; 877 878 #ifdef ENABLE_CLASSIC 879 /* GAP tasks, see GAP_TASK_* */ 880 uint16_t gap_tasks; 881 882 /* write page scan activity */ 883 uint16_t new_page_scan_interval; 884 uint16_t new_page_scan_window; 885 886 /* write page scan type */ 887 uint8_t new_page_scan_type; 888 889 /* write page timeout */ 890 uint16_t page_timeout; 891 892 // Errata-11838 mandates 7 bytes for GAP Security Level 1-3, we use 16 as default 893 uint8_t gap_required_encyrption_key_size; 894 uint16_t link_supervision_timeout; 895 gap_security_level_t gap_security_level; 896 gap_security_level_t gap_minimal_service_security_level; 897 gap_security_mode_t gap_security_mode; 898 899 uint32_t inquiry_lap; // GAP_IAC_GENERAL_INQUIRY or GAP_IAC_LIMITED_INQUIRY 900 uint16_t inquiry_scan_interval; 901 uint16_t inquiry_scan_window; 902 903 bool gap_secure_connections_only_mode; 904 #endif 905 906 // single buffer for HCI packet assembly + additional prebuffer for H4 drivers 907 uint8_t * hci_packet_buffer; 908 uint8_t hci_packet_buffer_data[HCI_OUTGOING_PRE_BUFFER_SIZE + HCI_OUTGOING_PACKET_BUFFER_SIZE]; 909 bool hci_packet_buffer_reserved; 910 uint16_t acl_fragmentation_pos; 911 uint16_t acl_fragmentation_total_size; 912 uint8_t acl_fragmentation_tx_active; 913 914 /* host to controller flow control */ 915 uint8_t num_cmd_packets; 916 uint8_t acl_packets_total_num; 917 uint16_t acl_data_packet_length; 918 uint8_t sco_packets_total_num; 919 uint8_t sco_data_packet_length; 920 uint8_t synchronous_flow_control_enabled; 921 uint8_t le_acl_packets_total_num; 922 uint16_t le_data_packets_length; 923 uint8_t sco_waiting_for_can_send_now; 924 bool sco_can_send_now; 925 926 /* local supported features */ 927 uint8_t local_supported_features[8]; 928 929 /* local supported commands summary - complete info is 64 bytes */ 930 /* 0 - Read Buffer Size (Octet 14/bit 7) */ 931 /* 1 - Write Le Host Supported (Octet 24/bit 6) */ 932 /* 2 - Write Synchronous Flow Control Enable (Octet 10/bit 4) */ 933 /* 3 - Write Default Erroneous Data Reporting (Octet 18/bit 3) */ 934 /* 4 - LE Write Suggested Default Data Length (Octet 34/bit 0) */ 935 /* 5 - LE Read Maximum Data Length (Octet 35/bit 3) */ 936 /* 6 - LE Set Default PHY (Octet 35/bit 5) */ 937 /* 7 - Read Encryption Key Size (Octet 20/bit 4) */ 938 /* 8 - Read Remote Extended Features (Octet 2/bit 5) */ 939 /* 9 - Write Secure Connections Host (Octet 32/bit 3) */ 940 /* 10 - LE Set Address Resolution Enable (Octet 35/bit 1) */ 941 /* 11 - Remote OOB Extended Data Request Reply (Octet 32/bit 1) */ 942 /* 12 - Read Local OOB Extended Data command (Octet 32/bit 6) */ 943 uint8_t local_supported_commands[2]; 944 945 /* bluetooth device information from hci read local version information */ 946 // uint16_t hci_version; 947 // uint16_t hci_revision; 948 // uint16_t lmp_version; 949 uint16_t manufacturer; 950 // uint16_t lmp_subversion; 951 952 // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE 953 uint16_t packet_types; 954 955 956 /* hci state machine */ 957 HCI_STATE state; 958 hci_substate_t substate; 959 btstack_timer_source_t timeout; 960 btstack_chipset_result_t chipset_result; 961 962 uint16_t last_cmd_opcode; 963 964 uint8_t cmds_ready; 965 966 /* buffer for scan enable cmd - 0xff no change */ 967 uint8_t new_scan_enable_value; 968 969 uint8_t discoverable; 970 uint8_t connectable; 971 uint8_t bondable; 972 973 uint8_t inquiry_state; // see hci.c for state defines 974 975 bd_addr_t remote_name_addr; 976 uint16_t remote_name_clock_offset; 977 uint8_t remote_name_page_scan_repetition_mode; 978 uint8_t remote_name_state; // see hci.c for state defines 979 980 bd_addr_t gap_pairing_addr; 981 uint8_t gap_pairing_state; // see hci.c for state defines 982 uint8_t gap_pairing_pin_len; 983 union { 984 const uint8_t * gap_pairing_pin; 985 uint32_t gap_pairing_passkey; 986 } gap_pairing_input; 987 988 uint16_t sco_voice_setting; 989 uint16_t sco_voice_setting_active; 990 991 uint8_t loopback_mode; 992 993 // buffer for single connection decline 994 uint8_t decline_reason; 995 bd_addr_t decline_addr; 996 997 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 998 uint8_t host_completed_packets; 999 #endif 1000 1001 #ifdef ENABLE_BLE 1002 uint8_t le_own_addr_type; 1003 bd_addr_t le_random_address; 1004 uint8_t le_random_address_set; 1005 1006 // LE Whitelist Management 1007 uint8_t le_whitelist_capacity; 1008 btstack_linked_list_t le_whitelist; 1009 #endif 1010 1011 #ifdef ENABLE_LE_CENTRAL 1012 bool le_scanning_enabled; 1013 bool le_scanning_active; 1014 1015 le_connecting_state_t le_connecting_state; 1016 le_connecting_state_t le_connecting_request; 1017 1018 bool le_scanning_param_update; 1019 uint8_t le_scan_type; 1020 uint8_t le_scan_filter_policy; 1021 uint16_t le_scan_interval; 1022 uint16_t le_scan_window; 1023 1024 // Connection parameters 1025 uint16_t le_connection_interval_min; 1026 uint16_t le_connection_interval_max; 1027 uint16_t le_connection_latency; 1028 uint16_t le_supervision_timeout; 1029 uint16_t le_minimum_ce_length; 1030 uint16_t le_maximum_ce_length; 1031 uint16_t le_connection_scan_interval; 1032 uint16_t le_connection_scan_window; 1033 uint8_t le_connection_own_addr_type; 1034 bd_addr_t le_connection_own_address; 1035 #endif 1036 1037 le_connection_parameter_range_t le_connection_parameter_range; 1038 1039 #ifdef ENABLE_LE_PERIPHERAL 1040 uint8_t * le_advertisements_data; 1041 uint8_t le_advertisements_data_len; 1042 1043 uint8_t * le_scan_response_data; 1044 uint8_t le_scan_response_data_len; 1045 1046 bool le_advertisements_active; 1047 bool le_advertisements_enabled; 1048 bool le_advertisements_enabled_for_current_roles; 1049 uint8_t le_advertisements_todo; 1050 1051 uint16_t le_advertisements_interval_min; 1052 uint16_t le_advertisements_interval_max; 1053 uint8_t le_advertisements_type; 1054 uint8_t le_advertisements_direct_address_type; 1055 uint8_t le_advertisements_channel_map; 1056 uint8_t le_advertisements_filter_policy; 1057 bd_addr_t le_advertisements_direct_address; 1058 uint8_t le_advertisements_own_addr_type; 1059 bd_addr_t le_advertisements_own_address; 1060 1061 uint8_t le_max_number_peripheral_connections; 1062 #endif 1063 1064 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION 1065 // LE Data Length 1066 uint16_t le_supported_max_tx_octets; 1067 uint16_t le_supported_max_tx_time; 1068 #endif 1069 1070 // custom BD ADDR 1071 bd_addr_t custom_bd_addr; 1072 uint8_t custom_bd_addr_set; 1073 1074 #ifdef ENABLE_CLASSIC 1075 uint8_t master_slave_policy; 1076 #endif 1077 1078 // address and address_type of active create connection command (ACL, SCO, LE) 1079 bd_addr_t outgoing_addr; 1080 bd_addr_type_t outgoing_addr_type; 1081 1082 // LE Resolving List 1083 #ifdef ENABLE_LE_PRIVACY_ADDRESS_RESOLUTION 1084 le_resolving_list_state_t le_resolving_list_state; 1085 uint16_t le_resolving_list_size; 1086 uint8_t le_resolving_list_add_entries[(MAX_NUM_RESOLVING_LIST_ENTRIES + 7) / 8]; 1087 uint8_t le_resolving_list_remove_entries[(MAX_NUM_RESOLVING_LIST_ENTRIES + 7) / 8]; 1088 #endif 1089 1090 #ifdef ENABLE_CLASSIC_PAIRING_OOB 1091 bool classic_read_local_oob_data; 1092 hci_con_handle_t classic_oob_con_handle; 1093 #endif 1094 1095 #ifdef HAVE_SCO_TRANSPORT 1096 const btstack_sco_transport_t * sco_transport; 1097 #endif 1098 } hci_stack_t; 1099 1100 1101 /* API_START */ 1102 1103 1104 // HCI init and configuration 1105 1106 1107 /** 1108 * @brief Set up HCI. Needs to be called before any other function. 1109 */ 1110 void hci_init(const hci_transport_t *transport, const void *config); 1111 1112 /** 1113 * @brief Configure Bluetooth chipset driver. Has to be called before power on, or right after receiving the local version information. 1114 */ 1115 void hci_set_chipset(const btstack_chipset_t *chipset_driver); 1116 1117 /** 1118 * @brief Configure Bluetooth hardware control. Has to be called before power on. 1119 * @[aram hardware_control implementation 1120 */ 1121 void hci_set_control(const btstack_control_t *hardware_control); 1122 1123 #ifdef HAVE_SCO_TRANSPORT 1124 /** 1125 * @brief Set SCO Transport implementation for SCO over PCM mode 1126 * @param sco_transport that sends SCO over I2S or PCM interface 1127 */ 1128 void hci_set_sco_transport(const btstack_sco_transport_t *sco_transport); 1129 #endif 1130 1131 #ifdef ENABLE_CLASSIC 1132 /** 1133 * @brief Configure Bluetooth hardware control. Has to be called before power on. 1134 */ 1135 void hci_set_link_key_db(btstack_link_key_db_t const * link_key_db); 1136 #endif 1137 1138 /** 1139 * @brief Set callback for Bluetooth Hardware Error 1140 */ 1141 void hci_set_hardware_error_callback(void (*fn)(uint8_t error)); 1142 1143 /** 1144 * @brief Set Public BD ADDR - passed on to Bluetooth chipset during init if supported in bt_control_h 1145 */ 1146 void hci_set_bd_addr(bd_addr_t addr); 1147 1148 /** 1149 * @brief Configure Voice Setting for use with SCO data in HSP/HFP 1150 */ 1151 void hci_set_sco_voice_setting(uint16_t voice_setting); 1152 1153 /** 1154 * @brief Get SCO Voice Setting 1155 * @return current voice setting 1156 */ 1157 uint16_t hci_get_sco_voice_setting(void); 1158 1159 /** 1160 * @brief Set inquiry mode: standard, with RSSI, with RSSI + Extended Inquiry Results. Has to be called before power on. 1161 * @param inquriy_mode see bluetooth_defines.h 1162 */ 1163 void hci_set_inquiry_mode(inquiry_mode_t inquriy_mode); 1164 1165 /** 1166 * @brief Requests the change of BTstack power mode. 1167 * @param power_mode 1168 * @return 0 if success, otherwise error 1169 */ 1170 int hci_power_control(HCI_POWER_MODE power_mode); 1171 1172 /** 1173 * @brief Shutdown HCI 1174 */ 1175 void hci_close(void); 1176 1177 1178 // Callback registration 1179 1180 1181 /** 1182 * @brief Add event packet handler. 1183 */ 1184 void hci_add_event_handler(btstack_packet_callback_registration_t * callback_handler); 1185 1186 /** 1187 * @brief Remove event packet handler. 1188 */ 1189 void hci_remove_event_handler(btstack_packet_callback_registration_t * callback_handler); 1190 1191 /** 1192 * @brief Registers a packet handler for ACL data. Used by L2CAP 1193 */ 1194 void hci_register_acl_packet_handler(btstack_packet_handler_t handler); 1195 1196 /** 1197 * @brief Registers a packet handler for SCO data. Used for HSP and HFP profiles. 1198 */ 1199 void hci_register_sco_packet_handler(btstack_packet_handler_t handler); 1200 1201 1202 // Sending HCI Commands 1203 1204 /** 1205 * @brief Check if CMD packet can be sent to controller 1206 * @return true if command can be sent 1207 */ 1208 bool hci_can_send_command_packet_now(void); 1209 1210 /** 1211 * @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. 1212 * @return status 1213 */ 1214 uint8_t hci_send_cmd(const hci_cmd_t * cmd, ...); 1215 1216 1217 // Sending SCO Packets 1218 1219 /** @brief Get SCO packet length for current SCO Voice setting 1220 * @note Using SCO packets of the exact length is required for USB transfer 1221 * @return Length of SCO packets in bytes (not audio frames) incl. 3 byte header 1222 */ 1223 uint16_t hci_get_sco_packet_length(void); 1224 1225 /** 1226 * @brief Request emission of HCI_EVENT_SCO_CAN_SEND_NOW as soon as possible 1227 * @note HCI_EVENT_SCO_CAN_SEND_NOW might be emitted during call to this function 1228 * so packet handler should be ready to handle it 1229 */ 1230 void hci_request_sco_can_send_now_event(void); 1231 1232 /** 1233 * @brief Check HCI packet buffer and if SCO packet can be sent to controller 1234 * @return true if sco packet can be sent 1235 */ 1236 bool hci_can_send_sco_packet_now(void); 1237 1238 /** 1239 * @brief Check if SCO packet can be sent to controller 1240 * @return true if sco packet can be sent 1241 */ 1242 bool hci_can_send_prepared_sco_packet_now(void); 1243 1244 /** 1245 * @brief Send SCO packet prepared in HCI packet buffer 1246 */ 1247 uint8_t hci_send_sco_packet_buffer(int size); 1248 1249 /** 1250 * Reserves outgoing packet buffer. 1251 * @return true on success 1252 */ 1253 bool hci_reserve_packet_buffer(void); 1254 1255 /** 1256 * Get pointer for outgoing packet buffer 1257 */ 1258 uint8_t* hci_get_outgoing_packet_buffer(void); 1259 1260 /** 1261 * Release outgoing packet buffer\ 1262 * @note only called instead of hci_send_preparared 1263 */ 1264 void hci_release_packet_buffer(void); 1265 1266 /** 1267 * @brief Sets the master/slave policy 1268 * @param policy (0: attempt to become master, 1: let connecting device decide) 1269 */ 1270 void hci_set_master_slave_policy(uint8_t policy); 1271 1272 /* API_END */ 1273 1274 1275 /** 1276 * va_list version of hci_send_cmd, call hci_send_cmd_packet 1277 * @return status 1278 */ 1279 uint8_t hci_send_cmd_va_arg(const hci_cmd_t * cmd, va_list argptr); 1280 1281 /** 1282 * Get connection iterator. Only used by l2cap.c and sm.c 1283 */ 1284 void hci_connections_get_iterator(btstack_linked_list_iterator_t *it); 1285 1286 /** 1287 * Get internal hci_connection_t for given handle. Used by L2CAP, SM, daemon 1288 */ 1289 hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle); 1290 1291 /** 1292 * Get internal hci_connection_t for given Bluetooth addres. Called by L2CAP 1293 */ 1294 hci_connection_t * hci_connection_for_bd_addr_and_type(const bd_addr_t addr, bd_addr_type_t addr_type); 1295 1296 /** 1297 * Check if outgoing packet buffer is reserved. Used for internal checks in l2cap.c 1298 * @return true if packet buffer is reserved 1299 */ 1300 bool hci_is_packet_buffer_reserved(void); 1301 1302 /** 1303 * Check hci packet buffer is free and a classic acl packet can be sent to controller 1304 * @return true if ACL Classic packet can be sent now 1305 */ 1306 bool hci_can_send_acl_classic_packet_now(void); 1307 1308 /** 1309 * Check hci packet buffer is free and an LE acl packet can be sent to controller 1310 * @return true if ACL LE packet can be sent now 1311 */ 1312 bool hci_can_send_acl_le_packet_now(void); 1313 1314 /** 1315 * Check hci packet buffer is free and an acl packet for the given handle can be sent to controller 1316 * @return true if ACL packet for con_handle can be sent now 1317 */ 1318 bool hci_can_send_acl_packet_now(hci_con_handle_t con_handle); 1319 1320 /** 1321 * Check if acl packet for the given handle can be sent to controller 1322 * @return true if ACL packet for con_handle can be sent now 1323 */ 1324 bool hci_can_send_prepared_acl_packet_now(hci_con_handle_t con_handle); 1325 1326 /** 1327 * Send acl packet prepared in hci packet buffer 1328 * @return status 1329 */ 1330 uint8_t hci_send_acl_packet_buffer(int size); 1331 1332 /** 1333 * Check if authentication is active. It delays automatic disconnect while no L2CAP connection 1334 * Called by l2cap. 1335 */ 1336 bool hci_authentication_active_for_handle(hci_con_handle_t handle); 1337 1338 /** 1339 * Get maximal ACL Classic data packet length based on used buffer size. Called by L2CAP 1340 */ 1341 uint16_t hci_max_acl_data_packet_length(void); 1342 1343 /** 1344 * Get supported packet types. Called by L2CAP 1345 */ 1346 uint16_t hci_usable_acl_packet_types(void); 1347 1348 /** 1349 * Check if ACL packets marked as non flushable can be sent. Called by L2CAP 1350 */ 1351 bool hci_non_flushable_packet_boundary_flag_supported(void); 1352 1353 /** 1354 * Check if remote supported features query has completed 1355 */ 1356 bool hci_remote_features_available(hci_con_handle_t con_handle); 1357 1358 /** 1359 * Trigger remote supported features query 1360 */ 1361 void hci_remote_features_query(hci_con_handle_t con_handle); 1362 1363 /** 1364 * Check if extended SCO Link is supported 1365 */ 1366 bool hci_extended_sco_link_supported(void); 1367 1368 /** 1369 * Check if SSP is supported on both sides. Called by L2CAP 1370 */ 1371 bool gap_ssp_supported_on_both_sides(hci_con_handle_t handle); 1372 1373 /** 1374 * Disconn because of security block. Called by L2CAP 1375 */ 1376 void hci_disconnect_security_block(hci_con_handle_t con_handle); 1377 1378 /** 1379 * Query if remote side supports eSCO 1380 */ 1381 bool hci_remote_esco_supported(hci_con_handle_t con_handle); 1382 1383 /** 1384 * Emit current HCI state. Called by daemon 1385 */ 1386 void hci_emit_state(void); 1387 1388 /** 1389 * Send complete CMD packet. Called by daemon and hci_send_cmd_va_arg 1390 * @return status 1391 */ 1392 uint8_t hci_send_cmd_packet(uint8_t *packet, int size); 1393 1394 /** 1395 * Disconnect all HCI connections. Called by daemon 1396 */ 1397 void hci_disconnect_all(void); 1398 1399 /** 1400 * Get number of free acl slots for packets of given handle. Called by daemon 1401 */ 1402 int hci_number_free_acl_slots_for_handle(hci_con_handle_t con_handle); 1403 1404 /** 1405 * @brief Set Advertisement Parameters 1406 * @param adv_int_min 1407 * @param adv_int_max 1408 * @param adv_type 1409 * @param direct_address_type 1410 * @param direct_address 1411 * @param channel_map 1412 * @param filter_policy 1413 * 1414 * @note internal use. use gap_advertisements_set_params from gap.h instead. 1415 */ 1416 void hci_le_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 1417 uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy); 1418 1419 /** 1420 * 1421 * @note internal use. use gap_random_address_set_mode from gap.h instead. 1422 */ 1423 void hci_le_set_own_address_type(uint8_t own_address_type); 1424 1425 /** 1426 * @naote internal use. use gap_random_address_set from gap.h instead 1427 */ 1428 void hci_le_random_address_set(const bd_addr_t random_address); 1429 1430 /** 1431 * @note internal use by sm 1432 */ 1433 void hci_load_le_device_db_entry_into_resolving_list(uint16_t le_device_db_index); 1434 1435 /** 1436 * @note internal use by sm 1437 */ 1438 void hci_remove_le_device_db_entry_from_resolving_list(uint16_t le_device_db_index); 1439 1440 /** 1441 * @note internal use 1442 */ 1443 uint16_t hci_number_free_acl_slots_for_connection_type(bd_addr_type_t address_type); 1444 1445 /** 1446 * @brief Get Manufactured 1447 * @return manufacturer id 1448 */ 1449 uint16_t hci_get_manufacturer(void); 1450 1451 /** 1452 * Defer halt. Used by btstack_crypto to allow current HCI operation to complete 1453 */ 1454 void hci_halting_defer(void); 1455 1456 // Only for PTS testing 1457 1458 /** 1459 * Disable automatic L2CAP disconnect if no L2CAP connection is established 1460 */ 1461 void hci_disable_l2cap_timeout_check(void); 1462 1463 /** 1464 * Get Classic Allow Role Switch param 1465 */ 1466 uint8_t hci_get_allow_role_switch(void); 1467 1468 /** 1469 * Get state 1470 */ 1471 HCI_STATE hci_get_state(void); 1472 1473 /** 1474 * @brief De-Init HCI 1475 */ 1476 void hci_deinit(void); 1477 1478 // setup test connections, used for fuzzing 1479 void hci_setup_test_connections_fuzz(void); 1480 1481 // free all connections, used for fuzzing 1482 void hci_free_connections_fuzz(void); 1483 1484 // simulate stack bootup 1485 void hci_simulate_working_fuzz(void); 1486 1487 1488 #if defined __cplusplus 1489 } 1490 #endif 1491 1492 #endif // HCI_H 1493