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 MATTHIAS 24 * RINGWALD 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 * hci.h 40 * 41 * Created by Matthias Ringwald on 4/29/09. 42 * 43 */ 44 45 #ifndef __HCI_H 46 #define __HCI_H 47 48 #include "btstack_config.h" 49 50 #include "btstack_chipset.h" 51 #include "btstack_control.h" 52 #include "btstack_linked_list.h" 53 #include "btstack_util.h" 54 #include "classic/btstack_link_key_db.h" 55 #include "hci_cmd.h" 56 #include "gap.h" 57 #include "hci_transport.h" 58 59 #ifdef ENABLE_BLE 60 #include "ble/att_db.h" 61 #endif 62 63 #include <stdint.h> 64 #include <stdlib.h> 65 #include <stdarg.h> 66 67 #if defined __cplusplus 68 extern "C" { 69 #endif 70 71 // packet buffer sizes 72 73 // Max HCI Command LE payload size: 74 // 64 from LE Generate DHKey command 75 // 32 from LE Encrypt command 76 #if defined(ENABLE_LE_SECURE_CONNECTIONS) && !defined(ENABLE_MICRO_ECC_FOR_LE_SECURE_CONNECTIONS) 77 #define HCI_CMD_PAYLOAD_SIZE_LE 64 78 #else 79 #define HCI_CMD_PAYLOAD_SIZE_LE 32 80 #endif 81 82 // HCI_ACL_PAYLOAD_SIZE is configurable and defined in config.h 83 // addition byte in even to terminate remote name request with '\0' 84 #define HCI_EVENT_BUFFER_SIZE (HCI_EVENT_HEADER_SIZE + HCI_EVENT_PAYLOAD_SIZE + 1) 85 86 #ifdef ENABLE_CLASSIC 87 #define HCI_CMD_BUFFER_SIZE (HCI_CMD_HEADER_SIZE + HCI_CMD_PAYLOAD_SIZE) 88 #else 89 #define HCI_CMD_BUFFER_SIZE (HCI_CMD_HEADER_SIZE + HCI_CMD_PAYLOAD_SIZE_LE) 90 #endif 91 92 #define HCI_ACL_BUFFER_SIZE (HCI_ACL_HEADER_SIZE + HCI_ACL_PAYLOAD_SIZE) 93 94 // size of hci buffers, big enough for command, event, or acl packet without H4 packet type 95 // @note cmd buffer is bigger than event buffer 96 #ifdef HCI_PACKET_BUFFER_SIZE 97 #if HCI_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE 98 #error HCI_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE 99 #endif 100 #if HCI_PACKET_BUFFER_SIZE < HCI_CMD_BUFFER_SIZE 101 #error HCI_PACKET_BUFFER_SIZE must be equal or larger than HCI_CMD_BUFFER_SIZE 102 #endif 103 #else 104 #if HCI_ACL_BUFFER_SIZE > HCI_CMD_BUFFER_SIZE 105 #define HCI_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE 106 #else 107 #define HCI_PACKET_BUFFER_SIZE HCI_CMD_BUFFER_SIZE 108 #endif 109 #endif 110 111 // additional pre-buffer space for packets to Bluetooth module, for now, used for HCI Transport H4 DMA 112 #ifdef HAVE_HOST_CONTROLLER_API 113 #define HCI_OUTGOING_PRE_BUFFER_SIZE 0 114 #else 115 #define HCI_OUTGOING_PRE_BUFFER_SIZE 1 116 #endif 117 118 // BNEP may uncompress the IP Header by 16 bytes 119 #ifndef HCI_INCOMING_PRE_BUFFER_SIZE 120 #ifdef ENABLE_CLASSIC 121 #define HCI_INCOMING_PRE_BUFFER_SIZE (16 - HCI_ACL_HEADER_SIZE - 4) 122 #else 123 #define HCI_INCOMING_PRE_BUFFER_SIZE 0 124 #endif 125 #endif 126 127 // 128 #define IS_COMMAND(packet, command) (little_endian_read_16(packet,0) == command.opcode) 129 130 // check if command complete event for given command 131 #define HCI_EVENT_IS_COMMAND_COMPLETE(event,cmd) ( event[0] == HCI_EVENT_COMMAND_COMPLETE && little_endian_read_16(event,3) == cmd.opcode) 132 #define HCI_EVENT_IS_COMMAND_STATUS(event,cmd) ( event[0] == HCI_EVENT_COMMAND_STATUS && little_endian_read_16(event,4) == cmd.opcode) 133 134 // Code+Len=2, Pkts+Opcode=3; total=5 135 #define OFFSET_OF_DATA_IN_COMMAND_COMPLETE 5 136 137 // ACL Packet 138 #define READ_ACL_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff) 139 #define READ_SCO_CONNECTION_HANDLE( buffer ) ( little_endian_read_16(buffer,0) & 0x0fff) 140 #define READ_ACL_FLAGS( buffer ) ( buffer[1] >> 4 ) 141 #define READ_ACL_LENGTH( buffer ) (little_endian_read_16(buffer, 2)) 142 143 // Sneak peak into L2CAP Packet 144 #define READ_L2CAP_LENGTH(buffer) ( little_endian_read_16(buffer, 4)) 145 #define READ_L2CAP_CHANNEL_ID(buffer) ( little_endian_read_16(buffer, 6)) 146 147 /** 148 * LE connection parameter update state 149 */ 150 151 typedef enum { 152 CON_PARAMETER_UPDATE_NONE, 153 CON_PARAMETER_UPDATE_SEND_REQUEST, 154 CON_PARAMETER_UPDATE_SEND_RESPONSE, 155 CON_PARAMETER_UPDATE_CHANGE_HCI_CON_PARAMETERS, 156 CON_PARAMETER_UPDATE_DENY 157 } le_con_parameter_update_state_t; 158 159 // Authentication flags 160 typedef enum { 161 AUTH_FLAGS_NONE = 0x0000, 162 RECV_LINK_KEY_REQUEST = 0x0001, 163 HANDLE_LINK_KEY_REQUEST = 0x0002, 164 SENT_LINK_KEY_REPLY = 0x0004, 165 SENT_LINK_KEY_NEGATIVE_REQUEST = 0x0008, 166 RECV_LINK_KEY_NOTIFICATION = 0x0010, 167 DENY_PIN_CODE_REQUEST = 0x0040, 168 RECV_IO_CAPABILITIES_REQUEST = 0x0080, 169 SEND_IO_CAPABILITIES_REPLY = 0x0100, 170 SEND_USER_CONFIRM_REPLY = 0x0200, 171 SEND_USER_PASSKEY_REPLY = 0x0400, 172 173 // pairing status 174 LEGACY_PAIRING_ACTIVE = 0x2000, 175 SSP_PAIRING_ACTIVE = 0x4000, 176 177 // connection status 178 CONNECTION_ENCRYPTED = 0x8000, 179 } hci_authentication_flags_t; 180 181 /** 182 * Connection State 183 */ 184 typedef enum { 185 SEND_CREATE_CONNECTION = 0, 186 SENT_CREATE_CONNECTION, 187 SEND_CANCEL_CONNECTION, 188 SENT_CANCEL_CONNECTION, 189 RECEIVED_CONNECTION_REQUEST, 190 ACCEPTED_CONNECTION_REQUEST, 191 REJECTED_CONNECTION_REQUEST, 192 OPEN, 193 SEND_DISCONNECT, 194 SENT_DISCONNECT, 195 RECEIVED_DISCONNECTION_COMPLETE 196 } CONNECTION_STATE; 197 198 // bonding flags 199 enum { 200 BONDING_REQUEST_REMOTE_FEATURES = 0x01, 201 BONDING_RECEIVED_REMOTE_FEATURES = 0x02, 202 BONDING_REMOTE_SUPPORTS_SSP = 0x04, 203 BONDING_DISCONNECT_SECURITY_BLOCK = 0x08, 204 BONDING_DISCONNECT_DEDICATED_DONE = 0x10, 205 BONDING_SEND_AUTHENTICATE_REQUEST = 0x20, 206 BONDING_SEND_ENCRYPTION_REQUEST = 0x40, 207 BONDING_DEDICATED = 0x80, 208 BONDING_EMIT_COMPLETE_ON_DISCONNECT = 0x100 209 }; 210 211 typedef enum { 212 BLUETOOTH_OFF = 1, 213 BLUETOOTH_ON, 214 BLUETOOTH_ACTIVE 215 } BLUETOOTH_STATE; 216 217 typedef enum { 218 LE_CONNECTING_IDLE, 219 LE_CONNECTING_DIRECT, 220 LE_CONNECTING_WHITELIST, 221 } le_connecting_state_t; 222 223 #ifdef ENABLE_BLE 224 225 // 226 // SM internal types and globals 227 // 228 229 typedef enum { 230 231 // general states 232 // state = 0 233 SM_GENERAL_IDLE, 234 SM_GENERAL_SEND_PAIRING_FAILED, 235 SM_GENERAL_TIMEOUT, // no other security messages are exchanged 236 237 // Phase 1: Pairing Feature Exchange 238 SM_PH1_W4_USER_RESPONSE, 239 240 // Phase 2: Authenticating and Encrypting 241 242 // get random number for use as TK Passkey if we show it 243 SM_PH2_GET_RANDOM_TK, 244 SM_PH2_W4_RANDOM_TK, 245 246 // get local random number for confirm c1 247 SM_PH2_C1_GET_RANDOM_A, 248 SM_PH2_C1_W4_RANDOM_A, 249 SM_PH2_C1_GET_RANDOM_B, 250 SM_PH2_C1_W4_RANDOM_B, 251 252 // calculate confirm value for local side 253 // state = 10 254 SM_PH2_C1_GET_ENC_A, 255 SM_PH2_C1_W4_ENC_A, 256 SM_PH2_C1_GET_ENC_B, 257 SM_PH2_C1_W4_ENC_B, 258 259 // calculate confirm value for remote side 260 SM_PH2_C1_GET_ENC_C, 261 SM_PH2_C1_W4_ENC_C, 262 SM_PH2_C1_GET_ENC_D, 263 SM_PH2_C1_W4_ENC_D, 264 265 SM_PH2_C1_SEND_PAIRING_CONFIRM, 266 SM_PH2_SEND_PAIRING_RANDOM, 267 268 // calc STK 269 // state = 20 270 SM_PH2_CALC_STK, 271 SM_PH2_W4_STK, 272 273 SM_PH2_W4_CONNECTION_ENCRYPTED, 274 275 // Phase 3: Transport Specific Key Distribution 276 // calculate DHK, Y, EDIV, and LTK 277 SM_PH3_GET_RANDOM, 278 SM_PH3_W4_RANDOM, 279 SM_PH3_GET_DIV, 280 SM_PH3_W4_DIV, 281 SM_PH3_Y_GET_ENC, 282 SM_PH3_Y_W4_ENC, 283 SM_PH3_LTK_GET_ENC, 284 // state = 30 285 SM_PH3_LTK_W4_ENC, 286 SM_PH3_CSRK_GET_ENC, 287 SM_PH3_CSRK_W4_ENC, 288 289 // exchange keys 290 SM_PH3_DISTRIBUTE_KEYS, 291 SM_PH3_RECEIVE_KEYS, 292 293 // RESPONDER ROLE 294 // state = 35 295 SM_RESPONDER_IDLE, 296 SM_RESPONDER_SEND_SECURITY_REQUEST, 297 SM_RESPONDER_PH0_RECEIVED_LTK_REQUEST, 298 SM_RESPONDER_PH0_RECEIVED_LTK_W4_IRK, 299 SM_RESPONDER_PH0_SEND_LTK_REQUESTED_NEGATIVE_REPLY, 300 SM_RESPONDER_PH1_W4_PAIRING_REQUEST, 301 SM_RESPONDER_PH1_PAIRING_REQUEST_RECEIVED, 302 SM_RESPONDER_PH1_SEND_PAIRING_RESPONSE, 303 SM_RESPONDER_PH1_W4_PAIRING_CONFIRM, 304 SM_RESPONDER_PH2_W4_PAIRING_RANDOM, 305 SM_RESPONDER_PH2_W4_LTK_REQUEST, 306 SM_RESPONDER_PH2_SEND_LTK_REPLY, 307 308 // Phase 4: re-establish previously distributed LTK 309 // state == 46 310 SM_RESPONDER_PH4_Y_GET_ENC, 311 SM_RESPONDER_PH4_Y_W4_ENC, 312 SM_RESPONDER_PH4_LTK_GET_ENC, 313 SM_RESPONDER_PH4_LTK_W4_ENC, 314 SM_RESPONDER_PH4_SEND_LTK_REPLY, 315 316 // INITITIATOR ROLE 317 // state = 51 318 SM_INITIATOR_CONNECTED, 319 SM_INITIATOR_PH0_HAS_LTK, 320 SM_INITIATOR_PH0_SEND_START_ENCRYPTION, 321 SM_INITIATOR_PH0_W4_CONNECTION_ENCRYPTED, 322 SM_INITIATOR_PH1_W2_SEND_PAIRING_REQUEST, 323 SM_INITIATOR_PH1_SEND_PAIRING_REQUEST, 324 SM_INITIATOR_PH1_W4_PAIRING_RESPONSE, 325 SM_INITIATOR_PH2_W4_PAIRING_CONFIRM, 326 SM_INITIATOR_PH2_W4_PAIRING_RANDOM, 327 SM_INITIATOR_PH3_SEND_START_ENCRYPTION, 328 329 // LE Secure Connections 330 SM_SC_RECEIVED_LTK_REQUEST, 331 SM_SC_SEND_PUBLIC_KEY_COMMAND, 332 SM_SC_W4_PUBLIC_KEY_COMMAND, 333 SM_SC_W2_GET_RANDOM_A, 334 SM_SC_W4_GET_RANDOM_A, 335 SM_SC_W2_GET_RANDOM_B, 336 SM_SC_W4_GET_RANDOM_B, 337 SM_SC_W2_CMAC_FOR_CONFIRMATION, 338 SM_SC_W4_CMAC_FOR_CONFIRMATION, 339 SM_SC_SEND_CONFIRMATION, 340 SM_SC_W2_CMAC_FOR_CHECK_CONFIRMATION, 341 SM_SC_W4_CMAC_FOR_CHECK_CONFIRMATION, 342 SM_SC_W4_CONFIRMATION, 343 SM_SC_SEND_PAIRING_RANDOM, 344 SM_SC_W4_PAIRING_RANDOM, 345 SM_SC_W2_CALCULATE_G2, 346 SM_SC_W4_CALCULATE_G2, 347 SM_SC_W4_CALCULATE_DHKEY, 348 SM_SC_W2_CALCULATE_F5_SALT, 349 SM_SC_W4_CALCULATE_F5_SALT, 350 SM_SC_W2_CALCULATE_F5_MACKEY, 351 SM_SC_W4_CALCULATE_F5_MACKEY, 352 SM_SC_W2_CALCULATE_F5_LTK, 353 SM_SC_W4_CALCULATE_F5_LTK, 354 SM_SC_W2_CALCULATE_F6_FOR_DHKEY_CHECK, 355 SM_SC_W4_CALCULATE_F6_FOR_DHKEY_CHECK, 356 SM_SC_W2_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK, 357 SM_SC_W4_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK, 358 SM_SC_W4_USER_RESPONSE, 359 SM_SC_SEND_DHKEY_CHECK_COMMAND, 360 SM_SC_W4_DHKEY_CHECK_COMMAND, 361 SM_SC_W4_LTK_REQUEST_SC, 362 SM_SC_W2_CALCULATE_H6_ILK, 363 SM_SC_W4_CALCULATE_H6_ILK, 364 SM_SC_W2_CALCULATE_H6_BR_EDR_LINK_KEY, 365 SM_SC_W4_CALCULATE_H6_BR_EDR_LINK_KEY, 366 } security_manager_state_t; 367 368 typedef enum { 369 IRK_LOOKUP_IDLE, 370 IRK_LOOKUP_W4_READY, 371 IRK_LOOKUP_STARTED, 372 IRK_LOOKUP_SUCCEEDED, 373 IRK_LOOKUP_FAILED 374 } irk_lookup_state_t; 375 376 typedef uint8_t sm_pairing_packet_t[7]; 377 378 // connection info available as long as connection exists 379 typedef struct sm_connection { 380 hci_con_handle_t sm_handle; 381 uint8_t sm_role; // 0 - IamMaster, 1 = IamSlave 382 uint8_t sm_security_request_received; 383 uint8_t sm_bonding_requested; 384 uint8_t sm_peer_addr_type; 385 bd_addr_t sm_peer_address; 386 security_manager_state_t sm_engine_state; 387 irk_lookup_state_t sm_irk_lookup_state; 388 uint8_t sm_connection_encrypted; 389 uint8_t sm_connection_authenticated; // [0..1] 390 uint8_t sm_actual_encryption_key_size; 391 sm_pairing_packet_t sm_m_preq; // only used during c1 392 authorization_state_t sm_connection_authorization_state; 393 uint16_t sm_local_ediv; 394 uint8_t sm_local_rand[8]; 395 int sm_le_db_index; 396 } sm_connection_t; 397 398 // 399 // ATT Server 400 // 401 402 // max ATT request matches L2CAP PDU -- allow to use smaller buffer 403 #ifndef ATT_REQUEST_BUFFER_SIZE 404 #define ATT_REQUEST_BUFFER_SIZE HCI_ACL_PAYLOAD_SIZE 405 #endif 406 407 typedef enum { 408 ATT_SERVER_IDLE, 409 ATT_SERVER_REQUEST_RECEIVED, 410 ATT_SERVER_W4_SIGNED_WRITE_VALIDATION, 411 ATT_SERVER_REQUEST_RECEIVED_AND_VALIDATED, 412 ATT_SERVER_READ_RESPONSE_PENDING, 413 } att_server_state_t; 414 415 typedef struct { 416 att_server_state_t state; 417 418 uint8_t peer_addr_type; 419 bd_addr_t peer_address; 420 421 int ir_le_device_db_index; 422 uint8_t ir_lookup_active; 423 uint8_t pairing_active; 424 425 int value_indication_handle; 426 btstack_timer_source_t value_indication_timer; 427 428 att_connection_t connection; 429 430 uint16_t request_size; 431 uint8_t request_buffer[ATT_REQUEST_BUFFER_SIZE]; 432 433 } att_server_t; 434 435 #endif 436 437 #ifdef ENABLE_L2CAP_ENHANCED_RETRANSMISSION_MODE 438 typedef enum { 439 L2CAP_INFORMATION_STATE_IDLE = 0, 440 L2CAP_INFORMATION_STATE_W2_SEND_EXTENDED_FEATURE_REQUEST, 441 L2CAP_INFORMATION_STATE_W4_EXTENDED_FEATURE_RESPONSE, 442 L2CAP_INFORMATION_STATE_DONE 443 } l2cap_information_state_t; 444 445 typedef struct { 446 l2cap_information_state_t information_state; 447 uint16_t extended_feature_mask; 448 } l2cap_state_t; 449 #endif 450 451 // 452 typedef struct { 453 // linked list - assert: first field 454 btstack_linked_item_t item; 455 456 // remote side 457 bd_addr_t address; 458 459 // module handle 460 hci_con_handle_t con_handle; 461 462 // le public, le random, classic 463 bd_addr_type_t address_type; 464 465 // role: 0 - master, 1 - slave 466 uint8_t role; 467 468 // connection state 469 CONNECTION_STATE state; 470 471 // bonding 472 uint16_t bonding_flags; 473 uint8_t bonding_status; 474 // requested security level 475 gap_security_level_t requested_security_level; 476 477 // 478 link_key_type_t link_key_type; 479 480 // remote supported features 481 uint8_t remote_supported_feature_eSCO; 482 483 // errands 484 uint32_t authentication_flags; 485 486 btstack_timer_source_t timeout; 487 488 // timeout in system ticks (HAVE_EMBEDDED_TICK) or milliseconds (HAVE_EMBEDDED_TIME_MS) 489 uint32_t timestamp; 490 491 // ACL packet recombination - PRE_BUFFER + ACL Header + ACL payload 492 uint8_t acl_recombination_buffer[HCI_INCOMING_PRE_BUFFER_SIZE + 4 + HCI_ACL_BUFFER_SIZE]; 493 uint16_t acl_recombination_pos; 494 uint16_t acl_recombination_length; 495 496 // number packets sent to controller 497 uint8_t num_acl_packets_sent; 498 uint8_t num_sco_packets_sent; 499 500 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 501 uint8_t num_packets_completed; 502 #endif 503 504 // LE Connection parameter update 505 le_con_parameter_update_state_t le_con_parameter_update_state; 506 uint8_t le_con_param_update_identifier; 507 uint16_t le_conn_interval_min; 508 uint16_t le_conn_interval_max; 509 uint16_t le_conn_latency; 510 uint16_t le_supervision_timeout; 511 512 #ifdef ENABLE_BLE 513 // LE Security Manager 514 sm_connection_t sm_connection; 515 516 // ATT Server 517 att_server_t att_server; 518 #endif 519 520 #ifdef ENABLE_L2CAP_ENHANCED_RETRANSMISSION_MODE 521 l2cap_state_t l2cap_state; 522 #endif 523 524 } hci_connection_t; 525 526 527 /** 528 * HCI Inititizlization State Machine 529 */ 530 typedef enum hci_init_state{ 531 HCI_INIT_SEND_RESET = 0, 532 HCI_INIT_W4_SEND_RESET, 533 HCI_INIT_SEND_READ_LOCAL_VERSION_INFORMATION, 534 HCI_INIT_W4_SEND_READ_LOCAL_VERSION_INFORMATION, 535 HCI_INIT_SEND_READ_LOCAL_NAME, 536 HCI_INIT_W4_SEND_READ_LOCAL_NAME, 537 538 HCI_INIT_SEND_BAUD_CHANGE, 539 HCI_INIT_W4_SEND_BAUD_CHANGE, 540 HCI_INIT_CUSTOM_INIT, 541 HCI_INIT_W4_CUSTOM_INIT, 542 HCI_INIT_SEND_RESET_CSR_WARM_BOOT, 543 HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT, 544 HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT_LINK_RESET, 545 HCI_INIT_W4_CUSTOM_INIT_BCM_DELAY, 546 547 HCI_INIT_READ_LOCAL_SUPPORTED_COMMANDS, 548 HCI_INIT_W4_READ_LOCAL_SUPPORTED_COMMANDS, 549 550 HCI_INIT_SEND_BAUD_CHANGE_BCM, 551 HCI_INIT_W4_SEND_BAUD_CHANGE_BCM, 552 553 HCI_INIT_SET_BD_ADDR, 554 HCI_INIT_W4_SET_BD_ADDR, 555 556 HCI_INIT_SEND_RESET_ST_WARM_BOOT, 557 HCI_INIT_W4_SEND_RESET_ST_WARM_BOOT, 558 559 HCI_INIT_READ_BD_ADDR, 560 HCI_INIT_W4_READ_BD_ADDR, 561 562 HCI_INIT_READ_BUFFER_SIZE, 563 HCI_INIT_W4_READ_BUFFER_SIZE, 564 HCI_INIT_READ_LOCAL_SUPPORTED_FEATURES, 565 HCI_INIT_W4_READ_LOCAL_SUPPORTED_FEATURES, 566 567 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 568 HCI_INIT_HOST_BUFFER_SIZE, 569 HCI_INIT_W4_HOST_BUFFER_SIZE, 570 HCI_INIT_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, 571 HCI_INIT_W4_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, 572 #endif 573 574 HCI_INIT_SET_EVENT_MASK, 575 HCI_INIT_W4_SET_EVENT_MASK, 576 577 HCI_INIT_WRITE_SIMPLE_PAIRING_MODE, 578 HCI_INIT_W4_WRITE_SIMPLE_PAIRING_MODE, 579 HCI_INIT_WRITE_PAGE_TIMEOUT, 580 HCI_INIT_W4_WRITE_PAGE_TIMEOUT, 581 HCI_INIT_WRITE_CLASS_OF_DEVICE, 582 HCI_INIT_W4_WRITE_CLASS_OF_DEVICE, 583 HCI_INIT_WRITE_LOCAL_NAME, 584 HCI_INIT_W4_WRITE_LOCAL_NAME, 585 HCI_INIT_WRITE_EIR_DATA, 586 HCI_INIT_W4_WRITE_EIR_DATA, 587 HCI_INIT_WRITE_INQUIRY_MODE, 588 HCI_INIT_W4_WRITE_INQUIRY_MODE, 589 HCI_INIT_WRITE_SCAN_ENABLE, 590 HCI_INIT_W4_WRITE_SCAN_ENABLE, 591 592 // SCO over HCI 593 HCI_INIT_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 594 HCI_INIT_W4_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 595 HCI_INIT_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 596 HCI_INIT_W4_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 597 598 // SCO over HCI Broadcom 599 HCI_INIT_BCM_WRITE_SCO_PCM_INT, 600 HCI_INIT_W4_BCM_WRITE_SCO_PCM_INT, 601 602 #ifdef ENABLE_BLE 603 HCI_INIT_LE_READ_BUFFER_SIZE, 604 HCI_INIT_W4_LE_READ_BUFFER_SIZE, 605 HCI_INIT_WRITE_LE_HOST_SUPPORTED, 606 HCI_INIT_W4_WRITE_LE_HOST_SUPPORTED, 607 HCI_INIT_LE_SET_EVENT_MASK, 608 HCI_INIT_W4_LE_SET_EVENT_MASK, 609 #endif 610 611 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION 612 HCI_INIT_LE_READ_MAX_DATA_LENGTH, 613 HCI_INIT_W4_LE_READ_MAX_DATA_LENGTH, 614 HCI_INIT_LE_WRITE_SUGGESTED_DATA_LENGTH, 615 HCI_INIT_W4_LE_WRITE_SUGGESTED_DATA_LENGTH, 616 #endif 617 618 #ifdef ENABLE_LE_CENTRAL 619 HCI_INIT_READ_WHITE_LIST_SIZE, 620 HCI_INIT_W4_READ_WHITE_LIST_SIZE, 621 622 HCI_INIT_LE_SET_SCAN_PARAMETERS, 623 HCI_INIT_W4_LE_SET_SCAN_PARAMETERS, 624 #endif 625 626 HCI_INIT_DONE, 627 628 HCI_FALLING_ASLEEP_DISCONNECT, 629 HCI_FALLING_ASLEEP_W4_WRITE_SCAN_ENABLE, 630 HCI_FALLING_ASLEEP_COMPLETE, 631 632 HCI_INIT_AFTER_SLEEP 633 634 } hci_substate_t; 635 636 enum { 637 LE_ADVERTISEMENT_TASKS_DISABLE = 1 << 0, 638 LE_ADVERTISEMENT_TASKS_SET_ADV_DATA = 1 << 1, 639 LE_ADVERTISEMENT_TASKS_SET_SCAN_DATA = 1 << 2, 640 LE_ADVERTISEMENT_TASKS_SET_PARAMS = 1 << 3, 641 LE_ADVERTISEMENT_TASKS_ENABLE = 1 << 4, 642 }; 643 644 enum { 645 LE_WHITELIST_ON_CONTROLLER = 1 << 0, 646 LE_WHITELIST_ADD_TO_CONTROLLER = 1 << 1, 647 LE_WHITELIST_REMOVE_FROM_CONTROLLER = 1 << 2, 648 }; 649 650 typedef struct { 651 btstack_linked_item_t item; 652 bd_addr_t address; 653 bd_addr_type_t address_type; 654 uint8_t state; 655 } whitelist_entry_t; 656 657 /** 658 * main data structure 659 */ 660 typedef struct { 661 // transport component with configuration 662 const hci_transport_t * hci_transport; 663 const void * config; 664 665 // chipset driver 666 const btstack_chipset_t * chipset; 667 668 // hardware power controller 669 const btstack_control_t * control; 670 671 /* link key db */ 672 const btstack_link_key_db_t * link_key_db; 673 674 // list of existing baseband connections 675 btstack_linked_list_t connections; 676 677 /* callback to L2CAP layer */ 678 btstack_packet_handler_t acl_packet_handler; 679 680 /* callback for SCO data */ 681 btstack_packet_handler_t sco_packet_handler; 682 683 /* callbacks for events */ 684 btstack_linked_list_t event_handlers; 685 686 // hardware error callback 687 void (*hardware_error_callback)(uint8_t error); 688 689 // basic configuration 690 const char * local_name; 691 const uint8_t * eir_data; 692 uint32_t class_of_device; 693 bd_addr_t local_bd_addr; 694 uint8_t ssp_enable; 695 uint8_t ssp_io_capability; 696 uint8_t ssp_authentication_requirement; 697 uint8_t ssp_auto_accept; 698 inquiry_mode_t inquiry_mode; 699 700 // single buffer for HCI packet assembly + additional prebuffer for H4 drivers 701 uint8_t * hci_packet_buffer; 702 uint8_t hci_packet_buffer_data[HCI_OUTGOING_PRE_BUFFER_SIZE + HCI_PACKET_BUFFER_SIZE]; 703 uint8_t hci_packet_buffer_reserved; 704 uint16_t acl_fragmentation_pos; 705 uint16_t acl_fragmentation_total_size; 706 707 /* host to controller flow control */ 708 uint8_t num_cmd_packets; 709 uint8_t acl_packets_total_num; 710 uint16_t acl_data_packet_length; 711 uint8_t sco_packets_total_num; 712 uint8_t sco_data_packet_length; 713 uint8_t synchronous_flow_control_enabled; 714 uint8_t le_acl_packets_total_num; 715 uint16_t le_data_packets_length; 716 uint8_t sco_waiting_for_can_send_now; 717 718 /* local supported features */ 719 uint8_t local_supported_features[8]; 720 721 /* local supported commands summary - complete info is 64 bytes */ 722 /* 0 - Read Buffer Size */ 723 /* 1 - Write Le Host Supported */ 724 /* 2 - Write Synchronous Flow Control Enable (Octet 10/bit 4) */ 725 /* 3 - Write Default Erroneous Data Reporting (Octet 18/bit 3) */ 726 /* 4 - LE Write Suggested Default Data Length (Octet 34/bit 0) */ 727 /* 5 - LE Read Maximum Data Length (Octet 35/bit 3) */ 728 uint8_t local_supported_commands[1]; 729 730 /* bluetooth device information from hci read local version information */ 731 // uint16_t hci_version; 732 // uint16_t hci_revision; 733 // uint16_t lmp_version; 734 uint16_t manufacturer; 735 // uint16_t lmp_subversion; 736 737 // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE 738 uint16_t packet_types; 739 740 741 /* hci state machine */ 742 HCI_STATE state; 743 hci_substate_t substate; 744 btstack_timer_source_t timeout; 745 746 uint16_t last_cmd_opcode; 747 748 uint8_t cmds_ready; 749 750 /* buffer for scan enable cmd - 0xff no change */ 751 uint8_t new_scan_enable_value; 752 753 uint8_t discoverable; 754 uint8_t connectable; 755 uint8_t bondable; 756 757 uint8_t inquiry_state; // see hci.c for state defines 758 759 bd_addr_t remote_name_addr; 760 uint16_t remote_name_clock_offset; 761 uint8_t remote_name_page_scan_repetition_mode; 762 uint8_t remote_name_state; // see hci.c for state defines 763 764 bd_addr_t gap_pairing_addr; 765 uint8_t gap_pairing_state; // see hci.c for state defines 766 union { 767 const char * gap_pairing_pin; 768 uint32_t gap_pairing_passkey; 769 }; 770 771 uint16_t sco_voice_setting; 772 uint16_t sco_voice_setting_active; 773 774 uint8_t loopback_mode; 775 776 // buffer for single connection decline 777 uint8_t decline_reason; 778 bd_addr_t decline_addr; 779 780 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 781 uint8_t host_completed_packets; 782 #endif 783 784 #ifdef ENABLE_BLE 785 uint8_t le_own_addr_type; 786 bd_addr_t le_random_address; 787 uint8_t le_random_address_set; 788 #endif 789 790 #ifdef ENABLE_LE_CENTRAL 791 uint8_t le_scanning_enabled; 792 uint8_t le_scanning_active; 793 794 le_connecting_state_t le_connecting_state; 795 796 // buffer for le scan type command - 0xff not set 797 uint8_t le_scan_type; 798 uint16_t le_scan_interval; 799 uint16_t le_scan_window; 800 801 // LE Whitelist Management 802 uint8_t le_whitelist_capacity; 803 btstack_linked_list_t le_whitelist; 804 805 // Connection parameters 806 uint16_t le_connection_interval_min; 807 uint16_t le_connection_interval_max; 808 uint16_t le_connection_latency; 809 uint16_t le_supervision_timeout; 810 uint16_t le_minimum_ce_length; 811 uint16_t le_maximum_ce_length; 812 uint16_t le_connection_scan_interval; 813 uint16_t le_connection_scan_window; 814 #endif 815 816 le_connection_parameter_range_t le_connection_parameter_range; 817 818 #ifdef ENABLE_LE_PERIPHERAL 819 uint8_t * le_advertisements_data; 820 uint8_t le_advertisements_data_len; 821 822 uint8_t * le_scan_response_data; 823 uint8_t le_scan_response_data_len; 824 825 uint8_t le_advertisements_active; 826 uint8_t le_advertisements_enabled; 827 uint8_t le_advertisements_todo; 828 829 uint16_t le_advertisements_interval_min; 830 uint16_t le_advertisements_interval_max; 831 uint8_t le_advertisements_type; 832 uint8_t le_advertisements_direct_address_type; 833 uint8_t le_advertisements_channel_map; 834 uint8_t le_advertisements_filter_policy; 835 bd_addr_t le_advertisements_direct_address; 836 837 uint8_t le_max_number_peripheral_connections; 838 #endif 839 840 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION 841 // LE Data Length 842 uint16_t le_supported_max_tx_octets; 843 uint16_t le_supported_max_tx_time; 844 #endif 845 846 // custom BD ADDR 847 bd_addr_t custom_bd_addr; 848 uint8_t custom_bd_addr_set; 849 850 #ifdef ENABLE_CLASSIC 851 uint8_t master_slave_policy; 852 #endif 853 854 } hci_stack_t; 855 856 857 /* API_START */ 858 859 860 // HCI init and configuration 861 862 863 /** 864 * @brief Set up HCI. Needs to be called before any other function. 865 */ 866 void hci_init(const hci_transport_t *transport, const void *config); 867 868 /** 869 * @brief Configure Bluetooth chipset driver. Has to be called before power on, or right after receiving the local version information. 870 */ 871 void hci_set_chipset(const btstack_chipset_t *chipset_driver); 872 873 /** 874 * @brief Configure Bluetooth hardware control. Has to be called before power on. 875 */ 876 void hci_set_control(const btstack_control_t *hardware_control); 877 878 /** 879 * @brief Configure Bluetooth hardware control. Has to be called before power on. 880 */ 881 void hci_set_link_key_db(btstack_link_key_db_t const * link_key_db); 882 883 /** 884 * @brief Set callback for Bluetooth Hardware Error 885 */ 886 void hci_set_hardware_error_callback(void (*fn)(uint8_t error)); 887 888 /** 889 * @brief Set Public BD ADDR - passed on to Bluetooth chipset during init if supported in bt_control_h 890 */ 891 void hci_set_bd_addr(bd_addr_t addr); 892 893 /** 894 * @brief Configure Voice Setting for use with SCO data in HSP/HFP 895 */ 896 void hci_set_sco_voice_setting(uint16_t voice_setting); 897 898 /** 899 * @brief Get SCO Voice Setting 900 * @return current voice setting 901 */ 902 uint16_t hci_get_sco_voice_setting(void); 903 904 /** 905 * @brief Set inquiry mode: standard, with RSSI, with RSSI + Extended Inquiry Results. Has to be called before power on. 906 * @param inquriy_mode see bluetooth_defines.h 907 */ 908 void hci_set_inquiry_mode(inquiry_mode_t mode); 909 910 /** 911 * @brief Requests the change of BTstack power mode. 912 */ 913 int hci_power_control(HCI_POWER_MODE mode); 914 915 /** 916 * @brief Shutdown HCI 917 */ 918 void hci_close(void); 919 920 921 // Callback registration 922 923 924 /** 925 * @brief Add event packet handler. 926 */ 927 void hci_add_event_handler(btstack_packet_callback_registration_t * callback_handler); 928 929 /** 930 * @brief Registers a packet handler for ACL data. Used by L2CAP 931 */ 932 void hci_register_acl_packet_handler(btstack_packet_handler_t handler); 933 934 /** 935 * @brief Registers a packet handler for SCO data. Used for HSP and HFP profiles. 936 */ 937 void hci_register_sco_packet_handler(btstack_packet_handler_t handler); 938 939 940 // Sending HCI Commands 941 942 /** 943 * @brief Check if CMD packet can be sent to controller 944 */ 945 int hci_can_send_command_packet_now(void); 946 947 /** 948 * @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. 949 */ 950 int hci_send_cmd(const hci_cmd_t *cmd, ...); 951 952 953 // Sending SCO Packets 954 955 /** @brief Get SCO packet length for current SCO Voice setting 956 * @note Using SCO packets of the exact length is required for USB transfer 957 * @return Length of SCO packets in bytes (not audio frames) incl. 3 byte header 958 */ 959 int hci_get_sco_packet_length(void); 960 961 /** 962 * @brief Request emission of HCI_EVENT_SCO_CAN_SEND_NOW as soon as possible 963 * @note HCI_EVENT_SCO_CAN_SEND_NOW might be emitted during call to this function 964 * so packet handler should be ready to handle it 965 */ 966 void hci_request_sco_can_send_now_event(void); 967 968 /** 969 * @brief Check HCI packet buffer and if SCO packet can be sent to controller 970 */ 971 int hci_can_send_sco_packet_now(void); 972 973 /** 974 * @brief Check if SCO packet can be sent to controller 975 */ 976 int hci_can_send_prepared_sco_packet_now(void); 977 978 /** 979 * @brief Send SCO packet prepared in HCI packet buffer 980 */ 981 int hci_send_sco_packet_buffer(int size); 982 983 984 // Outgoing packet buffer, also used for SCO packets 985 // see hci_can_send_prepared_sco_packet_now amn hci_send_sco_packet_buffer 986 987 /** 988 * Reserves outgoing packet buffer. 989 * @return 1 on success 990 */ 991 int hci_reserve_packet_buffer(void); 992 993 /** 994 * Get pointer for outgoing packet buffer 995 */ 996 uint8_t* hci_get_outgoing_packet_buffer(void); 997 998 /** 999 * Release outgoing packet buffer\ 1000 * @note only called instead of hci_send_preparared 1001 */ 1002 void hci_release_packet_buffer(void); 1003 1004 /** 1005 * @brief Sets the master/slave policy 1006 * @param policy (0: attempt to become master, 1: let connecting device decide) 1007 */ 1008 void hci_set_master_slave_policy(uint8_t policy); 1009 1010 /* API_END */ 1011 1012 1013 /** 1014 * va_list version of hci_send_cmd 1015 */ 1016 int hci_send_cmd_va_arg(const hci_cmd_t *cmd, va_list argtr); 1017 1018 /** 1019 * Get connection iterator. Only used by l2cap.c and sm.c 1020 */ 1021 void hci_connections_get_iterator(btstack_linked_list_iterator_t *it); 1022 1023 /** 1024 * Get internal hci_connection_t for given handle. Used by L2CAP, SM, daemon 1025 */ 1026 hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle); 1027 1028 /** 1029 * Get internal hci_connection_t for given Bluetooth addres. Called by L2CAP 1030 */ 1031 hci_connection_t * hci_connection_for_bd_addr_and_type(bd_addr_t addr, bd_addr_type_t addr_type); 1032 1033 /** 1034 * Check if outgoing packet buffer is reserved. Used for internal checks in l2cap.c 1035 */ 1036 int hci_is_packet_buffer_reserved(void); 1037 1038 /** 1039 * Check hci packet buffer is free and a classic acl packet can be sent to controller 1040 */ 1041 int hci_can_send_acl_classic_packet_now(void); 1042 1043 /** 1044 * Check hci packet buffer is free and an LE acl packet can be sent to controller 1045 */ 1046 int hci_can_send_acl_le_packet_now(void); 1047 1048 /** 1049 * Check hci packet buffer is free and an acl packet for the given handle can be sent to controller 1050 */ 1051 int hci_can_send_acl_packet_now(hci_con_handle_t con_handle); 1052 1053 /** 1054 * Check if acl packet for the given handle can be sent to controller 1055 */ 1056 int hci_can_send_prepared_acl_packet_now(hci_con_handle_t con_handle); 1057 1058 /** 1059 * Send acl packet prepared in hci packet buffer 1060 */ 1061 int hci_send_acl_packet_buffer(int size); 1062 1063 /** 1064 * Check if authentication is active. It delays automatic disconnect while no L2CAP connection 1065 * Called by l2cap. 1066 */ 1067 int hci_authentication_active_for_handle(hci_con_handle_t handle); 1068 1069 /** 1070 * Get maximal ACL Classic data packet length based on used buffer size. Called by L2CAP 1071 */ 1072 uint16_t hci_max_acl_data_packet_length(void); 1073 1074 /** 1075 * Get supported packet types. Called by L2CAP 1076 */ 1077 uint16_t hci_usable_acl_packet_types(void); 1078 1079 /** 1080 * Check if ACL packets marked as non flushable can be sent. Called by L2CAP 1081 */ 1082 int hci_non_flushable_packet_boundary_flag_supported(void); 1083 1084 /** 1085 * Check if extended SCO Link is supported 1086 */ 1087 int hci_extended_sco_link_supported(void); 1088 1089 /** 1090 * Check if SSP is supported on both sides. Called by L2CAP 1091 */ 1092 int gap_ssp_supported_on_both_sides(hci_con_handle_t handle); 1093 1094 /** 1095 * Disconn because of security block. Called by L2CAP 1096 */ 1097 void hci_disconnect_security_block(hci_con_handle_t con_handle); 1098 1099 /** 1100 * Query if remote side supports eSCO 1101 */ 1102 int hci_remote_esco_supported(hci_con_handle_t con_handle); 1103 1104 /** 1105 * Emit current HCI state. Called by daemon 1106 */ 1107 void hci_emit_state(void); 1108 1109 /** 1110 * Send complete CMD packet. Called by daemon 1111 */ 1112 int hci_send_cmd_packet(uint8_t *packet, int size); 1113 1114 /** 1115 * Disconnect all HCI connections. Called by daemon 1116 */ 1117 void hci_disconnect_all(void); 1118 1119 /** 1120 * Get number of free acl slots for packets of given handle. Called by daemon 1121 */ 1122 int hci_number_free_acl_slots_for_handle(hci_con_handle_t con_handle); 1123 1124 /** 1125 * @brief Set Advertisement Parameters 1126 * @param adv_int_min 1127 * @param adv_int_max 1128 * @param adv_type 1129 * @param direct_address_type 1130 * @param direct_address 1131 * @param channel_map 1132 * @param filter_policy 1133 * 1134 * @note internal use. use gap_advertisements_set_params from gap.h instead. 1135 */ 1136 void hci_le_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 1137 uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy); 1138 1139 /** 1140 * 1141 * @note internal use. use gap_random_address_set_mode from gap.h instead. 1142 */ 1143 void hci_le_set_own_address_type(uint8_t own_address_type); 1144 1145 /** 1146 * @brief Get Manufactured 1147 * @return manufacturer id 1148 */ 1149 uint16_t hci_get_manufacturer(void); 1150 1151 // Only for PTS testing 1152 1153 /** 1154 * Disable automatic L2CAP disconnect if no L2CAP connection is established 1155 */ 1156 void hci_disable_l2cap_timeout_check(void); 1157 1158 /** 1159 * Get state 1160 */ 1161 HCI_STATE hci_get_state(void); 1162 1163 #if defined __cplusplus 1164 } 1165 #endif 1166 1167 #endif // __HCI_H 1168