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)
865 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
866 * AP as usual. Valid for DMG network only.
873 HIDDEN_SSID_ZERO_LEN,
874 HIDDEN_SSID_ZERO_CONTENTS
877 struct wowlan_triggers {
881 u8 gtk_rekey_failure;
883 u8 four_way_handshake;
887 struct wpa_driver_ap_params {
889 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
894 * head_len - Length of the head buffer in octets
899 * tail - Beacon tail following TIM IE
904 * tail_len - Length of the tail buffer in octets
909 * dtim_period - DTIM period
914 * beacon_int - Beacon interval
919 * basic_rates: -1 terminated array of basic rates in 100 kbps
921 * This parameter can be used to set a specific basic rate set for the
922 * BSS. If %NULL, default basic rate set is used.
927 * proberesp - Probe Response template
929 * This is used by drivers that reply to Probe Requests internally in
930 * AP mode and require the full Probe Response template.
935 * proberesp_len - Length of the proberesp buffer in octets
937 size_t proberesp_len;
940 * ssid - The SSID to use in Beacon/Probe Response frames
945 * ssid_len - Length of the SSID (1..32)
950 * hide_ssid - Whether to hide the SSID
952 enum hide_ssid hide_ssid;
955 * pairwise_ciphers - WPA_CIPHER_* bitfield
957 unsigned int pairwise_ciphers;
960 * group_cipher - WPA_CIPHER_*
962 unsigned int group_cipher;
965 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
967 unsigned int key_mgmt_suites;
970 * auth_algs - WPA_AUTH_ALG_* bitfield
972 unsigned int auth_algs;
975 * wpa_version - WPA_PROTO_* bitfield
977 unsigned int wpa_version;
980 * privacy - Whether privacy is used in the BSS
985 * beacon_ies - WPS/P2P IE(s) for Beacon frames
987 * This is used to add IEs like WPS IE and P2P IE by drivers that do
988 * not use the full Beacon template.
990 const struct wpabuf *beacon_ies;
993 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
995 * This is used to add IEs like WPS IE and P2P IE by drivers that
996 * reply to Probe Request frames internally.
998 const struct wpabuf *proberesp_ies;
1001 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1003 * This is used to add IEs like WPS IE by drivers that reply to
1004 * (Re)Association Request frames internally.
1006 const struct wpabuf *assocresp_ies;
1009 * isolate - Whether to isolate frames between associated stations
1011 * If this is non-zero, the AP is requested to disable forwarding of
1012 * frames between associated stations.
1017 * cts_protect - Whether CTS protection is enabled
1022 * preamble - Whether short preamble is enabled
1027 * short_slot_time - Whether short slot time is enabled
1029 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1030 * not set (e.g., when 802.11g mode is not in use)
1032 int short_slot_time;
1035 * ht_opmode - HT operation mode or -1 if HT not in use
1040 * interworking - Whether Interworking is enabled
1045 * hessid - Homogeneous ESS identifier or %NULL if not set
1050 * access_network_type - Access Network Type (0..15)
1052 * This is used for filtering Probe Request frames when Interworking is
1055 u8 access_network_type;
1058 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1060 * This is used by driver which advertises this capability.
1062 int ap_max_inactivity;
1065 * ctwindow - Client Traffic Window (in TUs)
1070 * smps_mode - SMPS mode
1072 * SMPS mode to be used by the AP, specified as the relevant bits of
1073 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1075 unsigned int smps_mode;
1078 * disable_dgaf - Whether group-addressed frames are disabled
1083 * osen - Whether OSEN security is enabled
1088 * freq - Channel parameters for dynamic bandwidth changes
1090 struct hostapd_freq_params *freq;
1093 * reenable - Whether this is to re-enable beaconing
1098 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1099 * infrastructure BSS. Valid only for DMG network.
1104 struct wpa_driver_mesh_bss_params {
1105 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1107 * TODO: Other mesh configuration parameters would go here.
1108 * See NL80211_MESHCONF_* for all the mesh config parameters.
1111 int peer_link_timeout;
1114 struct wpa_driver_mesh_join_params {
1117 const int *basic_rates;
1120 struct hostapd_freq_params freq;
1123 struct wpa_driver_mesh_bss_params conf;
1124 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1125 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1126 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1127 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1132 * struct wpa_driver_capa - Driver capability information
1134 struct wpa_driver_capa {
1135 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1136 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1137 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1138 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1139 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1140 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1141 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1142 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1143 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1144 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
1145 /** Bitfield of supported key management suites */
1146 unsigned int key_mgmt;
1148 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1149 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1150 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1151 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1152 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1153 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1154 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1155 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1156 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1157 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1158 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1159 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1160 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1161 /** Bitfield of supported cipher suites */
1164 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1165 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1166 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1167 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1170 /** Driver generated WPA/RSN IE */
1171 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1172 /** Driver needs static WEP key setup after association command */
1173 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1174 /** Driver takes care of all DFS operations */
1175 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1176 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1177 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1178 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1179 /** Driver is for a wired Ethernet interface */
1180 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1181 /** Driver provides separate commands for authentication and association (SME in
1182 * wpa_supplicant). */
1183 #define WPA_DRIVER_FLAGS_SME 0x00000020
1184 /** Driver supports AP mode */
1185 #define WPA_DRIVER_FLAGS_AP 0x00000040
1186 /** Driver needs static WEP key setup after association has been completed */
1187 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1188 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1189 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1190 /** Driver supports concurrent P2P operations */
1191 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1193 * Driver uses the initial interface as a dedicated management interface, i.e.,
1194 * it cannot be used for P2P group operations or non-P2P purposes.
1196 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1197 /** This interface is P2P capable (P2P GO or P2P Client) */
1198 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1199 /** Driver supports station and key removal when stopping an AP */
1200 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1202 * Driver uses the initial interface for P2P management interface and non-P2P
1203 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1204 * P2P group operations.
1206 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1208 * Driver is known to use sane error codes, i.e., when it indicates that
1209 * something (e.g., association) fails, there was indeed a failure and the
1210 * operation does not end up getting completed successfully later.
1212 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1213 /** Driver supports off-channel TX */
1214 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1215 /** Driver indicates TX status events for EAPOL Data frames */
1216 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1217 /** Driver indicates TX status events for Deauth/Disassoc frames */
1218 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1219 /** Driver supports roaming (BSS selection) in firmware */
1220 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1221 /** Driver supports operating as a TDLS peer */
1222 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1223 /** Driver requires external TDLS setup/teardown/discovery */
1224 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1225 /** Driver indicates support for Probe Response offloading in AP mode */
1226 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1227 /** Driver supports U-APSD in AP mode */
1228 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1229 /** Driver supports inactivity timer in AP mode */
1230 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1231 /** Driver expects user space implementation of MLME in AP mode */
1232 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1233 /** Driver supports SAE with user space SME */
1234 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1235 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1236 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1237 /** Driver supports IBSS (Ad-hoc) mode */
1238 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1239 /** Driver supports radar detection */
1240 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1241 /** Driver supports a dedicated interface for P2P Device */
1242 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1243 /** Driver supports QoS Mapping */
1244 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1245 /** Driver supports CSA in AP mode */
1246 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1247 /** Driver supports mesh */
1248 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1249 /** Driver support ACS offload */
1250 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1251 /** Driver supports key management offload */
1252 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1253 /** Driver supports TDLS channel switching */
1254 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1255 /** Driver supports IBSS with HT datarates */
1256 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
1257 /** Driver supports IBSS with VHT datarates */
1258 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
1259 /** Driver supports automatic band selection */
1260 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
1261 /** Driver supports simultaneous off-channel operations */
1262 #define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
1263 /** Driver supports full AP client state */
1264 #define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
1267 #define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1268 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1270 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1271 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1272 unsigned int smps_modes;
1274 unsigned int wmm_ac_supported:1;
1276 unsigned int mac_addr_rand_scan_supported:1;
1277 unsigned int mac_addr_rand_sched_scan_supported:1;
1279 /** Maximum number of supported active probe SSIDs */
1282 /** Maximum number of supported active probe SSIDs for sched_scan */
1283 int max_sched_scan_ssids;
1285 /** Maximum number of supported scan plans for scheduled scan */
1286 unsigned int max_sched_scan_plans;
1288 /** Maximum interval in a scan plan. In seconds */
1289 u32 max_sched_scan_plan_interval;
1291 /** Maximum number of iterations in a single scan plan */
1292 u32 max_sched_scan_plan_iterations;
1294 /** Whether sched_scan (offloaded scanning) is supported */
1295 int sched_scan_supported;
1297 /** Maximum number of supported match sets for sched_scan */
1301 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1303 unsigned int max_remain_on_chan;
1306 * max_stations - Maximum number of associated stations the driver
1307 * supports in AP mode
1309 unsigned int max_stations;
1312 * probe_resp_offloads - Bitmap of supported protocols by the driver
1313 * for Probe Response offloading.
1315 /** Driver Probe Response offloading support for WPS ver. 1 */
1316 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1317 /** Driver Probe Response offloading support for WPS ver. 2 */
1318 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1319 /** Driver Probe Response offloading support for P2P */
1320 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1321 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1322 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1323 unsigned int probe_resp_offloads;
1325 unsigned int max_acl_mac_addrs;
1328 * Number of supported concurrent channels
1330 unsigned int num_multichan_concurrent;
1333 * extended_capa - extended capabilities in driver/device
1335 * Must be allocated and freed by driver and the pointers must be
1336 * valid for the lifetime of the driver, i.e., freed in deinit()
1338 const u8 *extended_capa, *extended_capa_mask;
1339 unsigned int extended_capa_len;
1341 struct wowlan_triggers wowlan_triggers;
1343 /** Driver adds the DS Params Set IE in Probe Request frames */
1344 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1345 /** Driver adds the WFA TPC IE in Probe Request frames */
1346 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1347 /** Driver handles quiet period requests */
1348 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1350 * Driver is capable of inserting the current TX power value into the body of
1351 * transmitted frames.
1352 * Background: Some Action frames include a TPC Report IE. This IE contains a
1353 * TX power field, which has to be updated by lower layers. One such Action
1354 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1355 * of spectrum management). Note that this insertion takes place at a fixed
1356 * offset, namely the 6th byte in the Action frame body.
1358 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1361 /* Driver concurrency capabilities */
1362 unsigned int conc_capab;
1363 /* Maximum number of concurrent channels on 2.4 GHz */
1364 unsigned int max_conc_chan_2_4;
1365 /* Maximum number of concurrent channels on 5 GHz */
1366 unsigned int max_conc_chan_5_0;
1368 /* Maximum number of supported CSA counters */
1369 u16 max_csa_counters;
1373 struct hostapd_data;
1375 struct hostap_sta_driver_data {
1376 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1377 unsigned long current_tx_rate;
1378 unsigned long inactive_msec;
1379 unsigned long flags;
1380 unsigned long num_ps_buf_frames;
1381 unsigned long tx_retry_failed;
1382 unsigned long tx_retry_count;
1387 struct hostapd_sta_add_params {
1391 const u8 *supp_rates;
1392 size_t supp_rates_len;
1393 u16 listen_interval;
1394 const struct ieee80211_ht_capabilities *ht_capabilities;
1395 const struct ieee80211_vht_capabilities *vht_capabilities;
1396 int vht_opmode_enabled;
1398 u32 flags; /* bitmask of WPA_STA_* flags */
1399 u32 flags_mask; /* unset bits in flags */
1401 enum mesh_plink_state plink_state;
1402 #endif /* CONFIG_MESH */
1403 int set; /* Set STA parameters instead of add */
1405 const u8 *ext_capab;
1406 size_t ext_capab_len;
1407 const u8 *supp_channels;
1408 size_t supp_channels_len;
1409 const u8 *supp_oper_classes;
1410 size_t supp_oper_classes_len;
1413 struct mac_address {
1417 struct hostapd_acl_params {
1419 unsigned int num_mac_acl;
1420 struct mac_address mac_acl[0];
1423 enum wpa_driver_if_type {
1425 * WPA_IF_STATION - Station mode interface
1430 * WPA_IF_AP_VLAN - AP mode VLAN interface
1432 * This interface shares its address and Beacon frame with the main
1438 * WPA_IF_AP_BSS - AP mode BSS interface
1440 * This interface has its own address and Beacon frame.
1445 * WPA_IF_P2P_GO - P2P Group Owner
1450 * WPA_IF_P2P_CLIENT - P2P Client
1455 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1456 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1461 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1462 * abstracted P2P Device function in the driver
1467 * WPA_IF_MESH - Mesh interface
1472 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1477 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1482 struct wpa_init_params {
1486 const char *driver_params;
1487 int use_pae_group_addr;
1491 u8 *own_addr; /* buffer for writing own MAC address */
1495 struct wpa_bss_params {
1496 /** Interface name (for multi-SSID/VLAN support) */
1498 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1507 enum mfp_options ieee80211w;
1510 #define WPA_STA_AUTHORIZED BIT(0)
1511 #define WPA_STA_WMM BIT(1)
1512 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1513 #define WPA_STA_MFP BIT(3)
1514 #define WPA_STA_TDLS_PEER BIT(4)
1515 #define WPA_STA_AUTHENTICATED BIT(5)
1516 #define WPA_STA_ASSOCIATED BIT(6)
1529 WNM_SLEEP_ENTER_CONFIRM,
1530 WNM_SLEEP_ENTER_FAIL,
1531 WNM_SLEEP_EXIT_CONFIRM,
1532 WNM_SLEEP_EXIT_FAIL,
1533 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1534 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1535 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1537 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1539 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1540 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1542 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1545 /* enum chan_width - Channel width definitions */
1557 * struct wpa_signal_info - Information about channel signal quality
1559 struct wpa_signal_info {
1561 int above_threshold;
1564 int avg_beacon_signal;
1567 enum chan_width chanwidth;
1573 * struct beacon_data - Beacon data
1574 * @head: Head portion of Beacon frame (before TIM IE)
1575 * @tail: Tail portion of Beacon frame (after TIM IE)
1576 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1577 * @proberesp_ies: Extra information element(s) to add into Probe Response
1579 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1580 * Response frames or %NULL
1581 * @probe_resp: Probe Response frame template
1582 * @head_len: Length of @head
1583 * @tail_len: Length of @tail
1584 * @beacon_ies_len: Length of beacon_ies in octets
1585 * @proberesp_ies_len: Length of proberesp_ies in octets
1586 * @proberesp_ies_len: Length of proberesp_ies in octets
1587 * @probe_resp_len: Length of probe response template (@probe_resp)
1589 struct beacon_data {
1596 size_t head_len, tail_len;
1597 size_t beacon_ies_len;
1598 size_t proberesp_ies_len;
1599 size_t assocresp_ies_len;
1600 size_t probe_resp_len;
1604 * struct csa_settings - Settings for channel switch command
1605 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1606 * @block_tx: 1 - block transmission for CSA period
1607 * @freq_params: Next channel frequency parameter
1608 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1609 * @beacon_after: Next beacon/probe resp/asooc resp info
1610 * @counter_offset_beacon: Offset to the count field in beacon's tail
1611 * @counter_offset_presp: Offset to the count field in probe resp.
1613 struct csa_settings {
1617 struct hostapd_freq_params freq_params;
1618 struct beacon_data beacon_csa;
1619 struct beacon_data beacon_after;
1621 u16 counter_offset_beacon[2];
1622 u16 counter_offset_presp[2];
1625 /* TDLS peer capabilities for send_tdls_mgmt() */
1626 enum tdls_peer_capability {
1627 TDLS_PEER_HT = BIT(0),
1628 TDLS_PEER_VHT = BIT(1),
1629 TDLS_PEER_WMM = BIT(2),
1632 /* valid info in the wmm_params struct */
1633 enum wmm_params_valid_info {
1634 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1638 * struct wmm_params - WMM parameterss configured for this association
1639 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1640 * of the struct contain valid information.
1641 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1642 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1649 #ifdef CONFIG_MACSEC
1650 struct macsec_init_params {
1651 Boolean always_include_sci;
1655 #endif /* CONFIG_MACSEC */
1657 enum drv_br_port_attr {
1658 DRV_BR_PORT_ATTR_PROXYARP,
1659 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1662 enum drv_br_net_param {
1663 DRV_BR_NET_PARAM_GARP_ACCEPT,
1664 DRV_BR_MULTICAST_SNOOPING,
1667 struct drv_acs_params {
1668 /* Selected mode (HOSTAPD_MODE_*) */
1669 enum hostapd_hw_mode hw_mode;
1671 /* Indicates whether HT is enabled */
1674 /* Indicates whether HT40 is enabled */
1677 /* Indicates whether VHT is enabled */
1680 /* Configured ACS channel width */
1683 /* ACS channel list info */
1684 unsigned int ch_list_len;
1686 const int *freq_list;
1691 * struct wpa_driver_ops - Driver interface API definition
1693 * This structure defines the API that each driver interface needs to implement
1694 * for core wpa_supplicant code. All driver specific functionality is captured
1697 struct wpa_driver_ops {
1698 /** Name of the driver interface */
1700 /** One line description of the driver interface */
1704 * get_bssid - Get the current BSSID
1705 * @priv: private driver interface data
1706 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1708 * Returns: 0 on success, -1 on failure
1710 * Query kernel driver for the current BSSID and copy it to bssid.
1711 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1714 int (*get_bssid)(void *priv, u8 *bssid);
1717 * get_ssid - Get the current SSID
1718 * @priv: private driver interface data
1719 * @ssid: buffer for SSID (at least 32 bytes)
1721 * Returns: Length of the SSID on success, -1 on failure
1723 * Query kernel driver for the current SSID and copy it to ssid.
1724 * Returning zero is recommended if the STA is not associated.
1726 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1727 * can, at least in theory, contain control characters (including nul)
1728 * and as such, should be processed as binary data, not a printable
1731 int (*get_ssid)(void *priv, u8 *ssid);
1734 * set_key - Configure encryption key
1735 * @ifname: Interface name (for multi-SSID/VLAN support)
1736 * @priv: private driver interface data
1737 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1738 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1739 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1740 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1741 * %WPA_ALG_BIP_CMAC_256);
1742 * %WPA_ALG_NONE clears the key.
1743 * @addr: Address of the peer STA (BSSID of the current AP when setting
1744 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1745 * broadcast keys, %NULL for default keys that are used both for
1746 * broadcast and unicast; when clearing keys, %NULL is used to
1747 * indicate that both the broadcast-only and default key of the
1748 * specified key index is to be cleared
1749 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1751 * @set_tx: configure this key as the default Tx key (only used when
1752 * driver does not support separate unicast/individual key
1753 * @seq: sequence number/packet number, seq_len octets, the next
1754 * packet number to be used for in replay protection; configured
1755 * for Rx keys (in most cases, this is only used with broadcast
1756 * keys and set to zero for unicast keys); %NULL if not set
1757 * @seq_len: length of the seq, depends on the algorithm:
1758 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1759 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1761 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1762 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1764 * Returns: 0 on success, -1 on failure
1766 * Configure the given key for the kernel driver. If the driver
1767 * supports separate individual keys (4 default keys + 1 individual),
1768 * addr can be used to determine whether the key is default or
1769 * individual. If only 4 keys are supported, the default key with key
1770 * index 0 is used as the individual key. STA must be configured to use
1771 * it as the default Tx key (set_tx is set) and accept Rx for all the
1772 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1773 * broadcast keys, so key index 0 is available for this kind of
1776 * Please note that TKIP keys include separate TX and RX MIC keys and
1777 * some drivers may expect them in different order than wpa_supplicant
1778 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1779 * will trigger Michael MIC errors. This can be fixed by changing the
1780 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1781 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1782 * example on how this can be done.
1784 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1785 const u8 *addr, int key_idx, int set_tx,
1786 const u8 *seq, size_t seq_len,
1787 const u8 *key, size_t key_len);
1790 * init - Initialize driver interface
1791 * @ctx: context to be used when calling wpa_supplicant functions,
1792 * e.g., wpa_supplicant_event()
1793 * @ifname: interface name, e.g., wlan0
1795 * Returns: Pointer to private data, %NULL on failure
1797 * Initialize driver interface, including event processing for kernel
1798 * driver events (e.g., associated, scan results, Michael MIC failure).
1799 * This function can allocate a private configuration data area for
1800 * @ctx, file descriptor, interface name, etc. information that may be
1801 * needed in future driver operations. If this is not used, non-NULL
1802 * value will need to be returned because %NULL is used to indicate
1803 * failure. The returned value will be used as 'void *priv' data for
1804 * all other driver_ops functions.
1806 * The main event loop (eloop.c) of wpa_supplicant can be used to
1807 * register callback for read sockets (eloop_register_read_sock()).
1809 * See below for more information about events and
1810 * wpa_supplicant_event() function.
1812 void * (*init)(void *ctx, const char *ifname);
1815 * deinit - Deinitialize driver interface
1816 * @priv: private driver interface data from init()
1818 * Shut down driver interface and processing of driver events. Free
1819 * private data buffer if one was allocated in init() handler.
1821 void (*deinit)(void *priv);
1824 * set_param - Set driver configuration parameters
1825 * @priv: private driver interface data from init()
1826 * @param: driver specific configuration parameters
1828 * Returns: 0 on success, -1 on failure
1830 * Optional handler for notifying driver interface about configuration
1831 * parameters (driver_param).
1833 int (*set_param)(void *priv, const char *param);
1836 * set_countermeasures - Enable/disable TKIP countermeasures
1837 * @priv: private driver interface data
1838 * @enabled: 1 = countermeasures enabled, 0 = disabled
1840 * Returns: 0 on success, -1 on failure
1842 * Configure TKIP countermeasures. When these are enabled, the driver
1843 * should drop all received and queued frames that are using TKIP.
1845 int (*set_countermeasures)(void *priv, int enabled);
1848 * deauthenticate - Request driver to deauthenticate
1849 * @priv: private driver interface data
1850 * @addr: peer address (BSSID of the AP)
1851 * @reason_code: 16-bit reason code to be sent in the deauthentication
1854 * Returns: 0 on success, -1 on failure
1856 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1859 * associate - Request driver to associate
1860 * @priv: private driver interface data
1861 * @params: association parameters
1863 * Returns: 0 on success, -1 on failure
1865 int (*associate)(void *priv,
1866 struct wpa_driver_associate_params *params);
1869 * add_pmkid - Add PMKSA cache entry to the driver
1870 * @priv: private driver interface data
1871 * @bssid: BSSID for the PMKSA cache entry
1872 * @pmkid: PMKID for the PMKSA cache entry
1874 * Returns: 0 on success, -1 on failure
1876 * This function is called when a new PMK is received, as a result of
1877 * either normal authentication or RSN pre-authentication.
1879 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1880 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1881 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1882 * driver_ops function does not need to be implemented. Likewise, if
1883 * the driver does not support WPA, this function is not needed.
1885 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1888 * remove_pmkid - Remove PMKSA cache entry to the driver
1889 * @priv: private driver interface data
1890 * @bssid: BSSID for the PMKSA cache entry
1891 * @pmkid: PMKID for the PMKSA cache entry
1893 * Returns: 0 on success, -1 on failure
1895 * This function is called when the supplicant drops a PMKSA cache
1896 * entry 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 (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1908 * flush_pmkid - Flush PMKSA cache
1909 * @priv: private driver interface data
1911 * Returns: 0 on success, -1 on failure
1913 * This function is called when the supplicant drops all PMKSA cache
1914 * entries for any reason.
1916 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1917 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1918 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1919 * from wpa_supplicant, this driver_ops function does not need to be
1920 * implemented. Likewise, if the driver does not support WPA, this
1921 * function is not needed.
1923 int (*flush_pmkid)(void *priv);
1926 * get_capa - Get driver capabilities
1927 * @priv: private driver interface data
1929 * Returns: 0 on success, -1 on failure
1931 * Get driver/firmware/hardware capabilities.
1933 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1936 * poll - Poll driver for association information
1937 * @priv: private driver interface data
1939 * This is an option callback that can be used when the driver does not
1940 * provide event mechanism for association events. This is called when
1941 * receiving WPA EAPOL-Key messages that require association
1942 * information. The driver interface is supposed to generate associnfo
1943 * event before returning from this callback function. In addition, the
1944 * driver interface should generate an association event after having
1945 * sent out associnfo.
1947 void (*poll)(void *priv);
1950 * get_ifname - Get interface name
1951 * @priv: private driver interface data
1953 * Returns: Pointer to the interface name. This can differ from the
1954 * interface name used in init() call. Init() is called first.
1956 * This optional function can be used to allow the driver interface to
1957 * replace the interface name with something else, e.g., based on an
1958 * interface mapping from a more descriptive name.
1960 const char * (*get_ifname)(void *priv);
1963 * get_mac_addr - Get own MAC address
1964 * @priv: private driver interface data
1966 * Returns: Pointer to own MAC address or %NULL on failure
1968 * This optional function can be used to get the own MAC address of the
1969 * device from the driver interface code. This is only needed if the
1970 * l2_packet implementation for the OS does not provide easy access to
1972 const u8 * (*get_mac_addr)(void *priv);
1975 * set_operstate - Sets device operating state to DORMANT or UP
1976 * @priv: private driver interface data
1977 * @state: 0 = dormant, 1 = up
1978 * Returns: 0 on success, -1 on failure
1980 * This is an optional function that can be used on operating systems
1981 * that support a concept of controlling network device state from user
1982 * space applications. This function, if set, gets called with
1983 * state = 1 when authentication has been completed and with state = 0
1984 * when connection is lost.
1986 int (*set_operstate)(void *priv, int state);
1989 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1990 * @priv: Private driver interface data
1991 * @addr: Address of the station for which to set protection (may be
1992 * %NULL for group keys)
1993 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1994 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1995 * Returns: 0 on success, -1 on failure
1997 * This is an optional function that can be used to set the driver to
1998 * require protection for Tx and/or Rx frames. This uses the layer
1999 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2000 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2001 * set protection operation; instead, they set protection implicitly
2002 * based on configured keys.
2004 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2008 * get_hw_feature_data - Get hardware support data (channels and rates)
2009 * @priv: Private driver interface data
2010 * @num_modes: Variable for returning the number of returned modes
2011 * flags: Variable for returning hardware feature flags
2012 * Returns: Pointer to allocated hardware data on success or %NULL on
2013 * failure. Caller is responsible for freeing this.
2015 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2020 * send_mlme - Send management frame from MLME
2021 * @priv: Private driver interface data
2022 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2023 * @data_len: Size of the management frame
2024 * @noack: Do not wait for this frame to be acked (disable retries)
2025 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2027 * @csa_offs: Array of CSA offsets or %NULL
2028 * @csa_offs_len: Number of elements in csa_offs
2029 * Returns: 0 on success, -1 on failure
2031 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
2032 int noack, unsigned int freq, const u16 *csa_offs,
2033 size_t csa_offs_len);
2036 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2037 * @priv: Private driver interface data
2038 * @md: Mobility domain (2 octets) (also included inside ies)
2039 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2040 * @ies_len: Length of FT IEs in bytes
2041 * Returns: 0 on success, -1 on failure
2043 * The supplicant uses this callback to let the driver know that keying
2044 * material for FT is available and that the driver can use the
2045 * provided IEs in the next message in FT authentication sequence.
2047 * This function is only needed for driver that support IEEE 802.11r
2048 * (Fast BSS Transition).
2050 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2054 * get_scan_results2 - Fetch the latest scan results
2055 * @priv: private driver interface data
2057 * Returns: Allocated buffer of scan results (caller is responsible for
2058 * freeing the data structure) on success, NULL on failure
2060 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2063 * set_country - Set country
2064 * @priv: Private driver interface data
2065 * @alpha2: country to which to switch to
2066 * Returns: 0 on success, -1 on failure
2068 * This function is for drivers which support some form
2069 * of setting a regulatory domain.
2071 int (*set_country)(void *priv, const char *alpha2);
2074 * get_country - Get country
2075 * @priv: Private driver interface data
2076 * @alpha2: Buffer for returning country code (at least 3 octets)
2077 * Returns: 0 on success, -1 on failure
2079 int (*get_country)(void *priv, char *alpha2);
2082 * global_init - Global driver initialization
2083 * Returns: Pointer to private data (global), %NULL on failure
2085 * This optional function is called to initialize the driver wrapper
2086 * for global data, i.e., data that applies to all interfaces. If this
2087 * function is implemented, global_deinit() will also need to be
2088 * implemented to free the private data. The driver will also likely
2089 * use init2() function instead of init() to get the pointer to global
2090 * data available to per-interface initializer.
2092 void * (*global_init)(void);
2095 * global_deinit - Global driver deinitialization
2096 * @priv: private driver global data from global_init()
2098 * Terminate any global driver related functionality and free the
2099 * global data structure.
2101 void (*global_deinit)(void *priv);
2104 * init2 - Initialize driver interface (with global data)
2105 * @ctx: context to be used when calling wpa_supplicant functions,
2106 * e.g., wpa_supplicant_event()
2107 * @ifname: interface name, e.g., wlan0
2108 * @global_priv: private driver global data from global_init()
2109 * Returns: Pointer to private data, %NULL on failure
2111 * This function can be used instead of init() if the driver wrapper
2114 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2117 * get_interfaces - Get information about available interfaces
2118 * @global_priv: private driver global data from global_init()
2119 * Returns: Allocated buffer of interface information (caller is
2120 * responsible for freeing the data structure) on success, NULL on
2123 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2126 * scan2 - Request the driver to initiate scan
2127 * @priv: private driver interface data
2128 * @params: Scan parameters
2130 * Returns: 0 on success, -1 on failure
2132 * Once the scan results are ready, the driver should report scan
2133 * results event for wpa_supplicant which will eventually request the
2134 * results with wpa_driver_get_scan_results2().
2136 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2139 * authenticate - Request driver to authenticate
2140 * @priv: private driver interface data
2141 * @params: authentication parameters
2142 * Returns: 0 on success, -1 on failure
2144 * This is an optional function that can be used with drivers that
2145 * support separate authentication and association steps, i.e., when
2146 * wpa_supplicant can act as the SME. If not implemented, associate()
2147 * function is expected to take care of IEEE 802.11 authentication,
2150 int (*authenticate)(void *priv,
2151 struct wpa_driver_auth_params *params);
2154 * set_ap - Set Beacon and Probe Response information for AP mode
2155 * @priv: Private driver interface data
2156 * @params: Parameters to use in AP mode
2158 * This function is used to configure Beacon template and/or extra IEs
2159 * to add for Beacon and Probe Response frames for the driver in
2160 * AP mode. The driver is responsible for building the full Beacon
2161 * frame by concatenating the head part with TIM IE generated by the
2162 * driver/firmware and finishing with the tail part. Depending on the
2163 * driver architectue, this can be done either by using the full
2164 * template or the set of additional IEs (e.g., WPS and P2P IE).
2165 * Similarly, Probe Response processing depends on the driver design.
2166 * If the driver (or firmware) takes care of replying to Probe Request
2167 * frames, the extra IEs provided here needs to be added to the Probe
2170 * Returns: 0 on success, -1 on failure
2172 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
2175 * set_acl - Set ACL in AP mode
2176 * @priv: Private driver interface data
2177 * @params: Parameters to configure ACL
2178 * Returns: 0 on success, -1 on failure
2180 * This is used only for the drivers which support MAC address ACL.
2182 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2185 * hapd_init - Initialize driver interface (hostapd only)
2186 * @hapd: Pointer to hostapd context
2187 * @params: Configuration for the driver wrapper
2188 * Returns: Pointer to private data, %NULL on failure
2190 * This function is used instead of init() or init2() when the driver
2191 * wrapper is used with hostapd.
2193 void * (*hapd_init)(struct hostapd_data *hapd,
2194 struct wpa_init_params *params);
2197 * hapd_deinit - Deinitialize driver interface (hostapd only)
2198 * @priv: Private driver interface data from hapd_init()
2200 void (*hapd_deinit)(void *priv);
2203 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2204 * @priv: Private driver interface data
2205 * @params: BSS parameters
2206 * Returns: 0 on success, -1 on failure
2208 * This is an optional function to configure the kernel driver to
2209 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2210 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2211 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2212 * for Beacon frames.
2214 * DEPRECATED - use set_ap() instead
2216 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2219 * set_privacy - Enable/disable privacy (AP only)
2220 * @priv: Private driver interface data
2221 * @enabled: 1 = privacy enabled, 0 = disabled
2222 * Returns: 0 on success, -1 on failure
2224 * This is an optional function to configure privacy field in the
2225 * kernel driver for Beacon frames. This can be left undefined (set to
2226 * %NULL) if the driver uses the Beacon template from set_ap().
2228 * DEPRECATED - use set_ap() instead
2230 int (*set_privacy)(void *priv, int enabled);
2233 * get_seqnum - Fetch the current TSC/packet number (AP only)
2234 * @ifname: The interface name (main or virtual)
2235 * @priv: Private driver interface data
2236 * @addr: MAC address of the station or %NULL for group keys
2238 * @seq: Buffer for returning the latest used TSC/packet number
2239 * Returns: 0 on success, -1 on failure
2241 * This function is used to fetch the last used TSC/packet number for
2242 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2243 * keys, so there is no strict requirement on implementing support for
2244 * unicast keys (i.e., addr != %NULL).
2246 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2250 * flush - Flush all association stations (AP only)
2251 * @priv: Private driver interface data
2252 * Returns: 0 on success, -1 on failure
2254 * This function requests the driver to disassociate all associated
2255 * stations. This function does not need to be implemented if the
2256 * driver does not process association frames internally.
2258 int (*flush)(void *priv);
2261 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2262 * @priv: Private driver interface data
2263 * @elem: Information elements
2264 * @elem_len: Length of the elem buffer in octets
2265 * Returns: 0 on success, -1 on failure
2267 * This is an optional function to add information elements in the
2268 * kernel driver for Beacon and Probe Response frames. This can be left
2269 * undefined (set to %NULL) if the driver uses the Beacon template from
2272 * DEPRECATED - use set_ap() instead
2274 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2277 * read_sta_data - Fetch station data
2278 * @priv: Private driver interface data
2279 * @data: Buffer for returning station information
2280 * @addr: MAC address of the station
2281 * Returns: 0 on success, -1 on failure
2283 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2287 * hapd_send_eapol - Send an EAPOL packet (AP only)
2288 * @priv: private driver interface data
2289 * @addr: Destination MAC address
2290 * @data: EAPOL packet starting with IEEE 802.1X header
2291 * @data_len: Length of the EAPOL packet in octets
2292 * @encrypt: Whether the frame should be encrypted
2293 * @own_addr: Source MAC address
2294 * @flags: WPA_STA_* flags for the destination station
2296 * Returns: 0 on success, -1 on failure
2298 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2299 size_t data_len, int encrypt,
2300 const u8 *own_addr, u32 flags);
2303 * sta_deauth - Deauthenticate a station (AP only)
2304 * @priv: Private driver interface data
2305 * @own_addr: Source address and BSSID for the Deauthentication frame
2306 * @addr: MAC address of the station to deauthenticate
2307 * @reason: Reason code for the Deauthentiation frame
2308 * Returns: 0 on success, -1 on failure
2310 * This function requests a specific station to be deauthenticated and
2311 * a Deauthentication frame to be sent to it.
2313 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2317 * sta_disassoc - Disassociate a station (AP only)
2318 * @priv: Private driver interface data
2319 * @own_addr: Source address and BSSID for the Disassociation frame
2320 * @addr: MAC address of the station to disassociate
2321 * @reason: Reason code for the Disassociation frame
2322 * Returns: 0 on success, -1 on failure
2324 * This function requests a specific station to be disassociated and
2325 * a Disassociation frame to be sent to it.
2327 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2331 * sta_remove - Remove a station entry (AP only)
2332 * @priv: Private driver interface data
2333 * @addr: MAC address of the station to be removed
2334 * Returns: 0 on success, -1 on failure
2336 int (*sta_remove)(void *priv, const u8 *addr);
2339 * hapd_get_ssid - Get the current SSID (AP only)
2340 * @priv: Private driver interface data
2341 * @buf: Buffer for returning the SSID
2342 * @len: Maximum length of the buffer
2343 * Returns: Length of the SSID on success, -1 on failure
2345 * This function need not be implemented if the driver uses Beacon
2346 * template from set_ap() and does not reply to Probe Request frames.
2348 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2351 * hapd_set_ssid - Set SSID (AP only)
2352 * @priv: Private driver interface data
2354 * @len: Length of the SSID in octets
2355 * Returns: 0 on success, -1 on failure
2357 * DEPRECATED - use set_ap() instead
2359 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2362 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2363 * @priv: Private driver interface data
2364 * @enabled: 1 = countermeasures enabled, 0 = disabled
2365 * Returns: 0 on success, -1 on failure
2367 * This need not be implemented if the driver does not take care of
2368 * association processing.
2370 int (*hapd_set_countermeasures)(void *priv, int enabled);
2373 * sta_add - Add a station entry
2374 * @priv: Private driver interface data
2375 * @params: Station parameters
2376 * Returns: 0 on success, -1 on failure
2378 * This function is used to add or set (params->set 1) a station
2379 * entry in the driver. Adding STA entries is used only if the driver
2380 * does not take care of association processing.
2382 * With drivers that don't support full AP client state, this function
2383 * is used to add a station entry to the driver once the station has
2384 * completed association.
2386 * With TDLS, this function is used to add or set (params->set 1)
2387 * TDLS peer entries (even with drivers that do not support full AP
2390 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2393 * get_inact_sec - Get station inactivity duration (AP only)
2394 * @priv: Private driver interface data
2395 * @addr: Station address
2396 * Returns: Number of seconds station has been inactive, -1 on failure
2398 int (*get_inact_sec)(void *priv, const u8 *addr);
2401 * sta_clear_stats - Clear station statistics (AP only)
2402 * @priv: Private driver interface data
2403 * @addr: Station address
2404 * Returns: 0 on success, -1 on failure
2406 int (*sta_clear_stats)(void *priv, const u8 *addr);
2409 * set_freq - Set channel/frequency (AP only)
2410 * @priv: Private driver interface data
2411 * @freq: Channel parameters
2412 * Returns: 0 on success, -1 on failure
2414 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2417 * set_rts - Set RTS threshold
2418 * @priv: Private driver interface data
2419 * @rts: RTS threshold in octets
2420 * Returns: 0 on success, -1 on failure
2422 int (*set_rts)(void *priv, int rts);
2425 * set_frag - Set fragmentation threshold
2426 * @priv: Private driver interface data
2427 * @frag: Fragmentation threshold in octets
2428 * Returns: 0 on success, -1 on failure
2430 int (*set_frag)(void *priv, int frag);
2433 * sta_set_flags - Set station flags (AP only)
2434 * @priv: Private driver interface data
2435 * @addr: Station address
2436 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2437 * @flags_or: Bitmap of WPA_STA_* flags to add
2438 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2439 * Returns: 0 on success, -1 on failure
2441 int (*sta_set_flags)(void *priv, const u8 *addr,
2442 unsigned int total_flags, unsigned int flags_or,
2443 unsigned int flags_and);
2446 * set_tx_queue_params - Set TX queue parameters
2447 * @priv: Private driver interface data
2448 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2452 * @burst_time: Maximum length for bursting in 0.1 msec units
2454 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2455 int cw_max, int burst_time);
2458 * if_add - Add a virtual interface
2459 * @priv: Private driver interface data
2460 * @type: Interface type
2461 * @ifname: Interface name for the new virtual interface
2462 * @addr: Local address to use for the interface or %NULL to use the
2463 * parent interface address
2464 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2465 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2466 * not allowed (applies only to %WPA_IF_AP_BSS type)
2467 * @force_ifname: Buffer for returning an interface name that the
2468 * driver ended up using if it differs from the requested ifname
2469 * @if_addr: Buffer for returning the allocated interface address
2470 * (this may differ from the requested addr if the driver cannot
2471 * change interface address)
2472 * @bridge: Bridge interface to use or %NULL if no bridge configured
2473 * @use_existing: Whether to allow existing interface to be used
2474 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
2475 * Returns: 0 on success, -1 on failure
2477 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2478 const char *ifname, const u8 *addr, void *bss_ctx,
2479 void **drv_priv, char *force_ifname, u8 *if_addr,
2480 const char *bridge, int use_existing, int setup_ap);
2483 * if_remove - Remove a virtual interface
2484 * @priv: Private driver interface data
2485 * @type: Interface type
2486 * @ifname: Interface name of the virtual interface to be removed
2487 * Returns: 0 on success, -1 on failure
2489 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2490 const char *ifname);
2493 * set_sta_vlan - Bind a station into a specific interface (AP only)
2494 * @priv: Private driver interface data
2495 * @ifname: Interface (main or virtual BSS or VLAN)
2496 * @addr: MAC address of the associated station
2498 * Returns: 0 on success, -1 on failure
2500 * This function is used to bind a station to a specific virtual
2501 * interface. It is only used if when virtual interfaces are supported,
2502 * e.g., to assign stations to different VLAN interfaces based on
2503 * information from a RADIUS server. This allows separate broadcast
2504 * domains to be used with a single BSS.
2506 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2510 * commit - Optional commit changes handler (AP only)
2511 * @priv: driver private data
2512 * Returns: 0 on success, -1 on failure
2514 * This optional handler function can be registered if the driver
2515 * interface implementation needs to commit changes (e.g., by setting
2516 * network interface up) at the end of initial configuration. If set,
2517 * this handler will be called after initial setup has been completed.
2519 int (*commit)(void *priv);
2522 * send_ether - Send an ethernet packet (AP only)
2523 * @priv: private driver interface data
2524 * @dst: Destination MAC address
2525 * @src: Source MAC address
2527 * @data: EAPOL packet starting with IEEE 802.1X header
2528 * @data_len: Length of the EAPOL packet in octets
2529 * Returns: 0 on success, -1 on failure
2531 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2532 const u8 *data, size_t data_len);
2535 * set_radius_acl_auth - Notification of RADIUS ACL change
2536 * @priv: Private driver interface data
2537 * @mac: MAC address of the station
2538 * @accepted: Whether the station was accepted
2539 * @session_timeout: Session timeout for the station
2540 * Returns: 0 on success, -1 on failure
2542 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2543 u32 session_timeout);
2546 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2547 * @priv: Private driver interface data
2548 * @mac: MAC address of the station
2549 * Returns: 0 on success, -1 on failure
2551 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2554 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2555 * @priv: Private driver interface data
2556 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2557 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2559 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2560 * to remove extra IE(s)
2561 * Returns: 0 on success, -1 on failure
2563 * This is an optional function to add WPS IE in the kernel driver for
2564 * Beacon and Probe Response frames. This can be left undefined (set
2565 * to %NULL) if the driver uses the Beacon template from set_ap()
2566 * and does not process Probe Request frames. If the driver takes care
2567 * of (Re)Association frame processing, the assocresp buffer includes
2568 * WPS IE(s) that need to be added to (Re)Association Response frames
2569 * whenever a (Re)Association Request frame indicated use of WPS.
2571 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2572 * frames when operating as a GO. The driver is responsible for adding
2573 * timing related attributes (e.g., NoA) in addition to the IEs
2574 * included here by appending them after these buffers. This call is
2575 * also used to provide Probe Response IEs for P2P Listen state
2576 * operations for drivers that generate the Probe Response frames
2579 * DEPRECATED - use set_ap() instead
2581 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2582 const struct wpabuf *proberesp,
2583 const struct wpabuf *assocresp);
2586 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2587 * @priv: Private driver interface data
2588 * @authorized: Whether the port is authorized
2589 * Returns: 0 on success, -1 on failure
2591 int (*set_supp_port)(void *priv, int authorized);
2594 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2595 * @priv: Private driver interface data
2596 * @addr: MAC address of the associated station
2597 * @aid: Association ID
2598 * @val: 1 = bind to 4-address WDS; 0 = unbind
2599 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2600 * to indicate that bridge is not to be used
2601 * @ifname_wds: Buffer to return the interface name for the new WDS
2602 * station or %NULL to indicate name is not returned.
2603 * Returns: 0 on success, -1 on failure
2605 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2606 const char *bridge_ifname, char *ifname_wds);
2609 * send_action - Transmit an Action frame
2610 * @priv: Private driver interface data
2611 * @freq: Frequency (in MHz) of the channel
2612 * @wait: Time to wait off-channel for a response (in ms), or zero
2613 * @dst: Destination MAC address (Address 1)
2614 * @src: Source MAC address (Address 2)
2615 * @bssid: BSSID (Address 3)
2617 * @data_len: data length in octets
2618 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2619 * Returns: 0 on success, -1 on failure
2621 * This command can be used to request the driver to transmit an action
2622 * frame to the specified destination.
2624 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2625 * be transmitted on the given channel and the device will wait for a
2626 * response on that channel for the given wait time.
2628 * If the flag is not set, the wait time will be ignored. In this case,
2629 * if a remain-on-channel duration is in progress, the frame must be
2630 * transmitted on that channel; alternatively the frame may be sent on
2631 * the current operational channel (if in associated state in station
2632 * mode or while operating as an AP.)
2634 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2635 const u8 *dst, const u8 *src, const u8 *bssid,
2636 const u8 *data, size_t data_len, int no_cck);
2639 * send_action_cancel_wait - Cancel action frame TX wait
2640 * @priv: Private driver interface data
2642 * This command cancels the wait time associated with sending an action
2643 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2644 * set in the driver flags.
2646 void (*send_action_cancel_wait)(void *priv);
2649 * remain_on_channel - Remain awake on a channel
2650 * @priv: Private driver interface data
2651 * @freq: Frequency (in MHz) of the channel
2652 * @duration: Duration in milliseconds
2653 * Returns: 0 on success, -1 on failure
2655 * This command is used to request the driver to remain awake on the
2656 * specified channel for the specified duration and report received
2657 * Action frames with EVENT_RX_MGMT events. Optionally, received
2658 * Probe Request frames may also be requested to be reported by calling
2659 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2661 * The driver may not be at the requested channel when this function
2662 * returns, i.e., the return code is only indicating whether the
2663 * request was accepted. The caller will need to wait until the
2664 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2665 * completed the channel change. This may take some time due to other
2666 * need for the radio and the caller should be prepared to timing out
2667 * its wait since there are no guarantees on when this request can be
2670 int (*remain_on_channel)(void *priv, unsigned int freq,
2671 unsigned int duration);
2674 * cancel_remain_on_channel - Cancel remain-on-channel operation
2675 * @priv: Private driver interface data
2677 * This command can be used to cancel a remain-on-channel operation
2678 * before its originally requested duration has passed. This could be
2679 * used, e.g., when remain_on_channel() is used to request extra time
2680 * to receive a response to an Action frame and the response is
2681 * received when there is still unneeded time remaining on the
2682 * remain-on-channel operation.
2684 int (*cancel_remain_on_channel)(void *priv);
2687 * probe_req_report - Request Probe Request frames to be indicated
2688 * @priv: Private driver interface data
2689 * @report: Whether to report received Probe Request frames
2690 * Returns: 0 on success, -1 on failure (or if not supported)
2692 * This command can be used to request the driver to indicate when
2693 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2694 * Since this operation may require extra resources, e.g., due to less
2695 * optimal hardware/firmware RX filtering, many drivers may disable
2696 * Probe Request reporting at least in station mode. This command is
2697 * used to notify the driver when the Probe Request frames need to be
2698 * reported, e.g., during remain-on-channel operations.
2700 int (*probe_req_report)(void *priv, int report);
2703 * deinit_ap - Deinitialize AP mode
2704 * @priv: Private driver interface data
2705 * Returns: 0 on success, -1 on failure (or if not supported)
2707 * This optional function can be used to disable AP mode related
2708 * configuration. If the interface was not dynamically added,
2709 * change the driver mode to station mode to allow normal station
2710 * operations like scanning to be completed.
2712 int (*deinit_ap)(void *priv);
2715 * deinit_p2p_cli - Deinitialize P2P client mode
2716 * @priv: Private driver interface data
2717 * Returns: 0 on success, -1 on failure (or if not supported)
2719 * This optional function can be used to disable P2P client mode. If the
2720 * interface was not dynamically added, change the interface type back
2723 int (*deinit_p2p_cli)(void *priv);
2726 * suspend - Notification on system suspend/hibernate event
2727 * @priv: Private driver interface data
2729 void (*suspend)(void *priv);
2732 * resume - Notification on system resume/thaw event
2733 * @priv: Private driver interface data
2735 void (*resume)(void *priv);
2738 * signal_monitor - Set signal monitoring parameters
2739 * @priv: Private driver interface data
2740 * @threshold: Threshold value for signal change events; 0 = disabled
2741 * @hysteresis: Minimum change in signal strength before indicating a
2743 * Returns: 0 on success, -1 on failure (or if not supported)
2745 * This function can be used to configure monitoring of signal strength
2746 * with the current AP. Whenever signal strength drops below the
2747 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2748 * should be generated assuming the signal strength has changed at
2749 * least %hysteresis from the previously indicated signal change event.
2751 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2754 * send_frame - Send IEEE 802.11 frame (testing use only)
2755 * @priv: Private driver interface data
2756 * @data: IEEE 802.11 frame with IEEE 802.11 header
2757 * @data_len: Size of the frame
2758 * @encrypt: Whether to encrypt the frame (if keys are set)
2759 * Returns: 0 on success, -1 on failure
2761 * This function is only used for debugging purposes and is not
2762 * required to be implemented for normal operations.
2764 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2768 * get_noa - Get current Notice of Absence attribute payload
2769 * @priv: Private driver interface data
2770 * @buf: Buffer for returning NoA
2771 * @buf_len: Buffer length in octets
2772 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2773 * advertized, or -1 on failure
2775 * This function is used to fetch the current Notice of Absence
2776 * attribute value from GO.
2778 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2781 * set_noa - Set Notice of Absence parameters for GO (testing)
2782 * @priv: Private driver interface data
2784 * @start: Start time in ms from next TBTT
2785 * @duration: Duration in ms
2786 * Returns: 0 on success or -1 on failure
2788 * This function is used to set Notice of Absence parameters for GO. It
2789 * is used only for testing. To disable NoA, all parameters are set to
2792 int (*set_noa)(void *priv, u8 count, int start, int duration);
2795 * set_p2p_powersave - Set P2P power save options
2796 * @priv: Private driver interface data
2797 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2798 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2799 * @ctwindow: 0.. = change (msec), -1 = no change
2800 * Returns: 0 on success or -1 on failure
2802 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2806 * ampdu - Enable/disable aggregation
2807 * @priv: Private driver interface data
2808 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2809 * Returns: 0 on success or -1 on failure
2811 int (*ampdu)(void *priv, int ampdu);
2814 * get_radio_name - Get physical radio name for the device
2815 * @priv: Private driver interface data
2816 * Returns: Radio name or %NULL if not known
2818 * The returned data must not be modified by the caller. It is assumed
2819 * that any interface that has the same radio name as another is
2820 * sharing the same physical radio. This information can be used to
2821 * share scan results etc. information between the virtual interfaces
2822 * to speed up various operations.
2824 const char * (*get_radio_name)(void *priv);
2827 * send_tdls_mgmt - for sending TDLS management packets
2828 * @priv: private driver interface data
2829 * @dst: Destination (peer) MAC address
2830 * @action_code: TDLS action code for the mssage
2831 * @dialog_token: Dialog Token to use in the message (if needed)
2832 * @status_code: Status Code or Reason Code to use (if needed)
2833 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2834 * @initiator: Is the current end the TDLS link initiator
2835 * @buf: TDLS IEs to add to the message
2836 * @len: Length of buf in octets
2837 * Returns: 0 on success, negative (<0) on failure
2839 * This optional function can be used to send packet to driver which is
2840 * responsible for receiving and sending all TDLS packets.
2842 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2843 u8 dialog_token, u16 status_code, u32 peer_capab,
2844 int initiator, const u8 *buf, size_t len);
2847 * tdls_oper - Ask the driver to perform high-level TDLS operations
2848 * @priv: Private driver interface data
2849 * @oper: TDLS high-level operation. See %enum tdls_oper
2850 * @peer: Destination (peer) MAC address
2851 * Returns: 0 on success, negative (<0) on failure
2853 * This optional function can be used to send high-level TDLS commands
2856 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2859 * wnm_oper - Notify driver of the WNM frame reception
2860 * @priv: Private driver interface data
2861 * @oper: WNM operation. See %enum wnm_oper
2862 * @peer: Destination (peer) MAC address
2863 * @buf: Buffer for the driver to fill in (for getting IE)
2864 * @buf_len: Return the len of buf
2865 * Returns: 0 on success, negative (<0) on failure
2867 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2868 u8 *buf, u16 *buf_len);
2871 * set_qos_map - Set QoS Map
2872 * @priv: Private driver interface data
2873 * @qos_map_set: QoS Map
2874 * @qos_map_set_len: Length of QoS Map
2876 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2877 u8 qos_map_set_len);
2880 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2881 * @priv: Private driver interface data
2882 * @version: IP version of the IP address, 4 or 6
2883 * @ipaddr: IP address for the neigh entry
2884 * @prefixlen: IP address prefix length
2885 * @addr: Corresponding MAC address
2886 * Returns: 0 on success, negative (<0) on failure
2888 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2889 int prefixlen, const u8 *addr);
2892 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2893 * @priv: Private driver interface data
2894 * @version: IP version of the IP address, 4 or 6
2895 * @ipaddr: IP address for the neigh entry
2896 * Returns: 0 on success, negative (<0) on failure
2898 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2901 * br_port_set_attr - Set a bridge port attribute
2902 * @attr: Bridge port attribute to set
2903 * @val: Value to be set
2904 * Returns: 0 on success, negative (<0) on failure
2906 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2910 * br_port_set_attr - Set a bridge network parameter
2911 * @param: Bridge parameter to set
2912 * @val: Value to be set
2913 * Returns: 0 on success, negative (<0) on failure
2915 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2919 * set_wowlan - Set wake-on-wireless triggers
2920 * @priv: Private driver interface data
2921 * @triggers: wowlan triggers
2923 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2926 * signal_poll - Get current connection information
2927 * @priv: Private driver interface data
2928 * @signal_info: Connection info structure
2930 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2933 * set_authmode - Set authentication algorithm(s) for static WEP
2934 * @priv: Private driver interface data
2935 * @authmode: 1=Open System, 2=Shared Key, 3=both
2936 * Returns: 0 on success, -1 on failure
2938 * This function can be used to set authentication algorithms for AP
2939 * mode when static WEP is used. If the driver uses user space MLME/SME
2940 * implementation, there is no need to implement this function.
2942 * DEPRECATED - use set_ap() instead
2944 int (*set_authmode)(void *priv, int authmode);
2948 * driver_cmd - Execute driver-specific command
2949 * @priv: Private driver interface data
2950 * @cmd: Command to execute
2951 * @buf: Return buffer
2952 * @buf_len: Buffer length
2953 * Returns: 0 on success, -1 on failure
2955 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2956 #endif /* ANDROID */
2959 * vendor_cmd - Execute vendor specific command
2960 * @priv: Private driver interface data
2961 * @vendor_id: Vendor id
2962 * @subcmd: Vendor command id
2963 * @data: Vendor command parameters (%NULL if no parameters)
2964 * @data_len: Data length
2965 * @buf: Return buffer (%NULL to ignore reply)
2966 * Returns: 0 on success, negative (<0) on failure
2968 * This function handles vendor specific commands that are passed to
2969 * the driver/device. The command is identified by vendor id and
2970 * command id. Parameters can be passed as argument to the command
2971 * in the data buffer. Reply (if any) will be filled in the supplied
2974 * The exact driver behavior is driver interface and vendor specific. As
2975 * an example, this will be converted to a vendor specific cfg80211
2976 * command in case of the nl80211 driver interface.
2978 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2979 unsigned int subcmd, const u8 *data, size_t data_len,
2980 struct wpabuf *buf);
2983 * set_rekey_info - Set rekey information
2984 * @priv: Private driver interface data
2986 * @kek_len: KEK length in octets
2988 * @kck_len: KCK length in octets
2989 * @replay_ctr: Current EAPOL-Key Replay Counter
2991 * This optional function can be used to provide information for the
2992 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2993 * while the host (including wpa_supplicant) is sleeping.
2995 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
2996 const u8 *kck, size_t kck_len,
2997 const u8 *replay_ctr);
3000 * sta_assoc - Station association indication
3001 * @priv: Private driver interface data
3002 * @own_addr: Source address and BSSID for association frame
3003 * @addr: MAC address of the station to associate
3004 * @reassoc: flag to indicate re-association
3005 * @status: association response status code
3006 * @ie: assoc response ie buffer
3007 * @len: ie buffer length
3008 * Returns: 0 on success, -1 on failure
3010 * This function indicates the driver to send (Re)Association
3011 * Response frame to the station.
3013 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3014 int reassoc, u16 status, const u8 *ie, size_t len);
3017 * sta_auth - Station authentication indication
3018 * @priv: Private driver interface data
3019 * @own_addr: Source address and BSSID for authentication frame
3020 * @addr: MAC address of the station to associate
3021 * @seq: authentication sequence number
3022 * @status: authentication response status code
3023 * @ie: authentication frame ie buffer
3024 * @len: ie buffer length
3026 * This function indicates the driver to send Authentication frame
3029 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
3030 u16 seq, u16 status, const u8 *ie, size_t len);
3033 * add_tspec - Add traffic stream
3034 * @priv: Private driver interface data
3035 * @addr: MAC address of the station to associate
3036 * @tspec_ie: tspec ie buffer
3037 * @tspec_ielen: tspec ie length
3038 * Returns: 0 on success, -1 on failure
3040 * This function adds the traffic steam for the station
3041 * and fills the medium_time in tspec_ie.
3043 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3044 size_t tspec_ielen);
3047 * add_sta_node - Add a station node in the driver
3048 * @priv: Private driver interface data
3049 * @addr: MAC address of the station to add
3050 * @auth_alg: authentication algorithm used by the station
3051 * Returns: 0 on success, -1 on failure
3053 * This function adds the station node in the driver, when
3054 * the station gets added by FT-over-DS.
3056 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
3059 * sched_scan - Request the driver to initiate scheduled scan
3060 * @priv: Private driver interface data
3061 * @params: Scan parameters
3062 * Returns: 0 on success, -1 on failure
3064 * This operation should be used for scheduled scan offload to
3065 * the hardware. Every time scan results are available, the
3066 * driver should report scan results event for wpa_supplicant
3067 * which will eventually request the results with
3068 * wpa_driver_get_scan_results2(). This operation is optional
3069 * and if not provided or if it returns -1, we fall back to
3070 * normal host-scheduled scans.
3072 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
3075 * stop_sched_scan - Request the driver to stop a scheduled scan
3076 * @priv: Private driver interface data
3077 * Returns: 0 on success, -1 on failure
3079 * This should cause the scheduled scan to be stopped and
3080 * results should stop being sent. Must be supported if
3081 * sched_scan is supported.
3083 int (*stop_sched_scan)(void *priv);
3086 * poll_client - Probe (null data or such) the given station
3087 * @priv: Private driver interface data
3088 * @own_addr: MAC address of sending interface
3089 * @addr: MAC address of the station to probe
3090 * @qos: Indicates whether station is QoS station
3092 * This function is used to verify whether an associated station is
3093 * still present. This function does not need to be implemented if the
3094 * driver provides such inactivity polling mechanism.
3096 void (*poll_client)(void *priv, const u8 *own_addr,
3097 const u8 *addr, int qos);
3100 * radio_disable - Disable/enable radio
3101 * @priv: Private driver interface data
3102 * @disabled: 1=disable 0=enable radio
3103 * Returns: 0 on success, -1 on failure
3105 * This optional command is for testing purposes. It can be used to
3106 * disable the radio on a testbed device to simulate out-of-radio-range
3109 int (*radio_disable)(void *priv, int disabled);
3112 * switch_channel - Announce channel switch and migrate the GO to the
3114 * @priv: Private driver interface data
3115 * @settings: Settings for CSA period and new channel
3116 * Returns: 0 on success, -1 on failure
3118 * This function is used to move the GO to the legacy STA channel to
3119 * avoid frequency conflict in single channel concurrency.
3121 int (*switch_channel)(void *priv, struct csa_settings *settings);
3124 * add_tx_ts - Add traffic stream
3125 * @priv: Private driver interface data
3126 * @tsid: Traffic stream ID
3127 * @addr: Receiver address
3128 * @user_prio: User priority of the traffic stream
3129 * @admitted_time: Admitted time for this TS in units of
3130 * 32 microsecond periods (per second).
3131 * Returns: 0 on success, -1 on failure
3133 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3137 * del_tx_ts - Delete traffic stream
3138 * @priv: Private driver interface data
3139 * @tsid: Traffic stream ID
3140 * @addr: Receiver address
3141 * Returns: 0 on success, -1 on failure
3143 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3146 * Enable channel-switching with TDLS peer
3147 * @priv: Private driver interface data
3148 * @addr: MAC address of the TDLS peer
3149 * @oper_class: Operating class of the switch channel
3150 * @params: Channel specification
3151 * Returns: 0 on success, -1 on failure
3153 * The function indicates to driver that it can start switching to a
3154 * different channel with a specified TDLS peer. The switching is
3155 * assumed on until canceled with tdls_disable_channel_switch().
3157 int (*tdls_enable_channel_switch)(
3158 void *priv, const u8 *addr, u8 oper_class,
3159 const struct hostapd_freq_params *params);
3162 * Disable channel switching with TDLS peer
3163 * @priv: Private driver interface data
3164 * @addr: MAC address of the TDLS peer
3165 * Returns: 0 on success, -1 on failure
3167 * This function indicates to the driver that it should stop switching
3168 * with a given TDLS peer.
3170 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3173 * start_dfs_cac - Listen for radar interference on the channel
3174 * @priv: Private driver interface data
3175 * @freq: Channel parameters
3176 * Returns: 0 on success, -1 on failure
3178 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
3181 * stop_ap - Removes beacon from AP
3182 * @priv: Private driver interface data
3183 * Returns: 0 on success, -1 on failure (or if not supported)
3185 * This optional function can be used to disable AP mode related
3186 * configuration. Unlike deinit_ap, it does not change to station
3189 int (*stop_ap)(void *priv);
3192 * get_survey - Retrieve survey data
3193 * @priv: Private driver interface data
3194 * @freq: If set, survey data for the specified frequency is only
3195 * being requested. If not set, all survey data is requested.
3196 * Returns: 0 on success, -1 on failure
3198 * Use this to retrieve:
3200 * - the observed channel noise floor
3201 * - the amount of time we have spent on the channel
3202 * - the amount of time during which we have spent on the channel that
3203 * the radio has determined the medium is busy and we cannot
3205 * - the amount of time we have spent receiving data
3206 * - the amount of time we have spent transmitting data
3208 * This data can be used for spectrum heuristics. One example is
3209 * Automatic Channel Selection (ACS). The channel survey data is
3210 * kept on a linked list on the channel data, one entry is added
3211 * for each survey. The min_nf of the channel is updated for each
3214 int (*get_survey)(void *priv, unsigned int freq);
3217 * status - Get driver interface status information
3218 * @priv: Private driver interface data
3219 * @buf: Buffer for printing tou the status information
3220 * @buflen: Maximum length of the buffer
3221 * Returns: Length of written status information or -1 on failure
3223 int (*status)(void *priv, char *buf, size_t buflen);
3226 * roaming - Set roaming policy for driver-based BSS selection
3227 * @priv: Private driver interface data
3228 * @allowed: Whether roaming within ESS is allowed
3229 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3230 * Returns: Length of written status information or -1 on failure
3232 * This optional callback can be used to update roaming policy from the
3233 * associate() command (bssid being set there indicates that the driver
3234 * should not roam before getting this roaming() call to allow roaming.
3235 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3236 * capability, roaming policy is handled within wpa_supplicant and there
3237 * is no need to implement or react to this callback.
3239 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3242 * set_mac_addr - Set MAC address
3243 * @priv: Private driver interface data
3244 * @addr: MAC address to use or %NULL for setting back to permanent
3245 * Returns: 0 on success, -1 on failure
3247 int (*set_mac_addr)(void *priv, const u8 *addr);
3249 #ifdef CONFIG_MACSEC
3250 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3252 int (*macsec_deinit)(void *priv);
3255 * enable_protect_frames - Set protect frames status
3256 * @priv: Private driver interface data
3257 * @enabled: TRUE = protect frames enabled
3258 * FALSE = protect frames disabled
3259 * Returns: 0 on success, -1 on failure (or if not supported)
3261 int (*enable_protect_frames)(void *priv, Boolean enabled);
3264 * set_replay_protect - Set replay protect status and window size
3265 * @priv: Private driver interface data
3266 * @enabled: TRUE = replay protect enabled
3267 * FALSE = replay protect disabled
3268 * @window: replay window size, valid only when replay protect enabled
3269 * Returns: 0 on success, -1 on failure (or if not supported)
3271 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3274 * set_current_cipher_suite - Set current cipher suite
3275 * @priv: Private driver interface data
3276 * @cs: EUI64 identifier
3277 * @cs_len: Length of the cs buffer in octets
3278 * Returns: 0 on success, -1 on failure (or if not supported)
3280 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3284 * enable_controlled_port - Set controlled port status
3285 * @priv: Private driver interface data
3286 * @enabled: TRUE = controlled port enabled
3287 * FALSE = controlled port disabled
3288 * Returns: 0 on success, -1 on failure (or if not supported)
3290 int (*enable_controlled_port)(void *priv, Boolean enabled);
3293 * get_receive_lowest_pn - Get receive lowest pn
3294 * @priv: Private driver interface data
3295 * @channel: secure channel
3296 * @an: association number
3297 * @lowest_pn: lowest accept pn
3298 * Returns: 0 on success, -1 on failure (or if not supported)
3300 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3304 * get_transmit_next_pn - Get transmit next pn
3305 * @priv: Private driver interface data
3306 * @channel: secure channel
3307 * @an: association number
3309 * Returns: 0 on success, -1 on failure (or if not supported)
3311 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3315 * set_transmit_next_pn - Set transmit next pn
3316 * @priv: Private driver interface data
3317 * @channel: secure channel
3318 * @an: association number
3320 * Returns: 0 on success, -1 on failure (or if not supported)
3322 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3326 * get_available_receive_sc - get available receive channel
3327 * @priv: Private driver interface data
3328 * @channel: secure channel
3329 * Returns: 0 on success, -1 on failure (or if not supported)
3331 int (*get_available_receive_sc)(void *priv, u32 *channel);
3334 * create_receive_sc - create secure channel for receiving
3335 * @priv: Private driver interface data
3336 * @channel: secure channel
3337 * @sci_addr: secure channel identifier - address
3338 * @sci_port: secure channel identifier - port
3339 * @conf_offset: confidentiality offset (0, 30, or 50)
3340 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3342 * Returns: 0 on success, -1 on failure (or if not supported)
3344 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3345 u16 sci_port, unsigned int conf_offset,
3349 * delete_receive_sc - delete secure connection for receiving
3350 * @priv: private driver interface data from init()
3351 * @channel: secure channel
3352 * Returns: 0 on success, -1 on failure
3354 int (*delete_receive_sc)(void *priv, u32 channel);
3357 * create_receive_sa - create secure association for receive
3358 * @priv: private driver interface data from init()
3359 * @channel: secure channel
3360 * @an: association number
3361 * @lowest_pn: the lowest packet number can be received
3362 * @sak: the secure association key
3363 * Returns: 0 on success, -1 on failure
3365 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3366 u32 lowest_pn, const u8 *sak);
3369 * enable_receive_sa - enable the SA for receive
3370 * @priv: private driver interface data from init()
3371 * @channel: secure channel
3372 * @an: association number
3373 * Returns: 0 on success, -1 on failure
3375 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3378 * disable_receive_sa - disable SA for receive
3379 * @priv: private driver interface data from init()
3380 * @channel: secure channel index
3381 * @an: association number
3382 * Returns: 0 on success, -1 on failure
3384 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3387 * get_available_transmit_sc - get available transmit channel
3388 * @priv: Private driver interface data
3389 * @channel: secure channel
3390 * Returns: 0 on success, -1 on failure (or if not supported)
3392 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3395 * create_transmit_sc - create secure connection for transmit
3396 * @priv: private driver interface data from init()
3397 * @channel: secure channel
3398 * @sci_addr: secure channel identifier - address
3399 * @sci_port: secure channel identifier - port
3400 * Returns: 0 on success, -1 on failure
3402 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3403 u16 sci_port, unsigned int conf_offset);
3406 * delete_transmit_sc - delete secure connection for transmit
3407 * @priv: private driver interface data from init()
3408 * @channel: secure channel
3409 * Returns: 0 on success, -1 on failure
3411 int (*delete_transmit_sc)(void *priv, u32 channel);
3414 * create_transmit_sa - create secure association for transmit
3415 * @priv: private driver interface data from init()
3416 * @channel: secure channel index
3417 * @an: association number
3418 * @next_pn: the packet number used as next transmit packet
3419 * @confidentiality: True if the SA is to provide confidentiality
3420 * as well as integrity
3421 * @sak: the secure association key
3422 * Returns: 0 on success, -1 on failure
3424 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3425 Boolean confidentiality, const u8 *sak);
3428 * enable_transmit_sa - enable SA for transmit
3429 * @priv: private driver interface data from init()
3430 * @channel: secure channel
3431 * @an: association number
3432 * Returns: 0 on success, -1 on failure
3434 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3437 * disable_transmit_sa - disable SA for transmit
3438 * @priv: private driver interface data from init()
3439 * @channel: secure channel
3440 * @an: association number
3441 * Returns: 0 on success, -1 on failure
3443 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3444 #endif /* CONFIG_MACSEC */
3447 * init_mesh - Driver specific initialization for mesh
3448 * @priv: Private driver interface data
3449 * Returns: 0 on success, -1 on failure
3451 int (*init_mesh)(void *priv);
3454 * join_mesh - Join a mesh network
3455 * @priv: Private driver interface data
3456 * @params: Mesh configuration parameters
3457 * Returns: 0 on success, -1 on failure
3459 int (*join_mesh)(void *priv,
3460 struct wpa_driver_mesh_join_params *params);
3463 * leave_mesh - Leave a mesh network
3464 * @priv: Private driver interface data
3465 * Returns 0 on success, -1 on failure
3467 int (*leave_mesh)(void *priv);
3470 * do_acs - Automatically select channel
3471 * @priv: Private driver interface data
3472 * @params: Parameters for ACS
3473 * Returns 0 on success, -1 on failure
3475 * This command can be used to offload ACS to the driver if the driver
3476 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3478 int (*do_acs)(void *priv, struct drv_acs_params *params);
3481 * set_band - Notify driver of band selection
3482 * @priv: Private driver interface data
3483 * @band: The selected band(s)
3484 * Returns 0 on success, -1 on failure
3486 int (*set_band)(void *priv, enum set_band band);
3489 * get_pref_freq_list - Get preferred frequency list for an interface
3490 * @priv: Private driver interface data
3491 * @if_type: Interface type
3492 * @num: Number of channels
3493 * @freq_list: Preferred channel frequency list encoded in MHz values
3494 * Returns 0 on success, -1 on failure
3496 * This command can be used to query the preferred frequency list from
3497 * the driver specific to a particular interface type.
3499 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
3500 unsigned int *num, unsigned int *freq_list);
3503 * set_prob_oper_freq - Indicate probable P2P operating channel
3504 * @priv: Private driver interface data
3505 * @freq: Channel frequency in MHz
3506 * Returns 0 on success, -1 on failure
3508 * This command can be used to inform the driver of the operating
3509 * frequency that an ongoing P2P group formation is likely to come up
3510 * on. Local device is assuming P2P Client role.
3512 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
3515 * abort_scan - Request the driver to abort an ongoing scan
3516 * @priv: Private driver interface data
3517 * Returns 0 on success, -1 on failure
3519 int (*abort_scan)(void *priv);
3524 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3526 enum wpa_event_type {
3528 * EVENT_ASSOC - Association completed
3530 * This event needs to be delivered when the driver completes IEEE
3531 * 802.11 association or reassociation successfully.
3532 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3533 * after this event has been generated. In addition, optional
3534 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3535 * more information about the association. If the driver interface gets
3536 * both of these events at the same time, it can also include the
3537 * assoc_info data in EVENT_ASSOC call.
3542 * EVENT_DISASSOC - Association lost
3544 * This event should be called when association is lost either due to
3545 * receiving deauthenticate or disassociate frame from the AP or when
3546 * sending either of these frames to the current AP. If the driver
3547 * supports separate deauthentication event, EVENT_DISASSOC should only
3548 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3549 * In AP mode, union wpa_event_data::disassoc_info is required.
3554 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3556 * This event must be delivered when a Michael MIC error is detected by
3557 * the local driver. Additional data for event processing is
3558 * provided with union wpa_event_data::michael_mic_failure. This
3559 * information is used to request new encyption key and to initiate
3560 * TKIP countermeasures if needed.
3562 EVENT_MICHAEL_MIC_FAILURE,
3565 * EVENT_SCAN_RESULTS - Scan results available
3567 * This event must be called whenever scan results are available to be
3568 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3569 * is expected to be used some time after struct wpa_driver_ops::scan()
3570 * is called. If the driver provides an unsolicited event when the scan
3571 * has been completed, this event can be used to trigger
3572 * EVENT_SCAN_RESULTS call. If such event is not available from the
3573 * driver, the driver wrapper code is expected to use a registered
3574 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3575 * scan is expected to be completed. Optional information about
3576 * completed scan can be provided with union wpa_event_data::scan_info.
3581 * EVENT_ASSOCINFO - Report optional extra information for association
3583 * This event can be used to report extra association information for
3584 * EVENT_ASSOC processing. This extra information includes IEs from
3585 * association frames and Beacon/Probe Response frames in union
3586 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3587 * EVENT_ASSOC. Alternatively, the driver interface can include
3588 * assoc_info data in the EVENT_ASSOC call if it has all the
3589 * information available at the same point.
3594 * EVENT_INTERFACE_STATUS - Report interface status changes
3596 * This optional event can be used to report changes in interface
3597 * status (interface added/removed) using union
3598 * wpa_event_data::interface_status. This can be used to trigger
3599 * wpa_supplicant to stop and re-start processing for the interface,
3600 * e.g., when a cardbus card is ejected/inserted.
3602 EVENT_INTERFACE_STATUS,
3605 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3607 * This event can be used to inform wpa_supplicant about candidates for
3608 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3609 * for scan request (ap_scan=2 mode), this event is required for
3610 * pre-authentication. If wpa_supplicant is performing scan request
3611 * (ap_scan=1), this event is optional since scan results can be used
3612 * to add pre-authentication candidates. union
3613 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3614 * candidate and priority of the candidate, e.g., based on the signal
3615 * strength, in order to try to pre-authenticate first with candidates
3616 * that are most likely targets for re-association.
3618 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3619 * on the candidate list. In addition, it can be called for the current
3620 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3621 * will automatically skip pre-authentication in cases where a valid
3622 * PMKSA exists. When more than one candidate exists, this event should
3623 * be generated once for each candidate.
3625 * Driver will be notified about successful pre-authentication with
3626 * struct wpa_driver_ops::add_pmkid() calls.
3628 EVENT_PMKID_CANDIDATE,
3631 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3633 * This event can be used to inform wpa_supplicant about desire to set
3634 * up secure direct link connection between two stations as defined in
3635 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3636 * STAKey negotiation. The caller will need to set peer address for the
3642 * EVENT_TDLS - Request TDLS operation
3644 * This event can be used to request a TDLS operation to be performed.
3649 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3651 * The driver is expected to report the received FT IEs from
3652 * FT authentication sequence from the AP. The FT IEs are included in
3653 * the extra information in union wpa_event_data::ft_ies.
3658 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3660 * The driver can use this event to inform wpa_supplicant about a STA
3661 * in an IBSS with which protected frames could be exchanged. This
3662 * event starts RSN authentication with the other STA to authenticate
3663 * the STA and set up encryption keys with it.
3665 EVENT_IBSS_RSN_START,
3668 * EVENT_AUTH - Authentication result
3670 * This event should be called when authentication attempt has been
3671 * completed. This is only used if the driver supports separate
3672 * authentication step (struct wpa_driver_ops::authenticate).
3673 * Information about authentication result is included in
3674 * union wpa_event_data::auth.
3679 * EVENT_DEAUTH - Authentication lost
3681 * This event should be called when authentication is lost either due
3682 * to receiving deauthenticate frame from the AP or when sending that
3683 * frame to the current AP.
3684 * In AP mode, union wpa_event_data::deauth_info is required.
3689 * EVENT_ASSOC_REJECT - Association rejected
3691 * This event should be called when (re)association attempt has been
3692 * rejected by the AP. Information about the association response is
3693 * included in union wpa_event_data::assoc_reject.
3698 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3700 EVENT_AUTH_TIMED_OUT,
3703 * EVENT_ASSOC_TIMED_OUT - Association timed out
3705 EVENT_ASSOC_TIMED_OUT,
3708 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3710 EVENT_WPS_BUTTON_PUSHED,
3713 * EVENT_TX_STATUS - Report TX status
3718 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3720 EVENT_RX_FROM_UNKNOWN,
3723 * EVENT_RX_MGMT - Report RX of a management frame
3728 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3730 * This event is used to indicate when the driver has started the
3731 * requested remain-on-channel duration. Information about the
3732 * operation is included in union wpa_event_data::remain_on_channel.
3734 EVENT_REMAIN_ON_CHANNEL,
3737 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3739 * This event is used to indicate when the driver has completed
3740 * remain-on-channel duration, i.e., may noot be available on the
3741 * requested channel anymore. Information about the
3742 * operation is included in union wpa_event_data::remain_on_channel.
3744 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3747 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3749 * This event is used to indicate when a Probe Request frame has been
3750 * received. Information about the received frame is included in
3751 * union wpa_event_data::rx_probe_req. The driver is required to report
3752 * these events only after successfully completed probe_req_report()
3753 * commands to request the events (i.e., report parameter is non-zero)
3754 * in station mode. In AP mode, Probe Request frames should always be
3760 * EVENT_NEW_STA - New wired device noticed
3762 * This event is used to indicate that a new device has been detected
3763 * in a network that does not use association-like functionality (i.e.,
3764 * mainly wired Ethernet). This can be used to start EAPOL
3765 * authenticator when receiving a frame from a device. The address of
3766 * the device is included in union wpa_event_data::new_sta.
3771 * EVENT_EAPOL_RX - Report received EAPOL frame
3773 * When in AP mode with hostapd, this event is required to be used to
3774 * deliver the receive EAPOL frames from the driver.
3779 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3781 * This event is used to indicate changes in the signal strength
3782 * observed in frames received from the current AP if signal strength
3783 * monitoring has been enabled with signal_monitor().
3785 EVENT_SIGNAL_CHANGE,
3788 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3790 * This event is used to indicate that the interface was enabled after
3791 * having been previously disabled, e.g., due to rfkill.
3793 EVENT_INTERFACE_ENABLED,
3796 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3798 * This event is used to indicate that the interface was disabled,
3799 * e.g., due to rfkill.
3801 EVENT_INTERFACE_DISABLED,
3804 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3806 * This event is used to indicate that the channel list has changed,
3807 * e.g., because of a regulatory domain change triggered by scan
3808 * results including an AP advertising a country code.
3810 EVENT_CHANNEL_LIST_CHANGED,
3813 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3815 * This event is used to indicate that the driver cannot maintain this
3816 * interface in its operation mode anymore. The most likely use for
3817 * this is to indicate that AP mode operation is not available due to
3818 * operating channel would need to be changed to a DFS channel when
3819 * the driver does not support radar detection and another virtual
3820 * interfaces caused the operating channel to change. Other similar
3821 * resource conflicts could also trigger this for station mode
3822 * interfaces. This event can be propagated when channel switching
3825 EVENT_INTERFACE_UNAVAILABLE,
3828 * EVENT_BEST_CHANNEL
3830 * Driver generates this event whenever it detects a better channel
3831 * (e.g., based on RSSI or channel use). This information can be used
3832 * to improve channel selection for a new AP/P2P group.
3837 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3839 * This event should be called when a Deauthentication frame is dropped
3840 * due to it not being protected (MFP/IEEE 802.11w).
3841 * union wpa_event_data::unprot_deauth is required to provide more
3842 * details of the frame.
3844 EVENT_UNPROT_DEAUTH,
3847 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3849 * This event should be called when a Disassociation frame is dropped
3850 * due to it not being protected (MFP/IEEE 802.11w).
3851 * union wpa_event_data::unprot_disassoc is required to provide more
3852 * details of the frame.
3854 EVENT_UNPROT_DISASSOC,
3857 * EVENT_STATION_LOW_ACK
3859 * Driver generates this event whenever it detected that a particular
3860 * station was lost. Detection can be through massive transmission
3861 * failures for example.
3863 EVENT_STATION_LOW_ACK,
3866 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3868 EVENT_IBSS_PEER_LOST,
3871 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3873 * This event carries the new replay counter to notify wpa_supplicant
3874 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3875 * completed Group Key Handshake while the host (including
3876 * wpa_supplicant was sleeping).
3878 EVENT_DRIVER_GTK_REKEY,
3881 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3883 EVENT_SCHED_SCAN_STOPPED,
3886 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3888 * This event indicates that the station responded to the poll
3889 * initiated with @poll_client.
3891 EVENT_DRIVER_CLIENT_POLL_OK,
3894 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3896 EVENT_EAPOL_TX_STATUS,
3899 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3901 * Described in wpa_event_data.ch_switch
3906 * EVENT_WNM - Request WNM operation
3908 * This event can be used to request a WNM operation to be performed.
3913 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3915 * This event indicates that the driver reported a connection failure
3916 * with the specified client (for example, max client reached, etc.) in
3919 EVENT_CONNECT_FAILED_REASON,
3922 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
3924 * A radar has been detected on the supplied frequency, hostapd should
3925 * react accordingly (e.g., change channel).
3927 EVENT_DFS_RADAR_DETECTED,
3930 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
3932 * After a successful CAC, the channel can be marked clear and used.
3934 EVENT_DFS_CAC_FINISHED,
3937 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
3939 * The CAC was not successful, and the channel remains in the previous
3940 * state. This may happen due to a radar beeing detected or other
3941 * external influences.
3943 EVENT_DFS_CAC_ABORTED,
3946 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
3948 * The channel which was previously unavailable is now available again.
3950 EVENT_DFS_NOP_FINISHED,
3953 * EVENT_SURVEY - Received survey data
3955 * This event gets triggered when a driver query is issued for survey
3956 * data and the requested data becomes available. The returned data is
3957 * stored in struct survey_results. The results provide at most one
3958 * survey entry for each frequency and at minimum will provide one
3959 * survey entry for one frequency. The survey data can be os_malloc()'d
3960 * and then os_free()'d, so the event callback must only copy data.
3965 * EVENT_SCAN_STARTED - Scan started
3967 * This indicates that driver has started a scan operation either based
3968 * on a request from wpa_supplicant/hostapd or from another application.
3969 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3970 * completed (either successfully or by getting cancelled).
3975 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3977 * This event indicates a set of frequency ranges that should be avoided
3978 * to reduce issues due to interference or internal co-existence
3979 * information in the driver.
3981 EVENT_AVOID_FREQUENCIES,
3984 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3986 EVENT_NEW_PEER_CANDIDATE,
3989 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
3991 * Indicates a pair of primary and secondary channels chosen by ACS
3994 EVENT_ACS_CHANNEL_SELECTED,
3997 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4000 * This event indicates that channel availability check has been started
4001 * on a DFS frequency by a driver that supports DFS Offload.
4003 EVENT_DFS_CAC_STARTED,
4008 * struct freq_survey - Channel survey info
4010 * @ifidx: Interface index in which this survey was observed
4011 * @freq: Center of frequency of the surveyed channel
4012 * @nf: Channel noise floor in dBm
4013 * @channel_time: Amount of time in ms the radio spent on the channel
4014 * @channel_time_busy: Amount of time in ms the radio detected some signal
4015 * that indicated to the radio the channel was not clear
4016 * @channel_time_rx: Amount of time the radio spent receiving data
4017 * @channel_time_tx: Amount of time the radio spent transmitting data
4018 * @filled: bitmask indicating which fields have been reported, see
4019 * SURVEY_HAS_* defines.
4020 * @list: Internal list pointers
4022 struct freq_survey {
4027 u64 channel_time_busy;
4028 u64 channel_time_rx;
4029 u64 channel_time_tx;
4030 unsigned int filled;
4031 struct dl_list list;
4034 #define SURVEY_HAS_NF BIT(0)
4035 #define SURVEY_HAS_CHAN_TIME BIT(1)
4036 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4037 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4038 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4042 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4044 union wpa_event_data {
4046 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4048 * This structure is optional for EVENT_ASSOC calls and required for
4049 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4050 * driver interface does not need to generate separate EVENT_ASSOCINFO
4055 * reassoc - Flag to indicate association or reassociation
4060 * req_ies - (Re)Association Request IEs
4062 * If the driver generates WPA/RSN IE, this event data must be
4063 * returned for WPA handshake to have needed information. If
4064 * wpa_supplicant-generated WPA/RSN IE is used, this
4065 * information event is optional.
4067 * This should start with the first IE (fixed fields before IEs
4068 * are not included).
4073 * req_ies_len - Length of req_ies in bytes
4078 * resp_ies - (Re)Association Response IEs
4080 * Optional association data from the driver. This data is not
4081 * required WPA, but may be useful for some protocols and as
4082 * such, should be reported if this is available to the driver
4085 * This should start with the first IE (fixed fields before IEs
4086 * are not included).
4091 * resp_ies_len - Length of resp_ies in bytes
4093 size_t resp_ies_len;
4096 * beacon_ies - Beacon or Probe Response IEs
4098 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4099 * Probe Response frames from the current AP (i.e., the one
4100 * that the client just associated with). This information is
4101 * used to update WPA/RSN IE for the AP. If this field is not
4102 * set, the results from previous scan will be used. If no
4103 * data for the new AP is found, scan results will be requested
4104 * again (without scan request). At this point, the driver is
4105 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4108 * This should start with the first IE (fixed fields before IEs
4109 * are not included).
4111 const u8 *beacon_ies;
4114 * beacon_ies_len - Length of beacon_ies */
4115 size_t beacon_ies_len;
4118 * freq - Frequency of the operational channel in MHz
4123 * wmm_params - WMM parameters used in this association.
4125 struct wmm_params wmm_params;
4128 * addr - Station address (for AP mode)
4133 * The following is the key management offload information
4136 * @key_replay_ctr_len
4144 * authorized - Status of key management offload,
4150 * key_replay_ctr - Key replay counter value last used
4151 * in a valid EAPOL-Key frame
4153 const u8 *key_replay_ctr;
4156 * key_replay_ctr_len - The length of key_replay_ctr
4158 size_t key_replay_ctr_len;
4161 * ptk_kck - The derived PTK KCK
4166 * ptk_kek_len - The length of ptk_kck
4171 * ptk_kek - The derived PTK KEK
4176 * ptk_kek_len - The length of ptk_kek
4181 * subnet_status - The subnet status:
4182 * 0 = unknown, 1 = unchanged, 2 = changed
4188 * struct disassoc_info - Data for EVENT_DISASSOC events
4190 struct disassoc_info {
4192 * addr - Station address (for AP mode)
4197 * reason_code - Reason Code (host byte order) used in
4198 * Deauthentication frame
4203 * ie - Optional IE(s) in Disassociation frame
4208 * ie_len - Length of ie buffer in octets
4213 * locally_generated - Whether the frame was locally generated
4215 int locally_generated;
4219 * struct deauth_info - Data for EVENT_DEAUTH events
4221 struct deauth_info {
4223 * addr - Station address (for AP mode)
4228 * reason_code - Reason Code (host byte order) used in
4229 * Deauthentication frame
4234 * ie - Optional IE(s) in Deauthentication frame
4239 * ie_len - Length of ie buffer in octets
4244 * locally_generated - Whether the frame was locally generated
4246 int locally_generated;
4250 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4252 struct michael_mic_failure {
4255 } michael_mic_failure;
4258 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4260 struct interface_status {
4263 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4268 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4270 struct pmkid_candidate {
4271 /** BSSID of the PMKID candidate */
4273 /** Smaller the index, higher the priority */
4275 /** Whether RSN IE includes pre-authenticate flag */
4280 * struct stkstart - Data for EVENT_STKSTART
4287 * struct tdls - Data for EVENT_TDLS
4293 TDLS_REQUEST_TEARDOWN,
4294 TDLS_REQUEST_DISCOVER,
4296 u16 reason_code; /* for teardown */
4300 * struct wnm - Data for EVENT_WNM
4318 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4320 * During FT (IEEE 802.11r) authentication sequence, the driver is
4321 * expected to use this event to report received FT IEs (MDIE, FTIE,
4322 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4323 * IEs for the next message will be delivered through the
4324 * struct wpa_driver_ops::update_ft_ies() callback.
4330 u8 target_ap[ETH_ALEN];
4331 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4333 /** Length of ric_ies buffer in octets */
4338 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4340 struct ibss_rsn_start {
4345 * struct auth_info - Data for EVENT_AUTH events
4351 u16 auth_transaction;
4358 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4360 struct assoc_reject {
4362 * bssid - BSSID of the AP that rejected association
4367 * resp_ies - (Re)Association Response IEs
4369 * Optional association data from the driver. This data is not
4370 * required WPA, but may be useful for some protocols and as
4371 * such, should be reported if this is available to the driver
4374 * This should start with the first IE (fixed fields before IEs
4375 * are not included).
4380 * resp_ies_len - Length of resp_ies in bytes
4382 size_t resp_ies_len;
4385 * status_code - Status Code from (Re)association Response
4390 struct timeout_event {
4395 * struct tx_status - Data for EVENT_TX_STATUS events
4407 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4409 struct rx_from_unknown {
4416 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4424 * drv_priv - Pointer to store driver private BSS information
4426 * If not set to NULL, this is used for comparison with
4427 * hostapd_data->drv_priv to determine which BSS should process
4433 * freq - Frequency (in MHz) on which the frame was received
4438 * ssi_signal - Signal strength in dBm (or 0 if not available)
4444 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4446 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4448 struct remain_on_channel {
4450 * freq - Channel frequency in MHz
4455 * duration - Duration to remain on the channel in milliseconds
4457 unsigned int duration;
4458 } remain_on_channel;
4461 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4462 * @aborted: Whether the scan was aborted
4463 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4464 * @num_freqs: Number of entries in freqs array
4465 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4467 * @num_ssids: Number of entries in ssids array
4468 * @external_scan: Whether the scan info is for an external scan
4469 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
4470 * 0 if the source of the scan event is a vendor scan
4476 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4483 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4485 struct rx_probe_req {
4487 * sa - Source address of the received Probe Request frame
4492 * da - Destination address of the received Probe Request frame
4493 * or %NULL if not available
4498 * bssid - BSSID of the received Probe Request frame or %NULL
4504 * ie - IEs from the Probe Request body
4509 * ie_len - Length of ie buffer in octets
4514 * signal - signal strength in dBm (or 0 if not available)
4520 * struct new_sta - Data for EVENT_NEW_STA events
4527 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4536 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4538 struct wpa_signal_info signal_change;
4541 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4542 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4543 * @freq_5: Best 5 GHz band channel frequency in MHz
4544 * @freq_overall: Best channel frequency in MHz
4546 * 0 can be used to indicate no preference in either band.
4548 struct best_channel {
4554 struct unprot_deauth {
4560 struct unprot_disassoc {
4567 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4568 * @addr: station address
4575 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4577 struct ibss_peer_lost {
4582 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4584 struct driver_gtk_rekey {
4586 const u8 *replay_ctr;
4590 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4591 * @addr: station address
4593 struct client_poll {
4598 * struct eapol_tx_status
4599 * @dst: Original destination
4600 * @data: Data starting with IEEE 802.1X header (!)
4601 * @data_len: Length of data
4602 * @ack: Indicates ack or lost frame
4604 * This corresponds to hapd_send_eapol if the frame sent
4605 * there isn't just reported as EVENT_TX_STATUS.
4607 struct eapol_tx_status {
4616 * @freq: Frequency of new channel in MHz
4617 * @ht_enabled: Whether this is an HT channel
4618 * @ch_offset: Secondary channel offset
4619 * @ch_width: Channel width
4620 * @cf1: Center frequency 1
4621 * @cf2: Center frequency 2
4627 enum chan_width ch_width;
4633 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4634 * @addr: Remote client address
4635 * @code: Reason code for connection failure
4637 struct connect_failed_reason {
4643 } connect_failed_reason;
4646 * struct dfs_event - Data for radar detected events
4647 * @freq: Frequency of the channel in MHz
4653 enum chan_width chan_width;
4659 * survey_results - Survey result data for EVENT_SURVEY
4660 * @freq_filter: Requested frequency survey filter, 0 if request
4661 * was for all survey data
4662 * @survey_list: Linked list of survey data (struct freq_survey)
4664 struct survey_results {
4665 unsigned int freq_filter;
4666 struct dl_list survey_list; /* struct freq_survey */
4670 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4671 * @initiator: Initiator of the regulatory change
4672 * @type: Regulatory change type
4673 * @alpha2: Country code (or "" if not available)
4675 struct channel_list_changed {
4676 enum reg_change_initiator initiator;
4679 } channel_list_changed;
4682 * freq_range - List of frequency ranges
4684 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4686 struct wpa_freq_range_list freq_range;
4691 * @peer: Peer address
4693 * @ie_len: Length of @ies
4695 * Notification of new candidate mesh peer.
4704 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4705 * @pri_channel: Selected primary channel
4706 * @sec_channel: Selected secondary channel
4707 * @vht_seg0_center_ch: VHT mode Segment0 center channel
4708 * @vht_seg1_center_ch: VHT mode Segment1 center channel
4709 * @ch_width: Selected Channel width by driver. Driver may choose to
4710 * change hostapd configured ACS channel width due driver internal
4711 * channel restrictions.
4712 * hw_mode: Selected band (used with hw_mode=any)
4714 struct acs_selected_channels {
4717 u8 vht_seg0_center_ch;
4718 u8 vht_seg1_center_ch;
4720 enum hostapd_hw_mode hw_mode;
4721 } acs_selected_channels;
4725 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4726 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4727 * with struct wpa_driver_ops::init()
4728 * @event: event type (defined above)
4729 * @data: possible extra data for the event
4731 * Driver wrapper code should call this function whenever an event is received
4734 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4735 union wpa_event_data *data);
4739 * The following inline functions are provided for convenience to simplify
4740 * event indication for some of the common events.
4743 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4744 size_t ielen, int reassoc)
4746 union wpa_event_data event;
4747 os_memset(&event, 0, sizeof(event));
4748 event.assoc_info.reassoc = reassoc;
4749 event.assoc_info.req_ies = ie;
4750 event.assoc_info.req_ies_len = ielen;
4751 event.assoc_info.addr = addr;
4752 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4755 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4757 union wpa_event_data event;
4758 os_memset(&event, 0, sizeof(event));
4759 event.disassoc_info.addr = addr;
4760 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4763 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4766 union wpa_event_data event;
4767 os_memset(&event, 0, sizeof(event));
4768 event.eapol_rx.src = src;
4769 event.eapol_rx.data = data;
4770 event.eapol_rx.data_len = data_len;
4771 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4774 /* driver_common.c */
4775 void wpa_scan_results_free(struct wpa_scan_results *res);
4777 /* Convert wpa_event_type to a string for logging */
4778 const char * event_to_string(enum wpa_event_type event);
4780 /* Convert chan_width to a string for logging and control interfaces */
4781 const char * channel_width_to_string(enum chan_width width);
4783 int ht_supported(const struct hostapd_hw_modes *mode);
4784 int vht_supported(const struct hostapd_hw_modes *mode);
4786 struct wowlan_triggers *
4787 wpa_get_wowlan_triggers(const char *wowlan_triggers,
4788 const struct wpa_driver_capa *capa);
4790 /* NULL terminated array of linked in driver wrappers */
4791 extern const struct wpa_driver_ops *const wpa_drivers[];
4793 #endif /* DRIVER_H */