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 */
1378 * struct wpa_driver_ops - Driver interface API definition
1380 * This structure defines the API that each driver interface needs to implement
1381 * for core wpa_supplicant code. All driver specific functionality is captured
1384 struct wpa_driver_ops {
1385 /** Name of the driver interface */
1387 /** One line description of the driver interface */
1391 * get_bssid - Get the current BSSID
1392 * @priv: private driver interface data
1393 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1395 * Returns: 0 on success, -1 on failure
1397 * Query kernel driver for the current BSSID and copy it to bssid.
1398 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1401 int (*get_bssid)(void *priv, u8 *bssid);
1404 * get_ssid - Get the current SSID
1405 * @priv: private driver interface data
1406 * @ssid: buffer for SSID (at least 32 bytes)
1408 * Returns: Length of the SSID on success, -1 on failure
1410 * Query kernel driver for the current SSID and copy it to ssid.
1411 * Returning zero is recommended if the STA is not associated.
1413 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1414 * can, at least in theory, contain control characters (including nul)
1415 * and as such, should be processed as binary data, not a printable
1418 int (*get_ssid)(void *priv, u8 *ssid);
1421 * set_key - Configure encryption key
1422 * @ifname: Interface name (for multi-SSID/VLAN support)
1423 * @priv: private driver interface data
1424 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1425 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1426 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1427 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1428 * %WPA_ALG_BIP_CMAC_256);
1429 * %WPA_ALG_NONE clears the key.
1430 * @addr: Address of the peer STA (BSSID of the current AP when setting
1431 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1432 * broadcast keys, %NULL for default keys that are used both for
1433 * broadcast and unicast; when clearing keys, %NULL is used to
1434 * indicate that both the broadcast-only and default key of the
1435 * specified key index is to be cleared
1436 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1438 * @set_tx: configure this key as the default Tx key (only used when
1439 * driver does not support separate unicast/individual key
1440 * @seq: sequence number/packet number, seq_len octets, the next
1441 * packet number to be used for in replay protection; configured
1442 * for Rx keys (in most cases, this is only used with broadcast
1443 * keys and set to zero for unicast keys); %NULL if not set
1444 * @seq_len: length of the seq, depends on the algorithm:
1445 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1446 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1448 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1449 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1451 * Returns: 0 on success, -1 on failure
1453 * Configure the given key for the kernel driver. If the driver
1454 * supports separate individual keys (4 default keys + 1 individual),
1455 * addr can be used to determine whether the key is default or
1456 * individual. If only 4 keys are supported, the default key with key
1457 * index 0 is used as the individual key. STA must be configured to use
1458 * it as the default Tx key (set_tx is set) and accept Rx for all the
1459 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1460 * broadcast keys, so key index 0 is available for this kind of
1463 * Please note that TKIP keys include separate TX and RX MIC keys and
1464 * some drivers may expect them in different order than wpa_supplicant
1465 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1466 * will trigger Michael MIC errors. This can be fixed by changing the
1467 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1468 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1469 * example on how this can be done.
1471 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1472 const u8 *addr, int key_idx, int set_tx,
1473 const u8 *seq, size_t seq_len,
1474 const u8 *key, size_t key_len);
1477 * init - Initialize driver interface
1478 * @ctx: context to be used when calling wpa_supplicant functions,
1479 * e.g., wpa_supplicant_event()
1480 * @ifname: interface name, e.g., wlan0
1482 * Returns: Pointer to private data, %NULL on failure
1484 * Initialize driver interface, including event processing for kernel
1485 * driver events (e.g., associated, scan results, Michael MIC failure).
1486 * This function can allocate a private configuration data area for
1487 * @ctx, file descriptor, interface name, etc. information that may be
1488 * needed in future driver operations. If this is not used, non-NULL
1489 * value will need to be returned because %NULL is used to indicate
1490 * failure. The returned value will be used as 'void *priv' data for
1491 * all other driver_ops functions.
1493 * The main event loop (eloop.c) of wpa_supplicant can be used to
1494 * register callback for read sockets (eloop_register_read_sock()).
1496 * See below for more information about events and
1497 * wpa_supplicant_event() function.
1499 void * (*init)(void *ctx, const char *ifname);
1502 * deinit - Deinitialize driver interface
1503 * @priv: private driver interface data from init()
1505 * Shut down driver interface and processing of driver events. Free
1506 * private data buffer if one was allocated in init() handler.
1508 void (*deinit)(void *priv);
1511 * set_param - Set driver configuration parameters
1512 * @priv: private driver interface data from init()
1513 * @param: driver specific configuration parameters
1515 * Returns: 0 on success, -1 on failure
1517 * Optional handler for notifying driver interface about configuration
1518 * parameters (driver_param).
1520 int (*set_param)(void *priv, const char *param);
1523 * set_countermeasures - Enable/disable TKIP countermeasures
1524 * @priv: private driver interface data
1525 * @enabled: 1 = countermeasures enabled, 0 = disabled
1527 * Returns: 0 on success, -1 on failure
1529 * Configure TKIP countermeasures. When these are enabled, the driver
1530 * should drop all received and queued frames that are using TKIP.
1532 int (*set_countermeasures)(void *priv, int enabled);
1535 * deauthenticate - Request driver to deauthenticate
1536 * @priv: private driver interface data
1537 * @addr: peer address (BSSID of the AP)
1538 * @reason_code: 16-bit reason code to be sent in the deauthentication
1541 * Returns: 0 on success, -1 on failure
1543 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1546 * associate - Request driver to associate
1547 * @priv: private driver interface data
1548 * @params: association parameters
1550 * Returns: 0 on success, -1 on failure
1552 int (*associate)(void *priv,
1553 struct wpa_driver_associate_params *params);
1556 * add_pmkid - Add PMKSA cache entry to the driver
1557 * @priv: private driver interface data
1558 * @bssid: BSSID for the PMKSA cache entry
1559 * @pmkid: PMKID for the PMKSA cache entry
1561 * Returns: 0 on success, -1 on failure
1563 * This function is called when a new PMK is received, as a result of
1564 * either normal authentication or RSN pre-authentication.
1566 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1567 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1568 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1569 * driver_ops function does not need to be implemented. Likewise, if
1570 * the driver does not support WPA, this function is not needed.
1572 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1575 * remove_pmkid - Remove PMKSA cache entry to the driver
1576 * @priv: private driver interface data
1577 * @bssid: BSSID for the PMKSA cache entry
1578 * @pmkid: PMKID for the PMKSA cache entry
1580 * Returns: 0 on success, -1 on failure
1582 * This function is called when the supplicant drops a PMKSA cache
1583 * entry for any reason.
1585 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1586 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1587 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1588 * from wpa_supplicant, this driver_ops function does not need to be
1589 * implemented. Likewise, if the driver does not support WPA, this
1590 * function is not needed.
1592 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1595 * flush_pmkid - Flush PMKSA cache
1596 * @priv: private driver interface data
1598 * Returns: 0 on success, -1 on failure
1600 * This function is called when the supplicant drops all PMKSA cache
1601 * entries for any reason.
1603 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1604 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1605 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1606 * from wpa_supplicant, this driver_ops function does not need to be
1607 * implemented. Likewise, if the driver does not support WPA, this
1608 * function is not needed.
1610 int (*flush_pmkid)(void *priv);
1613 * get_capa - Get driver capabilities
1614 * @priv: private driver interface data
1616 * Returns: 0 on success, -1 on failure
1618 * Get driver/firmware/hardware capabilities.
1620 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1623 * poll - Poll driver for association information
1624 * @priv: private driver interface data
1626 * This is an option callback that can be used when the driver does not
1627 * provide event mechanism for association events. This is called when
1628 * receiving WPA EAPOL-Key messages that require association
1629 * information. The driver interface is supposed to generate associnfo
1630 * event before returning from this callback function. In addition, the
1631 * driver interface should generate an association event after having
1632 * sent out associnfo.
1634 void (*poll)(void *priv);
1637 * get_ifname - Get interface name
1638 * @priv: private driver interface data
1640 * Returns: Pointer to the interface name. This can differ from the
1641 * interface name used in init() call. Init() is called first.
1643 * This optional function can be used to allow the driver interface to
1644 * replace the interface name with something else, e.g., based on an
1645 * interface mapping from a more descriptive name.
1647 const char * (*get_ifname)(void *priv);
1650 * get_mac_addr - Get own MAC address
1651 * @priv: private driver interface data
1653 * Returns: Pointer to own MAC address or %NULL on failure
1655 * This optional function can be used to get the own MAC address of the
1656 * device from the driver interface code. This is only needed if the
1657 * l2_packet implementation for the OS does not provide easy access to
1659 const u8 * (*get_mac_addr)(void *priv);
1662 * send_eapol - Optional function for sending EAPOL packets
1663 * @priv: private driver interface data
1664 * @dest: Destination MAC address
1666 * @data: EAPOL packet starting with IEEE 802.1X header
1667 * @data_len: Size of the EAPOL packet
1669 * Returns: 0 on success, -1 on failure
1671 * This optional function can be used to override l2_packet operations
1672 * with driver specific functionality. If this function pointer is set,
1673 * l2_packet module is not used at all and the driver interface code is
1674 * responsible for receiving and sending all EAPOL packets. The
1675 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1676 * event. The driver interface is required to implement get_mac_addr()
1677 * handler if send_eapol() is used.
1679 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1680 const u8 *data, size_t data_len);
1683 * set_operstate - Sets device operating state to DORMANT or UP
1684 * @priv: private driver interface data
1685 * @state: 0 = dormant, 1 = up
1686 * Returns: 0 on success, -1 on failure
1688 * This is an optional function that can be used on operating systems
1689 * that support a concept of controlling network device state from user
1690 * space applications. This function, if set, gets called with
1691 * state = 1 when authentication has been completed and with state = 0
1692 * when connection is lost.
1694 int (*set_operstate)(void *priv, int state);
1697 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1698 * @priv: Private driver interface data
1699 * @addr: Address of the station for which to set protection (may be
1700 * %NULL for group keys)
1701 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1702 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1703 * Returns: 0 on success, -1 on failure
1705 * This is an optional function that can be used to set the driver to
1706 * require protection for Tx and/or Rx frames. This uses the layer
1707 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1708 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1709 * set protection operation; instead, they set protection implicitly
1710 * based on configured keys.
1712 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1716 * get_hw_feature_data - Get hardware support data (channels and rates)
1717 * @priv: Private driver interface data
1718 * @num_modes: Variable for returning the number of returned modes
1719 * flags: Variable for returning hardware feature flags
1720 * Returns: Pointer to allocated hardware data on success or %NULL on
1721 * failure. Caller is responsible for freeing this.
1723 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1728 * send_mlme - Send management frame from MLME
1729 * @priv: Private driver interface data
1730 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1731 * @data_len: Size of the management frame
1732 * @noack: Do not wait for this frame to be acked (disable retries)
1733 * Returns: 0 on success, -1 on failure
1735 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1739 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1740 * @priv: Private driver interface data
1741 * @md: Mobility domain (2 octets) (also included inside ies)
1742 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1743 * @ies_len: Length of FT IEs in bytes
1744 * Returns: 0 on success, -1 on failure
1746 * The supplicant uses this callback to let the driver know that keying
1747 * material for FT is available and that the driver can use the
1748 * provided IEs in the next message in FT authentication sequence.
1750 * This function is only needed for driver that support IEEE 802.11r
1751 * (Fast BSS Transition).
1753 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1757 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1758 * @priv: Private driver interface data
1759 * @action: Action field value
1760 * @target_ap: Target AP address
1761 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1762 * @ies_len: Length of FT IEs in bytes
1763 * Returns: 0 on success, -1 on failure
1765 * The supplicant uses this callback to request the driver to transmit
1766 * an FT Action frame (action category 6) for over-the-DS fast BSS
1769 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1770 const u8 *ies, size_t ies_len);
1773 * get_scan_results2 - Fetch the latest scan results
1774 * @priv: private driver interface data
1776 * Returns: Allocated buffer of scan results (caller is responsible for
1777 * freeing the data structure) on success, NULL on failure
1779 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1782 * set_country - Set country
1783 * @priv: Private driver interface data
1784 * @alpha2: country to which to switch to
1785 * Returns: 0 on success, -1 on failure
1787 * This function is for drivers which support some form
1788 * of setting a regulatory domain.
1790 int (*set_country)(void *priv, const char *alpha2);
1793 * get_country - Get country
1794 * @priv: Private driver interface data
1795 * @alpha2: Buffer for returning country code (at least 3 octets)
1796 * Returns: 0 on success, -1 on failure
1798 int (*get_country)(void *priv, char *alpha2);
1801 * global_init - Global driver initialization
1802 * Returns: Pointer to private data (global), %NULL on failure
1804 * This optional function is called to initialize the driver wrapper
1805 * for global data, i.e., data that applies to all interfaces. If this
1806 * function is implemented, global_deinit() will also need to be
1807 * implemented to free the private data. The driver will also likely
1808 * use init2() function instead of init() to get the pointer to global
1809 * data available to per-interface initializer.
1811 void * (*global_init)(void);
1814 * global_deinit - Global driver deinitialization
1815 * @priv: private driver global data from global_init()
1817 * Terminate any global driver related functionality and free the
1818 * global data structure.
1820 void (*global_deinit)(void *priv);
1823 * init2 - Initialize driver interface (with global data)
1824 * @ctx: context to be used when calling wpa_supplicant functions,
1825 * e.g., wpa_supplicant_event()
1826 * @ifname: interface name, e.g., wlan0
1827 * @global_priv: private driver global data from global_init()
1828 * Returns: Pointer to private data, %NULL on failure
1830 * This function can be used instead of init() if the driver wrapper
1833 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1836 * get_interfaces - Get information about available interfaces
1837 * @global_priv: private driver global data from global_init()
1838 * Returns: Allocated buffer of interface information (caller is
1839 * responsible for freeing the data structure) on success, NULL on
1842 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1845 * scan2 - Request the driver to initiate scan
1846 * @priv: private driver interface data
1847 * @params: Scan parameters
1849 * Returns: 0 on success, -1 on failure
1851 * Once the scan results are ready, the driver should report scan
1852 * results event for wpa_supplicant which will eventually request the
1853 * results with wpa_driver_get_scan_results2().
1855 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1858 * authenticate - Request driver to authenticate
1859 * @priv: private driver interface data
1860 * @params: authentication parameters
1861 * Returns: 0 on success, -1 on failure
1863 * This is an optional function that can be used with drivers that
1864 * support separate authentication and association steps, i.e., when
1865 * wpa_supplicant can act as the SME. If not implemented, associate()
1866 * function is expected to take care of IEEE 802.11 authentication,
1869 int (*authenticate)(void *priv,
1870 struct wpa_driver_auth_params *params);
1873 * set_ap - Set Beacon and Probe Response information for AP mode
1874 * @priv: Private driver interface data
1875 * @params: Parameters to use in AP mode
1877 * This function is used to configure Beacon template and/or extra IEs
1878 * to add for Beacon and Probe Response frames for the driver in
1879 * AP mode. The driver is responsible for building the full Beacon
1880 * frame by concatenating the head part with TIM IE generated by the
1881 * driver/firmware and finishing with the tail part. Depending on the
1882 * driver architectue, this can be done either by using the full
1883 * template or the set of additional IEs (e.g., WPS and P2P IE).
1884 * Similarly, Probe Response processing depends on the driver design.
1885 * If the driver (or firmware) takes care of replying to Probe Request
1886 * frames, the extra IEs provided here needs to be added to the Probe
1889 * Returns: 0 on success, -1 on failure
1891 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1894 * set_acl - Set ACL in AP mode
1895 * @priv: Private driver interface data
1896 * @params: Parameters to configure ACL
1897 * Returns: 0 on success, -1 on failure
1899 * This is used only for the drivers which support MAC address ACL.
1901 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1904 * hapd_init - Initialize driver interface (hostapd only)
1905 * @hapd: Pointer to hostapd context
1906 * @params: Configuration for the driver wrapper
1907 * Returns: Pointer to private data, %NULL on failure
1909 * This function is used instead of init() or init2() when the driver
1910 * wrapper is used with hostapd.
1912 void * (*hapd_init)(struct hostapd_data *hapd,
1913 struct wpa_init_params *params);
1916 * hapd_deinit - Deinitialize driver interface (hostapd only)
1917 * @priv: Private driver interface data from hapd_init()
1919 void (*hapd_deinit)(void *priv);
1922 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1923 * @priv: Private driver interface data
1924 * @params: BSS parameters
1925 * Returns: 0 on success, -1 on failure
1927 * This is an optional function to configure the kernel driver to
1928 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1929 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1930 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1931 * for Beacon frames.
1933 * DEPRECATED - use set_ap() instead
1935 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1938 * set_privacy - Enable/disable privacy (AP only)
1939 * @priv: Private driver interface data
1940 * @enabled: 1 = privacy enabled, 0 = disabled
1941 * Returns: 0 on success, -1 on failure
1943 * This is an optional function to configure privacy field in the
1944 * kernel driver for Beacon frames. This can be left undefined (set to
1945 * %NULL) if the driver uses the Beacon template from set_ap().
1947 * DEPRECATED - use set_ap() instead
1949 int (*set_privacy)(void *priv, int enabled);
1952 * get_seqnum - Fetch the current TSC/packet number (AP only)
1953 * @ifname: The interface name (main or virtual)
1954 * @priv: Private driver interface data
1955 * @addr: MAC address of the station or %NULL for group keys
1957 * @seq: Buffer for returning the latest used TSC/packet number
1958 * Returns: 0 on success, -1 on failure
1960 * This function is used to fetch the last used TSC/packet number for
1961 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1962 * keys, so there is no strict requirement on implementing support for
1963 * unicast keys (i.e., addr != %NULL).
1965 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1969 * flush - Flush all association stations (AP only)
1970 * @priv: Private driver interface data
1971 * Returns: 0 on success, -1 on failure
1973 * This function requests the driver to disassociate all associated
1974 * stations. This function does not need to be implemented if the
1975 * driver does not process association frames internally.
1977 int (*flush)(void *priv);
1980 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1981 * @priv: Private driver interface data
1982 * @elem: Information elements
1983 * @elem_len: Length of the elem buffer in octets
1984 * Returns: 0 on success, -1 on failure
1986 * This is an optional function to add information elements in the
1987 * kernel driver for Beacon and Probe Response frames. This can be left
1988 * undefined (set to %NULL) if the driver uses the Beacon template from
1991 * DEPRECATED - use set_ap() instead
1993 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1996 * read_sta_data - Fetch station data
1997 * @priv: Private driver interface data
1998 * @data: Buffer for returning station information
1999 * @addr: MAC address of the station
2000 * Returns: 0 on success, -1 on failure
2002 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2006 * hapd_send_eapol - Send an EAPOL packet (AP only)
2007 * @priv: private driver interface data
2008 * @addr: Destination MAC address
2009 * @data: EAPOL packet starting with IEEE 802.1X header
2010 * @data_len: Length of the EAPOL packet in octets
2011 * @encrypt: Whether the frame should be encrypted
2012 * @own_addr: Source MAC address
2013 * @flags: WPA_STA_* flags for the destination station
2015 * Returns: 0 on success, -1 on failure
2017 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2018 size_t data_len, int encrypt,
2019 const u8 *own_addr, u32 flags);
2022 * sta_deauth - Deauthenticate a station (AP only)
2023 * @priv: Private driver interface data
2024 * @own_addr: Source address and BSSID for the Deauthentication frame
2025 * @addr: MAC address of the station to deauthenticate
2026 * @reason: Reason code for the Deauthentiation frame
2027 * Returns: 0 on success, -1 on failure
2029 * This function requests a specific station to be deauthenticated and
2030 * a Deauthentication frame to be sent to it.
2032 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2036 * sta_disassoc - Disassociate a station (AP only)
2037 * @priv: Private driver interface data
2038 * @own_addr: Source address and BSSID for the Disassociation frame
2039 * @addr: MAC address of the station to disassociate
2040 * @reason: Reason code for the Disassociation frame
2041 * Returns: 0 on success, -1 on failure
2043 * This function requests a specific station to be disassociated and
2044 * a Disassociation frame to be sent to it.
2046 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2050 * sta_remove - Remove a station entry (AP only)
2051 * @priv: Private driver interface data
2052 * @addr: MAC address of the station to be removed
2053 * Returns: 0 on success, -1 on failure
2055 int (*sta_remove)(void *priv, const u8 *addr);
2058 * hapd_get_ssid - Get the current SSID (AP only)
2059 * @priv: Private driver interface data
2060 * @buf: Buffer for returning the SSID
2061 * @len: Maximum length of the buffer
2062 * Returns: Length of the SSID on success, -1 on failure
2064 * This function need not be implemented if the driver uses Beacon
2065 * template from set_ap() and does not reply to Probe Request frames.
2067 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2070 * hapd_set_ssid - Set SSID (AP only)
2071 * @priv: Private driver interface data
2073 * @len: Length of the SSID in octets
2074 * Returns: 0 on success, -1 on failure
2076 * DEPRECATED - use set_ap() instead
2078 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2081 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2082 * @priv: Private driver interface data
2083 * @enabled: 1 = countermeasures enabled, 0 = disabled
2084 * Returns: 0 on success, -1 on failure
2086 * This need not be implemented if the driver does not take care of
2087 * association processing.
2089 int (*hapd_set_countermeasures)(void *priv, int enabled);
2092 * sta_add - Add a station entry
2093 * @priv: Private driver interface data
2094 * @params: Station parameters
2095 * Returns: 0 on success, -1 on failure
2097 * This function is used to add a station entry to the driver once the
2098 * station has completed association. This is only used if the driver
2099 * does not take care of association processing.
2101 * With TDLS, this function is also used to add or set (params->set 1)
2102 * TDLS peer entries.
2104 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2107 * get_inact_sec - Get station inactivity duration (AP only)
2108 * @priv: Private driver interface data
2109 * @addr: Station address
2110 * Returns: Number of seconds station has been inactive, -1 on failure
2112 int (*get_inact_sec)(void *priv, const u8 *addr);
2115 * sta_clear_stats - Clear station statistics (AP only)
2116 * @priv: Private driver interface data
2117 * @addr: Station address
2118 * Returns: 0 on success, -1 on failure
2120 int (*sta_clear_stats)(void *priv, const u8 *addr);
2123 * set_freq - Set channel/frequency (AP only)
2124 * @priv: Private driver interface data
2125 * @freq: Channel parameters
2126 * Returns: 0 on success, -1 on failure
2128 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2131 * set_rts - Set RTS threshold
2132 * @priv: Private driver interface data
2133 * @rts: RTS threshold in octets
2134 * Returns: 0 on success, -1 on failure
2136 int (*set_rts)(void *priv, int rts);
2139 * set_frag - Set fragmentation threshold
2140 * @priv: Private driver interface data
2141 * @frag: Fragmentation threshold in octets
2142 * Returns: 0 on success, -1 on failure
2144 int (*set_frag)(void *priv, int frag);
2147 * sta_set_flags - Set station flags (AP only)
2148 * @priv: Private driver interface data
2149 * @addr: Station address
2150 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2151 * @flags_or: Bitmap of WPA_STA_* flags to add
2152 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2153 * Returns: 0 on success, -1 on failure
2155 int (*sta_set_flags)(void *priv, const u8 *addr,
2156 int total_flags, int flags_or, int flags_and);
2159 * set_tx_queue_params - Set TX queue parameters
2160 * @priv: Private driver interface data
2161 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2165 * @burst_time: Maximum length for bursting in 0.1 msec units
2167 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2168 int cw_max, int burst_time);
2171 * if_add - Add a virtual interface
2172 * @priv: Private driver interface data
2173 * @type: Interface type
2174 * @ifname: Interface name for the new virtual interface
2175 * @addr: Local address to use for the interface or %NULL to use the
2176 * parent interface address
2177 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2178 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2179 * not allowed (applies only to %WPA_IF_AP_BSS type)
2180 * @force_ifname: Buffer for returning an interface name that the
2181 * driver ended up using if it differs from the requested ifname
2182 * @if_addr: Buffer for returning the allocated interface address
2183 * (this may differ from the requested addr if the driver cannot
2184 * change interface address)
2185 * @bridge: Bridge interface to use or %NULL if no bridge configured
2186 * @use_existing: Whether to allow existing interface to be used
2187 * Returns: 0 on success, -1 on failure
2189 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2190 const char *ifname, const u8 *addr, void *bss_ctx,
2191 void **drv_priv, char *force_ifname, u8 *if_addr,
2192 const char *bridge, int use_existing);
2195 * if_remove - Remove a virtual interface
2196 * @priv: Private driver interface data
2197 * @type: Interface type
2198 * @ifname: Interface name of the virtual interface to be removed
2199 * Returns: 0 on success, -1 on failure
2201 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2202 const char *ifname);
2205 * set_sta_vlan - Bind a station into a specific interface (AP only)
2206 * @priv: Private driver interface data
2207 * @ifname: Interface (main or virtual BSS or VLAN)
2208 * @addr: MAC address of the associated station
2210 * Returns: 0 on success, -1 on failure
2212 * This function is used to bind a station to a specific virtual
2213 * interface. It is only used if when virtual interfaces are supported,
2214 * e.g., to assign stations to different VLAN interfaces based on
2215 * information from a RADIUS server. This allows separate broadcast
2216 * domains to be used with a single BSS.
2218 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2222 * commit - Optional commit changes handler (AP only)
2223 * @priv: driver private data
2224 * Returns: 0 on success, -1 on failure
2226 * This optional handler function can be registered if the driver
2227 * interface implementation needs to commit changes (e.g., by setting
2228 * network interface up) at the end of initial configuration. If set,
2229 * this handler will be called after initial setup has been completed.
2231 int (*commit)(void *priv);
2234 * send_ether - Send an ethernet packet (AP only)
2235 * @priv: private driver interface data
2236 * @dst: Destination MAC address
2237 * @src: Source MAC address
2239 * @data: EAPOL packet starting with IEEE 802.1X header
2240 * @data_len: Length of the EAPOL packet in octets
2241 * Returns: 0 on success, -1 on failure
2243 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2244 const u8 *data, size_t data_len);
2247 * set_radius_acl_auth - Notification of RADIUS ACL change
2248 * @priv: Private driver interface data
2249 * @mac: MAC address of the station
2250 * @accepted: Whether the station was accepted
2251 * @session_timeout: Session timeout for the station
2252 * Returns: 0 on success, -1 on failure
2254 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2255 u32 session_timeout);
2258 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2259 * @priv: Private driver interface data
2260 * @mac: MAC address of the station
2261 * Returns: 0 on success, -1 on failure
2263 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2266 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2267 * @priv: Private driver interface data
2268 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2269 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2271 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2272 * to remove extra IE(s)
2273 * Returns: 0 on success, -1 on failure
2275 * This is an optional function to add WPS IE in the kernel driver for
2276 * Beacon and Probe Response frames. This can be left undefined (set
2277 * to %NULL) if the driver uses the Beacon template from set_ap()
2278 * and does not process Probe Request frames. If the driver takes care
2279 * of (Re)Association frame processing, the assocresp buffer includes
2280 * WPS IE(s) that need to be added to (Re)Association Response frames
2281 * whenever a (Re)Association Request frame indicated use of WPS.
2283 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2284 * frames when operating as a GO. The driver is responsible for adding
2285 * timing related attributes (e.g., NoA) in addition to the IEs
2286 * included here by appending them after these buffers. This call is
2287 * also used to provide Probe Response IEs for P2P Listen state
2288 * operations for drivers that generate the Probe Response frames
2291 * DEPRECATED - use set_ap() instead
2293 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2294 const struct wpabuf *proberesp,
2295 const struct wpabuf *assocresp);
2298 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2299 * @priv: Private driver interface data
2300 * @authorized: Whether the port is authorized
2301 * Returns: 0 on success, -1 on failure
2303 int (*set_supp_port)(void *priv, int authorized);
2306 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2307 * @priv: Private driver interface data
2308 * @addr: MAC address of the associated station
2309 * @aid: Association ID
2310 * @val: 1 = bind to 4-address WDS; 0 = unbind
2311 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2312 * to indicate that bridge is not to be used
2313 * @ifname_wds: Buffer to return the interface name for the new WDS
2314 * station or %NULL to indicate name is not returned.
2315 * Returns: 0 on success, -1 on failure
2317 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2318 const char *bridge_ifname, char *ifname_wds);
2321 * send_action - Transmit an Action frame
2322 * @priv: Private driver interface data
2323 * @freq: Frequency (in MHz) of the channel
2324 * @wait: Time to wait off-channel for a response (in ms), or zero
2325 * @dst: Destination MAC address (Address 1)
2326 * @src: Source MAC address (Address 2)
2327 * @bssid: BSSID (Address 3)
2329 * @data_len: data length in octets
2330 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2331 * Returns: 0 on success, -1 on failure
2333 * This command can be used to request the driver to transmit an action
2334 * frame to the specified destination.
2336 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2337 * be transmitted on the given channel and the device will wait for a
2338 * response on that channel for the given wait time.
2340 * If the flag is not set, the wait time will be ignored. In this case,
2341 * if a remain-on-channel duration is in progress, the frame must be
2342 * transmitted on that channel; alternatively the frame may be sent on
2343 * the current operational channel (if in associated state in station
2344 * mode or while operating as an AP.)
2346 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2347 const u8 *dst, const u8 *src, const u8 *bssid,
2348 const u8 *data, size_t data_len, int no_cck);
2351 * send_action_cancel_wait - Cancel action frame TX wait
2352 * @priv: Private driver interface data
2354 * This command cancels the wait time associated with sending an action
2355 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2356 * set in the driver flags.
2358 void (*send_action_cancel_wait)(void *priv);
2361 * remain_on_channel - Remain awake on a channel
2362 * @priv: Private driver interface data
2363 * @freq: Frequency (in MHz) of the channel
2364 * @duration: Duration in milliseconds
2365 * Returns: 0 on success, -1 on failure
2367 * This command is used to request the driver to remain awake on the
2368 * specified channel for the specified duration and report received
2369 * Action frames with EVENT_RX_MGMT events. Optionally, received
2370 * Probe Request frames may also be requested to be reported by calling
2371 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2373 * The driver may not be at the requested channel when this function
2374 * returns, i.e., the return code is only indicating whether the
2375 * request was accepted. The caller will need to wait until the
2376 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2377 * completed the channel change. This may take some time due to other
2378 * need for the radio and the caller should be prepared to timing out
2379 * its wait since there are no guarantees on when this request can be
2382 int (*remain_on_channel)(void *priv, unsigned int freq,
2383 unsigned int duration);
2386 * cancel_remain_on_channel - Cancel remain-on-channel operation
2387 * @priv: Private driver interface data
2389 * This command can be used to cancel a remain-on-channel operation
2390 * before its originally requested duration has passed. This could be
2391 * used, e.g., when remain_on_channel() is used to request extra time
2392 * to receive a response to an Action frame and the response is
2393 * received when there is still unneeded time remaining on the
2394 * remain-on-channel operation.
2396 int (*cancel_remain_on_channel)(void *priv);
2399 * probe_req_report - Request Probe Request frames to be indicated
2400 * @priv: Private driver interface data
2401 * @report: Whether to report received Probe Request frames
2402 * Returns: 0 on success, -1 on failure (or if not supported)
2404 * This command can be used to request the driver to indicate when
2405 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2406 * Since this operation may require extra resources, e.g., due to less
2407 * optimal hardware/firmware RX filtering, many drivers may disable
2408 * Probe Request reporting at least in station mode. This command is
2409 * used to notify the driver when the Probe Request frames need to be
2410 * reported, e.g., during remain-on-channel operations.
2412 int (*probe_req_report)(void *priv, int report);
2415 * deinit_ap - Deinitialize AP mode
2416 * @priv: Private driver interface data
2417 * Returns: 0 on success, -1 on failure (or if not supported)
2419 * This optional function can be used to disable AP mode related
2420 * configuration. If the interface was not dynamically added,
2421 * change the driver mode to station mode to allow normal station
2422 * operations like scanning to be completed.
2424 int (*deinit_ap)(void *priv);
2427 * deinit_p2p_cli - Deinitialize P2P client mode
2428 * @priv: Private driver interface data
2429 * Returns: 0 on success, -1 on failure (or if not supported)
2431 * This optional function can be used to disable P2P client mode. If the
2432 * interface was not dynamically added, change the interface type back
2435 int (*deinit_p2p_cli)(void *priv);
2438 * suspend - Notification on system suspend/hibernate event
2439 * @priv: Private driver interface data
2441 void (*suspend)(void *priv);
2444 * resume - Notification on system resume/thaw event
2445 * @priv: Private driver interface data
2447 void (*resume)(void *priv);
2450 * signal_monitor - Set signal monitoring parameters
2451 * @priv: Private driver interface data
2452 * @threshold: Threshold value for signal change events; 0 = disabled
2453 * @hysteresis: Minimum change in signal strength before indicating a
2455 * Returns: 0 on success, -1 on failure (or if not supported)
2457 * This function can be used to configure monitoring of signal strength
2458 * with the current AP. Whenever signal strength drops below the
2459 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2460 * should be generated assuming the signal strength has changed at
2461 * least %hysteresis from the previously indicated signal change event.
2463 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2466 * send_frame - Send IEEE 802.11 frame (testing use only)
2467 * @priv: Private driver interface data
2468 * @data: IEEE 802.11 frame with IEEE 802.11 header
2469 * @data_len: Size of the frame
2470 * @encrypt: Whether to encrypt the frame (if keys are set)
2471 * Returns: 0 on success, -1 on failure
2473 * This function is only used for debugging purposes and is not
2474 * required to be implemented for normal operations.
2476 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2480 * shared_freq - Get operating frequency of shared interface(s)
2481 * @priv: Private driver interface data
2482 * Returns: Operating frequency in MHz, 0 if no shared operation in
2483 * use, or -1 on failure
2485 * This command can be used to request the current operating frequency
2486 * of any virtual interface that shares the same radio to provide
2487 * information for channel selection for other virtual interfaces.
2489 int (*shared_freq)(void *priv);
2492 * get_noa - Get current Notice of Absence attribute payload
2493 * @priv: Private driver interface data
2494 * @buf: Buffer for returning NoA
2495 * @buf_len: Buffer length in octets
2496 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2497 * advertized, or -1 on failure
2499 * This function is used to fetch the current Notice of Absence
2500 * attribute value from GO.
2502 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2505 * set_noa - Set Notice of Absence parameters for GO (testing)
2506 * @priv: Private driver interface data
2508 * @start: Start time in ms from next TBTT
2509 * @duration: Duration in ms
2510 * Returns: 0 on success or -1 on failure
2512 * This function is used to set Notice of Absence parameters for GO. It
2513 * is used only for testing. To disable NoA, all parameters are set to
2516 int (*set_noa)(void *priv, u8 count, int start, int duration);
2519 * set_p2p_powersave - Set P2P power save options
2520 * @priv: Private driver interface data
2521 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2522 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2523 * @ctwindow: 0.. = change (msec), -1 = no change
2524 * Returns: 0 on success or -1 on failure
2526 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2530 * ampdu - Enable/disable aggregation
2531 * @priv: Private driver interface data
2532 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2533 * Returns: 0 on success or -1 on failure
2535 int (*ampdu)(void *priv, int ampdu);
2538 * get_radio_name - Get physical radio name for the device
2539 * @priv: Private driver interface data
2540 * Returns: Radio name or %NULL if not known
2542 * The returned data must not be modified by the caller. It is assumed
2543 * that any interface that has the same radio name as another is
2544 * sharing the same physical radio. This information can be used to
2545 * share scan results etc. information between the virtual interfaces
2546 * to speed up various operations.
2548 const char * (*get_radio_name)(void *priv);
2551 * send_tdls_mgmt - for sending TDLS management packets
2552 * @priv: private driver interface data
2553 * @dst: Destination (peer) MAC address
2554 * @action_code: TDLS action code for the mssage
2555 * @dialog_token: Dialog Token to use in the message (if needed)
2556 * @status_code: Status Code or Reason Code to use (if needed)
2557 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2558 * @initiator: Is the current end the TDLS link initiator
2559 * @buf: TDLS IEs to add to the message
2560 * @len: Length of buf in octets
2561 * Returns: 0 on success, negative (<0) on failure
2563 * This optional function can be used to send packet to driver which is
2564 * responsible for receiving and sending all TDLS packets.
2566 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2567 u8 dialog_token, u16 status_code, u32 peer_capab,
2568 int initiator, const u8 *buf, size_t len);
2571 * tdls_oper - Ask the driver to perform high-level TDLS operations
2572 * @priv: Private driver interface data
2573 * @oper: TDLS high-level operation. See %enum tdls_oper
2574 * @peer: Destination (peer) MAC address
2575 * Returns: 0 on success, negative (<0) on failure
2577 * This optional function can be used to send high-level TDLS commands
2580 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2583 * wnm_oper - Notify driver of the WNM frame reception
2584 * @priv: Private driver interface data
2585 * @oper: WNM operation. See %enum wnm_oper
2586 * @peer: Destination (peer) MAC address
2587 * @buf: Buffer for the driver to fill in (for getting IE)
2588 * @buf_len: Return the len of buf
2589 * Returns: 0 on success, negative (<0) on failure
2591 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2592 u8 *buf, u16 *buf_len);
2595 * set_qos_map - Set QoS Map
2596 * @priv: Private driver interface data
2597 * @qos_map_set: QoS Map
2598 * @qos_map_set_len: Length of QoS Map
2600 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2601 u8 qos_map_set_len);
2604 * set_wowlan - Set wake-on-wireless triggers
2605 * @priv: Private driver interface data
2606 * @triggers: wowlan triggers
2608 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2611 * signal_poll - Get current connection information
2612 * @priv: Private driver interface data
2613 * @signal_info: Connection info structure
2615 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2618 * set_authmode - Set authentication algorithm(s) for static WEP
2619 * @priv: Private driver interface data
2620 * @authmode: 1=Open System, 2=Shared Key, 3=both
2621 * Returns: 0 on success, -1 on failure
2623 * This function can be used to set authentication algorithms for AP
2624 * mode when static WEP is used. If the driver uses user space MLME/SME
2625 * implementation, there is no need to implement this function.
2627 * DEPRECATED - use set_ap() instead
2629 int (*set_authmode)(void *priv, int authmode);
2633 * driver_cmd - Execute driver-specific command
2634 * @priv: Private driver interface data
2635 * @cmd: Command to execute
2636 * @buf: Return buffer
2637 * @buf_len: Buffer length
2638 * Returns: 0 on success, -1 on failure
2640 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2641 #endif /* ANDROID */
2644 * vendor_cmd - Execute vendor specific command
2645 * @priv: Private driver interface data
2646 * @vendor_id: Vendor id
2647 * @subcmd: Vendor command id
2648 * @data: Vendor command parameters (%NULL if no parameters)
2649 * @data_len: Data length
2650 * @buf: Return buffer (%NULL to ignore reply)
2651 * Returns: 0 on success, negative (<0) on failure
2653 * This function handles vendor specific commands that are passed to
2654 * the driver/device. The command is identified by vendor id and
2655 * command id. Parameters can be passed as argument to the command
2656 * in the data buffer. Reply (if any) will be filled in the supplied
2659 * The exact driver behavior is driver interface and vendor specific. As
2660 * an example, this will be converted to a vendor specific cfg80211
2661 * command in case of the nl80211 driver interface.
2663 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2664 unsigned int subcmd, const u8 *data, size_t data_len,
2665 struct wpabuf *buf);
2668 * set_rekey_info - Set rekey information
2669 * @priv: Private driver interface data
2672 * @replay_ctr: Current EAPOL-Key Replay Counter
2674 * This optional function can be used to provide information for the
2675 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2676 * while the host (including wpa_supplicant) is sleeping.
2678 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2679 const u8 *replay_ctr);
2682 * sta_assoc - Station association indication
2683 * @priv: Private driver interface data
2684 * @own_addr: Source address and BSSID for association frame
2685 * @addr: MAC address of the station to associate
2686 * @reassoc: flag to indicate re-association
2687 * @status: association response status code
2688 * @ie: assoc response ie buffer
2689 * @len: ie buffer length
2690 * Returns: 0 on success, -1 on failure
2692 * This function indicates the driver to send (Re)Association
2693 * Response frame to the station.
2695 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2696 int reassoc, u16 status, const u8 *ie, size_t len);
2699 * sta_auth - Station authentication indication
2700 * @priv: Private driver interface data
2701 * @own_addr: Source address and BSSID for authentication frame
2702 * @addr: MAC address of the station to associate
2703 * @seq: authentication sequence number
2704 * @status: authentication response status code
2705 * @ie: authentication frame ie buffer
2706 * @len: ie buffer length
2708 * This function indicates the driver to send Authentication frame
2711 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2712 u16 seq, u16 status, const u8 *ie, size_t len);
2715 * add_tspec - Add traffic stream
2716 * @priv: Private driver interface data
2717 * @addr: MAC address of the station to associate
2718 * @tspec_ie: tspec ie buffer
2719 * @tspec_ielen: tspec ie length
2720 * Returns: 0 on success, -1 on failure
2722 * This function adds the traffic steam for the station
2723 * and fills the medium_time in tspec_ie.
2725 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2726 size_t tspec_ielen);
2729 * add_sta_node - Add a station node in the driver
2730 * @priv: Private driver interface data
2731 * @addr: MAC address of the station to add
2732 * @auth_alg: authentication algorithm used by the station
2733 * Returns: 0 on success, -1 on failure
2735 * This function adds the station node in the driver, when
2736 * the station gets added by FT-over-DS.
2738 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2741 * sched_scan - Request the driver to initiate scheduled scan
2742 * @priv: Private driver interface data
2743 * @params: Scan parameters
2744 * @interval: Interval between scan cycles in milliseconds
2745 * Returns: 0 on success, -1 on failure
2747 * This operation should be used for scheduled scan offload to
2748 * the hardware. Every time scan results are available, the
2749 * driver should report scan results event for wpa_supplicant
2750 * which will eventually request the results with
2751 * wpa_driver_get_scan_results2(). This operation is optional
2752 * and if not provided or if it returns -1, we fall back to
2753 * normal host-scheduled scans.
2755 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2759 * stop_sched_scan - Request the driver to stop a scheduled scan
2760 * @priv: Private driver interface data
2761 * Returns: 0 on success, -1 on failure
2763 * This should cause the scheduled scan to be stopped and
2764 * results should stop being sent. Must be supported if
2765 * sched_scan is supported.
2767 int (*stop_sched_scan)(void *priv);
2770 * poll_client - Probe (null data or such) the given station
2771 * @priv: Private driver interface data
2772 * @own_addr: MAC address of sending interface
2773 * @addr: MAC address of the station to probe
2774 * @qos: Indicates whether station is QoS station
2776 * This function is used to verify whether an associated station is
2777 * still present. This function does not need to be implemented if the
2778 * driver provides such inactivity polling mechanism.
2780 void (*poll_client)(void *priv, const u8 *own_addr,
2781 const u8 *addr, int qos);
2784 * radio_disable - Disable/enable radio
2785 * @priv: Private driver interface data
2786 * @disabled: 1=disable 0=enable radio
2787 * Returns: 0 on success, -1 on failure
2789 * This optional command is for testing purposes. It can be used to
2790 * disable the radio on a testbed device to simulate out-of-radio-range
2793 int (*radio_disable)(void *priv, int disabled);
2796 * switch_channel - Announce channel switch and migrate the GO to the
2798 * @priv: Private driver interface data
2799 * @settings: Settings for CSA period and new channel
2800 * Returns: 0 on success, -1 on failure
2802 * This function is used to move the GO to the legacy STA channel to
2803 * avoid frequency conflict in single channel concurrency.
2805 int (*switch_channel)(void *priv, struct csa_settings *settings);
2808 * start_dfs_cac - Listen for radar interference on the channel
2809 * @priv: Private driver interface data
2810 * @freq: Channel parameters
2811 * Returns: 0 on success, -1 on failure
2813 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
2816 * stop_ap - Removes beacon from AP
2817 * @priv: Private driver interface data
2818 * Returns: 0 on success, -1 on failure (or if not supported)
2820 * This optional function can be used to disable AP mode related
2821 * configuration. Unlike deinit_ap, it does not change to station
2824 int (*stop_ap)(void *priv);
2827 * get_survey - Retrieve survey data
2828 * @priv: Private driver interface data
2829 * @freq: If set, survey data for the specified frequency is only
2830 * being requested. If not set, all survey data is requested.
2831 * Returns: 0 on success, -1 on failure
2833 * Use this to retrieve:
2835 * - the observed channel noise floor
2836 * - the amount of time we have spent on the channel
2837 * - the amount of time during which we have spent on the channel that
2838 * the radio has determined the medium is busy and we cannot
2840 * - the amount of time we have spent receiving data
2841 * - the amount of time we have spent transmitting data
2843 * This data can be used for spectrum heuristics. One example is
2844 * Automatic Channel Selection (ACS). The channel survey data is
2845 * kept on a linked list on the channel data, one entry is added
2846 * for each survey. The min_nf of the channel is updated for each
2849 int (*get_survey)(void *priv, unsigned int freq);
2852 * status - Get driver interface status information
2853 * @priv: Private driver interface data
2854 * @buf: Buffer for printing tou the status information
2855 * @buflen: Maximum length of the buffer
2856 * Returns: Length of written status information or -1 on failure
2858 int (*status)(void *priv, char *buf, size_t buflen);
2861 * roaming - Set roaming policy for driver-based BSS selection
2862 * @priv: Private driver interface data
2863 * @allowed: Whether roaming within ESS is allowed
2864 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
2865 * Returns: Length of written status information or -1 on failure
2867 * This optional callback can be used to update roaming policy from the
2868 * associate() command (bssid being set there indicates that the driver
2869 * should not roam before getting this roaming() call to allow roaming.
2870 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
2871 * capability, roaming policy is handled within wpa_supplicant and there
2872 * is no need to implement or react to this callback.
2874 int (*roaming)(void *priv, int allowed, const u8 *bssid);
2877 * set_mac_addr - Set MAC address
2878 * @priv: Private driver interface data
2879 * @addr: MAC address to use or %NULL for setting back to permanent
2880 * Returns: 0 on success, -1 on failure
2882 int (*set_mac_addr)(void *priv, const u8 *addr);
2884 #ifdef CONFIG_MACSEC
2885 int (*macsec_init)(void *priv, struct macsec_init_params *params);
2887 int (*macsec_deinit)(void *priv);
2890 * enable_protect_frames - Set protect frames status
2891 * @priv: Private driver interface data
2892 * @enabled: TRUE = protect frames enabled
2893 * FALSE = protect frames disabled
2894 * Returns: 0 on success, -1 on failure (or if not supported)
2896 int (*enable_protect_frames)(void *priv, Boolean enabled);
2899 * set_replay_protect - Set replay protect status and window size
2900 * @priv: Private driver interface data
2901 * @enabled: TRUE = replay protect enabled
2902 * FALSE = replay protect disabled
2903 * @window: replay window size, valid only when replay protect enabled
2904 * Returns: 0 on success, -1 on failure (or if not supported)
2906 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
2909 * set_current_cipher_suite - Set current cipher suite
2910 * @priv: Private driver interface data
2911 * @cs: EUI64 identifier
2912 * @cs_len: Length of the cs buffer in octets
2913 * Returns: 0 on success, -1 on failure (or if not supported)
2915 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
2919 * enable_controlled_port - Set controlled port status
2920 * @priv: Private driver interface data
2921 * @enabled: TRUE = controlled port enabled
2922 * FALSE = controlled port disabled
2923 * Returns: 0 on success, -1 on failure (or if not supported)
2925 int (*enable_controlled_port)(void *priv, Boolean enabled);
2928 * get_receive_lowest_pn - Get receive lowest pn
2929 * @priv: Private driver interface data
2930 * @channel: secure channel
2931 * @an: association number
2932 * @lowest_pn: lowest accept pn
2933 * Returns: 0 on success, -1 on failure (or if not supported)
2935 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
2939 * get_transmit_next_pn - Get transmit next pn
2940 * @priv: Private driver interface data
2941 * @channel: secure channel
2942 * @an: association number
2944 * Returns: 0 on success, -1 on failure (or if not supported)
2946 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
2950 * set_transmit_next_pn - Set transmit next pn
2951 * @priv: Private driver interface data
2952 * @channel: secure channel
2953 * @an: association number
2955 * Returns: 0 on success, -1 on failure (or if not supported)
2957 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
2961 * get_available_receive_sc - get available receive channel
2962 * @priv: Private driver interface data
2963 * @channel: secure channel
2964 * Returns: 0 on success, -1 on failure (or if not supported)
2966 int (*get_available_receive_sc)(void *priv, u32 *channel);
2969 * create_receive_sc - create secure channel for receiving
2970 * @priv: Private driver interface data
2971 * @channel: secure channel
2972 * @sci_addr: secure channel identifier - address
2973 * @sci_port: secure channel identifier - port
2974 * @conf_offset: confidentiality offset (0, 30, or 50)
2975 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
2977 * Returns: 0 on success, -1 on failure (or if not supported)
2979 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
2980 u16 sci_port, unsigned int conf_offset,
2984 * delete_receive_sc - delete secure connection for receiving
2985 * @priv: private driver interface data from init()
2986 * @channel: secure channel
2987 * Returns: 0 on success, -1 on failure
2989 int (*delete_receive_sc)(void *priv, u32 channel);
2992 * create_receive_sa - create secure association for receive
2993 * @priv: private driver interface data from init()
2994 * @channel: secure channel
2995 * @an: association number
2996 * @lowest_pn: the lowest packet number can be received
2997 * @sak: the secure association key
2998 * Returns: 0 on success, -1 on failure
3000 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3001 u32 lowest_pn, const u8 *sak);
3004 * enable_receive_sa - enable the SA for receive
3005 * @priv: private driver interface data from init()
3006 * @channel: secure channel
3007 * @an: association number
3008 * Returns: 0 on success, -1 on failure
3010 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3013 * disable_receive_sa - disable SA for receive
3014 * @priv: private driver interface data from init()
3015 * @channel: secure channel index
3016 * @an: association number
3017 * Returns: 0 on success, -1 on failure
3019 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3022 * get_available_transmit_sc - get available transmit channel
3023 * @priv: Private driver interface data
3024 * @channel: secure channel
3025 * Returns: 0 on success, -1 on failure (or if not supported)
3027 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3030 * create_transmit_sc - create secure connection for transmit
3031 * @priv: private driver interface data from init()
3032 * @channel: secure channel
3033 * @sci_addr: secure channel identifier - address
3034 * @sci_port: secure channel identifier - port
3035 * Returns: 0 on success, -1 on failure
3037 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3038 u16 sci_port, unsigned int conf_offset);
3041 * delete_transmit_sc - delete secure connection for transmit
3042 * @priv: private driver interface data from init()
3043 * @channel: secure channel
3044 * Returns: 0 on success, -1 on failure
3046 int (*delete_transmit_sc)(void *priv, u32 channel);
3049 * create_transmit_sa - create secure association for transmit
3050 * @priv: private driver interface data from init()
3051 * @channel: secure channel index
3052 * @an: association number
3053 * @next_pn: the packet number used as next transmit packet
3054 * @confidentiality: True if the SA is to provide confidentiality
3055 * as well as integrity
3056 * @sak: the secure association key
3057 * Returns: 0 on success, -1 on failure
3059 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3060 Boolean confidentiality, const u8 *sak);
3063 * enable_transmit_sa - enable SA for transmit
3064 * @priv: private driver interface data from init()
3065 * @channel: secure channel
3066 * @an: association number
3067 * Returns: 0 on success, -1 on failure
3069 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3072 * disable_transmit_sa - disable SA for transmit
3073 * @priv: private driver interface data from init()
3074 * @channel: secure channel
3075 * @an: association number
3076 * Returns: 0 on success, -1 on failure
3078 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3079 #endif /* CONFIG_MACSEC */
3082 * init_mesh - Driver specific initialization for mesh
3083 * @priv: Private driver interface data
3084 * Returns: 0 on success, -1 on failure
3086 int (*init_mesh)(void *priv);
3089 * join_mesh - Join a mesh network
3090 * @priv: Private driver interface data
3091 * @params: Mesh configuration parameters
3092 * Returns: 0 on success, -1 on failure
3094 int (*join_mesh)(void *priv,
3095 struct wpa_driver_mesh_join_params *params);
3098 * leave_mesh - Leave a mesh network
3099 * @priv: Private driver interface data
3100 * Returns 0 on success, -1 on failure
3102 int (*leave_mesh)(void *priv);
3107 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3109 enum wpa_event_type {
3111 * EVENT_ASSOC - Association completed
3113 * This event needs to be delivered when the driver completes IEEE
3114 * 802.11 association or reassociation successfully.
3115 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3116 * after this event has been generated. In addition, optional
3117 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3118 * more information about the association. If the driver interface gets
3119 * both of these events at the same time, it can also include the
3120 * assoc_info data in EVENT_ASSOC call.
3125 * EVENT_DISASSOC - Association lost
3127 * This event should be called when association is lost either due to
3128 * receiving deauthenticate or disassociate frame from the AP or when
3129 * sending either of these frames to the current AP. If the driver
3130 * supports separate deauthentication event, EVENT_DISASSOC should only
3131 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3132 * In AP mode, union wpa_event_data::disassoc_info is required.
3137 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3139 * This event must be delivered when a Michael MIC error is detected by
3140 * the local driver. Additional data for event processing is
3141 * provided with union wpa_event_data::michael_mic_failure. This
3142 * information is used to request new encyption key and to initiate
3143 * TKIP countermeasures if needed.
3145 EVENT_MICHAEL_MIC_FAILURE,
3148 * EVENT_SCAN_RESULTS - Scan results available
3150 * This event must be called whenever scan results are available to be
3151 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3152 * is expected to be used some time after struct wpa_driver_ops::scan()
3153 * is called. If the driver provides an unsolicited event when the scan
3154 * has been completed, this event can be used to trigger
3155 * EVENT_SCAN_RESULTS call. If such event is not available from the
3156 * driver, the driver wrapper code is expected to use a registered
3157 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3158 * scan is expected to be completed. Optional information about
3159 * completed scan can be provided with union wpa_event_data::scan_info.
3164 * EVENT_ASSOCINFO - Report optional extra information for association
3166 * This event can be used to report extra association information for
3167 * EVENT_ASSOC processing. This extra information includes IEs from
3168 * association frames and Beacon/Probe Response frames in union
3169 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3170 * EVENT_ASSOC. Alternatively, the driver interface can include
3171 * assoc_info data in the EVENT_ASSOC call if it has all the
3172 * information available at the same point.
3177 * EVENT_INTERFACE_STATUS - Report interface status changes
3179 * This optional event can be used to report changes in interface
3180 * status (interface added/removed) using union
3181 * wpa_event_data::interface_status. This can be used to trigger
3182 * wpa_supplicant to stop and re-start processing for the interface,
3183 * e.g., when a cardbus card is ejected/inserted.
3185 EVENT_INTERFACE_STATUS,
3188 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3190 * This event can be used to inform wpa_supplicant about candidates for
3191 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3192 * for scan request (ap_scan=2 mode), this event is required for
3193 * pre-authentication. If wpa_supplicant is performing scan request
3194 * (ap_scan=1), this event is optional since scan results can be used
3195 * to add pre-authentication candidates. union
3196 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3197 * candidate and priority of the candidate, e.g., based on the signal
3198 * strength, in order to try to pre-authenticate first with candidates
3199 * that are most likely targets for re-association.
3201 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3202 * on the candidate list. In addition, it can be called for the current
3203 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3204 * will automatically skip pre-authentication in cases where a valid
3205 * PMKSA exists. When more than one candidate exists, this event should
3206 * be generated once for each candidate.
3208 * Driver will be notified about successful pre-authentication with
3209 * struct wpa_driver_ops::add_pmkid() calls.
3211 EVENT_PMKID_CANDIDATE,
3214 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3216 * This event can be used to inform wpa_supplicant about desire to set
3217 * up secure direct link connection between two stations as defined in
3218 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3219 * STAKey negotiation. The caller will need to set peer address for the
3225 * EVENT_TDLS - Request TDLS operation
3227 * This event can be used to request a TDLS operation to be performed.
3232 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3234 * The driver is expected to report the received FT IEs from
3235 * FT authentication sequence from the AP. The FT IEs are included in
3236 * the extra information in union wpa_event_data::ft_ies.
3241 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3243 * The driver can use this event to inform wpa_supplicant about a STA
3244 * in an IBSS with which protected frames could be exchanged. This
3245 * event starts RSN authentication with the other STA to authenticate
3246 * the STA and set up encryption keys with it.
3248 EVENT_IBSS_RSN_START,
3251 * EVENT_AUTH - Authentication result
3253 * This event should be called when authentication attempt has been
3254 * completed. This is only used if the driver supports separate
3255 * authentication step (struct wpa_driver_ops::authenticate).
3256 * Information about authentication result is included in
3257 * union wpa_event_data::auth.
3262 * EVENT_DEAUTH - Authentication lost
3264 * This event should be called when authentication is lost either due
3265 * to receiving deauthenticate frame from the AP or when sending that
3266 * frame to the current AP.
3267 * In AP mode, union wpa_event_data::deauth_info is required.
3272 * EVENT_ASSOC_REJECT - Association rejected
3274 * This event should be called when (re)association attempt has been
3275 * rejected by the AP. Information about the association response is
3276 * included in union wpa_event_data::assoc_reject.
3281 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3283 EVENT_AUTH_TIMED_OUT,
3286 * EVENT_ASSOC_TIMED_OUT - Association timed out
3288 EVENT_ASSOC_TIMED_OUT,
3291 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
3296 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3298 EVENT_WPS_BUTTON_PUSHED,
3301 * EVENT_TX_STATUS - Report TX status
3306 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3308 EVENT_RX_FROM_UNKNOWN,
3311 * EVENT_RX_MGMT - Report RX of a management frame
3316 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3318 * This event is used to indicate when the driver has started the
3319 * requested remain-on-channel duration. Information about the
3320 * operation is included in union wpa_event_data::remain_on_channel.
3322 EVENT_REMAIN_ON_CHANNEL,
3325 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3327 * This event is used to indicate when the driver has completed
3328 * remain-on-channel duration, i.e., may noot be available on the
3329 * requested channel anymore. Information about the
3330 * operation is included in union wpa_event_data::remain_on_channel.
3332 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3335 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
3337 * This event is used only by driver_test.c and userspace MLME.
3342 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3344 * This event is used to indicate when a Probe Request frame has been
3345 * received. Information about the received frame is included in
3346 * union wpa_event_data::rx_probe_req. The driver is required to report
3347 * these events only after successfully completed probe_req_report()
3348 * commands to request the events (i.e., report parameter is non-zero)
3349 * in station mode. In AP mode, Probe Request frames should always be
3355 * EVENT_NEW_STA - New wired device noticed
3357 * This event is used to indicate that a new device has been detected
3358 * in a network that does not use association-like functionality (i.e.,
3359 * mainly wired Ethernet). This can be used to start EAPOL
3360 * authenticator when receiving a frame from a device. The address of
3361 * the device is included in union wpa_event_data::new_sta.
3366 * EVENT_EAPOL_RX - Report received EAPOL frame
3368 * When in AP mode with hostapd, this event is required to be used to
3369 * deliver the receive EAPOL frames from the driver. With
3370 * %wpa_supplicant, this event is used only if the send_eapol() handler
3371 * is used to override the use of l2_packet for EAPOL frame TX.
3376 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3378 * This event is used to indicate changes in the signal strength
3379 * observed in frames received from the current AP if signal strength
3380 * monitoring has been enabled with signal_monitor().
3382 EVENT_SIGNAL_CHANGE,
3385 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3387 * This event is used to indicate that the interface was enabled after
3388 * having been previously disabled, e.g., due to rfkill.
3390 EVENT_INTERFACE_ENABLED,
3393 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3395 * This event is used to indicate that the interface was disabled,
3396 * e.g., due to rfkill.
3398 EVENT_INTERFACE_DISABLED,
3401 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3403 * This event is used to indicate that the channel list has changed,
3404 * e.g., because of a regulatory domain change triggered by scan
3405 * results including an AP advertising a country code.
3407 EVENT_CHANNEL_LIST_CHANGED,
3410 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3412 * This event is used to indicate that the driver cannot maintain this
3413 * interface in its operation mode anymore. The most likely use for
3414 * this is to indicate that AP mode operation is not available due to
3415 * operating channel would need to be changed to a DFS channel when
3416 * the driver does not support radar detection and another virtual
3417 * interfaces caused the operating channel to change. Other similar
3418 * resource conflicts could also trigger this for station mode
3419 * interfaces. This event can be propagated when channel switching
3422 EVENT_INTERFACE_UNAVAILABLE,
3425 * EVENT_BEST_CHANNEL
3427 * Driver generates this event whenever it detects a better channel
3428 * (e.g., based on RSSI or channel use). This information can be used
3429 * to improve channel selection for a new AP/P2P group.
3434 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3436 * This event should be called when a Deauthentication frame is dropped
3437 * due to it not being protected (MFP/IEEE 802.11w).
3438 * union wpa_event_data::unprot_deauth is required to provide more
3439 * details of the frame.
3441 EVENT_UNPROT_DEAUTH,
3444 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3446 * This event should be called when a Disassociation frame is dropped
3447 * due to it not being protected (MFP/IEEE 802.11w).
3448 * union wpa_event_data::unprot_disassoc is required to provide more
3449 * details of the frame.
3451 EVENT_UNPROT_DISASSOC,
3454 * EVENT_STATION_LOW_ACK
3456 * Driver generates this event whenever it detected that a particular
3457 * station was lost. Detection can be through massive transmission
3458 * failures for example.
3460 EVENT_STATION_LOW_ACK,
3463 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3465 EVENT_IBSS_PEER_LOST,
3468 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3470 * This event carries the new replay counter to notify wpa_supplicant
3471 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3472 * completed Group Key Handshake while the host (including
3473 * wpa_supplicant was sleeping).
3475 EVENT_DRIVER_GTK_REKEY,
3478 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3480 EVENT_SCHED_SCAN_STOPPED,
3483 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3485 * This event indicates that the station responded to the poll
3486 * initiated with @poll_client.
3488 EVENT_DRIVER_CLIENT_POLL_OK,
3491 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3493 EVENT_EAPOL_TX_STATUS,
3496 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3498 * Described in wpa_event_data.ch_switch
3503 * EVENT_WNM - Request WNM operation
3505 * This event can be used to request a WNM operation to be performed.
3510 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3512 * This event indicates that the driver reported a connection failure
3513 * with the specified client (for example, max client reached, etc.) in
3516 EVENT_CONNECT_FAILED_REASON,
3519 * EVENT_RADAR_DETECTED - Notify of radar detection
3521 * A radar has been detected on the supplied frequency, hostapd should
3522 * react accordingly (e.g., change channel).
3524 EVENT_DFS_RADAR_DETECTED,
3527 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3529 * After a successful CAC, the channel can be marked clear and used.
3531 EVENT_DFS_CAC_FINISHED,
3534 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3536 * The CAC was not successful, and the channel remains in the previous
3537 * state. This may happen due to a radar beeing detected or other
3538 * external influences.
3540 EVENT_DFS_CAC_ABORTED,
3543 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3545 * The channel which was previously unavailable is now available again.
3547 EVENT_DFS_NOP_FINISHED,
3550 * EVENT_SURVEY - Received survey data
3552 * This event gets triggered when a driver query is issued for survey
3553 * data and the requested data becomes available. The returned data is
3554 * stored in struct survey_results. The results provide at most one
3555 * survey entry for each frequency and at minimum will provide one
3556 * survey entry for one frequency. The survey data can be os_malloc()'d
3557 * and then os_free()'d, so the event callback must only copy data.
3562 * EVENT_SCAN_STARTED - Scan started
3564 * This indicates that driver has started a scan operation either based
3565 * on a request from wpa_supplicant/hostapd or from another application.
3566 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3567 * completed (either successfully or by getting cancelled).
3572 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3574 * This event indicates a set of frequency ranges that should be avoided
3575 * to reduce issues due to interference or internal co-existence
3576 * information in the driver.
3578 EVENT_AVOID_FREQUENCIES,
3581 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3583 EVENT_NEW_PEER_CANDIDATE
3589 * struct freq_survey - Channel survey info
3591 * @ifidx: Interface index in which this survey was observed
3592 * @freq: Center of frequency of the surveyed channel
3593 * @nf: Channel noise floor in dBm
3594 * @channel_time: Amount of time in ms the radio spent on the channel
3595 * @channel_time_busy: Amount of time in ms the radio detected some signal
3596 * that indicated to the radio the channel was not clear
3597 * @channel_time_rx: Amount of time the radio spent receiving data
3598 * @channel_time_tx: Amount of time the radio spent transmitting data
3599 * @filled: bitmask indicating which fields have been reported, see
3600 * SURVEY_HAS_* defines.
3601 * @list: Internal list pointers
3603 struct freq_survey {
3608 u64 channel_time_busy;
3609 u64 channel_time_rx;
3610 u64 channel_time_tx;
3611 unsigned int filled;
3612 struct dl_list list;
3615 #define SURVEY_HAS_NF BIT(0)
3616 #define SURVEY_HAS_CHAN_TIME BIT(1)
3617 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3618 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3619 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3623 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3625 union wpa_event_data {
3627 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3629 * This structure is optional for EVENT_ASSOC calls and required for
3630 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3631 * driver interface does not need to generate separate EVENT_ASSOCINFO
3636 * reassoc - Flag to indicate association or reassociation
3641 * req_ies - (Re)Association Request IEs
3643 * If the driver generates WPA/RSN IE, this event data must be
3644 * returned for WPA handshake to have needed information. If
3645 * wpa_supplicant-generated WPA/RSN IE is used, this
3646 * information event is optional.
3648 * This should start with the first IE (fixed fields before IEs
3649 * are not included).
3654 * req_ies_len - Length of req_ies in bytes
3659 * resp_ies - (Re)Association Response IEs
3661 * Optional association data from the driver. This data is not
3662 * required WPA, but may be useful for some protocols and as
3663 * such, should be reported if this is available to the driver
3666 * This should start with the first IE (fixed fields before IEs
3667 * are not included).
3672 * resp_ies_len - Length of resp_ies in bytes
3674 size_t resp_ies_len;
3677 * beacon_ies - Beacon or Probe Response IEs
3679 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3680 * Probe Response frames from the current AP (i.e., the one
3681 * that the client just associated with). This information is
3682 * used to update WPA/RSN IE for the AP. If this field is not
3683 * set, the results from previous scan will be used. If no
3684 * data for the new AP is found, scan results will be requested
3685 * again (without scan request). At this point, the driver is
3686 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3689 * This should start with the first IE (fixed fields before IEs
3690 * are not included).
3692 const u8 *beacon_ies;
3695 * beacon_ies_len - Length of beacon_ies */
3696 size_t beacon_ies_len;
3699 * freq - Frequency of the operational channel in MHz
3704 * addr - Station address (for AP mode)
3709 * The following is the key management offload information
3712 * @key_replay_ctr_len
3720 * authorized - Status of key management offload,
3726 * key_replay_ctr - Key replay counter value last used
3727 * in a valid EAPOL-Key frame
3729 const u8 *key_replay_ctr;
3732 * key_replay_ctr_len - The length of key_replay_ctr
3734 size_t key_replay_ctr_len;
3737 * ptk_kck - The derived PTK KCK
3742 * ptk_kek_len - The length of ptk_kck
3747 * ptk_kek - The derived PTK KEK
3752 * ptk_kek_len - The length of ptk_kek
3758 * struct disassoc_info - Data for EVENT_DISASSOC events
3760 struct disassoc_info {
3762 * addr - Station address (for AP mode)
3767 * reason_code - Reason Code (host byte order) used in
3768 * Deauthentication frame
3773 * ie - Optional IE(s) in Disassociation frame
3778 * ie_len - Length of ie buffer in octets
3783 * locally_generated - Whether the frame was locally generated
3785 int locally_generated;
3789 * struct deauth_info - Data for EVENT_DEAUTH events
3791 struct deauth_info {
3793 * addr - Station address (for AP mode)
3798 * reason_code - Reason Code (host byte order) used in
3799 * Deauthentication frame
3804 * ie - Optional IE(s) in Deauthentication frame
3809 * ie_len - Length of ie buffer in octets
3814 * locally_generated - Whether the frame was locally generated
3816 int locally_generated;
3820 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3822 struct michael_mic_failure {
3825 } michael_mic_failure;
3828 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3830 struct interface_status {
3833 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3838 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3840 struct pmkid_candidate {
3841 /** BSSID of the PMKID candidate */
3843 /** Smaller the index, higher the priority */
3845 /** Whether RSN IE includes pre-authenticate flag */
3850 * struct stkstart - Data for EVENT_STKSTART
3857 * struct tdls - Data for EVENT_TDLS
3863 TDLS_REQUEST_TEARDOWN
3865 u16 reason_code; /* for teardown */
3869 * struct wnm - Data for EVENT_WNM
3887 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3889 * During FT (IEEE 802.11r) authentication sequence, the driver is
3890 * expected to use this event to report received FT IEs (MDIE, FTIE,
3891 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3892 * IEs for the next message will be delivered through the
3893 * struct wpa_driver_ops::update_ft_ies() callback.
3899 u8 target_ap[ETH_ALEN];
3900 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3902 /** Length of ric_ies buffer in octets */
3907 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3909 struct ibss_rsn_start {
3914 * struct auth_info - Data for EVENT_AUTH events
3920 u16 auth_transaction;
3927 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3929 struct assoc_reject {
3931 * bssid - BSSID of the AP that rejected association
3936 * resp_ies - (Re)Association Response IEs
3938 * Optional association data from the driver. This data is not
3939 * required WPA, but may be useful for some protocols and as
3940 * such, should be reported if this is available to the driver
3943 * This should start with the first IE (fixed fields before IEs
3944 * are not included).
3949 * resp_ies_len - Length of resp_ies in bytes
3951 size_t resp_ies_len;
3954 * status_code - Status Code from (Re)association Response
3959 struct timeout_event {
3964 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3973 * struct tx_status - Data for EVENT_TX_STATUS events
3985 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3987 struct rx_from_unknown {
3994 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4002 * drv_priv - Pointer to store driver private BSS information
4004 * If not set to NULL, this is used for comparison with
4005 * hostapd_data->drv_priv to determine which BSS should process
4011 * freq - Frequency (in MHz) on which the frame was received
4016 * ssi_signal - Signal strength in dBm (or 0 if not available)
4022 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4024 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4026 struct remain_on_channel {
4028 * freq - Channel frequency in MHz
4033 * duration - Duration to remain on the channel in milliseconds
4035 unsigned int duration;
4036 } remain_on_channel;
4039 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4040 * @aborted: Whether the scan was aborted
4041 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4042 * @num_freqs: Number of entries in freqs array
4043 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4045 * @num_ssids: Number of entries in ssids array
4051 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4056 * struct mlme_rx - Data for EVENT_MLME_RX events
4067 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4069 struct rx_probe_req {
4071 * sa - Source address of the received Probe Request frame
4076 * da - Destination address of the received Probe Request frame
4077 * or %NULL if not available
4082 * bssid - BSSID of the received Probe Request frame or %NULL
4088 * ie - IEs from the Probe Request body
4093 * ie_len - Length of ie buffer in octets
4098 * signal - signal strength in dBm (or 0 if not available)
4104 * struct new_sta - Data for EVENT_NEW_STA events
4111 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4120 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4122 struct wpa_signal_info signal_change;
4125 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4126 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4127 * @freq_5: Best 5 GHz band channel frequency in MHz
4128 * @freq_overall: Best channel frequency in MHz
4130 * 0 can be used to indicate no preference in either band.
4132 struct best_channel {
4138 struct unprot_deauth {
4144 struct unprot_disassoc {
4151 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4152 * @addr: station address
4159 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4161 struct ibss_peer_lost {
4166 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4168 struct driver_gtk_rekey {
4170 const u8 *replay_ctr;
4174 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4175 * @addr: station address
4177 struct client_poll {
4182 * struct eapol_tx_status
4183 * @dst: Original destination
4184 * @data: Data starting with IEEE 802.1X header (!)
4185 * @data_len: Length of data
4186 * @ack: Indicates ack or lost frame
4188 * This corresponds to hapd_send_eapol if the frame sent
4189 * there isn't just reported as EVENT_TX_STATUS.
4191 struct eapol_tx_status {
4200 * @freq: Frequency of new channel in MHz
4201 * @ht_enabled: Whether this is an HT channel
4202 * @ch_offset: Secondary channel offset
4203 * @ch_width: Channel width
4204 * @cf1: Center frequency 1
4205 * @cf2: Center frequency 2
4211 enum chan_width ch_width;
4217 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4218 * @addr: Remote client address
4219 * @code: Reason code for connection failure
4221 struct connect_failed_reason {
4227 } connect_failed_reason;
4230 * struct dfs_event - Data for radar detected events
4231 * @freq: Frequency of the channel in MHz
4237 enum chan_width chan_width;
4243 * survey_results - Survey result data for EVENT_SURVEY
4244 * @freq_filter: Requested frequency survey filter, 0 if request
4245 * was for all survey data
4246 * @survey_list: Linked list of survey data
4248 struct survey_results {
4249 unsigned int freq_filter;
4250 struct dl_list survey_list; /* struct freq_survey */
4254 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4255 * @initiator: Initiator of the regulatory change
4256 * @type: Regulatory change type
4257 * @alpha2: Country code (or "" if not available)
4259 struct channel_list_changed {
4260 enum reg_change_initiator initiator;
4263 } channel_list_changed;
4266 * freq_range - List of frequency ranges
4268 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4270 struct wpa_freq_range_list freq_range;
4275 * @peer: Peer address
4277 * @ie_len: Length of @ies
4279 * Notification of new candidate mesh peer.
4290 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4291 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4292 * with struct wpa_driver_ops::init()
4293 * @event: event type (defined above)
4294 * @data: possible extra data for the event
4296 * Driver wrapper code should call this function whenever an event is received
4299 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4300 union wpa_event_data *data);
4304 * The following inline functions are provided for convenience to simplify
4305 * event indication for some of the common events.
4308 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4309 size_t ielen, int reassoc)
4311 union wpa_event_data event;
4312 os_memset(&event, 0, sizeof(event));
4313 event.assoc_info.reassoc = reassoc;
4314 event.assoc_info.req_ies = ie;
4315 event.assoc_info.req_ies_len = ielen;
4316 event.assoc_info.addr = addr;
4317 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4320 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4322 union wpa_event_data event;
4323 os_memset(&event, 0, sizeof(event));
4324 event.disassoc_info.addr = addr;
4325 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4328 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4331 union wpa_event_data event;
4332 os_memset(&event, 0, sizeof(event));
4333 event.eapol_rx.src = src;
4334 event.eapol_rx.data = data;
4335 event.eapol_rx.data_len = data_len;
4336 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4339 /* driver_common.c */
4340 void wpa_scan_results_free(struct wpa_scan_results *res);
4342 /* Convert wpa_event_type to a string for logging */
4343 const char * event_to_string(enum wpa_event_type event);
4345 /* Convert chan_width to a string for logging and control interfaces */
4346 const char * channel_width_to_string(enum chan_width width);
4348 int ht_supported(const struct hostapd_hw_modes *mode);
4349 int vht_supported(const struct hostapd_hw_modes *mode);
4351 /* NULL terminated array of linked in driver wrappers */
4352 extern struct wpa_driver_ops *wpa_drivers[];
4354 #endif /* DRIVER_H */