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