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