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/hci_cmds.h> 51 #include <btstack/utils.h> 52 #include "hci_transport.h" 53 #include "bt_control.h" 54 #include "remote_device_db.h" 55 56 #include <stdint.h> 57 #include <stdlib.h> 58 #include <stdarg.h> 59 #include <btstack/linked_list.h> 60 61 #if defined __cplusplus 62 extern "C" { 63 #endif 64 65 // HCI roles 66 #define HCI_ROLE_MASTER 0 67 #define HCI_ROLE_SLAVE 1 68 69 // packet header sizes 70 #define HCI_CMD_HEADER_SIZE 3 71 #define HCI_ACL_HEADER_SIZE 4 72 #define HCI_SCO_HEADER_SIZE 3 73 #define HCI_EVENT_HEADER_SIZE 2 74 75 // packet sizes (max payload) 76 #define HCI_ACL_DM1_SIZE 17 77 #define HCI_ACL_DH1_SIZE 27 78 #define HCI_ACL_2DH1_SIZE 54 79 #define HCI_ACL_3DH1_SIZE 83 80 #define HCI_ACL_DM3_SIZE 121 81 #define HCI_ACL_DH3_SIZE 183 82 #define HCI_ACL_DM5_SIZE 224 83 #define HCI_ACL_DH5_SIZE 339 84 #define HCI_ACL_2DH3_SIZE 367 85 #define HCI_ACL_3DH3_SIZE 552 86 #define HCI_ACL_2DH5_SIZE 679 87 #define HCI_ACL_3DH5_SIZE 1021 88 89 #define HCI_EVENT_PAYLOAD_SIZE 255 90 #define HCI_CMD_PAYLOAD_SIZE 255 91 92 #define LE_ADVERTISING_DATA_SIZE 31 93 94 // packet buffer sizes 95 // HCI_ACL_PAYLOAD_SIZE is configurable and defined in config.h 96 #define HCI_EVENT_BUFFER_SIZE (HCI_EVENT_HEADER_SIZE + HCI_EVENT_PAYLOAD_SIZE) 97 #define HCI_CMD_BUFFER_SIZE (HCI_CMD_HEADER_SIZE + HCI_CMD_PAYLOAD_SIZE) 98 #define HCI_ACL_BUFFER_SIZE (HCI_ACL_HEADER_SIZE + HCI_ACL_PAYLOAD_SIZE) 99 100 // size of hci buffers, big enough for command, event, or acl packet without H4 packet type 101 // @note cmd buffer is bigger than event buffer 102 #ifdef HCI_PACKET_BUFFER_SIZE 103 #if HCI_PACKET_BUFFER_SIZE < HCI_ACL_BUFFER_SIZE 104 #error HCI_PACKET_BUFFER_SIZE must be equal or larger than HCI_ACL_BUFFER_SIZE 105 #endif 106 #if HCI_PACKET_BUFFER_SIZE < HCI_CMD_BUFFER_SIZE 107 #error HCI_PACKET_BUFFER_SIZE must be equal or larger than HCI_CMD_BUFFER_SIZE 108 #endif 109 #else 110 #if HCI_ACL_BUFFER_SIZE > HCI_CMD_BUFFER_SIZE 111 #define HCI_PACKET_BUFFER_SIZE HCI_ACL_BUFFER_SIZE 112 #else 113 #define HCI_PACKET_BUFFER_SIZE HCI_CMD_BUFFER_SIZE 114 #endif 115 #endif 116 117 // additional pre-buffer space for packets to Bluetooth module, for now, used for HCI Transport H4 DMA 118 #define HCI_OUTGOING_PRE_BUFFER_SIZE 1 119 120 // BNEP may uncompress the IP Header by 16 bytes 121 #ifdef HAVE_BNEP 122 #define HCI_INCOMING_PRE_BUFFER_SIZE (16 - HCI_ACL_HEADER_SIZE - 4) 123 #endif 124 #ifndef HCI_INCOMING_PRE_BUFFER_SIZE 125 #define HCI_INCOMING_PRE_BUFFER_SIZE 0 126 #endif 127 128 // OGFs 129 #define OGF_LINK_CONTROL 0x01 130 #define OGF_LINK_POLICY 0x02 131 #define OGF_CONTROLLER_BASEBAND 0x03 132 #define OGF_INFORMATIONAL_PARAMETERS 0x04 133 #define OGF_STATUS_PARAMETERS 0x05 134 #define OGF_TESTING 0x06 135 #define OGF_LE_CONTROLLER 0x08 136 #define OGF_BTSTACK 0x3d 137 #define OGF_VENDOR 0x3f 138 139 // cmds for BTstack 140 // get state: @returns HCI_STATE 141 #define BTSTACK_GET_STATE 0x01 142 143 // set power mode: @param HCI_POWER_MODE 144 #define BTSTACK_SET_POWER_MODE 0x02 145 146 // set capture mode: @param on 147 #define BTSTACK_SET_ACL_CAPTURE_MODE 0x03 148 149 // get BTstack version 150 #define BTSTACK_GET_VERSION 0x04 151 152 // get system Bluetooth state 153 #define BTSTACK_GET_SYSTEM_BLUETOOTH_ENABLED 0x05 154 155 // set system Bluetooth state 156 #define BTSTACK_SET_SYSTEM_BLUETOOTH_ENABLED 0x06 157 158 // enable inquiry scan for this client 159 #define BTSTACK_SET_DISCOVERABLE 0x07 160 161 // set global Bluetooth state 162 #define BTSTACK_SET_BLUETOOTH_ENABLED 0x08 163 164 // create l2cap channel: @param bd_addr(48), psm (16) 165 #define L2CAP_CREATE_CHANNEL 0x20 166 167 // disconnect l2cap disconnect, @param channel(16), reason(8) 168 #define L2CAP_DISCONNECT 0x21 169 170 // register l2cap service: @param psm(16), mtu (16) 171 #define L2CAP_REGISTER_SERVICE 0x22 172 173 // unregister l2cap disconnect, @param psm(16) 174 #define L2CAP_UNREGISTER_SERVICE 0x23 175 176 // accept connection @param bd_addr(48), dest cid (16) 177 #define L2CAP_ACCEPT_CONNECTION 0x24 178 179 // decline l2cap disconnect,@param bd_addr(48), dest cid (16), reason(8) 180 #define L2CAP_DECLINE_CONNECTION 0x25 181 182 // create l2cap channel: @param bd_addr(48), psm (16), mtu (16) 183 #define L2CAP_CREATE_CHANNEL_MTU 0x26 184 185 // register SDP Service Record: service record (size) 186 #define SDP_REGISTER_SERVICE_RECORD 0x30 187 188 // unregister SDP Service Record 189 #define SDP_UNREGISTER_SERVICE_RECORD 0x31 190 191 // Get remote RFCOMM services 192 #define SDP_CLIENT_QUERY_RFCOMM_SERVICES 0x32 193 194 // Get remote SDP services 195 #define SDP_CLIENT_QUERY_SERVICES 0x33 196 197 // RFCOMM "HCI" Commands 198 #define RFCOMM_CREATE_CHANNEL 0x40 199 #define RFCOMM_DISCONNECT 0x41 200 #define RFCOMM_REGISTER_SERVICE 0x42 201 #define RFCOMM_UNREGISTER_SERVICE 0x43 202 #define RFCOMM_ACCEPT_CONNECTION 0x44 203 #define RFCOMM_DECLINE_CONNECTION 0x45 204 #define RFCOMM_PERSISTENT_CHANNEL 0x46 205 #define RFCOMM_CREATE_CHANNEL_WITH_CREDITS 0x47 206 #define RFCOMM_REGISTER_SERVICE_WITH_CREDITS 0x48 207 #define RFCOMM_GRANT_CREDITS 0x49 208 209 // GAP Classic 0x50 210 #define GAP_DISCONNECT 0x50 211 212 // GAP LE 0x60 213 #define GAP_LE_SCAN_START 0x60 214 #define GAP_LE_SCAN_STOP 0x61 215 #define GAP_LE_CONNECT 0x62 216 #define GAP_LE_CONNECT_CANCEL 0x63 217 #define GAP_LE_SET_SCAN_PARAMETERS 0x64 218 219 // GATT (Client) 0x70 220 #define GATT_DISCOVER_ALL_PRIMARY_SERVICES 0x70 221 #define GATT_DISCOVER_PRIMARY_SERVICES_BY_UUID16 0x71 222 #define GATT_DISCOVER_PRIMARY_SERVICES_BY_UUID128 0x72 223 #define GATT_FIND_INCLUDED_SERVICES_FOR_SERVICE 0x73 224 #define GATT_DISCOVER_CHARACTERISTICS_FOR_SERVICE 0x74 225 #define GATT_DISCOVER_CHARACTERISTICS_FOR_SERVICE_BY_UUID128 0x75 226 #define GATT_DISCOVER_CHARACTERISTIC_DESCRIPTORS 0x76 227 #define GATT_READ_VALUE_OF_CHARACTERISTIC 0x77 228 #define GATT_READ_LONG_VALUE_OF_CHARACTERISTIC 0x78 229 #define GATT_WRITE_VALUE_OF_CHARACTERISTIC_WITHOUT_RESPONSE 0x79 230 #define GATT_WRITE_VALUE_OF_CHARACTERISTIC 0x7A 231 #define GATT_WRITE_LONG_VALUE_OF_CHARACTERISTIC 0x7B 232 #define GATT_RELIABLE_WRITE_LONG_VALUE_OF_CHARACTERISTIC 0x7C 233 #define GATT_READ_CHARACTERISTIC_DESCRIPTOR 0X7D 234 #define GATT_READ_LONG_CHARACTERISTIC_DESCRIPTOR 0X7E 235 #define GATT_WRITE_CHARACTERISTIC_DESCRIPTOR 0X7F 236 #define GATT_WRITE_LONG_CHARACTERISTIC_DESCRIPTOR 0X80 237 #define GATT_WRITE_CLIENT_CHARACTERISTIC_CONFIGURATION 0X81 238 #define GATT_GET_MTU 0x82 239 240 // 241 #define IS_COMMAND(packet, command) (READ_BT_16(packet,0) == command.opcode) 242 243 244 /** 245 * LE connection parameter update state 246 */ 247 248 typedef enum { 249 CON_PARAMETER_UPDATE_NONE, 250 CON_PARAMETER_UPDATE_SEND_REQUEST, 251 CON_PARAMETER_UPDATE_SEND_RESPONSE, 252 CON_PARAMETER_UPDATE_CHANGE_HCI_CON_PARAMETERS, 253 CON_PARAMETER_UPDATE_DENY 254 } le_con_parameter_update_state_t; 255 256 typedef struct le_connection_parameter_range{ 257 uint16_t le_conn_interval_min; 258 uint16_t le_conn_interval_max; 259 uint16_t le_conn_latency_min; 260 uint16_t le_conn_latency_max; 261 uint16_t le_supervision_timeout_min; 262 uint16_t le_supervision_timeout_max; 263 } le_connection_parameter_range_t; 264 265 // Authentication flags 266 typedef enum { 267 AUTH_FLAGS_NONE = 0x0000, 268 RECV_LINK_KEY_REQUEST = 0x0001, 269 HANDLE_LINK_KEY_REQUEST = 0x0002, 270 SENT_LINK_KEY_REPLY = 0x0004, 271 SENT_LINK_KEY_NEGATIVE_REQUEST = 0x0008, 272 RECV_LINK_KEY_NOTIFICATION = 0x0010, 273 DENY_PIN_CODE_REQUEST = 0x0040, 274 RECV_IO_CAPABILITIES_REQUEST = 0x0080, 275 SEND_IO_CAPABILITIES_REPLY = 0x0100, 276 SEND_USER_CONFIRM_REPLY = 0x0200, 277 SEND_USER_PASSKEY_REPLY = 0x0400, 278 279 // pairing status 280 LEGACY_PAIRING_ACTIVE = 0x2000, 281 SSP_PAIRING_ACTIVE = 0x4000, 282 283 // connection status 284 CONNECTION_ENCRYPTED = 0x8000, 285 } hci_authentication_flags_t; 286 287 /** 288 * Connection State 289 */ 290 typedef enum { 291 SEND_CREATE_CONNECTION = 0, 292 SENT_CREATE_CONNECTION, 293 SEND_CANCEL_CONNECTION, 294 SENT_CANCEL_CONNECTION, 295 RECEIVED_CONNECTION_REQUEST, 296 ACCEPTED_CONNECTION_REQUEST, 297 REJECTED_CONNECTION_REQUEST, 298 OPEN, 299 SEND_DISCONNECT, 300 SENT_DISCONNECT, 301 RECEIVED_DISCONNECTION_COMPLETE 302 } CONNECTION_STATE; 303 304 // bonding flags 305 enum { 306 BONDING_REQUEST_REMOTE_FEATURES = 0x01, 307 BONDING_RECEIVED_REMOTE_FEATURES = 0x02, 308 BONDING_REMOTE_SUPPORTS_SSP = 0x04, 309 BONDING_DISCONNECT_SECURITY_BLOCK = 0x08, 310 BONDING_DISCONNECT_DEDICATED_DONE = 0x10, 311 BONDING_SEND_AUTHENTICATE_REQUEST = 0x20, 312 BONDING_SEND_ENCRYPTION_REQUEST = 0x40, 313 BONDING_DEDICATED = 0x80, 314 BONDING_EMIT_COMPLETE_ON_DISCONNECT = 0x100 315 }; 316 317 typedef enum { 318 BLUETOOTH_OFF = 1, 319 BLUETOOTH_ON, 320 BLUETOOTH_ACTIVE 321 } BLUETOOTH_STATE; 322 323 // le central scanning state 324 typedef enum { 325 LE_SCAN_IDLE, 326 LE_START_SCAN, 327 LE_SCANNING, 328 LE_STOP_SCAN, 329 } le_scanning_state_t; 330 331 typedef enum { 332 LE_CONNECTING_IDLE, 333 LE_CONNECTING_DIRECT, 334 LE_CONNECTING_WHITELIST, 335 } le_connecting_state_t; 336 337 // 338 // SM internal types and globals 339 // 340 341 typedef enum { 342 343 // general states 344 // state = 0 345 SM_GENERAL_IDLE, 346 SM_GENERAL_SEND_PAIRING_FAILED, 347 SM_GENERAL_TIMEOUT, // no other security messages are exchanged 348 349 // Phase 1: Pairing Feature Exchange 350 SM_PH1_W4_USER_RESPONSE, 351 352 // Phase 2: Authenticating and Encrypting 353 354 // get random number for use as TK Passkey if we show it 355 SM_PH2_GET_RANDOM_TK, 356 SM_PH2_W4_RANDOM_TK, 357 358 // get local random number for confirm c1 359 SM_PH2_C1_GET_RANDOM_A, 360 SM_PH2_C1_W4_RANDOM_A, 361 SM_PH2_C1_GET_RANDOM_B, 362 SM_PH2_C1_W4_RANDOM_B, 363 364 // calculate confirm value for local side 365 // state = 10 366 SM_PH2_C1_GET_ENC_A, 367 SM_PH2_C1_W4_ENC_A, 368 SM_PH2_C1_GET_ENC_B, 369 SM_PH2_C1_W4_ENC_B, 370 371 // calculate confirm value for remote side 372 SM_PH2_C1_GET_ENC_C, 373 SM_PH2_C1_W4_ENC_C, 374 SM_PH2_C1_GET_ENC_D, 375 SM_PH2_C1_W4_ENC_D, 376 377 SM_PH2_C1_SEND_PAIRING_CONFIRM, 378 SM_PH2_SEND_PAIRING_RANDOM, 379 380 // calc STK 381 // state = 20 382 SM_PH2_CALC_STK, 383 SM_PH2_W4_STK, 384 385 SM_PH2_W4_CONNECTION_ENCRYPTED, 386 387 // Phase 3: Transport Specific Key Distribution 388 // calculate DHK, Y, EDIV, and LTK 389 SM_PH3_GET_RANDOM, 390 SM_PH3_W4_RANDOM, 391 SM_PH3_GET_DIV, 392 SM_PH3_W4_DIV, 393 SM_PH3_Y_GET_ENC, 394 SM_PH3_Y_W4_ENC, 395 SM_PH3_LTK_GET_ENC, 396 // state = 30 397 SM_PH3_LTK_W4_ENC, 398 SM_PH3_CSRK_GET_ENC, 399 SM_PH3_CSRK_W4_ENC, 400 401 // exchange keys 402 SM_PH3_DISTRIBUTE_KEYS, 403 SM_PH3_RECEIVE_KEYS, 404 405 // RESPONDER ROLE 406 // state = 35 407 SM_RESPONDER_IDLE, 408 SM_RESPONDER_SEND_SECURITY_REQUEST, 409 SM_RESPONDER_PH0_RECEIVED_LTK, 410 SM_RESPONDER_PH0_SEND_LTK_REQUESTED_NEGATIVE_REPLY, 411 SM_RESPONDER_PH1_W4_PAIRING_REQUEST, 412 SM_RESPONDER_PH1_PAIRING_REQUEST_RECEIVED, 413 SM_RESPONDER_PH1_SEND_PAIRING_RESPONSE, 414 SM_RESPONDER_PH1_W4_PAIRING_CONFIRM, 415 SM_RESPONDER_PH2_W4_PAIRING_RANDOM, 416 SM_RESPONDER_PH2_W4_LTK_REQUEST, 417 SM_RESPONDER_PH2_SEND_LTK_REPLY, 418 419 // Phase 4: re-establish previously distributed LTK 420 // state == 46 421 SM_RESPONDER_PH4_Y_GET_ENC, 422 SM_RESPONDER_PH4_Y_W4_ENC, 423 SM_RESPONDER_PH4_LTK_GET_ENC, 424 SM_RESPONDER_PH4_LTK_W4_ENC, 425 SM_RESPONDER_PH4_SEND_LTK, 426 427 // INITITIATOR ROLE 428 // state = 51 429 SM_INITIATOR_CONNECTED, 430 SM_INITIATOR_PH0_HAS_LTK, 431 SM_INITIATOR_PH0_SEND_START_ENCRYPTION, 432 SM_INITIATOR_PH0_W4_CONNECTION_ENCRYPTED, 433 SM_INITIATOR_PH1_W2_SEND_PAIRING_REQUEST, 434 SM_INITIATOR_PH1_SEND_PAIRING_REQUEST, 435 SM_INITIATOR_PH1_W4_PAIRING_RESPONSE, 436 SM_INITIATOR_PH2_W4_PAIRING_CONFIRM, 437 SM_INITIATOR_PH2_W4_PAIRING_RANDOM, 438 SM_INITIATOR_PH3_SEND_START_ENCRYPTION, 439 440 } security_manager_state_t; 441 442 typedef enum { 443 IRK_LOOKUP_IDLE, 444 IRK_LOOKUP_W4_READY, 445 IRK_LOOKUP_STARTED, 446 IRK_LOOKUP_SUCCEEDED, 447 IRK_LOOKUP_FAILED 448 } irk_lookup_state_t; 449 450 // Authorization state 451 typedef enum { 452 AUTHORIZATION_UNKNOWN, 453 AUTHORIZATION_PENDING, 454 AUTHORIZATION_DECLINED, 455 AUTHORIZATION_GRANTED 456 } authorization_state_t; 457 458 typedef struct sm_pairing_packet { 459 uint8_t code; 460 uint8_t io_capability; 461 uint8_t oob_data_flag; 462 uint8_t auth_req; 463 uint8_t max_encryption_key_size; 464 uint8_t initiator_key_distribution; 465 uint8_t responder_key_distribution; 466 } sm_pairing_packet_t; 467 468 // connection info available as long as connection exists 469 typedef struct sm_connection { 470 uint16_t sm_handle; 471 uint8_t sm_role; // 0 - IamMaster, 1 = IamSlave 472 uint8_t sm_security_request_received; 473 uint8_t sm_bonding_requested; 474 uint8_t sm_peer_addr_type; 475 bd_addr_t sm_peer_address; 476 security_manager_state_t sm_engine_state; 477 irk_lookup_state_t sm_irk_lookup_state; 478 uint8_t sm_connection_encrypted; 479 uint8_t sm_connection_authenticated; // [0..1] 480 uint8_t sm_actual_encryption_key_size; 481 sm_pairing_packet_t sm_m_preq; // only used during c1 482 authorization_state_t sm_connection_authorization_state; 483 uint16_t sm_local_ediv; 484 uint8_t sm_local_rand[8]; 485 int sm_le_db_index; 486 } sm_connection_t; 487 488 typedef struct { 489 // linked list - assert: first field 490 linked_item_t item; 491 492 // remote side 493 bd_addr_t address; 494 495 // module handle 496 hci_con_handle_t con_handle; 497 498 // le public, le random, classic 499 bd_addr_type_t address_type; 500 501 // role: 0 - master, 1 - slave 502 uint8_t role; 503 504 // connection state 505 CONNECTION_STATE state; 506 507 // bonding 508 uint16_t bonding_flags; 509 uint8_t bonding_status; 510 // requested security level 511 gap_security_level_t requested_security_level; 512 513 // 514 link_key_type_t link_key_type; 515 516 // remote supported features 517 uint8_t remote_supported_feature_eSCO; 518 519 // errands 520 uint32_t authentication_flags; 521 522 timer_source_t timeout; 523 524 #ifdef HAVE_TIME 525 // timer 526 struct timeval timestamp; 527 #endif 528 #ifdef HAVE_TICK 529 uint32_t timestamp; // timeout in system ticks 530 #endif 531 532 // ACL packet recombination - PRE_BUFFER + ACL Header + ACL payload 533 uint8_t acl_recombination_buffer[HCI_INCOMING_PRE_BUFFER_SIZE + 4 + HCI_ACL_BUFFER_SIZE]; 534 uint16_t acl_recombination_pos; 535 uint16_t acl_recombination_length; 536 537 // number packets sent to controller 538 uint8_t num_acl_packets_sent; 539 uint8_t num_sco_packets_sent; 540 541 // LE Connection parameter update 542 le_con_parameter_update_state_t le_con_parameter_update_state; 543 uint8_t le_con_param_update_identifier; 544 uint16_t le_conn_interval_min; 545 uint16_t le_conn_interval_max; 546 uint16_t le_conn_latency; 547 uint16_t le_supervision_timeout; 548 549 #ifdef HAVE_BLE 550 // LE Security Manager 551 sm_connection_t sm_connection; 552 #endif 553 554 } hci_connection_t; 555 556 557 /** 558 * HCI Inititizlization State Machine 559 */ 560 typedef enum hci_init_state{ 561 HCI_INIT_SEND_RESET = 0, 562 HCI_INIT_W4_SEND_RESET, 563 HCI_INIT_SEND_READ_LOCAL_VERSION_INFORMATION, 564 HCI_INIT_W4_SEND_READ_LOCAL_VERSION_INFORMATION, 565 566 HCI_INIT_SET_BD_ADDR, 567 HCI_INIT_W4_SET_BD_ADDR, 568 569 HCI_INIT_SEND_RESET_ST_WARM_BOOT, 570 HCI_INIT_W4_SEND_RESET_ST_WARM_BOOT, 571 572 HCI_INIT_SEND_BAUD_CHANGE, 573 HCI_INIT_W4_SEND_BAUD_CHANGE, 574 HCI_INIT_CUSTOM_INIT, 575 HCI_INIT_W4_CUSTOM_INIT, 576 HCI_INIT_SEND_RESET_CSR_WARM_BOOT, 577 HCI_INIT_W4_CUSTOM_INIT_CSR_WARM_BOOT, 578 579 HCI_INIT_READ_BD_ADDR, 580 HCI_INIT_W4_READ_BD_ADDR, 581 HCI_INIT_READ_LOCAL_SUPPORTED_COMMANDS, 582 HCI_INIT_W4_READ_LOCAL_SUPPORTED_COMMANDS, 583 584 HCI_INIT_READ_BUFFER_SIZE, 585 HCI_INIT_W4_READ_BUFFER_SIZE, 586 HCI_INIT_READ_LOCAL_SUPPORTED_FEATUES, 587 HCI_INIT_W4_READ_LOCAL_SUPPORTED_FEATUES, 588 HCI_INIT_SET_EVENT_MASK, 589 HCI_INIT_W4_SET_EVENT_MASK, 590 HCI_INIT_WRITE_SIMPLE_PAIRING_MODE, 591 HCI_INIT_W4_WRITE_SIMPLE_PAIRING_MODE, 592 HCI_INIT_WRITE_PAGE_TIMEOUT, 593 HCI_INIT_W4_WRITE_PAGE_TIMEOUT, 594 HCI_INIT_WRITE_CLASS_OF_DEVICE, 595 HCI_INIT_W4_WRITE_CLASS_OF_DEVICE, 596 HCI_INIT_WRITE_LOCAL_NAME, 597 HCI_INIT_W4_WRITE_LOCAL_NAME, 598 HCI_INIT_WRITE_SCAN_ENABLE, 599 HCI_INIT_W4_WRITE_SCAN_ENABLE, 600 601 HCI_INIT_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 602 HCI_INIT_W4_WRITE_SYNCHRONOUS_FLOW_CONTROL_ENABLE, 603 604 HCI_INIT_LE_READ_BUFFER_SIZE, 605 HCI_INIT_W4_LE_READ_BUFFER_SIZE, 606 HCI_INIT_WRITE_LE_HOST_SUPPORTED, 607 HCI_INIT_W4_WRITE_LE_HOST_SUPPORTED, 608 HCI_INIT_READ_WHITE_LIST_SIZE, 609 HCI_INIT_W4_READ_WHITE_LIST_SIZE, 610 611 HCI_INIT_LE_SET_SCAN_PARAMETERS, 612 HCI_INIT_W4_LE_SET_SCAN_PARAMETERS, 613 614 HCI_INIT_DONE, 615 616 HCI_FALLING_ASLEEP_DISCONNECT, 617 HCI_FALLING_ASLEEP_W4_WRITE_SCAN_ENABLE, 618 HCI_FALLING_ASLEEP_COMPLETE, 619 620 HCI_INIT_AFTER_SLEEP 621 622 } hci_substate_t; 623 624 enum { 625 LE_ADVERTISEMENT_TASKS_DISABLE = 1 << 0, 626 LE_ADVERTISEMENT_TASKS_SET_DATA = 1 << 1, 627 LE_ADVERTISEMENT_TASKS_SET_PARAMS = 1 << 2, 628 LE_ADVERTISEMENT_TASKS_ENABLE = 1 << 3, 629 }; 630 631 enum { 632 LE_WHITELIST_ON_CONTROLLER = 1 << 0, 633 LE_WHITELIST_ADD_TO_CONTROLLER = 1 << 1, 634 LE_WHITELIST_REMOVE_FROM_CONTROLLER = 1 << 2, 635 }; 636 637 typedef struct { 638 linked_item_t item; 639 bd_addr_t address; 640 bd_addr_type_t address_type; 641 uint8_t state; 642 } whitelist_entry_t; 643 644 /** 645 * main data structure 646 */ 647 typedef struct { 648 // transport component with configuration 649 hci_transport_t * hci_transport; 650 void * config; 651 652 // basic configuration 653 const char * local_name; 654 uint32_t class_of_device; 655 bd_addr_t local_bd_addr; 656 uint8_t ssp_enable; 657 uint8_t ssp_io_capability; 658 uint8_t ssp_authentication_requirement; 659 uint8_t ssp_auto_accept; 660 661 // hardware power controller 662 bt_control_t * control; 663 664 // list of existing baseband connections 665 linked_list_t connections; 666 667 // single buffer for HCI packet assembly + additional prebuffer for H4 drivers 668 uint8_t hci_packet_buffer_prefix[HCI_OUTGOING_PRE_BUFFER_SIZE]; 669 uint8_t hci_packet_buffer[HCI_PACKET_BUFFER_SIZE]; // opcode (16), len(8) 670 uint8_t hci_packet_buffer_reserved; 671 uint16_t acl_fragmentation_pos; 672 uint16_t acl_fragmentation_total_size; 673 674 /* host to controller flow control */ 675 uint8_t num_cmd_packets; 676 uint8_t acl_packets_total_num; 677 uint16_t acl_data_packet_length; 678 uint8_t sco_packets_total_num; 679 uint8_t sco_data_packet_length; 680 uint8_t synchronous_flow_control_enabled; 681 uint8_t le_acl_packets_total_num; 682 uint16_t le_data_packets_length; 683 684 /* local supported features */ 685 uint8_t local_supported_features[8]; 686 687 /* local supported commands summary - complete info is 64 bytes */ 688 /* 0 - read buffer size */ 689 /* 1 - write le host supported */ 690 uint8_t local_supported_commands[1]; 691 692 /* bluetooth device information from hci read local version information */ 693 // uint16_t hci_version; 694 // uint16_t hci_revision; 695 // uint16_t lmp_version; 696 uint16_t manufacturer; 697 // uint16_t lmp_subversion; 698 699 // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE 700 uint16_t packet_types; 701 702 /* callback to L2CAP layer */ 703 void (*packet_handler)(uint8_t packet_type, uint8_t *packet, uint16_t size); 704 705 /* callback for SCO data */ 706 void (*sco_packet_handler)(uint8_t packet_type, uint8_t *packet, uint16_t size); 707 708 /* remote device db */ 709 remote_device_db_t const*remote_device_db; 710 711 /* hci state machine */ 712 HCI_STATE state; 713 hci_substate_t substate; 714 timer_source_t timeout; 715 uint8_t cmds_ready; 716 717 uint16_t last_cmd_opcode; 718 719 uint8_t discoverable; 720 uint8_t connectable; 721 uint8_t bondable; 722 723 /* buffer for scan enable cmd - 0xff no change */ 724 uint8_t new_scan_enable_value; 725 726 uint16_t sco_voice_setting; 727 728 uint8_t loopback_mode; 729 730 // buffer for single connection decline 731 uint8_t decline_reason; 732 bd_addr_t decline_addr; 733 734 uint8_t adv_addr_type; 735 bd_addr_t adv_address; 736 737 le_scanning_state_t le_scanning_state; 738 le_connecting_state_t le_connecting_state; 739 740 // buffer for le scan type command - 0xff not set 741 uint8_t le_scan_type; 742 uint16_t le_scan_interval; 743 uint16_t le_scan_window; 744 745 le_connection_parameter_range_t le_connection_parameter_range; 746 747 uint8_t * le_advertisements_data; 748 uint8_t le_advertisements_data_len; 749 750 uint8_t le_advertisements_active; 751 uint8_t le_advertisements_enabled; 752 uint8_t le_advertisements_todo; 753 754 uint16_t le_advertisements_interval_min; 755 uint16_t le_advertisements_interval_max; 756 uint8_t le_advertisements_type; 757 uint8_t le_advertisements_own_address_type; 758 uint8_t le_advertisements_direct_address_type; 759 uint8_t le_advertisements_channel_map; 760 uint8_t le_advertisements_filter_policy; 761 bd_addr_t le_advertisements_direct_address; 762 763 // LE Whitelist Management 764 uint16_t le_whitelist_capacity; 765 linked_list_t le_whitelist; 766 767 // custom BD ADDR 768 bd_addr_t custom_bd_addr; 769 uint8_t custom_bd_addr_set; 770 771 // hardware error handler 772 void (*hardware_error_callback)(void); 773 774 } hci_stack_t; 775 776 /** 777 * set connection iterator 778 */ 779 void hci_connections_get_iterator(linked_list_iterator_t *it); 780 781 // create and send hci command packets based on a template and a list of parameters 782 uint16_t hci_create_cmd(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, ...); 783 uint16_t hci_create_cmd_internal(uint8_t *hci_cmd_buffer, const hci_cmd_t *cmd, va_list argptr); 784 785 /** 786 * run the hci control loop once 787 */ 788 void hci_run(void); 789 790 // send ACL packet prepared in hci packet buffer 791 int hci_send_acl_packet_buffer(int size); 792 793 // send SCO packet prepared in hci packet buffer 794 int hci_send_sco_packet_buffer(int size); 795 796 797 int hci_can_send_acl_packet_now(hci_con_handle_t con_handle); 798 int hci_can_send_prepared_acl_packet_now(hci_con_handle_t con_handle); 799 int hci_can_send_sco_packet_now(hci_con_handle_t con_handle); 800 int hci_can_send_prepared_sco_packet_now(hci_con_handle_t con_handle); 801 802 // reserves outgoing packet buffer. @returns 1 if successful 803 int hci_reserve_packet_buffer(void); 804 void hci_release_packet_buffer(void); 805 806 // used for internal checks in l2cap[-le].c 807 int hci_is_packet_buffer_reserved(void); 808 809 // get point to packet buffer 810 uint8_t* hci_get_outgoing_packet_buffer(void); 811 812 813 hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle); 814 hci_connection_t * hci_connection_for_bd_addr_and_type(bd_addr_t addr, bd_addr_type_t addr_type); 815 int hci_is_le_connection(hci_connection_t * connection); 816 uint8_t hci_number_outgoing_packets(hci_con_handle_t handle); 817 uint8_t hci_number_free_acl_slots_for_handle(hci_con_handle_t con_handle); 818 int hci_authentication_active_for_handle(hci_con_handle_t handle); 819 uint16_t hci_max_acl_data_packet_length(void); 820 uint16_t hci_max_acl_le_data_packet_length(void); 821 uint16_t hci_usable_acl_packet_types(void); 822 int hci_non_flushable_packet_boundary_flag_supported(void); 823 824 void hci_disconnect_all(void); 825 826 void hci_emit_state(void); 827 void hci_emit_connection_complete(hci_connection_t *conn, uint8_t status); 828 void hci_emit_l2cap_check_timeout(hci_connection_t *conn); 829 void hci_emit_disconnection_complete(uint16_t handle, uint8_t reason); 830 void hci_emit_nr_connections_changed(void); 831 void hci_emit_hci_open_failed(void); 832 void hci_emit_btstack_version(void); 833 void hci_emit_system_bluetooth_enabled(uint8_t enabled); 834 void hci_emit_remote_name_cached(bd_addr_t addr, device_name_t *name); 835 void hci_emit_discoverable_enabled(uint8_t enabled); 836 void hci_emit_security_level(hci_con_handle_t con_handle, gap_security_level_t level); 837 void hci_emit_dedicated_bonding_result(bd_addr_t address, uint8_t status); 838 839 // query if the local side supports SSP 840 int hci_local_ssp_activated(void); 841 842 // query if the remote side supports SSP 843 int hci_remote_ssp_supported(hci_con_handle_t con_handle); 844 845 // query if both sides support SSP 846 int hci_ssp_supported_on_both_sides(hci_con_handle_t handle); 847 848 // disable automatic L2CAP disconnect for testing 849 void hci_disable_l2cap_timeout_check(void); 850 851 // disconnect because of security block 852 void hci_disconnect_security_block(hci_con_handle_t con_handle); 853 854 // send complete CMD packet 855 int hci_send_cmd_packet(uint8_t *packet, int size); 856 857 // query if remote side supports eSCO 858 int hci_remote_eSCO_supported(hci_con_handle_t con_handle); 859 860 /* API_START */ 861 862 void gap_le_get_connection_parameter_range(le_connection_parameter_range_t range); 863 void gap_le_set_connection_parameter_range(le_connection_parameter_range_t range); 864 865 /* LE Client Start */ 866 867 le_command_status_t le_central_start_scan(void); 868 le_command_status_t le_central_stop_scan(void); 869 le_command_status_t le_central_connect(bd_addr_t addr, bd_addr_type_t addr_type); 870 le_command_status_t le_central_connect_cancel(void); 871 le_command_status_t gap_disconnect(hci_con_handle_t handle); 872 void le_central_set_scan_parameters(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window); 873 874 /* LE Client End */ 875 876 void hci_connectable_control(uint8_t enable); 877 void hci_close(void); 878 879 /** 880 * @note New functions replacing: hci_can_send_packet_now[_using_packet_buffer] 881 */ 882 int hci_can_send_command_packet_now(void); 883 884 /** 885 * @brief Gets local address. 886 */ 887 void hci_local_bd_addr(bd_addr_t address_buffer); 888 889 /** 890 * @brief Set up HCI. Needs to be called before any other function. 891 */ 892 void hci_init(hci_transport_t *transport, void *config, bt_control_t *control, remote_device_db_t const* remote_device_db); 893 894 /** 895 * @brief Set class of device that will be set during Bluetooth init. 896 */ 897 void hci_set_class_of_device(uint32_t class_of_device); 898 899 /** 900 * @brief Set Public BD ADDR - passed on to Bluetooth chipset if supported in bt_control_h 901 */ 902 void hci_set_bd_addr(bd_addr_t addr); 903 904 /** 905 * @brief Registers a packet handler. Used if L2CAP is not used (rarely). 906 */ 907 void hci_register_packet_handler(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size)); 908 909 /** 910 * @brief Registers a packet handler for SCO data. Used for HSP and HFP profiles. 911 */ 912 void hci_register_sco_packet_handler(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size)); 913 914 /** 915 * @brief Requests the change of BTstack power mode. 916 */ 917 int hci_power_control(HCI_POWER_MODE mode); 918 919 /** 920 * @brief Allows to control if device is discoverable. OFF by default. 921 */ 922 void hci_discoverable_control(uint8_t enable); 923 924 /** 925 * @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. 926 */ 927 int hci_send_cmd(const hci_cmd_t *cmd, ...); 928 929 /** 930 * @brief Deletes link key for remote device with baseband address. 931 */ 932 void hci_drop_link_key_for_bd_addr(bd_addr_t addr); 933 934 /* Configure Secure Simple Pairing */ 935 936 /** 937 * @brief Enable will enable SSP during init. 938 */ 939 void hci_ssp_set_enable(int enable); 940 941 /** 942 * @brief If set, BTstack will respond to io capability request using authentication requirement. 943 */ 944 void hci_ssp_set_io_capability(int ssp_io_capability); 945 void hci_ssp_set_authentication_requirement(int authentication_requirement); 946 947 /** 948 * @brief If set, BTstack will confirm a numeric comparison and enter '000000' if requested. 949 */ 950 void hci_ssp_set_auto_accept(int auto_accept); 951 952 /** 953 * @brief Get addr type and address used in advertisement packets. 954 */ 955 void hci_le_advertisement_address(uint8_t * addr_type, bd_addr_t addr); 956 957 /** 958 * @brief Set callback for Bluetooth Hardware Error 959 */ 960 void hci_set_hardware_error_callback(void (*fn)(void)); 961 962 /** 963 * @brief Configure Voice Setting for use with SCO data in HSP/HFP 964 */ 965 void hci_set_sco_voice_setting(uint16_t voice_setting); 966 967 /** 968 * @brief Get SCO Voice Setting 969 * @return current voice setting 970 */ 971 uint16_t hci_get_sco_voice_setting(void); 972 973 /* API_END */ 974 975 /** 976 * @brief Set Advertisement Parameters 977 * @param adv_int_min 978 * @param adv_int_max 979 * @param adv_type 980 * @param own_address_type 981 * @param direct_address_type 982 * @param direct_address 983 * @param channel_map 984 * @param filter_policy 985 * 986 * @note internal use. use gap_advertisements_set_params from gap_le.h instead. 987 */ 988 void hci_le_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 989 uint8_t own_address_type, uint8_t direct_address_typ, bd_addr_t direct_address, 990 uint8_t channel_map, uint8_t filter_policy); 991 992 #if defined __cplusplus 993 } 994 #endif 995 996 #endif // __HCI_H 997