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 234 // 235 #define IS_COMMAND(packet, command) (READ_BT_16(packet,0) == command.opcode) 236 237 238 /** 239 * LE connection parameter update state 240 */ 241 242 typedef enum { 243 CON_PARAMETER_UPDATE_NONE, 244 CON_PARAMETER_UPDATE_SEND_RESPONSE, 245 CON_PARAMETER_UPDATE_CHANGE_HCI_CON_PARAMETERS, 246 CON_PARAMETER_UPDATE_DENY 247 } le_con_parameter_update_state_t; 248 249 typedef struct le_connection_parameter_range{ 250 uint16_t le_conn_interval_min; 251 uint16_t le_conn_interval_max; 252 uint16_t le_conn_latency_min; 253 uint16_t le_conn_latency_max; 254 uint16_t le_supervision_timeout_min; 255 uint16_t le_supervision_timeout_max; 256 } le_connection_parameter_range_t; 257 258 // Authentication flags 259 typedef enum { 260 AUTH_FLAGS_NONE = 0x0000, 261 RECV_LINK_KEY_REQUEST = 0x0001, 262 HANDLE_LINK_KEY_REQUEST = 0x0002, 263 SENT_LINK_KEY_REPLY = 0x0004, 264 SENT_LINK_KEY_NEGATIVE_REQUEST = 0x0008, 265 RECV_LINK_KEY_NOTIFICATION = 0x0010, 266 DENY_PIN_CODE_REQUEST = 0x0040, 267 RECV_IO_CAPABILITIES_REQUEST = 0x0080, 268 SEND_IO_CAPABILITIES_REPLY = 0x0100, 269 SEND_USER_CONFIRM_REPLY = 0x0200, 270 SEND_USER_PASSKEY_REPLY = 0x0400, 271 272 // pairing status 273 LEGACY_PAIRING_ACTIVE = 0x2000, 274 SSP_PAIRING_ACTIVE = 0x4000, 275 276 // connection status 277 CONNECTION_ENCRYPTED = 0x8000, 278 } hci_authentication_flags_t; 279 280 /** 281 * Connection State 282 */ 283 typedef enum { 284 SEND_CREATE_CONNECTION = 0, 285 SENT_CREATE_CONNECTION, 286 SEND_CANCEL_CONNECTION, 287 SENT_CANCEL_CONNECTION, 288 RECEIVED_CONNECTION_REQUEST, 289 ACCEPTED_CONNECTION_REQUEST, 290 REJECTED_CONNECTION_REQUEST, 291 OPEN, 292 SEND_DISCONNECT, 293 SENT_DISCONNECT, 294 RECEIVED_DISCONNECTION_COMPLETE 295 } CONNECTION_STATE; 296 297 // bonding flags 298 enum { 299 BONDING_REQUEST_REMOTE_FEATURES = 0x01, 300 BONDING_RECEIVED_REMOTE_FEATURES = 0x02, 301 BONDING_REMOTE_SUPPORTS_SSP = 0x04, 302 BONDING_DISCONNECT_SECURITY_BLOCK = 0x08, 303 BONDING_DISCONNECT_DEDICATED_DONE = 0x10, 304 BONDING_SEND_AUTHENTICATE_REQUEST = 0x20, 305 BONDING_SEND_ENCRYPTION_REQUEST = 0x40, 306 BONDING_DEDICATED = 0x80, 307 BONDING_EMIT_COMPLETE_ON_DISCONNECT = 0x100 308 }; 309 310 typedef enum { 311 BLUETOOTH_OFF = 1, 312 BLUETOOTH_ON, 313 BLUETOOTH_ACTIVE 314 } BLUETOOTH_STATE; 315 316 // le central scanning state 317 typedef enum { 318 LE_SCAN_IDLE, 319 LE_START_SCAN, 320 LE_SCANNING, 321 LE_STOP_SCAN, 322 } le_scanning_state_t; 323 324 // 325 // SM internal types and globals 326 // 327 328 typedef enum { 329 330 // general states 331 SM_GENERAL_IDLE, 332 SM_GENERAL_SEND_PAIRING_FAILED, 333 SM_GENERAL_TIMEOUT, // no other security messages are exchanged 334 335 // Phase 1: Pairing Feature Exchange 336 SM_PH1_W4_USER_RESPONSE, 337 338 // Phase 2: Authenticating and Encrypting 339 340 // get random number for use as TK Passkey if we show it 341 SM_PH2_GET_RANDOM_TK, 342 SM_PH2_W4_RANDOM_TK, 343 344 // get local random number for confirm c1 345 SM_PH2_C1_GET_RANDOM_A, 346 SM_PH2_C1_W4_RANDOM_A, 347 SM_PH2_C1_GET_RANDOM_B, 348 SM_PH2_C1_W4_RANDOM_B, 349 350 // calculate confirm value for local side 351 SM_PH2_C1_GET_ENC_A, 352 SM_PH2_C1_W4_ENC_A, 353 SM_PH2_C1_GET_ENC_B, 354 SM_PH2_C1_W4_ENC_B, 355 356 // calculate confirm value for remote side 357 SM_PH2_C1_GET_ENC_C, 358 SM_PH2_C1_W4_ENC_C, 359 SM_PH2_C1_GET_ENC_D, 360 SM_PH2_C1_W4_ENC_D, 361 362 SM_PH2_C1_SEND_PAIRING_CONFIRM, 363 SM_PH2_SEND_PAIRING_RANDOM, 364 365 // calc STK 366 SM_PH2_CALC_STK, 367 SM_PH2_W4_STK, 368 369 SM_PH2_W4_CONNECTION_ENCRYPTED, 370 371 // Phase 3: Transport Specific Key Distribution 372 373 // calculate DHK, Y, EDIV, and LTK 374 SM_PH3_GET_RANDOM, 375 SM_PH3_W4_RANDOM, 376 SM_PH3_GET_DIV, 377 SM_PH3_W4_DIV, 378 SM_PH3_Y_GET_ENC, 379 SM_PH3_Y_W4_ENC, 380 SM_PH3_LTK_GET_ENC, 381 SM_PH3_LTK_W4_ENC, 382 SM_PH3_CSRK_GET_ENC, 383 SM_PH3_CSRK_W4_ENC, 384 385 // exchange keys 386 SM_PH3_DISTRIBUTE_KEYS, 387 SM_PH3_RECEIVE_KEYS, 388 389 // Phase 4: re-establish previously distributed LTK 390 SM_PH4_Y_GET_ENC, 391 SM_PH4_Y_W4_ENC, 392 SM_PH4_LTK_GET_ENC, 393 SM_PH4_LTK_W4_ENC, 394 SM_PH4_SEND_LTK, 395 396 // RESPONDER ROLE 397 SM_RESPONDER_RECEIVED_LTK, 398 SM_RESPONDER_SEND_SECURITY_REQUEST, 399 SM_RESPONDER_SEND_LTK_REQUESTED_NEGATIVE_REPLY, 400 SM_RESPONDER_PH1_W4_PAIRING_REQUEST, 401 SM_RESPONDER_PH1_PAIRING_REQUEST_RECEIVED, 402 SM_RESPONDER_PH1_SEND_PAIRING_RESPONSE, 403 SM_RESPONDER_PH1_W4_PAIRING_CONFIRM, 404 SM_RESPONDER_PH2_W4_PAIRING_RANDOM, 405 SM_RESPONDER_PH2_W4_LTK_REQUEST, 406 SM_RESPONDER_PH2_SEND_LTK_REPLY, 407 408 // INITITIATOR ROLE 409 SM_INITIATOR_CONNECTED, 410 SM_INITIATOR_PH1_W2_SEND_PAIRING_REQUEST, 411 SM_INITIATOR_PH1_SEND_PAIRING_REQUEST, 412 SM_INITIATOR_PH1_W4_PAIRING_RESPONSE, 413 SM_INITIATOR_PH2_W4_PAIRING_CONFIRM, 414 SM_INITIATOR_PH2_W4_PAIRING_RANDOM, 415 SM_INITIATOR_PH3_SEND_START_ENCRYPTION, 416 SM_INITIATOR_PH3_XXXX, 417 418 } security_manager_state_t; 419 420 typedef enum { 421 CSRK_LOOKUP_IDLE, 422 CSRK_LOOKUP_W4_READY, 423 CSRK_LOOKUP_STARTED, 424 } csrk_lookup_state_t; 425 426 // Authorization state 427 typedef enum { 428 AUTHORIZATION_UNKNOWN, 429 AUTHORIZATION_PENDING, 430 AUTHORIZATION_DECLINED, 431 AUTHORIZATION_GRANTED 432 } authorization_state_t; 433 434 typedef struct sm_pairing_packet { 435 uint8_t code; 436 uint8_t io_capability; 437 uint8_t oob_data_flag; 438 uint8_t auth_req; 439 uint8_t max_encryption_key_size; 440 uint8_t initiator_key_distribution; 441 uint8_t responder_key_distribution; 442 } sm_pairing_packet_t; 443 444 // connection info available as long as connection exists 445 typedef struct sm_connection { 446 uint16_t sm_handle; 447 uint8_t sm_role; // 0 - IamMaster, 1 = IamSlave 448 bd_addr_t sm_peer_address; 449 uint8_t sm_peer_addr_type; 450 security_manager_state_t sm_engine_state; 451 csrk_lookup_state_t sm_csrk_lookup_state; 452 uint8_t sm_connection_encrypted; 453 uint8_t sm_connection_authenticated; // [0..1] 454 uint8_t sm_actual_encryption_key_size; 455 sm_pairing_packet_t sm_m_preq; // only used during c1 456 authorization_state_t sm_connection_authorization_state; 457 uint16_t sm_local_ediv; 458 uint8_t sm_local_rand[8]; 459 } sm_connection_t; 460 461 typedef struct { 462 // linked list - assert: first field 463 linked_item_t item; 464 465 // remote side 466 bd_addr_t address; 467 468 // module handle 469 hci_con_handle_t con_handle; 470 471 // le public, le random, classic 472 bd_addr_type_t address_type; 473 474 // connection state 475 CONNECTION_STATE state; 476 477 // bonding 478 uint16_t bonding_flags; 479 uint8_t bonding_status; 480 // requested security level 481 gap_security_level_t requested_security_level; 482 483 // 484 link_key_type_t link_key_type; 485 486 // errands 487 uint32_t authentication_flags; 488 489 timer_source_t timeout; 490 491 #ifdef HAVE_TIME 492 // timer 493 struct timeval timestamp; 494 #endif 495 #ifdef HAVE_TICK 496 uint32_t timestamp; // timeout in system ticks 497 #endif 498 499 // ACL packet recombination - PRE_BUFFER + ACL Header + ACL payload 500 uint8_t acl_recombination_buffer[HCI_INCOMING_PRE_BUFFER_SIZE + 4 + HCI_ACL_BUFFER_SIZE]; 501 uint16_t acl_recombination_pos; 502 uint16_t acl_recombination_length; 503 504 // number packets sent to controller 505 uint8_t num_acl_packets_sent; 506 uint8_t num_sco_packets_sent; 507 508 // LE Connection parameter update 509 le_con_parameter_update_state_t le_con_parameter_update_state; 510 uint16_t le_conn_interval_min; 511 uint16_t le_conn_interval_max; 512 uint16_t le_conn_latency; 513 uint16_t le_supervision_timeout; 514 uint16_t le_update_con_parameter_response; 515 516 #ifdef HAVE_BLE 517 // LE Security Manager 518 sm_connection_t sm_connection; 519 #endif 520 521 } hci_connection_t; 522 523 /** 524 * main data structure 525 */ 526 typedef struct { 527 // transport component with configuration 528 hci_transport_t * hci_transport; 529 void * config; 530 531 // basic configuration 532 const char * local_name; 533 uint32_t class_of_device; 534 bd_addr_t local_bd_addr; 535 uint8_t ssp_enable; 536 uint8_t ssp_io_capability; 537 uint8_t ssp_authentication_requirement; 538 uint8_t ssp_auto_accept; 539 540 // hardware power controller 541 bt_control_t * control; 542 543 // list of existing baseband connections 544 linked_list_t connections; 545 546 // single buffer for HCI packet assembly + additional prebuffer for H4 drivers 547 uint8_t hci_packet_buffer_prefix[HCI_OUTGOING_PRE_BUFFER_SIZE]; 548 uint8_t hci_packet_buffer[HCI_PACKET_BUFFER_SIZE]; // opcode (16), len(8) 549 uint8_t hci_packet_buffer_reserved; 550 uint16_t acl_fragmentation_pos; 551 uint16_t acl_fragmentation_total_size; 552 553 /* host to controller flow control */ 554 uint8_t num_cmd_packets; 555 uint8_t acl_packets_total_num; 556 uint16_t acl_data_packet_length; 557 uint8_t sco_packets_total_num; 558 uint8_t sco_data_packet_length; 559 uint8_t le_acl_packets_total_num; 560 uint16_t le_data_packets_length; 561 562 /* local supported features */ 563 uint8_t local_supported_features[8]; 564 565 // usable packet types given acl_data_packet_length and HCI_ACL_BUFFER_SIZE 566 uint16_t packet_types; 567 568 /* callback to L2CAP layer */ 569 void (*packet_handler)(uint8_t packet_type, uint8_t *packet, uint16_t size); 570 571 /* remote device db */ 572 remote_device_db_t const*remote_device_db; 573 574 /* hci state machine */ 575 HCI_STATE state; 576 uint8_t substate; 577 uint8_t cmds_ready; 578 579 uint16_t last_cmd_opcode; 580 581 uint8_t discoverable; 582 uint8_t connectable; 583 uint8_t bondable; 584 585 /* buffer for scan enable cmd - 0xff no change */ 586 uint8_t new_scan_enable_value; 587 588 // buffer for single connection decline 589 uint8_t decline_reason; 590 bd_addr_t decline_addr; 591 592 uint8_t adv_addr_type; 593 bd_addr_t adv_address; 594 595 le_scanning_state_t le_scanning_state; 596 597 // buffer for le scan type command - 0xff not set 598 uint8_t le_scan_type; 599 uint16_t le_scan_interval; 600 uint16_t le_scan_window; 601 602 le_connection_parameter_range_t le_connection_parameter_range; 603 604 // custom BD ADDR 605 bd_addr_t custom_bd_addr; 606 uint8_t custom_bd_addr_set; 607 608 } hci_stack_t; 609 610 /** 611 * set connection iterator 612 */ 613 void hci_connections_get_iterator(linked_list_iterator_t *it); 614 615 le_connection_parameter_range_t gap_le_get_connection_parameter_range(); 616 void gap_le_set_connection_parameter_range(le_connection_parameter_range_t range); 617 618 // *************** le client start 619 620 le_command_status_t le_central_start_scan(void); 621 le_command_status_t le_central_stop_scan(void); 622 le_command_status_t le_central_connect(bd_addr_t addr, bd_addr_type_t addr_type); 623 le_command_status_t le_central_connect_cancel(void); 624 le_command_status_t gap_disconnect(hci_con_handle_t handle); 625 void le_central_set_scan_parameters(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window); 626 627 // *************** le client end 628 629 // create and send hci command packets based on a template and a list of parameters 630 uint16_t hci_create_cmd(uint8_t *hci_cmd_buffer, hci_cmd_t *cmd, ...); 631 uint16_t hci_create_cmd_internal(uint8_t *hci_cmd_buffer, const hci_cmd_t *cmd, va_list argptr); 632 633 void hci_connectable_control(uint8_t enable); 634 void hci_close(void); 635 636 /** 637 * run the hci control loop once 638 */ 639 void hci_run(void); 640 641 // send complete CMD packet 642 int hci_send_cmd_packet(uint8_t *packet, int size); 643 644 // send ACL packet prepared in hci packet buffer 645 int hci_send_acl_packet_buffer(int size); 646 647 // send SCO packet prepared in hci packet buffer 648 int hci_send_sco_packet_buffer(int size); 649 650 // new functions replacing hci_can_send_packet_now[_using_packet_buffer] 651 int hci_can_send_command_packet_now(void); 652 int hci_can_send_acl_packet_now(hci_con_handle_t con_handle); 653 int hci_can_send_prepared_acl_packet_now(hci_con_handle_t con_handle); 654 int hci_can_send_sco_packet_now(hci_con_handle_t con_handle); 655 int hci_can_send_prepared_sco_packet_now(hci_con_handle_t con_handle); 656 657 // reserves outgoing packet buffer. @returns 1 if successful 658 int hci_reserve_packet_buffer(void); 659 void hci_release_packet_buffer(void); 660 661 // used for internal checks in l2cap[-le].c 662 int hci_is_packet_buffer_reserved(void); 663 664 // get point to packet buffer 665 uint8_t* hci_get_outgoing_packet_buffer(void); 666 667 // returns pointer to a bd_addr_t array 668 uint8_t * hci_local_bd_addr(void); 669 670 hci_connection_t * hci_connection_for_handle(hci_con_handle_t con_handle); 671 hci_connection_t * hci_connection_for_bd_addr_and_type(bd_addr_t addr, bd_addr_type_t addr_type); 672 int hci_is_le_connection(hci_connection_t * connection); 673 uint8_t hci_number_outgoing_packets(hci_con_handle_t handle); 674 uint8_t hci_number_free_acl_slots_for_handle(hci_con_handle_t con_handle); 675 int hci_authentication_active_for_handle(hci_con_handle_t handle); 676 uint16_t hci_max_acl_data_packet_length(void); 677 uint16_t hci_max_acl_le_data_packet_length(void); 678 uint16_t hci_usable_acl_packet_types(void); 679 int hci_non_flushable_packet_boundary_flag_supported(void); 680 681 void hci_disconnect_all(void); 682 683 void hci_emit_state(void); 684 void hci_emit_connection_complete(hci_connection_t *conn, uint8_t status); 685 void hci_emit_l2cap_check_timeout(hci_connection_t *conn); 686 void hci_emit_disconnection_complete(uint16_t handle, uint8_t reason); 687 void hci_emit_nr_connections_changed(void); 688 void hci_emit_hci_open_failed(void); 689 void hci_emit_btstack_version(void); 690 void hci_emit_system_bluetooth_enabled(uint8_t enabled); 691 void hci_emit_remote_name_cached(bd_addr_t addr, device_name_t *name); 692 void hci_emit_discoverable_enabled(uint8_t enabled); 693 void hci_emit_security_level(hci_con_handle_t con_handle, gap_security_level_t level); 694 void hci_emit_dedicated_bonding_result(bd_addr_t address, uint8_t status); 695 696 // query if remote side supports SSP 697 // query if the local side supports SSP 698 int hci_local_ssp_activated(void); 699 700 // query if the remote side supports SSP 701 int hci_remote_ssp_supported(hci_con_handle_t con_handle); 702 703 // query if both sides support SSP 704 int hci_ssp_supported_on_both_sides(hci_con_handle_t handle); 705 706 // disable automatic l2cap disconnect for testing 707 void hci_disable_l2cap_timeout_check(void); 708 709 // disconnect because of security block 710 void hci_disconnect_security_block(hci_con_handle_t con_handle); 711 712 /** Embedded API **/ 713 714 // Set up HCI. Needs to be called before any other function 715 void hci_init(hci_transport_t *transport, void *config, bt_control_t *control, remote_device_db_t const* remote_device_db); 716 717 // Set class of device that will be set during Bluetooth init 718 void hci_set_class_of_device(uint32_t class_of_device); 719 720 // Set Public BD ADDR - passed on to Bluetooth chipset if supported in bt_control_h 721 void hci_set_bd_addr(bd_addr_t addr); 722 723 // Registers a packet handler. Used if L2CAP is not used (rarely). 724 void hci_register_packet_handler(void (*handler)(uint8_t packet_type, uint8_t *packet, uint16_t size)); 725 726 // Requests the change of BTstack power mode. 727 int hci_power_control(HCI_POWER_MODE mode); 728 729 // Allows to control if device is discoverable. OFF by default. 730 void hci_discoverable_control(uint8_t enable); 731 732 // Creates and sends HCI command packets based on a template and 733 // a list of parameters. Will return error if outgoing data buffer 734 // is occupied. 735 int hci_send_cmd(const hci_cmd_t *cmd, ...); 736 737 // Deletes link key for remote device with baseband address. 738 void hci_drop_link_key_for_bd_addr(bd_addr_t addr); 739 740 // Configure Secure Simple Pairing 741 742 // enable will enable SSP during init 743 void hci_ssp_set_enable(int enable); 744 745 // if set, BTstack will respond to io capability request using authentication requirement 746 void hci_ssp_set_io_capability(int ssp_io_capability); 747 void hci_ssp_set_authentication_requirement(int authentication_requirement); 748 749 // if set, BTstack will confirm a numberic comparion and enter '000000' if requested 750 void hci_ssp_set_auto_accept(int auto_accept); 751 752 // get addr type and address used in advertisement packets 753 void hci_le_advertisement_address(uint8_t * addr_type, bd_addr_t addr); 754 755 756 #if defined __cplusplus 757 } 758 #endif 759 760 #endif // __HCI_H 761