2 * Driver interface definition
3 * Copyright (c) 2003-2014, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
8 * This file defines a driver interface used by both %wpa_supplicant and
9 * hostapd. The first part of the file defines data structures used in various
10 * driver operations. This is followed by the struct wpa_driver_ops that each
11 * driver wrapper will beed to define with callback functions for requesting
12 * driver operations. After this, there are definitions for driver event
13 * reporting with wpa_supplicant_event() and some convenience helper functions
14 * that can be used to report events.
20 #define WPA_SUPPLICANT_DRIVER_VERSION 4
22 #include "common/defs.h"
23 #include "utils/list.h"
25 #define HOSTAPD_CHAN_DISABLED 0x00000001
26 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
27 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
28 #define HOSTAPD_CHAN_RADAR 0x00000008
29 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
30 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
31 #define HOSTAPD_CHAN_HT40 0x00000040
32 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
34 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
35 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
36 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
37 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
38 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
40 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
41 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
42 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
43 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
45 enum reg_change_initiator {
49 REGDOM_SET_BY_COUNTRY_IE,
57 REGDOM_TYPE_CUSTOM_WORLD,
58 REGDOM_TYPE_INTERSECTION,
62 * struct hostapd_channel_data - Channel information
64 struct hostapd_channel_data {
66 * chan - Channel number (IEEE 802.11)
71 * freq - Frequency in MHz
76 * flag - Channel flags (HOSTAPD_CHAN_*)
81 * max_tx_power - Regulatory transmit power limit in dBm
86 * survey_list - Linked list of surveys
88 struct dl_list survey_list;
91 * min_nf - Minimum observed noise floor, in dBm, based on all
92 * surveyed channel data
98 * interference_factor - Computed interference factor on this
99 * channel (used internally in src/ap/acs.c; driver wrappers do not
102 long double interference_factor;
103 #endif /* CONFIG_ACS */
105 /* DFS CAC time in milliseconds */
106 unsigned int dfs_cac_ms;
109 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
110 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
113 * struct hostapd_hw_modes - Supported hardware mode information
115 struct hostapd_hw_modes {
117 * mode - Hardware mode
119 enum hostapd_hw_mode mode;
122 * num_channels - Number of entries in the channels array
127 * channels - Array of supported channels
129 struct hostapd_channel_data *channels;
132 * num_rates - Number of entries in the rates array
137 * rates - Array of supported rates in 100 kbps units
142 * ht_capab - HT (IEEE 802.11n) capabilities
147 * mcs_set - MCS (IEEE 802.11n) rate parameters
152 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
157 * vht_capab - VHT (IEEE 802.11ac) capabilities
162 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
166 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
170 #define IEEE80211_MODE_INFRA 0
171 #define IEEE80211_MODE_IBSS 1
172 #define IEEE80211_MODE_AP 2
173 #define IEEE80211_MODE_MESH 5
175 #define IEEE80211_CAP_ESS 0x0001
176 #define IEEE80211_CAP_IBSS 0x0002
177 #define IEEE80211_CAP_PRIVACY 0x0010
179 /* DMG (60 GHz) IEEE 802.11ad */
180 /* type - bits 0..1 */
181 #define IEEE80211_CAP_DMG_MASK 0x0003
182 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
183 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
184 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
186 #define WPA_SCAN_QUAL_INVALID BIT(0)
187 #define WPA_SCAN_NOISE_INVALID BIT(1)
188 #define WPA_SCAN_LEVEL_INVALID BIT(2)
189 #define WPA_SCAN_LEVEL_DBM BIT(3)
190 #define WPA_SCAN_AUTHENTICATED BIT(4)
191 #define WPA_SCAN_ASSOCIATED BIT(5)
194 * struct wpa_scan_res - Scan result for an BSS/IBSS
195 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
197 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
198 * @beacon_int: beacon interval in TUs (host byte order)
199 * @caps: capability information field in host byte order
200 * @qual: signal quality
201 * @noise: noise level
202 * @level: signal level
204 * @age: Age of the information in milliseconds (i.e., how many milliseconds
205 * ago the last Beacon or Probe Response frame was received)
206 * @ie_len: length of the following IE field in octets
207 * @beacon_ie_len: length of the following Beacon IE field in octets
209 * This structure is used as a generic format for scan results from the
210 * driver. Each driver interface implementation is responsible for converting
211 * the driver or OS specific scan results into this format.
213 * If the driver does not support reporting all IEs, the IE data structure is
214 * constructed of the IEs that are available. This field will also need to
215 * include SSID in IE format. All drivers are encouraged to be extended to
216 * report all IEs to make it easier to support future additions.
218 struct wpa_scan_res {
230 size_t beacon_ie_len;
232 * Followed by ie_len octets of IEs from Probe Response frame (or if
233 * the driver does not indicate source of IEs, these may also be from
234 * Beacon frame). After the first set of IEs, another set of IEs may
235 * follow (with beacon_ie_len octets of data) if the driver provides
241 * struct wpa_scan_results - Scan results
242 * @res: Array of pointers to allocated variable length scan result entries
243 * @num: Number of entries in the scan result array
244 * @fetch_time: Time when the results were fetched from the driver
246 struct wpa_scan_results {
247 struct wpa_scan_res **res;
249 struct os_reltime fetch_time;
253 * struct wpa_interface_info - Network interface information
254 * @next: Pointer to the next interface or NULL if this is the last one
255 * @ifname: Interface name that can be used with init() or init2()
256 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
258 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
259 * is not an allocated copy, i.e., get_interfaces() caller will not free
262 struct wpa_interface_info {
263 struct wpa_interface_info *next;
266 const char *drv_name;
269 #define WPAS_MAX_SCAN_SSIDS 16
272 * struct wpa_driver_scan_params - Scan parameters
273 * Data for struct wpa_driver_ops::scan2().
275 struct wpa_driver_scan_params {
277 * ssids - SSIDs to scan for
279 struct wpa_driver_scan_ssid {
281 * ssid - specific SSID to scan for (ProbeReq)
282 * %NULL or zero-length SSID is used to indicate active scan
283 * with wildcard SSID.
287 * ssid_len: Length of the SSID in octets
290 } ssids[WPAS_MAX_SCAN_SSIDS];
293 * num_ssids - Number of entries in ssids array
294 * Zero indicates a request for a passive scan.
299 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
304 * extra_ies_len - Length of extra_ies in octets
306 size_t extra_ies_len;
309 * freqs - Array of frequencies to scan or %NULL for all frequencies
311 * The frequency is set in MHz. The array is zero-terminated.
316 * filter_ssids - Filter for reporting SSIDs
318 * This optional parameter can be used to request the driver wrapper to
319 * filter scan results to include only the specified SSIDs. %NULL
320 * indicates that no filtering is to be done. This can be used to
321 * reduce memory needs for scan results in environments that have large
322 * number of APs with different SSIDs.
324 * The driver wrapper is allowed to take this allocated buffer into its
325 * own use by setting the pointer to %NULL. In that case, the driver
326 * wrapper is responsible for freeing the buffer with os_free() once it
327 * is not needed anymore.
329 struct wpa_driver_scan_filter {
335 * num_filter_ssids - Number of entries in filter_ssids array
337 size_t num_filter_ssids;
340 * filter_rssi - Filter by RSSI
342 * The driver may filter scan results in firmware to reduce host
343 * wakeups and thereby save power. Specify the RSSI threshold in s32
349 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
351 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
352 * Mbps from the support rates element(s) in the Probe Request frames
353 * and not to transmit the frames at any of those rates.
355 unsigned int p2p_probe:1;
358 * only_new_results - Request driver to report only new results
360 * This is used to request the driver to report only BSSes that have
361 * been detected after this scan request has been started, i.e., to
362 * flush old cached BSS entries.
364 unsigned int only_new_results:1;
367 * low_priority - Requests driver to use a lower scan priority
369 * This is used to request the driver to use a lower scan priority
370 * if it supports such a thing.
372 unsigned int low_priority:1;
375 * NOTE: Whenever adding new parameters here, please make sure
376 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
382 * struct wpa_driver_auth_params - Authentication parameters
383 * Data for struct wpa_driver_ops::authenticate().
385 struct wpa_driver_auth_params {
393 const u8 *wep_key[4];
394 size_t wep_key_len[4];
396 int local_state_change;
399 * p2p - Whether this connection is a P2P group
409 WPS_MODE_NONE /* no WPS provisioning being used */,
410 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
411 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
415 struct hostapd_freq_params {
421 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
422 * secondary channel below primary, 1 = HT40
423 * enabled, secondary channel above primary */
428 /* valid for both HT and VHT, center_freq2 is non-zero
429 * only for bandwidth 80 and an 80+80 channel */
430 int center_freq1, center_freq2;
435 * struct wpa_driver_associate_params - Association parameters
436 * Data for struct wpa_driver_ops::associate().
438 struct wpa_driver_associate_params {
440 * bssid - BSSID of the selected AP
441 * This can be %NULL, if ap_scan=2 mode is used and the driver is
442 * responsible for selecting with which BSS to associate. */
446 * bssid_hint - BSSID of a proposed AP
448 * This indicates which BSS has been found a suitable candidate for
449 * initial association for drivers that use driver/firmwate-based BSS
450 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
451 * the driver from selecting other BSSes in the ESS.
453 const u8 *bssid_hint;
456 * ssid - The selected SSID
461 * ssid_len - Length of the SSID (1..32)
466 * freq - channel parameters
468 struct hostapd_freq_params freq;
471 * freq_hint - Frequency of the channel the proposed AP is using
473 * This provides a channel on which a suitable BSS has been found as a
474 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
475 * limit the driver from selecting other channels for
476 * driver/firmware-based BSS selection.
481 * bg_scan_period - Background scan period in seconds, 0 to disable
482 * background scan, or -1 to indicate no change to default driver
488 * beacon_int - Beacon interval for IBSS or 0 to use driver default
493 * wpa_ie - WPA information element for (Re)Association Request
494 * WPA information element to be included in (Re)Association
495 * Request (including information element id and length). Use
496 * of this WPA IE is optional. If the driver generates the WPA
497 * IE, it can use pairwise_suite, group_suite, and
498 * key_mgmt_suite to select proper algorithms. In this case,
499 * the driver has to notify wpa_supplicant about the used WPA
500 * IE by generating an event that the interface code will
501 * convert into EVENT_ASSOCINFO data (see below).
503 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
504 * instead. The driver can determine which version is used by
505 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
508 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
513 * wpa_ie_len - length of the wpa_ie
518 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
520 unsigned int wpa_proto;
523 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
525 * This is usually ignored if @wpa_ie is used.
527 unsigned int pairwise_suite;
530 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
532 * This is usually ignored if @wpa_ie is used.
534 unsigned int group_suite;
537 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
539 * This is usually ignored if @wpa_ie is used.
541 unsigned int key_mgmt_suite;
544 * auth_alg - Allowed authentication algorithms
545 * Bit field of WPA_AUTH_ALG_*
550 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
555 * wep_key - WEP keys for static WEP configuration
557 const u8 *wep_key[4];
560 * wep_key_len - WEP key length for static WEP configuration
562 size_t wep_key_len[4];
565 * wep_tx_keyidx - WEP TX key index for static WEP configuration
570 * mgmt_frame_protection - IEEE 802.11w management frame protection
572 enum mfp_options mgmt_frame_protection;
575 * ft_ies - IEEE 802.11r / FT information elements
576 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
577 * for fast transition, this parameter is set to include the IEs that
578 * are to be sent in the next FT Authentication Request message.
579 * update_ft_ies() handler is called to update the IEs for further
580 * FT messages in the sequence.
582 * The driver should use these IEs only if the target AP is advertising
583 * the same mobility domain as the one included in the MDIE here.
585 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
586 * AP after the initial association. These IEs can only be used if the
587 * target AP is advertising support for FT and is using the same MDIE
588 * and SSID as the current AP.
590 * The driver is responsible for reporting the FT IEs received from the
591 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
592 * type. update_ft_ies() handler will then be called with the FT IEs to
593 * include in the next frame in the authentication sequence.
598 * ft_ies_len - Length of ft_ies in bytes
603 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
605 * This value is provided to allow the driver interface easier access
606 * to the current mobility domain. This value is set to %NULL if no
607 * mobility domain is currently active.
612 * passphrase - RSN passphrase for PSK
614 * This value is made available only for WPA/WPA2-Personal (PSK) and
615 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
616 * the 8..63 character ASCII passphrase, if available. Please note that
617 * this can be %NULL if passphrase was not used to generate the PSK. In
618 * that case, the psk field must be used to fetch the PSK.
620 const char *passphrase;
623 * psk - RSN PSK (alternative for passphrase for PSK)
625 * This value is made available only for WPA/WPA2-Personal (PSK) and
626 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
627 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
628 * be prepared to handle %NULL value as an error.
633 * drop_unencrypted - Enable/disable unencrypted frame filtering
635 * Configure the driver to drop all non-EAPOL frames (both receive and
636 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
637 * still be allowed for key negotiation.
639 int drop_unencrypted;
642 * prev_bssid - Previously used BSSID in this ESS
644 * When not %NULL, this is a request to use reassociation instead of
647 const u8 *prev_bssid;
652 * If the driver needs to do special configuration for WPS association,
653 * this variable provides more information on what type of association
654 * is being requested. Most drivers should not need ot use this.
659 * p2p - Whether this connection is a P2P group
664 * uapsd - UAPSD parameters for the network
665 * -1 = do not change defaults
666 * AP mode: 1 = enabled, 0 = disabled
667 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
672 * fixed_bssid - Whether to force this BSSID in IBSS mode
673 * 1 = Fix this BSSID and prevent merges.
674 * 0 = Do not fix BSSID.
679 * disable_ht - Disable HT (IEEE 802.11n) for this connection
684 * HT Capabilities over-rides. Only bits set in the mask will be used,
685 * and not all values are used by the kernel anyway. Currently, MCS,
686 * MPDU and MSDU fields are used.
688 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */
689 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */
691 #ifdef CONFIG_VHT_OVERRIDES
693 * disable_vht - Disable VHT for this connection
698 * VHT capability overrides.
700 const struct ieee80211_vht_capabilities *vhtcaps;
701 const struct ieee80211_vht_capabilities *vhtcaps_mask;
702 #endif /* CONFIG_VHT_OVERRIDES */
705 * req_key_mgmt_offload - Request key management offload for connection
707 * Request key management offload for this connection if the device
710 int req_key_mgmt_offload;
715 HIDDEN_SSID_ZERO_LEN,
716 HIDDEN_SSID_ZERO_CONTENTS
719 struct wowlan_triggers {
723 u8 gtk_rekey_failure;
725 u8 four_way_handshake;
729 struct wpa_driver_ap_params {
731 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
736 * head_len - Length of the head buffer in octets
741 * tail - Beacon tail following TIM IE
746 * tail_len - Length of the tail buffer in octets
751 * dtim_period - DTIM period
756 * beacon_int - Beacon interval
761 * basic_rates: -1 terminated array of basic rates in 100 kbps
763 * This parameter can be used to set a specific basic rate set for the
764 * BSS. If %NULL, default basic rate set is used.
769 * proberesp - Probe Response template
771 * This is used by drivers that reply to Probe Requests internally in
772 * AP mode and require the full Probe Response template.
777 * proberesp_len - Length of the proberesp buffer in octets
779 size_t proberesp_len;
782 * ssid - The SSID to use in Beacon/Probe Response frames
787 * ssid_len - Length of the SSID (1..32)
792 * hide_ssid - Whether to hide the SSID
794 enum hide_ssid hide_ssid;
797 * pairwise_ciphers - WPA_CIPHER_* bitfield
799 unsigned int pairwise_ciphers;
802 * group_cipher - WPA_CIPHER_*
804 unsigned int group_cipher;
807 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
809 unsigned int key_mgmt_suites;
812 * auth_algs - WPA_AUTH_ALG_* bitfield
814 unsigned int auth_algs;
817 * wpa_version - WPA_PROTO_* bitfield
819 unsigned int wpa_version;
822 * privacy - Whether privacy is used in the BSS
827 * beacon_ies - WPS/P2P IE(s) for Beacon frames
829 * This is used to add IEs like WPS IE and P2P IE by drivers that do
830 * not use the full Beacon template.
832 const struct wpabuf *beacon_ies;
835 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
837 * This is used to add IEs like WPS IE and P2P IE by drivers that
838 * reply to Probe Request frames internally.
840 const struct wpabuf *proberesp_ies;
843 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
845 * This is used to add IEs like WPS IE by drivers that reply to
846 * (Re)Association Request frames internally.
848 const struct wpabuf *assocresp_ies;
851 * isolate - Whether to isolate frames between associated stations
853 * If this is non-zero, the AP is requested to disable forwarding of
854 * frames between associated stations.
859 * cts_protect - Whether CTS protection is enabled
864 * preamble - Whether short preamble is enabled
869 * short_slot_time - Whether short slot time is enabled
871 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
872 * not set (e.g., when 802.11g mode is not in use)
877 * ht_opmode - HT operation mode or -1 if HT not in use
882 * interworking - Whether Interworking is enabled
887 * hessid - Homogeneous ESS identifier or %NULL if not set
892 * access_network_type - Access Network Type (0..15)
894 * This is used for filtering Probe Request frames when Interworking is
897 u8 access_network_type;
900 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
902 * This is used by driver which advertises this capability.
904 int ap_max_inactivity;
907 * smps_mode - SMPS mode
909 * SMPS mode to be used by the AP, specified as the relevant bits of
910 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
912 unsigned int smps_mode;
915 * disable_dgaf - Whether group-addressed frames are disabled
920 * osen - Whether OSEN security is enabled
925 * freq - Channel parameters for dynamic bandwidth changes
927 struct hostapd_freq_params *freq;
930 struct wpa_driver_mesh_bss_params {
931 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
933 * TODO: Other mesh configuration parameters would go here.
934 * See NL80211_MESHCONF_* for all the mesh config parameters.
939 struct wpa_driver_mesh_join_params {
942 const int *basic_rates;
946 struct wpa_driver_mesh_bss_params conf;
947 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
948 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
949 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
950 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
955 * struct wpa_driver_capa - Driver capability information
957 struct wpa_driver_capa {
958 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
959 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
960 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
961 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
962 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
963 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
964 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
965 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
966 unsigned int key_mgmt;
968 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
969 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
970 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
971 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
972 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
973 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
974 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
975 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
976 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
977 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
978 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
979 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
980 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
983 #define WPA_DRIVER_AUTH_OPEN 0x00000001
984 #define WPA_DRIVER_AUTH_SHARED 0x00000002
985 #define WPA_DRIVER_AUTH_LEAP 0x00000004
988 /* Driver generated WPA/RSN IE */
989 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
990 /* Driver needs static WEP key setup after association command */
991 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
992 /* Driver takes care of all DFS operations */
993 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
994 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
995 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
996 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
997 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
998 /* Driver provides separate commands for authentication and association (SME in
999 * wpa_supplicant). */
1000 #define WPA_DRIVER_FLAGS_SME 0x00000020
1001 /* Driver supports AP mode */
1002 #define WPA_DRIVER_FLAGS_AP 0x00000040
1003 /* Driver needs static WEP key setup after association has been completed */
1004 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1005 /* Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1006 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1007 /* Driver supports concurrent P2P operations */
1008 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1010 * Driver uses the initial interface as a dedicated management interface, i.e.,
1011 * it cannot be used for P2P group operations or non-P2P purposes.
1013 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1014 /* This interface is P2P capable (P2P GO or P2P Client) */
1015 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1016 /* Driver supports station and key removal when stopping an AP */
1017 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1019 * Driver uses the initial interface for P2P management interface and non-P2P
1020 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1021 * P2P group operations.
1023 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1025 * Driver is known to use sane error codes, i.e., when it indicates that
1026 * something (e.g., association) fails, there was indeed a failure and the
1027 * operation does not end up getting completed successfully later.
1029 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1030 /* Driver supports off-channel TX */
1031 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1032 /* Driver indicates TX status events for EAPOL Data frames */
1033 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1034 /* Driver indicates TX status events for Deauth/Disassoc frames */
1035 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1036 /* Driver supports roaming (BSS selection) in firmware */
1037 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1038 /* Driver supports operating as a TDLS peer */
1039 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1040 /* Driver requires external TDLS setup/teardown/discovery */
1041 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1042 /* Driver indicates support for Probe Response offloading in AP mode */
1043 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1044 /* Driver supports U-APSD in AP mode */
1045 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1046 /* Driver supports inactivity timer in AP mode */
1047 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1048 /* Driver expects user space implementation of MLME in AP mode */
1049 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1050 /* Driver supports SAE with user space SME */
1051 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1052 /* Driver makes use of OBSS scan mechanism in wpa_supplicant */
1053 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1054 /* Driver supports IBSS (Ad-hoc) mode */
1055 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1056 /* Driver supports radar detection */
1057 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1058 /* Driver supports a dedicated interface for P2P Device */
1059 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1060 /* Driver supports QoS Mapping */
1061 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1062 /* Driver supports CSA in AP mode */
1063 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1064 /* Driver supports mesh */
1065 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1068 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1069 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1070 unsigned int smps_modes;
1073 int max_sched_scan_ssids;
1074 int sched_scan_supported;
1078 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1080 unsigned int max_remain_on_chan;
1083 * max_stations - Maximum number of associated stations the driver
1084 * supports in AP mode
1086 unsigned int max_stations;
1089 * probe_resp_offloads - Bitmap of supported protocols by the driver
1090 * for Probe Response offloading.
1092 /* Driver Probe Response offloading support for WPS ver. 1 */
1093 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1094 /* Driver Probe Response offloading support for WPS ver. 2 */
1095 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1096 /* Driver Probe Response offloading support for P2P */
1097 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1098 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1099 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1100 unsigned int probe_resp_offloads;
1102 unsigned int max_acl_mac_addrs;
1105 * Number of supported concurrent channels
1107 unsigned int num_multichan_concurrent;
1110 * extended_capa - extended capabilities in driver/device
1112 * Must be allocated and freed by driver and the pointers must be
1113 * valid for the lifetime of the driver, i.e., freed in deinit()
1115 const u8 *extended_capa, *extended_capa_mask;
1116 unsigned int extended_capa_len;
1118 struct wowlan_triggers wowlan_triggers;
1122 struct hostapd_data;
1124 struct hostap_sta_driver_data {
1125 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1126 unsigned long current_tx_rate;
1127 unsigned long inactive_msec;
1128 unsigned long flags;
1129 unsigned long num_ps_buf_frames;
1130 unsigned long tx_retry_failed;
1131 unsigned long tx_retry_count;
1136 struct hostapd_sta_add_params {
1140 const u8 *supp_rates;
1141 size_t supp_rates_len;
1142 u16 listen_interval;
1143 const struct ieee80211_ht_capabilities *ht_capabilities;
1144 const struct ieee80211_vht_capabilities *vht_capabilities;
1145 int vht_opmode_enabled;
1147 u32 flags; /* bitmask of WPA_STA_* flags */
1148 u32 flags_mask; /* unset bits in flags */
1150 enum mesh_plink_state plink_state;
1151 #endif /* CONFIG_MESH */
1152 int set; /* Set STA parameters instead of add */
1154 const u8 *ext_capab;
1155 size_t ext_capab_len;
1156 const u8 *supp_channels;
1157 size_t supp_channels_len;
1158 const u8 *supp_oper_classes;
1159 size_t supp_oper_classes_len;
1162 struct mac_address {
1166 struct hostapd_acl_params {
1168 unsigned int num_mac_acl;
1169 struct mac_address mac_acl[0];
1172 enum wpa_driver_if_type {
1174 * WPA_IF_STATION - Station mode interface
1179 * WPA_IF_AP_VLAN - AP mode VLAN interface
1181 * This interface shares its address and Beacon frame with the main
1187 * WPA_IF_AP_BSS - AP mode BSS interface
1189 * This interface has its own address and Beacon frame.
1194 * WPA_IF_P2P_GO - P2P Group Owner
1199 * WPA_IF_P2P_CLIENT - P2P Client
1204 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1205 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1210 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1211 * abstracted P2P Device function in the driver
1216 struct wpa_init_params {
1222 const char *test_socket;
1223 int use_pae_group_addr;
1227 u8 *own_addr; /* buffer for writing own MAC address */
1231 struct wpa_bss_params {
1232 /** Interface name (for multi-SSID/VLAN support) */
1234 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1243 enum mfp_options ieee80211w;
1246 #define WPA_STA_AUTHORIZED BIT(0)
1247 #define WPA_STA_WMM BIT(1)
1248 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1249 #define WPA_STA_MFP BIT(3)
1250 #define WPA_STA_TDLS_PEER BIT(4)
1251 #define WPA_STA_AUTHENTICATED BIT(5)
1264 WNM_SLEEP_ENTER_CONFIRM,
1265 WNM_SLEEP_ENTER_FAIL,
1266 WNM_SLEEP_EXIT_CONFIRM,
1267 WNM_SLEEP_EXIT_FAIL,
1268 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1269 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1270 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1272 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1274 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1275 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1277 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1280 /* enum chan_width - Channel width definitions */
1292 * struct wpa_signal_info - Information about channel signal quality
1294 struct wpa_signal_info {
1296 int above_threshold;
1301 enum chan_width chanwidth;
1307 * struct beacon_data - Beacon data
1308 * @head: Head portion of Beacon frame (before TIM IE)
1309 * @tail: Tail portion of Beacon frame (after TIM IE)
1310 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1311 * @proberesp_ies: Extra information element(s) to add into Probe Response
1313 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1314 * Response frames or %NULL
1315 * @probe_resp: Probe Response frame template
1316 * @head_len: Length of @head
1317 * @tail_len: Length of @tail
1318 * @beacon_ies_len: Length of beacon_ies in octets
1319 * @proberesp_ies_len: Length of proberesp_ies in octets
1320 * @proberesp_ies_len: Length of proberesp_ies in octets
1321 * @probe_resp_len: Length of probe response template (@probe_resp)
1323 struct beacon_data {
1330 size_t head_len, tail_len;
1331 size_t beacon_ies_len;
1332 size_t proberesp_ies_len;
1333 size_t assocresp_ies_len;
1334 size_t probe_resp_len;
1338 * struct csa_settings - Settings for channel switch command
1339 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1340 * @block_tx: 1 - block transmission for CSA period
1341 * @freq_params: Next channel frequency parameter
1342 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1343 * @beacon_after: Next beacon/probe resp/asooc resp info
1344 * @counter_offset_beacon: Offset to the count field in beacon's tail
1345 * @counter_offset_presp: Offset to the count field in probe resp.
1347 struct csa_settings {
1351 struct hostapd_freq_params freq_params;
1352 struct beacon_data beacon_csa;
1353 struct beacon_data beacon_after;
1355 u16 counter_offset_beacon;
1356 u16 counter_offset_presp;
1359 /* TDLS peer capabilities for send_tdls_mgmt() */
1360 enum tdls_peer_capability {
1361 TDLS_PEER_HT = BIT(0),
1362 TDLS_PEER_VHT = BIT(1),
1363 TDLS_PEER_WMM = BIT(2),
1366 #ifdef CONFIG_MACSEC
1367 struct macsec_init_params {
1368 Boolean always_include_sci;
1372 #endif /* CONFIG_MACSEC */
1376 * struct wpa_driver_ops - Driver interface API definition
1378 * This structure defines the API that each driver interface needs to implement
1379 * for core wpa_supplicant code. All driver specific functionality is captured
1382 struct wpa_driver_ops {
1383 /** Name of the driver interface */
1385 /** One line description of the driver interface */
1389 * get_bssid - Get the current BSSID
1390 * @priv: private driver interface data
1391 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1393 * Returns: 0 on success, -1 on failure
1395 * Query kernel driver for the current BSSID and copy it to bssid.
1396 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1399 int (*get_bssid)(void *priv, u8 *bssid);
1402 * get_ssid - Get the current SSID
1403 * @priv: private driver interface data
1404 * @ssid: buffer for SSID (at least 32 bytes)
1406 * Returns: Length of the SSID on success, -1 on failure
1408 * Query kernel driver for the current SSID and copy it to ssid.
1409 * Returning zero is recommended if the STA is not associated.
1411 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1412 * can, at least in theory, contain control characters (including nul)
1413 * and as such, should be processed as binary data, not a printable
1416 int (*get_ssid)(void *priv, u8 *ssid);
1419 * set_key - Configure encryption key
1420 * @ifname: Interface name (for multi-SSID/VLAN support)
1421 * @priv: private driver interface data
1422 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1423 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1424 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1425 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1426 * %WPA_ALG_BIP_CMAC_256);
1427 * %WPA_ALG_NONE clears the key.
1428 * @addr: Address of the peer STA (BSSID of the current AP when setting
1429 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1430 * broadcast keys, %NULL for default keys that are used both for
1431 * broadcast and unicast; when clearing keys, %NULL is used to
1432 * indicate that both the broadcast-only and default key of the
1433 * specified key index is to be cleared
1434 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1436 * @set_tx: configure this key as the default Tx key (only used when
1437 * driver does not support separate unicast/individual key
1438 * @seq: sequence number/packet number, seq_len octets, the next
1439 * packet number to be used for in replay protection; configured
1440 * for Rx keys (in most cases, this is only used with broadcast
1441 * keys and set to zero for unicast keys); %NULL if not set
1442 * @seq_len: length of the seq, depends on the algorithm:
1443 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1444 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1446 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1447 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1449 * Returns: 0 on success, -1 on failure
1451 * Configure the given key for the kernel driver. If the driver
1452 * supports separate individual keys (4 default keys + 1 individual),
1453 * addr can be used to determine whether the key is default or
1454 * individual. If only 4 keys are supported, the default key with key
1455 * index 0 is used as the individual key. STA must be configured to use
1456 * it as the default Tx key (set_tx is set) and accept Rx for all the
1457 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1458 * broadcast keys, so key index 0 is available for this kind of
1461 * Please note that TKIP keys include separate TX and RX MIC keys and
1462 * some drivers may expect them in different order than wpa_supplicant
1463 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1464 * will trigger Michael MIC errors. This can be fixed by changing the
1465 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1466 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1467 * example on how this can be done.
1469 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1470 const u8 *addr, int key_idx, int set_tx,
1471 const u8 *seq, size_t seq_len,
1472 const u8 *key, size_t key_len);
1475 * init - Initialize driver interface
1476 * @ctx: context to be used when calling wpa_supplicant functions,
1477 * e.g., wpa_supplicant_event()
1478 * @ifname: interface name, e.g., wlan0
1480 * Returns: Pointer to private data, %NULL on failure
1482 * Initialize driver interface, including event processing for kernel
1483 * driver events (e.g., associated, scan results, Michael MIC failure).
1484 * This function can allocate a private configuration data area for
1485 * @ctx, file descriptor, interface name, etc. information that may be
1486 * needed in future driver operations. If this is not used, non-NULL
1487 * value will need to be returned because %NULL is used to indicate
1488 * failure. The returned value will be used as 'void *priv' data for
1489 * all other driver_ops functions.
1491 * The main event loop (eloop.c) of wpa_supplicant can be used to
1492 * register callback for read sockets (eloop_register_read_sock()).
1494 * See below for more information about events and
1495 * wpa_supplicant_event() function.
1497 void * (*init)(void *ctx, const char *ifname);
1500 * deinit - Deinitialize driver interface
1501 * @priv: private driver interface data from init()
1503 * Shut down driver interface and processing of driver events. Free
1504 * private data buffer if one was allocated in init() handler.
1506 void (*deinit)(void *priv);
1509 * set_param - Set driver configuration parameters
1510 * @priv: private driver interface data from init()
1511 * @param: driver specific configuration parameters
1513 * Returns: 0 on success, -1 on failure
1515 * Optional handler for notifying driver interface about configuration
1516 * parameters (driver_param).
1518 int (*set_param)(void *priv, const char *param);
1521 * set_countermeasures - Enable/disable TKIP countermeasures
1522 * @priv: private driver interface data
1523 * @enabled: 1 = countermeasures enabled, 0 = disabled
1525 * Returns: 0 on success, -1 on failure
1527 * Configure TKIP countermeasures. When these are enabled, the driver
1528 * should drop all received and queued frames that are using TKIP.
1530 int (*set_countermeasures)(void *priv, int enabled);
1533 * deauthenticate - Request driver to deauthenticate
1534 * @priv: private driver interface data
1535 * @addr: peer address (BSSID of the AP)
1536 * @reason_code: 16-bit reason code to be sent in the deauthentication
1539 * Returns: 0 on success, -1 on failure
1541 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1544 * associate - Request driver to associate
1545 * @priv: private driver interface data
1546 * @params: association parameters
1548 * Returns: 0 on success, -1 on failure
1550 int (*associate)(void *priv,
1551 struct wpa_driver_associate_params *params);
1554 * add_pmkid - Add PMKSA cache entry to the driver
1555 * @priv: private driver interface data
1556 * @bssid: BSSID for the PMKSA cache entry
1557 * @pmkid: PMKID for the PMKSA cache entry
1559 * Returns: 0 on success, -1 on failure
1561 * This function is called when a new PMK is received, as a result of
1562 * either normal authentication or RSN pre-authentication.
1564 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1565 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1566 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1567 * driver_ops function does not need to be implemented. Likewise, if
1568 * the driver does not support WPA, this function is not needed.
1570 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1573 * remove_pmkid - Remove PMKSA cache entry to the driver
1574 * @priv: private driver interface data
1575 * @bssid: BSSID for the PMKSA cache entry
1576 * @pmkid: PMKID for the PMKSA cache entry
1578 * Returns: 0 on success, -1 on failure
1580 * This function is called when the supplicant drops a PMKSA cache
1581 * entry for any reason.
1583 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1584 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1585 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1586 * from wpa_supplicant, this driver_ops function does not need to be
1587 * implemented. Likewise, if the driver does not support WPA, this
1588 * function is not needed.
1590 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1593 * flush_pmkid - Flush PMKSA cache
1594 * @priv: private driver interface data
1596 * Returns: 0 on success, -1 on failure
1598 * This function is called when the supplicant drops all PMKSA cache
1599 * entries for any reason.
1601 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1602 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1603 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1604 * from wpa_supplicant, this driver_ops function does not need to be
1605 * implemented. Likewise, if the driver does not support WPA, this
1606 * function is not needed.
1608 int (*flush_pmkid)(void *priv);
1611 * get_capa - Get driver capabilities
1612 * @priv: private driver interface data
1614 * Returns: 0 on success, -1 on failure
1616 * Get driver/firmware/hardware capabilities.
1618 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1621 * poll - Poll driver for association information
1622 * @priv: private driver interface data
1624 * This is an option callback that can be used when the driver does not
1625 * provide event mechanism for association events. This is called when
1626 * receiving WPA EAPOL-Key messages that require association
1627 * information. The driver interface is supposed to generate associnfo
1628 * event before returning from this callback function. In addition, the
1629 * driver interface should generate an association event after having
1630 * sent out associnfo.
1632 void (*poll)(void *priv);
1635 * get_ifname - Get interface name
1636 * @priv: private driver interface data
1638 * Returns: Pointer to the interface name. This can differ from the
1639 * interface name used in init() call. Init() is called first.
1641 * This optional function can be used to allow the driver interface to
1642 * replace the interface name with something else, e.g., based on an
1643 * interface mapping from a more descriptive name.
1645 const char * (*get_ifname)(void *priv);
1648 * get_mac_addr - Get own MAC address
1649 * @priv: private driver interface data
1651 * Returns: Pointer to own MAC address or %NULL on failure
1653 * This optional function can be used to get the own MAC address of the
1654 * device from the driver interface code. This is only needed if the
1655 * l2_packet implementation for the OS does not provide easy access to
1657 const u8 * (*get_mac_addr)(void *priv);
1660 * send_eapol - Optional function for sending EAPOL packets
1661 * @priv: private driver interface data
1662 * @dest: Destination MAC address
1664 * @data: EAPOL packet starting with IEEE 802.1X header
1665 * @data_len: Size of the EAPOL packet
1667 * Returns: 0 on success, -1 on failure
1669 * This optional function can be used to override l2_packet operations
1670 * with driver specific functionality. If this function pointer is set,
1671 * l2_packet module is not used at all and the driver interface code is
1672 * responsible for receiving and sending all EAPOL packets. The
1673 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1674 * event. The driver interface is required to implement get_mac_addr()
1675 * handler if send_eapol() is used.
1677 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1678 const u8 *data, size_t data_len);
1681 * set_operstate - Sets device operating state to DORMANT or UP
1682 * @priv: private driver interface data
1683 * @state: 0 = dormant, 1 = up
1684 * Returns: 0 on success, -1 on failure
1686 * This is an optional function that can be used on operating systems
1687 * that support a concept of controlling network device state from user
1688 * space applications. This function, if set, gets called with
1689 * state = 1 when authentication has been completed and with state = 0
1690 * when connection is lost.
1692 int (*set_operstate)(void *priv, int state);
1695 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1696 * @priv: Private driver interface data
1697 * @addr: Address of the station for which to set protection (may be
1698 * %NULL for group keys)
1699 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1700 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1701 * Returns: 0 on success, -1 on failure
1703 * This is an optional function that can be used to set the driver to
1704 * require protection for Tx and/or Rx frames. This uses the layer
1705 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1706 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1707 * set protection operation; instead, they set protection implicitly
1708 * based on configured keys.
1710 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1714 * get_hw_feature_data - Get hardware support data (channels and rates)
1715 * @priv: Private driver interface data
1716 * @num_modes: Variable for returning the number of returned modes
1717 * flags: Variable for returning hardware feature flags
1718 * Returns: Pointer to allocated hardware data on success or %NULL on
1719 * failure. Caller is responsible for freeing this.
1721 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1726 * send_mlme - Send management frame from MLME
1727 * @priv: Private driver interface data
1728 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1729 * @data_len: Size of the management frame
1730 * @noack: Do not wait for this frame to be acked (disable retries)
1731 * Returns: 0 on success, -1 on failure
1733 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1737 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1738 * @priv: Private driver interface data
1739 * @md: Mobility domain (2 octets) (also included inside ies)
1740 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1741 * @ies_len: Length of FT IEs in bytes
1742 * Returns: 0 on success, -1 on failure
1744 * The supplicant uses this callback to let the driver know that keying
1745 * material for FT is available and that the driver can use the
1746 * provided IEs in the next message in FT authentication sequence.
1748 * This function is only needed for driver that support IEEE 802.11r
1749 * (Fast BSS Transition).
1751 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1755 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1756 * @priv: Private driver interface data
1757 * @action: Action field value
1758 * @target_ap: Target AP address
1759 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1760 * @ies_len: Length of FT IEs in bytes
1761 * Returns: 0 on success, -1 on failure
1763 * The supplicant uses this callback to request the driver to transmit
1764 * an FT Action frame (action category 6) for over-the-DS fast BSS
1767 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1768 const u8 *ies, size_t ies_len);
1771 * get_scan_results2 - Fetch the latest scan results
1772 * @priv: private driver interface data
1774 * Returns: Allocated buffer of scan results (caller is responsible for
1775 * freeing the data structure) on success, NULL on failure
1777 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1780 * set_country - Set country
1781 * @priv: Private driver interface data
1782 * @alpha2: country to which to switch to
1783 * Returns: 0 on success, -1 on failure
1785 * This function is for drivers which support some form
1786 * of setting a regulatory domain.
1788 int (*set_country)(void *priv, const char *alpha2);
1791 * get_country - Get country
1792 * @priv: Private driver interface data
1793 * @alpha2: Buffer for returning country code (at least 3 octets)
1794 * Returns: 0 on success, -1 on failure
1796 int (*get_country)(void *priv, char *alpha2);
1799 * global_init - Global driver initialization
1800 * Returns: Pointer to private data (global), %NULL on failure
1802 * This optional function is called to initialize the driver wrapper
1803 * for global data, i.e., data that applies to all interfaces. If this
1804 * function is implemented, global_deinit() will also need to be
1805 * implemented to free the private data. The driver will also likely
1806 * use init2() function instead of init() to get the pointer to global
1807 * data available to per-interface initializer.
1809 void * (*global_init)(void);
1812 * global_deinit - Global driver deinitialization
1813 * @priv: private driver global data from global_init()
1815 * Terminate any global driver related functionality and free the
1816 * global data structure.
1818 void (*global_deinit)(void *priv);
1821 * init2 - Initialize driver interface (with global data)
1822 * @ctx: context to be used when calling wpa_supplicant functions,
1823 * e.g., wpa_supplicant_event()
1824 * @ifname: interface name, e.g., wlan0
1825 * @global_priv: private driver global data from global_init()
1826 * Returns: Pointer to private data, %NULL on failure
1828 * This function can be used instead of init() if the driver wrapper
1831 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1834 * get_interfaces - Get information about available interfaces
1835 * @global_priv: private driver global data from global_init()
1836 * Returns: Allocated buffer of interface information (caller is
1837 * responsible for freeing the data structure) on success, NULL on
1840 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1843 * scan2 - Request the driver to initiate scan
1844 * @priv: private driver interface data
1845 * @params: Scan parameters
1847 * Returns: 0 on success, -1 on failure
1849 * Once the scan results are ready, the driver should report scan
1850 * results event for wpa_supplicant which will eventually request the
1851 * results with wpa_driver_get_scan_results2().
1853 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1856 * authenticate - Request driver to authenticate
1857 * @priv: private driver interface data
1858 * @params: authentication parameters
1859 * Returns: 0 on success, -1 on failure
1861 * This is an optional function that can be used with drivers that
1862 * support separate authentication and association steps, i.e., when
1863 * wpa_supplicant can act as the SME. If not implemented, associate()
1864 * function is expected to take care of IEEE 802.11 authentication,
1867 int (*authenticate)(void *priv,
1868 struct wpa_driver_auth_params *params);
1871 * set_ap - Set Beacon and Probe Response information for AP mode
1872 * @priv: Private driver interface data
1873 * @params: Parameters to use in AP mode
1875 * This function is used to configure Beacon template and/or extra IEs
1876 * to add for Beacon and Probe Response frames for the driver in
1877 * AP mode. The driver is responsible for building the full Beacon
1878 * frame by concatenating the head part with TIM IE generated by the
1879 * driver/firmware and finishing with the tail part. Depending on the
1880 * driver architectue, this can be done either by using the full
1881 * template or the set of additional IEs (e.g., WPS and P2P IE).
1882 * Similarly, Probe Response processing depends on the driver design.
1883 * If the driver (or firmware) takes care of replying to Probe Request
1884 * frames, the extra IEs provided here needs to be added to the Probe
1887 * Returns: 0 on success, -1 on failure
1889 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1892 * set_acl - Set ACL in AP mode
1893 * @priv: Private driver interface data
1894 * @params: Parameters to configure ACL
1895 * Returns: 0 on success, -1 on failure
1897 * This is used only for the drivers which support MAC address ACL.
1899 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1902 * hapd_init - Initialize driver interface (hostapd only)
1903 * @hapd: Pointer to hostapd context
1904 * @params: Configuration for the driver wrapper
1905 * Returns: Pointer to private data, %NULL on failure
1907 * This function is used instead of init() or init2() when the driver
1908 * wrapper is used with hostapd.
1910 void * (*hapd_init)(struct hostapd_data *hapd,
1911 struct wpa_init_params *params);
1914 * hapd_deinit - Deinitialize driver interface (hostapd only)
1915 * @priv: Private driver interface data from hapd_init()
1917 void (*hapd_deinit)(void *priv);
1920 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1921 * @priv: Private driver interface data
1922 * @params: BSS parameters
1923 * Returns: 0 on success, -1 on failure
1925 * This is an optional function to configure the kernel driver to
1926 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1927 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1928 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1929 * for Beacon frames.
1931 * DEPRECATED - use set_ap() instead
1933 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1936 * set_privacy - Enable/disable privacy (AP only)
1937 * @priv: Private driver interface data
1938 * @enabled: 1 = privacy enabled, 0 = disabled
1939 * Returns: 0 on success, -1 on failure
1941 * This is an optional function to configure privacy field in the
1942 * kernel driver for Beacon frames. This can be left undefined (set to
1943 * %NULL) if the driver uses the Beacon template from set_ap().
1945 * DEPRECATED - use set_ap() instead
1947 int (*set_privacy)(void *priv, int enabled);
1950 * get_seqnum - Fetch the current TSC/packet number (AP only)
1951 * @ifname: The interface name (main or virtual)
1952 * @priv: Private driver interface data
1953 * @addr: MAC address of the station or %NULL for group keys
1955 * @seq: Buffer for returning the latest used TSC/packet number
1956 * Returns: 0 on success, -1 on failure
1958 * This function is used to fetch the last used TSC/packet number for
1959 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1960 * keys, so there is no strict requirement on implementing support for
1961 * unicast keys (i.e., addr != %NULL).
1963 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1967 * flush - Flush all association stations (AP only)
1968 * @priv: Private driver interface data
1969 * Returns: 0 on success, -1 on failure
1971 * This function requests the driver to disassociate all associated
1972 * stations. This function does not need to be implemented if the
1973 * driver does not process association frames internally.
1975 int (*flush)(void *priv);
1978 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1979 * @priv: Private driver interface data
1980 * @elem: Information elements
1981 * @elem_len: Length of the elem buffer in octets
1982 * Returns: 0 on success, -1 on failure
1984 * This is an optional function to add information elements in the
1985 * kernel driver for Beacon and Probe Response frames. This can be left
1986 * undefined (set to %NULL) if the driver uses the Beacon template from
1989 * DEPRECATED - use set_ap() instead
1991 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1994 * read_sta_data - Fetch station data
1995 * @priv: Private driver interface data
1996 * @data: Buffer for returning station information
1997 * @addr: MAC address of the station
1998 * Returns: 0 on success, -1 on failure
2000 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2004 * hapd_send_eapol - Send an EAPOL packet (AP only)
2005 * @priv: private driver interface data
2006 * @addr: Destination MAC address
2007 * @data: EAPOL packet starting with IEEE 802.1X header
2008 * @data_len: Length of the EAPOL packet in octets
2009 * @encrypt: Whether the frame should be encrypted
2010 * @own_addr: Source MAC address
2011 * @flags: WPA_STA_* flags for the destination station
2013 * Returns: 0 on success, -1 on failure
2015 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2016 size_t data_len, int encrypt,
2017 const u8 *own_addr, u32 flags);
2020 * sta_deauth - Deauthenticate a station (AP only)
2021 * @priv: Private driver interface data
2022 * @own_addr: Source address and BSSID for the Deauthentication frame
2023 * @addr: MAC address of the station to deauthenticate
2024 * @reason: Reason code for the Deauthentiation frame
2025 * Returns: 0 on success, -1 on failure
2027 * This function requests a specific station to be deauthenticated and
2028 * a Deauthentication frame to be sent to it.
2030 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2034 * sta_disassoc - Disassociate a station (AP only)
2035 * @priv: Private driver interface data
2036 * @own_addr: Source address and BSSID for the Disassociation frame
2037 * @addr: MAC address of the station to disassociate
2038 * @reason: Reason code for the Disassociation frame
2039 * Returns: 0 on success, -1 on failure
2041 * This function requests a specific station to be disassociated and
2042 * a Disassociation frame to be sent to it.
2044 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2048 * sta_remove - Remove a station entry (AP only)
2049 * @priv: Private driver interface data
2050 * @addr: MAC address of the station to be removed
2051 * Returns: 0 on success, -1 on failure
2053 int (*sta_remove)(void *priv, const u8 *addr);
2056 * hapd_get_ssid - Get the current SSID (AP only)
2057 * @priv: Private driver interface data
2058 * @buf: Buffer for returning the SSID
2059 * @len: Maximum length of the buffer
2060 * Returns: Length of the SSID on success, -1 on failure
2062 * This function need not be implemented if the driver uses Beacon
2063 * template from set_ap() and does not reply to Probe Request frames.
2065 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2068 * hapd_set_ssid - Set SSID (AP only)
2069 * @priv: Private driver interface data
2071 * @len: Length of the SSID in octets
2072 * Returns: 0 on success, -1 on failure
2074 * DEPRECATED - use set_ap() instead
2076 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2079 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2080 * @priv: Private driver interface data
2081 * @enabled: 1 = countermeasures enabled, 0 = disabled
2082 * Returns: 0 on success, -1 on failure
2084 * This need not be implemented if the driver does not take care of
2085 * association processing.
2087 int (*hapd_set_countermeasures)(void *priv, int enabled);
2090 * sta_add - Add a station entry
2091 * @priv: Private driver interface data
2092 * @params: Station parameters
2093 * Returns: 0 on success, -1 on failure
2095 * This function is used to add a station entry to the driver once the
2096 * station has completed association. This is only used if the driver
2097 * does not take care of association processing.
2099 * With TDLS, this function is also used to add or set (params->set 1)
2100 * TDLS peer entries.
2102 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2105 * get_inact_sec - Get station inactivity duration (AP only)
2106 * @priv: Private driver interface data
2107 * @addr: Station address
2108 * Returns: Number of seconds station has been inactive, -1 on failure
2110 int (*get_inact_sec)(void *priv, const u8 *addr);
2113 * sta_clear_stats - Clear station statistics (AP only)
2114 * @priv: Private driver interface data
2115 * @addr: Station address
2116 * Returns: 0 on success, -1 on failure
2118 int (*sta_clear_stats)(void *priv, const u8 *addr);
2121 * set_freq - Set channel/frequency (AP only)
2122 * @priv: Private driver interface data
2123 * @freq: Channel parameters
2124 * Returns: 0 on success, -1 on failure
2126 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2129 * set_rts - Set RTS threshold
2130 * @priv: Private driver interface data
2131 * @rts: RTS threshold in octets
2132 * Returns: 0 on success, -1 on failure
2134 int (*set_rts)(void *priv, int rts);
2137 * set_frag - Set fragmentation threshold
2138 * @priv: Private driver interface data
2139 * @frag: Fragmentation threshold in octets
2140 * Returns: 0 on success, -1 on failure
2142 int (*set_frag)(void *priv, int frag);
2145 * sta_set_flags - Set station flags (AP only)
2146 * @priv: Private driver interface data
2147 * @addr: Station address
2148 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2149 * @flags_or: Bitmap of WPA_STA_* flags to add
2150 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2151 * Returns: 0 on success, -1 on failure
2153 int (*sta_set_flags)(void *priv, const u8 *addr,
2154 int total_flags, int flags_or, int flags_and);
2157 * set_tx_queue_params - Set TX queue parameters
2158 * @priv: Private driver interface data
2159 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2163 * @burst_time: Maximum length for bursting in 0.1 msec units
2165 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2166 int cw_max, int burst_time);
2169 * if_add - Add a virtual interface
2170 * @priv: Private driver interface data
2171 * @type: Interface type
2172 * @ifname: Interface name for the new virtual interface
2173 * @addr: Local address to use for the interface or %NULL to use the
2174 * parent interface address
2175 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2176 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2177 * not allowed (applies only to %WPA_IF_AP_BSS type)
2178 * @force_ifname: Buffer for returning an interface name that the
2179 * driver ended up using if it differs from the requested ifname
2180 * @if_addr: Buffer for returning the allocated interface address
2181 * (this may differ from the requested addr if the driver cannot
2182 * change interface address)
2183 * @bridge: Bridge interface to use or %NULL if no bridge configured
2184 * @use_existing: Whether to allow existing interface to be used
2185 * Returns: 0 on success, -1 on failure
2187 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2188 const char *ifname, const u8 *addr, void *bss_ctx,
2189 void **drv_priv, char *force_ifname, u8 *if_addr,
2190 const char *bridge, int use_existing);
2193 * if_remove - Remove a virtual interface
2194 * @priv: Private driver interface data
2195 * @type: Interface type
2196 * @ifname: Interface name of the virtual interface to be removed
2197 * Returns: 0 on success, -1 on failure
2199 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2200 const char *ifname);
2203 * set_sta_vlan - Bind a station into a specific interface (AP only)
2204 * @priv: Private driver interface data
2205 * @ifname: Interface (main or virtual BSS or VLAN)
2206 * @addr: MAC address of the associated station
2208 * Returns: 0 on success, -1 on failure
2210 * This function is used to bind a station to a specific virtual
2211 * interface. It is only used if when virtual interfaces are supported,
2212 * e.g., to assign stations to different VLAN interfaces based on
2213 * information from a RADIUS server. This allows separate broadcast
2214 * domains to be used with a single BSS.
2216 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2220 * commit - Optional commit changes handler (AP only)
2221 * @priv: driver private data
2222 * Returns: 0 on success, -1 on failure
2224 * This optional handler function can be registered if the driver
2225 * interface implementation needs to commit changes (e.g., by setting
2226 * network interface up) at the end of initial configuration. If set,
2227 * this handler will be called after initial setup has been completed.
2229 int (*commit)(void *priv);
2232 * send_ether - Send an ethernet packet (AP only)
2233 * @priv: private driver interface data
2234 * @dst: Destination MAC address
2235 * @src: Source MAC address
2237 * @data: EAPOL packet starting with IEEE 802.1X header
2238 * @data_len: Length of the EAPOL packet in octets
2239 * Returns: 0 on success, -1 on failure
2241 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2242 const u8 *data, size_t data_len);
2245 * set_radius_acl_auth - Notification of RADIUS ACL change
2246 * @priv: Private driver interface data
2247 * @mac: MAC address of the station
2248 * @accepted: Whether the station was accepted
2249 * @session_timeout: Session timeout for the station
2250 * Returns: 0 on success, -1 on failure
2252 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2253 u32 session_timeout);
2256 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2257 * @priv: Private driver interface data
2258 * @mac: MAC address of the station
2259 * Returns: 0 on success, -1 on failure
2261 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2264 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2265 * @priv: Private driver interface data
2266 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2267 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2269 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2270 * to remove extra IE(s)
2271 * Returns: 0 on success, -1 on failure
2273 * This is an optional function to add WPS IE in the kernel driver for
2274 * Beacon and Probe Response frames. This can be left undefined (set
2275 * to %NULL) if the driver uses the Beacon template from set_ap()
2276 * and does not process Probe Request frames. If the driver takes care
2277 * of (Re)Association frame processing, the assocresp buffer includes
2278 * WPS IE(s) that need to be added to (Re)Association Response frames
2279 * whenever a (Re)Association Request frame indicated use of WPS.
2281 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2282 * frames when operating as a GO. The driver is responsible for adding
2283 * timing related attributes (e.g., NoA) in addition to the IEs
2284 * included here by appending them after these buffers. This call is
2285 * also used to provide Probe Response IEs for P2P Listen state
2286 * operations for drivers that generate the Probe Response frames
2289 * DEPRECATED - use set_ap() instead
2291 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2292 const struct wpabuf *proberesp,
2293 const struct wpabuf *assocresp);
2296 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2297 * @priv: Private driver interface data
2298 * @authorized: Whether the port is authorized
2299 * Returns: 0 on success, -1 on failure
2301 int (*set_supp_port)(void *priv, int authorized);
2304 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2305 * @priv: Private driver interface data
2306 * @addr: MAC address of the associated station
2307 * @aid: Association ID
2308 * @val: 1 = bind to 4-address WDS; 0 = unbind
2309 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2310 * to indicate that bridge is not to be used
2311 * @ifname_wds: Buffer to return the interface name for the new WDS
2312 * station or %NULL to indicate name is not returned.
2313 * Returns: 0 on success, -1 on failure
2315 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2316 const char *bridge_ifname, char *ifname_wds);
2319 * send_action - Transmit an Action frame
2320 * @priv: Private driver interface data
2321 * @freq: Frequency (in MHz) of the channel
2322 * @wait: Time to wait off-channel for a response (in ms), or zero
2323 * @dst: Destination MAC address (Address 1)
2324 * @src: Source MAC address (Address 2)
2325 * @bssid: BSSID (Address 3)
2327 * @data_len: data length in octets
2328 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2329 * Returns: 0 on success, -1 on failure
2331 * This command can be used to request the driver to transmit an action
2332 * frame to the specified destination.
2334 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2335 * be transmitted on the given channel and the device will wait for a
2336 * response on that channel for the given wait time.
2338 * If the flag is not set, the wait time will be ignored. In this case,
2339 * if a remain-on-channel duration is in progress, the frame must be
2340 * transmitted on that channel; alternatively the frame may be sent on
2341 * the current operational channel (if in associated state in station
2342 * mode or while operating as an AP.)
2344 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2345 const u8 *dst, const u8 *src, const u8 *bssid,
2346 const u8 *data, size_t data_len, int no_cck);
2349 * send_action_cancel_wait - Cancel action frame TX wait
2350 * @priv: Private driver interface data
2352 * This command cancels the wait time associated with sending an action
2353 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2354 * set in the driver flags.
2356 void (*send_action_cancel_wait)(void *priv);
2359 * remain_on_channel - Remain awake on a channel
2360 * @priv: Private driver interface data
2361 * @freq: Frequency (in MHz) of the channel
2362 * @duration: Duration in milliseconds
2363 * Returns: 0 on success, -1 on failure
2365 * This command is used to request the driver to remain awake on the
2366 * specified channel for the specified duration and report received
2367 * Action frames with EVENT_RX_MGMT events. Optionally, received
2368 * Probe Request frames may also be requested to be reported by calling
2369 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2371 * The driver may not be at the requested channel when this function
2372 * returns, i.e., the return code is only indicating whether the
2373 * request was accepted. The caller will need to wait until the
2374 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2375 * completed the channel change. This may take some time due to other
2376 * need for the radio and the caller should be prepared to timing out
2377 * its wait since there are no guarantees on when this request can be
2380 int (*remain_on_channel)(void *priv, unsigned int freq,
2381 unsigned int duration);
2384 * cancel_remain_on_channel - Cancel remain-on-channel operation
2385 * @priv: Private driver interface data
2387 * This command can be used to cancel a remain-on-channel operation
2388 * before its originally requested duration has passed. This could be
2389 * used, e.g., when remain_on_channel() is used to request extra time
2390 * to receive a response to an Action frame and the response is
2391 * received when there is still unneeded time remaining on the
2392 * remain-on-channel operation.
2394 int (*cancel_remain_on_channel)(void *priv);
2397 * probe_req_report - Request Probe Request frames to be indicated
2398 * @priv: Private driver interface data
2399 * @report: Whether to report received Probe Request frames
2400 * Returns: 0 on success, -1 on failure (or if not supported)
2402 * This command can be used to request the driver to indicate when
2403 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2404 * Since this operation may require extra resources, e.g., due to less
2405 * optimal hardware/firmware RX filtering, many drivers may disable
2406 * Probe Request reporting at least in station mode. This command is
2407 * used to notify the driver when the Probe Request frames need to be
2408 * reported, e.g., during remain-on-channel operations.
2410 int (*probe_req_report)(void *priv, int report);
2413 * deinit_ap - Deinitialize AP mode
2414 * @priv: Private driver interface data
2415 * Returns: 0 on success, -1 on failure (or if not supported)
2417 * This optional function can be used to disable AP mode related
2418 * configuration. If the interface was not dynamically added,
2419 * change the driver mode to station mode to allow normal station
2420 * operations like scanning to be completed.
2422 int (*deinit_ap)(void *priv);
2425 * deinit_p2p_cli - Deinitialize P2P client mode
2426 * @priv: Private driver interface data
2427 * Returns: 0 on success, -1 on failure (or if not supported)
2429 * This optional function can be used to disable P2P client mode. If the
2430 * interface was not dynamically added, change the interface type back
2433 int (*deinit_p2p_cli)(void *priv);
2436 * suspend - Notification on system suspend/hibernate event
2437 * @priv: Private driver interface data
2439 void (*suspend)(void *priv);
2442 * resume - Notification on system resume/thaw event
2443 * @priv: Private driver interface data
2445 void (*resume)(void *priv);
2448 * signal_monitor - Set signal monitoring parameters
2449 * @priv: Private driver interface data
2450 * @threshold: Threshold value for signal change events; 0 = disabled
2451 * @hysteresis: Minimum change in signal strength before indicating a
2453 * Returns: 0 on success, -1 on failure (or if not supported)
2455 * This function can be used to configure monitoring of signal strength
2456 * with the current AP. Whenever signal strength drops below the
2457 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2458 * should be generated assuming the signal strength has changed at
2459 * least %hysteresis from the previously indicated signal change event.
2461 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2464 * send_frame - Send IEEE 802.11 frame (testing use only)
2465 * @priv: Private driver interface data
2466 * @data: IEEE 802.11 frame with IEEE 802.11 header
2467 * @data_len: Size of the frame
2468 * @encrypt: Whether to encrypt the frame (if keys are set)
2469 * Returns: 0 on success, -1 on failure
2471 * This function is only used for debugging purposes and is not
2472 * required to be implemented for normal operations.
2474 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2478 * shared_freq - Get operating frequency of shared interface(s)
2479 * @priv: Private driver interface data
2480 * Returns: Operating frequency in MHz, 0 if no shared operation in
2481 * use, or -1 on failure
2483 * This command can be used to request the current operating frequency
2484 * of any virtual interface that shares the same radio to provide
2485 * information for channel selection for other virtual interfaces.
2487 int (*shared_freq)(void *priv);
2490 * get_noa - Get current Notice of Absence attribute payload
2491 * @priv: Private driver interface data
2492 * @buf: Buffer for returning NoA
2493 * @buf_len: Buffer length in octets
2494 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2495 * advertized, or -1 on failure
2497 * This function is used to fetch the current Notice of Absence
2498 * attribute value from GO.
2500 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2503 * set_noa - Set Notice of Absence parameters for GO (testing)
2504 * @priv: Private driver interface data
2506 * @start: Start time in ms from next TBTT
2507 * @duration: Duration in ms
2508 * Returns: 0 on success or -1 on failure
2510 * This function is used to set Notice of Absence parameters for GO. It
2511 * is used only for testing. To disable NoA, all parameters are set to
2514 int (*set_noa)(void *priv, u8 count, int start, int duration);
2517 * set_p2p_powersave - Set P2P power save options
2518 * @priv: Private driver interface data
2519 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2520 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2521 * @ctwindow: 0.. = change (msec), -1 = no change
2522 * Returns: 0 on success or -1 on failure
2524 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2528 * ampdu - Enable/disable aggregation
2529 * @priv: Private driver interface data
2530 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2531 * Returns: 0 on success or -1 on failure
2533 int (*ampdu)(void *priv, int ampdu);
2536 * get_radio_name - Get physical radio name for the device
2537 * @priv: Private driver interface data
2538 * Returns: Radio name or %NULL if not known
2540 * The returned data must not be modified by the caller. It is assumed
2541 * that any interface that has the same radio name as another is
2542 * sharing the same physical radio. This information can be used to
2543 * share scan results etc. information between the virtual interfaces
2544 * to speed up various operations.
2546 const char * (*get_radio_name)(void *priv);
2549 * send_tdls_mgmt - for sending TDLS management packets
2550 * @priv: private driver interface data
2551 * @dst: Destination (peer) MAC address
2552 * @action_code: TDLS action code for the mssage
2553 * @dialog_token: Dialog Token to use in the message (if needed)
2554 * @status_code: Status Code or Reason Code to use (if needed)
2555 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2556 * @initiator: Is the current end the TDLS link initiator
2557 * @buf: TDLS IEs to add to the message
2558 * @len: Length of buf in octets
2559 * Returns: 0 on success, negative (<0) on failure
2561 * This optional function can be used to send packet to driver which is
2562 * responsible for receiving and sending all TDLS packets.
2564 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2565 u8 dialog_token, u16 status_code, u32 peer_capab,
2566 int initiator, const u8 *buf, size_t len);
2569 * tdls_oper - Ask the driver to perform high-level TDLS operations
2570 * @priv: Private driver interface data
2571 * @oper: TDLS high-level operation. See %enum tdls_oper
2572 * @peer: Destination (peer) MAC address
2573 * Returns: 0 on success, negative (<0) on failure
2575 * This optional function can be used to send high-level TDLS commands
2578 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2581 * wnm_oper - Notify driver of the WNM frame reception
2582 * @priv: Private driver interface data
2583 * @oper: WNM operation. See %enum wnm_oper
2584 * @peer: Destination (peer) MAC address
2585 * @buf: Buffer for the driver to fill in (for getting IE)
2586 * @buf_len: Return the len of buf
2587 * Returns: 0 on success, negative (<0) on failure
2589 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2590 u8 *buf, u16 *buf_len);
2593 * set_qos_map - Set QoS Map
2594 * @priv: Private driver interface data
2595 * @qos_map_set: QoS Map
2596 * @qos_map_set_len: Length of QoS Map
2598 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2599 u8 qos_map_set_len);
2602 * set_wowlan - Set wake-on-wireless triggers
2603 * @priv: Private driver interface data
2604 * @triggers: wowlan triggers
2606 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2609 * signal_poll - Get current connection information
2610 * @priv: Private driver interface data
2611 * @signal_info: Connection info structure
2613 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2616 * set_authmode - Set authentication algorithm(s) for static WEP
2617 * @priv: Private driver interface data
2618 * @authmode: 1=Open System, 2=Shared Key, 3=both
2619 * Returns: 0 on success, -1 on failure
2621 * This function can be used to set authentication algorithms for AP
2622 * mode when static WEP is used. If the driver uses user space MLME/SME
2623 * implementation, there is no need to implement this function.
2625 * DEPRECATED - use set_ap() instead
2627 int (*set_authmode)(void *priv, int authmode);
2631 * driver_cmd - Execute driver-specific command
2632 * @priv: Private driver interface data
2633 * @cmd: Command to execute
2634 * @buf: Return buffer
2635 * @buf_len: Buffer length
2636 * Returns: 0 on success, -1 on failure
2638 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2639 #endif /* ANDROID */
2642 * vendor_cmd - Execute vendor specific command
2643 * @priv: Private driver interface data
2644 * @vendor_id: Vendor id
2645 * @subcmd: Vendor command id
2646 * @data: Vendor command parameters (%NULL if no parameters)
2647 * @data_len: Data length
2648 * @buf: Return buffer (%NULL to ignore reply)
2649 * Returns: 0 on success, negative (<0) on failure
2651 * This function handles vendor specific commands that are passed to
2652 * the driver/device. The command is identified by vendor id and
2653 * command id. Parameters can be passed as argument to the command
2654 * in the data buffer. Reply (if any) will be filled in the supplied
2657 * The exact driver behavior is driver interface and vendor specific. As
2658 * an example, this will be converted to a vendor specific cfg80211
2659 * command in case of the nl80211 driver interface.
2661 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2662 unsigned int subcmd, const u8 *data, size_t data_len,
2663 struct wpabuf *buf);
2666 * set_rekey_info - Set rekey information
2667 * @priv: Private driver interface data
2670 * @replay_ctr: Current EAPOL-Key Replay Counter
2672 * This optional function can be used to provide information for the
2673 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2674 * while the host (including wpa_supplicant) is sleeping.
2676 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2677 const u8 *replay_ctr);
2680 * sta_assoc - Station association indication
2681 * @priv: Private driver interface data
2682 * @own_addr: Source address and BSSID for association frame
2683 * @addr: MAC address of the station to associate
2684 * @reassoc: flag to indicate re-association
2685 * @status: association response status code
2686 * @ie: assoc response ie buffer
2687 * @len: ie buffer length
2688 * Returns: 0 on success, -1 on failure
2690 * This function indicates the driver to send (Re)Association
2691 * Response frame to the station.
2693 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2694 int reassoc, u16 status, const u8 *ie, size_t len);
2697 * sta_auth - Station authentication indication
2698 * @priv: Private driver interface data
2699 * @own_addr: Source address and BSSID for authentication frame
2700 * @addr: MAC address of the station to associate
2701 * @seq: authentication sequence number
2702 * @status: authentication response status code
2703 * @ie: authentication frame ie buffer
2704 * @len: ie buffer length
2706 * This function indicates the driver to send Authentication frame
2709 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2710 u16 seq, u16 status, const u8 *ie, size_t len);
2713 * add_tspec - Add traffic stream
2714 * @priv: Private driver interface data
2715 * @addr: MAC address of the station to associate
2716 * @tspec_ie: tspec ie buffer
2717 * @tspec_ielen: tspec ie length
2718 * Returns: 0 on success, -1 on failure
2720 * This function adds the traffic steam for the station
2721 * and fills the medium_time in tspec_ie.
2723 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2724 size_t tspec_ielen);
2727 * add_sta_node - Add a station node in the driver
2728 * @priv: Private driver interface data
2729 * @addr: MAC address of the station to add
2730 * @auth_alg: authentication algorithm used by the station
2731 * Returns: 0 on success, -1 on failure
2733 * This function adds the station node in the driver, when
2734 * the station gets added by FT-over-DS.
2736 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2739 * sched_scan - Request the driver to initiate scheduled scan
2740 * @priv: Private driver interface data
2741 * @params: Scan parameters
2742 * @interval: Interval between scan cycles in milliseconds
2743 * Returns: 0 on success, -1 on failure
2745 * This operation should be used for scheduled scan offload to
2746 * the hardware. Every time scan results are available, the
2747 * driver should report scan results event for wpa_supplicant
2748 * which will eventually request the results with
2749 * wpa_driver_get_scan_results2(). This operation is optional
2750 * and if not provided or if it returns -1, we fall back to
2751 * normal host-scheduled scans.
2753 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2757 * stop_sched_scan - Request the driver to stop a scheduled scan
2758 * @priv: Private driver interface data
2759 * Returns: 0 on success, -1 on failure
2761 * This should cause the scheduled scan to be stopped and
2762 * results should stop being sent. Must be supported if
2763 * sched_scan is supported.
2765 int (*stop_sched_scan)(void *priv);
2768 * poll_client - Probe (null data or such) the given station
2769 * @priv: Private driver interface data
2770 * @own_addr: MAC address of sending interface
2771 * @addr: MAC address of the station to probe
2772 * @qos: Indicates whether station is QoS station
2774 * This function is used to verify whether an associated station is
2775 * still present. This function does not need to be implemented if the
2776 * driver provides such inactivity polling mechanism.
2778 void (*poll_client)(void *priv, const u8 *own_addr,
2779 const u8 *addr, int qos);
2782 * radio_disable - Disable/enable radio
2783 * @priv: Private driver interface data
2784 * @disabled: 1=disable 0=enable radio
2785 * Returns: 0 on success, -1 on failure
2787 * This optional command is for testing purposes. It can be used to
2788 * disable the radio on a testbed device to simulate out-of-radio-range
2791 int (*radio_disable)(void *priv, int disabled);
2794 * switch_channel - Announce channel switch and migrate the GO to the
2796 * @priv: Private driver interface data
2797 * @settings: Settings for CSA period and new channel
2798 * Returns: 0 on success, -1 on failure
2800 * This function is used to move the GO to the legacy STA channel to
2801 * avoid frequency conflict in single channel concurrency.
2803 int (*switch_channel)(void *priv, struct csa_settings *settings);
2806 * start_dfs_cac - Listen for radar interference on the channel
2807 * @priv: Private driver interface data
2808 * @freq: Channel parameters
2809 * Returns: 0 on success, -1 on failure
2811 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
2814 * stop_ap - Removes beacon from AP
2815 * @priv: Private driver interface data
2816 * Returns: 0 on success, -1 on failure (or if not supported)
2818 * This optional function can be used to disable AP mode related
2819 * configuration. Unlike deinit_ap, it does not change to station
2822 int (*stop_ap)(void *priv);
2825 * get_survey - Retrieve survey data
2826 * @priv: Private driver interface data
2827 * @freq: If set, survey data for the specified frequency is only
2828 * being requested. If not set, all survey data is requested.
2829 * Returns: 0 on success, -1 on failure
2831 * Use this to retrieve:
2833 * - the observed channel noise floor
2834 * - the amount of time we have spent on the channel
2835 * - the amount of time during which we have spent on the channel that
2836 * the radio has determined the medium is busy and we cannot
2838 * - the amount of time we have spent receiving data
2839 * - the amount of time we have spent transmitting data
2841 * This data can be used for spectrum heuristics. One example is
2842 * Automatic Channel Selection (ACS). The channel survey data is
2843 * kept on a linked list on the channel data, one entry is added
2844 * for each survey. The min_nf of the channel is updated for each
2847 int (*get_survey)(void *priv, unsigned int freq);
2850 * status - Get driver interface status information
2851 * @priv: Private driver interface data
2852 * @buf: Buffer for printing tou the status information
2853 * @buflen: Maximum length of the buffer
2854 * Returns: Length of written status information or -1 on failure
2856 int (*status)(void *priv, char *buf, size_t buflen);
2859 * roaming - Set roaming policy for driver-based BSS selection
2860 * @priv: Private driver interface data
2861 * @allowed: Whether roaming within ESS is allowed
2862 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
2863 * Returns: Length of written status information or -1 on failure
2865 * This optional callback can be used to update roaming policy from the
2866 * associate() command (bssid being set there indicates that the driver
2867 * should not roam before getting this roaming() call to allow roaming.
2868 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
2869 * capability, roaming policy is handled within wpa_supplicant and there
2870 * is no need to implement or react to this callback.
2872 int (*roaming)(void *priv, int allowed, const u8 *bssid);
2875 * set_mac_addr - Set MAC address
2876 * @priv: Private driver interface data
2877 * @addr: MAC address to use or %NULL for setting back to permanent
2878 * Returns: 0 on success, -1 on failure
2880 int (*set_mac_addr)(void *priv, const u8 *addr);
2882 #ifdef CONFIG_MACSEC
2883 int (*macsec_init)(void *priv, struct macsec_init_params *params);
2885 int (*macsec_deinit)(void *priv);
2888 * enable_protect_frames - Set protect frames status
2889 * @priv: Private driver interface data
2890 * @enabled: TRUE = protect frames enabled
2891 * FALSE = protect frames disabled
2892 * Returns: 0 on success, -1 on failure (or if not supported)
2894 int (*enable_protect_frames)(void *priv, Boolean enabled);
2897 * set_replay_protect - Set replay protect status and window size
2898 * @priv: Private driver interface data
2899 * @enabled: TRUE = replay protect enabled
2900 * FALSE = replay protect disabled
2901 * @window: replay window size, valid only when replay protect enabled
2902 * Returns: 0 on success, -1 on failure (or if not supported)
2904 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
2907 * set_current_cipher_suite - Set current cipher suite
2908 * @priv: Private driver interface data
2909 * @cs: EUI64 identifier
2910 * @cs_len: Length of the cs buffer in octets
2911 * Returns: 0 on success, -1 on failure (or if not supported)
2913 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
2917 * enable_controlled_port - Set controlled port status
2918 * @priv: Private driver interface data
2919 * @enabled: TRUE = controlled port enabled
2920 * FALSE = controlled port disabled
2921 * Returns: 0 on success, -1 on failure (or if not supported)
2923 int (*enable_controlled_port)(void *priv, Boolean enabled);
2926 * get_receive_lowest_pn - Get receive lowest pn
2927 * @priv: Private driver interface data
2928 * @channel: secure channel
2929 * @an: association number
2930 * @lowest_pn: lowest accept pn
2931 * Returns: 0 on success, -1 on failure (or if not supported)
2933 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
2937 * get_transmit_next_pn - Get transmit next pn
2938 * @priv: Private driver interface data
2939 * @channel: secure channel
2940 * @an: association number
2942 * Returns: 0 on success, -1 on failure (or if not supported)
2944 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
2948 * set_transmit_next_pn - Set transmit next pn
2949 * @priv: Private driver interface data
2950 * @channel: secure channel
2951 * @an: association number
2953 * Returns: 0 on success, -1 on failure (or if not supported)
2955 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
2959 * get_available_receive_sc - get available receive channel
2960 * @priv: Private driver interface data
2961 * @channel: secure channel
2962 * Returns: 0 on success, -1 on failure (or if not supported)
2964 int (*get_available_receive_sc)(void *priv, u32 *channel);
2967 * create_receive_sc - create secure channel for receiving
2968 * @priv: Private driver interface data
2969 * @channel: secure channel
2970 * @sci_addr: secure channel identifier - address
2971 * @sci_port: secure channel identifier - port
2972 * @conf_offset: confidentiality offset (0, 30, or 50)
2973 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
2975 * Returns: 0 on success, -1 on failure (or if not supported)
2977 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
2978 u16 sci_port, unsigned int conf_offset,
2982 * delete_receive_sc - delete secure connection for receiving
2983 * @priv: private driver interface data from init()
2984 * @channel: secure channel
2985 * Returns: 0 on success, -1 on failure
2987 int (*delete_receive_sc)(void *priv, u32 channel);
2990 * create_receive_sa - create secure association for receive
2991 * @priv: private driver interface data from init()
2992 * @channel: secure channel
2993 * @an: association number
2994 * @lowest_pn: the lowest packet number can be received
2995 * @sak: the secure association key
2996 * Returns: 0 on success, -1 on failure
2998 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
2999 u32 lowest_pn, const u8 *sak);
3002 * enable_receive_sa - enable the SA for receive
3003 * @priv: private driver interface data from init()
3004 * @channel: secure channel
3005 * @an: association number
3006 * Returns: 0 on success, -1 on failure
3008 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3011 * disable_receive_sa - disable SA for receive
3012 * @priv: private driver interface data from init()
3013 * @channel: secure channel index
3014 * @an: association number
3015 * Returns: 0 on success, -1 on failure
3017 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3020 * get_available_transmit_sc - get available transmit channel
3021 * @priv: Private driver interface data
3022 * @channel: secure channel
3023 * Returns: 0 on success, -1 on failure (or if not supported)
3025 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3028 * create_transmit_sc - create secure connection for transmit
3029 * @priv: private driver interface data from init()
3030 * @channel: secure channel
3031 * @sci_addr: secure channel identifier - address
3032 * @sci_port: secure channel identifier - port
3033 * Returns: 0 on success, -1 on failure
3035 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3036 u16 sci_port, unsigned int conf_offset);
3039 * delete_transmit_sc - delete secure connection for transmit
3040 * @priv: private driver interface data from init()
3041 * @channel: secure channel
3042 * Returns: 0 on success, -1 on failure
3044 int (*delete_transmit_sc)(void *priv, u32 channel);
3047 * create_transmit_sa - create secure association for transmit
3048 * @priv: private driver interface data from init()
3049 * @channel: secure channel index
3050 * @an: association number
3051 * @next_pn: the packet number used as next transmit packet
3052 * @confidentiality: True if the SA is to provide confidentiality
3053 * as well as integrity
3054 * @sak: the secure association key
3055 * Returns: 0 on success, -1 on failure
3057 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3058 Boolean confidentiality, const u8 *sak);
3061 * enable_transmit_sa - enable SA for transmit
3062 * @priv: private driver interface data from init()
3063 * @channel: secure channel
3064 * @an: association number
3065 * Returns: 0 on success, -1 on failure
3067 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3070 * disable_transmit_sa - disable SA for transmit
3071 * @priv: private driver interface data from init()
3072 * @channel: secure channel
3073 * @an: association number
3074 * Returns: 0 on success, -1 on failure
3076 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3077 #endif /* CONFIG_MACSEC */
3080 * init_mesh - Driver specific initialization for mesh
3081 * @priv: Private driver interface data
3082 * Returns: 0 on success, -1 on failure
3084 int (*init_mesh)(void *priv);
3087 * join_mesh - Join a mesh network
3088 * @priv: Private driver interface data
3089 * @params: Mesh configuration parameters
3090 * Returns: 0 on success, -1 on failure
3092 int (*join_mesh)(void *priv,
3093 struct wpa_driver_mesh_join_params *params);
3096 * leave_mesh - Leave a mesh network
3097 * @priv: Private driver interface data
3098 * Returns 0 on success, -1 on failure
3100 int (*leave_mesh)(void *priv);
3105 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3107 enum wpa_event_type {
3109 * EVENT_ASSOC - Association completed
3111 * This event needs to be delivered when the driver completes IEEE
3112 * 802.11 association or reassociation successfully.
3113 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3114 * after this event has been generated. In addition, optional
3115 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3116 * more information about the association. If the driver interface gets
3117 * both of these events at the same time, it can also include the
3118 * assoc_info data in EVENT_ASSOC call.
3123 * EVENT_DISASSOC - Association lost
3125 * This event should be called when association is lost either due to
3126 * receiving deauthenticate or disassociate frame from the AP or when
3127 * sending either of these frames to the current AP. If the driver
3128 * supports separate deauthentication event, EVENT_DISASSOC should only
3129 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3130 * In AP mode, union wpa_event_data::disassoc_info is required.
3135 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3137 * This event must be delivered when a Michael MIC error is detected by
3138 * the local driver. Additional data for event processing is
3139 * provided with union wpa_event_data::michael_mic_failure. This
3140 * information is used to request new encyption key and to initiate
3141 * TKIP countermeasures if needed.
3143 EVENT_MICHAEL_MIC_FAILURE,
3146 * EVENT_SCAN_RESULTS - Scan results available
3148 * This event must be called whenever scan results are available to be
3149 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3150 * is expected to be used some time after struct wpa_driver_ops::scan()
3151 * is called. If the driver provides an unsolicited event when the scan
3152 * has been completed, this event can be used to trigger
3153 * EVENT_SCAN_RESULTS call. If such event is not available from the
3154 * driver, the driver wrapper code is expected to use a registered
3155 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3156 * scan is expected to be completed. Optional information about
3157 * completed scan can be provided with union wpa_event_data::scan_info.
3162 * EVENT_ASSOCINFO - Report optional extra information for association
3164 * This event can be used to report extra association information for
3165 * EVENT_ASSOC processing. This extra information includes IEs from
3166 * association frames and Beacon/Probe Response frames in union
3167 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3168 * EVENT_ASSOC. Alternatively, the driver interface can include
3169 * assoc_info data in the EVENT_ASSOC call if it has all the
3170 * information available at the same point.
3175 * EVENT_INTERFACE_STATUS - Report interface status changes
3177 * This optional event can be used to report changes in interface
3178 * status (interface added/removed) using union
3179 * wpa_event_data::interface_status. This can be used to trigger
3180 * wpa_supplicant to stop and re-start processing for the interface,
3181 * e.g., when a cardbus card is ejected/inserted.
3183 EVENT_INTERFACE_STATUS,
3186 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3188 * This event can be used to inform wpa_supplicant about candidates for
3189 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3190 * for scan request (ap_scan=2 mode), this event is required for
3191 * pre-authentication. If wpa_supplicant is performing scan request
3192 * (ap_scan=1), this event is optional since scan results can be used
3193 * to add pre-authentication candidates. union
3194 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3195 * candidate and priority of the candidate, e.g., based on the signal
3196 * strength, in order to try to pre-authenticate first with candidates
3197 * that are most likely targets for re-association.
3199 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3200 * on the candidate list. In addition, it can be called for the current
3201 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3202 * will automatically skip pre-authentication in cases where a valid
3203 * PMKSA exists. When more than one candidate exists, this event should
3204 * be generated once for each candidate.
3206 * Driver will be notified about successful pre-authentication with
3207 * struct wpa_driver_ops::add_pmkid() calls.
3209 EVENT_PMKID_CANDIDATE,
3212 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3214 * This event can be used to inform wpa_supplicant about desire to set
3215 * up secure direct link connection between two stations as defined in
3216 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3217 * STAKey negotiation. The caller will need to set peer address for the
3223 * EVENT_TDLS - Request TDLS operation
3225 * This event can be used to request a TDLS operation to be performed.
3230 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3232 * The driver is expected to report the received FT IEs from
3233 * FT authentication sequence from the AP. The FT IEs are included in
3234 * the extra information in union wpa_event_data::ft_ies.
3239 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3241 * The driver can use this event to inform wpa_supplicant about a STA
3242 * in an IBSS with which protected frames could be exchanged. This
3243 * event starts RSN authentication with the other STA to authenticate
3244 * the STA and set up encryption keys with it.
3246 EVENT_IBSS_RSN_START,
3249 * EVENT_AUTH - Authentication result
3251 * This event should be called when authentication attempt has been
3252 * completed. This is only used if the driver supports separate
3253 * authentication step (struct wpa_driver_ops::authenticate).
3254 * Information about authentication result is included in
3255 * union wpa_event_data::auth.
3260 * EVENT_DEAUTH - Authentication lost
3262 * This event should be called when authentication is lost either due
3263 * to receiving deauthenticate frame from the AP or when sending that
3264 * frame to the current AP.
3265 * In AP mode, union wpa_event_data::deauth_info is required.
3270 * EVENT_ASSOC_REJECT - Association rejected
3272 * This event should be called when (re)association attempt has been
3273 * rejected by the AP. Information about the association response is
3274 * included in union wpa_event_data::assoc_reject.
3279 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3281 EVENT_AUTH_TIMED_OUT,
3284 * EVENT_ASSOC_TIMED_OUT - Association timed out
3286 EVENT_ASSOC_TIMED_OUT,
3289 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
3294 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3296 EVENT_WPS_BUTTON_PUSHED,
3299 * EVENT_TX_STATUS - Report TX status
3304 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3306 EVENT_RX_FROM_UNKNOWN,
3309 * EVENT_RX_MGMT - Report RX of a management frame
3314 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3316 * This event is used to indicate when the driver has started the
3317 * requested remain-on-channel duration. Information about the
3318 * operation is included in union wpa_event_data::remain_on_channel.
3320 EVENT_REMAIN_ON_CHANNEL,
3323 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3325 * This event is used to indicate when the driver has completed
3326 * remain-on-channel duration, i.e., may noot be available on the
3327 * requested channel anymore. Information about the
3328 * operation is included in union wpa_event_data::remain_on_channel.
3330 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3333 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
3335 * This event is used only by driver_test.c and userspace MLME.
3340 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3342 * This event is used to indicate when a Probe Request frame has been
3343 * received. Information about the received frame is included in
3344 * union wpa_event_data::rx_probe_req. The driver is required to report
3345 * these events only after successfully completed probe_req_report()
3346 * commands to request the events (i.e., report parameter is non-zero)
3347 * in station mode. In AP mode, Probe Request frames should always be
3353 * EVENT_NEW_STA - New wired device noticed
3355 * This event is used to indicate that a new device has been detected
3356 * in a network that does not use association-like functionality (i.e.,
3357 * mainly wired Ethernet). This can be used to start EAPOL
3358 * authenticator when receiving a frame from a device. The address of
3359 * the device is included in union wpa_event_data::new_sta.
3364 * EVENT_EAPOL_RX - Report received EAPOL frame
3366 * When in AP mode with hostapd, this event is required to be used to
3367 * deliver the receive EAPOL frames from the driver. With
3368 * %wpa_supplicant, this event is used only if the send_eapol() handler
3369 * is used to override the use of l2_packet for EAPOL frame TX.
3374 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3376 * This event is used to indicate changes in the signal strength
3377 * observed in frames received from the current AP if signal strength
3378 * monitoring has been enabled with signal_monitor().
3380 EVENT_SIGNAL_CHANGE,
3383 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3385 * This event is used to indicate that the interface was enabled after
3386 * having been previously disabled, e.g., due to rfkill.
3388 EVENT_INTERFACE_ENABLED,
3391 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3393 * This event is used to indicate that the interface was disabled,
3394 * e.g., due to rfkill.
3396 EVENT_INTERFACE_DISABLED,
3399 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3401 * This event is used to indicate that the channel list has changed,
3402 * e.g., because of a regulatory domain change triggered by scan
3403 * results including an AP advertising a country code.
3405 EVENT_CHANNEL_LIST_CHANGED,
3408 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3410 * This event is used to indicate that the driver cannot maintain this
3411 * interface in its operation mode anymore. The most likely use for
3412 * this is to indicate that AP mode operation is not available due to
3413 * operating channel would need to be changed to a DFS channel when
3414 * the driver does not support radar detection and another virtual
3415 * interfaces caused the operating channel to change. Other similar
3416 * resource conflicts could also trigger this for station mode
3417 * interfaces. This event can be propagated when channel switching
3420 EVENT_INTERFACE_UNAVAILABLE,
3423 * EVENT_BEST_CHANNEL
3425 * Driver generates this event whenever it detects a better channel
3426 * (e.g., based on RSSI or channel use). This information can be used
3427 * to improve channel selection for a new AP/P2P group.
3432 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3434 * This event should be called when a Deauthentication frame is dropped
3435 * due to it not being protected (MFP/IEEE 802.11w).
3436 * union wpa_event_data::unprot_deauth is required to provide more
3437 * details of the frame.
3439 EVENT_UNPROT_DEAUTH,
3442 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3444 * This event should be called when a Disassociation frame is dropped
3445 * due to it not being protected (MFP/IEEE 802.11w).
3446 * union wpa_event_data::unprot_disassoc is required to provide more
3447 * details of the frame.
3449 EVENT_UNPROT_DISASSOC,
3452 * EVENT_STATION_LOW_ACK
3454 * Driver generates this event whenever it detected that a particular
3455 * station was lost. Detection can be through massive transmission
3456 * failures for example.
3458 EVENT_STATION_LOW_ACK,
3461 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3463 EVENT_IBSS_PEER_LOST,
3466 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3468 * This event carries the new replay counter to notify wpa_supplicant
3469 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3470 * completed Group Key Handshake while the host (including
3471 * wpa_supplicant was sleeping).
3473 EVENT_DRIVER_GTK_REKEY,
3476 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3478 EVENT_SCHED_SCAN_STOPPED,
3481 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3483 * This event indicates that the station responded to the poll
3484 * initiated with @poll_client.
3486 EVENT_DRIVER_CLIENT_POLL_OK,
3489 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3491 EVENT_EAPOL_TX_STATUS,
3494 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3496 * Described in wpa_event_data.ch_switch
3501 * EVENT_WNM - Request WNM operation
3503 * This event can be used to request a WNM operation to be performed.
3508 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3510 * This event indicates that the driver reported a connection failure
3511 * with the specified client (for example, max client reached, etc.) in
3514 EVENT_CONNECT_FAILED_REASON,
3517 * EVENT_RADAR_DETECTED - Notify of radar detection
3519 * A radar has been detected on the supplied frequency, hostapd should
3520 * react accordingly (e.g., change channel).
3522 EVENT_DFS_RADAR_DETECTED,
3525 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3527 * After a successful CAC, the channel can be marked clear and used.
3529 EVENT_DFS_CAC_FINISHED,
3532 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3534 * The CAC was not successful, and the channel remains in the previous
3535 * state. This may happen due to a radar beeing detected or other
3536 * external influences.
3538 EVENT_DFS_CAC_ABORTED,
3541 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3543 * The channel which was previously unavailable is now available again.
3545 EVENT_DFS_NOP_FINISHED,
3548 * EVENT_SURVEY - Received survey data
3550 * This event gets triggered when a driver query is issued for survey
3551 * data and the requested data becomes available. The returned data is
3552 * stored in struct survey_results. The results provide at most one
3553 * survey entry for each frequency and at minimum will provide one
3554 * survey entry for one frequency. The survey data can be os_malloc()'d
3555 * and then os_free()'d, so the event callback must only copy data.
3560 * EVENT_SCAN_STARTED - Scan started
3562 * This indicates that driver has started a scan operation either based
3563 * on a request from wpa_supplicant/hostapd or from another application.
3564 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3565 * completed (either successfully or by getting cancelled).
3570 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3572 * This event indicates a set of frequency ranges that should be avoided
3573 * to reduce issues due to interference or internal co-existence
3574 * information in the driver.
3576 EVENT_AVOID_FREQUENCIES,
3579 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3581 EVENT_NEW_PEER_CANDIDATE
3587 * struct freq_survey - Channel survey info
3589 * @ifidx: Interface index in which this survey was observed
3590 * @freq: Center of frequency of the surveyed channel
3591 * @nf: Channel noise floor in dBm
3592 * @channel_time: Amount of time in ms the radio spent on the channel
3593 * @channel_time_busy: Amount of time in ms the radio detected some signal
3594 * that indicated to the radio the channel was not clear
3595 * @channel_time_rx: Amount of time the radio spent receiving data
3596 * @channel_time_tx: Amount of time the radio spent transmitting data
3597 * @filled: bitmask indicating which fields have been reported, see
3598 * SURVEY_HAS_* defines.
3599 * @list: Internal list pointers
3601 struct freq_survey {
3606 u64 channel_time_busy;
3607 u64 channel_time_rx;
3608 u64 channel_time_tx;
3609 unsigned int filled;
3610 struct dl_list list;
3613 #define SURVEY_HAS_NF BIT(0)
3614 #define SURVEY_HAS_CHAN_TIME BIT(1)
3615 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3616 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3617 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3621 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3623 union wpa_event_data {
3625 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3627 * This structure is optional for EVENT_ASSOC calls and required for
3628 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3629 * driver interface does not need to generate separate EVENT_ASSOCINFO
3634 * reassoc - Flag to indicate association or reassociation
3639 * req_ies - (Re)Association Request IEs
3641 * If the driver generates WPA/RSN IE, this event data must be
3642 * returned for WPA handshake to have needed information. If
3643 * wpa_supplicant-generated WPA/RSN IE is used, this
3644 * information event is optional.
3646 * This should start with the first IE (fixed fields before IEs
3647 * are not included).
3652 * req_ies_len - Length of req_ies in bytes
3657 * resp_ies - (Re)Association Response IEs
3659 * Optional association data from the driver. This data is not
3660 * required WPA, but may be useful for some protocols and as
3661 * such, should be reported if this is available to the driver
3664 * This should start with the first IE (fixed fields before IEs
3665 * are not included).
3670 * resp_ies_len - Length of resp_ies in bytes
3672 size_t resp_ies_len;
3675 * beacon_ies - Beacon or Probe Response IEs
3677 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3678 * Probe Response frames from the current AP (i.e., the one
3679 * that the client just associated with). This information is
3680 * used to update WPA/RSN IE for the AP. If this field is not
3681 * set, the results from previous scan will be used. If no
3682 * data for the new AP is found, scan results will be requested
3683 * again (without scan request). At this point, the driver is
3684 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3687 * This should start with the first IE (fixed fields before IEs
3688 * are not included).
3690 const u8 *beacon_ies;
3693 * beacon_ies_len - Length of beacon_ies */
3694 size_t beacon_ies_len;
3697 * freq - Frequency of the operational channel in MHz
3702 * addr - Station address (for AP mode)
3707 * The following is the key management offload information
3710 * @key_replay_ctr_len
3718 * authorized - Status of key management offload,
3724 * key_replay_ctr - Key replay counter value last used
3725 * in a valid EAPOL-Key frame
3727 const u8 *key_replay_ctr;
3730 * key_replay_ctr_len - The length of key_replay_ctr
3732 size_t key_replay_ctr_len;
3735 * ptk_kck - The derived PTK KCK
3740 * ptk_kek_len - The length of ptk_kck
3745 * ptk_kek - The derived PTK KEK
3750 * ptk_kek_len - The length of ptk_kek
3756 * struct disassoc_info - Data for EVENT_DISASSOC events
3758 struct disassoc_info {
3760 * addr - Station address (for AP mode)
3765 * reason_code - Reason Code (host byte order) used in
3766 * Deauthentication frame
3771 * ie - Optional IE(s) in Disassociation frame
3776 * ie_len - Length of ie buffer in octets
3781 * locally_generated - Whether the frame was locally generated
3783 int locally_generated;
3787 * struct deauth_info - Data for EVENT_DEAUTH events
3789 struct deauth_info {
3791 * addr - Station address (for AP mode)
3796 * reason_code - Reason Code (host byte order) used in
3797 * Deauthentication frame
3802 * ie - Optional IE(s) in Deauthentication frame
3807 * ie_len - Length of ie buffer in octets
3812 * locally_generated - Whether the frame was locally generated
3814 int locally_generated;
3818 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3820 struct michael_mic_failure {
3823 } michael_mic_failure;
3826 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3828 struct interface_status {
3831 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3836 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3838 struct pmkid_candidate {
3839 /** BSSID of the PMKID candidate */
3841 /** Smaller the index, higher the priority */
3843 /** Whether RSN IE includes pre-authenticate flag */
3848 * struct stkstart - Data for EVENT_STKSTART
3855 * struct tdls - Data for EVENT_TDLS
3861 TDLS_REQUEST_TEARDOWN
3863 u16 reason_code; /* for teardown */
3867 * struct wnm - Data for EVENT_WNM
3885 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3887 * During FT (IEEE 802.11r) authentication sequence, the driver is
3888 * expected to use this event to report received FT IEs (MDIE, FTIE,
3889 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3890 * IEs for the next message will be delivered through the
3891 * struct wpa_driver_ops::update_ft_ies() callback.
3897 u8 target_ap[ETH_ALEN];
3898 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3900 /** Length of ric_ies buffer in octets */
3905 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3907 struct ibss_rsn_start {
3912 * struct auth_info - Data for EVENT_AUTH events
3918 u16 auth_transaction;
3925 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3927 struct assoc_reject {
3929 * bssid - BSSID of the AP that rejected association
3934 * resp_ies - (Re)Association Response IEs
3936 * Optional association data from the driver. This data is not
3937 * required WPA, but may be useful for some protocols and as
3938 * such, should be reported if this is available to the driver
3941 * This should start with the first IE (fixed fields before IEs
3942 * are not included).
3947 * resp_ies_len - Length of resp_ies in bytes
3949 size_t resp_ies_len;
3952 * status_code - Status Code from (Re)association Response
3957 struct timeout_event {
3962 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3971 * struct tx_status - Data for EVENT_TX_STATUS events
3983 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3985 struct rx_from_unknown {
3992 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4000 * drv_priv - Pointer to store driver private BSS information
4002 * If not set to NULL, this is used for comparison with
4003 * hostapd_data->drv_priv to determine which BSS should process
4009 * freq - Frequency (in MHz) on which the frame was received
4014 * ssi_signal - Signal strength in dBm (or 0 if not available)
4020 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4022 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4024 struct remain_on_channel {
4026 * freq - Channel frequency in MHz
4031 * duration - Duration to remain on the channel in milliseconds
4033 unsigned int duration;
4034 } remain_on_channel;
4037 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4038 * @aborted: Whether the scan was aborted
4039 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4040 * @num_freqs: Number of entries in freqs array
4041 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4043 * @num_ssids: Number of entries in ssids array
4049 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4054 * struct mlme_rx - Data for EVENT_MLME_RX events
4065 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4067 struct rx_probe_req {
4069 * sa - Source address of the received Probe Request frame
4074 * da - Destination address of the received Probe Request frame
4075 * or %NULL if not available
4080 * bssid - BSSID of the received Probe Request frame or %NULL
4086 * ie - IEs from the Probe Request body
4091 * ie_len - Length of ie buffer in octets
4096 * signal - signal strength in dBm (or 0 if not available)
4102 * struct new_sta - Data for EVENT_NEW_STA events
4109 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4118 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4120 struct wpa_signal_info signal_change;
4123 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4124 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4125 * @freq_5: Best 5 GHz band channel frequency in MHz
4126 * @freq_overall: Best channel frequency in MHz
4128 * 0 can be used to indicate no preference in either band.
4130 struct best_channel {
4136 struct unprot_deauth {
4142 struct unprot_disassoc {
4149 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4150 * @addr: station address
4157 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4159 struct ibss_peer_lost {
4164 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4166 struct driver_gtk_rekey {
4168 const u8 *replay_ctr;
4172 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4173 * @addr: station address
4175 struct client_poll {
4180 * struct eapol_tx_status
4181 * @dst: Original destination
4182 * @data: Data starting with IEEE 802.1X header (!)
4183 * @data_len: Length of data
4184 * @ack: Indicates ack or lost frame
4186 * This corresponds to hapd_send_eapol if the frame sent
4187 * there isn't just reported as EVENT_TX_STATUS.
4189 struct eapol_tx_status {
4198 * @freq: Frequency of new channel in MHz
4199 * @ht_enabled: Whether this is an HT channel
4200 * @ch_offset: Secondary channel offset
4201 * @ch_width: Channel width
4202 * @cf1: Center frequency 1
4203 * @cf2: Center frequency 2
4209 enum chan_width ch_width;
4215 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4216 * @addr: Remote client address
4217 * @code: Reason code for connection failure
4219 struct connect_failed_reason {
4225 } connect_failed_reason;
4228 * struct dfs_event - Data for radar detected events
4229 * @freq: Frequency of the channel in MHz
4235 enum chan_width chan_width;
4241 * survey_results - Survey result data for EVENT_SURVEY
4242 * @freq_filter: Requested frequency survey filter, 0 if request
4243 * was for all survey data
4244 * @survey_list: Linked list of survey data
4246 struct survey_results {
4247 unsigned int freq_filter;
4248 struct dl_list survey_list; /* struct freq_survey */
4252 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4253 * @initiator: Initiator of the regulatory change
4254 * @type: Regulatory change type
4255 * @alpha2: Country code (or "" if not available)
4257 struct channel_list_changed {
4258 enum reg_change_initiator initiator;
4261 } channel_list_changed;
4264 * freq_range - List of frequency ranges
4266 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4268 struct wpa_freq_range_list freq_range;
4273 * @peer: Peer address
4275 * @ie_len: Length of @ies
4277 * Notification of new candidate mesh peer.
4288 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4289 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4290 * with struct wpa_driver_ops::init()
4291 * @event: event type (defined above)
4292 * @data: possible extra data for the event
4294 * Driver wrapper code should call this function whenever an event is received
4297 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4298 union wpa_event_data *data);
4302 * The following inline functions are provided for convenience to simplify
4303 * event indication for some of the common events.
4306 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4307 size_t ielen, int reassoc)
4309 union wpa_event_data event;
4310 os_memset(&event, 0, sizeof(event));
4311 event.assoc_info.reassoc = reassoc;
4312 event.assoc_info.req_ies = ie;
4313 event.assoc_info.req_ies_len = ielen;
4314 event.assoc_info.addr = addr;
4315 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4318 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4320 union wpa_event_data event;
4321 os_memset(&event, 0, sizeof(event));
4322 event.disassoc_info.addr = addr;
4323 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4326 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4329 union wpa_event_data event;
4330 os_memset(&event, 0, sizeof(event));
4331 event.eapol_rx.src = src;
4332 event.eapol_rx.data = data;
4333 event.eapol_rx.data_len = data_len;
4334 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4337 /* driver_common.c */
4338 void wpa_scan_results_free(struct wpa_scan_results *res);
4340 /* Convert wpa_event_type to a string for logging */
4341 const char * event_to_string(enum wpa_event_type event);
4343 /* Convert chan_width to a string for logging and control interfaces */
4344 const char * channel_width_to_string(enum chan_width width);
4346 int ht_supported(const struct hostapd_hw_modes *mode);
4347 int vht_supported(const struct hostapd_hw_modes *mode);
4349 /* NULL terminated array of linked in driver wrappers */
4350 extern struct wpa_driver_ops *wpa_drivers[];
4352 #endif /* DRIVER_H */