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