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