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 Enable/disable bonding. Default is enabled. 133 * @param enabled 134 */ 135 void gap_set_bondable_mode(int enabled); 136 137 /** 138 * @brief Get bondable mode. 139 * @return 1 if bondable 140 */ 141 int gap_get_bondable_mode(void); 142 143 /** 144 * @brief Start dedicated bonding with device. Disconnect after bonding. 145 * @param device 146 * @param request MITM protection 147 * @return error, if max num acl connections active 148 * @result GAP_DEDICATED_BONDING_COMPLETE 149 */ 150 int gap_dedicated_bonding(bd_addr_t device, int mitm_protection_required); 151 152 gap_security_level_t gap_security_level_for_link_key_type(link_key_type_t link_key_type); 153 gap_security_level_t gap_security_level(hci_con_handle_t con_handle); 154 155 void gap_request_security_level(hci_con_handle_t con_handle, gap_security_level_t level); 156 157 int gap_mitm_protection_required_for_security_level(gap_security_level_t level); 158 159 // LE 160 161 /** 162 * @brief Set parameters for LE Scan 163 */ 164 void gap_set_scan_parameters(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window); 165 166 /** 167 * @brief Start LE Scan 168 */ 169 void gap_start_scan(void); 170 171 /** 172 * @brief Stop LE Scan 173 */ 174 void gap_stop_scan(void); 175 176 /** 177 * @brief Enable privacy by using random addresses 178 * @param random_address_type to use (incl. OFF) 179 */ 180 void gap_random_address_set_mode(gap_random_address_type_t random_address_type); 181 182 /** 183 * @brief Get privacy mode 184 */ 185 gap_random_address_type_t gap_random_address_get_mode(void); 186 187 /** 188 * @brief Sets update period for random address 189 * @param period_ms in ms 190 */ 191 void gap_random_address_set_update_period(int period_ms); 192 193 /** 194 * @brief Sets a fixed random address for advertising 195 * @param addr 196 * @note Sets random address mode to type off 197 */ 198 void gap_random_address_set(bd_addr_t addr); 199 200 /** 201 * @brief Set Advertisement Data 202 * @param advertising_data_length 203 * @param advertising_data (max 31 octets) 204 * @note data is not copied, pointer has to stay valid 205 */ 206 void gap_advertisements_set_data(uint8_t advertising_data_length, uint8_t * advertising_data); 207 208 /** 209 * @brief Set Advertisement Paramters 210 * @param adv_int_min 211 * @param adv_int_max 212 * @param adv_type 213 * @param direct_address_type 214 * @param direct_address 215 * @param channel_map 216 * @param filter_policy 217 * @note own_address_type is used from gap_random_address_set_mode 218 */ 219 void gap_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 220 uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy); 221 222 /** 223 * @brief Enable/Disable Advertisements 224 * @param enabled 225 */ 226 void gap_advertisements_enable(int enabled); 227 /** 228 * @brief Request an update of the connection parameter for a given LE connection 229 * @param handle 230 * @param conn_interval_min (unit: 1.25ms) 231 * @param conn_interval_max (unit: 1.25ms) 232 * @param conn_latency 233 * @param supervision_timeout (unit: 10ms) 234 * @returns 0 if ok 235 */ 236 int gap_request_connection_parameter_update(hci_con_handle_t con_handle, uint16_t conn_interval_min, 237 uint16_t conn_interval_max, uint16_t conn_latency, uint16_t supervision_timeout); 238 239 /** 240 * @brief Updates the connection parameters for a given LE connection 241 * @param handle 242 * @param conn_interval_min (unit: 1.25ms) 243 * @param conn_interval_max (unit: 1.25ms) 244 * @param conn_latency 245 * @param supervision_timeout (unit: 10ms) 246 * @returns 0 if ok 247 */ 248 int gap_update_connection_parameters(hci_con_handle_t con_handle, uint16_t conn_interval_min, 249 uint16_t conn_interval_max, uint16_t conn_latency, uint16_t supervision_timeout); 250 251 /** 252 * @brief Set accepted connection parameter range 253 * @param range 254 */ 255 void gap_get_connection_parameter_range(le_connection_parameter_range_t range); 256 257 /** 258 * @brief Get accepted connection parameter range 259 * @param range 260 */ 261 void gap_set_connection_parameter_range(le_connection_parameter_range_t range); 262 263 /** 264 * @brief Connect to remote LE device 265 */ 266 uint8_t gap_connect(bd_addr_t addr, bd_addr_type_t addr_type); 267 268 /** 269 * @brief Cancel connection process initiated by gap_connect 270 */ 271 uint8_t gap_connect_cancel(void); 272 273 /** 274 * @brief Auto Connection Establishment - Start Connecting to device 275 * @param address_typ 276 * @param address 277 * @returns 0 if ok 278 */ 279 int gap_auto_connection_start(bd_addr_type_t address_typ, bd_addr_t address); 280 281 /** 282 * @brief Auto Connection Establishment - Stop Connecting to device 283 * @param address_typ 284 * @param address 285 * @returns 0 if ok 286 */ 287 int gap_auto_connection_stop(bd_addr_type_t address_typ, bd_addr_t address); 288 289 /** 290 * @brief Auto Connection Establishment - Stop everything 291 * @note Convenience function to stop all active auto connection attempts 292 */ 293 void gap_auto_connection_stop_all(void); 294 295 296 /* API_END*/ 297 298 #if defined __cplusplus 299 } 300 #endif 301 302 #endif // __GAP_H 303