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