2 * Driver interface definition
3 * Copyright (c) 2003-2015, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
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.
20 #define WPA_SUPPLICANT_DRIVER_VERSION 4
22 #include "common/defs.h"
23 #include "common/ieee802_11_defs.h"
24 #include "utils/list.h"
26 #define HOSTAPD_CHAN_DISABLED 0x00000001
27 #define HOSTAPD_CHAN_NO_IR 0x00000002
28 #define HOSTAPD_CHAN_RADAR 0x00000008
29 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
30 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
31 #define HOSTAPD_CHAN_HT40 0x00000040
32 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
34 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
35 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
36 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
37 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
38 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
40 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
41 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
42 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
43 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
45 #define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
46 #define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
48 #define HOSTAPD_CHAN_VHT_10_150 0x00100000
49 #define HOSTAPD_CHAN_VHT_30_130 0x00200000
50 #define HOSTAPD_CHAN_VHT_50_110 0x00400000
51 #define HOSTAPD_CHAN_VHT_70_90 0x00800000
52 #define HOSTAPD_CHAN_VHT_90_70 0x01000000
53 #define HOSTAPD_CHAN_VHT_110_50 0x02000000
54 #define HOSTAPD_CHAN_VHT_130_30 0x04000000
55 #define HOSTAPD_CHAN_VHT_150_10 0x08000000
57 /* Filter gratuitous ARP */
58 #define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
59 /* Filter unsolicited Neighbor Advertisement */
60 #define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
61 /* Filter unicast IP packets encrypted using the GTK */
62 #define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)
65 * enum reg_change_initiator - Regulatory change initiator
67 enum reg_change_initiator {
71 REGDOM_SET_BY_COUNTRY_IE,
76 * enum reg_type - Regulatory change types
82 REGDOM_TYPE_CUSTOM_WORLD,
83 REGDOM_TYPE_INTERSECTION,
87 * struct hostapd_channel_data - Channel information
89 struct hostapd_channel_data {
91 * chan - Channel number (IEEE 802.11)
96 * freq - Frequency in MHz
101 * flag - Channel flags (HOSTAPD_CHAN_*)
106 * max_tx_power - Regulatory transmit power limit in dBm
111 * survey_list - Linked list of surveys (struct freq_survey)
113 struct dl_list survey_list;
116 * min_nf - Minimum observed noise floor, in dBm, based on all
117 * surveyed channel data
123 * interference_factor - Computed interference factor on this
124 * channel (used internally in src/ap/acs.c; driver wrappers do not
127 long double interference_factor;
128 #endif /* CONFIG_ACS */
131 * dfs_cac_ms - DFS CAC time in milliseconds
133 unsigned int dfs_cac_ms;
136 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
137 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
140 * struct hostapd_hw_modes - Supported hardware mode information
142 struct hostapd_hw_modes {
144 * mode - Hardware mode
146 enum hostapd_hw_mode mode;
149 * num_channels - Number of entries in the channels array
154 * channels - Array of supported channels
156 struct hostapd_channel_data *channels;
159 * num_rates - Number of entries in the rates array
164 * rates - Array of supported rates in 100 kbps units
169 * ht_capab - HT (IEEE 802.11n) capabilities
174 * mcs_set - MCS (IEEE 802.11n) rate parameters
179 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
184 * vht_capab - VHT (IEEE 802.11ac) capabilities
189 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
193 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
197 #define IEEE80211_MODE_INFRA 0
198 #define IEEE80211_MODE_IBSS 1
199 #define IEEE80211_MODE_AP 2
200 #define IEEE80211_MODE_MESH 5
202 #define IEEE80211_CAP_ESS 0x0001
203 #define IEEE80211_CAP_IBSS 0x0002
204 #define IEEE80211_CAP_PRIVACY 0x0010
205 #define IEEE80211_CAP_RRM 0x1000
207 /* DMG (60 GHz) IEEE 802.11ad */
208 /* type - bits 0..1 */
209 #define IEEE80211_CAP_DMG_MASK 0x0003
210 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
211 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
212 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
214 #define WPA_SCAN_QUAL_INVALID BIT(0)
215 #define WPA_SCAN_NOISE_INVALID BIT(1)
216 #define WPA_SCAN_LEVEL_INVALID BIT(2)
217 #define WPA_SCAN_LEVEL_DBM BIT(3)
218 #define WPA_SCAN_ASSOCIATED BIT(5)
221 * struct wpa_scan_res - Scan result for an BSS/IBSS
222 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
224 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
225 * @beacon_int: beacon interval in TUs (host byte order)
226 * @caps: capability information field in host byte order
227 * @qual: signal quality
228 * @noise: noise level
229 * @level: signal level
231 * @age: Age of the information in milliseconds (i.e., how many milliseconds
232 * ago the last Beacon or Probe Response frame was received)
233 * @est_throughput: Estimated throughput in kbps (this is calculated during
234 * scan result processing if left zero by the driver wrapper)
235 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
236 * @ie_len: length of the following IE field in octets
237 * @beacon_ie_len: length of the following Beacon IE field in octets
239 * This structure is used as a generic format for scan results from the
240 * driver. Each driver interface implementation is responsible for converting
241 * the driver or OS specific scan results into this format.
243 * If the driver does not support reporting all IEs, the IE data structure is
244 * constructed of the IEs that are available. This field will also need to
245 * include SSID in IE format. All drivers are encouraged to be extended to
246 * report all IEs to make it easier to support future additions.
248 * This structure data is followed by ie_len octets of IEs from Probe Response
249 * frame (or if the driver does not indicate source of IEs, these may also be
250 * from Beacon frame). After the first set of IEs, another set of IEs may follow
251 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
253 struct wpa_scan_res {
264 unsigned int est_throughput;
267 size_t beacon_ie_len;
268 /* Followed by ie_len + beacon_ie_len octets of IE data */
272 * struct wpa_scan_results - Scan results
273 * @res: Array of pointers to allocated variable length scan result entries
274 * @num: Number of entries in the scan result array
275 * @fetch_time: Time when the results were fetched from the driver
277 struct wpa_scan_results {
278 struct wpa_scan_res **res;
280 struct os_reltime fetch_time;
284 * struct wpa_interface_info - Network interface information
285 * @next: Pointer to the next interface or NULL if this is the last one
286 * @ifname: Interface name that can be used with init() or init2()
287 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
289 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
290 * is not an allocated copy, i.e., get_interfaces() caller will not free
293 struct wpa_interface_info {
294 struct wpa_interface_info *next;
297 const char *drv_name;
300 #define WPAS_MAX_SCAN_SSIDS 16
303 * struct wpa_driver_scan_ssid - SSIDs to scan for
304 * @ssid - specific SSID to scan for (ProbeReq)
305 * %NULL or zero-length SSID is used to indicate active scan
306 * with wildcard SSID.
307 * @ssid_len - Length of the SSID in octets
309 struct wpa_driver_scan_ssid {
315 * struct wpa_driver_scan_params - Scan parameters
316 * Data for struct wpa_driver_ops::scan2().
318 struct wpa_driver_scan_params {
320 * ssids - SSIDs to scan for
322 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
325 * num_ssids - Number of entries in ssids array
326 * Zero indicates a request for a passive scan.
331 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
336 * extra_ies_len - Length of extra_ies in octets
338 size_t extra_ies_len;
341 * freqs - Array of frequencies to scan or %NULL for all frequencies
343 * The frequency is set in MHz. The array is zero-terminated.
348 * filter_ssids - Filter for reporting SSIDs
350 * This optional parameter can be used to request the driver wrapper to
351 * filter scan results to include only the specified SSIDs. %NULL
352 * indicates that no filtering is to be done. This can be used to
353 * reduce memory needs for scan results in environments that have large
354 * number of APs with different SSIDs.
356 * The driver wrapper is allowed to take this allocated buffer into its
357 * own use by setting the pointer to %NULL. In that case, the driver
358 * wrapper is responsible for freeing the buffer with os_free() once it
359 * is not needed anymore.
361 struct wpa_driver_scan_filter {
362 u8 ssid[SSID_MAX_LEN];
367 * num_filter_ssids - Number of entries in filter_ssids array
369 size_t num_filter_ssids;
372 * filter_rssi - Filter by RSSI
374 * The driver may filter scan results in firmware to reduce host
375 * wakeups and thereby save power. Specify the RSSI threshold in s32
381 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
383 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
384 * Mbps from the support rates element(s) in the Probe Request frames
385 * and not to transmit the frames at any of those rates.
387 unsigned int p2p_probe:1;
390 * only_new_results - Request driver to report only new results
392 * This is used to request the driver to report only BSSes that have
393 * been detected after this scan request has been started, i.e., to
394 * flush old cached BSS entries.
396 unsigned int only_new_results:1;
399 * low_priority - Requests driver to use a lower scan priority
401 * This is used to request the driver to use a lower scan priority
402 * if it supports such a thing.
404 unsigned int low_priority:1;
407 * mac_addr_rand - Requests driver to randomize MAC address
409 unsigned int mac_addr_rand:1;
412 * mac_addr - MAC address used with randomization. The address cannot be
413 * a multicast one, i.e., bit 0 of byte 0 should not be set.
418 * mac_addr_mask - MAC address mask used with randomization.
420 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
421 * the mask should be taken as is from mac_addr. The mask should not
422 * allow the generation of a multicast address, i.e., bit 0 of byte 0
425 const u8 *mac_addr_mask;
428 * sched_scan_plans - Scan plans for scheduled scan
430 * Each scan plan consists of the number of iterations to scan and the
431 * interval between scans. When a scan plan finishes (i.e., it was run
432 * for the specified number of iterations), the next scan plan is
433 * executed. The scan plans are executed in the order they appear in
434 * the array (lower index first). The last scan plan will run infinitely
435 * (until requested to stop), thus must not specify the number of
436 * iterations. All other scan plans must specify the number of
439 struct sched_scan_plan {
440 u32 interval; /* In seconds */
441 u32 iterations; /* Zero to run infinitely */
445 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
447 unsigned int sched_scan_plans_num;
450 * bssid - Specific BSSID to scan for
452 * This optional parameter can be used to replace the default wildcard
453 * BSSID with a specific BSSID to scan for if results are needed from
459 * NOTE: Whenever adding new parameters here, please make sure
460 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
466 * struct wpa_driver_auth_params - Authentication parameters
467 * Data for struct wpa_driver_ops::authenticate().
469 struct wpa_driver_auth_params {
477 const u8 *wep_key[4];
478 size_t wep_key_len[4];
480 int local_state_change;
483 * p2p - Whether this connection is a P2P group
488 * sae_data - SAE elements for Authentication frame
490 * This buffer starts with the Authentication transaction sequence
491 * number field. If SAE is not used, this pointer is %NULL.
496 * sae_data_len - Length of sae_data buffer in octets
502 * enum wps_mode - WPS mode
506 * WPS_MODE_NONE - No WPS provisioning being used
511 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
516 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
522 * struct hostapd_freq_params - Channel parameters
524 struct hostapd_freq_params {
526 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
528 enum hostapd_hw_mode mode;
531 * freq - Primary channel center frequency in MHz
536 * channel - Channel number
541 * ht_enabled - Whether HT is enabled
546 * sec_channel_offset - Secondary channel offset for HT40
549 * -1 = HT40 enabled, secondary channel below primary,
550 * 1 = HT40 enabled, secondary channel above primary
552 int sec_channel_offset;
555 * vht_enabled - Whether VHT is enabled
560 * center_freq1 - Segment 0 center frequency in MHz
562 * Valid for both HT and VHT.
567 * center_freq2 - Segment 1 center frequency in MHz
569 * Non-zero only for bandwidth 80 and an 80+80 channel
574 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
580 * struct wpa_driver_associate_params - Association parameters
581 * Data for struct wpa_driver_ops::associate().
583 struct wpa_driver_associate_params {
585 * bssid - BSSID of the selected AP
586 * This can be %NULL, if ap_scan=2 mode is used and the driver is
587 * responsible for selecting with which BSS to associate. */
591 * bssid_hint - BSSID of a proposed AP
593 * This indicates which BSS has been found a suitable candidate for
594 * initial association for drivers that use driver/firmwate-based BSS
595 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
596 * the driver from selecting other BSSes in the ESS.
598 const u8 *bssid_hint;
601 * ssid - The selected SSID
606 * ssid_len - Length of the SSID (1..32)
611 * freq - channel parameters
613 struct hostapd_freq_params freq;
616 * freq_hint - Frequency of the channel the proposed AP is using
618 * This provides a channel on which a suitable BSS has been found as a
619 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
620 * limit the driver from selecting other channels for
621 * driver/firmware-based BSS selection.
626 * bg_scan_period - Background scan period in seconds, 0 to disable
627 * background scan, or -1 to indicate no change to default driver
633 * beacon_int - Beacon interval for IBSS or 0 to use driver default
638 * wpa_ie - WPA information element for (Re)Association Request
639 * WPA information element to be included in (Re)Association
640 * Request (including information element id and length). Use
641 * of this WPA IE is optional. If the driver generates the WPA
642 * IE, it can use pairwise_suite, group_suite, and
643 * key_mgmt_suite to select proper algorithms. In this case,
644 * the driver has to notify wpa_supplicant about the used WPA
645 * IE by generating an event that the interface code will
646 * convert into EVENT_ASSOCINFO data (see below).
648 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
649 * instead. The driver can determine which version is used by
650 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
653 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
658 * wpa_ie_len - length of the wpa_ie
663 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
665 unsigned int wpa_proto;
668 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
670 * This is usually ignored if @wpa_ie is used.
672 unsigned int pairwise_suite;
675 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
677 * This is usually ignored if @wpa_ie is used.
679 unsigned int group_suite;
682 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
684 * This is usually ignored if @wpa_ie is used.
686 unsigned int key_mgmt_suite;
689 * auth_alg - Allowed authentication algorithms
690 * Bit field of WPA_AUTH_ALG_*
695 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
700 * wep_key - WEP keys for static WEP configuration
702 const u8 *wep_key[4];
705 * wep_key_len - WEP key length for static WEP configuration
707 size_t wep_key_len[4];
710 * wep_tx_keyidx - WEP TX key index for static WEP configuration
715 * mgmt_frame_protection - IEEE 802.11w management frame protection
717 enum mfp_options mgmt_frame_protection;
720 * ft_ies - IEEE 802.11r / FT information elements
721 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
722 * for fast transition, this parameter is set to include the IEs that
723 * are to be sent in the next FT Authentication Request message.
724 * update_ft_ies() handler is called to update the IEs for further
725 * FT messages in the sequence.
727 * The driver should use these IEs only if the target AP is advertising
728 * the same mobility domain as the one included in the MDIE here.
730 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
731 * AP after the initial association. These IEs can only be used if the
732 * target AP is advertising support for FT and is using the same MDIE
733 * and SSID as the current AP.
735 * The driver is responsible for reporting the FT IEs received from the
736 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
737 * type. update_ft_ies() handler will then be called with the FT IEs to
738 * include in the next frame in the authentication sequence.
743 * ft_ies_len - Length of ft_ies in bytes
748 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
750 * This value is provided to allow the driver interface easier access
751 * to the current mobility domain. This value is set to %NULL if no
752 * mobility domain is currently active.
757 * passphrase - RSN passphrase for PSK
759 * This value is made available only for WPA/WPA2-Personal (PSK) and
760 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
761 * the 8..63 character ASCII passphrase, if available. Please note that
762 * this can be %NULL if passphrase was not used to generate the PSK. In
763 * that case, the psk field must be used to fetch the PSK.
765 const char *passphrase;
768 * psk - RSN PSK (alternative for passphrase for PSK)
770 * This value is made available only for WPA/WPA2-Personal (PSK) and
771 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
772 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
773 * be prepared to handle %NULL value as an error.
778 * drop_unencrypted - Enable/disable unencrypted frame filtering
780 * Configure the driver to drop all non-EAPOL frames (both receive and
781 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
782 * still be allowed for key negotiation.
784 int drop_unencrypted;
787 * prev_bssid - Previously used BSSID in this ESS
789 * When not %NULL, this is a request to use reassociation instead of
792 const u8 *prev_bssid;
797 * If the driver needs to do special configuration for WPS association,
798 * this variable provides more information on what type of association
799 * is being requested. Most drivers should not need ot use this.
804 * p2p - Whether this connection is a P2P group
809 * uapsd - UAPSD parameters for the network
810 * -1 = do not change defaults
811 * AP mode: 1 = enabled, 0 = disabled
812 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
817 * fixed_bssid - Whether to force this BSSID in IBSS mode
818 * 1 = Fix this BSSID and prevent merges.
819 * 0 = Do not fix BSSID.
824 * fixed_freq - Fix control channel in IBSS mode
825 * 0 = don't fix control channel (default)
826 * 1 = fix control channel; this prevents IBSS merging with another
832 * disable_ht - Disable HT (IEEE 802.11n) for this connection
837 * htcaps - HT Capabilities over-rides
839 * Only bits set in the mask will be used, and not all values are used
840 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
842 * Pointer to struct ieee80211_ht_capabilities.
847 * htcaps_mask - HT Capabilities over-rides mask
849 * Pointer to struct ieee80211_ht_capabilities.
851 const u8 *htcaps_mask;
853 #ifdef CONFIG_VHT_OVERRIDES
855 * disable_vht - Disable VHT for this connection
860 * VHT capability overrides.
862 const struct ieee80211_vht_capabilities *vhtcaps;
863 const struct ieee80211_vht_capabilities *vhtcaps_mask;
864 #endif /* CONFIG_VHT_OVERRIDES */
867 * req_key_mgmt_offload - Request key management offload for connection
869 * Request key management offload for this connection if the device
872 int req_key_mgmt_offload;
875 * Flag for indicating whether this association includes support for
876 * RRM (Radio Resource Measurements)
881 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
882 * AP as usual. Valid for DMG network only.
889 HIDDEN_SSID_ZERO_LEN,
890 HIDDEN_SSID_ZERO_CONTENTS
893 struct wowlan_triggers {
897 u8 gtk_rekey_failure;
899 u8 four_way_handshake;
903 struct wpa_driver_ap_params {
905 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
910 * head_len - Length of the head buffer in octets
915 * tail - Beacon tail following TIM IE
920 * tail_len - Length of the tail buffer in octets
925 * dtim_period - DTIM period
930 * beacon_int - Beacon interval
935 * basic_rates: -1 terminated array of basic rates in 100 kbps
937 * This parameter can be used to set a specific basic rate set for the
938 * BSS. If %NULL, default basic rate set is used.
943 * proberesp - Probe Response template
945 * This is used by drivers that reply to Probe Requests internally in
946 * AP mode and require the full Probe Response template.
951 * proberesp_len - Length of the proberesp buffer in octets
953 size_t proberesp_len;
956 * ssid - The SSID to use in Beacon/Probe Response frames
961 * ssid_len - Length of the SSID (1..32)
966 * hide_ssid - Whether to hide the SSID
968 enum hide_ssid hide_ssid;
971 * pairwise_ciphers - WPA_CIPHER_* bitfield
973 unsigned int pairwise_ciphers;
976 * group_cipher - WPA_CIPHER_*
978 unsigned int group_cipher;
981 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
983 unsigned int key_mgmt_suites;
986 * auth_algs - WPA_AUTH_ALG_* bitfield
988 unsigned int auth_algs;
991 * wpa_version - WPA_PROTO_* bitfield
993 unsigned int wpa_version;
996 * privacy - Whether privacy is used in the BSS
1001 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1003 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1004 * not use the full Beacon template.
1006 const struct wpabuf *beacon_ies;
1009 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1011 * This is used to add IEs like WPS IE and P2P IE by drivers that
1012 * reply to Probe Request frames internally.
1014 const struct wpabuf *proberesp_ies;
1017 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1019 * This is used to add IEs like WPS IE by drivers that reply to
1020 * (Re)Association Request frames internally.
1022 const struct wpabuf *assocresp_ies;
1025 * isolate - Whether to isolate frames between associated stations
1027 * If this is non-zero, the AP is requested to disable forwarding of
1028 * frames between associated stations.
1033 * cts_protect - Whether CTS protection is enabled
1038 * preamble - Whether short preamble is enabled
1043 * short_slot_time - Whether short slot time is enabled
1045 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1046 * not set (e.g., when 802.11g mode is not in use)
1048 int short_slot_time;
1051 * ht_opmode - HT operation mode or -1 if HT not in use
1056 * interworking - Whether Interworking is enabled
1061 * hessid - Homogeneous ESS identifier or %NULL if not set
1066 * access_network_type - Access Network Type (0..15)
1068 * This is used for filtering Probe Request frames when Interworking is
1071 u8 access_network_type;
1074 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1076 * This is used by driver which advertises this capability.
1078 int ap_max_inactivity;
1081 * ctwindow - Client Traffic Window (in TUs)
1086 * smps_mode - SMPS mode
1088 * SMPS mode to be used by the AP, specified as the relevant bits of
1089 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1091 unsigned int smps_mode;
1094 * disable_dgaf - Whether group-addressed frames are disabled
1099 * osen - Whether OSEN security is enabled
1104 * freq - Channel parameters for dynamic bandwidth changes
1106 struct hostapd_freq_params *freq;
1109 * reenable - Whether this is to re-enable beaconing
1114 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1115 * infrastructure BSS. Valid only for DMG network.
1120 struct wpa_driver_mesh_bss_params {
1121 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1123 * TODO: Other mesh configuration parameters would go here.
1124 * See NL80211_MESHCONF_* for all the mesh config parameters.
1127 int peer_link_timeout;
1131 struct wpa_driver_mesh_join_params {
1134 const int *basic_rates;
1137 struct hostapd_freq_params freq;
1140 struct wpa_driver_mesh_bss_params conf;
1141 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1142 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1143 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1144 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1149 * struct wpa_driver_capa - Driver capability information
1151 struct wpa_driver_capa {
1152 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1153 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1154 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1155 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1156 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1157 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1158 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1159 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1160 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1161 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
1162 /** Bitfield of supported key management suites */
1163 unsigned int key_mgmt;
1165 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1166 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1167 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1168 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1169 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1170 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1171 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1172 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1173 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1174 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1175 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1176 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1177 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1178 /** Bitfield of supported cipher suites */
1181 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1182 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1183 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1184 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1187 /** Driver generated WPA/RSN IE */
1188 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1189 /** Driver needs static WEP key setup after association command */
1190 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1191 /** Driver takes care of all DFS operations */
1192 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1193 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1194 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1195 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1196 /** Driver is for a wired Ethernet interface */
1197 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1198 /** Driver provides separate commands for authentication and association (SME in
1199 * wpa_supplicant). */
1200 #define WPA_DRIVER_FLAGS_SME 0x00000020
1201 /** Driver supports AP mode */
1202 #define WPA_DRIVER_FLAGS_AP 0x00000040
1203 /** Driver needs static WEP key setup after association has been completed */
1204 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1205 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1206 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1207 /** Driver supports concurrent P2P operations */
1208 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1210 * Driver uses the initial interface as a dedicated management interface, i.e.,
1211 * it cannot be used for P2P group operations or non-P2P purposes.
1213 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1214 /** This interface is P2P capable (P2P GO or P2P Client) */
1215 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1216 /** Driver supports station and key removal when stopping an AP */
1217 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1219 * Driver uses the initial interface for P2P management interface and non-P2P
1220 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1221 * P2P group operations.
1223 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1225 * Driver is known to use sane error codes, i.e., when it indicates that
1226 * something (e.g., association) fails, there was indeed a failure and the
1227 * operation does not end up getting completed successfully later.
1229 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1230 /** Driver supports off-channel TX */
1231 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1232 /** Driver indicates TX status events for EAPOL Data frames */
1233 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1234 /** Driver indicates TX status events for Deauth/Disassoc frames */
1235 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1236 /** Driver supports roaming (BSS selection) in firmware */
1237 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1238 /** Driver supports operating as a TDLS peer */
1239 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1240 /** Driver requires external TDLS setup/teardown/discovery */
1241 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1242 /** Driver indicates support for Probe Response offloading in AP mode */
1243 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1244 /** Driver supports U-APSD in AP mode */
1245 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1246 /** Driver supports inactivity timer in AP mode */
1247 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1248 /** Driver expects user space implementation of MLME in AP mode */
1249 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1250 /** Driver supports SAE with user space SME */
1251 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1252 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1253 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1254 /** Driver supports IBSS (Ad-hoc) mode */
1255 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1256 /** Driver supports radar detection */
1257 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1258 /** Driver supports a dedicated interface for P2P Device */
1259 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1260 /** Driver supports QoS Mapping */
1261 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1262 /** Driver supports CSA in AP mode */
1263 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1264 /** Driver supports mesh */
1265 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1266 /** Driver support ACS offload */
1267 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1268 /** Driver supports key management offload */
1269 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1270 /** Driver supports TDLS channel switching */
1271 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1272 /** Driver supports IBSS with HT datarates */
1273 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
1274 /** Driver supports IBSS with VHT datarates */
1275 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
1276 /** Driver supports automatic band selection */
1277 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
1278 /** Driver supports simultaneous off-channel operations */
1279 #define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
1280 /** Driver supports full AP client state */
1281 #define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
1282 /** Driver supports P2P Listen offload */
1283 #define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
1286 #define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1287 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1289 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1290 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1291 unsigned int smps_modes;
1293 unsigned int wmm_ac_supported:1;
1295 unsigned int mac_addr_rand_scan_supported:1;
1296 unsigned int mac_addr_rand_sched_scan_supported:1;
1298 /** Maximum number of supported active probe SSIDs */
1301 /** Maximum number of supported active probe SSIDs for sched_scan */
1302 int max_sched_scan_ssids;
1304 /** Maximum number of supported scan plans for scheduled scan */
1305 unsigned int max_sched_scan_plans;
1307 /** Maximum interval in a scan plan. In seconds */
1308 u32 max_sched_scan_plan_interval;
1310 /** Maximum number of iterations in a single scan plan */
1311 u32 max_sched_scan_plan_iterations;
1313 /** Whether sched_scan (offloaded scanning) is supported */
1314 int sched_scan_supported;
1316 /** Maximum number of supported match sets for sched_scan */
1320 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1322 unsigned int max_remain_on_chan;
1325 * max_stations - Maximum number of associated stations the driver
1326 * supports in AP mode
1328 unsigned int max_stations;
1331 * probe_resp_offloads - Bitmap of supported protocols by the driver
1332 * for Probe Response offloading.
1334 /** Driver Probe Response offloading support for WPS ver. 1 */
1335 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1336 /** Driver Probe Response offloading support for WPS ver. 2 */
1337 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1338 /** Driver Probe Response offloading support for P2P */
1339 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1340 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1341 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1342 unsigned int probe_resp_offloads;
1344 unsigned int max_acl_mac_addrs;
1347 * Number of supported concurrent channels
1349 unsigned int num_multichan_concurrent;
1352 * extended_capa - extended capabilities in driver/device
1354 * Must be allocated and freed by driver and the pointers must be
1355 * valid for the lifetime of the driver, i.e., freed in deinit()
1357 const u8 *extended_capa, *extended_capa_mask;
1358 unsigned int extended_capa_len;
1360 struct wowlan_triggers wowlan_triggers;
1362 /** Driver adds the DS Params Set IE in Probe Request frames */
1363 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1364 /** Driver adds the WFA TPC IE in Probe Request frames */
1365 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1366 /** Driver handles quiet period requests */
1367 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1369 * Driver is capable of inserting the current TX power value into the body of
1370 * transmitted frames.
1371 * Background: Some Action frames include a TPC Report IE. This IE contains a
1372 * TX power field, which has to be updated by lower layers. One such Action
1373 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1374 * of spectrum management). Note that this insertion takes place at a fixed
1375 * offset, namely the 6th byte in the Action frame body.
1377 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1379 * Driver supports RRM. With this support, the driver will accept to use RRM in
1380 * (Re)Association Request frames, without supporting quiet period.
1382 #define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1386 /* Driver concurrency capabilities */
1387 unsigned int conc_capab;
1388 /* Maximum number of concurrent channels on 2.4 GHz */
1389 unsigned int max_conc_chan_2_4;
1390 /* Maximum number of concurrent channels on 5 GHz */
1391 unsigned int max_conc_chan_5_0;
1393 /* Maximum number of supported CSA counters */
1394 u16 max_csa_counters;
1398 struct hostapd_data;
1400 struct hostap_sta_driver_data {
1401 unsigned long rx_packets, tx_packets;
1402 unsigned long long rx_bytes, tx_bytes;
1403 int bytes_64bit; /* whether 64-bit byte counters are supported */
1404 unsigned long current_tx_rate;
1405 unsigned long inactive_msec;
1406 unsigned long flags;
1407 unsigned long num_ps_buf_frames;
1408 unsigned long tx_retry_failed;
1409 unsigned long tx_retry_count;
1414 struct hostapd_sta_add_params {
1418 const u8 *supp_rates;
1419 size_t supp_rates_len;
1420 u16 listen_interval;
1421 const struct ieee80211_ht_capabilities *ht_capabilities;
1422 const struct ieee80211_vht_capabilities *vht_capabilities;
1423 int vht_opmode_enabled;
1425 u32 flags; /* bitmask of WPA_STA_* flags */
1426 u32 flags_mask; /* unset bits in flags */
1428 enum mesh_plink_state plink_state;
1430 #endif /* CONFIG_MESH */
1431 int set; /* Set STA parameters instead of add */
1433 const u8 *ext_capab;
1434 size_t ext_capab_len;
1435 const u8 *supp_channels;
1436 size_t supp_channels_len;
1437 const u8 *supp_oper_classes;
1438 size_t supp_oper_classes_len;
1442 struct mac_address {
1446 struct hostapd_acl_params {
1448 unsigned int num_mac_acl;
1449 struct mac_address mac_acl[0];
1452 enum wpa_driver_if_type {
1454 * WPA_IF_STATION - Station mode interface
1459 * WPA_IF_AP_VLAN - AP mode VLAN interface
1461 * This interface shares its address and Beacon frame with the main
1467 * WPA_IF_AP_BSS - AP mode BSS interface
1469 * This interface has its own address and Beacon frame.
1474 * WPA_IF_P2P_GO - P2P Group Owner
1479 * WPA_IF_P2P_CLIENT - P2P Client
1484 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1485 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1490 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1491 * abstracted P2P Device function in the driver
1496 * WPA_IF_MESH - Mesh interface
1501 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1506 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1511 struct wpa_init_params {
1515 const char *driver_params;
1516 int use_pae_group_addr;
1520 u8 *own_addr; /* buffer for writing own MAC address */
1524 struct wpa_bss_params {
1525 /** Interface name (for multi-SSID/VLAN support) */
1527 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1536 enum mfp_options ieee80211w;
1539 #define WPA_STA_AUTHORIZED BIT(0)
1540 #define WPA_STA_WMM BIT(1)
1541 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1542 #define WPA_STA_MFP BIT(3)
1543 #define WPA_STA_TDLS_PEER BIT(4)
1544 #define WPA_STA_AUTHENTICATED BIT(5)
1545 #define WPA_STA_ASSOCIATED BIT(6)
1558 WNM_SLEEP_ENTER_CONFIRM,
1559 WNM_SLEEP_ENTER_FAIL,
1560 WNM_SLEEP_EXIT_CONFIRM,
1561 WNM_SLEEP_EXIT_FAIL,
1562 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1563 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1564 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1566 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1568 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1569 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1571 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1574 /* enum chan_width - Channel width definitions */
1586 * struct wpa_signal_info - Information about channel signal quality
1588 struct wpa_signal_info {
1590 int above_threshold;
1593 int avg_beacon_signal;
1596 enum chan_width chanwidth;
1602 * struct beacon_data - Beacon data
1603 * @head: Head portion of Beacon frame (before TIM IE)
1604 * @tail: Tail portion of Beacon frame (after TIM IE)
1605 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1606 * @proberesp_ies: Extra information element(s) to add into Probe Response
1608 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1609 * Response frames or %NULL
1610 * @probe_resp: Probe Response frame template
1611 * @head_len: Length of @head
1612 * @tail_len: Length of @tail
1613 * @beacon_ies_len: Length of beacon_ies in octets
1614 * @proberesp_ies_len: Length of proberesp_ies in octets
1615 * @proberesp_ies_len: Length of proberesp_ies in octets
1616 * @probe_resp_len: Length of probe response template (@probe_resp)
1618 struct beacon_data {
1625 size_t head_len, tail_len;
1626 size_t beacon_ies_len;
1627 size_t proberesp_ies_len;
1628 size_t assocresp_ies_len;
1629 size_t probe_resp_len;
1633 * struct csa_settings - Settings for channel switch command
1634 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1635 * @block_tx: 1 - block transmission for CSA period
1636 * @freq_params: Next channel frequency parameter
1637 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1638 * @beacon_after: Next beacon/probe resp/asooc resp info
1639 * @counter_offset_beacon: Offset to the count field in beacon's tail
1640 * @counter_offset_presp: Offset to the count field in probe resp.
1642 struct csa_settings {
1646 struct hostapd_freq_params freq_params;
1647 struct beacon_data beacon_csa;
1648 struct beacon_data beacon_after;
1650 u16 counter_offset_beacon[2];
1651 u16 counter_offset_presp[2];
1654 /* TDLS peer capabilities for send_tdls_mgmt() */
1655 enum tdls_peer_capability {
1656 TDLS_PEER_HT = BIT(0),
1657 TDLS_PEER_VHT = BIT(1),
1658 TDLS_PEER_WMM = BIT(2),
1661 /* valid info in the wmm_params struct */
1662 enum wmm_params_valid_info {
1663 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1667 * struct wmm_params - WMM parameterss configured for this association
1668 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1669 * of the struct contain valid information.
1670 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1671 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1678 #ifdef CONFIG_MACSEC
1679 struct macsec_init_params {
1680 Boolean always_include_sci;
1684 #endif /* CONFIG_MACSEC */
1686 enum drv_br_port_attr {
1687 DRV_BR_PORT_ATTR_PROXYARP,
1688 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1691 enum drv_br_net_param {
1692 DRV_BR_NET_PARAM_GARP_ACCEPT,
1693 DRV_BR_MULTICAST_SNOOPING,
1696 struct drv_acs_params {
1697 /* Selected mode (HOSTAPD_MODE_*) */
1698 enum hostapd_hw_mode hw_mode;
1700 /* Indicates whether HT is enabled */
1703 /* Indicates whether HT40 is enabled */
1706 /* Indicates whether VHT is enabled */
1709 /* Configured ACS channel width */
1712 /* ACS channel list info */
1713 unsigned int ch_list_len;
1715 const int *freq_list;
1720 * struct wpa_driver_ops - Driver interface API definition
1722 * This structure defines the API that each driver interface needs to implement
1723 * for core wpa_supplicant code. All driver specific functionality is captured
1726 struct wpa_driver_ops {
1727 /** Name of the driver interface */
1729 /** One line description of the driver interface */
1733 * get_bssid - Get the current BSSID
1734 * @priv: private driver interface data
1735 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1737 * Returns: 0 on success, -1 on failure
1739 * Query kernel driver for the current BSSID and copy it to bssid.
1740 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1743 int (*get_bssid)(void *priv, u8 *bssid);
1746 * get_ssid - Get the current SSID
1747 * @priv: private driver interface data
1748 * @ssid: buffer for SSID (at least 32 bytes)
1750 * Returns: Length of the SSID on success, -1 on failure
1752 * Query kernel driver for the current SSID and copy it to ssid.
1753 * Returning zero is recommended if the STA is not associated.
1755 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1756 * can, at least in theory, contain control characters (including nul)
1757 * and as such, should be processed as binary data, not a printable
1760 int (*get_ssid)(void *priv, u8 *ssid);
1763 * set_key - Configure encryption key
1764 * @ifname: Interface name (for multi-SSID/VLAN support)
1765 * @priv: private driver interface data
1766 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1767 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1768 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1769 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1770 * %WPA_ALG_BIP_CMAC_256);
1771 * %WPA_ALG_NONE clears the key.
1772 * @addr: Address of the peer STA (BSSID of the current AP when setting
1773 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1774 * broadcast keys, %NULL for default keys that are used both for
1775 * broadcast and unicast; when clearing keys, %NULL is used to
1776 * indicate that both the broadcast-only and default key of the
1777 * specified key index is to be cleared
1778 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1780 * @set_tx: configure this key as the default Tx key (only used when
1781 * driver does not support separate unicast/individual key
1782 * @seq: sequence number/packet number, seq_len octets, the next
1783 * packet number to be used for in replay protection; configured
1784 * for Rx keys (in most cases, this is only used with broadcast
1785 * keys and set to zero for unicast keys); %NULL if not set
1786 * @seq_len: length of the seq, depends on the algorithm:
1787 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1788 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1790 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1791 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1793 * Returns: 0 on success, -1 on failure
1795 * Configure the given key for the kernel driver. If the driver
1796 * supports separate individual keys (4 default keys + 1 individual),
1797 * addr can be used to determine whether the key is default or
1798 * individual. If only 4 keys are supported, the default key with key
1799 * index 0 is used as the individual key. STA must be configured to use
1800 * it as the default Tx key (set_tx is set) and accept Rx for all the
1801 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1802 * broadcast keys, so key index 0 is available for this kind of
1805 * Please note that TKIP keys include separate TX and RX MIC keys and
1806 * some drivers may expect them in different order than wpa_supplicant
1807 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1808 * will trigger Michael MIC errors. This can be fixed by changing the
1809 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1810 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1811 * example on how this can be done.
1813 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1814 const u8 *addr, int key_idx, int set_tx,
1815 const u8 *seq, size_t seq_len,
1816 const u8 *key, size_t key_len);
1819 * init - Initialize driver interface
1820 * @ctx: context to be used when calling wpa_supplicant functions,
1821 * e.g., wpa_supplicant_event()
1822 * @ifname: interface name, e.g., wlan0
1824 * Returns: Pointer to private data, %NULL on failure
1826 * Initialize driver interface, including event processing for kernel
1827 * driver events (e.g., associated, scan results, Michael MIC failure).
1828 * This function can allocate a private configuration data area for
1829 * @ctx, file descriptor, interface name, etc. information that may be
1830 * needed in future driver operations. If this is not used, non-NULL
1831 * value will need to be returned because %NULL is used to indicate
1832 * failure. The returned value will be used as 'void *priv' data for
1833 * all other driver_ops functions.
1835 * The main event loop (eloop.c) of wpa_supplicant can be used to
1836 * register callback for read sockets (eloop_register_read_sock()).
1838 * See below for more information about events and
1839 * wpa_supplicant_event() function.
1841 void * (*init)(void *ctx, const char *ifname);
1844 * deinit - Deinitialize driver interface
1845 * @priv: private driver interface data from init()
1847 * Shut down driver interface and processing of driver events. Free
1848 * private data buffer if one was allocated in init() handler.
1850 void (*deinit)(void *priv);
1853 * set_param - Set driver configuration parameters
1854 * @priv: private driver interface data from init()
1855 * @param: driver specific configuration parameters
1857 * Returns: 0 on success, -1 on failure
1859 * Optional handler for notifying driver interface about configuration
1860 * parameters (driver_param).
1862 int (*set_param)(void *priv, const char *param);
1865 * set_countermeasures - Enable/disable TKIP countermeasures
1866 * @priv: private driver interface data
1867 * @enabled: 1 = countermeasures enabled, 0 = disabled
1869 * Returns: 0 on success, -1 on failure
1871 * Configure TKIP countermeasures. When these are enabled, the driver
1872 * should drop all received and queued frames that are using TKIP.
1874 int (*set_countermeasures)(void *priv, int enabled);
1877 * deauthenticate - Request driver to deauthenticate
1878 * @priv: private driver interface data
1879 * @addr: peer address (BSSID of the AP)
1880 * @reason_code: 16-bit reason code to be sent in the deauthentication
1883 * Returns: 0 on success, -1 on failure
1885 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1888 * associate - Request driver to associate
1889 * @priv: private driver interface data
1890 * @params: association parameters
1892 * Returns: 0 on success, -1 on failure
1894 int (*associate)(void *priv,
1895 struct wpa_driver_associate_params *params);
1898 * add_pmkid - Add PMKSA cache entry to the driver
1899 * @priv: private driver interface data
1900 * @bssid: BSSID for the PMKSA cache entry
1901 * @pmkid: PMKID for the PMKSA cache entry
1903 * Returns: 0 on success, -1 on failure
1905 * This function is called when a new PMK is received, as a result of
1906 * either normal authentication or RSN pre-authentication.
1908 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1909 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1910 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1911 * driver_ops function does not need to be implemented. Likewise, if
1912 * the driver does not support WPA, this function is not needed.
1914 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1917 * remove_pmkid - Remove PMKSA cache entry to the driver
1918 * @priv: private driver interface data
1919 * @bssid: BSSID for the PMKSA cache entry
1920 * @pmkid: PMKID for the PMKSA cache entry
1922 * Returns: 0 on success, -1 on failure
1924 * This function is called when the supplicant drops a PMKSA cache
1925 * entry for any reason.
1927 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1928 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1929 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1930 * from wpa_supplicant, this driver_ops function does not need to be
1931 * implemented. Likewise, if the driver does not support WPA, this
1932 * function is not needed.
1934 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1937 * flush_pmkid - Flush PMKSA cache
1938 * @priv: private driver interface data
1940 * Returns: 0 on success, -1 on failure
1942 * This function is called when the supplicant drops all PMKSA cache
1943 * entries for any reason.
1945 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1946 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1947 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1948 * from wpa_supplicant, this driver_ops function does not need to be
1949 * implemented. Likewise, if the driver does not support WPA, this
1950 * function is not needed.
1952 int (*flush_pmkid)(void *priv);
1955 * get_capa - Get driver capabilities
1956 * @priv: private driver interface data
1958 * Returns: 0 on success, -1 on failure
1960 * Get driver/firmware/hardware capabilities.
1962 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1965 * poll - Poll driver for association information
1966 * @priv: private driver interface data
1968 * This is an option callback that can be used when the driver does not
1969 * provide event mechanism for association events. This is called when
1970 * receiving WPA EAPOL-Key messages that require association
1971 * information. The driver interface is supposed to generate associnfo
1972 * event before returning from this callback function. In addition, the
1973 * driver interface should generate an association event after having
1974 * sent out associnfo.
1976 void (*poll)(void *priv);
1979 * get_ifindex - Get interface index
1980 * @priv: private driver interface data
1982 * Returns: Interface index
1984 unsigned int (*get_ifindex)(void *priv);
1987 * get_ifname - Get interface name
1988 * @priv: private driver interface data
1990 * Returns: Pointer to the interface name. This can differ from the
1991 * interface name used in init() call. Init() is called first.
1993 * This optional function can be used to allow the driver interface to
1994 * replace the interface name with something else, e.g., based on an
1995 * interface mapping from a more descriptive name.
1997 const char * (*get_ifname)(void *priv);
2000 * get_mac_addr - Get own MAC address
2001 * @priv: private driver interface data
2003 * Returns: Pointer to own MAC address or %NULL on failure
2005 * This optional function can be used to get the own MAC address of the
2006 * device from the driver interface code. This is only needed if the
2007 * l2_packet implementation for the OS does not provide easy access to
2009 const u8 * (*get_mac_addr)(void *priv);
2012 * set_operstate - Sets device operating state to DORMANT or UP
2013 * @priv: private driver interface data
2014 * @state: 0 = dormant, 1 = up
2015 * Returns: 0 on success, -1 on failure
2017 * This is an optional function that can be used on operating systems
2018 * that support a concept of controlling network device state from user
2019 * space applications. This function, if set, gets called with
2020 * state = 1 when authentication has been completed and with state = 0
2021 * when connection is lost.
2023 int (*set_operstate)(void *priv, int state);
2026 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2027 * @priv: Private driver interface data
2028 * @addr: Address of the station for which to set protection (may be
2029 * %NULL for group keys)
2030 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2031 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2032 * Returns: 0 on success, -1 on failure
2034 * This is an optional function that can be used to set the driver to
2035 * require protection for Tx and/or Rx frames. This uses the layer
2036 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2037 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2038 * set protection operation; instead, they set protection implicitly
2039 * based on configured keys.
2041 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2045 * get_hw_feature_data - Get hardware support data (channels and rates)
2046 * @priv: Private driver interface data
2047 * @num_modes: Variable for returning the number of returned modes
2048 * flags: Variable for returning hardware feature flags
2049 * Returns: Pointer to allocated hardware data on success or %NULL on
2050 * failure. Caller is responsible for freeing this.
2052 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2057 * send_mlme - Send management frame from MLME
2058 * @priv: Private driver interface data
2059 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2060 * @data_len: Size of the management frame
2061 * @noack: Do not wait for this frame to be acked (disable retries)
2062 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2064 * @csa_offs: Array of CSA offsets or %NULL
2065 * @csa_offs_len: Number of elements in csa_offs
2066 * Returns: 0 on success, -1 on failure
2068 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
2069 int noack, unsigned int freq, const u16 *csa_offs,
2070 size_t csa_offs_len);
2073 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2074 * @priv: Private driver interface data
2075 * @md: Mobility domain (2 octets) (also included inside ies)
2076 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2077 * @ies_len: Length of FT IEs in bytes
2078 * Returns: 0 on success, -1 on failure
2080 * The supplicant uses this callback to let the driver know that keying
2081 * material for FT is available and that the driver can use the
2082 * provided IEs in the next message in FT authentication sequence.
2084 * This function is only needed for driver that support IEEE 802.11r
2085 * (Fast BSS Transition).
2087 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2091 * get_scan_results2 - Fetch the latest scan results
2092 * @priv: private driver interface data
2094 * Returns: Allocated buffer of scan results (caller is responsible for
2095 * freeing the data structure) on success, NULL on failure
2097 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2100 * set_country - Set country
2101 * @priv: Private driver interface data
2102 * @alpha2: country to which to switch to
2103 * Returns: 0 on success, -1 on failure
2105 * This function is for drivers which support some form
2106 * of setting a regulatory domain.
2108 int (*set_country)(void *priv, const char *alpha2);
2111 * get_country - Get country
2112 * @priv: Private driver interface data
2113 * @alpha2: Buffer for returning country code (at least 3 octets)
2114 * Returns: 0 on success, -1 on failure
2116 int (*get_country)(void *priv, char *alpha2);
2119 * global_init - Global driver initialization
2120 * @ctx: wpa_global pointer
2121 * Returns: Pointer to private data (global), %NULL on failure
2123 * This optional function is called to initialize the driver wrapper
2124 * for global data, i.e., data that applies to all interfaces. If this
2125 * function is implemented, global_deinit() will also need to be
2126 * implemented to free the private data. The driver will also likely
2127 * use init2() function instead of init() to get the pointer to global
2128 * data available to per-interface initializer.
2130 void * (*global_init)(void *ctx);
2133 * global_deinit - Global driver deinitialization
2134 * @priv: private driver global data from global_init()
2136 * Terminate any global driver related functionality and free the
2137 * global data structure.
2139 void (*global_deinit)(void *priv);
2142 * init2 - Initialize driver interface (with global data)
2143 * @ctx: context to be used when calling wpa_supplicant functions,
2144 * e.g., wpa_supplicant_event()
2145 * @ifname: interface name, e.g., wlan0
2146 * @global_priv: private driver global data from global_init()
2147 * Returns: Pointer to private data, %NULL on failure
2149 * This function can be used instead of init() if the driver wrapper
2152 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2155 * get_interfaces - Get information about available interfaces
2156 * @global_priv: private driver global data from global_init()
2157 * Returns: Allocated buffer of interface information (caller is
2158 * responsible for freeing the data structure) on success, NULL on
2161 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2164 * scan2 - Request the driver to initiate scan
2165 * @priv: private driver interface data
2166 * @params: Scan parameters
2168 * Returns: 0 on success, -1 on failure
2170 * Once the scan results are ready, the driver should report scan
2171 * results event for wpa_supplicant which will eventually request the
2172 * results with wpa_driver_get_scan_results2().
2174 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2177 * authenticate - Request driver to authenticate
2178 * @priv: private driver interface data
2179 * @params: authentication parameters
2180 * Returns: 0 on success, -1 on failure
2182 * This is an optional function that can be used with drivers that
2183 * support separate authentication and association steps, i.e., when
2184 * wpa_supplicant can act as the SME. If not implemented, associate()
2185 * function is expected to take care of IEEE 802.11 authentication,
2188 int (*authenticate)(void *priv,
2189 struct wpa_driver_auth_params *params);
2192 * set_ap - Set Beacon and Probe Response information for AP mode
2193 * @priv: Private driver interface data
2194 * @params: Parameters to use in AP mode
2196 * This function is used to configure Beacon template and/or extra IEs
2197 * to add for Beacon and Probe Response frames for the driver in
2198 * AP mode. The driver is responsible for building the full Beacon
2199 * frame by concatenating the head part with TIM IE generated by the
2200 * driver/firmware and finishing with the tail part. Depending on the
2201 * driver architectue, this can be done either by using the full
2202 * template or the set of additional IEs (e.g., WPS and P2P IE).
2203 * Similarly, Probe Response processing depends on the driver design.
2204 * If the driver (or firmware) takes care of replying to Probe Request
2205 * frames, the extra IEs provided here needs to be added to the Probe
2208 * Returns: 0 on success, -1 on failure
2210 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
2213 * set_acl - Set ACL in AP mode
2214 * @priv: Private driver interface data
2215 * @params: Parameters to configure ACL
2216 * Returns: 0 on success, -1 on failure
2218 * This is used only for the drivers which support MAC address ACL.
2220 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2223 * hapd_init - Initialize driver interface (hostapd only)
2224 * @hapd: Pointer to hostapd context
2225 * @params: Configuration for the driver wrapper
2226 * Returns: Pointer to private data, %NULL on failure
2228 * This function is used instead of init() or init2() when the driver
2229 * wrapper is used with hostapd.
2231 void * (*hapd_init)(struct hostapd_data *hapd,
2232 struct wpa_init_params *params);
2235 * hapd_deinit - Deinitialize driver interface (hostapd only)
2236 * @priv: Private driver interface data from hapd_init()
2238 void (*hapd_deinit)(void *priv);
2241 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2242 * @priv: Private driver interface data
2243 * @params: BSS parameters
2244 * Returns: 0 on success, -1 on failure
2246 * This is an optional function to configure the kernel driver to
2247 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2248 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2249 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2250 * for Beacon frames.
2252 * DEPRECATED - use set_ap() instead
2254 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2257 * set_privacy - Enable/disable privacy (AP only)
2258 * @priv: Private driver interface data
2259 * @enabled: 1 = privacy enabled, 0 = disabled
2260 * Returns: 0 on success, -1 on failure
2262 * This is an optional function to configure privacy field in the
2263 * kernel driver for Beacon frames. This can be left undefined (set to
2264 * %NULL) if the driver uses the Beacon template from set_ap().
2266 * DEPRECATED - use set_ap() instead
2268 int (*set_privacy)(void *priv, int enabled);
2271 * get_seqnum - Fetch the current TSC/packet number (AP only)
2272 * @ifname: The interface name (main or virtual)
2273 * @priv: Private driver interface data
2274 * @addr: MAC address of the station or %NULL for group keys
2276 * @seq: Buffer for returning the latest used TSC/packet number
2277 * Returns: 0 on success, -1 on failure
2279 * This function is used to fetch the last used TSC/packet number for
2280 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2281 * keys, so there is no strict requirement on implementing support for
2282 * unicast keys (i.e., addr != %NULL).
2284 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2288 * flush - Flush all association stations (AP only)
2289 * @priv: Private driver interface data
2290 * Returns: 0 on success, -1 on failure
2292 * This function requests the driver to disassociate all associated
2293 * stations. This function does not need to be implemented if the
2294 * driver does not process association frames internally.
2296 int (*flush)(void *priv);
2299 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2300 * @priv: Private driver interface data
2301 * @elem: Information elements
2302 * @elem_len: Length of the elem buffer in octets
2303 * Returns: 0 on success, -1 on failure
2305 * This is an optional function to add information elements in the
2306 * kernel driver for Beacon and Probe Response frames. This can be left
2307 * undefined (set to %NULL) if the driver uses the Beacon template from
2310 * DEPRECATED - use set_ap() instead
2312 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2315 * read_sta_data - Fetch station data
2316 * @priv: Private driver interface data
2317 * @data: Buffer for returning station information
2318 * @addr: MAC address of the station
2319 * Returns: 0 on success, -1 on failure
2321 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2325 * hapd_send_eapol - Send an EAPOL packet (AP only)
2326 * @priv: private driver interface data
2327 * @addr: Destination MAC address
2328 * @data: EAPOL packet starting with IEEE 802.1X header
2329 * @data_len: Length of the EAPOL packet in octets
2330 * @encrypt: Whether the frame should be encrypted
2331 * @own_addr: Source MAC address
2332 * @flags: WPA_STA_* flags for the destination station
2334 * Returns: 0 on success, -1 on failure
2336 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2337 size_t data_len, int encrypt,
2338 const u8 *own_addr, u32 flags);
2341 * sta_deauth - Deauthenticate a station (AP only)
2342 * @priv: Private driver interface data
2343 * @own_addr: Source address and BSSID for the Deauthentication frame
2344 * @addr: MAC address of the station to deauthenticate
2345 * @reason: Reason code for the Deauthentiation frame
2346 * Returns: 0 on success, -1 on failure
2348 * This function requests a specific station to be deauthenticated and
2349 * a Deauthentication frame to be sent to it.
2351 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2355 * sta_disassoc - Disassociate a station (AP only)
2356 * @priv: Private driver interface data
2357 * @own_addr: Source address and BSSID for the Disassociation frame
2358 * @addr: MAC address of the station to disassociate
2359 * @reason: Reason code for the Disassociation frame
2360 * Returns: 0 on success, -1 on failure
2362 * This function requests a specific station to be disassociated and
2363 * a Disassociation frame to be sent to it.
2365 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2369 * sta_remove - Remove a station entry (AP only)
2370 * @priv: Private driver interface data
2371 * @addr: MAC address of the station to be removed
2372 * Returns: 0 on success, -1 on failure
2374 int (*sta_remove)(void *priv, const u8 *addr);
2377 * hapd_get_ssid - Get the current SSID (AP only)
2378 * @priv: Private driver interface data
2379 * @buf: Buffer for returning the SSID
2380 * @len: Maximum length of the buffer
2381 * Returns: Length of the SSID on success, -1 on failure
2383 * This function need not be implemented if the driver uses Beacon
2384 * template from set_ap() and does not reply to Probe Request frames.
2386 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2389 * hapd_set_ssid - Set SSID (AP only)
2390 * @priv: Private driver interface data
2392 * @len: Length of the SSID in octets
2393 * Returns: 0 on success, -1 on failure
2395 * DEPRECATED - use set_ap() instead
2397 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2400 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2401 * @priv: Private driver interface data
2402 * @enabled: 1 = countermeasures enabled, 0 = disabled
2403 * Returns: 0 on success, -1 on failure
2405 * This need not be implemented if the driver does not take care of
2406 * association processing.
2408 int (*hapd_set_countermeasures)(void *priv, int enabled);
2411 * sta_add - Add a station entry
2412 * @priv: Private driver interface data
2413 * @params: Station parameters
2414 * Returns: 0 on success, -1 on failure
2416 * This function is used to add or set (params->set 1) a station
2417 * entry in the driver. Adding STA entries is used only if the driver
2418 * does not take care of association processing.
2420 * With drivers that don't support full AP client state, this function
2421 * is used to add a station entry to the driver once the station has
2422 * completed association.
2424 * With TDLS, this function is used to add or set (params->set 1)
2425 * TDLS peer entries (even with drivers that do not support full AP
2428 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2431 * get_inact_sec - Get station inactivity duration (AP only)
2432 * @priv: Private driver interface data
2433 * @addr: Station address
2434 * Returns: Number of seconds station has been inactive, -1 on failure
2436 int (*get_inact_sec)(void *priv, const u8 *addr);
2439 * sta_clear_stats - Clear station statistics (AP only)
2440 * @priv: Private driver interface data
2441 * @addr: Station address
2442 * Returns: 0 on success, -1 on failure
2444 int (*sta_clear_stats)(void *priv, const u8 *addr);
2447 * set_freq - Set channel/frequency (AP only)
2448 * @priv: Private driver interface data
2449 * @freq: Channel parameters
2450 * Returns: 0 on success, -1 on failure
2452 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2455 * set_rts - Set RTS threshold
2456 * @priv: Private driver interface data
2457 * @rts: RTS threshold in octets
2458 * Returns: 0 on success, -1 on failure
2460 int (*set_rts)(void *priv, int rts);
2463 * set_frag - Set fragmentation threshold
2464 * @priv: Private driver interface data
2465 * @frag: Fragmentation threshold in octets
2466 * Returns: 0 on success, -1 on failure
2468 int (*set_frag)(void *priv, int frag);
2471 * sta_set_flags - Set station flags (AP only)
2472 * @priv: Private driver interface data
2473 * @addr: Station address
2474 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2475 * @flags_or: Bitmap of WPA_STA_* flags to add
2476 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2477 * Returns: 0 on success, -1 on failure
2479 int (*sta_set_flags)(void *priv, const u8 *addr,
2480 unsigned int total_flags, unsigned int flags_or,
2481 unsigned int flags_and);
2484 * set_tx_queue_params - Set TX queue parameters
2485 * @priv: Private driver interface data
2486 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2490 * @burst_time: Maximum length for bursting in 0.1 msec units
2492 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2493 int cw_max, int burst_time);
2496 * if_add - Add a virtual interface
2497 * @priv: Private driver interface data
2498 * @type: Interface type
2499 * @ifname: Interface name for the new virtual interface
2500 * @addr: Local address to use for the interface or %NULL to use the
2501 * parent interface address
2502 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2503 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2504 * not allowed (applies only to %WPA_IF_AP_BSS type)
2505 * @force_ifname: Buffer for returning an interface name that the
2506 * driver ended up using if it differs from the requested ifname
2507 * @if_addr: Buffer for returning the allocated interface address
2508 * (this may differ from the requested addr if the driver cannot
2509 * change interface address)
2510 * @bridge: Bridge interface to use or %NULL if no bridge configured
2511 * @use_existing: Whether to allow existing interface to be used
2512 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
2513 * Returns: 0 on success, -1 on failure
2515 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2516 const char *ifname, const u8 *addr, void *bss_ctx,
2517 void **drv_priv, char *force_ifname, u8 *if_addr,
2518 const char *bridge, int use_existing, int setup_ap);
2521 * if_remove - Remove a virtual interface
2522 * @priv: Private driver interface data
2523 * @type: Interface type
2524 * @ifname: Interface name of the virtual interface to be removed
2525 * Returns: 0 on success, -1 on failure
2527 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2528 const char *ifname);
2531 * set_sta_vlan - Bind a station into a specific interface (AP only)
2532 * @priv: Private driver interface data
2533 * @ifname: Interface (main or virtual BSS or VLAN)
2534 * @addr: MAC address of the associated station
2536 * Returns: 0 on success, -1 on failure
2538 * This function is used to bind a station to a specific virtual
2539 * interface. It is only used if when virtual interfaces are supported,
2540 * e.g., to assign stations to different VLAN interfaces based on
2541 * information from a RADIUS server. This allows separate broadcast
2542 * domains to be used with a single BSS.
2544 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2548 * commit - Optional commit changes handler (AP only)
2549 * @priv: driver private data
2550 * Returns: 0 on success, -1 on failure
2552 * This optional handler function can be registered if the driver
2553 * interface implementation needs to commit changes (e.g., by setting
2554 * network interface up) at the end of initial configuration. If set,
2555 * this handler will be called after initial setup has been completed.
2557 int (*commit)(void *priv);
2560 * send_ether - Send an ethernet packet (AP only)
2561 * @priv: private driver interface data
2562 * @dst: Destination MAC address
2563 * @src: Source MAC address
2565 * @data: EAPOL packet starting with IEEE 802.1X header
2566 * @data_len: Length of the EAPOL packet in octets
2567 * Returns: 0 on success, -1 on failure
2569 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2570 const u8 *data, size_t data_len);
2573 * set_radius_acl_auth - Notification of RADIUS ACL change
2574 * @priv: Private driver interface data
2575 * @mac: MAC address of the station
2576 * @accepted: Whether the station was accepted
2577 * @session_timeout: Session timeout for the station
2578 * Returns: 0 on success, -1 on failure
2580 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2581 u32 session_timeout);
2584 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2585 * @priv: Private driver interface data
2586 * @mac: MAC address of the station
2587 * Returns: 0 on success, -1 on failure
2589 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2592 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2593 * @priv: Private driver interface data
2594 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2595 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2597 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2598 * to remove extra IE(s)
2599 * Returns: 0 on success, -1 on failure
2601 * This is an optional function to add WPS IE in the kernel driver for
2602 * Beacon and Probe Response frames. This can be left undefined (set
2603 * to %NULL) if the driver uses the Beacon template from set_ap()
2604 * and does not process Probe Request frames. If the driver takes care
2605 * of (Re)Association frame processing, the assocresp buffer includes
2606 * WPS IE(s) that need to be added to (Re)Association Response frames
2607 * whenever a (Re)Association Request frame indicated use of WPS.
2609 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2610 * frames when operating as a GO. The driver is responsible for adding
2611 * timing related attributes (e.g., NoA) in addition to the IEs
2612 * included here by appending them after these buffers. This call is
2613 * also used to provide Probe Response IEs for P2P Listen state
2614 * operations for drivers that generate the Probe Response frames
2617 * DEPRECATED - use set_ap() instead
2619 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2620 const struct wpabuf *proberesp,
2621 const struct wpabuf *assocresp);
2624 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2625 * @priv: Private driver interface data
2626 * @authorized: Whether the port is authorized
2627 * Returns: 0 on success, -1 on failure
2629 int (*set_supp_port)(void *priv, int authorized);
2632 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2633 * @priv: Private driver interface data
2634 * @addr: MAC address of the associated station
2635 * @aid: Association ID
2636 * @val: 1 = bind to 4-address WDS; 0 = unbind
2637 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2638 * to indicate that bridge is not to be used
2639 * @ifname_wds: Buffer to return the interface name for the new WDS
2640 * station or %NULL to indicate name is not returned.
2641 * Returns: 0 on success, -1 on failure
2643 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2644 const char *bridge_ifname, char *ifname_wds);
2647 * send_action - Transmit an Action frame
2648 * @priv: Private driver interface data
2649 * @freq: Frequency (in MHz) of the channel
2650 * @wait: Time to wait off-channel for a response (in ms), or zero
2651 * @dst: Destination MAC address (Address 1)
2652 * @src: Source MAC address (Address 2)
2653 * @bssid: BSSID (Address 3)
2655 * @data_len: data length in octets
2656 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2657 * Returns: 0 on success, -1 on failure
2659 * This command can be used to request the driver to transmit an action
2660 * frame to the specified destination.
2662 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2663 * be transmitted on the given channel and the device will wait for a
2664 * response on that channel for the given wait time.
2666 * If the flag is not set, the wait time will be ignored. In this case,
2667 * if a remain-on-channel duration is in progress, the frame must be
2668 * transmitted on that channel; alternatively the frame may be sent on
2669 * the current operational channel (if in associated state in station
2670 * mode or while operating as an AP.)
2672 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2673 const u8 *dst, const u8 *src, const u8 *bssid,
2674 const u8 *data, size_t data_len, int no_cck);
2677 * send_action_cancel_wait - Cancel action frame TX wait
2678 * @priv: Private driver interface data
2680 * This command cancels the wait time associated with sending an action
2681 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2682 * set in the driver flags.
2684 void (*send_action_cancel_wait)(void *priv);
2687 * remain_on_channel - Remain awake on a channel
2688 * @priv: Private driver interface data
2689 * @freq: Frequency (in MHz) of the channel
2690 * @duration: Duration in milliseconds
2691 * Returns: 0 on success, -1 on failure
2693 * This command is used to request the driver to remain awake on the
2694 * specified channel for the specified duration and report received
2695 * Action frames with EVENT_RX_MGMT events. Optionally, received
2696 * Probe Request frames may also be requested to be reported by calling
2697 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2699 * The driver may not be at the requested channel when this function
2700 * returns, i.e., the return code is only indicating whether the
2701 * request was accepted. The caller will need to wait until the
2702 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2703 * completed the channel change. This may take some time due to other
2704 * need for the radio and the caller should be prepared to timing out
2705 * its wait since there are no guarantees on when this request can be
2708 int (*remain_on_channel)(void *priv, unsigned int freq,
2709 unsigned int duration);
2712 * cancel_remain_on_channel - Cancel remain-on-channel operation
2713 * @priv: Private driver interface data
2715 * This command can be used to cancel a remain-on-channel operation
2716 * before its originally requested duration has passed. This could be
2717 * used, e.g., when remain_on_channel() is used to request extra time
2718 * to receive a response to an Action frame and the response is
2719 * received when there is still unneeded time remaining on the
2720 * remain-on-channel operation.
2722 int (*cancel_remain_on_channel)(void *priv);
2725 * probe_req_report - Request Probe Request frames to be indicated
2726 * @priv: Private driver interface data
2727 * @report: Whether to report received Probe Request frames
2728 * Returns: 0 on success, -1 on failure (or if not supported)
2730 * This command can be used to request the driver to indicate when
2731 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2732 * Since this operation may require extra resources, e.g., due to less
2733 * optimal hardware/firmware RX filtering, many drivers may disable
2734 * Probe Request reporting at least in station mode. This command is
2735 * used to notify the driver when the Probe Request frames need to be
2736 * reported, e.g., during remain-on-channel operations.
2738 int (*probe_req_report)(void *priv, int report);
2741 * deinit_ap - Deinitialize AP mode
2742 * @priv: Private driver interface data
2743 * Returns: 0 on success, -1 on failure (or if not supported)
2745 * This optional function can be used to disable AP mode related
2746 * configuration. If the interface was not dynamically added,
2747 * change the driver mode to station mode to allow normal station
2748 * operations like scanning to be completed.
2750 int (*deinit_ap)(void *priv);
2753 * deinit_p2p_cli - Deinitialize P2P client mode
2754 * @priv: Private driver interface data
2755 * Returns: 0 on success, -1 on failure (or if not supported)
2757 * This optional function can be used to disable P2P client mode. If the
2758 * interface was not dynamically added, change the interface type back
2761 int (*deinit_p2p_cli)(void *priv);
2764 * suspend - Notification on system suspend/hibernate event
2765 * @priv: Private driver interface data
2767 void (*suspend)(void *priv);
2770 * resume - Notification on system resume/thaw event
2771 * @priv: Private driver interface data
2773 void (*resume)(void *priv);
2776 * signal_monitor - Set signal monitoring parameters
2777 * @priv: Private driver interface data
2778 * @threshold: Threshold value for signal change events; 0 = disabled
2779 * @hysteresis: Minimum change in signal strength before indicating a
2781 * Returns: 0 on success, -1 on failure (or if not supported)
2783 * This function can be used to configure monitoring of signal strength
2784 * with the current AP. Whenever signal strength drops below the
2785 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2786 * should be generated assuming the signal strength has changed at
2787 * least %hysteresis from the previously indicated signal change event.
2789 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2792 * send_frame - Send IEEE 802.11 frame (testing use only)
2793 * @priv: Private driver interface data
2794 * @data: IEEE 802.11 frame with IEEE 802.11 header
2795 * @data_len: Size of the frame
2796 * @encrypt: Whether to encrypt the frame (if keys are set)
2797 * Returns: 0 on success, -1 on failure
2799 * This function is only used for debugging purposes and is not
2800 * required to be implemented for normal operations.
2802 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2806 * get_noa - Get current Notice of Absence attribute payload
2807 * @priv: Private driver interface data
2808 * @buf: Buffer for returning NoA
2809 * @buf_len: Buffer length in octets
2810 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2811 * advertized, or -1 on failure
2813 * This function is used to fetch the current Notice of Absence
2814 * attribute value from GO.
2816 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2819 * set_noa - Set Notice of Absence parameters for GO (testing)
2820 * @priv: Private driver interface data
2822 * @start: Start time in ms from next TBTT
2823 * @duration: Duration in ms
2824 * Returns: 0 on success or -1 on failure
2826 * This function is used to set Notice of Absence parameters for GO. It
2827 * is used only for testing. To disable NoA, all parameters are set to
2830 int (*set_noa)(void *priv, u8 count, int start, int duration);
2833 * set_p2p_powersave - Set P2P power save options
2834 * @priv: Private driver interface data
2835 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2836 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2837 * @ctwindow: 0.. = change (msec), -1 = no change
2838 * Returns: 0 on success or -1 on failure
2840 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2844 * ampdu - Enable/disable aggregation
2845 * @priv: Private driver interface data
2846 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2847 * Returns: 0 on success or -1 on failure
2849 int (*ampdu)(void *priv, int ampdu);
2852 * get_radio_name - Get physical radio name for the device
2853 * @priv: Private driver interface data
2854 * Returns: Radio name or %NULL if not known
2856 * The returned data must not be modified by the caller. It is assumed
2857 * that any interface that has the same radio name as another is
2858 * sharing the same physical radio. This information can be used to
2859 * share scan results etc. information between the virtual interfaces
2860 * to speed up various operations.
2862 const char * (*get_radio_name)(void *priv);
2865 * send_tdls_mgmt - for sending TDLS management packets
2866 * @priv: private driver interface data
2867 * @dst: Destination (peer) MAC address
2868 * @action_code: TDLS action code for the mssage
2869 * @dialog_token: Dialog Token to use in the message (if needed)
2870 * @status_code: Status Code or Reason Code to use (if needed)
2871 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2872 * @initiator: Is the current end the TDLS link initiator
2873 * @buf: TDLS IEs to add to the message
2874 * @len: Length of buf in octets
2875 * Returns: 0 on success, negative (<0) on failure
2877 * This optional function can be used to send packet to driver which is
2878 * responsible for receiving and sending all TDLS packets.
2880 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2881 u8 dialog_token, u16 status_code, u32 peer_capab,
2882 int initiator, const u8 *buf, size_t len);
2885 * tdls_oper - Ask the driver to perform high-level TDLS operations
2886 * @priv: Private driver interface data
2887 * @oper: TDLS high-level operation. See %enum tdls_oper
2888 * @peer: Destination (peer) MAC address
2889 * Returns: 0 on success, negative (<0) on failure
2891 * This optional function can be used to send high-level TDLS commands
2894 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2897 * wnm_oper - Notify driver of the WNM frame reception
2898 * @priv: Private driver interface data
2899 * @oper: WNM operation. See %enum wnm_oper
2900 * @peer: Destination (peer) MAC address
2901 * @buf: Buffer for the driver to fill in (for getting IE)
2902 * @buf_len: Return the len of buf
2903 * Returns: 0 on success, negative (<0) on failure
2905 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2906 u8 *buf, u16 *buf_len);
2909 * set_qos_map - Set QoS Map
2910 * @priv: Private driver interface data
2911 * @qos_map_set: QoS Map
2912 * @qos_map_set_len: Length of QoS Map
2914 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2915 u8 qos_map_set_len);
2918 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2919 * @priv: Private driver interface data
2920 * @version: IP version of the IP address, 4 or 6
2921 * @ipaddr: IP address for the neigh entry
2922 * @prefixlen: IP address prefix length
2923 * @addr: Corresponding MAC address
2924 * Returns: 0 on success, negative (<0) on failure
2926 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2927 int prefixlen, const u8 *addr);
2930 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2931 * @priv: Private driver interface data
2932 * @version: IP version of the IP address, 4 or 6
2933 * @ipaddr: IP address for the neigh entry
2934 * Returns: 0 on success, negative (<0) on failure
2936 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2939 * br_port_set_attr - Set a bridge port attribute
2940 * @attr: Bridge port attribute to set
2941 * @val: Value to be set
2942 * Returns: 0 on success, negative (<0) on failure
2944 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2948 * br_port_set_attr - Set a bridge network parameter
2949 * @param: Bridge parameter to set
2950 * @val: Value to be set
2951 * Returns: 0 on success, negative (<0) on failure
2953 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2957 * set_wowlan - Set wake-on-wireless triggers
2958 * @priv: Private driver interface data
2959 * @triggers: wowlan triggers
2961 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2964 * signal_poll - Get current connection information
2965 * @priv: Private driver interface data
2966 * @signal_info: Connection info structure
2968 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2971 * set_authmode - Set authentication algorithm(s) for static WEP
2972 * @priv: Private driver interface data
2973 * @authmode: 1=Open System, 2=Shared Key, 3=both
2974 * Returns: 0 on success, -1 on failure
2976 * This function can be used to set authentication algorithms for AP
2977 * mode when static WEP is used. If the driver uses user space MLME/SME
2978 * implementation, there is no need to implement this function.
2980 * DEPRECATED - use set_ap() instead
2982 int (*set_authmode)(void *priv, int authmode);
2986 * driver_cmd - Execute driver-specific command
2987 * @priv: Private driver interface data
2988 * @cmd: Command to execute
2989 * @buf: Return buffer
2990 * @buf_len: Buffer length
2991 * Returns: 0 on success, -1 on failure
2993 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2994 #endif /* ANDROID */
2997 * vendor_cmd - Execute vendor specific command
2998 * @priv: Private driver interface data
2999 * @vendor_id: Vendor id
3000 * @subcmd: Vendor command id
3001 * @data: Vendor command parameters (%NULL if no parameters)
3002 * @data_len: Data length
3003 * @buf: Return buffer (%NULL to ignore reply)
3004 * Returns: 0 on success, negative (<0) on failure
3006 * This function handles vendor specific commands that are passed to
3007 * the driver/device. The command is identified by vendor id and
3008 * command id. Parameters can be passed as argument to the command
3009 * in the data buffer. Reply (if any) will be filled in the supplied
3012 * The exact driver behavior is driver interface and vendor specific. As
3013 * an example, this will be converted to a vendor specific cfg80211
3014 * command in case of the nl80211 driver interface.
3016 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3017 unsigned int subcmd, const u8 *data, size_t data_len,
3018 struct wpabuf *buf);
3021 * set_rekey_info - Set rekey information
3022 * @priv: Private driver interface data
3024 * @kek_len: KEK length in octets
3026 * @kck_len: KCK length in octets
3027 * @replay_ctr: Current EAPOL-Key Replay Counter
3029 * This optional function can be used to provide information for the
3030 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3031 * while the host (including wpa_supplicant) is sleeping.
3033 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3034 const u8 *kck, size_t kck_len,
3035 const u8 *replay_ctr);
3038 * sta_assoc - Station association indication
3039 * @priv: Private driver interface data
3040 * @own_addr: Source address and BSSID for association frame
3041 * @addr: MAC address of the station to associate
3042 * @reassoc: flag to indicate re-association
3043 * @status: association response status code
3044 * @ie: assoc response ie buffer
3045 * @len: ie buffer length
3046 * Returns: 0 on success, -1 on failure
3048 * This function indicates the driver to send (Re)Association
3049 * Response frame to the station.
3051 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3052 int reassoc, u16 status, const u8 *ie, size_t len);
3055 * sta_auth - Station authentication indication
3056 * @priv: Private driver interface data
3057 * @own_addr: Source address and BSSID for authentication frame
3058 * @addr: MAC address of the station to associate
3059 * @seq: authentication sequence number
3060 * @status: authentication response status code
3061 * @ie: authentication frame ie buffer
3062 * @len: ie buffer length
3064 * This function indicates the driver to send Authentication frame
3067 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
3068 u16 seq, u16 status, const u8 *ie, size_t len);
3071 * add_tspec - Add traffic stream
3072 * @priv: Private driver interface data
3073 * @addr: MAC address of the station to associate
3074 * @tspec_ie: tspec ie buffer
3075 * @tspec_ielen: tspec ie length
3076 * Returns: 0 on success, -1 on failure
3078 * This function adds the traffic steam for the station
3079 * and fills the medium_time in tspec_ie.
3081 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3082 size_t tspec_ielen);
3085 * add_sta_node - Add a station node in the driver
3086 * @priv: Private driver interface data
3087 * @addr: MAC address of the station to add
3088 * @auth_alg: authentication algorithm used by the station
3089 * Returns: 0 on success, -1 on failure
3091 * This function adds the station node in the driver, when
3092 * the station gets added by FT-over-DS.
3094 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
3097 * sched_scan - Request the driver to initiate scheduled scan
3098 * @priv: Private driver interface data
3099 * @params: Scan parameters
3100 * Returns: 0 on success, -1 on failure
3102 * This operation should be used for scheduled scan offload to
3103 * the hardware. Every time scan results are available, the
3104 * driver should report scan results event for wpa_supplicant
3105 * which will eventually request the results with
3106 * wpa_driver_get_scan_results2(). This operation is optional
3107 * and if not provided or if it returns -1, we fall back to
3108 * normal host-scheduled scans.
3110 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
3113 * stop_sched_scan - Request the driver to stop a scheduled scan
3114 * @priv: Private driver interface data
3115 * Returns: 0 on success, -1 on failure
3117 * This should cause the scheduled scan to be stopped and
3118 * results should stop being sent. Must be supported if
3119 * sched_scan is supported.
3121 int (*stop_sched_scan)(void *priv);
3124 * poll_client - Probe (null data or such) the given station
3125 * @priv: Private driver interface data
3126 * @own_addr: MAC address of sending interface
3127 * @addr: MAC address of the station to probe
3128 * @qos: Indicates whether station is QoS station
3130 * This function is used to verify whether an associated station is
3131 * still present. This function does not need to be implemented if the
3132 * driver provides such inactivity polling mechanism.
3134 void (*poll_client)(void *priv, const u8 *own_addr,
3135 const u8 *addr, int qos);
3138 * radio_disable - Disable/enable radio
3139 * @priv: Private driver interface data
3140 * @disabled: 1=disable 0=enable radio
3141 * Returns: 0 on success, -1 on failure
3143 * This optional command is for testing purposes. It can be used to
3144 * disable the radio on a testbed device to simulate out-of-radio-range
3147 int (*radio_disable)(void *priv, int disabled);
3150 * switch_channel - Announce channel switch and migrate the GO to the
3152 * @priv: Private driver interface data
3153 * @settings: Settings for CSA period and new channel
3154 * Returns: 0 on success, -1 on failure
3156 * This function is used to move the GO to the legacy STA channel to
3157 * avoid frequency conflict in single channel concurrency.
3159 int (*switch_channel)(void *priv, struct csa_settings *settings);
3162 * add_tx_ts - Add traffic stream
3163 * @priv: Private driver interface data
3164 * @tsid: Traffic stream ID
3165 * @addr: Receiver address
3166 * @user_prio: User priority of the traffic stream
3167 * @admitted_time: Admitted time for this TS in units of
3168 * 32 microsecond periods (per second).
3169 * Returns: 0 on success, -1 on failure
3171 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3175 * del_tx_ts - Delete traffic stream
3176 * @priv: Private driver interface data
3177 * @tsid: Traffic stream ID
3178 * @addr: Receiver address
3179 * Returns: 0 on success, -1 on failure
3181 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3184 * Enable channel-switching with TDLS peer
3185 * @priv: Private driver interface data
3186 * @addr: MAC address of the TDLS peer
3187 * @oper_class: Operating class of the switch channel
3188 * @params: Channel specification
3189 * Returns: 0 on success, -1 on failure
3191 * The function indicates to driver that it can start switching to a
3192 * different channel with a specified TDLS peer. The switching is
3193 * assumed on until canceled with tdls_disable_channel_switch().
3195 int (*tdls_enable_channel_switch)(
3196 void *priv, const u8 *addr, u8 oper_class,
3197 const struct hostapd_freq_params *params);
3200 * Disable channel switching with TDLS peer
3201 * @priv: Private driver interface data
3202 * @addr: MAC address of the TDLS peer
3203 * Returns: 0 on success, -1 on failure
3205 * This function indicates to the driver that it should stop switching
3206 * with a given TDLS peer.
3208 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3211 * start_dfs_cac - Listen for radar interference on the channel
3212 * @priv: Private driver interface data
3213 * @freq: Channel parameters
3214 * Returns: 0 on success, -1 on failure
3216 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
3219 * stop_ap - Removes beacon from AP
3220 * @priv: Private driver interface data
3221 * Returns: 0 on success, -1 on failure (or if not supported)
3223 * This optional function can be used to disable AP mode related
3224 * configuration. Unlike deinit_ap, it does not change to station
3227 int (*stop_ap)(void *priv);
3230 * get_survey - Retrieve survey data
3231 * @priv: Private driver interface data
3232 * @freq: If set, survey data for the specified frequency is only
3233 * being requested. If not set, all survey data is requested.
3234 * Returns: 0 on success, -1 on failure
3236 * Use this to retrieve:
3238 * - the observed channel noise floor
3239 * - the amount of time we have spent on the channel
3240 * - the amount of time during which we have spent on the channel that
3241 * the radio has determined the medium is busy and we cannot
3243 * - the amount of time we have spent receiving data
3244 * - the amount of time we have spent transmitting data
3246 * This data can be used for spectrum heuristics. One example is
3247 * Automatic Channel Selection (ACS). The channel survey data is
3248 * kept on a linked list on the channel data, one entry is added
3249 * for each survey. The min_nf of the channel is updated for each
3252 int (*get_survey)(void *priv, unsigned int freq);
3255 * status - Get driver interface status information
3256 * @priv: Private driver interface data
3257 * @buf: Buffer for printing tou the status information
3258 * @buflen: Maximum length of the buffer
3259 * Returns: Length of written status information or -1 on failure
3261 int (*status)(void *priv, char *buf, size_t buflen);
3264 * roaming - Set roaming policy for driver-based BSS selection
3265 * @priv: Private driver interface data
3266 * @allowed: Whether roaming within ESS is allowed
3267 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3268 * Returns: Length of written status information or -1 on failure
3270 * This optional callback can be used to update roaming policy from the
3271 * associate() command (bssid being set there indicates that the driver
3272 * should not roam before getting this roaming() call to allow roaming.
3273 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3274 * capability, roaming policy is handled within wpa_supplicant and there
3275 * is no need to implement or react to this callback.
3277 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3280 * set_mac_addr - Set MAC address
3281 * @priv: Private driver interface data
3282 * @addr: MAC address to use or %NULL for setting back to permanent
3283 * Returns: 0 on success, -1 on failure
3285 int (*set_mac_addr)(void *priv, const u8 *addr);
3287 #ifdef CONFIG_MACSEC
3288 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3290 int (*macsec_deinit)(void *priv);
3293 * enable_protect_frames - Set protect frames status
3294 * @priv: Private driver interface data
3295 * @enabled: TRUE = protect frames enabled
3296 * FALSE = protect frames disabled
3297 * Returns: 0 on success, -1 on failure (or if not supported)
3299 int (*enable_protect_frames)(void *priv, Boolean enabled);
3302 * set_replay_protect - Set replay protect status and window size
3303 * @priv: Private driver interface data
3304 * @enabled: TRUE = replay protect enabled
3305 * FALSE = replay protect disabled
3306 * @window: replay window size, valid only when replay protect enabled
3307 * Returns: 0 on success, -1 on failure (or if not supported)
3309 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3312 * set_current_cipher_suite - Set current cipher suite
3313 * @priv: Private driver interface data
3314 * @cs: EUI64 identifier
3315 * @cs_len: Length of the cs buffer in octets
3316 * Returns: 0 on success, -1 on failure (or if not supported)
3318 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3322 * enable_controlled_port - Set controlled port status
3323 * @priv: Private driver interface data
3324 * @enabled: TRUE = controlled port enabled
3325 * FALSE = controlled port disabled
3326 * Returns: 0 on success, -1 on failure (or if not supported)
3328 int (*enable_controlled_port)(void *priv, Boolean enabled);
3331 * get_receive_lowest_pn - Get receive lowest pn
3332 * @priv: Private driver interface data
3333 * @channel: secure channel
3334 * @an: association number
3335 * @lowest_pn: lowest accept pn
3336 * Returns: 0 on success, -1 on failure (or if not supported)
3338 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3342 * get_transmit_next_pn - Get transmit next pn
3343 * @priv: Private driver interface data
3344 * @channel: secure channel
3345 * @an: association number
3347 * Returns: 0 on success, -1 on failure (or if not supported)
3349 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3353 * set_transmit_next_pn - Set transmit next pn
3354 * @priv: Private driver interface data
3355 * @channel: secure channel
3356 * @an: association number
3358 * Returns: 0 on success, -1 on failure (or if not supported)
3360 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3364 * get_available_receive_sc - get available receive channel
3365 * @priv: Private driver interface data
3366 * @channel: secure channel
3367 * Returns: 0 on success, -1 on failure (or if not supported)
3369 int (*get_available_receive_sc)(void *priv, u32 *channel);
3372 * create_receive_sc - create secure channel for receiving
3373 * @priv: Private driver interface data
3374 * @channel: secure channel
3375 * @sci_addr: secure channel identifier - address
3376 * @sci_port: secure channel identifier - port
3377 * @conf_offset: confidentiality offset (0, 30, or 50)
3378 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3380 * Returns: 0 on success, -1 on failure (or if not supported)
3382 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3383 u16 sci_port, unsigned int conf_offset,
3387 * delete_receive_sc - delete secure connection for receiving
3388 * @priv: private driver interface data from init()
3389 * @channel: secure channel
3390 * Returns: 0 on success, -1 on failure
3392 int (*delete_receive_sc)(void *priv, u32 channel);
3395 * create_receive_sa - create secure association for receive
3396 * @priv: private driver interface data from init()
3397 * @channel: secure channel
3398 * @an: association number
3399 * @lowest_pn: the lowest packet number can be received
3400 * @sak: the secure association key
3401 * Returns: 0 on success, -1 on failure
3403 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3404 u32 lowest_pn, const u8 *sak);
3407 * enable_receive_sa - enable the SA for receive
3408 * @priv: private driver interface data from init()
3409 * @channel: secure channel
3410 * @an: association number
3411 * Returns: 0 on success, -1 on failure
3413 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3416 * disable_receive_sa - disable SA for receive
3417 * @priv: private driver interface data from init()
3418 * @channel: secure channel index
3419 * @an: association number
3420 * Returns: 0 on success, -1 on failure
3422 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3425 * get_available_transmit_sc - get available transmit channel
3426 * @priv: Private driver interface data
3427 * @channel: secure channel
3428 * Returns: 0 on success, -1 on failure (or if not supported)
3430 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3433 * create_transmit_sc - create secure connection for transmit
3434 * @priv: private driver interface data from init()
3435 * @channel: secure channel
3436 * @sci_addr: secure channel identifier - address
3437 * @sci_port: secure channel identifier - port
3438 * Returns: 0 on success, -1 on failure
3440 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3441 u16 sci_port, unsigned int conf_offset);
3444 * delete_transmit_sc - delete secure connection for transmit
3445 * @priv: private driver interface data from init()
3446 * @channel: secure channel
3447 * Returns: 0 on success, -1 on failure
3449 int (*delete_transmit_sc)(void *priv, u32 channel);
3452 * create_transmit_sa - create secure association for transmit
3453 * @priv: private driver interface data from init()
3454 * @channel: secure channel index
3455 * @an: association number
3456 * @next_pn: the packet number used as next transmit packet
3457 * @confidentiality: True if the SA is to provide confidentiality
3458 * as well as integrity
3459 * @sak: the secure association key
3460 * Returns: 0 on success, -1 on failure
3462 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3463 Boolean confidentiality, const u8 *sak);
3466 * enable_transmit_sa - enable SA for transmit
3467 * @priv: private driver interface data from init()
3468 * @channel: secure channel
3469 * @an: association number
3470 * Returns: 0 on success, -1 on failure
3472 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3475 * disable_transmit_sa - disable SA for transmit
3476 * @priv: private driver interface data from init()
3477 * @channel: secure channel
3478 * @an: association number
3479 * Returns: 0 on success, -1 on failure
3481 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3482 #endif /* CONFIG_MACSEC */
3485 * init_mesh - Driver specific initialization for mesh
3486 * @priv: Private driver interface data
3487 * Returns: 0 on success, -1 on failure
3489 int (*init_mesh)(void *priv);
3492 * join_mesh - Join a mesh network
3493 * @priv: Private driver interface data
3494 * @params: Mesh configuration parameters
3495 * Returns: 0 on success, -1 on failure
3497 int (*join_mesh)(void *priv,
3498 struct wpa_driver_mesh_join_params *params);
3501 * leave_mesh - Leave a mesh network
3502 * @priv: Private driver interface data
3503 * Returns 0 on success, -1 on failure
3505 int (*leave_mesh)(void *priv);
3508 * do_acs - Automatically select channel
3509 * @priv: Private driver interface data
3510 * @params: Parameters for ACS
3511 * Returns 0 on success, -1 on failure
3513 * This command can be used to offload ACS to the driver if the driver
3514 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3516 int (*do_acs)(void *priv, struct drv_acs_params *params);
3519 * set_band - Notify driver of band selection
3520 * @priv: Private driver interface data
3521 * @band: The selected band(s)
3522 * Returns 0 on success, -1 on failure
3524 int (*set_band)(void *priv, enum set_band band);
3527 * get_pref_freq_list - Get preferred frequency list for an interface
3528 * @priv: Private driver interface data
3529 * @if_type: Interface type
3530 * @num: Number of channels
3531 * @freq_list: Preferred channel frequency list encoded in MHz values
3532 * Returns 0 on success, -1 on failure
3534 * This command can be used to query the preferred frequency list from
3535 * the driver specific to a particular interface type.
3537 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
3538 unsigned int *num, unsigned int *freq_list);
3541 * set_prob_oper_freq - Indicate probable P2P operating channel
3542 * @priv: Private driver interface data
3543 * @freq: Channel frequency in MHz
3544 * Returns 0 on success, -1 on failure
3546 * This command can be used to inform the driver of the operating
3547 * frequency that an ongoing P2P group formation is likely to come up
3548 * on. Local device is assuming P2P Client role.
3550 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
3553 * abort_scan - Request the driver to abort an ongoing scan
3554 * @priv: Private driver interface data
3555 * Returns 0 on success, -1 on failure
3557 int (*abort_scan)(void *priv);
3560 * configure_data_frame_filters - Request to configure frame filters
3561 * @priv: Private driver interface data
3562 * @filter_flags: The type of frames to filter (bitfield of
3563 * WPA_DATA_FRAME_FILTER_FLAG_*)
3564 * Returns: 0 on success or -1 on failure
3566 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
3569 * get_ext_capab - Get extended capabilities for the specified interface
3570 * @priv: Private driver interface data
3571 * @type: Interface type for which to get extended capabilities
3572 * @ext_capab: Extended capabilities fetched
3573 * @ext_capab_mask: Extended capabilities mask
3574 * @ext_capab_len: Length of the extended capabilities
3575 * Returns: 0 on success or -1 on failure
3577 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
3578 const u8 **ext_capab, const u8 **ext_capab_mask,
3579 unsigned int *ext_capab_len);
3582 * p2p_lo_start - Start offloading P2P listen to device
3583 * @priv: Private driver interface data
3584 * @freq: Listening frequency (MHz) for P2P listen
3585 * @period: Length of the listen operation in milliseconds
3586 * @interval: Interval for running the listen operation in milliseconds
3587 * @count: Number of times to run the listen operation
3588 * @device_types: Device primary and secondary types
3589 * @dev_types_len: Number of bytes for device_types
3590 * @ies: P2P IE and WSC IE for Probe Response frames
3591 * @ies_len: Length of ies in bytes
3592 * Returns: 0 on success or -1 on failure
3594 int (*p2p_lo_start)(void *priv, unsigned int freq,
3595 unsigned int period, unsigned int interval,
3597 const u8 *device_types, size_t dev_types_len,
3598 const u8 *ies, size_t ies_len);
3601 * p2p_lo_stop - Stop P2P listen offload
3602 * @priv: Private driver interface data
3603 * Returns: 0 on success or -1 on failure
3605 int (*p2p_lo_stop)(void *priv);
3608 * set_default_scan_ies - Set default scan IEs
3609 * @priv: Private driver interface data
3610 * @ies: Scan default IEs buffer
3611 * @ies_len: Length of IEs in bytes
3612 * Returns: 0 on success or -1 on failure
3614 * The driver can use these by default when there are no scan IEs coming
3615 * in the subsequent scan requests. Also in case of one or more of IEs
3616 * given in set_default_scan_ies() are missing in the subsequent scan
3617 * request, the driver should merge the missing scan IEs in the scan
3618 * request from the IEs set by set_default_scan_ies() in the Probe
3619 * Request frames sent.
3621 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
3627 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3629 enum wpa_event_type {
3631 * EVENT_ASSOC - Association completed
3633 * This event needs to be delivered when the driver completes IEEE
3634 * 802.11 association or reassociation successfully.
3635 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3636 * after this event has been generated. In addition, optional
3637 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3638 * more information about the association. If the driver interface gets
3639 * both of these events at the same time, it can also include the
3640 * assoc_info data in EVENT_ASSOC call.
3645 * EVENT_DISASSOC - Association lost
3647 * This event should be called when association is lost either due to
3648 * receiving deauthenticate or disassociate frame from the AP or when
3649 * sending either of these frames to the current AP. If the driver
3650 * supports separate deauthentication event, EVENT_DISASSOC should only
3651 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3652 * In AP mode, union wpa_event_data::disassoc_info is required.
3657 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3659 * This event must be delivered when a Michael MIC error is detected by
3660 * the local driver. Additional data for event processing is
3661 * provided with union wpa_event_data::michael_mic_failure. This
3662 * information is used to request new encyption key and to initiate
3663 * TKIP countermeasures if needed.
3665 EVENT_MICHAEL_MIC_FAILURE,
3668 * EVENT_SCAN_RESULTS - Scan results available
3670 * This event must be called whenever scan results are available to be
3671 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3672 * is expected to be used some time after struct wpa_driver_ops::scan()
3673 * is called. If the driver provides an unsolicited event when the scan
3674 * has been completed, this event can be used to trigger
3675 * EVENT_SCAN_RESULTS call. If such event is not available from the
3676 * driver, the driver wrapper code is expected to use a registered
3677 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3678 * scan is expected to be completed. Optional information about
3679 * completed scan can be provided with union wpa_event_data::scan_info.
3684 * EVENT_ASSOCINFO - Report optional extra information for association
3686 * This event can be used to report extra association information for
3687 * EVENT_ASSOC processing. This extra information includes IEs from
3688 * association frames and Beacon/Probe Response frames in union
3689 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3690 * EVENT_ASSOC. Alternatively, the driver interface can include
3691 * assoc_info data in the EVENT_ASSOC call if it has all the
3692 * information available at the same point.
3697 * EVENT_INTERFACE_STATUS - Report interface status changes
3699 * This optional event can be used to report changes in interface
3700 * status (interface added/removed) using union
3701 * wpa_event_data::interface_status. This can be used to trigger
3702 * wpa_supplicant to stop and re-start processing for the interface,
3703 * e.g., when a cardbus card is ejected/inserted.
3705 EVENT_INTERFACE_STATUS,
3708 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3710 * This event can be used to inform wpa_supplicant about candidates for
3711 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3712 * for scan request (ap_scan=2 mode), this event is required for
3713 * pre-authentication. If wpa_supplicant is performing scan request
3714 * (ap_scan=1), this event is optional since scan results can be used
3715 * to add pre-authentication candidates. union
3716 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3717 * candidate and priority of the candidate, e.g., based on the signal
3718 * strength, in order to try to pre-authenticate first with candidates
3719 * that are most likely targets for re-association.
3721 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3722 * on the candidate list. In addition, it can be called for the current
3723 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3724 * will automatically skip pre-authentication in cases where a valid
3725 * PMKSA exists. When more than one candidate exists, this event should
3726 * be generated once for each candidate.
3728 * Driver will be notified about successful pre-authentication with
3729 * struct wpa_driver_ops::add_pmkid() calls.
3731 EVENT_PMKID_CANDIDATE,
3734 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3736 * This event can be used to inform wpa_supplicant about desire to set
3737 * up secure direct link connection between two stations as defined in
3738 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3739 * STAKey negotiation. The caller will need to set peer address for the
3745 * EVENT_TDLS - Request TDLS operation
3747 * This event can be used to request a TDLS operation to be performed.
3752 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3754 * The driver is expected to report the received FT IEs from
3755 * FT authentication sequence from the AP. The FT IEs are included in
3756 * the extra information in union wpa_event_data::ft_ies.
3761 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3763 * The driver can use this event to inform wpa_supplicant about a STA
3764 * in an IBSS with which protected frames could be exchanged. This
3765 * event starts RSN authentication with the other STA to authenticate
3766 * the STA and set up encryption keys with it.
3768 EVENT_IBSS_RSN_START,
3771 * EVENT_AUTH - Authentication result
3773 * This event should be called when authentication attempt has been
3774 * completed. This is only used if the driver supports separate
3775 * authentication step (struct wpa_driver_ops::authenticate).
3776 * Information about authentication result is included in
3777 * union wpa_event_data::auth.
3782 * EVENT_DEAUTH - Authentication lost
3784 * This event should be called when authentication is lost either due
3785 * to receiving deauthenticate frame from the AP or when sending that
3786 * frame to the current AP.
3787 * In AP mode, union wpa_event_data::deauth_info is required.
3792 * EVENT_ASSOC_REJECT - Association rejected
3794 * This event should be called when (re)association attempt has been
3795 * rejected by the AP. Information about the association response is
3796 * included in union wpa_event_data::assoc_reject.
3801 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3803 EVENT_AUTH_TIMED_OUT,
3806 * EVENT_ASSOC_TIMED_OUT - Association timed out
3808 EVENT_ASSOC_TIMED_OUT,
3811 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3813 EVENT_WPS_BUTTON_PUSHED,
3816 * EVENT_TX_STATUS - Report TX status
3821 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3823 EVENT_RX_FROM_UNKNOWN,
3826 * EVENT_RX_MGMT - Report RX of a management frame
3831 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3833 * This event is used to indicate when the driver has started the
3834 * requested remain-on-channel duration. Information about the
3835 * operation is included in union wpa_event_data::remain_on_channel.
3837 EVENT_REMAIN_ON_CHANNEL,
3840 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3842 * This event is used to indicate when the driver has completed
3843 * remain-on-channel duration, i.e., may noot be available on the
3844 * requested channel anymore. Information about the
3845 * operation is included in union wpa_event_data::remain_on_channel.
3847 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3850 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3852 * This event is used to indicate when a Probe Request frame has been
3853 * received. Information about the received frame is included in
3854 * union wpa_event_data::rx_probe_req. The driver is required to report
3855 * these events only after successfully completed probe_req_report()
3856 * commands to request the events (i.e., report parameter is non-zero)
3857 * in station mode. In AP mode, Probe Request frames should always be
3863 * EVENT_NEW_STA - New wired device noticed
3865 * This event is used to indicate that a new device has been detected
3866 * in a network that does not use association-like functionality (i.e.,
3867 * mainly wired Ethernet). This can be used to start EAPOL
3868 * authenticator when receiving a frame from a device. The address of
3869 * the device is included in union wpa_event_data::new_sta.
3874 * EVENT_EAPOL_RX - Report received EAPOL frame
3876 * When in AP mode with hostapd, this event is required to be used to
3877 * deliver the receive EAPOL frames from the driver.
3882 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3884 * This event is used to indicate changes in the signal strength
3885 * observed in frames received from the current AP if signal strength
3886 * monitoring has been enabled with signal_monitor().
3888 EVENT_SIGNAL_CHANGE,
3891 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3893 * This event is used to indicate that the interface was enabled after
3894 * having been previously disabled, e.g., due to rfkill.
3896 EVENT_INTERFACE_ENABLED,
3899 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3901 * This event is used to indicate that the interface was disabled,
3902 * e.g., due to rfkill.
3904 EVENT_INTERFACE_DISABLED,
3907 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3909 * This event is used to indicate that the channel list has changed,
3910 * e.g., because of a regulatory domain change triggered by scan
3911 * results including an AP advertising a country code.
3913 EVENT_CHANNEL_LIST_CHANGED,
3916 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3918 * This event is used to indicate that the driver cannot maintain this
3919 * interface in its operation mode anymore. The most likely use for
3920 * this is to indicate that AP mode operation is not available due to
3921 * operating channel would need to be changed to a DFS channel when
3922 * the driver does not support radar detection and another virtual
3923 * interfaces caused the operating channel to change. Other similar
3924 * resource conflicts could also trigger this for station mode
3925 * interfaces. This event can be propagated when channel switching
3928 EVENT_INTERFACE_UNAVAILABLE,
3931 * EVENT_BEST_CHANNEL
3933 * Driver generates this event whenever it detects a better channel
3934 * (e.g., based on RSSI or channel use). This information can be used
3935 * to improve channel selection for a new AP/P2P group.
3940 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3942 * This event should be called when a Deauthentication frame is dropped
3943 * due to it not being protected (MFP/IEEE 802.11w).
3944 * union wpa_event_data::unprot_deauth is required to provide more
3945 * details of the frame.
3947 EVENT_UNPROT_DEAUTH,
3950 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3952 * This event should be called when a Disassociation frame is dropped
3953 * due to it not being protected (MFP/IEEE 802.11w).
3954 * union wpa_event_data::unprot_disassoc is required to provide more
3955 * details of the frame.
3957 EVENT_UNPROT_DISASSOC,
3960 * EVENT_STATION_LOW_ACK
3962 * Driver generates this event whenever it detected that a particular
3963 * station was lost. Detection can be through massive transmission
3964 * failures for example.
3966 EVENT_STATION_LOW_ACK,
3969 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3971 EVENT_IBSS_PEER_LOST,
3974 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3976 * This event carries the new replay counter to notify wpa_supplicant
3977 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3978 * completed Group Key Handshake while the host (including
3979 * wpa_supplicant was sleeping).
3981 EVENT_DRIVER_GTK_REKEY,
3984 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3986 EVENT_SCHED_SCAN_STOPPED,
3989 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3991 * This event indicates that the station responded to the poll
3992 * initiated with @poll_client.
3994 EVENT_DRIVER_CLIENT_POLL_OK,
3997 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3999 EVENT_EAPOL_TX_STATUS,
4002 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4004 * Described in wpa_event_data.ch_switch
4009 * EVENT_WNM - Request WNM operation
4011 * This event can be used to request a WNM operation to be performed.
4016 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4018 * This event indicates that the driver reported a connection failure
4019 * with the specified client (for example, max client reached, etc.) in
4022 EVENT_CONNECT_FAILED_REASON,
4025 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
4027 * A radar has been detected on the supplied frequency, hostapd should
4028 * react accordingly (e.g., change channel).
4030 EVENT_DFS_RADAR_DETECTED,
4033 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
4035 * After a successful CAC, the channel can be marked clear and used.
4037 EVENT_DFS_CAC_FINISHED,
4040 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
4042 * The CAC was not successful, and the channel remains in the previous
4043 * state. This may happen due to a radar beeing detected or other
4044 * external influences.
4046 EVENT_DFS_CAC_ABORTED,
4049 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
4051 * The channel which was previously unavailable is now available again.
4053 EVENT_DFS_NOP_FINISHED,
4056 * EVENT_SURVEY - Received survey data
4058 * This event gets triggered when a driver query is issued for survey
4059 * data and the requested data becomes available. The returned data is
4060 * stored in struct survey_results. The results provide at most one
4061 * survey entry for each frequency and at minimum will provide one
4062 * survey entry for one frequency. The survey data can be os_malloc()'d
4063 * and then os_free()'d, so the event callback must only copy data.
4068 * EVENT_SCAN_STARTED - Scan started
4070 * This indicates that driver has started a scan operation either based
4071 * on a request from wpa_supplicant/hostapd or from another application.
4072 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4073 * completed (either successfully or by getting cancelled).
4078 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4080 * This event indicates a set of frequency ranges that should be avoided
4081 * to reduce issues due to interference or internal co-existence
4082 * information in the driver.
4084 EVENT_AVOID_FREQUENCIES,
4087 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4089 EVENT_NEW_PEER_CANDIDATE,
4092 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4094 * Indicates a pair of primary and secondary channels chosen by ACS
4097 EVENT_ACS_CHANNEL_SELECTED,
4100 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4103 * This event indicates that channel availability check has been started
4104 * on a DFS frequency by a driver that supports DFS Offload.
4106 EVENT_DFS_CAC_STARTED,
4109 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4116 * struct freq_survey - Channel survey info
4118 * @ifidx: Interface index in which this survey was observed
4119 * @freq: Center of frequency of the surveyed channel
4120 * @nf: Channel noise floor in dBm
4121 * @channel_time: Amount of time in ms the radio spent on the channel
4122 * @channel_time_busy: Amount of time in ms the radio detected some signal
4123 * that indicated to the radio the channel was not clear
4124 * @channel_time_rx: Amount of time the radio spent receiving data
4125 * @channel_time_tx: Amount of time the radio spent transmitting data
4126 * @filled: bitmask indicating which fields have been reported, see
4127 * SURVEY_HAS_* defines.
4128 * @list: Internal list pointers
4130 struct freq_survey {
4135 u64 channel_time_busy;
4136 u64 channel_time_rx;
4137 u64 channel_time_tx;
4138 unsigned int filled;
4139 struct dl_list list;
4142 #define SURVEY_HAS_NF BIT(0)
4143 #define SURVEY_HAS_CHAN_TIME BIT(1)
4144 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4145 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4146 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4150 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4152 union wpa_event_data {
4154 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4156 * This structure is optional for EVENT_ASSOC calls and required for
4157 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4158 * driver interface does not need to generate separate EVENT_ASSOCINFO
4163 * reassoc - Flag to indicate association or reassociation
4168 * req_ies - (Re)Association Request IEs
4170 * If the driver generates WPA/RSN IE, this event data must be
4171 * returned for WPA handshake to have needed information. If
4172 * wpa_supplicant-generated WPA/RSN IE is used, this
4173 * information event is optional.
4175 * This should start with the first IE (fixed fields before IEs
4176 * are not included).
4181 * req_ies_len - Length of req_ies in bytes
4186 * resp_ies - (Re)Association Response IEs
4188 * Optional association data from the driver. This data is not
4189 * required WPA, but may be useful for some protocols and as
4190 * such, should be reported if this is available to the driver
4193 * This should start with the first IE (fixed fields before IEs
4194 * are not included).
4199 * resp_ies_len - Length of resp_ies in bytes
4201 size_t resp_ies_len;
4204 * beacon_ies - Beacon or Probe Response IEs
4206 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4207 * Probe Response frames from the current AP (i.e., the one
4208 * that the client just associated with). This information is
4209 * used to update WPA/RSN IE for the AP. If this field is not
4210 * set, the results from previous scan will be used. If no
4211 * data for the new AP is found, scan results will be requested
4212 * again (without scan request). At this point, the driver is
4213 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4216 * This should start with the first IE (fixed fields before IEs
4217 * are not included).
4219 const u8 *beacon_ies;
4222 * beacon_ies_len - Length of beacon_ies */
4223 size_t beacon_ies_len;
4226 * freq - Frequency of the operational channel in MHz
4231 * wmm_params - WMM parameters used in this association.
4233 struct wmm_params wmm_params;
4236 * addr - Station address (for AP mode)
4241 * The following is the key management offload information
4244 * @key_replay_ctr_len
4252 * authorized - Status of key management offload,
4258 * key_replay_ctr - Key replay counter value last used
4259 * in a valid EAPOL-Key frame
4261 const u8 *key_replay_ctr;
4264 * key_replay_ctr_len - The length of key_replay_ctr
4266 size_t key_replay_ctr_len;
4269 * ptk_kck - The derived PTK KCK
4274 * ptk_kek_len - The length of ptk_kck
4279 * ptk_kek - The derived PTK KEK
4284 * ptk_kek_len - The length of ptk_kek
4289 * subnet_status - The subnet status:
4290 * 0 = unknown, 1 = unchanged, 2 = changed
4296 * struct disassoc_info - Data for EVENT_DISASSOC events
4298 struct disassoc_info {
4300 * addr - Station address (for AP mode)
4305 * reason_code - Reason Code (host byte order) used in
4306 * Deauthentication frame
4311 * ie - Optional IE(s) in Disassociation frame
4316 * ie_len - Length of ie buffer in octets
4321 * locally_generated - Whether the frame was locally generated
4323 int locally_generated;
4327 * struct deauth_info - Data for EVENT_DEAUTH events
4329 struct deauth_info {
4331 * addr - Station address (for AP mode)
4336 * reason_code - Reason Code (host byte order) used in
4337 * Deauthentication frame
4342 * ie - Optional IE(s) in Deauthentication frame
4347 * ie_len - Length of ie buffer in octets
4352 * locally_generated - Whether the frame was locally generated
4354 int locally_generated;
4358 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4360 struct michael_mic_failure {
4363 } michael_mic_failure;
4366 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4368 struct interface_status {
4369 unsigned int ifindex;
4372 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4377 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4379 struct pmkid_candidate {
4380 /** BSSID of the PMKID candidate */
4382 /** Smaller the index, higher the priority */
4384 /** Whether RSN IE includes pre-authenticate flag */
4389 * struct stkstart - Data for EVENT_STKSTART
4396 * struct tdls - Data for EVENT_TDLS
4402 TDLS_REQUEST_TEARDOWN,
4403 TDLS_REQUEST_DISCOVER,
4405 u16 reason_code; /* for teardown */
4409 * struct wnm - Data for EVENT_WNM
4427 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4429 * During FT (IEEE 802.11r) authentication sequence, the driver is
4430 * expected to use this event to report received FT IEs (MDIE, FTIE,
4431 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4432 * IEs for the next message will be delivered through the
4433 * struct wpa_driver_ops::update_ft_ies() callback.
4439 u8 target_ap[ETH_ALEN];
4440 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4442 /** Length of ric_ies buffer in octets */
4447 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4449 struct ibss_rsn_start {
4454 * struct auth_info - Data for EVENT_AUTH events
4460 u16 auth_transaction;
4467 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4469 struct assoc_reject {
4471 * bssid - BSSID of the AP that rejected association
4476 * resp_ies - (Re)Association Response IEs
4478 * Optional association data from the driver. This data is not
4479 * required WPA, but may be useful for some protocols and as
4480 * such, should be reported if this is available to the driver
4483 * This should start with the first IE (fixed fields before IEs
4484 * are not included).
4489 * resp_ies_len - Length of resp_ies in bytes
4491 size_t resp_ies_len;
4494 * status_code - Status Code from (Re)association Response
4499 * timed_out - Whether failure is due to timeout (etc.) rather
4500 * than explicit rejection response from the AP.
4505 struct timeout_event {
4510 * struct tx_status - Data for EVENT_TX_STATUS events
4522 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4524 struct rx_from_unknown {
4531 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4539 * drv_priv - Pointer to store driver private BSS information
4541 * If not set to NULL, this is used for comparison with
4542 * hostapd_data->drv_priv to determine which BSS should process
4548 * freq - Frequency (in MHz) on which the frame was received
4553 * ssi_signal - Signal strength in dBm (or 0 if not available)
4559 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4561 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4563 struct remain_on_channel {
4565 * freq - Channel frequency in MHz
4570 * duration - Duration to remain on the channel in milliseconds
4572 unsigned int duration;
4573 } remain_on_channel;
4576 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4577 * @aborted: Whether the scan was aborted
4578 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4579 * @num_freqs: Number of entries in freqs array
4580 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4582 * @num_ssids: Number of entries in ssids array
4583 * @external_scan: Whether the scan info is for an external scan
4584 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
4585 * 0 if the source of the scan event is a vendor scan
4591 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4598 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4600 struct rx_probe_req {
4602 * sa - Source address of the received Probe Request frame
4607 * da - Destination address of the received Probe Request frame
4608 * or %NULL if not available
4613 * bssid - BSSID of the received Probe Request frame or %NULL
4619 * ie - IEs from the Probe Request body
4624 * ie_len - Length of ie buffer in octets
4629 * signal - signal strength in dBm (or 0 if not available)
4635 * struct new_sta - Data for EVENT_NEW_STA events
4642 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4651 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4653 struct wpa_signal_info signal_change;
4656 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4657 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4658 * @freq_5: Best 5 GHz band channel frequency in MHz
4659 * @freq_overall: Best channel frequency in MHz
4661 * 0 can be used to indicate no preference in either band.
4663 struct best_channel {
4669 struct unprot_deauth {
4675 struct unprot_disassoc {
4682 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4683 * @addr: station address
4690 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4692 struct ibss_peer_lost {
4697 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4699 struct driver_gtk_rekey {
4701 const u8 *replay_ctr;
4705 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4706 * @addr: station address
4708 struct client_poll {
4713 * struct eapol_tx_status
4714 * @dst: Original destination
4715 * @data: Data starting with IEEE 802.1X header (!)
4716 * @data_len: Length of data
4717 * @ack: Indicates ack or lost frame
4719 * This corresponds to hapd_send_eapol if the frame sent
4720 * there isn't just reported as EVENT_TX_STATUS.
4722 struct eapol_tx_status {
4731 * @freq: Frequency of new channel in MHz
4732 * @ht_enabled: Whether this is an HT channel
4733 * @ch_offset: Secondary channel offset
4734 * @ch_width: Channel width
4735 * @cf1: Center frequency 1
4736 * @cf2: Center frequency 2
4742 enum chan_width ch_width;
4748 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4749 * @addr: Remote client address
4750 * @code: Reason code for connection failure
4752 struct connect_failed_reason {
4758 } connect_failed_reason;
4761 * struct dfs_event - Data for radar detected events
4762 * @freq: Frequency of the channel in MHz
4768 enum chan_width chan_width;
4774 * survey_results - Survey result data for EVENT_SURVEY
4775 * @freq_filter: Requested frequency survey filter, 0 if request
4776 * was for all survey data
4777 * @survey_list: Linked list of survey data (struct freq_survey)
4779 struct survey_results {
4780 unsigned int freq_filter;
4781 struct dl_list survey_list; /* struct freq_survey */
4785 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4786 * @initiator: Initiator of the regulatory change
4787 * @type: Regulatory change type
4788 * @alpha2: Country code (or "" if not available)
4790 struct channel_list_changed {
4791 enum reg_change_initiator initiator;
4794 } channel_list_changed;
4797 * freq_range - List of frequency ranges
4799 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4801 struct wpa_freq_range_list freq_range;
4806 * @peer: Peer address
4808 * @ie_len: Length of @ies
4810 * Notification of new candidate mesh peer.
4819 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4820 * @pri_channel: Selected primary channel
4821 * @sec_channel: Selected secondary channel
4822 * @vht_seg0_center_ch: VHT mode Segment0 center channel
4823 * @vht_seg1_center_ch: VHT mode Segment1 center channel
4824 * @ch_width: Selected Channel width by driver. Driver may choose to
4825 * change hostapd configured ACS channel width due driver internal
4826 * channel restrictions.
4827 * hw_mode: Selected band (used with hw_mode=any)
4829 struct acs_selected_channels {
4832 u8 vht_seg0_center_ch;
4833 u8 vht_seg1_center_ch;
4835 enum hostapd_hw_mode hw_mode;
4836 } acs_selected_channels;
4839 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
4840 * @reason_code: Reason for stopping offload
4841 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
4843 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
4845 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
4847 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
4848 * supported by device.
4850 struct p2p_lo_stop {
4852 P2P_LO_STOPPED_REASON_COMPLETE = 0,
4853 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
4854 P2P_LO_STOPPED_REASON_INVALID_PARAM,
4855 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
4861 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4862 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4863 * with struct wpa_driver_ops::init()
4864 * @event: event type (defined above)
4865 * @data: possible extra data for the event
4867 * Driver wrapper code should call this function whenever an event is received
4870 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4871 union wpa_event_data *data);
4874 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
4875 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4876 * with struct wpa_driver_ops::init()
4877 * @event: event type (defined above)
4878 * @data: possible extra data for the event
4880 * Same as wpa_supplicant_event(), but we search for the interface in
4883 void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
4884 union wpa_event_data *data);
4887 * The following inline functions are provided for convenience to simplify
4888 * event indication for some of the common events.
4891 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4892 size_t ielen, int reassoc)
4894 union wpa_event_data event;
4895 os_memset(&event, 0, sizeof(event));
4896 event.assoc_info.reassoc = reassoc;
4897 event.assoc_info.req_ies = ie;
4898 event.assoc_info.req_ies_len = ielen;
4899 event.assoc_info.addr = addr;
4900 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4903 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4905 union wpa_event_data event;
4906 os_memset(&event, 0, sizeof(event));
4907 event.disassoc_info.addr = addr;
4908 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4911 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4914 union wpa_event_data event;
4915 os_memset(&event, 0, sizeof(event));
4916 event.eapol_rx.src = src;
4917 event.eapol_rx.data = data;
4918 event.eapol_rx.data_len = data_len;
4919 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4922 /* driver_common.c */
4923 void wpa_scan_results_free(struct wpa_scan_results *res);
4925 /* Convert wpa_event_type to a string for logging */
4926 const char * event_to_string(enum wpa_event_type event);
4928 /* Convert chan_width to a string for logging and control interfaces */
4929 const char * channel_width_to_string(enum chan_width width);
4931 int ht_supported(const struct hostapd_hw_modes *mode);
4932 int vht_supported(const struct hostapd_hw_modes *mode);
4934 struct wowlan_triggers *
4935 wpa_get_wowlan_triggers(const char *wowlan_triggers,
4936 const struct wpa_driver_capa *capa);
4937 /* Convert driver flag to string */
4938 const char * driver_flag_to_string(u64 flag);
4940 /* NULL terminated array of linked in driver wrappers */
4941 extern const struct wpa_driver_ops *const wpa_drivers[];
4944 /* Available drivers */
4946 #ifdef CONFIG_DRIVER_WEXT
4947 extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
4948 #endif /* CONFIG_DRIVER_WEXT */
4949 #ifdef CONFIG_DRIVER_NL80211
4950 /* driver_nl80211.c */
4951 extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
4952 #endif /* CONFIG_DRIVER_NL80211 */
4953 #ifdef CONFIG_DRIVER_HOSTAP
4954 extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
4955 #endif /* CONFIG_DRIVER_HOSTAP */
4956 #ifdef CONFIG_DRIVER_BSD
4957 extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
4958 #endif /* CONFIG_DRIVER_BSD */
4959 #ifdef CONFIG_DRIVER_OPENBSD
4960 /* driver_openbsd.c */
4961 extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
4962 #endif /* CONFIG_DRIVER_OPENBSD */
4963 #ifdef CONFIG_DRIVER_NDIS
4964 extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
4965 #endif /* CONFIG_DRIVER_NDIS */
4966 #ifdef CONFIG_DRIVER_WIRED
4967 extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
4968 #endif /* CONFIG_DRIVER_WIRED */
4969 #ifdef CONFIG_DRIVER_MACSEC_QCA
4970 /* driver_macsec_qca.c */
4971 extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
4972 #endif /* CONFIG_DRIVER_MACSEC_QCA */
4973 #ifdef CONFIG_DRIVER_ROBOSWITCH
4974 /* driver_roboswitch.c */
4975 extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
4976 #endif /* CONFIG_DRIVER_ROBOSWITCH */
4977 #ifdef CONFIG_DRIVER_ATHEROS
4978 /* driver_atheros.c */
4979 extern const struct wpa_driver_ops wpa_driver_atheros_ops;
4980 #endif /* CONFIG_DRIVER_ATHEROS */
4981 #ifdef CONFIG_DRIVER_NONE
4982 extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
4983 #endif /* CONFIG_DRIVER_NONE */
4985 #endif /* DRIVER_H */