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