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