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 * NOTE: Whenever adding new parameters here, please make sure
444 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
450 * struct wpa_driver_auth_params - Authentication parameters
451 * Data for struct wpa_driver_ops::authenticate().
453 struct wpa_driver_auth_params {
461 const u8 *wep_key[4];
462 size_t wep_key_len[4];
464 int local_state_change;
467 * p2p - Whether this connection is a P2P group
472 * sae_data - SAE elements for Authentication frame
474 * This buffer starts with the Authentication transaction sequence
475 * number field. If SAE is not used, this pointer is %NULL.
480 * sae_data_len - Length of sae_data buffer in octets
486 * enum wps_mode - WPS mode
490 * WPS_MODE_NONE - No WPS provisioning being used
495 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
500 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
506 * struct hostapd_freq_params - Channel parameters
508 struct hostapd_freq_params {
510 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
512 enum hostapd_hw_mode mode;
515 * freq - Primary channel center frequency in MHz
520 * channel - Channel number
525 * ht_enabled - Whether HT is enabled
530 * sec_channel_offset - Secondary channel offset for HT40
533 * -1 = HT40 enabled, secondary channel below primary,
534 * 1 = HT40 enabled, secondary channel above primary
536 int sec_channel_offset;
539 * vht_enabled - Whether VHT is enabled
544 * center_freq1 - Segment 0 center frequency in MHz
546 * Valid for both HT and VHT.
551 * center_freq2 - Segment 1 center frequency in MHz
553 * Non-zero only for bandwidth 80 and an 80+80 channel
558 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
564 * struct wpa_driver_associate_params - Association parameters
565 * Data for struct wpa_driver_ops::associate().
567 struct wpa_driver_associate_params {
569 * bssid - BSSID of the selected AP
570 * This can be %NULL, if ap_scan=2 mode is used and the driver is
571 * responsible for selecting with which BSS to associate. */
575 * bssid_hint - BSSID of a proposed AP
577 * This indicates which BSS has been found a suitable candidate for
578 * initial association for drivers that use driver/firmwate-based BSS
579 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
580 * the driver from selecting other BSSes in the ESS.
582 const u8 *bssid_hint;
585 * ssid - The selected SSID
590 * ssid_len - Length of the SSID (1..32)
595 * freq - channel parameters
597 struct hostapd_freq_params freq;
600 * freq_hint - Frequency of the channel the proposed AP is using
602 * This provides a channel on which a suitable BSS has been found as a
603 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
604 * limit the driver from selecting other channels for
605 * driver/firmware-based BSS selection.
610 * bg_scan_period - Background scan period in seconds, 0 to disable
611 * background scan, or -1 to indicate no change to default driver
617 * beacon_int - Beacon interval for IBSS or 0 to use driver default
622 * wpa_ie - WPA information element for (Re)Association Request
623 * WPA information element to be included in (Re)Association
624 * Request (including information element id and length). Use
625 * of this WPA IE is optional. If the driver generates the WPA
626 * IE, it can use pairwise_suite, group_suite, and
627 * key_mgmt_suite to select proper algorithms. In this case,
628 * the driver has to notify wpa_supplicant about the used WPA
629 * IE by generating an event that the interface code will
630 * convert into EVENT_ASSOCINFO data (see below).
632 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
633 * instead. The driver can determine which version is used by
634 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
637 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
642 * wpa_ie_len - length of the wpa_ie
647 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
649 unsigned int wpa_proto;
652 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
654 * This is usually ignored if @wpa_ie is used.
656 unsigned int pairwise_suite;
659 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
661 * This is usually ignored if @wpa_ie is used.
663 unsigned int group_suite;
666 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
668 * This is usually ignored if @wpa_ie is used.
670 unsigned int key_mgmt_suite;
673 * auth_alg - Allowed authentication algorithms
674 * Bit field of WPA_AUTH_ALG_*
679 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
684 * wep_key - WEP keys for static WEP configuration
686 const u8 *wep_key[4];
689 * wep_key_len - WEP key length for static WEP configuration
691 size_t wep_key_len[4];
694 * wep_tx_keyidx - WEP TX key index for static WEP configuration
699 * mgmt_frame_protection - IEEE 802.11w management frame protection
701 enum mfp_options mgmt_frame_protection;
704 * ft_ies - IEEE 802.11r / FT information elements
705 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
706 * for fast transition, this parameter is set to include the IEs that
707 * are to be sent in the next FT Authentication Request message.
708 * update_ft_ies() handler is called to update the IEs for further
709 * FT messages in the sequence.
711 * The driver should use these IEs only if the target AP is advertising
712 * the same mobility domain as the one included in the MDIE here.
714 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
715 * AP after the initial association. These IEs can only be used if the
716 * target AP is advertising support for FT and is using the same MDIE
717 * and SSID as the current AP.
719 * The driver is responsible for reporting the FT IEs received from the
720 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
721 * type. update_ft_ies() handler will then be called with the FT IEs to
722 * include in the next frame in the authentication sequence.
727 * ft_ies_len - Length of ft_ies in bytes
732 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
734 * This value is provided to allow the driver interface easier access
735 * to the current mobility domain. This value is set to %NULL if no
736 * mobility domain is currently active.
741 * passphrase - RSN passphrase for PSK
743 * This value is made available only for WPA/WPA2-Personal (PSK) and
744 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
745 * the 8..63 character ASCII passphrase, if available. Please note that
746 * this can be %NULL if passphrase was not used to generate the PSK. In
747 * that case, the psk field must be used to fetch the PSK.
749 const char *passphrase;
752 * psk - RSN PSK (alternative for passphrase for PSK)
754 * This value is made available only for WPA/WPA2-Personal (PSK) and
755 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
756 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
757 * be prepared to handle %NULL value as an error.
762 * drop_unencrypted - Enable/disable unencrypted frame filtering
764 * Configure the driver to drop all non-EAPOL frames (both receive and
765 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
766 * still be allowed for key negotiation.
768 int drop_unencrypted;
771 * prev_bssid - Previously used BSSID in this ESS
773 * When not %NULL, this is a request to use reassociation instead of
776 const u8 *prev_bssid;
781 * If the driver needs to do special configuration for WPS association,
782 * this variable provides more information on what type of association
783 * is being requested. Most drivers should not need ot use this.
788 * p2p - Whether this connection is a P2P group
793 * uapsd - UAPSD parameters for the network
794 * -1 = do not change defaults
795 * AP mode: 1 = enabled, 0 = disabled
796 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
801 * fixed_bssid - Whether to force this BSSID in IBSS mode
802 * 1 = Fix this BSSID and prevent merges.
803 * 0 = Do not fix BSSID.
808 * fixed_freq - Fix control channel in IBSS mode
809 * 0 = don't fix control channel (default)
810 * 1 = fix control channel; this prevents IBSS merging with another
816 * disable_ht - Disable HT (IEEE 802.11n) for this connection
821 * htcaps - HT Capabilities over-rides
823 * Only bits set in the mask will be used, and not all values are used
824 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
826 * Pointer to struct ieee80211_ht_capabilities.
831 * htcaps_mask - HT Capabilities over-rides mask
833 * Pointer to struct ieee80211_ht_capabilities.
835 const u8 *htcaps_mask;
837 #ifdef CONFIG_VHT_OVERRIDES
839 * disable_vht - Disable VHT for this connection
844 * VHT capability overrides.
846 const struct ieee80211_vht_capabilities *vhtcaps;
847 const struct ieee80211_vht_capabilities *vhtcaps_mask;
848 #endif /* CONFIG_VHT_OVERRIDES */
851 * req_key_mgmt_offload - Request key management offload for connection
853 * Request key management offload for this connection if the device
856 int req_key_mgmt_offload;
859 * Flag for indicating whether this association includes support for
860 * RRM (Radio Resource Measurements)
867 HIDDEN_SSID_ZERO_LEN,
868 HIDDEN_SSID_ZERO_CONTENTS
871 struct wowlan_triggers {
875 u8 gtk_rekey_failure;
877 u8 four_way_handshake;
881 struct wpa_driver_ap_params {
883 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
888 * head_len - Length of the head buffer in octets
893 * tail - Beacon tail following TIM IE
898 * tail_len - Length of the tail buffer in octets
903 * dtim_period - DTIM period
908 * beacon_int - Beacon interval
913 * basic_rates: -1 terminated array of basic rates in 100 kbps
915 * This parameter can be used to set a specific basic rate set for the
916 * BSS. If %NULL, default basic rate set is used.
921 * proberesp - Probe Response template
923 * This is used by drivers that reply to Probe Requests internally in
924 * AP mode and require the full Probe Response template.
929 * proberesp_len - Length of the proberesp buffer in octets
931 size_t proberesp_len;
934 * ssid - The SSID to use in Beacon/Probe Response frames
939 * ssid_len - Length of the SSID (1..32)
944 * hide_ssid - Whether to hide the SSID
946 enum hide_ssid hide_ssid;
949 * pairwise_ciphers - WPA_CIPHER_* bitfield
951 unsigned int pairwise_ciphers;
954 * group_cipher - WPA_CIPHER_*
956 unsigned int group_cipher;
959 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
961 unsigned int key_mgmt_suites;
964 * auth_algs - WPA_AUTH_ALG_* bitfield
966 unsigned int auth_algs;
969 * wpa_version - WPA_PROTO_* bitfield
971 unsigned int wpa_version;
974 * privacy - Whether privacy is used in the BSS
979 * beacon_ies - WPS/P2P IE(s) for Beacon frames
981 * This is used to add IEs like WPS IE and P2P IE by drivers that do
982 * not use the full Beacon template.
984 const struct wpabuf *beacon_ies;
987 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
989 * This is used to add IEs like WPS IE and P2P IE by drivers that
990 * reply to Probe Request frames internally.
992 const struct wpabuf *proberesp_ies;
995 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
997 * This is used to add IEs like WPS IE by drivers that reply to
998 * (Re)Association Request frames internally.
1000 const struct wpabuf *assocresp_ies;
1003 * isolate - Whether to isolate frames between associated stations
1005 * If this is non-zero, the AP is requested to disable forwarding of
1006 * frames between associated stations.
1011 * cts_protect - Whether CTS protection is enabled
1016 * preamble - Whether short preamble is enabled
1021 * short_slot_time - Whether short slot time is enabled
1023 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1024 * not set (e.g., when 802.11g mode is not in use)
1026 int short_slot_time;
1029 * ht_opmode - HT operation mode or -1 if HT not in use
1034 * interworking - Whether Interworking is enabled
1039 * hessid - Homogeneous ESS identifier or %NULL if not set
1044 * access_network_type - Access Network Type (0..15)
1046 * This is used for filtering Probe Request frames when Interworking is
1049 u8 access_network_type;
1052 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1054 * This is used by driver which advertises this capability.
1056 int ap_max_inactivity;
1059 * ctwindow - Client Traffic Window (in TUs)
1064 * smps_mode - SMPS mode
1066 * SMPS mode to be used by the AP, specified as the relevant bits of
1067 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1069 unsigned int smps_mode;
1072 * disable_dgaf - Whether group-addressed frames are disabled
1077 * osen - Whether OSEN security is enabled
1082 * freq - Channel parameters for dynamic bandwidth changes
1084 struct hostapd_freq_params *freq;
1087 * reenable - Whether this is to re-enable beaconing
1092 struct wpa_driver_mesh_bss_params {
1093 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1095 * TODO: Other mesh configuration parameters would go here.
1096 * See NL80211_MESHCONF_* for all the mesh config parameters.
1099 int peer_link_timeout;
1102 struct wpa_driver_mesh_join_params {
1105 const int *basic_rates;
1108 struct hostapd_freq_params freq;
1111 struct wpa_driver_mesh_bss_params conf;
1112 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1113 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1114 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1115 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1120 * struct wpa_driver_capa - Driver capability information
1122 struct wpa_driver_capa {
1123 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1124 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1125 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1126 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1127 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1128 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1129 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1130 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1131 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1132 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
1133 /** Bitfield of supported key management suites */
1134 unsigned int key_mgmt;
1136 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1137 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1138 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1139 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1140 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1141 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1142 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1143 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1144 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1145 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1146 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1147 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1148 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1149 /** Bitfield of supported cipher suites */
1152 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1153 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1154 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1155 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1158 /** Driver generated WPA/RSN IE */
1159 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1160 /** Driver needs static WEP key setup after association command */
1161 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1162 /** Driver takes care of all DFS operations */
1163 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1164 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1165 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1166 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1167 /** Driver is for a wired Ethernet interface */
1168 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1169 /** Driver provides separate commands for authentication and association (SME in
1170 * wpa_supplicant). */
1171 #define WPA_DRIVER_FLAGS_SME 0x00000020
1172 /** Driver supports AP mode */
1173 #define WPA_DRIVER_FLAGS_AP 0x00000040
1174 /** Driver needs static WEP key setup after association has been completed */
1175 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1176 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1177 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1178 /** Driver supports concurrent P2P operations */
1179 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1181 * Driver uses the initial interface as a dedicated management interface, i.e.,
1182 * it cannot be used for P2P group operations or non-P2P purposes.
1184 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1185 /** This interface is P2P capable (P2P GO or P2P Client) */
1186 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1187 /** Driver supports station and key removal when stopping an AP */
1188 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1190 * Driver uses the initial interface for P2P management interface and non-P2P
1191 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1192 * P2P group operations.
1194 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1196 * Driver is known to use sane error codes, i.e., when it indicates that
1197 * something (e.g., association) fails, there was indeed a failure and the
1198 * operation does not end up getting completed successfully later.
1200 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1201 /** Driver supports off-channel TX */
1202 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1203 /** Driver indicates TX status events for EAPOL Data frames */
1204 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1205 /** Driver indicates TX status events for Deauth/Disassoc frames */
1206 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1207 /** Driver supports roaming (BSS selection) in firmware */
1208 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1209 /** Driver supports operating as a TDLS peer */
1210 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1211 /** Driver requires external TDLS setup/teardown/discovery */
1212 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1213 /** Driver indicates support for Probe Response offloading in AP mode */
1214 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1215 /** Driver supports U-APSD in AP mode */
1216 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1217 /** Driver supports inactivity timer in AP mode */
1218 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1219 /** Driver expects user space implementation of MLME in AP mode */
1220 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1221 /** Driver supports SAE with user space SME */
1222 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1223 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1224 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1225 /** Driver supports IBSS (Ad-hoc) mode */
1226 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1227 /** Driver supports radar detection */
1228 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1229 /** Driver supports a dedicated interface for P2P Device */
1230 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1231 /** Driver supports QoS Mapping */
1232 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1233 /** Driver supports CSA in AP mode */
1234 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1235 /** Driver supports mesh */
1236 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1237 /** Driver support ACS offload */
1238 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1239 /** Driver supports key management offload */
1240 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1241 /** Driver supports TDLS channel switching */
1242 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1243 /** Driver supports IBSS with HT datarates */
1244 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
1245 /** Driver supports IBSS with VHT datarates */
1246 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
1247 /** Driver supports automatic band selection */
1248 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
1249 /** Driver supports simultaneous off-channel operations */
1250 #define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
1253 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1254 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1255 unsigned int smps_modes;
1257 unsigned int wmm_ac_supported:1;
1259 unsigned int mac_addr_rand_scan_supported:1;
1260 unsigned int mac_addr_rand_sched_scan_supported:1;
1262 /** Maximum number of supported active probe SSIDs */
1265 /** Maximum number of supported active probe SSIDs for sched_scan */
1266 int max_sched_scan_ssids;
1268 /** Maximum number of supported scan plans for scheduled scan */
1269 unsigned int max_sched_scan_plans;
1271 /** Maximum interval in a scan plan. In seconds */
1272 u32 max_sched_scan_plan_interval;
1274 /** Maximum number of iterations in a single scan plan */
1275 u32 max_sched_scan_plan_iterations;
1277 /** Whether sched_scan (offloaded scanning) is supported */
1278 int sched_scan_supported;
1280 /** Maximum number of supported match sets for sched_scan */
1284 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1286 unsigned int max_remain_on_chan;
1289 * max_stations - Maximum number of associated stations the driver
1290 * supports in AP mode
1292 unsigned int max_stations;
1295 * probe_resp_offloads - Bitmap of supported protocols by the driver
1296 * for Probe Response offloading.
1298 /** Driver Probe Response offloading support for WPS ver. 1 */
1299 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1300 /** Driver Probe Response offloading support for WPS ver. 2 */
1301 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1302 /** Driver Probe Response offloading support for P2P */
1303 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1304 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1305 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1306 unsigned int probe_resp_offloads;
1308 unsigned int max_acl_mac_addrs;
1311 * Number of supported concurrent channels
1313 unsigned int num_multichan_concurrent;
1316 * extended_capa - extended capabilities in driver/device
1318 * Must be allocated and freed by driver and the pointers must be
1319 * valid for the lifetime of the driver, i.e., freed in deinit()
1321 const u8 *extended_capa, *extended_capa_mask;
1322 unsigned int extended_capa_len;
1324 struct wowlan_triggers wowlan_triggers;
1326 /** Driver adds the DS Params Set IE in Probe Request frames */
1327 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1328 /** Driver adds the WFA TPC IE in Probe Request frames */
1329 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1330 /** Driver handles quiet period requests */
1331 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1333 * Driver is capable of inserting the current TX power value into the body of
1334 * transmitted frames.
1335 * Background: Some Action frames include a TPC Report IE. This IE contains a
1336 * TX power field, which has to be updated by lower layers. One such Action
1337 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1338 * of spectrum management). Note that this insertion takes place at a fixed
1339 * offset, namely the 6th byte in the Action frame body.
1341 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1344 /* Driver concurrency capabilities */
1345 unsigned int conc_capab;
1346 /* Maximum number of concurrent channels on 2.4 GHz */
1347 unsigned int max_conc_chan_2_4;
1348 /* Maximum number of concurrent channels on 5 GHz */
1349 unsigned int max_conc_chan_5_0;
1351 /* Maximum number of supported CSA counters */
1352 u16 max_csa_counters;
1356 struct hostapd_data;
1358 struct hostap_sta_driver_data {
1359 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1360 unsigned long current_tx_rate;
1361 unsigned long inactive_msec;
1362 unsigned long flags;
1363 unsigned long num_ps_buf_frames;
1364 unsigned long tx_retry_failed;
1365 unsigned long tx_retry_count;
1370 struct hostapd_sta_add_params {
1374 const u8 *supp_rates;
1375 size_t supp_rates_len;
1376 u16 listen_interval;
1377 const struct ieee80211_ht_capabilities *ht_capabilities;
1378 const struct ieee80211_vht_capabilities *vht_capabilities;
1379 int vht_opmode_enabled;
1381 u32 flags; /* bitmask of WPA_STA_* flags */
1382 u32 flags_mask; /* unset bits in flags */
1384 enum mesh_plink_state plink_state;
1385 #endif /* CONFIG_MESH */
1386 int set; /* Set STA parameters instead of add */
1388 const u8 *ext_capab;
1389 size_t ext_capab_len;
1390 const u8 *supp_channels;
1391 size_t supp_channels_len;
1392 const u8 *supp_oper_classes;
1393 size_t supp_oper_classes_len;
1396 struct mac_address {
1400 struct hostapd_acl_params {
1402 unsigned int num_mac_acl;
1403 struct mac_address mac_acl[0];
1406 enum wpa_driver_if_type {
1408 * WPA_IF_STATION - Station mode interface
1413 * WPA_IF_AP_VLAN - AP mode VLAN interface
1415 * This interface shares its address and Beacon frame with the main
1421 * WPA_IF_AP_BSS - AP mode BSS interface
1423 * This interface has its own address and Beacon frame.
1428 * WPA_IF_P2P_GO - P2P Group Owner
1433 * WPA_IF_P2P_CLIENT - P2P Client
1438 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1439 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1444 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1445 * abstracted P2P Device function in the driver
1450 * WPA_IF_MESH - Mesh interface
1455 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1460 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1465 struct wpa_init_params {
1469 const char *driver_params;
1470 int use_pae_group_addr;
1474 u8 *own_addr; /* buffer for writing own MAC address */
1478 struct wpa_bss_params {
1479 /** Interface name (for multi-SSID/VLAN support) */
1481 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1490 enum mfp_options ieee80211w;
1493 #define WPA_STA_AUTHORIZED BIT(0)
1494 #define WPA_STA_WMM BIT(1)
1495 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1496 #define WPA_STA_MFP BIT(3)
1497 #define WPA_STA_TDLS_PEER BIT(4)
1498 #define WPA_STA_AUTHENTICATED BIT(5)
1511 WNM_SLEEP_ENTER_CONFIRM,
1512 WNM_SLEEP_ENTER_FAIL,
1513 WNM_SLEEP_EXIT_CONFIRM,
1514 WNM_SLEEP_EXIT_FAIL,
1515 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1516 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1517 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1519 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1521 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1522 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1524 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1527 /* enum chan_width - Channel width definitions */
1539 * struct wpa_signal_info - Information about channel signal quality
1541 struct wpa_signal_info {
1543 int above_threshold;
1546 int avg_beacon_signal;
1549 enum chan_width chanwidth;
1555 * struct beacon_data - Beacon data
1556 * @head: Head portion of Beacon frame (before TIM IE)
1557 * @tail: Tail portion of Beacon frame (after TIM IE)
1558 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1559 * @proberesp_ies: Extra information element(s) to add into Probe Response
1561 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1562 * Response frames or %NULL
1563 * @probe_resp: Probe Response frame template
1564 * @head_len: Length of @head
1565 * @tail_len: Length of @tail
1566 * @beacon_ies_len: Length of beacon_ies in octets
1567 * @proberesp_ies_len: Length of proberesp_ies in octets
1568 * @proberesp_ies_len: Length of proberesp_ies in octets
1569 * @probe_resp_len: Length of probe response template (@probe_resp)
1571 struct beacon_data {
1578 size_t head_len, tail_len;
1579 size_t beacon_ies_len;
1580 size_t proberesp_ies_len;
1581 size_t assocresp_ies_len;
1582 size_t probe_resp_len;
1586 * struct csa_settings - Settings for channel switch command
1587 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1588 * @block_tx: 1 - block transmission for CSA period
1589 * @freq_params: Next channel frequency parameter
1590 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1591 * @beacon_after: Next beacon/probe resp/asooc resp info
1592 * @counter_offset_beacon: Offset to the count field in beacon's tail
1593 * @counter_offset_presp: Offset to the count field in probe resp.
1595 struct csa_settings {
1599 struct hostapd_freq_params freq_params;
1600 struct beacon_data beacon_csa;
1601 struct beacon_data beacon_after;
1603 u16 counter_offset_beacon[2];
1604 u16 counter_offset_presp[2];
1607 /* TDLS peer capabilities for send_tdls_mgmt() */
1608 enum tdls_peer_capability {
1609 TDLS_PEER_HT = BIT(0),
1610 TDLS_PEER_VHT = BIT(1),
1611 TDLS_PEER_WMM = BIT(2),
1614 /* valid info in the wmm_params struct */
1615 enum wmm_params_valid_info {
1616 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1620 * struct wmm_params - WMM parameterss configured for this association
1621 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1622 * of the struct contain valid information.
1623 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1624 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1631 #ifdef CONFIG_MACSEC
1632 struct macsec_init_params {
1633 Boolean always_include_sci;
1637 #endif /* CONFIG_MACSEC */
1639 enum drv_br_port_attr {
1640 DRV_BR_PORT_ATTR_PROXYARP,
1641 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1644 enum drv_br_net_param {
1645 DRV_BR_NET_PARAM_GARP_ACCEPT,
1646 DRV_BR_MULTICAST_SNOOPING,
1649 struct drv_acs_params {
1650 /* Selected mode (HOSTAPD_MODE_*) */
1651 enum hostapd_hw_mode hw_mode;
1653 /* Indicates whether HT is enabled */
1656 /* Indicates whether HT40 is enabled */
1659 /* Indicates whether VHT is enabled */
1662 /* Configured ACS channel width */
1665 /* ACS channel list info */
1666 unsigned int ch_list_len;
1668 const int *freq_list;
1673 * struct wpa_driver_ops - Driver interface API definition
1675 * This structure defines the API that each driver interface needs to implement
1676 * for core wpa_supplicant code. All driver specific functionality is captured
1679 struct wpa_driver_ops {
1680 /** Name of the driver interface */
1682 /** One line description of the driver interface */
1686 * get_bssid - Get the current BSSID
1687 * @priv: private driver interface data
1688 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1690 * Returns: 0 on success, -1 on failure
1692 * Query kernel driver for the current BSSID and copy it to bssid.
1693 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1696 int (*get_bssid)(void *priv, u8 *bssid);
1699 * get_ssid - Get the current SSID
1700 * @priv: private driver interface data
1701 * @ssid: buffer for SSID (at least 32 bytes)
1703 * Returns: Length of the SSID on success, -1 on failure
1705 * Query kernel driver for the current SSID and copy it to ssid.
1706 * Returning zero is recommended if the STA is not associated.
1708 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1709 * can, at least in theory, contain control characters (including nul)
1710 * and as such, should be processed as binary data, not a printable
1713 int (*get_ssid)(void *priv, u8 *ssid);
1716 * set_key - Configure encryption key
1717 * @ifname: Interface name (for multi-SSID/VLAN support)
1718 * @priv: private driver interface data
1719 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1720 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1721 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1722 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1723 * %WPA_ALG_BIP_CMAC_256);
1724 * %WPA_ALG_NONE clears the key.
1725 * @addr: Address of the peer STA (BSSID of the current AP when setting
1726 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1727 * broadcast keys, %NULL for default keys that are used both for
1728 * broadcast and unicast; when clearing keys, %NULL is used to
1729 * indicate that both the broadcast-only and default key of the
1730 * specified key index is to be cleared
1731 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1733 * @set_tx: configure this key as the default Tx key (only used when
1734 * driver does not support separate unicast/individual key
1735 * @seq: sequence number/packet number, seq_len octets, the next
1736 * packet number to be used for in replay protection; configured
1737 * for Rx keys (in most cases, this is only used with broadcast
1738 * keys and set to zero for unicast keys); %NULL if not set
1739 * @seq_len: length of the seq, depends on the algorithm:
1740 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1741 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1743 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1744 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1746 * Returns: 0 on success, -1 on failure
1748 * Configure the given key for the kernel driver. If the driver
1749 * supports separate individual keys (4 default keys + 1 individual),
1750 * addr can be used to determine whether the key is default or
1751 * individual. If only 4 keys are supported, the default key with key
1752 * index 0 is used as the individual key. STA must be configured to use
1753 * it as the default Tx key (set_tx is set) and accept Rx for all the
1754 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1755 * broadcast keys, so key index 0 is available for this kind of
1758 * Please note that TKIP keys include separate TX and RX MIC keys and
1759 * some drivers may expect them in different order than wpa_supplicant
1760 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1761 * will trigger Michael MIC errors. This can be fixed by changing the
1762 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1763 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1764 * example on how this can be done.
1766 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1767 const u8 *addr, int key_idx, int set_tx,
1768 const u8 *seq, size_t seq_len,
1769 const u8 *key, size_t key_len);
1772 * init - Initialize driver interface
1773 * @ctx: context to be used when calling wpa_supplicant functions,
1774 * e.g., wpa_supplicant_event()
1775 * @ifname: interface name, e.g., wlan0
1777 * Returns: Pointer to private data, %NULL on failure
1779 * Initialize driver interface, including event processing for kernel
1780 * driver events (e.g., associated, scan results, Michael MIC failure).
1781 * This function can allocate a private configuration data area for
1782 * @ctx, file descriptor, interface name, etc. information that may be
1783 * needed in future driver operations. If this is not used, non-NULL
1784 * value will need to be returned because %NULL is used to indicate
1785 * failure. The returned value will be used as 'void *priv' data for
1786 * all other driver_ops functions.
1788 * The main event loop (eloop.c) of wpa_supplicant can be used to
1789 * register callback for read sockets (eloop_register_read_sock()).
1791 * See below for more information about events and
1792 * wpa_supplicant_event() function.
1794 void * (*init)(void *ctx, const char *ifname);
1797 * deinit - Deinitialize driver interface
1798 * @priv: private driver interface data from init()
1800 * Shut down driver interface and processing of driver events. Free
1801 * private data buffer if one was allocated in init() handler.
1803 void (*deinit)(void *priv);
1806 * set_param - Set driver configuration parameters
1807 * @priv: private driver interface data from init()
1808 * @param: driver specific configuration parameters
1810 * Returns: 0 on success, -1 on failure
1812 * Optional handler for notifying driver interface about configuration
1813 * parameters (driver_param).
1815 int (*set_param)(void *priv, const char *param);
1818 * set_countermeasures - Enable/disable TKIP countermeasures
1819 * @priv: private driver interface data
1820 * @enabled: 1 = countermeasures enabled, 0 = disabled
1822 * Returns: 0 on success, -1 on failure
1824 * Configure TKIP countermeasures. When these are enabled, the driver
1825 * should drop all received and queued frames that are using TKIP.
1827 int (*set_countermeasures)(void *priv, int enabled);
1830 * deauthenticate - Request driver to deauthenticate
1831 * @priv: private driver interface data
1832 * @addr: peer address (BSSID of the AP)
1833 * @reason_code: 16-bit reason code to be sent in the deauthentication
1836 * Returns: 0 on success, -1 on failure
1838 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1841 * associate - Request driver to associate
1842 * @priv: private driver interface data
1843 * @params: association parameters
1845 * Returns: 0 on success, -1 on failure
1847 int (*associate)(void *priv,
1848 struct wpa_driver_associate_params *params);
1851 * add_pmkid - Add PMKSA cache entry to the driver
1852 * @priv: private driver interface data
1853 * @bssid: BSSID for the PMKSA cache entry
1854 * @pmkid: PMKID for the PMKSA cache entry
1856 * Returns: 0 on success, -1 on failure
1858 * This function is called when a new PMK is received, as a result of
1859 * either normal authentication or RSN pre-authentication.
1861 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1862 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1863 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1864 * driver_ops function does not need to be implemented. Likewise, if
1865 * the driver does not support WPA, this function is not needed.
1867 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1870 * remove_pmkid - Remove PMKSA cache entry to the driver
1871 * @priv: private driver interface data
1872 * @bssid: BSSID for the PMKSA cache entry
1873 * @pmkid: PMKID for the PMKSA cache entry
1875 * Returns: 0 on success, -1 on failure
1877 * This function is called when the supplicant drops a PMKSA cache
1878 * entry for any reason.
1880 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1881 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1882 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1883 * from wpa_supplicant, this driver_ops function does not need to be
1884 * implemented. Likewise, if the driver does not support WPA, this
1885 * function is not needed.
1887 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1890 * flush_pmkid - Flush PMKSA cache
1891 * @priv: private driver interface data
1893 * Returns: 0 on success, -1 on failure
1895 * This function is called when the supplicant drops all PMKSA cache
1896 * entries for any reason.
1898 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1899 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1900 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1901 * from wpa_supplicant, this driver_ops function does not need to be
1902 * implemented. Likewise, if the driver does not support WPA, this
1903 * function is not needed.
1905 int (*flush_pmkid)(void *priv);
1908 * get_capa - Get driver capabilities
1909 * @priv: private driver interface data
1911 * Returns: 0 on success, -1 on failure
1913 * Get driver/firmware/hardware capabilities.
1915 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1918 * poll - Poll driver for association information
1919 * @priv: private driver interface data
1921 * This is an option callback that can be used when the driver does not
1922 * provide event mechanism for association events. This is called when
1923 * receiving WPA EAPOL-Key messages that require association
1924 * information. The driver interface is supposed to generate associnfo
1925 * event before returning from this callback function. In addition, the
1926 * driver interface should generate an association event after having
1927 * sent out associnfo.
1929 void (*poll)(void *priv);
1932 * get_ifname - Get interface name
1933 * @priv: private driver interface data
1935 * Returns: Pointer to the interface name. This can differ from the
1936 * interface name used in init() call. Init() is called first.
1938 * This optional function can be used to allow the driver interface to
1939 * replace the interface name with something else, e.g., based on an
1940 * interface mapping from a more descriptive name.
1942 const char * (*get_ifname)(void *priv);
1945 * get_mac_addr - Get own MAC address
1946 * @priv: private driver interface data
1948 * Returns: Pointer to own MAC address or %NULL on failure
1950 * This optional function can be used to get the own MAC address of the
1951 * device from the driver interface code. This is only needed if the
1952 * l2_packet implementation for the OS does not provide easy access to
1954 const u8 * (*get_mac_addr)(void *priv);
1957 * set_operstate - Sets device operating state to DORMANT or UP
1958 * @priv: private driver interface data
1959 * @state: 0 = dormant, 1 = up
1960 * Returns: 0 on success, -1 on failure
1962 * This is an optional function that can be used on operating systems
1963 * that support a concept of controlling network device state from user
1964 * space applications. This function, if set, gets called with
1965 * state = 1 when authentication has been completed and with state = 0
1966 * when connection is lost.
1968 int (*set_operstate)(void *priv, int state);
1971 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1972 * @priv: Private driver interface data
1973 * @addr: Address of the station for which to set protection (may be
1974 * %NULL for group keys)
1975 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1976 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1977 * Returns: 0 on success, -1 on failure
1979 * This is an optional function that can be used to set the driver to
1980 * require protection for Tx and/or Rx frames. This uses the layer
1981 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1982 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1983 * set protection operation; instead, they set protection implicitly
1984 * based on configured keys.
1986 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1990 * get_hw_feature_data - Get hardware support data (channels and rates)
1991 * @priv: Private driver interface data
1992 * @num_modes: Variable for returning the number of returned modes
1993 * flags: Variable for returning hardware feature flags
1994 * Returns: Pointer to allocated hardware data on success or %NULL on
1995 * failure. Caller is responsible for freeing this.
1997 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2002 * send_mlme - Send management frame from MLME
2003 * @priv: Private driver interface data
2004 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2005 * @data_len: Size of the management frame
2006 * @noack: Do not wait for this frame to be acked (disable retries)
2007 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2009 * @csa_offs: Array of CSA offsets or %NULL
2010 * @csa_offs_len: Number of elements in csa_offs
2011 * Returns: 0 on success, -1 on failure
2013 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
2014 int noack, unsigned int freq, const u16 *csa_offs,
2015 size_t csa_offs_len);
2018 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2019 * @priv: Private driver interface data
2020 * @md: Mobility domain (2 octets) (also included inside ies)
2021 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2022 * @ies_len: Length of FT IEs in bytes
2023 * Returns: 0 on success, -1 on failure
2025 * The supplicant uses this callback to let the driver know that keying
2026 * material for FT is available and that the driver can use the
2027 * provided IEs in the next message in FT authentication sequence.
2029 * This function is only needed for driver that support IEEE 802.11r
2030 * (Fast BSS Transition).
2032 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2036 * get_scan_results2 - Fetch the latest scan results
2037 * @priv: private driver interface data
2039 * Returns: Allocated buffer of scan results (caller is responsible for
2040 * freeing the data structure) on success, NULL on failure
2042 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2045 * set_country - Set country
2046 * @priv: Private driver interface data
2047 * @alpha2: country to which to switch to
2048 * Returns: 0 on success, -1 on failure
2050 * This function is for drivers which support some form
2051 * of setting a regulatory domain.
2053 int (*set_country)(void *priv, const char *alpha2);
2056 * get_country - Get country
2057 * @priv: Private driver interface data
2058 * @alpha2: Buffer for returning country code (at least 3 octets)
2059 * Returns: 0 on success, -1 on failure
2061 int (*get_country)(void *priv, char *alpha2);
2064 * global_init - Global driver initialization
2065 * Returns: Pointer to private data (global), %NULL on failure
2067 * This optional function is called to initialize the driver wrapper
2068 * for global data, i.e., data that applies to all interfaces. If this
2069 * function is implemented, global_deinit() will also need to be
2070 * implemented to free the private data. The driver will also likely
2071 * use init2() function instead of init() to get the pointer to global
2072 * data available to per-interface initializer.
2074 void * (*global_init)(void);
2077 * global_deinit - Global driver deinitialization
2078 * @priv: private driver global data from global_init()
2080 * Terminate any global driver related functionality and free the
2081 * global data structure.
2083 void (*global_deinit)(void *priv);
2086 * init2 - Initialize driver interface (with global data)
2087 * @ctx: context to be used when calling wpa_supplicant functions,
2088 * e.g., wpa_supplicant_event()
2089 * @ifname: interface name, e.g., wlan0
2090 * @global_priv: private driver global data from global_init()
2091 * Returns: Pointer to private data, %NULL on failure
2093 * This function can be used instead of init() if the driver wrapper
2096 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2099 * get_interfaces - Get information about available interfaces
2100 * @global_priv: private driver global data from global_init()
2101 * Returns: Allocated buffer of interface information (caller is
2102 * responsible for freeing the data structure) on success, NULL on
2105 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2108 * scan2 - Request the driver to initiate scan
2109 * @priv: private driver interface data
2110 * @params: Scan parameters
2112 * Returns: 0 on success, -1 on failure
2114 * Once the scan results are ready, the driver should report scan
2115 * results event for wpa_supplicant which will eventually request the
2116 * results with wpa_driver_get_scan_results2().
2118 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2121 * authenticate - Request driver to authenticate
2122 * @priv: private driver interface data
2123 * @params: authentication parameters
2124 * Returns: 0 on success, -1 on failure
2126 * This is an optional function that can be used with drivers that
2127 * support separate authentication and association steps, i.e., when
2128 * wpa_supplicant can act as the SME. If not implemented, associate()
2129 * function is expected to take care of IEEE 802.11 authentication,
2132 int (*authenticate)(void *priv,
2133 struct wpa_driver_auth_params *params);
2136 * set_ap - Set Beacon and Probe Response information for AP mode
2137 * @priv: Private driver interface data
2138 * @params: Parameters to use in AP mode
2140 * This function is used to configure Beacon template and/or extra IEs
2141 * to add for Beacon and Probe Response frames for the driver in
2142 * AP mode. The driver is responsible for building the full Beacon
2143 * frame by concatenating the head part with TIM IE generated by the
2144 * driver/firmware and finishing with the tail part. Depending on the
2145 * driver architectue, this can be done either by using the full
2146 * template or the set of additional IEs (e.g., WPS and P2P IE).
2147 * Similarly, Probe Response processing depends on the driver design.
2148 * If the driver (or firmware) takes care of replying to Probe Request
2149 * frames, the extra IEs provided here needs to be added to the Probe
2152 * Returns: 0 on success, -1 on failure
2154 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
2157 * set_acl - Set ACL in AP mode
2158 * @priv: Private driver interface data
2159 * @params: Parameters to configure ACL
2160 * Returns: 0 on success, -1 on failure
2162 * This is used only for the drivers which support MAC address ACL.
2164 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2167 * hapd_init - Initialize driver interface (hostapd only)
2168 * @hapd: Pointer to hostapd context
2169 * @params: Configuration for the driver wrapper
2170 * Returns: Pointer to private data, %NULL on failure
2172 * This function is used instead of init() or init2() when the driver
2173 * wrapper is used with hostapd.
2175 void * (*hapd_init)(struct hostapd_data *hapd,
2176 struct wpa_init_params *params);
2179 * hapd_deinit - Deinitialize driver interface (hostapd only)
2180 * @priv: Private driver interface data from hapd_init()
2182 void (*hapd_deinit)(void *priv);
2185 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2186 * @priv: Private driver interface data
2187 * @params: BSS parameters
2188 * Returns: 0 on success, -1 on failure
2190 * This is an optional function to configure the kernel driver to
2191 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2192 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2193 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2194 * for Beacon frames.
2196 * DEPRECATED - use set_ap() instead
2198 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2201 * set_privacy - Enable/disable privacy (AP only)
2202 * @priv: Private driver interface data
2203 * @enabled: 1 = privacy enabled, 0 = disabled
2204 * Returns: 0 on success, -1 on failure
2206 * This is an optional function to configure privacy field in the
2207 * kernel driver for Beacon frames. This can be left undefined (set to
2208 * %NULL) if the driver uses the Beacon template from set_ap().
2210 * DEPRECATED - use set_ap() instead
2212 int (*set_privacy)(void *priv, int enabled);
2215 * get_seqnum - Fetch the current TSC/packet number (AP only)
2216 * @ifname: The interface name (main or virtual)
2217 * @priv: Private driver interface data
2218 * @addr: MAC address of the station or %NULL for group keys
2220 * @seq: Buffer for returning the latest used TSC/packet number
2221 * Returns: 0 on success, -1 on failure
2223 * This function is used to fetch the last used TSC/packet number for
2224 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2225 * keys, so there is no strict requirement on implementing support for
2226 * unicast keys (i.e., addr != %NULL).
2228 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2232 * flush - Flush all association stations (AP only)
2233 * @priv: Private driver interface data
2234 * Returns: 0 on success, -1 on failure
2236 * This function requests the driver to disassociate all associated
2237 * stations. This function does not need to be implemented if the
2238 * driver does not process association frames internally.
2240 int (*flush)(void *priv);
2243 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2244 * @priv: Private driver interface data
2245 * @elem: Information elements
2246 * @elem_len: Length of the elem buffer in octets
2247 * Returns: 0 on success, -1 on failure
2249 * This is an optional function to add information elements in the
2250 * kernel driver for Beacon and Probe Response frames. This can be left
2251 * undefined (set to %NULL) if the driver uses the Beacon template from
2254 * DEPRECATED - use set_ap() instead
2256 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2259 * read_sta_data - Fetch station data
2260 * @priv: Private driver interface data
2261 * @data: Buffer for returning station information
2262 * @addr: MAC address of the station
2263 * Returns: 0 on success, -1 on failure
2265 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2269 * hapd_send_eapol - Send an EAPOL packet (AP only)
2270 * @priv: private driver interface data
2271 * @addr: Destination MAC address
2272 * @data: EAPOL packet starting with IEEE 802.1X header
2273 * @data_len: Length of the EAPOL packet in octets
2274 * @encrypt: Whether the frame should be encrypted
2275 * @own_addr: Source MAC address
2276 * @flags: WPA_STA_* flags for the destination station
2278 * Returns: 0 on success, -1 on failure
2280 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2281 size_t data_len, int encrypt,
2282 const u8 *own_addr, u32 flags);
2285 * sta_deauth - Deauthenticate a station (AP only)
2286 * @priv: Private driver interface data
2287 * @own_addr: Source address and BSSID for the Deauthentication frame
2288 * @addr: MAC address of the station to deauthenticate
2289 * @reason: Reason code for the Deauthentiation frame
2290 * Returns: 0 on success, -1 on failure
2292 * This function requests a specific station to be deauthenticated and
2293 * a Deauthentication frame to be sent to it.
2295 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2299 * sta_disassoc - Disassociate a station (AP only)
2300 * @priv: Private driver interface data
2301 * @own_addr: Source address and BSSID for the Disassociation frame
2302 * @addr: MAC address of the station to disassociate
2303 * @reason: Reason code for the Disassociation frame
2304 * Returns: 0 on success, -1 on failure
2306 * This function requests a specific station to be disassociated and
2307 * a Disassociation frame to be sent to it.
2309 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2313 * sta_remove - Remove a station entry (AP only)
2314 * @priv: Private driver interface data
2315 * @addr: MAC address of the station to be removed
2316 * Returns: 0 on success, -1 on failure
2318 int (*sta_remove)(void *priv, const u8 *addr);
2321 * hapd_get_ssid - Get the current SSID (AP only)
2322 * @priv: Private driver interface data
2323 * @buf: Buffer for returning the SSID
2324 * @len: Maximum length of the buffer
2325 * Returns: Length of the SSID on success, -1 on failure
2327 * This function need not be implemented if the driver uses Beacon
2328 * template from set_ap() and does not reply to Probe Request frames.
2330 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2333 * hapd_set_ssid - Set SSID (AP only)
2334 * @priv: Private driver interface data
2336 * @len: Length of the SSID in octets
2337 * Returns: 0 on success, -1 on failure
2339 * DEPRECATED - use set_ap() instead
2341 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2344 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2345 * @priv: Private driver interface data
2346 * @enabled: 1 = countermeasures enabled, 0 = disabled
2347 * Returns: 0 on success, -1 on failure
2349 * This need not be implemented if the driver does not take care of
2350 * association processing.
2352 int (*hapd_set_countermeasures)(void *priv, int enabled);
2355 * sta_add - Add a station entry
2356 * @priv: Private driver interface data
2357 * @params: Station parameters
2358 * Returns: 0 on success, -1 on failure
2360 * This function is used to add a station entry to the driver once the
2361 * station has completed association. This is only used if the driver
2362 * does not take care of association processing.
2364 * With TDLS, this function is also used to add or set (params->set 1)
2365 * TDLS peer entries.
2367 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2370 * get_inact_sec - Get station inactivity duration (AP only)
2371 * @priv: Private driver interface data
2372 * @addr: Station address
2373 * Returns: Number of seconds station has been inactive, -1 on failure
2375 int (*get_inact_sec)(void *priv, const u8 *addr);
2378 * sta_clear_stats - Clear station statistics (AP only)
2379 * @priv: Private driver interface data
2380 * @addr: Station address
2381 * Returns: 0 on success, -1 on failure
2383 int (*sta_clear_stats)(void *priv, const u8 *addr);
2386 * set_freq - Set channel/frequency (AP only)
2387 * @priv: Private driver interface data
2388 * @freq: Channel parameters
2389 * Returns: 0 on success, -1 on failure
2391 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2394 * set_rts - Set RTS threshold
2395 * @priv: Private driver interface data
2396 * @rts: RTS threshold in octets
2397 * Returns: 0 on success, -1 on failure
2399 int (*set_rts)(void *priv, int rts);
2402 * set_frag - Set fragmentation threshold
2403 * @priv: Private driver interface data
2404 * @frag: Fragmentation threshold in octets
2405 * Returns: 0 on success, -1 on failure
2407 int (*set_frag)(void *priv, int frag);
2410 * sta_set_flags - Set station flags (AP only)
2411 * @priv: Private driver interface data
2412 * @addr: Station address
2413 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2414 * @flags_or: Bitmap of WPA_STA_* flags to add
2415 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2416 * Returns: 0 on success, -1 on failure
2418 int (*sta_set_flags)(void *priv, const u8 *addr,
2419 unsigned int total_flags, unsigned int flags_or,
2420 unsigned int flags_and);
2423 * set_tx_queue_params - Set TX queue parameters
2424 * @priv: Private driver interface data
2425 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2429 * @burst_time: Maximum length for bursting in 0.1 msec units
2431 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2432 int cw_max, int burst_time);
2435 * if_add - Add a virtual interface
2436 * @priv: Private driver interface data
2437 * @type: Interface type
2438 * @ifname: Interface name for the new virtual interface
2439 * @addr: Local address to use for the interface or %NULL to use the
2440 * parent interface address
2441 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2442 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2443 * not allowed (applies only to %WPA_IF_AP_BSS type)
2444 * @force_ifname: Buffer for returning an interface name that the
2445 * driver ended up using if it differs from the requested ifname
2446 * @if_addr: Buffer for returning the allocated interface address
2447 * (this may differ from the requested addr if the driver cannot
2448 * change interface address)
2449 * @bridge: Bridge interface to use or %NULL if no bridge configured
2450 * @use_existing: Whether to allow existing interface to be used
2451 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
2452 * Returns: 0 on success, -1 on failure
2454 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2455 const char *ifname, const u8 *addr, void *bss_ctx,
2456 void **drv_priv, char *force_ifname, u8 *if_addr,
2457 const char *bridge, int use_existing, int setup_ap);
2460 * if_remove - Remove a virtual interface
2461 * @priv: Private driver interface data
2462 * @type: Interface type
2463 * @ifname: Interface name of the virtual interface to be removed
2464 * Returns: 0 on success, -1 on failure
2466 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2467 const char *ifname);
2470 * set_sta_vlan - Bind a station into a specific interface (AP only)
2471 * @priv: Private driver interface data
2472 * @ifname: Interface (main or virtual BSS or VLAN)
2473 * @addr: MAC address of the associated station
2475 * Returns: 0 on success, -1 on failure
2477 * This function is used to bind a station to a specific virtual
2478 * interface. It is only used if when virtual interfaces are supported,
2479 * e.g., to assign stations to different VLAN interfaces based on
2480 * information from a RADIUS server. This allows separate broadcast
2481 * domains to be used with a single BSS.
2483 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2487 * commit - Optional commit changes handler (AP only)
2488 * @priv: driver private data
2489 * Returns: 0 on success, -1 on failure
2491 * This optional handler function can be registered if the driver
2492 * interface implementation needs to commit changes (e.g., by setting
2493 * network interface up) at the end of initial configuration. If set,
2494 * this handler will be called after initial setup has been completed.
2496 int (*commit)(void *priv);
2499 * send_ether - Send an ethernet packet (AP only)
2500 * @priv: private driver interface data
2501 * @dst: Destination MAC address
2502 * @src: Source MAC address
2504 * @data: EAPOL packet starting with IEEE 802.1X header
2505 * @data_len: Length of the EAPOL packet in octets
2506 * Returns: 0 on success, -1 on failure
2508 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2509 const u8 *data, size_t data_len);
2512 * set_radius_acl_auth - Notification of RADIUS ACL change
2513 * @priv: Private driver interface data
2514 * @mac: MAC address of the station
2515 * @accepted: Whether the station was accepted
2516 * @session_timeout: Session timeout for the station
2517 * Returns: 0 on success, -1 on failure
2519 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2520 u32 session_timeout);
2523 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2524 * @priv: Private driver interface data
2525 * @mac: MAC address of the station
2526 * Returns: 0 on success, -1 on failure
2528 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2531 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2532 * @priv: Private driver interface data
2533 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2534 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2536 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2537 * to remove extra IE(s)
2538 * Returns: 0 on success, -1 on failure
2540 * This is an optional function to add WPS IE in the kernel driver for
2541 * Beacon and Probe Response frames. This can be left undefined (set
2542 * to %NULL) if the driver uses the Beacon template from set_ap()
2543 * and does not process Probe Request frames. If the driver takes care
2544 * of (Re)Association frame processing, the assocresp buffer includes
2545 * WPS IE(s) that need to be added to (Re)Association Response frames
2546 * whenever a (Re)Association Request frame indicated use of WPS.
2548 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2549 * frames when operating as a GO. The driver is responsible for adding
2550 * timing related attributes (e.g., NoA) in addition to the IEs
2551 * included here by appending them after these buffers. This call is
2552 * also used to provide Probe Response IEs for P2P Listen state
2553 * operations for drivers that generate the Probe Response frames
2556 * DEPRECATED - use set_ap() instead
2558 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2559 const struct wpabuf *proberesp,
2560 const struct wpabuf *assocresp);
2563 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2564 * @priv: Private driver interface data
2565 * @authorized: Whether the port is authorized
2566 * Returns: 0 on success, -1 on failure
2568 int (*set_supp_port)(void *priv, int authorized);
2571 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2572 * @priv: Private driver interface data
2573 * @addr: MAC address of the associated station
2574 * @aid: Association ID
2575 * @val: 1 = bind to 4-address WDS; 0 = unbind
2576 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2577 * to indicate that bridge is not to be used
2578 * @ifname_wds: Buffer to return the interface name for the new WDS
2579 * station or %NULL to indicate name is not returned.
2580 * Returns: 0 on success, -1 on failure
2582 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2583 const char *bridge_ifname, char *ifname_wds);
2586 * send_action - Transmit an Action frame
2587 * @priv: Private driver interface data
2588 * @freq: Frequency (in MHz) of the channel
2589 * @wait: Time to wait off-channel for a response (in ms), or zero
2590 * @dst: Destination MAC address (Address 1)
2591 * @src: Source MAC address (Address 2)
2592 * @bssid: BSSID (Address 3)
2594 * @data_len: data length in octets
2595 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2596 * Returns: 0 on success, -1 on failure
2598 * This command can be used to request the driver to transmit an action
2599 * frame to the specified destination.
2601 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2602 * be transmitted on the given channel and the device will wait for a
2603 * response on that channel for the given wait time.
2605 * If the flag is not set, the wait time will be ignored. In this case,
2606 * if a remain-on-channel duration is in progress, the frame must be
2607 * transmitted on that channel; alternatively the frame may be sent on
2608 * the current operational channel (if in associated state in station
2609 * mode or while operating as an AP.)
2611 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2612 const u8 *dst, const u8 *src, const u8 *bssid,
2613 const u8 *data, size_t data_len, int no_cck);
2616 * send_action_cancel_wait - Cancel action frame TX wait
2617 * @priv: Private driver interface data
2619 * This command cancels the wait time associated with sending an action
2620 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2621 * set in the driver flags.
2623 void (*send_action_cancel_wait)(void *priv);
2626 * remain_on_channel - Remain awake on a channel
2627 * @priv: Private driver interface data
2628 * @freq: Frequency (in MHz) of the channel
2629 * @duration: Duration in milliseconds
2630 * Returns: 0 on success, -1 on failure
2632 * This command is used to request the driver to remain awake on the
2633 * specified channel for the specified duration and report received
2634 * Action frames with EVENT_RX_MGMT events. Optionally, received
2635 * Probe Request frames may also be requested to be reported by calling
2636 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2638 * The driver may not be at the requested channel when this function
2639 * returns, i.e., the return code is only indicating whether the
2640 * request was accepted. The caller will need to wait until the
2641 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2642 * completed the channel change. This may take some time due to other
2643 * need for the radio and the caller should be prepared to timing out
2644 * its wait since there are no guarantees on when this request can be
2647 int (*remain_on_channel)(void *priv, unsigned int freq,
2648 unsigned int duration);
2651 * cancel_remain_on_channel - Cancel remain-on-channel operation
2652 * @priv: Private driver interface data
2654 * This command can be used to cancel a remain-on-channel operation
2655 * before its originally requested duration has passed. This could be
2656 * used, e.g., when remain_on_channel() is used to request extra time
2657 * to receive a response to an Action frame and the response is
2658 * received when there is still unneeded time remaining on the
2659 * remain-on-channel operation.
2661 int (*cancel_remain_on_channel)(void *priv);
2664 * probe_req_report - Request Probe Request frames to be indicated
2665 * @priv: Private driver interface data
2666 * @report: Whether to report received Probe Request frames
2667 * Returns: 0 on success, -1 on failure (or if not supported)
2669 * This command can be used to request the driver to indicate when
2670 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2671 * Since this operation may require extra resources, e.g., due to less
2672 * optimal hardware/firmware RX filtering, many drivers may disable
2673 * Probe Request reporting at least in station mode. This command is
2674 * used to notify the driver when the Probe Request frames need to be
2675 * reported, e.g., during remain-on-channel operations.
2677 int (*probe_req_report)(void *priv, int report);
2680 * deinit_ap - Deinitialize AP mode
2681 * @priv: Private driver interface data
2682 * Returns: 0 on success, -1 on failure (or if not supported)
2684 * This optional function can be used to disable AP mode related
2685 * configuration. If the interface was not dynamically added,
2686 * change the driver mode to station mode to allow normal station
2687 * operations like scanning to be completed.
2689 int (*deinit_ap)(void *priv);
2692 * deinit_p2p_cli - Deinitialize P2P client mode
2693 * @priv: Private driver interface data
2694 * Returns: 0 on success, -1 on failure (or if not supported)
2696 * This optional function can be used to disable P2P client mode. If the
2697 * interface was not dynamically added, change the interface type back
2700 int (*deinit_p2p_cli)(void *priv);
2703 * suspend - Notification on system suspend/hibernate event
2704 * @priv: Private driver interface data
2706 void (*suspend)(void *priv);
2709 * resume - Notification on system resume/thaw event
2710 * @priv: Private driver interface data
2712 void (*resume)(void *priv);
2715 * signal_monitor - Set signal monitoring parameters
2716 * @priv: Private driver interface data
2717 * @threshold: Threshold value for signal change events; 0 = disabled
2718 * @hysteresis: Minimum change in signal strength before indicating a
2720 * Returns: 0 on success, -1 on failure (or if not supported)
2722 * This function can be used to configure monitoring of signal strength
2723 * with the current AP. Whenever signal strength drops below the
2724 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2725 * should be generated assuming the signal strength has changed at
2726 * least %hysteresis from the previously indicated signal change event.
2728 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2731 * send_frame - Send IEEE 802.11 frame (testing use only)
2732 * @priv: Private driver interface data
2733 * @data: IEEE 802.11 frame with IEEE 802.11 header
2734 * @data_len: Size of the frame
2735 * @encrypt: Whether to encrypt the frame (if keys are set)
2736 * Returns: 0 on success, -1 on failure
2738 * This function is only used for debugging purposes and is not
2739 * required to be implemented for normal operations.
2741 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2745 * get_noa - Get current Notice of Absence attribute payload
2746 * @priv: Private driver interface data
2747 * @buf: Buffer for returning NoA
2748 * @buf_len: Buffer length in octets
2749 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2750 * advertized, or -1 on failure
2752 * This function is used to fetch the current Notice of Absence
2753 * attribute value from GO.
2755 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2758 * set_noa - Set Notice of Absence parameters for GO (testing)
2759 * @priv: Private driver interface data
2761 * @start: Start time in ms from next TBTT
2762 * @duration: Duration in ms
2763 * Returns: 0 on success or -1 on failure
2765 * This function is used to set Notice of Absence parameters for GO. It
2766 * is used only for testing. To disable NoA, all parameters are set to
2769 int (*set_noa)(void *priv, u8 count, int start, int duration);
2772 * set_p2p_powersave - Set P2P power save options
2773 * @priv: Private driver interface data
2774 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2775 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2776 * @ctwindow: 0.. = change (msec), -1 = no change
2777 * Returns: 0 on success or -1 on failure
2779 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2783 * ampdu - Enable/disable aggregation
2784 * @priv: Private driver interface data
2785 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2786 * Returns: 0 on success or -1 on failure
2788 int (*ampdu)(void *priv, int ampdu);
2791 * get_radio_name - Get physical radio name for the device
2792 * @priv: Private driver interface data
2793 * Returns: Radio name or %NULL if not known
2795 * The returned data must not be modified by the caller. It is assumed
2796 * that any interface that has the same radio name as another is
2797 * sharing the same physical radio. This information can be used to
2798 * share scan results etc. information between the virtual interfaces
2799 * to speed up various operations.
2801 const char * (*get_radio_name)(void *priv);
2804 * send_tdls_mgmt - for sending TDLS management packets
2805 * @priv: private driver interface data
2806 * @dst: Destination (peer) MAC address
2807 * @action_code: TDLS action code for the mssage
2808 * @dialog_token: Dialog Token to use in the message (if needed)
2809 * @status_code: Status Code or Reason Code to use (if needed)
2810 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2811 * @initiator: Is the current end the TDLS link initiator
2812 * @buf: TDLS IEs to add to the message
2813 * @len: Length of buf in octets
2814 * Returns: 0 on success, negative (<0) on failure
2816 * This optional function can be used to send packet to driver which is
2817 * responsible for receiving and sending all TDLS packets.
2819 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2820 u8 dialog_token, u16 status_code, u32 peer_capab,
2821 int initiator, const u8 *buf, size_t len);
2824 * tdls_oper - Ask the driver to perform high-level TDLS operations
2825 * @priv: Private driver interface data
2826 * @oper: TDLS high-level operation. See %enum tdls_oper
2827 * @peer: Destination (peer) MAC address
2828 * Returns: 0 on success, negative (<0) on failure
2830 * This optional function can be used to send high-level TDLS commands
2833 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2836 * wnm_oper - Notify driver of the WNM frame reception
2837 * @priv: Private driver interface data
2838 * @oper: WNM operation. See %enum wnm_oper
2839 * @peer: Destination (peer) MAC address
2840 * @buf: Buffer for the driver to fill in (for getting IE)
2841 * @buf_len: Return the len of buf
2842 * Returns: 0 on success, negative (<0) on failure
2844 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2845 u8 *buf, u16 *buf_len);
2848 * set_qos_map - Set QoS Map
2849 * @priv: Private driver interface data
2850 * @qos_map_set: QoS Map
2851 * @qos_map_set_len: Length of QoS Map
2853 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2854 u8 qos_map_set_len);
2857 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2858 * @priv: Private driver interface data
2859 * @version: IP version of the IP address, 4 or 6
2860 * @ipaddr: IP address for the neigh entry
2861 * @prefixlen: IP address prefix length
2862 * @addr: Corresponding MAC address
2863 * Returns: 0 on success, negative (<0) on failure
2865 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2866 int prefixlen, const u8 *addr);
2869 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2870 * @priv: Private driver interface data
2871 * @version: IP version of the IP address, 4 or 6
2872 * @ipaddr: IP address for the neigh entry
2873 * Returns: 0 on success, negative (<0) on failure
2875 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2878 * br_port_set_attr - Set a bridge port attribute
2879 * @attr: Bridge port attribute to set
2880 * @val: Value to be set
2881 * Returns: 0 on success, negative (<0) on failure
2883 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2887 * br_port_set_attr - Set a bridge network parameter
2888 * @param: Bridge parameter to set
2889 * @val: Value to be set
2890 * Returns: 0 on success, negative (<0) on failure
2892 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2896 * set_wowlan - Set wake-on-wireless triggers
2897 * @priv: Private driver interface data
2898 * @triggers: wowlan triggers
2900 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2903 * signal_poll - Get current connection information
2904 * @priv: Private driver interface data
2905 * @signal_info: Connection info structure
2907 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2910 * set_authmode - Set authentication algorithm(s) for static WEP
2911 * @priv: Private driver interface data
2912 * @authmode: 1=Open System, 2=Shared Key, 3=both
2913 * Returns: 0 on success, -1 on failure
2915 * This function can be used to set authentication algorithms for AP
2916 * mode when static WEP is used. If the driver uses user space MLME/SME
2917 * implementation, there is no need to implement this function.
2919 * DEPRECATED - use set_ap() instead
2921 int (*set_authmode)(void *priv, int authmode);
2925 * driver_cmd - Execute driver-specific command
2926 * @priv: Private driver interface data
2927 * @cmd: Command to execute
2928 * @buf: Return buffer
2929 * @buf_len: Buffer length
2930 * Returns: 0 on success, -1 on failure
2932 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2933 #endif /* ANDROID */
2936 * vendor_cmd - Execute vendor specific command
2937 * @priv: Private driver interface data
2938 * @vendor_id: Vendor id
2939 * @subcmd: Vendor command id
2940 * @data: Vendor command parameters (%NULL if no parameters)
2941 * @data_len: Data length
2942 * @buf: Return buffer (%NULL to ignore reply)
2943 * Returns: 0 on success, negative (<0) on failure
2945 * This function handles vendor specific commands that are passed to
2946 * the driver/device. The command is identified by vendor id and
2947 * command id. Parameters can be passed as argument to the command
2948 * in the data buffer. Reply (if any) will be filled in the supplied
2951 * The exact driver behavior is driver interface and vendor specific. As
2952 * an example, this will be converted to a vendor specific cfg80211
2953 * command in case of the nl80211 driver interface.
2955 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2956 unsigned int subcmd, const u8 *data, size_t data_len,
2957 struct wpabuf *buf);
2960 * set_rekey_info - Set rekey information
2961 * @priv: Private driver interface data
2963 * @kek_len: KEK length in octets
2965 * @kck_len: KCK length in octets
2966 * @replay_ctr: Current EAPOL-Key Replay Counter
2968 * This optional function can be used to provide information for the
2969 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2970 * while the host (including wpa_supplicant) is sleeping.
2972 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
2973 const u8 *kck, size_t kck_len,
2974 const u8 *replay_ctr);
2977 * sta_assoc - Station association indication
2978 * @priv: Private driver interface data
2979 * @own_addr: Source address and BSSID for association frame
2980 * @addr: MAC address of the station to associate
2981 * @reassoc: flag to indicate re-association
2982 * @status: association response status code
2983 * @ie: assoc response ie buffer
2984 * @len: ie buffer length
2985 * Returns: 0 on success, -1 on failure
2987 * This function indicates the driver to send (Re)Association
2988 * Response frame to the station.
2990 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2991 int reassoc, u16 status, const u8 *ie, size_t len);
2994 * sta_auth - Station authentication indication
2995 * @priv: Private driver interface data
2996 * @own_addr: Source address and BSSID for authentication frame
2997 * @addr: MAC address of the station to associate
2998 * @seq: authentication sequence number
2999 * @status: authentication response status code
3000 * @ie: authentication frame ie buffer
3001 * @len: ie buffer length
3003 * This function indicates the driver to send Authentication frame
3006 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
3007 u16 seq, u16 status, const u8 *ie, size_t len);
3010 * add_tspec - Add traffic stream
3011 * @priv: Private driver interface data
3012 * @addr: MAC address of the station to associate
3013 * @tspec_ie: tspec ie buffer
3014 * @tspec_ielen: tspec ie length
3015 * Returns: 0 on success, -1 on failure
3017 * This function adds the traffic steam for the station
3018 * and fills the medium_time in tspec_ie.
3020 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3021 size_t tspec_ielen);
3024 * add_sta_node - Add a station node in the driver
3025 * @priv: Private driver interface data
3026 * @addr: MAC address of the station to add
3027 * @auth_alg: authentication algorithm used by the station
3028 * Returns: 0 on success, -1 on failure
3030 * This function adds the station node in the driver, when
3031 * the station gets added by FT-over-DS.
3033 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
3036 * sched_scan - Request the driver to initiate scheduled scan
3037 * @priv: Private driver interface data
3038 * @params: Scan parameters
3039 * Returns: 0 on success, -1 on failure
3041 * This operation should be used for scheduled scan offload to
3042 * the hardware. Every time scan results are available, the
3043 * driver should report scan results event for wpa_supplicant
3044 * which will eventually request the results with
3045 * wpa_driver_get_scan_results2(). This operation is optional
3046 * and if not provided or if it returns -1, we fall back to
3047 * normal host-scheduled scans.
3049 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
3052 * stop_sched_scan - Request the driver to stop a scheduled scan
3053 * @priv: Private driver interface data
3054 * Returns: 0 on success, -1 on failure
3056 * This should cause the scheduled scan to be stopped and
3057 * results should stop being sent. Must be supported if
3058 * sched_scan is supported.
3060 int (*stop_sched_scan)(void *priv);
3063 * poll_client - Probe (null data or such) the given station
3064 * @priv: Private driver interface data
3065 * @own_addr: MAC address of sending interface
3066 * @addr: MAC address of the station to probe
3067 * @qos: Indicates whether station is QoS station
3069 * This function is used to verify whether an associated station is
3070 * still present. This function does not need to be implemented if the
3071 * driver provides such inactivity polling mechanism.
3073 void (*poll_client)(void *priv, const u8 *own_addr,
3074 const u8 *addr, int qos);
3077 * radio_disable - Disable/enable radio
3078 * @priv: Private driver interface data
3079 * @disabled: 1=disable 0=enable radio
3080 * Returns: 0 on success, -1 on failure
3082 * This optional command is for testing purposes. It can be used to
3083 * disable the radio on a testbed device to simulate out-of-radio-range
3086 int (*radio_disable)(void *priv, int disabled);
3089 * switch_channel - Announce channel switch and migrate the GO to the
3091 * @priv: Private driver interface data
3092 * @settings: Settings for CSA period and new channel
3093 * Returns: 0 on success, -1 on failure
3095 * This function is used to move the GO to the legacy STA channel to
3096 * avoid frequency conflict in single channel concurrency.
3098 int (*switch_channel)(void *priv, struct csa_settings *settings);
3101 * add_tx_ts - Add traffic stream
3102 * @priv: Private driver interface data
3103 * @tsid: Traffic stream ID
3104 * @addr: Receiver address
3105 * @user_prio: User priority of the traffic stream
3106 * @admitted_time: Admitted time for this TS in units of
3107 * 32 microsecond periods (per second).
3108 * Returns: 0 on success, -1 on failure
3110 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3114 * del_tx_ts - Delete traffic stream
3115 * @priv: Private driver interface data
3116 * @tsid: Traffic stream ID
3117 * @addr: Receiver address
3118 * Returns: 0 on success, -1 on failure
3120 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3123 * Enable channel-switching with TDLS peer
3124 * @priv: Private driver interface data
3125 * @addr: MAC address of the TDLS peer
3126 * @oper_class: Operating class of the switch channel
3127 * @params: Channel specification
3128 * Returns: 0 on success, -1 on failure
3130 * The function indicates to driver that it can start switching to a
3131 * different channel with a specified TDLS peer. The switching is
3132 * assumed on until canceled with tdls_disable_channel_switch().
3134 int (*tdls_enable_channel_switch)(
3135 void *priv, const u8 *addr, u8 oper_class,
3136 const struct hostapd_freq_params *params);
3139 * Disable channel switching with TDLS peer
3140 * @priv: Private driver interface data
3141 * @addr: MAC address of the TDLS peer
3142 * Returns: 0 on success, -1 on failure
3144 * This function indicates to the driver that it should stop switching
3145 * with a given TDLS peer.
3147 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3150 * start_dfs_cac - Listen for radar interference on the channel
3151 * @priv: Private driver interface data
3152 * @freq: Channel parameters
3153 * Returns: 0 on success, -1 on failure
3155 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
3158 * stop_ap - Removes beacon from AP
3159 * @priv: Private driver interface data
3160 * Returns: 0 on success, -1 on failure (or if not supported)
3162 * This optional function can be used to disable AP mode related
3163 * configuration. Unlike deinit_ap, it does not change to station
3166 int (*stop_ap)(void *priv);
3169 * get_survey - Retrieve survey data
3170 * @priv: Private driver interface data
3171 * @freq: If set, survey data for the specified frequency is only
3172 * being requested. If not set, all survey data is requested.
3173 * Returns: 0 on success, -1 on failure
3175 * Use this to retrieve:
3177 * - the observed channel noise floor
3178 * - the amount of time we have spent on the channel
3179 * - the amount of time during which we have spent on the channel that
3180 * the radio has determined the medium is busy and we cannot
3182 * - the amount of time we have spent receiving data
3183 * - the amount of time we have spent transmitting data
3185 * This data can be used for spectrum heuristics. One example is
3186 * Automatic Channel Selection (ACS). The channel survey data is
3187 * kept on a linked list on the channel data, one entry is added
3188 * for each survey. The min_nf of the channel is updated for each
3191 int (*get_survey)(void *priv, unsigned int freq);
3194 * status - Get driver interface status information
3195 * @priv: Private driver interface data
3196 * @buf: Buffer for printing tou the status information
3197 * @buflen: Maximum length of the buffer
3198 * Returns: Length of written status information or -1 on failure
3200 int (*status)(void *priv, char *buf, size_t buflen);
3203 * roaming - Set roaming policy for driver-based BSS selection
3204 * @priv: Private driver interface data
3205 * @allowed: Whether roaming within ESS is allowed
3206 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3207 * Returns: Length of written status information or -1 on failure
3209 * This optional callback can be used to update roaming policy from the
3210 * associate() command (bssid being set there indicates that the driver
3211 * should not roam before getting this roaming() call to allow roaming.
3212 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3213 * capability, roaming policy is handled within wpa_supplicant and there
3214 * is no need to implement or react to this callback.
3216 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3219 * set_mac_addr - Set MAC address
3220 * @priv: Private driver interface data
3221 * @addr: MAC address to use or %NULL for setting back to permanent
3222 * Returns: 0 on success, -1 on failure
3224 int (*set_mac_addr)(void *priv, const u8 *addr);
3226 #ifdef CONFIG_MACSEC
3227 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3229 int (*macsec_deinit)(void *priv);
3232 * enable_protect_frames - Set protect frames status
3233 * @priv: Private driver interface data
3234 * @enabled: TRUE = protect frames enabled
3235 * FALSE = protect frames disabled
3236 * Returns: 0 on success, -1 on failure (or if not supported)
3238 int (*enable_protect_frames)(void *priv, Boolean enabled);
3241 * set_replay_protect - Set replay protect status and window size
3242 * @priv: Private driver interface data
3243 * @enabled: TRUE = replay protect enabled
3244 * FALSE = replay protect disabled
3245 * @window: replay window size, valid only when replay protect enabled
3246 * Returns: 0 on success, -1 on failure (or if not supported)
3248 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3251 * set_current_cipher_suite - Set current cipher suite
3252 * @priv: Private driver interface data
3253 * @cs: EUI64 identifier
3254 * @cs_len: Length of the cs buffer in octets
3255 * Returns: 0 on success, -1 on failure (or if not supported)
3257 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3261 * enable_controlled_port - Set controlled port status
3262 * @priv: Private driver interface data
3263 * @enabled: TRUE = controlled port enabled
3264 * FALSE = controlled port disabled
3265 * Returns: 0 on success, -1 on failure (or if not supported)
3267 int (*enable_controlled_port)(void *priv, Boolean enabled);
3270 * get_receive_lowest_pn - Get receive lowest pn
3271 * @priv: Private driver interface data
3272 * @channel: secure channel
3273 * @an: association number
3274 * @lowest_pn: lowest accept pn
3275 * Returns: 0 on success, -1 on failure (or if not supported)
3277 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3281 * get_transmit_next_pn - Get transmit next pn
3282 * @priv: Private driver interface data
3283 * @channel: secure channel
3284 * @an: association number
3286 * Returns: 0 on success, -1 on failure (or if not supported)
3288 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3292 * set_transmit_next_pn - Set transmit next pn
3293 * @priv: Private driver interface data
3294 * @channel: secure channel
3295 * @an: association number
3297 * Returns: 0 on success, -1 on failure (or if not supported)
3299 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3303 * get_available_receive_sc - get available receive channel
3304 * @priv: Private driver interface data
3305 * @channel: secure channel
3306 * Returns: 0 on success, -1 on failure (or if not supported)
3308 int (*get_available_receive_sc)(void *priv, u32 *channel);
3311 * create_receive_sc - create secure channel for receiving
3312 * @priv: Private driver interface data
3313 * @channel: secure channel
3314 * @sci_addr: secure channel identifier - address
3315 * @sci_port: secure channel identifier - port
3316 * @conf_offset: confidentiality offset (0, 30, or 50)
3317 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3319 * Returns: 0 on success, -1 on failure (or if not supported)
3321 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3322 u16 sci_port, unsigned int conf_offset,
3326 * delete_receive_sc - delete secure connection for receiving
3327 * @priv: private driver interface data from init()
3328 * @channel: secure channel
3329 * Returns: 0 on success, -1 on failure
3331 int (*delete_receive_sc)(void *priv, u32 channel);
3334 * create_receive_sa - create secure association for receive
3335 * @priv: private driver interface data from init()
3336 * @channel: secure channel
3337 * @an: association number
3338 * @lowest_pn: the lowest packet number can be received
3339 * @sak: the secure association key
3340 * Returns: 0 on success, -1 on failure
3342 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3343 u32 lowest_pn, const u8 *sak);
3346 * enable_receive_sa - enable the SA for receive
3347 * @priv: private driver interface data from init()
3348 * @channel: secure channel
3349 * @an: association number
3350 * Returns: 0 on success, -1 on failure
3352 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3355 * disable_receive_sa - disable SA for receive
3356 * @priv: private driver interface data from init()
3357 * @channel: secure channel index
3358 * @an: association number
3359 * Returns: 0 on success, -1 on failure
3361 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3364 * get_available_transmit_sc - get available transmit channel
3365 * @priv: Private driver interface data
3366 * @channel: secure channel
3367 * Returns: 0 on success, -1 on failure (or if not supported)
3369 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3372 * create_transmit_sc - create secure connection for transmit
3373 * @priv: private driver interface data from init()
3374 * @channel: secure channel
3375 * @sci_addr: secure channel identifier - address
3376 * @sci_port: secure channel identifier - port
3377 * Returns: 0 on success, -1 on failure
3379 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3380 u16 sci_port, unsigned int conf_offset);
3383 * delete_transmit_sc - delete secure connection for transmit
3384 * @priv: private driver interface data from init()
3385 * @channel: secure channel
3386 * Returns: 0 on success, -1 on failure
3388 int (*delete_transmit_sc)(void *priv, u32 channel);
3391 * create_transmit_sa - create secure association for transmit
3392 * @priv: private driver interface data from init()
3393 * @channel: secure channel index
3394 * @an: association number
3395 * @next_pn: the packet number used as next transmit packet
3396 * @confidentiality: True if the SA is to provide confidentiality
3397 * as well as integrity
3398 * @sak: the secure association key
3399 * Returns: 0 on success, -1 on failure
3401 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3402 Boolean confidentiality, const u8 *sak);
3405 * enable_transmit_sa - enable SA for transmit
3406 * @priv: private driver interface data from init()
3407 * @channel: secure channel
3408 * @an: association number
3409 * Returns: 0 on success, -1 on failure
3411 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3414 * disable_transmit_sa - disable SA for transmit
3415 * @priv: private driver interface data from init()
3416 * @channel: secure channel
3417 * @an: association number
3418 * Returns: 0 on success, -1 on failure
3420 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3421 #endif /* CONFIG_MACSEC */
3424 * init_mesh - Driver specific initialization for mesh
3425 * @priv: Private driver interface data
3426 * Returns: 0 on success, -1 on failure
3428 int (*init_mesh)(void *priv);
3431 * join_mesh - Join a mesh network
3432 * @priv: Private driver interface data
3433 * @params: Mesh configuration parameters
3434 * Returns: 0 on success, -1 on failure
3436 int (*join_mesh)(void *priv,
3437 struct wpa_driver_mesh_join_params *params);
3440 * leave_mesh - Leave a mesh network
3441 * @priv: Private driver interface data
3442 * Returns 0 on success, -1 on failure
3444 int (*leave_mesh)(void *priv);
3447 * do_acs - Automatically select channel
3448 * @priv: Private driver interface data
3449 * @params: Parameters for ACS
3450 * Returns 0 on success, -1 on failure
3452 * This command can be used to offload ACS to the driver if the driver
3453 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3455 int (*do_acs)(void *priv, struct drv_acs_params *params);
3458 * set_band - Notify driver of band selection
3459 * @priv: Private driver interface data
3460 * @band: The selected band(s)
3461 * Returns 0 on success, -1 on failure
3463 int (*set_band)(void *priv, enum set_band band);
3466 * get_pref_freq_list - Get preferred frequency list for an interface
3467 * @priv: Private driver interface data
3468 * @if_type: Interface type
3469 * @num: Number of channels
3470 * @freq_list: Preferred channel frequency list encoded in MHz values
3471 * Returns 0 on success, -1 on failure
3473 * This command can be used to query the preferred frequency list from
3474 * the driver specific to a particular interface type.
3476 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
3477 unsigned int *num, unsigned int *freq_list);
3480 * set_prob_oper_freq - Indicate probable P2P operating channel
3481 * @priv: Private driver interface data
3482 * @freq: Channel frequency in MHz
3483 * Returns 0 on success, -1 on failure
3485 * This command can be used to inform the driver of the operating
3486 * frequency that an ongoing P2P group formation is likely to come up
3487 * on. Local device is assuming P2P Client role.
3489 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
3492 * abort_scan - Request the driver to abort an ongoing scan
3493 * @priv: Private driver interface data
3494 * Returns 0 on success, -1 on failure
3496 int (*abort_scan)(void *priv);
3501 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3503 enum wpa_event_type {
3505 * EVENT_ASSOC - Association completed
3507 * This event needs to be delivered when the driver completes IEEE
3508 * 802.11 association or reassociation successfully.
3509 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3510 * after this event has been generated. In addition, optional
3511 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3512 * more information about the association. If the driver interface gets
3513 * both of these events at the same time, it can also include the
3514 * assoc_info data in EVENT_ASSOC call.
3519 * EVENT_DISASSOC - Association lost
3521 * This event should be called when association is lost either due to
3522 * receiving deauthenticate or disassociate frame from the AP or when
3523 * sending either of these frames to the current AP. If the driver
3524 * supports separate deauthentication event, EVENT_DISASSOC should only
3525 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3526 * In AP mode, union wpa_event_data::disassoc_info is required.
3531 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3533 * This event must be delivered when a Michael MIC error is detected by
3534 * the local driver. Additional data for event processing is
3535 * provided with union wpa_event_data::michael_mic_failure. This
3536 * information is used to request new encyption key and to initiate
3537 * TKIP countermeasures if needed.
3539 EVENT_MICHAEL_MIC_FAILURE,
3542 * EVENT_SCAN_RESULTS - Scan results available
3544 * This event must be called whenever scan results are available to be
3545 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3546 * is expected to be used some time after struct wpa_driver_ops::scan()
3547 * is called. If the driver provides an unsolicited event when the scan
3548 * has been completed, this event can be used to trigger
3549 * EVENT_SCAN_RESULTS call. If such event is not available from the
3550 * driver, the driver wrapper code is expected to use a registered
3551 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3552 * scan is expected to be completed. Optional information about
3553 * completed scan can be provided with union wpa_event_data::scan_info.
3558 * EVENT_ASSOCINFO - Report optional extra information for association
3560 * This event can be used to report extra association information for
3561 * EVENT_ASSOC processing. This extra information includes IEs from
3562 * association frames and Beacon/Probe Response frames in union
3563 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3564 * EVENT_ASSOC. Alternatively, the driver interface can include
3565 * assoc_info data in the EVENT_ASSOC call if it has all the
3566 * information available at the same point.
3571 * EVENT_INTERFACE_STATUS - Report interface status changes
3573 * This optional event can be used to report changes in interface
3574 * status (interface added/removed) using union
3575 * wpa_event_data::interface_status. This can be used to trigger
3576 * wpa_supplicant to stop and re-start processing for the interface,
3577 * e.g., when a cardbus card is ejected/inserted.
3579 EVENT_INTERFACE_STATUS,
3582 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3584 * This event can be used to inform wpa_supplicant about candidates for
3585 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3586 * for scan request (ap_scan=2 mode), this event is required for
3587 * pre-authentication. If wpa_supplicant is performing scan request
3588 * (ap_scan=1), this event is optional since scan results can be used
3589 * to add pre-authentication candidates. union
3590 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3591 * candidate and priority of the candidate, e.g., based on the signal
3592 * strength, in order to try to pre-authenticate first with candidates
3593 * that are most likely targets for re-association.
3595 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3596 * on the candidate list. In addition, it can be called for the current
3597 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3598 * will automatically skip pre-authentication in cases where a valid
3599 * PMKSA exists. When more than one candidate exists, this event should
3600 * be generated once for each candidate.
3602 * Driver will be notified about successful pre-authentication with
3603 * struct wpa_driver_ops::add_pmkid() calls.
3605 EVENT_PMKID_CANDIDATE,
3608 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3610 * This event can be used to inform wpa_supplicant about desire to set
3611 * up secure direct link connection between two stations as defined in
3612 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3613 * STAKey negotiation. The caller will need to set peer address for the
3619 * EVENT_TDLS - Request TDLS operation
3621 * This event can be used to request a TDLS operation to be performed.
3626 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3628 * The driver is expected to report the received FT IEs from
3629 * FT authentication sequence from the AP. The FT IEs are included in
3630 * the extra information in union wpa_event_data::ft_ies.
3635 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3637 * The driver can use this event to inform wpa_supplicant about a STA
3638 * in an IBSS with which protected frames could be exchanged. This
3639 * event starts RSN authentication with the other STA to authenticate
3640 * the STA and set up encryption keys with it.
3642 EVENT_IBSS_RSN_START,
3645 * EVENT_AUTH - Authentication result
3647 * This event should be called when authentication attempt has been
3648 * completed. This is only used if the driver supports separate
3649 * authentication step (struct wpa_driver_ops::authenticate).
3650 * Information about authentication result is included in
3651 * union wpa_event_data::auth.
3656 * EVENT_DEAUTH - Authentication lost
3658 * This event should be called when authentication is lost either due
3659 * to receiving deauthenticate frame from the AP or when sending that
3660 * frame to the current AP.
3661 * In AP mode, union wpa_event_data::deauth_info is required.
3666 * EVENT_ASSOC_REJECT - Association rejected
3668 * This event should be called when (re)association attempt has been
3669 * rejected by the AP. Information about the association response is
3670 * included in union wpa_event_data::assoc_reject.
3675 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3677 EVENT_AUTH_TIMED_OUT,
3680 * EVENT_ASSOC_TIMED_OUT - Association timed out
3682 EVENT_ASSOC_TIMED_OUT,
3685 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3687 EVENT_WPS_BUTTON_PUSHED,
3690 * EVENT_TX_STATUS - Report TX status
3695 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3697 EVENT_RX_FROM_UNKNOWN,
3700 * EVENT_RX_MGMT - Report RX of a management frame
3705 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3707 * This event is used to indicate when the driver has started the
3708 * requested remain-on-channel duration. Information about the
3709 * operation is included in union wpa_event_data::remain_on_channel.
3711 EVENT_REMAIN_ON_CHANNEL,
3714 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3716 * This event is used to indicate when the driver has completed
3717 * remain-on-channel duration, i.e., may noot be available on the
3718 * requested channel anymore. Information about the
3719 * operation is included in union wpa_event_data::remain_on_channel.
3721 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3724 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3726 * This event is used to indicate when a Probe Request frame has been
3727 * received. Information about the received frame is included in
3728 * union wpa_event_data::rx_probe_req. The driver is required to report
3729 * these events only after successfully completed probe_req_report()
3730 * commands to request the events (i.e., report parameter is non-zero)
3731 * in station mode. In AP mode, Probe Request frames should always be
3737 * EVENT_NEW_STA - New wired device noticed
3739 * This event is used to indicate that a new device has been detected
3740 * in a network that does not use association-like functionality (i.e.,
3741 * mainly wired Ethernet). This can be used to start EAPOL
3742 * authenticator when receiving a frame from a device. The address of
3743 * the device is included in union wpa_event_data::new_sta.
3748 * EVENT_EAPOL_RX - Report received EAPOL frame
3750 * When in AP mode with hostapd, this event is required to be used to
3751 * deliver the receive EAPOL frames from the driver.
3756 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3758 * This event is used to indicate changes in the signal strength
3759 * observed in frames received from the current AP if signal strength
3760 * monitoring has been enabled with signal_monitor().
3762 EVENT_SIGNAL_CHANGE,
3765 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3767 * This event is used to indicate that the interface was enabled after
3768 * having been previously disabled, e.g., due to rfkill.
3770 EVENT_INTERFACE_ENABLED,
3773 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3775 * This event is used to indicate that the interface was disabled,
3776 * e.g., due to rfkill.
3778 EVENT_INTERFACE_DISABLED,
3781 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3783 * This event is used to indicate that the channel list has changed,
3784 * e.g., because of a regulatory domain change triggered by scan
3785 * results including an AP advertising a country code.
3787 EVENT_CHANNEL_LIST_CHANGED,
3790 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3792 * This event is used to indicate that the driver cannot maintain this
3793 * interface in its operation mode anymore. The most likely use for
3794 * this is to indicate that AP mode operation is not available due to
3795 * operating channel would need to be changed to a DFS channel when
3796 * the driver does not support radar detection and another virtual
3797 * interfaces caused the operating channel to change. Other similar
3798 * resource conflicts could also trigger this for station mode
3799 * interfaces. This event can be propagated when channel switching
3802 EVENT_INTERFACE_UNAVAILABLE,
3805 * EVENT_BEST_CHANNEL
3807 * Driver generates this event whenever it detects a better channel
3808 * (e.g., based on RSSI or channel use). This information can be used
3809 * to improve channel selection for a new AP/P2P group.
3814 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3816 * This event should be called when a Deauthentication frame is dropped
3817 * due to it not being protected (MFP/IEEE 802.11w).
3818 * union wpa_event_data::unprot_deauth is required to provide more
3819 * details of the frame.
3821 EVENT_UNPROT_DEAUTH,
3824 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3826 * This event should be called when a Disassociation frame is dropped
3827 * due to it not being protected (MFP/IEEE 802.11w).
3828 * union wpa_event_data::unprot_disassoc is required to provide more
3829 * details of the frame.
3831 EVENT_UNPROT_DISASSOC,
3834 * EVENT_STATION_LOW_ACK
3836 * Driver generates this event whenever it detected that a particular
3837 * station was lost. Detection can be through massive transmission
3838 * failures for example.
3840 EVENT_STATION_LOW_ACK,
3843 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3845 EVENT_IBSS_PEER_LOST,
3848 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3850 * This event carries the new replay counter to notify wpa_supplicant
3851 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3852 * completed Group Key Handshake while the host (including
3853 * wpa_supplicant was sleeping).
3855 EVENT_DRIVER_GTK_REKEY,
3858 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3860 EVENT_SCHED_SCAN_STOPPED,
3863 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3865 * This event indicates that the station responded to the poll
3866 * initiated with @poll_client.
3868 EVENT_DRIVER_CLIENT_POLL_OK,
3871 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3873 EVENT_EAPOL_TX_STATUS,
3876 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3878 * Described in wpa_event_data.ch_switch
3883 * EVENT_WNM - Request WNM operation
3885 * This event can be used to request a WNM operation to be performed.
3890 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3892 * This event indicates that the driver reported a connection failure
3893 * with the specified client (for example, max client reached, etc.) in
3896 EVENT_CONNECT_FAILED_REASON,
3899 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
3901 * A radar has been detected on the supplied frequency, hostapd should
3902 * react accordingly (e.g., change channel).
3904 EVENT_DFS_RADAR_DETECTED,
3907 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
3909 * After a successful CAC, the channel can be marked clear and used.
3911 EVENT_DFS_CAC_FINISHED,
3914 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
3916 * The CAC was not successful, and the channel remains in the previous
3917 * state. This may happen due to a radar beeing detected or other
3918 * external influences.
3920 EVENT_DFS_CAC_ABORTED,
3923 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
3925 * The channel which was previously unavailable is now available again.
3927 EVENT_DFS_NOP_FINISHED,
3930 * EVENT_SURVEY - Received survey data
3932 * This event gets triggered when a driver query is issued for survey
3933 * data and the requested data becomes available. The returned data is
3934 * stored in struct survey_results. The results provide at most one
3935 * survey entry for each frequency and at minimum will provide one
3936 * survey entry for one frequency. The survey data can be os_malloc()'d
3937 * and then os_free()'d, so the event callback must only copy data.
3942 * EVENT_SCAN_STARTED - Scan started
3944 * This indicates that driver has started a scan operation either based
3945 * on a request from wpa_supplicant/hostapd or from another application.
3946 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3947 * completed (either successfully or by getting cancelled).
3952 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3954 * This event indicates a set of frequency ranges that should be avoided
3955 * to reduce issues due to interference or internal co-existence
3956 * information in the driver.
3958 EVENT_AVOID_FREQUENCIES,
3961 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3963 EVENT_NEW_PEER_CANDIDATE,
3966 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
3968 * Indicates a pair of primary and secondary channels chosen by ACS
3971 EVENT_ACS_CHANNEL_SELECTED,
3974 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
3977 * This event indicates that channel availability check has been started
3978 * on a DFS frequency by a driver that supports DFS Offload.
3980 EVENT_DFS_CAC_STARTED,
3985 * struct freq_survey - Channel survey info
3987 * @ifidx: Interface index in which this survey was observed
3988 * @freq: Center of frequency of the surveyed channel
3989 * @nf: Channel noise floor in dBm
3990 * @channel_time: Amount of time in ms the radio spent on the channel
3991 * @channel_time_busy: Amount of time in ms the radio detected some signal
3992 * that indicated to the radio the channel was not clear
3993 * @channel_time_rx: Amount of time the radio spent receiving data
3994 * @channel_time_tx: Amount of time the radio spent transmitting data
3995 * @filled: bitmask indicating which fields have been reported, see
3996 * SURVEY_HAS_* defines.
3997 * @list: Internal list pointers
3999 struct freq_survey {
4004 u64 channel_time_busy;
4005 u64 channel_time_rx;
4006 u64 channel_time_tx;
4007 unsigned int filled;
4008 struct dl_list list;
4011 #define SURVEY_HAS_NF BIT(0)
4012 #define SURVEY_HAS_CHAN_TIME BIT(1)
4013 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4014 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4015 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4019 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4021 union wpa_event_data {
4023 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4025 * This structure is optional for EVENT_ASSOC calls and required for
4026 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4027 * driver interface does not need to generate separate EVENT_ASSOCINFO
4032 * reassoc - Flag to indicate association or reassociation
4037 * req_ies - (Re)Association Request IEs
4039 * If the driver generates WPA/RSN IE, this event data must be
4040 * returned for WPA handshake to have needed information. If
4041 * wpa_supplicant-generated WPA/RSN IE is used, this
4042 * information event is optional.
4044 * This should start with the first IE (fixed fields before IEs
4045 * are not included).
4050 * req_ies_len - Length of req_ies in bytes
4055 * resp_ies - (Re)Association Response IEs
4057 * Optional association data from the driver. This data is not
4058 * required WPA, but may be useful for some protocols and as
4059 * such, should be reported if this is available to the driver
4062 * This should start with the first IE (fixed fields before IEs
4063 * are not included).
4068 * resp_ies_len - Length of resp_ies in bytes
4070 size_t resp_ies_len;
4073 * beacon_ies - Beacon or Probe Response IEs
4075 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4076 * Probe Response frames from the current AP (i.e., the one
4077 * that the client just associated with). This information is
4078 * used to update WPA/RSN IE for the AP. If this field is not
4079 * set, the results from previous scan will be used. If no
4080 * data for the new AP is found, scan results will be requested
4081 * again (without scan request). At this point, the driver is
4082 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4085 * This should start with the first IE (fixed fields before IEs
4086 * are not included).
4088 const u8 *beacon_ies;
4091 * beacon_ies_len - Length of beacon_ies */
4092 size_t beacon_ies_len;
4095 * freq - Frequency of the operational channel in MHz
4100 * wmm_params - WMM parameters used in this association.
4102 struct wmm_params wmm_params;
4105 * addr - Station address (for AP mode)
4110 * The following is the key management offload information
4113 * @key_replay_ctr_len
4121 * authorized - Status of key management offload,
4127 * key_replay_ctr - Key replay counter value last used
4128 * in a valid EAPOL-Key frame
4130 const u8 *key_replay_ctr;
4133 * key_replay_ctr_len - The length of key_replay_ctr
4135 size_t key_replay_ctr_len;
4138 * ptk_kck - The derived PTK KCK
4143 * ptk_kek_len - The length of ptk_kck
4148 * ptk_kek - The derived PTK KEK
4153 * ptk_kek_len - The length of ptk_kek
4158 * subnet_status - The subnet status:
4159 * 0 = unknown, 1 = unchanged, 2 = changed
4165 * struct disassoc_info - Data for EVENT_DISASSOC events
4167 struct disassoc_info {
4169 * addr - Station address (for AP mode)
4174 * reason_code - Reason Code (host byte order) used in
4175 * Deauthentication frame
4180 * ie - Optional IE(s) in Disassociation frame
4185 * ie_len - Length of ie buffer in octets
4190 * locally_generated - Whether the frame was locally generated
4192 int locally_generated;
4196 * struct deauth_info - Data for EVENT_DEAUTH events
4198 struct deauth_info {
4200 * addr - Station address (for AP mode)
4205 * reason_code - Reason Code (host byte order) used in
4206 * Deauthentication frame
4211 * ie - Optional IE(s) in Deauthentication frame
4216 * ie_len - Length of ie buffer in octets
4221 * locally_generated - Whether the frame was locally generated
4223 int locally_generated;
4227 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4229 struct michael_mic_failure {
4232 } michael_mic_failure;
4235 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4237 struct interface_status {
4240 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4245 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4247 struct pmkid_candidate {
4248 /** BSSID of the PMKID candidate */
4250 /** Smaller the index, higher the priority */
4252 /** Whether RSN IE includes pre-authenticate flag */
4257 * struct stkstart - Data for EVENT_STKSTART
4264 * struct tdls - Data for EVENT_TDLS
4270 TDLS_REQUEST_TEARDOWN,
4271 TDLS_REQUEST_DISCOVER,
4273 u16 reason_code; /* for teardown */
4277 * struct wnm - Data for EVENT_WNM
4295 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4297 * During FT (IEEE 802.11r) authentication sequence, the driver is
4298 * expected to use this event to report received FT IEs (MDIE, FTIE,
4299 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4300 * IEs for the next message will be delivered through the
4301 * struct wpa_driver_ops::update_ft_ies() callback.
4307 u8 target_ap[ETH_ALEN];
4308 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4310 /** Length of ric_ies buffer in octets */
4315 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4317 struct ibss_rsn_start {
4322 * struct auth_info - Data for EVENT_AUTH events
4328 u16 auth_transaction;
4335 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4337 struct assoc_reject {
4339 * bssid - BSSID of the AP that rejected association
4344 * resp_ies - (Re)Association Response IEs
4346 * Optional association data from the driver. This data is not
4347 * required WPA, but may be useful for some protocols and as
4348 * such, should be reported if this is available to the driver
4351 * This should start with the first IE (fixed fields before IEs
4352 * are not included).
4357 * resp_ies_len - Length of resp_ies in bytes
4359 size_t resp_ies_len;
4362 * status_code - Status Code from (Re)association Response
4367 struct timeout_event {
4372 * struct tx_status - Data for EVENT_TX_STATUS events
4384 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4386 struct rx_from_unknown {
4393 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4401 * drv_priv - Pointer to store driver private BSS information
4403 * If not set to NULL, this is used for comparison with
4404 * hostapd_data->drv_priv to determine which BSS should process
4410 * freq - Frequency (in MHz) on which the frame was received
4415 * ssi_signal - Signal strength in dBm (or 0 if not available)
4421 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4423 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4425 struct remain_on_channel {
4427 * freq - Channel frequency in MHz
4432 * duration - Duration to remain on the channel in milliseconds
4434 unsigned int duration;
4435 } remain_on_channel;
4438 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4439 * @aborted: Whether the scan was aborted
4440 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4441 * @num_freqs: Number of entries in freqs array
4442 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4444 * @num_ssids: Number of entries in ssids array
4445 * @external_scan: Whether the scan info is for an external scan
4446 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
4447 * 0 if the source of the scan event is a vendor scan
4453 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4460 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4462 struct rx_probe_req {
4464 * sa - Source address of the received Probe Request frame
4469 * da - Destination address of the received Probe Request frame
4470 * or %NULL if not available
4475 * bssid - BSSID of the received Probe Request frame or %NULL
4481 * ie - IEs from the Probe Request body
4486 * ie_len - Length of ie buffer in octets
4491 * signal - signal strength in dBm (or 0 if not available)
4497 * struct new_sta - Data for EVENT_NEW_STA events
4504 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4513 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4515 struct wpa_signal_info signal_change;
4518 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4519 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4520 * @freq_5: Best 5 GHz band channel frequency in MHz
4521 * @freq_overall: Best channel frequency in MHz
4523 * 0 can be used to indicate no preference in either band.
4525 struct best_channel {
4531 struct unprot_deauth {
4537 struct unprot_disassoc {
4544 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4545 * @addr: station address
4552 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4554 struct ibss_peer_lost {
4559 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4561 struct driver_gtk_rekey {
4563 const u8 *replay_ctr;
4567 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4568 * @addr: station address
4570 struct client_poll {
4575 * struct eapol_tx_status
4576 * @dst: Original destination
4577 * @data: Data starting with IEEE 802.1X header (!)
4578 * @data_len: Length of data
4579 * @ack: Indicates ack or lost frame
4581 * This corresponds to hapd_send_eapol if the frame sent
4582 * there isn't just reported as EVENT_TX_STATUS.
4584 struct eapol_tx_status {
4593 * @freq: Frequency of new channel in MHz
4594 * @ht_enabled: Whether this is an HT channel
4595 * @ch_offset: Secondary channel offset
4596 * @ch_width: Channel width
4597 * @cf1: Center frequency 1
4598 * @cf2: Center frequency 2
4604 enum chan_width ch_width;
4610 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4611 * @addr: Remote client address
4612 * @code: Reason code for connection failure
4614 struct connect_failed_reason {
4620 } connect_failed_reason;
4623 * struct dfs_event - Data for radar detected events
4624 * @freq: Frequency of the channel in MHz
4630 enum chan_width chan_width;
4636 * survey_results - Survey result data for EVENT_SURVEY
4637 * @freq_filter: Requested frequency survey filter, 0 if request
4638 * was for all survey data
4639 * @survey_list: Linked list of survey data (struct freq_survey)
4641 struct survey_results {
4642 unsigned int freq_filter;
4643 struct dl_list survey_list; /* struct freq_survey */
4647 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4648 * @initiator: Initiator of the regulatory change
4649 * @type: Regulatory change type
4650 * @alpha2: Country code (or "" if not available)
4652 struct channel_list_changed {
4653 enum reg_change_initiator initiator;
4656 } channel_list_changed;
4659 * freq_range - List of frequency ranges
4661 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4663 struct wpa_freq_range_list freq_range;
4668 * @peer: Peer address
4670 * @ie_len: Length of @ies
4672 * Notification of new candidate mesh peer.
4681 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4682 * @pri_channel: Selected primary channel
4683 * @sec_channel: Selected secondary channel
4684 * @vht_seg0_center_ch: VHT mode Segment0 center channel
4685 * @vht_seg1_center_ch: VHT mode Segment1 center channel
4686 * @ch_width: Selected Channel width by driver. Driver may choose to
4687 * change hostapd configured ACS channel width due driver internal
4688 * channel restrictions.
4689 * hw_mode: Selected band (used with hw_mode=any)
4691 struct acs_selected_channels {
4694 u8 vht_seg0_center_ch;
4695 u8 vht_seg1_center_ch;
4697 enum hostapd_hw_mode hw_mode;
4698 } acs_selected_channels;
4702 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4703 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4704 * with struct wpa_driver_ops::init()
4705 * @event: event type (defined above)
4706 * @data: possible extra data for the event
4708 * Driver wrapper code should call this function whenever an event is received
4711 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4712 union wpa_event_data *data);
4716 * The following inline functions are provided for convenience to simplify
4717 * event indication for some of the common events.
4720 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4721 size_t ielen, int reassoc)
4723 union wpa_event_data event;
4724 os_memset(&event, 0, sizeof(event));
4725 event.assoc_info.reassoc = reassoc;
4726 event.assoc_info.req_ies = ie;
4727 event.assoc_info.req_ies_len = ielen;
4728 event.assoc_info.addr = addr;
4729 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4732 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4734 union wpa_event_data event;
4735 os_memset(&event, 0, sizeof(event));
4736 event.disassoc_info.addr = addr;
4737 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4740 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4743 union wpa_event_data event;
4744 os_memset(&event, 0, sizeof(event));
4745 event.eapol_rx.src = src;
4746 event.eapol_rx.data = data;
4747 event.eapol_rx.data_len = data_len;
4748 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4751 /* driver_common.c */
4752 void wpa_scan_results_free(struct wpa_scan_results *res);
4754 /* Convert wpa_event_type to a string for logging */
4755 const char * event_to_string(enum wpa_event_type event);
4757 /* Convert chan_width to a string for logging and control interfaces */
4758 const char * channel_width_to_string(enum chan_width width);
4760 int ht_supported(const struct hostapd_hw_modes *mode);
4761 int vht_supported(const struct hostapd_hw_modes *mode);
4763 struct wowlan_triggers *
4764 wpa_get_wowlan_triggers(const char *wowlan_triggers,
4765 const struct wpa_driver_capa *capa);
4767 /* NULL terminated array of linked in driver wrappers */
4768 extern const struct wpa_driver_ops *const wpa_drivers[];
4770 #endif /* DRIVER_H */