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 // Authorization state 385 typedef enum { 386 AUTHORIZATION_UNKNOWN, 387 AUTHORIZATION_PENDING, 388 AUTHORIZATION_DECLINED, 389 AUTHORIZATION_GRANTED 390 } authorization_state_t; 391 392 typedef uint8_t sm_pairing_packet_t[7]; 393 394 // connection info available as long as connection exists 395 typedef struct sm_connection { 396 hci_con_handle_t sm_handle; 397 uint8_t sm_role; // 0 - IamMaster, 1 = IamSlave 398 uint8_t sm_security_request_received; 399 uint8_t sm_bonding_requested; 400 uint8_t sm_peer_addr_type; 401 bd_addr_t sm_peer_address; 402 security_manager_state_t sm_engine_state; 403 irk_lookup_state_t sm_irk_lookup_state; 404 uint8_t sm_connection_encrypted; 405 uint8_t sm_connection_authenticated; // [0..1] 406 uint8_t sm_actual_encryption_key_size; 407 sm_pairing_packet_t sm_m_preq; // only used during c1 408 authorization_state_t sm_connection_authorization_state; 409 uint16_t sm_local_ediv; 410 uint8_t sm_local_rand[8]; 411 int sm_le_db_index; 412 } sm_connection_t; 413 414 // 415 // ATT Server 416 // 417 418 // max ATT request matches L2CAP PDU -- allow to use smaller buffer 419 #ifndef ATT_REQUEST_BUFFER_SIZE 420 #define ATT_REQUEST_BUFFER_SIZE HCI_ACL_PAYLOAD_SIZE 421 #endif 422 423 typedef enum { 424 ATT_SERVER_IDLE, 425 ATT_SERVER_REQUEST_RECEIVED, 426 ATT_SERVER_W4_SIGNED_WRITE_VALIDATION, 427 ATT_SERVER_REQUEST_RECEIVED_AND_VALIDATED, 428 } att_server_state_t; 429 430 typedef struct { 431 att_server_state_t state; 432 433 uint8_t peer_addr_type; 434 bd_addr_t peer_address; 435 436 int ir_le_device_db_index; 437 int ir_lookup_active; 438 439 int value_indication_handle; 440 btstack_timer_source_t value_indication_timer; 441 442 att_connection_t connection; 443 444 uint16_t request_size; 445 uint8_t request_buffer[ATT_REQUEST_BUFFER_SIZE]; 446 447 } att_server_t; 448 449 #endif 450 451 #ifdef ENABLE_L2CAP_ENHANCED_RETRANSMISSION_MODE 452 typedef enum { 453 L2CAP_INFORMATION_STATE_IDLE = 0, 454 L2CAP_INFORMATION_STATE_W2_SEND_EXTENDED_FEATURE_REQUEST, 455 L2CAP_INFORMATION_STATE_W4_EXTENDED_FEATURE_RESPONSE, 456 L2CAP_INFORMATION_STATE_DONE 457 } l2cap_information_state_t; 458 459 typedef struct { 460 l2cap_information_state_t information_state; 461 uint16_t extended_feature_mask; 462 } l2cap_state_t; 463 #endif 464 465 // 466 typedef struct { 467 // linked list - assert: first field 468 btstack_linked_item_t item; 469 470 // remote side 471 bd_addr_t address; 472 473 // module handle 474 hci_con_handle_t con_handle; 475 476 // le public, le random, classic 477 bd_addr_type_t address_type; 478 479 // role: 0 - master, 1 - slave 480 uint8_t role; 481 482 // connection state 483 CONNECTION_STATE state; 484 485 // bonding 486 uint16_t bonding_flags; 487 uint8_t bonding_status; 488 // requested security level 489 gap_security_level_t requested_security_level; 490 491 // 492 link_key_type_t link_key_type; 493 494 // remote supported features 495 uint8_t remote_supported_feature_eSCO; 496 497 // errands 498 uint32_t authentication_flags; 499 500 btstack_timer_source_t timeout; 501 502 // timeout in system ticks (HAVE_EMBEDDED_TICK) or milliseconds (HAVE_EMBEDDED_TIME_MS) 503 uint32_t timestamp; 504 505 // ACL packet recombination - PRE_BUFFER + ACL Header + ACL payload 506 uint8_t acl_recombination_buffer[HCI_INCOMING_PRE_BUFFER_SIZE + 4 + HCI_ACL_BUFFER_SIZE]; 507 uint16_t acl_recombination_pos; 508 uint16_t acl_recombination_length; 509 510 // number packets sent to controller 511 uint8_t num_acl_packets_sent; 512 uint8_t num_sco_packets_sent; 513 514 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 515 uint8_t num_packets_completed; 516 #endif 517 518 // LE Connection parameter update 519 le_con_parameter_update_state_t le_con_parameter_update_state; 520 uint8_t le_con_param_update_identifier; 521 uint16_t le_conn_interval_min; 522 uint16_t le_conn_interval_max; 523 uint16_t le_conn_latency; 524 uint16_t le_supervision_timeout; 525 526 #ifdef ENABLE_BLE 527 // LE Security Manager 528 sm_connection_t sm_connection; 529 530 // ATT Server 531 att_server_t att_server; 532 #endif 533 534 #ifdef ENABLE_L2CAP_ENHANCED_RETRANSMISSION_MODE 535 l2cap_state_t l2cap_state; 536 #endif 537 538 } hci_connection_t; 539 540 541 /** 542 * HCI Inititizlization State Machine 543 */ 544 typedef enum hci_init_state{ 545 HCI_INIT_SEND_RESET = 0, 546 HCI_INIT_W4_SEND_RESET, 547 HCI_INIT_SEND_READ_LOCAL_VERSION_INFORMATION, 548 HCI_INIT_W4_SEND_READ_LOCAL_VERSION_INFORMATION, 549 HCI_INIT_SEND_READ_LOCAL_NAME, 550 HCI_INIT_W4_SEND_READ_LOCAL_NAME, 551 552 HCI_INIT_SEND_BAUD_CHANGE, 553 HCI_INIT_W4_SEND_BAUD_CHANGE, 554 HCI_INIT_CUSTOM_INIT, 555 HCI_INIT_W4_CUSTOM_INIT, 556 HCI_INIT_SEND_RESET_CSR_WARM_BOOT, 557 HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT, 558 HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT_LINK_RESET, 559 HCI_INIT_W4_CUSTOM_INIT_BCM_DELAY, 560 561 HCI_INIT_READ_LOCAL_SUPPORTED_COMMANDS, 562 HCI_INIT_W4_READ_LOCAL_SUPPORTED_COMMANDS, 563 564 HCI_INIT_SEND_BAUD_CHANGE_BCM, 565 HCI_INIT_W4_SEND_BAUD_CHANGE_BCM, 566 567 HCI_INIT_SET_BD_ADDR, 568 HCI_INIT_W4_SET_BD_ADDR, 569 570 HCI_INIT_SEND_RESET_ST_WARM_BOOT, 571 HCI_INIT_W4_SEND_RESET_ST_WARM_BOOT, 572 573 HCI_INIT_READ_BD_ADDR, 574 HCI_INIT_W4_READ_BD_ADDR, 575 576 HCI_INIT_READ_BUFFER_SIZE, 577 HCI_INIT_W4_READ_BUFFER_SIZE, 578 HCI_INIT_READ_LOCAL_SUPPORTED_FEATURES, 579 HCI_INIT_W4_READ_LOCAL_SUPPORTED_FEATURES, 580 581 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 582 HCI_INIT_HOST_BUFFER_SIZE, 583 HCI_INIT_W4_HOST_BUFFER_SIZE, 584 HCI_INIT_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, 585 HCI_INIT_W4_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, 586 #endif 587 588 HCI_INIT_SET_EVENT_MASK, 589 HCI_INIT_W4_SET_EVENT_MASK, 590 591 HCI_INIT_WRITE_SIMPLE_PAIRING_MODE, 592 HCI_INIT_W4_WRITE_SIMPLE_PAIRING_MODE, 593 HCI_INIT_WRITE_PAGE_TIMEOUT, 594 HCI_INIT_W4_WRITE_PAGE_TIMEOUT, 595 HCI_INIT_WRITE_CLASS_OF_DEVICE, 596 HCI_INIT_W4_WRITE_CLASS_OF_DEVICE, 597 HCI_INIT_WRITE_LOCAL_NAME, 598 HCI_INIT_W4_WRITE_LOCAL_NAME, 599 HCI_INIT_WRITE_EIR_DATA, 600 HCI_INIT_W4_WRITE_EIR_DATA, 601 HCI_INIT_WRITE_INQUIRY_MODE, 602 HCI_INIT_W4_WRITE_INQUIRY_MODE, 603 HCI_INIT_WRITE_SCAN_ENABLE, 604 HCI_INIT_W4_WRITE_SCAN_ENABLE, 605 606 // SCO over HCI 607 HCI_INIT_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 608 HCI_INIT_W4_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 609 HCI_INIT_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 610 HCI_INIT_W4_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 611 612 // SCO over HCI Broadcom 613 HCI_INIT_BCM_WRITE_SCO_PCM_INT, 614 HCI_INIT_W4_BCM_WRITE_SCO_PCM_INT, 615 616 #ifdef ENABLE_BLE 617 HCI_INIT_LE_READ_BUFFER_SIZE, 618 HCI_INIT_W4_LE_READ_BUFFER_SIZE, 619 HCI_INIT_WRITE_LE_HOST_SUPPORTED, 620 HCI_INIT_W4_WRITE_LE_HOST_SUPPORTED, 621 HCI_INIT_LE_SET_EVENT_MASK, 622 HCI_INIT_W4_LE_SET_EVENT_MASK, 623 #endif 624 625 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION 626 HCI_INIT_LE_READ_MAX_DATA_LENGTH, 627 HCI_INIT_W4_LE_READ_MAX_DATA_LENGTH, 628 HCI_INIT_LE_WRITE_SUGGESTED_DATA_LENGTH, 629 HCI_INIT_W4_LE_WRITE_SUGGESTED_DATA_LENGTH, 630 #endif 631 632 #ifdef ENABLE_LE_CENTRAL 633 HCI_INIT_READ_WHITE_LIST_SIZE, 634 HCI_INIT_W4_READ_WHITE_LIST_SIZE, 635 636 HCI_INIT_LE_SET_SCAN_PARAMETERS, 637 HCI_INIT_W4_LE_SET_SCAN_PARAMETERS, 638 #endif 639 640 HCI_INIT_DONE, 641 642 HCI_FALLING_ASLEEP_DISCONNECT, 643 HCI_FALLING_ASLEEP_W4_WRITE_SCAN_ENABLE, 644 HCI_FALLING_ASLEEP_COMPLETE, 645 646 HCI_INIT_AFTER_SLEEP 647 648 } hci_substate_t; 649 650 enum { 651 LE_ADVERTISEMENT_TASKS_DISABLE = 1 << 0, 652 LE_ADVERTISEMENT_TASKS_SET_ADV_DATA = 1 << 1, 653 LE_ADVERTISEMENT_TASKS_SET_SCAN_DATA = 1 << 2, 654 LE_ADVERTISEMENT_TASKS_SET_PARAMS = 1 << 3, 655 LE_ADVERTISEMENT_TASKS_ENABLE = 1 << 4, 656 }; 657 658 enum { 659 LE_WHITELIST_ON_CONTROLLER = 1 << 0, 660 LE_WHITELIST_ADD_TO_CONTROLLER = 1 << 1, 661 LE_WHITELIST_REMOVE_FROM_CONTROLLER = 1 << 2, 662 }; 663 664 typedef struct { 665 btstack_linked_item_t item; 666 bd_addr_t address; 667 bd_addr_type_t address_type; 668 uint8_t state; 669 } whitelist_entry_t; 670 671 /** 672 * main data structure 673 */ 674 typedef struct { 675 // transport component with configuration 676 const hci_transport_t * hci_transport; 677 const void * config; 678 679 // chipset driver 680 const btstack_chipset_t * chipset; 681 682 // hardware power controller 683 const btstack_control_t * control; 684 685 /* link key db */ 686 const btstack_link_key_db_t * link_key_db; 687 688 // list of existing baseband connections 689 btstack_linked_list_t connections; 690 691 /* callback to L2CAP layer */ 692 btstack_packet_handler_t acl_packet_handler; 693 694 /* callback for SCO data */ 695 btstack_packet_handler_t sco_packet_handler; 696 697 /* callbacks for events */ 698 btstack_linked_list_t event_handlers; 699 700 // hardware error callback 701 void (*hardware_error_callback)(uint8_t error); 702 703 // basic configuration 704 const char * local_name; 705 const uint8_t * eir_data; 706 uint32_t class_of_device; 707 bd_addr_t local_bd_addr; 708 uint8_t ssp_enable; 709 uint8_t ssp_io_capability; 710 uint8_t ssp_authentication_requirement; 711 uint8_t ssp_auto_accept; 712 inquiry_mode_t inquiry_mode; 713 714 // single buffer for HCI packet assembly + additional prebuffer for H4 drivers 715 uint8_t * hci_packet_buffer; 716 uint8_t hci_packet_buffer_data[HCI_OUTGOING_PRE_BUFFER_SIZE + HCI_PACKET_BUFFER_SIZE]; 717 uint8_t hci_packet_buffer_reserved; 718 uint16_t acl_fragmentation_pos; 719 uint16_t acl_fragmentation_total_size; 720 721 /* host to controller flow control */ 722 uint8_t num_cmd_packets; 723 uint8_t acl_packets_total_num; 724 uint16_t acl_data_packet_length; 725 uint8_t sco_packets_total_num; 726 uint8_t sco_data_packet_length; 727 uint8_t synchronous_flow_control_enabled; 728 uint8_t le_acl_packets_total_num; 729 uint16_t le_data_packets_length; 730 uint8_t sco_waiting_for_can_send_now; 731 732 /* local supported features */ 733 uint8_t local_supported_features[8]; 734 735 /* local supported commands summary - complete info is 64 bytes */ 736 /* 0 - Read Buffer Size */ 737 /* 1 - Write Le Host Supported */ 738 /* 2 - Write Synchronous Flow Control Enable (Octet 10/bit 4) */ 739 /* 3 - Write Default Erroneous Data Reporting (Octet 18/bit 3) */ 740 /* 4 - LE Write Suggested Default Data Length (Octet 34/bit 0) */ 741 /* 5 - LE Read Maximum Data Length (Octet 35/bit 3) */ 742 uint8_t local_supported_commands[1]; 743 744 /* bluetooth device information from hci read local version information */ 745 // uint16_t hci_version; 746 // uint16_t hci_revision; 747 // uint16_t lmp_version; 748 uint16_t manufacturer; 749 // uint16_t lmp_subversion; 750 751 // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE 752 uint16_t packet_types; 753 754 755 /* hci state machine */ 756 HCI_STATE state; 757 hci_substate_t substate; 758 btstack_timer_source_t timeout; 759 760 uint16_t last_cmd_opcode; 761 762 uint8_t cmds_ready; 763 764 /* buffer for scan enable cmd - 0xff no change */ 765 uint8_t new_scan_enable_value; 766 767 uint8_t discoverable; 768 uint8_t connectable; 769 uint8_t bondable; 770 771 uint8_t inquiry_state; // see hci.c for state defines 772 773 bd_addr_t remote_name_addr; 774 uint16_t remote_name_clock_offset; 775 uint8_t remote_name_page_scan_repetition_mode; 776 uint8_t remote_name_state; // see hci.c for state defines 777 778 bd_addr_t gap_pairing_addr; 779 uint8_t gap_pairing_state; // see hci.c for state defines 780 union { 781 const char * gap_pairing_pin; 782 uint32_t gap_pairing_passkey; 783 }; 784 785 uint16_t sco_voice_setting; 786 uint16_t sco_voice_setting_active; 787 788 uint8_t loopback_mode; 789 790 // buffer for single connection decline 791 uint8_t decline_reason; 792 bd_addr_t decline_addr; 793 794 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 795 uint8_t host_completed_packets; 796 #endif 797 798 #ifdef ENABLE_BLE 799 uint8_t le_own_addr_type; 800 bd_addr_t le_random_address; 801 uint8_t le_random_address_set; 802 #endif 803 804 #ifdef ENABLE_LE_CENTRAL 805 le_scanning_state_t le_scanning_state; 806 le_connecting_state_t le_connecting_state; 807 808 // buffer for le scan type command - 0xff not set 809 uint8_t le_scan_type; 810 uint16_t le_scan_interval; 811 uint16_t le_scan_window; 812 813 // LE Whitelist Management 814 uint8_t le_whitelist_capacity; 815 btstack_linked_list_t le_whitelist; 816 817 // Connection parameters 818 uint16_t le_connection_interval_min; 819 uint16_t le_connection_interval_max; 820 uint16_t le_connection_latency; 821 uint16_t le_supervision_timeout; 822 uint16_t le_minimum_ce_length; 823 uint16_t le_maximum_ce_length; 824 #endif 825 826 le_connection_parameter_range_t le_connection_parameter_range; 827 828 #ifdef ENABLE_LE_PERIPHERAL 829 uint8_t * le_advertisements_data; 830 uint8_t le_advertisements_data_len; 831 832 uint8_t * le_scan_response_data; 833 uint8_t le_scan_response_data_len; 834 835 uint8_t le_advertisements_active; 836 uint8_t le_advertisements_enabled; 837 uint8_t le_advertisements_todo; 838 839 uint16_t le_advertisements_interval_min; 840 uint16_t le_advertisements_interval_max; 841 uint8_t le_advertisements_type; 842 uint8_t le_advertisements_direct_address_type; 843 uint8_t le_advertisements_channel_map; 844 uint8_t le_advertisements_filter_policy; 845 bd_addr_t le_advertisements_direct_address; 846 #endif 847 848 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION 849 // LE Data Length 850 uint16_t le_supported_max_tx_octets; 851 uint16_t le_supported_max_tx_time; 852 #endif 853 854 // custom BD ADDR 855 bd_addr_t custom_bd_addr; 856 uint8_t custom_bd_addr_set; 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 /* API_END */ 1010 1011 1012 /** 1013 * va_list version of hci_send_cmd 1014 */ 1015 int hci_send_cmd_va_arg(const hci_cmd_t *cmd, va_list argtr); 1016 1017 /** 1018 * Get connection iterator. Only used by l2cap.c and sm.c 1019 */ 1020 void hci_connections_get_iterator(btstack_linked_list_iterator_t *it); 1021 1022 /** 1023 * Get internal hci_connection_t for given handle. Used by L2CAP, SM, daemon 1024 */ 1025 hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle); 1026 1027 /** 1028 * Get internal hci_connection_t for given Bluetooth addres. Called by L2CAP 1029 */ 1030 hci_connection_t * hci_connection_for_bd_addr_and_type(bd_addr_t addr, bd_addr_type_t addr_type); 1031 1032 /** 1033 * Check if outgoing packet buffer is reserved. Used for internal checks in l2cap.c 1034 */ 1035 int hci_is_packet_buffer_reserved(void); 1036 1037 /** 1038 * Check hci packet buffer is free and a classic acl packet can be sent to controller 1039 */ 1040 int hci_can_send_acl_classic_packet_now(void); 1041 1042 /** 1043 * Check hci packet buffer is free and an LE acl packet can be sent to controller 1044 */ 1045 int hci_can_send_acl_le_packet_now(void); 1046 1047 /** 1048 * Check hci packet buffer is free and an acl packet for the given handle can be sent to controller 1049 */ 1050 int hci_can_send_acl_packet_now(hci_con_handle_t con_handle); 1051 1052 /** 1053 * Check if acl packet for the given handle can be sent to controller 1054 */ 1055 int hci_can_send_prepared_acl_packet_now(hci_con_handle_t con_handle); 1056 1057 /** 1058 * Send acl packet prepared in hci packet buffer 1059 */ 1060 int hci_send_acl_packet_buffer(int size); 1061 1062 /** 1063 * Check if authentication is active. It delays automatic disconnect while no L2CAP connection 1064 * Called by l2cap. 1065 */ 1066 int hci_authentication_active_for_handle(hci_con_handle_t handle); 1067 1068 /** 1069 * Get maximal ACL Classic data packet length based on used buffer size. Called by L2CAP 1070 */ 1071 uint16_t hci_max_acl_data_packet_length(void); 1072 1073 /** 1074 * Get supported packet types. Called by L2CAP 1075 */ 1076 uint16_t hci_usable_acl_packet_types(void); 1077 1078 /** 1079 * Check if ACL packets marked as non flushable can be sent. Called by L2CAP 1080 */ 1081 int hci_non_flushable_packet_boundary_flag_supported(void); 1082 1083 /** 1084 * Check if extended SCO Link is supported 1085 */ 1086 int hci_extended_sco_link_supported(void); 1087 1088 /** 1089 * Check if SSP is supported on both sides. Called by L2CAP 1090 */ 1091 int gap_ssp_supported_on_both_sides(hci_con_handle_t handle); 1092 1093 /** 1094 * Disconn because of security block. Called by L2CAP 1095 */ 1096 void hci_disconnect_security_block(hci_con_handle_t con_handle); 1097 1098 /** 1099 * Query if remote side supports eSCO 1100 */ 1101 int hci_remote_esco_supported(hci_con_handle_t con_handle); 1102 1103 /** 1104 * Emit current HCI state. Called by daemon 1105 */ 1106 void hci_emit_state(void); 1107 1108 /** 1109 * Send complete CMD packet. Called by daemon 1110 */ 1111 int hci_send_cmd_packet(uint8_t *packet, int size); 1112 1113 /** 1114 * Disconnect all HCI connections. Called by daemon 1115 */ 1116 void hci_disconnect_all(void); 1117 1118 /** 1119 * Get number of free acl slots for packets of given handle. Called by daemon 1120 */ 1121 int hci_number_free_acl_slots_for_handle(hci_con_handle_t con_handle); 1122 1123 /** 1124 * @brief Set Advertisement Parameters 1125 * @param adv_int_min 1126 * @param adv_int_max 1127 * @param adv_type 1128 * @param direct_address_type 1129 * @param direct_address 1130 * @param channel_map 1131 * @param filter_policy 1132 * 1133 * @note internal use. use gap_advertisements_set_params from gap.h instead. 1134 */ 1135 void hci_le_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 1136 uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy); 1137 1138 /** 1139 * 1140 * @note internal use. use gap_random_address_set_mode from gap.h instead. 1141 */ 1142 void hci_le_set_own_address_type(uint8_t own_address_type); 1143 1144 /** 1145 * @brief Get Manufactured 1146 * @return manufacturer id 1147 */ 1148 uint16_t hci_get_manufacturer(void); 1149 1150 // Only for PTS testing 1151 1152 /** 1153 * Disable automatic L2CAP disconnect if no L2CAP connection is established 1154 */ 1155 void hci_disable_l2cap_timeout_check(void); 1156 1157 /** 1158 * Get state 1159 */ 1160 HCI_STATE hci_get_state(void); 1161 1162 #if defined __cplusplus 1163 } 1164 #endif 1165 1166 #endif // __HCI_H 1167