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