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 #ifndef GAP_H 39 #define GAP_H 40 41 #if defined __cplusplus 42 extern "C" { 43 #endif 44 45 #include "btstack_defines.h" 46 #include "btstack_util.h" 47 #include "classic/btstack_link_key_db.h" 48 49 typedef enum { 50 51 // MITM protection not required 52 // No encryption required 53 // No user interaction required 54 LEVEL_0 = 0, 55 56 // MITM protection not required 57 // No encryption required 58 // Minimal user interaction desired 59 LEVEL_1, 60 61 // MITM protection not required 62 // Encryption required 63 LEVEL_2, 64 65 // MITM protection required 66 // Encryption required 67 // User interaction acceptable 68 LEVEL_3, 69 70 // MITM protection required 71 // Encryption required 72 // 128-bit equivalent strength for link and encryption keys required (P-192 is not enough) 73 // User interaction acceptable 74 LEVEL_4, 75 } gap_security_level_t; 76 77 typedef enum { 78 GAP_SECURITY_NONE, 79 GAP_SECUIRTY_ENCRYPTED, // SSP: JUST WORKS 80 GAP_SECURITY_AUTHENTICATED, // SSP: numeric comparison, passkey, OOB 81 // GAP_SECURITY_AUTHORIZED 82 } gap_security_state; 83 84 typedef enum { 85 GAP_CONNECTION_INVALID, 86 GAP_CONNECTION_ACL, 87 GAP_CONNECTION_SCO, 88 GAP_CONNECTION_LE 89 } gap_connection_type_t; 90 91 typedef struct le_connection_parameter_range{ 92 uint16_t le_conn_interval_min; 93 uint16_t le_conn_interval_max; 94 uint16_t le_conn_latency_min; 95 uint16_t le_conn_latency_max; 96 uint16_t le_supervision_timeout_min; 97 uint16_t le_supervision_timeout_max; 98 } le_connection_parameter_range_t; 99 100 typedef enum { 101 GAP_RANDOM_ADDRESS_TYPE_OFF = 0, 102 GAP_RANDOM_ADDRESS_TYPE_STATIC, 103 GAP_RANDOM_ADDRESS_NON_RESOLVABLE, 104 GAP_RANDOM_ADDRESS_RESOLVABLE, 105 } gap_random_address_type_t; 106 107 // Authorization state 108 typedef enum { 109 AUTHORIZATION_UNKNOWN, 110 AUTHORIZATION_PENDING, 111 AUTHORIZATION_DECLINED, 112 AUTHORIZATION_GRANTED 113 } authorization_state_t; 114 115 116 /* API_START */ 117 118 // Classic + LE 119 120 /** 121 * @brief Disconnect connection with handle 122 * @param handle 123 */ 124 uint8_t gap_disconnect(hci_con_handle_t handle); 125 126 /** 127 * @brief Get connection type 128 * @param con_handle 129 * @result connection_type 130 */ 131 gap_connection_type_t gap_get_connection_type(hci_con_handle_t connection_handle); 132 133 // Classic 134 135 /** 136 * @brief Sets local name. 137 * @note has to be done before stack starts up 138 * @note Default name is 'BTstack 00:00:00:00:00:00' 139 * @note '00:00:00:00:00:00' in local_name will be replaced with actual bd addr 140 * @param name is not copied, make sure memory is accessible during stack startup 141 */ 142 void gap_set_local_name(const char * local_name); 143 144 /** 145 * @brief Set Extended Inquiry Response data 146 * @note has to be done before stack starts up 147 * @note If not set, local name will be used for EIR data (see gap_set_local_name) 148 * @note '00:00:00:00:00:00' in local_name will be replaced with actual bd addr 149 * @param eir_data size 240 bytes, is not copied make sure memory is accessible during stack startup 150 */ 151 void gap_set_extended_inquiry_response(const uint8_t * data); 152 153 /** 154 * @brief Set class of device that will be set during Bluetooth init. 155 * @note has to be done before stack starts up 156 */ 157 void gap_set_class_of_device(uint32_t class_of_device); 158 159 /** 160 * @brief Set default link policy settings for all classic ACL links 161 * @param default_link_policy_settings - see LM_LINK_POLICY_* in bluetooth.h 162 * @note common value: LM_LINK_POLICY_ENABLE_ROLE_SWITCH | LM_LINK_POLICY_ENABLE_SNIFF_MODE to enable role switch and sniff mode 163 * @note has to be done before stack starts up 164 */ 165 void gap_set_default_link_policy_settings(uint16_t default_link_policy_settings); 166 167 /** 168 * @brief Set Allow Role Switch param for outgoing classic ACL links 169 * @param allow_role_switch - true: allow remote device to request role switch, false: stay master 170 */ 171 void gap_set_allow_role_switch(bool allow_role_switch); 172 173 /** 174 * @brief Set link supervision timeout for outgoing classic ACL links 175 * @param default_link_supervision_timeout * 0.625 ms, default 0x7d00 = 20 seconds 176 */ 177 void gap_set_link_supervision_timeout(uint16_t link_supervision_timeout); 178 179 /** 180 * @brief Enable/disable bonding. Default is enabled. 181 * @param enabled 182 */ 183 void gap_set_bondable_mode(int enabled); 184 185 /** 186 * @brief Get bondable mode. 187 * @return 1 if bondable 188 */ 189 int gap_get_bondable_mode(void); 190 191 /** 192 * @brief Register filter for rejecting classic connections. Callback will return 1 accept connection, 0 on reject. 193 */ 194 195 void gap_register_classic_connection_filter(int (*accept_callback)(bd_addr_t addr)); 196 197 198 /* Configure Secure Simple Pairing */ 199 200 /** 201 * @brief Enable will enable SSP during init. 202 */ 203 void gap_ssp_set_enable(int enable); 204 205 /** 206 * @brief Set IO Capability. BTstack will return capability to SSP requests 207 */ 208 void gap_ssp_set_io_capability(int ssp_io_capability); 209 210 /** 211 * @brief Set Authentication Requirements using during SSP 212 */ 213 void gap_ssp_set_authentication_requirement(int authentication_requirement); 214 215 /** 216 * @brief If set, BTstack will confirm a numeric comparison and enter '000000' if requested. 217 */ 218 void gap_ssp_set_auto_accept(int auto_accept); 219 220 /** 221 * @brief Set required encryption key size for GAP Levels 1-3 on ccassic connections. Default: 16 bytes 222 * @param encryption_key_size in bytes. Valid 7..16 223 */ 224 void gap_set_required_encryption_key_size(uint8_t encryption_key_size); 225 226 /** 227 * @brief Start dedicated bonding with device. Disconnect after bonding. 228 * @param device 229 * @param request MITM protection 230 * @return error, if max num acl connections active 231 * @result GAP_DEDICATED_BONDING_COMPLETE 232 */ 233 int gap_dedicated_bonding(bd_addr_t device, int mitm_protection_required); 234 235 gap_security_level_t gap_security_level_for_link_key_type(link_key_type_t link_key_type); 236 237 /** 238 * @brief map link keys to secure connection yes/no 239 */ 240 int gap_secure_connection_for_link_key_type(link_key_type_t link_key_type); 241 242 /** 243 * @brief map link keys to authenticated 244 */ 245 int gap_authenticated_for_link_key_type(link_key_type_t link_key_type); 246 247 gap_security_level_t gap_security_level(hci_con_handle_t con_handle); 248 249 void gap_request_security_level(hci_con_handle_t con_handle, gap_security_level_t level); 250 251 int gap_mitm_protection_required_for_security_level(gap_security_level_t level); 252 253 // LE 254 255 /** 256 * @brief Set parameters for LE Scan 257 */ 258 void gap_set_scan_parameters(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window); 259 260 /** 261 * @brief Start LE Scan 262 */ 263 void gap_start_scan(void); 264 265 /** 266 * @brief Stop LE Scan 267 */ 268 void gap_stop_scan(void); 269 270 /** 271 * @brief Enable privacy by using random addresses 272 * @param random_address_type to use (incl. OFF) 273 */ 274 void gap_random_address_set_mode(gap_random_address_type_t random_address_type); 275 276 /** 277 * @brief Get privacy mode 278 */ 279 gap_random_address_type_t gap_random_address_get_mode(void); 280 281 /** 282 * @brief Sets update period for random address 283 * @param period_ms in ms 284 */ 285 void gap_random_address_set_update_period(int period_ms); 286 287 /** 288 * @brief Sets a fixed random address for advertising 289 * @param addr 290 * @note Sets random address mode to type off 291 */ 292 void gap_random_address_set(bd_addr_t addr); 293 294 /** 295 * @brief Set Advertisement Data 296 * @param advertising_data_length 297 * @param advertising_data (max 31 octets) 298 * @note data is not copied, pointer has to stay valid 299 * @note '00:00:00:00:00:00' in advertising_data will be replaced with actual bd addr 300 */ 301 void gap_advertisements_set_data(uint8_t advertising_data_length, uint8_t * advertising_data); 302 303 /** 304 * @brief Set Advertisement Paramters 305 * @param adv_int_min 306 * @param adv_int_max 307 * @param adv_type 308 * @param direct_address_type 309 * @param direct_address 310 * @param channel_map 311 * @param filter_policy 312 * @note own_address_type is used from gap_random_address_set_mode 313 */ 314 void gap_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 315 uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy); 316 317 /** 318 * @brief Enable/Disable Advertisements. OFF by default. 319 * @param enabled 320 */ 321 void gap_advertisements_enable(int enabled); 322 323 /** 324 * @brief Set Scan Response Data 325 * 326 * @note For scan response data, scannable undirected advertising (ADV_SCAN_IND) need to be used 327 * 328 * @param advertising_data_length 329 * @param advertising_data (max 31 octets) 330 * @note data is not copied, pointer has to stay valid 331 * @note '00:00:00:00:00:00' in scan_response_data will be replaced with actual bd addr 332 */ 333 void gap_scan_response_set_data(uint8_t scan_response_data_length, uint8_t * scan_response_data); 334 335 /** 336 * @brief Set connection parameters for outgoing connections 337 * @param conn_scan_interval (unit: 0.625 msec), default: 60 ms 338 * @param conn_scan_window (unit: 0.625 msec), default: 30 ms 339 * @param conn_interval_min (unit: 1.25ms), default: 10 ms 340 * @param conn_interval_max (unit: 1.25ms), default: 30 ms 341 * @param conn_latency, default: 4 342 * @param supervision_timeout (unit: 10ms), default: 720 ms 343 * @param min_ce_length (unit: 0.625ms), default: 10 ms 344 * @param max_ce_length (unit: 0.625ms), default: 30 ms 345 */ 346 void gap_set_connection_parameters(uint16_t conn_scan_interval, uint16_t conn_scan_window, 347 uint16_t conn_interval_min, uint16_t conn_interval_max, uint16_t conn_latency, 348 uint16_t supervision_timeout, uint16_t min_ce_length, uint16_t max_ce_length); 349 350 /** 351 * @brief Request an update of the connection parameter for a given LE connection 352 * @param handle 353 * @param conn_interval_min (unit: 1.25ms) 354 * @param conn_interval_max (unit: 1.25ms) 355 * @param conn_latency 356 * @param supervision_timeout (unit: 10ms) 357 * @returns 0 if ok 358 */ 359 int gap_request_connection_parameter_update(hci_con_handle_t con_handle, uint16_t conn_interval_min, 360 uint16_t conn_interval_max, uint16_t conn_latency, uint16_t supervision_timeout); 361 362 /** 363 * @brief Updates the connection parameters for a given LE connection 364 * @param handle 365 * @param conn_interval_min (unit: 1.25ms) 366 * @param conn_interval_max (unit: 1.25ms) 367 * @param conn_latency 368 * @param supervision_timeout (unit: 10ms) 369 * @returns 0 if ok 370 */ 371 int gap_update_connection_parameters(hci_con_handle_t con_handle, uint16_t conn_interval_min, 372 uint16_t conn_interval_max, uint16_t conn_latency, uint16_t supervision_timeout); 373 374 /** 375 * @brief Set accepted connection parameter range 376 * @param range 377 */ 378 void gap_get_connection_parameter_range(le_connection_parameter_range_t * range); 379 380 /** 381 * @brief Get accepted connection parameter range 382 * @param range 383 */ 384 void gap_set_connection_parameter_range(le_connection_parameter_range_t * range); 385 386 /** 387 * @brief Test if connection parameters are inside in existing rage 388 * @param conn_interval_min (unit: 1.25ms) 389 * @param conn_interval_max (unit: 1.25ms) 390 * @param conn_latency 391 * @param supervision_timeout (unit: 10ms) 392 * @returns 1 if included 393 */ 394 int gap_connection_parameter_range_included(le_connection_parameter_range_t * existing_range, uint16_t le_conn_interval_min, uint16_t le_conn_interval_max, uint16_t le_conn_latency, uint16_t le_supervision_timeout); 395 396 /** 397 * @brief Set max number of connections in LE Peripheral role (if Bluetooth Controller supports it) 398 * @note: default: 1 399 * @param max_peripheral_connections 400 */ 401 void gap_set_max_number_peripheral_connections(int max_peripheral_connections); 402 403 /** 404 * @brief Connect to remote LE device 405 */ 406 uint8_t gap_connect(bd_addr_t addr, bd_addr_type_t addr_type); 407 408 /** 409 * @brief Cancel connection process initiated by gap_connect 410 */ 411 uint8_t gap_connect_cancel(void); 412 413 /** 414 * @brief Auto Connection Establishment - Start Connecting to device 415 * @param address_typ 416 * @param address 417 * @returns 0 if ok 418 */ 419 int gap_auto_connection_start(bd_addr_type_t address_typ, bd_addr_t address); 420 421 /** 422 * @brief Auto Connection Establishment - Stop Connecting to device 423 * @param address_typ 424 * @param address 425 * @returns 0 if ok 426 */ 427 int gap_auto_connection_stop(bd_addr_type_t address_typ, bd_addr_t address); 428 429 /** 430 * @brief Auto Connection Establishment - Stop everything 431 * @note Convenience function to stop all active auto connection attempts 432 */ 433 void gap_auto_connection_stop_all(void); 434 435 /** 436 * @brief Set LE PHY 437 * @param con_handle 438 * @param all_phys 0 = set rx/tx, 1 = set only rx, 2 = set only tx 439 * @param tx_phys 1 = 1M, 2 = 2M, 4 = Coded 440 * @param rx_phys 1 = 1M, 2 = 2M, 4 = Coded 441 * @param phy_options 0 = no preferred coding for Coded, 1 = S=2 coding (500 kbit), 2 = S=8 coding (125 kbit) 442 * @returns 0 if ok 443 */ 444 uint8_t gap_le_set_phy(hci_con_handle_t con_handle, uint8_t all_phys, uint8_t tx_phys, uint8_t rx_phys, uint8_t phy_options); 445 446 /** 447 * @brief Get connection interval 448 * @return connection interval, otherwise 0 if error 449 */ 450 uint16_t gap_le_connection_interval(hci_con_handle_t connection_handle); 451 452 /** 453 * 454 * @brief Get encryption key size. 455 * @param con_handle 456 * @return 0 if not encrypted, 7-16 otherwise 457 */ 458 int gap_encryption_key_size(hci_con_handle_t con_handle); 459 460 /** 461 * @brief Get authentication property. 462 * @param con_handle 463 * @return 1 if bonded with OOB/Passkey (AND MITM protection) 464 */ 465 int gap_authenticated(hci_con_handle_t con_handle); 466 467 /** 468 * @brief Get secure connection property 469 * @param con_handle 470 * @return 1 if bonded usiung LE Secure Connections 471 */ 472 int gap_secure_connection(hci_con_handle_t con_handle); 473 474 /** 475 * @brief Queries authorization state. 476 * @param con_handle 477 * @return authorization_state for the current session 478 */ 479 authorization_state_t gap_authorization_state(hci_con_handle_t con_handle); 480 481 // Classic 482 483 /** 484 * @brief Override page scan mode. Page scan mode enabled by l2cap when services are registered 485 * @note Might be used to reduce power consumption while Bluetooth module stays powered but no (new) 486 * connections are expected 487 */ 488 void gap_connectable_control(uint8_t enable); 489 490 /** 491 * @brief Allows to control if device is discoverable. OFF by default. 492 */ 493 void gap_discoverable_control(uint8_t enable); 494 495 /** 496 * @brief Gets local address. 497 */ 498 void gap_local_bd_addr(bd_addr_t address_buffer); 499 500 /** 501 * @brief Deletes link key for remote device with baseband address. 502 * @param addr 503 */ 504 void gap_drop_link_key_for_bd_addr(bd_addr_t addr); 505 506 /** 507 * @brief Delete all stored link keys 508 */ 509 void gap_delete_all_link_keys(void); 510 511 /** 512 * @brief Store link key for remote device with baseband address 513 * @param addr 514 * @param link_key 515 * @param link_key_type 516 */ 517 void gap_store_link_key_for_bd_addr(bd_addr_t addr, link_key_t link_key, link_key_type_t type); 518 519 /** 520 * @brief Setup Link Key iterator 521 * @param it 522 * @returns 1 on success 523 */ 524 int gap_link_key_iterator_init(btstack_link_key_iterator_t * it); 525 526 /** 527 * @brief Get next Link Key 528 * @param it 529 * @brief addr 530 * @brief link_key 531 * @brief type of link key 532 * @returns 1, if valid link key found 533 */ 534 int gap_link_key_iterator_get_next(btstack_link_key_iterator_t * it, bd_addr_t bd_addr, link_key_t link_key, link_key_type_t * type); 535 536 /** 537 * @brief Frees resources allocated by iterator_init 538 * @note Must be called after iteration to free resources 539 * @param it 540 */ 541 void gap_link_key_iterator_done(btstack_link_key_iterator_t * it); 542 543 /** 544 * @brief Start GAP Classic Inquiry 545 * @param duration in 1.28s units 546 * @return 0 if ok 547 * @events: GAP_EVENT_INQUIRY_RESULT, GAP_EVENT_INQUIRY_COMPLETE 548 */ 549 int gap_inquiry_start(uint8_t duration_in_1280ms_units); 550 551 /** 552 * @brief Stop GAP Classic Inquiry 553 * @brief Stop GAP Classic Inquiry 554 * @returns 0 if ok 555 * @events: GAP_EVENT_INQUIRY_COMPLETE 556 */ 557 int gap_inquiry_stop(void); 558 559 /** 560 * @brief Remote Name Request 561 * @param addr 562 * @param page_scan_repetition_mode 563 * @param clock_offset only used when bit 15 is set - pass 0 if not known 564 * @events: HCI_EVENT_REMOTE_NAME_REQUEST_COMPLETE 565 */ 566 int gap_remote_name_request(bd_addr_t addr, uint8_t page_scan_repetition_mode, uint16_t clock_offset); 567 568 /** 569 * @brief Read RSSI 570 * @param con_handle 571 * @events: GAP_EVENT_RSSI_MEASUREMENT 572 */ 573 int gap_read_rssi(hci_con_handle_t con_handle); 574 575 /** 576 * @brief Legacy Pairing Pin Code Response 577 * @param addr 578 * @param pin 579 * @return 0 if ok 580 */ 581 int gap_pin_code_response(bd_addr_t addr, const char * pin); 582 583 /** 584 * @brief Abort Legacy Pairing 585 * @param addr 586 * @param pin 587 * @return 0 if ok 588 */ 589 int gap_pin_code_negative(bd_addr_t addr); 590 591 /** 592 * @brief SSP Passkey Response 593 * @param addr 594 * @param passkey [0..999999] 595 * @return 0 if ok 596 */ 597 int gap_ssp_passkey_response(bd_addr_t addr, uint32_t passkey); 598 599 /** 600 * @brief Abort SSP Passkey Entry/Pairing 601 * @param addr 602 * @param pin 603 * @return 0 if ok 604 */ 605 int gap_ssp_passkey_negative(bd_addr_t addr); 606 607 /** 608 * @brief Accept SSP Numeric Comparison 609 * @param addr 610 * @param passkey 611 * @return 0 if ok 612 */ 613 int gap_ssp_confirmation_response(bd_addr_t addr); 614 615 /** 616 * @brief Abort SSP Numeric Comparison/Pairing 617 * @param addr 618 * @param pin 619 * @return 0 if ok 620 */ 621 int gap_ssp_confirmation_negative(bd_addr_t addr); 622 623 /** 624 * @brief Enter Sniff mode 625 * @param con_handle 626 * @param sniff_min_interval range: 0x0002 to 0xFFFE; only even values are valid, Time = N * 0.625 ms 627 * @param sniff_max_interval range: 0x0002 to 0xFFFE; only even values are valid, Time = N * 0.625 ms 628 * @param sniff_attempt Number of Baseband receive slots for sniff attempt. 629 * @param sniff_timeout Number of Baseband receive slots for sniff timeout. 630 @ @return 0 if ok 631 */ 632 uint8_t gap_sniff_mode_enter(hci_con_handle_t con_handle, uint16_t sniff_min_interval, uint16_t sniff_max_interval, uint16_t sniff_attempt, uint16_t sniff_timeout); 633 634 /** 635 * @brief Exit Sniff mode 636 * @param con_handle 637 @ @return 0 if ok 638 */ 639 uint8_t gap_sniff_mode_exit(hci_con_handle_t con_handle); 640 641 // LE 642 643 /** 644 * @brief Get own addr type and address used for LE 645 */ 646 void gap_le_get_own_address(uint8_t * addr_type, bd_addr_t addr); 647 648 649 /** 650 * @brief Get state of connection re-encryptiong for bonded devices when in central role 651 * @note used by gatt_client and att_server to wait for re-encryption 652 * @param con_handle 653 * @return 1 if security setup is active 654 */ 655 int gap_reconnect_security_setup_active(hci_con_handle_t con_handle); 656 657 658 /* API_END*/ 659 660 #if defined __cplusplus 661 } 662 #endif 663 664 #endif // GAP_H 665