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 Commadn LE payload size: 74 // 64 from LE Generate DHKey command 75 // 32 from LE Encrypt command 76 #if defined(ENABLE_LE_SECURE_CONNECTIONS) && !defined(HAVE_HCI_CONTROLLER_DHKEY_SUPPORT) 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_SEND_LTK_REQUESTED_NEGATIVE_REPLY, 307 SM_RESPONDER_PH1_W4_PAIRING_REQUEST, 308 SM_RESPONDER_PH1_PAIRING_REQUEST_RECEIVED, 309 SM_RESPONDER_PH1_SEND_PAIRING_RESPONSE, 310 SM_RESPONDER_PH1_W4_PAIRING_CONFIRM, 311 SM_RESPONDER_PH2_W4_PAIRING_RANDOM, 312 SM_RESPONDER_PH2_W4_LTK_REQUEST, 313 SM_RESPONDER_PH2_SEND_LTK_REPLY, 314 315 // Phase 4: re-establish previously distributed LTK 316 // state == 46 317 SM_RESPONDER_PH4_Y_GET_ENC, 318 SM_RESPONDER_PH4_Y_W4_ENC, 319 SM_RESPONDER_PH4_LTK_GET_ENC, 320 SM_RESPONDER_PH4_LTK_W4_ENC, 321 SM_RESPONDER_PH4_SEND_LTK_REPLY, 322 323 // INITITIATOR ROLE 324 // state = 51 325 SM_INITIATOR_CONNECTED, 326 SM_INITIATOR_PH0_HAS_LTK, 327 SM_INITIATOR_PH0_SEND_START_ENCRYPTION, 328 SM_INITIATOR_PH0_W4_CONNECTION_ENCRYPTED, 329 SM_INITIATOR_PH1_W2_SEND_PAIRING_REQUEST, 330 SM_INITIATOR_PH1_SEND_PAIRING_REQUEST, 331 SM_INITIATOR_PH1_W4_PAIRING_RESPONSE, 332 SM_INITIATOR_PH2_W4_PAIRING_CONFIRM, 333 SM_INITIATOR_PH2_W4_PAIRING_RANDOM, 334 SM_INITIATOR_PH3_SEND_START_ENCRYPTION, 335 336 // LE Secure Connections 337 SM_SC_RECEIVED_LTK_REQUEST, 338 SM_SC_SEND_PUBLIC_KEY_COMMAND, 339 SM_SC_W4_PUBLIC_KEY_COMMAND, 340 SM_SC_W2_GET_RANDOM_A, 341 SM_SC_W4_GET_RANDOM_A, 342 SM_SC_W2_GET_RANDOM_B, 343 SM_SC_W4_GET_RANDOM_B, 344 SM_SC_W2_CMAC_FOR_CONFIRMATION, 345 SM_SC_W4_CMAC_FOR_CONFIRMATION, 346 SM_SC_SEND_CONFIRMATION, 347 SM_SC_W2_CMAC_FOR_CHECK_CONFIRMATION, 348 SM_SC_W4_CMAC_FOR_CHECK_CONFIRMATION, 349 SM_SC_W4_CONFIRMATION, 350 SM_SC_SEND_PAIRING_RANDOM, 351 SM_SC_W4_PAIRING_RANDOM, 352 SM_SC_W2_CALCULATE_G2, 353 SM_SC_W4_CALCULATE_G2, 354 SM_SC_W2_CALCULATE_F5_SALT, 355 SM_SC_W4_CALCULATE_F5_SALT, 356 SM_SC_W2_CALCULATE_F5_MACKEY, 357 SM_SC_W4_CALCULATE_F5_MACKEY, 358 SM_SC_W2_CALCULATE_F5_LTK, 359 SM_SC_W4_CALCULATE_F5_LTK, 360 SM_SC_W2_CALCULATE_F6_FOR_DHKEY_CHECK, 361 SM_SC_W4_CALCULATE_F6_FOR_DHKEY_CHECK, 362 SM_SC_W2_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK, 363 SM_SC_W4_CALCULATE_F6_TO_VERIFY_DHKEY_CHECK, 364 SM_SC_W4_USER_RESPONSE, 365 SM_SC_SEND_DHKEY_CHECK_COMMAND, 366 SM_SC_W4_DHKEY_CHECK_COMMAND, 367 SM_SC_W4_LTK_REQUEST_SC, 368 SM_SC_W2_CALCULATE_H6_ILK, 369 SM_SC_W4_CALCULATE_H6_ILK, 370 SM_SC_W2_CALCULATE_H6_BR_EDR_LINK_KEY, 371 SM_SC_W4_CALCULATE_H6_BR_EDR_LINK_KEY, 372 } security_manager_state_t; 373 374 typedef enum { 375 IRK_LOOKUP_IDLE, 376 IRK_LOOKUP_W4_READY, 377 IRK_LOOKUP_STARTED, 378 IRK_LOOKUP_SUCCEEDED, 379 IRK_LOOKUP_FAILED 380 } irk_lookup_state_t; 381 382 // Authorization state 383 typedef enum { 384 AUTHORIZATION_UNKNOWN, 385 AUTHORIZATION_PENDING, 386 AUTHORIZATION_DECLINED, 387 AUTHORIZATION_GRANTED 388 } authorization_state_t; 389 390 typedef uint8_t sm_pairing_packet_t[7]; 391 392 // connection info available as long as connection exists 393 typedef struct sm_connection { 394 hci_con_handle_t sm_handle; 395 uint8_t sm_role; // 0 - IamMaster, 1 = IamSlave 396 uint8_t sm_security_request_received; 397 uint8_t sm_bonding_requested; 398 uint8_t sm_peer_addr_type; 399 bd_addr_t sm_peer_address; 400 security_manager_state_t sm_engine_state; 401 irk_lookup_state_t sm_irk_lookup_state; 402 uint8_t sm_connection_encrypted; 403 uint8_t sm_connection_authenticated; // [0..1] 404 uint8_t sm_actual_encryption_key_size; 405 sm_pairing_packet_t sm_m_preq; // only used during c1 406 authorization_state_t sm_connection_authorization_state; 407 uint16_t sm_local_ediv; 408 uint8_t sm_local_rand[8]; 409 int sm_le_db_index; 410 } sm_connection_t; 411 412 // 413 // ATT Server 414 // 415 416 // max ATT request matches L2CAP PDU -- allow to use smaller buffer 417 #ifndef ATT_REQUEST_BUFFER_SIZE 418 #define ATT_REQUEST_BUFFER_SIZE HCI_ACL_PAYLOAD_SIZE 419 #endif 420 421 typedef enum { 422 ATT_SERVER_IDLE, 423 ATT_SERVER_REQUEST_RECEIVED, 424 ATT_SERVER_W4_SIGNED_WRITE_VALIDATION, 425 ATT_SERVER_REQUEST_RECEIVED_AND_VALIDATED, 426 } att_server_state_t; 427 428 typedef struct { 429 att_server_state_t state; 430 431 uint8_t peer_addr_type; 432 bd_addr_t peer_address; 433 434 int ir_le_device_db_index; 435 int ir_lookup_active; 436 437 int value_indication_handle; 438 btstack_timer_source_t value_indication_timer; 439 440 att_connection_t connection; 441 442 uint16_t request_size; 443 uint8_t request_buffer[ATT_REQUEST_BUFFER_SIZE]; 444 445 } att_server_t; 446 447 #endif 448 449 #ifdef ENABLE_L2CAP_ENHANCED_RETRANSMISSION_MODE 450 typedef enum { 451 L2CAP_INFORMATION_STATE_IDLE = 0, 452 L2CAP_INFORMATION_STATE_W2_SEND_EXTENDED_FEATURE_REQUEST, 453 L2CAP_INFORMATION_STATE_W4_EXTENDED_FEATURE_RESPONSE, 454 L2CAP_INFORMATION_STATE_DONE 455 } l2cap_information_state_t; 456 457 typedef struct { 458 l2cap_information_state_t information_state; 459 uint16_t extended_feature_mask; 460 } l2cap_state_t; 461 #endif 462 463 // 464 typedef struct { 465 // linked list - assert: first field 466 btstack_linked_item_t item; 467 468 // remote side 469 bd_addr_t address; 470 471 // module handle 472 hci_con_handle_t con_handle; 473 474 // le public, le random, classic 475 bd_addr_type_t address_type; 476 477 // role: 0 - master, 1 - slave 478 uint8_t role; 479 480 // connection state 481 CONNECTION_STATE state; 482 483 // bonding 484 uint16_t bonding_flags; 485 uint8_t bonding_status; 486 // requested security level 487 gap_security_level_t requested_security_level; 488 489 // 490 link_key_type_t link_key_type; 491 492 // remote supported features 493 uint8_t remote_supported_feature_eSCO; 494 495 // errands 496 uint32_t authentication_flags; 497 498 btstack_timer_source_t timeout; 499 500 // timeout in system ticks (HAVE_EMBEDDED_TICK) or milliseconds (HAVE_EMBEDDED_TIME_MS) 501 uint32_t timestamp; 502 503 // ACL packet recombination - PRE_BUFFER + ACL Header + ACL payload 504 uint8_t acl_recombination_buffer[HCI_INCOMING_PRE_BUFFER_SIZE + 4 + HCI_ACL_BUFFER_SIZE]; 505 uint16_t acl_recombination_pos; 506 uint16_t acl_recombination_length; 507 508 // number packets sent to controller 509 uint8_t num_acl_packets_sent; 510 uint8_t num_sco_packets_sent; 511 512 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 513 uint8_t num_packets_completed; 514 #endif 515 516 // LE Connection parameter update 517 le_con_parameter_update_state_t le_con_parameter_update_state; 518 uint8_t le_con_param_update_identifier; 519 uint16_t le_conn_interval_min; 520 uint16_t le_conn_interval_max; 521 uint16_t le_conn_latency; 522 uint16_t le_supervision_timeout; 523 524 #ifdef ENABLE_BLE 525 // LE Security Manager 526 sm_connection_t sm_connection; 527 528 // ATT Server 529 att_server_t att_server; 530 #endif 531 532 #ifdef ENABLE_L2CAP_ENHANCED_RETRANSMISSION_MODE 533 l2cap_state_t l2cap_state; 534 #endif 535 536 } hci_connection_t; 537 538 539 /** 540 * HCI Inititizlization State Machine 541 */ 542 typedef enum hci_init_state{ 543 HCI_INIT_SEND_RESET = 0, 544 HCI_INIT_W4_SEND_RESET, 545 HCI_INIT_SEND_READ_LOCAL_VERSION_INFORMATION, 546 HCI_INIT_W4_SEND_READ_LOCAL_VERSION_INFORMATION, 547 HCI_INIT_SEND_READ_LOCAL_NAME, 548 HCI_INIT_W4_SEND_READ_LOCAL_NAME, 549 550 HCI_INIT_SEND_BAUD_CHANGE, 551 HCI_INIT_W4_SEND_BAUD_CHANGE, 552 HCI_INIT_CUSTOM_INIT, 553 HCI_INIT_W4_CUSTOM_INIT, 554 HCI_INIT_SEND_RESET_CSR_WARM_BOOT, 555 HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT, 556 HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT_LINK_RESET, 557 HCI_INIT_W4_CUSTOM_INIT_BCM_DELAY, 558 559 HCI_INIT_READ_LOCAL_SUPPORTED_COMMANDS, 560 HCI_INIT_W4_READ_LOCAL_SUPPORTED_COMMANDS, 561 562 HCI_INIT_SEND_BAUD_CHANGE_BCM, 563 HCI_INIT_W4_SEND_BAUD_CHANGE_BCM, 564 565 HCI_INIT_SET_BD_ADDR, 566 HCI_INIT_W4_SET_BD_ADDR, 567 568 HCI_INIT_SEND_RESET_ST_WARM_BOOT, 569 HCI_INIT_W4_SEND_RESET_ST_WARM_BOOT, 570 571 HCI_INIT_READ_BD_ADDR, 572 HCI_INIT_W4_READ_BD_ADDR, 573 574 HCI_INIT_READ_BUFFER_SIZE, 575 HCI_INIT_W4_READ_BUFFER_SIZE, 576 HCI_INIT_READ_LOCAL_SUPPORTED_FEATURES, 577 HCI_INIT_W4_READ_LOCAL_SUPPORTED_FEATURES, 578 579 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 580 HCI_INIT_HOST_BUFFER_SIZE, 581 HCI_INIT_W4_HOST_BUFFER_SIZE, 582 HCI_INIT_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, 583 HCI_INIT_W4_SET_CONTROLLER_TO_HOST_FLOW_CONTROL, 584 #endif 585 586 HCI_INIT_SET_EVENT_MASK, 587 HCI_INIT_W4_SET_EVENT_MASK, 588 589 HCI_INIT_WRITE_SIMPLE_PAIRING_MODE, 590 HCI_INIT_W4_WRITE_SIMPLE_PAIRING_MODE, 591 HCI_INIT_WRITE_PAGE_TIMEOUT, 592 HCI_INIT_W4_WRITE_PAGE_TIMEOUT, 593 HCI_INIT_WRITE_CLASS_OF_DEVICE, 594 HCI_INIT_W4_WRITE_CLASS_OF_DEVICE, 595 HCI_INIT_WRITE_LOCAL_NAME, 596 HCI_INIT_W4_WRITE_LOCAL_NAME, 597 HCI_INIT_WRITE_EIR_DATA, 598 HCI_INIT_W4_WRITE_EIR_DATA, 599 HCI_INIT_WRITE_INQUIRY_MODE, 600 HCI_INIT_W4_WRITE_INQUIRY_MODE, 601 HCI_INIT_WRITE_SCAN_ENABLE, 602 HCI_INIT_W4_WRITE_SCAN_ENABLE, 603 604 // SCO over HCI 605 HCI_INIT_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 606 HCI_INIT_W4_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 607 HCI_INIT_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 608 HCI_INIT_W4_WRITE_DEFAULT_ERRONEOUS_DATA_REPORTING, 609 610 // SCO over HCI Broadcom 611 HCI_INIT_BCM_WRITE_SCO_PCM_INT, 612 HCI_INIT_W4_BCM_WRITE_SCO_PCM_INT, 613 614 #ifdef ENABLE_BLE 615 HCI_INIT_LE_READ_BUFFER_SIZE, 616 HCI_INIT_W4_LE_READ_BUFFER_SIZE, 617 HCI_INIT_WRITE_LE_HOST_SUPPORTED, 618 HCI_INIT_W4_WRITE_LE_HOST_SUPPORTED, 619 HCI_INIT_LE_SET_EVENT_MASK, 620 HCI_INIT_W4_LE_SET_EVENT_MASK, 621 #endif 622 623 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION 624 HCI_INIT_LE_READ_MAX_DATA_LENGTH, 625 HCI_INIT_W4_LE_READ_MAX_DATA_LENGTH, 626 HCI_INIT_LE_WRITE_SUGGESTED_DATA_LENGTH, 627 HCI_INIT_W4_LE_WRITE_SUGGESTED_DATA_LENGTH, 628 #endif 629 630 #ifdef ENABLE_LE_CENTRAL 631 HCI_INIT_READ_WHITE_LIST_SIZE, 632 HCI_INIT_W4_READ_WHITE_LIST_SIZE, 633 634 HCI_INIT_LE_SET_SCAN_PARAMETERS, 635 HCI_INIT_W4_LE_SET_SCAN_PARAMETERS, 636 #endif 637 638 HCI_INIT_DONE, 639 640 HCI_FALLING_ASLEEP_DISCONNECT, 641 HCI_FALLING_ASLEEP_W4_WRITE_SCAN_ENABLE, 642 HCI_FALLING_ASLEEP_COMPLETE, 643 644 HCI_INIT_AFTER_SLEEP 645 646 } hci_substate_t; 647 648 enum { 649 LE_ADVERTISEMENT_TASKS_DISABLE = 1 << 0, 650 LE_ADVERTISEMENT_TASKS_SET_ADV_DATA = 1 << 1, 651 LE_ADVERTISEMENT_TASKS_SET_SCAN_DATA = 1 << 2, 652 LE_ADVERTISEMENT_TASKS_SET_PARAMS = 1 << 3, 653 LE_ADVERTISEMENT_TASKS_ENABLE = 1 << 4, 654 }; 655 656 enum { 657 LE_WHITELIST_ON_CONTROLLER = 1 << 0, 658 LE_WHITELIST_ADD_TO_CONTROLLER = 1 << 1, 659 LE_WHITELIST_REMOVE_FROM_CONTROLLER = 1 << 2, 660 }; 661 662 typedef struct { 663 btstack_linked_item_t item; 664 bd_addr_t address; 665 bd_addr_type_t address_type; 666 uint8_t state; 667 } whitelist_entry_t; 668 669 /** 670 * main data structure 671 */ 672 typedef struct { 673 // transport component with configuration 674 const hci_transport_t * hci_transport; 675 const void * config; 676 677 // chipset driver 678 const btstack_chipset_t * chipset; 679 680 // hardware power controller 681 const btstack_control_t * control; 682 683 /* link key db */ 684 const btstack_link_key_db_t * link_key_db; 685 686 // list of existing baseband connections 687 btstack_linked_list_t connections; 688 689 /* callback to L2CAP layer */ 690 btstack_packet_handler_t acl_packet_handler; 691 692 /* callback for SCO data */ 693 btstack_packet_handler_t sco_packet_handler; 694 695 /* callbacks for events */ 696 btstack_linked_list_t event_handlers; 697 698 // hardware error callback 699 void (*hardware_error_callback)(uint8_t error); 700 701 // basic configuration 702 const char * local_name; 703 const uint8_t * eir_data; 704 uint32_t class_of_device; 705 bd_addr_t local_bd_addr; 706 uint8_t ssp_enable; 707 uint8_t ssp_io_capability; 708 uint8_t ssp_authentication_requirement; 709 uint8_t ssp_auto_accept; 710 inquiry_mode_t inquiry_mode; 711 712 // single buffer for HCI packet assembly + additional prebuffer for H4 drivers 713 uint8_t * hci_packet_buffer; 714 uint8_t hci_packet_buffer_data[HCI_OUTGOING_PRE_BUFFER_SIZE + HCI_PACKET_BUFFER_SIZE]; 715 uint8_t hci_packet_buffer_reserved; 716 uint16_t acl_fragmentation_pos; 717 uint16_t acl_fragmentation_total_size; 718 719 /* host to controller flow control */ 720 uint8_t num_cmd_packets; 721 uint8_t acl_packets_total_num; 722 uint16_t acl_data_packet_length; 723 uint8_t sco_packets_total_num; 724 uint8_t sco_data_packet_length; 725 uint8_t synchronous_flow_control_enabled; 726 uint8_t le_acl_packets_total_num; 727 uint16_t le_data_packets_length; 728 uint8_t sco_waiting_for_can_send_now; 729 730 /* local supported features */ 731 uint8_t local_supported_features[8]; 732 733 /* local supported commands summary - complete info is 64 bytes */ 734 /* 0 - Read Buffer Size */ 735 /* 1 - Write Le Host Supported */ 736 /* 2 - Write Synchronous Flow Control Enable (Octet 10/bit 4) */ 737 /* 3 - Write Default Erroneous Data Reporting (Octet 18/bit 3) */ 738 /* 4 - LE Write Suggested Default Data Length (Octet 34/bit 0) */ 739 /* 5 - LE Read Maximum Data Length (Octet 35/bit 3) */ 740 uint8_t local_supported_commands[1]; 741 742 /* bluetooth device information from hci read local version information */ 743 // uint16_t hci_version; 744 // uint16_t hci_revision; 745 // uint16_t lmp_version; 746 uint16_t manufacturer; 747 // uint16_t lmp_subversion; 748 749 // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE 750 uint16_t packet_types; 751 752 753 /* hci state machine */ 754 HCI_STATE state; 755 hci_substate_t substate; 756 btstack_timer_source_t timeout; 757 758 uint16_t last_cmd_opcode; 759 760 uint8_t cmds_ready; 761 762 /* buffer for scan enable cmd - 0xff no change */ 763 uint8_t new_scan_enable_value; 764 765 uint8_t discoverable; 766 uint8_t connectable; 767 uint8_t bondable; 768 769 uint8_t inquiry_state; // see hci.c for state defines 770 771 bd_addr_t remote_name_addr; 772 uint16_t remote_name_clock_offset; 773 uint8_t remote_name_page_scan_repetition_mode; 774 uint8_t remote_name_state; // see hci.c for state defines 775 776 bd_addr_t gap_pairing_addr; 777 uint8_t gap_pairing_state; // see hci.c for state defines 778 union { 779 const char * gap_pairing_pin; 780 uint32_t gap_pairing_passkey; 781 }; 782 783 uint16_t sco_voice_setting; 784 uint16_t sco_voice_setting_active; 785 786 uint8_t loopback_mode; 787 788 // buffer for single connection decline 789 uint8_t decline_reason; 790 bd_addr_t decline_addr; 791 792 #ifdef ENABLE_HCI_CONTROLLER_TO_HOST_FLOW_CONTROL 793 uint8_t host_completed_packets; 794 #endif 795 796 #ifdef ENABLE_BLE 797 uint8_t le_own_addr_type; 798 bd_addr_t le_random_address; 799 uint8_t le_random_address_set; 800 #endif 801 802 #ifdef ENABLE_LE_CENTRAL 803 le_scanning_state_t le_scanning_state; 804 le_connecting_state_t le_connecting_state; 805 806 // buffer for le scan type command - 0xff not set 807 uint8_t le_scan_type; 808 uint16_t le_scan_interval; 809 uint16_t le_scan_window; 810 811 // LE Whitelist Management 812 uint8_t le_whitelist_capacity; 813 btstack_linked_list_t le_whitelist; 814 815 // Connection parameters 816 uint16_t le_connection_interval_min; 817 uint16_t le_connection_interval_max; 818 uint16_t le_connection_latency; 819 uint16_t le_supervision_timeout; 820 uint16_t le_minimum_ce_length; 821 uint16_t le_maximum_ce_length; 822 #endif 823 824 le_connection_parameter_range_t le_connection_parameter_range; 825 826 #ifdef ENABLE_LE_PERIPHERAL 827 uint8_t * le_advertisements_data; 828 uint8_t le_advertisements_data_len; 829 830 uint8_t * le_scan_response_data; 831 uint8_t le_scan_response_data_len; 832 833 uint8_t le_advertisements_active; 834 uint8_t le_advertisements_enabled; 835 uint8_t le_advertisements_todo; 836 837 uint16_t le_advertisements_interval_min; 838 uint16_t le_advertisements_interval_max; 839 uint8_t le_advertisements_type; 840 uint8_t le_advertisements_direct_address_type; 841 uint8_t le_advertisements_channel_map; 842 uint8_t le_advertisements_filter_policy; 843 bd_addr_t le_advertisements_direct_address; 844 #endif 845 846 #ifdef ENABLE_LE_DATA_LENGTH_EXTENSION 847 // LE Data Length 848 uint16_t le_supported_max_tx_octets; 849 uint16_t le_supported_max_tx_time; 850 #endif 851 852 // custom BD ADDR 853 bd_addr_t custom_bd_addr; 854 uint8_t custom_bd_addr_set; 855 856 } hci_stack_t; 857 858 859 /* API_START */ 860 861 862 // HCI init and configuration 863 864 865 /** 866 * @brief Set up HCI. Needs to be called before any other function. 867 */ 868 void hci_init(const hci_transport_t *transport, const void *config); 869 870 /** 871 * @brief Configure Bluetooth chipset driver. Has to be called before power on, or right after receiving the local version information. 872 */ 873 void hci_set_chipset(const btstack_chipset_t *chipset_driver); 874 875 /** 876 * @brief Configure Bluetooth hardware control. Has to be called before power on. 877 */ 878 void hci_set_control(const btstack_control_t *hardware_control); 879 880 /** 881 * @brief Configure Bluetooth hardware control. Has to be called before power on. 882 */ 883 void hci_set_link_key_db(btstack_link_key_db_t const * link_key_db); 884 885 /** 886 * @brief Set callback for Bluetooth Hardware Error 887 */ 888 void hci_set_hardware_error_callback(void (*fn)(uint8_t error)); 889 890 /** 891 * @brief Set Public BD ADDR - passed on to Bluetooth chipset during init if supported in bt_control_h 892 */ 893 void hci_set_bd_addr(bd_addr_t addr); 894 895 /** 896 * @brief Configure Voice Setting for use with SCO data in HSP/HFP 897 */ 898 void hci_set_sco_voice_setting(uint16_t voice_setting); 899 900 /** 901 * @brief Get SCO Voice Setting 902 * @return current voice setting 903 */ 904 uint16_t hci_get_sco_voice_setting(void); 905 906 /** 907 * @brief Set inquiry mode: standard, with RSSI, with RSSI + Extended Inquiry Results. Has to be called before power on. 908 * @param inquriy_mode see bluetooth_defines.h 909 */ 910 void hci_set_inquiry_mode(inquiry_mode_t mode); 911 912 /** 913 * @brief Requests the change of BTstack power mode. 914 */ 915 int hci_power_control(HCI_POWER_MODE mode); 916 917 /** 918 * @brief Shutdown HCI 919 */ 920 void hci_close(void); 921 922 923 // Callback registration 924 925 926 /** 927 * @brief Add event packet handler. 928 */ 929 void hci_add_event_handler(btstack_packet_callback_registration_t * callback_handler); 930 931 /** 932 * @brief Registers a packet handler for ACL data. Used by L2CAP 933 */ 934 void hci_register_acl_packet_handler(btstack_packet_handler_t handler); 935 936 /** 937 * @brief Registers a packet handler for SCO data. Used for HSP and HFP profiles. 938 */ 939 void hci_register_sco_packet_handler(btstack_packet_handler_t handler); 940 941 942 // Sending HCI Commands 943 944 /** 945 * @brief Check if CMD packet can be sent to controller 946 */ 947 int hci_can_send_command_packet_now(void); 948 949 /** 950 * @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. 951 */ 952 int hci_send_cmd(const hci_cmd_t *cmd, ...); 953 954 955 // Sending SCO Packets 956 957 /** @brief Get SCO packet length for current SCO Voice setting 958 * @note Using SCO packets of the exact length is required for USB transfer 959 * @return Length of SCO packets in bytes (not audio frames) incl. 3 byte header 960 */ 961 int hci_get_sco_packet_length(void); 962 963 /** 964 * @brief Request emission of HCI_EVENT_SCO_CAN_SEND_NOW as soon as possible 965 * @note HCI_EVENT_SCO_CAN_SEND_NOW might be emitted during call to this function 966 * so packet handler should be ready to handle it 967 */ 968 void hci_request_sco_can_send_now_event(void); 969 970 /** 971 * @brief Check HCI packet buffer and if SCO packet can be sent to controller 972 */ 973 int hci_can_send_sco_packet_now(void); 974 975 /** 976 * @brief Check if SCO packet can be sent to controller 977 */ 978 int hci_can_send_prepared_sco_packet_now(void); 979 980 /** 981 * @brief Send SCO packet prepared in HCI packet buffer 982 */ 983 int hci_send_sco_packet_buffer(int size); 984 985 986 // Outgoing packet buffer, also used for SCO packets 987 // see hci_can_send_prepared_sco_packet_now amn hci_send_sco_packet_buffer 988 989 /** 990 * Reserves outgoing packet buffer. 991 * @return 1 on success 992 */ 993 int hci_reserve_packet_buffer(void); 994 995 /** 996 * Get pointer for outgoing packet buffer 997 */ 998 uint8_t* hci_get_outgoing_packet_buffer(void); 999 1000 /** 1001 * Release outgoing packet buffer\ 1002 * @note only called instead of hci_send_preparared 1003 */ 1004 void hci_release_packet_buffer(void); 1005 1006 1007 /* API_END */ 1008 1009 1010 /** 1011 * va_list version of hci_send_cmd 1012 */ 1013 int hci_send_cmd_va_arg(const hci_cmd_t *cmd, va_list argtr); 1014 1015 /** 1016 * Get connection iterator. Only used by l2cap.c and sm.c 1017 */ 1018 void hci_connections_get_iterator(btstack_linked_list_iterator_t *it); 1019 1020 /** 1021 * Get internal hci_connection_t for given handle. Used by L2CAP, SM, daemon 1022 */ 1023 hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle); 1024 1025 /** 1026 * Get internal hci_connection_t for given Bluetooth addres. Called by L2CAP 1027 */ 1028 hci_connection_t * hci_connection_for_bd_addr_and_type(bd_addr_t addr, bd_addr_type_t addr_type); 1029 1030 /** 1031 * Check if outgoing packet buffer is reserved. Used for internal checks in l2cap.c 1032 */ 1033 int hci_is_packet_buffer_reserved(void); 1034 1035 /** 1036 * Check hci packet buffer is free and a classic acl packet can be sent to controller 1037 */ 1038 int hci_can_send_acl_classic_packet_now(void); 1039 1040 /** 1041 * Check hci packet buffer is free and an LE acl packet can be sent to controller 1042 */ 1043 int hci_can_send_acl_le_packet_now(void); 1044 1045 /** 1046 * Check hci packet buffer is free and an acl packet for the given handle can be sent to controller 1047 */ 1048 int hci_can_send_acl_packet_now(hci_con_handle_t con_handle); 1049 1050 /** 1051 * Check if acl packet for the given handle can be sent to controller 1052 */ 1053 int hci_can_send_prepared_acl_packet_now(hci_con_handle_t con_handle); 1054 1055 /** 1056 * Send acl packet prepared in hci packet buffer 1057 */ 1058 int hci_send_acl_packet_buffer(int size); 1059 1060 /** 1061 * Check if authentication is active. It delays automatic disconnect while no L2CAP connection 1062 * Called by l2cap. 1063 */ 1064 int hci_authentication_active_for_handle(hci_con_handle_t handle); 1065 1066 /** 1067 * Get maximal ACL Classic data packet length based on used buffer size. Called by L2CAP 1068 */ 1069 uint16_t hci_max_acl_data_packet_length(void); 1070 1071 /** 1072 * Get supported packet types. Called by L2CAP 1073 */ 1074 uint16_t hci_usable_acl_packet_types(void); 1075 1076 /** 1077 * Check if ACL packets marked as non flushable can be sent. Called by L2CAP 1078 */ 1079 int hci_non_flushable_packet_boundary_flag_supported(void); 1080 1081 /** 1082 * Check if extended SCO Link is supported 1083 */ 1084 int hci_extended_sco_link_supported(void); 1085 1086 /** 1087 * Check if SSP is supported on both sides. Called by L2CAP 1088 */ 1089 int gap_ssp_supported_on_both_sides(hci_con_handle_t handle); 1090 1091 /** 1092 * Disconn because of security block. Called by L2CAP 1093 */ 1094 void hci_disconnect_security_block(hci_con_handle_t con_handle); 1095 1096 /** 1097 * Query if remote side supports eSCO 1098 */ 1099 int hci_remote_esco_supported(hci_con_handle_t con_handle); 1100 1101 /** 1102 * Emit current HCI state. Called by daemon 1103 */ 1104 void hci_emit_state(void); 1105 1106 /** 1107 * Send complete CMD packet. Called by daemon 1108 */ 1109 int hci_send_cmd_packet(uint8_t *packet, int size); 1110 1111 /** 1112 * Disconnect all HCI connections. Called by daemon 1113 */ 1114 void hci_disconnect_all(void); 1115 1116 /** 1117 * Get number of free acl slots for packets of given handle. Called by daemon 1118 */ 1119 int hci_number_free_acl_slots_for_handle(hci_con_handle_t con_handle); 1120 1121 /** 1122 * @brief Set Advertisement Parameters 1123 * @param adv_int_min 1124 * @param adv_int_max 1125 * @param adv_type 1126 * @param direct_address_type 1127 * @param direct_address 1128 * @param channel_map 1129 * @param filter_policy 1130 * 1131 * @note internal use. use gap_advertisements_set_params from gap.h instead. 1132 */ 1133 void hci_le_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 1134 uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy); 1135 1136 /** 1137 * 1138 * @note internal use. use gap_random_address_set_mode from gap.h instead. 1139 */ 1140 void hci_le_set_own_address_type(uint8_t own_address_type); 1141 1142 /** 1143 * @brief Get Manufactured 1144 * @return manufacturer id 1145 */ 1146 uint16_t hci_get_manufacturer(void); 1147 1148 // Only for PTS testing 1149 1150 /** 1151 * Disable automatic L2CAP disconnect if no L2CAP connection is established 1152 */ 1153 void hci_disable_l2cap_timeout_check(void); 1154 1155 /** 1156 * Get state 1157 */ 1158 HCI_STATE hci_get_state(void); 1159 1160 #if defined __cplusplus 1161 } 1162 #endif 1163 1164 #endif // __HCI_H 1165