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 48 typedef enum { 49 50 // MITM protection not required 51 // No encryption required 52 // No user interaction required 53 LEVEL_0 = 0, 54 55 // MITM protection not required 56 // No encryption required 57 // Minimal user interaction desired 58 LEVEL_1, 59 60 // MITM protection not required 61 // Encryption required 62 LEVEL_2, 63 64 // MITM protection required 65 // Encryption required 66 // User interaction acceptable 67 LEVEL_3, 68 69 // MITM protection required 70 // Encryption required 71 // 128-bit equivalent strength for link and encryption keys required (P-192 is not enough) 72 // User interaction acceptable 73 LEVEL_4, 74 } gap_security_level_t; 75 76 typedef enum { 77 GAP_SECURITY_NONE, 78 GAP_SECUIRTY_ENCRYPTED, // SSP: JUST WORKS 79 GAP_SECURITY_AUTHENTICATED, // SSP: numeric comparison, passkey, OOB 80 // GAP_SECURITY_AUTHORIZED 81 } gap_security_state; 82 83 typedef enum { 84 GAP_CONNECTION_INVALID, 85 GAP_CONNECTION_ACL, 86 GAP_CONNECTION_SCO, 87 GAP_CONNECTION_LE 88 } gap_connection_type_t; 89 90 typedef struct le_connection_parameter_range{ 91 uint16_t le_conn_interval_min; 92 uint16_t le_conn_interval_max; 93 uint16_t le_conn_latency_min; 94 uint16_t le_conn_latency_max; 95 uint16_t le_supervision_timeout_min; 96 uint16_t le_supervision_timeout_max; 97 } le_connection_parameter_range_t; 98 99 typedef enum { 100 GAP_RANDOM_ADDRESS_TYPE_OFF = 0, 101 GAP_RANDOM_ADDRESS_TYPE_STATIC, 102 GAP_RANDOM_ADDRESS_NON_RESOLVABLE, 103 GAP_RANDOM_ADDRESS_RESOLVABLE, 104 } gap_random_address_type_t; 105 106 /* API_START */ 107 108 // Classic + LE 109 110 /** 111 * @brief Disconnect connection with handle 112 * @param handle 113 */ 114 uint8_t gap_disconnect(hci_con_handle_t handle); 115 116 /** 117 * @brief Get connection type 118 * @param con_handle 119 * @result connection_type 120 */ 121 gap_connection_type_t gap_get_connection_type(hci_con_handle_t connection_handle); 122 123 // Classic 124 125 /** 126 * @brief Sets local name. 127 * @note has to be done before stack starts up 128 * @param name is not copied, make sure memory is accessible during stack startup 129 */ 130 void gap_set_local_name(const char * local_name); 131 132 /** 133 * @brief Set Extended Inquiry Response data 134 * @param eir_data size 240 bytes, is not copied make sure memory is accessible during stack startup 135 * @note has to be done before stack starts up 136 */ 137 void gap_set_extended_inquiry_response(const uint8_t * data); 138 139 /** 140 * @brief Set class of device that will be set during Bluetooth init. 141 * @note has to be done before stack starts up 142 */ 143 void gap_set_class_of_device(uint32_t class_of_device); 144 145 /** 146 * @brief Enable/disable bonding. Default is enabled. 147 * @param enabled 148 */ 149 void gap_set_bondable_mode(int enabled); 150 151 /** 152 * @brief Get bondable mode. 153 * @return 1 if bondable 154 */ 155 int gap_get_bondable_mode(void); 156 157 /* Configure Secure Simple Pairing */ 158 159 /** 160 * @brief Enable will enable SSP during init. 161 */ 162 void gap_ssp_set_enable(int enable); 163 164 /** 165 * @brief Set IO Capability. BTstack will return capability to SSP requests 166 */ 167 void gap_ssp_set_io_capability(int ssp_io_capability); 168 169 /** 170 * @brief Set Authentication Requirements using during SSP 171 */ 172 void gap_ssp_set_authentication_requirement(int authentication_requirement); 173 174 /** 175 * @brief If set, BTstack will confirm a numeric comparison and enter '000000' if requested. 176 */ 177 void gap_ssp_set_auto_accept(int auto_accept); 178 179 /** 180 * @brief Start dedicated bonding with device. Disconnect after bonding. 181 * @param device 182 * @param request MITM protection 183 * @return error, if max num acl connections active 184 * @result GAP_DEDICATED_BONDING_COMPLETE 185 */ 186 int gap_dedicated_bonding(bd_addr_t device, int mitm_protection_required); 187 188 gap_security_level_t gap_security_level_for_link_key_type(link_key_type_t link_key_type); 189 gap_security_level_t gap_security_level(hci_con_handle_t con_handle); 190 191 void gap_request_security_level(hci_con_handle_t con_handle, gap_security_level_t level); 192 193 int gap_mitm_protection_required_for_security_level(gap_security_level_t level); 194 195 // LE 196 197 /** 198 * @brief Set parameters for LE Scan 199 */ 200 void gap_set_scan_parameters(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window); 201 202 /** 203 * @brief Start LE Scan 204 */ 205 void gap_start_scan(void); 206 207 /** 208 * @brief Stop LE Scan 209 */ 210 void gap_stop_scan(void); 211 212 /** 213 * @brief Enable privacy by using random addresses 214 * @param random_address_type to use (incl. OFF) 215 */ 216 void gap_random_address_set_mode(gap_random_address_type_t random_address_type); 217 218 /** 219 * @brief Get privacy mode 220 */ 221 gap_random_address_type_t gap_random_address_get_mode(void); 222 223 /** 224 * @brief Sets update period for random address 225 * @param period_ms in ms 226 */ 227 void gap_random_address_set_update_period(int period_ms); 228 229 /** 230 * @brief Sets a fixed random address for advertising 231 * @param addr 232 * @note Sets random address mode to type off 233 */ 234 void gap_random_address_set(bd_addr_t addr); 235 236 /** 237 * @brief Set Advertisement Data 238 * @param advertising_data_length 239 * @param advertising_data (max 31 octets) 240 * @note data is not copied, pointer has to stay valid 241 */ 242 void gap_advertisements_set_data(uint8_t advertising_data_length, uint8_t * advertising_data); 243 244 /** 245 * @brief Set Advertisement Paramters 246 * @param adv_int_min 247 * @param adv_int_max 248 * @param adv_type 249 * @param direct_address_type 250 * @param direct_address 251 * @param channel_map 252 * @param filter_policy 253 * @note own_address_type is used from gap_random_address_set_mode 254 */ 255 void gap_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 256 uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy); 257 258 /** 259 * @brief Enable/Disable Advertisements. OFF by default. 260 * @param enabled 261 */ 262 void gap_advertisements_enable(int enabled); 263 264 /** 265 * @brief Set Scan Response Data 266 * 267 * @note For scan response data, scannable undirected advertising (ADV_SCAN_IND) need to be used 268 * 269 * @param advertising_data_length 270 * @param advertising_data (max 31 octets) 271 * @note data is not copied, pointer has to stay valid 272 */ 273 void gap_scan_response_set_data(uint8_t scan_response_data_length, uint8_t * scan_response_data); 274 275 /** 276 * @brief Request an update of the connection parameter for a given LE connection 277 * @param handle 278 * @param conn_interval_min (unit: 1.25ms) 279 * @param conn_interval_max (unit: 1.25ms) 280 * @param conn_latency 281 * @param supervision_timeout (unit: 10ms) 282 * @returns 0 if ok 283 */ 284 int gap_request_connection_parameter_update(hci_con_handle_t con_handle, uint16_t conn_interval_min, 285 uint16_t conn_interval_max, uint16_t conn_latency, uint16_t supervision_timeout); 286 287 /** 288 * @brief Updates the connection parameters for a given LE connection 289 * @param handle 290 * @param conn_interval_min (unit: 1.25ms) 291 * @param conn_interval_max (unit: 1.25ms) 292 * @param conn_latency 293 * @param supervision_timeout (unit: 10ms) 294 * @returns 0 if ok 295 */ 296 int gap_update_connection_parameters(hci_con_handle_t con_handle, uint16_t conn_interval_min, 297 uint16_t conn_interval_max, uint16_t conn_latency, uint16_t supervision_timeout); 298 299 /** 300 * @brief Set accepted connection parameter range 301 * @param range 302 */ 303 void gap_get_connection_parameter_range(le_connection_parameter_range_t * range); 304 305 /** 306 * @brief Get accepted connection parameter range 307 * @param range 308 */ 309 void gap_set_connection_parameter_range(le_connection_parameter_range_t * range); 310 311 /** 312 * @brief Connect to remote LE device 313 */ 314 uint8_t gap_connect(bd_addr_t addr, bd_addr_type_t addr_type); 315 316 /** 317 * @brief Cancel connection process initiated by gap_connect 318 */ 319 uint8_t gap_connect_cancel(void); 320 321 /** 322 * @brief Auto Connection Establishment - Start Connecting to device 323 * @param address_typ 324 * @param address 325 * @returns 0 if ok 326 */ 327 int gap_auto_connection_start(bd_addr_type_t address_typ, bd_addr_t address); 328 329 /** 330 * @brief Auto Connection Establishment - Stop Connecting to device 331 * @param address_typ 332 * @param address 333 * @returns 0 if ok 334 */ 335 int gap_auto_connection_stop(bd_addr_type_t address_typ, bd_addr_t address); 336 337 /** 338 * @brief Auto Connection Establishment - Stop everything 339 * @note Convenience function to stop all active auto connection attempts 340 */ 341 void gap_auto_connection_stop_all(void); 342 343 // Classic 344 345 /** 346 * @brief Override page scan mode. Page scan mode enabled by l2cap when services are registered 347 * @note Might be used to reduce power consumption while Bluetooth module stays powered but no (new) 348 * connections are expected 349 */ 350 void gap_connectable_control(uint8_t enable); 351 352 /** 353 * @brief Allows to control if device is discoverable. OFF by default. 354 */ 355 void gap_discoverable_control(uint8_t enable); 356 357 /** 358 * @brief Gets local address. 359 */ 360 void gap_local_bd_addr(bd_addr_t address_buffer); 361 362 /** 363 * @brief Deletes link key for remote device with baseband address. 364 * @param addr 365 */ 366 void gap_drop_link_key_for_bd_addr(bd_addr_t addr); 367 368 /** 369 * @brief Store link key for remote device with baseband address 370 * @param addr 371 * @param link_key 372 * @param link_key_type 373 */ 374 void gap_store_link_key_for_bd_addr(bd_addr_t addr, link_key_t link_key, link_key_type_t type); 375 376 // LE 377 378 /** 379 * @brief Get own addr type and address used for LE 380 */ 381 void gap_le_get_own_address(uint8_t * addr_type, bd_addr_t addr); 382 383 384 /* API_END*/ 385 386 #if defined __cplusplus 387 } 388 #endif 389 390 #endif // __GAP_H 391