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