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