P2P: Allow P2P listen being offloaded to the driver/firmware
[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 /** Driver supports P2P Listen offload */
1282 #define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD     0x0000020000000000ULL
1283         u64 flags;
1284
1285 #define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1286         (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1287
1288 #define WPA_DRIVER_SMPS_MODE_STATIC                     0x00000001
1289 #define WPA_DRIVER_SMPS_MODE_DYNAMIC                    0x00000002
1290         unsigned int smps_modes;
1291
1292         unsigned int wmm_ac_supported:1;
1293
1294         unsigned int mac_addr_rand_scan_supported:1;
1295         unsigned int mac_addr_rand_sched_scan_supported:1;
1296
1297         /** Maximum number of supported active probe SSIDs */
1298         int max_scan_ssids;
1299
1300         /** Maximum number of supported active probe SSIDs for sched_scan */
1301         int max_sched_scan_ssids;
1302
1303         /** Maximum number of supported scan plans for scheduled scan */
1304         unsigned int max_sched_scan_plans;
1305
1306         /** Maximum interval in a scan plan. In seconds */
1307         u32 max_sched_scan_plan_interval;
1308
1309         /** Maximum number of iterations in a single scan plan */
1310         u32 max_sched_scan_plan_iterations;
1311
1312         /** Whether sched_scan (offloaded scanning) is supported */
1313         int sched_scan_supported;
1314
1315         /** Maximum number of supported match sets for sched_scan */
1316         int max_match_sets;
1317
1318         /**
1319          * max_remain_on_chan - Maximum remain-on-channel duration in msec
1320          */
1321         unsigned int max_remain_on_chan;
1322
1323         /**
1324          * max_stations - Maximum number of associated stations the driver
1325          * supports in AP mode
1326          */
1327         unsigned int max_stations;
1328
1329         /**
1330          * probe_resp_offloads - Bitmap of supported protocols by the driver
1331          * for Probe Response offloading.
1332          */
1333 /** Driver Probe Response offloading support for WPS ver. 1 */
1334 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS               0x00000001
1335 /** Driver Probe Response offloading support for WPS ver. 2 */
1336 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2              0x00000002
1337 /** Driver Probe Response offloading support for P2P */
1338 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P               0x00000004
1339 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1340 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING      0x00000008
1341         unsigned int probe_resp_offloads;
1342
1343         unsigned int max_acl_mac_addrs;
1344
1345         /**
1346          * Number of supported concurrent channels
1347          */
1348         unsigned int num_multichan_concurrent;
1349
1350         /**
1351          * extended_capa - extended capabilities in driver/device
1352          *
1353          * Must be allocated and freed by driver and the pointers must be
1354          * valid for the lifetime of the driver, i.e., freed in deinit()
1355          */
1356         const u8 *extended_capa, *extended_capa_mask;
1357         unsigned int extended_capa_len;
1358
1359         struct wowlan_triggers wowlan_triggers;
1360
1361 /** Driver adds the DS Params Set IE in Probe Request frames */
1362 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES      0x00000001
1363 /** Driver adds the WFA TPC IE in Probe Request frames */
1364 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES           0x00000002
1365 /** Driver handles quiet period requests */
1366 #define WPA_DRIVER_FLAGS_QUIET                          0x00000004
1367 /**
1368  * Driver is capable of inserting the current TX power value into the body of
1369  * transmitted frames.
1370  * Background: Some Action frames include a TPC Report IE. This IE contains a
1371  * TX power field, which has to be updated by lower layers. One such Action
1372  * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1373  * of spectrum management). Note that this insertion takes place at a fixed
1374  * offset, namely the 6th byte in the Action frame body.
1375  */
1376 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION             0x00000008
1377 /**
1378  * Driver supports RRM. With this support, the driver will accept to use RRM in
1379  * (Re)Association Request frames, without supporting quiet period.
1380  */
1381 #define WPA_DRIVER_FLAGS_SUPPORT_RRM                    0x00000010
1382
1383         u32 rrm_flags;
1384
1385         /* Driver concurrency capabilities */
1386         unsigned int conc_capab;
1387         /* Maximum number of concurrent channels on 2.4 GHz */
1388         unsigned int max_conc_chan_2_4;
1389         /* Maximum number of concurrent channels on 5 GHz */
1390         unsigned int max_conc_chan_5_0;
1391
1392         /* Maximum number of supported CSA counters */
1393         u16 max_csa_counters;
1394 };
1395
1396
1397 struct hostapd_data;
1398
1399 struct hostap_sta_driver_data {
1400         unsigned long rx_packets, tx_packets;
1401         unsigned long long rx_bytes, tx_bytes;
1402         int bytes_64bit; /* whether 64-bit byte counters are supported */
1403         unsigned long current_tx_rate;
1404         unsigned long inactive_msec;
1405         unsigned long flags;
1406         unsigned long num_ps_buf_frames;
1407         unsigned long tx_retry_failed;
1408         unsigned long tx_retry_count;
1409         int last_rssi;
1410         int last_ack_rssi;
1411 };
1412
1413 struct hostapd_sta_add_params {
1414         const u8 *addr;
1415         u16 aid;
1416         u16 capability;
1417         const u8 *supp_rates;
1418         size_t supp_rates_len;
1419         u16 listen_interval;
1420         const struct ieee80211_ht_capabilities *ht_capabilities;
1421         const struct ieee80211_vht_capabilities *vht_capabilities;
1422         int vht_opmode_enabled;
1423         u8 vht_opmode;
1424         u32 flags; /* bitmask of WPA_STA_* flags */
1425         u32 flags_mask; /* unset bits in flags */
1426 #ifdef CONFIG_MESH
1427         enum mesh_plink_state plink_state;
1428 #endif /* CONFIG_MESH */
1429         int set; /* Set STA parameters instead of add */
1430         u8 qosinfo;
1431         const u8 *ext_capab;
1432         size_t ext_capab_len;
1433         const u8 *supp_channels;
1434         size_t supp_channels_len;
1435         const u8 *supp_oper_classes;
1436         size_t supp_oper_classes_len;
1437         int support_p2p_ps;
1438 };
1439
1440 struct mac_address {
1441         u8 addr[ETH_ALEN];
1442 };
1443
1444 struct hostapd_acl_params {
1445         u8 acl_policy;
1446         unsigned int num_mac_acl;
1447         struct mac_address mac_acl[0];
1448 };
1449
1450 enum wpa_driver_if_type {
1451         /**
1452          * WPA_IF_STATION - Station mode interface
1453          */
1454         WPA_IF_STATION,
1455
1456         /**
1457          * WPA_IF_AP_VLAN - AP mode VLAN interface
1458          *
1459          * This interface shares its address and Beacon frame with the main
1460          * BSS.
1461          */
1462         WPA_IF_AP_VLAN,
1463
1464         /**
1465          * WPA_IF_AP_BSS - AP mode BSS interface
1466          *
1467          * This interface has its own address and Beacon frame.
1468          */
1469         WPA_IF_AP_BSS,
1470
1471         /**
1472          * WPA_IF_P2P_GO - P2P Group Owner
1473          */
1474         WPA_IF_P2P_GO,
1475
1476         /**
1477          * WPA_IF_P2P_CLIENT - P2P Client
1478          */
1479         WPA_IF_P2P_CLIENT,
1480
1481         /**
1482          * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1483          * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1484          */
1485         WPA_IF_P2P_GROUP,
1486
1487         /**
1488          * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1489          * abstracted P2P Device function in the driver
1490          */
1491         WPA_IF_P2P_DEVICE,
1492
1493         /*
1494          * WPA_IF_MESH - Mesh interface
1495          */
1496         WPA_IF_MESH,
1497
1498         /*
1499          * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1500          */
1501         WPA_IF_TDLS,
1502
1503         /*
1504          * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1505          */
1506         WPA_IF_IBSS,
1507 };
1508
1509 struct wpa_init_params {
1510         void *global_priv;
1511         const u8 *bssid;
1512         const char *ifname;
1513         const char *driver_params;
1514         int use_pae_group_addr;
1515         char **bridge;
1516         size_t num_bridge;
1517
1518         u8 *own_addr; /* buffer for writing own MAC address */
1519 };
1520
1521
1522 struct wpa_bss_params {
1523         /** Interface name (for multi-SSID/VLAN support) */
1524         const char *ifname;
1525         /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1526         int enabled;
1527
1528         int wpa;
1529         int ieee802_1x;
1530         int wpa_group;
1531         int wpa_pairwise;
1532         int wpa_key_mgmt;
1533         int rsn_preauth;
1534         enum mfp_options ieee80211w;
1535 };
1536
1537 #define WPA_STA_AUTHORIZED BIT(0)
1538 #define WPA_STA_WMM BIT(1)
1539 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1540 #define WPA_STA_MFP BIT(3)
1541 #define WPA_STA_TDLS_PEER BIT(4)
1542 #define WPA_STA_AUTHENTICATED BIT(5)
1543 #define WPA_STA_ASSOCIATED BIT(6)
1544
1545 enum tdls_oper {
1546         TDLS_DISCOVERY_REQ,
1547         TDLS_SETUP,
1548         TDLS_TEARDOWN,
1549         TDLS_ENABLE_LINK,
1550         TDLS_DISABLE_LINK,
1551         TDLS_ENABLE,
1552         TDLS_DISABLE
1553 };
1554
1555 enum wnm_oper {
1556         WNM_SLEEP_ENTER_CONFIRM,
1557         WNM_SLEEP_ENTER_FAIL,
1558         WNM_SLEEP_EXIT_CONFIRM,
1559         WNM_SLEEP_EXIT_FAIL,
1560         WNM_SLEEP_TFS_REQ_IE_ADD,   /* STA requests driver to add TFS req IE */
1561         WNM_SLEEP_TFS_REQ_IE_NONE,  /* STA requests empty TFS req IE */
1562         WNM_SLEEP_TFS_REQ_IE_SET,   /* AP requests driver to set TFS req IE for
1563                                      * a STA */
1564         WNM_SLEEP_TFS_RESP_IE_ADD,  /* AP requests driver to add TFS resp IE
1565                                      * for a STA */
1566         WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1567         WNM_SLEEP_TFS_RESP_IE_SET,  /* AP requests driver to set TFS resp IE
1568                                      * for a STA */
1569         WNM_SLEEP_TFS_IE_DEL        /* AP delete the TFS IE */
1570 };
1571
1572 /* enum chan_width - Channel width definitions */
1573 enum chan_width {
1574         CHAN_WIDTH_20_NOHT,
1575         CHAN_WIDTH_20,
1576         CHAN_WIDTH_40,
1577         CHAN_WIDTH_80,
1578         CHAN_WIDTH_80P80,
1579         CHAN_WIDTH_160,
1580         CHAN_WIDTH_UNKNOWN
1581 };
1582
1583 /**
1584  * struct wpa_signal_info - Information about channel signal quality
1585  */
1586 struct wpa_signal_info {
1587         u32 frequency;
1588         int above_threshold;
1589         int current_signal;
1590         int avg_signal;
1591         int avg_beacon_signal;
1592         int current_noise;
1593         int current_txrate;
1594         enum chan_width chanwidth;
1595         int center_frq1;
1596         int center_frq2;
1597 };
1598
1599 /**
1600  * struct beacon_data - Beacon data
1601  * @head: Head portion of Beacon frame (before TIM IE)
1602  * @tail: Tail portion of Beacon frame (after TIM IE)
1603  * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1604  * @proberesp_ies: Extra information element(s) to add into Probe Response
1605  *      frames or %NULL
1606  * @assocresp_ies: Extra information element(s) to add into (Re)Association
1607  *      Response frames or %NULL
1608  * @probe_resp: Probe Response frame template
1609  * @head_len: Length of @head
1610  * @tail_len: Length of @tail
1611  * @beacon_ies_len: Length of beacon_ies in octets
1612  * @proberesp_ies_len: Length of proberesp_ies in octets
1613  * @proberesp_ies_len: Length of proberesp_ies in octets
1614  * @probe_resp_len: Length of probe response template (@probe_resp)
1615  */
1616 struct beacon_data {
1617         u8 *head, *tail;
1618         u8 *beacon_ies;
1619         u8 *proberesp_ies;
1620         u8 *assocresp_ies;
1621         u8 *probe_resp;
1622
1623         size_t head_len, tail_len;
1624         size_t beacon_ies_len;
1625         size_t proberesp_ies_len;
1626         size_t assocresp_ies_len;
1627         size_t probe_resp_len;
1628 };
1629
1630 /**
1631  * struct csa_settings - Settings for channel switch command
1632  * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1633  * @block_tx: 1 - block transmission for CSA period
1634  * @freq_params: Next channel frequency parameter
1635  * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1636  * @beacon_after: Next beacon/probe resp/asooc resp info
1637  * @counter_offset_beacon: Offset to the count field in beacon's tail
1638  * @counter_offset_presp: Offset to the count field in probe resp.
1639  */
1640 struct csa_settings {
1641         u8 cs_count;
1642         u8 block_tx;
1643
1644         struct hostapd_freq_params freq_params;
1645         struct beacon_data beacon_csa;
1646         struct beacon_data beacon_after;
1647
1648         u16 counter_offset_beacon[2];
1649         u16 counter_offset_presp[2];
1650 };
1651
1652 /* TDLS peer capabilities for send_tdls_mgmt() */
1653 enum tdls_peer_capability {
1654         TDLS_PEER_HT = BIT(0),
1655         TDLS_PEER_VHT = BIT(1),
1656         TDLS_PEER_WMM = BIT(2),
1657 };
1658
1659 /* valid info in the wmm_params struct */
1660 enum wmm_params_valid_info {
1661         WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1662 };
1663
1664 /**
1665  * struct wmm_params - WMM parameterss configured for this association
1666  * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1667  *      of the struct contain valid information.
1668  * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1669  *      %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1670  */
1671 struct wmm_params {
1672         u8 info_bitmap;
1673         u8 uapsd_queues;
1674 };
1675
1676 #ifdef CONFIG_MACSEC
1677 struct macsec_init_params {
1678         Boolean always_include_sci;
1679         Boolean use_es;
1680         Boolean use_scb;
1681 };
1682 #endif /* CONFIG_MACSEC */
1683
1684 enum drv_br_port_attr {
1685         DRV_BR_PORT_ATTR_PROXYARP,
1686         DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1687 };
1688
1689 enum drv_br_net_param {
1690         DRV_BR_NET_PARAM_GARP_ACCEPT,
1691         DRV_BR_MULTICAST_SNOOPING,
1692 };
1693
1694 struct drv_acs_params {
1695         /* Selected mode (HOSTAPD_MODE_*) */
1696         enum hostapd_hw_mode hw_mode;
1697
1698         /* Indicates whether HT is enabled */
1699         int ht_enabled;
1700
1701         /* Indicates whether HT40 is enabled */
1702         int ht40_enabled;
1703
1704         /* Indicates whether VHT is enabled */
1705         int vht_enabled;
1706
1707         /* Configured ACS channel width */
1708         u16 ch_width;
1709
1710         /* ACS channel list info */
1711         unsigned int ch_list_len;
1712         const u8 *ch_list;
1713         const int *freq_list;
1714 };
1715
1716
1717 /**
1718  * struct wpa_driver_ops - Driver interface API definition
1719  *
1720  * This structure defines the API that each driver interface needs to implement
1721  * for core wpa_supplicant code. All driver specific functionality is captured
1722  * in this wrapper.
1723  */
1724 struct wpa_driver_ops {
1725         /** Name of the driver interface */
1726         const char *name;
1727         /** One line description of the driver interface */
1728         const char *desc;
1729
1730         /**
1731          * get_bssid - Get the current BSSID
1732          * @priv: private driver interface data
1733          * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1734          *
1735          * Returns: 0 on success, -1 on failure
1736          *
1737          * Query kernel driver for the current BSSID and copy it to bssid.
1738          * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1739          * associated.
1740          */
1741         int (*get_bssid)(void *priv, u8 *bssid);
1742
1743         /**
1744          * get_ssid - Get the current SSID
1745          * @priv: private driver interface data
1746          * @ssid: buffer for SSID (at least 32 bytes)
1747          *
1748          * Returns: Length of the SSID on success, -1 on failure
1749          *
1750          * Query kernel driver for the current SSID and copy it to ssid.
1751          * Returning zero is recommended if the STA is not associated.
1752          *
1753          * Note: SSID is an array of octets, i.e., it is not nul terminated and
1754          * can, at least in theory, contain control characters (including nul)
1755          * and as such, should be processed as binary data, not a printable
1756          * string.
1757          */
1758         int (*get_ssid)(void *priv, u8 *ssid);
1759
1760         /**
1761          * set_key - Configure encryption key
1762          * @ifname: Interface name (for multi-SSID/VLAN support)
1763          * @priv: private driver interface data
1764          * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1765          *      %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1766          *      %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1767          *      %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1768          *      %WPA_ALG_BIP_CMAC_256);
1769          *      %WPA_ALG_NONE clears the key.
1770          * @addr: Address of the peer STA (BSSID of the current AP when setting
1771          *      pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1772          *      broadcast keys, %NULL for default keys that are used both for
1773          *      broadcast and unicast; when clearing keys, %NULL is used to
1774          *      indicate that both the broadcast-only and default key of the
1775          *      specified key index is to be cleared
1776          * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1777          *      IGTK
1778          * @set_tx: configure this key as the default Tx key (only used when
1779          *      driver does not support separate unicast/individual key
1780          * @seq: sequence number/packet number, seq_len octets, the next
1781          *      packet number to be used for in replay protection; configured
1782          *      for Rx keys (in most cases, this is only used with broadcast
1783          *      keys and set to zero for unicast keys); %NULL if not set
1784          * @seq_len: length of the seq, depends on the algorithm:
1785          *      TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1786          * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1787          *      8-byte Rx Mic Key
1788          * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1789          *      TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1790          *
1791          * Returns: 0 on success, -1 on failure
1792          *
1793          * Configure the given key for the kernel driver. If the driver
1794          * supports separate individual keys (4 default keys + 1 individual),
1795          * addr can be used to determine whether the key is default or
1796          * individual. If only 4 keys are supported, the default key with key
1797          * index 0 is used as the individual key. STA must be configured to use
1798          * it as the default Tx key (set_tx is set) and accept Rx for all the
1799          * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1800          * broadcast keys, so key index 0 is available for this kind of
1801          * configuration.
1802          *
1803          * Please note that TKIP keys include separate TX and RX MIC keys and
1804          * some drivers may expect them in different order than wpa_supplicant
1805          * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1806          * will trigger Michael MIC errors. This can be fixed by changing the
1807          * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1808          * in driver_*.c set_key() implementation, see driver_ndis.c for an
1809          * example on how this can be done.
1810          */
1811         int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1812                        const u8 *addr, int key_idx, int set_tx,
1813                        const u8 *seq, size_t seq_len,
1814                        const u8 *key, size_t key_len);
1815
1816         /**
1817          * init - Initialize driver interface
1818          * @ctx: context to be used when calling wpa_supplicant functions,
1819          * e.g., wpa_supplicant_event()
1820          * @ifname: interface name, e.g., wlan0
1821          *
1822          * Returns: Pointer to private data, %NULL on failure
1823          *
1824          * Initialize driver interface, including event processing for kernel
1825          * driver events (e.g., associated, scan results, Michael MIC failure).
1826          * This function can allocate a private configuration data area for
1827          * @ctx, file descriptor, interface name, etc. information that may be
1828          * needed in future driver operations. If this is not used, non-NULL
1829          * value will need to be returned because %NULL is used to indicate
1830          * failure. The returned value will be used as 'void *priv' data for
1831          * all other driver_ops functions.
1832          *
1833          * The main event loop (eloop.c) of wpa_supplicant can be used to
1834          * register callback for read sockets (eloop_register_read_sock()).
1835          *
1836          * See below for more information about events and
1837          * wpa_supplicant_event() function.
1838          */
1839         void * (*init)(void *ctx, const char *ifname);
1840
1841         /**
1842          * deinit - Deinitialize driver interface
1843          * @priv: private driver interface data from init()
1844          *
1845          * Shut down driver interface and processing of driver events. Free
1846          * private data buffer if one was allocated in init() handler.
1847          */
1848         void (*deinit)(void *priv);
1849
1850         /**
1851          * set_param - Set driver configuration parameters
1852          * @priv: private driver interface data from init()
1853          * @param: driver specific configuration parameters
1854          *
1855          * Returns: 0 on success, -1 on failure
1856          *
1857          * Optional handler for notifying driver interface about configuration
1858          * parameters (driver_param).
1859          */
1860         int (*set_param)(void *priv, const char *param);
1861
1862         /**
1863          * set_countermeasures - Enable/disable TKIP countermeasures
1864          * @priv: private driver interface data
1865          * @enabled: 1 = countermeasures enabled, 0 = disabled
1866          *
1867          * Returns: 0 on success, -1 on failure
1868          *
1869          * Configure TKIP countermeasures. When these are enabled, the driver
1870          * should drop all received and queued frames that are using TKIP.
1871          */
1872         int (*set_countermeasures)(void *priv, int enabled);
1873
1874         /**
1875          * deauthenticate - Request driver to deauthenticate
1876          * @priv: private driver interface data
1877          * @addr: peer address (BSSID of the AP)
1878          * @reason_code: 16-bit reason code to be sent in the deauthentication
1879          *      frame
1880          *
1881          * Returns: 0 on success, -1 on failure
1882          */
1883         int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1884
1885         /**
1886          * associate - Request driver to associate
1887          * @priv: private driver interface data
1888          * @params: association parameters
1889          *
1890          * Returns: 0 on success, -1 on failure
1891          */
1892         int (*associate)(void *priv,
1893                          struct wpa_driver_associate_params *params);
1894
1895         /**
1896          * add_pmkid - Add PMKSA cache entry to the driver
1897          * @priv: private driver interface data
1898          * @bssid: BSSID for the PMKSA cache entry
1899          * @pmkid: PMKID for the PMKSA cache entry
1900          *
1901          * Returns: 0 on success, -1 on failure
1902          *
1903          * This function is called when a new PMK is received, as a result of
1904          * either normal authentication or RSN pre-authentication.
1905          *
1906          * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1907          * associate(), add_pmkid() can be used to add new PMKSA cache entries
1908          * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1909          * driver_ops function does not need to be implemented. Likewise, if
1910          * the driver does not support WPA, this function is not needed.
1911          */
1912         int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1913
1914         /**
1915          * remove_pmkid - Remove PMKSA cache entry to the driver
1916          * @priv: private driver interface data
1917          * @bssid: BSSID for the PMKSA cache entry
1918          * @pmkid: PMKID for the PMKSA cache entry
1919          *
1920          * Returns: 0 on success, -1 on failure
1921          *
1922          * This function is called when the supplicant drops a PMKSA cache
1923          * entry for any reason.
1924          *
1925          * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1926          * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1927          * between the driver and wpa_supplicant. If the driver uses wpa_ie
1928          * from wpa_supplicant, this driver_ops function does not need to be
1929          * implemented. Likewise, if the driver does not support WPA, this
1930          * function is not needed.
1931          */
1932         int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1933
1934         /**
1935          * flush_pmkid - Flush PMKSA cache
1936          * @priv: private driver interface data
1937          *
1938          * Returns: 0 on success, -1 on failure
1939          *
1940          * This function is called when the supplicant drops all PMKSA cache
1941          * entries for any reason.
1942          *
1943          * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1944          * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1945          * between the driver and wpa_supplicant. If the driver uses wpa_ie
1946          * from wpa_supplicant, this driver_ops function does not need to be
1947          * implemented. Likewise, if the driver does not support WPA, this
1948          * function is not needed.
1949          */
1950         int (*flush_pmkid)(void *priv);
1951
1952         /**
1953          * get_capa - Get driver capabilities
1954          * @priv: private driver interface data
1955          *
1956          * Returns: 0 on success, -1 on failure
1957          *
1958          * Get driver/firmware/hardware capabilities.
1959          */
1960         int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1961
1962         /**
1963          * poll - Poll driver for association information
1964          * @priv: private driver interface data
1965          *
1966          * This is an option callback that can be used when the driver does not
1967          * provide event mechanism for association events. This is called when
1968          * receiving WPA EAPOL-Key messages that require association
1969          * information. The driver interface is supposed to generate associnfo
1970          * event before returning from this callback function. In addition, the
1971          * driver interface should generate an association event after having
1972          * sent out associnfo.
1973          */
1974         void (*poll)(void *priv);
1975
1976         /**
1977          * get_ifindex - Get interface index
1978          * @priv: private driver interface data
1979          *
1980          * Returns: Interface index
1981          */
1982         unsigned int (*get_ifindex)(void *priv);
1983
1984         /**
1985          * get_ifname - Get interface name
1986          * @priv: private driver interface data
1987          *
1988          * Returns: Pointer to the interface name. This can differ from the
1989          * interface name used in init() call. Init() is called first.
1990          *
1991          * This optional function can be used to allow the driver interface to
1992          * replace the interface name with something else, e.g., based on an
1993          * interface mapping from a more descriptive name.
1994          */
1995         const char * (*get_ifname)(void *priv);
1996
1997         /**
1998          * get_mac_addr - Get own MAC address
1999          * @priv: private driver interface data
2000          *
2001          * Returns: Pointer to own MAC address or %NULL on failure
2002          *
2003          * This optional function can be used to get the own MAC address of the
2004          * device from the driver interface code. This is only needed if the
2005          * l2_packet implementation for the OS does not provide easy access to
2006          * a MAC address. */
2007         const u8 * (*get_mac_addr)(void *priv);
2008
2009         /**
2010          * set_operstate - Sets device operating state to DORMANT or UP
2011          * @priv: private driver interface data
2012          * @state: 0 = dormant, 1 = up
2013          * Returns: 0 on success, -1 on failure
2014          *
2015          * This is an optional function that can be used on operating systems
2016          * that support a concept of controlling network device state from user
2017          * space applications. This function, if set, gets called with
2018          * state = 1 when authentication has been completed and with state = 0
2019          * when connection is lost.
2020          */
2021         int (*set_operstate)(void *priv, int state);
2022
2023         /**
2024          * mlme_setprotection - MLME-SETPROTECTION.request primitive
2025          * @priv: Private driver interface data
2026          * @addr: Address of the station for which to set protection (may be
2027          * %NULL for group keys)
2028          * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2029          * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2030          * Returns: 0 on success, -1 on failure
2031          *
2032          * This is an optional function that can be used to set the driver to
2033          * require protection for Tx and/or Rx frames. This uses the layer
2034          * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2035          * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2036          * set protection operation; instead, they set protection implicitly
2037          * based on configured keys.
2038          */
2039         int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2040                                   int key_type);
2041
2042         /**
2043          * get_hw_feature_data - Get hardware support data (channels and rates)
2044          * @priv: Private driver interface data
2045          * @num_modes: Variable for returning the number of returned modes
2046          * flags: Variable for returning hardware feature flags
2047          * Returns: Pointer to allocated hardware data on success or %NULL on
2048          * failure. Caller is responsible for freeing this.
2049          */
2050         struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2051                                                          u16 *num_modes,
2052                                                          u16 *flags);
2053
2054         /**
2055          * send_mlme - Send management frame from MLME
2056          * @priv: Private driver interface data
2057          * @data: IEEE 802.11 management frame with IEEE 802.11 header
2058          * @data_len: Size of the management frame
2059          * @noack: Do not wait for this frame to be acked (disable retries)
2060          * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2061          * driver decide
2062          * @csa_offs: Array of CSA offsets or %NULL
2063          * @csa_offs_len: Number of elements in csa_offs
2064          * Returns: 0 on success, -1 on failure
2065          */
2066         int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
2067                          int noack, unsigned int freq, const u16 *csa_offs,
2068                          size_t csa_offs_len);
2069
2070         /**
2071          * update_ft_ies - Update FT (IEEE 802.11r) IEs
2072          * @priv: Private driver interface data
2073          * @md: Mobility domain (2 octets) (also included inside ies)
2074          * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2075          * @ies_len: Length of FT IEs in bytes
2076          * Returns: 0 on success, -1 on failure
2077          *
2078          * The supplicant uses this callback to let the driver know that keying
2079          * material for FT is available and that the driver can use the
2080          * provided IEs in the next message in FT authentication sequence.
2081          *
2082          * This function is only needed for driver that support IEEE 802.11r
2083          * (Fast BSS Transition).
2084          */
2085         int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2086                              size_t ies_len);
2087
2088         /**
2089          * get_scan_results2 - Fetch the latest scan results
2090          * @priv: private driver interface data
2091          *
2092          * Returns: Allocated buffer of scan results (caller is responsible for
2093          * freeing the data structure) on success, NULL on failure
2094          */
2095          struct wpa_scan_results * (*get_scan_results2)(void *priv);
2096
2097         /**
2098          * set_country - Set country
2099          * @priv: Private driver interface data
2100          * @alpha2: country to which to switch to
2101          * Returns: 0 on success, -1 on failure
2102          *
2103          * This function is for drivers which support some form
2104          * of setting a regulatory domain.
2105          */
2106         int (*set_country)(void *priv, const char *alpha2);
2107
2108         /**
2109          * get_country - Get country
2110          * @priv: Private driver interface data
2111          * @alpha2: Buffer for returning country code (at least 3 octets)
2112          * Returns: 0 on success, -1 on failure
2113          */
2114         int (*get_country)(void *priv, char *alpha2);
2115
2116         /**
2117          * global_init - Global driver initialization
2118          * @ctx: wpa_global pointer
2119          * Returns: Pointer to private data (global), %NULL on failure
2120          *
2121          * This optional function is called to initialize the driver wrapper
2122          * for global data, i.e., data that applies to all interfaces. If this
2123          * function is implemented, global_deinit() will also need to be
2124          * implemented to free the private data. The driver will also likely
2125          * use init2() function instead of init() to get the pointer to global
2126          * data available to per-interface initializer.
2127          */
2128         void * (*global_init)(void *ctx);
2129
2130         /**
2131          * global_deinit - Global driver deinitialization
2132          * @priv: private driver global data from global_init()
2133          *
2134          * Terminate any global driver related functionality and free the
2135          * global data structure.
2136          */
2137         void (*global_deinit)(void *priv);
2138
2139         /**
2140          * init2 - Initialize driver interface (with global data)
2141          * @ctx: context to be used when calling wpa_supplicant functions,
2142          * e.g., wpa_supplicant_event()
2143          * @ifname: interface name, e.g., wlan0
2144          * @global_priv: private driver global data from global_init()
2145          * Returns: Pointer to private data, %NULL on failure
2146          *
2147          * This function can be used instead of init() if the driver wrapper
2148          * uses global data.
2149          */
2150         void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2151
2152         /**
2153          * get_interfaces - Get information about available interfaces
2154          * @global_priv: private driver global data from global_init()
2155          * Returns: Allocated buffer of interface information (caller is
2156          * responsible for freeing the data structure) on success, NULL on
2157          * failure
2158          */
2159         struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2160
2161         /**
2162          * scan2 - Request the driver to initiate scan
2163          * @priv: private driver interface data
2164          * @params: Scan parameters
2165          *
2166          * Returns: 0 on success, -1 on failure
2167          *
2168          * Once the scan results are ready, the driver should report scan
2169          * results event for wpa_supplicant which will eventually request the
2170          * results with wpa_driver_get_scan_results2().
2171          */
2172         int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2173
2174         /**
2175          * authenticate - Request driver to authenticate
2176          * @priv: private driver interface data
2177          * @params: authentication parameters
2178          * Returns: 0 on success, -1 on failure
2179          *
2180          * This is an optional function that can be used with drivers that
2181          * support separate authentication and association steps, i.e., when
2182          * wpa_supplicant can act as the SME. If not implemented, associate()
2183          * function is expected to take care of IEEE 802.11 authentication,
2184          * too.
2185          */
2186         int (*authenticate)(void *priv,
2187                             struct wpa_driver_auth_params *params);
2188
2189         /**
2190          * set_ap - Set Beacon and Probe Response information for AP mode
2191          * @priv: Private driver interface data
2192          * @params: Parameters to use in AP mode
2193          *
2194          * This function is used to configure Beacon template and/or extra IEs
2195          * to add for Beacon and Probe Response frames for the driver in
2196          * AP mode. The driver is responsible for building the full Beacon
2197          * frame by concatenating the head part with TIM IE generated by the
2198          * driver/firmware and finishing with the tail part. Depending on the
2199          * driver architectue, this can be done either by using the full
2200          * template or the set of additional IEs (e.g., WPS and P2P IE).
2201          * Similarly, Probe Response processing depends on the driver design.
2202          * If the driver (or firmware) takes care of replying to Probe Request
2203          * frames, the extra IEs provided here needs to be added to the Probe
2204          * Response frames.
2205          *
2206          * Returns: 0 on success, -1 on failure
2207          */
2208         int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
2209
2210         /**
2211          * set_acl - Set ACL in AP mode
2212          * @priv: Private driver interface data
2213          * @params: Parameters to configure ACL
2214          * Returns: 0 on success, -1 on failure
2215          *
2216          * This is used only for the drivers which support MAC address ACL.
2217          */
2218         int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2219
2220         /**
2221          * hapd_init - Initialize driver interface (hostapd only)
2222          * @hapd: Pointer to hostapd context
2223          * @params: Configuration for the driver wrapper
2224          * Returns: Pointer to private data, %NULL on failure
2225          *
2226          * This function is used instead of init() or init2() when the driver
2227          * wrapper is used with hostapd.
2228          */
2229         void * (*hapd_init)(struct hostapd_data *hapd,
2230                             struct wpa_init_params *params);
2231
2232         /**
2233          * hapd_deinit - Deinitialize driver interface (hostapd only)
2234          * @priv: Private driver interface data from hapd_init()
2235          */
2236         void (*hapd_deinit)(void *priv);
2237
2238         /**
2239          * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2240          * @priv: Private driver interface data
2241          * @params: BSS parameters
2242          * Returns: 0 on success, -1 on failure
2243          *
2244          * This is an optional function to configure the kernel driver to
2245          * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2246          * can be left undefined (set to %NULL) if IEEE 802.1X support is
2247          * always enabled and the driver uses set_ap() to set WPA/RSN IE
2248          * for Beacon frames.
2249          *
2250          * DEPRECATED - use set_ap() instead
2251          */
2252         int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2253
2254         /**
2255          * set_privacy - Enable/disable privacy (AP only)
2256          * @priv: Private driver interface data
2257          * @enabled: 1 = privacy enabled, 0 = disabled
2258          * Returns: 0 on success, -1 on failure
2259          *
2260          * This is an optional function to configure privacy field in the
2261          * kernel driver for Beacon frames. This can be left undefined (set to
2262          * %NULL) if the driver uses the Beacon template from set_ap().
2263          *
2264          * DEPRECATED - use set_ap() instead
2265          */
2266         int (*set_privacy)(void *priv, int enabled);
2267
2268         /**
2269          * get_seqnum - Fetch the current TSC/packet number (AP only)
2270          * @ifname: The interface name (main or virtual)
2271          * @priv: Private driver interface data
2272          * @addr: MAC address of the station or %NULL for group keys
2273          * @idx: Key index
2274          * @seq: Buffer for returning the latest used TSC/packet number
2275          * Returns: 0 on success, -1 on failure
2276          *
2277          * This function is used to fetch the last used TSC/packet number for
2278          * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2279          * keys, so there is no strict requirement on implementing support for
2280          * unicast keys (i.e., addr != %NULL).
2281          */
2282         int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2283                           int idx, u8 *seq);
2284
2285         /**
2286          * flush - Flush all association stations (AP only)
2287          * @priv: Private driver interface data
2288          * Returns: 0 on success, -1 on failure
2289          *
2290          * This function requests the driver to disassociate all associated
2291          * stations. This function does not need to be implemented if the
2292          * driver does not process association frames internally.
2293          */
2294         int (*flush)(void *priv);
2295
2296         /**
2297          * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2298          * @priv: Private driver interface data
2299          * @elem: Information elements
2300          * @elem_len: Length of the elem buffer in octets
2301          * Returns: 0 on success, -1 on failure
2302          *
2303          * This is an optional function to add information elements in the
2304          * kernel driver for Beacon and Probe Response frames. This can be left
2305          * undefined (set to %NULL) if the driver uses the Beacon template from
2306          * set_ap().
2307          *
2308          * DEPRECATED - use set_ap() instead
2309          */
2310         int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2311
2312         /**
2313          * read_sta_data - Fetch station data
2314          * @priv: Private driver interface data
2315          * @data: Buffer for returning station information
2316          * @addr: MAC address of the station
2317          * Returns: 0 on success, -1 on failure
2318          */
2319         int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2320                              const u8 *addr);
2321
2322         /**
2323          * hapd_send_eapol - Send an EAPOL packet (AP only)
2324          * @priv: private driver interface data
2325          * @addr: Destination MAC address
2326          * @data: EAPOL packet starting with IEEE 802.1X header
2327          * @data_len: Length of the EAPOL packet in octets
2328          * @encrypt: Whether the frame should be encrypted
2329          * @own_addr: Source MAC address
2330          * @flags: WPA_STA_* flags for the destination station
2331          *
2332          * Returns: 0 on success, -1 on failure
2333          */
2334         int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2335                                size_t data_len, int encrypt,
2336                                const u8 *own_addr, u32 flags);
2337
2338         /**
2339          * sta_deauth - Deauthenticate a station (AP only)
2340          * @priv: Private driver interface data
2341          * @own_addr: Source address and BSSID for the Deauthentication frame
2342          * @addr: MAC address of the station to deauthenticate
2343          * @reason: Reason code for the Deauthentiation frame
2344          * Returns: 0 on success, -1 on failure
2345          *
2346          * This function requests a specific station to be deauthenticated and
2347          * a Deauthentication frame to be sent to it.
2348          */
2349         int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2350                           int reason);
2351
2352         /**
2353          * sta_disassoc - Disassociate a station (AP only)
2354          * @priv: Private driver interface data
2355          * @own_addr: Source address and BSSID for the Disassociation frame
2356          * @addr: MAC address of the station to disassociate
2357          * @reason: Reason code for the Disassociation frame
2358          * Returns: 0 on success, -1 on failure
2359          *
2360          * This function requests a specific station to be disassociated and
2361          * a Disassociation frame to be sent to it.
2362          */
2363         int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2364                             int reason);
2365
2366         /**
2367          * sta_remove - Remove a station entry (AP only)
2368          * @priv: Private driver interface data
2369          * @addr: MAC address of the station to be removed
2370          * Returns: 0 on success, -1 on failure
2371          */
2372         int (*sta_remove)(void *priv, const u8 *addr);
2373
2374         /**
2375          * hapd_get_ssid - Get the current SSID (AP only)
2376          * @priv: Private driver interface data
2377          * @buf: Buffer for returning the SSID
2378          * @len: Maximum length of the buffer
2379          * Returns: Length of the SSID on success, -1 on failure
2380          *
2381          * This function need not be implemented if the driver uses Beacon
2382          * template from set_ap() and does not reply to Probe Request frames.
2383          */
2384         int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2385
2386         /**
2387          * hapd_set_ssid - Set SSID (AP only)
2388          * @priv: Private driver interface data
2389          * @buf: SSID
2390          * @len: Length of the SSID in octets
2391          * Returns: 0 on success, -1 on failure
2392          *
2393          * DEPRECATED - use set_ap() instead
2394          */
2395         int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2396
2397         /**
2398          * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2399          * @priv: Private driver interface data
2400          * @enabled: 1 = countermeasures enabled, 0 = disabled
2401          * Returns: 0 on success, -1 on failure
2402          *
2403          * This need not be implemented if the driver does not take care of
2404          * association processing.
2405          */
2406         int (*hapd_set_countermeasures)(void *priv, int enabled);
2407
2408         /**
2409          * sta_add - Add a station entry
2410          * @priv: Private driver interface data
2411          * @params: Station parameters
2412          * Returns: 0 on success, -1 on failure
2413          *
2414          * This function is used to add or set (params->set 1) a station
2415          * entry in the driver. Adding STA entries is used only if the driver
2416          * does not take care of association processing.
2417          *
2418          * With drivers that don't support full AP client state, this function
2419          * is used to add a station entry to the driver once the station has
2420          * completed association.
2421          *
2422          * With TDLS, this function is used to add or set (params->set 1)
2423          * TDLS peer entries (even with drivers that do not support full AP
2424          * client state).
2425          */
2426         int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2427
2428         /**
2429          * get_inact_sec - Get station inactivity duration (AP only)
2430          * @priv: Private driver interface data
2431          * @addr: Station address
2432          * Returns: Number of seconds station has been inactive, -1 on failure
2433          */
2434         int (*get_inact_sec)(void *priv, const u8 *addr);
2435
2436         /**
2437          * sta_clear_stats - Clear station statistics (AP only)
2438          * @priv: Private driver interface data
2439          * @addr: Station address
2440          * Returns: 0 on success, -1 on failure
2441          */
2442         int (*sta_clear_stats)(void *priv, const u8 *addr);
2443
2444         /**
2445          * set_freq - Set channel/frequency (AP only)
2446          * @priv: Private driver interface data
2447          * @freq: Channel parameters
2448          * Returns: 0 on success, -1 on failure
2449          */
2450         int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2451
2452         /**
2453          * set_rts - Set RTS threshold
2454          * @priv: Private driver interface data
2455          * @rts: RTS threshold in octets
2456          * Returns: 0 on success, -1 on failure
2457          */
2458         int (*set_rts)(void *priv, int rts);
2459
2460         /**
2461          * set_frag - Set fragmentation threshold
2462          * @priv: Private driver interface data
2463          * @frag: Fragmentation threshold in octets
2464          * Returns: 0 on success, -1 on failure
2465          */
2466         int (*set_frag)(void *priv, int frag);
2467
2468         /**
2469          * sta_set_flags - Set station flags (AP only)
2470          * @priv: Private driver interface data
2471          * @addr: Station address
2472          * @total_flags: Bitmap of all WPA_STA_* flags currently set
2473          * @flags_or: Bitmap of WPA_STA_* flags to add
2474          * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2475          * Returns: 0 on success, -1 on failure
2476          */
2477         int (*sta_set_flags)(void *priv, const u8 *addr,
2478                              unsigned int total_flags, unsigned int flags_or,
2479                              unsigned int flags_and);
2480
2481         /**
2482          * set_tx_queue_params - Set TX queue parameters
2483          * @priv: Private driver interface data
2484          * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2485          * @aifs: AIFS
2486          * @cw_min: cwMin
2487          * @cw_max: cwMax
2488          * @burst_time: Maximum length for bursting in 0.1 msec units
2489          */
2490         int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2491                                    int cw_max, int burst_time);
2492
2493         /**
2494          * if_add - Add a virtual interface
2495          * @priv: Private driver interface data
2496          * @type: Interface type
2497          * @ifname: Interface name for the new virtual interface
2498          * @addr: Local address to use for the interface or %NULL to use the
2499          *      parent interface address
2500          * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2501          * @drv_priv: Pointer for overwriting the driver context or %NULL if
2502          *      not allowed (applies only to %WPA_IF_AP_BSS type)
2503          * @force_ifname: Buffer for returning an interface name that the
2504          *      driver ended up using if it differs from the requested ifname
2505          * @if_addr: Buffer for returning the allocated interface address
2506          *      (this may differ from the requested addr if the driver cannot
2507          *      change interface address)
2508          * @bridge: Bridge interface to use or %NULL if no bridge configured
2509          * @use_existing: Whether to allow existing interface to be used
2510          * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
2511          * Returns: 0 on success, -1 on failure
2512          */
2513         int (*if_add)(void *priv, enum wpa_driver_if_type type,
2514                       const char *ifname, const u8 *addr, void *bss_ctx,
2515                       void **drv_priv, char *force_ifname, u8 *if_addr,
2516                       const char *bridge, int use_existing, int setup_ap);
2517
2518         /**
2519          * if_remove - Remove a virtual interface
2520          * @priv: Private driver interface data
2521          * @type: Interface type
2522          * @ifname: Interface name of the virtual interface to be removed
2523          * Returns: 0 on success, -1 on failure
2524          */
2525         int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2526                          const char *ifname);
2527
2528         /**
2529          * set_sta_vlan - Bind a station into a specific interface (AP only)
2530          * @priv: Private driver interface data
2531          * @ifname: Interface (main or virtual BSS or VLAN)
2532          * @addr: MAC address of the associated station
2533          * @vlan_id: VLAN ID
2534          * Returns: 0 on success, -1 on failure
2535          *
2536          * This function is used to bind a station to a specific virtual
2537          * interface. It is only used if when virtual interfaces are supported,
2538          * e.g., to assign stations to different VLAN interfaces based on
2539          * information from a RADIUS server. This allows separate broadcast
2540          * domains to be used with a single BSS.
2541          */
2542         int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2543                             int vlan_id);
2544
2545         /**
2546          * commit - Optional commit changes handler (AP only)
2547          * @priv: driver private data
2548          * Returns: 0 on success, -1 on failure
2549          *
2550          * This optional handler function can be registered if the driver
2551          * interface implementation needs to commit changes (e.g., by setting
2552          * network interface up) at the end of initial configuration. If set,
2553          * this handler will be called after initial setup has been completed.
2554          */
2555         int (*commit)(void *priv);
2556
2557         /**
2558          * send_ether - Send an ethernet packet (AP only)
2559          * @priv: private driver interface data
2560          * @dst: Destination MAC address
2561          * @src: Source MAC address
2562          * @proto: Ethertype
2563          * @data: EAPOL packet starting with IEEE 802.1X header
2564          * @data_len: Length of the EAPOL packet in octets
2565          * Returns: 0 on success, -1 on failure
2566          */
2567         int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2568                           const u8 *data, size_t data_len);
2569
2570         /**
2571          * set_radius_acl_auth - Notification of RADIUS ACL change
2572          * @priv: Private driver interface data
2573          * @mac: MAC address of the station
2574          * @accepted: Whether the station was accepted
2575          * @session_timeout: Session timeout for the station
2576          * Returns: 0 on success, -1 on failure
2577          */
2578         int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2579                                    u32 session_timeout);
2580
2581         /**
2582          * set_radius_acl_expire - Notification of RADIUS ACL expiration
2583          * @priv: Private driver interface data
2584          * @mac: MAC address of the station
2585          * Returns: 0 on success, -1 on failure
2586          */
2587         int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2588
2589         /**
2590          * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2591          * @priv: Private driver interface data
2592          * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2593          * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2594          *      extra IE(s)
2595          * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2596          *      to remove extra IE(s)
2597          * Returns: 0 on success, -1 on failure
2598          *
2599          * This is an optional function to add WPS IE in the kernel driver for
2600          * Beacon and Probe Response frames. This can be left undefined (set
2601          * to %NULL) if the driver uses the Beacon template from set_ap()
2602          * and does not process Probe Request frames. If the driver takes care
2603          * of (Re)Association frame processing, the assocresp buffer includes
2604          * WPS IE(s) that need to be added to (Re)Association Response frames
2605          * whenever a (Re)Association Request frame indicated use of WPS.
2606          *
2607          * This will also be used to add P2P IE(s) into Beacon/Probe Response
2608          * frames when operating as a GO. The driver is responsible for adding
2609          * timing related attributes (e.g., NoA) in addition to the IEs
2610          * included here by appending them after these buffers. This call is
2611          * also used to provide Probe Response IEs for P2P Listen state
2612          * operations for drivers that generate the Probe Response frames
2613          * internally.
2614          *
2615          * DEPRECATED - use set_ap() instead
2616          */
2617         int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2618                              const struct wpabuf *proberesp,
2619                              const struct wpabuf *assocresp);
2620
2621         /**
2622          * set_supp_port - Set IEEE 802.1X Supplicant Port status
2623          * @priv: Private driver interface data
2624          * @authorized: Whether the port is authorized
2625          * Returns: 0 on success, -1 on failure
2626          */
2627         int (*set_supp_port)(void *priv, int authorized);
2628
2629         /**
2630          * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2631          * @priv: Private driver interface data
2632          * @addr: MAC address of the associated station
2633          * @aid: Association ID
2634          * @val: 1 = bind to 4-address WDS; 0 = unbind
2635          * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2636          *      to indicate that bridge is not to be used
2637          * @ifname_wds: Buffer to return the interface name for the new WDS
2638          *      station or %NULL to indicate name is not returned.
2639          * Returns: 0 on success, -1 on failure
2640          */
2641         int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2642                            const char *bridge_ifname, char *ifname_wds);
2643
2644         /**
2645          * send_action - Transmit an Action frame
2646          * @priv: Private driver interface data
2647          * @freq: Frequency (in MHz) of the channel
2648          * @wait: Time to wait off-channel for a response (in ms), or zero
2649          * @dst: Destination MAC address (Address 1)
2650          * @src: Source MAC address (Address 2)
2651          * @bssid: BSSID (Address 3)
2652          * @data: Frame body
2653          * @data_len: data length in octets
2654          @ @no_cck: Whether CCK rates must not be used to transmit this frame
2655          * Returns: 0 on success, -1 on failure
2656          *
2657          * This command can be used to request the driver to transmit an action
2658          * frame to the specified destination.
2659          *
2660          * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2661          * be transmitted on the given channel and the device will wait for a
2662          * response on that channel for the given wait time.
2663          *
2664          * If the flag is not set, the wait time will be ignored. In this case,
2665          * if a remain-on-channel duration is in progress, the frame must be
2666          * transmitted on that channel; alternatively the frame may be sent on
2667          * the current operational channel (if in associated state in station
2668          * mode or while operating as an AP.)
2669          */
2670         int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2671                            const u8 *dst, const u8 *src, const u8 *bssid,
2672                            const u8 *data, size_t data_len, int no_cck);
2673
2674         /**
2675          * send_action_cancel_wait - Cancel action frame TX wait
2676          * @priv: Private driver interface data
2677          *
2678          * This command cancels the wait time associated with sending an action
2679          * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2680          * set in the driver flags.
2681          */
2682         void (*send_action_cancel_wait)(void *priv);
2683
2684         /**
2685          * remain_on_channel - Remain awake on a channel
2686          * @priv: Private driver interface data
2687          * @freq: Frequency (in MHz) of the channel
2688          * @duration: Duration in milliseconds
2689          * Returns: 0 on success, -1 on failure
2690          *
2691          * This command is used to request the driver to remain awake on the
2692          * specified channel for the specified duration and report received
2693          * Action frames with EVENT_RX_MGMT events. Optionally, received
2694          * Probe Request frames may also be requested to be reported by calling
2695          * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2696          *
2697          * The driver may not be at the requested channel when this function
2698          * returns, i.e., the return code is only indicating whether the
2699          * request was accepted. The caller will need to wait until the
2700          * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2701          * completed the channel change. This may take some time due to other
2702          * need for the radio and the caller should be prepared to timing out
2703          * its wait since there are no guarantees on when this request can be
2704          * executed.
2705          */
2706         int (*remain_on_channel)(void *priv, unsigned int freq,
2707                                  unsigned int duration);
2708
2709         /**
2710          * cancel_remain_on_channel - Cancel remain-on-channel operation
2711          * @priv: Private driver interface data
2712          *
2713          * This command can be used to cancel a remain-on-channel operation
2714          * before its originally requested duration has passed. This could be
2715          * used, e.g., when remain_on_channel() is used to request extra time
2716          * to receive a response to an Action frame and the response is
2717          * received when there is still unneeded time remaining on the
2718          * remain-on-channel operation.
2719          */
2720         int (*cancel_remain_on_channel)(void *priv);
2721
2722         /**
2723          * probe_req_report - Request Probe Request frames to be indicated
2724          * @priv: Private driver interface data
2725          * @report: Whether to report received Probe Request frames
2726          * Returns: 0 on success, -1 on failure (or if not supported)
2727          *
2728          * This command can be used to request the driver to indicate when
2729          * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2730          * Since this operation may require extra resources, e.g., due to less
2731          * optimal hardware/firmware RX filtering, many drivers may disable
2732          * Probe Request reporting at least in station mode. This command is
2733          * used to notify the driver when the Probe Request frames need to be
2734          * reported, e.g., during remain-on-channel operations.
2735          */
2736         int (*probe_req_report)(void *priv, int report);
2737
2738         /**
2739          * deinit_ap - Deinitialize AP mode
2740          * @priv: Private driver interface data
2741          * Returns: 0 on success, -1 on failure (or if not supported)
2742          *
2743          * This optional function can be used to disable AP mode related
2744          * configuration. If the interface was not dynamically added,
2745          * change the driver mode to station mode to allow normal station
2746          * operations like scanning to be completed.
2747          */
2748         int (*deinit_ap)(void *priv);
2749
2750         /**
2751          * deinit_p2p_cli - Deinitialize P2P client mode
2752          * @priv: Private driver interface data
2753          * Returns: 0 on success, -1 on failure (or if not supported)
2754          *
2755          * This optional function can be used to disable P2P client mode. If the
2756          * interface was not dynamically added, change the interface type back
2757          * to station mode.
2758          */
2759         int (*deinit_p2p_cli)(void *priv);
2760
2761         /**
2762          * suspend - Notification on system suspend/hibernate event
2763          * @priv: Private driver interface data
2764          */
2765         void (*suspend)(void *priv);
2766
2767         /**
2768          * resume - Notification on system resume/thaw event
2769          * @priv: Private driver interface data
2770          */
2771         void (*resume)(void *priv);
2772
2773         /**
2774          * signal_monitor - Set signal monitoring parameters
2775          * @priv: Private driver interface data
2776          * @threshold: Threshold value for signal change events; 0 = disabled
2777          * @hysteresis: Minimum change in signal strength before indicating a
2778          *      new event
2779          * Returns: 0 on success, -1 on failure (or if not supported)
2780          *
2781          * This function can be used to configure monitoring of signal strength
2782          * with the current AP. Whenever signal strength drops below the
2783          * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2784          * should be generated assuming the signal strength has changed at
2785          * least %hysteresis from the previously indicated signal change event.
2786          */
2787         int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2788
2789         /**
2790          * send_frame - Send IEEE 802.11 frame (testing use only)
2791          * @priv: Private driver interface data
2792          * @data: IEEE 802.11 frame with IEEE 802.11 header
2793          * @data_len: Size of the frame
2794          * @encrypt: Whether to encrypt the frame (if keys are set)
2795          * Returns: 0 on success, -1 on failure
2796          *
2797          * This function is only used for debugging purposes and is not
2798          * required to be implemented for normal operations.
2799          */
2800         int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2801                           int encrypt);
2802
2803         /**
2804          * get_noa - Get current Notice of Absence attribute payload
2805          * @priv: Private driver interface data
2806          * @buf: Buffer for returning NoA
2807          * @buf_len: Buffer length in octets
2808          * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2809          * advertized, or -1 on failure
2810          *
2811          * This function is used to fetch the current Notice of Absence
2812          * attribute value from GO.
2813          */
2814         int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2815
2816         /**
2817          * set_noa - Set Notice of Absence parameters for GO (testing)
2818          * @priv: Private driver interface data
2819          * @count: Count
2820          * @start: Start time in ms from next TBTT
2821          * @duration: Duration in ms
2822          * Returns: 0 on success or -1 on failure
2823          *
2824          * This function is used to set Notice of Absence parameters for GO. It
2825          * is used only for testing. To disable NoA, all parameters are set to
2826          * 0.
2827          */
2828         int (*set_noa)(void *priv, u8 count, int start, int duration);
2829
2830         /**
2831          * set_p2p_powersave - Set P2P power save options
2832          * @priv: Private driver interface data
2833          * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2834          * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2835          * @ctwindow: 0.. = change (msec), -1 = no change
2836          * Returns: 0 on success or -1 on failure
2837          */
2838         int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2839                                  int ctwindow);
2840
2841         /**
2842          * ampdu - Enable/disable aggregation
2843          * @priv: Private driver interface data
2844          * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2845          * Returns: 0 on success or -1 on failure
2846          */
2847         int (*ampdu)(void *priv, int ampdu);
2848
2849         /**
2850          * get_radio_name - Get physical radio name for the device
2851          * @priv: Private driver interface data
2852          * Returns: Radio name or %NULL if not known
2853          *
2854          * The returned data must not be modified by the caller. It is assumed
2855          * that any interface that has the same radio name as another is
2856          * sharing the same physical radio. This information can be used to
2857          * share scan results etc. information between the virtual interfaces
2858          * to speed up various operations.
2859          */
2860         const char * (*get_radio_name)(void *priv);
2861
2862         /**
2863          * send_tdls_mgmt - for sending TDLS management packets
2864          * @priv: private driver interface data
2865          * @dst: Destination (peer) MAC address
2866          * @action_code: TDLS action code for the mssage
2867          * @dialog_token: Dialog Token to use in the message (if needed)
2868          * @status_code: Status Code or Reason Code to use (if needed)
2869          * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2870          * @initiator: Is the current end the TDLS link initiator
2871          * @buf: TDLS IEs to add to the message
2872          * @len: Length of buf in octets
2873          * Returns: 0 on success, negative (<0) on failure
2874          *
2875          * This optional function can be used to send packet to driver which is
2876          * responsible for receiving and sending all TDLS packets.
2877          */
2878         int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2879                               u8 dialog_token, u16 status_code, u32 peer_capab,
2880                               int initiator, const u8 *buf, size_t len);
2881
2882         /**
2883          * tdls_oper - Ask the driver to perform high-level TDLS operations
2884          * @priv: Private driver interface data
2885          * @oper: TDLS high-level operation. See %enum tdls_oper
2886          * @peer: Destination (peer) MAC address
2887          * Returns: 0 on success, negative (<0) on failure
2888          *
2889          * This optional function can be used to send high-level TDLS commands
2890          * to the driver.
2891          */
2892         int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2893
2894         /**
2895          * wnm_oper - Notify driver of the WNM frame reception
2896          * @priv: Private driver interface data
2897          * @oper: WNM operation. See %enum wnm_oper
2898          * @peer: Destination (peer) MAC address
2899          * @buf: Buffer for the driver to fill in (for getting IE)
2900          * @buf_len: Return the len of buf
2901          * Returns: 0 on success, negative (<0) on failure
2902          */
2903         int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2904                         u8 *buf, u16 *buf_len);
2905
2906         /**
2907          * set_qos_map - Set QoS Map
2908          * @priv: Private driver interface data
2909          * @qos_map_set: QoS Map
2910          * @qos_map_set_len: Length of QoS Map
2911          */
2912         int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2913                            u8 qos_map_set_len);
2914
2915         /**
2916          * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2917          * @priv: Private driver interface data
2918          * @version: IP version of the IP address, 4 or 6
2919          * @ipaddr: IP address for the neigh entry
2920          * @prefixlen: IP address prefix length
2921          * @addr: Corresponding MAC address
2922          * Returns: 0 on success, negative (<0) on failure
2923          */
2924         int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2925                                int prefixlen, const u8 *addr);
2926
2927         /**
2928          * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2929          * @priv: Private driver interface data
2930          * @version: IP version of the IP address, 4 or 6
2931          * @ipaddr: IP address for the neigh entry
2932          * Returns: 0 on success, negative (<0) on failure
2933          */
2934         int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2935
2936         /**
2937          * br_port_set_attr - Set a bridge port attribute
2938          * @attr: Bridge port attribute to set
2939          * @val: Value to be set
2940          * Returns: 0 on success, negative (<0) on failure
2941          */
2942         int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2943                                 unsigned int val);
2944
2945         /**
2946          * br_port_set_attr - Set a bridge network parameter
2947          * @param: Bridge parameter to set
2948          * @val: Value to be set
2949          * Returns: 0 on success, negative (<0) on failure
2950          */
2951         int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2952                                 unsigned int val);
2953
2954         /**
2955          * set_wowlan - Set wake-on-wireless triggers
2956          * @priv: Private driver interface data
2957          * @triggers: wowlan triggers
2958          */
2959         int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2960
2961         /**
2962          * signal_poll - Get current connection information
2963          * @priv: Private driver interface data
2964          * @signal_info: Connection info structure
2965          */
2966         int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2967
2968         /**
2969          * set_authmode - Set authentication algorithm(s) for static WEP
2970          * @priv: Private driver interface data
2971          * @authmode: 1=Open System, 2=Shared Key, 3=both
2972          * Returns: 0 on success, -1 on failure
2973          *
2974          * This function can be used to set authentication algorithms for AP
2975          * mode when static WEP is used. If the driver uses user space MLME/SME
2976          * implementation, there is no need to implement this function.
2977          *
2978          * DEPRECATED - use set_ap() instead
2979          */
2980         int (*set_authmode)(void *priv, int authmode);
2981
2982 #ifdef ANDROID
2983         /**
2984          * driver_cmd - Execute driver-specific command
2985          * @priv: Private driver interface data
2986          * @cmd: Command to execute
2987          * @buf: Return buffer
2988          * @buf_len: Buffer length
2989          * Returns: 0 on success, -1 on failure
2990          */
2991         int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2992 #endif /* ANDROID */
2993
2994         /**
2995          * vendor_cmd - Execute vendor specific command
2996          * @priv: Private driver interface data
2997          * @vendor_id: Vendor id
2998          * @subcmd: Vendor command id
2999          * @data: Vendor command parameters (%NULL if no parameters)
3000          * @data_len: Data length
3001          * @buf: Return buffer (%NULL to ignore reply)
3002          * Returns: 0 on success, negative (<0) on failure
3003          *
3004          * This function handles vendor specific commands that are passed to
3005          * the driver/device. The command is identified by vendor id and
3006          * command id. Parameters can be passed as argument to the command
3007          * in the data buffer. Reply (if any) will be filled in the supplied
3008          * return buffer.
3009          *
3010          * The exact driver behavior is driver interface and vendor specific. As
3011          * an example, this will be converted to a vendor specific cfg80211
3012          * command in case of the nl80211 driver interface.
3013          */
3014         int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3015                           unsigned int subcmd, const u8 *data, size_t data_len,
3016                           struct wpabuf *buf);
3017
3018         /**
3019          * set_rekey_info - Set rekey information
3020          * @priv: Private driver interface data
3021          * @kek: Current KEK
3022          * @kek_len: KEK length in octets
3023          * @kck: Current KCK
3024          * @kck_len: KCK length in octets
3025          * @replay_ctr: Current EAPOL-Key Replay Counter
3026          *
3027          * This optional function can be used to provide information for the
3028          * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3029          * while the host (including wpa_supplicant) is sleeping.
3030          */
3031         void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3032                                const u8 *kck, size_t kck_len,
3033                                const u8 *replay_ctr);
3034
3035         /**
3036          * sta_assoc - Station association indication
3037          * @priv: Private driver interface data
3038          * @own_addr: Source address and BSSID for association frame
3039          * @addr: MAC address of the station to associate
3040          * @reassoc: flag to indicate re-association
3041          * @status: association response status code
3042          * @ie: assoc response ie buffer
3043          * @len: ie buffer length
3044          * Returns: 0 on success, -1 on failure
3045          *
3046          * This function indicates the driver to send (Re)Association
3047          * Response frame to the station.
3048          */
3049          int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3050                           int reassoc, u16 status, const u8 *ie, size_t len);
3051
3052         /**
3053          * sta_auth - Station authentication indication
3054          * @priv: Private driver interface data
3055          * @own_addr: Source address and BSSID for authentication frame
3056          * @addr: MAC address of the station to associate
3057          * @seq: authentication sequence number
3058          * @status: authentication response status code
3059          * @ie: authentication frame ie buffer
3060          * @len: ie buffer length
3061          *
3062          * This function indicates the driver to send Authentication frame
3063          * to the station.
3064          */
3065          int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
3066                          u16 seq, u16 status, const u8 *ie, size_t len);
3067
3068         /**
3069          * add_tspec - Add traffic stream
3070          * @priv: Private driver interface data
3071          * @addr: MAC address of the station to associate
3072          * @tspec_ie: tspec ie buffer
3073          * @tspec_ielen: tspec ie length
3074          * Returns: 0 on success, -1 on failure
3075          *
3076          * This function adds the traffic steam for the station
3077          * and fills the medium_time in tspec_ie.
3078          */
3079          int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3080                           size_t tspec_ielen);
3081
3082         /**
3083          * add_sta_node - Add a station node in the driver
3084          * @priv: Private driver interface data
3085          * @addr: MAC address of the station to add
3086          * @auth_alg: authentication algorithm used by the station
3087          * Returns: 0 on success, -1 on failure
3088          *
3089          * This function adds the station node in the driver, when
3090          * the station gets added by FT-over-DS.
3091          */
3092         int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
3093
3094         /**
3095          * sched_scan - Request the driver to initiate scheduled scan
3096          * @priv: Private driver interface data
3097          * @params: Scan parameters
3098          * Returns: 0 on success, -1 on failure
3099          *
3100          * This operation should be used for scheduled scan offload to
3101          * the hardware. Every time scan results are available, the
3102          * driver should report scan results event for wpa_supplicant
3103          * which will eventually request the results with
3104          * wpa_driver_get_scan_results2(). This operation is optional
3105          * and if not provided or if it returns -1, we fall back to
3106          * normal host-scheduled scans.
3107          */
3108         int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
3109
3110         /**
3111          * stop_sched_scan - Request the driver to stop a scheduled scan
3112          * @priv: Private driver interface data
3113          * Returns: 0 on success, -1 on failure
3114          *
3115          * This should cause the scheduled scan to be stopped and
3116          * results should stop being sent. Must be supported if
3117          * sched_scan is supported.
3118          */
3119         int (*stop_sched_scan)(void *priv);
3120
3121         /**
3122          * poll_client - Probe (null data or such) the given station
3123          * @priv: Private driver interface data
3124          * @own_addr: MAC address of sending interface
3125          * @addr: MAC address of the station to probe
3126          * @qos: Indicates whether station is QoS station
3127          *
3128          * This function is used to verify whether an associated station is
3129          * still present. This function does not need to be implemented if the
3130          * driver provides such inactivity polling mechanism.
3131          */
3132         void (*poll_client)(void *priv, const u8 *own_addr,
3133                             const u8 *addr, int qos);
3134
3135         /**
3136          * radio_disable - Disable/enable radio
3137          * @priv: Private driver interface data
3138          * @disabled: 1=disable 0=enable radio
3139          * Returns: 0 on success, -1 on failure
3140          *
3141          * This optional command is for testing purposes. It can be used to
3142          * disable the radio on a testbed device to simulate out-of-radio-range
3143          * conditions.
3144          */
3145         int (*radio_disable)(void *priv, int disabled);
3146
3147         /**
3148          * switch_channel - Announce channel switch and migrate the GO to the
3149          * given frequency
3150          * @priv: Private driver interface data
3151          * @settings: Settings for CSA period and new channel
3152          * Returns: 0 on success, -1 on failure
3153          *
3154          * This function is used to move the GO to the legacy STA channel to
3155          * avoid frequency conflict in single channel concurrency.
3156          */
3157         int (*switch_channel)(void *priv, struct csa_settings *settings);
3158
3159         /**
3160          * add_tx_ts - Add traffic stream
3161          * @priv: Private driver interface data
3162          * @tsid: Traffic stream ID
3163          * @addr: Receiver address
3164          * @user_prio: User priority of the traffic stream
3165          * @admitted_time: Admitted time for this TS in units of
3166          *      32 microsecond periods (per second).
3167          * Returns: 0 on success, -1 on failure
3168          */
3169         int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3170                          u16 admitted_time);
3171
3172         /**
3173          * del_tx_ts - Delete traffic stream
3174          * @priv: Private driver interface data
3175          * @tsid: Traffic stream ID
3176          * @addr: Receiver address
3177          * Returns: 0 on success, -1 on failure
3178          */
3179         int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3180
3181         /**
3182          * Enable channel-switching with TDLS peer
3183          * @priv: Private driver interface data
3184          * @addr: MAC address of the TDLS peer
3185          * @oper_class: Operating class of the switch channel
3186          * @params: Channel specification
3187          * Returns: 0 on success, -1 on failure
3188          *
3189          * The function indicates to driver that it can start switching to a
3190          * different channel with a specified TDLS peer. The switching is
3191          * assumed on until canceled with tdls_disable_channel_switch().
3192          */
3193         int (*tdls_enable_channel_switch)(
3194                 void *priv, const u8 *addr, u8 oper_class,
3195                 const struct hostapd_freq_params *params);
3196
3197         /**
3198          * Disable channel switching with TDLS peer
3199          * @priv: Private driver interface data
3200          * @addr: MAC address of the TDLS peer
3201          * Returns: 0 on success, -1 on failure
3202          *
3203          * This function indicates to the driver that it should stop switching
3204          * with a given TDLS peer.
3205          */
3206         int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3207
3208         /**
3209          * start_dfs_cac - Listen for radar interference on the channel
3210          * @priv: Private driver interface data
3211          * @freq: Channel parameters
3212          * Returns: 0 on success, -1 on failure
3213          */
3214         int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
3215
3216         /**
3217          * stop_ap - Removes beacon from AP
3218          * @priv: Private driver interface data
3219          * Returns: 0 on success, -1 on failure (or if not supported)
3220          *
3221          * This optional function can be used to disable AP mode related
3222          * configuration. Unlike deinit_ap, it does not change to station
3223          * mode.
3224          */
3225         int (*stop_ap)(void *priv);
3226
3227         /**
3228          * get_survey - Retrieve survey data
3229          * @priv: Private driver interface data
3230          * @freq: If set, survey data for the specified frequency is only
3231          *      being requested. If not set, all survey data is requested.
3232          * Returns: 0 on success, -1 on failure
3233          *
3234          * Use this to retrieve:
3235          *
3236          * - the observed channel noise floor
3237          * - the amount of time we have spent on the channel
3238          * - the amount of time during which we have spent on the channel that
3239          *   the radio has determined the medium is busy and we cannot
3240          *   transmit
3241          * - the amount of time we have spent receiving data
3242          * - the amount of time we have spent transmitting data
3243          *
3244          * This data can be used for spectrum heuristics. One example is
3245          * Automatic Channel Selection (ACS). The channel survey data is
3246          * kept on a linked list on the channel data, one entry is added
3247          * for each survey. The min_nf of the channel is updated for each
3248          * survey.
3249          */
3250         int (*get_survey)(void *priv, unsigned int freq);
3251
3252         /**
3253          * status - Get driver interface status information
3254          * @priv: Private driver interface data
3255          * @buf: Buffer for printing tou the status information
3256          * @buflen: Maximum length of the buffer
3257          * Returns: Length of written status information or -1 on failure
3258          */
3259         int (*status)(void *priv, char *buf, size_t buflen);
3260
3261         /**
3262          * roaming - Set roaming policy for driver-based BSS selection
3263          * @priv: Private driver interface data
3264          * @allowed: Whether roaming within ESS is allowed
3265          * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3266          * Returns: Length of written status information or -1 on failure
3267          *
3268          * This optional callback can be used to update roaming policy from the
3269          * associate() command (bssid being set there indicates that the driver
3270          * should not roam before getting this roaming() call to allow roaming.
3271          * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3272          * capability, roaming policy is handled within wpa_supplicant and there
3273          * is no need to implement or react to this callback.
3274          */
3275         int (*roaming)(void *priv, int allowed, const u8 *bssid);
3276
3277         /**
3278          * set_mac_addr - Set MAC address
3279          * @priv: Private driver interface data
3280          * @addr: MAC address to use or %NULL for setting back to permanent
3281          * Returns: 0 on success, -1 on failure
3282          */
3283         int (*set_mac_addr)(void *priv, const u8 *addr);
3284
3285 #ifdef CONFIG_MACSEC
3286         int (*macsec_init)(void *priv, struct macsec_init_params *params);
3287
3288         int (*macsec_deinit)(void *priv);
3289
3290         /**
3291          * enable_protect_frames - Set protect frames status
3292          * @priv: Private driver interface data
3293          * @enabled: TRUE = protect frames enabled
3294          *           FALSE = protect frames disabled
3295          * Returns: 0 on success, -1 on failure (or if not supported)
3296          */
3297         int (*enable_protect_frames)(void *priv, Boolean enabled);
3298
3299         /**
3300          * set_replay_protect - Set replay protect status and window size
3301          * @priv: Private driver interface data
3302          * @enabled: TRUE = replay protect enabled
3303          *           FALSE = replay protect disabled
3304          * @window: replay window size, valid only when replay protect enabled
3305          * Returns: 0 on success, -1 on failure (or if not supported)
3306          */
3307         int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3308
3309         /**
3310          * set_current_cipher_suite - Set current cipher suite
3311          * @priv: Private driver interface data
3312          * @cs: EUI64 identifier
3313          * @cs_len: Length of the cs buffer in octets
3314          * Returns: 0 on success, -1 on failure (or if not supported)
3315          */
3316         int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3317                                         size_t cs_len);
3318
3319         /**
3320          * enable_controlled_port - Set controlled port status
3321          * @priv: Private driver interface data
3322          * @enabled: TRUE = controlled port enabled
3323          *           FALSE = controlled port disabled
3324          * Returns: 0 on success, -1 on failure (or if not supported)
3325          */
3326         int (*enable_controlled_port)(void *priv, Boolean enabled);
3327
3328         /**
3329          * get_receive_lowest_pn - Get receive lowest pn
3330          * @priv: Private driver interface data
3331          * @channel: secure channel
3332          * @an: association number
3333          * @lowest_pn: lowest accept pn
3334          * Returns: 0 on success, -1 on failure (or if not supported)
3335          */
3336         int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3337                                      u32 *lowest_pn);
3338
3339         /**
3340          * get_transmit_next_pn - Get transmit next pn
3341          * @priv: Private driver interface data
3342          * @channel: secure channel
3343          * @an: association number
3344          * @next_pn: next pn
3345          * Returns: 0 on success, -1 on failure (or if not supported)
3346          */
3347         int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3348                                     u32 *next_pn);
3349
3350         /**
3351          * set_transmit_next_pn - Set transmit next pn
3352          * @priv: Private driver interface data
3353          * @channel: secure channel
3354          * @an: association number
3355          * @next_pn: next pn
3356          * Returns: 0 on success, -1 on failure (or if not supported)
3357          */
3358         int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3359                                     u32 next_pn);
3360
3361         /**
3362          * get_available_receive_sc - get available receive channel
3363          * @priv: Private driver interface data
3364          * @channel: secure channel
3365          * Returns: 0 on success, -1 on failure (or if not supported)
3366          */
3367         int (*get_available_receive_sc)(void *priv, u32 *channel);
3368
3369         /**
3370          * create_receive_sc - create secure channel for receiving
3371          * @priv: Private driver interface data
3372          * @channel: secure channel
3373          * @sci_addr: secure channel identifier - address
3374          * @sci_port: secure channel identifier - port
3375          * @conf_offset: confidentiality offset (0, 30, or 50)
3376          * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3377          *      2 = Strict)
3378          * Returns: 0 on success, -1 on failure (or if not supported)
3379          */
3380         int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3381                                  u16 sci_port, unsigned int conf_offset,
3382                                  int validation);
3383
3384         /**
3385          * delete_receive_sc - delete secure connection for receiving
3386          * @priv: private driver interface data from init()
3387          * @channel: secure channel
3388          * Returns: 0 on success, -1 on failure
3389          */
3390         int (*delete_receive_sc)(void *priv, u32 channel);
3391
3392         /**
3393          * create_receive_sa - create secure association for receive
3394          * @priv: private driver interface data from init()
3395          * @channel: secure channel
3396          * @an: association number
3397          * @lowest_pn: the lowest packet number can be received
3398          * @sak: the secure association key
3399          * Returns: 0 on success, -1 on failure
3400          */
3401         int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3402                                  u32 lowest_pn, const u8 *sak);
3403
3404         /**
3405          * enable_receive_sa - enable the SA for receive
3406          * @priv: private driver interface data from init()
3407          * @channel: secure channel
3408          * @an: association number
3409          * Returns: 0 on success, -1 on failure
3410          */
3411         int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3412
3413         /**
3414          * disable_receive_sa - disable SA for receive
3415          * @priv: private driver interface data from init()
3416          * @channel: secure channel index
3417          * @an: association number
3418          * Returns: 0 on success, -1 on failure
3419          */
3420         int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3421
3422         /**
3423          * get_available_transmit_sc - get available transmit channel
3424          * @priv: Private driver interface data
3425          * @channel: secure channel
3426          * Returns: 0 on success, -1 on failure (or if not supported)
3427          */
3428         int (*get_available_transmit_sc)(void *priv, u32 *channel);
3429
3430         /**
3431          * create_transmit_sc - create secure connection for transmit
3432          * @priv: private driver interface data from init()
3433          * @channel: secure channel
3434          * @sci_addr: secure channel identifier - address
3435          * @sci_port: secure channel identifier - port
3436          * Returns: 0 on success, -1 on failure
3437          */
3438         int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3439                                   u16 sci_port, unsigned int conf_offset);
3440
3441         /**
3442          * delete_transmit_sc - delete secure connection for transmit
3443          * @priv: private driver interface data from init()
3444          * @channel: secure channel
3445          * Returns: 0 on success, -1 on failure
3446          */
3447         int (*delete_transmit_sc)(void *priv, u32 channel);
3448
3449         /**
3450          * create_transmit_sa - create secure association for transmit
3451          * @priv: private driver interface data from init()
3452          * @channel: secure channel index
3453          * @an: association number
3454          * @next_pn: the packet number used as next transmit packet
3455          * @confidentiality: True if the SA is to provide confidentiality
3456          *                   as well as integrity
3457          * @sak: the secure association key
3458          * Returns: 0 on success, -1 on failure
3459          */
3460         int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3461                                   Boolean confidentiality, const u8 *sak);
3462
3463         /**
3464          * enable_transmit_sa - enable SA for transmit
3465          * @priv: private driver interface data from init()
3466          * @channel: secure channel
3467          * @an: association number
3468          * Returns: 0 on success, -1 on failure
3469          */
3470         int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3471
3472         /**
3473          * disable_transmit_sa - disable SA for transmit
3474          * @priv: private driver interface data from init()
3475          * @channel: secure channel
3476          * @an: association number
3477          * Returns: 0 on success, -1 on failure
3478          */
3479         int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3480 #endif /* CONFIG_MACSEC */
3481
3482         /**
3483          * init_mesh - Driver specific initialization for mesh
3484          * @priv: Private driver interface data
3485          * Returns: 0 on success, -1 on failure
3486          */
3487         int (*init_mesh)(void *priv);
3488
3489         /**
3490          * join_mesh - Join a mesh network
3491          * @priv: Private driver interface data
3492          * @params: Mesh configuration parameters
3493          * Returns: 0 on success, -1 on failure
3494          */
3495         int (*join_mesh)(void *priv,
3496                          struct wpa_driver_mesh_join_params *params);
3497
3498         /**
3499          * leave_mesh - Leave a mesh network
3500          * @priv: Private driver interface data
3501          * Returns 0 on success, -1 on failure
3502          */
3503         int (*leave_mesh)(void *priv);
3504
3505         /**
3506          * do_acs - Automatically select channel
3507          * @priv: Private driver interface data
3508          * @params: Parameters for ACS
3509          * Returns 0 on success, -1 on failure
3510          *
3511          * This command can be used to offload ACS to the driver if the driver
3512          * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3513          */
3514         int (*do_acs)(void *priv, struct drv_acs_params *params);
3515
3516         /**
3517          * set_band - Notify driver of band selection
3518          * @priv: Private driver interface data
3519          * @band: The selected band(s)
3520          * Returns 0 on success, -1 on failure
3521          */
3522         int (*set_band)(void *priv, enum set_band band);
3523
3524         /**
3525          * get_pref_freq_list - Get preferred frequency list for an interface
3526          * @priv: Private driver interface data
3527          * @if_type: Interface type
3528          * @num: Number of channels
3529          * @freq_list: Preferred channel frequency list encoded in MHz values
3530          * Returns 0 on success, -1 on failure
3531          *
3532          * This command can be used to query the preferred frequency list from
3533          * the driver specific to a particular interface type.
3534          */
3535         int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
3536                                   unsigned int *num, unsigned int *freq_list);
3537
3538         /**
3539          * set_prob_oper_freq - Indicate probable P2P operating channel
3540          * @priv: Private driver interface data
3541          * @freq: Channel frequency in MHz
3542          * Returns 0 on success, -1 on failure
3543          *
3544          * This command can be used to inform the driver of the operating
3545          * frequency that an ongoing P2P group formation is likely to come up
3546          * on. Local device is assuming P2P Client role.
3547          */
3548         int (*set_prob_oper_freq)(void *priv, unsigned int freq);
3549
3550         /**
3551          * abort_scan - Request the driver to abort an ongoing scan
3552          * @priv: Private driver interface data
3553          * Returns 0 on success, -1 on failure
3554          */
3555         int (*abort_scan)(void *priv);
3556
3557         /**
3558          * configure_data_frame_filters - Request to configure frame filters
3559          * @priv: Private driver interface data
3560          * @filter_flags: The type of frames to filter (bitfield of
3561          * WPA_DATA_FRAME_FILTER_FLAG_*)
3562          * Returns: 0 on success or -1 on failure
3563          */
3564         int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
3565
3566         /**
3567          * get_ext_capab - Get extended capabilities for the specified interface
3568          * @priv: Private driver interface data
3569          * @type: Interface type for which to get extended capabilities
3570          * @ext_capab: Extended capabilities fetched
3571          * @ext_capab_mask: Extended capabilities mask
3572          * @ext_capab_len: Length of the extended capabilities
3573          * Returns: 0 on success or -1 on failure
3574          */
3575         int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
3576                              const u8 **ext_capab, const u8 **ext_capab_mask,
3577                              unsigned int *ext_capab_len);
3578
3579         /**
3580          * p2p_lo_start - Start offloading P2P listen to device
3581          * @priv: Private driver interface data
3582          * @freq: Listening frequency (MHz) for P2P listen
3583          * @period: Length of the listen operation in milliseconds
3584          * @interval: Interval for running the listen operation in milliseconds
3585          * @count: Number of times to run the listen operation
3586          * @device_types: Device primary and secondary types
3587          * @dev_types_len: Number of bytes for device_types
3588          * @ies: P2P IE and WSC IE for Probe Response frames
3589          * @ies_len: Length of ies in bytes
3590          * Returns: 0 on success or -1 on failure
3591          */
3592         int (*p2p_lo_start)(void *priv, unsigned int freq,
3593                             unsigned int period, unsigned int interval,
3594                             unsigned int count,
3595                             const u8 *device_types, size_t dev_types_len,
3596                             const u8 *ies, size_t ies_len);
3597
3598         /**
3599          * p2p_lo_stop - Stop P2P listen offload
3600          * @priv: Private driver interface data
3601          * Returns: 0 on success or -1 on failure
3602          */
3603         int (*p2p_lo_stop)(void *priv);
3604 };
3605
3606
3607 /**
3608  * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3609  */
3610 enum wpa_event_type {
3611         /**
3612          * EVENT_ASSOC - Association completed
3613          *
3614          * This event needs to be delivered when the driver completes IEEE
3615          * 802.11 association or reassociation successfully.
3616          * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3617          * after this event has been generated. In addition, optional
3618          * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3619          * more information about the association. If the driver interface gets
3620          * both of these events at the same time, it can also include the
3621          * assoc_info data in EVENT_ASSOC call.
3622          */
3623         EVENT_ASSOC,
3624
3625         /**
3626          * EVENT_DISASSOC - Association lost
3627          *
3628          * This event should be called when association is lost either due to
3629          * receiving deauthenticate or disassociate frame from the AP or when
3630          * sending either of these frames to the current AP. If the driver
3631          * supports separate deauthentication event, EVENT_DISASSOC should only
3632          * be used for disassociation and EVENT_DEAUTH for deauthentication.
3633          * In AP mode, union wpa_event_data::disassoc_info is required.
3634          */
3635         EVENT_DISASSOC,
3636
3637         /**
3638          * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3639          *
3640          * This event must be delivered when a Michael MIC error is detected by
3641          * the local driver. Additional data for event processing is
3642          * provided with union wpa_event_data::michael_mic_failure. This
3643          * information is used to request new encyption key and to initiate
3644          * TKIP countermeasures if needed.
3645          */
3646         EVENT_MICHAEL_MIC_FAILURE,
3647
3648         /**
3649          * EVENT_SCAN_RESULTS - Scan results available
3650          *
3651          * This event must be called whenever scan results are available to be
3652          * fetched with struct wpa_driver_ops::get_scan_results(). This event
3653          * is expected to be used some time after struct wpa_driver_ops::scan()
3654          * is called. If the driver provides an unsolicited event when the scan
3655          * has been completed, this event can be used to trigger
3656          * EVENT_SCAN_RESULTS call. If such event is not available from the
3657          * driver, the driver wrapper code is expected to use a registered
3658          * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3659          * scan is expected to be completed. Optional information about
3660          * completed scan can be provided with union wpa_event_data::scan_info.
3661          */
3662         EVENT_SCAN_RESULTS,
3663
3664         /**
3665          * EVENT_ASSOCINFO - Report optional extra information for association
3666          *
3667          * This event can be used to report extra association information for
3668          * EVENT_ASSOC processing. This extra information includes IEs from
3669          * association frames and Beacon/Probe Response frames in union
3670          * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3671          * EVENT_ASSOC. Alternatively, the driver interface can include
3672          * assoc_info data in the EVENT_ASSOC call if it has all the
3673          * information available at the same point.
3674          */
3675         EVENT_ASSOCINFO,
3676
3677         /**
3678          * EVENT_INTERFACE_STATUS - Report interface status changes
3679          *
3680          * This optional event can be used to report changes in interface
3681          * status (interface added/removed) using union
3682          * wpa_event_data::interface_status. This can be used to trigger
3683          * wpa_supplicant to stop and re-start processing for the interface,
3684          * e.g., when a cardbus card is ejected/inserted.
3685          */
3686         EVENT_INTERFACE_STATUS,
3687
3688         /**
3689          * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3690          *
3691          * This event can be used to inform wpa_supplicant about candidates for
3692          * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3693          * for scan request (ap_scan=2 mode), this event is required for
3694          * pre-authentication. If wpa_supplicant is performing scan request
3695          * (ap_scan=1), this event is optional since scan results can be used
3696          * to add pre-authentication candidates. union
3697          * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3698          * candidate and priority of the candidate, e.g., based on the signal
3699          * strength, in order to try to pre-authenticate first with candidates
3700          * that are most likely targets for re-association.
3701          *
3702          * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3703          * on the candidate list. In addition, it can be called for the current
3704          * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3705          * will automatically skip pre-authentication in cases where a valid
3706          * PMKSA exists. When more than one candidate exists, this event should
3707          * be generated once for each candidate.
3708          *
3709          * Driver will be notified about successful pre-authentication with
3710          * struct wpa_driver_ops::add_pmkid() calls.
3711          */
3712         EVENT_PMKID_CANDIDATE,
3713
3714         /**
3715          * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3716          *
3717          * This event can be used to inform wpa_supplicant about desire to set
3718          * up secure direct link connection between two stations as defined in
3719          * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3720          * STAKey negotiation. The caller will need to set peer address for the
3721          * event.
3722          */
3723         EVENT_STKSTART,
3724
3725         /**
3726          * EVENT_TDLS - Request TDLS operation
3727          *
3728          * This event can be used to request a TDLS operation to be performed.
3729          */
3730         EVENT_TDLS,
3731
3732         /**
3733          * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3734          *
3735          * The driver is expected to report the received FT IEs from
3736          * FT authentication sequence from the AP. The FT IEs are included in
3737          * the extra information in union wpa_event_data::ft_ies.
3738          */
3739         EVENT_FT_RESPONSE,
3740
3741         /**
3742          * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3743          *
3744          * The driver can use this event to inform wpa_supplicant about a STA
3745          * in an IBSS with which protected frames could be exchanged. This
3746          * event starts RSN authentication with the other STA to authenticate
3747          * the STA and set up encryption keys with it.
3748          */
3749         EVENT_IBSS_RSN_START,
3750
3751         /**
3752          * EVENT_AUTH - Authentication result
3753          *
3754          * This event should be called when authentication attempt has been
3755          * completed. This is only used if the driver supports separate
3756          * authentication step (struct wpa_driver_ops::authenticate).
3757          * Information about authentication result is included in
3758          * union wpa_event_data::auth.
3759          */
3760         EVENT_AUTH,
3761
3762         /**
3763          * EVENT_DEAUTH - Authentication lost
3764          *
3765          * This event should be called when authentication is lost either due
3766          * to receiving deauthenticate frame from the AP or when sending that
3767          * frame to the current AP.
3768          * In AP mode, union wpa_event_data::deauth_info is required.
3769          */
3770         EVENT_DEAUTH,
3771
3772         /**
3773          * EVENT_ASSOC_REJECT - Association rejected
3774          *
3775          * This event should be called when (re)association attempt has been
3776          * rejected by the AP. Information about the association response is
3777          * included in union wpa_event_data::assoc_reject.
3778          */
3779         EVENT_ASSOC_REJECT,
3780
3781         /**
3782          * EVENT_AUTH_TIMED_OUT - Authentication timed out
3783          */
3784         EVENT_AUTH_TIMED_OUT,
3785
3786         /**
3787          * EVENT_ASSOC_TIMED_OUT - Association timed out
3788          */
3789         EVENT_ASSOC_TIMED_OUT,
3790
3791         /**
3792          * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3793          */
3794         EVENT_WPS_BUTTON_PUSHED,
3795
3796         /**
3797          * EVENT_TX_STATUS - Report TX status
3798          */
3799         EVENT_TX_STATUS,
3800
3801         /**
3802          * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3803          */
3804         EVENT_RX_FROM_UNKNOWN,
3805
3806         /**
3807          * EVENT_RX_MGMT - Report RX of a management frame
3808          */
3809         EVENT_RX_MGMT,
3810
3811         /**
3812          * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3813          *
3814          * This event is used to indicate when the driver has started the
3815          * requested remain-on-channel duration. Information about the
3816          * operation is included in union wpa_event_data::remain_on_channel.
3817          */
3818         EVENT_REMAIN_ON_CHANNEL,
3819
3820         /**
3821          * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3822          *
3823          * This event is used to indicate when the driver has completed
3824          * remain-on-channel duration, i.e., may noot be available on the
3825          * requested channel anymore. Information about the
3826          * operation is included in union wpa_event_data::remain_on_channel.
3827          */
3828         EVENT_CANCEL_REMAIN_ON_CHANNEL,
3829
3830         /**
3831          * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3832          *
3833          * This event is used to indicate when a Probe Request frame has been
3834          * received. Information about the received frame is included in
3835          * union wpa_event_data::rx_probe_req. The driver is required to report
3836          * these events only after successfully completed probe_req_report()
3837          * commands to request the events (i.e., report parameter is non-zero)
3838          * in station mode. In AP mode, Probe Request frames should always be
3839          * reported.
3840          */
3841         EVENT_RX_PROBE_REQ,
3842
3843         /**
3844          * EVENT_NEW_STA - New wired device noticed
3845          *
3846          * This event is used to indicate that a new device has been detected
3847          * in a network that does not use association-like functionality (i.e.,
3848          * mainly wired Ethernet). This can be used to start EAPOL
3849          * authenticator when receiving a frame from a device. The address of
3850          * the device is included in union wpa_event_data::new_sta.
3851          */
3852         EVENT_NEW_STA,
3853
3854         /**
3855          * EVENT_EAPOL_RX - Report received EAPOL frame
3856          *
3857          * When in AP mode with hostapd, this event is required to be used to
3858          * deliver the receive EAPOL frames from the driver.
3859          */
3860         EVENT_EAPOL_RX,
3861
3862         /**
3863          * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3864          *
3865          * This event is used to indicate changes in the signal strength
3866          * observed in frames received from the current AP if signal strength
3867          * monitoring has been enabled with signal_monitor().
3868          */
3869         EVENT_SIGNAL_CHANGE,
3870
3871         /**
3872          * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3873          *
3874          * This event is used to indicate that the interface was enabled after
3875          * having been previously disabled, e.g., due to rfkill.
3876          */
3877         EVENT_INTERFACE_ENABLED,
3878
3879         /**
3880          * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3881          *
3882          * This event is used to indicate that the interface was disabled,
3883          * e.g., due to rfkill.
3884          */
3885         EVENT_INTERFACE_DISABLED,
3886
3887         /**
3888          * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3889          *
3890          * This event is used to indicate that the channel list has changed,
3891          * e.g., because of a regulatory domain change triggered by scan
3892          * results including an AP advertising a country code.
3893          */
3894         EVENT_CHANNEL_LIST_CHANGED,
3895
3896         /**
3897          * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3898          *
3899          * This event is used to indicate that the driver cannot maintain this
3900          * interface in its operation mode anymore. The most likely use for
3901          * this is to indicate that AP mode operation is not available due to
3902          * operating channel would need to be changed to a DFS channel when
3903          * the driver does not support radar detection and another virtual
3904          * interfaces caused the operating channel to change. Other similar
3905          * resource conflicts could also trigger this for station mode
3906          * interfaces. This event can be propagated when channel switching
3907          * fails.
3908          */
3909         EVENT_INTERFACE_UNAVAILABLE,
3910
3911         /**
3912          * EVENT_BEST_CHANNEL
3913          *
3914          * Driver generates this event whenever it detects a better channel
3915          * (e.g., based on RSSI or channel use). This information can be used
3916          * to improve channel selection for a new AP/P2P group.
3917          */
3918         EVENT_BEST_CHANNEL,
3919
3920         /**
3921          * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3922          *
3923          * This event should be called when a Deauthentication frame is dropped
3924          * due to it not being protected (MFP/IEEE 802.11w).
3925          * union wpa_event_data::unprot_deauth is required to provide more
3926          * details of the frame.
3927          */
3928         EVENT_UNPROT_DEAUTH,
3929
3930         /**
3931          * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3932          *
3933          * This event should be called when a Disassociation frame is dropped
3934          * due to it not being protected (MFP/IEEE 802.11w).
3935          * union wpa_event_data::unprot_disassoc is required to provide more
3936          * details of the frame.
3937          */
3938         EVENT_UNPROT_DISASSOC,
3939
3940         /**
3941          * EVENT_STATION_LOW_ACK
3942          *
3943          * Driver generates this event whenever it detected that a particular
3944          * station was lost. Detection can be through massive transmission
3945          * failures for example.
3946          */
3947         EVENT_STATION_LOW_ACK,
3948
3949         /**
3950          * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3951          */
3952         EVENT_IBSS_PEER_LOST,
3953
3954         /**
3955          * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3956          *
3957          * This event carries the new replay counter to notify wpa_supplicant
3958          * of the current EAPOL-Key Replay Counter in case the driver/firmware
3959          * completed Group Key Handshake while the host (including
3960          * wpa_supplicant was sleeping).
3961          */
3962         EVENT_DRIVER_GTK_REKEY,
3963
3964         /**
3965          * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3966          */
3967         EVENT_SCHED_SCAN_STOPPED,
3968
3969         /**
3970          * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3971          *
3972          * This event indicates that the station responded to the poll
3973          * initiated with @poll_client.
3974          */
3975         EVENT_DRIVER_CLIENT_POLL_OK,
3976
3977         /**
3978          * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3979          */
3980         EVENT_EAPOL_TX_STATUS,
3981
3982         /**
3983          * EVENT_CH_SWITCH - AP or GO decided to switch channels
3984          *
3985          * Described in wpa_event_data.ch_switch
3986          * */
3987         EVENT_CH_SWITCH,
3988
3989         /**
3990          * EVENT_WNM - Request WNM operation
3991          *
3992          * This event can be used to request a WNM operation to be performed.
3993          */
3994         EVENT_WNM,
3995
3996         /**
3997          * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3998          *
3999          * This event indicates that the driver reported a connection failure
4000          * with the specified client (for example, max client reached, etc.) in
4001          * AP mode.
4002          */
4003         EVENT_CONNECT_FAILED_REASON,
4004
4005         /**
4006          * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
4007          *
4008          * A radar has been detected on the supplied frequency, hostapd should
4009          * react accordingly (e.g., change channel).
4010          */
4011         EVENT_DFS_RADAR_DETECTED,
4012
4013         /**
4014          * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
4015          *
4016          * After a successful CAC, the channel can be marked clear and used.
4017          */
4018         EVENT_DFS_CAC_FINISHED,
4019
4020         /**
4021          * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
4022          *
4023          * The CAC was not successful, and the channel remains in the previous
4024          * state. This may happen due to a radar beeing detected or other
4025          * external influences.
4026          */
4027         EVENT_DFS_CAC_ABORTED,
4028
4029         /**
4030          * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
4031          *
4032          * The channel which was previously unavailable is now available again.
4033          */
4034         EVENT_DFS_NOP_FINISHED,
4035
4036         /**
4037          * EVENT_SURVEY - Received survey data
4038          *
4039          * This event gets triggered when a driver query is issued for survey
4040          * data and the requested data becomes available. The returned data is
4041          * stored in struct survey_results. The results provide at most one
4042          * survey entry for each frequency and at minimum will provide one
4043          * survey entry for one frequency. The survey data can be os_malloc()'d
4044          * and then os_free()'d, so the event callback must only copy data.
4045          */
4046         EVENT_SURVEY,
4047
4048         /**
4049          * EVENT_SCAN_STARTED - Scan started
4050          *
4051          * This indicates that driver has started a scan operation either based
4052          * on a request from wpa_supplicant/hostapd or from another application.
4053          * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4054          * completed (either successfully or by getting cancelled).
4055          */
4056         EVENT_SCAN_STARTED,
4057
4058         /**
4059          * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4060          *
4061          * This event indicates a set of frequency ranges that should be avoided
4062          * to reduce issues due to interference or internal co-existence
4063          * information in the driver.
4064          */
4065         EVENT_AVOID_FREQUENCIES,
4066
4067         /**
4068          * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4069          */
4070         EVENT_NEW_PEER_CANDIDATE,
4071
4072         /**
4073          * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4074          *
4075          * Indicates a pair of primary and secondary channels chosen by ACS
4076          * in device.
4077          */
4078         EVENT_ACS_CHANNEL_SELECTED,
4079
4080         /**
4081          * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4082          * been started.
4083          *
4084          * This event indicates that channel availability check has been started
4085          * on a DFS frequency by a driver that supports DFS Offload.
4086          */
4087         EVENT_DFS_CAC_STARTED,
4088
4089         /**
4090          * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4091          */
4092         EVENT_P2P_LO_STOP,
4093 };
4094
4095
4096 /**
4097  * struct freq_survey - Channel survey info
4098  *
4099  * @ifidx: Interface index in which this survey was observed
4100  * @freq: Center of frequency of the surveyed channel
4101  * @nf: Channel noise floor in dBm
4102  * @channel_time: Amount of time in ms the radio spent on the channel
4103  * @channel_time_busy: Amount of time in ms the radio detected some signal
4104  *     that indicated to the radio the channel was not clear
4105  * @channel_time_rx: Amount of time the radio spent receiving data
4106  * @channel_time_tx: Amount of time the radio spent transmitting data
4107  * @filled: bitmask indicating which fields have been reported, see
4108  *     SURVEY_HAS_* defines.
4109  * @list: Internal list pointers
4110  */
4111 struct freq_survey {
4112         u32 ifidx;
4113         unsigned int freq;
4114         s8 nf;
4115         u64 channel_time;
4116         u64 channel_time_busy;
4117         u64 channel_time_rx;
4118         u64 channel_time_tx;
4119         unsigned int filled;
4120         struct dl_list list;
4121 };
4122
4123 #define SURVEY_HAS_NF BIT(0)
4124 #define SURVEY_HAS_CHAN_TIME BIT(1)
4125 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4126 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4127 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4128
4129
4130 /**
4131  * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4132  */
4133 union wpa_event_data {
4134         /**
4135          * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4136          *
4137          * This structure is optional for EVENT_ASSOC calls and required for
4138          * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4139          * driver interface does not need to generate separate EVENT_ASSOCINFO
4140          * calls.
4141          */
4142         struct assoc_info {
4143                 /**
4144                  * reassoc - Flag to indicate association or reassociation
4145                  */
4146                 int reassoc;
4147
4148                 /**
4149                  * req_ies - (Re)Association Request IEs
4150                  *
4151                  * If the driver generates WPA/RSN IE, this event data must be
4152                  * returned for WPA handshake to have needed information. If
4153                  * wpa_supplicant-generated WPA/RSN IE is used, this
4154                  * information event is optional.
4155                  *
4156                  * This should start with the first IE (fixed fields before IEs
4157                  * are not included).
4158                  */
4159                 const u8 *req_ies;
4160
4161                 /**
4162                  * req_ies_len - Length of req_ies in bytes
4163                  */
4164                 size_t req_ies_len;
4165
4166                 /**
4167                  * resp_ies - (Re)Association Response IEs
4168                  *
4169                  * Optional association data from the driver. This data is not
4170                  * required WPA, but may be useful for some protocols and as
4171                  * such, should be reported if this is available to the driver
4172                  * interface.
4173                  *
4174                  * This should start with the first IE (fixed fields before IEs
4175                  * are not included).
4176                  */
4177                 const u8 *resp_ies;
4178
4179                 /**
4180                  * resp_ies_len - Length of resp_ies in bytes
4181                  */
4182                 size_t resp_ies_len;
4183
4184                 /**
4185                  * beacon_ies - Beacon or Probe Response IEs
4186                  *
4187                  * Optional Beacon/ProbeResp data: IEs included in Beacon or
4188                  * Probe Response frames from the current AP (i.e., the one
4189                  * that the client just associated with). This information is
4190                  * used to update WPA/RSN IE for the AP. If this field is not
4191                  * set, the results from previous scan will be used. If no
4192                  * data for the new AP is found, scan results will be requested
4193                  * again (without scan request). At this point, the driver is
4194                  * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4195                  * used).
4196                  *
4197                  * This should start with the first IE (fixed fields before IEs
4198                  * are not included).
4199                  */
4200                 const u8 *beacon_ies;
4201
4202                 /**
4203                  * beacon_ies_len - Length of beacon_ies */
4204                 size_t beacon_ies_len;
4205
4206                 /**
4207                  * freq - Frequency of the operational channel in MHz
4208                  */
4209                 unsigned int freq;
4210
4211                 /**
4212                  * wmm_params - WMM parameters used in this association.
4213                  */
4214                 struct wmm_params wmm_params;
4215
4216                 /**
4217                  * addr - Station address (for AP mode)
4218                  */
4219                 const u8 *addr;
4220
4221                 /**
4222                  * The following is the key management offload information
4223                  * @authorized
4224                  * @key_replay_ctr
4225                  * @key_replay_ctr_len
4226                  * @ptk_kck
4227                  * @ptk_kek_len
4228                  * @ptk_kek
4229                  * @ptk_kek_len
4230                  */
4231
4232                 /**
4233                  * authorized - Status of key management offload,
4234                  * 1 = successful
4235                  */
4236                 int authorized;
4237
4238                 /**
4239                  * key_replay_ctr - Key replay counter value last used
4240                  * in a valid EAPOL-Key frame
4241                  */
4242                 const u8 *key_replay_ctr;
4243
4244                 /**
4245                  * key_replay_ctr_len - The length of key_replay_ctr
4246                  */
4247                 size_t key_replay_ctr_len;
4248
4249                 /**
4250                  * ptk_kck - The derived PTK KCK
4251                  */
4252                 const u8 *ptk_kck;
4253
4254                 /**
4255                  * ptk_kek_len - The length of ptk_kck
4256                  */
4257                 size_t ptk_kck_len;
4258
4259                 /**
4260                  * ptk_kek - The derived PTK KEK
4261                  */
4262                 const u8 *ptk_kek;
4263
4264                 /**
4265                  * ptk_kek_len - The length of ptk_kek
4266                  */
4267                 size_t ptk_kek_len;
4268
4269                 /**
4270                  * subnet_status - The subnet status:
4271                  * 0 = unknown, 1 = unchanged, 2 = changed
4272                  */
4273                 u8 subnet_status;
4274         } assoc_info;
4275
4276         /**
4277          * struct disassoc_info - Data for EVENT_DISASSOC events
4278          */
4279         struct disassoc_info {
4280                 /**
4281                  * addr - Station address (for AP mode)
4282                  */
4283                 const u8 *addr;
4284
4285                 /**
4286                  * reason_code - Reason Code (host byte order) used in
4287                  *      Deauthentication frame
4288                  */
4289                 u16 reason_code;
4290
4291                 /**
4292                  * ie - Optional IE(s) in Disassociation frame
4293                  */
4294                 const u8 *ie;
4295
4296                 /**
4297                  * ie_len - Length of ie buffer in octets
4298                  */
4299                 size_t ie_len;
4300
4301                 /**
4302                  * locally_generated - Whether the frame was locally generated
4303                  */
4304                 int locally_generated;
4305         } disassoc_info;
4306
4307         /**
4308          * struct deauth_info - Data for EVENT_DEAUTH events
4309          */
4310         struct deauth_info {
4311                 /**
4312                  * addr - Station address (for AP mode)
4313                  */
4314                 const u8 *addr;
4315
4316                 /**
4317                  * reason_code - Reason Code (host byte order) used in
4318                  *      Deauthentication frame
4319                  */
4320                 u16 reason_code;
4321
4322                 /**
4323                  * ie - Optional IE(s) in Deauthentication frame
4324                  */
4325                 const u8 *ie;
4326
4327                 /**
4328                  * ie_len - Length of ie buffer in octets
4329                  */
4330                 size_t ie_len;
4331
4332                 /**
4333                  * locally_generated - Whether the frame was locally generated
4334                  */
4335                 int locally_generated;
4336         } deauth_info;
4337
4338         /**
4339          * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4340          */
4341         struct michael_mic_failure {
4342                 int unicast;
4343                 const u8 *src;
4344         } michael_mic_failure;
4345
4346         /**
4347          * struct interface_status - Data for EVENT_INTERFACE_STATUS
4348          */
4349         struct interface_status {
4350                 unsigned int ifindex;
4351                 char ifname[100];
4352                 enum {
4353                         EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4354                 } ievent;
4355         } interface_status;
4356
4357         /**
4358          * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4359          */
4360         struct pmkid_candidate {
4361                 /** BSSID of the PMKID candidate */
4362                 u8 bssid[ETH_ALEN];
4363                 /** Smaller the index, higher the priority */
4364                 int index;
4365                 /** Whether RSN IE includes pre-authenticate flag */
4366                 int preauth;
4367         } pmkid_candidate;
4368
4369         /**
4370          * struct stkstart - Data for EVENT_STKSTART
4371          */
4372         struct stkstart {
4373                 u8 peer[ETH_ALEN];
4374         } stkstart;
4375
4376         /**
4377          * struct tdls - Data for EVENT_TDLS
4378          */
4379         struct tdls {
4380                 u8 peer[ETH_ALEN];
4381                 enum {
4382                         TDLS_REQUEST_SETUP,
4383                         TDLS_REQUEST_TEARDOWN,
4384                         TDLS_REQUEST_DISCOVER,
4385                 } oper;
4386                 u16 reason_code; /* for teardown */
4387         } tdls;
4388
4389         /**
4390          * struct wnm - Data for EVENT_WNM
4391          */
4392         struct wnm {
4393                 u8 addr[ETH_ALEN];
4394                 enum {
4395                         WNM_OPER_SLEEP,
4396                 } oper;
4397                 enum {
4398                         WNM_SLEEP_ENTER,
4399                         WNM_SLEEP_EXIT
4400                 } sleep_action;
4401                 int sleep_intval;
4402                 u16 reason_code;
4403                 u8 *buf;
4404                 u16 buf_len;
4405         } wnm;
4406
4407         /**
4408          * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4409          *
4410          * During FT (IEEE 802.11r) authentication sequence, the driver is
4411          * expected to use this event to report received FT IEs (MDIE, FTIE,
4412          * RSN IE, TIE, possible resource request) to the supplicant. The FT
4413          * IEs for the next message will be delivered through the
4414          * struct wpa_driver_ops::update_ft_ies() callback.
4415          */
4416         struct ft_ies {
4417                 const u8 *ies;
4418                 size_t ies_len;
4419                 int ft_action;
4420                 u8 target_ap[ETH_ALEN];
4421                 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4422                 const u8 *ric_ies;
4423                 /** Length of ric_ies buffer in octets */
4424                 size_t ric_ies_len;
4425         } ft_ies;
4426
4427         /**
4428          * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4429          */
4430         struct ibss_rsn_start {
4431                 u8 peer[ETH_ALEN];
4432         } ibss_rsn_start;
4433
4434         /**
4435          * struct auth_info - Data for EVENT_AUTH events
4436          */
4437         struct auth_info {
4438                 u8 peer[ETH_ALEN];
4439                 u8 bssid[ETH_ALEN];
4440                 u16 auth_type;
4441                 u16 auth_transaction;
4442                 u16 status_code;
4443                 const u8 *ies;
4444                 size_t ies_len;
4445         } auth;
4446
4447         /**
4448          * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4449          */
4450         struct assoc_reject {
4451                 /**
4452                  * bssid - BSSID of the AP that rejected association
4453                  */
4454                 const u8 *bssid;
4455
4456                 /**
4457                  * resp_ies - (Re)Association Response IEs
4458                  *
4459                  * Optional association data from the driver. This data is not
4460                  * required WPA, but may be useful for some protocols and as
4461                  * such, should be reported if this is available to the driver
4462                  * interface.
4463                  *
4464                  * This should start with the first IE (fixed fields before IEs
4465                  * are not included).
4466                  */
4467                 const u8 *resp_ies;
4468
4469                 /**
4470                  * resp_ies_len - Length of resp_ies in bytes
4471                  */
4472                 size_t resp_ies_len;
4473
4474                 /**
4475                  * status_code - Status Code from (Re)association Response
4476                  */
4477                 u16 status_code;
4478
4479                 /**
4480                  * timed_out - Whether failure is due to timeout (etc.) rather
4481                  * than explicit rejection response from the AP.
4482                  */
4483                 int timed_out;
4484         } assoc_reject;
4485
4486         struct timeout_event {
4487                 u8 addr[ETH_ALEN];
4488         } timeout_event;
4489
4490         /**
4491          * struct tx_status - Data for EVENT_TX_STATUS events
4492          */
4493         struct tx_status {
4494                 u16 type;
4495                 u16 stype;
4496                 const u8 *dst;
4497                 const u8 *data;
4498                 size_t data_len;
4499                 int ack;
4500         } tx_status;
4501
4502         /**
4503          * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4504          */
4505         struct rx_from_unknown {
4506                 const u8 *bssid;
4507                 const u8 *addr;
4508                 int wds;
4509         } rx_from_unknown;
4510
4511         /**
4512          * struct rx_mgmt - Data for EVENT_RX_MGMT events
4513          */
4514         struct rx_mgmt {
4515                 const u8 *frame;
4516                 size_t frame_len;
4517                 u32 datarate;
4518
4519                 /**
4520                  * drv_priv - Pointer to store driver private BSS information
4521                  *
4522                  * If not set to NULL, this is used for comparison with
4523                  * hostapd_data->drv_priv to determine which BSS should process
4524                  * the frame.
4525                  */
4526                 void *drv_priv;
4527
4528                 /**
4529                  * freq - Frequency (in MHz) on which the frame was received
4530                  */
4531                 int freq;
4532
4533                 /**
4534                  * ssi_signal - Signal strength in dBm (or 0 if not available)
4535                  */
4536                 int ssi_signal;
4537         } rx_mgmt;
4538
4539         /**
4540          * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4541          *
4542          * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4543          */
4544         struct remain_on_channel {
4545                 /**
4546                  * freq - Channel frequency in MHz
4547                  */
4548                 unsigned int freq;
4549
4550                 /**
4551                  * duration - Duration to remain on the channel in milliseconds
4552                  */
4553                 unsigned int duration;
4554         } remain_on_channel;
4555
4556         /**
4557          * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4558          * @aborted: Whether the scan was aborted
4559          * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4560          * @num_freqs: Number of entries in freqs array
4561          * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4562          *      SSID)
4563          * @num_ssids: Number of entries in ssids array
4564          * @external_scan: Whether the scan info is for an external scan
4565          * @nl_scan_event: 1 if the source of this scan event is a normal scan,
4566          *      0 if the source of the scan event is a vendor scan
4567          */
4568         struct scan_info {
4569                 int aborted;
4570                 const int *freqs;
4571                 size_t num_freqs;
4572                 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4573                 size_t num_ssids;
4574                 int external_scan;
4575                 int nl_scan_event;
4576         } scan_info;
4577
4578         /**
4579          * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4580          */
4581         struct rx_probe_req {
4582                 /**
4583                  * sa - Source address of the received Probe Request frame
4584                  */
4585                 const u8 *sa;
4586
4587                 /**
4588                  * da - Destination address of the received Probe Request frame
4589                  *      or %NULL if not available
4590                  */
4591                 const u8 *da;
4592
4593                 /**
4594                  * bssid - BSSID of the received Probe Request frame or %NULL
4595                  *      if not available
4596                  */
4597                 const u8 *bssid;
4598
4599                 /**
4600                  * ie - IEs from the Probe Request body
4601                  */
4602                 const u8 *ie;
4603
4604                 /**
4605                  * ie_len - Length of ie buffer in octets
4606                  */
4607                 size_t ie_len;
4608
4609                 /**
4610                  * signal - signal strength in dBm (or 0 if not available)
4611                  */
4612                 int ssi_signal;
4613         } rx_probe_req;
4614
4615         /**
4616          * struct new_sta - Data for EVENT_NEW_STA events
4617          */
4618         struct new_sta {
4619                 const u8 *addr;
4620         } new_sta;
4621
4622         /**
4623          * struct eapol_rx - Data for EVENT_EAPOL_RX events
4624          */
4625         struct eapol_rx {
4626                 const u8 *src;
4627                 const u8 *data;
4628                 size_t data_len;
4629         } eapol_rx;
4630
4631         /**
4632          * signal_change - Data for EVENT_SIGNAL_CHANGE events
4633          */
4634         struct wpa_signal_info signal_change;
4635
4636         /**
4637          * struct best_channel - Data for EVENT_BEST_CHANNEL events
4638          * @freq_24: Best 2.4 GHz band channel frequency in MHz
4639          * @freq_5: Best 5 GHz band channel frequency in MHz
4640          * @freq_overall: Best channel frequency in MHz
4641          *
4642          * 0 can be used to indicate no preference in either band.
4643          */
4644         struct best_channel {
4645                 int freq_24;
4646                 int freq_5;
4647                 int freq_overall;
4648         } best_chan;
4649
4650         struct unprot_deauth {
4651                 const u8 *sa;
4652                 const u8 *da;
4653                 u16 reason_code;
4654         } unprot_deauth;
4655
4656         struct unprot_disassoc {
4657                 const u8 *sa;
4658                 const u8 *da;
4659                 u16 reason_code;
4660         } unprot_disassoc;
4661
4662         /**
4663          * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4664          * @addr: station address
4665          */
4666         struct low_ack {
4667                 u8 addr[ETH_ALEN];
4668         } low_ack;
4669
4670         /**
4671          * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4672          */
4673         struct ibss_peer_lost {
4674                 u8 peer[ETH_ALEN];
4675         } ibss_peer_lost;
4676
4677         /**
4678          * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4679          */
4680         struct driver_gtk_rekey {
4681                 const u8 *bssid;
4682                 const u8 *replay_ctr;
4683         } driver_gtk_rekey;
4684
4685         /**
4686          * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4687          * @addr: station address
4688          */
4689         struct client_poll {
4690                 u8 addr[ETH_ALEN];
4691         } client_poll;
4692
4693         /**
4694          * struct eapol_tx_status
4695          * @dst: Original destination
4696          * @data: Data starting with IEEE 802.1X header (!)
4697          * @data_len: Length of data
4698          * @ack: Indicates ack or lost frame
4699          *
4700          * This corresponds to hapd_send_eapol if the frame sent
4701          * there isn't just reported as EVENT_TX_STATUS.
4702          */
4703         struct eapol_tx_status {
4704                 const u8 *dst;
4705                 const u8 *data;
4706                 int data_len;
4707                 int ack;
4708         } eapol_tx_status;
4709
4710         /**
4711          * struct ch_switch
4712          * @freq: Frequency of new channel in MHz
4713          * @ht_enabled: Whether this is an HT channel
4714          * @ch_offset: Secondary channel offset
4715          * @ch_width: Channel width
4716          * @cf1: Center frequency 1
4717          * @cf2: Center frequency 2
4718          */
4719         struct ch_switch {
4720                 int freq;
4721                 int ht_enabled;
4722                 int ch_offset;
4723                 enum chan_width ch_width;
4724                 int cf1;
4725                 int cf2;
4726         } ch_switch;
4727
4728         /**
4729          * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4730          * @addr: Remote client address
4731          * @code: Reason code for connection failure
4732          */
4733         struct connect_failed_reason {
4734                 u8 addr[ETH_ALEN];
4735                 enum {
4736                         MAX_CLIENT_REACHED,
4737                         BLOCKED_CLIENT
4738                 } code;
4739         } connect_failed_reason;
4740
4741         /**
4742          * struct dfs_event - Data for radar detected events
4743          * @freq: Frequency of the channel in MHz
4744          */
4745         struct dfs_event {
4746                 int freq;
4747                 int ht_enabled;
4748                 int chan_offset;
4749                 enum chan_width chan_width;
4750                 int cf1;
4751                 int cf2;
4752         } dfs_event;
4753
4754         /**
4755          * survey_results - Survey result data for EVENT_SURVEY
4756          * @freq_filter: Requested frequency survey filter, 0 if request
4757          *      was for all survey data
4758          * @survey_list: Linked list of survey data (struct freq_survey)
4759          */
4760         struct survey_results {
4761                 unsigned int freq_filter;
4762                 struct dl_list survey_list; /* struct freq_survey */
4763         } survey_results;
4764
4765         /**
4766          * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4767          * @initiator: Initiator of the regulatory change
4768          * @type: Regulatory change type
4769          * @alpha2: Country code (or "" if not available)
4770          */
4771         struct channel_list_changed {
4772                 enum reg_change_initiator initiator;
4773                 enum reg_type type;
4774                 char alpha2[3];
4775         } channel_list_changed;
4776
4777         /**
4778          * freq_range - List of frequency ranges
4779          *
4780          * This is used as the data with EVENT_AVOID_FREQUENCIES.
4781          */
4782         struct wpa_freq_range_list freq_range;
4783
4784         /**
4785          * struct mesh_peer
4786          *
4787          * @peer: Peer address
4788          * @ies: Beacon IEs
4789          * @ie_len: Length of @ies
4790          *
4791          * Notification of new candidate mesh peer.
4792          */
4793         struct mesh_peer {
4794                 const u8 *peer;
4795                 const u8 *ies;
4796                 size_t ie_len;
4797         } mesh_peer;
4798
4799         /**
4800          * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4801          * @pri_channel: Selected primary channel
4802          * @sec_channel: Selected secondary channel
4803          * @vht_seg0_center_ch: VHT mode Segment0 center channel
4804          * @vht_seg1_center_ch: VHT mode Segment1 center channel
4805          * @ch_width: Selected Channel width by driver. Driver may choose to
4806          *      change hostapd configured ACS channel width due driver internal
4807          *      channel restrictions.
4808          * hw_mode: Selected band (used with hw_mode=any)
4809          */
4810         struct acs_selected_channels {
4811                 u8 pri_channel;
4812                 u8 sec_channel;
4813                 u8 vht_seg0_center_ch;
4814                 u8 vht_seg1_center_ch;
4815                 u16 ch_width;
4816                 enum hostapd_hw_mode hw_mode;
4817         } acs_selected_channels;
4818
4819         /**
4820          * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
4821          * @reason_code: Reason for stopping offload
4822          *      P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
4823          *      scheduled.
4824          *      P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
4825          *      be stopped.
4826          *      P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
4827          *      parameters.
4828          *      P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
4829          *      supported by device.
4830          */
4831         struct p2p_lo_stop {
4832                 enum {
4833                         P2P_LO_STOPPED_REASON_COMPLETE = 0,
4834                         P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
4835                         P2P_LO_STOPPED_REASON_INVALID_PARAM,
4836                         P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
4837                 } reason_code;
4838         } p2p_lo_stop;
4839 };
4840
4841 /**
4842  * wpa_supplicant_event - Report a driver event for wpa_supplicant
4843  * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4844  *      with struct wpa_driver_ops::init()
4845  * @event: event type (defined above)
4846  * @data: possible extra data for the event
4847  *
4848  * Driver wrapper code should call this function whenever an event is received
4849  * from the driver.
4850  */
4851 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4852                           union wpa_event_data *data);
4853
4854 /**
4855  * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
4856  * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4857  *      with struct wpa_driver_ops::init()
4858  * @event: event type (defined above)
4859  * @data: possible extra data for the event
4860  *
4861  * Same as wpa_supplicant_event(), but we search for the interface in
4862  * wpa_global.
4863  */
4864 void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
4865                                  union wpa_event_data *data);
4866
4867 /*
4868  * The following inline functions are provided for convenience to simplify
4869  * event indication for some of the common events.
4870  */
4871
4872 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4873                                    size_t ielen, int reassoc)
4874 {
4875         union wpa_event_data event;
4876         os_memset(&event, 0, sizeof(event));
4877         event.assoc_info.reassoc = reassoc;
4878         event.assoc_info.req_ies = ie;
4879         event.assoc_info.req_ies_len = ielen;
4880         event.assoc_info.addr = addr;
4881         wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4882 }
4883
4884 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4885 {
4886         union wpa_event_data event;
4887         os_memset(&event, 0, sizeof(event));
4888         event.disassoc_info.addr = addr;
4889         wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4890 }
4891
4892 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4893                                       size_t data_len)
4894 {
4895         union wpa_event_data event;
4896         os_memset(&event, 0, sizeof(event));
4897         event.eapol_rx.src = src;
4898         event.eapol_rx.data = data;
4899         event.eapol_rx.data_len = data_len;
4900         wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4901 }
4902
4903 /* driver_common.c */
4904 void wpa_scan_results_free(struct wpa_scan_results *res);
4905
4906 /* Convert wpa_event_type to a string for logging */
4907 const char * event_to_string(enum wpa_event_type event);
4908
4909 /* Convert chan_width to a string for logging and control interfaces */
4910 const char * channel_width_to_string(enum chan_width width);
4911
4912 int ht_supported(const struct hostapd_hw_modes *mode);
4913 int vht_supported(const struct hostapd_hw_modes *mode);
4914
4915 struct wowlan_triggers *
4916 wpa_get_wowlan_triggers(const char *wowlan_triggers,
4917                         const struct wpa_driver_capa *capa);
4918
4919 /* NULL terminated array of linked in driver wrappers */
4920 extern const struct wpa_driver_ops *const wpa_drivers[];
4921
4922
4923 /* Available drivers */
4924
4925 #ifdef CONFIG_DRIVER_WEXT
4926 extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
4927 #endif /* CONFIG_DRIVER_WEXT */
4928 #ifdef CONFIG_DRIVER_NL80211
4929 /* driver_nl80211.c */
4930 extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
4931 #endif /* CONFIG_DRIVER_NL80211 */
4932 #ifdef CONFIG_DRIVER_HOSTAP
4933 extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
4934 #endif /* CONFIG_DRIVER_HOSTAP */
4935 #ifdef CONFIG_DRIVER_BSD
4936 extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
4937 #endif /* CONFIG_DRIVER_BSD */
4938 #ifdef CONFIG_DRIVER_OPENBSD
4939 /* driver_openbsd.c */
4940 extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
4941 #endif /* CONFIG_DRIVER_OPENBSD */
4942 #ifdef CONFIG_DRIVER_NDIS
4943 extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
4944 #endif /* CONFIG_DRIVER_NDIS */
4945 #ifdef CONFIG_DRIVER_WIRED
4946 extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
4947 #endif /* CONFIG_DRIVER_WIRED */
4948 #ifdef CONFIG_DRIVER_MACSEC_QCA
4949 /* driver_macsec_qca.c */
4950 extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
4951 #endif /* CONFIG_DRIVER_MACSEC_QCA */
4952 #ifdef CONFIG_DRIVER_ROBOSWITCH
4953 /* driver_roboswitch.c */
4954 extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
4955 #endif /* CONFIG_DRIVER_ROBOSWITCH */
4956 #ifdef CONFIG_DRIVER_ATHEROS
4957 /* driver_atheros.c */
4958 extern const struct wpa_driver_ops wpa_driver_atheros_ops;
4959 #endif /* CONFIG_DRIVER_ATHEROS */
4960 #ifdef CONFIG_DRIVER_NONE
4961 extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
4962 #endif /* CONFIG_DRIVER_NONE */
4963
4964 #endif /* DRIVER_H */