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"
24 #define HOSTAPD_CHAN_DISABLED 0x00000001
25 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
26 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
27 #define HOSTAPD_CHAN_RADAR 0x00000008
28 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
29 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
30 #define HOSTAPD_CHAN_HT40 0x00000040
32 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
33 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
34 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
35 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
36 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
39 * struct hostapd_channel_data - Channel information
41 struct hostapd_channel_data {
43 * chan - Channel number (IEEE 802.11)
48 * freq - Frequency in MHz
53 * flag - Channel flags (HOSTAPD_CHAN_*)
58 * max_tx_power - maximum transmit power in dBm
63 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
64 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
67 * struct hostapd_hw_modes - Supported hardware mode information
69 struct hostapd_hw_modes {
71 * mode - Hardware mode
73 enum hostapd_hw_mode mode;
76 * num_channels - Number of entries in the channels array
81 * channels - Array of supported channels
83 struct hostapd_channel_data *channels;
86 * num_rates - Number of entries in the rates array
91 * rates - Array of supported rates in 100 kbps units
96 * ht_capab - HT (IEEE 802.11n) capabilities
101 * mcs_set - MCS (IEEE 802.11n) rate parameters
106 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
111 * vht_capab - VHT (IEEE 802.11ac) capabilities
116 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
120 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
124 #define IEEE80211_MODE_INFRA 0
125 #define IEEE80211_MODE_IBSS 1
126 #define IEEE80211_MODE_AP 2
128 #define IEEE80211_CAP_ESS 0x0001
129 #define IEEE80211_CAP_IBSS 0x0002
130 #define IEEE80211_CAP_PRIVACY 0x0010
132 /* DMG (60 GHz) IEEE 802.11ad */
133 /* type - bits 0..1 */
134 #define IEEE80211_CAP_DMG_MASK 0x0003
135 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
136 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
137 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
139 #define WPA_SCAN_QUAL_INVALID BIT(0)
140 #define WPA_SCAN_NOISE_INVALID BIT(1)
141 #define WPA_SCAN_LEVEL_INVALID BIT(2)
142 #define WPA_SCAN_LEVEL_DBM BIT(3)
143 #define WPA_SCAN_AUTHENTICATED BIT(4)
144 #define WPA_SCAN_ASSOCIATED BIT(5)
147 * struct wpa_scan_res - Scan result for an BSS/IBSS
148 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
150 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
151 * @beacon_int: beacon interval in TUs (host byte order)
152 * @caps: capability information field in host byte order
153 * @qual: signal quality
154 * @noise: noise level
155 * @level: signal level
157 * @age: Age of the information in milliseconds (i.e., how many milliseconds
158 * ago the last Beacon or Probe Response frame was received)
159 * @ie_len: length of the following IE field in octets
160 * @beacon_ie_len: length of the following Beacon IE field in octets
162 * This structure is used as a generic format for scan results from the
163 * driver. Each driver interface implementation is responsible for converting
164 * the driver or OS specific scan results into this format.
166 * If the driver does not support reporting all IEs, the IE data structure is
167 * constructed of the IEs that are available. This field will also need to
168 * include SSID in IE format. All drivers are encouraged to be extended to
169 * report all IEs to make it easier to support future additions.
171 struct wpa_scan_res {
183 size_t beacon_ie_len;
185 * Followed by ie_len octets of IEs from Probe Response frame (or if
186 * the driver does not indicate source of IEs, these may also be from
187 * Beacon frame). After the first set of IEs, another set of IEs may
188 * follow (with beacon_ie_len octets of data) if the driver provides
194 * struct wpa_scan_results - Scan results
195 * @res: Array of pointers to allocated variable length scan result entries
196 * @num: Number of entries in the scan result array
197 * @fetch_time: Time when the results were fetched from the driver
199 struct wpa_scan_results {
200 struct wpa_scan_res **res;
202 struct os_time fetch_time;
206 * struct wpa_interface_info - Network interface information
207 * @next: Pointer to the next interface or NULL if this is the last one
208 * @ifname: Interface name that can be used with init() or init2()
209 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
211 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
212 * is not an allocated copy, i.e., get_interfaces() caller will not free
215 struct wpa_interface_info {
216 struct wpa_interface_info *next;
219 const char *drv_name;
222 #define WPAS_MAX_SCAN_SSIDS 16
225 * struct wpa_driver_scan_params - Scan parameters
226 * Data for struct wpa_driver_ops::scan2().
228 struct wpa_driver_scan_params {
230 * ssids - SSIDs to scan for
232 struct wpa_driver_scan_ssid {
234 * ssid - specific SSID to scan for (ProbeReq)
235 * %NULL or zero-length SSID is used to indicate active scan
236 * with wildcard SSID.
240 * ssid_len: Length of the SSID in octets
243 } ssids[WPAS_MAX_SCAN_SSIDS];
246 * num_ssids - Number of entries in ssids array
247 * Zero indicates a request for a passive scan.
252 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
257 * extra_ies_len - Length of extra_ies in octets
259 size_t extra_ies_len;
262 * freqs - Array of frequencies to scan or %NULL for all frequencies
264 * The frequency is set in MHz. The array is zero-terminated.
269 * filter_ssids - Filter for reporting SSIDs
271 * This optional parameter can be used to request the driver wrapper to
272 * filter scan results to include only the specified SSIDs. %NULL
273 * indicates that no filtering is to be done. This can be used to
274 * reduce memory needs for scan results in environments that have large
275 * number of APs with different SSIDs.
277 * The driver wrapper is allowed to take this allocated buffer into its
278 * own use by setting the pointer to %NULL. In that case, the driver
279 * wrapper is responsible for freeing the buffer with os_free() once it
280 * is not needed anymore.
282 struct wpa_driver_scan_filter {
288 * num_filter_ssids - Number of entries in filter_ssids array
290 size_t num_filter_ssids;
293 * filter_rssi - Filter by RSSI
295 * The driver may filter scan results in firmware to reduce host
296 * wakeups and thereby save power. Specify the RSSI threshold in s32
302 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
304 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
305 * Mbps from the support rates element(s) in the Probe Request frames
306 * and not to transmit the frames at any of those rates.
312 * struct wpa_driver_auth_params - Authentication parameters
313 * Data for struct wpa_driver_ops::authenticate().
315 struct wpa_driver_auth_params {
323 const u8 *wep_key[4];
324 size_t wep_key_len[4];
326 int local_state_change;
329 * p2p - Whether this connection is a P2P group
339 WPS_MODE_NONE /* no WPS provisioning being used */,
340 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
341 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
346 * struct wpa_driver_associate_params - Association parameters
347 * Data for struct wpa_driver_ops::associate().
349 struct wpa_driver_associate_params {
351 * bssid - BSSID of the selected AP
352 * This can be %NULL, if ap_scan=2 mode is used and the driver is
353 * responsible for selecting with which BSS to associate. */
357 * ssid - The selected SSID
362 * ssid_len - Length of the SSID (1..32)
367 * freq - Frequency of the channel the selected AP is using
368 * Frequency that the selected AP is using (in MHz as
369 * reported in the scan results)
374 * bg_scan_period - Background scan period in seconds, 0 to disable
375 * background scan, or -1 to indicate no change to default driver
381 * wpa_ie - WPA information element for (Re)Association Request
382 * WPA information element to be included in (Re)Association
383 * Request (including information element id and length). Use
384 * of this WPA IE is optional. If the driver generates the WPA
385 * IE, it can use pairwise_suite, group_suite, and
386 * key_mgmt_suite to select proper algorithms. In this case,
387 * the driver has to notify wpa_supplicant about the used WPA
388 * IE by generating an event that the interface code will
389 * convert into EVENT_ASSOCINFO data (see below).
391 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
392 * instead. The driver can determine which version is used by
393 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
396 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
401 * wpa_ie_len - length of the wpa_ie
406 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
408 unsigned int wpa_proto;
411 * pairwise_suite - Selected pairwise cipher suite
413 * This is usually ignored if @wpa_ie is used.
415 enum wpa_cipher pairwise_suite;
418 * group_suite - Selected group cipher suite
420 * This is usually ignored if @wpa_ie is used.
422 enum wpa_cipher group_suite;
425 * key_mgmt_suite - Selected key management suite
427 * This is usually ignored if @wpa_ie is used.
429 enum wpa_key_mgmt key_mgmt_suite;
432 * auth_alg - Allowed authentication algorithms
433 * Bit field of WPA_AUTH_ALG_*
438 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
443 * wep_key - WEP keys for static WEP configuration
445 const u8 *wep_key[4];
448 * wep_key_len - WEP key length for static WEP configuration
450 size_t wep_key_len[4];
453 * wep_tx_keyidx - WEP TX key index for static WEP configuration
458 * mgmt_frame_protection - IEEE 802.11w management frame protection
460 enum mfp_options mgmt_frame_protection;
463 * ft_ies - IEEE 802.11r / FT information elements
464 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
465 * for fast transition, this parameter is set to include the IEs that
466 * are to be sent in the next FT Authentication Request message.
467 * update_ft_ies() handler is called to update the IEs for further
468 * FT messages in the sequence.
470 * The driver should use these IEs only if the target AP is advertising
471 * the same mobility domain as the one included in the MDIE here.
473 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
474 * AP after the initial association. These IEs can only be used if the
475 * target AP is advertising support for FT and is using the same MDIE
476 * and SSID as the current AP.
478 * The driver is responsible for reporting the FT IEs received from the
479 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
480 * type. update_ft_ies() handler will then be called with the FT IEs to
481 * include in the next frame in the authentication sequence.
486 * ft_ies_len - Length of ft_ies in bytes
491 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
493 * This value is provided to allow the driver interface easier access
494 * to the current mobility domain. This value is set to %NULL if no
495 * mobility domain is currently active.
500 * passphrase - RSN passphrase for PSK
502 * This value is made available only for WPA/WPA2-Personal (PSK) and
503 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
504 * the 8..63 character ASCII passphrase, if available. Please note that
505 * this can be %NULL if passphrase was not used to generate the PSK. In
506 * that case, the psk field must be used to fetch the PSK.
508 const char *passphrase;
511 * psk - RSN PSK (alternative for passphrase for PSK)
513 * This value is made available only for WPA/WPA2-Personal (PSK) and
514 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
515 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
516 * be prepared to handle %NULL value as an error.
521 * drop_unencrypted - Enable/disable unencrypted frame filtering
523 * Configure the driver to drop all non-EAPOL frames (both receive and
524 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
525 * still be allowed for key negotiation.
527 int drop_unencrypted;
530 * prev_bssid - Previously used BSSID in this ESS
532 * When not %NULL, this is a request to use reassociation instead of
535 const u8 *prev_bssid;
540 * If the driver needs to do special configuration for WPS association,
541 * this variable provides more information on what type of association
542 * is being requested. Most drivers should not need ot use this.
547 * p2p - Whether this connection is a P2P group
552 * uapsd - UAPSD parameters for the network
553 * -1 = do not change defaults
554 * AP mode: 1 = enabled, 0 = disabled
555 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
560 * fixed_bssid - Whether to force this BSSID in IBSS mode
561 * 1 = Fix this BSSID and prevent merges.
562 * 0 = Do not fix BSSID.
567 * disable_ht - Disable HT (IEEE 802.11n) for this connection
572 * HT Capabilities over-rides. Only bits set in the mask will be used,
573 * and not all values are used by the kernel anyway. Currently, MCS,
574 * MPDU and MSDU fields are used.
576 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */
577 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */
579 #ifdef CONFIG_VHT_OVERRIDES
581 * disable_vht - Disable VHT for this connection
586 * VHT capability overrides.
588 const struct ieee80211_vht_capabilities *vhtcaps;
589 const struct ieee80211_vht_capabilities *vhtcaps_mask;
590 #endif /* CONFIG_VHT_OVERRIDES */
595 HIDDEN_SSID_ZERO_LEN,
596 HIDDEN_SSID_ZERO_CONTENTS
599 struct wpa_driver_ap_params {
601 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
606 * head_len - Length of the head buffer in octets
611 * tail - Beacon tail following TIM IE
616 * tail_len - Length of the tail buffer in octets
621 * dtim_period - DTIM period
626 * beacon_int - Beacon interval
631 * basic_rates: -1 terminated array of basic rates in 100 kbps
633 * This parameter can be used to set a specific basic rate set for the
634 * BSS. If %NULL, default basic rate set is used.
639 * proberesp - Probe Response template
641 * This is used by drivers that reply to Probe Requests internally in
642 * AP mode and require the full Probe Response template.
647 * proberesp_len - Length of the proberesp buffer in octets
649 size_t proberesp_len;
652 * ssid - The SSID to use in Beacon/Probe Response frames
657 * ssid_len - Length of the SSID (1..32)
662 * hide_ssid - Whether to hide the SSID
664 enum hide_ssid hide_ssid;
667 * pairwise_ciphers - WPA_CIPHER_* bitfield
669 unsigned int pairwise_ciphers;
672 * group_cipher - WPA_CIPHER_*
674 unsigned int group_cipher;
677 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
679 unsigned int key_mgmt_suites;
682 * auth_algs - WPA_AUTH_ALG_* bitfield
684 unsigned int auth_algs;
687 * wpa_version - WPA_PROTO_* bitfield
689 unsigned int wpa_version;
692 * privacy - Whether privacy is used in the BSS
697 * beacon_ies - WPS/P2P IE(s) for Beacon frames
699 * This is used to add IEs like WPS IE and P2P IE by drivers that do
700 * not use the full Beacon template.
702 const struct wpabuf *beacon_ies;
705 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
707 * This is used to add IEs like WPS IE and P2P IE by drivers that
708 * reply to Probe Request frames internally.
710 const struct wpabuf *proberesp_ies;
713 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
715 * This is used to add IEs like WPS IE by drivers that reply to
716 * (Re)Association Request frames internally.
718 const struct wpabuf *assocresp_ies;
721 * isolate - Whether to isolate frames between associated stations
723 * If this is non-zero, the AP is requested to disable forwarding of
724 * frames between associated stations.
729 * cts_protect - Whether CTS protection is enabled
734 * preamble - Whether short preamble is enabled
739 * short_slot_time - Whether short slot time is enabled
741 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
742 * not set (e.g., when 802.11g mode is not in use)
747 * ht_opmode - HT operation mode or -1 if HT not in use
752 * interworking - Whether Interworking is enabled
757 * hessid - Homogeneous ESS identifier or %NULL if not set
762 * access_network_type - Access Network Type (0..15)
764 * This is used for filtering Probe Request frames when Interworking is
767 u8 access_network_type;
770 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
772 * This is used by driver which advertises this capability.
774 int ap_max_inactivity;
777 * disable_dgaf - Whether group-addressed frames are disabled
783 * struct wpa_driver_capa - Driver capability information
785 struct wpa_driver_capa {
786 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
787 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
788 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
789 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
790 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
791 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
792 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
793 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
794 unsigned int key_mgmt;
796 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
797 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
798 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
799 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
800 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
801 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
804 #define WPA_DRIVER_AUTH_OPEN 0x00000001
805 #define WPA_DRIVER_AUTH_SHARED 0x00000002
806 #define WPA_DRIVER_AUTH_LEAP 0x00000004
809 /* Driver generated WPA/RSN IE */
810 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
811 /* Driver needs static WEP key setup after association command */
812 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
813 /* unused: 0x00000004 */
814 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
815 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
816 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
817 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
818 /* Driver provides separate commands for authentication and association (SME in
819 * wpa_supplicant). */
820 #define WPA_DRIVER_FLAGS_SME 0x00000020
821 /* Driver supports AP mode */
822 #define WPA_DRIVER_FLAGS_AP 0x00000040
823 /* Driver needs static WEP key setup after association has been completed */
824 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
825 /* Driver takes care of P2P management operations */
826 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
827 /* Driver supports concurrent P2P operations */
828 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
830 * Driver uses the initial interface as a dedicated management interface, i.e.,
831 * it cannot be used for P2P group operations or non-P2P purposes.
833 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
834 /* This interface is P2P capable (P2P GO or P2P Client) */
835 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
836 /* Driver supports concurrent operations on multiple channels */
837 #define WPA_DRIVER_FLAGS_MULTI_CHANNEL_CONCURRENT 0x00001000
839 * Driver uses the initial interface for P2P management interface and non-P2P
840 * purposes (e.g., connect to infra AP), but this interface cannot be used for
841 * P2P group operations.
843 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
845 * Driver is known to use sane error codes, i.e., when it indicates that
846 * something (e.g., association) fails, there was indeed a failure and the
847 * operation does not end up getting completed successfully later.
849 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
850 /* Driver supports off-channel TX */
851 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
852 /* Driver indicates TX status events for EAPOL Data frames */
853 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
854 /* Driver indicates TX status events for Deauth/Disassoc frames */
855 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
856 /* Driver supports roaming (BSS selection) in firmware */
857 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
858 /* Driver supports operating as a TDLS peer */
859 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
860 /* Driver requires external TDLS setup/teardown/discovery */
861 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
862 /* Driver indicates support for Probe Response offloading in AP mode */
863 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
864 /* Driver supports U-APSD in AP mode */
865 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
866 /* Driver supports inactivity timer in AP mode */
867 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
868 /* Driver expects user space implementation of MLME in AP mode */
869 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
870 /* Driver supports SAE with user space SME */
871 #define WPA_DRIVER_FLAGS_SAE 0x02000000
872 /* Driver makes use of OBSS scan mechanism in wpa_supplicant */
873 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
874 /* Driver supports IBSS (Ad-hoc) mode */
875 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
876 /* Driver supports radar detection */
877 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
878 /* Driver supports a dedicated interface for P2P Device */
879 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
883 int max_sched_scan_ssids;
884 int sched_scan_supported;
888 * max_remain_on_chan - Maximum remain-on-channel duration in msec
890 unsigned int max_remain_on_chan;
893 * max_stations - Maximum number of associated stations the driver
894 * supports in AP mode
896 unsigned int max_stations;
899 * probe_resp_offloads - Bitmap of supported protocols by the driver
900 * for Probe Response offloading.
902 /* Driver Probe Response offloading support for WPS ver. 1 */
903 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
904 /* Driver Probe Response offloading support for WPS ver. 2 */
905 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
906 /* Driver Probe Response offloading support for P2P */
907 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
908 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
909 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
910 unsigned int probe_resp_offloads;
912 unsigned int max_acl_mac_addrs;
915 * Number of supported concurrent channels
917 unsigned int num_multichan_concurrent;
920 * extended_capa - extended capabilities in driver/device
922 * Must be allocated and freed by driver and the pointers must be
923 * valid for the lifetime of the driver, i.e., freed in deinit()
925 const u8 *extended_capa, *extended_capa_mask;
926 unsigned int extended_capa_len;
932 struct hostap_sta_driver_data {
933 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
934 unsigned long current_tx_rate;
935 unsigned long inactive_msec;
937 unsigned long num_ps_buf_frames;
938 unsigned long tx_retry_failed;
939 unsigned long tx_retry_count;
944 struct hostapd_sta_add_params {
948 const u8 *supp_rates;
949 size_t supp_rates_len;
951 const struct ieee80211_ht_capabilities *ht_capabilities;
952 const struct ieee80211_vht_capabilities *vht_capabilities;
953 u32 flags; /* bitmask of WPA_STA_* flags */
954 int set; /* Set STA parameters instead of add */
957 size_t ext_capab_len;
960 struct hostapd_freq_params {
966 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
967 * secondary channel below primary, 1 = HT40
968 * enabled, secondary channel above primary */
973 /* valid for both HT and VHT, center_freq2 is non-zero
974 * only for bandwidth 80 and an 80+80 channel */
975 int center_freq1, center_freq2;
983 struct hostapd_acl_params {
985 unsigned int num_mac_acl;
986 struct mac_address mac_acl[0];
989 enum wpa_driver_if_type {
991 * WPA_IF_STATION - Station mode interface
996 * WPA_IF_AP_VLAN - AP mode VLAN interface
998 * This interface shares its address and Beacon frame with the main
1004 * WPA_IF_AP_BSS - AP mode BSS interface
1006 * This interface has its own address and Beacon frame.
1011 * WPA_IF_P2P_GO - P2P Group Owner
1016 * WPA_IF_P2P_CLIENT - P2P Client
1021 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1022 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1027 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1028 * abstracted P2P Device function in the driver
1033 struct wpa_init_params {
1039 const char *test_socket;
1040 int use_pae_group_addr;
1044 u8 *own_addr; /* buffer for writing own MAC address */
1048 struct wpa_bss_params {
1049 /** Interface name (for multi-SSID/VLAN support) */
1051 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1060 enum mfp_options ieee80211w;
1063 #define WPA_STA_AUTHORIZED BIT(0)
1064 #define WPA_STA_WMM BIT(1)
1065 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1066 #define WPA_STA_MFP BIT(3)
1067 #define WPA_STA_TDLS_PEER BIT(4)
1070 * struct p2p_params - P2P parameters for driver-based P2P management
1073 const char *dev_name;
1075 #define DRV_MAX_SEC_DEV_TYPES 5
1076 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8];
1077 size_t num_sec_dev_types;
1091 WNM_SLEEP_ENTER_CONFIRM,
1092 WNM_SLEEP_ENTER_FAIL,
1093 WNM_SLEEP_EXIT_CONFIRM,
1094 WNM_SLEEP_EXIT_FAIL,
1095 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1096 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1097 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1099 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1101 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1102 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1104 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1107 /* enum chan_width - Channel width definitions */
1119 * struct wpa_signal_info - Information about channel signal quality
1121 struct wpa_signal_info {
1123 int above_threshold;
1128 enum chan_width chanwidth;
1134 * struct wpa_driver_ops - Driver interface API definition
1136 * This structure defines the API that each driver interface needs to implement
1137 * for core wpa_supplicant code. All driver specific functionality is captured
1140 struct wpa_driver_ops {
1141 /** Name of the driver interface */
1143 /** One line description of the driver interface */
1147 * get_bssid - Get the current BSSID
1148 * @priv: private driver interface data
1149 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1151 * Returns: 0 on success, -1 on failure
1153 * Query kernel driver for the current BSSID and copy it to bssid.
1154 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1157 int (*get_bssid)(void *priv, u8 *bssid);
1160 * get_ssid - Get the current SSID
1161 * @priv: private driver interface data
1162 * @ssid: buffer for SSID (at least 32 bytes)
1164 * Returns: Length of the SSID on success, -1 on failure
1166 * Query kernel driver for the current SSID and copy it to ssid.
1167 * Returning zero is recommended if the STA is not associated.
1169 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1170 * can, at least in theory, contain control characters (including nul)
1171 * and as such, should be processed as binary data, not a printable
1174 int (*get_ssid)(void *priv, u8 *ssid);
1177 * set_key - Configure encryption key
1178 * @ifname: Interface name (for multi-SSID/VLAN support)
1179 * @priv: private driver interface data
1180 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1181 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1183 * %WPA_ALG_NONE clears the key.
1184 * @addr: Address of the peer STA (BSSID of the current AP when setting
1185 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1186 * broadcast keys, %NULL for default keys that are used both for
1187 * broadcast and unicast; when clearing keys, %NULL is used to
1188 * indicate that both the broadcast-only and default key of the
1189 * specified key index is to be cleared
1190 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1192 * @set_tx: configure this key as the default Tx key (only used when
1193 * driver does not support separate unicast/individual key
1194 * @seq: sequence number/packet number, seq_len octets, the next
1195 * packet number to be used for in replay protection; configured
1196 * for Rx keys (in most cases, this is only used with broadcast
1197 * keys and set to zero for unicast keys); %NULL if not set
1198 * @seq_len: length of the seq, depends on the algorithm:
1199 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1200 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1202 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1203 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1205 * Returns: 0 on success, -1 on failure
1207 * Configure the given key for the kernel driver. If the driver
1208 * supports separate individual keys (4 default keys + 1 individual),
1209 * addr can be used to determine whether the key is default or
1210 * individual. If only 4 keys are supported, the default key with key
1211 * index 0 is used as the individual key. STA must be configured to use
1212 * it as the default Tx key (set_tx is set) and accept Rx for all the
1213 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1214 * broadcast keys, so key index 0 is available for this kind of
1217 * Please note that TKIP keys include separate TX and RX MIC keys and
1218 * some drivers may expect them in different order than wpa_supplicant
1219 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1220 * will trigger Michael MIC errors. This can be fixed by changing the
1221 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1222 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1223 * example on how this can be done.
1225 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1226 const u8 *addr, int key_idx, int set_tx,
1227 const u8 *seq, size_t seq_len,
1228 const u8 *key, size_t key_len);
1231 * init - Initialize driver interface
1232 * @ctx: context to be used when calling wpa_supplicant functions,
1233 * e.g., wpa_supplicant_event()
1234 * @ifname: interface name, e.g., wlan0
1236 * Returns: Pointer to private data, %NULL on failure
1238 * Initialize driver interface, including event processing for kernel
1239 * driver events (e.g., associated, scan results, Michael MIC failure).
1240 * This function can allocate a private configuration data area for
1241 * @ctx, file descriptor, interface name, etc. information that may be
1242 * needed in future driver operations. If this is not used, non-NULL
1243 * value will need to be returned because %NULL is used to indicate
1244 * failure. The returned value will be used as 'void *priv' data for
1245 * all other driver_ops functions.
1247 * The main event loop (eloop.c) of wpa_supplicant can be used to
1248 * register callback for read sockets (eloop_register_read_sock()).
1250 * See below for more information about events and
1251 * wpa_supplicant_event() function.
1253 void * (*init)(void *ctx, const char *ifname);
1256 * deinit - Deinitialize driver interface
1257 * @priv: private driver interface data from init()
1259 * Shut down driver interface and processing of driver events. Free
1260 * private data buffer if one was allocated in init() handler.
1262 void (*deinit)(void *priv);
1265 * set_param - Set driver configuration parameters
1266 * @priv: private driver interface data from init()
1267 * @param: driver specific configuration parameters
1269 * Returns: 0 on success, -1 on failure
1271 * Optional handler for notifying driver interface about configuration
1272 * parameters (driver_param).
1274 int (*set_param)(void *priv, const char *param);
1277 * set_countermeasures - Enable/disable TKIP countermeasures
1278 * @priv: private driver interface data
1279 * @enabled: 1 = countermeasures enabled, 0 = disabled
1281 * Returns: 0 on success, -1 on failure
1283 * Configure TKIP countermeasures. When these are enabled, the driver
1284 * should drop all received and queued frames that are using TKIP.
1286 int (*set_countermeasures)(void *priv, int enabled);
1289 * deauthenticate - Request driver to deauthenticate
1290 * @priv: private driver interface data
1291 * @addr: peer address (BSSID of the AP)
1292 * @reason_code: 16-bit reason code to be sent in the deauthentication
1295 * Returns: 0 on success, -1 on failure
1297 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1300 * associate - Request driver to associate
1301 * @priv: private driver interface data
1302 * @params: association parameters
1304 * Returns: 0 on success, -1 on failure
1306 int (*associate)(void *priv,
1307 struct wpa_driver_associate_params *params);
1310 * add_pmkid - Add PMKSA cache entry to the driver
1311 * @priv: private driver interface data
1312 * @bssid: BSSID for the PMKSA cache entry
1313 * @pmkid: PMKID for the PMKSA cache entry
1315 * Returns: 0 on success, -1 on failure
1317 * This function is called when a new PMK is received, as a result of
1318 * either normal authentication or RSN pre-authentication.
1320 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1321 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1322 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1323 * driver_ops function does not need to be implemented. Likewise, if
1324 * the driver does not support WPA, this function is not needed.
1326 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1329 * remove_pmkid - Remove PMKSA cache entry to the driver
1330 * @priv: private driver interface data
1331 * @bssid: BSSID for the PMKSA cache entry
1332 * @pmkid: PMKID for the PMKSA cache entry
1334 * Returns: 0 on success, -1 on failure
1336 * This function is called when the supplicant drops a PMKSA cache
1337 * entry for any reason.
1339 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1340 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1341 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1342 * from wpa_supplicant, this driver_ops function does not need to be
1343 * implemented. Likewise, if the driver does not support WPA, this
1344 * function is not needed.
1346 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1349 * flush_pmkid - Flush PMKSA cache
1350 * @priv: private driver interface data
1352 * Returns: 0 on success, -1 on failure
1354 * This function is called when the supplicant drops all PMKSA cache
1355 * entries for any reason.
1357 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1358 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1359 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1360 * from wpa_supplicant, this driver_ops function does not need to be
1361 * implemented. Likewise, if the driver does not support WPA, this
1362 * function is not needed.
1364 int (*flush_pmkid)(void *priv);
1367 * get_capa - Get driver capabilities
1368 * @priv: private driver interface data
1370 * Returns: 0 on success, -1 on failure
1372 * Get driver/firmware/hardware capabilities.
1374 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1377 * poll - Poll driver for association information
1378 * @priv: private driver interface data
1380 * This is an option callback that can be used when the driver does not
1381 * provide event mechanism for association events. This is called when
1382 * receiving WPA EAPOL-Key messages that require association
1383 * information. The driver interface is supposed to generate associnfo
1384 * event before returning from this callback function. In addition, the
1385 * driver interface should generate an association event after having
1386 * sent out associnfo.
1388 void (*poll)(void *priv);
1391 * get_ifname - Get interface name
1392 * @priv: private driver interface data
1394 * Returns: Pointer to the interface name. This can differ from the
1395 * interface name used in init() call. Init() is called first.
1397 * This optional function can be used to allow the driver interface to
1398 * replace the interface name with something else, e.g., based on an
1399 * interface mapping from a more descriptive name.
1401 const char * (*get_ifname)(void *priv);
1404 * get_mac_addr - Get own MAC address
1405 * @priv: private driver interface data
1407 * Returns: Pointer to own MAC address or %NULL on failure
1409 * This optional function can be used to get the own MAC address of the
1410 * device from the driver interface code. This is only needed if the
1411 * l2_packet implementation for the OS does not provide easy access to
1413 const u8 * (*get_mac_addr)(void *priv);
1416 * send_eapol - Optional function for sending EAPOL packets
1417 * @priv: private driver interface data
1418 * @dest: Destination MAC address
1420 * @data: EAPOL packet starting with IEEE 802.1X header
1421 * @data_len: Size of the EAPOL packet
1423 * Returns: 0 on success, -1 on failure
1425 * This optional function can be used to override l2_packet operations
1426 * with driver specific functionality. If this function pointer is set,
1427 * l2_packet module is not used at all and the driver interface code is
1428 * responsible for receiving and sending all EAPOL packets. The
1429 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1430 * event. The driver interface is required to implement get_mac_addr()
1431 * handler if send_eapol() is used.
1433 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1434 const u8 *data, size_t data_len);
1437 * set_operstate - Sets device operating state to DORMANT or UP
1438 * @priv: private driver interface data
1439 * @state: 0 = dormant, 1 = up
1440 * Returns: 0 on success, -1 on failure
1442 * This is an optional function that can be used on operating systems
1443 * that support a concept of controlling network device state from user
1444 * space applications. This function, if set, gets called with
1445 * state = 1 when authentication has been completed and with state = 0
1446 * when connection is lost.
1448 int (*set_operstate)(void *priv, int state);
1451 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1452 * @priv: Private driver interface data
1453 * @addr: Address of the station for which to set protection (may be
1454 * %NULL for group keys)
1455 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1456 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1457 * Returns: 0 on success, -1 on failure
1459 * This is an optional function that can be used to set the driver to
1460 * require protection for Tx and/or Rx frames. This uses the layer
1461 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1462 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1463 * set protection operation; instead, they set protection implicitly
1464 * based on configured keys.
1466 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1470 * get_hw_feature_data - Get hardware support data (channels and rates)
1471 * @priv: Private driver interface data
1472 * @num_modes: Variable for returning the number of returned modes
1473 * flags: Variable for returning hardware feature flags
1474 * Returns: Pointer to allocated hardware data on success or %NULL on
1475 * failure. Caller is responsible for freeing this.
1477 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1482 * send_mlme - Send management frame from MLME
1483 * @priv: Private driver interface data
1484 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1485 * @data_len: Size of the management frame
1486 * @noack: Do not wait for this frame to be acked (disable retries)
1487 * Returns: 0 on success, -1 on failure
1489 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1493 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1494 * @priv: Private driver interface data
1495 * @md: Mobility domain (2 octets) (also included inside ies)
1496 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1497 * @ies_len: Length of FT IEs in bytes
1498 * Returns: 0 on success, -1 on failure
1500 * The supplicant uses this callback to let the driver know that keying
1501 * material for FT is available and that the driver can use the
1502 * provided IEs in the next message in FT authentication sequence.
1504 * This function is only needed for driver that support IEEE 802.11r
1505 * (Fast BSS Transition).
1507 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1511 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1512 * @priv: Private driver interface data
1513 * @action: Action field value
1514 * @target_ap: Target AP address
1515 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1516 * @ies_len: Length of FT IEs in bytes
1517 * Returns: 0 on success, -1 on failure
1519 * The supplicant uses this callback to request the driver to transmit
1520 * an FT Action frame (action category 6) for over-the-DS fast BSS
1523 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1524 const u8 *ies, size_t ies_len);
1527 * get_scan_results2 - Fetch the latest scan results
1528 * @priv: private driver interface data
1530 * Returns: Allocated buffer of scan results (caller is responsible for
1531 * freeing the data structure) on success, NULL on failure
1533 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1536 * set_country - Set country
1537 * @priv: Private driver interface data
1538 * @alpha2: country to which to switch to
1539 * Returns: 0 on success, -1 on failure
1541 * This function is for drivers which support some form
1542 * of setting a regulatory domain.
1544 int (*set_country)(void *priv, const char *alpha2);
1547 * global_init - Global driver initialization
1548 * Returns: Pointer to private data (global), %NULL on failure
1550 * This optional function is called to initialize the driver wrapper
1551 * for global data, i.e., data that applies to all interfaces. If this
1552 * function is implemented, global_deinit() will also need to be
1553 * implemented to free the private data. The driver will also likely
1554 * use init2() function instead of init() to get the pointer to global
1555 * data available to per-interface initializer.
1557 void * (*global_init)(void);
1560 * global_deinit - Global driver deinitialization
1561 * @priv: private driver global data from global_init()
1563 * Terminate any global driver related functionality and free the
1564 * global data structure.
1566 void (*global_deinit)(void *priv);
1569 * init2 - Initialize driver interface (with global data)
1570 * @ctx: context to be used when calling wpa_supplicant functions,
1571 * e.g., wpa_supplicant_event()
1572 * @ifname: interface name, e.g., wlan0
1573 * @global_priv: private driver global data from global_init()
1574 * Returns: Pointer to private data, %NULL on failure
1576 * This function can be used instead of init() if the driver wrapper
1579 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1582 * get_interfaces - Get information about available interfaces
1583 * @global_priv: private driver global data from global_init()
1584 * Returns: Allocated buffer of interface information (caller is
1585 * responsible for freeing the data structure) on success, NULL on
1588 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1591 * scan2 - Request the driver to initiate scan
1592 * @priv: private driver interface data
1593 * @params: Scan parameters
1595 * Returns: 0 on success, -1 on failure
1597 * Once the scan results are ready, the driver should report scan
1598 * results event for wpa_supplicant which will eventually request the
1599 * results with wpa_driver_get_scan_results2().
1601 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1604 * authenticate - Request driver to authenticate
1605 * @priv: private driver interface data
1606 * @params: authentication parameters
1607 * Returns: 0 on success, -1 on failure
1609 * This is an optional function that can be used with drivers that
1610 * support separate authentication and association steps, i.e., when
1611 * wpa_supplicant can act as the SME. If not implemented, associate()
1612 * function is expected to take care of IEEE 802.11 authentication,
1615 int (*authenticate)(void *priv,
1616 struct wpa_driver_auth_params *params);
1619 * set_ap - Set Beacon and Probe Response information for AP mode
1620 * @priv: Private driver interface data
1621 * @params: Parameters to use in AP mode
1623 * This function is used to configure Beacon template and/or extra IEs
1624 * to add for Beacon and Probe Response frames for the driver in
1625 * AP mode. The driver is responsible for building the full Beacon
1626 * frame by concatenating the head part with TIM IE generated by the
1627 * driver/firmware and finishing with the tail part. Depending on the
1628 * driver architectue, this can be done either by using the full
1629 * template or the set of additional IEs (e.g., WPS and P2P IE).
1630 * Similarly, Probe Response processing depends on the driver design.
1631 * If the driver (or firmware) takes care of replying to Probe Request
1632 * frames, the extra IEs provided here needs to be added to the Probe
1635 * Returns: 0 on success, -1 on failure
1637 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1640 * set_acl - Set ACL in AP mode
1641 * @priv: Private driver interface data
1642 * @params: Parameters to configure ACL
1643 * Returns: 0 on success, -1 on failure
1645 * This is used only for the drivers which support MAC address ACL.
1647 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1650 * hapd_init - Initialize driver interface (hostapd only)
1651 * @hapd: Pointer to hostapd context
1652 * @params: Configuration for the driver wrapper
1653 * Returns: Pointer to private data, %NULL on failure
1655 * This function is used instead of init() or init2() when the driver
1656 * wrapper is used with hostapd.
1658 void * (*hapd_init)(struct hostapd_data *hapd,
1659 struct wpa_init_params *params);
1662 * hapd_deinit - Deinitialize driver interface (hostapd only)
1663 * @priv: Private driver interface data from hapd_init()
1665 void (*hapd_deinit)(void *priv);
1668 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1669 * @priv: Private driver interface data
1670 * @params: BSS parameters
1671 * Returns: 0 on success, -1 on failure
1673 * This is an optional function to configure the kernel driver to
1674 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1675 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1676 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1677 * for Beacon frames.
1679 * DEPRECATED - use set_ap() instead
1681 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1684 * set_privacy - Enable/disable privacy (AP only)
1685 * @priv: Private driver interface data
1686 * @enabled: 1 = privacy enabled, 0 = disabled
1687 * Returns: 0 on success, -1 on failure
1689 * This is an optional function to configure privacy field in the
1690 * kernel driver for Beacon frames. This can be left undefined (set to
1691 * %NULL) if the driver uses the Beacon template from set_ap().
1693 * DEPRECATED - use set_ap() instead
1695 int (*set_privacy)(void *priv, int enabled);
1698 * get_seqnum - Fetch the current TSC/packet number (AP only)
1699 * @ifname: The interface name (main or virtual)
1700 * @priv: Private driver interface data
1701 * @addr: MAC address of the station or %NULL for group keys
1703 * @seq: Buffer for returning the latest used TSC/packet number
1704 * Returns: 0 on success, -1 on failure
1706 * This function is used to fetch the last used TSC/packet number for
1707 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1708 * keys, so there is no strict requirement on implementing support for
1709 * unicast keys (i.e., addr != %NULL).
1711 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1715 * flush - Flush all association stations (AP only)
1716 * @priv: Private driver interface data
1717 * Returns: 0 on success, -1 on failure
1719 * This function requests the driver to disassociate all associated
1720 * stations. This function does not need to be implemented if the
1721 * driver does not process association frames internally.
1723 int (*flush)(void *priv);
1726 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1727 * @priv: Private driver interface data
1728 * @elem: Information elements
1729 * @elem_len: Length of the elem buffer in octets
1730 * Returns: 0 on success, -1 on failure
1732 * This is an optional function to add information elements in the
1733 * kernel driver for Beacon and Probe Response frames. This can be left
1734 * undefined (set to %NULL) if the driver uses the Beacon template from
1737 * DEPRECATED - use set_ap() instead
1739 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1742 * read_sta_data - Fetch station data
1743 * @priv: Private driver interface data
1744 * @data: Buffer for returning station information
1745 * @addr: MAC address of the station
1746 * Returns: 0 on success, -1 on failure
1748 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1752 * hapd_send_eapol - Send an EAPOL packet (AP only)
1753 * @priv: private driver interface data
1754 * @addr: Destination MAC address
1755 * @data: EAPOL packet starting with IEEE 802.1X header
1756 * @data_len: Length of the EAPOL packet in octets
1757 * @encrypt: Whether the frame should be encrypted
1758 * @own_addr: Source MAC address
1759 * @flags: WPA_STA_* flags for the destination station
1761 * Returns: 0 on success, -1 on failure
1763 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1764 size_t data_len, int encrypt,
1765 const u8 *own_addr, u32 flags);
1768 * sta_deauth - Deauthenticate a station (AP only)
1769 * @priv: Private driver interface data
1770 * @own_addr: Source address and BSSID for the Deauthentication frame
1771 * @addr: MAC address of the station to deauthenticate
1772 * @reason: Reason code for the Deauthentiation frame
1773 * Returns: 0 on success, -1 on failure
1775 * This function requests a specific station to be deauthenticated and
1776 * a Deauthentication frame to be sent to it.
1778 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1782 * sta_disassoc - Disassociate a station (AP only)
1783 * @priv: Private driver interface data
1784 * @own_addr: Source address and BSSID for the Disassociation frame
1785 * @addr: MAC address of the station to disassociate
1786 * @reason: Reason code for the Disassociation frame
1787 * Returns: 0 on success, -1 on failure
1789 * This function requests a specific station to be disassociated and
1790 * a Disassociation frame to be sent to it.
1792 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1796 * sta_remove - Remove a station entry (AP only)
1797 * @priv: Private driver interface data
1798 * @addr: MAC address of the station to be removed
1799 * Returns: 0 on success, -1 on failure
1801 int (*sta_remove)(void *priv, const u8 *addr);
1804 * hapd_get_ssid - Get the current SSID (AP only)
1805 * @priv: Private driver interface data
1806 * @buf: Buffer for returning the SSID
1807 * @len: Maximum length of the buffer
1808 * Returns: Length of the SSID on success, -1 on failure
1810 * This function need not be implemented if the driver uses Beacon
1811 * template from set_ap() and does not reply to Probe Request frames.
1813 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1816 * hapd_set_ssid - Set SSID (AP only)
1817 * @priv: Private driver interface data
1819 * @len: Length of the SSID in octets
1820 * Returns: 0 on success, -1 on failure
1822 * DEPRECATED - use set_ap() instead
1824 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1827 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1828 * @priv: Private driver interface data
1829 * @enabled: 1 = countermeasures enabled, 0 = disabled
1830 * Returns: 0 on success, -1 on failure
1832 * This need not be implemented if the driver does not take care of
1833 * association processing.
1835 int (*hapd_set_countermeasures)(void *priv, int enabled);
1838 * sta_add - Add a station entry
1839 * @priv: Private driver interface data
1840 * @params: Station parameters
1841 * Returns: 0 on success, -1 on failure
1843 * This function is used to add a station entry to the driver once the
1844 * station has completed association. This is only used if the driver
1845 * does not take care of association processing.
1847 * With TDLS, this function is also used to add or set (params->set 1)
1848 * TDLS peer entries.
1850 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1853 * get_inact_sec - Get station inactivity duration (AP only)
1854 * @priv: Private driver interface data
1855 * @addr: Station address
1856 * Returns: Number of seconds station has been inactive, -1 on failure
1858 int (*get_inact_sec)(void *priv, const u8 *addr);
1861 * sta_clear_stats - Clear station statistics (AP only)
1862 * @priv: Private driver interface data
1863 * @addr: Station address
1864 * Returns: 0 on success, -1 on failure
1866 int (*sta_clear_stats)(void *priv, const u8 *addr);
1869 * set_freq - Set channel/frequency (AP only)
1870 * @priv: Private driver interface data
1871 * @freq: Channel parameters
1872 * Returns: 0 on success, -1 on failure
1874 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1877 * set_rts - Set RTS threshold
1878 * @priv: Private driver interface data
1879 * @rts: RTS threshold in octets
1880 * Returns: 0 on success, -1 on failure
1882 int (*set_rts)(void *priv, int rts);
1885 * set_frag - Set fragmentation threshold
1886 * @priv: Private driver interface data
1887 * @frag: Fragmentation threshold in octets
1888 * Returns: 0 on success, -1 on failure
1890 int (*set_frag)(void *priv, int frag);
1893 * sta_set_flags - Set station flags (AP only)
1894 * @priv: Private driver interface data
1895 * @addr: Station address
1896 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1897 * @flags_or: Bitmap of WPA_STA_* flags to add
1898 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1899 * Returns: 0 on success, -1 on failure
1901 int (*sta_set_flags)(void *priv, const u8 *addr,
1902 int total_flags, int flags_or, int flags_and);
1905 * set_tx_queue_params - Set TX queue parameters
1906 * @priv: Private driver interface data
1907 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1911 * @burst_time: Maximum length for bursting in 0.1 msec units
1913 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1914 int cw_max, int burst_time);
1917 * if_add - Add a virtual interface
1918 * @priv: Private driver interface data
1919 * @type: Interface type
1920 * @ifname: Interface name for the new virtual interface
1921 * @addr: Local address to use for the interface or %NULL to use the
1922 * parent interface address
1923 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1924 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1925 * not allowed (applies only to %WPA_IF_AP_BSS type)
1926 * @force_ifname: Buffer for returning an interface name that the
1927 * driver ended up using if it differs from the requested ifname
1928 * @if_addr: Buffer for returning the allocated interface address
1929 * (this may differ from the requested addr if the driver cannot
1930 * change interface address)
1931 * @bridge: Bridge interface to use or %NULL if no bridge configured
1932 * Returns: 0 on success, -1 on failure
1934 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1935 const char *ifname, const u8 *addr, void *bss_ctx,
1936 void **drv_priv, char *force_ifname, u8 *if_addr,
1937 const char *bridge);
1940 * if_remove - Remove a virtual interface
1941 * @priv: Private driver interface data
1942 * @type: Interface type
1943 * @ifname: Interface name of the virtual interface to be removed
1944 * Returns: 0 on success, -1 on failure
1946 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1947 const char *ifname);
1950 * set_sta_vlan - Bind a station into a specific interface (AP only)
1951 * @priv: Private driver interface data
1952 * @ifname: Interface (main or virtual BSS or VLAN)
1953 * @addr: MAC address of the associated station
1955 * Returns: 0 on success, -1 on failure
1957 * This function is used to bind a station to a specific virtual
1958 * interface. It is only used if when virtual interfaces are supported,
1959 * e.g., to assign stations to different VLAN interfaces based on
1960 * information from a RADIUS server. This allows separate broadcast
1961 * domains to be used with a single BSS.
1963 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1967 * commit - Optional commit changes handler (AP only)
1968 * @priv: driver private data
1969 * Returns: 0 on success, -1 on failure
1971 * This optional handler function can be registered if the driver
1972 * interface implementation needs to commit changes (e.g., by setting
1973 * network interface up) at the end of initial configuration. If set,
1974 * this handler will be called after initial setup has been completed.
1976 int (*commit)(void *priv);
1979 * send_ether - Send an ethernet packet (AP only)
1980 * @priv: private driver interface data
1981 * @dst: Destination MAC address
1982 * @src: Source MAC address
1984 * @data: EAPOL packet starting with IEEE 802.1X header
1985 * @data_len: Length of the EAPOL packet in octets
1986 * Returns: 0 on success, -1 on failure
1988 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1989 const u8 *data, size_t data_len);
1992 * set_radius_acl_auth - Notification of RADIUS ACL change
1993 * @priv: Private driver interface data
1994 * @mac: MAC address of the station
1995 * @accepted: Whether the station was accepted
1996 * @session_timeout: Session timeout for the station
1997 * Returns: 0 on success, -1 on failure
1999 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2000 u32 session_timeout);
2003 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2004 * @priv: Private driver interface data
2005 * @mac: MAC address of the station
2006 * Returns: 0 on success, -1 on failure
2008 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2011 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2012 * @priv: Private driver interface data
2013 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2014 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2016 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2017 * to remove extra IE(s)
2018 * Returns: 0 on success, -1 on failure
2020 * This is an optional function to add WPS IE in the kernel driver for
2021 * Beacon and Probe Response frames. This can be left undefined (set
2022 * to %NULL) if the driver uses the Beacon template from set_ap()
2023 * and does not process Probe Request frames. If the driver takes care
2024 * of (Re)Association frame processing, the assocresp buffer includes
2025 * WPS IE(s) that need to be added to (Re)Association Response frames
2026 * whenever a (Re)Association Request frame indicated use of WPS.
2028 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2029 * frames when operating as a GO. The driver is responsible for adding
2030 * timing related attributes (e.g., NoA) in addition to the IEs
2031 * included here by appending them after these buffers. This call is
2032 * also used to provide Probe Response IEs for P2P Listen state
2033 * operations for drivers that generate the Probe Response frames
2036 * DEPRECATED - use set_ap() instead
2038 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2039 const struct wpabuf *proberesp,
2040 const struct wpabuf *assocresp);
2043 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2044 * @priv: Private driver interface data
2045 * @authorized: Whether the port is authorized
2046 * Returns: 0 on success, -1 on failure
2048 int (*set_supp_port)(void *priv, int authorized);
2051 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2052 * @priv: Private driver interface data
2053 * @addr: MAC address of the associated station
2054 * @aid: Association ID
2055 * @val: 1 = bind to 4-address WDS; 0 = unbind
2056 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2057 * to indicate that bridge is not to be used
2058 * @ifname_wds: Buffer to return the interface name for the new WDS
2059 * station or %NULL to indicate name is not returned.
2060 * Returns: 0 on success, -1 on failure
2062 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2063 const char *bridge_ifname, char *ifname_wds);
2066 * send_action - Transmit an Action frame
2067 * @priv: Private driver interface data
2068 * @freq: Frequency (in MHz) of the channel
2069 * @wait: Time to wait off-channel for a response (in ms), or zero
2070 * @dst: Destination MAC address (Address 1)
2071 * @src: Source MAC address (Address 2)
2072 * @bssid: BSSID (Address 3)
2074 * @data_len: data length in octets
2075 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2076 * Returns: 0 on success, -1 on failure
2078 * This command can be used to request the driver to transmit an action
2079 * frame to the specified destination.
2081 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2082 * be transmitted on the given channel and the device will wait for a
2083 * response on that channel for the given wait time.
2085 * If the flag is not set, the wait time will be ignored. In this case,
2086 * if a remain-on-channel duration is in progress, the frame must be
2087 * transmitted on that channel; alternatively the frame may be sent on
2088 * the current operational channel (if in associated state in station
2089 * mode or while operating as an AP.)
2091 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2092 const u8 *dst, const u8 *src, const u8 *bssid,
2093 const u8 *data, size_t data_len, int no_cck);
2096 * send_action_cancel_wait - Cancel action frame TX wait
2097 * @priv: Private driver interface data
2099 * This command cancels the wait time associated with sending an action
2100 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2101 * set in the driver flags.
2103 void (*send_action_cancel_wait)(void *priv);
2106 * remain_on_channel - Remain awake on a channel
2107 * @priv: Private driver interface data
2108 * @freq: Frequency (in MHz) of the channel
2109 * @duration: Duration in milliseconds
2110 * Returns: 0 on success, -1 on failure
2112 * This command is used to request the driver to remain awake on the
2113 * specified channel for the specified duration and report received
2114 * Action frames with EVENT_RX_ACTION events. Optionally, received
2115 * Probe Request frames may also be requested to be reported by calling
2116 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2118 * The driver may not be at the requested channel when this function
2119 * returns, i.e., the return code is only indicating whether the
2120 * request was accepted. The caller will need to wait until the
2121 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2122 * completed the channel change. This may take some time due to other
2123 * need for the radio and the caller should be prepared to timing out
2124 * its wait since there are no guarantees on when this request can be
2127 int (*remain_on_channel)(void *priv, unsigned int freq,
2128 unsigned int duration);
2131 * cancel_remain_on_channel - Cancel remain-on-channel operation
2132 * @priv: Private driver interface data
2134 * This command can be used to cancel a remain-on-channel operation
2135 * before its originally requested duration has passed. This could be
2136 * used, e.g., when remain_on_channel() is used to request extra time
2137 * to receive a response to an Action frame and the response is
2138 * received when there is still unneeded time remaining on the
2139 * remain-on-channel operation.
2141 int (*cancel_remain_on_channel)(void *priv);
2144 * probe_req_report - Request Probe Request frames to be indicated
2145 * @priv: Private driver interface data
2146 * @report: Whether to report received Probe Request frames
2147 * Returns: 0 on success, -1 on failure (or if not supported)
2149 * This command can be used to request the driver to indicate when
2150 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2151 * Since this operation may require extra resources, e.g., due to less
2152 * optimal hardware/firmware RX filtering, many drivers may disable
2153 * Probe Request reporting at least in station mode. This command is
2154 * used to notify the driver when the Probe Request frames need to be
2155 * reported, e.g., during remain-on-channel operations.
2157 int (*probe_req_report)(void *priv, int report);
2160 * deinit_ap - Deinitialize AP mode
2161 * @priv: Private driver interface data
2162 * Returns: 0 on success, -1 on failure (or if not supported)
2164 * This optional function can be used to disable AP mode related
2165 * configuration and change the driver mode to station mode to allow
2166 * normal station operations like scanning to be completed.
2168 int (*deinit_ap)(void *priv);
2171 * deinit_p2p_cli - Deinitialize P2P client 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 P2P client mode. It
2176 * can be used to change the interface type back to station mode.
2178 int (*deinit_p2p_cli)(void *priv);
2181 * suspend - Notification on system suspend/hibernate event
2182 * @priv: Private driver interface data
2184 void (*suspend)(void *priv);
2187 * resume - Notification on system resume/thaw event
2188 * @priv: Private driver interface data
2190 void (*resume)(void *priv);
2193 * signal_monitor - Set signal monitoring parameters
2194 * @priv: Private driver interface data
2195 * @threshold: Threshold value for signal change events; 0 = disabled
2196 * @hysteresis: Minimum change in signal strength before indicating a
2198 * Returns: 0 on success, -1 on failure (or if not supported)
2200 * This function can be used to configure monitoring of signal strength
2201 * with the current AP. Whenever signal strength drops below the
2202 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2203 * should be generated assuming the signal strength has changed at
2204 * least %hysteresis from the previously indicated signal change event.
2206 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2209 * send_frame - Send IEEE 802.11 frame (testing use only)
2210 * @priv: Private driver interface data
2211 * @data: IEEE 802.11 frame with IEEE 802.11 header
2212 * @data_len: Size of the frame
2213 * @encrypt: Whether to encrypt the frame (if keys are set)
2214 * Returns: 0 on success, -1 on failure
2216 * This function is only used for debugging purposes and is not
2217 * required to be implemented for normal operations.
2219 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2223 * shared_freq - Get operating frequency of shared interface(s)
2224 * @priv: Private driver interface data
2225 * Returns: Operating frequency in MHz, 0 if no shared operation in
2226 * use, or -1 on failure
2228 * This command can be used to request the current operating frequency
2229 * of any virtual interface that shares the same radio to provide
2230 * information for channel selection for other virtual interfaces.
2232 int (*shared_freq)(void *priv);
2235 * get_noa - Get current Notice of Absence attribute payload
2236 * @priv: Private driver interface data
2237 * @buf: Buffer for returning NoA
2238 * @buf_len: Buffer length in octets
2239 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2240 * advertized, or -1 on failure
2242 * This function is used to fetch the current Notice of Absence
2243 * attribute value from GO.
2245 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2248 * set_noa - Set Notice of Absence parameters for GO (testing)
2249 * @priv: Private driver interface data
2251 * @start: Start time in ms from next TBTT
2252 * @duration: Duration in ms
2253 * Returns: 0 on success or -1 on failure
2255 * This function is used to set Notice of Absence parameters for GO. It
2256 * is used only for testing. To disable NoA, all parameters are set to
2259 int (*set_noa)(void *priv, u8 count, int start, int duration);
2262 * set_p2p_powersave - Set P2P power save options
2263 * @priv: Private driver interface data
2264 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2265 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2266 * @ctwindow: 0.. = change (msec), -1 = no change
2267 * Returns: 0 on success or -1 on failure
2269 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2273 * ampdu - Enable/disable aggregation
2274 * @priv: Private driver interface data
2275 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2276 * Returns: 0 on success or -1 on failure
2278 int (*ampdu)(void *priv, int ampdu);
2281 * get_radio_name - Get physical radio name for the device
2282 * @priv: Private driver interface data
2283 * Returns: Radio name or %NULL if not known
2285 * The returned data must not be modified by the caller. It is assumed
2286 * that any interface that has the same radio name as another is
2287 * sharing the same physical radio. This information can be used to
2288 * share scan results etc. information between the virtual interfaces
2289 * to speed up various operations.
2291 const char * (*get_radio_name)(void *priv);
2294 * p2p_find - Start P2P Device Discovery
2295 * @priv: Private driver interface data
2296 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2297 * @type: Device Discovery type (enum p2p_discovery_type)
2298 * Returns: 0 on success, -1 on failure
2300 * This function is only used if the driver implements P2P management,
2301 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2302 * struct wpa_driver_capa.
2304 int (*p2p_find)(void *priv, unsigned int timeout, int type);
2307 * p2p_stop_find - Stop P2P Device Discovery
2308 * @priv: Private driver interface data
2309 * Returns: 0 on success, -1 on failure
2311 * This function is only used if the driver implements P2P management,
2312 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2313 * struct wpa_driver_capa.
2315 int (*p2p_stop_find)(void *priv);
2318 * p2p_listen - Start P2P Listen state for specified duration
2319 * @priv: Private driver interface data
2320 * @timeout: Listen state duration in milliseconds
2321 * Returns: 0 on success, -1 on failure
2323 * This function can be used to request the P2P module to keep the
2324 * device discoverable on the listen channel for an extended set of
2325 * time. At least in its current form, this is mainly used for testing
2326 * purposes and may not be of much use for normal P2P operations.
2328 * This function is only used if the driver implements P2P management,
2329 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2330 * struct wpa_driver_capa.
2332 int (*p2p_listen)(void *priv, unsigned int timeout);
2335 * p2p_connect - Start P2P group formation (GO negotiation)
2336 * @priv: Private driver interface data
2337 * @peer_addr: MAC address of the peer P2P client
2338 * @wps_method: enum p2p_wps_method value indicating config method
2339 * @go_intent: Local GO intent value (1..15)
2340 * @own_interface_addr: Intended interface address to use with the
2342 * @force_freq: The only allowed channel frequency in MHz or 0
2343 * @persistent_group: Whether to create persistent group
2344 * Returns: 0 on success, -1 on failure
2346 * This function is only used if the driver implements P2P management,
2347 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2348 * struct wpa_driver_capa.
2350 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method,
2351 int go_intent, const u8 *own_interface_addr,
2352 unsigned int force_freq, int persistent_group);
2355 * wps_success_cb - Report successfully completed WPS provisioning
2356 * @priv: Private driver interface data
2357 * @peer_addr: Peer address
2358 * Returns: 0 on success, -1 on failure
2360 * This function is used to report successfully completed WPS
2361 * provisioning during group formation in both GO/Registrar and
2362 * client/Enrollee roles.
2364 * This function is only used if the driver implements P2P management,
2365 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2366 * struct wpa_driver_capa.
2368 int (*wps_success_cb)(void *priv, const u8 *peer_addr);
2371 * p2p_group_formation_failed - Report failed WPS provisioning
2372 * @priv: Private driver interface data
2373 * Returns: 0 on success, -1 on failure
2375 * This function is used to report failed group formation. This can
2376 * happen either due to failed WPS provisioning or due to 15 second
2377 * timeout during the provisioning phase.
2379 * This function is only used if the driver implements P2P management,
2380 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2381 * struct wpa_driver_capa.
2383 int (*p2p_group_formation_failed)(void *priv);
2386 * p2p_set_params - Set P2P parameters
2387 * @priv: Private driver interface data
2388 * @params: P2P parameters
2389 * Returns: 0 on success, -1 on failure
2391 * This function is only used if the driver implements P2P management,
2392 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2393 * struct wpa_driver_capa.
2395 int (*p2p_set_params)(void *priv, const struct p2p_params *params);
2398 * p2p_prov_disc_req - Send Provision Discovery Request
2399 * @priv: Private driver interface data
2400 * @peer_addr: MAC address of the peer P2P client
2401 * @config_methods: WPS Config Methods value (only one bit set)
2402 * Returns: 0 on success, -1 on failure
2404 * This function can be used to request a discovered P2P peer to
2405 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2406 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2407 * Provision Discovery Request frame is transmitted once immediately
2408 * and if no response is received, the frame will be sent again
2409 * whenever the target device is discovered during device dsicovery
2410 * (start with a p2p_find() call). Response from the peer is indicated
2411 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2413 * This function is only used if the driver implements P2P management,
2414 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2415 * struct wpa_driver_capa.
2417 int (*p2p_prov_disc_req)(void *priv, const u8 *peer_addr,
2418 u16 config_methods, int join);
2421 * p2p_sd_request - Schedule a service discovery query
2422 * @priv: Private driver interface data
2423 * @dst: Destination peer or %NULL to apply for all peers
2424 * @tlvs: P2P Service Query TLV(s)
2425 * Returns: Reference to the query or 0 on failure
2427 * Response to the query is indicated with the
2428 * EVENT_P2P_SD_RESPONSE driver event.
2430 * This function is only used if the driver implements P2P management,
2431 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2432 * struct wpa_driver_capa.
2434 u64 (*p2p_sd_request)(void *priv, const u8 *dst,
2435 const struct wpabuf *tlvs);
2438 * p2p_sd_cancel_request - Cancel a pending service discovery query
2439 * @priv: Private driver interface data
2440 * @req: Query reference from p2p_sd_request()
2441 * Returns: 0 on success, -1 on failure
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 int (*p2p_sd_cancel_request)(void *priv, u64 req);
2450 * p2p_sd_response - Send response to a service discovery query
2451 * @priv: Private driver interface data
2452 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2453 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2454 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2455 * @resp_tlvs: P2P Service Response TLV(s)
2456 * Returns: 0 on success, -1 on failure
2458 * This function is called as a response to the request indicated with
2459 * the EVENT_P2P_SD_REQUEST driver event.
2461 * This function is only used if the driver implements P2P management,
2462 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2463 * struct wpa_driver_capa.
2465 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst,
2467 const struct wpabuf *resp_tlvs);
2470 * p2p_service_update - Indicate a change in local services
2471 * @priv: Private driver interface data
2472 * Returns: 0 on success, -1 on failure
2474 * This function needs to be called whenever there is a change in
2475 * availability of the local services. This will increment the
2476 * Service Update Indicator value which will be used in SD Request and
2479 * This function is only used if the driver implements P2P management,
2480 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2481 * struct wpa_driver_capa.
2483 int (*p2p_service_update)(void *priv);
2486 * p2p_reject - Reject peer device (explicitly block connections)
2487 * @priv: Private driver interface data
2488 * @addr: MAC address of the peer
2489 * Returns: 0 on success, -1 on failure
2491 int (*p2p_reject)(void *priv, const u8 *addr);
2494 * p2p_invite - Invite a P2P Device into a group
2495 * @priv: Private driver interface data
2496 * @peer: Device Address of the peer P2P Device
2497 * @role: Local role in the group
2498 * @bssid: Group BSSID or %NULL if not known
2500 * @ssid_len: Length of ssid in octets
2501 * @go_dev_addr: Forced GO Device Address or %NULL if none
2502 * @persistent_group: Whether this is to reinvoke a persistent group
2503 * Returns: 0 on success, -1 on failure
2505 int (*p2p_invite)(void *priv, const u8 *peer, int role,
2506 const u8 *bssid, const u8 *ssid, size_t ssid_len,
2507 const u8 *go_dev_addr, int persistent_group);
2510 * send_tdls_mgmt - for sending TDLS management packets
2511 * @priv: private driver interface data
2512 * @dst: Destination (peer) MAC address
2513 * @action_code: TDLS action code for the mssage
2514 * @dialog_token: Dialog Token to use in the message (if needed)
2515 * @status_code: Status Code or Reason Code to use (if needed)
2516 * @buf: TDLS IEs to add to the message
2517 * @len: Length of buf in octets
2518 * Returns: 0 on success, negative (<0) on failure
2520 * This optional function can be used to send packet to driver which is
2521 * responsible for receiving and sending all TDLS packets.
2523 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2524 u8 dialog_token, u16 status_code,
2525 const u8 *buf, size_t len);
2528 * tdls_oper - Ask the driver to perform high-level TDLS operations
2529 * @priv: Private driver interface data
2530 * @oper: TDLS high-level operation. See %enum tdls_oper
2531 * @peer: Destination (peer) MAC address
2532 * Returns: 0 on success, negative (<0) on failure
2534 * This optional function can be used to send high-level TDLS commands
2537 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2540 * wnm_oper - Notify driver of the WNM frame reception
2541 * @priv: Private driver interface data
2542 * @oper: WNM operation. See %enum wnm_oper
2543 * @peer: Destination (peer) MAC address
2544 * @buf: Buffer for the driver to fill in (for getting IE)
2545 * @buf_len: Return the len of buf
2546 * Returns: 0 on success, negative (<0) on failure
2548 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2549 u8 *buf, u16 *buf_len);
2552 * signal_poll - Get current connection information
2553 * @priv: Private driver interface data
2554 * @signal_info: Connection info structure
2556 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2559 * set_authmode - Set authentication algorithm(s) for static WEP
2560 * @priv: Private driver interface data
2561 * @authmode: 1=Open System, 2=Shared Key, 3=both
2562 * Returns: 0 on success, -1 on failure
2564 * This function can be used to set authentication algorithms for AP
2565 * mode when static WEP is used. If the driver uses user space MLME/SME
2566 * implementation, there is no need to implement this function.
2568 * DEPRECATED - use set_ap() instead
2570 int (*set_authmode)(void *priv, int authmode);
2573 * set_rekey_info - Set rekey information
2574 * @priv: Private driver interface data
2577 * @replay_ctr: Current EAPOL-Key Replay Counter
2579 * This optional function can be used to provide information for the
2580 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2581 * while the host (including wpa_supplicant) is sleeping.
2583 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2584 const u8 *replay_ctr);
2587 * sta_assoc - Station association indication
2588 * @priv: Private driver interface data
2589 * @own_addr: Source address and BSSID for association frame
2590 * @addr: MAC address of the station to associate
2591 * @reassoc: flag to indicate re-association
2592 * @status: association response status code
2593 * @ie: assoc response ie buffer
2594 * @len: ie buffer length
2595 * Returns: 0 on success, -1 on failure
2597 * This function indicates the driver to send (Re)Association
2598 * Response frame to the station.
2600 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2601 int reassoc, u16 status, const u8 *ie, size_t len);
2604 * sta_auth - Station authentication indication
2605 * @priv: Private driver interface data
2606 * @own_addr: Source address and BSSID for authentication frame
2607 * @addr: MAC address of the station to associate
2608 * @seq: authentication sequence number
2609 * @status: authentication response status code
2610 * @ie: authentication frame ie buffer
2611 * @len: ie buffer length
2613 * This function indicates the driver to send Authentication frame
2616 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2617 u16 seq, u16 status, const u8 *ie, size_t len);
2620 * add_tspec - Add traffic stream
2621 * @priv: Private driver interface data
2622 * @addr: MAC address of the station to associate
2623 * @tspec_ie: tspec ie buffer
2624 * @tspec_ielen: tspec ie length
2625 * Returns: 0 on success, -1 on failure
2627 * This function adds the traffic steam for the station
2628 * and fills the medium_time in tspec_ie.
2630 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2631 size_t tspec_ielen);
2634 * add_sta_node - Add a station node in the driver
2635 * @priv: Private driver interface data
2636 * @addr: MAC address of the station to add
2637 * @auth_alg: authentication algorithm used by the station
2638 * Returns: 0 on success, -1 on failure
2640 * This function adds the station node in the driver, when
2641 * the station gets added by FT-over-DS.
2643 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2646 * sched_scan - Request the driver to initiate scheduled scan
2647 * @priv: Private driver interface data
2648 * @params: Scan parameters
2649 * @interval: Interval between scan cycles in milliseconds
2650 * Returns: 0 on success, -1 on failure
2652 * This operation should be used for scheduled scan offload to
2653 * the hardware. Every time scan results are available, the
2654 * driver should report scan results event for wpa_supplicant
2655 * which will eventually request the results with
2656 * wpa_driver_get_scan_results2(). This operation is optional
2657 * and if not provided or if it returns -1, we fall back to
2658 * normal host-scheduled scans.
2660 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2664 * stop_sched_scan - Request the driver to stop a scheduled scan
2665 * @priv: Private driver interface data
2666 * Returns: 0 on success, -1 on failure
2668 * This should cause the scheduled scan to be stopped and
2669 * results should stop being sent. Must be supported if
2670 * sched_scan is supported.
2672 int (*stop_sched_scan)(void *priv);
2675 * poll_client - Probe (null data or such) the given station
2676 * @priv: Private driver interface data
2677 * @own_addr: MAC address of sending interface
2678 * @addr: MAC address of the station to probe
2679 * @qos: Indicates whether station is QoS station
2681 * This function is used to verify whether an associated station is
2682 * still present. This function does not need to be implemented if the
2683 * driver provides such inactivity polling mechanism.
2685 void (*poll_client)(void *priv, const u8 *own_addr,
2686 const u8 *addr, int qos);
2689 * radio_disable - Disable/enable radio
2690 * @priv: Private driver interface data
2691 * @disabled: 1=disable 0=enable radio
2692 * Returns: 0 on success, -1 on failure
2694 * This optional command is for testing purposes. It can be used to
2695 * disable the radio on a testbed device to simulate out-of-radio-range
2698 int (*radio_disable)(void *priv, int disabled);
2701 * switch_channel - Announce channel switch and migrate the GO to the
2703 * @priv: Private driver interface data
2704 * @freq: Frequency in MHz
2705 * Returns: 0 on success, -1 on failure
2707 * This function is used to move the GO to the legacy STA channel to
2708 * avoid frequency conflict in single channel concurrency.
2710 int (*switch_channel)(void *priv, unsigned int freq);
2713 * start_dfs_cac - Listen for radar interference on the channel
2714 * @priv: Private driver interface data
2715 * @freq: Frequency (in MHz) of the channel
2716 * Returns: 0 on success, -1 on failure
2718 int (*start_dfs_cac)(void *priv, int freq);
2721 * stop_ap - Removes beacon from AP
2722 * @priv: Private driver interface data
2723 * Returns: 0 on success, -1 on failure (or if not supported)
2725 * This optional function can be used to disable AP mode related
2726 * configuration. Unlike deinit_ap, it does not change to station
2729 int (*stop_ap)(void *priv);
2734 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2736 enum wpa_event_type {
2738 * EVENT_ASSOC - Association completed
2740 * This event needs to be delivered when the driver completes IEEE
2741 * 802.11 association or reassociation successfully.
2742 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2743 * after this event has been generated. In addition, optional
2744 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2745 * more information about the association. If the driver interface gets
2746 * both of these events at the same time, it can also include the
2747 * assoc_info data in EVENT_ASSOC call.
2752 * EVENT_DISASSOC - Association lost
2754 * This event should be called when association is lost either due to
2755 * receiving deauthenticate or disassociate frame from the AP or when
2756 * sending either of these frames to the current AP. If the driver
2757 * supports separate deauthentication event, EVENT_DISASSOC should only
2758 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2759 * In AP mode, union wpa_event_data::disassoc_info is required.
2764 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2766 * This event must be delivered when a Michael MIC error is detected by
2767 * the local driver. Additional data for event processing is
2768 * provided with union wpa_event_data::michael_mic_failure. This
2769 * information is used to request new encyption key and to initiate
2770 * TKIP countermeasures if needed.
2772 EVENT_MICHAEL_MIC_FAILURE,
2775 * EVENT_SCAN_RESULTS - Scan results available
2777 * This event must be called whenever scan results are available to be
2778 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2779 * is expected to be used some time after struct wpa_driver_ops::scan()
2780 * is called. If the driver provides an unsolicited event when the scan
2781 * has been completed, this event can be used to trigger
2782 * EVENT_SCAN_RESULTS call. If such event is not available from the
2783 * driver, the driver wrapper code is expected to use a registered
2784 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2785 * scan is expected to be completed. Optional information about
2786 * completed scan can be provided with union wpa_event_data::scan_info.
2791 * EVENT_ASSOCINFO - Report optional extra information for association
2793 * This event can be used to report extra association information for
2794 * EVENT_ASSOC processing. This extra information includes IEs from
2795 * association frames and Beacon/Probe Response frames in union
2796 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2797 * EVENT_ASSOC. Alternatively, the driver interface can include
2798 * assoc_info data in the EVENT_ASSOC call if it has all the
2799 * information available at the same point.
2804 * EVENT_INTERFACE_STATUS - Report interface status changes
2806 * This optional event can be used to report changes in interface
2807 * status (interface added/removed) using union
2808 * wpa_event_data::interface_status. This can be used to trigger
2809 * wpa_supplicant to stop and re-start processing for the interface,
2810 * e.g., when a cardbus card is ejected/inserted.
2812 EVENT_INTERFACE_STATUS,
2815 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2817 * This event can be used to inform wpa_supplicant about candidates for
2818 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2819 * for scan request (ap_scan=2 mode), this event is required for
2820 * pre-authentication. If wpa_supplicant is performing scan request
2821 * (ap_scan=1), this event is optional since scan results can be used
2822 * to add pre-authentication candidates. union
2823 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2824 * candidate and priority of the candidate, e.g., based on the signal
2825 * strength, in order to try to pre-authenticate first with candidates
2826 * that are most likely targets for re-association.
2828 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2829 * on the candidate list. In addition, it can be called for the current
2830 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2831 * will automatically skip pre-authentication in cases where a valid
2832 * PMKSA exists. When more than one candidate exists, this event should
2833 * be generated once for each candidate.
2835 * Driver will be notified about successful pre-authentication with
2836 * struct wpa_driver_ops::add_pmkid() calls.
2838 EVENT_PMKID_CANDIDATE,
2841 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2843 * This event can be used to inform wpa_supplicant about desire to set
2844 * up secure direct link connection between two stations as defined in
2845 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2846 * STAKey negotiation. The caller will need to set peer address for the
2852 * EVENT_TDLS - Request TDLS operation
2854 * This event can be used to request a TDLS operation to be performed.
2859 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2861 * The driver is expected to report the received FT IEs from
2862 * FT authentication sequence from the AP. The FT IEs are included in
2863 * the extra information in union wpa_event_data::ft_ies.
2868 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2870 * The driver can use this event to inform wpa_supplicant about a STA
2871 * in an IBSS with which protected frames could be exchanged. This
2872 * event starts RSN authentication with the other STA to authenticate
2873 * the STA and set up encryption keys with it.
2875 EVENT_IBSS_RSN_START,
2878 * EVENT_AUTH - Authentication result
2880 * This event should be called when authentication attempt has been
2881 * completed. This is only used if the driver supports separate
2882 * authentication step (struct wpa_driver_ops::authenticate).
2883 * Information about authentication result is included in
2884 * union wpa_event_data::auth.
2889 * EVENT_DEAUTH - Authentication lost
2891 * This event should be called when authentication is lost either due
2892 * to receiving deauthenticate frame from the AP or when sending that
2893 * frame to the current AP.
2894 * In AP mode, union wpa_event_data::deauth_info is required.
2899 * EVENT_ASSOC_REJECT - Association rejected
2901 * This event should be called when (re)association attempt has been
2902 * rejected by the AP. Information about the association response is
2903 * included in union wpa_event_data::assoc_reject.
2908 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2910 EVENT_AUTH_TIMED_OUT,
2913 * EVENT_ASSOC_TIMED_OUT - Association timed out
2915 EVENT_ASSOC_TIMED_OUT,
2918 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2923 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2925 EVENT_WPS_BUTTON_PUSHED,
2928 * EVENT_TX_STATUS - Report TX status
2933 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
2935 EVENT_RX_FROM_UNKNOWN,
2938 * EVENT_RX_MGMT - Report RX of a management frame
2943 * EVENT_RX_ACTION - Action frame received
2945 * This event is used to indicate when an Action frame has been
2946 * received. Information about the received frame is included in
2947 * union wpa_event_data::rx_action.
2952 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
2954 * This event is used to indicate when the driver has started the
2955 * requested remain-on-channel duration. Information about the
2956 * operation is included in union wpa_event_data::remain_on_channel.
2958 EVENT_REMAIN_ON_CHANNEL,
2961 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
2963 * This event is used to indicate when the driver has completed
2964 * remain-on-channel duration, i.e., may noot be available on the
2965 * requested channel anymore. Information about the
2966 * operation is included in union wpa_event_data::remain_on_channel.
2968 EVENT_CANCEL_REMAIN_ON_CHANNEL,
2971 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2973 * This event is used only by driver_test.c and userspace MLME.
2978 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2980 * This event is used to indicate when a Probe Request frame has been
2981 * received. Information about the received frame is included in
2982 * union wpa_event_data::rx_probe_req. The driver is required to report
2983 * these events only after successfully completed probe_req_report()
2984 * commands to request the events (i.e., report parameter is non-zero)
2985 * in station mode. In AP mode, Probe Request frames should always be
2991 * EVENT_NEW_STA - New wired device noticed
2993 * This event is used to indicate that a new device has been detected
2994 * in a network that does not use association-like functionality (i.e.,
2995 * mainly wired Ethernet). This can be used to start EAPOL
2996 * authenticator when receiving a frame from a device. The address of
2997 * the device is included in union wpa_event_data::new_sta.
3002 * EVENT_EAPOL_RX - Report received EAPOL frame
3004 * When in AP mode with hostapd, this event is required to be used to
3005 * deliver the receive EAPOL frames from the driver. With
3006 * %wpa_supplicant, this event is used only if the send_eapol() handler
3007 * is used to override the use of l2_packet for EAPOL frame TX.
3012 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3014 * This event is used to indicate changes in the signal strength
3015 * observed in frames received from the current AP if signal strength
3016 * monitoring has been enabled with signal_monitor().
3018 EVENT_SIGNAL_CHANGE,
3021 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3023 * This event is used to indicate that the interface was enabled after
3024 * having been previously disabled, e.g., due to rfkill.
3026 EVENT_INTERFACE_ENABLED,
3029 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3031 * This event is used to indicate that the interface was disabled,
3032 * e.g., due to rfkill.
3034 EVENT_INTERFACE_DISABLED,
3037 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3039 * This event is used to indicate that the channel list has changed,
3040 * e.g., because of a regulatory domain change triggered by scan
3041 * results including an AP advertising a country code.
3043 EVENT_CHANNEL_LIST_CHANGED,
3046 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3048 * This event is used to indicate that the driver cannot maintain this
3049 * interface in its operation mode anymore. The most likely use for
3050 * this is to indicate that AP mode operation is not available due to
3051 * operating channel would need to be changed to a DFS channel when
3052 * the driver does not support radar detection and another virtual
3053 * interfaces caused the operating channel to change. Other similar
3054 * resource conflicts could also trigger this for station mode
3057 EVENT_INTERFACE_UNAVAILABLE,
3060 * EVENT_BEST_CHANNEL
3062 * Driver generates this event whenever it detects a better channel
3063 * (e.g., based on RSSI or channel use). This information can be used
3064 * to improve channel selection for a new AP/P2P group.
3069 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3071 * This event should be called when a Deauthentication frame is dropped
3072 * due to it not being protected (MFP/IEEE 802.11w).
3073 * union wpa_event_data::unprot_deauth is required to provide more
3074 * details of the frame.
3076 EVENT_UNPROT_DEAUTH,
3079 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3081 * This event should be called when a Disassociation frame is dropped
3082 * due to it not being protected (MFP/IEEE 802.11w).
3083 * union wpa_event_data::unprot_disassoc is required to provide more
3084 * details of the frame.
3086 EVENT_UNPROT_DISASSOC,
3089 * EVENT_STATION_LOW_ACK
3091 * Driver generates this event whenever it detected that a particular
3092 * station was lost. Detection can be through massive transmission
3093 * failures for example.
3095 EVENT_STATION_LOW_ACK,
3098 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
3100 * This event is used only if the driver implements P2P management
3101 * internally. Event data is stored in
3102 * union wpa_event_data::p2p_dev_found.
3104 EVENT_P2P_DEV_FOUND,
3107 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
3109 * This event is used only if the driver implements P2P management
3110 * internally. Event data is stored in
3111 * union wpa_event_data::p2p_go_neg_req_rx.
3113 EVENT_P2P_GO_NEG_REQ_RX,
3116 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
3118 * This event is used only if the driver implements P2P management
3119 * internally. Event data is stored in
3120 * union wpa_event_data::p2p_go_neg_completed.
3122 EVENT_P2P_GO_NEG_COMPLETED,
3124 EVENT_P2P_PROV_DISC_REQUEST,
3125 EVENT_P2P_PROV_DISC_RESPONSE,
3126 EVENT_P2P_SD_REQUEST,
3127 EVENT_P2P_SD_RESPONSE,
3130 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3132 EVENT_IBSS_PEER_LOST,
3135 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3137 * This event carries the new replay counter to notify wpa_supplicant
3138 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3139 * completed Group Key Handshake while the host (including
3140 * wpa_supplicant was sleeping).
3142 EVENT_DRIVER_GTK_REKEY,
3145 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3147 EVENT_SCHED_SCAN_STOPPED,
3150 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3152 * This event indicates that the station responded to the poll
3153 * initiated with @poll_client.
3155 EVENT_DRIVER_CLIENT_POLL_OK,
3158 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3160 EVENT_EAPOL_TX_STATUS,
3163 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3165 * Described in wpa_event_data.ch_switch
3170 * EVENT_WNM - Request WNM operation
3172 * This event can be used to request a WNM operation to be performed.
3177 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3179 * This event indicates that the driver reported a connection failure
3180 * with the specified client (for example, max client reached, etc.) in
3183 EVENT_CONNECT_FAILED_REASON,
3186 * EVENT_RADAR_DETECTED - Notify of radar detection
3188 * A radar has been detected on the supplied frequency, hostapd should
3189 * react accordingly (e.g., change channel).
3191 EVENT_DFS_RADAR_DETECTED,
3194 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3196 * After a successful CAC, the channel can be marked clear and used.
3198 EVENT_DFS_CAC_FINISHED,
3201 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3203 * The CAC was not successful, and the channel remains in the previous
3204 * state. This may happen due to a radar beeing detected or other
3205 * external influences.
3207 EVENT_DFS_CAC_ABORTED,
3210 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3212 * The channel which was previously unavailable is now available again.
3214 EVENT_DFS_NOP_FINISHED
3219 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3221 union wpa_event_data {
3223 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3225 * This structure is optional for EVENT_ASSOC calls and required for
3226 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3227 * driver interface does not need to generate separate EVENT_ASSOCINFO
3232 * reassoc - Flag to indicate association or reassociation
3237 * req_ies - (Re)Association Request IEs
3239 * If the driver generates WPA/RSN IE, this event data must be
3240 * returned for WPA handshake to have needed information. If
3241 * wpa_supplicant-generated WPA/RSN IE is used, this
3242 * information event is optional.
3244 * This should start with the first IE (fixed fields before IEs
3245 * are not included).
3250 * req_ies_len - Length of req_ies in bytes
3255 * resp_ies - (Re)Association Response IEs
3257 * Optional association data from the driver. This data is not
3258 * required WPA, but may be useful for some protocols and as
3259 * such, should be reported if this is available to the driver
3262 * This should start with the first IE (fixed fields before IEs
3263 * are not included).
3268 * resp_ies_len - Length of resp_ies in bytes
3270 size_t resp_ies_len;
3273 * beacon_ies - Beacon or Probe Response IEs
3275 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3276 * Probe Response frames from the current AP (i.e., the one
3277 * that the client just associated with). This information is
3278 * used to update WPA/RSN IE for the AP. If this field is not
3279 * set, the results from previous scan will be used. If no
3280 * data for the new AP is found, scan results will be requested
3281 * again (without scan request). At this point, the driver is
3282 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3285 * This should start with the first IE (fixed fields before IEs
3286 * are not included).
3288 const u8 *beacon_ies;
3291 * beacon_ies_len - Length of beacon_ies */
3292 size_t beacon_ies_len;
3295 * freq - Frequency of the operational channel in MHz
3300 * addr - Station address (for AP mode)
3306 * struct disassoc_info - Data for EVENT_DISASSOC events
3308 struct disassoc_info {
3310 * addr - Station address (for AP mode)
3315 * reason_code - Reason Code (host byte order) used in
3316 * Deauthentication frame
3321 * ie - Optional IE(s) in Disassociation frame
3326 * ie_len - Length of ie buffer in octets
3331 * locally_generated - Whether the frame was locally generated
3333 int locally_generated;
3337 * struct deauth_info - Data for EVENT_DEAUTH events
3339 struct deauth_info {
3341 * addr - Station address (for AP mode)
3346 * reason_code - Reason Code (host byte order) used in
3347 * Deauthentication frame
3352 * ie - Optional IE(s) in Deauthentication frame
3357 * ie_len - Length of ie buffer in octets
3362 * locally_generated - Whether the frame was locally generated
3364 int locally_generated;
3368 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3370 struct michael_mic_failure {
3373 } michael_mic_failure;
3376 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3378 struct interface_status {
3381 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3386 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3388 struct pmkid_candidate {
3389 /** BSSID of the PMKID candidate */
3391 /** Smaller the index, higher the priority */
3393 /** Whether RSN IE includes pre-authenticate flag */
3398 * struct stkstart - Data for EVENT_STKSTART
3405 * struct tdls - Data for EVENT_TDLS
3411 TDLS_REQUEST_TEARDOWN
3413 u16 reason_code; /* for teardown */
3417 * struct wnm - Data for EVENT_WNM
3435 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3437 * During FT (IEEE 802.11r) authentication sequence, the driver is
3438 * expected to use this event to report received FT IEs (MDIE, FTIE,
3439 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3440 * IEs for the next message will be delivered through the
3441 * struct wpa_driver_ops::update_ft_ies() callback.
3447 u8 target_ap[ETH_ALEN];
3448 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3450 /** Length of ric_ies buffer in octets */
3455 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3457 struct ibss_rsn_start {
3462 * struct auth_info - Data for EVENT_AUTH events
3468 u16 auth_transaction;
3475 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3477 struct assoc_reject {
3479 * bssid - BSSID of the AP that rejected association
3484 * resp_ies - (Re)Association Response IEs
3486 * Optional association data from the driver. This data is not
3487 * required WPA, but may be useful for some protocols and as
3488 * such, should be reported if this is available to the driver
3491 * This should start with the first IE (fixed fields before IEs
3492 * are not included).
3497 * resp_ies_len - Length of resp_ies in bytes
3499 size_t resp_ies_len;
3502 * status_code - Status Code from (Re)association Response
3507 struct timeout_event {
3512 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3521 * struct tx_status - Data for EVENT_TX_STATUS events
3533 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3535 struct rx_from_unknown {
3542 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3548 int ssi_signal; /* dBm */
3552 * struct rx_action - Data for EVENT_RX_ACTION events
3556 * da - Destination address of the received Action frame
3561 * sa - Source address of the received Action frame
3566 * bssid - Address 3 of the received Action frame
3571 * category - Action frame category
3576 * data - Action frame body after category field
3581 * len - Length of data in octets
3586 * freq - Frequency (in MHz) on which the frame was received
3592 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3594 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3596 struct remain_on_channel {
3598 * freq - Channel frequency in MHz
3603 * duration - Duration to remain on the channel in milliseconds
3605 unsigned int duration;
3606 } remain_on_channel;
3609 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3610 * @aborted: Whether the scan was aborted
3611 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3612 * @num_freqs: Number of entries in freqs array
3613 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3615 * @num_ssids: Number of entries in ssids array
3621 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3626 * struct mlme_rx - Data for EVENT_MLME_RX events
3637 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3639 struct rx_probe_req {
3641 * sa - Source address of the received Probe Request frame
3646 * da - Destination address of the received Probe Request frame
3647 * or %NULL if not available
3652 * bssid - BSSID of the received Probe Request frame or %NULL
3658 * ie - IEs from the Probe Request body
3663 * ie_len - Length of ie buffer in octets
3668 * signal - signal strength in dBm (or 0 if not available)
3674 * struct new_sta - Data for EVENT_NEW_STA events
3681 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3690 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3692 struct wpa_signal_info signal_change;
3695 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3696 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3697 * @freq_5: Best 5 GHz band channel frequency in MHz
3698 * @freq_overall: Best channel frequency in MHz
3700 * 0 can be used to indicate no preference in either band.
3702 struct best_channel {
3708 struct unprot_deauth {
3714 struct unprot_disassoc {
3721 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3722 * @addr: station address
3729 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3731 struct p2p_dev_found {
3734 const u8 *pri_dev_type;
3735 const char *dev_name;
3742 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3744 struct p2p_go_neg_req_rx {
3747 } p2p_go_neg_req_rx;
3750 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3752 struct p2p_go_neg_completed {
3753 struct p2p_go_neg_results *res;
3754 } p2p_go_neg_completed;
3756 struct p2p_prov_disc_req {
3760 const u8 *pri_dev_type;
3761 const char *dev_name;
3762 u16 supp_config_methods;
3765 } p2p_prov_disc_req;
3767 struct p2p_prov_disc_resp {
3770 } p2p_prov_disc_resp;
3781 struct p2p_sd_resp {
3789 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3791 struct ibss_peer_lost {
3796 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3798 struct driver_gtk_rekey {
3800 const u8 *replay_ctr;
3804 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
3805 * @addr: station address
3807 struct client_poll {
3812 * struct eapol_tx_status
3813 * @dst: Original destination
3814 * @data: Data starting with IEEE 802.1X header (!)
3815 * @data_len: Length of data
3816 * @ack: Indicates ack or lost frame
3818 * This corresponds to hapd_send_eapol if the frame sent
3819 * there isn't just reported as EVENT_TX_STATUS.
3821 struct eapol_tx_status {
3830 * @freq: Frequency of new channel in MHz
3831 * @ht_enabled: Whether this is an HT channel
3832 * @ch_offset: Secondary channel offset
3841 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
3842 * @addr: Remote client address
3843 * @code: Reason code for connection failure
3845 struct connect_failed_reason {
3851 } connect_failed_reason;
3854 * struct dfs_event - Data for radar detected events
3855 * @freq: Frequency of the channel in MHz
3863 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3864 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3865 * with struct wpa_driver_ops::init()
3866 * @event: event type (defined above)
3867 * @data: possible extra data for the event
3869 * Driver wrapper code should call this function whenever an event is received
3872 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
3873 union wpa_event_data *data);
3877 * The following inline functions are provided for convenience to simplify
3878 * event indication for some of the common events.
3881 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
3882 size_t ielen, int reassoc)
3884 union wpa_event_data event;
3885 os_memset(&event, 0, sizeof(event));
3886 event.assoc_info.reassoc = reassoc;
3887 event.assoc_info.req_ies = ie;
3888 event.assoc_info.req_ies_len = ielen;
3889 event.assoc_info.addr = addr;
3890 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
3893 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
3895 union wpa_event_data event;
3896 os_memset(&event, 0, sizeof(event));
3897 event.disassoc_info.addr = addr;
3898 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
3901 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
3904 union wpa_event_data event;
3905 os_memset(&event, 0, sizeof(event));
3906 event.eapol_rx.src = src;
3907 event.eapol_rx.data = data;
3908 event.eapol_rx.data_len = data_len;
3909 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
3912 /* driver_common.c */
3913 void wpa_scan_results_free(struct wpa_scan_results *res);
3915 /* Convert wpa_event_type to a string for logging */
3916 const char * event_to_string(enum wpa_event_type event);
3918 #endif /* DRIVER_H */