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