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