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