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 struct wpa_driver_mesh_bss_params conf;
949 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
950 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
951 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
952 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
957 * struct wpa_driver_capa - Driver capability information
959 struct wpa_driver_capa {
960 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
961 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
962 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
963 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
964 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
965 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
966 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
967 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
968 unsigned int key_mgmt;
970 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
971 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
972 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
973 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
974 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
975 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
976 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
977 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
978 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
979 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
980 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
981 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
982 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
985 #define WPA_DRIVER_AUTH_OPEN 0x00000001
986 #define WPA_DRIVER_AUTH_SHARED 0x00000002
987 #define WPA_DRIVER_AUTH_LEAP 0x00000004
990 /* Driver generated WPA/RSN IE */
991 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
992 /* Driver needs static WEP key setup after association command */
993 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
994 /* Driver takes care of all DFS operations */
995 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
996 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
997 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
998 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
999 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1000 /* Driver provides separate commands for authentication and association (SME in
1001 * wpa_supplicant). */
1002 #define WPA_DRIVER_FLAGS_SME 0x00000020
1003 /* Driver supports AP mode */
1004 #define WPA_DRIVER_FLAGS_AP 0x00000040
1005 /* Driver needs static WEP key setup after association has been completed */
1006 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1007 /* Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1008 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1009 /* Driver supports concurrent P2P operations */
1010 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1012 * Driver uses the initial interface as a dedicated management interface, i.e.,
1013 * it cannot be used for P2P group operations or non-P2P purposes.
1015 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1016 /* This interface is P2P capable (P2P GO or P2P Client) */
1017 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1018 /* Driver supports station and key removal when stopping an AP */
1019 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1021 * Driver uses the initial interface for P2P management interface and non-P2P
1022 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1023 * P2P group operations.
1025 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1027 * Driver is known to use sane error codes, i.e., when it indicates that
1028 * something (e.g., association) fails, there was indeed a failure and the
1029 * operation does not end up getting completed successfully later.
1031 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1032 /* Driver supports off-channel TX */
1033 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1034 /* Driver indicates TX status events for EAPOL Data frames */
1035 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1036 /* Driver indicates TX status events for Deauth/Disassoc frames */
1037 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1038 /* Driver supports roaming (BSS selection) in firmware */
1039 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1040 /* Driver supports operating as a TDLS peer */
1041 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1042 /* Driver requires external TDLS setup/teardown/discovery */
1043 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1044 /* Driver indicates support for Probe Response offloading in AP mode */
1045 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1046 /* Driver supports U-APSD in AP mode */
1047 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1048 /* Driver supports inactivity timer in AP mode */
1049 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1050 /* Driver expects user space implementation of MLME in AP mode */
1051 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1052 /* Driver supports SAE with user space SME */
1053 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1054 /* Driver makes use of OBSS scan mechanism in wpa_supplicant */
1055 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1056 /* Driver supports IBSS (Ad-hoc) mode */
1057 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1058 /* Driver supports radar detection */
1059 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1060 /* Driver supports a dedicated interface for P2P Device */
1061 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1062 /* Driver supports QoS Mapping */
1063 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1064 /* Driver supports CSA in AP mode */
1065 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1066 /* Driver supports mesh */
1067 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1070 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1071 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1072 unsigned int smps_modes;
1075 int max_sched_scan_ssids;
1076 int sched_scan_supported;
1080 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1082 unsigned int max_remain_on_chan;
1085 * max_stations - Maximum number of associated stations the driver
1086 * supports in AP mode
1088 unsigned int max_stations;
1091 * probe_resp_offloads - Bitmap of supported protocols by the driver
1092 * for Probe Response offloading.
1094 /* Driver Probe Response offloading support for WPS ver. 1 */
1095 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1096 /* Driver Probe Response offloading support for WPS ver. 2 */
1097 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1098 /* Driver Probe Response offloading support for P2P */
1099 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1100 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1101 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1102 unsigned int probe_resp_offloads;
1104 unsigned int max_acl_mac_addrs;
1107 * Number of supported concurrent channels
1109 unsigned int num_multichan_concurrent;
1112 * extended_capa - extended capabilities in driver/device
1114 * Must be allocated and freed by driver and the pointers must be
1115 * valid for the lifetime of the driver, i.e., freed in deinit()
1117 const u8 *extended_capa, *extended_capa_mask;
1118 unsigned int extended_capa_len;
1120 struct wowlan_triggers wowlan_triggers;
1124 struct hostapd_data;
1126 struct hostap_sta_driver_data {
1127 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1128 unsigned long current_tx_rate;
1129 unsigned long inactive_msec;
1130 unsigned long flags;
1131 unsigned long num_ps_buf_frames;
1132 unsigned long tx_retry_failed;
1133 unsigned long tx_retry_count;
1138 struct hostapd_sta_add_params {
1142 const u8 *supp_rates;
1143 size_t supp_rates_len;
1144 u16 listen_interval;
1145 const struct ieee80211_ht_capabilities *ht_capabilities;
1146 const struct ieee80211_vht_capabilities *vht_capabilities;
1147 int vht_opmode_enabled;
1149 u32 flags; /* bitmask of WPA_STA_* flags */
1150 u32 flags_mask; /* unset bits in flags */
1152 enum mesh_plink_state plink_state;
1153 #endif /* CONFIG_MESH */
1154 int set; /* Set STA parameters instead of add */
1156 const u8 *ext_capab;
1157 size_t ext_capab_len;
1158 const u8 *supp_channels;
1159 size_t supp_channels_len;
1160 const u8 *supp_oper_classes;
1161 size_t supp_oper_classes_len;
1164 struct mac_address {
1168 struct hostapd_acl_params {
1170 unsigned int num_mac_acl;
1171 struct mac_address mac_acl[0];
1174 enum wpa_driver_if_type {
1176 * WPA_IF_STATION - Station mode interface
1181 * WPA_IF_AP_VLAN - AP mode VLAN interface
1183 * This interface shares its address and Beacon frame with the main
1189 * WPA_IF_AP_BSS - AP mode BSS interface
1191 * This interface has its own address and Beacon frame.
1196 * WPA_IF_P2P_GO - P2P Group Owner
1201 * WPA_IF_P2P_CLIENT - P2P Client
1206 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1207 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1212 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1213 * abstracted P2P Device function in the driver
1218 struct wpa_init_params {
1224 const char *test_socket;
1225 int use_pae_group_addr;
1229 u8 *own_addr; /* buffer for writing own MAC address */
1233 struct wpa_bss_params {
1234 /** Interface name (for multi-SSID/VLAN support) */
1236 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1245 enum mfp_options ieee80211w;
1248 #define WPA_STA_AUTHORIZED BIT(0)
1249 #define WPA_STA_WMM BIT(1)
1250 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1251 #define WPA_STA_MFP BIT(3)
1252 #define WPA_STA_TDLS_PEER BIT(4)
1253 #define WPA_STA_AUTHENTICATED BIT(5)
1266 WNM_SLEEP_ENTER_CONFIRM,
1267 WNM_SLEEP_ENTER_FAIL,
1268 WNM_SLEEP_EXIT_CONFIRM,
1269 WNM_SLEEP_EXIT_FAIL,
1270 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1271 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1272 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1274 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1276 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1277 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1279 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1282 /* enum chan_width - Channel width definitions */
1294 * struct wpa_signal_info - Information about channel signal quality
1296 struct wpa_signal_info {
1298 int above_threshold;
1303 enum chan_width chanwidth;
1309 * struct beacon_data - Beacon data
1310 * @head: Head portion of Beacon frame (before TIM IE)
1311 * @tail: Tail portion of Beacon frame (after TIM IE)
1312 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1313 * @proberesp_ies: Extra information element(s) to add into Probe Response
1315 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1316 * Response frames or %NULL
1317 * @probe_resp: Probe Response frame template
1318 * @head_len: Length of @head
1319 * @tail_len: Length of @tail
1320 * @beacon_ies_len: Length of beacon_ies in octets
1321 * @proberesp_ies_len: Length of proberesp_ies in octets
1322 * @proberesp_ies_len: Length of proberesp_ies in octets
1323 * @probe_resp_len: Length of probe response template (@probe_resp)
1325 struct beacon_data {
1332 size_t head_len, tail_len;
1333 size_t beacon_ies_len;
1334 size_t proberesp_ies_len;
1335 size_t assocresp_ies_len;
1336 size_t probe_resp_len;
1340 * struct csa_settings - Settings for channel switch command
1341 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1342 * @block_tx: 1 - block transmission for CSA period
1343 * @freq_params: Next channel frequency parameter
1344 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1345 * @beacon_after: Next beacon/probe resp/asooc resp info
1346 * @counter_offset_beacon: Offset to the count field in beacon's tail
1347 * @counter_offset_presp: Offset to the count field in probe resp.
1349 struct csa_settings {
1353 struct hostapd_freq_params freq_params;
1354 struct beacon_data beacon_csa;
1355 struct beacon_data beacon_after;
1357 u16 counter_offset_beacon;
1358 u16 counter_offset_presp;
1361 /* TDLS peer capabilities for send_tdls_mgmt() */
1362 enum tdls_peer_capability {
1363 TDLS_PEER_HT = BIT(0),
1364 TDLS_PEER_VHT = BIT(1),
1365 TDLS_PEER_WMM = BIT(2),
1368 #ifdef CONFIG_MACSEC
1369 struct macsec_init_params {
1370 Boolean always_include_sci;
1374 #endif /* CONFIG_MACSEC */
1376 enum drv_br_port_attr {
1377 DRV_BR_PORT_ATTR_PROXYARP,
1378 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1381 enum drv_br_net_param {
1382 DRV_BR_NET_PARAM_GARP_ACCEPT,
1387 * struct wpa_driver_ops - Driver interface API definition
1389 * This structure defines the API that each driver interface needs to implement
1390 * for core wpa_supplicant code. All driver specific functionality is captured
1393 struct wpa_driver_ops {
1394 /** Name of the driver interface */
1396 /** One line description of the driver interface */
1400 * get_bssid - Get the current BSSID
1401 * @priv: private driver interface data
1402 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1404 * Returns: 0 on success, -1 on failure
1406 * Query kernel driver for the current BSSID and copy it to bssid.
1407 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1410 int (*get_bssid)(void *priv, u8 *bssid);
1413 * get_ssid - Get the current SSID
1414 * @priv: private driver interface data
1415 * @ssid: buffer for SSID (at least 32 bytes)
1417 * Returns: Length of the SSID on success, -1 on failure
1419 * Query kernel driver for the current SSID and copy it to ssid.
1420 * Returning zero is recommended if the STA is not associated.
1422 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1423 * can, at least in theory, contain control characters (including nul)
1424 * and as such, should be processed as binary data, not a printable
1427 int (*get_ssid)(void *priv, u8 *ssid);
1430 * set_key - Configure encryption key
1431 * @ifname: Interface name (for multi-SSID/VLAN support)
1432 * @priv: private driver interface data
1433 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1434 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1435 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1436 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1437 * %WPA_ALG_BIP_CMAC_256);
1438 * %WPA_ALG_NONE clears the key.
1439 * @addr: Address of the peer STA (BSSID of the current AP when setting
1440 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1441 * broadcast keys, %NULL for default keys that are used both for
1442 * broadcast and unicast; when clearing keys, %NULL is used to
1443 * indicate that both the broadcast-only and default key of the
1444 * specified key index is to be cleared
1445 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1447 * @set_tx: configure this key as the default Tx key (only used when
1448 * driver does not support separate unicast/individual key
1449 * @seq: sequence number/packet number, seq_len octets, the next
1450 * packet number to be used for in replay protection; configured
1451 * for Rx keys (in most cases, this is only used with broadcast
1452 * keys and set to zero for unicast keys); %NULL if not set
1453 * @seq_len: length of the seq, depends on the algorithm:
1454 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1455 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1457 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1458 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1460 * Returns: 0 on success, -1 on failure
1462 * Configure the given key for the kernel driver. If the driver
1463 * supports separate individual keys (4 default keys + 1 individual),
1464 * addr can be used to determine whether the key is default or
1465 * individual. If only 4 keys are supported, the default key with key
1466 * index 0 is used as the individual key. STA must be configured to use
1467 * it as the default Tx key (set_tx is set) and accept Rx for all the
1468 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1469 * broadcast keys, so key index 0 is available for this kind of
1472 * Please note that TKIP keys include separate TX and RX MIC keys and
1473 * some drivers may expect them in different order than wpa_supplicant
1474 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1475 * will trigger Michael MIC errors. This can be fixed by changing the
1476 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1477 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1478 * example on how this can be done.
1480 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1481 const u8 *addr, int key_idx, int set_tx,
1482 const u8 *seq, size_t seq_len,
1483 const u8 *key, size_t key_len);
1486 * init - Initialize driver interface
1487 * @ctx: context to be used when calling wpa_supplicant functions,
1488 * e.g., wpa_supplicant_event()
1489 * @ifname: interface name, e.g., wlan0
1491 * Returns: Pointer to private data, %NULL on failure
1493 * Initialize driver interface, including event processing for kernel
1494 * driver events (e.g., associated, scan results, Michael MIC failure).
1495 * This function can allocate a private configuration data area for
1496 * @ctx, file descriptor, interface name, etc. information that may be
1497 * needed in future driver operations. If this is not used, non-NULL
1498 * value will need to be returned because %NULL is used to indicate
1499 * failure. The returned value will be used as 'void *priv' data for
1500 * all other driver_ops functions.
1502 * The main event loop (eloop.c) of wpa_supplicant can be used to
1503 * register callback for read sockets (eloop_register_read_sock()).
1505 * See below for more information about events and
1506 * wpa_supplicant_event() function.
1508 void * (*init)(void *ctx, const char *ifname);
1511 * deinit - Deinitialize driver interface
1512 * @priv: private driver interface data from init()
1514 * Shut down driver interface and processing of driver events. Free
1515 * private data buffer if one was allocated in init() handler.
1517 void (*deinit)(void *priv);
1520 * set_param - Set driver configuration parameters
1521 * @priv: private driver interface data from init()
1522 * @param: driver specific configuration parameters
1524 * Returns: 0 on success, -1 on failure
1526 * Optional handler for notifying driver interface about configuration
1527 * parameters (driver_param).
1529 int (*set_param)(void *priv, const char *param);
1532 * set_countermeasures - Enable/disable TKIP countermeasures
1533 * @priv: private driver interface data
1534 * @enabled: 1 = countermeasures enabled, 0 = disabled
1536 * Returns: 0 on success, -1 on failure
1538 * Configure TKIP countermeasures. When these are enabled, the driver
1539 * should drop all received and queued frames that are using TKIP.
1541 int (*set_countermeasures)(void *priv, int enabled);
1544 * deauthenticate - Request driver to deauthenticate
1545 * @priv: private driver interface data
1546 * @addr: peer address (BSSID of the AP)
1547 * @reason_code: 16-bit reason code to be sent in the deauthentication
1550 * Returns: 0 on success, -1 on failure
1552 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1555 * associate - Request driver to associate
1556 * @priv: private driver interface data
1557 * @params: association parameters
1559 * Returns: 0 on success, -1 on failure
1561 int (*associate)(void *priv,
1562 struct wpa_driver_associate_params *params);
1565 * add_pmkid - Add PMKSA cache entry to the driver
1566 * @priv: private driver interface data
1567 * @bssid: BSSID for the PMKSA cache entry
1568 * @pmkid: PMKID for the PMKSA cache entry
1570 * Returns: 0 on success, -1 on failure
1572 * This function is called when a new PMK is received, as a result of
1573 * either normal authentication or RSN pre-authentication.
1575 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1576 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1577 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1578 * driver_ops function does not need to be implemented. Likewise, if
1579 * the driver does not support WPA, this function is not needed.
1581 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1584 * remove_pmkid - Remove PMKSA cache entry to the driver
1585 * @priv: private driver interface data
1586 * @bssid: BSSID for the PMKSA cache entry
1587 * @pmkid: PMKID for the PMKSA cache entry
1589 * Returns: 0 on success, -1 on failure
1591 * This function is called when the supplicant drops a PMKSA cache
1592 * entry for any reason.
1594 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1595 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1596 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1597 * from wpa_supplicant, this driver_ops function does not need to be
1598 * implemented. Likewise, if the driver does not support WPA, this
1599 * function is not needed.
1601 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1604 * flush_pmkid - Flush PMKSA cache
1605 * @priv: private driver interface data
1607 * Returns: 0 on success, -1 on failure
1609 * This function is called when the supplicant drops all PMKSA cache
1610 * entries for any reason.
1612 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1613 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1614 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1615 * from wpa_supplicant, this driver_ops function does not need to be
1616 * implemented. Likewise, if the driver does not support WPA, this
1617 * function is not needed.
1619 int (*flush_pmkid)(void *priv);
1622 * get_capa - Get driver capabilities
1623 * @priv: private driver interface data
1625 * Returns: 0 on success, -1 on failure
1627 * Get driver/firmware/hardware capabilities.
1629 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1632 * poll - Poll driver for association information
1633 * @priv: private driver interface data
1635 * This is an option callback that can be used when the driver does not
1636 * provide event mechanism for association events. This is called when
1637 * receiving WPA EAPOL-Key messages that require association
1638 * information. The driver interface is supposed to generate associnfo
1639 * event before returning from this callback function. In addition, the
1640 * driver interface should generate an association event after having
1641 * sent out associnfo.
1643 void (*poll)(void *priv);
1646 * get_ifname - Get interface name
1647 * @priv: private driver interface data
1649 * Returns: Pointer to the interface name. This can differ from the
1650 * interface name used in init() call. Init() is called first.
1652 * This optional function can be used to allow the driver interface to
1653 * replace the interface name with something else, e.g., based on an
1654 * interface mapping from a more descriptive name.
1656 const char * (*get_ifname)(void *priv);
1659 * get_mac_addr - Get own MAC address
1660 * @priv: private driver interface data
1662 * Returns: Pointer to own MAC address or %NULL on failure
1664 * This optional function can be used to get the own MAC address of the
1665 * device from the driver interface code. This is only needed if the
1666 * l2_packet implementation for the OS does not provide easy access to
1668 const u8 * (*get_mac_addr)(void *priv);
1671 * send_eapol - Optional function for sending EAPOL packets
1672 * @priv: private driver interface data
1673 * @dest: Destination MAC address
1675 * @data: EAPOL packet starting with IEEE 802.1X header
1676 * @data_len: Size of the EAPOL packet
1678 * Returns: 0 on success, -1 on failure
1680 * This optional function can be used to override l2_packet operations
1681 * with driver specific functionality. If this function pointer is set,
1682 * l2_packet module is not used at all and the driver interface code is
1683 * responsible for receiving and sending all EAPOL packets. The
1684 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1685 * event. The driver interface is required to implement get_mac_addr()
1686 * handler if send_eapol() is used.
1688 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1689 const u8 *data, size_t data_len);
1692 * set_operstate - Sets device operating state to DORMANT or UP
1693 * @priv: private driver interface data
1694 * @state: 0 = dormant, 1 = up
1695 * Returns: 0 on success, -1 on failure
1697 * This is an optional function that can be used on operating systems
1698 * that support a concept of controlling network device state from user
1699 * space applications. This function, if set, gets called with
1700 * state = 1 when authentication has been completed and with state = 0
1701 * when connection is lost.
1703 int (*set_operstate)(void *priv, int state);
1706 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1707 * @priv: Private driver interface data
1708 * @addr: Address of the station for which to set protection (may be
1709 * %NULL for group keys)
1710 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1711 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1712 * Returns: 0 on success, -1 on failure
1714 * This is an optional function that can be used to set the driver to
1715 * require protection for Tx and/or Rx frames. This uses the layer
1716 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1717 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1718 * set protection operation; instead, they set protection implicitly
1719 * based on configured keys.
1721 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1725 * get_hw_feature_data - Get hardware support data (channels and rates)
1726 * @priv: Private driver interface data
1727 * @num_modes: Variable for returning the number of returned modes
1728 * flags: Variable for returning hardware feature flags
1729 * Returns: Pointer to allocated hardware data on success or %NULL on
1730 * failure. Caller is responsible for freeing this.
1732 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1737 * send_mlme - Send management frame from MLME
1738 * @priv: Private driver interface data
1739 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1740 * @data_len: Size of the management frame
1741 * @noack: Do not wait for this frame to be acked (disable retries)
1742 * Returns: 0 on success, -1 on failure
1744 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1748 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1749 * @priv: Private driver interface data
1750 * @md: Mobility domain (2 octets) (also included inside ies)
1751 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1752 * @ies_len: Length of FT IEs in bytes
1753 * Returns: 0 on success, -1 on failure
1755 * The supplicant uses this callback to let the driver know that keying
1756 * material for FT is available and that the driver can use the
1757 * provided IEs in the next message in FT authentication sequence.
1759 * This function is only needed for driver that support IEEE 802.11r
1760 * (Fast BSS Transition).
1762 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1766 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1767 * @priv: Private driver interface data
1768 * @action: Action field value
1769 * @target_ap: Target AP address
1770 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1771 * @ies_len: Length of FT IEs in bytes
1772 * Returns: 0 on success, -1 on failure
1774 * The supplicant uses this callback to request the driver to transmit
1775 * an FT Action frame (action category 6) for over-the-DS fast BSS
1778 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1779 const u8 *ies, size_t ies_len);
1782 * get_scan_results2 - Fetch the latest scan results
1783 * @priv: private driver interface data
1785 * Returns: Allocated buffer of scan results (caller is responsible for
1786 * freeing the data structure) on success, NULL on failure
1788 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1791 * set_country - Set country
1792 * @priv: Private driver interface data
1793 * @alpha2: country to which to switch to
1794 * Returns: 0 on success, -1 on failure
1796 * This function is for drivers which support some form
1797 * of setting a regulatory domain.
1799 int (*set_country)(void *priv, const char *alpha2);
1802 * get_country - Get country
1803 * @priv: Private driver interface data
1804 * @alpha2: Buffer for returning country code (at least 3 octets)
1805 * Returns: 0 on success, -1 on failure
1807 int (*get_country)(void *priv, char *alpha2);
1810 * global_init - Global driver initialization
1811 * Returns: Pointer to private data (global), %NULL on failure
1813 * This optional function is called to initialize the driver wrapper
1814 * for global data, i.e., data that applies to all interfaces. If this
1815 * function is implemented, global_deinit() will also need to be
1816 * implemented to free the private data. The driver will also likely
1817 * use init2() function instead of init() to get the pointer to global
1818 * data available to per-interface initializer.
1820 void * (*global_init)(void);
1823 * global_deinit - Global driver deinitialization
1824 * @priv: private driver global data from global_init()
1826 * Terminate any global driver related functionality and free the
1827 * global data structure.
1829 void (*global_deinit)(void *priv);
1832 * init2 - Initialize driver interface (with global data)
1833 * @ctx: context to be used when calling wpa_supplicant functions,
1834 * e.g., wpa_supplicant_event()
1835 * @ifname: interface name, e.g., wlan0
1836 * @global_priv: private driver global data from global_init()
1837 * Returns: Pointer to private data, %NULL on failure
1839 * This function can be used instead of init() if the driver wrapper
1842 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1845 * get_interfaces - Get information about available interfaces
1846 * @global_priv: private driver global data from global_init()
1847 * Returns: Allocated buffer of interface information (caller is
1848 * responsible for freeing the data structure) on success, NULL on
1851 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1854 * scan2 - Request the driver to initiate scan
1855 * @priv: private driver interface data
1856 * @params: Scan parameters
1858 * Returns: 0 on success, -1 on failure
1860 * Once the scan results are ready, the driver should report scan
1861 * results event for wpa_supplicant which will eventually request the
1862 * results with wpa_driver_get_scan_results2().
1864 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1867 * authenticate - Request driver to authenticate
1868 * @priv: private driver interface data
1869 * @params: authentication parameters
1870 * Returns: 0 on success, -1 on failure
1872 * This is an optional function that can be used with drivers that
1873 * support separate authentication and association steps, i.e., when
1874 * wpa_supplicant can act as the SME. If not implemented, associate()
1875 * function is expected to take care of IEEE 802.11 authentication,
1878 int (*authenticate)(void *priv,
1879 struct wpa_driver_auth_params *params);
1882 * set_ap - Set Beacon and Probe Response information for AP mode
1883 * @priv: Private driver interface data
1884 * @params: Parameters to use in AP mode
1886 * This function is used to configure Beacon template and/or extra IEs
1887 * to add for Beacon and Probe Response frames for the driver in
1888 * AP mode. The driver is responsible for building the full Beacon
1889 * frame by concatenating the head part with TIM IE generated by the
1890 * driver/firmware and finishing with the tail part. Depending on the
1891 * driver architectue, this can be done either by using the full
1892 * template or the set of additional IEs (e.g., WPS and P2P IE).
1893 * Similarly, Probe Response processing depends on the driver design.
1894 * If the driver (or firmware) takes care of replying to Probe Request
1895 * frames, the extra IEs provided here needs to be added to the Probe
1898 * Returns: 0 on success, -1 on failure
1900 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1903 * set_acl - Set ACL in AP mode
1904 * @priv: Private driver interface data
1905 * @params: Parameters to configure ACL
1906 * Returns: 0 on success, -1 on failure
1908 * This is used only for the drivers which support MAC address ACL.
1910 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1913 * hapd_init - Initialize driver interface (hostapd only)
1914 * @hapd: Pointer to hostapd context
1915 * @params: Configuration for the driver wrapper
1916 * Returns: Pointer to private data, %NULL on failure
1918 * This function is used instead of init() or init2() when the driver
1919 * wrapper is used with hostapd.
1921 void * (*hapd_init)(struct hostapd_data *hapd,
1922 struct wpa_init_params *params);
1925 * hapd_deinit - Deinitialize driver interface (hostapd only)
1926 * @priv: Private driver interface data from hapd_init()
1928 void (*hapd_deinit)(void *priv);
1931 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1932 * @priv: Private driver interface data
1933 * @params: BSS parameters
1934 * Returns: 0 on success, -1 on failure
1936 * This is an optional function to configure the kernel driver to
1937 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1938 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1939 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1940 * for Beacon frames.
1942 * DEPRECATED - use set_ap() instead
1944 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1947 * set_privacy - Enable/disable privacy (AP only)
1948 * @priv: Private driver interface data
1949 * @enabled: 1 = privacy enabled, 0 = disabled
1950 * Returns: 0 on success, -1 on failure
1952 * This is an optional function to configure privacy field in the
1953 * kernel driver for Beacon frames. This can be left undefined (set to
1954 * %NULL) if the driver uses the Beacon template from set_ap().
1956 * DEPRECATED - use set_ap() instead
1958 int (*set_privacy)(void *priv, int enabled);
1961 * get_seqnum - Fetch the current TSC/packet number (AP only)
1962 * @ifname: The interface name (main or virtual)
1963 * @priv: Private driver interface data
1964 * @addr: MAC address of the station or %NULL for group keys
1966 * @seq: Buffer for returning the latest used TSC/packet number
1967 * Returns: 0 on success, -1 on failure
1969 * This function is used to fetch the last used TSC/packet number for
1970 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1971 * keys, so there is no strict requirement on implementing support for
1972 * unicast keys (i.e., addr != %NULL).
1974 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1978 * flush - Flush all association stations (AP only)
1979 * @priv: Private driver interface data
1980 * Returns: 0 on success, -1 on failure
1982 * This function requests the driver to disassociate all associated
1983 * stations. This function does not need to be implemented if the
1984 * driver does not process association frames internally.
1986 int (*flush)(void *priv);
1989 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1990 * @priv: Private driver interface data
1991 * @elem: Information elements
1992 * @elem_len: Length of the elem buffer in octets
1993 * Returns: 0 on success, -1 on failure
1995 * This is an optional function to add information elements in the
1996 * kernel driver for Beacon and Probe Response frames. This can be left
1997 * undefined (set to %NULL) if the driver uses the Beacon template from
2000 * DEPRECATED - use set_ap() instead
2002 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2005 * read_sta_data - Fetch station data
2006 * @priv: Private driver interface data
2007 * @data: Buffer for returning station information
2008 * @addr: MAC address of the station
2009 * Returns: 0 on success, -1 on failure
2011 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2015 * hapd_send_eapol - Send an EAPOL packet (AP only)
2016 * @priv: private driver interface data
2017 * @addr: Destination MAC address
2018 * @data: EAPOL packet starting with IEEE 802.1X header
2019 * @data_len: Length of the EAPOL packet in octets
2020 * @encrypt: Whether the frame should be encrypted
2021 * @own_addr: Source MAC address
2022 * @flags: WPA_STA_* flags for the destination station
2024 * Returns: 0 on success, -1 on failure
2026 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2027 size_t data_len, int encrypt,
2028 const u8 *own_addr, u32 flags);
2031 * sta_deauth - Deauthenticate a station (AP only)
2032 * @priv: Private driver interface data
2033 * @own_addr: Source address and BSSID for the Deauthentication frame
2034 * @addr: MAC address of the station to deauthenticate
2035 * @reason: Reason code for the Deauthentiation frame
2036 * Returns: 0 on success, -1 on failure
2038 * This function requests a specific station to be deauthenticated and
2039 * a Deauthentication frame to be sent to it.
2041 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2045 * sta_disassoc - Disassociate a station (AP only)
2046 * @priv: Private driver interface data
2047 * @own_addr: Source address and BSSID for the Disassociation frame
2048 * @addr: MAC address of the station to disassociate
2049 * @reason: Reason code for the Disassociation frame
2050 * Returns: 0 on success, -1 on failure
2052 * This function requests a specific station to be disassociated and
2053 * a Disassociation frame to be sent to it.
2055 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2059 * sta_remove - Remove a station entry (AP only)
2060 * @priv: Private driver interface data
2061 * @addr: MAC address of the station to be removed
2062 * Returns: 0 on success, -1 on failure
2064 int (*sta_remove)(void *priv, const u8 *addr);
2067 * hapd_get_ssid - Get the current SSID (AP only)
2068 * @priv: Private driver interface data
2069 * @buf: Buffer for returning the SSID
2070 * @len: Maximum length of the buffer
2071 * Returns: Length of the SSID on success, -1 on failure
2073 * This function need not be implemented if the driver uses Beacon
2074 * template from set_ap() and does not reply to Probe Request frames.
2076 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2079 * hapd_set_ssid - Set SSID (AP only)
2080 * @priv: Private driver interface data
2082 * @len: Length of the SSID in octets
2083 * Returns: 0 on success, -1 on failure
2085 * DEPRECATED - use set_ap() instead
2087 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2090 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2091 * @priv: Private driver interface data
2092 * @enabled: 1 = countermeasures enabled, 0 = disabled
2093 * Returns: 0 on success, -1 on failure
2095 * This need not be implemented if the driver does not take care of
2096 * association processing.
2098 int (*hapd_set_countermeasures)(void *priv, int enabled);
2101 * sta_add - Add a station entry
2102 * @priv: Private driver interface data
2103 * @params: Station parameters
2104 * Returns: 0 on success, -1 on failure
2106 * This function is used to add a station entry to the driver once the
2107 * station has completed association. This is only used if the driver
2108 * does not take care of association processing.
2110 * With TDLS, this function is also used to add or set (params->set 1)
2111 * TDLS peer entries.
2113 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2116 * get_inact_sec - Get station inactivity duration (AP only)
2117 * @priv: Private driver interface data
2118 * @addr: Station address
2119 * Returns: Number of seconds station has been inactive, -1 on failure
2121 int (*get_inact_sec)(void *priv, const u8 *addr);
2124 * sta_clear_stats - Clear station statistics (AP only)
2125 * @priv: Private driver interface data
2126 * @addr: Station address
2127 * Returns: 0 on success, -1 on failure
2129 int (*sta_clear_stats)(void *priv, const u8 *addr);
2132 * set_freq - Set channel/frequency (AP only)
2133 * @priv: Private driver interface data
2134 * @freq: Channel parameters
2135 * Returns: 0 on success, -1 on failure
2137 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2140 * set_rts - Set RTS threshold
2141 * @priv: Private driver interface data
2142 * @rts: RTS threshold in octets
2143 * Returns: 0 on success, -1 on failure
2145 int (*set_rts)(void *priv, int rts);
2148 * set_frag - Set fragmentation threshold
2149 * @priv: Private driver interface data
2150 * @frag: Fragmentation threshold in octets
2151 * Returns: 0 on success, -1 on failure
2153 int (*set_frag)(void *priv, int frag);
2156 * sta_set_flags - Set station flags (AP only)
2157 * @priv: Private driver interface data
2158 * @addr: Station address
2159 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2160 * @flags_or: Bitmap of WPA_STA_* flags to add
2161 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2162 * Returns: 0 on success, -1 on failure
2164 int (*sta_set_flags)(void *priv, const u8 *addr,
2165 int total_flags, int flags_or, int flags_and);
2168 * set_tx_queue_params - Set TX queue parameters
2169 * @priv: Private driver interface data
2170 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2174 * @burst_time: Maximum length for bursting in 0.1 msec units
2176 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2177 int cw_max, int burst_time);
2180 * if_add - Add a virtual interface
2181 * @priv: Private driver interface data
2182 * @type: Interface type
2183 * @ifname: Interface name for the new virtual interface
2184 * @addr: Local address to use for the interface or %NULL to use the
2185 * parent interface address
2186 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2187 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2188 * not allowed (applies only to %WPA_IF_AP_BSS type)
2189 * @force_ifname: Buffer for returning an interface name that the
2190 * driver ended up using if it differs from the requested ifname
2191 * @if_addr: Buffer for returning the allocated interface address
2192 * (this may differ from the requested addr if the driver cannot
2193 * change interface address)
2194 * @bridge: Bridge interface to use or %NULL if no bridge configured
2195 * @use_existing: Whether to allow existing interface to be used
2196 * Returns: 0 on success, -1 on failure
2198 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2199 const char *ifname, const u8 *addr, void *bss_ctx,
2200 void **drv_priv, char *force_ifname, u8 *if_addr,
2201 const char *bridge, int use_existing);
2204 * if_remove - Remove a virtual interface
2205 * @priv: Private driver interface data
2206 * @type: Interface type
2207 * @ifname: Interface name of the virtual interface to be removed
2208 * Returns: 0 on success, -1 on failure
2210 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2211 const char *ifname);
2214 * set_sta_vlan - Bind a station into a specific interface (AP only)
2215 * @priv: Private driver interface data
2216 * @ifname: Interface (main or virtual BSS or VLAN)
2217 * @addr: MAC address of the associated station
2219 * Returns: 0 on success, -1 on failure
2221 * This function is used to bind a station to a specific virtual
2222 * interface. It is only used if when virtual interfaces are supported,
2223 * e.g., to assign stations to different VLAN interfaces based on
2224 * information from a RADIUS server. This allows separate broadcast
2225 * domains to be used with a single BSS.
2227 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2231 * commit - Optional commit changes handler (AP only)
2232 * @priv: driver private data
2233 * Returns: 0 on success, -1 on failure
2235 * This optional handler function can be registered if the driver
2236 * interface implementation needs to commit changes (e.g., by setting
2237 * network interface up) at the end of initial configuration. If set,
2238 * this handler will be called after initial setup has been completed.
2240 int (*commit)(void *priv);
2243 * send_ether - Send an ethernet packet (AP only)
2244 * @priv: private driver interface data
2245 * @dst: Destination MAC address
2246 * @src: Source MAC address
2248 * @data: EAPOL packet starting with IEEE 802.1X header
2249 * @data_len: Length of the EAPOL packet in octets
2250 * Returns: 0 on success, -1 on failure
2252 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2253 const u8 *data, size_t data_len);
2256 * set_radius_acl_auth - Notification of RADIUS ACL change
2257 * @priv: Private driver interface data
2258 * @mac: MAC address of the station
2259 * @accepted: Whether the station was accepted
2260 * @session_timeout: Session timeout for the station
2261 * Returns: 0 on success, -1 on failure
2263 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2264 u32 session_timeout);
2267 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2268 * @priv: Private driver interface data
2269 * @mac: MAC address of the station
2270 * Returns: 0 on success, -1 on failure
2272 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2275 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2276 * @priv: Private driver interface data
2277 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2278 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2280 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2281 * to remove extra IE(s)
2282 * Returns: 0 on success, -1 on failure
2284 * This is an optional function to add WPS IE in the kernel driver for
2285 * Beacon and Probe Response frames. This can be left undefined (set
2286 * to %NULL) if the driver uses the Beacon template from set_ap()
2287 * and does not process Probe Request frames. If the driver takes care
2288 * of (Re)Association frame processing, the assocresp buffer includes
2289 * WPS IE(s) that need to be added to (Re)Association Response frames
2290 * whenever a (Re)Association Request frame indicated use of WPS.
2292 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2293 * frames when operating as a GO. The driver is responsible for adding
2294 * timing related attributes (e.g., NoA) in addition to the IEs
2295 * included here by appending them after these buffers. This call is
2296 * also used to provide Probe Response IEs for P2P Listen state
2297 * operations for drivers that generate the Probe Response frames
2300 * DEPRECATED - use set_ap() instead
2302 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2303 const struct wpabuf *proberesp,
2304 const struct wpabuf *assocresp);
2307 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2308 * @priv: Private driver interface data
2309 * @authorized: Whether the port is authorized
2310 * Returns: 0 on success, -1 on failure
2312 int (*set_supp_port)(void *priv, int authorized);
2315 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2316 * @priv: Private driver interface data
2317 * @addr: MAC address of the associated station
2318 * @aid: Association ID
2319 * @val: 1 = bind to 4-address WDS; 0 = unbind
2320 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2321 * to indicate that bridge is not to be used
2322 * @ifname_wds: Buffer to return the interface name for the new WDS
2323 * station or %NULL to indicate name is not returned.
2324 * Returns: 0 on success, -1 on failure
2326 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2327 const char *bridge_ifname, char *ifname_wds);
2330 * send_action - Transmit an Action frame
2331 * @priv: Private driver interface data
2332 * @freq: Frequency (in MHz) of the channel
2333 * @wait: Time to wait off-channel for a response (in ms), or zero
2334 * @dst: Destination MAC address (Address 1)
2335 * @src: Source MAC address (Address 2)
2336 * @bssid: BSSID (Address 3)
2338 * @data_len: data length in octets
2339 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2340 * Returns: 0 on success, -1 on failure
2342 * This command can be used to request the driver to transmit an action
2343 * frame to the specified destination.
2345 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2346 * be transmitted on the given channel and the device will wait for a
2347 * response on that channel for the given wait time.
2349 * If the flag is not set, the wait time will be ignored. In this case,
2350 * if a remain-on-channel duration is in progress, the frame must be
2351 * transmitted on that channel; alternatively the frame may be sent on
2352 * the current operational channel (if in associated state in station
2353 * mode or while operating as an AP.)
2355 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2356 const u8 *dst, const u8 *src, const u8 *bssid,
2357 const u8 *data, size_t data_len, int no_cck);
2360 * send_action_cancel_wait - Cancel action frame TX wait
2361 * @priv: Private driver interface data
2363 * This command cancels the wait time associated with sending an action
2364 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2365 * set in the driver flags.
2367 void (*send_action_cancel_wait)(void *priv);
2370 * remain_on_channel - Remain awake on a channel
2371 * @priv: Private driver interface data
2372 * @freq: Frequency (in MHz) of the channel
2373 * @duration: Duration in milliseconds
2374 * Returns: 0 on success, -1 on failure
2376 * This command is used to request the driver to remain awake on the
2377 * specified channel for the specified duration and report received
2378 * Action frames with EVENT_RX_MGMT events. Optionally, received
2379 * Probe Request frames may also be requested to be reported by calling
2380 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2382 * The driver may not be at the requested channel when this function
2383 * returns, i.e., the return code is only indicating whether the
2384 * request was accepted. The caller will need to wait until the
2385 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2386 * completed the channel change. This may take some time due to other
2387 * need for the radio and the caller should be prepared to timing out
2388 * its wait since there are no guarantees on when this request can be
2391 int (*remain_on_channel)(void *priv, unsigned int freq,
2392 unsigned int duration);
2395 * cancel_remain_on_channel - Cancel remain-on-channel operation
2396 * @priv: Private driver interface data
2398 * This command can be used to cancel a remain-on-channel operation
2399 * before its originally requested duration has passed. This could be
2400 * used, e.g., when remain_on_channel() is used to request extra time
2401 * to receive a response to an Action frame and the response is
2402 * received when there is still unneeded time remaining on the
2403 * remain-on-channel operation.
2405 int (*cancel_remain_on_channel)(void *priv);
2408 * probe_req_report - Request Probe Request frames to be indicated
2409 * @priv: Private driver interface data
2410 * @report: Whether to report received Probe Request frames
2411 * Returns: 0 on success, -1 on failure (or if not supported)
2413 * This command can be used to request the driver to indicate when
2414 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2415 * Since this operation may require extra resources, e.g., due to less
2416 * optimal hardware/firmware RX filtering, many drivers may disable
2417 * Probe Request reporting at least in station mode. This command is
2418 * used to notify the driver when the Probe Request frames need to be
2419 * reported, e.g., during remain-on-channel operations.
2421 int (*probe_req_report)(void *priv, int report);
2424 * deinit_ap - Deinitialize AP mode
2425 * @priv: Private driver interface data
2426 * Returns: 0 on success, -1 on failure (or if not supported)
2428 * This optional function can be used to disable AP mode related
2429 * configuration. If the interface was not dynamically added,
2430 * change the driver mode to station mode to allow normal station
2431 * operations like scanning to be completed.
2433 int (*deinit_ap)(void *priv);
2436 * deinit_p2p_cli - Deinitialize P2P client mode
2437 * @priv: Private driver interface data
2438 * Returns: 0 on success, -1 on failure (or if not supported)
2440 * This optional function can be used to disable P2P client mode. If the
2441 * interface was not dynamically added, change the interface type back
2444 int (*deinit_p2p_cli)(void *priv);
2447 * suspend - Notification on system suspend/hibernate event
2448 * @priv: Private driver interface data
2450 void (*suspend)(void *priv);
2453 * resume - Notification on system resume/thaw event
2454 * @priv: Private driver interface data
2456 void (*resume)(void *priv);
2459 * signal_monitor - Set signal monitoring parameters
2460 * @priv: Private driver interface data
2461 * @threshold: Threshold value for signal change events; 0 = disabled
2462 * @hysteresis: Minimum change in signal strength before indicating a
2464 * Returns: 0 on success, -1 on failure (or if not supported)
2466 * This function can be used to configure monitoring of signal strength
2467 * with the current AP. Whenever signal strength drops below the
2468 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2469 * should be generated assuming the signal strength has changed at
2470 * least %hysteresis from the previously indicated signal change event.
2472 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2475 * send_frame - Send IEEE 802.11 frame (testing use only)
2476 * @priv: Private driver interface data
2477 * @data: IEEE 802.11 frame with IEEE 802.11 header
2478 * @data_len: Size of the frame
2479 * @encrypt: Whether to encrypt the frame (if keys are set)
2480 * Returns: 0 on success, -1 on failure
2482 * This function is only used for debugging purposes and is not
2483 * required to be implemented for normal operations.
2485 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2489 * shared_freq - Get operating frequency of shared interface(s)
2490 * @priv: Private driver interface data
2491 * Returns: Operating frequency in MHz, 0 if no shared operation in
2492 * use, or -1 on failure
2494 * This command can be used to request the current operating frequency
2495 * of any virtual interface that shares the same radio to provide
2496 * information for channel selection for other virtual interfaces.
2498 int (*shared_freq)(void *priv);
2501 * get_noa - Get current Notice of Absence attribute payload
2502 * @priv: Private driver interface data
2503 * @buf: Buffer for returning NoA
2504 * @buf_len: Buffer length in octets
2505 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2506 * advertized, or -1 on failure
2508 * This function is used to fetch the current Notice of Absence
2509 * attribute value from GO.
2511 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2514 * set_noa - Set Notice of Absence parameters for GO (testing)
2515 * @priv: Private driver interface data
2517 * @start: Start time in ms from next TBTT
2518 * @duration: Duration in ms
2519 * Returns: 0 on success or -1 on failure
2521 * This function is used to set Notice of Absence parameters for GO. It
2522 * is used only for testing. To disable NoA, all parameters are set to
2525 int (*set_noa)(void *priv, u8 count, int start, int duration);
2528 * set_p2p_powersave - Set P2P power save options
2529 * @priv: Private driver interface data
2530 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2531 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2532 * @ctwindow: 0.. = change (msec), -1 = no change
2533 * Returns: 0 on success or -1 on failure
2535 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2539 * ampdu - Enable/disable aggregation
2540 * @priv: Private driver interface data
2541 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2542 * Returns: 0 on success or -1 on failure
2544 int (*ampdu)(void *priv, int ampdu);
2547 * get_radio_name - Get physical radio name for the device
2548 * @priv: Private driver interface data
2549 * Returns: Radio name or %NULL if not known
2551 * The returned data must not be modified by the caller. It is assumed
2552 * that any interface that has the same radio name as another is
2553 * sharing the same physical radio. This information can be used to
2554 * share scan results etc. information between the virtual interfaces
2555 * to speed up various operations.
2557 const char * (*get_radio_name)(void *priv);
2560 * send_tdls_mgmt - for sending TDLS management packets
2561 * @priv: private driver interface data
2562 * @dst: Destination (peer) MAC address
2563 * @action_code: TDLS action code for the mssage
2564 * @dialog_token: Dialog Token to use in the message (if needed)
2565 * @status_code: Status Code or Reason Code to use (if needed)
2566 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2567 * @initiator: Is the current end the TDLS link initiator
2568 * @buf: TDLS IEs to add to the message
2569 * @len: Length of buf in octets
2570 * Returns: 0 on success, negative (<0) on failure
2572 * This optional function can be used to send packet to driver which is
2573 * responsible for receiving and sending all TDLS packets.
2575 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2576 u8 dialog_token, u16 status_code, u32 peer_capab,
2577 int initiator, const u8 *buf, size_t len);
2580 * tdls_oper - Ask the driver to perform high-level TDLS operations
2581 * @priv: Private driver interface data
2582 * @oper: TDLS high-level operation. See %enum tdls_oper
2583 * @peer: Destination (peer) MAC address
2584 * Returns: 0 on success, negative (<0) on failure
2586 * This optional function can be used to send high-level TDLS commands
2589 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2592 * wnm_oper - Notify driver of the WNM frame reception
2593 * @priv: Private driver interface data
2594 * @oper: WNM operation. See %enum wnm_oper
2595 * @peer: Destination (peer) MAC address
2596 * @buf: Buffer for the driver to fill in (for getting IE)
2597 * @buf_len: Return the len of buf
2598 * Returns: 0 on success, negative (<0) on failure
2600 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2601 u8 *buf, u16 *buf_len);
2604 * set_qos_map - Set QoS Map
2605 * @priv: Private driver interface data
2606 * @qos_map_set: QoS Map
2607 * @qos_map_set_len: Length of QoS Map
2609 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2610 u8 qos_map_set_len);
2613 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2614 * @priv: Private driver interface data
2615 * @ipaddr: IPv4 address for the neigh entry
2616 * @prefixlen: IPv4 address netmask prefix length
2617 * @addr: Corresponding MAC address
2618 * Returns: 0 on success, negative (<0) on failure
2620 int (*br_add_ip_neigh)(void *priv, be32 ipaddr, int prefixlen,
2624 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2625 * @priv: Private driver interface data
2626 * @ipaddr: IPv4 address for the neigh entry
2627 * Returns: 0 on success, negative (<0) on failure
2629 int (*br_delete_ip_neigh)(void *priv, be32 ipaddr);
2632 * br_port_set_attr - Set a bridge port attribute
2633 * @attr: Bridge port attribute to set
2634 * @val: Value to be set
2635 * Returns: 0 on success, negative (<0) on failure
2637 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2641 * br_port_set_attr - Set a bridge network parameter
2642 * @param: Bridge parameter to set
2643 * @val: Value to be set
2644 * Returns: 0 on success, negative (<0) on failure
2646 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2650 * set_wowlan - Set wake-on-wireless triggers
2651 * @priv: Private driver interface data
2652 * @triggers: wowlan triggers
2654 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2657 * signal_poll - Get current connection information
2658 * @priv: Private driver interface data
2659 * @signal_info: Connection info structure
2661 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2664 * set_authmode - Set authentication algorithm(s) for static WEP
2665 * @priv: Private driver interface data
2666 * @authmode: 1=Open System, 2=Shared Key, 3=both
2667 * Returns: 0 on success, -1 on failure
2669 * This function can be used to set authentication algorithms for AP
2670 * mode when static WEP is used. If the driver uses user space MLME/SME
2671 * implementation, there is no need to implement this function.
2673 * DEPRECATED - use set_ap() instead
2675 int (*set_authmode)(void *priv, int authmode);
2679 * driver_cmd - Execute driver-specific command
2680 * @priv: Private driver interface data
2681 * @cmd: Command to execute
2682 * @buf: Return buffer
2683 * @buf_len: Buffer length
2684 * Returns: 0 on success, -1 on failure
2686 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2687 #endif /* ANDROID */
2690 * vendor_cmd - Execute vendor specific command
2691 * @priv: Private driver interface data
2692 * @vendor_id: Vendor id
2693 * @subcmd: Vendor command id
2694 * @data: Vendor command parameters (%NULL if no parameters)
2695 * @data_len: Data length
2696 * @buf: Return buffer (%NULL to ignore reply)
2697 * Returns: 0 on success, negative (<0) on failure
2699 * This function handles vendor specific commands that are passed to
2700 * the driver/device. The command is identified by vendor id and
2701 * command id. Parameters can be passed as argument to the command
2702 * in the data buffer. Reply (if any) will be filled in the supplied
2705 * The exact driver behavior is driver interface and vendor specific. As
2706 * an example, this will be converted to a vendor specific cfg80211
2707 * command in case of the nl80211 driver interface.
2709 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2710 unsigned int subcmd, const u8 *data, size_t data_len,
2711 struct wpabuf *buf);
2714 * set_rekey_info - Set rekey information
2715 * @priv: Private driver interface data
2718 * @replay_ctr: Current EAPOL-Key Replay Counter
2720 * This optional function can be used to provide information for the
2721 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2722 * while the host (including wpa_supplicant) is sleeping.
2724 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2725 const u8 *replay_ctr);
2728 * sta_assoc - Station association indication
2729 * @priv: Private driver interface data
2730 * @own_addr: Source address and BSSID for association frame
2731 * @addr: MAC address of the station to associate
2732 * @reassoc: flag to indicate re-association
2733 * @status: association response status code
2734 * @ie: assoc response ie buffer
2735 * @len: ie buffer length
2736 * Returns: 0 on success, -1 on failure
2738 * This function indicates the driver to send (Re)Association
2739 * Response frame to the station.
2741 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2742 int reassoc, u16 status, const u8 *ie, size_t len);
2745 * sta_auth - Station authentication indication
2746 * @priv: Private driver interface data
2747 * @own_addr: Source address and BSSID for authentication frame
2748 * @addr: MAC address of the station to associate
2749 * @seq: authentication sequence number
2750 * @status: authentication response status code
2751 * @ie: authentication frame ie buffer
2752 * @len: ie buffer length
2754 * This function indicates the driver to send Authentication frame
2757 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2758 u16 seq, u16 status, const u8 *ie, size_t len);
2761 * add_tspec - Add traffic stream
2762 * @priv: Private driver interface data
2763 * @addr: MAC address of the station to associate
2764 * @tspec_ie: tspec ie buffer
2765 * @tspec_ielen: tspec ie length
2766 * Returns: 0 on success, -1 on failure
2768 * This function adds the traffic steam for the station
2769 * and fills the medium_time in tspec_ie.
2771 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2772 size_t tspec_ielen);
2775 * add_sta_node - Add a station node in the driver
2776 * @priv: Private driver interface data
2777 * @addr: MAC address of the station to add
2778 * @auth_alg: authentication algorithm used by the station
2779 * Returns: 0 on success, -1 on failure
2781 * This function adds the station node in the driver, when
2782 * the station gets added by FT-over-DS.
2784 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2787 * sched_scan - Request the driver to initiate scheduled scan
2788 * @priv: Private driver interface data
2789 * @params: Scan parameters
2790 * @interval: Interval between scan cycles in milliseconds
2791 * Returns: 0 on success, -1 on failure
2793 * This operation should be used for scheduled scan offload to
2794 * the hardware. Every time scan results are available, the
2795 * driver should report scan results event for wpa_supplicant
2796 * which will eventually request the results with
2797 * wpa_driver_get_scan_results2(). This operation is optional
2798 * and if not provided or if it returns -1, we fall back to
2799 * normal host-scheduled scans.
2801 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2805 * stop_sched_scan - Request the driver to stop a scheduled scan
2806 * @priv: Private driver interface data
2807 * Returns: 0 on success, -1 on failure
2809 * This should cause the scheduled scan to be stopped and
2810 * results should stop being sent. Must be supported if
2811 * sched_scan is supported.
2813 int (*stop_sched_scan)(void *priv);
2816 * poll_client - Probe (null data or such) the given station
2817 * @priv: Private driver interface data
2818 * @own_addr: MAC address of sending interface
2819 * @addr: MAC address of the station to probe
2820 * @qos: Indicates whether station is QoS station
2822 * This function is used to verify whether an associated station is
2823 * still present. This function does not need to be implemented if the
2824 * driver provides such inactivity polling mechanism.
2826 void (*poll_client)(void *priv, const u8 *own_addr,
2827 const u8 *addr, int qos);
2830 * radio_disable - Disable/enable radio
2831 * @priv: Private driver interface data
2832 * @disabled: 1=disable 0=enable radio
2833 * Returns: 0 on success, -1 on failure
2835 * This optional command is for testing purposes. It can be used to
2836 * disable the radio on a testbed device to simulate out-of-radio-range
2839 int (*radio_disable)(void *priv, int disabled);
2842 * switch_channel - Announce channel switch and migrate the GO to the
2844 * @priv: Private driver interface data
2845 * @settings: Settings for CSA period and new channel
2846 * Returns: 0 on success, -1 on failure
2848 * This function is used to move the GO to the legacy STA channel to
2849 * avoid frequency conflict in single channel concurrency.
2851 int (*switch_channel)(void *priv, struct csa_settings *settings);
2854 * start_dfs_cac - Listen for radar interference on the channel
2855 * @priv: Private driver interface data
2856 * @freq: Channel parameters
2857 * Returns: 0 on success, -1 on failure
2859 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
2862 * stop_ap - Removes beacon from AP
2863 * @priv: Private driver interface data
2864 * Returns: 0 on success, -1 on failure (or if not supported)
2866 * This optional function can be used to disable AP mode related
2867 * configuration. Unlike deinit_ap, it does not change to station
2870 int (*stop_ap)(void *priv);
2873 * get_survey - Retrieve survey data
2874 * @priv: Private driver interface data
2875 * @freq: If set, survey data for the specified frequency is only
2876 * being requested. If not set, all survey data is requested.
2877 * Returns: 0 on success, -1 on failure
2879 * Use this to retrieve:
2881 * - the observed channel noise floor
2882 * - the amount of time we have spent on the channel
2883 * - the amount of time during which we have spent on the channel that
2884 * the radio has determined the medium is busy and we cannot
2886 * - the amount of time we have spent receiving data
2887 * - the amount of time we have spent transmitting data
2889 * This data can be used for spectrum heuristics. One example is
2890 * Automatic Channel Selection (ACS). The channel survey data is
2891 * kept on a linked list on the channel data, one entry is added
2892 * for each survey. The min_nf of the channel is updated for each
2895 int (*get_survey)(void *priv, unsigned int freq);
2898 * status - Get driver interface status information
2899 * @priv: Private driver interface data
2900 * @buf: Buffer for printing tou the status information
2901 * @buflen: Maximum length of the buffer
2902 * Returns: Length of written status information or -1 on failure
2904 int (*status)(void *priv, char *buf, size_t buflen);
2907 * roaming - Set roaming policy for driver-based BSS selection
2908 * @priv: Private driver interface data
2909 * @allowed: Whether roaming within ESS is allowed
2910 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
2911 * Returns: Length of written status information or -1 on failure
2913 * This optional callback can be used to update roaming policy from the
2914 * associate() command (bssid being set there indicates that the driver
2915 * should not roam before getting this roaming() call to allow roaming.
2916 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
2917 * capability, roaming policy is handled within wpa_supplicant and there
2918 * is no need to implement or react to this callback.
2920 int (*roaming)(void *priv, int allowed, const u8 *bssid);
2923 * set_mac_addr - Set MAC address
2924 * @priv: Private driver interface data
2925 * @addr: MAC address to use or %NULL for setting back to permanent
2926 * Returns: 0 on success, -1 on failure
2928 int (*set_mac_addr)(void *priv, const u8 *addr);
2930 #ifdef CONFIG_MACSEC
2931 int (*macsec_init)(void *priv, struct macsec_init_params *params);
2933 int (*macsec_deinit)(void *priv);
2936 * enable_protect_frames - Set protect frames status
2937 * @priv: Private driver interface data
2938 * @enabled: TRUE = protect frames enabled
2939 * FALSE = protect frames disabled
2940 * Returns: 0 on success, -1 on failure (or if not supported)
2942 int (*enable_protect_frames)(void *priv, Boolean enabled);
2945 * set_replay_protect - Set replay protect status and window size
2946 * @priv: Private driver interface data
2947 * @enabled: TRUE = replay protect enabled
2948 * FALSE = replay protect disabled
2949 * @window: replay window size, valid only when replay protect enabled
2950 * Returns: 0 on success, -1 on failure (or if not supported)
2952 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
2955 * set_current_cipher_suite - Set current cipher suite
2956 * @priv: Private driver interface data
2957 * @cs: EUI64 identifier
2958 * @cs_len: Length of the cs buffer in octets
2959 * Returns: 0 on success, -1 on failure (or if not supported)
2961 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
2965 * enable_controlled_port - Set controlled port status
2966 * @priv: Private driver interface data
2967 * @enabled: TRUE = controlled port enabled
2968 * FALSE = controlled port disabled
2969 * Returns: 0 on success, -1 on failure (or if not supported)
2971 int (*enable_controlled_port)(void *priv, Boolean enabled);
2974 * get_receive_lowest_pn - Get receive lowest pn
2975 * @priv: Private driver interface data
2976 * @channel: secure channel
2977 * @an: association number
2978 * @lowest_pn: lowest accept pn
2979 * Returns: 0 on success, -1 on failure (or if not supported)
2981 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
2985 * get_transmit_next_pn - Get transmit next pn
2986 * @priv: Private driver interface data
2987 * @channel: secure channel
2988 * @an: association number
2990 * Returns: 0 on success, -1 on failure (or if not supported)
2992 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
2996 * set_transmit_next_pn - Set transmit next pn
2997 * @priv: Private driver interface data
2998 * @channel: secure channel
2999 * @an: association number
3001 * Returns: 0 on success, -1 on failure (or if not supported)
3003 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3007 * get_available_receive_sc - get available receive channel
3008 * @priv: Private driver interface data
3009 * @channel: secure channel
3010 * Returns: 0 on success, -1 on failure (or if not supported)
3012 int (*get_available_receive_sc)(void *priv, u32 *channel);
3015 * create_receive_sc - create secure channel for receiving
3016 * @priv: Private driver interface data
3017 * @channel: secure channel
3018 * @sci_addr: secure channel identifier - address
3019 * @sci_port: secure channel identifier - port
3020 * @conf_offset: confidentiality offset (0, 30, or 50)
3021 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3023 * Returns: 0 on success, -1 on failure (or if not supported)
3025 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3026 u16 sci_port, unsigned int conf_offset,
3030 * delete_receive_sc - delete secure connection for receiving
3031 * @priv: private driver interface data from init()
3032 * @channel: secure channel
3033 * Returns: 0 on success, -1 on failure
3035 int (*delete_receive_sc)(void *priv, u32 channel);
3038 * create_receive_sa - create secure association for receive
3039 * @priv: private driver interface data from init()
3040 * @channel: secure channel
3041 * @an: association number
3042 * @lowest_pn: the lowest packet number can be received
3043 * @sak: the secure association key
3044 * Returns: 0 on success, -1 on failure
3046 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3047 u32 lowest_pn, const u8 *sak);
3050 * enable_receive_sa - enable the SA for receive
3051 * @priv: private driver interface data from init()
3052 * @channel: secure channel
3053 * @an: association number
3054 * Returns: 0 on success, -1 on failure
3056 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3059 * disable_receive_sa - disable SA for receive
3060 * @priv: private driver interface data from init()
3061 * @channel: secure channel index
3062 * @an: association number
3063 * Returns: 0 on success, -1 on failure
3065 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3068 * get_available_transmit_sc - get available transmit channel
3069 * @priv: Private driver interface data
3070 * @channel: secure channel
3071 * Returns: 0 on success, -1 on failure (or if not supported)
3073 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3076 * create_transmit_sc - create secure connection for transmit
3077 * @priv: private driver interface data from init()
3078 * @channel: secure channel
3079 * @sci_addr: secure channel identifier - address
3080 * @sci_port: secure channel identifier - port
3081 * Returns: 0 on success, -1 on failure
3083 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3084 u16 sci_port, unsigned int conf_offset);
3087 * delete_transmit_sc - delete secure connection for transmit
3088 * @priv: private driver interface data from init()
3089 * @channel: secure channel
3090 * Returns: 0 on success, -1 on failure
3092 int (*delete_transmit_sc)(void *priv, u32 channel);
3095 * create_transmit_sa - create secure association for transmit
3096 * @priv: private driver interface data from init()
3097 * @channel: secure channel index
3098 * @an: association number
3099 * @next_pn: the packet number used as next transmit packet
3100 * @confidentiality: True if the SA is to provide confidentiality
3101 * as well as integrity
3102 * @sak: the secure association key
3103 * Returns: 0 on success, -1 on failure
3105 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3106 Boolean confidentiality, const u8 *sak);
3109 * enable_transmit_sa - enable SA for transmit
3110 * @priv: private driver interface data from init()
3111 * @channel: secure channel
3112 * @an: association number
3113 * Returns: 0 on success, -1 on failure
3115 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3118 * disable_transmit_sa - disable SA for transmit
3119 * @priv: private driver interface data from init()
3120 * @channel: secure channel
3121 * @an: association number
3122 * Returns: 0 on success, -1 on failure
3124 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3125 #endif /* CONFIG_MACSEC */
3128 * init_mesh - Driver specific initialization for mesh
3129 * @priv: Private driver interface data
3130 * Returns: 0 on success, -1 on failure
3132 int (*init_mesh)(void *priv);
3135 * join_mesh - Join a mesh network
3136 * @priv: Private driver interface data
3137 * @params: Mesh configuration parameters
3138 * Returns: 0 on success, -1 on failure
3140 int (*join_mesh)(void *priv,
3141 struct wpa_driver_mesh_join_params *params);
3144 * leave_mesh - Leave a mesh network
3145 * @priv: Private driver interface data
3146 * Returns 0 on success, -1 on failure
3148 int (*leave_mesh)(void *priv);
3153 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3155 enum wpa_event_type {
3157 * EVENT_ASSOC - Association completed
3159 * This event needs to be delivered when the driver completes IEEE
3160 * 802.11 association or reassociation successfully.
3161 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3162 * after this event has been generated. In addition, optional
3163 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3164 * more information about the association. If the driver interface gets
3165 * both of these events at the same time, it can also include the
3166 * assoc_info data in EVENT_ASSOC call.
3171 * EVENT_DISASSOC - Association lost
3173 * This event should be called when association is lost either due to
3174 * receiving deauthenticate or disassociate frame from the AP or when
3175 * sending either of these frames to the current AP. If the driver
3176 * supports separate deauthentication event, EVENT_DISASSOC should only
3177 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3178 * In AP mode, union wpa_event_data::disassoc_info is required.
3183 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3185 * This event must be delivered when a Michael MIC error is detected by
3186 * the local driver. Additional data for event processing is
3187 * provided with union wpa_event_data::michael_mic_failure. This
3188 * information is used to request new encyption key and to initiate
3189 * TKIP countermeasures if needed.
3191 EVENT_MICHAEL_MIC_FAILURE,
3194 * EVENT_SCAN_RESULTS - Scan results available
3196 * This event must be called whenever scan results are available to be
3197 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3198 * is expected to be used some time after struct wpa_driver_ops::scan()
3199 * is called. If the driver provides an unsolicited event when the scan
3200 * has been completed, this event can be used to trigger
3201 * EVENT_SCAN_RESULTS call. If such event is not available from the
3202 * driver, the driver wrapper code is expected to use a registered
3203 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3204 * scan is expected to be completed. Optional information about
3205 * completed scan can be provided with union wpa_event_data::scan_info.
3210 * EVENT_ASSOCINFO - Report optional extra information for association
3212 * This event can be used to report extra association information for
3213 * EVENT_ASSOC processing. This extra information includes IEs from
3214 * association frames and Beacon/Probe Response frames in union
3215 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3216 * EVENT_ASSOC. Alternatively, the driver interface can include
3217 * assoc_info data in the EVENT_ASSOC call if it has all the
3218 * information available at the same point.
3223 * EVENT_INTERFACE_STATUS - Report interface status changes
3225 * This optional event can be used to report changes in interface
3226 * status (interface added/removed) using union
3227 * wpa_event_data::interface_status. This can be used to trigger
3228 * wpa_supplicant to stop and re-start processing for the interface,
3229 * e.g., when a cardbus card is ejected/inserted.
3231 EVENT_INTERFACE_STATUS,
3234 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3236 * This event can be used to inform wpa_supplicant about candidates for
3237 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3238 * for scan request (ap_scan=2 mode), this event is required for
3239 * pre-authentication. If wpa_supplicant is performing scan request
3240 * (ap_scan=1), this event is optional since scan results can be used
3241 * to add pre-authentication candidates. union
3242 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3243 * candidate and priority of the candidate, e.g., based on the signal
3244 * strength, in order to try to pre-authenticate first with candidates
3245 * that are most likely targets for re-association.
3247 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3248 * on the candidate list. In addition, it can be called for the current
3249 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3250 * will automatically skip pre-authentication in cases where a valid
3251 * PMKSA exists. When more than one candidate exists, this event should
3252 * be generated once for each candidate.
3254 * Driver will be notified about successful pre-authentication with
3255 * struct wpa_driver_ops::add_pmkid() calls.
3257 EVENT_PMKID_CANDIDATE,
3260 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3262 * This event can be used to inform wpa_supplicant about desire to set
3263 * up secure direct link connection between two stations as defined in
3264 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3265 * STAKey negotiation. The caller will need to set peer address for the
3271 * EVENT_TDLS - Request TDLS operation
3273 * This event can be used to request a TDLS operation to be performed.
3278 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3280 * The driver is expected to report the received FT IEs from
3281 * FT authentication sequence from the AP. The FT IEs are included in
3282 * the extra information in union wpa_event_data::ft_ies.
3287 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3289 * The driver can use this event to inform wpa_supplicant about a STA
3290 * in an IBSS with which protected frames could be exchanged. This
3291 * event starts RSN authentication with the other STA to authenticate
3292 * the STA and set up encryption keys with it.
3294 EVENT_IBSS_RSN_START,
3297 * EVENT_AUTH - Authentication result
3299 * This event should be called when authentication attempt has been
3300 * completed. This is only used if the driver supports separate
3301 * authentication step (struct wpa_driver_ops::authenticate).
3302 * Information about authentication result is included in
3303 * union wpa_event_data::auth.
3308 * EVENT_DEAUTH - Authentication lost
3310 * This event should be called when authentication is lost either due
3311 * to receiving deauthenticate frame from the AP or when sending that
3312 * frame to the current AP.
3313 * In AP mode, union wpa_event_data::deauth_info is required.
3318 * EVENT_ASSOC_REJECT - Association rejected
3320 * This event should be called when (re)association attempt has been
3321 * rejected by the AP. Information about the association response is
3322 * included in union wpa_event_data::assoc_reject.
3327 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3329 EVENT_AUTH_TIMED_OUT,
3332 * EVENT_ASSOC_TIMED_OUT - Association timed out
3334 EVENT_ASSOC_TIMED_OUT,
3337 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
3342 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3344 EVENT_WPS_BUTTON_PUSHED,
3347 * EVENT_TX_STATUS - Report TX status
3352 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3354 EVENT_RX_FROM_UNKNOWN,
3357 * EVENT_RX_MGMT - Report RX of a management frame
3362 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3364 * This event is used to indicate when the driver has started the
3365 * requested remain-on-channel duration. Information about the
3366 * operation is included in union wpa_event_data::remain_on_channel.
3368 EVENT_REMAIN_ON_CHANNEL,
3371 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3373 * This event is used to indicate when the driver has completed
3374 * remain-on-channel duration, i.e., may noot be available on the
3375 * requested channel anymore. Information about the
3376 * operation is included in union wpa_event_data::remain_on_channel.
3378 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3381 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
3383 * This event is used only by driver_test.c and userspace MLME.
3388 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3390 * This event is used to indicate when a Probe Request frame has been
3391 * received. Information about the received frame is included in
3392 * union wpa_event_data::rx_probe_req. The driver is required to report
3393 * these events only after successfully completed probe_req_report()
3394 * commands to request the events (i.e., report parameter is non-zero)
3395 * in station mode. In AP mode, Probe Request frames should always be
3401 * EVENT_NEW_STA - New wired device noticed
3403 * This event is used to indicate that a new device has been detected
3404 * in a network that does not use association-like functionality (i.e.,
3405 * mainly wired Ethernet). This can be used to start EAPOL
3406 * authenticator when receiving a frame from a device. The address of
3407 * the device is included in union wpa_event_data::new_sta.
3412 * EVENT_EAPOL_RX - Report received EAPOL frame
3414 * When in AP mode with hostapd, this event is required to be used to
3415 * deliver the receive EAPOL frames from the driver. With
3416 * %wpa_supplicant, this event is used only if the send_eapol() handler
3417 * is used to override the use of l2_packet for EAPOL frame TX.
3422 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3424 * This event is used to indicate changes in the signal strength
3425 * observed in frames received from the current AP if signal strength
3426 * monitoring has been enabled with signal_monitor().
3428 EVENT_SIGNAL_CHANGE,
3431 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3433 * This event is used to indicate that the interface was enabled after
3434 * having been previously disabled, e.g., due to rfkill.
3436 EVENT_INTERFACE_ENABLED,
3439 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3441 * This event is used to indicate that the interface was disabled,
3442 * e.g., due to rfkill.
3444 EVENT_INTERFACE_DISABLED,
3447 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3449 * This event is used to indicate that the channel list has changed,
3450 * e.g., because of a regulatory domain change triggered by scan
3451 * results including an AP advertising a country code.
3453 EVENT_CHANNEL_LIST_CHANGED,
3456 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3458 * This event is used to indicate that the driver cannot maintain this
3459 * interface in its operation mode anymore. The most likely use for
3460 * this is to indicate that AP mode operation is not available due to
3461 * operating channel would need to be changed to a DFS channel when
3462 * the driver does not support radar detection and another virtual
3463 * interfaces caused the operating channel to change. Other similar
3464 * resource conflicts could also trigger this for station mode
3465 * interfaces. This event can be propagated when channel switching
3468 EVENT_INTERFACE_UNAVAILABLE,
3471 * EVENT_BEST_CHANNEL
3473 * Driver generates this event whenever it detects a better channel
3474 * (e.g., based on RSSI or channel use). This information can be used
3475 * to improve channel selection for a new AP/P2P group.
3480 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3482 * This event should be called when a Deauthentication frame is dropped
3483 * due to it not being protected (MFP/IEEE 802.11w).
3484 * union wpa_event_data::unprot_deauth is required to provide more
3485 * details of the frame.
3487 EVENT_UNPROT_DEAUTH,
3490 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3492 * This event should be called when a Disassociation frame is dropped
3493 * due to it not being protected (MFP/IEEE 802.11w).
3494 * union wpa_event_data::unprot_disassoc is required to provide more
3495 * details of the frame.
3497 EVENT_UNPROT_DISASSOC,
3500 * EVENT_STATION_LOW_ACK
3502 * Driver generates this event whenever it detected that a particular
3503 * station was lost. Detection can be through massive transmission
3504 * failures for example.
3506 EVENT_STATION_LOW_ACK,
3509 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3511 EVENT_IBSS_PEER_LOST,
3514 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3516 * This event carries the new replay counter to notify wpa_supplicant
3517 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3518 * completed Group Key Handshake while the host (including
3519 * wpa_supplicant was sleeping).
3521 EVENT_DRIVER_GTK_REKEY,
3524 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3526 EVENT_SCHED_SCAN_STOPPED,
3529 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3531 * This event indicates that the station responded to the poll
3532 * initiated with @poll_client.
3534 EVENT_DRIVER_CLIENT_POLL_OK,
3537 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3539 EVENT_EAPOL_TX_STATUS,
3542 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3544 * Described in wpa_event_data.ch_switch
3549 * EVENT_WNM - Request WNM operation
3551 * This event can be used to request a WNM operation to be performed.
3556 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3558 * This event indicates that the driver reported a connection failure
3559 * with the specified client (for example, max client reached, etc.) in
3562 EVENT_CONNECT_FAILED_REASON,
3565 * EVENT_RADAR_DETECTED - Notify of radar detection
3567 * A radar has been detected on the supplied frequency, hostapd should
3568 * react accordingly (e.g., change channel).
3570 EVENT_DFS_RADAR_DETECTED,
3573 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3575 * After a successful CAC, the channel can be marked clear and used.
3577 EVENT_DFS_CAC_FINISHED,
3580 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3582 * The CAC was not successful, and the channel remains in the previous
3583 * state. This may happen due to a radar beeing detected or other
3584 * external influences.
3586 EVENT_DFS_CAC_ABORTED,
3589 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3591 * The channel which was previously unavailable is now available again.
3593 EVENT_DFS_NOP_FINISHED,
3596 * EVENT_SURVEY - Received survey data
3598 * This event gets triggered when a driver query is issued for survey
3599 * data and the requested data becomes available. The returned data is
3600 * stored in struct survey_results. The results provide at most one
3601 * survey entry for each frequency and at minimum will provide one
3602 * survey entry for one frequency. The survey data can be os_malloc()'d
3603 * and then os_free()'d, so the event callback must only copy data.
3608 * EVENT_SCAN_STARTED - Scan started
3610 * This indicates that driver has started a scan operation either based
3611 * on a request from wpa_supplicant/hostapd or from another application.
3612 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3613 * completed (either successfully or by getting cancelled).
3618 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3620 * This event indicates a set of frequency ranges that should be avoided
3621 * to reduce issues due to interference or internal co-existence
3622 * information in the driver.
3624 EVENT_AVOID_FREQUENCIES,
3627 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3629 EVENT_NEW_PEER_CANDIDATE
3635 * struct freq_survey - Channel survey info
3637 * @ifidx: Interface index in which this survey was observed
3638 * @freq: Center of frequency of the surveyed channel
3639 * @nf: Channel noise floor in dBm
3640 * @channel_time: Amount of time in ms the radio spent on the channel
3641 * @channel_time_busy: Amount of time in ms the radio detected some signal
3642 * that indicated to the radio the channel was not clear
3643 * @channel_time_rx: Amount of time the radio spent receiving data
3644 * @channel_time_tx: Amount of time the radio spent transmitting data
3645 * @filled: bitmask indicating which fields have been reported, see
3646 * SURVEY_HAS_* defines.
3647 * @list: Internal list pointers
3649 struct freq_survey {
3654 u64 channel_time_busy;
3655 u64 channel_time_rx;
3656 u64 channel_time_tx;
3657 unsigned int filled;
3658 struct dl_list list;
3661 #define SURVEY_HAS_NF BIT(0)
3662 #define SURVEY_HAS_CHAN_TIME BIT(1)
3663 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3664 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3665 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3669 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3671 union wpa_event_data {
3673 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3675 * This structure is optional for EVENT_ASSOC calls and required for
3676 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3677 * driver interface does not need to generate separate EVENT_ASSOCINFO
3682 * reassoc - Flag to indicate association or reassociation
3687 * req_ies - (Re)Association Request IEs
3689 * If the driver generates WPA/RSN IE, this event data must be
3690 * returned for WPA handshake to have needed information. If
3691 * wpa_supplicant-generated WPA/RSN IE is used, this
3692 * information event is optional.
3694 * This should start with the first IE (fixed fields before IEs
3695 * are not included).
3700 * req_ies_len - Length of req_ies in bytes
3705 * resp_ies - (Re)Association Response IEs
3707 * Optional association data from the driver. This data is not
3708 * required WPA, but may be useful for some protocols and as
3709 * such, should be reported if this is available to the driver
3712 * This should start with the first IE (fixed fields before IEs
3713 * are not included).
3718 * resp_ies_len - Length of resp_ies in bytes
3720 size_t resp_ies_len;
3723 * beacon_ies - Beacon or Probe Response IEs
3725 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3726 * Probe Response frames from the current AP (i.e., the one
3727 * that the client just associated with). This information is
3728 * used to update WPA/RSN IE for the AP. If this field is not
3729 * set, the results from previous scan will be used. If no
3730 * data for the new AP is found, scan results will be requested
3731 * again (without scan request). At this point, the driver is
3732 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3735 * This should start with the first IE (fixed fields before IEs
3736 * are not included).
3738 const u8 *beacon_ies;
3741 * beacon_ies_len - Length of beacon_ies */
3742 size_t beacon_ies_len;
3745 * freq - Frequency of the operational channel in MHz
3750 * addr - Station address (for AP mode)
3755 * The following is the key management offload information
3758 * @key_replay_ctr_len
3766 * authorized - Status of key management offload,
3772 * key_replay_ctr - Key replay counter value last used
3773 * in a valid EAPOL-Key frame
3775 const u8 *key_replay_ctr;
3778 * key_replay_ctr_len - The length of key_replay_ctr
3780 size_t key_replay_ctr_len;
3783 * ptk_kck - The derived PTK KCK
3788 * ptk_kek_len - The length of ptk_kck
3793 * ptk_kek - The derived PTK KEK
3798 * ptk_kek_len - The length of ptk_kek
3804 * struct disassoc_info - Data for EVENT_DISASSOC events
3806 struct disassoc_info {
3808 * addr - Station address (for AP mode)
3813 * reason_code - Reason Code (host byte order) used in
3814 * Deauthentication frame
3819 * ie - Optional IE(s) in Disassociation frame
3824 * ie_len - Length of ie buffer in octets
3829 * locally_generated - Whether the frame was locally generated
3831 int locally_generated;
3835 * struct deauth_info - Data for EVENT_DEAUTH events
3837 struct deauth_info {
3839 * addr - Station address (for AP mode)
3844 * reason_code - Reason Code (host byte order) used in
3845 * Deauthentication frame
3850 * ie - Optional IE(s) in Deauthentication frame
3855 * ie_len - Length of ie buffer in octets
3860 * locally_generated - Whether the frame was locally generated
3862 int locally_generated;
3866 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3868 struct michael_mic_failure {
3871 } michael_mic_failure;
3874 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3876 struct interface_status {
3879 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3884 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3886 struct pmkid_candidate {
3887 /** BSSID of the PMKID candidate */
3889 /** Smaller the index, higher the priority */
3891 /** Whether RSN IE includes pre-authenticate flag */
3896 * struct stkstart - Data for EVENT_STKSTART
3903 * struct tdls - Data for EVENT_TDLS
3909 TDLS_REQUEST_TEARDOWN
3911 u16 reason_code; /* for teardown */
3915 * struct wnm - Data for EVENT_WNM
3933 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3935 * During FT (IEEE 802.11r) authentication sequence, the driver is
3936 * expected to use this event to report received FT IEs (MDIE, FTIE,
3937 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3938 * IEs for the next message will be delivered through the
3939 * struct wpa_driver_ops::update_ft_ies() callback.
3945 u8 target_ap[ETH_ALEN];
3946 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3948 /** Length of ric_ies buffer in octets */
3953 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3955 struct ibss_rsn_start {
3960 * struct auth_info - Data for EVENT_AUTH events
3966 u16 auth_transaction;
3973 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3975 struct assoc_reject {
3977 * bssid - BSSID of the AP that rejected association
3982 * resp_ies - (Re)Association Response IEs
3984 * Optional association data from the driver. This data is not
3985 * required WPA, but may be useful for some protocols and as
3986 * such, should be reported if this is available to the driver
3989 * This should start with the first IE (fixed fields before IEs
3990 * are not included).
3995 * resp_ies_len - Length of resp_ies in bytes
3997 size_t resp_ies_len;
4000 * status_code - Status Code from (Re)association Response
4005 struct timeout_event {
4010 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
4019 * struct tx_status - Data for EVENT_TX_STATUS events
4031 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4033 struct rx_from_unknown {
4040 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4048 * drv_priv - Pointer to store driver private BSS information
4050 * If not set to NULL, this is used for comparison with
4051 * hostapd_data->drv_priv to determine which BSS should process
4057 * freq - Frequency (in MHz) on which the frame was received
4062 * ssi_signal - Signal strength in dBm (or 0 if not available)
4068 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4070 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4072 struct remain_on_channel {
4074 * freq - Channel frequency in MHz
4079 * duration - Duration to remain on the channel in milliseconds
4081 unsigned int duration;
4082 } remain_on_channel;
4085 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4086 * @aborted: Whether the scan was aborted
4087 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4088 * @num_freqs: Number of entries in freqs array
4089 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4091 * @num_ssids: Number of entries in ssids array
4097 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4102 * struct mlme_rx - Data for EVENT_MLME_RX events
4113 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4115 struct rx_probe_req {
4117 * sa - Source address of the received Probe Request frame
4122 * da - Destination address of the received Probe Request frame
4123 * or %NULL if not available
4128 * bssid - BSSID of the received Probe Request frame or %NULL
4134 * ie - IEs from the Probe Request body
4139 * ie_len - Length of ie buffer in octets
4144 * signal - signal strength in dBm (or 0 if not available)
4150 * struct new_sta - Data for EVENT_NEW_STA events
4157 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4166 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4168 struct wpa_signal_info signal_change;
4171 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4172 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4173 * @freq_5: Best 5 GHz band channel frequency in MHz
4174 * @freq_overall: Best channel frequency in MHz
4176 * 0 can be used to indicate no preference in either band.
4178 struct best_channel {
4184 struct unprot_deauth {
4190 struct unprot_disassoc {
4197 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4198 * @addr: station address
4205 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4207 struct ibss_peer_lost {
4212 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4214 struct driver_gtk_rekey {
4216 const u8 *replay_ctr;
4220 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4221 * @addr: station address
4223 struct client_poll {
4228 * struct eapol_tx_status
4229 * @dst: Original destination
4230 * @data: Data starting with IEEE 802.1X header (!)
4231 * @data_len: Length of data
4232 * @ack: Indicates ack or lost frame
4234 * This corresponds to hapd_send_eapol if the frame sent
4235 * there isn't just reported as EVENT_TX_STATUS.
4237 struct eapol_tx_status {
4246 * @freq: Frequency of new channel in MHz
4247 * @ht_enabled: Whether this is an HT channel
4248 * @ch_offset: Secondary channel offset
4249 * @ch_width: Channel width
4250 * @cf1: Center frequency 1
4251 * @cf2: Center frequency 2
4257 enum chan_width ch_width;
4263 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4264 * @addr: Remote client address
4265 * @code: Reason code for connection failure
4267 struct connect_failed_reason {
4273 } connect_failed_reason;
4276 * struct dfs_event - Data for radar detected events
4277 * @freq: Frequency of the channel in MHz
4283 enum chan_width chan_width;
4289 * survey_results - Survey result data for EVENT_SURVEY
4290 * @freq_filter: Requested frequency survey filter, 0 if request
4291 * was for all survey data
4292 * @survey_list: Linked list of survey data
4294 struct survey_results {
4295 unsigned int freq_filter;
4296 struct dl_list survey_list; /* struct freq_survey */
4300 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4301 * @initiator: Initiator of the regulatory change
4302 * @type: Regulatory change type
4303 * @alpha2: Country code (or "" if not available)
4305 struct channel_list_changed {
4306 enum reg_change_initiator initiator;
4309 } channel_list_changed;
4312 * freq_range - List of frequency ranges
4314 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4316 struct wpa_freq_range_list freq_range;
4321 * @peer: Peer address
4323 * @ie_len: Length of @ies
4325 * Notification of new candidate mesh peer.
4336 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4337 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4338 * with struct wpa_driver_ops::init()
4339 * @event: event type (defined above)
4340 * @data: possible extra data for the event
4342 * Driver wrapper code should call this function whenever an event is received
4345 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4346 union wpa_event_data *data);
4350 * The following inline functions are provided for convenience to simplify
4351 * event indication for some of the common events.
4354 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4355 size_t ielen, int reassoc)
4357 union wpa_event_data event;
4358 os_memset(&event, 0, sizeof(event));
4359 event.assoc_info.reassoc = reassoc;
4360 event.assoc_info.req_ies = ie;
4361 event.assoc_info.req_ies_len = ielen;
4362 event.assoc_info.addr = addr;
4363 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4366 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4368 union wpa_event_data event;
4369 os_memset(&event, 0, sizeof(event));
4370 event.disassoc_info.addr = addr;
4371 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4374 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4377 union wpa_event_data event;
4378 os_memset(&event, 0, sizeof(event));
4379 event.eapol_rx.src = src;
4380 event.eapol_rx.data = data;
4381 event.eapol_rx.data_len = data_len;
4382 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4385 /* driver_common.c */
4386 void wpa_scan_results_free(struct wpa_scan_results *res);
4388 /* Convert wpa_event_type to a string for logging */
4389 const char * event_to_string(enum wpa_event_type event);
4391 /* Convert chan_width to a string for logging and control interfaces */
4392 const char * channel_width_to_string(enum chan_width width);
4394 int ht_supported(const struct hostapd_hw_modes *mode);
4395 int vht_supported(const struct hostapd_hw_modes *mode);
4397 /* NULL terminated array of linked in driver wrappers */
4398 extern struct wpa_driver_ops *wpa_drivers[];
4400 #endif /* DRIVER_H */