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