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