2 * Driver interface definition
3 * Copyright (c) 2003-2014, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
8 * This file defines a driver interface used by both %wpa_supplicant and
9 * hostapd. The first part of the file defines data structures used in various
10 * driver operations. This is followed by the struct wpa_driver_ops that each
11 * driver wrapper will beed to define with callback functions for requesting
12 * driver operations. After this, there are definitions for driver event
13 * reporting with wpa_supplicant_event() and some convenience helper functions
14 * that can be used to report events.
20 #define WPA_SUPPLICANT_DRIVER_VERSION 4
22 #include "common/defs.h"
23 #include "utils/list.h"
25 #define HOSTAPD_CHAN_DISABLED 0x00000001
26 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
27 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
28 #define HOSTAPD_CHAN_RADAR 0x00000008
29 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
30 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
31 #define HOSTAPD_CHAN_HT40 0x00000040
32 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
34 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
35 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
36 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
37 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
38 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
40 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
41 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
42 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
43 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
45 enum reg_change_initiator {
49 REGDOM_SET_BY_COUNTRY_IE,
57 REGDOM_TYPE_CUSTOM_WORLD,
58 REGDOM_TYPE_INTERSECTION,
62 * struct hostapd_channel_data - Channel information
64 struct hostapd_channel_data {
66 * chan - Channel number (IEEE 802.11)
71 * freq - Frequency in MHz
76 * flag - Channel flags (HOSTAPD_CHAN_*)
81 * max_tx_power - Regulatory transmit power limit in dBm
86 * survey_list - Linked list of surveys
88 struct dl_list survey_list;
91 * min_nf - Minimum observed noise floor, in dBm, based on all
92 * surveyed channel data
98 * interference_factor - Computed interference factor on this
99 * channel (used internally in src/ap/acs.c; driver wrappers do not
102 long double interference_factor;
103 #endif /* CONFIG_ACS */
105 /* DFS CAC time in milliseconds */
106 unsigned int dfs_cac_ms;
109 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
110 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
113 * struct hostapd_hw_modes - Supported hardware mode information
115 struct hostapd_hw_modes {
117 * mode - Hardware mode
119 enum hostapd_hw_mode mode;
122 * num_channels - Number of entries in the channels array
127 * channels - Array of supported channels
129 struct hostapd_channel_data *channels;
132 * num_rates - Number of entries in the rates array
137 * rates - Array of supported rates in 100 kbps units
142 * ht_capab - HT (IEEE 802.11n) capabilities
147 * mcs_set - MCS (IEEE 802.11n) rate parameters
152 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
157 * vht_capab - VHT (IEEE 802.11ac) capabilities
162 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
166 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
170 #define IEEE80211_MODE_INFRA 0
171 #define IEEE80211_MODE_IBSS 1
172 #define IEEE80211_MODE_AP 2
174 #define IEEE80211_CAP_ESS 0x0001
175 #define IEEE80211_CAP_IBSS 0x0002
176 #define IEEE80211_CAP_PRIVACY 0x0010
178 /* DMG (60 GHz) IEEE 802.11ad */
179 /* type - bits 0..1 */
180 #define IEEE80211_CAP_DMG_MASK 0x0003
181 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
182 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
183 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
185 #define WPA_SCAN_QUAL_INVALID BIT(0)
186 #define WPA_SCAN_NOISE_INVALID BIT(1)
187 #define WPA_SCAN_LEVEL_INVALID BIT(2)
188 #define WPA_SCAN_LEVEL_DBM BIT(3)
189 #define WPA_SCAN_AUTHENTICATED BIT(4)
190 #define WPA_SCAN_ASSOCIATED BIT(5)
193 * struct wpa_scan_res - Scan result for an BSS/IBSS
194 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
196 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
197 * @beacon_int: beacon interval in TUs (host byte order)
198 * @caps: capability information field in host byte order
199 * @qual: signal quality
200 * @noise: noise level
201 * @level: signal level
203 * @age: Age of the information in milliseconds (i.e., how many milliseconds
204 * ago the last Beacon or Probe Response frame was received)
205 * @ie_len: length of the following IE field in octets
206 * @beacon_ie_len: length of the following Beacon IE field in octets
208 * This structure is used as a generic format for scan results from the
209 * driver. Each driver interface implementation is responsible for converting
210 * the driver or OS specific scan results into this format.
212 * If the driver does not support reporting all IEs, the IE data structure is
213 * constructed of the IEs that are available. This field will also need to
214 * include SSID in IE format. All drivers are encouraged to be extended to
215 * report all IEs to make it easier to support future additions.
217 struct wpa_scan_res {
229 size_t beacon_ie_len;
231 * Followed by ie_len octets of IEs from Probe Response frame (or if
232 * the driver does not indicate source of IEs, these may also be from
233 * Beacon frame). After the first set of IEs, another set of IEs may
234 * follow (with beacon_ie_len octets of data) if the driver provides
240 * struct wpa_scan_results - Scan results
241 * @res: Array of pointers to allocated variable length scan result entries
242 * @num: Number of entries in the scan result array
243 * @fetch_time: Time when the results were fetched from the driver
245 struct wpa_scan_results {
246 struct wpa_scan_res **res;
248 struct os_reltime fetch_time;
252 * struct wpa_interface_info - Network interface information
253 * @next: Pointer to the next interface or NULL if this is the last one
254 * @ifname: Interface name that can be used with init() or init2()
255 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
257 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
258 * is not an allocated copy, i.e., get_interfaces() caller will not free
261 struct wpa_interface_info {
262 struct wpa_interface_info *next;
265 const char *drv_name;
268 #define WPAS_MAX_SCAN_SSIDS 16
271 * struct wpa_driver_scan_params - Scan parameters
272 * Data for struct wpa_driver_ops::scan2().
274 struct wpa_driver_scan_params {
276 * ssids - SSIDs to scan for
278 struct wpa_driver_scan_ssid {
280 * ssid - specific SSID to scan for (ProbeReq)
281 * %NULL or zero-length SSID is used to indicate active scan
282 * with wildcard SSID.
286 * ssid_len: Length of the SSID in octets
289 } ssids[WPAS_MAX_SCAN_SSIDS];
292 * num_ssids - Number of entries in ssids array
293 * Zero indicates a request for a passive scan.
298 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
303 * extra_ies_len - Length of extra_ies in octets
305 size_t extra_ies_len;
308 * freqs - Array of frequencies to scan or %NULL for all frequencies
310 * The frequency is set in MHz. The array is zero-terminated.
315 * filter_ssids - Filter for reporting SSIDs
317 * This optional parameter can be used to request the driver wrapper to
318 * filter scan results to include only the specified SSIDs. %NULL
319 * indicates that no filtering is to be done. This can be used to
320 * reduce memory needs for scan results in environments that have large
321 * number of APs with different SSIDs.
323 * The driver wrapper is allowed to take this allocated buffer into its
324 * own use by setting the pointer to %NULL. In that case, the driver
325 * wrapper is responsible for freeing the buffer with os_free() once it
326 * is not needed anymore.
328 struct wpa_driver_scan_filter {
334 * num_filter_ssids - Number of entries in filter_ssids array
336 size_t num_filter_ssids;
339 * filter_rssi - Filter by RSSI
341 * The driver may filter scan results in firmware to reduce host
342 * wakeups and thereby save power. Specify the RSSI threshold in s32
348 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
350 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
351 * Mbps from the support rates element(s) in the Probe Request frames
352 * and not to transmit the frames at any of those rates.
354 unsigned int p2p_probe:1;
357 * only_new_results - Request driver to report only new results
359 * This is used to request the driver to report only BSSes that have
360 * been detected after this scan request has been started, i.e., to
361 * flush old cached BSS entries.
363 unsigned int only_new_results:1;
366 * low_priority - Requests driver to use a lower scan priority
368 * This is used to request the driver to use a lower scan priority
369 * if it supports such a thing.
371 unsigned int low_priority:1;
374 * NOTE: Whenever adding new parameters here, please make sure
375 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
381 * struct wpa_driver_auth_params - Authentication parameters
382 * Data for struct wpa_driver_ops::authenticate().
384 struct wpa_driver_auth_params {
392 const u8 *wep_key[4];
393 size_t wep_key_len[4];
395 int local_state_change;
398 * p2p - Whether this connection is a P2P group
408 WPS_MODE_NONE /* no WPS provisioning being used */,
409 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
410 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
415 * struct wpa_driver_associate_params - Association parameters
416 * Data for struct wpa_driver_ops::associate().
418 struct wpa_driver_associate_params {
420 * bssid - BSSID of the selected AP
421 * This can be %NULL, if ap_scan=2 mode is used and the driver is
422 * responsible for selecting with which BSS to associate. */
426 * bssid_hint - BSSID of a proposed AP
428 * This indicates which BSS has been found a suitable candidate for
429 * initial association for drivers that use driver/firmwate-based BSS
430 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
431 * the driver from selecting other BSSes in the ESS.
433 const u8 *bssid_hint;
436 * ssid - The selected SSID
441 * ssid_len - Length of the SSID (1..32)
446 * freq - Frequency of the channel the selected AP is using
447 * Frequency that the selected AP is using (in MHz as
448 * reported in the scan results)
453 * freq_hint - Frequency of the channel the proposed AP is using
455 * This provides a channel on which a suitable BSS has been found as a
456 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
457 * limit the driver from selecting other channels for
458 * driver/firmware-based BSS selection.
463 * bg_scan_period - Background scan period in seconds, 0 to disable
464 * background scan, or -1 to indicate no change to default driver
470 * beacon_int - Beacon interval for IBSS or 0 to use driver default
475 * wpa_ie - WPA information element for (Re)Association Request
476 * WPA information element to be included in (Re)Association
477 * Request (including information element id and length). Use
478 * of this WPA IE is optional. If the driver generates the WPA
479 * IE, it can use pairwise_suite, group_suite, and
480 * key_mgmt_suite to select proper algorithms. In this case,
481 * the driver has to notify wpa_supplicant about the used WPA
482 * IE by generating an event that the interface code will
483 * convert into EVENT_ASSOCINFO data (see below).
485 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
486 * instead. The driver can determine which version is used by
487 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
490 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
495 * wpa_ie_len - length of the wpa_ie
500 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
502 unsigned int wpa_proto;
505 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
507 * This is usually ignored if @wpa_ie is used.
509 unsigned int pairwise_suite;
512 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
514 * This is usually ignored if @wpa_ie is used.
516 unsigned int group_suite;
519 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
521 * This is usually ignored if @wpa_ie is used.
523 unsigned int key_mgmt_suite;
526 * auth_alg - Allowed authentication algorithms
527 * Bit field of WPA_AUTH_ALG_*
532 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
537 * wep_key - WEP keys for static WEP configuration
539 const u8 *wep_key[4];
542 * wep_key_len - WEP key length for static WEP configuration
544 size_t wep_key_len[4];
547 * wep_tx_keyidx - WEP TX key index for static WEP configuration
552 * mgmt_frame_protection - IEEE 802.11w management frame protection
554 enum mfp_options mgmt_frame_protection;
557 * ft_ies - IEEE 802.11r / FT information elements
558 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
559 * for fast transition, this parameter is set to include the IEs that
560 * are to be sent in the next FT Authentication Request message.
561 * update_ft_ies() handler is called to update the IEs for further
562 * FT messages in the sequence.
564 * The driver should use these IEs only if the target AP is advertising
565 * the same mobility domain as the one included in the MDIE here.
567 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
568 * AP after the initial association. These IEs can only be used if the
569 * target AP is advertising support for FT and is using the same MDIE
570 * and SSID as the current AP.
572 * The driver is responsible for reporting the FT IEs received from the
573 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
574 * type. update_ft_ies() handler will then be called with the FT IEs to
575 * include in the next frame in the authentication sequence.
580 * ft_ies_len - Length of ft_ies in bytes
585 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
587 * This value is provided to allow the driver interface easier access
588 * to the current mobility domain. This value is set to %NULL if no
589 * mobility domain is currently active.
594 * passphrase - RSN passphrase for PSK
596 * This value is made available only for WPA/WPA2-Personal (PSK) and
597 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
598 * the 8..63 character ASCII passphrase, if available. Please note that
599 * this can be %NULL if passphrase was not used to generate the PSK. In
600 * that case, the psk field must be used to fetch the PSK.
602 const char *passphrase;
605 * psk - RSN PSK (alternative for passphrase for PSK)
607 * This value is made available only for WPA/WPA2-Personal (PSK) and
608 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
609 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
610 * be prepared to handle %NULL value as an error.
615 * drop_unencrypted - Enable/disable unencrypted frame filtering
617 * Configure the driver to drop all non-EAPOL frames (both receive and
618 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
619 * still be allowed for key negotiation.
621 int drop_unencrypted;
624 * prev_bssid - Previously used BSSID in this ESS
626 * When not %NULL, this is a request to use reassociation instead of
629 const u8 *prev_bssid;
634 * If the driver needs to do special configuration for WPS association,
635 * this variable provides more information on what type of association
636 * is being requested. Most drivers should not need ot use this.
641 * p2p - Whether this connection is a P2P group
646 * uapsd - UAPSD parameters for the network
647 * -1 = do not change defaults
648 * AP mode: 1 = enabled, 0 = disabled
649 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
654 * fixed_bssid - Whether to force this BSSID in IBSS mode
655 * 1 = Fix this BSSID and prevent merges.
656 * 0 = Do not fix BSSID.
661 * disable_ht - Disable HT (IEEE 802.11n) for this connection
666 * HT Capabilities over-rides. Only bits set in the mask will be used,
667 * and not all values are used by the kernel anyway. Currently, MCS,
668 * MPDU and MSDU fields are used.
670 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */
671 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */
673 #ifdef CONFIG_VHT_OVERRIDES
675 * disable_vht - Disable VHT for this connection
680 * VHT capability overrides.
682 const struct ieee80211_vht_capabilities *vhtcaps;
683 const struct ieee80211_vht_capabilities *vhtcaps_mask;
684 #endif /* CONFIG_VHT_OVERRIDES */
689 HIDDEN_SSID_ZERO_LEN,
690 HIDDEN_SSID_ZERO_CONTENTS
693 struct wowlan_triggers {
697 u8 gtk_rekey_failure;
699 u8 four_way_handshake;
703 struct wpa_driver_ap_params {
705 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
710 * head_len - Length of the head buffer in octets
715 * tail - Beacon tail following TIM IE
720 * tail_len - Length of the tail buffer in octets
725 * dtim_period - DTIM period
730 * beacon_int - Beacon interval
735 * basic_rates: -1 terminated array of basic rates in 100 kbps
737 * This parameter can be used to set a specific basic rate set for the
738 * BSS. If %NULL, default basic rate set is used.
743 * proberesp - Probe Response template
745 * This is used by drivers that reply to Probe Requests internally in
746 * AP mode and require the full Probe Response template.
751 * proberesp_len - Length of the proberesp buffer in octets
753 size_t proberesp_len;
756 * ssid - The SSID to use in Beacon/Probe Response frames
761 * ssid_len - Length of the SSID (1..32)
766 * hide_ssid - Whether to hide the SSID
768 enum hide_ssid hide_ssid;
771 * pairwise_ciphers - WPA_CIPHER_* bitfield
773 unsigned int pairwise_ciphers;
776 * group_cipher - WPA_CIPHER_*
778 unsigned int group_cipher;
781 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
783 unsigned int key_mgmt_suites;
786 * auth_algs - WPA_AUTH_ALG_* bitfield
788 unsigned int auth_algs;
791 * wpa_version - WPA_PROTO_* bitfield
793 unsigned int wpa_version;
796 * privacy - Whether privacy is used in the BSS
801 * beacon_ies - WPS/P2P IE(s) for Beacon frames
803 * This is used to add IEs like WPS IE and P2P IE by drivers that do
804 * not use the full Beacon template.
806 const struct wpabuf *beacon_ies;
809 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
811 * This is used to add IEs like WPS IE and P2P IE by drivers that
812 * reply to Probe Request frames internally.
814 const struct wpabuf *proberesp_ies;
817 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
819 * This is used to add IEs like WPS IE by drivers that reply to
820 * (Re)Association Request frames internally.
822 const struct wpabuf *assocresp_ies;
825 * isolate - Whether to isolate frames between associated stations
827 * If this is non-zero, the AP is requested to disable forwarding of
828 * frames between associated stations.
833 * cts_protect - Whether CTS protection is enabled
838 * preamble - Whether short preamble is enabled
843 * short_slot_time - Whether short slot time is enabled
845 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
846 * not set (e.g., when 802.11g mode is not in use)
851 * ht_opmode - HT operation mode or -1 if HT not in use
856 * interworking - Whether Interworking is enabled
861 * hessid - Homogeneous ESS identifier or %NULL if not set
866 * access_network_type - Access Network Type (0..15)
868 * This is used for filtering Probe Request frames when Interworking is
871 u8 access_network_type;
874 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
876 * This is used by driver which advertises this capability.
878 int ap_max_inactivity;
881 * disable_dgaf - Whether group-addressed frames are disabled
886 * osen - Whether OSEN security is enabled
891 * freq - Channel parameters for dynamic bandwidth changes
893 struct hostapd_freq_params *freq;
897 * struct wpa_driver_capa - Driver capability information
899 struct wpa_driver_capa {
900 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
901 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
902 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
903 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
904 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
905 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
906 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
907 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
908 unsigned int key_mgmt;
910 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
911 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
912 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
913 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
914 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
915 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
916 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
917 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
918 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
919 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
920 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
921 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
922 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
925 #define WPA_DRIVER_AUTH_OPEN 0x00000001
926 #define WPA_DRIVER_AUTH_SHARED 0x00000002
927 #define WPA_DRIVER_AUTH_LEAP 0x00000004
930 /* Driver generated WPA/RSN IE */
931 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
932 /* Driver needs static WEP key setup after association command */
933 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
934 /* Driver takes care of all DFS operations */
935 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
936 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
937 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
938 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
939 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
940 /* Driver provides separate commands for authentication and association (SME in
941 * wpa_supplicant). */
942 #define WPA_DRIVER_FLAGS_SME 0x00000020
943 /* Driver supports AP mode */
944 #define WPA_DRIVER_FLAGS_AP 0x00000040
945 /* Driver needs static WEP key setup after association has been completed */
946 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
947 /* Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
948 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
949 /* Driver supports concurrent P2P operations */
950 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
952 * Driver uses the initial interface as a dedicated management interface, i.e.,
953 * it cannot be used for P2P group operations or non-P2P purposes.
955 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
956 /* This interface is P2P capable (P2P GO or P2P Client) */
957 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
958 /* Driver supports station and key removal when stopping an AP */
959 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
961 * Driver uses the initial interface for P2P management interface and non-P2P
962 * purposes (e.g., connect to infra AP), but this interface cannot be used for
963 * P2P group operations.
965 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
967 * Driver is known to use sane error codes, i.e., when it indicates that
968 * something (e.g., association) fails, there was indeed a failure and the
969 * operation does not end up getting completed successfully later.
971 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
972 /* Driver supports off-channel TX */
973 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
974 /* Driver indicates TX status events for EAPOL Data frames */
975 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
976 /* Driver indicates TX status events for Deauth/Disassoc frames */
977 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
978 /* Driver supports roaming (BSS selection) in firmware */
979 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
980 /* Driver supports operating as a TDLS peer */
981 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
982 /* Driver requires external TDLS setup/teardown/discovery */
983 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
984 /* Driver indicates support for Probe Response offloading in AP mode */
985 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
986 /* Driver supports U-APSD in AP mode */
987 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
988 /* Driver supports inactivity timer in AP mode */
989 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
990 /* Driver expects user space implementation of MLME in AP mode */
991 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
992 /* Driver supports SAE with user space SME */
993 #define WPA_DRIVER_FLAGS_SAE 0x02000000
994 /* Driver makes use of OBSS scan mechanism in wpa_supplicant */
995 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
996 /* Driver supports IBSS (Ad-hoc) mode */
997 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
998 /* Driver supports radar detection */
999 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1000 /* Driver supports a dedicated interface for P2P Device */
1001 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1002 /* Driver supports QoS Mapping */
1003 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1004 /* Driver supports CSA in AP mode */
1005 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1009 int max_sched_scan_ssids;
1010 int sched_scan_supported;
1014 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1016 unsigned int max_remain_on_chan;
1019 * max_stations - Maximum number of associated stations the driver
1020 * supports in AP mode
1022 unsigned int max_stations;
1025 * probe_resp_offloads - Bitmap of supported protocols by the driver
1026 * for Probe Response offloading.
1028 /* Driver Probe Response offloading support for WPS ver. 1 */
1029 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1030 /* Driver Probe Response offloading support for WPS ver. 2 */
1031 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1032 /* Driver Probe Response offloading support for P2P */
1033 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1034 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1035 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1036 unsigned int probe_resp_offloads;
1038 unsigned int max_acl_mac_addrs;
1041 * Number of supported concurrent channels
1043 unsigned int num_multichan_concurrent;
1046 * extended_capa - extended capabilities in driver/device
1048 * Must be allocated and freed by driver and the pointers must be
1049 * valid for the lifetime of the driver, i.e., freed in deinit()
1051 const u8 *extended_capa, *extended_capa_mask;
1052 unsigned int extended_capa_len;
1054 struct wowlan_triggers wowlan_triggers;
1058 struct hostapd_data;
1060 struct hostap_sta_driver_data {
1061 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1062 unsigned long current_tx_rate;
1063 unsigned long inactive_msec;
1064 unsigned long flags;
1065 unsigned long num_ps_buf_frames;
1066 unsigned long tx_retry_failed;
1067 unsigned long tx_retry_count;
1072 struct hostapd_sta_add_params {
1076 const u8 *supp_rates;
1077 size_t supp_rates_len;
1078 u16 listen_interval;
1079 const struct ieee80211_ht_capabilities *ht_capabilities;
1080 const struct ieee80211_vht_capabilities *vht_capabilities;
1081 int vht_opmode_enabled;
1083 u32 flags; /* bitmask of WPA_STA_* flags */
1084 int set; /* Set STA parameters instead of add */
1086 const u8 *ext_capab;
1087 size_t ext_capab_len;
1088 const u8 *supp_channels;
1089 size_t supp_channels_len;
1090 const u8 *supp_oper_classes;
1091 size_t supp_oper_classes_len;
1094 struct hostapd_freq_params {
1100 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
1101 * secondary channel below primary, 1 = HT40
1102 * enabled, secondary channel above primary */
1107 /* valid for both HT and VHT, center_freq2 is non-zero
1108 * only for bandwidth 80 and an 80+80 channel */
1109 int center_freq1, center_freq2;
1113 struct mac_address {
1117 struct hostapd_acl_params {
1119 unsigned int num_mac_acl;
1120 struct mac_address mac_acl[0];
1123 enum wpa_driver_if_type {
1125 * WPA_IF_STATION - Station mode interface
1130 * WPA_IF_AP_VLAN - AP mode VLAN interface
1132 * This interface shares its address and Beacon frame with the main
1138 * WPA_IF_AP_BSS - AP mode BSS interface
1140 * This interface has its own address and Beacon frame.
1145 * WPA_IF_P2P_GO - P2P Group Owner
1150 * WPA_IF_P2P_CLIENT - P2P Client
1155 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1156 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1161 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1162 * abstracted P2P Device function in the driver
1167 struct wpa_init_params {
1173 const char *test_socket;
1174 int use_pae_group_addr;
1178 u8 *own_addr; /* buffer for writing own MAC address */
1182 struct wpa_bss_params {
1183 /** Interface name (for multi-SSID/VLAN support) */
1185 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1194 enum mfp_options ieee80211w;
1197 #define WPA_STA_AUTHORIZED BIT(0)
1198 #define WPA_STA_WMM BIT(1)
1199 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1200 #define WPA_STA_MFP BIT(3)
1201 #define WPA_STA_TDLS_PEER BIT(4)
1214 WNM_SLEEP_ENTER_CONFIRM,
1215 WNM_SLEEP_ENTER_FAIL,
1216 WNM_SLEEP_EXIT_CONFIRM,
1217 WNM_SLEEP_EXIT_FAIL,
1218 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1219 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1220 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1222 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1224 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1225 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1227 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1230 /* enum chan_width - Channel width definitions */
1242 * struct wpa_signal_info - Information about channel signal quality
1244 struct wpa_signal_info {
1246 int above_threshold;
1251 enum chan_width chanwidth;
1257 * struct beacon_data - Beacon data
1258 * @head: Head portion of Beacon frame (before TIM IE)
1259 * @tail: Tail portion of Beacon frame (after TIM IE)
1260 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1261 * @proberesp_ies: Extra information element(s) to add into Probe Response
1263 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1264 * Response frames or %NULL
1265 * @probe_resp: Probe Response frame template
1266 * @head_len: Length of @head
1267 * @tail_len: Length of @tail
1268 * @beacon_ies_len: Length of beacon_ies in octets
1269 * @proberesp_ies_len: Length of proberesp_ies in octets
1270 * @proberesp_ies_len: Length of proberesp_ies in octets
1271 * @probe_resp_len: Length of probe response template (@probe_resp)
1273 struct beacon_data {
1280 size_t head_len, tail_len;
1281 size_t beacon_ies_len;
1282 size_t proberesp_ies_len;
1283 size_t assocresp_ies_len;
1284 size_t probe_resp_len;
1288 * struct csa_settings - Settings for channel switch command
1289 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1290 * @block_tx: 1 - block transmission for CSA period
1291 * @freq_params: Next channel frequency parameter
1292 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1293 * @beacon_after: Next beacon/probe resp/asooc resp info
1294 * @counter_offset_beacon: Offset to the count field in beacon's tail
1295 * @counter_offset_presp: Offset to the count field in probe resp.
1297 struct csa_settings {
1301 struct hostapd_freq_params freq_params;
1302 struct beacon_data beacon_csa;
1303 struct beacon_data beacon_after;
1305 u16 counter_offset_beacon;
1306 u16 counter_offset_presp;
1309 /* TDLS peer capabilities for send_tdls_mgmt() */
1310 enum tdls_peer_capability {
1311 TDLS_PEER_HT = BIT(0),
1312 TDLS_PEER_VHT = BIT(1),
1313 TDLS_PEER_WMM = BIT(2),
1316 #ifdef CONFIG_MACSEC
1317 struct macsec_init_params {
1318 Boolean always_include_sci;
1322 #endif /* CONFIG_MACSEC */
1326 * struct wpa_driver_ops - Driver interface API definition
1328 * This structure defines the API that each driver interface needs to implement
1329 * for core wpa_supplicant code. All driver specific functionality is captured
1332 struct wpa_driver_ops {
1333 /** Name of the driver interface */
1335 /** One line description of the driver interface */
1339 * get_bssid - Get the current BSSID
1340 * @priv: private driver interface data
1341 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1343 * Returns: 0 on success, -1 on failure
1345 * Query kernel driver for the current BSSID and copy it to bssid.
1346 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1349 int (*get_bssid)(void *priv, u8 *bssid);
1352 * get_ssid - Get the current SSID
1353 * @priv: private driver interface data
1354 * @ssid: buffer for SSID (at least 32 bytes)
1356 * Returns: Length of the SSID on success, -1 on failure
1358 * Query kernel driver for the current SSID and copy it to ssid.
1359 * Returning zero is recommended if the STA is not associated.
1361 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1362 * can, at least in theory, contain control characters (including nul)
1363 * and as such, should be processed as binary data, not a printable
1366 int (*get_ssid)(void *priv, u8 *ssid);
1369 * set_key - Configure encryption key
1370 * @ifname: Interface name (for multi-SSID/VLAN support)
1371 * @priv: private driver interface data
1372 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1373 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1374 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1375 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1376 * %WPA_ALG_BIP_CMAC_256);
1377 * %WPA_ALG_NONE clears the key.
1378 * @addr: Address of the peer STA (BSSID of the current AP when setting
1379 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1380 * broadcast keys, %NULL for default keys that are used both for
1381 * broadcast and unicast; when clearing keys, %NULL is used to
1382 * indicate that both the broadcast-only and default key of the
1383 * specified key index is to be cleared
1384 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1386 * @set_tx: configure this key as the default Tx key (only used when
1387 * driver does not support separate unicast/individual key
1388 * @seq: sequence number/packet number, seq_len octets, the next
1389 * packet number to be used for in replay protection; configured
1390 * for Rx keys (in most cases, this is only used with broadcast
1391 * keys and set to zero for unicast keys); %NULL if not set
1392 * @seq_len: length of the seq, depends on the algorithm:
1393 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1394 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1396 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1397 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1399 * Returns: 0 on success, -1 on failure
1401 * Configure the given key for the kernel driver. If the driver
1402 * supports separate individual keys (4 default keys + 1 individual),
1403 * addr can be used to determine whether the key is default or
1404 * individual. If only 4 keys are supported, the default key with key
1405 * index 0 is used as the individual key. STA must be configured to use
1406 * it as the default Tx key (set_tx is set) and accept Rx for all the
1407 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1408 * broadcast keys, so key index 0 is available for this kind of
1411 * Please note that TKIP keys include separate TX and RX MIC keys and
1412 * some drivers may expect them in different order than wpa_supplicant
1413 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1414 * will trigger Michael MIC errors. This can be fixed by changing the
1415 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1416 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1417 * example on how this can be done.
1419 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1420 const u8 *addr, int key_idx, int set_tx,
1421 const u8 *seq, size_t seq_len,
1422 const u8 *key, size_t key_len);
1425 * init - Initialize driver interface
1426 * @ctx: context to be used when calling wpa_supplicant functions,
1427 * e.g., wpa_supplicant_event()
1428 * @ifname: interface name, e.g., wlan0
1430 * Returns: Pointer to private data, %NULL on failure
1432 * Initialize driver interface, including event processing for kernel
1433 * driver events (e.g., associated, scan results, Michael MIC failure).
1434 * This function can allocate a private configuration data area for
1435 * @ctx, file descriptor, interface name, etc. information that may be
1436 * needed in future driver operations. If this is not used, non-NULL
1437 * value will need to be returned because %NULL is used to indicate
1438 * failure. The returned value will be used as 'void *priv' data for
1439 * all other driver_ops functions.
1441 * The main event loop (eloop.c) of wpa_supplicant can be used to
1442 * register callback for read sockets (eloop_register_read_sock()).
1444 * See below for more information about events and
1445 * wpa_supplicant_event() function.
1447 void * (*init)(void *ctx, const char *ifname);
1450 * deinit - Deinitialize driver interface
1451 * @priv: private driver interface data from init()
1453 * Shut down driver interface and processing of driver events. Free
1454 * private data buffer if one was allocated in init() handler.
1456 void (*deinit)(void *priv);
1459 * set_param - Set driver configuration parameters
1460 * @priv: private driver interface data from init()
1461 * @param: driver specific configuration parameters
1463 * Returns: 0 on success, -1 on failure
1465 * Optional handler for notifying driver interface about configuration
1466 * parameters (driver_param).
1468 int (*set_param)(void *priv, const char *param);
1471 * set_countermeasures - Enable/disable TKIP countermeasures
1472 * @priv: private driver interface data
1473 * @enabled: 1 = countermeasures enabled, 0 = disabled
1475 * Returns: 0 on success, -1 on failure
1477 * Configure TKIP countermeasures. When these are enabled, the driver
1478 * should drop all received and queued frames that are using TKIP.
1480 int (*set_countermeasures)(void *priv, int enabled);
1483 * deauthenticate - Request driver to deauthenticate
1484 * @priv: private driver interface data
1485 * @addr: peer address (BSSID of the AP)
1486 * @reason_code: 16-bit reason code to be sent in the deauthentication
1489 * Returns: 0 on success, -1 on failure
1491 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1494 * associate - Request driver to associate
1495 * @priv: private driver interface data
1496 * @params: association parameters
1498 * Returns: 0 on success, -1 on failure
1500 int (*associate)(void *priv,
1501 struct wpa_driver_associate_params *params);
1504 * add_pmkid - Add PMKSA cache entry to the driver
1505 * @priv: private driver interface data
1506 * @bssid: BSSID for the PMKSA cache entry
1507 * @pmkid: PMKID for the PMKSA cache entry
1509 * Returns: 0 on success, -1 on failure
1511 * This function is called when a new PMK is received, as a result of
1512 * either normal authentication or RSN pre-authentication.
1514 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1515 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1516 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1517 * driver_ops function does not need to be implemented. Likewise, if
1518 * the driver does not support WPA, this function is not needed.
1520 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1523 * remove_pmkid - Remove PMKSA cache entry to the driver
1524 * @priv: private driver interface data
1525 * @bssid: BSSID for the PMKSA cache entry
1526 * @pmkid: PMKID for the PMKSA cache entry
1528 * Returns: 0 on success, -1 on failure
1530 * This function is called when the supplicant drops a PMKSA cache
1531 * entry for any reason.
1533 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1534 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1535 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1536 * from wpa_supplicant, this driver_ops function does not need to be
1537 * implemented. Likewise, if the driver does not support WPA, this
1538 * function is not needed.
1540 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1543 * flush_pmkid - Flush PMKSA cache
1544 * @priv: private driver interface data
1546 * Returns: 0 on success, -1 on failure
1548 * This function is called when the supplicant drops all PMKSA cache
1549 * entries for any reason.
1551 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1552 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1553 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1554 * from wpa_supplicant, this driver_ops function does not need to be
1555 * implemented. Likewise, if the driver does not support WPA, this
1556 * function is not needed.
1558 int (*flush_pmkid)(void *priv);
1561 * get_capa - Get driver capabilities
1562 * @priv: private driver interface data
1564 * Returns: 0 on success, -1 on failure
1566 * Get driver/firmware/hardware capabilities.
1568 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1571 * poll - Poll driver for association information
1572 * @priv: private driver interface data
1574 * This is an option callback that can be used when the driver does not
1575 * provide event mechanism for association events. This is called when
1576 * receiving WPA EAPOL-Key messages that require association
1577 * information. The driver interface is supposed to generate associnfo
1578 * event before returning from this callback function. In addition, the
1579 * driver interface should generate an association event after having
1580 * sent out associnfo.
1582 void (*poll)(void *priv);
1585 * get_ifname - Get interface name
1586 * @priv: private driver interface data
1588 * Returns: Pointer to the interface name. This can differ from the
1589 * interface name used in init() call. Init() is called first.
1591 * This optional function can be used to allow the driver interface to
1592 * replace the interface name with something else, e.g., based on an
1593 * interface mapping from a more descriptive name.
1595 const char * (*get_ifname)(void *priv);
1598 * get_mac_addr - Get own MAC address
1599 * @priv: private driver interface data
1601 * Returns: Pointer to own MAC address or %NULL on failure
1603 * This optional function can be used to get the own MAC address of the
1604 * device from the driver interface code. This is only needed if the
1605 * l2_packet implementation for the OS does not provide easy access to
1607 const u8 * (*get_mac_addr)(void *priv);
1610 * send_eapol - Optional function for sending EAPOL packets
1611 * @priv: private driver interface data
1612 * @dest: Destination MAC address
1614 * @data: EAPOL packet starting with IEEE 802.1X header
1615 * @data_len: Size of the EAPOL packet
1617 * Returns: 0 on success, -1 on failure
1619 * This optional function can be used to override l2_packet operations
1620 * with driver specific functionality. If this function pointer is set,
1621 * l2_packet module is not used at all and the driver interface code is
1622 * responsible for receiving and sending all EAPOL packets. The
1623 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1624 * event. The driver interface is required to implement get_mac_addr()
1625 * handler if send_eapol() is used.
1627 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1628 const u8 *data, size_t data_len);
1631 * set_operstate - Sets device operating state to DORMANT or UP
1632 * @priv: private driver interface data
1633 * @state: 0 = dormant, 1 = up
1634 * Returns: 0 on success, -1 on failure
1636 * This is an optional function that can be used on operating systems
1637 * that support a concept of controlling network device state from user
1638 * space applications. This function, if set, gets called with
1639 * state = 1 when authentication has been completed and with state = 0
1640 * when connection is lost.
1642 int (*set_operstate)(void *priv, int state);
1645 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1646 * @priv: Private driver interface data
1647 * @addr: Address of the station for which to set protection (may be
1648 * %NULL for group keys)
1649 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1650 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1651 * Returns: 0 on success, -1 on failure
1653 * This is an optional function that can be used to set the driver to
1654 * require protection for Tx and/or Rx frames. This uses the layer
1655 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1656 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1657 * set protection operation; instead, they set protection implicitly
1658 * based on configured keys.
1660 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1664 * get_hw_feature_data - Get hardware support data (channels and rates)
1665 * @priv: Private driver interface data
1666 * @num_modes: Variable for returning the number of returned modes
1667 * flags: Variable for returning hardware feature flags
1668 * Returns: Pointer to allocated hardware data on success or %NULL on
1669 * failure. Caller is responsible for freeing this.
1671 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1676 * send_mlme - Send management frame from MLME
1677 * @priv: Private driver interface data
1678 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1679 * @data_len: Size of the management frame
1680 * @noack: Do not wait for this frame to be acked (disable retries)
1681 * Returns: 0 on success, -1 on failure
1683 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1687 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1688 * @priv: Private driver interface data
1689 * @md: Mobility domain (2 octets) (also included inside ies)
1690 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1691 * @ies_len: Length of FT IEs in bytes
1692 * Returns: 0 on success, -1 on failure
1694 * The supplicant uses this callback to let the driver know that keying
1695 * material for FT is available and that the driver can use the
1696 * provided IEs in the next message in FT authentication sequence.
1698 * This function is only needed for driver that support IEEE 802.11r
1699 * (Fast BSS Transition).
1701 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1705 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1706 * @priv: Private driver interface data
1707 * @action: Action field value
1708 * @target_ap: Target AP address
1709 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1710 * @ies_len: Length of FT IEs in bytes
1711 * Returns: 0 on success, -1 on failure
1713 * The supplicant uses this callback to request the driver to transmit
1714 * an FT Action frame (action category 6) for over-the-DS fast BSS
1717 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1718 const u8 *ies, size_t ies_len);
1721 * get_scan_results2 - Fetch the latest scan results
1722 * @priv: private driver interface data
1724 * Returns: Allocated buffer of scan results (caller is responsible for
1725 * freeing the data structure) on success, NULL on failure
1727 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1730 * set_country - Set country
1731 * @priv: Private driver interface data
1732 * @alpha2: country to which to switch to
1733 * Returns: 0 on success, -1 on failure
1735 * This function is for drivers which support some form
1736 * of setting a regulatory domain.
1738 int (*set_country)(void *priv, const char *alpha2);
1741 * get_country - Get country
1742 * @priv: Private driver interface data
1743 * @alpha2: Buffer for returning country code (at least 3 octets)
1744 * Returns: 0 on success, -1 on failure
1746 int (*get_country)(void *priv, char *alpha2);
1749 * global_init - Global driver initialization
1750 * Returns: Pointer to private data (global), %NULL on failure
1752 * This optional function is called to initialize the driver wrapper
1753 * for global data, i.e., data that applies to all interfaces. If this
1754 * function is implemented, global_deinit() will also need to be
1755 * implemented to free the private data. The driver will also likely
1756 * use init2() function instead of init() to get the pointer to global
1757 * data available to per-interface initializer.
1759 void * (*global_init)(void);
1762 * global_deinit - Global driver deinitialization
1763 * @priv: private driver global data from global_init()
1765 * Terminate any global driver related functionality and free the
1766 * global data structure.
1768 void (*global_deinit)(void *priv);
1771 * init2 - Initialize driver interface (with global data)
1772 * @ctx: context to be used when calling wpa_supplicant functions,
1773 * e.g., wpa_supplicant_event()
1774 * @ifname: interface name, e.g., wlan0
1775 * @global_priv: private driver global data from global_init()
1776 * Returns: Pointer to private data, %NULL on failure
1778 * This function can be used instead of init() if the driver wrapper
1781 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1784 * get_interfaces - Get information about available interfaces
1785 * @global_priv: private driver global data from global_init()
1786 * Returns: Allocated buffer of interface information (caller is
1787 * responsible for freeing the data structure) on success, NULL on
1790 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1793 * scan2 - Request the driver to initiate scan
1794 * @priv: private driver interface data
1795 * @params: Scan parameters
1797 * Returns: 0 on success, -1 on failure
1799 * Once the scan results are ready, the driver should report scan
1800 * results event for wpa_supplicant which will eventually request the
1801 * results with wpa_driver_get_scan_results2().
1803 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1806 * authenticate - Request driver to authenticate
1807 * @priv: private driver interface data
1808 * @params: authentication parameters
1809 * Returns: 0 on success, -1 on failure
1811 * This is an optional function that can be used with drivers that
1812 * support separate authentication and association steps, i.e., when
1813 * wpa_supplicant can act as the SME. If not implemented, associate()
1814 * function is expected to take care of IEEE 802.11 authentication,
1817 int (*authenticate)(void *priv,
1818 struct wpa_driver_auth_params *params);
1821 * set_ap - Set Beacon and Probe Response information for AP mode
1822 * @priv: Private driver interface data
1823 * @params: Parameters to use in AP mode
1825 * This function is used to configure Beacon template and/or extra IEs
1826 * to add for Beacon and Probe Response frames for the driver in
1827 * AP mode. The driver is responsible for building the full Beacon
1828 * frame by concatenating the head part with TIM IE generated by the
1829 * driver/firmware and finishing with the tail part. Depending on the
1830 * driver architectue, this can be done either by using the full
1831 * template or the set of additional IEs (e.g., WPS and P2P IE).
1832 * Similarly, Probe Response processing depends on the driver design.
1833 * If the driver (or firmware) takes care of replying to Probe Request
1834 * frames, the extra IEs provided here needs to be added to the Probe
1837 * Returns: 0 on success, -1 on failure
1839 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1842 * set_acl - Set ACL in AP mode
1843 * @priv: Private driver interface data
1844 * @params: Parameters to configure ACL
1845 * Returns: 0 on success, -1 on failure
1847 * This is used only for the drivers which support MAC address ACL.
1849 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1852 * hapd_init - Initialize driver interface (hostapd only)
1853 * @hapd: Pointer to hostapd context
1854 * @params: Configuration for the driver wrapper
1855 * Returns: Pointer to private data, %NULL on failure
1857 * This function is used instead of init() or init2() when the driver
1858 * wrapper is used with hostapd.
1860 void * (*hapd_init)(struct hostapd_data *hapd,
1861 struct wpa_init_params *params);
1864 * hapd_deinit - Deinitialize driver interface (hostapd only)
1865 * @priv: Private driver interface data from hapd_init()
1867 void (*hapd_deinit)(void *priv);
1870 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1871 * @priv: Private driver interface data
1872 * @params: BSS parameters
1873 * Returns: 0 on success, -1 on failure
1875 * This is an optional function to configure the kernel driver to
1876 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1877 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1878 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1879 * for Beacon frames.
1881 * DEPRECATED - use set_ap() instead
1883 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1886 * set_privacy - Enable/disable privacy (AP only)
1887 * @priv: Private driver interface data
1888 * @enabled: 1 = privacy enabled, 0 = disabled
1889 * Returns: 0 on success, -1 on failure
1891 * This is an optional function to configure privacy field in the
1892 * kernel driver for Beacon frames. This can be left undefined (set to
1893 * %NULL) if the driver uses the Beacon template from set_ap().
1895 * DEPRECATED - use set_ap() instead
1897 int (*set_privacy)(void *priv, int enabled);
1900 * get_seqnum - Fetch the current TSC/packet number (AP only)
1901 * @ifname: The interface name (main or virtual)
1902 * @priv: Private driver interface data
1903 * @addr: MAC address of the station or %NULL for group keys
1905 * @seq: Buffer for returning the latest used TSC/packet number
1906 * Returns: 0 on success, -1 on failure
1908 * This function is used to fetch the last used TSC/packet number for
1909 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1910 * keys, so there is no strict requirement on implementing support for
1911 * unicast keys (i.e., addr != %NULL).
1913 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1917 * flush - Flush all association stations (AP only)
1918 * @priv: Private driver interface data
1919 * Returns: 0 on success, -1 on failure
1921 * This function requests the driver to disassociate all associated
1922 * stations. This function does not need to be implemented if the
1923 * driver does not process association frames internally.
1925 int (*flush)(void *priv);
1928 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1929 * @priv: Private driver interface data
1930 * @elem: Information elements
1931 * @elem_len: Length of the elem buffer in octets
1932 * Returns: 0 on success, -1 on failure
1934 * This is an optional function to add information elements in the
1935 * kernel driver for Beacon and Probe Response frames. This can be left
1936 * undefined (set to %NULL) if the driver uses the Beacon template from
1939 * DEPRECATED - use set_ap() instead
1941 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1944 * read_sta_data - Fetch station data
1945 * @priv: Private driver interface data
1946 * @data: Buffer for returning station information
1947 * @addr: MAC address of the station
1948 * Returns: 0 on success, -1 on failure
1950 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1954 * hapd_send_eapol - Send an EAPOL packet (AP only)
1955 * @priv: private driver interface data
1956 * @addr: Destination MAC address
1957 * @data: EAPOL packet starting with IEEE 802.1X header
1958 * @data_len: Length of the EAPOL packet in octets
1959 * @encrypt: Whether the frame should be encrypted
1960 * @own_addr: Source MAC address
1961 * @flags: WPA_STA_* flags for the destination station
1963 * Returns: 0 on success, -1 on failure
1965 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1966 size_t data_len, int encrypt,
1967 const u8 *own_addr, u32 flags);
1970 * sta_deauth - Deauthenticate a station (AP only)
1971 * @priv: Private driver interface data
1972 * @own_addr: Source address and BSSID for the Deauthentication frame
1973 * @addr: MAC address of the station to deauthenticate
1974 * @reason: Reason code for the Deauthentiation frame
1975 * Returns: 0 on success, -1 on failure
1977 * This function requests a specific station to be deauthenticated and
1978 * a Deauthentication frame to be sent to it.
1980 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1984 * sta_disassoc - Disassociate a station (AP only)
1985 * @priv: Private driver interface data
1986 * @own_addr: Source address and BSSID for the Disassociation frame
1987 * @addr: MAC address of the station to disassociate
1988 * @reason: Reason code for the Disassociation frame
1989 * Returns: 0 on success, -1 on failure
1991 * This function requests a specific station to be disassociated and
1992 * a Disassociation frame to be sent to it.
1994 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1998 * sta_remove - Remove a station entry (AP only)
1999 * @priv: Private driver interface data
2000 * @addr: MAC address of the station to be removed
2001 * Returns: 0 on success, -1 on failure
2003 int (*sta_remove)(void *priv, const u8 *addr);
2006 * hapd_get_ssid - Get the current SSID (AP only)
2007 * @priv: Private driver interface data
2008 * @buf: Buffer for returning the SSID
2009 * @len: Maximum length of the buffer
2010 * Returns: Length of the SSID on success, -1 on failure
2012 * This function need not be implemented if the driver uses Beacon
2013 * template from set_ap() and does not reply to Probe Request frames.
2015 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2018 * hapd_set_ssid - Set SSID (AP only)
2019 * @priv: Private driver interface data
2021 * @len: Length of the SSID in octets
2022 * Returns: 0 on success, -1 on failure
2024 * DEPRECATED - use set_ap() instead
2026 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2029 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2030 * @priv: Private driver interface data
2031 * @enabled: 1 = countermeasures enabled, 0 = disabled
2032 * Returns: 0 on success, -1 on failure
2034 * This need not be implemented if the driver does not take care of
2035 * association processing.
2037 int (*hapd_set_countermeasures)(void *priv, int enabled);
2040 * sta_add - Add a station entry
2041 * @priv: Private driver interface data
2042 * @params: Station parameters
2043 * Returns: 0 on success, -1 on failure
2045 * This function is used to add a station entry to the driver once the
2046 * station has completed association. This is only used if the driver
2047 * does not take care of association processing.
2049 * With TDLS, this function is also used to add or set (params->set 1)
2050 * TDLS peer entries.
2052 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2055 * get_inact_sec - Get station inactivity duration (AP only)
2056 * @priv: Private driver interface data
2057 * @addr: Station address
2058 * Returns: Number of seconds station has been inactive, -1 on failure
2060 int (*get_inact_sec)(void *priv, const u8 *addr);
2063 * sta_clear_stats - Clear station statistics (AP only)
2064 * @priv: Private driver interface data
2065 * @addr: Station address
2066 * Returns: 0 on success, -1 on failure
2068 int (*sta_clear_stats)(void *priv, const u8 *addr);
2071 * set_freq - Set channel/frequency (AP only)
2072 * @priv: Private driver interface data
2073 * @freq: Channel parameters
2074 * Returns: 0 on success, -1 on failure
2076 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2079 * set_rts - Set RTS threshold
2080 * @priv: Private driver interface data
2081 * @rts: RTS threshold in octets
2082 * Returns: 0 on success, -1 on failure
2084 int (*set_rts)(void *priv, int rts);
2087 * set_frag - Set fragmentation threshold
2088 * @priv: Private driver interface data
2089 * @frag: Fragmentation threshold in octets
2090 * Returns: 0 on success, -1 on failure
2092 int (*set_frag)(void *priv, int frag);
2095 * sta_set_flags - Set station flags (AP only)
2096 * @priv: Private driver interface data
2097 * @addr: Station address
2098 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2099 * @flags_or: Bitmap of WPA_STA_* flags to add
2100 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2101 * Returns: 0 on success, -1 on failure
2103 int (*sta_set_flags)(void *priv, const u8 *addr,
2104 int total_flags, int flags_or, int flags_and);
2107 * set_tx_queue_params - Set TX queue parameters
2108 * @priv: Private driver interface data
2109 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2113 * @burst_time: Maximum length for bursting in 0.1 msec units
2115 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2116 int cw_max, int burst_time);
2119 * if_add - Add a virtual interface
2120 * @priv: Private driver interface data
2121 * @type: Interface type
2122 * @ifname: Interface name for the new virtual interface
2123 * @addr: Local address to use for the interface or %NULL to use the
2124 * parent interface address
2125 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2126 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2127 * not allowed (applies only to %WPA_IF_AP_BSS type)
2128 * @force_ifname: Buffer for returning an interface name that the
2129 * driver ended up using if it differs from the requested ifname
2130 * @if_addr: Buffer for returning the allocated interface address
2131 * (this may differ from the requested addr if the driver cannot
2132 * change interface address)
2133 * @bridge: Bridge interface to use or %NULL if no bridge configured
2134 * @use_existing: Whether to allow existing interface to be used
2135 * Returns: 0 on success, -1 on failure
2137 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2138 const char *ifname, const u8 *addr, void *bss_ctx,
2139 void **drv_priv, char *force_ifname, u8 *if_addr,
2140 const char *bridge, int use_existing);
2143 * if_remove - Remove a virtual interface
2144 * @priv: Private driver interface data
2145 * @type: Interface type
2146 * @ifname: Interface name of the virtual interface to be removed
2147 * Returns: 0 on success, -1 on failure
2149 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2150 const char *ifname);
2153 * set_sta_vlan - Bind a station into a specific interface (AP only)
2154 * @priv: Private driver interface data
2155 * @ifname: Interface (main or virtual BSS or VLAN)
2156 * @addr: MAC address of the associated station
2158 * Returns: 0 on success, -1 on failure
2160 * This function is used to bind a station to a specific virtual
2161 * interface. It is only used if when virtual interfaces are supported,
2162 * e.g., to assign stations to different VLAN interfaces based on
2163 * information from a RADIUS server. This allows separate broadcast
2164 * domains to be used with a single BSS.
2166 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2170 * commit - Optional commit changes handler (AP only)
2171 * @priv: driver private data
2172 * Returns: 0 on success, -1 on failure
2174 * This optional handler function can be registered if the driver
2175 * interface implementation needs to commit changes (e.g., by setting
2176 * network interface up) at the end of initial configuration. If set,
2177 * this handler will be called after initial setup has been completed.
2179 int (*commit)(void *priv);
2182 * send_ether - Send an ethernet packet (AP only)
2183 * @priv: private driver interface data
2184 * @dst: Destination MAC address
2185 * @src: Source MAC address
2187 * @data: EAPOL packet starting with IEEE 802.1X header
2188 * @data_len: Length of the EAPOL packet in octets
2189 * Returns: 0 on success, -1 on failure
2191 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2192 const u8 *data, size_t data_len);
2195 * set_radius_acl_auth - Notification of RADIUS ACL change
2196 * @priv: Private driver interface data
2197 * @mac: MAC address of the station
2198 * @accepted: Whether the station was accepted
2199 * @session_timeout: Session timeout for the station
2200 * Returns: 0 on success, -1 on failure
2202 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2203 u32 session_timeout);
2206 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2207 * @priv: Private driver interface data
2208 * @mac: MAC address of the station
2209 * Returns: 0 on success, -1 on failure
2211 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2214 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2215 * @priv: Private driver interface data
2216 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2217 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2219 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2220 * to remove extra IE(s)
2221 * Returns: 0 on success, -1 on failure
2223 * This is an optional function to add WPS IE in the kernel driver for
2224 * Beacon and Probe Response frames. This can be left undefined (set
2225 * to %NULL) if the driver uses the Beacon template from set_ap()
2226 * and does not process Probe Request frames. If the driver takes care
2227 * of (Re)Association frame processing, the assocresp buffer includes
2228 * WPS IE(s) that need to be added to (Re)Association Response frames
2229 * whenever a (Re)Association Request frame indicated use of WPS.
2231 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2232 * frames when operating as a GO. The driver is responsible for adding
2233 * timing related attributes (e.g., NoA) in addition to the IEs
2234 * included here by appending them after these buffers. This call is
2235 * also used to provide Probe Response IEs for P2P Listen state
2236 * operations for drivers that generate the Probe Response frames
2239 * DEPRECATED - use set_ap() instead
2241 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2242 const struct wpabuf *proberesp,
2243 const struct wpabuf *assocresp);
2246 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2247 * @priv: Private driver interface data
2248 * @authorized: Whether the port is authorized
2249 * Returns: 0 on success, -1 on failure
2251 int (*set_supp_port)(void *priv, int authorized);
2254 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2255 * @priv: Private driver interface data
2256 * @addr: MAC address of the associated station
2257 * @aid: Association ID
2258 * @val: 1 = bind to 4-address WDS; 0 = unbind
2259 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2260 * to indicate that bridge is not to be used
2261 * @ifname_wds: Buffer to return the interface name for the new WDS
2262 * station or %NULL to indicate name is not returned.
2263 * Returns: 0 on success, -1 on failure
2265 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2266 const char *bridge_ifname, char *ifname_wds);
2269 * send_action - Transmit an Action frame
2270 * @priv: Private driver interface data
2271 * @freq: Frequency (in MHz) of the channel
2272 * @wait: Time to wait off-channel for a response (in ms), or zero
2273 * @dst: Destination MAC address (Address 1)
2274 * @src: Source MAC address (Address 2)
2275 * @bssid: BSSID (Address 3)
2277 * @data_len: data length in octets
2278 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2279 * Returns: 0 on success, -1 on failure
2281 * This command can be used to request the driver to transmit an action
2282 * frame to the specified destination.
2284 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2285 * be transmitted on the given channel and the device will wait for a
2286 * response on that channel for the given wait time.
2288 * If the flag is not set, the wait time will be ignored. In this case,
2289 * if a remain-on-channel duration is in progress, the frame must be
2290 * transmitted on that channel; alternatively the frame may be sent on
2291 * the current operational channel (if in associated state in station
2292 * mode or while operating as an AP.)
2294 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2295 const u8 *dst, const u8 *src, const u8 *bssid,
2296 const u8 *data, size_t data_len, int no_cck);
2299 * send_action_cancel_wait - Cancel action frame TX wait
2300 * @priv: Private driver interface data
2302 * This command cancels the wait time associated with sending an action
2303 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2304 * set in the driver flags.
2306 void (*send_action_cancel_wait)(void *priv);
2309 * remain_on_channel - Remain awake on a channel
2310 * @priv: Private driver interface data
2311 * @freq: Frequency (in MHz) of the channel
2312 * @duration: Duration in milliseconds
2313 * Returns: 0 on success, -1 on failure
2315 * This command is used to request the driver to remain awake on the
2316 * specified channel for the specified duration and report received
2317 * Action frames with EVENT_RX_MGMT events. Optionally, received
2318 * Probe Request frames may also be requested to be reported by calling
2319 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2321 * The driver may not be at the requested channel when this function
2322 * returns, i.e., the return code is only indicating whether the
2323 * request was accepted. The caller will need to wait until the
2324 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2325 * completed the channel change. This may take some time due to other
2326 * need for the radio and the caller should be prepared to timing out
2327 * its wait since there are no guarantees on when this request can be
2330 int (*remain_on_channel)(void *priv, unsigned int freq,
2331 unsigned int duration);
2334 * cancel_remain_on_channel - Cancel remain-on-channel operation
2335 * @priv: Private driver interface data
2337 * This command can be used to cancel a remain-on-channel operation
2338 * before its originally requested duration has passed. This could be
2339 * used, e.g., when remain_on_channel() is used to request extra time
2340 * to receive a response to an Action frame and the response is
2341 * received when there is still unneeded time remaining on the
2342 * remain-on-channel operation.
2344 int (*cancel_remain_on_channel)(void *priv);
2347 * probe_req_report - Request Probe Request frames to be indicated
2348 * @priv: Private driver interface data
2349 * @report: Whether to report received Probe Request frames
2350 * Returns: 0 on success, -1 on failure (or if not supported)
2352 * This command can be used to request the driver to indicate when
2353 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2354 * Since this operation may require extra resources, e.g., due to less
2355 * optimal hardware/firmware RX filtering, many drivers may disable
2356 * Probe Request reporting at least in station mode. This command is
2357 * used to notify the driver when the Probe Request frames need to be
2358 * reported, e.g., during remain-on-channel operations.
2360 int (*probe_req_report)(void *priv, int report);
2363 * deinit_ap - Deinitialize AP mode
2364 * @priv: Private driver interface data
2365 * Returns: 0 on success, -1 on failure (or if not supported)
2367 * This optional function can be used to disable AP mode related
2368 * configuration. If the interface was not dynamically added,
2369 * change the driver mode to station mode to allow normal station
2370 * operations like scanning to be completed.
2372 int (*deinit_ap)(void *priv);
2375 * deinit_p2p_cli - Deinitialize P2P client mode
2376 * @priv: Private driver interface data
2377 * Returns: 0 on success, -1 on failure (or if not supported)
2379 * This optional function can be used to disable P2P client mode. If the
2380 * interface was not dynamically added, change the interface type back
2383 int (*deinit_p2p_cli)(void *priv);
2386 * suspend - Notification on system suspend/hibernate event
2387 * @priv: Private driver interface data
2389 void (*suspend)(void *priv);
2392 * resume - Notification on system resume/thaw event
2393 * @priv: Private driver interface data
2395 void (*resume)(void *priv);
2398 * signal_monitor - Set signal monitoring parameters
2399 * @priv: Private driver interface data
2400 * @threshold: Threshold value for signal change events; 0 = disabled
2401 * @hysteresis: Minimum change in signal strength before indicating a
2403 * Returns: 0 on success, -1 on failure (or if not supported)
2405 * This function can be used to configure monitoring of signal strength
2406 * with the current AP. Whenever signal strength drops below the
2407 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2408 * should be generated assuming the signal strength has changed at
2409 * least %hysteresis from the previously indicated signal change event.
2411 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2414 * send_frame - Send IEEE 802.11 frame (testing use only)
2415 * @priv: Private driver interface data
2416 * @data: IEEE 802.11 frame with IEEE 802.11 header
2417 * @data_len: Size of the frame
2418 * @encrypt: Whether to encrypt the frame (if keys are set)
2419 * Returns: 0 on success, -1 on failure
2421 * This function is only used for debugging purposes and is not
2422 * required to be implemented for normal operations.
2424 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2428 * shared_freq - Get operating frequency of shared interface(s)
2429 * @priv: Private driver interface data
2430 * Returns: Operating frequency in MHz, 0 if no shared operation in
2431 * use, or -1 on failure
2433 * This command can be used to request the current operating frequency
2434 * of any virtual interface that shares the same radio to provide
2435 * information for channel selection for other virtual interfaces.
2437 int (*shared_freq)(void *priv);
2440 * get_noa - Get current Notice of Absence attribute payload
2441 * @priv: Private driver interface data
2442 * @buf: Buffer for returning NoA
2443 * @buf_len: Buffer length in octets
2444 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2445 * advertized, or -1 on failure
2447 * This function is used to fetch the current Notice of Absence
2448 * attribute value from GO.
2450 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2453 * set_noa - Set Notice of Absence parameters for GO (testing)
2454 * @priv: Private driver interface data
2456 * @start: Start time in ms from next TBTT
2457 * @duration: Duration in ms
2458 * Returns: 0 on success or -1 on failure
2460 * This function is used to set Notice of Absence parameters for GO. It
2461 * is used only for testing. To disable NoA, all parameters are set to
2464 int (*set_noa)(void *priv, u8 count, int start, int duration);
2467 * set_p2p_powersave - Set P2P power save options
2468 * @priv: Private driver interface data
2469 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2470 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2471 * @ctwindow: 0.. = change (msec), -1 = no change
2472 * Returns: 0 on success or -1 on failure
2474 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2478 * ampdu - Enable/disable aggregation
2479 * @priv: Private driver interface data
2480 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2481 * Returns: 0 on success or -1 on failure
2483 int (*ampdu)(void *priv, int ampdu);
2486 * get_radio_name - Get physical radio name for the device
2487 * @priv: Private driver interface data
2488 * Returns: Radio name or %NULL if not known
2490 * The returned data must not be modified by the caller. It is assumed
2491 * that any interface that has the same radio name as another is
2492 * sharing the same physical radio. This information can be used to
2493 * share scan results etc. information between the virtual interfaces
2494 * to speed up various operations.
2496 const char * (*get_radio_name)(void *priv);
2499 * send_tdls_mgmt - for sending TDLS management packets
2500 * @priv: private driver interface data
2501 * @dst: Destination (peer) MAC address
2502 * @action_code: TDLS action code for the mssage
2503 * @dialog_token: Dialog Token to use in the message (if needed)
2504 * @status_code: Status Code or Reason Code to use (if needed)
2505 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2506 * @buf: TDLS IEs to add to the message
2507 * @len: Length of buf in octets
2508 * Returns: 0 on success, negative (<0) on failure
2510 * This optional function can be used to send packet to driver which is
2511 * responsible for receiving and sending all TDLS packets.
2513 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2514 u8 dialog_token, u16 status_code, u32 peer_capab,
2515 const u8 *buf, size_t len);
2518 * tdls_oper - Ask the driver to perform high-level TDLS operations
2519 * @priv: Private driver interface data
2520 * @oper: TDLS high-level operation. See %enum tdls_oper
2521 * @peer: Destination (peer) MAC address
2522 * Returns: 0 on success, negative (<0) on failure
2524 * This optional function can be used to send high-level TDLS commands
2527 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2530 * wnm_oper - Notify driver of the WNM frame reception
2531 * @priv: Private driver interface data
2532 * @oper: WNM operation. See %enum wnm_oper
2533 * @peer: Destination (peer) MAC address
2534 * @buf: Buffer for the driver to fill in (for getting IE)
2535 * @buf_len: Return the len of buf
2536 * Returns: 0 on success, negative (<0) on failure
2538 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2539 u8 *buf, u16 *buf_len);
2542 * set_qos_map - Set QoS Map
2543 * @priv: Private driver interface data
2544 * @qos_map_set: QoS Map
2545 * @qos_map_set_len: Length of QoS Map
2547 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2548 u8 qos_map_set_len);
2551 * set_wowlan - Set wake-on-wireless triggers
2552 * @priv: Private driver interface data
2553 * @triggers: wowlan triggers
2555 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2558 * signal_poll - Get current connection information
2559 * @priv: Private driver interface data
2560 * @signal_info: Connection info structure
2562 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2565 * set_authmode - Set authentication algorithm(s) for static WEP
2566 * @priv: Private driver interface data
2567 * @authmode: 1=Open System, 2=Shared Key, 3=both
2568 * Returns: 0 on success, -1 on failure
2570 * This function can be used to set authentication algorithms for AP
2571 * mode when static WEP is used. If the driver uses user space MLME/SME
2572 * implementation, there is no need to implement this function.
2574 * DEPRECATED - use set_ap() instead
2576 int (*set_authmode)(void *priv, int authmode);
2580 * driver_cmd - Execute driver-specific command
2581 * @priv: Private driver interface data
2582 * @cmd: Command to execute
2583 * @buf: Return buffer
2584 * @buf_len: Buffer length
2585 * Returns: 0 on success, -1 on failure
2587 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2588 #endif /* ANDROID */
2591 * vendor_cmd - Execute vendor specific command
2592 * @priv: Private driver interface data
2593 * @vendor_id: Vendor id
2594 * @subcmd: Vendor command id
2595 * @data: Vendor command parameters (%NULL if no parameters)
2596 * @data_len: Data length
2597 * @buf: Return buffer (%NULL to ignore reply)
2598 * Returns: 0 on success, negative (<0) on failure
2600 * This function handles vendor specific commands that are passed to
2601 * the driver/device. The command is identified by vendor id and
2602 * command id. Parameters can be passed as argument to the command
2603 * in the data buffer. Reply (if any) will be filled in the supplied
2606 * The exact driver behavior is driver interface and vendor specific. As
2607 * an example, this will be converted to a vendor specific cfg80211
2608 * command in case of the nl80211 driver interface.
2610 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2611 unsigned int subcmd, const u8 *data, size_t data_len,
2612 struct wpabuf *buf);
2615 * set_rekey_info - Set rekey information
2616 * @priv: Private driver interface data
2619 * @replay_ctr: Current EAPOL-Key Replay Counter
2621 * This optional function can be used to provide information for the
2622 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2623 * while the host (including wpa_supplicant) is sleeping.
2625 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2626 const u8 *replay_ctr);
2629 * sta_assoc - Station association indication
2630 * @priv: Private driver interface data
2631 * @own_addr: Source address and BSSID for association frame
2632 * @addr: MAC address of the station to associate
2633 * @reassoc: flag to indicate re-association
2634 * @status: association response status code
2635 * @ie: assoc response ie buffer
2636 * @len: ie buffer length
2637 * Returns: 0 on success, -1 on failure
2639 * This function indicates the driver to send (Re)Association
2640 * Response frame to the station.
2642 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2643 int reassoc, u16 status, const u8 *ie, size_t len);
2646 * sta_auth - Station authentication indication
2647 * @priv: Private driver interface data
2648 * @own_addr: Source address and BSSID for authentication frame
2649 * @addr: MAC address of the station to associate
2650 * @seq: authentication sequence number
2651 * @status: authentication response status code
2652 * @ie: authentication frame ie buffer
2653 * @len: ie buffer length
2655 * This function indicates the driver to send Authentication frame
2658 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2659 u16 seq, u16 status, const u8 *ie, size_t len);
2662 * add_tspec - Add traffic stream
2663 * @priv: Private driver interface data
2664 * @addr: MAC address of the station to associate
2665 * @tspec_ie: tspec ie buffer
2666 * @tspec_ielen: tspec ie length
2667 * Returns: 0 on success, -1 on failure
2669 * This function adds the traffic steam for the station
2670 * and fills the medium_time in tspec_ie.
2672 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2673 size_t tspec_ielen);
2676 * add_sta_node - Add a station node in the driver
2677 * @priv: Private driver interface data
2678 * @addr: MAC address of the station to add
2679 * @auth_alg: authentication algorithm used by the station
2680 * Returns: 0 on success, -1 on failure
2682 * This function adds the station node in the driver, when
2683 * the station gets added by FT-over-DS.
2685 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2688 * sched_scan - Request the driver to initiate scheduled scan
2689 * @priv: Private driver interface data
2690 * @params: Scan parameters
2691 * @interval: Interval between scan cycles in milliseconds
2692 * Returns: 0 on success, -1 on failure
2694 * This operation should be used for scheduled scan offload to
2695 * the hardware. Every time scan results are available, the
2696 * driver should report scan results event for wpa_supplicant
2697 * which will eventually request the results with
2698 * wpa_driver_get_scan_results2(). This operation is optional
2699 * and if not provided or if it returns -1, we fall back to
2700 * normal host-scheduled scans.
2702 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2706 * stop_sched_scan - Request the driver to stop a scheduled scan
2707 * @priv: Private driver interface data
2708 * Returns: 0 on success, -1 on failure
2710 * This should cause the scheduled scan to be stopped and
2711 * results should stop being sent. Must be supported if
2712 * sched_scan is supported.
2714 int (*stop_sched_scan)(void *priv);
2717 * poll_client - Probe (null data or such) the given station
2718 * @priv: Private driver interface data
2719 * @own_addr: MAC address of sending interface
2720 * @addr: MAC address of the station to probe
2721 * @qos: Indicates whether station is QoS station
2723 * This function is used to verify whether an associated station is
2724 * still present. This function does not need to be implemented if the
2725 * driver provides such inactivity polling mechanism.
2727 void (*poll_client)(void *priv, const u8 *own_addr,
2728 const u8 *addr, int qos);
2731 * radio_disable - Disable/enable radio
2732 * @priv: Private driver interface data
2733 * @disabled: 1=disable 0=enable radio
2734 * Returns: 0 on success, -1 on failure
2736 * This optional command is for testing purposes. It can be used to
2737 * disable the radio on a testbed device to simulate out-of-radio-range
2740 int (*radio_disable)(void *priv, int disabled);
2743 * switch_channel - Announce channel switch and migrate the GO to the
2745 * @priv: Private driver interface data
2746 * @settings: Settings for CSA period and new channel
2747 * Returns: 0 on success, -1 on failure
2749 * This function is used to move the GO to the legacy STA channel to
2750 * avoid frequency conflict in single channel concurrency.
2752 int (*switch_channel)(void *priv, struct csa_settings *settings);
2755 * start_dfs_cac - Listen for radar interference on the channel
2756 * @priv: Private driver interface data
2757 * @freq: Channel parameters
2758 * Returns: 0 on success, -1 on failure
2760 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
2763 * stop_ap - Removes beacon from AP
2764 * @priv: Private driver interface data
2765 * Returns: 0 on success, -1 on failure (or if not supported)
2767 * This optional function can be used to disable AP mode related
2768 * configuration. Unlike deinit_ap, it does not change to station
2771 int (*stop_ap)(void *priv);
2774 * get_survey - Retrieve survey data
2775 * @priv: Private driver interface data
2776 * @freq: If set, survey data for the specified frequency is only
2777 * being requested. If not set, all survey data is requested.
2778 * Returns: 0 on success, -1 on failure
2780 * Use this to retrieve:
2782 * - the observed channel noise floor
2783 * - the amount of time we have spent on the channel
2784 * - the amount of time during which we have spent on the channel that
2785 * the radio has determined the medium is busy and we cannot
2787 * - the amount of time we have spent receiving data
2788 * - the amount of time we have spent transmitting data
2790 * This data can be used for spectrum heuristics. One example is
2791 * Automatic Channel Selection (ACS). The channel survey data is
2792 * kept on a linked list on the channel data, one entry is added
2793 * for each survey. The min_nf of the channel is updated for each
2796 int (*get_survey)(void *priv, unsigned int freq);
2799 * status - Get driver interface status information
2800 * @priv: Private driver interface data
2801 * @buf: Buffer for printing tou the status information
2802 * @buflen: Maximum length of the buffer
2803 * Returns: Length of written status information or -1 on failure
2805 int (*status)(void *priv, char *buf, size_t buflen);
2807 #ifdef CONFIG_MACSEC
2808 int (*macsec_init)(void *priv, struct macsec_init_params *params);
2810 int (*macsec_deinit)(void *priv);
2813 * enable_protect_frames - Set protect frames status
2814 * @priv: Private driver interface data
2815 * @enabled: TRUE = protect frames enabled
2816 * FALSE = protect frames disabled
2817 * Returns: 0 on success, -1 on failure (or if not supported)
2819 int (*enable_protect_frames)(void *priv, Boolean enabled);
2822 * set_replay_protect - Set replay protect status and window size
2823 * @priv: Private driver interface data
2824 * @enabled: TRUE = replay protect enabled
2825 * FALSE = replay protect disabled
2826 * @window: replay window size, valid only when replay protect enabled
2827 * Returns: 0 on success, -1 on failure (or if not supported)
2829 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
2832 * set_current_cipher_suite - Set current cipher suite
2833 * @priv: Private driver interface data
2834 * @cs: EUI64 identifier
2835 * @cs_len: Length of the cs buffer in octets
2836 * Returns: 0 on success, -1 on failure (or if not supported)
2838 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
2842 * enable_controlled_port - Set controlled port status
2843 * @priv: Private driver interface data
2844 * @enabled: TRUE = controlled port enabled
2845 * FALSE = controlled port disabled
2846 * Returns: 0 on success, -1 on failure (or if not supported)
2848 int (*enable_controlled_port)(void *priv, Boolean enabled);
2851 * get_receive_lowest_pn - Get receive lowest pn
2852 * @priv: Private driver interface data
2853 * @channel: secure channel
2854 * @an: association number
2855 * @lowest_pn: lowest accept pn
2856 * Returns: 0 on success, -1 on failure (or if not supported)
2858 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
2862 * get_transmit_next_pn - Get transmit next pn
2863 * @priv: Private driver interface data
2864 * @channel: secure channel
2865 * @an: association number
2867 * Returns: 0 on success, -1 on failure (or if not supported)
2869 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
2873 * set_transmit_next_pn - Set transmit next pn
2874 * @priv: Private driver interface data
2875 * @channel: secure channel
2876 * @an: association number
2878 * Returns: 0 on success, -1 on failure (or if not supported)
2880 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
2884 * get_available_receive_sc - get available receive channel
2885 * @priv: Private driver interface data
2886 * @channel: secure channel
2887 * Returns: 0 on success, -1 on failure (or if not supported)
2889 int (*get_available_receive_sc)(void *priv, u32 *channel);
2892 * create_receive_sc - create secure channel for receiving
2893 * @priv: Private driver interface data
2894 * @channel: secure channel
2895 * @sci_addr: secure channel identifier - address
2896 * @sci_port: secure channel identifier - port
2897 * @conf_offset: confidentiality offset (0, 30, or 50)
2898 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
2900 * Returns: 0 on success, -1 on failure (or if not supported)
2902 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
2903 u16 sci_port, unsigned int conf_offset,
2907 * delete_receive_sc - delete secure connection for receiving
2908 * @priv: private driver interface data from init()
2909 * @channel: secure channel
2910 * Returns: 0 on success, -1 on failure
2912 int (*delete_receive_sc)(void *priv, u32 channel);
2915 * create_receive_sa - create secure association for receive
2916 * @priv: private driver interface data from init()
2917 * @channel: secure channel
2918 * @an: association number
2919 * @lowest_pn: the lowest packet number can be received
2920 * @sak: the secure association key
2921 * Returns: 0 on success, -1 on failure
2923 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
2924 u32 lowest_pn, const u8 *sak);
2927 * enable_receive_sa - enable the SA for receive
2928 * @priv: private driver interface data from init()
2929 * @channel: secure channel
2930 * @an: association number
2931 * Returns: 0 on success, -1 on failure
2933 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
2936 * disable_receive_sa - disable SA for receive
2937 * @priv: private driver interface data from init()
2938 * @channel: secure channel index
2939 * @an: association number
2940 * Returns: 0 on success, -1 on failure
2942 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
2945 * get_available_transmit_sc - get available transmit channel
2946 * @priv: Private driver interface data
2947 * @channel: secure channel
2948 * Returns: 0 on success, -1 on failure (or if not supported)
2950 int (*get_available_transmit_sc)(void *priv, u32 *channel);
2953 * create_transmit_sc - create secure connection for transmit
2954 * @priv: private driver interface data from init()
2955 * @channel: secure channel
2956 * @sci_addr: secure channel identifier - address
2957 * @sci_port: secure channel identifier - port
2958 * Returns: 0 on success, -1 on failure
2960 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
2961 u16 sci_port, unsigned int conf_offset);
2964 * delete_transmit_sc - delete secure connection for transmit
2965 * @priv: private driver interface data from init()
2966 * @channel: secure channel
2967 * Returns: 0 on success, -1 on failure
2969 int (*delete_transmit_sc)(void *priv, u32 channel);
2972 * create_transmit_sa - create secure association for transmit
2973 * @priv: private driver interface data from init()
2974 * @channel: secure channel index
2975 * @an: association number
2976 * @next_pn: the packet number used as next transmit packet
2977 * @confidentiality: True if the SA is to provide confidentiality
2978 * as well as integrity
2979 * @sak: the secure association key
2980 * Returns: 0 on success, -1 on failure
2982 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
2983 Boolean confidentiality, const u8 *sak);
2986 * enable_transmit_sa - enable SA for transmit
2987 * @priv: private driver interface data from init()
2988 * @channel: secure channel
2989 * @an: association number
2990 * Returns: 0 on success, -1 on failure
2992 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
2995 * disable_transmit_sa - disable SA for transmit
2996 * @priv: private driver interface data from init()
2997 * @channel: secure channel
2998 * @an: association number
2999 * Returns: 0 on success, -1 on failure
3001 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3002 #endif /* CONFIG_MACSEC */
3007 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3009 enum wpa_event_type {
3011 * EVENT_ASSOC - Association completed
3013 * This event needs to be delivered when the driver completes IEEE
3014 * 802.11 association or reassociation successfully.
3015 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3016 * after this event has been generated. In addition, optional
3017 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3018 * more information about the association. If the driver interface gets
3019 * both of these events at the same time, it can also include the
3020 * assoc_info data in EVENT_ASSOC call.
3025 * EVENT_DISASSOC - Association lost
3027 * This event should be called when association is lost either due to
3028 * receiving deauthenticate or disassociate frame from the AP or when
3029 * sending either of these frames to the current AP. If the driver
3030 * supports separate deauthentication event, EVENT_DISASSOC should only
3031 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3032 * In AP mode, union wpa_event_data::disassoc_info is required.
3037 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3039 * This event must be delivered when a Michael MIC error is detected by
3040 * the local driver. Additional data for event processing is
3041 * provided with union wpa_event_data::michael_mic_failure. This
3042 * information is used to request new encyption key and to initiate
3043 * TKIP countermeasures if needed.
3045 EVENT_MICHAEL_MIC_FAILURE,
3048 * EVENT_SCAN_RESULTS - Scan results available
3050 * This event must be called whenever scan results are available to be
3051 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3052 * is expected to be used some time after struct wpa_driver_ops::scan()
3053 * is called. If the driver provides an unsolicited event when the scan
3054 * has been completed, this event can be used to trigger
3055 * EVENT_SCAN_RESULTS call. If such event is not available from the
3056 * driver, the driver wrapper code is expected to use a registered
3057 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3058 * scan is expected to be completed. Optional information about
3059 * completed scan can be provided with union wpa_event_data::scan_info.
3064 * EVENT_ASSOCINFO - Report optional extra information for association
3066 * This event can be used to report extra association information for
3067 * EVENT_ASSOC processing. This extra information includes IEs from
3068 * association frames and Beacon/Probe Response frames in union
3069 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3070 * EVENT_ASSOC. Alternatively, the driver interface can include
3071 * assoc_info data in the EVENT_ASSOC call if it has all the
3072 * information available at the same point.
3077 * EVENT_INTERFACE_STATUS - Report interface status changes
3079 * This optional event can be used to report changes in interface
3080 * status (interface added/removed) using union
3081 * wpa_event_data::interface_status. This can be used to trigger
3082 * wpa_supplicant to stop and re-start processing for the interface,
3083 * e.g., when a cardbus card is ejected/inserted.
3085 EVENT_INTERFACE_STATUS,
3088 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3090 * This event can be used to inform wpa_supplicant about candidates for
3091 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3092 * for scan request (ap_scan=2 mode), this event is required for
3093 * pre-authentication. If wpa_supplicant is performing scan request
3094 * (ap_scan=1), this event is optional since scan results can be used
3095 * to add pre-authentication candidates. union
3096 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3097 * candidate and priority of the candidate, e.g., based on the signal
3098 * strength, in order to try to pre-authenticate first with candidates
3099 * that are most likely targets for re-association.
3101 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3102 * on the candidate list. In addition, it can be called for the current
3103 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3104 * will automatically skip pre-authentication in cases where a valid
3105 * PMKSA exists. When more than one candidate exists, this event should
3106 * be generated once for each candidate.
3108 * Driver will be notified about successful pre-authentication with
3109 * struct wpa_driver_ops::add_pmkid() calls.
3111 EVENT_PMKID_CANDIDATE,
3114 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3116 * This event can be used to inform wpa_supplicant about desire to set
3117 * up secure direct link connection between two stations as defined in
3118 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3119 * STAKey negotiation. The caller will need to set peer address for the
3125 * EVENT_TDLS - Request TDLS operation
3127 * This event can be used to request a TDLS operation to be performed.
3132 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3134 * The driver is expected to report the received FT IEs from
3135 * FT authentication sequence from the AP. The FT IEs are included in
3136 * the extra information in union wpa_event_data::ft_ies.
3141 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3143 * The driver can use this event to inform wpa_supplicant about a STA
3144 * in an IBSS with which protected frames could be exchanged. This
3145 * event starts RSN authentication with the other STA to authenticate
3146 * the STA and set up encryption keys with it.
3148 EVENT_IBSS_RSN_START,
3151 * EVENT_AUTH - Authentication result
3153 * This event should be called when authentication attempt has been
3154 * completed. This is only used if the driver supports separate
3155 * authentication step (struct wpa_driver_ops::authenticate).
3156 * Information about authentication result is included in
3157 * union wpa_event_data::auth.
3162 * EVENT_DEAUTH - Authentication lost
3164 * This event should be called when authentication is lost either due
3165 * to receiving deauthenticate frame from the AP or when sending that
3166 * frame to the current AP.
3167 * In AP mode, union wpa_event_data::deauth_info is required.
3172 * EVENT_ASSOC_REJECT - Association rejected
3174 * This event should be called when (re)association attempt has been
3175 * rejected by the AP. Information about the association response is
3176 * included in union wpa_event_data::assoc_reject.
3181 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3183 EVENT_AUTH_TIMED_OUT,
3186 * EVENT_ASSOC_TIMED_OUT - Association timed out
3188 EVENT_ASSOC_TIMED_OUT,
3191 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
3196 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3198 EVENT_WPS_BUTTON_PUSHED,
3201 * EVENT_TX_STATUS - Report TX status
3206 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3208 EVENT_RX_FROM_UNKNOWN,
3211 * EVENT_RX_MGMT - Report RX of a management frame
3216 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3218 * This event is used to indicate when the driver has started the
3219 * requested remain-on-channel duration. Information about the
3220 * operation is included in union wpa_event_data::remain_on_channel.
3222 EVENT_REMAIN_ON_CHANNEL,
3225 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3227 * This event is used to indicate when the driver has completed
3228 * remain-on-channel duration, i.e., may noot be available on the
3229 * requested channel anymore. Information about the
3230 * operation is included in union wpa_event_data::remain_on_channel.
3232 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3235 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
3237 * This event is used only by driver_test.c and userspace MLME.
3242 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3244 * This event is used to indicate when a Probe Request frame has been
3245 * received. Information about the received frame is included in
3246 * union wpa_event_data::rx_probe_req. The driver is required to report
3247 * these events only after successfully completed probe_req_report()
3248 * commands to request the events (i.e., report parameter is non-zero)
3249 * in station mode. In AP mode, Probe Request frames should always be
3255 * EVENT_NEW_STA - New wired device noticed
3257 * This event is used to indicate that a new device has been detected
3258 * in a network that does not use association-like functionality (i.e.,
3259 * mainly wired Ethernet). This can be used to start EAPOL
3260 * authenticator when receiving a frame from a device. The address of
3261 * the device is included in union wpa_event_data::new_sta.
3266 * EVENT_EAPOL_RX - Report received EAPOL frame
3268 * When in AP mode with hostapd, this event is required to be used to
3269 * deliver the receive EAPOL frames from the driver. With
3270 * %wpa_supplicant, this event is used only if the send_eapol() handler
3271 * is used to override the use of l2_packet for EAPOL frame TX.
3276 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3278 * This event is used to indicate changes in the signal strength
3279 * observed in frames received from the current AP if signal strength
3280 * monitoring has been enabled with signal_monitor().
3282 EVENT_SIGNAL_CHANGE,
3285 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3287 * This event is used to indicate that the interface was enabled after
3288 * having been previously disabled, e.g., due to rfkill.
3290 EVENT_INTERFACE_ENABLED,
3293 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3295 * This event is used to indicate that the interface was disabled,
3296 * e.g., due to rfkill.
3298 EVENT_INTERFACE_DISABLED,
3301 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3303 * This event is used to indicate that the channel list has changed,
3304 * e.g., because of a regulatory domain change triggered by scan
3305 * results including an AP advertising a country code.
3307 EVENT_CHANNEL_LIST_CHANGED,
3310 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3312 * This event is used to indicate that the driver cannot maintain this
3313 * interface in its operation mode anymore. The most likely use for
3314 * this is to indicate that AP mode operation is not available due to
3315 * operating channel would need to be changed to a DFS channel when
3316 * the driver does not support radar detection and another virtual
3317 * interfaces caused the operating channel to change. Other similar
3318 * resource conflicts could also trigger this for station mode
3321 EVENT_INTERFACE_UNAVAILABLE,
3324 * EVENT_BEST_CHANNEL
3326 * Driver generates this event whenever it detects a better channel
3327 * (e.g., based on RSSI or channel use). This information can be used
3328 * to improve channel selection for a new AP/P2P group.
3333 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3335 * This event should be called when a Deauthentication frame is dropped
3336 * due to it not being protected (MFP/IEEE 802.11w).
3337 * union wpa_event_data::unprot_deauth is required to provide more
3338 * details of the frame.
3340 EVENT_UNPROT_DEAUTH,
3343 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3345 * This event should be called when a Disassociation frame is dropped
3346 * due to it not being protected (MFP/IEEE 802.11w).
3347 * union wpa_event_data::unprot_disassoc is required to provide more
3348 * details of the frame.
3350 EVENT_UNPROT_DISASSOC,
3353 * EVENT_STATION_LOW_ACK
3355 * Driver generates this event whenever it detected that a particular
3356 * station was lost. Detection can be through massive transmission
3357 * failures for example.
3359 EVENT_STATION_LOW_ACK,
3362 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3364 EVENT_IBSS_PEER_LOST,
3367 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3369 * This event carries the new replay counter to notify wpa_supplicant
3370 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3371 * completed Group Key Handshake while the host (including
3372 * wpa_supplicant was sleeping).
3374 EVENT_DRIVER_GTK_REKEY,
3377 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3379 EVENT_SCHED_SCAN_STOPPED,
3382 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3384 * This event indicates that the station responded to the poll
3385 * initiated with @poll_client.
3387 EVENT_DRIVER_CLIENT_POLL_OK,
3390 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3392 EVENT_EAPOL_TX_STATUS,
3395 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3397 * Described in wpa_event_data.ch_switch
3402 * EVENT_WNM - Request WNM operation
3404 * This event can be used to request a WNM operation to be performed.
3409 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3411 * This event indicates that the driver reported a connection failure
3412 * with the specified client (for example, max client reached, etc.) in
3415 EVENT_CONNECT_FAILED_REASON,
3418 * EVENT_RADAR_DETECTED - Notify of radar detection
3420 * A radar has been detected on the supplied frequency, hostapd should
3421 * react accordingly (e.g., change channel).
3423 EVENT_DFS_RADAR_DETECTED,
3426 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3428 * After a successful CAC, the channel can be marked clear and used.
3430 EVENT_DFS_CAC_FINISHED,
3433 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3435 * The CAC was not successful, and the channel remains in the previous
3436 * state. This may happen due to a radar beeing detected or other
3437 * external influences.
3439 EVENT_DFS_CAC_ABORTED,
3442 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3444 * The channel which was previously unavailable is now available again.
3446 EVENT_DFS_NOP_FINISHED,
3449 * EVENT_SURVEY - Received survey data
3451 * This event gets triggered when a driver query is issued for survey
3452 * data and the requested data becomes available. The returned data is
3453 * stored in struct survey_results. The results provide at most one
3454 * survey entry for each frequency and at minimum will provide one
3455 * survey entry for one frequency. The survey data can be os_malloc()'d
3456 * and then os_free()'d, so the event callback must only copy data.
3461 * EVENT_SCAN_STARTED - Scan started
3463 * This indicates that driver has started a scan operation either based
3464 * on a request from wpa_supplicant/hostapd or from another application.
3465 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3466 * completed (either successfully or by getting cancelled).
3471 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3473 * This event indicates a set of frequency ranges that should be avoided
3474 * to reduce issues due to interference or internal co-existence
3475 * information in the driver.
3477 EVENT_AVOID_FREQUENCIES
3482 * struct freq_survey - Channel survey info
3484 * @ifidx: Interface index in which this survey was observed
3485 * @freq: Center of frequency of the surveyed channel
3486 * @nf: Channel noise floor in dBm
3487 * @channel_time: Amount of time in ms the radio spent on the channel
3488 * @channel_time_busy: Amount of time in ms the radio detected some signal
3489 * that indicated to the radio the channel was not clear
3490 * @channel_time_rx: Amount of time the radio spent receiving data
3491 * @channel_time_tx: Amount of time the radio spent transmitting data
3492 * @filled: bitmask indicating which fields have been reported, see
3493 * SURVEY_HAS_* defines.
3494 * @list: Internal list pointers
3496 struct freq_survey {
3501 u64 channel_time_busy;
3502 u64 channel_time_rx;
3503 u64 channel_time_tx;
3504 unsigned int filled;
3505 struct dl_list list;
3508 #define SURVEY_HAS_NF BIT(0)
3509 #define SURVEY_HAS_CHAN_TIME BIT(1)
3510 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3511 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3512 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3516 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3518 union wpa_event_data {
3520 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3522 * This structure is optional for EVENT_ASSOC calls and required for
3523 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3524 * driver interface does not need to generate separate EVENT_ASSOCINFO
3529 * reassoc - Flag to indicate association or reassociation
3534 * req_ies - (Re)Association Request IEs
3536 * If the driver generates WPA/RSN IE, this event data must be
3537 * returned for WPA handshake to have needed information. If
3538 * wpa_supplicant-generated WPA/RSN IE is used, this
3539 * information event is optional.
3541 * This should start with the first IE (fixed fields before IEs
3542 * are not included).
3547 * req_ies_len - Length of req_ies in bytes
3552 * resp_ies - (Re)Association Response IEs
3554 * Optional association data from the driver. This data is not
3555 * required WPA, but may be useful for some protocols and as
3556 * such, should be reported if this is available to the driver
3559 * This should start with the first IE (fixed fields before IEs
3560 * are not included).
3565 * resp_ies_len - Length of resp_ies in bytes
3567 size_t resp_ies_len;
3570 * beacon_ies - Beacon or Probe Response IEs
3572 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3573 * Probe Response frames from the current AP (i.e., the one
3574 * that the client just associated with). This information is
3575 * used to update WPA/RSN IE for the AP. If this field is not
3576 * set, the results from previous scan will be used. If no
3577 * data for the new AP is found, scan results will be requested
3578 * again (without scan request). At this point, the driver is
3579 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3582 * This should start with the first IE (fixed fields before IEs
3583 * are not included).
3585 const u8 *beacon_ies;
3588 * beacon_ies_len - Length of beacon_ies */
3589 size_t beacon_ies_len;
3592 * freq - Frequency of the operational channel in MHz
3597 * addr - Station address (for AP mode)
3603 * struct disassoc_info - Data for EVENT_DISASSOC events
3605 struct disassoc_info {
3607 * addr - Station address (for AP mode)
3612 * reason_code - Reason Code (host byte order) used in
3613 * Deauthentication frame
3618 * ie - Optional IE(s) in Disassociation frame
3623 * ie_len - Length of ie buffer in octets
3628 * locally_generated - Whether the frame was locally generated
3630 int locally_generated;
3634 * struct deauth_info - Data for EVENT_DEAUTH events
3636 struct deauth_info {
3638 * addr - Station address (for AP mode)
3643 * reason_code - Reason Code (host byte order) used in
3644 * Deauthentication frame
3649 * ie - Optional IE(s) in Deauthentication frame
3654 * ie_len - Length of ie buffer in octets
3659 * locally_generated - Whether the frame was locally generated
3661 int locally_generated;
3665 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3667 struct michael_mic_failure {
3670 } michael_mic_failure;
3673 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3675 struct interface_status {
3678 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3683 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3685 struct pmkid_candidate {
3686 /** BSSID of the PMKID candidate */
3688 /** Smaller the index, higher the priority */
3690 /** Whether RSN IE includes pre-authenticate flag */
3695 * struct stkstart - Data for EVENT_STKSTART
3702 * struct tdls - Data for EVENT_TDLS
3708 TDLS_REQUEST_TEARDOWN
3710 u16 reason_code; /* for teardown */
3714 * struct wnm - Data for EVENT_WNM
3732 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3734 * During FT (IEEE 802.11r) authentication sequence, the driver is
3735 * expected to use this event to report received FT IEs (MDIE, FTIE,
3736 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3737 * IEs for the next message will be delivered through the
3738 * struct wpa_driver_ops::update_ft_ies() callback.
3744 u8 target_ap[ETH_ALEN];
3745 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3747 /** Length of ric_ies buffer in octets */
3752 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3754 struct ibss_rsn_start {
3759 * struct auth_info - Data for EVENT_AUTH events
3765 u16 auth_transaction;
3772 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3774 struct assoc_reject {
3776 * bssid - BSSID of the AP that rejected association
3781 * resp_ies - (Re)Association Response IEs
3783 * Optional association data from the driver. This data is not
3784 * required WPA, but may be useful for some protocols and as
3785 * such, should be reported if this is available to the driver
3788 * This should start with the first IE (fixed fields before IEs
3789 * are not included).
3794 * resp_ies_len - Length of resp_ies in bytes
3796 size_t resp_ies_len;
3799 * status_code - Status Code from (Re)association Response
3804 struct timeout_event {
3809 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3818 * struct tx_status - Data for EVENT_TX_STATUS events
3830 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3832 struct rx_from_unknown {
3839 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3847 * drv_priv - Pointer to store driver private BSS information
3849 * If not set to NULL, this is used for comparison with
3850 * hostapd_data->drv_priv to determine which BSS should process
3856 * freq - Frequency (in MHz) on which the frame was received
3861 * ssi_signal - Signal strength in dBm (or 0 if not available)
3867 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3869 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3871 struct remain_on_channel {
3873 * freq - Channel frequency in MHz
3878 * duration - Duration to remain on the channel in milliseconds
3880 unsigned int duration;
3881 } remain_on_channel;
3884 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3885 * @aborted: Whether the scan was aborted
3886 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3887 * @num_freqs: Number of entries in freqs array
3888 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3890 * @num_ssids: Number of entries in ssids array
3896 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3901 * struct mlme_rx - Data for EVENT_MLME_RX events
3912 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3914 struct rx_probe_req {
3916 * sa - Source address of the received Probe Request frame
3921 * da - Destination address of the received Probe Request frame
3922 * or %NULL if not available
3927 * bssid - BSSID of the received Probe Request frame or %NULL
3933 * ie - IEs from the Probe Request body
3938 * ie_len - Length of ie buffer in octets
3943 * signal - signal strength in dBm (or 0 if not available)
3949 * struct new_sta - Data for EVENT_NEW_STA events
3956 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3965 * signal_change - Data for EVENT_SIGNAL_CHANGE events
3967 struct wpa_signal_info signal_change;
3970 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3971 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3972 * @freq_5: Best 5 GHz band channel frequency in MHz
3973 * @freq_overall: Best channel frequency in MHz
3975 * 0 can be used to indicate no preference in either band.
3977 struct best_channel {
3983 struct unprot_deauth {
3989 struct unprot_disassoc {
3996 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3997 * @addr: station address
4004 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4006 struct ibss_peer_lost {
4011 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4013 struct driver_gtk_rekey {
4015 const u8 *replay_ctr;
4019 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4020 * @addr: station address
4022 struct client_poll {
4027 * struct eapol_tx_status
4028 * @dst: Original destination
4029 * @data: Data starting with IEEE 802.1X header (!)
4030 * @data_len: Length of data
4031 * @ack: Indicates ack or lost frame
4033 * This corresponds to hapd_send_eapol if the frame sent
4034 * there isn't just reported as EVENT_TX_STATUS.
4036 struct eapol_tx_status {
4045 * @freq: Frequency of new channel in MHz
4046 * @ht_enabled: Whether this is an HT channel
4047 * @ch_offset: Secondary channel offset
4048 * @ch_width: Channel width
4049 * @cf1: Center frequency 1
4050 * @cf2: Center frequency 2
4056 enum chan_width ch_width;
4062 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4063 * @addr: Remote client address
4064 * @code: Reason code for connection failure
4066 struct connect_failed_reason {
4072 } connect_failed_reason;
4075 * struct dfs_event - Data for radar detected events
4076 * @freq: Frequency of the channel in MHz
4082 enum chan_width chan_width;
4088 * survey_results - Survey result data for EVENT_SURVEY
4089 * @freq_filter: Requested frequency survey filter, 0 if request
4090 * was for all survey data
4091 * @survey_list: Linked list of survey data
4093 struct survey_results {
4094 unsigned int freq_filter;
4095 struct dl_list survey_list; /* struct freq_survey */
4099 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4100 * @initiator: Initiator of the regulatory change
4101 * @type: Regulatory change type
4102 * @alpha2: Country code (or "" if not available)
4104 struct channel_list_changed {
4105 enum reg_change_initiator initiator;
4108 } channel_list_changed;
4111 * freq_range - List of frequency ranges
4113 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4115 struct wpa_freq_range_list freq_range;
4119 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4120 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4121 * with struct wpa_driver_ops::init()
4122 * @event: event type (defined above)
4123 * @data: possible extra data for the event
4125 * Driver wrapper code should call this function whenever an event is received
4128 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4129 union wpa_event_data *data);
4133 * The following inline functions are provided for convenience to simplify
4134 * event indication for some of the common events.
4137 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4138 size_t ielen, int reassoc)
4140 union wpa_event_data event;
4141 os_memset(&event, 0, sizeof(event));
4142 event.assoc_info.reassoc = reassoc;
4143 event.assoc_info.req_ies = ie;
4144 event.assoc_info.req_ies_len = ielen;
4145 event.assoc_info.addr = addr;
4146 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4149 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4151 union wpa_event_data event;
4152 os_memset(&event, 0, sizeof(event));
4153 event.disassoc_info.addr = addr;
4154 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4157 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4160 union wpa_event_data event;
4161 os_memset(&event, 0, sizeof(event));
4162 event.eapol_rx.src = src;
4163 event.eapol_rx.data = data;
4164 event.eapol_rx.data_len = data_len;
4165 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4168 /* driver_common.c */
4169 void wpa_scan_results_free(struct wpa_scan_results *res);
4171 /* Convert wpa_event_type to a string for logging */
4172 const char * event_to_string(enum wpa_event_type event);
4174 /* NULL terminated array of linked in driver wrappers */
4175 extern struct wpa_driver_ops *wpa_drivers[];
4177 #endif /* DRIVER_H */