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