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