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_NO_IR 0x00000002
27 #define HOSTAPD_CHAN_RADAR 0x00000008
28 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
29 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
30 #define HOSTAPD_CHAN_HT40 0x00000040
31 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
33 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
34 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
35 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
36 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
37 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
39 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
40 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
41 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
42 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
44 #define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
45 #define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
47 enum reg_change_initiator {
51 REGDOM_SET_BY_COUNTRY_IE,
59 REGDOM_TYPE_CUSTOM_WORLD,
60 REGDOM_TYPE_INTERSECTION,
64 * struct hostapd_channel_data - Channel information
66 struct hostapd_channel_data {
68 * chan - Channel number (IEEE 802.11)
73 * freq - Frequency in MHz
78 * flag - Channel flags (HOSTAPD_CHAN_*)
83 * max_tx_power - Regulatory transmit power limit in dBm
88 * survey_list - Linked list of surveys
90 struct dl_list survey_list;
93 * min_nf - Minimum observed noise floor, in dBm, based on all
94 * surveyed channel data
100 * interference_factor - Computed interference factor on this
101 * channel (used internally in src/ap/acs.c; driver wrappers do not
104 long double interference_factor;
105 #endif /* CONFIG_ACS */
107 /* DFS CAC time in milliseconds */
108 unsigned int dfs_cac_ms;
111 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
112 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
115 * struct hostapd_hw_modes - Supported hardware mode information
117 struct hostapd_hw_modes {
119 * mode - Hardware mode
121 enum hostapd_hw_mode mode;
124 * num_channels - Number of entries in the channels array
129 * channels - Array of supported channels
131 struct hostapd_channel_data *channels;
134 * num_rates - Number of entries in the rates array
139 * rates - Array of supported rates in 100 kbps units
144 * ht_capab - HT (IEEE 802.11n) capabilities
149 * mcs_set - MCS (IEEE 802.11n) rate parameters
154 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
159 * vht_capab - VHT (IEEE 802.11ac) capabilities
164 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
168 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
172 #define IEEE80211_MODE_INFRA 0
173 #define IEEE80211_MODE_IBSS 1
174 #define IEEE80211_MODE_AP 2
175 #define IEEE80211_MODE_MESH 5
177 #define IEEE80211_CAP_ESS 0x0001
178 #define IEEE80211_CAP_IBSS 0x0002
179 #define IEEE80211_CAP_PRIVACY 0x0010
181 /* DMG (60 GHz) IEEE 802.11ad */
182 /* type - bits 0..1 */
183 #define IEEE80211_CAP_DMG_MASK 0x0003
184 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
185 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
186 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
188 #define WPA_SCAN_QUAL_INVALID BIT(0)
189 #define WPA_SCAN_NOISE_INVALID BIT(1)
190 #define WPA_SCAN_LEVEL_INVALID BIT(2)
191 #define WPA_SCAN_LEVEL_DBM BIT(3)
192 #define WPA_SCAN_AUTHENTICATED BIT(4)
193 #define WPA_SCAN_ASSOCIATED BIT(5)
196 * struct wpa_scan_res - Scan result for an BSS/IBSS
197 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
199 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
200 * @beacon_int: beacon interval in TUs (host byte order)
201 * @caps: capability information field in host byte order
202 * @qual: signal quality
203 * @noise: noise level
204 * @level: signal level
206 * @age: Age of the information in milliseconds (i.e., how many milliseconds
207 * ago the last Beacon or Probe Response frame was received)
208 * @ie_len: length of the following IE field in octets
209 * @beacon_ie_len: length of the following Beacon IE field in octets
211 * This structure is used as a generic format for scan results from the
212 * driver. Each driver interface implementation is responsible for converting
213 * the driver or OS specific scan results into this format.
215 * If the driver does not support reporting all IEs, the IE data structure is
216 * constructed of the IEs that are available. This field will also need to
217 * include SSID in IE format. All drivers are encouraged to be extended to
218 * report all IEs to make it easier to support future additions.
220 struct wpa_scan_res {
232 size_t beacon_ie_len;
234 * Followed by ie_len octets of IEs from Probe Response frame (or if
235 * the driver does not indicate source of IEs, these may also be from
236 * Beacon frame). After the first set of IEs, another set of IEs may
237 * follow (with beacon_ie_len octets of data) if the driver provides
243 * struct wpa_scan_results - Scan results
244 * @res: Array of pointers to allocated variable length scan result entries
245 * @num: Number of entries in the scan result array
246 * @fetch_time: Time when the results were fetched from the driver
248 struct wpa_scan_results {
249 struct wpa_scan_res **res;
251 struct os_reltime fetch_time;
255 * struct wpa_interface_info - Network interface information
256 * @next: Pointer to the next interface or NULL if this is the last one
257 * @ifname: Interface name that can be used with init() or init2()
258 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
260 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
261 * is not an allocated copy, i.e., get_interfaces() caller will not free
264 struct wpa_interface_info {
265 struct wpa_interface_info *next;
268 const char *drv_name;
271 #define WPAS_MAX_SCAN_SSIDS 16
274 * struct wpa_driver_scan_params - Scan parameters
275 * Data for struct wpa_driver_ops::scan2().
277 struct wpa_driver_scan_params {
279 * ssids - SSIDs to scan for
281 struct wpa_driver_scan_ssid {
283 * ssid - specific SSID to scan for (ProbeReq)
284 * %NULL or zero-length SSID is used to indicate active scan
285 * with wildcard SSID.
289 * ssid_len: Length of the SSID in octets
292 } ssids[WPAS_MAX_SCAN_SSIDS];
295 * num_ssids - Number of entries in ssids array
296 * Zero indicates a request for a passive scan.
301 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
306 * extra_ies_len - Length of extra_ies in octets
308 size_t extra_ies_len;
311 * freqs - Array of frequencies to scan or %NULL for all frequencies
313 * The frequency is set in MHz. The array is zero-terminated.
318 * filter_ssids - Filter for reporting SSIDs
320 * This optional parameter can be used to request the driver wrapper to
321 * filter scan results to include only the specified SSIDs. %NULL
322 * indicates that no filtering is to be done. This can be used to
323 * reduce memory needs for scan results in environments that have large
324 * number of APs with different SSIDs.
326 * The driver wrapper is allowed to take this allocated buffer into its
327 * own use by setting the pointer to %NULL. In that case, the driver
328 * wrapper is responsible for freeing the buffer with os_free() once it
329 * is not needed anymore.
331 struct wpa_driver_scan_filter {
337 * num_filter_ssids - Number of entries in filter_ssids array
339 size_t num_filter_ssids;
342 * filter_rssi - Filter by RSSI
344 * The driver may filter scan results in firmware to reduce host
345 * wakeups and thereby save power. Specify the RSSI threshold in s32
351 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
353 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
354 * Mbps from the support rates element(s) in the Probe Request frames
355 * and not to transmit the frames at any of those rates.
357 unsigned int p2p_probe:1;
360 * only_new_results - Request driver to report only new results
362 * This is used to request the driver to report only BSSes that have
363 * been detected after this scan request has been started, i.e., to
364 * flush old cached BSS entries.
366 unsigned int only_new_results:1;
369 * low_priority - Requests driver to use a lower scan priority
371 * This is used to request the driver to use a lower scan priority
372 * if it supports such a thing.
374 unsigned int low_priority:1;
377 * NOTE: Whenever adding new parameters here, please make sure
378 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
384 * struct wpa_driver_auth_params - Authentication parameters
385 * Data for struct wpa_driver_ops::authenticate().
387 struct wpa_driver_auth_params {
395 const u8 *wep_key[4];
396 size_t wep_key_len[4];
398 int local_state_change;
401 * p2p - Whether this connection is a P2P group
411 WPS_MODE_NONE /* no WPS provisioning being used */,
412 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
413 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
417 struct hostapd_freq_params {
423 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
424 * secondary channel below primary, 1 = HT40
425 * enabled, secondary channel above primary */
430 /* valid for both HT and VHT, center_freq2 is non-zero
431 * only for bandwidth 80 and an 80+80 channel */
432 int center_freq1, center_freq2;
437 * struct wpa_driver_associate_params - Association parameters
438 * Data for struct wpa_driver_ops::associate().
440 struct wpa_driver_associate_params {
442 * bssid - BSSID of the selected AP
443 * This can be %NULL, if ap_scan=2 mode is used and the driver is
444 * responsible for selecting with which BSS to associate. */
448 * bssid_hint - BSSID of a proposed AP
450 * This indicates which BSS has been found a suitable candidate for
451 * initial association for drivers that use driver/firmwate-based BSS
452 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
453 * the driver from selecting other BSSes in the ESS.
455 const u8 *bssid_hint;
458 * ssid - The selected SSID
463 * ssid_len - Length of the SSID (1..32)
468 * freq - channel parameters
470 struct hostapd_freq_params freq;
473 * freq_hint - Frequency of the channel the proposed AP is using
475 * This provides a channel on which a suitable BSS has been found as a
476 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
477 * limit the driver from selecting other channels for
478 * driver/firmware-based BSS selection.
483 * bg_scan_period - Background scan period in seconds, 0 to disable
484 * background scan, or -1 to indicate no change to default driver
490 * beacon_int - Beacon interval for IBSS or 0 to use driver default
495 * wpa_ie - WPA information element for (Re)Association Request
496 * WPA information element to be included in (Re)Association
497 * Request (including information element id and length). Use
498 * of this WPA IE is optional. If the driver generates the WPA
499 * IE, it can use pairwise_suite, group_suite, and
500 * key_mgmt_suite to select proper algorithms. In this case,
501 * the driver has to notify wpa_supplicant about the used WPA
502 * IE by generating an event that the interface code will
503 * convert into EVENT_ASSOCINFO data (see below).
505 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
506 * instead. The driver can determine which version is used by
507 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
510 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
515 * wpa_ie_len - length of the wpa_ie
520 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
522 unsigned int wpa_proto;
525 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
527 * This is usually ignored if @wpa_ie is used.
529 unsigned int pairwise_suite;
532 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
534 * This is usually ignored if @wpa_ie is used.
536 unsigned int group_suite;
539 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
541 * This is usually ignored if @wpa_ie is used.
543 unsigned int key_mgmt_suite;
546 * auth_alg - Allowed authentication algorithms
547 * Bit field of WPA_AUTH_ALG_*
552 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
557 * wep_key - WEP keys for static WEP configuration
559 const u8 *wep_key[4];
562 * wep_key_len - WEP key length for static WEP configuration
564 size_t wep_key_len[4];
567 * wep_tx_keyidx - WEP TX key index for static WEP configuration
572 * mgmt_frame_protection - IEEE 802.11w management frame protection
574 enum mfp_options mgmt_frame_protection;
577 * ft_ies - IEEE 802.11r / FT information elements
578 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
579 * for fast transition, this parameter is set to include the IEs that
580 * are to be sent in the next FT Authentication Request message.
581 * update_ft_ies() handler is called to update the IEs for further
582 * FT messages in the sequence.
584 * The driver should use these IEs only if the target AP is advertising
585 * the same mobility domain as the one included in the MDIE here.
587 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
588 * AP after the initial association. These IEs can only be used if the
589 * target AP is advertising support for FT and is using the same MDIE
590 * and SSID as the current AP.
592 * The driver is responsible for reporting the FT IEs received from the
593 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
594 * type. update_ft_ies() handler will then be called with the FT IEs to
595 * include in the next frame in the authentication sequence.
600 * ft_ies_len - Length of ft_ies in bytes
605 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
607 * This value is provided to allow the driver interface easier access
608 * to the current mobility domain. This value is set to %NULL if no
609 * mobility domain is currently active.
614 * passphrase - RSN passphrase for PSK
616 * This value is made available only for WPA/WPA2-Personal (PSK) and
617 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
618 * the 8..63 character ASCII passphrase, if available. Please note that
619 * this can be %NULL if passphrase was not used to generate the PSK. In
620 * that case, the psk field must be used to fetch the PSK.
622 const char *passphrase;
625 * psk - RSN PSK (alternative for passphrase for PSK)
627 * This value is made available only for WPA/WPA2-Personal (PSK) and
628 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
629 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
630 * be prepared to handle %NULL value as an error.
635 * drop_unencrypted - Enable/disable unencrypted frame filtering
637 * Configure the driver to drop all non-EAPOL frames (both receive and
638 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
639 * still be allowed for key negotiation.
641 int drop_unencrypted;
644 * prev_bssid - Previously used BSSID in this ESS
646 * When not %NULL, this is a request to use reassociation instead of
649 const u8 *prev_bssid;
654 * If the driver needs to do special configuration for WPS association,
655 * this variable provides more information on what type of association
656 * is being requested. Most drivers should not need ot use this.
661 * p2p - Whether this connection is a P2P group
666 * uapsd - UAPSD parameters for the network
667 * -1 = do not change defaults
668 * AP mode: 1 = enabled, 0 = disabled
669 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
674 * fixed_bssid - Whether to force this BSSID in IBSS mode
675 * 1 = Fix this BSSID and prevent merges.
676 * 0 = Do not fix BSSID.
681 * disable_ht - Disable HT (IEEE 802.11n) for this connection
686 * HT Capabilities over-rides. Only bits set in the mask will be used,
687 * and not all values are used by the kernel anyway. Currently, MCS,
688 * MPDU and MSDU fields are used.
690 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */
691 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */
693 #ifdef CONFIG_VHT_OVERRIDES
695 * disable_vht - Disable VHT for this connection
700 * VHT capability overrides.
702 const struct ieee80211_vht_capabilities *vhtcaps;
703 const struct ieee80211_vht_capabilities *vhtcaps_mask;
704 #endif /* CONFIG_VHT_OVERRIDES */
707 * req_key_mgmt_offload - Request key management offload for connection
709 * Request key management offload for this connection if the device
712 int req_key_mgmt_offload;
717 HIDDEN_SSID_ZERO_LEN,
718 HIDDEN_SSID_ZERO_CONTENTS
721 struct wowlan_triggers {
725 u8 gtk_rekey_failure;
727 u8 four_way_handshake;
731 struct wpa_driver_ap_params {
733 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
738 * head_len - Length of the head buffer in octets
743 * tail - Beacon tail following TIM IE
748 * tail_len - Length of the tail buffer in octets
753 * dtim_period - DTIM period
758 * beacon_int - Beacon interval
763 * basic_rates: -1 terminated array of basic rates in 100 kbps
765 * This parameter can be used to set a specific basic rate set for the
766 * BSS. If %NULL, default basic rate set is used.
771 * proberesp - Probe Response template
773 * This is used by drivers that reply to Probe Requests internally in
774 * AP mode and require the full Probe Response template.
779 * proberesp_len - Length of the proberesp buffer in octets
781 size_t proberesp_len;
784 * ssid - The SSID to use in Beacon/Probe Response frames
789 * ssid_len - Length of the SSID (1..32)
794 * hide_ssid - Whether to hide the SSID
796 enum hide_ssid hide_ssid;
799 * pairwise_ciphers - WPA_CIPHER_* bitfield
801 unsigned int pairwise_ciphers;
804 * group_cipher - WPA_CIPHER_*
806 unsigned int group_cipher;
809 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
811 unsigned int key_mgmt_suites;
814 * auth_algs - WPA_AUTH_ALG_* bitfield
816 unsigned int auth_algs;
819 * wpa_version - WPA_PROTO_* bitfield
821 unsigned int wpa_version;
824 * privacy - Whether privacy is used in the BSS
829 * beacon_ies - WPS/P2P IE(s) for Beacon frames
831 * This is used to add IEs like WPS IE and P2P IE by drivers that do
832 * not use the full Beacon template.
834 const struct wpabuf *beacon_ies;
837 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
839 * This is used to add IEs like WPS IE and P2P IE by drivers that
840 * reply to Probe Request frames internally.
842 const struct wpabuf *proberesp_ies;
845 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
847 * This is used to add IEs like WPS IE by drivers that reply to
848 * (Re)Association Request frames internally.
850 const struct wpabuf *assocresp_ies;
853 * isolate - Whether to isolate frames between associated stations
855 * If this is non-zero, the AP is requested to disable forwarding of
856 * frames between associated stations.
861 * cts_protect - Whether CTS protection is enabled
866 * preamble - Whether short preamble is enabled
871 * short_slot_time - Whether short slot time is enabled
873 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
874 * not set (e.g., when 802.11g mode is not in use)
879 * ht_opmode - HT operation mode or -1 if HT not in use
884 * interworking - Whether Interworking is enabled
889 * hessid - Homogeneous ESS identifier or %NULL if not set
894 * access_network_type - Access Network Type (0..15)
896 * This is used for filtering Probe Request frames when Interworking is
899 u8 access_network_type;
902 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
904 * This is used by driver which advertises this capability.
906 int ap_max_inactivity;
909 * smps_mode - SMPS mode
911 * SMPS mode to be used by the AP, specified as the relevant bits of
912 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
914 unsigned int smps_mode;
917 * disable_dgaf - Whether group-addressed frames are disabled
922 * osen - Whether OSEN security is enabled
927 * freq - Channel parameters for dynamic bandwidth changes
929 struct hostapd_freq_params *freq;
932 struct wpa_driver_mesh_bss_params {
933 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
935 * TODO: Other mesh configuration parameters would go here.
936 * See NL80211_MESHCONF_* for all the mesh config parameters.
941 struct wpa_driver_mesh_join_params {
944 const int *basic_rates;
948 enum ht_mode ht_mode;
949 struct wpa_driver_mesh_bss_params conf;
950 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
951 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
952 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
953 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
958 * struct wpa_driver_capa - Driver capability information
960 struct wpa_driver_capa {
961 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
962 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
963 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
964 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
965 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
966 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
967 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
968 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
969 unsigned int key_mgmt;
971 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
972 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
973 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
974 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
975 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
976 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
977 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
978 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
979 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
980 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
981 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
982 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
983 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
986 #define WPA_DRIVER_AUTH_OPEN 0x00000001
987 #define WPA_DRIVER_AUTH_SHARED 0x00000002
988 #define WPA_DRIVER_AUTH_LEAP 0x00000004
991 /* Driver generated WPA/RSN IE */
992 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
993 /* Driver needs static WEP key setup after association command */
994 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
995 /* Driver takes care of all DFS operations */
996 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
997 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
998 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
999 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1000 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1001 /* Driver provides separate commands for authentication and association (SME in
1002 * wpa_supplicant). */
1003 #define WPA_DRIVER_FLAGS_SME 0x00000020
1004 /* Driver supports AP mode */
1005 #define WPA_DRIVER_FLAGS_AP 0x00000040
1006 /* Driver needs static WEP key setup after association has been completed */
1007 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1008 /* Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1009 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1010 /* Driver supports concurrent P2P operations */
1011 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1013 * Driver uses the initial interface as a dedicated management interface, i.e.,
1014 * it cannot be used for P2P group operations or non-P2P purposes.
1016 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1017 /* This interface is P2P capable (P2P GO or P2P Client) */
1018 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1019 /* Driver supports station and key removal when stopping an AP */
1020 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1022 * Driver uses the initial interface for P2P management interface and non-P2P
1023 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1024 * P2P group operations.
1026 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1028 * Driver is known to use sane error codes, i.e., when it indicates that
1029 * something (e.g., association) fails, there was indeed a failure and the
1030 * operation does not end up getting completed successfully later.
1032 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1033 /* Driver supports off-channel TX */
1034 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1035 /* Driver indicates TX status events for EAPOL Data frames */
1036 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1037 /* Driver indicates TX status events for Deauth/Disassoc frames */
1038 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1039 /* Driver supports roaming (BSS selection) in firmware */
1040 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1041 /* Driver supports operating as a TDLS peer */
1042 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1043 /* Driver requires external TDLS setup/teardown/discovery */
1044 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1045 /* Driver indicates support for Probe Response offloading in AP mode */
1046 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1047 /* Driver supports U-APSD in AP mode */
1048 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1049 /* Driver supports inactivity timer in AP mode */
1050 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1051 /* Driver expects user space implementation of MLME in AP mode */
1052 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1053 /* Driver supports SAE with user space SME */
1054 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1055 /* Driver makes use of OBSS scan mechanism in wpa_supplicant */
1056 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1057 /* Driver supports IBSS (Ad-hoc) mode */
1058 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1059 /* Driver supports radar detection */
1060 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1061 /* Driver supports a dedicated interface for P2P Device */
1062 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1063 /* Driver supports QoS Mapping */
1064 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1065 /* Driver supports CSA in AP mode */
1066 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1067 /* Driver supports mesh */
1068 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1071 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1072 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1073 unsigned int smps_modes;
1076 int max_sched_scan_ssids;
1077 int sched_scan_supported;
1081 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1083 unsigned int max_remain_on_chan;
1086 * max_stations - Maximum number of associated stations the driver
1087 * supports in AP mode
1089 unsigned int max_stations;
1092 * probe_resp_offloads - Bitmap of supported protocols by the driver
1093 * for Probe Response offloading.
1095 /* Driver Probe Response offloading support for WPS ver. 1 */
1096 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1097 /* Driver Probe Response offloading support for WPS ver. 2 */
1098 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1099 /* Driver Probe Response offloading support for P2P */
1100 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1101 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1102 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1103 unsigned int probe_resp_offloads;
1105 unsigned int max_acl_mac_addrs;
1108 * Number of supported concurrent channels
1110 unsigned int num_multichan_concurrent;
1113 * extended_capa - extended capabilities in driver/device
1115 * Must be allocated and freed by driver and the pointers must be
1116 * valid for the lifetime of the driver, i.e., freed in deinit()
1118 const u8 *extended_capa, *extended_capa_mask;
1119 unsigned int extended_capa_len;
1121 struct wowlan_triggers wowlan_triggers;
1125 struct hostapd_data;
1127 struct hostap_sta_driver_data {
1128 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1129 unsigned long current_tx_rate;
1130 unsigned long inactive_msec;
1131 unsigned long flags;
1132 unsigned long num_ps_buf_frames;
1133 unsigned long tx_retry_failed;
1134 unsigned long tx_retry_count;
1139 struct hostapd_sta_add_params {
1143 const u8 *supp_rates;
1144 size_t supp_rates_len;
1145 u16 listen_interval;
1146 const struct ieee80211_ht_capabilities *ht_capabilities;
1147 const struct ieee80211_vht_capabilities *vht_capabilities;
1148 int vht_opmode_enabled;
1150 u32 flags; /* bitmask of WPA_STA_* flags */
1151 u32 flags_mask; /* unset bits in flags */
1153 enum mesh_plink_state plink_state;
1154 #endif /* CONFIG_MESH */
1155 int set; /* Set STA parameters instead of add */
1157 const u8 *ext_capab;
1158 size_t ext_capab_len;
1159 const u8 *supp_channels;
1160 size_t supp_channels_len;
1161 const u8 *supp_oper_classes;
1162 size_t supp_oper_classes_len;
1165 struct mac_address {
1169 struct hostapd_acl_params {
1171 unsigned int num_mac_acl;
1172 struct mac_address mac_acl[0];
1175 enum wpa_driver_if_type {
1177 * WPA_IF_STATION - Station mode interface
1182 * WPA_IF_AP_VLAN - AP mode VLAN interface
1184 * This interface shares its address and Beacon frame with the main
1190 * WPA_IF_AP_BSS - AP mode BSS interface
1192 * This interface has its own address and Beacon frame.
1197 * WPA_IF_P2P_GO - P2P Group Owner
1202 * WPA_IF_P2P_CLIENT - P2P Client
1207 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1208 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1213 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1214 * abstracted P2P Device function in the driver
1219 struct wpa_init_params {
1225 const char *test_socket;
1226 int use_pae_group_addr;
1230 u8 *own_addr; /* buffer for writing own MAC address */
1234 struct wpa_bss_params {
1235 /** Interface name (for multi-SSID/VLAN support) */
1237 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1246 enum mfp_options ieee80211w;
1249 #define WPA_STA_AUTHORIZED BIT(0)
1250 #define WPA_STA_WMM BIT(1)
1251 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1252 #define WPA_STA_MFP BIT(3)
1253 #define WPA_STA_TDLS_PEER BIT(4)
1254 #define WPA_STA_AUTHENTICATED BIT(5)
1267 WNM_SLEEP_ENTER_CONFIRM,
1268 WNM_SLEEP_ENTER_FAIL,
1269 WNM_SLEEP_EXIT_CONFIRM,
1270 WNM_SLEEP_EXIT_FAIL,
1271 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1272 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1273 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1275 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1277 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1278 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1280 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1283 /* enum chan_width - Channel width definitions */
1295 * struct wpa_signal_info - Information about channel signal quality
1297 struct wpa_signal_info {
1299 int above_threshold;
1304 enum chan_width chanwidth;
1310 * struct beacon_data - Beacon data
1311 * @head: Head portion of Beacon frame (before TIM IE)
1312 * @tail: Tail portion of Beacon frame (after TIM IE)
1313 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1314 * @proberesp_ies: Extra information element(s) to add into Probe Response
1316 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1317 * Response frames or %NULL
1318 * @probe_resp: Probe Response frame template
1319 * @head_len: Length of @head
1320 * @tail_len: Length of @tail
1321 * @beacon_ies_len: Length of beacon_ies in octets
1322 * @proberesp_ies_len: Length of proberesp_ies in octets
1323 * @proberesp_ies_len: Length of proberesp_ies in octets
1324 * @probe_resp_len: Length of probe response template (@probe_resp)
1326 struct beacon_data {
1333 size_t head_len, tail_len;
1334 size_t beacon_ies_len;
1335 size_t proberesp_ies_len;
1336 size_t assocresp_ies_len;
1337 size_t probe_resp_len;
1341 * struct csa_settings - Settings for channel switch command
1342 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1343 * @block_tx: 1 - block transmission for CSA period
1344 * @freq_params: Next channel frequency parameter
1345 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1346 * @beacon_after: Next beacon/probe resp/asooc resp info
1347 * @counter_offset_beacon: Offset to the count field in beacon's tail
1348 * @counter_offset_presp: Offset to the count field in probe resp.
1350 struct csa_settings {
1354 struct hostapd_freq_params freq_params;
1355 struct beacon_data beacon_csa;
1356 struct beacon_data beacon_after;
1358 u16 counter_offset_beacon;
1359 u16 counter_offset_presp;
1362 /* TDLS peer capabilities for send_tdls_mgmt() */
1363 enum tdls_peer_capability {
1364 TDLS_PEER_HT = BIT(0),
1365 TDLS_PEER_VHT = BIT(1),
1366 TDLS_PEER_WMM = BIT(2),
1369 /* valid info in the wmm_params struct */
1370 enum wmm_params_valid_info {
1371 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1375 * struct wmm_params - WMM parameterss configured for this association
1376 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1377 * of the struct contain valid information.
1378 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1379 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1386 #ifdef CONFIG_MACSEC
1387 struct macsec_init_params {
1388 Boolean always_include_sci;
1392 #endif /* CONFIG_MACSEC */
1394 enum drv_br_port_attr {
1395 DRV_BR_PORT_ATTR_PROXYARP,
1396 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1399 enum drv_br_net_param {
1400 DRV_BR_NET_PARAM_GARP_ACCEPT,
1405 * struct wpa_driver_ops - Driver interface API definition
1407 * This structure defines the API that each driver interface needs to implement
1408 * for core wpa_supplicant code. All driver specific functionality is captured
1411 struct wpa_driver_ops {
1412 /** Name of the driver interface */
1414 /** One line description of the driver interface */
1418 * get_bssid - Get the current BSSID
1419 * @priv: private driver interface data
1420 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1422 * Returns: 0 on success, -1 on failure
1424 * Query kernel driver for the current BSSID and copy it to bssid.
1425 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1428 int (*get_bssid)(void *priv, u8 *bssid);
1431 * get_ssid - Get the current SSID
1432 * @priv: private driver interface data
1433 * @ssid: buffer for SSID (at least 32 bytes)
1435 * Returns: Length of the SSID on success, -1 on failure
1437 * Query kernel driver for the current SSID and copy it to ssid.
1438 * Returning zero is recommended if the STA is not associated.
1440 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1441 * can, at least in theory, contain control characters (including nul)
1442 * and as such, should be processed as binary data, not a printable
1445 int (*get_ssid)(void *priv, u8 *ssid);
1448 * set_key - Configure encryption key
1449 * @ifname: Interface name (for multi-SSID/VLAN support)
1450 * @priv: private driver interface data
1451 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1452 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1453 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1454 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1455 * %WPA_ALG_BIP_CMAC_256);
1456 * %WPA_ALG_NONE clears the key.
1457 * @addr: Address of the peer STA (BSSID of the current AP when setting
1458 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1459 * broadcast keys, %NULL for default keys that are used both for
1460 * broadcast and unicast; when clearing keys, %NULL is used to
1461 * indicate that both the broadcast-only and default key of the
1462 * specified key index is to be cleared
1463 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1465 * @set_tx: configure this key as the default Tx key (only used when
1466 * driver does not support separate unicast/individual key
1467 * @seq: sequence number/packet number, seq_len octets, the next
1468 * packet number to be used for in replay protection; configured
1469 * for Rx keys (in most cases, this is only used with broadcast
1470 * keys and set to zero for unicast keys); %NULL if not set
1471 * @seq_len: length of the seq, depends on the algorithm:
1472 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1473 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1475 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1476 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1478 * Returns: 0 on success, -1 on failure
1480 * Configure the given key for the kernel driver. If the driver
1481 * supports separate individual keys (4 default keys + 1 individual),
1482 * addr can be used to determine whether the key is default or
1483 * individual. If only 4 keys are supported, the default key with key
1484 * index 0 is used as the individual key. STA must be configured to use
1485 * it as the default Tx key (set_tx is set) and accept Rx for all the
1486 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1487 * broadcast keys, so key index 0 is available for this kind of
1490 * Please note that TKIP keys include separate TX and RX MIC keys and
1491 * some drivers may expect them in different order than wpa_supplicant
1492 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1493 * will trigger Michael MIC errors. This can be fixed by changing the
1494 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1495 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1496 * example on how this can be done.
1498 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1499 const u8 *addr, int key_idx, int set_tx,
1500 const u8 *seq, size_t seq_len,
1501 const u8 *key, size_t key_len);
1504 * init - Initialize driver interface
1505 * @ctx: context to be used when calling wpa_supplicant functions,
1506 * e.g., wpa_supplicant_event()
1507 * @ifname: interface name, e.g., wlan0
1509 * Returns: Pointer to private data, %NULL on failure
1511 * Initialize driver interface, including event processing for kernel
1512 * driver events (e.g., associated, scan results, Michael MIC failure).
1513 * This function can allocate a private configuration data area for
1514 * @ctx, file descriptor, interface name, etc. information that may be
1515 * needed in future driver operations. If this is not used, non-NULL
1516 * value will need to be returned because %NULL is used to indicate
1517 * failure. The returned value will be used as 'void *priv' data for
1518 * all other driver_ops functions.
1520 * The main event loop (eloop.c) of wpa_supplicant can be used to
1521 * register callback for read sockets (eloop_register_read_sock()).
1523 * See below for more information about events and
1524 * wpa_supplicant_event() function.
1526 void * (*init)(void *ctx, const char *ifname);
1529 * deinit - Deinitialize driver interface
1530 * @priv: private driver interface data from init()
1532 * Shut down driver interface and processing of driver events. Free
1533 * private data buffer if one was allocated in init() handler.
1535 void (*deinit)(void *priv);
1538 * set_param - Set driver configuration parameters
1539 * @priv: private driver interface data from init()
1540 * @param: driver specific configuration parameters
1542 * Returns: 0 on success, -1 on failure
1544 * Optional handler for notifying driver interface about configuration
1545 * parameters (driver_param).
1547 int (*set_param)(void *priv, const char *param);
1550 * set_countermeasures - Enable/disable TKIP countermeasures
1551 * @priv: private driver interface data
1552 * @enabled: 1 = countermeasures enabled, 0 = disabled
1554 * Returns: 0 on success, -1 on failure
1556 * Configure TKIP countermeasures. When these are enabled, the driver
1557 * should drop all received and queued frames that are using TKIP.
1559 int (*set_countermeasures)(void *priv, int enabled);
1562 * deauthenticate - Request driver to deauthenticate
1563 * @priv: private driver interface data
1564 * @addr: peer address (BSSID of the AP)
1565 * @reason_code: 16-bit reason code to be sent in the deauthentication
1568 * Returns: 0 on success, -1 on failure
1570 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1573 * associate - Request driver to associate
1574 * @priv: private driver interface data
1575 * @params: association parameters
1577 * Returns: 0 on success, -1 on failure
1579 int (*associate)(void *priv,
1580 struct wpa_driver_associate_params *params);
1583 * add_pmkid - Add PMKSA cache entry to the driver
1584 * @priv: private driver interface data
1585 * @bssid: BSSID for the PMKSA cache entry
1586 * @pmkid: PMKID for the PMKSA cache entry
1588 * Returns: 0 on success, -1 on failure
1590 * This function is called when a new PMK is received, as a result of
1591 * either normal authentication or RSN pre-authentication.
1593 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1594 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1595 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1596 * driver_ops function does not need to be implemented. Likewise, if
1597 * the driver does not support WPA, this function is not needed.
1599 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1602 * remove_pmkid - Remove PMKSA cache entry to the driver
1603 * @priv: private driver interface data
1604 * @bssid: BSSID for the PMKSA cache entry
1605 * @pmkid: PMKID for the PMKSA cache entry
1607 * Returns: 0 on success, -1 on failure
1609 * This function is called when the supplicant drops a PMKSA cache
1610 * entry for any reason.
1612 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1613 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1614 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1615 * from wpa_supplicant, this driver_ops function does not need to be
1616 * implemented. Likewise, if the driver does not support WPA, this
1617 * function is not needed.
1619 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1622 * flush_pmkid - Flush PMKSA cache
1623 * @priv: private driver interface data
1625 * Returns: 0 on success, -1 on failure
1627 * This function is called when the supplicant drops all PMKSA cache
1628 * entries for any reason.
1630 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1631 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1632 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1633 * from wpa_supplicant, this driver_ops function does not need to be
1634 * implemented. Likewise, if the driver does not support WPA, this
1635 * function is not needed.
1637 int (*flush_pmkid)(void *priv);
1640 * get_capa - Get driver capabilities
1641 * @priv: private driver interface data
1643 * Returns: 0 on success, -1 on failure
1645 * Get driver/firmware/hardware capabilities.
1647 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1650 * poll - Poll driver for association information
1651 * @priv: private driver interface data
1653 * This is an option callback that can be used when the driver does not
1654 * provide event mechanism for association events. This is called when
1655 * receiving WPA EAPOL-Key messages that require association
1656 * information. The driver interface is supposed to generate associnfo
1657 * event before returning from this callback function. In addition, the
1658 * driver interface should generate an association event after having
1659 * sent out associnfo.
1661 void (*poll)(void *priv);
1664 * get_ifname - Get interface name
1665 * @priv: private driver interface data
1667 * Returns: Pointer to the interface name. This can differ from the
1668 * interface name used in init() call. Init() is called first.
1670 * This optional function can be used to allow the driver interface to
1671 * replace the interface name with something else, e.g., based on an
1672 * interface mapping from a more descriptive name.
1674 const char * (*get_ifname)(void *priv);
1677 * get_mac_addr - Get own MAC address
1678 * @priv: private driver interface data
1680 * Returns: Pointer to own MAC address or %NULL on failure
1682 * This optional function can be used to get the own MAC address of the
1683 * device from the driver interface code. This is only needed if the
1684 * l2_packet implementation for the OS does not provide easy access to
1686 const u8 * (*get_mac_addr)(void *priv);
1689 * send_eapol - Optional function for sending EAPOL packets
1690 * @priv: private driver interface data
1691 * @dest: Destination MAC address
1693 * @data: EAPOL packet starting with IEEE 802.1X header
1694 * @data_len: Size of the EAPOL packet
1696 * Returns: 0 on success, -1 on failure
1698 * This optional function can be used to override l2_packet operations
1699 * with driver specific functionality. If this function pointer is set,
1700 * l2_packet module is not used at all and the driver interface code is
1701 * responsible for receiving and sending all EAPOL packets. The
1702 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1703 * event. The driver interface is required to implement get_mac_addr()
1704 * handler if send_eapol() is used.
1706 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1707 const u8 *data, size_t data_len);
1710 * set_operstate - Sets device operating state to DORMANT or UP
1711 * @priv: private driver interface data
1712 * @state: 0 = dormant, 1 = up
1713 * Returns: 0 on success, -1 on failure
1715 * This is an optional function that can be used on operating systems
1716 * that support a concept of controlling network device state from user
1717 * space applications. This function, if set, gets called with
1718 * state = 1 when authentication has been completed and with state = 0
1719 * when connection is lost.
1721 int (*set_operstate)(void *priv, int state);
1724 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1725 * @priv: Private driver interface data
1726 * @addr: Address of the station for which to set protection (may be
1727 * %NULL for group keys)
1728 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1729 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1730 * Returns: 0 on success, -1 on failure
1732 * This is an optional function that can be used to set the driver to
1733 * require protection for Tx and/or Rx frames. This uses the layer
1734 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1735 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1736 * set protection operation; instead, they set protection implicitly
1737 * based on configured keys.
1739 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1743 * get_hw_feature_data - Get hardware support data (channels and rates)
1744 * @priv: Private driver interface data
1745 * @num_modes: Variable for returning the number of returned modes
1746 * flags: Variable for returning hardware feature flags
1747 * Returns: Pointer to allocated hardware data on success or %NULL on
1748 * failure. Caller is responsible for freeing this.
1750 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1755 * send_mlme - Send management frame from MLME
1756 * @priv: Private driver interface data
1757 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1758 * @data_len: Size of the management frame
1759 * @noack: Do not wait for this frame to be acked (disable retries)
1760 * Returns: 0 on success, -1 on failure
1762 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1766 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1767 * @priv: Private driver interface data
1768 * @md: Mobility domain (2 octets) (also included inside ies)
1769 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1770 * @ies_len: Length of FT IEs in bytes
1771 * Returns: 0 on success, -1 on failure
1773 * The supplicant uses this callback to let the driver know that keying
1774 * material for FT is available and that the driver can use the
1775 * provided IEs in the next message in FT authentication sequence.
1777 * This function is only needed for driver that support IEEE 802.11r
1778 * (Fast BSS Transition).
1780 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1784 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1785 * @priv: Private driver interface data
1786 * @action: Action field value
1787 * @target_ap: Target AP address
1788 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1789 * @ies_len: Length of FT IEs in bytes
1790 * Returns: 0 on success, -1 on failure
1792 * The supplicant uses this callback to request the driver to transmit
1793 * an FT Action frame (action category 6) for over-the-DS fast BSS
1796 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1797 const u8 *ies, size_t ies_len);
1800 * get_scan_results2 - Fetch the latest scan results
1801 * @priv: private driver interface data
1803 * Returns: Allocated buffer of scan results (caller is responsible for
1804 * freeing the data structure) on success, NULL on failure
1806 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1809 * set_country - Set country
1810 * @priv: Private driver interface data
1811 * @alpha2: country to which to switch to
1812 * Returns: 0 on success, -1 on failure
1814 * This function is for drivers which support some form
1815 * of setting a regulatory domain.
1817 int (*set_country)(void *priv, const char *alpha2);
1820 * get_country - Get country
1821 * @priv: Private driver interface data
1822 * @alpha2: Buffer for returning country code (at least 3 octets)
1823 * Returns: 0 on success, -1 on failure
1825 int (*get_country)(void *priv, char *alpha2);
1828 * global_init - Global driver initialization
1829 * Returns: Pointer to private data (global), %NULL on failure
1831 * This optional function is called to initialize the driver wrapper
1832 * for global data, i.e., data that applies to all interfaces. If this
1833 * function is implemented, global_deinit() will also need to be
1834 * implemented to free the private data. The driver will also likely
1835 * use init2() function instead of init() to get the pointer to global
1836 * data available to per-interface initializer.
1838 void * (*global_init)(void);
1841 * global_deinit - Global driver deinitialization
1842 * @priv: private driver global data from global_init()
1844 * Terminate any global driver related functionality and free the
1845 * global data structure.
1847 void (*global_deinit)(void *priv);
1850 * init2 - Initialize driver interface (with global data)
1851 * @ctx: context to be used when calling wpa_supplicant functions,
1852 * e.g., wpa_supplicant_event()
1853 * @ifname: interface name, e.g., wlan0
1854 * @global_priv: private driver global data from global_init()
1855 * Returns: Pointer to private data, %NULL on failure
1857 * This function can be used instead of init() if the driver wrapper
1860 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1863 * get_interfaces - Get information about available interfaces
1864 * @global_priv: private driver global data from global_init()
1865 * Returns: Allocated buffer of interface information (caller is
1866 * responsible for freeing the data structure) on success, NULL on
1869 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1872 * scan2 - Request the driver to initiate scan
1873 * @priv: private driver interface data
1874 * @params: Scan parameters
1876 * Returns: 0 on success, -1 on failure
1878 * Once the scan results are ready, the driver should report scan
1879 * results event for wpa_supplicant which will eventually request the
1880 * results with wpa_driver_get_scan_results2().
1882 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1885 * authenticate - Request driver to authenticate
1886 * @priv: private driver interface data
1887 * @params: authentication parameters
1888 * Returns: 0 on success, -1 on failure
1890 * This is an optional function that can be used with drivers that
1891 * support separate authentication and association steps, i.e., when
1892 * wpa_supplicant can act as the SME. If not implemented, associate()
1893 * function is expected to take care of IEEE 802.11 authentication,
1896 int (*authenticate)(void *priv,
1897 struct wpa_driver_auth_params *params);
1900 * set_ap - Set Beacon and Probe Response information for AP mode
1901 * @priv: Private driver interface data
1902 * @params: Parameters to use in AP mode
1904 * This function is used to configure Beacon template and/or extra IEs
1905 * to add for Beacon and Probe Response frames for the driver in
1906 * AP mode. The driver is responsible for building the full Beacon
1907 * frame by concatenating the head part with TIM IE generated by the
1908 * driver/firmware and finishing with the tail part. Depending on the
1909 * driver architectue, this can be done either by using the full
1910 * template or the set of additional IEs (e.g., WPS and P2P IE).
1911 * Similarly, Probe Response processing depends on the driver design.
1912 * If the driver (or firmware) takes care of replying to Probe Request
1913 * frames, the extra IEs provided here needs to be added to the Probe
1916 * Returns: 0 on success, -1 on failure
1918 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1921 * set_acl - Set ACL in AP mode
1922 * @priv: Private driver interface data
1923 * @params: Parameters to configure ACL
1924 * Returns: 0 on success, -1 on failure
1926 * This is used only for the drivers which support MAC address ACL.
1928 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1931 * hapd_init - Initialize driver interface (hostapd only)
1932 * @hapd: Pointer to hostapd context
1933 * @params: Configuration for the driver wrapper
1934 * Returns: Pointer to private data, %NULL on failure
1936 * This function is used instead of init() or init2() when the driver
1937 * wrapper is used with hostapd.
1939 void * (*hapd_init)(struct hostapd_data *hapd,
1940 struct wpa_init_params *params);
1943 * hapd_deinit - Deinitialize driver interface (hostapd only)
1944 * @priv: Private driver interface data from hapd_init()
1946 void (*hapd_deinit)(void *priv);
1949 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1950 * @priv: Private driver interface data
1951 * @params: BSS parameters
1952 * Returns: 0 on success, -1 on failure
1954 * This is an optional function to configure the kernel driver to
1955 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1956 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1957 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1958 * for Beacon frames.
1960 * DEPRECATED - use set_ap() instead
1962 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1965 * set_privacy - Enable/disable privacy (AP only)
1966 * @priv: Private driver interface data
1967 * @enabled: 1 = privacy enabled, 0 = disabled
1968 * Returns: 0 on success, -1 on failure
1970 * This is an optional function to configure privacy field in the
1971 * kernel driver for Beacon frames. This can be left undefined (set to
1972 * %NULL) if the driver uses the Beacon template from set_ap().
1974 * DEPRECATED - use set_ap() instead
1976 int (*set_privacy)(void *priv, int enabled);
1979 * get_seqnum - Fetch the current TSC/packet number (AP only)
1980 * @ifname: The interface name (main or virtual)
1981 * @priv: Private driver interface data
1982 * @addr: MAC address of the station or %NULL for group keys
1984 * @seq: Buffer for returning the latest used TSC/packet number
1985 * Returns: 0 on success, -1 on failure
1987 * This function is used to fetch the last used TSC/packet number for
1988 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1989 * keys, so there is no strict requirement on implementing support for
1990 * unicast keys (i.e., addr != %NULL).
1992 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1996 * flush - Flush all association stations (AP only)
1997 * @priv: Private driver interface data
1998 * Returns: 0 on success, -1 on failure
2000 * This function requests the driver to disassociate all associated
2001 * stations. This function does not need to be implemented if the
2002 * driver does not process association frames internally.
2004 int (*flush)(void *priv);
2007 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2008 * @priv: Private driver interface data
2009 * @elem: Information elements
2010 * @elem_len: Length of the elem buffer in octets
2011 * Returns: 0 on success, -1 on failure
2013 * This is an optional function to add information elements in the
2014 * kernel driver for Beacon and Probe Response frames. This can be left
2015 * undefined (set to %NULL) if the driver uses the Beacon template from
2018 * DEPRECATED - use set_ap() instead
2020 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2023 * read_sta_data - Fetch station data
2024 * @priv: Private driver interface data
2025 * @data: Buffer for returning station information
2026 * @addr: MAC address of the station
2027 * Returns: 0 on success, -1 on failure
2029 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2033 * hapd_send_eapol - Send an EAPOL packet (AP only)
2034 * @priv: private driver interface data
2035 * @addr: Destination MAC address
2036 * @data: EAPOL packet starting with IEEE 802.1X header
2037 * @data_len: Length of the EAPOL packet in octets
2038 * @encrypt: Whether the frame should be encrypted
2039 * @own_addr: Source MAC address
2040 * @flags: WPA_STA_* flags for the destination station
2042 * Returns: 0 on success, -1 on failure
2044 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2045 size_t data_len, int encrypt,
2046 const u8 *own_addr, u32 flags);
2049 * sta_deauth - Deauthenticate a station (AP only)
2050 * @priv: Private driver interface data
2051 * @own_addr: Source address and BSSID for the Deauthentication frame
2052 * @addr: MAC address of the station to deauthenticate
2053 * @reason: Reason code for the Deauthentiation frame
2054 * Returns: 0 on success, -1 on failure
2056 * This function requests a specific station to be deauthenticated and
2057 * a Deauthentication frame to be sent to it.
2059 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2063 * sta_disassoc - Disassociate a station (AP only)
2064 * @priv: Private driver interface data
2065 * @own_addr: Source address and BSSID for the Disassociation frame
2066 * @addr: MAC address of the station to disassociate
2067 * @reason: Reason code for the Disassociation frame
2068 * Returns: 0 on success, -1 on failure
2070 * This function requests a specific station to be disassociated and
2071 * a Disassociation frame to be sent to it.
2073 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2077 * sta_remove - Remove a station entry (AP only)
2078 * @priv: Private driver interface data
2079 * @addr: MAC address of the station to be removed
2080 * Returns: 0 on success, -1 on failure
2082 int (*sta_remove)(void *priv, const u8 *addr);
2085 * hapd_get_ssid - Get the current SSID (AP only)
2086 * @priv: Private driver interface data
2087 * @buf: Buffer for returning the SSID
2088 * @len: Maximum length of the buffer
2089 * Returns: Length of the SSID on success, -1 on failure
2091 * This function need not be implemented if the driver uses Beacon
2092 * template from set_ap() and does not reply to Probe Request frames.
2094 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2097 * hapd_set_ssid - Set SSID (AP only)
2098 * @priv: Private driver interface data
2100 * @len: Length of the SSID in octets
2101 * Returns: 0 on success, -1 on failure
2103 * DEPRECATED - use set_ap() instead
2105 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2108 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2109 * @priv: Private driver interface data
2110 * @enabled: 1 = countermeasures enabled, 0 = disabled
2111 * Returns: 0 on success, -1 on failure
2113 * This need not be implemented if the driver does not take care of
2114 * association processing.
2116 int (*hapd_set_countermeasures)(void *priv, int enabled);
2119 * sta_add - Add a station entry
2120 * @priv: Private driver interface data
2121 * @params: Station parameters
2122 * Returns: 0 on success, -1 on failure
2124 * This function is used to add a station entry to the driver once the
2125 * station has completed association. This is only used if the driver
2126 * does not take care of association processing.
2128 * With TDLS, this function is also used to add or set (params->set 1)
2129 * TDLS peer entries.
2131 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2134 * get_inact_sec - Get station inactivity duration (AP only)
2135 * @priv: Private driver interface data
2136 * @addr: Station address
2137 * Returns: Number of seconds station has been inactive, -1 on failure
2139 int (*get_inact_sec)(void *priv, const u8 *addr);
2142 * sta_clear_stats - Clear station statistics (AP only)
2143 * @priv: Private driver interface data
2144 * @addr: Station address
2145 * Returns: 0 on success, -1 on failure
2147 int (*sta_clear_stats)(void *priv, const u8 *addr);
2150 * set_freq - Set channel/frequency (AP only)
2151 * @priv: Private driver interface data
2152 * @freq: Channel parameters
2153 * Returns: 0 on success, -1 on failure
2155 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2158 * set_rts - Set RTS threshold
2159 * @priv: Private driver interface data
2160 * @rts: RTS threshold in octets
2161 * Returns: 0 on success, -1 on failure
2163 int (*set_rts)(void *priv, int rts);
2166 * set_frag - Set fragmentation threshold
2167 * @priv: Private driver interface data
2168 * @frag: Fragmentation threshold in octets
2169 * Returns: 0 on success, -1 on failure
2171 int (*set_frag)(void *priv, int frag);
2174 * sta_set_flags - Set station flags (AP only)
2175 * @priv: Private driver interface data
2176 * @addr: Station address
2177 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2178 * @flags_or: Bitmap of WPA_STA_* flags to add
2179 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2180 * Returns: 0 on success, -1 on failure
2182 int (*sta_set_flags)(void *priv, const u8 *addr,
2183 int total_flags, int flags_or, int flags_and);
2186 * set_tx_queue_params - Set TX queue parameters
2187 * @priv: Private driver interface data
2188 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2192 * @burst_time: Maximum length for bursting in 0.1 msec units
2194 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2195 int cw_max, int burst_time);
2198 * if_add - Add a virtual interface
2199 * @priv: Private driver interface data
2200 * @type: Interface type
2201 * @ifname: Interface name for the new virtual interface
2202 * @addr: Local address to use for the interface or %NULL to use the
2203 * parent interface address
2204 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2205 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2206 * not allowed (applies only to %WPA_IF_AP_BSS type)
2207 * @force_ifname: Buffer for returning an interface name that the
2208 * driver ended up using if it differs from the requested ifname
2209 * @if_addr: Buffer for returning the allocated interface address
2210 * (this may differ from the requested addr if the driver cannot
2211 * change interface address)
2212 * @bridge: Bridge interface to use or %NULL if no bridge configured
2213 * @use_existing: Whether to allow existing interface to be used
2214 * Returns: 0 on success, -1 on failure
2216 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2217 const char *ifname, const u8 *addr, void *bss_ctx,
2218 void **drv_priv, char *force_ifname, u8 *if_addr,
2219 const char *bridge, int use_existing);
2222 * if_remove - Remove a virtual interface
2223 * @priv: Private driver interface data
2224 * @type: Interface type
2225 * @ifname: Interface name of the virtual interface to be removed
2226 * Returns: 0 on success, -1 on failure
2228 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2229 const char *ifname);
2232 * set_sta_vlan - Bind a station into a specific interface (AP only)
2233 * @priv: Private driver interface data
2234 * @ifname: Interface (main or virtual BSS or VLAN)
2235 * @addr: MAC address of the associated station
2237 * Returns: 0 on success, -1 on failure
2239 * This function is used to bind a station to a specific virtual
2240 * interface. It is only used if when virtual interfaces are supported,
2241 * e.g., to assign stations to different VLAN interfaces based on
2242 * information from a RADIUS server. This allows separate broadcast
2243 * domains to be used with a single BSS.
2245 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2249 * commit - Optional commit changes handler (AP only)
2250 * @priv: driver private data
2251 * Returns: 0 on success, -1 on failure
2253 * This optional handler function can be registered if the driver
2254 * interface implementation needs to commit changes (e.g., by setting
2255 * network interface up) at the end of initial configuration. If set,
2256 * this handler will be called after initial setup has been completed.
2258 int (*commit)(void *priv);
2261 * send_ether - Send an ethernet packet (AP only)
2262 * @priv: private driver interface data
2263 * @dst: Destination MAC address
2264 * @src: Source MAC address
2266 * @data: EAPOL packet starting with IEEE 802.1X header
2267 * @data_len: Length of the EAPOL packet in octets
2268 * Returns: 0 on success, -1 on failure
2270 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2271 const u8 *data, size_t data_len);
2274 * set_radius_acl_auth - Notification of RADIUS ACL change
2275 * @priv: Private driver interface data
2276 * @mac: MAC address of the station
2277 * @accepted: Whether the station was accepted
2278 * @session_timeout: Session timeout for the station
2279 * Returns: 0 on success, -1 on failure
2281 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2282 u32 session_timeout);
2285 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2286 * @priv: Private driver interface data
2287 * @mac: MAC address of the station
2288 * Returns: 0 on success, -1 on failure
2290 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2293 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2294 * @priv: Private driver interface data
2295 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2296 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2298 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2299 * to remove extra IE(s)
2300 * Returns: 0 on success, -1 on failure
2302 * This is an optional function to add WPS IE in the kernel driver for
2303 * Beacon and Probe Response frames. This can be left undefined (set
2304 * to %NULL) if the driver uses the Beacon template from set_ap()
2305 * and does not process Probe Request frames. If the driver takes care
2306 * of (Re)Association frame processing, the assocresp buffer includes
2307 * WPS IE(s) that need to be added to (Re)Association Response frames
2308 * whenever a (Re)Association Request frame indicated use of WPS.
2310 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2311 * frames when operating as a GO. The driver is responsible for adding
2312 * timing related attributes (e.g., NoA) in addition to the IEs
2313 * included here by appending them after these buffers. This call is
2314 * also used to provide Probe Response IEs for P2P Listen state
2315 * operations for drivers that generate the Probe Response frames
2318 * DEPRECATED - use set_ap() instead
2320 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2321 const struct wpabuf *proberesp,
2322 const struct wpabuf *assocresp);
2325 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2326 * @priv: Private driver interface data
2327 * @authorized: Whether the port is authorized
2328 * Returns: 0 on success, -1 on failure
2330 int (*set_supp_port)(void *priv, int authorized);
2333 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2334 * @priv: Private driver interface data
2335 * @addr: MAC address of the associated station
2336 * @aid: Association ID
2337 * @val: 1 = bind to 4-address WDS; 0 = unbind
2338 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2339 * to indicate that bridge is not to be used
2340 * @ifname_wds: Buffer to return the interface name for the new WDS
2341 * station or %NULL to indicate name is not returned.
2342 * Returns: 0 on success, -1 on failure
2344 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2345 const char *bridge_ifname, char *ifname_wds);
2348 * send_action - Transmit an Action frame
2349 * @priv: Private driver interface data
2350 * @freq: Frequency (in MHz) of the channel
2351 * @wait: Time to wait off-channel for a response (in ms), or zero
2352 * @dst: Destination MAC address (Address 1)
2353 * @src: Source MAC address (Address 2)
2354 * @bssid: BSSID (Address 3)
2356 * @data_len: data length in octets
2357 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2358 * Returns: 0 on success, -1 on failure
2360 * This command can be used to request the driver to transmit an action
2361 * frame to the specified destination.
2363 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2364 * be transmitted on the given channel and the device will wait for a
2365 * response on that channel for the given wait time.
2367 * If the flag is not set, the wait time will be ignored. In this case,
2368 * if a remain-on-channel duration is in progress, the frame must be
2369 * transmitted on that channel; alternatively the frame may be sent on
2370 * the current operational channel (if in associated state in station
2371 * mode or while operating as an AP.)
2373 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2374 const u8 *dst, const u8 *src, const u8 *bssid,
2375 const u8 *data, size_t data_len, int no_cck);
2378 * send_action_cancel_wait - Cancel action frame TX wait
2379 * @priv: Private driver interface data
2381 * This command cancels the wait time associated with sending an action
2382 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2383 * set in the driver flags.
2385 void (*send_action_cancel_wait)(void *priv);
2388 * remain_on_channel - Remain awake on a channel
2389 * @priv: Private driver interface data
2390 * @freq: Frequency (in MHz) of the channel
2391 * @duration: Duration in milliseconds
2392 * Returns: 0 on success, -1 on failure
2394 * This command is used to request the driver to remain awake on the
2395 * specified channel for the specified duration and report received
2396 * Action frames with EVENT_RX_MGMT events. Optionally, received
2397 * Probe Request frames may also be requested to be reported by calling
2398 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2400 * The driver may not be at the requested channel when this function
2401 * returns, i.e., the return code is only indicating whether the
2402 * request was accepted. The caller will need to wait until the
2403 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2404 * completed the channel change. This may take some time due to other
2405 * need for the radio and the caller should be prepared to timing out
2406 * its wait since there are no guarantees on when this request can be
2409 int (*remain_on_channel)(void *priv, unsigned int freq,
2410 unsigned int duration);
2413 * cancel_remain_on_channel - Cancel remain-on-channel operation
2414 * @priv: Private driver interface data
2416 * This command can be used to cancel a remain-on-channel operation
2417 * before its originally requested duration has passed. This could be
2418 * used, e.g., when remain_on_channel() is used to request extra time
2419 * to receive a response to an Action frame and the response is
2420 * received when there is still unneeded time remaining on the
2421 * remain-on-channel operation.
2423 int (*cancel_remain_on_channel)(void *priv);
2426 * probe_req_report - Request Probe Request frames to be indicated
2427 * @priv: Private driver interface data
2428 * @report: Whether to report received Probe Request frames
2429 * Returns: 0 on success, -1 on failure (or if not supported)
2431 * This command can be used to request the driver to indicate when
2432 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2433 * Since this operation may require extra resources, e.g., due to less
2434 * optimal hardware/firmware RX filtering, many drivers may disable
2435 * Probe Request reporting at least in station mode. This command is
2436 * used to notify the driver when the Probe Request frames need to be
2437 * reported, e.g., during remain-on-channel operations.
2439 int (*probe_req_report)(void *priv, int report);
2442 * deinit_ap - Deinitialize AP mode
2443 * @priv: Private driver interface data
2444 * Returns: 0 on success, -1 on failure (or if not supported)
2446 * This optional function can be used to disable AP mode related
2447 * configuration. If the interface was not dynamically added,
2448 * change the driver mode to station mode to allow normal station
2449 * operations like scanning to be completed.
2451 int (*deinit_ap)(void *priv);
2454 * deinit_p2p_cli - Deinitialize P2P client mode
2455 * @priv: Private driver interface data
2456 * Returns: 0 on success, -1 on failure (or if not supported)
2458 * This optional function can be used to disable P2P client mode. If the
2459 * interface was not dynamically added, change the interface type back
2462 int (*deinit_p2p_cli)(void *priv);
2465 * suspend - Notification on system suspend/hibernate event
2466 * @priv: Private driver interface data
2468 void (*suspend)(void *priv);
2471 * resume - Notification on system resume/thaw event
2472 * @priv: Private driver interface data
2474 void (*resume)(void *priv);
2477 * signal_monitor - Set signal monitoring parameters
2478 * @priv: Private driver interface data
2479 * @threshold: Threshold value for signal change events; 0 = disabled
2480 * @hysteresis: Minimum change in signal strength before indicating a
2482 * Returns: 0 on success, -1 on failure (or if not supported)
2484 * This function can be used to configure monitoring of signal strength
2485 * with the current AP. Whenever signal strength drops below the
2486 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2487 * should be generated assuming the signal strength has changed at
2488 * least %hysteresis from the previously indicated signal change event.
2490 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2493 * send_frame - Send IEEE 802.11 frame (testing use only)
2494 * @priv: Private driver interface data
2495 * @data: IEEE 802.11 frame with IEEE 802.11 header
2496 * @data_len: Size of the frame
2497 * @encrypt: Whether to encrypt the frame (if keys are set)
2498 * Returns: 0 on success, -1 on failure
2500 * This function is only used for debugging purposes and is not
2501 * required to be implemented for normal operations.
2503 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2507 * shared_freq - Get operating frequency of shared interface(s)
2508 * @priv: Private driver interface data
2509 * Returns: Operating frequency in MHz, 0 if no shared operation in
2510 * use, or -1 on failure
2512 * This command can be used to request the current operating frequency
2513 * of any virtual interface that shares the same radio to provide
2514 * information for channel selection for other virtual interfaces.
2516 int (*shared_freq)(void *priv);
2519 * get_noa - Get current Notice of Absence attribute payload
2520 * @priv: Private driver interface data
2521 * @buf: Buffer for returning NoA
2522 * @buf_len: Buffer length in octets
2523 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2524 * advertized, or -1 on failure
2526 * This function is used to fetch the current Notice of Absence
2527 * attribute value from GO.
2529 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2532 * set_noa - Set Notice of Absence parameters for GO (testing)
2533 * @priv: Private driver interface data
2535 * @start: Start time in ms from next TBTT
2536 * @duration: Duration in ms
2537 * Returns: 0 on success or -1 on failure
2539 * This function is used to set Notice of Absence parameters for GO. It
2540 * is used only for testing. To disable NoA, all parameters are set to
2543 int (*set_noa)(void *priv, u8 count, int start, int duration);
2546 * set_p2p_powersave - Set P2P power save options
2547 * @priv: Private driver interface data
2548 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2549 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2550 * @ctwindow: 0.. = change (msec), -1 = no change
2551 * Returns: 0 on success or -1 on failure
2553 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2557 * ampdu - Enable/disable aggregation
2558 * @priv: Private driver interface data
2559 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2560 * Returns: 0 on success or -1 on failure
2562 int (*ampdu)(void *priv, int ampdu);
2565 * get_radio_name - Get physical radio name for the device
2566 * @priv: Private driver interface data
2567 * Returns: Radio name or %NULL if not known
2569 * The returned data must not be modified by the caller. It is assumed
2570 * that any interface that has the same radio name as another is
2571 * sharing the same physical radio. This information can be used to
2572 * share scan results etc. information between the virtual interfaces
2573 * to speed up various operations.
2575 const char * (*get_radio_name)(void *priv);
2578 * send_tdls_mgmt - for sending TDLS management packets
2579 * @priv: private driver interface data
2580 * @dst: Destination (peer) MAC address
2581 * @action_code: TDLS action code for the mssage
2582 * @dialog_token: Dialog Token to use in the message (if needed)
2583 * @status_code: Status Code or Reason Code to use (if needed)
2584 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2585 * @initiator: Is the current end the TDLS link initiator
2586 * @buf: TDLS IEs to add to the message
2587 * @len: Length of buf in octets
2588 * Returns: 0 on success, negative (<0) on failure
2590 * This optional function can be used to send packet to driver which is
2591 * responsible for receiving and sending all TDLS packets.
2593 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2594 u8 dialog_token, u16 status_code, u32 peer_capab,
2595 int initiator, const u8 *buf, size_t len);
2598 * tdls_oper - Ask the driver to perform high-level TDLS operations
2599 * @priv: Private driver interface data
2600 * @oper: TDLS high-level operation. See %enum tdls_oper
2601 * @peer: Destination (peer) MAC address
2602 * Returns: 0 on success, negative (<0) on failure
2604 * This optional function can be used to send high-level TDLS commands
2607 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2610 * wnm_oper - Notify driver of the WNM frame reception
2611 * @priv: Private driver interface data
2612 * @oper: WNM operation. See %enum wnm_oper
2613 * @peer: Destination (peer) MAC address
2614 * @buf: Buffer for the driver to fill in (for getting IE)
2615 * @buf_len: Return the len of buf
2616 * Returns: 0 on success, negative (<0) on failure
2618 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2619 u8 *buf, u16 *buf_len);
2622 * set_qos_map - Set QoS Map
2623 * @priv: Private driver interface data
2624 * @qos_map_set: QoS Map
2625 * @qos_map_set_len: Length of QoS Map
2627 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2628 u8 qos_map_set_len);
2631 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2632 * @priv: Private driver interface data
2633 * @ipaddr: IPv4 address for the neigh entry
2634 * @prefixlen: IPv4 address netmask prefix length
2635 * @addr: Corresponding MAC address
2636 * Returns: 0 on success, negative (<0) on failure
2638 int (*br_add_ip_neigh)(void *priv, be32 ipaddr, int prefixlen,
2642 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2643 * @priv: Private driver interface data
2644 * @ipaddr: IPv4 address for the neigh entry
2645 * Returns: 0 on success, negative (<0) on failure
2647 int (*br_delete_ip_neigh)(void *priv, be32 ipaddr);
2650 * br_port_set_attr - Set a bridge port attribute
2651 * @attr: Bridge port attribute to set
2652 * @val: Value to be set
2653 * Returns: 0 on success, negative (<0) on failure
2655 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2659 * br_port_set_attr - Set a bridge network parameter
2660 * @param: Bridge parameter to set
2661 * @val: Value to be set
2662 * Returns: 0 on success, negative (<0) on failure
2664 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2668 * set_wowlan - Set wake-on-wireless triggers
2669 * @priv: Private driver interface data
2670 * @triggers: wowlan triggers
2672 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2675 * signal_poll - Get current connection information
2676 * @priv: Private driver interface data
2677 * @signal_info: Connection info structure
2679 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2682 * set_authmode - Set authentication algorithm(s) for static WEP
2683 * @priv: Private driver interface data
2684 * @authmode: 1=Open System, 2=Shared Key, 3=both
2685 * Returns: 0 on success, -1 on failure
2687 * This function can be used to set authentication algorithms for AP
2688 * mode when static WEP is used. If the driver uses user space MLME/SME
2689 * implementation, there is no need to implement this function.
2691 * DEPRECATED - use set_ap() instead
2693 int (*set_authmode)(void *priv, int authmode);
2697 * driver_cmd - Execute driver-specific command
2698 * @priv: Private driver interface data
2699 * @cmd: Command to execute
2700 * @buf: Return buffer
2701 * @buf_len: Buffer length
2702 * Returns: 0 on success, -1 on failure
2704 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2705 #endif /* ANDROID */
2708 * vendor_cmd - Execute vendor specific command
2709 * @priv: Private driver interface data
2710 * @vendor_id: Vendor id
2711 * @subcmd: Vendor command id
2712 * @data: Vendor command parameters (%NULL if no parameters)
2713 * @data_len: Data length
2714 * @buf: Return buffer (%NULL to ignore reply)
2715 * Returns: 0 on success, negative (<0) on failure
2717 * This function handles vendor specific commands that are passed to
2718 * the driver/device. The command is identified by vendor id and
2719 * command id. Parameters can be passed as argument to the command
2720 * in the data buffer. Reply (if any) will be filled in the supplied
2723 * The exact driver behavior is driver interface and vendor specific. As
2724 * an example, this will be converted to a vendor specific cfg80211
2725 * command in case of the nl80211 driver interface.
2727 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2728 unsigned int subcmd, const u8 *data, size_t data_len,
2729 struct wpabuf *buf);
2732 * set_rekey_info - Set rekey information
2733 * @priv: Private driver interface data
2736 * @replay_ctr: Current EAPOL-Key Replay Counter
2738 * This optional function can be used to provide information for the
2739 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2740 * while the host (including wpa_supplicant) is sleeping.
2742 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2743 const u8 *replay_ctr);
2746 * sta_assoc - Station association indication
2747 * @priv: Private driver interface data
2748 * @own_addr: Source address and BSSID for association frame
2749 * @addr: MAC address of the station to associate
2750 * @reassoc: flag to indicate re-association
2751 * @status: association response status code
2752 * @ie: assoc response ie buffer
2753 * @len: ie buffer length
2754 * Returns: 0 on success, -1 on failure
2756 * This function indicates the driver to send (Re)Association
2757 * Response frame to the station.
2759 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2760 int reassoc, u16 status, const u8 *ie, size_t len);
2763 * sta_auth - Station authentication indication
2764 * @priv: Private driver interface data
2765 * @own_addr: Source address and BSSID for authentication frame
2766 * @addr: MAC address of the station to associate
2767 * @seq: authentication sequence number
2768 * @status: authentication response status code
2769 * @ie: authentication frame ie buffer
2770 * @len: ie buffer length
2772 * This function indicates the driver to send Authentication frame
2775 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2776 u16 seq, u16 status, const u8 *ie, size_t len);
2779 * add_tspec - Add traffic stream
2780 * @priv: Private driver interface data
2781 * @addr: MAC address of the station to associate
2782 * @tspec_ie: tspec ie buffer
2783 * @tspec_ielen: tspec ie length
2784 * Returns: 0 on success, -1 on failure
2786 * This function adds the traffic steam for the station
2787 * and fills the medium_time in tspec_ie.
2789 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2790 size_t tspec_ielen);
2793 * add_sta_node - Add a station node in the driver
2794 * @priv: Private driver interface data
2795 * @addr: MAC address of the station to add
2796 * @auth_alg: authentication algorithm used by the station
2797 * Returns: 0 on success, -1 on failure
2799 * This function adds the station node in the driver, when
2800 * the station gets added by FT-over-DS.
2802 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2805 * sched_scan - Request the driver to initiate scheduled scan
2806 * @priv: Private driver interface data
2807 * @params: Scan parameters
2808 * @interval: Interval between scan cycles in milliseconds
2809 * Returns: 0 on success, -1 on failure
2811 * This operation should be used for scheduled scan offload to
2812 * the hardware. Every time scan results are available, the
2813 * driver should report scan results event for wpa_supplicant
2814 * which will eventually request the results with
2815 * wpa_driver_get_scan_results2(). This operation is optional
2816 * and if not provided or if it returns -1, we fall back to
2817 * normal host-scheduled scans.
2819 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2823 * stop_sched_scan - Request the driver to stop a scheduled scan
2824 * @priv: Private driver interface data
2825 * Returns: 0 on success, -1 on failure
2827 * This should cause the scheduled scan to be stopped and
2828 * results should stop being sent. Must be supported if
2829 * sched_scan is supported.
2831 int (*stop_sched_scan)(void *priv);
2834 * poll_client - Probe (null data or such) the given station
2835 * @priv: Private driver interface data
2836 * @own_addr: MAC address of sending interface
2837 * @addr: MAC address of the station to probe
2838 * @qos: Indicates whether station is QoS station
2840 * This function is used to verify whether an associated station is
2841 * still present. This function does not need to be implemented if the
2842 * driver provides such inactivity polling mechanism.
2844 void (*poll_client)(void *priv, const u8 *own_addr,
2845 const u8 *addr, int qos);
2848 * radio_disable - Disable/enable radio
2849 * @priv: Private driver interface data
2850 * @disabled: 1=disable 0=enable radio
2851 * Returns: 0 on success, -1 on failure
2853 * This optional command is for testing purposes. It can be used to
2854 * disable the radio on a testbed device to simulate out-of-radio-range
2857 int (*radio_disable)(void *priv, int disabled);
2860 * switch_channel - Announce channel switch and migrate the GO to the
2862 * @priv: Private driver interface data
2863 * @settings: Settings for CSA period and new channel
2864 * Returns: 0 on success, -1 on failure
2866 * This function is used to move the GO to the legacy STA channel to
2867 * avoid frequency conflict in single channel concurrency.
2869 int (*switch_channel)(void *priv, struct csa_settings *settings);
2872 * start_dfs_cac - Listen for radar interference on the channel
2873 * @priv: Private driver interface data
2874 * @freq: Channel parameters
2875 * Returns: 0 on success, -1 on failure
2877 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
2880 * stop_ap - Removes beacon from AP
2881 * @priv: Private driver interface data
2882 * Returns: 0 on success, -1 on failure (or if not supported)
2884 * This optional function can be used to disable AP mode related
2885 * configuration. Unlike deinit_ap, it does not change to station
2888 int (*stop_ap)(void *priv);
2891 * get_survey - Retrieve survey data
2892 * @priv: Private driver interface data
2893 * @freq: If set, survey data for the specified frequency is only
2894 * being requested. If not set, all survey data is requested.
2895 * Returns: 0 on success, -1 on failure
2897 * Use this to retrieve:
2899 * - the observed channel noise floor
2900 * - the amount of time we have spent on the channel
2901 * - the amount of time during which we have spent on the channel that
2902 * the radio has determined the medium is busy and we cannot
2904 * - the amount of time we have spent receiving data
2905 * - the amount of time we have spent transmitting data
2907 * This data can be used for spectrum heuristics. One example is
2908 * Automatic Channel Selection (ACS). The channel survey data is
2909 * kept on a linked list on the channel data, one entry is added
2910 * for each survey. The min_nf of the channel is updated for each
2913 int (*get_survey)(void *priv, unsigned int freq);
2916 * status - Get driver interface status information
2917 * @priv: Private driver interface data
2918 * @buf: Buffer for printing tou the status information
2919 * @buflen: Maximum length of the buffer
2920 * Returns: Length of written status information or -1 on failure
2922 int (*status)(void *priv, char *buf, size_t buflen);
2925 * roaming - Set roaming policy for driver-based BSS selection
2926 * @priv: Private driver interface data
2927 * @allowed: Whether roaming within ESS is allowed
2928 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
2929 * Returns: Length of written status information or -1 on failure
2931 * This optional callback can be used to update roaming policy from the
2932 * associate() command (bssid being set there indicates that the driver
2933 * should not roam before getting this roaming() call to allow roaming.
2934 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
2935 * capability, roaming policy is handled within wpa_supplicant and there
2936 * is no need to implement or react to this callback.
2938 int (*roaming)(void *priv, int allowed, const u8 *bssid);
2941 * set_mac_addr - Set MAC address
2942 * @priv: Private driver interface data
2943 * @addr: MAC address to use or %NULL for setting back to permanent
2944 * Returns: 0 on success, -1 on failure
2946 int (*set_mac_addr)(void *priv, const u8 *addr);
2948 #ifdef CONFIG_MACSEC
2949 int (*macsec_init)(void *priv, struct macsec_init_params *params);
2951 int (*macsec_deinit)(void *priv);
2954 * enable_protect_frames - Set protect frames status
2955 * @priv: Private driver interface data
2956 * @enabled: TRUE = protect frames enabled
2957 * FALSE = protect frames disabled
2958 * Returns: 0 on success, -1 on failure (or if not supported)
2960 int (*enable_protect_frames)(void *priv, Boolean enabled);
2963 * set_replay_protect - Set replay protect status and window size
2964 * @priv: Private driver interface data
2965 * @enabled: TRUE = replay protect enabled
2966 * FALSE = replay protect disabled
2967 * @window: replay window size, valid only when replay protect enabled
2968 * Returns: 0 on success, -1 on failure (or if not supported)
2970 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
2973 * set_current_cipher_suite - Set current cipher suite
2974 * @priv: Private driver interface data
2975 * @cs: EUI64 identifier
2976 * @cs_len: Length of the cs buffer in octets
2977 * Returns: 0 on success, -1 on failure (or if not supported)
2979 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
2983 * enable_controlled_port - Set controlled port status
2984 * @priv: Private driver interface data
2985 * @enabled: TRUE = controlled port enabled
2986 * FALSE = controlled port disabled
2987 * Returns: 0 on success, -1 on failure (or if not supported)
2989 int (*enable_controlled_port)(void *priv, Boolean enabled);
2992 * get_receive_lowest_pn - Get receive lowest pn
2993 * @priv: Private driver interface data
2994 * @channel: secure channel
2995 * @an: association number
2996 * @lowest_pn: lowest accept pn
2997 * Returns: 0 on success, -1 on failure (or if not supported)
2999 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3003 * get_transmit_next_pn - Get transmit next pn
3004 * @priv: Private driver interface data
3005 * @channel: secure channel
3006 * @an: association number
3008 * Returns: 0 on success, -1 on failure (or if not supported)
3010 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3014 * set_transmit_next_pn - Set transmit next pn
3015 * @priv: Private driver interface data
3016 * @channel: secure channel
3017 * @an: association number
3019 * Returns: 0 on success, -1 on failure (or if not supported)
3021 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3025 * get_available_receive_sc - get available receive channel
3026 * @priv: Private driver interface data
3027 * @channel: secure channel
3028 * Returns: 0 on success, -1 on failure (or if not supported)
3030 int (*get_available_receive_sc)(void *priv, u32 *channel);
3033 * create_receive_sc - create secure channel for receiving
3034 * @priv: Private driver interface data
3035 * @channel: secure channel
3036 * @sci_addr: secure channel identifier - address
3037 * @sci_port: secure channel identifier - port
3038 * @conf_offset: confidentiality offset (0, 30, or 50)
3039 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3041 * Returns: 0 on success, -1 on failure (or if not supported)
3043 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3044 u16 sci_port, unsigned int conf_offset,
3048 * delete_receive_sc - delete secure connection for receiving
3049 * @priv: private driver interface data from init()
3050 * @channel: secure channel
3051 * Returns: 0 on success, -1 on failure
3053 int (*delete_receive_sc)(void *priv, u32 channel);
3056 * create_receive_sa - create secure association for receive
3057 * @priv: private driver interface data from init()
3058 * @channel: secure channel
3059 * @an: association number
3060 * @lowest_pn: the lowest packet number can be received
3061 * @sak: the secure association key
3062 * Returns: 0 on success, -1 on failure
3064 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3065 u32 lowest_pn, const u8 *sak);
3068 * enable_receive_sa - enable the SA for receive
3069 * @priv: private driver interface data from init()
3070 * @channel: secure channel
3071 * @an: association number
3072 * Returns: 0 on success, -1 on failure
3074 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3077 * disable_receive_sa - disable SA for receive
3078 * @priv: private driver interface data from init()
3079 * @channel: secure channel index
3080 * @an: association number
3081 * Returns: 0 on success, -1 on failure
3083 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3086 * get_available_transmit_sc - get available transmit channel
3087 * @priv: Private driver interface data
3088 * @channel: secure channel
3089 * Returns: 0 on success, -1 on failure (or if not supported)
3091 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3094 * create_transmit_sc - create secure connection for transmit
3095 * @priv: private driver interface data from init()
3096 * @channel: secure channel
3097 * @sci_addr: secure channel identifier - address
3098 * @sci_port: secure channel identifier - port
3099 * Returns: 0 on success, -1 on failure
3101 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3102 u16 sci_port, unsigned int conf_offset);
3105 * delete_transmit_sc - delete secure connection for transmit
3106 * @priv: private driver interface data from init()
3107 * @channel: secure channel
3108 * Returns: 0 on success, -1 on failure
3110 int (*delete_transmit_sc)(void *priv, u32 channel);
3113 * create_transmit_sa - create secure association for transmit
3114 * @priv: private driver interface data from init()
3115 * @channel: secure channel index
3116 * @an: association number
3117 * @next_pn: the packet number used as next transmit packet
3118 * @confidentiality: True if the SA is to provide confidentiality
3119 * as well as integrity
3120 * @sak: the secure association key
3121 * Returns: 0 on success, -1 on failure
3123 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3124 Boolean confidentiality, const u8 *sak);
3127 * enable_transmit_sa - enable SA for transmit
3128 * @priv: private driver interface data from init()
3129 * @channel: secure channel
3130 * @an: association number
3131 * Returns: 0 on success, -1 on failure
3133 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3136 * disable_transmit_sa - disable SA for transmit
3137 * @priv: private driver interface data from init()
3138 * @channel: secure channel
3139 * @an: association number
3140 * Returns: 0 on success, -1 on failure
3142 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3143 #endif /* CONFIG_MACSEC */
3146 * init_mesh - Driver specific initialization for mesh
3147 * @priv: Private driver interface data
3148 * Returns: 0 on success, -1 on failure
3150 int (*init_mesh)(void *priv);
3153 * join_mesh - Join a mesh network
3154 * @priv: Private driver interface data
3155 * @params: Mesh configuration parameters
3156 * Returns: 0 on success, -1 on failure
3158 int (*join_mesh)(void *priv,
3159 struct wpa_driver_mesh_join_params *params);
3162 * leave_mesh - Leave a mesh network
3163 * @priv: Private driver interface data
3164 * Returns 0 on success, -1 on failure
3166 int (*leave_mesh)(void *priv);
3171 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3173 enum wpa_event_type {
3175 * EVENT_ASSOC - Association completed
3177 * This event needs to be delivered when the driver completes IEEE
3178 * 802.11 association or reassociation successfully.
3179 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3180 * after this event has been generated. In addition, optional
3181 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3182 * more information about the association. If the driver interface gets
3183 * both of these events at the same time, it can also include the
3184 * assoc_info data in EVENT_ASSOC call.
3189 * EVENT_DISASSOC - Association lost
3191 * This event should be called when association is lost either due to
3192 * receiving deauthenticate or disassociate frame from the AP or when
3193 * sending either of these frames to the current AP. If the driver
3194 * supports separate deauthentication event, EVENT_DISASSOC should only
3195 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3196 * In AP mode, union wpa_event_data::disassoc_info is required.
3201 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3203 * This event must be delivered when a Michael MIC error is detected by
3204 * the local driver. Additional data for event processing is
3205 * provided with union wpa_event_data::michael_mic_failure. This
3206 * information is used to request new encyption key and to initiate
3207 * TKIP countermeasures if needed.
3209 EVENT_MICHAEL_MIC_FAILURE,
3212 * EVENT_SCAN_RESULTS - Scan results available
3214 * This event must be called whenever scan results are available to be
3215 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3216 * is expected to be used some time after struct wpa_driver_ops::scan()
3217 * is called. If the driver provides an unsolicited event when the scan
3218 * has been completed, this event can be used to trigger
3219 * EVENT_SCAN_RESULTS call. If such event is not available from the
3220 * driver, the driver wrapper code is expected to use a registered
3221 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3222 * scan is expected to be completed. Optional information about
3223 * completed scan can be provided with union wpa_event_data::scan_info.
3228 * EVENT_ASSOCINFO - Report optional extra information for association
3230 * This event can be used to report extra association information for
3231 * EVENT_ASSOC processing. This extra information includes IEs from
3232 * association frames and Beacon/Probe Response frames in union
3233 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3234 * EVENT_ASSOC. Alternatively, the driver interface can include
3235 * assoc_info data in the EVENT_ASSOC call if it has all the
3236 * information available at the same point.
3241 * EVENT_INTERFACE_STATUS - Report interface status changes
3243 * This optional event can be used to report changes in interface
3244 * status (interface added/removed) using union
3245 * wpa_event_data::interface_status. This can be used to trigger
3246 * wpa_supplicant to stop and re-start processing for the interface,
3247 * e.g., when a cardbus card is ejected/inserted.
3249 EVENT_INTERFACE_STATUS,
3252 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3254 * This event can be used to inform wpa_supplicant about candidates for
3255 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3256 * for scan request (ap_scan=2 mode), this event is required for
3257 * pre-authentication. If wpa_supplicant is performing scan request
3258 * (ap_scan=1), this event is optional since scan results can be used
3259 * to add pre-authentication candidates. union
3260 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3261 * candidate and priority of the candidate, e.g., based on the signal
3262 * strength, in order to try to pre-authenticate first with candidates
3263 * that are most likely targets for re-association.
3265 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3266 * on the candidate list. In addition, it can be called for the current
3267 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3268 * will automatically skip pre-authentication in cases where a valid
3269 * PMKSA exists. When more than one candidate exists, this event should
3270 * be generated once for each candidate.
3272 * Driver will be notified about successful pre-authentication with
3273 * struct wpa_driver_ops::add_pmkid() calls.
3275 EVENT_PMKID_CANDIDATE,
3278 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3280 * This event can be used to inform wpa_supplicant about desire to set
3281 * up secure direct link connection between two stations as defined in
3282 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3283 * STAKey negotiation. The caller will need to set peer address for the
3289 * EVENT_TDLS - Request TDLS operation
3291 * This event can be used to request a TDLS operation to be performed.
3296 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3298 * The driver is expected to report the received FT IEs from
3299 * FT authentication sequence from the AP. The FT IEs are included in
3300 * the extra information in union wpa_event_data::ft_ies.
3305 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3307 * The driver can use this event to inform wpa_supplicant about a STA
3308 * in an IBSS with which protected frames could be exchanged. This
3309 * event starts RSN authentication with the other STA to authenticate
3310 * the STA and set up encryption keys with it.
3312 EVENT_IBSS_RSN_START,
3315 * EVENT_AUTH - Authentication result
3317 * This event should be called when authentication attempt has been
3318 * completed. This is only used if the driver supports separate
3319 * authentication step (struct wpa_driver_ops::authenticate).
3320 * Information about authentication result is included in
3321 * union wpa_event_data::auth.
3326 * EVENT_DEAUTH - Authentication lost
3328 * This event should be called when authentication is lost either due
3329 * to receiving deauthenticate frame from the AP or when sending that
3330 * frame to the current AP.
3331 * In AP mode, union wpa_event_data::deauth_info is required.
3336 * EVENT_ASSOC_REJECT - Association rejected
3338 * This event should be called when (re)association attempt has been
3339 * rejected by the AP. Information about the association response is
3340 * included in union wpa_event_data::assoc_reject.
3345 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3347 EVENT_AUTH_TIMED_OUT,
3350 * EVENT_ASSOC_TIMED_OUT - Association timed out
3352 EVENT_ASSOC_TIMED_OUT,
3355 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3357 EVENT_WPS_BUTTON_PUSHED,
3360 * EVENT_TX_STATUS - Report TX status
3365 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3367 EVENT_RX_FROM_UNKNOWN,
3370 * EVENT_RX_MGMT - Report RX of a management frame
3375 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3377 * This event is used to indicate when the driver has started the
3378 * requested remain-on-channel duration. Information about the
3379 * operation is included in union wpa_event_data::remain_on_channel.
3381 EVENT_REMAIN_ON_CHANNEL,
3384 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3386 * This event is used to indicate when the driver has completed
3387 * remain-on-channel duration, i.e., may noot be available on the
3388 * requested channel anymore. Information about the
3389 * operation is included in union wpa_event_data::remain_on_channel.
3391 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3394 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3396 * This event is used to indicate when a Probe Request frame has been
3397 * received. Information about the received frame is included in
3398 * union wpa_event_data::rx_probe_req. The driver is required to report
3399 * these events only after successfully completed probe_req_report()
3400 * commands to request the events (i.e., report parameter is non-zero)
3401 * in station mode. In AP mode, Probe Request frames should always be
3407 * EVENT_NEW_STA - New wired device noticed
3409 * This event is used to indicate that a new device has been detected
3410 * in a network that does not use association-like functionality (i.e.,
3411 * mainly wired Ethernet). This can be used to start EAPOL
3412 * authenticator when receiving a frame from a device. The address of
3413 * the device is included in union wpa_event_data::new_sta.
3418 * EVENT_EAPOL_RX - Report received EAPOL frame
3420 * When in AP mode with hostapd, this event is required to be used to
3421 * deliver the receive EAPOL frames from the driver. With
3422 * %wpa_supplicant, this event is used only if the send_eapol() handler
3423 * is used to override the use of l2_packet for EAPOL frame TX.
3428 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3430 * This event is used to indicate changes in the signal strength
3431 * observed in frames received from the current AP if signal strength
3432 * monitoring has been enabled with signal_monitor().
3434 EVENT_SIGNAL_CHANGE,
3437 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3439 * This event is used to indicate that the interface was enabled after
3440 * having been previously disabled, e.g., due to rfkill.
3442 EVENT_INTERFACE_ENABLED,
3445 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3447 * This event is used to indicate that the interface was disabled,
3448 * e.g., due to rfkill.
3450 EVENT_INTERFACE_DISABLED,
3453 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3455 * This event is used to indicate that the channel list has changed,
3456 * e.g., because of a regulatory domain change triggered by scan
3457 * results including an AP advertising a country code.
3459 EVENT_CHANNEL_LIST_CHANGED,
3462 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3464 * This event is used to indicate that the driver cannot maintain this
3465 * interface in its operation mode anymore. The most likely use for
3466 * this is to indicate that AP mode operation is not available due to
3467 * operating channel would need to be changed to a DFS channel when
3468 * the driver does not support radar detection and another virtual
3469 * interfaces caused the operating channel to change. Other similar
3470 * resource conflicts could also trigger this for station mode
3471 * interfaces. This event can be propagated when channel switching
3474 EVENT_INTERFACE_UNAVAILABLE,
3477 * EVENT_BEST_CHANNEL
3479 * Driver generates this event whenever it detects a better channel
3480 * (e.g., based on RSSI or channel use). This information can be used
3481 * to improve channel selection for a new AP/P2P group.
3486 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3488 * This event should be called when a Deauthentication frame is dropped
3489 * due to it not being protected (MFP/IEEE 802.11w).
3490 * union wpa_event_data::unprot_deauth is required to provide more
3491 * details of the frame.
3493 EVENT_UNPROT_DEAUTH,
3496 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3498 * This event should be called when a Disassociation frame is dropped
3499 * due to it not being protected (MFP/IEEE 802.11w).
3500 * union wpa_event_data::unprot_disassoc is required to provide more
3501 * details of the frame.
3503 EVENT_UNPROT_DISASSOC,
3506 * EVENT_STATION_LOW_ACK
3508 * Driver generates this event whenever it detected that a particular
3509 * station was lost. Detection can be through massive transmission
3510 * failures for example.
3512 EVENT_STATION_LOW_ACK,
3515 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3517 EVENT_IBSS_PEER_LOST,
3520 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3522 * This event carries the new replay counter to notify wpa_supplicant
3523 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3524 * completed Group Key Handshake while the host (including
3525 * wpa_supplicant was sleeping).
3527 EVENT_DRIVER_GTK_REKEY,
3530 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3532 EVENT_SCHED_SCAN_STOPPED,
3535 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3537 * This event indicates that the station responded to the poll
3538 * initiated with @poll_client.
3540 EVENT_DRIVER_CLIENT_POLL_OK,
3543 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3545 EVENT_EAPOL_TX_STATUS,
3548 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3550 * Described in wpa_event_data.ch_switch
3555 * EVENT_WNM - Request WNM operation
3557 * This event can be used to request a WNM operation to be performed.
3562 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3564 * This event indicates that the driver reported a connection failure
3565 * with the specified client (for example, max client reached, etc.) in
3568 EVENT_CONNECT_FAILED_REASON,
3571 * EVENT_RADAR_DETECTED - Notify of radar detection
3573 * A radar has been detected on the supplied frequency, hostapd should
3574 * react accordingly (e.g., change channel).
3576 EVENT_DFS_RADAR_DETECTED,
3579 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3581 * After a successful CAC, the channel can be marked clear and used.
3583 EVENT_DFS_CAC_FINISHED,
3586 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3588 * The CAC was not successful, and the channel remains in the previous
3589 * state. This may happen due to a radar beeing detected or other
3590 * external influences.
3592 EVENT_DFS_CAC_ABORTED,
3595 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3597 * The channel which was previously unavailable is now available again.
3599 EVENT_DFS_NOP_FINISHED,
3602 * EVENT_SURVEY - Received survey data
3604 * This event gets triggered when a driver query is issued for survey
3605 * data and the requested data becomes available. The returned data is
3606 * stored in struct survey_results. The results provide at most one
3607 * survey entry for each frequency and at minimum will provide one
3608 * survey entry for one frequency. The survey data can be os_malloc()'d
3609 * and then os_free()'d, so the event callback must only copy data.
3614 * EVENT_SCAN_STARTED - Scan started
3616 * This indicates that driver has started a scan operation either based
3617 * on a request from wpa_supplicant/hostapd or from another application.
3618 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3619 * completed (either successfully or by getting cancelled).
3624 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3626 * This event indicates a set of frequency ranges that should be avoided
3627 * to reduce issues due to interference or internal co-existence
3628 * information in the driver.
3630 EVENT_AVOID_FREQUENCIES,
3633 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3635 EVENT_NEW_PEER_CANDIDATE
3641 * struct freq_survey - Channel survey info
3643 * @ifidx: Interface index in which this survey was observed
3644 * @freq: Center of frequency of the surveyed channel
3645 * @nf: Channel noise floor in dBm
3646 * @channel_time: Amount of time in ms the radio spent on the channel
3647 * @channel_time_busy: Amount of time in ms the radio detected some signal
3648 * that indicated to the radio the channel was not clear
3649 * @channel_time_rx: Amount of time the radio spent receiving data
3650 * @channel_time_tx: Amount of time the radio spent transmitting data
3651 * @filled: bitmask indicating which fields have been reported, see
3652 * SURVEY_HAS_* defines.
3653 * @list: Internal list pointers
3655 struct freq_survey {
3660 u64 channel_time_busy;
3661 u64 channel_time_rx;
3662 u64 channel_time_tx;
3663 unsigned int filled;
3664 struct dl_list list;
3667 #define SURVEY_HAS_NF BIT(0)
3668 #define SURVEY_HAS_CHAN_TIME BIT(1)
3669 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3670 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3671 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3675 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3677 union wpa_event_data {
3679 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3681 * This structure is optional for EVENT_ASSOC calls and required for
3682 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3683 * driver interface does not need to generate separate EVENT_ASSOCINFO
3688 * reassoc - Flag to indicate association or reassociation
3693 * req_ies - (Re)Association Request IEs
3695 * If the driver generates WPA/RSN IE, this event data must be
3696 * returned for WPA handshake to have needed information. If
3697 * wpa_supplicant-generated WPA/RSN IE is used, this
3698 * information event is optional.
3700 * This should start with the first IE (fixed fields before IEs
3701 * are not included).
3706 * req_ies_len - Length of req_ies in bytes
3711 * resp_ies - (Re)Association Response IEs
3713 * Optional association data from the driver. This data is not
3714 * required WPA, but may be useful for some protocols and as
3715 * such, should be reported if this is available to the driver
3718 * This should start with the first IE (fixed fields before IEs
3719 * are not included).
3724 * resp_ies_len - Length of resp_ies in bytes
3726 size_t resp_ies_len;
3729 * beacon_ies - Beacon or Probe Response IEs
3731 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3732 * Probe Response frames from the current AP (i.e., the one
3733 * that the client just associated with). This information is
3734 * used to update WPA/RSN IE for the AP. If this field is not
3735 * set, the results from previous scan will be used. If no
3736 * data for the new AP is found, scan results will be requested
3737 * again (without scan request). At this point, the driver is
3738 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3741 * This should start with the first IE (fixed fields before IEs
3742 * are not included).
3744 const u8 *beacon_ies;
3747 * beacon_ies_len - Length of beacon_ies */
3748 size_t beacon_ies_len;
3751 * freq - Frequency of the operational channel in MHz
3756 * wmm_params - WMM parameters used in this association.
3758 struct wmm_params wmm_params;
3761 * addr - Station address (for AP mode)
3766 * The following is the key management offload information
3769 * @key_replay_ctr_len
3777 * authorized - Status of key management offload,
3783 * key_replay_ctr - Key replay counter value last used
3784 * in a valid EAPOL-Key frame
3786 const u8 *key_replay_ctr;
3789 * key_replay_ctr_len - The length of key_replay_ctr
3791 size_t key_replay_ctr_len;
3794 * ptk_kck - The derived PTK KCK
3799 * ptk_kek_len - The length of ptk_kck
3804 * ptk_kek - The derived PTK KEK
3809 * ptk_kek_len - The length of ptk_kek
3815 * struct disassoc_info - Data for EVENT_DISASSOC events
3817 struct disassoc_info {
3819 * addr - Station address (for AP mode)
3824 * reason_code - Reason Code (host byte order) used in
3825 * Deauthentication frame
3830 * ie - Optional IE(s) in Disassociation frame
3835 * ie_len - Length of ie buffer in octets
3840 * locally_generated - Whether the frame was locally generated
3842 int locally_generated;
3846 * struct deauth_info - Data for EVENT_DEAUTH events
3848 struct deauth_info {
3850 * addr - Station address (for AP mode)
3855 * reason_code - Reason Code (host byte order) used in
3856 * Deauthentication frame
3861 * ie - Optional IE(s) in Deauthentication frame
3866 * ie_len - Length of ie buffer in octets
3871 * locally_generated - Whether the frame was locally generated
3873 int locally_generated;
3877 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3879 struct michael_mic_failure {
3882 } michael_mic_failure;
3885 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3887 struct interface_status {
3890 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3895 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3897 struct pmkid_candidate {
3898 /** BSSID of the PMKID candidate */
3900 /** Smaller the index, higher the priority */
3902 /** Whether RSN IE includes pre-authenticate flag */
3907 * struct stkstart - Data for EVENT_STKSTART
3914 * struct tdls - Data for EVENT_TDLS
3920 TDLS_REQUEST_TEARDOWN
3922 u16 reason_code; /* for teardown */
3926 * struct wnm - Data for EVENT_WNM
3944 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3946 * During FT (IEEE 802.11r) authentication sequence, the driver is
3947 * expected to use this event to report received FT IEs (MDIE, FTIE,
3948 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3949 * IEs for the next message will be delivered through the
3950 * struct wpa_driver_ops::update_ft_ies() callback.
3956 u8 target_ap[ETH_ALEN];
3957 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3959 /** Length of ric_ies buffer in octets */
3964 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3966 struct ibss_rsn_start {
3971 * struct auth_info - Data for EVENT_AUTH events
3977 u16 auth_transaction;
3984 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3986 struct assoc_reject {
3988 * bssid - BSSID of the AP that rejected association
3993 * resp_ies - (Re)Association Response IEs
3995 * Optional association data from the driver. This data is not
3996 * required WPA, but may be useful for some protocols and as
3997 * such, should be reported if this is available to the driver
4000 * This should start with the first IE (fixed fields before IEs
4001 * are not included).
4006 * resp_ies_len - Length of resp_ies in bytes
4008 size_t resp_ies_len;
4011 * status_code - Status Code from (Re)association Response
4016 struct timeout_event {
4021 * struct tx_status - Data for EVENT_TX_STATUS events
4033 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4035 struct rx_from_unknown {
4042 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4050 * drv_priv - Pointer to store driver private BSS information
4052 * If not set to NULL, this is used for comparison with
4053 * hostapd_data->drv_priv to determine which BSS should process
4059 * freq - Frequency (in MHz) on which the frame was received
4064 * ssi_signal - Signal strength in dBm (or 0 if not available)
4070 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4072 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4074 struct remain_on_channel {
4076 * freq - Channel frequency in MHz
4081 * duration - Duration to remain on the channel in milliseconds
4083 unsigned int duration;
4084 } remain_on_channel;
4087 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4088 * @aborted: Whether the scan was aborted
4089 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4090 * @num_freqs: Number of entries in freqs array
4091 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4093 * @num_ssids: Number of entries in ssids array
4099 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4104 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4106 struct rx_probe_req {
4108 * sa - Source address of the received Probe Request frame
4113 * da - Destination address of the received Probe Request frame
4114 * or %NULL if not available
4119 * bssid - BSSID of the received Probe Request frame or %NULL
4125 * ie - IEs from the Probe Request body
4130 * ie_len - Length of ie buffer in octets
4135 * signal - signal strength in dBm (or 0 if not available)
4141 * struct new_sta - Data for EVENT_NEW_STA events
4148 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4157 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4159 struct wpa_signal_info signal_change;
4162 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4163 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4164 * @freq_5: Best 5 GHz band channel frequency in MHz
4165 * @freq_overall: Best channel frequency in MHz
4167 * 0 can be used to indicate no preference in either band.
4169 struct best_channel {
4175 struct unprot_deauth {
4181 struct unprot_disassoc {
4188 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4189 * @addr: station address
4196 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4198 struct ibss_peer_lost {
4203 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4205 struct driver_gtk_rekey {
4207 const u8 *replay_ctr;
4211 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4212 * @addr: station address
4214 struct client_poll {
4219 * struct eapol_tx_status
4220 * @dst: Original destination
4221 * @data: Data starting with IEEE 802.1X header (!)
4222 * @data_len: Length of data
4223 * @ack: Indicates ack or lost frame
4225 * This corresponds to hapd_send_eapol if the frame sent
4226 * there isn't just reported as EVENT_TX_STATUS.
4228 struct eapol_tx_status {
4237 * @freq: Frequency of new channel in MHz
4238 * @ht_enabled: Whether this is an HT channel
4239 * @ch_offset: Secondary channel offset
4240 * @ch_width: Channel width
4241 * @cf1: Center frequency 1
4242 * @cf2: Center frequency 2
4248 enum chan_width ch_width;
4254 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4255 * @addr: Remote client address
4256 * @code: Reason code for connection failure
4258 struct connect_failed_reason {
4264 } connect_failed_reason;
4267 * struct dfs_event - Data for radar detected events
4268 * @freq: Frequency of the channel in MHz
4274 enum chan_width chan_width;
4280 * survey_results - Survey result data for EVENT_SURVEY
4281 * @freq_filter: Requested frequency survey filter, 0 if request
4282 * was for all survey data
4283 * @survey_list: Linked list of survey data
4285 struct survey_results {
4286 unsigned int freq_filter;
4287 struct dl_list survey_list; /* struct freq_survey */
4291 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4292 * @initiator: Initiator of the regulatory change
4293 * @type: Regulatory change type
4294 * @alpha2: Country code (or "" if not available)
4296 struct channel_list_changed {
4297 enum reg_change_initiator initiator;
4300 } channel_list_changed;
4303 * freq_range - List of frequency ranges
4305 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4307 struct wpa_freq_range_list freq_range;
4312 * @peer: Peer address
4314 * @ie_len: Length of @ies
4316 * Notification of new candidate mesh peer.
4327 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4328 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4329 * with struct wpa_driver_ops::init()
4330 * @event: event type (defined above)
4331 * @data: possible extra data for the event
4333 * Driver wrapper code should call this function whenever an event is received
4336 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4337 union wpa_event_data *data);
4341 * The following inline functions are provided for convenience to simplify
4342 * event indication for some of the common events.
4345 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4346 size_t ielen, int reassoc)
4348 union wpa_event_data event;
4349 os_memset(&event, 0, sizeof(event));
4350 event.assoc_info.reassoc = reassoc;
4351 event.assoc_info.req_ies = ie;
4352 event.assoc_info.req_ies_len = ielen;
4353 event.assoc_info.addr = addr;
4354 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4357 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4359 union wpa_event_data event;
4360 os_memset(&event, 0, sizeof(event));
4361 event.disassoc_info.addr = addr;
4362 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4365 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4368 union wpa_event_data event;
4369 os_memset(&event, 0, sizeof(event));
4370 event.eapol_rx.src = src;
4371 event.eapol_rx.data = data;
4372 event.eapol_rx.data_len = data_len;
4373 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4376 /* driver_common.c */
4377 void wpa_scan_results_free(struct wpa_scan_results *res);
4379 /* Convert wpa_event_type to a string for logging */
4380 const char * event_to_string(enum wpa_event_type event);
4382 /* Convert chan_width to a string for logging and control interfaces */
4383 const char * channel_width_to_string(enum chan_width width);
4385 int ht_supported(const struct hostapd_hw_modes *mode);
4386 int vht_supported(const struct hostapd_hw_modes *mode);
4388 struct wowlan_triggers *
4389 wpa_get_wowlan_triggers(const char *wowlan_triggers,
4390 const struct wpa_driver_capa *capa);
4392 /* NULL terminated array of linked in driver wrappers */
4393 extern struct wpa_driver_ops *wpa_drivers[];
4395 #endif /* DRIVER_H */