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