driver.h revision df5a7e4c5c64890c2425bb47d665bbce4992b676
15c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)/* 25c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Driver interface definition 35c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * Copyright (c) 2003-2014, Jouni Malinen <j@w1.fi> 45c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 55c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * This software may be distributed under the terms of the BSD license. 65c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * See README for more details. 75c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * 85c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * This file defines a driver interface used by both %wpa_supplicant and 95c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * hostapd. The first part of the file defines data structures used in various 105c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * driver operations. This is followed by the struct wpa_driver_ops that each 115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * driver wrapper will beed to define with callback functions for requesting 125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * driver operations. After this, there are definitions for driver event 135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * reporting with wpa_supplicant_event() and some convenience helper functions 145c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * that can be used to report events. 155c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 165c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#ifndef DRIVER_H 185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#define DRIVER_H 195c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 205c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#define WPA_SUPPLICANT_DRIVER_VERSION 4 215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#include "common/defs.h" 235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#include "utils/list.h" 245c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 255c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#define HOSTAPD_CHAN_DISABLED 0x00000001 265c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002 27bfe3590b1806e3ff18f46ee3af5d4b83078f305aTorne (Richard Coles)#define HOSTAPD_CHAN_NO_IBSS 0x00000004 285c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#define HOSTAPD_CHAN_RADAR 0x00000008 2953e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles)#define HOSTAPD_CHAN_HT40PLUS 0x00000010 3053e740f4a82e17f3ae59772501622dc354e42336Torne (Richard Coles)#define HOSTAPD_CHAN_HT40MINUS 0x00000020 315c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#define HOSTAPD_CHAN_HT40 0x00000040 32c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles)#define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080 335c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 34bfe3590b1806e3ff18f46ee3af5d4b83078f305aTorne (Richard Coles)#define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000 355c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#define HOSTAPD_CHAN_DFS_USABLE 0x00000100 36bfe3590b1806e3ff18f46ee3af5d4b83078f305aTorne (Richard Coles)#define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200 375c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300 3802772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch#define HOSTAPD_CHAN_DFS_MASK 0x00000300 39bfe3590b1806e3ff18f46ee3af5d4b83078f305aTorne (Richard Coles) 405c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#define HOSTAPD_CHAN_VHT_10_70 0x00000800 415c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#define HOSTAPD_CHAN_VHT_30_50 0x00001000 425c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#define HOSTAPD_CHAN_VHT_50_30 0x00002000 435c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#define HOSTAPD_CHAN_VHT_70_10 0x00004000 44bfe3590b1806e3ff18f46ee3af5d4b83078f305aTorne (Richard Coles) 455c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)enum reg_change_initiator { 465c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) REGDOM_SET_BY_CORE, 4702772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch REGDOM_SET_BY_USER, 48bfe3590b1806e3ff18f46ee3af5d4b83078f305aTorne (Richard Coles) REGDOM_SET_BY_DRIVER, 495c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) REGDOM_SET_BY_COUNTRY_IE, 505c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) REGDOM_BEACON_HINT, 5102772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch}; 525c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 535c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)/** 5402772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch * struct hostapd_channel_data - Channel information 55a372c30a9dc26aa32e51fa7b85e0c47b55479f89Ben Murdoch */ 565c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)struct hostapd_channel_data { 575c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 58bfe3590b1806e3ff18f46ee3af5d4b83078f305aTorne (Richard Coles) * chan - Channel number (IEEE 802.11) 595c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 605c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) short chan; 6102772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch 62197021e6b966cfb06891637935ef33fff06433d1Ben Murdoch /** 635c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * freq - Frequency in MHz 645c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 655c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) int freq; 665c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 67197021e6b966cfb06891637935ef33fff06433d1Ben Murdoch /** 685c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * flag - Channel flags (HOSTAPD_CHAN_*) 695c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 705c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) int flag; 715c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 7202772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch /** 73bfe3590b1806e3ff18f46ee3af5d4b83078f305aTorne (Richard Coles) * max_tx_power - Regulatory transmit power limit in dBm 745c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 755c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) u8 max_tx_power; 765c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 775c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /* 7802772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch * survey_list - Linked list of surveys 795c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 805c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) struct dl_list survey_list; 815c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 82bfe3590b1806e3ff18f46ee3af5d4b83078f305aTorne (Richard Coles) /** 835c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * min_nf - Minimum observed noise floor, in dBm, based on all 84bfe3590b1806e3ff18f46ee3af5d4b83078f305aTorne (Richard Coles) * surveyed channel data 855c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 865c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) s8 min_nf; 875c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 8802772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch#ifdef CONFIG_ACS 89bfe3590b1806e3ff18f46ee3af5d4b83078f305aTorne (Richard Coles) /** 905c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * interference_factor - Computed interference factor on this 91bfe3590b1806e3ff18f46ee3af5d4b83078f305aTorne (Richard Coles) * channel (used internally in src/ap/acs.c; driver wrappers do not 925c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * need to set this) 935c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) */ 94bfe3590b1806e3ff18f46ee3af5d4b83078f305aTorne (Richard Coles) long double interference_factor; 955c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#endif /* CONFIG_ACS */ 965c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 975c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /* DFS CAC time in milliseconds */ 9802772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch unsigned int dfs_cac_ms; 995c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)}; 100bfe3590b1806e3ff18f46ee3af5d4b83078f305aTorne (Richard Coles) 1015c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0) 102bfe3590b1806e3ff18f46ee3af5d4b83078f305aTorne (Richard Coles)#define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1) 10302772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch 10402772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch/** 1055c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * struct hostapd_hw_modes - Supported hardware mode information 10602772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch */ 1075c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles)struct hostapd_hw_modes { 1085c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 1095c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * mode - Hardware mode 110bfe3590b1806e3ff18f46ee3af5d4b83078f305aTorne (Richard Coles) */ 1115c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) enum hostapd_hw_mode mode; 1125c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1135c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 11402772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch * num_channels - Number of entries in the channels array 115bfe3590b1806e3ff18f46ee3af5d4b83078f305aTorne (Richard Coles) */ 1165c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) int num_channels; 1175c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1185c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 1195c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) * channels - Array of supported channels 12002772c6a72f1ee0b226341a4f4439970c29fc861Ben Murdoch */ 1215c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) struct hostapd_channel_data *channels; 1225c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) 1235c87bf8b86a7c82ef50fb7a89697d8e02e2553beTorne (Richard Coles) /** 124c1847b1379d12d0e05df27436bf19a9b1bf12deaTorne (Richard Coles) * num_rates - Number of entries in the rates array 125 */ 126 int num_rates; 127 128 /** 129 * rates - Array of supported rates in 100 kbps units 130 */ 131 int *rates; 132 133 /** 134 * ht_capab - HT (IEEE 802.11n) capabilities 135 */ 136 u16 ht_capab; 137 138 /** 139 * mcs_set - MCS (IEEE 802.11n) rate parameters 140 */ 141 u8 mcs_set[16]; 142 143 /** 144 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters 145 */ 146 u8 a_mpdu_params; 147 148 /** 149 * vht_capab - VHT (IEEE 802.11ac) capabilities 150 */ 151 u32 vht_capab; 152 153 /** 154 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters 155 */ 156 u8 vht_mcs_set[8]; 157 158 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */ 159}; 160 161 162#define IEEE80211_MODE_INFRA 0 163#define IEEE80211_MODE_IBSS 1 164#define IEEE80211_MODE_AP 2 165 166#define IEEE80211_CAP_ESS 0x0001 167#define IEEE80211_CAP_IBSS 0x0002 168#define IEEE80211_CAP_PRIVACY 0x0010 169 170/* DMG (60 GHz) IEEE 802.11ad */ 171/* type - bits 0..1 */ 172#define IEEE80211_CAP_DMG_MASK 0x0003 173#define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */ 174#define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */ 175#define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */ 176 177#define WPA_SCAN_QUAL_INVALID BIT(0) 178#define WPA_SCAN_NOISE_INVALID BIT(1) 179#define WPA_SCAN_LEVEL_INVALID BIT(2) 180#define WPA_SCAN_LEVEL_DBM BIT(3) 181#define WPA_SCAN_AUTHENTICATED BIT(4) 182#define WPA_SCAN_ASSOCIATED BIT(5) 183 184/** 185 * struct wpa_scan_res - Scan result for an BSS/IBSS 186 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*) 187 * @bssid: BSSID 188 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1) 189 * @beacon_int: beacon interval in TUs (host byte order) 190 * @caps: capability information field in host byte order 191 * @qual: signal quality 192 * @noise: noise level 193 * @level: signal level 194 * @tsf: Timestamp 195 * @age: Age of the information in milliseconds (i.e., how many milliseconds 196 * ago the last Beacon or Probe Response frame was received) 197 * @ie_len: length of the following IE field in octets 198 * @beacon_ie_len: length of the following Beacon IE field in octets 199 * 200 * This structure is used as a generic format for scan results from the 201 * driver. Each driver interface implementation is responsible for converting 202 * the driver or OS specific scan results into this format. 203 * 204 * If the driver does not support reporting all IEs, the IE data structure is 205 * constructed of the IEs that are available. This field will also need to 206 * include SSID in IE format. All drivers are encouraged to be extended to 207 * report all IEs to make it easier to support future additions. 208 */ 209struct wpa_scan_res { 210 unsigned int flags; 211 u8 bssid[ETH_ALEN]; 212 int freq; 213 u16 beacon_int; 214 u16 caps; 215 int qual; 216 int noise; 217 int level; 218 u64 tsf; 219 unsigned int age; 220 size_t ie_len; 221 size_t beacon_ie_len; 222 /* 223 * Followed by ie_len octets of IEs from Probe Response frame (or if 224 * the driver does not indicate source of IEs, these may also be from 225 * Beacon frame). After the first set of IEs, another set of IEs may 226 * follow (with beacon_ie_len octets of data) if the driver provides 227 * both IE sets. 228 */ 229}; 230 231/** 232 * struct wpa_scan_results - Scan results 233 * @res: Array of pointers to allocated variable length scan result entries 234 * @num: Number of entries in the scan result array 235 * @fetch_time: Time when the results were fetched from the driver 236 */ 237struct wpa_scan_results { 238 struct wpa_scan_res **res; 239 size_t num; 240 struct os_reltime fetch_time; 241}; 242 243/** 244 * struct wpa_interface_info - Network interface information 245 * @next: Pointer to the next interface or NULL if this is the last one 246 * @ifname: Interface name that can be used with init() or init2() 247 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if 248 * not available 249 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one 250 * is not an allocated copy, i.e., get_interfaces() caller will not free 251 * this) 252 */ 253struct wpa_interface_info { 254 struct wpa_interface_info *next; 255 char *ifname; 256 char *desc; 257 const char *drv_name; 258}; 259 260#define WPAS_MAX_SCAN_SSIDS 16 261 262/** 263 * struct wpa_driver_scan_params - Scan parameters 264 * Data for struct wpa_driver_ops::scan2(). 265 */ 266struct wpa_driver_scan_params { 267 /** 268 * ssids - SSIDs to scan for 269 */ 270 struct wpa_driver_scan_ssid { 271 /** 272 * ssid - specific SSID to scan for (ProbeReq) 273 * %NULL or zero-length SSID is used to indicate active scan 274 * with wildcard SSID. 275 */ 276 const u8 *ssid; 277 /** 278 * ssid_len: Length of the SSID in octets 279 */ 280 size_t ssid_len; 281 } ssids[WPAS_MAX_SCAN_SSIDS]; 282 283 /** 284 * num_ssids - Number of entries in ssids array 285 * Zero indicates a request for a passive scan. 286 */ 287 size_t num_ssids; 288 289 /** 290 * extra_ies - Extra IE(s) to add into Probe Request or %NULL 291 */ 292 const u8 *extra_ies; 293 294 /** 295 * extra_ies_len - Length of extra_ies in octets 296 */ 297 size_t extra_ies_len; 298 299 /** 300 * freqs - Array of frequencies to scan or %NULL for all frequencies 301 * 302 * The frequency is set in MHz. The array is zero-terminated. 303 */ 304 int *freqs; 305 306 /** 307 * filter_ssids - Filter for reporting SSIDs 308 * 309 * This optional parameter can be used to request the driver wrapper to 310 * filter scan results to include only the specified SSIDs. %NULL 311 * indicates that no filtering is to be done. This can be used to 312 * reduce memory needs for scan results in environments that have large 313 * number of APs with different SSIDs. 314 * 315 * The driver wrapper is allowed to take this allocated buffer into its 316 * own use by setting the pointer to %NULL. In that case, the driver 317 * wrapper is responsible for freeing the buffer with os_free() once it 318 * is not needed anymore. 319 */ 320 struct wpa_driver_scan_filter { 321 u8 ssid[32]; 322 size_t ssid_len; 323 } *filter_ssids; 324 325 /** 326 * num_filter_ssids - Number of entries in filter_ssids array 327 */ 328 size_t num_filter_ssids; 329 330 /** 331 * filter_rssi - Filter by RSSI 332 * 333 * The driver may filter scan results in firmware to reduce host 334 * wakeups and thereby save power. Specify the RSSI threshold in s32 335 * dBm. 336 */ 337 s32 filter_rssi; 338 339 /** 340 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes 341 * 342 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11 343 * Mbps from the support rates element(s) in the Probe Request frames 344 * and not to transmit the frames at any of those rates. 345 */ 346 u8 p2p_probe; 347 348 /** 349 * only_new_results - Request driver to report only new results 350 * 351 * This is used to request the driver to report only BSSes that have 352 * been detected after this scan request has been started, i.e., to 353 * flush old cached BSS entries. 354 */ 355 int only_new_results; 356 357 /* 358 * NOTE: Whenever adding new parameters here, please make sure 359 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with 360 * matching changes. 361 */ 362}; 363 364/** 365 * struct wpa_driver_auth_params - Authentication parameters 366 * Data for struct wpa_driver_ops::authenticate(). 367 */ 368struct wpa_driver_auth_params { 369 int freq; 370 const u8 *bssid; 371 const u8 *ssid; 372 size_t ssid_len; 373 int auth_alg; 374 const u8 *ie; 375 size_t ie_len; 376 const u8 *wep_key[4]; 377 size_t wep_key_len[4]; 378 int wep_tx_keyidx; 379 int local_state_change; 380 381 /** 382 * p2p - Whether this connection is a P2P group 383 */ 384 int p2p; 385 386 const u8 *sae_data; 387 size_t sae_data_len; 388 389}; 390 391enum wps_mode { 392 WPS_MODE_NONE /* no WPS provisioning being used */, 393 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */, 394 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection 395 */ 396}; 397 398/** 399 * struct wpa_driver_associate_params - Association parameters 400 * Data for struct wpa_driver_ops::associate(). 401 */ 402struct wpa_driver_associate_params { 403 /** 404 * bssid - BSSID of the selected AP 405 * This can be %NULL, if ap_scan=2 mode is used and the driver is 406 * responsible for selecting with which BSS to associate. */ 407 const u8 *bssid; 408 409 /** 410 * bssid_hint - BSSID of a proposed AP 411 * 412 * This indicates which BSS has been found a suitable candidate for 413 * initial association for drivers that use driver/firmwate-based BSS 414 * selection. Unlike the @bssid parameter, @bssid_hint does not limit 415 * the driver from selecting other BSSes in the ESS. 416 */ 417 const u8 *bssid_hint; 418 419 /** 420 * ssid - The selected SSID 421 */ 422 const u8 *ssid; 423 424 /** 425 * ssid_len - Length of the SSID (1..32) 426 */ 427 size_t ssid_len; 428 429 /** 430 * freq - Frequency of the channel the selected AP is using 431 * Frequency that the selected AP is using (in MHz as 432 * reported in the scan results) 433 */ 434 int freq; 435 436 /** 437 * freq_hint - Frequency of the channel the proposed AP is using 438 * 439 * This provides a channel on which a suitable BSS has been found as a 440 * hint for the driver. Unlike the @freq parameter, @freq_hint does not 441 * limit the driver from selecting other channels for 442 * driver/firmware-based BSS selection. 443 */ 444 int freq_hint; 445 446 /** 447 * bg_scan_period - Background scan period in seconds, 0 to disable 448 * background scan, or -1 to indicate no change to default driver 449 * configuration 450 */ 451 int bg_scan_period; 452 453 /** 454 * beacon_int - Beacon interval for IBSS or 0 to use driver default 455 */ 456 int beacon_int; 457 458 /** 459 * wpa_ie - WPA information element for (Re)Association Request 460 * WPA information element to be included in (Re)Association 461 * Request (including information element id and length). Use 462 * of this WPA IE is optional. If the driver generates the WPA 463 * IE, it can use pairwise_suite, group_suite, and 464 * key_mgmt_suite to select proper algorithms. In this case, 465 * the driver has to notify wpa_supplicant about the used WPA 466 * IE by generating an event that the interface code will 467 * convert into EVENT_ASSOCINFO data (see below). 468 * 469 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE 470 * instead. The driver can determine which version is used by 471 * looking at the first byte of the IE (0xdd for WPA, 0x30 for 472 * WPA2/RSN). 473 * 474 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE. 475 */ 476 const u8 *wpa_ie; 477 478 /** 479 * wpa_ie_len - length of the wpa_ie 480 */ 481 size_t wpa_ie_len; 482 483 /** 484 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2 485 */ 486 unsigned int wpa_proto; 487 488 /** 489 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*) 490 * 491 * This is usually ignored if @wpa_ie is used. 492 */ 493 unsigned int pairwise_suite; 494 495 /** 496 * group_suite - Selected group cipher suite (WPA_CIPHER_*) 497 * 498 * This is usually ignored if @wpa_ie is used. 499 */ 500 unsigned int group_suite; 501 502 /** 503 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*) 504 * 505 * This is usually ignored if @wpa_ie is used. 506 */ 507 unsigned int key_mgmt_suite; 508 509 /** 510 * auth_alg - Allowed authentication algorithms 511 * Bit field of WPA_AUTH_ALG_* 512 */ 513 int auth_alg; 514 515 /** 516 * mode - Operation mode (infra/ibss) IEEE80211_MODE_* 517 */ 518 int mode; 519 520 /** 521 * wep_key - WEP keys for static WEP configuration 522 */ 523 const u8 *wep_key[4]; 524 525 /** 526 * wep_key_len - WEP key length for static WEP configuration 527 */ 528 size_t wep_key_len[4]; 529 530 /** 531 * wep_tx_keyidx - WEP TX key index for static WEP configuration 532 */ 533 int wep_tx_keyidx; 534 535 /** 536 * mgmt_frame_protection - IEEE 802.11w management frame protection 537 */ 538 enum mfp_options mgmt_frame_protection; 539 540 /** 541 * ft_ies - IEEE 802.11r / FT information elements 542 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys 543 * for fast transition, this parameter is set to include the IEs that 544 * are to be sent in the next FT Authentication Request message. 545 * update_ft_ies() handler is called to update the IEs for further 546 * FT messages in the sequence. 547 * 548 * The driver should use these IEs only if the target AP is advertising 549 * the same mobility domain as the one included in the MDIE here. 550 * 551 * In ap_scan=2 mode, the driver can use these IEs when moving to a new 552 * AP after the initial association. These IEs can only be used if the 553 * target AP is advertising support for FT and is using the same MDIE 554 * and SSID as the current AP. 555 * 556 * The driver is responsible for reporting the FT IEs received from the 557 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE 558 * type. update_ft_ies() handler will then be called with the FT IEs to 559 * include in the next frame in the authentication sequence. 560 */ 561 const u8 *ft_ies; 562 563 /** 564 * ft_ies_len - Length of ft_ies in bytes 565 */ 566 size_t ft_ies_len; 567 568 /** 569 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies) 570 * 571 * This value is provided to allow the driver interface easier access 572 * to the current mobility domain. This value is set to %NULL if no 573 * mobility domain is currently active. 574 */ 575 const u8 *ft_md; 576 577 /** 578 * passphrase - RSN passphrase for PSK 579 * 580 * This value is made available only for WPA/WPA2-Personal (PSK) and 581 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is 582 * the 8..63 character ASCII passphrase, if available. Please note that 583 * this can be %NULL if passphrase was not used to generate the PSK. In 584 * that case, the psk field must be used to fetch the PSK. 585 */ 586 const char *passphrase; 587 588 /** 589 * psk - RSN PSK (alternative for passphrase for PSK) 590 * 591 * This value is made available only for WPA/WPA2-Personal (PSK) and 592 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is 593 * the 32-octet (256-bit) PSK, if available. The driver wrapper should 594 * be prepared to handle %NULL value as an error. 595 */ 596 const u8 *psk; 597 598 /** 599 * drop_unencrypted - Enable/disable unencrypted frame filtering 600 * 601 * Configure the driver to drop all non-EAPOL frames (both receive and 602 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must 603 * still be allowed for key negotiation. 604 */ 605 int drop_unencrypted; 606 607 /** 608 * prev_bssid - Previously used BSSID in this ESS 609 * 610 * When not %NULL, this is a request to use reassociation instead of 611 * association. 612 */ 613 const u8 *prev_bssid; 614 615 /** 616 * wps - WPS mode 617 * 618 * If the driver needs to do special configuration for WPS association, 619 * this variable provides more information on what type of association 620 * is being requested. Most drivers should not need ot use this. 621 */ 622 enum wps_mode wps; 623 624 /** 625 * p2p - Whether this connection is a P2P group 626 */ 627 int p2p; 628 629 /** 630 * uapsd - UAPSD parameters for the network 631 * -1 = do not change defaults 632 * AP mode: 1 = enabled, 0 = disabled 633 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE 634 */ 635 int uapsd; 636 637 /** 638 * fixed_bssid - Whether to force this BSSID in IBSS mode 639 * 1 = Fix this BSSID and prevent merges. 640 * 0 = Do not fix BSSID. 641 */ 642 int fixed_bssid; 643 644 /** 645 * disable_ht - Disable HT (IEEE 802.11n) for this connection 646 */ 647 int disable_ht; 648 649 /** 650 * HT Capabilities over-rides. Only bits set in the mask will be used, 651 * and not all values are used by the kernel anyway. Currently, MCS, 652 * MPDU and MSDU fields are used. 653 */ 654 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */ 655 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */ 656 657#ifdef CONFIG_VHT_OVERRIDES 658 /** 659 * disable_vht - Disable VHT for this connection 660 */ 661 int disable_vht; 662 663 /** 664 * VHT capability overrides. 665 */ 666 const struct ieee80211_vht_capabilities *vhtcaps; 667 const struct ieee80211_vht_capabilities *vhtcaps_mask; 668#endif /* CONFIG_VHT_OVERRIDES */ 669}; 670 671enum hide_ssid { 672 NO_SSID_HIDING, 673 HIDDEN_SSID_ZERO_LEN, 674 HIDDEN_SSID_ZERO_CONTENTS 675}; 676 677struct wpa_driver_ap_params { 678 /** 679 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE 680 */ 681 u8 *head; 682 683 /** 684 * head_len - Length of the head buffer in octets 685 */ 686 size_t head_len; 687 688 /** 689 * tail - Beacon tail following TIM IE 690 */ 691 u8 *tail; 692 693 /** 694 * tail_len - Length of the tail buffer in octets 695 */ 696 size_t tail_len; 697 698 /** 699 * dtim_period - DTIM period 700 */ 701 int dtim_period; 702 703 /** 704 * beacon_int - Beacon interval 705 */ 706 int beacon_int; 707 708 /** 709 * basic_rates: -1 terminated array of basic rates in 100 kbps 710 * 711 * This parameter can be used to set a specific basic rate set for the 712 * BSS. If %NULL, default basic rate set is used. 713 */ 714 int *basic_rates; 715 716 /** 717 * proberesp - Probe Response template 718 * 719 * This is used by drivers that reply to Probe Requests internally in 720 * AP mode and require the full Probe Response template. 721 */ 722 u8 *proberesp; 723 724 /** 725 * proberesp_len - Length of the proberesp buffer in octets 726 */ 727 size_t proberesp_len; 728 729 /** 730 * ssid - The SSID to use in Beacon/Probe Response frames 731 */ 732 const u8 *ssid; 733 734 /** 735 * ssid_len - Length of the SSID (1..32) 736 */ 737 size_t ssid_len; 738 739 /** 740 * hide_ssid - Whether to hide the SSID 741 */ 742 enum hide_ssid hide_ssid; 743 744 /** 745 * pairwise_ciphers - WPA_CIPHER_* bitfield 746 */ 747 unsigned int pairwise_ciphers; 748 749 /** 750 * group_cipher - WPA_CIPHER_* 751 */ 752 unsigned int group_cipher; 753 754 /** 755 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield 756 */ 757 unsigned int key_mgmt_suites; 758 759 /** 760 * auth_algs - WPA_AUTH_ALG_* bitfield 761 */ 762 unsigned int auth_algs; 763 764 /** 765 * wpa_version - WPA_PROTO_* bitfield 766 */ 767 unsigned int wpa_version; 768 769 /** 770 * privacy - Whether privacy is used in the BSS 771 */ 772 int privacy; 773 774 /** 775 * beacon_ies - WPS/P2P IE(s) for Beacon frames 776 * 777 * This is used to add IEs like WPS IE and P2P IE by drivers that do 778 * not use the full Beacon template. 779 */ 780 const struct wpabuf *beacon_ies; 781 782 /** 783 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames 784 * 785 * This is used to add IEs like WPS IE and P2P IE by drivers that 786 * reply to Probe Request frames internally. 787 */ 788 const struct wpabuf *proberesp_ies; 789 790 /** 791 * assocresp_ies - WPS IE(s) for (Re)Association Response frames 792 * 793 * This is used to add IEs like WPS IE by drivers that reply to 794 * (Re)Association Request frames internally. 795 */ 796 const struct wpabuf *assocresp_ies; 797 798 /** 799 * isolate - Whether to isolate frames between associated stations 800 * 801 * If this is non-zero, the AP is requested to disable forwarding of 802 * frames between associated stations. 803 */ 804 int isolate; 805 806 /** 807 * cts_protect - Whether CTS protection is enabled 808 */ 809 int cts_protect; 810 811 /** 812 * preamble - Whether short preamble is enabled 813 */ 814 int preamble; 815 816 /** 817 * short_slot_time - Whether short slot time is enabled 818 * 819 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do 820 * not set (e.g., when 802.11g mode is not in use) 821 */ 822 int short_slot_time; 823 824 /** 825 * ht_opmode - HT operation mode or -1 if HT not in use 826 */ 827 int ht_opmode; 828 829 /** 830 * interworking - Whether Interworking is enabled 831 */ 832 int interworking; 833 834 /** 835 * hessid - Homogeneous ESS identifier or %NULL if not set 836 */ 837 const u8 *hessid; 838 839 /** 840 * access_network_type - Access Network Type (0..15) 841 * 842 * This is used for filtering Probe Request frames when Interworking is 843 * enabled. 844 */ 845 u8 access_network_type; 846 847 /** 848 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity 849 * 850 * This is used by driver which advertises this capability. 851 */ 852 int ap_max_inactivity; 853 854 /** 855 * disable_dgaf - Whether group-addressed frames are disabled 856 */ 857 int disable_dgaf; 858 859 /** 860 * osen - Whether OSEN security is enabled 861 */ 862 int osen; 863}; 864 865/** 866 * struct wpa_driver_capa - Driver capability information 867 */ 868struct wpa_driver_capa { 869#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001 870#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002 871#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004 872#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008 873#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010 874#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020 875#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040 876#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080 877 unsigned int key_mgmt; 878 879#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001 880#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002 881#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004 882#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008 883#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010 884#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020 885#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040 886#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080 887#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100 888#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200 889#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400 890#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800 891#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000 892 unsigned int enc; 893 894#define WPA_DRIVER_AUTH_OPEN 0x00000001 895#define WPA_DRIVER_AUTH_SHARED 0x00000002 896#define WPA_DRIVER_AUTH_LEAP 0x00000004 897 unsigned int auth; 898 899/* Driver generated WPA/RSN IE */ 900#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001 901/* Driver needs static WEP key setup after association command */ 902#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002 903/* Driver takes care of all DFS operations */ 904#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004 905/* Driver takes care of RSN 4-way handshake internally; PMK is configured with 906 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */ 907#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008 908#define WPA_DRIVER_FLAGS_WIRED 0x00000010 909/* Driver provides separate commands for authentication and association (SME in 910 * wpa_supplicant). */ 911#define WPA_DRIVER_FLAGS_SME 0x00000020 912/* Driver supports AP mode */ 913#define WPA_DRIVER_FLAGS_AP 0x00000040 914/* Driver needs static WEP key setup after association has been completed */ 915#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080 916/* unused: 0x00000100 */ 917/* Driver supports concurrent P2P operations */ 918#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200 919/* 920 * Driver uses the initial interface as a dedicated management interface, i.e., 921 * it cannot be used for P2P group operations or non-P2P purposes. 922 */ 923#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400 924/* This interface is P2P capable (P2P GO or P2P Client) */ 925#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800 926/* Driver supports station and key removal when stopping an AP */ 927#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000 928/* 929 * Driver uses the initial interface for P2P management interface and non-P2P 930 * purposes (e.g., connect to infra AP), but this interface cannot be used for 931 * P2P group operations. 932 */ 933#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000 934/* 935 * Driver is known to use sane error codes, i.e., when it indicates that 936 * something (e.g., association) fails, there was indeed a failure and the 937 * operation does not end up getting completed successfully later. 938 */ 939#define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000 940/* Driver supports off-channel TX */ 941#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000 942/* Driver indicates TX status events for EAPOL Data frames */ 943#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000 944/* Driver indicates TX status events for Deauth/Disassoc frames */ 945#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000 946/* Driver supports roaming (BSS selection) in firmware */ 947#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000 948/* Driver supports operating as a TDLS peer */ 949#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000 950/* Driver requires external TDLS setup/teardown/discovery */ 951#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000 952/* Driver indicates support for Probe Response offloading in AP mode */ 953#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000 954/* Driver supports U-APSD in AP mode */ 955#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000 956/* Driver supports inactivity timer in AP mode */ 957#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000 958/* Driver expects user space implementation of MLME in AP mode */ 959#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000 960/* Driver supports SAE with user space SME */ 961#define WPA_DRIVER_FLAGS_SAE 0x02000000 962/* Driver makes use of OBSS scan mechanism in wpa_supplicant */ 963#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000 964/* Driver supports IBSS (Ad-hoc) mode */ 965#define WPA_DRIVER_FLAGS_IBSS 0x08000000 966/* Driver supports radar detection */ 967#define WPA_DRIVER_FLAGS_RADAR 0x10000000 968/* Driver supports a dedicated interface for P2P Device */ 969#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000 970/* Driver supports QoS Mapping */ 971#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000 972/* Driver supports CSA in AP mode */ 973#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000 974 unsigned int flags; 975 976 int max_scan_ssids; 977 int max_sched_scan_ssids; 978 int sched_scan_supported; 979 int max_match_sets; 980 981 /** 982 * max_remain_on_chan - Maximum remain-on-channel duration in msec 983 */ 984 unsigned int max_remain_on_chan; 985 986 /** 987 * max_stations - Maximum number of associated stations the driver 988 * supports in AP mode 989 */ 990 unsigned int max_stations; 991 992 /** 993 * probe_resp_offloads - Bitmap of supported protocols by the driver 994 * for Probe Response offloading. 995 */ 996/* Driver Probe Response offloading support for WPS ver. 1 */ 997#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001 998/* Driver Probe Response offloading support for WPS ver. 2 */ 999#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002 1000/* Driver Probe Response offloading support for P2P */ 1001#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004 1002/* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */ 1003#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008 1004 unsigned int probe_resp_offloads; 1005 1006 unsigned int max_acl_mac_addrs; 1007 1008 /** 1009 * Number of supported concurrent channels 1010 */ 1011 unsigned int num_multichan_concurrent; 1012 1013 /** 1014 * extended_capa - extended capabilities in driver/device 1015 * 1016 * Must be allocated and freed by driver and the pointers must be 1017 * valid for the lifetime of the driver, i.e., freed in deinit() 1018 */ 1019 const u8 *extended_capa, *extended_capa_mask; 1020 unsigned int extended_capa_len; 1021}; 1022 1023 1024struct hostapd_data; 1025 1026struct hostap_sta_driver_data { 1027 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes; 1028 unsigned long current_tx_rate; 1029 unsigned long inactive_msec; 1030 unsigned long flags; 1031 unsigned long num_ps_buf_frames; 1032 unsigned long tx_retry_failed; 1033 unsigned long tx_retry_count; 1034 int last_rssi; 1035 int last_ack_rssi; 1036}; 1037 1038struct hostapd_sta_add_params { 1039 const u8 *addr; 1040 u16 aid; 1041 u16 capability; 1042 const u8 *supp_rates; 1043 size_t supp_rates_len; 1044 u16 listen_interval; 1045 const struct ieee80211_ht_capabilities *ht_capabilities; 1046 const struct ieee80211_vht_capabilities *vht_capabilities; 1047 int vht_opmode_enabled; 1048 u8 vht_opmode; 1049 u32 flags; /* bitmask of WPA_STA_* flags */ 1050 int set; /* Set STA parameters instead of add */ 1051 u8 qosinfo; 1052 const u8 *ext_capab; 1053 size_t ext_capab_len; 1054 const u8 *supp_channels; 1055 size_t supp_channels_len; 1056 const u8 *supp_oper_classes; 1057 size_t supp_oper_classes_len; 1058}; 1059 1060struct hostapd_freq_params { 1061 int mode; 1062 int freq; 1063 int channel; 1064 /* for HT */ 1065 int ht_enabled; 1066 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled, 1067 * secondary channel below primary, 1 = HT40 1068 * enabled, secondary channel above primary */ 1069 1070 /* for VHT */ 1071 int vht_enabled; 1072 1073 /* valid for both HT and VHT, center_freq2 is non-zero 1074 * only for bandwidth 80 and an 80+80 channel */ 1075 int center_freq1, center_freq2; 1076 int bandwidth; 1077}; 1078 1079struct mac_address { 1080 u8 addr[ETH_ALEN]; 1081}; 1082 1083struct hostapd_acl_params { 1084 u8 acl_policy; 1085 unsigned int num_mac_acl; 1086 struct mac_address mac_acl[0]; 1087}; 1088 1089enum wpa_driver_if_type { 1090 /** 1091 * WPA_IF_STATION - Station mode interface 1092 */ 1093 WPA_IF_STATION, 1094 1095 /** 1096 * WPA_IF_AP_VLAN - AP mode VLAN interface 1097 * 1098 * This interface shares its address and Beacon frame with the main 1099 * BSS. 1100 */ 1101 WPA_IF_AP_VLAN, 1102 1103 /** 1104 * WPA_IF_AP_BSS - AP mode BSS interface 1105 * 1106 * This interface has its own address and Beacon frame. 1107 */ 1108 WPA_IF_AP_BSS, 1109 1110 /** 1111 * WPA_IF_P2P_GO - P2P Group Owner 1112 */ 1113 WPA_IF_P2P_GO, 1114 1115 /** 1116 * WPA_IF_P2P_CLIENT - P2P Client 1117 */ 1118 WPA_IF_P2P_CLIENT, 1119 1120 /** 1121 * WPA_IF_P2P_GROUP - P2P Group interface (will become either 1122 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known) 1123 */ 1124 WPA_IF_P2P_GROUP, 1125 1126 /** 1127 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the 1128 * abstracted P2P Device function in the driver 1129 */ 1130 WPA_IF_P2P_DEVICE 1131}; 1132 1133struct wpa_init_params { 1134 void *global_priv; 1135 const u8 *bssid; 1136 const char *ifname; 1137 const u8 *ssid; 1138 size_t ssid_len; 1139 const char *test_socket; 1140 int use_pae_group_addr; 1141 char **bridge; 1142 size_t num_bridge; 1143 1144 u8 *own_addr; /* buffer for writing own MAC address */ 1145}; 1146 1147 1148struct wpa_bss_params { 1149 /** Interface name (for multi-SSID/VLAN support) */ 1150 const char *ifname; 1151 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */ 1152 int enabled; 1153 1154 int wpa; 1155 int ieee802_1x; 1156 int wpa_group; 1157 int wpa_pairwise; 1158 int wpa_key_mgmt; 1159 int rsn_preauth; 1160 enum mfp_options ieee80211w; 1161}; 1162 1163#define WPA_STA_AUTHORIZED BIT(0) 1164#define WPA_STA_WMM BIT(1) 1165#define WPA_STA_SHORT_PREAMBLE BIT(2) 1166#define WPA_STA_MFP BIT(3) 1167#define WPA_STA_TDLS_PEER BIT(4) 1168 1169enum tdls_oper { 1170 TDLS_DISCOVERY_REQ, 1171 TDLS_SETUP, 1172 TDLS_TEARDOWN, 1173 TDLS_ENABLE_LINK, 1174 TDLS_DISABLE_LINK, 1175 TDLS_ENABLE, 1176 TDLS_DISABLE 1177}; 1178 1179enum wnm_oper { 1180 WNM_SLEEP_ENTER_CONFIRM, 1181 WNM_SLEEP_ENTER_FAIL, 1182 WNM_SLEEP_EXIT_CONFIRM, 1183 WNM_SLEEP_EXIT_FAIL, 1184 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */ 1185 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */ 1186 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for 1187 * a STA */ 1188 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE 1189 * for a STA */ 1190 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */ 1191 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE 1192 * for a STA */ 1193 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */ 1194}; 1195 1196/* enum chan_width - Channel width definitions */ 1197enum chan_width { 1198 CHAN_WIDTH_20_NOHT, 1199 CHAN_WIDTH_20, 1200 CHAN_WIDTH_40, 1201 CHAN_WIDTH_80, 1202 CHAN_WIDTH_80P80, 1203 CHAN_WIDTH_160, 1204 CHAN_WIDTH_UNKNOWN 1205}; 1206 1207/** 1208 * struct wpa_signal_info - Information about channel signal quality 1209 */ 1210struct wpa_signal_info { 1211 u32 frequency; 1212 int above_threshold; 1213 int current_signal; 1214 int avg_signal; 1215 int current_noise; 1216 int current_txrate; 1217 enum chan_width chanwidth; 1218 int center_frq1; 1219 int center_frq2; 1220}; 1221 1222/** 1223 * struct beacon_data - Beacon data 1224 * @head: Head portion of Beacon frame (before TIM IE) 1225 * @tail: Tail portion of Beacon frame (after TIM IE) 1226 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL 1227 * @proberesp_ies: Extra information element(s) to add into Probe Response 1228 * frames or %NULL 1229 * @assocresp_ies: Extra information element(s) to add into (Re)Association 1230 * Response frames or %NULL 1231 * @probe_resp: Probe Response frame template 1232 * @head_len: Length of @head 1233 * @tail_len: Length of @tail 1234 * @beacon_ies_len: Length of beacon_ies in octets 1235 * @proberesp_ies_len: Length of proberesp_ies in octets 1236 * @proberesp_ies_len: Length of proberesp_ies in octets 1237 * @probe_resp_len: Length of probe response template (@probe_resp) 1238 */ 1239struct beacon_data { 1240 u8 *head, *tail; 1241 u8 *beacon_ies; 1242 u8 *proberesp_ies; 1243 u8 *assocresp_ies; 1244 u8 *probe_resp; 1245 1246 size_t head_len, tail_len; 1247 size_t beacon_ies_len; 1248 size_t proberesp_ies_len; 1249 size_t assocresp_ies_len; 1250 size_t probe_resp_len; 1251}; 1252 1253/** 1254 * struct csa_settings - Settings for channel switch command 1255 * @cs_count: Count in Beacon frames (TBTT) to perform the switch 1256 * @block_tx: 1 - block transmission for CSA period 1257 * @freq_params: Next channel frequency parameter 1258 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period 1259 * @beacon_after: Next beacon/probe resp/asooc resp info 1260 * @counter_offset_beacon: Offset to the count field in beacon's tail 1261 * @counter_offset_presp: Offset to the count field in probe resp. 1262 */ 1263struct csa_settings { 1264 u8 cs_count; 1265 u8 block_tx; 1266 1267 struct hostapd_freq_params freq_params; 1268 struct beacon_data beacon_csa; 1269 struct beacon_data beacon_after; 1270 1271 u16 counter_offset_beacon; 1272 u16 counter_offset_presp; 1273}; 1274 1275/* TDLS peer capabilities for send_tdls_mgmt() */ 1276enum tdls_peer_capability { 1277 TDLS_PEER_HT = BIT(0), 1278 TDLS_PEER_VHT = BIT(1), 1279 TDLS_PEER_WMM = BIT(2), 1280}; 1281 1282/** 1283 * struct wpa_driver_ops - Driver interface API definition 1284 * 1285 * This structure defines the API that each driver interface needs to implement 1286 * for core wpa_supplicant code. All driver specific functionality is captured 1287 * in this wrapper. 1288 */ 1289struct wpa_driver_ops { 1290 /** Name of the driver interface */ 1291 const char *name; 1292 /** One line description of the driver interface */ 1293 const char *desc; 1294 1295 /** 1296 * get_bssid - Get the current BSSID 1297 * @priv: private driver interface data 1298 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes) 1299 * 1300 * Returns: 0 on success, -1 on failure 1301 * 1302 * Query kernel driver for the current BSSID and copy it to bssid. 1303 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not 1304 * associated. 1305 */ 1306 int (*get_bssid)(void *priv, u8 *bssid); 1307 1308 /** 1309 * get_ssid - Get the current SSID 1310 * @priv: private driver interface data 1311 * @ssid: buffer for SSID (at least 32 bytes) 1312 * 1313 * Returns: Length of the SSID on success, -1 on failure 1314 * 1315 * Query kernel driver for the current SSID and copy it to ssid. 1316 * Returning zero is recommended if the STA is not associated. 1317 * 1318 * Note: SSID is an array of octets, i.e., it is not nul terminated and 1319 * can, at least in theory, contain control characters (including nul) 1320 * and as such, should be processed as binary data, not a printable 1321 * string. 1322 */ 1323 int (*get_ssid)(void *priv, u8 *ssid); 1324 1325 /** 1326 * set_key - Configure encryption key 1327 * @ifname: Interface name (for multi-SSID/VLAN support) 1328 * @priv: private driver interface data 1329 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP, 1330 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK, 1331 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256, 1332 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256, 1333 * %WPA_ALG_BIP_CMAC_256); 1334 * %WPA_ALG_NONE clears the key. 1335 * @addr: Address of the peer STA (BSSID of the current AP when setting 1336 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for 1337 * broadcast keys, %NULL for default keys that are used both for 1338 * broadcast and unicast; when clearing keys, %NULL is used to 1339 * indicate that both the broadcast-only and default key of the 1340 * specified key index is to be cleared 1341 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for 1342 * IGTK 1343 * @set_tx: configure this key as the default Tx key (only used when 1344 * driver does not support separate unicast/individual key 1345 * @seq: sequence number/packet number, seq_len octets, the next 1346 * packet number to be used for in replay protection; configured 1347 * for Rx keys (in most cases, this is only used with broadcast 1348 * keys and set to zero for unicast keys); %NULL if not set 1349 * @seq_len: length of the seq, depends on the algorithm: 1350 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets 1351 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key, 1352 * 8-byte Rx Mic Key 1353 * @key_len: length of the key buffer in octets (WEP: 5 or 13, 1354 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16) 1355 * 1356 * Returns: 0 on success, -1 on failure 1357 * 1358 * Configure the given key for the kernel driver. If the driver 1359 * supports separate individual keys (4 default keys + 1 individual), 1360 * addr can be used to determine whether the key is default or 1361 * individual. If only 4 keys are supported, the default key with key 1362 * index 0 is used as the individual key. STA must be configured to use 1363 * it as the default Tx key (set_tx is set) and accept Rx for all the 1364 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for 1365 * broadcast keys, so key index 0 is available for this kind of 1366 * configuration. 1367 * 1368 * Please note that TKIP keys include separate TX and RX MIC keys and 1369 * some drivers may expect them in different order than wpa_supplicant 1370 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets 1371 * will trigger Michael MIC errors. This can be fixed by changing the 1372 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key 1373 * in driver_*.c set_key() implementation, see driver_ndis.c for an 1374 * example on how this can be done. 1375 */ 1376 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg, 1377 const u8 *addr, int key_idx, int set_tx, 1378 const u8 *seq, size_t seq_len, 1379 const u8 *key, size_t key_len); 1380 1381 /** 1382 * init - Initialize driver interface 1383 * @ctx: context to be used when calling wpa_supplicant functions, 1384 * e.g., wpa_supplicant_event() 1385 * @ifname: interface name, e.g., wlan0 1386 * 1387 * Returns: Pointer to private data, %NULL on failure 1388 * 1389 * Initialize driver interface, including event processing for kernel 1390 * driver events (e.g., associated, scan results, Michael MIC failure). 1391 * This function can allocate a private configuration data area for 1392 * @ctx, file descriptor, interface name, etc. information that may be 1393 * needed in future driver operations. If this is not used, non-NULL 1394 * value will need to be returned because %NULL is used to indicate 1395 * failure. The returned value will be used as 'void *priv' data for 1396 * all other driver_ops functions. 1397 * 1398 * The main event loop (eloop.c) of wpa_supplicant can be used to 1399 * register callback for read sockets (eloop_register_read_sock()). 1400 * 1401 * See below for more information about events and 1402 * wpa_supplicant_event() function. 1403 */ 1404 void * (*init)(void *ctx, const char *ifname); 1405 1406 /** 1407 * deinit - Deinitialize driver interface 1408 * @priv: private driver interface data from init() 1409 * 1410 * Shut down driver interface and processing of driver events. Free 1411 * private data buffer if one was allocated in init() handler. 1412 */ 1413 void (*deinit)(void *priv); 1414 1415 /** 1416 * set_param - Set driver configuration parameters 1417 * @priv: private driver interface data from init() 1418 * @param: driver specific configuration parameters 1419 * 1420 * Returns: 0 on success, -1 on failure 1421 * 1422 * Optional handler for notifying driver interface about configuration 1423 * parameters (driver_param). 1424 */ 1425 int (*set_param)(void *priv, const char *param); 1426 1427 /** 1428 * set_countermeasures - Enable/disable TKIP countermeasures 1429 * @priv: private driver interface data 1430 * @enabled: 1 = countermeasures enabled, 0 = disabled 1431 * 1432 * Returns: 0 on success, -1 on failure 1433 * 1434 * Configure TKIP countermeasures. When these are enabled, the driver 1435 * should drop all received and queued frames that are using TKIP. 1436 */ 1437 int (*set_countermeasures)(void *priv, int enabled); 1438 1439 /** 1440 * deauthenticate - Request driver to deauthenticate 1441 * @priv: private driver interface data 1442 * @addr: peer address (BSSID of the AP) 1443 * @reason_code: 16-bit reason code to be sent in the deauthentication 1444 * frame 1445 * 1446 * Returns: 0 on success, -1 on failure 1447 */ 1448 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code); 1449 1450 /** 1451 * associate - Request driver to associate 1452 * @priv: private driver interface data 1453 * @params: association parameters 1454 * 1455 * Returns: 0 on success, -1 on failure 1456 */ 1457 int (*associate)(void *priv, 1458 struct wpa_driver_associate_params *params); 1459 1460 /** 1461 * add_pmkid - Add PMKSA cache entry to the driver 1462 * @priv: private driver interface data 1463 * @bssid: BSSID for the PMKSA cache entry 1464 * @pmkid: PMKID for the PMKSA cache entry 1465 * 1466 * Returns: 0 on success, -1 on failure 1467 * 1468 * This function is called when a new PMK is received, as a result of 1469 * either normal authentication or RSN pre-authentication. 1470 * 1471 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 1472 * associate(), add_pmkid() can be used to add new PMKSA cache entries 1473 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this 1474 * driver_ops function does not need to be implemented. Likewise, if 1475 * the driver does not support WPA, this function is not needed. 1476 */ 1477 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid); 1478 1479 /** 1480 * remove_pmkid - Remove PMKSA cache entry to the driver 1481 * @priv: private driver interface data 1482 * @bssid: BSSID for the PMKSA cache entry 1483 * @pmkid: PMKID for the PMKSA cache entry 1484 * 1485 * Returns: 0 on success, -1 on failure 1486 * 1487 * This function is called when the supplicant drops a PMKSA cache 1488 * entry for any reason. 1489 * 1490 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 1491 * associate(), remove_pmkid() can be used to synchronize PMKSA caches 1492 * between the driver and wpa_supplicant. If the driver uses wpa_ie 1493 * from wpa_supplicant, this driver_ops function does not need to be 1494 * implemented. Likewise, if the driver does not support WPA, this 1495 * function is not needed. 1496 */ 1497 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid); 1498 1499 /** 1500 * flush_pmkid - Flush PMKSA cache 1501 * @priv: private driver interface data 1502 * 1503 * Returns: 0 on success, -1 on failure 1504 * 1505 * This function is called when the supplicant drops all PMKSA cache 1506 * entries for any reason. 1507 * 1508 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 1509 * associate(), remove_pmkid() can be used to synchronize PMKSA caches 1510 * between the driver and wpa_supplicant. If the driver uses wpa_ie 1511 * from wpa_supplicant, this driver_ops function does not need to be 1512 * implemented. Likewise, if the driver does not support WPA, this 1513 * function is not needed. 1514 */ 1515 int (*flush_pmkid)(void *priv); 1516 1517 /** 1518 * get_capa - Get driver capabilities 1519 * @priv: private driver interface data 1520 * 1521 * Returns: 0 on success, -1 on failure 1522 * 1523 * Get driver/firmware/hardware capabilities. 1524 */ 1525 int (*get_capa)(void *priv, struct wpa_driver_capa *capa); 1526 1527 /** 1528 * poll - Poll driver for association information 1529 * @priv: private driver interface data 1530 * 1531 * This is an option callback that can be used when the driver does not 1532 * provide event mechanism for association events. This is called when 1533 * receiving WPA EAPOL-Key messages that require association 1534 * information. The driver interface is supposed to generate associnfo 1535 * event before returning from this callback function. In addition, the 1536 * driver interface should generate an association event after having 1537 * sent out associnfo. 1538 */ 1539 void (*poll)(void *priv); 1540 1541 /** 1542 * get_ifname - Get interface name 1543 * @priv: private driver interface data 1544 * 1545 * Returns: Pointer to the interface name. This can differ from the 1546 * interface name used in init() call. Init() is called first. 1547 * 1548 * This optional function can be used to allow the driver interface to 1549 * replace the interface name with something else, e.g., based on an 1550 * interface mapping from a more descriptive name. 1551 */ 1552 const char * (*get_ifname)(void *priv); 1553 1554 /** 1555 * get_mac_addr - Get own MAC address 1556 * @priv: private driver interface data 1557 * 1558 * Returns: Pointer to own MAC address or %NULL on failure 1559 * 1560 * This optional function can be used to get the own MAC address of the 1561 * device from the driver interface code. This is only needed if the 1562 * l2_packet implementation for the OS does not provide easy access to 1563 * a MAC address. */ 1564 const u8 * (*get_mac_addr)(void *priv); 1565 1566 /** 1567 * send_eapol - Optional function for sending EAPOL packets 1568 * @priv: private driver interface data 1569 * @dest: Destination MAC address 1570 * @proto: Ethertype 1571 * @data: EAPOL packet starting with IEEE 802.1X header 1572 * @data_len: Size of the EAPOL packet 1573 * 1574 * Returns: 0 on success, -1 on failure 1575 * 1576 * This optional function can be used to override l2_packet operations 1577 * with driver specific functionality. If this function pointer is set, 1578 * l2_packet module is not used at all and the driver interface code is 1579 * responsible for receiving and sending all EAPOL packets. The 1580 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX 1581 * event. The driver interface is required to implement get_mac_addr() 1582 * handler if send_eapol() is used. 1583 */ 1584 int (*send_eapol)(void *priv, const u8 *dest, u16 proto, 1585 const u8 *data, size_t data_len); 1586 1587 /** 1588 * set_operstate - Sets device operating state to DORMANT or UP 1589 * @priv: private driver interface data 1590 * @state: 0 = dormant, 1 = up 1591 * Returns: 0 on success, -1 on failure 1592 * 1593 * This is an optional function that can be used on operating systems 1594 * that support a concept of controlling network device state from user 1595 * space applications. This function, if set, gets called with 1596 * state = 1 when authentication has been completed and with state = 0 1597 * when connection is lost. 1598 */ 1599 int (*set_operstate)(void *priv, int state); 1600 1601 /** 1602 * mlme_setprotection - MLME-SETPROTECTION.request primitive 1603 * @priv: Private driver interface data 1604 * @addr: Address of the station for which to set protection (may be 1605 * %NULL for group keys) 1606 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_* 1607 * @key_type: MLME_SETPROTECTION_KEY_TYPE_* 1608 * Returns: 0 on success, -1 on failure 1609 * 1610 * This is an optional function that can be used to set the driver to 1611 * require protection for Tx and/or Rx frames. This uses the layer 1612 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1 1613 * (MLME-SETPROTECTION.request). Many drivers do not use explicit 1614 * set protection operation; instead, they set protection implicitly 1615 * based on configured keys. 1616 */ 1617 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type, 1618 int key_type); 1619 1620 /** 1621 * get_hw_feature_data - Get hardware support data (channels and rates) 1622 * @priv: Private driver interface data 1623 * @num_modes: Variable for returning the number of returned modes 1624 * flags: Variable for returning hardware feature flags 1625 * Returns: Pointer to allocated hardware data on success or %NULL on 1626 * failure. Caller is responsible for freeing this. 1627 */ 1628 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv, 1629 u16 *num_modes, 1630 u16 *flags); 1631 1632 /** 1633 * send_mlme - Send management frame from MLME 1634 * @priv: Private driver interface data 1635 * @data: IEEE 802.11 management frame with IEEE 802.11 header 1636 * @data_len: Size of the management frame 1637 * @noack: Do not wait for this frame to be acked (disable retries) 1638 * Returns: 0 on success, -1 on failure 1639 */ 1640 int (*send_mlme)(void *priv, const u8 *data, size_t data_len, 1641 int noack); 1642 1643 /** 1644 * update_ft_ies - Update FT (IEEE 802.11r) IEs 1645 * @priv: Private driver interface data 1646 * @md: Mobility domain (2 octets) (also included inside ies) 1647 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs 1648 * @ies_len: Length of FT IEs in bytes 1649 * Returns: 0 on success, -1 on failure 1650 * 1651 * The supplicant uses this callback to let the driver know that keying 1652 * material for FT is available and that the driver can use the 1653 * provided IEs in the next message in FT authentication sequence. 1654 * 1655 * This function is only needed for driver that support IEEE 802.11r 1656 * (Fast BSS Transition). 1657 */ 1658 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies, 1659 size_t ies_len); 1660 1661 /** 1662 * send_ft_action - Send FT Action frame (IEEE 802.11r) 1663 * @priv: Private driver interface data 1664 * @action: Action field value 1665 * @target_ap: Target AP address 1666 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body) 1667 * @ies_len: Length of FT IEs in bytes 1668 * Returns: 0 on success, -1 on failure 1669 * 1670 * The supplicant uses this callback to request the driver to transmit 1671 * an FT Action frame (action category 6) for over-the-DS fast BSS 1672 * transition. 1673 */ 1674 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap, 1675 const u8 *ies, size_t ies_len); 1676 1677 /** 1678 * get_scan_results2 - Fetch the latest scan results 1679 * @priv: private driver interface data 1680 * 1681 * Returns: Allocated buffer of scan results (caller is responsible for 1682 * freeing the data structure) on success, NULL on failure 1683 */ 1684 struct wpa_scan_results * (*get_scan_results2)(void *priv); 1685 1686 /** 1687 * set_country - Set country 1688 * @priv: Private driver interface data 1689 * @alpha2: country to which to switch to 1690 * Returns: 0 on success, -1 on failure 1691 * 1692 * This function is for drivers which support some form 1693 * of setting a regulatory domain. 1694 */ 1695 int (*set_country)(void *priv, const char *alpha2); 1696 1697 /** 1698 * get_country - Get country 1699 * @priv: Private driver interface data 1700 * @alpha2: Buffer for returning country code (at least 3 octets) 1701 * Returns: 0 on success, -1 on failure 1702 */ 1703 int (*get_country)(void *priv, char *alpha2); 1704 1705 /** 1706 * global_init - Global driver initialization 1707 * Returns: Pointer to private data (global), %NULL on failure 1708 * 1709 * This optional function is called to initialize the driver wrapper 1710 * for global data, i.e., data that applies to all interfaces. If this 1711 * function is implemented, global_deinit() will also need to be 1712 * implemented to free the private data. The driver will also likely 1713 * use init2() function instead of init() to get the pointer to global 1714 * data available to per-interface initializer. 1715 */ 1716 void * (*global_init)(void); 1717 1718 /** 1719 * global_deinit - Global driver deinitialization 1720 * @priv: private driver global data from global_init() 1721 * 1722 * Terminate any global driver related functionality and free the 1723 * global data structure. 1724 */ 1725 void (*global_deinit)(void *priv); 1726 1727 /** 1728 * init2 - Initialize driver interface (with global data) 1729 * @ctx: context to be used when calling wpa_supplicant functions, 1730 * e.g., wpa_supplicant_event() 1731 * @ifname: interface name, e.g., wlan0 1732 * @global_priv: private driver global data from global_init() 1733 * Returns: Pointer to private data, %NULL on failure 1734 * 1735 * This function can be used instead of init() if the driver wrapper 1736 * uses global data. 1737 */ 1738 void * (*init2)(void *ctx, const char *ifname, void *global_priv); 1739 1740 /** 1741 * get_interfaces - Get information about available interfaces 1742 * @global_priv: private driver global data from global_init() 1743 * Returns: Allocated buffer of interface information (caller is 1744 * responsible for freeing the data structure) on success, NULL on 1745 * failure 1746 */ 1747 struct wpa_interface_info * (*get_interfaces)(void *global_priv); 1748 1749 /** 1750 * scan2 - Request the driver to initiate scan 1751 * @priv: private driver interface data 1752 * @params: Scan parameters 1753 * 1754 * Returns: 0 on success, -1 on failure 1755 * 1756 * Once the scan results are ready, the driver should report scan 1757 * results event for wpa_supplicant which will eventually request the 1758 * results with wpa_driver_get_scan_results2(). 1759 */ 1760 int (*scan2)(void *priv, struct wpa_driver_scan_params *params); 1761 1762 /** 1763 * authenticate - Request driver to authenticate 1764 * @priv: private driver interface data 1765 * @params: authentication parameters 1766 * Returns: 0 on success, -1 on failure 1767 * 1768 * This is an optional function that can be used with drivers that 1769 * support separate authentication and association steps, i.e., when 1770 * wpa_supplicant can act as the SME. If not implemented, associate() 1771 * function is expected to take care of IEEE 802.11 authentication, 1772 * too. 1773 */ 1774 int (*authenticate)(void *priv, 1775 struct wpa_driver_auth_params *params); 1776 1777 /** 1778 * set_ap - Set Beacon and Probe Response information for AP mode 1779 * @priv: Private driver interface data 1780 * @params: Parameters to use in AP mode 1781 * 1782 * This function is used to configure Beacon template and/or extra IEs 1783 * to add for Beacon and Probe Response frames for the driver in 1784 * AP mode. The driver is responsible for building the full Beacon 1785 * frame by concatenating the head part with TIM IE generated by the 1786 * driver/firmware and finishing with the tail part. Depending on the 1787 * driver architectue, this can be done either by using the full 1788 * template or the set of additional IEs (e.g., WPS and P2P IE). 1789 * Similarly, Probe Response processing depends on the driver design. 1790 * If the driver (or firmware) takes care of replying to Probe Request 1791 * frames, the extra IEs provided here needs to be added to the Probe 1792 * Response frames. 1793 * 1794 * Returns: 0 on success, -1 on failure 1795 */ 1796 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params); 1797 1798 /** 1799 * set_acl - Set ACL in AP mode 1800 * @priv: Private driver interface data 1801 * @params: Parameters to configure ACL 1802 * Returns: 0 on success, -1 on failure 1803 * 1804 * This is used only for the drivers which support MAC address ACL. 1805 */ 1806 int (*set_acl)(void *priv, struct hostapd_acl_params *params); 1807 1808 /** 1809 * hapd_init - Initialize driver interface (hostapd only) 1810 * @hapd: Pointer to hostapd context 1811 * @params: Configuration for the driver wrapper 1812 * Returns: Pointer to private data, %NULL on failure 1813 * 1814 * This function is used instead of init() or init2() when the driver 1815 * wrapper is used with hostapd. 1816 */ 1817 void * (*hapd_init)(struct hostapd_data *hapd, 1818 struct wpa_init_params *params); 1819 1820 /** 1821 * hapd_deinit - Deinitialize driver interface (hostapd only) 1822 * @priv: Private driver interface data from hapd_init() 1823 */ 1824 void (*hapd_deinit)(void *priv); 1825 1826 /** 1827 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only) 1828 * @priv: Private driver interface data 1829 * @params: BSS parameters 1830 * Returns: 0 on success, -1 on failure 1831 * 1832 * This is an optional function to configure the kernel driver to 1833 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This 1834 * can be left undefined (set to %NULL) if IEEE 802.1X support is 1835 * always enabled and the driver uses set_ap() to set WPA/RSN IE 1836 * for Beacon frames. 1837 * 1838 * DEPRECATED - use set_ap() instead 1839 */ 1840 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params); 1841 1842 /** 1843 * set_privacy - Enable/disable privacy (AP only) 1844 * @priv: Private driver interface data 1845 * @enabled: 1 = privacy enabled, 0 = disabled 1846 * Returns: 0 on success, -1 on failure 1847 * 1848 * This is an optional function to configure privacy field in the 1849 * kernel driver for Beacon frames. This can be left undefined (set to 1850 * %NULL) if the driver uses the Beacon template from set_ap(). 1851 * 1852 * DEPRECATED - use set_ap() instead 1853 */ 1854 int (*set_privacy)(void *priv, int enabled); 1855 1856 /** 1857 * get_seqnum - Fetch the current TSC/packet number (AP only) 1858 * @ifname: The interface name (main or virtual) 1859 * @priv: Private driver interface data 1860 * @addr: MAC address of the station or %NULL for group keys 1861 * @idx: Key index 1862 * @seq: Buffer for returning the latest used TSC/packet number 1863 * Returns: 0 on success, -1 on failure 1864 * 1865 * This function is used to fetch the last used TSC/packet number for 1866 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group 1867 * keys, so there is no strict requirement on implementing support for 1868 * unicast keys (i.e., addr != %NULL). 1869 */ 1870 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr, 1871 int idx, u8 *seq); 1872 1873 /** 1874 * flush - Flush all association stations (AP only) 1875 * @priv: Private driver interface data 1876 * Returns: 0 on success, -1 on failure 1877 * 1878 * This function requests the driver to disassociate all associated 1879 * stations. This function does not need to be implemented if the 1880 * driver does not process association frames internally. 1881 */ 1882 int (*flush)(void *priv); 1883 1884 /** 1885 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP) 1886 * @priv: Private driver interface data 1887 * @elem: Information elements 1888 * @elem_len: Length of the elem buffer in octets 1889 * Returns: 0 on success, -1 on failure 1890 * 1891 * This is an optional function to add information elements in the 1892 * kernel driver for Beacon and Probe Response frames. This can be left 1893 * undefined (set to %NULL) if the driver uses the Beacon template from 1894 * set_ap(). 1895 * 1896 * DEPRECATED - use set_ap() instead 1897 */ 1898 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len); 1899 1900 /** 1901 * read_sta_data - Fetch station data 1902 * @priv: Private driver interface data 1903 * @data: Buffer for returning station information 1904 * @addr: MAC address of the station 1905 * Returns: 0 on success, -1 on failure 1906 */ 1907 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data, 1908 const u8 *addr); 1909 1910 /** 1911 * hapd_send_eapol - Send an EAPOL packet (AP only) 1912 * @priv: private driver interface data 1913 * @addr: Destination MAC address 1914 * @data: EAPOL packet starting with IEEE 802.1X header 1915 * @data_len: Length of the EAPOL packet in octets 1916 * @encrypt: Whether the frame should be encrypted 1917 * @own_addr: Source MAC address 1918 * @flags: WPA_STA_* flags for the destination station 1919 * 1920 * Returns: 0 on success, -1 on failure 1921 */ 1922 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data, 1923 size_t data_len, int encrypt, 1924 const u8 *own_addr, u32 flags); 1925 1926 /** 1927 * sta_deauth - Deauthenticate a station (AP only) 1928 * @priv: Private driver interface data 1929 * @own_addr: Source address and BSSID for the Deauthentication frame 1930 * @addr: MAC address of the station to deauthenticate 1931 * @reason: Reason code for the Deauthentiation frame 1932 * Returns: 0 on success, -1 on failure 1933 * 1934 * This function requests a specific station to be deauthenticated and 1935 * a Deauthentication frame to be sent to it. 1936 */ 1937 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr, 1938 int reason); 1939 1940 /** 1941 * sta_disassoc - Disassociate a station (AP only) 1942 * @priv: Private driver interface data 1943 * @own_addr: Source address and BSSID for the Disassociation frame 1944 * @addr: MAC address of the station to disassociate 1945 * @reason: Reason code for the Disassociation frame 1946 * Returns: 0 on success, -1 on failure 1947 * 1948 * This function requests a specific station to be disassociated and 1949 * a Disassociation frame to be sent to it. 1950 */ 1951 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr, 1952 int reason); 1953 1954 /** 1955 * sta_remove - Remove a station entry (AP only) 1956 * @priv: Private driver interface data 1957 * @addr: MAC address of the station to be removed 1958 * Returns: 0 on success, -1 on failure 1959 */ 1960 int (*sta_remove)(void *priv, const u8 *addr); 1961 1962 /** 1963 * hapd_get_ssid - Get the current SSID (AP only) 1964 * @priv: Private driver interface data 1965 * @buf: Buffer for returning the SSID 1966 * @len: Maximum length of the buffer 1967 * Returns: Length of the SSID on success, -1 on failure 1968 * 1969 * This function need not be implemented if the driver uses Beacon 1970 * template from set_ap() and does not reply to Probe Request frames. 1971 */ 1972 int (*hapd_get_ssid)(void *priv, u8 *buf, int len); 1973 1974 /** 1975 * hapd_set_ssid - Set SSID (AP only) 1976 * @priv: Private driver interface data 1977 * @buf: SSID 1978 * @len: Length of the SSID in octets 1979 * Returns: 0 on success, -1 on failure 1980 * 1981 * DEPRECATED - use set_ap() instead 1982 */ 1983 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len); 1984 1985 /** 1986 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP) 1987 * @priv: Private driver interface data 1988 * @enabled: 1 = countermeasures enabled, 0 = disabled 1989 * Returns: 0 on success, -1 on failure 1990 * 1991 * This need not be implemented if the driver does not take care of 1992 * association processing. 1993 */ 1994 int (*hapd_set_countermeasures)(void *priv, int enabled); 1995 1996 /** 1997 * sta_add - Add a station entry 1998 * @priv: Private driver interface data 1999 * @params: Station parameters 2000 * Returns: 0 on success, -1 on failure 2001 * 2002 * This function is used to add a station entry to the driver once the 2003 * station has completed association. This is only used if the driver 2004 * does not take care of association processing. 2005 * 2006 * With TDLS, this function is also used to add or set (params->set 1) 2007 * TDLS peer entries. 2008 */ 2009 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params); 2010 2011 /** 2012 * get_inact_sec - Get station inactivity duration (AP only) 2013 * @priv: Private driver interface data 2014 * @addr: Station address 2015 * Returns: Number of seconds station has been inactive, -1 on failure 2016 */ 2017 int (*get_inact_sec)(void *priv, const u8 *addr); 2018 2019 /** 2020 * sta_clear_stats - Clear station statistics (AP only) 2021 * @priv: Private driver interface data 2022 * @addr: Station address 2023 * Returns: 0 on success, -1 on failure 2024 */ 2025 int (*sta_clear_stats)(void *priv, const u8 *addr); 2026 2027 /** 2028 * set_freq - Set channel/frequency (AP only) 2029 * @priv: Private driver interface data 2030 * @freq: Channel parameters 2031 * Returns: 0 on success, -1 on failure 2032 */ 2033 int (*set_freq)(void *priv, struct hostapd_freq_params *freq); 2034 2035 /** 2036 * set_rts - Set RTS threshold 2037 * @priv: Private driver interface data 2038 * @rts: RTS threshold in octets 2039 * Returns: 0 on success, -1 on failure 2040 */ 2041 int (*set_rts)(void *priv, int rts); 2042 2043 /** 2044 * set_frag - Set fragmentation threshold 2045 * @priv: Private driver interface data 2046 * @frag: Fragmentation threshold in octets 2047 * Returns: 0 on success, -1 on failure 2048 */ 2049 int (*set_frag)(void *priv, int frag); 2050 2051 /** 2052 * sta_set_flags - Set station flags (AP only) 2053 * @priv: Private driver interface data 2054 * @addr: Station address 2055 * @total_flags: Bitmap of all WPA_STA_* flags currently set 2056 * @flags_or: Bitmap of WPA_STA_* flags to add 2057 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask 2058 * Returns: 0 on success, -1 on failure 2059 */ 2060 int (*sta_set_flags)(void *priv, const u8 *addr, 2061 int total_flags, int flags_or, int flags_and); 2062 2063 /** 2064 * set_tx_queue_params - Set TX queue parameters 2065 * @priv: Private driver interface data 2066 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK) 2067 * @aifs: AIFS 2068 * @cw_min: cwMin 2069 * @cw_max: cwMax 2070 * @burst_time: Maximum length for bursting in 0.1 msec units 2071 */ 2072 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min, 2073 int cw_max, int burst_time); 2074 2075 /** 2076 * if_add - Add a virtual interface 2077 * @priv: Private driver interface data 2078 * @type: Interface type 2079 * @ifname: Interface name for the new virtual interface 2080 * @addr: Local address to use for the interface or %NULL to use the 2081 * parent interface address 2082 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces 2083 * @drv_priv: Pointer for overwriting the driver context or %NULL if 2084 * not allowed (applies only to %WPA_IF_AP_BSS type) 2085 * @force_ifname: Buffer for returning an interface name that the 2086 * driver ended up using if it differs from the requested ifname 2087 * @if_addr: Buffer for returning the allocated interface address 2088 * (this may differ from the requested addr if the driver cannot 2089 * change interface address) 2090 * @bridge: Bridge interface to use or %NULL if no bridge configured 2091 * @use_existing: Whether to allow existing interface to be used 2092 * Returns: 0 on success, -1 on failure 2093 */ 2094 int (*if_add)(void *priv, enum wpa_driver_if_type type, 2095 const char *ifname, const u8 *addr, void *bss_ctx, 2096 void **drv_priv, char *force_ifname, u8 *if_addr, 2097 const char *bridge, int use_existing); 2098 2099 /** 2100 * if_remove - Remove a virtual interface 2101 * @priv: Private driver interface data 2102 * @type: Interface type 2103 * @ifname: Interface name of the virtual interface to be removed 2104 * Returns: 0 on success, -1 on failure 2105 */ 2106 int (*if_remove)(void *priv, enum wpa_driver_if_type type, 2107 const char *ifname); 2108 2109 /** 2110 * set_sta_vlan - Bind a station into a specific interface (AP only) 2111 * @priv: Private driver interface data 2112 * @ifname: Interface (main or virtual BSS or VLAN) 2113 * @addr: MAC address of the associated station 2114 * @vlan_id: VLAN ID 2115 * Returns: 0 on success, -1 on failure 2116 * 2117 * This function is used to bind a station to a specific virtual 2118 * interface. It is only used if when virtual interfaces are supported, 2119 * e.g., to assign stations to different VLAN interfaces based on 2120 * information from a RADIUS server. This allows separate broadcast 2121 * domains to be used with a single BSS. 2122 */ 2123 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname, 2124 int vlan_id); 2125 2126 /** 2127 * commit - Optional commit changes handler (AP only) 2128 * @priv: driver private data 2129 * Returns: 0 on success, -1 on failure 2130 * 2131 * This optional handler function can be registered if the driver 2132 * interface implementation needs to commit changes (e.g., by setting 2133 * network interface up) at the end of initial configuration. If set, 2134 * this handler will be called after initial setup has been completed. 2135 */ 2136 int (*commit)(void *priv); 2137 2138 /** 2139 * send_ether - Send an ethernet packet (AP only) 2140 * @priv: private driver interface data 2141 * @dst: Destination MAC address 2142 * @src: Source MAC address 2143 * @proto: Ethertype 2144 * @data: EAPOL packet starting with IEEE 802.1X header 2145 * @data_len: Length of the EAPOL packet in octets 2146 * Returns: 0 on success, -1 on failure 2147 */ 2148 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto, 2149 const u8 *data, size_t data_len); 2150 2151 /** 2152 * set_radius_acl_auth - Notification of RADIUS ACL change 2153 * @priv: Private driver interface data 2154 * @mac: MAC address of the station 2155 * @accepted: Whether the station was accepted 2156 * @session_timeout: Session timeout for the station 2157 * Returns: 0 on success, -1 on failure 2158 */ 2159 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted, 2160 u32 session_timeout); 2161 2162 /** 2163 * set_radius_acl_expire - Notification of RADIUS ACL expiration 2164 * @priv: Private driver interface data 2165 * @mac: MAC address of the station 2166 * Returns: 0 on success, -1 on failure 2167 */ 2168 int (*set_radius_acl_expire)(void *priv, const u8 *mac); 2169 2170 /** 2171 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP) 2172 * @priv: Private driver interface data 2173 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s) 2174 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove 2175 * extra IE(s) 2176 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL 2177 * to remove extra IE(s) 2178 * Returns: 0 on success, -1 on failure 2179 * 2180 * This is an optional function to add WPS IE in the kernel driver for 2181 * Beacon and Probe Response frames. This can be left undefined (set 2182 * to %NULL) if the driver uses the Beacon template from set_ap() 2183 * and does not process Probe Request frames. If the driver takes care 2184 * of (Re)Association frame processing, the assocresp buffer includes 2185 * WPS IE(s) that need to be added to (Re)Association Response frames 2186 * whenever a (Re)Association Request frame indicated use of WPS. 2187 * 2188 * This will also be used to add P2P IE(s) into Beacon/Probe Response 2189 * frames when operating as a GO. The driver is responsible for adding 2190 * timing related attributes (e.g., NoA) in addition to the IEs 2191 * included here by appending them after these buffers. This call is 2192 * also used to provide Probe Response IEs for P2P Listen state 2193 * operations for drivers that generate the Probe Response frames 2194 * internally. 2195 * 2196 * DEPRECATED - use set_ap() instead 2197 */ 2198 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon, 2199 const struct wpabuf *proberesp, 2200 const struct wpabuf *assocresp); 2201 2202 /** 2203 * set_supp_port - Set IEEE 802.1X Supplicant Port status 2204 * @priv: Private driver interface data 2205 * @authorized: Whether the port is authorized 2206 * Returns: 0 on success, -1 on failure 2207 */ 2208 int (*set_supp_port)(void *priv, int authorized); 2209 2210 /** 2211 * set_wds_sta - Bind a station into a 4-address WDS (AP only) 2212 * @priv: Private driver interface data 2213 * @addr: MAC address of the associated station 2214 * @aid: Association ID 2215 * @val: 1 = bind to 4-address WDS; 0 = unbind 2216 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL 2217 * to indicate that bridge is not to be used 2218 * @ifname_wds: Buffer to return the interface name for the new WDS 2219 * station or %NULL to indicate name is not returned. 2220 * Returns: 0 on success, -1 on failure 2221 */ 2222 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val, 2223 const char *bridge_ifname, char *ifname_wds); 2224 2225 /** 2226 * send_action - Transmit an Action frame 2227 * @priv: Private driver interface data 2228 * @freq: Frequency (in MHz) of the channel 2229 * @wait: Time to wait off-channel for a response (in ms), or zero 2230 * @dst: Destination MAC address (Address 1) 2231 * @src: Source MAC address (Address 2) 2232 * @bssid: BSSID (Address 3) 2233 * @data: Frame body 2234 * @data_len: data length in octets 2235 @ @no_cck: Whether CCK rates must not be used to transmit this frame 2236 * Returns: 0 on success, -1 on failure 2237 * 2238 * This command can be used to request the driver to transmit an action 2239 * frame to the specified destination. 2240 * 2241 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will 2242 * be transmitted on the given channel and the device will wait for a 2243 * response on that channel for the given wait time. 2244 * 2245 * If the flag is not set, the wait time will be ignored. In this case, 2246 * if a remain-on-channel duration is in progress, the frame must be 2247 * transmitted on that channel; alternatively the frame may be sent on 2248 * the current operational channel (if in associated state in station 2249 * mode or while operating as an AP.) 2250 */ 2251 int (*send_action)(void *priv, unsigned int freq, unsigned int wait, 2252 const u8 *dst, const u8 *src, const u8 *bssid, 2253 const u8 *data, size_t data_len, int no_cck); 2254 2255 /** 2256 * send_action_cancel_wait - Cancel action frame TX wait 2257 * @priv: Private driver interface data 2258 * 2259 * This command cancels the wait time associated with sending an action 2260 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is 2261 * set in the driver flags. 2262 */ 2263 void (*send_action_cancel_wait)(void *priv); 2264 2265 /** 2266 * remain_on_channel - Remain awake on a channel 2267 * @priv: Private driver interface data 2268 * @freq: Frequency (in MHz) of the channel 2269 * @duration: Duration in milliseconds 2270 * Returns: 0 on success, -1 on failure 2271 * 2272 * This command is used to request the driver to remain awake on the 2273 * specified channel for the specified duration and report received 2274 * Action frames with EVENT_RX_MGMT events. Optionally, received 2275 * Probe Request frames may also be requested to be reported by calling 2276 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ. 2277 * 2278 * The driver may not be at the requested channel when this function 2279 * returns, i.e., the return code is only indicating whether the 2280 * request was accepted. The caller will need to wait until the 2281 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has 2282 * completed the channel change. This may take some time due to other 2283 * need for the radio and the caller should be prepared to timing out 2284 * its wait since there are no guarantees on when this request can be 2285 * executed. 2286 */ 2287 int (*remain_on_channel)(void *priv, unsigned int freq, 2288 unsigned int duration); 2289 2290 /** 2291 * cancel_remain_on_channel - Cancel remain-on-channel operation 2292 * @priv: Private driver interface data 2293 * 2294 * This command can be used to cancel a remain-on-channel operation 2295 * before its originally requested duration has passed. This could be 2296 * used, e.g., when remain_on_channel() is used to request extra time 2297 * to receive a response to an Action frame and the response is 2298 * received when there is still unneeded time remaining on the 2299 * remain-on-channel operation. 2300 */ 2301 int (*cancel_remain_on_channel)(void *priv); 2302 2303 /** 2304 * probe_req_report - Request Probe Request frames to be indicated 2305 * @priv: Private driver interface data 2306 * @report: Whether to report received Probe Request frames 2307 * Returns: 0 on success, -1 on failure (or if not supported) 2308 * 2309 * This command can be used to request the driver to indicate when 2310 * Probe Request frames are received with EVENT_RX_PROBE_REQ events. 2311 * Since this operation may require extra resources, e.g., due to less 2312 * optimal hardware/firmware RX filtering, many drivers may disable 2313 * Probe Request reporting at least in station mode. This command is 2314 * used to notify the driver when the Probe Request frames need to be 2315 * reported, e.g., during remain-on-channel operations. 2316 */ 2317 int (*probe_req_report)(void *priv, int report); 2318 2319 /** 2320 * deinit_ap - Deinitialize AP mode 2321 * @priv: Private driver interface data 2322 * Returns: 0 on success, -1 on failure (or if not supported) 2323 * 2324 * This optional function can be used to disable AP mode related 2325 * configuration. If the interface was not dynamically added, 2326 * change the driver mode to station mode to allow normal station 2327 * operations like scanning to be completed. 2328 */ 2329 int (*deinit_ap)(void *priv); 2330 2331 /** 2332 * deinit_p2p_cli - Deinitialize P2P client mode 2333 * @priv: Private driver interface data 2334 * Returns: 0 on success, -1 on failure (or if not supported) 2335 * 2336 * This optional function can be used to disable P2P client mode. If the 2337 * interface was not dynamically added, change the interface type back 2338 * to station mode. 2339 */ 2340 int (*deinit_p2p_cli)(void *priv); 2341 2342 /** 2343 * suspend - Notification on system suspend/hibernate event 2344 * @priv: Private driver interface data 2345 */ 2346 void (*suspend)(void *priv); 2347 2348 /** 2349 * resume - Notification on system resume/thaw event 2350 * @priv: Private driver interface data 2351 */ 2352 void (*resume)(void *priv); 2353 2354 /** 2355 * signal_monitor - Set signal monitoring parameters 2356 * @priv: Private driver interface data 2357 * @threshold: Threshold value for signal change events; 0 = disabled 2358 * @hysteresis: Minimum change in signal strength before indicating a 2359 * new event 2360 * Returns: 0 on success, -1 on failure (or if not supported) 2361 * 2362 * This function can be used to configure monitoring of signal strength 2363 * with the current AP. Whenever signal strength drops below the 2364 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event 2365 * should be generated assuming the signal strength has changed at 2366 * least %hysteresis from the previously indicated signal change event. 2367 */ 2368 int (*signal_monitor)(void *priv, int threshold, int hysteresis); 2369 2370 /** 2371 * send_frame - Send IEEE 802.11 frame (testing use only) 2372 * @priv: Private driver interface data 2373 * @data: IEEE 802.11 frame with IEEE 802.11 header 2374 * @data_len: Size of the frame 2375 * @encrypt: Whether to encrypt the frame (if keys are set) 2376 * Returns: 0 on success, -1 on failure 2377 * 2378 * This function is only used for debugging purposes and is not 2379 * required to be implemented for normal operations. 2380 */ 2381 int (*send_frame)(void *priv, const u8 *data, size_t data_len, 2382 int encrypt); 2383 2384 /** 2385 * shared_freq - Get operating frequency of shared interface(s) 2386 * @priv: Private driver interface data 2387 * Returns: Operating frequency in MHz, 0 if no shared operation in 2388 * use, or -1 on failure 2389 * 2390 * This command can be used to request the current operating frequency 2391 * of any virtual interface that shares the same radio to provide 2392 * information for channel selection for other virtual interfaces. 2393 */ 2394 int (*shared_freq)(void *priv); 2395 2396 /** 2397 * get_noa - Get current Notice of Absence attribute payload 2398 * @priv: Private driver interface data 2399 * @buf: Buffer for returning NoA 2400 * @buf_len: Buffer length in octets 2401 * Returns: Number of octets used in buf, 0 to indicate no NoA is being 2402 * advertized, or -1 on failure 2403 * 2404 * This function is used to fetch the current Notice of Absence 2405 * attribute value from GO. 2406 */ 2407 int (*get_noa)(void *priv, u8 *buf, size_t buf_len); 2408 2409 /** 2410 * set_noa - Set Notice of Absence parameters for GO (testing) 2411 * @priv: Private driver interface data 2412 * @count: Count 2413 * @start: Start time in ms from next TBTT 2414 * @duration: Duration in ms 2415 * Returns: 0 on success or -1 on failure 2416 * 2417 * This function is used to set Notice of Absence parameters for GO. It 2418 * is used only for testing. To disable NoA, all parameters are set to 2419 * 0. 2420 */ 2421 int (*set_noa)(void *priv, u8 count, int start, int duration); 2422 2423 /** 2424 * set_p2p_powersave - Set P2P power save options 2425 * @priv: Private driver interface data 2426 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change 2427 * @opp_ps: 0 = disable, 1 = enable, -1 = no change 2428 * @ctwindow: 0.. = change (msec), -1 = no change 2429 * Returns: 0 on success or -1 on failure 2430 */ 2431 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps, 2432 int ctwindow); 2433 2434 /** 2435 * ampdu - Enable/disable aggregation 2436 * @priv: Private driver interface data 2437 * @ampdu: 1/0 = enable/disable A-MPDU aggregation 2438 * Returns: 0 on success or -1 on failure 2439 */ 2440 int (*ampdu)(void *priv, int ampdu); 2441 2442 /** 2443 * get_radio_name - Get physical radio name for the device 2444 * @priv: Private driver interface data 2445 * Returns: Radio name or %NULL if not known 2446 * 2447 * The returned data must not be modified by the caller. It is assumed 2448 * that any interface that has the same radio name as another is 2449 * sharing the same physical radio. This information can be used to 2450 * share scan results etc. information between the virtual interfaces 2451 * to speed up various operations. 2452 */ 2453 const char * (*get_radio_name)(void *priv); 2454 2455 /** 2456 * send_tdls_mgmt - for sending TDLS management packets 2457 * @priv: private driver interface data 2458 * @dst: Destination (peer) MAC address 2459 * @action_code: TDLS action code for the mssage 2460 * @dialog_token: Dialog Token to use in the message (if needed) 2461 * @status_code: Status Code or Reason Code to use (if needed) 2462 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield) 2463 * @buf: TDLS IEs to add to the message 2464 * @len: Length of buf in octets 2465 * Returns: 0 on success, negative (<0) on failure 2466 * 2467 * This optional function can be used to send packet to driver which is 2468 * responsible for receiving and sending all TDLS packets. 2469 */ 2470 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code, 2471 u8 dialog_token, u16 status_code, u32 peer_capab, 2472 const u8 *buf, size_t len); 2473 2474 /** 2475 * tdls_oper - Ask the driver to perform high-level TDLS operations 2476 * @priv: Private driver interface data 2477 * @oper: TDLS high-level operation. See %enum tdls_oper 2478 * @peer: Destination (peer) MAC address 2479 * Returns: 0 on success, negative (<0) on failure 2480 * 2481 * This optional function can be used to send high-level TDLS commands 2482 * to the driver. 2483 */ 2484 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer); 2485 2486 /** 2487 * wnm_oper - Notify driver of the WNM frame reception 2488 * @priv: Private driver interface data 2489 * @oper: WNM operation. See %enum wnm_oper 2490 * @peer: Destination (peer) MAC address 2491 * @buf: Buffer for the driver to fill in (for getting IE) 2492 * @buf_len: Return the len of buf 2493 * Returns: 0 on success, negative (<0) on failure 2494 */ 2495 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer, 2496 u8 *buf, u16 *buf_len); 2497 2498 /** 2499 * set_qos_map - Set QoS Map 2500 * @priv: Private driver interface data 2501 * @qos_map_set: QoS Map 2502 * @qos_map_set_len: Length of QoS Map 2503 */ 2504 int (*set_qos_map)(void *priv, const u8 *qos_map_set, 2505 u8 qos_map_set_len); 2506 2507 /** 2508 * signal_poll - Get current connection information 2509 * @priv: Private driver interface data 2510 * @signal_info: Connection info structure 2511 */ 2512 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info); 2513 2514 /** 2515 * set_authmode - Set authentication algorithm(s) for static WEP 2516 * @priv: Private driver interface data 2517 * @authmode: 1=Open System, 2=Shared Key, 3=both 2518 * Returns: 0 on success, -1 on failure 2519 * 2520 * This function can be used to set authentication algorithms for AP 2521 * mode when static WEP is used. If the driver uses user space MLME/SME 2522 * implementation, there is no need to implement this function. 2523 * 2524 * DEPRECATED - use set_ap() instead 2525 */ 2526 int (*set_authmode)(void *priv, int authmode); 2527 2528#ifdef ANDROID 2529 /** 2530 * driver_cmd - Execute driver-specific command 2531 * @priv: Private driver interface data 2532 * @cmd: Command to execute 2533 * @buf: Return buffer 2534 * @buf_len: Buffer length 2535 * Returns: 0 on success, -1 on failure 2536 */ 2537 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len); 2538#endif /* ANDROID */ 2539 2540 /** 2541 * vendor_cmd - Execute vendor specific command 2542 * @priv: Private driver interface data 2543 * @vendor_id: Vendor id 2544 * @subcmd: Vendor command id 2545 * @data: Vendor command parameters (%NULL if no parameters) 2546 * @data_len: Data length 2547 * @buf: Return buffer (%NULL to ignore reply) 2548 * Returns: 0 on success, negative (<0) on failure 2549 * 2550 * This function handles vendor specific commands that are passed to 2551 * the driver/device. The command is identified by vendor id and 2552 * command id. Parameters can be passed as argument to the command 2553 * in the data buffer. Reply (if any) will be filled in the supplied 2554 * return buffer. 2555 * 2556 * The exact driver behavior is driver interface and vendor specific. As 2557 * an example, this will be converted to a vendor specific cfg80211 2558 * command in case of the nl80211 driver interface. 2559 */ 2560 int (*vendor_cmd)(void *priv, unsigned int vendor_id, 2561 unsigned int subcmd, const u8 *data, size_t data_len, 2562 struct wpabuf *buf); 2563 2564 /** 2565 * set_rekey_info - Set rekey information 2566 * @priv: Private driver interface data 2567 * @kek: Current KEK 2568 * @kck: Current KCK 2569 * @replay_ctr: Current EAPOL-Key Replay Counter 2570 * 2571 * This optional function can be used to provide information for the 2572 * driver/firmware to process EAPOL-Key frames in Group Key Handshake 2573 * while the host (including wpa_supplicant) is sleeping. 2574 */ 2575 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck, 2576 const u8 *replay_ctr); 2577 2578 /** 2579 * sta_assoc - Station association indication 2580 * @priv: Private driver interface data 2581 * @own_addr: Source address and BSSID for association frame 2582 * @addr: MAC address of the station to associate 2583 * @reassoc: flag to indicate re-association 2584 * @status: association response status code 2585 * @ie: assoc response ie buffer 2586 * @len: ie buffer length 2587 * Returns: 0 on success, -1 on failure 2588 * 2589 * This function indicates the driver to send (Re)Association 2590 * Response frame to the station. 2591 */ 2592 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr, 2593 int reassoc, u16 status, const u8 *ie, size_t len); 2594 2595 /** 2596 * sta_auth - Station authentication indication 2597 * @priv: Private driver interface data 2598 * @own_addr: Source address and BSSID for authentication frame 2599 * @addr: MAC address of the station to associate 2600 * @seq: authentication sequence number 2601 * @status: authentication response status code 2602 * @ie: authentication frame ie buffer 2603 * @len: ie buffer length 2604 * 2605 * This function indicates the driver to send Authentication frame 2606 * to the station. 2607 */ 2608 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr, 2609 u16 seq, u16 status, const u8 *ie, size_t len); 2610 2611 /** 2612 * add_tspec - Add traffic stream 2613 * @priv: Private driver interface data 2614 * @addr: MAC address of the station to associate 2615 * @tspec_ie: tspec ie buffer 2616 * @tspec_ielen: tspec ie length 2617 * Returns: 0 on success, -1 on failure 2618 * 2619 * This function adds the traffic steam for the station 2620 * and fills the medium_time in tspec_ie. 2621 */ 2622 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie, 2623 size_t tspec_ielen); 2624 2625 /** 2626 * add_sta_node - Add a station node in the driver 2627 * @priv: Private driver interface data 2628 * @addr: MAC address of the station to add 2629 * @auth_alg: authentication algorithm used by the station 2630 * Returns: 0 on success, -1 on failure 2631 * 2632 * This function adds the station node in the driver, when 2633 * the station gets added by FT-over-DS. 2634 */ 2635 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg); 2636 2637 /** 2638 * sched_scan - Request the driver to initiate scheduled scan 2639 * @priv: Private driver interface data 2640 * @params: Scan parameters 2641 * @interval: Interval between scan cycles in milliseconds 2642 * Returns: 0 on success, -1 on failure 2643 * 2644 * This operation should be used for scheduled scan offload to 2645 * the hardware. Every time scan results are available, the 2646 * driver should report scan results event for wpa_supplicant 2647 * which will eventually request the results with 2648 * wpa_driver_get_scan_results2(). This operation is optional 2649 * and if not provided or if it returns -1, we fall back to 2650 * normal host-scheduled scans. 2651 */ 2652 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params, 2653 u32 interval); 2654 2655 /** 2656 * stop_sched_scan - Request the driver to stop a scheduled scan 2657 * @priv: Private driver interface data 2658 * Returns: 0 on success, -1 on failure 2659 * 2660 * This should cause the scheduled scan to be stopped and 2661 * results should stop being sent. Must be supported if 2662 * sched_scan is supported. 2663 */ 2664 int (*stop_sched_scan)(void *priv); 2665 2666 /** 2667 * poll_client - Probe (null data or such) the given station 2668 * @priv: Private driver interface data 2669 * @own_addr: MAC address of sending interface 2670 * @addr: MAC address of the station to probe 2671 * @qos: Indicates whether station is QoS station 2672 * 2673 * This function is used to verify whether an associated station is 2674 * still present. This function does not need to be implemented if the 2675 * driver provides such inactivity polling mechanism. 2676 */ 2677 void (*poll_client)(void *priv, const u8 *own_addr, 2678 const u8 *addr, int qos); 2679 2680 /** 2681 * radio_disable - Disable/enable radio 2682 * @priv: Private driver interface data 2683 * @disabled: 1=disable 0=enable radio 2684 * Returns: 0 on success, -1 on failure 2685 * 2686 * This optional command is for testing purposes. It can be used to 2687 * disable the radio on a testbed device to simulate out-of-radio-range 2688 * conditions. 2689 */ 2690 int (*radio_disable)(void *priv, int disabled); 2691 2692 /** 2693 * switch_channel - Announce channel switch and migrate the GO to the 2694 * given frequency 2695 * @priv: Private driver interface data 2696 * @settings: Settings for CSA period and new channel 2697 * Returns: 0 on success, -1 on failure 2698 * 2699 * This function is used to move the GO to the legacy STA channel to 2700 * avoid frequency conflict in single channel concurrency. 2701 */ 2702 int (*switch_channel)(void *priv, struct csa_settings *settings); 2703 2704 /** 2705 * start_dfs_cac - Listen for radar interference on the channel 2706 * @priv: Private driver interface data 2707 * @freq: Channel parameters 2708 * Returns: 0 on success, -1 on failure 2709 */ 2710 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq); 2711 2712 /** 2713 * stop_ap - Removes beacon from AP 2714 * @priv: Private driver interface data 2715 * Returns: 0 on success, -1 on failure (or if not supported) 2716 * 2717 * This optional function can be used to disable AP mode related 2718 * configuration. Unlike deinit_ap, it does not change to station 2719 * mode. 2720 */ 2721 int (*stop_ap)(void *priv); 2722 2723 /** 2724 * get_survey - Retrieve survey data 2725 * @priv: Private driver interface data 2726 * @freq: If set, survey data for the specified frequency is only 2727 * being requested. If not set, all survey data is requested. 2728 * Returns: 0 on success, -1 on failure 2729 * 2730 * Use this to retrieve: 2731 * 2732 * - the observed channel noise floor 2733 * - the amount of time we have spent on the channel 2734 * - the amount of time during which we have spent on the channel that 2735 * the radio has determined the medium is busy and we cannot 2736 * transmit 2737 * - the amount of time we have spent receiving data 2738 * - the amount of time we have spent transmitting data 2739 * 2740 * This data can be used for spectrum heuristics. One example is 2741 * Automatic Channel Selection (ACS). The channel survey data is 2742 * kept on a linked list on the channel data, one entry is added 2743 * for each survey. The min_nf of the channel is updated for each 2744 * survey. 2745 */ 2746 int (*get_survey)(void *priv, unsigned int freq); 2747 2748 /** 2749 * status - Get driver interface status information 2750 * @priv: Private driver interface data 2751 * @buf: Buffer for printing tou the status information 2752 * @buflen: Maximum length of the buffer 2753 * Returns: Length of written status information or -1 on failure 2754 */ 2755 int (*status)(void *priv, char *buf, size_t buflen); 2756}; 2757 2758 2759/** 2760 * enum wpa_event_type - Event type for wpa_supplicant_event() calls 2761 */ 2762enum wpa_event_type { 2763 /** 2764 * EVENT_ASSOC - Association completed 2765 * 2766 * This event needs to be delivered when the driver completes IEEE 2767 * 802.11 association or reassociation successfully. 2768 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID 2769 * after this event has been generated. In addition, optional 2770 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide 2771 * more information about the association. If the driver interface gets 2772 * both of these events at the same time, it can also include the 2773 * assoc_info data in EVENT_ASSOC call. 2774 */ 2775 EVENT_ASSOC, 2776 2777 /** 2778 * EVENT_DISASSOC - Association lost 2779 * 2780 * This event should be called when association is lost either due to 2781 * receiving deauthenticate or disassociate frame from the AP or when 2782 * sending either of these frames to the current AP. If the driver 2783 * supports separate deauthentication event, EVENT_DISASSOC should only 2784 * be used for disassociation and EVENT_DEAUTH for deauthentication. 2785 * In AP mode, union wpa_event_data::disassoc_info is required. 2786 */ 2787 EVENT_DISASSOC, 2788 2789 /** 2790 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected 2791 * 2792 * This event must be delivered when a Michael MIC error is detected by 2793 * the local driver. Additional data for event processing is 2794 * provided with union wpa_event_data::michael_mic_failure. This 2795 * information is used to request new encyption key and to initiate 2796 * TKIP countermeasures if needed. 2797 */ 2798 EVENT_MICHAEL_MIC_FAILURE, 2799 2800 /** 2801 * EVENT_SCAN_RESULTS - Scan results available 2802 * 2803 * This event must be called whenever scan results are available to be 2804 * fetched with struct wpa_driver_ops::get_scan_results(). This event 2805 * is expected to be used some time after struct wpa_driver_ops::scan() 2806 * is called. If the driver provides an unsolicited event when the scan 2807 * has been completed, this event can be used to trigger 2808 * EVENT_SCAN_RESULTS call. If such event is not available from the 2809 * driver, the driver wrapper code is expected to use a registered 2810 * timeout to generate EVENT_SCAN_RESULTS call after the time that the 2811 * scan is expected to be completed. Optional information about 2812 * completed scan can be provided with union wpa_event_data::scan_info. 2813 */ 2814 EVENT_SCAN_RESULTS, 2815 2816 /** 2817 * EVENT_ASSOCINFO - Report optional extra information for association 2818 * 2819 * This event can be used to report extra association information for 2820 * EVENT_ASSOC processing. This extra information includes IEs from 2821 * association frames and Beacon/Probe Response frames in union 2822 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before 2823 * EVENT_ASSOC. Alternatively, the driver interface can include 2824 * assoc_info data in the EVENT_ASSOC call if it has all the 2825 * information available at the same point. 2826 */ 2827 EVENT_ASSOCINFO, 2828 2829 /** 2830 * EVENT_INTERFACE_STATUS - Report interface status changes 2831 * 2832 * This optional event can be used to report changes in interface 2833 * status (interface added/removed) using union 2834 * wpa_event_data::interface_status. This can be used to trigger 2835 * wpa_supplicant to stop and re-start processing for the interface, 2836 * e.g., when a cardbus card is ejected/inserted. 2837 */ 2838 EVENT_INTERFACE_STATUS, 2839 2840 /** 2841 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication 2842 * 2843 * This event can be used to inform wpa_supplicant about candidates for 2844 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible 2845 * for scan request (ap_scan=2 mode), this event is required for 2846 * pre-authentication. If wpa_supplicant is performing scan request 2847 * (ap_scan=1), this event is optional since scan results can be used 2848 * to add pre-authentication candidates. union 2849 * wpa_event_data::pmkid_candidate is used to report the BSSID of the 2850 * candidate and priority of the candidate, e.g., based on the signal 2851 * strength, in order to try to pre-authenticate first with candidates 2852 * that are most likely targets for re-association. 2853 * 2854 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates 2855 * on the candidate list. In addition, it can be called for the current 2856 * AP and APs that have existing PMKSA cache entries. wpa_supplicant 2857 * will automatically skip pre-authentication in cases where a valid 2858 * PMKSA exists. When more than one candidate exists, this event should 2859 * be generated once for each candidate. 2860 * 2861 * Driver will be notified about successful pre-authentication with 2862 * struct wpa_driver_ops::add_pmkid() calls. 2863 */ 2864 EVENT_PMKID_CANDIDATE, 2865 2866 /** 2867 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request) 2868 * 2869 * This event can be used to inform wpa_supplicant about desire to set 2870 * up secure direct link connection between two stations as defined in 2871 * IEEE 802.11e with a new PeerKey mechanism that replaced the original 2872 * STAKey negotiation. The caller will need to set peer address for the 2873 * event. 2874 */ 2875 EVENT_STKSTART, 2876 2877 /** 2878 * EVENT_TDLS - Request TDLS operation 2879 * 2880 * This event can be used to request a TDLS operation to be performed. 2881 */ 2882 EVENT_TDLS, 2883 2884 /** 2885 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs 2886 * 2887 * The driver is expected to report the received FT IEs from 2888 * FT authentication sequence from the AP. The FT IEs are included in 2889 * the extra information in union wpa_event_data::ft_ies. 2890 */ 2891 EVENT_FT_RESPONSE, 2892 2893 /** 2894 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS 2895 * 2896 * The driver can use this event to inform wpa_supplicant about a STA 2897 * in an IBSS with which protected frames could be exchanged. This 2898 * event starts RSN authentication with the other STA to authenticate 2899 * the STA and set up encryption keys with it. 2900 */ 2901 EVENT_IBSS_RSN_START, 2902 2903 /** 2904 * EVENT_AUTH - Authentication result 2905 * 2906 * This event should be called when authentication attempt has been 2907 * completed. This is only used if the driver supports separate 2908 * authentication step (struct wpa_driver_ops::authenticate). 2909 * Information about authentication result is included in 2910 * union wpa_event_data::auth. 2911 */ 2912 EVENT_AUTH, 2913 2914 /** 2915 * EVENT_DEAUTH - Authentication lost 2916 * 2917 * This event should be called when authentication is lost either due 2918 * to receiving deauthenticate frame from the AP or when sending that 2919 * frame to the current AP. 2920 * In AP mode, union wpa_event_data::deauth_info is required. 2921 */ 2922 EVENT_DEAUTH, 2923 2924 /** 2925 * EVENT_ASSOC_REJECT - Association rejected 2926 * 2927 * This event should be called when (re)association attempt has been 2928 * rejected by the AP. Information about the association response is 2929 * included in union wpa_event_data::assoc_reject. 2930 */ 2931 EVENT_ASSOC_REJECT, 2932 2933 /** 2934 * EVENT_AUTH_TIMED_OUT - Authentication timed out 2935 */ 2936 EVENT_AUTH_TIMED_OUT, 2937 2938 /** 2939 * EVENT_ASSOC_TIMED_OUT - Association timed out 2940 */ 2941 EVENT_ASSOC_TIMED_OUT, 2942 2943 /** 2944 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received 2945 */ 2946 EVENT_FT_RRB_RX, 2947 2948 /** 2949 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS 2950 */ 2951 EVENT_WPS_BUTTON_PUSHED, 2952 2953 /** 2954 * EVENT_TX_STATUS - Report TX status 2955 */ 2956 EVENT_TX_STATUS, 2957 2958 /** 2959 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA 2960 */ 2961 EVENT_RX_FROM_UNKNOWN, 2962 2963 /** 2964 * EVENT_RX_MGMT - Report RX of a management frame 2965 */ 2966 EVENT_RX_MGMT, 2967 2968 /** 2969 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started 2970 * 2971 * This event is used to indicate when the driver has started the 2972 * requested remain-on-channel duration. Information about the 2973 * operation is included in union wpa_event_data::remain_on_channel. 2974 */ 2975 EVENT_REMAIN_ON_CHANNEL, 2976 2977 /** 2978 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out 2979 * 2980 * This event is used to indicate when the driver has completed 2981 * remain-on-channel duration, i.e., may noot be available on the 2982 * requested channel anymore. Information about the 2983 * operation is included in union wpa_event_data::remain_on_channel. 2984 */ 2985 EVENT_CANCEL_REMAIN_ON_CHANNEL, 2986 2987 /** 2988 * EVENT_MLME_RX - Report reception of frame for MLME (test use only) 2989 * 2990 * This event is used only by driver_test.c and userspace MLME. 2991 */ 2992 EVENT_MLME_RX, 2993 2994 /** 2995 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame 2996 * 2997 * This event is used to indicate when a Probe Request frame has been 2998 * received. Information about the received frame is included in 2999 * union wpa_event_data::rx_probe_req. The driver is required to report 3000 * these events only after successfully completed probe_req_report() 3001 * commands to request the events (i.e., report parameter is non-zero) 3002 * in station mode. In AP mode, Probe Request frames should always be 3003 * reported. 3004 */ 3005 EVENT_RX_PROBE_REQ, 3006 3007 /** 3008 * EVENT_NEW_STA - New wired device noticed 3009 * 3010 * This event is used to indicate that a new device has been detected 3011 * in a network that does not use association-like functionality (i.e., 3012 * mainly wired Ethernet). This can be used to start EAPOL 3013 * authenticator when receiving a frame from a device. The address of 3014 * the device is included in union wpa_event_data::new_sta. 3015 */ 3016 EVENT_NEW_STA, 3017 3018 /** 3019 * EVENT_EAPOL_RX - Report received EAPOL frame 3020 * 3021 * When in AP mode with hostapd, this event is required to be used to 3022 * deliver the receive EAPOL frames from the driver. With 3023 * %wpa_supplicant, this event is used only if the send_eapol() handler 3024 * is used to override the use of l2_packet for EAPOL frame TX. 3025 */ 3026 EVENT_EAPOL_RX, 3027 3028 /** 3029 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength 3030 * 3031 * This event is used to indicate changes in the signal strength 3032 * observed in frames received from the current AP if signal strength 3033 * monitoring has been enabled with signal_monitor(). 3034 */ 3035 EVENT_SIGNAL_CHANGE, 3036 3037 /** 3038 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled 3039 * 3040 * This event is used to indicate that the interface was enabled after 3041 * having been previously disabled, e.g., due to rfkill. 3042 */ 3043 EVENT_INTERFACE_ENABLED, 3044 3045 /** 3046 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled 3047 * 3048 * This event is used to indicate that the interface was disabled, 3049 * e.g., due to rfkill. 3050 */ 3051 EVENT_INTERFACE_DISABLED, 3052 3053 /** 3054 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed 3055 * 3056 * This event is used to indicate that the channel list has changed, 3057 * e.g., because of a regulatory domain change triggered by scan 3058 * results including an AP advertising a country code. 3059 */ 3060 EVENT_CHANNEL_LIST_CHANGED, 3061 3062 /** 3063 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable 3064 * 3065 * This event is used to indicate that the driver cannot maintain this 3066 * interface in its operation mode anymore. The most likely use for 3067 * this is to indicate that AP mode operation is not available due to 3068 * operating channel would need to be changed to a DFS channel when 3069 * the driver does not support radar detection and another virtual 3070 * interfaces caused the operating channel to change. Other similar 3071 * resource conflicts could also trigger this for station mode 3072 * interfaces. 3073 */ 3074 EVENT_INTERFACE_UNAVAILABLE, 3075 3076 /** 3077 * EVENT_BEST_CHANNEL 3078 * 3079 * Driver generates this event whenever it detects a better channel 3080 * (e.g., based on RSSI or channel use). This information can be used 3081 * to improve channel selection for a new AP/P2P group. 3082 */ 3083 EVENT_BEST_CHANNEL, 3084 3085 /** 3086 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received 3087 * 3088 * This event should be called when a Deauthentication frame is dropped 3089 * due to it not being protected (MFP/IEEE 802.11w). 3090 * union wpa_event_data::unprot_deauth is required to provide more 3091 * details of the frame. 3092 */ 3093 EVENT_UNPROT_DEAUTH, 3094 3095 /** 3096 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received 3097 * 3098 * This event should be called when a Disassociation frame is dropped 3099 * due to it not being protected (MFP/IEEE 802.11w). 3100 * union wpa_event_data::unprot_disassoc is required to provide more 3101 * details of the frame. 3102 */ 3103 EVENT_UNPROT_DISASSOC, 3104 3105 /** 3106 * EVENT_STATION_LOW_ACK 3107 * 3108 * Driver generates this event whenever it detected that a particular 3109 * station was lost. Detection can be through massive transmission 3110 * failures for example. 3111 */ 3112 EVENT_STATION_LOW_ACK, 3113 3114 /** 3115 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore 3116 */ 3117 EVENT_IBSS_PEER_LOST, 3118 3119 /** 3120 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey 3121 * 3122 * This event carries the new replay counter to notify wpa_supplicant 3123 * of the current EAPOL-Key Replay Counter in case the driver/firmware 3124 * completed Group Key Handshake while the host (including 3125 * wpa_supplicant was sleeping). 3126 */ 3127 EVENT_DRIVER_GTK_REKEY, 3128 3129 /** 3130 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped 3131 */ 3132 EVENT_SCHED_SCAN_STOPPED, 3133 3134 /** 3135 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll 3136 * 3137 * This event indicates that the station responded to the poll 3138 * initiated with @poll_client. 3139 */ 3140 EVENT_DRIVER_CLIENT_POLL_OK, 3141 3142 /** 3143 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status 3144 */ 3145 EVENT_EAPOL_TX_STATUS, 3146 3147 /** 3148 * EVENT_CH_SWITCH - AP or GO decided to switch channels 3149 * 3150 * Described in wpa_event_data.ch_switch 3151 * */ 3152 EVENT_CH_SWITCH, 3153 3154 /** 3155 * EVENT_WNM - Request WNM operation 3156 * 3157 * This event can be used to request a WNM operation to be performed. 3158 */ 3159 EVENT_WNM, 3160 3161 /** 3162 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode 3163 * 3164 * This event indicates that the driver reported a connection failure 3165 * with the specified client (for example, max client reached, etc.) in 3166 * AP mode. 3167 */ 3168 EVENT_CONNECT_FAILED_REASON, 3169 3170 /** 3171 * EVENT_RADAR_DETECTED - Notify of radar detection 3172 * 3173 * A radar has been detected on the supplied frequency, hostapd should 3174 * react accordingly (e.g., change channel). 3175 */ 3176 EVENT_DFS_RADAR_DETECTED, 3177 3178 /** 3179 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed 3180 * 3181 * After a successful CAC, the channel can be marked clear and used. 3182 */ 3183 EVENT_DFS_CAC_FINISHED, 3184 3185 /** 3186 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted 3187 * 3188 * The CAC was not successful, and the channel remains in the previous 3189 * state. This may happen due to a radar beeing detected or other 3190 * external influences. 3191 */ 3192 EVENT_DFS_CAC_ABORTED, 3193 3194 /** 3195 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over 3196 * 3197 * The channel which was previously unavailable is now available again. 3198 */ 3199 EVENT_DFS_NOP_FINISHED, 3200 3201 /** 3202 * EVENT_SURVEY - Received survey data 3203 * 3204 * This event gets triggered when a driver query is issued for survey 3205 * data and the requested data becomes available. The returned data is 3206 * stored in struct survey_results. The results provide at most one 3207 * survey entry for each frequency and at minimum will provide one 3208 * survey entry for one frequency. The survey data can be os_malloc()'d 3209 * and then os_free()'d, so the event callback must only copy data. 3210 */ 3211 EVENT_SURVEY, 3212 3213 /** 3214 * EVENT_SCAN_STARTED - Scan started 3215 * 3216 * This indicates that driver has started a scan operation either based 3217 * on a request from wpa_supplicant/hostapd or from another application. 3218 * EVENT_SCAN_RESULTS is used to indicate when the scan has been 3219 * completed (either successfully or by getting cancelled). 3220 */ 3221 EVENT_SCAN_STARTED, 3222 3223 /** 3224 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range 3225 * 3226 * This event indicates a set of frequency ranges that should be avoided 3227 * to reduce issues due to interference or internal co-existence 3228 * information in the driver. 3229 */ 3230 EVENT_AVOID_FREQUENCIES 3231}; 3232 3233 3234/** 3235 * struct freq_survey - Channel survey info 3236 * 3237 * @ifidx: Interface index in which this survey was observed 3238 * @freq: Center of frequency of the surveyed channel 3239 * @nf: Channel noise floor in dBm 3240 * @channel_time: Amount of time in ms the radio spent on the channel 3241 * @channel_time_busy: Amount of time in ms the radio detected some signal 3242 * that indicated to the radio the channel was not clear 3243 * @channel_time_rx: Amount of time the radio spent receiving data 3244 * @channel_time_tx: Amount of time the radio spent transmitting data 3245 * @filled: bitmask indicating which fields have been reported, see 3246 * SURVEY_HAS_* defines. 3247 * @list: Internal list pointers 3248 */ 3249struct freq_survey { 3250 u32 ifidx; 3251 unsigned int freq; 3252 s8 nf; 3253 u64 channel_time; 3254 u64 channel_time_busy; 3255 u64 channel_time_rx; 3256 u64 channel_time_tx; 3257 unsigned int filled; 3258 struct dl_list list; 3259}; 3260 3261#define SURVEY_HAS_NF BIT(0) 3262#define SURVEY_HAS_CHAN_TIME BIT(1) 3263#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2) 3264#define SURVEY_HAS_CHAN_TIME_RX BIT(3) 3265#define SURVEY_HAS_CHAN_TIME_TX BIT(4) 3266 3267 3268/** 3269 * union wpa_event_data - Additional data for wpa_supplicant_event() calls 3270 */ 3271union wpa_event_data { 3272 /** 3273 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events 3274 * 3275 * This structure is optional for EVENT_ASSOC calls and required for 3276 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the 3277 * driver interface does not need to generate separate EVENT_ASSOCINFO 3278 * calls. 3279 */ 3280 struct assoc_info { 3281 /** 3282 * reassoc - Flag to indicate association or reassociation 3283 */ 3284 int reassoc; 3285 3286 /** 3287 * req_ies - (Re)Association Request IEs 3288 * 3289 * If the driver generates WPA/RSN IE, this event data must be 3290 * returned for WPA handshake to have needed information. If 3291 * wpa_supplicant-generated WPA/RSN IE is used, this 3292 * information event is optional. 3293 * 3294 * This should start with the first IE (fixed fields before IEs 3295 * are not included). 3296 */ 3297 const u8 *req_ies; 3298 3299 /** 3300 * req_ies_len - Length of req_ies in bytes 3301 */ 3302 size_t req_ies_len; 3303 3304 /** 3305 * resp_ies - (Re)Association Response IEs 3306 * 3307 * Optional association data from the driver. This data is not 3308 * required WPA, but may be useful for some protocols and as 3309 * such, should be reported if this is available to the driver 3310 * interface. 3311 * 3312 * This should start with the first IE (fixed fields before IEs 3313 * are not included). 3314 */ 3315 const u8 *resp_ies; 3316 3317 /** 3318 * resp_ies_len - Length of resp_ies in bytes 3319 */ 3320 size_t resp_ies_len; 3321 3322 /** 3323 * beacon_ies - Beacon or Probe Response IEs 3324 * 3325 * Optional Beacon/ProbeResp data: IEs included in Beacon or 3326 * Probe Response frames from the current AP (i.e., the one 3327 * that the client just associated with). This information is 3328 * used to update WPA/RSN IE for the AP. If this field is not 3329 * set, the results from previous scan will be used. If no 3330 * data for the new AP is found, scan results will be requested 3331 * again (without scan request). At this point, the driver is 3332 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is 3333 * used). 3334 * 3335 * This should start with the first IE (fixed fields before IEs 3336 * are not included). 3337 */ 3338 const u8 *beacon_ies; 3339 3340 /** 3341 * beacon_ies_len - Length of beacon_ies */ 3342 size_t beacon_ies_len; 3343 3344 /** 3345 * freq - Frequency of the operational channel in MHz 3346 */ 3347 unsigned int freq; 3348 3349 /** 3350 * addr - Station address (for AP mode) 3351 */ 3352 const u8 *addr; 3353 } assoc_info; 3354 3355 /** 3356 * struct disassoc_info - Data for EVENT_DISASSOC events 3357 */ 3358 struct disassoc_info { 3359 /** 3360 * addr - Station address (for AP mode) 3361 */ 3362 const u8 *addr; 3363 3364 /** 3365 * reason_code - Reason Code (host byte order) used in 3366 * Deauthentication frame 3367 */ 3368 u16 reason_code; 3369 3370 /** 3371 * ie - Optional IE(s) in Disassociation frame 3372 */ 3373 const u8 *ie; 3374 3375 /** 3376 * ie_len - Length of ie buffer in octets 3377 */ 3378 size_t ie_len; 3379 3380 /** 3381 * locally_generated - Whether the frame was locally generated 3382 */ 3383 int locally_generated; 3384 } disassoc_info; 3385 3386 /** 3387 * struct deauth_info - Data for EVENT_DEAUTH events 3388 */ 3389 struct deauth_info { 3390 /** 3391 * addr - Station address (for AP mode) 3392 */ 3393 const u8 *addr; 3394 3395 /** 3396 * reason_code - Reason Code (host byte order) used in 3397 * Deauthentication frame 3398 */ 3399 u16 reason_code; 3400 3401 /** 3402 * ie - Optional IE(s) in Deauthentication frame 3403 */ 3404 const u8 *ie; 3405 3406 /** 3407 * ie_len - Length of ie buffer in octets 3408 */ 3409 size_t ie_len; 3410 3411 /** 3412 * locally_generated - Whether the frame was locally generated 3413 */ 3414 int locally_generated; 3415 } deauth_info; 3416 3417 /** 3418 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE 3419 */ 3420 struct michael_mic_failure { 3421 int unicast; 3422 const u8 *src; 3423 } michael_mic_failure; 3424 3425 /** 3426 * struct interface_status - Data for EVENT_INTERFACE_STATUS 3427 */ 3428 struct interface_status { 3429 char ifname[100]; 3430 enum { 3431 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED 3432 } ievent; 3433 } interface_status; 3434 3435 /** 3436 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE 3437 */ 3438 struct pmkid_candidate { 3439 /** BSSID of the PMKID candidate */ 3440 u8 bssid[ETH_ALEN]; 3441 /** Smaller the index, higher the priority */ 3442 int index; 3443 /** Whether RSN IE includes pre-authenticate flag */ 3444 int preauth; 3445 } pmkid_candidate; 3446 3447 /** 3448 * struct stkstart - Data for EVENT_STKSTART 3449 */ 3450 struct stkstart { 3451 u8 peer[ETH_ALEN]; 3452 } stkstart; 3453 3454 /** 3455 * struct tdls - Data for EVENT_TDLS 3456 */ 3457 struct tdls { 3458 u8 peer[ETH_ALEN]; 3459 enum { 3460 TDLS_REQUEST_SETUP, 3461 TDLS_REQUEST_TEARDOWN 3462 } oper; 3463 u16 reason_code; /* for teardown */ 3464 } tdls; 3465 3466 /** 3467 * struct wnm - Data for EVENT_WNM 3468 */ 3469 struct wnm { 3470 u8 addr[ETH_ALEN]; 3471 enum { 3472 WNM_OPER_SLEEP, 3473 } oper; 3474 enum { 3475 WNM_SLEEP_ENTER, 3476 WNM_SLEEP_EXIT 3477 } sleep_action; 3478 int sleep_intval; 3479 u16 reason_code; 3480 u8 *buf; 3481 u16 buf_len; 3482 } wnm; 3483 3484 /** 3485 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE) 3486 * 3487 * During FT (IEEE 802.11r) authentication sequence, the driver is 3488 * expected to use this event to report received FT IEs (MDIE, FTIE, 3489 * RSN IE, TIE, possible resource request) to the supplicant. The FT 3490 * IEs for the next message will be delivered through the 3491 * struct wpa_driver_ops::update_ft_ies() callback. 3492 */ 3493 struct ft_ies { 3494 const u8 *ies; 3495 size_t ies_len; 3496 int ft_action; 3497 u8 target_ap[ETH_ALEN]; 3498 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */ 3499 const u8 *ric_ies; 3500 /** Length of ric_ies buffer in octets */ 3501 size_t ric_ies_len; 3502 } ft_ies; 3503 3504 /** 3505 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START 3506 */ 3507 struct ibss_rsn_start { 3508 u8 peer[ETH_ALEN]; 3509 } ibss_rsn_start; 3510 3511 /** 3512 * struct auth_info - Data for EVENT_AUTH events 3513 */ 3514 struct auth_info { 3515 u8 peer[ETH_ALEN]; 3516 u8 bssid[ETH_ALEN]; 3517 u16 auth_type; 3518 u16 auth_transaction; 3519 u16 status_code; 3520 const u8 *ies; 3521 size_t ies_len; 3522 } auth; 3523 3524 /** 3525 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events 3526 */ 3527 struct assoc_reject { 3528 /** 3529 * bssid - BSSID of the AP that rejected association 3530 */ 3531 const u8 *bssid; 3532 3533 /** 3534 * resp_ies - (Re)Association Response IEs 3535 * 3536 * Optional association data from the driver. This data is not 3537 * required WPA, but may be useful for some protocols and as 3538 * such, should be reported if this is available to the driver 3539 * interface. 3540 * 3541 * This should start with the first IE (fixed fields before IEs 3542 * are not included). 3543 */ 3544 const u8 *resp_ies; 3545 3546 /** 3547 * resp_ies_len - Length of resp_ies in bytes 3548 */ 3549 size_t resp_ies_len; 3550 3551 /** 3552 * status_code - Status Code from (Re)association Response 3553 */ 3554 u16 status_code; 3555 } assoc_reject; 3556 3557 struct timeout_event { 3558 u8 addr[ETH_ALEN]; 3559 } timeout_event; 3560 3561 /** 3562 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events 3563 */ 3564 struct ft_rrb_rx { 3565 const u8 *src; 3566 const u8 *data; 3567 size_t data_len; 3568 } ft_rrb_rx; 3569 3570 /** 3571 * struct tx_status - Data for EVENT_TX_STATUS events 3572 */ 3573 struct tx_status { 3574 u16 type; 3575 u16 stype; 3576 const u8 *dst; 3577 const u8 *data; 3578 size_t data_len; 3579 int ack; 3580 } tx_status; 3581 3582 /** 3583 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events 3584 */ 3585 struct rx_from_unknown { 3586 const u8 *bssid; 3587 const u8 *addr; 3588 int wds; 3589 } rx_from_unknown; 3590 3591 /** 3592 * struct rx_mgmt - Data for EVENT_RX_MGMT events 3593 */ 3594 struct rx_mgmt { 3595 const u8 *frame; 3596 size_t frame_len; 3597 u32 datarate; 3598 3599 /** 3600 * drv_priv - Pointer to store driver private BSS information 3601 * 3602 * If not set to NULL, this is used for comparison with 3603 * hostapd_data->drv_priv to determine which BSS should process 3604 * the frame. 3605 */ 3606 void *drv_priv; 3607 3608 /** 3609 * freq - Frequency (in MHz) on which the frame was received 3610 */ 3611 int freq; 3612 3613 /** 3614 * ssi_signal - Signal strength in dBm (or 0 if not available) 3615 */ 3616 int ssi_signal; 3617 } rx_mgmt; 3618 3619 /** 3620 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events 3621 * 3622 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events. 3623 */ 3624 struct remain_on_channel { 3625 /** 3626 * freq - Channel frequency in MHz 3627 */ 3628 unsigned int freq; 3629 3630 /** 3631 * duration - Duration to remain on the channel in milliseconds 3632 */ 3633 unsigned int duration; 3634 } remain_on_channel; 3635 3636 /** 3637 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events 3638 * @aborted: Whether the scan was aborted 3639 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned) 3640 * @num_freqs: Number of entries in freqs array 3641 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard 3642 * SSID) 3643 * @num_ssids: Number of entries in ssids array 3644 */ 3645 struct scan_info { 3646 int aborted; 3647 const int *freqs; 3648 size_t num_freqs; 3649 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS]; 3650 size_t num_ssids; 3651 } scan_info; 3652 3653 /** 3654 * struct mlme_rx - Data for EVENT_MLME_RX events 3655 */ 3656 struct mlme_rx { 3657 const u8 *buf; 3658 size_t len; 3659 int freq; 3660 int channel; 3661 int ssi; 3662 } mlme_rx; 3663 3664 /** 3665 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events 3666 */ 3667 struct rx_probe_req { 3668 /** 3669 * sa - Source address of the received Probe Request frame 3670 */ 3671 const u8 *sa; 3672 3673 /** 3674 * da - Destination address of the received Probe Request frame 3675 * or %NULL if not available 3676 */ 3677 const u8 *da; 3678 3679 /** 3680 * bssid - BSSID of the received Probe Request frame or %NULL 3681 * if not available 3682 */ 3683 const u8 *bssid; 3684 3685 /** 3686 * ie - IEs from the Probe Request body 3687 */ 3688 const u8 *ie; 3689 3690 /** 3691 * ie_len - Length of ie buffer in octets 3692 */ 3693 size_t ie_len; 3694 3695 /** 3696 * signal - signal strength in dBm (or 0 if not available) 3697 */ 3698 int ssi_signal; 3699 } rx_probe_req; 3700 3701 /** 3702 * struct new_sta - Data for EVENT_NEW_STA events 3703 */ 3704 struct new_sta { 3705 const u8 *addr; 3706 } new_sta; 3707 3708 /** 3709 * struct eapol_rx - Data for EVENT_EAPOL_RX events 3710 */ 3711 struct eapol_rx { 3712 const u8 *src; 3713 const u8 *data; 3714 size_t data_len; 3715 } eapol_rx; 3716 3717 /** 3718 * signal_change - Data for EVENT_SIGNAL_CHANGE events 3719 */ 3720 struct wpa_signal_info signal_change; 3721 3722 /** 3723 * struct best_channel - Data for EVENT_BEST_CHANNEL events 3724 * @freq_24: Best 2.4 GHz band channel frequency in MHz 3725 * @freq_5: Best 5 GHz band channel frequency in MHz 3726 * @freq_overall: Best channel frequency in MHz 3727 * 3728 * 0 can be used to indicate no preference in either band. 3729 */ 3730 struct best_channel { 3731 int freq_24; 3732 int freq_5; 3733 int freq_overall; 3734 } best_chan; 3735 3736 struct unprot_deauth { 3737 const u8 *sa; 3738 const u8 *da; 3739 u16 reason_code; 3740 } unprot_deauth; 3741 3742 struct unprot_disassoc { 3743 const u8 *sa; 3744 const u8 *da; 3745 u16 reason_code; 3746 } unprot_disassoc; 3747 3748 /** 3749 * struct low_ack - Data for EVENT_STATION_LOW_ACK events 3750 * @addr: station address 3751 */ 3752 struct low_ack { 3753 u8 addr[ETH_ALEN]; 3754 } low_ack; 3755 3756 /** 3757 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST 3758 */ 3759 struct ibss_peer_lost { 3760 u8 peer[ETH_ALEN]; 3761 } ibss_peer_lost; 3762 3763 /** 3764 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY 3765 */ 3766 struct driver_gtk_rekey { 3767 const u8 *bssid; 3768 const u8 *replay_ctr; 3769 } driver_gtk_rekey; 3770 3771 /** 3772 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events 3773 * @addr: station address 3774 */ 3775 struct client_poll { 3776 u8 addr[ETH_ALEN]; 3777 } client_poll; 3778 3779 /** 3780 * struct eapol_tx_status 3781 * @dst: Original destination 3782 * @data: Data starting with IEEE 802.1X header (!) 3783 * @data_len: Length of data 3784 * @ack: Indicates ack or lost frame 3785 * 3786 * This corresponds to hapd_send_eapol if the frame sent 3787 * there isn't just reported as EVENT_TX_STATUS. 3788 */ 3789 struct eapol_tx_status { 3790 const u8 *dst; 3791 const u8 *data; 3792 int data_len; 3793 int ack; 3794 } eapol_tx_status; 3795 3796 /** 3797 * struct ch_switch 3798 * @freq: Frequency of new channel in MHz 3799 * @ht_enabled: Whether this is an HT channel 3800 * @ch_offset: Secondary channel offset 3801 * @ch_width: Channel width 3802 * @cf1: Center frequency 1 3803 * @cf2: Center frequency 2 3804 */ 3805 struct ch_switch { 3806 int freq; 3807 int ht_enabled; 3808 int ch_offset; 3809 enum chan_width ch_width; 3810 int cf1; 3811 int cf2; 3812 } ch_switch; 3813 3814 /** 3815 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON 3816 * @addr: Remote client address 3817 * @code: Reason code for connection failure 3818 */ 3819 struct connect_failed_reason { 3820 u8 addr[ETH_ALEN]; 3821 enum { 3822 MAX_CLIENT_REACHED, 3823 BLOCKED_CLIENT 3824 } code; 3825 } connect_failed_reason; 3826 3827 /** 3828 * struct dfs_event - Data for radar detected events 3829 * @freq: Frequency of the channel in MHz 3830 */ 3831 struct dfs_event { 3832 int freq; 3833 int ht_enabled; 3834 int chan_offset; 3835 enum chan_width chan_width; 3836 int cf1; 3837 int cf2; 3838 } dfs_event; 3839 3840 /** 3841 * survey_results - Survey result data for EVENT_SURVEY 3842 * @freq_filter: Requested frequency survey filter, 0 if request 3843 * was for all survey data 3844 * @survey_list: Linked list of survey data 3845 */ 3846 struct survey_results { 3847 unsigned int freq_filter; 3848 struct dl_list survey_list; /* struct freq_survey */ 3849 } survey_results; 3850 3851 /** 3852 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED 3853 * @initiator: Initiator of the regulatory change 3854 */ 3855 struct channel_list_changed { 3856 enum reg_change_initiator initiator; 3857 } channel_list_changed; 3858 3859 /** 3860 * freq_range - List of frequency ranges 3861 * 3862 * This is used as the data with EVENT_AVOID_FREQUENCIES. 3863 */ 3864 struct wpa_freq_range_list freq_range; 3865}; 3866 3867/** 3868 * wpa_supplicant_event - Report a driver event for wpa_supplicant 3869 * @ctx: Context pointer (wpa_s); this is the ctx variable registered 3870 * with struct wpa_driver_ops::init() 3871 * @event: event type (defined above) 3872 * @data: possible extra data for the event 3873 * 3874 * Driver wrapper code should call this function whenever an event is received 3875 * from the driver. 3876 */ 3877void wpa_supplicant_event(void *ctx, enum wpa_event_type event, 3878 union wpa_event_data *data); 3879 3880 3881/* 3882 * The following inline functions are provided for convenience to simplify 3883 * event indication for some of the common events. 3884 */ 3885 3886static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie, 3887 size_t ielen, int reassoc) 3888{ 3889 union wpa_event_data event; 3890 os_memset(&event, 0, sizeof(event)); 3891 event.assoc_info.reassoc = reassoc; 3892 event.assoc_info.req_ies = ie; 3893 event.assoc_info.req_ies_len = ielen; 3894 event.assoc_info.addr = addr; 3895 wpa_supplicant_event(ctx, EVENT_ASSOC, &event); 3896} 3897 3898static inline void drv_event_disassoc(void *ctx, const u8 *addr) 3899{ 3900 union wpa_event_data event; 3901 os_memset(&event, 0, sizeof(event)); 3902 event.disassoc_info.addr = addr; 3903 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event); 3904} 3905 3906static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data, 3907 size_t data_len) 3908{ 3909 union wpa_event_data event; 3910 os_memset(&event, 0, sizeof(event)); 3911 event.eapol_rx.src = src; 3912 event.eapol_rx.data = data; 3913 event.eapol_rx.data_len = data_len; 3914 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event); 3915} 3916 3917/* driver_common.c */ 3918void wpa_scan_results_free(struct wpa_scan_results *res); 3919 3920/* Convert wpa_event_type to a string for logging */ 3921const char * event_to_string(enum wpa_event_type event); 3922 3923/* NULL terminated array of linked in driver wrappers */ 3924extern struct wpa_driver_ops *wpa_drivers[]; 3925 3926#endif /* DRIVER_H */ 3927