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