1458bf4e8S[email protected] /* 2a0c35809S[email protected] * Copyright (C) 2014 BlueKitchen GmbH 3458bf4e8S[email protected] * 4458bf4e8S[email protected] * Redistribution and use in source and binary forms, with or without 5458bf4e8S[email protected] * modification, are permitted provided that the following conditions 6458bf4e8S[email protected] * are met: 7458bf4e8S[email protected] * 8458bf4e8S[email protected] * 1. Redistributions of source code must retain the above copyright 9458bf4e8S[email protected] * notice, this list of conditions and the following disclaimer. 10458bf4e8S[email protected] * 2. Redistributions in binary form must reproduce the above copyright 11458bf4e8S[email protected] * notice, this list of conditions and the following disclaimer in the 12458bf4e8S[email protected] * documentation and/or other materials provided with the distribution. 13458bf4e8S[email protected] * 3. Neither the name of the copyright holders nor the names of 14458bf4e8S[email protected] * contributors may be used to endorse or promote products derived 15458bf4e8S[email protected] * from this software without specific prior written permission. 16458bf4e8S[email protected] * 4. Any redistribution, use, or modification is done solely for 17458bf4e8S[email protected] * personal benefit and not for any commercial purpose or for 18458bf4e8S[email protected] * monetary gain. 19458bf4e8S[email protected] * 20a0c35809S[email protected] * THIS SOFTWARE IS PROVIDED BY BLUEKITCHEN GMBH AND CONTRIBUTORS 21458bf4e8S[email protected] * ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 22458bf4e8S[email protected] * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 23458bf4e8S[email protected] * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL MATTHIAS 24458bf4e8S[email protected] * RINGWALD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 25458bf4e8S[email protected] * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 26458bf4e8S[email protected] * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS 27458bf4e8S[email protected] * OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED 28458bf4e8S[email protected] * AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 29458bf4e8S[email protected] * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF 30458bf4e8S[email protected] * THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 31458bf4e8S[email protected] * SUCH DAMAGE. 32458bf4e8S[email protected] * 33a0c35809S[email protected] * Please inquire about commercial licensing options at 34a0c35809S[email protected] * [email protected] 35458bf4e8S[email protected] * 36458bf4e8S[email protected] */ 37458bf4e8S[email protected] 3880e33422SMatthias Ringwald #ifndef GAP_H 3980e33422SMatthias Ringwald #define GAP_H 40458bf4e8S[email protected] 41458bf4e8S[email protected] #if defined __cplusplus 42458bf4e8S[email protected] extern "C" { 43458bf4e8S[email protected] #endif 44458bf4e8S[email protected] 45f7a05cdaSMatthias Ringwald #include "btstack_defines.h" 46eb886013SMatthias Ringwald #include "btstack_util.h" 471b6fb31bSMatthias Ringwald #include "classic/btstack_link_key_db.h" 48f7a05cdaSMatthias Ringwald 49cb230b9dS[email protected] typedef enum { 50cb230b9dS[email protected] 51cb230b9dS[email protected] // MITM protection not required 52cb230b9dS[email protected] // No encryption required 53cb230b9dS[email protected] // No user interaction required 54cb230b9dS[email protected] LEVEL_0 = 0, 55cb230b9dS[email protected] 56cb230b9dS[email protected] // MITM protection not required 57cb230b9dS[email protected] // No encryption required 58cb230b9dS[email protected] // Minimal user interaction desired 59cb230b9dS[email protected] LEVEL_1, 60cb230b9dS[email protected] 61cb230b9dS[email protected] // MITM protection not required 62cb230b9dS[email protected] // Encryption required 63cb230b9dS[email protected] LEVEL_2, 64cb230b9dS[email protected] 65cb230b9dS[email protected] // MITM protection required 66cb230b9dS[email protected] // Encryption required 67cb230b9dS[email protected] // User interaction acceptable 68cb230b9dS[email protected] LEVEL_3, 69cb230b9dS[email protected] 70cb230b9dS[email protected] // MITM protection required 71cb230b9dS[email protected] // Encryption required 723c68dfa9S[email protected] // 128-bit equivalent strength for link and encryption keys required (P-192 is not enough) 73cb230b9dS[email protected] // User interaction acceptable 74cb230b9dS[email protected] LEVEL_4, 75cb230b9dS[email protected] } gap_security_level_t; 76cb230b9dS[email protected] 7734f9eab8S[email protected] typedef enum { 7834f9eab8S[email protected] GAP_SECURITY_NONE, 7934f9eab8S[email protected] GAP_SECUIRTY_ENCRYPTED, // SSP: JUST WORKS 8034f9eab8S[email protected] GAP_SECURITY_AUTHENTICATED, // SSP: numeric comparison, passkey, OOB 8134f9eab8S[email protected] // GAP_SECURITY_AUTHORIZED 823c68dfa9S[email protected] } gap_security_state; 8334f9eab8S[email protected] 84a1bf5ae7SMatthias Ringwald typedef enum { 85a1bf5ae7SMatthias Ringwald GAP_CONNECTION_INVALID, 86a1bf5ae7SMatthias Ringwald GAP_CONNECTION_ACL, 87a1bf5ae7SMatthias Ringwald GAP_CONNECTION_SCO, 88a1bf5ae7SMatthias Ringwald GAP_CONNECTION_LE 89a1bf5ae7SMatthias Ringwald } gap_connection_type_t; 90a1bf5ae7SMatthias Ringwald 916e364deaSMatthias Ringwald typedef struct le_connection_parameter_range{ 926e364deaSMatthias Ringwald uint16_t le_conn_interval_min; 936e364deaSMatthias Ringwald uint16_t le_conn_interval_max; 946e364deaSMatthias Ringwald uint16_t le_conn_latency_min; 956e364deaSMatthias Ringwald uint16_t le_conn_latency_max; 966e364deaSMatthias Ringwald uint16_t le_supervision_timeout_min; 976e364deaSMatthias Ringwald uint16_t le_supervision_timeout_max; 986e364deaSMatthias Ringwald } le_connection_parameter_range_t; 996e364deaSMatthias Ringwald 1006e364deaSMatthias Ringwald typedef enum { 1016e364deaSMatthias Ringwald GAP_RANDOM_ADDRESS_TYPE_OFF = 0, 1028f57b085SMatthias Ringwald GAP_RANDOM_ADDRESS_TYPE_STATIC, 1036e364deaSMatthias Ringwald GAP_RANDOM_ADDRESS_NON_RESOLVABLE, 1046e364deaSMatthias Ringwald GAP_RANDOM_ADDRESS_RESOLVABLE, 1056e364deaSMatthias Ringwald } gap_random_address_type_t; 1066e364deaSMatthias Ringwald 1079c6e867eSMatthias Ringwald // Authorization state 1089c6e867eSMatthias Ringwald typedef enum { 1099c6e867eSMatthias Ringwald AUTHORIZATION_UNKNOWN, 1109c6e867eSMatthias Ringwald AUTHORIZATION_PENDING, 1119c6e867eSMatthias Ringwald AUTHORIZATION_DECLINED, 1129c6e867eSMatthias Ringwald AUTHORIZATION_GRANTED 1139c6e867eSMatthias Ringwald } authorization_state_t; 1149c6e867eSMatthias Ringwald 1159c6e867eSMatthias Ringwald 1163de95307SMilanka Ringwald /* API_START */ 1173de95307SMilanka Ringwald 118d8e8f12aSMatthias Ringwald // Classic + LE 119d8e8f12aSMatthias Ringwald 120d8e8f12aSMatthias Ringwald /** 121d8e8f12aSMatthias Ringwald * @brief Disconnect connection with handle 122d8e8f12aSMatthias Ringwald * @param handle 123d8e8f12aSMatthias Ringwald */ 124d8e8f12aSMatthias Ringwald uint8_t gap_disconnect(hci_con_handle_t handle); 125d8e8f12aSMatthias Ringwald 126d8e8f12aSMatthias Ringwald /** 127d8e8f12aSMatthias Ringwald * @brief Get connection type 128d8e8f12aSMatthias Ringwald * @param con_handle 129d8e8f12aSMatthias Ringwald * @result connection_type 130d8e8f12aSMatthias Ringwald */ 131d8e8f12aSMatthias Ringwald gap_connection_type_t gap_get_connection_type(hci_con_handle_t connection_handle); 132d8e8f12aSMatthias Ringwald 1332dceb1d6SMatthias Ringwald /** 1342dceb1d6SMatthias Ringwald * @brief Get HCI connection role 1352dceb1d6SMatthias Ringwald * @param con_handle 1362dceb1d6SMatthias Ringwald * @result hci_role_t HCI_ROLE_MASTER / HCI_ROLE_SLAVE / HCI_ROLE_INVALID (if connection does not exist) 1372dceb1d6SMatthias Ringwald */ 1382dceb1d6SMatthias Ringwald hci_role_t gap_get_role(hci_con_handle_t connection_handle); 1392dceb1d6SMatthias Ringwald 140d8e8f12aSMatthias Ringwald // Classic 141d8e8f12aSMatthias Ringwald 142d8e8f12aSMatthias Ringwald /** 14388a03c8dSMatthias Ringwald * @brief Request role switch 14488a03c8dSMatthias Ringwald * @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 14588a03c8dSMatthias Ringwald * @param addr 14688a03c8dSMatthias Ringwald * @param hci_role_t HCI_ROLE_MASTER / HCI_ROLE_SLAVE 14788a03c8dSMatthias Ringwald * @result status 14888a03c8dSMatthias Ringwald */ 14988a03c8dSMatthias Ringwald uint8_t gap_request_role(bd_addr_t addr, hci_role_t role); 15088a03c8dSMatthias Ringwald 15188a03c8dSMatthias Ringwald /** 152d8e8f12aSMatthias Ringwald * @brief Sets local name. 153d8e8f12aSMatthias Ringwald * @note has to be done before stack starts up 154ad0d1108SMatthias Ringwald * @note Default name is 'BTstack 00:00:00:00:00:00' 155f868b059SMatthias Ringwald * @note '00:00:00:00:00:00' in local_name will be replaced with actual bd addr 156ad0d1108SMatthias Ringwald * @param name is not copied, make sure memory is accessible during stack startup 157d8e8f12aSMatthias Ringwald */ 158d8e8f12aSMatthias Ringwald void gap_set_local_name(const char * local_name); 159d8e8f12aSMatthias Ringwald 160458bf4e8S[email protected] /** 161ff00ed1cSMatthias Ringwald * @brief Set Extended Inquiry Response data 162ff00ed1cSMatthias Ringwald * @note has to be done before stack starts up 163ad0d1108SMatthias Ringwald * @note If not set, local name will be used for EIR data (see gap_set_local_name) 164f868b059SMatthias Ringwald * @note '00:00:00:00:00:00' in local_name will be replaced with actual bd addr 165a8c4e5adSMatthias Ringwald * @param eir_data size HCI_EXTENDED_INQUIRY_RESPONSE_DATA_LEN (240) bytes, is not copied make sure memory is accessible during stack startup 166ff00ed1cSMatthias Ringwald */ 167ff00ed1cSMatthias Ringwald void gap_set_extended_inquiry_response(const uint8_t * data); 168ff00ed1cSMatthias Ringwald 169ff00ed1cSMatthias Ringwald /** 17060b9e82fSMatthias Ringwald * @brief Set class of device that will be set during Bluetooth init. 17160b9e82fSMatthias Ringwald * @note has to be done before stack starts up 17260b9e82fSMatthias Ringwald */ 17360b9e82fSMatthias Ringwald void gap_set_class_of_device(uint32_t class_of_device); 17460b9e82fSMatthias Ringwald 17560b9e82fSMatthias Ringwald /** 176c33e56d3SMatthias Ringwald * @brief Set default link policy settings for all classic ACL links 177c33e56d3SMatthias Ringwald * @param default_link_policy_settings - see LM_LINK_POLICY_* in bluetooth.h 178c33e56d3SMatthias Ringwald * @note common value: LM_LINK_POLICY_ENABLE_ROLE_SWITCH | LM_LINK_POLICY_ENABLE_SNIFF_MODE to enable role switch and sniff mode 179c33e56d3SMatthias Ringwald * @note has to be done before stack starts up 180c33e56d3SMatthias Ringwald */ 181c33e56d3SMatthias Ringwald void gap_set_default_link_policy_settings(uint16_t default_link_policy_settings); 182c33e56d3SMatthias Ringwald 183c33e56d3SMatthias Ringwald /** 184b4eb4420SMatthias Ringwald * @brief Set Allow Role Switch param for outgoing classic ACL links 185b4eb4420SMatthias Ringwald * @param allow_role_switch - true: allow remote device to request role switch, false: stay master 186b4eb4420SMatthias Ringwald */ 187b4eb4420SMatthias Ringwald void gap_set_allow_role_switch(bool allow_role_switch); 188b4eb4420SMatthias Ringwald 189b4eb4420SMatthias Ringwald /** 190e6c51921SMatthias Ringwald * @brief Set link supervision timeout for outgoing classic ACL links 1910c3eb48dSMatthias Ringwald * @param default_link_supervision_timeout * 0.625 ms, default 0x7d00 = 20 seconds 1920c3eb48dSMatthias Ringwald */ 1930c3eb48dSMatthias Ringwald void gap_set_link_supervision_timeout(uint16_t link_supervision_timeout); 1940c3eb48dSMatthias Ringwald 1950c3eb48dSMatthias Ringwald /** 1963de95307SMilanka Ringwald * @brief Enable/disable bonding. Default is enabled. 1973de95307SMilanka Ringwald * @param enabled 198458bf4e8S[email protected] */ 199458bf4e8S[email protected] void gap_set_bondable_mode(int enabled); 20034d2123cS[email protected] 201ad83dc6aS[email protected] /** 202671d15e6SMatthias Ringwald * @brief Get bondable mode. 203671d15e6SMatthias Ringwald * @return 1 if bondable 204671d15e6SMatthias Ringwald */ 205671d15e6SMatthias Ringwald int gap_get_bondable_mode(void); 206671d15e6SMatthias Ringwald 20707e010b6SMilanka Ringwald /** 20878315a58SMatthias Ringwald * @brief Set security level for all outgoing and incoming connections. Default: LEVEL_2 20978315a58SMatthias Ringwald * @param security_level 21078315a58SMatthias Ringwald * @note has to be called before services or profiles are initialized 21178315a58SMatthias Ringwald */ 21278315a58SMatthias Ringwald void gap_set_security_level(gap_security_level_t security_level); 21378315a58SMatthias Ringwald 21478315a58SMatthias Ringwald /** 21578315a58SMatthias Ringwald * @brief Get security level 21678315a58SMatthias Ringwald * @return security_level 21778315a58SMatthias Ringwald */ 21878315a58SMatthias Ringwald gap_security_level_t gap_get_security_level(void); 21978315a58SMatthias Ringwald 22078315a58SMatthias Ringwald /** 22107e010b6SMilanka Ringwald * @brief Register filter for rejecting classic connections. Callback will return 1 accept connection, 0 on reject. 22207e010b6SMilanka Ringwald */ 22307e010b6SMilanka Ringwald void gap_register_classic_connection_filter(int (*accept_callback)(bd_addr_t addr)); 22407e010b6SMilanka Ringwald 22515a95bd5SMatthias Ringwald /* Configure Secure Simple Pairing */ 22615a95bd5SMatthias Ringwald 22715a95bd5SMatthias Ringwald /** 2285d23aae8SMatthias Ringwald * @brief Enable will enable SSP during init. Default: true 22915a95bd5SMatthias Ringwald */ 23015a95bd5SMatthias Ringwald void gap_ssp_set_enable(int enable); 23115a95bd5SMatthias Ringwald 23215a95bd5SMatthias Ringwald /** 23315a95bd5SMatthias Ringwald * @brief Set IO Capability. BTstack will return capability to SSP requests 23415a95bd5SMatthias Ringwald */ 23515a95bd5SMatthias Ringwald void gap_ssp_set_io_capability(int ssp_io_capability); 23615a95bd5SMatthias Ringwald 23715a95bd5SMatthias Ringwald /** 23815a95bd5SMatthias Ringwald * @brief Set Authentication Requirements using during SSP 23915a95bd5SMatthias Ringwald */ 24015a95bd5SMatthias Ringwald void gap_ssp_set_authentication_requirement(int authentication_requirement); 24115a95bd5SMatthias Ringwald 24215a95bd5SMatthias Ringwald /** 2435d23aae8SMatthias Ringwald * @brief Enable/disable Secure Connections. Default: true if supported by Controller 2445d23aae8SMatthias Ringwald */ 2455d23aae8SMatthias Ringwald void gap_secure_connections_enable(bool enable); 2465d23aae8SMatthias Ringwald 2475d23aae8SMatthias Ringwald /** 24815a95bd5SMatthias Ringwald * @brief If set, BTstack will confirm a numeric comparison and enter '000000' if requested. 24915a95bd5SMatthias Ringwald */ 25015a95bd5SMatthias Ringwald void gap_ssp_set_auto_accept(int auto_accept); 25115a95bd5SMatthias Ringwald 252671d15e6SMatthias Ringwald /** 253170fafaeSMatthias Ringwald * @brief Set required encryption key size for GAP Levels 1-3 on ccassic connections. Default: 16 bytes 254170fafaeSMatthias Ringwald * @param encryption_key_size in bytes. Valid 7..16 255170fafaeSMatthias Ringwald */ 256170fafaeSMatthias Ringwald void gap_set_required_encryption_key_size(uint8_t encryption_key_size); 257170fafaeSMatthias Ringwald 258170fafaeSMatthias Ringwald /** 2593de95307SMilanka Ringwald * @brief Start dedicated bonding with device. Disconnect after bonding. 260ad83dc6aS[email protected] * @param device 261ad83dc6aS[email protected] * @param request MITM protection 2623de95307SMilanka Ringwald * @return error, if max num acl connections active 263ad83dc6aS[email protected] * @result GAP_DEDICATED_BONDING_COMPLETE 264ad83dc6aS[email protected] */ 265ad83dc6aS[email protected] int gap_dedicated_bonding(bd_addr_t device, int mitm_protection_required); 266ad83dc6aS[email protected] 26734d2123cS[email protected] gap_security_level_t gap_security_level_for_link_key_type(link_key_type_t link_key_type); 2688b35e16aSMatthias Ringwald 2698b35e16aSMatthias Ringwald /** 2708b35e16aSMatthias Ringwald * @brief map link keys to secure connection yes/no 2718b35e16aSMatthias Ringwald */ 2728b35e16aSMatthias Ringwald int gap_secure_connection_for_link_key_type(link_key_type_t link_key_type); 2738b35e16aSMatthias Ringwald 2748b35e16aSMatthias Ringwald /** 2758b35e16aSMatthias Ringwald * @brief map link keys to authenticated 2768b35e16aSMatthias Ringwald */ 2778b35e16aSMatthias Ringwald int gap_authenticated_for_link_key_type(link_key_type_t link_key_type); 2788b35e16aSMatthias Ringwald 279ad671560S[email protected] gap_security_level_t gap_security_level(hci_con_handle_t con_handle); 28034d2123cS[email protected] 281ad671560S[email protected] void gap_request_security_level(hci_con_handle_t con_handle, gap_security_level_t level); 282d8e8f12aSMatthias Ringwald 283106d6d11S[email protected] int gap_mitm_protection_required_for_security_level(gap_security_level_t level); 284458bf4e8S[email protected] 285d8e8f12aSMatthias Ringwald // LE 2868e618f72S[email protected] 287a1bf5ae7SMatthias Ringwald /** 288d8e8f12aSMatthias Ringwald * @brief Set parameters for LE Scan 289*5a1ca52eSMatthias Ringwald * @param scan_type 0 = passive, 1 = active 290*5a1ca52eSMatthias Ringwald * @param scan_interval range 0x0004..0x4000, unit 0.625 ms 291*5a1ca52eSMatthias Ringwald * @param scan_window range 0x0004..0x4000, unit 0.625 ms 292*5a1ca52eSMatthias Ringwald * @param scanning_filter_policy 0 = all devices, 1 = all from whitelist 293*5a1ca52eSMatthias Ringwald */ 294*5a1ca52eSMatthias Ringwald void gap_set_scan_params(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window, uint8_t scanning_filter_policy); 295*5a1ca52eSMatthias Ringwald 296*5a1ca52eSMatthias Ringwald /** 297*5a1ca52eSMatthias Ringwald * @brief Set parameters for LE Scan 298*5a1ca52eSMatthias Ringwald * @deprecated Use gap_set_scan_params instead 299a1bf5ae7SMatthias Ringwald */ 300d8e8f12aSMatthias Ringwald void gap_set_scan_parameters(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window); 301d8e8f12aSMatthias Ringwald 302d8e8f12aSMatthias Ringwald /** 303d8e8f12aSMatthias Ringwald * @brief Start LE Scan 304d8e8f12aSMatthias Ringwald */ 305d8e8f12aSMatthias Ringwald void gap_start_scan(void); 306d8e8f12aSMatthias Ringwald 307d8e8f12aSMatthias Ringwald /** 308d8e8f12aSMatthias Ringwald * @brief Stop LE Scan 309d8e8f12aSMatthias Ringwald */ 310d8e8f12aSMatthias Ringwald void gap_stop_scan(void); 311a1bf5ae7SMatthias Ringwald 312f7a05cdaSMatthias Ringwald /** 313f7a05cdaSMatthias Ringwald * @brief Enable privacy by using random addresses 314f7a05cdaSMatthias Ringwald * @param random_address_type to use (incl. OFF) 315f7a05cdaSMatthias Ringwald */ 316f7a05cdaSMatthias Ringwald void gap_random_address_set_mode(gap_random_address_type_t random_address_type); 317f7a05cdaSMatthias Ringwald 318f7a05cdaSMatthias Ringwald /** 319f7a05cdaSMatthias Ringwald * @brief Get privacy mode 320f7a05cdaSMatthias Ringwald */ 321f7a05cdaSMatthias Ringwald gap_random_address_type_t gap_random_address_get_mode(void); 322f7a05cdaSMatthias Ringwald 323f7a05cdaSMatthias Ringwald /** 324f7a05cdaSMatthias Ringwald * @brief Sets update period for random address 325f7a05cdaSMatthias Ringwald * @param period_ms in ms 326f7a05cdaSMatthias Ringwald */ 327f7a05cdaSMatthias Ringwald void gap_random_address_set_update_period(int period_ms); 328f7a05cdaSMatthias Ringwald 329f7a05cdaSMatthias Ringwald /** 3307e252622SMatthias Ringwald * @brief Sets a fixed random address for advertising 3317e252622SMatthias Ringwald * @param addr 3327e252622SMatthias Ringwald * @note Sets random address mode to type off 3337e252622SMatthias Ringwald */ 3347e252622SMatthias Ringwald void gap_random_address_set(bd_addr_t addr); 3357e252622SMatthias Ringwald 3367e252622SMatthias Ringwald /** 337f7a05cdaSMatthias Ringwald * @brief Set Advertisement Data 338f7a05cdaSMatthias Ringwald * @param advertising_data_length 339f7a05cdaSMatthias Ringwald * @param advertising_data (max 31 octets) 340f7a05cdaSMatthias Ringwald * @note data is not copied, pointer has to stay valid 341f868b059SMatthias Ringwald * @note '00:00:00:00:00:00' in advertising_data will be replaced with actual bd addr 342f7a05cdaSMatthias Ringwald */ 343f7a05cdaSMatthias Ringwald void gap_advertisements_set_data(uint8_t advertising_data_length, uint8_t * advertising_data); 344f7a05cdaSMatthias Ringwald 345f7a05cdaSMatthias Ringwald /** 346f7a05cdaSMatthias Ringwald * @brief Set Advertisement Paramters 347f7a05cdaSMatthias Ringwald * @param adv_int_min 348f7a05cdaSMatthias Ringwald * @param adv_int_max 349f7a05cdaSMatthias Ringwald * @param adv_type 350f7a05cdaSMatthias Ringwald * @param direct_address_type 351f7a05cdaSMatthias Ringwald * @param direct_address 352f7a05cdaSMatthias Ringwald * @param channel_map 353f7a05cdaSMatthias Ringwald * @param filter_policy 354f7a05cdaSMatthias Ringwald * @note own_address_type is used from gap_random_address_set_mode 355f7a05cdaSMatthias Ringwald */ 356f7a05cdaSMatthias Ringwald void gap_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 357f7a05cdaSMatthias Ringwald uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy); 358f7a05cdaSMatthias Ringwald 359f7a05cdaSMatthias Ringwald /** 360cb264910SMatthias Ringwald * @brief Enable/Disable Advertisements. OFF by default. 361f7a05cdaSMatthias Ringwald * @param enabled 362f7a05cdaSMatthias Ringwald */ 363f7a05cdaSMatthias Ringwald void gap_advertisements_enable(int enabled); 364501f56b3SMatthias Ringwald 365501f56b3SMatthias Ringwald /** 366501f56b3SMatthias Ringwald * @brief Set Scan Response Data 367501f56b3SMatthias Ringwald * 368501f56b3SMatthias Ringwald * @note For scan response data, scannable undirected advertising (ADV_SCAN_IND) need to be used 369501f56b3SMatthias Ringwald * 370501f56b3SMatthias Ringwald * @param advertising_data_length 371501f56b3SMatthias Ringwald * @param advertising_data (max 31 octets) 372501f56b3SMatthias Ringwald * @note data is not copied, pointer has to stay valid 373f868b059SMatthias Ringwald * @note '00:00:00:00:00:00' in scan_response_data will be replaced with actual bd addr 374501f56b3SMatthias Ringwald */ 375501f56b3SMatthias Ringwald void gap_scan_response_set_data(uint8_t scan_response_data_length, uint8_t * scan_response_data); 376501f56b3SMatthias Ringwald 377d8e8f12aSMatthias Ringwald /** 3786012052bSMatthias Ringwald * @brief Set connection parameters for outgoing connections 379cbe54ab2SJakob Krantz * @param conn_scan_interval (unit: 0.625 msec), default: 60 ms 380cbe54ab2SJakob Krantz * @param conn_scan_window (unit: 0.625 msec), default: 30 ms 3816012052bSMatthias Ringwald * @param conn_interval_min (unit: 1.25ms), default: 10 ms 3826012052bSMatthias Ringwald * @param conn_interval_max (unit: 1.25ms), default: 30 ms 3836012052bSMatthias Ringwald * @param conn_latency, default: 4 3846012052bSMatthias Ringwald * @param supervision_timeout (unit: 10ms), default: 720 ms 3856012052bSMatthias Ringwald * @param min_ce_length (unit: 0.625ms), default: 10 ms 3866012052bSMatthias Ringwald * @param max_ce_length (unit: 0.625ms), default: 30 ms 3876012052bSMatthias Ringwald */ 388cbe54ab2SJakob Krantz void gap_set_connection_parameters(uint16_t conn_scan_interval, uint16_t conn_scan_window, 389cbe54ab2SJakob Krantz uint16_t conn_interval_min, uint16_t conn_interval_max, uint16_t conn_latency, 390cbe54ab2SJakob Krantz uint16_t supervision_timeout, uint16_t min_ce_length, uint16_t max_ce_length); 3916012052bSMatthias Ringwald 3926012052bSMatthias Ringwald /** 393d8e8f12aSMatthias Ringwald * @brief Request an update of the connection parameter for a given LE connection 394d8e8f12aSMatthias Ringwald * @param handle 395d8e8f12aSMatthias Ringwald * @param conn_interval_min (unit: 1.25ms) 396d8e8f12aSMatthias Ringwald * @param conn_interval_max (unit: 1.25ms) 397d8e8f12aSMatthias Ringwald * @param conn_latency 398d8e8f12aSMatthias Ringwald * @param supervision_timeout (unit: 10ms) 399d8e8f12aSMatthias Ringwald * @returns 0 if ok 400d8e8f12aSMatthias Ringwald */ 401d8e8f12aSMatthias Ringwald int gap_request_connection_parameter_update(hci_con_handle_t con_handle, uint16_t conn_interval_min, 402d8e8f12aSMatthias Ringwald uint16_t conn_interval_max, uint16_t conn_latency, uint16_t supervision_timeout); 403d8e8f12aSMatthias Ringwald 404d8e8f12aSMatthias Ringwald /** 405d8e8f12aSMatthias Ringwald * @brief Updates the connection parameters for a given LE connection 406d8e8f12aSMatthias Ringwald * @param handle 407d8e8f12aSMatthias Ringwald * @param conn_interval_min (unit: 1.25ms) 408d8e8f12aSMatthias Ringwald * @param conn_interval_max (unit: 1.25ms) 409d8e8f12aSMatthias Ringwald * @param conn_latency 410d8e8f12aSMatthias Ringwald * @param supervision_timeout (unit: 10ms) 411d8e8f12aSMatthias Ringwald * @returns 0 if ok 412d8e8f12aSMatthias Ringwald */ 413d8e8f12aSMatthias Ringwald int gap_update_connection_parameters(hci_con_handle_t con_handle, uint16_t conn_interval_min, 414d8e8f12aSMatthias Ringwald uint16_t conn_interval_max, uint16_t conn_latency, uint16_t supervision_timeout); 415d8e8f12aSMatthias Ringwald 416d8e8f12aSMatthias Ringwald /** 417d8e8f12aSMatthias Ringwald * @brief Set accepted connection parameter range 418d8e8f12aSMatthias Ringwald * @param range 419d8e8f12aSMatthias Ringwald */ 4204ced4e8cSMatthias Ringwald void gap_get_connection_parameter_range(le_connection_parameter_range_t * range); 421d8e8f12aSMatthias Ringwald 422d8e8f12aSMatthias Ringwald /** 423d8e8f12aSMatthias Ringwald * @brief Get accepted connection parameter range 424d8e8f12aSMatthias Ringwald * @param range 425d8e8f12aSMatthias Ringwald */ 4264ced4e8cSMatthias Ringwald void gap_set_connection_parameter_range(le_connection_parameter_range_t * range); 427d8e8f12aSMatthias Ringwald 428d8e8f12aSMatthias Ringwald /** 42973cd8a2aSMatthias Ringwald * @brief Test if connection parameters are inside in existing rage 43073cd8a2aSMatthias Ringwald * @param conn_interval_min (unit: 1.25ms) 43173cd8a2aSMatthias Ringwald * @param conn_interval_max (unit: 1.25ms) 43273cd8a2aSMatthias Ringwald * @param conn_latency 43373cd8a2aSMatthias Ringwald * @param supervision_timeout (unit: 10ms) 43473cd8a2aSMatthias Ringwald * @returns 1 if included 43573cd8a2aSMatthias Ringwald */ 43673cd8a2aSMatthias Ringwald 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); 43773cd8a2aSMatthias Ringwald 43873cd8a2aSMatthias Ringwald /** 4392b6ab3e6SMatthias Ringwald * @brief Set max number of connections in LE Peripheral role (if Bluetooth Controller supports it) 4402b6ab3e6SMatthias Ringwald * @note: default: 1 4412b6ab3e6SMatthias Ringwald * @param max_peripheral_connections 4422b6ab3e6SMatthias Ringwald */ 4432b6ab3e6SMatthias Ringwald void gap_set_max_number_peripheral_connections(int max_peripheral_connections); 4442b6ab3e6SMatthias Ringwald 4452b6ab3e6SMatthias Ringwald /** 446d8e8f12aSMatthias Ringwald * @brief Connect to remote LE device 447d8e8f12aSMatthias Ringwald */ 448d8e8f12aSMatthias Ringwald uint8_t gap_connect(bd_addr_t addr, bd_addr_type_t addr_type); 449d8e8f12aSMatthias Ringwald 450d8e8f12aSMatthias Ringwald /** 451d8e8f12aSMatthias Ringwald * @brief Cancel connection process initiated by gap_connect 452d8e8f12aSMatthias Ringwald */ 453d8e8f12aSMatthias Ringwald uint8_t gap_connect_cancel(void); 454f7a05cdaSMatthias Ringwald 455f7a05cdaSMatthias Ringwald /** 456f7a05cdaSMatthias Ringwald * @brief Auto Connection Establishment - Start Connecting to device 457f7a05cdaSMatthias Ringwald * @param address_typ 458f7a05cdaSMatthias Ringwald * @param address 459f7a05cdaSMatthias Ringwald * @returns 0 if ok 460f7a05cdaSMatthias Ringwald */ 461f7a05cdaSMatthias Ringwald int gap_auto_connection_start(bd_addr_type_t address_typ, bd_addr_t address); 462f7a05cdaSMatthias Ringwald 463f7a05cdaSMatthias Ringwald /** 464f7a05cdaSMatthias Ringwald * @brief Auto Connection Establishment - Stop Connecting to device 465f7a05cdaSMatthias Ringwald * @param address_typ 466f7a05cdaSMatthias Ringwald * @param address 467f7a05cdaSMatthias Ringwald * @returns 0 if ok 468f7a05cdaSMatthias Ringwald */ 469f7a05cdaSMatthias Ringwald int gap_auto_connection_stop(bd_addr_type_t address_typ, bd_addr_t address); 470f7a05cdaSMatthias Ringwald 471f7a05cdaSMatthias Ringwald /** 472f7a05cdaSMatthias Ringwald * @brief Auto Connection Establishment - Stop everything 473f7a05cdaSMatthias Ringwald * @note Convenience function to stop all active auto connection attempts 474f7a05cdaSMatthias Ringwald */ 475f7a05cdaSMatthias Ringwald void gap_auto_connection_stop_all(void); 476f7a05cdaSMatthias Ringwald 4779c6e867eSMatthias Ringwald /** 478b90f6e0aSMatthias Ringwald * @brief Set LE PHY 479b90f6e0aSMatthias Ringwald * @param con_handle 480b90f6e0aSMatthias Ringwald * @param all_phys 0 = set rx/tx, 1 = set only rx, 2 = set only tx 481b90f6e0aSMatthias Ringwald * @param tx_phys 1 = 1M, 2 = 2M, 4 = Coded 482b90f6e0aSMatthias Ringwald * @param rx_phys 1 = 1M, 2 = 2M, 4 = Coded 483b90f6e0aSMatthias Ringwald * @param phy_options 0 = no preferred coding for Coded, 1 = S=2 coding (500 kbit), 2 = S=8 coding (125 kbit) 484b90f6e0aSMatthias Ringwald * @returns 0 if ok 485b90f6e0aSMatthias Ringwald */ 486b90f6e0aSMatthias Ringwald 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); 487b90f6e0aSMatthias Ringwald 488b90f6e0aSMatthias Ringwald /** 489c9db5c21SMilanka Ringwald * @brief Get connection interval 490c9db5c21SMilanka Ringwald * @return connection interval, otherwise 0 if error 491c9db5c21SMilanka Ringwald */ 492c9db5c21SMilanka Ringwald uint16_t gap_le_connection_interval(hci_con_handle_t connection_handle); 493c9db5c21SMilanka Ringwald 494c9db5c21SMilanka Ringwald /** 4959c6e867eSMatthias Ringwald * 4969c6e867eSMatthias Ringwald * @brief Get encryption key size. 4979c6e867eSMatthias Ringwald * @param con_handle 4989c6e867eSMatthias Ringwald * @return 0 if not encrypted, 7-16 otherwise 4999c6e867eSMatthias Ringwald */ 5009c6e867eSMatthias Ringwald int gap_encryption_key_size(hci_con_handle_t con_handle); 5019c6e867eSMatthias Ringwald 5029c6e867eSMatthias Ringwald /** 5039c6e867eSMatthias Ringwald * @brief Get authentication property. 5049c6e867eSMatthias Ringwald * @param con_handle 5059c6e867eSMatthias Ringwald * @return 1 if bonded with OOB/Passkey (AND MITM protection) 5069c6e867eSMatthias Ringwald */ 5079c6e867eSMatthias Ringwald int gap_authenticated(hci_con_handle_t con_handle); 5089c6e867eSMatthias Ringwald 5099c6e867eSMatthias Ringwald /** 510f1dfbe18SMatthias Ringwald * @brief Get secure connection property 511f1dfbe18SMatthias Ringwald * @param con_handle 512f1dfbe18SMatthias Ringwald * @return 1 if bonded usiung LE Secure Connections 513f1dfbe18SMatthias Ringwald */ 514f1dfbe18SMatthias Ringwald int gap_secure_connection(hci_con_handle_t con_handle); 515f1dfbe18SMatthias Ringwald 516f1dfbe18SMatthias Ringwald /** 5179c6e867eSMatthias Ringwald * @brief Queries authorization state. 5189c6e867eSMatthias Ringwald * @param con_handle 5199c6e867eSMatthias Ringwald * @return authorization_state for the current session 5209c6e867eSMatthias Ringwald */ 5219c6e867eSMatthias Ringwald authorization_state_t gap_authorization_state(hci_con_handle_t con_handle); 5229c6e867eSMatthias Ringwald 52315a95bd5SMatthias Ringwald // Classic 52415a95bd5SMatthias Ringwald 52515a95bd5SMatthias Ringwald /** 52615a95bd5SMatthias Ringwald * @brief Override page scan mode. Page scan mode enabled by l2cap when services are registered 52715a95bd5SMatthias Ringwald * @note Might be used to reduce power consumption while Bluetooth module stays powered but no (new) 52815a95bd5SMatthias Ringwald * connections are expected 52915a95bd5SMatthias Ringwald */ 53015a95bd5SMatthias Ringwald void gap_connectable_control(uint8_t enable); 53115a95bd5SMatthias Ringwald 53215a95bd5SMatthias Ringwald /** 53315a95bd5SMatthias Ringwald * @brief Allows to control if device is discoverable. OFF by default. 53415a95bd5SMatthias Ringwald */ 53515a95bd5SMatthias Ringwald void gap_discoverable_control(uint8_t enable); 53615a95bd5SMatthias Ringwald 53715a95bd5SMatthias Ringwald /** 53815a95bd5SMatthias Ringwald * @brief Gets local address. 53915a95bd5SMatthias Ringwald */ 54015a95bd5SMatthias Ringwald void gap_local_bd_addr(bd_addr_t address_buffer); 54115a95bd5SMatthias Ringwald 54215a95bd5SMatthias Ringwald /** 54315a95bd5SMatthias Ringwald * @brief Deletes link key for remote device with baseband address. 54455597469SMatthias Ringwald * @param addr 545c7710378SMatthias Ringwald * @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per 546c7710378SMatthias Ringwald * Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during 547c7710378SMatthias Ringwald * power up, this function only works, when the stack is in working state for these ports. 54815a95bd5SMatthias Ringwald */ 54915a95bd5SMatthias Ringwald void gap_drop_link_key_for_bd_addr(bd_addr_t addr); 55015a95bd5SMatthias Ringwald 55155597469SMatthias Ringwald /** 552ceecb9d9SMatthias Ringwald * @brief Delete all stored link keys 553c7710378SMatthias Ringwald * @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per 554c7710378SMatthias Ringwald * Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during 555c7710378SMatthias Ringwald * power up, this function only works, when the stack is in working state for these ports. 556ceecb9d9SMatthias Ringwald */ 557ceecb9d9SMatthias Ringwald void gap_delete_all_link_keys(void); 558ceecb9d9SMatthias Ringwald 559ceecb9d9SMatthias Ringwald /** 56055597469SMatthias Ringwald * @brief Store link key for remote device with baseband address 56155597469SMatthias Ringwald * @param addr 56255597469SMatthias Ringwald * @param link_key 56355597469SMatthias Ringwald * @param link_key_type 564c7710378SMatthias Ringwald * @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per 565c7710378SMatthias Ringwald * Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during 566c7710378SMatthias Ringwald * power up, this function only works, when the stack is in working state for these ports. 56755597469SMatthias Ringwald */ 56855597469SMatthias Ringwald void gap_store_link_key_for_bd_addr(bd_addr_t addr, link_key_t link_key, link_key_type_t type); 56955597469SMatthias Ringwald 570f5875de5SMatthias Ringwald /** 5711b6fb31bSMatthias Ringwald * @brief Setup Link Key iterator 5721b6fb31bSMatthias Ringwald * @param it 5731b6fb31bSMatthias Ringwald * @returns 1 on success 574c7710378SMatthias Ringwald * @note On most desktop ports, the Link Key DB uses a TLV and there is one TLV storage per 575c7710378SMatthias Ringwald * Controller resp. its Bluetooth Address. As the Bluetooth Address is retrieved during 576c7710378SMatthias Ringwald * power up, this function only works, when the stack is in working state for these ports. 5771b6fb31bSMatthias Ringwald */ 5781b6fb31bSMatthias Ringwald int gap_link_key_iterator_init(btstack_link_key_iterator_t * it); 5791b6fb31bSMatthias Ringwald 5801b6fb31bSMatthias Ringwald /** 5811b6fb31bSMatthias Ringwald * @brief Get next Link Key 5821b6fb31bSMatthias Ringwald * @param it 5831b6fb31bSMatthias Ringwald * @brief addr 5841b6fb31bSMatthias Ringwald * @brief link_key 5851b6fb31bSMatthias Ringwald * @brief type of link key 5861b6fb31bSMatthias Ringwald * @returns 1, if valid link key found 587c7710378SMatthias Ringwald * @see note on gap_link_key_iterator_init 5881b6fb31bSMatthias Ringwald */ 5891b6fb31bSMatthias Ringwald 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); 5901b6fb31bSMatthias Ringwald 5911b6fb31bSMatthias Ringwald /** 5921b6fb31bSMatthias Ringwald * @brief Frees resources allocated by iterator_init 5931b6fb31bSMatthias Ringwald * @note Must be called after iteration to free resources 5941b6fb31bSMatthias Ringwald * @param it 595c7710378SMatthias Ringwald * @see note on gap_link_key_iterator_init 5961b6fb31bSMatthias Ringwald */ 5971b6fb31bSMatthias Ringwald void gap_link_key_iterator_done(btstack_link_key_iterator_t * it); 5981b6fb31bSMatthias Ringwald 5991b6fb31bSMatthias Ringwald /** 600f5875de5SMatthias Ringwald * @brief Start GAP Classic Inquiry 601f5875de5SMatthias Ringwald * @param duration in 1.28s units 602f5875de5SMatthias Ringwald * @return 0 if ok 603f5875de5SMatthias Ringwald * @events: GAP_EVENT_INQUIRY_RESULT, GAP_EVENT_INQUIRY_COMPLETE 604f5875de5SMatthias Ringwald */ 605f5875de5SMatthias Ringwald int gap_inquiry_start(uint8_t duration_in_1280ms_units); 606f5875de5SMatthias Ringwald 607f5875de5SMatthias Ringwald /** 608f5875de5SMatthias Ringwald * @brief Stop GAP Classic Inquiry 609f5875de5SMatthias Ringwald * @brief Stop GAP Classic Inquiry 610f5875de5SMatthias Ringwald * @returns 0 if ok 611f5875de5SMatthias Ringwald * @events: GAP_EVENT_INQUIRY_COMPLETE 612f5875de5SMatthias Ringwald */ 613f5875de5SMatthias Ringwald int gap_inquiry_stop(void); 614f5875de5SMatthias Ringwald 615b7f1ee76SMatthias Ringwald /** 616b7f1ee76SMatthias Ringwald * @brief Remote Name Request 617b7f1ee76SMatthias Ringwald * @param addr 618b7f1ee76SMatthias Ringwald * @param page_scan_repetition_mode 619b7f1ee76SMatthias Ringwald * @param clock_offset only used when bit 15 is set - pass 0 if not known 620b7f1ee76SMatthias Ringwald * @events: HCI_EVENT_REMOTE_NAME_REQUEST_COMPLETE 621b7f1ee76SMatthias Ringwald */ 622b7f1ee76SMatthias Ringwald int gap_remote_name_request(bd_addr_t addr, uint8_t page_scan_repetition_mode, uint16_t clock_offset); 623b7f1ee76SMatthias Ringwald 6240a51f88bSMatthias Ringwald /** 625891b9fc2SMatthias Ringwald * @brief Read RSSI 626891b9fc2SMatthias Ringwald * @param con_handle 627891b9fc2SMatthias Ringwald * @events: GAP_EVENT_RSSI_MEASUREMENT 628891b9fc2SMatthias Ringwald */ 629891b9fc2SMatthias Ringwald int gap_read_rssi(hci_con_handle_t con_handle); 630891b9fc2SMatthias Ringwald 631891b9fc2SMatthias Ringwald /** 6320a51f88bSMatthias Ringwald * @brief Legacy Pairing Pin Code Response 633aad97216SMatthias Ringwald * @note data is not copied, pointer has to stay valid 6340a51f88bSMatthias Ringwald * @param addr 6350a51f88bSMatthias Ringwald * @param pin 6360a51f88bSMatthias Ringwald * @return 0 if ok 6370a51f88bSMatthias Ringwald */ 6380a51f88bSMatthias Ringwald int gap_pin_code_response(bd_addr_t addr, const char * pin); 6390a51f88bSMatthias Ringwald 6400a51f88bSMatthias Ringwald /** 641aad97216SMatthias Ringwald * @brief Legacy Pairing Pin Code Response for binary data / non-strings 642aad97216SMatthias Ringwald * @note data is not copied, pointer has to stay valid 643aad97216SMatthias Ringwald * @param addr 644aad97216SMatthias Ringwald * @param pin_data 645aad97216SMatthias Ringwald * @param pin_len 646aad97216SMatthias Ringwald * @return 0 if ok 647aad97216SMatthias Ringwald */ 648aad97216SMatthias Ringwald int gap_pin_code_response_binary(bd_addr_t addr, const uint8_t * pin_data, uint8_t pin_len); 649aad97216SMatthias Ringwald 650aad97216SMatthias Ringwald /** 6510a51f88bSMatthias Ringwald * @brief Abort Legacy Pairing 6520a51f88bSMatthias Ringwald * @param addr 6530a51f88bSMatthias Ringwald * @param pin 6540a51f88bSMatthias Ringwald * @return 0 if ok 6550a51f88bSMatthias Ringwald */ 6560a51f88bSMatthias Ringwald int gap_pin_code_negative(bd_addr_t addr); 6570a51f88bSMatthias Ringwald 6580a51f88bSMatthias Ringwald /** 6590a51f88bSMatthias Ringwald * @brief SSP Passkey Response 6600a51f88bSMatthias Ringwald * @param addr 6610a51f88bSMatthias Ringwald * @param passkey [0..999999] 6620a51f88bSMatthias Ringwald * @return 0 if ok 6630a51f88bSMatthias Ringwald */ 6640a51f88bSMatthias Ringwald int gap_ssp_passkey_response(bd_addr_t addr, uint32_t passkey); 6650a51f88bSMatthias Ringwald 6660a51f88bSMatthias Ringwald /** 6670a51f88bSMatthias Ringwald * @brief Abort SSP Passkey Entry/Pairing 6680a51f88bSMatthias Ringwald * @param addr 6690a51f88bSMatthias Ringwald * @param pin 6700a51f88bSMatthias Ringwald * @return 0 if ok 6710a51f88bSMatthias Ringwald */ 6720a51f88bSMatthias Ringwald int gap_ssp_passkey_negative(bd_addr_t addr); 6730a51f88bSMatthias Ringwald 6740a51f88bSMatthias Ringwald /** 6750a51f88bSMatthias Ringwald * @brief Accept SSP Numeric Comparison 6760a51f88bSMatthias Ringwald * @param addr 6770a51f88bSMatthias Ringwald * @param passkey 6780a51f88bSMatthias Ringwald * @return 0 if ok 6790a51f88bSMatthias Ringwald */ 6800a51f88bSMatthias Ringwald int gap_ssp_confirmation_response(bd_addr_t addr); 6810a51f88bSMatthias Ringwald 6820a51f88bSMatthias Ringwald /** 6830a51f88bSMatthias Ringwald * @brief Abort SSP Numeric Comparison/Pairing 6840a51f88bSMatthias Ringwald * @param addr 6850a51f88bSMatthias Ringwald * @param pin 6860a51f88bSMatthias Ringwald * @return 0 if ok 6870a51f88bSMatthias Ringwald */ 6880a51f88bSMatthias Ringwald int gap_ssp_confirmation_negative(bd_addr_t addr); 6890a51f88bSMatthias Ringwald 690f8ee3071SMatthias Ringwald /** 691f8ee3071SMatthias Ringwald * @brief Enter Sniff mode 692f8ee3071SMatthias Ringwald * @param con_handle 693f8ee3071SMatthias Ringwald * @param sniff_min_interval range: 0x0002 to 0xFFFE; only even values are valid, Time = N * 0.625 ms 694f8ee3071SMatthias Ringwald * @param sniff_max_interval range: 0x0002 to 0xFFFE; only even values are valid, Time = N * 0.625 ms 695f8ee3071SMatthias Ringwald * @param sniff_attempt Number of Baseband receive slots for sniff attempt. 696f8ee3071SMatthias Ringwald * @param sniff_timeout Number of Baseband receive slots for sniff timeout. 697f8ee3071SMatthias Ringwald @ @return 0 if ok 698f8ee3071SMatthias Ringwald */ 699f8ee3071SMatthias Ringwald 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); 7000a51f88bSMatthias Ringwald 701f8ee3071SMatthias Ringwald /** 702f8ee3071SMatthias Ringwald * @brief Exit Sniff mode 703f8ee3071SMatthias Ringwald * @param con_handle 704f8ee3071SMatthias Ringwald @ @return 0 if ok 705f8ee3071SMatthias Ringwald */ 706f8ee3071SMatthias Ringwald uint8_t gap_sniff_mode_exit(hci_con_handle_t con_handle); 7070a51f88bSMatthias Ringwald 70815a95bd5SMatthias Ringwald // LE 70915a95bd5SMatthias Ringwald 71015a95bd5SMatthias Ringwald /** 711b95a5a35SMatthias Ringwald * @brief Get own addr type and address used for LE 71215a95bd5SMatthias Ringwald */ 713b95a5a35SMatthias Ringwald void gap_le_get_own_address(uint8_t * addr_type, bd_addr_t addr); 71415a95bd5SMatthias Ringwald 7156e364deaSMatthias Ringwald 716dcd6c9b5SMatthias Ringwald /** 71788a03c8dSMatthias Ringwald * @brief Get state of connection re-encryption for bonded devices when in central role 718dcd6c9b5SMatthias Ringwald * @note used by gatt_client and att_server to wait for re-encryption 719dcd6c9b5SMatthias Ringwald * @param con_handle 720dcd6c9b5SMatthias Ringwald * @return 1 if security setup is active 721dcd6c9b5SMatthias Ringwald */ 722dcd6c9b5SMatthias Ringwald int gap_reconnect_security_setup_active(hci_con_handle_t con_handle); 723dcd6c9b5SMatthias Ringwald 724dcd6c9b5SMatthias Ringwald 725d8e8f12aSMatthias Ringwald /* API_END*/ 7266e364deaSMatthias Ringwald 727458bf4e8S[email protected] #if defined __cplusplus 728458bf4e8S[email protected] } 729458bf4e8S[email protected] #endif 730458bf4e8S[email protected] 73180e33422SMatthias Ringwald #endif // GAP_H 732