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;
1075 unsigned int wmm_ac_supported:1;
1078 int max_sched_scan_ssids;
1079 int sched_scan_supported;
1083 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1085 unsigned int max_remain_on_chan;
1088 * max_stations - Maximum number of associated stations the driver
1089 * supports in AP mode
1091 unsigned int max_stations;
1094 * probe_resp_offloads - Bitmap of supported protocols by the driver
1095 * for Probe Response offloading.
1097 /* Driver Probe Response offloading support for WPS ver. 1 */
1098 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1099 /* Driver Probe Response offloading support for WPS ver. 2 */
1100 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1101 /* Driver Probe Response offloading support for P2P */
1102 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1103 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1104 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1105 unsigned int probe_resp_offloads;
1107 unsigned int max_acl_mac_addrs;
1110 * Number of supported concurrent channels
1112 unsigned int num_multichan_concurrent;
1115 * extended_capa - extended capabilities in driver/device
1117 * Must be allocated and freed by driver and the pointers must be
1118 * valid for the lifetime of the driver, i.e., freed in deinit()
1120 const u8 *extended_capa, *extended_capa_mask;
1121 unsigned int extended_capa_len;
1123 struct wowlan_triggers wowlan_triggers;
1127 struct hostapd_data;
1129 struct hostap_sta_driver_data {
1130 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1131 unsigned long current_tx_rate;
1132 unsigned long inactive_msec;
1133 unsigned long flags;
1134 unsigned long num_ps_buf_frames;
1135 unsigned long tx_retry_failed;
1136 unsigned long tx_retry_count;
1141 struct hostapd_sta_add_params {
1145 const u8 *supp_rates;
1146 size_t supp_rates_len;
1147 u16 listen_interval;
1148 const struct ieee80211_ht_capabilities *ht_capabilities;
1149 const struct ieee80211_vht_capabilities *vht_capabilities;
1150 int vht_opmode_enabled;
1152 u32 flags; /* bitmask of WPA_STA_* flags */
1153 u32 flags_mask; /* unset bits in flags */
1155 enum mesh_plink_state plink_state;
1156 #endif /* CONFIG_MESH */
1157 int set; /* Set STA parameters instead of add */
1159 const u8 *ext_capab;
1160 size_t ext_capab_len;
1161 const u8 *supp_channels;
1162 size_t supp_channels_len;
1163 const u8 *supp_oper_classes;
1164 size_t supp_oper_classes_len;
1167 struct mac_address {
1171 struct hostapd_acl_params {
1173 unsigned int num_mac_acl;
1174 struct mac_address mac_acl[0];
1177 enum wpa_driver_if_type {
1179 * WPA_IF_STATION - Station mode interface
1184 * WPA_IF_AP_VLAN - AP mode VLAN interface
1186 * This interface shares its address and Beacon frame with the main
1192 * WPA_IF_AP_BSS - AP mode BSS interface
1194 * This interface has its own address and Beacon frame.
1199 * WPA_IF_P2P_GO - P2P Group Owner
1204 * WPA_IF_P2P_CLIENT - P2P Client
1209 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1210 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1215 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1216 * abstracted P2P Device function in the driver
1221 struct wpa_init_params {
1227 const char *test_socket;
1228 int use_pae_group_addr;
1232 u8 *own_addr; /* buffer for writing own MAC address */
1236 struct wpa_bss_params {
1237 /** Interface name (for multi-SSID/VLAN support) */
1239 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1248 enum mfp_options ieee80211w;
1251 #define WPA_STA_AUTHORIZED BIT(0)
1252 #define WPA_STA_WMM BIT(1)
1253 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1254 #define WPA_STA_MFP BIT(3)
1255 #define WPA_STA_TDLS_PEER BIT(4)
1256 #define WPA_STA_AUTHENTICATED BIT(5)
1269 WNM_SLEEP_ENTER_CONFIRM,
1270 WNM_SLEEP_ENTER_FAIL,
1271 WNM_SLEEP_EXIT_CONFIRM,
1272 WNM_SLEEP_EXIT_FAIL,
1273 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1274 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1275 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1277 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1279 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1280 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1282 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1285 /* enum chan_width - Channel width definitions */
1297 * struct wpa_signal_info - Information about channel signal quality
1299 struct wpa_signal_info {
1301 int above_threshold;
1306 enum chan_width chanwidth;
1312 * struct beacon_data - Beacon data
1313 * @head: Head portion of Beacon frame (before TIM IE)
1314 * @tail: Tail portion of Beacon frame (after TIM IE)
1315 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1316 * @proberesp_ies: Extra information element(s) to add into Probe Response
1318 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1319 * Response frames or %NULL
1320 * @probe_resp: Probe Response frame template
1321 * @head_len: Length of @head
1322 * @tail_len: Length of @tail
1323 * @beacon_ies_len: Length of beacon_ies in octets
1324 * @proberesp_ies_len: Length of proberesp_ies in octets
1325 * @proberesp_ies_len: Length of proberesp_ies in octets
1326 * @probe_resp_len: Length of probe response template (@probe_resp)
1328 struct beacon_data {
1335 size_t head_len, tail_len;
1336 size_t beacon_ies_len;
1337 size_t proberesp_ies_len;
1338 size_t assocresp_ies_len;
1339 size_t probe_resp_len;
1343 * struct csa_settings - Settings for channel switch command
1344 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1345 * @block_tx: 1 - block transmission for CSA period
1346 * @freq_params: Next channel frequency parameter
1347 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1348 * @beacon_after: Next beacon/probe resp/asooc resp info
1349 * @counter_offset_beacon: Offset to the count field in beacon's tail
1350 * @counter_offset_presp: Offset to the count field in probe resp.
1352 struct csa_settings {
1356 struct hostapd_freq_params freq_params;
1357 struct beacon_data beacon_csa;
1358 struct beacon_data beacon_after;
1360 u16 counter_offset_beacon;
1361 u16 counter_offset_presp;
1364 /* TDLS peer capabilities for send_tdls_mgmt() */
1365 enum tdls_peer_capability {
1366 TDLS_PEER_HT = BIT(0),
1367 TDLS_PEER_VHT = BIT(1),
1368 TDLS_PEER_WMM = BIT(2),
1371 /* valid info in the wmm_params struct */
1372 enum wmm_params_valid_info {
1373 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1377 * struct wmm_params - WMM parameterss configured for this association
1378 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1379 * of the struct contain valid information.
1380 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1381 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1388 #ifdef CONFIG_MACSEC
1389 struct macsec_init_params {
1390 Boolean always_include_sci;
1394 #endif /* CONFIG_MACSEC */
1396 enum drv_br_port_attr {
1397 DRV_BR_PORT_ATTR_PROXYARP,
1398 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1401 enum drv_br_net_param {
1402 DRV_BR_NET_PARAM_GARP_ACCEPT,
1407 * struct wpa_driver_ops - Driver interface API definition
1409 * This structure defines the API that each driver interface needs to implement
1410 * for core wpa_supplicant code. All driver specific functionality is captured
1413 struct wpa_driver_ops {
1414 /** Name of the driver interface */
1416 /** One line description of the driver interface */
1420 * get_bssid - Get the current BSSID
1421 * @priv: private driver interface data
1422 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1424 * Returns: 0 on success, -1 on failure
1426 * Query kernel driver for the current BSSID and copy it to bssid.
1427 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1430 int (*get_bssid)(void *priv, u8 *bssid);
1433 * get_ssid - Get the current SSID
1434 * @priv: private driver interface data
1435 * @ssid: buffer for SSID (at least 32 bytes)
1437 * Returns: Length of the SSID on success, -1 on failure
1439 * Query kernel driver for the current SSID and copy it to ssid.
1440 * Returning zero is recommended if the STA is not associated.
1442 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1443 * can, at least in theory, contain control characters (including nul)
1444 * and as such, should be processed as binary data, not a printable
1447 int (*get_ssid)(void *priv, u8 *ssid);
1450 * set_key - Configure encryption key
1451 * @ifname: Interface name (for multi-SSID/VLAN support)
1452 * @priv: private driver interface data
1453 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1454 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1455 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1456 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1457 * %WPA_ALG_BIP_CMAC_256);
1458 * %WPA_ALG_NONE clears the key.
1459 * @addr: Address of the peer STA (BSSID of the current AP when setting
1460 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1461 * broadcast keys, %NULL for default keys that are used both for
1462 * broadcast and unicast; when clearing keys, %NULL is used to
1463 * indicate that both the broadcast-only and default key of the
1464 * specified key index is to be cleared
1465 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1467 * @set_tx: configure this key as the default Tx key (only used when
1468 * driver does not support separate unicast/individual key
1469 * @seq: sequence number/packet number, seq_len octets, the next
1470 * packet number to be used for in replay protection; configured
1471 * for Rx keys (in most cases, this is only used with broadcast
1472 * keys and set to zero for unicast keys); %NULL if not set
1473 * @seq_len: length of the seq, depends on the algorithm:
1474 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1475 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1477 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1478 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1480 * Returns: 0 on success, -1 on failure
1482 * Configure the given key for the kernel driver. If the driver
1483 * supports separate individual keys (4 default keys + 1 individual),
1484 * addr can be used to determine whether the key is default or
1485 * individual. If only 4 keys are supported, the default key with key
1486 * index 0 is used as the individual key. STA must be configured to use
1487 * it as the default Tx key (set_tx is set) and accept Rx for all the
1488 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1489 * broadcast keys, so key index 0 is available for this kind of
1492 * Please note that TKIP keys include separate TX and RX MIC keys and
1493 * some drivers may expect them in different order than wpa_supplicant
1494 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1495 * will trigger Michael MIC errors. This can be fixed by changing the
1496 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1497 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1498 * example on how this can be done.
1500 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1501 const u8 *addr, int key_idx, int set_tx,
1502 const u8 *seq, size_t seq_len,
1503 const u8 *key, size_t key_len);
1506 * init - Initialize driver interface
1507 * @ctx: context to be used when calling wpa_supplicant functions,
1508 * e.g., wpa_supplicant_event()
1509 * @ifname: interface name, e.g., wlan0
1511 * Returns: Pointer to private data, %NULL on failure
1513 * Initialize driver interface, including event processing for kernel
1514 * driver events (e.g., associated, scan results, Michael MIC failure).
1515 * This function can allocate a private configuration data area for
1516 * @ctx, file descriptor, interface name, etc. information that may be
1517 * needed in future driver operations. If this is not used, non-NULL
1518 * value will need to be returned because %NULL is used to indicate
1519 * failure. The returned value will be used as 'void *priv' data for
1520 * all other driver_ops functions.
1522 * The main event loop (eloop.c) of wpa_supplicant can be used to
1523 * register callback for read sockets (eloop_register_read_sock()).
1525 * See below for more information about events and
1526 * wpa_supplicant_event() function.
1528 void * (*init)(void *ctx, const char *ifname);
1531 * deinit - Deinitialize driver interface
1532 * @priv: private driver interface data from init()
1534 * Shut down driver interface and processing of driver events. Free
1535 * private data buffer if one was allocated in init() handler.
1537 void (*deinit)(void *priv);
1540 * set_param - Set driver configuration parameters
1541 * @priv: private driver interface data from init()
1542 * @param: driver specific configuration parameters
1544 * Returns: 0 on success, -1 on failure
1546 * Optional handler for notifying driver interface about configuration
1547 * parameters (driver_param).
1549 int (*set_param)(void *priv, const char *param);
1552 * set_countermeasures - Enable/disable TKIP countermeasures
1553 * @priv: private driver interface data
1554 * @enabled: 1 = countermeasures enabled, 0 = disabled
1556 * Returns: 0 on success, -1 on failure
1558 * Configure TKIP countermeasures. When these are enabled, the driver
1559 * should drop all received and queued frames that are using TKIP.
1561 int (*set_countermeasures)(void *priv, int enabled);
1564 * deauthenticate - Request driver to deauthenticate
1565 * @priv: private driver interface data
1566 * @addr: peer address (BSSID of the AP)
1567 * @reason_code: 16-bit reason code to be sent in the deauthentication
1570 * Returns: 0 on success, -1 on failure
1572 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1575 * associate - Request driver to associate
1576 * @priv: private driver interface data
1577 * @params: association parameters
1579 * Returns: 0 on success, -1 on failure
1581 int (*associate)(void *priv,
1582 struct wpa_driver_associate_params *params);
1585 * add_pmkid - Add PMKSA cache entry to the driver
1586 * @priv: private driver interface data
1587 * @bssid: BSSID for the PMKSA cache entry
1588 * @pmkid: PMKID for the PMKSA cache entry
1590 * Returns: 0 on success, -1 on failure
1592 * This function is called when a new PMK is received, as a result of
1593 * either normal authentication or RSN pre-authentication.
1595 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1596 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1597 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1598 * driver_ops function does not need to be implemented. Likewise, if
1599 * the driver does not support WPA, this function is not needed.
1601 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1604 * remove_pmkid - Remove PMKSA cache entry to the driver
1605 * @priv: private driver interface data
1606 * @bssid: BSSID for the PMKSA cache entry
1607 * @pmkid: PMKID for the PMKSA cache entry
1609 * Returns: 0 on success, -1 on failure
1611 * This function is called when the supplicant drops a PMKSA cache
1612 * entry for any reason.
1614 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1615 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1616 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1617 * from wpa_supplicant, this driver_ops function does not need to be
1618 * implemented. Likewise, if the driver does not support WPA, this
1619 * function is not needed.
1621 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1624 * flush_pmkid - Flush PMKSA cache
1625 * @priv: private driver interface data
1627 * Returns: 0 on success, -1 on failure
1629 * This function is called when the supplicant drops all PMKSA cache
1630 * entries for any reason.
1632 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1633 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1634 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1635 * from wpa_supplicant, this driver_ops function does not need to be
1636 * implemented. Likewise, if the driver does not support WPA, this
1637 * function is not needed.
1639 int (*flush_pmkid)(void *priv);
1642 * get_capa - Get driver capabilities
1643 * @priv: private driver interface data
1645 * Returns: 0 on success, -1 on failure
1647 * Get driver/firmware/hardware capabilities.
1649 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1652 * poll - Poll driver for association information
1653 * @priv: private driver interface data
1655 * This is an option callback that can be used when the driver does not
1656 * provide event mechanism for association events. This is called when
1657 * receiving WPA EAPOL-Key messages that require association
1658 * information. The driver interface is supposed to generate associnfo
1659 * event before returning from this callback function. In addition, the
1660 * driver interface should generate an association event after having
1661 * sent out associnfo.
1663 void (*poll)(void *priv);
1666 * get_ifname - Get interface name
1667 * @priv: private driver interface data
1669 * Returns: Pointer to the interface name. This can differ from the
1670 * interface name used in init() call. Init() is called first.
1672 * This optional function can be used to allow the driver interface to
1673 * replace the interface name with something else, e.g., based on an
1674 * interface mapping from a more descriptive name.
1676 const char * (*get_ifname)(void *priv);
1679 * get_mac_addr - Get own MAC address
1680 * @priv: private driver interface data
1682 * Returns: Pointer to own MAC address or %NULL on failure
1684 * This optional function can be used to get the own MAC address of the
1685 * device from the driver interface code. This is only needed if the
1686 * l2_packet implementation for the OS does not provide easy access to
1688 const u8 * (*get_mac_addr)(void *priv);
1691 * send_eapol - Optional function for sending EAPOL packets
1692 * @priv: private driver interface data
1693 * @dest: Destination MAC address
1695 * @data: EAPOL packet starting with IEEE 802.1X header
1696 * @data_len: Size of the EAPOL packet
1698 * Returns: 0 on success, -1 on failure
1700 * This optional function can be used to override l2_packet operations
1701 * with driver specific functionality. If this function pointer is set,
1702 * l2_packet module is not used at all and the driver interface code is
1703 * responsible for receiving and sending all EAPOL packets. The
1704 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1705 * event. The driver interface is required to implement get_mac_addr()
1706 * handler if send_eapol() is used.
1708 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1709 const u8 *data, size_t data_len);
1712 * set_operstate - Sets device operating state to DORMANT or UP
1713 * @priv: private driver interface data
1714 * @state: 0 = dormant, 1 = up
1715 * Returns: 0 on success, -1 on failure
1717 * This is an optional function that can be used on operating systems
1718 * that support a concept of controlling network device state from user
1719 * space applications. This function, if set, gets called with
1720 * state = 1 when authentication has been completed and with state = 0
1721 * when connection is lost.
1723 int (*set_operstate)(void *priv, int state);
1726 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1727 * @priv: Private driver interface data
1728 * @addr: Address of the station for which to set protection (may be
1729 * %NULL for group keys)
1730 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1731 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1732 * Returns: 0 on success, -1 on failure
1734 * This is an optional function that can be used to set the driver to
1735 * require protection for Tx and/or Rx frames. This uses the layer
1736 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1737 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1738 * set protection operation; instead, they set protection implicitly
1739 * based on configured keys.
1741 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1745 * get_hw_feature_data - Get hardware support data (channels and rates)
1746 * @priv: Private driver interface data
1747 * @num_modes: Variable for returning the number of returned modes
1748 * flags: Variable for returning hardware feature flags
1749 * Returns: Pointer to allocated hardware data on success or %NULL on
1750 * failure. Caller is responsible for freeing this.
1752 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1757 * send_mlme - Send management frame from MLME
1758 * @priv: Private driver interface data
1759 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1760 * @data_len: Size of the management frame
1761 * @noack: Do not wait for this frame to be acked (disable retries)
1762 * Returns: 0 on success, -1 on failure
1764 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1768 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1769 * @priv: Private driver interface data
1770 * @md: Mobility domain (2 octets) (also included inside ies)
1771 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1772 * @ies_len: Length of FT IEs in bytes
1773 * Returns: 0 on success, -1 on failure
1775 * The supplicant uses this callback to let the driver know that keying
1776 * material for FT is available and that the driver can use the
1777 * provided IEs in the next message in FT authentication sequence.
1779 * This function is only needed for driver that support IEEE 802.11r
1780 * (Fast BSS Transition).
1782 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1786 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1787 * @priv: Private driver interface data
1788 * @action: Action field value
1789 * @target_ap: Target AP address
1790 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1791 * @ies_len: Length of FT IEs in bytes
1792 * Returns: 0 on success, -1 on failure
1794 * The supplicant uses this callback to request the driver to transmit
1795 * an FT Action frame (action category 6) for over-the-DS fast BSS
1798 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1799 const u8 *ies, size_t ies_len);
1802 * get_scan_results2 - Fetch the latest scan results
1803 * @priv: private driver interface data
1805 * Returns: Allocated buffer of scan results (caller is responsible for
1806 * freeing the data structure) on success, NULL on failure
1808 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1811 * set_country - Set country
1812 * @priv: Private driver interface data
1813 * @alpha2: country to which to switch to
1814 * Returns: 0 on success, -1 on failure
1816 * This function is for drivers which support some form
1817 * of setting a regulatory domain.
1819 int (*set_country)(void *priv, const char *alpha2);
1822 * get_country - Get country
1823 * @priv: Private driver interface data
1824 * @alpha2: Buffer for returning country code (at least 3 octets)
1825 * Returns: 0 on success, -1 on failure
1827 int (*get_country)(void *priv, char *alpha2);
1830 * global_init - Global driver initialization
1831 * Returns: Pointer to private data (global), %NULL on failure
1833 * This optional function is called to initialize the driver wrapper
1834 * for global data, i.e., data that applies to all interfaces. If this
1835 * function is implemented, global_deinit() will also need to be
1836 * implemented to free the private data. The driver will also likely
1837 * use init2() function instead of init() to get the pointer to global
1838 * data available to per-interface initializer.
1840 void * (*global_init)(void);
1843 * global_deinit - Global driver deinitialization
1844 * @priv: private driver global data from global_init()
1846 * Terminate any global driver related functionality and free the
1847 * global data structure.
1849 void (*global_deinit)(void *priv);
1852 * init2 - Initialize driver interface (with global data)
1853 * @ctx: context to be used when calling wpa_supplicant functions,
1854 * e.g., wpa_supplicant_event()
1855 * @ifname: interface name, e.g., wlan0
1856 * @global_priv: private driver global data from global_init()
1857 * Returns: Pointer to private data, %NULL on failure
1859 * This function can be used instead of init() if the driver wrapper
1862 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1865 * get_interfaces - Get information about available interfaces
1866 * @global_priv: private driver global data from global_init()
1867 * Returns: Allocated buffer of interface information (caller is
1868 * responsible for freeing the data structure) on success, NULL on
1871 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1874 * scan2 - Request the driver to initiate scan
1875 * @priv: private driver interface data
1876 * @params: Scan parameters
1878 * Returns: 0 on success, -1 on failure
1880 * Once the scan results are ready, the driver should report scan
1881 * results event for wpa_supplicant which will eventually request the
1882 * results with wpa_driver_get_scan_results2().
1884 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1887 * authenticate - Request driver to authenticate
1888 * @priv: private driver interface data
1889 * @params: authentication parameters
1890 * Returns: 0 on success, -1 on failure
1892 * This is an optional function that can be used with drivers that
1893 * support separate authentication and association steps, i.e., when
1894 * wpa_supplicant can act as the SME. If not implemented, associate()
1895 * function is expected to take care of IEEE 802.11 authentication,
1898 int (*authenticate)(void *priv,
1899 struct wpa_driver_auth_params *params);
1902 * set_ap - Set Beacon and Probe Response information for AP mode
1903 * @priv: Private driver interface data
1904 * @params: Parameters to use in AP mode
1906 * This function is used to configure Beacon template and/or extra IEs
1907 * to add for Beacon and Probe Response frames for the driver in
1908 * AP mode. The driver is responsible for building the full Beacon
1909 * frame by concatenating the head part with TIM IE generated by the
1910 * driver/firmware and finishing with the tail part. Depending on the
1911 * driver architectue, this can be done either by using the full
1912 * template or the set of additional IEs (e.g., WPS and P2P IE).
1913 * Similarly, Probe Response processing depends on the driver design.
1914 * If the driver (or firmware) takes care of replying to Probe Request
1915 * frames, the extra IEs provided here needs to be added to the Probe
1918 * Returns: 0 on success, -1 on failure
1920 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1923 * set_acl - Set ACL in AP mode
1924 * @priv: Private driver interface data
1925 * @params: Parameters to configure ACL
1926 * Returns: 0 on success, -1 on failure
1928 * This is used only for the drivers which support MAC address ACL.
1930 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1933 * hapd_init - Initialize driver interface (hostapd only)
1934 * @hapd: Pointer to hostapd context
1935 * @params: Configuration for the driver wrapper
1936 * Returns: Pointer to private data, %NULL on failure
1938 * This function is used instead of init() or init2() when the driver
1939 * wrapper is used with hostapd.
1941 void * (*hapd_init)(struct hostapd_data *hapd,
1942 struct wpa_init_params *params);
1945 * hapd_deinit - Deinitialize driver interface (hostapd only)
1946 * @priv: Private driver interface data from hapd_init()
1948 void (*hapd_deinit)(void *priv);
1951 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1952 * @priv: Private driver interface data
1953 * @params: BSS parameters
1954 * Returns: 0 on success, -1 on failure
1956 * This is an optional function to configure the kernel driver to
1957 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1958 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1959 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1960 * for Beacon frames.
1962 * DEPRECATED - use set_ap() instead
1964 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1967 * set_privacy - Enable/disable privacy (AP only)
1968 * @priv: Private driver interface data
1969 * @enabled: 1 = privacy enabled, 0 = disabled
1970 * Returns: 0 on success, -1 on failure
1972 * This is an optional function to configure privacy field in the
1973 * kernel driver for Beacon frames. This can be left undefined (set to
1974 * %NULL) if the driver uses the Beacon template from set_ap().
1976 * DEPRECATED - use set_ap() instead
1978 int (*set_privacy)(void *priv, int enabled);
1981 * get_seqnum - Fetch the current TSC/packet number (AP only)
1982 * @ifname: The interface name (main or virtual)
1983 * @priv: Private driver interface data
1984 * @addr: MAC address of the station or %NULL for group keys
1986 * @seq: Buffer for returning the latest used TSC/packet number
1987 * Returns: 0 on success, -1 on failure
1989 * This function is used to fetch the last used TSC/packet number for
1990 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1991 * keys, so there is no strict requirement on implementing support for
1992 * unicast keys (i.e., addr != %NULL).
1994 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1998 * flush - Flush all association stations (AP only)
1999 * @priv: Private driver interface data
2000 * Returns: 0 on success, -1 on failure
2002 * This function requests the driver to disassociate all associated
2003 * stations. This function does not need to be implemented if the
2004 * driver does not process association frames internally.
2006 int (*flush)(void *priv);
2009 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2010 * @priv: Private driver interface data
2011 * @elem: Information elements
2012 * @elem_len: Length of the elem buffer in octets
2013 * Returns: 0 on success, -1 on failure
2015 * This is an optional function to add information elements in the
2016 * kernel driver for Beacon and Probe Response frames. This can be left
2017 * undefined (set to %NULL) if the driver uses the Beacon template from
2020 * DEPRECATED - use set_ap() instead
2022 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2025 * read_sta_data - Fetch station data
2026 * @priv: Private driver interface data
2027 * @data: Buffer for returning station information
2028 * @addr: MAC address of the station
2029 * Returns: 0 on success, -1 on failure
2031 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2035 * hapd_send_eapol - Send an EAPOL packet (AP only)
2036 * @priv: private driver interface data
2037 * @addr: Destination MAC address
2038 * @data: EAPOL packet starting with IEEE 802.1X header
2039 * @data_len: Length of the EAPOL packet in octets
2040 * @encrypt: Whether the frame should be encrypted
2041 * @own_addr: Source MAC address
2042 * @flags: WPA_STA_* flags for the destination station
2044 * Returns: 0 on success, -1 on failure
2046 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2047 size_t data_len, int encrypt,
2048 const u8 *own_addr, u32 flags);
2051 * sta_deauth - Deauthenticate a station (AP only)
2052 * @priv: Private driver interface data
2053 * @own_addr: Source address and BSSID for the Deauthentication frame
2054 * @addr: MAC address of the station to deauthenticate
2055 * @reason: Reason code for the Deauthentiation frame
2056 * Returns: 0 on success, -1 on failure
2058 * This function requests a specific station to be deauthenticated and
2059 * a Deauthentication frame to be sent to it.
2061 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2065 * sta_disassoc - Disassociate a station (AP only)
2066 * @priv: Private driver interface data
2067 * @own_addr: Source address and BSSID for the Disassociation frame
2068 * @addr: MAC address of the station to disassociate
2069 * @reason: Reason code for the Disassociation frame
2070 * Returns: 0 on success, -1 on failure
2072 * This function requests a specific station to be disassociated and
2073 * a Disassociation frame to be sent to it.
2075 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2079 * sta_remove - Remove a station entry (AP only)
2080 * @priv: Private driver interface data
2081 * @addr: MAC address of the station to be removed
2082 * Returns: 0 on success, -1 on failure
2084 int (*sta_remove)(void *priv, const u8 *addr);
2087 * hapd_get_ssid - Get the current SSID (AP only)
2088 * @priv: Private driver interface data
2089 * @buf: Buffer for returning the SSID
2090 * @len: Maximum length of the buffer
2091 * Returns: Length of the SSID on success, -1 on failure
2093 * This function need not be implemented if the driver uses Beacon
2094 * template from set_ap() and does not reply to Probe Request frames.
2096 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2099 * hapd_set_ssid - Set SSID (AP only)
2100 * @priv: Private driver interface data
2102 * @len: Length of the SSID in octets
2103 * Returns: 0 on success, -1 on failure
2105 * DEPRECATED - use set_ap() instead
2107 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2110 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2111 * @priv: Private driver interface data
2112 * @enabled: 1 = countermeasures enabled, 0 = disabled
2113 * Returns: 0 on success, -1 on failure
2115 * This need not be implemented if the driver does not take care of
2116 * association processing.
2118 int (*hapd_set_countermeasures)(void *priv, int enabled);
2121 * sta_add - Add a station entry
2122 * @priv: Private driver interface data
2123 * @params: Station parameters
2124 * Returns: 0 on success, -1 on failure
2126 * This function is used to add a station entry to the driver once the
2127 * station has completed association. This is only used if the driver
2128 * does not take care of association processing.
2130 * With TDLS, this function is also used to add or set (params->set 1)
2131 * TDLS peer entries.
2133 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2136 * get_inact_sec - Get station inactivity duration (AP only)
2137 * @priv: Private driver interface data
2138 * @addr: Station address
2139 * Returns: Number of seconds station has been inactive, -1 on failure
2141 int (*get_inact_sec)(void *priv, const u8 *addr);
2144 * sta_clear_stats - Clear station statistics (AP only)
2145 * @priv: Private driver interface data
2146 * @addr: Station address
2147 * Returns: 0 on success, -1 on failure
2149 int (*sta_clear_stats)(void *priv, const u8 *addr);
2152 * set_freq - Set channel/frequency (AP only)
2153 * @priv: Private driver interface data
2154 * @freq: Channel parameters
2155 * Returns: 0 on success, -1 on failure
2157 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2160 * set_rts - Set RTS threshold
2161 * @priv: Private driver interface data
2162 * @rts: RTS threshold in octets
2163 * Returns: 0 on success, -1 on failure
2165 int (*set_rts)(void *priv, int rts);
2168 * set_frag - Set fragmentation threshold
2169 * @priv: Private driver interface data
2170 * @frag: Fragmentation threshold in octets
2171 * Returns: 0 on success, -1 on failure
2173 int (*set_frag)(void *priv, int frag);
2176 * sta_set_flags - Set station flags (AP only)
2177 * @priv: Private driver interface data
2178 * @addr: Station address
2179 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2180 * @flags_or: Bitmap of WPA_STA_* flags to add
2181 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2182 * Returns: 0 on success, -1 on failure
2184 int (*sta_set_flags)(void *priv, const u8 *addr,
2185 int total_flags, int flags_or, int flags_and);
2188 * set_tx_queue_params - Set TX queue parameters
2189 * @priv: Private driver interface data
2190 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2194 * @burst_time: Maximum length for bursting in 0.1 msec units
2196 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2197 int cw_max, int burst_time);
2200 * if_add - Add a virtual interface
2201 * @priv: Private driver interface data
2202 * @type: Interface type
2203 * @ifname: Interface name for the new virtual interface
2204 * @addr: Local address to use for the interface or %NULL to use the
2205 * parent interface address
2206 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2207 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2208 * not allowed (applies only to %WPA_IF_AP_BSS type)
2209 * @force_ifname: Buffer for returning an interface name that the
2210 * driver ended up using if it differs from the requested ifname
2211 * @if_addr: Buffer for returning the allocated interface address
2212 * (this may differ from the requested addr if the driver cannot
2213 * change interface address)
2214 * @bridge: Bridge interface to use or %NULL if no bridge configured
2215 * @use_existing: Whether to allow existing interface to be used
2216 * Returns: 0 on success, -1 on failure
2218 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2219 const char *ifname, const u8 *addr, void *bss_ctx,
2220 void **drv_priv, char *force_ifname, u8 *if_addr,
2221 const char *bridge, int use_existing);
2224 * if_remove - Remove a virtual interface
2225 * @priv: Private driver interface data
2226 * @type: Interface type
2227 * @ifname: Interface name of the virtual interface to be removed
2228 * Returns: 0 on success, -1 on failure
2230 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2231 const char *ifname);
2234 * set_sta_vlan - Bind a station into a specific interface (AP only)
2235 * @priv: Private driver interface data
2236 * @ifname: Interface (main or virtual BSS or VLAN)
2237 * @addr: MAC address of the associated station
2239 * Returns: 0 on success, -1 on failure
2241 * This function is used to bind a station to a specific virtual
2242 * interface. It is only used if when virtual interfaces are supported,
2243 * e.g., to assign stations to different VLAN interfaces based on
2244 * information from a RADIUS server. This allows separate broadcast
2245 * domains to be used with a single BSS.
2247 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2251 * commit - Optional commit changes handler (AP only)
2252 * @priv: driver private data
2253 * Returns: 0 on success, -1 on failure
2255 * This optional handler function can be registered if the driver
2256 * interface implementation needs to commit changes (e.g., by setting
2257 * network interface up) at the end of initial configuration. If set,
2258 * this handler will be called after initial setup has been completed.
2260 int (*commit)(void *priv);
2263 * send_ether - Send an ethernet packet (AP only)
2264 * @priv: private driver interface data
2265 * @dst: Destination MAC address
2266 * @src: Source MAC address
2268 * @data: EAPOL packet starting with IEEE 802.1X header
2269 * @data_len: Length of the EAPOL packet in octets
2270 * Returns: 0 on success, -1 on failure
2272 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2273 const u8 *data, size_t data_len);
2276 * set_radius_acl_auth - Notification of RADIUS ACL change
2277 * @priv: Private driver interface data
2278 * @mac: MAC address of the station
2279 * @accepted: Whether the station was accepted
2280 * @session_timeout: Session timeout for the station
2281 * Returns: 0 on success, -1 on failure
2283 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2284 u32 session_timeout);
2287 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2288 * @priv: Private driver interface data
2289 * @mac: MAC address of the station
2290 * Returns: 0 on success, -1 on failure
2292 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2295 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2296 * @priv: Private driver interface data
2297 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2298 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2300 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2301 * to remove extra IE(s)
2302 * Returns: 0 on success, -1 on failure
2304 * This is an optional function to add WPS IE in the kernel driver for
2305 * Beacon and Probe Response frames. This can be left undefined (set
2306 * to %NULL) if the driver uses the Beacon template from set_ap()
2307 * and does not process Probe Request frames. If the driver takes care
2308 * of (Re)Association frame processing, the assocresp buffer includes
2309 * WPS IE(s) that need to be added to (Re)Association Response frames
2310 * whenever a (Re)Association Request frame indicated use of WPS.
2312 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2313 * frames when operating as a GO. The driver is responsible for adding
2314 * timing related attributes (e.g., NoA) in addition to the IEs
2315 * included here by appending them after these buffers. This call is
2316 * also used to provide Probe Response IEs for P2P Listen state
2317 * operations for drivers that generate the Probe Response frames
2320 * DEPRECATED - use set_ap() instead
2322 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2323 const struct wpabuf *proberesp,
2324 const struct wpabuf *assocresp);
2327 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2328 * @priv: Private driver interface data
2329 * @authorized: Whether the port is authorized
2330 * Returns: 0 on success, -1 on failure
2332 int (*set_supp_port)(void *priv, int authorized);
2335 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2336 * @priv: Private driver interface data
2337 * @addr: MAC address of the associated station
2338 * @aid: Association ID
2339 * @val: 1 = bind to 4-address WDS; 0 = unbind
2340 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2341 * to indicate that bridge is not to be used
2342 * @ifname_wds: Buffer to return the interface name for the new WDS
2343 * station or %NULL to indicate name is not returned.
2344 * Returns: 0 on success, -1 on failure
2346 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2347 const char *bridge_ifname, char *ifname_wds);
2350 * send_action - Transmit an Action frame
2351 * @priv: Private driver interface data
2352 * @freq: Frequency (in MHz) of the channel
2353 * @wait: Time to wait off-channel for a response (in ms), or zero
2354 * @dst: Destination MAC address (Address 1)
2355 * @src: Source MAC address (Address 2)
2356 * @bssid: BSSID (Address 3)
2358 * @data_len: data length in octets
2359 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2360 * Returns: 0 on success, -1 on failure
2362 * This command can be used to request the driver to transmit an action
2363 * frame to the specified destination.
2365 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2366 * be transmitted on the given channel and the device will wait for a
2367 * response on that channel for the given wait time.
2369 * If the flag is not set, the wait time will be ignored. In this case,
2370 * if a remain-on-channel duration is in progress, the frame must be
2371 * transmitted on that channel; alternatively the frame may be sent on
2372 * the current operational channel (if in associated state in station
2373 * mode or while operating as an AP.)
2375 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2376 const u8 *dst, const u8 *src, const u8 *bssid,
2377 const u8 *data, size_t data_len, int no_cck);
2380 * send_action_cancel_wait - Cancel action frame TX wait
2381 * @priv: Private driver interface data
2383 * This command cancels the wait time associated with sending an action
2384 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2385 * set in the driver flags.
2387 void (*send_action_cancel_wait)(void *priv);
2390 * remain_on_channel - Remain awake on a channel
2391 * @priv: Private driver interface data
2392 * @freq: Frequency (in MHz) of the channel
2393 * @duration: Duration in milliseconds
2394 * Returns: 0 on success, -1 on failure
2396 * This command is used to request the driver to remain awake on the
2397 * specified channel for the specified duration and report received
2398 * Action frames with EVENT_RX_MGMT events. Optionally, received
2399 * Probe Request frames may also be requested to be reported by calling
2400 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2402 * The driver may not be at the requested channel when this function
2403 * returns, i.e., the return code is only indicating whether the
2404 * request was accepted. The caller will need to wait until the
2405 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2406 * completed the channel change. This may take some time due to other
2407 * need for the radio and the caller should be prepared to timing out
2408 * its wait since there are no guarantees on when this request can be
2411 int (*remain_on_channel)(void *priv, unsigned int freq,
2412 unsigned int duration);
2415 * cancel_remain_on_channel - Cancel remain-on-channel operation
2416 * @priv: Private driver interface data
2418 * This command can be used to cancel a remain-on-channel operation
2419 * before its originally requested duration has passed. This could be
2420 * used, e.g., when remain_on_channel() is used to request extra time
2421 * to receive a response to an Action frame and the response is
2422 * received when there is still unneeded time remaining on the
2423 * remain-on-channel operation.
2425 int (*cancel_remain_on_channel)(void *priv);
2428 * probe_req_report - Request Probe Request frames to be indicated
2429 * @priv: Private driver interface data
2430 * @report: Whether to report received Probe Request frames
2431 * Returns: 0 on success, -1 on failure (or if not supported)
2433 * This command can be used to request the driver to indicate when
2434 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2435 * Since this operation may require extra resources, e.g., due to less
2436 * optimal hardware/firmware RX filtering, many drivers may disable
2437 * Probe Request reporting at least in station mode. This command is
2438 * used to notify the driver when the Probe Request frames need to be
2439 * reported, e.g., during remain-on-channel operations.
2441 int (*probe_req_report)(void *priv, int report);
2444 * deinit_ap - Deinitialize AP mode
2445 * @priv: Private driver interface data
2446 * Returns: 0 on success, -1 on failure (or if not supported)
2448 * This optional function can be used to disable AP mode related
2449 * configuration. If the interface was not dynamically added,
2450 * change the driver mode to station mode to allow normal station
2451 * operations like scanning to be completed.
2453 int (*deinit_ap)(void *priv);
2456 * deinit_p2p_cli - Deinitialize P2P client mode
2457 * @priv: Private driver interface data
2458 * Returns: 0 on success, -1 on failure (or if not supported)
2460 * This optional function can be used to disable P2P client mode. If the
2461 * interface was not dynamically added, change the interface type back
2464 int (*deinit_p2p_cli)(void *priv);
2467 * suspend - Notification on system suspend/hibernate event
2468 * @priv: Private driver interface data
2470 void (*suspend)(void *priv);
2473 * resume - Notification on system resume/thaw event
2474 * @priv: Private driver interface data
2476 void (*resume)(void *priv);
2479 * signal_monitor - Set signal monitoring parameters
2480 * @priv: Private driver interface data
2481 * @threshold: Threshold value for signal change events; 0 = disabled
2482 * @hysteresis: Minimum change in signal strength before indicating a
2484 * Returns: 0 on success, -1 on failure (or if not supported)
2486 * This function can be used to configure monitoring of signal strength
2487 * with the current AP. Whenever signal strength drops below the
2488 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2489 * should be generated assuming the signal strength has changed at
2490 * least %hysteresis from the previously indicated signal change event.
2492 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2495 * send_frame - Send IEEE 802.11 frame (testing use only)
2496 * @priv: Private driver interface data
2497 * @data: IEEE 802.11 frame with IEEE 802.11 header
2498 * @data_len: Size of the frame
2499 * @encrypt: Whether to encrypt the frame (if keys are set)
2500 * Returns: 0 on success, -1 on failure
2502 * This function is only used for debugging purposes and is not
2503 * required to be implemented for normal operations.
2505 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2509 * shared_freq - Get operating frequency of shared interface(s)
2510 * @priv: Private driver interface data
2511 * Returns: Operating frequency in MHz, 0 if no shared operation in
2512 * use, or -1 on failure
2514 * This command can be used to request the current operating frequency
2515 * of any virtual interface that shares the same radio to provide
2516 * information for channel selection for other virtual interfaces.
2518 int (*shared_freq)(void *priv);
2521 * get_noa - Get current Notice of Absence attribute payload
2522 * @priv: Private driver interface data
2523 * @buf: Buffer for returning NoA
2524 * @buf_len: Buffer length in octets
2525 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2526 * advertized, or -1 on failure
2528 * This function is used to fetch the current Notice of Absence
2529 * attribute value from GO.
2531 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2534 * set_noa - Set Notice of Absence parameters for GO (testing)
2535 * @priv: Private driver interface data
2537 * @start: Start time in ms from next TBTT
2538 * @duration: Duration in ms
2539 * Returns: 0 on success or -1 on failure
2541 * This function is used to set Notice of Absence parameters for GO. It
2542 * is used only for testing. To disable NoA, all parameters are set to
2545 int (*set_noa)(void *priv, u8 count, int start, int duration);
2548 * set_p2p_powersave - Set P2P power save options
2549 * @priv: Private driver interface data
2550 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2551 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2552 * @ctwindow: 0.. = change (msec), -1 = no change
2553 * Returns: 0 on success or -1 on failure
2555 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2559 * ampdu - Enable/disable aggregation
2560 * @priv: Private driver interface data
2561 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2562 * Returns: 0 on success or -1 on failure
2564 int (*ampdu)(void *priv, int ampdu);
2567 * get_radio_name - Get physical radio name for the device
2568 * @priv: Private driver interface data
2569 * Returns: Radio name or %NULL if not known
2571 * The returned data must not be modified by the caller. It is assumed
2572 * that any interface that has the same radio name as another is
2573 * sharing the same physical radio. This information can be used to
2574 * share scan results etc. information between the virtual interfaces
2575 * to speed up various operations.
2577 const char * (*get_radio_name)(void *priv);
2580 * send_tdls_mgmt - for sending TDLS management packets
2581 * @priv: private driver interface data
2582 * @dst: Destination (peer) MAC address
2583 * @action_code: TDLS action code for the mssage
2584 * @dialog_token: Dialog Token to use in the message (if needed)
2585 * @status_code: Status Code or Reason Code to use (if needed)
2586 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2587 * @initiator: Is the current end the TDLS link initiator
2588 * @buf: TDLS IEs to add to the message
2589 * @len: Length of buf in octets
2590 * Returns: 0 on success, negative (<0) on failure
2592 * This optional function can be used to send packet to driver which is
2593 * responsible for receiving and sending all TDLS packets.
2595 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2596 u8 dialog_token, u16 status_code, u32 peer_capab,
2597 int initiator, const u8 *buf, size_t len);
2600 * tdls_oper - Ask the driver to perform high-level TDLS operations
2601 * @priv: Private driver interface data
2602 * @oper: TDLS high-level operation. See %enum tdls_oper
2603 * @peer: Destination (peer) MAC address
2604 * Returns: 0 on success, negative (<0) on failure
2606 * This optional function can be used to send high-level TDLS commands
2609 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2612 * wnm_oper - Notify driver of the WNM frame reception
2613 * @priv: Private driver interface data
2614 * @oper: WNM operation. See %enum wnm_oper
2615 * @peer: Destination (peer) MAC address
2616 * @buf: Buffer for the driver to fill in (for getting IE)
2617 * @buf_len: Return the len of buf
2618 * Returns: 0 on success, negative (<0) on failure
2620 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2621 u8 *buf, u16 *buf_len);
2624 * set_qos_map - Set QoS Map
2625 * @priv: Private driver interface data
2626 * @qos_map_set: QoS Map
2627 * @qos_map_set_len: Length of QoS Map
2629 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2630 u8 qos_map_set_len);
2633 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2634 * @priv: Private driver interface data
2635 * @ipaddr: IPv4 address for the neigh entry
2636 * @prefixlen: IPv4 address netmask prefix length
2637 * @addr: Corresponding MAC address
2638 * Returns: 0 on success, negative (<0) on failure
2640 int (*br_add_ip_neigh)(void *priv, be32 ipaddr, int prefixlen,
2644 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2645 * @priv: Private driver interface data
2646 * @ipaddr: IPv4 address for the neigh entry
2647 * Returns: 0 on success, negative (<0) on failure
2649 int (*br_delete_ip_neigh)(void *priv, be32 ipaddr);
2652 * br_port_set_attr - Set a bridge port attribute
2653 * @attr: Bridge port attribute to set
2654 * @val: Value to be set
2655 * Returns: 0 on success, negative (<0) on failure
2657 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2661 * br_port_set_attr - Set a bridge network parameter
2662 * @param: Bridge parameter to set
2663 * @val: Value to be set
2664 * Returns: 0 on success, negative (<0) on failure
2666 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2670 * set_wowlan - Set wake-on-wireless triggers
2671 * @priv: Private driver interface data
2672 * @triggers: wowlan triggers
2674 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2677 * signal_poll - Get current connection information
2678 * @priv: Private driver interface data
2679 * @signal_info: Connection info structure
2681 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2684 * set_authmode - Set authentication algorithm(s) for static WEP
2685 * @priv: Private driver interface data
2686 * @authmode: 1=Open System, 2=Shared Key, 3=both
2687 * Returns: 0 on success, -1 on failure
2689 * This function can be used to set authentication algorithms for AP
2690 * mode when static WEP is used. If the driver uses user space MLME/SME
2691 * implementation, there is no need to implement this function.
2693 * DEPRECATED - use set_ap() instead
2695 int (*set_authmode)(void *priv, int authmode);
2699 * driver_cmd - Execute driver-specific command
2700 * @priv: Private driver interface data
2701 * @cmd: Command to execute
2702 * @buf: Return buffer
2703 * @buf_len: Buffer length
2704 * Returns: 0 on success, -1 on failure
2706 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2707 #endif /* ANDROID */
2710 * vendor_cmd - Execute vendor specific command
2711 * @priv: Private driver interface data
2712 * @vendor_id: Vendor id
2713 * @subcmd: Vendor command id
2714 * @data: Vendor command parameters (%NULL if no parameters)
2715 * @data_len: Data length
2716 * @buf: Return buffer (%NULL to ignore reply)
2717 * Returns: 0 on success, negative (<0) on failure
2719 * This function handles vendor specific commands that are passed to
2720 * the driver/device. The command is identified by vendor id and
2721 * command id. Parameters can be passed as argument to the command
2722 * in the data buffer. Reply (if any) will be filled in the supplied
2725 * The exact driver behavior is driver interface and vendor specific. As
2726 * an example, this will be converted to a vendor specific cfg80211
2727 * command in case of the nl80211 driver interface.
2729 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2730 unsigned int subcmd, const u8 *data, size_t data_len,
2731 struct wpabuf *buf);
2734 * set_rekey_info - Set rekey information
2735 * @priv: Private driver interface data
2738 * @replay_ctr: Current EAPOL-Key Replay Counter
2740 * This optional function can be used to provide information for the
2741 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2742 * while the host (including wpa_supplicant) is sleeping.
2744 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2745 const u8 *replay_ctr);
2748 * sta_assoc - Station association indication
2749 * @priv: Private driver interface data
2750 * @own_addr: Source address and BSSID for association frame
2751 * @addr: MAC address of the station to associate
2752 * @reassoc: flag to indicate re-association
2753 * @status: association response status code
2754 * @ie: assoc response ie buffer
2755 * @len: ie buffer length
2756 * Returns: 0 on success, -1 on failure
2758 * This function indicates the driver to send (Re)Association
2759 * Response frame to the station.
2761 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2762 int reassoc, u16 status, const u8 *ie, size_t len);
2765 * sta_auth - Station authentication indication
2766 * @priv: Private driver interface data
2767 * @own_addr: Source address and BSSID for authentication frame
2768 * @addr: MAC address of the station to associate
2769 * @seq: authentication sequence number
2770 * @status: authentication response status code
2771 * @ie: authentication frame ie buffer
2772 * @len: ie buffer length
2774 * This function indicates the driver to send Authentication frame
2777 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2778 u16 seq, u16 status, const u8 *ie, size_t len);
2781 * add_tspec - Add traffic stream
2782 * @priv: Private driver interface data
2783 * @addr: MAC address of the station to associate
2784 * @tspec_ie: tspec ie buffer
2785 * @tspec_ielen: tspec ie length
2786 * Returns: 0 on success, -1 on failure
2788 * This function adds the traffic steam for the station
2789 * and fills the medium_time in tspec_ie.
2791 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2792 size_t tspec_ielen);
2795 * add_sta_node - Add a station node in the driver
2796 * @priv: Private driver interface data
2797 * @addr: MAC address of the station to add
2798 * @auth_alg: authentication algorithm used by the station
2799 * Returns: 0 on success, -1 on failure
2801 * This function adds the station node in the driver, when
2802 * the station gets added by FT-over-DS.
2804 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2807 * sched_scan - Request the driver to initiate scheduled scan
2808 * @priv: Private driver interface data
2809 * @params: Scan parameters
2810 * @interval: Interval between scan cycles in milliseconds
2811 * Returns: 0 on success, -1 on failure
2813 * This operation should be used for scheduled scan offload to
2814 * the hardware. Every time scan results are available, the
2815 * driver should report scan results event for wpa_supplicant
2816 * which will eventually request the results with
2817 * wpa_driver_get_scan_results2(). This operation is optional
2818 * and if not provided or if it returns -1, we fall back to
2819 * normal host-scheduled scans.
2821 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2825 * stop_sched_scan - Request the driver to stop a scheduled scan
2826 * @priv: Private driver interface data
2827 * Returns: 0 on success, -1 on failure
2829 * This should cause the scheduled scan to be stopped and
2830 * results should stop being sent. Must be supported if
2831 * sched_scan is supported.
2833 int (*stop_sched_scan)(void *priv);
2836 * poll_client - Probe (null data or such) the given station
2837 * @priv: Private driver interface data
2838 * @own_addr: MAC address of sending interface
2839 * @addr: MAC address of the station to probe
2840 * @qos: Indicates whether station is QoS station
2842 * This function is used to verify whether an associated station is
2843 * still present. This function does not need to be implemented if the
2844 * driver provides such inactivity polling mechanism.
2846 void (*poll_client)(void *priv, const u8 *own_addr,
2847 const u8 *addr, int qos);
2850 * radio_disable - Disable/enable radio
2851 * @priv: Private driver interface data
2852 * @disabled: 1=disable 0=enable radio
2853 * Returns: 0 on success, -1 on failure
2855 * This optional command is for testing purposes. It can be used to
2856 * disable the radio on a testbed device to simulate out-of-radio-range
2859 int (*radio_disable)(void *priv, int disabled);
2862 * switch_channel - Announce channel switch and migrate the GO to the
2864 * @priv: Private driver interface data
2865 * @settings: Settings for CSA period and new channel
2866 * Returns: 0 on success, -1 on failure
2868 * This function is used to move the GO to the legacy STA channel to
2869 * avoid frequency conflict in single channel concurrency.
2871 int (*switch_channel)(void *priv, struct csa_settings *settings);
2874 * add_tx_ts - Add traffic stream
2875 * @priv: Private driver interface data
2876 * @tsid: Traffic stream ID
2877 * @addr: Receiver address
2878 * @user_prio: User priority of the traffic stream
2879 * @admitted_time: Admitted time for this TS in units of
2880 * 32 microsecond periods (per second).
2881 * Returns: 0 on success, -1 on failure
2883 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
2887 * del_tx_ts - Delete traffic stream
2888 * @priv: Private driver interface data
2889 * @tsid: Traffic stream ID
2890 * @addr: Receiver address
2891 * Returns: 0 on success, -1 on failure
2893 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
2896 * start_dfs_cac - Listen for radar interference on the channel
2897 * @priv: Private driver interface data
2898 * @freq: Channel parameters
2899 * Returns: 0 on success, -1 on failure
2901 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
2904 * stop_ap - Removes beacon from AP
2905 * @priv: Private driver interface data
2906 * Returns: 0 on success, -1 on failure (or if not supported)
2908 * This optional function can be used to disable AP mode related
2909 * configuration. Unlike deinit_ap, it does not change to station
2912 int (*stop_ap)(void *priv);
2915 * get_survey - Retrieve survey data
2916 * @priv: Private driver interface data
2917 * @freq: If set, survey data for the specified frequency is only
2918 * being requested. If not set, all survey data is requested.
2919 * Returns: 0 on success, -1 on failure
2921 * Use this to retrieve:
2923 * - the observed channel noise floor
2924 * - the amount of time we have spent on the channel
2925 * - the amount of time during which we have spent on the channel that
2926 * the radio has determined the medium is busy and we cannot
2928 * - the amount of time we have spent receiving data
2929 * - the amount of time we have spent transmitting data
2931 * This data can be used for spectrum heuristics. One example is
2932 * Automatic Channel Selection (ACS). The channel survey data is
2933 * kept on a linked list on the channel data, one entry is added
2934 * for each survey. The min_nf of the channel is updated for each
2937 int (*get_survey)(void *priv, unsigned int freq);
2940 * status - Get driver interface status information
2941 * @priv: Private driver interface data
2942 * @buf: Buffer for printing tou the status information
2943 * @buflen: Maximum length of the buffer
2944 * Returns: Length of written status information or -1 on failure
2946 int (*status)(void *priv, char *buf, size_t buflen);
2949 * roaming - Set roaming policy for driver-based BSS selection
2950 * @priv: Private driver interface data
2951 * @allowed: Whether roaming within ESS is allowed
2952 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
2953 * Returns: Length of written status information or -1 on failure
2955 * This optional callback can be used to update roaming policy from the
2956 * associate() command (bssid being set there indicates that the driver
2957 * should not roam before getting this roaming() call to allow roaming.
2958 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
2959 * capability, roaming policy is handled within wpa_supplicant and there
2960 * is no need to implement or react to this callback.
2962 int (*roaming)(void *priv, int allowed, const u8 *bssid);
2965 * set_mac_addr - Set MAC address
2966 * @priv: Private driver interface data
2967 * @addr: MAC address to use or %NULL for setting back to permanent
2968 * Returns: 0 on success, -1 on failure
2970 int (*set_mac_addr)(void *priv, const u8 *addr);
2972 #ifdef CONFIG_MACSEC
2973 int (*macsec_init)(void *priv, struct macsec_init_params *params);
2975 int (*macsec_deinit)(void *priv);
2978 * enable_protect_frames - Set protect frames status
2979 * @priv: Private driver interface data
2980 * @enabled: TRUE = protect frames enabled
2981 * FALSE = protect frames disabled
2982 * Returns: 0 on success, -1 on failure (or if not supported)
2984 int (*enable_protect_frames)(void *priv, Boolean enabled);
2987 * set_replay_protect - Set replay protect status and window size
2988 * @priv: Private driver interface data
2989 * @enabled: TRUE = replay protect enabled
2990 * FALSE = replay protect disabled
2991 * @window: replay window size, valid only when replay protect enabled
2992 * Returns: 0 on success, -1 on failure (or if not supported)
2994 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
2997 * set_current_cipher_suite - Set current cipher suite
2998 * @priv: Private driver interface data
2999 * @cs: EUI64 identifier
3000 * @cs_len: Length of the cs buffer in octets
3001 * Returns: 0 on success, -1 on failure (or if not supported)
3003 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3007 * enable_controlled_port - Set controlled port status
3008 * @priv: Private driver interface data
3009 * @enabled: TRUE = controlled port enabled
3010 * FALSE = controlled port disabled
3011 * Returns: 0 on success, -1 on failure (or if not supported)
3013 int (*enable_controlled_port)(void *priv, Boolean enabled);
3016 * get_receive_lowest_pn - Get receive lowest pn
3017 * @priv: Private driver interface data
3018 * @channel: secure channel
3019 * @an: association number
3020 * @lowest_pn: lowest accept pn
3021 * Returns: 0 on success, -1 on failure (or if not supported)
3023 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3027 * get_transmit_next_pn - Get transmit next pn
3028 * @priv: Private driver interface data
3029 * @channel: secure channel
3030 * @an: association number
3032 * Returns: 0 on success, -1 on failure (or if not supported)
3034 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3038 * set_transmit_next_pn - Set transmit next pn
3039 * @priv: Private driver interface data
3040 * @channel: secure channel
3041 * @an: association number
3043 * Returns: 0 on success, -1 on failure (or if not supported)
3045 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3049 * get_available_receive_sc - get available receive channel
3050 * @priv: Private driver interface data
3051 * @channel: secure channel
3052 * Returns: 0 on success, -1 on failure (or if not supported)
3054 int (*get_available_receive_sc)(void *priv, u32 *channel);
3057 * create_receive_sc - create secure channel for receiving
3058 * @priv: Private driver interface data
3059 * @channel: secure channel
3060 * @sci_addr: secure channel identifier - address
3061 * @sci_port: secure channel identifier - port
3062 * @conf_offset: confidentiality offset (0, 30, or 50)
3063 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3065 * Returns: 0 on success, -1 on failure (or if not supported)
3067 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3068 u16 sci_port, unsigned int conf_offset,
3072 * delete_receive_sc - delete secure connection for receiving
3073 * @priv: private driver interface data from init()
3074 * @channel: secure channel
3075 * Returns: 0 on success, -1 on failure
3077 int (*delete_receive_sc)(void *priv, u32 channel);
3080 * create_receive_sa - create secure association for receive
3081 * @priv: private driver interface data from init()
3082 * @channel: secure channel
3083 * @an: association number
3084 * @lowest_pn: the lowest packet number can be received
3085 * @sak: the secure association key
3086 * Returns: 0 on success, -1 on failure
3088 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3089 u32 lowest_pn, const u8 *sak);
3092 * enable_receive_sa - enable the SA for receive
3093 * @priv: private driver interface data from init()
3094 * @channel: secure channel
3095 * @an: association number
3096 * Returns: 0 on success, -1 on failure
3098 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3101 * disable_receive_sa - disable SA for receive
3102 * @priv: private driver interface data from init()
3103 * @channel: secure channel index
3104 * @an: association number
3105 * Returns: 0 on success, -1 on failure
3107 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3110 * get_available_transmit_sc - get available transmit channel
3111 * @priv: Private driver interface data
3112 * @channel: secure channel
3113 * Returns: 0 on success, -1 on failure (or if not supported)
3115 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3118 * create_transmit_sc - create secure connection for transmit
3119 * @priv: private driver interface data from init()
3120 * @channel: secure channel
3121 * @sci_addr: secure channel identifier - address
3122 * @sci_port: secure channel identifier - port
3123 * Returns: 0 on success, -1 on failure
3125 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3126 u16 sci_port, unsigned int conf_offset);
3129 * delete_transmit_sc - delete secure connection for transmit
3130 * @priv: private driver interface data from init()
3131 * @channel: secure channel
3132 * Returns: 0 on success, -1 on failure
3134 int (*delete_transmit_sc)(void *priv, u32 channel);
3137 * create_transmit_sa - create secure association for transmit
3138 * @priv: private driver interface data from init()
3139 * @channel: secure channel index
3140 * @an: association number
3141 * @next_pn: the packet number used as next transmit packet
3142 * @confidentiality: True if the SA is to provide confidentiality
3143 * as well as integrity
3144 * @sak: the secure association key
3145 * Returns: 0 on success, -1 on failure
3147 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3148 Boolean confidentiality, const u8 *sak);
3151 * enable_transmit_sa - enable SA for transmit
3152 * @priv: private driver interface data from init()
3153 * @channel: secure channel
3154 * @an: association number
3155 * Returns: 0 on success, -1 on failure
3157 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3160 * disable_transmit_sa - disable SA for transmit
3161 * @priv: private driver interface data from init()
3162 * @channel: secure channel
3163 * @an: association number
3164 * Returns: 0 on success, -1 on failure
3166 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3167 #endif /* CONFIG_MACSEC */
3170 * init_mesh - Driver specific initialization for mesh
3171 * @priv: Private driver interface data
3172 * Returns: 0 on success, -1 on failure
3174 int (*init_mesh)(void *priv);
3177 * join_mesh - Join a mesh network
3178 * @priv: Private driver interface data
3179 * @params: Mesh configuration parameters
3180 * Returns: 0 on success, -1 on failure
3182 int (*join_mesh)(void *priv,
3183 struct wpa_driver_mesh_join_params *params);
3186 * leave_mesh - Leave a mesh network
3187 * @priv: Private driver interface data
3188 * Returns 0 on success, -1 on failure
3190 int (*leave_mesh)(void *priv);
3195 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3197 enum wpa_event_type {
3199 * EVENT_ASSOC - Association completed
3201 * This event needs to be delivered when the driver completes IEEE
3202 * 802.11 association or reassociation successfully.
3203 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3204 * after this event has been generated. In addition, optional
3205 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3206 * more information about the association. If the driver interface gets
3207 * both of these events at the same time, it can also include the
3208 * assoc_info data in EVENT_ASSOC call.
3213 * EVENT_DISASSOC - Association lost
3215 * This event should be called when association is lost either due to
3216 * receiving deauthenticate or disassociate frame from the AP or when
3217 * sending either of these frames to the current AP. If the driver
3218 * supports separate deauthentication event, EVENT_DISASSOC should only
3219 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3220 * In AP mode, union wpa_event_data::disassoc_info is required.
3225 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3227 * This event must be delivered when a Michael MIC error is detected by
3228 * the local driver. Additional data for event processing is
3229 * provided with union wpa_event_data::michael_mic_failure. This
3230 * information is used to request new encyption key and to initiate
3231 * TKIP countermeasures if needed.
3233 EVENT_MICHAEL_MIC_FAILURE,
3236 * EVENT_SCAN_RESULTS - Scan results available
3238 * This event must be called whenever scan results are available to be
3239 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3240 * is expected to be used some time after struct wpa_driver_ops::scan()
3241 * is called. If the driver provides an unsolicited event when the scan
3242 * has been completed, this event can be used to trigger
3243 * EVENT_SCAN_RESULTS call. If such event is not available from the
3244 * driver, the driver wrapper code is expected to use a registered
3245 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3246 * scan is expected to be completed. Optional information about
3247 * completed scan can be provided with union wpa_event_data::scan_info.
3252 * EVENT_ASSOCINFO - Report optional extra information for association
3254 * This event can be used to report extra association information for
3255 * EVENT_ASSOC processing. This extra information includes IEs from
3256 * association frames and Beacon/Probe Response frames in union
3257 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3258 * EVENT_ASSOC. Alternatively, the driver interface can include
3259 * assoc_info data in the EVENT_ASSOC call if it has all the
3260 * information available at the same point.
3265 * EVENT_INTERFACE_STATUS - Report interface status changes
3267 * This optional event can be used to report changes in interface
3268 * status (interface added/removed) using union
3269 * wpa_event_data::interface_status. This can be used to trigger
3270 * wpa_supplicant to stop and re-start processing for the interface,
3271 * e.g., when a cardbus card is ejected/inserted.
3273 EVENT_INTERFACE_STATUS,
3276 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3278 * This event can be used to inform wpa_supplicant about candidates for
3279 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3280 * for scan request (ap_scan=2 mode), this event is required for
3281 * pre-authentication. If wpa_supplicant is performing scan request
3282 * (ap_scan=1), this event is optional since scan results can be used
3283 * to add pre-authentication candidates. union
3284 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3285 * candidate and priority of the candidate, e.g., based on the signal
3286 * strength, in order to try to pre-authenticate first with candidates
3287 * that are most likely targets for re-association.
3289 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3290 * on the candidate list. In addition, it can be called for the current
3291 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3292 * will automatically skip pre-authentication in cases where a valid
3293 * PMKSA exists. When more than one candidate exists, this event should
3294 * be generated once for each candidate.
3296 * Driver will be notified about successful pre-authentication with
3297 * struct wpa_driver_ops::add_pmkid() calls.
3299 EVENT_PMKID_CANDIDATE,
3302 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3304 * This event can be used to inform wpa_supplicant about desire to set
3305 * up secure direct link connection between two stations as defined in
3306 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3307 * STAKey negotiation. The caller will need to set peer address for the
3313 * EVENT_TDLS - Request TDLS operation
3315 * This event can be used to request a TDLS operation to be performed.
3320 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3322 * The driver is expected to report the received FT IEs from
3323 * FT authentication sequence from the AP. The FT IEs are included in
3324 * the extra information in union wpa_event_data::ft_ies.
3329 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3331 * The driver can use this event to inform wpa_supplicant about a STA
3332 * in an IBSS with which protected frames could be exchanged. This
3333 * event starts RSN authentication with the other STA to authenticate
3334 * the STA and set up encryption keys with it.
3336 EVENT_IBSS_RSN_START,
3339 * EVENT_AUTH - Authentication result
3341 * This event should be called when authentication attempt has been
3342 * completed. This is only used if the driver supports separate
3343 * authentication step (struct wpa_driver_ops::authenticate).
3344 * Information about authentication result is included in
3345 * union wpa_event_data::auth.
3350 * EVENT_DEAUTH - Authentication lost
3352 * This event should be called when authentication is lost either due
3353 * to receiving deauthenticate frame from the AP or when sending that
3354 * frame to the current AP.
3355 * In AP mode, union wpa_event_data::deauth_info is required.
3360 * EVENT_ASSOC_REJECT - Association rejected
3362 * This event should be called when (re)association attempt has been
3363 * rejected by the AP. Information about the association response is
3364 * included in union wpa_event_data::assoc_reject.
3369 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3371 EVENT_AUTH_TIMED_OUT,
3374 * EVENT_ASSOC_TIMED_OUT - Association timed out
3376 EVENT_ASSOC_TIMED_OUT,
3379 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3381 EVENT_WPS_BUTTON_PUSHED,
3384 * EVENT_TX_STATUS - Report TX status
3389 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3391 EVENT_RX_FROM_UNKNOWN,
3394 * EVENT_RX_MGMT - Report RX of a management frame
3399 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3401 * This event is used to indicate when the driver has started the
3402 * requested remain-on-channel duration. Information about the
3403 * operation is included in union wpa_event_data::remain_on_channel.
3405 EVENT_REMAIN_ON_CHANNEL,
3408 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3410 * This event is used to indicate when the driver has completed
3411 * remain-on-channel duration, i.e., may noot be available on the
3412 * requested channel anymore. Information about the
3413 * operation is included in union wpa_event_data::remain_on_channel.
3415 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3418 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3420 * This event is used to indicate when a Probe Request frame has been
3421 * received. Information about the received frame is included in
3422 * union wpa_event_data::rx_probe_req. The driver is required to report
3423 * these events only after successfully completed probe_req_report()
3424 * commands to request the events (i.e., report parameter is non-zero)
3425 * in station mode. In AP mode, Probe Request frames should always be
3431 * EVENT_NEW_STA - New wired device noticed
3433 * This event is used to indicate that a new device has been detected
3434 * in a network that does not use association-like functionality (i.e.,
3435 * mainly wired Ethernet). This can be used to start EAPOL
3436 * authenticator when receiving a frame from a device. The address of
3437 * the device is included in union wpa_event_data::new_sta.
3442 * EVENT_EAPOL_RX - Report received EAPOL frame
3444 * When in AP mode with hostapd, this event is required to be used to
3445 * deliver the receive EAPOL frames from the driver. With
3446 * %wpa_supplicant, this event is used only if the send_eapol() handler
3447 * is used to override the use of l2_packet for EAPOL frame TX.
3452 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3454 * This event is used to indicate changes in the signal strength
3455 * observed in frames received from the current AP if signal strength
3456 * monitoring has been enabled with signal_monitor().
3458 EVENT_SIGNAL_CHANGE,
3461 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3463 * This event is used to indicate that the interface was enabled after
3464 * having been previously disabled, e.g., due to rfkill.
3466 EVENT_INTERFACE_ENABLED,
3469 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3471 * This event is used to indicate that the interface was disabled,
3472 * e.g., due to rfkill.
3474 EVENT_INTERFACE_DISABLED,
3477 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3479 * This event is used to indicate that the channel list has changed,
3480 * e.g., because of a regulatory domain change triggered by scan
3481 * results including an AP advertising a country code.
3483 EVENT_CHANNEL_LIST_CHANGED,
3486 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3488 * This event is used to indicate that the driver cannot maintain this
3489 * interface in its operation mode anymore. The most likely use for
3490 * this is to indicate that AP mode operation is not available due to
3491 * operating channel would need to be changed to a DFS channel when
3492 * the driver does not support radar detection and another virtual
3493 * interfaces caused the operating channel to change. Other similar
3494 * resource conflicts could also trigger this for station mode
3495 * interfaces. This event can be propagated when channel switching
3498 EVENT_INTERFACE_UNAVAILABLE,
3501 * EVENT_BEST_CHANNEL
3503 * Driver generates this event whenever it detects a better channel
3504 * (e.g., based on RSSI or channel use). This information can be used
3505 * to improve channel selection for a new AP/P2P group.
3510 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3512 * This event should be called when a Deauthentication frame is dropped
3513 * due to it not being protected (MFP/IEEE 802.11w).
3514 * union wpa_event_data::unprot_deauth is required to provide more
3515 * details of the frame.
3517 EVENT_UNPROT_DEAUTH,
3520 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3522 * This event should be called when a Disassociation frame is dropped
3523 * due to it not being protected (MFP/IEEE 802.11w).
3524 * union wpa_event_data::unprot_disassoc is required to provide more
3525 * details of the frame.
3527 EVENT_UNPROT_DISASSOC,
3530 * EVENT_STATION_LOW_ACK
3532 * Driver generates this event whenever it detected that a particular
3533 * station was lost. Detection can be through massive transmission
3534 * failures for example.
3536 EVENT_STATION_LOW_ACK,
3539 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3541 EVENT_IBSS_PEER_LOST,
3544 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3546 * This event carries the new replay counter to notify wpa_supplicant
3547 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3548 * completed Group Key Handshake while the host (including
3549 * wpa_supplicant was sleeping).
3551 EVENT_DRIVER_GTK_REKEY,
3554 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3556 EVENT_SCHED_SCAN_STOPPED,
3559 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3561 * This event indicates that the station responded to the poll
3562 * initiated with @poll_client.
3564 EVENT_DRIVER_CLIENT_POLL_OK,
3567 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3569 EVENT_EAPOL_TX_STATUS,
3572 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3574 * Described in wpa_event_data.ch_switch
3579 * EVENT_WNM - Request WNM operation
3581 * This event can be used to request a WNM operation to be performed.
3586 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3588 * This event indicates that the driver reported a connection failure
3589 * with the specified client (for example, max client reached, etc.) in
3592 EVENT_CONNECT_FAILED_REASON,
3595 * EVENT_RADAR_DETECTED - Notify of radar detection
3597 * A radar has been detected on the supplied frequency, hostapd should
3598 * react accordingly (e.g., change channel).
3600 EVENT_DFS_RADAR_DETECTED,
3603 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3605 * After a successful CAC, the channel can be marked clear and used.
3607 EVENT_DFS_CAC_FINISHED,
3610 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3612 * The CAC was not successful, and the channel remains in the previous
3613 * state. This may happen due to a radar beeing detected or other
3614 * external influences.
3616 EVENT_DFS_CAC_ABORTED,
3619 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3621 * The channel which was previously unavailable is now available again.
3623 EVENT_DFS_NOP_FINISHED,
3626 * EVENT_SURVEY - Received survey data
3628 * This event gets triggered when a driver query is issued for survey
3629 * data and the requested data becomes available. The returned data is
3630 * stored in struct survey_results. The results provide at most one
3631 * survey entry for each frequency and at minimum will provide one
3632 * survey entry for one frequency. The survey data can be os_malloc()'d
3633 * and then os_free()'d, so the event callback must only copy data.
3638 * EVENT_SCAN_STARTED - Scan started
3640 * This indicates that driver has started a scan operation either based
3641 * on a request from wpa_supplicant/hostapd or from another application.
3642 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3643 * completed (either successfully or by getting cancelled).
3648 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3650 * This event indicates a set of frequency ranges that should be avoided
3651 * to reduce issues due to interference or internal co-existence
3652 * information in the driver.
3654 EVENT_AVOID_FREQUENCIES,
3657 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3659 EVENT_NEW_PEER_CANDIDATE
3665 * struct freq_survey - Channel survey info
3667 * @ifidx: Interface index in which this survey was observed
3668 * @freq: Center of frequency of the surveyed channel
3669 * @nf: Channel noise floor in dBm
3670 * @channel_time: Amount of time in ms the radio spent on the channel
3671 * @channel_time_busy: Amount of time in ms the radio detected some signal
3672 * that indicated to the radio the channel was not clear
3673 * @channel_time_rx: Amount of time the radio spent receiving data
3674 * @channel_time_tx: Amount of time the radio spent transmitting data
3675 * @filled: bitmask indicating which fields have been reported, see
3676 * SURVEY_HAS_* defines.
3677 * @list: Internal list pointers
3679 struct freq_survey {
3684 u64 channel_time_busy;
3685 u64 channel_time_rx;
3686 u64 channel_time_tx;
3687 unsigned int filled;
3688 struct dl_list list;
3691 #define SURVEY_HAS_NF BIT(0)
3692 #define SURVEY_HAS_CHAN_TIME BIT(1)
3693 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3694 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3695 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3699 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3701 union wpa_event_data {
3703 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3705 * This structure is optional for EVENT_ASSOC calls and required for
3706 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3707 * driver interface does not need to generate separate EVENT_ASSOCINFO
3712 * reassoc - Flag to indicate association or reassociation
3717 * req_ies - (Re)Association Request IEs
3719 * If the driver generates WPA/RSN IE, this event data must be
3720 * returned for WPA handshake to have needed information. If
3721 * wpa_supplicant-generated WPA/RSN IE is used, this
3722 * information event is optional.
3724 * This should start with the first IE (fixed fields before IEs
3725 * are not included).
3730 * req_ies_len - Length of req_ies in bytes
3735 * resp_ies - (Re)Association Response IEs
3737 * Optional association data from the driver. This data is not
3738 * required WPA, but may be useful for some protocols and as
3739 * such, should be reported if this is available to the driver
3742 * This should start with the first IE (fixed fields before IEs
3743 * are not included).
3748 * resp_ies_len - Length of resp_ies in bytes
3750 size_t resp_ies_len;
3753 * beacon_ies - Beacon or Probe Response IEs
3755 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3756 * Probe Response frames from the current AP (i.e., the one
3757 * that the client just associated with). This information is
3758 * used to update WPA/RSN IE for the AP. If this field is not
3759 * set, the results from previous scan will be used. If no
3760 * data for the new AP is found, scan results will be requested
3761 * again (without scan request). At this point, the driver is
3762 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3765 * This should start with the first IE (fixed fields before IEs
3766 * are not included).
3768 const u8 *beacon_ies;
3771 * beacon_ies_len - Length of beacon_ies */
3772 size_t beacon_ies_len;
3775 * freq - Frequency of the operational channel in MHz
3780 * wmm_params - WMM parameters used in this association.
3782 struct wmm_params wmm_params;
3785 * addr - Station address (for AP mode)
3790 * The following is the key management offload information
3793 * @key_replay_ctr_len
3801 * authorized - Status of key management offload,
3807 * key_replay_ctr - Key replay counter value last used
3808 * in a valid EAPOL-Key frame
3810 const u8 *key_replay_ctr;
3813 * key_replay_ctr_len - The length of key_replay_ctr
3815 size_t key_replay_ctr_len;
3818 * ptk_kck - The derived PTK KCK
3823 * ptk_kek_len - The length of ptk_kck
3828 * ptk_kek - The derived PTK KEK
3833 * ptk_kek_len - The length of ptk_kek
3839 * struct disassoc_info - Data for EVENT_DISASSOC events
3841 struct disassoc_info {
3843 * addr - Station address (for AP mode)
3848 * reason_code - Reason Code (host byte order) used in
3849 * Deauthentication frame
3854 * ie - Optional IE(s) in Disassociation frame
3859 * ie_len - Length of ie buffer in octets
3864 * locally_generated - Whether the frame was locally generated
3866 int locally_generated;
3870 * struct deauth_info - Data for EVENT_DEAUTH events
3872 struct deauth_info {
3874 * addr - Station address (for AP mode)
3879 * reason_code - Reason Code (host byte order) used in
3880 * Deauthentication frame
3885 * ie - Optional IE(s) in Deauthentication frame
3890 * ie_len - Length of ie buffer in octets
3895 * locally_generated - Whether the frame was locally generated
3897 int locally_generated;
3901 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3903 struct michael_mic_failure {
3906 } michael_mic_failure;
3909 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3911 struct interface_status {
3914 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3919 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3921 struct pmkid_candidate {
3922 /** BSSID of the PMKID candidate */
3924 /** Smaller the index, higher the priority */
3926 /** Whether RSN IE includes pre-authenticate flag */
3931 * struct stkstart - Data for EVENT_STKSTART
3938 * struct tdls - Data for EVENT_TDLS
3944 TDLS_REQUEST_TEARDOWN
3946 u16 reason_code; /* for teardown */
3950 * struct wnm - Data for EVENT_WNM
3968 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3970 * During FT (IEEE 802.11r) authentication sequence, the driver is
3971 * expected to use this event to report received FT IEs (MDIE, FTIE,
3972 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3973 * IEs for the next message will be delivered through the
3974 * struct wpa_driver_ops::update_ft_ies() callback.
3980 u8 target_ap[ETH_ALEN];
3981 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3983 /** Length of ric_ies buffer in octets */
3988 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3990 struct ibss_rsn_start {
3995 * struct auth_info - Data for EVENT_AUTH events
4001 u16 auth_transaction;
4008 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4010 struct assoc_reject {
4012 * bssid - BSSID of the AP that rejected association
4017 * resp_ies - (Re)Association Response IEs
4019 * Optional association data from the driver. This data is not
4020 * required WPA, but may be useful for some protocols and as
4021 * such, should be reported if this is available to the driver
4024 * This should start with the first IE (fixed fields before IEs
4025 * are not included).
4030 * resp_ies_len - Length of resp_ies in bytes
4032 size_t resp_ies_len;
4035 * status_code - Status Code from (Re)association Response
4040 struct timeout_event {
4045 * struct tx_status - Data for EVENT_TX_STATUS events
4057 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4059 struct rx_from_unknown {
4066 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4074 * drv_priv - Pointer to store driver private BSS information
4076 * If not set to NULL, this is used for comparison with
4077 * hostapd_data->drv_priv to determine which BSS should process
4083 * freq - Frequency (in MHz) on which the frame was received
4088 * ssi_signal - Signal strength in dBm (or 0 if not available)
4094 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4096 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4098 struct remain_on_channel {
4100 * freq - Channel frequency in MHz
4105 * duration - Duration to remain on the channel in milliseconds
4107 unsigned int duration;
4108 } remain_on_channel;
4111 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4112 * @aborted: Whether the scan was aborted
4113 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4114 * @num_freqs: Number of entries in freqs array
4115 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4117 * @num_ssids: Number of entries in ssids array
4123 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4128 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4130 struct rx_probe_req {
4132 * sa - Source address of the received Probe Request frame
4137 * da - Destination address of the received Probe Request frame
4138 * or %NULL if not available
4143 * bssid - BSSID of the received Probe Request frame or %NULL
4149 * ie - IEs from the Probe Request body
4154 * ie_len - Length of ie buffer in octets
4159 * signal - signal strength in dBm (or 0 if not available)
4165 * struct new_sta - Data for EVENT_NEW_STA events
4172 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4181 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4183 struct wpa_signal_info signal_change;
4186 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4187 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4188 * @freq_5: Best 5 GHz band channel frequency in MHz
4189 * @freq_overall: Best channel frequency in MHz
4191 * 0 can be used to indicate no preference in either band.
4193 struct best_channel {
4199 struct unprot_deauth {
4205 struct unprot_disassoc {
4212 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4213 * @addr: station address
4220 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4222 struct ibss_peer_lost {
4227 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4229 struct driver_gtk_rekey {
4231 const u8 *replay_ctr;
4235 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4236 * @addr: station address
4238 struct client_poll {
4243 * struct eapol_tx_status
4244 * @dst: Original destination
4245 * @data: Data starting with IEEE 802.1X header (!)
4246 * @data_len: Length of data
4247 * @ack: Indicates ack or lost frame
4249 * This corresponds to hapd_send_eapol if the frame sent
4250 * there isn't just reported as EVENT_TX_STATUS.
4252 struct eapol_tx_status {
4261 * @freq: Frequency of new channel in MHz
4262 * @ht_enabled: Whether this is an HT channel
4263 * @ch_offset: Secondary channel offset
4264 * @ch_width: Channel width
4265 * @cf1: Center frequency 1
4266 * @cf2: Center frequency 2
4272 enum chan_width ch_width;
4278 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4279 * @addr: Remote client address
4280 * @code: Reason code for connection failure
4282 struct connect_failed_reason {
4288 } connect_failed_reason;
4291 * struct dfs_event - Data for radar detected events
4292 * @freq: Frequency of the channel in MHz
4298 enum chan_width chan_width;
4304 * survey_results - Survey result data for EVENT_SURVEY
4305 * @freq_filter: Requested frequency survey filter, 0 if request
4306 * was for all survey data
4307 * @survey_list: Linked list of survey data
4309 struct survey_results {
4310 unsigned int freq_filter;
4311 struct dl_list survey_list; /* struct freq_survey */
4315 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4316 * @initiator: Initiator of the regulatory change
4317 * @type: Regulatory change type
4318 * @alpha2: Country code (or "" if not available)
4320 struct channel_list_changed {
4321 enum reg_change_initiator initiator;
4324 } channel_list_changed;
4327 * freq_range - List of frequency ranges
4329 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4331 struct wpa_freq_range_list freq_range;
4336 * @peer: Peer address
4338 * @ie_len: Length of @ies
4340 * Notification of new candidate mesh peer.
4351 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4352 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4353 * with struct wpa_driver_ops::init()
4354 * @event: event type (defined above)
4355 * @data: possible extra data for the event
4357 * Driver wrapper code should call this function whenever an event is received
4360 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4361 union wpa_event_data *data);
4365 * The following inline functions are provided for convenience to simplify
4366 * event indication for some of the common events.
4369 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4370 size_t ielen, int reassoc)
4372 union wpa_event_data event;
4373 os_memset(&event, 0, sizeof(event));
4374 event.assoc_info.reassoc = reassoc;
4375 event.assoc_info.req_ies = ie;
4376 event.assoc_info.req_ies_len = ielen;
4377 event.assoc_info.addr = addr;
4378 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4381 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4383 union wpa_event_data event;
4384 os_memset(&event, 0, sizeof(event));
4385 event.disassoc_info.addr = addr;
4386 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4389 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4392 union wpa_event_data event;
4393 os_memset(&event, 0, sizeof(event));
4394 event.eapol_rx.src = src;
4395 event.eapol_rx.data = data;
4396 event.eapol_rx.data_len = data_len;
4397 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4400 /* driver_common.c */
4401 void wpa_scan_results_free(struct wpa_scan_results *res);
4403 /* Convert wpa_event_type to a string for logging */
4404 const char * event_to_string(enum wpa_event_type event);
4406 /* Convert chan_width to a string for logging and control interfaces */
4407 const char * channel_width_to_string(enum chan_width width);
4409 int ht_supported(const struct hostapd_hw_modes *mode);
4410 int vht_supported(const struct hostapd_hw_modes *mode);
4412 struct wowlan_triggers *
4413 wpa_get_wowlan_triggers(const char *wowlan_triggers,
4414 const struct wpa_driver_capa *capa);
4416 /* NULL terminated array of linked in driver wrappers */
4417 extern struct wpa_driver_ops *wpa_drivers[];
4419 #endif /* DRIVER_H */