2 * Driver interface definition
3 * Copyright (c) 2003-2012, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
8 * This file defines a driver interface used by both %wpa_supplicant and
9 * hostapd. The first part of the file defines data structures used in various
10 * driver operations. This is followed by the struct wpa_driver_ops that each
11 * driver wrapper will beed to define with callback functions for requesting
12 * driver operations. After this, there are definitions for driver event
13 * reporting with wpa_supplicant_event() and some convenience helper functions
14 * that can be used to report events.
20 #define WPA_SUPPLICANT_DRIVER_VERSION 4
22 #include "common/defs.h"
23 #include "utils/list.h"
25 #define HOSTAPD_CHAN_DISABLED 0x00000001
26 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
27 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
28 #define HOSTAPD_CHAN_RADAR 0x00000008
29 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
30 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
31 #define HOSTAPD_CHAN_HT40 0x00000040
32 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
34 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
35 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
36 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
37 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
38 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
40 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
41 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
42 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
43 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
45 enum reg_change_initiator {
49 REGDOM_SET_BY_COUNTRY_IE,
53 * struct hostapd_channel_data - Channel information
55 struct hostapd_channel_data {
57 * chan - Channel number (IEEE 802.11)
62 * freq - Frequency in MHz
67 * flag - Channel flags (HOSTAPD_CHAN_*)
72 * max_tx_power - Regulatory transmit power limit in dBm
77 * survey_list - Linked list of surveys
79 struct dl_list survey_list;
82 * min_nf - Minimum observed noise floor, in dBm, based on all
83 * surveyed channel data
89 * interference_factor - Computed interference factor on this
90 * channel (used internally in src/ap/acs.c; driver wrappers do not
93 long double interference_factor;
94 #endif /* CONFIG_ACS */
97 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
98 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
101 * struct hostapd_hw_modes - Supported hardware mode information
103 struct hostapd_hw_modes {
105 * mode - Hardware mode
107 enum hostapd_hw_mode mode;
110 * num_channels - Number of entries in the channels array
115 * channels - Array of supported channels
117 struct hostapd_channel_data *channels;
120 * num_rates - Number of entries in the rates array
125 * rates - Array of supported rates in 100 kbps units
130 * ht_capab - HT (IEEE 802.11n) capabilities
135 * mcs_set - MCS (IEEE 802.11n) rate parameters
140 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
145 * vht_capab - VHT (IEEE 802.11ac) capabilities
150 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
154 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
158 #define IEEE80211_MODE_INFRA 0
159 #define IEEE80211_MODE_IBSS 1
160 #define IEEE80211_MODE_AP 2
162 #define IEEE80211_CAP_ESS 0x0001
163 #define IEEE80211_CAP_IBSS 0x0002
164 #define IEEE80211_CAP_PRIVACY 0x0010
166 /* DMG (60 GHz) IEEE 802.11ad */
167 /* type - bits 0..1 */
168 #define IEEE80211_CAP_DMG_MASK 0x0003
169 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
170 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
171 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
173 #define WPA_SCAN_QUAL_INVALID BIT(0)
174 #define WPA_SCAN_NOISE_INVALID BIT(1)
175 #define WPA_SCAN_LEVEL_INVALID BIT(2)
176 #define WPA_SCAN_LEVEL_DBM BIT(3)
177 #define WPA_SCAN_AUTHENTICATED BIT(4)
178 #define WPA_SCAN_ASSOCIATED BIT(5)
181 * struct wpa_scan_res - Scan result for an BSS/IBSS
182 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
184 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
185 * @beacon_int: beacon interval in TUs (host byte order)
186 * @caps: capability information field in host byte order
187 * @qual: signal quality
188 * @noise: noise level
189 * @level: signal level
191 * @age: Age of the information in milliseconds (i.e., how many milliseconds
192 * ago the last Beacon or Probe Response frame was received)
193 * @ie_len: length of the following IE field in octets
194 * @beacon_ie_len: length of the following Beacon IE field in octets
196 * This structure is used as a generic format for scan results from the
197 * driver. Each driver interface implementation is responsible for converting
198 * the driver or OS specific scan results into this format.
200 * If the driver does not support reporting all IEs, the IE data structure is
201 * constructed of the IEs that are available. This field will also need to
202 * include SSID in IE format. All drivers are encouraged to be extended to
203 * report all IEs to make it easier to support future additions.
205 struct wpa_scan_res {
217 size_t beacon_ie_len;
219 * Followed by ie_len octets of IEs from Probe Response frame (or if
220 * the driver does not indicate source of IEs, these may also be from
221 * Beacon frame). After the first set of IEs, another set of IEs may
222 * follow (with beacon_ie_len octets of data) if the driver provides
228 * struct wpa_scan_results - Scan results
229 * @res: Array of pointers to allocated variable length scan result entries
230 * @num: Number of entries in the scan result array
231 * @fetch_time: Time when the results were fetched from the driver
233 struct wpa_scan_results {
234 struct wpa_scan_res **res;
236 struct os_time fetch_time;
240 * struct wpa_interface_info - Network interface information
241 * @next: Pointer to the next interface or NULL if this is the last one
242 * @ifname: Interface name that can be used with init() or init2()
243 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
245 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
246 * is not an allocated copy, i.e., get_interfaces() caller will not free
249 struct wpa_interface_info {
250 struct wpa_interface_info *next;
253 const char *drv_name;
256 #define WPAS_MAX_SCAN_SSIDS 16
259 * struct wpa_driver_scan_params - Scan parameters
260 * Data for struct wpa_driver_ops::scan2().
262 struct wpa_driver_scan_params {
264 * ssids - SSIDs to scan for
266 struct wpa_driver_scan_ssid {
268 * ssid - specific SSID to scan for (ProbeReq)
269 * %NULL or zero-length SSID is used to indicate active scan
270 * with wildcard SSID.
274 * ssid_len: Length of the SSID in octets
277 } ssids[WPAS_MAX_SCAN_SSIDS];
280 * num_ssids - Number of entries in ssids array
281 * Zero indicates a request for a passive scan.
286 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
291 * extra_ies_len - Length of extra_ies in octets
293 size_t extra_ies_len;
296 * freqs - Array of frequencies to scan or %NULL for all frequencies
298 * The frequency is set in MHz. The array is zero-terminated.
303 * filter_ssids - Filter for reporting SSIDs
305 * This optional parameter can be used to request the driver wrapper to
306 * filter scan results to include only the specified SSIDs. %NULL
307 * indicates that no filtering is to be done. This can be used to
308 * reduce memory needs for scan results in environments that have large
309 * number of APs with different SSIDs.
311 * The driver wrapper is allowed to take this allocated buffer into its
312 * own use by setting the pointer to %NULL. In that case, the driver
313 * wrapper is responsible for freeing the buffer with os_free() once it
314 * is not needed anymore.
316 struct wpa_driver_scan_filter {
322 * num_filter_ssids - Number of entries in filter_ssids array
324 size_t num_filter_ssids;
327 * filter_rssi - Filter by RSSI
329 * The driver may filter scan results in firmware to reduce host
330 * wakeups and thereby save power. Specify the RSSI threshold in s32
336 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
338 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
339 * Mbps from the support rates element(s) in the Probe Request frames
340 * and not to transmit the frames at any of those rates.
346 * struct wpa_driver_auth_params - Authentication parameters
347 * Data for struct wpa_driver_ops::authenticate().
349 struct wpa_driver_auth_params {
357 const u8 *wep_key[4];
358 size_t wep_key_len[4];
360 int local_state_change;
363 * p2p - Whether this connection is a P2P group
373 WPS_MODE_NONE /* no WPS provisioning being used */,
374 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
375 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
380 * struct wpa_driver_associate_params - Association parameters
381 * Data for struct wpa_driver_ops::associate().
383 struct wpa_driver_associate_params {
385 * bssid - BSSID of the selected AP
386 * This can be %NULL, if ap_scan=2 mode is used and the driver is
387 * responsible for selecting with which BSS to associate. */
391 * ssid - The selected SSID
396 * ssid_len - Length of the SSID (1..32)
401 * freq - Frequency of the channel the selected AP is using
402 * Frequency that the selected AP is using (in MHz as
403 * reported in the scan results)
408 * bg_scan_period - Background scan period in seconds, 0 to disable
409 * background scan, or -1 to indicate no change to default driver
415 * wpa_ie - WPA information element for (Re)Association Request
416 * WPA information element to be included in (Re)Association
417 * Request (including information element id and length). Use
418 * of this WPA IE is optional. If the driver generates the WPA
419 * IE, it can use pairwise_suite, group_suite, and
420 * key_mgmt_suite to select proper algorithms. In this case,
421 * the driver has to notify wpa_supplicant about the used WPA
422 * IE by generating an event that the interface code will
423 * convert into EVENT_ASSOCINFO data (see below).
425 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
426 * instead. The driver can determine which version is used by
427 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
430 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
435 * wpa_ie_len - length of the wpa_ie
440 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
442 unsigned int wpa_proto;
445 * pairwise_suite - Selected pairwise cipher suite
447 * This is usually ignored if @wpa_ie is used.
449 enum wpa_cipher pairwise_suite;
452 * group_suite - Selected group cipher suite
454 * This is usually ignored if @wpa_ie is used.
456 enum wpa_cipher group_suite;
459 * key_mgmt_suite - Selected key management suite
461 * This is usually ignored if @wpa_ie is used.
463 enum wpa_key_mgmt key_mgmt_suite;
466 * auth_alg - Allowed authentication algorithms
467 * Bit field of WPA_AUTH_ALG_*
472 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
477 * wep_key - WEP keys for static WEP configuration
479 const u8 *wep_key[4];
482 * wep_key_len - WEP key length for static WEP configuration
484 size_t wep_key_len[4];
487 * wep_tx_keyidx - WEP TX key index for static WEP configuration
492 * mgmt_frame_protection - IEEE 802.11w management frame protection
494 enum mfp_options mgmt_frame_protection;
497 * ft_ies - IEEE 802.11r / FT information elements
498 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
499 * for fast transition, this parameter is set to include the IEs that
500 * are to be sent in the next FT Authentication Request message.
501 * update_ft_ies() handler is called to update the IEs for further
502 * FT messages in the sequence.
504 * The driver should use these IEs only if the target AP is advertising
505 * the same mobility domain as the one included in the MDIE here.
507 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
508 * AP after the initial association. These IEs can only be used if the
509 * target AP is advertising support for FT and is using the same MDIE
510 * and SSID as the current AP.
512 * The driver is responsible for reporting the FT IEs received from the
513 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
514 * type. update_ft_ies() handler will then be called with the FT IEs to
515 * include in the next frame in the authentication sequence.
520 * ft_ies_len - Length of ft_ies in bytes
525 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
527 * This value is provided to allow the driver interface easier access
528 * to the current mobility domain. This value is set to %NULL if no
529 * mobility domain is currently active.
534 * passphrase - RSN passphrase for PSK
536 * This value is made available only for WPA/WPA2-Personal (PSK) and
537 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
538 * the 8..63 character ASCII passphrase, if available. Please note that
539 * this can be %NULL if passphrase was not used to generate the PSK. In
540 * that case, the psk field must be used to fetch the PSK.
542 const char *passphrase;
545 * psk - RSN PSK (alternative for passphrase for PSK)
547 * This value is made available only for WPA/WPA2-Personal (PSK) and
548 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
549 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
550 * be prepared to handle %NULL value as an error.
555 * drop_unencrypted - Enable/disable unencrypted frame filtering
557 * Configure the driver to drop all non-EAPOL frames (both receive and
558 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
559 * still be allowed for key negotiation.
561 int drop_unencrypted;
564 * prev_bssid - Previously used BSSID in this ESS
566 * When not %NULL, this is a request to use reassociation instead of
569 const u8 *prev_bssid;
574 * If the driver needs to do special configuration for WPS association,
575 * this variable provides more information on what type of association
576 * is being requested. Most drivers should not need ot use this.
581 * p2p - Whether this connection is a P2P group
586 * uapsd - UAPSD parameters for the network
587 * -1 = do not change defaults
588 * AP mode: 1 = enabled, 0 = disabled
589 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
594 * fixed_bssid - Whether to force this BSSID in IBSS mode
595 * 1 = Fix this BSSID and prevent merges.
596 * 0 = Do not fix BSSID.
601 * disable_ht - Disable HT (IEEE 802.11n) for this connection
606 * HT Capabilities over-rides. Only bits set in the mask will be used,
607 * and not all values are used by the kernel anyway. Currently, MCS,
608 * MPDU and MSDU fields are used.
610 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */
611 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */
613 #ifdef CONFIG_VHT_OVERRIDES
615 * disable_vht - Disable VHT for this connection
620 * VHT capability overrides.
622 const struct ieee80211_vht_capabilities *vhtcaps;
623 const struct ieee80211_vht_capabilities *vhtcaps_mask;
624 #endif /* CONFIG_VHT_OVERRIDES */
629 HIDDEN_SSID_ZERO_LEN,
630 HIDDEN_SSID_ZERO_CONTENTS
633 struct wpa_driver_ap_params {
635 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
640 * head_len - Length of the head buffer in octets
645 * tail - Beacon tail following TIM IE
650 * tail_len - Length of the tail buffer in octets
655 * dtim_period - DTIM period
660 * beacon_int - Beacon interval
665 * basic_rates: -1 terminated array of basic rates in 100 kbps
667 * This parameter can be used to set a specific basic rate set for the
668 * BSS. If %NULL, default basic rate set is used.
673 * proberesp - Probe Response template
675 * This is used by drivers that reply to Probe Requests internally in
676 * AP mode and require the full Probe Response template.
681 * proberesp_len - Length of the proberesp buffer in octets
683 size_t proberesp_len;
686 * ssid - The SSID to use in Beacon/Probe Response frames
691 * ssid_len - Length of the SSID (1..32)
696 * hide_ssid - Whether to hide the SSID
698 enum hide_ssid hide_ssid;
701 * pairwise_ciphers - WPA_CIPHER_* bitfield
703 unsigned int pairwise_ciphers;
706 * group_cipher - WPA_CIPHER_*
708 unsigned int group_cipher;
711 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
713 unsigned int key_mgmt_suites;
716 * auth_algs - WPA_AUTH_ALG_* bitfield
718 unsigned int auth_algs;
721 * wpa_version - WPA_PROTO_* bitfield
723 unsigned int wpa_version;
726 * privacy - Whether privacy is used in the BSS
731 * beacon_ies - WPS/P2P IE(s) for Beacon frames
733 * This is used to add IEs like WPS IE and P2P IE by drivers that do
734 * not use the full Beacon template.
736 const struct wpabuf *beacon_ies;
739 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
741 * This is used to add IEs like WPS IE and P2P IE by drivers that
742 * reply to Probe Request frames internally.
744 const struct wpabuf *proberesp_ies;
747 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
749 * This is used to add IEs like WPS IE by drivers that reply to
750 * (Re)Association Request frames internally.
752 const struct wpabuf *assocresp_ies;
755 * isolate - Whether to isolate frames between associated stations
757 * If this is non-zero, the AP is requested to disable forwarding of
758 * frames between associated stations.
763 * cts_protect - Whether CTS protection is enabled
768 * preamble - Whether short preamble is enabled
773 * short_slot_time - Whether short slot time is enabled
775 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
776 * not set (e.g., when 802.11g mode is not in use)
781 * ht_opmode - HT operation mode or -1 if HT not in use
786 * interworking - Whether Interworking is enabled
791 * hessid - Homogeneous ESS identifier or %NULL if not set
796 * access_network_type - Access Network Type (0..15)
798 * This is used for filtering Probe Request frames when Interworking is
801 u8 access_network_type;
804 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
806 * This is used by driver which advertises this capability.
808 int ap_max_inactivity;
811 * disable_dgaf - Whether group-addressed frames are disabled
817 * struct wpa_driver_capa - Driver capability information
819 struct wpa_driver_capa {
820 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
821 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
822 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
823 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
824 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
825 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
826 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
827 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
828 unsigned int key_mgmt;
830 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
831 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
832 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
833 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
834 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
835 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
838 #define WPA_DRIVER_AUTH_OPEN 0x00000001
839 #define WPA_DRIVER_AUTH_SHARED 0x00000002
840 #define WPA_DRIVER_AUTH_LEAP 0x00000004
843 /* Driver generated WPA/RSN IE */
844 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
845 /* Driver needs static WEP key setup after association command */
846 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
847 /* unused: 0x00000004 */
848 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
849 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
850 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
851 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
852 /* Driver provides separate commands for authentication and association (SME in
853 * wpa_supplicant). */
854 #define WPA_DRIVER_FLAGS_SME 0x00000020
855 /* Driver supports AP mode */
856 #define WPA_DRIVER_FLAGS_AP 0x00000040
857 /* Driver needs static WEP key setup after association has been completed */
858 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
859 /* Driver takes care of P2P management operations */
860 #define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
861 /* Driver supports concurrent P2P operations */
862 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
864 * Driver uses the initial interface as a dedicated management interface, i.e.,
865 * it cannot be used for P2P group operations or non-P2P purposes.
867 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
868 /* This interface is P2P capable (P2P GO or P2P Client) */
869 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
870 /* unused: 0x00001000 */
872 * Driver uses the initial interface for P2P management interface and non-P2P
873 * purposes (e.g., connect to infra AP), but this interface cannot be used for
874 * P2P group operations.
876 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
878 * Driver is known to use sane error codes, i.e., when it indicates that
879 * something (e.g., association) fails, there was indeed a failure and the
880 * operation does not end up getting completed successfully later.
882 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
883 /* Driver supports off-channel TX */
884 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
885 /* Driver indicates TX status events for EAPOL Data frames */
886 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
887 /* Driver indicates TX status events for Deauth/Disassoc frames */
888 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
889 /* Driver supports roaming (BSS selection) in firmware */
890 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
891 /* Driver supports operating as a TDLS peer */
892 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
893 /* Driver requires external TDLS setup/teardown/discovery */
894 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
895 /* Driver indicates support for Probe Response offloading in AP mode */
896 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
897 /* Driver supports U-APSD in AP mode */
898 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
899 /* Driver supports inactivity timer in AP mode */
900 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
901 /* Driver expects user space implementation of MLME in AP mode */
902 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
903 /* Driver supports SAE with user space SME */
904 #define WPA_DRIVER_FLAGS_SAE 0x02000000
905 /* Driver makes use of OBSS scan mechanism in wpa_supplicant */
906 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
907 /* Driver supports IBSS (Ad-hoc) mode */
908 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
909 /* Driver supports radar detection */
910 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
911 /* Driver supports a dedicated interface for P2P Device */
912 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
916 int max_sched_scan_ssids;
917 int sched_scan_supported;
921 * max_remain_on_chan - Maximum remain-on-channel duration in msec
923 unsigned int max_remain_on_chan;
926 * max_stations - Maximum number of associated stations the driver
927 * supports in AP mode
929 unsigned int max_stations;
932 * probe_resp_offloads - Bitmap of supported protocols by the driver
933 * for Probe Response offloading.
935 /* Driver Probe Response offloading support for WPS ver. 1 */
936 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
937 /* Driver Probe Response offloading support for WPS ver. 2 */
938 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
939 /* Driver Probe Response offloading support for P2P */
940 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
941 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
942 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
943 unsigned int probe_resp_offloads;
945 unsigned int max_acl_mac_addrs;
948 * Number of supported concurrent channels
950 unsigned int num_multichan_concurrent;
953 * extended_capa - extended capabilities in driver/device
955 * Must be allocated and freed by driver and the pointers must be
956 * valid for the lifetime of the driver, i.e., freed in deinit()
958 const u8 *extended_capa, *extended_capa_mask;
959 unsigned int extended_capa_len;
965 struct hostap_sta_driver_data {
966 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
967 unsigned long current_tx_rate;
968 unsigned long inactive_msec;
970 unsigned long num_ps_buf_frames;
971 unsigned long tx_retry_failed;
972 unsigned long tx_retry_count;
977 struct hostapd_sta_add_params {
981 const u8 *supp_rates;
982 size_t supp_rates_len;
984 const struct ieee80211_ht_capabilities *ht_capabilities;
985 const struct ieee80211_vht_capabilities *vht_capabilities;
986 u32 flags; /* bitmask of WPA_STA_* flags */
987 int set; /* Set STA parameters instead of add */
990 size_t ext_capab_len;
993 struct hostapd_freq_params {
999 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
1000 * secondary channel below primary, 1 = HT40
1001 * enabled, secondary channel above primary */
1006 /* valid for both HT and VHT, center_freq2 is non-zero
1007 * only for bandwidth 80 and an 80+80 channel */
1008 int center_freq1, center_freq2;
1012 struct mac_address {
1016 struct hostapd_acl_params {
1018 unsigned int num_mac_acl;
1019 struct mac_address mac_acl[0];
1022 enum wpa_driver_if_type {
1024 * WPA_IF_STATION - Station mode interface
1029 * WPA_IF_AP_VLAN - AP mode VLAN interface
1031 * This interface shares its address and Beacon frame with the main
1037 * WPA_IF_AP_BSS - AP mode BSS interface
1039 * This interface has its own address and Beacon frame.
1044 * WPA_IF_P2P_GO - P2P Group Owner
1049 * WPA_IF_P2P_CLIENT - P2P Client
1054 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1055 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1060 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1061 * abstracted P2P Device function in the driver
1066 struct wpa_init_params {
1072 const char *test_socket;
1073 int use_pae_group_addr;
1077 u8 *own_addr; /* buffer for writing own MAC address */
1081 struct wpa_bss_params {
1082 /** Interface name (for multi-SSID/VLAN support) */
1084 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1093 enum mfp_options ieee80211w;
1096 #define WPA_STA_AUTHORIZED BIT(0)
1097 #define WPA_STA_WMM BIT(1)
1098 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1099 #define WPA_STA_MFP BIT(3)
1100 #define WPA_STA_TDLS_PEER BIT(4)
1103 * struct p2p_params - P2P parameters for driver-based P2P management
1106 const char *dev_name;
1108 #define DRV_MAX_SEC_DEV_TYPES 5
1109 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8];
1110 size_t num_sec_dev_types;
1124 WNM_SLEEP_ENTER_CONFIRM,
1125 WNM_SLEEP_ENTER_FAIL,
1126 WNM_SLEEP_EXIT_CONFIRM,
1127 WNM_SLEEP_EXIT_FAIL,
1128 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1129 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1130 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1132 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1134 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1135 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1137 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1140 /* enum chan_width - Channel width definitions */
1152 * struct wpa_signal_info - Information about channel signal quality
1154 struct wpa_signal_info {
1156 int above_threshold;
1161 enum chan_width chanwidth;
1167 * struct wpa_driver_ops - Driver interface API definition
1169 * This structure defines the API that each driver interface needs to implement
1170 * for core wpa_supplicant code. All driver specific functionality is captured
1173 struct wpa_driver_ops {
1174 /** Name of the driver interface */
1176 /** One line description of the driver interface */
1180 * get_bssid - Get the current BSSID
1181 * @priv: private driver interface data
1182 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1184 * Returns: 0 on success, -1 on failure
1186 * Query kernel driver for the current BSSID and copy it to bssid.
1187 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1190 int (*get_bssid)(void *priv, u8 *bssid);
1193 * get_ssid - Get the current SSID
1194 * @priv: private driver interface data
1195 * @ssid: buffer for SSID (at least 32 bytes)
1197 * Returns: Length of the SSID on success, -1 on failure
1199 * Query kernel driver for the current SSID and copy it to ssid.
1200 * Returning zero is recommended if the STA is not associated.
1202 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1203 * can, at least in theory, contain control characters (including nul)
1204 * and as such, should be processed as binary data, not a printable
1207 int (*get_ssid)(void *priv, u8 *ssid);
1210 * set_key - Configure encryption key
1211 * @ifname: Interface name (for multi-SSID/VLAN support)
1212 * @priv: private driver interface data
1213 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1214 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1216 * %WPA_ALG_NONE clears the key.
1217 * @addr: Address of the peer STA (BSSID of the current AP when setting
1218 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1219 * broadcast keys, %NULL for default keys that are used both for
1220 * broadcast and unicast; when clearing keys, %NULL is used to
1221 * indicate that both the broadcast-only and default key of the
1222 * specified key index is to be cleared
1223 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1225 * @set_tx: configure this key as the default Tx key (only used when
1226 * driver does not support separate unicast/individual key
1227 * @seq: sequence number/packet number, seq_len octets, the next
1228 * packet number to be used for in replay protection; configured
1229 * for Rx keys (in most cases, this is only used with broadcast
1230 * keys and set to zero for unicast keys); %NULL if not set
1231 * @seq_len: length of the seq, depends on the algorithm:
1232 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1233 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1235 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1236 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1238 * Returns: 0 on success, -1 on failure
1240 * Configure the given key for the kernel driver. If the driver
1241 * supports separate individual keys (4 default keys + 1 individual),
1242 * addr can be used to determine whether the key is default or
1243 * individual. If only 4 keys are supported, the default key with key
1244 * index 0 is used as the individual key. STA must be configured to use
1245 * it as the default Tx key (set_tx is set) and accept Rx for all the
1246 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1247 * broadcast keys, so key index 0 is available for this kind of
1250 * Please note that TKIP keys include separate TX and RX MIC keys and
1251 * some drivers may expect them in different order than wpa_supplicant
1252 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1253 * will trigger Michael MIC errors. This can be fixed by changing the
1254 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1255 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1256 * example on how this can be done.
1258 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1259 const u8 *addr, int key_idx, int set_tx,
1260 const u8 *seq, size_t seq_len,
1261 const u8 *key, size_t key_len);
1264 * init - Initialize driver interface
1265 * @ctx: context to be used when calling wpa_supplicant functions,
1266 * e.g., wpa_supplicant_event()
1267 * @ifname: interface name, e.g., wlan0
1269 * Returns: Pointer to private data, %NULL on failure
1271 * Initialize driver interface, including event processing for kernel
1272 * driver events (e.g., associated, scan results, Michael MIC failure).
1273 * This function can allocate a private configuration data area for
1274 * @ctx, file descriptor, interface name, etc. information that may be
1275 * needed in future driver operations. If this is not used, non-NULL
1276 * value will need to be returned because %NULL is used to indicate
1277 * failure. The returned value will be used as 'void *priv' data for
1278 * all other driver_ops functions.
1280 * The main event loop (eloop.c) of wpa_supplicant can be used to
1281 * register callback for read sockets (eloop_register_read_sock()).
1283 * See below for more information about events and
1284 * wpa_supplicant_event() function.
1286 void * (*init)(void *ctx, const char *ifname);
1289 * deinit - Deinitialize driver interface
1290 * @priv: private driver interface data from init()
1292 * Shut down driver interface and processing of driver events. Free
1293 * private data buffer if one was allocated in init() handler.
1295 void (*deinit)(void *priv);
1298 * set_param - Set driver configuration parameters
1299 * @priv: private driver interface data from init()
1300 * @param: driver specific configuration parameters
1302 * Returns: 0 on success, -1 on failure
1304 * Optional handler for notifying driver interface about configuration
1305 * parameters (driver_param).
1307 int (*set_param)(void *priv, const char *param);
1310 * set_countermeasures - Enable/disable TKIP countermeasures
1311 * @priv: private driver interface data
1312 * @enabled: 1 = countermeasures enabled, 0 = disabled
1314 * Returns: 0 on success, -1 on failure
1316 * Configure TKIP countermeasures. When these are enabled, the driver
1317 * should drop all received and queued frames that are using TKIP.
1319 int (*set_countermeasures)(void *priv, int enabled);
1322 * deauthenticate - Request driver to deauthenticate
1323 * @priv: private driver interface data
1324 * @addr: peer address (BSSID of the AP)
1325 * @reason_code: 16-bit reason code to be sent in the deauthentication
1328 * Returns: 0 on success, -1 on failure
1330 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1333 * associate - Request driver to associate
1334 * @priv: private driver interface data
1335 * @params: association parameters
1337 * Returns: 0 on success, -1 on failure
1339 int (*associate)(void *priv,
1340 struct wpa_driver_associate_params *params);
1343 * add_pmkid - Add PMKSA cache entry to the driver
1344 * @priv: private driver interface data
1345 * @bssid: BSSID for the PMKSA cache entry
1346 * @pmkid: PMKID for the PMKSA cache entry
1348 * Returns: 0 on success, -1 on failure
1350 * This function is called when a new PMK is received, as a result of
1351 * either normal authentication or RSN pre-authentication.
1353 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1354 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1355 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1356 * driver_ops function does not need to be implemented. Likewise, if
1357 * the driver does not support WPA, this function is not needed.
1359 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1362 * remove_pmkid - Remove PMKSA cache entry to the driver
1363 * @priv: private driver interface data
1364 * @bssid: BSSID for the PMKSA cache entry
1365 * @pmkid: PMKID for the PMKSA cache entry
1367 * Returns: 0 on success, -1 on failure
1369 * This function is called when the supplicant drops a PMKSA cache
1370 * entry for any reason.
1372 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1373 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1374 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1375 * from wpa_supplicant, this driver_ops function does not need to be
1376 * implemented. Likewise, if the driver does not support WPA, this
1377 * function is not needed.
1379 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1382 * flush_pmkid - Flush PMKSA cache
1383 * @priv: private driver interface data
1385 * Returns: 0 on success, -1 on failure
1387 * This function is called when the supplicant drops all PMKSA cache
1388 * entries for any reason.
1390 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1391 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1392 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1393 * from wpa_supplicant, this driver_ops function does not need to be
1394 * implemented. Likewise, if the driver does not support WPA, this
1395 * function is not needed.
1397 int (*flush_pmkid)(void *priv);
1400 * get_capa - Get driver capabilities
1401 * @priv: private driver interface data
1403 * Returns: 0 on success, -1 on failure
1405 * Get driver/firmware/hardware capabilities.
1407 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1410 * poll - Poll driver for association information
1411 * @priv: private driver interface data
1413 * This is an option callback that can be used when the driver does not
1414 * provide event mechanism for association events. This is called when
1415 * receiving WPA EAPOL-Key messages that require association
1416 * information. The driver interface is supposed to generate associnfo
1417 * event before returning from this callback function. In addition, the
1418 * driver interface should generate an association event after having
1419 * sent out associnfo.
1421 void (*poll)(void *priv);
1424 * get_ifname - Get interface name
1425 * @priv: private driver interface data
1427 * Returns: Pointer to the interface name. This can differ from the
1428 * interface name used in init() call. Init() is called first.
1430 * This optional function can be used to allow the driver interface to
1431 * replace the interface name with something else, e.g., based on an
1432 * interface mapping from a more descriptive name.
1434 const char * (*get_ifname)(void *priv);
1437 * get_mac_addr - Get own MAC address
1438 * @priv: private driver interface data
1440 * Returns: Pointer to own MAC address or %NULL on failure
1442 * This optional function can be used to get the own MAC address of the
1443 * device from the driver interface code. This is only needed if the
1444 * l2_packet implementation for the OS does not provide easy access to
1446 const u8 * (*get_mac_addr)(void *priv);
1449 * send_eapol - Optional function for sending EAPOL packets
1450 * @priv: private driver interface data
1451 * @dest: Destination MAC address
1453 * @data: EAPOL packet starting with IEEE 802.1X header
1454 * @data_len: Size of the EAPOL packet
1456 * Returns: 0 on success, -1 on failure
1458 * This optional function can be used to override l2_packet operations
1459 * with driver specific functionality. If this function pointer is set,
1460 * l2_packet module is not used at all and the driver interface code is
1461 * responsible for receiving and sending all EAPOL packets. The
1462 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1463 * event. The driver interface is required to implement get_mac_addr()
1464 * handler if send_eapol() is used.
1466 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1467 const u8 *data, size_t data_len);
1470 * set_operstate - Sets device operating state to DORMANT or UP
1471 * @priv: private driver interface data
1472 * @state: 0 = dormant, 1 = up
1473 * Returns: 0 on success, -1 on failure
1475 * This is an optional function that can be used on operating systems
1476 * that support a concept of controlling network device state from user
1477 * space applications. This function, if set, gets called with
1478 * state = 1 when authentication has been completed and with state = 0
1479 * when connection is lost.
1481 int (*set_operstate)(void *priv, int state);
1484 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1485 * @priv: Private driver interface data
1486 * @addr: Address of the station for which to set protection (may be
1487 * %NULL for group keys)
1488 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1489 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1490 * Returns: 0 on success, -1 on failure
1492 * This is an optional function that can be used to set the driver to
1493 * require protection for Tx and/or Rx frames. This uses the layer
1494 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1495 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1496 * set protection operation; instead, they set protection implicitly
1497 * based on configured keys.
1499 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1503 * get_hw_feature_data - Get hardware support data (channels and rates)
1504 * @priv: Private driver interface data
1505 * @num_modes: Variable for returning the number of returned modes
1506 * flags: Variable for returning hardware feature flags
1507 * Returns: Pointer to allocated hardware data on success or %NULL on
1508 * failure. Caller is responsible for freeing this.
1510 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1515 * send_mlme - Send management frame from MLME
1516 * @priv: Private driver interface data
1517 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1518 * @data_len: Size of the management frame
1519 * @noack: Do not wait for this frame to be acked (disable retries)
1520 * Returns: 0 on success, -1 on failure
1522 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1526 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1527 * @priv: Private driver interface data
1528 * @md: Mobility domain (2 octets) (also included inside ies)
1529 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1530 * @ies_len: Length of FT IEs in bytes
1531 * Returns: 0 on success, -1 on failure
1533 * The supplicant uses this callback to let the driver know that keying
1534 * material for FT is available and that the driver can use the
1535 * provided IEs in the next message in FT authentication sequence.
1537 * This function is only needed for driver that support IEEE 802.11r
1538 * (Fast BSS Transition).
1540 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1544 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1545 * @priv: Private driver interface data
1546 * @action: Action field value
1547 * @target_ap: Target AP address
1548 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1549 * @ies_len: Length of FT IEs in bytes
1550 * Returns: 0 on success, -1 on failure
1552 * The supplicant uses this callback to request the driver to transmit
1553 * an FT Action frame (action category 6) for over-the-DS fast BSS
1556 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1557 const u8 *ies, size_t ies_len);
1560 * get_scan_results2 - Fetch the latest scan results
1561 * @priv: private driver interface data
1563 * Returns: Allocated buffer of scan results (caller is responsible for
1564 * freeing the data structure) on success, NULL on failure
1566 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1569 * set_country - Set country
1570 * @priv: Private driver interface data
1571 * @alpha2: country to which to switch to
1572 * Returns: 0 on success, -1 on failure
1574 * This function is for drivers which support some form
1575 * of setting a regulatory domain.
1577 int (*set_country)(void *priv, const char *alpha2);
1580 * get_country - Get country
1581 * @priv: Private driver interface data
1582 * @alpha2: Buffer for returning country code (at least 3 octets)
1583 * Returns: 0 on success, -1 on failure
1585 int (*get_country)(void *priv, char *alpha2);
1588 * global_init - Global driver initialization
1589 * Returns: Pointer to private data (global), %NULL on failure
1591 * This optional function is called to initialize the driver wrapper
1592 * for global data, i.e., data that applies to all interfaces. If this
1593 * function is implemented, global_deinit() will also need to be
1594 * implemented to free the private data. The driver will also likely
1595 * use init2() function instead of init() to get the pointer to global
1596 * data available to per-interface initializer.
1598 void * (*global_init)(void);
1601 * global_deinit - Global driver deinitialization
1602 * @priv: private driver global data from global_init()
1604 * Terminate any global driver related functionality and free the
1605 * global data structure.
1607 void (*global_deinit)(void *priv);
1610 * init2 - Initialize driver interface (with global data)
1611 * @ctx: context to be used when calling wpa_supplicant functions,
1612 * e.g., wpa_supplicant_event()
1613 * @ifname: interface name, e.g., wlan0
1614 * @global_priv: private driver global data from global_init()
1615 * Returns: Pointer to private data, %NULL on failure
1617 * This function can be used instead of init() if the driver wrapper
1620 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1623 * get_interfaces - Get information about available interfaces
1624 * @global_priv: private driver global data from global_init()
1625 * Returns: Allocated buffer of interface information (caller is
1626 * responsible for freeing the data structure) on success, NULL on
1629 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1632 * scan2 - Request the driver to initiate scan
1633 * @priv: private driver interface data
1634 * @params: Scan parameters
1636 * Returns: 0 on success, -1 on failure
1638 * Once the scan results are ready, the driver should report scan
1639 * results event for wpa_supplicant which will eventually request the
1640 * results with wpa_driver_get_scan_results2().
1642 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1645 * authenticate - Request driver to authenticate
1646 * @priv: private driver interface data
1647 * @params: authentication parameters
1648 * Returns: 0 on success, -1 on failure
1650 * This is an optional function that can be used with drivers that
1651 * support separate authentication and association steps, i.e., when
1652 * wpa_supplicant can act as the SME. If not implemented, associate()
1653 * function is expected to take care of IEEE 802.11 authentication,
1656 int (*authenticate)(void *priv,
1657 struct wpa_driver_auth_params *params);
1660 * set_ap - Set Beacon and Probe Response information for AP mode
1661 * @priv: Private driver interface data
1662 * @params: Parameters to use in AP mode
1664 * This function is used to configure Beacon template and/or extra IEs
1665 * to add for Beacon and Probe Response frames for the driver in
1666 * AP mode. The driver is responsible for building the full Beacon
1667 * frame by concatenating the head part with TIM IE generated by the
1668 * driver/firmware and finishing with the tail part. Depending on the
1669 * driver architectue, this can be done either by using the full
1670 * template or the set of additional IEs (e.g., WPS and P2P IE).
1671 * Similarly, Probe Response processing depends on the driver design.
1672 * If the driver (or firmware) takes care of replying to Probe Request
1673 * frames, the extra IEs provided here needs to be added to the Probe
1676 * Returns: 0 on success, -1 on failure
1678 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1681 * set_acl - Set ACL in AP mode
1682 * @priv: Private driver interface data
1683 * @params: Parameters to configure ACL
1684 * Returns: 0 on success, -1 on failure
1686 * This is used only for the drivers which support MAC address ACL.
1688 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1691 * hapd_init - Initialize driver interface (hostapd only)
1692 * @hapd: Pointer to hostapd context
1693 * @params: Configuration for the driver wrapper
1694 * Returns: Pointer to private data, %NULL on failure
1696 * This function is used instead of init() or init2() when the driver
1697 * wrapper is used with hostapd.
1699 void * (*hapd_init)(struct hostapd_data *hapd,
1700 struct wpa_init_params *params);
1703 * hapd_deinit - Deinitialize driver interface (hostapd only)
1704 * @priv: Private driver interface data from hapd_init()
1706 void (*hapd_deinit)(void *priv);
1709 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1710 * @priv: Private driver interface data
1711 * @params: BSS parameters
1712 * Returns: 0 on success, -1 on failure
1714 * This is an optional function to configure the kernel driver to
1715 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1716 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1717 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1718 * for Beacon frames.
1720 * DEPRECATED - use set_ap() instead
1722 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1725 * set_privacy - Enable/disable privacy (AP only)
1726 * @priv: Private driver interface data
1727 * @enabled: 1 = privacy enabled, 0 = disabled
1728 * Returns: 0 on success, -1 on failure
1730 * This is an optional function to configure privacy field in the
1731 * kernel driver for Beacon frames. This can be left undefined (set to
1732 * %NULL) if the driver uses the Beacon template from set_ap().
1734 * DEPRECATED - use set_ap() instead
1736 int (*set_privacy)(void *priv, int enabled);
1739 * get_seqnum - Fetch the current TSC/packet number (AP only)
1740 * @ifname: The interface name (main or virtual)
1741 * @priv: Private driver interface data
1742 * @addr: MAC address of the station or %NULL for group keys
1744 * @seq: Buffer for returning the latest used TSC/packet number
1745 * Returns: 0 on success, -1 on failure
1747 * This function is used to fetch the last used TSC/packet number for
1748 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1749 * keys, so there is no strict requirement on implementing support for
1750 * unicast keys (i.e., addr != %NULL).
1752 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1756 * flush - Flush all association stations (AP only)
1757 * @priv: Private driver interface data
1758 * Returns: 0 on success, -1 on failure
1760 * This function requests the driver to disassociate all associated
1761 * stations. This function does not need to be implemented if the
1762 * driver does not process association frames internally.
1764 int (*flush)(void *priv);
1767 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1768 * @priv: Private driver interface data
1769 * @elem: Information elements
1770 * @elem_len: Length of the elem buffer in octets
1771 * Returns: 0 on success, -1 on failure
1773 * This is an optional function to add information elements in the
1774 * kernel driver for Beacon and Probe Response frames. This can be left
1775 * undefined (set to %NULL) if the driver uses the Beacon template from
1778 * DEPRECATED - use set_ap() instead
1780 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1783 * read_sta_data - Fetch station data
1784 * @priv: Private driver interface data
1785 * @data: Buffer for returning station information
1786 * @addr: MAC address of the station
1787 * Returns: 0 on success, -1 on failure
1789 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1793 * hapd_send_eapol - Send an EAPOL packet (AP only)
1794 * @priv: private driver interface data
1795 * @addr: Destination MAC address
1796 * @data: EAPOL packet starting with IEEE 802.1X header
1797 * @data_len: Length of the EAPOL packet in octets
1798 * @encrypt: Whether the frame should be encrypted
1799 * @own_addr: Source MAC address
1800 * @flags: WPA_STA_* flags for the destination station
1802 * Returns: 0 on success, -1 on failure
1804 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1805 size_t data_len, int encrypt,
1806 const u8 *own_addr, u32 flags);
1809 * sta_deauth - Deauthenticate a station (AP only)
1810 * @priv: Private driver interface data
1811 * @own_addr: Source address and BSSID for the Deauthentication frame
1812 * @addr: MAC address of the station to deauthenticate
1813 * @reason: Reason code for the Deauthentiation frame
1814 * Returns: 0 on success, -1 on failure
1816 * This function requests a specific station to be deauthenticated and
1817 * a Deauthentication frame to be sent to it.
1819 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1823 * sta_disassoc - Disassociate a station (AP only)
1824 * @priv: Private driver interface data
1825 * @own_addr: Source address and BSSID for the Disassociation frame
1826 * @addr: MAC address of the station to disassociate
1827 * @reason: Reason code for the Disassociation frame
1828 * Returns: 0 on success, -1 on failure
1830 * This function requests a specific station to be disassociated and
1831 * a Disassociation frame to be sent to it.
1833 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1837 * sta_remove - Remove a station entry (AP only)
1838 * @priv: Private driver interface data
1839 * @addr: MAC address of the station to be removed
1840 * Returns: 0 on success, -1 on failure
1842 int (*sta_remove)(void *priv, const u8 *addr);
1845 * hapd_get_ssid - Get the current SSID (AP only)
1846 * @priv: Private driver interface data
1847 * @buf: Buffer for returning the SSID
1848 * @len: Maximum length of the buffer
1849 * Returns: Length of the SSID on success, -1 on failure
1851 * This function need not be implemented if the driver uses Beacon
1852 * template from set_ap() and does not reply to Probe Request frames.
1854 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
1857 * hapd_set_ssid - Set SSID (AP only)
1858 * @priv: Private driver interface data
1860 * @len: Length of the SSID in octets
1861 * Returns: 0 on success, -1 on failure
1863 * DEPRECATED - use set_ap() instead
1865 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1868 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1869 * @priv: Private driver interface data
1870 * @enabled: 1 = countermeasures enabled, 0 = disabled
1871 * Returns: 0 on success, -1 on failure
1873 * This need not be implemented if the driver does not take care of
1874 * association processing.
1876 int (*hapd_set_countermeasures)(void *priv, int enabled);
1879 * sta_add - Add a station entry
1880 * @priv: Private driver interface data
1881 * @params: Station parameters
1882 * Returns: 0 on success, -1 on failure
1884 * This function is used to add a station entry to the driver once the
1885 * station has completed association. This is only used if the driver
1886 * does not take care of association processing.
1888 * With TDLS, this function is also used to add or set (params->set 1)
1889 * TDLS peer entries.
1891 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
1894 * get_inact_sec - Get station inactivity duration (AP only)
1895 * @priv: Private driver interface data
1896 * @addr: Station address
1897 * Returns: Number of seconds station has been inactive, -1 on failure
1899 int (*get_inact_sec)(void *priv, const u8 *addr);
1902 * sta_clear_stats - Clear station statistics (AP only)
1903 * @priv: Private driver interface data
1904 * @addr: Station address
1905 * Returns: 0 on success, -1 on failure
1907 int (*sta_clear_stats)(void *priv, const u8 *addr);
1910 * set_freq - Set channel/frequency (AP only)
1911 * @priv: Private driver interface data
1912 * @freq: Channel parameters
1913 * Returns: 0 on success, -1 on failure
1915 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1918 * set_rts - Set RTS threshold
1919 * @priv: Private driver interface data
1920 * @rts: RTS threshold in octets
1921 * Returns: 0 on success, -1 on failure
1923 int (*set_rts)(void *priv, int rts);
1926 * set_frag - Set fragmentation threshold
1927 * @priv: Private driver interface data
1928 * @frag: Fragmentation threshold in octets
1929 * Returns: 0 on success, -1 on failure
1931 int (*set_frag)(void *priv, int frag);
1934 * sta_set_flags - Set station flags (AP only)
1935 * @priv: Private driver interface data
1936 * @addr: Station address
1937 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1938 * @flags_or: Bitmap of WPA_STA_* flags to add
1939 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1940 * Returns: 0 on success, -1 on failure
1942 int (*sta_set_flags)(void *priv, const u8 *addr,
1943 int total_flags, int flags_or, int flags_and);
1946 * set_tx_queue_params - Set TX queue parameters
1947 * @priv: Private driver interface data
1948 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
1952 * @burst_time: Maximum length for bursting in 0.1 msec units
1954 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1955 int cw_max, int burst_time);
1958 * if_add - Add a virtual interface
1959 * @priv: Private driver interface data
1960 * @type: Interface type
1961 * @ifname: Interface name for the new virtual interface
1962 * @addr: Local address to use for the interface or %NULL to use the
1963 * parent interface address
1964 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1965 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1966 * not allowed (applies only to %WPA_IF_AP_BSS type)
1967 * @force_ifname: Buffer for returning an interface name that the
1968 * driver ended up using if it differs from the requested ifname
1969 * @if_addr: Buffer for returning the allocated interface address
1970 * (this may differ from the requested addr if the driver cannot
1971 * change interface address)
1972 * @bridge: Bridge interface to use or %NULL if no bridge configured
1973 * @use_existing: Whether to allow existing interface to be used
1974 * Returns: 0 on success, -1 on failure
1976 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1977 const char *ifname, const u8 *addr, void *bss_ctx,
1978 void **drv_priv, char *force_ifname, u8 *if_addr,
1979 const char *bridge, int use_existing);
1982 * if_remove - Remove a virtual interface
1983 * @priv: Private driver interface data
1984 * @type: Interface type
1985 * @ifname: Interface name of the virtual interface to be removed
1986 * Returns: 0 on success, -1 on failure
1988 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1989 const char *ifname);
1992 * set_sta_vlan - Bind a station into a specific interface (AP only)
1993 * @priv: Private driver interface data
1994 * @ifname: Interface (main or virtual BSS or VLAN)
1995 * @addr: MAC address of the associated station
1997 * Returns: 0 on success, -1 on failure
1999 * This function is used to bind a station to a specific virtual
2000 * interface. It is only used if when virtual interfaces are supported,
2001 * e.g., to assign stations to different VLAN interfaces based on
2002 * information from a RADIUS server. This allows separate broadcast
2003 * domains to be used with a single BSS.
2005 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2009 * commit - Optional commit changes handler (AP only)
2010 * @priv: driver private data
2011 * Returns: 0 on success, -1 on failure
2013 * This optional handler function can be registered if the driver
2014 * interface implementation needs to commit changes (e.g., by setting
2015 * network interface up) at the end of initial configuration. If set,
2016 * this handler will be called after initial setup has been completed.
2018 int (*commit)(void *priv);
2021 * send_ether - Send an ethernet packet (AP only)
2022 * @priv: private driver interface data
2023 * @dst: Destination MAC address
2024 * @src: Source MAC address
2026 * @data: EAPOL packet starting with IEEE 802.1X header
2027 * @data_len: Length of the EAPOL packet in octets
2028 * Returns: 0 on success, -1 on failure
2030 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2031 const u8 *data, size_t data_len);
2034 * set_radius_acl_auth - Notification of RADIUS ACL change
2035 * @priv: Private driver interface data
2036 * @mac: MAC address of the station
2037 * @accepted: Whether the station was accepted
2038 * @session_timeout: Session timeout for the station
2039 * Returns: 0 on success, -1 on failure
2041 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2042 u32 session_timeout);
2045 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2046 * @priv: Private driver interface data
2047 * @mac: MAC address of the station
2048 * Returns: 0 on success, -1 on failure
2050 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2053 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2054 * @priv: Private driver interface data
2055 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2056 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2058 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2059 * to remove extra IE(s)
2060 * Returns: 0 on success, -1 on failure
2062 * This is an optional function to add WPS IE in the kernel driver for
2063 * Beacon and Probe Response frames. This can be left undefined (set
2064 * to %NULL) if the driver uses the Beacon template from set_ap()
2065 * and does not process Probe Request frames. If the driver takes care
2066 * of (Re)Association frame processing, the assocresp buffer includes
2067 * WPS IE(s) that need to be added to (Re)Association Response frames
2068 * whenever a (Re)Association Request frame indicated use of WPS.
2070 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2071 * frames when operating as a GO. The driver is responsible for adding
2072 * timing related attributes (e.g., NoA) in addition to the IEs
2073 * included here by appending them after these buffers. This call is
2074 * also used to provide Probe Response IEs for P2P Listen state
2075 * operations for drivers that generate the Probe Response frames
2078 * DEPRECATED - use set_ap() instead
2080 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2081 const struct wpabuf *proberesp,
2082 const struct wpabuf *assocresp);
2085 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2086 * @priv: Private driver interface data
2087 * @authorized: Whether the port is authorized
2088 * Returns: 0 on success, -1 on failure
2090 int (*set_supp_port)(void *priv, int authorized);
2093 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2094 * @priv: Private driver interface data
2095 * @addr: MAC address of the associated station
2096 * @aid: Association ID
2097 * @val: 1 = bind to 4-address WDS; 0 = unbind
2098 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2099 * to indicate that bridge is not to be used
2100 * @ifname_wds: Buffer to return the interface name for the new WDS
2101 * station or %NULL to indicate name is not returned.
2102 * Returns: 0 on success, -1 on failure
2104 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2105 const char *bridge_ifname, char *ifname_wds);
2108 * send_action - Transmit an Action frame
2109 * @priv: Private driver interface data
2110 * @freq: Frequency (in MHz) of the channel
2111 * @wait: Time to wait off-channel for a response (in ms), or zero
2112 * @dst: Destination MAC address (Address 1)
2113 * @src: Source MAC address (Address 2)
2114 * @bssid: BSSID (Address 3)
2116 * @data_len: data length in octets
2117 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2118 * Returns: 0 on success, -1 on failure
2120 * This command can be used to request the driver to transmit an action
2121 * frame to the specified destination.
2123 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2124 * be transmitted on the given channel and the device will wait for a
2125 * response on that channel for the given wait time.
2127 * If the flag is not set, the wait time will be ignored. In this case,
2128 * if a remain-on-channel duration is in progress, the frame must be
2129 * transmitted on that channel; alternatively the frame may be sent on
2130 * the current operational channel (if in associated state in station
2131 * mode or while operating as an AP.)
2133 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2134 const u8 *dst, const u8 *src, const u8 *bssid,
2135 const u8 *data, size_t data_len, int no_cck);
2138 * send_action_cancel_wait - Cancel action frame TX wait
2139 * @priv: Private driver interface data
2141 * This command cancels the wait time associated with sending an action
2142 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2143 * set in the driver flags.
2145 void (*send_action_cancel_wait)(void *priv);
2148 * remain_on_channel - Remain awake on a channel
2149 * @priv: Private driver interface data
2150 * @freq: Frequency (in MHz) of the channel
2151 * @duration: Duration in milliseconds
2152 * Returns: 0 on success, -1 on failure
2154 * This command is used to request the driver to remain awake on the
2155 * specified channel for the specified duration and report received
2156 * Action frames with EVENT_RX_ACTION events. Optionally, received
2157 * Probe Request frames may also be requested to be reported by calling
2158 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2160 * The driver may not be at the requested channel when this function
2161 * returns, i.e., the return code is only indicating whether the
2162 * request was accepted. The caller will need to wait until the
2163 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2164 * completed the channel change. This may take some time due to other
2165 * need for the radio and the caller should be prepared to timing out
2166 * its wait since there are no guarantees on when this request can be
2169 int (*remain_on_channel)(void *priv, unsigned int freq,
2170 unsigned int duration);
2173 * cancel_remain_on_channel - Cancel remain-on-channel operation
2174 * @priv: Private driver interface data
2176 * This command can be used to cancel a remain-on-channel operation
2177 * before its originally requested duration has passed. This could be
2178 * used, e.g., when remain_on_channel() is used to request extra time
2179 * to receive a response to an Action frame and the response is
2180 * received when there is still unneeded time remaining on the
2181 * remain-on-channel operation.
2183 int (*cancel_remain_on_channel)(void *priv);
2186 * probe_req_report - Request Probe Request frames to be indicated
2187 * @priv: Private driver interface data
2188 * @report: Whether to report received Probe Request frames
2189 * Returns: 0 on success, -1 on failure (or if not supported)
2191 * This command can be used to request the driver to indicate when
2192 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2193 * Since this operation may require extra resources, e.g., due to less
2194 * optimal hardware/firmware RX filtering, many drivers may disable
2195 * Probe Request reporting at least in station mode. This command is
2196 * used to notify the driver when the Probe Request frames need to be
2197 * reported, e.g., during remain-on-channel operations.
2199 int (*probe_req_report)(void *priv, int report);
2202 * deinit_ap - Deinitialize AP mode
2203 * @priv: Private driver interface data
2204 * Returns: 0 on success, -1 on failure (or if not supported)
2206 * This optional function can be used to disable AP mode related
2207 * configuration. If the interface was not dynamically added,
2208 * change the driver mode to station mode to allow normal station
2209 * operations like scanning to be completed.
2211 int (*deinit_ap)(void *priv);
2214 * deinit_p2p_cli - Deinitialize P2P client mode
2215 * @priv: Private driver interface data
2216 * Returns: 0 on success, -1 on failure (or if not supported)
2218 * This optional function can be used to disable P2P client mode. If the
2219 * interface was not dynamically added, change the interface type back
2222 int (*deinit_p2p_cli)(void *priv);
2225 * suspend - Notification on system suspend/hibernate event
2226 * @priv: Private driver interface data
2228 void (*suspend)(void *priv);
2231 * resume - Notification on system resume/thaw event
2232 * @priv: Private driver interface data
2234 void (*resume)(void *priv);
2237 * signal_monitor - Set signal monitoring parameters
2238 * @priv: Private driver interface data
2239 * @threshold: Threshold value for signal change events; 0 = disabled
2240 * @hysteresis: Minimum change in signal strength before indicating a
2242 * Returns: 0 on success, -1 on failure (or if not supported)
2244 * This function can be used to configure monitoring of signal strength
2245 * with the current AP. Whenever signal strength drops below the
2246 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2247 * should be generated assuming the signal strength has changed at
2248 * least %hysteresis from the previously indicated signal change event.
2250 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2253 * send_frame - Send IEEE 802.11 frame (testing use only)
2254 * @priv: Private driver interface data
2255 * @data: IEEE 802.11 frame with IEEE 802.11 header
2256 * @data_len: Size of the frame
2257 * @encrypt: Whether to encrypt the frame (if keys are set)
2258 * Returns: 0 on success, -1 on failure
2260 * This function is only used for debugging purposes and is not
2261 * required to be implemented for normal operations.
2263 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2267 * shared_freq - Get operating frequency of shared interface(s)
2268 * @priv: Private driver interface data
2269 * Returns: Operating frequency in MHz, 0 if no shared operation in
2270 * use, or -1 on failure
2272 * This command can be used to request the current operating frequency
2273 * of any virtual interface that shares the same radio to provide
2274 * information for channel selection for other virtual interfaces.
2276 int (*shared_freq)(void *priv);
2279 * get_noa - Get current Notice of Absence attribute payload
2280 * @priv: Private driver interface data
2281 * @buf: Buffer for returning NoA
2282 * @buf_len: Buffer length in octets
2283 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2284 * advertized, or -1 on failure
2286 * This function is used to fetch the current Notice of Absence
2287 * attribute value from GO.
2289 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2292 * set_noa - Set Notice of Absence parameters for GO (testing)
2293 * @priv: Private driver interface data
2295 * @start: Start time in ms from next TBTT
2296 * @duration: Duration in ms
2297 * Returns: 0 on success or -1 on failure
2299 * This function is used to set Notice of Absence parameters for GO. It
2300 * is used only for testing. To disable NoA, all parameters are set to
2303 int (*set_noa)(void *priv, u8 count, int start, int duration);
2306 * set_p2p_powersave - Set P2P power save options
2307 * @priv: Private driver interface data
2308 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2309 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2310 * @ctwindow: 0.. = change (msec), -1 = no change
2311 * Returns: 0 on success or -1 on failure
2313 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2317 * ampdu - Enable/disable aggregation
2318 * @priv: Private driver interface data
2319 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2320 * Returns: 0 on success or -1 on failure
2322 int (*ampdu)(void *priv, int ampdu);
2325 * get_radio_name - Get physical radio name for the device
2326 * @priv: Private driver interface data
2327 * Returns: Radio name or %NULL if not known
2329 * The returned data must not be modified by the caller. It is assumed
2330 * that any interface that has the same radio name as another is
2331 * sharing the same physical radio. This information can be used to
2332 * share scan results etc. information between the virtual interfaces
2333 * to speed up various operations.
2335 const char * (*get_radio_name)(void *priv);
2338 * p2p_find - Start P2P Device Discovery
2339 * @priv: Private driver interface data
2340 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2341 * @type: Device Discovery type (enum p2p_discovery_type)
2342 * Returns: 0 on success, -1 on failure
2344 * This function is only used if the driver implements P2P management,
2345 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2346 * struct wpa_driver_capa.
2348 int (*p2p_find)(void *priv, unsigned int timeout, int type);
2351 * p2p_stop_find - Stop P2P Device Discovery
2352 * @priv: Private driver interface data
2353 * Returns: 0 on success, -1 on failure
2355 * This function is only used if the driver implements P2P management,
2356 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2357 * struct wpa_driver_capa.
2359 int (*p2p_stop_find)(void *priv);
2362 * p2p_listen - Start P2P Listen state for specified duration
2363 * @priv: Private driver interface data
2364 * @timeout: Listen state duration in milliseconds
2365 * Returns: 0 on success, -1 on failure
2367 * This function can be used to request the P2P module to keep the
2368 * device discoverable on the listen channel for an extended set of
2369 * time. At least in its current form, this is mainly used for testing
2370 * purposes and may not be of much use for normal P2P operations.
2372 * This function is only used if the driver implements P2P management,
2373 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2374 * struct wpa_driver_capa.
2376 int (*p2p_listen)(void *priv, unsigned int timeout);
2379 * p2p_connect - Start P2P group formation (GO negotiation)
2380 * @priv: Private driver interface data
2381 * @peer_addr: MAC address of the peer P2P client
2382 * @wps_method: enum p2p_wps_method value indicating config method
2383 * @go_intent: Local GO intent value (1..15)
2384 * @own_interface_addr: Intended interface address to use with the
2386 * @force_freq: The only allowed channel frequency in MHz or 0
2387 * @persistent_group: Whether to create persistent group
2388 * Returns: 0 on success, -1 on failure
2390 * This function is only used if the driver implements P2P management,
2391 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2392 * struct wpa_driver_capa.
2394 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method,
2395 int go_intent, const u8 *own_interface_addr,
2396 unsigned int force_freq, int persistent_group);
2399 * wps_success_cb - Report successfully completed WPS provisioning
2400 * @priv: Private driver interface data
2401 * @peer_addr: Peer address
2402 * Returns: 0 on success, -1 on failure
2404 * This function is used to report successfully completed WPS
2405 * provisioning during group formation in both GO/Registrar and
2406 * client/Enrollee roles.
2408 * This function is only used if the driver implements P2P management,
2409 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2410 * struct wpa_driver_capa.
2412 int (*wps_success_cb)(void *priv, const u8 *peer_addr);
2415 * p2p_group_formation_failed - Report failed WPS provisioning
2416 * @priv: Private driver interface data
2417 * Returns: 0 on success, -1 on failure
2419 * This function is used to report failed group formation. This can
2420 * happen either due to failed WPS provisioning or due to 15 second
2421 * timeout during the provisioning phase.
2423 * This function is only used if the driver implements P2P management,
2424 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2425 * struct wpa_driver_capa.
2427 int (*p2p_group_formation_failed)(void *priv);
2430 * p2p_set_params - Set P2P parameters
2431 * @priv: Private driver interface data
2432 * @params: P2P parameters
2433 * Returns: 0 on success, -1 on failure
2435 * This function is only used if the driver implements P2P management,
2436 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2437 * struct wpa_driver_capa.
2439 int (*p2p_set_params)(void *priv, const struct p2p_params *params);
2442 * p2p_prov_disc_req - Send Provision Discovery Request
2443 * @priv: Private driver interface data
2444 * @peer_addr: MAC address of the peer P2P client
2445 * @config_methods: WPS Config Methods value (only one bit set)
2446 * Returns: 0 on success, -1 on failure
2448 * This function can be used to request a discovered P2P peer to
2449 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2450 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2451 * Provision Discovery Request frame is transmitted once immediately
2452 * and if no response is received, the frame will be sent again
2453 * whenever the target device is discovered during device dsicovery
2454 * (start with a p2p_find() call). Response from the peer is indicated
2455 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2457 * This function is only used if the driver implements P2P management,
2458 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2459 * struct wpa_driver_capa.
2461 int (*p2p_prov_disc_req)(void *priv, const u8 *peer_addr,
2462 u16 config_methods, int join);
2465 * p2p_sd_request - Schedule a service discovery query
2466 * @priv: Private driver interface data
2467 * @dst: Destination peer or %NULL to apply for all peers
2468 * @tlvs: P2P Service Query TLV(s)
2469 * Returns: Reference to the query or 0 on failure
2471 * Response to the query is indicated with the
2472 * EVENT_P2P_SD_RESPONSE driver event.
2474 * This function is only used if the driver implements P2P management,
2475 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2476 * struct wpa_driver_capa.
2478 u64 (*p2p_sd_request)(void *priv, const u8 *dst,
2479 const struct wpabuf *tlvs);
2482 * p2p_sd_cancel_request - Cancel a pending service discovery query
2483 * @priv: Private driver interface data
2484 * @req: Query reference from p2p_sd_request()
2485 * Returns: 0 on success, -1 on failure
2487 * This function is only used if the driver implements P2P management,
2488 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2489 * struct wpa_driver_capa.
2491 int (*p2p_sd_cancel_request)(void *priv, u64 req);
2494 * p2p_sd_response - Send response to a service discovery query
2495 * @priv: Private driver interface data
2496 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2497 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2498 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2499 * @resp_tlvs: P2P Service Response TLV(s)
2500 * Returns: 0 on success, -1 on failure
2502 * This function is called as a response to the request indicated with
2503 * the EVENT_P2P_SD_REQUEST driver event.
2505 * This function is only used if the driver implements P2P management,
2506 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2507 * struct wpa_driver_capa.
2509 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst,
2511 const struct wpabuf *resp_tlvs);
2514 * p2p_service_update - Indicate a change in local services
2515 * @priv: Private driver interface data
2516 * Returns: 0 on success, -1 on failure
2518 * This function needs to be called whenever there is a change in
2519 * availability of the local services. This will increment the
2520 * Service Update Indicator value which will be used in SD Request and
2523 * This function is only used if the driver implements P2P management,
2524 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2525 * struct wpa_driver_capa.
2527 int (*p2p_service_update)(void *priv);
2530 * p2p_reject - Reject peer device (explicitly block connections)
2531 * @priv: Private driver interface data
2532 * @addr: MAC address of the peer
2533 * Returns: 0 on success, -1 on failure
2535 int (*p2p_reject)(void *priv, const u8 *addr);
2538 * p2p_invite - Invite a P2P Device into a group
2539 * @priv: Private driver interface data
2540 * @peer: Device Address of the peer P2P Device
2541 * @role: Local role in the group
2542 * @bssid: Group BSSID or %NULL if not known
2544 * @ssid_len: Length of ssid in octets
2545 * @go_dev_addr: Forced GO Device Address or %NULL if none
2546 * @persistent_group: Whether this is to reinvoke a persistent group
2547 * Returns: 0 on success, -1 on failure
2549 int (*p2p_invite)(void *priv, const u8 *peer, int role,
2550 const u8 *bssid, const u8 *ssid, size_t ssid_len,
2551 const u8 *go_dev_addr, int persistent_group);
2554 * send_tdls_mgmt - for sending TDLS management packets
2555 * @priv: private driver interface data
2556 * @dst: Destination (peer) MAC address
2557 * @action_code: TDLS action code for the mssage
2558 * @dialog_token: Dialog Token to use in the message (if needed)
2559 * @status_code: Status Code or Reason Code to use (if needed)
2560 * @buf: TDLS IEs to add to the message
2561 * @len: Length of buf in octets
2562 * Returns: 0 on success, negative (<0) on failure
2564 * This optional function can be used to send packet to driver which is
2565 * responsible for receiving and sending all TDLS packets.
2567 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2568 u8 dialog_token, u16 status_code,
2569 const u8 *buf, size_t len);
2572 * tdls_oper - Ask the driver to perform high-level TDLS operations
2573 * @priv: Private driver interface data
2574 * @oper: TDLS high-level operation. See %enum tdls_oper
2575 * @peer: Destination (peer) MAC address
2576 * Returns: 0 on success, negative (<0) on failure
2578 * This optional function can be used to send high-level TDLS commands
2581 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2584 * wnm_oper - Notify driver of the WNM frame reception
2585 * @priv: Private driver interface data
2586 * @oper: WNM operation. See %enum wnm_oper
2587 * @peer: Destination (peer) MAC address
2588 * @buf: Buffer for the driver to fill in (for getting IE)
2589 * @buf_len: Return the len of buf
2590 * Returns: 0 on success, negative (<0) on failure
2592 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2593 u8 *buf, u16 *buf_len);
2596 * set_qos_map - Set QoS Map
2597 * @priv: Private driver interface data
2598 * @qos_map_set: QoS Map
2599 * @qos_map_set_len: Length of QoS Map
2601 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2602 u8 qos_map_set_len);
2605 * signal_poll - Get current connection information
2606 * @priv: Private driver interface data
2607 * @signal_info: Connection info structure
2609 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2612 * set_authmode - Set authentication algorithm(s) for static WEP
2613 * @priv: Private driver interface data
2614 * @authmode: 1=Open System, 2=Shared Key, 3=both
2615 * Returns: 0 on success, -1 on failure
2617 * This function can be used to set authentication algorithms for AP
2618 * mode when static WEP is used. If the driver uses user space MLME/SME
2619 * implementation, there is no need to implement this function.
2621 * DEPRECATED - use set_ap() instead
2623 int (*set_authmode)(void *priv, int authmode);
2626 * set_rekey_info - Set rekey information
2627 * @priv: Private driver interface data
2630 * @replay_ctr: Current EAPOL-Key Replay Counter
2632 * This optional function can be used to provide information for the
2633 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2634 * while the host (including wpa_supplicant) is sleeping.
2636 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2637 const u8 *replay_ctr);
2640 * sta_assoc - Station association indication
2641 * @priv: Private driver interface data
2642 * @own_addr: Source address and BSSID for association frame
2643 * @addr: MAC address of the station to associate
2644 * @reassoc: flag to indicate re-association
2645 * @status: association response status code
2646 * @ie: assoc response ie buffer
2647 * @len: ie buffer length
2648 * Returns: 0 on success, -1 on failure
2650 * This function indicates the driver to send (Re)Association
2651 * Response frame to the station.
2653 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2654 int reassoc, u16 status, const u8 *ie, size_t len);
2657 * sta_auth - Station authentication indication
2658 * @priv: Private driver interface data
2659 * @own_addr: Source address and BSSID for authentication frame
2660 * @addr: MAC address of the station to associate
2661 * @seq: authentication sequence number
2662 * @status: authentication response status code
2663 * @ie: authentication frame ie buffer
2664 * @len: ie buffer length
2666 * This function indicates the driver to send Authentication frame
2669 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2670 u16 seq, u16 status, const u8 *ie, size_t len);
2673 * add_tspec - Add traffic stream
2674 * @priv: Private driver interface data
2675 * @addr: MAC address of the station to associate
2676 * @tspec_ie: tspec ie buffer
2677 * @tspec_ielen: tspec ie length
2678 * Returns: 0 on success, -1 on failure
2680 * This function adds the traffic steam for the station
2681 * and fills the medium_time in tspec_ie.
2683 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2684 size_t tspec_ielen);
2687 * add_sta_node - Add a station node in the driver
2688 * @priv: Private driver interface data
2689 * @addr: MAC address of the station to add
2690 * @auth_alg: authentication algorithm used by the station
2691 * Returns: 0 on success, -1 on failure
2693 * This function adds the station node in the driver, when
2694 * the station gets added by FT-over-DS.
2696 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2699 * sched_scan - Request the driver to initiate scheduled scan
2700 * @priv: Private driver interface data
2701 * @params: Scan parameters
2702 * @interval: Interval between scan cycles in milliseconds
2703 * Returns: 0 on success, -1 on failure
2705 * This operation should be used for scheduled scan offload to
2706 * the hardware. Every time scan results are available, the
2707 * driver should report scan results event for wpa_supplicant
2708 * which will eventually request the results with
2709 * wpa_driver_get_scan_results2(). This operation is optional
2710 * and if not provided or if it returns -1, we fall back to
2711 * normal host-scheduled scans.
2713 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2717 * stop_sched_scan - Request the driver to stop a scheduled scan
2718 * @priv: Private driver interface data
2719 * Returns: 0 on success, -1 on failure
2721 * This should cause the scheduled scan to be stopped and
2722 * results should stop being sent. Must be supported if
2723 * sched_scan is supported.
2725 int (*stop_sched_scan)(void *priv);
2728 * poll_client - Probe (null data or such) the given station
2729 * @priv: Private driver interface data
2730 * @own_addr: MAC address of sending interface
2731 * @addr: MAC address of the station to probe
2732 * @qos: Indicates whether station is QoS station
2734 * This function is used to verify whether an associated station is
2735 * still present. This function does not need to be implemented if the
2736 * driver provides such inactivity polling mechanism.
2738 void (*poll_client)(void *priv, const u8 *own_addr,
2739 const u8 *addr, int qos);
2742 * radio_disable - Disable/enable radio
2743 * @priv: Private driver interface data
2744 * @disabled: 1=disable 0=enable radio
2745 * Returns: 0 on success, -1 on failure
2747 * This optional command is for testing purposes. It can be used to
2748 * disable the radio on a testbed device to simulate out-of-radio-range
2751 int (*radio_disable)(void *priv, int disabled);
2754 * switch_channel - Announce channel switch and migrate the GO to the
2756 * @priv: Private driver interface data
2757 * @freq: Frequency in MHz
2758 * Returns: 0 on success, -1 on failure
2760 * This function is used to move the GO to the legacy STA channel to
2761 * avoid frequency conflict in single channel concurrency.
2763 int (*switch_channel)(void *priv, unsigned int freq);
2766 * start_dfs_cac - Listen for radar interference on the channel
2767 * @priv: Private driver interface data
2768 * @freq: Channel parameters
2769 * Returns: 0 on success, -1 on failure
2771 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
2774 * stop_ap - Removes beacon from AP
2775 * @priv: Private driver interface data
2776 * Returns: 0 on success, -1 on failure (or if not supported)
2778 * This optional function can be used to disable AP mode related
2779 * configuration. Unlike deinit_ap, it does not change to station
2782 int (*stop_ap)(void *priv);
2785 * get_survey - Retrieve survey data
2786 * @priv: Private driver interface data
2787 * @freq: If set, survey data for the specified frequency is only
2788 * being requested. If not set, all survey data is requested.
2789 * Returns: 0 on success, -1 on failure
2791 * Use this to retrieve:
2793 * - the observed channel noise floor
2794 * - the amount of time we have spent on the channel
2795 * - the amount of time during which we have spent on the channel that
2796 * the radio has determined the medium is busy and we cannot
2798 * - the amount of time we have spent receiving data
2799 * - the amount of time we have spent transmitting data
2801 * This data can be used for spectrum heuristics. One example is
2802 * Automatic Channel Selection (ACS). The channel survey data is
2803 * kept on a linked list on the channel data, one entry is added
2804 * for each survey. The min_nf of the channel is updated for each
2807 int (*get_survey)(void *priv, unsigned int freq);
2810 * status - Get driver interface status information
2811 * @priv: Private driver interface data
2812 * @buf: Buffer for printing tou the status information
2813 * @buflen: Maximum length of the buffer
2814 * Returns: Length of written status information or -1 on failure
2816 int (*status)(void *priv, char *buf, size_t buflen);
2821 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2823 enum wpa_event_type {
2825 * EVENT_ASSOC - Association completed
2827 * This event needs to be delivered when the driver completes IEEE
2828 * 802.11 association or reassociation successfully.
2829 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2830 * after this event has been generated. In addition, optional
2831 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2832 * more information about the association. If the driver interface gets
2833 * both of these events at the same time, it can also include the
2834 * assoc_info data in EVENT_ASSOC call.
2839 * EVENT_DISASSOC - Association lost
2841 * This event should be called when association is lost either due to
2842 * receiving deauthenticate or disassociate frame from the AP or when
2843 * sending either of these frames to the current AP. If the driver
2844 * supports separate deauthentication event, EVENT_DISASSOC should only
2845 * be used for disassociation and EVENT_DEAUTH for deauthentication.
2846 * In AP mode, union wpa_event_data::disassoc_info is required.
2851 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2853 * This event must be delivered when a Michael MIC error is detected by
2854 * the local driver. Additional data for event processing is
2855 * provided with union wpa_event_data::michael_mic_failure. This
2856 * information is used to request new encyption key and to initiate
2857 * TKIP countermeasures if needed.
2859 EVENT_MICHAEL_MIC_FAILURE,
2862 * EVENT_SCAN_RESULTS - Scan results available
2864 * This event must be called whenever scan results are available to be
2865 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2866 * is expected to be used some time after struct wpa_driver_ops::scan()
2867 * is called. If the driver provides an unsolicited event when the scan
2868 * has been completed, this event can be used to trigger
2869 * EVENT_SCAN_RESULTS call. If such event is not available from the
2870 * driver, the driver wrapper code is expected to use a registered
2871 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
2872 * scan is expected to be completed. Optional information about
2873 * completed scan can be provided with union wpa_event_data::scan_info.
2878 * EVENT_ASSOCINFO - Report optional extra information for association
2880 * This event can be used to report extra association information for
2881 * EVENT_ASSOC processing. This extra information includes IEs from
2882 * association frames and Beacon/Probe Response frames in union
2883 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2884 * EVENT_ASSOC. Alternatively, the driver interface can include
2885 * assoc_info data in the EVENT_ASSOC call if it has all the
2886 * information available at the same point.
2891 * EVENT_INTERFACE_STATUS - Report interface status changes
2893 * This optional event can be used to report changes in interface
2894 * status (interface added/removed) using union
2895 * wpa_event_data::interface_status. This can be used to trigger
2896 * wpa_supplicant to stop and re-start processing for the interface,
2897 * e.g., when a cardbus card is ejected/inserted.
2899 EVENT_INTERFACE_STATUS,
2902 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2904 * This event can be used to inform wpa_supplicant about candidates for
2905 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2906 * for scan request (ap_scan=2 mode), this event is required for
2907 * pre-authentication. If wpa_supplicant is performing scan request
2908 * (ap_scan=1), this event is optional since scan results can be used
2909 * to add pre-authentication candidates. union
2910 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2911 * candidate and priority of the candidate, e.g., based on the signal
2912 * strength, in order to try to pre-authenticate first with candidates
2913 * that are most likely targets for re-association.
2915 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2916 * on the candidate list. In addition, it can be called for the current
2917 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2918 * will automatically skip pre-authentication in cases where a valid
2919 * PMKSA exists. When more than one candidate exists, this event should
2920 * be generated once for each candidate.
2922 * Driver will be notified about successful pre-authentication with
2923 * struct wpa_driver_ops::add_pmkid() calls.
2925 EVENT_PMKID_CANDIDATE,
2928 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2930 * This event can be used to inform wpa_supplicant about desire to set
2931 * up secure direct link connection between two stations as defined in
2932 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2933 * STAKey negotiation. The caller will need to set peer address for the
2939 * EVENT_TDLS - Request TDLS operation
2941 * This event can be used to request a TDLS operation to be performed.
2946 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2948 * The driver is expected to report the received FT IEs from
2949 * FT authentication sequence from the AP. The FT IEs are included in
2950 * the extra information in union wpa_event_data::ft_ies.
2955 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2957 * The driver can use this event to inform wpa_supplicant about a STA
2958 * in an IBSS with which protected frames could be exchanged. This
2959 * event starts RSN authentication with the other STA to authenticate
2960 * the STA and set up encryption keys with it.
2962 EVENT_IBSS_RSN_START,
2965 * EVENT_AUTH - Authentication result
2967 * This event should be called when authentication attempt has been
2968 * completed. This is only used if the driver supports separate
2969 * authentication step (struct wpa_driver_ops::authenticate).
2970 * Information about authentication result is included in
2971 * union wpa_event_data::auth.
2976 * EVENT_DEAUTH - Authentication lost
2978 * This event should be called when authentication is lost either due
2979 * to receiving deauthenticate frame from the AP or when sending that
2980 * frame to the current AP.
2981 * In AP mode, union wpa_event_data::deauth_info is required.
2986 * EVENT_ASSOC_REJECT - Association rejected
2988 * This event should be called when (re)association attempt has been
2989 * rejected by the AP. Information about the association response is
2990 * included in union wpa_event_data::assoc_reject.
2995 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2997 EVENT_AUTH_TIMED_OUT,
3000 * EVENT_ASSOC_TIMED_OUT - Association timed out
3002 EVENT_ASSOC_TIMED_OUT,
3005 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
3010 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3012 EVENT_WPS_BUTTON_PUSHED,
3015 * EVENT_TX_STATUS - Report TX status
3020 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3022 EVENT_RX_FROM_UNKNOWN,
3025 * EVENT_RX_MGMT - Report RX of a management frame
3030 * EVENT_RX_ACTION - Action frame received
3032 * This event is used to indicate when an Action frame has been
3033 * received. Information about the received frame is included in
3034 * union wpa_event_data::rx_action.
3039 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3041 * This event is used to indicate when the driver has started the
3042 * requested remain-on-channel duration. Information about the
3043 * operation is included in union wpa_event_data::remain_on_channel.
3045 EVENT_REMAIN_ON_CHANNEL,
3048 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3050 * This event is used to indicate when the driver has completed
3051 * remain-on-channel duration, i.e., may noot be available on the
3052 * requested channel anymore. Information about the
3053 * operation is included in union wpa_event_data::remain_on_channel.
3055 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3058 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
3060 * This event is used only by driver_test.c and userspace MLME.
3065 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3067 * This event is used to indicate when a Probe Request frame has been
3068 * received. Information about the received frame is included in
3069 * union wpa_event_data::rx_probe_req. The driver is required to report
3070 * these events only after successfully completed probe_req_report()
3071 * commands to request the events (i.e., report parameter is non-zero)
3072 * in station mode. In AP mode, Probe Request frames should always be
3078 * EVENT_NEW_STA - New wired device noticed
3080 * This event is used to indicate that a new device has been detected
3081 * in a network that does not use association-like functionality (i.e.,
3082 * mainly wired Ethernet). This can be used to start EAPOL
3083 * authenticator when receiving a frame from a device. The address of
3084 * the device is included in union wpa_event_data::new_sta.
3089 * EVENT_EAPOL_RX - Report received EAPOL frame
3091 * When in AP mode with hostapd, this event is required to be used to
3092 * deliver the receive EAPOL frames from the driver. With
3093 * %wpa_supplicant, this event is used only if the send_eapol() handler
3094 * is used to override the use of l2_packet for EAPOL frame TX.
3099 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3101 * This event is used to indicate changes in the signal strength
3102 * observed in frames received from the current AP if signal strength
3103 * monitoring has been enabled with signal_monitor().
3105 EVENT_SIGNAL_CHANGE,
3108 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3110 * This event is used to indicate that the interface was enabled after
3111 * having been previously disabled, e.g., due to rfkill.
3113 EVENT_INTERFACE_ENABLED,
3116 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3118 * This event is used to indicate that the interface was disabled,
3119 * e.g., due to rfkill.
3121 EVENT_INTERFACE_DISABLED,
3124 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3126 * This event is used to indicate that the channel list has changed,
3127 * e.g., because of a regulatory domain change triggered by scan
3128 * results including an AP advertising a country code.
3130 EVENT_CHANNEL_LIST_CHANGED,
3133 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3135 * This event is used to indicate that the driver cannot maintain this
3136 * interface in its operation mode anymore. The most likely use for
3137 * this is to indicate that AP mode operation is not available due to
3138 * operating channel would need to be changed to a DFS channel when
3139 * the driver does not support radar detection and another virtual
3140 * interfaces caused the operating channel to change. Other similar
3141 * resource conflicts could also trigger this for station mode
3144 EVENT_INTERFACE_UNAVAILABLE,
3147 * EVENT_BEST_CHANNEL
3149 * Driver generates this event whenever it detects a better channel
3150 * (e.g., based on RSSI or channel use). This information can be used
3151 * to improve channel selection for a new AP/P2P group.
3156 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3158 * This event should be called when a Deauthentication frame is dropped
3159 * due to it not being protected (MFP/IEEE 802.11w).
3160 * union wpa_event_data::unprot_deauth is required to provide more
3161 * details of the frame.
3163 EVENT_UNPROT_DEAUTH,
3166 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3168 * This event should be called when a Disassociation frame is dropped
3169 * due to it not being protected (MFP/IEEE 802.11w).
3170 * union wpa_event_data::unprot_disassoc is required to provide more
3171 * details of the frame.
3173 EVENT_UNPROT_DISASSOC,
3176 * EVENT_STATION_LOW_ACK
3178 * Driver generates this event whenever it detected that a particular
3179 * station was lost. Detection can be through massive transmission
3180 * failures for example.
3182 EVENT_STATION_LOW_ACK,
3185 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
3187 * This event is used only if the driver implements P2P management
3188 * internally. Event data is stored in
3189 * union wpa_event_data::p2p_dev_found.
3191 EVENT_P2P_DEV_FOUND,
3194 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
3196 * This event is used only if the driver implements P2P management
3197 * internally. Event data is stored in
3198 * union wpa_event_data::p2p_go_neg_req_rx.
3200 EVENT_P2P_GO_NEG_REQ_RX,
3203 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
3205 * This event is used only if the driver implements P2P management
3206 * internally. Event data is stored in
3207 * union wpa_event_data::p2p_go_neg_completed.
3209 EVENT_P2P_GO_NEG_COMPLETED,
3211 EVENT_P2P_PROV_DISC_REQUEST,
3212 EVENT_P2P_PROV_DISC_RESPONSE,
3213 EVENT_P2P_SD_REQUEST,
3214 EVENT_P2P_SD_RESPONSE,
3217 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3219 EVENT_IBSS_PEER_LOST,
3222 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3224 * This event carries the new replay counter to notify wpa_supplicant
3225 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3226 * completed Group Key Handshake while the host (including
3227 * wpa_supplicant was sleeping).
3229 EVENT_DRIVER_GTK_REKEY,
3232 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3234 EVENT_SCHED_SCAN_STOPPED,
3237 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3239 * This event indicates that the station responded to the poll
3240 * initiated with @poll_client.
3242 EVENT_DRIVER_CLIENT_POLL_OK,
3245 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3247 EVENT_EAPOL_TX_STATUS,
3250 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3252 * Described in wpa_event_data.ch_switch
3257 * EVENT_WNM - Request WNM operation
3259 * This event can be used to request a WNM operation to be performed.
3264 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3266 * This event indicates that the driver reported a connection failure
3267 * with the specified client (for example, max client reached, etc.) in
3270 EVENT_CONNECT_FAILED_REASON,
3273 * EVENT_RADAR_DETECTED - Notify of radar detection
3275 * A radar has been detected on the supplied frequency, hostapd should
3276 * react accordingly (e.g., change channel).
3278 EVENT_DFS_RADAR_DETECTED,
3281 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3283 * After a successful CAC, the channel can be marked clear and used.
3285 EVENT_DFS_CAC_FINISHED,
3288 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3290 * The CAC was not successful, and the channel remains in the previous
3291 * state. This may happen due to a radar beeing detected or other
3292 * external influences.
3294 EVENT_DFS_CAC_ABORTED,
3297 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3299 * The channel which was previously unavailable is now available again.
3301 EVENT_DFS_NOP_FINISHED,
3304 * EVENT_SURVEY - Received survey data
3306 * This event gets triggered when a driver query is issued for survey
3307 * data and the requested data becomes available. The returned data is
3308 * stored in struct survey_results. The results provide at most one
3309 * survey entry for each frequency and at minimum will provide one survey
3310 * entry for one frequency. The survey data can be os_malloc()'d and
3311 * then os_free()'d, so the event callback must only copy data.
3318 * struct freq_survey - Channel survey info
3320 * @ifidx: Interface index in which this survey was observed
3321 * @freq: Center of frequency of the surveyed channel
3322 * @nf: Channel noise floor in dBm
3323 * @channel_time: Amount of time in ms the radio spent on the channel
3324 * @channel_time_busy: Amount of time in ms the radio detected some signal
3325 * that indicated to the radio the channel was not clear
3326 * @channel_time_rx: Amount of time the radio spent receiving data
3327 * @channel_time_tx: Amount of time the radio spent transmitting data
3328 * @filled: bitmask indicating which fields have been reported, see
3329 * SURVEY_HAS_* defines.
3330 * @list: Internal list pointers
3332 struct freq_survey {
3337 u64 channel_time_busy;
3338 u64 channel_time_rx;
3339 u64 channel_time_tx;
3340 unsigned int filled;
3341 struct dl_list list;
3344 #define SURVEY_HAS_NF BIT(0)
3345 #define SURVEY_HAS_CHAN_TIME BIT(1)
3346 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3347 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3348 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3352 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3354 union wpa_event_data {
3356 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3358 * This structure is optional for EVENT_ASSOC calls and required for
3359 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3360 * driver interface does not need to generate separate EVENT_ASSOCINFO
3365 * reassoc - Flag to indicate association or reassociation
3370 * req_ies - (Re)Association Request IEs
3372 * If the driver generates WPA/RSN IE, this event data must be
3373 * returned for WPA handshake to have needed information. If
3374 * wpa_supplicant-generated WPA/RSN IE is used, this
3375 * information event is optional.
3377 * This should start with the first IE (fixed fields before IEs
3378 * are not included).
3383 * req_ies_len - Length of req_ies in bytes
3388 * resp_ies - (Re)Association Response IEs
3390 * Optional association data from the driver. This data is not
3391 * required WPA, but may be useful for some protocols and as
3392 * such, should be reported if this is available to the driver
3395 * This should start with the first IE (fixed fields before IEs
3396 * are not included).
3401 * resp_ies_len - Length of resp_ies in bytes
3403 size_t resp_ies_len;
3406 * beacon_ies - Beacon or Probe Response IEs
3408 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3409 * Probe Response frames from the current AP (i.e., the one
3410 * that the client just associated with). This information is
3411 * used to update WPA/RSN IE for the AP. If this field is not
3412 * set, the results from previous scan will be used. If no
3413 * data for the new AP is found, scan results will be requested
3414 * again (without scan request). At this point, the driver is
3415 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3418 * This should start with the first IE (fixed fields before IEs
3419 * are not included).
3421 const u8 *beacon_ies;
3424 * beacon_ies_len - Length of beacon_ies */
3425 size_t beacon_ies_len;
3428 * freq - Frequency of the operational channel in MHz
3433 * addr - Station address (for AP mode)
3439 * struct disassoc_info - Data for EVENT_DISASSOC events
3441 struct disassoc_info {
3443 * addr - Station address (for AP mode)
3448 * reason_code - Reason Code (host byte order) used in
3449 * Deauthentication frame
3454 * ie - Optional IE(s) in Disassociation frame
3459 * ie_len - Length of ie buffer in octets
3464 * locally_generated - Whether the frame was locally generated
3466 int locally_generated;
3470 * struct deauth_info - Data for EVENT_DEAUTH events
3472 struct deauth_info {
3474 * addr - Station address (for AP mode)
3479 * reason_code - Reason Code (host byte order) used in
3480 * Deauthentication frame
3485 * ie - Optional IE(s) in Deauthentication frame
3490 * ie_len - Length of ie buffer in octets
3495 * locally_generated - Whether the frame was locally generated
3497 int locally_generated;
3501 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3503 struct michael_mic_failure {
3506 } michael_mic_failure;
3509 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3511 struct interface_status {
3514 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3519 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3521 struct pmkid_candidate {
3522 /** BSSID of the PMKID candidate */
3524 /** Smaller the index, higher the priority */
3526 /** Whether RSN IE includes pre-authenticate flag */
3531 * struct stkstart - Data for EVENT_STKSTART
3538 * struct tdls - Data for EVENT_TDLS
3544 TDLS_REQUEST_TEARDOWN
3546 u16 reason_code; /* for teardown */
3550 * struct wnm - Data for EVENT_WNM
3568 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3570 * During FT (IEEE 802.11r) authentication sequence, the driver is
3571 * expected to use this event to report received FT IEs (MDIE, FTIE,
3572 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3573 * IEs for the next message will be delivered through the
3574 * struct wpa_driver_ops::update_ft_ies() callback.
3580 u8 target_ap[ETH_ALEN];
3581 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3583 /** Length of ric_ies buffer in octets */
3588 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3590 struct ibss_rsn_start {
3595 * struct auth_info - Data for EVENT_AUTH events
3601 u16 auth_transaction;
3608 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3610 struct assoc_reject {
3612 * bssid - BSSID of the AP that rejected association
3617 * resp_ies - (Re)Association Response IEs
3619 * Optional association data from the driver. This data is not
3620 * required WPA, but may be useful for some protocols and as
3621 * such, should be reported if this is available to the driver
3624 * This should start with the first IE (fixed fields before IEs
3625 * are not included).
3630 * resp_ies_len - Length of resp_ies in bytes
3632 size_t resp_ies_len;
3635 * status_code - Status Code from (Re)association Response
3640 struct timeout_event {
3645 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3654 * struct tx_status - Data for EVENT_TX_STATUS events
3666 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3668 struct rx_from_unknown {
3675 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3681 int ssi_signal; /* dBm */
3685 * struct rx_action - Data for EVENT_RX_ACTION events
3689 * da - Destination address of the received Action frame
3694 * sa - Source address of the received Action frame
3699 * bssid - Address 3 of the received Action frame
3704 * category - Action frame category
3709 * data - Action frame body after category field
3714 * len - Length of data in octets
3719 * freq - Frequency (in MHz) on which the frame was received
3725 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3727 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3729 struct remain_on_channel {
3731 * freq - Channel frequency in MHz
3736 * duration - Duration to remain on the channel in milliseconds
3738 unsigned int duration;
3739 } remain_on_channel;
3742 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3743 * @aborted: Whether the scan was aborted
3744 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3745 * @num_freqs: Number of entries in freqs array
3746 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3748 * @num_ssids: Number of entries in ssids array
3754 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3759 * struct mlme_rx - Data for EVENT_MLME_RX events
3770 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3772 struct rx_probe_req {
3774 * sa - Source address of the received Probe Request frame
3779 * da - Destination address of the received Probe Request frame
3780 * or %NULL if not available
3785 * bssid - BSSID of the received Probe Request frame or %NULL
3791 * ie - IEs from the Probe Request body
3796 * ie_len - Length of ie buffer in octets
3801 * signal - signal strength in dBm (or 0 if not available)
3807 * struct new_sta - Data for EVENT_NEW_STA events
3814 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3823 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3825 struct wpa_signal_info signal_change;
3828 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3829 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3830 * @freq_5: Best 5 GHz band channel frequency in MHz
3831 * @freq_overall: Best channel frequency in MHz
3833 * 0 can be used to indicate no preference in either band.
3835 struct best_channel {
3841 struct unprot_deauth {
3847 struct unprot_disassoc {
3854 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3855 * @addr: station address
3862 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3864 struct p2p_dev_found {
3867 const u8 *pri_dev_type;
3868 const char *dev_name;
3875 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3877 struct p2p_go_neg_req_rx {
3880 } p2p_go_neg_req_rx;
3883 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3885 struct p2p_go_neg_completed {
3886 struct p2p_go_neg_results *res;
3887 } p2p_go_neg_completed;
3889 struct p2p_prov_disc_req {
3893 const u8 *pri_dev_type;
3894 const char *dev_name;
3895 u16 supp_config_methods;
3898 } p2p_prov_disc_req;
3900 struct p2p_prov_disc_resp {
3903 } p2p_prov_disc_resp;
3914 struct p2p_sd_resp {
3922 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3924 struct ibss_peer_lost {
3929 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3931 struct driver_gtk_rekey {
3933 const u8 *replay_ctr;
3937 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
3938 * @addr: station address
3940 struct client_poll {
3945 * struct eapol_tx_status
3946 * @dst: Original destination
3947 * @data: Data starting with IEEE 802.1X header (!)
3948 * @data_len: Length of data
3949 * @ack: Indicates ack or lost frame
3951 * This corresponds to hapd_send_eapol if the frame sent
3952 * there isn't just reported as EVENT_TX_STATUS.
3954 struct eapol_tx_status {
3963 * @freq: Frequency of new channel in MHz
3964 * @ht_enabled: Whether this is an HT channel
3965 * @ch_offset: Secondary channel offset
3974 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
3975 * @addr: Remote client address
3976 * @code: Reason code for connection failure
3978 struct connect_failed_reason {
3984 } connect_failed_reason;
3987 * struct dfs_event - Data for radar detected events
3988 * @freq: Frequency of the channel in MHz
3994 enum chan_width chan_width;
4000 * survey_results - Survey result data for EVENT_SURVEY
4001 * @freq_filter: Requested frequency survey filter, 0 if request
4002 * was for all survey data
4003 * @survey_list: Linked list of survey data
4005 struct survey_results {
4006 unsigned int freq_filter;
4007 struct dl_list survey_list; /* struct freq_survey */
4011 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4012 * @initiator: Initiator of the regulatory change
4014 struct channel_list_changed {
4015 enum reg_change_initiator initiator;
4016 } channel_list_changed;
4020 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4021 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4022 * with struct wpa_driver_ops::init()
4023 * @event: event type (defined above)
4024 * @data: possible extra data for the event
4026 * Driver wrapper code should call this function whenever an event is received
4029 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4030 union wpa_event_data *data);
4034 * The following inline functions are provided for convenience to simplify
4035 * event indication for some of the common events.
4038 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4039 size_t ielen, int reassoc)
4041 union wpa_event_data event;
4042 os_memset(&event, 0, sizeof(event));
4043 event.assoc_info.reassoc = reassoc;
4044 event.assoc_info.req_ies = ie;
4045 event.assoc_info.req_ies_len = ielen;
4046 event.assoc_info.addr = addr;
4047 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4050 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4052 union wpa_event_data event;
4053 os_memset(&event, 0, sizeof(event));
4054 event.disassoc_info.addr = addr;
4055 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4058 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4061 union wpa_event_data event;
4062 os_memset(&event, 0, sizeof(event));
4063 event.eapol_rx.src = src;
4064 event.eapol_rx.data = data;
4065 event.eapol_rx.data_len = data_len;
4066 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4069 /* driver_common.c */
4070 void wpa_scan_results_free(struct wpa_scan_results *res);
4072 /* Convert wpa_event_type to a string for logging */
4073 const char * event_to_string(enum wpa_event_type event);
4075 #endif /* DRIVER_H */