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