1 /* 2 * Copyright (C) 2014 BlueKitchen GmbH 3 * 4 * Redistribution and use in source and binary forms, with or without 5 * modification, are permitted provided that the following conditions 6 * are met: 7 * 8 * 1. Redistributions of source code must retain the above copyright 9 * notice, this list of conditions and the following disclaimer. 10 * 2. Redistributions in binary form must reproduce the above copyright 11 * notice, this list of conditions and the following disclaimer in the 12 * documentation and/or other materials provided with the distribution. 13 * 3. Neither the name of the copyright holders nor the names of 14 * contributors may be used to endorse or promote products derived 15 * from this software without specific prior written permission. 16 * 4. Any redistribution, use, or modification is done solely for 17 * personal benefit and not for any commercial purpose or for 18 * monetary gain. 19 * 20 * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21 * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23 * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 24 * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25 * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26 * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27 * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28 * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30 * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31 * SUCH DAMAGE. 32 * 33 * Please inquire about commercial licensing options at 34 * [email protected] 35 * 36 */ 37 38 #ifndef GAP_H 39 #define GAP_H 40 41 #if defined __cplusplus 42 extern "C" { 43 #endif 44 45 #include "btstack_defines.h" 46 #include "btstack_util.h" 47 #include "classic/btstack_link_key_db.h" 48 49 typedef enum { 50 51 // MITM protection not required 52 // No encryption required 53 // No user interaction required 54 LEVEL_0 = 0, 55 56 // MITM protection not required 57 // No encryption required 58 // Minimal user interaction desired 59 LEVEL_1, 60 61 // MITM protection not required 62 // Encryption required 63 LEVEL_2, 64 65 // MITM protection required 66 // Encryption required 67 // User interaction acceptable 68 LEVEL_3, 69 70 // MITM protection required 71 // Encryption required 72 // 128-bit equivalent strength for link and encryption keys required (P-192 is not enough) 73 // User interaction acceptable 74 LEVEL_4, 75 } gap_security_level_t; 76 77 typedef enum { 78 GAP_SECURITY_NONE, 79 GAP_SECUIRTY_ENCRYPTED, // SSP: JUST WORKS 80 GAP_SECURITY_AUTHENTICATED, // SSP: numeric comparison, passkey, OOB 81 // GAP_SECURITY_AUTHORIZED 82 } gap_security_state; 83 84 typedef enum { 85 GAP_CONNECTION_INVALID, 86 GAP_CONNECTION_ACL, 87 GAP_CONNECTION_SCO, 88 GAP_CONNECTION_LE 89 } gap_connection_type_t; 90 91 typedef struct le_connection_parameter_range{ 92 uint16_t le_conn_interval_min; 93 uint16_t le_conn_interval_max; 94 uint16_t le_conn_latency_min; 95 uint16_t le_conn_latency_max; 96 uint16_t le_supervision_timeout_min; 97 uint16_t le_supervision_timeout_max; 98 } le_connection_parameter_range_t; 99 100 typedef enum { 101 GAP_RANDOM_ADDRESS_TYPE_OFF = 0, 102 GAP_RANDOM_ADDRESS_TYPE_STATIC, 103 GAP_RANDOM_ADDRESS_NON_RESOLVABLE, 104 GAP_RANDOM_ADDRESS_RESOLVABLE, 105 } gap_random_address_type_t; 106 107 // Authorization state 108 typedef enum { 109 AUTHORIZATION_UNKNOWN, 110 AUTHORIZATION_PENDING, 111 AUTHORIZATION_DECLINED, 112 AUTHORIZATION_GRANTED 113 } authorization_state_t; 114 115 116 /* API_START */ 117 118 // Classic + LE 119 120 /** 121 * @brief Disconnect connection with handle 122 * @param handle 123 */ 124 uint8_t gap_disconnect(hci_con_handle_t handle); 125 126 /** 127 * @brief Get connection type 128 * @param con_handle 129 * @result connection_type 130 */ 131 gap_connection_type_t gap_get_connection_type(hci_con_handle_t connection_handle); 132 133 // Classic 134 135 /** 136 * @brief Sets local name. 137 * @note has to be done before stack starts up 138 * @note Default name is 'BTstack 00:00:00:00:00:00' 139 * @note '00:00:00:00:00:00' in local_name will be replaced with actual bd addr 140 * @param name is not copied, make sure memory is accessible during stack startup 141 */ 142 void gap_set_local_name(const char * local_name); 143 144 /** 145 * @brief Set Extended Inquiry Response data 146 * @note has to be done before stack starts up 147 * @note If not set, local name will be used for EIR data (see gap_set_local_name) 148 * @note '00:00:00:00:00:00' in local_name will be replaced with actual bd addr 149 * @param eir_data size 240 bytes, is not copied make sure memory is accessible during stack startup 150 */ 151 void gap_set_extended_inquiry_response(const uint8_t * data); 152 153 /** 154 * @brief Set class of device that will be set during Bluetooth init. 155 * @note has to be done before stack starts up 156 */ 157 void gap_set_class_of_device(uint32_t class_of_device); 158 159 /** 160 * @brief Set default link policy settings for all classic ACL links 161 * @param default_link_policy_settings - see LM_LINK_POLICY_* in bluetooth.h 162 * @note common value: LM_LINK_POLICY_ENABLE_ROLE_SWITCH | LM_LINK_POLICY_ENABLE_SNIFF_MODE to enable role switch and sniff mode 163 * @note has to be done before stack starts up 164 */ 165 void gap_set_default_link_policy_settings(uint16_t default_link_policy_settings); 166 167 /** 168 * @brief Enable/disable bonding. Default is enabled. 169 * @param enabled 170 */ 171 void gap_set_bondable_mode(int enabled); 172 173 /** 174 * @brief Get bondable mode. 175 * @return 1 if bondable 176 */ 177 int gap_get_bondable_mode(void); 178 179 /* Configure Secure Simple Pairing */ 180 181 /** 182 * @brief Enable will enable SSP during init. 183 */ 184 void gap_ssp_set_enable(int enable); 185 186 /** 187 * @brief Set IO Capability. BTstack will return capability to SSP requests 188 */ 189 void gap_ssp_set_io_capability(int ssp_io_capability); 190 191 /** 192 * @brief Set Authentication Requirements using during SSP 193 */ 194 void gap_ssp_set_authentication_requirement(int authentication_requirement); 195 196 /** 197 * @brief If set, BTstack will confirm a numeric comparison and enter '000000' if requested. 198 */ 199 void gap_ssp_set_auto_accept(int auto_accept); 200 201 /** 202 * @brief Set required encryption key size for GAP Levels 1-3 on ccassic connections. Default: 16 bytes 203 * @param encryption_key_size in bytes. Valid 7..16 204 */ 205 void gap_set_required_encryption_key_size(uint8_t encryption_key_size); 206 207 /** 208 * @brief Start dedicated bonding with device. Disconnect after bonding. 209 * @param device 210 * @param request MITM protection 211 * @return error, if max num acl connections active 212 * @result GAP_DEDICATED_BONDING_COMPLETE 213 */ 214 int gap_dedicated_bonding(bd_addr_t device, int mitm_protection_required); 215 216 gap_security_level_t gap_security_level_for_link_key_type(link_key_type_t link_key_type); 217 218 /** 219 * @brief map link keys to secure connection yes/no 220 */ 221 int gap_secure_connection_for_link_key_type(link_key_type_t link_key_type); 222 223 /** 224 * @brief map link keys to authenticated 225 */ 226 int gap_authenticated_for_link_key_type(link_key_type_t link_key_type); 227 228 gap_security_level_t gap_security_level(hci_con_handle_t con_handle); 229 230 void gap_request_security_level(hci_con_handle_t con_handle, gap_security_level_t level); 231 232 int gap_mitm_protection_required_for_security_level(gap_security_level_t level); 233 234 // LE 235 236 /** 237 * @brief Set parameters for LE Scan 238 */ 239 void gap_set_scan_parameters(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window); 240 241 /** 242 * @brief Start LE Scan 243 */ 244 void gap_start_scan(void); 245 246 /** 247 * @brief Stop LE Scan 248 */ 249 void gap_stop_scan(void); 250 251 /** 252 * @brief Enable privacy by using random addresses 253 * @param random_address_type to use (incl. OFF) 254 */ 255 void gap_random_address_set_mode(gap_random_address_type_t random_address_type); 256 257 /** 258 * @brief Get privacy mode 259 */ 260 gap_random_address_type_t gap_random_address_get_mode(void); 261 262 /** 263 * @brief Sets update period for random address 264 * @param period_ms in ms 265 */ 266 void gap_random_address_set_update_period(int period_ms); 267 268 /** 269 * @brief Sets a fixed random address for advertising 270 * @param addr 271 * @note Sets random address mode to type off 272 */ 273 void gap_random_address_set(bd_addr_t addr); 274 275 /** 276 * @brief Set Advertisement Data 277 * @param advertising_data_length 278 * @param advertising_data (max 31 octets) 279 * @note data is not copied, pointer has to stay valid 280 * @note '00:00:00:00:00:00' in advertising_data will be replaced with actual bd addr 281 */ 282 void gap_advertisements_set_data(uint8_t advertising_data_length, uint8_t * advertising_data); 283 284 /** 285 * @brief Set Advertisement Paramters 286 * @param adv_int_min 287 * @param adv_int_max 288 * @param adv_type 289 * @param direct_address_type 290 * @param direct_address 291 * @param channel_map 292 * @param filter_policy 293 * @note own_address_type is used from gap_random_address_set_mode 294 */ 295 void gap_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 296 uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy); 297 298 /** 299 * @brief Enable/Disable Advertisements. OFF by default. 300 * @param enabled 301 */ 302 void gap_advertisements_enable(int enabled); 303 304 /** 305 * @brief Set Scan Response Data 306 * 307 * @note For scan response data, scannable undirected advertising (ADV_SCAN_IND) need to be used 308 * 309 * @param advertising_data_length 310 * @param advertising_data (max 31 octets) 311 * @note data is not copied, pointer has to stay valid 312 * @note '00:00:00:00:00:00' in scan_response_data will be replaced with actual bd addr 313 */ 314 void gap_scan_response_set_data(uint8_t scan_response_data_length, uint8_t * scan_response_data); 315 316 /** 317 * @brief Set connection parameters for outgoing connections 318 * @param conn_scan_interval (unit: 0.625 msec), default: 60 ms 319 * @param conn_scan_window (unit: 0.625 msec), default: 30 ms 320 * @param conn_interval_min (unit: 1.25ms), default: 10 ms 321 * @param conn_interval_max (unit: 1.25ms), default: 30 ms 322 * @param conn_latency, default: 4 323 * @param supervision_timeout (unit: 10ms), default: 720 ms 324 * @param min_ce_length (unit: 0.625ms), default: 10 ms 325 * @param max_ce_length (unit: 0.625ms), default: 30 ms 326 */ 327 void gap_set_connection_parameters(uint16_t conn_scan_interval, uint16_t conn_scan_window, 328 uint16_t conn_interval_min, uint16_t conn_interval_max, uint16_t conn_latency, 329 uint16_t supervision_timeout, uint16_t min_ce_length, uint16_t max_ce_length); 330 331 /** 332 * @brief Request an update of the connection parameter for a given LE connection 333 * @param handle 334 * @param conn_interval_min (unit: 1.25ms) 335 * @param conn_interval_max (unit: 1.25ms) 336 * @param conn_latency 337 * @param supervision_timeout (unit: 10ms) 338 * @returns 0 if ok 339 */ 340 int gap_request_connection_parameter_update(hci_con_handle_t con_handle, uint16_t conn_interval_min, 341 uint16_t conn_interval_max, uint16_t conn_latency, uint16_t supervision_timeout); 342 343 /** 344 * @brief Updates the connection parameters for a given LE connection 345 * @param handle 346 * @param conn_interval_min (unit: 1.25ms) 347 * @param conn_interval_max (unit: 1.25ms) 348 * @param conn_latency 349 * @param supervision_timeout (unit: 10ms) 350 * @returns 0 if ok 351 */ 352 int gap_update_connection_parameters(hci_con_handle_t con_handle, uint16_t conn_interval_min, 353 uint16_t conn_interval_max, uint16_t conn_latency, uint16_t supervision_timeout); 354 355 /** 356 * @brief Set accepted connection parameter range 357 * @param range 358 */ 359 void gap_get_connection_parameter_range(le_connection_parameter_range_t * range); 360 361 /** 362 * @brief Get accepted connection parameter range 363 * @param range 364 */ 365 void gap_set_connection_parameter_range(le_connection_parameter_range_t * range); 366 367 /** 368 * @brief Test if connection parameters are inside in existing rage 369 * @param conn_interval_min (unit: 1.25ms) 370 * @param conn_interval_max (unit: 1.25ms) 371 * @param conn_latency 372 * @param supervision_timeout (unit: 10ms) 373 * @returns 1 if included 374 */ 375 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); 376 377 /** 378 * @brief Set max number of connections in LE Peripheral role (if Bluetooth Controller supports it) 379 * @note: default: 1 380 * @param max_peripheral_connections 381 */ 382 void gap_set_max_number_peripheral_connections(int max_peripheral_connections); 383 384 /** 385 * @brief Connect to remote LE device 386 */ 387 uint8_t gap_connect(bd_addr_t addr, bd_addr_type_t addr_type); 388 389 /** 390 * @brief Cancel connection process initiated by gap_connect 391 */ 392 uint8_t gap_connect_cancel(void); 393 394 /** 395 * @brief Auto Connection Establishment - Start Connecting to device 396 * @param address_typ 397 * @param address 398 * @returns 0 if ok 399 */ 400 int gap_auto_connection_start(bd_addr_type_t address_typ, bd_addr_t address); 401 402 /** 403 * @brief Auto Connection Establishment - Stop Connecting to device 404 * @param address_typ 405 * @param address 406 * @returns 0 if ok 407 */ 408 int gap_auto_connection_stop(bd_addr_type_t address_typ, bd_addr_t address); 409 410 /** 411 * @brief Auto Connection Establishment - Stop everything 412 * @note Convenience function to stop all active auto connection attempts 413 */ 414 void gap_auto_connection_stop_all(void); 415 416 /** 417 * @brief Set LE PHY 418 * @param con_handle 419 * @param all_phys 0 = set rx/tx, 1 = set only rx, 2 = set only tx 420 * @param tx_phys 1 = 1M, 2 = 2M, 4 = Coded 421 * @param rx_phys 1 = 1M, 2 = 2M, 4 = Coded 422 * @param phy_options 0 = no preferred coding for Coded, 1 = S=2 coding (500 kbit), 2 = S=8 coding (125 kbit) 423 * @returns 0 if ok 424 */ 425 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); 426 427 /** 428 * @brief Get connection interval 429 * @return connection interval, otherwise 0 if error 430 */ 431 uint16_t gap_le_connection_interval(hci_con_handle_t connection_handle); 432 433 /** 434 * 435 * @brief Get encryption key size. 436 * @param con_handle 437 * @return 0 if not encrypted, 7-16 otherwise 438 */ 439 int gap_encryption_key_size(hci_con_handle_t con_handle); 440 441 /** 442 * @brief Get authentication property. 443 * @param con_handle 444 * @return 1 if bonded with OOB/Passkey (AND MITM protection) 445 */ 446 int gap_authenticated(hci_con_handle_t con_handle); 447 448 /** 449 * @brief Get secure connection property 450 * @param con_handle 451 * @return 1 if bonded usiung LE Secure Connections 452 */ 453 int gap_secure_connection(hci_con_handle_t con_handle); 454 455 /** 456 * @brief Queries authorization state. 457 * @param con_handle 458 * @return authorization_state for the current session 459 */ 460 authorization_state_t gap_authorization_state(hci_con_handle_t con_handle); 461 462 // Classic 463 464 /** 465 * @brief Override page scan mode. Page scan mode enabled by l2cap when services are registered 466 * @note Might be used to reduce power consumption while Bluetooth module stays powered but no (new) 467 * connections are expected 468 */ 469 void gap_connectable_control(uint8_t enable); 470 471 /** 472 * @brief Allows to control if device is discoverable. OFF by default. 473 */ 474 void gap_discoverable_control(uint8_t enable); 475 476 /** 477 * @brief Gets local address. 478 */ 479 void gap_local_bd_addr(bd_addr_t address_buffer); 480 481 /** 482 * @brief Deletes link key for remote device with baseband address. 483 * @param addr 484 */ 485 void gap_drop_link_key_for_bd_addr(bd_addr_t addr); 486 487 /** 488 * @brief Delete all stored link keys 489 */ 490 void gap_delete_all_link_keys(void); 491 492 /** 493 * @brief Store link key for remote device with baseband address 494 * @param addr 495 * @param link_key 496 * @param link_key_type 497 */ 498 void gap_store_link_key_for_bd_addr(bd_addr_t addr, link_key_t link_key, link_key_type_t type); 499 500 /** 501 * @brief Setup Link Key iterator 502 * @param it 503 * @returns 1 on success 504 */ 505 int gap_link_key_iterator_init(btstack_link_key_iterator_t * it); 506 507 /** 508 * @brief Get next Link Key 509 * @param it 510 * @brief addr 511 * @brief link_key 512 * @brief type of link key 513 * @returns 1, if valid link key found 514 */ 515 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); 516 517 /** 518 * @brief Frees resources allocated by iterator_init 519 * @note Must be called after iteration to free resources 520 * @param it 521 */ 522 void gap_link_key_iterator_done(btstack_link_key_iterator_t * it); 523 524 /** 525 * @brief Start GAP Classic Inquiry 526 * @param duration in 1.28s units 527 * @return 0 if ok 528 * @events: GAP_EVENT_INQUIRY_RESULT, GAP_EVENT_INQUIRY_COMPLETE 529 */ 530 int gap_inquiry_start(uint8_t duration_in_1280ms_units); 531 532 /** 533 * @brief Stop GAP Classic Inquiry 534 * @brief Stop GAP Classic Inquiry 535 * @returns 0 if ok 536 * @events: GAP_EVENT_INQUIRY_COMPLETE 537 */ 538 int gap_inquiry_stop(void); 539 540 /** 541 * @brief Remote Name Request 542 * @param addr 543 * @param page_scan_repetition_mode 544 * @param clock_offset only used when bit 15 is set - pass 0 if not known 545 * @events: HCI_EVENT_REMOTE_NAME_REQUEST_COMPLETE 546 */ 547 int gap_remote_name_request(bd_addr_t addr, uint8_t page_scan_repetition_mode, uint16_t clock_offset); 548 549 /** 550 * @brief Legacy Pairing Pin Code Response 551 * @param addr 552 * @param pin 553 * @return 0 if ok 554 */ 555 int gap_pin_code_response(bd_addr_t addr, const char * pin); 556 557 /** 558 * @brief Abort Legacy Pairing 559 * @param addr 560 * @param pin 561 * @return 0 if ok 562 */ 563 int gap_pin_code_negative(bd_addr_t addr); 564 565 /** 566 * @brief SSP Passkey Response 567 * @param addr 568 * @param passkey [0..999999] 569 * @return 0 if ok 570 */ 571 int gap_ssp_passkey_response(bd_addr_t addr, uint32_t passkey); 572 573 /** 574 * @brief Abort SSP Passkey Entry/Pairing 575 * @param addr 576 * @param pin 577 * @return 0 if ok 578 */ 579 int gap_ssp_passkey_negative(bd_addr_t addr); 580 581 /** 582 * @brief Accept SSP Numeric Comparison 583 * @param addr 584 * @param passkey 585 * @return 0 if ok 586 */ 587 int gap_ssp_confirmation_response(bd_addr_t addr); 588 589 /** 590 * @brief Abort SSP Numeric Comparison/Pairing 591 * @param addr 592 * @param pin 593 * @return 0 if ok 594 */ 595 int gap_ssp_confirmation_negative(bd_addr_t addr); 596 597 /** 598 * @brief Enter Sniff mode 599 * @param con_handle 600 * @param sniff_min_interval range: 0x0002 to 0xFFFE; only even values are valid, Time = N * 0.625 ms 601 * @param sniff_max_interval range: 0x0002 to 0xFFFE; only even values are valid, Time = N * 0.625 ms 602 * @param sniff_attempt Number of Baseband receive slots for sniff attempt. 603 * @param sniff_timeout Number of Baseband receive slots for sniff timeout. 604 @ @return 0 if ok 605 */ 606 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); 607 608 /** 609 * @brief Exit Sniff mode 610 * @param con_handle 611 @ @return 0 if ok 612 */ 613 uint8_t gap_sniff_mode_exit(hci_con_handle_t con_handle); 614 615 // LE 616 617 /** 618 * @brief Get own addr type and address used for LE 619 */ 620 void gap_le_get_own_address(uint8_t * addr_type, bd_addr_t addr); 621 622 623 /** 624 * @brief Get state of connection re-encryptiong for bonded devices when in central role 625 * @note used by gatt_client and att_server to wait for re-encryption 626 * @param con_handle 627 * @return 1 if security setup is active 628 */ 629 int gap_reconnect_security_setup_active(hci_con_handle_t con_handle); 630 631 632 /* API_END*/ 633 634 #if defined __cplusplus 635 } 636 #endif 637 638 #endif // GAP_H 639