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