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