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
174 #define IEEE80211_CAP_ESS 0x0001
175 #define IEEE80211_CAP_IBSS 0x0002
176 #define IEEE80211_CAP_PRIVACY 0x0010
178 /* DMG (60 GHz) IEEE 802.11ad */
179 /* type - bits 0..1 */
180 #define IEEE80211_CAP_DMG_MASK 0x0003
181 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
182 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
183 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
185 #define WPA_SCAN_QUAL_INVALID BIT(0)
186 #define WPA_SCAN_NOISE_INVALID BIT(1)
187 #define WPA_SCAN_LEVEL_INVALID BIT(2)
188 #define WPA_SCAN_LEVEL_DBM BIT(3)
189 #define WPA_SCAN_AUTHENTICATED BIT(4)
190 #define WPA_SCAN_ASSOCIATED BIT(5)
193 * struct wpa_scan_res - Scan result for an BSS/IBSS
194 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
196 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
197 * @beacon_int: beacon interval in TUs (host byte order)
198 * @caps: capability information field in host byte order
199 * @qual: signal quality
200 * @noise: noise level
201 * @level: signal level
203 * @age: Age of the information in milliseconds (i.e., how many milliseconds
204 * ago the last Beacon or Probe Response frame was received)
205 * @ie_len: length of the following IE field in octets
206 * @beacon_ie_len: length of the following Beacon IE field in octets
208 * This structure is used as a generic format for scan results from the
209 * driver. Each driver interface implementation is responsible for converting
210 * the driver or OS specific scan results into this format.
212 * If the driver does not support reporting all IEs, the IE data structure is
213 * constructed of the IEs that are available. This field will also need to
214 * include SSID in IE format. All drivers are encouraged to be extended to
215 * report all IEs to make it easier to support future additions.
217 struct wpa_scan_res {
229 size_t beacon_ie_len;
231 * Followed by ie_len octets of IEs from Probe Response frame (or if
232 * the driver does not indicate source of IEs, these may also be from
233 * Beacon frame). After the first set of IEs, another set of IEs may
234 * follow (with beacon_ie_len octets of data) if the driver provides
240 * struct wpa_scan_results - Scan results
241 * @res: Array of pointers to allocated variable length scan result entries
242 * @num: Number of entries in the scan result array
243 * @fetch_time: Time when the results were fetched from the driver
245 struct wpa_scan_results {
246 struct wpa_scan_res **res;
248 struct os_reltime fetch_time;
252 * struct wpa_interface_info - Network interface information
253 * @next: Pointer to the next interface or NULL if this is the last one
254 * @ifname: Interface name that can be used with init() or init2()
255 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
257 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
258 * is not an allocated copy, i.e., get_interfaces() caller will not free
261 struct wpa_interface_info {
262 struct wpa_interface_info *next;
265 const char *drv_name;
268 #define WPAS_MAX_SCAN_SSIDS 16
271 * struct wpa_driver_scan_params - Scan parameters
272 * Data for struct wpa_driver_ops::scan2().
274 struct wpa_driver_scan_params {
276 * ssids - SSIDs to scan for
278 struct wpa_driver_scan_ssid {
280 * ssid - specific SSID to scan for (ProbeReq)
281 * %NULL or zero-length SSID is used to indicate active scan
282 * with wildcard SSID.
286 * ssid_len: Length of the SSID in octets
289 } ssids[WPAS_MAX_SCAN_SSIDS];
292 * num_ssids - Number of entries in ssids array
293 * Zero indicates a request for a passive scan.
298 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
303 * extra_ies_len - Length of extra_ies in octets
305 size_t extra_ies_len;
308 * freqs - Array of frequencies to scan or %NULL for all frequencies
310 * The frequency is set in MHz. The array is zero-terminated.
315 * filter_ssids - Filter for reporting SSIDs
317 * This optional parameter can be used to request the driver wrapper to
318 * filter scan results to include only the specified SSIDs. %NULL
319 * indicates that no filtering is to be done. This can be used to
320 * reduce memory needs for scan results in environments that have large
321 * number of APs with different SSIDs.
323 * The driver wrapper is allowed to take this allocated buffer into its
324 * own use by setting the pointer to %NULL. In that case, the driver
325 * wrapper is responsible for freeing the buffer with os_free() once it
326 * is not needed anymore.
328 struct wpa_driver_scan_filter {
334 * num_filter_ssids - Number of entries in filter_ssids array
336 size_t num_filter_ssids;
339 * filter_rssi - Filter by RSSI
341 * The driver may filter scan results in firmware to reduce host
342 * wakeups and thereby save power. Specify the RSSI threshold in s32
348 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
350 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
351 * Mbps from the support rates element(s) in the Probe Request frames
352 * and not to transmit the frames at any of those rates.
354 unsigned int p2p_probe:1;
357 * only_new_results - Request driver to report only new results
359 * This is used to request the driver to report only BSSes that have
360 * been detected after this scan request has been started, i.e., to
361 * flush old cached BSS entries.
363 unsigned int only_new_results:1;
366 * low_priority - Requests driver to use a lower scan priority
368 * This is used to request the driver to use a lower scan priority
369 * if it supports such a thing.
371 unsigned int low_priority:1;
374 * NOTE: Whenever adding new parameters here, please make sure
375 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
381 * struct wpa_driver_auth_params - Authentication parameters
382 * Data for struct wpa_driver_ops::authenticate().
384 struct wpa_driver_auth_params {
392 const u8 *wep_key[4];
393 size_t wep_key_len[4];
395 int local_state_change;
398 * p2p - Whether this connection is a P2P group
408 WPS_MODE_NONE /* no WPS provisioning being used */,
409 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
410 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
414 struct hostapd_freq_params {
420 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
421 * secondary channel below primary, 1 = HT40
422 * enabled, secondary channel above primary */
427 /* valid for both HT and VHT, center_freq2 is non-zero
428 * only for bandwidth 80 and an 80+80 channel */
429 int center_freq1, center_freq2;
434 * struct wpa_driver_associate_params - Association parameters
435 * Data for struct wpa_driver_ops::associate().
437 struct wpa_driver_associate_params {
439 * bssid - BSSID of the selected AP
440 * This can be %NULL, if ap_scan=2 mode is used and the driver is
441 * responsible for selecting with which BSS to associate. */
445 * bssid_hint - BSSID of a proposed AP
447 * This indicates which BSS has been found a suitable candidate for
448 * initial association for drivers that use driver/firmwate-based BSS
449 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
450 * the driver from selecting other BSSes in the ESS.
452 const u8 *bssid_hint;
455 * ssid - The selected SSID
460 * ssid_len - Length of the SSID (1..32)
465 * freq - channel parameters
467 struct hostapd_freq_params freq;
470 * freq_hint - Frequency of the channel the proposed AP is using
472 * This provides a channel on which a suitable BSS has been found as a
473 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
474 * limit the driver from selecting other channels for
475 * driver/firmware-based BSS selection.
480 * bg_scan_period - Background scan period in seconds, 0 to disable
481 * background scan, or -1 to indicate no change to default driver
487 * beacon_int - Beacon interval for IBSS or 0 to use driver default
492 * wpa_ie - WPA information element for (Re)Association Request
493 * WPA information element to be included in (Re)Association
494 * Request (including information element id and length). Use
495 * of this WPA IE is optional. If the driver generates the WPA
496 * IE, it can use pairwise_suite, group_suite, and
497 * key_mgmt_suite to select proper algorithms. In this case,
498 * the driver has to notify wpa_supplicant about the used WPA
499 * IE by generating an event that the interface code will
500 * convert into EVENT_ASSOCINFO data (see below).
502 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
503 * instead. The driver can determine which version is used by
504 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
507 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
512 * wpa_ie_len - length of the wpa_ie
517 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
519 unsigned int wpa_proto;
522 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
524 * This is usually ignored if @wpa_ie is used.
526 unsigned int pairwise_suite;
529 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
531 * This is usually ignored if @wpa_ie is used.
533 unsigned int group_suite;
536 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
538 * This is usually ignored if @wpa_ie is used.
540 unsigned int key_mgmt_suite;
543 * auth_alg - Allowed authentication algorithms
544 * Bit field of WPA_AUTH_ALG_*
549 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
554 * wep_key - WEP keys for static WEP configuration
556 const u8 *wep_key[4];
559 * wep_key_len - WEP key length for static WEP configuration
561 size_t wep_key_len[4];
564 * wep_tx_keyidx - WEP TX key index for static WEP configuration
569 * mgmt_frame_protection - IEEE 802.11w management frame protection
571 enum mfp_options mgmt_frame_protection;
574 * ft_ies - IEEE 802.11r / FT information elements
575 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
576 * for fast transition, this parameter is set to include the IEs that
577 * are to be sent in the next FT Authentication Request message.
578 * update_ft_ies() handler is called to update the IEs for further
579 * FT messages in the sequence.
581 * The driver should use these IEs only if the target AP is advertising
582 * the same mobility domain as the one included in the MDIE here.
584 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
585 * AP after the initial association. These IEs can only be used if the
586 * target AP is advertising support for FT and is using the same MDIE
587 * and SSID as the current AP.
589 * The driver is responsible for reporting the FT IEs received from the
590 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
591 * type. update_ft_ies() handler will then be called with the FT IEs to
592 * include in the next frame in the authentication sequence.
597 * ft_ies_len - Length of ft_ies in bytes
602 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
604 * This value is provided to allow the driver interface easier access
605 * to the current mobility domain. This value is set to %NULL if no
606 * mobility domain is currently active.
611 * passphrase - RSN passphrase for PSK
613 * This value is made available only for WPA/WPA2-Personal (PSK) and
614 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
615 * the 8..63 character ASCII passphrase, if available. Please note that
616 * this can be %NULL if passphrase was not used to generate the PSK. In
617 * that case, the psk field must be used to fetch the PSK.
619 const char *passphrase;
622 * psk - RSN PSK (alternative for passphrase for PSK)
624 * This value is made available only for WPA/WPA2-Personal (PSK) and
625 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
626 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
627 * be prepared to handle %NULL value as an error.
632 * drop_unencrypted - Enable/disable unencrypted frame filtering
634 * Configure the driver to drop all non-EAPOL frames (both receive and
635 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
636 * still be allowed for key negotiation.
638 int drop_unencrypted;
641 * prev_bssid - Previously used BSSID in this ESS
643 * When not %NULL, this is a request to use reassociation instead of
646 const u8 *prev_bssid;
651 * If the driver needs to do special configuration for WPS association,
652 * this variable provides more information on what type of association
653 * is being requested. Most drivers should not need ot use this.
658 * p2p - Whether this connection is a P2P group
663 * uapsd - UAPSD parameters for the network
664 * -1 = do not change defaults
665 * AP mode: 1 = enabled, 0 = disabled
666 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
671 * fixed_bssid - Whether to force this BSSID in IBSS mode
672 * 1 = Fix this BSSID and prevent merges.
673 * 0 = Do not fix BSSID.
678 * disable_ht - Disable HT (IEEE 802.11n) for this connection
683 * HT Capabilities over-rides. Only bits set in the mask will be used,
684 * and not all values are used by the kernel anyway. Currently, MCS,
685 * MPDU and MSDU fields are used.
687 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */
688 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */
690 #ifdef CONFIG_VHT_OVERRIDES
692 * disable_vht - Disable VHT for this connection
697 * VHT capability overrides.
699 const struct ieee80211_vht_capabilities *vhtcaps;
700 const struct ieee80211_vht_capabilities *vhtcaps_mask;
701 #endif /* CONFIG_VHT_OVERRIDES */
704 * req_key_mgmt_offload - Request key management offload for connection
706 * Request key management offload for this connection if the device
709 int req_key_mgmt_offload;
714 HIDDEN_SSID_ZERO_LEN,
715 HIDDEN_SSID_ZERO_CONTENTS
718 struct wowlan_triggers {
722 u8 gtk_rekey_failure;
724 u8 four_way_handshake;
728 struct wpa_driver_ap_params {
730 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
735 * head_len - Length of the head buffer in octets
740 * tail - Beacon tail following TIM IE
745 * tail_len - Length of the tail buffer in octets
750 * dtim_period - DTIM period
755 * beacon_int - Beacon interval
760 * basic_rates: -1 terminated array of basic rates in 100 kbps
762 * This parameter can be used to set a specific basic rate set for the
763 * BSS. If %NULL, default basic rate set is used.
768 * proberesp - Probe Response template
770 * This is used by drivers that reply to Probe Requests internally in
771 * AP mode and require the full Probe Response template.
776 * proberesp_len - Length of the proberesp buffer in octets
778 size_t proberesp_len;
781 * ssid - The SSID to use in Beacon/Probe Response frames
786 * ssid_len - Length of the SSID (1..32)
791 * hide_ssid - Whether to hide the SSID
793 enum hide_ssid hide_ssid;
796 * pairwise_ciphers - WPA_CIPHER_* bitfield
798 unsigned int pairwise_ciphers;
801 * group_cipher - WPA_CIPHER_*
803 unsigned int group_cipher;
806 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
808 unsigned int key_mgmt_suites;
811 * auth_algs - WPA_AUTH_ALG_* bitfield
813 unsigned int auth_algs;
816 * wpa_version - WPA_PROTO_* bitfield
818 unsigned int wpa_version;
821 * privacy - Whether privacy is used in the BSS
826 * beacon_ies - WPS/P2P IE(s) for Beacon frames
828 * This is used to add IEs like WPS IE and P2P IE by drivers that do
829 * not use the full Beacon template.
831 const struct wpabuf *beacon_ies;
834 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
836 * This is used to add IEs like WPS IE and P2P IE by drivers that
837 * reply to Probe Request frames internally.
839 const struct wpabuf *proberesp_ies;
842 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
844 * This is used to add IEs like WPS IE by drivers that reply to
845 * (Re)Association Request frames internally.
847 const struct wpabuf *assocresp_ies;
850 * isolate - Whether to isolate frames between associated stations
852 * If this is non-zero, the AP is requested to disable forwarding of
853 * frames between associated stations.
858 * cts_protect - Whether CTS protection is enabled
863 * preamble - Whether short preamble is enabled
868 * short_slot_time - Whether short slot time is enabled
870 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
871 * not set (e.g., when 802.11g mode is not in use)
876 * ht_opmode - HT operation mode or -1 if HT not in use
881 * interworking - Whether Interworking is enabled
886 * hessid - Homogeneous ESS identifier or %NULL if not set
891 * access_network_type - Access Network Type (0..15)
893 * This is used for filtering Probe Request frames when Interworking is
896 u8 access_network_type;
899 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
901 * This is used by driver which advertises this capability.
903 int ap_max_inactivity;
906 * disable_dgaf - Whether group-addressed frames are disabled
911 * osen - Whether OSEN security is enabled
916 * freq - Channel parameters for dynamic bandwidth changes
918 struct hostapd_freq_params *freq;
921 struct wpa_driver_mesh_bss_params {
922 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
924 * TODO: Other mesh configuration parameters would go here.
925 * See NL80211_MESHCONF_* for all the mesh config parameters.
930 struct wpa_driver_mesh_join_params {
933 const int *basic_rates;
937 struct wpa_driver_mesh_bss_params conf;
938 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
939 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
940 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
941 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
946 * struct wpa_driver_capa - Driver capability information
948 struct wpa_driver_capa {
949 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
950 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
951 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
952 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
953 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
954 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
955 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
956 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
957 unsigned int key_mgmt;
959 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
960 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
961 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
962 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
963 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
964 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
965 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
966 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
967 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
968 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
969 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
970 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
971 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
974 #define WPA_DRIVER_AUTH_OPEN 0x00000001
975 #define WPA_DRIVER_AUTH_SHARED 0x00000002
976 #define WPA_DRIVER_AUTH_LEAP 0x00000004
979 /* Driver generated WPA/RSN IE */
980 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
981 /* Driver needs static WEP key setup after association command */
982 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
983 /* Driver takes care of all DFS operations */
984 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
985 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
986 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
987 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
988 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
989 /* Driver provides separate commands for authentication and association (SME in
990 * wpa_supplicant). */
991 #define WPA_DRIVER_FLAGS_SME 0x00000020
992 /* Driver supports AP mode */
993 #define WPA_DRIVER_FLAGS_AP 0x00000040
994 /* Driver needs static WEP key setup after association has been completed */
995 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
996 /* Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
997 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
998 /* Driver supports concurrent P2P operations */
999 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1001 * Driver uses the initial interface as a dedicated management interface, i.e.,
1002 * it cannot be used for P2P group operations or non-P2P purposes.
1004 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1005 /* This interface is P2P capable (P2P GO or P2P Client) */
1006 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1007 /* Driver supports station and key removal when stopping an AP */
1008 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1010 * Driver uses the initial interface for P2P management interface and non-P2P
1011 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1012 * P2P group operations.
1014 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1016 * Driver is known to use sane error codes, i.e., when it indicates that
1017 * something (e.g., association) fails, there was indeed a failure and the
1018 * operation does not end up getting completed successfully later.
1020 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1021 /* Driver supports off-channel TX */
1022 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1023 /* Driver indicates TX status events for EAPOL Data frames */
1024 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1025 /* Driver indicates TX status events for Deauth/Disassoc frames */
1026 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1027 /* Driver supports roaming (BSS selection) in firmware */
1028 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1029 /* Driver supports operating as a TDLS peer */
1030 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1031 /* Driver requires external TDLS setup/teardown/discovery */
1032 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1033 /* Driver indicates support for Probe Response offloading in AP mode */
1034 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1035 /* Driver supports U-APSD in AP mode */
1036 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1037 /* Driver supports inactivity timer in AP mode */
1038 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1039 /* Driver expects user space implementation of MLME in AP mode */
1040 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1041 /* Driver supports SAE with user space SME */
1042 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1043 /* Driver makes use of OBSS scan mechanism in wpa_supplicant */
1044 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1045 /* Driver supports IBSS (Ad-hoc) mode */
1046 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1047 /* Driver supports radar detection */
1048 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1049 /* Driver supports a dedicated interface for P2P Device */
1050 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1051 /* Driver supports QoS Mapping */
1052 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1053 /* Driver supports CSA in AP mode */
1054 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1055 /* Driver supports mesh */
1056 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1060 int max_sched_scan_ssids;
1061 int sched_scan_supported;
1065 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1067 unsigned int max_remain_on_chan;
1070 * max_stations - Maximum number of associated stations the driver
1071 * supports in AP mode
1073 unsigned int max_stations;
1076 * probe_resp_offloads - Bitmap of supported protocols by the driver
1077 * for Probe Response offloading.
1079 /* Driver Probe Response offloading support for WPS ver. 1 */
1080 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1081 /* Driver Probe Response offloading support for WPS ver. 2 */
1082 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1083 /* Driver Probe Response offloading support for P2P */
1084 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1085 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1086 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1087 unsigned int probe_resp_offloads;
1089 unsigned int max_acl_mac_addrs;
1092 * Number of supported concurrent channels
1094 unsigned int num_multichan_concurrent;
1097 * extended_capa - extended capabilities in driver/device
1099 * Must be allocated and freed by driver and the pointers must be
1100 * valid for the lifetime of the driver, i.e., freed in deinit()
1102 const u8 *extended_capa, *extended_capa_mask;
1103 unsigned int extended_capa_len;
1105 struct wowlan_triggers wowlan_triggers;
1109 struct hostapd_data;
1111 struct hostap_sta_driver_data {
1112 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1113 unsigned long current_tx_rate;
1114 unsigned long inactive_msec;
1115 unsigned long flags;
1116 unsigned long num_ps_buf_frames;
1117 unsigned long tx_retry_failed;
1118 unsigned long tx_retry_count;
1123 struct hostapd_sta_add_params {
1127 const u8 *supp_rates;
1128 size_t supp_rates_len;
1129 u16 listen_interval;
1130 const struct ieee80211_ht_capabilities *ht_capabilities;
1131 const struct ieee80211_vht_capabilities *vht_capabilities;
1132 int vht_opmode_enabled;
1134 u32 flags; /* bitmask of WPA_STA_* flags */
1135 u32 flags_mask; /* unset bits in flags */
1136 int set; /* Set STA parameters instead of add */
1138 const u8 *ext_capab;
1139 size_t ext_capab_len;
1140 const u8 *supp_channels;
1141 size_t supp_channels_len;
1142 const u8 *supp_oper_classes;
1143 size_t supp_oper_classes_len;
1146 struct mac_address {
1150 struct hostapd_acl_params {
1152 unsigned int num_mac_acl;
1153 struct mac_address mac_acl[0];
1156 enum wpa_driver_if_type {
1158 * WPA_IF_STATION - Station mode interface
1163 * WPA_IF_AP_VLAN - AP mode VLAN interface
1165 * This interface shares its address and Beacon frame with the main
1171 * WPA_IF_AP_BSS - AP mode BSS interface
1173 * This interface has its own address and Beacon frame.
1178 * WPA_IF_P2P_GO - P2P Group Owner
1183 * WPA_IF_P2P_CLIENT - P2P Client
1188 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1189 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1194 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1195 * abstracted P2P Device function in the driver
1200 struct wpa_init_params {
1206 const char *test_socket;
1207 int use_pae_group_addr;
1211 u8 *own_addr; /* buffer for writing own MAC address */
1215 struct wpa_bss_params {
1216 /** Interface name (for multi-SSID/VLAN support) */
1218 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1227 enum mfp_options ieee80211w;
1230 #define WPA_STA_AUTHORIZED BIT(0)
1231 #define WPA_STA_WMM BIT(1)
1232 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1233 #define WPA_STA_MFP BIT(3)
1234 #define WPA_STA_TDLS_PEER BIT(4)
1247 WNM_SLEEP_ENTER_CONFIRM,
1248 WNM_SLEEP_ENTER_FAIL,
1249 WNM_SLEEP_EXIT_CONFIRM,
1250 WNM_SLEEP_EXIT_FAIL,
1251 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1252 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1253 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1255 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1257 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1258 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1260 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1263 /* enum chan_width - Channel width definitions */
1275 * struct wpa_signal_info - Information about channel signal quality
1277 struct wpa_signal_info {
1279 int above_threshold;
1284 enum chan_width chanwidth;
1290 * struct beacon_data - Beacon data
1291 * @head: Head portion of Beacon frame (before TIM IE)
1292 * @tail: Tail portion of Beacon frame (after TIM IE)
1293 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1294 * @proberesp_ies: Extra information element(s) to add into Probe Response
1296 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1297 * Response frames or %NULL
1298 * @probe_resp: Probe Response frame template
1299 * @head_len: Length of @head
1300 * @tail_len: Length of @tail
1301 * @beacon_ies_len: Length of beacon_ies in octets
1302 * @proberesp_ies_len: Length of proberesp_ies in octets
1303 * @proberesp_ies_len: Length of proberesp_ies in octets
1304 * @probe_resp_len: Length of probe response template (@probe_resp)
1306 struct beacon_data {
1313 size_t head_len, tail_len;
1314 size_t beacon_ies_len;
1315 size_t proberesp_ies_len;
1316 size_t assocresp_ies_len;
1317 size_t probe_resp_len;
1321 * struct csa_settings - Settings for channel switch command
1322 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1323 * @block_tx: 1 - block transmission for CSA period
1324 * @freq_params: Next channel frequency parameter
1325 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1326 * @beacon_after: Next beacon/probe resp/asooc resp info
1327 * @counter_offset_beacon: Offset to the count field in beacon's tail
1328 * @counter_offset_presp: Offset to the count field in probe resp.
1330 struct csa_settings {
1334 struct hostapd_freq_params freq_params;
1335 struct beacon_data beacon_csa;
1336 struct beacon_data beacon_after;
1338 u16 counter_offset_beacon;
1339 u16 counter_offset_presp;
1342 /* TDLS peer capabilities for send_tdls_mgmt() */
1343 enum tdls_peer_capability {
1344 TDLS_PEER_HT = BIT(0),
1345 TDLS_PEER_VHT = BIT(1),
1346 TDLS_PEER_WMM = BIT(2),
1349 #ifdef CONFIG_MACSEC
1350 struct macsec_init_params {
1351 Boolean always_include_sci;
1355 #endif /* CONFIG_MACSEC */
1359 * struct wpa_driver_ops - Driver interface API definition
1361 * This structure defines the API that each driver interface needs to implement
1362 * for core wpa_supplicant code. All driver specific functionality is captured
1365 struct wpa_driver_ops {
1366 /** Name of the driver interface */
1368 /** One line description of the driver interface */
1372 * get_bssid - Get the current BSSID
1373 * @priv: private driver interface data
1374 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1376 * Returns: 0 on success, -1 on failure
1378 * Query kernel driver for the current BSSID and copy it to bssid.
1379 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1382 int (*get_bssid)(void *priv, u8 *bssid);
1385 * get_ssid - Get the current SSID
1386 * @priv: private driver interface data
1387 * @ssid: buffer for SSID (at least 32 bytes)
1389 * Returns: Length of the SSID on success, -1 on failure
1391 * Query kernel driver for the current SSID and copy it to ssid.
1392 * Returning zero is recommended if the STA is not associated.
1394 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1395 * can, at least in theory, contain control characters (including nul)
1396 * and as such, should be processed as binary data, not a printable
1399 int (*get_ssid)(void *priv, u8 *ssid);
1402 * set_key - Configure encryption key
1403 * @ifname: Interface name (for multi-SSID/VLAN support)
1404 * @priv: private driver interface data
1405 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1406 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1407 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1408 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1409 * %WPA_ALG_BIP_CMAC_256);
1410 * %WPA_ALG_NONE clears the key.
1411 * @addr: Address of the peer STA (BSSID of the current AP when setting
1412 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1413 * broadcast keys, %NULL for default keys that are used both for
1414 * broadcast and unicast; when clearing keys, %NULL is used to
1415 * indicate that both the broadcast-only and default key of the
1416 * specified key index is to be cleared
1417 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1419 * @set_tx: configure this key as the default Tx key (only used when
1420 * driver does not support separate unicast/individual key
1421 * @seq: sequence number/packet number, seq_len octets, the next
1422 * packet number to be used for in replay protection; configured
1423 * for Rx keys (in most cases, this is only used with broadcast
1424 * keys and set to zero for unicast keys); %NULL if not set
1425 * @seq_len: length of the seq, depends on the algorithm:
1426 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1427 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1429 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1430 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1432 * Returns: 0 on success, -1 on failure
1434 * Configure the given key for the kernel driver. If the driver
1435 * supports separate individual keys (4 default keys + 1 individual),
1436 * addr can be used to determine whether the key is default or
1437 * individual. If only 4 keys are supported, the default key with key
1438 * index 0 is used as the individual key. STA must be configured to use
1439 * it as the default Tx key (set_tx is set) and accept Rx for all the
1440 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1441 * broadcast keys, so key index 0 is available for this kind of
1444 * Please note that TKIP keys include separate TX and RX MIC keys and
1445 * some drivers may expect them in different order than wpa_supplicant
1446 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1447 * will trigger Michael MIC errors. This can be fixed by changing the
1448 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1449 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1450 * example on how this can be done.
1452 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1453 const u8 *addr, int key_idx, int set_tx,
1454 const u8 *seq, size_t seq_len,
1455 const u8 *key, size_t key_len);
1458 * init - Initialize driver interface
1459 * @ctx: context to be used when calling wpa_supplicant functions,
1460 * e.g., wpa_supplicant_event()
1461 * @ifname: interface name, e.g., wlan0
1463 * Returns: Pointer to private data, %NULL on failure
1465 * Initialize driver interface, including event processing for kernel
1466 * driver events (e.g., associated, scan results, Michael MIC failure).
1467 * This function can allocate a private configuration data area for
1468 * @ctx, file descriptor, interface name, etc. information that may be
1469 * needed in future driver operations. If this is not used, non-NULL
1470 * value will need to be returned because %NULL is used to indicate
1471 * failure. The returned value will be used as 'void *priv' data for
1472 * all other driver_ops functions.
1474 * The main event loop (eloop.c) of wpa_supplicant can be used to
1475 * register callback for read sockets (eloop_register_read_sock()).
1477 * See below for more information about events and
1478 * wpa_supplicant_event() function.
1480 void * (*init)(void *ctx, const char *ifname);
1483 * deinit - Deinitialize driver interface
1484 * @priv: private driver interface data from init()
1486 * Shut down driver interface and processing of driver events. Free
1487 * private data buffer if one was allocated in init() handler.
1489 void (*deinit)(void *priv);
1492 * set_param - Set driver configuration parameters
1493 * @priv: private driver interface data from init()
1494 * @param: driver specific configuration parameters
1496 * Returns: 0 on success, -1 on failure
1498 * Optional handler for notifying driver interface about configuration
1499 * parameters (driver_param).
1501 int (*set_param)(void *priv, const char *param);
1504 * set_countermeasures - Enable/disable TKIP countermeasures
1505 * @priv: private driver interface data
1506 * @enabled: 1 = countermeasures enabled, 0 = disabled
1508 * Returns: 0 on success, -1 on failure
1510 * Configure TKIP countermeasures. When these are enabled, the driver
1511 * should drop all received and queued frames that are using TKIP.
1513 int (*set_countermeasures)(void *priv, int enabled);
1516 * deauthenticate - Request driver to deauthenticate
1517 * @priv: private driver interface data
1518 * @addr: peer address (BSSID of the AP)
1519 * @reason_code: 16-bit reason code to be sent in the deauthentication
1522 * Returns: 0 on success, -1 on failure
1524 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1527 * associate - Request driver to associate
1528 * @priv: private driver interface data
1529 * @params: association parameters
1531 * Returns: 0 on success, -1 on failure
1533 int (*associate)(void *priv,
1534 struct wpa_driver_associate_params *params);
1537 * add_pmkid - Add PMKSA cache entry to the driver
1538 * @priv: private driver interface data
1539 * @bssid: BSSID for the PMKSA cache entry
1540 * @pmkid: PMKID for the PMKSA cache entry
1542 * Returns: 0 on success, -1 on failure
1544 * This function is called when a new PMK is received, as a result of
1545 * either normal authentication or RSN pre-authentication.
1547 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1548 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1549 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1550 * driver_ops function does not need to be implemented. Likewise, if
1551 * the driver does not support WPA, this function is not needed.
1553 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1556 * remove_pmkid - Remove PMKSA cache entry to the driver
1557 * @priv: private driver interface data
1558 * @bssid: BSSID for the PMKSA cache entry
1559 * @pmkid: PMKID for the PMKSA cache entry
1561 * Returns: 0 on success, -1 on failure
1563 * This function is called when the supplicant drops a PMKSA cache
1564 * entry for any reason.
1566 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1567 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1568 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1569 * from wpa_supplicant, this driver_ops function does not need to be
1570 * implemented. Likewise, if the driver does not support WPA, this
1571 * function is not needed.
1573 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1576 * flush_pmkid - Flush PMKSA cache
1577 * @priv: private driver interface data
1579 * Returns: 0 on success, -1 on failure
1581 * This function is called when the supplicant drops all PMKSA cache
1582 * entries for any reason.
1584 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1585 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1586 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1587 * from wpa_supplicant, this driver_ops function does not need to be
1588 * implemented. Likewise, if the driver does not support WPA, this
1589 * function is not needed.
1591 int (*flush_pmkid)(void *priv);
1594 * get_capa - Get driver capabilities
1595 * @priv: private driver interface data
1597 * Returns: 0 on success, -1 on failure
1599 * Get driver/firmware/hardware capabilities.
1601 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1604 * poll - Poll driver for association information
1605 * @priv: private driver interface data
1607 * This is an option callback that can be used when the driver does not
1608 * provide event mechanism for association events. This is called when
1609 * receiving WPA EAPOL-Key messages that require association
1610 * information. The driver interface is supposed to generate associnfo
1611 * event before returning from this callback function. In addition, the
1612 * driver interface should generate an association event after having
1613 * sent out associnfo.
1615 void (*poll)(void *priv);
1618 * get_ifname - Get interface name
1619 * @priv: private driver interface data
1621 * Returns: Pointer to the interface name. This can differ from the
1622 * interface name used in init() call. Init() is called first.
1624 * This optional function can be used to allow the driver interface to
1625 * replace the interface name with something else, e.g., based on an
1626 * interface mapping from a more descriptive name.
1628 const char * (*get_ifname)(void *priv);
1631 * get_mac_addr - Get own MAC address
1632 * @priv: private driver interface data
1634 * Returns: Pointer to own MAC address or %NULL on failure
1636 * This optional function can be used to get the own MAC address of the
1637 * device from the driver interface code. This is only needed if the
1638 * l2_packet implementation for the OS does not provide easy access to
1640 const u8 * (*get_mac_addr)(void *priv);
1643 * send_eapol - Optional function for sending EAPOL packets
1644 * @priv: private driver interface data
1645 * @dest: Destination MAC address
1647 * @data: EAPOL packet starting with IEEE 802.1X header
1648 * @data_len: Size of the EAPOL packet
1650 * Returns: 0 on success, -1 on failure
1652 * This optional function can be used to override l2_packet operations
1653 * with driver specific functionality. If this function pointer is set,
1654 * l2_packet module is not used at all and the driver interface code is
1655 * responsible for receiving and sending all EAPOL packets. The
1656 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1657 * event. The driver interface is required to implement get_mac_addr()
1658 * handler if send_eapol() is used.
1660 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1661 const u8 *data, size_t data_len);
1664 * set_operstate - Sets device operating state to DORMANT or UP
1665 * @priv: private driver interface data
1666 * @state: 0 = dormant, 1 = up
1667 * Returns: 0 on success, -1 on failure
1669 * This is an optional function that can be used on operating systems
1670 * that support a concept of controlling network device state from user
1671 * space applications. This function, if set, gets called with
1672 * state = 1 when authentication has been completed and with state = 0
1673 * when connection is lost.
1675 int (*set_operstate)(void *priv, int state);
1678 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1679 * @priv: Private driver interface data
1680 * @addr: Address of the station for which to set protection (may be
1681 * %NULL for group keys)
1682 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1683 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1684 * Returns: 0 on success, -1 on failure
1686 * This is an optional function that can be used to set the driver to
1687 * require protection for Tx and/or Rx frames. This uses the layer
1688 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1689 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1690 * set protection operation; instead, they set protection implicitly
1691 * based on configured keys.
1693 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1697 * get_hw_feature_data - Get hardware support data (channels and rates)
1698 * @priv: Private driver interface data
1699 * @num_modes: Variable for returning the number of returned modes
1700 * flags: Variable for returning hardware feature flags
1701 * Returns: Pointer to allocated hardware data on success or %NULL on
1702 * failure. Caller is responsible for freeing this.
1704 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1709 * send_mlme - Send management frame from MLME
1710 * @priv: Private driver interface data
1711 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1712 * @data_len: Size of the management frame
1713 * @noack: Do not wait for this frame to be acked (disable retries)
1714 * Returns: 0 on success, -1 on failure
1716 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1720 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1721 * @priv: Private driver interface data
1722 * @md: Mobility domain (2 octets) (also included inside ies)
1723 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1724 * @ies_len: Length of FT IEs in bytes
1725 * Returns: 0 on success, -1 on failure
1727 * The supplicant uses this callback to let the driver know that keying
1728 * material for FT is available and that the driver can use the
1729 * provided IEs in the next message in FT authentication sequence.
1731 * This function is only needed for driver that support IEEE 802.11r
1732 * (Fast BSS Transition).
1734 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1738 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1739 * @priv: Private driver interface data
1740 * @action: Action field value
1741 * @target_ap: Target AP address
1742 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1743 * @ies_len: Length of FT IEs in bytes
1744 * Returns: 0 on success, -1 on failure
1746 * The supplicant uses this callback to request the driver to transmit
1747 * an FT Action frame (action category 6) for over-the-DS fast BSS
1750 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1751 const u8 *ies, size_t ies_len);
1754 * get_scan_results2 - Fetch the latest scan results
1755 * @priv: private driver interface data
1757 * Returns: Allocated buffer of scan results (caller is responsible for
1758 * freeing the data structure) on success, NULL on failure
1760 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1763 * set_country - Set country
1764 * @priv: Private driver interface data
1765 * @alpha2: country to which to switch to
1766 * Returns: 0 on success, -1 on failure
1768 * This function is for drivers which support some form
1769 * of setting a regulatory domain.
1771 int (*set_country)(void *priv, const char *alpha2);
1774 * get_country - Get country
1775 * @priv: Private driver interface data
1776 * @alpha2: Buffer for returning country code (at least 3 octets)
1777 * Returns: 0 on success, -1 on failure
1779 int (*get_country)(void *priv, char *alpha2);
1782 * global_init - Global driver initialization
1783 * Returns: Pointer to private data (global), %NULL on failure
1785 * This optional function is called to initialize the driver wrapper
1786 * for global data, i.e., data that applies to all interfaces. If this
1787 * function is implemented, global_deinit() will also need to be
1788 * implemented to free the private data. The driver will also likely
1789 * use init2() function instead of init() to get the pointer to global
1790 * data available to per-interface initializer.
1792 void * (*global_init)(void);
1795 * global_deinit - Global driver deinitialization
1796 * @priv: private driver global data from global_init()
1798 * Terminate any global driver related functionality and free the
1799 * global data structure.
1801 void (*global_deinit)(void *priv);
1804 * init2 - Initialize driver interface (with global data)
1805 * @ctx: context to be used when calling wpa_supplicant functions,
1806 * e.g., wpa_supplicant_event()
1807 * @ifname: interface name, e.g., wlan0
1808 * @global_priv: private driver global data from global_init()
1809 * Returns: Pointer to private data, %NULL on failure
1811 * This function can be used instead of init() if the driver wrapper
1814 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1817 * get_interfaces - Get information about available interfaces
1818 * @global_priv: private driver global data from global_init()
1819 * Returns: Allocated buffer of interface information (caller is
1820 * responsible for freeing the data structure) on success, NULL on
1823 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1826 * scan2 - Request the driver to initiate scan
1827 * @priv: private driver interface data
1828 * @params: Scan parameters
1830 * Returns: 0 on success, -1 on failure
1832 * Once the scan results are ready, the driver should report scan
1833 * results event for wpa_supplicant which will eventually request the
1834 * results with wpa_driver_get_scan_results2().
1836 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1839 * authenticate - Request driver to authenticate
1840 * @priv: private driver interface data
1841 * @params: authentication parameters
1842 * Returns: 0 on success, -1 on failure
1844 * This is an optional function that can be used with drivers that
1845 * support separate authentication and association steps, i.e., when
1846 * wpa_supplicant can act as the SME. If not implemented, associate()
1847 * function is expected to take care of IEEE 802.11 authentication,
1850 int (*authenticate)(void *priv,
1851 struct wpa_driver_auth_params *params);
1854 * set_ap - Set Beacon and Probe Response information for AP mode
1855 * @priv: Private driver interface data
1856 * @params: Parameters to use in AP mode
1858 * This function is used to configure Beacon template and/or extra IEs
1859 * to add for Beacon and Probe Response frames for the driver in
1860 * AP mode. The driver is responsible for building the full Beacon
1861 * frame by concatenating the head part with TIM IE generated by the
1862 * driver/firmware and finishing with the tail part. Depending on the
1863 * driver architectue, this can be done either by using the full
1864 * template or the set of additional IEs (e.g., WPS and P2P IE).
1865 * Similarly, Probe Response processing depends on the driver design.
1866 * If the driver (or firmware) takes care of replying to Probe Request
1867 * frames, the extra IEs provided here needs to be added to the Probe
1870 * Returns: 0 on success, -1 on failure
1872 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1875 * set_acl - Set ACL in AP mode
1876 * @priv: Private driver interface data
1877 * @params: Parameters to configure ACL
1878 * Returns: 0 on success, -1 on failure
1880 * This is used only for the drivers which support MAC address ACL.
1882 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1885 * hapd_init - Initialize driver interface (hostapd only)
1886 * @hapd: Pointer to hostapd context
1887 * @params: Configuration for the driver wrapper
1888 * Returns: Pointer to private data, %NULL on failure
1890 * This function is used instead of init() or init2() when the driver
1891 * wrapper is used with hostapd.
1893 void * (*hapd_init)(struct hostapd_data *hapd,
1894 struct wpa_init_params *params);
1897 * hapd_deinit - Deinitialize driver interface (hostapd only)
1898 * @priv: Private driver interface data from hapd_init()
1900 void (*hapd_deinit)(void *priv);
1903 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1904 * @priv: Private driver interface data
1905 * @params: BSS parameters
1906 * Returns: 0 on success, -1 on failure
1908 * This is an optional function to configure the kernel driver to
1909 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1910 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1911 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1912 * for Beacon frames.
1914 * DEPRECATED - use set_ap() instead
1916 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1919 * set_privacy - Enable/disable privacy (AP only)
1920 * @priv: Private driver interface data
1921 * @enabled: 1 = privacy enabled, 0 = disabled
1922 * Returns: 0 on success, -1 on failure
1924 * This is an optional function to configure privacy field in the
1925 * kernel driver for Beacon frames. This can be left undefined (set to
1926 * %NULL) if the driver uses the Beacon template from set_ap().
1928 * DEPRECATED - use set_ap() instead
1930 int (*set_privacy)(void *priv, int enabled);
1933 * get_seqnum - Fetch the current TSC/packet number (AP only)
1934 * @ifname: The interface name (main or virtual)
1935 * @priv: Private driver interface data
1936 * @addr: MAC address of the station or %NULL for group keys
1938 * @seq: Buffer for returning the latest used TSC/packet number
1939 * Returns: 0 on success, -1 on failure
1941 * This function is used to fetch the last used TSC/packet number for
1942 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1943 * keys, so there is no strict requirement on implementing support for
1944 * unicast keys (i.e., addr != %NULL).
1946 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1950 * flush - Flush all association stations (AP only)
1951 * @priv: Private driver interface data
1952 * Returns: 0 on success, -1 on failure
1954 * This function requests the driver to disassociate all associated
1955 * stations. This function does not need to be implemented if the
1956 * driver does not process association frames internally.
1958 int (*flush)(void *priv);
1961 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1962 * @priv: Private driver interface data
1963 * @elem: Information elements
1964 * @elem_len: Length of the elem buffer in octets
1965 * Returns: 0 on success, -1 on failure
1967 * This is an optional function to add information elements in the
1968 * kernel driver for Beacon and Probe Response frames. This can be left
1969 * undefined (set to %NULL) if the driver uses the Beacon template from
1972 * DEPRECATED - use set_ap() instead
1974 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1977 * read_sta_data - Fetch station data
1978 * @priv: Private driver interface data
1979 * @data: Buffer for returning station information
1980 * @addr: MAC address of the station
1981 * Returns: 0 on success, -1 on failure
1983 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1987 * hapd_send_eapol - Send an EAPOL packet (AP only)
1988 * @priv: private driver interface data
1989 * @addr: Destination MAC address
1990 * @data: EAPOL packet starting with IEEE 802.1X header
1991 * @data_len: Length of the EAPOL packet in octets
1992 * @encrypt: Whether the frame should be encrypted
1993 * @own_addr: Source MAC address
1994 * @flags: WPA_STA_* flags for the destination station
1996 * Returns: 0 on success, -1 on failure
1998 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1999 size_t data_len, int encrypt,
2000 const u8 *own_addr, u32 flags);
2003 * sta_deauth - Deauthenticate a station (AP only)
2004 * @priv: Private driver interface data
2005 * @own_addr: Source address and BSSID for the Deauthentication frame
2006 * @addr: MAC address of the station to deauthenticate
2007 * @reason: Reason code for the Deauthentiation frame
2008 * Returns: 0 on success, -1 on failure
2010 * This function requests a specific station to be deauthenticated and
2011 * a Deauthentication frame to be sent to it.
2013 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2017 * sta_disassoc - Disassociate a station (AP only)
2018 * @priv: Private driver interface data
2019 * @own_addr: Source address and BSSID for the Disassociation frame
2020 * @addr: MAC address of the station to disassociate
2021 * @reason: Reason code for the Disassociation frame
2022 * Returns: 0 on success, -1 on failure
2024 * This function requests a specific station to be disassociated and
2025 * a Disassociation frame to be sent to it.
2027 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2031 * sta_remove - Remove a station entry (AP only)
2032 * @priv: Private driver interface data
2033 * @addr: MAC address of the station to be removed
2034 * Returns: 0 on success, -1 on failure
2036 int (*sta_remove)(void *priv, const u8 *addr);
2039 * hapd_get_ssid - Get the current SSID (AP only)
2040 * @priv: Private driver interface data
2041 * @buf: Buffer for returning the SSID
2042 * @len: Maximum length of the buffer
2043 * Returns: Length of the SSID on success, -1 on failure
2045 * This function need not be implemented if the driver uses Beacon
2046 * template from set_ap() and does not reply to Probe Request frames.
2048 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2051 * hapd_set_ssid - Set SSID (AP only)
2052 * @priv: Private driver interface data
2054 * @len: Length of the SSID in octets
2055 * Returns: 0 on success, -1 on failure
2057 * DEPRECATED - use set_ap() instead
2059 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2062 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2063 * @priv: Private driver interface data
2064 * @enabled: 1 = countermeasures enabled, 0 = disabled
2065 * Returns: 0 on success, -1 on failure
2067 * This need not be implemented if the driver does not take care of
2068 * association processing.
2070 int (*hapd_set_countermeasures)(void *priv, int enabled);
2073 * sta_add - Add a station entry
2074 * @priv: Private driver interface data
2075 * @params: Station parameters
2076 * Returns: 0 on success, -1 on failure
2078 * This function is used to add a station entry to the driver once the
2079 * station has completed association. This is only used if the driver
2080 * does not take care of association processing.
2082 * With TDLS, this function is also used to add or set (params->set 1)
2083 * TDLS peer entries.
2085 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2088 * get_inact_sec - Get station inactivity duration (AP only)
2089 * @priv: Private driver interface data
2090 * @addr: Station address
2091 * Returns: Number of seconds station has been inactive, -1 on failure
2093 int (*get_inact_sec)(void *priv, const u8 *addr);
2096 * sta_clear_stats - Clear station statistics (AP only)
2097 * @priv: Private driver interface data
2098 * @addr: Station address
2099 * Returns: 0 on success, -1 on failure
2101 int (*sta_clear_stats)(void *priv, const u8 *addr);
2104 * set_freq - Set channel/frequency (AP only)
2105 * @priv: Private driver interface data
2106 * @freq: Channel parameters
2107 * Returns: 0 on success, -1 on failure
2109 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2112 * set_rts - Set RTS threshold
2113 * @priv: Private driver interface data
2114 * @rts: RTS threshold in octets
2115 * Returns: 0 on success, -1 on failure
2117 int (*set_rts)(void *priv, int rts);
2120 * set_frag - Set fragmentation threshold
2121 * @priv: Private driver interface data
2122 * @frag: Fragmentation threshold in octets
2123 * Returns: 0 on success, -1 on failure
2125 int (*set_frag)(void *priv, int frag);
2128 * sta_set_flags - Set station flags (AP only)
2129 * @priv: Private driver interface data
2130 * @addr: Station address
2131 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2132 * @flags_or: Bitmap of WPA_STA_* flags to add
2133 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2134 * Returns: 0 on success, -1 on failure
2136 int (*sta_set_flags)(void *priv, const u8 *addr,
2137 int total_flags, int flags_or, int flags_and);
2140 * set_tx_queue_params - Set TX queue parameters
2141 * @priv: Private driver interface data
2142 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2146 * @burst_time: Maximum length for bursting in 0.1 msec units
2148 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2149 int cw_max, int burst_time);
2152 * if_add - Add a virtual interface
2153 * @priv: Private driver interface data
2154 * @type: Interface type
2155 * @ifname: Interface name for the new virtual interface
2156 * @addr: Local address to use for the interface or %NULL to use the
2157 * parent interface address
2158 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2159 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2160 * not allowed (applies only to %WPA_IF_AP_BSS type)
2161 * @force_ifname: Buffer for returning an interface name that the
2162 * driver ended up using if it differs from the requested ifname
2163 * @if_addr: Buffer for returning the allocated interface address
2164 * (this may differ from the requested addr if the driver cannot
2165 * change interface address)
2166 * @bridge: Bridge interface to use or %NULL if no bridge configured
2167 * @use_existing: Whether to allow existing interface to be used
2168 * Returns: 0 on success, -1 on failure
2170 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2171 const char *ifname, const u8 *addr, void *bss_ctx,
2172 void **drv_priv, char *force_ifname, u8 *if_addr,
2173 const char *bridge, int use_existing);
2176 * if_remove - Remove a virtual interface
2177 * @priv: Private driver interface data
2178 * @type: Interface type
2179 * @ifname: Interface name of the virtual interface to be removed
2180 * Returns: 0 on success, -1 on failure
2182 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2183 const char *ifname);
2186 * set_sta_vlan - Bind a station into a specific interface (AP only)
2187 * @priv: Private driver interface data
2188 * @ifname: Interface (main or virtual BSS or VLAN)
2189 * @addr: MAC address of the associated station
2191 * Returns: 0 on success, -1 on failure
2193 * This function is used to bind a station to a specific virtual
2194 * interface. It is only used if when virtual interfaces are supported,
2195 * e.g., to assign stations to different VLAN interfaces based on
2196 * information from a RADIUS server. This allows separate broadcast
2197 * domains to be used with a single BSS.
2199 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2203 * commit - Optional commit changes handler (AP only)
2204 * @priv: driver private data
2205 * Returns: 0 on success, -1 on failure
2207 * This optional handler function can be registered if the driver
2208 * interface implementation needs to commit changes (e.g., by setting
2209 * network interface up) at the end of initial configuration. If set,
2210 * this handler will be called after initial setup has been completed.
2212 int (*commit)(void *priv);
2215 * send_ether - Send an ethernet packet (AP only)
2216 * @priv: private driver interface data
2217 * @dst: Destination MAC address
2218 * @src: Source MAC address
2220 * @data: EAPOL packet starting with IEEE 802.1X header
2221 * @data_len: Length of the EAPOL packet in octets
2222 * Returns: 0 on success, -1 on failure
2224 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2225 const u8 *data, size_t data_len);
2228 * set_radius_acl_auth - Notification of RADIUS ACL change
2229 * @priv: Private driver interface data
2230 * @mac: MAC address of the station
2231 * @accepted: Whether the station was accepted
2232 * @session_timeout: Session timeout for the station
2233 * Returns: 0 on success, -1 on failure
2235 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2236 u32 session_timeout);
2239 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2240 * @priv: Private driver interface data
2241 * @mac: MAC address of the station
2242 * Returns: 0 on success, -1 on failure
2244 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2247 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2248 * @priv: Private driver interface data
2249 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2250 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2252 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2253 * to remove extra IE(s)
2254 * Returns: 0 on success, -1 on failure
2256 * This is an optional function to add WPS IE in the kernel driver for
2257 * Beacon and Probe Response frames. This can be left undefined (set
2258 * to %NULL) if the driver uses the Beacon template from set_ap()
2259 * and does not process Probe Request frames. If the driver takes care
2260 * of (Re)Association frame processing, the assocresp buffer includes
2261 * WPS IE(s) that need to be added to (Re)Association Response frames
2262 * whenever a (Re)Association Request frame indicated use of WPS.
2264 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2265 * frames when operating as a GO. The driver is responsible for adding
2266 * timing related attributes (e.g., NoA) in addition to the IEs
2267 * included here by appending them after these buffers. This call is
2268 * also used to provide Probe Response IEs for P2P Listen state
2269 * operations for drivers that generate the Probe Response frames
2272 * DEPRECATED - use set_ap() instead
2274 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2275 const struct wpabuf *proberesp,
2276 const struct wpabuf *assocresp);
2279 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2280 * @priv: Private driver interface data
2281 * @authorized: Whether the port is authorized
2282 * Returns: 0 on success, -1 on failure
2284 int (*set_supp_port)(void *priv, int authorized);
2287 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2288 * @priv: Private driver interface data
2289 * @addr: MAC address of the associated station
2290 * @aid: Association ID
2291 * @val: 1 = bind to 4-address WDS; 0 = unbind
2292 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2293 * to indicate that bridge is not to be used
2294 * @ifname_wds: Buffer to return the interface name for the new WDS
2295 * station or %NULL to indicate name is not returned.
2296 * Returns: 0 on success, -1 on failure
2298 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2299 const char *bridge_ifname, char *ifname_wds);
2302 * send_action - Transmit an Action frame
2303 * @priv: Private driver interface data
2304 * @freq: Frequency (in MHz) of the channel
2305 * @wait: Time to wait off-channel for a response (in ms), or zero
2306 * @dst: Destination MAC address (Address 1)
2307 * @src: Source MAC address (Address 2)
2308 * @bssid: BSSID (Address 3)
2310 * @data_len: data length in octets
2311 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2312 * Returns: 0 on success, -1 on failure
2314 * This command can be used to request the driver to transmit an action
2315 * frame to the specified destination.
2317 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2318 * be transmitted on the given channel and the device will wait for a
2319 * response on that channel for the given wait time.
2321 * If the flag is not set, the wait time will be ignored. In this case,
2322 * if a remain-on-channel duration is in progress, the frame must be
2323 * transmitted on that channel; alternatively the frame may be sent on
2324 * the current operational channel (if in associated state in station
2325 * mode or while operating as an AP.)
2327 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2328 const u8 *dst, const u8 *src, const u8 *bssid,
2329 const u8 *data, size_t data_len, int no_cck);
2332 * send_action_cancel_wait - Cancel action frame TX wait
2333 * @priv: Private driver interface data
2335 * This command cancels the wait time associated with sending an action
2336 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2337 * set in the driver flags.
2339 void (*send_action_cancel_wait)(void *priv);
2342 * remain_on_channel - Remain awake on a channel
2343 * @priv: Private driver interface data
2344 * @freq: Frequency (in MHz) of the channel
2345 * @duration: Duration in milliseconds
2346 * Returns: 0 on success, -1 on failure
2348 * This command is used to request the driver to remain awake on the
2349 * specified channel for the specified duration and report received
2350 * Action frames with EVENT_RX_MGMT events. Optionally, received
2351 * Probe Request frames may also be requested to be reported by calling
2352 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2354 * The driver may not be at the requested channel when this function
2355 * returns, i.e., the return code is only indicating whether the
2356 * request was accepted. The caller will need to wait until the
2357 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2358 * completed the channel change. This may take some time due to other
2359 * need for the radio and the caller should be prepared to timing out
2360 * its wait since there are no guarantees on when this request can be
2363 int (*remain_on_channel)(void *priv, unsigned int freq,
2364 unsigned int duration);
2367 * cancel_remain_on_channel - Cancel remain-on-channel operation
2368 * @priv: Private driver interface data
2370 * This command can be used to cancel a remain-on-channel operation
2371 * before its originally requested duration has passed. This could be
2372 * used, e.g., when remain_on_channel() is used to request extra time
2373 * to receive a response to an Action frame and the response is
2374 * received when there is still unneeded time remaining on the
2375 * remain-on-channel operation.
2377 int (*cancel_remain_on_channel)(void *priv);
2380 * probe_req_report - Request Probe Request frames to be indicated
2381 * @priv: Private driver interface data
2382 * @report: Whether to report received Probe Request frames
2383 * Returns: 0 on success, -1 on failure (or if not supported)
2385 * This command can be used to request the driver to indicate when
2386 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2387 * Since this operation may require extra resources, e.g., due to less
2388 * optimal hardware/firmware RX filtering, many drivers may disable
2389 * Probe Request reporting at least in station mode. This command is
2390 * used to notify the driver when the Probe Request frames need to be
2391 * reported, e.g., during remain-on-channel operations.
2393 int (*probe_req_report)(void *priv, int report);
2396 * deinit_ap - Deinitialize AP mode
2397 * @priv: Private driver interface data
2398 * Returns: 0 on success, -1 on failure (or if not supported)
2400 * This optional function can be used to disable AP mode related
2401 * configuration. If the interface was not dynamically added,
2402 * change the driver mode to station mode to allow normal station
2403 * operations like scanning to be completed.
2405 int (*deinit_ap)(void *priv);
2408 * deinit_p2p_cli - Deinitialize P2P client mode
2409 * @priv: Private driver interface data
2410 * Returns: 0 on success, -1 on failure (or if not supported)
2412 * This optional function can be used to disable P2P client mode. If the
2413 * interface was not dynamically added, change the interface type back
2416 int (*deinit_p2p_cli)(void *priv);
2419 * suspend - Notification on system suspend/hibernate event
2420 * @priv: Private driver interface data
2422 void (*suspend)(void *priv);
2425 * resume - Notification on system resume/thaw event
2426 * @priv: Private driver interface data
2428 void (*resume)(void *priv);
2431 * signal_monitor - Set signal monitoring parameters
2432 * @priv: Private driver interface data
2433 * @threshold: Threshold value for signal change events; 0 = disabled
2434 * @hysteresis: Minimum change in signal strength before indicating a
2436 * Returns: 0 on success, -1 on failure (or if not supported)
2438 * This function can be used to configure monitoring of signal strength
2439 * with the current AP. Whenever signal strength drops below the
2440 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2441 * should be generated assuming the signal strength has changed at
2442 * least %hysteresis from the previously indicated signal change event.
2444 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2447 * send_frame - Send IEEE 802.11 frame (testing use only)
2448 * @priv: Private driver interface data
2449 * @data: IEEE 802.11 frame with IEEE 802.11 header
2450 * @data_len: Size of the frame
2451 * @encrypt: Whether to encrypt the frame (if keys are set)
2452 * Returns: 0 on success, -1 on failure
2454 * This function is only used for debugging purposes and is not
2455 * required to be implemented for normal operations.
2457 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2461 * shared_freq - Get operating frequency of shared interface(s)
2462 * @priv: Private driver interface data
2463 * Returns: Operating frequency in MHz, 0 if no shared operation in
2464 * use, or -1 on failure
2466 * This command can be used to request the current operating frequency
2467 * of any virtual interface that shares the same radio to provide
2468 * information for channel selection for other virtual interfaces.
2470 int (*shared_freq)(void *priv);
2473 * get_noa - Get current Notice of Absence attribute payload
2474 * @priv: Private driver interface data
2475 * @buf: Buffer for returning NoA
2476 * @buf_len: Buffer length in octets
2477 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2478 * advertized, or -1 on failure
2480 * This function is used to fetch the current Notice of Absence
2481 * attribute value from GO.
2483 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2486 * set_noa - Set Notice of Absence parameters for GO (testing)
2487 * @priv: Private driver interface data
2489 * @start: Start time in ms from next TBTT
2490 * @duration: Duration in ms
2491 * Returns: 0 on success or -1 on failure
2493 * This function is used to set Notice of Absence parameters for GO. It
2494 * is used only for testing. To disable NoA, all parameters are set to
2497 int (*set_noa)(void *priv, u8 count, int start, int duration);
2500 * set_p2p_powersave - Set P2P power save options
2501 * @priv: Private driver interface data
2502 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2503 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2504 * @ctwindow: 0.. = change (msec), -1 = no change
2505 * Returns: 0 on success or -1 on failure
2507 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2511 * ampdu - Enable/disable aggregation
2512 * @priv: Private driver interface data
2513 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2514 * Returns: 0 on success or -1 on failure
2516 int (*ampdu)(void *priv, int ampdu);
2519 * get_radio_name - Get physical radio name for the device
2520 * @priv: Private driver interface data
2521 * Returns: Radio name or %NULL if not known
2523 * The returned data must not be modified by the caller. It is assumed
2524 * that any interface that has the same radio name as another is
2525 * sharing the same physical radio. This information can be used to
2526 * share scan results etc. information between the virtual interfaces
2527 * to speed up various operations.
2529 const char * (*get_radio_name)(void *priv);
2532 * send_tdls_mgmt - for sending TDLS management packets
2533 * @priv: private driver interface data
2534 * @dst: Destination (peer) MAC address
2535 * @action_code: TDLS action code for the mssage
2536 * @dialog_token: Dialog Token to use in the message (if needed)
2537 * @status_code: Status Code or Reason Code to use (if needed)
2538 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2539 * @initiator: Is the current end the TDLS link initiator
2540 * @buf: TDLS IEs to add to the message
2541 * @len: Length of buf in octets
2542 * Returns: 0 on success, negative (<0) on failure
2544 * This optional function can be used to send packet to driver which is
2545 * responsible for receiving and sending all TDLS packets.
2547 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2548 u8 dialog_token, u16 status_code, u32 peer_capab,
2549 int initiator, const u8 *buf, size_t len);
2552 * tdls_oper - Ask the driver to perform high-level TDLS operations
2553 * @priv: Private driver interface data
2554 * @oper: TDLS high-level operation. See %enum tdls_oper
2555 * @peer: Destination (peer) MAC address
2556 * Returns: 0 on success, negative (<0) on failure
2558 * This optional function can be used to send high-level TDLS commands
2561 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2564 * wnm_oper - Notify driver of the WNM frame reception
2565 * @priv: Private driver interface data
2566 * @oper: WNM operation. See %enum wnm_oper
2567 * @peer: Destination (peer) MAC address
2568 * @buf: Buffer for the driver to fill in (for getting IE)
2569 * @buf_len: Return the len of buf
2570 * Returns: 0 on success, negative (<0) on failure
2572 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2573 u8 *buf, u16 *buf_len);
2576 * set_qos_map - Set QoS Map
2577 * @priv: Private driver interface data
2578 * @qos_map_set: QoS Map
2579 * @qos_map_set_len: Length of QoS Map
2581 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2582 u8 qos_map_set_len);
2585 * set_wowlan - Set wake-on-wireless triggers
2586 * @priv: Private driver interface data
2587 * @triggers: wowlan triggers
2589 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2592 * signal_poll - Get current connection information
2593 * @priv: Private driver interface data
2594 * @signal_info: Connection info structure
2596 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2599 * set_authmode - Set authentication algorithm(s) for static WEP
2600 * @priv: Private driver interface data
2601 * @authmode: 1=Open System, 2=Shared Key, 3=both
2602 * Returns: 0 on success, -1 on failure
2604 * This function can be used to set authentication algorithms for AP
2605 * mode when static WEP is used. If the driver uses user space MLME/SME
2606 * implementation, there is no need to implement this function.
2608 * DEPRECATED - use set_ap() instead
2610 int (*set_authmode)(void *priv, int authmode);
2614 * driver_cmd - Execute driver-specific command
2615 * @priv: Private driver interface data
2616 * @cmd: Command to execute
2617 * @buf: Return buffer
2618 * @buf_len: Buffer length
2619 * Returns: 0 on success, -1 on failure
2621 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2622 #endif /* ANDROID */
2625 * vendor_cmd - Execute vendor specific command
2626 * @priv: Private driver interface data
2627 * @vendor_id: Vendor id
2628 * @subcmd: Vendor command id
2629 * @data: Vendor command parameters (%NULL if no parameters)
2630 * @data_len: Data length
2631 * @buf: Return buffer (%NULL to ignore reply)
2632 * Returns: 0 on success, negative (<0) on failure
2634 * This function handles vendor specific commands that are passed to
2635 * the driver/device. The command is identified by vendor id and
2636 * command id. Parameters can be passed as argument to the command
2637 * in the data buffer. Reply (if any) will be filled in the supplied
2640 * The exact driver behavior is driver interface and vendor specific. As
2641 * an example, this will be converted to a vendor specific cfg80211
2642 * command in case of the nl80211 driver interface.
2644 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2645 unsigned int subcmd, const u8 *data, size_t data_len,
2646 struct wpabuf *buf);
2649 * set_rekey_info - Set rekey information
2650 * @priv: Private driver interface data
2653 * @replay_ctr: Current EAPOL-Key Replay Counter
2655 * This optional function can be used to provide information for the
2656 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2657 * while the host (including wpa_supplicant) is sleeping.
2659 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2660 const u8 *replay_ctr);
2663 * sta_assoc - Station association indication
2664 * @priv: Private driver interface data
2665 * @own_addr: Source address and BSSID for association frame
2666 * @addr: MAC address of the station to associate
2667 * @reassoc: flag to indicate re-association
2668 * @status: association response status code
2669 * @ie: assoc response ie buffer
2670 * @len: ie buffer length
2671 * Returns: 0 on success, -1 on failure
2673 * This function indicates the driver to send (Re)Association
2674 * Response frame to the station.
2676 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2677 int reassoc, u16 status, const u8 *ie, size_t len);
2680 * sta_auth - Station authentication indication
2681 * @priv: Private driver interface data
2682 * @own_addr: Source address and BSSID for authentication frame
2683 * @addr: MAC address of the station to associate
2684 * @seq: authentication sequence number
2685 * @status: authentication response status code
2686 * @ie: authentication frame ie buffer
2687 * @len: ie buffer length
2689 * This function indicates the driver to send Authentication frame
2692 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2693 u16 seq, u16 status, const u8 *ie, size_t len);
2696 * add_tspec - Add traffic stream
2697 * @priv: Private driver interface data
2698 * @addr: MAC address of the station to associate
2699 * @tspec_ie: tspec ie buffer
2700 * @tspec_ielen: tspec ie length
2701 * Returns: 0 on success, -1 on failure
2703 * This function adds the traffic steam for the station
2704 * and fills the medium_time in tspec_ie.
2706 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2707 size_t tspec_ielen);
2710 * add_sta_node - Add a station node in the driver
2711 * @priv: Private driver interface data
2712 * @addr: MAC address of the station to add
2713 * @auth_alg: authentication algorithm used by the station
2714 * Returns: 0 on success, -1 on failure
2716 * This function adds the station node in the driver, when
2717 * the station gets added by FT-over-DS.
2719 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2722 * sched_scan - Request the driver to initiate scheduled scan
2723 * @priv: Private driver interface data
2724 * @params: Scan parameters
2725 * @interval: Interval between scan cycles in milliseconds
2726 * Returns: 0 on success, -1 on failure
2728 * This operation should be used for scheduled scan offload to
2729 * the hardware. Every time scan results are available, the
2730 * driver should report scan results event for wpa_supplicant
2731 * which will eventually request the results with
2732 * wpa_driver_get_scan_results2(). This operation is optional
2733 * and if not provided or if it returns -1, we fall back to
2734 * normal host-scheduled scans.
2736 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2740 * stop_sched_scan - Request the driver to stop a scheduled scan
2741 * @priv: Private driver interface data
2742 * Returns: 0 on success, -1 on failure
2744 * This should cause the scheduled scan to be stopped and
2745 * results should stop being sent. Must be supported if
2746 * sched_scan is supported.
2748 int (*stop_sched_scan)(void *priv);
2751 * poll_client - Probe (null data or such) the given station
2752 * @priv: Private driver interface data
2753 * @own_addr: MAC address of sending interface
2754 * @addr: MAC address of the station to probe
2755 * @qos: Indicates whether station is QoS station
2757 * This function is used to verify whether an associated station is
2758 * still present. This function does not need to be implemented if the
2759 * driver provides such inactivity polling mechanism.
2761 void (*poll_client)(void *priv, const u8 *own_addr,
2762 const u8 *addr, int qos);
2765 * radio_disable - Disable/enable radio
2766 * @priv: Private driver interface data
2767 * @disabled: 1=disable 0=enable radio
2768 * Returns: 0 on success, -1 on failure
2770 * This optional command is for testing purposes. It can be used to
2771 * disable the radio on a testbed device to simulate out-of-radio-range
2774 int (*radio_disable)(void *priv, int disabled);
2777 * switch_channel - Announce channel switch and migrate the GO to the
2779 * @priv: Private driver interface data
2780 * @settings: Settings for CSA period and new channel
2781 * Returns: 0 on success, -1 on failure
2783 * This function is used to move the GO to the legacy STA channel to
2784 * avoid frequency conflict in single channel concurrency.
2786 int (*switch_channel)(void *priv, struct csa_settings *settings);
2789 * start_dfs_cac - Listen for radar interference on the channel
2790 * @priv: Private driver interface data
2791 * @freq: Channel parameters
2792 * Returns: 0 on success, -1 on failure
2794 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
2797 * stop_ap - Removes beacon from AP
2798 * @priv: Private driver interface data
2799 * Returns: 0 on success, -1 on failure (or if not supported)
2801 * This optional function can be used to disable AP mode related
2802 * configuration. Unlike deinit_ap, it does not change to station
2805 int (*stop_ap)(void *priv);
2808 * get_survey - Retrieve survey data
2809 * @priv: Private driver interface data
2810 * @freq: If set, survey data for the specified frequency is only
2811 * being requested. If not set, all survey data is requested.
2812 * Returns: 0 on success, -1 on failure
2814 * Use this to retrieve:
2816 * - the observed channel noise floor
2817 * - the amount of time we have spent on the channel
2818 * - the amount of time during which we have spent on the channel that
2819 * the radio has determined the medium is busy and we cannot
2821 * - the amount of time we have spent receiving data
2822 * - the amount of time we have spent transmitting data
2824 * This data can be used for spectrum heuristics. One example is
2825 * Automatic Channel Selection (ACS). The channel survey data is
2826 * kept on a linked list on the channel data, one entry is added
2827 * for each survey. The min_nf of the channel is updated for each
2830 int (*get_survey)(void *priv, unsigned int freq);
2833 * status - Get driver interface status information
2834 * @priv: Private driver interface data
2835 * @buf: Buffer for printing tou the status information
2836 * @buflen: Maximum length of the buffer
2837 * Returns: Length of written status information or -1 on failure
2839 int (*status)(void *priv, char *buf, size_t buflen);
2842 * roaming - Set roaming policy for driver-based BSS selection
2843 * @priv: Private driver interface data
2844 * @allowed: Whether roaming within ESS is allowed
2845 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
2846 * Returns: Length of written status information or -1 on failure
2848 * This optional callback can be used to update roaming policy from the
2849 * associate() command (bssid being set there indicates that the driver
2850 * should not roam before getting this roaming() call to allow roaming.
2851 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
2852 * capability, roaming policy is handled within wpa_supplicant and there
2853 * is no need to implement or react to this callback.
2855 int (*roaming)(void *priv, int allowed, const u8 *bssid);
2858 * set_mac_addr - Set MAC address
2859 * @priv: Private driver interface data
2860 * @addr: MAC address to use or %NULL for setting back to permanent
2861 * Returns: 0 on success, -1 on failure
2863 int (*set_mac_addr)(void *priv, const u8 *addr);
2865 #ifdef CONFIG_MACSEC
2866 int (*macsec_init)(void *priv, struct macsec_init_params *params);
2868 int (*macsec_deinit)(void *priv);
2871 * enable_protect_frames - Set protect frames status
2872 * @priv: Private driver interface data
2873 * @enabled: TRUE = protect frames enabled
2874 * FALSE = protect frames disabled
2875 * Returns: 0 on success, -1 on failure (or if not supported)
2877 int (*enable_protect_frames)(void *priv, Boolean enabled);
2880 * set_replay_protect - Set replay protect status and window size
2881 * @priv: Private driver interface data
2882 * @enabled: TRUE = replay protect enabled
2883 * FALSE = replay protect disabled
2884 * @window: replay window size, valid only when replay protect enabled
2885 * Returns: 0 on success, -1 on failure (or if not supported)
2887 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
2890 * set_current_cipher_suite - Set current cipher suite
2891 * @priv: Private driver interface data
2892 * @cs: EUI64 identifier
2893 * @cs_len: Length of the cs buffer in octets
2894 * Returns: 0 on success, -1 on failure (or if not supported)
2896 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
2900 * enable_controlled_port - Set controlled port status
2901 * @priv: Private driver interface data
2902 * @enabled: TRUE = controlled port enabled
2903 * FALSE = controlled port disabled
2904 * Returns: 0 on success, -1 on failure (or if not supported)
2906 int (*enable_controlled_port)(void *priv, Boolean enabled);
2909 * get_receive_lowest_pn - Get receive lowest pn
2910 * @priv: Private driver interface data
2911 * @channel: secure channel
2912 * @an: association number
2913 * @lowest_pn: lowest accept pn
2914 * Returns: 0 on success, -1 on failure (or if not supported)
2916 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
2920 * get_transmit_next_pn - Get transmit next pn
2921 * @priv: Private driver interface data
2922 * @channel: secure channel
2923 * @an: association number
2925 * Returns: 0 on success, -1 on failure (or if not supported)
2927 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
2931 * set_transmit_next_pn - Set transmit next pn
2932 * @priv: Private driver interface data
2933 * @channel: secure channel
2934 * @an: association number
2936 * Returns: 0 on success, -1 on failure (or if not supported)
2938 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
2942 * get_available_receive_sc - get available receive channel
2943 * @priv: Private driver interface data
2944 * @channel: secure channel
2945 * Returns: 0 on success, -1 on failure (or if not supported)
2947 int (*get_available_receive_sc)(void *priv, u32 *channel);
2950 * create_receive_sc - create secure channel for receiving
2951 * @priv: Private driver interface data
2952 * @channel: secure channel
2953 * @sci_addr: secure channel identifier - address
2954 * @sci_port: secure channel identifier - port
2955 * @conf_offset: confidentiality offset (0, 30, or 50)
2956 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
2958 * Returns: 0 on success, -1 on failure (or if not supported)
2960 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
2961 u16 sci_port, unsigned int conf_offset,
2965 * delete_receive_sc - delete secure connection for receiving
2966 * @priv: private driver interface data from init()
2967 * @channel: secure channel
2968 * Returns: 0 on success, -1 on failure
2970 int (*delete_receive_sc)(void *priv, u32 channel);
2973 * create_receive_sa - create secure association for receive
2974 * @priv: private driver interface data from init()
2975 * @channel: secure channel
2976 * @an: association number
2977 * @lowest_pn: the lowest packet number can be received
2978 * @sak: the secure association key
2979 * Returns: 0 on success, -1 on failure
2981 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
2982 u32 lowest_pn, const u8 *sak);
2985 * enable_receive_sa - enable the SA for receive
2986 * @priv: private driver interface data from init()
2987 * @channel: secure channel
2988 * @an: association number
2989 * Returns: 0 on success, -1 on failure
2991 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
2994 * disable_receive_sa - disable SA for receive
2995 * @priv: private driver interface data from init()
2996 * @channel: secure channel index
2997 * @an: association number
2998 * Returns: 0 on success, -1 on failure
3000 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3003 * get_available_transmit_sc - get available transmit channel
3004 * @priv: Private driver interface data
3005 * @channel: secure channel
3006 * Returns: 0 on success, -1 on failure (or if not supported)
3008 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3011 * create_transmit_sc - create secure connection for transmit
3012 * @priv: private driver interface data from init()
3013 * @channel: secure channel
3014 * @sci_addr: secure channel identifier - address
3015 * @sci_port: secure channel identifier - port
3016 * Returns: 0 on success, -1 on failure
3018 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3019 u16 sci_port, unsigned int conf_offset);
3022 * delete_transmit_sc - delete secure connection for transmit
3023 * @priv: private driver interface data from init()
3024 * @channel: secure channel
3025 * Returns: 0 on success, -1 on failure
3027 int (*delete_transmit_sc)(void *priv, u32 channel);
3030 * create_transmit_sa - create secure association for transmit
3031 * @priv: private driver interface data from init()
3032 * @channel: secure channel index
3033 * @an: association number
3034 * @next_pn: the packet number used as next transmit packet
3035 * @confidentiality: True if the SA is to provide confidentiality
3036 * as well as integrity
3037 * @sak: the secure association key
3038 * Returns: 0 on success, -1 on failure
3040 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3041 Boolean confidentiality, const u8 *sak);
3044 * enable_transmit_sa - enable SA for transmit
3045 * @priv: private driver interface data from init()
3046 * @channel: secure channel
3047 * @an: association number
3048 * Returns: 0 on success, -1 on failure
3050 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3053 * disable_transmit_sa - disable SA for transmit
3054 * @priv: private driver interface data from init()
3055 * @channel: secure channel
3056 * @an: association number
3057 * Returns: 0 on success, -1 on failure
3059 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3060 #endif /* CONFIG_MACSEC */
3063 * init_mesh - Driver specific initialization for mesh
3064 * @priv: Private driver interface data
3065 * Returns: 0 on success, -1 on failure
3067 int (*init_mesh)(void *priv);
3070 * join_mesh - Join a mesh network
3071 * @priv: Private driver interface data
3072 * @params: Mesh configuration parameters
3073 * Returns: 0 on success, -1 on failure
3075 int (*join_mesh)(void *priv,
3076 struct wpa_driver_mesh_join_params *params);
3079 * leave_mesh - Leave a mesh network
3080 * @priv: Private driver interface data
3081 * Returns 0 on success, -1 on failure
3083 int (*leave_mesh)(void *priv);
3088 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3090 enum wpa_event_type {
3092 * EVENT_ASSOC - Association completed
3094 * This event needs to be delivered when the driver completes IEEE
3095 * 802.11 association or reassociation successfully.
3096 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3097 * after this event has been generated. In addition, optional
3098 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3099 * more information about the association. If the driver interface gets
3100 * both of these events at the same time, it can also include the
3101 * assoc_info data in EVENT_ASSOC call.
3106 * EVENT_DISASSOC - Association lost
3108 * This event should be called when association is lost either due to
3109 * receiving deauthenticate or disassociate frame from the AP or when
3110 * sending either of these frames to the current AP. If the driver
3111 * supports separate deauthentication event, EVENT_DISASSOC should only
3112 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3113 * In AP mode, union wpa_event_data::disassoc_info is required.
3118 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3120 * This event must be delivered when a Michael MIC error is detected by
3121 * the local driver. Additional data for event processing is
3122 * provided with union wpa_event_data::michael_mic_failure. This
3123 * information is used to request new encyption key and to initiate
3124 * TKIP countermeasures if needed.
3126 EVENT_MICHAEL_MIC_FAILURE,
3129 * EVENT_SCAN_RESULTS - Scan results available
3131 * This event must be called whenever scan results are available to be
3132 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3133 * is expected to be used some time after struct wpa_driver_ops::scan()
3134 * is called. If the driver provides an unsolicited event when the scan
3135 * has been completed, this event can be used to trigger
3136 * EVENT_SCAN_RESULTS call. If such event is not available from the
3137 * driver, the driver wrapper code is expected to use a registered
3138 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3139 * scan is expected to be completed. Optional information about
3140 * completed scan can be provided with union wpa_event_data::scan_info.
3145 * EVENT_ASSOCINFO - Report optional extra information for association
3147 * This event can be used to report extra association information for
3148 * EVENT_ASSOC processing. This extra information includes IEs from
3149 * association frames and Beacon/Probe Response frames in union
3150 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3151 * EVENT_ASSOC. Alternatively, the driver interface can include
3152 * assoc_info data in the EVENT_ASSOC call if it has all the
3153 * information available at the same point.
3158 * EVENT_INTERFACE_STATUS - Report interface status changes
3160 * This optional event can be used to report changes in interface
3161 * status (interface added/removed) using union
3162 * wpa_event_data::interface_status. This can be used to trigger
3163 * wpa_supplicant to stop and re-start processing for the interface,
3164 * e.g., when a cardbus card is ejected/inserted.
3166 EVENT_INTERFACE_STATUS,
3169 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3171 * This event can be used to inform wpa_supplicant about candidates for
3172 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3173 * for scan request (ap_scan=2 mode), this event is required for
3174 * pre-authentication. If wpa_supplicant is performing scan request
3175 * (ap_scan=1), this event is optional since scan results can be used
3176 * to add pre-authentication candidates. union
3177 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3178 * candidate and priority of the candidate, e.g., based on the signal
3179 * strength, in order to try to pre-authenticate first with candidates
3180 * that are most likely targets for re-association.
3182 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3183 * on the candidate list. In addition, it can be called for the current
3184 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3185 * will automatically skip pre-authentication in cases where a valid
3186 * PMKSA exists. When more than one candidate exists, this event should
3187 * be generated once for each candidate.
3189 * Driver will be notified about successful pre-authentication with
3190 * struct wpa_driver_ops::add_pmkid() calls.
3192 EVENT_PMKID_CANDIDATE,
3195 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3197 * This event can be used to inform wpa_supplicant about desire to set
3198 * up secure direct link connection between two stations as defined in
3199 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3200 * STAKey negotiation. The caller will need to set peer address for the
3206 * EVENT_TDLS - Request TDLS operation
3208 * This event can be used to request a TDLS operation to be performed.
3213 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3215 * The driver is expected to report the received FT IEs from
3216 * FT authentication sequence from the AP. The FT IEs are included in
3217 * the extra information in union wpa_event_data::ft_ies.
3222 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3224 * The driver can use this event to inform wpa_supplicant about a STA
3225 * in an IBSS with which protected frames could be exchanged. This
3226 * event starts RSN authentication with the other STA to authenticate
3227 * the STA and set up encryption keys with it.
3229 EVENT_IBSS_RSN_START,
3232 * EVENT_AUTH - Authentication result
3234 * This event should be called when authentication attempt has been
3235 * completed. This is only used if the driver supports separate
3236 * authentication step (struct wpa_driver_ops::authenticate).
3237 * Information about authentication result is included in
3238 * union wpa_event_data::auth.
3243 * EVENT_DEAUTH - Authentication lost
3245 * This event should be called when authentication is lost either due
3246 * to receiving deauthenticate frame from the AP or when sending that
3247 * frame to the current AP.
3248 * In AP mode, union wpa_event_data::deauth_info is required.
3253 * EVENT_ASSOC_REJECT - Association rejected
3255 * This event should be called when (re)association attempt has been
3256 * rejected by the AP. Information about the association response is
3257 * included in union wpa_event_data::assoc_reject.
3262 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3264 EVENT_AUTH_TIMED_OUT,
3267 * EVENT_ASSOC_TIMED_OUT - Association timed out
3269 EVENT_ASSOC_TIMED_OUT,
3272 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
3277 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3279 EVENT_WPS_BUTTON_PUSHED,
3282 * EVENT_TX_STATUS - Report TX status
3287 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3289 EVENT_RX_FROM_UNKNOWN,
3292 * EVENT_RX_MGMT - Report RX of a management frame
3297 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3299 * This event is used to indicate when the driver has started the
3300 * requested remain-on-channel duration. Information about the
3301 * operation is included in union wpa_event_data::remain_on_channel.
3303 EVENT_REMAIN_ON_CHANNEL,
3306 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3308 * This event is used to indicate when the driver has completed
3309 * remain-on-channel duration, i.e., may noot be available on the
3310 * requested channel anymore. Information about the
3311 * operation is included in union wpa_event_data::remain_on_channel.
3313 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3316 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
3318 * This event is used only by driver_test.c and userspace MLME.
3323 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3325 * This event is used to indicate when a Probe Request frame has been
3326 * received. Information about the received frame is included in
3327 * union wpa_event_data::rx_probe_req. The driver is required to report
3328 * these events only after successfully completed probe_req_report()
3329 * commands to request the events (i.e., report parameter is non-zero)
3330 * in station mode. In AP mode, Probe Request frames should always be
3336 * EVENT_NEW_STA - New wired device noticed
3338 * This event is used to indicate that a new device has been detected
3339 * in a network that does not use association-like functionality (i.e.,
3340 * mainly wired Ethernet). This can be used to start EAPOL
3341 * authenticator when receiving a frame from a device. The address of
3342 * the device is included in union wpa_event_data::new_sta.
3347 * EVENT_EAPOL_RX - Report received EAPOL frame
3349 * When in AP mode with hostapd, this event is required to be used to
3350 * deliver the receive EAPOL frames from the driver. With
3351 * %wpa_supplicant, this event is used only if the send_eapol() handler
3352 * is used to override the use of l2_packet for EAPOL frame TX.
3357 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3359 * This event is used to indicate changes in the signal strength
3360 * observed in frames received from the current AP if signal strength
3361 * monitoring has been enabled with signal_monitor().
3363 EVENT_SIGNAL_CHANGE,
3366 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3368 * This event is used to indicate that the interface was enabled after
3369 * having been previously disabled, e.g., due to rfkill.
3371 EVENT_INTERFACE_ENABLED,
3374 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3376 * This event is used to indicate that the interface was disabled,
3377 * e.g., due to rfkill.
3379 EVENT_INTERFACE_DISABLED,
3382 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3384 * This event is used to indicate that the channel list has changed,
3385 * e.g., because of a regulatory domain change triggered by scan
3386 * results including an AP advertising a country code.
3388 EVENT_CHANNEL_LIST_CHANGED,
3391 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3393 * This event is used to indicate that the driver cannot maintain this
3394 * interface in its operation mode anymore. The most likely use for
3395 * this is to indicate that AP mode operation is not available due to
3396 * operating channel would need to be changed to a DFS channel when
3397 * the driver does not support radar detection and another virtual
3398 * interfaces caused the operating channel to change. Other similar
3399 * resource conflicts could also trigger this for station mode
3400 * interfaces. This event can be propagated when channel switching
3403 EVENT_INTERFACE_UNAVAILABLE,
3406 * EVENT_BEST_CHANNEL
3408 * Driver generates this event whenever it detects a better channel
3409 * (e.g., based on RSSI or channel use). This information can be used
3410 * to improve channel selection for a new AP/P2P group.
3415 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3417 * This event should be called when a Deauthentication frame is dropped
3418 * due to it not being protected (MFP/IEEE 802.11w).
3419 * union wpa_event_data::unprot_deauth is required to provide more
3420 * details of the frame.
3422 EVENT_UNPROT_DEAUTH,
3425 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3427 * This event should be called when a Disassociation frame is dropped
3428 * due to it not being protected (MFP/IEEE 802.11w).
3429 * union wpa_event_data::unprot_disassoc is required to provide more
3430 * details of the frame.
3432 EVENT_UNPROT_DISASSOC,
3435 * EVENT_STATION_LOW_ACK
3437 * Driver generates this event whenever it detected that a particular
3438 * station was lost. Detection can be through massive transmission
3439 * failures for example.
3441 EVENT_STATION_LOW_ACK,
3444 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3446 EVENT_IBSS_PEER_LOST,
3449 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3451 * This event carries the new replay counter to notify wpa_supplicant
3452 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3453 * completed Group Key Handshake while the host (including
3454 * wpa_supplicant was sleeping).
3456 EVENT_DRIVER_GTK_REKEY,
3459 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3461 EVENT_SCHED_SCAN_STOPPED,
3464 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3466 * This event indicates that the station responded to the poll
3467 * initiated with @poll_client.
3469 EVENT_DRIVER_CLIENT_POLL_OK,
3472 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3474 EVENT_EAPOL_TX_STATUS,
3477 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3479 * Described in wpa_event_data.ch_switch
3484 * EVENT_WNM - Request WNM operation
3486 * This event can be used to request a WNM operation to be performed.
3491 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3493 * This event indicates that the driver reported a connection failure
3494 * with the specified client (for example, max client reached, etc.) in
3497 EVENT_CONNECT_FAILED_REASON,
3500 * EVENT_RADAR_DETECTED - Notify of radar detection
3502 * A radar has been detected on the supplied frequency, hostapd should
3503 * react accordingly (e.g., change channel).
3505 EVENT_DFS_RADAR_DETECTED,
3508 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3510 * After a successful CAC, the channel can be marked clear and used.
3512 EVENT_DFS_CAC_FINISHED,
3515 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3517 * The CAC was not successful, and the channel remains in the previous
3518 * state. This may happen due to a radar beeing detected or other
3519 * external influences.
3521 EVENT_DFS_CAC_ABORTED,
3524 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3526 * The channel which was previously unavailable is now available again.
3528 EVENT_DFS_NOP_FINISHED,
3531 * EVENT_SURVEY - Received survey data
3533 * This event gets triggered when a driver query is issued for survey
3534 * data and the requested data becomes available. The returned data is
3535 * stored in struct survey_results. The results provide at most one
3536 * survey entry for each frequency and at minimum will provide one
3537 * survey entry for one frequency. The survey data can be os_malloc()'d
3538 * and then os_free()'d, so the event callback must only copy data.
3543 * EVENT_SCAN_STARTED - Scan started
3545 * This indicates that driver has started a scan operation either based
3546 * on a request from wpa_supplicant/hostapd or from another application.
3547 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3548 * completed (either successfully or by getting cancelled).
3553 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3555 * This event indicates a set of frequency ranges that should be avoided
3556 * to reduce issues due to interference or internal co-existence
3557 * information in the driver.
3559 EVENT_AVOID_FREQUENCIES,
3562 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3564 EVENT_NEW_PEER_CANDIDATE
3570 * struct freq_survey - Channel survey info
3572 * @ifidx: Interface index in which this survey was observed
3573 * @freq: Center of frequency of the surveyed channel
3574 * @nf: Channel noise floor in dBm
3575 * @channel_time: Amount of time in ms the radio spent on the channel
3576 * @channel_time_busy: Amount of time in ms the radio detected some signal
3577 * that indicated to the radio the channel was not clear
3578 * @channel_time_rx: Amount of time the radio spent receiving data
3579 * @channel_time_tx: Amount of time the radio spent transmitting data
3580 * @filled: bitmask indicating which fields have been reported, see
3581 * SURVEY_HAS_* defines.
3582 * @list: Internal list pointers
3584 struct freq_survey {
3589 u64 channel_time_busy;
3590 u64 channel_time_rx;
3591 u64 channel_time_tx;
3592 unsigned int filled;
3593 struct dl_list list;
3596 #define SURVEY_HAS_NF BIT(0)
3597 #define SURVEY_HAS_CHAN_TIME BIT(1)
3598 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3599 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3600 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3604 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3606 union wpa_event_data {
3608 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3610 * This structure is optional for EVENT_ASSOC calls and required for
3611 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3612 * driver interface does not need to generate separate EVENT_ASSOCINFO
3617 * reassoc - Flag to indicate association or reassociation
3622 * req_ies - (Re)Association Request IEs
3624 * If the driver generates WPA/RSN IE, this event data must be
3625 * returned for WPA handshake to have needed information. If
3626 * wpa_supplicant-generated WPA/RSN IE is used, this
3627 * information event is optional.
3629 * This should start with the first IE (fixed fields before IEs
3630 * are not included).
3635 * req_ies_len - Length of req_ies in bytes
3640 * resp_ies - (Re)Association Response IEs
3642 * Optional association data from the driver. This data is not
3643 * required WPA, but may be useful for some protocols and as
3644 * such, should be reported if this is available to the driver
3647 * This should start with the first IE (fixed fields before IEs
3648 * are not included).
3653 * resp_ies_len - Length of resp_ies in bytes
3655 size_t resp_ies_len;
3658 * beacon_ies - Beacon or Probe Response IEs
3660 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3661 * Probe Response frames from the current AP (i.e., the one
3662 * that the client just associated with). This information is
3663 * used to update WPA/RSN IE for the AP. If this field is not
3664 * set, the results from previous scan will be used. If no
3665 * data for the new AP is found, scan results will be requested
3666 * again (without scan request). At this point, the driver is
3667 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3670 * This should start with the first IE (fixed fields before IEs
3671 * are not included).
3673 const u8 *beacon_ies;
3676 * beacon_ies_len - Length of beacon_ies */
3677 size_t beacon_ies_len;
3680 * freq - Frequency of the operational channel in MHz
3685 * addr - Station address (for AP mode)
3690 * The following is the key management offload information
3693 * @key_replay_ctr_len
3701 * authorized - Status of key management offload,
3707 * key_replay_ctr - Key replay counter value last used
3708 * in a valid EAPOL-Key frame
3710 const u8 *key_replay_ctr;
3713 * key_replay_ctr_len - The length of key_replay_ctr
3715 size_t key_replay_ctr_len;
3718 * ptk_kck - The derived PTK KCK
3723 * ptk_kek_len - The length of ptk_kck
3728 * ptk_kek - The derived PTK KEK
3733 * ptk_kek_len - The length of ptk_kek
3739 * struct disassoc_info - Data for EVENT_DISASSOC events
3741 struct disassoc_info {
3743 * addr - Station address (for AP mode)
3748 * reason_code - Reason Code (host byte order) used in
3749 * Deauthentication frame
3754 * ie - Optional IE(s) in Disassociation frame
3759 * ie_len - Length of ie buffer in octets
3764 * locally_generated - Whether the frame was locally generated
3766 int locally_generated;
3770 * struct deauth_info - Data for EVENT_DEAUTH events
3772 struct deauth_info {
3774 * addr - Station address (for AP mode)
3779 * reason_code - Reason Code (host byte order) used in
3780 * Deauthentication frame
3785 * ie - Optional IE(s) in Deauthentication frame
3790 * ie_len - Length of ie buffer in octets
3795 * locally_generated - Whether the frame was locally generated
3797 int locally_generated;
3801 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3803 struct michael_mic_failure {
3806 } michael_mic_failure;
3809 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3811 struct interface_status {
3814 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3819 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3821 struct pmkid_candidate {
3822 /** BSSID of the PMKID candidate */
3824 /** Smaller the index, higher the priority */
3826 /** Whether RSN IE includes pre-authenticate flag */
3831 * struct stkstart - Data for EVENT_STKSTART
3838 * struct tdls - Data for EVENT_TDLS
3844 TDLS_REQUEST_TEARDOWN
3846 u16 reason_code; /* for teardown */
3850 * struct wnm - Data for EVENT_WNM
3868 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3870 * During FT (IEEE 802.11r) authentication sequence, the driver is
3871 * expected to use this event to report received FT IEs (MDIE, FTIE,
3872 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3873 * IEs for the next message will be delivered through the
3874 * struct wpa_driver_ops::update_ft_ies() callback.
3880 u8 target_ap[ETH_ALEN];
3881 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3883 /** Length of ric_ies buffer in octets */
3888 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3890 struct ibss_rsn_start {
3895 * struct auth_info - Data for EVENT_AUTH events
3901 u16 auth_transaction;
3908 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3910 struct assoc_reject {
3912 * bssid - BSSID of the AP that rejected association
3917 * resp_ies - (Re)Association Response IEs
3919 * Optional association data from the driver. This data is not
3920 * required WPA, but may be useful for some protocols and as
3921 * such, should be reported if this is available to the driver
3924 * This should start with the first IE (fixed fields before IEs
3925 * are not included).
3930 * resp_ies_len - Length of resp_ies in bytes
3932 size_t resp_ies_len;
3935 * status_code - Status Code from (Re)association Response
3940 struct timeout_event {
3945 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3954 * struct tx_status - Data for EVENT_TX_STATUS events
3966 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3968 struct rx_from_unknown {
3975 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3983 * drv_priv - Pointer to store driver private BSS information
3985 * If not set to NULL, this is used for comparison with
3986 * hostapd_data->drv_priv to determine which BSS should process
3992 * freq - Frequency (in MHz) on which the frame was received
3997 * ssi_signal - Signal strength in dBm (or 0 if not available)
4003 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4005 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4007 struct remain_on_channel {
4009 * freq - Channel frequency in MHz
4014 * duration - Duration to remain on the channel in milliseconds
4016 unsigned int duration;
4017 } remain_on_channel;
4020 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4021 * @aborted: Whether the scan was aborted
4022 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4023 * @num_freqs: Number of entries in freqs array
4024 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4026 * @num_ssids: Number of entries in ssids array
4032 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4037 * struct mlme_rx - Data for EVENT_MLME_RX events
4048 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4050 struct rx_probe_req {
4052 * sa - Source address of the received Probe Request frame
4057 * da - Destination address of the received Probe Request frame
4058 * or %NULL if not available
4063 * bssid - BSSID of the received Probe Request frame or %NULL
4069 * ie - IEs from the Probe Request body
4074 * ie_len - Length of ie buffer in octets
4079 * signal - signal strength in dBm (or 0 if not available)
4085 * struct new_sta - Data for EVENT_NEW_STA events
4092 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4101 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4103 struct wpa_signal_info signal_change;
4106 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4107 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4108 * @freq_5: Best 5 GHz band channel frequency in MHz
4109 * @freq_overall: Best channel frequency in MHz
4111 * 0 can be used to indicate no preference in either band.
4113 struct best_channel {
4119 struct unprot_deauth {
4125 struct unprot_disassoc {
4132 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4133 * @addr: station address
4140 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4142 struct ibss_peer_lost {
4147 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4149 struct driver_gtk_rekey {
4151 const u8 *replay_ctr;
4155 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4156 * @addr: station address
4158 struct client_poll {
4163 * struct eapol_tx_status
4164 * @dst: Original destination
4165 * @data: Data starting with IEEE 802.1X header (!)
4166 * @data_len: Length of data
4167 * @ack: Indicates ack or lost frame
4169 * This corresponds to hapd_send_eapol if the frame sent
4170 * there isn't just reported as EVENT_TX_STATUS.
4172 struct eapol_tx_status {
4181 * @freq: Frequency of new channel in MHz
4182 * @ht_enabled: Whether this is an HT channel
4183 * @ch_offset: Secondary channel offset
4184 * @ch_width: Channel width
4185 * @cf1: Center frequency 1
4186 * @cf2: Center frequency 2
4192 enum chan_width ch_width;
4198 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4199 * @addr: Remote client address
4200 * @code: Reason code for connection failure
4202 struct connect_failed_reason {
4208 } connect_failed_reason;
4211 * struct dfs_event - Data for radar detected events
4212 * @freq: Frequency of the channel in MHz
4218 enum chan_width chan_width;
4224 * survey_results - Survey result data for EVENT_SURVEY
4225 * @freq_filter: Requested frequency survey filter, 0 if request
4226 * was for all survey data
4227 * @survey_list: Linked list of survey data
4229 struct survey_results {
4230 unsigned int freq_filter;
4231 struct dl_list survey_list; /* struct freq_survey */
4235 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4236 * @initiator: Initiator of the regulatory change
4237 * @type: Regulatory change type
4238 * @alpha2: Country code (or "" if not available)
4240 struct channel_list_changed {
4241 enum reg_change_initiator initiator;
4244 } channel_list_changed;
4247 * freq_range - List of frequency ranges
4249 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4251 struct wpa_freq_range_list freq_range;
4256 * @peer: Peer address
4258 * @ie_len: Length of @ies
4260 * Notification of new candidate mesh peer.
4271 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4272 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4273 * with struct wpa_driver_ops::init()
4274 * @event: event type (defined above)
4275 * @data: possible extra data for the event
4277 * Driver wrapper code should call this function whenever an event is received
4280 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4281 union wpa_event_data *data);
4285 * The following inline functions are provided for convenience to simplify
4286 * event indication for some of the common events.
4289 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4290 size_t ielen, int reassoc)
4292 union wpa_event_data event;
4293 os_memset(&event, 0, sizeof(event));
4294 event.assoc_info.reassoc = reassoc;
4295 event.assoc_info.req_ies = ie;
4296 event.assoc_info.req_ies_len = ielen;
4297 event.assoc_info.addr = addr;
4298 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4301 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4303 union wpa_event_data event;
4304 os_memset(&event, 0, sizeof(event));
4305 event.disassoc_info.addr = addr;
4306 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4309 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4312 union wpa_event_data event;
4313 os_memset(&event, 0, sizeof(event));
4314 event.eapol_rx.src = src;
4315 event.eapol_rx.data = data;
4316 event.eapol_rx.data_len = data_len;
4317 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4320 /* driver_common.c */
4321 void wpa_scan_results_free(struct wpa_scan_results *res);
4323 /* Convert wpa_event_type to a string for logging */
4324 const char * event_to_string(enum wpa_event_type event);
4326 /* Convert chan_width to a string for logging and control interfaces */
4327 const char * channel_width_to_string(enum chan_width width);
4329 int ht_supported(const struct hostapd_hw_modes *mode);
4330 int vht_supported(const struct hostapd_hw_modes *mode);
4332 /* NULL terminated array of linked in driver wrappers */
4333 extern struct wpa_driver_ops *wpa_drivers[];
4335 #endif /* DRIVER_H */