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 // Phase 3: Transport Specific Key Distribution 253 // calculate DHK, Y, EDIV, and LTK 254 SM_PH3_GET_RANDOM, 255 SM_PH3_W4_RANDOM, 256 SM_PH3_GET_DIV, 257 SM_PH3_W4_DIV, 258 SM_PH3_Y_GET_ENC, 259 SM_PH3_Y_W4_ENC, 260 SM_PH3_LTK_GET_ENC, 261 // state = 30 262 SM_PH3_LTK_W4_ENC, 263 SM_PH3_CSRK_GET_ENC, 264 SM_PH3_CSRK_W4_ENC, 265 266 // exchange keys 267 SM_PH3_DISTRIBUTE_KEYS, 268 SM_PH3_RECEIVE_KEYS, 269 270 // RESPONDER ROLE 271 // state = 35 272 SM_RESPONDER_IDLE, 273 SM_RESPONDER_SEND_SECURITY_REQUEST, 274 SM_RESPONDER_PH0_RECEIVED_LTK, 275 SM_RESPONDER_PH0_SEND_LTK_REQUESTED_NEGATIVE_REPLY, 276 SM_RESPONDER_PH1_W4_PAIRING_REQUEST, 277 SM_RESPONDER_PH1_PAIRING_REQUEST_RECEIVED, 278 SM_RESPONDER_PH1_SEND_PAIRING_RESPONSE, 279 SM_RESPONDER_PH1_W4_PAIRING_CONFIRM, 280 SM_RESPONDER_PH2_W4_PAIRING_RANDOM, 281 SM_RESPONDER_PH2_W4_LTK_REQUEST, 282 SM_RESPONDER_PH2_SEND_LTK_REPLY, 283 284 // Phase 4: re-establish previously distributed LTK 285 // state == 46 286 SM_RESPONDER_PH4_Y_GET_ENC, 287 SM_RESPONDER_PH4_Y_W4_ENC, 288 SM_RESPONDER_PH4_LTK_GET_ENC, 289 SM_RESPONDER_PH4_LTK_W4_ENC, 290 SM_RESPONDER_PH4_SEND_LTK, 291 292 // INITITIATOR ROLE 293 // state = 51 294 SM_INITIATOR_CONNECTED, 295 SM_INITIATOR_PH0_HAS_LTK, 296 SM_INITIATOR_PH0_SEND_START_ENCRYPTION, 297 SM_INITIATOR_PH0_W4_CONNECTION_ENCRYPTED, 298 SM_INITIATOR_PH1_W2_SEND_PAIRING_REQUEST, 299 SM_INITIATOR_PH1_SEND_PAIRING_REQUEST, 300 SM_INITIATOR_PH1_W4_PAIRING_RESPONSE, 301 SM_INITIATOR_PH2_W4_PAIRING_CONFIRM, 302 SM_INITIATOR_PH2_W4_PAIRING_RANDOM, 303 SM_INITIATOR_PH3_SEND_START_ENCRYPTION, 304 305 // LE Secure Connections 306 SM_SC_SEND_PUBLIC_KEY_COMMAND, 307 SM_SC_W4_PUBLIC_KEY_COMMAND, 308 SM_SC_W2_CMAC_FOR_CONFIRMATION, 309 SM_SC_W4_CMAC_FOR_CONFIRMATION, 310 SM_SC_SEND_CONFIRMATION, 311 SM_SC_W2_CMAC_FOR_CHECK_CONFIRMATION, 312 SM_SC_W4_CMAC_FOR_CHECK_CONFIRMATION, 313 SM_SC_W4_CONFIRMATION, 314 SM_SC_SEND_PAIRING_RANDOM, 315 SM_SC_W4_PAIRING_RANDOM, 316 SM_SC_W2_CALCULATE_F6_FOR_DHKEY_CHECK, 317 SM_SC_W4_CALCULATE_F6_FOR_DHKEY_CHECK, 318 SM_SC_W2_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK, 319 SM_SC_W4_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK, 320 SM_SC_SEND_DHKEY_CHECK_COMMAND, 321 SM_SC_W4_DHKEY_CHECK_COMMAND, 322 SM_SC_W4_USER_RESPONSE, 323 SM_SC_W4_LTK_REQUEST_SC, 324 325 } security_manager_state_t; 326 327 typedef enum { 328 IRK_LOOKUP_IDLE, 329 IRK_LOOKUP_W4_READY, 330 IRK_LOOKUP_STARTED, 331 IRK_LOOKUP_SUCCEEDED, 332 IRK_LOOKUP_FAILED 333 } irk_lookup_state_t; 334 335 // Authorization state 336 typedef enum { 337 AUTHORIZATION_UNKNOWN, 338 AUTHORIZATION_PENDING, 339 AUTHORIZATION_DECLINED, 340 AUTHORIZATION_GRANTED 341 } authorization_state_t; 342 343 typedef uint8_t sm_pairing_packet_t[7]; 344 345 // connection info available as long as connection exists 346 typedef struct sm_connection { 347 hci_con_handle_t sm_handle; 348 uint8_t sm_role; // 0 - IamMaster, 1 = IamSlave 349 uint8_t sm_security_request_received; 350 uint8_t sm_bonding_requested; 351 uint8_t sm_peer_addr_type; 352 bd_addr_t sm_peer_address; 353 security_manager_state_t sm_engine_state; 354 irk_lookup_state_t sm_irk_lookup_state; 355 uint8_t sm_connection_encrypted; 356 uint8_t sm_connection_authenticated; // [0..1] 357 uint8_t sm_actual_encryption_key_size; 358 sm_pairing_packet_t sm_m_preq; // only used during c1 359 authorization_state_t sm_connection_authorization_state; 360 uint16_t sm_local_ediv; 361 uint8_t sm_local_rand[8]; 362 int sm_le_db_index; 363 } sm_connection_t; 364 365 typedef struct { 366 // linked list - assert: first field 367 btstack_linked_item_t item; 368 369 // remote side 370 bd_addr_t address; 371 372 // module handle 373 hci_con_handle_t con_handle; 374 375 // le public, le random, classic 376 bd_addr_type_t address_type; 377 378 // role: 0 - master, 1 - slave 379 uint8_t role; 380 381 // connection state 382 CONNECTION_STATE state; 383 384 // bonding 385 uint16_t bonding_flags; 386 uint8_t bonding_status; 387 // requested security level 388 gap_security_level_t requested_security_level; 389 390 // 391 link_key_type_t link_key_type; 392 393 // remote supported features 394 uint8_t remote_supported_feature_eSCO; 395 396 // errands 397 uint32_t authentication_flags; 398 399 btstack_timer_source_t timeout; 400 401 // timeout in system ticks (HAVE_EMBEDDED_TICK) or milliseconds (HAVE_EMBEDDED_TIME_MS) 402 uint32_t timestamp; 403 404 // ACL packet recombination - PRE_BUFFER + ACL Header + ACL payload 405 uint8_t acl_recombination_buffer[HCI_INCOMING_PRE_BUFFER_SIZE + 4 + HCI_ACL_BUFFER_SIZE]; 406 uint16_t acl_recombination_pos; 407 uint16_t acl_recombination_length; 408 409 // number packets sent to controller 410 uint8_t num_acl_packets_sent; 411 uint8_t num_sco_packets_sent; 412 413 // LE Connection parameter update 414 le_con_parameter_update_state_t le_con_parameter_update_state; 415 uint8_t le_con_param_update_identifier; 416 uint16_t le_conn_interval_min; 417 uint16_t le_conn_interval_max; 418 uint16_t le_conn_latency; 419 uint16_t le_supervision_timeout; 420 421 #ifdef ENABLE_BLE 422 // LE Security Manager 423 sm_connection_t sm_connection; 424 #endif 425 426 } hci_connection_t; 427 428 429 /** 430 * HCI Inititizlization State Machine 431 */ 432 typedef enum hci_init_state{ 433 HCI_INIT_SEND_RESET = 0, 434 HCI_INIT_W4_SEND_RESET, 435 HCI_INIT_SEND_READ_LOCAL_VERSION_INFORMATION, 436 HCI_INIT_W4_SEND_READ_LOCAL_VERSION_INFORMATION, 437 438 HCI_INIT_SEND_BAUD_CHANGE, 439 HCI_INIT_W4_SEND_BAUD_CHANGE, 440 HCI_INIT_CUSTOM_INIT, 441 HCI_INIT_W4_CUSTOM_INIT, 442 HCI_INIT_SEND_RESET_CSR_WARM_BOOT, 443 HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT, 444 HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT_LINK_RESET, 445 446 HCI_INIT_READ_LOCAL_SUPPORTED_COMMANDS, 447 HCI_INIT_W4_READ_LOCAL_SUPPORTED_COMMANDS, 448 449 HCI_INIT_SEND_BAUD_CHANGE_BCM, 450 HCI_INIT_W4_SEND_BAUD_CHANGE_BCM, 451 452 HCI_INIT_SET_BD_ADDR, 453 HCI_INIT_W4_SET_BD_ADDR, 454 455 HCI_INIT_SEND_RESET_ST_WARM_BOOT, 456 HCI_INIT_W4_SEND_RESET_ST_WARM_BOOT, 457 458 HCI_INIT_READ_BD_ADDR, 459 HCI_INIT_W4_READ_BD_ADDR, 460 461 HCI_INIT_READ_BUFFER_SIZE, 462 HCI_INIT_W4_READ_BUFFER_SIZE, 463 HCI_INIT_READ_LOCAL_SUPPORTED_FEATURES, 464 HCI_INIT_W4_READ_LOCAL_SUPPORTED_FEATURES, 465 HCI_INIT_SET_EVENT_MASK, 466 HCI_INIT_W4_SET_EVENT_MASK, 467 HCI_INIT_WRITE_SIMPLE_PAIRING_MODE, 468 HCI_INIT_W4_WRITE_SIMPLE_PAIRING_MODE, 469 HCI_INIT_WRITE_PAGE_TIMEOUT, 470 HCI_INIT_W4_WRITE_PAGE_TIMEOUT, 471 HCI_INIT_WRITE_CLASS_OF_DEVICE, 472 HCI_INIT_W4_WRITE_CLASS_OF_DEVICE, 473 HCI_INIT_WRITE_LOCAL_NAME, 474 HCI_INIT_W4_WRITE_LOCAL_NAME, 475 HCI_INIT_WRITE_SCAN_ENABLE, 476 HCI_INIT_W4_WRITE_SCAN_ENABLE, 477 478 HCI_INIT_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 479 HCI_INIT_W4_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 480 HCI_INIT_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 481 HCI_INIT_W4_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 482 483 HCI_INIT_LE_READ_BUFFER_SIZE, 484 HCI_INIT_W4_LE_READ_BUFFER_SIZE, 485 HCI_INIT_WRITE_LE_HOST_SUPPORTED, 486 HCI_INIT_W4_WRITE_LE_HOST_SUPPORTED, 487 HCI_INIT_READ_WHITE_LIST_SIZE, 488 HCI_INIT_W4_READ_WHITE_LIST_SIZE, 489 490 HCI_INIT_LE_SET_SCAN_PARAMETERS, 491 HCI_INIT_W4_LE_SET_SCAN_PARAMETERS, 492 493 HCI_INIT_DONE, 494 495 HCI_FALLING_ASLEEP_DISCONNECT, 496 HCI_FALLING_ASLEEP_W4_WRITE_SCAN_ENABLE, 497 HCI_FALLING_ASLEEP_COMPLETE, 498 499 HCI_INIT_AFTER_SLEEP 500 501 } hci_substate_t; 502 503 enum { 504 LE_ADVERTISEMENT_TASKS_DISABLE = 1 << 0, 505 LE_ADVERTISEMENT_TASKS_SET_ADV_DATA = 1 << 1, 506 LE_ADVERTISEMENT_TASKS_SET_SCAN_DATA = 1 << 2, 507 LE_ADVERTISEMENT_TASKS_SET_PARAMS = 1 << 3, 508 LE_ADVERTISEMENT_TASKS_ENABLE = 1 << 4, 509 }; 510 511 enum { 512 LE_WHITELIST_ON_CONTROLLER = 1 << 0, 513 LE_WHITELIST_ADD_TO_CONTROLLER = 1 << 1, 514 LE_WHITELIST_REMOVE_FROM_CONTROLLER = 1 << 2, 515 }; 516 517 typedef struct { 518 btstack_linked_item_t item; 519 bd_addr_t address; 520 bd_addr_type_t address_type; 521 uint8_t state; 522 } whitelist_entry_t; 523 524 /** 525 * main data structure 526 */ 527 typedef struct { 528 // transport component with configuration 529 const hci_transport_t * hci_transport; 530 const void * config; 531 532 // chipset driver 533 const btstack_chipset_t * chipset; 534 535 // hardware power controller 536 const btstack_control_t * control; 537 538 /* link key db */ 539 const btstack_link_key_db_t * link_key_db; 540 541 // list of existing baseband connections 542 btstack_linked_list_t connections; 543 544 /* callback to L2CAP layer */ 545 btstack_packet_handler_t acl_packet_handler; 546 547 /* callback for SCO data */ 548 btstack_packet_handler_t sco_packet_handler; 549 550 /* callbacks for events */ 551 btstack_linked_list_t event_handlers; 552 553 // local version information callback 554 void (*local_version_information_callback)(uint8_t * local_version_information); 555 556 // hardware error callback 557 void (*hardware_error_callback)(void); 558 559 // basic configuration 560 const char * local_name; 561 uint32_t class_of_device; 562 bd_addr_t local_bd_addr; 563 uint8_t ssp_enable; 564 uint8_t ssp_io_capability; 565 uint8_t ssp_authentication_requirement; 566 uint8_t ssp_auto_accept; 567 568 // single buffer for HCI packet assembly + additional prebuffer for H4 drivers 569 uint8_t hci_packet_buffer_prefix[HCI_OUTGOING_PRE_BUFFER_SIZE]; 570 uint8_t hci_packet_buffer[HCI_PACKET_BUFFER_SIZE]; // opcode (16), len(8) 571 uint8_t hci_packet_buffer_reserved; 572 uint16_t acl_fragmentation_pos; 573 uint16_t acl_fragmentation_total_size; 574 575 /* host to controller flow control */ 576 uint8_t num_cmd_packets; 577 uint8_t acl_packets_total_num; 578 uint16_t acl_data_packet_length; 579 uint8_t sco_packets_total_num; 580 uint8_t sco_data_packet_length; 581 uint8_t synchronous_flow_control_enabled; 582 uint8_t le_acl_packets_total_num; 583 uint16_t le_data_packets_length; 584 uint8_t sco_waiting_for_can_send_now; 585 586 /* local supported features */ 587 uint8_t local_supported_features[8]; 588 589 /* local supported commands summary - complete info is 64 bytes */ 590 /* 0 - read buffer size */ 591 /* 1 - write le host supported */ 592 uint8_t local_supported_commands[1]; 593 594 /* bluetooth device information from hci read local version information */ 595 // uint16_t hci_version; 596 // uint16_t hci_revision; 597 // uint16_t lmp_version; 598 uint16_t manufacturer; 599 // uint16_t lmp_subversion; 600 601 // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE 602 uint16_t packet_types; 603 604 605 /* hci state machine */ 606 HCI_STATE state; 607 hci_substate_t substate; 608 btstack_timer_source_t timeout; 609 uint8_t cmds_ready; 610 611 uint16_t last_cmd_opcode; 612 613 uint8_t discoverable; 614 uint8_t connectable; 615 uint8_t bondable; 616 617 /* buffer for scan enable cmd - 0xff no change */ 618 uint8_t new_scan_enable_value; 619 620 uint16_t sco_voice_setting; 621 622 uint8_t loopback_mode; 623 624 // buffer for single connection decline 625 uint8_t decline_reason; 626 bd_addr_t decline_addr; 627 628 uint8_t adv_addr_type; 629 bd_addr_t adv_address; 630 631 le_scanning_state_t le_scanning_state; 632 le_connecting_state_t le_connecting_state; 633 634 // buffer for le scan type command - 0xff not set 635 uint8_t le_scan_type; 636 uint16_t le_scan_interval; 637 uint16_t le_scan_window; 638 639 le_connection_parameter_range_t le_connection_parameter_range; 640 641 uint8_t * le_advertisements_data; 642 uint8_t le_advertisements_data_len; 643 644 uint8_t * le_scan_response_data; 645 uint8_t le_scan_response_data_len; 646 647 uint8_t le_advertisements_active; 648 uint8_t le_advertisements_enabled; 649 uint8_t le_advertisements_todo; 650 651 uint16_t le_advertisements_interval_min; 652 uint16_t le_advertisements_interval_max; 653 uint8_t le_advertisements_type; 654 uint8_t le_advertisements_own_address_type; 655 uint8_t le_advertisements_direct_address_type; 656 uint8_t le_advertisements_channel_map; 657 uint8_t le_advertisements_filter_policy; 658 bd_addr_t le_advertisements_direct_address; 659 660 // LE Whitelist Management 661 uint16_t le_whitelist_capacity; 662 btstack_linked_list_t le_whitelist; 663 664 // custom BD ADDR 665 bd_addr_t custom_bd_addr; 666 uint8_t custom_bd_addr_set; 667 668 } hci_stack_t; 669 670 671 /* API_START */ 672 673 674 // HCI init and configuration 675 676 677 /** 678 * @brief Set up HCI. Needs to be called before any other function. 679 */ 680 void hci_init(const hci_transport_t *transport, const void *config); 681 682 /** 683 * @brief Configure Bluetooth chipset driver. Has to be called before power on, or right after receiving the local version information. 684 */ 685 void hci_set_chipset(const btstack_chipset_t *chipset_driver); 686 687 /** 688 * @brief Configure Bluetooth hardware control. Has to be called before power on. 689 */ 690 void hci_set_control(const btstack_control_t *hardware_control); 691 692 /** 693 * @brief Configure Bluetooth hardware control. Has to be called before power on. 694 */ 695 void hci_set_link_key_db(btstack_link_key_db_t const * link_key_db); 696 697 /** 698 * @brief Set callback for Bluetooth Hardware Error 699 */ 700 void hci_set_hardware_error_callback(void (*fn)(void)); 701 702 /** 703 * @brief Set callback for local information from Bluetooth controller right after HCI Reset 704 * @note Can be used to select chipset driver dynamically during startup 705 */ 706 void hci_set_local_version_information_callback(void (*fn)(uint8_t * local_version_information)); 707 708 /** 709 * @brief Set Public BD ADDR - passed on to Bluetooth chipset during init if supported in bt_control_h 710 */ 711 void hci_set_bd_addr(bd_addr_t addr); 712 713 /** 714 * @brief Configure Voice Setting for use with SCO data in HSP/HFP 715 */ 716 void hci_set_sco_voice_setting(uint16_t voice_setting); 717 718 /** 719 * @brief Get SCO Voice Setting 720 * @return current voice setting 721 */ 722 uint16_t hci_get_sco_voice_setting(void); 723 724 /** 725 * @brief Requests the change of BTstack power mode. 726 */ 727 int hci_power_control(HCI_POWER_MODE mode); 728 729 /** 730 * @brief Shutdown HCI 731 */ 732 void hci_close(void); 733 734 735 // Callback registration 736 737 738 /** 739 * @brief Add event packet handler. 740 */ 741 void hci_add_event_handler(btstack_packet_callback_registration_t * callback_handler); 742 743 /** 744 * @brief Registers a packet handler for ACL data. Used by L2CAP 745 */ 746 void hci_register_acl_packet_handler(btstack_packet_handler_t handler); 747 748 /** 749 * @brief Registers a packet handler for SCO data. Used for HSP and HFP profiles. 750 */ 751 void hci_register_sco_packet_handler(btstack_packet_handler_t handler); 752 753 754 // Sending HCI Commands 755 756 /** 757 * @brief Check if CMD packet can be sent to controller 758 */ 759 int hci_can_send_command_packet_now(void); 760 761 /** 762 * @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. 763 */ 764 int hci_send_cmd(const hci_cmd_t *cmd, ...); 765 766 767 // Sending SCO Packets 768 769 /** @brief Get SCO packet length for current SCO Voice setting 770 * @note Using SCO packets of the exact length is required for USB transfer 771 * @return Length of SCO packets in bytes (not audio frames) incl. 3 byte header 772 */ 773 int hci_get_sco_packet_length(void); 774 775 /** 776 * @brief Request emission of HCI_EVENT_SCO_CAN_SEND_NOW as soon as possible 777 * @note HCI_EVENT_SCO_CAN_SEND_NOW might be emitted during call to this function 778 * so packet handler should be ready to handle it 779 */ 780 void hci_request_sco_can_send_now_event(void); 781 782 /** 783 * @brief Check HCI packet buffer and if SCO packet can be sent to controller 784 */ 785 int hci_can_send_sco_packet_now(void); 786 787 /** 788 * @brief Check if SCO packet can be sent to controller 789 */ 790 int hci_can_send_prepared_sco_packet_now(void); 791 792 /** 793 * @brief Send SCO packet prepared in HCI packet buffer 794 */ 795 int hci_send_sco_packet_buffer(int size); 796 797 798 // Outgoing packet buffer, also used for SCO packets 799 // see hci_can_send_prepared_sco_packet_now amn hci_send_sco_packet_buffer 800 801 /** 802 * Reserves outgoing packet buffer. 803 * @return 1 on success 804 */ 805 int hci_reserve_packet_buffer(void); 806 807 /** 808 * Get pointer for outgoing packet buffer 809 */ 810 uint8_t* hci_get_outgoing_packet_buffer(void); 811 812 /** 813 * Release outgoing packet buffer\ 814 * @note only called instead of hci_send_preparared 815 */ 816 void hci_release_packet_buffer(void); 817 818 819 /* API_END */ 820 821 822 823 /** 824 * Get connection iterator. Only used by l2cap.c and sm.c 825 */ 826 void hci_connections_get_iterator(btstack_linked_list_iterator_t *it); 827 828 /** 829 * Get internal hci_connection_t for given handle. Used by L2CAP, SM, daemon 830 */ 831 hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle); 832 833 /** 834 * Get internal hci_connection_t for given Bluetooth addres. Called by L2CAP 835 */ 836 hci_connection_t * hci_connection_for_bd_addr_and_type(bd_addr_t addr, bd_addr_type_t addr_type); 837 838 /** 839 * Check if outgoing packet buffer is reserved. Used for internal checks in l2cap.c 840 */ 841 int hci_is_packet_buffer_reserved(void); 842 843 /** 844 * Check hci packet buffer is free and a classic acl packet can be sent to controller 845 */ 846 int hci_can_send_acl_classic_packet_now(void); 847 848 /** 849 * Check hci packet buffer is free and an LE acl packet can be sent to controller 850 */ 851 int hci_can_send_acl_le_packet_now(void); 852 853 /** 854 * Check hci packet buffer is free and an acl packet for the given handle can be sent to controller 855 */ 856 int hci_can_send_acl_packet_now(hci_con_handle_t con_handle); 857 858 /** 859 * Check if acl packet for the given handle can be sent to controller 860 */ 861 int hci_can_send_prepared_acl_packet_now(hci_con_handle_t con_handle); 862 863 /** 864 * Send acl packet prepared in hci packet buffer 865 */ 866 int hci_send_acl_packet_buffer(int size); 867 868 /** 869 * Check if authentication is active. It delays automatic disconnect while no L2CAP connection 870 * Called by l2cap. 871 */ 872 int hci_authentication_active_for_handle(hci_con_handle_t handle); 873 874 /** 875 * Get maximal ACL Classic data packet length based on used buffer size. Called by L2CAP 876 */ 877 uint16_t hci_max_acl_data_packet_length(void); 878 879 /** 880 * Get supported packet types. Called by L2CAP 881 */ 882 uint16_t hci_usable_acl_packet_types(void); 883 884 /** 885 * Check if ACL packets marked as non flushable can be sent. Called by L2CAP 886 */ 887 int hci_non_flushable_packet_boundary_flag_supported(void); 888 889 /** 890 * Check if SSP is supported on both sides. Called by L2CAP 891 */ 892 int gap_ssp_supported_on_both_sides(hci_con_handle_t handle); 893 894 /** 895 * Disconn because of security block. Called by L2CAP 896 */ 897 void hci_disconnect_security_block(hci_con_handle_t con_handle); 898 899 /** 900 * Query if remote side supports eSCO 901 */ 902 int hci_remote_esco_supported(hci_con_handle_t con_handle); 903 904 /** 905 * Emit current HCI state. Called by daemon 906 */ 907 void hci_emit_state(void); 908 909 /** 910 * Send complete CMD packet. Called by daemon 911 */ 912 int hci_send_cmd_packet(uint8_t *packet, int size); 913 914 /** 915 * Disconnect all HCI connections. Called by daemon 916 */ 917 void hci_disconnect_all(void); 918 919 /** 920 * Get number of free acl slots for packets of given handle. Called by daemon 921 */ 922 int hci_number_free_acl_slots_for_handle(hci_con_handle_t con_handle); 923 924 /** 925 * @brief Set Advertisement Parameters 926 * @param adv_int_min 927 * @param adv_int_max 928 * @param adv_type 929 * @param own_address_type 930 * @param direct_address_type 931 * @param direct_address 932 * @param channel_map 933 * @param filter_policy 934 * 935 * @note internal use. use gap_advertisements_set_params from gap_le.h instead. 936 */ 937 void hci_le_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 938 uint8_t own_address_type, uint8_t direct_address_typ, bd_addr_t direct_address, 939 uint8_t channel_map, uint8_t filter_policy); 940 941 942 // Only for PTS testing 943 944 /** 945 * Disable automatic L2CAP disconnect if no L2CAP connection is established 946 */ 947 void hci_disable_l2cap_timeout_check(void); 948 949 #if defined __cplusplus 950 } 951 #endif 952 953 #endif // __HCI_H 954