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 "utils/list.h"
25 #define HOSTAPD_CHAN_DISABLED 0x00000001
26 #define HOSTAPD_CHAN_NO_IR 0x00000002
27 #define HOSTAPD_CHAN_RADAR 0x00000008
28 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
29 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
30 #define HOSTAPD_CHAN_HT40 0x00000040
31 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
33 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
34 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
35 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
36 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
37 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
39 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
40 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
41 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
42 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
44 #define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
45 #define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
48 * enum reg_change_initiator - Regulatory change initiator
50 enum reg_change_initiator {
54 REGDOM_SET_BY_COUNTRY_IE,
59 * enum reg_type - Regulatory change types
65 REGDOM_TYPE_CUSTOM_WORLD,
66 REGDOM_TYPE_INTERSECTION,
70 * struct hostapd_channel_data - Channel information
72 struct hostapd_channel_data {
74 * chan - Channel number (IEEE 802.11)
79 * freq - Frequency in MHz
84 * flag - Channel flags (HOSTAPD_CHAN_*)
89 * max_tx_power - Regulatory transmit power limit in dBm
94 * survey_list - Linked list of surveys (struct freq_survey)
96 struct dl_list survey_list;
99 * min_nf - Minimum observed noise floor, in dBm, based on all
100 * surveyed channel data
106 * interference_factor - Computed interference factor on this
107 * channel (used internally in src/ap/acs.c; driver wrappers do not
110 long double interference_factor;
111 #endif /* CONFIG_ACS */
114 * dfs_cac_ms - DFS CAC time in milliseconds
116 unsigned int dfs_cac_ms;
119 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
120 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
123 * struct hostapd_hw_modes - Supported hardware mode information
125 struct hostapd_hw_modes {
127 * mode - Hardware mode
129 enum hostapd_hw_mode mode;
132 * num_channels - Number of entries in the channels array
137 * channels - Array of supported channels
139 struct hostapd_channel_data *channels;
142 * num_rates - Number of entries in the rates array
147 * rates - Array of supported rates in 100 kbps units
152 * ht_capab - HT (IEEE 802.11n) capabilities
157 * mcs_set - MCS (IEEE 802.11n) rate parameters
162 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
167 * vht_capab - VHT (IEEE 802.11ac) capabilities
172 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
176 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
180 #define IEEE80211_MODE_INFRA 0
181 #define IEEE80211_MODE_IBSS 1
182 #define IEEE80211_MODE_AP 2
183 #define IEEE80211_MODE_MESH 5
185 #define IEEE80211_CAP_ESS 0x0001
186 #define IEEE80211_CAP_IBSS 0x0002
187 #define IEEE80211_CAP_PRIVACY 0x0010
188 #define IEEE80211_CAP_RRM 0x1000
190 /* DMG (60 GHz) IEEE 802.11ad */
191 /* type - bits 0..1 */
192 #define IEEE80211_CAP_DMG_MASK 0x0003
193 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
194 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
195 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
197 #define WPA_SCAN_QUAL_INVALID BIT(0)
198 #define WPA_SCAN_NOISE_INVALID BIT(1)
199 #define WPA_SCAN_LEVEL_INVALID BIT(2)
200 #define WPA_SCAN_LEVEL_DBM BIT(3)
201 #define WPA_SCAN_ASSOCIATED BIT(5)
204 * struct wpa_scan_res - Scan result for an BSS/IBSS
205 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
207 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
208 * @beacon_int: beacon interval in TUs (host byte order)
209 * @caps: capability information field in host byte order
210 * @qual: signal quality
211 * @noise: noise level
212 * @level: signal level
214 * @age: Age of the information in milliseconds (i.e., how many milliseconds
215 * ago the last Beacon or Probe Response frame was received)
216 * @est_throughput: Estimated throughput in kbps (this is calculated during
217 * scan result processing if left zero by the driver wrapper)
218 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
219 * @ie_len: length of the following IE field in octets
220 * @beacon_ie_len: length of the following Beacon IE field in octets
222 * This structure is used as a generic format for scan results from the
223 * driver. Each driver interface implementation is responsible for converting
224 * the driver or OS specific scan results into this format.
226 * If the driver does not support reporting all IEs, the IE data structure is
227 * constructed of the IEs that are available. This field will also need to
228 * include SSID in IE format. All drivers are encouraged to be extended to
229 * report all IEs to make it easier to support future additions.
231 * This structure data is followed by ie_len octets of IEs from Probe Response
232 * frame (or if the driver does not indicate source of IEs, these may also be
233 * from Beacon frame). After the first set of IEs, another set of IEs may follow
234 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
236 struct wpa_scan_res {
247 unsigned int est_throughput;
250 size_t beacon_ie_len;
251 /* Followed by ie_len + beacon_ie_len octets of IE data */
255 * struct wpa_scan_results - Scan results
256 * @res: Array of pointers to allocated variable length scan result entries
257 * @num: Number of entries in the scan result array
258 * @fetch_time: Time when the results were fetched from the driver
260 struct wpa_scan_results {
261 struct wpa_scan_res **res;
263 struct os_reltime fetch_time;
267 * struct wpa_interface_info - Network interface information
268 * @next: Pointer to the next interface or NULL if this is the last one
269 * @ifname: Interface name that can be used with init() or init2()
270 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
272 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
273 * is not an allocated copy, i.e., get_interfaces() caller will not free
276 struct wpa_interface_info {
277 struct wpa_interface_info *next;
280 const char *drv_name;
283 #define WPAS_MAX_SCAN_SSIDS 16
286 * struct wpa_driver_scan_params - Scan parameters
287 * Data for struct wpa_driver_ops::scan2().
289 struct wpa_driver_scan_params {
291 * ssids - SSIDs to scan for
293 struct wpa_driver_scan_ssid {
295 * ssid - specific SSID to scan for (ProbeReq)
296 * %NULL or zero-length SSID is used to indicate active scan
297 * with wildcard SSID.
301 * ssid_len: Length of the SSID in octets
304 } ssids[WPAS_MAX_SCAN_SSIDS];
307 * num_ssids - Number of entries in ssids array
308 * Zero indicates a request for a passive scan.
313 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
318 * extra_ies_len - Length of extra_ies in octets
320 size_t extra_ies_len;
323 * freqs - Array of frequencies to scan or %NULL for all frequencies
325 * The frequency is set in MHz. The array is zero-terminated.
330 * filter_ssids - Filter for reporting SSIDs
332 * This optional parameter can be used to request the driver wrapper to
333 * filter scan results to include only the specified SSIDs. %NULL
334 * indicates that no filtering is to be done. This can be used to
335 * reduce memory needs for scan results in environments that have large
336 * number of APs with different SSIDs.
338 * The driver wrapper is allowed to take this allocated buffer into its
339 * own use by setting the pointer to %NULL. In that case, the driver
340 * wrapper is responsible for freeing the buffer with os_free() once it
341 * is not needed anymore.
343 struct wpa_driver_scan_filter {
349 * num_filter_ssids - Number of entries in filter_ssids array
351 size_t num_filter_ssids;
354 * filter_rssi - Filter by RSSI
356 * The driver may filter scan results in firmware to reduce host
357 * wakeups and thereby save power. Specify the RSSI threshold in s32
363 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
365 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
366 * Mbps from the support rates element(s) in the Probe Request frames
367 * and not to transmit the frames at any of those rates.
369 unsigned int p2p_probe:1;
372 * only_new_results - Request driver to report only new results
374 * This is used to request the driver to report only BSSes that have
375 * been detected after this scan request has been started, i.e., to
376 * flush old cached BSS entries.
378 unsigned int only_new_results:1;
381 * low_priority - Requests driver to use a lower scan priority
383 * This is used to request the driver to use a lower scan priority
384 * if it supports such a thing.
386 unsigned int low_priority:1;
389 * mac_addr_rand - Requests driver to randomize MAC address
391 unsigned int mac_addr_rand:1;
394 * mac_addr - MAC address used with randomization. The address cannot be
395 * a multicast one, i.e., bit 0 of byte 0 should not be set.
400 * mac_addr_mask - MAC address mask used with randomization.
402 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
403 * the mask should be taken as is from mac_addr. The mask should not
404 * allow the generation of a multicast address, i.e., bit 0 of byte 0
407 const u8 *mac_addr_mask;
410 * NOTE: Whenever adding new parameters here, please make sure
411 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
417 * struct wpa_driver_auth_params - Authentication parameters
418 * Data for struct wpa_driver_ops::authenticate().
420 struct wpa_driver_auth_params {
428 const u8 *wep_key[4];
429 size_t wep_key_len[4];
431 int local_state_change;
434 * p2p - Whether this connection is a P2P group
439 * sae_data - SAE elements for Authentication frame
441 * This buffer starts with the Authentication transaction sequence
442 * number field. If SAE is not used, this pointer is %NULL.
447 * sae_data_len - Length of sae_data buffer in octets
453 * enum wps_mode - WPS mode
457 * WPS_MODE_NONE - No WPS provisioning being used
462 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
467 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
473 * struct hostapd_freq_params - Channel parameters
475 struct hostapd_freq_params {
477 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
479 enum hostapd_hw_mode mode;
482 * freq - Primary channel center frequency in MHz
487 * channel - Channel number
492 * ht_enabled - Whether HT is enabled
497 * sec_channel_offset - Secondary channel offset for HT40
500 * -1 = HT40 enabled, secondary channel below primary,
501 * 1 = HT40 enabled, secondary channel above primary
503 int sec_channel_offset;
506 * vht_enabled - Whether VHT is enabled
511 * center_freq1 - Segment 0 center frequency in MHz
513 * Valid for both HT and VHT.
518 * center_freq2 - Segment 1 center frequency in MHz
520 * Non-zero only for bandwidth 80 and an 80+80 channel
525 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
531 * struct wpa_driver_associate_params - Association parameters
532 * Data for struct wpa_driver_ops::associate().
534 struct wpa_driver_associate_params {
536 * bssid - BSSID of the selected AP
537 * This can be %NULL, if ap_scan=2 mode is used and the driver is
538 * responsible for selecting with which BSS to associate. */
542 * bssid_hint - BSSID of a proposed AP
544 * This indicates which BSS has been found a suitable candidate for
545 * initial association for drivers that use driver/firmwate-based BSS
546 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
547 * the driver from selecting other BSSes in the ESS.
549 const u8 *bssid_hint;
552 * ssid - The selected SSID
557 * ssid_len - Length of the SSID (1..32)
562 * freq - channel parameters
564 struct hostapd_freq_params freq;
567 * freq_hint - Frequency of the channel the proposed AP is using
569 * This provides a channel on which a suitable BSS has been found as a
570 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
571 * limit the driver from selecting other channels for
572 * driver/firmware-based BSS selection.
577 * bg_scan_period - Background scan period in seconds, 0 to disable
578 * background scan, or -1 to indicate no change to default driver
584 * beacon_int - Beacon interval for IBSS or 0 to use driver default
589 * wpa_ie - WPA information element for (Re)Association Request
590 * WPA information element to be included in (Re)Association
591 * Request (including information element id and length). Use
592 * of this WPA IE is optional. If the driver generates the WPA
593 * IE, it can use pairwise_suite, group_suite, and
594 * key_mgmt_suite to select proper algorithms. In this case,
595 * the driver has to notify wpa_supplicant about the used WPA
596 * IE by generating an event that the interface code will
597 * convert into EVENT_ASSOCINFO data (see below).
599 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
600 * instead. The driver can determine which version is used by
601 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
604 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
609 * wpa_ie_len - length of the wpa_ie
614 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
616 unsigned int wpa_proto;
619 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
621 * This is usually ignored if @wpa_ie is used.
623 unsigned int pairwise_suite;
626 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
628 * This is usually ignored if @wpa_ie is used.
630 unsigned int group_suite;
633 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
635 * This is usually ignored if @wpa_ie is used.
637 unsigned int key_mgmt_suite;
640 * auth_alg - Allowed authentication algorithms
641 * Bit field of WPA_AUTH_ALG_*
646 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
651 * wep_key - WEP keys for static WEP configuration
653 const u8 *wep_key[4];
656 * wep_key_len - WEP key length for static WEP configuration
658 size_t wep_key_len[4];
661 * wep_tx_keyidx - WEP TX key index for static WEP configuration
666 * mgmt_frame_protection - IEEE 802.11w management frame protection
668 enum mfp_options mgmt_frame_protection;
671 * ft_ies - IEEE 802.11r / FT information elements
672 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
673 * for fast transition, this parameter is set to include the IEs that
674 * are to be sent in the next FT Authentication Request message.
675 * update_ft_ies() handler is called to update the IEs for further
676 * FT messages in the sequence.
678 * The driver should use these IEs only if the target AP is advertising
679 * the same mobility domain as the one included in the MDIE here.
681 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
682 * AP after the initial association. These IEs can only be used if the
683 * target AP is advertising support for FT and is using the same MDIE
684 * and SSID as the current AP.
686 * The driver is responsible for reporting the FT IEs received from the
687 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
688 * type. update_ft_ies() handler will then be called with the FT IEs to
689 * include in the next frame in the authentication sequence.
694 * ft_ies_len - Length of ft_ies in bytes
699 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
701 * This value is provided to allow the driver interface easier access
702 * to the current mobility domain. This value is set to %NULL if no
703 * mobility domain is currently active.
708 * passphrase - RSN passphrase for PSK
710 * This value is made available only for WPA/WPA2-Personal (PSK) and
711 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
712 * the 8..63 character ASCII passphrase, if available. Please note that
713 * this can be %NULL if passphrase was not used to generate the PSK. In
714 * that case, the psk field must be used to fetch the PSK.
716 const char *passphrase;
719 * psk - RSN PSK (alternative for passphrase for PSK)
721 * This value is made available only for WPA/WPA2-Personal (PSK) and
722 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
723 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
724 * be prepared to handle %NULL value as an error.
729 * drop_unencrypted - Enable/disable unencrypted frame filtering
731 * Configure the driver to drop all non-EAPOL frames (both receive and
732 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
733 * still be allowed for key negotiation.
735 int drop_unencrypted;
738 * prev_bssid - Previously used BSSID in this ESS
740 * When not %NULL, this is a request to use reassociation instead of
743 const u8 *prev_bssid;
748 * If the driver needs to do special configuration for WPS association,
749 * this variable provides more information on what type of association
750 * is being requested. Most drivers should not need ot use this.
755 * p2p - Whether this connection is a P2P group
760 * uapsd - UAPSD parameters for the network
761 * -1 = do not change defaults
762 * AP mode: 1 = enabled, 0 = disabled
763 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
768 * fixed_bssid - Whether to force this BSSID in IBSS mode
769 * 1 = Fix this BSSID and prevent merges.
770 * 0 = Do not fix BSSID.
775 * fixed_freq - Fix control channel in IBSS mode
776 * 0 = don't fix control channel (default)
777 * 1 = fix control channel; this prevents IBSS merging with another
783 * disable_ht - Disable HT (IEEE 802.11n) for this connection
788 * htcaps - HT Capabilities over-rides
790 * Only bits set in the mask will be used, and not all values are used
791 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
793 * Pointer to struct ieee80211_ht_capabilities.
798 * htcaps_mask - HT Capabilities over-rides mask
800 * Pointer to struct ieee80211_ht_capabilities.
802 const u8 *htcaps_mask;
804 #ifdef CONFIG_VHT_OVERRIDES
806 * disable_vht - Disable VHT for this connection
811 * VHT capability overrides.
813 const struct ieee80211_vht_capabilities *vhtcaps;
814 const struct ieee80211_vht_capabilities *vhtcaps_mask;
815 #endif /* CONFIG_VHT_OVERRIDES */
818 * req_key_mgmt_offload - Request key management offload for connection
820 * Request key management offload for this connection if the device
823 int req_key_mgmt_offload;
826 * Flag for indicating whether this association includes support for
827 * RRM (Radio Resource Measurements)
834 HIDDEN_SSID_ZERO_LEN,
835 HIDDEN_SSID_ZERO_CONTENTS
838 struct wowlan_triggers {
842 u8 gtk_rekey_failure;
844 u8 four_way_handshake;
848 struct wpa_driver_ap_params {
850 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
855 * head_len - Length of the head buffer in octets
860 * tail - Beacon tail following TIM IE
865 * tail_len - Length of the tail buffer in octets
870 * dtim_period - DTIM period
875 * beacon_int - Beacon interval
880 * basic_rates: -1 terminated array of basic rates in 100 kbps
882 * This parameter can be used to set a specific basic rate set for the
883 * BSS. If %NULL, default basic rate set is used.
888 * proberesp - Probe Response template
890 * This is used by drivers that reply to Probe Requests internally in
891 * AP mode and require the full Probe Response template.
896 * proberesp_len - Length of the proberesp buffer in octets
898 size_t proberesp_len;
901 * ssid - The SSID to use in Beacon/Probe Response frames
906 * ssid_len - Length of the SSID (1..32)
911 * hide_ssid - Whether to hide the SSID
913 enum hide_ssid hide_ssid;
916 * pairwise_ciphers - WPA_CIPHER_* bitfield
918 unsigned int pairwise_ciphers;
921 * group_cipher - WPA_CIPHER_*
923 unsigned int group_cipher;
926 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
928 unsigned int key_mgmt_suites;
931 * auth_algs - WPA_AUTH_ALG_* bitfield
933 unsigned int auth_algs;
936 * wpa_version - WPA_PROTO_* bitfield
938 unsigned int wpa_version;
941 * privacy - Whether privacy is used in the BSS
946 * beacon_ies - WPS/P2P IE(s) for Beacon frames
948 * This is used to add IEs like WPS IE and P2P IE by drivers that do
949 * not use the full Beacon template.
951 const struct wpabuf *beacon_ies;
954 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
956 * This is used to add IEs like WPS IE and P2P IE by drivers that
957 * reply to Probe Request frames internally.
959 const struct wpabuf *proberesp_ies;
962 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
964 * This is used to add IEs like WPS IE by drivers that reply to
965 * (Re)Association Request frames internally.
967 const struct wpabuf *assocresp_ies;
970 * isolate - Whether to isolate frames between associated stations
972 * If this is non-zero, the AP is requested to disable forwarding of
973 * frames between associated stations.
978 * cts_protect - Whether CTS protection is enabled
983 * preamble - Whether short preamble is enabled
988 * short_slot_time - Whether short slot time is enabled
990 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
991 * not set (e.g., when 802.11g mode is not in use)
996 * ht_opmode - HT operation mode or -1 if HT not in use
1001 * interworking - Whether Interworking is enabled
1006 * hessid - Homogeneous ESS identifier or %NULL if not set
1011 * access_network_type - Access Network Type (0..15)
1013 * This is used for filtering Probe Request frames when Interworking is
1016 u8 access_network_type;
1019 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1021 * This is used by driver which advertises this capability.
1023 int ap_max_inactivity;
1026 * ctwindow - Client Traffic Window (in TUs)
1031 * smps_mode - SMPS mode
1033 * SMPS mode to be used by the AP, specified as the relevant bits of
1034 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1036 unsigned int smps_mode;
1039 * disable_dgaf - Whether group-addressed frames are disabled
1044 * osen - Whether OSEN security is enabled
1049 * freq - Channel parameters for dynamic bandwidth changes
1051 struct hostapd_freq_params *freq;
1054 * reenable - Whether this is to re-enable beaconing
1059 struct wpa_driver_mesh_bss_params {
1060 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1062 * TODO: Other mesh configuration parameters would go here.
1063 * See NL80211_MESHCONF_* for all the mesh config parameters.
1066 int peer_link_timeout;
1069 struct wpa_driver_mesh_join_params {
1072 const int *basic_rates;
1075 struct hostapd_freq_params freq;
1078 struct wpa_driver_mesh_bss_params conf;
1079 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1080 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1081 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1082 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1087 * struct wpa_driver_capa - Driver capability information
1089 struct wpa_driver_capa {
1090 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1091 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1092 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1093 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1094 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1095 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1096 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1097 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1098 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1099 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
1100 /** Bitfield of supported key management suites */
1101 unsigned int key_mgmt;
1103 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1104 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1105 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1106 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1107 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1108 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1109 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1110 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1111 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1112 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1113 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1114 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1115 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1116 /** Bitfield of supported cipher suites */
1119 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1120 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1121 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1122 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1125 /** Driver generated WPA/RSN IE */
1126 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1127 /** Driver needs static WEP key setup after association command */
1128 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1129 /** Driver takes care of all DFS operations */
1130 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1131 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1132 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1133 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1134 /** Driver is for a wired Ethernet interface */
1135 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1136 /** Driver provides separate commands for authentication and association (SME in
1137 * wpa_supplicant). */
1138 #define WPA_DRIVER_FLAGS_SME 0x00000020
1139 /** Driver supports AP mode */
1140 #define WPA_DRIVER_FLAGS_AP 0x00000040
1141 /** Driver needs static WEP key setup after association has been completed */
1142 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1143 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1144 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1145 /** Driver supports concurrent P2P operations */
1146 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1148 * Driver uses the initial interface as a dedicated management interface, i.e.,
1149 * it cannot be used for P2P group operations or non-P2P purposes.
1151 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1152 /** This interface is P2P capable (P2P GO or P2P Client) */
1153 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1154 /** Driver supports station and key removal when stopping an AP */
1155 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1157 * Driver uses the initial interface for P2P management interface and non-P2P
1158 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1159 * P2P group operations.
1161 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1163 * Driver is known to use sane error codes, i.e., when it indicates that
1164 * something (e.g., association) fails, there was indeed a failure and the
1165 * operation does not end up getting completed successfully later.
1167 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1168 /** Driver supports off-channel TX */
1169 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1170 /** Driver indicates TX status events for EAPOL Data frames */
1171 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1172 /** Driver indicates TX status events for Deauth/Disassoc frames */
1173 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1174 /** Driver supports roaming (BSS selection) in firmware */
1175 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1176 /** Driver supports operating as a TDLS peer */
1177 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1178 /** Driver requires external TDLS setup/teardown/discovery */
1179 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1180 /** Driver indicates support for Probe Response offloading in AP mode */
1181 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1182 /** Driver supports U-APSD in AP mode */
1183 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1184 /** Driver supports inactivity timer in AP mode */
1185 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1186 /** Driver expects user space implementation of MLME in AP mode */
1187 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1188 /** Driver supports SAE with user space SME */
1189 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1190 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1191 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1192 /** Driver supports IBSS (Ad-hoc) mode */
1193 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1194 /** Driver supports radar detection */
1195 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1196 /** Driver supports a dedicated interface for P2P Device */
1197 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1198 /** Driver supports QoS Mapping */
1199 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1200 /** Driver supports CSA in AP mode */
1201 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1202 /** Driver supports mesh */
1203 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1204 /** Driver support ACS offload */
1205 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1206 /** Driver supports key management offload */
1207 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1208 /** Driver supports TDLS channel switching */
1209 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1210 /** Driver supports IBSS with HT datarates */
1211 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
1212 /** Driver supports IBSS with VHT datarates */
1213 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
1216 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1217 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1218 unsigned int smps_modes;
1220 unsigned int wmm_ac_supported:1;
1222 unsigned int mac_addr_rand_scan_supported:1;
1223 unsigned int mac_addr_rand_sched_scan_supported:1;
1225 /** Maximum number of supported active probe SSIDs */
1228 /** Maximum number of supported active probe SSIDs for sched_scan */
1229 int max_sched_scan_ssids;
1231 /** Whether sched_scan (offloaded scanning) is supported */
1232 int sched_scan_supported;
1234 /** Maximum number of supported match sets for sched_scan */
1238 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1240 unsigned int max_remain_on_chan;
1243 * max_stations - Maximum number of associated stations the driver
1244 * supports in AP mode
1246 unsigned int max_stations;
1249 * probe_resp_offloads - Bitmap of supported protocols by the driver
1250 * for Probe Response offloading.
1252 /** Driver Probe Response offloading support for WPS ver. 1 */
1253 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1254 /** Driver Probe Response offloading support for WPS ver. 2 */
1255 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1256 /** Driver Probe Response offloading support for P2P */
1257 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1258 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1259 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1260 unsigned int probe_resp_offloads;
1262 unsigned int max_acl_mac_addrs;
1265 * Number of supported concurrent channels
1267 unsigned int num_multichan_concurrent;
1270 * extended_capa - extended capabilities in driver/device
1272 * Must be allocated and freed by driver and the pointers must be
1273 * valid for the lifetime of the driver, i.e., freed in deinit()
1275 const u8 *extended_capa, *extended_capa_mask;
1276 unsigned int extended_capa_len;
1278 struct wowlan_triggers wowlan_triggers;
1280 /** Driver adds the DS Params Set IE in Probe Request frames */
1281 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1282 /** Driver adds the WFA TPC IE in Probe Request frames */
1283 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1284 /** Driver handles quiet period requests */
1285 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1287 * Driver is capable of inserting the current TX power value into the body of
1288 * transmitted frames.
1289 * Background: Some Action frames include a TPC Report IE. This IE contains a
1290 * TX power field, which has to be updated by lower layers. One such Action
1291 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1292 * of spectrum management). Note that this insertion takes place at a fixed
1293 * offset, namely the 6th byte in the Action frame body.
1295 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1300 struct hostapd_data;
1302 struct hostap_sta_driver_data {
1303 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1304 unsigned long current_tx_rate;
1305 unsigned long inactive_msec;
1306 unsigned long flags;
1307 unsigned long num_ps_buf_frames;
1308 unsigned long tx_retry_failed;
1309 unsigned long tx_retry_count;
1314 struct hostapd_sta_add_params {
1318 const u8 *supp_rates;
1319 size_t supp_rates_len;
1320 u16 listen_interval;
1321 const struct ieee80211_ht_capabilities *ht_capabilities;
1322 const struct ieee80211_vht_capabilities *vht_capabilities;
1323 int vht_opmode_enabled;
1325 u32 flags; /* bitmask of WPA_STA_* flags */
1326 u32 flags_mask; /* unset bits in flags */
1328 enum mesh_plink_state plink_state;
1329 #endif /* CONFIG_MESH */
1330 int set; /* Set STA parameters instead of add */
1332 const u8 *ext_capab;
1333 size_t ext_capab_len;
1334 const u8 *supp_channels;
1335 size_t supp_channels_len;
1336 const u8 *supp_oper_classes;
1337 size_t supp_oper_classes_len;
1340 struct mac_address {
1344 struct hostapd_acl_params {
1346 unsigned int num_mac_acl;
1347 struct mac_address mac_acl[0];
1350 enum wpa_driver_if_type {
1352 * WPA_IF_STATION - Station mode interface
1357 * WPA_IF_AP_VLAN - AP mode VLAN interface
1359 * This interface shares its address and Beacon frame with the main
1365 * WPA_IF_AP_BSS - AP mode BSS interface
1367 * This interface has its own address and Beacon frame.
1372 * WPA_IF_P2P_GO - P2P Group Owner
1377 * WPA_IF_P2P_CLIENT - P2P Client
1382 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1383 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1388 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1389 * abstracted P2P Device function in the driver
1394 * WPA_IF_MESH - Mesh interface
1399 struct wpa_init_params {
1403 const char *driver_params;
1404 int use_pae_group_addr;
1408 u8 *own_addr; /* buffer for writing own MAC address */
1412 struct wpa_bss_params {
1413 /** Interface name (for multi-SSID/VLAN support) */
1415 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1424 enum mfp_options ieee80211w;
1427 #define WPA_STA_AUTHORIZED BIT(0)
1428 #define WPA_STA_WMM BIT(1)
1429 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1430 #define WPA_STA_MFP BIT(3)
1431 #define WPA_STA_TDLS_PEER BIT(4)
1432 #define WPA_STA_AUTHENTICATED BIT(5)
1445 WNM_SLEEP_ENTER_CONFIRM,
1446 WNM_SLEEP_ENTER_FAIL,
1447 WNM_SLEEP_EXIT_CONFIRM,
1448 WNM_SLEEP_EXIT_FAIL,
1449 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1450 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1451 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1453 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1455 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1456 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1458 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1461 /* enum chan_width - Channel width definitions */
1473 * struct wpa_signal_info - Information about channel signal quality
1475 struct wpa_signal_info {
1477 int above_threshold;
1482 enum chan_width chanwidth;
1488 * struct beacon_data - Beacon data
1489 * @head: Head portion of Beacon frame (before TIM IE)
1490 * @tail: Tail portion of Beacon frame (after TIM IE)
1491 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1492 * @proberesp_ies: Extra information element(s) to add into Probe Response
1494 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1495 * Response frames or %NULL
1496 * @probe_resp: Probe Response frame template
1497 * @head_len: Length of @head
1498 * @tail_len: Length of @tail
1499 * @beacon_ies_len: Length of beacon_ies in octets
1500 * @proberesp_ies_len: Length of proberesp_ies in octets
1501 * @proberesp_ies_len: Length of proberesp_ies in octets
1502 * @probe_resp_len: Length of probe response template (@probe_resp)
1504 struct beacon_data {
1511 size_t head_len, tail_len;
1512 size_t beacon_ies_len;
1513 size_t proberesp_ies_len;
1514 size_t assocresp_ies_len;
1515 size_t probe_resp_len;
1519 * struct csa_settings - Settings for channel switch command
1520 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1521 * @block_tx: 1 - block transmission for CSA period
1522 * @freq_params: Next channel frequency parameter
1523 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1524 * @beacon_after: Next beacon/probe resp/asooc resp info
1525 * @counter_offset_beacon: Offset to the count field in beacon's tail
1526 * @counter_offset_presp: Offset to the count field in probe resp.
1528 struct csa_settings {
1532 struct hostapd_freq_params freq_params;
1533 struct beacon_data beacon_csa;
1534 struct beacon_data beacon_after;
1536 u16 counter_offset_beacon;
1537 u16 counter_offset_presp;
1540 /* TDLS peer capabilities for send_tdls_mgmt() */
1541 enum tdls_peer_capability {
1542 TDLS_PEER_HT = BIT(0),
1543 TDLS_PEER_VHT = BIT(1),
1544 TDLS_PEER_WMM = BIT(2),
1547 /* valid info in the wmm_params struct */
1548 enum wmm_params_valid_info {
1549 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1553 * struct wmm_params - WMM parameterss configured for this association
1554 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1555 * of the struct contain valid information.
1556 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1557 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1564 #ifdef CONFIG_MACSEC
1565 struct macsec_init_params {
1566 Boolean always_include_sci;
1570 #endif /* CONFIG_MACSEC */
1572 enum drv_br_port_attr {
1573 DRV_BR_PORT_ATTR_PROXYARP,
1574 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1577 enum drv_br_net_param {
1578 DRV_BR_NET_PARAM_GARP_ACCEPT,
1581 struct drv_acs_params {
1582 /* Selected mode (HOSTAPD_MODE_*) */
1583 enum hostapd_hw_mode hw_mode;
1585 /* Indicates whether HT is enabled */
1588 /* Indicates whether HT40 is enabled */
1594 * struct wpa_driver_ops - Driver interface API definition
1596 * This structure defines the API that each driver interface needs to implement
1597 * for core wpa_supplicant code. All driver specific functionality is captured
1600 struct wpa_driver_ops {
1601 /** Name of the driver interface */
1603 /** One line description of the driver interface */
1607 * get_bssid - Get the current BSSID
1608 * @priv: private driver interface data
1609 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1611 * Returns: 0 on success, -1 on failure
1613 * Query kernel driver for the current BSSID and copy it to bssid.
1614 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1617 int (*get_bssid)(void *priv, u8 *bssid);
1620 * get_ssid - Get the current SSID
1621 * @priv: private driver interface data
1622 * @ssid: buffer for SSID (at least 32 bytes)
1624 * Returns: Length of the SSID on success, -1 on failure
1626 * Query kernel driver for the current SSID and copy it to ssid.
1627 * Returning zero is recommended if the STA is not associated.
1629 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1630 * can, at least in theory, contain control characters (including nul)
1631 * and as such, should be processed as binary data, not a printable
1634 int (*get_ssid)(void *priv, u8 *ssid);
1637 * set_key - Configure encryption key
1638 * @ifname: Interface name (for multi-SSID/VLAN support)
1639 * @priv: private driver interface data
1640 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1641 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1642 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1643 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1644 * %WPA_ALG_BIP_CMAC_256);
1645 * %WPA_ALG_NONE clears the key.
1646 * @addr: Address of the peer STA (BSSID of the current AP when setting
1647 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1648 * broadcast keys, %NULL for default keys that are used both for
1649 * broadcast and unicast; when clearing keys, %NULL is used to
1650 * indicate that both the broadcast-only and default key of the
1651 * specified key index is to be cleared
1652 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1654 * @set_tx: configure this key as the default Tx key (only used when
1655 * driver does not support separate unicast/individual key
1656 * @seq: sequence number/packet number, seq_len octets, the next
1657 * packet number to be used for in replay protection; configured
1658 * for Rx keys (in most cases, this is only used with broadcast
1659 * keys and set to zero for unicast keys); %NULL if not set
1660 * @seq_len: length of the seq, depends on the algorithm:
1661 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1662 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1664 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1665 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1667 * Returns: 0 on success, -1 on failure
1669 * Configure the given key for the kernel driver. If the driver
1670 * supports separate individual keys (4 default keys + 1 individual),
1671 * addr can be used to determine whether the key is default or
1672 * individual. If only 4 keys are supported, the default key with key
1673 * index 0 is used as the individual key. STA must be configured to use
1674 * it as the default Tx key (set_tx is set) and accept Rx for all the
1675 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1676 * broadcast keys, so key index 0 is available for this kind of
1679 * Please note that TKIP keys include separate TX and RX MIC keys and
1680 * some drivers may expect them in different order than wpa_supplicant
1681 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1682 * will trigger Michael MIC errors. This can be fixed by changing the
1683 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1684 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1685 * example on how this can be done.
1687 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1688 const u8 *addr, int key_idx, int set_tx,
1689 const u8 *seq, size_t seq_len,
1690 const u8 *key, size_t key_len);
1693 * init - Initialize driver interface
1694 * @ctx: context to be used when calling wpa_supplicant functions,
1695 * e.g., wpa_supplicant_event()
1696 * @ifname: interface name, e.g., wlan0
1698 * Returns: Pointer to private data, %NULL on failure
1700 * Initialize driver interface, including event processing for kernel
1701 * driver events (e.g., associated, scan results, Michael MIC failure).
1702 * This function can allocate a private configuration data area for
1703 * @ctx, file descriptor, interface name, etc. information that may be
1704 * needed in future driver operations. If this is not used, non-NULL
1705 * value will need to be returned because %NULL is used to indicate
1706 * failure. The returned value will be used as 'void *priv' data for
1707 * all other driver_ops functions.
1709 * The main event loop (eloop.c) of wpa_supplicant can be used to
1710 * register callback for read sockets (eloop_register_read_sock()).
1712 * See below for more information about events and
1713 * wpa_supplicant_event() function.
1715 void * (*init)(void *ctx, const char *ifname);
1718 * deinit - Deinitialize driver interface
1719 * @priv: private driver interface data from init()
1721 * Shut down driver interface and processing of driver events. Free
1722 * private data buffer if one was allocated in init() handler.
1724 void (*deinit)(void *priv);
1727 * set_param - Set driver configuration parameters
1728 * @priv: private driver interface data from init()
1729 * @param: driver specific configuration parameters
1731 * Returns: 0 on success, -1 on failure
1733 * Optional handler for notifying driver interface about configuration
1734 * parameters (driver_param).
1736 int (*set_param)(void *priv, const char *param);
1739 * set_countermeasures - Enable/disable TKIP countermeasures
1740 * @priv: private driver interface data
1741 * @enabled: 1 = countermeasures enabled, 0 = disabled
1743 * Returns: 0 on success, -1 on failure
1745 * Configure TKIP countermeasures. When these are enabled, the driver
1746 * should drop all received and queued frames that are using TKIP.
1748 int (*set_countermeasures)(void *priv, int enabled);
1751 * deauthenticate - Request driver to deauthenticate
1752 * @priv: private driver interface data
1753 * @addr: peer address (BSSID of the AP)
1754 * @reason_code: 16-bit reason code to be sent in the deauthentication
1757 * Returns: 0 on success, -1 on failure
1759 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1762 * associate - Request driver to associate
1763 * @priv: private driver interface data
1764 * @params: association parameters
1766 * Returns: 0 on success, -1 on failure
1768 int (*associate)(void *priv,
1769 struct wpa_driver_associate_params *params);
1772 * add_pmkid - Add PMKSA cache entry to the driver
1773 * @priv: private driver interface data
1774 * @bssid: BSSID for the PMKSA cache entry
1775 * @pmkid: PMKID for the PMKSA cache entry
1777 * Returns: 0 on success, -1 on failure
1779 * This function is called when a new PMK is received, as a result of
1780 * either normal authentication or RSN pre-authentication.
1782 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1783 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1784 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1785 * driver_ops function does not need to be implemented. Likewise, if
1786 * the driver does not support WPA, this function is not needed.
1788 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1791 * remove_pmkid - Remove PMKSA cache entry to the driver
1792 * @priv: private driver interface data
1793 * @bssid: BSSID for the PMKSA cache entry
1794 * @pmkid: PMKID for the PMKSA cache entry
1796 * Returns: 0 on success, -1 on failure
1798 * This function is called when the supplicant drops a PMKSA cache
1799 * entry for any reason.
1801 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1802 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1803 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1804 * from wpa_supplicant, this driver_ops function does not need to be
1805 * implemented. Likewise, if the driver does not support WPA, this
1806 * function is not needed.
1808 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1811 * flush_pmkid - Flush PMKSA cache
1812 * @priv: private driver interface data
1814 * Returns: 0 on success, -1 on failure
1816 * This function is called when the supplicant drops all PMKSA cache
1817 * entries for any reason.
1819 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1820 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1821 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1822 * from wpa_supplicant, this driver_ops function does not need to be
1823 * implemented. Likewise, if the driver does not support WPA, this
1824 * function is not needed.
1826 int (*flush_pmkid)(void *priv);
1829 * get_capa - Get driver capabilities
1830 * @priv: private driver interface data
1832 * Returns: 0 on success, -1 on failure
1834 * Get driver/firmware/hardware capabilities.
1836 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1839 * poll - Poll driver for association information
1840 * @priv: private driver interface data
1842 * This is an option callback that can be used when the driver does not
1843 * provide event mechanism for association events. This is called when
1844 * receiving WPA EAPOL-Key messages that require association
1845 * information. The driver interface is supposed to generate associnfo
1846 * event before returning from this callback function. In addition, the
1847 * driver interface should generate an association event after having
1848 * sent out associnfo.
1850 void (*poll)(void *priv);
1853 * get_ifname - Get interface name
1854 * @priv: private driver interface data
1856 * Returns: Pointer to the interface name. This can differ from the
1857 * interface name used in init() call. Init() is called first.
1859 * This optional function can be used to allow the driver interface to
1860 * replace the interface name with something else, e.g., based on an
1861 * interface mapping from a more descriptive name.
1863 const char * (*get_ifname)(void *priv);
1866 * get_mac_addr - Get own MAC address
1867 * @priv: private driver interface data
1869 * Returns: Pointer to own MAC address or %NULL on failure
1871 * This optional function can be used to get the own MAC address of the
1872 * device from the driver interface code. This is only needed if the
1873 * l2_packet implementation for the OS does not provide easy access to
1875 const u8 * (*get_mac_addr)(void *priv);
1878 * set_operstate - Sets device operating state to DORMANT or UP
1879 * @priv: private driver interface data
1880 * @state: 0 = dormant, 1 = up
1881 * Returns: 0 on success, -1 on failure
1883 * This is an optional function that can be used on operating systems
1884 * that support a concept of controlling network device state from user
1885 * space applications. This function, if set, gets called with
1886 * state = 1 when authentication has been completed and with state = 0
1887 * when connection is lost.
1889 int (*set_operstate)(void *priv, int state);
1892 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1893 * @priv: Private driver interface data
1894 * @addr: Address of the station for which to set protection (may be
1895 * %NULL for group keys)
1896 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1897 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1898 * Returns: 0 on success, -1 on failure
1900 * This is an optional function that can be used to set the driver to
1901 * require protection for Tx and/or Rx frames. This uses the layer
1902 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1903 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1904 * set protection operation; instead, they set protection implicitly
1905 * based on configured keys.
1907 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1911 * get_hw_feature_data - Get hardware support data (channels and rates)
1912 * @priv: Private driver interface data
1913 * @num_modes: Variable for returning the number of returned modes
1914 * flags: Variable for returning hardware feature flags
1915 * Returns: Pointer to allocated hardware data on success or %NULL on
1916 * failure. Caller is responsible for freeing this.
1918 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1923 * send_mlme - Send management frame from MLME
1924 * @priv: Private driver interface data
1925 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1926 * @data_len: Size of the management frame
1927 * @noack: Do not wait for this frame to be acked (disable retries)
1928 * Returns: 0 on success, -1 on failure
1930 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1934 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1935 * @priv: Private driver interface data
1936 * @md: Mobility domain (2 octets) (also included inside ies)
1937 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1938 * @ies_len: Length of FT IEs in bytes
1939 * Returns: 0 on success, -1 on failure
1941 * The supplicant uses this callback to let the driver know that keying
1942 * material for FT is available and that the driver can use the
1943 * provided IEs in the next message in FT authentication sequence.
1945 * This function is only needed for driver that support IEEE 802.11r
1946 * (Fast BSS Transition).
1948 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1952 * get_scan_results2 - Fetch the latest scan results
1953 * @priv: private driver interface data
1955 * Returns: Allocated buffer of scan results (caller is responsible for
1956 * freeing the data structure) on success, NULL on failure
1958 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1961 * set_country - Set country
1962 * @priv: Private driver interface data
1963 * @alpha2: country to which to switch to
1964 * Returns: 0 on success, -1 on failure
1966 * This function is for drivers which support some form
1967 * of setting a regulatory domain.
1969 int (*set_country)(void *priv, const char *alpha2);
1972 * get_country - Get country
1973 * @priv: Private driver interface data
1974 * @alpha2: Buffer for returning country code (at least 3 octets)
1975 * Returns: 0 on success, -1 on failure
1977 int (*get_country)(void *priv, char *alpha2);
1980 * global_init - Global driver initialization
1981 * Returns: Pointer to private data (global), %NULL on failure
1983 * This optional function is called to initialize the driver wrapper
1984 * for global data, i.e., data that applies to all interfaces. If this
1985 * function is implemented, global_deinit() will also need to be
1986 * implemented to free the private data. The driver will also likely
1987 * use init2() function instead of init() to get the pointer to global
1988 * data available to per-interface initializer.
1990 void * (*global_init)(void);
1993 * global_deinit - Global driver deinitialization
1994 * @priv: private driver global data from global_init()
1996 * Terminate any global driver related functionality and free the
1997 * global data structure.
1999 void (*global_deinit)(void *priv);
2002 * init2 - Initialize driver interface (with global data)
2003 * @ctx: context to be used when calling wpa_supplicant functions,
2004 * e.g., wpa_supplicant_event()
2005 * @ifname: interface name, e.g., wlan0
2006 * @global_priv: private driver global data from global_init()
2007 * Returns: Pointer to private data, %NULL on failure
2009 * This function can be used instead of init() if the driver wrapper
2012 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2015 * get_interfaces - Get information about available interfaces
2016 * @global_priv: private driver global data from global_init()
2017 * Returns: Allocated buffer of interface information (caller is
2018 * responsible for freeing the data structure) on success, NULL on
2021 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2024 * scan2 - Request the driver to initiate scan
2025 * @priv: private driver interface data
2026 * @params: Scan parameters
2028 * Returns: 0 on success, -1 on failure
2030 * Once the scan results are ready, the driver should report scan
2031 * results event for wpa_supplicant which will eventually request the
2032 * results with wpa_driver_get_scan_results2().
2034 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2037 * authenticate - Request driver to authenticate
2038 * @priv: private driver interface data
2039 * @params: authentication parameters
2040 * Returns: 0 on success, -1 on failure
2042 * This is an optional function that can be used with drivers that
2043 * support separate authentication and association steps, i.e., when
2044 * wpa_supplicant can act as the SME. If not implemented, associate()
2045 * function is expected to take care of IEEE 802.11 authentication,
2048 int (*authenticate)(void *priv,
2049 struct wpa_driver_auth_params *params);
2052 * set_ap - Set Beacon and Probe Response information for AP mode
2053 * @priv: Private driver interface data
2054 * @params: Parameters to use in AP mode
2056 * This function is used to configure Beacon template and/or extra IEs
2057 * to add for Beacon and Probe Response frames for the driver in
2058 * AP mode. The driver is responsible for building the full Beacon
2059 * frame by concatenating the head part with TIM IE generated by the
2060 * driver/firmware and finishing with the tail part. Depending on the
2061 * driver architectue, this can be done either by using the full
2062 * template or the set of additional IEs (e.g., WPS and P2P IE).
2063 * Similarly, Probe Response processing depends on the driver design.
2064 * If the driver (or firmware) takes care of replying to Probe Request
2065 * frames, the extra IEs provided here needs to be added to the Probe
2068 * Returns: 0 on success, -1 on failure
2070 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
2073 * set_acl - Set ACL in AP mode
2074 * @priv: Private driver interface data
2075 * @params: Parameters to configure ACL
2076 * Returns: 0 on success, -1 on failure
2078 * This is used only for the drivers which support MAC address ACL.
2080 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2083 * hapd_init - Initialize driver interface (hostapd only)
2084 * @hapd: Pointer to hostapd context
2085 * @params: Configuration for the driver wrapper
2086 * Returns: Pointer to private data, %NULL on failure
2088 * This function is used instead of init() or init2() when the driver
2089 * wrapper is used with hostapd.
2091 void * (*hapd_init)(struct hostapd_data *hapd,
2092 struct wpa_init_params *params);
2095 * hapd_deinit - Deinitialize driver interface (hostapd only)
2096 * @priv: Private driver interface data from hapd_init()
2098 void (*hapd_deinit)(void *priv);
2101 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2102 * @priv: Private driver interface data
2103 * @params: BSS parameters
2104 * Returns: 0 on success, -1 on failure
2106 * This is an optional function to configure the kernel driver to
2107 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2108 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2109 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2110 * for Beacon frames.
2112 * DEPRECATED - use set_ap() instead
2114 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2117 * set_privacy - Enable/disable privacy (AP only)
2118 * @priv: Private driver interface data
2119 * @enabled: 1 = privacy enabled, 0 = disabled
2120 * Returns: 0 on success, -1 on failure
2122 * This is an optional function to configure privacy field in the
2123 * kernel driver for Beacon frames. This can be left undefined (set to
2124 * %NULL) if the driver uses the Beacon template from set_ap().
2126 * DEPRECATED - use set_ap() instead
2128 int (*set_privacy)(void *priv, int enabled);
2131 * get_seqnum - Fetch the current TSC/packet number (AP only)
2132 * @ifname: The interface name (main or virtual)
2133 * @priv: Private driver interface data
2134 * @addr: MAC address of the station or %NULL for group keys
2136 * @seq: Buffer for returning the latest used TSC/packet number
2137 * Returns: 0 on success, -1 on failure
2139 * This function is used to fetch the last used TSC/packet number for
2140 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2141 * keys, so there is no strict requirement on implementing support for
2142 * unicast keys (i.e., addr != %NULL).
2144 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2148 * flush - Flush all association stations (AP only)
2149 * @priv: Private driver interface data
2150 * Returns: 0 on success, -1 on failure
2152 * This function requests the driver to disassociate all associated
2153 * stations. This function does not need to be implemented if the
2154 * driver does not process association frames internally.
2156 int (*flush)(void *priv);
2159 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2160 * @priv: Private driver interface data
2161 * @elem: Information elements
2162 * @elem_len: Length of the elem buffer in octets
2163 * Returns: 0 on success, -1 on failure
2165 * This is an optional function to add information elements in the
2166 * kernel driver for Beacon and Probe Response frames. This can be left
2167 * undefined (set to %NULL) if the driver uses the Beacon template from
2170 * DEPRECATED - use set_ap() instead
2172 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2175 * read_sta_data - Fetch station data
2176 * @priv: Private driver interface data
2177 * @data: Buffer for returning station information
2178 * @addr: MAC address of the station
2179 * Returns: 0 on success, -1 on failure
2181 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2185 * hapd_send_eapol - Send an EAPOL packet (AP only)
2186 * @priv: private driver interface data
2187 * @addr: Destination MAC address
2188 * @data: EAPOL packet starting with IEEE 802.1X header
2189 * @data_len: Length of the EAPOL packet in octets
2190 * @encrypt: Whether the frame should be encrypted
2191 * @own_addr: Source MAC address
2192 * @flags: WPA_STA_* flags for the destination station
2194 * Returns: 0 on success, -1 on failure
2196 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2197 size_t data_len, int encrypt,
2198 const u8 *own_addr, u32 flags);
2201 * sta_deauth - Deauthenticate a station (AP only)
2202 * @priv: Private driver interface data
2203 * @own_addr: Source address and BSSID for the Deauthentication frame
2204 * @addr: MAC address of the station to deauthenticate
2205 * @reason: Reason code for the Deauthentiation frame
2206 * Returns: 0 on success, -1 on failure
2208 * This function requests a specific station to be deauthenticated and
2209 * a Deauthentication frame to be sent to it.
2211 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2215 * sta_disassoc - Disassociate a station (AP only)
2216 * @priv: Private driver interface data
2217 * @own_addr: Source address and BSSID for the Disassociation frame
2218 * @addr: MAC address of the station to disassociate
2219 * @reason: Reason code for the Disassociation frame
2220 * Returns: 0 on success, -1 on failure
2222 * This function requests a specific station to be disassociated and
2223 * a Disassociation frame to be sent to it.
2225 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2229 * sta_remove - Remove a station entry (AP only)
2230 * @priv: Private driver interface data
2231 * @addr: MAC address of the station to be removed
2232 * Returns: 0 on success, -1 on failure
2234 int (*sta_remove)(void *priv, const u8 *addr);
2237 * hapd_get_ssid - Get the current SSID (AP only)
2238 * @priv: Private driver interface data
2239 * @buf: Buffer for returning the SSID
2240 * @len: Maximum length of the buffer
2241 * Returns: Length of the SSID on success, -1 on failure
2243 * This function need not be implemented if the driver uses Beacon
2244 * template from set_ap() and does not reply to Probe Request frames.
2246 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2249 * hapd_set_ssid - Set SSID (AP only)
2250 * @priv: Private driver interface data
2252 * @len: Length of the SSID in octets
2253 * Returns: 0 on success, -1 on failure
2255 * DEPRECATED - use set_ap() instead
2257 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2260 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2261 * @priv: Private driver interface data
2262 * @enabled: 1 = countermeasures enabled, 0 = disabled
2263 * Returns: 0 on success, -1 on failure
2265 * This need not be implemented if the driver does not take care of
2266 * association processing.
2268 int (*hapd_set_countermeasures)(void *priv, int enabled);
2271 * sta_add - Add a station entry
2272 * @priv: Private driver interface data
2273 * @params: Station parameters
2274 * Returns: 0 on success, -1 on failure
2276 * This function is used to add a station entry to the driver once the
2277 * station has completed association. This is only used if the driver
2278 * does not take care of association processing.
2280 * With TDLS, this function is also used to add or set (params->set 1)
2281 * TDLS peer entries.
2283 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2286 * get_inact_sec - Get station inactivity duration (AP only)
2287 * @priv: Private driver interface data
2288 * @addr: Station address
2289 * Returns: Number of seconds station has been inactive, -1 on failure
2291 int (*get_inact_sec)(void *priv, const u8 *addr);
2294 * sta_clear_stats - Clear station statistics (AP only)
2295 * @priv: Private driver interface data
2296 * @addr: Station address
2297 * Returns: 0 on success, -1 on failure
2299 int (*sta_clear_stats)(void *priv, const u8 *addr);
2302 * set_freq - Set channel/frequency (AP only)
2303 * @priv: Private driver interface data
2304 * @freq: Channel parameters
2305 * Returns: 0 on success, -1 on failure
2307 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2310 * set_rts - Set RTS threshold
2311 * @priv: Private driver interface data
2312 * @rts: RTS threshold in octets
2313 * Returns: 0 on success, -1 on failure
2315 int (*set_rts)(void *priv, int rts);
2318 * set_frag - Set fragmentation threshold
2319 * @priv: Private driver interface data
2320 * @frag: Fragmentation threshold in octets
2321 * Returns: 0 on success, -1 on failure
2323 int (*set_frag)(void *priv, int frag);
2326 * sta_set_flags - Set station flags (AP only)
2327 * @priv: Private driver interface data
2328 * @addr: Station address
2329 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2330 * @flags_or: Bitmap of WPA_STA_* flags to add
2331 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2332 * Returns: 0 on success, -1 on failure
2334 int (*sta_set_flags)(void *priv, const u8 *addr,
2335 int total_flags, int flags_or, int flags_and);
2338 * set_tx_queue_params - Set TX queue parameters
2339 * @priv: Private driver interface data
2340 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2344 * @burst_time: Maximum length for bursting in 0.1 msec units
2346 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2347 int cw_max, int burst_time);
2350 * if_add - Add a virtual interface
2351 * @priv: Private driver interface data
2352 * @type: Interface type
2353 * @ifname: Interface name for the new virtual interface
2354 * @addr: Local address to use for the interface or %NULL to use the
2355 * parent interface address
2356 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2357 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2358 * not allowed (applies only to %WPA_IF_AP_BSS type)
2359 * @force_ifname: Buffer for returning an interface name that the
2360 * driver ended up using if it differs from the requested ifname
2361 * @if_addr: Buffer for returning the allocated interface address
2362 * (this may differ from the requested addr if the driver cannot
2363 * change interface address)
2364 * @bridge: Bridge interface to use or %NULL if no bridge configured
2365 * @use_existing: Whether to allow existing interface to be used
2366 * Returns: 0 on success, -1 on failure
2368 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2369 const char *ifname, const u8 *addr, void *bss_ctx,
2370 void **drv_priv, char *force_ifname, u8 *if_addr,
2371 const char *bridge, int use_existing);
2374 * if_remove - Remove a virtual interface
2375 * @priv: Private driver interface data
2376 * @type: Interface type
2377 * @ifname: Interface name of the virtual interface to be removed
2378 * Returns: 0 on success, -1 on failure
2380 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2381 const char *ifname);
2384 * set_sta_vlan - Bind a station into a specific interface (AP only)
2385 * @priv: Private driver interface data
2386 * @ifname: Interface (main or virtual BSS or VLAN)
2387 * @addr: MAC address of the associated station
2389 * Returns: 0 on success, -1 on failure
2391 * This function is used to bind a station to a specific virtual
2392 * interface. It is only used if when virtual interfaces are supported,
2393 * e.g., to assign stations to different VLAN interfaces based on
2394 * information from a RADIUS server. This allows separate broadcast
2395 * domains to be used with a single BSS.
2397 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2401 * commit - Optional commit changes handler (AP only)
2402 * @priv: driver private data
2403 * Returns: 0 on success, -1 on failure
2405 * This optional handler function can be registered if the driver
2406 * interface implementation needs to commit changes (e.g., by setting
2407 * network interface up) at the end of initial configuration. If set,
2408 * this handler will be called after initial setup has been completed.
2410 int (*commit)(void *priv);
2413 * send_ether - Send an ethernet packet (AP only)
2414 * @priv: private driver interface data
2415 * @dst: Destination MAC address
2416 * @src: Source MAC address
2418 * @data: EAPOL packet starting with IEEE 802.1X header
2419 * @data_len: Length of the EAPOL packet in octets
2420 * Returns: 0 on success, -1 on failure
2422 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2423 const u8 *data, size_t data_len);
2426 * set_radius_acl_auth - Notification of RADIUS ACL change
2427 * @priv: Private driver interface data
2428 * @mac: MAC address of the station
2429 * @accepted: Whether the station was accepted
2430 * @session_timeout: Session timeout for the station
2431 * Returns: 0 on success, -1 on failure
2433 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2434 u32 session_timeout);
2437 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2438 * @priv: Private driver interface data
2439 * @mac: MAC address of the station
2440 * Returns: 0 on success, -1 on failure
2442 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2445 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2446 * @priv: Private driver interface data
2447 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2448 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2450 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2451 * to remove extra IE(s)
2452 * Returns: 0 on success, -1 on failure
2454 * This is an optional function to add WPS IE in the kernel driver for
2455 * Beacon and Probe Response frames. This can be left undefined (set
2456 * to %NULL) if the driver uses the Beacon template from set_ap()
2457 * and does not process Probe Request frames. If the driver takes care
2458 * of (Re)Association frame processing, the assocresp buffer includes
2459 * WPS IE(s) that need to be added to (Re)Association Response frames
2460 * whenever a (Re)Association Request frame indicated use of WPS.
2462 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2463 * frames when operating as a GO. The driver is responsible for adding
2464 * timing related attributes (e.g., NoA) in addition to the IEs
2465 * included here by appending them after these buffers. This call is
2466 * also used to provide Probe Response IEs for P2P Listen state
2467 * operations for drivers that generate the Probe Response frames
2470 * DEPRECATED - use set_ap() instead
2472 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2473 const struct wpabuf *proberesp,
2474 const struct wpabuf *assocresp);
2477 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2478 * @priv: Private driver interface data
2479 * @authorized: Whether the port is authorized
2480 * Returns: 0 on success, -1 on failure
2482 int (*set_supp_port)(void *priv, int authorized);
2485 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2486 * @priv: Private driver interface data
2487 * @addr: MAC address of the associated station
2488 * @aid: Association ID
2489 * @val: 1 = bind to 4-address WDS; 0 = unbind
2490 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2491 * to indicate that bridge is not to be used
2492 * @ifname_wds: Buffer to return the interface name for the new WDS
2493 * station or %NULL to indicate name is not returned.
2494 * Returns: 0 on success, -1 on failure
2496 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2497 const char *bridge_ifname, char *ifname_wds);
2500 * send_action - Transmit an Action frame
2501 * @priv: Private driver interface data
2502 * @freq: Frequency (in MHz) of the channel
2503 * @wait: Time to wait off-channel for a response (in ms), or zero
2504 * @dst: Destination MAC address (Address 1)
2505 * @src: Source MAC address (Address 2)
2506 * @bssid: BSSID (Address 3)
2508 * @data_len: data length in octets
2509 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2510 * Returns: 0 on success, -1 on failure
2512 * This command can be used to request the driver to transmit an action
2513 * frame to the specified destination.
2515 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2516 * be transmitted on the given channel and the device will wait for a
2517 * response on that channel for the given wait time.
2519 * If the flag is not set, the wait time will be ignored. In this case,
2520 * if a remain-on-channel duration is in progress, the frame must be
2521 * transmitted on that channel; alternatively the frame may be sent on
2522 * the current operational channel (if in associated state in station
2523 * mode or while operating as an AP.)
2525 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2526 const u8 *dst, const u8 *src, const u8 *bssid,
2527 const u8 *data, size_t data_len, int no_cck);
2530 * send_action_cancel_wait - Cancel action frame TX wait
2531 * @priv: Private driver interface data
2533 * This command cancels the wait time associated with sending an action
2534 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2535 * set in the driver flags.
2537 void (*send_action_cancel_wait)(void *priv);
2540 * remain_on_channel - Remain awake on a channel
2541 * @priv: Private driver interface data
2542 * @freq: Frequency (in MHz) of the channel
2543 * @duration: Duration in milliseconds
2544 * Returns: 0 on success, -1 on failure
2546 * This command is used to request the driver to remain awake on the
2547 * specified channel for the specified duration and report received
2548 * Action frames with EVENT_RX_MGMT events. Optionally, received
2549 * Probe Request frames may also be requested to be reported by calling
2550 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2552 * The driver may not be at the requested channel when this function
2553 * returns, i.e., the return code is only indicating whether the
2554 * request was accepted. The caller will need to wait until the
2555 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2556 * completed the channel change. This may take some time due to other
2557 * need for the radio and the caller should be prepared to timing out
2558 * its wait since there are no guarantees on when this request can be
2561 int (*remain_on_channel)(void *priv, unsigned int freq,
2562 unsigned int duration);
2565 * cancel_remain_on_channel - Cancel remain-on-channel operation
2566 * @priv: Private driver interface data
2568 * This command can be used to cancel a remain-on-channel operation
2569 * before its originally requested duration has passed. This could be
2570 * used, e.g., when remain_on_channel() is used to request extra time
2571 * to receive a response to an Action frame and the response is
2572 * received when there is still unneeded time remaining on the
2573 * remain-on-channel operation.
2575 int (*cancel_remain_on_channel)(void *priv);
2578 * probe_req_report - Request Probe Request frames to be indicated
2579 * @priv: Private driver interface data
2580 * @report: Whether to report received Probe Request frames
2581 * Returns: 0 on success, -1 on failure (or if not supported)
2583 * This command can be used to request the driver to indicate when
2584 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2585 * Since this operation may require extra resources, e.g., due to less
2586 * optimal hardware/firmware RX filtering, many drivers may disable
2587 * Probe Request reporting at least in station mode. This command is
2588 * used to notify the driver when the Probe Request frames need to be
2589 * reported, e.g., during remain-on-channel operations.
2591 int (*probe_req_report)(void *priv, int report);
2594 * deinit_ap - Deinitialize AP mode
2595 * @priv: Private driver interface data
2596 * Returns: 0 on success, -1 on failure (or if not supported)
2598 * This optional function can be used to disable AP mode related
2599 * configuration. If the interface was not dynamically added,
2600 * change the driver mode to station mode to allow normal station
2601 * operations like scanning to be completed.
2603 int (*deinit_ap)(void *priv);
2606 * deinit_p2p_cli - Deinitialize P2P client mode
2607 * @priv: Private driver interface data
2608 * Returns: 0 on success, -1 on failure (or if not supported)
2610 * This optional function can be used to disable P2P client mode. If the
2611 * interface was not dynamically added, change the interface type back
2614 int (*deinit_p2p_cli)(void *priv);
2617 * suspend - Notification on system suspend/hibernate event
2618 * @priv: Private driver interface data
2620 void (*suspend)(void *priv);
2623 * resume - Notification on system resume/thaw event
2624 * @priv: Private driver interface data
2626 void (*resume)(void *priv);
2629 * signal_monitor - Set signal monitoring parameters
2630 * @priv: Private driver interface data
2631 * @threshold: Threshold value for signal change events; 0 = disabled
2632 * @hysteresis: Minimum change in signal strength before indicating a
2634 * Returns: 0 on success, -1 on failure (or if not supported)
2636 * This function can be used to configure monitoring of signal strength
2637 * with the current AP. Whenever signal strength drops below the
2638 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2639 * should be generated assuming the signal strength has changed at
2640 * least %hysteresis from the previously indicated signal change event.
2642 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2645 * send_frame - Send IEEE 802.11 frame (testing use only)
2646 * @priv: Private driver interface data
2647 * @data: IEEE 802.11 frame with IEEE 802.11 header
2648 * @data_len: Size of the frame
2649 * @encrypt: Whether to encrypt the frame (if keys are set)
2650 * Returns: 0 on success, -1 on failure
2652 * This function is only used for debugging purposes and is not
2653 * required to be implemented for normal operations.
2655 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2659 * shared_freq - Get operating frequency of shared interface(s)
2660 * @priv: Private driver interface data
2661 * Returns: Operating frequency in MHz, 0 if no shared operation in
2662 * use, or -1 on failure
2664 * This command can be used to request the current operating frequency
2665 * of any virtual interface that shares the same radio to provide
2666 * information for channel selection for other virtual interfaces.
2668 int (*shared_freq)(void *priv);
2671 * get_noa - Get current Notice of Absence attribute payload
2672 * @priv: Private driver interface data
2673 * @buf: Buffer for returning NoA
2674 * @buf_len: Buffer length in octets
2675 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2676 * advertized, or -1 on failure
2678 * This function is used to fetch the current Notice of Absence
2679 * attribute value from GO.
2681 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2684 * set_noa - Set Notice of Absence parameters for GO (testing)
2685 * @priv: Private driver interface data
2687 * @start: Start time in ms from next TBTT
2688 * @duration: Duration in ms
2689 * Returns: 0 on success or -1 on failure
2691 * This function is used to set Notice of Absence parameters for GO. It
2692 * is used only for testing. To disable NoA, all parameters are set to
2695 int (*set_noa)(void *priv, u8 count, int start, int duration);
2698 * set_p2p_powersave - Set P2P power save options
2699 * @priv: Private driver interface data
2700 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2701 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2702 * @ctwindow: 0.. = change (msec), -1 = no change
2703 * Returns: 0 on success or -1 on failure
2705 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2709 * ampdu - Enable/disable aggregation
2710 * @priv: Private driver interface data
2711 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2712 * Returns: 0 on success or -1 on failure
2714 int (*ampdu)(void *priv, int ampdu);
2717 * get_radio_name - Get physical radio name for the device
2718 * @priv: Private driver interface data
2719 * Returns: Radio name or %NULL if not known
2721 * The returned data must not be modified by the caller. It is assumed
2722 * that any interface that has the same radio name as another is
2723 * sharing the same physical radio. This information can be used to
2724 * share scan results etc. information between the virtual interfaces
2725 * to speed up various operations.
2727 const char * (*get_radio_name)(void *priv);
2730 * send_tdls_mgmt - for sending TDLS management packets
2731 * @priv: private driver interface data
2732 * @dst: Destination (peer) MAC address
2733 * @action_code: TDLS action code for the mssage
2734 * @dialog_token: Dialog Token to use in the message (if needed)
2735 * @status_code: Status Code or Reason Code to use (if needed)
2736 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2737 * @initiator: Is the current end the TDLS link initiator
2738 * @buf: TDLS IEs to add to the message
2739 * @len: Length of buf in octets
2740 * Returns: 0 on success, negative (<0) on failure
2742 * This optional function can be used to send packet to driver which is
2743 * responsible for receiving and sending all TDLS packets.
2745 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2746 u8 dialog_token, u16 status_code, u32 peer_capab,
2747 int initiator, const u8 *buf, size_t len);
2750 * tdls_oper - Ask the driver to perform high-level TDLS operations
2751 * @priv: Private driver interface data
2752 * @oper: TDLS high-level operation. See %enum tdls_oper
2753 * @peer: Destination (peer) MAC address
2754 * Returns: 0 on success, negative (<0) on failure
2756 * This optional function can be used to send high-level TDLS commands
2759 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2762 * wnm_oper - Notify driver of the WNM frame reception
2763 * @priv: Private driver interface data
2764 * @oper: WNM operation. See %enum wnm_oper
2765 * @peer: Destination (peer) MAC address
2766 * @buf: Buffer for the driver to fill in (for getting IE)
2767 * @buf_len: Return the len of buf
2768 * Returns: 0 on success, negative (<0) on failure
2770 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2771 u8 *buf, u16 *buf_len);
2774 * set_qos_map - Set QoS Map
2775 * @priv: Private driver interface data
2776 * @qos_map_set: QoS Map
2777 * @qos_map_set_len: Length of QoS Map
2779 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2780 u8 qos_map_set_len);
2783 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2784 * @priv: Private driver interface data
2785 * @version: IP version of the IP address, 4 or 6
2786 * @ipaddr: IP address for the neigh entry
2787 * @prefixlen: IP address prefix length
2788 * @addr: Corresponding MAC address
2789 * Returns: 0 on success, negative (<0) on failure
2791 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2792 int prefixlen, const u8 *addr);
2795 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2796 * @priv: Private driver interface data
2797 * @version: IP version of the IP address, 4 or 6
2798 * @ipaddr: IP address for the neigh entry
2799 * Returns: 0 on success, negative (<0) on failure
2801 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2804 * br_port_set_attr - Set a bridge port attribute
2805 * @attr: Bridge port attribute to set
2806 * @val: Value to be set
2807 * Returns: 0 on success, negative (<0) on failure
2809 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2813 * br_port_set_attr - Set a bridge network parameter
2814 * @param: Bridge parameter to set
2815 * @val: Value to be set
2816 * Returns: 0 on success, negative (<0) on failure
2818 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2822 * set_wowlan - Set wake-on-wireless triggers
2823 * @priv: Private driver interface data
2824 * @triggers: wowlan triggers
2826 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2829 * signal_poll - Get current connection information
2830 * @priv: Private driver interface data
2831 * @signal_info: Connection info structure
2833 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2836 * set_authmode - Set authentication algorithm(s) for static WEP
2837 * @priv: Private driver interface data
2838 * @authmode: 1=Open System, 2=Shared Key, 3=both
2839 * Returns: 0 on success, -1 on failure
2841 * This function can be used to set authentication algorithms for AP
2842 * mode when static WEP is used. If the driver uses user space MLME/SME
2843 * implementation, there is no need to implement this function.
2845 * DEPRECATED - use set_ap() instead
2847 int (*set_authmode)(void *priv, int authmode);
2851 * driver_cmd - Execute driver-specific command
2852 * @priv: Private driver interface data
2853 * @cmd: Command to execute
2854 * @buf: Return buffer
2855 * @buf_len: Buffer length
2856 * Returns: 0 on success, -1 on failure
2858 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2859 #endif /* ANDROID */
2862 * vendor_cmd - Execute vendor specific command
2863 * @priv: Private driver interface data
2864 * @vendor_id: Vendor id
2865 * @subcmd: Vendor command id
2866 * @data: Vendor command parameters (%NULL if no parameters)
2867 * @data_len: Data length
2868 * @buf: Return buffer (%NULL to ignore reply)
2869 * Returns: 0 on success, negative (<0) on failure
2871 * This function handles vendor specific commands that are passed to
2872 * the driver/device. The command is identified by vendor id and
2873 * command id. Parameters can be passed as argument to the command
2874 * in the data buffer. Reply (if any) will be filled in the supplied
2877 * The exact driver behavior is driver interface and vendor specific. As
2878 * an example, this will be converted to a vendor specific cfg80211
2879 * command in case of the nl80211 driver interface.
2881 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2882 unsigned int subcmd, const u8 *data, size_t data_len,
2883 struct wpabuf *buf);
2886 * set_rekey_info - Set rekey information
2887 * @priv: Private driver interface data
2889 * @kek_len: KEK length in octets
2891 * @kck_len: KCK length in octets
2892 * @replay_ctr: Current EAPOL-Key Replay Counter
2894 * This optional function can be used to provide information for the
2895 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2896 * while the host (including wpa_supplicant) is sleeping.
2898 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
2899 const u8 *kck, size_t kck_len,
2900 const u8 *replay_ctr);
2903 * sta_assoc - Station association indication
2904 * @priv: Private driver interface data
2905 * @own_addr: Source address and BSSID for association frame
2906 * @addr: MAC address of the station to associate
2907 * @reassoc: flag to indicate re-association
2908 * @status: association response status code
2909 * @ie: assoc response ie buffer
2910 * @len: ie buffer length
2911 * Returns: 0 on success, -1 on failure
2913 * This function indicates the driver to send (Re)Association
2914 * Response frame to the station.
2916 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2917 int reassoc, u16 status, const u8 *ie, size_t len);
2920 * sta_auth - Station authentication indication
2921 * @priv: Private driver interface data
2922 * @own_addr: Source address and BSSID for authentication frame
2923 * @addr: MAC address of the station to associate
2924 * @seq: authentication sequence number
2925 * @status: authentication response status code
2926 * @ie: authentication frame ie buffer
2927 * @len: ie buffer length
2929 * This function indicates the driver to send Authentication frame
2932 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2933 u16 seq, u16 status, const u8 *ie, size_t len);
2936 * add_tspec - Add traffic stream
2937 * @priv: Private driver interface data
2938 * @addr: MAC address of the station to associate
2939 * @tspec_ie: tspec ie buffer
2940 * @tspec_ielen: tspec ie length
2941 * Returns: 0 on success, -1 on failure
2943 * This function adds the traffic steam for the station
2944 * and fills the medium_time in tspec_ie.
2946 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2947 size_t tspec_ielen);
2950 * add_sta_node - Add a station node in the driver
2951 * @priv: Private driver interface data
2952 * @addr: MAC address of the station to add
2953 * @auth_alg: authentication algorithm used by the station
2954 * Returns: 0 on success, -1 on failure
2956 * This function adds the station node in the driver, when
2957 * the station gets added by FT-over-DS.
2959 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2962 * sched_scan - Request the driver to initiate scheduled scan
2963 * @priv: Private driver interface data
2964 * @params: Scan parameters
2965 * @interval: Interval between scan cycles in milliseconds
2966 * Returns: 0 on success, -1 on failure
2968 * This operation should be used for scheduled scan offload to
2969 * the hardware. Every time scan results are available, the
2970 * driver should report scan results event for wpa_supplicant
2971 * which will eventually request the results with
2972 * wpa_driver_get_scan_results2(). This operation is optional
2973 * and if not provided or if it returns -1, we fall back to
2974 * normal host-scheduled scans.
2976 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2980 * stop_sched_scan - Request the driver to stop a scheduled scan
2981 * @priv: Private driver interface data
2982 * Returns: 0 on success, -1 on failure
2984 * This should cause the scheduled scan to be stopped and
2985 * results should stop being sent. Must be supported if
2986 * sched_scan is supported.
2988 int (*stop_sched_scan)(void *priv);
2991 * poll_client - Probe (null data or such) the given station
2992 * @priv: Private driver interface data
2993 * @own_addr: MAC address of sending interface
2994 * @addr: MAC address of the station to probe
2995 * @qos: Indicates whether station is QoS station
2997 * This function is used to verify whether an associated station is
2998 * still present. This function does not need to be implemented if the
2999 * driver provides such inactivity polling mechanism.
3001 void (*poll_client)(void *priv, const u8 *own_addr,
3002 const u8 *addr, int qos);
3005 * radio_disable - Disable/enable radio
3006 * @priv: Private driver interface data
3007 * @disabled: 1=disable 0=enable radio
3008 * Returns: 0 on success, -1 on failure
3010 * This optional command is for testing purposes. It can be used to
3011 * disable the radio on a testbed device to simulate out-of-radio-range
3014 int (*radio_disable)(void *priv, int disabled);
3017 * switch_channel - Announce channel switch and migrate the GO to the
3019 * @priv: Private driver interface data
3020 * @settings: Settings for CSA period and new channel
3021 * Returns: 0 on success, -1 on failure
3023 * This function is used to move the GO to the legacy STA channel to
3024 * avoid frequency conflict in single channel concurrency.
3026 int (*switch_channel)(void *priv, struct csa_settings *settings);
3029 * add_tx_ts - Add traffic stream
3030 * @priv: Private driver interface data
3031 * @tsid: Traffic stream ID
3032 * @addr: Receiver address
3033 * @user_prio: User priority of the traffic stream
3034 * @admitted_time: Admitted time for this TS in units of
3035 * 32 microsecond periods (per second).
3036 * Returns: 0 on success, -1 on failure
3038 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3042 * del_tx_ts - Delete traffic stream
3043 * @priv: Private driver interface data
3044 * @tsid: Traffic stream ID
3045 * @addr: Receiver address
3046 * Returns: 0 on success, -1 on failure
3048 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3051 * Enable channel-switching with TDLS peer
3052 * @priv: Private driver interface data
3053 * @addr: MAC address of the TDLS peer
3054 * @oper_class: Operating class of the switch channel
3055 * @params: Channel specification
3056 * Returns: 0 on success, -1 on failure
3058 * The function indicates to driver that it can start switching to a
3059 * different channel with a specified TDLS peer. The switching is
3060 * assumed on until canceled with tdls_disable_channel_switch().
3062 int (*tdls_enable_channel_switch)(
3063 void *priv, const u8 *addr, u8 oper_class,
3064 const struct hostapd_freq_params *params);
3067 * Disable channel switching with TDLS peer
3068 * @priv: Private driver interface data
3069 * @addr: MAC address of the TDLS peer
3070 * Returns: 0 on success, -1 on failure
3072 * This function indicates to the driver that it should stop switching
3073 * with a given TDLS peer.
3075 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3078 * start_dfs_cac - Listen for radar interference on the channel
3079 * @priv: Private driver interface data
3080 * @freq: Channel parameters
3081 * Returns: 0 on success, -1 on failure
3083 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
3086 * stop_ap - Removes beacon from AP
3087 * @priv: Private driver interface data
3088 * Returns: 0 on success, -1 on failure (or if not supported)
3090 * This optional function can be used to disable AP mode related
3091 * configuration. Unlike deinit_ap, it does not change to station
3094 int (*stop_ap)(void *priv);
3097 * get_survey - Retrieve survey data
3098 * @priv: Private driver interface data
3099 * @freq: If set, survey data for the specified frequency is only
3100 * being requested. If not set, all survey data is requested.
3101 * Returns: 0 on success, -1 on failure
3103 * Use this to retrieve:
3105 * - the observed channel noise floor
3106 * - the amount of time we have spent on the channel
3107 * - the amount of time during which we have spent on the channel that
3108 * the radio has determined the medium is busy and we cannot
3110 * - the amount of time we have spent receiving data
3111 * - the amount of time we have spent transmitting data
3113 * This data can be used for spectrum heuristics. One example is
3114 * Automatic Channel Selection (ACS). The channel survey data is
3115 * kept on a linked list on the channel data, one entry is added
3116 * for each survey. The min_nf of the channel is updated for each
3119 int (*get_survey)(void *priv, unsigned int freq);
3122 * status - Get driver interface status information
3123 * @priv: Private driver interface data
3124 * @buf: Buffer for printing tou the status information
3125 * @buflen: Maximum length of the buffer
3126 * Returns: Length of written status information or -1 on failure
3128 int (*status)(void *priv, char *buf, size_t buflen);
3131 * roaming - Set roaming policy for driver-based BSS selection
3132 * @priv: Private driver interface data
3133 * @allowed: Whether roaming within ESS is allowed
3134 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3135 * Returns: Length of written status information or -1 on failure
3137 * This optional callback can be used to update roaming policy from the
3138 * associate() command (bssid being set there indicates that the driver
3139 * should not roam before getting this roaming() call to allow roaming.
3140 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3141 * capability, roaming policy is handled within wpa_supplicant and there
3142 * is no need to implement or react to this callback.
3144 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3147 * set_mac_addr - Set MAC address
3148 * @priv: Private driver interface data
3149 * @addr: MAC address to use or %NULL for setting back to permanent
3150 * Returns: 0 on success, -1 on failure
3152 int (*set_mac_addr)(void *priv, const u8 *addr);
3154 #ifdef CONFIG_MACSEC
3155 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3157 int (*macsec_deinit)(void *priv);
3160 * enable_protect_frames - Set protect frames status
3161 * @priv: Private driver interface data
3162 * @enabled: TRUE = protect frames enabled
3163 * FALSE = protect frames disabled
3164 * Returns: 0 on success, -1 on failure (or if not supported)
3166 int (*enable_protect_frames)(void *priv, Boolean enabled);
3169 * set_replay_protect - Set replay protect status and window size
3170 * @priv: Private driver interface data
3171 * @enabled: TRUE = replay protect enabled
3172 * FALSE = replay protect disabled
3173 * @window: replay window size, valid only when replay protect enabled
3174 * Returns: 0 on success, -1 on failure (or if not supported)
3176 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3179 * set_current_cipher_suite - Set current cipher suite
3180 * @priv: Private driver interface data
3181 * @cs: EUI64 identifier
3182 * @cs_len: Length of the cs buffer in octets
3183 * Returns: 0 on success, -1 on failure (or if not supported)
3185 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3189 * enable_controlled_port - Set controlled port status
3190 * @priv: Private driver interface data
3191 * @enabled: TRUE = controlled port enabled
3192 * FALSE = controlled port disabled
3193 * Returns: 0 on success, -1 on failure (or if not supported)
3195 int (*enable_controlled_port)(void *priv, Boolean enabled);
3198 * get_receive_lowest_pn - Get receive lowest pn
3199 * @priv: Private driver interface data
3200 * @channel: secure channel
3201 * @an: association number
3202 * @lowest_pn: lowest accept pn
3203 * Returns: 0 on success, -1 on failure (or if not supported)
3205 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3209 * get_transmit_next_pn - Get transmit next pn
3210 * @priv: Private driver interface data
3211 * @channel: secure channel
3212 * @an: association number
3214 * Returns: 0 on success, -1 on failure (or if not supported)
3216 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3220 * set_transmit_next_pn - Set transmit next pn
3221 * @priv: Private driver interface data
3222 * @channel: secure channel
3223 * @an: association number
3225 * Returns: 0 on success, -1 on failure (or if not supported)
3227 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3231 * get_available_receive_sc - get available receive channel
3232 * @priv: Private driver interface data
3233 * @channel: secure channel
3234 * Returns: 0 on success, -1 on failure (or if not supported)
3236 int (*get_available_receive_sc)(void *priv, u32 *channel);
3239 * create_receive_sc - create secure channel for receiving
3240 * @priv: Private driver interface data
3241 * @channel: secure channel
3242 * @sci_addr: secure channel identifier - address
3243 * @sci_port: secure channel identifier - port
3244 * @conf_offset: confidentiality offset (0, 30, or 50)
3245 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3247 * Returns: 0 on success, -1 on failure (or if not supported)
3249 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3250 u16 sci_port, unsigned int conf_offset,
3254 * delete_receive_sc - delete secure connection for receiving
3255 * @priv: private driver interface data from init()
3256 * @channel: secure channel
3257 * Returns: 0 on success, -1 on failure
3259 int (*delete_receive_sc)(void *priv, u32 channel);
3262 * create_receive_sa - create secure association for receive
3263 * @priv: private driver interface data from init()
3264 * @channel: secure channel
3265 * @an: association number
3266 * @lowest_pn: the lowest packet number can be received
3267 * @sak: the secure association key
3268 * Returns: 0 on success, -1 on failure
3270 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3271 u32 lowest_pn, const u8 *sak);
3274 * enable_receive_sa - enable the SA for receive
3275 * @priv: private driver interface data from init()
3276 * @channel: secure channel
3277 * @an: association number
3278 * Returns: 0 on success, -1 on failure
3280 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3283 * disable_receive_sa - disable SA for receive
3284 * @priv: private driver interface data from init()
3285 * @channel: secure channel index
3286 * @an: association number
3287 * Returns: 0 on success, -1 on failure
3289 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3292 * get_available_transmit_sc - get available transmit channel
3293 * @priv: Private driver interface data
3294 * @channel: secure channel
3295 * Returns: 0 on success, -1 on failure (or if not supported)
3297 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3300 * create_transmit_sc - create secure connection for transmit
3301 * @priv: private driver interface data from init()
3302 * @channel: secure channel
3303 * @sci_addr: secure channel identifier - address
3304 * @sci_port: secure channel identifier - port
3305 * Returns: 0 on success, -1 on failure
3307 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3308 u16 sci_port, unsigned int conf_offset);
3311 * delete_transmit_sc - delete secure connection for transmit
3312 * @priv: private driver interface data from init()
3313 * @channel: secure channel
3314 * Returns: 0 on success, -1 on failure
3316 int (*delete_transmit_sc)(void *priv, u32 channel);
3319 * create_transmit_sa - create secure association for transmit
3320 * @priv: private driver interface data from init()
3321 * @channel: secure channel index
3322 * @an: association number
3323 * @next_pn: the packet number used as next transmit packet
3324 * @confidentiality: True if the SA is to provide confidentiality
3325 * as well as integrity
3326 * @sak: the secure association key
3327 * Returns: 0 on success, -1 on failure
3329 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3330 Boolean confidentiality, const u8 *sak);
3333 * enable_transmit_sa - enable SA for transmit
3334 * @priv: private driver interface data from init()
3335 * @channel: secure channel
3336 * @an: association number
3337 * Returns: 0 on success, -1 on failure
3339 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3342 * disable_transmit_sa - disable SA for transmit
3343 * @priv: private driver interface data from init()
3344 * @channel: secure channel
3345 * @an: association number
3346 * Returns: 0 on success, -1 on failure
3348 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3349 #endif /* CONFIG_MACSEC */
3352 * init_mesh - Driver specific initialization for mesh
3353 * @priv: Private driver interface data
3354 * Returns: 0 on success, -1 on failure
3356 int (*init_mesh)(void *priv);
3359 * join_mesh - Join a mesh network
3360 * @priv: Private driver interface data
3361 * @params: Mesh configuration parameters
3362 * Returns: 0 on success, -1 on failure
3364 int (*join_mesh)(void *priv,
3365 struct wpa_driver_mesh_join_params *params);
3368 * leave_mesh - Leave a mesh network
3369 * @priv: Private driver interface data
3370 * Returns 0 on success, -1 on failure
3372 int (*leave_mesh)(void *priv);
3375 * do_acs - Automatically select channel
3376 * @priv: Private driver interface data
3377 * @params: Parameters for ACS
3378 * Returns 0 on success, -1 on failure
3380 * This command can be used to offload ACS to the driver if the driver
3381 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3383 int (*do_acs)(void *priv, struct drv_acs_params *params);
3388 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3390 enum wpa_event_type {
3392 * EVENT_ASSOC - Association completed
3394 * This event needs to be delivered when the driver completes IEEE
3395 * 802.11 association or reassociation successfully.
3396 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3397 * after this event has been generated. In addition, optional
3398 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3399 * more information about the association. If the driver interface gets
3400 * both of these events at the same time, it can also include the
3401 * assoc_info data in EVENT_ASSOC call.
3406 * EVENT_DISASSOC - Association lost
3408 * This event should be called when association is lost either due to
3409 * receiving deauthenticate or disassociate frame from the AP or when
3410 * sending either of these frames to the current AP. If the driver
3411 * supports separate deauthentication event, EVENT_DISASSOC should only
3412 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3413 * In AP mode, union wpa_event_data::disassoc_info is required.
3418 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3420 * This event must be delivered when a Michael MIC error is detected by
3421 * the local driver. Additional data for event processing is
3422 * provided with union wpa_event_data::michael_mic_failure. This
3423 * information is used to request new encyption key and to initiate
3424 * TKIP countermeasures if needed.
3426 EVENT_MICHAEL_MIC_FAILURE,
3429 * EVENT_SCAN_RESULTS - Scan results available
3431 * This event must be called whenever scan results are available to be
3432 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3433 * is expected to be used some time after struct wpa_driver_ops::scan()
3434 * is called. If the driver provides an unsolicited event when the scan
3435 * has been completed, this event can be used to trigger
3436 * EVENT_SCAN_RESULTS call. If such event is not available from the
3437 * driver, the driver wrapper code is expected to use a registered
3438 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3439 * scan is expected to be completed. Optional information about
3440 * completed scan can be provided with union wpa_event_data::scan_info.
3445 * EVENT_ASSOCINFO - Report optional extra information for association
3447 * This event can be used to report extra association information for
3448 * EVENT_ASSOC processing. This extra information includes IEs from
3449 * association frames and Beacon/Probe Response frames in union
3450 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3451 * EVENT_ASSOC. Alternatively, the driver interface can include
3452 * assoc_info data in the EVENT_ASSOC call if it has all the
3453 * information available at the same point.
3458 * EVENT_INTERFACE_STATUS - Report interface status changes
3460 * This optional event can be used to report changes in interface
3461 * status (interface added/removed) using union
3462 * wpa_event_data::interface_status. This can be used to trigger
3463 * wpa_supplicant to stop and re-start processing for the interface,
3464 * e.g., when a cardbus card is ejected/inserted.
3466 EVENT_INTERFACE_STATUS,
3469 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3471 * This event can be used to inform wpa_supplicant about candidates for
3472 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3473 * for scan request (ap_scan=2 mode), this event is required for
3474 * pre-authentication. If wpa_supplicant is performing scan request
3475 * (ap_scan=1), this event is optional since scan results can be used
3476 * to add pre-authentication candidates. union
3477 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3478 * candidate and priority of the candidate, e.g., based on the signal
3479 * strength, in order to try to pre-authenticate first with candidates
3480 * that are most likely targets for re-association.
3482 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3483 * on the candidate list. In addition, it can be called for the current
3484 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3485 * will automatically skip pre-authentication in cases where a valid
3486 * PMKSA exists. When more than one candidate exists, this event should
3487 * be generated once for each candidate.
3489 * Driver will be notified about successful pre-authentication with
3490 * struct wpa_driver_ops::add_pmkid() calls.
3492 EVENT_PMKID_CANDIDATE,
3495 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3497 * This event can be used to inform wpa_supplicant about desire to set
3498 * up secure direct link connection between two stations as defined in
3499 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3500 * STAKey negotiation. The caller will need to set peer address for the
3506 * EVENT_TDLS - Request TDLS operation
3508 * This event can be used to request a TDLS operation to be performed.
3513 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3515 * The driver is expected to report the received FT IEs from
3516 * FT authentication sequence from the AP. The FT IEs are included in
3517 * the extra information in union wpa_event_data::ft_ies.
3522 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3524 * The driver can use this event to inform wpa_supplicant about a STA
3525 * in an IBSS with which protected frames could be exchanged. This
3526 * event starts RSN authentication with the other STA to authenticate
3527 * the STA and set up encryption keys with it.
3529 EVENT_IBSS_RSN_START,
3532 * EVENT_AUTH - Authentication result
3534 * This event should be called when authentication attempt has been
3535 * completed. This is only used if the driver supports separate
3536 * authentication step (struct wpa_driver_ops::authenticate).
3537 * Information about authentication result is included in
3538 * union wpa_event_data::auth.
3543 * EVENT_DEAUTH - Authentication lost
3545 * This event should be called when authentication is lost either due
3546 * to receiving deauthenticate frame from the AP or when sending that
3547 * frame to the current AP.
3548 * In AP mode, union wpa_event_data::deauth_info is required.
3553 * EVENT_ASSOC_REJECT - Association rejected
3555 * This event should be called when (re)association attempt has been
3556 * rejected by the AP. Information about the association response is
3557 * included in union wpa_event_data::assoc_reject.
3562 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3564 EVENT_AUTH_TIMED_OUT,
3567 * EVENT_ASSOC_TIMED_OUT - Association timed out
3569 EVENT_ASSOC_TIMED_OUT,
3572 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3574 EVENT_WPS_BUTTON_PUSHED,
3577 * EVENT_TX_STATUS - Report TX status
3582 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3584 EVENT_RX_FROM_UNKNOWN,
3587 * EVENT_RX_MGMT - Report RX of a management frame
3592 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3594 * This event is used to indicate when the driver has started the
3595 * requested remain-on-channel duration. Information about the
3596 * operation is included in union wpa_event_data::remain_on_channel.
3598 EVENT_REMAIN_ON_CHANNEL,
3601 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3603 * This event is used to indicate when the driver has completed
3604 * remain-on-channel duration, i.e., may noot be available on the
3605 * requested channel anymore. Information about the
3606 * operation is included in union wpa_event_data::remain_on_channel.
3608 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3611 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3613 * This event is used to indicate when a Probe Request frame has been
3614 * received. Information about the received frame is included in
3615 * union wpa_event_data::rx_probe_req. The driver is required to report
3616 * these events only after successfully completed probe_req_report()
3617 * commands to request the events (i.e., report parameter is non-zero)
3618 * in station mode. In AP mode, Probe Request frames should always be
3624 * EVENT_NEW_STA - New wired device noticed
3626 * This event is used to indicate that a new device has been detected
3627 * in a network that does not use association-like functionality (i.e.,
3628 * mainly wired Ethernet). This can be used to start EAPOL
3629 * authenticator when receiving a frame from a device. The address of
3630 * the device is included in union wpa_event_data::new_sta.
3635 * EVENT_EAPOL_RX - Report received EAPOL frame
3637 * When in AP mode with hostapd, this event is required to be used to
3638 * deliver the receive EAPOL frames from the driver.
3643 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3645 * This event is used to indicate changes in the signal strength
3646 * observed in frames received from the current AP if signal strength
3647 * monitoring has been enabled with signal_monitor().
3649 EVENT_SIGNAL_CHANGE,
3652 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3654 * This event is used to indicate that the interface was enabled after
3655 * having been previously disabled, e.g., due to rfkill.
3657 EVENT_INTERFACE_ENABLED,
3660 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3662 * This event is used to indicate that the interface was disabled,
3663 * e.g., due to rfkill.
3665 EVENT_INTERFACE_DISABLED,
3668 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3670 * This event is used to indicate that the channel list has changed,
3671 * e.g., because of a regulatory domain change triggered by scan
3672 * results including an AP advertising a country code.
3674 EVENT_CHANNEL_LIST_CHANGED,
3677 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3679 * This event is used to indicate that the driver cannot maintain this
3680 * interface in its operation mode anymore. The most likely use for
3681 * this is to indicate that AP mode operation is not available due to
3682 * operating channel would need to be changed to a DFS channel when
3683 * the driver does not support radar detection and another virtual
3684 * interfaces caused the operating channel to change. Other similar
3685 * resource conflicts could also trigger this for station mode
3686 * interfaces. This event can be propagated when channel switching
3689 EVENT_INTERFACE_UNAVAILABLE,
3692 * EVENT_BEST_CHANNEL
3694 * Driver generates this event whenever it detects a better channel
3695 * (e.g., based on RSSI or channel use). This information can be used
3696 * to improve channel selection for a new AP/P2P group.
3701 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3703 * This event should be called when a Deauthentication frame is dropped
3704 * due to it not being protected (MFP/IEEE 802.11w).
3705 * union wpa_event_data::unprot_deauth is required to provide more
3706 * details of the frame.
3708 EVENT_UNPROT_DEAUTH,
3711 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3713 * This event should be called when a Disassociation frame is dropped
3714 * due to it not being protected (MFP/IEEE 802.11w).
3715 * union wpa_event_data::unprot_disassoc is required to provide more
3716 * details of the frame.
3718 EVENT_UNPROT_DISASSOC,
3721 * EVENT_STATION_LOW_ACK
3723 * Driver generates this event whenever it detected that a particular
3724 * station was lost. Detection can be through massive transmission
3725 * failures for example.
3727 EVENT_STATION_LOW_ACK,
3730 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3732 EVENT_IBSS_PEER_LOST,
3735 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3737 * This event carries the new replay counter to notify wpa_supplicant
3738 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3739 * completed Group Key Handshake while the host (including
3740 * wpa_supplicant was sleeping).
3742 EVENT_DRIVER_GTK_REKEY,
3745 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3747 EVENT_SCHED_SCAN_STOPPED,
3750 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3752 * This event indicates that the station responded to the poll
3753 * initiated with @poll_client.
3755 EVENT_DRIVER_CLIENT_POLL_OK,
3758 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3760 EVENT_EAPOL_TX_STATUS,
3763 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3765 * Described in wpa_event_data.ch_switch
3770 * EVENT_WNM - Request WNM operation
3772 * This event can be used to request a WNM operation to be performed.
3777 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3779 * This event indicates that the driver reported a connection failure
3780 * with the specified client (for example, max client reached, etc.) in
3783 EVENT_CONNECT_FAILED_REASON,
3786 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
3788 * A radar has been detected on the supplied frequency, hostapd should
3789 * react accordingly (e.g., change channel).
3791 EVENT_DFS_RADAR_DETECTED,
3794 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
3796 * After a successful CAC, the channel can be marked clear and used.
3798 EVENT_DFS_CAC_FINISHED,
3801 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
3803 * The CAC was not successful, and the channel remains in the previous
3804 * state. This may happen due to a radar beeing detected or other
3805 * external influences.
3807 EVENT_DFS_CAC_ABORTED,
3810 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
3812 * The channel which was previously unavailable is now available again.
3814 EVENT_DFS_NOP_FINISHED,
3817 * EVENT_SURVEY - Received survey data
3819 * This event gets triggered when a driver query is issued for survey
3820 * data and the requested data becomes available. The returned data is
3821 * stored in struct survey_results. The results provide at most one
3822 * survey entry for each frequency and at minimum will provide one
3823 * survey entry for one frequency. The survey data can be os_malloc()'d
3824 * and then os_free()'d, so the event callback must only copy data.
3829 * EVENT_SCAN_STARTED - Scan started
3831 * This indicates that driver has started a scan operation either based
3832 * on a request from wpa_supplicant/hostapd or from another application.
3833 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3834 * completed (either successfully or by getting cancelled).
3839 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3841 * This event indicates a set of frequency ranges that should be avoided
3842 * to reduce issues due to interference or internal co-existence
3843 * information in the driver.
3845 EVENT_AVOID_FREQUENCIES,
3848 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3850 EVENT_NEW_PEER_CANDIDATE,
3853 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
3855 * Indicates a pair of primary and secondary channels chosen by ACS
3858 EVENT_ACS_CHANNEL_SELECTED,
3861 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
3864 * This event indicates that channel availability check has been started
3865 * on a DFS frequency by a driver that supports DFS Offload.
3867 EVENT_DFS_CAC_STARTED,
3872 * struct freq_survey - Channel survey info
3874 * @ifidx: Interface index in which this survey was observed
3875 * @freq: Center of frequency of the surveyed channel
3876 * @nf: Channel noise floor in dBm
3877 * @channel_time: Amount of time in ms the radio spent on the channel
3878 * @channel_time_busy: Amount of time in ms the radio detected some signal
3879 * that indicated to the radio the channel was not clear
3880 * @channel_time_rx: Amount of time the radio spent receiving data
3881 * @channel_time_tx: Amount of time the radio spent transmitting data
3882 * @filled: bitmask indicating which fields have been reported, see
3883 * SURVEY_HAS_* defines.
3884 * @list: Internal list pointers
3886 struct freq_survey {
3891 u64 channel_time_busy;
3892 u64 channel_time_rx;
3893 u64 channel_time_tx;
3894 unsigned int filled;
3895 struct dl_list list;
3898 #define SURVEY_HAS_NF BIT(0)
3899 #define SURVEY_HAS_CHAN_TIME BIT(1)
3900 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3901 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3902 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3906 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3908 union wpa_event_data {
3910 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3912 * This structure is optional for EVENT_ASSOC calls and required for
3913 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3914 * driver interface does not need to generate separate EVENT_ASSOCINFO
3919 * reassoc - Flag to indicate association or reassociation
3924 * req_ies - (Re)Association Request IEs
3926 * If the driver generates WPA/RSN IE, this event data must be
3927 * returned for WPA handshake to have needed information. If
3928 * wpa_supplicant-generated WPA/RSN IE is used, this
3929 * information event is optional.
3931 * This should start with the first IE (fixed fields before IEs
3932 * are not included).
3937 * req_ies_len - Length of req_ies in bytes
3942 * resp_ies - (Re)Association Response IEs
3944 * Optional association data from the driver. This data is not
3945 * required WPA, but may be useful for some protocols and as
3946 * such, should be reported if this is available to the driver
3949 * This should start with the first IE (fixed fields before IEs
3950 * are not included).
3955 * resp_ies_len - Length of resp_ies in bytes
3957 size_t resp_ies_len;
3960 * beacon_ies - Beacon or Probe Response IEs
3962 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3963 * Probe Response frames from the current AP (i.e., the one
3964 * that the client just associated with). This information is
3965 * used to update WPA/RSN IE for the AP. If this field is not
3966 * set, the results from previous scan will be used. If no
3967 * data for the new AP is found, scan results will be requested
3968 * again (without scan request). At this point, the driver is
3969 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3972 * This should start with the first IE (fixed fields before IEs
3973 * are not included).
3975 const u8 *beacon_ies;
3978 * beacon_ies_len - Length of beacon_ies */
3979 size_t beacon_ies_len;
3982 * freq - Frequency of the operational channel in MHz
3987 * wmm_params - WMM parameters used in this association.
3989 struct wmm_params wmm_params;
3992 * addr - Station address (for AP mode)
3997 * The following is the key management offload information
4000 * @key_replay_ctr_len
4008 * authorized - Status of key management offload,
4014 * key_replay_ctr - Key replay counter value last used
4015 * in a valid EAPOL-Key frame
4017 const u8 *key_replay_ctr;
4020 * key_replay_ctr_len - The length of key_replay_ctr
4022 size_t key_replay_ctr_len;
4025 * ptk_kck - The derived PTK KCK
4030 * ptk_kek_len - The length of ptk_kck
4035 * ptk_kek - The derived PTK KEK
4040 * ptk_kek_len - The length of ptk_kek
4046 * struct disassoc_info - Data for EVENT_DISASSOC events
4048 struct disassoc_info {
4050 * addr - Station address (for AP mode)
4055 * reason_code - Reason Code (host byte order) used in
4056 * Deauthentication frame
4061 * ie - Optional IE(s) in Disassociation frame
4066 * ie_len - Length of ie buffer in octets
4071 * locally_generated - Whether the frame was locally generated
4073 int locally_generated;
4077 * struct deauth_info - Data for EVENT_DEAUTH events
4079 struct deauth_info {
4081 * addr - Station address (for AP mode)
4086 * reason_code - Reason Code (host byte order) used in
4087 * Deauthentication frame
4092 * ie - Optional IE(s) in Deauthentication frame
4097 * ie_len - Length of ie buffer in octets
4102 * locally_generated - Whether the frame was locally generated
4104 int locally_generated;
4108 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4110 struct michael_mic_failure {
4113 } michael_mic_failure;
4116 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4118 struct interface_status {
4121 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4126 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4128 struct pmkid_candidate {
4129 /** BSSID of the PMKID candidate */
4131 /** Smaller the index, higher the priority */
4133 /** Whether RSN IE includes pre-authenticate flag */
4138 * struct stkstart - Data for EVENT_STKSTART
4145 * struct tdls - Data for EVENT_TDLS
4151 TDLS_REQUEST_TEARDOWN,
4152 TDLS_REQUEST_DISCOVER,
4154 u16 reason_code; /* for teardown */
4158 * struct wnm - Data for EVENT_WNM
4176 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4178 * During FT (IEEE 802.11r) authentication sequence, the driver is
4179 * expected to use this event to report received FT IEs (MDIE, FTIE,
4180 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4181 * IEs for the next message will be delivered through the
4182 * struct wpa_driver_ops::update_ft_ies() callback.
4188 u8 target_ap[ETH_ALEN];
4189 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4191 /** Length of ric_ies buffer in octets */
4196 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4198 struct ibss_rsn_start {
4203 * struct auth_info - Data for EVENT_AUTH events
4209 u16 auth_transaction;
4216 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4218 struct assoc_reject {
4220 * bssid - BSSID of the AP that rejected association
4225 * resp_ies - (Re)Association Response IEs
4227 * Optional association data from the driver. This data is not
4228 * required WPA, but may be useful for some protocols and as
4229 * such, should be reported if this is available to the driver
4232 * This should start with the first IE (fixed fields before IEs
4233 * are not included).
4238 * resp_ies_len - Length of resp_ies in bytes
4240 size_t resp_ies_len;
4243 * status_code - Status Code from (Re)association Response
4248 struct timeout_event {
4253 * struct tx_status - Data for EVENT_TX_STATUS events
4265 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4267 struct rx_from_unknown {
4274 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4282 * drv_priv - Pointer to store driver private BSS information
4284 * If not set to NULL, this is used for comparison with
4285 * hostapd_data->drv_priv to determine which BSS should process
4291 * freq - Frequency (in MHz) on which the frame was received
4296 * ssi_signal - Signal strength in dBm (or 0 if not available)
4302 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4304 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4306 struct remain_on_channel {
4308 * freq - Channel frequency in MHz
4313 * duration - Duration to remain on the channel in milliseconds
4315 unsigned int duration;
4316 } remain_on_channel;
4319 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4320 * @aborted: Whether the scan was aborted
4321 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4322 * @num_freqs: Number of entries in freqs array
4323 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4325 * @num_ssids: Number of entries in ssids array
4331 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4336 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4338 struct rx_probe_req {
4340 * sa - Source address of the received Probe Request frame
4345 * da - Destination address of the received Probe Request frame
4346 * or %NULL if not available
4351 * bssid - BSSID of the received Probe Request frame or %NULL
4357 * ie - IEs from the Probe Request body
4362 * ie_len - Length of ie buffer in octets
4367 * signal - signal strength in dBm (or 0 if not available)
4373 * struct new_sta - Data for EVENT_NEW_STA events
4380 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4389 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4391 struct wpa_signal_info signal_change;
4394 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4395 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4396 * @freq_5: Best 5 GHz band channel frequency in MHz
4397 * @freq_overall: Best channel frequency in MHz
4399 * 0 can be used to indicate no preference in either band.
4401 struct best_channel {
4407 struct unprot_deauth {
4413 struct unprot_disassoc {
4420 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4421 * @addr: station address
4428 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4430 struct ibss_peer_lost {
4435 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4437 struct driver_gtk_rekey {
4439 const u8 *replay_ctr;
4443 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4444 * @addr: station address
4446 struct client_poll {
4451 * struct eapol_tx_status
4452 * @dst: Original destination
4453 * @data: Data starting with IEEE 802.1X header (!)
4454 * @data_len: Length of data
4455 * @ack: Indicates ack or lost frame
4457 * This corresponds to hapd_send_eapol if the frame sent
4458 * there isn't just reported as EVENT_TX_STATUS.
4460 struct eapol_tx_status {
4469 * @freq: Frequency of new channel in MHz
4470 * @ht_enabled: Whether this is an HT channel
4471 * @ch_offset: Secondary channel offset
4472 * @ch_width: Channel width
4473 * @cf1: Center frequency 1
4474 * @cf2: Center frequency 2
4480 enum chan_width ch_width;
4486 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4487 * @addr: Remote client address
4488 * @code: Reason code for connection failure
4490 struct connect_failed_reason {
4496 } connect_failed_reason;
4499 * struct dfs_event - Data for radar detected events
4500 * @freq: Frequency of the channel in MHz
4506 enum chan_width chan_width;
4512 * survey_results - Survey result data for EVENT_SURVEY
4513 * @freq_filter: Requested frequency survey filter, 0 if request
4514 * was for all survey data
4515 * @survey_list: Linked list of survey data (struct freq_survey)
4517 struct survey_results {
4518 unsigned int freq_filter;
4519 struct dl_list survey_list; /* struct freq_survey */
4523 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4524 * @initiator: Initiator of the regulatory change
4525 * @type: Regulatory change type
4526 * @alpha2: Country code (or "" if not available)
4528 struct channel_list_changed {
4529 enum reg_change_initiator initiator;
4532 } channel_list_changed;
4535 * freq_range - List of frequency ranges
4537 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4539 struct wpa_freq_range_list freq_range;
4544 * @peer: Peer address
4546 * @ie_len: Length of @ies
4548 * Notification of new candidate mesh peer.
4557 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4558 * @pri_channel: Selected primary channel
4559 * @sec_channel: Selected secondary channel
4561 struct acs_selected_channels {
4564 } acs_selected_channels;
4568 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4569 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4570 * with struct wpa_driver_ops::init()
4571 * @event: event type (defined above)
4572 * @data: possible extra data for the event
4574 * Driver wrapper code should call this function whenever an event is received
4577 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4578 union wpa_event_data *data);
4582 * The following inline functions are provided for convenience to simplify
4583 * event indication for some of the common events.
4586 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4587 size_t ielen, int reassoc)
4589 union wpa_event_data event;
4590 os_memset(&event, 0, sizeof(event));
4591 event.assoc_info.reassoc = reassoc;
4592 event.assoc_info.req_ies = ie;
4593 event.assoc_info.req_ies_len = ielen;
4594 event.assoc_info.addr = addr;
4595 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4598 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4600 union wpa_event_data event;
4601 os_memset(&event, 0, sizeof(event));
4602 event.disassoc_info.addr = addr;
4603 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4606 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4609 union wpa_event_data event;
4610 os_memset(&event, 0, sizeof(event));
4611 event.eapol_rx.src = src;
4612 event.eapol_rx.data = data;
4613 event.eapol_rx.data_len = data_len;
4614 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4617 /* driver_common.c */
4618 void wpa_scan_results_free(struct wpa_scan_results *res);
4620 /* Convert wpa_event_type to a string for logging */
4621 const char * event_to_string(enum wpa_event_type event);
4623 /* Convert chan_width to a string for logging and control interfaces */
4624 const char * channel_width_to_string(enum chan_width width);
4626 int ht_supported(const struct hostapd_hw_modes *mode);
4627 int vht_supported(const struct hostapd_hw_modes *mode);
4629 struct wowlan_triggers *
4630 wpa_get_wowlan_triggers(const char *wowlan_triggers,
4631 const struct wpa_driver_capa *capa);
4633 /* NULL terminated array of linked in driver wrappers */
4634 extern struct wpa_driver_ops *wpa_drivers[];
4636 #endif /* DRIVER_H */