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 /** 134 * @brief Get HCI connection role 135 * @param con_handle 136 * @result hci_role_t HCI_ROLE_MASTER / HCI_ROLE_SLAVE / HCI_ROLE_INVALID (if connection does not exist) 137 */ 138 hci_role_t gap_get_role(hci_con_handle_t connection_handle); 139 140 // Classic 141 142 /** 143 * @brief Request role switch 144 * @note this only requests the role switch. A HCI_EVENT_ROLE_CHANGE is emitted and its status field will indicate if the switch was succesful 145 * @param addr 146 * @param hci_role_t HCI_ROLE_MASTER / HCI_ROLE_SLAVE 147 * @result status 148 */ 149 uint8_t gap_request_role(const bd_addr_t addr, hci_role_t role); 150 151 /** 152 * @brief Sets local name. 153 * @note has to be done before stack starts up 154 * @note Default name is 'BTstack 00:00:00:00:00:00' 155 * @note '00:00:00:00:00:00' in local_name will be replaced with actual bd addr 156 * @param name is not copied, make sure memory is accessible during stack startup 157 */ 158 void gap_set_local_name(const char * local_name); 159 160 /** 161 * @brief Set Extended Inquiry Response data 162 * @note has to be done before stack starts up 163 * @note If not set, local name will be used for EIR data (see gap_set_local_name) 164 * @note '00:00:00:00:00:00' in local_name will be replaced with actual bd addr 165 * @param eir_data size HCI_EXTENDED_INQUIRY_RESPONSE_DATA_LEN (240) bytes, is not copied make sure memory is accessible during stack startup 166 */ 167 void gap_set_extended_inquiry_response(const uint8_t * data); 168 169 /** 170 * @brief Set class of device that will be set during Bluetooth init. 171 * @note has to be done before stack starts up 172 */ 173 void gap_set_class_of_device(uint32_t class_of_device); 174 175 /** 176 * @brief Set default link policy settings for all classic ACL links 177 * @param default_link_policy_settings - see LM_LINK_POLICY_* in bluetooth.h 178 * @note common value: LM_LINK_POLICY_ENABLE_ROLE_SWITCH | LM_LINK_POLICY_ENABLE_SNIFF_MODE to enable role switch and sniff mode 179 * @note has to be done before stack starts up 180 */ 181 void gap_set_default_link_policy_settings(uint16_t default_link_policy_settings); 182 183 /** 184 * @brief Set Allow Role Switch param for outgoing classic ACL links 185 * @param allow_role_switch - true: allow remote device to request role switch, false: stay master 186 */ 187 void gap_set_allow_role_switch(bool allow_role_switch); 188 189 /** 190 * @brief Set link supervision timeout for outgoing classic ACL links 191 * @param default_link_supervision_timeout * 0.625 ms, default 0x7d00 = 20 seconds 192 */ 193 void gap_set_link_supervision_timeout(uint16_t link_supervision_timeout); 194 195 /** 196 * @brief Enable/disable bonding. Default is enabled. 197 * @param enabled 198 */ 199 void gap_set_bondable_mode(int enabled); 200 201 /** 202 * @brief Get bondable mode. 203 * @return 1 if bondable 204 */ 205 int gap_get_bondable_mode(void); 206 207 /** 208 * @brief Set security level for all outgoing and incoming connections. Default: LEVEL_2 209 * @param security_level 210 * @note has to be called before services or profiles are initialized 211 */ 212 void gap_set_security_level(gap_security_level_t security_level); 213 214 /** 215 * @brief Get security level 216 * @return security_level 217 */ 218 gap_security_level_t gap_get_security_level(void); 219 220 /** 221 * @brief Register filter for rejecting classic connections. Callback will return 1 accept connection, 0 on reject. 222 */ 223 void gap_register_classic_connection_filter(int (*accept_callback)(bd_addr_t addr)); 224 225 /* Configure Secure Simple Pairing */ 226 227 /** 228 * @brief Enable will enable SSP during init. Default: true 229 */ 230 void gap_ssp_set_enable(int enable); 231 232 /** 233 * @brief Set IO Capability. BTstack will return capability to SSP requests 234 */ 235 void gap_ssp_set_io_capability(int ssp_io_capability); 236 237 /** 238 * @brief Set Authentication Requirements using during SSP 239 */ 240 void gap_ssp_set_authentication_requirement(int authentication_requirement); 241 242 /** 243 * @brief Enable/disable Secure Connections. Default: true if supported by Controller 244 */ 245 void gap_secure_connections_enable(bool enable); 246 247 /** 248 * @brief If set, BTstack will confirm a numeric comparison and enter '000000' if requested. 249 */ 250 void gap_ssp_set_auto_accept(int auto_accept); 251 252 /** 253 * @brief Set required encryption key size for GAP Levels 1-3 on ccassic connections. Default: 16 bytes 254 * @param encryption_key_size in bytes. Valid 7..16 255 */ 256 void gap_set_required_encryption_key_size(uint8_t encryption_key_size); 257 258 /** 259 * @brief Start dedicated bonding with device. Disconnect after bonding. 260 * @param device 261 * @param request MITM protection 262 * @return error, if max num acl connections active 263 * @result GAP_DEDICATED_BONDING_COMPLETE 264 */ 265 int gap_dedicated_bonding(bd_addr_t device, int mitm_protection_required); 266 267 gap_security_level_t gap_security_level_for_link_key_type(link_key_type_t link_key_type); 268 269 /** 270 * @brief map link keys to secure connection yes/no 271 */ 272 int gap_secure_connection_for_link_key_type(link_key_type_t link_key_type); 273 274 /** 275 * @brief map link keys to authenticated 276 */ 277 int gap_authenticated_for_link_key_type(link_key_type_t link_key_type); 278 279 gap_security_level_t gap_security_level(hci_con_handle_t con_handle); 280 281 void gap_request_security_level(hci_con_handle_t con_handle, gap_security_level_t level); 282 283 int gap_mitm_protection_required_for_security_level(gap_security_level_t level); 284 285 // LE 286 287 /** 288 * @brief Set parameters for LE Scan 289 * @param scan_type 0 = passive, 1 = active 290 * @param scan_interval range 0x0004..0x4000, unit 0.625 ms 291 * @param scan_window range 0x0004..0x4000, unit 0.625 ms 292 * @param scanning_filter_policy 0 = all devices, 1 = all from whitelist 293 */ 294 void gap_set_scan_params(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window, uint8_t scanning_filter_policy); 295 296 /** 297 * @brief Set parameters for LE Scan 298 * @deprecated Use gap_set_scan_params instead 299 */ 300 void gap_set_scan_parameters(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window); 301 302 /** 303 * @brief Start LE Scan 304 */ 305 void gap_start_scan(void); 306 307 /** 308 * @brief Stop LE Scan 309 */ 310 void gap_stop_scan(void); 311 312 /** 313 * @brief Enable privacy by using random addresses 314 * @param random_address_type to use (incl. OFF) 315 */ 316 void gap_random_address_set_mode(gap_random_address_type_t random_address_type); 317 318 /** 319 * @brief Get privacy mode 320 */ 321 gap_random_address_type_t gap_random_address_get_mode(void); 322 323 /** 324 * @brief Sets update period for random address 325 * @param period_ms in ms 326 */ 327 void gap_random_address_set_update_period(int period_ms); 328 329 /** 330 * @brief Sets a fixed random address for advertising 331 * @param addr 332 * @note Sets random address mode to type off 333 */ 334 void gap_random_address_set(const bd_addr_t addr); 335 336 /** 337 * @brief Set Advertisement Data 338 * @param advertising_data_length 339 * @param advertising_data (max 31 octets) 340 * @note data is not copied, pointer has to stay valid 341 * @note '00:00:00:00:00:00' in advertising_data will be replaced with actual bd addr 342 */ 343 void gap_advertisements_set_data(uint8_t advertising_data_length, uint8_t * advertising_data); 344 345 /** 346 * @brief Set Advertisement Paramters 347 * @param adv_int_min 348 * @param adv_int_max 349 * @param adv_type 350 * @param direct_address_type 351 * @param direct_address 352 * @param channel_map 353 * @param filter_policy 354 * @note own_address_type is used from gap_random_address_set_mode 355 */ 356 void gap_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 357 uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy); 358 359 /** 360 * @brief Enable/Disable Advertisements. OFF by default. 361 * @param enabled 362 */ 363 void gap_advertisements_enable(int enabled); 364 365 /** 366 * @brief Set Scan Response Data 367 * 368 * @note For scan response data, scannable undirected advertising (ADV_SCAN_IND) need to be used 369 * 370 * @param advertising_data_length 371 * @param advertising_data (max 31 octets) 372 * @note data is not copied, pointer has to stay valid 373 * @note '00:00:00:00:00:00' in scan_response_data will be replaced with actual bd addr 374 */ 375 void gap_scan_response_set_data(uint8_t scan_response_data_length, uint8_t * scan_response_data); 376 377 /** 378 * @brief Set connection parameters for outgoing connections 379 * @param conn_scan_interval (unit: 0.625 msec), default: 60 ms 380 * @param conn_scan_window (unit: 0.625 msec), default: 30 ms 381 * @param conn_interval_min (unit: 1.25ms), default: 10 ms 382 * @param conn_interval_max (unit: 1.25ms), default: 30 ms 383 * @param conn_latency, default: 4 384 * @param supervision_timeout (unit: 10ms), default: 720 ms 385 * @param min_ce_length (unit: 0.625ms), default: 10 ms 386 * @param max_ce_length (unit: 0.625ms), default: 30 ms 387 */ 388 void gap_set_connection_parameters(uint16_t conn_scan_interval, uint16_t conn_scan_window, 389 uint16_t conn_interval_min, uint16_t conn_interval_max, uint16_t conn_latency, 390 uint16_t supervision_timeout, uint16_t min_ce_length, uint16_t max_ce_length); 391 392 /** 393 * @brief Request an update of the connection parameter for a given LE connection 394 * @param handle 395 * @param conn_interval_min (unit: 1.25ms) 396 * @param conn_interval_max (unit: 1.25ms) 397 * @param conn_latency 398 * @param supervision_timeout (unit: 10ms) 399 * @returns 0 if ok 400 */ 401 int gap_request_connection_parameter_update(hci_con_handle_t con_handle, uint16_t conn_interval_min, 402 uint16_t conn_interval_max, uint16_t conn_latency, uint16_t supervision_timeout); 403 404 /** 405 * @brief Updates the connection parameters for a given LE connection 406 * @param handle 407 * @param conn_interval_min (unit: 1.25ms) 408 * @param conn_interval_max (unit: 1.25ms) 409 * @param conn_latency 410 * @param supervision_timeout (unit: 10ms) 411 * @returns 0 if ok 412 */ 413 int gap_update_connection_parameters(hci_con_handle_t con_handle, uint16_t conn_interval_min, 414 uint16_t conn_interval_max, uint16_t conn_latency, uint16_t supervision_timeout); 415 416 /** 417 * @brief Set accepted connection parameter range 418 * @param range 419 */ 420 void gap_get_connection_parameter_range(le_connection_parameter_range_t * range); 421 422 /** 423 * @brief Get accepted connection parameter range 424 * @param range 425 */ 426 void gap_set_connection_parameter_range(le_connection_parameter_range_t * range); 427 428 /** 429 * @brief Test if connection parameters are inside in existing rage 430 * @param conn_interval_min (unit: 1.25ms) 431 * @param conn_interval_max (unit: 1.25ms) 432 * @param conn_latency 433 * @param supervision_timeout (unit: 10ms) 434 * @returns 1 if included 435 */ 436 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); 437 438 /** 439 * @brief Set max number of connections in LE Peripheral role (if Bluetooth Controller supports it) 440 * @note: default: 1 441 * @param max_peripheral_connections 442 */ 443 void gap_set_max_number_peripheral_connections(int max_peripheral_connections); 444 445 /** 446 * @brief Add Device to Whitelist 447 * @param address_typ 448 * @param address 449 * @returns 0 if ok 450 */ 451 uint8_t gap_whitelist_add(bd_addr_type_t address_type, const bd_addr_t address); 452 453 /** 454 * @brief Remove Device from Whitelist 455 * @param address_typ 456 * @param address 457 * @returns 0 if ok 458 */ 459 uint8_t gap_whitelist_remove(bd_addr_type_t address_type, const bd_addr_t address); 460 461 /** 462 * @brief Clear Whitelist 463 * @returns 0 if ok 464 */ 465 uint8_t gap_whitelist_clear(void); 466 467 /** 468 * @brief Connect to remote LE device 469 */ 470 uint8_t gap_connect(const bd_addr_t addr, bd_addr_type_t addr_type); 471 472 /** 473 * @brief Connect with Whitelist 474 * @note Explicit whitelist management and this connect with whitelist replace deprecated gap_auto_connection_* functions 475 * @returns - if ok 476 */ 477 uint8_t gap_connect_with_whitelist(void); 478 479 /** 480 * @brief Cancel connection process initiated by gap_connect 481 */ 482 uint8_t gap_connect_cancel(void); 483 484 /** 485 * @brief Auto Connection Establishment - Start Connecting to device 486 * @deprecated Please setup Whitelist with gap_whitelist_* and start connecting with gap_connect_with_whitelist 487 * @param address_typ 488 * @param address 489 * @returns 0 if ok 490 */ 491 uint8_t gap_auto_connection_start(bd_addr_type_t address_typ, const bd_addr_t address); 492 493 /** 494 * @brief Auto Connection Establishment - Stop Connecting to device 495 * @deprecated Please setup Whitelist with gap_whitelist_* and start connecting with gap_connect_with_whitelist 496 * @param address_typ 497 * @param address 498 * @returns 0 if ok 499 */ 500 uint8_t gap_auto_connection_stop(bd_addr_type_t address_typ, const bd_addr_t address); 501 502 /** 503 * @brief Auto Connection Establishment - Stop everything 504 * @deprecated Please setup Whitelist with gap_whitelist_* and start connecting with gap_connect_with_whitelist 505 * @note Convenience function to stop all active auto connection attempts 506 */ 507 uint8_t gap_auto_connection_stop_all(void); 508 509 /** 510 * @brief Set LE PHY 511 * @param con_handle 512 * @param all_phys 0 = set rx/tx, 1 = set only rx, 2 = set only tx 513 * @param tx_phys 1 = 1M, 2 = 2M, 4 = Coded 514 * @param rx_phys 1 = 1M, 2 = 2M, 4 = Coded 515 * @param phy_options 0 = no preferred coding for Coded, 1 = S=2 coding (500 kbit), 2 = S=8 coding (125 kbit) 516 * @returns 0 if ok 517 */ 518 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); 519 520 /** 521 * @brief Get connection interval 522 * @return connection interval, otherwise 0 if error 523 */ 524 uint16_t gap_le_connection_interval(hci_con_handle_t connection_handle); 525 526 /** 527 * 528 * @brief Get encryption key size. 529 * @param con_handle 530 * @return 0 if not encrypted, 7-16 otherwise 531 */ 532 int gap_encryption_key_size(hci_con_handle_t con_handle); 533 534 /** 535 * @brief Get authentication property. 536 * @param con_handle 537 * @return 1 if bonded with OOB/Passkey (AND MITM protection) 538 */ 539 int gap_authenticated(hci_con_handle_t con_handle); 540 541 /** 542 * @brief Get secure connection property 543 * @param con_handle 544 * @return 1 if bonded usiung LE Secure Connections 545 */ 546 int gap_secure_connection(hci_con_handle_t con_handle); 547 548 /** 549 * @brief Queries authorization state. 550 * @param con_handle 551 * @return authorization_state for the current session 552 */ 553 authorization_state_t gap_authorization_state(hci_con_handle_t con_handle); 554 555 /** 556 * @brief Get bonded property (BR/EDR/LE) 557 * @note LE: has to be called after identity resolving is complete 558 * @param con_handle 559 * @return true if bonded 560 */ 561 bool gap_bonded(hci_con_handle_t con_handle); 562 563 // Classic 564 565 /** 566 * @brief Override page scan mode. Page scan mode enabled by l2cap when services are registered 567 * @note Might be used to reduce power consumption while Bluetooth module stays powered but no (new) 568 * connections are expected 569 */ 570 void gap_connectable_control(uint8_t enable); 571 572 /** 573 * @brief Allows to control if device is discoverable. OFF by default. 574 */ 575 void gap_discoverable_control(uint8_t enable); 576 577 /** 578 * @brief Gets local address. 579 */ 580 void gap_local_bd_addr(bd_addr_t address_buffer); 581 582 /** 583 * @brief Deletes link key for remote device with baseband address. 584 * @param addr 585 * @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per 586 * Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during 587 * power up, this function only works, when the stack is in working state for these ports. 588 */ 589 void gap_drop_link_key_for_bd_addr(bd_addr_t addr); 590 591 /** 592 * @brief Delete all stored link keys 593 * @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per 594 * Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during 595 * power up, this function only works, when the stack is in working state for these ports. 596 */ 597 void gap_delete_all_link_keys(void); 598 599 /** 600 * @brief Store link key for remote device with baseband address 601 * @param addr 602 * @param link_key 603 * @param link_key_type 604 * @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per 605 * Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during 606 * power up, this function only works, when the stack is in working state for these ports. 607 */ 608 void gap_store_link_key_for_bd_addr(bd_addr_t addr, link_key_t link_key, link_key_type_t type); 609 610 /** 611 * @brief Get link for remote device with basband address 612 * @param addr 613 * @param link_key (out) is stored here 614 * @param link_key_type (out) is stored here 615 * @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per 616 * Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during 617 * power up, this function only works, when the stack is in working state for these ports. 618 */ 619 bool gap_get_link_key_for_bd_addr(bd_addr_t addr, link_key_t link_key, link_key_type_t * type); 620 621 /** 622 * @brief Setup Link Key iterator 623 * @param it 624 * @returns 1 on success 625 * @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per 626 * Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during 627 * power up, this function only works, when the stack is in working state for these ports. 628 */ 629 int gap_link_key_iterator_init(btstack_link_key_iterator_t * it); 630 631 /** 632 * @brief Get next Link Key 633 * @param it 634 * @brief addr 635 * @brief link_key 636 * @brief type of link key 637 * @returns 1, if valid link key found 638 * @see note on gap_link_key_iterator_init 639 */ 640 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); 641 642 /** 643 * @brief Frees resources allocated by iterator_init 644 * @note Must be called after iteration to free resources 645 * @param it 646 * @see note on gap_link_key_iterator_init 647 */ 648 void gap_link_key_iterator_done(btstack_link_key_iterator_t * it); 649 650 /** 651 * @brief Start GAP Classic Inquiry 652 * @param duration in 1.28s units 653 * @return 0 if ok 654 * @events: GAP_EVENT_INQUIRY_RESULT, GAP_EVENT_INQUIRY_COMPLETE 655 */ 656 int gap_inquiry_start(uint8_t duration_in_1280ms_units); 657 658 /** 659 * @brief Stop GAP Classic Inquiry 660 * @brief Stop GAP Classic Inquiry 661 * @returns 0 if ok 662 * @events: GAP_EVENT_INQUIRY_COMPLETE 663 */ 664 int gap_inquiry_stop(void); 665 666 /** 667 * @brief Remote Name Request 668 * @param addr 669 * @param page_scan_repetition_mode 670 * @param clock_offset only used when bit 15 is set - pass 0 if not known 671 * @events: HCI_EVENT_REMOTE_NAME_REQUEST_COMPLETE 672 */ 673 int gap_remote_name_request(const bd_addr_t addr, uint8_t page_scan_repetition_mode, uint16_t clock_offset); 674 675 /** 676 * @brief Read RSSI 677 * @param con_handle 678 * @events: GAP_EVENT_RSSI_MEASUREMENT 679 */ 680 int gap_read_rssi(hci_con_handle_t con_handle); 681 682 /** 683 * @brief Legacy Pairing Pin Code Response 684 * @note data is not copied, pointer has to stay valid 685 * @param addr 686 * @param pin 687 * @return 0 if ok 688 */ 689 int gap_pin_code_response(const bd_addr_t addr, const char * pin); 690 691 /** 692 * @brief Legacy Pairing Pin Code Response for binary data / non-strings 693 * @note data is not copied, pointer has to stay valid 694 * @param addr 695 * @param pin_data 696 * @param pin_len 697 * @return 0 if ok 698 */ 699 int gap_pin_code_response_binary(const bd_addr_t addr, const uint8_t * pin_data, uint8_t pin_len); 700 701 /** 702 * @brief Abort Legacy Pairing 703 * @param addr 704 * @param pin 705 * @return 0 if ok 706 */ 707 int gap_pin_code_negative(bd_addr_t addr); 708 709 /** 710 * @brief SSP Passkey Response 711 * @param addr 712 * @param passkey [0..999999] 713 * @return 0 if ok 714 */ 715 int gap_ssp_passkey_response(const bd_addr_t addr, uint32_t passkey); 716 717 /** 718 * @brief Abort SSP Passkey Entry/Pairing 719 * @param addr 720 * @param pin 721 * @return 0 if ok 722 */ 723 int gap_ssp_passkey_negative(const bd_addr_t addr); 724 725 /** 726 * @brief Accept SSP Numeric Comparison 727 * @param addr 728 * @param passkey 729 * @return 0 if ok 730 */ 731 int gap_ssp_confirmation_response(const bd_addr_t addr); 732 733 /** 734 * @brief Abort SSP Numeric Comparison/Pairing 735 * @param addr 736 * @param pin 737 * @return 0 if ok 738 */ 739 int gap_ssp_confirmation_negative(const bd_addr_t addr); 740 741 /** 742 * @brief Enter Sniff mode 743 * @param con_handle 744 * @param sniff_min_interval range: 0x0002 to 0xFFFE; only even values are valid, Time = N * 0.625 ms 745 * @param sniff_max_interval range: 0x0002 to 0xFFFE; only even values are valid, Time = N * 0.625 ms 746 * @param sniff_attempt Number of Baseband receive slots for sniff attempt. 747 * @param sniff_timeout Number of Baseband receive slots for sniff timeout. 748 @ @return 0 if ok 749 */ 750 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); 751 752 /** 753 * @brief Exit Sniff mode 754 * @param con_handle 755 @ @return 0 if ok 756 */ 757 uint8_t gap_sniff_mode_exit(hci_con_handle_t con_handle); 758 759 // LE 760 761 /** 762 * @brief Get own addr type and address used for LE 763 */ 764 void gap_le_get_own_address(uint8_t * addr_type, bd_addr_t addr); 765 766 767 /** 768 * @brief Get state of connection re-encryption for bonded devices when in central role 769 * @note used by gatt_client and att_server to wait for re-encryption 770 * @param con_handle 771 * @return 1 if security setup is active 772 */ 773 int gap_reconnect_security_setup_active(hci_con_handle_t con_handle); 774 775 /** 776 * @brief Delete bonding information for remote device 777 * @note On most desktop ports, the LE Device DB uses a TLV and there is one TLV storage per 778 * Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during 779 * power up, this function only works, when the stack is in working state for these ports. 780 * @param address_type 781 * @param address 782 */ 783 void gap_delete_bonding(bd_addr_type_t address_type, bd_addr_t address); 784 785 /** 786 * LE Privacy 1.2 - requires support by Controller and ENABLE_LE_RESOLVING_LIST to be defined 787 */ 788 789 /** 790 * @brief Load LE Device DB entries into Controller Resolving List to allow filtering on 791 * bonded devies with resolvable private addresses 792 * @return EROOR_CODE_SUCCESS if supported by Controller 793 */ 794 uint8_t gap_load_resolving_list_from_le_device_db(void); 795 796 /** 797 * @brief Get local persistent IRK 798 */ 799 const uint8_t * gap_get_persistent_irk(void); 800 801 /* API_END*/ 802 803 #if defined __cplusplus 804 } 805 #endif 806 807 #endif // GAP_H 808