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