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 BLUEKITCHEN 24 * GMBH 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 * @title Genral Access Profile (GAP) 40 * 41 */ 42 43 #ifndef GAP_H 44 #define GAP_H 45 46 #if defined __cplusplus 47 extern "C" { 48 #endif 49 50 #include "btstack_defines.h" 51 #include "btstack_util.h" 52 53 #ifdef ENABLE_CLASSIC 54 #include "classic/btstack_link_key_db.h" 55 #endif 56 57 // BIG has up to 2 BIS (stereo) 58 #ifndef MAX_NR_BIS 59 #define MAX_NR_BIS 2 60 #endif 61 62 // CIG usually has up to 2 CIS (stereo) 63 #ifndef MAX_NR_CIS 64 #define MAX_NR_CIS 2 65 #endif 66 67 typedef enum { 68 69 // MITM protection not required 70 // No encryption required 71 // No user interaction required 72 LEVEL_0 = 0, 73 74 // MITM protection not required 75 // No encryption required 76 // Minimal user interaction desired 77 LEVEL_1, 78 79 // MITM protection not required 80 // Encryption required 81 LEVEL_2, 82 83 // MITM protection required 84 // Encryption required 85 // User interaction acceptable 86 LEVEL_3, 87 88 // MITM protection required 89 // Encryption required 90 // 128-bit equivalent strength for link and encryption keys required (P-192 is not enough) 91 // User interaction acceptable 92 LEVEL_4, 93 } gap_security_level_t; 94 95 96 typedef enum { 97 // non-secure 98 GAP_SECURITY_MODE_1 = 1, 99 100 // service level enforced security 101 GAP_SECURITY_MODE_2, 102 103 // link level enforced security 104 GAP_SECURITY_MODE_3, 105 106 // service level enforced security 107 GAP_SECURITY_MODE_4 108 } gap_security_mode_t; 109 110 typedef enum { 111 GAP_SECURITY_NONE, 112 GAP_SECURITY_ENCRYPTED, // SSP: JUST WORKS 113 GAP_SECURITY_AUTHENTICATED, // SSP: numeric comparison, passkey, OOB 114 // GAP_SECURITY_AUTHORIZED 115 } gap_security_state; 116 117 typedef enum { 118 GAP_CONNECTION_INVALID, 119 GAP_CONNECTION_ACL, 120 GAP_CONNECTION_SCO, 121 GAP_CONNECTION_LE 122 } gap_connection_type_t; 123 124 typedef struct le_connection_parameter_range{ 125 uint16_t le_conn_interval_min; 126 uint16_t le_conn_interval_max; 127 uint16_t le_conn_latency_min; 128 uint16_t le_conn_latency_max; 129 uint16_t le_supervision_timeout_min; 130 uint16_t le_supervision_timeout_max; 131 } le_connection_parameter_range_t; 132 133 typedef enum { 134 GAP_RANDOM_ADDRESS_TYPE_OFF = 0, 135 GAP_RANDOM_ADDRESS_TYPE_STATIC, 136 GAP_RANDOM_ADDRESS_NON_RESOLVABLE, 137 GAP_RANDOM_ADDRESS_RESOLVABLE, 138 } gap_random_address_type_t; 139 140 // Authorization state 141 typedef enum { 142 AUTHORIZATION_UNKNOWN, 143 AUTHORIZATION_PENDING, 144 AUTHORIZATION_DECLINED, 145 AUTHORIZATION_GRANTED 146 } authorization_state_t; 147 148 // Extended Advertising Parameters 149 typedef struct { 150 uint16_t advertising_event_properties; 151 uint16_t primary_advertising_interval_min; 152 uint16_t primary_advertising_interval_max; 153 uint8_t primary_advertising_channel_map; 154 bd_addr_type_t own_address_type; 155 bd_addr_type_t peer_address_type; 156 bd_addr_t peer_address; 157 uint8_t advertising_filter_policy; 158 int8_t advertising_tx_power; 159 uint8_t primary_advertising_phy; 160 uint8_t secondary_advertising_max_skip; 161 uint8_t secondary_advertising_phy; 162 uint8_t advertising_sid; 163 uint8_t scan_request_notification_enable; 164 } le_extended_advertising_parameters_t; 165 166 typedef struct { 167 uint16_t periodic_advertising_interval_min; 168 uint16_t periodic_advertising_interval_max; 169 uint16_t periodic_advertising_properties; 170 } le_periodic_advertising_parameters_t; 171 172 // Extended Advertising Set State 173 typedef struct { 174 btstack_linked_item_t item; 175 le_extended_advertising_parameters_t extended_params; 176 le_periodic_advertising_parameters_t periodic_params; 177 bd_addr_t random_address; 178 const uint8_t * adv_data; 179 const uint8_t * scan_data; 180 const uint8_t * periodic_data; 181 uint16_t adv_data_len; 182 uint16_t scan_data_len; 183 uint16_t periodic_data_len; 184 uint16_t adv_data_pos; 185 uint16_t scan_data_pos; 186 uint16_t periodic_data_pos; 187 uint16_t enable_timeout; 188 uint8_t advertising_handle; 189 uint8_t enable_max_scan_events; 190 bool periodic_include_adi; 191 uint8_t state; 192 uint8_t tasks; 193 } le_advertising_set_t; 194 195 // Isochronous Streams 196 197 // -- Broadcast Isochronous Group BIG 198 199 typedef struct { 200 uint8_t big_handle; 201 uint8_t advertising_handle; 202 uint8_t num_bis; 203 uint32_t sdu_interval_us; 204 uint16_t max_sdu; 205 uint16_t max_transport_latency_ms; 206 uint8_t rtn; 207 uint8_t phy; 208 uint8_t packing; 209 uint8_t framing; 210 uint8_t encryption; 211 uint8_t broadcast_code[16]; 212 } le_audio_big_params_t; 213 214 typedef struct { 215 uint8_t big_handle; 216 uint8_t sync_handle; 217 uint8_t encryption; 218 uint8_t broadcast_code[16]; 219 uint8_t mse; 220 uint16_t big_sync_timeout_10ms; 221 uint8_t num_bis; 222 uint8_t bis_indices[MAX_NR_BIS]; 223 } le_audio_big_sync_params_t; 224 225 typedef enum { 226 LE_AUDIO_BIG_STATE_CREATE, 227 LE_AUDIO_BIG_STATE_W4_ESTABLISHED, 228 LE_AUDIO_BIG_STATE_SETUP_ISO_PATH, 229 LE_AUDIO_BIG_STATE_W4_SETUP_ISO_PATH, 230 LE_AUDIO_BIG_STATE_W4_SETUP_ISO_PATH_THEN_TERMINATE, 231 LE_AUDIO_BIG_STATE_SETUP_ISO_PATHS_FAILED, 232 LE_AUDIO_BIG_STATE_ACTIVE, 233 LE_AUDIO_BIG_STATE_TERMINATE, 234 LE_AUDIO_BIG_STATE_W4_TERMINATED_AFTER_SETUP_FAILED, 235 LE_AUDIO_BIG_STATE_W4_TERMINATED, 236 } le_audio_big_state_t; 237 238 typedef struct { 239 btstack_linked_item_t item; 240 uint8_t big_handle; 241 le_audio_big_state_t state; 242 union { 243 uint8_t next_bis; 244 uint8_t status; 245 } state_vars; 246 uint8_t num_bis; 247 hci_con_handle_t bis_con_handles[MAX_NR_BIS]; 248 const le_audio_big_params_t * params; 249 // request to send 250 bool can_send_now_requested; 251 // previous and current timestamp of number completed event to track ISO intervals 252 bool num_completed_timestamp_previous_valid; 253 bool num_completed_timestamp_current_valid; 254 uint32_t num_completed_timestamp_previous_ms; 255 uint32_t num_completed_timestamp_current_ms; 256 257 } le_audio_big_t; 258 259 typedef struct { 260 btstack_linked_item_t item; 261 uint8_t big_handle; 262 le_audio_big_state_t state; 263 union { 264 uint8_t next_bis; 265 uint8_t status; 266 } state_vars; 267 uint8_t num_bis; 268 hci_con_handle_t bis_con_handles[MAX_NR_BIS]; 269 const le_audio_big_sync_params_t * params; 270 } le_audio_big_sync_t; 271 272 // -- Connected Isochronuous Group CIG 273 274 typedef enum { 275 LE_AUDIO_CIG_STATE_CREATE, 276 LE_AUDIO_CIG_STATE_W4_ESTABLISHED, 277 LE_AUDIO_CIG_STATE_W4_CIS_REQUEST, 278 LE_AUDIO_CIG_STATE_CREATE_CIS, 279 LE_AUDIO_CIG_STATE_W4_CREATE_CIS, 280 LE_AUDIO_CIG_STATE_SETUP_ISO_PATH, 281 LE_AUDIO_CIG_STATE_W4_SETUP_ISO_PATH, 282 LE_AUDIO_CIG_STATE_ACTIVE, 283 LE_AUDIO_CIG_STATE_REMOVE, 284 } le_audio_cig_state_t; 285 286 typedef struct { 287 uint8_t cis_id; 288 uint16_t max_sdu_c_to_p; 289 uint16_t max_sdu_p_to_c; 290 uint8_t phy_c_to_p; 291 uint8_t phy_p_to_c; 292 uint8_t rtn_c_to_p; 293 uint8_t rtn_p_to_c; 294 } le_audio_cis_params_t; 295 296 typedef struct { 297 uint8_t cig_id; 298 uint32_t sdu_interval_c_to_p; 299 uint32_t sdu_interval_p_to_c; 300 uint8_t worst_case_sca; 301 uint8_t packing; 302 uint8_t framing; 303 uint16_t max_transport_latency_c_to_p; 304 uint16_t max_transport_latency_p_to_c; 305 uint8_t num_cis; 306 le_audio_cis_params_t cis_params[MAX_NR_CIS]; 307 } le_audio_cig_params_t; 308 309 typedef struct { 310 btstack_linked_item_t item; 311 uint8_t cig_id; 312 le_audio_cig_params_t * params; 313 le_audio_cig_state_t state; 314 union { 315 uint8_t next_cis; 316 uint8_t status; 317 } state_vars; 318 uint8_t num_cis; 319 hci_con_handle_t cis_con_handles[MAX_NR_CIS]; 320 hci_con_handle_t acl_con_handles[MAX_NR_CIS]; 321 // request to send 322 bool can_send_now_requested; 323 } le_audio_cig_t; 324 325 /* API_START */ 326 327 // Classic + LE 328 329 /** 330 * @brief Read RSSI 331 * @param con_handle 332 * @events: GAP_EVENT_RSSI_MEASUREMENT 333 */ 334 int gap_read_rssi(hci_con_handle_t con_handle); 335 336 337 /** 338 * @brief Gets local address. 339 */ 340 void gap_local_bd_addr(bd_addr_t address_buffer); 341 342 /** 343 * @brief Disconnect connection with handle 344 * @param handle 345 */ 346 uint8_t gap_disconnect(hci_con_handle_t handle); 347 348 /** 349 * @brief Get connection type 350 * @param con_handle 351 * @result connection_type 352 */ 353 gap_connection_type_t gap_get_connection_type(hci_con_handle_t connection_handle); 354 355 /** 356 * @brief Get HCI connection role 357 * @param con_handle 358 * @result hci_role_t HCI_ROLE_MASTER / HCI_ROLE_SLAVE / HCI_ROLE_INVALID (if connection does not exist) 359 */ 360 hci_role_t gap_get_role(hci_con_handle_t connection_handle); 361 362 // Classic 363 364 /** 365 * @brief Request role switch 366 * @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 367 * @param addr 368 * @param hci_role_t HCI_ROLE_MASTER / HCI_ROLE_SLAVE 369 * @result status 370 */ 371 uint8_t gap_request_role(const bd_addr_t addr, hci_role_t role); 372 373 /** 374 * @brief Sets local name. 375 * @note Default name is 'BTstack 00:00:00:00:00:00' 376 * @note '00:00:00:00:00:00' in local_name will be replaced with actual bd addr 377 * @param name is not copied, make sure memory stays valid 378 */ 379 void gap_set_local_name(const char * local_name); 380 381 /** 382 * @brief Set Extended Inquiry Response data 383 * @note If not set, local name will be used for EIR data (see gap_set_local_name) 384 * @note '00:00:00:00:00:00' in local_name will be replaced with actual bd addr 385 * @param eir_data size HCI_EXTENDED_INQUIRY_RESPONSE_DATA_LEN (240) bytes, is not copied make sure memory stays valid 386 */ 387 void gap_set_extended_inquiry_response(const uint8_t * data); 388 389 /** 390 * @brief Set class of device 391 */ 392 void gap_set_class_of_device(uint32_t class_of_device); 393 394 /** 395 * @brief Set default link policy settings for all classic ACL links 396 * @param default_link_policy_settings - see LM_LINK_POLICY_* in bluetooth.h 397 * @note common value: LM_LINK_POLICY_ENABLE_ROLE_SWITCH | LM_LINK_POLICY_ENABLE_SNIFF_MODE to enable role switch and sniff mode 398 */ 399 void gap_set_default_link_policy_settings(uint16_t default_link_policy_settings); 400 401 /** 402 * @brief Set Allow Role Switch param for outgoing classic ACL links 403 * @param allow_role_switch - true: allow remote device to request role switch, false: stay master 404 */ 405 void gap_set_allow_role_switch(bool allow_role_switch); 406 407 /** 408 * @brief Set link supervision timeout for outgoing classic ACL links 409 * @param default_link_supervision_timeout * 0.625 ms, default 0x7d00 = 20 seconds, 0 = no link supervision timeout 410 */ 411 void gap_set_link_supervision_timeout(uint16_t link_supervision_timeout); 412 413 /** 414 * @brief Enable link watchdog. If no ACL packet is sent within timeout_ms, the link will get disconnected 415 * note: current implementation uses the automatic flush timeout controller feature with a max timeout of 1.28s 416 * @param timeout_ms 417 */ 418 void gap_enable_link_watchdog(uint16_t timeout_ms); 419 420 /** 421 * @brief Enable/disable bonding. Default is enabled. 422 * @param enabled 423 */ 424 void gap_set_bondable_mode(int enabled); 425 426 /** 427 * @brief Get bondable mode. 428 * @return 1 if bondable 429 */ 430 int gap_get_bondable_mode(void); 431 432 /** 433 * @brief Set security mode for all outgoing and incoming connections. Default: GAP_SECURITY_MODE_4 434 * @param security_mode is GAP_SECURITY_MODE_2 or GAP_SECURITY_MODE_4 435 * @return status ERROR_CODE_SUCCESS or ERROR_CODE_UNSUPPORTED_FEATURE_OR_PARAMETER_VALUE 436 */ 437 uint8_t gap_set_security_mode(gap_security_mode_t security_mode); 438 439 /** 440 * @brief Get security mode 441 * @return security_mode 442 */ 443 gap_security_mode_t gap_get_security_mode(void); 444 445 /** 446 * @brief Set security level for all outgoing and incoming connections. Default: LEVEL_2 447 * @param security_level 448 * @note has to be called before services or profiles are initialized 449 */ 450 void gap_set_security_level(gap_security_level_t security_level); 451 452 /** 453 * @brief Get security level 454 * @return security_level 455 */ 456 gap_security_level_t gap_get_security_level(void); 457 458 /** 459 * @brief Set Secure Connections Only Mode for BR/EDR (Classic) Default: false 460 * @param enable 461 */ 462 void gap_set_secure_connections_only_mode(bool enable); 463 464 /** 465 * @breif Get Secure Connections Only Mode 466 * @param enabled 467 */ 468 bool gap_get_secure_connections_only_mode(void); 469 470 /** 471 * @brief Set minimal security level for registered services 472 * @param security_level 473 * @note Called by L2CAP based on registered services 474 */ 475 void gap_set_minimal_service_security_level(gap_security_level_t security_level); 476 477 /** 478 * @brief Register filter for rejecting classic connections. Callback will return 1 accept connection, 0 on reject. 479 */ 480 void gap_register_classic_connection_filter(int (*accept_callback)(bd_addr_t addr, hci_link_type_t link_type)); 481 482 /* Configure Secure Simple Pairing */ 483 484 /** 485 * @brief Enable will enable SSP during init. Default: true 486 */ 487 void gap_ssp_set_enable(int enable); 488 489 /** 490 * @brief Set IO Capability. BTstack will return capability to SSP requests 491 */ 492 void gap_ssp_set_io_capability(int ssp_io_capability); 493 494 /** 495 * @brief Set Authentication Requirements using during SSP 496 */ 497 void gap_ssp_set_authentication_requirement(int authentication_requirement); 498 499 /** 500 * @brief Enable/disable Secure Connections. Default: true if supported by Controller 501 */ 502 void gap_secure_connections_enable(bool enable); 503 504 /** 505 * @brief Query if Secure Connections can be used for Classic connections. 506 * @note Requires gap_secure_connections_enable == true and Controller to support it 507 */ 508 bool gap_secure_connections_active(void); 509 510 /** 511 * @brief If set, BTstack will confirm a numeric comparison and enter '000000' if requested. 512 */ 513 void gap_ssp_set_auto_accept(int auto_accept); 514 515 /** 516 * @brief Set required encryption key size for GAP Levels 1-3 on ccassic connections. Default: 16 bytes 517 * @param encryption_key_size in bytes. Valid 7..16 518 */ 519 void gap_set_required_encryption_key_size(uint8_t encryption_key_size); 520 521 /** 522 * @brief Start dedicated bonding with device. Disconnect after bonding. 523 * @param device 524 * @param request MITM protection 525 * @return error, if max num acl connections active 526 * @result GAP_DEDICATED_BONDING_COMPLETE 527 */ 528 int gap_dedicated_bonding(bd_addr_t device, int mitm_protection_required); 529 530 gap_security_level_t gap_security_level_for_link_key_type(link_key_type_t link_key_type); 531 532 /** 533 * @brief map link keys to secure connection yes/no 534 */ 535 bool gap_secure_connection_for_link_key_type(link_key_type_t link_key_type); 536 537 /** 538 * @brief map link keys to authenticated 539 */ 540 bool gap_authenticated_for_link_key_type(link_key_type_t link_key_type); 541 542 gap_security_level_t gap_security_level(hci_con_handle_t con_handle); 543 544 void gap_request_security_level(hci_con_handle_t con_handle, gap_security_level_t level); 545 546 bool gap_mitm_protection_required_for_security_level(gap_security_level_t level); 547 548 /** 549 * @brief Set Page Scan Type 550 * @param page_scan_interval * 0.625 ms, range: 0x0012..0x1000, default: 0x0800 551 * @param page_scan_windows * 0.625 ms, range: 0x0011..page_scan_interval, default: 0x0012 552 */ 553 void gap_set_page_scan_activity(uint16_t page_scan_interval, uint16_t page_scan_window); 554 555 /** 556 * @brief Set Page Scan Type 557 * @param page_scan_mode 558 */ 559 void gap_set_page_scan_type(page_scan_type_t page_scan_type); 560 561 /** 562 * @brief Set Page Timeout 563 * @param page_timeout * 0.625 ms, range: 0x0001..0xffff, default: 0x6000 (ca 15 seconds) 564 */ 565 void gap_set_page_timeout(uint16_t page_timeout); 566 567 // LE 568 569 /** 570 * @brief Set parameters for LE Scan 571 * @param scan_type 0 = passive, 1 = active 572 * @param scan_interval range 0x0004..0x4000, unit 0.625 ms 573 * @param scan_window range 0x0004..0x4000, unit 0.625 ms 574 * @param scanning_filter_policy 0 = all devices, 1 = all from whitelist 575 */ 576 void gap_set_scan_params(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window, uint8_t scanning_filter_policy); 577 578 /** 579 * @brief Set parameters for LE Scan 580 * @deprecated Use gap_set_scan_params instead 581 */ 582 void gap_set_scan_parameters(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window); 583 584 /** 585 * @brief Start LE Scan 586 */ 587 void gap_start_scan(void); 588 589 /** 590 * @brief Stop LE Scan 591 */ 592 void gap_stop_scan(void); 593 594 /** 595 * @brief Enable privacy by using random addresses 596 * @param random_address_type to use (incl. OFF) 597 */ 598 void gap_random_address_set_mode(gap_random_address_type_t random_address_type); 599 600 /** 601 * @brief Get privacy mode 602 */ 603 gap_random_address_type_t gap_random_address_get_mode(void); 604 605 /** 606 * @brief Sets update period for random address 607 * @param period_ms in ms 608 */ 609 void gap_random_address_set_update_period(int period_ms); 610 611 /** 612 * @brief Sets a fixed random address for advertising 613 * @param addr 614 * @note Sets random address mode to type off 615 */ 616 void gap_random_address_set(const bd_addr_t addr); 617 618 /** 619 * @brief Set Advertisement Data 620 * @param advertising_data_length 621 * @param advertising_data (max 31 octets) 622 * @note data is not copied, pointer has to stay valid 623 * @note '00:00:00:00:00:00' in advertising_data will be replaced with actual bd addr 624 */ 625 void gap_advertisements_set_data(uint8_t advertising_data_length, uint8_t * advertising_data); 626 627 /** 628 * @brief Set Advertisement Parameters 629 * @param adv_int_min 630 * @param adv_int_max 631 * @param adv_type 632 * @param direct_address_type 633 * @param direct_address 634 * @param channel_map 635 * @param filter_policy 636 * @note own_address_type is used from gap_random_address_set_mode 637 */ 638 void gap_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 639 uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy); 640 641 /** 642 * @brief Enable/Disable Advertisements. OFF by default. 643 * @param enabled 644 */ 645 void gap_advertisements_enable(int enabled); 646 647 /** 648 * @brief Set Scan Response Data 649 * 650 * @note For scan response data, scannable undirected advertising (ADV_SCAN_IND) need to be used 651 * 652 * @param advertising_data_length 653 * @param advertising_data (max 31 octets) 654 * @note data is not copied, pointer has to stay valid 655 * @note '00:00:00:00:00:00' in scan_response_data will be replaced with actual bd addr 656 */ 657 void gap_scan_response_set_data(uint8_t scan_response_data_length, uint8_t * scan_response_data); 658 659 /** 660 * @brief Provide storage for new advertising set and setup on Controller 661 * @param storage to use by stack, needs to stay valid until adv set is removed with gap_extended_advertising_remove 662 * @param advertising_parameters 663 * @param out_advertising_handle to use with other adv config commands 664 * @return status 665 * @events: GAP_SUBEVENT_ADVERTISING_SET_INSTALLED 666 */ 667 uint8_t gap_extended_advertising_setup(le_advertising_set_t * storage, const le_extended_advertising_parameters_t * advertising_parameters, uint8_t * out_advertising_handle); 668 669 /** 670 * @param Set advertising params for advertising set 671 * @param advertising_handle 672 * @param advertising_parameters 673 * @return status 674 */ 675 uint8_t gap_extended_advertising_set_params(uint8_t advertising_handle, const le_extended_advertising_parameters_t * advertising_parameters); 676 677 /** 678 * @param Get advertising params for advertising set, e.g. to update params 679 * @param advertising_handle 680 * @param advertising_parameters 681 * @return status 682 */ 683 uint8_t gap_extended_advertising_get_params(uint8_t advertising_handle, le_extended_advertising_parameters_t * advertising_parameters); 684 685 /** 686 * @param Set periodic advertising params for advertising set 687 * @param advertising_handle 688 * @param advertising_parameters 689 * @return status 690 */ 691 uint8_t gap_periodic_advertising_set_params(uint8_t advertising_handle, const le_periodic_advertising_parameters_t * advertising_parameters); 692 693 /** 694 * @param Get params for periodic advertising set, e.g. to update params 695 * @param advertising_handle 696 * @param advertising_parameters 697 * @return status 698 */ 699 uint8_t gap_periodic_advertising_get_params(uint8_t advertising_handle, le_periodic_advertising_parameters_t * advertising_parameters); 700 701 /** 702 * @param Set random addrress for advertising set 703 * @param advertising_handle 704 * @param random_address 705 * @return status 706 */ 707 uint8_t gap_extended_advertising_set_random_address(uint8_t advertising_handle, bd_addr_t random_address); 708 709 /** 710 * @brief Set Advertising Data for a advertisement set 711 * @param advertising_handle 712 * @param advertising_data_length 713 * @param advertising_data 714 * @return status 715 */ 716 uint8_t gap_extended_advertising_set_adv_data(uint8_t advertising_handle, uint16_t advertising_data_length, const uint8_t * advertising_data); 717 718 /** 719 * @brief Set Scan Response Data for a advertisement set 720 * @param advertising_handle 721 * @param scan_response_data_length 722 * @param scan_response_data 723 * @return status 724 */ 725 uint8_t gap_extended_advertising_set_scan_response_data(uint8_t advertising_handle, uint16_t scan_response_data_length, const uint8_t * scan_response_data); 726 727 /** 728 * @brief Set data for periodic advertisement set 729 * @param advertising_handle 730 * @param periodic_data_length 731 * @param periodic_data 732 * @return status 733 */ 734 uint8_t gap_periodic_advertising_set_data(uint8_t advertising_handle, uint16_t periodic_data_length, const uint8_t * periodic_data); 735 736 /** 737 * @brief Start advertising advertising set 738 * @param advertising_handle 739 * @param timeout in 10ms, or 0 == no timeout 740 * @param num_extended_advertising_events Controller shall send, or 0 == no max number 741 * @return status 742 */ 743 uint8_t gap_extended_advertising_start(uint8_t advertising_handle, uint16_t timeout, uint8_t num_extended_advertising_events); 744 745 /** 746 * @brief Stop advertising 747 * @param advertising_handle 748 * @return status 749 */ 750 uint8_t gap_extended_advertising_stop(uint8_t advertising_handle); 751 752 /** 753 * @brief Start periodic advertising for given advertising set 754 * @param advertising_handle 755 * @param include_adi 756 * @return status 757 */ 758 uint8_t gap_periodic_advertising_start(uint8_t advertising_handle, bool include_adi); 759 760 /** 761 * @brief Stop periodic advertising for given advertising set 762 * @param advertising_handle 763 * @return status 764 */ 765 uint8_t gap_periodic_advertising_stop(uint8_t advertising_handle); 766 767 /** 768 * @brief Remove advertising set from Controller 769 * @param advertising_handle 770 * @return status 771 * @events GAP_SUBEVENT_ADVERTISING_SET_REMOVED 772 */ 773 uint8_t gap_extended_advertising_remove(uint8_t advertising_handle); 774 775 /** 776 * @brief Create Broadcast Isochronous Group (BIG) 777 * @param storage to use by stack, needs to stay valid until adv set is removed with gap_big_terminate 778 * @param big_params 779 * @return status 780 * @events GAP_SUBEVENT_BIG_CREATED unless interrupted by call to gap_big_terminate 781 */ 782 uint8_t gap_big_create(le_audio_big_t * storage, le_audio_big_params_t * big_params); 783 784 /** 785 * @brief Terminate Broadcast Isochronous Group (BIG) 786 * @param big_handle 787 * @return status 788 * @events: GAP_SUBEVENT_BIG_TERMINATED 789 */ 790 uint8_t gap_big_terminate(uint8_t big_handle); 791 792 /** 793 * @brief Synchronize to Broadcast Isochronous Group (BIG) 794 * @param storage to use by stack, needs to stay valid until adv set is removed with gap_big_terminate 795 * @param big_sync_params 796 * @return status 797 * @events GAP_SUBEVENT_BIG_SYNC_CREATED unless interrupted by call to gap_big_sync_terminate 798 */ 799 uint8_t gap_big_sync_create(le_audio_big_sync_t * storage, le_audio_big_sync_params_t * big_sync_params); 800 801 /** 802 * @brief Stop synchronizing to Broadcast Isochronous Group (BIG). Triggers GAP_SUBEVENT_BIG_SYNC_STOPPED 803 * @note Also used to stop synchronizing before BIG Sync was established 804 * @param big_handle 805 * @return status 806 * @events GAP_SUBEVENT_BIG_SYNC_STOPPED 807 */ 808 uint8_t gap_big_sync_terminate(uint8_t big_handle); 809 810 /** 811 * @brief Create Connected Isochronous Group (CIG) 812 * @param storage to use by stack, needs to stay valid until CIG removed with gap_cig_remove 813 * @param cig_params 814 * @return status 815 * @events GAP_SUBEVENT_CIG_CREATED unless interrupted by call to gap_cig_remove 816 */ 817 uint8_t gap_cig_create(le_audio_cig_t * storage, le_audio_cig_params_t * cig_params); 818 819 /** 820 * @brief Remove Connected Isochronous Group (CIG) 821 * @param cig_handle 822 * @return status 823 * @events GAP_SUBEVENT_CIG_TERMINATED 824 */ 825 uint8_t gap_cig_remove(uint8_t cig_handle); 826 827 /** 828 * @brief Create Connected Isochronous Streams (CIS) 829 * @note number of CIS from cig_params in gap_cig_create is used 830 * @param cig_handle 831 * @param cis_con_handles array of CIS Connection Handles 832 * @param acl_con_handles array of ACL Connection Handles 833 * @return status 834 * @events GAP_SUBEVENT_CIS_CREATED unless interrupted by call to gap_cig_remove 835 */ 836 uint8_t gap_cis_create(uint8_t cig_handle, hci_con_handle_t cis_con_handles [], hci_con_handle_t acl_con_handles []); 837 838 /** 839 * @brief Set connection parameters for outgoing connections 840 * @param conn_scan_interval (unit: 0.625 msec), default: 60 ms 841 * @param conn_scan_window (unit: 0.625 msec), default: 30 ms 842 * @param conn_interval_min (unit: 1.25ms), default: 10 ms 843 * @param conn_interval_max (unit: 1.25ms), default: 30 ms 844 * @param conn_latency, default: 4 845 * @param supervision_timeout (unit: 10ms), default: 720 ms 846 * @param min_ce_length (unit: 0.625ms), default: 10 ms 847 * @param max_ce_length (unit: 0.625ms), default: 30 ms 848 */ 849 void gap_set_connection_parameters(uint16_t conn_scan_interval, uint16_t conn_scan_window, 850 uint16_t conn_interval_min, uint16_t conn_interval_max, uint16_t conn_latency, 851 uint16_t supervision_timeout, uint16_t min_ce_length, uint16_t max_ce_length); 852 853 /** 854 * @brief Request an update of the connection parameter for a given LE connection 855 * @param handle 856 * @param conn_interval_min (unit: 1.25ms) 857 * @param conn_interval_max (unit: 1.25ms) 858 * @param conn_latency 859 * @param supervision_timeout (unit: 10ms) 860 * @return 0 if ok 861 */ 862 int gap_request_connection_parameter_update(hci_con_handle_t con_handle, uint16_t conn_interval_min, 863 uint16_t conn_interval_max, uint16_t conn_latency, uint16_t supervision_timeout); 864 865 /** 866 * @brief Updates the connection parameters for a given LE connection 867 * @param handle 868 * @param conn_interval_min (unit: 1.25ms) 869 * @param conn_interval_max (unit: 1.25ms) 870 * @param conn_latency 871 * @param supervision_timeout (unit: 10ms) 872 * @return 0 if ok 873 */ 874 int gap_update_connection_parameters(hci_con_handle_t con_handle, uint16_t conn_interval_min, 875 uint16_t conn_interval_max, uint16_t conn_latency, uint16_t supervision_timeout); 876 877 /** 878 * @brief Set accepted connection parameter range 879 * @param range 880 */ 881 void gap_get_connection_parameter_range(le_connection_parameter_range_t * range); 882 883 /** 884 * @brief Get accepted connection parameter range 885 * @param range 886 */ 887 void gap_set_connection_parameter_range(le_connection_parameter_range_t * range); 888 889 /** 890 * @brief Test if connection parameters are inside in existing rage 891 * @param conn_interval_min (unit: 1.25ms) 892 * @param conn_interval_max (unit: 1.25ms) 893 * @param conn_latency 894 * @param supervision_timeout (unit: 10ms) 895 * @return 1 if included 896 */ 897 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); 898 899 /** 900 * @brief Set max number of connections in LE Peripheral role (if Bluetooth Controller supports it) 901 * @note: default: 1 902 * @param max_peripheral_connections 903 */ 904 void gap_set_max_number_peripheral_connections(int max_peripheral_connections); 905 906 /** 907 * @brief Add Device to Whitelist 908 * @param address_typ 909 * @param address 910 * @return 0 if ok 911 */ 912 uint8_t gap_whitelist_add(bd_addr_type_t address_type, const bd_addr_t address); 913 914 /** 915 * @brief Remove Device from Whitelist 916 * @param address_typ 917 * @param address 918 * @return 0 if ok 919 */ 920 uint8_t gap_whitelist_remove(bd_addr_type_t address_type, const bd_addr_t address); 921 922 /** 923 * @brief Clear Whitelist 924 * @return 0 if ok 925 */ 926 uint8_t gap_whitelist_clear(void); 927 928 /** 929 * @brief Connect to remote LE device 930 */ 931 uint8_t gap_connect(const bd_addr_t addr, bd_addr_type_t addr_type); 932 933 /** 934 * @brief Connect with Whitelist 935 * @note Explicit whitelist management and this connect with whitelist replace deprecated gap_auto_connection_* functions 936 * @return - if ok 937 */ 938 uint8_t gap_connect_with_whitelist(void); 939 940 /** 941 * @brief Cancel connection process initiated by gap_connect 942 */ 943 uint8_t gap_connect_cancel(void); 944 945 /** 946 * @brief Auto Connection Establishment - Start Connecting to device 947 * @deprecated Please setup Whitelist with gap_whitelist_* and start connecting with gap_connect_with_whitelist 948 * @param address_type 949 * @param address 950 * @return 0 if ok 951 */ 952 uint8_t gap_auto_connection_start(bd_addr_type_t address_type, const bd_addr_t address); 953 954 /** 955 * @brief Auto Connection Establishment - Stop Connecting to device 956 * @deprecated Please setup Whitelist with gap_whitelist_* and start connecting with gap_connect_with_whitelist 957 * @param address_type 958 * @param address 959 * @return 0 if ok 960 */ 961 uint8_t gap_auto_connection_stop(bd_addr_type_t address_type, const bd_addr_t address); 962 963 /** 964 * @brief Auto Connection Establishment - Stop everything 965 * @deprecated Please setup Whitelist with gap_whitelist_* and start connecting with gap_connect_with_whitelist 966 * @note Convenience function to stop all active auto connection attempts 967 */ 968 uint8_t gap_auto_connection_stop_all(void); 969 970 /** 971 * @brief Set LE PHY 972 * @param con_handle 973 * @param all_phys 0 = set rx/tx, 1 = set only rx, 2 = set only tx 974 * @param tx_phys 1 = 1M, 2 = 2M, 4 = Coded 975 * @param rx_phys 1 = 1M, 2 = 2M, 4 = Coded 976 * @param phy_options 0 = no preferred coding for Coded, 1 = S=2 coding (500 kbit), 2 = S=8 coding (125 kbit) 977 * @return 0 if ok 978 */ 979 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); 980 981 /** 982 * @brief Get connection interval 983 * @param con_handle 984 * @return connection interval, otherwise 0 if error 985 */ 986 uint16_t gap_le_connection_interval(hci_con_handle_t con_handle); 987 988 /** 989 * 990 * @brief Get encryption key size. 991 * @param con_handle 992 * @return 0 if not encrypted, 7-16 otherwise 993 */ 994 uint8_t gap_encryption_key_size(hci_con_handle_t con_handle); 995 996 /** 997 * @brief Get authentication property. 998 * @param con_handle 999 * @return 1 if bonded with OOB/Passkey (AND MITM protection) 1000 */ 1001 bool gap_authenticated(hci_con_handle_t con_handle); 1002 1003 /** 1004 * @brief Get secure connection property 1005 * @param con_handle 1006 * @return 1 if bonded usiung LE Secure Connections 1007 */ 1008 bool gap_secure_connection(hci_con_handle_t con_handle); 1009 1010 /** 1011 * @brief Queries authorization state. 1012 * @param con_handle 1013 * @return authorization_state for the current session 1014 */ 1015 authorization_state_t gap_authorization_state(hci_con_handle_t con_handle); 1016 1017 /** 1018 * @brief Get bonded property (BR/EDR/LE) 1019 * @note LE: has to be called after identity resolving is complete 1020 * @param con_handle 1021 * @return true if bonded 1022 */ 1023 bool gap_bonded(hci_con_handle_t con_handle); 1024 1025 // Classic 1026 #ifdef ENABLE_CLASSIC 1027 1028 /** 1029 * @brief Override page scan mode. Page scan mode enabled by l2cap when services are registered 1030 * @note Might be used to reduce power consumption while Bluetooth module stays powered but no (new) 1031 * connections are expected 1032 */ 1033 void gap_connectable_control(uint8_t enable); 1034 1035 /** 1036 * @brief Allows to control if device is discoverable. OFF by default. 1037 */ 1038 void gap_discoverable_control(uint8_t enable); 1039 1040 /** 1041 * @brief Deletes link key for remote device with baseband address. 1042 * @param addr 1043 * @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per 1044 * Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during 1045 * power up, this function only works, when the stack is in working state for these ports. 1046 */ 1047 void gap_drop_link_key_for_bd_addr(bd_addr_t addr); 1048 1049 /** 1050 * @brief Delete all stored link keys 1051 * @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per 1052 * Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during 1053 * power up, this function only works, when the stack is in working state for these ports. 1054 */ 1055 void gap_delete_all_link_keys(void); 1056 1057 /** 1058 * @brief Store link key for remote device with baseband address 1059 * @param addr 1060 * @param link_key 1061 * @param link_key_type 1062 * @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per 1063 * Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during 1064 * power up, this function only works, when the stack is in working state for these ports. 1065 */ 1066 void gap_store_link_key_for_bd_addr(bd_addr_t addr, link_key_t link_key, link_key_type_t type); 1067 1068 /** 1069 * @brief Get link for remote device with basband address 1070 * @param addr 1071 * @param link_key (out) is stored here 1072 * @param link_key_type (out) is stored here 1073 * @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per 1074 * Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during 1075 * power up, this function only works, when the stack is in working state for these ports. 1076 */ 1077 bool gap_get_link_key_for_bd_addr(bd_addr_t addr, link_key_t link_key, link_key_type_t * type); 1078 1079 /** 1080 * @brief Setup Link Key iterator 1081 * @param it 1082 * @return 1 on success 1083 * @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per 1084 * Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during 1085 * power up, this function only works, when the stack is in working state for these ports. 1086 */ 1087 int gap_link_key_iterator_init(btstack_link_key_iterator_t * it); 1088 1089 /** 1090 * @brief Get next Link Key 1091 * @param it 1092 * @brief addr 1093 * @brief link_key 1094 * @brief type of link key 1095 * @return 1, if valid link key found 1096 * @see note on gap_link_key_iterator_init 1097 */ 1098 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); 1099 1100 /** 1101 * @brief Frees resources allocated by iterator_init 1102 * @note Must be called after iteration to free resources 1103 * @param it 1104 * @see note on gap_link_key_iterator_init 1105 */ 1106 void gap_link_key_iterator_done(btstack_link_key_iterator_t * it); 1107 1108 /** 1109 * @brief Start GAP Classic Inquiry 1110 * @param duration in 1.28s units 1111 * @return 0 if ok 1112 * @events: GAP_EVENT_INQUIRY_RESULT, GAP_EVENT_INQUIRY_COMPLETE 1113 */ 1114 int gap_inquiry_start(uint8_t duration_in_1280ms_units); 1115 1116 /** 1117 * @brief Start GAP Classic Periodic Inquiry 1118 * @param duration in 1.28s units 1119 * @param max_period_length between consecutive inquiries in 1.28s units 1120 * @param min_period_length between consecutive inquiries in 1.28s units 1121 * @return 0 if ok 1122 * @events: GAP_EVENT_INQUIRY_RESULT, GAP_EVENT_INQUIRY_COMPLETE 1123 */ 1124 uint8_t gap_inquiry_periodic_start(uint8_t duration, uint16_t max_period_length, uint16_t min_period_length); 1125 1126 /** 1127 * @brief Stop GAP Classic Inquiry (regular or periodic) 1128 * @return 0 if ok 1129 * @events: GAP_EVENT_INQUIRY_COMPLETE 1130 */ 1131 int gap_inquiry_stop(void); 1132 1133 /** 1134 * @brief Set LAP for GAP Classic Inquiry 1135 * @param lap GAP_IAC_GENERAL_INQUIRY (default), GAP_IAC_LIMITED_INQUIRY 1136 */ 1137 void gap_inquiry_set_lap(uint32_t lap); 1138 1139 /** 1140 * @brief Set Inquiry Scan Activity 1141 * @param inquiry_scan_interval range: 0x0012 to 0x1000; only even values are valid, Time = N * 0.625 ms 1142 * @param inquiry_scan_window range: 0x0011 to 0x1000; Time = N * 0.625 ms 1143 */ 1144 void gap_inquiry_set_scan_activity(uint16_t inquiry_scan_interval, uint16_t inquiry_scan_window); 1145 1146 /** 1147 * @brief Remote Name Request 1148 * @param addr 1149 * @param page_scan_repetition_mode 1150 * @param clock_offset only used when bit 15 is set - pass 0 if not known 1151 * @events: HCI_EVENT_REMOTE_NAME_REQUEST_COMPLETE 1152 */ 1153 int gap_remote_name_request(const bd_addr_t addr, uint8_t page_scan_repetition_mode, uint16_t clock_offset); 1154 1155 /** 1156 * @brief Legacy Pairing Pin Code Response 1157 * @note data is not copied, pointer has to stay valid 1158 * @param addr 1159 * @param pin 1160 * @return 0 if ok 1161 */ 1162 int gap_pin_code_response(const bd_addr_t addr, const char * pin); 1163 1164 /** 1165 * @brief Legacy Pairing Pin Code Response for binary data / non-strings 1166 * @note data is not copied, pointer has to stay valid 1167 * @param addr 1168 * @param pin_data 1169 * @param pin_len 1170 * @return 0 if ok 1171 */ 1172 int gap_pin_code_response_binary(const bd_addr_t addr, const uint8_t * pin_data, uint8_t pin_len); 1173 1174 /** 1175 * @brief Abort Legacy Pairing 1176 * @param addr 1177 * @param pin 1178 * @return 0 if ok 1179 */ 1180 int gap_pin_code_negative(bd_addr_t addr); 1181 1182 /** 1183 * @brief SSP Passkey Response 1184 * @param addr 1185 * @param passkey [0..999999] 1186 * @return 0 if ok 1187 */ 1188 int gap_ssp_passkey_response(const bd_addr_t addr, uint32_t passkey); 1189 1190 /** 1191 * @brief Abort SSP Passkey Entry/Pairing 1192 * @param addr 1193 * @param pin 1194 * @return 0 if ok 1195 */ 1196 int gap_ssp_passkey_negative(const bd_addr_t addr); 1197 1198 /** 1199 * @brief Accept SSP Numeric Comparison 1200 * @param addr 1201 * @param passkey 1202 * @return 0 if ok 1203 */ 1204 int gap_ssp_confirmation_response(const bd_addr_t addr); 1205 1206 /** 1207 * @brief Abort SSP Numeric Comparison/Pairing 1208 * @param addr 1209 * @param pin 1210 * @return 0 if ok 1211 */ 1212 int gap_ssp_confirmation_negative(const bd_addr_t addr); 1213 1214 /** 1215 * @brief Generate new OOB data 1216 * @note OOB data will be provided in GAP_EVENT_LOCAL_OOB_DATA and be used in future pairing procedures 1217 */ 1218 void gap_ssp_generate_oob_data(void); 1219 1220 /** 1221 * @brief Report Remote OOB Data 1222 * @note Pairing Hash and Randomizer are expected in big-endian byte format 1223 * @param bd_addr 1224 * @param c_192 Simple Pairing Hash C derived from P-192 public key 1225 * @param r_192 Simple Pairing Randomizer derived from P-192 public key 1226 * @param c_256 Simple Pairing Hash C derived from P-256 public key 1227 * @param r_256 Simple Pairing Randomizer derived from P-256 public key 1228 */ 1229 uint8_t gap_ssp_remote_oob_data(const bd_addr_t addr, const uint8_t * c_192, const uint8_t * r_192, const uint8_t * c_256, const uint8_t * r_256); 1230 1231 /** 1232 * Send SSP IO Capabilities Reply 1233 * @note IO Capabilities (Negative) Reply is sent automatically unless ENABLE_EXPLICIT_IO_CAPABILITIES_REPLY 1234 * @param addr 1235 * @return 0 if ok 1236 */ 1237 uint8_t gap_ssp_io_capabilities_response(const bd_addr_t addr); 1238 1239 /** 1240 * Send SSP IO Capabilities Negative Reply 1241 * @note IO Capabilities (Negative) Reply is sent automatically unless ENABLE_EXPLICIT_IO_CAPABILITIES_REPLY 1242 * @param addr 1243 * @return 0 if ok 1244 */ 1245 uint8_t gap_ssp_io_capabilities_negative(const bd_addr_t addr); 1246 1247 /** 1248 * Send Link Key Reponse 1249 * @note Link Key (Negative) Reply is sent automatically unless ENABLE_EXPLICIT_LINK_KEY_RESPONSE 1250 * @param addr 1251 * @param link_key 1252 * @param type or INVALID_LINK_KEY if link key not available 1253 * @return 0 if ok 1254 */ 1255 uint8_t gap_send_link_key_response(const bd_addr_t addr, link_key_t link_key, link_key_type_t type); 1256 1257 /** 1258 * @brief Enter Sniff mode 1259 * @param con_handle 1260 * @param sniff_min_interval range: 0x0002 to 0xFFFE; only even values are valid, Time = N * 0.625 ms 1261 * @param sniff_max_interval range: 0x0002 to 0xFFFE; only even values are valid, Time = N * 0.625 ms 1262 * @param sniff_attempt Number of Baseband receive slots for sniff attempt. 1263 * @param sniff_timeout Number of Baseband receive slots for sniff timeout. 1264 @ @return 0 if ok 1265 */ 1266 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); 1267 1268 /** 1269 * @brief Exit Sniff mode 1270 * @param con_handle 1271 @ @return 0 if ok 1272 */ 1273 uint8_t gap_sniff_mode_exit(hci_con_handle_t con_handle); 1274 1275 /** 1276 * @brief Configure Sniff Subrating 1277 * @param con_handle 1278 * @param max_latency range: 0x0002 to 0xFFFE; Time = N * 0.625 ms 1279 * @param min_remote_timeout range: 0x0002 to 0xFFFE; Time = N * 0.625 ms 1280 * @param min_local_timeout range: 0x0002 to 0xFFFE; Time = N * 0.625 ms 1281 @ @return 0 if ok 1282 */ 1283 uint8_t gap_sniff_subrating_configure(hci_con_handle_t con_handle, uint16_t max_latency, uint16_t min_remote_timeout, uint16_t min_local_timeout); 1284 1285 /** 1286 * @Brief Set QoS 1287 * @param con_handle 1288 * @param service_type 1289 * @param token_rate 1290 * @param peak_bandwidth 1291 * @param latency 1292 * @param delay_variation 1293 @ @return 0 if ok 1294 */ 1295 uint8_t gap_qos_set(hci_con_handle_t con_handle, hci_service_type_t service_type, uint32_t token_rate, uint32_t peak_bandwidth, uint32_t latency, uint32_t delay_variation); 1296 1297 #endif 1298 1299 // LE 1300 1301 /** 1302 * @brief Get own addr type and address used for LE for next scan/advertisement/connect operation 1303 */ 1304 void gap_le_get_own_address(uint8_t * addr_type, bd_addr_t addr); 1305 1306 /** 1307 * @brief Get own addr type and address used for LE advertisements (Peripheral) 1308 */ 1309 void gap_le_get_own_advertisements_address(uint8_t * addr_type, bd_addr_t addr); 1310 1311 /** 1312 * @brief Get own addr type and address used for LE connections (Central) 1313 */ 1314 void gap_le_get_own_connection_address(uint8_t * addr_type, bd_addr_t addr); 1315 1316 /** 1317 * @brief Get state of connection re-encryption for bonded devices when in central role 1318 * @note used by gatt_client and att_server to wait for re-encryption 1319 * @param con_handle 1320 * @return 1 if security setup is active 1321 */ 1322 int gap_reconnect_security_setup_active(hci_con_handle_t con_handle); 1323 1324 /** 1325 * @brief Delete bonding information for remote device 1326 * @note On most desktop ports, the LE Device DB uses a TLV and there is one TLV storage per 1327 * Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during 1328 * power up, this function only works, when the stack is in working state for these ports. 1329 * @param address_type 1330 * @param address 1331 */ 1332 void gap_delete_bonding(bd_addr_type_t address_type, bd_addr_t address); 1333 1334 /** 1335 * LE Privacy 1.2 - requires support by Controller and ENABLE_LE_RESOLVING_LIST to be defined 1336 */ 1337 1338 /** 1339 * @brief Load LE Device DB entries into Controller Resolving List to allow filtering on 1340 * bonded devies with resolvable private addresses 1341 * @return EROOR_CODE_SUCCESS if supported by Controller 1342 */ 1343 uint8_t gap_load_resolving_list_from_le_device_db(void); 1344 1345 /** 1346 * @brief Get local persistent IRK 1347 */ 1348 const uint8_t * gap_get_persistent_irk(void); 1349 1350 /* API_END*/ 1351 1352 #if defined __cplusplus 1353 } 1354 #endif 1355 1356 #endif // GAP_H 1357