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