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