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