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
1217 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1218 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1219 unsigned int smps_modes;
1221 unsigned int wmm_ac_supported:1;
1223 unsigned int mac_addr_rand_scan_supported:1;
1224 unsigned int mac_addr_rand_sched_scan_supported:1;
1226 /** Maximum number of supported active probe SSIDs */
1229 /** Maximum number of supported active probe SSIDs for sched_scan */
1230 int max_sched_scan_ssids;
1232 /** Whether sched_scan (offloaded scanning) is supported */
1233 int sched_scan_supported;
1235 /** Maximum number of supported match sets for sched_scan */
1239 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1241 unsigned int max_remain_on_chan;
1244 * max_stations - Maximum number of associated stations the driver
1245 * supports in AP mode
1247 unsigned int max_stations;
1250 * probe_resp_offloads - Bitmap of supported protocols by the driver
1251 * for Probe Response offloading.
1253 /** Driver Probe Response offloading support for WPS ver. 1 */
1254 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1255 /** Driver Probe Response offloading support for WPS ver. 2 */
1256 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1257 /** Driver Probe Response offloading support for P2P */
1258 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1259 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1260 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1261 unsigned int probe_resp_offloads;
1263 unsigned int max_acl_mac_addrs;
1266 * Number of supported concurrent channels
1268 unsigned int num_multichan_concurrent;
1271 * extended_capa - extended capabilities in driver/device
1273 * Must be allocated and freed by driver and the pointers must be
1274 * valid for the lifetime of the driver, i.e., freed in deinit()
1276 const u8 *extended_capa, *extended_capa_mask;
1277 unsigned int extended_capa_len;
1279 struct wowlan_triggers wowlan_triggers;
1281 /** Driver adds the DS Params Set IE in Probe Request frames */
1282 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1283 /** Driver adds the WFA TPC IE in Probe Request frames */
1284 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1285 /** Driver handles quiet period requests */
1286 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1288 * Driver is capable of inserting the current TX power value into the body of
1289 * transmitted frames.
1290 * Background: Some Action frames include a TPC Report IE. This IE contains a
1291 * TX power field, which has to be updated by lower layers. One such Action
1292 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1293 * of spectrum management). Note that this insertion takes place at a fixed
1294 * offset, namely the 6th byte in the Action frame body.
1296 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1301 struct hostapd_data;
1303 struct hostap_sta_driver_data {
1304 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1305 unsigned long current_tx_rate;
1306 unsigned long inactive_msec;
1307 unsigned long flags;
1308 unsigned long num_ps_buf_frames;
1309 unsigned long tx_retry_failed;
1310 unsigned long tx_retry_count;
1315 struct hostapd_sta_add_params {
1319 const u8 *supp_rates;
1320 size_t supp_rates_len;
1321 u16 listen_interval;
1322 const struct ieee80211_ht_capabilities *ht_capabilities;
1323 const struct ieee80211_vht_capabilities *vht_capabilities;
1324 int vht_opmode_enabled;
1326 u32 flags; /* bitmask of WPA_STA_* flags */
1327 u32 flags_mask; /* unset bits in flags */
1329 enum mesh_plink_state plink_state;
1330 #endif /* CONFIG_MESH */
1331 int set; /* Set STA parameters instead of add */
1333 const u8 *ext_capab;
1334 size_t ext_capab_len;
1335 const u8 *supp_channels;
1336 size_t supp_channels_len;
1337 const u8 *supp_oper_classes;
1338 size_t supp_oper_classes_len;
1341 struct mac_address {
1345 struct hostapd_acl_params {
1347 unsigned int num_mac_acl;
1348 struct mac_address mac_acl[0];
1351 enum wpa_driver_if_type {
1353 * WPA_IF_STATION - Station mode interface
1358 * WPA_IF_AP_VLAN - AP mode VLAN interface
1360 * This interface shares its address and Beacon frame with the main
1366 * WPA_IF_AP_BSS - AP mode BSS interface
1368 * This interface has its own address and Beacon frame.
1373 * WPA_IF_P2P_GO - P2P Group Owner
1378 * WPA_IF_P2P_CLIENT - P2P Client
1383 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1384 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1389 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1390 * abstracted P2P Device function in the driver
1395 * WPA_IF_MESH - Mesh interface
1400 struct wpa_init_params {
1404 const char *driver_params;
1405 int use_pae_group_addr;
1409 u8 *own_addr; /* buffer for writing own MAC address */
1413 struct wpa_bss_params {
1414 /** Interface name (for multi-SSID/VLAN support) */
1416 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1425 enum mfp_options ieee80211w;
1428 #define WPA_STA_AUTHORIZED BIT(0)
1429 #define WPA_STA_WMM BIT(1)
1430 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1431 #define WPA_STA_MFP BIT(3)
1432 #define WPA_STA_TDLS_PEER BIT(4)
1433 #define WPA_STA_AUTHENTICATED BIT(5)
1446 WNM_SLEEP_ENTER_CONFIRM,
1447 WNM_SLEEP_ENTER_FAIL,
1448 WNM_SLEEP_EXIT_CONFIRM,
1449 WNM_SLEEP_EXIT_FAIL,
1450 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1451 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1452 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1454 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1456 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1457 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1459 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1462 /* enum chan_width - Channel width definitions */
1474 * struct wpa_signal_info - Information about channel signal quality
1476 struct wpa_signal_info {
1478 int above_threshold;
1481 int avg_beacon_signal;
1484 enum chan_width chanwidth;
1490 * struct beacon_data - Beacon data
1491 * @head: Head portion of Beacon frame (before TIM IE)
1492 * @tail: Tail portion of Beacon frame (after TIM IE)
1493 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1494 * @proberesp_ies: Extra information element(s) to add into Probe Response
1496 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1497 * Response frames or %NULL
1498 * @probe_resp: Probe Response frame template
1499 * @head_len: Length of @head
1500 * @tail_len: Length of @tail
1501 * @beacon_ies_len: Length of beacon_ies in octets
1502 * @proberesp_ies_len: Length of proberesp_ies in octets
1503 * @proberesp_ies_len: Length of proberesp_ies in octets
1504 * @probe_resp_len: Length of probe response template (@probe_resp)
1506 struct beacon_data {
1513 size_t head_len, tail_len;
1514 size_t beacon_ies_len;
1515 size_t proberesp_ies_len;
1516 size_t assocresp_ies_len;
1517 size_t probe_resp_len;
1521 * struct csa_settings - Settings for channel switch command
1522 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1523 * @block_tx: 1 - block transmission for CSA period
1524 * @freq_params: Next channel frequency parameter
1525 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1526 * @beacon_after: Next beacon/probe resp/asooc resp info
1527 * @counter_offset_beacon: Offset to the count field in beacon's tail
1528 * @counter_offset_presp: Offset to the count field in probe resp.
1530 struct csa_settings {
1534 struct hostapd_freq_params freq_params;
1535 struct beacon_data beacon_csa;
1536 struct beacon_data beacon_after;
1538 u16 counter_offset_beacon;
1539 u16 counter_offset_presp;
1542 /* TDLS peer capabilities for send_tdls_mgmt() */
1543 enum tdls_peer_capability {
1544 TDLS_PEER_HT = BIT(0),
1545 TDLS_PEER_VHT = BIT(1),
1546 TDLS_PEER_WMM = BIT(2),
1549 /* valid info in the wmm_params struct */
1550 enum wmm_params_valid_info {
1551 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1555 * struct wmm_params - WMM parameterss configured for this association
1556 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1557 * of the struct contain valid information.
1558 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1559 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1566 #ifdef CONFIG_MACSEC
1567 struct macsec_init_params {
1568 Boolean always_include_sci;
1572 #endif /* CONFIG_MACSEC */
1574 enum drv_br_port_attr {
1575 DRV_BR_PORT_ATTR_PROXYARP,
1576 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1579 enum drv_br_net_param {
1580 DRV_BR_NET_PARAM_GARP_ACCEPT,
1581 DRV_BR_MULTICAST_SNOOPING,
1584 struct drv_acs_params {
1585 /* Selected mode (HOSTAPD_MODE_*) */
1586 enum hostapd_hw_mode hw_mode;
1588 /* Indicates whether HT is enabled */
1591 /* Indicates whether HT40 is enabled */
1594 /* Indicates whether VHT is enabled */
1597 /* Configured ACS channel width */
1600 /* ACS channel list info */
1601 unsigned int ch_list_len;
1607 * struct wpa_driver_ops - Driver interface API definition
1609 * This structure defines the API that each driver interface needs to implement
1610 * for core wpa_supplicant code. All driver specific functionality is captured
1613 struct wpa_driver_ops {
1614 /** Name of the driver interface */
1616 /** One line description of the driver interface */
1620 * get_bssid - Get the current BSSID
1621 * @priv: private driver interface data
1622 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1624 * Returns: 0 on success, -1 on failure
1626 * Query kernel driver for the current BSSID and copy it to bssid.
1627 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1630 int (*get_bssid)(void *priv, u8 *bssid);
1633 * get_ssid - Get the current SSID
1634 * @priv: private driver interface data
1635 * @ssid: buffer for SSID (at least 32 bytes)
1637 * Returns: Length of the SSID on success, -1 on failure
1639 * Query kernel driver for the current SSID and copy it to ssid.
1640 * Returning zero is recommended if the STA is not associated.
1642 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1643 * can, at least in theory, contain control characters (including nul)
1644 * and as such, should be processed as binary data, not a printable
1647 int (*get_ssid)(void *priv, u8 *ssid);
1650 * set_key - Configure encryption key
1651 * @ifname: Interface name (for multi-SSID/VLAN support)
1652 * @priv: private driver interface data
1653 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1654 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1655 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1656 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1657 * %WPA_ALG_BIP_CMAC_256);
1658 * %WPA_ALG_NONE clears the key.
1659 * @addr: Address of the peer STA (BSSID of the current AP when setting
1660 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1661 * broadcast keys, %NULL for default keys that are used both for
1662 * broadcast and unicast; when clearing keys, %NULL is used to
1663 * indicate that both the broadcast-only and default key of the
1664 * specified key index is to be cleared
1665 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1667 * @set_tx: configure this key as the default Tx key (only used when
1668 * driver does not support separate unicast/individual key
1669 * @seq: sequence number/packet number, seq_len octets, the next
1670 * packet number to be used for in replay protection; configured
1671 * for Rx keys (in most cases, this is only used with broadcast
1672 * keys and set to zero for unicast keys); %NULL if not set
1673 * @seq_len: length of the seq, depends on the algorithm:
1674 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1675 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1677 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1678 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1680 * Returns: 0 on success, -1 on failure
1682 * Configure the given key for the kernel driver. If the driver
1683 * supports separate individual keys (4 default keys + 1 individual),
1684 * addr can be used to determine whether the key is default or
1685 * individual. If only 4 keys are supported, the default key with key
1686 * index 0 is used as the individual key. STA must be configured to use
1687 * it as the default Tx key (set_tx is set) and accept Rx for all the
1688 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1689 * broadcast keys, so key index 0 is available for this kind of
1692 * Please note that TKIP keys include separate TX and RX MIC keys and
1693 * some drivers may expect them in different order than wpa_supplicant
1694 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1695 * will trigger Michael MIC errors. This can be fixed by changing the
1696 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1697 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1698 * example on how this can be done.
1700 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1701 const u8 *addr, int key_idx, int set_tx,
1702 const u8 *seq, size_t seq_len,
1703 const u8 *key, size_t key_len);
1706 * init - Initialize driver interface
1707 * @ctx: context to be used when calling wpa_supplicant functions,
1708 * e.g., wpa_supplicant_event()
1709 * @ifname: interface name, e.g., wlan0
1711 * Returns: Pointer to private data, %NULL on failure
1713 * Initialize driver interface, including event processing for kernel
1714 * driver events (e.g., associated, scan results, Michael MIC failure).
1715 * This function can allocate a private configuration data area for
1716 * @ctx, file descriptor, interface name, etc. information that may be
1717 * needed in future driver operations. If this is not used, non-NULL
1718 * value will need to be returned because %NULL is used to indicate
1719 * failure. The returned value will be used as 'void *priv' data for
1720 * all other driver_ops functions.
1722 * The main event loop (eloop.c) of wpa_supplicant can be used to
1723 * register callback for read sockets (eloop_register_read_sock()).
1725 * See below for more information about events and
1726 * wpa_supplicant_event() function.
1728 void * (*init)(void *ctx, const char *ifname);
1731 * deinit - Deinitialize driver interface
1732 * @priv: private driver interface data from init()
1734 * Shut down driver interface and processing of driver events. Free
1735 * private data buffer if one was allocated in init() handler.
1737 void (*deinit)(void *priv);
1740 * set_param - Set driver configuration parameters
1741 * @priv: private driver interface data from init()
1742 * @param: driver specific configuration parameters
1744 * Returns: 0 on success, -1 on failure
1746 * Optional handler for notifying driver interface about configuration
1747 * parameters (driver_param).
1749 int (*set_param)(void *priv, const char *param);
1752 * set_countermeasures - Enable/disable TKIP countermeasures
1753 * @priv: private driver interface data
1754 * @enabled: 1 = countermeasures enabled, 0 = disabled
1756 * Returns: 0 on success, -1 on failure
1758 * Configure TKIP countermeasures. When these are enabled, the driver
1759 * should drop all received and queued frames that are using TKIP.
1761 int (*set_countermeasures)(void *priv, int enabled);
1764 * deauthenticate - Request driver to deauthenticate
1765 * @priv: private driver interface data
1766 * @addr: peer address (BSSID of the AP)
1767 * @reason_code: 16-bit reason code to be sent in the deauthentication
1770 * Returns: 0 on success, -1 on failure
1772 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1775 * associate - Request driver to associate
1776 * @priv: private driver interface data
1777 * @params: association parameters
1779 * Returns: 0 on success, -1 on failure
1781 int (*associate)(void *priv,
1782 struct wpa_driver_associate_params *params);
1785 * add_pmkid - Add PMKSA cache entry to the driver
1786 * @priv: private driver interface data
1787 * @bssid: BSSID for the PMKSA cache entry
1788 * @pmkid: PMKID for the PMKSA cache entry
1790 * Returns: 0 on success, -1 on failure
1792 * This function is called when a new PMK is received, as a result of
1793 * either normal authentication or RSN pre-authentication.
1795 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1796 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1797 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1798 * driver_ops function does not need to be implemented. Likewise, if
1799 * the driver does not support WPA, this function is not needed.
1801 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1804 * remove_pmkid - Remove PMKSA cache entry to the driver
1805 * @priv: private driver interface data
1806 * @bssid: BSSID for the PMKSA cache entry
1807 * @pmkid: PMKID for the PMKSA cache entry
1809 * Returns: 0 on success, -1 on failure
1811 * This function is called when the supplicant drops a PMKSA cache
1812 * entry for any reason.
1814 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1815 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1816 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1817 * from wpa_supplicant, this driver_ops function does not need to be
1818 * implemented. Likewise, if the driver does not support WPA, this
1819 * function is not needed.
1821 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1824 * flush_pmkid - Flush PMKSA cache
1825 * @priv: private driver interface data
1827 * Returns: 0 on success, -1 on failure
1829 * This function is called when the supplicant drops all PMKSA cache
1830 * entries for any reason.
1832 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1833 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1834 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1835 * from wpa_supplicant, this driver_ops function does not need to be
1836 * implemented. Likewise, if the driver does not support WPA, this
1837 * function is not needed.
1839 int (*flush_pmkid)(void *priv);
1842 * get_capa - Get driver capabilities
1843 * @priv: private driver interface data
1845 * Returns: 0 on success, -1 on failure
1847 * Get driver/firmware/hardware capabilities.
1849 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1852 * poll - Poll driver for association information
1853 * @priv: private driver interface data
1855 * This is an option callback that can be used when the driver does not
1856 * provide event mechanism for association events. This is called when
1857 * receiving WPA EAPOL-Key messages that require association
1858 * information. The driver interface is supposed to generate associnfo
1859 * event before returning from this callback function. In addition, the
1860 * driver interface should generate an association event after having
1861 * sent out associnfo.
1863 void (*poll)(void *priv);
1866 * get_ifname - Get interface name
1867 * @priv: private driver interface data
1869 * Returns: Pointer to the interface name. This can differ from the
1870 * interface name used in init() call. Init() is called first.
1872 * This optional function can be used to allow the driver interface to
1873 * replace the interface name with something else, e.g., based on an
1874 * interface mapping from a more descriptive name.
1876 const char * (*get_ifname)(void *priv);
1879 * get_mac_addr - Get own MAC address
1880 * @priv: private driver interface data
1882 * Returns: Pointer to own MAC address or %NULL on failure
1884 * This optional function can be used to get the own MAC address of the
1885 * device from the driver interface code. This is only needed if the
1886 * l2_packet implementation for the OS does not provide easy access to
1888 const u8 * (*get_mac_addr)(void *priv);
1891 * set_operstate - Sets device operating state to DORMANT or UP
1892 * @priv: private driver interface data
1893 * @state: 0 = dormant, 1 = up
1894 * Returns: 0 on success, -1 on failure
1896 * This is an optional function that can be used on operating systems
1897 * that support a concept of controlling network device state from user
1898 * space applications. This function, if set, gets called with
1899 * state = 1 when authentication has been completed and with state = 0
1900 * when connection is lost.
1902 int (*set_operstate)(void *priv, int state);
1905 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1906 * @priv: Private driver interface data
1907 * @addr: Address of the station for which to set protection (may be
1908 * %NULL for group keys)
1909 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1910 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1911 * Returns: 0 on success, -1 on failure
1913 * This is an optional function that can be used to set the driver to
1914 * require protection for Tx and/or Rx frames. This uses the layer
1915 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1916 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1917 * set protection operation; instead, they set protection implicitly
1918 * based on configured keys.
1920 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1924 * get_hw_feature_data - Get hardware support data (channels and rates)
1925 * @priv: Private driver interface data
1926 * @num_modes: Variable for returning the number of returned modes
1927 * flags: Variable for returning hardware feature flags
1928 * Returns: Pointer to allocated hardware data on success or %NULL on
1929 * failure. Caller is responsible for freeing this.
1931 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1936 * send_mlme - Send management frame from MLME
1937 * @priv: Private driver interface data
1938 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1939 * @data_len: Size of the management frame
1940 * @noack: Do not wait for this frame to be acked (disable retries)
1941 * Returns: 0 on success, -1 on failure
1943 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1947 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1948 * @priv: Private driver interface data
1949 * @md: Mobility domain (2 octets) (also included inside ies)
1950 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1951 * @ies_len: Length of FT IEs in bytes
1952 * Returns: 0 on success, -1 on failure
1954 * The supplicant uses this callback to let the driver know that keying
1955 * material for FT is available and that the driver can use the
1956 * provided IEs in the next message in FT authentication sequence.
1958 * This function is only needed for driver that support IEEE 802.11r
1959 * (Fast BSS Transition).
1961 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1965 * get_scan_results2 - Fetch the latest scan results
1966 * @priv: private driver interface data
1968 * Returns: Allocated buffer of scan results (caller is responsible for
1969 * freeing the data structure) on success, NULL on failure
1971 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1974 * set_country - Set country
1975 * @priv: Private driver interface data
1976 * @alpha2: country to which to switch to
1977 * Returns: 0 on success, -1 on failure
1979 * This function is for drivers which support some form
1980 * of setting a regulatory domain.
1982 int (*set_country)(void *priv, const char *alpha2);
1985 * get_country - Get country
1986 * @priv: Private driver interface data
1987 * @alpha2: Buffer for returning country code (at least 3 octets)
1988 * Returns: 0 on success, -1 on failure
1990 int (*get_country)(void *priv, char *alpha2);
1993 * global_init - Global driver initialization
1994 * Returns: Pointer to private data (global), %NULL on failure
1996 * This optional function is called to initialize the driver wrapper
1997 * for global data, i.e., data that applies to all interfaces. If this
1998 * function is implemented, global_deinit() will also need to be
1999 * implemented to free the private data. The driver will also likely
2000 * use init2() function instead of init() to get the pointer to global
2001 * data available to per-interface initializer.
2003 void * (*global_init)(void);
2006 * global_deinit - Global driver deinitialization
2007 * @priv: private driver global data from global_init()
2009 * Terminate any global driver related functionality and free the
2010 * global data structure.
2012 void (*global_deinit)(void *priv);
2015 * init2 - Initialize driver interface (with global data)
2016 * @ctx: context to be used when calling wpa_supplicant functions,
2017 * e.g., wpa_supplicant_event()
2018 * @ifname: interface name, e.g., wlan0
2019 * @global_priv: private driver global data from global_init()
2020 * Returns: Pointer to private data, %NULL on failure
2022 * This function can be used instead of init() if the driver wrapper
2025 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2028 * get_interfaces - Get information about available interfaces
2029 * @global_priv: private driver global data from global_init()
2030 * Returns: Allocated buffer of interface information (caller is
2031 * responsible for freeing the data structure) on success, NULL on
2034 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2037 * scan2 - Request the driver to initiate scan
2038 * @priv: private driver interface data
2039 * @params: Scan parameters
2041 * Returns: 0 on success, -1 on failure
2043 * Once the scan results are ready, the driver should report scan
2044 * results event for wpa_supplicant which will eventually request the
2045 * results with wpa_driver_get_scan_results2().
2047 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2050 * authenticate - Request driver to authenticate
2051 * @priv: private driver interface data
2052 * @params: authentication parameters
2053 * Returns: 0 on success, -1 on failure
2055 * This is an optional function that can be used with drivers that
2056 * support separate authentication and association steps, i.e., when
2057 * wpa_supplicant can act as the SME. If not implemented, associate()
2058 * function is expected to take care of IEEE 802.11 authentication,
2061 int (*authenticate)(void *priv,
2062 struct wpa_driver_auth_params *params);
2065 * set_ap - Set Beacon and Probe Response information for AP mode
2066 * @priv: Private driver interface data
2067 * @params: Parameters to use in AP mode
2069 * This function is used to configure Beacon template and/or extra IEs
2070 * to add for Beacon and Probe Response frames for the driver in
2071 * AP mode. The driver is responsible for building the full Beacon
2072 * frame by concatenating the head part with TIM IE generated by the
2073 * driver/firmware and finishing with the tail part. Depending on the
2074 * driver architectue, this can be done either by using the full
2075 * template or the set of additional IEs (e.g., WPS and P2P IE).
2076 * Similarly, Probe Response processing depends on the driver design.
2077 * If the driver (or firmware) takes care of replying to Probe Request
2078 * frames, the extra IEs provided here needs to be added to the Probe
2081 * Returns: 0 on success, -1 on failure
2083 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
2086 * set_acl - Set ACL in AP mode
2087 * @priv: Private driver interface data
2088 * @params: Parameters to configure ACL
2089 * Returns: 0 on success, -1 on failure
2091 * This is used only for the drivers which support MAC address ACL.
2093 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2096 * hapd_init - Initialize driver interface (hostapd only)
2097 * @hapd: Pointer to hostapd context
2098 * @params: Configuration for the driver wrapper
2099 * Returns: Pointer to private data, %NULL on failure
2101 * This function is used instead of init() or init2() when the driver
2102 * wrapper is used with hostapd.
2104 void * (*hapd_init)(struct hostapd_data *hapd,
2105 struct wpa_init_params *params);
2108 * hapd_deinit - Deinitialize driver interface (hostapd only)
2109 * @priv: Private driver interface data from hapd_init()
2111 void (*hapd_deinit)(void *priv);
2114 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2115 * @priv: Private driver interface data
2116 * @params: BSS parameters
2117 * Returns: 0 on success, -1 on failure
2119 * This is an optional function to configure the kernel driver to
2120 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2121 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2122 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2123 * for Beacon frames.
2125 * DEPRECATED - use set_ap() instead
2127 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2130 * set_privacy - Enable/disable privacy (AP only)
2131 * @priv: Private driver interface data
2132 * @enabled: 1 = privacy enabled, 0 = disabled
2133 * Returns: 0 on success, -1 on failure
2135 * This is an optional function to configure privacy field in the
2136 * kernel driver for Beacon frames. This can be left undefined (set to
2137 * %NULL) if the driver uses the Beacon template from set_ap().
2139 * DEPRECATED - use set_ap() instead
2141 int (*set_privacy)(void *priv, int enabled);
2144 * get_seqnum - Fetch the current TSC/packet number (AP only)
2145 * @ifname: The interface name (main or virtual)
2146 * @priv: Private driver interface data
2147 * @addr: MAC address of the station or %NULL for group keys
2149 * @seq: Buffer for returning the latest used TSC/packet number
2150 * Returns: 0 on success, -1 on failure
2152 * This function is used to fetch the last used TSC/packet number for
2153 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2154 * keys, so there is no strict requirement on implementing support for
2155 * unicast keys (i.e., addr != %NULL).
2157 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2161 * flush - Flush all association stations (AP only)
2162 * @priv: Private driver interface data
2163 * Returns: 0 on success, -1 on failure
2165 * This function requests the driver to disassociate all associated
2166 * stations. This function does not need to be implemented if the
2167 * driver does not process association frames internally.
2169 int (*flush)(void *priv);
2172 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2173 * @priv: Private driver interface data
2174 * @elem: Information elements
2175 * @elem_len: Length of the elem buffer in octets
2176 * Returns: 0 on success, -1 on failure
2178 * This is an optional function to add information elements in the
2179 * kernel driver for Beacon and Probe Response frames. This can be left
2180 * undefined (set to %NULL) if the driver uses the Beacon template from
2183 * DEPRECATED - use set_ap() instead
2185 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2188 * read_sta_data - Fetch station data
2189 * @priv: Private driver interface data
2190 * @data: Buffer for returning station information
2191 * @addr: MAC address of the station
2192 * Returns: 0 on success, -1 on failure
2194 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2198 * hapd_send_eapol - Send an EAPOL packet (AP only)
2199 * @priv: private driver interface data
2200 * @addr: Destination MAC address
2201 * @data: EAPOL packet starting with IEEE 802.1X header
2202 * @data_len: Length of the EAPOL packet in octets
2203 * @encrypt: Whether the frame should be encrypted
2204 * @own_addr: Source MAC address
2205 * @flags: WPA_STA_* flags for the destination station
2207 * Returns: 0 on success, -1 on failure
2209 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2210 size_t data_len, int encrypt,
2211 const u8 *own_addr, u32 flags);
2214 * sta_deauth - Deauthenticate a station (AP only)
2215 * @priv: Private driver interface data
2216 * @own_addr: Source address and BSSID for the Deauthentication frame
2217 * @addr: MAC address of the station to deauthenticate
2218 * @reason: Reason code for the Deauthentiation frame
2219 * Returns: 0 on success, -1 on failure
2221 * This function requests a specific station to be deauthenticated and
2222 * a Deauthentication frame to be sent to it.
2224 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2228 * sta_disassoc - Disassociate a station (AP only)
2229 * @priv: Private driver interface data
2230 * @own_addr: Source address and BSSID for the Disassociation frame
2231 * @addr: MAC address of the station to disassociate
2232 * @reason: Reason code for the Disassociation frame
2233 * Returns: 0 on success, -1 on failure
2235 * This function requests a specific station to be disassociated and
2236 * a Disassociation frame to be sent to it.
2238 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2242 * sta_remove - Remove a station entry (AP only)
2243 * @priv: Private driver interface data
2244 * @addr: MAC address of the station to be removed
2245 * Returns: 0 on success, -1 on failure
2247 int (*sta_remove)(void *priv, const u8 *addr);
2250 * hapd_get_ssid - Get the current SSID (AP only)
2251 * @priv: Private driver interface data
2252 * @buf: Buffer for returning the SSID
2253 * @len: Maximum length of the buffer
2254 * Returns: Length of the SSID on success, -1 on failure
2256 * This function need not be implemented if the driver uses Beacon
2257 * template from set_ap() and does not reply to Probe Request frames.
2259 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2262 * hapd_set_ssid - Set SSID (AP only)
2263 * @priv: Private driver interface data
2265 * @len: Length of the SSID in octets
2266 * Returns: 0 on success, -1 on failure
2268 * DEPRECATED - use set_ap() instead
2270 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2273 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2274 * @priv: Private driver interface data
2275 * @enabled: 1 = countermeasures enabled, 0 = disabled
2276 * Returns: 0 on success, -1 on failure
2278 * This need not be implemented if the driver does not take care of
2279 * association processing.
2281 int (*hapd_set_countermeasures)(void *priv, int enabled);
2284 * sta_add - Add a station entry
2285 * @priv: Private driver interface data
2286 * @params: Station parameters
2287 * Returns: 0 on success, -1 on failure
2289 * This function is used to add a station entry to the driver once the
2290 * station has completed association. This is only used if the driver
2291 * does not take care of association processing.
2293 * With TDLS, this function is also used to add or set (params->set 1)
2294 * TDLS peer entries.
2296 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2299 * get_inact_sec - Get station inactivity duration (AP only)
2300 * @priv: Private driver interface data
2301 * @addr: Station address
2302 * Returns: Number of seconds station has been inactive, -1 on failure
2304 int (*get_inact_sec)(void *priv, const u8 *addr);
2307 * sta_clear_stats - Clear station statistics (AP only)
2308 * @priv: Private driver interface data
2309 * @addr: Station address
2310 * Returns: 0 on success, -1 on failure
2312 int (*sta_clear_stats)(void *priv, const u8 *addr);
2315 * set_freq - Set channel/frequency (AP only)
2316 * @priv: Private driver interface data
2317 * @freq: Channel parameters
2318 * Returns: 0 on success, -1 on failure
2320 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2323 * set_rts - Set RTS threshold
2324 * @priv: Private driver interface data
2325 * @rts: RTS threshold in octets
2326 * Returns: 0 on success, -1 on failure
2328 int (*set_rts)(void *priv, int rts);
2331 * set_frag - Set fragmentation threshold
2332 * @priv: Private driver interface data
2333 * @frag: Fragmentation threshold in octets
2334 * Returns: 0 on success, -1 on failure
2336 int (*set_frag)(void *priv, int frag);
2339 * sta_set_flags - Set station flags (AP only)
2340 * @priv: Private driver interface data
2341 * @addr: Station address
2342 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2343 * @flags_or: Bitmap of WPA_STA_* flags to add
2344 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2345 * Returns: 0 on success, -1 on failure
2347 int (*sta_set_flags)(void *priv, const u8 *addr,
2348 int total_flags, int flags_or, int flags_and);
2351 * set_tx_queue_params - Set TX queue parameters
2352 * @priv: Private driver interface data
2353 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2357 * @burst_time: Maximum length for bursting in 0.1 msec units
2359 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2360 int cw_max, int burst_time);
2363 * if_add - Add a virtual interface
2364 * @priv: Private driver interface data
2365 * @type: Interface type
2366 * @ifname: Interface name for the new virtual interface
2367 * @addr: Local address to use for the interface or %NULL to use the
2368 * parent interface address
2369 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2370 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2371 * not allowed (applies only to %WPA_IF_AP_BSS type)
2372 * @force_ifname: Buffer for returning an interface name that the
2373 * driver ended up using if it differs from the requested ifname
2374 * @if_addr: Buffer for returning the allocated interface address
2375 * (this may differ from the requested addr if the driver cannot
2376 * change interface address)
2377 * @bridge: Bridge interface to use or %NULL if no bridge configured
2378 * @use_existing: Whether to allow existing interface to be used
2379 * Returns: 0 on success, -1 on failure
2381 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2382 const char *ifname, const u8 *addr, void *bss_ctx,
2383 void **drv_priv, char *force_ifname, u8 *if_addr,
2384 const char *bridge, int use_existing);
2387 * if_remove - Remove a virtual interface
2388 * @priv: Private driver interface data
2389 * @type: Interface type
2390 * @ifname: Interface name of the virtual interface to be removed
2391 * Returns: 0 on success, -1 on failure
2393 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2394 const char *ifname);
2397 * set_sta_vlan - Bind a station into a specific interface (AP only)
2398 * @priv: Private driver interface data
2399 * @ifname: Interface (main or virtual BSS or VLAN)
2400 * @addr: MAC address of the associated station
2402 * Returns: 0 on success, -1 on failure
2404 * This function is used to bind a station to a specific virtual
2405 * interface. It is only used if when virtual interfaces are supported,
2406 * e.g., to assign stations to different VLAN interfaces based on
2407 * information from a RADIUS server. This allows separate broadcast
2408 * domains to be used with a single BSS.
2410 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2414 * commit - Optional commit changes handler (AP only)
2415 * @priv: driver private data
2416 * Returns: 0 on success, -1 on failure
2418 * This optional handler function can be registered if the driver
2419 * interface implementation needs to commit changes (e.g., by setting
2420 * network interface up) at the end of initial configuration. If set,
2421 * this handler will be called after initial setup has been completed.
2423 int (*commit)(void *priv);
2426 * send_ether - Send an ethernet packet (AP only)
2427 * @priv: private driver interface data
2428 * @dst: Destination MAC address
2429 * @src: Source MAC address
2431 * @data: EAPOL packet starting with IEEE 802.1X header
2432 * @data_len: Length of the EAPOL packet in octets
2433 * Returns: 0 on success, -1 on failure
2435 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2436 const u8 *data, size_t data_len);
2439 * set_radius_acl_auth - Notification of RADIUS ACL change
2440 * @priv: Private driver interface data
2441 * @mac: MAC address of the station
2442 * @accepted: Whether the station was accepted
2443 * @session_timeout: Session timeout for the station
2444 * Returns: 0 on success, -1 on failure
2446 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2447 u32 session_timeout);
2450 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2451 * @priv: Private driver interface data
2452 * @mac: MAC address of the station
2453 * Returns: 0 on success, -1 on failure
2455 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2458 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2459 * @priv: Private driver interface data
2460 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2461 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2463 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2464 * to remove extra IE(s)
2465 * Returns: 0 on success, -1 on failure
2467 * This is an optional function to add WPS IE in the kernel driver for
2468 * Beacon and Probe Response frames. This can be left undefined (set
2469 * to %NULL) if the driver uses the Beacon template from set_ap()
2470 * and does not process Probe Request frames. If the driver takes care
2471 * of (Re)Association frame processing, the assocresp buffer includes
2472 * WPS IE(s) that need to be added to (Re)Association Response frames
2473 * whenever a (Re)Association Request frame indicated use of WPS.
2475 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2476 * frames when operating as a GO. The driver is responsible for adding
2477 * timing related attributes (e.g., NoA) in addition to the IEs
2478 * included here by appending them after these buffers. This call is
2479 * also used to provide Probe Response IEs for P2P Listen state
2480 * operations for drivers that generate the Probe Response frames
2483 * DEPRECATED - use set_ap() instead
2485 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2486 const struct wpabuf *proberesp,
2487 const struct wpabuf *assocresp);
2490 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2491 * @priv: Private driver interface data
2492 * @authorized: Whether the port is authorized
2493 * Returns: 0 on success, -1 on failure
2495 int (*set_supp_port)(void *priv, int authorized);
2498 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2499 * @priv: Private driver interface data
2500 * @addr: MAC address of the associated station
2501 * @aid: Association ID
2502 * @val: 1 = bind to 4-address WDS; 0 = unbind
2503 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2504 * to indicate that bridge is not to be used
2505 * @ifname_wds: Buffer to return the interface name for the new WDS
2506 * station or %NULL to indicate name is not returned.
2507 * Returns: 0 on success, -1 on failure
2509 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2510 const char *bridge_ifname, char *ifname_wds);
2513 * send_action - Transmit an Action frame
2514 * @priv: Private driver interface data
2515 * @freq: Frequency (in MHz) of the channel
2516 * @wait: Time to wait off-channel for a response (in ms), or zero
2517 * @dst: Destination MAC address (Address 1)
2518 * @src: Source MAC address (Address 2)
2519 * @bssid: BSSID (Address 3)
2521 * @data_len: data length in octets
2522 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2523 * Returns: 0 on success, -1 on failure
2525 * This command can be used to request the driver to transmit an action
2526 * frame to the specified destination.
2528 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2529 * be transmitted on the given channel and the device will wait for a
2530 * response on that channel for the given wait time.
2532 * If the flag is not set, the wait time will be ignored. In this case,
2533 * if a remain-on-channel duration is in progress, the frame must be
2534 * transmitted on that channel; alternatively the frame may be sent on
2535 * the current operational channel (if in associated state in station
2536 * mode or while operating as an AP.)
2538 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2539 const u8 *dst, const u8 *src, const u8 *bssid,
2540 const u8 *data, size_t data_len, int no_cck);
2543 * send_action_cancel_wait - Cancel action frame TX wait
2544 * @priv: Private driver interface data
2546 * This command cancels the wait time associated with sending an action
2547 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2548 * set in the driver flags.
2550 void (*send_action_cancel_wait)(void *priv);
2553 * remain_on_channel - Remain awake on a channel
2554 * @priv: Private driver interface data
2555 * @freq: Frequency (in MHz) of the channel
2556 * @duration: Duration in milliseconds
2557 * Returns: 0 on success, -1 on failure
2559 * This command is used to request the driver to remain awake on the
2560 * specified channel for the specified duration and report received
2561 * Action frames with EVENT_RX_MGMT events. Optionally, received
2562 * Probe Request frames may also be requested to be reported by calling
2563 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2565 * The driver may not be at the requested channel when this function
2566 * returns, i.e., the return code is only indicating whether the
2567 * request was accepted. The caller will need to wait until the
2568 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2569 * completed the channel change. This may take some time due to other
2570 * need for the radio and the caller should be prepared to timing out
2571 * its wait since there are no guarantees on when this request can be
2574 int (*remain_on_channel)(void *priv, unsigned int freq,
2575 unsigned int duration);
2578 * cancel_remain_on_channel - Cancel remain-on-channel operation
2579 * @priv: Private driver interface data
2581 * This command can be used to cancel a remain-on-channel operation
2582 * before its originally requested duration has passed. This could be
2583 * used, e.g., when remain_on_channel() is used to request extra time
2584 * to receive a response to an Action frame and the response is
2585 * received when there is still unneeded time remaining on the
2586 * remain-on-channel operation.
2588 int (*cancel_remain_on_channel)(void *priv);
2591 * probe_req_report - Request Probe Request frames to be indicated
2592 * @priv: Private driver interface data
2593 * @report: Whether to report received Probe Request frames
2594 * Returns: 0 on success, -1 on failure (or if not supported)
2596 * This command can be used to request the driver to indicate when
2597 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2598 * Since this operation may require extra resources, e.g., due to less
2599 * optimal hardware/firmware RX filtering, many drivers may disable
2600 * Probe Request reporting at least in station mode. This command is
2601 * used to notify the driver when the Probe Request frames need to be
2602 * reported, e.g., during remain-on-channel operations.
2604 int (*probe_req_report)(void *priv, int report);
2607 * deinit_ap - Deinitialize AP mode
2608 * @priv: Private driver interface data
2609 * Returns: 0 on success, -1 on failure (or if not supported)
2611 * This optional function can be used to disable AP mode related
2612 * configuration. If the interface was not dynamically added,
2613 * change the driver mode to station mode to allow normal station
2614 * operations like scanning to be completed.
2616 int (*deinit_ap)(void *priv);
2619 * deinit_p2p_cli - Deinitialize P2P client mode
2620 * @priv: Private driver interface data
2621 * Returns: 0 on success, -1 on failure (or if not supported)
2623 * This optional function can be used to disable P2P client mode. If the
2624 * interface was not dynamically added, change the interface type back
2627 int (*deinit_p2p_cli)(void *priv);
2630 * suspend - Notification on system suspend/hibernate event
2631 * @priv: Private driver interface data
2633 void (*suspend)(void *priv);
2636 * resume - Notification on system resume/thaw event
2637 * @priv: Private driver interface data
2639 void (*resume)(void *priv);
2642 * signal_monitor - Set signal monitoring parameters
2643 * @priv: Private driver interface data
2644 * @threshold: Threshold value for signal change events; 0 = disabled
2645 * @hysteresis: Minimum change in signal strength before indicating a
2647 * Returns: 0 on success, -1 on failure (or if not supported)
2649 * This function can be used to configure monitoring of signal strength
2650 * with the current AP. Whenever signal strength drops below the
2651 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2652 * should be generated assuming the signal strength has changed at
2653 * least %hysteresis from the previously indicated signal change event.
2655 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2658 * send_frame - Send IEEE 802.11 frame (testing use only)
2659 * @priv: Private driver interface data
2660 * @data: IEEE 802.11 frame with IEEE 802.11 header
2661 * @data_len: Size of the frame
2662 * @encrypt: Whether to encrypt the frame (if keys are set)
2663 * Returns: 0 on success, -1 on failure
2665 * This function is only used for debugging purposes and is not
2666 * required to be implemented for normal operations.
2668 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2672 * get_noa - Get current Notice of Absence attribute payload
2673 * @priv: Private driver interface data
2674 * @buf: Buffer for returning NoA
2675 * @buf_len: Buffer length in octets
2676 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2677 * advertized, or -1 on failure
2679 * This function is used to fetch the current Notice of Absence
2680 * attribute value from GO.
2682 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2685 * set_noa - Set Notice of Absence parameters for GO (testing)
2686 * @priv: Private driver interface data
2688 * @start: Start time in ms from next TBTT
2689 * @duration: Duration in ms
2690 * Returns: 0 on success or -1 on failure
2692 * This function is used to set Notice of Absence parameters for GO. It
2693 * is used only for testing. To disable NoA, all parameters are set to
2696 int (*set_noa)(void *priv, u8 count, int start, int duration);
2699 * set_p2p_powersave - Set P2P power save options
2700 * @priv: Private driver interface data
2701 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2702 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2703 * @ctwindow: 0.. = change (msec), -1 = no change
2704 * Returns: 0 on success or -1 on failure
2706 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2710 * ampdu - Enable/disable aggregation
2711 * @priv: Private driver interface data
2712 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2713 * Returns: 0 on success or -1 on failure
2715 int (*ampdu)(void *priv, int ampdu);
2718 * get_radio_name - Get physical radio name for the device
2719 * @priv: Private driver interface data
2720 * Returns: Radio name or %NULL if not known
2722 * The returned data must not be modified by the caller. It is assumed
2723 * that any interface that has the same radio name as another is
2724 * sharing the same physical radio. This information can be used to
2725 * share scan results etc. information between the virtual interfaces
2726 * to speed up various operations.
2728 const char * (*get_radio_name)(void *priv);
2731 * send_tdls_mgmt - for sending TDLS management packets
2732 * @priv: private driver interface data
2733 * @dst: Destination (peer) MAC address
2734 * @action_code: TDLS action code for the mssage
2735 * @dialog_token: Dialog Token to use in the message (if needed)
2736 * @status_code: Status Code or Reason Code to use (if needed)
2737 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2738 * @initiator: Is the current end the TDLS link initiator
2739 * @buf: TDLS IEs to add to the message
2740 * @len: Length of buf in octets
2741 * Returns: 0 on success, negative (<0) on failure
2743 * This optional function can be used to send packet to driver which is
2744 * responsible for receiving and sending all TDLS packets.
2746 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2747 u8 dialog_token, u16 status_code, u32 peer_capab,
2748 int initiator, const u8 *buf, size_t len);
2751 * tdls_oper - Ask the driver to perform high-level TDLS operations
2752 * @priv: Private driver interface data
2753 * @oper: TDLS high-level operation. See %enum tdls_oper
2754 * @peer: Destination (peer) MAC address
2755 * Returns: 0 on success, negative (<0) on failure
2757 * This optional function can be used to send high-level TDLS commands
2760 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2763 * wnm_oper - Notify driver of the WNM frame reception
2764 * @priv: Private driver interface data
2765 * @oper: WNM operation. See %enum wnm_oper
2766 * @peer: Destination (peer) MAC address
2767 * @buf: Buffer for the driver to fill in (for getting IE)
2768 * @buf_len: Return the len of buf
2769 * Returns: 0 on success, negative (<0) on failure
2771 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2772 u8 *buf, u16 *buf_len);
2775 * set_qos_map - Set QoS Map
2776 * @priv: Private driver interface data
2777 * @qos_map_set: QoS Map
2778 * @qos_map_set_len: Length of QoS Map
2780 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2781 u8 qos_map_set_len);
2784 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2785 * @priv: Private driver interface data
2786 * @version: IP version of the IP address, 4 or 6
2787 * @ipaddr: IP address for the neigh entry
2788 * @prefixlen: IP address prefix length
2789 * @addr: Corresponding MAC address
2790 * Returns: 0 on success, negative (<0) on failure
2792 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2793 int prefixlen, const u8 *addr);
2796 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2797 * @priv: Private driver interface data
2798 * @version: IP version of the IP address, 4 or 6
2799 * @ipaddr: IP address for the neigh entry
2800 * Returns: 0 on success, negative (<0) on failure
2802 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2805 * br_port_set_attr - Set a bridge port attribute
2806 * @attr: Bridge port attribute to set
2807 * @val: Value to be set
2808 * Returns: 0 on success, negative (<0) on failure
2810 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2814 * br_port_set_attr - Set a bridge network parameter
2815 * @param: Bridge parameter to set
2816 * @val: Value to be set
2817 * Returns: 0 on success, negative (<0) on failure
2819 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2823 * set_wowlan - Set wake-on-wireless triggers
2824 * @priv: Private driver interface data
2825 * @triggers: wowlan triggers
2827 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2830 * signal_poll - Get current connection information
2831 * @priv: Private driver interface data
2832 * @signal_info: Connection info structure
2834 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2837 * set_authmode - Set authentication algorithm(s) for static WEP
2838 * @priv: Private driver interface data
2839 * @authmode: 1=Open System, 2=Shared Key, 3=both
2840 * Returns: 0 on success, -1 on failure
2842 * This function can be used to set authentication algorithms for AP
2843 * mode when static WEP is used. If the driver uses user space MLME/SME
2844 * implementation, there is no need to implement this function.
2846 * DEPRECATED - use set_ap() instead
2848 int (*set_authmode)(void *priv, int authmode);
2852 * driver_cmd - Execute driver-specific command
2853 * @priv: Private driver interface data
2854 * @cmd: Command to execute
2855 * @buf: Return buffer
2856 * @buf_len: Buffer length
2857 * Returns: 0 on success, -1 on failure
2859 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2860 #endif /* ANDROID */
2863 * vendor_cmd - Execute vendor specific command
2864 * @priv: Private driver interface data
2865 * @vendor_id: Vendor id
2866 * @subcmd: Vendor command id
2867 * @data: Vendor command parameters (%NULL if no parameters)
2868 * @data_len: Data length
2869 * @buf: Return buffer (%NULL to ignore reply)
2870 * Returns: 0 on success, negative (<0) on failure
2872 * This function handles vendor specific commands that are passed to
2873 * the driver/device. The command is identified by vendor id and
2874 * command id. Parameters can be passed as argument to the command
2875 * in the data buffer. Reply (if any) will be filled in the supplied
2878 * The exact driver behavior is driver interface and vendor specific. As
2879 * an example, this will be converted to a vendor specific cfg80211
2880 * command in case of the nl80211 driver interface.
2882 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2883 unsigned int subcmd, const u8 *data, size_t data_len,
2884 struct wpabuf *buf);
2887 * set_rekey_info - Set rekey information
2888 * @priv: Private driver interface data
2890 * @kek_len: KEK length in octets
2892 * @kck_len: KCK length in octets
2893 * @replay_ctr: Current EAPOL-Key Replay Counter
2895 * This optional function can be used to provide information for the
2896 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2897 * while the host (including wpa_supplicant) is sleeping.
2899 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
2900 const u8 *kck, size_t kck_len,
2901 const u8 *replay_ctr);
2904 * sta_assoc - Station association indication
2905 * @priv: Private driver interface data
2906 * @own_addr: Source address and BSSID for association frame
2907 * @addr: MAC address of the station to associate
2908 * @reassoc: flag to indicate re-association
2909 * @status: association response status code
2910 * @ie: assoc response ie buffer
2911 * @len: ie buffer length
2912 * Returns: 0 on success, -1 on failure
2914 * This function indicates the driver to send (Re)Association
2915 * Response frame to the station.
2917 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2918 int reassoc, u16 status, const u8 *ie, size_t len);
2921 * sta_auth - Station authentication indication
2922 * @priv: Private driver interface data
2923 * @own_addr: Source address and BSSID for authentication frame
2924 * @addr: MAC address of the station to associate
2925 * @seq: authentication sequence number
2926 * @status: authentication response status code
2927 * @ie: authentication frame ie buffer
2928 * @len: ie buffer length
2930 * This function indicates the driver to send Authentication frame
2933 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2934 u16 seq, u16 status, const u8 *ie, size_t len);
2937 * add_tspec - Add traffic stream
2938 * @priv: Private driver interface data
2939 * @addr: MAC address of the station to associate
2940 * @tspec_ie: tspec ie buffer
2941 * @tspec_ielen: tspec ie length
2942 * Returns: 0 on success, -1 on failure
2944 * This function adds the traffic steam for the station
2945 * and fills the medium_time in tspec_ie.
2947 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2948 size_t tspec_ielen);
2951 * add_sta_node - Add a station node in the driver
2952 * @priv: Private driver interface data
2953 * @addr: MAC address of the station to add
2954 * @auth_alg: authentication algorithm used by the station
2955 * Returns: 0 on success, -1 on failure
2957 * This function adds the station node in the driver, when
2958 * the station gets added by FT-over-DS.
2960 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2963 * sched_scan - Request the driver to initiate scheduled scan
2964 * @priv: Private driver interface data
2965 * @params: Scan parameters
2966 * @interval: Interval between scan cycles in milliseconds
2967 * Returns: 0 on success, -1 on failure
2969 * This operation should be used for scheduled scan offload to
2970 * the hardware. Every time scan results are available, the
2971 * driver should report scan results event for wpa_supplicant
2972 * which will eventually request the results with
2973 * wpa_driver_get_scan_results2(). This operation is optional
2974 * and if not provided or if it returns -1, we fall back to
2975 * normal host-scheduled scans.
2977 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2981 * stop_sched_scan - Request the driver to stop a scheduled scan
2982 * @priv: Private driver interface data
2983 * Returns: 0 on success, -1 on failure
2985 * This should cause the scheduled scan to be stopped and
2986 * results should stop being sent. Must be supported if
2987 * sched_scan is supported.
2989 int (*stop_sched_scan)(void *priv);
2992 * poll_client - Probe (null data or such) the given station
2993 * @priv: Private driver interface data
2994 * @own_addr: MAC address of sending interface
2995 * @addr: MAC address of the station to probe
2996 * @qos: Indicates whether station is QoS station
2998 * This function is used to verify whether an associated station is
2999 * still present. This function does not need to be implemented if the
3000 * driver provides such inactivity polling mechanism.
3002 void (*poll_client)(void *priv, const u8 *own_addr,
3003 const u8 *addr, int qos);
3006 * radio_disable - Disable/enable radio
3007 * @priv: Private driver interface data
3008 * @disabled: 1=disable 0=enable radio
3009 * Returns: 0 on success, -1 on failure
3011 * This optional command is for testing purposes. It can be used to
3012 * disable the radio on a testbed device to simulate out-of-radio-range
3015 int (*radio_disable)(void *priv, int disabled);
3018 * switch_channel - Announce channel switch and migrate the GO to the
3020 * @priv: Private driver interface data
3021 * @settings: Settings for CSA period and new channel
3022 * Returns: 0 on success, -1 on failure
3024 * This function is used to move the GO to the legacy STA channel to
3025 * avoid frequency conflict in single channel concurrency.
3027 int (*switch_channel)(void *priv, struct csa_settings *settings);
3030 * add_tx_ts - Add traffic stream
3031 * @priv: Private driver interface data
3032 * @tsid: Traffic stream ID
3033 * @addr: Receiver address
3034 * @user_prio: User priority of the traffic stream
3035 * @admitted_time: Admitted time for this TS in units of
3036 * 32 microsecond periods (per second).
3037 * Returns: 0 on success, -1 on failure
3039 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3043 * del_tx_ts - Delete traffic stream
3044 * @priv: Private driver interface data
3045 * @tsid: Traffic stream ID
3046 * @addr: Receiver address
3047 * Returns: 0 on success, -1 on failure
3049 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3052 * Enable channel-switching with TDLS peer
3053 * @priv: Private driver interface data
3054 * @addr: MAC address of the TDLS peer
3055 * @oper_class: Operating class of the switch channel
3056 * @params: Channel specification
3057 * Returns: 0 on success, -1 on failure
3059 * The function indicates to driver that it can start switching to a
3060 * different channel with a specified TDLS peer. The switching is
3061 * assumed on until canceled with tdls_disable_channel_switch().
3063 int (*tdls_enable_channel_switch)(
3064 void *priv, const u8 *addr, u8 oper_class,
3065 const struct hostapd_freq_params *params);
3068 * Disable channel switching with TDLS peer
3069 * @priv: Private driver interface data
3070 * @addr: MAC address of the TDLS peer
3071 * Returns: 0 on success, -1 on failure
3073 * This function indicates to the driver that it should stop switching
3074 * with a given TDLS peer.
3076 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3079 * start_dfs_cac - Listen for radar interference on the channel
3080 * @priv: Private driver interface data
3081 * @freq: Channel parameters
3082 * Returns: 0 on success, -1 on failure
3084 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
3087 * stop_ap - Removes beacon from AP
3088 * @priv: Private driver interface data
3089 * Returns: 0 on success, -1 on failure (or if not supported)
3091 * This optional function can be used to disable AP mode related
3092 * configuration. Unlike deinit_ap, it does not change to station
3095 int (*stop_ap)(void *priv);
3098 * get_survey - Retrieve survey data
3099 * @priv: Private driver interface data
3100 * @freq: If set, survey data for the specified frequency is only
3101 * being requested. If not set, all survey data is requested.
3102 * Returns: 0 on success, -1 on failure
3104 * Use this to retrieve:
3106 * - the observed channel noise floor
3107 * - the amount of time we have spent on the channel
3108 * - the amount of time during which we have spent on the channel that
3109 * the radio has determined the medium is busy and we cannot
3111 * - the amount of time we have spent receiving data
3112 * - the amount of time we have spent transmitting data
3114 * This data can be used for spectrum heuristics. One example is
3115 * Automatic Channel Selection (ACS). The channel survey data is
3116 * kept on a linked list on the channel data, one entry is added
3117 * for each survey. The min_nf of the channel is updated for each
3120 int (*get_survey)(void *priv, unsigned int freq);
3123 * status - Get driver interface status information
3124 * @priv: Private driver interface data
3125 * @buf: Buffer for printing tou the status information
3126 * @buflen: Maximum length of the buffer
3127 * Returns: Length of written status information or -1 on failure
3129 int (*status)(void *priv, char *buf, size_t buflen);
3132 * roaming - Set roaming policy for driver-based BSS selection
3133 * @priv: Private driver interface data
3134 * @allowed: Whether roaming within ESS is allowed
3135 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3136 * Returns: Length of written status information or -1 on failure
3138 * This optional callback can be used to update roaming policy from the
3139 * associate() command (bssid being set there indicates that the driver
3140 * should not roam before getting this roaming() call to allow roaming.
3141 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3142 * capability, roaming policy is handled within wpa_supplicant and there
3143 * is no need to implement or react to this callback.
3145 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3148 * set_mac_addr - Set MAC address
3149 * @priv: Private driver interface data
3150 * @addr: MAC address to use or %NULL for setting back to permanent
3151 * Returns: 0 on success, -1 on failure
3153 int (*set_mac_addr)(void *priv, const u8 *addr);
3155 #ifdef CONFIG_MACSEC
3156 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3158 int (*macsec_deinit)(void *priv);
3161 * enable_protect_frames - Set protect frames status
3162 * @priv: Private driver interface data
3163 * @enabled: TRUE = protect frames enabled
3164 * FALSE = protect frames disabled
3165 * Returns: 0 on success, -1 on failure (or if not supported)
3167 int (*enable_protect_frames)(void *priv, Boolean enabled);
3170 * set_replay_protect - Set replay protect status and window size
3171 * @priv: Private driver interface data
3172 * @enabled: TRUE = replay protect enabled
3173 * FALSE = replay protect disabled
3174 * @window: replay window size, valid only when replay protect enabled
3175 * Returns: 0 on success, -1 on failure (or if not supported)
3177 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3180 * set_current_cipher_suite - Set current cipher suite
3181 * @priv: Private driver interface data
3182 * @cs: EUI64 identifier
3183 * @cs_len: Length of the cs buffer in octets
3184 * Returns: 0 on success, -1 on failure (or if not supported)
3186 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3190 * enable_controlled_port - Set controlled port status
3191 * @priv: Private driver interface data
3192 * @enabled: TRUE = controlled port enabled
3193 * FALSE = controlled port disabled
3194 * Returns: 0 on success, -1 on failure (or if not supported)
3196 int (*enable_controlled_port)(void *priv, Boolean enabled);
3199 * get_receive_lowest_pn - Get receive lowest pn
3200 * @priv: Private driver interface data
3201 * @channel: secure channel
3202 * @an: association number
3203 * @lowest_pn: lowest accept pn
3204 * Returns: 0 on success, -1 on failure (or if not supported)
3206 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3210 * get_transmit_next_pn - Get transmit next pn
3211 * @priv: Private driver interface data
3212 * @channel: secure channel
3213 * @an: association number
3215 * Returns: 0 on success, -1 on failure (or if not supported)
3217 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3221 * set_transmit_next_pn - Set transmit next pn
3222 * @priv: Private driver interface data
3223 * @channel: secure channel
3224 * @an: association number
3226 * Returns: 0 on success, -1 on failure (or if not supported)
3228 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3232 * get_available_receive_sc - get available receive channel
3233 * @priv: Private driver interface data
3234 * @channel: secure channel
3235 * Returns: 0 on success, -1 on failure (or if not supported)
3237 int (*get_available_receive_sc)(void *priv, u32 *channel);
3240 * create_receive_sc - create secure channel for receiving
3241 * @priv: Private driver interface data
3242 * @channel: secure channel
3243 * @sci_addr: secure channel identifier - address
3244 * @sci_port: secure channel identifier - port
3245 * @conf_offset: confidentiality offset (0, 30, or 50)
3246 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3248 * Returns: 0 on success, -1 on failure (or if not supported)
3250 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3251 u16 sci_port, unsigned int conf_offset,
3255 * delete_receive_sc - delete secure connection for receiving
3256 * @priv: private driver interface data from init()
3257 * @channel: secure channel
3258 * Returns: 0 on success, -1 on failure
3260 int (*delete_receive_sc)(void *priv, u32 channel);
3263 * create_receive_sa - create secure association for receive
3264 * @priv: private driver interface data from init()
3265 * @channel: secure channel
3266 * @an: association number
3267 * @lowest_pn: the lowest packet number can be received
3268 * @sak: the secure association key
3269 * Returns: 0 on success, -1 on failure
3271 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3272 u32 lowest_pn, const u8 *sak);
3275 * enable_receive_sa - enable the SA for receive
3276 * @priv: private driver interface data from init()
3277 * @channel: secure channel
3278 * @an: association number
3279 * Returns: 0 on success, -1 on failure
3281 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3284 * disable_receive_sa - disable SA for receive
3285 * @priv: private driver interface data from init()
3286 * @channel: secure channel index
3287 * @an: association number
3288 * Returns: 0 on success, -1 on failure
3290 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3293 * get_available_transmit_sc - get available transmit channel
3294 * @priv: Private driver interface data
3295 * @channel: secure channel
3296 * Returns: 0 on success, -1 on failure (or if not supported)
3298 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3301 * create_transmit_sc - create secure connection for transmit
3302 * @priv: private driver interface data from init()
3303 * @channel: secure channel
3304 * @sci_addr: secure channel identifier - address
3305 * @sci_port: secure channel identifier - port
3306 * Returns: 0 on success, -1 on failure
3308 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3309 u16 sci_port, unsigned int conf_offset);
3312 * delete_transmit_sc - delete secure connection for transmit
3313 * @priv: private driver interface data from init()
3314 * @channel: secure channel
3315 * Returns: 0 on success, -1 on failure
3317 int (*delete_transmit_sc)(void *priv, u32 channel);
3320 * create_transmit_sa - create secure association for transmit
3321 * @priv: private driver interface data from init()
3322 * @channel: secure channel index
3323 * @an: association number
3324 * @next_pn: the packet number used as next transmit packet
3325 * @confidentiality: True if the SA is to provide confidentiality
3326 * as well as integrity
3327 * @sak: the secure association key
3328 * Returns: 0 on success, -1 on failure
3330 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3331 Boolean confidentiality, const u8 *sak);
3334 * enable_transmit_sa - enable SA for transmit
3335 * @priv: private driver interface data from init()
3336 * @channel: secure channel
3337 * @an: association number
3338 * Returns: 0 on success, -1 on failure
3340 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3343 * disable_transmit_sa - disable SA for transmit
3344 * @priv: private driver interface data from init()
3345 * @channel: secure channel
3346 * @an: association number
3347 * Returns: 0 on success, -1 on failure
3349 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3350 #endif /* CONFIG_MACSEC */
3353 * init_mesh - Driver specific initialization for mesh
3354 * @priv: Private driver interface data
3355 * Returns: 0 on success, -1 on failure
3357 int (*init_mesh)(void *priv);
3360 * join_mesh - Join a mesh network
3361 * @priv: Private driver interface data
3362 * @params: Mesh configuration parameters
3363 * Returns: 0 on success, -1 on failure
3365 int (*join_mesh)(void *priv,
3366 struct wpa_driver_mesh_join_params *params);
3369 * leave_mesh - Leave a mesh network
3370 * @priv: Private driver interface data
3371 * Returns 0 on success, -1 on failure
3373 int (*leave_mesh)(void *priv);
3376 * do_acs - Automatically select channel
3377 * @priv: Private driver interface data
3378 * @params: Parameters for ACS
3379 * Returns 0 on success, -1 on failure
3381 * This command can be used to offload ACS to the driver if the driver
3382 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3384 int (*do_acs)(void *priv, struct drv_acs_params *params);
3389 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3391 enum wpa_event_type {
3393 * EVENT_ASSOC - Association completed
3395 * This event needs to be delivered when the driver completes IEEE
3396 * 802.11 association or reassociation successfully.
3397 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3398 * after this event has been generated. In addition, optional
3399 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3400 * more information about the association. If the driver interface gets
3401 * both of these events at the same time, it can also include the
3402 * assoc_info data in EVENT_ASSOC call.
3407 * EVENT_DISASSOC - Association lost
3409 * This event should be called when association is lost either due to
3410 * receiving deauthenticate or disassociate frame from the AP or when
3411 * sending either of these frames to the current AP. If the driver
3412 * supports separate deauthentication event, EVENT_DISASSOC should only
3413 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3414 * In AP mode, union wpa_event_data::disassoc_info is required.
3419 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3421 * This event must be delivered when a Michael MIC error is detected by
3422 * the local driver. Additional data for event processing is
3423 * provided with union wpa_event_data::michael_mic_failure. This
3424 * information is used to request new encyption key and to initiate
3425 * TKIP countermeasures if needed.
3427 EVENT_MICHAEL_MIC_FAILURE,
3430 * EVENT_SCAN_RESULTS - Scan results available
3432 * This event must be called whenever scan results are available to be
3433 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3434 * is expected to be used some time after struct wpa_driver_ops::scan()
3435 * is called. If the driver provides an unsolicited event when the scan
3436 * has been completed, this event can be used to trigger
3437 * EVENT_SCAN_RESULTS call. If such event is not available from the
3438 * driver, the driver wrapper code is expected to use a registered
3439 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3440 * scan is expected to be completed. Optional information about
3441 * completed scan can be provided with union wpa_event_data::scan_info.
3446 * EVENT_ASSOCINFO - Report optional extra information for association
3448 * This event can be used to report extra association information for
3449 * EVENT_ASSOC processing. This extra information includes IEs from
3450 * association frames and Beacon/Probe Response frames in union
3451 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3452 * EVENT_ASSOC. Alternatively, the driver interface can include
3453 * assoc_info data in the EVENT_ASSOC call if it has all the
3454 * information available at the same point.
3459 * EVENT_INTERFACE_STATUS - Report interface status changes
3461 * This optional event can be used to report changes in interface
3462 * status (interface added/removed) using union
3463 * wpa_event_data::interface_status. This can be used to trigger
3464 * wpa_supplicant to stop and re-start processing for the interface,
3465 * e.g., when a cardbus card is ejected/inserted.
3467 EVENT_INTERFACE_STATUS,
3470 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3472 * This event can be used to inform wpa_supplicant about candidates for
3473 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3474 * for scan request (ap_scan=2 mode), this event is required for
3475 * pre-authentication. If wpa_supplicant is performing scan request
3476 * (ap_scan=1), this event is optional since scan results can be used
3477 * to add pre-authentication candidates. union
3478 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3479 * candidate and priority of the candidate, e.g., based on the signal
3480 * strength, in order to try to pre-authenticate first with candidates
3481 * that are most likely targets for re-association.
3483 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3484 * on the candidate list. In addition, it can be called for the current
3485 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3486 * will automatically skip pre-authentication in cases where a valid
3487 * PMKSA exists. When more than one candidate exists, this event should
3488 * be generated once for each candidate.
3490 * Driver will be notified about successful pre-authentication with
3491 * struct wpa_driver_ops::add_pmkid() calls.
3493 EVENT_PMKID_CANDIDATE,
3496 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3498 * This event can be used to inform wpa_supplicant about desire to set
3499 * up secure direct link connection between two stations as defined in
3500 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3501 * STAKey negotiation. The caller will need to set peer address for the
3507 * EVENT_TDLS - Request TDLS operation
3509 * This event can be used to request a TDLS operation to be performed.
3514 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3516 * The driver is expected to report the received FT IEs from
3517 * FT authentication sequence from the AP. The FT IEs are included in
3518 * the extra information in union wpa_event_data::ft_ies.
3523 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3525 * The driver can use this event to inform wpa_supplicant about a STA
3526 * in an IBSS with which protected frames could be exchanged. This
3527 * event starts RSN authentication with the other STA to authenticate
3528 * the STA and set up encryption keys with it.
3530 EVENT_IBSS_RSN_START,
3533 * EVENT_AUTH - Authentication result
3535 * This event should be called when authentication attempt has been
3536 * completed. This is only used if the driver supports separate
3537 * authentication step (struct wpa_driver_ops::authenticate).
3538 * Information about authentication result is included in
3539 * union wpa_event_data::auth.
3544 * EVENT_DEAUTH - Authentication lost
3546 * This event should be called when authentication is lost either due
3547 * to receiving deauthenticate frame from the AP or when sending that
3548 * frame to the current AP.
3549 * In AP mode, union wpa_event_data::deauth_info is required.
3554 * EVENT_ASSOC_REJECT - Association rejected
3556 * This event should be called when (re)association attempt has been
3557 * rejected by the AP. Information about the association response is
3558 * included in union wpa_event_data::assoc_reject.
3563 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3565 EVENT_AUTH_TIMED_OUT,
3568 * EVENT_ASSOC_TIMED_OUT - Association timed out
3570 EVENT_ASSOC_TIMED_OUT,
3573 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3575 EVENT_WPS_BUTTON_PUSHED,
3578 * EVENT_TX_STATUS - Report TX status
3583 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3585 EVENT_RX_FROM_UNKNOWN,
3588 * EVENT_RX_MGMT - Report RX of a management frame
3593 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3595 * This event is used to indicate when the driver has started the
3596 * requested remain-on-channel duration. Information about the
3597 * operation is included in union wpa_event_data::remain_on_channel.
3599 EVENT_REMAIN_ON_CHANNEL,
3602 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3604 * This event is used to indicate when the driver has completed
3605 * remain-on-channel duration, i.e., may noot be available on the
3606 * requested channel anymore. Information about the
3607 * operation is included in union wpa_event_data::remain_on_channel.
3609 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3612 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3614 * This event is used to indicate when a Probe Request frame has been
3615 * received. Information about the received frame is included in
3616 * union wpa_event_data::rx_probe_req. The driver is required to report
3617 * these events only after successfully completed probe_req_report()
3618 * commands to request the events (i.e., report parameter is non-zero)
3619 * in station mode. In AP mode, Probe Request frames should always be
3625 * EVENT_NEW_STA - New wired device noticed
3627 * This event is used to indicate that a new device has been detected
3628 * in a network that does not use association-like functionality (i.e.,
3629 * mainly wired Ethernet). This can be used to start EAPOL
3630 * authenticator when receiving a frame from a device. The address of
3631 * the device is included in union wpa_event_data::new_sta.
3636 * EVENT_EAPOL_RX - Report received EAPOL frame
3638 * When in AP mode with hostapd, this event is required to be used to
3639 * deliver the receive EAPOL frames from the driver.
3644 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3646 * This event is used to indicate changes in the signal strength
3647 * observed in frames received from the current AP if signal strength
3648 * monitoring has been enabled with signal_monitor().
3650 EVENT_SIGNAL_CHANGE,
3653 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3655 * This event is used to indicate that the interface was enabled after
3656 * having been previously disabled, e.g., due to rfkill.
3658 EVENT_INTERFACE_ENABLED,
3661 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3663 * This event is used to indicate that the interface was disabled,
3664 * e.g., due to rfkill.
3666 EVENT_INTERFACE_DISABLED,
3669 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3671 * This event is used to indicate that the channel list has changed,
3672 * e.g., because of a regulatory domain change triggered by scan
3673 * results including an AP advertising a country code.
3675 EVENT_CHANNEL_LIST_CHANGED,
3678 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3680 * This event is used to indicate that the driver cannot maintain this
3681 * interface in its operation mode anymore. The most likely use for
3682 * this is to indicate that AP mode operation is not available due to
3683 * operating channel would need to be changed to a DFS channel when
3684 * the driver does not support radar detection and another virtual
3685 * interfaces caused the operating channel to change. Other similar
3686 * resource conflicts could also trigger this for station mode
3687 * interfaces. This event can be propagated when channel switching
3690 EVENT_INTERFACE_UNAVAILABLE,
3693 * EVENT_BEST_CHANNEL
3695 * Driver generates this event whenever it detects a better channel
3696 * (e.g., based on RSSI or channel use). This information can be used
3697 * to improve channel selection for a new AP/P2P group.
3702 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3704 * This event should be called when a Deauthentication frame is dropped
3705 * due to it not being protected (MFP/IEEE 802.11w).
3706 * union wpa_event_data::unprot_deauth is required to provide more
3707 * details of the frame.
3709 EVENT_UNPROT_DEAUTH,
3712 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3714 * This event should be called when a Disassociation frame is dropped
3715 * due to it not being protected (MFP/IEEE 802.11w).
3716 * union wpa_event_data::unprot_disassoc is required to provide more
3717 * details of the frame.
3719 EVENT_UNPROT_DISASSOC,
3722 * EVENT_STATION_LOW_ACK
3724 * Driver generates this event whenever it detected that a particular
3725 * station was lost. Detection can be through massive transmission
3726 * failures for example.
3728 EVENT_STATION_LOW_ACK,
3731 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3733 EVENT_IBSS_PEER_LOST,
3736 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3738 * This event carries the new replay counter to notify wpa_supplicant
3739 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3740 * completed Group Key Handshake while the host (including
3741 * wpa_supplicant was sleeping).
3743 EVENT_DRIVER_GTK_REKEY,
3746 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3748 EVENT_SCHED_SCAN_STOPPED,
3751 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3753 * This event indicates that the station responded to the poll
3754 * initiated with @poll_client.
3756 EVENT_DRIVER_CLIENT_POLL_OK,
3759 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3761 EVENT_EAPOL_TX_STATUS,
3764 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3766 * Described in wpa_event_data.ch_switch
3771 * EVENT_WNM - Request WNM operation
3773 * This event can be used to request a WNM operation to be performed.
3778 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3780 * This event indicates that the driver reported a connection failure
3781 * with the specified client (for example, max client reached, etc.) in
3784 EVENT_CONNECT_FAILED_REASON,
3787 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
3789 * A radar has been detected on the supplied frequency, hostapd should
3790 * react accordingly (e.g., change channel).
3792 EVENT_DFS_RADAR_DETECTED,
3795 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
3797 * After a successful CAC, the channel can be marked clear and used.
3799 EVENT_DFS_CAC_FINISHED,
3802 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
3804 * The CAC was not successful, and the channel remains in the previous
3805 * state. This may happen due to a radar beeing detected or other
3806 * external influences.
3808 EVENT_DFS_CAC_ABORTED,
3811 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
3813 * The channel which was previously unavailable is now available again.
3815 EVENT_DFS_NOP_FINISHED,
3818 * EVENT_SURVEY - Received survey data
3820 * This event gets triggered when a driver query is issued for survey
3821 * data and the requested data becomes available. The returned data is
3822 * stored in struct survey_results. The results provide at most one
3823 * survey entry for each frequency and at minimum will provide one
3824 * survey entry for one frequency. The survey data can be os_malloc()'d
3825 * and then os_free()'d, so the event callback must only copy data.
3830 * EVENT_SCAN_STARTED - Scan started
3832 * This indicates that driver has started a scan operation either based
3833 * on a request from wpa_supplicant/hostapd or from another application.
3834 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3835 * completed (either successfully or by getting cancelled).
3840 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3842 * This event indicates a set of frequency ranges that should be avoided
3843 * to reduce issues due to interference or internal co-existence
3844 * information in the driver.
3846 EVENT_AVOID_FREQUENCIES,
3849 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3851 EVENT_NEW_PEER_CANDIDATE,
3854 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
3856 * Indicates a pair of primary and secondary channels chosen by ACS
3859 EVENT_ACS_CHANNEL_SELECTED,
3862 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
3865 * This event indicates that channel availability check has been started
3866 * on a DFS frequency by a driver that supports DFS Offload.
3868 EVENT_DFS_CAC_STARTED,
3873 * struct freq_survey - Channel survey info
3875 * @ifidx: Interface index in which this survey was observed
3876 * @freq: Center of frequency of the surveyed channel
3877 * @nf: Channel noise floor in dBm
3878 * @channel_time: Amount of time in ms the radio spent on the channel
3879 * @channel_time_busy: Amount of time in ms the radio detected some signal
3880 * that indicated to the radio the channel was not clear
3881 * @channel_time_rx: Amount of time the radio spent receiving data
3882 * @channel_time_tx: Amount of time the radio spent transmitting data
3883 * @filled: bitmask indicating which fields have been reported, see
3884 * SURVEY_HAS_* defines.
3885 * @list: Internal list pointers
3887 struct freq_survey {
3892 u64 channel_time_busy;
3893 u64 channel_time_rx;
3894 u64 channel_time_tx;
3895 unsigned int filled;
3896 struct dl_list list;
3899 #define SURVEY_HAS_NF BIT(0)
3900 #define SURVEY_HAS_CHAN_TIME BIT(1)
3901 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3902 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3903 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3907 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3909 union wpa_event_data {
3911 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3913 * This structure is optional for EVENT_ASSOC calls and required for
3914 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3915 * driver interface does not need to generate separate EVENT_ASSOCINFO
3920 * reassoc - Flag to indicate association or reassociation
3925 * req_ies - (Re)Association Request IEs
3927 * If the driver generates WPA/RSN IE, this event data must be
3928 * returned for WPA handshake to have needed information. If
3929 * wpa_supplicant-generated WPA/RSN IE is used, this
3930 * information event is optional.
3932 * This should start with the first IE (fixed fields before IEs
3933 * are not included).
3938 * req_ies_len - Length of req_ies in bytes
3943 * resp_ies - (Re)Association Response IEs
3945 * Optional association data from the driver. This data is not
3946 * required WPA, but may be useful for some protocols and as
3947 * such, should be reported if this is available to the driver
3950 * This should start with the first IE (fixed fields before IEs
3951 * are not included).
3956 * resp_ies_len - Length of resp_ies in bytes
3958 size_t resp_ies_len;
3961 * beacon_ies - Beacon or Probe Response IEs
3963 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3964 * Probe Response frames from the current AP (i.e., the one
3965 * that the client just associated with). This information is
3966 * used to update WPA/RSN IE for the AP. If this field is not
3967 * set, the results from previous scan will be used. If no
3968 * data for the new AP is found, scan results will be requested
3969 * again (without scan request). At this point, the driver is
3970 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3973 * This should start with the first IE (fixed fields before IEs
3974 * are not included).
3976 const u8 *beacon_ies;
3979 * beacon_ies_len - Length of beacon_ies */
3980 size_t beacon_ies_len;
3983 * freq - Frequency of the operational channel in MHz
3988 * wmm_params - WMM parameters used in this association.
3990 struct wmm_params wmm_params;
3993 * addr - Station address (for AP mode)
3998 * The following is the key management offload information
4001 * @key_replay_ctr_len
4009 * authorized - Status of key management offload,
4015 * key_replay_ctr - Key replay counter value last used
4016 * in a valid EAPOL-Key frame
4018 const u8 *key_replay_ctr;
4021 * key_replay_ctr_len - The length of key_replay_ctr
4023 size_t key_replay_ctr_len;
4026 * ptk_kck - The derived PTK KCK
4031 * ptk_kek_len - The length of ptk_kck
4036 * ptk_kek - The derived PTK KEK
4041 * ptk_kek_len - The length of ptk_kek
4047 * struct disassoc_info - Data for EVENT_DISASSOC events
4049 struct disassoc_info {
4051 * addr - Station address (for AP mode)
4056 * reason_code - Reason Code (host byte order) used in
4057 * Deauthentication frame
4062 * ie - Optional IE(s) in Disassociation frame
4067 * ie_len - Length of ie buffer in octets
4072 * locally_generated - Whether the frame was locally generated
4074 int locally_generated;
4078 * struct deauth_info - Data for EVENT_DEAUTH events
4080 struct deauth_info {
4082 * addr - Station address (for AP mode)
4087 * reason_code - Reason Code (host byte order) used in
4088 * Deauthentication frame
4093 * ie - Optional IE(s) in Deauthentication frame
4098 * ie_len - Length of ie buffer in octets
4103 * locally_generated - Whether the frame was locally generated
4105 int locally_generated;
4109 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4111 struct michael_mic_failure {
4114 } michael_mic_failure;
4117 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4119 struct interface_status {
4122 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4127 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4129 struct pmkid_candidate {
4130 /** BSSID of the PMKID candidate */
4132 /** Smaller the index, higher the priority */
4134 /** Whether RSN IE includes pre-authenticate flag */
4139 * struct stkstart - Data for EVENT_STKSTART
4146 * struct tdls - Data for EVENT_TDLS
4152 TDLS_REQUEST_TEARDOWN,
4153 TDLS_REQUEST_DISCOVER,
4155 u16 reason_code; /* for teardown */
4159 * struct wnm - Data for EVENT_WNM
4177 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4179 * During FT (IEEE 802.11r) authentication sequence, the driver is
4180 * expected to use this event to report received FT IEs (MDIE, FTIE,
4181 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4182 * IEs for the next message will be delivered through the
4183 * struct wpa_driver_ops::update_ft_ies() callback.
4189 u8 target_ap[ETH_ALEN];
4190 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4192 /** Length of ric_ies buffer in octets */
4197 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4199 struct ibss_rsn_start {
4204 * struct auth_info - Data for EVENT_AUTH events
4210 u16 auth_transaction;
4217 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4219 struct assoc_reject {
4221 * bssid - BSSID of the AP that rejected association
4226 * resp_ies - (Re)Association Response IEs
4228 * Optional association data from the driver. This data is not
4229 * required WPA, but may be useful for some protocols and as
4230 * such, should be reported if this is available to the driver
4233 * This should start with the first IE (fixed fields before IEs
4234 * are not included).
4239 * resp_ies_len - Length of resp_ies in bytes
4241 size_t resp_ies_len;
4244 * status_code - Status Code from (Re)association Response
4249 struct timeout_event {
4254 * struct tx_status - Data for EVENT_TX_STATUS events
4266 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4268 struct rx_from_unknown {
4275 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4283 * drv_priv - Pointer to store driver private BSS information
4285 * If not set to NULL, this is used for comparison with
4286 * hostapd_data->drv_priv to determine which BSS should process
4292 * freq - Frequency (in MHz) on which the frame was received
4297 * ssi_signal - Signal strength in dBm (or 0 if not available)
4303 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4305 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4307 struct remain_on_channel {
4309 * freq - Channel frequency in MHz
4314 * duration - Duration to remain on the channel in milliseconds
4316 unsigned int duration;
4317 } remain_on_channel;
4320 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4321 * @aborted: Whether the scan was aborted
4322 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4323 * @num_freqs: Number of entries in freqs array
4324 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4326 * @num_ssids: Number of entries in ssids array
4332 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4337 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4339 struct rx_probe_req {
4341 * sa - Source address of the received Probe Request frame
4346 * da - Destination address of the received Probe Request frame
4347 * or %NULL if not available
4352 * bssid - BSSID of the received Probe Request frame or %NULL
4358 * ie - IEs from the Probe Request body
4363 * ie_len - Length of ie buffer in octets
4368 * signal - signal strength in dBm (or 0 if not available)
4374 * struct new_sta - Data for EVENT_NEW_STA events
4381 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4390 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4392 struct wpa_signal_info signal_change;
4395 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4396 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4397 * @freq_5: Best 5 GHz band channel frequency in MHz
4398 * @freq_overall: Best channel frequency in MHz
4400 * 0 can be used to indicate no preference in either band.
4402 struct best_channel {
4408 struct unprot_deauth {
4414 struct unprot_disassoc {
4421 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4422 * @addr: station address
4429 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4431 struct ibss_peer_lost {
4436 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4438 struct driver_gtk_rekey {
4440 const u8 *replay_ctr;
4444 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4445 * @addr: station address
4447 struct client_poll {
4452 * struct eapol_tx_status
4453 * @dst: Original destination
4454 * @data: Data starting with IEEE 802.1X header (!)
4455 * @data_len: Length of data
4456 * @ack: Indicates ack or lost frame
4458 * This corresponds to hapd_send_eapol if the frame sent
4459 * there isn't just reported as EVENT_TX_STATUS.
4461 struct eapol_tx_status {
4470 * @freq: Frequency of new channel in MHz
4471 * @ht_enabled: Whether this is an HT channel
4472 * @ch_offset: Secondary channel offset
4473 * @ch_width: Channel width
4474 * @cf1: Center frequency 1
4475 * @cf2: Center frequency 2
4481 enum chan_width ch_width;
4487 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4488 * @addr: Remote client address
4489 * @code: Reason code for connection failure
4491 struct connect_failed_reason {
4497 } connect_failed_reason;
4500 * struct dfs_event - Data for radar detected events
4501 * @freq: Frequency of the channel in MHz
4507 enum chan_width chan_width;
4513 * survey_results - Survey result data for EVENT_SURVEY
4514 * @freq_filter: Requested frequency survey filter, 0 if request
4515 * was for all survey data
4516 * @survey_list: Linked list of survey data (struct freq_survey)
4518 struct survey_results {
4519 unsigned int freq_filter;
4520 struct dl_list survey_list; /* struct freq_survey */
4524 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4525 * @initiator: Initiator of the regulatory change
4526 * @type: Regulatory change type
4527 * @alpha2: Country code (or "" if not available)
4529 struct channel_list_changed {
4530 enum reg_change_initiator initiator;
4533 } channel_list_changed;
4536 * freq_range - List of frequency ranges
4538 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4540 struct wpa_freq_range_list freq_range;
4545 * @peer: Peer address
4547 * @ie_len: Length of @ies
4549 * Notification of new candidate mesh peer.
4558 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4559 * @pri_channel: Selected primary channel
4560 * @sec_channel: Selected secondary channel
4561 * @vht_seg0_center_ch: VHT mode Segment0 center channel
4562 * @vht_seg1_center_ch: VHT mode Segment1 center channel
4563 * @ch_width: Selected Channel width by driver. Driver may choose to
4564 * change hostapd configured ACS channel width due driver internal
4565 * channel restrictions.
4567 struct acs_selected_channels {
4570 u8 vht_seg0_center_ch;
4571 u8 vht_seg1_center_ch;
4573 } acs_selected_channels;
4577 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4578 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4579 * with struct wpa_driver_ops::init()
4580 * @event: event type (defined above)
4581 * @data: possible extra data for the event
4583 * Driver wrapper code should call this function whenever an event is received
4586 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4587 union wpa_event_data *data);
4591 * The following inline functions are provided for convenience to simplify
4592 * event indication for some of the common events.
4595 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4596 size_t ielen, int reassoc)
4598 union wpa_event_data event;
4599 os_memset(&event, 0, sizeof(event));
4600 event.assoc_info.reassoc = reassoc;
4601 event.assoc_info.req_ies = ie;
4602 event.assoc_info.req_ies_len = ielen;
4603 event.assoc_info.addr = addr;
4604 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4607 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4609 union wpa_event_data event;
4610 os_memset(&event, 0, sizeof(event));
4611 event.disassoc_info.addr = addr;
4612 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4615 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4618 union wpa_event_data event;
4619 os_memset(&event, 0, sizeof(event));
4620 event.eapol_rx.src = src;
4621 event.eapol_rx.data = data;
4622 event.eapol_rx.data_len = data_len;
4623 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4626 /* driver_common.c */
4627 void wpa_scan_results_free(struct wpa_scan_results *res);
4629 /* Convert wpa_event_type to a string for logging */
4630 const char * event_to_string(enum wpa_event_type event);
4632 /* Convert chan_width to a string for logging and control interfaces */
4633 const char * channel_width_to_string(enum chan_width width);
4635 int ht_supported(const struct hostapd_hw_modes *mode);
4636 int vht_supported(const struct hostapd_hw_modes *mode);
4638 struct wowlan_triggers *
4639 wpa_get_wowlan_triggers(const char *wowlan_triggers,
4640 const struct wpa_driver_capa *capa);
4642 /* NULL terminated array of linked in driver wrappers */
4643 extern const struct wpa_driver_ops *const wpa_drivers[];
4645 #endif /* DRIVER_H */