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