]>
Commit | Line | Data |
---|---|---|
6fc6879b | 1 | /* |
e0498677 | 2 | * Driver interface definition |
8d923a4a | 3 | * Copyright (c) 2003-2010, Jouni Malinen <j@w1.fi> |
6fc6879b JM |
4 | * |
5 | * This program is free software; you can redistribute it and/or modify | |
6 | * it under the terms of the GNU General Public License version 2 as | |
7 | * published by the Free Software Foundation. | |
8 | * | |
9 | * Alternatively, this software may be distributed under the terms of BSD | |
10 | * license. | |
11 | * | |
12 | * See README and COPYING for more details. | |
e0498677 JM |
13 | * |
14 | * This file defines a driver interface used by both %wpa_supplicant and | |
15 | * hostapd. The first part of the file defines data structures used in various | |
16 | * driver operations. This is followed by the struct wpa_driver_ops that each | |
17 | * driver wrapper will beed to define with callback functions for requesting | |
18 | * driver operations. After this, there are definitions for driver event | |
19 | * reporting with wpa_supplicant_event() and some convenience helper functions | |
20 | * that can be used to report events. | |
6fc6879b JM |
21 | */ |
22 | ||
23 | #ifndef DRIVER_H | |
24 | #define DRIVER_H | |
25 | ||
642187d6 | 26 | #define WPA_SUPPLICANT_DRIVER_VERSION 4 |
6fc6879b | 27 | |
90973fb2 | 28 | #include "common/defs.h" |
6fc6879b | 29 | |
c5121837 JM |
30 | #define HOSTAPD_CHAN_DISABLED 0x00000001 |
31 | #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002 | |
32 | #define HOSTAPD_CHAN_NO_IBSS 0x00000004 | |
33 | #define HOSTAPD_CHAN_RADAR 0x00000008 | |
34 | ||
e0498677 JM |
35 | /** |
36 | * struct hostapd_channel_data - Channel information | |
37 | */ | |
c5121837 | 38 | struct hostapd_channel_data { |
e0498677 JM |
39 | /** |
40 | * chan - Channel number (IEEE 802.11) | |
41 | */ | |
42 | short chan; | |
43 | ||
44 | /** | |
45 | * freq - Frequency in MHz | |
46 | */ | |
47 | short freq; | |
48 | ||
49 | /** | |
50 | * flag - Channel flags (HOSTAPD_CHAN_*) | |
51 | */ | |
52 | int flag; | |
53 | ||
54 | /** | |
55 | * max_tx_power - maximum transmit power in dBm | |
56 | */ | |
57 | u8 max_tx_power; | |
c5121837 JM |
58 | }; |
59 | ||
e0498677 JM |
60 | /** |
61 | * struct hostapd_hw_modes - Supported hardware mode information | |
62 | */ | |
c5121837 | 63 | struct hostapd_hw_modes { |
e0498677 JM |
64 | /** |
65 | * mode - Hardware mode | |
66 | */ | |
71934751 | 67 | enum hostapd_hw_mode mode; |
e0498677 JM |
68 | |
69 | /** | |
70 | * num_channels - Number of entries in the channels array | |
71 | */ | |
c5121837 | 72 | int num_channels; |
e0498677 JM |
73 | |
74 | /** | |
75 | * channels - Array of supported channels | |
76 | */ | |
c5121837 | 77 | struct hostapd_channel_data *channels; |
e0498677 JM |
78 | |
79 | /** | |
80 | * num_rates - Number of entries in the rates array | |
81 | */ | |
c5121837 | 82 | int num_rates; |
e0498677 JM |
83 | |
84 | /** | |
85 | * rates - Array of supported rates in 100 kbps units | |
86 | */ | |
87 | int *rates; | |
88 | ||
89 | /** | |
90 | * ht_capab - HT (IEEE 802.11n) capabilities | |
91 | */ | |
c5121837 | 92 | u16 ht_capab; |
e0498677 JM |
93 | |
94 | /** | |
95 | * mcs_set - MCS (IEEE 802.11n) rate parameters | |
96 | */ | |
08eb154d | 97 | u8 mcs_set[16]; |
e0498677 JM |
98 | |
99 | /** | |
100 | * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters | |
101 | */ | |
be8eb8ab | 102 | u8 a_mpdu_params; |
c5121837 JM |
103 | }; |
104 | ||
105 | ||
6fc6879b JM |
106 | #define IEEE80211_MODE_INFRA 0 |
107 | #define IEEE80211_MODE_IBSS 1 | |
ad1e68e6 | 108 | #define IEEE80211_MODE_AP 2 |
6fc6879b JM |
109 | |
110 | #define IEEE80211_CAP_ESS 0x0001 | |
111 | #define IEEE80211_CAP_IBSS 0x0002 | |
112 | #define IEEE80211_CAP_PRIVACY 0x0010 | |
113 | ||
7c2849d2 JM |
114 | #define WPA_SCAN_QUAL_INVALID BIT(0) |
115 | #define WPA_SCAN_NOISE_INVALID BIT(1) | |
116 | #define WPA_SCAN_LEVEL_INVALID BIT(2) | |
117 | #define WPA_SCAN_LEVEL_DBM BIT(3) | |
e6b8efeb JM |
118 | #define WPA_SCAN_AUTHENTICATED BIT(4) |
119 | #define WPA_SCAN_ASSOCIATED BIT(5) | |
7c2849d2 | 120 | |
6fc6879b JM |
121 | /** |
122 | * struct wpa_scan_res - Scan result for an BSS/IBSS | |
7c2849d2 | 123 | * @flags: information flags about the BSS/IBSS (WPA_SCAN_*) |
6fc6879b JM |
124 | * @bssid: BSSID |
125 | * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1) | |
126 | * @beacon_int: beacon interval in TUs (host byte order) | |
127 | * @caps: capability information field in host byte order | |
128 | * @qual: signal quality | |
129 | * @noise: noise level | |
130 | * @level: signal level | |
131 | * @tsf: Timestamp | |
b3ad11bb JM |
132 | * @age: Age of the information in milliseconds (i.e., how many milliseconds |
133 | * ago the last Beacon or Probe Response frame was received) | |
6fc6879b | 134 | * @ie_len: length of the following IE field in octets |
8c090654 | 135 | * @beacon_ie_len: length of the following Beacon IE field in octets |
6fc6879b JM |
136 | * |
137 | * This structure is used as a generic format for scan results from the | |
138 | * driver. Each driver interface implementation is responsible for converting | |
139 | * the driver or OS specific scan results into this format. | |
140 | * | |
141 | * If the driver does not support reporting all IEs, the IE data structure is | |
142 | * constructed of the IEs that are available. This field will also need to | |
143 | * include SSID in IE format. All drivers are encouraged to be extended to | |
144 | * report all IEs to make it easier to support future additions. | |
145 | */ | |
146 | struct wpa_scan_res { | |
7c2849d2 | 147 | unsigned int flags; |
6fc6879b JM |
148 | u8 bssid[ETH_ALEN]; |
149 | int freq; | |
150 | u16 beacon_int; | |
151 | u16 caps; | |
152 | int qual; | |
153 | int noise; | |
154 | int level; | |
155 | u64 tsf; | |
b3ad11bb | 156 | unsigned int age; |
6fc6879b | 157 | size_t ie_len; |
8c090654 JM |
158 | size_t beacon_ie_len; |
159 | /* | |
160 | * Followed by ie_len octets of IEs from Probe Response frame (or if | |
161 | * the driver does not indicate source of IEs, these may also be from | |
162 | * Beacon frame). After the first set of IEs, another set of IEs may | |
163 | * follow (with beacon_ie_len octets of data) if the driver provides | |
164 | * both IE sets. | |
165 | */ | |
6fc6879b JM |
166 | }; |
167 | ||
168 | /** | |
169 | * struct wpa_scan_results - Scan results | |
170 | * @res: Array of pointers to allocated variable length scan result entries | |
171 | * @num: Number of entries in the scan result array | |
172 | */ | |
173 | struct wpa_scan_results { | |
174 | struct wpa_scan_res **res; | |
175 | size_t num; | |
176 | }; | |
177 | ||
4b4a8ae5 JM |
178 | /** |
179 | * struct wpa_interface_info - Network interface information | |
180 | * @next: Pointer to the next interface or NULL if this is the last one | |
181 | * @ifname: Interface name that can be used with init() or init2() | |
182 | * @desc: Human readable adapter description (e.g., vendor/model) or NULL if | |
183 | * not available | |
60ad2c7b | 184 | * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one |
4b4a8ae5 JM |
185 | * is not an allocated copy, i.e., get_interfaces() caller will not free |
186 | * this) | |
187 | */ | |
188 | struct wpa_interface_info { | |
189 | struct wpa_interface_info *next; | |
190 | char *ifname; | |
191 | char *desc; | |
192 | const char *drv_name; | |
193 | }; | |
194 | ||
fc2b7ed5 JM |
195 | #define WPAS_MAX_SCAN_SSIDS 4 |
196 | ||
197 | /** | |
198 | * struct wpa_driver_scan_params - Scan parameters | |
199 | * Data for struct wpa_driver_ops::scan2(). | |
200 | */ | |
201 | struct wpa_driver_scan_params { | |
202 | /** | |
203 | * ssids - SSIDs to scan for | |
204 | */ | |
205 | struct wpa_driver_scan_ssid { | |
206 | /** | |
207 | * ssid - specific SSID to scan for (ProbeReq) | |
208 | * %NULL or zero-length SSID is used to indicate active scan | |
ba2a573c | 209 | * with wildcard SSID. |
fc2b7ed5 JM |
210 | */ |
211 | const u8 *ssid; | |
212 | /** | |
213 | * ssid_len: Length of the SSID in octets | |
214 | */ | |
215 | size_t ssid_len; | |
216 | } ssids[WPAS_MAX_SCAN_SSIDS]; | |
217 | ||
218 | /** | |
219 | * num_ssids - Number of entries in ssids array | |
220 | * Zero indicates a request for a passive scan. | |
221 | */ | |
222 | size_t num_ssids; | |
223 | ||
224 | /** | |
225 | * extra_ies - Extra IE(s) to add into Probe Request or %NULL | |
226 | */ | |
227 | const u8 *extra_ies; | |
228 | ||
229 | /** | |
230 | * extra_ies_len - Length of extra_ies in octets | |
231 | */ | |
232 | size_t extra_ies_len; | |
d3a98225 JM |
233 | |
234 | /** | |
235 | * freqs - Array of frequencies to scan or %NULL for all frequencies | |
236 | * | |
237 | * The frequency is set in MHz. The array is zero-terminated. | |
238 | */ | |
239 | int *freqs; | |
fc2b7ed5 JM |
240 | }; |
241 | ||
c2a04078 JM |
242 | /** |
243 | * struct wpa_driver_auth_params - Authentication parameters | |
244 | * Data for struct wpa_driver_ops::authenticate(). | |
245 | */ | |
246 | struct wpa_driver_auth_params { | |
247 | int freq; | |
248 | const u8 *bssid; | |
249 | const u8 *ssid; | |
250 | size_t ssid_len; | |
251 | int auth_alg; | |
252 | const u8 *ie; | |
253 | size_t ie_len; | |
a0b2f99b JM |
254 | const u8 *wep_key[4]; |
255 | size_t wep_key_len[4]; | |
256 | int wep_tx_keyidx; | |
c2a04078 JM |
257 | }; |
258 | ||
6fc6879b JM |
259 | /** |
260 | * struct wpa_driver_associate_params - Association parameters | |
261 | * Data for struct wpa_driver_ops::associate(). | |
262 | */ | |
263 | struct wpa_driver_associate_params { | |
264 | /** | |
265 | * bssid - BSSID of the selected AP | |
266 | * This can be %NULL, if ap_scan=2 mode is used and the driver is | |
267 | * responsible for selecting with which BSS to associate. */ | |
268 | const u8 *bssid; | |
269 | ||
270 | /** | |
271 | * ssid - The selected SSID | |
272 | */ | |
273 | const u8 *ssid; | |
e0498677 JM |
274 | |
275 | /** | |
276 | * ssid_len - Length of the SSID (1..32) | |
277 | */ | |
6fc6879b JM |
278 | size_t ssid_len; |
279 | ||
280 | /** | |
281 | * freq - Frequency of the channel the selected AP is using | |
282 | * Frequency that the selected AP is using (in MHz as | |
283 | * reported in the scan results) | |
284 | */ | |
285 | int freq; | |
286 | ||
287 | /** | |
288 | * wpa_ie - WPA information element for (Re)Association Request | |
289 | * WPA information element to be included in (Re)Association | |
290 | * Request (including information element id and length). Use | |
291 | * of this WPA IE is optional. If the driver generates the WPA | |
292 | * IE, it can use pairwise_suite, group_suite, and | |
293 | * key_mgmt_suite to select proper algorithms. In this case, | |
294 | * the driver has to notify wpa_supplicant about the used WPA | |
295 | * IE by generating an event that the interface code will | |
296 | * convert into EVENT_ASSOCINFO data (see below). | |
297 | * | |
298 | * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE | |
299 | * instead. The driver can determine which version is used by | |
300 | * looking at the first byte of the IE (0xdd for WPA, 0x30 for | |
301 | * WPA2/RSN). | |
ad08c363 JM |
302 | * |
303 | * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE. | |
6fc6879b JM |
304 | */ |
305 | const u8 *wpa_ie; | |
e0498677 | 306 | |
6fc6879b JM |
307 | /** |
308 | * wpa_ie_len - length of the wpa_ie | |
309 | */ | |
310 | size_t wpa_ie_len; | |
311 | ||
e0498677 JM |
312 | /** |
313 | * pairwise_suite - Selected pairwise cipher suite | |
314 | * | |
315 | * This is usually ignored if @wpa_ie is used. | |
316 | */ | |
71934751 | 317 | enum wpa_cipher pairwise_suite; |
e0498677 JM |
318 | |
319 | /** | |
320 | * group_suite - Selected group cipher suite | |
321 | * | |
322 | * This is usually ignored if @wpa_ie is used. | |
323 | */ | |
71934751 | 324 | enum wpa_cipher group_suite; |
e0498677 JM |
325 | |
326 | /** | |
327 | * key_mgmt_suite - Selected key management suite | |
328 | * | |
329 | * This is usually ignored if @wpa_ie is used. | |
330 | */ | |
71934751 | 331 | enum wpa_key_mgmt key_mgmt_suite; |
6fc6879b JM |
332 | |
333 | /** | |
334 | * auth_alg - Allowed authentication algorithms | |
abd9fafa | 335 | * Bit field of WPA_AUTH_ALG_* |
6fc6879b JM |
336 | */ |
337 | int auth_alg; | |
338 | ||
339 | /** | |
340 | * mode - Operation mode (infra/ibss) IEEE80211_MODE_* | |
341 | */ | |
342 | int mode; | |
343 | ||
344 | /** | |
345 | * wep_key - WEP keys for static WEP configuration | |
346 | */ | |
347 | const u8 *wep_key[4]; | |
348 | ||
349 | /** | |
350 | * wep_key_len - WEP key length for static WEP configuration | |
351 | */ | |
352 | size_t wep_key_len[4]; | |
353 | ||
354 | /** | |
355 | * wep_tx_keyidx - WEP TX key index for static WEP configuration | |
356 | */ | |
357 | int wep_tx_keyidx; | |
358 | ||
359 | /** | |
360 | * mgmt_frame_protection - IEEE 802.11w management frame protection | |
361 | */ | |
70f8cc8e | 362 | enum mfp_options mgmt_frame_protection; |
6fc6879b JM |
363 | |
364 | /** | |
365 | * ft_ies - IEEE 802.11r / FT information elements | |
366 | * If the supplicant is using IEEE 802.11r (FT) and has the needed keys | |
367 | * for fast transition, this parameter is set to include the IEs that | |
368 | * are to be sent in the next FT Authentication Request message. | |
369 | * update_ft_ies() handler is called to update the IEs for further | |
370 | * FT messages in the sequence. | |
371 | * | |
372 | * The driver should use these IEs only if the target AP is advertising | |
373 | * the same mobility domain as the one included in the MDIE here. | |
374 | * | |
375 | * In ap_scan=2 mode, the driver can use these IEs when moving to a new | |
376 | * AP after the initial association. These IEs can only be used if the | |
377 | * target AP is advertising support for FT and is using the same MDIE | |
378 | * and SSID as the current AP. | |
379 | * | |
380 | * The driver is responsible for reporting the FT IEs received from the | |
381 | * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE | |
382 | * type. update_ft_ies() handler will then be called with the FT IEs to | |
383 | * include in the next frame in the authentication sequence. | |
384 | */ | |
385 | const u8 *ft_ies; | |
386 | ||
387 | /** | |
388 | * ft_ies_len - Length of ft_ies in bytes | |
389 | */ | |
390 | size_t ft_ies_len; | |
391 | ||
392 | /** | |
393 | * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies) | |
394 | * | |
395 | * This value is provided to allow the driver interface easier access | |
396 | * to the current mobility domain. This value is set to %NULL if no | |
397 | * mobility domain is currently active. | |
398 | */ | |
399 | const u8 *ft_md; | |
400 | ||
401 | /** | |
402 | * passphrase - RSN passphrase for PSK | |
403 | * | |
404 | * This value is made available only for WPA/WPA2-Personal (PSK) and | |
405 | * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is | |
406 | * the 8..63 character ASCII passphrase, if available. Please note that | |
407 | * this can be %NULL if passphrase was not used to generate the PSK. In | |
408 | * that case, the psk field must be used to fetch the PSK. | |
409 | */ | |
410 | const char *passphrase; | |
411 | ||
412 | /** | |
413 | * psk - RSN PSK (alternative for passphrase for PSK) | |
414 | * | |
415 | * This value is made available only for WPA/WPA2-Personal (PSK) and | |
416 | * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is | |
417 | * the 32-octet (256-bit) PSK, if available. The driver wrapper should | |
418 | * be prepared to handle %NULL value as an error. | |
419 | */ | |
420 | const u8 *psk; | |
36b15723 JM |
421 | |
422 | /** | |
423 | * drop_unencrypted - Enable/disable unencrypted frame filtering | |
424 | * | |
425 | * Configure the driver to drop all non-EAPOL frames (both receive and | |
426 | * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must | |
427 | * still be allowed for key negotiation. | |
428 | */ | |
429 | int drop_unencrypted; | |
62fa124c JM |
430 | |
431 | /** | |
432 | * prev_bssid - Previously used BSSID in this ESS | |
433 | * | |
434 | * When not %NULL, this is a request to use reassociation instead of | |
435 | * association. | |
436 | */ | |
437 | const u8 *prev_bssid; | |
6fc6879b JM |
438 | }; |
439 | ||
440 | /** | |
441 | * struct wpa_driver_capa - Driver capability information | |
442 | */ | |
443 | struct wpa_driver_capa { | |
444 | #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001 | |
445 | #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002 | |
446 | #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004 | |
447 | #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008 | |
448 | #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010 | |
449 | #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020 | |
450 | #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040 | |
451 | unsigned int key_mgmt; | |
452 | ||
453 | #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001 | |
454 | #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002 | |
455 | #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004 | |
456 | #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008 | |
457 | unsigned int enc; | |
458 | ||
459 | #define WPA_DRIVER_AUTH_OPEN 0x00000001 | |
460 | #define WPA_DRIVER_AUTH_SHARED 0x00000002 | |
461 | #define WPA_DRIVER_AUTH_LEAP 0x00000004 | |
462 | unsigned int auth; | |
463 | ||
464 | /* Driver generated WPA/RSN IE */ | |
465 | #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001 | |
0194fedb | 466 | /* Driver needs static WEP key setup after association command */ |
6fc6879b JM |
467 | #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002 |
468 | #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004 | |
469 | /* Driver takes care of RSN 4-way handshake internally; PMK is configured with | |
470 | * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */ | |
471 | #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008 | |
4ef1e644 | 472 | #define WPA_DRIVER_FLAGS_WIRED 0x00000010 |
c2a04078 JM |
473 | /* Driver provides separate commands for authentication and association (SME in |
474 | * wpa_supplicant). */ | |
475 | #define WPA_DRIVER_FLAGS_SME 0x00000020 | |
1581b38b JM |
476 | /* Driver supports AP mode */ |
477 | #define WPA_DRIVER_FLAGS_AP 0x00000040 | |
0194fedb JB |
478 | /* Driver needs static WEP key setup after association has been completed */ |
479 | #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080 | |
6fc6879b | 480 | unsigned int flags; |
80bc75f1 JM |
481 | |
482 | int max_scan_ssids; | |
6fc6879b JM |
483 | }; |
484 | ||
485 | ||
c5121837 JM |
486 | struct hostapd_data; |
487 | ||
488 | struct hostap_sta_driver_data { | |
489 | unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes; | |
490 | unsigned long current_tx_rate; | |
491 | unsigned long inactive_msec; | |
492 | unsigned long flags; | |
493 | unsigned long num_ps_buf_frames; | |
494 | unsigned long tx_retry_failed; | |
495 | unsigned long tx_retry_count; | |
496 | int last_rssi; | |
497 | int last_ack_rssi; | |
498 | }; | |
499 | ||
500 | struct hostapd_sta_add_params { | |
501 | const u8 *addr; | |
502 | u16 aid; | |
503 | u16 capability; | |
504 | const u8 *supp_rates; | |
505 | size_t supp_rates_len; | |
c5121837 | 506 | u16 listen_interval; |
fc4e2d95 | 507 | const struct ieee80211_ht_capabilities *ht_capabilities; |
c5121837 JM |
508 | }; |
509 | ||
510 | struct hostapd_freq_params { | |
511 | int mode; | |
512 | int freq; | |
513 | int channel; | |
514 | int ht_enabled; | |
515 | int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled, | |
516 | * secondary channel below primary, 1 = HT40 | |
517 | * enabled, secondary channel above primary */ | |
518 | }; | |
519 | ||
22a7c9d7 JM |
520 | enum wpa_driver_if_type { |
521 | /** | |
522 | * WPA_IF_STATION - Station mode interface | |
523 | */ | |
524 | WPA_IF_STATION, | |
525 | ||
526 | /** | |
527 | * WPA_IF_AP_VLAN - AP mode VLAN interface | |
528 | * | |
529 | * This interface shares its address and Beacon frame with the main | |
530 | * BSS. | |
531 | */ | |
532 | WPA_IF_AP_VLAN, | |
533 | ||
534 | /** | |
535 | * WPA_IF_AP_BSS - AP mode BSS interface | |
536 | * | |
537 | * This interface has its own address and Beacon frame. | |
538 | */ | |
539 | WPA_IF_AP_BSS, | |
c5121837 JM |
540 | }; |
541 | ||
92f475b4 JM |
542 | struct wpa_init_params { |
543 | const u8 *bssid; | |
544 | const char *ifname; | |
545 | const u8 *ssid; | |
546 | size_t ssid_len; | |
547 | const char *test_socket; | |
548 | int use_pae_group_addr; | |
92f475b4 JM |
549 | char **bridge; |
550 | size_t num_bridge; | |
412036f5 JM |
551 | |
552 | u8 *own_addr; /* buffer for writing own MAC address */ | |
92f475b4 JM |
553 | }; |
554 | ||
c5121837 | 555 | |
e3bd3912 JM |
556 | struct wpa_bss_params { |
557 | /** Interface name (for multi-SSID/VLAN support) */ | |
558 | const char *ifname; | |
559 | /** Whether IEEE 802.1X or WPA/WPA2 is enabled */ | |
560 | int enabled; | |
af586419 JM |
561 | |
562 | int wpa; | |
563 | int ieee802_1x; | |
564 | int wpa_group; | |
565 | int wpa_pairwise; | |
566 | int wpa_key_mgmt; | |
567 | int rsn_preauth; | |
e3bd3912 JM |
568 | }; |
569 | ||
0de39516 JM |
570 | #define WPA_STA_AUTHORIZED BIT(0) |
571 | #define WPA_STA_WMM BIT(1) | |
572 | #define WPA_STA_SHORT_PREAMBLE BIT(2) | |
573 | #define WPA_STA_MFP BIT(3) | |
e3bd3912 | 574 | |
6fc6879b JM |
575 | /** |
576 | * struct wpa_driver_ops - Driver interface API definition | |
577 | * | |
578 | * This structure defines the API that each driver interface needs to implement | |
579 | * for core wpa_supplicant code. All driver specific functionality is captured | |
580 | * in this wrapper. | |
581 | */ | |
582 | struct wpa_driver_ops { | |
583 | /** Name of the driver interface */ | |
584 | const char *name; | |
585 | /** One line description of the driver interface */ | |
586 | const char *desc; | |
587 | ||
588 | /** | |
589 | * get_bssid - Get the current BSSID | |
590 | * @priv: private driver interface data | |
591 | * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes) | |
592 | * | |
593 | * Returns: 0 on success, -1 on failure | |
594 | * | |
595 | * Query kernel driver for the current BSSID and copy it to bssid. | |
596 | * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not | |
597 | * associated. | |
598 | */ | |
599 | int (*get_bssid)(void *priv, u8 *bssid); | |
600 | ||
601 | /** | |
602 | * get_ssid - Get the current SSID | |
603 | * @priv: private driver interface data | |
604 | * @ssid: buffer for SSID (at least 32 bytes) | |
605 | * | |
606 | * Returns: Length of the SSID on success, -1 on failure | |
607 | * | |
608 | * Query kernel driver for the current SSID and copy it to ssid. | |
609 | * Returning zero is recommended if the STA is not associated. | |
610 | * | |
611 | * Note: SSID is an array of octets, i.e., it is not nul terminated and | |
612 | * can, at least in theory, contain control characters (including nul) | |
613 | * and as such, should be processed as binary data, not a printable | |
614 | * string. | |
615 | */ | |
616 | int (*get_ssid)(void *priv, u8 *ssid); | |
617 | ||
6fc6879b JM |
618 | /** |
619 | * set_key - Configure encryption key | |
642187d6 | 620 | * @ifname: Interface name (for multi-SSID/VLAN support) |
6fc6879b JM |
621 | * @priv: private driver interface data |
622 | * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP, | |
623 | * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK); | |
624 | * %WPA_ALG_NONE clears the key. | |
625 | * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for | |
626 | * broadcast/default keys | |
627 | * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for | |
628 | * IGTK | |
629 | * @set_tx: configure this key as the default Tx key (only used when | |
630 | * driver does not support separate unicast/individual key | |
631 | * @seq: sequence number/packet number, seq_len octets, the next | |
632 | * packet number to be used for in replay protection; configured | |
633 | * for Rx keys (in most cases, this is only used with broadcast | |
634 | * keys and set to zero for unicast keys) | |
635 | * @seq_len: length of the seq, depends on the algorithm: | |
636 | * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets | |
637 | * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key, | |
638 | * 8-byte Rx Mic Key | |
639 | * @key_len: length of the key buffer in octets (WEP: 5 or 13, | |
640 | * TKIP: 32, CCMP: 16, IGTK: 16) | |
641 | * | |
642 | * Returns: 0 on success, -1 on failure | |
643 | * | |
644 | * Configure the given key for the kernel driver. If the driver | |
645 | * supports separate individual keys (4 default keys + 1 individual), | |
646 | * addr can be used to determine whether the key is default or | |
647 | * individual. If only 4 keys are supported, the default key with key | |
648 | * index 0 is used as the individual key. STA must be configured to use | |
649 | * it as the default Tx key (set_tx is set) and accept Rx for all the | |
650 | * key indexes. In most cases, WPA uses only key indexes 1 and 2 for | |
651 | * broadcast keys, so key index 0 is available for this kind of | |
652 | * configuration. | |
653 | * | |
654 | * Please note that TKIP keys include separate TX and RX MIC keys and | |
655 | * some drivers may expect them in different order than wpa_supplicant | |
656 | * is using. If the TX/RX keys are swapped, all TKIP encrypted packets | |
657 | * will tricker Michael MIC errors. This can be fixed by changing the | |
658 | * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key | |
659 | * in driver_*.c set_key() implementation, see driver_ndis.c for an | |
660 | * example on how this can be done. | |
661 | */ | |
71934751 | 662 | int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg, |
642187d6 JM |
663 | const u8 *addr, int key_idx, int set_tx, |
664 | const u8 *seq, size_t seq_len, | |
6fc6879b JM |
665 | const u8 *key, size_t key_len); |
666 | ||
667 | /** | |
668 | * init - Initialize driver interface | |
669 | * @ctx: context to be used when calling wpa_supplicant functions, | |
670 | * e.g., wpa_supplicant_event() | |
671 | * @ifname: interface name, e.g., wlan0 | |
672 | * | |
673 | * Returns: Pointer to private data, %NULL on failure | |
674 | * | |
675 | * Initialize driver interface, including event processing for kernel | |
676 | * driver events (e.g., associated, scan results, Michael MIC failure). | |
677 | * This function can allocate a private configuration data area for | |
678 | * @ctx, file descriptor, interface name, etc. information that may be | |
679 | * needed in future driver operations. If this is not used, non-NULL | |
680 | * value will need to be returned because %NULL is used to indicate | |
681 | * failure. The returned value will be used as 'void *priv' data for | |
682 | * all other driver_ops functions. | |
683 | * | |
684 | * The main event loop (eloop.c) of wpa_supplicant can be used to | |
685 | * register callback for read sockets (eloop_register_read_sock()). | |
686 | * | |
687 | * See below for more information about events and | |
688 | * wpa_supplicant_event() function. | |
689 | */ | |
690 | void * (*init)(void *ctx, const char *ifname); | |
691 | ||
692 | /** | |
693 | * deinit - Deinitialize driver interface | |
694 | * @priv: private driver interface data from init() | |
695 | * | |
696 | * Shut down driver interface and processing of driver events. Free | |
697 | * private data buffer if one was allocated in init() handler. | |
698 | */ | |
699 | void (*deinit)(void *priv); | |
700 | ||
701 | /** | |
702 | * set_param - Set driver configuration parameters | |
703 | * @priv: private driver interface data from init() | |
704 | * @param: driver specific configuration parameters | |
705 | * | |
706 | * Returns: 0 on success, -1 on failure | |
707 | * | |
708 | * Optional handler for notifying driver interface about configuration | |
709 | * parameters (driver_param). | |
710 | */ | |
711 | int (*set_param)(void *priv, const char *param); | |
712 | ||
713 | /** | |
714 | * set_countermeasures - Enable/disable TKIP countermeasures | |
715 | * @priv: private driver interface data | |
716 | * @enabled: 1 = countermeasures enabled, 0 = disabled | |
717 | * | |
718 | * Returns: 0 on success, -1 on failure | |
719 | * | |
720 | * Configure TKIP countermeasures. When these are enabled, the driver | |
721 | * should drop all received and queued frames that are using TKIP. | |
722 | */ | |
723 | int (*set_countermeasures)(void *priv, int enabled); | |
724 | ||
6fc6879b JM |
725 | /** |
726 | * deauthenticate - Request driver to deauthenticate | |
727 | * @priv: private driver interface data | |
728 | * @addr: peer address (BSSID of the AP) | |
729 | * @reason_code: 16-bit reason code to be sent in the deauthentication | |
730 | * frame | |
731 | * | |
732 | * Returns: 0 on success, -1 on failure | |
733 | */ | |
734 | int (*deauthenticate)(void *priv, const u8 *addr, int reason_code); | |
735 | ||
736 | /** | |
737 | * disassociate - Request driver to disassociate | |
738 | * @priv: private driver interface data | |
739 | * @addr: peer address (BSSID of the AP) | |
740 | * @reason_code: 16-bit reason code to be sent in the disassociation | |
741 | * frame | |
742 | * | |
743 | * Returns: 0 on success, -1 on failure | |
744 | */ | |
745 | int (*disassociate)(void *priv, const u8 *addr, int reason_code); | |
746 | ||
747 | /** | |
748 | * associate - Request driver to associate | |
749 | * @priv: private driver interface data | |
750 | * @params: association parameters | |
751 | * | |
752 | * Returns: 0 on success, -1 on failure | |
753 | */ | |
754 | int (*associate)(void *priv, | |
755 | struct wpa_driver_associate_params *params); | |
756 | ||
6fc6879b JM |
757 | /** |
758 | * add_pmkid - Add PMKSA cache entry to the driver | |
759 | * @priv: private driver interface data | |
760 | * @bssid: BSSID for the PMKSA cache entry | |
761 | * @pmkid: PMKID for the PMKSA cache entry | |
762 | * | |
763 | * Returns: 0 on success, -1 on failure | |
764 | * | |
765 | * This function is called when a new PMK is received, as a result of | |
766 | * either normal authentication or RSN pre-authentication. | |
767 | * | |
768 | * If the driver generates RSN IE, i.e., it does not use wpa_ie in | |
769 | * associate(), add_pmkid() can be used to add new PMKSA cache entries | |
770 | * in the driver. If the driver uses wpa_ie from wpa_supplicant, this | |
771 | * driver_ops function does not need to be implemented. Likewise, if | |
772 | * the driver does not support WPA, this function is not needed. | |
773 | */ | |
774 | int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid); | |
775 | ||
776 | /** | |
777 | * remove_pmkid - Remove PMKSA cache entry to the driver | |
778 | * @priv: private driver interface data | |
779 | * @bssid: BSSID for the PMKSA cache entry | |
780 | * @pmkid: PMKID for the PMKSA cache entry | |
781 | * | |
782 | * Returns: 0 on success, -1 on failure | |
783 | * | |
784 | * This function is called when the supplicant drops a PMKSA cache | |
785 | * entry for any reason. | |
786 | * | |
787 | * If the driver generates RSN IE, i.e., it does not use wpa_ie in | |
788 | * associate(), remove_pmkid() can be used to synchronize PMKSA caches | |
789 | * between the driver and wpa_supplicant. If the driver uses wpa_ie | |
790 | * from wpa_supplicant, this driver_ops function does not need to be | |
791 | * implemented. Likewise, if the driver does not support WPA, this | |
792 | * function is not needed. | |
793 | */ | |
794 | int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid); | |
795 | ||
796 | /** | |
797 | * flush_pmkid - Flush PMKSA cache | |
798 | * @priv: private driver interface data | |
799 | * | |
800 | * Returns: 0 on success, -1 on failure | |
801 | * | |
802 | * This function is called when the supplicant drops all PMKSA cache | |
803 | * entries for any reason. | |
804 | * | |
805 | * If the driver generates RSN IE, i.e., it does not use wpa_ie in | |
806 | * associate(), remove_pmkid() can be used to synchronize PMKSA caches | |
807 | * between the driver and wpa_supplicant. If the driver uses wpa_ie | |
808 | * from wpa_supplicant, this driver_ops function does not need to be | |
809 | * implemented. Likewise, if the driver does not support WPA, this | |
810 | * function is not needed. | |
811 | */ | |
812 | int (*flush_pmkid)(void *priv); | |
813 | ||
814 | /** | |
6179d2fd | 815 | * get_capa - Get driver capabilities |
6fc6879b JM |
816 | * @priv: private driver interface data |
817 | * | |
818 | * Returns: 0 on success, -1 on failure | |
819 | * | |
820 | * Get driver/firmware/hardware capabilities. | |
821 | */ | |
822 | int (*get_capa)(void *priv, struct wpa_driver_capa *capa); | |
823 | ||
824 | /** | |
825 | * poll - Poll driver for association information | |
826 | * @priv: private driver interface data | |
827 | * | |
828 | * This is an option callback that can be used when the driver does not | |
829 | * provide event mechanism for association events. This is called when | |
830 | * receiving WPA EAPOL-Key messages that require association | |
831 | * information. The driver interface is supposed to generate associnfo | |
832 | * event before returning from this callback function. In addition, the | |
833 | * driver interface should generate an association event after having | |
834 | * sent out associnfo. | |
835 | */ | |
836 | void (*poll)(void *priv); | |
837 | ||
838 | /** | |
839 | * get_ifname - Get interface name | |
840 | * @priv: private driver interface data | |
841 | * | |
842 | * Returns: Pointer to the interface name. This can differ from the | |
e519314e | 843 | * interface name used in init() call. Init() is called first. |
6fc6879b JM |
844 | * |
845 | * This optional function can be used to allow the driver interface to | |
846 | * replace the interface name with something else, e.g., based on an | |
847 | * interface mapping from a more descriptive name. | |
848 | */ | |
849 | const char * (*get_ifname)(void *priv); | |
850 | ||
851 | /** | |
852 | * get_mac_addr - Get own MAC address | |
853 | * @priv: private driver interface data | |
854 | * | |
855 | * Returns: Pointer to own MAC address or %NULL on failure | |
856 | * | |
857 | * This optional function can be used to get the own MAC address of the | |
858 | * device from the driver interface code. This is only needed if the | |
859 | * l2_packet implementation for the OS does not provide easy access to | |
860 | * a MAC address. */ | |
861 | const u8 * (*get_mac_addr)(void *priv); | |
862 | ||
863 | /** | |
864 | * send_eapol - Optional function for sending EAPOL packets | |
865 | * @priv: private driver interface data | |
866 | * @dest: Destination MAC address | |
867 | * @proto: Ethertype | |
868 | * @data: EAPOL packet starting with IEEE 802.1X header | |
869 | * @data_len: Size of the EAPOL packet | |
870 | * | |
871 | * Returns: 0 on success, -1 on failure | |
872 | * | |
873 | * This optional function can be used to override l2_packet operations | |
874 | * with driver specific functionality. If this function pointer is set, | |
875 | * l2_packet module is not used at all and the driver interface code is | |
876 | * responsible for receiving and sending all EAPOL packets. The | |
a8e0505b JM |
877 | * received EAPOL packets are sent to core code with EVENT_EAPOL_RX |
878 | * event. The driver interface is required to implement get_mac_addr() | |
879 | * handler if send_eapol() is used. | |
6fc6879b JM |
880 | */ |
881 | int (*send_eapol)(void *priv, const u8 *dest, u16 proto, | |
882 | const u8 *data, size_t data_len); | |
883 | ||
884 | /** | |
885 | * set_operstate - Sets device operating state to DORMANT or UP | |
886 | * @priv: private driver interface data | |
887 | * @state: 0 = dormant, 1 = up | |
888 | * Returns: 0 on success, -1 on failure | |
889 | * | |
890 | * This is an optional function that can be used on operating systems | |
891 | * that support a concept of controlling network device state from user | |
892 | * space applications. This function, if set, gets called with | |
893 | * state = 1 when authentication has been completed and with state = 0 | |
894 | * when connection is lost. | |
895 | */ | |
896 | int (*set_operstate)(void *priv, int state); | |
897 | ||
898 | /** | |
899 | * mlme_setprotection - MLME-SETPROTECTION.request primitive | |
900 | * @priv: Private driver interface data | |
901 | * @addr: Address of the station for which to set protection (may be | |
902 | * %NULL for group keys) | |
903 | * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_* | |
904 | * @key_type: MLME_SETPROTECTION_KEY_TYPE_* | |
905 | * Returns: 0 on success, -1 on failure | |
906 | * | |
907 | * This is an optional function that can be used to set the driver to | |
908 | * require protection for Tx and/or Rx frames. This uses the layer | |
909 | * interface defined in IEEE 802.11i-2004 clause 10.3.22.1 | |
910 | * (MLME-SETPROTECTION.request). Many drivers do not use explicit | |
911 | * set protection operation; instead, they set protection implicitly | |
912 | * based on configured keys. | |
913 | */ | |
914 | int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type, | |
915 | int key_type); | |
916 | ||
917 | /** | |
918 | * get_hw_feature_data - Get hardware support data (channels and rates) | |
919 | * @priv: Private driver interface data | |
920 | * @num_modes: Variable for returning the number of returned modes | |
921 | * flags: Variable for returning hardware feature flags | |
922 | * Returns: Pointer to allocated hardware data on success or %NULL on | |
923 | * failure. Caller is responsible for freeing this. | |
924 | * | |
925 | * This function is only needed for drivers that export MLME | |
e0498677 | 926 | * (management frame processing) to %wpa_supplicant or hostapd. |
6fc6879b | 927 | */ |
6caf9ca6 JM |
928 | struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv, |
929 | u16 *num_modes, | |
930 | u16 *flags); | |
6fc6879b JM |
931 | |
932 | /** | |
933 | * set_channel - Set channel | |
934 | * @priv: Private driver interface data | |
6caf9ca6 | 935 | * @phymode: HOSTAPD_MODE_IEEE80211B, .. |
6fc6879b JM |
936 | * @chan: IEEE 802.11 channel number |
937 | * @freq: Frequency of the channel in MHz | |
938 | * Returns: 0 on success, -1 on failure | |
939 | * | |
940 | * This function is only needed for drivers that export MLME | |
941 | * (management frame processing) to wpa_supplicant. | |
942 | */ | |
71934751 | 943 | int (*set_channel)(void *priv, enum hostapd_hw_mode phymode, int chan, |
6fc6879b JM |
944 | int freq); |
945 | ||
946 | /** | |
947 | * set_ssid - Set SSID | |
948 | * @priv: Private driver interface data | |
949 | * @ssid: SSID | |
950 | * @ssid_len: SSID length | |
951 | * Returns: 0 on success, -1 on failure | |
952 | * | |
953 | * This function is only needed for drivers that export MLME | |
954 | * (management frame processing) to wpa_supplicant. | |
955 | */ | |
956 | int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len); | |
957 | ||
958 | /** | |
959 | * set_bssid - Set BSSID | |
960 | * @priv: Private driver interface data | |
961 | * @bssid: BSSID | |
962 | * Returns: 0 on success, -1 on failure | |
963 | * | |
964 | * This function is only needed for drivers that export MLME | |
965 | * (management frame processing) to wpa_supplicant. | |
966 | */ | |
967 | int (*set_bssid)(void *priv, const u8 *bssid); | |
968 | ||
969 | /** | |
970 | * send_mlme - Send management frame from MLME | |
971 | * @priv: Private driver interface data | |
972 | * @data: IEEE 802.11 management frame with IEEE 802.11 header | |
973 | * @data_len: Size of the management frame | |
974 | * Returns: 0 on success, -1 on failure | |
975 | * | |
976 | * This function is only needed for drivers that export MLME | |
977 | * (management frame processing) to wpa_supplicant. | |
978 | */ | |
979 | int (*send_mlme)(void *priv, const u8 *data, size_t data_len); | |
980 | ||
981 | /** | |
982 | * mlme_add_sta - Add a STA entry into the driver/netstack | |
983 | * @priv: Private driver interface data | |
984 | * @addr: MAC address of the STA (e.g., BSSID of the AP) | |
985 | * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11 | |
986 | * format (one octet per rate, 1 = 0.5 Mbps) | |
987 | * @supp_rates_len: Number of entries in supp_rates | |
988 | * Returns: 0 on success, -1 on failure | |
989 | * | |
990 | * This function is only needed for drivers that export MLME | |
991 | * (management frame processing) to wpa_supplicant. When the MLME code | |
992 | * completes association with an AP, this function is called to | |
993 | * configure the driver/netstack with a STA entry for data frame | |
994 | * processing (TX rate control, encryption/decryption). | |
995 | */ | |
996 | int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates, | |
997 | size_t supp_rates_len); | |
998 | ||
999 | /** | |
1000 | * mlme_remove_sta - Remove a STA entry from the driver/netstack | |
1001 | * @priv: Private driver interface data | |
1002 | * @addr: MAC address of the STA (e.g., BSSID of the AP) | |
1003 | * Returns: 0 on success, -1 on failure | |
1004 | * | |
1005 | * This function is only needed for drivers that export MLME | |
1006 | * (management frame processing) to wpa_supplicant. | |
1007 | */ | |
1008 | int (*mlme_remove_sta)(void *priv, const u8 *addr); | |
1009 | ||
1010 | /** | |
1011 | * update_ft_ies - Update FT (IEEE 802.11r) IEs | |
1012 | * @priv: Private driver interface data | |
1013 | * @md: Mobility domain (2 octets) (also included inside ies) | |
1014 | * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs | |
1015 | * @ies_len: Length of FT IEs in bytes | |
1016 | * Returns: 0 on success, -1 on failure | |
1017 | * | |
1018 | * The supplicant uses this callback to let the driver know that keying | |
1019 | * material for FT is available and that the driver can use the | |
1020 | * provided IEs in the next message in FT authentication sequence. | |
1021 | * | |
1022 | * This function is only needed for driver that support IEEE 802.11r | |
1023 | * (Fast BSS Transition). | |
1024 | */ | |
1025 | int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies, | |
1026 | size_t ies_len); | |
1027 | ||
1028 | /** | |
1029 | * send_ft_action - Send FT Action frame (IEEE 802.11r) | |
1030 | * @priv: Private driver interface data | |
1031 | * @action: Action field value | |
1032 | * @target_ap: Target AP address | |
1033 | * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body) | |
1034 | * @ies_len: Length of FT IEs in bytes | |
1035 | * Returns: 0 on success, -1 on failure | |
1036 | * | |
1037 | * The supplicant uses this callback to request the driver to transmit | |
1038 | * an FT Action frame (action category 6) for over-the-DS fast BSS | |
1039 | * transition. | |
1040 | */ | |
1041 | int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap, | |
1042 | const u8 *ies, size_t ies_len); | |
1043 | ||
1044 | /** | |
1045 | * get_scan_results2 - Fetch the latest scan results | |
1046 | * @priv: private driver interface data | |
1047 | * | |
1048 | * Returns: Allocated buffer of scan results (caller is responsible for | |
1049 | * freeing the data structure) on success, NULL on failure | |
1050 | */ | |
1051 | struct wpa_scan_results * (*get_scan_results2)(void *priv); | |
1052 | ||
6d158490 LR |
1053 | /** |
1054 | * set_country - Set country | |
1055 | * @priv: Private driver interface data | |
1056 | * @alpha2: country to which to switch to | |
1057 | * Returns: 0 on success, -1 on failure | |
1058 | * | |
1059 | * This function is for drivers which support some form | |
1060 | * of setting a regulatory domain. | |
1061 | */ | |
1062 | int (*set_country)(void *priv, const char *alpha2); | |
ac305589 JM |
1063 | |
1064 | /** | |
1065 | * global_init - Global driver initialization | |
1066 | * Returns: Pointer to private data (global), %NULL on failure | |
1067 | * | |
1068 | * This optional function is called to initialize the driver wrapper | |
1069 | * for global data, i.e., data that applies to all interfaces. If this | |
1070 | * function is implemented, global_deinit() will also need to be | |
1071 | * implemented to free the private data. The driver will also likely | |
1072 | * use init2() function instead of init() to get the pointer to global | |
1073 | * data available to per-interface initializer. | |
1074 | */ | |
1075 | void * (*global_init)(void); | |
1076 | ||
1077 | /** | |
1078 | * global_deinit - Global driver deinitialization | |
1079 | * @priv: private driver global data from global_init() | |
1080 | * | |
1081 | * Terminate any global driver related functionality and free the | |
1082 | * global data structure. | |
1083 | */ | |
1084 | void (*global_deinit)(void *priv); | |
1085 | ||
1086 | /** | |
1087 | * init2 - Initialize driver interface (with global data) | |
1088 | * @ctx: context to be used when calling wpa_supplicant functions, | |
1089 | * e.g., wpa_supplicant_event() | |
1090 | * @ifname: interface name, e.g., wlan0 | |
1091 | * @global_priv: private driver global data from global_init() | |
1092 | * Returns: Pointer to private data, %NULL on failure | |
1093 | * | |
1094 | * This function can be used instead of init() if the driver wrapper | |
1095 | * uses global data. | |
1096 | */ | |
1097 | void * (*init2)(void *ctx, const char *ifname, void *global_priv); | |
4b4a8ae5 JM |
1098 | |
1099 | /** | |
1100 | * get_interfaces - Get information about available interfaces | |
1101 | * @global_priv: private driver global data from global_init() | |
1102 | * Returns: Allocated buffer of interface information (caller is | |
1103 | * responsible for freeing the data structure) on success, NULL on | |
1104 | * failure | |
1105 | */ | |
1106 | struct wpa_interface_info * (*get_interfaces)(void *global_priv); | |
fc2b7ed5 JM |
1107 | |
1108 | /** | |
1109 | * scan2 - Request the driver to initiate scan | |
1110 | * @priv: private driver interface data | |
1111 | * @params: Scan parameters | |
1112 | * | |
1113 | * Returns: 0 on success, -1 on failure | |
1114 | * | |
1115 | * Once the scan results are ready, the driver should report scan | |
1116 | * results event for wpa_supplicant which will eventually request the | |
1117 | * results with wpa_driver_get_scan_results2(). | |
1118 | */ | |
1119 | int (*scan2)(void *priv, struct wpa_driver_scan_params *params); | |
c2a04078 JM |
1120 | |
1121 | /** | |
1122 | * authenticate - Request driver to authenticate | |
1123 | * @priv: private driver interface data | |
1124 | * @params: authentication parameters | |
1125 | * Returns: 0 on success, -1 on failure | |
1126 | * | |
1127 | * This is an optional function that can be used with drivers that | |
1128 | * support separate authentication and association steps, i.e., when | |
1129 | * wpa_supplicant can act as the SME. If not implemented, associate() | |
1130 | * function is expected to take care of IEEE 802.11 authentication, | |
1131 | * too. | |
1132 | */ | |
d2440ba0 JM |
1133 | int (*authenticate)(void *priv, |
1134 | struct wpa_driver_auth_params *params); | |
1135 | ||
15333707 JM |
1136 | /** |
1137 | * set_beacon - Set Beacon frame template | |
1138 | * @iface: Interface name (main interface or virtual BSS) | |
1139 | * @priv: Private driver interface data | |
1140 | * @head: Beacon head from IEEE 802.11 header to IEs before TIM IE | |
1141 | * @head_len: Length of the head buffer in octets | |
1142 | * @tail: Beacon tail following TIM IE | |
1143 | * @tail_len: Length of the tail buffer in octets | |
1144 | * @dtim_period: DTIM period | |
1145 | * @beacon_int: Beacon interval | |
1146 | * Returns: 0 on success, -1 on failure | |
1147 | * | |
1148 | * This function is used to configure Beacon template for the driver in | |
1149 | * AP mode. The driver is responsible for building the full Beacon | |
1150 | * frame by concatenating the head part with TIM IE generated by the | |
1151 | * driver/firmware and finishing with the tail part. | |
1152 | */ | |
5d674872 JM |
1153 | int (*set_beacon)(const char *ifname, void *priv, |
1154 | const u8 *head, size_t head_len, | |
1155 | const u8 *tail, size_t tail_len, int dtim_period, | |
1156 | int beacon_int); | |
c5121837 | 1157 | |
15333707 JM |
1158 | /** |
1159 | * hapd_init - Initialize driver interface (hostapd only) | |
1160 | * @hapd: Pointer to hostapd context | |
1161 | * @params: Configuration for the driver wrapper | |
1162 | * Returns: Pointer to private data, %NULL on failure | |
1163 | * | |
1164 | * This function is used instead of init() or init2() when the driver | |
1165 | * wrapper is used withh hostapd. | |
1166 | */ | |
92f475b4 JM |
1167 | void * (*hapd_init)(struct hostapd_data *hapd, |
1168 | struct wpa_init_params *params); | |
15333707 JM |
1169 | |
1170 | /** | |
1171 | * hapd_deinit - Deinitialize driver interface (hostapd only) | |
1172 | * @priv: Private driver interface data from hapd_init() | |
1173 | */ | |
c5121837 JM |
1174 | void (*hapd_deinit)(void *priv); |
1175 | ||
1176 | /** | |
15333707 | 1177 | * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only) |
15333707 | 1178 | * @priv: Private driver interface data |
e3bd3912 | 1179 | * @params: BSS parameters |
c5121837 JM |
1180 | * Returns: 0 on success, -1 on failure |
1181 | * | |
15333707 | 1182 | * This is an optional function to configure the kernel driver to |
e3bd3912 JM |
1183 | * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This |
1184 | * can be left undefined (set to %NULL) if IEEE 802.1X support is | |
1185 | * always enabled and the driver uses set_beacon() to set WPA/RSN IE | |
1186 | * for Beacon frames. | |
c5121837 | 1187 | */ |
e3bd3912 | 1188 | int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params); |
c5121837 JM |
1189 | |
1190 | /** | |
15333707 JM |
1191 | * set_privacy - Enable/disable privacy (AP only) |
1192 | * @priv: Private driver interface data | |
c5121837 | 1193 | * @enabled: 1 = privacy enabled, 0 = disabled |
15333707 | 1194 | * Returns: 0 on success, -1 on failure |
c5121837 | 1195 | * |
15333707 JM |
1196 | * This is an optional function to configure privacy field in the |
1197 | * kernel driver for Beacon frames. This can be left undefined (set to | |
1198 | * %NULL) if the driver uses the Beacon template from set_beacon(). | |
c5121837 JM |
1199 | */ |
1200 | int (*set_privacy)(const char *ifname, void *priv, int enabled); | |
1201 | ||
15333707 JM |
1202 | /** |
1203 | * get_seqnum - Fetch the current TSC/packet number (AP only) | |
1204 | * @ifname: The interface name (main or virtual) | |
1205 | * @priv: Private driver interface data | |
1206 | * @addr: MAC address of the station or %NULL for group keys | |
1207 | * @idx: Key index | |
1208 | * @seq: Buffer for returning the latest used TSC/packet number | |
1209 | * Returns: 0 on success, -1 on failure | |
1210 | * | |
1211 | * This function is used to fetch the last used TSC/packet number for | |
9008a3e4 JM |
1212 | * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so |
1213 | * there is no strict requirement on implementing support for unicast | |
1214 | * keys (i.e., addr != %NULL). | |
15333707 | 1215 | */ |
c5121837 JM |
1216 | int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr, |
1217 | int idx, u8 *seq); | |
15333707 | 1218 | |
15333707 JM |
1219 | /** |
1220 | * flush - Flush all association stations (AP only) | |
1221 | * @priv: Private driver interface data | |
1222 | * Returns: 0 on success, -1 on failure | |
1223 | * | |
1224 | * This function requests the driver to disassociate all associated | |
1225 | * stations. This function does not need to be implemented if the | |
1226 | * driver does not process association frames internally. | |
1227 | */ | |
c5121837 | 1228 | int (*flush)(void *priv); |
15333707 JM |
1229 | |
1230 | /** | |
1231 | * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP) | |
1232 | * @ifname: The interface name (main or virtual BSS) | |
1233 | * @priv: Private driver interface data | |
1234 | * @elem: Information elements | |
1235 | * @elem_len: Length of the elem buffer in octets | |
1236 | * Returns: 0 on success, -1 on failure | |
1237 | * | |
1238 | * This is an optional function to add information elements in the | |
1239 | * kernel driver for Beacon and Probe Response frames. This can be left | |
1240 | * undefined (set to %NULL) if the driver uses the Beacon template from | |
1241 | * set_beacon(). | |
1242 | */ | |
c5121837 JM |
1243 | int (*set_generic_elem)(const char *ifname, void *priv, const u8 *elem, |
1244 | size_t elem_len); | |
1245 | ||
15333707 JM |
1246 | /** |
1247 | * read_sta_data - Fetch station data (AP only) | |
1248 | * @priv: Private driver interface data | |
1249 | * @data: Buffer for returning station information | |
1250 | * @addr: MAC address of the station | |
1251 | * Returns: 0 on success, -1 on failure | |
1252 | */ | |
c5121837 JM |
1253 | int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data, |
1254 | const u8 *addr); | |
15333707 JM |
1255 | |
1256 | /** | |
1257 | * hapd_send_eapol - Send an EAPOL packet (AP only) | |
1258 | * @priv: private driver interface data | |
1259 | * @addr: Destination MAC address | |
1260 | * @data: EAPOL packet starting with IEEE 802.1X header | |
1261 | * @data_len: Length of the EAPOL packet in octets | |
1262 | * @encrypt: Whether the frame should be encrypted | |
1263 | * @own_addr: Source MAC address | |
1264 | * | |
1265 | * Returns: 0 on success, -1 on failure | |
1266 | */ | |
c5121837 JM |
1267 | int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data, |
1268 | size_t data_len, int encrypt, | |
1269 | const u8 *own_addr); | |
15333707 | 1270 | |
90b8c4c5 JM |
1271 | /** |
1272 | * sta_deauth - Deauthenticate a station (AP only) | |
1273 | * @priv: Private driver interface data | |
1274 | * @own_addr: Source address and BSSID for the Deauthentication frame | |
1275 | * @addr: MAC address of the station to deauthenticate | |
1276 | * @reason: Reason code for the Deauthentiation frame | |
1277 | * Returns: 0 on success, -1 on failure | |
1278 | * | |
1279 | * This function requests a specific station to be deauthenticated and | |
1280 | * a Deauthentication frame to be sent to it. | |
1281 | */ | |
731723a5 JM |
1282 | int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr, |
1283 | int reason); | |
90b8c4c5 JM |
1284 | |
1285 | /** | |
1286 | * sta_disassoc - Disassociate a station (AP only) | |
1287 | * @priv: Private driver interface data | |
1288 | * @own_addr: Source address and BSSID for the Disassociation frame | |
1289 | * @addr: MAC address of the station to disassociate | |
1290 | * @reason: Reason code for the Disassociation frame | |
1291 | * Returns: 0 on success, -1 on failure | |
1292 | * | |
1293 | * This function requests a specific station to be disassociated and | |
1294 | * a Disassociation frame to be sent to it. | |
1295 | */ | |
731723a5 JM |
1296 | int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr, |
1297 | int reason); | |
90b8c4c5 JM |
1298 | |
1299 | /** | |
1300 | * sta_remove - Remove a station entry (AP only) | |
1301 | * @priv: Private driver interface data | |
1302 | * @addr: MAC address of the station to be removed | |
1303 | * Returns: 0 on success, -1 on failure | |
1304 | */ | |
c5121837 | 1305 | int (*sta_remove)(void *priv, const u8 *addr); |
90b8c4c5 JM |
1306 | |
1307 | /** | |
1308 | * hapd_get_ssid - Get the current SSID (AP only) | |
1309 | * @ifname: Interface (master or virtual BSS) | |
1310 | * @priv: Private driver interface data | |
1311 | * @buf: Buffer for returning the SSID | |
1312 | * @len: Maximum length of the buffer | |
1313 | * Returns: Length of the SSID on success, -1 on failure | |
1314 | * | |
1315 | * This function need not be implemented if the driver uses Beacon | |
1316 | * template from set_beacon() and does not reply to Probe Request | |
1317 | * frames. | |
1318 | */ | |
c5121837 | 1319 | int (*hapd_get_ssid)(const char *ifname, void *priv, u8 *buf, int len); |
90b8c4c5 JM |
1320 | |
1321 | /** | |
1322 | * hapd_set_ssid - Set SSID (AP only) | |
1323 | * @ifname: Interface (master or virtual BSS) | |
1324 | * @priv: Private driver interface data | |
1325 | * @buf: SSID | |
1326 | * @len: Length of the SSID in octets | |
1327 | * Returns: 0 on success, -1 on failure | |
1328 | */ | |
c5121837 JM |
1329 | int (*hapd_set_ssid)(const char *ifname, void *priv, const u8 *buf, |
1330 | int len); | |
90b8c4c5 JM |
1331 | /** |
1332 | * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP) | |
1333 | * @priv: Private driver interface data | |
1334 | * @enabled: 1 = countermeasures enabled, 0 = disabled | |
1335 | * Returns: 0 on success, -1 on failure | |
1336 | * | |
1337 | * This need not be implemented if the driver does not take care of | |
1338 | * association processing. | |
1339 | */ | |
c5121837 | 1340 | int (*hapd_set_countermeasures)(void *priv, int enabled); |
90b8c4c5 JM |
1341 | |
1342 | /** | |
1343 | * sta_add - Add a station entry | |
1344 | * @ifname: Interface (master or virtual) | |
1345 | * @priv: Private driver interface data | |
1346 | * @params: Station parameters | |
1347 | * Returns: 0 on success, -1 on failure | |
1348 | * | |
1349 | * This function is used to add a station entry to the driver once the | |
1350 | * station has completed association. This is only used if the driver | |
1351 | * does not take care of association processing. | |
1352 | */ | |
c5121837 JM |
1353 | int (*sta_add)(const char *ifname, void *priv, |
1354 | struct hostapd_sta_add_params *params); | |
90b8c4c5 JM |
1355 | |
1356 | /** | |
1357 | * get_inact_sec - Get station inactivity duration (AP only) | |
1358 | * @priv: Private driver interface data | |
1359 | * @addr: Station address | |
1360 | * Returns: Number of seconds station has been inactive, -1 on failure | |
1361 | */ | |
c5121837 | 1362 | int (*get_inact_sec)(void *priv, const u8 *addr); |
90b8c4c5 JM |
1363 | |
1364 | /** | |
1365 | * sta_clear_stats - Clear station statistics (AP only) | |
1366 | * @priv: Private driver interface data | |
1367 | * @addr: Station address | |
1368 | * Returns: 0 on success, -1 on failure | |
1369 | */ | |
c5121837 JM |
1370 | int (*sta_clear_stats)(void *priv, const u8 *addr); |
1371 | ||
90b8c4c5 JM |
1372 | /** |
1373 | * set_freq - Set channel/frequency (AP only) | |
1374 | * @priv: Private driver interface data | |
1375 | * @freq: Channel parameters | |
1376 | * Returns: 0 on success, -1 on failure | |
1377 | */ | |
c5121837 | 1378 | int (*set_freq)(void *priv, struct hostapd_freq_params *freq); |
90b8c4c5 JM |
1379 | |
1380 | /** | |
1381 | * set_rts - Set RTS threshold | |
1382 | * @priv: Private driver interface data | |
1383 | * @rts: RTS threshold in octets | |
1384 | * Returns: 0 on success, -1 on failure | |
1385 | */ | |
c5121837 | 1386 | int (*set_rts)(void *priv, int rts); |
90b8c4c5 JM |
1387 | |
1388 | /** | |
1389 | * set_frag - Set fragmentation threshold | |
1390 | * @priv: Private driver interface data | |
1391 | * @frag: Fragmentation threshold in octets | |
1392 | * Returns: 0 on success, -1 on failure | |
1393 | */ | |
c5121837 | 1394 | int (*set_frag)(void *priv, int frag); |
c5121837 | 1395 | |
90b8c4c5 JM |
1396 | /** |
1397 | * sta_set_flags - Set station flags (AP only) | |
1398 | * @priv: Private driver interface data | |
1399 | * @addr: Station address | |
0de39516 JM |
1400 | * @total_flags: Bitmap of all WPA_STA_* flags currently set |
1401 | * @flags_or: Bitmap of WPA_STA_* flags to add | |
1402 | * @flags_and: Bitmap of WPA_STA_* flags to us as a mask | |
90b8c4c5 JM |
1403 | * Returns: 0 on success, -1 on failure |
1404 | */ | |
c5121837 JM |
1405 | int (*sta_set_flags)(void *priv, const u8 *addr, |
1406 | int total_flags, int flags_or, int flags_and); | |
90b8c4c5 JM |
1407 | |
1408 | /** | |
1409 | * set_rate_sets - Set supported and basic rate sets (AP only) | |
1410 | * @priv: Private driver interface data | |
1411 | * @supp_rates: -1 terminated array of supported rates in 100 kbps | |
1412 | * @basic_rates: -1 terminated array of basic rates in 100 kbps | |
1413 | * @mode: hardware mode (HOSTAPD_MODE_*) | |
1414 | * Returns: 0 on success, -1 on failure | |
1415 | */ | |
c5121837 JM |
1416 | int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates, |
1417 | int mode); | |
c5121837 | 1418 | |
90b8c4c5 JM |
1419 | /** |
1420 | * set_cts_protect - Set CTS protection mode (AP only) | |
1421 | * @priv: Private driver interface data | |
1422 | * @value: Whether CTS protection is enabled | |
1423 | * Returns: 0 on success, -1 on failure | |
1424 | */ | |
c5121837 | 1425 | int (*set_cts_protect)(void *priv, int value); |
90b8c4c5 JM |
1426 | |
1427 | /** | |
1428 | * set_preamble - Set preamble mode (AP only) | |
1429 | * @priv: Private driver interface data | |
1430 | * @value: Whether short preamble is enabled | |
1431 | * Returns: 0 on success, -1 on failure | |
1432 | */ | |
c5121837 | 1433 | int (*set_preamble)(void *priv, int value); |
90b8c4c5 JM |
1434 | |
1435 | /** | |
1436 | * set_short_slot_time - Set short slot time (AP only) | |
1437 | * @priv: Private driver interface data | |
1438 | * @value: Whether short slot time is enabled | |
1439 | * Returns: 0 on success, -1 on failure | |
1440 | */ | |
c5121837 | 1441 | int (*set_short_slot_time)(void *priv, int value); |
90b8c4c5 JM |
1442 | |
1443 | /** | |
1444 | * set_tx_queue_params - Set TX queue parameters | |
1445 | * @priv: Private driver interface data | |
1446 | * @queue: Queue number | |
1447 | * @aifs: AIFS | |
1448 | * @cw_min: cwMin | |
1449 | * @cw_max: cwMax | |
1450 | * @burst_time: Maximum length for bursting in 0.1 msec units | |
1451 | */ | |
c5121837 JM |
1452 | int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min, |
1453 | int cw_max, int burst_time); | |
90b8c4c5 JM |
1454 | |
1455 | /** | |
1456 | * valid_bss_mask - Validate BSSID mask | |
1457 | * @priv: Private driver interface data | |
1458 | * @addr: Address | |
1459 | * @mask: Mask | |
1460 | * Returns: 0 if mask is valid, -1 if mask is not valid, 1 if mask can | |
1461 | * be used, but the main interface address must be the first address in | |
1462 | * the block if mask is applied | |
1463 | */ | |
c5121837 | 1464 | int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask); |
22a7c9d7 JM |
1465 | |
1466 | /** | |
1467 | * if_add - Add a virtual interface | |
22a7c9d7 | 1468 | * @iface: Parent interface name |
15333707 | 1469 | * @priv: Private driver interface data |
22a7c9d7 JM |
1470 | * @type: Interface type |
1471 | * @ifname: Interface name for the new virtual interface | |
1472 | * @addr: Local address to use for the interface or %NULL to use the | |
1473 | * parent interface address | |
8043e725 | 1474 | * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces |
22a7c9d7 JM |
1475 | * Returns: 0 on success, -1 on failure |
1476 | */ | |
c5121837 | 1477 | int (*if_add)(const char *iface, void *priv, |
22a7c9d7 | 1478 | enum wpa_driver_if_type type, const char *ifname, |
8043e725 | 1479 | const u8 *addr, void *bss_ctx); |
22a7c9d7 JM |
1480 | |
1481 | /** | |
1482 | * if_remove - Remove a virtual interface | |
1483 | * @priv: Private driver interface data | |
1484 | * @type: Interface type | |
1485 | * @ifname: Interface name of the virtual interface to be removed | |
1486 | * Returns: 0 on success, -1 on failure | |
1487 | */ | |
1488 | int (*if_remove)(void *priv, enum wpa_driver_if_type type, | |
1489 | const char *ifname); | |
90b8c4c5 | 1490 | |
15333707 JM |
1491 | /** |
1492 | * set_sta_vlan - Bind a station into a specific interface (AP only) | |
1493 | * @priv: Private driver interface data | |
1494 | * @ifname: Interface (main or virtual BSS or VLAN) | |
1495 | * @addr: MAC address of the associated station | |
1496 | * @vlan_id: VLAN ID | |
1497 | * Returns: 0 on success, -1 on failure | |
1498 | * | |
1499 | * This function is used to bind a station to a specific virtual | |
1500 | * interface. It is only used if when virtual interfaces are supported, | |
1501 | * e.g., to assign stations to different VLAN interfaces based on | |
1502 | * information from a RADIUS server. This allows separate broadcast | |
1503 | * domains to be used with a single BSS. | |
1504 | */ | |
c5121837 JM |
1505 | int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname, |
1506 | int vlan_id); | |
15333707 | 1507 | |
c5121837 | 1508 | /** |
15333707 | 1509 | * commit - Optional commit changes handler (AP only) |
c5121837 JM |
1510 | * @priv: driver private data |
1511 | * Returns: 0 on success, -1 on failure | |
1512 | * | |
1513 | * This optional handler function can be registered if the driver | |
1514 | * interface implementation needs to commit changes (e.g., by setting | |
1515 | * network interface up) at the end of initial configuration. If set, | |
1516 | * this handler will be called after initial setup has been completed. | |
1517 | */ | |
1518 | int (*commit)(void *priv); | |
1519 | ||
90b8c4c5 JM |
1520 | /** |
1521 | * send_ether - Send an ethernet packet (AP only) | |
1522 | * @priv: private driver interface data | |
1523 | * @dst: Destination MAC address | |
1524 | * @src: Source MAC address | |
1525 | * @proto: Ethertype | |
1526 | * @data: EAPOL packet starting with IEEE 802.1X header | |
1527 | * @data_len: Length of the EAPOL packet in octets | |
1528 | * Returns: 0 on success, -1 on failure | |
1529 | */ | |
c5121837 JM |
1530 | int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto, |
1531 | const u8 *data, size_t data_len); | |
1532 | ||
90b8c4c5 JM |
1533 | /** |
1534 | * set_radius_acl_auth - Notification of RADIUS ACL change | |
1535 | * @priv: Private driver interface data | |
1536 | * @mac: MAC address of the station | |
1537 | * @accepted: Whether the station was accepted | |
1538 | * @session_timeout: Session timeout for the station | |
1539 | * Returns: 0 on success, -1 on failure | |
1540 | */ | |
c5121837 JM |
1541 | int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted, |
1542 | u32 session_timeout); | |
90b8c4c5 JM |
1543 | |
1544 | /** | |
1545 | * set_radius_acl_expire - Notification of RADIUS ACL expiration | |
1546 | * @priv: Private driver interface data | |
1547 | * @mac: MAC address of the station | |
1548 | * Returns: 0 on success, -1 on failure | |
1549 | */ | |
c5121837 JM |
1550 | int (*set_radius_acl_expire)(void *priv, const u8 *mac); |
1551 | ||
90b8c4c5 JM |
1552 | /** |
1553 | * set_ht_params - Set HT parameters (AP only) | |
1554 | * @ifname: The interface name (main or virtual BSS) | |
1555 | * @priv: Private driver interface data | |
1556 | * @ht_capab: HT Capabilities IE | |
1557 | * @ht_capab_len: Length of ht_capab in octets | |
1558 | * @ht_oper: HT Operation IE | |
1559 | * @ht_oper_len: Length of ht_oper in octets | |
1560 | * Returns: 0 on success, -1 on failure | |
1561 | */ | |
c5121837 JM |
1562 | int (*set_ht_params)(const char *ifname, void *priv, |
1563 | const u8 *ht_capab, size_t ht_capab_len, | |
1564 | const u8 *ht_oper, size_t ht_oper_len); | |
1565 | ||
15333707 | 1566 | /** |
14f79386 | 1567 | * set_ap_wps_ie - Add WPS IE into Beacon/Probe Response frames (AP) |
15333707 JM |
1568 | * @ifname: The interface name (main or virtual BSS) |
1569 | * @priv: Private driver interface data | |
14f79386 JM |
1570 | * @beacon: WPS IE for Beacon frames |
1571 | * @proberesp: WPS IE for Probe Response frames | |
15333707 JM |
1572 | * Returns: 0 on success, -1 on failure |
1573 | * | |
1574 | * This is an optional function to add WPS IE in the kernel driver for | |
14f79386 JM |
1575 | * Beacon and Probe Response frames. This can be left undefined (set |
1576 | * to %NULL) if the driver uses the Beacon template from set_beacon() | |
1577 | * and does not process Probe Request frames. | |
15333707 | 1578 | */ |
14f79386 JM |
1579 | int (*set_ap_wps_ie)(const char *ifname, void *priv, |
1580 | const struct wpabuf *beacon, | |
1581 | const struct wpabuf *proberesp); | |
4bc181ec JM |
1582 | |
1583 | /** | |
1584 | * set_supp_port - Set IEEE 802.1X Supplicant Port status | |
1585 | * @priv: Private driver interface data | |
1586 | * @authorized: Whether the port is authorized | |
1587 | * Returns: 0 on success, -1 on failure | |
1588 | */ | |
1589 | int (*set_supp_port)(void *priv, int authorized); | |
fbbfcbac FF |
1590 | |
1591 | /** | |
1592 | * set_wds_sta - Bind a station into a 4-address WDS (AP only) | |
1593 | * @priv: Private driver interface data | |
1594 | * @addr: MAC address of the associated station | |
1595 | * @aid: Association ID | |
1596 | * @val: 1 = bind to 4-address WDS; 0 = unbind | |
1597 | * Returns: 0 on success, -1 on failure | |
1598 | */ | |
1599 | int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val); | |
504e905c | 1600 | |
55777702 JM |
1601 | /** |
1602 | * send_action - Transmit an Action frame | |
1603 | * @priv: Private driver interface data | |
1604 | * @freq: Frequency (in MHz) of the channel | |
e8828999 JM |
1605 | * @dst: Destination MAC address (Address 1) |
1606 | * @src: Source MAC address (Address 2) | |
1607 | * @bssid: BSSID (Address 3) | |
55777702 JM |
1608 | * @data: Frame body |
1609 | * @data_len: data length in octets | |
1610 | * Returns: 0 on success, -1 on failure | |
1611 | * | |
1612 | * This command can be used to request the driver to transmit an action | |
1613 | * frame to the specified destination. If a remain-on-channel duration | |
1614 | * is in progress, the frame is transmitted on that channel. Otherwise, | |
1615 | * the frame is transmitted on the current operational channel if in | |
1616 | * associated state in station mode or if operating as an AP. If none | |
1617 | * of these conditions is in effect, send_action() cannot be used. | |
1618 | */ | |
1619 | int (*send_action)(void *priv, unsigned int freq, | |
e8828999 | 1620 | const u8 *dst, const u8 *src, const u8 *bssid, |
55777702 JM |
1621 | const u8 *data, size_t data_len); |
1622 | ||
7bfc47c3 JM |
1623 | /** |
1624 | * alloc_interface_addr - Allocate a virtual interface address | |
1625 | * @priv: Private driver interface data | |
1626 | * @addr: Buffer for returning the address | |
b7a2b0b6 | 1627 | * @ifname: Buffer for returning interface name (if needed) |
7bfc47c3 JM |
1628 | * Returns: 0 on success, -1 on failure |
1629 | * | |
1630 | * This command pre-allocates an interface address for a new virtual | |
1631 | * interface. This can be used before creating a virtual interface if | |
1632 | * the interface mode (e.g., AP vs. station) is not yet known, but the | |
1633 | * address of the virtual interface is already needed. This helps with | |
1634 | * drivers that cannot change interface mode without destroying and | |
b7a2b0b6 JM |
1635 | * re-creating the interface. If the driver requires a specific |
1636 | * interface name to be used, the ifname buffer (up to IFNAMSIZ | |
1637 | * characters) will be used to indicate which name must be used for | |
1638 | * this virtual interface. | |
7bfc47c3 | 1639 | * |
b7a2b0b6 | 1640 | * The allocated address can be used in a if_add() call to request a |
7bfc47c3 JM |
1641 | * specific bssid. |
1642 | */ | |
b7a2b0b6 | 1643 | int (*alloc_interface_addr)(void *priv, u8 *addr, char *ifname); |
7bfc47c3 JM |
1644 | |
1645 | /** | |
1646 | * release_interface_addr - Release a virtual interface address | |
1647 | * @priv: Private driver interface data | |
1648 | * @addr: Address to be freed from alloc_interface_addr() | |
1649 | * | |
1650 | * This command is used to release a virtual interface address that was | |
1651 | * allocated with alloc_interface_addr(), but has not yet been used | |
b7a2b0b6 | 1652 | * with if_add() to actually create the interface. This allows the |
7bfc47c3 JM |
1653 | * driver to release the pending allocation for a new interface. |
1654 | */ | |
1655 | void (*release_interface_addr)(void *priv, const u8 *addr); | |
1656 | ||
55777702 JM |
1657 | /** |
1658 | * remain_on_channel - Remain awake on a channel | |
1659 | * @priv: Private driver interface data | |
1660 | * @freq: Frequency (in MHz) of the channel | |
1661 | * @duration: Duration in milliseconds | |
1662 | * Returns: 0 on success, -1 on failure | |
1663 | * | |
1664 | * This command is used to request the driver to remain awake on the | |
1665 | * specified channel for the specified duration and report received | |
1666 | * Action frames with EVENT_RX_ACTION events. Optionally, received | |
1667 | * Probe Request frames may also be requested to be reported by calling | |
1668 | * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ. | |
1669 | * | |
1670 | * The driver may not be at the requested channel when this function | |
1671 | * returns, i.e., the return code is only indicating whether the | |
1672 | * request was accepted. The caller will need to wait until the | |
1673 | * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has | |
1674 | * completed the channel change. This may take some time due to other | |
1675 | * need for the radio and the caller should be prepared to timing out | |
1676 | * its wait since there are no guarantees on when this request can be | |
1677 | * executed. | |
1678 | */ | |
1679 | int (*remain_on_channel)(void *priv, unsigned int freq, | |
1680 | unsigned int duration); | |
1681 | ||
1682 | /** | |
1683 | * cancel_remain_on_channel - Cancel remain-on-channel operation | |
1684 | * @priv: Private driver interface data | |
1685 | * | |
1686 | * This command can be used to cancel a remain-on-channel operation | |
1687 | * before its originally requested duration has passed. This could be | |
1688 | * used, e.g., when remain_on_channel() is used to request extra time | |
1689 | * to receive a response to an Action frame and the response is | |
1690 | * received when there is still unneeded time remaining on the | |
1691 | * remain-on-channel operation. | |
1692 | */ | |
1693 | int (*cancel_remain_on_channel)(void *priv); | |
1694 | ||
504e905c JM |
1695 | /** |
1696 | * probe_req_report - Request Probe Request frames to be indicated | |
1697 | * @priv: Private driver interface data | |
1698 | * @report: Whether to report received Probe Request frames | |
1699 | * Returns: 0 on success, -1 on failure (or if not supported) | |
1700 | * | |
1701 | * This command can be used to request the driver to indicate when | |
1702 | * Probe Request frames are received with EVENT_RX_PROBE_REQ events. | |
1703 | * Since this operation may require extra resources, e.g., due to less | |
1704 | * optimal hardware/firmware RX filtering, many drivers may disable | |
1705 | * Probe Request reporting at least in station mode. This command is | |
1706 | * used to notify the driver when the Probe Request frames need to be | |
1707 | * reported, e.g., during remain-on-channel operations. | |
1708 | */ | |
1709 | int (*probe_req_report)(void *priv, int report); | |
4e5cb1a3 JM |
1710 | |
1711 | /** | |
1712 | * disable_11b_rates - Set whether IEEE 802.11b rates are used for TX | |
1713 | * @priv: Private driver interface data | |
1714 | * @disabled: Whether IEEE 802.11b rates are disabled | |
1715 | * Returns: 0 on success, -1 on failure (or if not supported) | |
1716 | * | |
1717 | * This command is used to disable IEEE 802.11b rates (1, 2, 5.5, and | |
1718 | * 11 Mbps) as TX rates for data and management frames. This can be | |
1719 | * used to optimize channel use when there is no need to support IEEE | |
1720 | * 802.11b-only devices. | |
1721 | */ | |
1722 | int (*disable_11b_rates)(void *priv, int disabled); | |
af473088 JM |
1723 | |
1724 | /** | |
1725 | * deinit_ap - Deinitialize AP mode | |
1726 | * @priv: Private driver interface data | |
1727 | * Returns: 0 on success, -1 on failure (or if not supported) | |
1728 | * | |
1729 | * This optional function can be used to disable AP mode related | |
1730 | * configuration and change the driver mode to station mode to allow | |
1731 | * normal station operations like scanning to be completed. | |
1732 | */ | |
1733 | int (*deinit_ap)(void *priv); | |
6fc6879b JM |
1734 | }; |
1735 | ||
e0498677 | 1736 | |
6fc6879b JM |
1737 | /** |
1738 | * enum wpa_event_type - Event type for wpa_supplicant_event() calls | |
1739 | */ | |
9646a8ab | 1740 | enum wpa_event_type { |
6fc6879b JM |
1741 | /** |
1742 | * EVENT_ASSOC - Association completed | |
1743 | * | |
1744 | * This event needs to be delivered when the driver completes IEEE | |
1745 | * 802.11 association or reassociation successfully. | |
1746 | * wpa_driver_ops::get_bssid() is expected to provide the current BSSID | |
1747 | * after this event has been generated. In addition, optional | |
1748 | * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide | |
1749 | * more information about the association. If the driver interface gets | |
1750 | * both of these events at the same time, it can also include the | |
1751 | * assoc_info data in EVENT_ASSOC call. | |
1752 | */ | |
1753 | EVENT_ASSOC, | |
1754 | ||
1755 | /** | |
1756 | * EVENT_DISASSOC - Association lost | |
1757 | * | |
1758 | * This event should be called when association is lost either due to | |
1759 | * receiving deauthenticate or disassociate frame from the AP or when | |
c2a04078 JM |
1760 | * sending either of these frames to the current AP. If the driver |
1761 | * supports separate deauthentication event, EVENT_DISASSOC should only | |
1762 | * be used for disassociation and EVENT_DEAUTH for deauthentication. | |
1d041bec | 1763 | * In AP mode, union wpa_event_data::disassoc_info is required. |
6fc6879b JM |
1764 | */ |
1765 | EVENT_DISASSOC, | |
1766 | ||
1767 | /** | |
1768 | * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected | |
1769 | * | |
1770 | * This event must be delivered when a Michael MIC error is detected by | |
1771 | * the local driver. Additional data for event processing is | |
1772 | * provided with union wpa_event_data::michael_mic_failure. This | |
1773 | * information is used to request new encyption key and to initiate | |
1774 | * TKIP countermeasures if needed. | |
1775 | */ | |
1776 | EVENT_MICHAEL_MIC_FAILURE, | |
1777 | ||
1778 | /** | |
1779 | * EVENT_SCAN_RESULTS - Scan results available | |
1780 | * | |
1781 | * This event must be called whenever scan results are available to be | |
1782 | * fetched with struct wpa_driver_ops::get_scan_results(). This event | |
1783 | * is expected to be used some time after struct wpa_driver_ops::scan() | |
1784 | * is called. If the driver provides an unsolicited event when the scan | |
1785 | * has been completed, this event can be used to trigger | |
1786 | * EVENT_SCAN_RESULTS call. If such event is not available from the | |
1787 | * driver, the driver wrapper code is expected to use a registered | |
1788 | * timeout to generate EVENT_SCAN_RESULTS call after the time that the | |
8d923a4a JM |
1789 | * scan is expected to be completed. Optional information about |
1790 | * completed scan can be provided with union wpa_event_data::scan_info. | |
6fc6879b JM |
1791 | */ |
1792 | EVENT_SCAN_RESULTS, | |
1793 | ||
1794 | /** | |
1795 | * EVENT_ASSOCINFO - Report optional extra information for association | |
1796 | * | |
1797 | * This event can be used to report extra association information for | |
1798 | * EVENT_ASSOC processing. This extra information includes IEs from | |
1799 | * association frames and Beacon/Probe Response frames in union | |
1800 | * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before | |
1801 | * EVENT_ASSOC. Alternatively, the driver interface can include | |
1802 | * assoc_info data in the EVENT_ASSOC call if it has all the | |
1803 | * information available at the same point. | |
1804 | */ | |
1805 | EVENT_ASSOCINFO, | |
1806 | ||
1807 | /** | |
1808 | * EVENT_INTERFACE_STATUS - Report interface status changes | |
1809 | * | |
1810 | * This optional event can be used to report changes in interface | |
1811 | * status (interface added/removed) using union | |
1812 | * wpa_event_data::interface_status. This can be used to trigger | |
1813 | * wpa_supplicant to stop and re-start processing for the interface, | |
1814 | * e.g., when a cardbus card is ejected/inserted. | |
1815 | */ | |
1816 | EVENT_INTERFACE_STATUS, | |
1817 | ||
1818 | /** | |
1819 | * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication | |
1820 | * | |
1821 | * This event can be used to inform wpa_supplicant about candidates for | |
1822 | * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible | |
1823 | * for scan request (ap_scan=2 mode), this event is required for | |
1824 | * pre-authentication. If wpa_supplicant is performing scan request | |
1825 | * (ap_scan=1), this event is optional since scan results can be used | |
1826 | * to add pre-authentication candidates. union | |
1827 | * wpa_event_data::pmkid_candidate is used to report the BSSID of the | |
1828 | * candidate and priority of the candidate, e.g., based on the signal | |
1829 | * strength, in order to try to pre-authenticate first with candidates | |
1830 | * that are most likely targets for re-association. | |
1831 | * | |
1832 | * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates | |
1833 | * on the candidate list. In addition, it can be called for the current | |
1834 | * AP and APs that have existing PMKSA cache entries. wpa_supplicant | |
1835 | * will automatically skip pre-authentication in cases where a valid | |
1836 | * PMKSA exists. When more than one candidate exists, this event should | |
1837 | * be generated once for each candidate. | |
1838 | * | |
1839 | * Driver will be notified about successful pre-authentication with | |
1840 | * struct wpa_driver_ops::add_pmkid() calls. | |
1841 | */ | |
1842 | EVENT_PMKID_CANDIDATE, | |
1843 | ||
1844 | /** | |
1845 | * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request) | |
1846 | * | |
1847 | * This event can be used to inform wpa_supplicant about desire to set | |
1848 | * up secure direct link connection between two stations as defined in | |
1849 | * IEEE 802.11e with a new PeerKey mechanism that replaced the original | |
1850 | * STAKey negotiation. The caller will need to set peer address for the | |
1851 | * event. | |
1852 | */ | |
1853 | EVENT_STKSTART, | |
1854 | ||
1855 | /** | |
1856 | * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs | |
1857 | * | |
1858 | * The driver is expected to report the received FT IEs from | |
1859 | * FT authentication sequence from the AP. The FT IEs are included in | |
1860 | * the extra information in union wpa_event_data::ft_ies. | |
1861 | */ | |
11ef8d35 JM |
1862 | EVENT_FT_RESPONSE, |
1863 | ||
1864 | /** | |
1865 | * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS | |
1866 | * | |
1867 | * The driver can use this event to inform wpa_supplicant about a STA | |
1868 | * in an IBSS with which protected frames could be exchanged. This | |
1869 | * event starts RSN authentication with the other STA to authenticate | |
1870 | * the STA and set up encryption keys with it. | |
1871 | */ | |
c2a04078 JM |
1872 | EVENT_IBSS_RSN_START, |
1873 | ||
1874 | /** | |
1875 | * EVENT_AUTH - Authentication result | |
1876 | * | |
1877 | * This event should be called when authentication attempt has been | |
1878 | * completed. This is only used if the driver supports separate | |
1879 | * authentication step (struct wpa_driver_ops::authenticate). | |
1880 | * Information about authentication result is included in | |
1881 | * union wpa_event_data::auth. | |
1882 | */ | |
1883 | EVENT_AUTH, | |
1884 | ||
1885 | /** | |
1886 | * EVENT_DEAUTH - Authentication lost | |
1887 | * | |
1888 | * This event should be called when authentication is lost either due | |
1889 | * to receiving deauthenticate frame from the AP or when sending that | |
1890 | * frame to the current AP. | |
1d041bec | 1891 | * In AP mode, union wpa_event_data::deauth_info is required. |
c2a04078 | 1892 | */ |
efa46078 JM |
1893 | EVENT_DEAUTH, |
1894 | ||
1895 | /** | |
1896 | * EVENT_ASSOC_REJECT - Association rejected | |
1897 | * | |
1898 | * This event should be called when (re)association attempt has been | |
1899 | * rejected by the AP. Information about authentication result is | |
1900 | * included in union wpa_event_data::assoc_reject. | |
1901 | */ | |
da1fb17c JM |
1902 | EVENT_ASSOC_REJECT, |
1903 | ||
1904 | /** | |
1905 | * EVENT_AUTH_TIMED_OUT - Authentication timed out | |
1906 | */ | |
1907 | EVENT_AUTH_TIMED_OUT, | |
1908 | ||
1909 | /** | |
1910 | * EVENT_ASSOC_TIMED_OUT - Association timed out | |
1911 | */ | |
08fd8c15 JM |
1912 | EVENT_ASSOC_TIMED_OUT, |
1913 | ||
1914 | /** | |
1915 | * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received | |
1916 | */ | |
fcf0f87d JM |
1917 | EVENT_FT_RRB_RX, |
1918 | ||
1919 | /** | |
1920 | * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS | |
1921 | */ | |
f8b1f695 JM |
1922 | EVENT_WPS_BUTTON_PUSHED, |
1923 | ||
1924 | /** | |
1925 | * EVENT_TX_STATUS - Report TX status | |
1926 | */ | |
1927 | EVENT_TX_STATUS, | |
1928 | ||
1929 | /** | |
1930 | * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA | |
1931 | */ | |
1932 | EVENT_RX_FROM_UNKNOWN, | |
1933 | ||
1934 | /** | |
1935 | * EVENT_RX_MGMT - Report RX of a management frame | |
1936 | */ | |
245519e0 JM |
1937 | EVENT_RX_MGMT, |
1938 | ||
55777702 JM |
1939 | /** |
1940 | * EVENT_RX_ACTION - Action frame received | |
1941 | * | |
1942 | * This event is used to indicate when an Action frame has been | |
1943 | * received. Information about the received frame is included in | |
1944 | * union wpa_event_data::rx_action. | |
1945 | */ | |
1946 | EVENT_RX_ACTION, | |
1947 | ||
1948 | /** | |
1949 | * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started | |
1950 | * | |
1951 | * This event is used to indicate when the driver has started the | |
1952 | * requested remain-on-channel duration. Information about the | |
1953 | * operation is included in union wpa_event_data::remain_on_channel. | |
1954 | */ | |
1955 | EVENT_REMAIN_ON_CHANNEL, | |
1956 | ||
1957 | /** | |
1958 | * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out | |
1959 | * | |
1960 | * This event is used to indicate when the driver has completed | |
1961 | * remain-on-channel duration, i.e., may noot be available on the | |
1962 | * requested channel anymore. Information about the | |
1963 | * operation is included in union wpa_event_data::remain_on_channel. | |
1964 | */ | |
1965 | EVENT_CANCEL_REMAIN_ON_CHANNEL, | |
1966 | ||
245519e0 JM |
1967 | /** |
1968 | * EVENT_MLME_RX - Report reception of frame for MLME (test use only) | |
1969 | * | |
1970 | * This event is used only by driver_test.c and userspace MLME. | |
1971 | */ | |
a0e0d3bb JM |
1972 | EVENT_MLME_RX, |
1973 | ||
1974 | /** | |
1975 | * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame | |
1976 | * | |
1977 | * This event is used to indicate when a Probe Request frame has been | |
1978 | * received. Information about the received frame is included in | |
504e905c JM |
1979 | * union wpa_event_data::rx_probe_req. The driver is required to report |
1980 | * these events only after successfully completed probe_req_report() | |
1981 | * commands to request the events (i.e., report parameter is non-zero) | |
1982 | * in station mode. In AP mode, Probe Request frames should always be | |
1983 | * reported. | |
a0e0d3bb | 1984 | */ |
a70a5d6d JM |
1985 | EVENT_RX_PROBE_REQ, |
1986 | ||
1987 | /** | |
1988 | * EVENT_NEW_STA - New wired device noticed | |
1989 | * | |
1990 | * This event is used to indicate that a new device has been detected | |
1991 | * in a network that does not use association-like functionality (i.e., | |
1992 | * mainly wired Ethernet). This can be used to start EAPOL | |
1993 | * authenticator when receiving a frame from a device. The address of | |
1994 | * the device is included in union wpa_event_data::new_sta. | |
1995 | */ | |
a8e0505b JM |
1996 | EVENT_NEW_STA, |
1997 | ||
1998 | /** | |
1999 | * EVENT_EAPOL_RX - Report received EAPOL frame | |
2000 | * | |
2001 | * When in AP mode with hostapd, this event is required to be used to | |
2002 | * deliver the receive EAPOL frames from the driver. With | |
2003 | * %wpa_supplicant, this event is used only if the send_eapol() handler | |
2004 | * is used to override the use of l2_packet for EAPOL frame TX. | |
2005 | */ | |
2006 | EVENT_EAPOL_RX | |
9646a8ab | 2007 | }; |
6fc6879b JM |
2008 | |
2009 | ||
2010 | /** | |
2011 | * union wpa_event_data - Additional data for wpa_supplicant_event() calls | |
2012 | */ | |
2013 | union wpa_event_data { | |
2014 | /** | |
2015 | * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events | |
2016 | * | |
2017 | * This structure is optional for EVENT_ASSOC calls and required for | |
2018 | * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the | |
2019 | * driver interface does not need to generate separate EVENT_ASSOCINFO | |
2020 | * calls. | |
2021 | */ | |
2022 | struct assoc_info { | |
2023 | /** | |
2024 | * req_ies - (Re)Association Request IEs | |
2025 | * | |
2026 | * If the driver generates WPA/RSN IE, this event data must be | |
2027 | * returned for WPA handshake to have needed information. If | |
2028 | * wpa_supplicant-generated WPA/RSN IE is used, this | |
2029 | * information event is optional. | |
2030 | * | |
2031 | * This should start with the first IE (fixed fields before IEs | |
2032 | * are not included). | |
2033 | */ | |
1d041bec | 2034 | const u8 *req_ies; |
6fc6879b JM |
2035 | |
2036 | /** | |
2037 | * req_ies_len - Length of req_ies in bytes | |
2038 | */ | |
2039 | size_t req_ies_len; | |
2040 | ||
2041 | /** | |
2042 | * resp_ies - (Re)Association Response IEs | |
2043 | * | |
2044 | * Optional association data from the driver. This data is not | |
2045 | * required WPA, but may be useful for some protocols and as | |
2046 | * such, should be reported if this is available to the driver | |
2047 | * interface. | |
2048 | * | |
2049 | * This should start with the first IE (fixed fields before IEs | |
2050 | * are not included). | |
2051 | */ | |
1d041bec | 2052 | const u8 *resp_ies; |
6fc6879b JM |
2053 | |
2054 | /** | |
2055 | * resp_ies_len - Length of resp_ies in bytes | |
2056 | */ | |
2057 | size_t resp_ies_len; | |
2058 | ||
2059 | /** | |
2060 | * beacon_ies - Beacon or Probe Response IEs | |
2061 | * | |
2062 | * Optional Beacon/ProbeResp data: IEs included in Beacon or | |
2063 | * Probe Response frames from the current AP (i.e., the one | |
2064 | * that the client just associated with). This information is | |
2065 | * used to update WPA/RSN IE for the AP. If this field is not | |
2066 | * set, the results from previous scan will be used. If no | |
2067 | * data for the new AP is found, scan results will be requested | |
2068 | * again (without scan request). At this point, the driver is | |
2069 | * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is | |
2070 | * used). | |
2071 | * | |
2072 | * This should start with the first IE (fixed fields before IEs | |
2073 | * are not included). | |
2074 | */ | |
1d041bec | 2075 | const u8 *beacon_ies; |
6fc6879b JM |
2076 | |
2077 | /** | |
2078 | * beacon_ies_len - Length of beacon_ies */ | |
2079 | size_t beacon_ies_len; | |
4832ecd7 JM |
2080 | |
2081 | /** | |
2082 | * freq - Frequency of the operational channel in MHz | |
2083 | */ | |
2084 | unsigned int freq; | |
1d041bec JM |
2085 | |
2086 | /** | |
2087 | * addr - Station address (for AP mode) | |
2088 | */ | |
2089 | const u8 *addr; | |
6fc6879b JM |
2090 | } assoc_info; |
2091 | ||
1d041bec JM |
2092 | /** |
2093 | * struct disassoc_info - Data for EVENT_DISASSOC events | |
2094 | */ | |
2095 | struct disassoc_info { | |
2096 | /** | |
2097 | * addr - Station address (for AP mode) | |
2098 | */ | |
2099 | const u8 *addr; | |
2100 | } disassoc_info; | |
2101 | ||
2102 | /** | |
2103 | * struct deauth_info - Data for EVENT_DEAUTH events | |
2104 | */ | |
2105 | struct deauth_info { | |
2106 | /** | |
2107 | * addr - Station address (for AP mode) | |
2108 | */ | |
2109 | const u8 *addr; | |
2110 | } deauth_info; | |
2111 | ||
6fc6879b JM |
2112 | /** |
2113 | * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE | |
2114 | */ | |
2115 | struct michael_mic_failure { | |
2116 | int unicast; | |
ad1e68e6 | 2117 | const u8 *src; |
6fc6879b JM |
2118 | } michael_mic_failure; |
2119 | ||
2120 | /** | |
2121 | * struct interface_status - Data for EVENT_INTERFACE_STATUS | |
2122 | */ | |
2123 | struct interface_status { | |
2124 | char ifname[100]; | |
2125 | enum { | |
2126 | EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED | |
2127 | } ievent; | |
2128 | } interface_status; | |
2129 | ||
2130 | /** | |
2131 | * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE | |
2132 | */ | |
2133 | struct pmkid_candidate { | |
2134 | /** BSSID of the PMKID candidate */ | |
2135 | u8 bssid[ETH_ALEN]; | |
2136 | /** Smaller the index, higher the priority */ | |
2137 | int index; | |
2138 | /** Whether RSN IE includes pre-authenticate flag */ | |
2139 | int preauth; | |
2140 | } pmkid_candidate; | |
2141 | ||
2142 | /** | |
2143 | * struct stkstart - Data for EVENT_STKSTART | |
2144 | */ | |
2145 | struct stkstart { | |
2146 | u8 peer[ETH_ALEN]; | |
2147 | } stkstart; | |
2148 | ||
2149 | /** | |
2150 | * struct ft_ies - FT information elements (EVENT_FT_RESPONSE) | |
2151 | * | |
2152 | * During FT (IEEE 802.11r) authentication sequence, the driver is | |
2153 | * expected to use this event to report received FT IEs (MDIE, FTIE, | |
2154 | * RSN IE, TIE, possible resource request) to the supplicant. The FT | |
2155 | * IEs for the next message will be delivered through the | |
2156 | * struct wpa_driver_ops::update_ft_ies() callback. | |
2157 | */ | |
2158 | struct ft_ies { | |
2159 | const u8 *ies; | |
2160 | size_t ies_len; | |
2161 | int ft_action; | |
2162 | u8 target_ap[ETH_ALEN]; | |
babfbf15 JM |
2163 | /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */ |
2164 | const u8 *ric_ies; | |
2165 | /** Length of ric_ies buffer in octets */ | |
2166 | size_t ric_ies_len; | |
6fc6879b | 2167 | } ft_ies; |
11ef8d35 JM |
2168 | |
2169 | /** | |
2170 | * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START | |
2171 | */ | |
2172 | struct ibss_rsn_start { | |
2173 | u8 peer[ETH_ALEN]; | |
2174 | } ibss_rsn_start; | |
c2a04078 JM |
2175 | |
2176 | /** | |
2177 | * struct auth_info - Data for EVENT_AUTH events | |
2178 | */ | |
2179 | struct auth_info { | |
2180 | u8 peer[ETH_ALEN]; | |
2181 | u16 auth_type; | |
2182 | u16 status_code; | |
2183 | const u8 *ies; | |
2184 | size_t ies_len; | |
2185 | } auth; | |
efa46078 JM |
2186 | |
2187 | /** | |
2188 | * struct assoc_reject - Data for EVENT_ASSOC_REJECT events | |
2189 | */ | |
2190 | struct assoc_reject { | |
2191 | /** | |
2192 | * resp_ies - (Re)Association Response IEs | |
2193 | * | |
2194 | * Optional association data from the driver. This data is not | |
2195 | * required WPA, but may be useful for some protocols and as | |
2196 | * such, should be reported if this is available to the driver | |
2197 | * interface. | |
2198 | * | |
2199 | * This should start with the first IE (fixed fields before IEs | |
2200 | * are not included). | |
2201 | */ | |
2202 | u8 *resp_ies; | |
2203 | ||
2204 | /** | |
2205 | * resp_ies_len - Length of resp_ies in bytes | |
2206 | */ | |
2207 | size_t resp_ies_len; | |
2208 | ||
2209 | /** | |
2210 | * status_code - Status Code from (Re)association Response | |
2211 | */ | |
2212 | u16 status_code; | |
2213 | } assoc_reject; | |
da1fb17c JM |
2214 | |
2215 | struct timeout_event { | |
2216 | u8 addr[ETH_ALEN]; | |
2217 | } timeout_event; | |
08fd8c15 JM |
2218 | |
2219 | /** | |
2220 | * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events | |
2221 | */ | |
2222 | struct ft_rrb_rx { | |
2223 | const u8 *src; | |
2224 | const u8 *data; | |
2225 | size_t data_len; | |
2226 | } ft_rrb_rx; | |
f8b1f695 JM |
2227 | |
2228 | /** | |
2229 | * struct tx_status - Data for EVENT_TX_STATUS events | |
2230 | */ | |
2231 | struct tx_status { | |
2232 | u16 type; | |
2233 | u16 stype; | |
2234 | const u8 *dst; | |
2235 | const u8 *data; | |
2236 | size_t data_len; | |
2237 | int ack; | |
2238 | } tx_status; | |
2239 | ||
2240 | /** | |
2241 | * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events | |
2242 | */ | |
2243 | struct rx_from_unknown { | |
0d9fc3d8 | 2244 | const u8 *frame; |
f8b1f695 JM |
2245 | size_t len; |
2246 | } rx_from_unknown; | |
2247 | ||
2248 | /** | |
2249 | * struct rx_mgmt - Data for EVENT_RX_MGMT events | |
2250 | */ | |
2251 | struct rx_mgmt { | |
b57e086c | 2252 | const u8 *frame; |
f8b1f695 | 2253 | size_t frame_len; |
2a8b7416 JM |
2254 | u32 datarate; |
2255 | u32 ssi_signal; | |
f8b1f695 | 2256 | } rx_mgmt; |
8d923a4a | 2257 | |
55777702 JM |
2258 | /** |
2259 | * struct rx_action - Data for EVENT_RX_ACTION events | |
2260 | */ | |
2261 | struct rx_action { | |
e8828999 JM |
2262 | /** |
2263 | * da - Destination address of the received Action frame | |
2264 | */ | |
2265 | const u8 *da; | |
2266 | ||
55777702 JM |
2267 | /** |
2268 | * sa - Source address of the received Action frame | |
2269 | */ | |
2270 | const u8 *sa; | |
2271 | ||
e8828999 JM |
2272 | /** |
2273 | * bssid - Address 3 of the received Action frame | |
2274 | */ | |
2275 | const u8 *bssid; | |
2276 | ||
55777702 JM |
2277 | /** |
2278 | * category - Action frame category | |
2279 | */ | |
2280 | u8 category; | |
2281 | ||
2282 | /** | |
2283 | * data - Action frame body after category field | |
2284 | */ | |
2285 | const u8 *data; | |
2286 | ||
2287 | /** | |
2288 | * len - Length of data in octets | |
2289 | */ | |
2290 | size_t len; | |
2291 | ||
2292 | /** | |
2293 | * freq - Frequency (in MHz) on which the frame was received | |
2294 | */ | |
2295 | int freq; | |
2296 | } rx_action; | |
2297 | ||
2298 | /** | |
2299 | * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events | |
2300 | * | |
2301 | * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events. | |
2302 | */ | |
2303 | struct remain_on_channel { | |
2304 | /** | |
2305 | * freq - Channel frequency in MHz | |
2306 | */ | |
2307 | unsigned int freq; | |
2308 | ||
2309 | /** | |
2310 | * duration - Duration to remain on the channel in milliseconds | |
2311 | */ | |
2312 | unsigned int duration; | |
2313 | } remain_on_channel; | |
2314 | ||
8d923a4a JM |
2315 | /** |
2316 | * struct scan_info - Optional data for EVENT_SCAN_RESULTS events | |
2317 | * @aborted: Whether the scan was aborted | |
2318 | * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned) | |
2319 | * @num_freqs: Number of entries in freqs array | |
2320 | * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard | |
2321 | * SSID) | |
2322 | * @num_ssids: Number of entries in ssids array | |
2323 | */ | |
2324 | struct scan_info { | |
2325 | int aborted; | |
2326 | const int *freqs; | |
2327 | size_t num_freqs; | |
2328 | struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS]; | |
2329 | size_t num_ssids; | |
2330 | } scan_info; | |
245519e0 JM |
2331 | |
2332 | /** | |
2333 | * struct mlme_rx - Data for EVENT_MLME_RX events | |
2334 | */ | |
2335 | struct mlme_rx { | |
2336 | const u8 *buf; | |
2337 | size_t len; | |
2338 | int freq; | |
2339 | int channel; | |
2340 | int ssi; | |
2341 | } mlme_rx; | |
a0e0d3bb JM |
2342 | |
2343 | /** | |
2344 | * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events | |
2345 | */ | |
2346 | struct rx_probe_req { | |
2347 | /** | |
2348 | * sa - Source address of the received Probe Request frame | |
2349 | */ | |
2350 | const u8 *sa; | |
2351 | ||
2352 | /** | |
2353 | * ie - IEs from the Probe Request body | |
2354 | */ | |
2355 | const u8 *ie; | |
2356 | ||
2357 | /** | |
2358 | * ie_len - Length of ie buffer in octets | |
2359 | */ | |
2360 | size_t ie_len; | |
2361 | } rx_probe_req; | |
a70a5d6d JM |
2362 | |
2363 | /** | |
2364 | * struct new_sta - Data for EVENT_NEW_STA events | |
2365 | */ | |
2366 | struct new_sta { | |
2367 | const u8 *addr; | |
2368 | } new_sta; | |
a8e0505b JM |
2369 | |
2370 | /** | |
2371 | * struct eapol_rx - Data for EVENT_EAPOL_RX events | |
2372 | */ | |
2373 | struct eapol_rx { | |
2374 | const u8 *src; | |
2375 | const u8 *data; | |
2376 | size_t data_len; | |
2377 | } eapol_rx; | |
6fc6879b JM |
2378 | }; |
2379 | ||
2380 | /** | |
2381 | * wpa_supplicant_event - Report a driver event for wpa_supplicant | |
2382 | * @ctx: Context pointer (wpa_s); this is the ctx variable registered | |
2383 | * with struct wpa_driver_ops::init() | |
2384 | * @event: event type (defined above) | |
2385 | * @data: possible extra data for the event | |
2386 | * | |
2387 | * Driver wrapper code should call this function whenever an event is received | |
2388 | * from the driver. | |
2389 | */ | |
9646a8ab | 2390 | void wpa_supplicant_event(void *ctx, enum wpa_event_type event, |
6fc6879b JM |
2391 | union wpa_event_data *data); |
2392 | ||
c5121837 | 2393 | |
1d041bec JM |
2394 | /* |
2395 | * The following inline functions are provided for convenience to simplify | |
2396 | * event indication for some of the common events. | |
2397 | */ | |
2398 | ||
2399 | static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie, | |
2400 | size_t ielen) | |
2401 | { | |
2402 | union wpa_event_data event; | |
2403 | os_memset(&event, 0, sizeof(event)); | |
2404 | event.assoc_info.req_ies = ie; | |
2405 | event.assoc_info.req_ies_len = ielen; | |
2406 | event.assoc_info.addr = addr; | |
2407 | wpa_supplicant_event(ctx, EVENT_ASSOC, &event); | |
2408 | } | |
2409 | ||
2410 | static inline void drv_event_disassoc(void *ctx, const u8 *addr) | |
2411 | { | |
2412 | union wpa_event_data event; | |
2413 | os_memset(&event, 0, sizeof(event)); | |
2414 | event.disassoc_info.addr = addr; | |
2415 | wpa_supplicant_event(ctx, EVENT_DISASSOC, &event); | |
2416 | } | |
c5121837 | 2417 | |
baac6490 JM |
2418 | static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data, |
2419 | size_t data_len) | |
2420 | { | |
2421 | union wpa_event_data event; | |
2422 | os_memset(&event, 0, sizeof(event)); | |
2423 | event.eapol_rx.src = src; | |
2424 | event.eapol_rx.data = data; | |
2425 | event.eapol_rx.data_len = data_len; | |
2426 | wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event); | |
2427 | } | |
2428 | ||
6fc6879b | 2429 | #endif /* DRIVER_H */ |