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
33 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
34 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
35 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
36 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
37 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
40 * struct hostapd_channel_data - Channel information
42 struct hostapd_channel_data {
44 * chan - Channel number (IEEE 802.11)
49 * freq - Frequency in MHz
54 * flag - Channel flags (HOSTAPD_CHAN_*)
59 * max_tx_power - Maximum transmit power in dBm
64 * survey_list - Linked list of surveys
66 struct dl_list survey_list;
69 * min_nf - Minimum observed noise floor, in dBm, based on all
70 * surveyed channel data
75 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
76 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
79 * struct hostapd_hw_modes - Supported hardware mode information
81 struct hostapd_hw_modes {
83 * mode - Hardware mode
85 enum hostapd_hw_mode mode;
88 * num_channels - Number of entries in the channels array
93 * channels - Array of supported channels
95 struct hostapd_channel_data *channels;
98 * num_rates - Number of entries in the rates array
103 * rates - Array of supported rates in 100 kbps units
108 * ht_capab - HT (IEEE 802.11n) capabilities
113 * mcs_set - MCS (IEEE 802.11n) rate parameters
118 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
123 * vht_capab - VHT (IEEE 802.11ac) capabilities
128 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
132 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
136 #define IEEE80211_MODE_INFRA 0
137 #define IEEE80211_MODE_IBSS 1
138 #define IEEE80211_MODE_AP 2
140 #define IEEE80211_CAP_ESS 0x0001
141 #define IEEE80211_CAP_IBSS 0x0002
142 #define IEEE80211_CAP_PRIVACY 0x0010
144 /* DMG (60 GHz) IEEE 802.11ad */
145 /* type - bits 0..1 */
146 #define IEEE80211_CAP_DMG_MASK 0x0003
147 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
148 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
149 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
151 #define WPA_SCAN_QUAL_INVALID BIT(0)
152 #define WPA_SCAN_NOISE_INVALID BIT(1)
153 #define WPA_SCAN_LEVEL_INVALID BIT(2)
154 #define WPA_SCAN_LEVEL_DBM BIT(3)
155 #define WPA_SCAN_AUTHENTICATED BIT(4)
156 #define WPA_SCAN_ASSOCIATED BIT(5)
159 * struct wpa_scan_res - Scan result for an BSS/IBSS
160 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
162 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
163 * @beacon_int: beacon interval in TUs (host byte order)
164 * @caps: capability information field in host byte order
165 * @qual: signal quality
166 * @noise: noise level
167 * @level: signal level
169 * @age: Age of the information in milliseconds (i.e., how many milliseconds
170 * ago the last Beacon or Probe Response frame was received)
171 * @ie_len: length of the following IE field in octets
172 * @beacon_ie_len: length of the following Beacon IE field in octets
174 * This structure is used as a generic format for scan results from the
175 * driver. Each driver interface implementation is responsible for converting
176 * the driver or OS specific scan results into this format.
178 * If the driver does not support reporting all IEs, the IE data structure is
179 * constructed of the IEs that are available. This field will also need to
180 * include SSID in IE format. All drivers are encouraged to be extended to
181 * report all IEs to make it easier to support future additions.
183 struct wpa_scan_res {
195 size_t beacon_ie_len;
197 * Followed by ie_len octets of IEs from Probe Response frame (or if
198 * the driver does not indicate source of IEs, these may also be from
199 * Beacon frame). After the first set of IEs, another set of IEs may
200 * follow (with beacon_ie_len octets of data) if the driver provides
206 * struct wpa_scan_results - Scan results
207 * @res: Array of pointers to allocated variable length scan result entries
208 * @num: Number of entries in the scan result array
209 * @fetch_time: Time when the results were fetched from the driver
211 struct wpa_scan_results {
212 struct wpa_scan_res **res;
214 struct os_time fetch_time;
218 * struct wpa_interface_info - Network interface information
219 * @next: Pointer to the next interface or NULL if this is the last one
220 * @ifname: Interface name that can be used with init() or init2()
221 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
223 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
224 * is not an allocated copy, i.e., get_interfaces() caller will not free
227 struct wpa_interface_info {
228 struct wpa_interface_info *next;
231 const char *drv_name;
234 #define WPAS_MAX_SCAN_SSIDS 16
237 * struct wpa_driver_scan_params - Scan parameters
238 * Data for struct wpa_driver_ops::scan2().
240 struct wpa_driver_scan_params {
242 * ssids - SSIDs to scan for
244 struct wpa_driver_scan_ssid {
246 * ssid - specific SSID to scan for (ProbeReq)
247 * %NULL or zero-length SSID is used to indicate active scan
248 * with wildcard SSID.
252 * ssid_len: Length of the SSID in octets
255 } ssids[WPAS_MAX_SCAN_SSIDS];
258 * num_ssids - Number of entries in ssids array
259 * Zero indicates a request for a passive scan.
264 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
269 * extra_ies_len - Length of extra_ies in octets
271 size_t extra_ies_len;
274 * freqs - Array of frequencies to scan or %NULL for all frequencies
276 * The frequency is set in MHz. The array is zero-terminated.
281 * filter_ssids - Filter for reporting SSIDs
283 * This optional parameter can be used to request the driver wrapper to
284 * filter scan results to include only the specified SSIDs. %NULL
285 * indicates that no filtering is to be done. This can be used to
286 * reduce memory needs for scan results in environments that have large
287 * number of APs with different SSIDs.
289 * The driver wrapper is allowed to take this allocated buffer into its
290 * own use by setting the pointer to %NULL. In that case, the driver
291 * wrapper is responsible for freeing the buffer with os_free() once it
292 * is not needed anymore.
294 struct wpa_driver_scan_filter {
300 * num_filter_ssids - Number of entries in filter_ssids array
302 size_t num_filter_ssids;
305 * filter_rssi - Filter by RSSI
307 * The driver may filter scan results in firmware to reduce host
308 * wakeups and thereby save power. Specify the RSSI threshold in s32
314 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
316 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
317 * Mbps from the support rates element(s) in the Probe Request frames
318 * and not to transmit the frames at any of those rates.
324 * struct wpa_driver_auth_params - Authentication parameters
325 * Data for struct wpa_driver_ops::authenticate().
327 struct wpa_driver_auth_params {
335 const u8 *wep_key[4];
336 size_t wep_key_len[4];
338 int local_state_change;
341 * p2p - Whether this connection is a P2P group
351 WPS_MODE_NONE /* no WPS provisioning being used */,
352 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
353 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
358 * struct wpa_driver_associate_params - Association parameters
359 * Data for struct wpa_driver_ops::associate().
361 struct wpa_driver_associate_params {
363 * bssid - BSSID of the selected AP
364 * This can be %NULL, if ap_scan=2 mode is used and the driver is
365 * responsible for selecting with which BSS to associate. */
369 * ssid - The selected SSID
374 * ssid_len - Length of the SSID (1..32)
379 * freq - Frequency of the channel the selected AP is using
380 * Frequency that the selected AP is using (in MHz as
381 * reported in the scan results)
386 * bg_scan_period - Background scan period in seconds, 0 to disable
387 * background scan, or -1 to indicate no change to default driver
393 * wpa_ie - WPA information element for (Re)Association Request
394 * WPA information element to be included in (Re)Association
395 * Request (including information element id and length). Use
396 * of this WPA IE is optional. If the driver generates the WPA
397 * IE, it can use pairwise_suite, group_suite, and
398 * key_mgmt_suite to select proper algorithms. In this case,
399 * the driver has to notify wpa_supplicant about the used WPA
400 * IE by generating an event that the interface code will
401 * convert into EVENT_ASSOCINFO data (see below).
403 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
404 * instead. The driver can determine which version is used by
405 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
408 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
413 * wpa_ie_len - length of the wpa_ie
418 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
420 unsigned int wpa_proto;
423 * pairwise_suite - Selected pairwise cipher suite
425 * This is usually ignored if @wpa_ie is used.
427 enum wpa_cipher pairwise_suite;
430 * group_suite - Selected group cipher suite
432 * This is usually ignored if @wpa_ie is used.
434 enum wpa_cipher group_suite;
437 * key_mgmt_suite - Selected key management suite
439 * This is usually ignored if @wpa_ie is used.
441 enum wpa_key_mgmt key_mgmt_suite;
444 * auth_alg - Allowed authentication algorithms
445 * Bit field of WPA_AUTH_ALG_*
450 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
455 * wep_key - WEP keys for static WEP configuration
457 const u8 *wep_key[4];
460 * wep_key_len - WEP key length for static WEP configuration
462 size_t wep_key_len[4];
465 * wep_tx_keyidx - WEP TX key index for static WEP configuration
470 * mgmt_frame_protection - IEEE 802.11w management frame protection
472 enum mfp_options mgmt_frame_protection;
475 * ft_ies - IEEE 802.11r / FT information elements
476 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
477 * for fast transition, this parameter is set to include the IEs that
478 * are to be sent in the next FT Authentication Request message.
479 * update_ft_ies() handler is called to update the IEs for further
480 * FT messages in the sequence.
482 * The driver should use these IEs only if the target AP is advertising
483 * the same mobility domain as the one included in the MDIE here.
485 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
486 * AP after the initial association. These IEs can only be used if the
487 * target AP is advertising support for FT and is using the same MDIE
488 * and SSID as the current AP.
490 * The driver is responsible for reporting the FT IEs received from the
491 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
492 * type. update_ft_ies() handler will then be called with the FT IEs to
493 * include in the next frame in the authentication sequence.
498 * ft_ies_len - Length of ft_ies in bytes
503 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
505 * This value is provided to allow the driver interface easier access
506 * to the current mobility domain. This value is set to %NULL if no
507 * mobility domain is currently active.
512 * passphrase - RSN passphrase for PSK
514 * This value is made available only for WPA/WPA2-Personal (PSK) and
515 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
516 * the 8..63 character ASCII passphrase, if available. Please note that
517 * this can be %NULL if passphrase was not used to generate the PSK. In
518 * that case, the psk field must be used to fetch the PSK.
520 const char *passphrase;
523 * psk - RSN PSK (alternative for passphrase for PSK)
525 * This value is made available only for WPA/WPA2-Personal (PSK) and
526 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
527 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
528 * be prepared to handle %NULL value as an error.
533 * drop_unencrypted - Enable/disable unencrypted frame filtering
535 * Configure the driver to drop all non-EAPOL frames (both receive and
536 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
537 * still be allowed for key negotiation.
539 int drop_unencrypted;
542 * prev_bssid - Previously used BSSID in this ESS
544 * When not %NULL, this is a request to use reassociation instead of
547 const u8 *prev_bssid;
552 * If the driver needs to do special configuration for WPS association,
553 * this variable provides more information on what type of association
554 * is being requested. Most drivers should not need ot use this.
559 * p2p - Whether this connection is a P2P group
564 * uapsd - UAPSD parameters for the network
565 * -1 = do not change defaults
566 * AP mode: 1 = enabled, 0 = disabled
567 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
572 * fixed_bssid - Whether to force this BSSID in IBSS mode
573 * 1 = Fix this BSSID and prevent merges.
574 * 0 = Do not fix BSSID.
579 * disable_ht - Disable HT (IEEE 802.11n) for this connection
584 * HT Capabilities over-rides. Only bits set in the mask will be used,
585 * and not all values are used by the kernel anyway. Currently, MCS,
586 * MPDU and MSDU fields are used.
588 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */
589 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */
591 #ifdef CONFIG_VHT_OVERRIDES
593 * disable_vht - Disable VHT for this connection
598 * VHT capability overrides.
600 const struct ieee80211_vht_capabilities *vhtcaps;
601 const struct ieee80211_vht_capabilities *vhtcaps_mask;
602 #endif /* CONFIG_VHT_OVERRIDES */
607 HIDDEN_SSID_ZERO_LEN,
608 HIDDEN_SSID_ZERO_CONTENTS
611 struct wpa_driver_ap_params {
613 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
618 * head_len - Length of the head buffer in octets
623 * tail - Beacon tail following TIM IE
628 * tail_len - Length of the tail buffer in octets
633 * dtim_period - DTIM period
638 * beacon_int - Beacon interval
643 * basic_rates: -1 terminated array of basic rates in 100 kbps
645 * This parameter can be used to set a specific basic rate set for the
646 * BSS. If %NULL, default basic rate set is used.
651 * proberesp - Probe Response template
653 * This is used by drivers that reply to Probe Requests internally in
654 * AP mode and require the full Probe Response template.
659 * proberesp_len - Length of the proberesp buffer in octets
661 size_t proberesp_len;
664 * ssid - The SSID to use in Beacon/Probe Response frames
669 * ssid_len - Length of the SSID (1..32)
674 * hide_ssid - Whether to hide the SSID
676 enum hide_ssid hide_ssid;
679 * pairwise_ciphers - WPA_CIPHER_* bitfield
681 unsigned int pairwise_ciphers;
684 * group_cipher - WPA_CIPHER_*
686 unsigned int group_cipher;
689 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
691 unsigned int key_mgmt_suites;
694 * auth_algs - WPA_AUTH_ALG_* bitfield
696 unsigned int auth_algs;
699 * wpa_version - WPA_PROTO_* bitfield
701 unsigned int wpa_version;
704 * privacy - Whether privacy is used in the BSS
709 * beacon_ies - WPS/P2P IE(s) for Beacon frames
711 * This is used to add IEs like WPS IE and P2P IE by drivers that do
712 * not use the full Beacon template.
714 const struct wpabuf *beacon_ies;
717 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
719 * This is used to add IEs like WPS IE and P2P IE by drivers that
720 * reply to Probe Request frames internally.
722 const struct wpabuf *proberesp_ies;
725 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
727 * This is used to add IEs like WPS IE by drivers that reply to
728 * (Re)Association Request frames internally.
730 const struct wpabuf *assocresp_ies;
733 * isolate - Whether to isolate frames between associated stations
735 * If this is non-zero, the AP is requested to disable forwarding of
736 * frames between associated stations.
741 * cts_protect - Whether CTS protection is enabled
746 * preamble - Whether short preamble is enabled
751 * short_slot_time - Whether short slot time is enabled
753 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
754 * not set (e.g., when 802.11g mode is not in use)
759 * ht_opmode - HT operation mode or -1 if HT not in use
764 * interworking - Whether Interworking is enabled
769 * hessid - Homogeneous ESS identifier or %NULL if not set
774 * access_network_type - Access Network Type (0..15)
776 * This is used for filtering Probe Request frames when Interworking is
779 u8 access_network_type;
782 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
784 * This is used by driver which advertises this capability.
786 int ap_max_inactivity;
789 * disable_dgaf - Whether group-addressed frames are disabled
795 * struct wpa_driver_capa - Driver capability information
797 struct wpa_driver_capa {
798 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
799 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
800 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
801 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
802 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
803 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
804 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
805 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
806 unsigned int key_mgmt;
808 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
809 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
810 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
811 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
812 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
813 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
816 #define WPA_DRIVER_AUTH_OPEN 0x00000001
817 #define WPA_DRIVER_AUTH_SHARED 0x00000002
818 #define WPA_DRIVER_AUTH_LEAP 0x00000004
821 /* Driver generated WPA/RSN IE */
822 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
823 /* Driver needs static WEP key setup after association command */
824 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
825 /* unused: 0x00000004 */
826 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
827 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
828 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
829 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
830 /* Driver provides separate commands for authentication and association (SME in
831 * wpa_supplicant). */
832 #define WPA_DRIVER_FLAGS_SME 0x00000020
833 /* Driver supports AP mode */
834 #define WPA_DRIVER_FLAGS_AP 0x00000040
835 /* Driver needs static WEP key setup after association has been completed */
836 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
837 /* Driver takes care of P2P management operations */
838 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
839 /* Driver supports concurrent P2P operations */
840 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
842 * Driver uses the initial interface as a dedicated management interface, i.e.,
843 * it cannot be used for P2P group operations or non-P2P purposes.
845 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
846 /* This interface is P2P capable (P2P GO or P2P Client) */
847 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
848 /* unused: 0x00001000 */
850 * Driver uses the initial interface for P2P management interface and non-P2P
851 * purposes (e.g., connect to infra AP), but this interface cannot be used for
852 * P2P group operations.
854 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
856 * Driver is known to use sane error codes, i.e., when it indicates that
857 * something (e.g., association) fails, there was indeed a failure and the
858 * operation does not end up getting completed successfully later.
860 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
861 /* Driver supports off-channel TX */
862 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
863 /* Driver indicates TX status events for EAPOL Data frames */
864 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
865 /* Driver indicates TX status events for Deauth/Disassoc frames */
866 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
867 /* Driver supports roaming (BSS selection) in firmware */
868 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
869 /* Driver supports operating as a TDLS peer */
870 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
871 /* Driver requires external TDLS setup/teardown/discovery */
872 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
873 /* Driver indicates support for Probe Response offloading in AP mode */
874 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
875 /* Driver supports U-APSD in AP mode */
876 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
877 /* Driver supports inactivity timer in AP mode */
878 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
879 /* Driver expects user space implementation of MLME in AP mode */
880 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
881 /* Driver supports SAE with user space SME */
882 #define WPA_DRIVER_FLAGS_SAE 0x02000000
883 /* Driver makes use of OBSS scan mechanism in wpa_supplicant */
884 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
885 /* Driver supports IBSS (Ad-hoc) mode */
886 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
887 /* Driver supports radar detection */
888 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
889 /* Driver supports a dedicated interface for P2P Device */
890 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
894 int max_sched_scan_ssids;
895 int sched_scan_supported;
899 * max_remain_on_chan - Maximum remain-on-channel duration in msec
901 unsigned int max_remain_on_chan;
904 * max_stations - Maximum number of associated stations the driver
905 * supports in AP mode
907 unsigned int max_stations;
910 * probe_resp_offloads - Bitmap of supported protocols by the driver
911 * for Probe Response offloading.
913 /* Driver Probe Response offloading support for WPS ver. 1 */
914 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
915 /* Driver Probe Response offloading support for WPS ver. 2 */
916 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
917 /* Driver Probe Response offloading support for P2P */
918 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
919 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
920 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
921 unsigned int probe_resp_offloads;
923 unsigned int max_acl_mac_addrs;
926 * Number of supported concurrent channels
928 unsigned int num_multichan_concurrent;
931 * extended_capa - extended capabilities in driver/device
933 * Must be allocated and freed by driver and the pointers must be
934 * valid for the lifetime of the driver, i.e., freed in deinit()
936 const u8 *extended_capa, *extended_capa_mask;
937 unsigned int extended_capa_len;
943 struct hostap_sta_driver_data {
944 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
945 unsigned long current_tx_rate;
946 unsigned long inactive_msec;
948 unsigned long num_ps_buf_frames;
949 unsigned long tx_retry_failed;
950 unsigned long tx_retry_count;
955 struct hostapd_sta_add_params {
959 const u8 *supp_rates;
960 size_t supp_rates_len;
962 const struct ieee80211_ht_capabilities *ht_capabilities;
963 const struct ieee80211_vht_capabilities *vht_capabilities;
964 u32 flags; /* bitmask of WPA_STA_* flags */
965 int set; /* Set STA parameters instead of add */
968 size_t ext_capab_len;
971 struct hostapd_freq_params {
977 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
978 * secondary channel below primary, 1 = HT40
979 * enabled, secondary channel above primary */
984 /* valid for both HT and VHT, center_freq2 is non-zero
985 * only for bandwidth 80 and an 80+80 channel */
986 int center_freq1, center_freq2;
994 struct hostapd_acl_params {
996 unsigned int num_mac_acl;
997 struct mac_address mac_acl[0];
1000 enum wpa_driver_if_type {
1002 * WPA_IF_STATION - Station mode interface
1007 * WPA_IF_AP_VLAN - AP mode VLAN interface
1009 * This interface shares its address and Beacon frame with the main
1015 * WPA_IF_AP_BSS - AP mode BSS interface
1017 * This interface has its own address and Beacon frame.
1022 * WPA_IF_P2P_GO - P2P Group Owner
1027 * WPA_IF_P2P_CLIENT - P2P Client
1032 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1033 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1038 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1039 * abstracted P2P Device function in the driver
1044 struct wpa_init_params {
1050 const char *test_socket;
1051 int use_pae_group_addr;
1055 u8 *own_addr; /* buffer for writing own MAC address */
1059 struct wpa_bss_params {
1060 /** Interface name (for multi-SSID/VLAN support) */
1062 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1071 enum mfp_options ieee80211w;
1074 #define WPA_STA_AUTHORIZED BIT(0)
1075 #define WPA_STA_WMM BIT(1)
1076 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1077 #define WPA_STA_MFP BIT(3)
1078 #define WPA_STA_TDLS_PEER BIT(4)
1081 * struct p2p_params - P2P parameters for driver-based P2P management
1084 const char *dev_name;
1086 #define DRV_MAX_SEC_DEV_TYPES 5
1087 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8];
1088 size_t num_sec_dev_types;
1102 WNM_SLEEP_ENTER_CONFIRM,
1103 WNM_SLEEP_ENTER_FAIL,
1104 WNM_SLEEP_EXIT_CONFIRM,
1105 WNM_SLEEP_EXIT_FAIL,
1106 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1107 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1108 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1110 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1112 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1113 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1115 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1118 /* enum chan_width - Channel width definitions */
1130 * struct wpa_signal_info - Information about channel signal quality
1132 struct wpa_signal_info {
1134 int above_threshold;
1139 enum chan_width chanwidth;
1145 * struct wpa_driver_ops - Driver interface API definition
1147 * This structure defines the API that each driver interface needs to implement
1148 * for core wpa_supplicant code. All driver specific functionality is captured
1151 struct wpa_driver_ops {
1152 /** Name of the driver interface */
1154 /** One line description of the driver interface */
1158 * get_bssid - Get the current BSSID
1159 * @priv: private driver interface data
1160 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1162 * Returns: 0 on success, -1 on failure
1164 * Query kernel driver for the current BSSID and copy it to bssid.
1165 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1168 int (*get_bssid)(void *priv, u8 *bssid);
1171 * get_ssid - Get the current SSID
1172 * @priv: private driver interface data
1173 * @ssid: buffer for SSID (at least 32 bytes)
1175 * Returns: Length of the SSID on success, -1 on failure
1177 * Query kernel driver for the current SSID and copy it to ssid.
1178 * Returning zero is recommended if the STA is not associated.
1180 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1181 * can, at least in theory, contain control characters (including nul)
1182 * and as such, should be processed as binary data, not a printable
1185 int (*get_ssid)(void *priv, u8 *ssid);
1188 * set_key - Configure encryption key
1189 * @ifname: Interface name (for multi-SSID/VLAN support)
1190 * @priv: private driver interface data
1191 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1192 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1194 * %WPA_ALG_NONE clears the key.
1195 * @addr: Address of the peer STA (BSSID of the current AP when setting
1196 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1197 * broadcast keys, %NULL for default keys that are used both for
1198 * broadcast and unicast; when clearing keys, %NULL is used to
1199 * indicate that both the broadcast-only and default key of the
1200 * specified key index is to be cleared
1201 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1203 * @set_tx: configure this key as the default Tx key (only used when
1204 * driver does not support separate unicast/individual key
1205 * @seq: sequence number/packet number, seq_len octets, the next
1206 * packet number to be used for in replay protection; configured
1207 * for Rx keys (in most cases, this is only used with broadcast
1208 * keys and set to zero for unicast keys); %NULL if not set
1209 * @seq_len: length of the seq, depends on the algorithm:
1210 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1211 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1213 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1214 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1216 * Returns: 0 on success, -1 on failure
1218 * Configure the given key for the kernel driver. If the driver
1219 * supports separate individual keys (4 default keys + 1 individual),
1220 * addr can be used to determine whether the key is default or
1221 * individual. If only 4 keys are supported, the default key with key
1222 * index 0 is used as the individual key. STA must be configured to use
1223 * it as the default Tx key (set_tx is set) and accept Rx for all the
1224 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1225 * broadcast keys, so key index 0 is available for this kind of
1228 * Please note that TKIP keys include separate TX and RX MIC keys and
1229 * some drivers may expect them in different order than wpa_supplicant
1230 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1231 * will trigger Michael MIC errors. This can be fixed by changing the
1232 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1233 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1234 * example on how this can be done.
1236 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1237 const u8 *addr, int key_idx, int set_tx,
1238 const u8 *seq, size_t seq_len,
1239 const u8 *key, size_t key_len);
1242 * init - Initialize driver interface
1243 * @ctx: context to be used when calling wpa_supplicant functions,
1244 * e.g., wpa_supplicant_event()
1245 * @ifname: interface name, e.g., wlan0
1247 * Returns: Pointer to private data, %NULL on failure
1249 * Initialize driver interface, including event processing for kernel
1250 * driver events (e.g., associated, scan results, Michael MIC failure).
1251 * This function can allocate a private configuration data area for
1252 * @ctx, file descriptor, interface name, etc. information that may be
1253 * needed in future driver operations. If this is not used, non-NULL
1254 * value will need to be returned because %NULL is used to indicate
1255 * failure. The returned value will be used as 'void *priv' data for
1256 * all other driver_ops functions.
1258 * The main event loop (eloop.c) of wpa_supplicant can be used to
1259 * register callback for read sockets (eloop_register_read_sock()).
1261 * See below for more information about events and
1262 * wpa_supplicant_event() function.
1264 void * (*init)(void *ctx, const char *ifname);
1267 * deinit - Deinitialize driver interface
1268 * @priv: private driver interface data from init()
1270 * Shut down driver interface and processing of driver events. Free
1271 * private data buffer if one was allocated in init() handler.
1273 void (*deinit)(void *priv);
1276 * set_param - Set driver configuration parameters
1277 * @priv: private driver interface data from init()
1278 * @param: driver specific configuration parameters
1280 * Returns: 0 on success, -1 on failure
1282 * Optional handler for notifying driver interface about configuration
1283 * parameters (driver_param).
1285 int (*set_param)(void *priv, const char *param);
1288 * set_countermeasures - Enable/disable TKIP countermeasures
1289 * @priv: private driver interface data
1290 * @enabled: 1 = countermeasures enabled, 0 = disabled
1292 * Returns: 0 on success, -1 on failure
1294 * Configure TKIP countermeasures. When these are enabled, the driver
1295 * should drop all received and queued frames that are using TKIP.
1297 int (*set_countermeasures)(void *priv, int enabled);
1300 * deauthenticate - Request driver to deauthenticate
1301 * @priv: private driver interface data
1302 * @addr: peer address (BSSID of the AP)
1303 * @reason_code: 16-bit reason code to be sent in the deauthentication
1306 * Returns: 0 on success, -1 on failure
1308 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1311 * associate - Request driver to associate
1312 * @priv: private driver interface data
1313 * @params: association parameters
1315 * Returns: 0 on success, -1 on failure
1317 int (*associate)(void *priv,
1318 struct wpa_driver_associate_params *params);
1321 * add_pmkid - Add PMKSA cache entry to the driver
1322 * @priv: private driver interface data
1323 * @bssid: BSSID for the PMKSA cache entry
1324 * @pmkid: PMKID for the PMKSA cache entry
1326 * Returns: 0 on success, -1 on failure
1328 * This function is called when a new PMK is received, as a result of
1329 * either normal authentication or RSN pre-authentication.
1331 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1332 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1333 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1334 * driver_ops function does not need to be implemented. Likewise, if
1335 * the driver does not support WPA, this function is not needed.
1337 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1340 * remove_pmkid - Remove PMKSA cache entry to the driver
1341 * @priv: private driver interface data
1342 * @bssid: BSSID for the PMKSA cache entry
1343 * @pmkid: PMKID for the PMKSA cache entry
1345 * Returns: 0 on success, -1 on failure
1347 * This function is called when the supplicant drops a PMKSA cache
1348 * entry for any reason.
1350 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1351 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1352 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1353 * from wpa_supplicant, this driver_ops function does not need to be
1354 * implemented. Likewise, if the driver does not support WPA, this
1355 * function is not needed.
1357 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1360 * flush_pmkid - Flush PMKSA cache
1361 * @priv: private driver interface data
1363 * Returns: 0 on success, -1 on failure
1365 * This function is called when the supplicant drops all PMKSA cache
1366 * entries for any reason.
1368 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1369 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1370 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1371 * from wpa_supplicant, this driver_ops function does not need to be
1372 * implemented. Likewise, if the driver does not support WPA, this
1373 * function is not needed.
1375 int (*flush_pmkid)(void *priv);
1378 * get_capa - Get driver capabilities
1379 * @priv: private driver interface data
1381 * Returns: 0 on success, -1 on failure
1383 * Get driver/firmware/hardware capabilities.
1385 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1388 * poll - Poll driver for association information
1389 * @priv: private driver interface data
1391 * This is an option callback that can be used when the driver does not
1392 * provide event mechanism for association events. This is called when
1393 * receiving WPA EAPOL-Key messages that require association
1394 * information. The driver interface is supposed to generate associnfo
1395 * event before returning from this callback function. In addition, the
1396 * driver interface should generate an association event after having
1397 * sent out associnfo.
1399 void (*poll)(void *priv);
1402 * get_ifname - Get interface name
1403 * @priv: private driver interface data
1405 * Returns: Pointer to the interface name. This can differ from the
1406 * interface name used in init() call. Init() is called first.
1408 * This optional function can be used to allow the driver interface to
1409 * replace the interface name with something else, e.g., based on an
1410 * interface mapping from a more descriptive name.
1412 const char * (*get_ifname)(void *priv);
1415 * get_mac_addr - Get own MAC address
1416 * @priv: private driver interface data
1418 * Returns: Pointer to own MAC address or %NULL on failure
1420 * This optional function can be used to get the own MAC address of the
1421 * device from the driver interface code. This is only needed if the
1422 * l2_packet implementation for the OS does not provide easy access to
1424 const u8 * (*get_mac_addr)(void *priv);
1427 * send_eapol - Optional function for sending EAPOL packets
1428 * @priv: private driver interface data
1429 * @dest: Destination MAC address
1431 * @data: EAPOL packet starting with IEEE 802.1X header
1432 * @data_len: Size of the EAPOL packet
1434 * Returns: 0 on success, -1 on failure
1436 * This optional function can be used to override l2_packet operations
1437 * with driver specific functionality. If this function pointer is set,
1438 * l2_packet module is not used at all and the driver interface code is
1439 * responsible for receiving and sending all EAPOL packets. The
1440 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1441 * event. The driver interface is required to implement get_mac_addr()
1442 * handler if send_eapol() is used.
1444 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1445 const u8 *data, size_t data_len);
1448 * set_operstate - Sets device operating state to DORMANT or UP
1449 * @priv: private driver interface data
1450 * @state: 0 = dormant, 1 = up
1451 * Returns: 0 on success, -1 on failure
1453 * This is an optional function that can be used on operating systems
1454 * that support a concept of controlling network device state from user
1455 * space applications. This function, if set, gets called with
1456 * state = 1 when authentication has been completed and with state = 0
1457 * when connection is lost.
1459 int (*set_operstate)(void *priv, int state);
1462 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1463 * @priv: Private driver interface data
1464 * @addr: Address of the station for which to set protection (may be
1465 * %NULL for group keys)
1466 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1467 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1468 * Returns: 0 on success, -1 on failure
1470 * This is an optional function that can be used to set the driver to
1471 * require protection for Tx and/or Rx frames. This uses the layer
1472 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1473 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1474 * set protection operation; instead, they set protection implicitly
1475 * based on configured keys.
1477 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1481 * get_hw_feature_data - Get hardware support data (channels and rates)
1482 * @priv: Private driver interface data
1483 * @num_modes: Variable for returning the number of returned modes
1484 * flags: Variable for returning hardware feature flags
1485 * Returns: Pointer to allocated hardware data on success or %NULL on
1486 * failure. Caller is responsible for freeing this.
1488 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1493 * send_mlme - Send management frame from MLME
1494 * @priv: Private driver interface data
1495 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1496 * @data_len: Size of the management frame
1497 * @noack: Do not wait for this frame to be acked (disable retries)
1498 * Returns: 0 on success, -1 on failure
1500 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1504 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1505 * @priv: Private driver interface data
1506 * @md: Mobility domain (2 octets) (also included inside ies)
1507 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1508 * @ies_len: Length of FT IEs in bytes
1509 * Returns: 0 on success, -1 on failure
1511 * The supplicant uses this callback to let the driver know that keying
1512 * material for FT is available and that the driver can use the
1513 * provided IEs in the next message in FT authentication sequence.
1515 * This function is only needed for driver that support IEEE 802.11r
1516 * (Fast BSS Transition).
1518 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1522 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1523 * @priv: Private driver interface data
1524 * @action: Action field value
1525 * @target_ap: Target AP address
1526 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1527 * @ies_len: Length of FT IEs in bytes
1528 * Returns: 0 on success, -1 on failure
1530 * The supplicant uses this callback to request the driver to transmit
1531 * an FT Action frame (action category 6) for over-the-DS fast BSS
1534 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1535 const u8 *ies, size_t ies_len);
1538 * get_scan_results2 - Fetch the latest scan results
1539 * @priv: private driver interface data
1541 * Returns: Allocated buffer of scan results (caller is responsible for
1542 * freeing the data structure) on success, NULL on failure
1544 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1547 * set_country - Set country
1548 * @priv: Private driver interface data
1549 * @alpha2: country to which to switch to
1550 * Returns: 0 on success, -1 on failure
1552 * This function is for drivers which support some form
1553 * of setting a regulatory domain.
1555 int (*set_country)(void *priv, const char *alpha2);
1558 * global_init - Global driver initialization
1559 * Returns: Pointer to private data (global), %NULL on failure
1561 * This optional function is called to initialize the driver wrapper
1562 * for global data, i.e., data that applies to all interfaces. If this
1563 * function is implemented, global_deinit() will also need to be
1564 * implemented to free the private data. The driver will also likely
1565 * use init2() function instead of init() to get the pointer to global
1566 * data available to per-interface initializer.
1568 void * (*global_init)(void);
1571 * global_deinit - Global driver deinitialization
1572 * @priv: private driver global data from global_init()
1574 * Terminate any global driver related functionality and free the
1575 * global data structure.
1577 void (*global_deinit)(void *priv);
1580 * init2 - Initialize driver interface (with global data)
1581 * @ctx: context to be used when calling wpa_supplicant functions,
1582 * e.g., wpa_supplicant_event()
1583 * @ifname: interface name, e.g., wlan0
1584 * @global_priv: private driver global data from global_init()
1585 * Returns: Pointer to private data, %NULL on failure
1587 * This function can be used instead of init() if the driver wrapper
1590 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1593 * get_interfaces - Get information about available interfaces
1594 * @global_priv: private driver global data from global_init()
1595 * Returns: Allocated buffer of interface information (caller is
1596 * responsible for freeing the data structure) on success, NULL on
1599 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1602 * scan2 - Request the driver to initiate scan
1603 * @priv: private driver interface data
1604 * @params: Scan parameters
1606 * Returns: 0 on success, -1 on failure
1608 * Once the scan results are ready, the driver should report scan
1609 * results event for wpa_supplicant which will eventually request the
1610 * results with wpa_driver_get_scan_results2().
1612 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1615 * authenticate - Request driver to authenticate
1616 * @priv: private driver interface data
1617 * @params: authentication parameters
1618 * Returns: 0 on success, -1 on failure
1620 * This is an optional function that can be used with drivers that
1621 * support separate authentication and association steps, i.e., when
1622 * wpa_supplicant can act as the SME. If not implemented, associate()
1623 * function is expected to take care of IEEE 802.11 authentication,
1626 int (*authenticate)(void *priv,
1627 struct wpa_driver_auth_params *params);
1630 * set_ap - Set Beacon and Probe Response information for AP mode
1631 * @priv: Private driver interface data
1632 * @params: Parameters to use in AP mode
1634 * This function is used to configure Beacon template and/or extra IEs
1635 * to add for Beacon and Probe Response frames for the driver in
1636 * AP mode. The driver is responsible for building the full Beacon
1637 * frame by concatenating the head part with TIM IE generated by the
1638 * driver/firmware and finishing with the tail part. Depending on the
1639 * driver architectue, this can be done either by using the full
1640 * template or the set of additional IEs (e.g., WPS and P2P IE).
1641 * Similarly, Probe Response processing depends on the driver design.
1642 * If the driver (or firmware) takes care of replying to Probe Request
1643 * frames, the extra IEs provided here needs to be added to the Probe
1646 * Returns: 0 on success, -1 on failure
1648 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1651 * set_acl - Set ACL in AP mode
1652 * @priv: Private driver interface data
1653 * @params: Parameters to configure ACL
1654 * Returns: 0 on success, -1 on failure
1656 * This is used only for the drivers which support MAC address ACL.
1658 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1661 * hapd_init - Initialize driver interface (hostapd only)
1662 * @hapd: Pointer to hostapd context
1663 * @params: Configuration for the driver wrapper
1664 * Returns: Pointer to private data, %NULL on failure
1666 * This function is used instead of init() or init2() when the driver
1667 * wrapper is used with hostapd.
1669 void * (*hapd_init)(struct hostapd_data *hapd,
1670 struct wpa_init_params *params);
1673 * hapd_deinit - Deinitialize driver interface (hostapd only)
1674 * @priv: Private driver interface data from hapd_init()
1676 void (*hapd_deinit)(void *priv);
1679 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1680 * @priv: Private driver interface data
1681 * @params: BSS parameters
1682 * Returns: 0 on success, -1 on failure
1684 * This is an optional function to configure the kernel driver to
1685 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1686 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1687 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1688 * for Beacon frames.
1690 * DEPRECATED - use set_ap() instead
1692 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1695 * set_privacy - Enable/disable privacy (AP only)
1696 * @priv: Private driver interface data
1697 * @enabled: 1 = privacy enabled, 0 = disabled
1698 * Returns: 0 on success, -1 on failure
1700 * This is an optional function to configure privacy field in the
1701 * kernel driver for Beacon frames. This can be left undefined (set to
1702 * %NULL) if the driver uses the Beacon template from set_ap().
1704 * DEPRECATED - use set_ap() instead
1706 int (*set_privacy)(void *priv, int enabled);
1709 * get_seqnum - Fetch the current TSC/packet number (AP only)
1710 * @ifname: The interface name (main or virtual)
1711 * @priv: Private driver interface data
1712 * @addr: MAC address of the station or %NULL for group keys
1714 * @seq: Buffer for returning the latest used TSC/packet number
1715 * Returns: 0 on success, -1 on failure
1717 * This function is used to fetch the last used TSC/packet number for
1718 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1719 * keys, so there is no strict requirement on implementing support for
1720 * unicast keys (i.e., addr != %NULL).
1722 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1726 * flush - Flush all association stations (AP only)
1727 * @priv: Private driver interface data
1728 * Returns: 0 on success, -1 on failure
1730 * This function requests the driver to disassociate all associated
1731 * stations. This function does not need to be implemented if the
1732 * driver does not process association frames internally.
1734 int (*flush)(void *priv);
1737 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1738 * @priv: Private driver interface data
1739 * @elem: Information elements
1740 * @elem_len: Length of the elem buffer in octets
1741 * Returns: 0 on success, -1 on failure
1743 * This is an optional function to add information elements in the
1744 * kernel driver for Beacon and Probe Response frames. This can be left
1745 * undefined (set to %NULL) if the driver uses the Beacon template from
1748 * DEPRECATED - use set_ap() instead
1750 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1753 * read_sta_data - Fetch station data
1754 * @priv: Private driver interface data
1755 * @data: Buffer for returning station information
1756 * @addr: MAC address of the station
1757 * Returns: 0 on success, -1 on failure
1759 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1763 * hapd_send_eapol - Send an EAPOL packet (AP only)
1764 * @priv: private driver interface data
1765 * @addr: Destination MAC address
1766 * @data: EAPOL packet starting with IEEE 802.1X header
1767 * @data_len: Length of the EAPOL packet in octets
1768 * @encrypt: Whether the frame should be encrypted
1769 * @own_addr: Source MAC address
1770 * @flags: WPA_STA_* flags for the destination station
1772 * Returns: 0 on success, -1 on failure
1774 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1775 size_t data_len, int encrypt,
1776 const u8 *own_addr, u32 flags);
1779 * sta_deauth - Deauthenticate a station (AP only)
1780 * @priv: Private driver interface data
1781 * @own_addr: Source address and BSSID for the Deauthentication frame
1782 * @addr: MAC address of the station to deauthenticate
1783 * @reason: Reason code for the Deauthentiation frame
1784 * Returns: 0 on success, -1 on failure
1786 * This function requests a specific station to be deauthenticated and
1787 * a Deauthentication frame to be sent to it.
1789 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1793 * sta_disassoc - Disassociate a station (AP only)
1794 * @priv: Private driver interface data
1795 * @own_addr: Source address and BSSID for the Disassociation frame
1796 * @addr: MAC address of the station to disassociate
1797 * @reason: Reason code for the Disassociation frame
1798 * Returns: 0 on success, -1 on failure
1800 * This function requests a specific station to be disassociated and
1801 * a Disassociation frame to be sent to it.
1803 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1807 * sta_remove - Remove a station entry (AP only)
1808 * @priv: Private driver interface data
1809 * @addr: MAC address of the station to be removed
1810 * Returns: 0 on success, -1 on failure
1812 int (*sta_remove)(void *priv, const u8 *addr);
1815 * hapd_get_ssid - Get the current SSID (AP only)
1816 * @priv: Private driver interface data
1817 * @buf: Buffer for returning the SSID
1818 * @len: Maximum length of the buffer
1819 * Returns: Length of the SSID on success, -1 on failure
1821 * This function need not be implemented if the driver uses Beacon
1822 * template from set_ap() and does not reply to Probe Request frames.
1824 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1827 * hapd_set_ssid - Set SSID (AP only)
1828 * @priv: Private driver interface data
1830 * @len: Length of the SSID in octets
1831 * Returns: 0 on success, -1 on failure
1833 * DEPRECATED - use set_ap() instead
1835 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1838 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1839 * @priv: Private driver interface data
1840 * @enabled: 1 = countermeasures enabled, 0 = disabled
1841 * Returns: 0 on success, -1 on failure
1843 * This need not be implemented if the driver does not take care of
1844 * association processing.
1846 int (*hapd_set_countermeasures)(void *priv, int enabled);
1849 * sta_add - Add a station entry
1850 * @priv: Private driver interface data
1851 * @params: Station parameters
1852 * Returns: 0 on success, -1 on failure
1854 * This function is used to add a station entry to the driver once the
1855 * station has completed association. This is only used if the driver
1856 * does not take care of association processing.
1858 * With TDLS, this function is also used to add or set (params->set 1)
1859 * TDLS peer entries.
1861 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1864 * get_inact_sec - Get station inactivity duration (AP only)
1865 * @priv: Private driver interface data
1866 * @addr: Station address
1867 * Returns: Number of seconds station has been inactive, -1 on failure
1869 int (*get_inact_sec)(void *priv, const u8 *addr);
1872 * sta_clear_stats - Clear station statistics (AP only)
1873 * @priv: Private driver interface data
1874 * @addr: Station address
1875 * Returns: 0 on success, -1 on failure
1877 int (*sta_clear_stats)(void *priv, const u8 *addr);
1880 * set_freq - Set channel/frequency (AP only)
1881 * @priv: Private driver interface data
1882 * @freq: Channel parameters
1883 * Returns: 0 on success, -1 on failure
1885 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1888 * set_rts - Set RTS threshold
1889 * @priv: Private driver interface data
1890 * @rts: RTS threshold in octets
1891 * Returns: 0 on success, -1 on failure
1893 int (*set_rts)(void *priv, int rts);
1896 * set_frag - Set fragmentation threshold
1897 * @priv: Private driver interface data
1898 * @frag: Fragmentation threshold in octets
1899 * Returns: 0 on success, -1 on failure
1901 int (*set_frag)(void *priv, int frag);
1904 * sta_set_flags - Set station flags (AP only)
1905 * @priv: Private driver interface data
1906 * @addr: Station address
1907 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1908 * @flags_or: Bitmap of WPA_STA_* flags to add
1909 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1910 * Returns: 0 on success, -1 on failure
1912 int (*sta_set_flags)(void *priv, const u8 *addr,
1913 int total_flags, int flags_or, int flags_and);
1916 * set_tx_queue_params - Set TX queue parameters
1917 * @priv: Private driver interface data
1918 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1922 * @burst_time: Maximum length for bursting in 0.1 msec units
1924 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1925 int cw_max, int burst_time);
1928 * if_add - Add a virtual interface
1929 * @priv: Private driver interface data
1930 * @type: Interface type
1931 * @ifname: Interface name for the new virtual interface
1932 * @addr: Local address to use for the interface or %NULL to use the
1933 * parent interface address
1934 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1935 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1936 * not allowed (applies only to %WPA_IF_AP_BSS type)
1937 * @force_ifname: Buffer for returning an interface name that the
1938 * driver ended up using if it differs from the requested ifname
1939 * @if_addr: Buffer for returning the allocated interface address
1940 * (this may differ from the requested addr if the driver cannot
1941 * change interface address)
1942 * @bridge: Bridge interface to use or %NULL if no bridge configured
1943 * Returns: 0 on success, -1 on failure
1945 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1946 const char *ifname, const u8 *addr, void *bss_ctx,
1947 void **drv_priv, char *force_ifname, u8 *if_addr,
1948 const char *bridge);
1951 * if_remove - Remove a virtual interface
1952 * @priv: Private driver interface data
1953 * @type: Interface type
1954 * @ifname: Interface name of the virtual interface to be removed
1955 * Returns: 0 on success, -1 on failure
1957 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1958 const char *ifname);
1961 * set_sta_vlan - Bind a station into a specific interface (AP only)
1962 * @priv: Private driver interface data
1963 * @ifname: Interface (main or virtual BSS or VLAN)
1964 * @addr: MAC address of the associated station
1966 * Returns: 0 on success, -1 on failure
1968 * This function is used to bind a station to a specific virtual
1969 * interface. It is only used if when virtual interfaces are supported,
1970 * e.g., to assign stations to different VLAN interfaces based on
1971 * information from a RADIUS server. This allows separate broadcast
1972 * domains to be used with a single BSS.
1974 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1978 * commit - Optional commit changes handler (AP only)
1979 * @priv: driver private data
1980 * Returns: 0 on success, -1 on failure
1982 * This optional handler function can be registered if the driver
1983 * interface implementation needs to commit changes (e.g., by setting
1984 * network interface up) at the end of initial configuration. If set,
1985 * this handler will be called after initial setup has been completed.
1987 int (*commit)(void *priv);
1990 * send_ether - Send an ethernet packet (AP only)
1991 * @priv: private driver interface data
1992 * @dst: Destination MAC address
1993 * @src: Source MAC address
1995 * @data: EAPOL packet starting with IEEE 802.1X header
1996 * @data_len: Length of the EAPOL packet in octets
1997 * Returns: 0 on success, -1 on failure
1999 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2000 const u8 *data, size_t data_len);
2003 * set_radius_acl_auth - Notification of RADIUS ACL change
2004 * @priv: Private driver interface data
2005 * @mac: MAC address of the station
2006 * @accepted: Whether the station was accepted
2007 * @session_timeout: Session timeout for the station
2008 * Returns: 0 on success, -1 on failure
2010 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2011 u32 session_timeout);
2014 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2015 * @priv: Private driver interface data
2016 * @mac: MAC address of the station
2017 * Returns: 0 on success, -1 on failure
2019 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2022 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2023 * @priv: Private driver interface data
2024 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2025 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2027 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2028 * to remove extra IE(s)
2029 * Returns: 0 on success, -1 on failure
2031 * This is an optional function to add WPS IE in the kernel driver for
2032 * Beacon and Probe Response frames. This can be left undefined (set
2033 * to %NULL) if the driver uses the Beacon template from set_ap()
2034 * and does not process Probe Request frames. If the driver takes care
2035 * of (Re)Association frame processing, the assocresp buffer includes
2036 * WPS IE(s) that need to be added to (Re)Association Response frames
2037 * whenever a (Re)Association Request frame indicated use of WPS.
2039 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2040 * frames when operating as a GO. The driver is responsible for adding
2041 * timing related attributes (e.g., NoA) in addition to the IEs
2042 * included here by appending them after these buffers. This call is
2043 * also used to provide Probe Response IEs for P2P Listen state
2044 * operations for drivers that generate the Probe Response frames
2047 * DEPRECATED - use set_ap() instead
2049 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2050 const struct wpabuf *proberesp,
2051 const struct wpabuf *assocresp);
2054 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2055 * @priv: Private driver interface data
2056 * @authorized: Whether the port is authorized
2057 * Returns: 0 on success, -1 on failure
2059 int (*set_supp_port)(void *priv, int authorized);
2062 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2063 * @priv: Private driver interface data
2064 * @addr: MAC address of the associated station
2065 * @aid: Association ID
2066 * @val: 1 = bind to 4-address WDS; 0 = unbind
2067 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2068 * to indicate that bridge is not to be used
2069 * @ifname_wds: Buffer to return the interface name for the new WDS
2070 * station or %NULL to indicate name is not returned.
2071 * Returns: 0 on success, -1 on failure
2073 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2074 const char *bridge_ifname, char *ifname_wds);
2077 * send_action - Transmit an Action frame
2078 * @priv: Private driver interface data
2079 * @freq: Frequency (in MHz) of the channel
2080 * @wait: Time to wait off-channel for a response (in ms), or zero
2081 * @dst: Destination MAC address (Address 1)
2082 * @src: Source MAC address (Address 2)
2083 * @bssid: BSSID (Address 3)
2085 * @data_len: data length in octets
2086 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2087 * Returns: 0 on success, -1 on failure
2089 * This command can be used to request the driver to transmit an action
2090 * frame to the specified destination.
2092 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2093 * be transmitted on the given channel and the device will wait for a
2094 * response on that channel for the given wait time.
2096 * If the flag is not set, the wait time will be ignored. In this case,
2097 * if a remain-on-channel duration is in progress, the frame must be
2098 * transmitted on that channel; alternatively the frame may be sent on
2099 * the current operational channel (if in associated state in station
2100 * mode or while operating as an AP.)
2102 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2103 const u8 *dst, const u8 *src, const u8 *bssid,
2104 const u8 *data, size_t data_len, int no_cck);
2107 * send_action_cancel_wait - Cancel action frame TX wait
2108 * @priv: Private driver interface data
2110 * This command cancels the wait time associated with sending an action
2111 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2112 * set in the driver flags.
2114 void (*send_action_cancel_wait)(void *priv);
2117 * remain_on_channel - Remain awake on a channel
2118 * @priv: Private driver interface data
2119 * @freq: Frequency (in MHz) of the channel
2120 * @duration: Duration in milliseconds
2121 * Returns: 0 on success, -1 on failure
2123 * This command is used to request the driver to remain awake on the
2124 * specified channel for the specified duration and report received
2125 * Action frames with EVENT_RX_ACTION events. Optionally, received
2126 * Probe Request frames may also be requested to be reported by calling
2127 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2129 * The driver may not be at the requested channel when this function
2130 * returns, i.e., the return code is only indicating whether the
2131 * request was accepted. The caller will need to wait until the
2132 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2133 * completed the channel change. This may take some time due to other
2134 * need for the radio and the caller should be prepared to timing out
2135 * its wait since there are no guarantees on when this request can be
2138 int (*remain_on_channel)(void *priv, unsigned int freq,
2139 unsigned int duration);
2142 * cancel_remain_on_channel - Cancel remain-on-channel operation
2143 * @priv: Private driver interface data
2145 * This command can be used to cancel a remain-on-channel operation
2146 * before its originally requested duration has passed. This could be
2147 * used, e.g., when remain_on_channel() is used to request extra time
2148 * to receive a response to an Action frame and the response is
2149 * received when there is still unneeded time remaining on the
2150 * remain-on-channel operation.
2152 int (*cancel_remain_on_channel)(void *priv);
2155 * probe_req_report - Request Probe Request frames to be indicated
2156 * @priv: Private driver interface data
2157 * @report: Whether to report received Probe Request frames
2158 * Returns: 0 on success, -1 on failure (or if not supported)
2160 * This command can be used to request the driver to indicate when
2161 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2162 * Since this operation may require extra resources, e.g., due to less
2163 * optimal hardware/firmware RX filtering, many drivers may disable
2164 * Probe Request reporting at least in station mode. This command is
2165 * used to notify the driver when the Probe Request frames need to be
2166 * reported, e.g., during remain-on-channel operations.
2168 int (*probe_req_report)(void *priv, int report);
2171 * deinit_ap - Deinitialize AP mode
2172 * @priv: Private driver interface data
2173 * Returns: 0 on success, -1 on failure (or if not supported)
2175 * This optional function can be used to disable AP mode related
2176 * configuration. If the interface was not dynamically added,
2177 * change the driver mode to station mode to allow normal station
2178 * operations like scanning to be completed.
2180 int (*deinit_ap)(void *priv);
2183 * deinit_p2p_cli - Deinitialize P2P client mode
2184 * @priv: Private driver interface data
2185 * Returns: 0 on success, -1 on failure (or if not supported)
2187 * This optional function can be used to disable P2P client mode. If the
2188 * interface was not dynamically added, change the interface type back
2191 int (*deinit_p2p_cli)(void *priv);
2194 * suspend - Notification on system suspend/hibernate event
2195 * @priv: Private driver interface data
2197 void (*suspend)(void *priv);
2200 * resume - Notification on system resume/thaw event
2201 * @priv: Private driver interface data
2203 void (*resume)(void *priv);
2206 * signal_monitor - Set signal monitoring parameters
2207 * @priv: Private driver interface data
2208 * @threshold: Threshold value for signal change events; 0 = disabled
2209 * @hysteresis: Minimum change in signal strength before indicating a
2211 * Returns: 0 on success, -1 on failure (or if not supported)
2213 * This function can be used to configure monitoring of signal strength
2214 * with the current AP. Whenever signal strength drops below the
2215 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2216 * should be generated assuming the signal strength has changed at
2217 * least %hysteresis from the previously indicated signal change event.
2219 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2222 * send_frame - Send IEEE 802.11 frame (testing use only)
2223 * @priv: Private driver interface data
2224 * @data: IEEE 802.11 frame with IEEE 802.11 header
2225 * @data_len: Size of the frame
2226 * @encrypt: Whether to encrypt the frame (if keys are set)
2227 * Returns: 0 on success, -1 on failure
2229 * This function is only used for debugging purposes and is not
2230 * required to be implemented for normal operations.
2232 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2236 * shared_freq - Get operating frequency of shared interface(s)
2237 * @priv: Private driver interface data
2238 * Returns: Operating frequency in MHz, 0 if no shared operation in
2239 * use, or -1 on failure
2241 * This command can be used to request the current operating frequency
2242 * of any virtual interface that shares the same radio to provide
2243 * information for channel selection for other virtual interfaces.
2245 int (*shared_freq)(void *priv);
2248 * get_noa - Get current Notice of Absence attribute payload
2249 * @priv: Private driver interface data
2250 * @buf: Buffer for returning NoA
2251 * @buf_len: Buffer length in octets
2252 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2253 * advertized, or -1 on failure
2255 * This function is used to fetch the current Notice of Absence
2256 * attribute value from GO.
2258 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2261 * set_noa - Set Notice of Absence parameters for GO (testing)
2262 * @priv: Private driver interface data
2264 * @start: Start time in ms from next TBTT
2265 * @duration: Duration in ms
2266 * Returns: 0 on success or -1 on failure
2268 * This function is used to set Notice of Absence parameters for GO. It
2269 * is used only for testing. To disable NoA, all parameters are set to
2272 int (*set_noa)(void *priv, u8 count, int start, int duration);
2275 * set_p2p_powersave - Set P2P power save options
2276 * @priv: Private driver interface data
2277 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2278 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2279 * @ctwindow: 0.. = change (msec), -1 = no change
2280 * Returns: 0 on success or -1 on failure
2282 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2286 * ampdu - Enable/disable aggregation
2287 * @priv: Private driver interface data
2288 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2289 * Returns: 0 on success or -1 on failure
2291 int (*ampdu)(void *priv, int ampdu);
2294 * get_radio_name - Get physical radio name for the device
2295 * @priv: Private driver interface data
2296 * Returns: Radio name or %NULL if not known
2298 * The returned data must not be modified by the caller. It is assumed
2299 * that any interface that has the same radio name as another is
2300 * sharing the same physical radio. This information can be used to
2301 * share scan results etc. information between the virtual interfaces
2302 * to speed up various operations.
2304 const char * (*get_radio_name)(void *priv);
2307 * p2p_find - Start P2P Device Discovery
2308 * @priv: Private driver interface data
2309 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2310 * @type: Device Discovery type (enum p2p_discovery_type)
2311 * Returns: 0 on success, -1 on failure
2313 * This function is only used if the driver implements P2P management,
2314 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2315 * struct wpa_driver_capa.
2317 int (*p2p_find)(void *priv, unsigned int timeout, int type);
2320 * p2p_stop_find - Stop P2P Device Discovery
2321 * @priv: Private driver interface data
2322 * Returns: 0 on success, -1 on failure
2324 * This function is only used if the driver implements P2P management,
2325 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2326 * struct wpa_driver_capa.
2328 int (*p2p_stop_find)(void *priv);
2331 * p2p_listen - Start P2P Listen state for specified duration
2332 * @priv: Private driver interface data
2333 * @timeout: Listen state duration in milliseconds
2334 * Returns: 0 on success, -1 on failure
2336 * This function can be used to request the P2P module to keep the
2337 * device discoverable on the listen channel for an extended set of
2338 * time. At least in its current form, this is mainly used for testing
2339 * purposes and may not be of much use for normal P2P operations.
2341 * This function is only used if the driver implements P2P management,
2342 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2343 * struct wpa_driver_capa.
2345 int (*p2p_listen)(void *priv, unsigned int timeout);
2348 * p2p_connect - Start P2P group formation (GO negotiation)
2349 * @priv: Private driver interface data
2350 * @peer_addr: MAC address of the peer P2P client
2351 * @wps_method: enum p2p_wps_method value indicating config method
2352 * @go_intent: Local GO intent value (1..15)
2353 * @own_interface_addr: Intended interface address to use with the
2355 * @force_freq: The only allowed channel frequency in MHz or 0
2356 * @persistent_group: Whether to create persistent group
2357 * Returns: 0 on success, -1 on failure
2359 * This function is only used if the driver implements P2P management,
2360 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2361 * struct wpa_driver_capa.
2363 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method,
2364 int go_intent, const u8 *own_interface_addr,
2365 unsigned int force_freq, int persistent_group);
2368 * wps_success_cb - Report successfully completed WPS provisioning
2369 * @priv: Private driver interface data
2370 * @peer_addr: Peer address
2371 * Returns: 0 on success, -1 on failure
2373 * This function is used to report successfully completed WPS
2374 * provisioning during group formation in both GO/Registrar and
2375 * client/Enrollee roles.
2377 * This function is only used if the driver implements P2P management,
2378 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2379 * struct wpa_driver_capa.
2381 int (*wps_success_cb)(void *priv, const u8 *peer_addr);
2384 * p2p_group_formation_failed - Report failed WPS provisioning
2385 * @priv: Private driver interface data
2386 * Returns: 0 on success, -1 on failure
2388 * This function is used to report failed group formation. This can
2389 * happen either due to failed WPS provisioning or due to 15 second
2390 * timeout during the provisioning phase.
2392 * This function is only used if the driver implements P2P management,
2393 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2394 * struct wpa_driver_capa.
2396 int (*p2p_group_formation_failed)(void *priv);
2399 * p2p_set_params - Set P2P parameters
2400 * @priv: Private driver interface data
2401 * @params: P2P parameters
2402 * Returns: 0 on success, -1 on failure
2404 * This function is only used if the driver implements P2P management,
2405 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2406 * struct wpa_driver_capa.
2408 int (*p2p_set_params)(void *priv, const struct p2p_params *params);
2411 * p2p_prov_disc_req - Send Provision Discovery Request
2412 * @priv: Private driver interface data
2413 * @peer_addr: MAC address of the peer P2P client
2414 * @config_methods: WPS Config Methods value (only one bit set)
2415 * Returns: 0 on success, -1 on failure
2417 * This function can be used to request a discovered P2P peer to
2418 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2419 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2420 * Provision Discovery Request frame is transmitted once immediately
2421 * and if no response is received, the frame will be sent again
2422 * whenever the target device is discovered during device dsicovery
2423 * (start with a p2p_find() call). Response from the peer is indicated
2424 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2426 * This function is only used if the driver implements P2P management,
2427 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2428 * struct wpa_driver_capa.
2430 int (*p2p_prov_disc_req)(void *priv, const u8 *peer_addr,
2431 u16 config_methods, int join);
2434 * p2p_sd_request - Schedule a service discovery query
2435 * @priv: Private driver interface data
2436 * @dst: Destination peer or %NULL to apply for all peers
2437 * @tlvs: P2P Service Query TLV(s)
2438 * Returns: Reference to the query or 0 on failure
2440 * Response to the query is indicated with the
2441 * EVENT_P2P_SD_RESPONSE driver event.
2443 * This function is only used if the driver implements P2P management,
2444 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2445 * struct wpa_driver_capa.
2447 u64 (*p2p_sd_request)(void *priv, const u8 *dst,
2448 const struct wpabuf *tlvs);
2451 * p2p_sd_cancel_request - Cancel a pending service discovery query
2452 * @priv: Private driver interface data
2453 * @req: Query reference from p2p_sd_request()
2454 * Returns: 0 on success, -1 on failure
2456 * This function is only used if the driver implements P2P management,
2457 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2458 * struct wpa_driver_capa.
2460 int (*p2p_sd_cancel_request)(void *priv, u64 req);
2463 * p2p_sd_response - Send response to a service discovery query
2464 * @priv: Private driver interface data
2465 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2466 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2467 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2468 * @resp_tlvs: P2P Service Response TLV(s)
2469 * Returns: 0 on success, -1 on failure
2471 * This function is called as a response to the request indicated with
2472 * the EVENT_P2P_SD_REQUEST driver event.
2474 * This function is only used if the driver implements P2P management,
2475 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2476 * struct wpa_driver_capa.
2478 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst,
2480 const struct wpabuf *resp_tlvs);
2483 * p2p_service_update - Indicate a change in local services
2484 * @priv: Private driver interface data
2485 * Returns: 0 on success, -1 on failure
2487 * This function needs to be called whenever there is a change in
2488 * availability of the local services. This will increment the
2489 * Service Update Indicator value which will be used in SD Request and
2492 * This function is only used if the driver implements P2P management,
2493 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2494 * struct wpa_driver_capa.
2496 int (*p2p_service_update)(void *priv);
2499 * p2p_reject - Reject peer device (explicitly block connections)
2500 * @priv: Private driver interface data
2501 * @addr: MAC address of the peer
2502 * Returns: 0 on success, -1 on failure
2504 int (*p2p_reject)(void *priv, const u8 *addr);
2507 * p2p_invite - Invite a P2P Device into a group
2508 * @priv: Private driver interface data
2509 * @peer: Device Address of the peer P2P Device
2510 * @role: Local role in the group
2511 * @bssid: Group BSSID or %NULL if not known
2513 * @ssid_len: Length of ssid in octets
2514 * @go_dev_addr: Forced GO Device Address or %NULL if none
2515 * @persistent_group: Whether this is to reinvoke a persistent group
2516 * Returns: 0 on success, -1 on failure
2518 int (*p2p_invite)(void *priv, const u8 *peer, int role,
2519 const u8 *bssid, const u8 *ssid, size_t ssid_len,
2520 const u8 *go_dev_addr, int persistent_group);
2523 * send_tdls_mgmt - for sending TDLS management packets
2524 * @priv: private driver interface data
2525 * @dst: Destination (peer) MAC address
2526 * @action_code: TDLS action code for the mssage
2527 * @dialog_token: Dialog Token to use in the message (if needed)
2528 * @status_code: Status Code or Reason Code to use (if needed)
2529 * @buf: TDLS IEs to add to the message
2530 * @len: Length of buf in octets
2531 * Returns: 0 on success, negative (<0) on failure
2533 * This optional function can be used to send packet to driver which is
2534 * responsible for receiving and sending all TDLS packets.
2536 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2537 u8 dialog_token, u16 status_code,
2538 const u8 *buf, size_t len);
2541 * tdls_oper - Ask the driver to perform high-level TDLS operations
2542 * @priv: Private driver interface data
2543 * @oper: TDLS high-level operation. See %enum tdls_oper
2544 * @peer: Destination (peer) MAC address
2545 * Returns: 0 on success, negative (<0) on failure
2547 * This optional function can be used to send high-level TDLS commands
2550 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2553 * wnm_oper - Notify driver of the WNM frame reception
2554 * @priv: Private driver interface data
2555 * @oper: WNM operation. See %enum wnm_oper
2556 * @peer: Destination (peer) MAC address
2557 * @buf: Buffer for the driver to fill in (for getting IE)
2558 * @buf_len: Return the len of buf
2559 * Returns: 0 on success, negative (<0) on failure
2561 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2562 u8 *buf, u16 *buf_len);
2565 * signal_poll - Get current connection information
2566 * @priv: Private driver interface data
2567 * @signal_info: Connection info structure
2569 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2572 * set_authmode - Set authentication algorithm(s) for static WEP
2573 * @priv: Private driver interface data
2574 * @authmode: 1=Open System, 2=Shared Key, 3=both
2575 * Returns: 0 on success, -1 on failure
2577 * This function can be used to set authentication algorithms for AP
2578 * mode when static WEP is used. If the driver uses user space MLME/SME
2579 * implementation, there is no need to implement this function.
2581 * DEPRECATED - use set_ap() instead
2583 int (*set_authmode)(void *priv, int authmode);
2586 * driver_cmd - execute driver-specific command
2587 * @priv: private driver interface data
2588 * @cmd: command to execute
2589 * @buf: return buffer
2590 * @buf_len: buffer length
2592 * Returns: 0 on success, -1 on failure
2594 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2597 * set_rekey_info - Set rekey information
2598 * @priv: Private driver interface data
2601 * @replay_ctr: Current EAPOL-Key Replay Counter
2603 * This optional function can be used to provide information for the
2604 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2605 * while the host (including wpa_supplicant) is sleeping.
2607 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2608 const u8 *replay_ctr);
2611 * sta_assoc - Station association indication
2612 * @priv: Private driver interface data
2613 * @own_addr: Source address and BSSID for association frame
2614 * @addr: MAC address of the station to associate
2615 * @reassoc: flag to indicate re-association
2616 * @status: association response status code
2617 * @ie: assoc response ie buffer
2618 * @len: ie buffer length
2619 * Returns: 0 on success, -1 on failure
2621 * This function indicates the driver to send (Re)Association
2622 * Response frame to the station.
2624 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2625 int reassoc, u16 status, const u8 *ie, size_t len);
2628 * sta_auth - Station authentication indication
2629 * @priv: Private driver interface data
2630 * @own_addr: Source address and BSSID for authentication frame
2631 * @addr: MAC address of the station to associate
2632 * @seq: authentication sequence number
2633 * @status: authentication response status code
2634 * @ie: authentication frame ie buffer
2635 * @len: ie buffer length
2637 * This function indicates the driver to send Authentication frame
2640 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2641 u16 seq, u16 status, const u8 *ie, size_t len);
2644 * add_tspec - Add traffic stream
2645 * @priv: Private driver interface data
2646 * @addr: MAC address of the station to associate
2647 * @tspec_ie: tspec ie buffer
2648 * @tspec_ielen: tspec ie length
2649 * Returns: 0 on success, -1 on failure
2651 * This function adds the traffic steam for the station
2652 * and fills the medium_time in tspec_ie.
2654 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2655 size_t tspec_ielen);
2658 * add_sta_node - Add a station node in the driver
2659 * @priv: Private driver interface data
2660 * @addr: MAC address of the station to add
2661 * @auth_alg: authentication algorithm used by the station
2662 * Returns: 0 on success, -1 on failure
2664 * This function adds the station node in the driver, when
2665 * the station gets added by FT-over-DS.
2667 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2670 * sched_scan - Request the driver to initiate scheduled scan
2671 * @priv: Private driver interface data
2672 * @params: Scan parameters
2673 * @interval: Interval between scan cycles in milliseconds
2674 * Returns: 0 on success, -1 on failure
2676 * This operation should be used for scheduled scan offload to
2677 * the hardware. Every time scan results are available, the
2678 * driver should report scan results event for wpa_supplicant
2679 * which will eventually request the results with
2680 * wpa_driver_get_scan_results2(). This operation is optional
2681 * and if not provided or if it returns -1, we fall back to
2682 * normal host-scheduled scans.
2684 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2688 * stop_sched_scan - Request the driver to stop a scheduled scan
2689 * @priv: Private driver interface data
2690 * Returns: 0 on success, -1 on failure
2692 * This should cause the scheduled scan to be stopped and
2693 * results should stop being sent. Must be supported if
2694 * sched_scan is supported.
2696 int (*stop_sched_scan)(void *priv);
2699 * poll_client - Probe (null data or such) the given station
2700 * @priv: Private driver interface data
2701 * @own_addr: MAC address of sending interface
2702 * @addr: MAC address of the station to probe
2703 * @qos: Indicates whether station is QoS station
2705 * This function is used to verify whether an associated station is
2706 * still present. This function does not need to be implemented if the
2707 * driver provides such inactivity polling mechanism.
2709 void (*poll_client)(void *priv, const u8 *own_addr,
2710 const u8 *addr, int qos);
2713 * radio_disable - Disable/enable radio
2714 * @priv: Private driver interface data
2715 * @disabled: 1=disable 0=enable radio
2716 * Returns: 0 on success, -1 on failure
2718 * This optional command is for testing purposes. It can be used to
2719 * disable the radio on a testbed device to simulate out-of-radio-range
2722 int (*radio_disable)(void *priv, int disabled);
2725 * switch_channel - Announce channel switch and migrate the GO to the
2727 * @priv: Private driver interface data
2728 * @freq: Frequency in MHz
2729 * Returns: 0 on success, -1 on failure
2731 * This function is used to move the GO to the legacy STA channel to
2732 * avoid frequency conflict in single channel concurrency.
2734 int (*switch_channel)(void *priv, unsigned int freq);
2737 * start_dfs_cac - Listen for radar interference on the channel
2738 * @priv: Private driver interface data
2739 * @freq: Frequency (in MHz) of the channel
2740 * Returns: 0 on success, -1 on failure
2742 int (*start_dfs_cac)(void *priv, int freq);
2745 * stop_ap - Removes beacon from AP
2746 * @priv: Private driver interface data
2747 * Returns: 0 on success, -1 on failure (or if not supported)
2749 * This optional function can be used to disable AP mode related
2750 * configuration. Unlike deinit_ap, it does not change to station
2753 int (*stop_ap)(void *priv);
2756 * get_survey - Retrieve survey data
2757 * @priv: Private driver interface data
2758 * @freq: If set, survey data for the specified frequency is only
2759 * being requested. If not set, all survey data is requested.
2760 * Returns: 0 on success, -1 on failure
2762 * Use this to retrieve:
2764 * - the observed channel noise floor
2765 * - the amount of time we have spent on the channel
2766 * - the amount of time during which we have spent on the channel that
2767 * the radio has determined the medium is busy and we cannot
2769 * - the amount of time we have spent receiving data
2770 * - the amount of time we have spent transmitting data
2772 * This data can be used for spectrum heuristics. One example is
2773 * Automatic Channel Selection (ACS). The channel survey data is
2774 * kept on a linked list on the channel data, one entry is added
2775 * for each survey. The min_nf of the channel is updated for each
2778 int (*get_survey)(void *priv, unsigned int freq);
2783 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2785 enum wpa_event_type {
2787 * EVENT_ASSOC - Association completed
2789 * This event needs to be delivered when the driver completes IEEE
2790 * 802.11 association or reassociation successfully.
2791 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2792 * after this event has been generated. In addition, optional
2793 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2794 * more information about the association. If the driver interface gets
2795 * both of these events at the same time, it can also include the
2796 * assoc_info data in EVENT_ASSOC call.
2801 * EVENT_DISASSOC - Association lost
2803 * This event should be called when association is lost either due to
2804 * receiving deauthenticate or disassociate frame from the AP or when
2805 * sending either of these frames to the current AP. If the driver
2806 * supports separate deauthentication event, EVENT_DISASSOC should only
2807 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2808 * In AP mode, union wpa_event_data::disassoc_info is required.
2813 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2815 * This event must be delivered when a Michael MIC error is detected by
2816 * the local driver. Additional data for event processing is
2817 * provided with union wpa_event_data::michael_mic_failure. This
2818 * information is used to request new encyption key and to initiate
2819 * TKIP countermeasures if needed.
2821 EVENT_MICHAEL_MIC_FAILURE,
2824 * EVENT_SCAN_RESULTS - Scan results available
2826 * This event must be called whenever scan results are available to be
2827 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2828 * is expected to be used some time after struct wpa_driver_ops::scan()
2829 * is called. If the driver provides an unsolicited event when the scan
2830 * has been completed, this event can be used to trigger
2831 * EVENT_SCAN_RESULTS call. If such event is not available from the
2832 * driver, the driver wrapper code is expected to use a registered
2833 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2834 * scan is expected to be completed. Optional information about
2835 * completed scan can be provided with union wpa_event_data::scan_info.
2840 * EVENT_ASSOCINFO - Report optional extra information for association
2842 * This event can be used to report extra association information for
2843 * EVENT_ASSOC processing. This extra information includes IEs from
2844 * association frames and Beacon/Probe Response frames in union
2845 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2846 * EVENT_ASSOC. Alternatively, the driver interface can include
2847 * assoc_info data in the EVENT_ASSOC call if it has all the
2848 * information available at the same point.
2853 * EVENT_INTERFACE_STATUS - Report interface status changes
2855 * This optional event can be used to report changes in interface
2856 * status (interface added/removed) using union
2857 * wpa_event_data::interface_status. This can be used to trigger
2858 * wpa_supplicant to stop and re-start processing for the interface,
2859 * e.g., when a cardbus card is ejected/inserted.
2861 EVENT_INTERFACE_STATUS,
2864 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2866 * This event can be used to inform wpa_supplicant about candidates for
2867 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2868 * for scan request (ap_scan=2 mode), this event is required for
2869 * pre-authentication. If wpa_supplicant is performing scan request
2870 * (ap_scan=1), this event is optional since scan results can be used
2871 * to add pre-authentication candidates. union
2872 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2873 * candidate and priority of the candidate, e.g., based on the signal
2874 * strength, in order to try to pre-authenticate first with candidates
2875 * that are most likely targets for re-association.
2877 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2878 * on the candidate list. In addition, it can be called for the current
2879 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2880 * will automatically skip pre-authentication in cases where a valid
2881 * PMKSA exists. When more than one candidate exists, this event should
2882 * be generated once for each candidate.
2884 * Driver will be notified about successful pre-authentication with
2885 * struct wpa_driver_ops::add_pmkid() calls.
2887 EVENT_PMKID_CANDIDATE,
2890 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2892 * This event can be used to inform wpa_supplicant about desire to set
2893 * up secure direct link connection between two stations as defined in
2894 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2895 * STAKey negotiation. The caller will need to set peer address for the
2901 * EVENT_TDLS - Request TDLS operation
2903 * This event can be used to request a TDLS operation to be performed.
2908 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2910 * The driver is expected to report the received FT IEs from
2911 * FT authentication sequence from the AP. The FT IEs are included in
2912 * the extra information in union wpa_event_data::ft_ies.
2917 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2919 * The driver can use this event to inform wpa_supplicant about a STA
2920 * in an IBSS with which protected frames could be exchanged. This
2921 * event starts RSN authentication with the other STA to authenticate
2922 * the STA and set up encryption keys with it.
2924 EVENT_IBSS_RSN_START,
2927 * EVENT_AUTH - Authentication result
2929 * This event should be called when authentication attempt has been
2930 * completed. This is only used if the driver supports separate
2931 * authentication step (struct wpa_driver_ops::authenticate).
2932 * Information about authentication result is included in
2933 * union wpa_event_data::auth.
2938 * EVENT_DEAUTH - Authentication lost
2940 * This event should be called when authentication is lost either due
2941 * to receiving deauthenticate frame from the AP or when sending that
2942 * frame to the current AP.
2943 * In AP mode, union wpa_event_data::deauth_info is required.
2948 * EVENT_ASSOC_REJECT - Association rejected
2950 * This event should be called when (re)association attempt has been
2951 * rejected by the AP. Information about the association response is
2952 * included in union wpa_event_data::assoc_reject.
2957 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2959 EVENT_AUTH_TIMED_OUT,
2962 * EVENT_ASSOC_TIMED_OUT - Association timed out
2964 EVENT_ASSOC_TIMED_OUT,
2967 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2972 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2974 EVENT_WPS_BUTTON_PUSHED,
2977 * EVENT_TX_STATUS - Report TX status
2982 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2984 EVENT_RX_FROM_UNKNOWN,
2987 * EVENT_RX_MGMT - Report RX of a management frame
2992 * EVENT_RX_ACTION - Action frame received
2994 * This event is used to indicate when an Action frame has been
2995 * received. Information about the received frame is included in
2996 * union wpa_event_data::rx_action.
3001 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3003 * This event is used to indicate when the driver has started the
3004 * requested remain-on-channel duration. Information about the
3005 * operation is included in union wpa_event_data::remain_on_channel.
3007 EVENT_REMAIN_ON_CHANNEL,
3010 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3012 * This event is used to indicate when the driver has completed
3013 * remain-on-channel duration, i.e., may noot be available on the
3014 * requested channel anymore. Information about the
3015 * operation is included in union wpa_event_data::remain_on_channel.
3017 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3020 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
3022 * This event is used only by driver_test.c and userspace MLME.
3027 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3029 * This event is used to indicate when a Probe Request frame has been
3030 * received. Information about the received frame is included in
3031 * union wpa_event_data::rx_probe_req. The driver is required to report
3032 * these events only after successfully completed probe_req_report()
3033 * commands to request the events (i.e., report parameter is non-zero)
3034 * in station mode. In AP mode, Probe Request frames should always be
3040 * EVENT_NEW_STA - New wired device noticed
3042 * This event is used to indicate that a new device has been detected
3043 * in a network that does not use association-like functionality (i.e.,
3044 * mainly wired Ethernet). This can be used to start EAPOL
3045 * authenticator when receiving a frame from a device. The address of
3046 * the device is included in union wpa_event_data::new_sta.
3051 * EVENT_EAPOL_RX - Report received EAPOL frame
3053 * When in AP mode with hostapd, this event is required to be used to
3054 * deliver the receive EAPOL frames from the driver. With
3055 * %wpa_supplicant, this event is used only if the send_eapol() handler
3056 * is used to override the use of l2_packet for EAPOL frame TX.
3061 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3063 * This event is used to indicate changes in the signal strength
3064 * observed in frames received from the current AP if signal strength
3065 * monitoring has been enabled with signal_monitor().
3067 EVENT_SIGNAL_CHANGE,
3070 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3072 * This event is used to indicate that the interface was enabled after
3073 * having been previously disabled, e.g., due to rfkill.
3075 EVENT_INTERFACE_ENABLED,
3078 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3080 * This event is used to indicate that the interface was disabled,
3081 * e.g., due to rfkill.
3083 EVENT_INTERFACE_DISABLED,
3086 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3088 * This event is used to indicate that the channel list has changed,
3089 * e.g., because of a regulatory domain change triggered by scan
3090 * results including an AP advertising a country code.
3092 EVENT_CHANNEL_LIST_CHANGED,
3095 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3097 * This event is used to indicate that the driver cannot maintain this
3098 * interface in its operation mode anymore. The most likely use for
3099 * this is to indicate that AP mode operation is not available due to
3100 * operating channel would need to be changed to a DFS channel when
3101 * the driver does not support radar detection and another virtual
3102 * interfaces caused the operating channel to change. Other similar
3103 * resource conflicts could also trigger this for station mode
3106 EVENT_INTERFACE_UNAVAILABLE,
3109 * EVENT_BEST_CHANNEL
3111 * Driver generates this event whenever it detects a better channel
3112 * (e.g., based on RSSI or channel use). This information can be used
3113 * to improve channel selection for a new AP/P2P group.
3118 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3120 * This event should be called when a Deauthentication frame is dropped
3121 * due to it not being protected (MFP/IEEE 802.11w).
3122 * union wpa_event_data::unprot_deauth is required to provide more
3123 * details of the frame.
3125 EVENT_UNPROT_DEAUTH,
3128 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3130 * This event should be called when a Disassociation frame is dropped
3131 * due to it not being protected (MFP/IEEE 802.11w).
3132 * union wpa_event_data::unprot_disassoc is required to provide more
3133 * details of the frame.
3135 EVENT_UNPROT_DISASSOC,
3138 * EVENT_STATION_LOW_ACK
3140 * Driver generates this event whenever it detected that a particular
3141 * station was lost. Detection can be through massive transmission
3142 * failures for example.
3144 EVENT_STATION_LOW_ACK,
3147 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
3149 * This event is used only if the driver implements P2P management
3150 * internally. Event data is stored in
3151 * union wpa_event_data::p2p_dev_found.
3153 EVENT_P2P_DEV_FOUND,
3156 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
3158 * This event is used only if the driver implements P2P management
3159 * internally. Event data is stored in
3160 * union wpa_event_data::p2p_go_neg_req_rx.
3162 EVENT_P2P_GO_NEG_REQ_RX,
3165 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
3167 * This event is used only if the driver implements P2P management
3168 * internally. Event data is stored in
3169 * union wpa_event_data::p2p_go_neg_completed.
3171 EVENT_P2P_GO_NEG_COMPLETED,
3173 EVENT_P2P_PROV_DISC_REQUEST,
3174 EVENT_P2P_PROV_DISC_RESPONSE,
3175 EVENT_P2P_SD_REQUEST,
3176 EVENT_P2P_SD_RESPONSE,
3179 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3181 EVENT_IBSS_PEER_LOST,
3184 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3186 * This event carries the new replay counter to notify wpa_supplicant
3187 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3188 * completed Group Key Handshake while the host (including
3189 * wpa_supplicant was sleeping).
3191 EVENT_DRIVER_GTK_REKEY,
3194 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3196 EVENT_SCHED_SCAN_STOPPED,
3199 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3201 * This event indicates that the station responded to the poll
3202 * initiated with @poll_client.
3204 EVENT_DRIVER_CLIENT_POLL_OK,
3207 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3209 EVENT_EAPOL_TX_STATUS,
3212 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3214 * Described in wpa_event_data.ch_switch
3219 * EVENT_WNM - Request WNM operation
3221 * This event can be used to request a WNM operation to be performed.
3226 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3228 * This event indicates that the driver reported a connection failure
3229 * with the specified client (for example, max client reached, etc.) in
3232 EVENT_CONNECT_FAILED_REASON,
3235 * EVENT_RADAR_DETECTED - Notify of radar detection
3237 * A radar has been detected on the supplied frequency, hostapd should
3238 * react accordingly (e.g., change channel).
3240 EVENT_DFS_RADAR_DETECTED,
3243 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3245 * After a successful CAC, the channel can be marked clear and used.
3247 EVENT_DFS_CAC_FINISHED,
3250 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3252 * The CAC was not successful, and the channel remains in the previous
3253 * state. This may happen due to a radar beeing detected or other
3254 * external influences.
3256 EVENT_DFS_CAC_ABORTED,
3259 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3261 * The channel which was previously unavailable is now available again.
3263 EVENT_DFS_NOP_FINISHED,
3266 * EVENT_SURVEY - Received survey data
3268 * This event gets triggered when a driver query is issued for survey
3269 * data and the requested data becomes available. The returned data is
3270 * stored in struct survey_results. The results provide at most one
3271 * survey entry for each frequency and at minimum will provide one survey
3272 * entry for one frequency. The survey data can be os_malloc()'d and
3273 * then os_free()'d, so the event callback must only copy data.
3280 * struct freq_survey - Channel survey info
3282 * @ifidx: Interface index in which this survey was observed
3283 * @freq: Center of frequency of the surveyed channel
3284 * @nf: Channel noise floor in dBm
3285 * @channel_time: Amount of time in ms the radio spent on the channel
3286 * @channel_time_busy: Amount of time in ms the radio detected some signal
3287 * that indicated to the radio the channel was not clear
3288 * @channel_time_rx: Amount of time the radio spent receiving data
3289 * @channel_time_tx: Amount of time the radio spent transmitting data
3290 * @filled: bitmask indicating which fields have been reported, see
3291 * SURVEY_HAS_* defines.
3292 * @list: Internal list pointers
3294 struct freq_survey {
3299 u64 channel_time_busy;
3300 u64 channel_time_rx;
3301 u64 channel_time_tx;
3302 unsigned int filled;
3303 struct dl_list list;
3306 #define SURVEY_HAS_NF BIT(0)
3307 #define SURVEY_HAS_CHAN_TIME BIT(1)
3308 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3309 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3310 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3314 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3316 union wpa_event_data {
3318 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3320 * This structure is optional for EVENT_ASSOC calls and required for
3321 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3322 * driver interface does not need to generate separate EVENT_ASSOCINFO
3327 * reassoc - Flag to indicate association or reassociation
3332 * req_ies - (Re)Association Request IEs
3334 * If the driver generates WPA/RSN IE, this event data must be
3335 * returned for WPA handshake to have needed information. If
3336 * wpa_supplicant-generated WPA/RSN IE is used, this
3337 * information event is optional.
3339 * This should start with the first IE (fixed fields before IEs
3340 * are not included).
3345 * req_ies_len - Length of req_ies in bytes
3350 * resp_ies - (Re)Association Response IEs
3352 * Optional association data from the driver. This data is not
3353 * required WPA, but may be useful for some protocols and as
3354 * such, should be reported if this is available to the driver
3357 * This should start with the first IE (fixed fields before IEs
3358 * are not included).
3363 * resp_ies_len - Length of resp_ies in bytes
3365 size_t resp_ies_len;
3368 * beacon_ies - Beacon or Probe Response IEs
3370 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3371 * Probe Response frames from the current AP (i.e., the one
3372 * that the client just associated with). This information is
3373 * used to update WPA/RSN IE for the AP. If this field is not
3374 * set, the results from previous scan will be used. If no
3375 * data for the new AP is found, scan results will be requested
3376 * again (without scan request). At this point, the driver is
3377 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3380 * This should start with the first IE (fixed fields before IEs
3381 * are not included).
3383 const u8 *beacon_ies;
3386 * beacon_ies_len - Length of beacon_ies */
3387 size_t beacon_ies_len;
3390 * freq - Frequency of the operational channel in MHz
3395 * addr - Station address (for AP mode)
3401 * struct disassoc_info - Data for EVENT_DISASSOC events
3403 struct disassoc_info {
3405 * addr - Station address (for AP mode)
3410 * reason_code - Reason Code (host byte order) used in
3411 * Deauthentication frame
3416 * ie - Optional IE(s) in Disassociation frame
3421 * ie_len - Length of ie buffer in octets
3426 * locally_generated - Whether the frame was locally generated
3428 int locally_generated;
3432 * struct deauth_info - Data for EVENT_DEAUTH events
3434 struct deauth_info {
3436 * addr - Station address (for AP mode)
3441 * reason_code - Reason Code (host byte order) used in
3442 * Deauthentication frame
3447 * ie - Optional IE(s) in Deauthentication frame
3452 * ie_len - Length of ie buffer in octets
3457 * locally_generated - Whether the frame was locally generated
3459 int locally_generated;
3463 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3465 struct michael_mic_failure {
3468 } michael_mic_failure;
3471 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3473 struct interface_status {
3476 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3481 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3483 struct pmkid_candidate {
3484 /** BSSID of the PMKID candidate */
3486 /** Smaller the index, higher the priority */
3488 /** Whether RSN IE includes pre-authenticate flag */
3493 * struct stkstart - Data for EVENT_STKSTART
3500 * struct tdls - Data for EVENT_TDLS
3506 TDLS_REQUEST_TEARDOWN
3508 u16 reason_code; /* for teardown */
3512 * struct wnm - Data for EVENT_WNM
3530 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3532 * During FT (IEEE 802.11r) authentication sequence, the driver is
3533 * expected to use this event to report received FT IEs (MDIE, FTIE,
3534 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3535 * IEs for the next message will be delivered through the
3536 * struct wpa_driver_ops::update_ft_ies() callback.
3542 u8 target_ap[ETH_ALEN];
3543 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3545 /** Length of ric_ies buffer in octets */
3550 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3552 struct ibss_rsn_start {
3557 * struct auth_info - Data for EVENT_AUTH events
3563 u16 auth_transaction;
3570 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3572 struct assoc_reject {
3574 * bssid - BSSID of the AP that rejected association
3579 * resp_ies - (Re)Association Response IEs
3581 * Optional association data from the driver. This data is not
3582 * required WPA, but may be useful for some protocols and as
3583 * such, should be reported if this is available to the driver
3586 * This should start with the first IE (fixed fields before IEs
3587 * are not included).
3592 * resp_ies_len - Length of resp_ies in bytes
3594 size_t resp_ies_len;
3597 * status_code - Status Code from (Re)association Response
3602 struct timeout_event {
3607 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3616 * struct tx_status - Data for EVENT_TX_STATUS events
3628 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3630 struct rx_from_unknown {
3637 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3643 int ssi_signal; /* dBm */
3647 * struct rx_action - Data for EVENT_RX_ACTION events
3651 * da - Destination address of the received Action frame
3656 * sa - Source address of the received Action frame
3661 * bssid - Address 3 of the received Action frame
3666 * category - Action frame category
3671 * data - Action frame body after category field
3676 * len - Length of data in octets
3681 * freq - Frequency (in MHz) on which the frame was received
3687 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3689 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3691 struct remain_on_channel {
3693 * freq - Channel frequency in MHz
3698 * duration - Duration to remain on the channel in milliseconds
3700 unsigned int duration;
3701 } remain_on_channel;
3704 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3705 * @aborted: Whether the scan was aborted
3706 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3707 * @num_freqs: Number of entries in freqs array
3708 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3710 * @num_ssids: Number of entries in ssids array
3716 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3721 * struct mlme_rx - Data for EVENT_MLME_RX events
3732 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3734 struct rx_probe_req {
3736 * sa - Source address of the received Probe Request frame
3741 * da - Destination address of the received Probe Request frame
3742 * or %NULL if not available
3747 * bssid - BSSID of the received Probe Request frame or %NULL
3753 * ie - IEs from the Probe Request body
3758 * ie_len - Length of ie buffer in octets
3763 * signal - signal strength in dBm (or 0 if not available)
3769 * struct new_sta - Data for EVENT_NEW_STA events
3776 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3785 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3787 struct wpa_signal_info signal_change;
3790 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3791 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3792 * @freq_5: Best 5 GHz band channel frequency in MHz
3793 * @freq_overall: Best channel frequency in MHz
3795 * 0 can be used to indicate no preference in either band.
3797 struct best_channel {
3803 struct unprot_deauth {
3809 struct unprot_disassoc {
3816 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3817 * @addr: station address
3824 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3826 struct p2p_dev_found {
3829 const u8 *pri_dev_type;
3830 const char *dev_name;
3837 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3839 struct p2p_go_neg_req_rx {
3842 } p2p_go_neg_req_rx;
3845 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3847 struct p2p_go_neg_completed {
3848 struct p2p_go_neg_results *res;
3849 } p2p_go_neg_completed;
3851 struct p2p_prov_disc_req {
3855 const u8 *pri_dev_type;
3856 const char *dev_name;
3857 u16 supp_config_methods;
3860 } p2p_prov_disc_req;
3862 struct p2p_prov_disc_resp {
3865 } p2p_prov_disc_resp;
3876 struct p2p_sd_resp {
3884 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3886 struct ibss_peer_lost {
3891 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3893 struct driver_gtk_rekey {
3895 const u8 *replay_ctr;
3899 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
3900 * @addr: station address
3902 struct client_poll {
3907 * struct eapol_tx_status
3908 * @dst: Original destination
3909 * @data: Data starting with IEEE 802.1X header (!)
3910 * @data_len: Length of data
3911 * @ack: Indicates ack or lost frame
3913 * This corresponds to hapd_send_eapol if the frame sent
3914 * there isn't just reported as EVENT_TX_STATUS.
3916 struct eapol_tx_status {
3925 * @freq: Frequency of new channel in MHz
3926 * @ht_enabled: Whether this is an HT channel
3927 * @ch_offset: Secondary channel offset
3936 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
3937 * @addr: Remote client address
3938 * @code: Reason code for connection failure
3940 struct connect_failed_reason {
3946 } connect_failed_reason;
3949 * struct dfs_event - Data for radar detected events
3950 * @freq: Frequency of the channel in MHz
3957 * survey_results - Survey result data for EVENT_SURVEY
3958 * @freq_filter: Requested frequency survey filter, 0 if request
3959 * was for all survey data
3960 * @survey_list: Linked list of survey data
3962 struct survey_results {
3963 unsigned int freq_filter;
3964 struct dl_list survey_list; /* struct freq_survey */
3969 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3970 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3971 * with struct wpa_driver_ops::init()
3972 * @event: event type (defined above)
3973 * @data: possible extra data for the event
3975 * Driver wrapper code should call this function whenever an event is received
3978 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
3979 union wpa_event_data *data);
3983 * The following inline functions are provided for convenience to simplify
3984 * event indication for some of the common events.
3987 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
3988 size_t ielen, int reassoc)
3990 union wpa_event_data event;
3991 os_memset(&event, 0, sizeof(event));
3992 event.assoc_info.reassoc = reassoc;
3993 event.assoc_info.req_ies = ie;
3994 event.assoc_info.req_ies_len = ielen;
3995 event.assoc_info.addr = addr;
3996 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
3999 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4001 union wpa_event_data event;
4002 os_memset(&event, 0, sizeof(event));
4003 event.disassoc_info.addr = addr;
4004 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4007 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4010 union wpa_event_data event;
4011 os_memset(&event, 0, sizeof(event));
4012 event.eapol_rx.src = src;
4013 event.eapol_rx.data = data;
4014 event.eapol_rx.data_len = data_len;
4015 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4018 /* driver_common.c */
4019 void wpa_scan_results_free(struct wpa_scan_results *res);
4021 /* Convert wpa_event_type to a string for logging */
4022 const char * event_to_string(enum wpa_event_type event);
4024 #endif /* DRIVER_H */