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