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