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