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