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,
54 * struct hostapd_channel_data - Channel information
56 struct hostapd_channel_data {
58 * chan - Channel number (IEEE 802.11)
63 * freq - Frequency in MHz
68 * flag - Channel flags (HOSTAPD_CHAN_*)
73 * max_tx_power - Regulatory transmit power limit in dBm
78 * survey_list - Linked list of surveys
80 struct dl_list survey_list;
83 * min_nf - Minimum observed noise floor, in dBm, based on all
84 * surveyed channel data
90 * interference_factor - Computed interference factor on this
91 * channel (used internally in src/ap/acs.c; driver wrappers do not
94 long double interference_factor;
95 #endif /* CONFIG_ACS */
98 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
99 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
102 * struct hostapd_hw_modes - Supported hardware mode information
104 struct hostapd_hw_modes {
106 * mode - Hardware mode
108 enum hostapd_hw_mode mode;
111 * num_channels - Number of entries in the channels array
116 * channels - Array of supported channels
118 struct hostapd_channel_data *channels;
121 * num_rates - Number of entries in the rates array
126 * rates - Array of supported rates in 100 kbps units
131 * ht_capab - HT (IEEE 802.11n) capabilities
136 * mcs_set - MCS (IEEE 802.11n) rate parameters
141 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
146 * vht_capab - VHT (IEEE 802.11ac) capabilities
151 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
155 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
159 #define IEEE80211_MODE_INFRA 0
160 #define IEEE80211_MODE_IBSS 1
161 #define IEEE80211_MODE_AP 2
163 #define IEEE80211_CAP_ESS 0x0001
164 #define IEEE80211_CAP_IBSS 0x0002
165 #define IEEE80211_CAP_PRIVACY 0x0010
167 /* DMG (60 GHz) IEEE 802.11ad */
168 /* type - bits 0..1 */
169 #define IEEE80211_CAP_DMG_MASK 0x0003
170 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
171 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
172 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
174 #define WPA_SCAN_QUAL_INVALID BIT(0)
175 #define WPA_SCAN_NOISE_INVALID BIT(1)
176 #define WPA_SCAN_LEVEL_INVALID BIT(2)
177 #define WPA_SCAN_LEVEL_DBM BIT(3)
178 #define WPA_SCAN_AUTHENTICATED BIT(4)
179 #define WPA_SCAN_ASSOCIATED BIT(5)
182 * struct wpa_scan_res - Scan result for an BSS/IBSS
183 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
185 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
186 * @beacon_int: beacon interval in TUs (host byte order)
187 * @caps: capability information field in host byte order
188 * @qual: signal quality
189 * @noise: noise level
190 * @level: signal level
192 * @age: Age of the information in milliseconds (i.e., how many milliseconds
193 * ago the last Beacon or Probe Response frame was received)
194 * @ie_len: length of the following IE field in octets
195 * @beacon_ie_len: length of the following Beacon IE field in octets
197 * This structure is used as a generic format for scan results from the
198 * driver. Each driver interface implementation is responsible for converting
199 * the driver or OS specific scan results into this format.
201 * If the driver does not support reporting all IEs, the IE data structure is
202 * constructed of the IEs that are available. This field will also need to
203 * include SSID in IE format. All drivers are encouraged to be extended to
204 * report all IEs to make it easier to support future additions.
206 struct wpa_scan_res {
218 size_t beacon_ie_len;
220 * Followed by ie_len octets of IEs from Probe Response frame (or if
221 * the driver does not indicate source of IEs, these may also be from
222 * Beacon frame). After the first set of IEs, another set of IEs may
223 * follow (with beacon_ie_len octets of data) if the driver provides
229 * struct wpa_scan_results - Scan results
230 * @res: Array of pointers to allocated variable length scan result entries
231 * @num: Number of entries in the scan result array
232 * @fetch_time: Time when the results were fetched from the driver
234 struct wpa_scan_results {
235 struct wpa_scan_res **res;
237 struct os_reltime fetch_time;
241 * struct wpa_interface_info - Network interface information
242 * @next: Pointer to the next interface or NULL if this is the last one
243 * @ifname: Interface name that can be used with init() or init2()
244 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
246 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
247 * is not an allocated copy, i.e., get_interfaces() caller will not free
250 struct wpa_interface_info {
251 struct wpa_interface_info *next;
254 const char *drv_name;
257 #define WPAS_MAX_SCAN_SSIDS 16
260 * struct wpa_driver_scan_params - Scan parameters
261 * Data for struct wpa_driver_ops::scan2().
263 struct wpa_driver_scan_params {
265 * ssids - SSIDs to scan for
267 struct wpa_driver_scan_ssid {
269 * ssid - specific SSID to scan for (ProbeReq)
270 * %NULL or zero-length SSID is used to indicate active scan
271 * with wildcard SSID.
275 * ssid_len: Length of the SSID in octets
278 } ssids[WPAS_MAX_SCAN_SSIDS];
281 * num_ssids - Number of entries in ssids array
282 * Zero indicates a request for a passive scan.
287 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
292 * extra_ies_len - Length of extra_ies in octets
294 size_t extra_ies_len;
297 * freqs - Array of frequencies to scan or %NULL for all frequencies
299 * The frequency is set in MHz. The array is zero-terminated.
304 * filter_ssids - Filter for reporting SSIDs
306 * This optional parameter can be used to request the driver wrapper to
307 * filter scan results to include only the specified SSIDs. %NULL
308 * indicates that no filtering is to be done. This can be used to
309 * reduce memory needs for scan results in environments that have large
310 * number of APs with different SSIDs.
312 * The driver wrapper is allowed to take this allocated buffer into its
313 * own use by setting the pointer to %NULL. In that case, the driver
314 * wrapper is responsible for freeing the buffer with os_free() once it
315 * is not needed anymore.
317 struct wpa_driver_scan_filter {
323 * num_filter_ssids - Number of entries in filter_ssids array
325 size_t num_filter_ssids;
328 * filter_rssi - Filter by RSSI
330 * The driver may filter scan results in firmware to reduce host
331 * wakeups and thereby save power. Specify the RSSI threshold in s32
337 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
339 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
340 * Mbps from the support rates element(s) in the Probe Request frames
341 * and not to transmit the frames at any of those rates.
346 * only_new_results - Request driver to report only new results
348 * This is used to request the driver to report only BSSes that have
349 * been detected after this scan request has been started, i.e., to
350 * flush old cached BSS entries.
352 int only_new_results;
355 * NOTE: Whenever adding new parameters here, please make sure
356 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
362 * struct wpa_driver_auth_params - Authentication parameters
363 * Data for struct wpa_driver_ops::authenticate().
365 struct wpa_driver_auth_params {
373 const u8 *wep_key[4];
374 size_t wep_key_len[4];
376 int local_state_change;
379 * p2p - Whether this connection is a P2P group
389 WPS_MODE_NONE /* no WPS provisioning being used */,
390 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
391 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
396 * struct wpa_driver_associate_params - Association parameters
397 * Data for struct wpa_driver_ops::associate().
399 struct wpa_driver_associate_params {
401 * bssid - BSSID of the selected AP
402 * This can be %NULL, if ap_scan=2 mode is used and the driver is
403 * responsible for selecting with which BSS to associate. */
407 * bssid_hint - BSSID of a proposed AP
409 * This indicates which BSS has been found a suitable candidate for
410 * initial association for drivers that use driver/firmwate-based BSS
411 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
412 * the driver from selecting other BSSes in the ESS.
414 const u8 *bssid_hint;
417 * ssid - The selected SSID
422 * ssid_len - Length of the SSID (1..32)
427 * freq - Frequency of the channel the selected AP is using
428 * Frequency that the selected AP is using (in MHz as
429 * reported in the scan results)
434 * freq_hint - Frequency of the channel the proposed AP is using
436 * This provides a channel on which a suitable BSS has been found as a
437 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
438 * limit the driver from selecting other channels for
439 * driver/firmware-based BSS selection.
444 * bg_scan_period - Background scan period in seconds, 0 to disable
445 * background scan, or -1 to indicate no change to default driver
451 * beacon_int - Beacon interval for IBSS or 0 to use driver default
456 * wpa_ie - WPA information element for (Re)Association Request
457 * WPA information element to be included in (Re)Association
458 * Request (including information element id and length). Use
459 * of this WPA IE is optional. If the driver generates the WPA
460 * IE, it can use pairwise_suite, group_suite, and
461 * key_mgmt_suite to select proper algorithms. In this case,
462 * the driver has to notify wpa_supplicant about the used WPA
463 * IE by generating an event that the interface code will
464 * convert into EVENT_ASSOCINFO data (see below).
466 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
467 * instead. The driver can determine which version is used by
468 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
471 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
476 * wpa_ie_len - length of the wpa_ie
481 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
483 unsigned int wpa_proto;
486 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
488 * This is usually ignored if @wpa_ie is used.
490 unsigned int pairwise_suite;
493 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
495 * This is usually ignored if @wpa_ie is used.
497 unsigned int group_suite;
500 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
502 * This is usually ignored if @wpa_ie is used.
504 unsigned int key_mgmt_suite;
507 * auth_alg - Allowed authentication algorithms
508 * Bit field of WPA_AUTH_ALG_*
513 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
518 * wep_key - WEP keys for static WEP configuration
520 const u8 *wep_key[4];
523 * wep_key_len - WEP key length for static WEP configuration
525 size_t wep_key_len[4];
528 * wep_tx_keyidx - WEP TX key index for static WEP configuration
533 * mgmt_frame_protection - IEEE 802.11w management frame protection
535 enum mfp_options mgmt_frame_protection;
538 * ft_ies - IEEE 802.11r / FT information elements
539 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
540 * for fast transition, this parameter is set to include the IEs that
541 * are to be sent in the next FT Authentication Request message.
542 * update_ft_ies() handler is called to update the IEs for further
543 * FT messages in the sequence.
545 * The driver should use these IEs only if the target AP is advertising
546 * the same mobility domain as the one included in the MDIE here.
548 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
549 * AP after the initial association. These IEs can only be used if the
550 * target AP is advertising support for FT and is using the same MDIE
551 * and SSID as the current AP.
553 * The driver is responsible for reporting the FT IEs received from the
554 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
555 * type. update_ft_ies() handler will then be called with the FT IEs to
556 * include in the next frame in the authentication sequence.
561 * ft_ies_len - Length of ft_ies in bytes
566 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
568 * This value is provided to allow the driver interface easier access
569 * to the current mobility domain. This value is set to %NULL if no
570 * mobility domain is currently active.
575 * passphrase - RSN passphrase for PSK
577 * This value is made available only for WPA/WPA2-Personal (PSK) and
578 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
579 * the 8..63 character ASCII passphrase, if available. Please note that
580 * this can be %NULL if passphrase was not used to generate the PSK. In
581 * that case, the psk field must be used to fetch the PSK.
583 const char *passphrase;
586 * psk - RSN PSK (alternative for passphrase for PSK)
588 * This value is made available only for WPA/WPA2-Personal (PSK) and
589 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
590 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
591 * be prepared to handle %NULL value as an error.
596 * drop_unencrypted - Enable/disable unencrypted frame filtering
598 * Configure the driver to drop all non-EAPOL frames (both receive and
599 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
600 * still be allowed for key negotiation.
602 int drop_unencrypted;
605 * prev_bssid - Previously used BSSID in this ESS
607 * When not %NULL, this is a request to use reassociation instead of
610 const u8 *prev_bssid;
615 * If the driver needs to do special configuration for WPS association,
616 * this variable provides more information on what type of association
617 * is being requested. Most drivers should not need ot use this.
622 * p2p - Whether this connection is a P2P group
627 * uapsd - UAPSD parameters for the network
628 * -1 = do not change defaults
629 * AP mode: 1 = enabled, 0 = disabled
630 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
635 * fixed_bssid - Whether to force this BSSID in IBSS mode
636 * 1 = Fix this BSSID and prevent merges.
637 * 0 = Do not fix BSSID.
642 * disable_ht - Disable HT (IEEE 802.11n) for this connection
647 * HT Capabilities over-rides. Only bits set in the mask will be used,
648 * and not all values are used by the kernel anyway. Currently, MCS,
649 * MPDU and MSDU fields are used.
651 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */
652 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */
654 #ifdef CONFIG_VHT_OVERRIDES
656 * disable_vht - Disable VHT for this connection
661 * VHT capability overrides.
663 const struct ieee80211_vht_capabilities *vhtcaps;
664 const struct ieee80211_vht_capabilities *vhtcaps_mask;
665 #endif /* CONFIG_VHT_OVERRIDES */
670 HIDDEN_SSID_ZERO_LEN,
671 HIDDEN_SSID_ZERO_CONTENTS
674 struct wpa_driver_ap_params {
676 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
681 * head_len - Length of the head buffer in octets
686 * tail - Beacon tail following TIM IE
691 * tail_len - Length of the tail buffer in octets
696 * dtim_period - DTIM period
701 * beacon_int - Beacon interval
706 * basic_rates: -1 terminated array of basic rates in 100 kbps
708 * This parameter can be used to set a specific basic rate set for the
709 * BSS. If %NULL, default basic rate set is used.
714 * proberesp - Probe Response template
716 * This is used by drivers that reply to Probe Requests internally in
717 * AP mode and require the full Probe Response template.
722 * proberesp_len - Length of the proberesp buffer in octets
724 size_t proberesp_len;
727 * ssid - The SSID to use in Beacon/Probe Response frames
732 * ssid_len - Length of the SSID (1..32)
737 * hide_ssid - Whether to hide the SSID
739 enum hide_ssid hide_ssid;
742 * pairwise_ciphers - WPA_CIPHER_* bitfield
744 unsigned int pairwise_ciphers;
747 * group_cipher - WPA_CIPHER_*
749 unsigned int group_cipher;
752 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
754 unsigned int key_mgmt_suites;
757 * auth_algs - WPA_AUTH_ALG_* bitfield
759 unsigned int auth_algs;
762 * wpa_version - WPA_PROTO_* bitfield
764 unsigned int wpa_version;
767 * privacy - Whether privacy is used in the BSS
772 * beacon_ies - WPS/P2P IE(s) for Beacon frames
774 * This is used to add IEs like WPS IE and P2P IE by drivers that do
775 * not use the full Beacon template.
777 const struct wpabuf *beacon_ies;
780 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
782 * This is used to add IEs like WPS IE and P2P IE by drivers that
783 * reply to Probe Request frames internally.
785 const struct wpabuf *proberesp_ies;
788 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
790 * This is used to add IEs like WPS IE by drivers that reply to
791 * (Re)Association Request frames internally.
793 const struct wpabuf *assocresp_ies;
796 * isolate - Whether to isolate frames between associated stations
798 * If this is non-zero, the AP is requested to disable forwarding of
799 * frames between associated stations.
804 * cts_protect - Whether CTS protection is enabled
809 * preamble - Whether short preamble is enabled
814 * short_slot_time - Whether short slot time is enabled
816 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
817 * not set (e.g., when 802.11g mode is not in use)
822 * ht_opmode - HT operation mode or -1 if HT not in use
827 * interworking - Whether Interworking is enabled
832 * hessid - Homogeneous ESS identifier or %NULL if not set
837 * access_network_type - Access Network Type (0..15)
839 * This is used for filtering Probe Request frames when Interworking is
842 u8 access_network_type;
845 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
847 * This is used by driver which advertises this capability.
849 int ap_max_inactivity;
852 * disable_dgaf - Whether group-addressed frames are disabled
857 * osen - Whether OSEN security is enabled
863 * struct wpa_driver_capa - Driver capability information
865 struct wpa_driver_capa {
866 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
867 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
868 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
869 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
870 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
871 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
872 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
873 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
874 unsigned int key_mgmt;
876 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
877 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
878 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
879 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
880 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
881 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
882 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
883 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
884 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
885 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
886 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
887 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
888 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
891 #define WPA_DRIVER_AUTH_OPEN 0x00000001
892 #define WPA_DRIVER_AUTH_SHARED 0x00000002
893 #define WPA_DRIVER_AUTH_LEAP 0x00000004
896 /* Driver generated WPA/RSN IE */
897 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
898 /* Driver needs static WEP key setup after association command */
899 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
900 /* Driver takes care of all DFS operations */
901 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
902 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
903 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
904 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
905 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
906 /* Driver provides separate commands for authentication and association (SME in
907 * wpa_supplicant). */
908 #define WPA_DRIVER_FLAGS_SME 0x00000020
909 /* Driver supports AP mode */
910 #define WPA_DRIVER_FLAGS_AP 0x00000040
911 /* Driver needs static WEP key setup after association has been completed */
912 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
913 /* unused: 0x00000100 */
914 /* Driver supports concurrent P2P operations */
915 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
917 * Driver uses the initial interface as a dedicated management interface, i.e.,
918 * it cannot be used for P2P group operations or non-P2P purposes.
920 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
921 /* This interface is P2P capable (P2P GO or P2P Client) */
922 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
923 /* Driver supports station and key removal when stopping an AP */
924 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
926 * Driver uses the initial interface for P2P management interface and non-P2P
927 * purposes (e.g., connect to infra AP), but this interface cannot be used for
928 * P2P group operations.
930 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
932 * Driver is known to use sane error codes, i.e., when it indicates that
933 * something (e.g., association) fails, there was indeed a failure and the
934 * operation does not end up getting completed successfully later.
936 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
937 /* Driver supports off-channel TX */
938 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
939 /* Driver indicates TX status events for EAPOL Data frames */
940 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
941 /* Driver indicates TX status events for Deauth/Disassoc frames */
942 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
943 /* Driver supports roaming (BSS selection) in firmware */
944 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
945 /* Driver supports operating as a TDLS peer */
946 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
947 /* Driver requires external TDLS setup/teardown/discovery */
948 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
949 /* Driver indicates support for Probe Response offloading in AP mode */
950 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
951 /* Driver supports U-APSD in AP mode */
952 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
953 /* Driver supports inactivity timer in AP mode */
954 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
955 /* Driver expects user space implementation of MLME in AP mode */
956 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
957 /* Driver supports SAE with user space SME */
958 #define WPA_DRIVER_FLAGS_SAE 0x02000000
959 /* Driver makes use of OBSS scan mechanism in wpa_supplicant */
960 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
961 /* Driver supports IBSS (Ad-hoc) mode */
962 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
963 /* Driver supports radar detection */
964 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
965 /* Driver supports a dedicated interface for P2P Device */
966 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
967 /* Driver supports QoS Mapping */
968 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
969 /* Driver supports CSA in AP mode */
970 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
974 int max_sched_scan_ssids;
975 int sched_scan_supported;
979 * max_remain_on_chan - Maximum remain-on-channel duration in msec
981 unsigned int max_remain_on_chan;
984 * max_stations - Maximum number of associated stations the driver
985 * supports in AP mode
987 unsigned int max_stations;
990 * probe_resp_offloads - Bitmap of supported protocols by the driver
991 * for Probe Response offloading.
993 /* Driver Probe Response offloading support for WPS ver. 1 */
994 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
995 /* Driver Probe Response offloading support for WPS ver. 2 */
996 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
997 /* Driver Probe Response offloading support for P2P */
998 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
999 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1000 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1001 unsigned int probe_resp_offloads;
1003 unsigned int max_acl_mac_addrs;
1006 * Number of supported concurrent channels
1008 unsigned int num_multichan_concurrent;
1011 * extended_capa - extended capabilities in driver/device
1013 * Must be allocated and freed by driver and the pointers must be
1014 * valid for the lifetime of the driver, i.e., freed in deinit()
1016 const u8 *extended_capa, *extended_capa_mask;
1017 unsigned int extended_capa_len;
1021 struct hostapd_data;
1023 struct hostap_sta_driver_data {
1024 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1025 unsigned long current_tx_rate;
1026 unsigned long inactive_msec;
1027 unsigned long flags;
1028 unsigned long num_ps_buf_frames;
1029 unsigned long tx_retry_failed;
1030 unsigned long tx_retry_count;
1035 struct hostapd_sta_add_params {
1039 const u8 *supp_rates;
1040 size_t supp_rates_len;
1041 u16 listen_interval;
1042 const struct ieee80211_ht_capabilities *ht_capabilities;
1043 const struct ieee80211_vht_capabilities *vht_capabilities;
1044 int vht_opmode_enabled;
1046 u32 flags; /* bitmask of WPA_STA_* flags */
1047 int set; /* Set STA parameters instead of add */
1049 const u8 *ext_capab;
1050 size_t ext_capab_len;
1051 const u8 *supp_channels;
1052 size_t supp_channels_len;
1053 const u8 *supp_oper_classes;
1054 size_t supp_oper_classes_len;
1057 struct hostapd_freq_params {
1063 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
1064 * secondary channel below primary, 1 = HT40
1065 * enabled, secondary channel above primary */
1070 /* valid for both HT and VHT, center_freq2 is non-zero
1071 * only for bandwidth 80 and an 80+80 channel */
1072 int center_freq1, center_freq2;
1076 struct mac_address {
1080 struct hostapd_acl_params {
1082 unsigned int num_mac_acl;
1083 struct mac_address mac_acl[0];
1086 enum wpa_driver_if_type {
1088 * WPA_IF_STATION - Station mode interface
1093 * WPA_IF_AP_VLAN - AP mode VLAN interface
1095 * This interface shares its address and Beacon frame with the main
1101 * WPA_IF_AP_BSS - AP mode BSS interface
1103 * This interface has its own address and Beacon frame.
1108 * WPA_IF_P2P_GO - P2P Group Owner
1113 * WPA_IF_P2P_CLIENT - P2P Client
1118 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1119 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1124 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1125 * abstracted P2P Device function in the driver
1130 struct wpa_init_params {
1136 const char *test_socket;
1137 int use_pae_group_addr;
1141 u8 *own_addr; /* buffer for writing own MAC address */
1145 struct wpa_bss_params {
1146 /** Interface name (for multi-SSID/VLAN support) */
1148 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1157 enum mfp_options ieee80211w;
1160 #define WPA_STA_AUTHORIZED BIT(0)
1161 #define WPA_STA_WMM BIT(1)
1162 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1163 #define WPA_STA_MFP BIT(3)
1164 #define WPA_STA_TDLS_PEER BIT(4)
1177 WNM_SLEEP_ENTER_CONFIRM,
1178 WNM_SLEEP_ENTER_FAIL,
1179 WNM_SLEEP_EXIT_CONFIRM,
1180 WNM_SLEEP_EXIT_FAIL,
1181 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1182 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1183 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1185 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1187 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1188 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1190 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1193 /* enum chan_width - Channel width definitions */
1205 * struct wpa_signal_info - Information about channel signal quality
1207 struct wpa_signal_info {
1209 int above_threshold;
1214 enum chan_width chanwidth;
1220 * struct beacon_data - Beacon data
1221 * @head: Head portion of Beacon frame (before TIM IE)
1222 * @tail: Tail portion of Beacon frame (after TIM IE)
1223 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1224 * @proberesp_ies: Extra information element(s) to add into Probe Response
1226 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1227 * Response frames or %NULL
1228 * @probe_resp: Probe Response frame template
1229 * @head_len: Length of @head
1230 * @tail_len: Length of @tail
1231 * @beacon_ies_len: Length of beacon_ies in octets
1232 * @proberesp_ies_len: Length of proberesp_ies in octets
1233 * @proberesp_ies_len: Length of proberesp_ies in octets
1234 * @probe_resp_len: Length of probe response template (@probe_resp)
1236 struct beacon_data {
1243 size_t head_len, tail_len;
1244 size_t beacon_ies_len;
1245 size_t proberesp_ies_len;
1246 size_t assocresp_ies_len;
1247 size_t probe_resp_len;
1251 * struct csa_settings - Settings for channel switch command
1252 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1253 * @block_tx: 1 - block transmission for CSA period
1254 * @freq_params: Next channel frequency parameter
1255 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1256 * @beacon_after: Next beacon/probe resp/asooc resp info
1257 * @counter_offset_beacon: Offset to the count field in beacon's tail
1258 * @counter_offset_presp: Offset to the count field in probe resp.
1260 struct csa_settings {
1264 struct hostapd_freq_params freq_params;
1265 struct beacon_data beacon_csa;
1266 struct beacon_data beacon_after;
1268 u16 counter_offset_beacon;
1269 u16 counter_offset_presp;
1272 /* TDLS peer capabilities for send_tdls_mgmt() */
1273 enum tdls_peer_capability {
1274 TDLS_PEER_HT = BIT(0),
1275 TDLS_PEER_VHT = BIT(1),
1276 TDLS_PEER_WMM = BIT(2),
1280 * struct wpa_driver_ops - Driver interface API definition
1282 * This structure defines the API that each driver interface needs to implement
1283 * for core wpa_supplicant code. All driver specific functionality is captured
1286 struct wpa_driver_ops {
1287 /** Name of the driver interface */
1289 /** One line description of the driver interface */
1293 * get_bssid - Get the current BSSID
1294 * @priv: private driver interface data
1295 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1297 * Returns: 0 on success, -1 on failure
1299 * Query kernel driver for the current BSSID and copy it to bssid.
1300 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1303 int (*get_bssid)(void *priv, u8 *bssid);
1306 * get_ssid - Get the current SSID
1307 * @priv: private driver interface data
1308 * @ssid: buffer for SSID (at least 32 bytes)
1310 * Returns: Length of the SSID on success, -1 on failure
1312 * Query kernel driver for the current SSID and copy it to ssid.
1313 * Returning zero is recommended if the STA is not associated.
1315 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1316 * can, at least in theory, contain control characters (including nul)
1317 * and as such, should be processed as binary data, not a printable
1320 int (*get_ssid)(void *priv, u8 *ssid);
1323 * set_key - Configure encryption key
1324 * @ifname: Interface name (for multi-SSID/VLAN support)
1325 * @priv: private driver interface data
1326 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1327 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1328 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1329 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1330 * %WPA_ALG_BIP_CMAC_256);
1331 * %WPA_ALG_NONE clears the key.
1332 * @addr: Address of the peer STA (BSSID of the current AP when setting
1333 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1334 * broadcast keys, %NULL for default keys that are used both for
1335 * broadcast and unicast; when clearing keys, %NULL is used to
1336 * indicate that both the broadcast-only and default key of the
1337 * specified key index is to be cleared
1338 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1340 * @set_tx: configure this key as the default Tx key (only used when
1341 * driver does not support separate unicast/individual key
1342 * @seq: sequence number/packet number, seq_len octets, the next
1343 * packet number to be used for in replay protection; configured
1344 * for Rx keys (in most cases, this is only used with broadcast
1345 * keys and set to zero for unicast keys); %NULL if not set
1346 * @seq_len: length of the seq, depends on the algorithm:
1347 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1348 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1350 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1351 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1353 * Returns: 0 on success, -1 on failure
1355 * Configure the given key for the kernel driver. If the driver
1356 * supports separate individual keys (4 default keys + 1 individual),
1357 * addr can be used to determine whether the key is default or
1358 * individual. If only 4 keys are supported, the default key with key
1359 * index 0 is used as the individual key. STA must be configured to use
1360 * it as the default Tx key (set_tx is set) and accept Rx for all the
1361 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1362 * broadcast keys, so key index 0 is available for this kind of
1365 * Please note that TKIP keys include separate TX and RX MIC keys and
1366 * some drivers may expect them in different order than wpa_supplicant
1367 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1368 * will trigger Michael MIC errors. This can be fixed by changing the
1369 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1370 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1371 * example on how this can be done.
1373 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1374 const u8 *addr, int key_idx, int set_tx,
1375 const u8 *seq, size_t seq_len,
1376 const u8 *key, size_t key_len);
1379 * init - Initialize driver interface
1380 * @ctx: context to be used when calling wpa_supplicant functions,
1381 * e.g., wpa_supplicant_event()
1382 * @ifname: interface name, e.g., wlan0
1384 * Returns: Pointer to private data, %NULL on failure
1386 * Initialize driver interface, including event processing for kernel
1387 * driver events (e.g., associated, scan results, Michael MIC failure).
1388 * This function can allocate a private configuration data area for
1389 * @ctx, file descriptor, interface name, etc. information that may be
1390 * needed in future driver operations. If this is not used, non-NULL
1391 * value will need to be returned because %NULL is used to indicate
1392 * failure. The returned value will be used as 'void *priv' data for
1393 * all other driver_ops functions.
1395 * The main event loop (eloop.c) of wpa_supplicant can be used to
1396 * register callback for read sockets (eloop_register_read_sock()).
1398 * See below for more information about events and
1399 * wpa_supplicant_event() function.
1401 void * (*init)(void *ctx, const char *ifname);
1404 * deinit - Deinitialize driver interface
1405 * @priv: private driver interface data from init()
1407 * Shut down driver interface and processing of driver events. Free
1408 * private data buffer if one was allocated in init() handler.
1410 void (*deinit)(void *priv);
1413 * set_param - Set driver configuration parameters
1414 * @priv: private driver interface data from init()
1415 * @param: driver specific configuration parameters
1417 * Returns: 0 on success, -1 on failure
1419 * Optional handler for notifying driver interface about configuration
1420 * parameters (driver_param).
1422 int (*set_param)(void *priv, const char *param);
1425 * set_countermeasures - Enable/disable TKIP countermeasures
1426 * @priv: private driver interface data
1427 * @enabled: 1 = countermeasures enabled, 0 = disabled
1429 * Returns: 0 on success, -1 on failure
1431 * Configure TKIP countermeasures. When these are enabled, the driver
1432 * should drop all received and queued frames that are using TKIP.
1434 int (*set_countermeasures)(void *priv, int enabled);
1437 * deauthenticate - Request driver to deauthenticate
1438 * @priv: private driver interface data
1439 * @addr: peer address (BSSID of the AP)
1440 * @reason_code: 16-bit reason code to be sent in the deauthentication
1443 * Returns: 0 on success, -1 on failure
1445 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1448 * associate - Request driver to associate
1449 * @priv: private driver interface data
1450 * @params: association parameters
1452 * Returns: 0 on success, -1 on failure
1454 int (*associate)(void *priv,
1455 struct wpa_driver_associate_params *params);
1458 * add_pmkid - Add PMKSA cache entry to the driver
1459 * @priv: private driver interface data
1460 * @bssid: BSSID for the PMKSA cache entry
1461 * @pmkid: PMKID for the PMKSA cache entry
1463 * Returns: 0 on success, -1 on failure
1465 * This function is called when a new PMK is received, as a result of
1466 * either normal authentication or RSN pre-authentication.
1468 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1469 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1470 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1471 * driver_ops function does not need to be implemented. Likewise, if
1472 * the driver does not support WPA, this function is not needed.
1474 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1477 * remove_pmkid - Remove PMKSA cache entry to the driver
1478 * @priv: private driver interface data
1479 * @bssid: BSSID for the PMKSA cache entry
1480 * @pmkid: PMKID for the PMKSA cache entry
1482 * Returns: 0 on success, -1 on failure
1484 * This function is called when the supplicant drops a PMKSA cache
1485 * entry for any reason.
1487 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1488 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1489 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1490 * from wpa_supplicant, this driver_ops function does not need to be
1491 * implemented. Likewise, if the driver does not support WPA, this
1492 * function is not needed.
1494 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1497 * flush_pmkid - Flush PMKSA cache
1498 * @priv: private driver interface data
1500 * Returns: 0 on success, -1 on failure
1502 * This function is called when the supplicant drops all PMKSA cache
1503 * entries for any reason.
1505 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1506 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1507 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1508 * from wpa_supplicant, this driver_ops function does not need to be
1509 * implemented. Likewise, if the driver does not support WPA, this
1510 * function is not needed.
1512 int (*flush_pmkid)(void *priv);
1515 * get_capa - Get driver capabilities
1516 * @priv: private driver interface data
1518 * Returns: 0 on success, -1 on failure
1520 * Get driver/firmware/hardware capabilities.
1522 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1525 * poll - Poll driver for association information
1526 * @priv: private driver interface data
1528 * This is an option callback that can be used when the driver does not
1529 * provide event mechanism for association events. This is called when
1530 * receiving WPA EAPOL-Key messages that require association
1531 * information. The driver interface is supposed to generate associnfo
1532 * event before returning from this callback function. In addition, the
1533 * driver interface should generate an association event after having
1534 * sent out associnfo.
1536 void (*poll)(void *priv);
1539 * get_ifname - Get interface name
1540 * @priv: private driver interface data
1542 * Returns: Pointer to the interface name. This can differ from the
1543 * interface name used in init() call. Init() is called first.
1545 * This optional function can be used to allow the driver interface to
1546 * replace the interface name with something else, e.g., based on an
1547 * interface mapping from a more descriptive name.
1549 const char * (*get_ifname)(void *priv);
1552 * get_mac_addr - Get own MAC address
1553 * @priv: private driver interface data
1555 * Returns: Pointer to own MAC address or %NULL on failure
1557 * This optional function can be used to get the own MAC address of the
1558 * device from the driver interface code. This is only needed if the
1559 * l2_packet implementation for the OS does not provide easy access to
1561 const u8 * (*get_mac_addr)(void *priv);
1564 * send_eapol - Optional function for sending EAPOL packets
1565 * @priv: private driver interface data
1566 * @dest: Destination MAC address
1568 * @data: EAPOL packet starting with IEEE 802.1X header
1569 * @data_len: Size of the EAPOL packet
1571 * Returns: 0 on success, -1 on failure
1573 * This optional function can be used to override l2_packet operations
1574 * with driver specific functionality. If this function pointer is set,
1575 * l2_packet module is not used at all and the driver interface code is
1576 * responsible for receiving and sending all EAPOL packets. The
1577 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1578 * event. The driver interface is required to implement get_mac_addr()
1579 * handler if send_eapol() is used.
1581 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1582 const u8 *data, size_t data_len);
1585 * set_operstate - Sets device operating state to DORMANT or UP
1586 * @priv: private driver interface data
1587 * @state: 0 = dormant, 1 = up
1588 * Returns: 0 on success, -1 on failure
1590 * This is an optional function that can be used on operating systems
1591 * that support a concept of controlling network device state from user
1592 * space applications. This function, if set, gets called with
1593 * state = 1 when authentication has been completed and with state = 0
1594 * when connection is lost.
1596 int (*set_operstate)(void *priv, int state);
1599 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1600 * @priv: Private driver interface data
1601 * @addr: Address of the station for which to set protection (may be
1602 * %NULL for group keys)
1603 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1604 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1605 * Returns: 0 on success, -1 on failure
1607 * This is an optional function that can be used to set the driver to
1608 * require protection for Tx and/or Rx frames. This uses the layer
1609 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1610 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1611 * set protection operation; instead, they set protection implicitly
1612 * based on configured keys.
1614 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1618 * get_hw_feature_data - Get hardware support data (channels and rates)
1619 * @priv: Private driver interface data
1620 * @num_modes: Variable for returning the number of returned modes
1621 * flags: Variable for returning hardware feature flags
1622 * Returns: Pointer to allocated hardware data on success or %NULL on
1623 * failure. Caller is responsible for freeing this.
1625 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1630 * send_mlme - Send management frame from MLME
1631 * @priv: Private driver interface data
1632 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1633 * @data_len: Size of the management frame
1634 * @noack: Do not wait for this frame to be acked (disable retries)
1635 * Returns: 0 on success, -1 on failure
1637 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1641 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1642 * @priv: Private driver interface data
1643 * @md: Mobility domain (2 octets) (also included inside ies)
1644 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1645 * @ies_len: Length of FT IEs in bytes
1646 * Returns: 0 on success, -1 on failure
1648 * The supplicant uses this callback to let the driver know that keying
1649 * material for FT is available and that the driver can use the
1650 * provided IEs in the next message in FT authentication sequence.
1652 * This function is only needed for driver that support IEEE 802.11r
1653 * (Fast BSS Transition).
1655 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1659 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1660 * @priv: Private driver interface data
1661 * @action: Action field value
1662 * @target_ap: Target AP address
1663 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1664 * @ies_len: Length of FT IEs in bytes
1665 * Returns: 0 on success, -1 on failure
1667 * The supplicant uses this callback to request the driver to transmit
1668 * an FT Action frame (action category 6) for over-the-DS fast BSS
1671 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1672 const u8 *ies, size_t ies_len);
1675 * get_scan_results2 - Fetch the latest scan results
1676 * @priv: private driver interface data
1678 * Returns: Allocated buffer of scan results (caller is responsible for
1679 * freeing the data structure) on success, NULL on failure
1681 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1684 * set_country - Set country
1685 * @priv: Private driver interface data
1686 * @alpha2: country to which to switch to
1687 * Returns: 0 on success, -1 on failure
1689 * This function is for drivers which support some form
1690 * of setting a regulatory domain.
1692 int (*set_country)(void *priv, const char *alpha2);
1695 * get_country - Get country
1696 * @priv: Private driver interface data
1697 * @alpha2: Buffer for returning country code (at least 3 octets)
1698 * Returns: 0 on success, -1 on failure
1700 int (*get_country)(void *priv, char *alpha2);
1703 * global_init - Global driver initialization
1704 * Returns: Pointer to private data (global), %NULL on failure
1706 * This optional function is called to initialize the driver wrapper
1707 * for global data, i.e., data that applies to all interfaces. If this
1708 * function is implemented, global_deinit() will also need to be
1709 * implemented to free the private data. The driver will also likely
1710 * use init2() function instead of init() to get the pointer to global
1711 * data available to per-interface initializer.
1713 void * (*global_init)(void);
1716 * global_deinit - Global driver deinitialization
1717 * @priv: private driver global data from global_init()
1719 * Terminate any global driver related functionality and free the
1720 * global data structure.
1722 void (*global_deinit)(void *priv);
1725 * init2 - Initialize driver interface (with global data)
1726 * @ctx: context to be used when calling wpa_supplicant functions,
1727 * e.g., wpa_supplicant_event()
1728 * @ifname: interface name, e.g., wlan0
1729 * @global_priv: private driver global data from global_init()
1730 * Returns: Pointer to private data, %NULL on failure
1732 * This function can be used instead of init() if the driver wrapper
1735 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1738 * get_interfaces - Get information about available interfaces
1739 * @global_priv: private driver global data from global_init()
1740 * Returns: Allocated buffer of interface information (caller is
1741 * responsible for freeing the data structure) on success, NULL on
1744 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1747 * scan2 - Request the driver to initiate scan
1748 * @priv: private driver interface data
1749 * @params: Scan parameters
1751 * Returns: 0 on success, -1 on failure
1753 * Once the scan results are ready, the driver should report scan
1754 * results event for wpa_supplicant which will eventually request the
1755 * results with wpa_driver_get_scan_results2().
1757 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1760 * authenticate - Request driver to authenticate
1761 * @priv: private driver interface data
1762 * @params: authentication parameters
1763 * Returns: 0 on success, -1 on failure
1765 * This is an optional function that can be used with drivers that
1766 * support separate authentication and association steps, i.e., when
1767 * wpa_supplicant can act as the SME. If not implemented, associate()
1768 * function is expected to take care of IEEE 802.11 authentication,
1771 int (*authenticate)(void *priv,
1772 struct wpa_driver_auth_params *params);
1775 * set_ap - Set Beacon and Probe Response information for AP mode
1776 * @priv: Private driver interface data
1777 * @params: Parameters to use in AP mode
1779 * This function is used to configure Beacon template and/or extra IEs
1780 * to add for Beacon and Probe Response frames for the driver in
1781 * AP mode. The driver is responsible for building the full Beacon
1782 * frame by concatenating the head part with TIM IE generated by the
1783 * driver/firmware and finishing with the tail part. Depending on the
1784 * driver architectue, this can be done either by using the full
1785 * template or the set of additional IEs (e.g., WPS and P2P IE).
1786 * Similarly, Probe Response processing depends on the driver design.
1787 * If the driver (or firmware) takes care of replying to Probe Request
1788 * frames, the extra IEs provided here needs to be added to the Probe
1791 * Returns: 0 on success, -1 on failure
1793 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1796 * set_acl - Set ACL in AP mode
1797 * @priv: Private driver interface data
1798 * @params: Parameters to configure ACL
1799 * Returns: 0 on success, -1 on failure
1801 * This is used only for the drivers which support MAC address ACL.
1803 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1806 * hapd_init - Initialize driver interface (hostapd only)
1807 * @hapd: Pointer to hostapd context
1808 * @params: Configuration for the driver wrapper
1809 * Returns: Pointer to private data, %NULL on failure
1811 * This function is used instead of init() or init2() when the driver
1812 * wrapper is used with hostapd.
1814 void * (*hapd_init)(struct hostapd_data *hapd,
1815 struct wpa_init_params *params);
1818 * hapd_deinit - Deinitialize driver interface (hostapd only)
1819 * @priv: Private driver interface data from hapd_init()
1821 void (*hapd_deinit)(void *priv);
1824 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1825 * @priv: Private driver interface data
1826 * @params: BSS parameters
1827 * Returns: 0 on success, -1 on failure
1829 * This is an optional function to configure the kernel driver to
1830 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1831 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1832 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1833 * for Beacon frames.
1835 * DEPRECATED - use set_ap() instead
1837 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1840 * set_privacy - Enable/disable privacy (AP only)
1841 * @priv: Private driver interface data
1842 * @enabled: 1 = privacy enabled, 0 = disabled
1843 * Returns: 0 on success, -1 on failure
1845 * This is an optional function to configure privacy field in the
1846 * kernel driver for Beacon frames. This can be left undefined (set to
1847 * %NULL) if the driver uses the Beacon template from set_ap().
1849 * DEPRECATED - use set_ap() instead
1851 int (*set_privacy)(void *priv, int enabled);
1854 * get_seqnum - Fetch the current TSC/packet number (AP only)
1855 * @ifname: The interface name (main or virtual)
1856 * @priv: Private driver interface data
1857 * @addr: MAC address of the station or %NULL for group keys
1859 * @seq: Buffer for returning the latest used TSC/packet number
1860 * Returns: 0 on success, -1 on failure
1862 * This function is used to fetch the last used TSC/packet number for
1863 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1864 * keys, so there is no strict requirement on implementing support for
1865 * unicast keys (i.e., addr != %NULL).
1867 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1871 * flush - Flush all association stations (AP only)
1872 * @priv: Private driver interface data
1873 * Returns: 0 on success, -1 on failure
1875 * This function requests the driver to disassociate all associated
1876 * stations. This function does not need to be implemented if the
1877 * driver does not process association frames internally.
1879 int (*flush)(void *priv);
1882 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1883 * @priv: Private driver interface data
1884 * @elem: Information elements
1885 * @elem_len: Length of the elem buffer in octets
1886 * Returns: 0 on success, -1 on failure
1888 * This is an optional function to add information elements in the
1889 * kernel driver for Beacon and Probe Response frames. This can be left
1890 * undefined (set to %NULL) if the driver uses the Beacon template from
1893 * DEPRECATED - use set_ap() instead
1895 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1898 * read_sta_data - Fetch station data
1899 * @priv: Private driver interface data
1900 * @data: Buffer for returning station information
1901 * @addr: MAC address of the station
1902 * Returns: 0 on success, -1 on failure
1904 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1908 * hapd_send_eapol - Send an EAPOL packet (AP only)
1909 * @priv: private driver interface data
1910 * @addr: Destination MAC address
1911 * @data: EAPOL packet starting with IEEE 802.1X header
1912 * @data_len: Length of the EAPOL packet in octets
1913 * @encrypt: Whether the frame should be encrypted
1914 * @own_addr: Source MAC address
1915 * @flags: WPA_STA_* flags for the destination station
1917 * Returns: 0 on success, -1 on failure
1919 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1920 size_t data_len, int encrypt,
1921 const u8 *own_addr, u32 flags);
1924 * sta_deauth - Deauthenticate a station (AP only)
1925 * @priv: Private driver interface data
1926 * @own_addr: Source address and BSSID for the Deauthentication frame
1927 * @addr: MAC address of the station to deauthenticate
1928 * @reason: Reason code for the Deauthentiation frame
1929 * Returns: 0 on success, -1 on failure
1931 * This function requests a specific station to be deauthenticated and
1932 * a Deauthentication frame to be sent to it.
1934 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1938 * sta_disassoc - Disassociate a station (AP only)
1939 * @priv: Private driver interface data
1940 * @own_addr: Source address and BSSID for the Disassociation frame
1941 * @addr: MAC address of the station to disassociate
1942 * @reason: Reason code for the Disassociation frame
1943 * Returns: 0 on success, -1 on failure
1945 * This function requests a specific station to be disassociated and
1946 * a Disassociation frame to be sent to it.
1948 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1952 * sta_remove - Remove a station entry (AP only)
1953 * @priv: Private driver interface data
1954 * @addr: MAC address of the station to be removed
1955 * Returns: 0 on success, -1 on failure
1957 int (*sta_remove)(void *priv, const u8 *addr);
1960 * hapd_get_ssid - Get the current SSID (AP only)
1961 * @priv: Private driver interface data
1962 * @buf: Buffer for returning the SSID
1963 * @len: Maximum length of the buffer
1964 * Returns: Length of the SSID on success, -1 on failure
1966 * This function need not be implemented if the driver uses Beacon
1967 * template from set_ap() and does not reply to Probe Request frames.
1969 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1972 * hapd_set_ssid - Set SSID (AP only)
1973 * @priv: Private driver interface data
1975 * @len: Length of the SSID in octets
1976 * Returns: 0 on success, -1 on failure
1978 * DEPRECATED - use set_ap() instead
1980 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1983 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1984 * @priv: Private driver interface data
1985 * @enabled: 1 = countermeasures enabled, 0 = disabled
1986 * Returns: 0 on success, -1 on failure
1988 * This need not be implemented if the driver does not take care of
1989 * association processing.
1991 int (*hapd_set_countermeasures)(void *priv, int enabled);
1994 * sta_add - Add a station entry
1995 * @priv: Private driver interface data
1996 * @params: Station parameters
1997 * Returns: 0 on success, -1 on failure
1999 * This function is used to add a station entry to the driver once the
2000 * station has completed association. This is only used if the driver
2001 * does not take care of association processing.
2003 * With TDLS, this function is also used to add or set (params->set 1)
2004 * TDLS peer entries.
2006 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2009 * get_inact_sec - Get station inactivity duration (AP only)
2010 * @priv: Private driver interface data
2011 * @addr: Station address
2012 * Returns: Number of seconds station has been inactive, -1 on failure
2014 int (*get_inact_sec)(void *priv, const u8 *addr);
2017 * sta_clear_stats - Clear station statistics (AP only)
2018 * @priv: Private driver interface data
2019 * @addr: Station address
2020 * Returns: 0 on success, -1 on failure
2022 int (*sta_clear_stats)(void *priv, const u8 *addr);
2025 * set_freq - Set channel/frequency (AP only)
2026 * @priv: Private driver interface data
2027 * @freq: Channel parameters
2028 * Returns: 0 on success, -1 on failure
2030 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2033 * set_rts - Set RTS threshold
2034 * @priv: Private driver interface data
2035 * @rts: RTS threshold in octets
2036 * Returns: 0 on success, -1 on failure
2038 int (*set_rts)(void *priv, int rts);
2041 * set_frag - Set fragmentation threshold
2042 * @priv: Private driver interface data
2043 * @frag: Fragmentation threshold in octets
2044 * Returns: 0 on success, -1 on failure
2046 int (*set_frag)(void *priv, int frag);
2049 * sta_set_flags - Set station flags (AP only)
2050 * @priv: Private driver interface data
2051 * @addr: Station address
2052 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2053 * @flags_or: Bitmap of WPA_STA_* flags to add
2054 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2055 * Returns: 0 on success, -1 on failure
2057 int (*sta_set_flags)(void *priv, const u8 *addr,
2058 int total_flags, int flags_or, int flags_and);
2061 * set_tx_queue_params - Set TX queue parameters
2062 * @priv: Private driver interface data
2063 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2067 * @burst_time: Maximum length for bursting in 0.1 msec units
2069 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2070 int cw_max, int burst_time);
2073 * if_add - Add a virtual interface
2074 * @priv: Private driver interface data
2075 * @type: Interface type
2076 * @ifname: Interface name for the new virtual interface
2077 * @addr: Local address to use for the interface or %NULL to use the
2078 * parent interface address
2079 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2080 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2081 * not allowed (applies only to %WPA_IF_AP_BSS type)
2082 * @force_ifname: Buffer for returning an interface name that the
2083 * driver ended up using if it differs from the requested ifname
2084 * @if_addr: Buffer for returning the allocated interface address
2085 * (this may differ from the requested addr if the driver cannot
2086 * change interface address)
2087 * @bridge: Bridge interface to use or %NULL if no bridge configured
2088 * @use_existing: Whether to allow existing interface to be used
2089 * Returns: 0 on success, -1 on failure
2091 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2092 const char *ifname, const u8 *addr, void *bss_ctx,
2093 void **drv_priv, char *force_ifname, u8 *if_addr,
2094 const char *bridge, int use_existing);
2097 * if_remove - Remove a virtual interface
2098 * @priv: Private driver interface data
2099 * @type: Interface type
2100 * @ifname: Interface name of the virtual interface to be removed
2101 * Returns: 0 on success, -1 on failure
2103 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2104 const char *ifname);
2107 * set_sta_vlan - Bind a station into a specific interface (AP only)
2108 * @priv: Private driver interface data
2109 * @ifname: Interface (main or virtual BSS or VLAN)
2110 * @addr: MAC address of the associated station
2112 * Returns: 0 on success, -1 on failure
2114 * This function is used to bind a station to a specific virtual
2115 * interface. It is only used if when virtual interfaces are supported,
2116 * e.g., to assign stations to different VLAN interfaces based on
2117 * information from a RADIUS server. This allows separate broadcast
2118 * domains to be used with a single BSS.
2120 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2124 * commit - Optional commit changes handler (AP only)
2125 * @priv: driver private data
2126 * Returns: 0 on success, -1 on failure
2128 * This optional handler function can be registered if the driver
2129 * interface implementation needs to commit changes (e.g., by setting
2130 * network interface up) at the end of initial configuration. If set,
2131 * this handler will be called after initial setup has been completed.
2133 int (*commit)(void *priv);
2136 * send_ether - Send an ethernet packet (AP only)
2137 * @priv: private driver interface data
2138 * @dst: Destination MAC address
2139 * @src: Source MAC address
2141 * @data: EAPOL packet starting with IEEE 802.1X header
2142 * @data_len: Length of the EAPOL packet in octets
2143 * Returns: 0 on success, -1 on failure
2145 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2146 const u8 *data, size_t data_len);
2149 * set_radius_acl_auth - Notification of RADIUS ACL change
2150 * @priv: Private driver interface data
2151 * @mac: MAC address of the station
2152 * @accepted: Whether the station was accepted
2153 * @session_timeout: Session timeout for the station
2154 * Returns: 0 on success, -1 on failure
2156 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2157 u32 session_timeout);
2160 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2161 * @priv: Private driver interface data
2162 * @mac: MAC address of the station
2163 * Returns: 0 on success, -1 on failure
2165 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2168 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2169 * @priv: Private driver interface data
2170 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2171 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2173 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2174 * to remove extra IE(s)
2175 * Returns: 0 on success, -1 on failure
2177 * This is an optional function to add WPS IE in the kernel driver for
2178 * Beacon and Probe Response frames. This can be left undefined (set
2179 * to %NULL) if the driver uses the Beacon template from set_ap()
2180 * and does not process Probe Request frames. If the driver takes care
2181 * of (Re)Association frame processing, the assocresp buffer includes
2182 * WPS IE(s) that need to be added to (Re)Association Response frames
2183 * whenever a (Re)Association Request frame indicated use of WPS.
2185 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2186 * frames when operating as a GO. The driver is responsible for adding
2187 * timing related attributes (e.g., NoA) in addition to the IEs
2188 * included here by appending them after these buffers. This call is
2189 * also used to provide Probe Response IEs for P2P Listen state
2190 * operations for drivers that generate the Probe Response frames
2193 * DEPRECATED - use set_ap() instead
2195 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2196 const struct wpabuf *proberesp,
2197 const struct wpabuf *assocresp);
2200 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2201 * @priv: Private driver interface data
2202 * @authorized: Whether the port is authorized
2203 * Returns: 0 on success, -1 on failure
2205 int (*set_supp_port)(void *priv, int authorized);
2208 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2209 * @priv: Private driver interface data
2210 * @addr: MAC address of the associated station
2211 * @aid: Association ID
2212 * @val: 1 = bind to 4-address WDS; 0 = unbind
2213 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2214 * to indicate that bridge is not to be used
2215 * @ifname_wds: Buffer to return the interface name for the new WDS
2216 * station or %NULL to indicate name is not returned.
2217 * Returns: 0 on success, -1 on failure
2219 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2220 const char *bridge_ifname, char *ifname_wds);
2223 * send_action - Transmit an Action frame
2224 * @priv: Private driver interface data
2225 * @freq: Frequency (in MHz) of the channel
2226 * @wait: Time to wait off-channel for a response (in ms), or zero
2227 * @dst: Destination MAC address (Address 1)
2228 * @src: Source MAC address (Address 2)
2229 * @bssid: BSSID (Address 3)
2231 * @data_len: data length in octets
2232 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2233 * Returns: 0 on success, -1 on failure
2235 * This command can be used to request the driver to transmit an action
2236 * frame to the specified destination.
2238 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2239 * be transmitted on the given channel and the device will wait for a
2240 * response on that channel for the given wait time.
2242 * If the flag is not set, the wait time will be ignored. In this case,
2243 * if a remain-on-channel duration is in progress, the frame must be
2244 * transmitted on that channel; alternatively the frame may be sent on
2245 * the current operational channel (if in associated state in station
2246 * mode or while operating as an AP.)
2248 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2249 const u8 *dst, const u8 *src, const u8 *bssid,
2250 const u8 *data, size_t data_len, int no_cck);
2253 * send_action_cancel_wait - Cancel action frame TX wait
2254 * @priv: Private driver interface data
2256 * This command cancels the wait time associated with sending an action
2257 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2258 * set in the driver flags.
2260 void (*send_action_cancel_wait)(void *priv);
2263 * remain_on_channel - Remain awake on a channel
2264 * @priv: Private driver interface data
2265 * @freq: Frequency (in MHz) of the channel
2266 * @duration: Duration in milliseconds
2267 * Returns: 0 on success, -1 on failure
2269 * This command is used to request the driver to remain awake on the
2270 * specified channel for the specified duration and report received
2271 * Action frames with EVENT_RX_MGMT events. Optionally, received
2272 * Probe Request frames may also be requested to be reported by calling
2273 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2275 * The driver may not be at the requested channel when this function
2276 * returns, i.e., the return code is only indicating whether the
2277 * request was accepted. The caller will need to wait until the
2278 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2279 * completed the channel change. This may take some time due to other
2280 * need for the radio and the caller should be prepared to timing out
2281 * its wait since there are no guarantees on when this request can be
2284 int (*remain_on_channel)(void *priv, unsigned int freq,
2285 unsigned int duration);
2288 * cancel_remain_on_channel - Cancel remain-on-channel operation
2289 * @priv: Private driver interface data
2291 * This command can be used to cancel a remain-on-channel operation
2292 * before its originally requested duration has passed. This could be
2293 * used, e.g., when remain_on_channel() is used to request extra time
2294 * to receive a response to an Action frame and the response is
2295 * received when there is still unneeded time remaining on the
2296 * remain-on-channel operation.
2298 int (*cancel_remain_on_channel)(void *priv);
2301 * probe_req_report - Request Probe Request frames to be indicated
2302 * @priv: Private driver interface data
2303 * @report: Whether to report received Probe Request frames
2304 * Returns: 0 on success, -1 on failure (or if not supported)
2306 * This command can be used to request the driver to indicate when
2307 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2308 * Since this operation may require extra resources, e.g., due to less
2309 * optimal hardware/firmware RX filtering, many drivers may disable
2310 * Probe Request reporting at least in station mode. This command is
2311 * used to notify the driver when the Probe Request frames need to be
2312 * reported, e.g., during remain-on-channel operations.
2314 int (*probe_req_report)(void *priv, int report);
2317 * deinit_ap - Deinitialize AP mode
2318 * @priv: Private driver interface data
2319 * Returns: 0 on success, -1 on failure (or if not supported)
2321 * This optional function can be used to disable AP mode related
2322 * configuration. If the interface was not dynamically added,
2323 * change the driver mode to station mode to allow normal station
2324 * operations like scanning to be completed.
2326 int (*deinit_ap)(void *priv);
2329 * deinit_p2p_cli - Deinitialize P2P client mode
2330 * @priv: Private driver interface data
2331 * Returns: 0 on success, -1 on failure (or if not supported)
2333 * This optional function can be used to disable P2P client mode. If the
2334 * interface was not dynamically added, change the interface type back
2337 int (*deinit_p2p_cli)(void *priv);
2340 * suspend - Notification on system suspend/hibernate event
2341 * @priv: Private driver interface data
2343 void (*suspend)(void *priv);
2346 * resume - Notification on system resume/thaw event
2347 * @priv: Private driver interface data
2349 void (*resume)(void *priv);
2352 * signal_monitor - Set signal monitoring parameters
2353 * @priv: Private driver interface data
2354 * @threshold: Threshold value for signal change events; 0 = disabled
2355 * @hysteresis: Minimum change in signal strength before indicating a
2357 * Returns: 0 on success, -1 on failure (or if not supported)
2359 * This function can be used to configure monitoring of signal strength
2360 * with the current AP. Whenever signal strength drops below the
2361 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2362 * should be generated assuming the signal strength has changed at
2363 * least %hysteresis from the previously indicated signal change event.
2365 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2368 * send_frame - Send IEEE 802.11 frame (testing use only)
2369 * @priv: Private driver interface data
2370 * @data: IEEE 802.11 frame with IEEE 802.11 header
2371 * @data_len: Size of the frame
2372 * @encrypt: Whether to encrypt the frame (if keys are set)
2373 * Returns: 0 on success, -1 on failure
2375 * This function is only used for debugging purposes and is not
2376 * required to be implemented for normal operations.
2378 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2382 * shared_freq - Get operating frequency of shared interface(s)
2383 * @priv: Private driver interface data
2384 * Returns: Operating frequency in MHz, 0 if no shared operation in
2385 * use, or -1 on failure
2387 * This command can be used to request the current operating frequency
2388 * of any virtual interface that shares the same radio to provide
2389 * information for channel selection for other virtual interfaces.
2391 int (*shared_freq)(void *priv);
2394 * get_noa - Get current Notice of Absence attribute payload
2395 * @priv: Private driver interface data
2396 * @buf: Buffer for returning NoA
2397 * @buf_len: Buffer length in octets
2398 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2399 * advertized, or -1 on failure
2401 * This function is used to fetch the current Notice of Absence
2402 * attribute value from GO.
2404 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2407 * set_noa - Set Notice of Absence parameters for GO (testing)
2408 * @priv: Private driver interface data
2410 * @start: Start time in ms from next TBTT
2411 * @duration: Duration in ms
2412 * Returns: 0 on success or -1 on failure
2414 * This function is used to set Notice of Absence parameters for GO. It
2415 * is used only for testing. To disable NoA, all parameters are set to
2418 int (*set_noa)(void *priv, u8 count, int start, int duration);
2421 * set_p2p_powersave - Set P2P power save options
2422 * @priv: Private driver interface data
2423 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2424 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2425 * @ctwindow: 0.. = change (msec), -1 = no change
2426 * Returns: 0 on success or -1 on failure
2428 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2432 * ampdu - Enable/disable aggregation
2433 * @priv: Private driver interface data
2434 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2435 * Returns: 0 on success or -1 on failure
2437 int (*ampdu)(void *priv, int ampdu);
2440 * get_radio_name - Get physical radio name for the device
2441 * @priv: Private driver interface data
2442 * Returns: Radio name or %NULL if not known
2444 * The returned data must not be modified by the caller. It is assumed
2445 * that any interface that has the same radio name as another is
2446 * sharing the same physical radio. This information can be used to
2447 * share scan results etc. information between the virtual interfaces
2448 * to speed up various operations.
2450 const char * (*get_radio_name)(void *priv);
2453 * send_tdls_mgmt - for sending TDLS management packets
2454 * @priv: private driver interface data
2455 * @dst: Destination (peer) MAC address
2456 * @action_code: TDLS action code for the mssage
2457 * @dialog_token: Dialog Token to use in the message (if needed)
2458 * @status_code: Status Code or Reason Code to use (if needed)
2459 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2460 * @buf: TDLS IEs to add to the message
2461 * @len: Length of buf in octets
2462 * Returns: 0 on success, negative (<0) on failure
2464 * This optional function can be used to send packet to driver which is
2465 * responsible for receiving and sending all TDLS packets.
2467 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2468 u8 dialog_token, u16 status_code, u32 peer_capab,
2469 const u8 *buf, size_t len);
2472 * tdls_oper - Ask the driver to perform high-level TDLS operations
2473 * @priv: Private driver interface data
2474 * @oper: TDLS high-level operation. See %enum tdls_oper
2475 * @peer: Destination (peer) MAC address
2476 * Returns: 0 on success, negative (<0) on failure
2478 * This optional function can be used to send high-level TDLS commands
2481 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2484 * wnm_oper - Notify driver of the WNM frame reception
2485 * @priv: Private driver interface data
2486 * @oper: WNM operation. See %enum wnm_oper
2487 * @peer: Destination (peer) MAC address
2488 * @buf: Buffer for the driver to fill in (for getting IE)
2489 * @buf_len: Return the len of buf
2490 * Returns: 0 on success, negative (<0) on failure
2492 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2493 u8 *buf, u16 *buf_len);
2496 * set_qos_map - Set QoS Map
2497 * @priv: Private driver interface data
2498 * @qos_map_set: QoS Map
2499 * @qos_map_set_len: Length of QoS Map
2501 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2502 u8 qos_map_set_len);
2505 * signal_poll - Get current connection information
2506 * @priv: Private driver interface data
2507 * @signal_info: Connection info structure
2509 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2512 * set_authmode - Set authentication algorithm(s) for static WEP
2513 * @priv: Private driver interface data
2514 * @authmode: 1=Open System, 2=Shared Key, 3=both
2515 * Returns: 0 on success, -1 on failure
2517 * This function can be used to set authentication algorithms for AP
2518 * mode when static WEP is used. If the driver uses user space MLME/SME
2519 * implementation, there is no need to implement this function.
2521 * DEPRECATED - use set_ap() instead
2523 int (*set_authmode)(void *priv, int authmode);
2527 * driver_cmd - Execute driver-specific command
2528 * @priv: Private driver interface data
2529 * @cmd: Command to execute
2530 * @buf: Return buffer
2531 * @buf_len: Buffer length
2532 * Returns: 0 on success, -1 on failure
2534 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2535 #endif /* ANDROID */
2538 * vendor_cmd - Execute vendor specific command
2539 * @priv: Private driver interface data
2540 * @vendor_id: Vendor id
2541 * @subcmd: Vendor command id
2542 * @data: Vendor command parameters (%NULL if no parameters)
2543 * @data_len: Data length
2544 * @buf: Return buffer (%NULL to ignore reply)
2545 * Returns: 0 on success, negative (<0) on failure
2547 * This function handles vendor specific commands that are passed to
2548 * the driver/device. The command is identified by vendor id and
2549 * command id. Parameters can be passed as argument to the command
2550 * in the data buffer. Reply (if any) will be filled in the supplied
2553 * The exact driver behavior is driver interface and vendor specific. As
2554 * an example, this will be converted to a vendor specific cfg80211
2555 * command in case of the nl80211 driver interface.
2557 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2558 unsigned int subcmd, const u8 *data, size_t data_len,
2559 struct wpabuf *buf);
2562 * set_rekey_info - Set rekey information
2563 * @priv: Private driver interface data
2566 * @replay_ctr: Current EAPOL-Key Replay Counter
2568 * This optional function can be used to provide information for the
2569 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2570 * while the host (including wpa_supplicant) is sleeping.
2572 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2573 const u8 *replay_ctr);
2576 * sta_assoc - Station association indication
2577 * @priv: Private driver interface data
2578 * @own_addr: Source address and BSSID for association frame
2579 * @addr: MAC address of the station to associate
2580 * @reassoc: flag to indicate re-association
2581 * @status: association response status code
2582 * @ie: assoc response ie buffer
2583 * @len: ie buffer length
2584 * Returns: 0 on success, -1 on failure
2586 * This function indicates the driver to send (Re)Association
2587 * Response frame to the station.
2589 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2590 int reassoc, u16 status, const u8 *ie, size_t len);
2593 * sta_auth - Station authentication indication
2594 * @priv: Private driver interface data
2595 * @own_addr: Source address and BSSID for authentication frame
2596 * @addr: MAC address of the station to associate
2597 * @seq: authentication sequence number
2598 * @status: authentication response status code
2599 * @ie: authentication frame ie buffer
2600 * @len: ie buffer length
2602 * This function indicates the driver to send Authentication frame
2605 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2606 u16 seq, u16 status, const u8 *ie, size_t len);
2609 * add_tspec - Add traffic stream
2610 * @priv: Private driver interface data
2611 * @addr: MAC address of the station to associate
2612 * @tspec_ie: tspec ie buffer
2613 * @tspec_ielen: tspec ie length
2614 * Returns: 0 on success, -1 on failure
2616 * This function adds the traffic steam for the station
2617 * and fills the medium_time in tspec_ie.
2619 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2620 size_t tspec_ielen);
2623 * add_sta_node - Add a station node in the driver
2624 * @priv: Private driver interface data
2625 * @addr: MAC address of the station to add
2626 * @auth_alg: authentication algorithm used by the station
2627 * Returns: 0 on success, -1 on failure
2629 * This function adds the station node in the driver, when
2630 * the station gets added by FT-over-DS.
2632 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2635 * sched_scan - Request the driver to initiate scheduled scan
2636 * @priv: Private driver interface data
2637 * @params: Scan parameters
2638 * @interval: Interval between scan cycles in milliseconds
2639 * Returns: 0 on success, -1 on failure
2641 * This operation should be used for scheduled scan offload to
2642 * the hardware. Every time scan results are available, the
2643 * driver should report scan results event for wpa_supplicant
2644 * which will eventually request the results with
2645 * wpa_driver_get_scan_results2(). This operation is optional
2646 * and if not provided or if it returns -1, we fall back to
2647 * normal host-scheduled scans.
2649 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2653 * stop_sched_scan - Request the driver to stop a scheduled scan
2654 * @priv: Private driver interface data
2655 * Returns: 0 on success, -1 on failure
2657 * This should cause the scheduled scan to be stopped and
2658 * results should stop being sent. Must be supported if
2659 * sched_scan is supported.
2661 int (*stop_sched_scan)(void *priv);
2664 * poll_client - Probe (null data or such) the given station
2665 * @priv: Private driver interface data
2666 * @own_addr: MAC address of sending interface
2667 * @addr: MAC address of the station to probe
2668 * @qos: Indicates whether station is QoS station
2670 * This function is used to verify whether an associated station is
2671 * still present. This function does not need to be implemented if the
2672 * driver provides such inactivity polling mechanism.
2674 void (*poll_client)(void *priv, const u8 *own_addr,
2675 const u8 *addr, int qos);
2678 * radio_disable - Disable/enable radio
2679 * @priv: Private driver interface data
2680 * @disabled: 1=disable 0=enable radio
2681 * Returns: 0 on success, -1 on failure
2683 * This optional command is for testing purposes. It can be used to
2684 * disable the radio on a testbed device to simulate out-of-radio-range
2687 int (*radio_disable)(void *priv, int disabled);
2690 * switch_channel - Announce channel switch and migrate the GO to the
2692 * @priv: Private driver interface data
2693 * @settings: Settings for CSA period and new channel
2694 * Returns: 0 on success, -1 on failure
2696 * This function is used to move the GO to the legacy STA channel to
2697 * avoid frequency conflict in single channel concurrency.
2699 int (*switch_channel)(void *priv, struct csa_settings *settings);
2702 * start_dfs_cac - Listen for radar interference on the channel
2703 * @priv: Private driver interface data
2704 * @freq: Channel parameters
2705 * Returns: 0 on success, -1 on failure
2707 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
2710 * stop_ap - Removes beacon from AP
2711 * @priv: Private driver interface data
2712 * Returns: 0 on success, -1 on failure (or if not supported)
2714 * This optional function can be used to disable AP mode related
2715 * configuration. Unlike deinit_ap, it does not change to station
2718 int (*stop_ap)(void *priv);
2721 * get_survey - Retrieve survey data
2722 * @priv: Private driver interface data
2723 * @freq: If set, survey data for the specified frequency is only
2724 * being requested. If not set, all survey data is requested.
2725 * Returns: 0 on success, -1 on failure
2727 * Use this to retrieve:
2729 * - the observed channel noise floor
2730 * - the amount of time we have spent on the channel
2731 * - the amount of time during which we have spent on the channel that
2732 * the radio has determined the medium is busy and we cannot
2734 * - the amount of time we have spent receiving data
2735 * - the amount of time we have spent transmitting data
2737 * This data can be used for spectrum heuristics. One example is
2738 * Automatic Channel Selection (ACS). The channel survey data is
2739 * kept on a linked list on the channel data, one entry is added
2740 * for each survey. The min_nf of the channel is updated for each
2743 int (*get_survey)(void *priv, unsigned int freq);
2746 * status - Get driver interface status information
2747 * @priv: Private driver interface data
2748 * @buf: Buffer for printing tou the status information
2749 * @buflen: Maximum length of the buffer
2750 * Returns: Length of written status information or -1 on failure
2752 int (*status)(void *priv, char *buf, size_t buflen);
2757 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2759 enum wpa_event_type {
2761 * EVENT_ASSOC - Association completed
2763 * This event needs to be delivered when the driver completes IEEE
2764 * 802.11 association or reassociation successfully.
2765 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2766 * after this event has been generated. In addition, optional
2767 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2768 * more information about the association. If the driver interface gets
2769 * both of these events at the same time, it can also include the
2770 * assoc_info data in EVENT_ASSOC call.
2775 * EVENT_DISASSOC - Association lost
2777 * This event should be called when association is lost either due to
2778 * receiving deauthenticate or disassociate frame from the AP or when
2779 * sending either of these frames to the current AP. If the driver
2780 * supports separate deauthentication event, EVENT_DISASSOC should only
2781 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2782 * In AP mode, union wpa_event_data::disassoc_info is required.
2787 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2789 * This event must be delivered when a Michael MIC error is detected by
2790 * the local driver. Additional data for event processing is
2791 * provided with union wpa_event_data::michael_mic_failure. This
2792 * information is used to request new encyption key and to initiate
2793 * TKIP countermeasures if needed.
2795 EVENT_MICHAEL_MIC_FAILURE,
2798 * EVENT_SCAN_RESULTS - Scan results available
2800 * This event must be called whenever scan results are available to be
2801 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2802 * is expected to be used some time after struct wpa_driver_ops::scan()
2803 * is called. If the driver provides an unsolicited event when the scan
2804 * has been completed, this event can be used to trigger
2805 * EVENT_SCAN_RESULTS call. If such event is not available from the
2806 * driver, the driver wrapper code is expected to use a registered
2807 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2808 * scan is expected to be completed. Optional information about
2809 * completed scan can be provided with union wpa_event_data::scan_info.
2814 * EVENT_ASSOCINFO - Report optional extra information for association
2816 * This event can be used to report extra association information for
2817 * EVENT_ASSOC processing. This extra information includes IEs from
2818 * association frames and Beacon/Probe Response frames in union
2819 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2820 * EVENT_ASSOC. Alternatively, the driver interface can include
2821 * assoc_info data in the EVENT_ASSOC call if it has all the
2822 * information available at the same point.
2827 * EVENT_INTERFACE_STATUS - Report interface status changes
2829 * This optional event can be used to report changes in interface
2830 * status (interface added/removed) using union
2831 * wpa_event_data::interface_status. This can be used to trigger
2832 * wpa_supplicant to stop and re-start processing for the interface,
2833 * e.g., when a cardbus card is ejected/inserted.
2835 EVENT_INTERFACE_STATUS,
2838 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2840 * This event can be used to inform wpa_supplicant about candidates for
2841 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2842 * for scan request (ap_scan=2 mode), this event is required for
2843 * pre-authentication. If wpa_supplicant is performing scan request
2844 * (ap_scan=1), this event is optional since scan results can be used
2845 * to add pre-authentication candidates. union
2846 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2847 * candidate and priority of the candidate, e.g., based on the signal
2848 * strength, in order to try to pre-authenticate first with candidates
2849 * that are most likely targets for re-association.
2851 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2852 * on the candidate list. In addition, it can be called for the current
2853 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2854 * will automatically skip pre-authentication in cases where a valid
2855 * PMKSA exists. When more than one candidate exists, this event should
2856 * be generated once for each candidate.
2858 * Driver will be notified about successful pre-authentication with
2859 * struct wpa_driver_ops::add_pmkid() calls.
2861 EVENT_PMKID_CANDIDATE,
2864 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2866 * This event can be used to inform wpa_supplicant about desire to set
2867 * up secure direct link connection between two stations as defined in
2868 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2869 * STAKey negotiation. The caller will need to set peer address for the
2875 * EVENT_TDLS - Request TDLS operation
2877 * This event can be used to request a TDLS operation to be performed.
2882 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2884 * The driver is expected to report the received FT IEs from
2885 * FT authentication sequence from the AP. The FT IEs are included in
2886 * the extra information in union wpa_event_data::ft_ies.
2891 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2893 * The driver can use this event to inform wpa_supplicant about a STA
2894 * in an IBSS with which protected frames could be exchanged. This
2895 * event starts RSN authentication with the other STA to authenticate
2896 * the STA and set up encryption keys with it.
2898 EVENT_IBSS_RSN_START,
2901 * EVENT_AUTH - Authentication result
2903 * This event should be called when authentication attempt has been
2904 * completed. This is only used if the driver supports separate
2905 * authentication step (struct wpa_driver_ops::authenticate).
2906 * Information about authentication result is included in
2907 * union wpa_event_data::auth.
2912 * EVENT_DEAUTH - Authentication lost
2914 * This event should be called when authentication is lost either due
2915 * to receiving deauthenticate frame from the AP or when sending that
2916 * frame to the current AP.
2917 * In AP mode, union wpa_event_data::deauth_info is required.
2922 * EVENT_ASSOC_REJECT - Association rejected
2924 * This event should be called when (re)association attempt has been
2925 * rejected by the AP. Information about the association response is
2926 * included in union wpa_event_data::assoc_reject.
2931 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2933 EVENT_AUTH_TIMED_OUT,
2936 * EVENT_ASSOC_TIMED_OUT - Association timed out
2938 EVENT_ASSOC_TIMED_OUT,
2941 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2946 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2948 EVENT_WPS_BUTTON_PUSHED,
2951 * EVENT_TX_STATUS - Report TX status
2956 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2958 EVENT_RX_FROM_UNKNOWN,
2961 * EVENT_RX_MGMT - Report RX of a management frame
2966 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2968 * This event is used to indicate when the driver has started the
2969 * requested remain-on-channel duration. Information about the
2970 * operation is included in union wpa_event_data::remain_on_channel.
2972 EVENT_REMAIN_ON_CHANNEL,
2975 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2977 * This event is used to indicate when the driver has completed
2978 * remain-on-channel duration, i.e., may noot be available on the
2979 * requested channel anymore. Information about the
2980 * operation is included in union wpa_event_data::remain_on_channel.
2982 EVENT_CANCEL_REMAIN_ON_CHANNEL,
2985 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2987 * This event is used only by driver_test.c and userspace MLME.
2992 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2994 * This event is used to indicate when a Probe Request frame has been
2995 * received. Information about the received frame is included in
2996 * union wpa_event_data::rx_probe_req. The driver is required to report
2997 * these events only after successfully completed probe_req_report()
2998 * commands to request the events (i.e., report parameter is non-zero)
2999 * in station mode. In AP mode, Probe Request frames should always be
3005 * EVENT_NEW_STA - New wired device noticed
3007 * This event is used to indicate that a new device has been detected
3008 * in a network that does not use association-like functionality (i.e.,
3009 * mainly wired Ethernet). This can be used to start EAPOL
3010 * authenticator when receiving a frame from a device. The address of
3011 * the device is included in union wpa_event_data::new_sta.
3016 * EVENT_EAPOL_RX - Report received EAPOL frame
3018 * When in AP mode with hostapd, this event is required to be used to
3019 * deliver the receive EAPOL frames from the driver. With
3020 * %wpa_supplicant, this event is used only if the send_eapol() handler
3021 * is used to override the use of l2_packet for EAPOL frame TX.
3026 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3028 * This event is used to indicate changes in the signal strength
3029 * observed in frames received from the current AP if signal strength
3030 * monitoring has been enabled with signal_monitor().
3032 EVENT_SIGNAL_CHANGE,
3035 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3037 * This event is used to indicate that the interface was enabled after
3038 * having been previously disabled, e.g., due to rfkill.
3040 EVENT_INTERFACE_ENABLED,
3043 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3045 * This event is used to indicate that the interface was disabled,
3046 * e.g., due to rfkill.
3048 EVENT_INTERFACE_DISABLED,
3051 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3053 * This event is used to indicate that the channel list has changed,
3054 * e.g., because of a regulatory domain change triggered by scan
3055 * results including an AP advertising a country code.
3057 EVENT_CHANNEL_LIST_CHANGED,
3060 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3062 * This event is used to indicate that the driver cannot maintain this
3063 * interface in its operation mode anymore. The most likely use for
3064 * this is to indicate that AP mode operation is not available due to
3065 * operating channel would need to be changed to a DFS channel when
3066 * the driver does not support radar detection and another virtual
3067 * interfaces caused the operating channel to change. Other similar
3068 * resource conflicts could also trigger this for station mode
3071 EVENT_INTERFACE_UNAVAILABLE,
3074 * EVENT_BEST_CHANNEL
3076 * Driver generates this event whenever it detects a better channel
3077 * (e.g., based on RSSI or channel use). This information can be used
3078 * to improve channel selection for a new AP/P2P group.
3083 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3085 * This event should be called when a Deauthentication frame is dropped
3086 * due to it not being protected (MFP/IEEE 802.11w).
3087 * union wpa_event_data::unprot_deauth is required to provide more
3088 * details of the frame.
3090 EVENT_UNPROT_DEAUTH,
3093 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3095 * This event should be called when a Disassociation frame is dropped
3096 * due to it not being protected (MFP/IEEE 802.11w).
3097 * union wpa_event_data::unprot_disassoc is required to provide more
3098 * details of the frame.
3100 EVENT_UNPROT_DISASSOC,
3103 * EVENT_STATION_LOW_ACK
3105 * Driver generates this event whenever it detected that a particular
3106 * station was lost. Detection can be through massive transmission
3107 * failures for example.
3109 EVENT_STATION_LOW_ACK,
3112 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3114 EVENT_IBSS_PEER_LOST,
3117 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3119 * This event carries the new replay counter to notify wpa_supplicant
3120 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3121 * completed Group Key Handshake while the host (including
3122 * wpa_supplicant was sleeping).
3124 EVENT_DRIVER_GTK_REKEY,
3127 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3129 EVENT_SCHED_SCAN_STOPPED,
3132 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3134 * This event indicates that the station responded to the poll
3135 * initiated with @poll_client.
3137 EVENT_DRIVER_CLIENT_POLL_OK,
3140 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3142 EVENT_EAPOL_TX_STATUS,
3145 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3147 * Described in wpa_event_data.ch_switch
3152 * EVENT_WNM - Request WNM operation
3154 * This event can be used to request a WNM operation to be performed.
3159 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3161 * This event indicates that the driver reported a connection failure
3162 * with the specified client (for example, max client reached, etc.) in
3165 EVENT_CONNECT_FAILED_REASON,
3168 * EVENT_RADAR_DETECTED - Notify of radar detection
3170 * A radar has been detected on the supplied frequency, hostapd should
3171 * react accordingly (e.g., change channel).
3173 EVENT_DFS_RADAR_DETECTED,
3176 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3178 * After a successful CAC, the channel can be marked clear and used.
3180 EVENT_DFS_CAC_FINISHED,
3183 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3185 * The CAC was not successful, and the channel remains in the previous
3186 * state. This may happen due to a radar beeing detected or other
3187 * external influences.
3189 EVENT_DFS_CAC_ABORTED,
3192 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3194 * The channel which was previously unavailable is now available again.
3196 EVENT_DFS_NOP_FINISHED,
3199 * EVENT_SURVEY - Received survey data
3201 * This event gets triggered when a driver query is issued for survey
3202 * data and the requested data becomes available. The returned data is
3203 * stored in struct survey_results. The results provide at most one
3204 * survey entry for each frequency and at minimum will provide one
3205 * survey entry for one frequency. The survey data can be os_malloc()'d
3206 * and then os_free()'d, so the event callback must only copy data.
3211 * EVENT_SCAN_STARTED - Scan started
3213 * This indicates that driver has started a scan operation either based
3214 * on a request from wpa_supplicant/hostapd or from another application.
3215 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3216 * completed (either successfully or by getting cancelled).
3221 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3223 * This event indicates a set of frequency ranges that should be avoided
3224 * to reduce issues due to interference or internal co-existence
3225 * information in the driver.
3227 EVENT_AVOID_FREQUENCIES
3232 * struct freq_survey - Channel survey info
3234 * @ifidx: Interface index in which this survey was observed
3235 * @freq: Center of frequency of the surveyed channel
3236 * @nf: Channel noise floor in dBm
3237 * @channel_time: Amount of time in ms the radio spent on the channel
3238 * @channel_time_busy: Amount of time in ms the radio detected some signal
3239 * that indicated to the radio the channel was not clear
3240 * @channel_time_rx: Amount of time the radio spent receiving data
3241 * @channel_time_tx: Amount of time the radio spent transmitting data
3242 * @filled: bitmask indicating which fields have been reported, see
3243 * SURVEY_HAS_* defines.
3244 * @list: Internal list pointers
3246 struct freq_survey {
3251 u64 channel_time_busy;
3252 u64 channel_time_rx;
3253 u64 channel_time_tx;
3254 unsigned int filled;
3255 struct dl_list list;
3258 #define SURVEY_HAS_NF BIT(0)
3259 #define SURVEY_HAS_CHAN_TIME BIT(1)
3260 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3261 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3262 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3266 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3268 union wpa_event_data {
3270 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3272 * This structure is optional for EVENT_ASSOC calls and required for
3273 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3274 * driver interface does not need to generate separate EVENT_ASSOCINFO
3279 * reassoc - Flag to indicate association or reassociation
3284 * req_ies - (Re)Association Request IEs
3286 * If the driver generates WPA/RSN IE, this event data must be
3287 * returned for WPA handshake to have needed information. If
3288 * wpa_supplicant-generated WPA/RSN IE is used, this
3289 * information event is optional.
3291 * This should start with the first IE (fixed fields before IEs
3292 * are not included).
3297 * req_ies_len - Length of req_ies in bytes
3302 * resp_ies - (Re)Association Response IEs
3304 * Optional association data from the driver. This data is not
3305 * required WPA, but may be useful for some protocols and as
3306 * such, should be reported if this is available to the driver
3309 * This should start with the first IE (fixed fields before IEs
3310 * are not included).
3315 * resp_ies_len - Length of resp_ies in bytes
3317 size_t resp_ies_len;
3320 * beacon_ies - Beacon or Probe Response IEs
3322 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3323 * Probe Response frames from the current AP (i.e., the one
3324 * that the client just associated with). This information is
3325 * used to update WPA/RSN IE for the AP. If this field is not
3326 * set, the results from previous scan will be used. If no
3327 * data for the new AP is found, scan results will be requested
3328 * again (without scan request). At this point, the driver is
3329 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3332 * This should start with the first IE (fixed fields before IEs
3333 * are not included).
3335 const u8 *beacon_ies;
3338 * beacon_ies_len - Length of beacon_ies */
3339 size_t beacon_ies_len;
3342 * freq - Frequency of the operational channel in MHz
3347 * addr - Station address (for AP mode)
3353 * struct disassoc_info - Data for EVENT_DISASSOC events
3355 struct disassoc_info {
3357 * addr - Station address (for AP mode)
3362 * reason_code - Reason Code (host byte order) used in
3363 * Deauthentication frame
3368 * ie - Optional IE(s) in Disassociation frame
3373 * ie_len - Length of ie buffer in octets
3378 * locally_generated - Whether the frame was locally generated
3380 int locally_generated;
3384 * struct deauth_info - Data for EVENT_DEAUTH events
3386 struct deauth_info {
3388 * addr - Station address (for AP mode)
3393 * reason_code - Reason Code (host byte order) used in
3394 * Deauthentication frame
3399 * ie - Optional IE(s) in Deauthentication frame
3404 * ie_len - Length of ie buffer in octets
3409 * locally_generated - Whether the frame was locally generated
3411 int locally_generated;
3415 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3417 struct michael_mic_failure {
3420 } michael_mic_failure;
3423 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3425 struct interface_status {
3428 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3433 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3435 struct pmkid_candidate {
3436 /** BSSID of the PMKID candidate */
3438 /** Smaller the index, higher the priority */
3440 /** Whether RSN IE includes pre-authenticate flag */
3445 * struct stkstart - Data for EVENT_STKSTART
3452 * struct tdls - Data for EVENT_TDLS
3458 TDLS_REQUEST_TEARDOWN
3460 u16 reason_code; /* for teardown */
3464 * struct wnm - Data for EVENT_WNM
3482 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3484 * During FT (IEEE 802.11r) authentication sequence, the driver is
3485 * expected to use this event to report received FT IEs (MDIE, FTIE,
3486 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3487 * IEs for the next message will be delivered through the
3488 * struct wpa_driver_ops::update_ft_ies() callback.
3494 u8 target_ap[ETH_ALEN];
3495 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3497 /** Length of ric_ies buffer in octets */
3502 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3504 struct ibss_rsn_start {
3509 * struct auth_info - Data for EVENT_AUTH events
3515 u16 auth_transaction;
3522 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3524 struct assoc_reject {
3526 * bssid - BSSID of the AP that rejected association
3531 * resp_ies - (Re)Association Response IEs
3533 * Optional association data from the driver. This data is not
3534 * required WPA, but may be useful for some protocols and as
3535 * such, should be reported if this is available to the driver
3538 * This should start with the first IE (fixed fields before IEs
3539 * are not included).
3544 * resp_ies_len - Length of resp_ies in bytes
3546 size_t resp_ies_len;
3549 * status_code - Status Code from (Re)association Response
3554 struct timeout_event {
3559 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3568 * struct tx_status - Data for EVENT_TX_STATUS events
3580 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3582 struct rx_from_unknown {
3589 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3597 * drv_priv - Pointer to store driver private BSS information
3599 * If not set to NULL, this is used for comparison with
3600 * hostapd_data->drv_priv to determine which BSS should process
3606 * freq - Frequency (in MHz) on which the frame was received
3611 * ssi_signal - Signal strength in dBm (or 0 if not available)
3617 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3619 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3621 struct remain_on_channel {
3623 * freq - Channel frequency in MHz
3628 * duration - Duration to remain on the channel in milliseconds
3630 unsigned int duration;
3631 } remain_on_channel;
3634 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3635 * @aborted: Whether the scan was aborted
3636 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3637 * @num_freqs: Number of entries in freqs array
3638 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3640 * @num_ssids: Number of entries in ssids array
3646 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3651 * struct mlme_rx - Data for EVENT_MLME_RX events
3662 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3664 struct rx_probe_req {
3666 * sa - Source address of the received Probe Request frame
3671 * da - Destination address of the received Probe Request frame
3672 * or %NULL if not available
3677 * bssid - BSSID of the received Probe Request frame or %NULL
3683 * ie - IEs from the Probe Request body
3688 * ie_len - Length of ie buffer in octets
3693 * signal - signal strength in dBm (or 0 if not available)
3699 * struct new_sta - Data for EVENT_NEW_STA events
3706 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3715 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3717 struct wpa_signal_info signal_change;
3720 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3721 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3722 * @freq_5: Best 5 GHz band channel frequency in MHz
3723 * @freq_overall: Best channel frequency in MHz
3725 * 0 can be used to indicate no preference in either band.
3727 struct best_channel {
3733 struct unprot_deauth {
3739 struct unprot_disassoc {
3746 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3747 * @addr: station address
3754 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3756 struct ibss_peer_lost {
3761 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3763 struct driver_gtk_rekey {
3765 const u8 *replay_ctr;
3769 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
3770 * @addr: station address
3772 struct client_poll {
3777 * struct eapol_tx_status
3778 * @dst: Original destination
3779 * @data: Data starting with IEEE 802.1X header (!)
3780 * @data_len: Length of data
3781 * @ack: Indicates ack or lost frame
3783 * This corresponds to hapd_send_eapol if the frame sent
3784 * there isn't just reported as EVENT_TX_STATUS.
3786 struct eapol_tx_status {
3795 * @freq: Frequency of new channel in MHz
3796 * @ht_enabled: Whether this is an HT channel
3797 * @ch_offset: Secondary channel offset
3798 * @ch_width: Channel width
3799 * @cf1: Center frequency 1
3800 * @cf2: Center frequency 2
3806 enum chan_width ch_width;
3812 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
3813 * @addr: Remote client address
3814 * @code: Reason code for connection failure
3816 struct connect_failed_reason {
3822 } connect_failed_reason;
3825 * struct dfs_event - Data for radar detected events
3826 * @freq: Frequency of the channel in MHz
3832 enum chan_width chan_width;
3838 * survey_results - Survey result data for EVENT_SURVEY
3839 * @freq_filter: Requested frequency survey filter, 0 if request
3840 * was for all survey data
3841 * @survey_list: Linked list of survey data
3843 struct survey_results {
3844 unsigned int freq_filter;
3845 struct dl_list survey_list; /* struct freq_survey */
3849 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
3850 * @initiator: Initiator of the regulatory change
3852 struct channel_list_changed {
3853 enum reg_change_initiator initiator;
3854 } channel_list_changed;
3857 * freq_range - List of frequency ranges
3859 * This is used as the data with EVENT_AVOID_FREQUENCIES.
3861 struct wpa_freq_range_list freq_range;
3865 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3866 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3867 * with struct wpa_driver_ops::init()
3868 * @event: event type (defined above)
3869 * @data: possible extra data for the event
3871 * Driver wrapper code should call this function whenever an event is received
3874 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
3875 union wpa_event_data *data);
3879 * The following inline functions are provided for convenience to simplify
3880 * event indication for some of the common events.
3883 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
3884 size_t ielen, int reassoc)
3886 union wpa_event_data event;
3887 os_memset(&event, 0, sizeof(event));
3888 event.assoc_info.reassoc = reassoc;
3889 event.assoc_info.req_ies = ie;
3890 event.assoc_info.req_ies_len = ielen;
3891 event.assoc_info.addr = addr;
3892 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
3895 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
3897 union wpa_event_data event;
3898 os_memset(&event, 0, sizeof(event));
3899 event.disassoc_info.addr = addr;
3900 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
3903 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
3906 union wpa_event_data event;
3907 os_memset(&event, 0, sizeof(event));
3908 event.eapol_rx.src = src;
3909 event.eapol_rx.data = data;
3910 event.eapol_rx.data_len = data_len;
3911 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
3914 /* driver_common.c */
3915 void wpa_scan_results_free(struct wpa_scan_results *res);
3917 /* Convert wpa_event_type to a string for logging */
3918 const char * event_to_string(enum wpa_event_type event);
3920 /* NULL terminated array of linked in driver wrappers */
3921 extern struct wpa_driver_ops *wpa_drivers[];
3923 #endif /* DRIVER_H */