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