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