2 * Driver interface definition
3 * Copyright (c) 2003-2014, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
8 * This file defines a driver interface used by both %wpa_supplicant and
9 * hostapd. The first part of the file defines data structures used in various
10 * driver operations. This is followed by the struct wpa_driver_ops that each
11 * driver wrapper will beed to define with callback functions for requesting
12 * driver operations. After this, there are definitions for driver event
13 * reporting with wpa_supplicant_event() and some convenience helper functions
14 * that can be used to report events.
20 #define WPA_SUPPLICANT_DRIVER_VERSION 4
22 #include "common/defs.h"
23 #include "utils/list.h"
25 #define HOSTAPD_CHAN_DISABLED 0x00000001
26 #define HOSTAPD_CHAN_NO_IR 0x00000002
27 #define HOSTAPD_CHAN_RADAR 0x00000008
28 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
29 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
30 #define HOSTAPD_CHAN_HT40 0x00000040
31 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
33 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
34 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
35 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
36 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
37 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
39 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
40 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
41 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
42 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
44 #define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
45 #define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
48 * enum reg_change_initiator - Regulatory change initiator
50 enum reg_change_initiator {
54 REGDOM_SET_BY_COUNTRY_IE,
59 * enum reg_type - Regulatory change types
65 REGDOM_TYPE_CUSTOM_WORLD,
66 REGDOM_TYPE_INTERSECTION,
70 * struct hostapd_channel_data - Channel information
72 struct hostapd_channel_data {
74 * chan - Channel number (IEEE 802.11)
79 * freq - Frequency in MHz
84 * flag - Channel flags (HOSTAPD_CHAN_*)
89 * max_tx_power - Regulatory transmit power limit in dBm
94 * survey_list - Linked list of surveys (struct freq_survey)
96 struct dl_list survey_list;
99 * min_nf - Minimum observed noise floor, in dBm, based on all
100 * surveyed channel data
106 * interference_factor - Computed interference factor on this
107 * channel (used internally in src/ap/acs.c; driver wrappers do not
110 long double interference_factor;
111 #endif /* CONFIG_ACS */
114 * dfs_cac_ms - DFS CAC time in milliseconds
116 unsigned int dfs_cac_ms;
119 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
120 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
123 * struct hostapd_hw_modes - Supported hardware mode information
125 struct hostapd_hw_modes {
127 * mode - Hardware mode
129 enum hostapd_hw_mode mode;
132 * num_channels - Number of entries in the channels array
137 * channels - Array of supported channels
139 struct hostapd_channel_data *channels;
142 * num_rates - Number of entries in the rates array
147 * rates - Array of supported rates in 100 kbps units
152 * ht_capab - HT (IEEE 802.11n) capabilities
157 * mcs_set - MCS (IEEE 802.11n) rate parameters
162 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
167 * vht_capab - VHT (IEEE 802.11ac) capabilities
172 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
176 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
180 #define IEEE80211_MODE_INFRA 0
181 #define IEEE80211_MODE_IBSS 1
182 #define IEEE80211_MODE_AP 2
183 #define IEEE80211_MODE_MESH 5
185 #define IEEE80211_CAP_ESS 0x0001
186 #define IEEE80211_CAP_IBSS 0x0002
187 #define IEEE80211_CAP_PRIVACY 0x0010
188 #define IEEE80211_CAP_RRM 0x1000
190 /* DMG (60 GHz) IEEE 802.11ad */
191 /* type - bits 0..1 */
192 #define IEEE80211_CAP_DMG_MASK 0x0003
193 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
194 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
195 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
197 #define WPA_SCAN_QUAL_INVALID BIT(0)
198 #define WPA_SCAN_NOISE_INVALID BIT(1)
199 #define WPA_SCAN_LEVEL_INVALID BIT(2)
200 #define WPA_SCAN_LEVEL_DBM BIT(3)
201 #define WPA_SCAN_AUTHENTICATED BIT(4)
202 #define WPA_SCAN_ASSOCIATED BIT(5)
205 * struct wpa_scan_res - Scan result for an BSS/IBSS
206 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
208 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
209 * @beacon_int: beacon interval in TUs (host byte order)
210 * @caps: capability information field in host byte order
211 * @qual: signal quality
212 * @noise: noise level
213 * @level: signal level
215 * @age: Age of the information in milliseconds (i.e., how many milliseconds
216 * ago the last Beacon or Probe Response frame was received)
217 * @ie_len: length of the following IE field in octets
218 * @beacon_ie_len: length of the following Beacon IE field in octets
220 * This structure is used as a generic format for scan results from the
221 * driver. Each driver interface implementation is responsible for converting
222 * the driver or OS specific scan results into this format.
224 * If the driver does not support reporting all IEs, the IE data structure is
225 * constructed of the IEs that are available. This field will also need to
226 * include SSID in IE format. All drivers are encouraged to be extended to
227 * report all IEs to make it easier to support future additions.
229 * This structure data is followed by ie_len octets of IEs from Probe Response
230 * frame (or if the driver does not indicate source of IEs, these may also be
231 * from Beacon frame). After the first set of IEs, another set of IEs may follow
232 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
234 struct wpa_scan_res {
246 size_t beacon_ie_len;
247 /* Followed by ie_len + beacon_ie_len octets of IE data */
251 * struct wpa_scan_results - Scan results
252 * @res: Array of pointers to allocated variable length scan result entries
253 * @num: Number of entries in the scan result array
254 * @fetch_time: Time when the results were fetched from the driver
256 struct wpa_scan_results {
257 struct wpa_scan_res **res;
259 struct os_reltime fetch_time;
263 * struct wpa_interface_info - Network interface information
264 * @next: Pointer to the next interface or NULL if this is the last one
265 * @ifname: Interface name that can be used with init() or init2()
266 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
268 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
269 * is not an allocated copy, i.e., get_interfaces() caller will not free
272 struct wpa_interface_info {
273 struct wpa_interface_info *next;
276 const char *drv_name;
279 #define WPAS_MAX_SCAN_SSIDS 16
282 * struct wpa_driver_scan_params - Scan parameters
283 * Data for struct wpa_driver_ops::scan2().
285 struct wpa_driver_scan_params {
287 * ssids - SSIDs to scan for
289 struct wpa_driver_scan_ssid {
291 * ssid - specific SSID to scan for (ProbeReq)
292 * %NULL or zero-length SSID is used to indicate active scan
293 * with wildcard SSID.
297 * ssid_len: Length of the SSID in octets
300 } ssids[WPAS_MAX_SCAN_SSIDS];
303 * num_ssids - Number of entries in ssids array
304 * Zero indicates a request for a passive scan.
309 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
314 * extra_ies_len - Length of extra_ies in octets
316 size_t extra_ies_len;
319 * freqs - Array of frequencies to scan or %NULL for all frequencies
321 * The frequency is set in MHz. The array is zero-terminated.
326 * filter_ssids - Filter for reporting SSIDs
328 * This optional parameter can be used to request the driver wrapper to
329 * filter scan results to include only the specified SSIDs. %NULL
330 * indicates that no filtering is to be done. This can be used to
331 * reduce memory needs for scan results in environments that have large
332 * number of APs with different SSIDs.
334 * The driver wrapper is allowed to take this allocated buffer into its
335 * own use by setting the pointer to %NULL. In that case, the driver
336 * wrapper is responsible for freeing the buffer with os_free() once it
337 * is not needed anymore.
339 struct wpa_driver_scan_filter {
345 * num_filter_ssids - Number of entries in filter_ssids array
347 size_t num_filter_ssids;
350 * filter_rssi - Filter by RSSI
352 * The driver may filter scan results in firmware to reduce host
353 * wakeups and thereby save power. Specify the RSSI threshold in s32
359 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
361 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
362 * Mbps from the support rates element(s) in the Probe Request frames
363 * and not to transmit the frames at any of those rates.
365 unsigned int p2p_probe:1;
368 * only_new_results - Request driver to report only new results
370 * This is used to request the driver to report only BSSes that have
371 * been detected after this scan request has been started, i.e., to
372 * flush old cached BSS entries.
374 unsigned int only_new_results:1;
377 * low_priority - Requests driver to use a lower scan priority
379 * This is used to request the driver to use a lower scan priority
380 * if it supports such a thing.
382 unsigned int low_priority:1;
385 * NOTE: Whenever adding new parameters here, please make sure
386 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
392 * struct wpa_driver_auth_params - Authentication parameters
393 * Data for struct wpa_driver_ops::authenticate().
395 struct wpa_driver_auth_params {
403 const u8 *wep_key[4];
404 size_t wep_key_len[4];
406 int local_state_change;
409 * p2p - Whether this connection is a P2P group
414 * sae_data - SAE elements for Authentication frame
416 * This buffer starts with the Authentication transaction sequence
417 * number field. If SAE is not used, this pointer is %NULL.
422 * sae_data_len - Length of sae_data buffer in octets
428 * enum wps_mode - WPS mode
432 * WPS_MODE_NONE - No WPS provisioning being used
437 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
442 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
448 * struct hostapd_freq_params - Channel parameters
450 struct hostapd_freq_params {
452 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
454 enum hostapd_hw_mode mode;
457 * freq - Primary channel center frequency in MHz
462 * channel - Channel number
467 * ht_enabled - Whether HT is enabled
472 * sec_channel_offset - Secondary channel offset for HT40
475 * -1 = HT40 enabled, secondary channel below primary,
476 * 1 = HT40 enabled, secondary channel above primary
478 int sec_channel_offset;
481 * vht_enabled - Whether VHT is enabled
486 * center_freq1 - Segment 0 center frequency in MHz
488 * Valid for both HT and VHT.
493 * center_freq2 - Segment 1 center frequency in MHz
495 * Non-zero only for bandwidth 80 and an 80+80 channel
500 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
506 * struct wpa_driver_associate_params - Association parameters
507 * Data for struct wpa_driver_ops::associate().
509 struct wpa_driver_associate_params {
511 * bssid - BSSID of the selected AP
512 * This can be %NULL, if ap_scan=2 mode is used and the driver is
513 * responsible for selecting with which BSS to associate. */
517 * bssid_hint - BSSID of a proposed AP
519 * This indicates which BSS has been found a suitable candidate for
520 * initial association for drivers that use driver/firmwate-based BSS
521 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
522 * the driver from selecting other BSSes in the ESS.
524 const u8 *bssid_hint;
527 * ssid - The selected SSID
532 * ssid_len - Length of the SSID (1..32)
537 * freq - channel parameters
539 struct hostapd_freq_params freq;
542 * freq_hint - Frequency of the channel the proposed AP is using
544 * This provides a channel on which a suitable BSS has been found as a
545 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
546 * limit the driver from selecting other channels for
547 * driver/firmware-based BSS selection.
552 * bg_scan_period - Background scan period in seconds, 0 to disable
553 * background scan, or -1 to indicate no change to default driver
559 * beacon_int - Beacon interval for IBSS or 0 to use driver default
564 * wpa_ie - WPA information element for (Re)Association Request
565 * WPA information element to be included in (Re)Association
566 * Request (including information element id and length). Use
567 * of this WPA IE is optional. If the driver generates the WPA
568 * IE, it can use pairwise_suite, group_suite, and
569 * key_mgmt_suite to select proper algorithms. In this case,
570 * the driver has to notify wpa_supplicant about the used WPA
571 * IE by generating an event that the interface code will
572 * convert into EVENT_ASSOCINFO data (see below).
574 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
575 * instead. The driver can determine which version is used by
576 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
579 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
584 * wpa_ie_len - length of the wpa_ie
589 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
591 unsigned int wpa_proto;
594 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
596 * This is usually ignored if @wpa_ie is used.
598 unsigned int pairwise_suite;
601 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
603 * This is usually ignored if @wpa_ie is used.
605 unsigned int group_suite;
608 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
610 * This is usually ignored if @wpa_ie is used.
612 unsigned int key_mgmt_suite;
615 * auth_alg - Allowed authentication algorithms
616 * Bit field of WPA_AUTH_ALG_*
621 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
626 * wep_key - WEP keys for static WEP configuration
628 const u8 *wep_key[4];
631 * wep_key_len - WEP key length for static WEP configuration
633 size_t wep_key_len[4];
636 * wep_tx_keyidx - WEP TX key index for static WEP configuration
641 * mgmt_frame_protection - IEEE 802.11w management frame protection
643 enum mfp_options mgmt_frame_protection;
646 * ft_ies - IEEE 802.11r / FT information elements
647 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
648 * for fast transition, this parameter is set to include the IEs that
649 * are to be sent in the next FT Authentication Request message.
650 * update_ft_ies() handler is called to update the IEs for further
651 * FT messages in the sequence.
653 * The driver should use these IEs only if the target AP is advertising
654 * the same mobility domain as the one included in the MDIE here.
656 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
657 * AP after the initial association. These IEs can only be used if the
658 * target AP is advertising support for FT and is using the same MDIE
659 * and SSID as the current AP.
661 * The driver is responsible for reporting the FT IEs received from the
662 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
663 * type. update_ft_ies() handler will then be called with the FT IEs to
664 * include in the next frame in the authentication sequence.
669 * ft_ies_len - Length of ft_ies in bytes
674 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
676 * This value is provided to allow the driver interface easier access
677 * to the current mobility domain. This value is set to %NULL if no
678 * mobility domain is currently active.
683 * passphrase - RSN passphrase for PSK
685 * This value is made available only for WPA/WPA2-Personal (PSK) and
686 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
687 * the 8..63 character ASCII passphrase, if available. Please note that
688 * this can be %NULL if passphrase was not used to generate the PSK. In
689 * that case, the psk field must be used to fetch the PSK.
691 const char *passphrase;
694 * psk - RSN PSK (alternative for passphrase for PSK)
696 * This value is made available only for WPA/WPA2-Personal (PSK) and
697 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
698 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
699 * be prepared to handle %NULL value as an error.
704 * drop_unencrypted - Enable/disable unencrypted frame filtering
706 * Configure the driver to drop all non-EAPOL frames (both receive and
707 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
708 * still be allowed for key negotiation.
710 int drop_unencrypted;
713 * prev_bssid - Previously used BSSID in this ESS
715 * When not %NULL, this is a request to use reassociation instead of
718 const u8 *prev_bssid;
723 * If the driver needs to do special configuration for WPS association,
724 * this variable provides more information on what type of association
725 * is being requested. Most drivers should not need ot use this.
730 * p2p - Whether this connection is a P2P group
735 * uapsd - UAPSD parameters for the network
736 * -1 = do not change defaults
737 * AP mode: 1 = enabled, 0 = disabled
738 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
743 * fixed_bssid - Whether to force this BSSID in IBSS mode
744 * 1 = Fix this BSSID and prevent merges.
745 * 0 = Do not fix BSSID.
750 * disable_ht - Disable HT (IEEE 802.11n) for this connection
755 * htcaps - HT Capabilities over-rides
757 * Only bits set in the mask will be used, and not all values are used
758 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
760 * Pointer to struct ieee80211_ht_capabilities.
765 * htcaps_mask - HT Capabilities over-rides mask
767 * Pointer to struct ieee80211_ht_capabilities.
769 const u8 *htcaps_mask;
771 #ifdef CONFIG_VHT_OVERRIDES
773 * disable_vht - Disable VHT for this connection
778 * VHT capability overrides.
780 const struct ieee80211_vht_capabilities *vhtcaps;
781 const struct ieee80211_vht_capabilities *vhtcaps_mask;
782 #endif /* CONFIG_VHT_OVERRIDES */
785 * req_key_mgmt_offload - Request key management offload for connection
787 * Request key management offload for this connection if the device
790 int req_key_mgmt_offload;
793 * Flag for indicating whether this association includes support for
794 * RRM (Radio Resource Measurements)
801 HIDDEN_SSID_ZERO_LEN,
802 HIDDEN_SSID_ZERO_CONTENTS
805 struct wowlan_triggers {
809 u8 gtk_rekey_failure;
811 u8 four_way_handshake;
815 struct wpa_driver_ap_params {
817 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
822 * head_len - Length of the head buffer in octets
827 * tail - Beacon tail following TIM IE
832 * tail_len - Length of the tail buffer in octets
837 * dtim_period - DTIM period
842 * beacon_int - Beacon interval
847 * basic_rates: -1 terminated array of basic rates in 100 kbps
849 * This parameter can be used to set a specific basic rate set for the
850 * BSS. If %NULL, default basic rate set is used.
855 * proberesp - Probe Response template
857 * This is used by drivers that reply to Probe Requests internally in
858 * AP mode and require the full Probe Response template.
863 * proberesp_len - Length of the proberesp buffer in octets
865 size_t proberesp_len;
868 * ssid - The SSID to use in Beacon/Probe Response frames
873 * ssid_len - Length of the SSID (1..32)
878 * hide_ssid - Whether to hide the SSID
880 enum hide_ssid hide_ssid;
883 * pairwise_ciphers - WPA_CIPHER_* bitfield
885 unsigned int pairwise_ciphers;
888 * group_cipher - WPA_CIPHER_*
890 unsigned int group_cipher;
893 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
895 unsigned int key_mgmt_suites;
898 * auth_algs - WPA_AUTH_ALG_* bitfield
900 unsigned int auth_algs;
903 * wpa_version - WPA_PROTO_* bitfield
905 unsigned int wpa_version;
908 * privacy - Whether privacy is used in the BSS
913 * beacon_ies - WPS/P2P IE(s) for Beacon frames
915 * This is used to add IEs like WPS IE and P2P IE by drivers that do
916 * not use the full Beacon template.
918 const struct wpabuf *beacon_ies;
921 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
923 * This is used to add IEs like WPS IE and P2P IE by drivers that
924 * reply to Probe Request frames internally.
926 const struct wpabuf *proberesp_ies;
929 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
931 * This is used to add IEs like WPS IE by drivers that reply to
932 * (Re)Association Request frames internally.
934 const struct wpabuf *assocresp_ies;
937 * isolate - Whether to isolate frames between associated stations
939 * If this is non-zero, the AP is requested to disable forwarding of
940 * frames between associated stations.
945 * cts_protect - Whether CTS protection is enabled
950 * preamble - Whether short preamble is enabled
955 * short_slot_time - Whether short slot time is enabled
957 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
958 * not set (e.g., when 802.11g mode is not in use)
963 * ht_opmode - HT operation mode or -1 if HT not in use
968 * interworking - Whether Interworking is enabled
973 * hessid - Homogeneous ESS identifier or %NULL if not set
978 * access_network_type - Access Network Type (0..15)
980 * This is used for filtering Probe Request frames when Interworking is
983 u8 access_network_type;
986 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
988 * This is used by driver which advertises this capability.
990 int ap_max_inactivity;
993 * smps_mode - SMPS mode
995 * SMPS mode to be used by the AP, specified as the relevant bits of
996 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
998 unsigned int smps_mode;
1001 * disable_dgaf - Whether group-addressed frames are disabled
1006 * osen - Whether OSEN security is enabled
1011 * freq - Channel parameters for dynamic bandwidth changes
1013 struct hostapd_freq_params *freq;
1016 struct wpa_driver_mesh_bss_params {
1017 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1019 * TODO: Other mesh configuration parameters would go here.
1020 * See NL80211_MESHCONF_* for all the mesh config parameters.
1025 struct wpa_driver_mesh_join_params {
1028 const int *basic_rates;
1034 enum ht_mode ht_mode;
1035 struct wpa_driver_mesh_bss_params conf;
1036 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1037 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1038 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1039 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1044 * struct wpa_driver_capa - Driver capability information
1046 struct wpa_driver_capa {
1047 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1048 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1049 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1050 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1051 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1052 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1053 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1054 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1055 /** Bitfield of supported key management suites */
1056 unsigned int key_mgmt;
1058 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1059 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1060 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1061 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1062 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1063 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1064 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1065 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1066 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1067 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1068 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1069 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1070 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1071 /** Bitfield of supported cipher suites */
1074 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1075 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1076 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1077 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1080 /** Driver generated WPA/RSN IE */
1081 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1082 /** Driver needs static WEP key setup after association command */
1083 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1084 /** Driver takes care of all DFS operations */
1085 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1086 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1087 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1088 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1089 /** Driver is for a wired Ethernet interface */
1090 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1091 /** Driver provides separate commands for authentication and association (SME in
1092 * wpa_supplicant). */
1093 #define WPA_DRIVER_FLAGS_SME 0x00000020
1094 /** Driver supports AP mode */
1095 #define WPA_DRIVER_FLAGS_AP 0x00000040
1096 /** Driver needs static WEP key setup after association has been completed */
1097 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1098 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1099 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1100 /** Driver supports concurrent P2P operations */
1101 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1103 * Driver uses the initial interface as a dedicated management interface, i.e.,
1104 * it cannot be used for P2P group operations or non-P2P purposes.
1106 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1107 /** This interface is P2P capable (P2P GO or P2P Client) */
1108 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1109 /** Driver supports station and key removal when stopping an AP */
1110 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1112 * Driver uses the initial interface for P2P management interface and non-P2P
1113 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1114 * P2P group operations.
1116 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1118 * Driver is known to use sane error codes, i.e., when it indicates that
1119 * something (e.g., association) fails, there was indeed a failure and the
1120 * operation does not end up getting completed successfully later.
1122 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1123 /** Driver supports off-channel TX */
1124 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1125 /** Driver indicates TX status events for EAPOL Data frames */
1126 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1127 /** Driver indicates TX status events for Deauth/Disassoc frames */
1128 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1129 /** Driver supports roaming (BSS selection) in firmware */
1130 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1131 /** Driver supports operating as a TDLS peer */
1132 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1133 /** Driver requires external TDLS setup/teardown/discovery */
1134 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1135 /** Driver indicates support for Probe Response offloading in AP mode */
1136 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1137 /** Driver supports U-APSD in AP mode */
1138 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1139 /** Driver supports inactivity timer in AP mode */
1140 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1141 /** Driver expects user space implementation of MLME in AP mode */
1142 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1143 /** Driver supports SAE with user space SME */
1144 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1145 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1146 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1147 /** Driver supports IBSS (Ad-hoc) mode */
1148 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1149 /** Driver supports radar detection */
1150 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1151 /** Driver supports a dedicated interface for P2P Device */
1152 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1153 /** Driver supports QoS Mapping */
1154 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1155 /** Driver supports CSA in AP mode */
1156 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1157 /** Driver supports mesh */
1158 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1159 /** Driver support ACS offload */
1160 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1161 /** Driver supports key management offload */
1162 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1163 /** Driver supports TDLS channel switching */
1164 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1167 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1168 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1169 unsigned int smps_modes;
1171 unsigned int wmm_ac_supported:1;
1173 /** Maximum number of supported active probe SSIDs */
1176 /** Maximum number of supported active probe SSIDs for sched_scan */
1177 int max_sched_scan_ssids;
1179 /** Whether sched_scan (offloaded scanning) is supported */
1180 int sched_scan_supported;
1182 /** Maximum number of supported match sets for sched_scan */
1186 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1188 unsigned int max_remain_on_chan;
1191 * max_stations - Maximum number of associated stations the driver
1192 * supports in AP mode
1194 unsigned int max_stations;
1197 * probe_resp_offloads - Bitmap of supported protocols by the driver
1198 * for Probe Response offloading.
1200 /** Driver Probe Response offloading support for WPS ver. 1 */
1201 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1202 /** Driver Probe Response offloading support for WPS ver. 2 */
1203 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1204 /** Driver Probe Response offloading support for P2P */
1205 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1206 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1207 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1208 unsigned int probe_resp_offloads;
1210 unsigned int max_acl_mac_addrs;
1213 * Number of supported concurrent channels
1215 unsigned int num_multichan_concurrent;
1218 * extended_capa - extended capabilities in driver/device
1220 * Must be allocated and freed by driver and the pointers must be
1221 * valid for the lifetime of the driver, i.e., freed in deinit()
1223 const u8 *extended_capa, *extended_capa_mask;
1224 unsigned int extended_capa_len;
1226 struct wowlan_triggers wowlan_triggers;
1228 /** Driver adds the DS Params Set IE in Probe Request frames */
1229 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1230 /** Driver adds the WFA TPC IE in Probe Request frames */
1231 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1232 /** Driver handles quiet period requests */
1233 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1235 * Driver is capable of inserting the current TX power value into the body of
1236 * transmitted frames.
1237 * Background: Some Action frames include a TPC Report IE. This IE contains a
1238 * TX power field, which has to be updated by lower layers. One such Action
1239 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1240 * of spectrum management). Note that this insertion takes place at a fixed
1241 * offset, namely the 6th byte in the Action frame body.
1243 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1248 struct hostapd_data;
1250 struct hostap_sta_driver_data {
1251 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1252 unsigned long current_tx_rate;
1253 unsigned long inactive_msec;
1254 unsigned long flags;
1255 unsigned long num_ps_buf_frames;
1256 unsigned long tx_retry_failed;
1257 unsigned long tx_retry_count;
1262 struct hostapd_sta_add_params {
1266 const u8 *supp_rates;
1267 size_t supp_rates_len;
1268 u16 listen_interval;
1269 const struct ieee80211_ht_capabilities *ht_capabilities;
1270 const struct ieee80211_vht_capabilities *vht_capabilities;
1271 int vht_opmode_enabled;
1273 u32 flags; /* bitmask of WPA_STA_* flags */
1274 u32 flags_mask; /* unset bits in flags */
1276 enum mesh_plink_state plink_state;
1277 #endif /* CONFIG_MESH */
1278 int set; /* Set STA parameters instead of add */
1280 const u8 *ext_capab;
1281 size_t ext_capab_len;
1282 const u8 *supp_channels;
1283 size_t supp_channels_len;
1284 const u8 *supp_oper_classes;
1285 size_t supp_oper_classes_len;
1288 struct mac_address {
1292 struct hostapd_acl_params {
1294 unsigned int num_mac_acl;
1295 struct mac_address mac_acl[0];
1298 enum wpa_driver_if_type {
1300 * WPA_IF_STATION - Station mode interface
1305 * WPA_IF_AP_VLAN - AP mode VLAN interface
1307 * This interface shares its address and Beacon frame with the main
1313 * WPA_IF_AP_BSS - AP mode BSS interface
1315 * This interface has its own address and Beacon frame.
1320 * WPA_IF_P2P_GO - P2P Group Owner
1325 * WPA_IF_P2P_CLIENT - P2P Client
1330 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1331 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1336 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1337 * abstracted P2P Device function in the driver
1342 * WPA_IF_MESH - Mesh interface
1347 struct wpa_init_params {
1351 const char *driver_params;
1352 int use_pae_group_addr;
1356 u8 *own_addr; /* buffer for writing own MAC address */
1360 struct wpa_bss_params {
1361 /** Interface name (for multi-SSID/VLAN support) */
1363 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1372 enum mfp_options ieee80211w;
1375 #define WPA_STA_AUTHORIZED BIT(0)
1376 #define WPA_STA_WMM BIT(1)
1377 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1378 #define WPA_STA_MFP BIT(3)
1379 #define WPA_STA_TDLS_PEER BIT(4)
1380 #define WPA_STA_AUTHENTICATED BIT(5)
1393 WNM_SLEEP_ENTER_CONFIRM,
1394 WNM_SLEEP_ENTER_FAIL,
1395 WNM_SLEEP_EXIT_CONFIRM,
1396 WNM_SLEEP_EXIT_FAIL,
1397 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1398 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1399 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1401 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1403 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1404 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1406 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1409 /* enum chan_width - Channel width definitions */
1421 * struct wpa_signal_info - Information about channel signal quality
1423 struct wpa_signal_info {
1425 int above_threshold;
1430 enum chan_width chanwidth;
1436 * struct beacon_data - Beacon data
1437 * @head: Head portion of Beacon frame (before TIM IE)
1438 * @tail: Tail portion of Beacon frame (after TIM IE)
1439 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1440 * @proberesp_ies: Extra information element(s) to add into Probe Response
1442 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1443 * Response frames or %NULL
1444 * @probe_resp: Probe Response frame template
1445 * @head_len: Length of @head
1446 * @tail_len: Length of @tail
1447 * @beacon_ies_len: Length of beacon_ies in octets
1448 * @proberesp_ies_len: Length of proberesp_ies in octets
1449 * @proberesp_ies_len: Length of proberesp_ies in octets
1450 * @probe_resp_len: Length of probe response template (@probe_resp)
1452 struct beacon_data {
1459 size_t head_len, tail_len;
1460 size_t beacon_ies_len;
1461 size_t proberesp_ies_len;
1462 size_t assocresp_ies_len;
1463 size_t probe_resp_len;
1467 * struct csa_settings - Settings for channel switch command
1468 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1469 * @block_tx: 1 - block transmission for CSA period
1470 * @freq_params: Next channel frequency parameter
1471 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1472 * @beacon_after: Next beacon/probe resp/asooc resp info
1473 * @counter_offset_beacon: Offset to the count field in beacon's tail
1474 * @counter_offset_presp: Offset to the count field in probe resp.
1476 struct csa_settings {
1480 struct hostapd_freq_params freq_params;
1481 struct beacon_data beacon_csa;
1482 struct beacon_data beacon_after;
1484 u16 counter_offset_beacon;
1485 u16 counter_offset_presp;
1488 /* TDLS peer capabilities for send_tdls_mgmt() */
1489 enum tdls_peer_capability {
1490 TDLS_PEER_HT = BIT(0),
1491 TDLS_PEER_VHT = BIT(1),
1492 TDLS_PEER_WMM = BIT(2),
1495 /* valid info in the wmm_params struct */
1496 enum wmm_params_valid_info {
1497 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1501 * struct wmm_params - WMM parameterss configured for this association
1502 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1503 * of the struct contain valid information.
1504 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1505 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1512 #ifdef CONFIG_MACSEC
1513 struct macsec_init_params {
1514 Boolean always_include_sci;
1518 #endif /* CONFIG_MACSEC */
1520 enum drv_br_port_attr {
1521 DRV_BR_PORT_ATTR_PROXYARP,
1522 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1525 enum drv_br_net_param {
1526 DRV_BR_NET_PARAM_GARP_ACCEPT,
1529 struct drv_acs_params {
1530 /* Selected mode (HOSTAPD_MODE_*) */
1531 enum hostapd_hw_mode hw_mode;
1533 /* Indicates whether HT is enabled */
1536 /* Indicates whether HT40 is enabled */
1542 * struct wpa_driver_ops - Driver interface API definition
1544 * This structure defines the API that each driver interface needs to implement
1545 * for core wpa_supplicant code. All driver specific functionality is captured
1548 struct wpa_driver_ops {
1549 /** Name of the driver interface */
1551 /** One line description of the driver interface */
1555 * get_bssid - Get the current BSSID
1556 * @priv: private driver interface data
1557 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1559 * Returns: 0 on success, -1 on failure
1561 * Query kernel driver for the current BSSID and copy it to bssid.
1562 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1565 int (*get_bssid)(void *priv, u8 *bssid);
1568 * get_ssid - Get the current SSID
1569 * @priv: private driver interface data
1570 * @ssid: buffer for SSID (at least 32 bytes)
1572 * Returns: Length of the SSID on success, -1 on failure
1574 * Query kernel driver for the current SSID and copy it to ssid.
1575 * Returning zero is recommended if the STA is not associated.
1577 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1578 * can, at least in theory, contain control characters (including nul)
1579 * and as such, should be processed as binary data, not a printable
1582 int (*get_ssid)(void *priv, u8 *ssid);
1585 * set_key - Configure encryption key
1586 * @ifname: Interface name (for multi-SSID/VLAN support)
1587 * @priv: private driver interface data
1588 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1589 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1590 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1591 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1592 * %WPA_ALG_BIP_CMAC_256);
1593 * %WPA_ALG_NONE clears the key.
1594 * @addr: Address of the peer STA (BSSID of the current AP when setting
1595 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1596 * broadcast keys, %NULL for default keys that are used both for
1597 * broadcast and unicast; when clearing keys, %NULL is used to
1598 * indicate that both the broadcast-only and default key of the
1599 * specified key index is to be cleared
1600 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1602 * @set_tx: configure this key as the default Tx key (only used when
1603 * driver does not support separate unicast/individual key
1604 * @seq: sequence number/packet number, seq_len octets, the next
1605 * packet number to be used for in replay protection; configured
1606 * for Rx keys (in most cases, this is only used with broadcast
1607 * keys and set to zero for unicast keys); %NULL if not set
1608 * @seq_len: length of the seq, depends on the algorithm:
1609 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1610 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1612 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1613 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1615 * Returns: 0 on success, -1 on failure
1617 * Configure the given key for the kernel driver. If the driver
1618 * supports separate individual keys (4 default keys + 1 individual),
1619 * addr can be used to determine whether the key is default or
1620 * individual. If only 4 keys are supported, the default key with key
1621 * index 0 is used as the individual key. STA must be configured to use
1622 * it as the default Tx key (set_tx is set) and accept Rx for all the
1623 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1624 * broadcast keys, so key index 0 is available for this kind of
1627 * Please note that TKIP keys include separate TX and RX MIC keys and
1628 * some drivers may expect them in different order than wpa_supplicant
1629 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1630 * will trigger Michael MIC errors. This can be fixed by changing the
1631 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1632 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1633 * example on how this can be done.
1635 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1636 const u8 *addr, int key_idx, int set_tx,
1637 const u8 *seq, size_t seq_len,
1638 const u8 *key, size_t key_len);
1641 * init - Initialize driver interface
1642 * @ctx: context to be used when calling wpa_supplicant functions,
1643 * e.g., wpa_supplicant_event()
1644 * @ifname: interface name, e.g., wlan0
1646 * Returns: Pointer to private data, %NULL on failure
1648 * Initialize driver interface, including event processing for kernel
1649 * driver events (e.g., associated, scan results, Michael MIC failure).
1650 * This function can allocate a private configuration data area for
1651 * @ctx, file descriptor, interface name, etc. information that may be
1652 * needed in future driver operations. If this is not used, non-NULL
1653 * value will need to be returned because %NULL is used to indicate
1654 * failure. The returned value will be used as 'void *priv' data for
1655 * all other driver_ops functions.
1657 * The main event loop (eloop.c) of wpa_supplicant can be used to
1658 * register callback for read sockets (eloop_register_read_sock()).
1660 * See below for more information about events and
1661 * wpa_supplicant_event() function.
1663 void * (*init)(void *ctx, const char *ifname);
1666 * deinit - Deinitialize driver interface
1667 * @priv: private driver interface data from init()
1669 * Shut down driver interface and processing of driver events. Free
1670 * private data buffer if one was allocated in init() handler.
1672 void (*deinit)(void *priv);
1675 * set_param - Set driver configuration parameters
1676 * @priv: private driver interface data from init()
1677 * @param: driver specific configuration parameters
1679 * Returns: 0 on success, -1 on failure
1681 * Optional handler for notifying driver interface about configuration
1682 * parameters (driver_param).
1684 int (*set_param)(void *priv, const char *param);
1687 * set_countermeasures - Enable/disable TKIP countermeasures
1688 * @priv: private driver interface data
1689 * @enabled: 1 = countermeasures enabled, 0 = disabled
1691 * Returns: 0 on success, -1 on failure
1693 * Configure TKIP countermeasures. When these are enabled, the driver
1694 * should drop all received and queued frames that are using TKIP.
1696 int (*set_countermeasures)(void *priv, int enabled);
1699 * deauthenticate - Request driver to deauthenticate
1700 * @priv: private driver interface data
1701 * @addr: peer address (BSSID of the AP)
1702 * @reason_code: 16-bit reason code to be sent in the deauthentication
1705 * Returns: 0 on success, -1 on failure
1707 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1710 * associate - Request driver to associate
1711 * @priv: private driver interface data
1712 * @params: association parameters
1714 * Returns: 0 on success, -1 on failure
1716 int (*associate)(void *priv,
1717 struct wpa_driver_associate_params *params);
1720 * add_pmkid - Add PMKSA cache entry to the driver
1721 * @priv: private driver interface data
1722 * @bssid: BSSID for the PMKSA cache entry
1723 * @pmkid: PMKID for the PMKSA cache entry
1725 * Returns: 0 on success, -1 on failure
1727 * This function is called when a new PMK is received, as a result of
1728 * either normal authentication or RSN pre-authentication.
1730 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1731 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1732 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1733 * driver_ops function does not need to be implemented. Likewise, if
1734 * the driver does not support WPA, this function is not needed.
1736 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1739 * remove_pmkid - Remove PMKSA cache entry to the driver
1740 * @priv: private driver interface data
1741 * @bssid: BSSID for the PMKSA cache entry
1742 * @pmkid: PMKID for the PMKSA cache entry
1744 * Returns: 0 on success, -1 on failure
1746 * This function is called when the supplicant drops a PMKSA cache
1747 * entry for any reason.
1749 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1750 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1751 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1752 * from wpa_supplicant, this driver_ops function does not need to be
1753 * implemented. Likewise, if the driver does not support WPA, this
1754 * function is not needed.
1756 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1759 * flush_pmkid - Flush PMKSA cache
1760 * @priv: private driver interface data
1762 * Returns: 0 on success, -1 on failure
1764 * This function is called when the supplicant drops all PMKSA cache
1765 * entries for any reason.
1767 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1768 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1769 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1770 * from wpa_supplicant, this driver_ops function does not need to be
1771 * implemented. Likewise, if the driver does not support WPA, this
1772 * function is not needed.
1774 int (*flush_pmkid)(void *priv);
1777 * get_capa - Get driver capabilities
1778 * @priv: private driver interface data
1780 * Returns: 0 on success, -1 on failure
1782 * Get driver/firmware/hardware capabilities.
1784 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1787 * poll - Poll driver for association information
1788 * @priv: private driver interface data
1790 * This is an option callback that can be used when the driver does not
1791 * provide event mechanism for association events. This is called when
1792 * receiving WPA EAPOL-Key messages that require association
1793 * information. The driver interface is supposed to generate associnfo
1794 * event before returning from this callback function. In addition, the
1795 * driver interface should generate an association event after having
1796 * sent out associnfo.
1798 void (*poll)(void *priv);
1801 * get_ifname - Get interface name
1802 * @priv: private driver interface data
1804 * Returns: Pointer to the interface name. This can differ from the
1805 * interface name used in init() call. Init() is called first.
1807 * This optional function can be used to allow the driver interface to
1808 * replace the interface name with something else, e.g., based on an
1809 * interface mapping from a more descriptive name.
1811 const char * (*get_ifname)(void *priv);
1814 * get_mac_addr - Get own MAC address
1815 * @priv: private driver interface data
1817 * Returns: Pointer to own MAC address or %NULL on failure
1819 * This optional function can be used to get the own MAC address of the
1820 * device from the driver interface code. This is only needed if the
1821 * l2_packet implementation for the OS does not provide easy access to
1823 const u8 * (*get_mac_addr)(void *priv);
1826 * set_operstate - Sets device operating state to DORMANT or UP
1827 * @priv: private driver interface data
1828 * @state: 0 = dormant, 1 = up
1829 * Returns: 0 on success, -1 on failure
1831 * This is an optional function that can be used on operating systems
1832 * that support a concept of controlling network device state from user
1833 * space applications. This function, if set, gets called with
1834 * state = 1 when authentication has been completed and with state = 0
1835 * when connection is lost.
1837 int (*set_operstate)(void *priv, int state);
1840 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1841 * @priv: Private driver interface data
1842 * @addr: Address of the station for which to set protection (may be
1843 * %NULL for group keys)
1844 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1845 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1846 * Returns: 0 on success, -1 on failure
1848 * This is an optional function that can be used to set the driver to
1849 * require protection for Tx and/or Rx frames. This uses the layer
1850 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1851 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1852 * set protection operation; instead, they set protection implicitly
1853 * based on configured keys.
1855 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1859 * get_hw_feature_data - Get hardware support data (channels and rates)
1860 * @priv: Private driver interface data
1861 * @num_modes: Variable for returning the number of returned modes
1862 * flags: Variable for returning hardware feature flags
1863 * Returns: Pointer to allocated hardware data on success or %NULL on
1864 * failure. Caller is responsible for freeing this.
1866 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1871 * send_mlme - Send management frame from MLME
1872 * @priv: Private driver interface data
1873 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1874 * @data_len: Size of the management frame
1875 * @noack: Do not wait for this frame to be acked (disable retries)
1876 * Returns: 0 on success, -1 on failure
1878 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1882 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1883 * @priv: Private driver interface data
1884 * @md: Mobility domain (2 octets) (also included inside ies)
1885 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1886 * @ies_len: Length of FT IEs in bytes
1887 * Returns: 0 on success, -1 on failure
1889 * The supplicant uses this callback to let the driver know that keying
1890 * material for FT is available and that the driver can use the
1891 * provided IEs in the next message in FT authentication sequence.
1893 * This function is only needed for driver that support IEEE 802.11r
1894 * (Fast BSS Transition).
1896 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1900 * get_scan_results2 - Fetch the latest scan results
1901 * @priv: private driver interface data
1903 * Returns: Allocated buffer of scan results (caller is responsible for
1904 * freeing the data structure) on success, NULL on failure
1906 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1909 * set_country - Set country
1910 * @priv: Private driver interface data
1911 * @alpha2: country to which to switch to
1912 * Returns: 0 on success, -1 on failure
1914 * This function is for drivers which support some form
1915 * of setting a regulatory domain.
1917 int (*set_country)(void *priv, const char *alpha2);
1920 * get_country - Get country
1921 * @priv: Private driver interface data
1922 * @alpha2: Buffer for returning country code (at least 3 octets)
1923 * Returns: 0 on success, -1 on failure
1925 int (*get_country)(void *priv, char *alpha2);
1928 * global_init - Global driver initialization
1929 * Returns: Pointer to private data (global), %NULL on failure
1931 * This optional function is called to initialize the driver wrapper
1932 * for global data, i.e., data that applies to all interfaces. If this
1933 * function is implemented, global_deinit() will also need to be
1934 * implemented to free the private data. The driver will also likely
1935 * use init2() function instead of init() to get the pointer to global
1936 * data available to per-interface initializer.
1938 void * (*global_init)(void);
1941 * global_deinit - Global driver deinitialization
1942 * @priv: private driver global data from global_init()
1944 * Terminate any global driver related functionality and free the
1945 * global data structure.
1947 void (*global_deinit)(void *priv);
1950 * init2 - Initialize driver interface (with global data)
1951 * @ctx: context to be used when calling wpa_supplicant functions,
1952 * e.g., wpa_supplicant_event()
1953 * @ifname: interface name, e.g., wlan0
1954 * @global_priv: private driver global data from global_init()
1955 * Returns: Pointer to private data, %NULL on failure
1957 * This function can be used instead of init() if the driver wrapper
1960 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1963 * get_interfaces - Get information about available interfaces
1964 * @global_priv: private driver global data from global_init()
1965 * Returns: Allocated buffer of interface information (caller is
1966 * responsible for freeing the data structure) on success, NULL on
1969 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1972 * scan2 - Request the driver to initiate scan
1973 * @priv: private driver interface data
1974 * @params: Scan parameters
1976 * Returns: 0 on success, -1 on failure
1978 * Once the scan results are ready, the driver should report scan
1979 * results event for wpa_supplicant which will eventually request the
1980 * results with wpa_driver_get_scan_results2().
1982 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1985 * authenticate - Request driver to authenticate
1986 * @priv: private driver interface data
1987 * @params: authentication parameters
1988 * Returns: 0 on success, -1 on failure
1990 * This is an optional function that can be used with drivers that
1991 * support separate authentication and association steps, i.e., when
1992 * wpa_supplicant can act as the SME. If not implemented, associate()
1993 * function is expected to take care of IEEE 802.11 authentication,
1996 int (*authenticate)(void *priv,
1997 struct wpa_driver_auth_params *params);
2000 * set_ap - Set Beacon and Probe Response information for AP mode
2001 * @priv: Private driver interface data
2002 * @params: Parameters to use in AP mode
2004 * This function is used to configure Beacon template and/or extra IEs
2005 * to add for Beacon and Probe Response frames for the driver in
2006 * AP mode. The driver is responsible for building the full Beacon
2007 * frame by concatenating the head part with TIM IE generated by the
2008 * driver/firmware and finishing with the tail part. Depending on the
2009 * driver architectue, this can be done either by using the full
2010 * template or the set of additional IEs (e.g., WPS and P2P IE).
2011 * Similarly, Probe Response processing depends on the driver design.
2012 * If the driver (or firmware) takes care of replying to Probe Request
2013 * frames, the extra IEs provided here needs to be added to the Probe
2016 * Returns: 0 on success, -1 on failure
2018 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
2021 * set_acl - Set ACL in AP mode
2022 * @priv: Private driver interface data
2023 * @params: Parameters to configure ACL
2024 * Returns: 0 on success, -1 on failure
2026 * This is used only for the drivers which support MAC address ACL.
2028 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2031 * hapd_init - Initialize driver interface (hostapd only)
2032 * @hapd: Pointer to hostapd context
2033 * @params: Configuration for the driver wrapper
2034 * Returns: Pointer to private data, %NULL on failure
2036 * This function is used instead of init() or init2() when the driver
2037 * wrapper is used with hostapd.
2039 void * (*hapd_init)(struct hostapd_data *hapd,
2040 struct wpa_init_params *params);
2043 * hapd_deinit - Deinitialize driver interface (hostapd only)
2044 * @priv: Private driver interface data from hapd_init()
2046 void (*hapd_deinit)(void *priv);
2049 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2050 * @priv: Private driver interface data
2051 * @params: BSS parameters
2052 * Returns: 0 on success, -1 on failure
2054 * This is an optional function to configure the kernel driver to
2055 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2056 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2057 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2058 * for Beacon frames.
2060 * DEPRECATED - use set_ap() instead
2062 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2065 * set_privacy - Enable/disable privacy (AP only)
2066 * @priv: Private driver interface data
2067 * @enabled: 1 = privacy enabled, 0 = disabled
2068 * Returns: 0 on success, -1 on failure
2070 * This is an optional function to configure privacy field in the
2071 * kernel driver for Beacon frames. This can be left undefined (set to
2072 * %NULL) if the driver uses the Beacon template from set_ap().
2074 * DEPRECATED - use set_ap() instead
2076 int (*set_privacy)(void *priv, int enabled);
2079 * get_seqnum - Fetch the current TSC/packet number (AP only)
2080 * @ifname: The interface name (main or virtual)
2081 * @priv: Private driver interface data
2082 * @addr: MAC address of the station or %NULL for group keys
2084 * @seq: Buffer for returning the latest used TSC/packet number
2085 * Returns: 0 on success, -1 on failure
2087 * This function is used to fetch the last used TSC/packet number for
2088 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2089 * keys, so there is no strict requirement on implementing support for
2090 * unicast keys (i.e., addr != %NULL).
2092 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2096 * flush - Flush all association stations (AP only)
2097 * @priv: Private driver interface data
2098 * Returns: 0 on success, -1 on failure
2100 * This function requests the driver to disassociate all associated
2101 * stations. This function does not need to be implemented if the
2102 * driver does not process association frames internally.
2104 int (*flush)(void *priv);
2107 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2108 * @priv: Private driver interface data
2109 * @elem: Information elements
2110 * @elem_len: Length of the elem buffer in octets
2111 * Returns: 0 on success, -1 on failure
2113 * This is an optional function to add information elements in the
2114 * kernel driver for Beacon and Probe Response frames. This can be left
2115 * undefined (set to %NULL) if the driver uses the Beacon template from
2118 * DEPRECATED - use set_ap() instead
2120 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2123 * read_sta_data - Fetch station data
2124 * @priv: Private driver interface data
2125 * @data: Buffer for returning station information
2126 * @addr: MAC address of the station
2127 * Returns: 0 on success, -1 on failure
2129 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2133 * hapd_send_eapol - Send an EAPOL packet (AP only)
2134 * @priv: private driver interface data
2135 * @addr: Destination MAC address
2136 * @data: EAPOL packet starting with IEEE 802.1X header
2137 * @data_len: Length of the EAPOL packet in octets
2138 * @encrypt: Whether the frame should be encrypted
2139 * @own_addr: Source MAC address
2140 * @flags: WPA_STA_* flags for the destination station
2142 * Returns: 0 on success, -1 on failure
2144 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2145 size_t data_len, int encrypt,
2146 const u8 *own_addr, u32 flags);
2149 * sta_deauth - Deauthenticate a station (AP only)
2150 * @priv: Private driver interface data
2151 * @own_addr: Source address and BSSID for the Deauthentication frame
2152 * @addr: MAC address of the station to deauthenticate
2153 * @reason: Reason code for the Deauthentiation frame
2154 * Returns: 0 on success, -1 on failure
2156 * This function requests a specific station to be deauthenticated and
2157 * a Deauthentication frame to be sent to it.
2159 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2163 * sta_disassoc - Disassociate a station (AP only)
2164 * @priv: Private driver interface data
2165 * @own_addr: Source address and BSSID for the Disassociation frame
2166 * @addr: MAC address of the station to disassociate
2167 * @reason: Reason code for the Disassociation frame
2168 * Returns: 0 on success, -1 on failure
2170 * This function requests a specific station to be disassociated and
2171 * a Disassociation frame to be sent to it.
2173 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2177 * sta_remove - Remove a station entry (AP only)
2178 * @priv: Private driver interface data
2179 * @addr: MAC address of the station to be removed
2180 * Returns: 0 on success, -1 on failure
2182 int (*sta_remove)(void *priv, const u8 *addr);
2185 * hapd_get_ssid - Get the current SSID (AP only)
2186 * @priv: Private driver interface data
2187 * @buf: Buffer for returning the SSID
2188 * @len: Maximum length of the buffer
2189 * Returns: Length of the SSID on success, -1 on failure
2191 * This function need not be implemented if the driver uses Beacon
2192 * template from set_ap() and does not reply to Probe Request frames.
2194 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2197 * hapd_set_ssid - Set SSID (AP only)
2198 * @priv: Private driver interface data
2200 * @len: Length of the SSID in octets
2201 * Returns: 0 on success, -1 on failure
2203 * DEPRECATED - use set_ap() instead
2205 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2208 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2209 * @priv: Private driver interface data
2210 * @enabled: 1 = countermeasures enabled, 0 = disabled
2211 * Returns: 0 on success, -1 on failure
2213 * This need not be implemented if the driver does not take care of
2214 * association processing.
2216 int (*hapd_set_countermeasures)(void *priv, int enabled);
2219 * sta_add - Add a station entry
2220 * @priv: Private driver interface data
2221 * @params: Station parameters
2222 * Returns: 0 on success, -1 on failure
2224 * This function is used to add a station entry to the driver once the
2225 * station has completed association. This is only used if the driver
2226 * does not take care of association processing.
2228 * With TDLS, this function is also used to add or set (params->set 1)
2229 * TDLS peer entries.
2231 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2234 * get_inact_sec - Get station inactivity duration (AP only)
2235 * @priv: Private driver interface data
2236 * @addr: Station address
2237 * Returns: Number of seconds station has been inactive, -1 on failure
2239 int (*get_inact_sec)(void *priv, const u8 *addr);
2242 * sta_clear_stats - Clear station statistics (AP only)
2243 * @priv: Private driver interface data
2244 * @addr: Station address
2245 * Returns: 0 on success, -1 on failure
2247 int (*sta_clear_stats)(void *priv, const u8 *addr);
2250 * set_freq - Set channel/frequency (AP only)
2251 * @priv: Private driver interface data
2252 * @freq: Channel parameters
2253 * Returns: 0 on success, -1 on failure
2255 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2258 * set_rts - Set RTS threshold
2259 * @priv: Private driver interface data
2260 * @rts: RTS threshold in octets
2261 * Returns: 0 on success, -1 on failure
2263 int (*set_rts)(void *priv, int rts);
2266 * set_frag - Set fragmentation threshold
2267 * @priv: Private driver interface data
2268 * @frag: Fragmentation threshold in octets
2269 * Returns: 0 on success, -1 on failure
2271 int (*set_frag)(void *priv, int frag);
2274 * sta_set_flags - Set station flags (AP only)
2275 * @priv: Private driver interface data
2276 * @addr: Station address
2277 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2278 * @flags_or: Bitmap of WPA_STA_* flags to add
2279 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2280 * Returns: 0 on success, -1 on failure
2282 int (*sta_set_flags)(void *priv, const u8 *addr,
2283 int total_flags, int flags_or, int flags_and);
2286 * set_tx_queue_params - Set TX queue parameters
2287 * @priv: Private driver interface data
2288 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2292 * @burst_time: Maximum length for bursting in 0.1 msec units
2294 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2295 int cw_max, int burst_time);
2298 * if_add - Add a virtual interface
2299 * @priv: Private driver interface data
2300 * @type: Interface type
2301 * @ifname: Interface name for the new virtual interface
2302 * @addr: Local address to use for the interface or %NULL to use the
2303 * parent interface address
2304 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2305 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2306 * not allowed (applies only to %WPA_IF_AP_BSS type)
2307 * @force_ifname: Buffer for returning an interface name that the
2308 * driver ended up using if it differs from the requested ifname
2309 * @if_addr: Buffer for returning the allocated interface address
2310 * (this may differ from the requested addr if the driver cannot
2311 * change interface address)
2312 * @bridge: Bridge interface to use or %NULL if no bridge configured
2313 * @use_existing: Whether to allow existing interface to be used
2314 * Returns: 0 on success, -1 on failure
2316 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2317 const char *ifname, const u8 *addr, void *bss_ctx,
2318 void **drv_priv, char *force_ifname, u8 *if_addr,
2319 const char *bridge, int use_existing);
2322 * if_remove - Remove a virtual interface
2323 * @priv: Private driver interface data
2324 * @type: Interface type
2325 * @ifname: Interface name of the virtual interface to be removed
2326 * Returns: 0 on success, -1 on failure
2328 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2329 const char *ifname);
2332 * set_sta_vlan - Bind a station into a specific interface (AP only)
2333 * @priv: Private driver interface data
2334 * @ifname: Interface (main or virtual BSS or VLAN)
2335 * @addr: MAC address of the associated station
2337 * Returns: 0 on success, -1 on failure
2339 * This function is used to bind a station to a specific virtual
2340 * interface. It is only used if when virtual interfaces are supported,
2341 * e.g., to assign stations to different VLAN interfaces based on
2342 * information from a RADIUS server. This allows separate broadcast
2343 * domains to be used with a single BSS.
2345 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2349 * commit - Optional commit changes handler (AP only)
2350 * @priv: driver private data
2351 * Returns: 0 on success, -1 on failure
2353 * This optional handler function can be registered if the driver
2354 * interface implementation needs to commit changes (e.g., by setting
2355 * network interface up) at the end of initial configuration. If set,
2356 * this handler will be called after initial setup has been completed.
2358 int (*commit)(void *priv);
2361 * send_ether - Send an ethernet packet (AP only)
2362 * @priv: private driver interface data
2363 * @dst: Destination MAC address
2364 * @src: Source MAC address
2366 * @data: EAPOL packet starting with IEEE 802.1X header
2367 * @data_len: Length of the EAPOL packet in octets
2368 * Returns: 0 on success, -1 on failure
2370 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2371 const u8 *data, size_t data_len);
2374 * set_radius_acl_auth - Notification of RADIUS ACL change
2375 * @priv: Private driver interface data
2376 * @mac: MAC address of the station
2377 * @accepted: Whether the station was accepted
2378 * @session_timeout: Session timeout for the station
2379 * Returns: 0 on success, -1 on failure
2381 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2382 u32 session_timeout);
2385 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2386 * @priv: Private driver interface data
2387 * @mac: MAC address of the station
2388 * Returns: 0 on success, -1 on failure
2390 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2393 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2394 * @priv: Private driver interface data
2395 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2396 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2398 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2399 * to remove extra IE(s)
2400 * Returns: 0 on success, -1 on failure
2402 * This is an optional function to add WPS IE in the kernel driver for
2403 * Beacon and Probe Response frames. This can be left undefined (set
2404 * to %NULL) if the driver uses the Beacon template from set_ap()
2405 * and does not process Probe Request frames. If the driver takes care
2406 * of (Re)Association frame processing, the assocresp buffer includes
2407 * WPS IE(s) that need to be added to (Re)Association Response frames
2408 * whenever a (Re)Association Request frame indicated use of WPS.
2410 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2411 * frames when operating as a GO. The driver is responsible for adding
2412 * timing related attributes (e.g., NoA) in addition to the IEs
2413 * included here by appending them after these buffers. This call is
2414 * also used to provide Probe Response IEs for P2P Listen state
2415 * operations for drivers that generate the Probe Response frames
2418 * DEPRECATED - use set_ap() instead
2420 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2421 const struct wpabuf *proberesp,
2422 const struct wpabuf *assocresp);
2425 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2426 * @priv: Private driver interface data
2427 * @authorized: Whether the port is authorized
2428 * Returns: 0 on success, -1 on failure
2430 int (*set_supp_port)(void *priv, int authorized);
2433 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2434 * @priv: Private driver interface data
2435 * @addr: MAC address of the associated station
2436 * @aid: Association ID
2437 * @val: 1 = bind to 4-address WDS; 0 = unbind
2438 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2439 * to indicate that bridge is not to be used
2440 * @ifname_wds: Buffer to return the interface name for the new WDS
2441 * station or %NULL to indicate name is not returned.
2442 * Returns: 0 on success, -1 on failure
2444 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2445 const char *bridge_ifname, char *ifname_wds);
2448 * send_action - Transmit an Action frame
2449 * @priv: Private driver interface data
2450 * @freq: Frequency (in MHz) of the channel
2451 * @wait: Time to wait off-channel for a response (in ms), or zero
2452 * @dst: Destination MAC address (Address 1)
2453 * @src: Source MAC address (Address 2)
2454 * @bssid: BSSID (Address 3)
2456 * @data_len: data length in octets
2457 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2458 * Returns: 0 on success, -1 on failure
2460 * This command can be used to request the driver to transmit an action
2461 * frame to the specified destination.
2463 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2464 * be transmitted on the given channel and the device will wait for a
2465 * response on that channel for the given wait time.
2467 * If the flag is not set, the wait time will be ignored. In this case,
2468 * if a remain-on-channel duration is in progress, the frame must be
2469 * transmitted on that channel; alternatively the frame may be sent on
2470 * the current operational channel (if in associated state in station
2471 * mode or while operating as an AP.)
2473 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2474 const u8 *dst, const u8 *src, const u8 *bssid,
2475 const u8 *data, size_t data_len, int no_cck);
2478 * send_action_cancel_wait - Cancel action frame TX wait
2479 * @priv: Private driver interface data
2481 * This command cancels the wait time associated with sending an action
2482 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2483 * set in the driver flags.
2485 void (*send_action_cancel_wait)(void *priv);
2488 * remain_on_channel - Remain awake on a channel
2489 * @priv: Private driver interface data
2490 * @freq: Frequency (in MHz) of the channel
2491 * @duration: Duration in milliseconds
2492 * Returns: 0 on success, -1 on failure
2494 * This command is used to request the driver to remain awake on the
2495 * specified channel for the specified duration and report received
2496 * Action frames with EVENT_RX_MGMT events. Optionally, received
2497 * Probe Request frames may also be requested to be reported by calling
2498 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2500 * The driver may not be at the requested channel when this function
2501 * returns, i.e., the return code is only indicating whether the
2502 * request was accepted. The caller will need to wait until the
2503 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2504 * completed the channel change. This may take some time due to other
2505 * need for the radio and the caller should be prepared to timing out
2506 * its wait since there are no guarantees on when this request can be
2509 int (*remain_on_channel)(void *priv, unsigned int freq,
2510 unsigned int duration);
2513 * cancel_remain_on_channel - Cancel remain-on-channel operation
2514 * @priv: Private driver interface data
2516 * This command can be used to cancel a remain-on-channel operation
2517 * before its originally requested duration has passed. This could be
2518 * used, e.g., when remain_on_channel() is used to request extra time
2519 * to receive a response to an Action frame and the response is
2520 * received when there is still unneeded time remaining on the
2521 * remain-on-channel operation.
2523 int (*cancel_remain_on_channel)(void *priv);
2526 * probe_req_report - Request Probe Request frames to be indicated
2527 * @priv: Private driver interface data
2528 * @report: Whether to report received Probe Request frames
2529 * Returns: 0 on success, -1 on failure (or if not supported)
2531 * This command can be used to request the driver to indicate when
2532 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2533 * Since this operation may require extra resources, e.g., due to less
2534 * optimal hardware/firmware RX filtering, many drivers may disable
2535 * Probe Request reporting at least in station mode. This command is
2536 * used to notify the driver when the Probe Request frames need to be
2537 * reported, e.g., during remain-on-channel operations.
2539 int (*probe_req_report)(void *priv, int report);
2542 * deinit_ap - Deinitialize AP mode
2543 * @priv: Private driver interface data
2544 * Returns: 0 on success, -1 on failure (or if not supported)
2546 * This optional function can be used to disable AP mode related
2547 * configuration. If the interface was not dynamically added,
2548 * change the driver mode to station mode to allow normal station
2549 * operations like scanning to be completed.
2551 int (*deinit_ap)(void *priv);
2554 * deinit_p2p_cli - Deinitialize P2P client mode
2555 * @priv: Private driver interface data
2556 * Returns: 0 on success, -1 on failure (or if not supported)
2558 * This optional function can be used to disable P2P client mode. If the
2559 * interface was not dynamically added, change the interface type back
2562 int (*deinit_p2p_cli)(void *priv);
2565 * suspend - Notification on system suspend/hibernate event
2566 * @priv: Private driver interface data
2568 void (*suspend)(void *priv);
2571 * resume - Notification on system resume/thaw event
2572 * @priv: Private driver interface data
2574 void (*resume)(void *priv);
2577 * signal_monitor - Set signal monitoring parameters
2578 * @priv: Private driver interface data
2579 * @threshold: Threshold value for signal change events; 0 = disabled
2580 * @hysteresis: Minimum change in signal strength before indicating a
2582 * Returns: 0 on success, -1 on failure (or if not supported)
2584 * This function can be used to configure monitoring of signal strength
2585 * with the current AP. Whenever signal strength drops below the
2586 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2587 * should be generated assuming the signal strength has changed at
2588 * least %hysteresis from the previously indicated signal change event.
2590 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2593 * send_frame - Send IEEE 802.11 frame (testing use only)
2594 * @priv: Private driver interface data
2595 * @data: IEEE 802.11 frame with IEEE 802.11 header
2596 * @data_len: Size of the frame
2597 * @encrypt: Whether to encrypt the frame (if keys are set)
2598 * Returns: 0 on success, -1 on failure
2600 * This function is only used for debugging purposes and is not
2601 * required to be implemented for normal operations.
2603 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2607 * shared_freq - Get operating frequency of shared interface(s)
2608 * @priv: Private driver interface data
2609 * Returns: Operating frequency in MHz, 0 if no shared operation in
2610 * use, or -1 on failure
2612 * This command can be used to request the current operating frequency
2613 * of any virtual interface that shares the same radio to provide
2614 * information for channel selection for other virtual interfaces.
2616 int (*shared_freq)(void *priv);
2619 * get_noa - Get current Notice of Absence attribute payload
2620 * @priv: Private driver interface data
2621 * @buf: Buffer for returning NoA
2622 * @buf_len: Buffer length in octets
2623 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2624 * advertized, or -1 on failure
2626 * This function is used to fetch the current Notice of Absence
2627 * attribute value from GO.
2629 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2632 * set_noa - Set Notice of Absence parameters for GO (testing)
2633 * @priv: Private driver interface data
2635 * @start: Start time in ms from next TBTT
2636 * @duration: Duration in ms
2637 * Returns: 0 on success or -1 on failure
2639 * This function is used to set Notice of Absence parameters for GO. It
2640 * is used only for testing. To disable NoA, all parameters are set to
2643 int (*set_noa)(void *priv, u8 count, int start, int duration);
2646 * set_p2p_powersave - Set P2P power save options
2647 * @priv: Private driver interface data
2648 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2649 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2650 * @ctwindow: 0.. = change (msec), -1 = no change
2651 * Returns: 0 on success or -1 on failure
2653 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2657 * ampdu - Enable/disable aggregation
2658 * @priv: Private driver interface data
2659 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2660 * Returns: 0 on success or -1 on failure
2662 int (*ampdu)(void *priv, int ampdu);
2665 * get_radio_name - Get physical radio name for the device
2666 * @priv: Private driver interface data
2667 * Returns: Radio name or %NULL if not known
2669 * The returned data must not be modified by the caller. It is assumed
2670 * that any interface that has the same radio name as another is
2671 * sharing the same physical radio. This information can be used to
2672 * share scan results etc. information between the virtual interfaces
2673 * to speed up various operations.
2675 const char * (*get_radio_name)(void *priv);
2678 * send_tdls_mgmt - for sending TDLS management packets
2679 * @priv: private driver interface data
2680 * @dst: Destination (peer) MAC address
2681 * @action_code: TDLS action code for the mssage
2682 * @dialog_token: Dialog Token to use in the message (if needed)
2683 * @status_code: Status Code or Reason Code to use (if needed)
2684 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2685 * @initiator: Is the current end the TDLS link initiator
2686 * @buf: TDLS IEs to add to the message
2687 * @len: Length of buf in octets
2688 * Returns: 0 on success, negative (<0) on failure
2690 * This optional function can be used to send packet to driver which is
2691 * responsible for receiving and sending all TDLS packets.
2693 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2694 u8 dialog_token, u16 status_code, u32 peer_capab,
2695 int initiator, const u8 *buf, size_t len);
2698 * tdls_oper - Ask the driver to perform high-level TDLS operations
2699 * @priv: Private driver interface data
2700 * @oper: TDLS high-level operation. See %enum tdls_oper
2701 * @peer: Destination (peer) MAC address
2702 * Returns: 0 on success, negative (<0) on failure
2704 * This optional function can be used to send high-level TDLS commands
2707 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2710 * wnm_oper - Notify driver of the WNM frame reception
2711 * @priv: Private driver interface data
2712 * @oper: WNM operation. See %enum wnm_oper
2713 * @peer: Destination (peer) MAC address
2714 * @buf: Buffer for the driver to fill in (for getting IE)
2715 * @buf_len: Return the len of buf
2716 * Returns: 0 on success, negative (<0) on failure
2718 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2719 u8 *buf, u16 *buf_len);
2722 * set_qos_map - Set QoS Map
2723 * @priv: Private driver interface data
2724 * @qos_map_set: QoS Map
2725 * @qos_map_set_len: Length of QoS Map
2727 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2728 u8 qos_map_set_len);
2731 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2732 * @priv: Private driver interface data
2733 * @version: IP version of the IP address, 4 or 6
2734 * @ipaddr: IP address for the neigh entry
2735 * @prefixlen: IP address prefix length
2736 * @addr: Corresponding MAC address
2737 * Returns: 0 on success, negative (<0) on failure
2739 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2740 int prefixlen, const u8 *addr);
2743 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2744 * @priv: Private driver interface data
2745 * @version: IP version of the IP address, 4 or 6
2746 * @ipaddr: IP address for the neigh entry
2747 * Returns: 0 on success, negative (<0) on failure
2749 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2752 * br_port_set_attr - Set a bridge port attribute
2753 * @attr: Bridge port attribute to set
2754 * @val: Value to be set
2755 * Returns: 0 on success, negative (<0) on failure
2757 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2761 * br_port_set_attr - Set a bridge network parameter
2762 * @param: Bridge parameter to set
2763 * @val: Value to be set
2764 * Returns: 0 on success, negative (<0) on failure
2766 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2770 * set_wowlan - Set wake-on-wireless triggers
2771 * @priv: Private driver interface data
2772 * @triggers: wowlan triggers
2774 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2777 * signal_poll - Get current connection information
2778 * @priv: Private driver interface data
2779 * @signal_info: Connection info structure
2781 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2784 * set_authmode - Set authentication algorithm(s) for static WEP
2785 * @priv: Private driver interface data
2786 * @authmode: 1=Open System, 2=Shared Key, 3=both
2787 * Returns: 0 on success, -1 on failure
2789 * This function can be used to set authentication algorithms for AP
2790 * mode when static WEP is used. If the driver uses user space MLME/SME
2791 * implementation, there is no need to implement this function.
2793 * DEPRECATED - use set_ap() instead
2795 int (*set_authmode)(void *priv, int authmode);
2799 * driver_cmd - Execute driver-specific command
2800 * @priv: Private driver interface data
2801 * @cmd: Command to execute
2802 * @buf: Return buffer
2803 * @buf_len: Buffer length
2804 * Returns: 0 on success, -1 on failure
2806 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2807 #endif /* ANDROID */
2810 * vendor_cmd - Execute vendor specific command
2811 * @priv: Private driver interface data
2812 * @vendor_id: Vendor id
2813 * @subcmd: Vendor command id
2814 * @data: Vendor command parameters (%NULL if no parameters)
2815 * @data_len: Data length
2816 * @buf: Return buffer (%NULL to ignore reply)
2817 * Returns: 0 on success, negative (<0) on failure
2819 * This function handles vendor specific commands that are passed to
2820 * the driver/device. The command is identified by vendor id and
2821 * command id. Parameters can be passed as argument to the command
2822 * in the data buffer. Reply (if any) will be filled in the supplied
2825 * The exact driver behavior is driver interface and vendor specific. As
2826 * an example, this will be converted to a vendor specific cfg80211
2827 * command in case of the nl80211 driver interface.
2829 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2830 unsigned int subcmd, const u8 *data, size_t data_len,
2831 struct wpabuf *buf);
2834 * set_rekey_info - Set rekey information
2835 * @priv: Private driver interface data
2838 * @replay_ctr: Current EAPOL-Key Replay Counter
2840 * This optional function can be used to provide information for the
2841 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2842 * while the host (including wpa_supplicant) is sleeping.
2844 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2845 const u8 *replay_ctr);
2848 * sta_assoc - Station association indication
2849 * @priv: Private driver interface data
2850 * @own_addr: Source address and BSSID for association frame
2851 * @addr: MAC address of the station to associate
2852 * @reassoc: flag to indicate re-association
2853 * @status: association response status code
2854 * @ie: assoc response ie buffer
2855 * @len: ie buffer length
2856 * Returns: 0 on success, -1 on failure
2858 * This function indicates the driver to send (Re)Association
2859 * Response frame to the station.
2861 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2862 int reassoc, u16 status, const u8 *ie, size_t len);
2865 * sta_auth - Station authentication indication
2866 * @priv: Private driver interface data
2867 * @own_addr: Source address and BSSID for authentication frame
2868 * @addr: MAC address of the station to associate
2869 * @seq: authentication sequence number
2870 * @status: authentication response status code
2871 * @ie: authentication frame ie buffer
2872 * @len: ie buffer length
2874 * This function indicates the driver to send Authentication frame
2877 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2878 u16 seq, u16 status, const u8 *ie, size_t len);
2881 * add_tspec - Add traffic stream
2882 * @priv: Private driver interface data
2883 * @addr: MAC address of the station to associate
2884 * @tspec_ie: tspec ie buffer
2885 * @tspec_ielen: tspec ie length
2886 * Returns: 0 on success, -1 on failure
2888 * This function adds the traffic steam for the station
2889 * and fills the medium_time in tspec_ie.
2891 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2892 size_t tspec_ielen);
2895 * add_sta_node - Add a station node in the driver
2896 * @priv: Private driver interface data
2897 * @addr: MAC address of the station to add
2898 * @auth_alg: authentication algorithm used by the station
2899 * Returns: 0 on success, -1 on failure
2901 * This function adds the station node in the driver, when
2902 * the station gets added by FT-over-DS.
2904 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2907 * sched_scan - Request the driver to initiate scheduled scan
2908 * @priv: Private driver interface data
2909 * @params: Scan parameters
2910 * @interval: Interval between scan cycles in milliseconds
2911 * Returns: 0 on success, -1 on failure
2913 * This operation should be used for scheduled scan offload to
2914 * the hardware. Every time scan results are available, the
2915 * driver should report scan results event for wpa_supplicant
2916 * which will eventually request the results with
2917 * wpa_driver_get_scan_results2(). This operation is optional
2918 * and if not provided or if it returns -1, we fall back to
2919 * normal host-scheduled scans.
2921 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2925 * stop_sched_scan - Request the driver to stop a scheduled scan
2926 * @priv: Private driver interface data
2927 * Returns: 0 on success, -1 on failure
2929 * This should cause the scheduled scan to be stopped and
2930 * results should stop being sent. Must be supported if
2931 * sched_scan is supported.
2933 int (*stop_sched_scan)(void *priv);
2936 * poll_client - Probe (null data or such) the given station
2937 * @priv: Private driver interface data
2938 * @own_addr: MAC address of sending interface
2939 * @addr: MAC address of the station to probe
2940 * @qos: Indicates whether station is QoS station
2942 * This function is used to verify whether an associated station is
2943 * still present. This function does not need to be implemented if the
2944 * driver provides such inactivity polling mechanism.
2946 void (*poll_client)(void *priv, const u8 *own_addr,
2947 const u8 *addr, int qos);
2950 * radio_disable - Disable/enable radio
2951 * @priv: Private driver interface data
2952 * @disabled: 1=disable 0=enable radio
2953 * Returns: 0 on success, -1 on failure
2955 * This optional command is for testing purposes. It can be used to
2956 * disable the radio on a testbed device to simulate out-of-radio-range
2959 int (*radio_disable)(void *priv, int disabled);
2962 * switch_channel - Announce channel switch and migrate the GO to the
2964 * @priv: Private driver interface data
2965 * @settings: Settings for CSA period and new channel
2966 * Returns: 0 on success, -1 on failure
2968 * This function is used to move the GO to the legacy STA channel to
2969 * avoid frequency conflict in single channel concurrency.
2971 int (*switch_channel)(void *priv, struct csa_settings *settings);
2974 * add_tx_ts - Add traffic stream
2975 * @priv: Private driver interface data
2976 * @tsid: Traffic stream ID
2977 * @addr: Receiver address
2978 * @user_prio: User priority of the traffic stream
2979 * @admitted_time: Admitted time for this TS in units of
2980 * 32 microsecond periods (per second).
2981 * Returns: 0 on success, -1 on failure
2983 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
2987 * del_tx_ts - Delete traffic stream
2988 * @priv: Private driver interface data
2989 * @tsid: Traffic stream ID
2990 * @addr: Receiver address
2991 * Returns: 0 on success, -1 on failure
2993 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
2996 * start_dfs_cac - Listen for radar interference on the channel
2997 * @priv: Private driver interface data
2998 * @freq: Channel parameters
2999 * Returns: 0 on success, -1 on failure
3001 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
3004 * stop_ap - Removes beacon from AP
3005 * @priv: Private driver interface data
3006 * Returns: 0 on success, -1 on failure (or if not supported)
3008 * This optional function can be used to disable AP mode related
3009 * configuration. Unlike deinit_ap, it does not change to station
3012 int (*stop_ap)(void *priv);
3015 * get_survey - Retrieve survey data
3016 * @priv: Private driver interface data
3017 * @freq: If set, survey data for the specified frequency is only
3018 * being requested. If not set, all survey data is requested.
3019 * Returns: 0 on success, -1 on failure
3021 * Use this to retrieve:
3023 * - the observed channel noise floor
3024 * - the amount of time we have spent on the channel
3025 * - the amount of time during which we have spent on the channel that
3026 * the radio has determined the medium is busy and we cannot
3028 * - the amount of time we have spent receiving data
3029 * - the amount of time we have spent transmitting data
3031 * This data can be used for spectrum heuristics. One example is
3032 * Automatic Channel Selection (ACS). The channel survey data is
3033 * kept on a linked list on the channel data, one entry is added
3034 * for each survey. The min_nf of the channel is updated for each
3037 int (*get_survey)(void *priv, unsigned int freq);
3040 * status - Get driver interface status information
3041 * @priv: Private driver interface data
3042 * @buf: Buffer for printing tou the status information
3043 * @buflen: Maximum length of the buffer
3044 * Returns: Length of written status information or -1 on failure
3046 int (*status)(void *priv, char *buf, size_t buflen);
3049 * roaming - Set roaming policy for driver-based BSS selection
3050 * @priv: Private driver interface data
3051 * @allowed: Whether roaming within ESS is allowed
3052 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3053 * Returns: Length of written status information or -1 on failure
3055 * This optional callback can be used to update roaming policy from the
3056 * associate() command (bssid being set there indicates that the driver
3057 * should not roam before getting this roaming() call to allow roaming.
3058 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3059 * capability, roaming policy is handled within wpa_supplicant and there
3060 * is no need to implement or react to this callback.
3062 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3065 * set_mac_addr - Set MAC address
3066 * @priv: Private driver interface data
3067 * @addr: MAC address to use or %NULL for setting back to permanent
3068 * Returns: 0 on success, -1 on failure
3070 int (*set_mac_addr)(void *priv, const u8 *addr);
3072 #ifdef CONFIG_MACSEC
3073 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3075 int (*macsec_deinit)(void *priv);
3078 * enable_protect_frames - Set protect frames status
3079 * @priv: Private driver interface data
3080 * @enabled: TRUE = protect frames enabled
3081 * FALSE = protect frames disabled
3082 * Returns: 0 on success, -1 on failure (or if not supported)
3084 int (*enable_protect_frames)(void *priv, Boolean enabled);
3087 * set_replay_protect - Set replay protect status and window size
3088 * @priv: Private driver interface data
3089 * @enabled: TRUE = replay protect enabled
3090 * FALSE = replay protect disabled
3091 * @window: replay window size, valid only when replay protect enabled
3092 * Returns: 0 on success, -1 on failure (or if not supported)
3094 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3097 * set_current_cipher_suite - Set current cipher suite
3098 * @priv: Private driver interface data
3099 * @cs: EUI64 identifier
3100 * @cs_len: Length of the cs buffer in octets
3101 * Returns: 0 on success, -1 on failure (or if not supported)
3103 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3107 * enable_controlled_port - Set controlled port status
3108 * @priv: Private driver interface data
3109 * @enabled: TRUE = controlled port enabled
3110 * FALSE = controlled port disabled
3111 * Returns: 0 on success, -1 on failure (or if not supported)
3113 int (*enable_controlled_port)(void *priv, Boolean enabled);
3116 * get_receive_lowest_pn - Get receive lowest pn
3117 * @priv: Private driver interface data
3118 * @channel: secure channel
3119 * @an: association number
3120 * @lowest_pn: lowest accept pn
3121 * Returns: 0 on success, -1 on failure (or if not supported)
3123 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3127 * get_transmit_next_pn - Get transmit next pn
3128 * @priv: Private driver interface data
3129 * @channel: secure channel
3130 * @an: association number
3132 * Returns: 0 on success, -1 on failure (or if not supported)
3134 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3138 * set_transmit_next_pn - Set transmit next pn
3139 * @priv: Private driver interface data
3140 * @channel: secure channel
3141 * @an: association number
3143 * Returns: 0 on success, -1 on failure (or if not supported)
3145 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3149 * get_available_receive_sc - get available receive channel
3150 * @priv: Private driver interface data
3151 * @channel: secure channel
3152 * Returns: 0 on success, -1 on failure (or if not supported)
3154 int (*get_available_receive_sc)(void *priv, u32 *channel);
3157 * create_receive_sc - create secure channel for receiving
3158 * @priv: Private driver interface data
3159 * @channel: secure channel
3160 * @sci_addr: secure channel identifier - address
3161 * @sci_port: secure channel identifier - port
3162 * @conf_offset: confidentiality offset (0, 30, or 50)
3163 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3165 * Returns: 0 on success, -1 on failure (or if not supported)
3167 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3168 u16 sci_port, unsigned int conf_offset,
3172 * delete_receive_sc - delete secure connection for receiving
3173 * @priv: private driver interface data from init()
3174 * @channel: secure channel
3175 * Returns: 0 on success, -1 on failure
3177 int (*delete_receive_sc)(void *priv, u32 channel);
3180 * create_receive_sa - create secure association for receive
3181 * @priv: private driver interface data from init()
3182 * @channel: secure channel
3183 * @an: association number
3184 * @lowest_pn: the lowest packet number can be received
3185 * @sak: the secure association key
3186 * Returns: 0 on success, -1 on failure
3188 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3189 u32 lowest_pn, const u8 *sak);
3192 * enable_receive_sa - enable the SA for receive
3193 * @priv: private driver interface data from init()
3194 * @channel: secure channel
3195 * @an: association number
3196 * Returns: 0 on success, -1 on failure
3198 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3201 * disable_receive_sa - disable SA for receive
3202 * @priv: private driver interface data from init()
3203 * @channel: secure channel index
3204 * @an: association number
3205 * Returns: 0 on success, -1 on failure
3207 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3210 * get_available_transmit_sc - get available transmit channel
3211 * @priv: Private driver interface data
3212 * @channel: secure channel
3213 * Returns: 0 on success, -1 on failure (or if not supported)
3215 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3218 * create_transmit_sc - create secure connection for transmit
3219 * @priv: private driver interface data from init()
3220 * @channel: secure channel
3221 * @sci_addr: secure channel identifier - address
3222 * @sci_port: secure channel identifier - port
3223 * Returns: 0 on success, -1 on failure
3225 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3226 u16 sci_port, unsigned int conf_offset);
3229 * delete_transmit_sc - delete secure connection for transmit
3230 * @priv: private driver interface data from init()
3231 * @channel: secure channel
3232 * Returns: 0 on success, -1 on failure
3234 int (*delete_transmit_sc)(void *priv, u32 channel);
3237 * create_transmit_sa - create secure association for transmit
3238 * @priv: private driver interface data from init()
3239 * @channel: secure channel index
3240 * @an: association number
3241 * @next_pn: the packet number used as next transmit packet
3242 * @confidentiality: True if the SA is to provide confidentiality
3243 * as well as integrity
3244 * @sak: the secure association key
3245 * Returns: 0 on success, -1 on failure
3247 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3248 Boolean confidentiality, const u8 *sak);
3251 * enable_transmit_sa - enable SA for transmit
3252 * @priv: private driver interface data from init()
3253 * @channel: secure channel
3254 * @an: association number
3255 * Returns: 0 on success, -1 on failure
3257 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3260 * disable_transmit_sa - disable SA for transmit
3261 * @priv: private driver interface data from init()
3262 * @channel: secure channel
3263 * @an: association number
3264 * Returns: 0 on success, -1 on failure
3266 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3267 #endif /* CONFIG_MACSEC */
3270 * init_mesh - Driver specific initialization for mesh
3271 * @priv: Private driver interface data
3272 * Returns: 0 on success, -1 on failure
3274 int (*init_mesh)(void *priv);
3277 * join_mesh - Join a mesh network
3278 * @priv: Private driver interface data
3279 * @params: Mesh configuration parameters
3280 * Returns: 0 on success, -1 on failure
3282 int (*join_mesh)(void *priv,
3283 struct wpa_driver_mesh_join_params *params);
3286 * leave_mesh - Leave a mesh network
3287 * @priv: Private driver interface data
3288 * Returns 0 on success, -1 on failure
3290 int (*leave_mesh)(void *priv);
3293 * do_acs - Automatically select channel
3294 * @priv: Private driver interface data
3295 * @params: Parameters for ACS
3296 * Returns 0 on success, -1 on failure
3298 * This command can be used to offload ACS to the driver if the driver
3299 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3301 int (*do_acs)(void *priv, struct drv_acs_params *params);
3306 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3308 enum wpa_event_type {
3310 * EVENT_ASSOC - Association completed
3312 * This event needs to be delivered when the driver completes IEEE
3313 * 802.11 association or reassociation successfully.
3314 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3315 * after this event has been generated. In addition, optional
3316 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3317 * more information about the association. If the driver interface gets
3318 * both of these events at the same time, it can also include the
3319 * assoc_info data in EVENT_ASSOC call.
3324 * EVENT_DISASSOC - Association lost
3326 * This event should be called when association is lost either due to
3327 * receiving deauthenticate or disassociate frame from the AP or when
3328 * sending either of these frames to the current AP. If the driver
3329 * supports separate deauthentication event, EVENT_DISASSOC should only
3330 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3331 * In AP mode, union wpa_event_data::disassoc_info is required.
3336 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3338 * This event must be delivered when a Michael MIC error is detected by
3339 * the local driver. Additional data for event processing is
3340 * provided with union wpa_event_data::michael_mic_failure. This
3341 * information is used to request new encyption key and to initiate
3342 * TKIP countermeasures if needed.
3344 EVENT_MICHAEL_MIC_FAILURE,
3347 * EVENT_SCAN_RESULTS - Scan results available
3349 * This event must be called whenever scan results are available to be
3350 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3351 * is expected to be used some time after struct wpa_driver_ops::scan()
3352 * is called. If the driver provides an unsolicited event when the scan
3353 * has been completed, this event can be used to trigger
3354 * EVENT_SCAN_RESULTS call. If such event is not available from the
3355 * driver, the driver wrapper code is expected to use a registered
3356 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3357 * scan is expected to be completed. Optional information about
3358 * completed scan can be provided with union wpa_event_data::scan_info.
3363 * EVENT_ASSOCINFO - Report optional extra information for association
3365 * This event can be used to report extra association information for
3366 * EVENT_ASSOC processing. This extra information includes IEs from
3367 * association frames and Beacon/Probe Response frames in union
3368 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3369 * EVENT_ASSOC. Alternatively, the driver interface can include
3370 * assoc_info data in the EVENT_ASSOC call if it has all the
3371 * information available at the same point.
3376 * EVENT_INTERFACE_STATUS - Report interface status changes
3378 * This optional event can be used to report changes in interface
3379 * status (interface added/removed) using union
3380 * wpa_event_data::interface_status. This can be used to trigger
3381 * wpa_supplicant to stop and re-start processing for the interface,
3382 * e.g., when a cardbus card is ejected/inserted.
3384 EVENT_INTERFACE_STATUS,
3387 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3389 * This event can be used to inform wpa_supplicant about candidates for
3390 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3391 * for scan request (ap_scan=2 mode), this event is required for
3392 * pre-authentication. If wpa_supplicant is performing scan request
3393 * (ap_scan=1), this event is optional since scan results can be used
3394 * to add pre-authentication candidates. union
3395 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3396 * candidate and priority of the candidate, e.g., based on the signal
3397 * strength, in order to try to pre-authenticate first with candidates
3398 * that are most likely targets for re-association.
3400 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3401 * on the candidate list. In addition, it can be called for the current
3402 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3403 * will automatically skip pre-authentication in cases where a valid
3404 * PMKSA exists. When more than one candidate exists, this event should
3405 * be generated once for each candidate.
3407 * Driver will be notified about successful pre-authentication with
3408 * struct wpa_driver_ops::add_pmkid() calls.
3410 EVENT_PMKID_CANDIDATE,
3413 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3415 * This event can be used to inform wpa_supplicant about desire to set
3416 * up secure direct link connection between two stations as defined in
3417 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3418 * STAKey negotiation. The caller will need to set peer address for the
3424 * EVENT_TDLS - Request TDLS operation
3426 * This event can be used to request a TDLS operation to be performed.
3431 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3433 * The driver is expected to report the received FT IEs from
3434 * FT authentication sequence from the AP. The FT IEs are included in
3435 * the extra information in union wpa_event_data::ft_ies.
3440 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3442 * The driver can use this event to inform wpa_supplicant about a STA
3443 * in an IBSS with which protected frames could be exchanged. This
3444 * event starts RSN authentication with the other STA to authenticate
3445 * the STA and set up encryption keys with it.
3447 EVENT_IBSS_RSN_START,
3450 * EVENT_AUTH - Authentication result
3452 * This event should be called when authentication attempt has been
3453 * completed. This is only used if the driver supports separate
3454 * authentication step (struct wpa_driver_ops::authenticate).
3455 * Information about authentication result is included in
3456 * union wpa_event_data::auth.
3461 * EVENT_DEAUTH - Authentication lost
3463 * This event should be called when authentication is lost either due
3464 * to receiving deauthenticate frame from the AP or when sending that
3465 * frame to the current AP.
3466 * In AP mode, union wpa_event_data::deauth_info is required.
3471 * EVENT_ASSOC_REJECT - Association rejected
3473 * This event should be called when (re)association attempt has been
3474 * rejected by the AP. Information about the association response is
3475 * included in union wpa_event_data::assoc_reject.
3480 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3482 EVENT_AUTH_TIMED_OUT,
3485 * EVENT_ASSOC_TIMED_OUT - Association timed out
3487 EVENT_ASSOC_TIMED_OUT,
3490 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3492 EVENT_WPS_BUTTON_PUSHED,
3495 * EVENT_TX_STATUS - Report TX status
3500 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3502 EVENT_RX_FROM_UNKNOWN,
3505 * EVENT_RX_MGMT - Report RX of a management frame
3510 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3512 * This event is used to indicate when the driver has started the
3513 * requested remain-on-channel duration. Information about the
3514 * operation is included in union wpa_event_data::remain_on_channel.
3516 EVENT_REMAIN_ON_CHANNEL,
3519 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3521 * This event is used to indicate when the driver has completed
3522 * remain-on-channel duration, i.e., may noot be available on the
3523 * requested channel anymore. Information about the
3524 * operation is included in union wpa_event_data::remain_on_channel.
3526 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3529 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3531 * This event is used to indicate when a Probe Request frame has been
3532 * received. Information about the received frame is included in
3533 * union wpa_event_data::rx_probe_req. The driver is required to report
3534 * these events only after successfully completed probe_req_report()
3535 * commands to request the events (i.e., report parameter is non-zero)
3536 * in station mode. In AP mode, Probe Request frames should always be
3542 * EVENT_NEW_STA - New wired device noticed
3544 * This event is used to indicate that a new device has been detected
3545 * in a network that does not use association-like functionality (i.e.,
3546 * mainly wired Ethernet). This can be used to start EAPOL
3547 * authenticator when receiving a frame from a device. The address of
3548 * the device is included in union wpa_event_data::new_sta.
3553 * EVENT_EAPOL_RX - Report received EAPOL frame
3555 * When in AP mode with hostapd, this event is required to be used to
3556 * deliver the receive EAPOL frames from the driver.
3561 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3563 * This event is used to indicate changes in the signal strength
3564 * observed in frames received from the current AP if signal strength
3565 * monitoring has been enabled with signal_monitor().
3567 EVENT_SIGNAL_CHANGE,
3570 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3572 * This event is used to indicate that the interface was enabled after
3573 * having been previously disabled, e.g., due to rfkill.
3575 EVENT_INTERFACE_ENABLED,
3578 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3580 * This event is used to indicate that the interface was disabled,
3581 * e.g., due to rfkill.
3583 EVENT_INTERFACE_DISABLED,
3586 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3588 * This event is used to indicate that the channel list has changed,
3589 * e.g., because of a regulatory domain change triggered by scan
3590 * results including an AP advertising a country code.
3592 EVENT_CHANNEL_LIST_CHANGED,
3595 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3597 * This event is used to indicate that the driver cannot maintain this
3598 * interface in its operation mode anymore. The most likely use for
3599 * this is to indicate that AP mode operation is not available due to
3600 * operating channel would need to be changed to a DFS channel when
3601 * the driver does not support radar detection and another virtual
3602 * interfaces caused the operating channel to change. Other similar
3603 * resource conflicts could also trigger this for station mode
3604 * interfaces. This event can be propagated when channel switching
3607 EVENT_INTERFACE_UNAVAILABLE,
3610 * EVENT_BEST_CHANNEL
3612 * Driver generates this event whenever it detects a better channel
3613 * (e.g., based on RSSI or channel use). This information can be used
3614 * to improve channel selection for a new AP/P2P group.
3619 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3621 * This event should be called when a Deauthentication frame is dropped
3622 * due to it not being protected (MFP/IEEE 802.11w).
3623 * union wpa_event_data::unprot_deauth is required to provide more
3624 * details of the frame.
3626 EVENT_UNPROT_DEAUTH,
3629 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3631 * This event should be called when a Disassociation frame is dropped
3632 * due to it not being protected (MFP/IEEE 802.11w).
3633 * union wpa_event_data::unprot_disassoc is required to provide more
3634 * details of the frame.
3636 EVENT_UNPROT_DISASSOC,
3639 * EVENT_STATION_LOW_ACK
3641 * Driver generates this event whenever it detected that a particular
3642 * station was lost. Detection can be through massive transmission
3643 * failures for example.
3645 EVENT_STATION_LOW_ACK,
3648 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3650 EVENT_IBSS_PEER_LOST,
3653 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3655 * This event carries the new replay counter to notify wpa_supplicant
3656 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3657 * completed Group Key Handshake while the host (including
3658 * wpa_supplicant was sleeping).
3660 EVENT_DRIVER_GTK_REKEY,
3663 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3665 EVENT_SCHED_SCAN_STOPPED,
3668 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3670 * This event indicates that the station responded to the poll
3671 * initiated with @poll_client.
3673 EVENT_DRIVER_CLIENT_POLL_OK,
3676 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3678 EVENT_EAPOL_TX_STATUS,
3681 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3683 * Described in wpa_event_data.ch_switch
3688 * EVENT_WNM - Request WNM operation
3690 * This event can be used to request a WNM operation to be performed.
3695 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3697 * This event indicates that the driver reported a connection failure
3698 * with the specified client (for example, max client reached, etc.) in
3701 EVENT_CONNECT_FAILED_REASON,
3704 * EVENT_RADAR_DETECTED - Notify of radar detection
3706 * A radar has been detected on the supplied frequency, hostapd should
3707 * react accordingly (e.g., change channel).
3709 EVENT_DFS_RADAR_DETECTED,
3712 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3714 * After a successful CAC, the channel can be marked clear and used.
3716 EVENT_DFS_CAC_FINISHED,
3719 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3721 * The CAC was not successful, and the channel remains in the previous
3722 * state. This may happen due to a radar beeing detected or other
3723 * external influences.
3725 EVENT_DFS_CAC_ABORTED,
3728 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3730 * The channel which was previously unavailable is now available again.
3732 EVENT_DFS_NOP_FINISHED,
3735 * EVENT_SURVEY - Received survey data
3737 * This event gets triggered when a driver query is issued for survey
3738 * data and the requested data becomes available. The returned data is
3739 * stored in struct survey_results. The results provide at most one
3740 * survey entry for each frequency and at minimum will provide one
3741 * survey entry for one frequency. The survey data can be os_malloc()'d
3742 * and then os_free()'d, so the event callback must only copy data.
3747 * EVENT_SCAN_STARTED - Scan started
3749 * This indicates that driver has started a scan operation either based
3750 * on a request from wpa_supplicant/hostapd or from another application.
3751 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3752 * completed (either successfully or by getting cancelled).
3757 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3759 * This event indicates a set of frequency ranges that should be avoided
3760 * to reduce issues due to interference or internal co-existence
3761 * information in the driver.
3763 EVENT_AVOID_FREQUENCIES,
3766 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3768 EVENT_NEW_PEER_CANDIDATE,
3771 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
3773 * Indicates a pair of primary and secondary channels chosen by ACS
3776 EVENT_ACS_CHANNEL_SELECTED,
3781 * struct freq_survey - Channel survey info
3783 * @ifidx: Interface index in which this survey was observed
3784 * @freq: Center of frequency of the surveyed channel
3785 * @nf: Channel noise floor in dBm
3786 * @channel_time: Amount of time in ms the radio spent on the channel
3787 * @channel_time_busy: Amount of time in ms the radio detected some signal
3788 * that indicated to the radio the channel was not clear
3789 * @channel_time_rx: Amount of time the radio spent receiving data
3790 * @channel_time_tx: Amount of time the radio spent transmitting data
3791 * @filled: bitmask indicating which fields have been reported, see
3792 * SURVEY_HAS_* defines.
3793 * @list: Internal list pointers
3795 struct freq_survey {
3800 u64 channel_time_busy;
3801 u64 channel_time_rx;
3802 u64 channel_time_tx;
3803 unsigned int filled;
3804 struct dl_list list;
3807 #define SURVEY_HAS_NF BIT(0)
3808 #define SURVEY_HAS_CHAN_TIME BIT(1)
3809 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3810 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3811 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3815 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3817 union wpa_event_data {
3819 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3821 * This structure is optional for EVENT_ASSOC calls and required for
3822 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3823 * driver interface does not need to generate separate EVENT_ASSOCINFO
3828 * reassoc - Flag to indicate association or reassociation
3833 * req_ies - (Re)Association Request IEs
3835 * If the driver generates WPA/RSN IE, this event data must be
3836 * returned for WPA handshake to have needed information. If
3837 * wpa_supplicant-generated WPA/RSN IE is used, this
3838 * information event is optional.
3840 * This should start with the first IE (fixed fields before IEs
3841 * are not included).
3846 * req_ies_len - Length of req_ies in bytes
3851 * resp_ies - (Re)Association Response IEs
3853 * Optional association data from the driver. This data is not
3854 * required WPA, but may be useful for some protocols and as
3855 * such, should be reported if this is available to the driver
3858 * This should start with the first IE (fixed fields before IEs
3859 * are not included).
3864 * resp_ies_len - Length of resp_ies in bytes
3866 size_t resp_ies_len;
3869 * beacon_ies - Beacon or Probe Response IEs
3871 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3872 * Probe Response frames from the current AP (i.e., the one
3873 * that the client just associated with). This information is
3874 * used to update WPA/RSN IE for the AP. If this field is not
3875 * set, the results from previous scan will be used. If no
3876 * data for the new AP is found, scan results will be requested
3877 * again (without scan request). At this point, the driver is
3878 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3881 * This should start with the first IE (fixed fields before IEs
3882 * are not included).
3884 const u8 *beacon_ies;
3887 * beacon_ies_len - Length of beacon_ies */
3888 size_t beacon_ies_len;
3891 * freq - Frequency of the operational channel in MHz
3896 * wmm_params - WMM parameters used in this association.
3898 struct wmm_params wmm_params;
3901 * addr - Station address (for AP mode)
3906 * The following is the key management offload information
3909 * @key_replay_ctr_len
3917 * authorized - Status of key management offload,
3923 * key_replay_ctr - Key replay counter value last used
3924 * in a valid EAPOL-Key frame
3926 const u8 *key_replay_ctr;
3929 * key_replay_ctr_len - The length of key_replay_ctr
3931 size_t key_replay_ctr_len;
3934 * ptk_kck - The derived PTK KCK
3939 * ptk_kek_len - The length of ptk_kck
3944 * ptk_kek - The derived PTK KEK
3949 * ptk_kek_len - The length of ptk_kek
3955 * struct disassoc_info - Data for EVENT_DISASSOC events
3957 struct disassoc_info {
3959 * addr - Station address (for AP mode)
3964 * reason_code - Reason Code (host byte order) used in
3965 * Deauthentication frame
3970 * ie - Optional IE(s) in Disassociation frame
3975 * ie_len - Length of ie buffer in octets
3980 * locally_generated - Whether the frame was locally generated
3982 int locally_generated;
3986 * struct deauth_info - Data for EVENT_DEAUTH events
3988 struct deauth_info {
3990 * addr - Station address (for AP mode)
3995 * reason_code - Reason Code (host byte order) used in
3996 * Deauthentication frame
4001 * ie - Optional IE(s) in Deauthentication frame
4006 * ie_len - Length of ie buffer in octets
4011 * locally_generated - Whether the frame was locally generated
4013 int locally_generated;
4017 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4019 struct michael_mic_failure {
4022 } michael_mic_failure;
4025 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4027 struct interface_status {
4030 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4035 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4037 struct pmkid_candidate {
4038 /** BSSID of the PMKID candidate */
4040 /** Smaller the index, higher the priority */
4042 /** Whether RSN IE includes pre-authenticate flag */
4047 * struct stkstart - Data for EVENT_STKSTART
4054 * struct tdls - Data for EVENT_TDLS
4060 TDLS_REQUEST_TEARDOWN
4062 u16 reason_code; /* for teardown */
4066 * struct wnm - Data for EVENT_WNM
4084 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4086 * During FT (IEEE 802.11r) authentication sequence, the driver is
4087 * expected to use this event to report received FT IEs (MDIE, FTIE,
4088 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4089 * IEs for the next message will be delivered through the
4090 * struct wpa_driver_ops::update_ft_ies() callback.
4096 u8 target_ap[ETH_ALEN];
4097 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4099 /** Length of ric_ies buffer in octets */
4104 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4106 struct ibss_rsn_start {
4111 * struct auth_info - Data for EVENT_AUTH events
4117 u16 auth_transaction;
4124 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4126 struct assoc_reject {
4128 * bssid - BSSID of the AP that rejected association
4133 * resp_ies - (Re)Association Response IEs
4135 * Optional association data from the driver. This data is not
4136 * required WPA, but may be useful for some protocols and as
4137 * such, should be reported if this is available to the driver
4140 * This should start with the first IE (fixed fields before IEs
4141 * are not included).
4146 * resp_ies_len - Length of resp_ies in bytes
4148 size_t resp_ies_len;
4151 * status_code - Status Code from (Re)association Response
4156 struct timeout_event {
4161 * struct tx_status - Data for EVENT_TX_STATUS events
4173 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4175 struct rx_from_unknown {
4182 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4190 * drv_priv - Pointer to store driver private BSS information
4192 * If not set to NULL, this is used for comparison with
4193 * hostapd_data->drv_priv to determine which BSS should process
4199 * freq - Frequency (in MHz) on which the frame was received
4204 * ssi_signal - Signal strength in dBm (or 0 if not available)
4210 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4212 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4214 struct remain_on_channel {
4216 * freq - Channel frequency in MHz
4221 * duration - Duration to remain on the channel in milliseconds
4223 unsigned int duration;
4224 } remain_on_channel;
4227 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4228 * @aborted: Whether the scan was aborted
4229 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4230 * @num_freqs: Number of entries in freqs array
4231 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4233 * @num_ssids: Number of entries in ssids array
4239 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4244 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4246 struct rx_probe_req {
4248 * sa - Source address of the received Probe Request frame
4253 * da - Destination address of the received Probe Request frame
4254 * or %NULL if not available
4259 * bssid - BSSID of the received Probe Request frame or %NULL
4265 * ie - IEs from the Probe Request body
4270 * ie_len - Length of ie buffer in octets
4275 * signal - signal strength in dBm (or 0 if not available)
4281 * struct new_sta - Data for EVENT_NEW_STA events
4288 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4297 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4299 struct wpa_signal_info signal_change;
4302 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4303 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4304 * @freq_5: Best 5 GHz band channel frequency in MHz
4305 * @freq_overall: Best channel frequency in MHz
4307 * 0 can be used to indicate no preference in either band.
4309 struct best_channel {
4315 struct unprot_deauth {
4321 struct unprot_disassoc {
4328 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4329 * @addr: station address
4336 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4338 struct ibss_peer_lost {
4343 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4345 struct driver_gtk_rekey {
4347 const u8 *replay_ctr;
4351 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4352 * @addr: station address
4354 struct client_poll {
4359 * struct eapol_tx_status
4360 * @dst: Original destination
4361 * @data: Data starting with IEEE 802.1X header (!)
4362 * @data_len: Length of data
4363 * @ack: Indicates ack or lost frame
4365 * This corresponds to hapd_send_eapol if the frame sent
4366 * there isn't just reported as EVENT_TX_STATUS.
4368 struct eapol_tx_status {
4377 * @freq: Frequency of new channel in MHz
4378 * @ht_enabled: Whether this is an HT channel
4379 * @ch_offset: Secondary channel offset
4380 * @ch_width: Channel width
4381 * @cf1: Center frequency 1
4382 * @cf2: Center frequency 2
4388 enum chan_width ch_width;
4394 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4395 * @addr: Remote client address
4396 * @code: Reason code for connection failure
4398 struct connect_failed_reason {
4404 } connect_failed_reason;
4407 * struct dfs_event - Data for radar detected events
4408 * @freq: Frequency of the channel in MHz
4414 enum chan_width chan_width;
4420 * survey_results - Survey result data for EVENT_SURVEY
4421 * @freq_filter: Requested frequency survey filter, 0 if request
4422 * was for all survey data
4423 * @survey_list: Linked list of survey data (struct freq_survey)
4425 struct survey_results {
4426 unsigned int freq_filter;
4427 struct dl_list survey_list; /* struct freq_survey */
4431 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4432 * @initiator: Initiator of the regulatory change
4433 * @type: Regulatory change type
4434 * @alpha2: Country code (or "" if not available)
4436 struct channel_list_changed {
4437 enum reg_change_initiator initiator;
4440 } channel_list_changed;
4443 * freq_range - List of frequency ranges
4445 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4447 struct wpa_freq_range_list freq_range;
4452 * @peer: Peer address
4454 * @ie_len: Length of @ies
4456 * Notification of new candidate mesh peer.
4465 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4466 * @pri_channel: Selected primary channel
4467 * @sec_channel: Selected secondary channel
4469 struct acs_selected_channels {
4472 } acs_selected_channels;
4476 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4477 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4478 * with struct wpa_driver_ops::init()
4479 * @event: event type (defined above)
4480 * @data: possible extra data for the event
4482 * Driver wrapper code should call this function whenever an event is received
4485 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4486 union wpa_event_data *data);
4490 * The following inline functions are provided for convenience to simplify
4491 * event indication for some of the common events.
4494 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4495 size_t ielen, int reassoc)
4497 union wpa_event_data event;
4498 os_memset(&event, 0, sizeof(event));
4499 event.assoc_info.reassoc = reassoc;
4500 event.assoc_info.req_ies = ie;
4501 event.assoc_info.req_ies_len = ielen;
4502 event.assoc_info.addr = addr;
4503 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4506 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4508 union wpa_event_data event;
4509 os_memset(&event, 0, sizeof(event));
4510 event.disassoc_info.addr = addr;
4511 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4514 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4517 union wpa_event_data event;
4518 os_memset(&event, 0, sizeof(event));
4519 event.eapol_rx.src = src;
4520 event.eapol_rx.data = data;
4521 event.eapol_rx.data_len = data_len;
4522 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4525 /* driver_common.c */
4526 void wpa_scan_results_free(struct wpa_scan_results *res);
4528 /* Convert wpa_event_type to a string for logging */
4529 const char * event_to_string(enum wpa_event_type event);
4531 /* Convert chan_width to a string for logging and control interfaces */
4532 const char * channel_width_to_string(enum chan_width width);
4534 int ht_supported(const struct hostapd_hw_modes *mode);
4535 int vht_supported(const struct hostapd_hw_modes *mode);
4537 struct wowlan_triggers *
4538 wpa_get_wowlan_triggers(const char *wowlan_triggers,
4539 const struct wpa_driver_capa *capa);
4541 /* NULL terminated array of linked in driver wrappers */
4542 extern struct wpa_driver_ops *wpa_drivers[];
4544 #endif /* DRIVER_H */