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