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