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
1059 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1060 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1061 unsigned int smps_modes;
1064 int max_sched_scan_ssids;
1065 int sched_scan_supported;
1069 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1071 unsigned int max_remain_on_chan;
1074 * max_stations - Maximum number of associated stations the driver
1075 * supports in AP mode
1077 unsigned int max_stations;
1080 * probe_resp_offloads - Bitmap of supported protocols by the driver
1081 * for Probe Response offloading.
1083 /* Driver Probe Response offloading support for WPS ver. 1 */
1084 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1085 /* Driver Probe Response offloading support for WPS ver. 2 */
1086 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1087 /* Driver Probe Response offloading support for P2P */
1088 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1089 /* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1090 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1091 unsigned int probe_resp_offloads;
1093 unsigned int max_acl_mac_addrs;
1096 * Number of supported concurrent channels
1098 unsigned int num_multichan_concurrent;
1101 * extended_capa - extended capabilities in driver/device
1103 * Must be allocated and freed by driver and the pointers must be
1104 * valid for the lifetime of the driver, i.e., freed in deinit()
1106 const u8 *extended_capa, *extended_capa_mask;
1107 unsigned int extended_capa_len;
1109 struct wowlan_triggers wowlan_triggers;
1113 struct hostapd_data;
1115 struct hostap_sta_driver_data {
1116 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1117 unsigned long current_tx_rate;
1118 unsigned long inactive_msec;
1119 unsigned long flags;
1120 unsigned long num_ps_buf_frames;
1121 unsigned long tx_retry_failed;
1122 unsigned long tx_retry_count;
1127 struct hostapd_sta_add_params {
1131 const u8 *supp_rates;
1132 size_t supp_rates_len;
1133 u16 listen_interval;
1134 const struct ieee80211_ht_capabilities *ht_capabilities;
1135 const struct ieee80211_vht_capabilities *vht_capabilities;
1136 int vht_opmode_enabled;
1138 u32 flags; /* bitmask of WPA_STA_* flags */
1139 u32 flags_mask; /* unset bits in flags */
1140 int set; /* Set STA parameters instead of add */
1142 const u8 *ext_capab;
1143 size_t ext_capab_len;
1144 const u8 *supp_channels;
1145 size_t supp_channels_len;
1146 const u8 *supp_oper_classes;
1147 size_t supp_oper_classes_len;
1150 struct mac_address {
1154 struct hostapd_acl_params {
1156 unsigned int num_mac_acl;
1157 struct mac_address mac_acl[0];
1160 enum wpa_driver_if_type {
1162 * WPA_IF_STATION - Station mode interface
1167 * WPA_IF_AP_VLAN - AP mode VLAN interface
1169 * This interface shares its address and Beacon frame with the main
1175 * WPA_IF_AP_BSS - AP mode BSS interface
1177 * This interface has its own address and Beacon frame.
1182 * WPA_IF_P2P_GO - P2P Group Owner
1187 * WPA_IF_P2P_CLIENT - P2P Client
1192 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1193 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1198 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1199 * abstracted P2P Device function in the driver
1204 struct wpa_init_params {
1210 const char *test_socket;
1211 int use_pae_group_addr;
1215 u8 *own_addr; /* buffer for writing own MAC address */
1219 struct wpa_bss_params {
1220 /** Interface name (for multi-SSID/VLAN support) */
1222 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1231 enum mfp_options ieee80211w;
1234 #define WPA_STA_AUTHORIZED BIT(0)
1235 #define WPA_STA_WMM BIT(1)
1236 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1237 #define WPA_STA_MFP BIT(3)
1238 #define WPA_STA_TDLS_PEER BIT(4)
1251 WNM_SLEEP_ENTER_CONFIRM,
1252 WNM_SLEEP_ENTER_FAIL,
1253 WNM_SLEEP_EXIT_CONFIRM,
1254 WNM_SLEEP_EXIT_FAIL,
1255 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1256 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1257 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1259 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1261 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1262 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1264 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1267 /* enum chan_width - Channel width definitions */
1279 * struct wpa_signal_info - Information about channel signal quality
1281 struct wpa_signal_info {
1283 int above_threshold;
1288 enum chan_width chanwidth;
1294 * struct beacon_data - Beacon data
1295 * @head: Head portion of Beacon frame (before TIM IE)
1296 * @tail: Tail portion of Beacon frame (after TIM IE)
1297 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1298 * @proberesp_ies: Extra information element(s) to add into Probe Response
1300 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1301 * Response frames or %NULL
1302 * @probe_resp: Probe Response frame template
1303 * @head_len: Length of @head
1304 * @tail_len: Length of @tail
1305 * @beacon_ies_len: Length of beacon_ies in octets
1306 * @proberesp_ies_len: Length of proberesp_ies in octets
1307 * @proberesp_ies_len: Length of proberesp_ies in octets
1308 * @probe_resp_len: Length of probe response template (@probe_resp)
1310 struct beacon_data {
1317 size_t head_len, tail_len;
1318 size_t beacon_ies_len;
1319 size_t proberesp_ies_len;
1320 size_t assocresp_ies_len;
1321 size_t probe_resp_len;
1325 * struct csa_settings - Settings for channel switch command
1326 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1327 * @block_tx: 1 - block transmission for CSA period
1328 * @freq_params: Next channel frequency parameter
1329 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1330 * @beacon_after: Next beacon/probe resp/asooc resp info
1331 * @counter_offset_beacon: Offset to the count field in beacon's tail
1332 * @counter_offset_presp: Offset to the count field in probe resp.
1334 struct csa_settings {
1338 struct hostapd_freq_params freq_params;
1339 struct beacon_data beacon_csa;
1340 struct beacon_data beacon_after;
1342 u16 counter_offset_beacon;
1343 u16 counter_offset_presp;
1346 /* TDLS peer capabilities for send_tdls_mgmt() */
1347 enum tdls_peer_capability {
1348 TDLS_PEER_HT = BIT(0),
1349 TDLS_PEER_VHT = BIT(1),
1350 TDLS_PEER_WMM = BIT(2),
1353 #ifdef CONFIG_MACSEC
1354 struct macsec_init_params {
1355 Boolean always_include_sci;
1359 #endif /* CONFIG_MACSEC */
1363 * struct wpa_driver_ops - Driver interface API definition
1365 * This structure defines the API that each driver interface needs to implement
1366 * for core wpa_supplicant code. All driver specific functionality is captured
1369 struct wpa_driver_ops {
1370 /** Name of the driver interface */
1372 /** One line description of the driver interface */
1376 * get_bssid - Get the current BSSID
1377 * @priv: private driver interface data
1378 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1380 * Returns: 0 on success, -1 on failure
1382 * Query kernel driver for the current BSSID and copy it to bssid.
1383 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1386 int (*get_bssid)(void *priv, u8 *bssid);
1389 * get_ssid - Get the current SSID
1390 * @priv: private driver interface data
1391 * @ssid: buffer for SSID (at least 32 bytes)
1393 * Returns: Length of the SSID on success, -1 on failure
1395 * Query kernel driver for the current SSID and copy it to ssid.
1396 * Returning zero is recommended if the STA is not associated.
1398 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1399 * can, at least in theory, contain control characters (including nul)
1400 * and as such, should be processed as binary data, not a printable
1403 int (*get_ssid)(void *priv, u8 *ssid);
1406 * set_key - Configure encryption key
1407 * @ifname: Interface name (for multi-SSID/VLAN support)
1408 * @priv: private driver interface data
1409 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1410 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1411 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1412 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1413 * %WPA_ALG_BIP_CMAC_256);
1414 * %WPA_ALG_NONE clears the key.
1415 * @addr: Address of the peer STA (BSSID of the current AP when setting
1416 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1417 * broadcast keys, %NULL for default keys that are used both for
1418 * broadcast and unicast; when clearing keys, %NULL is used to
1419 * indicate that both the broadcast-only and default key of the
1420 * specified key index is to be cleared
1421 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1423 * @set_tx: configure this key as the default Tx key (only used when
1424 * driver does not support separate unicast/individual key
1425 * @seq: sequence number/packet number, seq_len octets, the next
1426 * packet number to be used for in replay protection; configured
1427 * for Rx keys (in most cases, this is only used with broadcast
1428 * keys and set to zero for unicast keys); %NULL if not set
1429 * @seq_len: length of the seq, depends on the algorithm:
1430 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1431 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1433 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1434 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1436 * Returns: 0 on success, -1 on failure
1438 * Configure the given key for the kernel driver. If the driver
1439 * supports separate individual keys (4 default keys + 1 individual),
1440 * addr can be used to determine whether the key is default or
1441 * individual. If only 4 keys are supported, the default key with key
1442 * index 0 is used as the individual key. STA must be configured to use
1443 * it as the default Tx key (set_tx is set) and accept Rx for all the
1444 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1445 * broadcast keys, so key index 0 is available for this kind of
1448 * Please note that TKIP keys include separate TX and RX MIC keys and
1449 * some drivers may expect them in different order than wpa_supplicant
1450 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1451 * will trigger Michael MIC errors. This can be fixed by changing the
1452 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1453 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1454 * example on how this can be done.
1456 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1457 const u8 *addr, int key_idx, int set_tx,
1458 const u8 *seq, size_t seq_len,
1459 const u8 *key, size_t key_len);
1462 * init - Initialize driver interface
1463 * @ctx: context to be used when calling wpa_supplicant functions,
1464 * e.g., wpa_supplicant_event()
1465 * @ifname: interface name, e.g., wlan0
1467 * Returns: Pointer to private data, %NULL on failure
1469 * Initialize driver interface, including event processing for kernel
1470 * driver events (e.g., associated, scan results, Michael MIC failure).
1471 * This function can allocate a private configuration data area for
1472 * @ctx, file descriptor, interface name, etc. information that may be
1473 * needed in future driver operations. If this is not used, non-NULL
1474 * value will need to be returned because %NULL is used to indicate
1475 * failure. The returned value will be used as 'void *priv' data for
1476 * all other driver_ops functions.
1478 * The main event loop (eloop.c) of wpa_supplicant can be used to
1479 * register callback for read sockets (eloop_register_read_sock()).
1481 * See below for more information about events and
1482 * wpa_supplicant_event() function.
1484 void * (*init)(void *ctx, const char *ifname);
1487 * deinit - Deinitialize driver interface
1488 * @priv: private driver interface data from init()
1490 * Shut down driver interface and processing of driver events. Free
1491 * private data buffer if one was allocated in init() handler.
1493 void (*deinit)(void *priv);
1496 * set_param - Set driver configuration parameters
1497 * @priv: private driver interface data from init()
1498 * @param: driver specific configuration parameters
1500 * Returns: 0 on success, -1 on failure
1502 * Optional handler for notifying driver interface about configuration
1503 * parameters (driver_param).
1505 int (*set_param)(void *priv, const char *param);
1508 * set_countermeasures - Enable/disable TKIP countermeasures
1509 * @priv: private driver interface data
1510 * @enabled: 1 = countermeasures enabled, 0 = disabled
1512 * Returns: 0 on success, -1 on failure
1514 * Configure TKIP countermeasures. When these are enabled, the driver
1515 * should drop all received and queued frames that are using TKIP.
1517 int (*set_countermeasures)(void *priv, int enabled);
1520 * deauthenticate - Request driver to deauthenticate
1521 * @priv: private driver interface data
1522 * @addr: peer address (BSSID of the AP)
1523 * @reason_code: 16-bit reason code to be sent in the deauthentication
1526 * Returns: 0 on success, -1 on failure
1528 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1531 * associate - Request driver to associate
1532 * @priv: private driver interface data
1533 * @params: association parameters
1535 * Returns: 0 on success, -1 on failure
1537 int (*associate)(void *priv,
1538 struct wpa_driver_associate_params *params);
1541 * add_pmkid - Add PMKSA cache entry to the driver
1542 * @priv: private driver interface data
1543 * @bssid: BSSID for the PMKSA cache entry
1544 * @pmkid: PMKID for the PMKSA cache entry
1546 * Returns: 0 on success, -1 on failure
1548 * This function is called when a new PMK is received, as a result of
1549 * either normal authentication or RSN pre-authentication.
1551 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1552 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1553 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1554 * driver_ops function does not need to be implemented. Likewise, if
1555 * the driver does not support WPA, this function is not needed.
1557 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1560 * remove_pmkid - Remove PMKSA cache entry to the driver
1561 * @priv: private driver interface data
1562 * @bssid: BSSID for the PMKSA cache entry
1563 * @pmkid: PMKID for the PMKSA cache entry
1565 * Returns: 0 on success, -1 on failure
1567 * This function is called when the supplicant drops a PMKSA cache
1568 * entry for any reason.
1570 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1571 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1572 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1573 * from wpa_supplicant, this driver_ops function does not need to be
1574 * implemented. Likewise, if the driver does not support WPA, this
1575 * function is not needed.
1577 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1580 * flush_pmkid - Flush PMKSA cache
1581 * @priv: private driver interface data
1583 * Returns: 0 on success, -1 on failure
1585 * This function is called when the supplicant drops all PMKSA cache
1586 * entries for any reason.
1588 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1589 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1590 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1591 * from wpa_supplicant, this driver_ops function does not need to be
1592 * implemented. Likewise, if the driver does not support WPA, this
1593 * function is not needed.
1595 int (*flush_pmkid)(void *priv);
1598 * get_capa - Get driver capabilities
1599 * @priv: private driver interface data
1601 * Returns: 0 on success, -1 on failure
1603 * Get driver/firmware/hardware capabilities.
1605 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1608 * poll - Poll driver for association information
1609 * @priv: private driver interface data
1611 * This is an option callback that can be used when the driver does not
1612 * provide event mechanism for association events. This is called when
1613 * receiving WPA EAPOL-Key messages that require association
1614 * information. The driver interface is supposed to generate associnfo
1615 * event before returning from this callback function. In addition, the
1616 * driver interface should generate an association event after having
1617 * sent out associnfo.
1619 void (*poll)(void *priv);
1622 * get_ifname - Get interface name
1623 * @priv: private driver interface data
1625 * Returns: Pointer to the interface name. This can differ from the
1626 * interface name used in init() call. Init() is called first.
1628 * This optional function can be used to allow the driver interface to
1629 * replace the interface name with something else, e.g., based on an
1630 * interface mapping from a more descriptive name.
1632 const char * (*get_ifname)(void *priv);
1635 * get_mac_addr - Get own MAC address
1636 * @priv: private driver interface data
1638 * Returns: Pointer to own MAC address or %NULL on failure
1640 * This optional function can be used to get the own MAC address of the
1641 * device from the driver interface code. This is only needed if the
1642 * l2_packet implementation for the OS does not provide easy access to
1644 const u8 * (*get_mac_addr)(void *priv);
1647 * send_eapol - Optional function for sending EAPOL packets
1648 * @priv: private driver interface data
1649 * @dest: Destination MAC address
1651 * @data: EAPOL packet starting with IEEE 802.1X header
1652 * @data_len: Size of the EAPOL packet
1654 * Returns: 0 on success, -1 on failure
1656 * This optional function can be used to override l2_packet operations
1657 * with driver specific functionality. If this function pointer is set,
1658 * l2_packet module is not used at all and the driver interface code is
1659 * responsible for receiving and sending all EAPOL packets. The
1660 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1661 * event. The driver interface is required to implement get_mac_addr()
1662 * handler if send_eapol() is used.
1664 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1665 const u8 *data, size_t data_len);
1668 * set_operstate - Sets device operating state to DORMANT or UP
1669 * @priv: private driver interface data
1670 * @state: 0 = dormant, 1 = up
1671 * Returns: 0 on success, -1 on failure
1673 * This is an optional function that can be used on operating systems
1674 * that support a concept of controlling network device state from user
1675 * space applications. This function, if set, gets called with
1676 * state = 1 when authentication has been completed and with state = 0
1677 * when connection is lost.
1679 int (*set_operstate)(void *priv, int state);
1682 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1683 * @priv: Private driver interface data
1684 * @addr: Address of the station for which to set protection (may be
1685 * %NULL for group keys)
1686 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1687 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1688 * Returns: 0 on success, -1 on failure
1690 * This is an optional function that can be used to set the driver to
1691 * require protection for Tx and/or Rx frames. This uses the layer
1692 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1693 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1694 * set protection operation; instead, they set protection implicitly
1695 * based on configured keys.
1697 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1701 * get_hw_feature_data - Get hardware support data (channels and rates)
1702 * @priv: Private driver interface data
1703 * @num_modes: Variable for returning the number of returned modes
1704 * flags: Variable for returning hardware feature flags
1705 * Returns: Pointer to allocated hardware data on success or %NULL on
1706 * failure. Caller is responsible for freeing this.
1708 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1713 * send_mlme - Send management frame from MLME
1714 * @priv: Private driver interface data
1715 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1716 * @data_len: Size of the management frame
1717 * @noack: Do not wait for this frame to be acked (disable retries)
1718 * Returns: 0 on success, -1 on failure
1720 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1724 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1725 * @priv: Private driver interface data
1726 * @md: Mobility domain (2 octets) (also included inside ies)
1727 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1728 * @ies_len: Length of FT IEs in bytes
1729 * Returns: 0 on success, -1 on failure
1731 * The supplicant uses this callback to let the driver know that keying
1732 * material for FT is available and that the driver can use the
1733 * provided IEs in the next message in FT authentication sequence.
1735 * This function is only needed for driver that support IEEE 802.11r
1736 * (Fast BSS Transition).
1738 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1742 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1743 * @priv: Private driver interface data
1744 * @action: Action field value
1745 * @target_ap: Target AP address
1746 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1747 * @ies_len: Length of FT IEs in bytes
1748 * Returns: 0 on success, -1 on failure
1750 * The supplicant uses this callback to request the driver to transmit
1751 * an FT Action frame (action category 6) for over-the-DS fast BSS
1754 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1755 const u8 *ies, size_t ies_len);
1758 * get_scan_results2 - Fetch the latest scan results
1759 * @priv: private driver interface data
1761 * Returns: Allocated buffer of scan results (caller is responsible for
1762 * freeing the data structure) on success, NULL on failure
1764 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1767 * set_country - Set country
1768 * @priv: Private driver interface data
1769 * @alpha2: country to which to switch to
1770 * Returns: 0 on success, -1 on failure
1772 * This function is for drivers which support some form
1773 * of setting a regulatory domain.
1775 int (*set_country)(void *priv, const char *alpha2);
1778 * get_country - Get country
1779 * @priv: Private driver interface data
1780 * @alpha2: Buffer for returning country code (at least 3 octets)
1781 * Returns: 0 on success, -1 on failure
1783 int (*get_country)(void *priv, char *alpha2);
1786 * global_init - Global driver initialization
1787 * Returns: Pointer to private data (global), %NULL on failure
1789 * This optional function is called to initialize the driver wrapper
1790 * for global data, i.e., data that applies to all interfaces. If this
1791 * function is implemented, global_deinit() will also need to be
1792 * implemented to free the private data. The driver will also likely
1793 * use init2() function instead of init() to get the pointer to global
1794 * data available to per-interface initializer.
1796 void * (*global_init)(void);
1799 * global_deinit - Global driver deinitialization
1800 * @priv: private driver global data from global_init()
1802 * Terminate any global driver related functionality and free the
1803 * global data structure.
1805 void (*global_deinit)(void *priv);
1808 * init2 - Initialize driver interface (with global data)
1809 * @ctx: context to be used when calling wpa_supplicant functions,
1810 * e.g., wpa_supplicant_event()
1811 * @ifname: interface name, e.g., wlan0
1812 * @global_priv: private driver global data from global_init()
1813 * Returns: Pointer to private data, %NULL on failure
1815 * This function can be used instead of init() if the driver wrapper
1818 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1821 * get_interfaces - Get information about available interfaces
1822 * @global_priv: private driver global data from global_init()
1823 * Returns: Allocated buffer of interface information (caller is
1824 * responsible for freeing the data structure) on success, NULL on
1827 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1830 * scan2 - Request the driver to initiate scan
1831 * @priv: private driver interface data
1832 * @params: Scan parameters
1834 * Returns: 0 on success, -1 on failure
1836 * Once the scan results are ready, the driver should report scan
1837 * results event for wpa_supplicant which will eventually request the
1838 * results with wpa_driver_get_scan_results2().
1840 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1843 * authenticate - Request driver to authenticate
1844 * @priv: private driver interface data
1845 * @params: authentication parameters
1846 * Returns: 0 on success, -1 on failure
1848 * This is an optional function that can be used with drivers that
1849 * support separate authentication and association steps, i.e., when
1850 * wpa_supplicant can act as the SME. If not implemented, associate()
1851 * function is expected to take care of IEEE 802.11 authentication,
1854 int (*authenticate)(void *priv,
1855 struct wpa_driver_auth_params *params);
1858 * set_ap - Set Beacon and Probe Response information for AP mode
1859 * @priv: Private driver interface data
1860 * @params: Parameters to use in AP mode
1862 * This function is used to configure Beacon template and/or extra IEs
1863 * to add for Beacon and Probe Response frames for the driver in
1864 * AP mode. The driver is responsible for building the full Beacon
1865 * frame by concatenating the head part with TIM IE generated by the
1866 * driver/firmware and finishing with the tail part. Depending on the
1867 * driver architectue, this can be done either by using the full
1868 * template or the set of additional IEs (e.g., WPS and P2P IE).
1869 * Similarly, Probe Response processing depends on the driver design.
1870 * If the driver (or firmware) takes care of replying to Probe Request
1871 * frames, the extra IEs provided here needs to be added to the Probe
1874 * Returns: 0 on success, -1 on failure
1876 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
1879 * set_acl - Set ACL in AP mode
1880 * @priv: Private driver interface data
1881 * @params: Parameters to configure ACL
1882 * Returns: 0 on success, -1 on failure
1884 * This is used only for the drivers which support MAC address ACL.
1886 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1889 * hapd_init - Initialize driver interface (hostapd only)
1890 * @hapd: Pointer to hostapd context
1891 * @params: Configuration for the driver wrapper
1892 * Returns: Pointer to private data, %NULL on failure
1894 * This function is used instead of init() or init2() when the driver
1895 * wrapper is used with hostapd.
1897 void * (*hapd_init)(struct hostapd_data *hapd,
1898 struct wpa_init_params *params);
1901 * hapd_deinit - Deinitialize driver interface (hostapd only)
1902 * @priv: Private driver interface data from hapd_init()
1904 void (*hapd_deinit)(void *priv);
1907 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1908 * @priv: Private driver interface data
1909 * @params: BSS parameters
1910 * Returns: 0 on success, -1 on failure
1912 * This is an optional function to configure the kernel driver to
1913 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1914 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1915 * always enabled and the driver uses set_ap() to set WPA/RSN IE
1916 * for Beacon frames.
1918 * DEPRECATED - use set_ap() instead
1920 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
1923 * set_privacy - Enable/disable privacy (AP only)
1924 * @priv: Private driver interface data
1925 * @enabled: 1 = privacy enabled, 0 = disabled
1926 * Returns: 0 on success, -1 on failure
1928 * This is an optional function to configure privacy field in the
1929 * kernel driver for Beacon frames. This can be left undefined (set to
1930 * %NULL) if the driver uses the Beacon template from set_ap().
1932 * DEPRECATED - use set_ap() instead
1934 int (*set_privacy)(void *priv, int enabled);
1937 * get_seqnum - Fetch the current TSC/packet number (AP only)
1938 * @ifname: The interface name (main or virtual)
1939 * @priv: Private driver interface data
1940 * @addr: MAC address of the station or %NULL for group keys
1942 * @seq: Buffer for returning the latest used TSC/packet number
1943 * Returns: 0 on success, -1 on failure
1945 * This function is used to fetch the last used TSC/packet number for
1946 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1947 * keys, so there is no strict requirement on implementing support for
1948 * unicast keys (i.e., addr != %NULL).
1950 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1954 * flush - Flush all association stations (AP only)
1955 * @priv: Private driver interface data
1956 * Returns: 0 on success, -1 on failure
1958 * This function requests the driver to disassociate all associated
1959 * stations. This function does not need to be implemented if the
1960 * driver does not process association frames internally.
1962 int (*flush)(void *priv);
1965 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1966 * @priv: Private driver interface data
1967 * @elem: Information elements
1968 * @elem_len: Length of the elem buffer in octets
1969 * Returns: 0 on success, -1 on failure
1971 * This is an optional function to add information elements in the
1972 * kernel driver for Beacon and Probe Response frames. This can be left
1973 * undefined (set to %NULL) if the driver uses the Beacon template from
1976 * DEPRECATED - use set_ap() instead
1978 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
1981 * read_sta_data - Fetch station data
1982 * @priv: Private driver interface data
1983 * @data: Buffer for returning station information
1984 * @addr: MAC address of the station
1985 * Returns: 0 on success, -1 on failure
1987 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1991 * hapd_send_eapol - Send an EAPOL packet (AP only)
1992 * @priv: private driver interface data
1993 * @addr: Destination MAC address
1994 * @data: EAPOL packet starting with IEEE 802.1X header
1995 * @data_len: Length of the EAPOL packet in octets
1996 * @encrypt: Whether the frame should be encrypted
1997 * @own_addr: Source MAC address
1998 * @flags: WPA_STA_* flags for the destination station
2000 * Returns: 0 on success, -1 on failure
2002 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2003 size_t data_len, int encrypt,
2004 const u8 *own_addr, u32 flags);
2007 * sta_deauth - Deauthenticate a station (AP only)
2008 * @priv: Private driver interface data
2009 * @own_addr: Source address and BSSID for the Deauthentication frame
2010 * @addr: MAC address of the station to deauthenticate
2011 * @reason: Reason code for the Deauthentiation frame
2012 * Returns: 0 on success, -1 on failure
2014 * This function requests a specific station to be deauthenticated and
2015 * a Deauthentication frame to be sent to it.
2017 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2021 * sta_disassoc - Disassociate a station (AP only)
2022 * @priv: Private driver interface data
2023 * @own_addr: Source address and BSSID for the Disassociation frame
2024 * @addr: MAC address of the station to disassociate
2025 * @reason: Reason code for the Disassociation frame
2026 * Returns: 0 on success, -1 on failure
2028 * This function requests a specific station to be disassociated and
2029 * a Disassociation frame to be sent to it.
2031 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2035 * sta_remove - Remove a station entry (AP only)
2036 * @priv: Private driver interface data
2037 * @addr: MAC address of the station to be removed
2038 * Returns: 0 on success, -1 on failure
2040 int (*sta_remove)(void *priv, const u8 *addr);
2043 * hapd_get_ssid - Get the current SSID (AP only)
2044 * @priv: Private driver interface data
2045 * @buf: Buffer for returning the SSID
2046 * @len: Maximum length of the buffer
2047 * Returns: Length of the SSID on success, -1 on failure
2049 * This function need not be implemented if the driver uses Beacon
2050 * template from set_ap() and does not reply to Probe Request frames.
2052 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2055 * hapd_set_ssid - Set SSID (AP only)
2056 * @priv: Private driver interface data
2058 * @len: Length of the SSID in octets
2059 * Returns: 0 on success, -1 on failure
2061 * DEPRECATED - use set_ap() instead
2063 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2066 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2067 * @priv: Private driver interface data
2068 * @enabled: 1 = countermeasures enabled, 0 = disabled
2069 * Returns: 0 on success, -1 on failure
2071 * This need not be implemented if the driver does not take care of
2072 * association processing.
2074 int (*hapd_set_countermeasures)(void *priv, int enabled);
2077 * sta_add - Add a station entry
2078 * @priv: Private driver interface data
2079 * @params: Station parameters
2080 * Returns: 0 on success, -1 on failure
2082 * This function is used to add a station entry to the driver once the
2083 * station has completed association. This is only used if the driver
2084 * does not take care of association processing.
2086 * With TDLS, this function is also used to add or set (params->set 1)
2087 * TDLS peer entries.
2089 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2092 * get_inact_sec - Get station inactivity duration (AP only)
2093 * @priv: Private driver interface data
2094 * @addr: Station address
2095 * Returns: Number of seconds station has been inactive, -1 on failure
2097 int (*get_inact_sec)(void *priv, const u8 *addr);
2100 * sta_clear_stats - Clear station statistics (AP only)
2101 * @priv: Private driver interface data
2102 * @addr: Station address
2103 * Returns: 0 on success, -1 on failure
2105 int (*sta_clear_stats)(void *priv, const u8 *addr);
2108 * set_freq - Set channel/frequency (AP only)
2109 * @priv: Private driver interface data
2110 * @freq: Channel parameters
2111 * Returns: 0 on success, -1 on failure
2113 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2116 * set_rts - Set RTS threshold
2117 * @priv: Private driver interface data
2118 * @rts: RTS threshold in octets
2119 * Returns: 0 on success, -1 on failure
2121 int (*set_rts)(void *priv, int rts);
2124 * set_frag - Set fragmentation threshold
2125 * @priv: Private driver interface data
2126 * @frag: Fragmentation threshold in octets
2127 * Returns: 0 on success, -1 on failure
2129 int (*set_frag)(void *priv, int frag);
2132 * sta_set_flags - Set station flags (AP only)
2133 * @priv: Private driver interface data
2134 * @addr: Station address
2135 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2136 * @flags_or: Bitmap of WPA_STA_* flags to add
2137 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2138 * Returns: 0 on success, -1 on failure
2140 int (*sta_set_flags)(void *priv, const u8 *addr,
2141 int total_flags, int flags_or, int flags_and);
2144 * set_tx_queue_params - Set TX queue parameters
2145 * @priv: Private driver interface data
2146 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2150 * @burst_time: Maximum length for bursting in 0.1 msec units
2152 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2153 int cw_max, int burst_time);
2156 * if_add - Add a virtual interface
2157 * @priv: Private driver interface data
2158 * @type: Interface type
2159 * @ifname: Interface name for the new virtual interface
2160 * @addr: Local address to use for the interface or %NULL to use the
2161 * parent interface address
2162 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2163 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2164 * not allowed (applies only to %WPA_IF_AP_BSS type)
2165 * @force_ifname: Buffer for returning an interface name that the
2166 * driver ended up using if it differs from the requested ifname
2167 * @if_addr: Buffer for returning the allocated interface address
2168 * (this may differ from the requested addr if the driver cannot
2169 * change interface address)
2170 * @bridge: Bridge interface to use or %NULL if no bridge configured
2171 * @use_existing: Whether to allow existing interface to be used
2172 * Returns: 0 on success, -1 on failure
2174 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2175 const char *ifname, const u8 *addr, void *bss_ctx,
2176 void **drv_priv, char *force_ifname, u8 *if_addr,
2177 const char *bridge, int use_existing);
2180 * if_remove - Remove a virtual interface
2181 * @priv: Private driver interface data
2182 * @type: Interface type
2183 * @ifname: Interface name of the virtual interface to be removed
2184 * Returns: 0 on success, -1 on failure
2186 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2187 const char *ifname);
2190 * set_sta_vlan - Bind a station into a specific interface (AP only)
2191 * @priv: Private driver interface data
2192 * @ifname: Interface (main or virtual BSS or VLAN)
2193 * @addr: MAC address of the associated station
2195 * Returns: 0 on success, -1 on failure
2197 * This function is used to bind a station to a specific virtual
2198 * interface. It is only used if when virtual interfaces are supported,
2199 * e.g., to assign stations to different VLAN interfaces based on
2200 * information from a RADIUS server. This allows separate broadcast
2201 * domains to be used with a single BSS.
2203 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2207 * commit - Optional commit changes handler (AP only)
2208 * @priv: driver private data
2209 * Returns: 0 on success, -1 on failure
2211 * This optional handler function can be registered if the driver
2212 * interface implementation needs to commit changes (e.g., by setting
2213 * network interface up) at the end of initial configuration. If set,
2214 * this handler will be called after initial setup has been completed.
2216 int (*commit)(void *priv);
2219 * send_ether - Send an ethernet packet (AP only)
2220 * @priv: private driver interface data
2221 * @dst: Destination MAC address
2222 * @src: Source MAC address
2224 * @data: EAPOL packet starting with IEEE 802.1X header
2225 * @data_len: Length of the EAPOL packet in octets
2226 * Returns: 0 on success, -1 on failure
2228 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2229 const u8 *data, size_t data_len);
2232 * set_radius_acl_auth - Notification of RADIUS ACL change
2233 * @priv: Private driver interface data
2234 * @mac: MAC address of the station
2235 * @accepted: Whether the station was accepted
2236 * @session_timeout: Session timeout for the station
2237 * Returns: 0 on success, -1 on failure
2239 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2240 u32 session_timeout);
2243 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2244 * @priv: Private driver interface data
2245 * @mac: MAC address of the station
2246 * Returns: 0 on success, -1 on failure
2248 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2251 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2252 * @priv: Private driver interface data
2253 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2254 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2256 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2257 * to remove extra IE(s)
2258 * Returns: 0 on success, -1 on failure
2260 * This is an optional function to add WPS IE in the kernel driver for
2261 * Beacon and Probe Response frames. This can be left undefined (set
2262 * to %NULL) if the driver uses the Beacon template from set_ap()
2263 * and does not process Probe Request frames. If the driver takes care
2264 * of (Re)Association frame processing, the assocresp buffer includes
2265 * WPS IE(s) that need to be added to (Re)Association Response frames
2266 * whenever a (Re)Association Request frame indicated use of WPS.
2268 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2269 * frames when operating as a GO. The driver is responsible for adding
2270 * timing related attributes (e.g., NoA) in addition to the IEs
2271 * included here by appending them after these buffers. This call is
2272 * also used to provide Probe Response IEs for P2P Listen state
2273 * operations for drivers that generate the Probe Response frames
2276 * DEPRECATED - use set_ap() instead
2278 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2279 const struct wpabuf *proberesp,
2280 const struct wpabuf *assocresp);
2283 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2284 * @priv: Private driver interface data
2285 * @authorized: Whether the port is authorized
2286 * Returns: 0 on success, -1 on failure
2288 int (*set_supp_port)(void *priv, int authorized);
2291 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2292 * @priv: Private driver interface data
2293 * @addr: MAC address of the associated station
2294 * @aid: Association ID
2295 * @val: 1 = bind to 4-address WDS; 0 = unbind
2296 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2297 * to indicate that bridge is not to be used
2298 * @ifname_wds: Buffer to return the interface name for the new WDS
2299 * station or %NULL to indicate name is not returned.
2300 * Returns: 0 on success, -1 on failure
2302 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2303 const char *bridge_ifname, char *ifname_wds);
2306 * send_action - Transmit an Action frame
2307 * @priv: Private driver interface data
2308 * @freq: Frequency (in MHz) of the channel
2309 * @wait: Time to wait off-channel for a response (in ms), or zero
2310 * @dst: Destination MAC address (Address 1)
2311 * @src: Source MAC address (Address 2)
2312 * @bssid: BSSID (Address 3)
2314 * @data_len: data length in octets
2315 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2316 * Returns: 0 on success, -1 on failure
2318 * This command can be used to request the driver to transmit an action
2319 * frame to the specified destination.
2321 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2322 * be transmitted on the given channel and the device will wait for a
2323 * response on that channel for the given wait time.
2325 * If the flag is not set, the wait time will be ignored. In this case,
2326 * if a remain-on-channel duration is in progress, the frame must be
2327 * transmitted on that channel; alternatively the frame may be sent on
2328 * the current operational channel (if in associated state in station
2329 * mode or while operating as an AP.)
2331 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2332 const u8 *dst, const u8 *src, const u8 *bssid,
2333 const u8 *data, size_t data_len, int no_cck);
2336 * send_action_cancel_wait - Cancel action frame TX wait
2337 * @priv: Private driver interface data
2339 * This command cancels the wait time associated with sending an action
2340 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2341 * set in the driver flags.
2343 void (*send_action_cancel_wait)(void *priv);
2346 * remain_on_channel - Remain awake on a channel
2347 * @priv: Private driver interface data
2348 * @freq: Frequency (in MHz) of the channel
2349 * @duration: Duration in milliseconds
2350 * Returns: 0 on success, -1 on failure
2352 * This command is used to request the driver to remain awake on the
2353 * specified channel for the specified duration and report received
2354 * Action frames with EVENT_RX_MGMT events. Optionally, received
2355 * Probe Request frames may also be requested to be reported by calling
2356 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2358 * The driver may not be at the requested channel when this function
2359 * returns, i.e., the return code is only indicating whether the
2360 * request was accepted. The caller will need to wait until the
2361 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2362 * completed the channel change. This may take some time due to other
2363 * need for the radio and the caller should be prepared to timing out
2364 * its wait since there are no guarantees on when this request can be
2367 int (*remain_on_channel)(void *priv, unsigned int freq,
2368 unsigned int duration);
2371 * cancel_remain_on_channel - Cancel remain-on-channel operation
2372 * @priv: Private driver interface data
2374 * This command can be used to cancel a remain-on-channel operation
2375 * before its originally requested duration has passed. This could be
2376 * used, e.g., when remain_on_channel() is used to request extra time
2377 * to receive a response to an Action frame and the response is
2378 * received when there is still unneeded time remaining on the
2379 * remain-on-channel operation.
2381 int (*cancel_remain_on_channel)(void *priv);
2384 * probe_req_report - Request Probe Request frames to be indicated
2385 * @priv: Private driver interface data
2386 * @report: Whether to report received Probe Request frames
2387 * Returns: 0 on success, -1 on failure (or if not supported)
2389 * This command can be used to request the driver to indicate when
2390 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2391 * Since this operation may require extra resources, e.g., due to less
2392 * optimal hardware/firmware RX filtering, many drivers may disable
2393 * Probe Request reporting at least in station mode. This command is
2394 * used to notify the driver when the Probe Request frames need to be
2395 * reported, e.g., during remain-on-channel operations.
2397 int (*probe_req_report)(void *priv, int report);
2400 * deinit_ap - Deinitialize AP mode
2401 * @priv: Private driver interface data
2402 * Returns: 0 on success, -1 on failure (or if not supported)
2404 * This optional function can be used to disable AP mode related
2405 * configuration. If the interface was not dynamically added,
2406 * change the driver mode to station mode to allow normal station
2407 * operations like scanning to be completed.
2409 int (*deinit_ap)(void *priv);
2412 * deinit_p2p_cli - Deinitialize P2P client mode
2413 * @priv: Private driver interface data
2414 * Returns: 0 on success, -1 on failure (or if not supported)
2416 * This optional function can be used to disable P2P client mode. If the
2417 * interface was not dynamically added, change the interface type back
2420 int (*deinit_p2p_cli)(void *priv);
2423 * suspend - Notification on system suspend/hibernate event
2424 * @priv: Private driver interface data
2426 void (*suspend)(void *priv);
2429 * resume - Notification on system resume/thaw event
2430 * @priv: Private driver interface data
2432 void (*resume)(void *priv);
2435 * signal_monitor - Set signal monitoring parameters
2436 * @priv: Private driver interface data
2437 * @threshold: Threshold value for signal change events; 0 = disabled
2438 * @hysteresis: Minimum change in signal strength before indicating a
2440 * Returns: 0 on success, -1 on failure (or if not supported)
2442 * This function can be used to configure monitoring of signal strength
2443 * with the current AP. Whenever signal strength drops below the
2444 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2445 * should be generated assuming the signal strength has changed at
2446 * least %hysteresis from the previously indicated signal change event.
2448 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2451 * send_frame - Send IEEE 802.11 frame (testing use only)
2452 * @priv: Private driver interface data
2453 * @data: IEEE 802.11 frame with IEEE 802.11 header
2454 * @data_len: Size of the frame
2455 * @encrypt: Whether to encrypt the frame (if keys are set)
2456 * Returns: 0 on success, -1 on failure
2458 * This function is only used for debugging purposes and is not
2459 * required to be implemented for normal operations.
2461 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2465 * shared_freq - Get operating frequency of shared interface(s)
2466 * @priv: Private driver interface data
2467 * Returns: Operating frequency in MHz, 0 if no shared operation in
2468 * use, or -1 on failure
2470 * This command can be used to request the current operating frequency
2471 * of any virtual interface that shares the same radio to provide
2472 * information for channel selection for other virtual interfaces.
2474 int (*shared_freq)(void *priv);
2477 * get_noa - Get current Notice of Absence attribute payload
2478 * @priv: Private driver interface data
2479 * @buf: Buffer for returning NoA
2480 * @buf_len: Buffer length in octets
2481 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2482 * advertized, or -1 on failure
2484 * This function is used to fetch the current Notice of Absence
2485 * attribute value from GO.
2487 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2490 * set_noa - Set Notice of Absence parameters for GO (testing)
2491 * @priv: Private driver interface data
2493 * @start: Start time in ms from next TBTT
2494 * @duration: Duration in ms
2495 * Returns: 0 on success or -1 on failure
2497 * This function is used to set Notice of Absence parameters for GO. It
2498 * is used only for testing. To disable NoA, all parameters are set to
2501 int (*set_noa)(void *priv, u8 count, int start, int duration);
2504 * set_p2p_powersave - Set P2P power save options
2505 * @priv: Private driver interface data
2506 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2507 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2508 * @ctwindow: 0.. = change (msec), -1 = no change
2509 * Returns: 0 on success or -1 on failure
2511 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2515 * ampdu - Enable/disable aggregation
2516 * @priv: Private driver interface data
2517 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2518 * Returns: 0 on success or -1 on failure
2520 int (*ampdu)(void *priv, int ampdu);
2523 * get_radio_name - Get physical radio name for the device
2524 * @priv: Private driver interface data
2525 * Returns: Radio name or %NULL if not known
2527 * The returned data must not be modified by the caller. It is assumed
2528 * that any interface that has the same radio name as another is
2529 * sharing the same physical radio. This information can be used to
2530 * share scan results etc. information between the virtual interfaces
2531 * to speed up various operations.
2533 const char * (*get_radio_name)(void *priv);
2536 * send_tdls_mgmt - for sending TDLS management packets
2537 * @priv: private driver interface data
2538 * @dst: Destination (peer) MAC address
2539 * @action_code: TDLS action code for the mssage
2540 * @dialog_token: Dialog Token to use in the message (if needed)
2541 * @status_code: Status Code or Reason Code to use (if needed)
2542 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2543 * @initiator: Is the current end the TDLS link initiator
2544 * @buf: TDLS IEs to add to the message
2545 * @len: Length of buf in octets
2546 * Returns: 0 on success, negative (<0) on failure
2548 * This optional function can be used to send packet to driver which is
2549 * responsible for receiving and sending all TDLS packets.
2551 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2552 u8 dialog_token, u16 status_code, u32 peer_capab,
2553 int initiator, const u8 *buf, size_t len);
2556 * tdls_oper - Ask the driver to perform high-level TDLS operations
2557 * @priv: Private driver interface data
2558 * @oper: TDLS high-level operation. See %enum tdls_oper
2559 * @peer: Destination (peer) MAC address
2560 * Returns: 0 on success, negative (<0) on failure
2562 * This optional function can be used to send high-level TDLS commands
2565 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2568 * wnm_oper - Notify driver of the WNM frame reception
2569 * @priv: Private driver interface data
2570 * @oper: WNM operation. See %enum wnm_oper
2571 * @peer: Destination (peer) MAC address
2572 * @buf: Buffer for the driver to fill in (for getting IE)
2573 * @buf_len: Return the len of buf
2574 * Returns: 0 on success, negative (<0) on failure
2576 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2577 u8 *buf, u16 *buf_len);
2580 * set_qos_map - Set QoS Map
2581 * @priv: Private driver interface data
2582 * @qos_map_set: QoS Map
2583 * @qos_map_set_len: Length of QoS Map
2585 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2586 u8 qos_map_set_len);
2589 * set_wowlan - Set wake-on-wireless triggers
2590 * @priv: Private driver interface data
2591 * @triggers: wowlan triggers
2593 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2596 * signal_poll - Get current connection information
2597 * @priv: Private driver interface data
2598 * @signal_info: Connection info structure
2600 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2603 * set_authmode - Set authentication algorithm(s) for static WEP
2604 * @priv: Private driver interface data
2605 * @authmode: 1=Open System, 2=Shared Key, 3=both
2606 * Returns: 0 on success, -1 on failure
2608 * This function can be used to set authentication algorithms for AP
2609 * mode when static WEP is used. If the driver uses user space MLME/SME
2610 * implementation, there is no need to implement this function.
2612 * DEPRECATED - use set_ap() instead
2614 int (*set_authmode)(void *priv, int authmode);
2618 * driver_cmd - Execute driver-specific command
2619 * @priv: Private driver interface data
2620 * @cmd: Command to execute
2621 * @buf: Return buffer
2622 * @buf_len: Buffer length
2623 * Returns: 0 on success, -1 on failure
2625 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2626 #endif /* ANDROID */
2629 * vendor_cmd - Execute vendor specific command
2630 * @priv: Private driver interface data
2631 * @vendor_id: Vendor id
2632 * @subcmd: Vendor command id
2633 * @data: Vendor command parameters (%NULL if no parameters)
2634 * @data_len: Data length
2635 * @buf: Return buffer (%NULL to ignore reply)
2636 * Returns: 0 on success, negative (<0) on failure
2638 * This function handles vendor specific commands that are passed to
2639 * the driver/device. The command is identified by vendor id and
2640 * command id. Parameters can be passed as argument to the command
2641 * in the data buffer. Reply (if any) will be filled in the supplied
2644 * The exact driver behavior is driver interface and vendor specific. As
2645 * an example, this will be converted to a vendor specific cfg80211
2646 * command in case of the nl80211 driver interface.
2648 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2649 unsigned int subcmd, const u8 *data, size_t data_len,
2650 struct wpabuf *buf);
2653 * set_rekey_info - Set rekey information
2654 * @priv: Private driver interface data
2657 * @replay_ctr: Current EAPOL-Key Replay Counter
2659 * This optional function can be used to provide information for the
2660 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2661 * while the host (including wpa_supplicant) is sleeping.
2663 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2664 const u8 *replay_ctr);
2667 * sta_assoc - Station association indication
2668 * @priv: Private driver interface data
2669 * @own_addr: Source address and BSSID for association frame
2670 * @addr: MAC address of the station to associate
2671 * @reassoc: flag to indicate re-association
2672 * @status: association response status code
2673 * @ie: assoc response ie buffer
2674 * @len: ie buffer length
2675 * Returns: 0 on success, -1 on failure
2677 * This function indicates the driver to send (Re)Association
2678 * Response frame to the station.
2680 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2681 int reassoc, u16 status, const u8 *ie, size_t len);
2684 * sta_auth - Station authentication indication
2685 * @priv: Private driver interface data
2686 * @own_addr: Source address and BSSID for authentication frame
2687 * @addr: MAC address of the station to associate
2688 * @seq: authentication sequence number
2689 * @status: authentication response status code
2690 * @ie: authentication frame ie buffer
2691 * @len: ie buffer length
2693 * This function indicates the driver to send Authentication frame
2696 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2697 u16 seq, u16 status, const u8 *ie, size_t len);
2700 * add_tspec - Add traffic stream
2701 * @priv: Private driver interface data
2702 * @addr: MAC address of the station to associate
2703 * @tspec_ie: tspec ie buffer
2704 * @tspec_ielen: tspec ie length
2705 * Returns: 0 on success, -1 on failure
2707 * This function adds the traffic steam for the station
2708 * and fills the medium_time in tspec_ie.
2710 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2711 size_t tspec_ielen);
2714 * add_sta_node - Add a station node in the driver
2715 * @priv: Private driver interface data
2716 * @addr: MAC address of the station to add
2717 * @auth_alg: authentication algorithm used by the station
2718 * Returns: 0 on success, -1 on failure
2720 * This function adds the station node in the driver, when
2721 * the station gets added by FT-over-DS.
2723 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2726 * sched_scan - Request the driver to initiate scheduled scan
2727 * @priv: Private driver interface data
2728 * @params: Scan parameters
2729 * @interval: Interval between scan cycles in milliseconds
2730 * Returns: 0 on success, -1 on failure
2732 * This operation should be used for scheduled scan offload to
2733 * the hardware. Every time scan results are available, the
2734 * driver should report scan results event for wpa_supplicant
2735 * which will eventually request the results with
2736 * wpa_driver_get_scan_results2(). This operation is optional
2737 * and if not provided or if it returns -1, we fall back to
2738 * normal host-scheduled scans.
2740 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2744 * stop_sched_scan - Request the driver to stop a scheduled scan
2745 * @priv: Private driver interface data
2746 * Returns: 0 on success, -1 on failure
2748 * This should cause the scheduled scan to be stopped and
2749 * results should stop being sent. Must be supported if
2750 * sched_scan is supported.
2752 int (*stop_sched_scan)(void *priv);
2755 * poll_client - Probe (null data or such) the given station
2756 * @priv: Private driver interface data
2757 * @own_addr: MAC address of sending interface
2758 * @addr: MAC address of the station to probe
2759 * @qos: Indicates whether station is QoS station
2761 * This function is used to verify whether an associated station is
2762 * still present. This function does not need to be implemented if the
2763 * driver provides such inactivity polling mechanism.
2765 void (*poll_client)(void *priv, const u8 *own_addr,
2766 const u8 *addr, int qos);
2769 * radio_disable - Disable/enable radio
2770 * @priv: Private driver interface data
2771 * @disabled: 1=disable 0=enable radio
2772 * Returns: 0 on success, -1 on failure
2774 * This optional command is for testing purposes. It can be used to
2775 * disable the radio on a testbed device to simulate out-of-radio-range
2778 int (*radio_disable)(void *priv, int disabled);
2781 * switch_channel - Announce channel switch and migrate the GO to the
2783 * @priv: Private driver interface data
2784 * @settings: Settings for CSA period and new channel
2785 * Returns: 0 on success, -1 on failure
2787 * This function is used to move the GO to the legacy STA channel to
2788 * avoid frequency conflict in single channel concurrency.
2790 int (*switch_channel)(void *priv, struct csa_settings *settings);
2793 * start_dfs_cac - Listen for radar interference on the channel
2794 * @priv: Private driver interface data
2795 * @freq: Channel parameters
2796 * Returns: 0 on success, -1 on failure
2798 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
2801 * stop_ap - Removes beacon from AP
2802 * @priv: Private driver interface data
2803 * Returns: 0 on success, -1 on failure (or if not supported)
2805 * This optional function can be used to disable AP mode related
2806 * configuration. Unlike deinit_ap, it does not change to station
2809 int (*stop_ap)(void *priv);
2812 * get_survey - Retrieve survey data
2813 * @priv: Private driver interface data
2814 * @freq: If set, survey data for the specified frequency is only
2815 * being requested. If not set, all survey data is requested.
2816 * Returns: 0 on success, -1 on failure
2818 * Use this to retrieve:
2820 * - the observed channel noise floor
2821 * - the amount of time we have spent on the channel
2822 * - the amount of time during which we have spent on the channel that
2823 * the radio has determined the medium is busy and we cannot
2825 * - the amount of time we have spent receiving data
2826 * - the amount of time we have spent transmitting data
2828 * This data can be used for spectrum heuristics. One example is
2829 * Automatic Channel Selection (ACS). The channel survey data is
2830 * kept on a linked list on the channel data, one entry is added
2831 * for each survey. The min_nf of the channel is updated for each
2834 int (*get_survey)(void *priv, unsigned int freq);
2837 * status - Get driver interface status information
2838 * @priv: Private driver interface data
2839 * @buf: Buffer for printing tou the status information
2840 * @buflen: Maximum length of the buffer
2841 * Returns: Length of written status information or -1 on failure
2843 int (*status)(void *priv, char *buf, size_t buflen);
2846 * roaming - Set roaming policy for driver-based BSS selection
2847 * @priv: Private driver interface data
2848 * @allowed: Whether roaming within ESS is allowed
2849 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
2850 * Returns: Length of written status information or -1 on failure
2852 * This optional callback can be used to update roaming policy from the
2853 * associate() command (bssid being set there indicates that the driver
2854 * should not roam before getting this roaming() call to allow roaming.
2855 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
2856 * capability, roaming policy is handled within wpa_supplicant and there
2857 * is no need to implement or react to this callback.
2859 int (*roaming)(void *priv, int allowed, const u8 *bssid);
2862 * set_mac_addr - Set MAC address
2863 * @priv: Private driver interface data
2864 * @addr: MAC address to use or %NULL for setting back to permanent
2865 * Returns: 0 on success, -1 on failure
2867 int (*set_mac_addr)(void *priv, const u8 *addr);
2869 #ifdef CONFIG_MACSEC
2870 int (*macsec_init)(void *priv, struct macsec_init_params *params);
2872 int (*macsec_deinit)(void *priv);
2875 * enable_protect_frames - Set protect frames status
2876 * @priv: Private driver interface data
2877 * @enabled: TRUE = protect frames enabled
2878 * FALSE = protect frames disabled
2879 * Returns: 0 on success, -1 on failure (or if not supported)
2881 int (*enable_protect_frames)(void *priv, Boolean enabled);
2884 * set_replay_protect - Set replay protect status and window size
2885 * @priv: Private driver interface data
2886 * @enabled: TRUE = replay protect enabled
2887 * FALSE = replay protect disabled
2888 * @window: replay window size, valid only when replay protect enabled
2889 * Returns: 0 on success, -1 on failure (or if not supported)
2891 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
2894 * set_current_cipher_suite - Set current cipher suite
2895 * @priv: Private driver interface data
2896 * @cs: EUI64 identifier
2897 * @cs_len: Length of the cs buffer in octets
2898 * Returns: 0 on success, -1 on failure (or if not supported)
2900 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
2904 * enable_controlled_port - Set controlled port status
2905 * @priv: Private driver interface data
2906 * @enabled: TRUE = controlled port enabled
2907 * FALSE = controlled port disabled
2908 * Returns: 0 on success, -1 on failure (or if not supported)
2910 int (*enable_controlled_port)(void *priv, Boolean enabled);
2913 * get_receive_lowest_pn - Get receive lowest pn
2914 * @priv: Private driver interface data
2915 * @channel: secure channel
2916 * @an: association number
2917 * @lowest_pn: lowest accept pn
2918 * Returns: 0 on success, -1 on failure (or if not supported)
2920 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
2924 * get_transmit_next_pn - Get transmit next pn
2925 * @priv: Private driver interface data
2926 * @channel: secure channel
2927 * @an: association number
2929 * Returns: 0 on success, -1 on failure (or if not supported)
2931 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
2935 * set_transmit_next_pn - Set transmit next pn
2936 * @priv: Private driver interface data
2937 * @channel: secure channel
2938 * @an: association number
2940 * Returns: 0 on success, -1 on failure (or if not supported)
2942 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
2946 * get_available_receive_sc - get available receive channel
2947 * @priv: Private driver interface data
2948 * @channel: secure channel
2949 * Returns: 0 on success, -1 on failure (or if not supported)
2951 int (*get_available_receive_sc)(void *priv, u32 *channel);
2954 * create_receive_sc - create secure channel for receiving
2955 * @priv: Private driver interface data
2956 * @channel: secure channel
2957 * @sci_addr: secure channel identifier - address
2958 * @sci_port: secure channel identifier - port
2959 * @conf_offset: confidentiality offset (0, 30, or 50)
2960 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
2962 * Returns: 0 on success, -1 on failure (or if not supported)
2964 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
2965 u16 sci_port, unsigned int conf_offset,
2969 * delete_receive_sc - delete secure connection for receiving
2970 * @priv: private driver interface data from init()
2971 * @channel: secure channel
2972 * Returns: 0 on success, -1 on failure
2974 int (*delete_receive_sc)(void *priv, u32 channel);
2977 * create_receive_sa - create secure association for receive
2978 * @priv: private driver interface data from init()
2979 * @channel: secure channel
2980 * @an: association number
2981 * @lowest_pn: the lowest packet number can be received
2982 * @sak: the secure association key
2983 * Returns: 0 on success, -1 on failure
2985 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
2986 u32 lowest_pn, const u8 *sak);
2989 * enable_receive_sa - enable the SA for receive
2990 * @priv: private driver interface data from init()
2991 * @channel: secure channel
2992 * @an: association number
2993 * Returns: 0 on success, -1 on failure
2995 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
2998 * disable_receive_sa - disable SA for receive
2999 * @priv: private driver interface data from init()
3000 * @channel: secure channel index
3001 * @an: association number
3002 * Returns: 0 on success, -1 on failure
3004 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3007 * get_available_transmit_sc - get available transmit channel
3008 * @priv: Private driver interface data
3009 * @channel: secure channel
3010 * Returns: 0 on success, -1 on failure (or if not supported)
3012 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3015 * create_transmit_sc - create secure connection for transmit
3016 * @priv: private driver interface data from init()
3017 * @channel: secure channel
3018 * @sci_addr: secure channel identifier - address
3019 * @sci_port: secure channel identifier - port
3020 * Returns: 0 on success, -1 on failure
3022 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3023 u16 sci_port, unsigned int conf_offset);
3026 * delete_transmit_sc - delete secure connection for transmit
3027 * @priv: private driver interface data from init()
3028 * @channel: secure channel
3029 * Returns: 0 on success, -1 on failure
3031 int (*delete_transmit_sc)(void *priv, u32 channel);
3034 * create_transmit_sa - create secure association for transmit
3035 * @priv: private driver interface data from init()
3036 * @channel: secure channel index
3037 * @an: association number
3038 * @next_pn: the packet number used as next transmit packet
3039 * @confidentiality: True if the SA is to provide confidentiality
3040 * as well as integrity
3041 * @sak: the secure association key
3042 * Returns: 0 on success, -1 on failure
3044 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3045 Boolean confidentiality, const u8 *sak);
3048 * enable_transmit_sa - enable SA for transmit
3049 * @priv: private driver interface data from init()
3050 * @channel: secure channel
3051 * @an: association number
3052 * Returns: 0 on success, -1 on failure
3054 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3057 * disable_transmit_sa - disable SA for transmit
3058 * @priv: private driver interface data from init()
3059 * @channel: secure channel
3060 * @an: association number
3061 * Returns: 0 on success, -1 on failure
3063 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3064 #endif /* CONFIG_MACSEC */
3067 * init_mesh - Driver specific initialization for mesh
3068 * @priv: Private driver interface data
3069 * Returns: 0 on success, -1 on failure
3071 int (*init_mesh)(void *priv);
3074 * join_mesh - Join a mesh network
3075 * @priv: Private driver interface data
3076 * @params: Mesh configuration parameters
3077 * Returns: 0 on success, -1 on failure
3079 int (*join_mesh)(void *priv,
3080 struct wpa_driver_mesh_join_params *params);
3083 * leave_mesh - Leave a mesh network
3084 * @priv: Private driver interface data
3085 * Returns 0 on success, -1 on failure
3087 int (*leave_mesh)(void *priv);
3092 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3094 enum wpa_event_type {
3096 * EVENT_ASSOC - Association completed
3098 * This event needs to be delivered when the driver completes IEEE
3099 * 802.11 association or reassociation successfully.
3100 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3101 * after this event has been generated. In addition, optional
3102 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3103 * more information about the association. If the driver interface gets
3104 * both of these events at the same time, it can also include the
3105 * assoc_info data in EVENT_ASSOC call.
3110 * EVENT_DISASSOC - Association lost
3112 * This event should be called when association is lost either due to
3113 * receiving deauthenticate or disassociate frame from the AP or when
3114 * sending either of these frames to the current AP. If the driver
3115 * supports separate deauthentication event, EVENT_DISASSOC should only
3116 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3117 * In AP mode, union wpa_event_data::disassoc_info is required.
3122 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3124 * This event must be delivered when a Michael MIC error is detected by
3125 * the local driver. Additional data for event processing is
3126 * provided with union wpa_event_data::michael_mic_failure. This
3127 * information is used to request new encyption key and to initiate
3128 * TKIP countermeasures if needed.
3130 EVENT_MICHAEL_MIC_FAILURE,
3133 * EVENT_SCAN_RESULTS - Scan results available
3135 * This event must be called whenever scan results are available to be
3136 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3137 * is expected to be used some time after struct wpa_driver_ops::scan()
3138 * is called. If the driver provides an unsolicited event when the scan
3139 * has been completed, this event can be used to trigger
3140 * EVENT_SCAN_RESULTS call. If such event is not available from the
3141 * driver, the driver wrapper code is expected to use a registered
3142 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3143 * scan is expected to be completed. Optional information about
3144 * completed scan can be provided with union wpa_event_data::scan_info.
3149 * EVENT_ASSOCINFO - Report optional extra information for association
3151 * This event can be used to report extra association information for
3152 * EVENT_ASSOC processing. This extra information includes IEs from
3153 * association frames and Beacon/Probe Response frames in union
3154 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3155 * EVENT_ASSOC. Alternatively, the driver interface can include
3156 * assoc_info data in the EVENT_ASSOC call if it has all the
3157 * information available at the same point.
3162 * EVENT_INTERFACE_STATUS - Report interface status changes
3164 * This optional event can be used to report changes in interface
3165 * status (interface added/removed) using union
3166 * wpa_event_data::interface_status. This can be used to trigger
3167 * wpa_supplicant to stop and re-start processing for the interface,
3168 * e.g., when a cardbus card is ejected/inserted.
3170 EVENT_INTERFACE_STATUS,
3173 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3175 * This event can be used to inform wpa_supplicant about candidates for
3176 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3177 * for scan request (ap_scan=2 mode), this event is required for
3178 * pre-authentication. If wpa_supplicant is performing scan request
3179 * (ap_scan=1), this event is optional since scan results can be used
3180 * to add pre-authentication candidates. union
3181 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3182 * candidate and priority of the candidate, e.g., based on the signal
3183 * strength, in order to try to pre-authenticate first with candidates
3184 * that are most likely targets for re-association.
3186 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3187 * on the candidate list. In addition, it can be called for the current
3188 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3189 * will automatically skip pre-authentication in cases where a valid
3190 * PMKSA exists. When more than one candidate exists, this event should
3191 * be generated once for each candidate.
3193 * Driver will be notified about successful pre-authentication with
3194 * struct wpa_driver_ops::add_pmkid() calls.
3196 EVENT_PMKID_CANDIDATE,
3199 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3201 * This event can be used to inform wpa_supplicant about desire to set
3202 * up secure direct link connection between two stations as defined in
3203 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3204 * STAKey negotiation. The caller will need to set peer address for the
3210 * EVENT_TDLS - Request TDLS operation
3212 * This event can be used to request a TDLS operation to be performed.
3217 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3219 * The driver is expected to report the received FT IEs from
3220 * FT authentication sequence from the AP. The FT IEs are included in
3221 * the extra information in union wpa_event_data::ft_ies.
3226 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3228 * The driver can use this event to inform wpa_supplicant about a STA
3229 * in an IBSS with which protected frames could be exchanged. This
3230 * event starts RSN authentication with the other STA to authenticate
3231 * the STA and set up encryption keys with it.
3233 EVENT_IBSS_RSN_START,
3236 * EVENT_AUTH - Authentication result
3238 * This event should be called when authentication attempt has been
3239 * completed. This is only used if the driver supports separate
3240 * authentication step (struct wpa_driver_ops::authenticate).
3241 * Information about authentication result is included in
3242 * union wpa_event_data::auth.
3247 * EVENT_DEAUTH - Authentication lost
3249 * This event should be called when authentication is lost either due
3250 * to receiving deauthenticate frame from the AP or when sending that
3251 * frame to the current AP.
3252 * In AP mode, union wpa_event_data::deauth_info is required.
3257 * EVENT_ASSOC_REJECT - Association rejected
3259 * This event should be called when (re)association attempt has been
3260 * rejected by the AP. Information about the association response is
3261 * included in union wpa_event_data::assoc_reject.
3266 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3268 EVENT_AUTH_TIMED_OUT,
3271 * EVENT_ASSOC_TIMED_OUT - Association timed out
3273 EVENT_ASSOC_TIMED_OUT,
3276 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
3281 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3283 EVENT_WPS_BUTTON_PUSHED,
3286 * EVENT_TX_STATUS - Report TX status
3291 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3293 EVENT_RX_FROM_UNKNOWN,
3296 * EVENT_RX_MGMT - Report RX of a management frame
3301 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3303 * This event is used to indicate when the driver has started the
3304 * requested remain-on-channel duration. Information about the
3305 * operation is included in union wpa_event_data::remain_on_channel.
3307 EVENT_REMAIN_ON_CHANNEL,
3310 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3312 * This event is used to indicate when the driver has completed
3313 * remain-on-channel duration, i.e., may noot be available on the
3314 * requested channel anymore. Information about the
3315 * operation is included in union wpa_event_data::remain_on_channel.
3317 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3320 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
3322 * This event is used only by driver_test.c and userspace MLME.
3327 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3329 * This event is used to indicate when a Probe Request frame has been
3330 * received. Information about the received frame is included in
3331 * union wpa_event_data::rx_probe_req. The driver is required to report
3332 * these events only after successfully completed probe_req_report()
3333 * commands to request the events (i.e., report parameter is non-zero)
3334 * in station mode. In AP mode, Probe Request frames should always be
3340 * EVENT_NEW_STA - New wired device noticed
3342 * This event is used to indicate that a new device has been detected
3343 * in a network that does not use association-like functionality (i.e.,
3344 * mainly wired Ethernet). This can be used to start EAPOL
3345 * authenticator when receiving a frame from a device. The address of
3346 * the device is included in union wpa_event_data::new_sta.
3351 * EVENT_EAPOL_RX - Report received EAPOL frame
3353 * When in AP mode with hostapd, this event is required to be used to
3354 * deliver the receive EAPOL frames from the driver. With
3355 * %wpa_supplicant, this event is used only if the send_eapol() handler
3356 * is used to override the use of l2_packet for EAPOL frame TX.
3361 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3363 * This event is used to indicate changes in the signal strength
3364 * observed in frames received from the current AP if signal strength
3365 * monitoring has been enabled with signal_monitor().
3367 EVENT_SIGNAL_CHANGE,
3370 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3372 * This event is used to indicate that the interface was enabled after
3373 * having been previously disabled, e.g., due to rfkill.
3375 EVENT_INTERFACE_ENABLED,
3378 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3380 * This event is used to indicate that the interface was disabled,
3381 * e.g., due to rfkill.
3383 EVENT_INTERFACE_DISABLED,
3386 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3388 * This event is used to indicate that the channel list has changed,
3389 * e.g., because of a regulatory domain change triggered by scan
3390 * results including an AP advertising a country code.
3392 EVENT_CHANNEL_LIST_CHANGED,
3395 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3397 * This event is used to indicate that the driver cannot maintain this
3398 * interface in its operation mode anymore. The most likely use for
3399 * this is to indicate that AP mode operation is not available due to
3400 * operating channel would need to be changed to a DFS channel when
3401 * the driver does not support radar detection and another virtual
3402 * interfaces caused the operating channel to change. Other similar
3403 * resource conflicts could also trigger this for station mode
3404 * interfaces. This event can be propagated when channel switching
3407 EVENT_INTERFACE_UNAVAILABLE,
3410 * EVENT_BEST_CHANNEL
3412 * Driver generates this event whenever it detects a better channel
3413 * (e.g., based on RSSI or channel use). This information can be used
3414 * to improve channel selection for a new AP/P2P group.
3419 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3421 * This event should be called when a Deauthentication frame is dropped
3422 * due to it not being protected (MFP/IEEE 802.11w).
3423 * union wpa_event_data::unprot_deauth is required to provide more
3424 * details of the frame.
3426 EVENT_UNPROT_DEAUTH,
3429 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3431 * This event should be called when a Disassociation frame is dropped
3432 * due to it not being protected (MFP/IEEE 802.11w).
3433 * union wpa_event_data::unprot_disassoc is required to provide more
3434 * details of the frame.
3436 EVENT_UNPROT_DISASSOC,
3439 * EVENT_STATION_LOW_ACK
3441 * Driver generates this event whenever it detected that a particular
3442 * station was lost. Detection can be through massive transmission
3443 * failures for example.
3445 EVENT_STATION_LOW_ACK,
3448 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3450 EVENT_IBSS_PEER_LOST,
3453 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3455 * This event carries the new replay counter to notify wpa_supplicant
3456 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3457 * completed Group Key Handshake while the host (including
3458 * wpa_supplicant was sleeping).
3460 EVENT_DRIVER_GTK_REKEY,
3463 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3465 EVENT_SCHED_SCAN_STOPPED,
3468 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3470 * This event indicates that the station responded to the poll
3471 * initiated with @poll_client.
3473 EVENT_DRIVER_CLIENT_POLL_OK,
3476 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3478 EVENT_EAPOL_TX_STATUS,
3481 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3483 * Described in wpa_event_data.ch_switch
3488 * EVENT_WNM - Request WNM operation
3490 * This event can be used to request a WNM operation to be performed.
3495 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3497 * This event indicates that the driver reported a connection failure
3498 * with the specified client (for example, max client reached, etc.) in
3501 EVENT_CONNECT_FAILED_REASON,
3504 * EVENT_RADAR_DETECTED - Notify of radar detection
3506 * A radar has been detected on the supplied frequency, hostapd should
3507 * react accordingly (e.g., change channel).
3509 EVENT_DFS_RADAR_DETECTED,
3512 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3514 * After a successful CAC, the channel can be marked clear and used.
3516 EVENT_DFS_CAC_FINISHED,
3519 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3521 * The CAC was not successful, and the channel remains in the previous
3522 * state. This may happen due to a radar beeing detected or other
3523 * external influences.
3525 EVENT_DFS_CAC_ABORTED,
3528 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3530 * The channel which was previously unavailable is now available again.
3532 EVENT_DFS_NOP_FINISHED,
3535 * EVENT_SURVEY - Received survey data
3537 * This event gets triggered when a driver query is issued for survey
3538 * data and the requested data becomes available. The returned data is
3539 * stored in struct survey_results. The results provide at most one
3540 * survey entry for each frequency and at minimum will provide one
3541 * survey entry for one frequency. The survey data can be os_malloc()'d
3542 * and then os_free()'d, so the event callback must only copy data.
3547 * EVENT_SCAN_STARTED - Scan started
3549 * This indicates that driver has started a scan operation either based
3550 * on a request from wpa_supplicant/hostapd or from another application.
3551 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3552 * completed (either successfully or by getting cancelled).
3557 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3559 * This event indicates a set of frequency ranges that should be avoided
3560 * to reduce issues due to interference or internal co-existence
3561 * information in the driver.
3563 EVENT_AVOID_FREQUENCIES,
3566 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3568 EVENT_NEW_PEER_CANDIDATE
3574 * struct freq_survey - Channel survey info
3576 * @ifidx: Interface index in which this survey was observed
3577 * @freq: Center of frequency of the surveyed channel
3578 * @nf: Channel noise floor in dBm
3579 * @channel_time: Amount of time in ms the radio spent on the channel
3580 * @channel_time_busy: Amount of time in ms the radio detected some signal
3581 * that indicated to the radio the channel was not clear
3582 * @channel_time_rx: Amount of time the radio spent receiving data
3583 * @channel_time_tx: Amount of time the radio spent transmitting data
3584 * @filled: bitmask indicating which fields have been reported, see
3585 * SURVEY_HAS_* defines.
3586 * @list: Internal list pointers
3588 struct freq_survey {
3593 u64 channel_time_busy;
3594 u64 channel_time_rx;
3595 u64 channel_time_tx;
3596 unsigned int filled;
3597 struct dl_list list;
3600 #define SURVEY_HAS_NF BIT(0)
3601 #define SURVEY_HAS_CHAN_TIME BIT(1)
3602 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3603 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3604 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3608 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3610 union wpa_event_data {
3612 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3614 * This structure is optional for EVENT_ASSOC calls and required for
3615 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3616 * driver interface does not need to generate separate EVENT_ASSOCINFO
3621 * reassoc - Flag to indicate association or reassociation
3626 * req_ies - (Re)Association Request IEs
3628 * If the driver generates WPA/RSN IE, this event data must be
3629 * returned for WPA handshake to have needed information. If
3630 * wpa_supplicant-generated WPA/RSN IE is used, this
3631 * information event is optional.
3633 * This should start with the first IE (fixed fields before IEs
3634 * are not included).
3639 * req_ies_len - Length of req_ies in bytes
3644 * resp_ies - (Re)Association Response IEs
3646 * Optional association data from the driver. This data is not
3647 * required WPA, but may be useful for some protocols and as
3648 * such, should be reported if this is available to the driver
3651 * This should start with the first IE (fixed fields before IEs
3652 * are not included).
3657 * resp_ies_len - Length of resp_ies in bytes
3659 size_t resp_ies_len;
3662 * beacon_ies - Beacon or Probe Response IEs
3664 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3665 * Probe Response frames from the current AP (i.e., the one
3666 * that the client just associated with). This information is
3667 * used to update WPA/RSN IE for the AP. If this field is not
3668 * set, the results from previous scan will be used. If no
3669 * data for the new AP is found, scan results will be requested
3670 * again (without scan request). At this point, the driver is
3671 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3674 * This should start with the first IE (fixed fields before IEs
3675 * are not included).
3677 const u8 *beacon_ies;
3680 * beacon_ies_len - Length of beacon_ies */
3681 size_t beacon_ies_len;
3684 * freq - Frequency of the operational channel in MHz
3689 * addr - Station address (for AP mode)
3694 * The following is the key management offload information
3697 * @key_replay_ctr_len
3705 * authorized - Status of key management offload,
3711 * key_replay_ctr - Key replay counter value last used
3712 * in a valid EAPOL-Key frame
3714 const u8 *key_replay_ctr;
3717 * key_replay_ctr_len - The length of key_replay_ctr
3719 size_t key_replay_ctr_len;
3722 * ptk_kck - The derived PTK KCK
3727 * ptk_kek_len - The length of ptk_kck
3732 * ptk_kek - The derived PTK KEK
3737 * ptk_kek_len - The length of ptk_kek
3743 * struct disassoc_info - Data for EVENT_DISASSOC events
3745 struct disassoc_info {
3747 * addr - Station address (for AP mode)
3752 * reason_code - Reason Code (host byte order) used in
3753 * Deauthentication frame
3758 * ie - Optional IE(s) in Disassociation frame
3763 * ie_len - Length of ie buffer in octets
3768 * locally_generated - Whether the frame was locally generated
3770 int locally_generated;
3774 * struct deauth_info - Data for EVENT_DEAUTH events
3776 struct deauth_info {
3778 * addr - Station address (for AP mode)
3783 * reason_code - Reason Code (host byte order) used in
3784 * Deauthentication frame
3789 * ie - Optional IE(s) in Deauthentication frame
3794 * ie_len - Length of ie buffer in octets
3799 * locally_generated - Whether the frame was locally generated
3801 int locally_generated;
3805 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3807 struct michael_mic_failure {
3810 } michael_mic_failure;
3813 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3815 struct interface_status {
3818 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3823 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3825 struct pmkid_candidate {
3826 /** BSSID of the PMKID candidate */
3828 /** Smaller the index, higher the priority */
3830 /** Whether RSN IE includes pre-authenticate flag */
3835 * struct stkstart - Data for EVENT_STKSTART
3842 * struct tdls - Data for EVENT_TDLS
3848 TDLS_REQUEST_TEARDOWN
3850 u16 reason_code; /* for teardown */
3854 * struct wnm - Data for EVENT_WNM
3872 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3874 * During FT (IEEE 802.11r) authentication sequence, the driver is
3875 * expected to use this event to report received FT IEs (MDIE, FTIE,
3876 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3877 * IEs for the next message will be delivered through the
3878 * struct wpa_driver_ops::update_ft_ies() callback.
3884 u8 target_ap[ETH_ALEN];
3885 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3887 /** Length of ric_ies buffer in octets */
3892 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3894 struct ibss_rsn_start {
3899 * struct auth_info - Data for EVENT_AUTH events
3905 u16 auth_transaction;
3912 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3914 struct assoc_reject {
3916 * bssid - BSSID of the AP that rejected association
3921 * resp_ies - (Re)Association Response IEs
3923 * Optional association data from the driver. This data is not
3924 * required WPA, but may be useful for some protocols and as
3925 * such, should be reported if this is available to the driver
3928 * This should start with the first IE (fixed fields before IEs
3929 * are not included).
3934 * resp_ies_len - Length of resp_ies in bytes
3936 size_t resp_ies_len;
3939 * status_code - Status Code from (Re)association Response
3944 struct timeout_event {
3949 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3958 * struct tx_status - Data for EVENT_TX_STATUS events
3970 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3972 struct rx_from_unknown {
3979 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3987 * drv_priv - Pointer to store driver private BSS information
3989 * If not set to NULL, this is used for comparison with
3990 * hostapd_data->drv_priv to determine which BSS should process
3996 * freq - Frequency (in MHz) on which the frame was received
4001 * ssi_signal - Signal strength in dBm (or 0 if not available)
4007 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4009 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4011 struct remain_on_channel {
4013 * freq - Channel frequency in MHz
4018 * duration - Duration to remain on the channel in milliseconds
4020 unsigned int duration;
4021 } remain_on_channel;
4024 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4025 * @aborted: Whether the scan was aborted
4026 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4027 * @num_freqs: Number of entries in freqs array
4028 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4030 * @num_ssids: Number of entries in ssids array
4036 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4041 * struct mlme_rx - Data for EVENT_MLME_RX events
4052 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4054 struct rx_probe_req {
4056 * sa - Source address of the received Probe Request frame
4061 * da - Destination address of the received Probe Request frame
4062 * or %NULL if not available
4067 * bssid - BSSID of the received Probe Request frame or %NULL
4073 * ie - IEs from the Probe Request body
4078 * ie_len - Length of ie buffer in octets
4083 * signal - signal strength in dBm (or 0 if not available)
4089 * struct new_sta - Data for EVENT_NEW_STA events
4096 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4105 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4107 struct wpa_signal_info signal_change;
4110 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4111 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4112 * @freq_5: Best 5 GHz band channel frequency in MHz
4113 * @freq_overall: Best channel frequency in MHz
4115 * 0 can be used to indicate no preference in either band.
4117 struct best_channel {
4123 struct unprot_deauth {
4129 struct unprot_disassoc {
4136 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4137 * @addr: station address
4144 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4146 struct ibss_peer_lost {
4151 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4153 struct driver_gtk_rekey {
4155 const u8 *replay_ctr;
4159 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4160 * @addr: station address
4162 struct client_poll {
4167 * struct eapol_tx_status
4168 * @dst: Original destination
4169 * @data: Data starting with IEEE 802.1X header (!)
4170 * @data_len: Length of data
4171 * @ack: Indicates ack or lost frame
4173 * This corresponds to hapd_send_eapol if the frame sent
4174 * there isn't just reported as EVENT_TX_STATUS.
4176 struct eapol_tx_status {
4185 * @freq: Frequency of new channel in MHz
4186 * @ht_enabled: Whether this is an HT channel
4187 * @ch_offset: Secondary channel offset
4188 * @ch_width: Channel width
4189 * @cf1: Center frequency 1
4190 * @cf2: Center frequency 2
4196 enum chan_width ch_width;
4202 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4203 * @addr: Remote client address
4204 * @code: Reason code for connection failure
4206 struct connect_failed_reason {
4212 } connect_failed_reason;
4215 * struct dfs_event - Data for radar detected events
4216 * @freq: Frequency of the channel in MHz
4222 enum chan_width chan_width;
4228 * survey_results - Survey result data for EVENT_SURVEY
4229 * @freq_filter: Requested frequency survey filter, 0 if request
4230 * was for all survey data
4231 * @survey_list: Linked list of survey data
4233 struct survey_results {
4234 unsigned int freq_filter;
4235 struct dl_list survey_list; /* struct freq_survey */
4239 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4240 * @initiator: Initiator of the regulatory change
4241 * @type: Regulatory change type
4242 * @alpha2: Country code (or "" if not available)
4244 struct channel_list_changed {
4245 enum reg_change_initiator initiator;
4248 } channel_list_changed;
4251 * freq_range - List of frequency ranges
4253 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4255 struct wpa_freq_range_list freq_range;
4260 * @peer: Peer address
4262 * @ie_len: Length of @ies
4264 * Notification of new candidate mesh peer.
4275 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4276 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4277 * with struct wpa_driver_ops::init()
4278 * @event: event type (defined above)
4279 * @data: possible extra data for the event
4281 * Driver wrapper code should call this function whenever an event is received
4284 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4285 union wpa_event_data *data);
4289 * The following inline functions are provided for convenience to simplify
4290 * event indication for some of the common events.
4293 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4294 size_t ielen, int reassoc)
4296 union wpa_event_data event;
4297 os_memset(&event, 0, sizeof(event));
4298 event.assoc_info.reassoc = reassoc;
4299 event.assoc_info.req_ies = ie;
4300 event.assoc_info.req_ies_len = ielen;
4301 event.assoc_info.addr = addr;
4302 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4305 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4307 union wpa_event_data event;
4308 os_memset(&event, 0, sizeof(event));
4309 event.disassoc_info.addr = addr;
4310 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4313 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4316 union wpa_event_data event;
4317 os_memset(&event, 0, sizeof(event));
4318 event.eapol_rx.src = src;
4319 event.eapol_rx.data = data;
4320 event.eapol_rx.data_len = data_len;
4321 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4324 /* driver_common.c */
4325 void wpa_scan_results_free(struct wpa_scan_results *res);
4327 /* Convert wpa_event_type to a string for logging */
4328 const char * event_to_string(enum wpa_event_type event);
4330 /* Convert chan_width to a string for logging and control interfaces */
4331 const char * channel_width_to_string(enum chan_width width);
4333 int ht_supported(const struct hostapd_hw_modes *mode);
4334 int vht_supported(const struct hostapd_hw_modes *mode);
4336 /* NULL terminated array of linked in driver wrappers */
4337 extern struct wpa_driver_ops *wpa_drivers[];
4339 #endif /* DRIVER_H */