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