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
57 /* Filter gratuitous ARP */
58 #define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
59 /* Filter unsolicited Neighbor Advertisement */
60 #define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
61 /* Filter unicast IP packets encrypted using the GTK */
62 #define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)
65 * enum reg_change_initiator - Regulatory change initiator
67 enum reg_change_initiator {
71 REGDOM_SET_BY_COUNTRY_IE,
76 * enum reg_type - Regulatory change types
82 REGDOM_TYPE_CUSTOM_WORLD,
83 REGDOM_TYPE_INTERSECTION,
87 * struct hostapd_channel_data - Channel information
89 struct hostapd_channel_data {
91 * chan - Channel number (IEEE 802.11)
96 * freq - Frequency in MHz
101 * flag - Channel flags (HOSTAPD_CHAN_*)
106 * max_tx_power - Regulatory transmit power limit in dBm
111 * survey_list - Linked list of surveys (struct freq_survey)
113 struct dl_list survey_list;
116 * min_nf - Minimum observed noise floor, in dBm, based on all
117 * surveyed channel data
123 * interference_factor - Computed interference factor on this
124 * channel (used internally in src/ap/acs.c; driver wrappers do not
127 long double interference_factor;
128 #endif /* CONFIG_ACS */
131 * dfs_cac_ms - DFS CAC time in milliseconds
133 unsigned int dfs_cac_ms;
136 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
137 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
140 * struct hostapd_hw_modes - Supported hardware mode information
142 struct hostapd_hw_modes {
144 * mode - Hardware mode
146 enum hostapd_hw_mode mode;
149 * num_channels - Number of entries in the channels array
154 * channels - Array of supported channels
156 struct hostapd_channel_data *channels;
159 * num_rates - Number of entries in the rates array
164 * rates - Array of supported rates in 100 kbps units
169 * ht_capab - HT (IEEE 802.11n) capabilities
174 * mcs_set - MCS (IEEE 802.11n) rate parameters
179 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
184 * vht_capab - VHT (IEEE 802.11ac) capabilities
189 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
193 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
197 #define IEEE80211_MODE_INFRA 0
198 #define IEEE80211_MODE_IBSS 1
199 #define IEEE80211_MODE_AP 2
200 #define IEEE80211_MODE_MESH 5
202 #define IEEE80211_CAP_ESS 0x0001
203 #define IEEE80211_CAP_IBSS 0x0002
204 #define IEEE80211_CAP_PRIVACY 0x0010
205 #define IEEE80211_CAP_RRM 0x1000
207 /* DMG (60 GHz) IEEE 802.11ad */
208 /* type - bits 0..1 */
209 #define IEEE80211_CAP_DMG_MASK 0x0003
210 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
211 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
212 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
214 #define WPA_SCAN_QUAL_INVALID BIT(0)
215 #define WPA_SCAN_NOISE_INVALID BIT(1)
216 #define WPA_SCAN_LEVEL_INVALID BIT(2)
217 #define WPA_SCAN_LEVEL_DBM BIT(3)
218 #define WPA_SCAN_ASSOCIATED BIT(5)
221 * struct wpa_scan_res - Scan result for an BSS/IBSS
222 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
224 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
225 * @beacon_int: beacon interval in TUs (host byte order)
226 * @caps: capability information field in host byte order
227 * @qual: signal quality
228 * @noise: noise level
229 * @level: signal level
231 * @age: Age of the information in milliseconds (i.e., how many milliseconds
232 * ago the last Beacon or Probe Response frame was received)
233 * @est_throughput: Estimated throughput in kbps (this is calculated during
234 * scan result processing if left zero by the driver wrapper)
235 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
236 * @ie_len: length of the following IE field in octets
237 * @beacon_ie_len: length of the following Beacon IE field in octets
239 * This structure is used as a generic format for scan results from the
240 * driver. Each driver interface implementation is responsible for converting
241 * the driver or OS specific scan results into this format.
243 * If the driver does not support reporting all IEs, the IE data structure is
244 * constructed of the IEs that are available. This field will also need to
245 * include SSID in IE format. All drivers are encouraged to be extended to
246 * report all IEs to make it easier to support future additions.
248 * This structure data is followed by ie_len octets of IEs from Probe Response
249 * frame (or if the driver does not indicate source of IEs, these may also be
250 * from Beacon frame). After the first set of IEs, another set of IEs may follow
251 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
253 struct wpa_scan_res {
264 unsigned int est_throughput;
267 size_t beacon_ie_len;
268 /* Followed by ie_len + beacon_ie_len octets of IE data */
272 * struct wpa_scan_results - Scan results
273 * @res: Array of pointers to allocated variable length scan result entries
274 * @num: Number of entries in the scan result array
275 * @fetch_time: Time when the results were fetched from the driver
277 struct wpa_scan_results {
278 struct wpa_scan_res **res;
280 struct os_reltime fetch_time;
284 * struct wpa_interface_info - Network interface information
285 * @next: Pointer to the next interface or NULL if this is the last one
286 * @ifname: Interface name that can be used with init() or init2()
287 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
289 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
290 * is not an allocated copy, i.e., get_interfaces() caller will not free
293 struct wpa_interface_info {
294 struct wpa_interface_info *next;
297 const char *drv_name;
300 #define WPAS_MAX_SCAN_SSIDS 16
303 * struct wpa_driver_scan_ssid - SSIDs to scan for
304 * @ssid - specific SSID to scan for (ProbeReq)
305 * %NULL or zero-length SSID is used to indicate active scan
306 * with wildcard SSID.
307 * @ssid_len - Length of the SSID in octets
309 struct wpa_driver_scan_ssid {
315 * struct wpa_driver_scan_params - Scan parameters
316 * Data for struct wpa_driver_ops::scan2().
318 struct wpa_driver_scan_params {
320 * ssids - SSIDs to scan for
322 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
325 * num_ssids - Number of entries in ssids array
326 * Zero indicates a request for a passive scan.
331 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
336 * extra_ies_len - Length of extra_ies in octets
338 size_t extra_ies_len;
341 * freqs - Array of frequencies to scan or %NULL for all frequencies
343 * The frequency is set in MHz. The array is zero-terminated.
348 * filter_ssids - Filter for reporting SSIDs
350 * This optional parameter can be used to request the driver wrapper to
351 * filter scan results to include only the specified SSIDs. %NULL
352 * indicates that no filtering is to be done. This can be used to
353 * reduce memory needs for scan results in environments that have large
354 * number of APs with different SSIDs.
356 * The driver wrapper is allowed to take this allocated buffer into its
357 * own use by setting the pointer to %NULL. In that case, the driver
358 * wrapper is responsible for freeing the buffer with os_free() once it
359 * is not needed anymore.
361 struct wpa_driver_scan_filter {
362 u8 ssid[SSID_MAX_LEN];
367 * num_filter_ssids - Number of entries in filter_ssids array
369 size_t num_filter_ssids;
372 * filter_rssi - Filter by RSSI
374 * The driver may filter scan results in firmware to reduce host
375 * wakeups and thereby save power. Specify the RSSI threshold in s32
381 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
383 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
384 * Mbps from the support rates element(s) in the Probe Request frames
385 * and not to transmit the frames at any of those rates.
387 unsigned int p2p_probe:1;
390 * only_new_results - Request driver to report only new results
392 * This is used to request the driver to report only BSSes that have
393 * been detected after this scan request has been started, i.e., to
394 * flush old cached BSS entries.
396 unsigned int only_new_results:1;
399 * low_priority - Requests driver to use a lower scan priority
401 * This is used to request the driver to use a lower scan priority
402 * if it supports such a thing.
404 unsigned int low_priority:1;
407 * mac_addr_rand - Requests driver to randomize MAC address
409 unsigned int mac_addr_rand:1;
412 * mac_addr - MAC address used with randomization. The address cannot be
413 * a multicast one, i.e., bit 0 of byte 0 should not be set.
418 * mac_addr_mask - MAC address mask used with randomization.
420 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
421 * the mask should be taken as is from mac_addr. The mask should not
422 * allow the generation of a multicast address, i.e., bit 0 of byte 0
425 const u8 *mac_addr_mask;
428 * sched_scan_plans - Scan plans for scheduled scan
430 * Each scan plan consists of the number of iterations to scan and the
431 * interval between scans. When a scan plan finishes (i.e., it was run
432 * for the specified number of iterations), the next scan plan is
433 * executed. The scan plans are executed in the order they appear in
434 * the array (lower index first). The last scan plan will run infinitely
435 * (until requested to stop), thus must not specify the number of
436 * iterations. All other scan plans must specify the number of
439 struct sched_scan_plan {
440 u32 interval; /* In seconds */
441 u32 iterations; /* Zero to run infinitely */
445 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
447 unsigned int sched_scan_plans_num;
450 * bssid - Specific BSSID to scan for
452 * This optional parameter can be used to replace the default wildcard
453 * BSSID with a specific BSSID to scan for if results are needed from
459 * NOTE: Whenever adding new parameters here, please make sure
460 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
466 * struct wpa_driver_auth_params - Authentication parameters
467 * Data for struct wpa_driver_ops::authenticate().
469 struct wpa_driver_auth_params {
477 const u8 *wep_key[4];
478 size_t wep_key_len[4];
480 int local_state_change;
483 * p2p - Whether this connection is a P2P group
488 * sae_data - SAE elements for Authentication frame
490 * This buffer starts with the Authentication transaction sequence
491 * number field. If SAE is not used, this pointer is %NULL.
496 * sae_data_len - Length of sae_data buffer in octets
502 * enum wps_mode - WPS mode
506 * WPS_MODE_NONE - No WPS provisioning being used
511 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
516 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
522 * struct hostapd_freq_params - Channel parameters
524 struct hostapd_freq_params {
526 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
528 enum hostapd_hw_mode mode;
531 * freq - Primary channel center frequency in MHz
536 * channel - Channel number
541 * ht_enabled - Whether HT is enabled
546 * sec_channel_offset - Secondary channel offset for HT40
549 * -1 = HT40 enabled, secondary channel below primary,
550 * 1 = HT40 enabled, secondary channel above primary
552 int sec_channel_offset;
555 * vht_enabled - Whether VHT is enabled
560 * center_freq1 - Segment 0 center frequency in MHz
562 * Valid for both HT and VHT.
567 * center_freq2 - Segment 1 center frequency in MHz
569 * Non-zero only for bandwidth 80 and an 80+80 channel
574 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
580 * struct wpa_driver_associate_params - Association parameters
581 * Data for struct wpa_driver_ops::associate().
583 struct wpa_driver_associate_params {
585 * bssid - BSSID of the selected AP
586 * This can be %NULL, if ap_scan=2 mode is used and the driver is
587 * responsible for selecting with which BSS to associate. */
591 * bssid_hint - BSSID of a proposed AP
593 * This indicates which BSS has been found a suitable candidate for
594 * initial association for drivers that use driver/firmwate-based BSS
595 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
596 * the driver from selecting other BSSes in the ESS.
598 const u8 *bssid_hint;
601 * ssid - The selected SSID
606 * ssid_len - Length of the SSID (1..32)
611 * freq - channel parameters
613 struct hostapd_freq_params freq;
616 * freq_hint - Frequency of the channel the proposed AP is using
618 * This provides a channel on which a suitable BSS has been found as a
619 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
620 * limit the driver from selecting other channels for
621 * driver/firmware-based BSS selection.
626 * bg_scan_period - Background scan period in seconds, 0 to disable
627 * background scan, or -1 to indicate no change to default driver
633 * beacon_int - Beacon interval for IBSS or 0 to use driver default
638 * wpa_ie - WPA information element for (Re)Association Request
639 * WPA information element to be included in (Re)Association
640 * Request (including information element id and length). Use
641 * of this WPA IE is optional. If the driver generates the WPA
642 * IE, it can use pairwise_suite, group_suite, and
643 * key_mgmt_suite to select proper algorithms. In this case,
644 * the driver has to notify wpa_supplicant about the used WPA
645 * IE by generating an event that the interface code will
646 * convert into EVENT_ASSOCINFO data (see below).
648 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
649 * instead. The driver can determine which version is used by
650 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
653 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
658 * wpa_ie_len - length of the wpa_ie
663 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
665 unsigned int wpa_proto;
668 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
670 * This is usually ignored if @wpa_ie is used.
672 unsigned int pairwise_suite;
675 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
677 * This is usually ignored if @wpa_ie is used.
679 unsigned int group_suite;
682 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
684 * This is usually ignored if @wpa_ie is used.
686 unsigned int key_mgmt_suite;
689 * auth_alg - Allowed authentication algorithms
690 * Bit field of WPA_AUTH_ALG_*
695 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
700 * wep_key - WEP keys for static WEP configuration
702 const u8 *wep_key[4];
705 * wep_key_len - WEP key length for static WEP configuration
707 size_t wep_key_len[4];
710 * wep_tx_keyidx - WEP TX key index for static WEP configuration
715 * mgmt_frame_protection - IEEE 802.11w management frame protection
717 enum mfp_options mgmt_frame_protection;
720 * ft_ies - IEEE 802.11r / FT information elements
721 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
722 * for fast transition, this parameter is set to include the IEs that
723 * are to be sent in the next FT Authentication Request message.
724 * update_ft_ies() handler is called to update the IEs for further
725 * FT messages in the sequence.
727 * The driver should use these IEs only if the target AP is advertising
728 * the same mobility domain as the one included in the MDIE here.
730 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
731 * AP after the initial association. These IEs can only be used if the
732 * target AP is advertising support for FT and is using the same MDIE
733 * and SSID as the current AP.
735 * The driver is responsible for reporting the FT IEs received from the
736 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
737 * type. update_ft_ies() handler will then be called with the FT IEs to
738 * include in the next frame in the authentication sequence.
743 * ft_ies_len - Length of ft_ies in bytes
748 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
750 * This value is provided to allow the driver interface easier access
751 * to the current mobility domain. This value is set to %NULL if no
752 * mobility domain is currently active.
757 * passphrase - RSN passphrase for PSK
759 * This value is made available only for WPA/WPA2-Personal (PSK) and
760 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
761 * the 8..63 character ASCII passphrase, if available. Please note that
762 * this can be %NULL if passphrase was not used to generate the PSK. In
763 * that case, the psk field must be used to fetch the PSK.
765 const char *passphrase;
768 * psk - RSN PSK (alternative for passphrase for PSK)
770 * This value is made available only for WPA/WPA2-Personal (PSK) and
771 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
772 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
773 * be prepared to handle %NULL value as an error.
778 * drop_unencrypted - Enable/disable unencrypted frame filtering
780 * Configure the driver to drop all non-EAPOL frames (both receive and
781 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
782 * still be allowed for key negotiation.
784 int drop_unencrypted;
787 * prev_bssid - Previously used BSSID in this ESS
789 * When not %NULL, this is a request to use reassociation instead of
792 const u8 *prev_bssid;
797 * If the driver needs to do special configuration for WPS association,
798 * this variable provides more information on what type of association
799 * is being requested. Most drivers should not need ot use this.
804 * p2p - Whether this connection is a P2P group
809 * uapsd - UAPSD parameters for the network
810 * -1 = do not change defaults
811 * AP mode: 1 = enabled, 0 = disabled
812 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
817 * fixed_bssid - Whether to force this BSSID in IBSS mode
818 * 1 = Fix this BSSID and prevent merges.
819 * 0 = Do not fix BSSID.
824 * fixed_freq - Fix control channel in IBSS mode
825 * 0 = don't fix control channel (default)
826 * 1 = fix control channel; this prevents IBSS merging with another
832 * disable_ht - Disable HT (IEEE 802.11n) for this connection
837 * htcaps - HT Capabilities over-rides
839 * Only bits set in the mask will be used, and not all values are used
840 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
842 * Pointer to struct ieee80211_ht_capabilities.
847 * htcaps_mask - HT Capabilities over-rides mask
849 * Pointer to struct ieee80211_ht_capabilities.
851 const u8 *htcaps_mask;
853 #ifdef CONFIG_VHT_OVERRIDES
855 * disable_vht - Disable VHT for this connection
860 * VHT capability overrides.
862 const struct ieee80211_vht_capabilities *vhtcaps;
863 const struct ieee80211_vht_capabilities *vhtcaps_mask;
864 #endif /* CONFIG_VHT_OVERRIDES */
867 * req_key_mgmt_offload - Request key management offload for connection
869 * Request key management offload for this connection if the device
872 int req_key_mgmt_offload;
875 * Flag for indicating whether this association includes support for
876 * RRM (Radio Resource Measurements)
881 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
882 * AP as usual. Valid for DMG network only.
889 HIDDEN_SSID_ZERO_LEN,
890 HIDDEN_SSID_ZERO_CONTENTS
893 struct wowlan_triggers {
897 u8 gtk_rekey_failure;
899 u8 four_way_handshake;
903 struct wpa_driver_ap_params {
905 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
910 * head_len - Length of the head buffer in octets
915 * tail - Beacon tail following TIM IE
920 * tail_len - Length of the tail buffer in octets
925 * dtim_period - DTIM period
930 * beacon_int - Beacon interval
935 * basic_rates: -1 terminated array of basic rates in 100 kbps
937 * This parameter can be used to set a specific basic rate set for the
938 * BSS. If %NULL, default basic rate set is used.
943 * proberesp - Probe Response template
945 * This is used by drivers that reply to Probe Requests internally in
946 * AP mode and require the full Probe Response template.
951 * proberesp_len - Length of the proberesp buffer in octets
953 size_t proberesp_len;
956 * ssid - The SSID to use in Beacon/Probe Response frames
961 * ssid_len - Length of the SSID (1..32)
966 * hide_ssid - Whether to hide the SSID
968 enum hide_ssid hide_ssid;
971 * pairwise_ciphers - WPA_CIPHER_* bitfield
973 unsigned int pairwise_ciphers;
976 * group_cipher - WPA_CIPHER_*
978 unsigned int group_cipher;
981 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
983 unsigned int key_mgmt_suites;
986 * auth_algs - WPA_AUTH_ALG_* bitfield
988 unsigned int auth_algs;
991 * wpa_version - WPA_PROTO_* bitfield
993 unsigned int wpa_version;
996 * privacy - Whether privacy is used in the BSS
1001 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1003 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1004 * not use the full Beacon template.
1006 const struct wpabuf *beacon_ies;
1009 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1011 * This is used to add IEs like WPS IE and P2P IE by drivers that
1012 * reply to Probe Request frames internally.
1014 const struct wpabuf *proberesp_ies;
1017 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1019 * This is used to add IEs like WPS IE by drivers that reply to
1020 * (Re)Association Request frames internally.
1022 const struct wpabuf *assocresp_ies;
1025 * isolate - Whether to isolate frames between associated stations
1027 * If this is non-zero, the AP is requested to disable forwarding of
1028 * frames between associated stations.
1033 * cts_protect - Whether CTS protection is enabled
1038 * preamble - Whether short preamble is enabled
1043 * short_slot_time - Whether short slot time is enabled
1045 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1046 * not set (e.g., when 802.11g mode is not in use)
1048 int short_slot_time;
1051 * ht_opmode - HT operation mode or -1 if HT not in use
1056 * interworking - Whether Interworking is enabled
1061 * hessid - Homogeneous ESS identifier or %NULL if not set
1066 * access_network_type - Access Network Type (0..15)
1068 * This is used for filtering Probe Request frames when Interworking is
1071 u8 access_network_type;
1074 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1076 * This is used by driver which advertises this capability.
1078 int ap_max_inactivity;
1081 * ctwindow - Client Traffic Window (in TUs)
1086 * smps_mode - SMPS mode
1088 * SMPS mode to be used by the AP, specified as the relevant bits of
1089 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1091 unsigned int smps_mode;
1094 * disable_dgaf - Whether group-addressed frames are disabled
1099 * osen - Whether OSEN security is enabled
1104 * freq - Channel parameters for dynamic bandwidth changes
1106 struct hostapd_freq_params *freq;
1109 * reenable - Whether this is to re-enable beaconing
1114 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1115 * infrastructure BSS. Valid only for DMG network.
1120 struct wpa_driver_mesh_bss_params {
1121 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1123 * TODO: Other mesh configuration parameters would go here.
1124 * See NL80211_MESHCONF_* for all the mesh config parameters.
1127 int peer_link_timeout;
1130 struct wpa_driver_mesh_join_params {
1133 const int *basic_rates;
1136 struct hostapd_freq_params freq;
1139 struct wpa_driver_mesh_bss_params conf;
1140 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1141 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1142 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1143 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1148 * struct wpa_driver_capa - Driver capability information
1150 struct wpa_driver_capa {
1151 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1152 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1153 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1154 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1155 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1156 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1157 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1158 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1159 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1160 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
1161 /** Bitfield of supported key management suites */
1162 unsigned int key_mgmt;
1164 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1165 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1166 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1167 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1168 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1169 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1170 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1171 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1172 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1173 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1174 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1175 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1176 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1177 /** Bitfield of supported cipher suites */
1180 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1181 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1182 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1183 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1186 /** Driver generated WPA/RSN IE */
1187 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1188 /** Driver needs static WEP key setup after association command */
1189 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1190 /** Driver takes care of all DFS operations */
1191 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1192 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1193 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1194 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
1195 /** Driver is for a wired Ethernet interface */
1196 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1197 /** Driver provides separate commands for authentication and association (SME in
1198 * wpa_supplicant). */
1199 #define WPA_DRIVER_FLAGS_SME 0x00000020
1200 /** Driver supports AP mode */
1201 #define WPA_DRIVER_FLAGS_AP 0x00000040
1202 /** Driver needs static WEP key setup after association has been completed */
1203 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1204 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1205 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1206 /** Driver supports concurrent P2P operations */
1207 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1209 * Driver uses the initial interface as a dedicated management interface, i.e.,
1210 * it cannot be used for P2P group operations or non-P2P purposes.
1212 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1213 /** This interface is P2P capable (P2P GO or P2P Client) */
1214 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1215 /** Driver supports station and key removal when stopping an AP */
1216 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1218 * Driver uses the initial interface for P2P management interface and non-P2P
1219 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1220 * P2P group operations.
1222 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1224 * Driver is known to use sane error codes, i.e., when it indicates that
1225 * something (e.g., association) fails, there was indeed a failure and the
1226 * operation does not end up getting completed successfully later.
1228 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1229 /** Driver supports off-channel TX */
1230 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1231 /** Driver indicates TX status events for EAPOL Data frames */
1232 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1233 /** Driver indicates TX status events for Deauth/Disassoc frames */
1234 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1235 /** Driver supports roaming (BSS selection) in firmware */
1236 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1237 /** Driver supports operating as a TDLS peer */
1238 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1239 /** Driver requires external TDLS setup/teardown/discovery */
1240 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1241 /** Driver indicates support for Probe Response offloading in AP mode */
1242 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1243 /** Driver supports U-APSD in AP mode */
1244 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1245 /** Driver supports inactivity timer in AP mode */
1246 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1247 /** Driver expects user space implementation of MLME in AP mode */
1248 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1249 /** Driver supports SAE with user space SME */
1250 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1251 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1252 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1253 /** Driver supports IBSS (Ad-hoc) mode */
1254 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1255 /** Driver supports radar detection */
1256 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1257 /** Driver supports a dedicated interface for P2P Device */
1258 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1259 /** Driver supports QoS Mapping */
1260 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1261 /** Driver supports CSA in AP mode */
1262 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1263 /** Driver supports mesh */
1264 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1265 /** Driver support ACS offload */
1266 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1267 /** Driver supports key management offload */
1268 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1269 /** Driver supports TDLS channel switching */
1270 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1271 /** Driver supports IBSS with HT datarates */
1272 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
1273 /** Driver supports IBSS with VHT datarates */
1274 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
1275 /** Driver supports automatic band selection */
1276 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
1277 /** Driver supports simultaneous off-channel operations */
1278 #define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
1279 /** Driver supports full AP client state */
1280 #define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
1281 /** Driver supports P2P Listen offload */
1282 #define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
1285 #define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1286 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1288 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1289 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1290 unsigned int smps_modes;
1292 unsigned int wmm_ac_supported:1;
1294 unsigned int mac_addr_rand_scan_supported:1;
1295 unsigned int mac_addr_rand_sched_scan_supported:1;
1297 /** Maximum number of supported active probe SSIDs */
1300 /** Maximum number of supported active probe SSIDs for sched_scan */
1301 int max_sched_scan_ssids;
1303 /** Maximum number of supported scan plans for scheduled scan */
1304 unsigned int max_sched_scan_plans;
1306 /** Maximum interval in a scan plan. In seconds */
1307 u32 max_sched_scan_plan_interval;
1309 /** Maximum number of iterations in a single scan plan */
1310 u32 max_sched_scan_plan_iterations;
1312 /** Whether sched_scan (offloaded scanning) is supported */
1313 int sched_scan_supported;
1315 /** Maximum number of supported match sets for sched_scan */
1319 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1321 unsigned int max_remain_on_chan;
1324 * max_stations - Maximum number of associated stations the driver
1325 * supports in AP mode
1327 unsigned int max_stations;
1330 * probe_resp_offloads - Bitmap of supported protocols by the driver
1331 * for Probe Response offloading.
1333 /** Driver Probe Response offloading support for WPS ver. 1 */
1334 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1335 /** Driver Probe Response offloading support for WPS ver. 2 */
1336 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1337 /** Driver Probe Response offloading support for P2P */
1338 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1339 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1340 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1341 unsigned int probe_resp_offloads;
1343 unsigned int max_acl_mac_addrs;
1346 * Number of supported concurrent channels
1348 unsigned int num_multichan_concurrent;
1351 * extended_capa - extended capabilities in driver/device
1353 * Must be allocated and freed by driver and the pointers must be
1354 * valid for the lifetime of the driver, i.e., freed in deinit()
1356 const u8 *extended_capa, *extended_capa_mask;
1357 unsigned int extended_capa_len;
1359 struct wowlan_triggers wowlan_triggers;
1361 /** Driver adds the DS Params Set IE in Probe Request frames */
1362 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1363 /** Driver adds the WFA TPC IE in Probe Request frames */
1364 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1365 /** Driver handles quiet period requests */
1366 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1368 * Driver is capable of inserting the current TX power value into the body of
1369 * transmitted frames.
1370 * Background: Some Action frames include a TPC Report IE. This IE contains a
1371 * TX power field, which has to be updated by lower layers. One such Action
1372 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1373 * of spectrum management). Note that this insertion takes place at a fixed
1374 * offset, namely the 6th byte in the Action frame body.
1376 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1378 * Driver supports RRM. With this support, the driver will accept to use RRM in
1379 * (Re)Association Request frames, without supporting quiet period.
1381 #define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1385 /* Driver concurrency capabilities */
1386 unsigned int conc_capab;
1387 /* Maximum number of concurrent channels on 2.4 GHz */
1388 unsigned int max_conc_chan_2_4;
1389 /* Maximum number of concurrent channels on 5 GHz */
1390 unsigned int max_conc_chan_5_0;
1392 /* Maximum number of supported CSA counters */
1393 u16 max_csa_counters;
1397 struct hostapd_data;
1399 struct hostap_sta_driver_data {
1400 unsigned long rx_packets, tx_packets;
1401 unsigned long long rx_bytes, tx_bytes;
1402 int bytes_64bit; /* whether 64-bit byte counters are supported */
1403 unsigned long current_tx_rate;
1404 unsigned long inactive_msec;
1405 unsigned long flags;
1406 unsigned long num_ps_buf_frames;
1407 unsigned long tx_retry_failed;
1408 unsigned long tx_retry_count;
1413 struct hostapd_sta_add_params {
1417 const u8 *supp_rates;
1418 size_t supp_rates_len;
1419 u16 listen_interval;
1420 const struct ieee80211_ht_capabilities *ht_capabilities;
1421 const struct ieee80211_vht_capabilities *vht_capabilities;
1422 int vht_opmode_enabled;
1424 u32 flags; /* bitmask of WPA_STA_* flags */
1425 u32 flags_mask; /* unset bits in flags */
1427 enum mesh_plink_state plink_state;
1429 #endif /* CONFIG_MESH */
1430 int set; /* Set STA parameters instead of add */
1432 const u8 *ext_capab;
1433 size_t ext_capab_len;
1434 const u8 *supp_channels;
1435 size_t supp_channels_len;
1436 const u8 *supp_oper_classes;
1437 size_t supp_oper_classes_len;
1441 struct mac_address {
1445 struct hostapd_acl_params {
1447 unsigned int num_mac_acl;
1448 struct mac_address mac_acl[0];
1451 enum wpa_driver_if_type {
1453 * WPA_IF_STATION - Station mode interface
1458 * WPA_IF_AP_VLAN - AP mode VLAN interface
1460 * This interface shares its address and Beacon frame with the main
1466 * WPA_IF_AP_BSS - AP mode BSS interface
1468 * This interface has its own address and Beacon frame.
1473 * WPA_IF_P2P_GO - P2P Group Owner
1478 * WPA_IF_P2P_CLIENT - P2P Client
1483 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1484 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1489 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1490 * abstracted P2P Device function in the driver
1495 * WPA_IF_MESH - Mesh interface
1500 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1505 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1510 struct wpa_init_params {
1514 const char *driver_params;
1515 int use_pae_group_addr;
1519 u8 *own_addr; /* buffer for writing own MAC address */
1523 struct wpa_bss_params {
1524 /** Interface name (for multi-SSID/VLAN support) */
1526 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1535 enum mfp_options ieee80211w;
1538 #define WPA_STA_AUTHORIZED BIT(0)
1539 #define WPA_STA_WMM BIT(1)
1540 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1541 #define WPA_STA_MFP BIT(3)
1542 #define WPA_STA_TDLS_PEER BIT(4)
1543 #define WPA_STA_AUTHENTICATED BIT(5)
1544 #define WPA_STA_ASSOCIATED BIT(6)
1557 WNM_SLEEP_ENTER_CONFIRM,
1558 WNM_SLEEP_ENTER_FAIL,
1559 WNM_SLEEP_EXIT_CONFIRM,
1560 WNM_SLEEP_EXIT_FAIL,
1561 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1562 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1563 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1565 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1567 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1568 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1570 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1573 /* enum chan_width - Channel width definitions */
1585 * struct wpa_signal_info - Information about channel signal quality
1587 struct wpa_signal_info {
1589 int above_threshold;
1592 int avg_beacon_signal;
1595 enum chan_width chanwidth;
1601 * struct beacon_data - Beacon data
1602 * @head: Head portion of Beacon frame (before TIM IE)
1603 * @tail: Tail portion of Beacon frame (after TIM IE)
1604 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1605 * @proberesp_ies: Extra information element(s) to add into Probe Response
1607 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1608 * Response frames or %NULL
1609 * @probe_resp: Probe Response frame template
1610 * @head_len: Length of @head
1611 * @tail_len: Length of @tail
1612 * @beacon_ies_len: Length of beacon_ies in octets
1613 * @proberesp_ies_len: Length of proberesp_ies in octets
1614 * @proberesp_ies_len: Length of proberesp_ies in octets
1615 * @probe_resp_len: Length of probe response template (@probe_resp)
1617 struct beacon_data {
1624 size_t head_len, tail_len;
1625 size_t beacon_ies_len;
1626 size_t proberesp_ies_len;
1627 size_t assocresp_ies_len;
1628 size_t probe_resp_len;
1632 * struct csa_settings - Settings for channel switch command
1633 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1634 * @block_tx: 1 - block transmission for CSA period
1635 * @freq_params: Next channel frequency parameter
1636 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1637 * @beacon_after: Next beacon/probe resp/asooc resp info
1638 * @counter_offset_beacon: Offset to the count field in beacon's tail
1639 * @counter_offset_presp: Offset to the count field in probe resp.
1641 struct csa_settings {
1645 struct hostapd_freq_params freq_params;
1646 struct beacon_data beacon_csa;
1647 struct beacon_data beacon_after;
1649 u16 counter_offset_beacon[2];
1650 u16 counter_offset_presp[2];
1653 /* TDLS peer capabilities for send_tdls_mgmt() */
1654 enum tdls_peer_capability {
1655 TDLS_PEER_HT = BIT(0),
1656 TDLS_PEER_VHT = BIT(1),
1657 TDLS_PEER_WMM = BIT(2),
1660 /* valid info in the wmm_params struct */
1661 enum wmm_params_valid_info {
1662 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1666 * struct wmm_params - WMM parameterss configured for this association
1667 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1668 * of the struct contain valid information.
1669 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1670 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1677 #ifdef CONFIG_MACSEC
1678 struct macsec_init_params {
1679 Boolean always_include_sci;
1683 #endif /* CONFIG_MACSEC */
1685 enum drv_br_port_attr {
1686 DRV_BR_PORT_ATTR_PROXYARP,
1687 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1690 enum drv_br_net_param {
1691 DRV_BR_NET_PARAM_GARP_ACCEPT,
1692 DRV_BR_MULTICAST_SNOOPING,
1695 struct drv_acs_params {
1696 /* Selected mode (HOSTAPD_MODE_*) */
1697 enum hostapd_hw_mode hw_mode;
1699 /* Indicates whether HT is enabled */
1702 /* Indicates whether HT40 is enabled */
1705 /* Indicates whether VHT is enabled */
1708 /* Configured ACS channel width */
1711 /* ACS channel list info */
1712 unsigned int ch_list_len;
1714 const int *freq_list;
1719 * struct wpa_driver_ops - Driver interface API definition
1721 * This structure defines the API that each driver interface needs to implement
1722 * for core wpa_supplicant code. All driver specific functionality is captured
1725 struct wpa_driver_ops {
1726 /** Name of the driver interface */
1728 /** One line description of the driver interface */
1732 * get_bssid - Get the current BSSID
1733 * @priv: private driver interface data
1734 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1736 * Returns: 0 on success, -1 on failure
1738 * Query kernel driver for the current BSSID and copy it to bssid.
1739 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1742 int (*get_bssid)(void *priv, u8 *bssid);
1745 * get_ssid - Get the current SSID
1746 * @priv: private driver interface data
1747 * @ssid: buffer for SSID (at least 32 bytes)
1749 * Returns: Length of the SSID on success, -1 on failure
1751 * Query kernel driver for the current SSID and copy it to ssid.
1752 * Returning zero is recommended if the STA is not associated.
1754 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1755 * can, at least in theory, contain control characters (including nul)
1756 * and as such, should be processed as binary data, not a printable
1759 int (*get_ssid)(void *priv, u8 *ssid);
1762 * set_key - Configure encryption key
1763 * @ifname: Interface name (for multi-SSID/VLAN support)
1764 * @priv: private driver interface data
1765 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
1766 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1767 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1768 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1769 * %WPA_ALG_BIP_CMAC_256);
1770 * %WPA_ALG_NONE clears the key.
1771 * @addr: Address of the peer STA (BSSID of the current AP when setting
1772 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1773 * broadcast keys, %NULL for default keys that are used both for
1774 * broadcast and unicast; when clearing keys, %NULL is used to
1775 * indicate that both the broadcast-only and default key of the
1776 * specified key index is to be cleared
1777 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1779 * @set_tx: configure this key as the default Tx key (only used when
1780 * driver does not support separate unicast/individual key
1781 * @seq: sequence number/packet number, seq_len octets, the next
1782 * packet number to be used for in replay protection; configured
1783 * for Rx keys (in most cases, this is only used with broadcast
1784 * keys and set to zero for unicast keys); %NULL if not set
1785 * @seq_len: length of the seq, depends on the algorithm:
1786 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
1787 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1789 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
1790 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
1792 * Returns: 0 on success, -1 on failure
1794 * Configure the given key for the kernel driver. If the driver
1795 * supports separate individual keys (4 default keys + 1 individual),
1796 * addr can be used to determine whether the key is default or
1797 * individual. If only 4 keys are supported, the default key with key
1798 * index 0 is used as the individual key. STA must be configured to use
1799 * it as the default Tx key (set_tx is set) and accept Rx for all the
1800 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1801 * broadcast keys, so key index 0 is available for this kind of
1804 * Please note that TKIP keys include separate TX and RX MIC keys and
1805 * some drivers may expect them in different order than wpa_supplicant
1806 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1807 * will trigger Michael MIC errors. This can be fixed by changing the
1808 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1809 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1810 * example on how this can be done.
1812 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1813 const u8 *addr, int key_idx, int set_tx,
1814 const u8 *seq, size_t seq_len,
1815 const u8 *key, size_t key_len);
1818 * init - Initialize driver interface
1819 * @ctx: context to be used when calling wpa_supplicant functions,
1820 * e.g., wpa_supplicant_event()
1821 * @ifname: interface name, e.g., wlan0
1823 * Returns: Pointer to private data, %NULL on failure
1825 * Initialize driver interface, including event processing for kernel
1826 * driver events (e.g., associated, scan results, Michael MIC failure).
1827 * This function can allocate a private configuration data area for
1828 * @ctx, file descriptor, interface name, etc. information that may be
1829 * needed in future driver operations. If this is not used, non-NULL
1830 * value will need to be returned because %NULL is used to indicate
1831 * failure. The returned value will be used as 'void *priv' data for
1832 * all other driver_ops functions.
1834 * The main event loop (eloop.c) of wpa_supplicant can be used to
1835 * register callback for read sockets (eloop_register_read_sock()).
1837 * See below for more information about events and
1838 * wpa_supplicant_event() function.
1840 void * (*init)(void *ctx, const char *ifname);
1843 * deinit - Deinitialize driver interface
1844 * @priv: private driver interface data from init()
1846 * Shut down driver interface and processing of driver events. Free
1847 * private data buffer if one was allocated in init() handler.
1849 void (*deinit)(void *priv);
1852 * set_param - Set driver configuration parameters
1853 * @priv: private driver interface data from init()
1854 * @param: driver specific configuration parameters
1856 * Returns: 0 on success, -1 on failure
1858 * Optional handler for notifying driver interface about configuration
1859 * parameters (driver_param).
1861 int (*set_param)(void *priv, const char *param);
1864 * set_countermeasures - Enable/disable TKIP countermeasures
1865 * @priv: private driver interface data
1866 * @enabled: 1 = countermeasures enabled, 0 = disabled
1868 * Returns: 0 on success, -1 on failure
1870 * Configure TKIP countermeasures. When these are enabled, the driver
1871 * should drop all received and queued frames that are using TKIP.
1873 int (*set_countermeasures)(void *priv, int enabled);
1876 * deauthenticate - Request driver to deauthenticate
1877 * @priv: private driver interface data
1878 * @addr: peer address (BSSID of the AP)
1879 * @reason_code: 16-bit reason code to be sent in the deauthentication
1882 * Returns: 0 on success, -1 on failure
1884 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1887 * associate - Request driver to associate
1888 * @priv: private driver interface data
1889 * @params: association parameters
1891 * Returns: 0 on success, -1 on failure
1893 int (*associate)(void *priv,
1894 struct wpa_driver_associate_params *params);
1897 * add_pmkid - Add PMKSA cache entry to the driver
1898 * @priv: private driver interface data
1899 * @bssid: BSSID for the PMKSA cache entry
1900 * @pmkid: PMKID for the PMKSA cache entry
1902 * Returns: 0 on success, -1 on failure
1904 * This function is called when a new PMK is received, as a result of
1905 * either normal authentication or RSN pre-authentication.
1907 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1908 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1909 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1910 * driver_ops function does not need to be implemented. Likewise, if
1911 * the driver does not support WPA, this function is not needed.
1913 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1916 * remove_pmkid - Remove PMKSA cache entry to the driver
1917 * @priv: private driver interface data
1918 * @bssid: BSSID for the PMKSA cache entry
1919 * @pmkid: PMKID for the PMKSA cache entry
1921 * Returns: 0 on success, -1 on failure
1923 * This function is called when the supplicant drops a PMKSA cache
1924 * entry for any reason.
1926 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1927 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1928 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1929 * from wpa_supplicant, this driver_ops function does not need to be
1930 * implemented. Likewise, if the driver does not support WPA, this
1931 * function is not needed.
1933 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1936 * flush_pmkid - Flush PMKSA cache
1937 * @priv: private driver interface data
1939 * Returns: 0 on success, -1 on failure
1941 * This function is called when the supplicant drops all PMKSA cache
1942 * entries for any reason.
1944 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1945 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1946 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1947 * from wpa_supplicant, this driver_ops function does not need to be
1948 * implemented. Likewise, if the driver does not support WPA, this
1949 * function is not needed.
1951 int (*flush_pmkid)(void *priv);
1954 * get_capa - Get driver capabilities
1955 * @priv: private driver interface data
1957 * Returns: 0 on success, -1 on failure
1959 * Get driver/firmware/hardware capabilities.
1961 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1964 * poll - Poll driver for association information
1965 * @priv: private driver interface data
1967 * This is an option callback that can be used when the driver does not
1968 * provide event mechanism for association events. This is called when
1969 * receiving WPA EAPOL-Key messages that require association
1970 * information. The driver interface is supposed to generate associnfo
1971 * event before returning from this callback function. In addition, the
1972 * driver interface should generate an association event after having
1973 * sent out associnfo.
1975 void (*poll)(void *priv);
1978 * get_ifindex - Get interface index
1979 * @priv: private driver interface data
1981 * Returns: Interface index
1983 unsigned int (*get_ifindex)(void *priv);
1986 * get_ifname - Get interface name
1987 * @priv: private driver interface data
1989 * Returns: Pointer to the interface name. This can differ from the
1990 * interface name used in init() call. Init() is called first.
1992 * This optional function can be used to allow the driver interface to
1993 * replace the interface name with something else, e.g., based on an
1994 * interface mapping from a more descriptive name.
1996 const char * (*get_ifname)(void *priv);
1999 * get_mac_addr - Get own MAC address
2000 * @priv: private driver interface data
2002 * Returns: Pointer to own MAC address or %NULL on failure
2004 * This optional function can be used to get the own MAC address of the
2005 * device from the driver interface code. This is only needed if the
2006 * l2_packet implementation for the OS does not provide easy access to
2008 const u8 * (*get_mac_addr)(void *priv);
2011 * set_operstate - Sets device operating state to DORMANT or UP
2012 * @priv: private driver interface data
2013 * @state: 0 = dormant, 1 = up
2014 * Returns: 0 on success, -1 on failure
2016 * This is an optional function that can be used on operating systems
2017 * that support a concept of controlling network device state from user
2018 * space applications. This function, if set, gets called with
2019 * state = 1 when authentication has been completed and with state = 0
2020 * when connection is lost.
2022 int (*set_operstate)(void *priv, int state);
2025 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2026 * @priv: Private driver interface data
2027 * @addr: Address of the station for which to set protection (may be
2028 * %NULL for group keys)
2029 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2030 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2031 * Returns: 0 on success, -1 on failure
2033 * This is an optional function that can be used to set the driver to
2034 * require protection for Tx and/or Rx frames. This uses the layer
2035 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2036 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2037 * set protection operation; instead, they set protection implicitly
2038 * based on configured keys.
2040 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2044 * get_hw_feature_data - Get hardware support data (channels and rates)
2045 * @priv: Private driver interface data
2046 * @num_modes: Variable for returning the number of returned modes
2047 * flags: Variable for returning hardware feature flags
2048 * Returns: Pointer to allocated hardware data on success or %NULL on
2049 * failure. Caller is responsible for freeing this.
2051 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2056 * send_mlme - Send management frame from MLME
2057 * @priv: Private driver interface data
2058 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2059 * @data_len: Size of the management frame
2060 * @noack: Do not wait for this frame to be acked (disable retries)
2061 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2063 * @csa_offs: Array of CSA offsets or %NULL
2064 * @csa_offs_len: Number of elements in csa_offs
2065 * Returns: 0 on success, -1 on failure
2067 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
2068 int noack, unsigned int freq, const u16 *csa_offs,
2069 size_t csa_offs_len);
2072 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2073 * @priv: Private driver interface data
2074 * @md: Mobility domain (2 octets) (also included inside ies)
2075 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2076 * @ies_len: Length of FT IEs in bytes
2077 * Returns: 0 on success, -1 on failure
2079 * The supplicant uses this callback to let the driver know that keying
2080 * material for FT is available and that the driver can use the
2081 * provided IEs in the next message in FT authentication sequence.
2083 * This function is only needed for driver that support IEEE 802.11r
2084 * (Fast BSS Transition).
2086 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2090 * get_scan_results2 - Fetch the latest scan results
2091 * @priv: private driver interface data
2093 * Returns: Allocated buffer of scan results (caller is responsible for
2094 * freeing the data structure) on success, NULL on failure
2096 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2099 * set_country - Set country
2100 * @priv: Private driver interface data
2101 * @alpha2: country to which to switch to
2102 * Returns: 0 on success, -1 on failure
2104 * This function is for drivers which support some form
2105 * of setting a regulatory domain.
2107 int (*set_country)(void *priv, const char *alpha2);
2110 * get_country - Get country
2111 * @priv: Private driver interface data
2112 * @alpha2: Buffer for returning country code (at least 3 octets)
2113 * Returns: 0 on success, -1 on failure
2115 int (*get_country)(void *priv, char *alpha2);
2118 * global_init - Global driver initialization
2119 * @ctx: wpa_global pointer
2120 * Returns: Pointer to private data (global), %NULL on failure
2122 * This optional function is called to initialize the driver wrapper
2123 * for global data, i.e., data that applies to all interfaces. If this
2124 * function is implemented, global_deinit() will also need to be
2125 * implemented to free the private data. The driver will also likely
2126 * use init2() function instead of init() to get the pointer to global
2127 * data available to per-interface initializer.
2129 void * (*global_init)(void *ctx);
2132 * global_deinit - Global driver deinitialization
2133 * @priv: private driver global data from global_init()
2135 * Terminate any global driver related functionality and free the
2136 * global data structure.
2138 void (*global_deinit)(void *priv);
2141 * init2 - Initialize driver interface (with global data)
2142 * @ctx: context to be used when calling wpa_supplicant functions,
2143 * e.g., wpa_supplicant_event()
2144 * @ifname: interface name, e.g., wlan0
2145 * @global_priv: private driver global data from global_init()
2146 * Returns: Pointer to private data, %NULL on failure
2148 * This function can be used instead of init() if the driver wrapper
2151 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2154 * get_interfaces - Get information about available interfaces
2155 * @global_priv: private driver global data from global_init()
2156 * Returns: Allocated buffer of interface information (caller is
2157 * responsible for freeing the data structure) on success, NULL on
2160 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2163 * scan2 - Request the driver to initiate scan
2164 * @priv: private driver interface data
2165 * @params: Scan parameters
2167 * Returns: 0 on success, -1 on failure
2169 * Once the scan results are ready, the driver should report scan
2170 * results event for wpa_supplicant which will eventually request the
2171 * results with wpa_driver_get_scan_results2().
2173 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2176 * authenticate - Request driver to authenticate
2177 * @priv: private driver interface data
2178 * @params: authentication parameters
2179 * Returns: 0 on success, -1 on failure
2181 * This is an optional function that can be used with drivers that
2182 * support separate authentication and association steps, i.e., when
2183 * wpa_supplicant can act as the SME. If not implemented, associate()
2184 * function is expected to take care of IEEE 802.11 authentication,
2187 int (*authenticate)(void *priv,
2188 struct wpa_driver_auth_params *params);
2191 * set_ap - Set Beacon and Probe Response information for AP mode
2192 * @priv: Private driver interface data
2193 * @params: Parameters to use in AP mode
2195 * This function is used to configure Beacon template and/or extra IEs
2196 * to add for Beacon and Probe Response frames for the driver in
2197 * AP mode. The driver is responsible for building the full Beacon
2198 * frame by concatenating the head part with TIM IE generated by the
2199 * driver/firmware and finishing with the tail part. Depending on the
2200 * driver architectue, this can be done either by using the full
2201 * template or the set of additional IEs (e.g., WPS and P2P IE).
2202 * Similarly, Probe Response processing depends on the driver design.
2203 * If the driver (or firmware) takes care of replying to Probe Request
2204 * frames, the extra IEs provided here needs to be added to the Probe
2207 * Returns: 0 on success, -1 on failure
2209 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
2212 * set_acl - Set ACL in AP mode
2213 * @priv: Private driver interface data
2214 * @params: Parameters to configure ACL
2215 * Returns: 0 on success, -1 on failure
2217 * This is used only for the drivers which support MAC address ACL.
2219 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2222 * hapd_init - Initialize driver interface (hostapd only)
2223 * @hapd: Pointer to hostapd context
2224 * @params: Configuration for the driver wrapper
2225 * Returns: Pointer to private data, %NULL on failure
2227 * This function is used instead of init() or init2() when the driver
2228 * wrapper is used with hostapd.
2230 void * (*hapd_init)(struct hostapd_data *hapd,
2231 struct wpa_init_params *params);
2234 * hapd_deinit - Deinitialize driver interface (hostapd only)
2235 * @priv: Private driver interface data from hapd_init()
2237 void (*hapd_deinit)(void *priv);
2240 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2241 * @priv: Private driver interface data
2242 * @params: BSS parameters
2243 * Returns: 0 on success, -1 on failure
2245 * This is an optional function to configure the kernel driver to
2246 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2247 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2248 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2249 * for Beacon frames.
2251 * DEPRECATED - use set_ap() instead
2253 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2256 * set_privacy - Enable/disable privacy (AP only)
2257 * @priv: Private driver interface data
2258 * @enabled: 1 = privacy enabled, 0 = disabled
2259 * Returns: 0 on success, -1 on failure
2261 * This is an optional function to configure privacy field in the
2262 * kernel driver for Beacon frames. This can be left undefined (set to
2263 * %NULL) if the driver uses the Beacon template from set_ap().
2265 * DEPRECATED - use set_ap() instead
2267 int (*set_privacy)(void *priv, int enabled);
2270 * get_seqnum - Fetch the current TSC/packet number (AP only)
2271 * @ifname: The interface name (main or virtual)
2272 * @priv: Private driver interface data
2273 * @addr: MAC address of the station or %NULL for group keys
2275 * @seq: Buffer for returning the latest used TSC/packet number
2276 * Returns: 0 on success, -1 on failure
2278 * This function is used to fetch the last used TSC/packet number for
2279 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2280 * keys, so there is no strict requirement on implementing support for
2281 * unicast keys (i.e., addr != %NULL).
2283 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2287 * flush - Flush all association stations (AP only)
2288 * @priv: Private driver interface data
2289 * Returns: 0 on success, -1 on failure
2291 * This function requests the driver to disassociate all associated
2292 * stations. This function does not need to be implemented if the
2293 * driver does not process association frames internally.
2295 int (*flush)(void *priv);
2298 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2299 * @priv: Private driver interface data
2300 * @elem: Information elements
2301 * @elem_len: Length of the elem buffer in octets
2302 * Returns: 0 on success, -1 on failure
2304 * This is an optional function to add information elements in the
2305 * kernel driver for Beacon and Probe Response frames. This can be left
2306 * undefined (set to %NULL) if the driver uses the Beacon template from
2309 * DEPRECATED - use set_ap() instead
2311 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2314 * read_sta_data - Fetch station data
2315 * @priv: Private driver interface data
2316 * @data: Buffer for returning station information
2317 * @addr: MAC address of the station
2318 * Returns: 0 on success, -1 on failure
2320 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2324 * hapd_send_eapol - Send an EAPOL packet (AP only)
2325 * @priv: private driver interface data
2326 * @addr: Destination MAC address
2327 * @data: EAPOL packet starting with IEEE 802.1X header
2328 * @data_len: Length of the EAPOL packet in octets
2329 * @encrypt: Whether the frame should be encrypted
2330 * @own_addr: Source MAC address
2331 * @flags: WPA_STA_* flags for the destination station
2333 * Returns: 0 on success, -1 on failure
2335 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2336 size_t data_len, int encrypt,
2337 const u8 *own_addr, u32 flags);
2340 * sta_deauth - Deauthenticate a station (AP only)
2341 * @priv: Private driver interface data
2342 * @own_addr: Source address and BSSID for the Deauthentication frame
2343 * @addr: MAC address of the station to deauthenticate
2344 * @reason: Reason code for the Deauthentiation frame
2345 * Returns: 0 on success, -1 on failure
2347 * This function requests a specific station to be deauthenticated and
2348 * a Deauthentication frame to be sent to it.
2350 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2354 * sta_disassoc - Disassociate a station (AP only)
2355 * @priv: Private driver interface data
2356 * @own_addr: Source address and BSSID for the Disassociation frame
2357 * @addr: MAC address of the station to disassociate
2358 * @reason: Reason code for the Disassociation frame
2359 * Returns: 0 on success, -1 on failure
2361 * This function requests a specific station to be disassociated and
2362 * a Disassociation frame to be sent to it.
2364 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2368 * sta_remove - Remove a station entry (AP only)
2369 * @priv: Private driver interface data
2370 * @addr: MAC address of the station to be removed
2371 * Returns: 0 on success, -1 on failure
2373 int (*sta_remove)(void *priv, const u8 *addr);
2376 * hapd_get_ssid - Get the current SSID (AP only)
2377 * @priv: Private driver interface data
2378 * @buf: Buffer for returning the SSID
2379 * @len: Maximum length of the buffer
2380 * Returns: Length of the SSID on success, -1 on failure
2382 * This function need not be implemented if the driver uses Beacon
2383 * template from set_ap() and does not reply to Probe Request frames.
2385 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2388 * hapd_set_ssid - Set SSID (AP only)
2389 * @priv: Private driver interface data
2391 * @len: Length of the SSID in octets
2392 * Returns: 0 on success, -1 on failure
2394 * DEPRECATED - use set_ap() instead
2396 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2399 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2400 * @priv: Private driver interface data
2401 * @enabled: 1 = countermeasures enabled, 0 = disabled
2402 * Returns: 0 on success, -1 on failure
2404 * This need not be implemented if the driver does not take care of
2405 * association processing.
2407 int (*hapd_set_countermeasures)(void *priv, int enabled);
2410 * sta_add - Add a station entry
2411 * @priv: Private driver interface data
2412 * @params: Station parameters
2413 * Returns: 0 on success, -1 on failure
2415 * This function is used to add or set (params->set 1) a station
2416 * entry in the driver. Adding STA entries is used only if the driver
2417 * does not take care of association processing.
2419 * With drivers that don't support full AP client state, this function
2420 * is used to add a station entry to the driver once the station has
2421 * completed association.
2423 * With TDLS, this function is used to add or set (params->set 1)
2424 * TDLS peer entries (even with drivers that do not support full AP
2427 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2430 * get_inact_sec - Get station inactivity duration (AP only)
2431 * @priv: Private driver interface data
2432 * @addr: Station address
2433 * Returns: Number of seconds station has been inactive, -1 on failure
2435 int (*get_inact_sec)(void *priv, const u8 *addr);
2438 * sta_clear_stats - Clear station statistics (AP only)
2439 * @priv: Private driver interface data
2440 * @addr: Station address
2441 * Returns: 0 on success, -1 on failure
2443 int (*sta_clear_stats)(void *priv, const u8 *addr);
2446 * set_freq - Set channel/frequency (AP only)
2447 * @priv: Private driver interface data
2448 * @freq: Channel parameters
2449 * Returns: 0 on success, -1 on failure
2451 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2454 * set_rts - Set RTS threshold
2455 * @priv: Private driver interface data
2456 * @rts: RTS threshold in octets
2457 * Returns: 0 on success, -1 on failure
2459 int (*set_rts)(void *priv, int rts);
2462 * set_frag - Set fragmentation threshold
2463 * @priv: Private driver interface data
2464 * @frag: Fragmentation threshold in octets
2465 * Returns: 0 on success, -1 on failure
2467 int (*set_frag)(void *priv, int frag);
2470 * sta_set_flags - Set station flags (AP only)
2471 * @priv: Private driver interface data
2472 * @addr: Station address
2473 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2474 * @flags_or: Bitmap of WPA_STA_* flags to add
2475 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2476 * Returns: 0 on success, -1 on failure
2478 int (*sta_set_flags)(void *priv, const u8 *addr,
2479 unsigned int total_flags, unsigned int flags_or,
2480 unsigned int flags_and);
2483 * set_tx_queue_params - Set TX queue parameters
2484 * @priv: Private driver interface data
2485 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2489 * @burst_time: Maximum length for bursting in 0.1 msec units
2491 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2492 int cw_max, int burst_time);
2495 * if_add - Add a virtual interface
2496 * @priv: Private driver interface data
2497 * @type: Interface type
2498 * @ifname: Interface name for the new virtual interface
2499 * @addr: Local address to use for the interface or %NULL to use the
2500 * parent interface address
2501 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2502 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2503 * not allowed (applies only to %WPA_IF_AP_BSS type)
2504 * @force_ifname: Buffer for returning an interface name that the
2505 * driver ended up using if it differs from the requested ifname
2506 * @if_addr: Buffer for returning the allocated interface address
2507 * (this may differ from the requested addr if the driver cannot
2508 * change interface address)
2509 * @bridge: Bridge interface to use or %NULL if no bridge configured
2510 * @use_existing: Whether to allow existing interface to be used
2511 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
2512 * Returns: 0 on success, -1 on failure
2514 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2515 const char *ifname, const u8 *addr, void *bss_ctx,
2516 void **drv_priv, char *force_ifname, u8 *if_addr,
2517 const char *bridge, int use_existing, int setup_ap);
2520 * if_remove - Remove a virtual interface
2521 * @priv: Private driver interface data
2522 * @type: Interface type
2523 * @ifname: Interface name of the virtual interface to be removed
2524 * Returns: 0 on success, -1 on failure
2526 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2527 const char *ifname);
2530 * set_sta_vlan - Bind a station into a specific interface (AP only)
2531 * @priv: Private driver interface data
2532 * @ifname: Interface (main or virtual BSS or VLAN)
2533 * @addr: MAC address of the associated station
2535 * Returns: 0 on success, -1 on failure
2537 * This function is used to bind a station to a specific virtual
2538 * interface. It is only used if when virtual interfaces are supported,
2539 * e.g., to assign stations to different VLAN interfaces based on
2540 * information from a RADIUS server. This allows separate broadcast
2541 * domains to be used with a single BSS.
2543 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2547 * commit - Optional commit changes handler (AP only)
2548 * @priv: driver private data
2549 * Returns: 0 on success, -1 on failure
2551 * This optional handler function can be registered if the driver
2552 * interface implementation needs to commit changes (e.g., by setting
2553 * network interface up) at the end of initial configuration. If set,
2554 * this handler will be called after initial setup has been completed.
2556 int (*commit)(void *priv);
2559 * send_ether - Send an ethernet packet (AP only)
2560 * @priv: private driver interface data
2561 * @dst: Destination MAC address
2562 * @src: Source MAC address
2564 * @data: EAPOL packet starting with IEEE 802.1X header
2565 * @data_len: Length of the EAPOL packet in octets
2566 * Returns: 0 on success, -1 on failure
2568 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2569 const u8 *data, size_t data_len);
2572 * set_radius_acl_auth - Notification of RADIUS ACL change
2573 * @priv: Private driver interface data
2574 * @mac: MAC address of the station
2575 * @accepted: Whether the station was accepted
2576 * @session_timeout: Session timeout for the station
2577 * Returns: 0 on success, -1 on failure
2579 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2580 u32 session_timeout);
2583 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2584 * @priv: Private driver interface data
2585 * @mac: MAC address of the station
2586 * Returns: 0 on success, -1 on failure
2588 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2591 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2592 * @priv: Private driver interface data
2593 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2594 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2596 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2597 * to remove extra IE(s)
2598 * Returns: 0 on success, -1 on failure
2600 * This is an optional function to add WPS IE in the kernel driver for
2601 * Beacon and Probe Response frames. This can be left undefined (set
2602 * to %NULL) if the driver uses the Beacon template from set_ap()
2603 * and does not process Probe Request frames. If the driver takes care
2604 * of (Re)Association frame processing, the assocresp buffer includes
2605 * WPS IE(s) that need to be added to (Re)Association Response frames
2606 * whenever a (Re)Association Request frame indicated use of WPS.
2608 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2609 * frames when operating as a GO. The driver is responsible for adding
2610 * timing related attributes (e.g., NoA) in addition to the IEs
2611 * included here by appending them after these buffers. This call is
2612 * also used to provide Probe Response IEs for P2P Listen state
2613 * operations for drivers that generate the Probe Response frames
2616 * DEPRECATED - use set_ap() instead
2618 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2619 const struct wpabuf *proberesp,
2620 const struct wpabuf *assocresp);
2623 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2624 * @priv: Private driver interface data
2625 * @authorized: Whether the port is authorized
2626 * Returns: 0 on success, -1 on failure
2628 int (*set_supp_port)(void *priv, int authorized);
2631 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2632 * @priv: Private driver interface data
2633 * @addr: MAC address of the associated station
2634 * @aid: Association ID
2635 * @val: 1 = bind to 4-address WDS; 0 = unbind
2636 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2637 * to indicate that bridge is not to be used
2638 * @ifname_wds: Buffer to return the interface name for the new WDS
2639 * station or %NULL to indicate name is not returned.
2640 * Returns: 0 on success, -1 on failure
2642 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
2643 const char *bridge_ifname, char *ifname_wds);
2646 * send_action - Transmit an Action frame
2647 * @priv: Private driver interface data
2648 * @freq: Frequency (in MHz) of the channel
2649 * @wait: Time to wait off-channel for a response (in ms), or zero
2650 * @dst: Destination MAC address (Address 1)
2651 * @src: Source MAC address (Address 2)
2652 * @bssid: BSSID (Address 3)
2654 * @data_len: data length in octets
2655 @ @no_cck: Whether CCK rates must not be used to transmit this frame
2656 * Returns: 0 on success, -1 on failure
2658 * This command can be used to request the driver to transmit an action
2659 * frame to the specified destination.
2661 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2662 * be transmitted on the given channel and the device will wait for a
2663 * response on that channel for the given wait time.
2665 * If the flag is not set, the wait time will be ignored. In this case,
2666 * if a remain-on-channel duration is in progress, the frame must be
2667 * transmitted on that channel; alternatively the frame may be sent on
2668 * the current operational channel (if in associated state in station
2669 * mode or while operating as an AP.)
2671 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2672 const u8 *dst, const u8 *src, const u8 *bssid,
2673 const u8 *data, size_t data_len, int no_cck);
2676 * send_action_cancel_wait - Cancel action frame TX wait
2677 * @priv: Private driver interface data
2679 * This command cancels the wait time associated with sending an action
2680 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2681 * set in the driver flags.
2683 void (*send_action_cancel_wait)(void *priv);
2686 * remain_on_channel - Remain awake on a channel
2687 * @priv: Private driver interface data
2688 * @freq: Frequency (in MHz) of the channel
2689 * @duration: Duration in milliseconds
2690 * Returns: 0 on success, -1 on failure
2692 * This command is used to request the driver to remain awake on the
2693 * specified channel for the specified duration and report received
2694 * Action frames with EVENT_RX_MGMT events. Optionally, received
2695 * Probe Request frames may also be requested to be reported by calling
2696 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2698 * The driver may not be at the requested channel when this function
2699 * returns, i.e., the return code is only indicating whether the
2700 * request was accepted. The caller will need to wait until the
2701 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2702 * completed the channel change. This may take some time due to other
2703 * need for the radio and the caller should be prepared to timing out
2704 * its wait since there are no guarantees on when this request can be
2707 int (*remain_on_channel)(void *priv, unsigned int freq,
2708 unsigned int duration);
2711 * cancel_remain_on_channel - Cancel remain-on-channel operation
2712 * @priv: Private driver interface data
2714 * This command can be used to cancel a remain-on-channel operation
2715 * before its originally requested duration has passed. This could be
2716 * used, e.g., when remain_on_channel() is used to request extra time
2717 * to receive a response to an Action frame and the response is
2718 * received when there is still unneeded time remaining on the
2719 * remain-on-channel operation.
2721 int (*cancel_remain_on_channel)(void *priv);
2724 * probe_req_report - Request Probe Request frames to be indicated
2725 * @priv: Private driver interface data
2726 * @report: Whether to report received Probe Request frames
2727 * Returns: 0 on success, -1 on failure (or if not supported)
2729 * This command can be used to request the driver to indicate when
2730 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2731 * Since this operation may require extra resources, e.g., due to less
2732 * optimal hardware/firmware RX filtering, many drivers may disable
2733 * Probe Request reporting at least in station mode. This command is
2734 * used to notify the driver when the Probe Request frames need to be
2735 * reported, e.g., during remain-on-channel operations.
2737 int (*probe_req_report)(void *priv, int report);
2740 * deinit_ap - Deinitialize AP mode
2741 * @priv: Private driver interface data
2742 * Returns: 0 on success, -1 on failure (or if not supported)
2744 * This optional function can be used to disable AP mode related
2745 * configuration. If the interface was not dynamically added,
2746 * change the driver mode to station mode to allow normal station
2747 * operations like scanning to be completed.
2749 int (*deinit_ap)(void *priv);
2752 * deinit_p2p_cli - Deinitialize P2P client mode
2753 * @priv: Private driver interface data
2754 * Returns: 0 on success, -1 on failure (or if not supported)
2756 * This optional function can be used to disable P2P client mode. If the
2757 * interface was not dynamically added, change the interface type back
2760 int (*deinit_p2p_cli)(void *priv);
2763 * suspend - Notification on system suspend/hibernate event
2764 * @priv: Private driver interface data
2766 void (*suspend)(void *priv);
2769 * resume - Notification on system resume/thaw event
2770 * @priv: Private driver interface data
2772 void (*resume)(void *priv);
2775 * signal_monitor - Set signal monitoring parameters
2776 * @priv: Private driver interface data
2777 * @threshold: Threshold value for signal change events; 0 = disabled
2778 * @hysteresis: Minimum change in signal strength before indicating a
2780 * Returns: 0 on success, -1 on failure (or if not supported)
2782 * This function can be used to configure monitoring of signal strength
2783 * with the current AP. Whenever signal strength drops below the
2784 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2785 * should be generated assuming the signal strength has changed at
2786 * least %hysteresis from the previously indicated signal change event.
2788 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2791 * send_frame - Send IEEE 802.11 frame (testing use only)
2792 * @priv: Private driver interface data
2793 * @data: IEEE 802.11 frame with IEEE 802.11 header
2794 * @data_len: Size of the frame
2795 * @encrypt: Whether to encrypt the frame (if keys are set)
2796 * Returns: 0 on success, -1 on failure
2798 * This function is only used for debugging purposes and is not
2799 * required to be implemented for normal operations.
2801 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2805 * get_noa - Get current Notice of Absence attribute payload
2806 * @priv: Private driver interface data
2807 * @buf: Buffer for returning NoA
2808 * @buf_len: Buffer length in octets
2809 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2810 * advertized, or -1 on failure
2812 * This function is used to fetch the current Notice of Absence
2813 * attribute value from GO.
2815 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2818 * set_noa - Set Notice of Absence parameters for GO (testing)
2819 * @priv: Private driver interface data
2821 * @start: Start time in ms from next TBTT
2822 * @duration: Duration in ms
2823 * Returns: 0 on success or -1 on failure
2825 * This function is used to set Notice of Absence parameters for GO. It
2826 * is used only for testing. To disable NoA, all parameters are set to
2829 int (*set_noa)(void *priv, u8 count, int start, int duration);
2832 * set_p2p_powersave - Set P2P power save options
2833 * @priv: Private driver interface data
2834 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2835 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2836 * @ctwindow: 0.. = change (msec), -1 = no change
2837 * Returns: 0 on success or -1 on failure
2839 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2843 * ampdu - Enable/disable aggregation
2844 * @priv: Private driver interface data
2845 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2846 * Returns: 0 on success or -1 on failure
2848 int (*ampdu)(void *priv, int ampdu);
2851 * get_radio_name - Get physical radio name for the device
2852 * @priv: Private driver interface data
2853 * Returns: Radio name or %NULL if not known
2855 * The returned data must not be modified by the caller. It is assumed
2856 * that any interface that has the same radio name as another is
2857 * sharing the same physical radio. This information can be used to
2858 * share scan results etc. information between the virtual interfaces
2859 * to speed up various operations.
2861 const char * (*get_radio_name)(void *priv);
2864 * send_tdls_mgmt - for sending TDLS management packets
2865 * @priv: private driver interface data
2866 * @dst: Destination (peer) MAC address
2867 * @action_code: TDLS action code for the mssage
2868 * @dialog_token: Dialog Token to use in the message (if needed)
2869 * @status_code: Status Code or Reason Code to use (if needed)
2870 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
2871 * @initiator: Is the current end the TDLS link initiator
2872 * @buf: TDLS IEs to add to the message
2873 * @len: Length of buf in octets
2874 * Returns: 0 on success, negative (<0) on failure
2876 * This optional function can be used to send packet to driver which is
2877 * responsible for receiving and sending all TDLS packets.
2879 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2880 u8 dialog_token, u16 status_code, u32 peer_capab,
2881 int initiator, const u8 *buf, size_t len);
2884 * tdls_oper - Ask the driver to perform high-level TDLS operations
2885 * @priv: Private driver interface data
2886 * @oper: TDLS high-level operation. See %enum tdls_oper
2887 * @peer: Destination (peer) MAC address
2888 * Returns: 0 on success, negative (<0) on failure
2890 * This optional function can be used to send high-level TDLS commands
2893 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2896 * wnm_oper - Notify driver of the WNM frame reception
2897 * @priv: Private driver interface data
2898 * @oper: WNM operation. See %enum wnm_oper
2899 * @peer: Destination (peer) MAC address
2900 * @buf: Buffer for the driver to fill in (for getting IE)
2901 * @buf_len: Return the len of buf
2902 * Returns: 0 on success, negative (<0) on failure
2904 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2905 u8 *buf, u16 *buf_len);
2908 * set_qos_map - Set QoS Map
2909 * @priv: Private driver interface data
2910 * @qos_map_set: QoS Map
2911 * @qos_map_set_len: Length of QoS Map
2913 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2914 u8 qos_map_set_len);
2917 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2918 * @priv: Private driver interface data
2919 * @version: IP version of the IP address, 4 or 6
2920 * @ipaddr: IP address for the neigh entry
2921 * @prefixlen: IP address prefix length
2922 * @addr: Corresponding MAC address
2923 * Returns: 0 on success, negative (<0) on failure
2925 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2926 int prefixlen, const u8 *addr);
2929 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2930 * @priv: Private driver interface data
2931 * @version: IP version of the IP address, 4 or 6
2932 * @ipaddr: IP address for the neigh entry
2933 * Returns: 0 on success, negative (<0) on failure
2935 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2938 * br_port_set_attr - Set a bridge port attribute
2939 * @attr: Bridge port attribute to set
2940 * @val: Value to be set
2941 * Returns: 0 on success, negative (<0) on failure
2943 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2947 * br_port_set_attr - Set a bridge network parameter
2948 * @param: Bridge parameter to set
2949 * @val: Value to be set
2950 * Returns: 0 on success, negative (<0) on failure
2952 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2956 * set_wowlan - Set wake-on-wireless triggers
2957 * @priv: Private driver interface data
2958 * @triggers: wowlan triggers
2960 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2963 * signal_poll - Get current connection information
2964 * @priv: Private driver interface data
2965 * @signal_info: Connection info structure
2967 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
2970 * set_authmode - Set authentication algorithm(s) for static WEP
2971 * @priv: Private driver interface data
2972 * @authmode: 1=Open System, 2=Shared Key, 3=both
2973 * Returns: 0 on success, -1 on failure
2975 * This function can be used to set authentication algorithms for AP
2976 * mode when static WEP is used. If the driver uses user space MLME/SME
2977 * implementation, there is no need to implement this function.
2979 * DEPRECATED - use set_ap() instead
2981 int (*set_authmode)(void *priv, int authmode);
2985 * driver_cmd - Execute driver-specific command
2986 * @priv: Private driver interface data
2987 * @cmd: Command to execute
2988 * @buf: Return buffer
2989 * @buf_len: Buffer length
2990 * Returns: 0 on success, -1 on failure
2992 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2993 #endif /* ANDROID */
2996 * vendor_cmd - Execute vendor specific command
2997 * @priv: Private driver interface data
2998 * @vendor_id: Vendor id
2999 * @subcmd: Vendor command id
3000 * @data: Vendor command parameters (%NULL if no parameters)
3001 * @data_len: Data length
3002 * @buf: Return buffer (%NULL to ignore reply)
3003 * Returns: 0 on success, negative (<0) on failure
3005 * This function handles vendor specific commands that are passed to
3006 * the driver/device. The command is identified by vendor id and
3007 * command id. Parameters can be passed as argument to the command
3008 * in the data buffer. Reply (if any) will be filled in the supplied
3011 * The exact driver behavior is driver interface and vendor specific. As
3012 * an example, this will be converted to a vendor specific cfg80211
3013 * command in case of the nl80211 driver interface.
3015 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3016 unsigned int subcmd, const u8 *data, size_t data_len,
3017 struct wpabuf *buf);
3020 * set_rekey_info - Set rekey information
3021 * @priv: Private driver interface data
3023 * @kek_len: KEK length in octets
3025 * @kck_len: KCK length in octets
3026 * @replay_ctr: Current EAPOL-Key Replay Counter
3028 * This optional function can be used to provide information for the
3029 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3030 * while the host (including wpa_supplicant) is sleeping.
3032 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3033 const u8 *kck, size_t kck_len,
3034 const u8 *replay_ctr);
3037 * sta_assoc - Station association indication
3038 * @priv: Private driver interface data
3039 * @own_addr: Source address and BSSID for association frame
3040 * @addr: MAC address of the station to associate
3041 * @reassoc: flag to indicate re-association
3042 * @status: association response status code
3043 * @ie: assoc response ie buffer
3044 * @len: ie buffer length
3045 * Returns: 0 on success, -1 on failure
3047 * This function indicates the driver to send (Re)Association
3048 * Response frame to the station.
3050 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3051 int reassoc, u16 status, const u8 *ie, size_t len);
3054 * sta_auth - Station authentication indication
3055 * @priv: Private driver interface data
3056 * @own_addr: Source address and BSSID for authentication frame
3057 * @addr: MAC address of the station to associate
3058 * @seq: authentication sequence number
3059 * @status: authentication response status code
3060 * @ie: authentication frame ie buffer
3061 * @len: ie buffer length
3063 * This function indicates the driver to send Authentication frame
3066 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
3067 u16 seq, u16 status, const u8 *ie, size_t len);
3070 * add_tspec - Add traffic stream
3071 * @priv: Private driver interface data
3072 * @addr: MAC address of the station to associate
3073 * @tspec_ie: tspec ie buffer
3074 * @tspec_ielen: tspec ie length
3075 * Returns: 0 on success, -1 on failure
3077 * This function adds the traffic steam for the station
3078 * and fills the medium_time in tspec_ie.
3080 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3081 size_t tspec_ielen);
3084 * add_sta_node - Add a station node in the driver
3085 * @priv: Private driver interface data
3086 * @addr: MAC address of the station to add
3087 * @auth_alg: authentication algorithm used by the station
3088 * Returns: 0 on success, -1 on failure
3090 * This function adds the station node in the driver, when
3091 * the station gets added by FT-over-DS.
3093 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
3096 * sched_scan - Request the driver to initiate scheduled scan
3097 * @priv: Private driver interface data
3098 * @params: Scan parameters
3099 * Returns: 0 on success, -1 on failure
3101 * This operation should be used for scheduled scan offload to
3102 * the hardware. Every time scan results are available, the
3103 * driver should report scan results event for wpa_supplicant
3104 * which will eventually request the results with
3105 * wpa_driver_get_scan_results2(). This operation is optional
3106 * and if not provided or if it returns -1, we fall back to
3107 * normal host-scheduled scans.
3109 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
3112 * stop_sched_scan - Request the driver to stop a scheduled scan
3113 * @priv: Private driver interface data
3114 * Returns: 0 on success, -1 on failure
3116 * This should cause the scheduled scan to be stopped and
3117 * results should stop being sent. Must be supported if
3118 * sched_scan is supported.
3120 int (*stop_sched_scan)(void *priv);
3123 * poll_client - Probe (null data or such) the given station
3124 * @priv: Private driver interface data
3125 * @own_addr: MAC address of sending interface
3126 * @addr: MAC address of the station to probe
3127 * @qos: Indicates whether station is QoS station
3129 * This function is used to verify whether an associated station is
3130 * still present. This function does not need to be implemented if the
3131 * driver provides such inactivity polling mechanism.
3133 void (*poll_client)(void *priv, const u8 *own_addr,
3134 const u8 *addr, int qos);
3137 * radio_disable - Disable/enable radio
3138 * @priv: Private driver interface data
3139 * @disabled: 1=disable 0=enable radio
3140 * Returns: 0 on success, -1 on failure
3142 * This optional command is for testing purposes. It can be used to
3143 * disable the radio on a testbed device to simulate out-of-radio-range
3146 int (*radio_disable)(void *priv, int disabled);
3149 * switch_channel - Announce channel switch and migrate the GO to the
3151 * @priv: Private driver interface data
3152 * @settings: Settings for CSA period and new channel
3153 * Returns: 0 on success, -1 on failure
3155 * This function is used to move the GO to the legacy STA channel to
3156 * avoid frequency conflict in single channel concurrency.
3158 int (*switch_channel)(void *priv, struct csa_settings *settings);
3161 * add_tx_ts - Add traffic stream
3162 * @priv: Private driver interface data
3163 * @tsid: Traffic stream ID
3164 * @addr: Receiver address
3165 * @user_prio: User priority of the traffic stream
3166 * @admitted_time: Admitted time for this TS in units of
3167 * 32 microsecond periods (per second).
3168 * Returns: 0 on success, -1 on failure
3170 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3174 * del_tx_ts - Delete traffic stream
3175 * @priv: Private driver interface data
3176 * @tsid: Traffic stream ID
3177 * @addr: Receiver address
3178 * Returns: 0 on success, -1 on failure
3180 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3183 * Enable channel-switching with TDLS peer
3184 * @priv: Private driver interface data
3185 * @addr: MAC address of the TDLS peer
3186 * @oper_class: Operating class of the switch channel
3187 * @params: Channel specification
3188 * Returns: 0 on success, -1 on failure
3190 * The function indicates to driver that it can start switching to a
3191 * different channel with a specified TDLS peer. The switching is
3192 * assumed on until canceled with tdls_disable_channel_switch().
3194 int (*tdls_enable_channel_switch)(
3195 void *priv, const u8 *addr, u8 oper_class,
3196 const struct hostapd_freq_params *params);
3199 * Disable channel switching with TDLS peer
3200 * @priv: Private driver interface data
3201 * @addr: MAC address of the TDLS peer
3202 * Returns: 0 on success, -1 on failure
3204 * This function indicates to the driver that it should stop switching
3205 * with a given TDLS peer.
3207 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3210 * start_dfs_cac - Listen for radar interference on the channel
3211 * @priv: Private driver interface data
3212 * @freq: Channel parameters
3213 * Returns: 0 on success, -1 on failure
3215 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
3218 * stop_ap - Removes beacon from AP
3219 * @priv: Private driver interface data
3220 * Returns: 0 on success, -1 on failure (or if not supported)
3222 * This optional function can be used to disable AP mode related
3223 * configuration. Unlike deinit_ap, it does not change to station
3226 int (*stop_ap)(void *priv);
3229 * get_survey - Retrieve survey data
3230 * @priv: Private driver interface data
3231 * @freq: If set, survey data for the specified frequency is only
3232 * being requested. If not set, all survey data is requested.
3233 * Returns: 0 on success, -1 on failure
3235 * Use this to retrieve:
3237 * - the observed channel noise floor
3238 * - the amount of time we have spent on the channel
3239 * - the amount of time during which we have spent on the channel that
3240 * the radio has determined the medium is busy and we cannot
3242 * - the amount of time we have spent receiving data
3243 * - the amount of time we have spent transmitting data
3245 * This data can be used for spectrum heuristics. One example is
3246 * Automatic Channel Selection (ACS). The channel survey data is
3247 * kept on a linked list on the channel data, one entry is added
3248 * for each survey. The min_nf of the channel is updated for each
3251 int (*get_survey)(void *priv, unsigned int freq);
3254 * status - Get driver interface status information
3255 * @priv: Private driver interface data
3256 * @buf: Buffer for printing tou the status information
3257 * @buflen: Maximum length of the buffer
3258 * Returns: Length of written status information or -1 on failure
3260 int (*status)(void *priv, char *buf, size_t buflen);
3263 * roaming - Set roaming policy for driver-based BSS selection
3264 * @priv: Private driver interface data
3265 * @allowed: Whether roaming within ESS is allowed
3266 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3267 * Returns: Length of written status information or -1 on failure
3269 * This optional callback can be used to update roaming policy from the
3270 * associate() command (bssid being set there indicates that the driver
3271 * should not roam before getting this roaming() call to allow roaming.
3272 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3273 * capability, roaming policy is handled within wpa_supplicant and there
3274 * is no need to implement or react to this callback.
3276 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3279 * set_mac_addr - Set MAC address
3280 * @priv: Private driver interface data
3281 * @addr: MAC address to use or %NULL for setting back to permanent
3282 * Returns: 0 on success, -1 on failure
3284 int (*set_mac_addr)(void *priv, const u8 *addr);
3286 #ifdef CONFIG_MACSEC
3287 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3289 int (*macsec_deinit)(void *priv);
3292 * enable_protect_frames - Set protect frames status
3293 * @priv: Private driver interface data
3294 * @enabled: TRUE = protect frames enabled
3295 * FALSE = protect frames disabled
3296 * Returns: 0 on success, -1 on failure (or if not supported)
3298 int (*enable_protect_frames)(void *priv, Boolean enabled);
3301 * set_replay_protect - Set replay protect status and window size
3302 * @priv: Private driver interface data
3303 * @enabled: TRUE = replay protect enabled
3304 * FALSE = replay protect disabled
3305 * @window: replay window size, valid only when replay protect enabled
3306 * Returns: 0 on success, -1 on failure (or if not supported)
3308 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3311 * set_current_cipher_suite - Set current cipher suite
3312 * @priv: Private driver interface data
3313 * @cs: EUI64 identifier
3314 * @cs_len: Length of the cs buffer in octets
3315 * Returns: 0 on success, -1 on failure (or if not supported)
3317 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3321 * enable_controlled_port - Set controlled port status
3322 * @priv: Private driver interface data
3323 * @enabled: TRUE = controlled port enabled
3324 * FALSE = controlled port disabled
3325 * Returns: 0 on success, -1 on failure (or if not supported)
3327 int (*enable_controlled_port)(void *priv, Boolean enabled);
3330 * get_receive_lowest_pn - Get receive lowest pn
3331 * @priv: Private driver interface data
3332 * @channel: secure channel
3333 * @an: association number
3334 * @lowest_pn: lowest accept pn
3335 * Returns: 0 on success, -1 on failure (or if not supported)
3337 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3341 * get_transmit_next_pn - Get transmit next pn
3342 * @priv: Private driver interface data
3343 * @channel: secure channel
3344 * @an: association number
3346 * Returns: 0 on success, -1 on failure (or if not supported)
3348 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3352 * set_transmit_next_pn - Set transmit next pn
3353 * @priv: Private driver interface data
3354 * @channel: secure channel
3355 * @an: association number
3357 * Returns: 0 on success, -1 on failure (or if not supported)
3359 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3363 * get_available_receive_sc - get available receive channel
3364 * @priv: Private driver interface data
3365 * @channel: secure channel
3366 * Returns: 0 on success, -1 on failure (or if not supported)
3368 int (*get_available_receive_sc)(void *priv, u32 *channel);
3371 * create_receive_sc - create secure channel for receiving
3372 * @priv: Private driver interface data
3373 * @channel: secure channel
3374 * @sci_addr: secure channel identifier - address
3375 * @sci_port: secure channel identifier - port
3376 * @conf_offset: confidentiality offset (0, 30, or 50)
3377 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3379 * Returns: 0 on success, -1 on failure (or if not supported)
3381 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3382 u16 sci_port, unsigned int conf_offset,
3386 * delete_receive_sc - delete secure connection for receiving
3387 * @priv: private driver interface data from init()
3388 * @channel: secure channel
3389 * Returns: 0 on success, -1 on failure
3391 int (*delete_receive_sc)(void *priv, u32 channel);
3394 * create_receive_sa - create secure association for receive
3395 * @priv: private driver interface data from init()
3396 * @channel: secure channel
3397 * @an: association number
3398 * @lowest_pn: the lowest packet number can be received
3399 * @sak: the secure association key
3400 * Returns: 0 on success, -1 on failure
3402 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3403 u32 lowest_pn, const u8 *sak);
3406 * enable_receive_sa - enable the SA for receive
3407 * @priv: private driver interface data from init()
3408 * @channel: secure channel
3409 * @an: association number
3410 * Returns: 0 on success, -1 on failure
3412 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3415 * disable_receive_sa - disable SA for receive
3416 * @priv: private driver interface data from init()
3417 * @channel: secure channel index
3418 * @an: association number
3419 * Returns: 0 on success, -1 on failure
3421 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3424 * get_available_transmit_sc - get available transmit channel
3425 * @priv: Private driver interface data
3426 * @channel: secure channel
3427 * Returns: 0 on success, -1 on failure (or if not supported)
3429 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3432 * create_transmit_sc - create secure connection for transmit
3433 * @priv: private driver interface data from init()
3434 * @channel: secure channel
3435 * @sci_addr: secure channel identifier - address
3436 * @sci_port: secure channel identifier - port
3437 * Returns: 0 on success, -1 on failure
3439 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3440 u16 sci_port, unsigned int conf_offset);
3443 * delete_transmit_sc - delete secure connection for transmit
3444 * @priv: private driver interface data from init()
3445 * @channel: secure channel
3446 * Returns: 0 on success, -1 on failure
3448 int (*delete_transmit_sc)(void *priv, u32 channel);
3451 * create_transmit_sa - create secure association for transmit
3452 * @priv: private driver interface data from init()
3453 * @channel: secure channel index
3454 * @an: association number
3455 * @next_pn: the packet number used as next transmit packet
3456 * @confidentiality: True if the SA is to provide confidentiality
3457 * as well as integrity
3458 * @sak: the secure association key
3459 * Returns: 0 on success, -1 on failure
3461 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3462 Boolean confidentiality, const u8 *sak);
3465 * enable_transmit_sa - enable SA for transmit
3466 * @priv: private driver interface data from init()
3467 * @channel: secure channel
3468 * @an: association number
3469 * Returns: 0 on success, -1 on failure
3471 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3474 * disable_transmit_sa - disable SA for transmit
3475 * @priv: private driver interface data from init()
3476 * @channel: secure channel
3477 * @an: association number
3478 * Returns: 0 on success, -1 on failure
3480 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3481 #endif /* CONFIG_MACSEC */
3484 * init_mesh - Driver specific initialization for mesh
3485 * @priv: Private driver interface data
3486 * Returns: 0 on success, -1 on failure
3488 int (*init_mesh)(void *priv);
3491 * join_mesh - Join a mesh network
3492 * @priv: Private driver interface data
3493 * @params: Mesh configuration parameters
3494 * Returns: 0 on success, -1 on failure
3496 int (*join_mesh)(void *priv,
3497 struct wpa_driver_mesh_join_params *params);
3500 * leave_mesh - Leave a mesh network
3501 * @priv: Private driver interface data
3502 * Returns 0 on success, -1 on failure
3504 int (*leave_mesh)(void *priv);
3507 * do_acs - Automatically select channel
3508 * @priv: Private driver interface data
3509 * @params: Parameters for ACS
3510 * Returns 0 on success, -1 on failure
3512 * This command can be used to offload ACS to the driver if the driver
3513 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3515 int (*do_acs)(void *priv, struct drv_acs_params *params);
3518 * set_band - Notify driver of band selection
3519 * @priv: Private driver interface data
3520 * @band: The selected band(s)
3521 * Returns 0 on success, -1 on failure
3523 int (*set_band)(void *priv, enum set_band band);
3526 * get_pref_freq_list - Get preferred frequency list for an interface
3527 * @priv: Private driver interface data
3528 * @if_type: Interface type
3529 * @num: Number of channels
3530 * @freq_list: Preferred channel frequency list encoded in MHz values
3531 * Returns 0 on success, -1 on failure
3533 * This command can be used to query the preferred frequency list from
3534 * the driver specific to a particular interface type.
3536 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
3537 unsigned int *num, unsigned int *freq_list);
3540 * set_prob_oper_freq - Indicate probable P2P operating channel
3541 * @priv: Private driver interface data
3542 * @freq: Channel frequency in MHz
3543 * Returns 0 on success, -1 on failure
3545 * This command can be used to inform the driver of the operating
3546 * frequency that an ongoing P2P group formation is likely to come up
3547 * on. Local device is assuming P2P Client role.
3549 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
3552 * abort_scan - Request the driver to abort an ongoing scan
3553 * @priv: Private driver interface data
3554 * Returns 0 on success, -1 on failure
3556 int (*abort_scan)(void *priv);
3559 * configure_data_frame_filters - Request to configure frame filters
3560 * @priv: Private driver interface data
3561 * @filter_flags: The type of frames to filter (bitfield of
3562 * WPA_DATA_FRAME_FILTER_FLAG_*)
3563 * Returns: 0 on success or -1 on failure
3565 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
3568 * get_ext_capab - Get extended capabilities for the specified interface
3569 * @priv: Private driver interface data
3570 * @type: Interface type for which to get extended capabilities
3571 * @ext_capab: Extended capabilities fetched
3572 * @ext_capab_mask: Extended capabilities mask
3573 * @ext_capab_len: Length of the extended capabilities
3574 * Returns: 0 on success or -1 on failure
3576 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
3577 const u8 **ext_capab, const u8 **ext_capab_mask,
3578 unsigned int *ext_capab_len);
3581 * p2p_lo_start - Start offloading P2P listen to device
3582 * @priv: Private driver interface data
3583 * @freq: Listening frequency (MHz) for P2P listen
3584 * @period: Length of the listen operation in milliseconds
3585 * @interval: Interval for running the listen operation in milliseconds
3586 * @count: Number of times to run the listen operation
3587 * @device_types: Device primary and secondary types
3588 * @dev_types_len: Number of bytes for device_types
3589 * @ies: P2P IE and WSC IE for Probe Response frames
3590 * @ies_len: Length of ies in bytes
3591 * Returns: 0 on success or -1 on failure
3593 int (*p2p_lo_start)(void *priv, unsigned int freq,
3594 unsigned int period, unsigned int interval,
3596 const u8 *device_types, size_t dev_types_len,
3597 const u8 *ies, size_t ies_len);
3600 * p2p_lo_stop - Stop P2P listen offload
3601 * @priv: Private driver interface data
3602 * Returns: 0 on success or -1 on failure
3604 int (*p2p_lo_stop)(void *priv);
3609 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3611 enum wpa_event_type {
3613 * EVENT_ASSOC - Association completed
3615 * This event needs to be delivered when the driver completes IEEE
3616 * 802.11 association or reassociation successfully.
3617 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3618 * after this event has been generated. In addition, optional
3619 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3620 * more information about the association. If the driver interface gets
3621 * both of these events at the same time, it can also include the
3622 * assoc_info data in EVENT_ASSOC call.
3627 * EVENT_DISASSOC - Association lost
3629 * This event should be called when association is lost either due to
3630 * receiving deauthenticate or disassociate frame from the AP or when
3631 * sending either of these frames to the current AP. If the driver
3632 * supports separate deauthentication event, EVENT_DISASSOC should only
3633 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3634 * In AP mode, union wpa_event_data::disassoc_info is required.
3639 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3641 * This event must be delivered when a Michael MIC error is detected by
3642 * the local driver. Additional data for event processing is
3643 * provided with union wpa_event_data::michael_mic_failure. This
3644 * information is used to request new encyption key and to initiate
3645 * TKIP countermeasures if needed.
3647 EVENT_MICHAEL_MIC_FAILURE,
3650 * EVENT_SCAN_RESULTS - Scan results available
3652 * This event must be called whenever scan results are available to be
3653 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3654 * is expected to be used some time after struct wpa_driver_ops::scan()
3655 * is called. If the driver provides an unsolicited event when the scan
3656 * has been completed, this event can be used to trigger
3657 * EVENT_SCAN_RESULTS call. If such event is not available from the
3658 * driver, the driver wrapper code is expected to use a registered
3659 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3660 * scan is expected to be completed. Optional information about
3661 * completed scan can be provided with union wpa_event_data::scan_info.
3666 * EVENT_ASSOCINFO - Report optional extra information for association
3668 * This event can be used to report extra association information for
3669 * EVENT_ASSOC processing. This extra information includes IEs from
3670 * association frames and Beacon/Probe Response frames in union
3671 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3672 * EVENT_ASSOC. Alternatively, the driver interface can include
3673 * assoc_info data in the EVENT_ASSOC call if it has all the
3674 * information available at the same point.
3679 * EVENT_INTERFACE_STATUS - Report interface status changes
3681 * This optional event can be used to report changes in interface
3682 * status (interface added/removed) using union
3683 * wpa_event_data::interface_status. This can be used to trigger
3684 * wpa_supplicant to stop and re-start processing for the interface,
3685 * e.g., when a cardbus card is ejected/inserted.
3687 EVENT_INTERFACE_STATUS,
3690 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3692 * This event can be used to inform wpa_supplicant about candidates for
3693 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3694 * for scan request (ap_scan=2 mode), this event is required for
3695 * pre-authentication. If wpa_supplicant is performing scan request
3696 * (ap_scan=1), this event is optional since scan results can be used
3697 * to add pre-authentication candidates. union
3698 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3699 * candidate and priority of the candidate, e.g., based on the signal
3700 * strength, in order to try to pre-authenticate first with candidates
3701 * that are most likely targets for re-association.
3703 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3704 * on the candidate list. In addition, it can be called for the current
3705 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3706 * will automatically skip pre-authentication in cases where a valid
3707 * PMKSA exists. When more than one candidate exists, this event should
3708 * be generated once for each candidate.
3710 * Driver will be notified about successful pre-authentication with
3711 * struct wpa_driver_ops::add_pmkid() calls.
3713 EVENT_PMKID_CANDIDATE,
3716 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3718 * This event can be used to inform wpa_supplicant about desire to set
3719 * up secure direct link connection between two stations as defined in
3720 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3721 * STAKey negotiation. The caller will need to set peer address for the
3727 * EVENT_TDLS - Request TDLS operation
3729 * This event can be used to request a TDLS operation to be performed.
3734 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3736 * The driver is expected to report the received FT IEs from
3737 * FT authentication sequence from the AP. The FT IEs are included in
3738 * the extra information in union wpa_event_data::ft_ies.
3743 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3745 * The driver can use this event to inform wpa_supplicant about a STA
3746 * in an IBSS with which protected frames could be exchanged. This
3747 * event starts RSN authentication with the other STA to authenticate
3748 * the STA and set up encryption keys with it.
3750 EVENT_IBSS_RSN_START,
3753 * EVENT_AUTH - Authentication result
3755 * This event should be called when authentication attempt has been
3756 * completed. This is only used if the driver supports separate
3757 * authentication step (struct wpa_driver_ops::authenticate).
3758 * Information about authentication result is included in
3759 * union wpa_event_data::auth.
3764 * EVENT_DEAUTH - Authentication lost
3766 * This event should be called when authentication is lost either due
3767 * to receiving deauthenticate frame from the AP or when sending that
3768 * frame to the current AP.
3769 * In AP mode, union wpa_event_data::deauth_info is required.
3774 * EVENT_ASSOC_REJECT - Association rejected
3776 * This event should be called when (re)association attempt has been
3777 * rejected by the AP. Information about the association response is
3778 * included in union wpa_event_data::assoc_reject.
3783 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3785 EVENT_AUTH_TIMED_OUT,
3788 * EVENT_ASSOC_TIMED_OUT - Association timed out
3790 EVENT_ASSOC_TIMED_OUT,
3793 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3795 EVENT_WPS_BUTTON_PUSHED,
3798 * EVENT_TX_STATUS - Report TX status
3803 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3805 EVENT_RX_FROM_UNKNOWN,
3808 * EVENT_RX_MGMT - Report RX of a management frame
3813 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3815 * This event is used to indicate when the driver has started the
3816 * requested remain-on-channel duration. Information about the
3817 * operation is included in union wpa_event_data::remain_on_channel.
3819 EVENT_REMAIN_ON_CHANNEL,
3822 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3824 * This event is used to indicate when the driver has completed
3825 * remain-on-channel duration, i.e., may noot be available on the
3826 * requested channel anymore. Information about the
3827 * operation is included in union wpa_event_data::remain_on_channel.
3829 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3832 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3834 * This event is used to indicate when a Probe Request frame has been
3835 * received. Information about the received frame is included in
3836 * union wpa_event_data::rx_probe_req. The driver is required to report
3837 * these events only after successfully completed probe_req_report()
3838 * commands to request the events (i.e., report parameter is non-zero)
3839 * in station mode. In AP mode, Probe Request frames should always be
3845 * EVENT_NEW_STA - New wired device noticed
3847 * This event is used to indicate that a new device has been detected
3848 * in a network that does not use association-like functionality (i.e.,
3849 * mainly wired Ethernet). This can be used to start EAPOL
3850 * authenticator when receiving a frame from a device. The address of
3851 * the device is included in union wpa_event_data::new_sta.
3856 * EVENT_EAPOL_RX - Report received EAPOL frame
3858 * When in AP mode with hostapd, this event is required to be used to
3859 * deliver the receive EAPOL frames from the driver.
3864 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3866 * This event is used to indicate changes in the signal strength
3867 * observed in frames received from the current AP if signal strength
3868 * monitoring has been enabled with signal_monitor().
3870 EVENT_SIGNAL_CHANGE,
3873 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3875 * This event is used to indicate that the interface was enabled after
3876 * having been previously disabled, e.g., due to rfkill.
3878 EVENT_INTERFACE_ENABLED,
3881 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3883 * This event is used to indicate that the interface was disabled,
3884 * e.g., due to rfkill.
3886 EVENT_INTERFACE_DISABLED,
3889 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3891 * This event is used to indicate that the channel list has changed,
3892 * e.g., because of a regulatory domain change triggered by scan
3893 * results including an AP advertising a country code.
3895 EVENT_CHANNEL_LIST_CHANGED,
3898 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3900 * This event is used to indicate that the driver cannot maintain this
3901 * interface in its operation mode anymore. The most likely use for
3902 * this is to indicate that AP mode operation is not available due to
3903 * operating channel would need to be changed to a DFS channel when
3904 * the driver does not support radar detection and another virtual
3905 * interfaces caused the operating channel to change. Other similar
3906 * resource conflicts could also trigger this for station mode
3907 * interfaces. This event can be propagated when channel switching
3910 EVENT_INTERFACE_UNAVAILABLE,
3913 * EVENT_BEST_CHANNEL
3915 * Driver generates this event whenever it detects a better channel
3916 * (e.g., based on RSSI or channel use). This information can be used
3917 * to improve channel selection for a new AP/P2P group.
3922 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3924 * This event should be called when a Deauthentication frame is dropped
3925 * due to it not being protected (MFP/IEEE 802.11w).
3926 * union wpa_event_data::unprot_deauth is required to provide more
3927 * details of the frame.
3929 EVENT_UNPROT_DEAUTH,
3932 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3934 * This event should be called when a Disassociation frame is dropped
3935 * due to it not being protected (MFP/IEEE 802.11w).
3936 * union wpa_event_data::unprot_disassoc is required to provide more
3937 * details of the frame.
3939 EVENT_UNPROT_DISASSOC,
3942 * EVENT_STATION_LOW_ACK
3944 * Driver generates this event whenever it detected that a particular
3945 * station was lost. Detection can be through massive transmission
3946 * failures for example.
3948 EVENT_STATION_LOW_ACK,
3951 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3953 EVENT_IBSS_PEER_LOST,
3956 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3958 * This event carries the new replay counter to notify wpa_supplicant
3959 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3960 * completed Group Key Handshake while the host (including
3961 * wpa_supplicant was sleeping).
3963 EVENT_DRIVER_GTK_REKEY,
3966 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3968 EVENT_SCHED_SCAN_STOPPED,
3971 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3973 * This event indicates that the station responded to the poll
3974 * initiated with @poll_client.
3976 EVENT_DRIVER_CLIENT_POLL_OK,
3979 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3981 EVENT_EAPOL_TX_STATUS,
3984 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3986 * Described in wpa_event_data.ch_switch
3991 * EVENT_WNM - Request WNM operation
3993 * This event can be used to request a WNM operation to be performed.
3998 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4000 * This event indicates that the driver reported a connection failure
4001 * with the specified client (for example, max client reached, etc.) in
4004 EVENT_CONNECT_FAILED_REASON,
4007 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
4009 * A radar has been detected on the supplied frequency, hostapd should
4010 * react accordingly (e.g., change channel).
4012 EVENT_DFS_RADAR_DETECTED,
4015 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
4017 * After a successful CAC, the channel can be marked clear and used.
4019 EVENT_DFS_CAC_FINISHED,
4022 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
4024 * The CAC was not successful, and the channel remains in the previous
4025 * state. This may happen due to a radar beeing detected or other
4026 * external influences.
4028 EVENT_DFS_CAC_ABORTED,
4031 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
4033 * The channel which was previously unavailable is now available again.
4035 EVENT_DFS_NOP_FINISHED,
4038 * EVENT_SURVEY - Received survey data
4040 * This event gets triggered when a driver query is issued for survey
4041 * data and the requested data becomes available. The returned data is
4042 * stored in struct survey_results. The results provide at most one
4043 * survey entry for each frequency and at minimum will provide one
4044 * survey entry for one frequency. The survey data can be os_malloc()'d
4045 * and then os_free()'d, so the event callback must only copy data.
4050 * EVENT_SCAN_STARTED - Scan started
4052 * This indicates that driver has started a scan operation either based
4053 * on a request from wpa_supplicant/hostapd or from another application.
4054 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4055 * completed (either successfully or by getting cancelled).
4060 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4062 * This event indicates a set of frequency ranges that should be avoided
4063 * to reduce issues due to interference or internal co-existence
4064 * information in the driver.
4066 EVENT_AVOID_FREQUENCIES,
4069 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4071 EVENT_NEW_PEER_CANDIDATE,
4074 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4076 * Indicates a pair of primary and secondary channels chosen by ACS
4079 EVENT_ACS_CHANNEL_SELECTED,
4082 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4085 * This event indicates that channel availability check has been started
4086 * on a DFS frequency by a driver that supports DFS Offload.
4088 EVENT_DFS_CAC_STARTED,
4091 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4098 * struct freq_survey - Channel survey info
4100 * @ifidx: Interface index in which this survey was observed
4101 * @freq: Center of frequency of the surveyed channel
4102 * @nf: Channel noise floor in dBm
4103 * @channel_time: Amount of time in ms the radio spent on the channel
4104 * @channel_time_busy: Amount of time in ms the radio detected some signal
4105 * that indicated to the radio the channel was not clear
4106 * @channel_time_rx: Amount of time the radio spent receiving data
4107 * @channel_time_tx: Amount of time the radio spent transmitting data
4108 * @filled: bitmask indicating which fields have been reported, see
4109 * SURVEY_HAS_* defines.
4110 * @list: Internal list pointers
4112 struct freq_survey {
4117 u64 channel_time_busy;
4118 u64 channel_time_rx;
4119 u64 channel_time_tx;
4120 unsigned int filled;
4121 struct dl_list list;
4124 #define SURVEY_HAS_NF BIT(0)
4125 #define SURVEY_HAS_CHAN_TIME BIT(1)
4126 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4127 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4128 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4132 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4134 union wpa_event_data {
4136 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4138 * This structure is optional for EVENT_ASSOC calls and required for
4139 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4140 * driver interface does not need to generate separate EVENT_ASSOCINFO
4145 * reassoc - Flag to indicate association or reassociation
4150 * req_ies - (Re)Association Request IEs
4152 * If the driver generates WPA/RSN IE, this event data must be
4153 * returned for WPA handshake to have needed information. If
4154 * wpa_supplicant-generated WPA/RSN IE is used, this
4155 * information event is optional.
4157 * This should start with the first IE (fixed fields before IEs
4158 * are not included).
4163 * req_ies_len - Length of req_ies in bytes
4168 * resp_ies - (Re)Association Response IEs
4170 * Optional association data from the driver. This data is not
4171 * required WPA, but may be useful for some protocols and as
4172 * such, should be reported if this is available to the driver
4175 * This should start with the first IE (fixed fields before IEs
4176 * are not included).
4181 * resp_ies_len - Length of resp_ies in bytes
4183 size_t resp_ies_len;
4186 * beacon_ies - Beacon or Probe Response IEs
4188 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4189 * Probe Response frames from the current AP (i.e., the one
4190 * that the client just associated with). This information is
4191 * used to update WPA/RSN IE for the AP. If this field is not
4192 * set, the results from previous scan will be used. If no
4193 * data for the new AP is found, scan results will be requested
4194 * again (without scan request). At this point, the driver is
4195 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4198 * This should start with the first IE (fixed fields before IEs
4199 * are not included).
4201 const u8 *beacon_ies;
4204 * beacon_ies_len - Length of beacon_ies */
4205 size_t beacon_ies_len;
4208 * freq - Frequency of the operational channel in MHz
4213 * wmm_params - WMM parameters used in this association.
4215 struct wmm_params wmm_params;
4218 * addr - Station address (for AP mode)
4223 * The following is the key management offload information
4226 * @key_replay_ctr_len
4234 * authorized - Status of key management offload,
4240 * key_replay_ctr - Key replay counter value last used
4241 * in a valid EAPOL-Key frame
4243 const u8 *key_replay_ctr;
4246 * key_replay_ctr_len - The length of key_replay_ctr
4248 size_t key_replay_ctr_len;
4251 * ptk_kck - The derived PTK KCK
4256 * ptk_kek_len - The length of ptk_kck
4261 * ptk_kek - The derived PTK KEK
4266 * ptk_kek_len - The length of ptk_kek
4271 * subnet_status - The subnet status:
4272 * 0 = unknown, 1 = unchanged, 2 = changed
4278 * struct disassoc_info - Data for EVENT_DISASSOC events
4280 struct disassoc_info {
4282 * addr - Station address (for AP mode)
4287 * reason_code - Reason Code (host byte order) used in
4288 * Deauthentication frame
4293 * ie - Optional IE(s) in Disassociation frame
4298 * ie_len - Length of ie buffer in octets
4303 * locally_generated - Whether the frame was locally generated
4305 int locally_generated;
4309 * struct deauth_info - Data for EVENT_DEAUTH events
4311 struct deauth_info {
4313 * addr - Station address (for AP mode)
4318 * reason_code - Reason Code (host byte order) used in
4319 * Deauthentication frame
4324 * ie - Optional IE(s) in Deauthentication frame
4329 * ie_len - Length of ie buffer in octets
4334 * locally_generated - Whether the frame was locally generated
4336 int locally_generated;
4340 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4342 struct michael_mic_failure {
4345 } michael_mic_failure;
4348 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4350 struct interface_status {
4351 unsigned int ifindex;
4354 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4359 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4361 struct pmkid_candidate {
4362 /** BSSID of the PMKID candidate */
4364 /** Smaller the index, higher the priority */
4366 /** Whether RSN IE includes pre-authenticate flag */
4371 * struct stkstart - Data for EVENT_STKSTART
4378 * struct tdls - Data for EVENT_TDLS
4384 TDLS_REQUEST_TEARDOWN,
4385 TDLS_REQUEST_DISCOVER,
4387 u16 reason_code; /* for teardown */
4391 * struct wnm - Data for EVENT_WNM
4409 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4411 * During FT (IEEE 802.11r) authentication sequence, the driver is
4412 * expected to use this event to report received FT IEs (MDIE, FTIE,
4413 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4414 * IEs for the next message will be delivered through the
4415 * struct wpa_driver_ops::update_ft_ies() callback.
4421 u8 target_ap[ETH_ALEN];
4422 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4424 /** Length of ric_ies buffer in octets */
4429 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4431 struct ibss_rsn_start {
4436 * struct auth_info - Data for EVENT_AUTH events
4442 u16 auth_transaction;
4449 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4451 struct assoc_reject {
4453 * bssid - BSSID of the AP that rejected association
4458 * resp_ies - (Re)Association Response IEs
4460 * Optional association data from the driver. This data is not
4461 * required WPA, but may be useful for some protocols and as
4462 * such, should be reported if this is available to the driver
4465 * This should start with the first IE (fixed fields before IEs
4466 * are not included).
4471 * resp_ies_len - Length of resp_ies in bytes
4473 size_t resp_ies_len;
4476 * status_code - Status Code from (Re)association Response
4481 * timed_out - Whether failure is due to timeout (etc.) rather
4482 * than explicit rejection response from the AP.
4487 struct timeout_event {
4492 * struct tx_status - Data for EVENT_TX_STATUS events
4504 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4506 struct rx_from_unknown {
4513 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4521 * drv_priv - Pointer to store driver private BSS information
4523 * If not set to NULL, this is used for comparison with
4524 * hostapd_data->drv_priv to determine which BSS should process
4530 * freq - Frequency (in MHz) on which the frame was received
4535 * ssi_signal - Signal strength in dBm (or 0 if not available)
4541 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4543 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4545 struct remain_on_channel {
4547 * freq - Channel frequency in MHz
4552 * duration - Duration to remain on the channel in milliseconds
4554 unsigned int duration;
4555 } remain_on_channel;
4558 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4559 * @aborted: Whether the scan was aborted
4560 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4561 * @num_freqs: Number of entries in freqs array
4562 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4564 * @num_ssids: Number of entries in ssids array
4565 * @external_scan: Whether the scan info is for an external scan
4566 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
4567 * 0 if the source of the scan event is a vendor scan
4573 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4580 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4582 struct rx_probe_req {
4584 * sa - Source address of the received Probe Request frame
4589 * da - Destination address of the received Probe Request frame
4590 * or %NULL if not available
4595 * bssid - BSSID of the received Probe Request frame or %NULL
4601 * ie - IEs from the Probe Request body
4606 * ie_len - Length of ie buffer in octets
4611 * signal - signal strength in dBm (or 0 if not available)
4617 * struct new_sta - Data for EVENT_NEW_STA events
4624 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4633 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4635 struct wpa_signal_info signal_change;
4638 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4639 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4640 * @freq_5: Best 5 GHz band channel frequency in MHz
4641 * @freq_overall: Best channel frequency in MHz
4643 * 0 can be used to indicate no preference in either band.
4645 struct best_channel {
4651 struct unprot_deauth {
4657 struct unprot_disassoc {
4664 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4665 * @addr: station address
4672 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4674 struct ibss_peer_lost {
4679 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4681 struct driver_gtk_rekey {
4683 const u8 *replay_ctr;
4687 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4688 * @addr: station address
4690 struct client_poll {
4695 * struct eapol_tx_status
4696 * @dst: Original destination
4697 * @data: Data starting with IEEE 802.1X header (!)
4698 * @data_len: Length of data
4699 * @ack: Indicates ack or lost frame
4701 * This corresponds to hapd_send_eapol if the frame sent
4702 * there isn't just reported as EVENT_TX_STATUS.
4704 struct eapol_tx_status {
4713 * @freq: Frequency of new channel in MHz
4714 * @ht_enabled: Whether this is an HT channel
4715 * @ch_offset: Secondary channel offset
4716 * @ch_width: Channel width
4717 * @cf1: Center frequency 1
4718 * @cf2: Center frequency 2
4724 enum chan_width ch_width;
4730 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4731 * @addr: Remote client address
4732 * @code: Reason code for connection failure
4734 struct connect_failed_reason {
4740 } connect_failed_reason;
4743 * struct dfs_event - Data for radar detected events
4744 * @freq: Frequency of the channel in MHz
4750 enum chan_width chan_width;
4756 * survey_results - Survey result data for EVENT_SURVEY
4757 * @freq_filter: Requested frequency survey filter, 0 if request
4758 * was for all survey data
4759 * @survey_list: Linked list of survey data (struct freq_survey)
4761 struct survey_results {
4762 unsigned int freq_filter;
4763 struct dl_list survey_list; /* struct freq_survey */
4767 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4768 * @initiator: Initiator of the regulatory change
4769 * @type: Regulatory change type
4770 * @alpha2: Country code (or "" if not available)
4772 struct channel_list_changed {
4773 enum reg_change_initiator initiator;
4776 } channel_list_changed;
4779 * freq_range - List of frequency ranges
4781 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4783 struct wpa_freq_range_list freq_range;
4788 * @peer: Peer address
4790 * @ie_len: Length of @ies
4792 * Notification of new candidate mesh peer.
4801 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4802 * @pri_channel: Selected primary channel
4803 * @sec_channel: Selected secondary channel
4804 * @vht_seg0_center_ch: VHT mode Segment0 center channel
4805 * @vht_seg1_center_ch: VHT mode Segment1 center channel
4806 * @ch_width: Selected Channel width by driver. Driver may choose to
4807 * change hostapd configured ACS channel width due driver internal
4808 * channel restrictions.
4809 * hw_mode: Selected band (used with hw_mode=any)
4811 struct acs_selected_channels {
4814 u8 vht_seg0_center_ch;
4815 u8 vht_seg1_center_ch;
4817 enum hostapd_hw_mode hw_mode;
4818 } acs_selected_channels;
4821 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
4822 * @reason_code: Reason for stopping offload
4823 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
4825 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
4827 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
4829 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
4830 * supported by device.
4832 struct p2p_lo_stop {
4834 P2P_LO_STOPPED_REASON_COMPLETE = 0,
4835 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
4836 P2P_LO_STOPPED_REASON_INVALID_PARAM,
4837 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
4843 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4844 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4845 * with struct wpa_driver_ops::init()
4846 * @event: event type (defined above)
4847 * @data: possible extra data for the event
4849 * Driver wrapper code should call this function whenever an event is received
4852 void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4853 union wpa_event_data *data);
4856 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
4857 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4858 * with struct wpa_driver_ops::init()
4859 * @event: event type (defined above)
4860 * @data: possible extra data for the event
4862 * Same as wpa_supplicant_event(), but we search for the interface in
4865 void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
4866 union wpa_event_data *data);
4869 * The following inline functions are provided for convenience to simplify
4870 * event indication for some of the common events.
4873 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4874 size_t ielen, int reassoc)
4876 union wpa_event_data event;
4877 os_memset(&event, 0, sizeof(event));
4878 event.assoc_info.reassoc = reassoc;
4879 event.assoc_info.req_ies = ie;
4880 event.assoc_info.req_ies_len = ielen;
4881 event.assoc_info.addr = addr;
4882 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4885 static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4887 union wpa_event_data event;
4888 os_memset(&event, 0, sizeof(event));
4889 event.disassoc_info.addr = addr;
4890 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4893 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4896 union wpa_event_data event;
4897 os_memset(&event, 0, sizeof(event));
4898 event.eapol_rx.src = src;
4899 event.eapol_rx.data = data;
4900 event.eapol_rx.data_len = data_len;
4901 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4904 /* driver_common.c */
4905 void wpa_scan_results_free(struct wpa_scan_results *res);
4907 /* Convert wpa_event_type to a string for logging */
4908 const char * event_to_string(enum wpa_event_type event);
4910 /* Convert chan_width to a string for logging and control interfaces */
4911 const char * channel_width_to_string(enum chan_width width);
4913 int ht_supported(const struct hostapd_hw_modes *mode);
4914 int vht_supported(const struct hostapd_hw_modes *mode);
4916 struct wowlan_triggers *
4917 wpa_get_wowlan_triggers(const char *wowlan_triggers,
4918 const struct wpa_driver_capa *capa);
4920 /* NULL terminated array of linked in driver wrappers */
4921 extern const struct wpa_driver_ops *const wpa_drivers[];
4924 /* Available drivers */
4926 #ifdef CONFIG_DRIVER_WEXT
4927 extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
4928 #endif /* CONFIG_DRIVER_WEXT */
4929 #ifdef CONFIG_DRIVER_NL80211
4930 /* driver_nl80211.c */
4931 extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
4932 #endif /* CONFIG_DRIVER_NL80211 */
4933 #ifdef CONFIG_DRIVER_HOSTAP
4934 extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
4935 #endif /* CONFIG_DRIVER_HOSTAP */
4936 #ifdef CONFIG_DRIVER_BSD
4937 extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
4938 #endif /* CONFIG_DRIVER_BSD */
4939 #ifdef CONFIG_DRIVER_OPENBSD
4940 /* driver_openbsd.c */
4941 extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
4942 #endif /* CONFIG_DRIVER_OPENBSD */
4943 #ifdef CONFIG_DRIVER_NDIS
4944 extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
4945 #endif /* CONFIG_DRIVER_NDIS */
4946 #ifdef CONFIG_DRIVER_WIRED
4947 extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
4948 #endif /* CONFIG_DRIVER_WIRED */
4949 #ifdef CONFIG_DRIVER_MACSEC_QCA
4950 /* driver_macsec_qca.c */
4951 extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
4952 #endif /* CONFIG_DRIVER_MACSEC_QCA */
4953 #ifdef CONFIG_DRIVER_ROBOSWITCH
4954 /* driver_roboswitch.c */
4955 extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
4956 #endif /* CONFIG_DRIVER_ROBOSWITCH */
4957 #ifdef CONFIG_DRIVER_ATHEROS
4958 /* driver_atheros.c */
4959 extern const struct wpa_driver_ops wpa_driver_atheros_ops;
4960 #endif /* CONFIG_DRIVER_ATHEROS */
4961 #ifdef CONFIG_DRIVER_NONE
4962 extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
4963 #endif /* CONFIG_DRIVER_NONE */
4965 #endif /* DRIVER_H */