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_rx_ms; 612 uint8_t sco_rx_count; 613 uint8_t sco_rx_valid; 614 #endif 615 // generate sco can send now based on received packets, using timeout below 616 uint8_t sco_tx_ready; 617 618 // request role switch 619 hci_role_t request_role; 620 621 btstack_timer_source_t timeout_sco; 622 #endif /* ENABLE_CLASSIC */ 623 624 // authentication and other errands 625 uint16_t authentication_flags; 626 627 // gap connection tasks, see GAP_CONNECTION_TASK_x 628 uint16_t gap_connection_tasks; 629 630 btstack_timer_source_t timeout; 631 632 // timeout in system ticks (HAVE_EMBEDDED_TICK) or milliseconds (HAVE_EMBEDDED_TIME_MS) 633 uint32_t timestamp; 634 635 // ACL packet recombination - PRE_BUFFER + ACL Header + ACL payload 636 uint8_t acl_recombination_buffer[HCI_INCOMING_PRE_BUFFER_SIZE + 4 + HCI_ACL_BUFFER_SIZE]; 637 uint16_t acl_recombination_pos; 638 uint16_t acl_recombination_length; 639 640 641 // number packets sent to controller 642 uint8_t num_packets_sent; 643 644 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 645 uint8_t num_packets_completed; 646 #endif 647 648 // LE Connection parameter update 649 le_con_parameter_update_state_t le_con_parameter_update_state; 650 uint8_t le_con_param_update_identifier; 651 uint16_t le_conn_interval_min; 652 uint16_t le_conn_interval_max; 653 uint16_t le_conn_latency; 654 uint16_t le_supervision_timeout; 655 656 #ifdef ENABLE_BLE 657 uint16_t le_connection_interval; 658 659 // LE PHY Update via set phy command 660 uint8_t le_phy_update_all_phys; // 0xff for idle 661 uint8_t le_phy_update_tx_phys; 662 uint8_t le_phy_update_rx_phys; 663 int8_t le_phy_update_phy_options; 664 665 // LE Security Manager 666 sm_connection_t sm_connection; 667 668 #ifdef ENABLE_LE_LIMIT_ACL_FRAGMENT_BY_MAX_OCTETS 669 uint16_t le_max_tx_octets; 670 #endif 671 672 // ATT Connection 673 att_connection_t att_connection; 674 675 // ATT Server 676 att_server_t att_server; 677 678 #ifdef ENABLE_LE_PERIODIC_ADVERTISING 679 hci_con_handle_t le_past_sync_handle; 680 uint8_t le_past_advertising_handle; 681 uint16_t le_past_service_data; 682 #endif 683 684 #endif 685 686 l2cap_state_t l2cap_state; 687 688 #ifdef ENABLE_CLASSIC_PAIRING_OOB 689 const uint8_t * classic_oob_c_192; 690 const uint8_t * classic_oob_r_192; 691 const uint8_t * classic_oob_c_256; 692 const uint8_t * classic_oob_r_256; 693 #endif 694 695 } hci_connection_t; 696 697 #ifdef ENABLE_LE_ISOCHRONOUS_STREAMS 698 699 700 typedef enum { 701 HCI_ISO_TYPE_INVALID = 0, 702 HCI_ISO_TYPE_BIS, 703 HCI_ISO_TYPE_CIS, 704 } hci_iso_type_t; 705 706 #define HCI_ISO_GROUP_ID_SINGLE_CIS 0xfe 707 #define HCI_ISO_GROUP_ID_INVALID 0xff 708 709 typedef enum{ 710 HCI_ISO_STREAM_STATE_IDLE, 711 HCI_ISO_STREAM_W4_USER, 712 HCI_ISO_STREAM_W2_ACCEPT, 713 HCI_ISO_STREAM_W2_REJECT, 714 HCI_ISO_STREAM_STATE_REQUESTED, 715 HCI_ISO_STREAM_STATE_W4_ESTABLISHED, 716 HCI_ISO_STREAM_STATE_ESTABLISHED, 717 HCI_ISO_STREAM_STATE_W2_SETUP_ISO_INPUT, 718 HCI_ISO_STREAM_STATE_W4_ISO_SETUP_INPUT, 719 HCI_ISO_STREAM_STATE_W2_SETUP_ISO_OUTPUT, 720 HCI_ISO_STREAM_STATE_W4_ISO_SETUP_OUTPUT, 721 } hci_iso_stream_state_t; 722 723 typedef struct { 724 // linked list - assert: first field 725 btstack_linked_item_t item; 726 727 // state 728 hci_iso_stream_state_t state; 729 730 // iso type: bis or cis 731 hci_iso_type_t iso_type; 732 733 // group_id: big_handle or cig_id 734 uint8_t group_id; 735 736 // stream_id: bis_index or cis_id 737 uint8_t stream_id; 738 739 // only valid for HCI_ISO_TYPE_CIS 740 hci_con_handle_t cis_handle; 741 hci_con_handle_t acl_handle; 742 743 // connection info 744 uint16_t max_sdu_c_to_p; 745 uint16_t max_sdu_p_to_c; 746 747 // re-assembly buffer 748 uint16_t reassembly_pos; 749 uint8_t reassembly_buffer[HCI_ISO_PAYLOAD_SIZE]; 750 751 // number packets sent to controller 752 uint8_t num_packets_sent; 753 754 // packets to skip due to queuing them to late before 755 uint8_t num_packets_to_skip; 756 757 // request to send 758 bool can_send_now_requested; 759 760 // ready to send 761 bool emit_ready_to_send; 762 763 } hci_iso_stream_t; 764 #endif 765 766 /** 767 * HCI Initialization State Machine 768 */ 769 typedef enum hci_init_state{ 770 HCI_INIT_SEND_RESET = 0, 771 HCI_INIT_W4_SEND_RESET, 772 HCI_INIT_SEND_READ_LOCAL_VERSION_INFORMATION, 773 HCI_INIT_W4_SEND_READ_LOCAL_VERSION_INFORMATION, 774 775 #ifndef HAVE_HOST_CONTROLLER_API 776 HCI_INIT_SEND_READ_LOCAL_NAME, 777 HCI_INIT_W4_SEND_READ_LOCAL_NAME, 778 HCI_INIT_SEND_BAUD_CHANGE, 779 HCI_INIT_W4_SEND_BAUD_CHANGE, 780 HCI_INIT_CUSTOM_INIT, 781 HCI_INIT_W4_CUSTOM_INIT, 782 783 HCI_INIT_SEND_RESET_CSR_WARM_BOOT, 784 HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT, 785 HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT_LINK_RESET, 786 787 HCI_INIT_W4_CUSTOM_INIT_BCM_DELAY, 788 789 // Support for Pre-Init before HCI Reset 790 HCI_INIT_CUSTOM_PRE_INIT, 791 HCI_INIT_W4_CUSTOM_PRE_INIT, 792 #endif 793 794 HCI_INIT_READ_LOCAL_SUPPORTED_COMMANDS, 795 HCI_INIT_W4_READ_LOCAL_SUPPORTED_COMMANDS, 796 797 HCI_INIT_SEND_BAUD_CHANGE_BCM, 798 HCI_INIT_W4_SEND_BAUD_CHANGE_BCM, 799 800 HCI_INIT_SET_BD_ADDR, 801 HCI_INIT_W4_SET_BD_ADDR, 802 803 HCI_INIT_SEND_RESET_ST_WARM_BOOT, 804 HCI_INIT_W4_SEND_RESET_ST_WARM_BOOT, 805 806 HCI_INIT_READ_BD_ADDR, 807 HCI_INIT_W4_READ_BD_ADDR, 808 809 HCI_INIT_READ_BUFFER_SIZE, 810 HCI_INIT_W4_READ_BUFFER_SIZE, 811 HCI_INIT_READ_LOCAL_SUPPORTED_FEATURES, 812 HCI_INIT_W4_READ_LOCAL_SUPPORTED_FEATURES, 813 814 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 815 HCI_INIT_HOST_BUFFER_SIZE, 816 HCI_INIT_W4_HOST_BUFFER_SIZE, 817 HCI_INIT_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, 818 HCI_INIT_W4_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, 819 #endif 820 821 HCI_INIT_SET_EVENT_MASK, 822 HCI_INIT_W4_SET_EVENT_MASK, 823 HCI_INIT_SET_EVENT_MASK_2, 824 HCI_INIT_W4_SET_EVENT_MASK_2, 825 826 #ifdef ENABLE_CLASSIC 827 HCI_INIT_WRITE_SIMPLE_PAIRING_MODE, 828 HCI_INIT_W4_WRITE_SIMPLE_PAIRING_MODE, 829 HCI_INIT_WRITE_INQUIRY_MODE, 830 HCI_INIT_W4_WRITE_INQUIRY_MODE, 831 HCI_INIT_WRITE_SECURE_CONNECTIONS_HOST_ENABLE, 832 HCI_INIT_W4_WRITE_SECURE_CONNECTIONS_HOST_ENABLE, 833 HCI_INIT_SET_MIN_ENCRYPTION_KEY_SIZE, 834 HCI_INIT_W4_SET_MIN_ENCRYPTION_KEY_SIZE, 835 836 #ifdef ENABLE_SCO_OVER_HCI 837 // SCO over HCI 838 HCI_INIT_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 839 HCI_INIT_W4_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 840 HCI_INIT_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 841 HCI_INIT_W4_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 842 #endif 843 844 #if defined(ENABLE_SCO_OVER_HCI) || defined(ENABLE_SCO_OVER_PCM) 845 // Broadcom SCO Routing and Configuration 846 HCI_INIT_BCM_WRITE_SCO_PCM_INT, 847 HCI_INIT_W4_BCM_WRITE_SCO_PCM_INT, 848 #endif 849 #ifdef ENABLE_SCO_OVER_PCM 850 HCI_INIT_BCM_WRITE_I2SPCM_INTERFACE_PARAM, 851 HCI_INIT_W4_BCM_WRITE_I2SPCM_INTERFACE_PARAM, 852 #endif 853 #endif 854 855 #ifdef ENABLE_BLE 856 HCI_INIT_LE_READ_BUFFER_SIZE, 857 HCI_INIT_W4_LE_READ_BUFFER_SIZE, 858 HCI_INIT_WRITE_LE_HOST_SUPPORTED, 859 HCI_INIT_W4_WRITE_LE_HOST_SUPPORTED, 860 HCI_INIT_LE_SET_EVENT_MASK, 861 HCI_INIT_W4_LE_SET_EVENT_MASK, 862 #endif 863 864 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION 865 HCI_INIT_LE_READ_MAX_DATA_LENGTH, 866 HCI_INIT_W4_LE_READ_MAX_DATA_LENGTH, 867 HCI_INIT_LE_WRITE_SUGGESTED_DATA_LENGTH, 868 HCI_INIT_W4_LE_WRITE_SUGGESTED_DATA_LENGTH, 869 #endif 870 871 #ifdef ENABLE_LE_CENTRAL 872 HCI_INIT_READ_WHITE_LIST_SIZE, 873 HCI_INIT_W4_READ_WHITE_LIST_SIZE, 874 #endif 875 876 #ifdef ENABLE_LE_PERIPHERAL 877 #ifdef ENABLE_LE_EXTENDED_ADVERTISING 878 HCI_INIT_LE_READ_MAX_ADV_DATA_LEN, 879 HCI_INIT_W4_LE_READ_MAX_ADV_DATA_LEN, 880 #endif 881 #endif 882 #ifdef ENABLE_LE_ISOCHRONOUS_STREAMS 883 HCI_INIT_LE_SET_HOST_FEATURE_CONNECTED_ISO_STREAMS, 884 HCI_INIT_W4_LE_SET_HOST_FEATURE_CONNECTED_ISO_STREAMS, 885 #endif 886 887 HCI_INIT_DONE, 888 889 HCI_FALLING_ASLEEP_DISCONNECT, 890 HCI_FALLING_ASLEEP_W4_WRITE_SCAN_ENABLE, 891 HCI_FALLING_ASLEEP_COMPLETE, 892 893 HCI_INIT_AFTER_SLEEP, 894 895 HCI_HALTING_CLASSIC_STOP, 896 HCI_HALTING_LE_ADV_STOP, 897 HCI_HALTING_LE_SCAN_STOP, 898 HCI_HALTING_DISCONNECT_ALL, 899 HCI_HALTING_W4_CLOSE_TIMER, 900 HCI_HALTING_CLOSE, 901 HCI_HALTING_CLOSE_DISCARDING_CONNECTIONS, 902 903 } hci_substate_t; 904 905 #define GAP_TASK_SET_LOCAL_NAME 0x01 906 #define GAP_TASK_SET_EIR_DATA 0x02 907 #define GAP_TASK_SET_CLASS_OF_DEVICE 0x04 908 #define GAP_TASK_SET_DEFAULT_LINK_POLICY 0x08 909 #define GAP_TASK_WRITE_SCAN_ENABLE 0x10 910 #define GAP_TASK_WRITE_PAGE_SCAN_ACTIVITY 0x20 911 #define GAP_TASK_WRITE_PAGE_SCAN_TYPE 0x40 912 #define GAP_TASK_WRITE_PAGE_TIMEOUT 0x80 913 #define GAP_TASK_WRITE_INQUIRY_SCAN_ACTIVITY 0x100 914 #define GAP_TASK_WRITE_INQUIRY_TX_POWER_LEVEL 0x200 915 916 enum { 917 // Tasks 918 LE_ADVERTISEMENT_TASKS_SET_ADV_DATA = 1 << 0, 919 LE_ADVERTISEMENT_TASKS_SET_SCAN_DATA = 1 << 1, 920 LE_ADVERTISEMENT_TASKS_SET_PARAMS = 1 << 2, 921 LE_ADVERTISEMENT_TASKS_SET_PERIODIC_PARAMS = 1 << 3, 922 LE_ADVERTISEMENT_TASKS_SET_PERIODIC_DATA = 1 << 4, 923 LE_ADVERTISEMENT_TASKS_REMOVE_SET = 1 << 5, 924 LE_ADVERTISEMENT_TASKS_SET_ADDRESS = 1 << 6, 925 LE_ADVERTISEMENT_TASKS_SET_ADDRESS_SET_0 = 1 << 7, 926 }; 927 928 enum { 929 // State 930 LE_ADVERTISEMENT_STATE_PARAMS_SET = 1 << 0, 931 LE_ADVERTISEMENT_STATE_ACTIVE = 1 << 1, 932 LE_ADVERTISEMENT_STATE_ENABLED = 1 << 2, 933 LE_ADVERTISEMENT_STATE_PERIODIC_ACTIVE = 1 << 3, 934 LE_ADVERTISEMENT_STATE_PERIODIC_ENABLED = 1 << 4, 935 }; 936 937 enum { 938 LE_WHITELIST_ON_CONTROLLER = 1 << 0, 939 LE_WHITELIST_ADD_TO_CONTROLLER = 1 << 1, 940 LE_WHITELIST_REMOVE_FROM_CONTROLLER = 1 << 2, 941 }; 942 943 enum { 944 LE_PERIODIC_ADVERTISER_LIST_ENTRY_ON_CONTROLLER = 1 << 0, 945 LE_PERIODIC_ADVERTISER_LIST_ENTRY_ADD_TO_CONTROLLER = 1 << 1, 946 LE_PERIODIC_ADVERTISER_LIST_ENTRY_REMOVE_FROM_CONTROLLER = 1 << 2, 947 }; 948 949 typedef struct { 950 btstack_linked_item_t item; 951 bd_addr_t address; 952 bd_addr_type_t address_type; 953 uint8_t state; 954 } whitelist_entry_t; 955 956 typedef struct { 957 btstack_linked_item_t item; 958 bd_addr_t address; 959 bd_addr_type_t address_type; 960 uint8_t sid; 961 uint8_t state; 962 } periodic_advertiser_list_entry_t; 963 964 #define MAX_NUM_RESOLVING_LIST_ENTRIES 64 965 typedef enum { 966 LE_RESOLVING_LIST_SEND_ENABLE_ADDRESS_RESOLUTION, 967 LE_RESOLVING_LIST_READ_SIZE, 968 LE_RESOLVING_LIST_SEND_CLEAR, 969 LE_RESOLVING_LIST_UPDATES_ENTRIES, 970 LE_RESOLVING_LIST_DONE 971 } le_resolving_list_state_t; 972 973 /** 974 * main data structure 975 */ 976 typedef struct { 977 // transport component with configuration 978 const hci_transport_t * hci_transport; 979 const void * config; 980 981 // chipset driver 982 const btstack_chipset_t * chipset; 983 984 // chipset driver requires pre-init 985 bool chipset_pre_init; 986 987 // hardware power controller 988 const btstack_control_t * control; 989 990 #ifdef ENABLE_CLASSIC 991 /* link key db */ 992 const btstack_link_key_db_t * link_key_db; 993 #endif 994 995 // list of existing baseband connections 996 btstack_linked_list_t connections; 997 998 /* callback to L2CAP layer */ 999 btstack_packet_handler_t acl_packet_handler; 1000 1001 /* callback for SCO data */ 1002 btstack_packet_handler_t sco_packet_handler; 1003 1004 /* callbacks for events */ 1005 btstack_linked_list_t event_handlers; 1006 1007 #ifdef ENABLE_CLASSIC 1008 /* callback for reject classic connection */ 1009 int (*gap_classic_accept_callback)(bd_addr_t addr, hci_link_type_t link_type); 1010 #endif 1011 1012 // hardware error callback 1013 void (*hardware_error_callback)(uint8_t error); 1014 1015 #ifdef ENABLE_LE_ISOCHRONOUS_STREAMS 1016 /* callback for ISO data */ 1017 btstack_packet_handler_t iso_packet_handler; 1018 1019 /* fragmentation for ISO data */ 1020 uint16_t iso_fragmentation_pos; 1021 uint16_t iso_fragmentation_total_size; 1022 bool iso_fragmentation_tx_active; 1023 1024 uint8_t iso_packets_to_queue; 1025 // group id and type of active operation 1026 hci_iso_type_t iso_active_operation_type; 1027 uint8_t iso_active_operation_group_id; 1028 1029 // list of iso streams 1030 btstack_linked_list_t iso_streams; 1031 1032 // list of BIGs and BIG Syncs 1033 btstack_linked_list_t le_audio_bigs; 1034 btstack_linked_list_t le_audio_big_syncs; 1035 1036 // list of CIGs 1037 btstack_linked_list_t le_audio_cigs; 1038 #endif 1039 1040 // basic configuration 1041 const char * local_name; 1042 const uint8_t * eir_data; 1043 uint32_t class_of_device; 1044 bd_addr_t local_bd_addr; 1045 uint16_t default_link_policy_settings; 1046 uint8_t allow_role_switch; 1047 uint8_t ssp_enable; 1048 uint8_t ssp_io_capability; 1049 uint8_t ssp_authentication_requirement; 1050 uint8_t ssp_auto_accept; 1051 bool secure_connections_enable; 1052 bool secure_connections_active; 1053 inquiry_mode_t inquiry_mode; 1054 1055 #ifdef ENABLE_CLASSIC 1056 /* GAP tasks, see GAP_TASK_* */ 1057 uint16_t gap_tasks_classic; 1058 1059 /* write page scan activity */ 1060 uint16_t new_page_scan_interval; 1061 uint16_t new_page_scan_window; 1062 1063 /* write page scan type */ 1064 uint8_t new_page_scan_type; 1065 1066 /* write page timeout */ 1067 uint16_t page_timeout; 1068 1069 // Errata-11838 mandates 7 bytes for GAP Security Level 1-3, we use 16 as default 1070 uint8_t gap_required_encyrption_key_size; 1071 1072 uint16_t link_supervision_timeout; 1073 uint16_t automatic_flush_timeout; 1074 1075 gap_security_level_t gap_security_level; 1076 gap_security_level_t gap_minimal_service_security_level; 1077 gap_security_mode_t gap_security_mode; 1078 1079 uint32_t inquiry_lap; // GAP_IAC_GENERAL_INQUIRY or GAP_IAC_LIMITED_INQUIRY 1080 uint16_t inquiry_scan_interval; 1081 uint16_t inquiry_scan_window; 1082 int8_t inquiry_tx_power_level; 1083 1084 bool gap_secure_connections_only_mode; 1085 #endif 1086 1087 // single buffer for HCI packet assembly + additional prebuffer for H4 drivers 1088 uint8_t * hci_packet_buffer; 1089 uint8_t hci_packet_buffer_data[HCI_OUTGOING_PRE_BUFFER_SIZE + HCI_OUTGOING_PACKET_BUFFER_SIZE]; 1090 bool hci_packet_buffer_reserved; 1091 uint16_t acl_fragmentation_pos; 1092 uint16_t acl_fragmentation_total_size; 1093 uint8_t acl_fragmentation_tx_active; 1094 1095 /* host to controller flow control */ 1096 uint8_t num_cmd_packets; 1097 uint8_t acl_packets_total_num; 1098 uint16_t acl_data_packet_length; 1099 uint8_t sco_packets_total_num; 1100 uint8_t sco_data_packet_length; 1101 uint8_t synchronous_flow_control_enabled; 1102 uint8_t le_acl_packets_total_num; 1103 uint16_t le_data_packets_length; 1104 uint8_t le_iso_packets_total_num; 1105 uint16_t le_iso_packets_length; 1106 uint8_t sco_waiting_for_can_send_now; 1107 bool sco_can_send_now; 1108 1109 /* local supported features */ 1110 uint8_t local_supported_features[8]; 1111 1112 /* local supported commands summary - complete info is 64 bytes */ 1113 uint32_t local_supported_commands; 1114 1115 /* bluetooth device information from hci read local version information */ 1116 // uint16_t hci_version; 1117 // uint16_t hci_revision; 1118 // uint16_t lmp_version; 1119 uint16_t manufacturer; 1120 // uint16_t lmp_subversion; 1121 1122 // usable ACL packet types given HCI_ACL_BUFFER_SIZE and local supported features 1123 uint16_t usable_packet_types_acl; 1124 1125 // usable SCO packet types given local supported features 1126 uint16_t usable_packet_types_sco; 1127 1128 /* hci state machine */ 1129 HCI_STATE state; 1130 hci_substate_t substate; 1131 btstack_timer_source_t timeout; 1132 btstack_chipset_result_t chipset_result; 1133 1134 uint16_t last_cmd_opcode; 1135 1136 uint8_t cmds_ready; 1137 1138 /* buffer for scan enable cmd - 0xff no change */ 1139 uint8_t new_scan_enable_value; 1140 1141 uint8_t discoverable; 1142 uint8_t connectable; 1143 uint8_t bondable; 1144 1145 uint8_t inquiry_state; // see hci.c for state defines 1146 uint16_t inquiry_max_period_length; 1147 uint16_t inquiry_min_period_length; 1148 1149 bd_addr_t remote_name_addr; 1150 uint16_t remote_name_clock_offset; 1151 uint8_t remote_name_page_scan_repetition_mode; 1152 uint8_t remote_name_state; // see hci.c for state defines 1153 1154 bd_addr_t gap_pairing_addr; 1155 uint8_t gap_pairing_state; // see hci.c for state defines 1156 uint8_t gap_pairing_pin_len; 1157 union { 1158 const uint8_t * gap_pairing_pin; 1159 uint32_t gap_pairing_passkey; 1160 } gap_pairing_input; 1161 1162 uint16_t sco_voice_setting; 1163 uint16_t sco_voice_setting_active; 1164 1165 uint8_t loopback_mode; 1166 1167 // buffer for single connection decline 1168 uint8_t decline_reason; 1169 bd_addr_t decline_addr; 1170 1171 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 1172 uint8_t host_completed_packets; 1173 #endif 1174 1175 #ifdef ENABLE_BLE 1176 uint8_t le_own_addr_type; 1177 bd_addr_t le_random_address; 1178 uint8_t le_random_address_set; 1179 1180 // LE Whitelist Management 1181 uint8_t le_whitelist_capacity; 1182 btstack_linked_list_t le_whitelist; 1183 1184 // Connection parameters 1185 uint16_t le_connection_scan_interval; 1186 uint16_t le_connection_scan_window; 1187 uint16_t le_connection_interval_min; 1188 uint16_t le_connection_interval_max; 1189 uint16_t le_connection_latency; 1190 uint16_t le_supervision_timeout; 1191 uint16_t le_minimum_ce_length; 1192 uint16_t le_maximum_ce_length; 1193 #endif 1194 1195 #ifdef ENABLE_LE_CENTRAL 1196 bool le_scanning_enabled; 1197 bool le_scanning_active; 1198 1199 le_connecting_state_t le_connecting_state; 1200 le_connecting_state_t le_connecting_request; 1201 1202 bool le_scanning_param_update; 1203 uint8_t le_scan_filter_duplicates; 1204 uint8_t le_scan_type; 1205 uint8_t le_scan_filter_policy; 1206 uint8_t le_scan_phys; 1207 uint16_t le_scan_interval; 1208 uint16_t le_scan_window; 1209 1210 uint8_t le_connection_own_addr_type; 1211 uint8_t le_connection_phys; 1212 bd_addr_t le_connection_own_address; 1213 1214 #ifdef ENABLE_LE_EXTENDED_ADVERTISING 1215 btstack_linked_list_t le_periodic_advertiser_list; 1216 uint16_t le_periodic_terminate_sync_handle; 1217 1218 // Periodic Advertising Sync parameters 1219 uint8_t le_periodic_sync_options; 1220 uint8_t le_periodic_sync_advertising_sid; 1221 bd_addr_type_t le_periodic_sync_advertiser_address_type; 1222 bd_addr_t le_periodic_sync_advertiser_address; 1223 uint16_t le_periodic_sync_skip; 1224 uint16_t le_periodic_sync_timeout; 1225 uint8_t le_periodic_sync_cte_type; 1226 le_connecting_state_t le_periodic_sync_state; 1227 le_connecting_state_t le_periodic_sync_request; 1228 1229 // Periodic Advertising Sync Transfer (PAST) 1230 bool le_past_set_default_params; 1231 uint8_t le_past_mode; 1232 uint16_t le_past_skip; 1233 uint16_t le_past_sync_timeout; 1234 uint8_t le_past_cte_type; 1235 #endif 1236 #endif 1237 1238 le_connection_parameter_range_t le_connection_parameter_range; 1239 1240 // TODO: move LE_ADVERTISEMENT_TASKS_SET_ADDRESS flag which is used for both roles into 1241 // some generic gap_le variable 1242 uint8_t le_advertisements_todo; 1243 1244 #ifdef ENABLE_LE_PERIPHERAL 1245 uint8_t * le_advertisements_data; 1246 uint8_t le_advertisements_data_len; 1247 1248 uint8_t * le_scan_response_data; 1249 uint8_t le_scan_response_data_len; 1250 1251 uint16_t le_advertisements_interval_min; 1252 uint16_t le_advertisements_interval_max; 1253 uint8_t le_advertisements_type; 1254 uint8_t le_advertisements_direct_address_type; 1255 uint8_t le_advertisements_channel_map; 1256 uint8_t le_advertisements_filter_policy; 1257 bd_addr_t le_advertisements_direct_address; 1258 uint8_t le_advertisements_own_addr_type; 1259 bd_addr_t le_advertisements_own_address; 1260 1261 uint8_t le_advertisements_state; 1262 1263 bool le_advertisements_enabled_for_current_roles; 1264 uint8_t le_max_number_peripheral_connections; 1265 1266 #ifdef ENABLE_LE_EXTENDED_ADVERTISING 1267 btstack_linked_list_t le_advertising_sets; 1268 uint16_t le_maximum_advertising_data_length; 1269 uint8_t le_advertising_set_in_current_command; 1270 uint16_t le_resolvable_private_address_update_s; 1271 #endif 1272 #endif 1273 1274 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION 1275 // LE Data Length 1276 uint16_t le_supported_max_tx_octets; 1277 uint16_t le_supported_max_tx_time; 1278 #endif 1279 1280 // custom BD ADDR 1281 bd_addr_t custom_bd_addr; 1282 uint8_t custom_bd_addr_set; 1283 1284 #ifdef ENABLE_CLASSIC 1285 uint8_t master_slave_policy; 1286 #endif 1287 1288 // address and address_type of active create connection command (ACL, SCO, LE) 1289 bd_addr_t outgoing_addr; 1290 bd_addr_type_t outgoing_addr_type; 1291 1292 // LE Resolving List 1293 #ifdef ENABLE_LE_PRIVACY_ADDRESS_RESOLUTION 1294 le_privacy_mode_t le_privacy_mode; 1295 le_resolving_list_state_t le_resolving_list_state; 1296 uint16_t le_resolving_list_size; 1297 uint8_t le_resolving_list_add_entries[(MAX_NUM_RESOLVING_LIST_ENTRIES + 7) / 8]; 1298 uint8_t le_resolving_list_set_privacy_mode[(MAX_NUM_RESOLVING_LIST_ENTRIES + 7) / 8]; 1299 uint8_t le_resolving_list_remove_entries[(MAX_NUM_RESOLVING_LIST_ENTRIES + 7) / 8]; 1300 #endif 1301 1302 #ifdef ENABLE_CLASSIC_PAIRING_OOB 1303 bool classic_read_local_oob_data; 1304 hci_con_handle_t classic_oob_con_handle; 1305 #endif 1306 1307 #ifdef HAVE_SCO_TRANSPORT 1308 const btstack_sco_transport_t * sco_transport; 1309 #endif 1310 } hci_stack_t; 1311 1312 1313 /* API_START */ 1314 1315 1316 // HCI init and configuration 1317 1318 1319 /** 1320 * @brief Set up HCI. Needs to be called before any other function. 1321 */ 1322 void hci_init(const hci_transport_t *transport, const void *config); 1323 1324 /** 1325 * @brief Configure Bluetooth chipset driver. Has to be called before power on, or right after receiving the local version information. 1326 */ 1327 void hci_set_chipset(const btstack_chipset_t *chipset_driver); 1328 1329 /** 1330 * @brief Enable custom init for chipset driver to send HCI commands before HCI Reset 1331 */ 1332 void hci_enable_custom_pre_init(void); 1333 1334 /** 1335 * @brief Configure Bluetooth hardware control. Has to be called before power on. 1336 * @[aram hardware_control implementation 1337 */ 1338 void hci_set_control(const btstack_control_t *hardware_control); 1339 1340 #ifdef HAVE_SCO_TRANSPORT 1341 /** 1342 * @brief Set SCO Transport implementation for SCO over PCM mode 1343 * @param sco_transport that sends SCO over I2S or PCM interface 1344 */ 1345 void hci_set_sco_transport(const btstack_sco_transport_t *sco_transport); 1346 #endif 1347 1348 #ifdef ENABLE_CLASSIC 1349 /** 1350 * @brief Configure Bluetooth hardware control. Has to be called before power on. 1351 */ 1352 void hci_set_link_key_db(btstack_link_key_db_t const * link_key_db); 1353 #endif 1354 1355 /** 1356 * @brief Set callback for Bluetooth Hardware Error 1357 */ 1358 void hci_set_hardware_error_callback(void (*fn)(uint8_t error)); 1359 1360 /** 1361 * @brief Set Public BD ADDR - passed on to Bluetooth chipset during init if supported in bt_control_h 1362 */ 1363 void hci_set_bd_addr(bd_addr_t addr); 1364 1365 /** 1366 * @brief Configure Voice Setting for use with SCO data in HSP/HFP 1367 */ 1368 void hci_set_sco_voice_setting(uint16_t voice_setting); 1369 1370 /** 1371 * @brief Get SCO Voice Setting 1372 * @return current voice setting 1373 */ 1374 uint16_t hci_get_sco_voice_setting(void); 1375 1376 /** 1377 * @brief Set number of ISO packets to buffer for BIS/CIS 1378 * @param num_packets (default = 1) 1379 */ 1380 void hci_set_num_iso_packets_to_queue(uint8_t num_packets); 1381 1382 /** 1383 * @brief Set inquiry mode: standard, with RSSI, with RSSI + Extended Inquiry Results. Has to be called before power on. 1384 * @param inquriy_mode see bluetooth_defines.h 1385 */ 1386 void hci_set_inquiry_mode(inquiry_mode_t inquriy_mode); 1387 1388 /** 1389 * @brief Requests the change of BTstack power mode. 1390 * @param power_mode 1391 * @return 0 if success, otherwise error 1392 */ 1393 int hci_power_control(HCI_POWER_MODE power_mode); 1394 1395 /** 1396 * @brief Shutdown HCI 1397 */ 1398 void hci_close(void); 1399 1400 1401 // Callback registration 1402 1403 1404 /** 1405 * @brief Add event packet handler. 1406 */ 1407 void hci_add_event_handler(btstack_packet_callback_registration_t * callback_handler); 1408 1409 /** 1410 * @brief Remove event packet handler. 1411 */ 1412 void hci_remove_event_handler(btstack_packet_callback_registration_t * callback_handler); 1413 1414 /** 1415 * @brief Registers a packet handler for ACL data. Used by L2CAP 1416 */ 1417 void hci_register_acl_packet_handler(btstack_packet_handler_t handler); 1418 1419 /** 1420 * @brief Registers a packet handler for SCO data. Used for HSP and HFP profiles. 1421 */ 1422 void hci_register_sco_packet_handler(btstack_packet_handler_t handler); 1423 1424 /** 1425 * @brief Registers a packet handler for ISO data. Used for LE Audio profiles 1426 */ 1427 void hci_register_iso_packet_handler(btstack_packet_handler_t handler); 1428 1429 // Sending HCI Commands 1430 1431 /** 1432 * @brief Check if CMD packet can be sent to controller 1433 * @return true if command can be sent 1434 */ 1435 bool hci_can_send_command_packet_now(void); 1436 1437 /** 1438 * @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. 1439 * @return status 1440 */ 1441 uint8_t hci_send_cmd(const hci_cmd_t * cmd, ...); 1442 1443 1444 // Sending SCO Packets 1445 1446 /** @brief Get SCO packet length for current SCO Voice setting 1447 * @note Using SCO packets of the exact length is required for USB transfer 1448 * @return Length of SCO packets in bytes (not audio frames) incl. 3 byte header 1449 */ 1450 uint16_t hci_get_sco_packet_length(void); 1451 1452 /** 1453 * @brief Request emission of HCI_EVENT_SCO_CAN_SEND_NOW as soon as possible 1454 * @note HCI_EVENT_SCO_CAN_SEND_NOW might be emitted during call to this function 1455 * so packet handler should be ready to handle it 1456 */ 1457 void hci_request_sco_can_send_now_event(void); 1458 1459 /** 1460 * @brief Check HCI packet buffer and if SCO packet can be sent to controller 1461 * @return true if sco packet can be sent 1462 */ 1463 bool hci_can_send_sco_packet_now(void); 1464 1465 /** 1466 * @brief Check if SCO packet can be sent to controller 1467 * @return true if sco packet can be sent 1468 */ 1469 bool hci_can_send_prepared_sco_packet_now(void); 1470 1471 /** 1472 * @brief Send SCO packet prepared in HCI packet buffer 1473 */ 1474 uint8_t hci_send_sco_packet_buffer(int size); 1475 1476 /** 1477 * @brief Request emission of HCI_EVENT_BIS_CAN_SEND_NOW for all BIS as soon as possible 1478 * @param big_handle 1479 * @note HCI_EVENT_ISO_CAN_SEND_NOW might be emitted during call to this function 1480 * so packet handler should be ready to handle it 1481 */ 1482 uint8_t hci_request_bis_can_send_now_events(uint8_t big_handle); 1483 1484 /** 1485 * @brief Request emission of HCI_EVENT_CIS_CAN_SEND_NOW for CIS as soon as possible 1486 * @param cis_con_handle 1487 * @note HCI_EVENT_CIS_CAN_SEND_NOW might be emitted during call to this function 1488 * so packet handler should be ready to handle it 1489 */ 1490 uint8_t hci_request_cis_can_send_now_events(hci_con_handle_t cis_con_handle); 1491 1492 /** 1493 * @brief Send ISO packet prepared in HCI packet buffer 1494 */ 1495 uint8_t hci_send_iso_packet_buffer(uint16_t size); 1496 1497 /** 1498 * Reserves outgoing packet buffer. 1499 * @return true on success 1500 */ 1501 bool hci_reserve_packet_buffer(void); 1502 1503 /** 1504 * Get pointer for outgoing packet buffer 1505 */ 1506 uint8_t* hci_get_outgoing_packet_buffer(void); 1507 1508 /** 1509 * Release outgoing packet buffer\ 1510 * @note only called instead of hci_send_preparared 1511 */ 1512 void hci_release_packet_buffer(void); 1513 1514 /** 1515 * @brief Sets the master/slave policy 1516 * @param policy (0: attempt to become master, 1: let connecting device decide) 1517 */ 1518 void hci_set_master_slave_policy(uint8_t policy); 1519 1520 /* API_END */ 1521 1522 1523 /** 1524 * va_list version of hci_send_cmd, call hci_send_cmd_packet 1525 * @return status 1526 */ 1527 uint8_t hci_send_cmd_va_arg(const hci_cmd_t * cmd, va_list argptr); 1528 1529 /** 1530 * Get connection iterator. Only used by l2cap.c and sm.c 1531 */ 1532 void hci_connections_get_iterator(btstack_linked_list_iterator_t *it); 1533 1534 /** 1535 * Get internal hci_connection_t for given handle. Used by L2CAP, SM, daemon 1536 */ 1537 hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle); 1538 1539 /** 1540 * Get internal hci_connection_t for given Bluetooth addres. Called by L2CAP 1541 */ 1542 hci_connection_t * hci_connection_for_bd_addr_and_type(const bd_addr_t addr, bd_addr_type_t addr_type); 1543 1544 /** 1545 * Check if outgoing packet buffer is reserved. Used for internal checks in l2cap.c 1546 * @return true if packet buffer is reserved 1547 */ 1548 bool hci_is_packet_buffer_reserved(void); 1549 1550 /** 1551 * Check hci packet buffer is free and a classic acl packet can be sent to controller 1552 * @return true if ACL Classic packet can be sent now 1553 */ 1554 bool hci_can_send_acl_classic_packet_now(void); 1555 1556 /** 1557 * Check hci packet buffer is free and an LE acl packet can be sent to controller 1558 * @return true if ACL LE packet can be sent now 1559 */ 1560 bool hci_can_send_acl_le_packet_now(void); 1561 1562 /** 1563 * Check hci packet buffer is free and an acl packet for the given handle can be sent to controller 1564 * @return true if ACL packet for con_handle can be sent now 1565 */ 1566 bool hci_can_send_acl_packet_now(hci_con_handle_t con_handle); 1567 1568 /** 1569 * Check if acl packet for the given handle can be sent to controller 1570 * @return true if ACL packet for con_handle can be sent now 1571 */ 1572 bool hci_can_send_prepared_acl_packet_now(hci_con_handle_t con_handle); 1573 1574 /** 1575 * Send acl packet prepared in hci packet buffer 1576 * @return status 1577 */ 1578 uint8_t hci_send_acl_packet_buffer(int size); 1579 1580 /** 1581 * Check if authentication is active. It delays automatic disconnect while no L2CAP connection 1582 * Called by l2cap. 1583 */ 1584 bool hci_authentication_active_for_handle(hci_con_handle_t handle); 1585 1586 /** 1587 * Get maximal ACL Classic data packet length based on used buffer size. Called by L2CAP 1588 */ 1589 uint16_t hci_max_acl_data_packet_length(void); 1590 1591 /** 1592 * Get supported ACL packet types. Already flipped for create connection. Called by L2CAP 1593 */ 1594 uint16_t hci_usable_acl_packet_types(void); 1595 1596 /** 1597 * Get supported SCO packet types. Not flipped. Called by HFP 1598 */ 1599 uint16_t hci_usable_sco_packet_types(void); 1600 1601 /** 1602 * Check if ACL packets marked as non flushable can be sent. Called by L2CAP 1603 */ 1604 bool hci_non_flushable_packet_boundary_flag_supported(void); 1605 1606 /** 1607 * Return current automatic flush timeout setting 1608 */ 1609 uint16_t hci_automatic_flush_timeout(void); 1610 1611 /** 1612 * Check if remote supported features query has completed 1613 */ 1614 bool hci_remote_features_available(hci_con_handle_t con_handle); 1615 1616 /** 1617 * Trigger remote supported features query 1618 */ 1619 void hci_remote_features_query(hci_con_handle_t con_handle); 1620 1621 /** 1622 * Check if extended SCO Link is supported 1623 */ 1624 bool hci_extended_sco_link_supported(void); 1625 1626 /** 1627 * Check if SSP is supported on both sides. Called by L2CAP 1628 */ 1629 bool gap_ssp_supported_on_both_sides(hci_con_handle_t handle); 1630 1631 /** 1632 * Disconn because of security block. Called by L2CAP 1633 */ 1634 void hci_disconnect_security_block(hci_con_handle_t con_handle); 1635 1636 /** 1637 * Query if remote side supports eSCO 1638 * @param con_handle 1639 */ 1640 bool hci_remote_esco_supported(hci_con_handle_t con_handle); 1641 1642 /** 1643 * Query remote supported SCO packets based on remote supported features 1644 * @param con_handle 1645 */ 1646 uint16_t hci_remote_sco_packet_types(hci_con_handle_t con_handle); 1647 1648 /** 1649 * Emit current HCI state. Called by daemon 1650 */ 1651 void hci_emit_state(void); 1652 1653 /** 1654 * Send complete CMD packet. Called by daemon and hci_send_cmd_va_arg 1655 * @return status 1656 */ 1657 uint8_t hci_send_cmd_packet(uint8_t *packet, int size); 1658 1659 /** 1660 * Disconnect all HCI connections. Called by daemon 1661 */ 1662 void hci_disconnect_all(void); 1663 1664 /** 1665 * Get number of free acl slots for packets of given handle. Called by daemon 1666 */ 1667 int hci_number_free_acl_slots_for_handle(hci_con_handle_t con_handle); 1668 1669 /** 1670 * @brief Set Advertisement Parameters 1671 * @param adv_int_min 1672 * @param adv_int_max 1673 * @param adv_type 1674 * @param direct_address_type 1675 * @param direct_address 1676 * @param channel_map 1677 * @param filter_policy 1678 * 1679 * @note internal use. use gap_advertisements_set_params from gap.h instead. 1680 */ 1681 void hci_le_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 1682 uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy); 1683 1684 /** 1685 * 1686 * @note internal use. use gap_random_address_set_mode from gap.h instead. 1687 */ 1688 void hci_le_set_own_address_type(uint8_t own_address_type); 1689 1690 /** 1691 * @naote internal use. use gap_random_address_set from gap.h instead 1692 */ 1693 void hci_le_random_address_set(const bd_addr_t random_address); 1694 1695 /** 1696 * @note internal use by sm 1697 */ 1698 void hci_load_le_device_db_entry_into_resolving_list(uint16_t le_device_db_index); 1699 1700 /** 1701 * @note internal use by sm 1702 */ 1703 void hci_remove_le_device_db_entry_from_resolving_list(uint16_t le_device_db_index); 1704 1705 /** 1706 * @note internal use 1707 */ 1708 uint16_t hci_number_free_acl_slots_for_connection_type(bd_addr_type_t address_type); 1709 1710 /** 1711 * @brief Clear Periodic Advertiser List 1712 * @return status 1713 */ 1714 uint8_t gap_periodic_advertiser_list_clear(void); 1715 1716 /** 1717 * @brief Add entry to Periodic Advertiser List 1718 * @param address_type 1719 * @param address 1720 * @param advertising_sid 1721 * @return 1722 */ 1723 uint8_t gap_periodic_advertiser_list_add(bd_addr_type_t address_type, const bd_addr_t address, uint8_t advertising_sid); 1724 1725 /** 1726 * Remove entry from Periodic Advertising List 1727 * @param address_type 1728 * @param address 1729 * @param advertising_sid 1730 * @return 1731 */ 1732 uint8_t gap_periodic_advertiser_list_remove(bd_addr_type_t address_type, const bd_addr_t address, uint8_t advertising_sid); 1733 1734 /** 1735 * @brief Synchronize with a periodic advertising train from an advertiser and begin receiving periodic advertising packets. 1736 * @param options 1737 * @param advertising_sid 1738 * @param advertiser_address_type 1739 * @param advertiser_address 1740 * @param skip 1741 * @param sync_timeout 1742 * @param sync_cte_type 1743 * @return 1744 */ 1745 uint8_t gap_periodic_advertising_create_sync(uint8_t options, uint8_t advertising_sid, bd_addr_type_t advertiser_address_type, 1746 bd_addr_t advertiser_address, uint16_t skip, uint16_t sync_timeout, uint8_t sync_cte_type); 1747 1748 /** 1749 * @brief Cancel sync periodic advertising train while it is pending. 1750 * @return status 1751 */ 1752 uint8_t gap_periodic_advertising_create_sync_cancel(void); 1753 1754 /** 1755 * @biref Stop reception of the periodic advertising train 1756 * @param sync_handle 1757 * @return status 1758 */ 1759 uint8_t gap_periodic_advertising_terminate_sync(uint16_t sync_handle); 1760 1761 /** 1762 * @brief Get Controller Manufacturer 1763 * @returns company_id - see bluetooth_company_id.h 1764 */ 1765 uint16_t hci_get_manufacturer(void); 1766 1767 /** 1768 * Get Classic Allow Role Switch param 1769 */ 1770 uint8_t hci_get_allow_role_switch(void); 1771 1772 /** 1773 * Get state 1774 */ 1775 HCI_STATE hci_get_state(void); 1776 1777 /** 1778 * @brief De-Init HCI 1779 */ 1780 void hci_deinit(void); 1781 1782 // defer disconnect on dedicated bonding complete, used internally for CTKD 1783 uint8_t hci_dedicated_bonding_defer_disconnect(hci_con_handle_t con_handle, bool defer); 1784 1785 // Only for PTS testing 1786 1787 // Disable automatic L2CAP disconnect if no L2CAP connection is established 1788 void hci_disable_l2cap_timeout_check(void); 1789 1790 // setup test connections, used for fuzzing 1791 void hci_setup_test_connections_fuzz(void); 1792 1793 // free all connections, used for fuzzing 1794 void hci_free_connections_fuzz(void); 1795 1796 // simulate stack bootup 1797 void hci_simulate_working_fuzz(void); 1798 1799 1800 #if defined __cplusplus 1801 } 1802 #endif 1803 1804 #endif // HCI_H 1805