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