2 * Driver interface definition
3 * Copyright (c) 2003-2015, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
8 * This file defines a driver interface used by both %wpa_supplicant and
9 * hostapd. The first part of the file defines data structures used in various
10 * driver operations. This is followed by the struct wpa_driver_ops that each
11 * driver wrapper will beed to define with callback functions for requesting
12 * driver operations. After this, there are definitions for driver event
13 * reporting with wpa_supplicant_event() and some convenience helper functions
14 * that can be used to report events.
20 #define WPA_SUPPLICANT_DRIVER_VERSION 4
22 #include "common/defs.h"
23 #include "common/ieee802_11_defs.h"
24 #include "utils/list.h"
26 #define HOSTAPD_CHAN_DISABLED 0x00000001
27 #define HOSTAPD_CHAN_NO_IR 0x00000002
28 #define HOSTAPD_CHAN_RADAR 0x00000008
29 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
30 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
31 #define HOSTAPD_CHAN_HT40 0x00000040
32 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
34 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
35 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
36 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
37 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
38 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
40 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
41 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
42 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
43 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
45 #define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
46 #define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
48 #define HOSTAPD_CHAN_VHT_10_150 0x00100000
49 #define HOSTAPD_CHAN_VHT_30_130 0x00200000
50 #define HOSTAPD_CHAN_VHT_50_110 0x00400000
51 #define HOSTAPD_CHAN_VHT_70_90 0x00800000
52 #define HOSTAPD_CHAN_VHT_90_70 0x01000000
53 #define HOSTAPD_CHAN_VHT_110_50 0x02000000
54 #define HOSTAPD_CHAN_VHT_130_30 0x04000000
55 #define HOSTAPD_CHAN_VHT_150_10 0x08000000
58 * enum reg_change_initiator - Regulatory change initiator
60 enum reg_change_initiator {
64 REGDOM_SET_BY_COUNTRY_IE,
69 * enum reg_type - Regulatory change types
75 REGDOM_TYPE_CUSTOM_WORLD,
76 REGDOM_TYPE_INTERSECTION,
80 * struct hostapd_channel_data - Channel information
82 struct hostapd_channel_data {
84 * chan - Channel number (IEEE 802.11)
89 * freq - Frequency in MHz
94 * flag - Channel flags (HOSTAPD_CHAN_*)
99 * max_tx_power - Regulatory transmit power limit in dBm
104 * survey_list - Linked list of surveys (struct freq_survey)
106 struct dl_list survey_list;
109 * min_nf - Minimum observed noise floor, in dBm, based on all
110 * surveyed channel data
116 * interference_factor - Computed interference factor on this
117 * channel (used internally in src/ap/acs.c; driver wrappers do not
120 long double interference_factor;
121 #endif /* CONFIG_ACS */
124 * dfs_cac_ms - DFS CAC time in milliseconds
126 unsigned int dfs_cac_ms;
129 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
130 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
133 * struct hostapd_hw_modes - Supported hardware mode information
135 struct hostapd_hw_modes {
137 * mode - Hardware mode
139 enum hostapd_hw_mode mode;
142 * num_channels - Number of entries in the channels array
147 * channels - Array of supported channels
149 struct hostapd_channel_data *channels;
152 * num_rates - Number of entries in the rates array
157 * rates - Array of supported rates in 100 kbps units
162 * ht_capab - HT (IEEE 802.11n) capabilities
167 * mcs_set - MCS (IEEE 802.11n) rate parameters
172 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
177 * vht_capab - VHT (IEEE 802.11ac) capabilities
182 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
186 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
190 #define IEEE80211_MODE_INFRA 0
191 #define IEEE80211_MODE_IBSS 1
192 #define IEEE80211_MODE_AP 2
193 #define IEEE80211_MODE_MESH 5
195 #define IEEE80211_CAP_ESS 0x0001
196 #define IEEE80211_CAP_IBSS 0x0002
197 #define IEEE80211_CAP_PRIVACY 0x0010
198 #define IEEE80211_CAP_RRM 0x1000
200 /* DMG (60 GHz) IEEE 802.11ad */
201 /* type - bits 0..1 */
202 #define IEEE80211_CAP_DMG_MASK 0x0003
203 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
204 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
205 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
207 #define WPA_SCAN_QUAL_INVALID BIT(0)
208 #define WPA_SCAN_NOISE_INVALID BIT(1)
209 #define WPA_SCAN_LEVEL_INVALID BIT(2)
210 #define WPA_SCAN_LEVEL_DBM BIT(3)
211 #define WPA_SCAN_ASSOCIATED BIT(5)
214 * struct wpa_scan_res - Scan result for an BSS/IBSS
215 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
217 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
218 * @beacon_int: beacon interval in TUs (host byte order)
219 * @caps: capability information field in host byte order
220 * @qual: signal quality
221 * @noise: noise level
222 * @level: signal level
224 * @age: Age of the information in milliseconds (i.e., how many milliseconds
225 * ago the last Beacon or Probe Response frame was received)
226 * @est_throughput: Estimated throughput in kbps (this is calculated during
227 * scan result processing if left zero by the driver wrapper)
228 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
229 * @ie_len: length of the following IE field in octets
230 * @beacon_ie_len: length of the following Beacon IE field in octets
232 * This structure is used as a generic format for scan results from the
233 * driver. Each driver interface implementation is responsible for converting
234 * the driver or OS specific scan results into this format.
236 * If the driver does not support reporting all IEs, the IE data structure is
237 * constructed of the IEs that are available. This field will also need to
238 * include SSID in IE format. All drivers are encouraged to be extended to
239 * report all IEs to make it easier to support future additions.
241 * This structure data is followed by ie_len octets of IEs from Probe Response
242 * frame (or if the driver does not indicate source of IEs, these may also be
243 * from Beacon frame). After the first set of IEs, another set of IEs may follow
244 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
246 struct wpa_scan_res {
257 unsigned int est_throughput;
260 size_t beacon_ie_len;
261 /* Followed by ie_len + beacon_ie_len octets of IE data */
265 * struct wpa_scan_results - Scan results
266 * @res: Array of pointers to allocated variable length scan result entries
267 * @num: Number of entries in the scan result array
268 * @fetch_time: Time when the results were fetched from the driver
270 struct wpa_scan_results {
271 struct wpa_scan_res **res;
273 struct os_reltime fetch_time;
277 * struct wpa_interface_info - Network interface information
278 * @next: Pointer to the next interface or NULL if this is the last one
279 * @ifname: Interface name that can be used with init() or init2()
280 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
282 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
283 * is not an allocated copy, i.e., get_interfaces() caller will not free
286 struct wpa_interface_info {
287 struct wpa_interface_info *next;
290 const char *drv_name;
293 #define WPAS_MAX_SCAN_SSIDS 16
296 * struct wpa_driver_scan_ssid - SSIDs to scan for
297 * @ssid - specific SSID to scan for (ProbeReq)
298 * %NULL or zero-length SSID is used to indicate active scan
299 * with wildcard SSID.
300 * @ssid_len - Length of the SSID in octets
302 struct wpa_driver_scan_ssid {
308 * struct wpa_driver_scan_params - Scan parameters
309 * Data for struct wpa_driver_ops::scan2().
311 struct wpa_driver_scan_params {
313 * ssids - SSIDs to scan for
315 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
318 * num_ssids - Number of entries in ssids array
319 * Zero indicates a request for a passive scan.
324 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
329 * extra_ies_len - Length of extra_ies in octets
331 size_t extra_ies_len;
334 * freqs - Array of frequencies to scan or %NULL for all frequencies
336 * The frequency is set in MHz. The array is zero-terminated.
341 * filter_ssids - Filter for reporting SSIDs
343 * This optional parameter can be used to request the driver wrapper to
344 * filter scan results to include only the specified SSIDs. %NULL
345 * indicates that no filtering is to be done. This can be used to
346 * reduce memory needs for scan results in environments that have large
347 * number of APs with different SSIDs.
349 * The driver wrapper is allowed to take this allocated buffer into its
350 * own use by setting the pointer to %NULL. In that case, the driver
351 * wrapper is responsible for freeing the buffer with os_free() once it
352 * is not needed anymore.
354 struct wpa_driver_scan_filter {
355 u8 ssid[SSID_MAX_LEN];
360 * num_filter_ssids - Number of entries in filter_ssids array
362 size_t num_filter_ssids;
365 * filter_rssi - Filter by RSSI
367 * The driver may filter scan results in firmware to reduce host
368 * wakeups and thereby save power. Specify the RSSI threshold in s32
374 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
376 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
377 * Mbps from the support rates element(s) in the Probe Request frames
378 * and not to transmit the frames at any of those rates.
380 unsigned int p2p_probe:1;
383 * only_new_results - Request driver to report only new results
385 * This is used to request the driver to report only BSSes that have
386 * been detected after this scan request has been started, i.e., to
387 * flush old cached BSS entries.
389 unsigned int only_new_results:1;
392 * low_priority - Requests driver to use a lower scan priority
394 * This is used to request the driver to use a lower scan priority
395 * if it supports such a thing.
397 unsigned int low_priority:1;
400 * mac_addr_rand - Requests driver to randomize MAC address
402 unsigned int mac_addr_rand:1;
405 * mac_addr - MAC address used with randomization. The address cannot be
406 * a multicast one, i.e., bit 0 of byte 0 should not be set.
411 * mac_addr_mask - MAC address mask used with randomization.
413 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
414 * the mask should be taken as is from mac_addr. The mask should not
415 * allow the generation of a multicast address, i.e., bit 0 of byte 0
418 const u8 *mac_addr_mask;
421 * sched_scan_plans - Scan plans for scheduled scan
423 * Each scan plan consists of the number of iterations to scan and the
424 * interval between scans. When a scan plan finishes (i.e., it was run
425 * for the specified number of iterations), the next scan plan is
426 * executed. The scan plans are executed in the order they appear in
427 * the array (lower index first). The last scan plan will run infinitely
428 * (until requested to stop), thus must not specify the number of
429 * iterations. All other scan plans must specify the number of
432 struct sched_scan_plan {
433 u32 interval; /* In seconds */
434 u32 iterations; /* Zero to run infinitely */
438 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
440 unsigned int sched_scan_plans_num;
443 * bssid - Specific BSSID to scan for
445 * This optional parameter can be used to replace the default wildcard
446 * BSSID with a specific BSSID to scan for if results are needed from
452 * NOTE: Whenever adding new parameters here, please make sure
453 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
459 * struct wpa_driver_auth_params - Authentication parameters
460 * Data for struct wpa_driver_ops::authenticate().
462 struct wpa_driver_auth_params {
470 const u8 *wep_key[4];
471 size_t wep_key_len[4];
473 int local_state_change;
476 * p2p - Whether this connection is a P2P group
481 * sae_data - SAE elements for Authentication frame
483 * This buffer starts with the Authentication transaction sequence
484 * number field. If SAE is not used, this pointer is %NULL.
489 * sae_data_len - Length of sae_data buffer in octets
495 * enum wps_mode - WPS mode
499 * WPS_MODE_NONE - No WPS provisioning being used
504 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
509 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
515 * struct hostapd_freq_params - Channel parameters
517 struct hostapd_freq_params {
519 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
521 enum hostapd_hw_mode mode;
524 * freq - Primary channel center frequency in MHz
529 * channel - Channel number
534 * ht_enabled - Whether HT is enabled
539 * sec_channel_offset - Secondary channel offset for HT40
542 * -1 = HT40 enabled, secondary channel below primary,
543 * 1 = HT40 enabled, secondary channel above primary
545 int sec_channel_offset;
548 * vht_enabled - Whether VHT is enabled
553 * center_freq1 - Segment 0 center frequency in MHz
555 * Valid for both HT and VHT.
560 * center_freq2 - Segment 1 center frequency in MHz
562 * Non-zero only for bandwidth 80 and an 80+80 channel
567 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
573 * struct wpa_driver_associate_params - Association parameters
574 * Data for struct wpa_driver_ops::associate().
576 struct wpa_driver_associate_params {
578 * bssid - BSSID of the selected AP
579 * This can be %NULL, if ap_scan=2 mode is used and the driver is
580 * responsible for selecting with which BSS to associate. */
584 * bssid_hint - BSSID of a proposed AP
586 * This indicates which BSS has been found a suitable candidate for
587 * initial association for drivers that use driver/firmwate-based BSS
588 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
589 * the driver from selecting other BSSes in the ESS.
591 const u8 *bssid_hint;
594 * ssid - The selected SSID
599 * ssid_len - Length of the SSID (1..32)
604 * freq - channel parameters
606 struct hostapd_freq_params freq;
609 * freq_hint - Frequency of the channel the proposed AP is using
611 * This provides a channel on which a suitable BSS has been found as a
612 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
613 * limit the driver from selecting other channels for
614 * driver/firmware-based BSS selection.
619 * bg_scan_period - Background scan period in seconds, 0 to disable
620 * background scan, or -1 to indicate no change to default driver
626 * beacon_int - Beacon interval for IBSS or 0 to use driver default
631 * wpa_ie - WPA information element for (Re)Association Request
632 * WPA information element to be included in (Re)Association
633 * Request (including information element id and length). Use
634 * of this WPA IE is optional. If the driver generates the WPA
635 * IE, it can use pairwise_suite, group_suite, and
636 * key_mgmt_suite to select proper algorithms. In this case,
637 * the driver has to notify wpa_supplicant about the used WPA
638 * IE by generating an event that the interface code will
639 * convert into EVENT_ASSOCINFO data (see below).
641 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
642 * instead. The driver can determine which version is used by
643 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
646 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
651 * wpa_ie_len - length of the wpa_ie
656 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
658 unsigned int wpa_proto;
661 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
663 * This is usually ignored if @wpa_ie is used.
665 unsigned int pairwise_suite;
668 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
670 * This is usually ignored if @wpa_ie is used.
672 unsigned int group_suite;
675 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
677 * This is usually ignored if @wpa_ie is used.
679 unsigned int key_mgmt_suite;
682 * auth_alg - Allowed authentication algorithms
683 * Bit field of WPA_AUTH_ALG_*
688 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
693 * wep_key - WEP keys for static WEP configuration
695 const u8 *wep_key[4];
698 * wep_key_len - WEP key length for static WEP configuration
700 size_t wep_key_len[4];
703 * wep_tx_keyidx - WEP TX key index for static WEP configuration
708 * mgmt_frame_protection - IEEE 802.11w management frame protection
710 enum mfp_options mgmt_frame_protection;
713 * ft_ies - IEEE 802.11r / FT information elements
714 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
715 * for fast transition, this parameter is set to include the IEs that
716 * are to be sent in the next FT Authentication Request message.
717 * update_ft_ies() handler is called to update the IEs for further
718 * FT messages in the sequence.
720 * The driver should use these IEs only if the target AP is advertising
721 * the same mobility domain as the one included in the MDIE here.
723 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
724 * AP after the initial association. These IEs can only be used if the
725 * target AP is advertising support for FT and is using the same MDIE
726 * and SSID as the current AP.
728 * The driver is responsible for reporting the FT IEs received from the
729 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
730 * type. update_ft_ies() handler will then be called with the FT IEs to
731 * include in the next frame in the authentication sequence.
736 * ft_ies_len - Length of ft_ies in bytes
741 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
743 * This value is provided to allow the driver interface easier access
744 * to the current mobility domain. This value is set to %NULL if no
745 * mobility domain is currently active.
750 * passphrase - RSN passphrase for PSK
752 * This value is made available only for WPA/WPA2-Personal (PSK) and
753 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
754 * the 8..63 character ASCII passphrase, if available. Please note that
755 * this can be %NULL if passphrase was not used to generate the PSK. In
756 * that case, the psk field must be used to fetch the PSK.
758 const char *passphrase;
761 * psk - RSN PSK (alternative for passphrase for PSK)
763 * This value is made available only for WPA/WPA2-Personal (PSK) and
764 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
765 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
766 * be prepared to handle %NULL value as an error.
771 * drop_unencrypted - Enable/disable unencrypted frame filtering
773 * Configure the driver to drop all non-EAPOL frames (both receive and
774 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
775 * still be allowed for key negotiation.
777 int drop_unencrypted;
780 * prev_bssid - Previously used BSSID in this ESS
782 * When not %NULL, this is a request to use reassociation instead of
785 const u8 *prev_bssid;
790 * If the driver needs to do special configuration for WPS association,
791 * this variable provides more information on what type of association
792 * is being requested. Most drivers should not need ot use this.
797 * p2p - Whether this connection is a P2P group
802 * uapsd - UAPSD parameters for the network
803 * -1 = do not change defaults
804 * AP mode: 1 = enabled, 0 = disabled
805 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
810 * fixed_bssid - Whether to force this BSSID in IBSS mode
811 * 1 = Fix this BSSID and prevent merges.
812 * 0 = Do not fix BSSID.
817 * fixed_freq - Fix control channel in IBSS mode
818 * 0 = don't fix control channel (default)
819 * 1 = fix control channel; this prevents IBSS merging with another
825 * disable_ht - Disable HT (IEEE 802.11n) for this connection
830 * htcaps - HT Capabilities over-rides
832 * Only bits set in the mask will be used, and not all values are used
833 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
835 * Pointer to struct ieee80211_ht_capabilities.
840 * htcaps_mask - HT Capabilities over-rides mask
842 * Pointer to struct ieee80211_ht_capabilities.
844 const u8 *htcaps_mask;
846 #ifdef CONFIG_VHT_OVERRIDES
848 * disable_vht - Disable VHT for this connection
853 * VHT capability overrides.
855 const struct ieee80211_vht_capabilities *vhtcaps;
856 const struct ieee80211_vht_capabilities *vhtcaps_mask;
857 #endif /* CONFIG_VHT_OVERRIDES */
860 * req_key_mgmt_offload - Request key management offload for connection
862 * Request key management offload for this connection if the device
865 int req_key_mgmt_offload;
868 * Flag for indicating whether this association includes support for
869 * RRM (Radio Resource Measurements)
874 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
875 * AP as usual. Valid for DMG network only.
882 HIDDEN_SSID_ZERO_LEN,
883 HIDDEN_SSID_ZERO_CONTENTS
886 struct wowlan_triggers {
890 u8 gtk_rekey_failure;
892 u8 four_way_handshake;
896 struct wpa_driver_ap_params {
898 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
903 * head_len - Length of the head buffer in octets
908 * tail - Beacon tail following TIM IE
913 * tail_len - Length of the tail buffer in octets
918 * dtim_period - DTIM period
923 * beacon_int - Beacon interval
928 * basic_rates: -1 terminated array of basic rates in 100 kbps
930 * This parameter can be used to set a specific basic rate set for the
931 * BSS. If %NULL, default basic rate set is used.
936 * proberesp - Probe Response template
938 * This is used by drivers that reply to Probe Requests internally in
939 * AP mode and require the full Probe Response template.
944 * proberesp_len - Length of the proberesp buffer in octets
946 size_t proberesp_len;
949 * ssid - The SSID to use in Beacon/Probe Response frames
954 * ssid_len - Length of the SSID (1..32)
959 * hide_ssid - Whether to hide the SSID
961 enum hide_ssid hide_ssid;
964 * pairwise_ciphers - WPA_CIPHER_* bitfield
966 unsigned int pairwise_ciphers;
969 * group_cipher - WPA_CIPHER_*
971 unsigned int group_cipher;
974 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
976 unsigned int key_mgmt_suites;
979 * auth_algs - WPA_AUTH_ALG_* bitfield
981 unsigned int auth_algs;
984 * wpa_version - WPA_PROTO_* bitfield
986 unsigned int wpa_version;
989 * privacy - Whether privacy is used in the BSS
994 * beacon_ies - WPS/P2P IE(s) for Beacon frames
996 * This is used to add IEs like WPS IE and P2P IE by drivers that do
997 * not use the full Beacon template.
999 const struct wpabuf *beacon_ies;
1002 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1004 * This is used to add IEs like WPS IE and P2P IE by drivers that
1005 * reply to Probe Request frames internally.
1007 const struct wpabuf *proberesp_ies;
1010 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1012 * This is used to add IEs like WPS IE by drivers that reply to
1013 * (Re)Association Request frames internally.
1015 const struct wpabuf *assocresp_ies;
1018 * isolate - Whether to isolate frames between associated stations
1020 * If this is non-zero, the AP is requested to disable forwarding of
1021 * frames between associated stations.
1026 * cts_protect - Whether CTS protection is enabled
1031 * preamble - Whether short preamble is enabled
1036 * short_slot_time - Whether short slot time is enabled
1038 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1039 * not set (e.g., when 802.11g mode is not in use)
1041 int short_slot_time;
1044 * ht_opmode - HT operation mode or -1 if HT not in use
1049 * interworking - Whether Interworking is enabled
1054 * hessid - Homogeneous ESS identifier or %NULL if not set
1059 * access_network_type - Access Network Type (0..15)
1061 * This is used for filtering Probe Request frames when Interworking is
1064 u8 access_network_type;
1067 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1069 * This is used by driver which advertises this capability.
1071 int ap_max_inactivity;
1074 * ctwindow - Client Traffic Window (in TUs)
1079 * smps_mode - SMPS mode
1081 * SMPS mode to be used by the AP, specified as the relevant bits of
1082 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1084 unsigned int smps_mode;
1087 * disable_dgaf - Whether group-addressed frames are disabled
1092 * osen - Whether OSEN security is enabled
1097 * freq - Channel parameters for dynamic bandwidth changes
1099 struct hostapd_freq_params *freq;
1102 * reenable - Whether this is to re-enable beaconing
1107 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1108 * infrastructure BSS. Valid only for DMG network.
1113 struct wpa_driver_mesh_bss_params {
1114 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1116 * TODO: Other mesh configuration parameters would go here.
1117 * See NL80211_MESHCONF_* for all the mesh config parameters.
1120 int peer_link_timeout;
1123 struct wpa_driver_mesh_join_params {
1126 const int *basic_rates;
1129 struct hostapd_freq_params freq;
1132 struct wpa_driver_mesh_bss_params conf;
1133 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1134 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1135 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1136 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1141 * struct wpa_driver_capa - Driver capability information
1143 struct wpa_driver_capa {
1144 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1145 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1146 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1147 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1148 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1149 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1150 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1151 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1152 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1153 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
1154 /** Bitfield of supported key management suites */
1155 unsigned int key_mgmt;
1157 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1158 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1159 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1160 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1161 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1162 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1163 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1164 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1165 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1166 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1167 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1168 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1169 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1170 /** Bitfield of supported cipher suites */
1173 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1174 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1175 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1176 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1179 /** Driver generated WPA/RSN IE */
1180 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1181 /** Driver needs static WEP key setup after association command */
1182 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1183 /** Driver takes care of all DFS operations */
1184 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1185 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1186 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1187 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1188 /** Driver is for a wired Ethernet interface */
1189 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1190 /** Driver provides separate commands for authentication and association (SME in
1191 * wpa_supplicant). */
1192 #define WPA_DRIVER_FLAGS_SME 0x00000020
1193 /** Driver supports AP mode */
1194 #define WPA_DRIVER_FLAGS_AP 0x00000040
1195 /** Driver needs static WEP key setup after association has been completed */
1196 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1197 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1198 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1199 /** Driver supports concurrent P2P operations */
1200 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1202 * Driver uses the initial interface as a dedicated management interface, i.e.,
1203 * it cannot be used for P2P group operations or non-P2P purposes.
1205 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1206 /** This interface is P2P capable (P2P GO or P2P Client) */
1207 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1208 /** Driver supports station and key removal when stopping an AP */
1209 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1211 * Driver uses the initial interface for P2P management interface and non-P2P
1212 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1213 * P2P group operations.
1215 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1217 * Driver is known to use sane error codes, i.e., when it indicates that
1218 * something (e.g., association) fails, there was indeed a failure and the
1219 * operation does not end up getting completed successfully later.
1221 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1222 /** Driver supports off-channel TX */
1223 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1224 /** Driver indicates TX status events for EAPOL Data frames */
1225 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1226 /** Driver indicates TX status events for Deauth/Disassoc frames */
1227 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1228 /** Driver supports roaming (BSS selection) in firmware */
1229 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1230 /** Driver supports operating as a TDLS peer */
1231 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1232 /** Driver requires external TDLS setup/teardown/discovery */
1233 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1234 /** Driver indicates support for Probe Response offloading in AP mode */
1235 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1236 /** Driver supports U-APSD in AP mode */
1237 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1238 /** Driver supports inactivity timer in AP mode */
1239 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1240 /** Driver expects user space implementation of MLME in AP mode */
1241 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1242 /** Driver supports SAE with user space SME */
1243 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1244 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1245 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1246 /** Driver supports IBSS (Ad-hoc) mode */
1247 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1248 /** Driver supports radar detection */
1249 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1250 /** Driver supports a dedicated interface for P2P Device */
1251 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1252 /** Driver supports QoS Mapping */
1253 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1254 /** Driver supports CSA in AP mode */
1255 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1256 /** Driver supports mesh */
1257 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1258 /** Driver support ACS offload */
1259 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1260 /** Driver supports key management offload */
1261 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1262 /** Driver supports TDLS channel switching */
1263 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1264 /** Driver supports IBSS with HT datarates */
1265 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
1266 /** Driver supports IBSS with VHT datarates */
1267 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
1268 /** Driver supports automatic band selection */
1269 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
1270 /** Driver supports simultaneous off-channel operations */
1271 #define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
1272 /** Driver supports full AP client state */
1273 #define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
1276 #define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1277 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1279 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1280 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1281 unsigned int smps_modes;
1283 unsigned int wmm_ac_supported:1;
1285 unsigned int mac_addr_rand_scan_supported:1;
1286 unsigned int mac_addr_rand_sched_scan_supported:1;
1288 /** Maximum number of supported active probe SSIDs */
1291 /** Maximum number of supported active probe SSIDs for sched_scan */
1292 int max_sched_scan_ssids;
1294 /** Maximum number of supported scan plans for scheduled scan */
1295 unsigned int max_sched_scan_plans;
1297 /** Maximum interval in a scan plan. In seconds */
1298 u32 max_sched_scan_plan_interval;
1300 /** Maximum number of iterations in a single scan plan */
1301 u32 max_sched_scan_plan_iterations;
1303 /** Whether sched_scan (offloaded scanning) is supported */
1304 int sched_scan_supported;
1306 /** Maximum number of supported match sets for sched_scan */
1310 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1312 unsigned int max_remain_on_chan;
1315 * max_stations - Maximum number of associated stations the driver
1316 * supports in AP mode
1318 unsigned int max_stations;
1321 * probe_resp_offloads - Bitmap of supported protocols by the driver
1322 * for Probe Response offloading.
1324 /** Driver Probe Response offloading support for WPS ver. 1 */
1325 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1326 /** Driver Probe Response offloading support for WPS ver. 2 */
1327 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1328 /** Driver Probe Response offloading support for P2P */
1329 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1330 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1331 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1332 unsigned int probe_resp_offloads;
1334 unsigned int max_acl_mac_addrs;
1337 * Number of supported concurrent channels
1339 unsigned int num_multichan_concurrent;
1342 * extended_capa - extended capabilities in driver/device
1344 * Must be allocated and freed by driver and the pointers must be
1345 * valid for the lifetime of the driver, i.e., freed in deinit()
1347 const u8 *extended_capa, *extended_capa_mask;
1348 unsigned int extended_capa_len;
1350 struct wowlan_triggers wowlan_triggers;
1352 /** Driver adds the DS Params Set IE in Probe Request frames */
1353 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1354 /** Driver adds the WFA TPC IE in Probe Request frames */
1355 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1356 /** Driver handles quiet period requests */
1357 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1359 * Driver is capable of inserting the current TX power value into the body of
1360 * transmitted frames.
1361 * Background: Some Action frames include a TPC Report IE. This IE contains a
1362 * TX power field, which has to be updated by lower layers. One such Action
1363 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1364 * of spectrum management). Note that this insertion takes place at a fixed
1365 * offset, namely the 6th byte in the Action frame body.
1367 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1370 /* Driver concurrency capabilities */
1371 unsigned int conc_capab;
1372 /* Maximum number of concurrent channels on 2.4 GHz */
1373 unsigned int max_conc_chan_2_4;
1374 /* Maximum number of concurrent channels on 5 GHz */
1375 unsigned int max_conc_chan_5_0;
1377 /* Maximum number of supported CSA counters */
1378 u16 max_csa_counters;
1382 struct hostapd_data;
1384 struct hostap_sta_driver_data {
1385 unsigned long rx_packets, tx_packets;
1386 unsigned long long rx_bytes, tx_bytes;
1387 int bytes_64bit; /* whether 64-bit byte counters are supported */
1388 unsigned long current_tx_rate;
1389 unsigned long inactive_msec;
1390 unsigned long flags;
1391 unsigned long num_ps_buf_frames;
1392 unsigned long tx_retry_failed;
1393 unsigned long tx_retry_count;
1398 struct hostapd_sta_add_params {
1402 const u8 *supp_rates;
1403 size_t supp_rates_len;
1404 u16 listen_interval;
1405 const struct ieee80211_ht_capabilities *ht_capabilities;
1406 const struct ieee80211_vht_capabilities *vht_capabilities;
1407 int vht_opmode_enabled;
1409 u32 flags; /* bitmask of WPA_STA_* flags */
1410 u32 flags_mask; /* unset bits in flags */
1412 enum mesh_plink_state plink_state;
1413 #endif /* CONFIG_MESH */
1414 int set; /* Set STA parameters instead of add */
1416 const u8 *ext_capab;
1417 size_t ext_capab_len;
1418 const u8 *supp_channels;
1419 size_t supp_channels_len;
1420 const u8 *supp_oper_classes;
1421 size_t supp_oper_classes_len;
1425 struct mac_address {
1429 struct hostapd_acl_params {
1431 unsigned int num_mac_acl;
1432 struct mac_address mac_acl[0];
1435 enum wpa_driver_if_type {
1437 * WPA_IF_STATION - Station mode interface
1442 * WPA_IF_AP_VLAN - AP mode VLAN interface
1444 * This interface shares its address and Beacon frame with the main
1450 * WPA_IF_AP_BSS - AP mode BSS interface
1452 * This interface has its own address and Beacon frame.
1457 * WPA_IF_P2P_GO - P2P Group Owner
1462 * WPA_IF_P2P_CLIENT - P2P Client
1467 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1468 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1473 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1474 * abstracted P2P Device function in the driver
1479 * WPA_IF_MESH - Mesh interface
1484 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1489 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1494 struct wpa_init_params {
1498 const char *driver_params;
1499 int use_pae_group_addr;
1503 u8 *own_addr; /* buffer for writing own MAC address */
1507 struct wpa_bss_params {
1508 /** Interface name (for multi-SSID/VLAN support) */
1510 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1519 enum mfp_options ieee80211w;
1522 #define WPA_STA_AUTHORIZED BIT(0)
1523 #define WPA_STA_WMM BIT(1)
1524 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1525 #define WPA_STA_MFP BIT(3)
1526 #define WPA_STA_TDLS_PEER BIT(4)
1527 #define WPA_STA_AUTHENTICATED BIT(5)
1528 #define WPA_STA_ASSOCIATED BIT(6)
1541 WNM_SLEEP_ENTER_CONFIRM,
1542 WNM_SLEEP_ENTER_FAIL,
1543 WNM_SLEEP_EXIT_CONFIRM,
1544 WNM_SLEEP_EXIT_FAIL,
1545 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1546 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1547 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1549 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1551 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1552 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1554 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1557 /* enum chan_width - Channel width definitions */
1569 * struct wpa_signal_info - Information about channel signal quality
1571 struct wpa_signal_info {
1573 int above_threshold;
1576 int avg_beacon_signal;
1579 enum chan_width chanwidth;
1585 * struct beacon_data - Beacon data
1586 * @head: Head portion of Beacon frame (before TIM IE)
1587 * @tail: Tail portion of Beacon frame (after TIM IE)
1588 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1589 * @proberesp_ies: Extra information element(s) to add into Probe Response
1591 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1592 * Response frames or %NULL
1593 * @probe_resp: Probe Response frame template
1594 * @head_len: Length of @head
1595 * @tail_len: Length of @tail
1596 * @beacon_ies_len: Length of beacon_ies in octets
1597 * @proberesp_ies_len: Length of proberesp_ies in octets
1598 * @proberesp_ies_len: Length of proberesp_ies in octets
1599 * @probe_resp_len: Length of probe response template (@probe_resp)
1601 struct beacon_data {
1608 size_t head_len, tail_len;
1609 size_t beacon_ies_len;
1610 size_t proberesp_ies_len;
1611 size_t assocresp_ies_len;
1612 size_t probe_resp_len;
1616 * struct csa_settings - Settings for channel switch command
1617 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1618 * @block_tx: 1 - block transmission for CSA period
1619 * @freq_params: Next channel frequency parameter
1620 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1621 * @beacon_after: Next beacon/probe resp/asooc resp info
1622 * @counter_offset_beacon: Offset to the count field in beacon's tail
1623 * @counter_offset_presp: Offset to the count field in probe resp.
1625 struct csa_settings {
1629 struct hostapd_freq_params freq_params;
1630 struct beacon_data beacon_csa;
1631 struct beacon_data beacon_after;
1633 u16 counter_offset_beacon[2];
1634 u16 counter_offset_presp[2];
1637 /* TDLS peer capabilities for send_tdls_mgmt() */
1638 enum tdls_peer_capability {
1639 TDLS_PEER_HT = BIT(0),
1640 TDLS_PEER_VHT = BIT(1),
1641 TDLS_PEER_WMM = BIT(2),
1644 /* valid info in the wmm_params struct */
1645 enum wmm_params_valid_info {
1646 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1650 * struct wmm_params - WMM parameterss configured for this association
1651 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1652 * of the struct contain valid information.
1653 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1654 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1661 #ifdef CONFIG_MACSEC
1662 struct macsec_init_params {
1663 Boolean always_include_sci;
1667 #endif /* CONFIG_MACSEC */
1669 enum drv_br_port_attr {
1670 DRV_BR_PORT_ATTR_PROXYARP,
1671 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1674 enum drv_br_net_param {
1675 DRV_BR_NET_PARAM_GARP_ACCEPT,
1676 DRV_BR_MULTICAST_SNOOPING,
1679 struct drv_acs_params {
1680 /* Selected mode (HOSTAPD_MODE_*) */
1681 enum hostapd_hw_mode hw_mode;
1683 /* Indicates whether HT is enabled */
1686 /* Indicates whether HT40 is enabled */
1689 /* Indicates whether VHT is enabled */
1692 /* Configured ACS channel width */
1695 /* ACS channel list info */
1696 unsigned int ch_list_len;
1698 const int *freq_list;
1703 * struct wpa_driver_ops - Driver interface API definition
1705 * This structure defines the API that each driver interface needs to implement
1706 * for core wpa_supplicant code. All driver specific functionality is captured
1709 struct wpa_driver_ops {
1710 /** Name of the driver interface */
1712 /** One line description of the driver interface */
1716 * get_bssid - Get the current BSSID
1717 * @priv: private driver interface data
1718 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1720 * Returns: 0 on success, -1 on failure
1722 * Query kernel driver for the current BSSID and copy it to bssid.
1723 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1726 int (*get_bssid)(void *priv, u8 *bssid);
1729 * get_ssid - Get the current SSID
1730 * @priv: private driver interface data
1731 * @ssid: buffer for SSID (at least 32 bytes)
1733 * Returns: Length of the SSID on success, -1 on failure
1735 * Query kernel driver for the current SSID and copy it to ssid.
1736 * Returning zero is recommended if the STA is not associated.
1738 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1739 * can, at least in theory, contain control characters (including nul)
1740 * and as such, should be processed as binary data, not a printable
1743 int (*get_ssid)(void *priv, u8 *ssid);
1746 * set_key - Configure encryption key
1747 * @ifname: Interface name (for multi-SSID/VLAN support)
1748 * @priv: private driver interface data
1749 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1750 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1751 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1752 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1753 * %WPA_ALG_BIP_CMAC_256);
1754 * %WPA_ALG_NONE clears the key.
1755 * @addr: Address of the peer STA (BSSID of the current AP when setting
1756 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1757 * broadcast keys, %NULL for default keys that are used both for
1758 * broadcast and unicast; when clearing keys, %NULL is used to
1759 * indicate that both the broadcast-only and default key of the
1760 * specified key index is to be cleared
1761 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1763 * @set_tx: configure this key as the default Tx key (only used when
1764 * driver does not support separate unicast/individual key
1765 * @seq: sequence number/packet number, seq_len octets, the next
1766 * packet number to be used for in replay protection; configured
1767 * for Rx keys (in most cases, this is only used with broadcast
1768 * keys and set to zero for unicast keys); %NULL if not set
1769 * @seq_len: length of the seq, depends on the algorithm:
1770 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1771 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1773 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1774 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1776 * Returns: 0 on success, -1 on failure
1778 * Configure the given key for the kernel driver. If the driver
1779 * supports separate individual keys (4 default keys + 1 individual),
1780 * addr can be used to determine whether the key is default or
1781 * individual. If only 4 keys are supported, the default key with key
1782 * index 0 is used as the individual key. STA must be configured to use
1783 * it as the default Tx key (set_tx is set) and accept Rx for all the
1784 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1785 * broadcast keys, so key index 0 is available for this kind of
1788 * Please note that TKIP keys include separate TX and RX MIC keys and
1789 * some drivers may expect them in different order than wpa_supplicant
1790 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1791 * will trigger Michael MIC errors. This can be fixed by changing the
1792 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1793 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1794 * example on how this can be done.
1796 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1797 const u8 *addr, int key_idx, int set_tx,
1798 const u8 *seq, size_t seq_len,
1799 const u8 *key, size_t key_len);
1802 * init - Initialize driver interface
1803 * @ctx: context to be used when calling wpa_supplicant functions,
1804 * e.g., wpa_supplicant_event()
1805 * @ifname: interface name, e.g., wlan0
1807 * Returns: Pointer to private data, %NULL on failure
1809 * Initialize driver interface, including event processing for kernel
1810 * driver events (e.g., associated, scan results, Michael MIC failure).
1811 * This function can allocate a private configuration data area for
1812 * @ctx, file descriptor, interface name, etc. information that may be
1813 * needed in future driver operations. If this is not used, non-NULL
1814 * value will need to be returned because %NULL is used to indicate
1815 * failure. The returned value will be used as 'void *priv' data for
1816 * all other driver_ops functions.
1818 * The main event loop (eloop.c) of wpa_supplicant can be used to
1819 * register callback for read sockets (eloop_register_read_sock()).
1821 * See below for more information about events and
1822 * wpa_supplicant_event() function.
1824 void * (*init)(void *ctx, const char *ifname);
1827 * deinit - Deinitialize driver interface
1828 * @priv: private driver interface data from init()
1830 * Shut down driver interface and processing of driver events. Free
1831 * private data buffer if one was allocated in init() handler.
1833 void (*deinit)(void *priv);
1836 * set_param - Set driver configuration parameters
1837 * @priv: private driver interface data from init()
1838 * @param: driver specific configuration parameters
1840 * Returns: 0 on success, -1 on failure
1842 * Optional handler for notifying driver interface about configuration
1843 * parameters (driver_param).
1845 int (*set_param)(void *priv, const char *param);
1848 * set_countermeasures - Enable/disable TKIP countermeasures
1849 * @priv: private driver interface data
1850 * @enabled: 1 = countermeasures enabled, 0 = disabled
1852 * Returns: 0 on success, -1 on failure
1854 * Configure TKIP countermeasures. When these are enabled, the driver
1855 * should drop all received and queued frames that are using TKIP.
1857 int (*set_countermeasures)(void *priv, int enabled);
1860 * deauthenticate - Request driver to deauthenticate
1861 * @priv: private driver interface data
1862 * @addr: peer address (BSSID of the AP)
1863 * @reason_code: 16-bit reason code to be sent in the deauthentication
1866 * Returns: 0 on success, -1 on failure
1868 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1871 * associate - Request driver to associate
1872 * @priv: private driver interface data
1873 * @params: association parameters
1875 * Returns: 0 on success, -1 on failure
1877 int (*associate)(void *priv,
1878 struct wpa_driver_associate_params *params);
1881 * add_pmkid - Add PMKSA cache entry to the driver
1882 * @priv: private driver interface data
1883 * @bssid: BSSID for the PMKSA cache entry
1884 * @pmkid: PMKID for the PMKSA cache entry
1886 * Returns: 0 on success, -1 on failure
1888 * This function is called when a new PMK is received, as a result of
1889 * either normal authentication or RSN pre-authentication.
1891 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1892 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1893 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1894 * driver_ops function does not need to be implemented. Likewise, if
1895 * the driver does not support WPA, this function is not needed.
1897 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1900 * remove_pmkid - Remove PMKSA cache entry to the driver
1901 * @priv: private driver interface data
1902 * @bssid: BSSID for the PMKSA cache entry
1903 * @pmkid: PMKID for the PMKSA cache entry
1905 * Returns: 0 on success, -1 on failure
1907 * This function is called when the supplicant drops a PMKSA cache
1908 * entry for any reason.
1910 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1911 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1912 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1913 * from wpa_supplicant, this driver_ops function does not need to be
1914 * implemented. Likewise, if the driver does not support WPA, this
1915 * function is not needed.
1917 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1920 * flush_pmkid - Flush PMKSA cache
1921 * @priv: private driver interface data
1923 * Returns: 0 on success, -1 on failure
1925 * This function is called when the supplicant drops all PMKSA cache
1926 * entries for any reason.
1928 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1929 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1930 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1931 * from wpa_supplicant, this driver_ops function does not need to be
1932 * implemented. Likewise, if the driver does not support WPA, this
1933 * function is not needed.
1935 int (*flush_pmkid)(void *priv);
1938 * get_capa - Get driver capabilities
1939 * @priv: private driver interface data
1941 * Returns: 0 on success, -1 on failure
1943 * Get driver/firmware/hardware capabilities.
1945 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1948 * poll - Poll driver for association information
1949 * @priv: private driver interface data
1951 * This is an option callback that can be used when the driver does not
1952 * provide event mechanism for association events. This is called when
1953 * receiving WPA EAPOL-Key messages that require association
1954 * information. The driver interface is supposed to generate associnfo
1955 * event before returning from this callback function. In addition, the
1956 * driver interface should generate an association event after having
1957 * sent out associnfo.
1959 void (*poll)(void *priv);
1962 * get_ifindex - Get interface index
1963 * @priv: private driver interface data
1965 * Returns: Interface index
1967 unsigned int (*get_ifindex)(void *priv);
1970 * get_ifname - Get interface name
1971 * @priv: private driver interface data
1973 * Returns: Pointer to the interface name. This can differ from the
1974 * interface name used in init() call. Init() is called first.
1976 * This optional function can be used to allow the driver interface to
1977 * replace the interface name with something else, e.g., based on an
1978 * interface mapping from a more descriptive name.
1980 const char * (*get_ifname)(void *priv);
1983 * get_mac_addr - Get own MAC address
1984 * @priv: private driver interface data
1986 * Returns: Pointer to own MAC address or %NULL on failure
1988 * This optional function can be used to get the own MAC address of the
1989 * device from the driver interface code. This is only needed if the
1990 * l2_packet implementation for the OS does not provide easy access to
1992 const u8 * (*get_mac_addr)(void *priv);
1995 * set_operstate - Sets device operating state to DORMANT or UP
1996 * @priv: private driver interface data
1997 * @state: 0 = dormant, 1 = up
1998 * Returns: 0 on success, -1 on failure
2000 * This is an optional function that can be used on operating systems
2001 * that support a concept of controlling network device state from user
2002 * space applications. This function, if set, gets called with
2003 * state = 1 when authentication has been completed and with state = 0
2004 * when connection is lost.
2006 int (*set_operstate)(void *priv, int state);
2009 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2010 * @priv: Private driver interface data
2011 * @addr: Address of the station for which to set protection (may be
2012 * %NULL for group keys)
2013 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2014 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2015 * Returns: 0 on success, -1 on failure
2017 * This is an optional function that can be used to set the driver to
2018 * require protection for Tx and/or Rx frames. This uses the layer
2019 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2020 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2021 * set protection operation; instead, they set protection implicitly
2022 * based on configured keys.
2024 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2028 * get_hw_feature_data - Get hardware support data (channels and rates)
2029 * @priv: Private driver interface data
2030 * @num_modes: Variable for returning the number of returned modes
2031 * flags: Variable for returning hardware feature flags
2032 * Returns: Pointer to allocated hardware data on success or %NULL on
2033 * failure. Caller is responsible for freeing this.
2035 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2040 * send_mlme - Send management frame from MLME
2041 * @priv: Private driver interface data
2042 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2043 * @data_len: Size of the management frame
2044 * @noack: Do not wait for this frame to be acked (disable retries)
2045 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2047 * @csa_offs: Array of CSA offsets or %NULL
2048 * @csa_offs_len: Number of elements in csa_offs
2049 * Returns: 0 on success, -1 on failure
2051 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
2052 int noack, unsigned int freq, const u16 *csa_offs,
2053 size_t csa_offs_len);
2056 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2057 * @priv: Private driver interface data
2058 * @md: Mobility domain (2 octets) (also included inside ies)
2059 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2060 * @ies_len: Length of FT IEs in bytes
2061 * Returns: 0 on success, -1 on failure
2063 * The supplicant uses this callback to let the driver know that keying
2064 * material for FT is available and that the driver can use the
2065 * provided IEs in the next message in FT authentication sequence.
2067 * This function is only needed for driver that support IEEE 802.11r
2068 * (Fast BSS Transition).
2070 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2074 * get_scan_results2 - Fetch the latest scan results
2075 * @priv: private driver interface data
2077 * Returns: Allocated buffer of scan results (caller is responsible for
2078 * freeing the data structure) on success, NULL on failure
2080 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2083 * set_country - Set country
2084 * @priv: Private driver interface data
2085 * @alpha2: country to which to switch to
2086 * Returns: 0 on success, -1 on failure
2088 * This function is for drivers which support some form
2089 * of setting a regulatory domain.
2091 int (*set_country)(void *priv, const char *alpha2);
2094 * get_country - Get country
2095 * @priv: Private driver interface data
2096 * @alpha2: Buffer for returning country code (at least 3 octets)
2097 * Returns: 0 on success, -1 on failure
2099 int (*get_country)(void *priv, char *alpha2);
2102 * global_init - Global driver initialization
2103 * @ctx: wpa_global pointer
2104 * Returns: Pointer to private data (global), %NULL on failure
2106 * This optional function is called to initialize the driver wrapper
2107 * for global data, i.e., data that applies to all interfaces. If this
2108 * function is implemented, global_deinit() will also need to be
2109 * implemented to free the private data. The driver will also likely
2110 * use init2() function instead of init() to get the pointer to global
2111 * data available to per-interface initializer.
2113 void * (*global_init)(void *ctx);
2116 * global_deinit - Global driver deinitialization
2117 * @priv: private driver global data from global_init()
2119 * Terminate any global driver related functionality and free the
2120 * global data structure.
2122 void (*global_deinit)(void *priv);
2125 * init2 - Initialize driver interface (with global data)
2126 * @ctx: context to be used when calling wpa_supplicant functions,
2127 * e.g., wpa_supplicant_event()
2128 * @ifname: interface name, e.g., wlan0
2129 * @global_priv: private driver global data from global_init()
2130 * Returns: Pointer to private data, %NULL on failure
2132 * This function can be used instead of init() if the driver wrapper
2135 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2138 * get_interfaces - Get information about available interfaces
2139 * @global_priv: private driver global data from global_init()
2140 * Returns: Allocated buffer of interface information (caller is
2141 * responsible for freeing the data structure) on success, NULL on
2144 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2147 * scan2 - Request the driver to initiate scan
2148 * @priv: private driver interface data
2149 * @params: Scan parameters
2151 * Returns: 0 on success, -1 on failure
2153 * Once the scan results are ready, the driver should report scan
2154 * results event for wpa_supplicant which will eventually request the
2155 * results with wpa_driver_get_scan_results2().
2157 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2160 * authenticate - Request driver to authenticate
2161 * @priv: private driver interface data
2162 * @params: authentication parameters
2163 * Returns: 0 on success, -1 on failure
2165 * This is an optional function that can be used with drivers that
2166 * support separate authentication and association steps, i.e., when
2167 * wpa_supplicant can act as the SME. If not implemented, associate()
2168 * function is expected to take care of IEEE 802.11 authentication,
2171 int (*authenticate)(void *priv,
2172 struct wpa_driver_auth_params *params);
2175 * set_ap - Set Beacon and Probe Response information for AP mode
2176 * @priv: Private driver interface data
2177 * @params: Parameters to use in AP mode
2179 * This function is used to configure Beacon template and/or extra IEs
2180 * to add for Beacon and Probe Response frames for the driver in
2181 * AP mode. The driver is responsible for building the full Beacon
2182 * frame by concatenating the head part with TIM IE generated by the
2183 * driver/firmware and finishing with the tail part. Depending on the
2184 * driver architectue, this can be done either by using the full
2185 * template or the set of additional IEs (e.g., WPS and P2P IE).
2186 * Similarly, Probe Response processing depends on the driver design.
2187 * If the driver (or firmware) takes care of replying to Probe Request
2188 * frames, the extra IEs provided here needs to be added to the Probe
2191 * Returns: 0 on success, -1 on failure
2193 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
2196 * set_acl - Set ACL in AP mode
2197 * @priv: Private driver interface data
2198 * @params: Parameters to configure ACL
2199 * Returns: 0 on success, -1 on failure
2201 * This is used only for the drivers which support MAC address ACL.
2203 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2206 * hapd_init - Initialize driver interface (hostapd only)
2207 * @hapd: Pointer to hostapd context
2208 * @params: Configuration for the driver wrapper
2209 * Returns: Pointer to private data, %NULL on failure
2211 * This function is used instead of init() or init2() when the driver
2212 * wrapper is used with hostapd.
2214 void * (*hapd_init)(struct hostapd_data *hapd,
2215 struct wpa_init_params *params);
2218 * hapd_deinit - Deinitialize driver interface (hostapd only)
2219 * @priv: Private driver interface data from hapd_init()
2221 void (*hapd_deinit)(void *priv);
2224 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2225 * @priv: Private driver interface data
2226 * @params: BSS parameters
2227 * Returns: 0 on success, -1 on failure
2229 * This is an optional function to configure the kernel driver to
2230 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2231 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2232 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2233 * for Beacon frames.
2235 * DEPRECATED - use set_ap() instead
2237 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2240 * set_privacy - Enable/disable privacy (AP only)
2241 * @priv: Private driver interface data
2242 * @enabled: 1 = privacy enabled, 0 = disabled
2243 * Returns: 0 on success, -1 on failure
2245 * This is an optional function to configure privacy field in the
2246 * kernel driver for Beacon frames. This can be left undefined (set to
2247 * %NULL) if the driver uses the Beacon template from set_ap().
2249 * DEPRECATED - use set_ap() instead
2251 int (*set_privacy)(void *priv, int enabled);
2254 * get_seqnum - Fetch the current TSC/packet number (AP only)
2255 * @ifname: The interface name (main or virtual)
2256 * @priv: Private driver interface data
2257 * @addr: MAC address of the station or %NULL for group keys
2259 * @seq: Buffer for returning the latest used TSC/packet number
2260 * Returns: 0 on success, -1 on failure
2262 * This function is used to fetch the last used TSC/packet number for
2263 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2264 * keys, so there is no strict requirement on implementing support for
2265 * unicast keys (i.e., addr != %NULL).
2267 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2271 * flush - Flush all association stations (AP only)
2272 * @priv: Private driver interface data
2273 * Returns: 0 on success, -1 on failure
2275 * This function requests the driver to disassociate all associated
2276 * stations. This function does not need to be implemented if the
2277 * driver does not process association frames internally.
2279 int (*flush)(void *priv);
2282 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2283 * @priv: Private driver interface data
2284 * @elem: Information elements
2285 * @elem_len: Length of the elem buffer in octets
2286 * Returns: 0 on success, -1 on failure
2288 * This is an optional function to add information elements in the
2289 * kernel driver for Beacon and Probe Response frames. This can be left
2290 * undefined (set to %NULL) if the driver uses the Beacon template from
2293 * DEPRECATED - use set_ap() instead
2295 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2298 * read_sta_data - Fetch station data
2299 * @priv: Private driver interface data
2300 * @data: Buffer for returning station information
2301 * @addr: MAC address of the station
2302 * Returns: 0 on success, -1 on failure
2304 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2308 * hapd_send_eapol - Send an EAPOL packet (AP only)
2309 * @priv: private driver interface data
2310 * @addr: Destination MAC address
2311 * @data: EAPOL packet starting with IEEE 802.1X header
2312 * @data_len: Length of the EAPOL packet in octets
2313 * @encrypt: Whether the frame should be encrypted
2314 * @own_addr: Source MAC address
2315 * @flags: WPA_STA_* flags for the destination station
2317 * Returns: 0 on success, -1 on failure
2319 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2320 size_t data_len, int encrypt,
2321 const u8 *own_addr, u32 flags);
2324 * sta_deauth - Deauthenticate a station (AP only)
2325 * @priv: Private driver interface data
2326 * @own_addr: Source address and BSSID for the Deauthentication frame
2327 * @addr: MAC address of the station to deauthenticate
2328 * @reason: Reason code for the Deauthentiation frame
2329 * Returns: 0 on success, -1 on failure
2331 * This function requests a specific station to be deauthenticated and
2332 * a Deauthentication frame to be sent to it.
2334 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2338 * sta_disassoc - Disassociate a station (AP only)
2339 * @priv: Private driver interface data
2340 * @own_addr: Source address and BSSID for the Disassociation frame
2341 * @addr: MAC address of the station to disassociate
2342 * @reason: Reason code for the Disassociation frame
2343 * Returns: 0 on success, -1 on failure
2345 * This function requests a specific station to be disassociated and
2346 * a Disassociation frame to be sent to it.
2348 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2352 * sta_remove - Remove a station entry (AP only)
2353 * @priv: Private driver interface data
2354 * @addr: MAC address of the station to be removed
2355 * Returns: 0 on success, -1 on failure
2357 int (*sta_remove)(void *priv, const u8 *addr);
2360 * hapd_get_ssid - Get the current SSID (AP only)
2361 * @priv: Private driver interface data
2362 * @buf: Buffer for returning the SSID
2363 * @len: Maximum length of the buffer
2364 * Returns: Length of the SSID on success, -1 on failure
2366 * This function need not be implemented if the driver uses Beacon
2367 * template from set_ap() and does not reply to Probe Request frames.
2369 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2372 * hapd_set_ssid - Set SSID (AP only)
2373 * @priv: Private driver interface data
2375 * @len: Length of the SSID in octets
2376 * Returns: 0 on success, -1 on failure
2378 * DEPRECATED - use set_ap() instead
2380 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2383 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2384 * @priv: Private driver interface data
2385 * @enabled: 1 = countermeasures enabled, 0 = disabled
2386 * Returns: 0 on success, -1 on failure
2388 * This need not be implemented if the driver does not take care of
2389 * association processing.
2391 int (*hapd_set_countermeasures)(void *priv, int enabled);
2394 * sta_add - Add a station entry
2395 * @priv: Private driver interface data
2396 * @params: Station parameters
2397 * Returns: 0 on success, -1 on failure
2399 * This function is used to add or set (params->set 1) a station
2400 * entry in the driver. Adding STA entries is used only if the driver
2401 * does not take care of association processing.
2403 * With drivers that don't support full AP client state, this function
2404 * is used to add a station entry to the driver once the station has
2405 * completed association.
2407 * With TDLS, this function is used to add or set (params->set 1)
2408 * TDLS peer entries (even with drivers that do not support full AP
2411 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2414 * get_inact_sec - Get station inactivity duration (AP only)
2415 * @priv: Private driver interface data
2416 * @addr: Station address
2417 * Returns: Number of seconds station has been inactive, -1 on failure
2419 int (*get_inact_sec)(void *priv, const u8 *addr);
2422 * sta_clear_stats - Clear station statistics (AP only)
2423 * @priv: Private driver interface data
2424 * @addr: Station address
2425 * Returns: 0 on success, -1 on failure
2427 int (*sta_clear_stats)(void *priv, const u8 *addr);
2430 * set_freq - Set channel/frequency (AP only)
2431 * @priv: Private driver interface data
2432 * @freq: Channel parameters
2433 * Returns: 0 on success, -1 on failure
2435 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2438 * set_rts - Set RTS threshold
2439 * @priv: Private driver interface data
2440 * @rts: RTS threshold in octets
2441 * Returns: 0 on success, -1 on failure
2443 int (*set_rts)(void *priv, int rts);
2446 * set_frag - Set fragmentation threshold
2447 * @priv: Private driver interface data
2448 * @frag: Fragmentation threshold in octets
2449 * Returns: 0 on success, -1 on failure
2451 int (*set_frag)(void *priv, int frag);
2454 * sta_set_flags - Set station flags (AP only)
2455 * @priv: Private driver interface data
2456 * @addr: Station address
2457 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2458 * @flags_or: Bitmap of WPA_STA_* flags to add
2459 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2460 * Returns: 0 on success, -1 on failure
2462 int (*sta_set_flags)(void *priv, const u8 *addr,
2463 unsigned int total_flags, unsigned int flags_or,
2464 unsigned int flags_and);
2467 * set_tx_queue_params - Set TX queue parameters
2468 * @priv: Private driver interface data
2469 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2473 * @burst_time: Maximum length for bursting in 0.1 msec units
2475 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2476 int cw_max, int burst_time);
2479 * if_add - Add a virtual interface
2480 * @priv: Private driver interface data
2481 * @type: Interface type
2482 * @ifname: Interface name for the new virtual interface
2483 * @addr: Local address to use for the interface or %NULL to use the
2484 * parent interface address
2485 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2486 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2487 * not allowed (applies only to %WPA_IF_AP_BSS type)
2488 * @force_ifname: Buffer for returning an interface name that the
2489 * driver ended up using if it differs from the requested ifname
2490 * @if_addr: Buffer for returning the allocated interface address
2491 * (this may differ from the requested addr if the driver cannot
2492 * change interface address)
2493 * @bridge: Bridge interface to use or %NULL if no bridge configured
2494 * @use_existing: Whether to allow existing interface to be used
2495 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
2496 * Returns: 0 on success, -1 on failure
2498 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2499 const char *ifname, const u8 *addr, void *bss_ctx,
2500 void **drv_priv, char *force_ifname, u8 *if_addr,
2501 const char *bridge, int use_existing, int setup_ap);
2504 * if_remove - Remove a virtual interface
2505 * @priv: Private driver interface data
2506 * @type: Interface type
2507 * @ifname: Interface name of the virtual interface to be removed
2508 * Returns: 0 on success, -1 on failure
2510 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2511 const char *ifname);
2514 * set_sta_vlan - Bind a station into a specific interface (AP only)
2515 * @priv: Private driver interface data
2516 * @ifname: Interface (main or virtual BSS or VLAN)
2517 * @addr: MAC address of the associated station
2519 * Returns: 0 on success, -1 on failure
2521 * This function is used to bind a station to a specific virtual
2522 * interface. It is only used if when virtual interfaces are supported,
2523 * e.g., to assign stations to different VLAN interfaces based on
2524 * information from a RADIUS server. This allows separate broadcast
2525 * domains to be used with a single BSS.
2527 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2531 * commit - Optional commit changes handler (AP only)
2532 * @priv: driver private data
2533 * Returns: 0 on success, -1 on failure
2535 * This optional handler function can be registered if the driver
2536 * interface implementation needs to commit changes (e.g., by setting
2537 * network interface up) at the end of initial configuration. If set,
2538 * this handler will be called after initial setup has been completed.
2540 int (*commit)(void *priv);
2543 * send_ether - Send an ethernet packet (AP only)
2544 * @priv: private driver interface data
2545 * @dst: Destination MAC address
2546 * @src: Source MAC address
2548 * @data: EAPOL packet starting with IEEE 802.1X header
2549 * @data_len: Length of the EAPOL packet in octets
2550 * Returns: 0 on success, -1 on failure
2552 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2553 const u8 *data, size_t data_len);
2556 * set_radius_acl_auth - Notification of RADIUS ACL change
2557 * @priv: Private driver interface data
2558 * @mac: MAC address of the station
2559 * @accepted: Whether the station was accepted
2560 * @session_timeout: Session timeout for the station
2561 * Returns: 0 on success, -1 on failure
2563 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2564 u32 session_timeout);
2567 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2568 * @priv: Private driver interface data
2569 * @mac: MAC address of the station
2570 * Returns: 0 on success, -1 on failure
2572 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2575 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2576 * @priv: Private driver interface data
2577 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2578 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2580 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2581 * to remove extra IE(s)
2582 * Returns: 0 on success, -1 on failure
2584 * This is an optional function to add WPS IE in the kernel driver for
2585 * Beacon and Probe Response frames. This can be left undefined (set
2586 * to %NULL) if the driver uses the Beacon template from set_ap()
2587 * and does not process Probe Request frames. If the driver takes care
2588 * of (Re)Association frame processing, the assocresp buffer includes
2589 * WPS IE(s) that need to be added to (Re)Association Response frames
2590 * whenever a (Re)Association Request frame indicated use of WPS.
2592 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2593 * frames when operating as a GO. The driver is responsible for adding
2594 * timing related attributes (e.g., NoA) in addition to the IEs
2595 * included here by appending them after these buffers. This call is
2596 * also used to provide Probe Response IEs for P2P Listen state
2597 * operations for drivers that generate the Probe Response frames
2600 * DEPRECATED - use set_ap() instead
2602 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2603 const struct wpabuf *proberesp,
2604 const struct wpabuf *assocresp);
2607 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2608 * @priv: Private driver interface data
2609 * @authorized: Whether the port is authorized
2610 * Returns: 0 on success, -1 on failure
2612 int (*set_supp_port)(void *priv, int authorized);
2615 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2616 * @priv: Private driver interface data
2617 * @addr: MAC address of the associated station
2618 * @aid: Association ID
2619 * @val: 1 = bind to 4-address WDS; 0 = unbind
2620 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2621 * to indicate that bridge is not to be used
2622 * @ifname_wds: Buffer to return the interface name for the new WDS
2623 * station or %NULL to indicate name is not returned.
2624 * Returns: 0 on success, -1 on failure
2626 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2627 const char *bridge_ifname, char *ifname_wds);
2630 * send_action - Transmit an Action frame
2631 * @priv: Private driver interface data
2632 * @freq: Frequency (in MHz) of the channel
2633 * @wait: Time to wait off-channel for a response (in ms), or zero
2634 * @dst: Destination MAC address (Address 1)
2635 * @src: Source MAC address (Address 2)
2636 * @bssid: BSSID (Address 3)
2638 * @data_len: data length in octets
2639 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2640 * Returns: 0 on success, -1 on failure
2642 * This command can be used to request the driver to transmit an action
2643 * frame to the specified destination.
2645 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2646 * be transmitted on the given channel and the device will wait for a
2647 * response on that channel for the given wait time.
2649 * If the flag is not set, the wait time will be ignored. In this case,
2650 * if a remain-on-channel duration is in progress, the frame must be
2651 * transmitted on that channel; alternatively the frame may be sent on
2652 * the current operational channel (if in associated state in station
2653 * mode or while operating as an AP.)
2655 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2656 const u8 *dst, const u8 *src, const u8 *bssid,
2657 const u8 *data, size_t data_len, int no_cck);
2660 * send_action_cancel_wait - Cancel action frame TX wait
2661 * @priv: Private driver interface data
2663 * This command cancels the wait time associated with sending an action
2664 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2665 * set in the driver flags.
2667 void (*send_action_cancel_wait)(void *priv);
2670 * remain_on_channel - Remain awake on a channel
2671 * @priv: Private driver interface data
2672 * @freq: Frequency (in MHz) of the channel
2673 * @duration: Duration in milliseconds
2674 * Returns: 0 on success, -1 on failure
2676 * This command is used to request the driver to remain awake on the
2677 * specified channel for the specified duration and report received
2678 * Action frames with EVENT_RX_MGMT events. Optionally, received
2679 * Probe Request frames may also be requested to be reported by calling
2680 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2682 * The driver may not be at the requested channel when this function
2683 * returns, i.e., the return code is only indicating whether the
2684 * request was accepted. The caller will need to wait until the
2685 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2686 * completed the channel change. This may take some time due to other
2687 * need for the radio and the caller should be prepared to timing out
2688 * its wait since there are no guarantees on when this request can be
2691 int (*remain_on_channel)(void *priv, unsigned int freq,
2692 unsigned int duration);
2695 * cancel_remain_on_channel - Cancel remain-on-channel operation
2696 * @priv: Private driver interface data
2698 * This command can be used to cancel a remain-on-channel operation
2699 * before its originally requested duration has passed. This could be
2700 * used, e.g., when remain_on_channel() is used to request extra time
2701 * to receive a response to an Action frame and the response is
2702 * received when there is still unneeded time remaining on the
2703 * remain-on-channel operation.
2705 int (*cancel_remain_on_channel)(void *priv);
2708 * probe_req_report - Request Probe Request frames to be indicated
2709 * @priv: Private driver interface data
2710 * @report: Whether to report received Probe Request frames
2711 * Returns: 0 on success, -1 on failure (or if not supported)
2713 * This command can be used to request the driver to indicate when
2714 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2715 * Since this operation may require extra resources, e.g., due to less
2716 * optimal hardware/firmware RX filtering, many drivers may disable
2717 * Probe Request reporting at least in station mode. This command is
2718 * used to notify the driver when the Probe Request frames need to be
2719 * reported, e.g., during remain-on-channel operations.
2721 int (*probe_req_report)(void *priv, int report);
2724 * deinit_ap - Deinitialize AP mode
2725 * @priv: Private driver interface data
2726 * Returns: 0 on success, -1 on failure (or if not supported)
2728 * This optional function can be used to disable AP mode related
2729 * configuration. If the interface was not dynamically added,
2730 * change the driver mode to station mode to allow normal station
2731 * operations like scanning to be completed.
2733 int (*deinit_ap)(void *priv);
2736 * deinit_p2p_cli - Deinitialize P2P client mode
2737 * @priv: Private driver interface data
2738 * Returns: 0 on success, -1 on failure (or if not supported)
2740 * This optional function can be used to disable P2P client mode. If the
2741 * interface was not dynamically added, change the interface type back
2744 int (*deinit_p2p_cli)(void *priv);
2747 * suspend - Notification on system suspend/hibernate event
2748 * @priv: Private driver interface data
2750 void (*suspend)(void *priv);
2753 * resume - Notification on system resume/thaw event
2754 * @priv: Private driver interface data
2756 void (*resume)(void *priv);
2759 * signal_monitor - Set signal monitoring parameters
2760 * @priv: Private driver interface data
2761 * @threshold: Threshold value for signal change events; 0 = disabled
2762 * @hysteresis: Minimum change in signal strength before indicating a
2764 * Returns: 0 on success, -1 on failure (or if not supported)
2766 * This function can be used to configure monitoring of signal strength
2767 * with the current AP. Whenever signal strength drops below the
2768 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2769 * should be generated assuming the signal strength has changed at
2770 * least %hysteresis from the previously indicated signal change event.
2772 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2775 * send_frame - Send IEEE 802.11 frame (testing use only)
2776 * @priv: Private driver interface data
2777 * @data: IEEE 802.11 frame with IEEE 802.11 header
2778 * @data_len: Size of the frame
2779 * @encrypt: Whether to encrypt the frame (if keys are set)
2780 * Returns: 0 on success, -1 on failure
2782 * This function is only used for debugging purposes and is not
2783 * required to be implemented for normal operations.
2785 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2789 * get_noa - Get current Notice of Absence attribute payload
2790 * @priv: Private driver interface data
2791 * @buf: Buffer for returning NoA
2792 * @buf_len: Buffer length in octets
2793 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2794 * advertized, or -1 on failure
2796 * This function is used to fetch the current Notice of Absence
2797 * attribute value from GO.
2799 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2802 * set_noa - Set Notice of Absence parameters for GO (testing)
2803 * @priv: Private driver interface data
2805 * @start: Start time in ms from next TBTT
2806 * @duration: Duration in ms
2807 * Returns: 0 on success or -1 on failure
2809 * This function is used to set Notice of Absence parameters for GO. It
2810 * is used only for testing. To disable NoA, all parameters are set to
2813 int (*set_noa)(void *priv, u8 count, int start, int duration);
2816 * set_p2p_powersave - Set P2P power save options
2817 * @priv: Private driver interface data
2818 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2819 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2820 * @ctwindow: 0.. = change (msec), -1 = no change
2821 * Returns: 0 on success or -1 on failure
2823 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2827 * ampdu - Enable/disable aggregation
2828 * @priv: Private driver interface data
2829 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2830 * Returns: 0 on success or -1 on failure
2832 int (*ampdu)(void *priv, int ampdu);
2835 * get_radio_name - Get physical radio name for the device
2836 * @priv: Private driver interface data
2837 * Returns: Radio name or %NULL if not known
2839 * The returned data must not be modified by the caller. It is assumed
2840 * that any interface that has the same radio name as another is
2841 * sharing the same physical radio. This information can be used to
2842 * share scan results etc. information between the virtual interfaces
2843 * to speed up various operations.
2845 const char * (*get_radio_name)(void *priv);
2848 * send_tdls_mgmt - for sending TDLS management packets
2849 * @priv: private driver interface data
2850 * @dst: Destination (peer) MAC address
2851 * @action_code: TDLS action code for the mssage
2852 * @dialog_token: Dialog Token to use in the message (if needed)
2853 * @status_code: Status Code or Reason Code to use (if needed)
2854 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2855 * @initiator: Is the current end the TDLS link initiator
2856 * @buf: TDLS IEs to add to the message
2857 * @len: Length of buf in octets
2858 * Returns: 0 on success, negative (<0) on failure
2860 * This optional function can be used to send packet to driver which is
2861 * responsible for receiving and sending all TDLS packets.
2863 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2864 u8 dialog_token, u16 status_code, u32 peer_capab,
2865 int initiator, const u8 *buf, size_t len);
2868 * tdls_oper - Ask the driver to perform high-level TDLS operations
2869 * @priv: Private driver interface data
2870 * @oper: TDLS high-level operation. See %enum tdls_oper
2871 * @peer: Destination (peer) MAC address
2872 * Returns: 0 on success, negative (<0) on failure
2874 * This optional function can be used to send high-level TDLS commands
2877 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2880 * wnm_oper - Notify driver of the WNM frame reception
2881 * @priv: Private driver interface data
2882 * @oper: WNM operation. See %enum wnm_oper
2883 * @peer: Destination (peer) MAC address
2884 * @buf: Buffer for the driver to fill in (for getting IE)
2885 * @buf_len: Return the len of buf
2886 * Returns: 0 on success, negative (<0) on failure
2888 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2889 u8 *buf, u16 *buf_len);
2892 * set_qos_map - Set QoS Map
2893 * @priv: Private driver interface data
2894 * @qos_map_set: QoS Map
2895 * @qos_map_set_len: Length of QoS Map
2897 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2898 u8 qos_map_set_len);
2901 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2902 * @priv: Private driver interface data
2903 * @version: IP version of the IP address, 4 or 6
2904 * @ipaddr: IP address for the neigh entry
2905 * @prefixlen: IP address prefix length
2906 * @addr: Corresponding MAC address
2907 * Returns: 0 on success, negative (<0) on failure
2909 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2910 int prefixlen, const u8 *addr);
2913 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2914 * @priv: Private driver interface data
2915 * @version: IP version of the IP address, 4 or 6
2916 * @ipaddr: IP address for the neigh entry
2917 * Returns: 0 on success, negative (<0) on failure
2919 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2922 * br_port_set_attr - Set a bridge port attribute
2923 * @attr: Bridge port attribute to set
2924 * @val: Value to be set
2925 * Returns: 0 on success, negative (<0) on failure
2927 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2931 * br_port_set_attr - Set a bridge network parameter
2932 * @param: Bridge parameter to set
2933 * @val: Value to be set
2934 * Returns: 0 on success, negative (<0) on failure
2936 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2940 * set_wowlan - Set wake-on-wireless triggers
2941 * @priv: Private driver interface data
2942 * @triggers: wowlan triggers
2944 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2947 * signal_poll - Get current connection information
2948 * @priv: Private driver interface data
2949 * @signal_info: Connection info structure
2951 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2954 * set_authmode - Set authentication algorithm(s) for static WEP
2955 * @priv: Private driver interface data
2956 * @authmode: 1=Open System, 2=Shared Key, 3=both
2957 * Returns: 0 on success, -1 on failure
2959 * This function can be used to set authentication algorithms for AP
2960 * mode when static WEP is used. If the driver uses user space MLME/SME
2961 * implementation, there is no need to implement this function.
2963 * DEPRECATED - use set_ap() instead
2965 int (*set_authmode)(void *priv, int authmode);
2969 * driver_cmd - Execute driver-specific command
2970 * @priv: Private driver interface data
2971 * @cmd: Command to execute
2972 * @buf: Return buffer
2973 * @buf_len: Buffer length
2974 * Returns: 0 on success, -1 on failure
2976 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2977 #endif /* ANDROID */
2980 * vendor_cmd - Execute vendor specific command
2981 * @priv: Private driver interface data
2982 * @vendor_id: Vendor id
2983 * @subcmd: Vendor command id
2984 * @data: Vendor command parameters (%NULL if no parameters)
2985 * @data_len: Data length
2986 * @buf: Return buffer (%NULL to ignore reply)
2987 * Returns: 0 on success, negative (<0) on failure
2989 * This function handles vendor specific commands that are passed to
2990 * the driver/device. The command is identified by vendor id and
2991 * command id. Parameters can be passed as argument to the command
2992 * in the data buffer. Reply (if any) will be filled in the supplied
2995 * The exact driver behavior is driver interface and vendor specific. As
2996 * an example, this will be converted to a vendor specific cfg80211
2997 * command in case of the nl80211 driver interface.
2999 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3000 unsigned int subcmd, const u8 *data, size_t data_len,
3001 struct wpabuf *buf);
3004 * set_rekey_info - Set rekey information
3005 * @priv: Private driver interface data
3007 * @kek_len: KEK length in octets
3009 * @kck_len: KCK length in octets
3010 * @replay_ctr: Current EAPOL-Key Replay Counter
3012 * This optional function can be used to provide information for the
3013 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3014 * while the host (including wpa_supplicant) is sleeping.
3016 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3017 const u8 *kck, size_t kck_len,
3018 const u8 *replay_ctr);
3021 * sta_assoc - Station association indication
3022 * @priv: Private driver interface data
3023 * @own_addr: Source address and BSSID for association frame
3024 * @addr: MAC address of the station to associate
3025 * @reassoc: flag to indicate re-association
3026 * @status: association response status code
3027 * @ie: assoc response ie buffer
3028 * @len: ie buffer length
3029 * Returns: 0 on success, -1 on failure
3031 * This function indicates the driver to send (Re)Association
3032 * Response frame to the station.
3034 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3035 int reassoc, u16 status, const u8 *ie, size_t len);
3038 * sta_auth - Station authentication indication
3039 * @priv: Private driver interface data
3040 * @own_addr: Source address and BSSID for authentication frame
3041 * @addr: MAC address of the station to associate
3042 * @seq: authentication sequence number
3043 * @status: authentication response status code
3044 * @ie: authentication frame ie buffer
3045 * @len: ie buffer length
3047 * This function indicates the driver to send Authentication frame
3050 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
3051 u16 seq, u16 status, const u8 *ie, size_t len);
3054 * add_tspec - Add traffic stream
3055 * @priv: Private driver interface data
3056 * @addr: MAC address of the station to associate
3057 * @tspec_ie: tspec ie buffer
3058 * @tspec_ielen: tspec ie length
3059 * Returns: 0 on success, -1 on failure
3061 * This function adds the traffic steam for the station
3062 * and fills the medium_time in tspec_ie.
3064 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3065 size_t tspec_ielen);
3068 * add_sta_node - Add a station node in the driver
3069 * @priv: Private driver interface data
3070 * @addr: MAC address of the station to add
3071 * @auth_alg: authentication algorithm used by the station
3072 * Returns: 0 on success, -1 on failure
3074 * This function adds the station node in the driver, when
3075 * the station gets added by FT-over-DS.
3077 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
3080 * sched_scan - Request the driver to initiate scheduled scan
3081 * @priv: Private driver interface data
3082 * @params: Scan parameters
3083 * Returns: 0 on success, -1 on failure
3085 * This operation should be used for scheduled scan offload to
3086 * the hardware. Every time scan results are available, the
3087 * driver should report scan results event for wpa_supplicant
3088 * which will eventually request the results with
3089 * wpa_driver_get_scan_results2(). This operation is optional
3090 * and if not provided or if it returns -1, we fall back to
3091 * normal host-scheduled scans.
3093 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
3096 * stop_sched_scan - Request the driver to stop a scheduled scan
3097 * @priv: Private driver interface data
3098 * Returns: 0 on success, -1 on failure
3100 * This should cause the scheduled scan to be stopped and
3101 * results should stop being sent. Must be supported if
3102 * sched_scan is supported.
3104 int (*stop_sched_scan)(void *priv);
3107 * poll_client - Probe (null data or such) the given station
3108 * @priv: Private driver interface data
3109 * @own_addr: MAC address of sending interface
3110 * @addr: MAC address of the station to probe
3111 * @qos: Indicates whether station is QoS station
3113 * This function is used to verify whether an associated station is
3114 * still present. This function does not need to be implemented if the
3115 * driver provides such inactivity polling mechanism.
3117 void (*poll_client)(void *priv, const u8 *own_addr,
3118 const u8 *addr, int qos);
3121 * radio_disable - Disable/enable radio
3122 * @priv: Private driver interface data
3123 * @disabled: 1=disable 0=enable radio
3124 * Returns: 0 on success, -1 on failure
3126 * This optional command is for testing purposes. It can be used to
3127 * disable the radio on a testbed device to simulate out-of-radio-range
3130 int (*radio_disable)(void *priv, int disabled);
3133 * switch_channel - Announce channel switch and migrate the GO to the
3135 * @priv: Private driver interface data
3136 * @settings: Settings for CSA period and new channel
3137 * Returns: 0 on success, -1 on failure
3139 * This function is used to move the GO to the legacy STA channel to
3140 * avoid frequency conflict in single channel concurrency.
3142 int (*switch_channel)(void *priv, struct csa_settings *settings);
3145 * add_tx_ts - Add traffic stream
3146 * @priv: Private driver interface data
3147 * @tsid: Traffic stream ID
3148 * @addr: Receiver address
3149 * @user_prio: User priority of the traffic stream
3150 * @admitted_time: Admitted time for this TS in units of
3151 * 32 microsecond periods (per second).
3152 * Returns: 0 on success, -1 on failure
3154 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3158 * del_tx_ts - Delete traffic stream
3159 * @priv: Private driver interface data
3160 * @tsid: Traffic stream ID
3161 * @addr: Receiver address
3162 * Returns: 0 on success, -1 on failure
3164 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3167 * Enable channel-switching with TDLS peer
3168 * @priv: Private driver interface data
3169 * @addr: MAC address of the TDLS peer
3170 * @oper_class: Operating class of the switch channel
3171 * @params: Channel specification
3172 * Returns: 0 on success, -1 on failure
3174 * The function indicates to driver that it can start switching to a
3175 * different channel with a specified TDLS peer. The switching is
3176 * assumed on until canceled with tdls_disable_channel_switch().
3178 int (*tdls_enable_channel_switch)(
3179 void *priv, const u8 *addr, u8 oper_class,
3180 const struct hostapd_freq_params *params);
3183 * Disable channel switching with TDLS peer
3184 * @priv: Private driver interface data
3185 * @addr: MAC address of the TDLS peer
3186 * Returns: 0 on success, -1 on failure
3188 * This function indicates to the driver that it should stop switching
3189 * with a given TDLS peer.
3191 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3194 * start_dfs_cac - Listen for radar interference on the channel
3195 * @priv: Private driver interface data
3196 * @freq: Channel parameters
3197 * Returns: 0 on success, -1 on failure
3199 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
3202 * stop_ap - Removes beacon from AP
3203 * @priv: Private driver interface data
3204 * Returns: 0 on success, -1 on failure (or if not supported)
3206 * This optional function can be used to disable AP mode related
3207 * configuration. Unlike deinit_ap, it does not change to station
3210 int (*stop_ap)(void *priv);
3213 * get_survey - Retrieve survey data
3214 * @priv: Private driver interface data
3215 * @freq: If set, survey data for the specified frequency is only
3216 * being requested. If not set, all survey data is requested.
3217 * Returns: 0 on success, -1 on failure
3219 * Use this to retrieve:
3221 * - the observed channel noise floor
3222 * - the amount of time we have spent on the channel
3223 * - the amount of time during which we have spent on the channel that
3224 * the radio has determined the medium is busy and we cannot
3226 * - the amount of time we have spent receiving data
3227 * - the amount of time we have spent transmitting data
3229 * This data can be used for spectrum heuristics. One example is
3230 * Automatic Channel Selection (ACS). The channel survey data is
3231 * kept on a linked list on the channel data, one entry is added
3232 * for each survey. The min_nf of the channel is updated for each
3235 int (*get_survey)(void *priv, unsigned int freq);
3238 * status - Get driver interface status information
3239 * @priv: Private driver interface data
3240 * @buf: Buffer for printing tou the status information
3241 * @buflen: Maximum length of the buffer
3242 * Returns: Length of written status information or -1 on failure
3244 int (*status)(void *priv, char *buf, size_t buflen);
3247 * roaming - Set roaming policy for driver-based BSS selection
3248 * @priv: Private driver interface data
3249 * @allowed: Whether roaming within ESS is allowed
3250 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3251 * Returns: Length of written status information or -1 on failure
3253 * This optional callback can be used to update roaming policy from the
3254 * associate() command (bssid being set there indicates that the driver
3255 * should not roam before getting this roaming() call to allow roaming.
3256 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3257 * capability, roaming policy is handled within wpa_supplicant and there
3258 * is no need to implement or react to this callback.
3260 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3263 * set_mac_addr - Set MAC address
3264 * @priv: Private driver interface data
3265 * @addr: MAC address to use or %NULL for setting back to permanent
3266 * Returns: 0 on success, -1 on failure
3268 int (*set_mac_addr)(void *priv, const u8 *addr);
3270 #ifdef CONFIG_MACSEC
3271 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3273 int (*macsec_deinit)(void *priv);
3276 * enable_protect_frames - Set protect frames status
3277 * @priv: Private driver interface data
3278 * @enabled: TRUE = protect frames enabled
3279 * FALSE = protect frames disabled
3280 * Returns: 0 on success, -1 on failure (or if not supported)
3282 int (*enable_protect_frames)(void *priv, Boolean enabled);
3285 * set_replay_protect - Set replay protect status and window size
3286 * @priv: Private driver interface data
3287 * @enabled: TRUE = replay protect enabled
3288 * FALSE = replay protect disabled
3289 * @window: replay window size, valid only when replay protect enabled
3290 * Returns: 0 on success, -1 on failure (or if not supported)
3292 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3295 * set_current_cipher_suite - Set current cipher suite
3296 * @priv: Private driver interface data
3297 * @cs: EUI64 identifier
3298 * @cs_len: Length of the cs buffer in octets
3299 * Returns: 0 on success, -1 on failure (or if not supported)
3301 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3305 * enable_controlled_port - Set controlled port status
3306 * @priv: Private driver interface data
3307 * @enabled: TRUE = controlled port enabled
3308 * FALSE = controlled port disabled
3309 * Returns: 0 on success, -1 on failure (or if not supported)
3311 int (*enable_controlled_port)(void *priv, Boolean enabled);
3314 * get_receive_lowest_pn - Get receive lowest pn
3315 * @priv: Private driver interface data
3316 * @channel: secure channel
3317 * @an: association number
3318 * @lowest_pn: lowest accept pn
3319 * Returns: 0 on success, -1 on failure (or if not supported)
3321 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3325 * get_transmit_next_pn - Get transmit next pn
3326 * @priv: Private driver interface data
3327 * @channel: secure channel
3328 * @an: association number
3330 * Returns: 0 on success, -1 on failure (or if not supported)
3332 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3336 * set_transmit_next_pn - Set transmit next pn
3337 * @priv: Private driver interface data
3338 * @channel: secure channel
3339 * @an: association number
3341 * Returns: 0 on success, -1 on failure (or if not supported)
3343 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3347 * get_available_receive_sc - get available receive channel
3348 * @priv: Private driver interface data
3349 * @channel: secure channel
3350 * Returns: 0 on success, -1 on failure (or if not supported)
3352 int (*get_available_receive_sc)(void *priv, u32 *channel);
3355 * create_receive_sc - create secure channel for receiving
3356 * @priv: Private driver interface data
3357 * @channel: secure channel
3358 * @sci_addr: secure channel identifier - address
3359 * @sci_port: secure channel identifier - port
3360 * @conf_offset: confidentiality offset (0, 30, or 50)
3361 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3363 * Returns: 0 on success, -1 on failure (or if not supported)
3365 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3366 u16 sci_port, unsigned int conf_offset,
3370 * delete_receive_sc - delete secure connection for receiving
3371 * @priv: private driver interface data from init()
3372 * @channel: secure channel
3373 * Returns: 0 on success, -1 on failure
3375 int (*delete_receive_sc)(void *priv, u32 channel);
3378 * create_receive_sa - create secure association for receive
3379 * @priv: private driver interface data from init()
3380 * @channel: secure channel
3381 * @an: association number
3382 * @lowest_pn: the lowest packet number can be received
3383 * @sak: the secure association key
3384 * Returns: 0 on success, -1 on failure
3386 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3387 u32 lowest_pn, const u8 *sak);
3390 * enable_receive_sa - enable the SA for receive
3391 * @priv: private driver interface data from init()
3392 * @channel: secure channel
3393 * @an: association number
3394 * Returns: 0 on success, -1 on failure
3396 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3399 * disable_receive_sa - disable SA for receive
3400 * @priv: private driver interface data from init()
3401 * @channel: secure channel index
3402 * @an: association number
3403 * Returns: 0 on success, -1 on failure
3405 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3408 * get_available_transmit_sc - get available transmit channel
3409 * @priv: Private driver interface data
3410 * @channel: secure channel
3411 * Returns: 0 on success, -1 on failure (or if not supported)
3413 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3416 * create_transmit_sc - create secure connection for transmit
3417 * @priv: private driver interface data from init()
3418 * @channel: secure channel
3419 * @sci_addr: secure channel identifier - address
3420 * @sci_port: secure channel identifier - port
3421 * Returns: 0 on success, -1 on failure
3423 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3424 u16 sci_port, unsigned int conf_offset);
3427 * delete_transmit_sc - delete secure connection for transmit
3428 * @priv: private driver interface data from init()
3429 * @channel: secure channel
3430 * Returns: 0 on success, -1 on failure
3432 int (*delete_transmit_sc)(void *priv, u32 channel);
3435 * create_transmit_sa - create secure association for transmit
3436 * @priv: private driver interface data from init()
3437 * @channel: secure channel index
3438 * @an: association number
3439 * @next_pn: the packet number used as next transmit packet
3440 * @confidentiality: True if the SA is to provide confidentiality
3441 * as well as integrity
3442 * @sak: the secure association key
3443 * Returns: 0 on success, -1 on failure
3445 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3446 Boolean confidentiality, const u8 *sak);
3449 * enable_transmit_sa - enable SA for transmit
3450 * @priv: private driver interface data from init()
3451 * @channel: secure channel
3452 * @an: association number
3453 * Returns: 0 on success, -1 on failure
3455 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3458 * disable_transmit_sa - disable SA for transmit
3459 * @priv: private driver interface data from init()
3460 * @channel: secure channel
3461 * @an: association number
3462 * Returns: 0 on success, -1 on failure
3464 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3465 #endif /* CONFIG_MACSEC */
3468 * init_mesh - Driver specific initialization for mesh
3469 * @priv: Private driver interface data
3470 * Returns: 0 on success, -1 on failure
3472 int (*init_mesh)(void *priv);
3475 * join_mesh - Join a mesh network
3476 * @priv: Private driver interface data
3477 * @params: Mesh configuration parameters
3478 * Returns: 0 on success, -1 on failure
3480 int (*join_mesh)(void *priv,
3481 struct wpa_driver_mesh_join_params *params);
3484 * leave_mesh - Leave a mesh network
3485 * @priv: Private driver interface data
3486 * Returns 0 on success, -1 on failure
3488 int (*leave_mesh)(void *priv);
3491 * do_acs - Automatically select channel
3492 * @priv: Private driver interface data
3493 * @params: Parameters for ACS
3494 * Returns 0 on success, -1 on failure
3496 * This command can be used to offload ACS to the driver if the driver
3497 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3499 int (*do_acs)(void *priv, struct drv_acs_params *params);
3502 * set_band - Notify driver of band selection
3503 * @priv: Private driver interface data
3504 * @band: The selected band(s)
3505 * Returns 0 on success, -1 on failure
3507 int (*set_band)(void *priv, enum set_band band);
3510 * get_pref_freq_list - Get preferred frequency list for an interface
3511 * @priv: Private driver interface data
3512 * @if_type: Interface type
3513 * @num: Number of channels
3514 * @freq_list: Preferred channel frequency list encoded in MHz values
3515 * Returns 0 on success, -1 on failure
3517 * This command can be used to query the preferred frequency list from
3518 * the driver specific to a particular interface type.
3520 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
3521 unsigned int *num, unsigned int *freq_list);
3524 * set_prob_oper_freq - Indicate probable P2P operating channel
3525 * @priv: Private driver interface data
3526 * @freq: Channel frequency in MHz
3527 * Returns 0 on success, -1 on failure
3529 * This command can be used to inform the driver of the operating
3530 * frequency that an ongoing P2P group formation is likely to come up
3531 * on. Local device is assuming P2P Client role.
3533 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
3536 * abort_scan - Request the driver to abort an ongoing scan
3537 * @priv: Private driver interface data
3538 * Returns 0 on success, -1 on failure
3540 int (*abort_scan)(void *priv);
3545 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3547 enum wpa_event_type {
3549 * EVENT_ASSOC - Association completed
3551 * This event needs to be delivered when the driver completes IEEE
3552 * 802.11 association or reassociation successfully.
3553 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3554 * after this event has been generated. In addition, optional
3555 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3556 * more information about the association. If the driver interface gets
3557 * both of these events at the same time, it can also include the
3558 * assoc_info data in EVENT_ASSOC call.
3563 * EVENT_DISASSOC - Association lost
3565 * This event should be called when association is lost either due to
3566 * receiving deauthenticate or disassociate frame from the AP or when
3567 * sending either of these frames to the current AP. If the driver
3568 * supports separate deauthentication event, EVENT_DISASSOC should only
3569 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3570 * In AP mode, union wpa_event_data::disassoc_info is required.
3575 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3577 * This event must be delivered when a Michael MIC error is detected by
3578 * the local driver. Additional data for event processing is
3579 * provided with union wpa_event_data::michael_mic_failure. This
3580 * information is used to request new encyption key and to initiate
3581 * TKIP countermeasures if needed.
3583 EVENT_MICHAEL_MIC_FAILURE,
3586 * EVENT_SCAN_RESULTS - Scan results available
3588 * This event must be called whenever scan results are available to be
3589 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3590 * is expected to be used some time after struct wpa_driver_ops::scan()
3591 * is called. If the driver provides an unsolicited event when the scan
3592 * has been completed, this event can be used to trigger
3593 * EVENT_SCAN_RESULTS call. If such event is not available from the
3594 * driver, the driver wrapper code is expected to use a registered
3595 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3596 * scan is expected to be completed. Optional information about
3597 * completed scan can be provided with union wpa_event_data::scan_info.
3602 * EVENT_ASSOCINFO - Report optional extra information for association
3604 * This event can be used to report extra association information for
3605 * EVENT_ASSOC processing. This extra information includes IEs from
3606 * association frames and Beacon/Probe Response frames in union
3607 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3608 * EVENT_ASSOC. Alternatively, the driver interface can include
3609 * assoc_info data in the EVENT_ASSOC call if it has all the
3610 * information available at the same point.
3615 * EVENT_INTERFACE_STATUS - Report interface status changes
3617 * This optional event can be used to report changes in interface
3618 * status (interface added/removed) using union
3619 * wpa_event_data::interface_status. This can be used to trigger
3620 * wpa_supplicant to stop and re-start processing for the interface,
3621 * e.g., when a cardbus card is ejected/inserted.
3623 EVENT_INTERFACE_STATUS,
3626 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3628 * This event can be used to inform wpa_supplicant about candidates for
3629 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3630 * for scan request (ap_scan=2 mode), this event is required for
3631 * pre-authentication. If wpa_supplicant is performing scan request
3632 * (ap_scan=1), this event is optional since scan results can be used
3633 * to add pre-authentication candidates. union
3634 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3635 * candidate and priority of the candidate, e.g., based on the signal
3636 * strength, in order to try to pre-authenticate first with candidates
3637 * that are most likely targets for re-association.
3639 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3640 * on the candidate list. In addition, it can be called for the current
3641 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3642 * will automatically skip pre-authentication in cases where a valid
3643 * PMKSA exists. When more than one candidate exists, this event should
3644 * be generated once for each candidate.
3646 * Driver will be notified about successful pre-authentication with
3647 * struct wpa_driver_ops::add_pmkid() calls.
3649 EVENT_PMKID_CANDIDATE,
3652 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3654 * This event can be used to inform wpa_supplicant about desire to set
3655 * up secure direct link connection between two stations as defined in
3656 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3657 * STAKey negotiation. The caller will need to set peer address for the
3663 * EVENT_TDLS - Request TDLS operation
3665 * This event can be used to request a TDLS operation to be performed.
3670 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3672 * The driver is expected to report the received FT IEs from
3673 * FT authentication sequence from the AP. The FT IEs are included in
3674 * the extra information in union wpa_event_data::ft_ies.
3679 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3681 * The driver can use this event to inform wpa_supplicant about a STA
3682 * in an IBSS with which protected frames could be exchanged. This
3683 * event starts RSN authentication with the other STA to authenticate
3684 * the STA and set up encryption keys with it.
3686 EVENT_IBSS_RSN_START,
3689 * EVENT_AUTH - Authentication result
3691 * This event should be called when authentication attempt has been
3692 * completed. This is only used if the driver supports separate
3693 * authentication step (struct wpa_driver_ops::authenticate).
3694 * Information about authentication result is included in
3695 * union wpa_event_data::auth.
3700 * EVENT_DEAUTH - Authentication lost
3702 * This event should be called when authentication is lost either due
3703 * to receiving deauthenticate frame from the AP or when sending that
3704 * frame to the current AP.
3705 * In AP mode, union wpa_event_data::deauth_info is required.
3710 * EVENT_ASSOC_REJECT - Association rejected
3712 * This event should be called when (re)association attempt has been
3713 * rejected by the AP. Information about the association response is
3714 * included in union wpa_event_data::assoc_reject.
3719 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3721 EVENT_AUTH_TIMED_OUT,
3724 * EVENT_ASSOC_TIMED_OUT - Association timed out
3726 EVENT_ASSOC_TIMED_OUT,
3729 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3731 EVENT_WPS_BUTTON_PUSHED,
3734 * EVENT_TX_STATUS - Report TX status
3739 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3741 EVENT_RX_FROM_UNKNOWN,
3744 * EVENT_RX_MGMT - Report RX of a management frame
3749 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3751 * This event is used to indicate when the driver has started the
3752 * requested remain-on-channel duration. Information about the
3753 * operation is included in union wpa_event_data::remain_on_channel.
3755 EVENT_REMAIN_ON_CHANNEL,
3758 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3760 * This event is used to indicate when the driver has completed
3761 * remain-on-channel duration, i.e., may noot be available on the
3762 * requested channel anymore. Information about the
3763 * operation is included in union wpa_event_data::remain_on_channel.
3765 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3768 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3770 * This event is used to indicate when a Probe Request frame has been
3771 * received. Information about the received frame is included in
3772 * union wpa_event_data::rx_probe_req. The driver is required to report
3773 * these events only after successfully completed probe_req_report()
3774 * commands to request the events (i.e., report parameter is non-zero)
3775 * in station mode. In AP mode, Probe Request frames should always be
3781 * EVENT_NEW_STA - New wired device noticed
3783 * This event is used to indicate that a new device has been detected
3784 * in a network that does not use association-like functionality (i.e.,
3785 * mainly wired Ethernet). This can be used to start EAPOL
3786 * authenticator when receiving a frame from a device. The address of
3787 * the device is included in union wpa_event_data::new_sta.
3792 * EVENT_EAPOL_RX - Report received EAPOL frame
3794 * When in AP mode with hostapd, this event is required to be used to
3795 * deliver the receive EAPOL frames from the driver.
3800 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3802 * This event is used to indicate changes in the signal strength
3803 * observed in frames received from the current AP if signal strength
3804 * monitoring has been enabled with signal_monitor().
3806 EVENT_SIGNAL_CHANGE,
3809 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3811 * This event is used to indicate that the interface was enabled after
3812 * having been previously disabled, e.g., due to rfkill.
3814 EVENT_INTERFACE_ENABLED,
3817 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3819 * This event is used to indicate that the interface was disabled,
3820 * e.g., due to rfkill.
3822 EVENT_INTERFACE_DISABLED,
3825 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3827 * This event is used to indicate that the channel list has changed,
3828 * e.g., because of a regulatory domain change triggered by scan
3829 * results including an AP advertising a country code.
3831 EVENT_CHANNEL_LIST_CHANGED,
3834 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3836 * This event is used to indicate that the driver cannot maintain this
3837 * interface in its operation mode anymore. The most likely use for
3838 * this is to indicate that AP mode operation is not available due to
3839 * operating channel would need to be changed to a DFS channel when
3840 * the driver does not support radar detection and another virtual
3841 * interfaces caused the operating channel to change. Other similar
3842 * resource conflicts could also trigger this for station mode
3843 * interfaces. This event can be propagated when channel switching
3846 EVENT_INTERFACE_UNAVAILABLE,
3849 * EVENT_BEST_CHANNEL
3851 * Driver generates this event whenever it detects a better channel
3852 * (e.g., based on RSSI or channel use). This information can be used
3853 * to improve channel selection for a new AP/P2P group.
3858 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3860 * This event should be called when a Deauthentication frame is dropped
3861 * due to it not being protected (MFP/IEEE 802.11w).
3862 * union wpa_event_data::unprot_deauth is required to provide more
3863 * details of the frame.
3865 EVENT_UNPROT_DEAUTH,
3868 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3870 * This event should be called when a Disassociation frame is dropped
3871 * due to it not being protected (MFP/IEEE 802.11w).
3872 * union wpa_event_data::unprot_disassoc is required to provide more
3873 * details of the frame.
3875 EVENT_UNPROT_DISASSOC,
3878 * EVENT_STATION_LOW_ACK
3880 * Driver generates this event whenever it detected that a particular
3881 * station was lost. Detection can be through massive transmission
3882 * failures for example.
3884 EVENT_STATION_LOW_ACK,
3887 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3889 EVENT_IBSS_PEER_LOST,
3892 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3894 * This event carries the new replay counter to notify wpa_supplicant
3895 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3896 * completed Group Key Handshake while the host (including
3897 * wpa_supplicant was sleeping).
3899 EVENT_DRIVER_GTK_REKEY,
3902 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3904 EVENT_SCHED_SCAN_STOPPED,
3907 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3909 * This event indicates that the station responded to the poll
3910 * initiated with @poll_client.
3912 EVENT_DRIVER_CLIENT_POLL_OK,
3915 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3917 EVENT_EAPOL_TX_STATUS,
3920 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3922 * Described in wpa_event_data.ch_switch
3927 * EVENT_WNM - Request WNM operation
3929 * This event can be used to request a WNM operation to be performed.
3934 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3936 * This event indicates that the driver reported a connection failure
3937 * with the specified client (for example, max client reached, etc.) in
3940 EVENT_CONNECT_FAILED_REASON,
3943 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
3945 * A radar has been detected on the supplied frequency, hostapd should
3946 * react accordingly (e.g., change channel).
3948 EVENT_DFS_RADAR_DETECTED,
3951 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
3953 * After a successful CAC, the channel can be marked clear and used.
3955 EVENT_DFS_CAC_FINISHED,
3958 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
3960 * The CAC was not successful, and the channel remains in the previous
3961 * state. This may happen due to a radar beeing detected or other
3962 * external influences.
3964 EVENT_DFS_CAC_ABORTED,
3967 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
3969 * The channel which was previously unavailable is now available again.
3971 EVENT_DFS_NOP_FINISHED,
3974 * EVENT_SURVEY - Received survey data
3976 * This event gets triggered when a driver query is issued for survey
3977 * data and the requested data becomes available. The returned data is
3978 * stored in struct survey_results. The results provide at most one
3979 * survey entry for each frequency and at minimum will provide one
3980 * survey entry for one frequency. The survey data can be os_malloc()'d
3981 * and then os_free()'d, so the event callback must only copy data.
3986 * EVENT_SCAN_STARTED - Scan started
3988 * This indicates that driver has started a scan operation either based
3989 * on a request from wpa_supplicant/hostapd or from another application.
3990 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3991 * completed (either successfully or by getting cancelled).
3996 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3998 * This event indicates a set of frequency ranges that should be avoided
3999 * to reduce issues due to interference or internal co-existence
4000 * information in the driver.
4002 EVENT_AVOID_FREQUENCIES,
4005 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4007 EVENT_NEW_PEER_CANDIDATE,
4010 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4012 * Indicates a pair of primary and secondary channels chosen by ACS
4015 EVENT_ACS_CHANNEL_SELECTED,
4018 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4021 * This event indicates that channel availability check has been started
4022 * on a DFS frequency by a driver that supports DFS Offload.
4024 EVENT_DFS_CAC_STARTED,
4029 * struct freq_survey - Channel survey info
4031 * @ifidx: Interface index in which this survey was observed
4032 * @freq: Center of frequency of the surveyed channel
4033 * @nf: Channel noise floor in dBm
4034 * @channel_time: Amount of time in ms the radio spent on the channel
4035 * @channel_time_busy: Amount of time in ms the radio detected some signal
4036 * that indicated to the radio the channel was not clear
4037 * @channel_time_rx: Amount of time the radio spent receiving data
4038 * @channel_time_tx: Amount of time the radio spent transmitting data
4039 * @filled: bitmask indicating which fields have been reported, see
4040 * SURVEY_HAS_* defines.
4041 * @list: Internal list pointers
4043 struct freq_survey {
4048 u64 channel_time_busy;
4049 u64 channel_time_rx;
4050 u64 channel_time_tx;
4051 unsigned int filled;
4052 struct dl_list list;
4055 #define SURVEY_HAS_NF BIT(0)
4056 #define SURVEY_HAS_CHAN_TIME BIT(1)
4057 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4058 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4059 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4063 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4065 union wpa_event_data {
4067 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4069 * This structure is optional for EVENT_ASSOC calls and required for
4070 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4071 * driver interface does not need to generate separate EVENT_ASSOCINFO
4076 * reassoc - Flag to indicate association or reassociation
4081 * req_ies - (Re)Association Request IEs
4083 * If the driver generates WPA/RSN IE, this event data must be
4084 * returned for WPA handshake to have needed information. If
4085 * wpa_supplicant-generated WPA/RSN IE is used, this
4086 * information event is optional.
4088 * This should start with the first IE (fixed fields before IEs
4089 * are not included).
4094 * req_ies_len - Length of req_ies in bytes
4099 * resp_ies - (Re)Association Response IEs
4101 * Optional association data from the driver. This data is not
4102 * required WPA, but may be useful for some protocols and as
4103 * such, should be reported if this is available to the driver
4106 * This should start with the first IE (fixed fields before IEs
4107 * are not included).
4112 * resp_ies_len - Length of resp_ies in bytes
4114 size_t resp_ies_len;
4117 * beacon_ies - Beacon or Probe Response IEs
4119 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4120 * Probe Response frames from the current AP (i.e., the one
4121 * that the client just associated with). This information is
4122 * used to update WPA/RSN IE for the AP. If this field is not
4123 * set, the results from previous scan will be used. If no
4124 * data for the new AP is found, scan results will be requested
4125 * again (without scan request). At this point, the driver is
4126 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4129 * This should start with the first IE (fixed fields before IEs
4130 * are not included).
4132 const u8 *beacon_ies;
4135 * beacon_ies_len - Length of beacon_ies */
4136 size_t beacon_ies_len;
4139 * freq - Frequency of the operational channel in MHz
4144 * wmm_params - WMM parameters used in this association.
4146 struct wmm_params wmm_params;
4149 * addr - Station address (for AP mode)
4154 * The following is the key management offload information
4157 * @key_replay_ctr_len
4165 * authorized - Status of key management offload,
4171 * key_replay_ctr - Key replay counter value last used
4172 * in a valid EAPOL-Key frame
4174 const u8 *key_replay_ctr;
4177 * key_replay_ctr_len - The length of key_replay_ctr
4179 size_t key_replay_ctr_len;
4182 * ptk_kck - The derived PTK KCK
4187 * ptk_kek_len - The length of ptk_kck
4192 * ptk_kek - The derived PTK KEK
4197 * ptk_kek_len - The length of ptk_kek
4202 * subnet_status - The subnet status:
4203 * 0 = unknown, 1 = unchanged, 2 = changed
4209 * struct disassoc_info - Data for EVENT_DISASSOC events
4211 struct disassoc_info {
4213 * addr - Station address (for AP mode)
4218 * reason_code - Reason Code (host byte order) used in
4219 * Deauthentication frame
4224 * ie - Optional IE(s) in Disassociation frame
4229 * ie_len - Length of ie buffer in octets
4234 * locally_generated - Whether the frame was locally generated
4236 int locally_generated;
4240 * struct deauth_info - Data for EVENT_DEAUTH events
4242 struct deauth_info {
4244 * addr - Station address (for AP mode)
4249 * reason_code - Reason Code (host byte order) used in
4250 * Deauthentication frame
4255 * ie - Optional IE(s) in Deauthentication frame
4260 * ie_len - Length of ie buffer in octets
4265 * locally_generated - Whether the frame was locally generated
4267 int locally_generated;
4271 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4273 struct michael_mic_failure {
4276 } michael_mic_failure;
4279 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4281 struct interface_status {
4282 unsigned int ifindex;
4285 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4290 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4292 struct pmkid_candidate {
4293 /** BSSID of the PMKID candidate */
4295 /** Smaller the index, higher the priority */
4297 /** Whether RSN IE includes pre-authenticate flag */
4302 * struct stkstart - Data for EVENT_STKSTART
4309 * struct tdls - Data for EVENT_TDLS
4315 TDLS_REQUEST_TEARDOWN,
4316 TDLS_REQUEST_DISCOVER,
4318 u16 reason_code; /* for teardown */
4322 * struct wnm - Data for EVENT_WNM
4340 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4342 * During FT (IEEE 802.11r) authentication sequence, the driver is
4343 * expected to use this event to report received FT IEs (MDIE, FTIE,
4344 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4345 * IEs for the next message will be delivered through the
4346 * struct wpa_driver_ops::update_ft_ies() callback.
4352 u8 target_ap[ETH_ALEN];
4353 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4355 /** Length of ric_ies buffer in octets */
4360 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4362 struct ibss_rsn_start {
4367 * struct auth_info - Data for EVENT_AUTH events
4373 u16 auth_transaction;
4380 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4382 struct assoc_reject {
4384 * bssid - BSSID of the AP that rejected association
4389 * resp_ies - (Re)Association Response IEs
4391 * Optional association data from the driver. This data is not
4392 * required WPA, but may be useful for some protocols and as
4393 * such, should be reported if this is available to the driver
4396 * This should start with the first IE (fixed fields before IEs
4397 * are not included).
4402 * resp_ies_len - Length of resp_ies in bytes
4404 size_t resp_ies_len;
4407 * status_code - Status Code from (Re)association Response
4412 struct timeout_event {
4417 * struct tx_status - Data for EVENT_TX_STATUS events
4429 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4431 struct rx_from_unknown {
4438 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4446 * drv_priv - Pointer to store driver private BSS information
4448 * If not set to NULL, this is used for comparison with
4449 * hostapd_data->drv_priv to determine which BSS should process
4455 * freq - Frequency (in MHz) on which the frame was received
4460 * ssi_signal - Signal strength in dBm (or 0 if not available)
4466 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4468 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4470 struct remain_on_channel {
4472 * freq - Channel frequency in MHz
4477 * duration - Duration to remain on the channel in milliseconds
4479 unsigned int duration;
4480 } remain_on_channel;
4483 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4484 * @aborted: Whether the scan was aborted
4485 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4486 * @num_freqs: Number of entries in freqs array
4487 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4489 * @num_ssids: Number of entries in ssids array
4490 * @external_scan: Whether the scan info is for an external scan
4491 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
4492 * 0 if the source of the scan event is a vendor scan
4498 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4505 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4507 struct rx_probe_req {
4509 * sa - Source address of the received Probe Request frame
4514 * da - Destination address of the received Probe Request frame
4515 * or %NULL if not available
4520 * bssid - BSSID of the received Probe Request frame or %NULL
4526 * ie - IEs from the Probe Request body
4531 * ie_len - Length of ie buffer in octets
4536 * signal - signal strength in dBm (or 0 if not available)
4542 * struct new_sta - Data for EVENT_NEW_STA events
4549 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4558 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4560 struct wpa_signal_info signal_change;
4563 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4564 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4565 * @freq_5: Best 5 GHz band channel frequency in MHz
4566 * @freq_overall: Best channel frequency in MHz
4568 * 0 can be used to indicate no preference in either band.
4570 struct best_channel {
4576 struct unprot_deauth {
4582 struct unprot_disassoc {
4589 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4590 * @addr: station address
4597 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4599 struct ibss_peer_lost {
4604 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4606 struct driver_gtk_rekey {
4608 const u8 *replay_ctr;
4612 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4613 * @addr: station address
4615 struct client_poll {
4620 * struct eapol_tx_status
4621 * @dst: Original destination
4622 * @data: Data starting with IEEE 802.1X header (!)
4623 * @data_len: Length of data
4624 * @ack: Indicates ack or lost frame
4626 * This corresponds to hapd_send_eapol if the frame sent
4627 * there isn't just reported as EVENT_TX_STATUS.
4629 struct eapol_tx_status {
4638 * @freq: Frequency of new channel in MHz
4639 * @ht_enabled: Whether this is an HT channel
4640 * @ch_offset: Secondary channel offset
4641 * @ch_width: Channel width
4642 * @cf1: Center frequency 1
4643 * @cf2: Center frequency 2
4649 enum chan_width ch_width;
4655 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4656 * @addr: Remote client address
4657 * @code: Reason code for connection failure
4659 struct connect_failed_reason {
4665 } connect_failed_reason;
4668 * struct dfs_event - Data for radar detected events
4669 * @freq: Frequency of the channel in MHz
4675 enum chan_width chan_width;
4681 * survey_results - Survey result data for EVENT_SURVEY
4682 * @freq_filter: Requested frequency survey filter, 0 if request
4683 * was for all survey data
4684 * @survey_list: Linked list of survey data (struct freq_survey)
4686 struct survey_results {
4687 unsigned int freq_filter;
4688 struct dl_list survey_list; /* struct freq_survey */
4692 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4693 * @initiator: Initiator of the regulatory change
4694 * @type: Regulatory change type
4695 * @alpha2: Country code (or "" if not available)
4697 struct channel_list_changed {
4698 enum reg_change_initiator initiator;
4701 } channel_list_changed;
4704 * freq_range - List of frequency ranges
4706 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4708 struct wpa_freq_range_list freq_range;
4713 * @peer: Peer address
4715 * @ie_len: Length of @ies
4717 * Notification of new candidate mesh peer.
4726 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4727 * @pri_channel: Selected primary channel
4728 * @sec_channel: Selected secondary channel
4729 * @vht_seg0_center_ch: VHT mode Segment0 center channel
4730 * @vht_seg1_center_ch: VHT mode Segment1 center channel
4731 * @ch_width: Selected Channel width by driver. Driver may choose to
4732 * change hostapd configured ACS channel width due driver internal
4733 * channel restrictions.
4734 * hw_mode: Selected band (used with hw_mode=any)
4736 struct acs_selected_channels {
4739 u8 vht_seg0_center_ch;
4740 u8 vht_seg1_center_ch;
4742 enum hostapd_hw_mode hw_mode;
4743 } acs_selected_channels;
4747 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4748 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4749 * with struct wpa_driver_ops::init()
4750 * @event: event type (defined above)
4751 * @data: possible extra data for the event
4753 * Driver wrapper code should call this function whenever an event is received
4756 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4757 union wpa_event_data *data);
4760 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
4761 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4762 * with struct wpa_driver_ops::init()
4763 * @event: event type (defined above)
4764 * @data: possible extra data for the event
4766 * Same as wpa_supplicant_event(), but we search for the interface in
4769 void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
4770 union wpa_event_data *data);
4773 * The following inline functions are provided for convenience to simplify
4774 * event indication for some of the common events.
4777 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4778 size_t ielen, int reassoc)
4780 union wpa_event_data event;
4781 os_memset(&event, 0, sizeof(event));
4782 event.assoc_info.reassoc = reassoc;
4783 event.assoc_info.req_ies = ie;
4784 event.assoc_info.req_ies_len = ielen;
4785 event.assoc_info.addr = addr;
4786 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4789 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4791 union wpa_event_data event;
4792 os_memset(&event, 0, sizeof(event));
4793 event.disassoc_info.addr = addr;
4794 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4797 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4800 union wpa_event_data event;
4801 os_memset(&event, 0, sizeof(event));
4802 event.eapol_rx.src = src;
4803 event.eapol_rx.data = data;
4804 event.eapol_rx.data_len = data_len;
4805 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4808 /* driver_common.c */
4809 void wpa_scan_results_free(struct wpa_scan_results *res);
4811 /* Convert wpa_event_type to a string for logging */
4812 const char * event_to_string(enum wpa_event_type event);
4814 /* Convert chan_width to a string for logging and control interfaces */
4815 const char * channel_width_to_string(enum chan_width width);
4817 int ht_supported(const struct hostapd_hw_modes *mode);
4818 int vht_supported(const struct hostapd_hw_modes *mode);
4820 struct wowlan_triggers *
4821 wpa_get_wowlan_triggers(const char *wowlan_triggers,
4822 const struct wpa_driver_capa *capa);
4824 /* NULL terminated array of linked in driver wrappers */
4825 extern const struct wpa_driver_ops *const wpa_drivers[];
4827 #endif /* DRIVER_H */