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