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