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