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