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 /** 108 * @brief Enable/disable bonding. Default is enabled. 109 * @param enabled 110 */ 111 void gap_set_bondable_mode(int enabled); 112 113 /** 114 * @brief Get bondable mode. 115 * @return 1 if bondable 116 */ 117 int gap_get_bondable_mode(void); 118 119 /** 120 * @brief Start dedicated bonding with device. Disconnect after bonding. 121 * @param device 122 * @param request MITM protection 123 * @return error, if max num acl connections active 124 * @result GAP_DEDICATED_BONDING_COMPLETE 125 */ 126 int gap_dedicated_bonding(bd_addr_t device, int mitm_protection_required); 127 128 gap_security_level_t gap_security_level_for_link_key_type(link_key_type_t link_key_type); 129 gap_security_level_t gap_security_level(hci_con_handle_t con_handle); 130 131 void gap_request_security_level(hci_con_handle_t con_handle, gap_security_level_t level); 132 int gap_mitm_protection_required_for_security_level(gap_security_level_t level); 133 134 /** 135 * @brief Sets local name. 136 * @note has to be done before stack starts up 137 * @param name is not copied, make sure memory is accessible during stack startup 138 */ 139 void gap_set_local_name(const char * local_name); 140 /* API_END*/ 141 142 /** 143 * @brief Get connection type 144 * @param con_handle 145 * @result connection_type 146 */ 147 gap_connection_type_t gap_get_connection_type(hci_con_handle_t connection_handle); 148 149 /** 150 * @brief Enable privacy by using random addresses 151 * @param random_address_type to use (incl. OFF) 152 */ 153 void gap_random_address_set_mode(gap_random_address_type_t random_address_type); 154 155 /** 156 * @brief Get privacy mode 157 */ 158 gap_random_address_type_t gap_random_address_get_mode(void); 159 160 /** 161 * @brief Sets update period for random address 162 * @param period_ms in ms 163 */ 164 void gap_random_address_set_update_period(int period_ms); 165 166 /** 167 * @brief Sets a fixed random address for advertising 168 * @param addr 169 * @note Sets random address mode to type off 170 */ 171 void gap_random_address_set(bd_addr_t addr); 172 173 /** 174 * @brief Updates the connection parameters for a given LE connection 175 * @param handle 176 * @param conn_interval_min (unit: 1.25ms) 177 * @param conn_interval_max (unit: 1.25ms) 178 * @param conn_latency 179 * @param supervision_timeout (unit: 10ms) 180 * @returns 0 if ok 181 */ 182 int gap_update_connection_parameters(hci_con_handle_t con_handle, uint16_t conn_interval_min, 183 uint16_t conn_interval_max, uint16_t conn_latency, uint16_t supervision_timeout); 184 185 /** 186 * @brief Request an update of the connection parameter for a given LE connection 187 * @param handle 188 * @param conn_interval_min (unit: 1.25ms) 189 * @param conn_interval_max (unit: 1.25ms) 190 * @param conn_latency 191 * @param supervision_timeout (unit: 10ms) 192 * @returns 0 if ok 193 */ 194 int gap_request_connection_parameter_update(hci_con_handle_t con_handle, uint16_t conn_interval_min, 195 uint16_t conn_interval_max, uint16_t conn_latency, uint16_t supervision_timeout); 196 197 /** 198 * @brief Set Advertisement Data 199 * @param advertising_data_length 200 * @param advertising_data (max 31 octets) 201 * @note data is not copied, pointer has to stay valid 202 */ 203 void gap_advertisements_set_data(uint8_t advertising_data_length, uint8_t * advertising_data); 204 205 /** 206 * @brief Set Advertisement Paramters 207 * @param adv_int_min 208 * @param adv_int_max 209 * @param adv_type 210 * @param direct_address_type 211 * @param direct_address 212 * @param channel_map 213 * @param filter_policy 214 * @note own_address_type is used from gap_random_address_set_mode 215 */ 216 void gap_advertisements_set_params(uint16_t adv_int_min, uint16_t adv_int_max, uint8_t adv_type, 217 uint8_t direct_address_typ, bd_addr_t direct_address, uint8_t channel_map, uint8_t filter_policy); 218 219 /** 220 * @brief Enable/Disable Advertisements 221 * @param enabled 222 */ 223 void gap_advertisements_enable(int enabled); 224 225 /** 226 * @brief Auto Connection Establishment - Start Connecting to device 227 * @param address_typ 228 * @param address 229 * @returns 0 if ok 230 */ 231 int gap_auto_connection_start(bd_addr_type_t address_typ, bd_addr_t address); 232 233 /** 234 * @brief Auto Connection Establishment - Stop Connecting to device 235 * @param address_typ 236 * @param address 237 * @returns 0 if ok 238 */ 239 int gap_auto_connection_stop(bd_addr_type_t address_typ, bd_addr_t address); 240 241 /** 242 * @brief Auto Connection Establishment - Stop everything 243 * @note Convenience function to stop all active auto connection attempts 244 */ 245 void gap_auto_connection_stop_all(void); 246 247 void gap_le_get_connection_parameter_range(le_connection_parameter_range_t range); 248 void gap_le_set_connection_parameter_range(le_connection_parameter_range_t range); 249 250 /* LE Client Start */ 251 252 uint8_t le_central_start_scan(void); 253 uint8_t le_central_stop_scan(void); 254 uint8_t le_central_connect(bd_addr_t addr, bd_addr_type_t addr_type); 255 uint8_t le_central_connect_cancel(void); 256 uint8_t gap_disconnect(hci_con_handle_t handle); 257 void le_central_set_scan_parameters(uint8_t scan_type, uint16_t scan_interval, uint16_t scan_window); 258 259 #if defined __cplusplus 260 } 261 #endif 262 263 #endif // __GAP_H 264