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