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