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