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 BLUEKITCHEN 24 * GMBH 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_bool.h" 49 #include "btstack_chipset.h" 50 #include "btstack_control.h" 51 #include "btstack_linked_list.h" 52 #include "btstack_util.h" 53 #include "hci_cmd.h" 54 #include "gap.h" 55 #include "hci_transport.h" 56 #include "btstack_run_loop.h" 57 58 #ifdef ENABLE_CLASSIC 59 #include "classic/btstack_link_key_db.h" 60 #endif 61 62 #ifdef ENABLE_BLE 63 #include "ble/att_db.h" 64 #endif 65 66 #ifdef HAVE_SCO_TRANSPORT 67 #include "btstack_sco_transport.h" 68 #endif 69 70 #include <stdint.h> 71 #include <stdlib.h> 72 #include <stdarg.h> 73 74 #if defined __cplusplus 75 extern "C" { 76 #endif 77 78 // packet buffer sizes 79 #define HCI_CMD_HEADER_SIZE 3 80 #define HCI_ACL_HEADER_SIZE 4 81 #define HCI_SCO_HEADER_SIZE 3 82 #define HCI_EVENT_HEADER_SIZE 2 83 #define HCI_ISO_HEADER_SIZE 4 84 85 #define HCI_EVENT_PAYLOAD_SIZE 255 86 #define HCI_CMD_PAYLOAD_SIZE 255 87 88 // default for ISO streams: 48_6_2 : 2 x 155 89 #ifndef HCI_ISO_PAYLOAD_SIZE 90 #define HCI_ISO_PAYLOAD_SIZE 310 91 #endif 92 93 // Max HCI Command LE payload size: 94 // 64 from LE Generate DHKey command 95 // 32 from LE Encrypt command 96 #if defined(ENABLE_LE_SECURE_CONNECTIONS) && !defined(ENABLE_MICRO_ECC_FOR_LE_SECURE_CONNECTIONS) 97 #define HCI_CMD_PAYLOAD_SIZE_LE 64 98 #else 99 #define HCI_CMD_PAYLOAD_SIZE_LE 32 100 #endif 101 102 // HCI_ACL_PAYLOAD_SIZE is configurable and defined in config.h 103 // addition byte in even to terminate remote name request with '\0' 104 #define HCI_EVENT_BUFFER_SIZE (HCI_EVENT_HEADER_SIZE + HCI_EVENT_PAYLOAD_SIZE + 1) 105 106 #ifdef ENABLE_CLASSIC 107 #define HCI_CMD_BUFFER_SIZE (HCI_CMD_HEADER_SIZE + HCI_CMD_PAYLOAD_SIZE) 108 #else 109 #define HCI_CMD_BUFFER_SIZE (HCI_CMD_HEADER_SIZE + HCI_CMD_PAYLOAD_SIZE_LE) 110 #endif 111 112 #define HCI_ACL_BUFFER_SIZE (HCI_ACL_HEADER_SIZE + HCI_ACL_PAYLOAD_SIZE) 113 114 // size of hci incoming buffer, big enough for event or acl packet without H4 packet type 115 #ifdef HCI_INCOMING_PACKET_BUFFER_SIZE 116 #if HCI_INCOMING_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE 117 #error HCI_INCOMING_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE 118 #endif 119 #if HCI_INCOMING_PACKET_BUFFER_SIZE < HCI_EVENT_BUFFER_SIZE 120 #error HCI_INCOMING_PACKET_BUFFER_SIZE must be equal or larger than HCI_EVENT_BUFFER_SIZE 121 #endif 122 #else 123 #if HCI_ACL_BUFFER_SIZE > HCI_EVENT_BUFFER_SIZE 124 #define HCI_INCOMING_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE 125 #else 126 #define HCI_INCOMING_PACKET_BUFFER_SIZE HCI_EVENT_BUFFER_SIZE 127 #endif 128 #endif 129 130 // size of hci outgoing buffer, big enough for command or acl packet without H4 packet type 131 #ifdef HCI_OUTGOING_PACKET_BUFFER_SIZE 132 #if HCI_OUTGOING_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE 133 #error HCI_OUTGOING_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE 134 #endif 135 #if HCI_OUTGOING_PACKET_BUFFER_SIZE < HCI_CMD_BUFFER_SIZE 136 #error HCI_OUTGOING_PACKET_BUFFER_SIZE must be equal or larger than HCI_CMD_BUFFER_SIZE 137 #endif 138 #else 139 #if HCI_ACL_BUFFER_SIZE > HCI_CMD_BUFFER_SIZE 140 #define HCI_OUTGOING_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE 141 #else 142 #define HCI_OUTGOING_PACKET_BUFFER_SIZE HCI_CMD_BUFFER_SIZE 143 #endif 144 #endif 145 146 // additional pre-buffer space for packets to Bluetooth module 147 // - H4 requires 1 byte for the packet type 148 // - h5 requires 4 bytes for H5 header 149 #ifndef HCI_OUTGOING_PRE_BUFFER_SIZE 150 #ifdef HAVE_HOST_CONTROLLER_API 151 #define HCI_OUTGOING_PRE_BUFFER_SIZE 0 152 #else 153 #ifdef ENABLE_H5 154 #define HCI_OUTGOING_PRE_BUFFER_SIZE 4 155 #else 156 #define HCI_OUTGOING_PRE_BUFFER_SIZE 1 157 #endif 158 #endif 159 #endif 160 161 // BNEP may uncompress the IP Header by 16 bytes, GATT Client requires two additional bytes for long characteristic reads 162 #ifndef HCI_INCOMING_PRE_BUFFER_SIZE 163 #ifdef ENABLE_CLASSIC 164 #define HCI_INCOMING_PRE_BUFFER_SIZE (16 - HCI_ACL_HEADER_SIZE - 4) 165 #else 166 #define HCI_INCOMING_PRE_BUFFER_SIZE 2 167 #endif 168 #endif 169 170 // 171 #define IS_COMMAND(packet, command) ( little_endian_read_16(packet,0) == command.opcode ) 172 173 // check if command complete event for given command 174 #define HCI_EVENT_IS_COMMAND_COMPLETE(event,cmd) ( (event[0] == HCI_EVENT_COMMAND_COMPLETE) && (little_endian_read_16(event,3) == cmd.opcode) ) 175 #define HCI_EVENT_IS_COMMAND_STATUS(event,cmd) ( (event[0] == HCI_EVENT_COMMAND_STATUS) && (little_endian_read_16(event,4) == cmd.opcode) ) 176 177 // Code+Len=2, Pkts+Opcode=3; total=5 178 #define OFFSET_OF_DATA_IN_COMMAND_COMPLETE 5 179 180 // ACL Packet 181 #define READ_ACL_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff) 182 #define READ_SCO_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff) 183 #define READ_ISO_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff) 184 #define READ_ACL_FLAGS( buffer ) ( buffer[1] >> 4 ) 185 #define READ_ACL_LENGTH( buffer ) (little_endian_read_16(buffer, 2)) 186 187 // Sneak peak into L2CAP Packet 188 #define READ_L2CAP_LENGTH(buffer) ( little_endian_read_16(buffer, 4)) 189 #define READ_L2CAP_CHANNEL_ID(buffer) ( little_endian_read_16(buffer, 6)) 190 191 /** 192 * LE connection parameter update state 193 */ 194 195 typedef enum { 196 CON_PARAMETER_UPDATE_NONE, 197 // L2CAP 198 CON_PARAMETER_UPDATE_SEND_REQUEST, 199 CON_PARAMETER_UPDATE_SEND_RESPONSE, 200 CON_PARAMETER_UPDATE_CHANGE_HCI_CON_PARAMETERS, 201 CON_PARAMETER_UPDATE_DENY, 202 // HCI - in respnose to HCI_SUBEVENT_LE_REMOTE_CONNECTION_PARAMETER_REQUEST 203 CON_PARAMETER_UPDATE_REPLY, 204 CON_PARAMETER_UPDATE_NEGATIVE_REPLY, 205 } le_con_parameter_update_state_t; 206 207 // Authentication flags 208 typedef enum { 209 AUTH_FLAG_NONE = 0x0000, 210 AUTH_FLAG_HANDLE_LINK_KEY_REQUEST = 0x0001, 211 AUTH_FLAG_DENY_PIN_CODE_REQUEST = 0x0002, 212 AUTH_FLAG_RECV_IO_CAPABILITIES_REQUEST = 0x0004, 213 AUTH_FLAG_RECV_IO_CAPABILITIES_RESPONSE = 0x0008, 214 AUTH_FLAG_SEND_IO_CAPABILITIES_REPLY = 0x0010, 215 AUTH_FLAG_SEND_IO_CAPABILITIES_NEGATIVE_REPLY = 0x0020, 216 AUTH_FLAG_SEND_USER_CONFIRM_REPLY = 0x0040, 217 AUTH_FLAG_SEND_USER_CONFIRM_NEGATIVE_REPLY = 0x0080, 218 AUTH_FLAG_SEND_USER_PASSKEY_REPLY = 0x0100, 219 220 // Classic OOB 221 AUTH_FLAG_SEND_REMOTE_OOB_DATA_REPLY = 0x0200, 222 223 // pairing status 224 AUTH_FLAG_LEGACY_PAIRING_ACTIVE = 0x0400, 225 AUTH_FLAG_SSP_PAIRING_ACTIVE = 0x0800, 226 AUTH_FLAG_PAIRING_ACTIVE_MASK = (AUTH_FLAG_LEGACY_PAIRING_ACTIVE | AUTH_FLAG_SSP_PAIRING_ACTIVE), 227 228 // connection status 229 AUTH_FLAG_CONNECTION_AUTHENTICATED = 0x1000, 230 AUTH_FLAG_CONNECTION_ENCRYPTED = 0x2000, 231 232 } hci_authentication_flags_t; 233 234 // GAP Connection Tasks 235 #define GAP_CONNECTION_TASK_WRITE_AUTOMATIC_FLUSH_TIMEOUT 0x0001u 236 #define GAP_CONNECTION_TASK_WRITE_SUPERVISION_TIMEOUT 0x0002u 237 #define GAP_CONNECTION_TASK_READ_RSSI 0x0004u 238 #define GAP_CONNECTION_TASK_LE_READ_REMOTE_FEATURES 0x0008u 239 240 /** 241 * Connection State 242 */ 243 typedef enum { 244 SEND_CREATE_CONNECTION = 0, 245 SENT_CREATE_CONNECTION, 246 RECEIVED_CONNECTION_REQUEST, 247 ACCEPTED_CONNECTION_REQUEST, 248 OPEN, 249 SEND_DISCONNECT, 250 SENT_DISCONNECT, 251 RECEIVED_DISCONNECTION_COMPLETE, 252 ANNOUNCED // connection handle announced in advertisement set terminated event 253 } CONNECTION_STATE; 254 255 // bonding flags 256 enum { 257 // remote features 258 BONDING_REMOTE_FEATURES_QUERY_ACTIVE = 0x0001, 259 BONDING_REQUEST_REMOTE_FEATURES_PAGE_0 = 0x0002, 260 BONDING_REQUEST_REMOTE_FEATURES_PAGE_1 = 0x0004, 261 BONDING_REQUEST_REMOTE_FEATURES_PAGE_2 = 0x0008, 262 BONDING_RECEIVED_REMOTE_FEATURES = 0x0010, 263 BONDING_REMOTE_SUPPORTS_SSP_CONTROLLER = 0x0020, 264 BONDING_REMOTE_SUPPORTS_SSP_HOST = 0x0040, 265 BONDING_REMOTE_SUPPORTS_SC_CONTROLLER = 0x0080, 266 BONDING_REMOTE_SUPPORTS_SC_HOST = 0x0100, 267 // other 268 BONDING_DISCONNECT_SECURITY_BLOCK = 0x0200, 269 BONDING_DISCONNECT_DEDICATED_DONE = 0x0400, 270 BONDING_SEND_AUTHENTICATE_REQUEST = 0x0800, 271 BONDING_SENT_AUTHENTICATE_REQUEST = 0x1000, 272 BONDING_SEND_ENCRYPTION_REQUEST = 0x2000, 273 BONDING_SEND_READ_ENCRYPTION_KEY_SIZE = 0x4000, 274 BONDING_DEDICATED = 0x8000, 275 BONDING_DEDICATED_DEFER_DISCONNECT = 0x10000, 276 BONDING_EMIT_COMPLETE_ON_DISCONNECT = 0x20000, 277 }; 278 279 typedef enum { 280 BLUETOOTH_OFF = 1, 281 BLUETOOTH_ON, 282 BLUETOOTH_ACTIVE 283 } BLUETOOTH_STATE; 284 285 typedef enum { 286 LE_CONNECTING_IDLE, 287 LE_CONNECTING_CANCEL, 288 LE_CONNECTING_DIRECT, 289 LE_CONNECTING_WHITELIST, 290 } le_connecting_state_t; 291 292 typedef enum { 293 ATT_BEARER_UNENHANCED_LE, 294 ATT_BEARER_UNENHANCED_CLASSIC, 295 ATT_BEARER_ENHANCED_LE, 296 ATT_BEARER_ENHANCED_CLASSIC 297 } att_bearer_type_t; 298 299 #ifdef ENABLE_BLE 300 301 // 302 // SM internal types and globals 303 // 304 305 typedef enum { 306 307 // general states 308 SM_GENERAL_IDLE, 309 SM_GENERAL_SEND_PAIRING_FAILED, 310 SM_GENERAL_TIMEOUT, // no other security messages are exchanged 311 SM_GENERAL_REENCRYPTION_FAILED, 312 313 // Phase 1: Pairing Feature Exchange 314 SM_PH1_W4_USER_RESPONSE, 315 316 // Phase 2: Authenticating and Encrypting 317 318 // get random number for use as TK Passkey if we show it 319 SM_PH2_GET_RANDOM_TK, 320 SM_PH2_W4_RANDOM_TK, 321 322 // get local random number for confirm c1 323 SM_PH2_C1_GET_RANDOM_A, 324 SM_PH2_C1_W4_RANDOM_A, 325 SM_PH2_C1_GET_RANDOM_B, 326 SM_PH2_C1_W4_RANDOM_B, 327 328 // calculate confirm value for local side 329 SM_PH2_C1_GET_ENC_A, 330 SM_PH2_C1_W4_ENC_A, 331 332 // calculate confirm value for remote side 333 SM_PH2_C1_GET_ENC_C, 334 SM_PH2_C1_W4_ENC_C, 335 336 SM_PH2_C1_SEND_PAIRING_CONFIRM, 337 SM_PH2_SEND_PAIRING_RANDOM, 338 339 // calc STK 340 SM_PH2_CALC_STK, 341 SM_PH2_W4_STK, 342 343 SM_PH2_W4_CONNECTION_ENCRYPTED, 344 345 // Phase 3: Transport Specific Key Distribution 346 // calculate DHK, Y, EDIV, and LTK 347 SM_PH3_Y_GET_ENC, 348 SM_PH3_Y_W4_ENC, 349 SM_PH3_LTK_GET_ENC, 350 351 // exchange keys 352 SM_PH3_DISTRIBUTE_KEYS, 353 SM_PH3_RECEIVE_KEYS, 354 355 // Phase 4: re-establish previously distributed LTK 356 SM_PH4_W4_CONNECTION_ENCRYPTED, 357 358 // RESPONDER ROLE 359 SM_RESPONDER_IDLE, 360 SM_RESPONDER_SEND_SECURITY_REQUEST, 361 SM_RESPONDER_PH0_RECEIVED_LTK_REQUEST, 362 SM_RESPONDER_PH0_RECEIVED_LTK_W4_IRK, 363 SM_RESPONDER_PH0_SEND_LTK_REQUESTED_NEGATIVE_REPLY, 364 SM_RESPONDER_PH1_W4_PAIRING_REQUEST, 365 SM_RESPONDER_PH1_PAIRING_REQUEST_RECEIVED, 366 SM_RESPONDER_PH1_PAIRING_REQUEST_RECEIVED_W4_IRK, 367 SM_RESPONDER_PH1_SEND_PAIRING_RESPONSE, 368 SM_RESPONDER_PH1_W4_PAIRING_CONFIRM, 369 SM_RESPONDER_PH2_W4_PAIRING_RANDOM, 370 SM_RESPONDER_PH2_W4_LTK_REQUEST, 371 SM_RESPONDER_PH2_SEND_LTK_REPLY, 372 SM_RESPONDER_PH4_Y_W4_ENC, 373 SM_RESPONDER_PH4_SEND_LTK_REPLY, 374 375 // INITIATOR ROLE 376 SM_INITIATOR_CONNECTED, 377 SM_INITIATOR_PH1_W2_SEND_PAIRING_REQUEST, 378 SM_INITIATOR_PH1_W4_PAIRING_RESPONSE, 379 SM_INITIATOR_PH2_W4_PAIRING_CONFIRM, 380 SM_INITIATOR_PH2_W4_PAIRING_RANDOM, 381 SM_INITIATOR_PH3_SEND_START_ENCRYPTION, 382 SM_INITIATOR_PH4_HAS_LTK, 383 384 // LE Secure Connections 385 SM_SC_RECEIVED_LTK_REQUEST, 386 SM_SC_SEND_PUBLIC_KEY_COMMAND, 387 SM_SC_W4_PUBLIC_KEY_COMMAND, 388 SM_SC_W4_LOCAL_NONCE, 389 SM_SC_W2_CMAC_FOR_CONFIRMATION, 390 SM_SC_W4_CMAC_FOR_CONFIRMATION, 391 SM_SC_SEND_CONFIRMATION, 392 SM_SC_W2_CMAC_FOR_CHECK_CONFIRMATION, 393 SM_SC_W4_CMAC_FOR_CHECK_CONFIRMATION, 394 SM_SC_W4_CONFIRMATION, 395 SM_SC_SEND_PAIRING_RANDOM, 396 SM_SC_W4_PAIRING_RANDOM, 397 SM_SC_W2_CALCULATE_G2, 398 SM_SC_W4_CALCULATE_G2, 399 SM_SC_W4_CALCULATE_DHKEY, 400 SM_SC_W2_CALCULATE_F5_SALT, 401 SM_SC_W4_CALCULATE_F5_SALT, 402 SM_SC_W2_CALCULATE_F5_MACKEY, 403 SM_SC_W4_CALCULATE_F5_MACKEY, 404 SM_SC_W2_CALCULATE_F5_LTK, 405 SM_SC_W4_CALCULATE_F5_LTK, 406 SM_SC_W2_CALCULATE_F6_FOR_DHKEY_CHECK, 407 SM_SC_W4_CALCULATE_F6_FOR_DHKEY_CHECK, 408 SM_SC_W2_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK, 409 SM_SC_W4_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK, 410 SM_SC_W4_USER_RESPONSE, 411 SM_SC_SEND_DHKEY_CHECK_COMMAND, 412 SM_SC_W4_DHKEY_CHECK_COMMAND, 413 SM_SC_W4_LTK_REQUEST_SC, 414 SM_SC_W2_CALCULATE_ILK_USING_H6, 415 SM_SC_W2_CALCULATE_ILK_USING_H7, 416 SM_SC_W4_CALCULATE_ILK, 417 SM_SC_W2_CALCULATE_BR_EDR_LINK_KEY, 418 SM_SC_W4_CALCULATE_BR_EDR_LINK_KEY, 419 420 // Classic 421 SM_BR_EDR_W4_ENCRYPTION_COMPLETE, 422 SM_BR_EDR_INITIATOR_W4_FIXED_CHANNEL_MASK, 423 SM_BR_EDR_INITIATOR_SEND_PAIRING_REQUEST, 424 SM_BR_EDR_INITIATOR_W4_PAIRING_RESPONSE, 425 SM_BR_EDR_RESPONDER_W4_PAIRING_REQUEST, 426 SM_BR_EDR_RESPONDER_PAIRING_REQUEST_RECEIVED, 427 SM_BR_EDR_DISTRIBUTE_KEYS, 428 SM_BR_EDR_RECEIVE_KEYS, 429 SM_BR_EDR_W2_CALCULATE_ILK_USING_H6, 430 SM_BR_EDR_W2_CALCULATE_ILK_USING_H7, 431 SM_BR_EDR_W4_CALCULATE_ILK, 432 SM_BR_EDR_W2_CALCULATE_LE_LTK, 433 SM_BR_EDR_W4_CALCULATE_LE_LTK, 434 } security_manager_state_t; 435 436 typedef enum { 437 IRK_LOOKUP_IDLE, 438 IRK_LOOKUP_W4_READY, 439 IRK_LOOKUP_STARTED, 440 IRK_LOOKUP_SUCCEEDED, 441 IRK_LOOKUP_FAILED 442 } irk_lookup_state_t; 443 444 typedef uint8_t sm_pairing_packet_t[7]; 445 446 // connection info available as long as connection exists 447 typedef struct sm_connection { 448 hci_con_handle_t sm_handle; 449 uint16_t sm_cid; 450 uint8_t sm_role; // 0 - IamMaster, 1 = IamSlave 451 bool sm_security_request_received; 452 bool sm_pairing_requested; 453 uint8_t sm_peer_addr_type; 454 bd_addr_t sm_peer_address; 455 uint8_t sm_own_addr_type; 456 bd_addr_t sm_own_address; 457 security_manager_state_t sm_engine_state; 458 irk_lookup_state_t sm_irk_lookup_state; 459 uint8_t sm_pairing_failed_reason; 460 uint8_t sm_connection_encrypted; // [0..2] 461 uint8_t sm_connection_authenticated; // [0..1] 462 bool sm_connection_sc; 463 uint8_t sm_actual_encryption_key_size; 464 sm_pairing_packet_t sm_m_preq; // only used during c1 465 authorization_state_t sm_connection_authorization_state; 466 uint16_t sm_local_ediv; 467 uint8_t sm_local_rand[8]; 468 int sm_le_db_index; 469 bool sm_pairing_active; 470 bool sm_reencryption_active; 471 } sm_connection_t; 472 473 // 474 // ATT Server 475 // 476 477 // max ATT request matches L2CAP PDU -- allow to use smaller buffer 478 #ifndef ATT_REQUEST_BUFFER_SIZE 479 #define ATT_REQUEST_BUFFER_SIZE HCI_ACL_PAYLOAD_SIZE 480 #endif 481 482 typedef enum { 483 ATT_SERVER_IDLE, 484 ATT_SERVER_REQUEST_RECEIVED, 485 ATT_SERVER_W4_SIGNED_WRITE_VALIDATION, 486 ATT_SERVER_REQUEST_RECEIVED_AND_VALIDATED, 487 ATT_SERVER_RESPONSE_PENDING, 488 } att_server_state_t; 489 490 typedef struct { 491 att_server_state_t state; 492 493 uint8_t peer_addr_type; 494 bd_addr_t peer_address; 495 496 att_bearer_type_t bearer_type; 497 498 int ir_le_device_db_index; 499 bool ir_lookup_active; 500 bool pairing_active; 501 502 uint16_t value_indication_handle; 503 btstack_timer_source_t value_indication_timer; 504 505 btstack_linked_list_t notification_requests; 506 btstack_linked_list_t indication_requests; 507 508 #if defined(ENABLE_GATT_OVER_CLASSIC) || defined(ENABLE_GATT_OVER_EATT) 509 // unified (client + server) att bearer 510 uint16_t l2cap_cid; 511 bool send_requests[2]; 512 bool outgoing_connection_active; 513 bool incoming_connection_request; 514 bool eatt_outgoing_active; 515 #endif 516 517 uint16_t request_size; 518 uint8_t request_buffer[ATT_REQUEST_BUFFER_SIZE]; 519 520 } att_server_t; 521 522 #endif 523 524 typedef enum { 525 L2CAP_INFORMATION_STATE_IDLE = 0, 526 L2CAP_INFORMATION_STATE_W2_SEND_EXTENDED_FEATURE_REQUEST, 527 L2CAP_INFORMATION_STATE_W4_EXTENDED_FEATURE_RESPONSE, 528 L2CAP_INFORMATION_STATE_W2_SEND_FIXED_CHANNELS_REQUEST, 529 L2CAP_INFORMATION_STATE_W4_FIXED_CHANNELS_RESPONSE, 530 L2CAP_INFORMATION_STATE_DONE 531 } l2cap_information_state_t; 532 533 typedef struct { 534 l2cap_information_state_t information_state; 535 uint16_t extended_feature_mask; 536 uint16_t fixed_channels_supported; // Core V5.3 - only first octet used 537 } l2cap_state_t; 538 539 // 540 typedef struct { 541 // linked list - assert: first field 542 btstack_linked_item_t item; 543 544 // remote side 545 bd_addr_t address; 546 547 // module handle 548 hci_con_handle_t con_handle; 549 550 // le public, le random, classic 551 bd_addr_type_t address_type; 552 553 // role: 0 - master, 1 - slave 554 hci_role_t role; 555 556 // connection state 557 CONNECTION_STATE state; 558 559 // bonding 560 uint32_t bonding_flags; 561 uint8_t bonding_status; 562 563 // encryption key size (in octets) 564 uint8_t encryption_key_size; 565 566 // requested security level 567 gap_security_level_t requested_security_level; 568 569 // link key and its type for Classic connections 570 // LTK and LTK valid flag for LE connections 571 link_key_t link_key; 572 link_key_type_t link_key_type; 573 574 #ifdef ENABLE_CLASSIC 575 // remote supported SCO packets based on remote supported features mask 576 uint16_t remote_supported_sco_packets; 577 578 // remote supported features 579 /* bit 0 - eSCO */ 580 /* bit 1 - extended features */ 581 uint8_t remote_supported_features[1]; 582 583 // IO Capabilities Response 584 uint8_t io_cap_response_auth_req; 585 uint8_t io_cap_response_io; 586 #ifdef ENABLE_CLASSIC_PAIRING_OOB 587 uint8_t io_cap_response_oob_data; 588 #endif 589 590 // connection mode, default ACL_CONNECTION_MODE_ACTIVE 591 uint8_t connection_mode; 592 593 // enter/exit sniff mode requests 594 uint16_t sniff_min_interval; // 0: idle, 0xffff exit sniff, else enter sniff 595 uint16_t sniff_max_interval; 596 uint16_t sniff_attempt; 597 uint16_t sniff_timeout; 598 599 // sniff subrating 600 uint16_t sniff_subrating_max_latency; // 0xffff = not set 601 uint16_t sniff_subrating_min_remote_timeout; 602 uint16_t sniff_subrating_min_local_timeout; 603 604 // QoS 605 hci_service_type_t qos_service_type; 606 uint32_t qos_token_rate; 607 uint32_t qos_peak_bandwidth; 608 uint32_t qos_latency; 609 uint32_t qos_delay_variation; 610 611 #ifdef ENABLE_SCO_OVER_HCI 612 // track SCO rx event 613 uint32_t sco_established_ms; 614 uint8_t sco_tx_active; 615 #endif 616 // generate sco can send now based on received packets, using timeout below 617 uint8_t sco_tx_ready; 618 619 // SCO payload length 620 uint16_t sco_payload_length; 621 622 // request role switch 623 hci_role_t request_role; 624 625 btstack_timer_source_t timeout_sco; 626 #endif /* ENABLE_CLASSIC */ 627 628 // authentication and other errands 629 uint16_t authentication_flags; 630 631 // gap connection tasks, see GAP_CONNECTION_TASK_x 632 uint16_t gap_connection_tasks; 633 634 btstack_timer_source_t timeout; 635 636 // timeout in system ticks (HAVE_EMBEDDED_TICK) or milliseconds (HAVE_EMBEDDED_TIME_MS) 637 uint32_t timestamp; 638 639 // ACL packet recombination - PRE_BUFFER + ACL Header + ACL payload 640 uint8_t acl_recombination_buffer[HCI_INCOMING_PRE_BUFFER_SIZE + 4 + HCI_ACL_BUFFER_SIZE]; 641 uint16_t acl_recombination_pos; 642 uint16_t acl_recombination_length; 643 644 645 // number packets sent to controller 646 uint8_t num_packets_sent; 647 648 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 649 uint8_t num_packets_completed; 650 #endif 651 652 // LE Connection parameter update 653 le_con_parameter_update_state_t le_con_parameter_update_state; 654 uint8_t le_con_param_update_identifier; 655 uint16_t le_conn_interval_min; 656 uint16_t le_conn_interval_max; 657 uint16_t le_conn_latency; 658 uint16_t le_supervision_timeout; 659 660 #ifdef ENABLE_BLE 661 uint16_t le_connection_interval; 662 663 // LE PHY Update via set phy command 664 uint8_t le_phy_update_all_phys; // 0xff for idle 665 uint8_t le_phy_update_tx_phys; 666 uint8_t le_phy_update_rx_phys; 667 int8_t le_phy_update_phy_options; 668 669 // LE Security Manager 670 sm_connection_t sm_connection; 671 672 #ifdef ENABLE_LE_LIMIT_ACL_FRAGMENT_BY_MAX_OCTETS 673 uint16_t le_max_tx_octets; 674 #endif 675 676 // ATT Connection 677 att_connection_t att_connection; 678 679 // ATT Server 680 att_server_t att_server; 681 682 #ifdef ENABLE_LE_PERIODIC_ADVERTISING 683 hci_con_handle_t le_past_sync_handle; 684 uint8_t le_past_advertising_handle; 685 uint16_t le_past_service_data; 686 #endif 687 688 #endif 689 690 l2cap_state_t l2cap_state; 691 692 #ifdef ENABLE_CLASSIC_PAIRING_OOB 693 const uint8_t * classic_oob_c_192; 694 const uint8_t * classic_oob_r_192; 695 const uint8_t * classic_oob_c_256; 696 const uint8_t * classic_oob_r_256; 697 #endif 698 699 } hci_connection_t; 700 701 #ifdef ENABLE_LE_ISOCHRONOUS_STREAMS 702 703 704 typedef enum { 705 HCI_ISO_TYPE_INVALID = 0, 706 HCI_ISO_TYPE_BIS, 707 HCI_ISO_TYPE_CIS, 708 } hci_iso_type_t; 709 710 #define HCI_ISO_GROUP_ID_SINGLE_CIS 0xfe 711 #define HCI_ISO_GROUP_ID_INVALID 0xff 712 713 typedef enum{ 714 HCI_ISO_STREAM_STATE_IDLE, 715 HCI_ISO_STREAM_W4_USER, 716 HCI_ISO_STREAM_W2_ACCEPT, 717 HCI_ISO_STREAM_W2_REJECT, 718 HCI_ISO_STREAM_STATE_REQUESTED, 719 HCI_ISO_STREAM_STATE_W4_ESTABLISHED, 720 HCI_ISO_STREAM_STATE_ESTABLISHED, 721 HCI_ISO_STREAM_STATE_W2_SETUP_ISO_INPUT, 722 HCI_ISO_STREAM_STATE_W4_ISO_SETUP_INPUT, 723 HCI_ISO_STREAM_STATE_W2_SETUP_ISO_OUTPUT, 724 HCI_ISO_STREAM_STATE_W4_ISO_SETUP_OUTPUT, 725 HCI_ISO_STREAM_STATE_W2_CLOSE, 726 HCI_ISO_STREAM_STATE_W4_DISCONNECTED, 727 } hci_iso_stream_state_t; 728 729 typedef struct { 730 // linked list - assert: first field 731 btstack_linked_item_t item; 732 733 // state 734 hci_iso_stream_state_t state; 735 736 // iso type: bis or cis 737 hci_iso_type_t iso_type; 738 739 // group_id: big_handle or cig_id 740 uint8_t group_id; 741 742 // stream_id: bis_index or cis_id 743 uint8_t stream_id; 744 745 // only valid for HCI_ISO_TYPE_CIS 746 hci_con_handle_t cis_handle; 747 hci_con_handle_t acl_handle; 748 749 // connection info 750 uint8_t number_of_subevents; 751 uint8_t burst_number_c_to_p; 752 uint8_t burst_number_p_to_c; 753 uint8_t flush_timeout_c_to_p; 754 uint8_t flush_timeout_p_to_c; 755 uint16_t max_sdu_c_to_p; 756 uint16_t max_sdu_p_to_c; 757 uint16_t iso_interval_1250us; 758 759 // re-assembly buffer (includes ISO packet header with timestamp) 760 uint16_t reassembly_pos; 761 uint8_t reassembly_buffer[12 + HCI_ISO_PAYLOAD_SIZE]; 762 763 // number packets sent to controller 764 uint8_t num_packets_sent; 765 766 // packets to skip due to queuing them to late before 767 uint8_t num_packets_to_skip; 768 769 // request to send 770 bool can_send_now_requested; 771 772 // ready to send 773 bool emit_ready_to_send; 774 775 } hci_iso_stream_t; 776 #endif 777 778 /** 779 * HCI Initialization State Machine 780 */ 781 typedef enum hci_init_state{ 782 HCI_INIT_SEND_RESET = 0, 783 HCI_INIT_W4_SEND_RESET, 784 HCI_INIT_SEND_READ_LOCAL_VERSION_INFORMATION, 785 HCI_INIT_W4_SEND_READ_LOCAL_VERSION_INFORMATION, 786 787 #ifndef HAVE_HOST_CONTROLLER_API 788 HCI_INIT_SEND_READ_LOCAL_NAME, 789 HCI_INIT_W4_SEND_READ_LOCAL_NAME, 790 HCI_INIT_SEND_BAUD_CHANGE, 791 HCI_INIT_W4_SEND_BAUD_CHANGE, 792 HCI_INIT_CUSTOM_INIT, 793 HCI_INIT_W4_CUSTOM_INIT, 794 795 HCI_INIT_SEND_RESET_CSR_WARM_BOOT, 796 HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT, 797 HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT_LINK_RESET, 798 799 HCI_INIT_W4_CUSTOM_INIT_BCM_DELAY, 800 801 // Support for Pre-Init before HCI Reset 802 HCI_INIT_CUSTOM_PRE_INIT, 803 HCI_INIT_W4_CUSTOM_PRE_INIT, 804 #endif 805 806 HCI_INIT_READ_LOCAL_SUPPORTED_COMMANDS, 807 HCI_INIT_W4_READ_LOCAL_SUPPORTED_COMMANDS, 808 809 HCI_INIT_SEND_BAUD_CHANGE_BCM, 810 HCI_INIT_W4_SEND_BAUD_CHANGE_BCM, 811 812 HCI_INIT_SET_BD_ADDR, 813 HCI_INIT_W4_SET_BD_ADDR, 814 815 HCI_INIT_SEND_RESET_ST_WARM_BOOT, 816 HCI_INIT_W4_SEND_RESET_ST_WARM_BOOT, 817 818 HCI_INIT_READ_BD_ADDR, 819 HCI_INIT_W4_READ_BD_ADDR, 820 821 HCI_INIT_READ_BUFFER_SIZE, 822 HCI_INIT_W4_READ_BUFFER_SIZE, 823 HCI_INIT_READ_LOCAL_SUPPORTED_FEATURES, 824 HCI_INIT_W4_READ_LOCAL_SUPPORTED_FEATURES, 825 826 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 827 HCI_INIT_HOST_BUFFER_SIZE, 828 HCI_INIT_W4_HOST_BUFFER_SIZE, 829 HCI_INIT_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, 830 HCI_INIT_W4_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, 831 #endif 832 833 HCI_INIT_SET_EVENT_MASK, 834 HCI_INIT_W4_SET_EVENT_MASK, 835 HCI_INIT_SET_EVENT_MASK_2, 836 HCI_INIT_W4_SET_EVENT_MASK_2, 837 838 #ifdef ENABLE_CLASSIC 839 HCI_INIT_WRITE_SIMPLE_PAIRING_MODE, 840 HCI_INIT_W4_WRITE_SIMPLE_PAIRING_MODE, 841 HCI_INIT_WRITE_INQUIRY_MODE, 842 HCI_INIT_W4_WRITE_INQUIRY_MODE, 843 HCI_INIT_WRITE_SECURE_CONNECTIONS_HOST_ENABLE, 844 HCI_INIT_W4_WRITE_SECURE_CONNECTIONS_HOST_ENABLE, 845 HCI_INIT_SET_MIN_ENCRYPTION_KEY_SIZE, 846 HCI_INIT_W4_SET_MIN_ENCRYPTION_KEY_SIZE, 847 848 #ifdef ENABLE_SCO_OVER_HCI 849 // SCO over HCI 850 HCI_INIT_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 851 HCI_INIT_W4_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 852 HCI_INIT_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 853 HCI_INIT_W4_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 854 #endif 855 856 #if defined(ENABLE_SCO_OVER_HCI) || defined(ENABLE_SCO_OVER_PCM) 857 // Broadcom SCO Routing and Configuration 858 HCI_INIT_BCM_WRITE_SCO_PCM_INT, 859 HCI_INIT_W4_BCM_WRITE_SCO_PCM_INT, 860 #endif 861 #ifdef ENABLE_SCO_OVER_PCM 862 HCI_INIT_BCM_WRITE_I2SPCM_INTERFACE_PARAM, 863 HCI_INIT_W4_BCM_WRITE_I2SPCM_INTERFACE_PARAM, 864 HCI_INIT_BCM_WRITE_PCM_DATA_FORMAT_PARAM, 865 HCI_INIT_W4_BCM_WRITE_PCM_DATA_FORMAT_PARAM, 866 #ifdef HAVE_BCM_PCM2 867 HCI_INIT_BCM_PCM2_SETUP, 868 HCI_INIT_W4_BCM_PCM2_SETUP, 869 #endif 870 #endif 871 #endif 872 873 #ifdef ENABLE_BLE 874 HCI_INIT_LE_READ_BUFFER_SIZE, 875 HCI_INIT_W4_LE_READ_BUFFER_SIZE, 876 HCI_INIT_WRITE_LE_HOST_SUPPORTED, 877 HCI_INIT_W4_WRITE_LE_HOST_SUPPORTED, 878 HCI_INIT_LE_SET_EVENT_MASK, 879 HCI_INIT_W4_LE_SET_EVENT_MASK, 880 #endif 881 882 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION 883 HCI_INIT_LE_READ_MAX_DATA_LENGTH, 884 HCI_INIT_W4_LE_READ_MAX_DATA_LENGTH, 885 HCI_INIT_LE_WRITE_SUGGESTED_DATA_LENGTH, 886 HCI_INIT_W4_LE_WRITE_SUGGESTED_DATA_LENGTH, 887 #endif 888 889 #ifdef ENABLE_LE_CENTRAL 890 HCI_INIT_READ_WHITE_LIST_SIZE, 891 HCI_INIT_W4_READ_WHITE_LIST_SIZE, 892 #endif 893 894 #ifdef ENABLE_LE_PERIPHERAL 895 #ifdef ENABLE_LE_EXTENDED_ADVERTISING 896 HCI_INIT_LE_READ_MAX_ADV_DATA_LEN, 897 HCI_INIT_W4_LE_READ_MAX_ADV_DATA_LEN, 898 #endif 899 #endif 900 #ifdef ENABLE_LE_ISOCHRONOUS_STREAMS 901 HCI_INIT_LE_SET_HOST_FEATURE_CONNECTED_ISO_STREAMS, 902 HCI_INIT_W4_LE_SET_HOST_FEATURE_CONNECTED_ISO_STREAMS, 903 #endif 904 905 HCI_INIT_DONE, 906 907 HCI_FALLING_ASLEEP_DISCONNECT, 908 HCI_FALLING_ASLEEP_W4_WRITE_SCAN_ENABLE, 909 HCI_FALLING_ASLEEP_COMPLETE, 910 911 HCI_INIT_AFTER_SLEEP, 912 913 HCI_HALTING_CLASSIC_STOP, 914 HCI_HALTING_LE_ADV_STOP, 915 HCI_HALTING_LE_SCAN_STOP, 916 HCI_HALTING_DISCONNECT_ALL, 917 HCI_HALTING_W4_CLOSE_TIMER, 918 HCI_HALTING_CLOSE, 919 HCI_HALTING_CLOSE_DISCARDING_CONNECTIONS, 920 921 } hci_substate_t; 922 923 #define GAP_TASK_SET_LOCAL_NAME 0x01 924 #define GAP_TASK_SET_EIR_DATA 0x02 925 #define GAP_TASK_SET_CLASS_OF_DEVICE 0x04 926 #define GAP_TASK_SET_DEFAULT_LINK_POLICY 0x08 927 #define GAP_TASK_WRITE_SCAN_ENABLE 0x10 928 #define GAP_TASK_WRITE_PAGE_SCAN_ACTIVITY 0x20 929 #define GAP_TASK_WRITE_PAGE_SCAN_TYPE 0x40 930 #define GAP_TASK_WRITE_PAGE_TIMEOUT 0x80 931 #define GAP_TASK_WRITE_INQUIRY_SCAN_ACTIVITY 0x100 932 #define GAP_TASK_WRITE_INQUIRY_TX_POWER_LEVEL 0x200 933 934 enum { 935 // Tasks 936 LE_ADVERTISEMENT_TASKS_SET_ADV_DATA = 1 << 0, 937 LE_ADVERTISEMENT_TASKS_SET_SCAN_DATA = 1 << 1, 938 LE_ADVERTISEMENT_TASKS_SET_PARAMS = 1 << 2, 939 LE_ADVERTISEMENT_TASKS_SET_PERIODIC_PARAMS = 1 << 3, 940 LE_ADVERTISEMENT_TASKS_SET_PERIODIC_DATA = 1 << 4, 941 LE_ADVERTISEMENT_TASKS_REMOVE_SET = 1 << 5, 942 LE_ADVERTISEMENT_TASKS_SET_ADDRESS = 1 << 6, 943 LE_ADVERTISEMENT_TASKS_SET_ADDRESS_SET_0 = 1 << 7, 944 LE_ADVERTISEMENT_TASKS_PRIVACY_NOTIFY = 1 << 8, 945 }; 946 947 enum { 948 // State 949 LE_ADVERTISEMENT_STATE_PARAMS_SET = 1 << 0, 950 LE_ADVERTISEMENT_STATE_ACTIVE = 1 << 1, 951 LE_ADVERTISEMENT_STATE_ENABLED = 1 << 2, 952 LE_ADVERTISEMENT_STATE_PERIODIC_ACTIVE = 1 << 3, 953 LE_ADVERTISEMENT_STATE_PERIODIC_ENABLED = 1 << 4, 954 LE_ADVERTISEMENT_STATE_PRIVACY_PENDING = 1 << 5, 955 }; 956 957 enum { 958 LE_WHITELIST_ON_CONTROLLER = 1 << 0, 959 LE_WHITELIST_ADD_TO_CONTROLLER = 1 << 1, 960 LE_WHITELIST_REMOVE_FROM_CONTROLLER = 1 << 2, 961 }; 962 963 enum { 964 LE_PERIODIC_ADVERTISER_LIST_ENTRY_ON_CONTROLLER = 1 << 0, 965 LE_PERIODIC_ADVERTISER_LIST_ENTRY_ADD_TO_CONTROLLER = 1 << 1, 966 LE_PERIODIC_ADVERTISER_LIST_ENTRY_REMOVE_FROM_CONTROLLER = 1 << 2, 967 }; 968 969 typedef struct { 970 btstack_linked_item_t item; 971 bd_addr_t address; 972 bd_addr_type_t address_type; 973 uint8_t state; 974 } whitelist_entry_t; 975 976 typedef struct { 977 btstack_linked_item_t item; 978 bd_addr_t address; 979 bd_addr_type_t address_type; 980 uint8_t sid; 981 uint8_t state; 982 } periodic_advertiser_list_entry_t; 983 984 #define MAX_NUM_RESOLVING_LIST_ENTRIES 64 985 typedef enum { 986 LE_RESOLVING_LIST_SEND_ENABLE_ADDRESS_RESOLUTION, 987 LE_RESOLVING_LIST_READ_SIZE, 988 LE_RESOLVING_LIST_SEND_CLEAR, 989 LE_RESOLVING_LIST_SET_IRK, 990 LE_RESOLVING_LIST_UPDATES_ENTRIES, 991 LE_RESOLVING_LIST_DONE 992 } le_resolving_list_state_t; 993 994 /** 995 * main data structure 996 */ 997 typedef struct { 998 // transport component with configuration 999 const hci_transport_t * hci_transport; 1000 const void * config; 1001 1002 // chipset driver 1003 const btstack_chipset_t * chipset; 1004 1005 // chipset driver requires pre-init 1006 bool chipset_pre_init; 1007 1008 // hardware power controller 1009 const btstack_control_t * control; 1010 1011 #ifdef ENABLE_CLASSIC 1012 /* link key db */ 1013 const btstack_link_key_db_t * link_key_db; 1014 #endif 1015 1016 // list of existing baseband connections 1017 btstack_linked_list_t connections; 1018 1019 /* callback to L2CAP layer */ 1020 btstack_packet_handler_t acl_packet_handler; 1021 1022 /* callback for SCO data */ 1023 btstack_packet_handler_t sco_packet_handler; 1024 1025 /* callbacks for events */ 1026 btstack_linked_list_t event_handlers; 1027 1028 #ifdef ENABLE_CLASSIC 1029 /* callback for reject classic connection */ 1030 int (*gap_classic_accept_callback)(bd_addr_t addr, hci_link_type_t link_type); 1031 #endif 1032 1033 // hardware error callback 1034 void (*hardware_error_callback)(uint8_t error); 1035 1036 #ifdef ENABLE_LE_ISOCHRONOUS_STREAMS 1037 /* callback for ISO data */ 1038 btstack_packet_handler_t iso_packet_handler; 1039 1040 /* fragmentation for ISO data */ 1041 uint16_t iso_fragmentation_pos; 1042 uint16_t iso_fragmentation_total_size; 1043 bool iso_fragmentation_tx_active; 1044 1045 uint8_t iso_packets_to_queue; 1046 // group id and type of active operation 1047 hci_iso_type_t iso_active_operation_type; 1048 uint8_t iso_active_operation_group_id; 1049 1050 // list of iso streams 1051 btstack_linked_list_t iso_streams; 1052 1053 // list of BIGs and BIG Syncs 1054 btstack_linked_list_t le_audio_bigs; 1055 btstack_linked_list_t le_audio_big_syncs; 1056 1057 // list of CIGs 1058 btstack_linked_list_t le_audio_cigs; 1059 #endif 1060 1061 // basic configuration 1062 const char * local_name; 1063 const uint8_t * eir_data; 1064 uint32_t class_of_device; 1065 bd_addr_t local_bd_addr; 1066 uint16_t default_link_policy_settings; 1067 uint8_t allow_role_switch; 1068 uint8_t ssp_enable; 1069 uint8_t ssp_io_capability; 1070 uint8_t ssp_authentication_requirement; 1071 uint8_t ssp_auto_accept; 1072 bool secure_connections_enable; 1073 bool secure_connections_active; 1074 inquiry_mode_t inquiry_mode; 1075 1076 #ifdef ENABLE_CLASSIC 1077 /* GAP tasks, see GAP_TASK_* */ 1078 uint16_t gap_tasks_classic; 1079 1080 /* write page scan activity */ 1081 uint16_t new_page_scan_interval; 1082 uint16_t new_page_scan_window; 1083 1084 /* write page scan type */ 1085 uint8_t new_page_scan_type; 1086 1087 /* write page timeout */ 1088 uint16_t page_timeout; 1089 1090 // Errata-11838 mandates 7 bytes for GAP Security Level 1-3, we use 16 as default 1091 uint8_t gap_required_encyrption_key_size; 1092 1093 uint16_t link_supervision_timeout; 1094 uint16_t automatic_flush_timeout; 1095 1096 gap_security_level_t gap_security_level; 1097 gap_security_level_t gap_minimal_service_security_level; 1098 gap_security_mode_t gap_security_mode; 1099 1100 uint32_t inquiry_lap; // GAP_IAC_GENERAL_INQUIRY or GAP_IAC_LIMITED_INQUIRY 1101 uint16_t inquiry_scan_interval; 1102 uint16_t inquiry_scan_window; 1103 int8_t inquiry_tx_power_level; 1104 1105 bool gap_secure_connections_only_mode; 1106 #endif 1107 1108 // single buffer for HCI packet assembly + additional prebuffer for H4 drivers 1109 uint8_t * hci_packet_buffer; 1110 uint8_t hci_packet_buffer_data[HCI_OUTGOING_PRE_BUFFER_SIZE + HCI_OUTGOING_PACKET_BUFFER_SIZE]; 1111 bool hci_packet_buffer_reserved; 1112 uint16_t acl_fragmentation_pos; 1113 uint16_t acl_fragmentation_total_size; 1114 uint8_t acl_fragmentation_tx_active; 1115 1116 /* host to controller flow control */ 1117 uint8_t num_cmd_packets; 1118 uint8_t acl_packets_total_num; 1119 uint16_t acl_data_packet_length; 1120 uint8_t sco_packets_total_num; 1121 uint8_t sco_data_packet_length; 1122 uint8_t synchronous_flow_control_enabled; 1123 uint8_t le_acl_packets_total_num; 1124 uint16_t le_data_packets_length; 1125 uint8_t le_iso_packets_total_num; 1126 uint16_t le_iso_packets_length; 1127 uint8_t sco_waiting_for_can_send_now; 1128 bool sco_can_send_now; 1129 1130 /* local supported features */ 1131 uint8_t local_supported_features[8]; 1132 1133 /* local supported commands summary - complete info is 64 bytes */ 1134 uint32_t local_supported_commands; 1135 1136 /* bluetooth device information from hci read local version information */ 1137 // uint16_t hci_version; 1138 // uint16_t hci_revision; 1139 // uint16_t lmp_version; 1140 uint16_t manufacturer; 1141 // uint16_t lmp_subversion; 1142 1143 // usable ACL packet types given HCI_ACL_BUFFER_SIZE and local supported features 1144 uint16_t usable_packet_types_acl; 1145 1146 // enabled ACL packet types 1147 uint16_t enabled_packet_types_acl; 1148 1149 // usable SCO packet types given local supported features 1150 uint16_t usable_packet_types_sco; 1151 1152 /* hci state machine */ 1153 HCI_STATE state; 1154 hci_substate_t substate; 1155 btstack_timer_source_t timeout; 1156 btstack_chipset_result_t chipset_result; 1157 1158 uint16_t last_cmd_opcode; 1159 1160 uint8_t cmds_ready; 1161 1162 /* buffer for scan enable cmd - 0xff no change */ 1163 uint8_t new_scan_enable_value; 1164 1165 uint8_t discoverable; 1166 uint8_t connectable; 1167 uint8_t bondable; 1168 1169 uint8_t inquiry_state; // see hci.c for state defines 1170 uint16_t inquiry_max_period_length; 1171 uint16_t inquiry_min_period_length; 1172 1173 bd_addr_t remote_name_addr; 1174 uint16_t remote_name_clock_offset; 1175 uint8_t remote_name_page_scan_repetition_mode; 1176 uint8_t remote_name_state; // see hci.c for state defines 1177 1178 bd_addr_t gap_pairing_addr; 1179 uint8_t gap_pairing_state; // see hci.c for state defines 1180 uint8_t gap_pairing_pin_len; 1181 union { 1182 const uint8_t * gap_pairing_pin; 1183 uint32_t gap_pairing_passkey; 1184 } gap_pairing_input; 1185 1186 uint16_t sco_voice_setting; 1187 uint16_t sco_voice_setting_active; 1188 1189 uint8_t loopback_mode; 1190 1191 // buffer for single connection decline 1192 uint8_t decline_reason; 1193 bd_addr_t decline_addr; 1194 1195 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 1196 uint8_t host_completed_packets; 1197 #endif 1198 1199 #ifdef ENABLE_BLE 1200 uint8_t le_own_addr_type; 1201 bd_addr_t le_random_address; 1202 uint8_t le_random_address_set; 1203 1204 // LE Whitelist Management 1205 uint8_t le_whitelist_capacity; 1206 btstack_linked_list_t le_whitelist; 1207 1208 // Connection parameters 1209 uint16_t le_connection_scan_interval; 1210 uint16_t le_connection_scan_window; 1211 uint16_t le_connection_interval_min; 1212 uint16_t le_connection_interval_max; 1213 uint16_t le_connection_latency; 1214 uint16_t le_supervision_timeout; 1215 uint16_t le_minimum_ce_length; 1216 uint16_t le_maximum_ce_length; 1217 1218 // GAP Privacy 1219 btstack_linked_list_t gap_privacy_clients; 1220 1221 #ifdef ENABLE_HCI_COMMAND_STATUS_DISCARDED_FOR_FAILED_CONNECTIONS_WORKAROUND 1222 hci_con_handle_t hci_command_con_handle; 1223 #endif 1224 #endif 1225 1226 #ifdef ENABLE_LE_CENTRAL 1227 bool le_scanning_enabled; 1228 bool le_scanning_active; 1229 1230 le_connecting_state_t le_connecting_state; 1231 le_connecting_state_t le_connecting_request; 1232 1233 bool le_scanning_param_update; 1234 uint8_t le_scan_filter_duplicates; 1235 uint8_t le_scan_type; 1236 uint8_t le_scan_filter_policy; 1237 uint8_t le_scan_phys; 1238 uint16_t le_scan_interval; 1239 uint16_t le_scan_window; 1240 1241 uint8_t le_connection_own_addr_type; 1242 uint8_t le_connection_phys; 1243 bd_addr_t le_connection_own_address; 1244 1245 #ifdef ENABLE_LE_EXTENDED_ADVERTISING 1246 btstack_linked_list_t le_periodic_advertiser_list; 1247 uint16_t le_periodic_terminate_sync_handle; 1248 1249 // Periodic Advertising Sync parameters 1250 uint8_t le_periodic_sync_options; 1251 uint8_t le_periodic_sync_advertising_sid; 1252 bd_addr_type_t le_periodic_sync_advertiser_address_type; 1253 bd_addr_t le_periodic_sync_advertiser_address; 1254 uint16_t le_periodic_sync_skip; 1255 uint16_t le_periodic_sync_timeout; 1256 uint8_t le_periodic_sync_cte_type; 1257 le_connecting_state_t le_periodic_sync_state; 1258 le_connecting_state_t le_periodic_sync_request; 1259 1260 // Periodic Advertising Sync Transfer (PAST) 1261 bool le_past_set_default_params; 1262 uint8_t le_past_mode; 1263 uint16_t le_past_skip; 1264 uint16_t le_past_sync_timeout; 1265 uint8_t le_past_cte_type; 1266 #endif 1267 #endif 1268 1269 le_connection_parameter_range_t le_connection_parameter_range; 1270 1271 // TODO: move LE_ADVERTISEMENT_TASKS_SET_ADDRESS flag which is used for both roles into 1272 // some generic gap_le variable 1273 uint16_t le_advertisements_todo; 1274 1275 #ifdef ENABLE_LE_PERIPHERAL 1276 uint8_t * le_advertisements_data; 1277 uint8_t le_advertisements_data_len; 1278 1279 uint8_t * le_scan_response_data; 1280 uint8_t le_scan_response_data_len; 1281 1282 uint16_t le_advertisements_interval_min; 1283 uint16_t le_advertisements_interval_max; 1284 uint8_t le_advertisements_type; 1285 uint8_t le_advertisements_direct_address_type; 1286 uint8_t le_advertisements_channel_map; 1287 uint8_t le_advertisements_filter_policy; 1288 bd_addr_t le_advertisements_direct_address; 1289 uint8_t le_advertisements_own_addr_type; 1290 bd_addr_t le_advertisements_own_address; 1291 1292 uint8_t le_advertisements_state; 1293 1294 bool le_advertisements_enabled_for_current_roles; 1295 uint8_t le_max_number_peripheral_connections; 1296 1297 #ifdef ENABLE_LE_EXTENDED_ADVERTISING 1298 btstack_linked_list_t le_advertising_sets; 1299 uint16_t le_maximum_advertising_data_length; 1300 uint8_t le_advertising_set_in_current_command; 1301 uint16_t le_resolvable_private_address_update_s; 1302 #endif 1303 #endif 1304 1305 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION 1306 // LE Data Length 1307 uint16_t le_supported_max_tx_octets; 1308 uint16_t le_supported_max_tx_time; 1309 #endif 1310 1311 // custom BD ADDR 1312 bd_addr_t custom_bd_addr; 1313 uint8_t custom_bd_addr_set; 1314 1315 #ifdef ENABLE_CLASSIC 1316 uint8_t master_slave_policy; 1317 #endif 1318 1319 // address and address_type of active create connection command (ACL, SCO, LE) 1320 bd_addr_t outgoing_addr; 1321 bd_addr_type_t outgoing_addr_type; 1322 1323 // LE Resolving List 1324 #ifdef ENABLE_LE_PRIVACY_ADDRESS_RESOLUTION 1325 le_privacy_mode_t le_privacy_mode; 1326 le_resolving_list_state_t le_resolving_list_state; 1327 uint16_t le_resolving_list_size; 1328 uint8_t le_resolving_list_add_entries[(MAX_NUM_RESOLVING_LIST_ENTRIES + 7) / 8]; 1329 uint8_t le_resolving_list_set_privacy_mode[(MAX_NUM_RESOLVING_LIST_ENTRIES + 7) / 8]; 1330 uint8_t le_resolving_list_remove_entries[(MAX_NUM_RESOLVING_LIST_ENTRIES + 7) / 8]; 1331 #endif 1332 1333 #ifdef ENABLE_CLASSIC_PAIRING_OOB 1334 bool classic_read_local_oob_data; 1335 hci_con_handle_t classic_oob_con_handle; 1336 #endif 1337 1338 #ifdef HAVE_SCO_TRANSPORT 1339 const btstack_sco_transport_t * sco_transport; 1340 #endif 1341 } hci_stack_t; 1342 1343 1344 /* API_START */ 1345 1346 1347 // HCI init and configuration 1348 1349 1350 /** 1351 * @brief Set up HCI. Needs to be called before any other function. 1352 */ 1353 void hci_init(const hci_transport_t *transport, const void *config); 1354 1355 /** 1356 * @brief Configure Bluetooth chipset driver. Has to be called before power on, or right after receiving the local version information. 1357 */ 1358 void hci_set_chipset(const btstack_chipset_t *chipset_driver); 1359 1360 /** 1361 * @brief Enable custom init for chipset driver to send HCI commands before HCI Reset 1362 */ 1363 void hci_enable_custom_pre_init(void); 1364 1365 /** 1366 * @brief Configure Bluetooth hardware control. Has to be called before power on. 1367 * @[aram hardware_control implementation 1368 */ 1369 void hci_set_control(const btstack_control_t *hardware_control); 1370 1371 #ifdef HAVE_SCO_TRANSPORT 1372 /** 1373 * @brief Set SCO Transport implementation for SCO over PCM mode 1374 * @param sco_transport that sends SCO over I2S or PCM interface 1375 */ 1376 void hci_set_sco_transport(const btstack_sco_transport_t *sco_transport); 1377 #endif 1378 1379 #ifdef ENABLE_CLASSIC 1380 /** 1381 * @brief Configure Bluetooth hardware control. Has to be called before power on. 1382 */ 1383 void hci_set_link_key_db(btstack_link_key_db_t const * link_key_db); 1384 #endif 1385 1386 /** 1387 * @brief Set callback for Bluetooth Hardware Error 1388 */ 1389 void hci_set_hardware_error_callback(void (*fn)(uint8_t error)); 1390 1391 /** 1392 * @brief Set Public BD ADDR - passed on to Bluetooth chipset during init if supported in bt_control_h 1393 */ 1394 void hci_set_bd_addr(bd_addr_t addr); 1395 1396 /** 1397 * @brief Configure Voice Setting for use with SCO data in HSP/HFP 1398 */ 1399 void hci_set_sco_voice_setting(uint16_t voice_setting); 1400 1401 /** 1402 * @brief Get SCO Voice Setting 1403 * @return current voice setting 1404 */ 1405 uint16_t hci_get_sco_voice_setting(void); 1406 1407 /** 1408 * @brief Set number of ISO packets to buffer for BIS/CIS 1409 * @param num_packets (default = 1) 1410 */ 1411 void hci_set_num_iso_packets_to_queue(uint8_t num_packets); 1412 1413 /** 1414 * @brief Set inquiry mode: standard, with RSSI, with RSSI + Extended Inquiry Results. Has to be called before power on. 1415 * @param inquriy_mode see bluetooth_defines.h 1416 */ 1417 void hci_set_inquiry_mode(inquiry_mode_t inquriy_mode); 1418 1419 /** 1420 * @brief Requests the change of BTstack power mode. 1421 * @param power_mode 1422 * @return 0 if success, otherwise error 1423 */ 1424 int hci_power_control(HCI_POWER_MODE power_mode); 1425 1426 /** 1427 * @brief Shutdown HCI 1428 */ 1429 void hci_close(void); 1430 1431 1432 // Callback registration 1433 1434 1435 /** 1436 * @brief Add event packet handler. 1437 */ 1438 void hci_add_event_handler(btstack_packet_callback_registration_t * callback_handler); 1439 1440 /** 1441 * @brief Remove event packet handler. 1442 */ 1443 void hci_remove_event_handler(btstack_packet_callback_registration_t * callback_handler); 1444 1445 /** 1446 * @brief Registers a packet handler for ACL data. Used by L2CAP 1447 */ 1448 void hci_register_acl_packet_handler(btstack_packet_handler_t handler); 1449 1450 /** 1451 * @brief Registers a packet handler for SCO data. Used for HSP and HFP profiles. 1452 */ 1453 void hci_register_sco_packet_handler(btstack_packet_handler_t handler); 1454 1455 /** 1456 * @brief Registers a packet handler for ISO data. Used for LE Audio profiles 1457 */ 1458 void hci_register_iso_packet_handler(btstack_packet_handler_t handler); 1459 1460 // Sending HCI Commands 1461 1462 /** 1463 * @brief Check if CMD packet can be sent to controller 1464 * @return true if command can be sent 1465 */ 1466 bool hci_can_send_command_packet_now(void); 1467 1468 /** 1469 * @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. 1470 * @return status 1471 */ 1472 uint8_t hci_send_cmd(const hci_cmd_t * cmd, ...); 1473 1474 1475 // Sending SCO Packets 1476 1477 /** @brief Get SCO payload length for existing SCO connection and current SCO Voice setting 1478 * @note Using SCO packets of the exact length is required for USB transfer in general and some H4 controllers as well 1479 * @param sco_con_handle 1480 * @return Length of SCO payload in bytes (not audio frames) incl. 3 byte header 1481 */ 1482 uint16_t hci_get_sco_packet_length_for_connection(hci_con_handle_t sco_con_handle); 1483 1484 /** @brief Get SCO packet length for one of the existing SCO connections and current SCO Voice setting 1485 * @deprecated Please use hci_get_sco_packet_length_for_connection instead 1486 * @note Using SCO packets of the exact length is required for USB transfer 1487 * @return Length of SCO packets in bytes (not audio frames) incl. 3 byte header 1488 */ 1489 uint16_t hci_get_sco_packet_length(void); 1490 1491 /** 1492 * @brief Request emission of HCI_EVENT_SCO_CAN_SEND_NOW as soon as possible 1493 * @note HCI_EVENT_SCO_CAN_SEND_NOW might be emitted during call to this function 1494 * so packet handler should be ready to handle it 1495 */ 1496 void hci_request_sco_can_send_now_event(void); 1497 1498 /** 1499 * @brief Check HCI packet buffer and if SCO packet can be sent to controller 1500 * @return true if sco packet can be sent 1501 */ 1502 bool hci_can_send_sco_packet_now(void); 1503 1504 /** 1505 * @brief Check if SCO packet can be sent to controller 1506 * @return true if sco packet can be sent 1507 */ 1508 bool hci_can_send_prepared_sco_packet_now(void); 1509 1510 /** 1511 * @brief Send SCO packet prepared in HCI packet buffer 1512 */ 1513 uint8_t hci_send_sco_packet_buffer(int size); 1514 1515 /** 1516 * @brief Request emission of HCI_EVENT_BIS_CAN_SEND_NOW for all BIS as soon as possible 1517 * @param big_handle 1518 * @note HCI_EVENT_ISO_CAN_SEND_NOW might be emitted during call to this function 1519 * so packet handler should be ready to handle it 1520 */ 1521 uint8_t hci_request_bis_can_send_now_events(uint8_t big_handle); 1522 1523 /** 1524 * @brief Request emission of HCI_EVENT_CIS_CAN_SEND_NOW for CIS as soon as possible 1525 * @param cis_con_handle 1526 * @note HCI_EVENT_CIS_CAN_SEND_NOW might be emitted during call to this function 1527 * so packet handler should be ready to handle it 1528 */ 1529 uint8_t hci_request_cis_can_send_now_events(hci_con_handle_t cis_con_handle); 1530 1531 /** 1532 * @brief Send ISO packet prepared in HCI packet buffer 1533 */ 1534 uint8_t hci_send_iso_packet_buffer(uint16_t size); 1535 1536 /** 1537 * Reserves outgoing packet buffer. 1538 * @note Must only be called after a 'can send now' check or event 1539 * @note Asserts if packet buffer is already reserved 1540 */ 1541 void hci_reserve_packet_buffer(void); 1542 1543 /** 1544 * Get pointer for outgoing packet buffer 1545 */ 1546 uint8_t* hci_get_outgoing_packet_buffer(void); 1547 1548 /** 1549 * Release outgoing packet buffer\ 1550 * @note only called instead of hci_send_prepared 1551 */ 1552 void hci_release_packet_buffer(void); 1553 1554 /** 1555 * @brief Sets the master/slave policy 1556 * @param policy (0: attempt to become master, 1: let connecting device decide) 1557 */ 1558 void hci_set_master_slave_policy(uint8_t policy); 1559 1560 /** 1561 * @brief Check if Controller supports BR/EDR (Bluetooth Classic) 1562 * @return true if supported 1563 * @note only valid in working state 1564 */ 1565 bool hci_classic_supported(void); 1566 1567 /** 1568 * @brief Check if Controller supports LE (Bluetooth Low Energy) 1569 * @return true if supported 1570 * @note only valid in working state 1571 */ 1572 bool hci_le_supported(void); 1573 1574 /** 1575 * @brief Check if LE Extended Advertising is supported 1576 * @return true if supported 1577 */ 1578 bool hci_le_extended_advertising_supported(void); 1579 1580 /** @brief Check if address type corresponds to LE connection 1581 * @bparam address_type 1582 * @erturn true if LE connection 1583 */ 1584 bool hci_is_le_connection_type(bd_addr_type_t address_type); 1585 1586 /** @brief Check if address type corresponds to Identity Address 1587 * @bparam address_type 1588 * @erturn true if LE connection 1589 */ 1590 bool hci_is_le_identity_address_type(bd_addr_type_t address_type); 1591 1592 /* API_END */ 1593 1594 1595 /** 1596 * va_list version of hci_send_cmd, call hci_send_cmd_packet 1597 * @return status 1598 */ 1599 uint8_t hci_send_cmd_va_arg(const hci_cmd_t * cmd, va_list argptr); 1600 1601 /** 1602 * Get connection iterator. Only used by l2cap.c and sm.c 1603 */ 1604 void hci_connections_get_iterator(btstack_linked_list_iterator_t *it); 1605 1606 /** 1607 * Get internal hci_connection_t for given handle. Used by L2CAP, SM, daemon 1608 */ 1609 hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle); 1610 1611 /** 1612 * Get internal hci_connection_t for given Bluetooth addres. Called by L2CAP 1613 */ 1614 hci_connection_t * hci_connection_for_bd_addr_and_type(const bd_addr_t addr, bd_addr_type_t addr_type); 1615 1616 /** 1617 * Check if outgoing packet buffer is reserved. Used for internal checks in l2cap.c 1618 * @return true if packet buffer is reserved 1619 */ 1620 bool hci_is_packet_buffer_reserved(void); 1621 1622 /** 1623 * Check hci packet buffer is free and a classic acl packet can be sent to controller 1624 * @return true if ACL Classic packet can be sent now 1625 */ 1626 bool hci_can_send_acl_classic_packet_now(void); 1627 1628 /** 1629 * Check hci packet buffer is free and an LE acl packet can be sent to controller 1630 * @return true if ACL LE packet can be sent now 1631 */ 1632 bool hci_can_send_acl_le_packet_now(void); 1633 1634 /** 1635 * Check hci packet buffer is free and an acl packet for the given handle can be sent to controller 1636 * @return true if ACL packet for con_handle can be sent now 1637 */ 1638 bool hci_can_send_acl_packet_now(hci_con_handle_t con_handle); 1639 1640 /** 1641 * Check if acl packet for the given handle can be sent to controller 1642 * @return true if ACL packet for con_handle can be sent now 1643 */ 1644 bool hci_can_send_prepared_acl_packet_now(hci_con_handle_t con_handle); 1645 1646 /** 1647 * Send acl packet prepared in hci packet buffer 1648 * @return status 1649 */ 1650 uint8_t hci_send_acl_packet_buffer(int size); 1651 1652 /** 1653 * Check if authentication is active. It delays automatic disconnect while no L2CAP connection 1654 * Called by l2cap. 1655 */ 1656 bool hci_authentication_active_for_handle(hci_con_handle_t handle); 1657 1658 /** 1659 * Get maximal ACL Classic data packet length based on used buffer size. Called by L2CAP 1660 */ 1661 uint16_t hci_max_acl_data_packet_length(void); 1662 1663 /** 1664 * Get supported ACL packet types. Already flipped for create connection. Called by L2CAP 1665 */ 1666 uint16_t hci_usable_acl_packet_types(void); 1667 1668 /** 1669 * Set filter for set of ACL packet types returned by hci_usable_acl_packet_types 1670 * @param packet_types see CL_PACKET_TYPES_* in bluetooth.h, default: ACL_PACKET_TYPES_ALL 1671 */ 1672 void hci_enable_acl_packet_types(uint16_t packet_types); 1673 1674 /** 1675 * Get supported SCO packet types. Not flipped. Called by HFP 1676 */ 1677 uint16_t hci_usable_sco_packet_types(void); 1678 1679 /** 1680 * Check if ACL packets marked as non flushable can be sent. Called by L2CAP 1681 */ 1682 bool hci_non_flushable_packet_boundary_flag_supported(void); 1683 1684 /** 1685 * Return current automatic flush timeout setting 1686 */ 1687 uint16_t hci_automatic_flush_timeout(void); 1688 1689 /** 1690 * Check if remote supported features query has completed 1691 */ 1692 bool hci_remote_features_available(hci_con_handle_t con_handle); 1693 1694 /** 1695 * Trigger remote supported features query 1696 */ 1697 void hci_remote_features_query(hci_con_handle_t con_handle); 1698 1699 /** 1700 * Check if extended SCO Link is supported 1701 */ 1702 bool hci_extended_sco_link_supported(void); 1703 1704 /** 1705 * Check if SSP is supported on both sides. Called by L2CAP 1706 */ 1707 bool gap_ssp_supported_on_both_sides(hci_con_handle_t handle); 1708 1709 /** 1710 * Disconn because of security block. Called by L2CAP 1711 */ 1712 void hci_disconnect_security_block(hci_con_handle_t con_handle); 1713 1714 /** 1715 * Query if remote side supports eSCO 1716 * @param con_handle 1717 */ 1718 bool hci_remote_esco_supported(hci_con_handle_t con_handle); 1719 1720 /** 1721 * Query remote supported SCO packets based on remote supported features 1722 * @param con_handle 1723 */ 1724 uint16_t hci_remote_sco_packet_types(hci_con_handle_t con_handle); 1725 1726 /** 1727 * Emit current HCI state. Called by daemon 1728 */ 1729 void hci_emit_state(void); 1730 1731 /** 1732 * Send complete CMD packet. Called by daemon and hci_send_cmd_va_arg 1733 * @return status 1734 */ 1735 uint8_t hci_send_cmd_packet(uint8_t *packet, int size); 1736 1737 /** 1738 * Disconnect all HCI connections. Called by daemon 1739 */ 1740 void hci_disconnect_all(void); 1741 1742 /** 1743 * Get number of free acl slots for packets of given handle. Called by daemon 1744 */ 1745 int hci_number_free_acl_slots_for_handle(hci_con_handle_t con_handle); 1746 1747 /** 1748 * @brief Set Advertisement Parameters 1749 * @param adv_int_min 1750 * @param adv_int_max 1751 * @param adv_type 1752 * @param direct_address_type 1753 * @param direct_address 1754 * @param channel_map 1755 * @param filter_policy 1756 * 1757 * @note internal use. use gap_advertisements_set_params from gap.h instead. 1758 */ 1759 void hci_le_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 1760 uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy); 1761 1762 /** 1763 * 1764 * @note internal use. use gap_random_address_set_mode from gap.h instead. 1765 */ 1766 void hci_le_set_own_address_type(uint8_t own_address_type); 1767 1768 /** 1769 * @naote internal use. use gap_random_address_set from gap.h instead 1770 */ 1771 void hci_le_random_address_set(const bd_addr_t random_address); 1772 1773 /** 1774 * @note internal use by sm 1775 */ 1776 void hci_load_le_device_db_entry_into_resolving_list(uint16_t le_device_db_index); 1777 1778 /** 1779 * @note internal use by sm 1780 */ 1781 void hci_remove_le_device_db_entry_from_resolving_list(uint16_t le_device_db_index); 1782 1783 /** 1784 * @note internal use 1785 */ 1786 uint16_t hci_number_free_acl_slots_for_connection_type(bd_addr_type_t address_type); 1787 1788 /** 1789 * @brief Clear Periodic Advertiser List 1790 * @return status 1791 */ 1792 uint8_t gap_periodic_advertiser_list_clear(void); 1793 1794 /** 1795 * @brief Add entry to Periodic Advertiser List 1796 * @param address_type 1797 * @param address 1798 * @param advertising_sid 1799 * @return 1800 */ 1801 uint8_t gap_periodic_advertiser_list_add(bd_addr_type_t address_type, const bd_addr_t address, uint8_t advertising_sid); 1802 1803 /** 1804 * Remove entry from Periodic Advertising List 1805 * @param address_type 1806 * @param address 1807 * @param advertising_sid 1808 * @return 1809 */ 1810 uint8_t gap_periodic_advertiser_list_remove(bd_addr_type_t address_type, const bd_addr_t address, uint8_t advertising_sid); 1811 1812 /** 1813 * @brief Synchronize with a periodic advertising train from an advertiser and begin receiving periodic advertising packets. 1814 * @param options 1815 * @param advertising_sid 1816 * @param advertiser_address_type 1817 * @param advertiser_address 1818 * @param skip 1819 * @param sync_timeout 1820 * @param sync_cte_type 1821 * @return 1822 */ 1823 uint8_t gap_periodic_advertising_create_sync(uint8_t options, uint8_t advertising_sid, bd_addr_type_t advertiser_address_type, 1824 bd_addr_t advertiser_address, uint16_t skip, uint16_t sync_timeout, uint8_t sync_cte_type); 1825 1826 /** 1827 * @brief Cancel sync periodic advertising train while it is pending. 1828 * @return status 1829 */ 1830 uint8_t gap_periodic_advertising_create_sync_cancel(void); 1831 1832 /** 1833 * @biref Stop reception of the periodic advertising train 1834 * @param sync_handle 1835 * @return status 1836 */ 1837 uint8_t gap_periodic_advertising_terminate_sync(uint16_t sync_handle); 1838 1839 /** 1840 * @brief Get Controller Manufacturer 1841 * @returns company_id - see bluetooth_company_id.h 1842 */ 1843 uint16_t hci_get_manufacturer(void); 1844 1845 /** 1846 * Get Classic Allow Role Switch param 1847 */ 1848 uint8_t hci_get_allow_role_switch(void); 1849 1850 /** 1851 * Get state 1852 */ 1853 HCI_STATE hci_get_state(void); 1854 1855 /** 1856 * @brief De-Init HCI 1857 */ 1858 void hci_deinit(void); 1859 1860 // defer disconnect on dedicated bonding complete, used internally for CTKD 1861 uint8_t hci_dedicated_bonding_defer_disconnect(hci_con_handle_t con_handle, bool defer); 1862 1863 // Only for PTS testing 1864 1865 // Disable automatic L2CAP disconnect if no L2CAP connection is established 1866 void hci_disable_l2cap_timeout_check(void); 1867 1868 // setup test connections, used for fuzzing 1869 void hci_setup_test_connections_fuzz(void); 1870 1871 // free all connections, used for fuzzing 1872 void hci_free_connections_fuzz(void); 1873 1874 // simulate stack bootup 1875 void hci_simulate_working_fuzz(void); 1876 1877 1878 #if defined __cplusplus 1879 } 1880 #endif 1881 1882 #endif // HCI_H 1883