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