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