2 * Driver interface definition
3 * Copyright (c) 2003-2012, 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
41 * struct hostapd_channel_data - Channel information
43 struct hostapd_channel_data {
45 * chan - Channel number (IEEE 802.11)
50 * freq - Frequency in MHz
55 * flag - Channel flags (HOSTAPD_CHAN_*)
60 * max_tx_power - Maximum transmit power in dBm
65 * survey_list - Linked list of surveys
67 struct dl_list survey_list;
70 * min_nf - Minimum observed noise floor, in dBm, based on all
71 * surveyed channel data
77 * interference_factor - Computed interference factor on this
78 * channel (used internally in src/ap/acs.c; driver wrappers do not
81 long double interference_factor;
82 #endif /* CONFIG_ACS */
85 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
86 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
89 * struct hostapd_hw_modes - Supported hardware mode information
91 struct hostapd_hw_modes {
93 * mode - Hardware mode
95 enum hostapd_hw_mode mode;
98 * num_channels - Number of entries in the channels array
103 * channels - Array of supported channels
105 struct hostapd_channel_data *channels;
108 * num_rates - Number of entries in the rates array
113 * rates - Array of supported rates in 100 kbps units
118 * ht_capab - HT (IEEE 802.11n) capabilities
123 * mcs_set - MCS (IEEE 802.11n) rate parameters
128 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
133 * vht_capab - VHT (IEEE 802.11ac) capabilities
138 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
142 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
146 #define IEEE80211_MODE_INFRA 0
147 #define IEEE80211_MODE_IBSS 1
148 #define IEEE80211_MODE_AP 2
150 #define IEEE80211_CAP_ESS 0x0001
151 #define IEEE80211_CAP_IBSS 0x0002
152 #define IEEE80211_CAP_PRIVACY 0x0010
154 /* DMG (60 GHz) IEEE 802.11ad */
155 /* type - bits 0..1 */
156 #define IEEE80211_CAP_DMG_MASK 0x0003
157 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
158 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
159 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
161 #define WPA_SCAN_QUAL_INVALID BIT(0)
162 #define WPA_SCAN_NOISE_INVALID BIT(1)
163 #define WPA_SCAN_LEVEL_INVALID BIT(2)
164 #define WPA_SCAN_LEVEL_DBM BIT(3)
165 #define WPA_SCAN_AUTHENTICATED BIT(4)
166 #define WPA_SCAN_ASSOCIATED BIT(5)
169 * struct wpa_scan_res - Scan result for an BSS/IBSS
170 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
172 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
173 * @beacon_int: beacon interval in TUs (host byte order)
174 * @caps: capability information field in host byte order
175 * @qual: signal quality
176 * @noise: noise level
177 * @level: signal level
179 * @age: Age of the information in milliseconds (i.e., how many milliseconds
180 * ago the last Beacon or Probe Response frame was received)
181 * @ie_len: length of the following IE field in octets
182 * @beacon_ie_len: length of the following Beacon IE field in octets
184 * This structure is used as a generic format for scan results from the
185 * driver. Each driver interface implementation is responsible for converting
186 * the driver or OS specific scan results into this format.
188 * If the driver does not support reporting all IEs, the IE data structure is
189 * constructed of the IEs that are available. This field will also need to
190 * include SSID in IE format. All drivers are encouraged to be extended to
191 * report all IEs to make it easier to support future additions.
193 struct wpa_scan_res {
205 size_t beacon_ie_len;
207 * Followed by ie_len octets of IEs from Probe Response frame (or if
208 * the driver does not indicate source of IEs, these may also be from
209 * Beacon frame). After the first set of IEs, another set of IEs may
210 * follow (with beacon_ie_len octets of data) if the driver provides
216 * struct wpa_scan_results - Scan results
217 * @res: Array of pointers to allocated variable length scan result entries
218 * @num: Number of entries in the scan result array
219 * @fetch_time: Time when the results were fetched from the driver
221 struct wpa_scan_results {
222 struct wpa_scan_res **res;
224 struct os_time fetch_time;
228 * struct wpa_interface_info - Network interface information
229 * @next: Pointer to the next interface or NULL if this is the last one
230 * @ifname: Interface name that can be used with init() or init2()
231 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
233 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
234 * is not an allocated copy, i.e., get_interfaces() caller will not free
237 struct wpa_interface_info {
238 struct wpa_interface_info *next;
241 const char *drv_name;
244 #define WPAS_MAX_SCAN_SSIDS 16
247 * struct wpa_driver_scan_params - Scan parameters
248 * Data for struct wpa_driver_ops::scan2().
250 struct wpa_driver_scan_params {
252 * ssids - SSIDs to scan for
254 struct wpa_driver_scan_ssid {
256 * ssid - specific SSID to scan for (ProbeReq)
257 * %NULL or zero-length SSID is used to indicate active scan
258 * with wildcard SSID.
262 * ssid_len: Length of the SSID in octets
265 } ssids[WPAS_MAX_SCAN_SSIDS];
268 * num_ssids - Number of entries in ssids array
269 * Zero indicates a request for a passive scan.
274 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
279 * extra_ies_len - Length of extra_ies in octets
281 size_t extra_ies_len;
284 * freqs - Array of frequencies to scan or %NULL for all frequencies
286 * The frequency is set in MHz. The array is zero-terminated.
291 * filter_ssids - Filter for reporting SSIDs
293 * This optional parameter can be used to request the driver wrapper to
294 * filter scan results to include only the specified SSIDs. %NULL
295 * indicates that no filtering is to be done. This can be used to
296 * reduce memory needs for scan results in environments that have large
297 * number of APs with different SSIDs.
299 * The driver wrapper is allowed to take this allocated buffer into its
300 * own use by setting the pointer to %NULL. In that case, the driver
301 * wrapper is responsible for freeing the buffer with os_free() once it
302 * is not needed anymore.
304 struct wpa_driver_scan_filter {
310 * num_filter_ssids - Number of entries in filter_ssids array
312 size_t num_filter_ssids;
315 * filter_rssi - Filter by RSSI
317 * The driver may filter scan results in firmware to reduce host
318 * wakeups and thereby save power. Specify the RSSI threshold in s32
324 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
326 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
327 * Mbps from the support rates element(s) in the Probe Request frames
328 * and not to transmit the frames at any of those rates.
334 * struct wpa_driver_auth_params - Authentication parameters
335 * Data for struct wpa_driver_ops::authenticate().
337 struct wpa_driver_auth_params {
345 const u8 *wep_key[4];
346 size_t wep_key_len[4];
348 int local_state_change;
351 * p2p - Whether this connection is a P2P group
361 WPS_MODE_NONE /* no WPS provisioning being used */,
362 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
363 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
368 * struct wpa_driver_associate_params - Association parameters
369 * Data for struct wpa_driver_ops::associate().
371 struct wpa_driver_associate_params {
373 * bssid - BSSID of the selected AP
374 * This can be %NULL, if ap_scan=2 mode is used and the driver is
375 * responsible for selecting with which BSS to associate. */
379 * ssid - The selected SSID
384 * ssid_len - Length of the SSID (1..32)
389 * freq - Frequency of the channel the selected AP is using
390 * Frequency that the selected AP is using (in MHz as
391 * reported in the scan results)
396 * bg_scan_period - Background scan period in seconds, 0 to disable
397 * background scan, or -1 to indicate no change to default driver
403 * wpa_ie - WPA information element for (Re)Association Request
404 * WPA information element to be included in (Re)Association
405 * Request (including information element id and length). Use
406 * of this WPA IE is optional. If the driver generates the WPA
407 * IE, it can use pairwise_suite, group_suite, and
408 * key_mgmt_suite to select proper algorithms. In this case,
409 * the driver has to notify wpa_supplicant about the used WPA
410 * IE by generating an event that the interface code will
411 * convert into EVENT_ASSOCINFO data (see below).
413 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
414 * instead. The driver can determine which version is used by
415 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
418 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
423 * wpa_ie_len - length of the wpa_ie
428 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
430 unsigned int wpa_proto;
433 * pairwise_suite - Selected pairwise cipher suite
435 * This is usually ignored if @wpa_ie is used.
437 enum wpa_cipher pairwise_suite;
440 * group_suite - Selected group cipher suite
442 * This is usually ignored if @wpa_ie is used.
444 enum wpa_cipher group_suite;
447 * key_mgmt_suite - Selected key management suite
449 * This is usually ignored if @wpa_ie is used.
451 enum wpa_key_mgmt key_mgmt_suite;
454 * auth_alg - Allowed authentication algorithms
455 * Bit field of WPA_AUTH_ALG_*
460 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
465 * wep_key - WEP keys for static WEP configuration
467 const u8 *wep_key[4];
470 * wep_key_len - WEP key length for static WEP configuration
472 size_t wep_key_len[4];
475 * wep_tx_keyidx - WEP TX key index for static WEP configuration
480 * mgmt_frame_protection - IEEE 802.11w management frame protection
482 enum mfp_options mgmt_frame_protection;
485 * ft_ies - IEEE 802.11r / FT information elements
486 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
487 * for fast transition, this parameter is set to include the IEs that
488 * are to be sent in the next FT Authentication Request message.
489 * update_ft_ies() handler is called to update the IEs for further
490 * FT messages in the sequence.
492 * The driver should use these IEs only if the target AP is advertising
493 * the same mobility domain as the one included in the MDIE here.
495 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
496 * AP after the initial association. These IEs can only be used if the
497 * target AP is advertising support for FT and is using the same MDIE
498 * and SSID as the current AP.
500 * The driver is responsible for reporting the FT IEs received from the
501 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
502 * type. update_ft_ies() handler will then be called with the FT IEs to
503 * include in the next frame in the authentication sequence.
508 * ft_ies_len - Length of ft_ies in bytes
513 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
515 * This value is provided to allow the driver interface easier access
516 * to the current mobility domain. This value is set to %NULL if no
517 * mobility domain is currently active.
522 * passphrase - RSN passphrase for PSK
524 * This value is made available only for WPA/WPA2-Personal (PSK) and
525 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
526 * the 8..63 character ASCII passphrase, if available. Please note that
527 * this can be %NULL if passphrase was not used to generate the PSK. In
528 * that case, the psk field must be used to fetch the PSK.
530 const char *passphrase;
533 * psk - RSN PSK (alternative for passphrase for PSK)
535 * This value is made available only for WPA/WPA2-Personal (PSK) and
536 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
537 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
538 * be prepared to handle %NULL value as an error.
543 * drop_unencrypted - Enable/disable unencrypted frame filtering
545 * Configure the driver to drop all non-EAPOL frames (both receive and
546 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
547 * still be allowed for key negotiation.
549 int drop_unencrypted;
552 * prev_bssid - Previously used BSSID in this ESS
554 * When not %NULL, this is a request to use reassociation instead of
557 const u8 *prev_bssid;
562 * If the driver needs to do special configuration for WPS association,
563 * this variable provides more information on what type of association
564 * is being requested. Most drivers should not need ot use this.
569 * p2p - Whether this connection is a P2P group
574 * uapsd - UAPSD parameters for the network
575 * -1 = do not change defaults
576 * AP mode: 1 = enabled, 0 = disabled
577 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
582 * fixed_bssid - Whether to force this BSSID in IBSS mode
583 * 1 = Fix this BSSID and prevent merges.
584 * 0 = Do not fix BSSID.
589 * disable_ht - Disable HT (IEEE 802.11n) for this connection
594 * HT Capabilities over-rides. Only bits set in the mask will be used,
595 * and not all values are used by the kernel anyway. Currently, MCS,
596 * MPDU and MSDU fields are used.
598 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */
599 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */
601 #ifdef CONFIG_VHT_OVERRIDES
603 * disable_vht - Disable VHT for this connection
608 * VHT capability overrides.
610 const struct ieee80211_vht_capabilities *vhtcaps;
611 const struct ieee80211_vht_capabilities *vhtcaps_mask;
612 #endif /* CONFIG_VHT_OVERRIDES */
617 HIDDEN_SSID_ZERO_LEN,
618 HIDDEN_SSID_ZERO_CONTENTS
621 struct wpa_driver_ap_params {
623 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
628 * head_len - Length of the head buffer in octets
633 * tail - Beacon tail following TIM IE
638 * tail_len - Length of the tail buffer in octets
643 * dtim_period - DTIM period
648 * beacon_int - Beacon interval
653 * basic_rates: -1 terminated array of basic rates in 100 kbps
655 * This parameter can be used to set a specific basic rate set for the
656 * BSS. If %NULL, default basic rate set is used.
661 * proberesp - Probe Response template
663 * This is used by drivers that reply to Probe Requests internally in
664 * AP mode and require the full Probe Response template.
669 * proberesp_len - Length of the proberesp buffer in octets
671 size_t proberesp_len;
674 * ssid - The SSID to use in Beacon/Probe Response frames
679 * ssid_len - Length of the SSID (1..32)
684 * hide_ssid - Whether to hide the SSID
686 enum hide_ssid hide_ssid;
689 * pairwise_ciphers - WPA_CIPHER_* bitfield
691 unsigned int pairwise_ciphers;
694 * group_cipher - WPA_CIPHER_*
696 unsigned int group_cipher;
699 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
701 unsigned int key_mgmt_suites;
704 * auth_algs - WPA_AUTH_ALG_* bitfield
706 unsigned int auth_algs;
709 * wpa_version - WPA_PROTO_* bitfield
711 unsigned int wpa_version;
714 * privacy - Whether privacy is used in the BSS
719 * beacon_ies - WPS/P2P IE(s) for Beacon frames
721 * This is used to add IEs like WPS IE and P2P IE by drivers that do
722 * not use the full Beacon template.
724 const struct wpabuf *beacon_ies;
727 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
729 * This is used to add IEs like WPS IE and P2P IE by drivers that
730 * reply to Probe Request frames internally.
732 const struct wpabuf *proberesp_ies;
735 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
737 * This is used to add IEs like WPS IE by drivers that reply to
738 * (Re)Association Request frames internally.
740 const struct wpabuf *assocresp_ies;
743 * isolate - Whether to isolate frames between associated stations
745 * If this is non-zero, the AP is requested to disable forwarding of
746 * frames between associated stations.
751 * cts_protect - Whether CTS protection is enabled
756 * preamble - Whether short preamble is enabled
761 * short_slot_time - Whether short slot time is enabled
763 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
764 * not set (e.g., when 802.11g mode is not in use)
769 * ht_opmode - HT operation mode or -1 if HT not in use
774 * interworking - Whether Interworking is enabled
779 * hessid - Homogeneous ESS identifier or %NULL if not set
784 * access_network_type - Access Network Type (0..15)
786 * This is used for filtering Probe Request frames when Interworking is
789 u8 access_network_type;
792 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
794 * This is used by driver which advertises this capability.
796 int ap_max_inactivity;
799 * disable_dgaf - Whether group-addressed frames are disabled
805 * struct wpa_driver_capa - Driver capability information
807 struct wpa_driver_capa {
808 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
809 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
810 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
811 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
812 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
813 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
814 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
815 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
816 unsigned int key_mgmt;
818 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
819 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
820 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
821 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
822 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
823 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
826 #define WPA_DRIVER_AUTH_OPEN 0x00000001
827 #define WPA_DRIVER_AUTH_SHARED 0x00000002
828 #define WPA_DRIVER_AUTH_LEAP 0x00000004
831 /* Driver generated WPA/RSN IE */
832 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
833 /* Driver needs static WEP key setup after association command */
834 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
835 /* unused: 0x00000004 */
836 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
837 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
838 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
839 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
840 /* Driver provides separate commands for authentication and association (SME in
841 * wpa_supplicant). */
842 #define WPA_DRIVER_FLAGS_SME 0x00000020
843 /* Driver supports AP mode */
844 #define WPA_DRIVER_FLAGS_AP 0x00000040
845 /* Driver needs static WEP key setup after association has been completed */
846 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
847 /* Driver takes care of P2P management operations */
848 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
849 /* Driver supports concurrent P2P operations */
850 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
852 * Driver uses the initial interface as a dedicated management interface, i.e.,
853 * it cannot be used for P2P group operations or non-P2P purposes.
855 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
856 /* This interface is P2P capable (P2P GO or P2P Client) */
857 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
858 /* unused: 0x00001000 */
860 * Driver uses the initial interface for P2P management interface and non-P2P
861 * purposes (e.g., connect to infra AP), but this interface cannot be used for
862 * P2P group operations.
864 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
866 * Driver is known to use sane error codes, i.e., when it indicates that
867 * something (e.g., association) fails, there was indeed a failure and the
868 * operation does not end up getting completed successfully later.
870 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
871 /* Driver supports off-channel TX */
872 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
873 /* Driver indicates TX status events for EAPOL Data frames */
874 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
875 /* Driver indicates TX status events for Deauth/Disassoc frames */
876 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
877 /* Driver supports roaming (BSS selection) in firmware */
878 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
879 /* Driver supports operating as a TDLS peer */
880 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
881 /* Driver requires external TDLS setup/teardown/discovery */
882 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
883 /* Driver indicates support for Probe Response offloading in AP mode */
884 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
885 /* Driver supports U-APSD in AP mode */
886 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
887 /* Driver supports inactivity timer in AP mode */
888 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
889 /* Driver expects user space implementation of MLME in AP mode */
890 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
891 /* Driver supports SAE with user space SME */
892 #define WPA_DRIVER_FLAGS_SAE 0x02000000
893 /* Driver makes use of OBSS scan mechanism in wpa_supplicant */
894 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
895 /* Driver supports IBSS (Ad-hoc) mode */
896 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
897 /* Driver supports radar detection */
898 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
899 /* Driver supports a dedicated interface for P2P Device */
900 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
904 int max_sched_scan_ssids;
905 int sched_scan_supported;
909 * max_remain_on_chan - Maximum remain-on-channel duration in msec
911 unsigned int max_remain_on_chan;
914 * max_stations - Maximum number of associated stations the driver
915 * supports in AP mode
917 unsigned int max_stations;
920 * probe_resp_offloads - Bitmap of supported protocols by the driver
921 * for Probe Response offloading.
923 /* Driver Probe Response offloading support for WPS ver. 1 */
924 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
925 /* Driver Probe Response offloading support for WPS ver. 2 */
926 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
927 /* Driver Probe Response offloading support for P2P */
928 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
929 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
930 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
931 unsigned int probe_resp_offloads;
933 unsigned int max_acl_mac_addrs;
936 * Number of supported concurrent channels
938 unsigned int num_multichan_concurrent;
941 * extended_capa - extended capabilities in driver/device
943 * Must be allocated and freed by driver and the pointers must be
944 * valid for the lifetime of the driver, i.e., freed in deinit()
946 const u8 *extended_capa, *extended_capa_mask;
947 unsigned int extended_capa_len;
953 struct hostap_sta_driver_data {
954 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
955 unsigned long current_tx_rate;
956 unsigned long inactive_msec;
958 unsigned long num_ps_buf_frames;
959 unsigned long tx_retry_failed;
960 unsigned long tx_retry_count;
965 struct hostapd_sta_add_params {
969 const u8 *supp_rates;
970 size_t supp_rates_len;
972 const struct ieee80211_ht_capabilities *ht_capabilities;
973 const struct ieee80211_vht_capabilities *vht_capabilities;
974 u32 flags; /* bitmask of WPA_STA_* flags */
975 int set; /* Set STA parameters instead of add */
978 size_t ext_capab_len;
981 struct hostapd_freq_params {
987 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
988 * secondary channel below primary, 1 = HT40
989 * enabled, secondary channel above primary */
994 /* valid for both HT and VHT, center_freq2 is non-zero
995 * only for bandwidth 80 and an 80+80 channel */
996 int center_freq1, center_freq2;
1000 struct mac_address {
1004 struct hostapd_acl_params {
1006 unsigned int num_mac_acl;
1007 struct mac_address mac_acl[0];
1010 enum wpa_driver_if_type {
1012 * WPA_IF_STATION - Station mode interface
1017 * WPA_IF_AP_VLAN - AP mode VLAN interface
1019 * This interface shares its address and Beacon frame with the main
1025 * WPA_IF_AP_BSS - AP mode BSS interface
1027 * This interface has its own address and Beacon frame.
1032 * WPA_IF_P2P_GO - P2P Group Owner
1037 * WPA_IF_P2P_CLIENT - P2P Client
1042 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1043 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1048 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1049 * abstracted P2P Device function in the driver
1054 struct wpa_init_params {
1060 const char *test_socket;
1061 int use_pae_group_addr;
1065 u8 *own_addr; /* buffer for writing own MAC address */
1069 struct wpa_bss_params {
1070 /** Interface name (for multi-SSID/VLAN support) */
1072 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1081 enum mfp_options ieee80211w;
1084 #define WPA_STA_AUTHORIZED BIT(0)
1085 #define WPA_STA_WMM BIT(1)
1086 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1087 #define WPA_STA_MFP BIT(3)
1088 #define WPA_STA_TDLS_PEER BIT(4)
1091 * struct p2p_params - P2P parameters for driver-based P2P management
1094 const char *dev_name;
1096 #define DRV_MAX_SEC_DEV_TYPES 5
1097 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8];
1098 size_t num_sec_dev_types;
1112 WNM_SLEEP_ENTER_CONFIRM,
1113 WNM_SLEEP_ENTER_FAIL,
1114 WNM_SLEEP_EXIT_CONFIRM,
1115 WNM_SLEEP_EXIT_FAIL,
1116 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1117 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1118 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1120 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1122 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1123 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1125 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1128 /* enum chan_width - Channel width definitions */
1140 * struct wpa_signal_info - Information about channel signal quality
1142 struct wpa_signal_info {
1144 int above_threshold;
1149 enum chan_width chanwidth;
1155 * struct wpa_driver_ops - Driver interface API definition
1157 * This structure defines the API that each driver interface needs to implement
1158 * for core wpa_supplicant code. All driver specific functionality is captured
1161 struct wpa_driver_ops {
1162 /** Name of the driver interface */
1164 /** One line description of the driver interface */
1168 * get_bssid - Get the current BSSID
1169 * @priv: private driver interface data
1170 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1172 * Returns: 0 on success, -1 on failure
1174 * Query kernel driver for the current BSSID and copy it to bssid.
1175 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1178 int (*get_bssid)(void *priv, u8 *bssid);
1181 * get_ssid - Get the current SSID
1182 * @priv: private driver interface data
1183 * @ssid: buffer for SSID (at least 32 bytes)
1185 * Returns: Length of the SSID on success, -1 on failure
1187 * Query kernel driver for the current SSID and copy it to ssid.
1188 * Returning zero is recommended if the STA is not associated.
1190 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1191 * can, at least in theory, contain control characters (including nul)
1192 * and as such, should be processed as binary data, not a printable
1195 int (*get_ssid)(void *priv, u8 *ssid);
1198 * set_key - Configure encryption key
1199 * @ifname: Interface name (for multi-SSID/VLAN support)
1200 * @priv: private driver interface data
1201 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1202 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1204 * %WPA_ALG_NONE clears the key.
1205 * @addr: Address of the peer STA (BSSID of the current AP when setting
1206 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1207 * broadcast keys, %NULL for default keys that are used both for
1208 * broadcast and unicast; when clearing keys, %NULL is used to
1209 * indicate that both the broadcast-only and default key of the
1210 * specified key index is to be cleared
1211 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1213 * @set_tx: configure this key as the default Tx key (only used when
1214 * driver does not support separate unicast/individual key
1215 * @seq: sequence number/packet number, seq_len octets, the next
1216 * packet number to be used for in replay protection; configured
1217 * for Rx keys (in most cases, this is only used with broadcast
1218 * keys and set to zero for unicast keys); %NULL if not set
1219 * @seq_len: length of the seq, depends on the algorithm:
1220 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1221 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1223 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1224 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1226 * Returns: 0 on success, -1 on failure
1228 * Configure the given key for the kernel driver. If the driver
1229 * supports separate individual keys (4 default keys + 1 individual),
1230 * addr can be used to determine whether the key is default or
1231 * individual. If only 4 keys are supported, the default key with key
1232 * index 0 is used as the individual key. STA must be configured to use
1233 * it as the default Tx key (set_tx is set) and accept Rx for all the
1234 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1235 * broadcast keys, so key index 0 is available for this kind of
1238 * Please note that TKIP keys include separate TX and RX MIC keys and
1239 * some drivers may expect them in different order than wpa_supplicant
1240 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1241 * will trigger Michael MIC errors. This can be fixed by changing the
1242 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1243 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1244 * example on how this can be done.
1246 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1247 const u8 *addr, int key_idx, int set_tx,
1248 const u8 *seq, size_t seq_len,
1249 const u8 *key, size_t key_len);
1252 * init - Initialize driver interface
1253 * @ctx: context to be used when calling wpa_supplicant functions,
1254 * e.g., wpa_supplicant_event()
1255 * @ifname: interface name, e.g., wlan0
1257 * Returns: Pointer to private data, %NULL on failure
1259 * Initialize driver interface, including event processing for kernel
1260 * driver events (e.g., associated, scan results, Michael MIC failure).
1261 * This function can allocate a private configuration data area for
1262 * @ctx, file descriptor, interface name, etc. information that may be
1263 * needed in future driver operations. If this is not used, non-NULL
1264 * value will need to be returned because %NULL is used to indicate
1265 * failure. The returned value will be used as 'void *priv' data for
1266 * all other driver_ops functions.
1268 * The main event loop (eloop.c) of wpa_supplicant can be used to
1269 * register callback for read sockets (eloop_register_read_sock()).
1271 * See below for more information about events and
1272 * wpa_supplicant_event() function.
1274 void * (*init)(void *ctx, const char *ifname);
1277 * deinit - Deinitialize driver interface
1278 * @priv: private driver interface data from init()
1280 * Shut down driver interface and processing of driver events. Free
1281 * private data buffer if one was allocated in init() handler.
1283 void (*deinit)(void *priv);
1286 * set_param - Set driver configuration parameters
1287 * @priv: private driver interface data from init()
1288 * @param: driver specific configuration parameters
1290 * Returns: 0 on success, -1 on failure
1292 * Optional handler for notifying driver interface about configuration
1293 * parameters (driver_param).
1295 int (*set_param)(void *priv, const char *param);
1298 * set_countermeasures - Enable/disable TKIP countermeasures
1299 * @priv: private driver interface data
1300 * @enabled: 1 = countermeasures enabled, 0 = disabled
1302 * Returns: 0 on success, -1 on failure
1304 * Configure TKIP countermeasures. When these are enabled, the driver
1305 * should drop all received and queued frames that are using TKIP.
1307 int (*set_countermeasures)(void *priv, int enabled);
1310 * deauthenticate - Request driver to deauthenticate
1311 * @priv: private driver interface data
1312 * @addr: peer address (BSSID of the AP)
1313 * @reason_code: 16-bit reason code to be sent in the deauthentication
1316 * Returns: 0 on success, -1 on failure
1318 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1321 * associate - Request driver to associate
1322 * @priv: private driver interface data
1323 * @params: association parameters
1325 * Returns: 0 on success, -1 on failure
1327 int (*associate)(void *priv,
1328 struct wpa_driver_associate_params *params);
1331 * add_pmkid - Add PMKSA cache entry to the driver
1332 * @priv: private driver interface data
1333 * @bssid: BSSID for the PMKSA cache entry
1334 * @pmkid: PMKID for the PMKSA cache entry
1336 * Returns: 0 on success, -1 on failure
1338 * This function is called when a new PMK is received, as a result of
1339 * either normal authentication or RSN pre-authentication.
1341 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1342 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1343 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1344 * driver_ops function does not need to be implemented. Likewise, if
1345 * the driver does not support WPA, this function is not needed.
1347 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1350 * remove_pmkid - Remove PMKSA cache entry to the driver
1351 * @priv: private driver interface data
1352 * @bssid: BSSID for the PMKSA cache entry
1353 * @pmkid: PMKID for the PMKSA cache entry
1355 * Returns: 0 on success, -1 on failure
1357 * This function is called when the supplicant drops a PMKSA cache
1358 * entry for any reason.
1360 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1361 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1362 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1363 * from wpa_supplicant, this driver_ops function does not need to be
1364 * implemented. Likewise, if the driver does not support WPA, this
1365 * function is not needed.
1367 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1370 * flush_pmkid - Flush PMKSA cache
1371 * @priv: private driver interface data
1373 * Returns: 0 on success, -1 on failure
1375 * This function is called when the supplicant drops all PMKSA cache
1376 * entries for any reason.
1378 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1379 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1380 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1381 * from wpa_supplicant, this driver_ops function does not need to be
1382 * implemented. Likewise, if the driver does not support WPA, this
1383 * function is not needed.
1385 int (*flush_pmkid)(void *priv);
1388 * get_capa - Get driver capabilities
1389 * @priv: private driver interface data
1391 * Returns: 0 on success, -1 on failure
1393 * Get driver/firmware/hardware capabilities.
1395 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1398 * poll - Poll driver for association information
1399 * @priv: private driver interface data
1401 * This is an option callback that can be used when the driver does not
1402 * provide event mechanism for association events. This is called when
1403 * receiving WPA EAPOL-Key messages that require association
1404 * information. The driver interface is supposed to generate associnfo
1405 * event before returning from this callback function. In addition, the
1406 * driver interface should generate an association event after having
1407 * sent out associnfo.
1409 void (*poll)(void *priv);
1412 * get_ifname - Get interface name
1413 * @priv: private driver interface data
1415 * Returns: Pointer to the interface name. This can differ from the
1416 * interface name used in init() call. Init() is called first.
1418 * This optional function can be used to allow the driver interface to
1419 * replace the interface name with something else, e.g., based on an
1420 * interface mapping from a more descriptive name.
1422 const char * (*get_ifname)(void *priv);
1425 * get_mac_addr - Get own MAC address
1426 * @priv: private driver interface data
1428 * Returns: Pointer to own MAC address or %NULL on failure
1430 * This optional function can be used to get the own MAC address of the
1431 * device from the driver interface code. This is only needed if the
1432 * l2_packet implementation for the OS does not provide easy access to
1434 const u8 * (*get_mac_addr)(void *priv);
1437 * send_eapol - Optional function for sending EAPOL packets
1438 * @priv: private driver interface data
1439 * @dest: Destination MAC address
1441 * @data: EAPOL packet starting with IEEE 802.1X header
1442 * @data_len: Size of the EAPOL packet
1444 * Returns: 0 on success, -1 on failure
1446 * This optional function can be used to override l2_packet operations
1447 * with driver specific functionality. If this function pointer is set,
1448 * l2_packet module is not used at all and the driver interface code is
1449 * responsible for receiving and sending all EAPOL packets. The
1450 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1451 * event. The driver interface is required to implement get_mac_addr()
1452 * handler if send_eapol() is used.
1454 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1455 const u8 *data, size_t data_len);
1458 * set_operstate - Sets device operating state to DORMANT or UP
1459 * @priv: private driver interface data
1460 * @state: 0 = dormant, 1 = up
1461 * Returns: 0 on success, -1 on failure
1463 * This is an optional function that can be used on operating systems
1464 * that support a concept of controlling network device state from user
1465 * space applications. This function, if set, gets called with
1466 * state = 1 when authentication has been completed and with state = 0
1467 * when connection is lost.
1469 int (*set_operstate)(void *priv, int state);
1472 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1473 * @priv: Private driver interface data
1474 * @addr: Address of the station for which to set protection (may be
1475 * %NULL for group keys)
1476 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1477 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1478 * Returns: 0 on success, -1 on failure
1480 * This is an optional function that can be used to set the driver to
1481 * require protection for Tx and/or Rx frames. This uses the layer
1482 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1483 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1484 * set protection operation; instead, they set protection implicitly
1485 * based on configured keys.
1487 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1491 * get_hw_feature_data - Get hardware support data (channels and rates)
1492 * @priv: Private driver interface data
1493 * @num_modes: Variable for returning the number of returned modes
1494 * flags: Variable for returning hardware feature flags
1495 * Returns: Pointer to allocated hardware data on success or %NULL on
1496 * failure. Caller is responsible for freeing this.
1498 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1503 * send_mlme - Send management frame from MLME
1504 * @priv: Private driver interface data
1505 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1506 * @data_len: Size of the management frame
1507 * @noack: Do not wait for this frame to be acked (disable retries)
1508 * Returns: 0 on success, -1 on failure
1510 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1514 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1515 * @priv: Private driver interface data
1516 * @md: Mobility domain (2 octets) (also included inside ies)
1517 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1518 * @ies_len: Length of FT IEs in bytes
1519 * Returns: 0 on success, -1 on failure
1521 * The supplicant uses this callback to let the driver know that keying
1522 * material for FT is available and that the driver can use the
1523 * provided IEs in the next message in FT authentication sequence.
1525 * This function is only needed for driver that support IEEE 802.11r
1526 * (Fast BSS Transition).
1528 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1532 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1533 * @priv: Private driver interface data
1534 * @action: Action field value
1535 * @target_ap: Target AP address
1536 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1537 * @ies_len: Length of FT IEs in bytes
1538 * Returns: 0 on success, -1 on failure
1540 * The supplicant uses this callback to request the driver to transmit
1541 * an FT Action frame (action category 6) for over-the-DS fast BSS
1544 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1545 const u8 *ies, size_t ies_len);
1548 * get_scan_results2 - Fetch the latest scan results
1549 * @priv: private driver interface data
1551 * Returns: Allocated buffer of scan results (caller is responsible for
1552 * freeing the data structure) on success, NULL on failure
1554 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1557 * set_country - Set country
1558 * @priv: Private driver interface data
1559 * @alpha2: country to which to switch to
1560 * Returns: 0 on success, -1 on failure
1562 * This function is for drivers which support some form
1563 * of setting a regulatory domain.
1565 int (*set_country)(void *priv, const char *alpha2);
1568 * global_init - Global driver initialization
1569 * Returns: Pointer to private data (global), %NULL on failure
1571 * This optional function is called to initialize the driver wrapper
1572 * for global data, i.e., data that applies to all interfaces. If this
1573 * function is implemented, global_deinit() will also need to be
1574 * implemented to free the private data. The driver will also likely
1575 * use init2() function instead of init() to get the pointer to global
1576 * data available to per-interface initializer.
1578 void * (*global_init)(void);
1581 * global_deinit - Global driver deinitialization
1582 * @priv: private driver global data from global_init()
1584 * Terminate any global driver related functionality and free the
1585 * global data structure.
1587 void (*global_deinit)(void *priv);
1590 * init2 - Initialize driver interface (with global data)
1591 * @ctx: context to be used when calling wpa_supplicant functions,
1592 * e.g., wpa_supplicant_event()
1593 * @ifname: interface name, e.g., wlan0
1594 * @global_priv: private driver global data from global_init()
1595 * Returns: Pointer to private data, %NULL on failure
1597 * This function can be used instead of init() if the driver wrapper
1600 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1603 * get_interfaces - Get information about available interfaces
1604 * @global_priv: private driver global data from global_init()
1605 * Returns: Allocated buffer of interface information (caller is
1606 * responsible for freeing the data structure) on success, NULL on
1609 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1612 * scan2 - Request the driver to initiate scan
1613 * @priv: private driver interface data
1614 * @params: Scan parameters
1616 * Returns: 0 on success, -1 on failure
1618 * Once the scan results are ready, the driver should report scan
1619 * results event for wpa_supplicant which will eventually request the
1620 * results with wpa_driver_get_scan_results2().
1622 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1625 * authenticate - Request driver to authenticate
1626 * @priv: private driver interface data
1627 * @params: authentication parameters
1628 * Returns: 0 on success, -1 on failure
1630 * This is an optional function that can be used with drivers that
1631 * support separate authentication and association steps, i.e., when
1632 * wpa_supplicant can act as the SME. If not implemented, associate()
1633 * function is expected to take care of IEEE 802.11 authentication,
1636 int (*authenticate)(void *priv,
1637 struct wpa_driver_auth_params *params);
1640 * set_ap - Set Beacon and Probe Response information for AP mode
1641 * @priv: Private driver interface data
1642 * @params: Parameters to use in AP mode
1644 * This function is used to configure Beacon template and/or extra IEs
1645 * to add for Beacon and Probe Response frames for the driver in
1646 * AP mode. The driver is responsible for building the full Beacon
1647 * frame by concatenating the head part with TIM IE generated by the
1648 * driver/firmware and finishing with the tail part. Depending on the
1649 * driver architectue, this can be done either by using the full
1650 * template or the set of additional IEs (e.g., WPS and P2P IE).
1651 * Similarly, Probe Response processing depends on the driver design.
1652 * If the driver (or firmware) takes care of replying to Probe Request
1653 * frames, the extra IEs provided here needs to be added to the Probe
1656 * Returns: 0 on success, -1 on failure
1658 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1661 * set_acl - Set ACL in AP mode
1662 * @priv: Private driver interface data
1663 * @params: Parameters to configure ACL
1664 * Returns: 0 on success, -1 on failure
1666 * This is used only for the drivers which support MAC address ACL.
1668 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1671 * hapd_init - Initialize driver interface (hostapd only)
1672 * @hapd: Pointer to hostapd context
1673 * @params: Configuration for the driver wrapper
1674 * Returns: Pointer to private data, %NULL on failure
1676 * This function is used instead of init() or init2() when the driver
1677 * wrapper is used with hostapd.
1679 void * (*hapd_init)(struct hostapd_data *hapd,
1680 struct wpa_init_params *params);
1683 * hapd_deinit - Deinitialize driver interface (hostapd only)
1684 * @priv: Private driver interface data from hapd_init()
1686 void (*hapd_deinit)(void *priv);
1689 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1690 * @priv: Private driver interface data
1691 * @params: BSS parameters
1692 * Returns: 0 on success, -1 on failure
1694 * This is an optional function to configure the kernel driver to
1695 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1696 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1697 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1698 * for Beacon frames.
1700 * DEPRECATED - use set_ap() instead
1702 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1705 * set_privacy - Enable/disable privacy (AP only)
1706 * @priv: Private driver interface data
1707 * @enabled: 1 = privacy enabled, 0 = disabled
1708 * Returns: 0 on success, -1 on failure
1710 * This is an optional function to configure privacy field in the
1711 * kernel driver for Beacon frames. This can be left undefined (set to
1712 * %NULL) if the driver uses the Beacon template from set_ap().
1714 * DEPRECATED - use set_ap() instead
1716 int (*set_privacy)(void *priv, int enabled);
1719 * get_seqnum - Fetch the current TSC/packet number (AP only)
1720 * @ifname: The interface name (main or virtual)
1721 * @priv: Private driver interface data
1722 * @addr: MAC address of the station or %NULL for group keys
1724 * @seq: Buffer for returning the latest used TSC/packet number
1725 * Returns: 0 on success, -1 on failure
1727 * This function is used to fetch the last used TSC/packet number for
1728 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1729 * keys, so there is no strict requirement on implementing support for
1730 * unicast keys (i.e., addr != %NULL).
1732 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1736 * flush - Flush all association stations (AP only)
1737 * @priv: Private driver interface data
1738 * Returns: 0 on success, -1 on failure
1740 * This function requests the driver to disassociate all associated
1741 * stations. This function does not need to be implemented if the
1742 * driver does not process association frames internally.
1744 int (*flush)(void *priv);
1747 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1748 * @priv: Private driver interface data
1749 * @elem: Information elements
1750 * @elem_len: Length of the elem buffer in octets
1751 * Returns: 0 on success, -1 on failure
1753 * This is an optional function to add information elements in the
1754 * kernel driver for Beacon and Probe Response frames. This can be left
1755 * undefined (set to %NULL) if the driver uses the Beacon template from
1758 * DEPRECATED - use set_ap() instead
1760 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1763 * read_sta_data - Fetch station data
1764 * @priv: Private driver interface data
1765 * @data: Buffer for returning station information
1766 * @addr: MAC address of the station
1767 * Returns: 0 on success, -1 on failure
1769 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1773 * hapd_send_eapol - Send an EAPOL packet (AP only)
1774 * @priv: private driver interface data
1775 * @addr: Destination MAC address
1776 * @data: EAPOL packet starting with IEEE 802.1X header
1777 * @data_len: Length of the EAPOL packet in octets
1778 * @encrypt: Whether the frame should be encrypted
1779 * @own_addr: Source MAC address
1780 * @flags: WPA_STA_* flags for the destination station
1782 * Returns: 0 on success, -1 on failure
1784 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1785 size_t data_len, int encrypt,
1786 const u8 *own_addr, u32 flags);
1789 * sta_deauth - Deauthenticate a station (AP only)
1790 * @priv: Private driver interface data
1791 * @own_addr: Source address and BSSID for the Deauthentication frame
1792 * @addr: MAC address of the station to deauthenticate
1793 * @reason: Reason code for the Deauthentiation frame
1794 * Returns: 0 on success, -1 on failure
1796 * This function requests a specific station to be deauthenticated and
1797 * a Deauthentication frame to be sent to it.
1799 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1803 * sta_disassoc - Disassociate a station (AP only)
1804 * @priv: Private driver interface data
1805 * @own_addr: Source address and BSSID for the Disassociation frame
1806 * @addr: MAC address of the station to disassociate
1807 * @reason: Reason code for the Disassociation frame
1808 * Returns: 0 on success, -1 on failure
1810 * This function requests a specific station to be disassociated and
1811 * a Disassociation frame to be sent to it.
1813 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1817 * sta_remove - Remove a station entry (AP only)
1818 * @priv: Private driver interface data
1819 * @addr: MAC address of the station to be removed
1820 * Returns: 0 on success, -1 on failure
1822 int (*sta_remove)(void *priv, const u8 *addr);
1825 * hapd_get_ssid - Get the current SSID (AP only)
1826 * @priv: Private driver interface data
1827 * @buf: Buffer for returning the SSID
1828 * @len: Maximum length of the buffer
1829 * Returns: Length of the SSID on success, -1 on failure
1831 * This function need not be implemented if the driver uses Beacon
1832 * template from set_ap() and does not reply to Probe Request frames.
1834 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1837 * hapd_set_ssid - Set SSID (AP only)
1838 * @priv: Private driver interface data
1840 * @len: Length of the SSID in octets
1841 * Returns: 0 on success, -1 on failure
1843 * DEPRECATED - use set_ap() instead
1845 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1848 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1849 * @priv: Private driver interface data
1850 * @enabled: 1 = countermeasures enabled, 0 = disabled
1851 * Returns: 0 on success, -1 on failure
1853 * This need not be implemented if the driver does not take care of
1854 * association processing.
1856 int (*hapd_set_countermeasures)(void *priv, int enabled);
1859 * sta_add - Add a station entry
1860 * @priv: Private driver interface data
1861 * @params: Station parameters
1862 * Returns: 0 on success, -1 on failure
1864 * This function is used to add a station entry to the driver once the
1865 * station has completed association. This is only used if the driver
1866 * does not take care of association processing.
1868 * With TDLS, this function is also used to add or set (params->set 1)
1869 * TDLS peer entries.
1871 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1874 * get_inact_sec - Get station inactivity duration (AP only)
1875 * @priv: Private driver interface data
1876 * @addr: Station address
1877 * Returns: Number of seconds station has been inactive, -1 on failure
1879 int (*get_inact_sec)(void *priv, const u8 *addr);
1882 * sta_clear_stats - Clear station statistics (AP only)
1883 * @priv: Private driver interface data
1884 * @addr: Station address
1885 * Returns: 0 on success, -1 on failure
1887 int (*sta_clear_stats)(void *priv, const u8 *addr);
1890 * set_freq - Set channel/frequency (AP only)
1891 * @priv: Private driver interface data
1892 * @freq: Channel parameters
1893 * Returns: 0 on success, -1 on failure
1895 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1898 * set_rts - Set RTS threshold
1899 * @priv: Private driver interface data
1900 * @rts: RTS threshold in octets
1901 * Returns: 0 on success, -1 on failure
1903 int (*set_rts)(void *priv, int rts);
1906 * set_frag - Set fragmentation threshold
1907 * @priv: Private driver interface data
1908 * @frag: Fragmentation threshold in octets
1909 * Returns: 0 on success, -1 on failure
1911 int (*set_frag)(void *priv, int frag);
1914 * sta_set_flags - Set station flags (AP only)
1915 * @priv: Private driver interface data
1916 * @addr: Station address
1917 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1918 * @flags_or: Bitmap of WPA_STA_* flags to add
1919 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1920 * Returns: 0 on success, -1 on failure
1922 int (*sta_set_flags)(void *priv, const u8 *addr,
1923 int total_flags, int flags_or, int flags_and);
1926 * set_tx_queue_params - Set TX queue parameters
1927 * @priv: Private driver interface data
1928 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1932 * @burst_time: Maximum length for bursting in 0.1 msec units
1934 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1935 int cw_max, int burst_time);
1938 * if_add - Add a virtual interface
1939 * @priv: Private driver interface data
1940 * @type: Interface type
1941 * @ifname: Interface name for the new virtual interface
1942 * @addr: Local address to use for the interface or %NULL to use the
1943 * parent interface address
1944 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1945 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1946 * not allowed (applies only to %WPA_IF_AP_BSS type)
1947 * @force_ifname: Buffer for returning an interface name that the
1948 * driver ended up using if it differs from the requested ifname
1949 * @if_addr: Buffer for returning the allocated interface address
1950 * (this may differ from the requested addr if the driver cannot
1951 * change interface address)
1952 * @bridge: Bridge interface to use or %NULL if no bridge configured
1953 * Returns: 0 on success, -1 on failure
1955 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1956 const char *ifname, const u8 *addr, void *bss_ctx,
1957 void **drv_priv, char *force_ifname, u8 *if_addr,
1958 const char *bridge);
1961 * if_remove - Remove a virtual interface
1962 * @priv: Private driver interface data
1963 * @type: Interface type
1964 * @ifname: Interface name of the virtual interface to be removed
1965 * Returns: 0 on success, -1 on failure
1967 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1968 const char *ifname);
1971 * set_sta_vlan - Bind a station into a specific interface (AP only)
1972 * @priv: Private driver interface data
1973 * @ifname: Interface (main or virtual BSS or VLAN)
1974 * @addr: MAC address of the associated station
1976 * Returns: 0 on success, -1 on failure
1978 * This function is used to bind a station to a specific virtual
1979 * interface. It is only used if when virtual interfaces are supported,
1980 * e.g., to assign stations to different VLAN interfaces based on
1981 * information from a RADIUS server. This allows separate broadcast
1982 * domains to be used with a single BSS.
1984 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1988 * commit - Optional commit changes handler (AP only)
1989 * @priv: driver private data
1990 * Returns: 0 on success, -1 on failure
1992 * This optional handler function can be registered if the driver
1993 * interface implementation needs to commit changes (e.g., by setting
1994 * network interface up) at the end of initial configuration. If set,
1995 * this handler will be called after initial setup has been completed.
1997 int (*commit)(void *priv);
2000 * send_ether - Send an ethernet packet (AP only)
2001 * @priv: private driver interface data
2002 * @dst: Destination MAC address
2003 * @src: Source MAC address
2005 * @data: EAPOL packet starting with IEEE 802.1X header
2006 * @data_len: Length of the EAPOL packet in octets
2007 * Returns: 0 on success, -1 on failure
2009 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2010 const u8 *data, size_t data_len);
2013 * set_radius_acl_auth - Notification of RADIUS ACL change
2014 * @priv: Private driver interface data
2015 * @mac: MAC address of the station
2016 * @accepted: Whether the station was accepted
2017 * @session_timeout: Session timeout for the station
2018 * Returns: 0 on success, -1 on failure
2020 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2021 u32 session_timeout);
2024 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2025 * @priv: Private driver interface data
2026 * @mac: MAC address of the station
2027 * Returns: 0 on success, -1 on failure
2029 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2032 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2033 * @priv: Private driver interface data
2034 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2035 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2037 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2038 * to remove extra IE(s)
2039 * Returns: 0 on success, -1 on failure
2041 * This is an optional function to add WPS IE in the kernel driver for
2042 * Beacon and Probe Response frames. This can be left undefined (set
2043 * to %NULL) if the driver uses the Beacon template from set_ap()
2044 * and does not process Probe Request frames. If the driver takes care
2045 * of (Re)Association frame processing, the assocresp buffer includes
2046 * WPS IE(s) that need to be added to (Re)Association Response frames
2047 * whenever a (Re)Association Request frame indicated use of WPS.
2049 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2050 * frames when operating as a GO. The driver is responsible for adding
2051 * timing related attributes (e.g., NoA) in addition to the IEs
2052 * included here by appending them after these buffers. This call is
2053 * also used to provide Probe Response IEs for P2P Listen state
2054 * operations for drivers that generate the Probe Response frames
2057 * DEPRECATED - use set_ap() instead
2059 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2060 const struct wpabuf *proberesp,
2061 const struct wpabuf *assocresp);
2064 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2065 * @priv: Private driver interface data
2066 * @authorized: Whether the port is authorized
2067 * Returns: 0 on success, -1 on failure
2069 int (*set_supp_port)(void *priv, int authorized);
2072 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2073 * @priv: Private driver interface data
2074 * @addr: MAC address of the associated station
2075 * @aid: Association ID
2076 * @val: 1 = bind to 4-address WDS; 0 = unbind
2077 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2078 * to indicate that bridge is not to be used
2079 * @ifname_wds: Buffer to return the interface name for the new WDS
2080 * station or %NULL to indicate name is not returned.
2081 * Returns: 0 on success, -1 on failure
2083 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2084 const char *bridge_ifname, char *ifname_wds);
2087 * send_action - Transmit an Action frame
2088 * @priv: Private driver interface data
2089 * @freq: Frequency (in MHz) of the channel
2090 * @wait: Time to wait off-channel for a response (in ms), or zero
2091 * @dst: Destination MAC address (Address 1)
2092 * @src: Source MAC address (Address 2)
2093 * @bssid: BSSID (Address 3)
2095 * @data_len: data length in octets
2096 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2097 * Returns: 0 on success, -1 on failure
2099 * This command can be used to request the driver to transmit an action
2100 * frame to the specified destination.
2102 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2103 * be transmitted on the given channel and the device will wait for a
2104 * response on that channel for the given wait time.
2106 * If the flag is not set, the wait time will be ignored. In this case,
2107 * if a remain-on-channel duration is in progress, the frame must be
2108 * transmitted on that channel; alternatively the frame may be sent on
2109 * the current operational channel (if in associated state in station
2110 * mode or while operating as an AP.)
2112 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2113 const u8 *dst, const u8 *src, const u8 *bssid,
2114 const u8 *data, size_t data_len, int no_cck);
2117 * send_action_cancel_wait - Cancel action frame TX wait
2118 * @priv: Private driver interface data
2120 * This command cancels the wait time associated with sending an action
2121 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2122 * set in the driver flags.
2124 void (*send_action_cancel_wait)(void *priv);
2127 * remain_on_channel - Remain awake on a channel
2128 * @priv: Private driver interface data
2129 * @freq: Frequency (in MHz) of the channel
2130 * @duration: Duration in milliseconds
2131 * Returns: 0 on success, -1 on failure
2133 * This command is used to request the driver to remain awake on the
2134 * specified channel for the specified duration and report received
2135 * Action frames with EVENT_RX_ACTION events. Optionally, received
2136 * Probe Request frames may also be requested to be reported by calling
2137 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2139 * The driver may not be at the requested channel when this function
2140 * returns, i.e., the return code is only indicating whether the
2141 * request was accepted. The caller will need to wait until the
2142 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2143 * completed the channel change. This may take some time due to other
2144 * need for the radio and the caller should be prepared to timing out
2145 * its wait since there are no guarantees on when this request can be
2148 int (*remain_on_channel)(void *priv, unsigned int freq,
2149 unsigned int duration);
2152 * cancel_remain_on_channel - Cancel remain-on-channel operation
2153 * @priv: Private driver interface data
2155 * This command can be used to cancel a remain-on-channel operation
2156 * before its originally requested duration has passed. This could be
2157 * used, e.g., when remain_on_channel() is used to request extra time
2158 * to receive a response to an Action frame and the response is
2159 * received when there is still unneeded time remaining on the
2160 * remain-on-channel operation.
2162 int (*cancel_remain_on_channel)(void *priv);
2165 * probe_req_report - Request Probe Request frames to be indicated
2166 * @priv: Private driver interface data
2167 * @report: Whether to report received Probe Request frames
2168 * Returns: 0 on success, -1 on failure (or if not supported)
2170 * This command can be used to request the driver to indicate when
2171 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2172 * Since this operation may require extra resources, e.g., due to less
2173 * optimal hardware/firmware RX filtering, many drivers may disable
2174 * Probe Request reporting at least in station mode. This command is
2175 * used to notify the driver when the Probe Request frames need to be
2176 * reported, e.g., during remain-on-channel operations.
2178 int (*probe_req_report)(void *priv, int report);
2181 * deinit_ap - Deinitialize AP mode
2182 * @priv: Private driver interface data
2183 * Returns: 0 on success, -1 on failure (or if not supported)
2185 * This optional function can be used to disable AP mode related
2186 * configuration. If the interface was not dynamically added,
2187 * change the driver mode to station mode to allow normal station
2188 * operations like scanning to be completed.
2190 int (*deinit_ap)(void *priv);
2193 * deinit_p2p_cli - Deinitialize P2P client mode
2194 * @priv: Private driver interface data
2195 * Returns: 0 on success, -1 on failure (or if not supported)
2197 * This optional function can be used to disable P2P client mode. If the
2198 * interface was not dynamically added, change the interface type back
2201 int (*deinit_p2p_cli)(void *priv);
2204 * suspend - Notification on system suspend/hibernate event
2205 * @priv: Private driver interface data
2207 void (*suspend)(void *priv);
2210 * resume - Notification on system resume/thaw event
2211 * @priv: Private driver interface data
2213 void (*resume)(void *priv);
2216 * signal_monitor - Set signal monitoring parameters
2217 * @priv: Private driver interface data
2218 * @threshold: Threshold value for signal change events; 0 = disabled
2219 * @hysteresis: Minimum change in signal strength before indicating a
2221 * Returns: 0 on success, -1 on failure (or if not supported)
2223 * This function can be used to configure monitoring of signal strength
2224 * with the current AP. Whenever signal strength drops below the
2225 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2226 * should be generated assuming the signal strength has changed at
2227 * least %hysteresis from the previously indicated signal change event.
2229 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2232 * send_frame - Send IEEE 802.11 frame (testing use only)
2233 * @priv: Private driver interface data
2234 * @data: IEEE 802.11 frame with IEEE 802.11 header
2235 * @data_len: Size of the frame
2236 * @encrypt: Whether to encrypt the frame (if keys are set)
2237 * Returns: 0 on success, -1 on failure
2239 * This function is only used for debugging purposes and is not
2240 * required to be implemented for normal operations.
2242 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2246 * shared_freq - Get operating frequency of shared interface(s)
2247 * @priv: Private driver interface data
2248 * Returns: Operating frequency in MHz, 0 if no shared operation in
2249 * use, or -1 on failure
2251 * This command can be used to request the current operating frequency
2252 * of any virtual interface that shares the same radio to provide
2253 * information for channel selection for other virtual interfaces.
2255 int (*shared_freq)(void *priv);
2258 * get_noa - Get current Notice of Absence attribute payload
2259 * @priv: Private driver interface data
2260 * @buf: Buffer for returning NoA
2261 * @buf_len: Buffer length in octets
2262 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2263 * advertized, or -1 on failure
2265 * This function is used to fetch the current Notice of Absence
2266 * attribute value from GO.
2268 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2271 * set_noa - Set Notice of Absence parameters for GO (testing)
2272 * @priv: Private driver interface data
2274 * @start: Start time in ms from next TBTT
2275 * @duration: Duration in ms
2276 * Returns: 0 on success or -1 on failure
2278 * This function is used to set Notice of Absence parameters for GO. It
2279 * is used only for testing. To disable NoA, all parameters are set to
2282 int (*set_noa)(void *priv, u8 count, int start, int duration);
2285 * set_p2p_powersave - Set P2P power save options
2286 * @priv: Private driver interface data
2287 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2288 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2289 * @ctwindow: 0.. = change (msec), -1 = no change
2290 * Returns: 0 on success or -1 on failure
2292 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2296 * ampdu - Enable/disable aggregation
2297 * @priv: Private driver interface data
2298 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2299 * Returns: 0 on success or -1 on failure
2301 int (*ampdu)(void *priv, int ampdu);
2304 * get_radio_name - Get physical radio name for the device
2305 * @priv: Private driver interface data
2306 * Returns: Radio name or %NULL if not known
2308 * The returned data must not be modified by the caller. It is assumed
2309 * that any interface that has the same radio name as another is
2310 * sharing the same physical radio. This information can be used to
2311 * share scan results etc. information between the virtual interfaces
2312 * to speed up various operations.
2314 const char * (*get_radio_name)(void *priv);
2317 * p2p_find - Start P2P Device Discovery
2318 * @priv: Private driver interface data
2319 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2320 * @type: Device Discovery type (enum p2p_discovery_type)
2321 * Returns: 0 on success, -1 on failure
2323 * This function is only used if the driver implements P2P management,
2324 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2325 * struct wpa_driver_capa.
2327 int (*p2p_find)(void *priv, unsigned int timeout, int type);
2330 * p2p_stop_find - Stop P2P Device Discovery
2331 * @priv: Private driver interface data
2332 * Returns: 0 on success, -1 on failure
2334 * This function is only used if the driver implements P2P management,
2335 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2336 * struct wpa_driver_capa.
2338 int (*p2p_stop_find)(void *priv);
2341 * p2p_listen - Start P2P Listen state for specified duration
2342 * @priv: Private driver interface data
2343 * @timeout: Listen state duration in milliseconds
2344 * Returns: 0 on success, -1 on failure
2346 * This function can be used to request the P2P module to keep the
2347 * device discoverable on the listen channel for an extended set of
2348 * time. At least in its current form, this is mainly used for testing
2349 * purposes and may not be of much use for normal P2P operations.
2351 * This function is only used if the driver implements P2P management,
2352 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2353 * struct wpa_driver_capa.
2355 int (*p2p_listen)(void *priv, unsigned int timeout);
2358 * p2p_connect - Start P2P group formation (GO negotiation)
2359 * @priv: Private driver interface data
2360 * @peer_addr: MAC address of the peer P2P client
2361 * @wps_method: enum p2p_wps_method value indicating config method
2362 * @go_intent: Local GO intent value (1..15)
2363 * @own_interface_addr: Intended interface address to use with the
2365 * @force_freq: The only allowed channel frequency in MHz or 0
2366 * @persistent_group: Whether to create persistent group
2367 * Returns: 0 on success, -1 on failure
2369 * This function is only used if the driver implements P2P management,
2370 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2371 * struct wpa_driver_capa.
2373 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method,
2374 int go_intent, const u8 *own_interface_addr,
2375 unsigned int force_freq, int persistent_group);
2378 * wps_success_cb - Report successfully completed WPS provisioning
2379 * @priv: Private driver interface data
2380 * @peer_addr: Peer address
2381 * Returns: 0 on success, -1 on failure
2383 * This function is used to report successfully completed WPS
2384 * provisioning during group formation in both GO/Registrar and
2385 * client/Enrollee roles.
2387 * This function is only used if the driver implements P2P management,
2388 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2389 * struct wpa_driver_capa.
2391 int (*wps_success_cb)(void *priv, const u8 *peer_addr);
2394 * p2p_group_formation_failed - Report failed WPS provisioning
2395 * @priv: Private driver interface data
2396 * Returns: 0 on success, -1 on failure
2398 * This function is used to report failed group formation. This can
2399 * happen either due to failed WPS provisioning or due to 15 second
2400 * timeout during the provisioning phase.
2402 * This function is only used if the driver implements P2P management,
2403 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2404 * struct wpa_driver_capa.
2406 int (*p2p_group_formation_failed)(void *priv);
2409 * p2p_set_params - Set P2P parameters
2410 * @priv: Private driver interface data
2411 * @params: P2P parameters
2412 * Returns: 0 on success, -1 on failure
2414 * This function is only used if the driver implements P2P management,
2415 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2416 * struct wpa_driver_capa.
2418 int (*p2p_set_params)(void *priv, const struct p2p_params *params);
2421 * p2p_prov_disc_req - Send Provision Discovery Request
2422 * @priv: Private driver interface data
2423 * @peer_addr: MAC address of the peer P2P client
2424 * @config_methods: WPS Config Methods value (only one bit set)
2425 * Returns: 0 on success, -1 on failure
2427 * This function can be used to request a discovered P2P peer to
2428 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2429 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2430 * Provision Discovery Request frame is transmitted once immediately
2431 * and if no response is received, the frame will be sent again
2432 * whenever the target device is discovered during device dsicovery
2433 * (start with a p2p_find() call). Response from the peer is indicated
2434 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2436 * This function is only used if the driver implements P2P management,
2437 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2438 * struct wpa_driver_capa.
2440 int (*p2p_prov_disc_req)(void *priv, const u8 *peer_addr,
2441 u16 config_methods, int join);
2444 * p2p_sd_request - Schedule a service discovery query
2445 * @priv: Private driver interface data
2446 * @dst: Destination peer or %NULL to apply for all peers
2447 * @tlvs: P2P Service Query TLV(s)
2448 * Returns: Reference to the query or 0 on failure
2450 * Response to the query is indicated with the
2451 * EVENT_P2P_SD_RESPONSE driver event.
2453 * This function is only used if the driver implements P2P management,
2454 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2455 * struct wpa_driver_capa.
2457 u64 (*p2p_sd_request)(void *priv, const u8 *dst,
2458 const struct wpabuf *tlvs);
2461 * p2p_sd_cancel_request - Cancel a pending service discovery query
2462 * @priv: Private driver interface data
2463 * @req: Query reference from p2p_sd_request()
2464 * Returns: 0 on success, -1 on failure
2466 * This function is only used if the driver implements P2P management,
2467 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2468 * struct wpa_driver_capa.
2470 int (*p2p_sd_cancel_request)(void *priv, u64 req);
2473 * p2p_sd_response - Send response to a service discovery query
2474 * @priv: Private driver interface data
2475 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2476 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2477 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2478 * @resp_tlvs: P2P Service Response TLV(s)
2479 * Returns: 0 on success, -1 on failure
2481 * This function is called as a response to the request indicated with
2482 * the EVENT_P2P_SD_REQUEST driver event.
2484 * This function is only used if the driver implements P2P management,
2485 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2486 * struct wpa_driver_capa.
2488 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst,
2490 const struct wpabuf *resp_tlvs);
2493 * p2p_service_update - Indicate a change in local services
2494 * @priv: Private driver interface data
2495 * Returns: 0 on success, -1 on failure
2497 * This function needs to be called whenever there is a change in
2498 * availability of the local services. This will increment the
2499 * Service Update Indicator value which will be used in SD Request and
2502 * This function is only used if the driver implements P2P management,
2503 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2504 * struct wpa_driver_capa.
2506 int (*p2p_service_update)(void *priv);
2509 * p2p_reject - Reject peer device (explicitly block connections)
2510 * @priv: Private driver interface data
2511 * @addr: MAC address of the peer
2512 * Returns: 0 on success, -1 on failure
2514 int (*p2p_reject)(void *priv, const u8 *addr);
2517 * p2p_invite - Invite a P2P Device into a group
2518 * @priv: Private driver interface data
2519 * @peer: Device Address of the peer P2P Device
2520 * @role: Local role in the group
2521 * @bssid: Group BSSID or %NULL if not known
2523 * @ssid_len: Length of ssid in octets
2524 * @go_dev_addr: Forced GO Device Address or %NULL if none
2525 * @persistent_group: Whether this is to reinvoke a persistent group
2526 * Returns: 0 on success, -1 on failure
2528 int (*p2p_invite)(void *priv, const u8 *peer, int role,
2529 const u8 *bssid, const u8 *ssid, size_t ssid_len,
2530 const u8 *go_dev_addr, int persistent_group);
2533 * send_tdls_mgmt - for sending TDLS management packets
2534 * @priv: private driver interface data
2535 * @dst: Destination (peer) MAC address
2536 * @action_code: TDLS action code for the mssage
2537 * @dialog_token: Dialog Token to use in the message (if needed)
2538 * @status_code: Status Code or Reason Code to use (if needed)
2539 * @buf: TDLS IEs to add to the message
2540 * @len: Length of buf in octets
2541 * Returns: 0 on success, negative (<0) on failure
2543 * This optional function can be used to send packet to driver which is
2544 * responsible for receiving and sending all TDLS packets.
2546 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2547 u8 dialog_token, u16 status_code,
2548 const u8 *buf, size_t len);
2551 * tdls_oper - Ask the driver to perform high-level TDLS operations
2552 * @priv: Private driver interface data
2553 * @oper: TDLS high-level operation. See %enum tdls_oper
2554 * @peer: Destination (peer) MAC address
2555 * Returns: 0 on success, negative (<0) on failure
2557 * This optional function can be used to send high-level TDLS commands
2560 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2563 * wnm_oper - Notify driver of the WNM frame reception
2564 * @priv: Private driver interface data
2565 * @oper: WNM operation. See %enum wnm_oper
2566 * @peer: Destination (peer) MAC address
2567 * @buf: Buffer for the driver to fill in (for getting IE)
2568 * @buf_len: Return the len of buf
2569 * Returns: 0 on success, negative (<0) on failure
2571 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2572 u8 *buf, u16 *buf_len);
2575 * signal_poll - Get current connection information
2576 * @priv: Private driver interface data
2577 * @signal_info: Connection info structure
2579 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2582 * set_authmode - Set authentication algorithm(s) for static WEP
2583 * @priv: Private driver interface data
2584 * @authmode: 1=Open System, 2=Shared Key, 3=both
2585 * Returns: 0 on success, -1 on failure
2587 * This function can be used to set authentication algorithms for AP
2588 * mode when static WEP is used. If the driver uses user space MLME/SME
2589 * implementation, there is no need to implement this function.
2591 * DEPRECATED - use set_ap() instead
2593 int (*set_authmode)(void *priv, int authmode);
2596 * set_rekey_info - Set rekey information
2597 * @priv: Private driver interface data
2600 * @replay_ctr: Current EAPOL-Key Replay Counter
2602 * This optional function can be used to provide information for the
2603 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2604 * while the host (including wpa_supplicant) is sleeping.
2606 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2607 const u8 *replay_ctr);
2610 * sta_assoc - Station association indication
2611 * @priv: Private driver interface data
2612 * @own_addr: Source address and BSSID for association frame
2613 * @addr: MAC address of the station to associate
2614 * @reassoc: flag to indicate re-association
2615 * @status: association response status code
2616 * @ie: assoc response ie buffer
2617 * @len: ie buffer length
2618 * Returns: 0 on success, -1 on failure
2620 * This function indicates the driver to send (Re)Association
2621 * Response frame to the station.
2623 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2624 int reassoc, u16 status, const u8 *ie, size_t len);
2627 * sta_auth - Station authentication indication
2628 * @priv: Private driver interface data
2629 * @own_addr: Source address and BSSID for authentication frame
2630 * @addr: MAC address of the station to associate
2631 * @seq: authentication sequence number
2632 * @status: authentication response status code
2633 * @ie: authentication frame ie buffer
2634 * @len: ie buffer length
2636 * This function indicates the driver to send Authentication frame
2639 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2640 u16 seq, u16 status, const u8 *ie, size_t len);
2643 * add_tspec - Add traffic stream
2644 * @priv: Private driver interface data
2645 * @addr: MAC address of the station to associate
2646 * @tspec_ie: tspec ie buffer
2647 * @tspec_ielen: tspec ie length
2648 * Returns: 0 on success, -1 on failure
2650 * This function adds the traffic steam for the station
2651 * and fills the medium_time in tspec_ie.
2653 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2654 size_t tspec_ielen);
2657 * add_sta_node - Add a station node in the driver
2658 * @priv: Private driver interface data
2659 * @addr: MAC address of the station to add
2660 * @auth_alg: authentication algorithm used by the station
2661 * Returns: 0 on success, -1 on failure
2663 * This function adds the station node in the driver, when
2664 * the station gets added by FT-over-DS.
2666 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2669 * sched_scan - Request the driver to initiate scheduled scan
2670 * @priv: Private driver interface data
2671 * @params: Scan parameters
2672 * @interval: Interval between scan cycles in milliseconds
2673 * Returns: 0 on success, -1 on failure
2675 * This operation should be used for scheduled scan offload to
2676 * the hardware. Every time scan results are available, the
2677 * driver should report scan results event for wpa_supplicant
2678 * which will eventually request the results with
2679 * wpa_driver_get_scan_results2(). This operation is optional
2680 * and if not provided or if it returns -1, we fall back to
2681 * normal host-scheduled scans.
2683 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2687 * stop_sched_scan - Request the driver to stop a scheduled scan
2688 * @priv: Private driver interface data
2689 * Returns: 0 on success, -1 on failure
2691 * This should cause the scheduled scan to be stopped and
2692 * results should stop being sent. Must be supported if
2693 * sched_scan is supported.
2695 int (*stop_sched_scan)(void *priv);
2698 * poll_client - Probe (null data or such) the given station
2699 * @priv: Private driver interface data
2700 * @own_addr: MAC address of sending interface
2701 * @addr: MAC address of the station to probe
2702 * @qos: Indicates whether station is QoS station
2704 * This function is used to verify whether an associated station is
2705 * still present. This function does not need to be implemented if the
2706 * driver provides such inactivity polling mechanism.
2708 void (*poll_client)(void *priv, const u8 *own_addr,
2709 const u8 *addr, int qos);
2712 * radio_disable - Disable/enable radio
2713 * @priv: Private driver interface data
2714 * @disabled: 1=disable 0=enable radio
2715 * Returns: 0 on success, -1 on failure
2717 * This optional command is for testing purposes. It can be used to
2718 * disable the radio on a testbed device to simulate out-of-radio-range
2721 int (*radio_disable)(void *priv, int disabled);
2724 * switch_channel - Announce channel switch and migrate the GO to the
2726 * @priv: Private driver interface data
2727 * @freq: Frequency in MHz
2728 * Returns: 0 on success, -1 on failure
2730 * This function is used to move the GO to the legacy STA channel to
2731 * avoid frequency conflict in single channel concurrency.
2733 int (*switch_channel)(void *priv, unsigned int freq);
2736 * start_dfs_cac - Listen for radar interference on the channel
2737 * @priv: Private driver interface data
2738 * @freq: Channel parameters
2739 * Returns: 0 on success, -1 on failure
2741 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
2744 * stop_ap - Removes beacon from AP
2745 * @priv: Private driver interface data
2746 * Returns: 0 on success, -1 on failure (or if not supported)
2748 * This optional function can be used to disable AP mode related
2749 * configuration. Unlike deinit_ap, it does not change to station
2752 int (*stop_ap)(void *priv);
2755 * get_survey - Retrieve survey data
2756 * @priv: Private driver interface data
2757 * @freq: If set, survey data for the specified frequency is only
2758 * being requested. If not set, all survey data is requested.
2759 * Returns: 0 on success, -1 on failure
2761 * Use this to retrieve:
2763 * - the observed channel noise floor
2764 * - the amount of time we have spent on the channel
2765 * - the amount of time during which we have spent on the channel that
2766 * the radio has determined the medium is busy and we cannot
2768 * - the amount of time we have spent receiving data
2769 * - the amount of time we have spent transmitting data
2771 * This data can be used for spectrum heuristics. One example is
2772 * Automatic Channel Selection (ACS). The channel survey data is
2773 * kept on a linked list on the channel data, one entry is added
2774 * for each survey. The min_nf of the channel is updated for each
2777 int (*get_survey)(void *priv, unsigned int freq);
2780 * status - Get driver interface status information
2781 * @priv: Private driver interface data
2782 * @buf: Buffer for printing tou the status information
2783 * @buflen: Maximum length of the buffer
2784 * Returns: Length of written status information or -1 on failure
2786 int (*status)(void *priv, char *buf, size_t buflen);
2791 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2793 enum wpa_event_type {
2795 * EVENT_ASSOC - Association completed
2797 * This event needs to be delivered when the driver completes IEEE
2798 * 802.11 association or reassociation successfully.
2799 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2800 * after this event has been generated. In addition, optional
2801 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2802 * more information about the association. If the driver interface gets
2803 * both of these events at the same time, it can also include the
2804 * assoc_info data in EVENT_ASSOC call.
2809 * EVENT_DISASSOC - Association lost
2811 * This event should be called when association is lost either due to
2812 * receiving deauthenticate or disassociate frame from the AP or when
2813 * sending either of these frames to the current AP. If the driver
2814 * supports separate deauthentication event, EVENT_DISASSOC should only
2815 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2816 * In AP mode, union wpa_event_data::disassoc_info is required.
2821 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2823 * This event must be delivered when a Michael MIC error is detected by
2824 * the local driver. Additional data for event processing is
2825 * provided with union wpa_event_data::michael_mic_failure. This
2826 * information is used to request new encyption key and to initiate
2827 * TKIP countermeasures if needed.
2829 EVENT_MICHAEL_MIC_FAILURE,
2832 * EVENT_SCAN_RESULTS - Scan results available
2834 * This event must be called whenever scan results are available to be
2835 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2836 * is expected to be used some time after struct wpa_driver_ops::scan()
2837 * is called. If the driver provides an unsolicited event when the scan
2838 * has been completed, this event can be used to trigger
2839 * EVENT_SCAN_RESULTS call. If such event is not available from the
2840 * driver, the driver wrapper code is expected to use a registered
2841 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2842 * scan is expected to be completed. Optional information about
2843 * completed scan can be provided with union wpa_event_data::scan_info.
2848 * EVENT_ASSOCINFO - Report optional extra information for association
2850 * This event can be used to report extra association information for
2851 * EVENT_ASSOC processing. This extra information includes IEs from
2852 * association frames and Beacon/Probe Response frames in union
2853 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2854 * EVENT_ASSOC. Alternatively, the driver interface can include
2855 * assoc_info data in the EVENT_ASSOC call if it has all the
2856 * information available at the same point.
2861 * EVENT_INTERFACE_STATUS - Report interface status changes
2863 * This optional event can be used to report changes in interface
2864 * status (interface added/removed) using union
2865 * wpa_event_data::interface_status. This can be used to trigger
2866 * wpa_supplicant to stop and re-start processing for the interface,
2867 * e.g., when a cardbus card is ejected/inserted.
2869 EVENT_INTERFACE_STATUS,
2872 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2874 * This event can be used to inform wpa_supplicant about candidates for
2875 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2876 * for scan request (ap_scan=2 mode), this event is required for
2877 * pre-authentication. If wpa_supplicant is performing scan request
2878 * (ap_scan=1), this event is optional since scan results can be used
2879 * to add pre-authentication candidates. union
2880 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2881 * candidate and priority of the candidate, e.g., based on the signal
2882 * strength, in order to try to pre-authenticate first with candidates
2883 * that are most likely targets for re-association.
2885 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2886 * on the candidate list. In addition, it can be called for the current
2887 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2888 * will automatically skip pre-authentication in cases where a valid
2889 * PMKSA exists. When more than one candidate exists, this event should
2890 * be generated once for each candidate.
2892 * Driver will be notified about successful pre-authentication with
2893 * struct wpa_driver_ops::add_pmkid() calls.
2895 EVENT_PMKID_CANDIDATE,
2898 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2900 * This event can be used to inform wpa_supplicant about desire to set
2901 * up secure direct link connection between two stations as defined in
2902 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2903 * STAKey negotiation. The caller will need to set peer address for the
2909 * EVENT_TDLS - Request TDLS operation
2911 * This event can be used to request a TDLS operation to be performed.
2916 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2918 * The driver is expected to report the received FT IEs from
2919 * FT authentication sequence from the AP. The FT IEs are included in
2920 * the extra information in union wpa_event_data::ft_ies.
2925 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2927 * The driver can use this event to inform wpa_supplicant about a STA
2928 * in an IBSS with which protected frames could be exchanged. This
2929 * event starts RSN authentication with the other STA to authenticate
2930 * the STA and set up encryption keys with it.
2932 EVENT_IBSS_RSN_START,
2935 * EVENT_AUTH - Authentication result
2937 * This event should be called when authentication attempt has been
2938 * completed. This is only used if the driver supports separate
2939 * authentication step (struct wpa_driver_ops::authenticate).
2940 * Information about authentication result is included in
2941 * union wpa_event_data::auth.
2946 * EVENT_DEAUTH - Authentication lost
2948 * This event should be called when authentication is lost either due
2949 * to receiving deauthenticate frame from the AP or when sending that
2950 * frame to the current AP.
2951 * In AP mode, union wpa_event_data::deauth_info is required.
2956 * EVENT_ASSOC_REJECT - Association rejected
2958 * This event should be called when (re)association attempt has been
2959 * rejected by the AP. Information about the association response is
2960 * included in union wpa_event_data::assoc_reject.
2965 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2967 EVENT_AUTH_TIMED_OUT,
2970 * EVENT_ASSOC_TIMED_OUT - Association timed out
2972 EVENT_ASSOC_TIMED_OUT,
2975 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2980 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2982 EVENT_WPS_BUTTON_PUSHED,
2985 * EVENT_TX_STATUS - Report TX status
2990 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2992 EVENT_RX_FROM_UNKNOWN,
2995 * EVENT_RX_MGMT - Report RX of a management frame
3000 * EVENT_RX_ACTION - Action frame received
3002 * This event is used to indicate when an Action frame has been
3003 * received. Information about the received frame is included in
3004 * union wpa_event_data::rx_action.
3009 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3011 * This event is used to indicate when the driver has started the
3012 * requested remain-on-channel duration. Information about the
3013 * operation is included in union wpa_event_data::remain_on_channel.
3015 EVENT_REMAIN_ON_CHANNEL,
3018 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3020 * This event is used to indicate when the driver has completed
3021 * remain-on-channel duration, i.e., may noot be available on the
3022 * requested channel anymore. Information about the
3023 * operation is included in union wpa_event_data::remain_on_channel.
3025 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3028 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
3030 * This event is used only by driver_test.c and userspace MLME.
3035 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3037 * This event is used to indicate when a Probe Request frame has been
3038 * received. Information about the received frame is included in
3039 * union wpa_event_data::rx_probe_req. The driver is required to report
3040 * these events only after successfully completed probe_req_report()
3041 * commands to request the events (i.e., report parameter is non-zero)
3042 * in station mode. In AP mode, Probe Request frames should always be
3048 * EVENT_NEW_STA - New wired device noticed
3050 * This event is used to indicate that a new device has been detected
3051 * in a network that does not use association-like functionality (i.e.,
3052 * mainly wired Ethernet). This can be used to start EAPOL
3053 * authenticator when receiving a frame from a device. The address of
3054 * the device is included in union wpa_event_data::new_sta.
3059 * EVENT_EAPOL_RX - Report received EAPOL frame
3061 * When in AP mode with hostapd, this event is required to be used to
3062 * deliver the receive EAPOL frames from the driver. With
3063 * %wpa_supplicant, this event is used only if the send_eapol() handler
3064 * is used to override the use of l2_packet for EAPOL frame TX.
3069 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3071 * This event is used to indicate changes in the signal strength
3072 * observed in frames received from the current AP if signal strength
3073 * monitoring has been enabled with signal_monitor().
3075 EVENT_SIGNAL_CHANGE,
3078 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3080 * This event is used to indicate that the interface was enabled after
3081 * having been previously disabled, e.g., due to rfkill.
3083 EVENT_INTERFACE_ENABLED,
3086 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3088 * This event is used to indicate that the interface was disabled,
3089 * e.g., due to rfkill.
3091 EVENT_INTERFACE_DISABLED,
3094 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3096 * This event is used to indicate that the channel list has changed,
3097 * e.g., because of a regulatory domain change triggered by scan
3098 * results including an AP advertising a country code.
3100 EVENT_CHANNEL_LIST_CHANGED,
3103 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3105 * This event is used to indicate that the driver cannot maintain this
3106 * interface in its operation mode anymore. The most likely use for
3107 * this is to indicate that AP mode operation is not available due to
3108 * operating channel would need to be changed to a DFS channel when
3109 * the driver does not support radar detection and another virtual
3110 * interfaces caused the operating channel to change. Other similar
3111 * resource conflicts could also trigger this for station mode
3114 EVENT_INTERFACE_UNAVAILABLE,
3117 * EVENT_BEST_CHANNEL
3119 * Driver generates this event whenever it detects a better channel
3120 * (e.g., based on RSSI or channel use). This information can be used
3121 * to improve channel selection for a new AP/P2P group.
3126 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3128 * This event should be called when a Deauthentication frame is dropped
3129 * due to it not being protected (MFP/IEEE 802.11w).
3130 * union wpa_event_data::unprot_deauth is required to provide more
3131 * details of the frame.
3133 EVENT_UNPROT_DEAUTH,
3136 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3138 * This event should be called when a Disassociation frame is dropped
3139 * due to it not being protected (MFP/IEEE 802.11w).
3140 * union wpa_event_data::unprot_disassoc is required to provide more
3141 * details of the frame.
3143 EVENT_UNPROT_DISASSOC,
3146 * EVENT_STATION_LOW_ACK
3148 * Driver generates this event whenever it detected that a particular
3149 * station was lost. Detection can be through massive transmission
3150 * failures for example.
3152 EVENT_STATION_LOW_ACK,
3155 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
3157 * This event is used only if the driver implements P2P management
3158 * internally. Event data is stored in
3159 * union wpa_event_data::p2p_dev_found.
3161 EVENT_P2P_DEV_FOUND,
3164 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
3166 * This event is used only if the driver implements P2P management
3167 * internally. Event data is stored in
3168 * union wpa_event_data::p2p_go_neg_req_rx.
3170 EVENT_P2P_GO_NEG_REQ_RX,
3173 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
3175 * This event is used only if the driver implements P2P management
3176 * internally. Event data is stored in
3177 * union wpa_event_data::p2p_go_neg_completed.
3179 EVENT_P2P_GO_NEG_COMPLETED,
3181 EVENT_P2P_PROV_DISC_REQUEST,
3182 EVENT_P2P_PROV_DISC_RESPONSE,
3183 EVENT_P2P_SD_REQUEST,
3184 EVENT_P2P_SD_RESPONSE,
3187 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3189 EVENT_IBSS_PEER_LOST,
3192 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3194 * This event carries the new replay counter to notify wpa_supplicant
3195 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3196 * completed Group Key Handshake while the host (including
3197 * wpa_supplicant was sleeping).
3199 EVENT_DRIVER_GTK_REKEY,
3202 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3204 EVENT_SCHED_SCAN_STOPPED,
3207 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3209 * This event indicates that the station responded to the poll
3210 * initiated with @poll_client.
3212 EVENT_DRIVER_CLIENT_POLL_OK,
3215 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3217 EVENT_EAPOL_TX_STATUS,
3220 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3222 * Described in wpa_event_data.ch_switch
3227 * EVENT_WNM - Request WNM operation
3229 * This event can be used to request a WNM operation to be performed.
3234 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3236 * This event indicates that the driver reported a connection failure
3237 * with the specified client (for example, max client reached, etc.) in
3240 EVENT_CONNECT_FAILED_REASON,
3243 * EVENT_RADAR_DETECTED - Notify of radar detection
3245 * A radar has been detected on the supplied frequency, hostapd should
3246 * react accordingly (e.g., change channel).
3248 EVENT_DFS_RADAR_DETECTED,
3251 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3253 * After a successful CAC, the channel can be marked clear and used.
3255 EVENT_DFS_CAC_FINISHED,
3258 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3260 * The CAC was not successful, and the channel remains in the previous
3261 * state. This may happen due to a radar beeing detected or other
3262 * external influences.
3264 EVENT_DFS_CAC_ABORTED,
3267 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3269 * The channel which was previously unavailable is now available again.
3271 EVENT_DFS_NOP_FINISHED,
3274 * EVENT_SURVEY - Received survey data
3276 * This event gets triggered when a driver query is issued for survey
3277 * data and the requested data becomes available. The returned data is
3278 * stored in struct survey_results. The results provide at most one
3279 * survey entry for each frequency and at minimum will provide one survey
3280 * entry for one frequency. The survey data can be os_malloc()'d and
3281 * then os_free()'d, so the event callback must only copy data.
3288 * struct freq_survey - Channel survey info
3290 * @ifidx: Interface index in which this survey was observed
3291 * @freq: Center of frequency of the surveyed channel
3292 * @nf: Channel noise floor in dBm
3293 * @channel_time: Amount of time in ms the radio spent on the channel
3294 * @channel_time_busy: Amount of time in ms the radio detected some signal
3295 * that indicated to the radio the channel was not clear
3296 * @channel_time_rx: Amount of time the radio spent receiving data
3297 * @channel_time_tx: Amount of time the radio spent transmitting data
3298 * @filled: bitmask indicating which fields have been reported, see
3299 * SURVEY_HAS_* defines.
3300 * @list: Internal list pointers
3302 struct freq_survey {
3307 u64 channel_time_busy;
3308 u64 channel_time_rx;
3309 u64 channel_time_tx;
3310 unsigned int filled;
3311 struct dl_list list;
3314 #define SURVEY_HAS_NF BIT(0)
3315 #define SURVEY_HAS_CHAN_TIME BIT(1)
3316 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3317 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3318 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3322 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3324 union wpa_event_data {
3326 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3328 * This structure is optional for EVENT_ASSOC calls and required for
3329 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3330 * driver interface does not need to generate separate EVENT_ASSOCINFO
3335 * reassoc - Flag to indicate association or reassociation
3340 * req_ies - (Re)Association Request IEs
3342 * If the driver generates WPA/RSN IE, this event data must be
3343 * returned for WPA handshake to have needed information. If
3344 * wpa_supplicant-generated WPA/RSN IE is used, this
3345 * information event is optional.
3347 * This should start with the first IE (fixed fields before IEs
3348 * are not included).
3353 * req_ies_len - Length of req_ies in bytes
3358 * resp_ies - (Re)Association Response IEs
3360 * Optional association data from the driver. This data is not
3361 * required WPA, but may be useful for some protocols and as
3362 * such, should be reported if this is available to the driver
3365 * This should start with the first IE (fixed fields before IEs
3366 * are not included).
3371 * resp_ies_len - Length of resp_ies in bytes
3373 size_t resp_ies_len;
3376 * beacon_ies - Beacon or Probe Response IEs
3378 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3379 * Probe Response frames from the current AP (i.e., the one
3380 * that the client just associated with). This information is
3381 * used to update WPA/RSN IE for the AP. If this field is not
3382 * set, the results from previous scan will be used. If no
3383 * data for the new AP is found, scan results will be requested
3384 * again (without scan request). At this point, the driver is
3385 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3388 * This should start with the first IE (fixed fields before IEs
3389 * are not included).
3391 const u8 *beacon_ies;
3394 * beacon_ies_len - Length of beacon_ies */
3395 size_t beacon_ies_len;
3398 * freq - Frequency of the operational channel in MHz
3403 * addr - Station address (for AP mode)
3409 * struct disassoc_info - Data for EVENT_DISASSOC events
3411 struct disassoc_info {
3413 * addr - Station address (for AP mode)
3418 * reason_code - Reason Code (host byte order) used in
3419 * Deauthentication frame
3424 * ie - Optional IE(s) in Disassociation frame
3429 * ie_len - Length of ie buffer in octets
3434 * locally_generated - Whether the frame was locally generated
3436 int locally_generated;
3440 * struct deauth_info - Data for EVENT_DEAUTH events
3442 struct deauth_info {
3444 * addr - Station address (for AP mode)
3449 * reason_code - Reason Code (host byte order) used in
3450 * Deauthentication frame
3455 * ie - Optional IE(s) in Deauthentication frame
3460 * ie_len - Length of ie buffer in octets
3465 * locally_generated - Whether the frame was locally generated
3467 int locally_generated;
3471 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3473 struct michael_mic_failure {
3476 } michael_mic_failure;
3479 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3481 struct interface_status {
3484 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3489 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3491 struct pmkid_candidate {
3492 /** BSSID of the PMKID candidate */
3494 /** Smaller the index, higher the priority */
3496 /** Whether RSN IE includes pre-authenticate flag */
3501 * struct stkstart - Data for EVENT_STKSTART
3508 * struct tdls - Data for EVENT_TDLS
3514 TDLS_REQUEST_TEARDOWN
3516 u16 reason_code; /* for teardown */
3520 * struct wnm - Data for EVENT_WNM
3538 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3540 * During FT (IEEE 802.11r) authentication sequence, the driver is
3541 * expected to use this event to report received FT IEs (MDIE, FTIE,
3542 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3543 * IEs for the next message will be delivered through the
3544 * struct wpa_driver_ops::update_ft_ies() callback.
3550 u8 target_ap[ETH_ALEN];
3551 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3553 /** Length of ric_ies buffer in octets */
3558 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3560 struct ibss_rsn_start {
3565 * struct auth_info - Data for EVENT_AUTH events
3571 u16 auth_transaction;
3578 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3580 struct assoc_reject {
3582 * bssid - BSSID of the AP that rejected association
3587 * resp_ies - (Re)Association Response IEs
3589 * Optional association data from the driver. This data is not
3590 * required WPA, but may be useful for some protocols and as
3591 * such, should be reported if this is available to the driver
3594 * This should start with the first IE (fixed fields before IEs
3595 * are not included).
3600 * resp_ies_len - Length of resp_ies in bytes
3602 size_t resp_ies_len;
3605 * status_code - Status Code from (Re)association Response
3610 struct timeout_event {
3615 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3624 * struct tx_status - Data for EVENT_TX_STATUS events
3636 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3638 struct rx_from_unknown {
3645 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3651 int ssi_signal; /* dBm */
3655 * struct rx_action - Data for EVENT_RX_ACTION events
3659 * da - Destination address of the received Action frame
3664 * sa - Source address of the received Action frame
3669 * bssid - Address 3 of the received Action frame
3674 * category - Action frame category
3679 * data - Action frame body after category field
3684 * len - Length of data in octets
3689 * freq - Frequency (in MHz) on which the frame was received
3695 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3697 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3699 struct remain_on_channel {
3701 * freq - Channel frequency in MHz
3706 * duration - Duration to remain on the channel in milliseconds
3708 unsigned int duration;
3709 } remain_on_channel;
3712 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3713 * @aborted: Whether the scan was aborted
3714 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3715 * @num_freqs: Number of entries in freqs array
3716 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3718 * @num_ssids: Number of entries in ssids array
3724 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3729 * struct mlme_rx - Data for EVENT_MLME_RX events
3740 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3742 struct rx_probe_req {
3744 * sa - Source address of the received Probe Request frame
3749 * da - Destination address of the received Probe Request frame
3750 * or %NULL if not available
3755 * bssid - BSSID of the received Probe Request frame or %NULL
3761 * ie - IEs from the Probe Request body
3766 * ie_len - Length of ie buffer in octets
3771 * signal - signal strength in dBm (or 0 if not available)
3777 * struct new_sta - Data for EVENT_NEW_STA events
3784 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3793 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3795 struct wpa_signal_info signal_change;
3798 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3799 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3800 * @freq_5: Best 5 GHz band channel frequency in MHz
3801 * @freq_overall: Best channel frequency in MHz
3803 * 0 can be used to indicate no preference in either band.
3805 struct best_channel {
3811 struct unprot_deauth {
3817 struct unprot_disassoc {
3824 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3825 * @addr: station address
3832 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3834 struct p2p_dev_found {
3837 const u8 *pri_dev_type;
3838 const char *dev_name;
3845 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3847 struct p2p_go_neg_req_rx {
3850 } p2p_go_neg_req_rx;
3853 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3855 struct p2p_go_neg_completed {
3856 struct p2p_go_neg_results *res;
3857 } p2p_go_neg_completed;
3859 struct p2p_prov_disc_req {
3863 const u8 *pri_dev_type;
3864 const char *dev_name;
3865 u16 supp_config_methods;
3868 } p2p_prov_disc_req;
3870 struct p2p_prov_disc_resp {
3873 } p2p_prov_disc_resp;
3884 struct p2p_sd_resp {
3892 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3894 struct ibss_peer_lost {
3899 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3901 struct driver_gtk_rekey {
3903 const u8 *replay_ctr;
3907 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
3908 * @addr: station address
3910 struct client_poll {
3915 * struct eapol_tx_status
3916 * @dst: Original destination
3917 * @data: Data starting with IEEE 802.1X header (!)
3918 * @data_len: Length of data
3919 * @ack: Indicates ack or lost frame
3921 * This corresponds to hapd_send_eapol if the frame sent
3922 * there isn't just reported as EVENT_TX_STATUS.
3924 struct eapol_tx_status {
3933 * @freq: Frequency of new channel in MHz
3934 * @ht_enabled: Whether this is an HT channel
3935 * @ch_offset: Secondary channel offset
3944 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
3945 * @addr: Remote client address
3946 * @code: Reason code for connection failure
3948 struct connect_failed_reason {
3954 } connect_failed_reason;
3957 * struct dfs_event - Data for radar detected events
3958 * @freq: Frequency of the channel in MHz
3964 enum chan_width chan_width;
3970 * survey_results - Survey result data for EVENT_SURVEY
3971 * @freq_filter: Requested frequency survey filter, 0 if request
3972 * was for all survey data
3973 * @survey_list: Linked list of survey data
3975 struct survey_results {
3976 unsigned int freq_filter;
3977 struct dl_list survey_list; /* struct freq_survey */
3982 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3983 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3984 * with struct wpa_driver_ops::init()
3985 * @event: event type (defined above)
3986 * @data: possible extra data for the event
3988 * Driver wrapper code should call this function whenever an event is received
3991 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
3992 union wpa_event_data *data);
3996 * The following inline functions are provided for convenience to simplify
3997 * event indication for some of the common events.
4000 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4001 size_t ielen, int reassoc)
4003 union wpa_event_data event;
4004 os_memset(&event, 0, sizeof(event));
4005 event.assoc_info.reassoc = reassoc;
4006 event.assoc_info.req_ies = ie;
4007 event.assoc_info.req_ies_len = ielen;
4008 event.assoc_info.addr = addr;
4009 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4012 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4014 union wpa_event_data event;
4015 os_memset(&event, 0, sizeof(event));
4016 event.disassoc_info.addr = addr;
4017 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4020 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4023 union wpa_event_data event;
4024 os_memset(&event, 0, sizeof(event));
4025 event.eapol_rx.src = src;
4026 event.eapol_rx.data = data;
4027 event.eapol_rx.data_len = data_len;
4028 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4031 /* driver_common.c */
4032 void wpa_scan_results_free(struct wpa_scan_results *res);
4034 /* Convert wpa_event_type to a string for logging */
4035 const char * event_to_string(enum wpa_event_type event);
4037 #endif /* DRIVER_H */