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