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