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