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