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