2 * Driver interface definition
3 * Copyright (c) 2003-2014, 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 "utils/list.h"
25 #define HOSTAPD_CHAN_DISABLED 0x00000001
26 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
27 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
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 enum reg_change_initiator {
49 REGDOM_SET_BY_COUNTRY_IE,
57 REGDOM_TYPE_CUSTOM_WORLD,
58 REGDOM_TYPE_INTERSECTION,
62 * struct hostapd_channel_data - Channel information
64 struct hostapd_channel_data {
66 * chan - Channel number (IEEE 802.11)
71 * freq - Frequency in MHz
76 * flag - Channel flags (HOSTAPD_CHAN_*)
81 * max_tx_power - Regulatory transmit power limit in dBm
86 * survey_list - Linked list of surveys
88 struct dl_list survey_list;
91 * min_nf - Minimum observed noise floor, in dBm, based on all
92 * surveyed channel data
98 * interference_factor - Computed interference factor on this
99 * channel (used internally in src/ap/acs.c; driver wrappers do not
102 long double interference_factor;
103 #endif /* CONFIG_ACS */
105 /* DFS CAC time in milliseconds */
106 unsigned int dfs_cac_ms;
109 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
110 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
113 * struct hostapd_hw_modes - Supported hardware mode information
115 struct hostapd_hw_modes {
117 * mode - Hardware mode
119 enum hostapd_hw_mode mode;
122 * num_channels - Number of entries in the channels array
127 * channels - Array of supported channels
129 struct hostapd_channel_data *channels;
132 * num_rates - Number of entries in the rates array
137 * rates - Array of supported rates in 100 kbps units
142 * ht_capab - HT (IEEE 802.11n) capabilities
147 * mcs_set - MCS (IEEE 802.11n) rate parameters
152 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
157 * vht_capab - VHT (IEEE 802.11ac) capabilities
162 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
166 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
170 #define IEEE80211_MODE_INFRA 0
171 #define IEEE80211_MODE_IBSS 1
172 #define IEEE80211_MODE_AP 2
174 #define IEEE80211_CAP_ESS 0x0001
175 #define IEEE80211_CAP_IBSS 0x0002
176 #define IEEE80211_CAP_PRIVACY 0x0010
178 /* DMG (60 GHz) IEEE 802.11ad */
179 /* type - bits 0..1 */
180 #define IEEE80211_CAP_DMG_MASK 0x0003
181 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
182 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
183 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
185 #define WPA_SCAN_QUAL_INVALID BIT(0)
186 #define WPA_SCAN_NOISE_INVALID BIT(1)
187 #define WPA_SCAN_LEVEL_INVALID BIT(2)
188 #define WPA_SCAN_LEVEL_DBM BIT(3)
189 #define WPA_SCAN_AUTHENTICATED BIT(4)
190 #define WPA_SCAN_ASSOCIATED BIT(5)
193 * struct wpa_scan_res - Scan result for an BSS/IBSS
194 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
196 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
197 * @beacon_int: beacon interval in TUs (host byte order)
198 * @caps: capability information field in host byte order
199 * @qual: signal quality
200 * @noise: noise level
201 * @level: signal level
203 * @age: Age of the information in milliseconds (i.e., how many milliseconds
204 * ago the last Beacon or Probe Response frame was received)
205 * @ie_len: length of the following IE field in octets
206 * @beacon_ie_len: length of the following Beacon IE field in octets
208 * This structure is used as a generic format for scan results from the
209 * driver. Each driver interface implementation is responsible for converting
210 * the driver or OS specific scan results into this format.
212 * If the driver does not support reporting all IEs, the IE data structure is
213 * constructed of the IEs that are available. This field will also need to
214 * include SSID in IE format. All drivers are encouraged to be extended to
215 * report all IEs to make it easier to support future additions.
217 struct wpa_scan_res {
229 size_t beacon_ie_len;
231 * Followed by ie_len octets of IEs from Probe Response frame (or if
232 * the driver does not indicate source of IEs, these may also be from
233 * Beacon frame). After the first set of IEs, another set of IEs may
234 * follow (with beacon_ie_len octets of data) if the driver provides
240 * struct wpa_scan_results - Scan results
241 * @res: Array of pointers to allocated variable length scan result entries
242 * @num: Number of entries in the scan result array
243 * @fetch_time: Time when the results were fetched from the driver
245 struct wpa_scan_results {
246 struct wpa_scan_res **res;
248 struct os_reltime fetch_time;
252 * struct wpa_interface_info - Network interface information
253 * @next: Pointer to the next interface or NULL if this is the last one
254 * @ifname: Interface name that can be used with init() or init2()
255 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
257 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
258 * is not an allocated copy, i.e., get_interfaces() caller will not free
261 struct wpa_interface_info {
262 struct wpa_interface_info *next;
265 const char *drv_name;
268 #define WPAS_MAX_SCAN_SSIDS 16
271 * struct wpa_driver_scan_params - Scan parameters
272 * Data for struct wpa_driver_ops::scan2().
274 struct wpa_driver_scan_params {
276 * ssids - SSIDs to scan for
278 struct wpa_driver_scan_ssid {
280 * ssid - specific SSID to scan for (ProbeReq)
281 * %NULL or zero-length SSID is used to indicate active scan
282 * with wildcard SSID.
286 * ssid_len: Length of the SSID in octets
289 } ssids[WPAS_MAX_SCAN_SSIDS];
292 * num_ssids - Number of entries in ssids array
293 * Zero indicates a request for a passive scan.
298 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
303 * extra_ies_len - Length of extra_ies in octets
305 size_t extra_ies_len;
308 * freqs - Array of frequencies to scan or %NULL for all frequencies
310 * The frequency is set in MHz. The array is zero-terminated.
315 * filter_ssids - Filter for reporting SSIDs
317 * This optional parameter can be used to request the driver wrapper to
318 * filter scan results to include only the specified SSIDs. %NULL
319 * indicates that no filtering is to be done. This can be used to
320 * reduce memory needs for scan results in environments that have large
321 * number of APs with different SSIDs.
323 * The driver wrapper is allowed to take this allocated buffer into its
324 * own use by setting the pointer to %NULL. In that case, the driver
325 * wrapper is responsible for freeing the buffer with os_free() once it
326 * is not needed anymore.
328 struct wpa_driver_scan_filter {
334 * num_filter_ssids - Number of entries in filter_ssids array
336 size_t num_filter_ssids;
339 * filter_rssi - Filter by RSSI
341 * The driver may filter scan results in firmware to reduce host
342 * wakeups and thereby save power. Specify the RSSI threshold in s32
348 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
350 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
351 * Mbps from the support rates element(s) in the Probe Request frames
352 * and not to transmit the frames at any of those rates.
354 unsigned int p2p_probe:1;
357 * only_new_results - Request driver to report only new results
359 * This is used to request the driver to report only BSSes that have
360 * been detected after this scan request has been started, i.e., to
361 * flush old cached BSS entries.
363 unsigned int only_new_results:1;
366 * low_priority - Requests driver to use a lower scan priority
368 * This is used to request the driver to use a lower scan priority
369 * if it supports such a thing.
371 unsigned int low_priority:1;
374 * NOTE: Whenever adding new parameters here, please make sure
375 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
381 * struct wpa_driver_auth_params - Authentication parameters
382 * Data for struct wpa_driver_ops::authenticate().
384 struct wpa_driver_auth_params {
392 const u8 *wep_key[4];
393 size_t wep_key_len[4];
395 int local_state_change;
398 * p2p - Whether this connection is a P2P group
408 WPS_MODE_NONE /* no WPS provisioning being used */,
409 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
410 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
414 struct hostapd_freq_params {
420 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
421 * secondary channel below primary, 1 = HT40
422 * enabled, secondary channel above primary */
427 /* valid for both HT and VHT, center_freq2 is non-zero
428 * only for bandwidth 80 and an 80+80 channel */
429 int center_freq1, center_freq2;
434 * struct wpa_driver_associate_params - Association parameters
435 * Data for struct wpa_driver_ops::associate().
437 struct wpa_driver_associate_params {
439 * bssid - BSSID of the selected AP
440 * This can be %NULL, if ap_scan=2 mode is used and the driver is
441 * responsible for selecting with which BSS to associate. */
445 * bssid_hint - BSSID of a proposed AP
447 * This indicates which BSS has been found a suitable candidate for
448 * initial association for drivers that use driver/firmwate-based BSS
449 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
450 * the driver from selecting other BSSes in the ESS.
452 const u8 *bssid_hint;
455 * ssid - The selected SSID
460 * ssid_len - Length of the SSID (1..32)
465 * freq - channel parameters
467 struct hostapd_freq_params freq;
470 * freq_hint - Frequency of the channel the proposed AP is using
472 * This provides a channel on which a suitable BSS has been found as a
473 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
474 * limit the driver from selecting other channels for
475 * driver/firmware-based BSS selection.
480 * bg_scan_period - Background scan period in seconds, 0 to disable
481 * background scan, or -1 to indicate no change to default driver
487 * beacon_int - Beacon interval for IBSS or 0 to use driver default
492 * wpa_ie - WPA information element for (Re)Association Request
493 * WPA information element to be included in (Re)Association
494 * Request (including information element id and length). Use
495 * of this WPA IE is optional. If the driver generates the WPA
496 * IE, it can use pairwise_suite, group_suite, and
497 * key_mgmt_suite to select proper algorithms. In this case,
498 * the driver has to notify wpa_supplicant about the used WPA
499 * IE by generating an event that the interface code will
500 * convert into EVENT_ASSOCINFO data (see below).
502 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
503 * instead. The driver can determine which version is used by
504 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
507 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
512 * wpa_ie_len - length of the wpa_ie
517 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
519 unsigned int wpa_proto;
522 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
524 * This is usually ignored if @wpa_ie is used.
526 unsigned int pairwise_suite;
529 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
531 * This is usually ignored if @wpa_ie is used.
533 unsigned int group_suite;
536 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
538 * This is usually ignored if @wpa_ie is used.
540 unsigned int key_mgmt_suite;
543 * auth_alg - Allowed authentication algorithms
544 * Bit field of WPA_AUTH_ALG_*
549 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
554 * wep_key - WEP keys for static WEP configuration
556 const u8 *wep_key[4];
559 * wep_key_len - WEP key length for static WEP configuration
561 size_t wep_key_len[4];
564 * wep_tx_keyidx - WEP TX key index for static WEP configuration
569 * mgmt_frame_protection - IEEE 802.11w management frame protection
571 enum mfp_options mgmt_frame_protection;
574 * ft_ies - IEEE 802.11r / FT information elements
575 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
576 * for fast transition, this parameter is set to include the IEs that
577 * are to be sent in the next FT Authentication Request message.
578 * update_ft_ies() handler is called to update the IEs for further
579 * FT messages in the sequence.
581 * The driver should use these IEs only if the target AP is advertising
582 * the same mobility domain as the one included in the MDIE here.
584 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
585 * AP after the initial association. These IEs can only be used if the
586 * target AP is advertising support for FT and is using the same MDIE
587 * and SSID as the current AP.
589 * The driver is responsible for reporting the FT IEs received from the
590 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
591 * type. update_ft_ies() handler will then be called with the FT IEs to
592 * include in the next frame in the authentication sequence.
597 * ft_ies_len - Length of ft_ies in bytes
602 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
604 * This value is provided to allow the driver interface easier access
605 * to the current mobility domain. This value is set to %NULL if no
606 * mobility domain is currently active.
611 * passphrase - RSN passphrase for PSK
613 * This value is made available only for WPA/WPA2-Personal (PSK) and
614 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
615 * the 8..63 character ASCII passphrase, if available. Please note that
616 * this can be %NULL if passphrase was not used to generate the PSK. In
617 * that case, the psk field must be used to fetch the PSK.
619 const char *passphrase;
622 * psk - RSN PSK (alternative for passphrase for PSK)
624 * This value is made available only for WPA/WPA2-Personal (PSK) and
625 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
626 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
627 * be prepared to handle %NULL value as an error.
632 * drop_unencrypted - Enable/disable unencrypted frame filtering
634 * Configure the driver to drop all non-EAPOL frames (both receive and
635 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
636 * still be allowed for key negotiation.
638 int drop_unencrypted;
641 * prev_bssid - Previously used BSSID in this ESS
643 * When not %NULL, this is a request to use reassociation instead of
646 const u8 *prev_bssid;
651 * If the driver needs to do special configuration for WPS association,
652 * this variable provides more information on what type of association
653 * is being requested. Most drivers should not need ot use this.
658 * p2p - Whether this connection is a P2P group
663 * uapsd - UAPSD parameters for the network
664 * -1 = do not change defaults
665 * AP mode: 1 = enabled, 0 = disabled
666 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
671 * fixed_bssid - Whether to force this BSSID in IBSS mode
672 * 1 = Fix this BSSID and prevent merges.
673 * 0 = Do not fix BSSID.
678 * disable_ht - Disable HT (IEEE 802.11n) for this connection
683 * HT Capabilities over-rides. Only bits set in the mask will be used,
684 * and not all values are used by the kernel anyway. Currently, MCS,
685 * MPDU and MSDU fields are used.
687 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */
688 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */
690 #ifdef CONFIG_VHT_OVERRIDES
692 * disable_vht - Disable VHT for this connection
697 * VHT capability overrides.
699 const struct ieee80211_vht_capabilities *vhtcaps;
700 const struct ieee80211_vht_capabilities *vhtcaps_mask;
701 #endif /* CONFIG_VHT_OVERRIDES */
706 HIDDEN_SSID_ZERO_LEN,
707 HIDDEN_SSID_ZERO_CONTENTS
710 struct wowlan_triggers {
714 u8 gtk_rekey_failure;
716 u8 four_way_handshake;
720 struct wpa_driver_ap_params {
722 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
727 * head_len - Length of the head buffer in octets
732 * tail - Beacon tail following TIM IE
737 * tail_len - Length of the tail buffer in octets
742 * dtim_period - DTIM period
747 * beacon_int - Beacon interval
752 * basic_rates: -1 terminated array of basic rates in 100 kbps
754 * This parameter can be used to set a specific basic rate set for the
755 * BSS. If %NULL, default basic rate set is used.
760 * proberesp - Probe Response template
762 * This is used by drivers that reply to Probe Requests internally in
763 * AP mode and require the full Probe Response template.
768 * proberesp_len - Length of the proberesp buffer in octets
770 size_t proberesp_len;
773 * ssid - The SSID to use in Beacon/Probe Response frames
778 * ssid_len - Length of the SSID (1..32)
783 * hide_ssid - Whether to hide the SSID
785 enum hide_ssid hide_ssid;
788 * pairwise_ciphers - WPA_CIPHER_* bitfield
790 unsigned int pairwise_ciphers;
793 * group_cipher - WPA_CIPHER_*
795 unsigned int group_cipher;
798 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
800 unsigned int key_mgmt_suites;
803 * auth_algs - WPA_AUTH_ALG_* bitfield
805 unsigned int auth_algs;
808 * wpa_version - WPA_PROTO_* bitfield
810 unsigned int wpa_version;
813 * privacy - Whether privacy is used in the BSS
818 * beacon_ies - WPS/P2P IE(s) for Beacon frames
820 * This is used to add IEs like WPS IE and P2P IE by drivers that do
821 * not use the full Beacon template.
823 const struct wpabuf *beacon_ies;
826 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
828 * This is used to add IEs like WPS IE and P2P IE by drivers that
829 * reply to Probe Request frames internally.
831 const struct wpabuf *proberesp_ies;
834 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
836 * This is used to add IEs like WPS IE by drivers that reply to
837 * (Re)Association Request frames internally.
839 const struct wpabuf *assocresp_ies;
842 * isolate - Whether to isolate frames between associated stations
844 * If this is non-zero, the AP is requested to disable forwarding of
845 * frames between associated stations.
850 * cts_protect - Whether CTS protection is enabled
855 * preamble - Whether short preamble is enabled
860 * short_slot_time - Whether short slot time is enabled
862 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
863 * not set (e.g., when 802.11g mode is not in use)
868 * ht_opmode - HT operation mode or -1 if HT not in use
873 * interworking - Whether Interworking is enabled
878 * hessid - Homogeneous ESS identifier or %NULL if not set
883 * access_network_type - Access Network Type (0..15)
885 * This is used for filtering Probe Request frames when Interworking is
888 u8 access_network_type;
891 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
893 * This is used by driver which advertises this capability.
895 int ap_max_inactivity;
898 * disable_dgaf - Whether group-addressed frames are disabled
903 * osen - Whether OSEN security is enabled
908 * freq - Channel parameters for dynamic bandwidth changes
910 struct hostapd_freq_params *freq;
914 * struct wpa_driver_capa - Driver capability information
916 struct wpa_driver_capa {
917 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
918 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
919 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
920 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
921 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
922 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
923 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
924 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
925 unsigned int key_mgmt;
927 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
928 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
929 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
930 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
931 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
932 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
933 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
934 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
935 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
936 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
937 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
938 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
939 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
942 #define WPA_DRIVER_AUTH_OPEN 0x00000001
943 #define WPA_DRIVER_AUTH_SHARED 0x00000002
944 #define WPA_DRIVER_AUTH_LEAP 0x00000004
947 /* Driver generated WPA/RSN IE */
948 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
949 /* Driver needs static WEP key setup after association command */
950 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
951 /* Driver takes care of all DFS operations */
952 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
953 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
954 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
955 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
956 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
957 /* Driver provides separate commands for authentication and association (SME in
958 * wpa_supplicant). */
959 #define WPA_DRIVER_FLAGS_SME 0x00000020
960 /* Driver supports AP mode */
961 #define WPA_DRIVER_FLAGS_AP 0x00000040
962 /* Driver needs static WEP key setup after association has been completed */
963 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
964 /* Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
965 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
966 /* Driver supports concurrent P2P operations */
967 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
969 * Driver uses the initial interface as a dedicated management interface, i.e.,
970 * it cannot be used for P2P group operations or non-P2P purposes.
972 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
973 /* This interface is P2P capable (P2P GO or P2P Client) */
974 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
975 /* Driver supports station and key removal when stopping an AP */
976 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
978 * Driver uses the initial interface for P2P management interface and non-P2P
979 * purposes (e.g., connect to infra AP), but this interface cannot be used for
980 * P2P group operations.
982 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
984 * Driver is known to use sane error codes, i.e., when it indicates that
985 * something (e.g., association) fails, there was indeed a failure and the
986 * operation does not end up getting completed successfully later.
988 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
989 /* Driver supports off-channel TX */
990 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
991 /* Driver indicates TX status events for EAPOL Data frames */
992 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
993 /* Driver indicates TX status events for Deauth/Disassoc frames */
994 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
995 /* Driver supports roaming (BSS selection) in firmware */
996 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
997 /* Driver supports operating as a TDLS peer */
998 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
999 /* Driver requires external TDLS setup/teardown/discovery */
1000 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1001 /* Driver indicates support for Probe Response offloading in AP mode */
1002 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1003 /* Driver supports U-APSD in AP mode */
1004 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1005 /* Driver supports inactivity timer in AP mode */
1006 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1007 /* Driver expects user space implementation of MLME in AP mode */
1008 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1009 /* Driver supports SAE with user space SME */
1010 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1011 /* Driver makes use of OBSS scan mechanism in wpa_supplicant */
1012 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1013 /* Driver supports IBSS (Ad-hoc) mode */
1014 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1015 /* Driver supports radar detection */
1016 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1017 /* Driver supports a dedicated interface for P2P Device */
1018 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1019 /* Driver supports QoS Mapping */
1020 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1021 /* Driver supports CSA in AP mode */
1022 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1026 int max_sched_scan_ssids;
1027 int sched_scan_supported;
1031 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1033 unsigned int max_remain_on_chan;
1036 * max_stations - Maximum number of associated stations the driver
1037 * supports in AP mode
1039 unsigned int max_stations;
1042 * probe_resp_offloads - Bitmap of supported protocols by the driver
1043 * for Probe Response offloading.
1045 /* Driver Probe Response offloading support for WPS ver. 1 */
1046 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1047 /* Driver Probe Response offloading support for WPS ver. 2 */
1048 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1049 /* Driver Probe Response offloading support for P2P */
1050 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1051 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1052 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1053 unsigned int probe_resp_offloads;
1055 unsigned int max_acl_mac_addrs;
1058 * Number of supported concurrent channels
1060 unsigned int num_multichan_concurrent;
1063 * extended_capa - extended capabilities in driver/device
1065 * Must be allocated and freed by driver and the pointers must be
1066 * valid for the lifetime of the driver, i.e., freed in deinit()
1068 const u8 *extended_capa, *extended_capa_mask;
1069 unsigned int extended_capa_len;
1071 struct wowlan_triggers wowlan_triggers;
1075 struct hostapd_data;
1077 struct hostap_sta_driver_data {
1078 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1079 unsigned long current_tx_rate;
1080 unsigned long inactive_msec;
1081 unsigned long flags;
1082 unsigned long num_ps_buf_frames;
1083 unsigned long tx_retry_failed;
1084 unsigned long tx_retry_count;
1089 struct hostapd_sta_add_params {
1093 const u8 *supp_rates;
1094 size_t supp_rates_len;
1095 u16 listen_interval;
1096 const struct ieee80211_ht_capabilities *ht_capabilities;
1097 const struct ieee80211_vht_capabilities *vht_capabilities;
1098 int vht_opmode_enabled;
1100 u32 flags; /* bitmask of WPA_STA_* flags */
1101 int set; /* Set STA parameters instead of add */
1103 const u8 *ext_capab;
1104 size_t ext_capab_len;
1105 const u8 *supp_channels;
1106 size_t supp_channels_len;
1107 const u8 *supp_oper_classes;
1108 size_t supp_oper_classes_len;
1111 struct mac_address {
1115 struct hostapd_acl_params {
1117 unsigned int num_mac_acl;
1118 struct mac_address mac_acl[0];
1121 enum wpa_driver_if_type {
1123 * WPA_IF_STATION - Station mode interface
1128 * WPA_IF_AP_VLAN - AP mode VLAN interface
1130 * This interface shares its address and Beacon frame with the main
1136 * WPA_IF_AP_BSS - AP mode BSS interface
1138 * This interface has its own address and Beacon frame.
1143 * WPA_IF_P2P_GO - P2P Group Owner
1148 * WPA_IF_P2P_CLIENT - P2P Client
1153 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1154 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1159 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1160 * abstracted P2P Device function in the driver
1165 struct wpa_init_params {
1171 const char *test_socket;
1172 int use_pae_group_addr;
1176 u8 *own_addr; /* buffer for writing own MAC address */
1180 struct wpa_bss_params {
1181 /** Interface name (for multi-SSID/VLAN support) */
1183 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1192 enum mfp_options ieee80211w;
1195 #define WPA_STA_AUTHORIZED BIT(0)
1196 #define WPA_STA_WMM BIT(1)
1197 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1198 #define WPA_STA_MFP BIT(3)
1199 #define WPA_STA_TDLS_PEER BIT(4)
1212 WNM_SLEEP_ENTER_CONFIRM,
1213 WNM_SLEEP_ENTER_FAIL,
1214 WNM_SLEEP_EXIT_CONFIRM,
1215 WNM_SLEEP_EXIT_FAIL,
1216 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1217 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1218 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1220 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1222 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1223 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1225 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1228 /* enum chan_width - Channel width definitions */
1240 * struct wpa_signal_info - Information about channel signal quality
1242 struct wpa_signal_info {
1244 int above_threshold;
1249 enum chan_width chanwidth;
1255 * struct beacon_data - Beacon data
1256 * @head: Head portion of Beacon frame (before TIM IE)
1257 * @tail: Tail portion of Beacon frame (after TIM IE)
1258 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1259 * @proberesp_ies: Extra information element(s) to add into Probe Response
1261 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1262 * Response frames or %NULL
1263 * @probe_resp: Probe Response frame template
1264 * @head_len: Length of @head
1265 * @tail_len: Length of @tail
1266 * @beacon_ies_len: Length of beacon_ies in octets
1267 * @proberesp_ies_len: Length of proberesp_ies in octets
1268 * @proberesp_ies_len: Length of proberesp_ies in octets
1269 * @probe_resp_len: Length of probe response template (@probe_resp)
1271 struct beacon_data {
1278 size_t head_len, tail_len;
1279 size_t beacon_ies_len;
1280 size_t proberesp_ies_len;
1281 size_t assocresp_ies_len;
1282 size_t probe_resp_len;
1286 * struct csa_settings - Settings for channel switch command
1287 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1288 * @block_tx: 1 - block transmission for CSA period
1289 * @freq_params: Next channel frequency parameter
1290 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1291 * @beacon_after: Next beacon/probe resp/asooc resp info
1292 * @counter_offset_beacon: Offset to the count field in beacon's tail
1293 * @counter_offset_presp: Offset to the count field in probe resp.
1295 struct csa_settings {
1299 struct hostapd_freq_params freq_params;
1300 struct beacon_data beacon_csa;
1301 struct beacon_data beacon_after;
1303 u16 counter_offset_beacon;
1304 u16 counter_offset_presp;
1307 /* TDLS peer capabilities for send_tdls_mgmt() */
1308 enum tdls_peer_capability {
1309 TDLS_PEER_HT = BIT(0),
1310 TDLS_PEER_VHT = BIT(1),
1311 TDLS_PEER_WMM = BIT(2),
1314 #ifdef CONFIG_MACSEC
1315 struct macsec_init_params {
1316 Boolean always_include_sci;
1320 #endif /* CONFIG_MACSEC */
1324 * struct wpa_driver_ops - Driver interface API definition
1326 * This structure defines the API that each driver interface needs to implement
1327 * for core wpa_supplicant code. All driver specific functionality is captured
1330 struct wpa_driver_ops {
1331 /** Name of the driver interface */
1333 /** One line description of the driver interface */
1337 * get_bssid - Get the current BSSID
1338 * @priv: private driver interface data
1339 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1341 * Returns: 0 on success, -1 on failure
1343 * Query kernel driver for the current BSSID and copy it to bssid.
1344 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1347 int (*get_bssid)(void *priv, u8 *bssid);
1350 * get_ssid - Get the current SSID
1351 * @priv: private driver interface data
1352 * @ssid: buffer for SSID (at least 32 bytes)
1354 * Returns: Length of the SSID on success, -1 on failure
1356 * Query kernel driver for the current SSID and copy it to ssid.
1357 * Returning zero is recommended if the STA is not associated.
1359 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1360 * can, at least in theory, contain control characters (including nul)
1361 * and as such, should be processed as binary data, not a printable
1364 int (*get_ssid)(void *priv, u8 *ssid);
1367 * set_key - Configure encryption key
1368 * @ifname: Interface name (for multi-SSID/VLAN support)
1369 * @priv: private driver interface data
1370 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1371 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1372 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1373 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1374 * %WPA_ALG_BIP_CMAC_256);
1375 * %WPA_ALG_NONE clears the key.
1376 * @addr: Address of the peer STA (BSSID of the current AP when setting
1377 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1378 * broadcast keys, %NULL for default keys that are used both for
1379 * broadcast and unicast; when clearing keys, %NULL is used to
1380 * indicate that both the broadcast-only and default key of the
1381 * specified key index is to be cleared
1382 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1384 * @set_tx: configure this key as the default Tx key (only used when
1385 * driver does not support separate unicast/individual key
1386 * @seq: sequence number/packet number, seq_len octets, the next
1387 * packet number to be used for in replay protection; configured
1388 * for Rx keys (in most cases, this is only used with broadcast
1389 * keys and set to zero for unicast keys); %NULL if not set
1390 * @seq_len: length of the seq, depends on the algorithm:
1391 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1392 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1394 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1395 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1397 * Returns: 0 on success, -1 on failure
1399 * Configure the given key for the kernel driver. If the driver
1400 * supports separate individual keys (4 default keys + 1 individual),
1401 * addr can be used to determine whether the key is default or
1402 * individual. If only 4 keys are supported, the default key with key
1403 * index 0 is used as the individual key. STA must be configured to use
1404 * it as the default Tx key (set_tx is set) and accept Rx for all the
1405 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1406 * broadcast keys, so key index 0 is available for this kind of
1409 * Please note that TKIP keys include separate TX and RX MIC keys and
1410 * some drivers may expect them in different order than wpa_supplicant
1411 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1412 * will trigger Michael MIC errors. This can be fixed by changing the
1413 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1414 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1415 * example on how this can be done.
1417 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1418 const u8 *addr, int key_idx, int set_tx,
1419 const u8 *seq, size_t seq_len,
1420 const u8 *key, size_t key_len);
1423 * init - Initialize driver interface
1424 * @ctx: context to be used when calling wpa_supplicant functions,
1425 * e.g., wpa_supplicant_event()
1426 * @ifname: interface name, e.g., wlan0
1428 * Returns: Pointer to private data, %NULL on failure
1430 * Initialize driver interface, including event processing for kernel
1431 * driver events (e.g., associated, scan results, Michael MIC failure).
1432 * This function can allocate a private configuration data area for
1433 * @ctx, file descriptor, interface name, etc. information that may be
1434 * needed in future driver operations. If this is not used, non-NULL
1435 * value will need to be returned because %NULL is used to indicate
1436 * failure. The returned value will be used as 'void *priv' data for
1437 * all other driver_ops functions.
1439 * The main event loop (eloop.c) of wpa_supplicant can be used to
1440 * register callback for read sockets (eloop_register_read_sock()).
1442 * See below for more information about events and
1443 * wpa_supplicant_event() function.
1445 void * (*init)(void *ctx, const char *ifname);
1448 * deinit - Deinitialize driver interface
1449 * @priv: private driver interface data from init()
1451 * Shut down driver interface and processing of driver events. Free
1452 * private data buffer if one was allocated in init() handler.
1454 void (*deinit)(void *priv);
1457 * set_param - Set driver configuration parameters
1458 * @priv: private driver interface data from init()
1459 * @param: driver specific configuration parameters
1461 * Returns: 0 on success, -1 on failure
1463 * Optional handler for notifying driver interface about configuration
1464 * parameters (driver_param).
1466 int (*set_param)(void *priv, const char *param);
1469 * set_countermeasures - Enable/disable TKIP countermeasures
1470 * @priv: private driver interface data
1471 * @enabled: 1 = countermeasures enabled, 0 = disabled
1473 * Returns: 0 on success, -1 on failure
1475 * Configure TKIP countermeasures. When these are enabled, the driver
1476 * should drop all received and queued frames that are using TKIP.
1478 int (*set_countermeasures)(void *priv, int enabled);
1481 * deauthenticate - Request driver to deauthenticate
1482 * @priv: private driver interface data
1483 * @addr: peer address (BSSID of the AP)
1484 * @reason_code: 16-bit reason code to be sent in the deauthentication
1487 * Returns: 0 on success, -1 on failure
1489 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1492 * associate - Request driver to associate
1493 * @priv: private driver interface data
1494 * @params: association parameters
1496 * Returns: 0 on success, -1 on failure
1498 int (*associate)(void *priv,
1499 struct wpa_driver_associate_params *params);
1502 * add_pmkid - Add PMKSA cache entry to the driver
1503 * @priv: private driver interface data
1504 * @bssid: BSSID for the PMKSA cache entry
1505 * @pmkid: PMKID for the PMKSA cache entry
1507 * Returns: 0 on success, -1 on failure
1509 * This function is called when a new PMK is received, as a result of
1510 * either normal authentication or RSN pre-authentication.
1512 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1513 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1514 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1515 * driver_ops function does not need to be implemented. Likewise, if
1516 * the driver does not support WPA, this function is not needed.
1518 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1521 * remove_pmkid - Remove PMKSA cache entry to the driver
1522 * @priv: private driver interface data
1523 * @bssid: BSSID for the PMKSA cache entry
1524 * @pmkid: PMKID for the PMKSA cache entry
1526 * Returns: 0 on success, -1 on failure
1528 * This function is called when the supplicant drops a PMKSA cache
1529 * entry for any reason.
1531 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1532 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1533 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1534 * from wpa_supplicant, this driver_ops function does not need to be
1535 * implemented. Likewise, if the driver does not support WPA, this
1536 * function is not needed.
1538 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1541 * flush_pmkid - Flush PMKSA cache
1542 * @priv: private driver interface data
1544 * Returns: 0 on success, -1 on failure
1546 * This function is called when the supplicant drops all PMKSA cache
1547 * entries for any reason.
1549 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1550 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1551 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1552 * from wpa_supplicant, this driver_ops function does not need to be
1553 * implemented. Likewise, if the driver does not support WPA, this
1554 * function is not needed.
1556 int (*flush_pmkid)(void *priv);
1559 * get_capa - Get driver capabilities
1560 * @priv: private driver interface data
1562 * Returns: 0 on success, -1 on failure
1564 * Get driver/firmware/hardware capabilities.
1566 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1569 * poll - Poll driver for association information
1570 * @priv: private driver interface data
1572 * This is an option callback that can be used when the driver does not
1573 * provide event mechanism for association events. This is called when
1574 * receiving WPA EAPOL-Key messages that require association
1575 * information. The driver interface is supposed to generate associnfo
1576 * event before returning from this callback function. In addition, the
1577 * driver interface should generate an association event after having
1578 * sent out associnfo.
1580 void (*poll)(void *priv);
1583 * get_ifname - Get interface name
1584 * @priv: private driver interface data
1586 * Returns: Pointer to the interface name. This can differ from the
1587 * interface name used in init() call. Init() is called first.
1589 * This optional function can be used to allow the driver interface to
1590 * replace the interface name with something else, e.g., based on an
1591 * interface mapping from a more descriptive name.
1593 const char * (*get_ifname)(void *priv);
1596 * get_mac_addr - Get own MAC address
1597 * @priv: private driver interface data
1599 * Returns: Pointer to own MAC address or %NULL on failure
1601 * This optional function can be used to get the own MAC address of the
1602 * device from the driver interface code. This is only needed if the
1603 * l2_packet implementation for the OS does not provide easy access to
1605 const u8 * (*get_mac_addr)(void *priv);
1608 * send_eapol - Optional function for sending EAPOL packets
1609 * @priv: private driver interface data
1610 * @dest: Destination MAC address
1612 * @data: EAPOL packet starting with IEEE 802.1X header
1613 * @data_len: Size of the EAPOL packet
1615 * Returns: 0 on success, -1 on failure
1617 * This optional function can be used to override l2_packet operations
1618 * with driver specific functionality. If this function pointer is set,
1619 * l2_packet module is not used at all and the driver interface code is
1620 * responsible for receiving and sending all EAPOL packets. The
1621 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1622 * event. The driver interface is required to implement get_mac_addr()
1623 * handler if send_eapol() is used.
1625 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1626 const u8 *data, size_t data_len);
1629 * set_operstate - Sets device operating state to DORMANT or UP
1630 * @priv: private driver interface data
1631 * @state: 0 = dormant, 1 = up
1632 * Returns: 0 on success, -1 on failure
1634 * This is an optional function that can be used on operating systems
1635 * that support a concept of controlling network device state from user
1636 * space applications. This function, if set, gets called with
1637 * state = 1 when authentication has been completed and with state = 0
1638 * when connection is lost.
1640 int (*set_operstate)(void *priv, int state);
1643 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1644 * @priv: Private driver interface data
1645 * @addr: Address of the station for which to set protection (may be
1646 * %NULL for group keys)
1647 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1648 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1649 * Returns: 0 on success, -1 on failure
1651 * This is an optional function that can be used to set the driver to
1652 * require protection for Tx and/or Rx frames. This uses the layer
1653 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1654 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1655 * set protection operation; instead, they set protection implicitly
1656 * based on configured keys.
1658 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1662 * get_hw_feature_data - Get hardware support data (channels and rates)
1663 * @priv: Private driver interface data
1664 * @num_modes: Variable for returning the number of returned modes
1665 * flags: Variable for returning hardware feature flags
1666 * Returns: Pointer to allocated hardware data on success or %NULL on
1667 * failure. Caller is responsible for freeing this.
1669 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1674 * send_mlme - Send management frame from MLME
1675 * @priv: Private driver interface data
1676 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1677 * @data_len: Size of the management frame
1678 * @noack: Do not wait for this frame to be acked (disable retries)
1679 * Returns: 0 on success, -1 on failure
1681 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1685 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1686 * @priv: Private driver interface data
1687 * @md: Mobility domain (2 octets) (also included inside ies)
1688 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1689 * @ies_len: Length of FT IEs in bytes
1690 * Returns: 0 on success, -1 on failure
1692 * The supplicant uses this callback to let the driver know that keying
1693 * material for FT is available and that the driver can use the
1694 * provided IEs in the next message in FT authentication sequence.
1696 * This function is only needed for driver that support IEEE 802.11r
1697 * (Fast BSS Transition).
1699 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1703 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1704 * @priv: Private driver interface data
1705 * @action: Action field value
1706 * @target_ap: Target AP address
1707 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1708 * @ies_len: Length of FT IEs in bytes
1709 * Returns: 0 on success, -1 on failure
1711 * The supplicant uses this callback to request the driver to transmit
1712 * an FT Action frame (action category 6) for over-the-DS fast BSS
1715 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1716 const u8 *ies, size_t ies_len);
1719 * get_scan_results2 - Fetch the latest scan results
1720 * @priv: private driver interface data
1722 * Returns: Allocated buffer of scan results (caller is responsible for
1723 * freeing the data structure) on success, NULL on failure
1725 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1728 * set_country - Set country
1729 * @priv: Private driver interface data
1730 * @alpha2: country to which to switch to
1731 * Returns: 0 on success, -1 on failure
1733 * This function is for drivers which support some form
1734 * of setting a regulatory domain.
1736 int (*set_country)(void *priv, const char *alpha2);
1739 * get_country - Get country
1740 * @priv: Private driver interface data
1741 * @alpha2: Buffer for returning country code (at least 3 octets)
1742 * Returns: 0 on success, -1 on failure
1744 int (*get_country)(void *priv, char *alpha2);
1747 * global_init - Global driver initialization
1748 * Returns: Pointer to private data (global), %NULL on failure
1750 * This optional function is called to initialize the driver wrapper
1751 * for global data, i.e., data that applies to all interfaces. If this
1752 * function is implemented, global_deinit() will also need to be
1753 * implemented to free the private data. The driver will also likely
1754 * use init2() function instead of init() to get the pointer to global
1755 * data available to per-interface initializer.
1757 void * (*global_init)(void);
1760 * global_deinit - Global driver deinitialization
1761 * @priv: private driver global data from global_init()
1763 * Terminate any global driver related functionality and free the
1764 * global data structure.
1766 void (*global_deinit)(void *priv);
1769 * init2 - Initialize driver interface (with global data)
1770 * @ctx: context to be used when calling wpa_supplicant functions,
1771 * e.g., wpa_supplicant_event()
1772 * @ifname: interface name, e.g., wlan0
1773 * @global_priv: private driver global data from global_init()
1774 * Returns: Pointer to private data, %NULL on failure
1776 * This function can be used instead of init() if the driver wrapper
1779 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1782 * get_interfaces - Get information about available interfaces
1783 * @global_priv: private driver global data from global_init()
1784 * Returns: Allocated buffer of interface information (caller is
1785 * responsible for freeing the data structure) on success, NULL on
1788 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1791 * scan2 - Request the driver to initiate scan
1792 * @priv: private driver interface data
1793 * @params: Scan parameters
1795 * Returns: 0 on success, -1 on failure
1797 * Once the scan results are ready, the driver should report scan
1798 * results event for wpa_supplicant which will eventually request the
1799 * results with wpa_driver_get_scan_results2().
1801 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1804 * authenticate - Request driver to authenticate
1805 * @priv: private driver interface data
1806 * @params: authentication parameters
1807 * Returns: 0 on success, -1 on failure
1809 * This is an optional function that can be used with drivers that
1810 * support separate authentication and association steps, i.e., when
1811 * wpa_supplicant can act as the SME. If not implemented, associate()
1812 * function is expected to take care of IEEE 802.11 authentication,
1815 int (*authenticate)(void *priv,
1816 struct wpa_driver_auth_params *params);
1819 * set_ap - Set Beacon and Probe Response information for AP mode
1820 * @priv: Private driver interface data
1821 * @params: Parameters to use in AP mode
1823 * This function is used to configure Beacon template and/or extra IEs
1824 * to add for Beacon and Probe Response frames for the driver in
1825 * AP mode. The driver is responsible for building the full Beacon
1826 * frame by concatenating the head part with TIM IE generated by the
1827 * driver/firmware and finishing with the tail part. Depending on the
1828 * driver architectue, this can be done either by using the full
1829 * template or the set of additional IEs (e.g., WPS and P2P IE).
1830 * Similarly, Probe Response processing depends on the driver design.
1831 * If the driver (or firmware) takes care of replying to Probe Request
1832 * frames, the extra IEs provided here needs to be added to the Probe
1835 * Returns: 0 on success, -1 on failure
1837 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1840 * set_acl - Set ACL in AP mode
1841 * @priv: Private driver interface data
1842 * @params: Parameters to configure ACL
1843 * Returns: 0 on success, -1 on failure
1845 * This is used only for the drivers which support MAC address ACL.
1847 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1850 * hapd_init - Initialize driver interface (hostapd only)
1851 * @hapd: Pointer to hostapd context
1852 * @params: Configuration for the driver wrapper
1853 * Returns: Pointer to private data, %NULL on failure
1855 * This function is used instead of init() or init2() when the driver
1856 * wrapper is used with hostapd.
1858 void * (*hapd_init)(struct hostapd_data *hapd,
1859 struct wpa_init_params *params);
1862 * hapd_deinit - Deinitialize driver interface (hostapd only)
1863 * @priv: Private driver interface data from hapd_init()
1865 void (*hapd_deinit)(void *priv);
1868 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1869 * @priv: Private driver interface data
1870 * @params: BSS parameters
1871 * Returns: 0 on success, -1 on failure
1873 * This is an optional function to configure the kernel driver to
1874 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1875 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1876 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1877 * for Beacon frames.
1879 * DEPRECATED - use set_ap() instead
1881 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1884 * set_privacy - Enable/disable privacy (AP only)
1885 * @priv: Private driver interface data
1886 * @enabled: 1 = privacy enabled, 0 = disabled
1887 * Returns: 0 on success, -1 on failure
1889 * This is an optional function to configure privacy field in the
1890 * kernel driver for Beacon frames. This can be left undefined (set to
1891 * %NULL) if the driver uses the Beacon template from set_ap().
1893 * DEPRECATED - use set_ap() instead
1895 int (*set_privacy)(void *priv, int enabled);
1898 * get_seqnum - Fetch the current TSC/packet number (AP only)
1899 * @ifname: The interface name (main or virtual)
1900 * @priv: Private driver interface data
1901 * @addr: MAC address of the station or %NULL for group keys
1903 * @seq: Buffer for returning the latest used TSC/packet number
1904 * Returns: 0 on success, -1 on failure
1906 * This function is used to fetch the last used TSC/packet number for
1907 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1908 * keys, so there is no strict requirement on implementing support for
1909 * unicast keys (i.e., addr != %NULL).
1911 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1915 * flush - Flush all association stations (AP only)
1916 * @priv: Private driver interface data
1917 * Returns: 0 on success, -1 on failure
1919 * This function requests the driver to disassociate all associated
1920 * stations. This function does not need to be implemented if the
1921 * driver does not process association frames internally.
1923 int (*flush)(void *priv);
1926 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1927 * @priv: Private driver interface data
1928 * @elem: Information elements
1929 * @elem_len: Length of the elem buffer in octets
1930 * Returns: 0 on success, -1 on failure
1932 * This is an optional function to add information elements in the
1933 * kernel driver for Beacon and Probe Response frames. This can be left
1934 * undefined (set to %NULL) if the driver uses the Beacon template from
1937 * DEPRECATED - use set_ap() instead
1939 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1942 * read_sta_data - Fetch station data
1943 * @priv: Private driver interface data
1944 * @data: Buffer for returning station information
1945 * @addr: MAC address of the station
1946 * Returns: 0 on success, -1 on failure
1948 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1952 * hapd_send_eapol - Send an EAPOL packet (AP only)
1953 * @priv: private driver interface data
1954 * @addr: Destination MAC address
1955 * @data: EAPOL packet starting with IEEE 802.1X header
1956 * @data_len: Length of the EAPOL packet in octets
1957 * @encrypt: Whether the frame should be encrypted
1958 * @own_addr: Source MAC address
1959 * @flags: WPA_STA_* flags for the destination station
1961 * Returns: 0 on success, -1 on failure
1963 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1964 size_t data_len, int encrypt,
1965 const u8 *own_addr, u32 flags);
1968 * sta_deauth - Deauthenticate a station (AP only)
1969 * @priv: Private driver interface data
1970 * @own_addr: Source address and BSSID for the Deauthentication frame
1971 * @addr: MAC address of the station to deauthenticate
1972 * @reason: Reason code for the Deauthentiation frame
1973 * Returns: 0 on success, -1 on failure
1975 * This function requests a specific station to be deauthenticated and
1976 * a Deauthentication frame to be sent to it.
1978 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1982 * sta_disassoc - Disassociate a station (AP only)
1983 * @priv: Private driver interface data
1984 * @own_addr: Source address and BSSID for the Disassociation frame
1985 * @addr: MAC address of the station to disassociate
1986 * @reason: Reason code for the Disassociation frame
1987 * Returns: 0 on success, -1 on failure
1989 * This function requests a specific station to be disassociated and
1990 * a Disassociation frame to be sent to it.
1992 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1996 * sta_remove - Remove a station entry (AP only)
1997 * @priv: Private driver interface data
1998 * @addr: MAC address of the station to be removed
1999 * Returns: 0 on success, -1 on failure
2001 int (*sta_remove)(void *priv, const u8 *addr);
2004 * hapd_get_ssid - Get the current SSID (AP only)
2005 * @priv: Private driver interface data
2006 * @buf: Buffer for returning the SSID
2007 * @len: Maximum length of the buffer
2008 * Returns: Length of the SSID on success, -1 on failure
2010 * This function need not be implemented if the driver uses Beacon
2011 * template from set_ap() and does not reply to Probe Request frames.
2013 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2016 * hapd_set_ssid - Set SSID (AP only)
2017 * @priv: Private driver interface data
2019 * @len: Length of the SSID in octets
2020 * Returns: 0 on success, -1 on failure
2022 * DEPRECATED - use set_ap() instead
2024 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2027 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2028 * @priv: Private driver interface data
2029 * @enabled: 1 = countermeasures enabled, 0 = disabled
2030 * Returns: 0 on success, -1 on failure
2032 * This need not be implemented if the driver does not take care of
2033 * association processing.
2035 int (*hapd_set_countermeasures)(void *priv, int enabled);
2038 * sta_add - Add a station entry
2039 * @priv: Private driver interface data
2040 * @params: Station parameters
2041 * Returns: 0 on success, -1 on failure
2043 * This function is used to add a station entry to the driver once the
2044 * station has completed association. This is only used if the driver
2045 * does not take care of association processing.
2047 * With TDLS, this function is also used to add or set (params->set 1)
2048 * TDLS peer entries.
2050 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2053 * get_inact_sec - Get station inactivity duration (AP only)
2054 * @priv: Private driver interface data
2055 * @addr: Station address
2056 * Returns: Number of seconds station has been inactive, -1 on failure
2058 int (*get_inact_sec)(void *priv, const u8 *addr);
2061 * sta_clear_stats - Clear station statistics (AP only)
2062 * @priv: Private driver interface data
2063 * @addr: Station address
2064 * Returns: 0 on success, -1 on failure
2066 int (*sta_clear_stats)(void *priv, const u8 *addr);
2069 * set_freq - Set channel/frequency (AP only)
2070 * @priv: Private driver interface data
2071 * @freq: Channel parameters
2072 * Returns: 0 on success, -1 on failure
2074 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2077 * set_rts - Set RTS threshold
2078 * @priv: Private driver interface data
2079 * @rts: RTS threshold in octets
2080 * Returns: 0 on success, -1 on failure
2082 int (*set_rts)(void *priv, int rts);
2085 * set_frag - Set fragmentation threshold
2086 * @priv: Private driver interface data
2087 * @frag: Fragmentation threshold in octets
2088 * Returns: 0 on success, -1 on failure
2090 int (*set_frag)(void *priv, int frag);
2093 * sta_set_flags - Set station flags (AP only)
2094 * @priv: Private driver interface data
2095 * @addr: Station address
2096 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2097 * @flags_or: Bitmap of WPA_STA_* flags to add
2098 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2099 * Returns: 0 on success, -1 on failure
2101 int (*sta_set_flags)(void *priv, const u8 *addr,
2102 int total_flags, int flags_or, int flags_and);
2105 * set_tx_queue_params - Set TX queue parameters
2106 * @priv: Private driver interface data
2107 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2111 * @burst_time: Maximum length for bursting in 0.1 msec units
2113 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2114 int cw_max, int burst_time);
2117 * if_add - Add a virtual interface
2118 * @priv: Private driver interface data
2119 * @type: Interface type
2120 * @ifname: Interface name for the new virtual interface
2121 * @addr: Local address to use for the interface or %NULL to use the
2122 * parent interface address
2123 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2124 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2125 * not allowed (applies only to %WPA_IF_AP_BSS type)
2126 * @force_ifname: Buffer for returning an interface name that the
2127 * driver ended up using if it differs from the requested ifname
2128 * @if_addr: Buffer for returning the allocated interface address
2129 * (this may differ from the requested addr if the driver cannot
2130 * change interface address)
2131 * @bridge: Bridge interface to use or %NULL if no bridge configured
2132 * @use_existing: Whether to allow existing interface to be used
2133 * Returns: 0 on success, -1 on failure
2135 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2136 const char *ifname, const u8 *addr, void *bss_ctx,
2137 void **drv_priv, char *force_ifname, u8 *if_addr,
2138 const char *bridge, int use_existing);
2141 * if_remove - Remove a virtual interface
2142 * @priv: Private driver interface data
2143 * @type: Interface type
2144 * @ifname: Interface name of the virtual interface to be removed
2145 * Returns: 0 on success, -1 on failure
2147 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2148 const char *ifname);
2151 * set_sta_vlan - Bind a station into a specific interface (AP only)
2152 * @priv: Private driver interface data
2153 * @ifname: Interface (main or virtual BSS or VLAN)
2154 * @addr: MAC address of the associated station
2156 * Returns: 0 on success, -1 on failure
2158 * This function is used to bind a station to a specific virtual
2159 * interface. It is only used if when virtual interfaces are supported,
2160 * e.g., to assign stations to different VLAN interfaces based on
2161 * information from a RADIUS server. This allows separate broadcast
2162 * domains to be used with a single BSS.
2164 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2168 * commit - Optional commit changes handler (AP only)
2169 * @priv: driver private data
2170 * Returns: 0 on success, -1 on failure
2172 * This optional handler function can be registered if the driver
2173 * interface implementation needs to commit changes (e.g., by setting
2174 * network interface up) at the end of initial configuration. If set,
2175 * this handler will be called after initial setup has been completed.
2177 int (*commit)(void *priv);
2180 * send_ether - Send an ethernet packet (AP only)
2181 * @priv: private driver interface data
2182 * @dst: Destination MAC address
2183 * @src: Source MAC address
2185 * @data: EAPOL packet starting with IEEE 802.1X header
2186 * @data_len: Length of the EAPOL packet in octets
2187 * Returns: 0 on success, -1 on failure
2189 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2190 const u8 *data, size_t data_len);
2193 * set_radius_acl_auth - Notification of RADIUS ACL change
2194 * @priv: Private driver interface data
2195 * @mac: MAC address of the station
2196 * @accepted: Whether the station was accepted
2197 * @session_timeout: Session timeout for the station
2198 * Returns: 0 on success, -1 on failure
2200 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2201 u32 session_timeout);
2204 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2205 * @priv: Private driver interface data
2206 * @mac: MAC address of the station
2207 * Returns: 0 on success, -1 on failure
2209 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2212 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2213 * @priv: Private driver interface data
2214 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2215 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2217 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2218 * to remove extra IE(s)
2219 * Returns: 0 on success, -1 on failure
2221 * This is an optional function to add WPS IE in the kernel driver for
2222 * Beacon and Probe Response frames. This can be left undefined (set
2223 * to %NULL) if the driver uses the Beacon template from set_ap()
2224 * and does not process Probe Request frames. If the driver takes care
2225 * of (Re)Association frame processing, the assocresp buffer includes
2226 * WPS IE(s) that need to be added to (Re)Association Response frames
2227 * whenever a (Re)Association Request frame indicated use of WPS.
2229 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2230 * frames when operating as a GO. The driver is responsible for adding
2231 * timing related attributes (e.g., NoA) in addition to the IEs
2232 * included here by appending them after these buffers. This call is
2233 * also used to provide Probe Response IEs for P2P Listen state
2234 * operations for drivers that generate the Probe Response frames
2237 * DEPRECATED - use set_ap() instead
2239 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2240 const struct wpabuf *proberesp,
2241 const struct wpabuf *assocresp);
2244 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2245 * @priv: Private driver interface data
2246 * @authorized: Whether the port is authorized
2247 * Returns: 0 on success, -1 on failure
2249 int (*set_supp_port)(void *priv, int authorized);
2252 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2253 * @priv: Private driver interface data
2254 * @addr: MAC address of the associated station
2255 * @aid: Association ID
2256 * @val: 1 = bind to 4-address WDS; 0 = unbind
2257 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2258 * to indicate that bridge is not to be used
2259 * @ifname_wds: Buffer to return the interface name for the new WDS
2260 * station or %NULL to indicate name is not returned.
2261 * Returns: 0 on success, -1 on failure
2263 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2264 const char *bridge_ifname, char *ifname_wds);
2267 * send_action - Transmit an Action frame
2268 * @priv: Private driver interface data
2269 * @freq: Frequency (in MHz) of the channel
2270 * @wait: Time to wait off-channel for a response (in ms), or zero
2271 * @dst: Destination MAC address (Address 1)
2272 * @src: Source MAC address (Address 2)
2273 * @bssid: BSSID (Address 3)
2275 * @data_len: data length in octets
2276 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2277 * Returns: 0 on success, -1 on failure
2279 * This command can be used to request the driver to transmit an action
2280 * frame to the specified destination.
2282 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2283 * be transmitted on the given channel and the device will wait for a
2284 * response on that channel for the given wait time.
2286 * If the flag is not set, the wait time will be ignored. In this case,
2287 * if a remain-on-channel duration is in progress, the frame must be
2288 * transmitted on that channel; alternatively the frame may be sent on
2289 * the current operational channel (if in associated state in station
2290 * mode or while operating as an AP.)
2292 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2293 const u8 *dst, const u8 *src, const u8 *bssid,
2294 const u8 *data, size_t data_len, int no_cck);
2297 * send_action_cancel_wait - Cancel action frame TX wait
2298 * @priv: Private driver interface data
2300 * This command cancels the wait time associated with sending an action
2301 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2302 * set in the driver flags.
2304 void (*send_action_cancel_wait)(void *priv);
2307 * remain_on_channel - Remain awake on a channel
2308 * @priv: Private driver interface data
2309 * @freq: Frequency (in MHz) of the channel
2310 * @duration: Duration in milliseconds
2311 * Returns: 0 on success, -1 on failure
2313 * This command is used to request the driver to remain awake on the
2314 * specified channel for the specified duration and report received
2315 * Action frames with EVENT_RX_MGMT events. Optionally, received
2316 * Probe Request frames may also be requested to be reported by calling
2317 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2319 * The driver may not be at the requested channel when this function
2320 * returns, i.e., the return code is only indicating whether the
2321 * request was accepted. The caller will need to wait until the
2322 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2323 * completed the channel change. This may take some time due to other
2324 * need for the radio and the caller should be prepared to timing out
2325 * its wait since there are no guarantees on when this request can be
2328 int (*remain_on_channel)(void *priv, unsigned int freq,
2329 unsigned int duration);
2332 * cancel_remain_on_channel - Cancel remain-on-channel operation
2333 * @priv: Private driver interface data
2335 * This command can be used to cancel a remain-on-channel operation
2336 * before its originally requested duration has passed. This could be
2337 * used, e.g., when remain_on_channel() is used to request extra time
2338 * to receive a response to an Action frame and the response is
2339 * received when there is still unneeded time remaining on the
2340 * remain-on-channel operation.
2342 int (*cancel_remain_on_channel)(void *priv);
2345 * probe_req_report - Request Probe Request frames to be indicated
2346 * @priv: Private driver interface data
2347 * @report: Whether to report received Probe Request frames
2348 * Returns: 0 on success, -1 on failure (or if not supported)
2350 * This command can be used to request the driver to indicate when
2351 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2352 * Since this operation may require extra resources, e.g., due to less
2353 * optimal hardware/firmware RX filtering, many drivers may disable
2354 * Probe Request reporting at least in station mode. This command is
2355 * used to notify the driver when the Probe Request frames need to be
2356 * reported, e.g., during remain-on-channel operations.
2358 int (*probe_req_report)(void *priv, int report);
2361 * deinit_ap - Deinitialize AP mode
2362 * @priv: Private driver interface data
2363 * Returns: 0 on success, -1 on failure (or if not supported)
2365 * This optional function can be used to disable AP mode related
2366 * configuration. If the interface was not dynamically added,
2367 * change the driver mode to station mode to allow normal station
2368 * operations like scanning to be completed.
2370 int (*deinit_ap)(void *priv);
2373 * deinit_p2p_cli - Deinitialize P2P client mode
2374 * @priv: Private driver interface data
2375 * Returns: 0 on success, -1 on failure (or if not supported)
2377 * This optional function can be used to disable P2P client mode. If the
2378 * interface was not dynamically added, change the interface type back
2381 int (*deinit_p2p_cli)(void *priv);
2384 * suspend - Notification on system suspend/hibernate event
2385 * @priv: Private driver interface data
2387 void (*suspend)(void *priv);
2390 * resume - Notification on system resume/thaw event
2391 * @priv: Private driver interface data
2393 void (*resume)(void *priv);
2396 * signal_monitor - Set signal monitoring parameters
2397 * @priv: Private driver interface data
2398 * @threshold: Threshold value for signal change events; 0 = disabled
2399 * @hysteresis: Minimum change in signal strength before indicating a
2401 * Returns: 0 on success, -1 on failure (or if not supported)
2403 * This function can be used to configure monitoring of signal strength
2404 * with the current AP. Whenever signal strength drops below the
2405 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2406 * should be generated assuming the signal strength has changed at
2407 * least %hysteresis from the previously indicated signal change event.
2409 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2412 * send_frame - Send IEEE 802.11 frame (testing use only)
2413 * @priv: Private driver interface data
2414 * @data: IEEE 802.11 frame with IEEE 802.11 header
2415 * @data_len: Size of the frame
2416 * @encrypt: Whether to encrypt the frame (if keys are set)
2417 * Returns: 0 on success, -1 on failure
2419 * This function is only used for debugging purposes and is not
2420 * required to be implemented for normal operations.
2422 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2426 * shared_freq - Get operating frequency of shared interface(s)
2427 * @priv: Private driver interface data
2428 * Returns: Operating frequency in MHz, 0 if no shared operation in
2429 * use, or -1 on failure
2431 * This command can be used to request the current operating frequency
2432 * of any virtual interface that shares the same radio to provide
2433 * information for channel selection for other virtual interfaces.
2435 int (*shared_freq)(void *priv);
2438 * get_noa - Get current Notice of Absence attribute payload
2439 * @priv: Private driver interface data
2440 * @buf: Buffer for returning NoA
2441 * @buf_len: Buffer length in octets
2442 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2443 * advertized, or -1 on failure
2445 * This function is used to fetch the current Notice of Absence
2446 * attribute value from GO.
2448 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2451 * set_noa - Set Notice of Absence parameters for GO (testing)
2452 * @priv: Private driver interface data
2454 * @start: Start time in ms from next TBTT
2455 * @duration: Duration in ms
2456 * Returns: 0 on success or -1 on failure
2458 * This function is used to set Notice of Absence parameters for GO. It
2459 * is used only for testing. To disable NoA, all parameters are set to
2462 int (*set_noa)(void *priv, u8 count, int start, int duration);
2465 * set_p2p_powersave - Set P2P power save options
2466 * @priv: Private driver interface data
2467 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2468 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2469 * @ctwindow: 0.. = change (msec), -1 = no change
2470 * Returns: 0 on success or -1 on failure
2472 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2476 * ampdu - Enable/disable aggregation
2477 * @priv: Private driver interface data
2478 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2479 * Returns: 0 on success or -1 on failure
2481 int (*ampdu)(void *priv, int ampdu);
2484 * get_radio_name - Get physical radio name for the device
2485 * @priv: Private driver interface data
2486 * Returns: Radio name or %NULL if not known
2488 * The returned data must not be modified by the caller. It is assumed
2489 * that any interface that has the same radio name as another is
2490 * sharing the same physical radio. This information can be used to
2491 * share scan results etc. information between the virtual interfaces
2492 * to speed up various operations.
2494 const char * (*get_radio_name)(void *priv);
2497 * send_tdls_mgmt - for sending TDLS management packets
2498 * @priv: private driver interface data
2499 * @dst: Destination (peer) MAC address
2500 * @action_code: TDLS action code for the mssage
2501 * @dialog_token: Dialog Token to use in the message (if needed)
2502 * @status_code: Status Code or Reason Code to use (if needed)
2503 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2504 * @initiator: Is the current end the TDLS link initiator
2505 * @buf: TDLS IEs to add to the message
2506 * @len: Length of buf in octets
2507 * Returns: 0 on success, negative (<0) on failure
2509 * This optional function can be used to send packet to driver which is
2510 * responsible for receiving and sending all TDLS packets.
2512 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2513 u8 dialog_token, u16 status_code, u32 peer_capab,
2514 int initiator, const u8 *buf, size_t len);
2517 * tdls_oper - Ask the driver to perform high-level TDLS operations
2518 * @priv: Private driver interface data
2519 * @oper: TDLS high-level operation. See %enum tdls_oper
2520 * @peer: Destination (peer) MAC address
2521 * Returns: 0 on success, negative (<0) on failure
2523 * This optional function can be used to send high-level TDLS commands
2526 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2529 * wnm_oper - Notify driver of the WNM frame reception
2530 * @priv: Private driver interface data
2531 * @oper: WNM operation. See %enum wnm_oper
2532 * @peer: Destination (peer) MAC address
2533 * @buf: Buffer for the driver to fill in (for getting IE)
2534 * @buf_len: Return the len of buf
2535 * Returns: 0 on success, negative (<0) on failure
2537 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2538 u8 *buf, u16 *buf_len);
2541 * set_qos_map - Set QoS Map
2542 * @priv: Private driver interface data
2543 * @qos_map_set: QoS Map
2544 * @qos_map_set_len: Length of QoS Map
2546 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2547 u8 qos_map_set_len);
2550 * set_wowlan - Set wake-on-wireless triggers
2551 * @priv: Private driver interface data
2552 * @triggers: wowlan triggers
2554 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2557 * signal_poll - Get current connection information
2558 * @priv: Private driver interface data
2559 * @signal_info: Connection info structure
2561 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2564 * set_authmode - Set authentication algorithm(s) for static WEP
2565 * @priv: Private driver interface data
2566 * @authmode: 1=Open System, 2=Shared Key, 3=both
2567 * Returns: 0 on success, -1 on failure
2569 * This function can be used to set authentication algorithms for AP
2570 * mode when static WEP is used. If the driver uses user space MLME/SME
2571 * implementation, there is no need to implement this function.
2573 * DEPRECATED - use set_ap() instead
2575 int (*set_authmode)(void *priv, int authmode);
2579 * driver_cmd - Execute driver-specific command
2580 * @priv: Private driver interface data
2581 * @cmd: Command to execute
2582 * @buf: Return buffer
2583 * @buf_len: Buffer length
2584 * Returns: 0 on success, -1 on failure
2586 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2587 #endif /* ANDROID */
2590 * vendor_cmd - Execute vendor specific command
2591 * @priv: Private driver interface data
2592 * @vendor_id: Vendor id
2593 * @subcmd: Vendor command id
2594 * @data: Vendor command parameters (%NULL if no parameters)
2595 * @data_len: Data length
2596 * @buf: Return buffer (%NULL to ignore reply)
2597 * Returns: 0 on success, negative (<0) on failure
2599 * This function handles vendor specific commands that are passed to
2600 * the driver/device. The command is identified by vendor id and
2601 * command id. Parameters can be passed as argument to the command
2602 * in the data buffer. Reply (if any) will be filled in the supplied
2605 * The exact driver behavior is driver interface and vendor specific. As
2606 * an example, this will be converted to a vendor specific cfg80211
2607 * command in case of the nl80211 driver interface.
2609 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2610 unsigned int subcmd, const u8 *data, size_t data_len,
2611 struct wpabuf *buf);
2614 * set_rekey_info - Set rekey information
2615 * @priv: Private driver interface data
2618 * @replay_ctr: Current EAPOL-Key Replay Counter
2620 * This optional function can be used to provide information for the
2621 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2622 * while the host (including wpa_supplicant) is sleeping.
2624 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2625 const u8 *replay_ctr);
2628 * sta_assoc - Station association indication
2629 * @priv: Private driver interface data
2630 * @own_addr: Source address and BSSID for association frame
2631 * @addr: MAC address of the station to associate
2632 * @reassoc: flag to indicate re-association
2633 * @status: association response status code
2634 * @ie: assoc response ie buffer
2635 * @len: ie buffer length
2636 * Returns: 0 on success, -1 on failure
2638 * This function indicates the driver to send (Re)Association
2639 * Response frame to the station.
2641 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2642 int reassoc, u16 status, const u8 *ie, size_t len);
2645 * sta_auth - Station authentication indication
2646 * @priv: Private driver interface data
2647 * @own_addr: Source address and BSSID for authentication frame
2648 * @addr: MAC address of the station to associate
2649 * @seq: authentication sequence number
2650 * @status: authentication response status code
2651 * @ie: authentication frame ie buffer
2652 * @len: ie buffer length
2654 * This function indicates the driver to send Authentication frame
2657 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2658 u16 seq, u16 status, const u8 *ie, size_t len);
2661 * add_tspec - Add traffic stream
2662 * @priv: Private driver interface data
2663 * @addr: MAC address of the station to associate
2664 * @tspec_ie: tspec ie buffer
2665 * @tspec_ielen: tspec ie length
2666 * Returns: 0 on success, -1 on failure
2668 * This function adds the traffic steam for the station
2669 * and fills the medium_time in tspec_ie.
2671 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2672 size_t tspec_ielen);
2675 * add_sta_node - Add a station node in the driver
2676 * @priv: Private driver interface data
2677 * @addr: MAC address of the station to add
2678 * @auth_alg: authentication algorithm used by the station
2679 * Returns: 0 on success, -1 on failure
2681 * This function adds the station node in the driver, when
2682 * the station gets added by FT-over-DS.
2684 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2687 * sched_scan - Request the driver to initiate scheduled scan
2688 * @priv: Private driver interface data
2689 * @params: Scan parameters
2690 * @interval: Interval between scan cycles in milliseconds
2691 * Returns: 0 on success, -1 on failure
2693 * This operation should be used for scheduled scan offload to
2694 * the hardware. Every time scan results are available, the
2695 * driver should report scan results event for wpa_supplicant
2696 * which will eventually request the results with
2697 * wpa_driver_get_scan_results2(). This operation is optional
2698 * and if not provided or if it returns -1, we fall back to
2699 * normal host-scheduled scans.
2701 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2705 * stop_sched_scan - Request the driver to stop a scheduled scan
2706 * @priv: Private driver interface data
2707 * Returns: 0 on success, -1 on failure
2709 * This should cause the scheduled scan to be stopped and
2710 * results should stop being sent. Must be supported if
2711 * sched_scan is supported.
2713 int (*stop_sched_scan)(void *priv);
2716 * poll_client - Probe (null data or such) the given station
2717 * @priv: Private driver interface data
2718 * @own_addr: MAC address of sending interface
2719 * @addr: MAC address of the station to probe
2720 * @qos: Indicates whether station is QoS station
2722 * This function is used to verify whether an associated station is
2723 * still present. This function does not need to be implemented if the
2724 * driver provides such inactivity polling mechanism.
2726 void (*poll_client)(void *priv, const u8 *own_addr,
2727 const u8 *addr, int qos);
2730 * radio_disable - Disable/enable radio
2731 * @priv: Private driver interface data
2732 * @disabled: 1=disable 0=enable radio
2733 * Returns: 0 on success, -1 on failure
2735 * This optional command is for testing purposes. It can be used to
2736 * disable the radio on a testbed device to simulate out-of-radio-range
2739 int (*radio_disable)(void *priv, int disabled);
2742 * switch_channel - Announce channel switch and migrate the GO to the
2744 * @priv: Private driver interface data
2745 * @settings: Settings for CSA period and new channel
2746 * Returns: 0 on success, -1 on failure
2748 * This function is used to move the GO to the legacy STA channel to
2749 * avoid frequency conflict in single channel concurrency.
2751 int (*switch_channel)(void *priv, struct csa_settings *settings);
2754 * start_dfs_cac - Listen for radar interference on the channel
2755 * @priv: Private driver interface data
2756 * @freq: Channel parameters
2757 * Returns: 0 on success, -1 on failure
2759 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
2762 * stop_ap - Removes beacon from AP
2763 * @priv: Private driver interface data
2764 * Returns: 0 on success, -1 on failure (or if not supported)
2766 * This optional function can be used to disable AP mode related
2767 * configuration. Unlike deinit_ap, it does not change to station
2770 int (*stop_ap)(void *priv);
2773 * get_survey - Retrieve survey data
2774 * @priv: Private driver interface data
2775 * @freq: If set, survey data for the specified frequency is only
2776 * being requested. If not set, all survey data is requested.
2777 * Returns: 0 on success, -1 on failure
2779 * Use this to retrieve:
2781 * - the observed channel noise floor
2782 * - the amount of time we have spent on the channel
2783 * - the amount of time during which we have spent on the channel that
2784 * the radio has determined the medium is busy and we cannot
2786 * - the amount of time we have spent receiving data
2787 * - the amount of time we have spent transmitting data
2789 * This data can be used for spectrum heuristics. One example is
2790 * Automatic Channel Selection (ACS). The channel survey data is
2791 * kept on a linked list on the channel data, one entry is added
2792 * for each survey. The min_nf of the channel is updated for each
2795 int (*get_survey)(void *priv, unsigned int freq);
2798 * status - Get driver interface status information
2799 * @priv: Private driver interface data
2800 * @buf: Buffer for printing tou the status information
2801 * @buflen: Maximum length of the buffer
2802 * Returns: Length of written status information or -1 on failure
2804 int (*status)(void *priv, char *buf, size_t buflen);
2807 * roaming - Set roaming policy for driver-based BSS selection
2808 * @priv: Private driver interface data
2809 * @allowed: Whether roaming within ESS is allowed
2810 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
2811 * Returns: Length of written status information or -1 on failure
2813 * This optional callback can be used to update roaming policy from the
2814 * associate() command (bssid being set there indicates that the driver
2815 * should not roam before getting this roaming() call to allow roaming.
2816 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
2817 * capability, roaming policy is handled within wpa_supplicant and there
2818 * is no need to implement or react to this callback.
2820 int (*roaming)(void *priv, int allowed, const u8 *bssid);
2823 * set_mac_addr - Set MAC address
2824 * @priv: Private driver interface data
2825 * @addr: MAC address to use or %NULL for setting back to permanent
2826 * Returns: 0 on success, -1 on failure
2828 int (*set_mac_addr)(void *priv, const u8 *addr);
2830 #ifdef CONFIG_MACSEC
2831 int (*macsec_init)(void *priv, struct macsec_init_params *params);
2833 int (*macsec_deinit)(void *priv);
2836 * enable_protect_frames - Set protect frames status
2837 * @priv: Private driver interface data
2838 * @enabled: TRUE = protect frames enabled
2839 * FALSE = protect frames disabled
2840 * Returns: 0 on success, -1 on failure (or if not supported)
2842 int (*enable_protect_frames)(void *priv, Boolean enabled);
2845 * set_replay_protect - Set replay protect status and window size
2846 * @priv: Private driver interface data
2847 * @enabled: TRUE = replay protect enabled
2848 * FALSE = replay protect disabled
2849 * @window: replay window size, valid only when replay protect enabled
2850 * Returns: 0 on success, -1 on failure (or if not supported)
2852 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
2855 * set_current_cipher_suite - Set current cipher suite
2856 * @priv: Private driver interface data
2857 * @cs: EUI64 identifier
2858 * @cs_len: Length of the cs buffer in octets
2859 * Returns: 0 on success, -1 on failure (or if not supported)
2861 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
2865 * enable_controlled_port - Set controlled port status
2866 * @priv: Private driver interface data
2867 * @enabled: TRUE = controlled port enabled
2868 * FALSE = controlled port disabled
2869 * Returns: 0 on success, -1 on failure (or if not supported)
2871 int (*enable_controlled_port)(void *priv, Boolean enabled);
2874 * get_receive_lowest_pn - Get receive lowest pn
2875 * @priv: Private driver interface data
2876 * @channel: secure channel
2877 * @an: association number
2878 * @lowest_pn: lowest accept pn
2879 * Returns: 0 on success, -1 on failure (or if not supported)
2881 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
2885 * get_transmit_next_pn - Get transmit next pn
2886 * @priv: Private driver interface data
2887 * @channel: secure channel
2888 * @an: association number
2890 * Returns: 0 on success, -1 on failure (or if not supported)
2892 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
2896 * set_transmit_next_pn - Set transmit next pn
2897 * @priv: Private driver interface data
2898 * @channel: secure channel
2899 * @an: association number
2901 * Returns: 0 on success, -1 on failure (or if not supported)
2903 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
2907 * get_available_receive_sc - get available receive channel
2908 * @priv: Private driver interface data
2909 * @channel: secure channel
2910 * Returns: 0 on success, -1 on failure (or if not supported)
2912 int (*get_available_receive_sc)(void *priv, u32 *channel);
2915 * create_receive_sc - create secure channel for receiving
2916 * @priv: Private driver interface data
2917 * @channel: secure channel
2918 * @sci_addr: secure channel identifier - address
2919 * @sci_port: secure channel identifier - port
2920 * @conf_offset: confidentiality offset (0, 30, or 50)
2921 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
2923 * Returns: 0 on success, -1 on failure (or if not supported)
2925 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
2926 u16 sci_port, unsigned int conf_offset,
2930 * delete_receive_sc - delete secure connection for receiving
2931 * @priv: private driver interface data from init()
2932 * @channel: secure channel
2933 * Returns: 0 on success, -1 on failure
2935 int (*delete_receive_sc)(void *priv, u32 channel);
2938 * create_receive_sa - create secure association for receive
2939 * @priv: private driver interface data from init()
2940 * @channel: secure channel
2941 * @an: association number
2942 * @lowest_pn: the lowest packet number can be received
2943 * @sak: the secure association key
2944 * Returns: 0 on success, -1 on failure
2946 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
2947 u32 lowest_pn, const u8 *sak);
2950 * enable_receive_sa - enable the SA for receive
2951 * @priv: private driver interface data from init()
2952 * @channel: secure channel
2953 * @an: association number
2954 * Returns: 0 on success, -1 on failure
2956 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
2959 * disable_receive_sa - disable SA for receive
2960 * @priv: private driver interface data from init()
2961 * @channel: secure channel index
2962 * @an: association number
2963 * Returns: 0 on success, -1 on failure
2965 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
2968 * get_available_transmit_sc - get available transmit channel
2969 * @priv: Private driver interface data
2970 * @channel: secure channel
2971 * Returns: 0 on success, -1 on failure (or if not supported)
2973 int (*get_available_transmit_sc)(void *priv, u32 *channel);
2976 * create_transmit_sc - create secure connection for transmit
2977 * @priv: private driver interface data from init()
2978 * @channel: secure channel
2979 * @sci_addr: secure channel identifier - address
2980 * @sci_port: secure channel identifier - port
2981 * Returns: 0 on success, -1 on failure
2983 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
2984 u16 sci_port, unsigned int conf_offset);
2987 * delete_transmit_sc - delete secure connection for transmit
2988 * @priv: private driver interface data from init()
2989 * @channel: secure channel
2990 * Returns: 0 on success, -1 on failure
2992 int (*delete_transmit_sc)(void *priv, u32 channel);
2995 * create_transmit_sa - create secure association for transmit
2996 * @priv: private driver interface data from init()
2997 * @channel: secure channel index
2998 * @an: association number
2999 * @next_pn: the packet number used as next transmit packet
3000 * @confidentiality: True if the SA is to provide confidentiality
3001 * as well as integrity
3002 * @sak: the secure association key
3003 * Returns: 0 on success, -1 on failure
3005 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3006 Boolean confidentiality, const u8 *sak);
3009 * enable_transmit_sa - enable SA for transmit
3010 * @priv: private driver interface data from init()
3011 * @channel: secure channel
3012 * @an: association number
3013 * Returns: 0 on success, -1 on failure
3015 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3018 * disable_transmit_sa - disable SA for transmit
3019 * @priv: private driver interface data from init()
3020 * @channel: secure channel
3021 * @an: association number
3022 * Returns: 0 on success, -1 on failure
3024 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3025 #endif /* CONFIG_MACSEC */
3030 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3032 enum wpa_event_type {
3034 * EVENT_ASSOC - Association completed
3036 * This event needs to be delivered when the driver completes IEEE
3037 * 802.11 association or reassociation successfully.
3038 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3039 * after this event has been generated. In addition, optional
3040 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3041 * more information about the association. If the driver interface gets
3042 * both of these events at the same time, it can also include the
3043 * assoc_info data in EVENT_ASSOC call.
3048 * EVENT_DISASSOC - Association lost
3050 * This event should be called when association is lost either due to
3051 * receiving deauthenticate or disassociate frame from the AP or when
3052 * sending either of these frames to the current AP. If the driver
3053 * supports separate deauthentication event, EVENT_DISASSOC should only
3054 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3055 * In AP mode, union wpa_event_data::disassoc_info is required.
3060 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3062 * This event must be delivered when a Michael MIC error is detected by
3063 * the local driver. Additional data for event processing is
3064 * provided with union wpa_event_data::michael_mic_failure. This
3065 * information is used to request new encyption key and to initiate
3066 * TKIP countermeasures if needed.
3068 EVENT_MICHAEL_MIC_FAILURE,
3071 * EVENT_SCAN_RESULTS - Scan results available
3073 * This event must be called whenever scan results are available to be
3074 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3075 * is expected to be used some time after struct wpa_driver_ops::scan()
3076 * is called. If the driver provides an unsolicited event when the scan
3077 * has been completed, this event can be used to trigger
3078 * EVENT_SCAN_RESULTS call. If such event is not available from the
3079 * driver, the driver wrapper code is expected to use a registered
3080 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3081 * scan is expected to be completed. Optional information about
3082 * completed scan can be provided with union wpa_event_data::scan_info.
3087 * EVENT_ASSOCINFO - Report optional extra information for association
3089 * This event can be used to report extra association information for
3090 * EVENT_ASSOC processing. This extra information includes IEs from
3091 * association frames and Beacon/Probe Response frames in union
3092 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3093 * EVENT_ASSOC. Alternatively, the driver interface can include
3094 * assoc_info data in the EVENT_ASSOC call if it has all the
3095 * information available at the same point.
3100 * EVENT_INTERFACE_STATUS - Report interface status changes
3102 * This optional event can be used to report changes in interface
3103 * status (interface added/removed) using union
3104 * wpa_event_data::interface_status. This can be used to trigger
3105 * wpa_supplicant to stop and re-start processing for the interface,
3106 * e.g., when a cardbus card is ejected/inserted.
3108 EVENT_INTERFACE_STATUS,
3111 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3113 * This event can be used to inform wpa_supplicant about candidates for
3114 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3115 * for scan request (ap_scan=2 mode), this event is required for
3116 * pre-authentication. If wpa_supplicant is performing scan request
3117 * (ap_scan=1), this event is optional since scan results can be used
3118 * to add pre-authentication candidates. union
3119 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3120 * candidate and priority of the candidate, e.g., based on the signal
3121 * strength, in order to try to pre-authenticate first with candidates
3122 * that are most likely targets for re-association.
3124 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3125 * on the candidate list. In addition, it can be called for the current
3126 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3127 * will automatically skip pre-authentication in cases where a valid
3128 * PMKSA exists. When more than one candidate exists, this event should
3129 * be generated once for each candidate.
3131 * Driver will be notified about successful pre-authentication with
3132 * struct wpa_driver_ops::add_pmkid() calls.
3134 EVENT_PMKID_CANDIDATE,
3137 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3139 * This event can be used to inform wpa_supplicant about desire to set
3140 * up secure direct link connection between two stations as defined in
3141 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3142 * STAKey negotiation. The caller will need to set peer address for the
3148 * EVENT_TDLS - Request TDLS operation
3150 * This event can be used to request a TDLS operation to be performed.
3155 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3157 * The driver is expected to report the received FT IEs from
3158 * FT authentication sequence from the AP. The FT IEs are included in
3159 * the extra information in union wpa_event_data::ft_ies.
3164 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3166 * The driver can use this event to inform wpa_supplicant about a STA
3167 * in an IBSS with which protected frames could be exchanged. This
3168 * event starts RSN authentication with the other STA to authenticate
3169 * the STA and set up encryption keys with it.
3171 EVENT_IBSS_RSN_START,
3174 * EVENT_AUTH - Authentication result
3176 * This event should be called when authentication attempt has been
3177 * completed. This is only used if the driver supports separate
3178 * authentication step (struct wpa_driver_ops::authenticate).
3179 * Information about authentication result is included in
3180 * union wpa_event_data::auth.
3185 * EVENT_DEAUTH - Authentication lost
3187 * This event should be called when authentication is lost either due
3188 * to receiving deauthenticate frame from the AP or when sending that
3189 * frame to the current AP.
3190 * In AP mode, union wpa_event_data::deauth_info is required.
3195 * EVENT_ASSOC_REJECT - Association rejected
3197 * This event should be called when (re)association attempt has been
3198 * rejected by the AP. Information about the association response is
3199 * included in union wpa_event_data::assoc_reject.
3204 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3206 EVENT_AUTH_TIMED_OUT,
3209 * EVENT_ASSOC_TIMED_OUT - Association timed out
3211 EVENT_ASSOC_TIMED_OUT,
3214 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
3219 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3221 EVENT_WPS_BUTTON_PUSHED,
3224 * EVENT_TX_STATUS - Report TX status
3229 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3231 EVENT_RX_FROM_UNKNOWN,
3234 * EVENT_RX_MGMT - Report RX of a management frame
3239 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3241 * This event is used to indicate when the driver has started the
3242 * requested remain-on-channel duration. Information about the
3243 * operation is included in union wpa_event_data::remain_on_channel.
3245 EVENT_REMAIN_ON_CHANNEL,
3248 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3250 * This event is used to indicate when the driver has completed
3251 * remain-on-channel duration, i.e., may noot be available on the
3252 * requested channel anymore. Information about the
3253 * operation is included in union wpa_event_data::remain_on_channel.
3255 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3258 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
3260 * This event is used only by driver_test.c and userspace MLME.
3265 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3267 * This event is used to indicate when a Probe Request frame has been
3268 * received. Information about the received frame is included in
3269 * union wpa_event_data::rx_probe_req. The driver is required to report
3270 * these events only after successfully completed probe_req_report()
3271 * commands to request the events (i.e., report parameter is non-zero)
3272 * in station mode. In AP mode, Probe Request frames should always be
3278 * EVENT_NEW_STA - New wired device noticed
3280 * This event is used to indicate that a new device has been detected
3281 * in a network that does not use association-like functionality (i.e.,
3282 * mainly wired Ethernet). This can be used to start EAPOL
3283 * authenticator when receiving a frame from a device. The address of
3284 * the device is included in union wpa_event_data::new_sta.
3289 * EVENT_EAPOL_RX - Report received EAPOL frame
3291 * When in AP mode with hostapd, this event is required to be used to
3292 * deliver the receive EAPOL frames from the driver. With
3293 * %wpa_supplicant, this event is used only if the send_eapol() handler
3294 * is used to override the use of l2_packet for EAPOL frame TX.
3299 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3301 * This event is used to indicate changes in the signal strength
3302 * observed in frames received from the current AP if signal strength
3303 * monitoring has been enabled with signal_monitor().
3305 EVENT_SIGNAL_CHANGE,
3308 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3310 * This event is used to indicate that the interface was enabled after
3311 * having been previously disabled, e.g., due to rfkill.
3313 EVENT_INTERFACE_ENABLED,
3316 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3318 * This event is used to indicate that the interface was disabled,
3319 * e.g., due to rfkill.
3321 EVENT_INTERFACE_DISABLED,
3324 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3326 * This event is used to indicate that the channel list has changed,
3327 * e.g., because of a regulatory domain change triggered by scan
3328 * results including an AP advertising a country code.
3330 EVENT_CHANNEL_LIST_CHANGED,
3333 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3335 * This event is used to indicate that the driver cannot maintain this
3336 * interface in its operation mode anymore. The most likely use for
3337 * this is to indicate that AP mode operation is not available due to
3338 * operating channel would need to be changed to a DFS channel when
3339 * the driver does not support radar detection and another virtual
3340 * interfaces caused the operating channel to change. Other similar
3341 * resource conflicts could also trigger this for station mode
3342 * interfaces. This event can be propagated when channel switching
3345 EVENT_INTERFACE_UNAVAILABLE,
3348 * EVENT_BEST_CHANNEL
3350 * Driver generates this event whenever it detects a better channel
3351 * (e.g., based on RSSI or channel use). This information can be used
3352 * to improve channel selection for a new AP/P2P group.
3357 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3359 * This event should be called when a Deauthentication frame is dropped
3360 * due to it not being protected (MFP/IEEE 802.11w).
3361 * union wpa_event_data::unprot_deauth is required to provide more
3362 * details of the frame.
3364 EVENT_UNPROT_DEAUTH,
3367 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3369 * This event should be called when a Disassociation frame is dropped
3370 * due to it not being protected (MFP/IEEE 802.11w).
3371 * union wpa_event_data::unprot_disassoc is required to provide more
3372 * details of the frame.
3374 EVENT_UNPROT_DISASSOC,
3377 * EVENT_STATION_LOW_ACK
3379 * Driver generates this event whenever it detected that a particular
3380 * station was lost. Detection can be through massive transmission
3381 * failures for example.
3383 EVENT_STATION_LOW_ACK,
3386 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3388 EVENT_IBSS_PEER_LOST,
3391 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3393 * This event carries the new replay counter to notify wpa_supplicant
3394 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3395 * completed Group Key Handshake while the host (including
3396 * wpa_supplicant was sleeping).
3398 EVENT_DRIVER_GTK_REKEY,
3401 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3403 EVENT_SCHED_SCAN_STOPPED,
3406 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3408 * This event indicates that the station responded to the poll
3409 * initiated with @poll_client.
3411 EVENT_DRIVER_CLIENT_POLL_OK,
3414 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3416 EVENT_EAPOL_TX_STATUS,
3419 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3421 * Described in wpa_event_data.ch_switch
3426 * EVENT_WNM - Request WNM operation
3428 * This event can be used to request a WNM operation to be performed.
3433 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3435 * This event indicates that the driver reported a connection failure
3436 * with the specified client (for example, max client reached, etc.) in
3439 EVENT_CONNECT_FAILED_REASON,
3442 * EVENT_RADAR_DETECTED - Notify of radar detection
3444 * A radar has been detected on the supplied frequency, hostapd should
3445 * react accordingly (e.g., change channel).
3447 EVENT_DFS_RADAR_DETECTED,
3450 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3452 * After a successful CAC, the channel can be marked clear and used.
3454 EVENT_DFS_CAC_FINISHED,
3457 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3459 * The CAC was not successful, and the channel remains in the previous
3460 * state. This may happen due to a radar beeing detected or other
3461 * external influences.
3463 EVENT_DFS_CAC_ABORTED,
3466 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3468 * The channel which was previously unavailable is now available again.
3470 EVENT_DFS_NOP_FINISHED,
3473 * EVENT_SURVEY - Received survey data
3475 * This event gets triggered when a driver query is issued for survey
3476 * data and the requested data becomes available. The returned data is
3477 * stored in struct survey_results. The results provide at most one
3478 * survey entry for each frequency and at minimum will provide one
3479 * survey entry for one frequency. The survey data can be os_malloc()'d
3480 * and then os_free()'d, so the event callback must only copy data.
3485 * EVENT_SCAN_STARTED - Scan started
3487 * This indicates that driver has started a scan operation either based
3488 * on a request from wpa_supplicant/hostapd or from another application.
3489 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3490 * completed (either successfully or by getting cancelled).
3495 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3497 * This event indicates a set of frequency ranges that should be avoided
3498 * to reduce issues due to interference or internal co-existence
3499 * information in the driver.
3501 EVENT_AVOID_FREQUENCIES
3506 * struct freq_survey - Channel survey info
3508 * @ifidx: Interface index in which this survey was observed
3509 * @freq: Center of frequency of the surveyed channel
3510 * @nf: Channel noise floor in dBm
3511 * @channel_time: Amount of time in ms the radio spent on the channel
3512 * @channel_time_busy: Amount of time in ms the radio detected some signal
3513 * that indicated to the radio the channel was not clear
3514 * @channel_time_rx: Amount of time the radio spent receiving data
3515 * @channel_time_tx: Amount of time the radio spent transmitting data
3516 * @filled: bitmask indicating which fields have been reported, see
3517 * SURVEY_HAS_* defines.
3518 * @list: Internal list pointers
3520 struct freq_survey {
3525 u64 channel_time_busy;
3526 u64 channel_time_rx;
3527 u64 channel_time_tx;
3528 unsigned int filled;
3529 struct dl_list list;
3532 #define SURVEY_HAS_NF BIT(0)
3533 #define SURVEY_HAS_CHAN_TIME BIT(1)
3534 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3535 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3536 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3540 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3542 union wpa_event_data {
3544 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3546 * This structure is optional for EVENT_ASSOC calls and required for
3547 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3548 * driver interface does not need to generate separate EVENT_ASSOCINFO
3553 * reassoc - Flag to indicate association or reassociation
3558 * req_ies - (Re)Association Request IEs
3560 * If the driver generates WPA/RSN IE, this event data must be
3561 * returned for WPA handshake to have needed information. If
3562 * wpa_supplicant-generated WPA/RSN IE is used, this
3563 * information event is optional.
3565 * This should start with the first IE (fixed fields before IEs
3566 * are not included).
3571 * req_ies_len - Length of req_ies in bytes
3576 * resp_ies - (Re)Association Response IEs
3578 * Optional association data from the driver. This data is not
3579 * required WPA, but may be useful for some protocols and as
3580 * such, should be reported if this is available to the driver
3583 * This should start with the first IE (fixed fields before IEs
3584 * are not included).
3589 * resp_ies_len - Length of resp_ies in bytes
3591 size_t resp_ies_len;
3594 * beacon_ies - Beacon or Probe Response IEs
3596 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3597 * Probe Response frames from the current AP (i.e., the one
3598 * that the client just associated with). This information is
3599 * used to update WPA/RSN IE for the AP. If this field is not
3600 * set, the results from previous scan will be used. If no
3601 * data for the new AP is found, scan results will be requested
3602 * again (without scan request). At this point, the driver is
3603 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3606 * This should start with the first IE (fixed fields before IEs
3607 * are not included).
3609 const u8 *beacon_ies;
3612 * beacon_ies_len - Length of beacon_ies */
3613 size_t beacon_ies_len;
3616 * freq - Frequency of the operational channel in MHz
3621 * addr - Station address (for AP mode)
3627 * struct disassoc_info - Data for EVENT_DISASSOC events
3629 struct disassoc_info {
3631 * addr - Station address (for AP mode)
3636 * reason_code - Reason Code (host byte order) used in
3637 * Deauthentication frame
3642 * ie - Optional IE(s) in Disassociation frame
3647 * ie_len - Length of ie buffer in octets
3652 * locally_generated - Whether the frame was locally generated
3654 int locally_generated;
3658 * struct deauth_info - Data for EVENT_DEAUTH events
3660 struct deauth_info {
3662 * addr - Station address (for AP mode)
3667 * reason_code - Reason Code (host byte order) used in
3668 * Deauthentication frame
3673 * ie - Optional IE(s) in Deauthentication frame
3678 * ie_len - Length of ie buffer in octets
3683 * locally_generated - Whether the frame was locally generated
3685 int locally_generated;
3689 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3691 struct michael_mic_failure {
3694 } michael_mic_failure;
3697 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3699 struct interface_status {
3702 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3707 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3709 struct pmkid_candidate {
3710 /** BSSID of the PMKID candidate */
3712 /** Smaller the index, higher the priority */
3714 /** Whether RSN IE includes pre-authenticate flag */
3719 * struct stkstart - Data for EVENT_STKSTART
3726 * struct tdls - Data for EVENT_TDLS
3732 TDLS_REQUEST_TEARDOWN
3734 u16 reason_code; /* for teardown */
3738 * struct wnm - Data for EVENT_WNM
3756 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3758 * During FT (IEEE 802.11r) authentication sequence, the driver is
3759 * expected to use this event to report received FT IEs (MDIE, FTIE,
3760 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3761 * IEs for the next message will be delivered through the
3762 * struct wpa_driver_ops::update_ft_ies() callback.
3768 u8 target_ap[ETH_ALEN];
3769 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3771 /** Length of ric_ies buffer in octets */
3776 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3778 struct ibss_rsn_start {
3783 * struct auth_info - Data for EVENT_AUTH events
3789 u16 auth_transaction;
3796 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3798 struct assoc_reject {
3800 * bssid - BSSID of the AP that rejected association
3805 * resp_ies - (Re)Association Response IEs
3807 * Optional association data from the driver. This data is not
3808 * required WPA, but may be useful for some protocols and as
3809 * such, should be reported if this is available to the driver
3812 * This should start with the first IE (fixed fields before IEs
3813 * are not included).
3818 * resp_ies_len - Length of resp_ies in bytes
3820 size_t resp_ies_len;
3823 * status_code - Status Code from (Re)association Response
3828 struct timeout_event {
3833 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3842 * struct tx_status - Data for EVENT_TX_STATUS events
3854 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3856 struct rx_from_unknown {
3863 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3871 * drv_priv - Pointer to store driver private BSS information
3873 * If not set to NULL, this is used for comparison with
3874 * hostapd_data->drv_priv to determine which BSS should process
3880 * freq - Frequency (in MHz) on which the frame was received
3885 * ssi_signal - Signal strength in dBm (or 0 if not available)
3891 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3893 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3895 struct remain_on_channel {
3897 * freq - Channel frequency in MHz
3902 * duration - Duration to remain on the channel in milliseconds
3904 unsigned int duration;
3905 } remain_on_channel;
3908 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3909 * @aborted: Whether the scan was aborted
3910 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3911 * @num_freqs: Number of entries in freqs array
3912 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3914 * @num_ssids: Number of entries in ssids array
3920 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3925 * struct mlme_rx - Data for EVENT_MLME_RX events
3936 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3938 struct rx_probe_req {
3940 * sa - Source address of the received Probe Request frame
3945 * da - Destination address of the received Probe Request frame
3946 * or %NULL if not available
3951 * bssid - BSSID of the received Probe Request frame or %NULL
3957 * ie - IEs from the Probe Request body
3962 * ie_len - Length of ie buffer in octets
3967 * signal - signal strength in dBm (or 0 if not available)
3973 * struct new_sta - Data for EVENT_NEW_STA events
3980 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3989 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3991 struct wpa_signal_info signal_change;
3994 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3995 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3996 * @freq_5: Best 5 GHz band channel frequency in MHz
3997 * @freq_overall: Best channel frequency in MHz
3999 * 0 can be used to indicate no preference in either band.
4001 struct best_channel {
4007 struct unprot_deauth {
4013 struct unprot_disassoc {
4020 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4021 * @addr: station address
4028 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4030 struct ibss_peer_lost {
4035 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4037 struct driver_gtk_rekey {
4039 const u8 *replay_ctr;
4043 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4044 * @addr: station address
4046 struct client_poll {
4051 * struct eapol_tx_status
4052 * @dst: Original destination
4053 * @data: Data starting with IEEE 802.1X header (!)
4054 * @data_len: Length of data
4055 * @ack: Indicates ack or lost frame
4057 * This corresponds to hapd_send_eapol if the frame sent
4058 * there isn't just reported as EVENT_TX_STATUS.
4060 struct eapol_tx_status {
4069 * @freq: Frequency of new channel in MHz
4070 * @ht_enabled: Whether this is an HT channel
4071 * @ch_offset: Secondary channel offset
4072 * @ch_width: Channel width
4073 * @cf1: Center frequency 1
4074 * @cf2: Center frequency 2
4080 enum chan_width ch_width;
4086 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4087 * @addr: Remote client address
4088 * @code: Reason code for connection failure
4090 struct connect_failed_reason {
4096 } connect_failed_reason;
4099 * struct dfs_event - Data for radar detected events
4100 * @freq: Frequency of the channel in MHz
4106 enum chan_width chan_width;
4112 * survey_results - Survey result data for EVENT_SURVEY
4113 * @freq_filter: Requested frequency survey filter, 0 if request
4114 * was for all survey data
4115 * @survey_list: Linked list of survey data
4117 struct survey_results {
4118 unsigned int freq_filter;
4119 struct dl_list survey_list; /* struct freq_survey */
4123 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4124 * @initiator: Initiator of the regulatory change
4125 * @type: Regulatory change type
4126 * @alpha2: Country code (or "" if not available)
4128 struct channel_list_changed {
4129 enum reg_change_initiator initiator;
4132 } channel_list_changed;
4135 * freq_range - List of frequency ranges
4137 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4139 struct wpa_freq_range_list freq_range;
4143 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4144 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4145 * with struct wpa_driver_ops::init()
4146 * @event: event type (defined above)
4147 * @data: possible extra data for the event
4149 * Driver wrapper code should call this function whenever an event is received
4152 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4153 union wpa_event_data *data);
4157 * The following inline functions are provided for convenience to simplify
4158 * event indication for some of the common events.
4161 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4162 size_t ielen, int reassoc)
4164 union wpa_event_data event;
4165 os_memset(&event, 0, sizeof(event));
4166 event.assoc_info.reassoc = reassoc;
4167 event.assoc_info.req_ies = ie;
4168 event.assoc_info.req_ies_len = ielen;
4169 event.assoc_info.addr = addr;
4170 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4173 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4175 union wpa_event_data event;
4176 os_memset(&event, 0, sizeof(event));
4177 event.disassoc_info.addr = addr;
4178 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4181 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4184 union wpa_event_data event;
4185 os_memset(&event, 0, sizeof(event));
4186 event.eapol_rx.src = src;
4187 event.eapol_rx.data = data;
4188 event.eapol_rx.data_len = data_len;
4189 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4192 /* driver_common.c */
4193 void wpa_scan_results_free(struct wpa_scan_results *res);
4195 /* Convert wpa_event_type to a string for logging */
4196 const char * event_to_string(enum wpa_event_type event);
4198 /* Convert chan_width to a string for logging and control interfaces */
4199 const char * channel_width_to_string(enum chan_width width);
4201 /* NULL terminated array of linked in driver wrappers */
4202 extern struct wpa_driver_ops *wpa_drivers[];
4204 #endif /* DRIVER_H */