2 * Driver interface definition
3 * Copyright (c) 2003-2015, 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 "common/ieee802_11_defs.h"
24 #include "utils/list.h"
26 #define HOSTAPD_CHAN_DISABLED 0x00000001
27 #define HOSTAPD_CHAN_NO_IR 0x00000002
28 #define HOSTAPD_CHAN_RADAR 0x00000008
29 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
30 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
31 #define HOSTAPD_CHAN_HT40 0x00000040
32 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
34 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
35 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
36 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
37 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
38 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
40 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
41 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
42 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
43 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
45 #define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
46 #define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
49 * enum reg_change_initiator - Regulatory change initiator
51 enum reg_change_initiator {
55 REGDOM_SET_BY_COUNTRY_IE,
60 * enum reg_type - Regulatory change types
66 REGDOM_TYPE_CUSTOM_WORLD,
67 REGDOM_TYPE_INTERSECTION,
71 * struct hostapd_channel_data - Channel information
73 struct hostapd_channel_data {
75 * chan - Channel number (IEEE 802.11)
80 * freq - Frequency in MHz
85 * flag - Channel flags (HOSTAPD_CHAN_*)
90 * max_tx_power - Regulatory transmit power limit in dBm
95 * survey_list - Linked list of surveys (struct freq_survey)
97 struct dl_list survey_list;
100 * min_nf - Minimum observed noise floor, in dBm, based on all
101 * surveyed channel data
107 * interference_factor - Computed interference factor on this
108 * channel (used internally in src/ap/acs.c; driver wrappers do not
111 long double interference_factor;
112 #endif /* CONFIG_ACS */
115 * dfs_cac_ms - DFS CAC time in milliseconds
117 unsigned int dfs_cac_ms;
120 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
121 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
124 * struct hostapd_hw_modes - Supported hardware mode information
126 struct hostapd_hw_modes {
128 * mode - Hardware mode
130 enum hostapd_hw_mode mode;
133 * num_channels - Number of entries in the channels array
138 * channels - Array of supported channels
140 struct hostapd_channel_data *channels;
143 * num_rates - Number of entries in the rates array
148 * rates - Array of supported rates in 100 kbps units
153 * ht_capab - HT (IEEE 802.11n) capabilities
158 * mcs_set - MCS (IEEE 802.11n) rate parameters
163 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
168 * vht_capab - VHT (IEEE 802.11ac) capabilities
173 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
177 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
181 #define IEEE80211_MODE_INFRA 0
182 #define IEEE80211_MODE_IBSS 1
183 #define IEEE80211_MODE_AP 2
184 #define IEEE80211_MODE_MESH 5
186 #define IEEE80211_CAP_ESS 0x0001
187 #define IEEE80211_CAP_IBSS 0x0002
188 #define IEEE80211_CAP_PRIVACY 0x0010
189 #define IEEE80211_CAP_RRM 0x1000
191 /* DMG (60 GHz) IEEE 802.11ad */
192 /* type - bits 0..1 */
193 #define IEEE80211_CAP_DMG_MASK 0x0003
194 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
195 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
196 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
198 #define WPA_SCAN_QUAL_INVALID BIT(0)
199 #define WPA_SCAN_NOISE_INVALID BIT(1)
200 #define WPA_SCAN_LEVEL_INVALID BIT(2)
201 #define WPA_SCAN_LEVEL_DBM BIT(3)
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 * @est_throughput: Estimated throughput in kbps (this is calculated during
218 * scan result processing if left zero by the driver wrapper)
219 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
220 * @ie_len: length of the following IE field in octets
221 * @beacon_ie_len: length of the following Beacon IE field in octets
223 * This structure is used as a generic format for scan results from the
224 * driver. Each driver interface implementation is responsible for converting
225 * the driver or OS specific scan results into this format.
227 * If the driver does not support reporting all IEs, the IE data structure is
228 * constructed of the IEs that are available. This field will also need to
229 * include SSID in IE format. All drivers are encouraged to be extended to
230 * report all IEs to make it easier to support future additions.
232 * This structure data is followed by ie_len octets of IEs from Probe Response
233 * frame (or if the driver does not indicate source of IEs, these may also be
234 * from Beacon frame). After the first set of IEs, another set of IEs may follow
235 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
237 struct wpa_scan_res {
248 unsigned int est_throughput;
251 size_t beacon_ie_len;
252 /* Followed by ie_len + beacon_ie_len octets of IE data */
256 * struct wpa_scan_results - Scan results
257 * @res: Array of pointers to allocated variable length scan result entries
258 * @num: Number of entries in the scan result array
259 * @fetch_time: Time when the results were fetched from the driver
261 struct wpa_scan_results {
262 struct wpa_scan_res **res;
264 struct os_reltime fetch_time;
268 * struct wpa_interface_info - Network interface information
269 * @next: Pointer to the next interface or NULL if this is the last one
270 * @ifname: Interface name that can be used with init() or init2()
271 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
273 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
274 * is not an allocated copy, i.e., get_interfaces() caller will not free
277 struct wpa_interface_info {
278 struct wpa_interface_info *next;
281 const char *drv_name;
284 #define WPAS_MAX_SCAN_SSIDS 16
287 * struct wpa_driver_scan_params - Scan parameters
288 * Data for struct wpa_driver_ops::scan2().
290 struct wpa_driver_scan_params {
292 * ssids - SSIDs to scan for
294 struct wpa_driver_scan_ssid {
296 * ssid - specific SSID to scan for (ProbeReq)
297 * %NULL or zero-length SSID is used to indicate active scan
298 * with wildcard SSID.
302 * ssid_len: Length of the SSID in octets
305 } ssids[WPAS_MAX_SCAN_SSIDS];
308 * num_ssids - Number of entries in ssids array
309 * Zero indicates a request for a passive scan.
314 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
319 * extra_ies_len - Length of extra_ies in octets
321 size_t extra_ies_len;
324 * freqs - Array of frequencies to scan or %NULL for all frequencies
326 * The frequency is set in MHz. The array is zero-terminated.
331 * filter_ssids - Filter for reporting SSIDs
333 * This optional parameter can be used to request the driver wrapper to
334 * filter scan results to include only the specified SSIDs. %NULL
335 * indicates that no filtering is to be done. This can be used to
336 * reduce memory needs for scan results in environments that have large
337 * number of APs with different SSIDs.
339 * The driver wrapper is allowed to take this allocated buffer into its
340 * own use by setting the pointer to %NULL. In that case, the driver
341 * wrapper is responsible for freeing the buffer with os_free() once it
342 * is not needed anymore.
344 struct wpa_driver_scan_filter {
345 u8 ssid[SSID_MAX_LEN];
350 * num_filter_ssids - Number of entries in filter_ssids array
352 size_t num_filter_ssids;
355 * filter_rssi - Filter by RSSI
357 * The driver may filter scan results in firmware to reduce host
358 * wakeups and thereby save power. Specify the RSSI threshold in s32
364 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
366 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
367 * Mbps from the support rates element(s) in the Probe Request frames
368 * and not to transmit the frames at any of those rates.
370 unsigned int p2p_probe:1;
373 * only_new_results - Request driver to report only new results
375 * This is used to request the driver to report only BSSes that have
376 * been detected after this scan request has been started, i.e., to
377 * flush old cached BSS entries.
379 unsigned int only_new_results:1;
382 * low_priority - Requests driver to use a lower scan priority
384 * This is used to request the driver to use a lower scan priority
385 * if it supports such a thing.
387 unsigned int low_priority:1;
390 * mac_addr_rand - Requests driver to randomize MAC address
392 unsigned int mac_addr_rand:1;
395 * mac_addr - MAC address used with randomization. The address cannot be
396 * a multicast one, i.e., bit 0 of byte 0 should not be set.
401 * mac_addr_mask - MAC address mask used with randomization.
403 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
404 * the mask should be taken as is from mac_addr. The mask should not
405 * allow the generation of a multicast address, i.e., bit 0 of byte 0
408 const u8 *mac_addr_mask;
411 * NOTE: Whenever adding new parameters here, please make sure
412 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
418 * struct wpa_driver_auth_params - Authentication parameters
419 * Data for struct wpa_driver_ops::authenticate().
421 struct wpa_driver_auth_params {
429 const u8 *wep_key[4];
430 size_t wep_key_len[4];
432 int local_state_change;
435 * p2p - Whether this connection is a P2P group
440 * sae_data - SAE elements for Authentication frame
442 * This buffer starts with the Authentication transaction sequence
443 * number field. If SAE is not used, this pointer is %NULL.
448 * sae_data_len - Length of sae_data buffer in octets
454 * enum wps_mode - WPS mode
458 * WPS_MODE_NONE - No WPS provisioning being used
463 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
468 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
474 * struct hostapd_freq_params - Channel parameters
476 struct hostapd_freq_params {
478 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
480 enum hostapd_hw_mode mode;
483 * freq - Primary channel center frequency in MHz
488 * channel - Channel number
493 * ht_enabled - Whether HT is enabled
498 * sec_channel_offset - Secondary channel offset for HT40
501 * -1 = HT40 enabled, secondary channel below primary,
502 * 1 = HT40 enabled, secondary channel above primary
504 int sec_channel_offset;
507 * vht_enabled - Whether VHT is enabled
512 * center_freq1 - Segment 0 center frequency in MHz
514 * Valid for both HT and VHT.
519 * center_freq2 - Segment 1 center frequency in MHz
521 * Non-zero only for bandwidth 80 and an 80+80 channel
526 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
532 * struct wpa_driver_associate_params - Association parameters
533 * Data for struct wpa_driver_ops::associate().
535 struct wpa_driver_associate_params {
537 * bssid - BSSID of the selected AP
538 * This can be %NULL, if ap_scan=2 mode is used and the driver is
539 * responsible for selecting with which BSS to associate. */
543 * bssid_hint - BSSID of a proposed AP
545 * This indicates which BSS has been found a suitable candidate for
546 * initial association for drivers that use driver/firmwate-based BSS
547 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
548 * the driver from selecting other BSSes in the ESS.
550 const u8 *bssid_hint;
553 * ssid - The selected SSID
558 * ssid_len - Length of the SSID (1..32)
563 * freq - channel parameters
565 struct hostapd_freq_params freq;
568 * freq_hint - Frequency of the channel the proposed AP is using
570 * This provides a channel on which a suitable BSS has been found as a
571 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
572 * limit the driver from selecting other channels for
573 * driver/firmware-based BSS selection.
578 * bg_scan_period - Background scan period in seconds, 0 to disable
579 * background scan, or -1 to indicate no change to default driver
585 * beacon_int - Beacon interval for IBSS or 0 to use driver default
590 * wpa_ie - WPA information element for (Re)Association Request
591 * WPA information element to be included in (Re)Association
592 * Request (including information element id and length). Use
593 * of this WPA IE is optional. If the driver generates the WPA
594 * IE, it can use pairwise_suite, group_suite, and
595 * key_mgmt_suite to select proper algorithms. In this case,
596 * the driver has to notify wpa_supplicant about the used WPA
597 * IE by generating an event that the interface code will
598 * convert into EVENT_ASSOCINFO data (see below).
600 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
601 * instead. The driver can determine which version is used by
602 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
605 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
610 * wpa_ie_len - length of the wpa_ie
615 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
617 unsigned int wpa_proto;
620 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
622 * This is usually ignored if @wpa_ie is used.
624 unsigned int pairwise_suite;
627 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
629 * This is usually ignored if @wpa_ie is used.
631 unsigned int group_suite;
634 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
636 * This is usually ignored if @wpa_ie is used.
638 unsigned int key_mgmt_suite;
641 * auth_alg - Allowed authentication algorithms
642 * Bit field of WPA_AUTH_ALG_*
647 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
652 * wep_key - WEP keys for static WEP configuration
654 const u8 *wep_key[4];
657 * wep_key_len - WEP key length for static WEP configuration
659 size_t wep_key_len[4];
662 * wep_tx_keyidx - WEP TX key index for static WEP configuration
667 * mgmt_frame_protection - IEEE 802.11w management frame protection
669 enum mfp_options mgmt_frame_protection;
672 * ft_ies - IEEE 802.11r / FT information elements
673 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
674 * for fast transition, this parameter is set to include the IEs that
675 * are to be sent in the next FT Authentication Request message.
676 * update_ft_ies() handler is called to update the IEs for further
677 * FT messages in the sequence.
679 * The driver should use these IEs only if the target AP is advertising
680 * the same mobility domain as the one included in the MDIE here.
682 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
683 * AP after the initial association. These IEs can only be used if the
684 * target AP is advertising support for FT and is using the same MDIE
685 * and SSID as the current AP.
687 * The driver is responsible for reporting the FT IEs received from the
688 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
689 * type. update_ft_ies() handler will then be called with the FT IEs to
690 * include in the next frame in the authentication sequence.
695 * ft_ies_len - Length of ft_ies in bytes
700 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
702 * This value is provided to allow the driver interface easier access
703 * to the current mobility domain. This value is set to %NULL if no
704 * mobility domain is currently active.
709 * passphrase - RSN passphrase for PSK
711 * This value is made available only for WPA/WPA2-Personal (PSK) and
712 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
713 * the 8..63 character ASCII passphrase, if available. Please note that
714 * this can be %NULL if passphrase was not used to generate the PSK. In
715 * that case, the psk field must be used to fetch the PSK.
717 const char *passphrase;
720 * psk - RSN PSK (alternative for passphrase for PSK)
722 * This value is made available only for WPA/WPA2-Personal (PSK) and
723 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
724 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
725 * be prepared to handle %NULL value as an error.
730 * drop_unencrypted - Enable/disable unencrypted frame filtering
732 * Configure the driver to drop all non-EAPOL frames (both receive and
733 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
734 * still be allowed for key negotiation.
736 int drop_unencrypted;
739 * prev_bssid - Previously used BSSID in this ESS
741 * When not %NULL, this is a request to use reassociation instead of
744 const u8 *prev_bssid;
749 * If the driver needs to do special configuration for WPS association,
750 * this variable provides more information on what type of association
751 * is being requested. Most drivers should not need ot use this.
756 * p2p - Whether this connection is a P2P group
761 * uapsd - UAPSD parameters for the network
762 * -1 = do not change defaults
763 * AP mode: 1 = enabled, 0 = disabled
764 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
769 * fixed_bssid - Whether to force this BSSID in IBSS mode
770 * 1 = Fix this BSSID and prevent merges.
771 * 0 = Do not fix BSSID.
776 * fixed_freq - Fix control channel in IBSS mode
777 * 0 = don't fix control channel (default)
778 * 1 = fix control channel; this prevents IBSS merging with another
784 * disable_ht - Disable HT (IEEE 802.11n) for this connection
789 * htcaps - HT Capabilities over-rides
791 * Only bits set in the mask will be used, and not all values are used
792 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
794 * Pointer to struct ieee80211_ht_capabilities.
799 * htcaps_mask - HT Capabilities over-rides mask
801 * Pointer to struct ieee80211_ht_capabilities.
803 const u8 *htcaps_mask;
805 #ifdef CONFIG_VHT_OVERRIDES
807 * disable_vht - Disable VHT for this connection
812 * VHT capability overrides.
814 const struct ieee80211_vht_capabilities *vhtcaps;
815 const struct ieee80211_vht_capabilities *vhtcaps_mask;
816 #endif /* CONFIG_VHT_OVERRIDES */
819 * req_key_mgmt_offload - Request key management offload for connection
821 * Request key management offload for this connection if the device
824 int req_key_mgmt_offload;
827 * Flag for indicating whether this association includes support for
828 * RRM (Radio Resource Measurements)
835 HIDDEN_SSID_ZERO_LEN,
836 HIDDEN_SSID_ZERO_CONTENTS
839 struct wowlan_triggers {
843 u8 gtk_rekey_failure;
845 u8 four_way_handshake;
849 struct wpa_driver_ap_params {
851 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
856 * head_len - Length of the head buffer in octets
861 * tail - Beacon tail following TIM IE
866 * tail_len - Length of the tail buffer in octets
871 * dtim_period - DTIM period
876 * beacon_int - Beacon interval
881 * basic_rates: -1 terminated array of basic rates in 100 kbps
883 * This parameter can be used to set a specific basic rate set for the
884 * BSS. If %NULL, default basic rate set is used.
889 * proberesp - Probe Response template
891 * This is used by drivers that reply to Probe Requests internally in
892 * AP mode and require the full Probe Response template.
897 * proberesp_len - Length of the proberesp buffer in octets
899 size_t proberesp_len;
902 * ssid - The SSID to use in Beacon/Probe Response frames
907 * ssid_len - Length of the SSID (1..32)
912 * hide_ssid - Whether to hide the SSID
914 enum hide_ssid hide_ssid;
917 * pairwise_ciphers - WPA_CIPHER_* bitfield
919 unsigned int pairwise_ciphers;
922 * group_cipher - WPA_CIPHER_*
924 unsigned int group_cipher;
927 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
929 unsigned int key_mgmt_suites;
932 * auth_algs - WPA_AUTH_ALG_* bitfield
934 unsigned int auth_algs;
937 * wpa_version - WPA_PROTO_* bitfield
939 unsigned int wpa_version;
942 * privacy - Whether privacy is used in the BSS
947 * beacon_ies - WPS/P2P IE(s) for Beacon frames
949 * This is used to add IEs like WPS IE and P2P IE by drivers that do
950 * not use the full Beacon template.
952 const struct wpabuf *beacon_ies;
955 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
957 * This is used to add IEs like WPS IE and P2P IE by drivers that
958 * reply to Probe Request frames internally.
960 const struct wpabuf *proberesp_ies;
963 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
965 * This is used to add IEs like WPS IE by drivers that reply to
966 * (Re)Association Request frames internally.
968 const struct wpabuf *assocresp_ies;
971 * isolate - Whether to isolate frames between associated stations
973 * If this is non-zero, the AP is requested to disable forwarding of
974 * frames between associated stations.
979 * cts_protect - Whether CTS protection is enabled
984 * preamble - Whether short preamble is enabled
989 * short_slot_time - Whether short slot time is enabled
991 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
992 * not set (e.g., when 802.11g mode is not in use)
997 * ht_opmode - HT operation mode or -1 if HT not in use
1002 * interworking - Whether Interworking is enabled
1007 * hessid - Homogeneous ESS identifier or %NULL if not set
1012 * access_network_type - Access Network Type (0..15)
1014 * This is used for filtering Probe Request frames when Interworking is
1017 u8 access_network_type;
1020 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1022 * This is used by driver which advertises this capability.
1024 int ap_max_inactivity;
1027 * ctwindow - Client Traffic Window (in TUs)
1032 * smps_mode - SMPS mode
1034 * SMPS mode to be used by the AP, specified as the relevant bits of
1035 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1037 unsigned int smps_mode;
1040 * disable_dgaf - Whether group-addressed frames are disabled
1045 * osen - Whether OSEN security is enabled
1050 * freq - Channel parameters for dynamic bandwidth changes
1052 struct hostapd_freq_params *freq;
1055 * reenable - Whether this is to re-enable beaconing
1060 struct wpa_driver_mesh_bss_params {
1061 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1063 * TODO: Other mesh configuration parameters would go here.
1064 * See NL80211_MESHCONF_* for all the mesh config parameters.
1067 int peer_link_timeout;
1070 struct wpa_driver_mesh_join_params {
1073 const int *basic_rates;
1076 struct hostapd_freq_params freq;
1079 struct wpa_driver_mesh_bss_params conf;
1080 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1081 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1082 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1083 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1088 * struct wpa_driver_capa - Driver capability information
1090 struct wpa_driver_capa {
1091 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1092 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1093 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1094 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1095 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1096 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1097 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1098 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1099 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1100 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
1101 /** Bitfield of supported key management suites */
1102 unsigned int key_mgmt;
1104 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1105 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1106 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1107 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1108 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1109 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1110 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1111 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1112 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1113 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1114 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1115 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1116 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1117 /** Bitfield of supported cipher suites */
1120 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1121 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1122 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1123 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1126 /** Driver generated WPA/RSN IE */
1127 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1128 /** Driver needs static WEP key setup after association command */
1129 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1130 /** Driver takes care of all DFS operations */
1131 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1132 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1133 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1134 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1135 /** Driver is for a wired Ethernet interface */
1136 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1137 /** Driver provides separate commands for authentication and association (SME in
1138 * wpa_supplicant). */
1139 #define WPA_DRIVER_FLAGS_SME 0x00000020
1140 /** Driver supports AP mode */
1141 #define WPA_DRIVER_FLAGS_AP 0x00000040
1142 /** Driver needs static WEP key setup after association has been completed */
1143 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1144 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1145 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1146 /** Driver supports concurrent P2P operations */
1147 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1149 * Driver uses the initial interface as a dedicated management interface, i.e.,
1150 * it cannot be used for P2P group operations or non-P2P purposes.
1152 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1153 /** This interface is P2P capable (P2P GO or P2P Client) */
1154 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1155 /** Driver supports station and key removal when stopping an AP */
1156 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1158 * Driver uses the initial interface for P2P management interface and non-P2P
1159 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1160 * P2P group operations.
1162 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1164 * Driver is known to use sane error codes, i.e., when it indicates that
1165 * something (e.g., association) fails, there was indeed a failure and the
1166 * operation does not end up getting completed successfully later.
1168 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1169 /** Driver supports off-channel TX */
1170 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1171 /** Driver indicates TX status events for EAPOL Data frames */
1172 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1173 /** Driver indicates TX status events for Deauth/Disassoc frames */
1174 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1175 /** Driver supports roaming (BSS selection) in firmware */
1176 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1177 /** Driver supports operating as a TDLS peer */
1178 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1179 /** Driver requires external TDLS setup/teardown/discovery */
1180 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1181 /** Driver indicates support for Probe Response offloading in AP mode */
1182 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1183 /** Driver supports U-APSD in AP mode */
1184 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1185 /** Driver supports inactivity timer in AP mode */
1186 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1187 /** Driver expects user space implementation of MLME in AP mode */
1188 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1189 /** Driver supports SAE with user space SME */
1190 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1191 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1192 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1193 /** Driver supports IBSS (Ad-hoc) mode */
1194 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1195 /** Driver supports radar detection */
1196 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1197 /** Driver supports a dedicated interface for P2P Device */
1198 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1199 /** Driver supports QoS Mapping */
1200 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1201 /** Driver supports CSA in AP mode */
1202 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1203 /** Driver supports mesh */
1204 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1205 /** Driver support ACS offload */
1206 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1207 /** Driver supports key management offload */
1208 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1209 /** Driver supports TDLS channel switching */
1210 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1211 /** Driver supports IBSS with HT datarates */
1212 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
1213 /** Driver supports IBSS with VHT datarates */
1214 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
1215 /** Driver supports automatic band selection */
1216 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
1219 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1220 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1221 unsigned int smps_modes;
1223 unsigned int wmm_ac_supported:1;
1225 unsigned int mac_addr_rand_scan_supported:1;
1226 unsigned int mac_addr_rand_sched_scan_supported:1;
1228 /** Maximum number of supported active probe SSIDs */
1231 /** Maximum number of supported active probe SSIDs for sched_scan */
1232 int max_sched_scan_ssids;
1234 /** Whether sched_scan (offloaded scanning) is supported */
1235 int sched_scan_supported;
1237 /** Maximum number of supported match sets for sched_scan */
1241 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1243 unsigned int max_remain_on_chan;
1246 * max_stations - Maximum number of associated stations the driver
1247 * supports in AP mode
1249 unsigned int max_stations;
1252 * probe_resp_offloads - Bitmap of supported protocols by the driver
1253 * for Probe Response offloading.
1255 /** Driver Probe Response offloading support for WPS ver. 1 */
1256 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1257 /** Driver Probe Response offloading support for WPS ver. 2 */
1258 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1259 /** Driver Probe Response offloading support for P2P */
1260 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1261 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1262 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1263 unsigned int probe_resp_offloads;
1265 unsigned int max_acl_mac_addrs;
1268 * Number of supported concurrent channels
1270 unsigned int num_multichan_concurrent;
1273 * extended_capa - extended capabilities in driver/device
1275 * Must be allocated and freed by driver and the pointers must be
1276 * valid for the lifetime of the driver, i.e., freed in deinit()
1278 const u8 *extended_capa, *extended_capa_mask;
1279 unsigned int extended_capa_len;
1281 struct wowlan_triggers wowlan_triggers;
1283 /** Driver adds the DS Params Set IE in Probe Request frames */
1284 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1285 /** Driver adds the WFA TPC IE in Probe Request frames */
1286 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1287 /** Driver handles quiet period requests */
1288 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1290 * Driver is capable of inserting the current TX power value into the body of
1291 * transmitted frames.
1292 * Background: Some Action frames include a TPC Report IE. This IE contains a
1293 * TX power field, which has to be updated by lower layers. One such Action
1294 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1295 * of spectrum management). Note that this insertion takes place at a fixed
1296 * offset, namely the 6th byte in the Action frame body.
1298 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1303 struct hostapd_data;
1305 struct hostap_sta_driver_data {
1306 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1307 unsigned long current_tx_rate;
1308 unsigned long inactive_msec;
1309 unsigned long flags;
1310 unsigned long num_ps_buf_frames;
1311 unsigned long tx_retry_failed;
1312 unsigned long tx_retry_count;
1317 struct hostapd_sta_add_params {
1321 const u8 *supp_rates;
1322 size_t supp_rates_len;
1323 u16 listen_interval;
1324 const struct ieee80211_ht_capabilities *ht_capabilities;
1325 const struct ieee80211_vht_capabilities *vht_capabilities;
1326 int vht_opmode_enabled;
1328 u32 flags; /* bitmask of WPA_STA_* flags */
1329 u32 flags_mask; /* unset bits in flags */
1331 enum mesh_plink_state plink_state;
1332 #endif /* CONFIG_MESH */
1333 int set; /* Set STA parameters instead of add */
1335 const u8 *ext_capab;
1336 size_t ext_capab_len;
1337 const u8 *supp_channels;
1338 size_t supp_channels_len;
1339 const u8 *supp_oper_classes;
1340 size_t supp_oper_classes_len;
1343 struct mac_address {
1347 struct hostapd_acl_params {
1349 unsigned int num_mac_acl;
1350 struct mac_address mac_acl[0];
1353 enum wpa_driver_if_type {
1355 * WPA_IF_STATION - Station mode interface
1360 * WPA_IF_AP_VLAN - AP mode VLAN interface
1362 * This interface shares its address and Beacon frame with the main
1368 * WPA_IF_AP_BSS - AP mode BSS interface
1370 * This interface has its own address and Beacon frame.
1375 * WPA_IF_P2P_GO - P2P Group Owner
1380 * WPA_IF_P2P_CLIENT - P2P Client
1385 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1386 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1391 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1392 * abstracted P2P Device function in the driver
1397 * WPA_IF_MESH - Mesh interface
1402 struct wpa_init_params {
1406 const char *driver_params;
1407 int use_pae_group_addr;
1411 u8 *own_addr; /* buffer for writing own MAC address */
1415 struct wpa_bss_params {
1416 /** Interface name (for multi-SSID/VLAN support) */
1418 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1427 enum mfp_options ieee80211w;
1430 #define WPA_STA_AUTHORIZED BIT(0)
1431 #define WPA_STA_WMM BIT(1)
1432 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1433 #define WPA_STA_MFP BIT(3)
1434 #define WPA_STA_TDLS_PEER BIT(4)
1435 #define WPA_STA_AUTHENTICATED BIT(5)
1448 WNM_SLEEP_ENTER_CONFIRM,
1449 WNM_SLEEP_ENTER_FAIL,
1450 WNM_SLEEP_EXIT_CONFIRM,
1451 WNM_SLEEP_EXIT_FAIL,
1452 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1453 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1454 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1456 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1458 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1459 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1461 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1464 /* enum chan_width - Channel width definitions */
1476 * struct wpa_signal_info - Information about channel signal quality
1478 struct wpa_signal_info {
1480 int above_threshold;
1483 int avg_beacon_signal;
1486 enum chan_width chanwidth;
1492 * struct beacon_data - Beacon data
1493 * @head: Head portion of Beacon frame (before TIM IE)
1494 * @tail: Tail portion of Beacon frame (after TIM IE)
1495 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1496 * @proberesp_ies: Extra information element(s) to add into Probe Response
1498 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1499 * Response frames or %NULL
1500 * @probe_resp: Probe Response frame template
1501 * @head_len: Length of @head
1502 * @tail_len: Length of @tail
1503 * @beacon_ies_len: Length of beacon_ies in octets
1504 * @proberesp_ies_len: Length of proberesp_ies in octets
1505 * @proberesp_ies_len: Length of proberesp_ies in octets
1506 * @probe_resp_len: Length of probe response template (@probe_resp)
1508 struct beacon_data {
1515 size_t head_len, tail_len;
1516 size_t beacon_ies_len;
1517 size_t proberesp_ies_len;
1518 size_t assocresp_ies_len;
1519 size_t probe_resp_len;
1523 * struct csa_settings - Settings for channel switch command
1524 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1525 * @block_tx: 1 - block transmission for CSA period
1526 * @freq_params: Next channel frequency parameter
1527 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1528 * @beacon_after: Next beacon/probe resp/asooc resp info
1529 * @counter_offset_beacon: Offset to the count field in beacon's tail
1530 * @counter_offset_presp: Offset to the count field in probe resp.
1532 struct csa_settings {
1536 struct hostapd_freq_params freq_params;
1537 struct beacon_data beacon_csa;
1538 struct beacon_data beacon_after;
1540 u16 counter_offset_beacon;
1541 u16 counter_offset_presp;
1544 /* TDLS peer capabilities for send_tdls_mgmt() */
1545 enum tdls_peer_capability {
1546 TDLS_PEER_HT = BIT(0),
1547 TDLS_PEER_VHT = BIT(1),
1548 TDLS_PEER_WMM = BIT(2),
1551 /* valid info in the wmm_params struct */
1552 enum wmm_params_valid_info {
1553 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1557 * struct wmm_params - WMM parameterss configured for this association
1558 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1559 * of the struct contain valid information.
1560 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1561 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1568 #ifdef CONFIG_MACSEC
1569 struct macsec_init_params {
1570 Boolean always_include_sci;
1574 #endif /* CONFIG_MACSEC */
1576 enum drv_br_port_attr {
1577 DRV_BR_PORT_ATTR_PROXYARP,
1578 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1581 enum drv_br_net_param {
1582 DRV_BR_NET_PARAM_GARP_ACCEPT,
1583 DRV_BR_MULTICAST_SNOOPING,
1586 struct drv_acs_params {
1587 /* Selected mode (HOSTAPD_MODE_*) */
1588 enum hostapd_hw_mode hw_mode;
1590 /* Indicates whether HT is enabled */
1593 /* Indicates whether HT40 is enabled */
1596 /* Indicates whether VHT is enabled */
1599 /* Configured ACS channel width */
1602 /* ACS channel list info */
1603 unsigned int ch_list_len;
1605 const int *freq_list;
1610 * struct wpa_driver_ops - Driver interface API definition
1612 * This structure defines the API that each driver interface needs to implement
1613 * for core wpa_supplicant code. All driver specific functionality is captured
1616 struct wpa_driver_ops {
1617 /** Name of the driver interface */
1619 /** One line description of the driver interface */
1623 * get_bssid - Get the current BSSID
1624 * @priv: private driver interface data
1625 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1627 * Returns: 0 on success, -1 on failure
1629 * Query kernel driver for the current BSSID and copy it to bssid.
1630 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1633 int (*get_bssid)(void *priv, u8 *bssid);
1636 * get_ssid - Get the current SSID
1637 * @priv: private driver interface data
1638 * @ssid: buffer for SSID (at least 32 bytes)
1640 * Returns: Length of the SSID on success, -1 on failure
1642 * Query kernel driver for the current SSID and copy it to ssid.
1643 * Returning zero is recommended if the STA is not associated.
1645 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1646 * can, at least in theory, contain control characters (including nul)
1647 * and as such, should be processed as binary data, not a printable
1650 int (*get_ssid)(void *priv, u8 *ssid);
1653 * set_key - Configure encryption key
1654 * @ifname: Interface name (for multi-SSID/VLAN support)
1655 * @priv: private driver interface data
1656 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1657 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1658 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1659 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1660 * %WPA_ALG_BIP_CMAC_256);
1661 * %WPA_ALG_NONE clears the key.
1662 * @addr: Address of the peer STA (BSSID of the current AP when setting
1663 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1664 * broadcast keys, %NULL for default keys that are used both for
1665 * broadcast and unicast; when clearing keys, %NULL is used to
1666 * indicate that both the broadcast-only and default key of the
1667 * specified key index is to be cleared
1668 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1670 * @set_tx: configure this key as the default Tx key (only used when
1671 * driver does not support separate unicast/individual key
1672 * @seq: sequence number/packet number, seq_len octets, the next
1673 * packet number to be used for in replay protection; configured
1674 * for Rx keys (in most cases, this is only used with broadcast
1675 * keys and set to zero for unicast keys); %NULL if not set
1676 * @seq_len: length of the seq, depends on the algorithm:
1677 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1678 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1680 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1681 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1683 * Returns: 0 on success, -1 on failure
1685 * Configure the given key for the kernel driver. If the driver
1686 * supports separate individual keys (4 default keys + 1 individual),
1687 * addr can be used to determine whether the key is default or
1688 * individual. If only 4 keys are supported, the default key with key
1689 * index 0 is used as the individual key. STA must be configured to use
1690 * it as the default Tx key (set_tx is set) and accept Rx for all the
1691 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1692 * broadcast keys, so key index 0 is available for this kind of
1695 * Please note that TKIP keys include separate TX and RX MIC keys and
1696 * some drivers may expect them in different order than wpa_supplicant
1697 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1698 * will trigger Michael MIC errors. This can be fixed by changing the
1699 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1700 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1701 * example on how this can be done.
1703 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1704 const u8 *addr, int key_idx, int set_tx,
1705 const u8 *seq, size_t seq_len,
1706 const u8 *key, size_t key_len);
1709 * init - Initialize driver interface
1710 * @ctx: context to be used when calling wpa_supplicant functions,
1711 * e.g., wpa_supplicant_event()
1712 * @ifname: interface name, e.g., wlan0
1714 * Returns: Pointer to private data, %NULL on failure
1716 * Initialize driver interface, including event processing for kernel
1717 * driver events (e.g., associated, scan results, Michael MIC failure).
1718 * This function can allocate a private configuration data area for
1719 * @ctx, file descriptor, interface name, etc. information that may be
1720 * needed in future driver operations. If this is not used, non-NULL
1721 * value will need to be returned because %NULL is used to indicate
1722 * failure. The returned value will be used as 'void *priv' data for
1723 * all other driver_ops functions.
1725 * The main event loop (eloop.c) of wpa_supplicant can be used to
1726 * register callback for read sockets (eloop_register_read_sock()).
1728 * See below for more information about events and
1729 * wpa_supplicant_event() function.
1731 void * (*init)(void *ctx, const char *ifname);
1734 * deinit - Deinitialize driver interface
1735 * @priv: private driver interface data from init()
1737 * Shut down driver interface and processing of driver events. Free
1738 * private data buffer if one was allocated in init() handler.
1740 void (*deinit)(void *priv);
1743 * set_param - Set driver configuration parameters
1744 * @priv: private driver interface data from init()
1745 * @param: driver specific configuration parameters
1747 * Returns: 0 on success, -1 on failure
1749 * Optional handler for notifying driver interface about configuration
1750 * parameters (driver_param).
1752 int (*set_param)(void *priv, const char *param);
1755 * set_countermeasures - Enable/disable TKIP countermeasures
1756 * @priv: private driver interface data
1757 * @enabled: 1 = countermeasures enabled, 0 = disabled
1759 * Returns: 0 on success, -1 on failure
1761 * Configure TKIP countermeasures. When these are enabled, the driver
1762 * should drop all received and queued frames that are using TKIP.
1764 int (*set_countermeasures)(void *priv, int enabled);
1767 * deauthenticate - Request driver to deauthenticate
1768 * @priv: private driver interface data
1769 * @addr: peer address (BSSID of the AP)
1770 * @reason_code: 16-bit reason code to be sent in the deauthentication
1773 * Returns: 0 on success, -1 on failure
1775 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1778 * associate - Request driver to associate
1779 * @priv: private driver interface data
1780 * @params: association parameters
1782 * Returns: 0 on success, -1 on failure
1784 int (*associate)(void *priv,
1785 struct wpa_driver_associate_params *params);
1788 * add_pmkid - Add PMKSA cache entry to the driver
1789 * @priv: private driver interface data
1790 * @bssid: BSSID for the PMKSA cache entry
1791 * @pmkid: PMKID for the PMKSA cache entry
1793 * Returns: 0 on success, -1 on failure
1795 * This function is called when a new PMK is received, as a result of
1796 * either normal authentication or RSN pre-authentication.
1798 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1799 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1800 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1801 * driver_ops function does not need to be implemented. Likewise, if
1802 * the driver does not support WPA, this function is not needed.
1804 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1807 * remove_pmkid - Remove PMKSA cache entry to the driver
1808 * @priv: private driver interface data
1809 * @bssid: BSSID for the PMKSA cache entry
1810 * @pmkid: PMKID for the PMKSA cache entry
1812 * Returns: 0 on success, -1 on failure
1814 * This function is called when the supplicant drops a PMKSA cache
1815 * entry for any reason.
1817 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1818 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1819 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1820 * from wpa_supplicant, this driver_ops function does not need to be
1821 * implemented. Likewise, if the driver does not support WPA, this
1822 * function is not needed.
1824 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1827 * flush_pmkid - Flush PMKSA cache
1828 * @priv: private driver interface data
1830 * Returns: 0 on success, -1 on failure
1832 * This function is called when the supplicant drops all PMKSA cache
1833 * entries for any reason.
1835 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1836 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1837 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1838 * from wpa_supplicant, this driver_ops function does not need to be
1839 * implemented. Likewise, if the driver does not support WPA, this
1840 * function is not needed.
1842 int (*flush_pmkid)(void *priv);
1845 * get_capa - Get driver capabilities
1846 * @priv: private driver interface data
1848 * Returns: 0 on success, -1 on failure
1850 * Get driver/firmware/hardware capabilities.
1852 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1855 * poll - Poll driver for association information
1856 * @priv: private driver interface data
1858 * This is an option callback that can be used when the driver does not
1859 * provide event mechanism for association events. This is called when
1860 * receiving WPA EAPOL-Key messages that require association
1861 * information. The driver interface is supposed to generate associnfo
1862 * event before returning from this callback function. In addition, the
1863 * driver interface should generate an association event after having
1864 * sent out associnfo.
1866 void (*poll)(void *priv);
1869 * get_ifname - Get interface name
1870 * @priv: private driver interface data
1872 * Returns: Pointer to the interface name. This can differ from the
1873 * interface name used in init() call. Init() is called first.
1875 * This optional function can be used to allow the driver interface to
1876 * replace the interface name with something else, e.g., based on an
1877 * interface mapping from a more descriptive name.
1879 const char * (*get_ifname)(void *priv);
1882 * get_mac_addr - Get own MAC address
1883 * @priv: private driver interface data
1885 * Returns: Pointer to own MAC address or %NULL on failure
1887 * This optional function can be used to get the own MAC address of the
1888 * device from the driver interface code. This is only needed if the
1889 * l2_packet implementation for the OS does not provide easy access to
1891 const u8 * (*get_mac_addr)(void *priv);
1894 * set_operstate - Sets device operating state to DORMANT or UP
1895 * @priv: private driver interface data
1896 * @state: 0 = dormant, 1 = up
1897 * Returns: 0 on success, -1 on failure
1899 * This is an optional function that can be used on operating systems
1900 * that support a concept of controlling network device state from user
1901 * space applications. This function, if set, gets called with
1902 * state = 1 when authentication has been completed and with state = 0
1903 * when connection is lost.
1905 int (*set_operstate)(void *priv, int state);
1908 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1909 * @priv: Private driver interface data
1910 * @addr: Address of the station for which to set protection (may be
1911 * %NULL for group keys)
1912 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1913 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1914 * Returns: 0 on success, -1 on failure
1916 * This is an optional function that can be used to set the driver to
1917 * require protection for Tx and/or Rx frames. This uses the layer
1918 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1919 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1920 * set protection operation; instead, they set protection implicitly
1921 * based on configured keys.
1923 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1927 * get_hw_feature_data - Get hardware support data (channels and rates)
1928 * @priv: Private driver interface data
1929 * @num_modes: Variable for returning the number of returned modes
1930 * flags: Variable for returning hardware feature flags
1931 * Returns: Pointer to allocated hardware data on success or %NULL on
1932 * failure. Caller is responsible for freeing this.
1934 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1939 * send_mlme - Send management frame from MLME
1940 * @priv: Private driver interface data
1941 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1942 * @data_len: Size of the management frame
1943 * @noack: Do not wait for this frame to be acked (disable retries)
1944 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
1946 * Returns: 0 on success, -1 on failure
1948 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1949 int noack, unsigned int freq);
1952 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1953 * @priv: Private driver interface data
1954 * @md: Mobility domain (2 octets) (also included inside ies)
1955 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1956 * @ies_len: Length of FT IEs in bytes
1957 * Returns: 0 on success, -1 on failure
1959 * The supplicant uses this callback to let the driver know that keying
1960 * material for FT is available and that the driver can use the
1961 * provided IEs in the next message in FT authentication sequence.
1963 * This function is only needed for driver that support IEEE 802.11r
1964 * (Fast BSS Transition).
1966 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1970 * get_scan_results2 - Fetch the latest scan results
1971 * @priv: private driver interface data
1973 * Returns: Allocated buffer of scan results (caller is responsible for
1974 * freeing the data structure) on success, NULL on failure
1976 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1979 * set_country - Set country
1980 * @priv: Private driver interface data
1981 * @alpha2: country to which to switch to
1982 * Returns: 0 on success, -1 on failure
1984 * This function is for drivers which support some form
1985 * of setting a regulatory domain.
1987 int (*set_country)(void *priv, const char *alpha2);
1990 * get_country - Get country
1991 * @priv: Private driver interface data
1992 * @alpha2: Buffer for returning country code (at least 3 octets)
1993 * Returns: 0 on success, -1 on failure
1995 int (*get_country)(void *priv, char *alpha2);
1998 * global_init - Global driver initialization
1999 * Returns: Pointer to private data (global), %NULL on failure
2001 * This optional function is called to initialize the driver wrapper
2002 * for global data, i.e., data that applies to all interfaces. If this
2003 * function is implemented, global_deinit() will also need to be
2004 * implemented to free the private data. The driver will also likely
2005 * use init2() function instead of init() to get the pointer to global
2006 * data available to per-interface initializer.
2008 void * (*global_init)(void);
2011 * global_deinit - Global driver deinitialization
2012 * @priv: private driver global data from global_init()
2014 * Terminate any global driver related functionality and free the
2015 * global data structure.
2017 void (*global_deinit)(void *priv);
2020 * init2 - Initialize driver interface (with global data)
2021 * @ctx: context to be used when calling wpa_supplicant functions,
2022 * e.g., wpa_supplicant_event()
2023 * @ifname: interface name, e.g., wlan0
2024 * @global_priv: private driver global data from global_init()
2025 * Returns: Pointer to private data, %NULL on failure
2027 * This function can be used instead of init() if the driver wrapper
2030 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2033 * get_interfaces - Get information about available interfaces
2034 * @global_priv: private driver global data from global_init()
2035 * Returns: Allocated buffer of interface information (caller is
2036 * responsible for freeing the data structure) on success, NULL on
2039 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2042 * scan2 - Request the driver to initiate scan
2043 * @priv: private driver interface data
2044 * @params: Scan parameters
2046 * Returns: 0 on success, -1 on failure
2048 * Once the scan results are ready, the driver should report scan
2049 * results event for wpa_supplicant which will eventually request the
2050 * results with wpa_driver_get_scan_results2().
2052 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2055 * authenticate - Request driver to authenticate
2056 * @priv: private driver interface data
2057 * @params: authentication parameters
2058 * Returns: 0 on success, -1 on failure
2060 * This is an optional function that can be used with drivers that
2061 * support separate authentication and association steps, i.e., when
2062 * wpa_supplicant can act as the SME. If not implemented, associate()
2063 * function is expected to take care of IEEE 802.11 authentication,
2066 int (*authenticate)(void *priv,
2067 struct wpa_driver_auth_params *params);
2070 * set_ap - Set Beacon and Probe Response information for AP mode
2071 * @priv: Private driver interface data
2072 * @params: Parameters to use in AP mode
2074 * This function is used to configure Beacon template and/or extra IEs
2075 * to add for Beacon and Probe Response frames for the driver in
2076 * AP mode. The driver is responsible for building the full Beacon
2077 * frame by concatenating the head part with TIM IE generated by the
2078 * driver/firmware and finishing with the tail part. Depending on the
2079 * driver architectue, this can be done either by using the full
2080 * template or the set of additional IEs (e.g., WPS and P2P IE).
2081 * Similarly, Probe Response processing depends on the driver design.
2082 * If the driver (or firmware) takes care of replying to Probe Request
2083 * frames, the extra IEs provided here needs to be added to the Probe
2086 * Returns: 0 on success, -1 on failure
2088 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
2091 * set_acl - Set ACL in AP mode
2092 * @priv: Private driver interface data
2093 * @params: Parameters to configure ACL
2094 * Returns: 0 on success, -1 on failure
2096 * This is used only for the drivers which support MAC address ACL.
2098 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2101 * hapd_init - Initialize driver interface (hostapd only)
2102 * @hapd: Pointer to hostapd context
2103 * @params: Configuration for the driver wrapper
2104 * Returns: Pointer to private data, %NULL on failure
2106 * This function is used instead of init() or init2() when the driver
2107 * wrapper is used with hostapd.
2109 void * (*hapd_init)(struct hostapd_data *hapd,
2110 struct wpa_init_params *params);
2113 * hapd_deinit - Deinitialize driver interface (hostapd only)
2114 * @priv: Private driver interface data from hapd_init()
2116 void (*hapd_deinit)(void *priv);
2119 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2120 * @priv: Private driver interface data
2121 * @params: BSS parameters
2122 * Returns: 0 on success, -1 on failure
2124 * This is an optional function to configure the kernel driver to
2125 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2126 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2127 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2128 * for Beacon frames.
2130 * DEPRECATED - use set_ap() instead
2132 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2135 * set_privacy - Enable/disable privacy (AP only)
2136 * @priv: Private driver interface data
2137 * @enabled: 1 = privacy enabled, 0 = disabled
2138 * Returns: 0 on success, -1 on failure
2140 * This is an optional function to configure privacy field in the
2141 * kernel driver for Beacon frames. This can be left undefined (set to
2142 * %NULL) if the driver uses the Beacon template from set_ap().
2144 * DEPRECATED - use set_ap() instead
2146 int (*set_privacy)(void *priv, int enabled);
2149 * get_seqnum - Fetch the current TSC/packet number (AP only)
2150 * @ifname: The interface name (main or virtual)
2151 * @priv: Private driver interface data
2152 * @addr: MAC address of the station or %NULL for group keys
2154 * @seq: Buffer for returning the latest used TSC/packet number
2155 * Returns: 0 on success, -1 on failure
2157 * This function is used to fetch the last used TSC/packet number for
2158 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2159 * keys, so there is no strict requirement on implementing support for
2160 * unicast keys (i.e., addr != %NULL).
2162 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2166 * flush - Flush all association stations (AP only)
2167 * @priv: Private driver interface data
2168 * Returns: 0 on success, -1 on failure
2170 * This function requests the driver to disassociate all associated
2171 * stations. This function does not need to be implemented if the
2172 * driver does not process association frames internally.
2174 int (*flush)(void *priv);
2177 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2178 * @priv: Private driver interface data
2179 * @elem: Information elements
2180 * @elem_len: Length of the elem buffer in octets
2181 * Returns: 0 on success, -1 on failure
2183 * This is an optional function to add information elements in the
2184 * kernel driver for Beacon and Probe Response frames. This can be left
2185 * undefined (set to %NULL) if the driver uses the Beacon template from
2188 * DEPRECATED - use set_ap() instead
2190 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2193 * read_sta_data - Fetch station data
2194 * @priv: Private driver interface data
2195 * @data: Buffer for returning station information
2196 * @addr: MAC address of the station
2197 * Returns: 0 on success, -1 on failure
2199 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2203 * hapd_send_eapol - Send an EAPOL packet (AP only)
2204 * @priv: private driver interface data
2205 * @addr: Destination MAC address
2206 * @data: EAPOL packet starting with IEEE 802.1X header
2207 * @data_len: Length of the EAPOL packet in octets
2208 * @encrypt: Whether the frame should be encrypted
2209 * @own_addr: Source MAC address
2210 * @flags: WPA_STA_* flags for the destination station
2212 * Returns: 0 on success, -1 on failure
2214 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2215 size_t data_len, int encrypt,
2216 const u8 *own_addr, u32 flags);
2219 * sta_deauth - Deauthenticate a station (AP only)
2220 * @priv: Private driver interface data
2221 * @own_addr: Source address and BSSID for the Deauthentication frame
2222 * @addr: MAC address of the station to deauthenticate
2223 * @reason: Reason code for the Deauthentiation frame
2224 * Returns: 0 on success, -1 on failure
2226 * This function requests a specific station to be deauthenticated and
2227 * a Deauthentication frame to be sent to it.
2229 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2233 * sta_disassoc - Disassociate a station (AP only)
2234 * @priv: Private driver interface data
2235 * @own_addr: Source address and BSSID for the Disassociation frame
2236 * @addr: MAC address of the station to disassociate
2237 * @reason: Reason code for the Disassociation frame
2238 * Returns: 0 on success, -1 on failure
2240 * This function requests a specific station to be disassociated and
2241 * a Disassociation frame to be sent to it.
2243 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2247 * sta_remove - Remove a station entry (AP only)
2248 * @priv: Private driver interface data
2249 * @addr: MAC address of the station to be removed
2250 * Returns: 0 on success, -1 on failure
2252 int (*sta_remove)(void *priv, const u8 *addr);
2255 * hapd_get_ssid - Get the current SSID (AP only)
2256 * @priv: Private driver interface data
2257 * @buf: Buffer for returning the SSID
2258 * @len: Maximum length of the buffer
2259 * Returns: Length of the SSID on success, -1 on failure
2261 * This function need not be implemented if the driver uses Beacon
2262 * template from set_ap() and does not reply to Probe Request frames.
2264 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2267 * hapd_set_ssid - Set SSID (AP only)
2268 * @priv: Private driver interface data
2270 * @len: Length of the SSID in octets
2271 * Returns: 0 on success, -1 on failure
2273 * DEPRECATED - use set_ap() instead
2275 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2278 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2279 * @priv: Private driver interface data
2280 * @enabled: 1 = countermeasures enabled, 0 = disabled
2281 * Returns: 0 on success, -1 on failure
2283 * This need not be implemented if the driver does not take care of
2284 * association processing.
2286 int (*hapd_set_countermeasures)(void *priv, int enabled);
2289 * sta_add - Add a station entry
2290 * @priv: Private driver interface data
2291 * @params: Station parameters
2292 * Returns: 0 on success, -1 on failure
2294 * This function is used to add a station entry to the driver once the
2295 * station has completed association. This is only used if the driver
2296 * does not take care of association processing.
2298 * With TDLS, this function is also used to add or set (params->set 1)
2299 * TDLS peer entries.
2301 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2304 * get_inact_sec - Get station inactivity duration (AP only)
2305 * @priv: Private driver interface data
2306 * @addr: Station address
2307 * Returns: Number of seconds station has been inactive, -1 on failure
2309 int (*get_inact_sec)(void *priv, const u8 *addr);
2312 * sta_clear_stats - Clear station statistics (AP only)
2313 * @priv: Private driver interface data
2314 * @addr: Station address
2315 * Returns: 0 on success, -1 on failure
2317 int (*sta_clear_stats)(void *priv, const u8 *addr);
2320 * set_freq - Set channel/frequency (AP only)
2321 * @priv: Private driver interface data
2322 * @freq: Channel parameters
2323 * Returns: 0 on success, -1 on failure
2325 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2328 * set_rts - Set RTS threshold
2329 * @priv: Private driver interface data
2330 * @rts: RTS threshold in octets
2331 * Returns: 0 on success, -1 on failure
2333 int (*set_rts)(void *priv, int rts);
2336 * set_frag - Set fragmentation threshold
2337 * @priv: Private driver interface data
2338 * @frag: Fragmentation threshold in octets
2339 * Returns: 0 on success, -1 on failure
2341 int (*set_frag)(void *priv, int frag);
2344 * sta_set_flags - Set station flags (AP only)
2345 * @priv: Private driver interface data
2346 * @addr: Station address
2347 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2348 * @flags_or: Bitmap of WPA_STA_* flags to add
2349 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2350 * Returns: 0 on success, -1 on failure
2352 int (*sta_set_flags)(void *priv, const u8 *addr,
2353 unsigned int total_flags, unsigned int flags_or,
2354 unsigned int flags_and);
2357 * set_tx_queue_params - Set TX queue parameters
2358 * @priv: Private driver interface data
2359 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2363 * @burst_time: Maximum length for bursting in 0.1 msec units
2365 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2366 int cw_max, int burst_time);
2369 * if_add - Add a virtual interface
2370 * @priv: Private driver interface data
2371 * @type: Interface type
2372 * @ifname: Interface name for the new virtual interface
2373 * @addr: Local address to use for the interface or %NULL to use the
2374 * parent interface address
2375 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2376 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2377 * not allowed (applies only to %WPA_IF_AP_BSS type)
2378 * @force_ifname: Buffer for returning an interface name that the
2379 * driver ended up using if it differs from the requested ifname
2380 * @if_addr: Buffer for returning the allocated interface address
2381 * (this may differ from the requested addr if the driver cannot
2382 * change interface address)
2383 * @bridge: Bridge interface to use or %NULL if no bridge configured
2384 * @use_existing: Whether to allow existing interface to be used
2385 * Returns: 0 on success, -1 on failure
2387 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2388 const char *ifname, const u8 *addr, void *bss_ctx,
2389 void **drv_priv, char *force_ifname, u8 *if_addr,
2390 const char *bridge, int use_existing);
2393 * if_remove - Remove a virtual interface
2394 * @priv: Private driver interface data
2395 * @type: Interface type
2396 * @ifname: Interface name of the virtual interface to be removed
2397 * Returns: 0 on success, -1 on failure
2399 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2400 const char *ifname);
2403 * set_sta_vlan - Bind a station into a specific interface (AP only)
2404 * @priv: Private driver interface data
2405 * @ifname: Interface (main or virtual BSS or VLAN)
2406 * @addr: MAC address of the associated station
2408 * Returns: 0 on success, -1 on failure
2410 * This function is used to bind a station to a specific virtual
2411 * interface. It is only used if when virtual interfaces are supported,
2412 * e.g., to assign stations to different VLAN interfaces based on
2413 * information from a RADIUS server. This allows separate broadcast
2414 * domains to be used with a single BSS.
2416 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2420 * commit - Optional commit changes handler (AP only)
2421 * @priv: driver private data
2422 * Returns: 0 on success, -1 on failure
2424 * This optional handler function can be registered if the driver
2425 * interface implementation needs to commit changes (e.g., by setting
2426 * network interface up) at the end of initial configuration. If set,
2427 * this handler will be called after initial setup has been completed.
2429 int (*commit)(void *priv);
2432 * send_ether - Send an ethernet packet (AP only)
2433 * @priv: private driver interface data
2434 * @dst: Destination MAC address
2435 * @src: Source MAC address
2437 * @data: EAPOL packet starting with IEEE 802.1X header
2438 * @data_len: Length of the EAPOL packet in octets
2439 * Returns: 0 on success, -1 on failure
2441 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2442 const u8 *data, size_t data_len);
2445 * set_radius_acl_auth - Notification of RADIUS ACL change
2446 * @priv: Private driver interface data
2447 * @mac: MAC address of the station
2448 * @accepted: Whether the station was accepted
2449 * @session_timeout: Session timeout for the station
2450 * Returns: 0 on success, -1 on failure
2452 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2453 u32 session_timeout);
2456 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2457 * @priv: Private driver interface data
2458 * @mac: MAC address of the station
2459 * Returns: 0 on success, -1 on failure
2461 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2464 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2465 * @priv: Private driver interface data
2466 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2467 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2469 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2470 * to remove extra IE(s)
2471 * Returns: 0 on success, -1 on failure
2473 * This is an optional function to add WPS IE in the kernel driver for
2474 * Beacon and Probe Response frames. This can be left undefined (set
2475 * to %NULL) if the driver uses the Beacon template from set_ap()
2476 * and does not process Probe Request frames. If the driver takes care
2477 * of (Re)Association frame processing, the assocresp buffer includes
2478 * WPS IE(s) that need to be added to (Re)Association Response frames
2479 * whenever a (Re)Association Request frame indicated use of WPS.
2481 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2482 * frames when operating as a GO. The driver is responsible for adding
2483 * timing related attributes (e.g., NoA) in addition to the IEs
2484 * included here by appending them after these buffers. This call is
2485 * also used to provide Probe Response IEs for P2P Listen state
2486 * operations for drivers that generate the Probe Response frames
2489 * DEPRECATED - use set_ap() instead
2491 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2492 const struct wpabuf *proberesp,
2493 const struct wpabuf *assocresp);
2496 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2497 * @priv: Private driver interface data
2498 * @authorized: Whether the port is authorized
2499 * Returns: 0 on success, -1 on failure
2501 int (*set_supp_port)(void *priv, int authorized);
2504 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2505 * @priv: Private driver interface data
2506 * @addr: MAC address of the associated station
2507 * @aid: Association ID
2508 * @val: 1 = bind to 4-address WDS; 0 = unbind
2509 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2510 * to indicate that bridge is not to be used
2511 * @ifname_wds: Buffer to return the interface name for the new WDS
2512 * station or %NULL to indicate name is not returned.
2513 * Returns: 0 on success, -1 on failure
2515 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2516 const char *bridge_ifname, char *ifname_wds);
2519 * send_action - Transmit an Action frame
2520 * @priv: Private driver interface data
2521 * @freq: Frequency (in MHz) of the channel
2522 * @wait: Time to wait off-channel for a response (in ms), or zero
2523 * @dst: Destination MAC address (Address 1)
2524 * @src: Source MAC address (Address 2)
2525 * @bssid: BSSID (Address 3)
2527 * @data_len: data length in octets
2528 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2529 * Returns: 0 on success, -1 on failure
2531 * This command can be used to request the driver to transmit an action
2532 * frame to the specified destination.
2534 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2535 * be transmitted on the given channel and the device will wait for a
2536 * response on that channel for the given wait time.
2538 * If the flag is not set, the wait time will be ignored. In this case,
2539 * if a remain-on-channel duration is in progress, the frame must be
2540 * transmitted on that channel; alternatively the frame may be sent on
2541 * the current operational channel (if in associated state in station
2542 * mode or while operating as an AP.)
2544 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2545 const u8 *dst, const u8 *src, const u8 *bssid,
2546 const u8 *data, size_t data_len, int no_cck);
2549 * send_action_cancel_wait - Cancel action frame TX wait
2550 * @priv: Private driver interface data
2552 * This command cancels the wait time associated with sending an action
2553 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2554 * set in the driver flags.
2556 void (*send_action_cancel_wait)(void *priv);
2559 * remain_on_channel - Remain awake on a channel
2560 * @priv: Private driver interface data
2561 * @freq: Frequency (in MHz) of the channel
2562 * @duration: Duration in milliseconds
2563 * Returns: 0 on success, -1 on failure
2565 * This command is used to request the driver to remain awake on the
2566 * specified channel for the specified duration and report received
2567 * Action frames with EVENT_RX_MGMT events. Optionally, received
2568 * Probe Request frames may also be requested to be reported by calling
2569 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2571 * The driver may not be at the requested channel when this function
2572 * returns, i.e., the return code is only indicating whether the
2573 * request was accepted. The caller will need to wait until the
2574 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2575 * completed the channel change. This may take some time due to other
2576 * need for the radio and the caller should be prepared to timing out
2577 * its wait since there are no guarantees on when this request can be
2580 int (*remain_on_channel)(void *priv, unsigned int freq,
2581 unsigned int duration);
2584 * cancel_remain_on_channel - Cancel remain-on-channel operation
2585 * @priv: Private driver interface data
2587 * This command can be used to cancel a remain-on-channel operation
2588 * before its originally requested duration has passed. This could be
2589 * used, e.g., when remain_on_channel() is used to request extra time
2590 * to receive a response to an Action frame and the response is
2591 * received when there is still unneeded time remaining on the
2592 * remain-on-channel operation.
2594 int (*cancel_remain_on_channel)(void *priv);
2597 * probe_req_report - Request Probe Request frames to be indicated
2598 * @priv: Private driver interface data
2599 * @report: Whether to report received Probe Request frames
2600 * Returns: 0 on success, -1 on failure (or if not supported)
2602 * This command can be used to request the driver to indicate when
2603 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2604 * Since this operation may require extra resources, e.g., due to less
2605 * optimal hardware/firmware RX filtering, many drivers may disable
2606 * Probe Request reporting at least in station mode. This command is
2607 * used to notify the driver when the Probe Request frames need to be
2608 * reported, e.g., during remain-on-channel operations.
2610 int (*probe_req_report)(void *priv, int report);
2613 * deinit_ap - Deinitialize AP mode
2614 * @priv: Private driver interface data
2615 * Returns: 0 on success, -1 on failure (or if not supported)
2617 * This optional function can be used to disable AP mode related
2618 * configuration. If the interface was not dynamically added,
2619 * change the driver mode to station mode to allow normal station
2620 * operations like scanning to be completed.
2622 int (*deinit_ap)(void *priv);
2625 * deinit_p2p_cli - Deinitialize P2P client mode
2626 * @priv: Private driver interface data
2627 * Returns: 0 on success, -1 on failure (or if not supported)
2629 * This optional function can be used to disable P2P client mode. If the
2630 * interface was not dynamically added, change the interface type back
2633 int (*deinit_p2p_cli)(void *priv);
2636 * suspend - Notification on system suspend/hibernate event
2637 * @priv: Private driver interface data
2639 void (*suspend)(void *priv);
2642 * resume - Notification on system resume/thaw event
2643 * @priv: Private driver interface data
2645 void (*resume)(void *priv);
2648 * signal_monitor - Set signal monitoring parameters
2649 * @priv: Private driver interface data
2650 * @threshold: Threshold value for signal change events; 0 = disabled
2651 * @hysteresis: Minimum change in signal strength before indicating a
2653 * Returns: 0 on success, -1 on failure (or if not supported)
2655 * This function can be used to configure monitoring of signal strength
2656 * with the current AP. Whenever signal strength drops below the
2657 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2658 * should be generated assuming the signal strength has changed at
2659 * least %hysteresis from the previously indicated signal change event.
2661 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2664 * send_frame - Send IEEE 802.11 frame (testing use only)
2665 * @priv: Private driver interface data
2666 * @data: IEEE 802.11 frame with IEEE 802.11 header
2667 * @data_len: Size of the frame
2668 * @encrypt: Whether to encrypt the frame (if keys are set)
2669 * Returns: 0 on success, -1 on failure
2671 * This function is only used for debugging purposes and is not
2672 * required to be implemented for normal operations.
2674 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2678 * get_noa - Get current Notice of Absence attribute payload
2679 * @priv: Private driver interface data
2680 * @buf: Buffer for returning NoA
2681 * @buf_len: Buffer length in octets
2682 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2683 * advertized, or -1 on failure
2685 * This function is used to fetch the current Notice of Absence
2686 * attribute value from GO.
2688 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2691 * set_noa - Set Notice of Absence parameters for GO (testing)
2692 * @priv: Private driver interface data
2694 * @start: Start time in ms from next TBTT
2695 * @duration: Duration in ms
2696 * Returns: 0 on success or -1 on failure
2698 * This function is used to set Notice of Absence parameters for GO. It
2699 * is used only for testing. To disable NoA, all parameters are set to
2702 int (*set_noa)(void *priv, u8 count, int start, int duration);
2705 * set_p2p_powersave - Set P2P power save options
2706 * @priv: Private driver interface data
2707 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2708 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2709 * @ctwindow: 0.. = change (msec), -1 = no change
2710 * Returns: 0 on success or -1 on failure
2712 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2716 * ampdu - Enable/disable aggregation
2717 * @priv: Private driver interface data
2718 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2719 * Returns: 0 on success or -1 on failure
2721 int (*ampdu)(void *priv, int ampdu);
2724 * get_radio_name - Get physical radio name for the device
2725 * @priv: Private driver interface data
2726 * Returns: Radio name or %NULL if not known
2728 * The returned data must not be modified by the caller. It is assumed
2729 * that any interface that has the same radio name as another is
2730 * sharing the same physical radio. This information can be used to
2731 * share scan results etc. information between the virtual interfaces
2732 * to speed up various operations.
2734 const char * (*get_radio_name)(void *priv);
2737 * send_tdls_mgmt - for sending TDLS management packets
2738 * @priv: private driver interface data
2739 * @dst: Destination (peer) MAC address
2740 * @action_code: TDLS action code for the mssage
2741 * @dialog_token: Dialog Token to use in the message (if needed)
2742 * @status_code: Status Code or Reason Code to use (if needed)
2743 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2744 * @initiator: Is the current end the TDLS link initiator
2745 * @buf: TDLS IEs to add to the message
2746 * @len: Length of buf in octets
2747 * Returns: 0 on success, negative (<0) on failure
2749 * This optional function can be used to send packet to driver which is
2750 * responsible for receiving and sending all TDLS packets.
2752 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2753 u8 dialog_token, u16 status_code, u32 peer_capab,
2754 int initiator, const u8 *buf, size_t len);
2757 * tdls_oper - Ask the driver to perform high-level TDLS operations
2758 * @priv: Private driver interface data
2759 * @oper: TDLS high-level operation. See %enum tdls_oper
2760 * @peer: Destination (peer) MAC address
2761 * Returns: 0 on success, negative (<0) on failure
2763 * This optional function can be used to send high-level TDLS commands
2766 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2769 * wnm_oper - Notify driver of the WNM frame reception
2770 * @priv: Private driver interface data
2771 * @oper: WNM operation. See %enum wnm_oper
2772 * @peer: Destination (peer) MAC address
2773 * @buf: Buffer for the driver to fill in (for getting IE)
2774 * @buf_len: Return the len of buf
2775 * Returns: 0 on success, negative (<0) on failure
2777 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2778 u8 *buf, u16 *buf_len);
2781 * set_qos_map - Set QoS Map
2782 * @priv: Private driver interface data
2783 * @qos_map_set: QoS Map
2784 * @qos_map_set_len: Length of QoS Map
2786 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2787 u8 qos_map_set_len);
2790 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2791 * @priv: Private driver interface data
2792 * @version: IP version of the IP address, 4 or 6
2793 * @ipaddr: IP address for the neigh entry
2794 * @prefixlen: IP address prefix length
2795 * @addr: Corresponding MAC address
2796 * Returns: 0 on success, negative (<0) on failure
2798 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2799 int prefixlen, const u8 *addr);
2802 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2803 * @priv: Private driver interface data
2804 * @version: IP version of the IP address, 4 or 6
2805 * @ipaddr: IP address for the neigh entry
2806 * Returns: 0 on success, negative (<0) on failure
2808 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2811 * br_port_set_attr - Set a bridge port attribute
2812 * @attr: Bridge port attribute to set
2813 * @val: Value to be set
2814 * Returns: 0 on success, negative (<0) on failure
2816 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2820 * br_port_set_attr - Set a bridge network parameter
2821 * @param: Bridge parameter to set
2822 * @val: Value to be set
2823 * Returns: 0 on success, negative (<0) on failure
2825 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2829 * set_wowlan - Set wake-on-wireless triggers
2830 * @priv: Private driver interface data
2831 * @triggers: wowlan triggers
2833 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2836 * signal_poll - Get current connection information
2837 * @priv: Private driver interface data
2838 * @signal_info: Connection info structure
2840 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2843 * set_authmode - Set authentication algorithm(s) for static WEP
2844 * @priv: Private driver interface data
2845 * @authmode: 1=Open System, 2=Shared Key, 3=both
2846 * Returns: 0 on success, -1 on failure
2848 * This function can be used to set authentication algorithms for AP
2849 * mode when static WEP is used. If the driver uses user space MLME/SME
2850 * implementation, there is no need to implement this function.
2852 * DEPRECATED - use set_ap() instead
2854 int (*set_authmode)(void *priv, int authmode);
2858 * driver_cmd - Execute driver-specific command
2859 * @priv: Private driver interface data
2860 * @cmd: Command to execute
2861 * @buf: Return buffer
2862 * @buf_len: Buffer length
2863 * Returns: 0 on success, -1 on failure
2865 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2866 #endif /* ANDROID */
2869 * vendor_cmd - Execute vendor specific command
2870 * @priv: Private driver interface data
2871 * @vendor_id: Vendor id
2872 * @subcmd: Vendor command id
2873 * @data: Vendor command parameters (%NULL if no parameters)
2874 * @data_len: Data length
2875 * @buf: Return buffer (%NULL to ignore reply)
2876 * Returns: 0 on success, negative (<0) on failure
2878 * This function handles vendor specific commands that are passed to
2879 * the driver/device. The command is identified by vendor id and
2880 * command id. Parameters can be passed as argument to the command
2881 * in the data buffer. Reply (if any) will be filled in the supplied
2884 * The exact driver behavior is driver interface and vendor specific. As
2885 * an example, this will be converted to a vendor specific cfg80211
2886 * command in case of the nl80211 driver interface.
2888 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2889 unsigned int subcmd, const u8 *data, size_t data_len,
2890 struct wpabuf *buf);
2893 * set_rekey_info - Set rekey information
2894 * @priv: Private driver interface data
2896 * @kek_len: KEK length in octets
2898 * @kck_len: KCK length in octets
2899 * @replay_ctr: Current EAPOL-Key Replay Counter
2901 * This optional function can be used to provide information for the
2902 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2903 * while the host (including wpa_supplicant) is sleeping.
2905 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
2906 const u8 *kck, size_t kck_len,
2907 const u8 *replay_ctr);
2910 * sta_assoc - Station association indication
2911 * @priv: Private driver interface data
2912 * @own_addr: Source address and BSSID for association frame
2913 * @addr: MAC address of the station to associate
2914 * @reassoc: flag to indicate re-association
2915 * @status: association response status code
2916 * @ie: assoc response ie buffer
2917 * @len: ie buffer length
2918 * Returns: 0 on success, -1 on failure
2920 * This function indicates the driver to send (Re)Association
2921 * Response frame to the station.
2923 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2924 int reassoc, u16 status, const u8 *ie, size_t len);
2927 * sta_auth - Station authentication indication
2928 * @priv: Private driver interface data
2929 * @own_addr: Source address and BSSID for authentication frame
2930 * @addr: MAC address of the station to associate
2931 * @seq: authentication sequence number
2932 * @status: authentication response status code
2933 * @ie: authentication frame ie buffer
2934 * @len: ie buffer length
2936 * This function indicates the driver to send Authentication frame
2939 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2940 u16 seq, u16 status, const u8 *ie, size_t len);
2943 * add_tspec - Add traffic stream
2944 * @priv: Private driver interface data
2945 * @addr: MAC address of the station to associate
2946 * @tspec_ie: tspec ie buffer
2947 * @tspec_ielen: tspec ie length
2948 * Returns: 0 on success, -1 on failure
2950 * This function adds the traffic steam for the station
2951 * and fills the medium_time in tspec_ie.
2953 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2954 size_t tspec_ielen);
2957 * add_sta_node - Add a station node in the driver
2958 * @priv: Private driver interface data
2959 * @addr: MAC address of the station to add
2960 * @auth_alg: authentication algorithm used by the station
2961 * Returns: 0 on success, -1 on failure
2963 * This function adds the station node in the driver, when
2964 * the station gets added by FT-over-DS.
2966 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2969 * sched_scan - Request the driver to initiate scheduled scan
2970 * @priv: Private driver interface data
2971 * @params: Scan parameters
2972 * @interval: Interval between scan cycles in milliseconds
2973 * Returns: 0 on success, -1 on failure
2975 * This operation should be used for scheduled scan offload to
2976 * the hardware. Every time scan results are available, the
2977 * driver should report scan results event for wpa_supplicant
2978 * which will eventually request the results with
2979 * wpa_driver_get_scan_results2(). This operation is optional
2980 * and if not provided or if it returns -1, we fall back to
2981 * normal host-scheduled scans.
2983 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2987 * stop_sched_scan - Request the driver to stop a scheduled scan
2988 * @priv: Private driver interface data
2989 * Returns: 0 on success, -1 on failure
2991 * This should cause the scheduled scan to be stopped and
2992 * results should stop being sent. Must be supported if
2993 * sched_scan is supported.
2995 int (*stop_sched_scan)(void *priv);
2998 * poll_client - Probe (null data or such) the given station
2999 * @priv: Private driver interface data
3000 * @own_addr: MAC address of sending interface
3001 * @addr: MAC address of the station to probe
3002 * @qos: Indicates whether station is QoS station
3004 * This function is used to verify whether an associated station is
3005 * still present. This function does not need to be implemented if the
3006 * driver provides such inactivity polling mechanism.
3008 void (*poll_client)(void *priv, const u8 *own_addr,
3009 const u8 *addr, int qos);
3012 * radio_disable - Disable/enable radio
3013 * @priv: Private driver interface data
3014 * @disabled: 1=disable 0=enable radio
3015 * Returns: 0 on success, -1 on failure
3017 * This optional command is for testing purposes. It can be used to
3018 * disable the radio on a testbed device to simulate out-of-radio-range
3021 int (*radio_disable)(void *priv, int disabled);
3024 * switch_channel - Announce channel switch and migrate the GO to the
3026 * @priv: Private driver interface data
3027 * @settings: Settings for CSA period and new channel
3028 * Returns: 0 on success, -1 on failure
3030 * This function is used to move the GO to the legacy STA channel to
3031 * avoid frequency conflict in single channel concurrency.
3033 int (*switch_channel)(void *priv, struct csa_settings *settings);
3036 * add_tx_ts - Add traffic stream
3037 * @priv: Private driver interface data
3038 * @tsid: Traffic stream ID
3039 * @addr: Receiver address
3040 * @user_prio: User priority of the traffic stream
3041 * @admitted_time: Admitted time for this TS in units of
3042 * 32 microsecond periods (per second).
3043 * Returns: 0 on success, -1 on failure
3045 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3049 * del_tx_ts - Delete traffic stream
3050 * @priv: Private driver interface data
3051 * @tsid: Traffic stream ID
3052 * @addr: Receiver address
3053 * Returns: 0 on success, -1 on failure
3055 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3058 * Enable channel-switching with TDLS peer
3059 * @priv: Private driver interface data
3060 * @addr: MAC address of the TDLS peer
3061 * @oper_class: Operating class of the switch channel
3062 * @params: Channel specification
3063 * Returns: 0 on success, -1 on failure
3065 * The function indicates to driver that it can start switching to a
3066 * different channel with a specified TDLS peer. The switching is
3067 * assumed on until canceled with tdls_disable_channel_switch().
3069 int (*tdls_enable_channel_switch)(
3070 void *priv, const u8 *addr, u8 oper_class,
3071 const struct hostapd_freq_params *params);
3074 * Disable channel switching with TDLS peer
3075 * @priv: Private driver interface data
3076 * @addr: MAC address of the TDLS peer
3077 * Returns: 0 on success, -1 on failure
3079 * This function indicates to the driver that it should stop switching
3080 * with a given TDLS peer.
3082 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3085 * start_dfs_cac - Listen for radar interference on the channel
3086 * @priv: Private driver interface data
3087 * @freq: Channel parameters
3088 * Returns: 0 on success, -1 on failure
3090 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
3093 * stop_ap - Removes beacon from AP
3094 * @priv: Private driver interface data
3095 * Returns: 0 on success, -1 on failure (or if not supported)
3097 * This optional function can be used to disable AP mode related
3098 * configuration. Unlike deinit_ap, it does not change to station
3101 int (*stop_ap)(void *priv);
3104 * get_survey - Retrieve survey data
3105 * @priv: Private driver interface data
3106 * @freq: If set, survey data for the specified frequency is only
3107 * being requested. If not set, all survey data is requested.
3108 * Returns: 0 on success, -1 on failure
3110 * Use this to retrieve:
3112 * - the observed channel noise floor
3113 * - the amount of time we have spent on the channel
3114 * - the amount of time during which we have spent on the channel that
3115 * the radio has determined the medium is busy and we cannot
3117 * - the amount of time we have spent receiving data
3118 * - the amount of time we have spent transmitting data
3120 * This data can be used for spectrum heuristics. One example is
3121 * Automatic Channel Selection (ACS). The channel survey data is
3122 * kept on a linked list on the channel data, one entry is added
3123 * for each survey. The min_nf of the channel is updated for each
3126 int (*get_survey)(void *priv, unsigned int freq);
3129 * status - Get driver interface status information
3130 * @priv: Private driver interface data
3131 * @buf: Buffer for printing tou the status information
3132 * @buflen: Maximum length of the buffer
3133 * Returns: Length of written status information or -1 on failure
3135 int (*status)(void *priv, char *buf, size_t buflen);
3138 * roaming - Set roaming policy for driver-based BSS selection
3139 * @priv: Private driver interface data
3140 * @allowed: Whether roaming within ESS is allowed
3141 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3142 * Returns: Length of written status information or -1 on failure
3144 * This optional callback can be used to update roaming policy from the
3145 * associate() command (bssid being set there indicates that the driver
3146 * should not roam before getting this roaming() call to allow roaming.
3147 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3148 * capability, roaming policy is handled within wpa_supplicant and there
3149 * is no need to implement or react to this callback.
3151 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3154 * set_mac_addr - Set MAC address
3155 * @priv: Private driver interface data
3156 * @addr: MAC address to use or %NULL for setting back to permanent
3157 * Returns: 0 on success, -1 on failure
3159 int (*set_mac_addr)(void *priv, const u8 *addr);
3161 #ifdef CONFIG_MACSEC
3162 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3164 int (*macsec_deinit)(void *priv);
3167 * enable_protect_frames - Set protect frames status
3168 * @priv: Private driver interface data
3169 * @enabled: TRUE = protect frames enabled
3170 * FALSE = protect frames disabled
3171 * Returns: 0 on success, -1 on failure (or if not supported)
3173 int (*enable_protect_frames)(void *priv, Boolean enabled);
3176 * set_replay_protect - Set replay protect status and window size
3177 * @priv: Private driver interface data
3178 * @enabled: TRUE = replay protect enabled
3179 * FALSE = replay protect disabled
3180 * @window: replay window size, valid only when replay protect enabled
3181 * Returns: 0 on success, -1 on failure (or if not supported)
3183 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3186 * set_current_cipher_suite - Set current cipher suite
3187 * @priv: Private driver interface data
3188 * @cs: EUI64 identifier
3189 * @cs_len: Length of the cs buffer in octets
3190 * Returns: 0 on success, -1 on failure (or if not supported)
3192 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3196 * enable_controlled_port - Set controlled port status
3197 * @priv: Private driver interface data
3198 * @enabled: TRUE = controlled port enabled
3199 * FALSE = controlled port disabled
3200 * Returns: 0 on success, -1 on failure (or if not supported)
3202 int (*enable_controlled_port)(void *priv, Boolean enabled);
3205 * get_receive_lowest_pn - Get receive lowest pn
3206 * @priv: Private driver interface data
3207 * @channel: secure channel
3208 * @an: association number
3209 * @lowest_pn: lowest accept pn
3210 * Returns: 0 on success, -1 on failure (or if not supported)
3212 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3216 * get_transmit_next_pn - Get transmit next pn
3217 * @priv: Private driver interface data
3218 * @channel: secure channel
3219 * @an: association number
3221 * Returns: 0 on success, -1 on failure (or if not supported)
3223 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3227 * set_transmit_next_pn - Set transmit next pn
3228 * @priv: Private driver interface data
3229 * @channel: secure channel
3230 * @an: association number
3232 * Returns: 0 on success, -1 on failure (or if not supported)
3234 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3238 * get_available_receive_sc - get available receive channel
3239 * @priv: Private driver interface data
3240 * @channel: secure channel
3241 * Returns: 0 on success, -1 on failure (or if not supported)
3243 int (*get_available_receive_sc)(void *priv, u32 *channel);
3246 * create_receive_sc - create secure channel for receiving
3247 * @priv: Private driver interface data
3248 * @channel: secure channel
3249 * @sci_addr: secure channel identifier - address
3250 * @sci_port: secure channel identifier - port
3251 * @conf_offset: confidentiality offset (0, 30, or 50)
3252 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3254 * Returns: 0 on success, -1 on failure (or if not supported)
3256 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3257 u16 sci_port, unsigned int conf_offset,
3261 * delete_receive_sc - delete secure connection for receiving
3262 * @priv: private driver interface data from init()
3263 * @channel: secure channel
3264 * Returns: 0 on success, -1 on failure
3266 int (*delete_receive_sc)(void *priv, u32 channel);
3269 * create_receive_sa - create secure association for receive
3270 * @priv: private driver interface data from init()
3271 * @channel: secure channel
3272 * @an: association number
3273 * @lowest_pn: the lowest packet number can be received
3274 * @sak: the secure association key
3275 * Returns: 0 on success, -1 on failure
3277 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3278 u32 lowest_pn, const u8 *sak);
3281 * enable_receive_sa - enable the SA for receive
3282 * @priv: private driver interface data from init()
3283 * @channel: secure channel
3284 * @an: association number
3285 * Returns: 0 on success, -1 on failure
3287 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3290 * disable_receive_sa - disable SA for receive
3291 * @priv: private driver interface data from init()
3292 * @channel: secure channel index
3293 * @an: association number
3294 * Returns: 0 on success, -1 on failure
3296 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3299 * get_available_transmit_sc - get available transmit channel
3300 * @priv: Private driver interface data
3301 * @channel: secure channel
3302 * Returns: 0 on success, -1 on failure (or if not supported)
3304 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3307 * create_transmit_sc - create secure connection for transmit
3308 * @priv: private driver interface data from init()
3309 * @channel: secure channel
3310 * @sci_addr: secure channel identifier - address
3311 * @sci_port: secure channel identifier - port
3312 * Returns: 0 on success, -1 on failure
3314 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3315 u16 sci_port, unsigned int conf_offset);
3318 * delete_transmit_sc - delete secure connection for transmit
3319 * @priv: private driver interface data from init()
3320 * @channel: secure channel
3321 * Returns: 0 on success, -1 on failure
3323 int (*delete_transmit_sc)(void *priv, u32 channel);
3326 * create_transmit_sa - create secure association for transmit
3327 * @priv: private driver interface data from init()
3328 * @channel: secure channel index
3329 * @an: association number
3330 * @next_pn: the packet number used as next transmit packet
3331 * @confidentiality: True if the SA is to provide confidentiality
3332 * as well as integrity
3333 * @sak: the secure association key
3334 * Returns: 0 on success, -1 on failure
3336 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3337 Boolean confidentiality, const u8 *sak);
3340 * enable_transmit_sa - enable SA for transmit
3341 * @priv: private driver interface data from init()
3342 * @channel: secure channel
3343 * @an: association number
3344 * Returns: 0 on success, -1 on failure
3346 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3349 * disable_transmit_sa - disable SA for transmit
3350 * @priv: private driver interface data from init()
3351 * @channel: secure channel
3352 * @an: association number
3353 * Returns: 0 on success, -1 on failure
3355 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3356 #endif /* CONFIG_MACSEC */
3359 * init_mesh - Driver specific initialization for mesh
3360 * @priv: Private driver interface data
3361 * Returns: 0 on success, -1 on failure
3363 int (*init_mesh)(void *priv);
3366 * join_mesh - Join a mesh network
3367 * @priv: Private driver interface data
3368 * @params: Mesh configuration parameters
3369 * Returns: 0 on success, -1 on failure
3371 int (*join_mesh)(void *priv,
3372 struct wpa_driver_mesh_join_params *params);
3375 * leave_mesh - Leave a mesh network
3376 * @priv: Private driver interface data
3377 * Returns 0 on success, -1 on failure
3379 int (*leave_mesh)(void *priv);
3382 * do_acs - Automatically select channel
3383 * @priv: Private driver interface data
3384 * @params: Parameters for ACS
3385 * Returns 0 on success, -1 on failure
3387 * This command can be used to offload ACS to the driver if the driver
3388 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3390 int (*do_acs)(void *priv, struct drv_acs_params *params);
3393 * set_band - Notify driver of band selection
3394 * @priv: Private driver interface data
3395 * @band: The selected band(s)
3396 * Returns 0 on success, -1 on failure
3398 int (*set_band)(void *priv, enum set_band band);
3403 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3405 enum wpa_event_type {
3407 * EVENT_ASSOC - Association completed
3409 * This event needs to be delivered when the driver completes IEEE
3410 * 802.11 association or reassociation successfully.
3411 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3412 * after this event has been generated. In addition, optional
3413 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3414 * more information about the association. If the driver interface gets
3415 * both of these events at the same time, it can also include the
3416 * assoc_info data in EVENT_ASSOC call.
3421 * EVENT_DISASSOC - Association lost
3423 * This event should be called when association is lost either due to
3424 * receiving deauthenticate or disassociate frame from the AP or when
3425 * sending either of these frames to the current AP. If the driver
3426 * supports separate deauthentication event, EVENT_DISASSOC should only
3427 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3428 * In AP mode, union wpa_event_data::disassoc_info is required.
3433 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3435 * This event must be delivered when a Michael MIC error is detected by
3436 * the local driver. Additional data for event processing is
3437 * provided with union wpa_event_data::michael_mic_failure. This
3438 * information is used to request new encyption key and to initiate
3439 * TKIP countermeasures if needed.
3441 EVENT_MICHAEL_MIC_FAILURE,
3444 * EVENT_SCAN_RESULTS - Scan results available
3446 * This event must be called whenever scan results are available to be
3447 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3448 * is expected to be used some time after struct wpa_driver_ops::scan()
3449 * is called. If the driver provides an unsolicited event when the scan
3450 * has been completed, this event can be used to trigger
3451 * EVENT_SCAN_RESULTS call. If such event is not available from the
3452 * driver, the driver wrapper code is expected to use a registered
3453 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3454 * scan is expected to be completed. Optional information about
3455 * completed scan can be provided with union wpa_event_data::scan_info.
3460 * EVENT_ASSOCINFO - Report optional extra information for association
3462 * This event can be used to report extra association information for
3463 * EVENT_ASSOC processing. This extra information includes IEs from
3464 * association frames and Beacon/Probe Response frames in union
3465 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3466 * EVENT_ASSOC. Alternatively, the driver interface can include
3467 * assoc_info data in the EVENT_ASSOC call if it has all the
3468 * information available at the same point.
3473 * EVENT_INTERFACE_STATUS - Report interface status changes
3475 * This optional event can be used to report changes in interface
3476 * status (interface added/removed) using union
3477 * wpa_event_data::interface_status. This can be used to trigger
3478 * wpa_supplicant to stop and re-start processing for the interface,
3479 * e.g., when a cardbus card is ejected/inserted.
3481 EVENT_INTERFACE_STATUS,
3484 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3486 * This event can be used to inform wpa_supplicant about candidates for
3487 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3488 * for scan request (ap_scan=2 mode), this event is required for
3489 * pre-authentication. If wpa_supplicant is performing scan request
3490 * (ap_scan=1), this event is optional since scan results can be used
3491 * to add pre-authentication candidates. union
3492 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3493 * candidate and priority of the candidate, e.g., based on the signal
3494 * strength, in order to try to pre-authenticate first with candidates
3495 * that are most likely targets for re-association.
3497 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3498 * on the candidate list. In addition, it can be called for the current
3499 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3500 * will automatically skip pre-authentication in cases where a valid
3501 * PMKSA exists. When more than one candidate exists, this event should
3502 * be generated once for each candidate.
3504 * Driver will be notified about successful pre-authentication with
3505 * struct wpa_driver_ops::add_pmkid() calls.
3507 EVENT_PMKID_CANDIDATE,
3510 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3512 * This event can be used to inform wpa_supplicant about desire to set
3513 * up secure direct link connection between two stations as defined in
3514 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3515 * STAKey negotiation. The caller will need to set peer address for the
3521 * EVENT_TDLS - Request TDLS operation
3523 * This event can be used to request a TDLS operation to be performed.
3528 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3530 * The driver is expected to report the received FT IEs from
3531 * FT authentication sequence from the AP. The FT IEs are included in
3532 * the extra information in union wpa_event_data::ft_ies.
3537 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3539 * The driver can use this event to inform wpa_supplicant about a STA
3540 * in an IBSS with which protected frames could be exchanged. This
3541 * event starts RSN authentication with the other STA to authenticate
3542 * the STA and set up encryption keys with it.
3544 EVENT_IBSS_RSN_START,
3547 * EVENT_AUTH - Authentication result
3549 * This event should be called when authentication attempt has been
3550 * completed. This is only used if the driver supports separate
3551 * authentication step (struct wpa_driver_ops::authenticate).
3552 * Information about authentication result is included in
3553 * union wpa_event_data::auth.
3558 * EVENT_DEAUTH - Authentication lost
3560 * This event should be called when authentication is lost either due
3561 * to receiving deauthenticate frame from the AP or when sending that
3562 * frame to the current AP.
3563 * In AP mode, union wpa_event_data::deauth_info is required.
3568 * EVENT_ASSOC_REJECT - Association rejected
3570 * This event should be called when (re)association attempt has been
3571 * rejected by the AP. Information about the association response is
3572 * included in union wpa_event_data::assoc_reject.
3577 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3579 EVENT_AUTH_TIMED_OUT,
3582 * EVENT_ASSOC_TIMED_OUT - Association timed out
3584 EVENT_ASSOC_TIMED_OUT,
3587 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3589 EVENT_WPS_BUTTON_PUSHED,
3592 * EVENT_TX_STATUS - Report TX status
3597 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3599 EVENT_RX_FROM_UNKNOWN,
3602 * EVENT_RX_MGMT - Report RX of a management frame
3607 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3609 * This event is used to indicate when the driver has started the
3610 * requested remain-on-channel duration. Information about the
3611 * operation is included in union wpa_event_data::remain_on_channel.
3613 EVENT_REMAIN_ON_CHANNEL,
3616 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3618 * This event is used to indicate when the driver has completed
3619 * remain-on-channel duration, i.e., may noot be available on the
3620 * requested channel anymore. Information about the
3621 * operation is included in union wpa_event_data::remain_on_channel.
3623 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3626 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3628 * This event is used to indicate when a Probe Request frame has been
3629 * received. Information about the received frame is included in
3630 * union wpa_event_data::rx_probe_req. The driver is required to report
3631 * these events only after successfully completed probe_req_report()
3632 * commands to request the events (i.e., report parameter is non-zero)
3633 * in station mode. In AP mode, Probe Request frames should always be
3639 * EVENT_NEW_STA - New wired device noticed
3641 * This event is used to indicate that a new device has been detected
3642 * in a network that does not use association-like functionality (i.e.,
3643 * mainly wired Ethernet). This can be used to start EAPOL
3644 * authenticator when receiving a frame from a device. The address of
3645 * the device is included in union wpa_event_data::new_sta.
3650 * EVENT_EAPOL_RX - Report received EAPOL frame
3652 * When in AP mode with hostapd, this event is required to be used to
3653 * deliver the receive EAPOL frames from the driver.
3658 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3660 * This event is used to indicate changes in the signal strength
3661 * observed in frames received from the current AP if signal strength
3662 * monitoring has been enabled with signal_monitor().
3664 EVENT_SIGNAL_CHANGE,
3667 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3669 * This event is used to indicate that the interface was enabled after
3670 * having been previously disabled, e.g., due to rfkill.
3672 EVENT_INTERFACE_ENABLED,
3675 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3677 * This event is used to indicate that the interface was disabled,
3678 * e.g., due to rfkill.
3680 EVENT_INTERFACE_DISABLED,
3683 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3685 * This event is used to indicate that the channel list has changed,
3686 * e.g., because of a regulatory domain change triggered by scan
3687 * results including an AP advertising a country code.
3689 EVENT_CHANNEL_LIST_CHANGED,
3692 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3694 * This event is used to indicate that the driver cannot maintain this
3695 * interface in its operation mode anymore. The most likely use for
3696 * this is to indicate that AP mode operation is not available due to
3697 * operating channel would need to be changed to a DFS channel when
3698 * the driver does not support radar detection and another virtual
3699 * interfaces caused the operating channel to change. Other similar
3700 * resource conflicts could also trigger this for station mode
3701 * interfaces. This event can be propagated when channel switching
3704 EVENT_INTERFACE_UNAVAILABLE,
3707 * EVENT_BEST_CHANNEL
3709 * Driver generates this event whenever it detects a better channel
3710 * (e.g., based on RSSI or channel use). This information can be used
3711 * to improve channel selection for a new AP/P2P group.
3716 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3718 * This event should be called when a Deauthentication frame is dropped
3719 * due to it not being protected (MFP/IEEE 802.11w).
3720 * union wpa_event_data::unprot_deauth is required to provide more
3721 * details of the frame.
3723 EVENT_UNPROT_DEAUTH,
3726 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3728 * This event should be called when a Disassociation frame is dropped
3729 * due to it not being protected (MFP/IEEE 802.11w).
3730 * union wpa_event_data::unprot_disassoc is required to provide more
3731 * details of the frame.
3733 EVENT_UNPROT_DISASSOC,
3736 * EVENT_STATION_LOW_ACK
3738 * Driver generates this event whenever it detected that a particular
3739 * station was lost. Detection can be through massive transmission
3740 * failures for example.
3742 EVENT_STATION_LOW_ACK,
3745 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3747 EVENT_IBSS_PEER_LOST,
3750 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3752 * This event carries the new replay counter to notify wpa_supplicant
3753 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3754 * completed Group Key Handshake while the host (including
3755 * wpa_supplicant was sleeping).
3757 EVENT_DRIVER_GTK_REKEY,
3760 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3762 EVENT_SCHED_SCAN_STOPPED,
3765 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3767 * This event indicates that the station responded to the poll
3768 * initiated with @poll_client.
3770 EVENT_DRIVER_CLIENT_POLL_OK,
3773 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3775 EVENT_EAPOL_TX_STATUS,
3778 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3780 * Described in wpa_event_data.ch_switch
3785 * EVENT_WNM - Request WNM operation
3787 * This event can be used to request a WNM operation to be performed.
3792 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3794 * This event indicates that the driver reported a connection failure
3795 * with the specified client (for example, max client reached, etc.) in
3798 EVENT_CONNECT_FAILED_REASON,
3801 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
3803 * A radar has been detected on the supplied frequency, hostapd should
3804 * react accordingly (e.g., change channel).
3806 EVENT_DFS_RADAR_DETECTED,
3809 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
3811 * After a successful CAC, the channel can be marked clear and used.
3813 EVENT_DFS_CAC_FINISHED,
3816 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
3818 * The CAC was not successful, and the channel remains in the previous
3819 * state. This may happen due to a radar beeing detected or other
3820 * external influences.
3822 EVENT_DFS_CAC_ABORTED,
3825 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
3827 * The channel which was previously unavailable is now available again.
3829 EVENT_DFS_NOP_FINISHED,
3832 * EVENT_SURVEY - Received survey data
3834 * This event gets triggered when a driver query is issued for survey
3835 * data and the requested data becomes available. The returned data is
3836 * stored in struct survey_results. The results provide at most one
3837 * survey entry for each frequency and at minimum will provide one
3838 * survey entry for one frequency. The survey data can be os_malloc()'d
3839 * and then os_free()'d, so the event callback must only copy data.
3844 * EVENT_SCAN_STARTED - Scan started
3846 * This indicates that driver has started a scan operation either based
3847 * on a request from wpa_supplicant/hostapd or from another application.
3848 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3849 * completed (either successfully or by getting cancelled).
3854 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3856 * This event indicates a set of frequency ranges that should be avoided
3857 * to reduce issues due to interference or internal co-existence
3858 * information in the driver.
3860 EVENT_AVOID_FREQUENCIES,
3863 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3865 EVENT_NEW_PEER_CANDIDATE,
3868 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
3870 * Indicates a pair of primary and secondary channels chosen by ACS
3873 EVENT_ACS_CHANNEL_SELECTED,
3876 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
3879 * This event indicates that channel availability check has been started
3880 * on a DFS frequency by a driver that supports DFS Offload.
3882 EVENT_DFS_CAC_STARTED,
3887 * struct freq_survey - Channel survey info
3889 * @ifidx: Interface index in which this survey was observed
3890 * @freq: Center of frequency of the surveyed channel
3891 * @nf: Channel noise floor in dBm
3892 * @channel_time: Amount of time in ms the radio spent on the channel
3893 * @channel_time_busy: Amount of time in ms the radio detected some signal
3894 * that indicated to the radio the channel was not clear
3895 * @channel_time_rx: Amount of time the radio spent receiving data
3896 * @channel_time_tx: Amount of time the radio spent transmitting data
3897 * @filled: bitmask indicating which fields have been reported, see
3898 * SURVEY_HAS_* defines.
3899 * @list: Internal list pointers
3901 struct freq_survey {
3906 u64 channel_time_busy;
3907 u64 channel_time_rx;
3908 u64 channel_time_tx;
3909 unsigned int filled;
3910 struct dl_list list;
3913 #define SURVEY_HAS_NF BIT(0)
3914 #define SURVEY_HAS_CHAN_TIME BIT(1)
3915 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3916 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3917 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3921 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3923 union wpa_event_data {
3925 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3927 * This structure is optional for EVENT_ASSOC calls and required for
3928 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3929 * driver interface does not need to generate separate EVENT_ASSOCINFO
3934 * reassoc - Flag to indicate association or reassociation
3939 * req_ies - (Re)Association Request IEs
3941 * If the driver generates WPA/RSN IE, this event data must be
3942 * returned for WPA handshake to have needed information. If
3943 * wpa_supplicant-generated WPA/RSN IE is used, this
3944 * information event is optional.
3946 * This should start with the first IE (fixed fields before IEs
3947 * are not included).
3952 * req_ies_len - Length of req_ies in bytes
3957 * resp_ies - (Re)Association Response IEs
3959 * Optional association data from the driver. This data is not
3960 * required WPA, but may be useful for some protocols and as
3961 * such, should be reported if this is available to the driver
3964 * This should start with the first IE (fixed fields before IEs
3965 * are not included).
3970 * resp_ies_len - Length of resp_ies in bytes
3972 size_t resp_ies_len;
3975 * beacon_ies - Beacon or Probe Response IEs
3977 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3978 * Probe Response frames from the current AP (i.e., the one
3979 * that the client just associated with). This information is
3980 * used to update WPA/RSN IE for the AP. If this field is not
3981 * set, the results from previous scan will be used. If no
3982 * data for the new AP is found, scan results will be requested
3983 * again (without scan request). At this point, the driver is
3984 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3987 * This should start with the first IE (fixed fields before IEs
3988 * are not included).
3990 const u8 *beacon_ies;
3993 * beacon_ies_len - Length of beacon_ies */
3994 size_t beacon_ies_len;
3997 * freq - Frequency of the operational channel in MHz
4002 * wmm_params - WMM parameters used in this association.
4004 struct wmm_params wmm_params;
4007 * addr - Station address (for AP mode)
4012 * The following is the key management offload information
4015 * @key_replay_ctr_len
4023 * authorized - Status of key management offload,
4029 * key_replay_ctr - Key replay counter value last used
4030 * in a valid EAPOL-Key frame
4032 const u8 *key_replay_ctr;
4035 * key_replay_ctr_len - The length of key_replay_ctr
4037 size_t key_replay_ctr_len;
4040 * ptk_kck - The derived PTK KCK
4045 * ptk_kek_len - The length of ptk_kck
4050 * ptk_kek - The derived PTK KEK
4055 * ptk_kek_len - The length of ptk_kek
4061 * struct disassoc_info - Data for EVENT_DISASSOC events
4063 struct disassoc_info {
4065 * addr - Station address (for AP mode)
4070 * reason_code - Reason Code (host byte order) used in
4071 * Deauthentication frame
4076 * ie - Optional IE(s) in Disassociation frame
4081 * ie_len - Length of ie buffer in octets
4086 * locally_generated - Whether the frame was locally generated
4088 int locally_generated;
4092 * struct deauth_info - Data for EVENT_DEAUTH events
4094 struct deauth_info {
4096 * addr - Station address (for AP mode)
4101 * reason_code - Reason Code (host byte order) used in
4102 * Deauthentication frame
4107 * ie - Optional IE(s) in Deauthentication frame
4112 * ie_len - Length of ie buffer in octets
4117 * locally_generated - Whether the frame was locally generated
4119 int locally_generated;
4123 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4125 struct michael_mic_failure {
4128 } michael_mic_failure;
4131 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4133 struct interface_status {
4136 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4141 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4143 struct pmkid_candidate {
4144 /** BSSID of the PMKID candidate */
4146 /** Smaller the index, higher the priority */
4148 /** Whether RSN IE includes pre-authenticate flag */
4153 * struct stkstart - Data for EVENT_STKSTART
4160 * struct tdls - Data for EVENT_TDLS
4166 TDLS_REQUEST_TEARDOWN,
4167 TDLS_REQUEST_DISCOVER,
4169 u16 reason_code; /* for teardown */
4173 * struct wnm - Data for EVENT_WNM
4191 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4193 * During FT (IEEE 802.11r) authentication sequence, the driver is
4194 * expected to use this event to report received FT IEs (MDIE, FTIE,
4195 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4196 * IEs for the next message will be delivered through the
4197 * struct wpa_driver_ops::update_ft_ies() callback.
4203 u8 target_ap[ETH_ALEN];
4204 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4206 /** Length of ric_ies buffer in octets */
4211 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4213 struct ibss_rsn_start {
4218 * struct auth_info - Data for EVENT_AUTH events
4224 u16 auth_transaction;
4231 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4233 struct assoc_reject {
4235 * bssid - BSSID of the AP that rejected association
4240 * resp_ies - (Re)Association Response IEs
4242 * Optional association data from the driver. This data is not
4243 * required WPA, but may be useful for some protocols and as
4244 * such, should be reported if this is available to the driver
4247 * This should start with the first IE (fixed fields before IEs
4248 * are not included).
4253 * resp_ies_len - Length of resp_ies in bytes
4255 size_t resp_ies_len;
4258 * status_code - Status Code from (Re)association Response
4263 struct timeout_event {
4268 * struct tx_status - Data for EVENT_TX_STATUS events
4280 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4282 struct rx_from_unknown {
4289 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4297 * drv_priv - Pointer to store driver private BSS information
4299 * If not set to NULL, this is used for comparison with
4300 * hostapd_data->drv_priv to determine which BSS should process
4306 * freq - Frequency (in MHz) on which the frame was received
4311 * ssi_signal - Signal strength in dBm (or 0 if not available)
4317 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4319 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4321 struct remain_on_channel {
4323 * freq - Channel frequency in MHz
4328 * duration - Duration to remain on the channel in milliseconds
4330 unsigned int duration;
4331 } remain_on_channel;
4334 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4335 * @aborted: Whether the scan was aborted
4336 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4337 * @num_freqs: Number of entries in freqs array
4338 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4340 * @num_ssids: Number of entries in ssids array
4346 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4351 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4353 struct rx_probe_req {
4355 * sa - Source address of the received Probe Request frame
4360 * da - Destination address of the received Probe Request frame
4361 * or %NULL if not available
4366 * bssid - BSSID of the received Probe Request frame or %NULL
4372 * ie - IEs from the Probe Request body
4377 * ie_len - Length of ie buffer in octets
4382 * signal - signal strength in dBm (or 0 if not available)
4388 * struct new_sta - Data for EVENT_NEW_STA events
4395 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4404 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4406 struct wpa_signal_info signal_change;
4409 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4410 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4411 * @freq_5: Best 5 GHz band channel frequency in MHz
4412 * @freq_overall: Best channel frequency in MHz
4414 * 0 can be used to indicate no preference in either band.
4416 struct best_channel {
4422 struct unprot_deauth {
4428 struct unprot_disassoc {
4435 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4436 * @addr: station address
4443 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4445 struct ibss_peer_lost {
4450 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4452 struct driver_gtk_rekey {
4454 const u8 *replay_ctr;
4458 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4459 * @addr: station address
4461 struct client_poll {
4466 * struct eapol_tx_status
4467 * @dst: Original destination
4468 * @data: Data starting with IEEE 802.1X header (!)
4469 * @data_len: Length of data
4470 * @ack: Indicates ack or lost frame
4472 * This corresponds to hapd_send_eapol if the frame sent
4473 * there isn't just reported as EVENT_TX_STATUS.
4475 struct eapol_tx_status {
4484 * @freq: Frequency of new channel in MHz
4485 * @ht_enabled: Whether this is an HT channel
4486 * @ch_offset: Secondary channel offset
4487 * @ch_width: Channel width
4488 * @cf1: Center frequency 1
4489 * @cf2: Center frequency 2
4495 enum chan_width ch_width;
4501 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4502 * @addr: Remote client address
4503 * @code: Reason code for connection failure
4505 struct connect_failed_reason {
4511 } connect_failed_reason;
4514 * struct dfs_event - Data for radar detected events
4515 * @freq: Frequency of the channel in MHz
4521 enum chan_width chan_width;
4527 * survey_results - Survey result data for EVENT_SURVEY
4528 * @freq_filter: Requested frequency survey filter, 0 if request
4529 * was for all survey data
4530 * @survey_list: Linked list of survey data (struct freq_survey)
4532 struct survey_results {
4533 unsigned int freq_filter;
4534 struct dl_list survey_list; /* struct freq_survey */
4538 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4539 * @initiator: Initiator of the regulatory change
4540 * @type: Regulatory change type
4541 * @alpha2: Country code (or "" if not available)
4543 struct channel_list_changed {
4544 enum reg_change_initiator initiator;
4547 } channel_list_changed;
4550 * freq_range - List of frequency ranges
4552 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4554 struct wpa_freq_range_list freq_range;
4559 * @peer: Peer address
4561 * @ie_len: Length of @ies
4563 * Notification of new candidate mesh peer.
4572 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4573 * @pri_channel: Selected primary channel
4574 * @sec_channel: Selected secondary channel
4575 * @vht_seg0_center_ch: VHT mode Segment0 center channel
4576 * @vht_seg1_center_ch: VHT mode Segment1 center channel
4577 * @ch_width: Selected Channel width by driver. Driver may choose to
4578 * change hostapd configured ACS channel width due driver internal
4579 * channel restrictions.
4580 * hw_mode: Selected band (used with hw_mode=any)
4582 struct acs_selected_channels {
4585 u8 vht_seg0_center_ch;
4586 u8 vht_seg1_center_ch;
4588 enum hostapd_hw_mode hw_mode;
4589 } acs_selected_channels;
4593 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4594 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4595 * with struct wpa_driver_ops::init()
4596 * @event: event type (defined above)
4597 * @data: possible extra data for the event
4599 * Driver wrapper code should call this function whenever an event is received
4602 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4603 union wpa_event_data *data);
4607 * The following inline functions are provided for convenience to simplify
4608 * event indication for some of the common events.
4611 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4612 size_t ielen, int reassoc)
4614 union wpa_event_data event;
4615 os_memset(&event, 0, sizeof(event));
4616 event.assoc_info.reassoc = reassoc;
4617 event.assoc_info.req_ies = ie;
4618 event.assoc_info.req_ies_len = ielen;
4619 event.assoc_info.addr = addr;
4620 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4623 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4625 union wpa_event_data event;
4626 os_memset(&event, 0, sizeof(event));
4627 event.disassoc_info.addr = addr;
4628 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4631 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4634 union wpa_event_data event;
4635 os_memset(&event, 0, sizeof(event));
4636 event.eapol_rx.src = src;
4637 event.eapol_rx.data = data;
4638 event.eapol_rx.data_len = data_len;
4639 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4642 /* driver_common.c */
4643 void wpa_scan_results_free(struct wpa_scan_results *res);
4645 /* Convert wpa_event_type to a string for logging */
4646 const char * event_to_string(enum wpa_event_type event);
4648 /* Convert chan_width to a string for logging and control interfaces */
4649 const char * channel_width_to_string(enum chan_width width);
4651 int ht_supported(const struct hostapd_hw_modes *mode);
4652 int vht_supported(const struct hostapd_hw_modes *mode);
4654 struct wowlan_triggers *
4655 wpa_get_wowlan_triggers(const char *wowlan_triggers,
4656 const struct wpa_driver_capa *capa);
4658 /* NULL terminated array of linked in driver wrappers */
4659 extern const struct wpa_driver_ops *const wpa_drivers[];
4661 #endif /* DRIVER_H */