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