2 * Driver interface definition
3 * Copyright (c) 2003-2017, 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 "common/wpa_common.h"
26 #include "pae/ieee802_1x_kay.h"
27 #endif /* CONFIG_MACSEC */
28 #include "utils/list.h"
30 #define HOSTAPD_CHAN_DISABLED 0x00000001
31 #define HOSTAPD_CHAN_NO_IR 0x00000002
32 #define HOSTAPD_CHAN_RADAR 0x00000008
33 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
34 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
35 #define HOSTAPD_CHAN_HT40 0x00000040
36 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
38 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
39 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
40 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
41 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
42 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
44 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
45 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
46 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
47 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
49 #define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
50 #define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
52 #define HOSTAPD_CHAN_VHT_10_150 0x00100000
53 #define HOSTAPD_CHAN_VHT_30_130 0x00200000
54 #define HOSTAPD_CHAN_VHT_50_110 0x00400000
55 #define HOSTAPD_CHAN_VHT_70_90 0x00800000
56 #define HOSTAPD_CHAN_VHT_90_70 0x01000000
57 #define HOSTAPD_CHAN_VHT_110_50 0x02000000
58 #define HOSTAPD_CHAN_VHT_130_30 0x04000000
59 #define HOSTAPD_CHAN_VHT_150_10 0x08000000
61 /* Allowed bandwidth mask */
62 enum hostapd_chan_width_attr
{
63 HOSTAPD_CHAN_WIDTH_10
= BIT(0),
64 HOSTAPD_CHAN_WIDTH_20
= BIT(1),
65 HOSTAPD_CHAN_WIDTH_40P
= BIT(2),
66 HOSTAPD_CHAN_WIDTH_40M
= BIT(3),
67 HOSTAPD_CHAN_WIDTH_80
= BIT(4),
68 HOSTAPD_CHAN_WIDTH_160
= BIT(5),
71 /* Filter gratuitous ARP */
72 #define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
73 /* Filter unsolicited Neighbor Advertisement */
74 #define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
75 /* Filter unicast IP packets encrypted using the GTK */
76 #define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)
78 #define HOSTAPD_DFS_REGION_FCC 1
79 #define HOSTAPD_DFS_REGION_ETSI 2
80 #define HOSTAPD_DFS_REGION_JP 3
83 * enum reg_change_initiator - Regulatory change initiator
85 enum reg_change_initiator
{
89 REGDOM_SET_BY_COUNTRY_IE
,
94 * enum reg_type - Regulatory change types
100 REGDOM_TYPE_CUSTOM_WORLD
,
101 REGDOM_TYPE_INTERSECTION
,
105 * struct hostapd_channel_data - Channel information
107 struct hostapd_channel_data
{
109 * chan - Channel number (IEEE 802.11)
114 * freq - Frequency in MHz
119 * flag - Channel flags (HOSTAPD_CHAN_*)
124 * allowed_bw - Allowed channel width bitmask
126 * See enum hostapd_chan_width_attr.
131 * max_tx_power - Regulatory transmit power limit in dBm
136 * survey_list - Linked list of surveys (struct freq_survey)
138 struct dl_list survey_list
;
141 * min_nf - Minimum observed noise floor, in dBm, based on all
142 * surveyed channel data
148 * interference_factor - Computed interference factor on this
149 * channel (used internally in src/ap/acs.c; driver wrappers do not
152 long double interference_factor
;
153 #endif /* CONFIG_ACS */
156 * dfs_cac_ms - DFS CAC time in milliseconds
158 unsigned int dfs_cac_ms
;
161 #define HE_MAX_MAC_CAPAB_SIZE 6
162 #define HE_MAX_PHY_CAPAB_SIZE 11
163 #define HE_MAX_MCS_CAPAB_SIZE 12
166 * struct he_capabilities - IEEE 802.11ax HE capabilities
168 struct he_capabilities
{
170 u8 phy_cap
[HE_MAX_PHY_CAPAB_SIZE
];
171 u8 mac_cap
[HE_MAX_MAC_CAPAB_SIZE
];
172 u8 mcs
[HE_MAX_MCS_CAPAB_SIZE
];
176 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
177 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
180 * struct hostapd_hw_modes - Supported hardware mode information
182 struct hostapd_hw_modes
{
184 * mode - Hardware mode
186 enum hostapd_hw_mode mode
;
189 * num_channels - Number of entries in the channels array
194 * channels - Array of supported channels
196 struct hostapd_channel_data
*channels
;
199 * num_rates - Number of entries in the rates array
204 * rates - Array of supported rates in 100 kbps units
209 * ht_capab - HT (IEEE 802.11n) capabilities
214 * mcs_set - MCS (IEEE 802.11n) rate parameters
219 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
224 * vht_capab - VHT (IEEE 802.11ac) capabilities
229 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
233 unsigned int flags
; /* HOSTAPD_MODE_FLAG_* */
236 * he_capab - HE (IEEE 802.11ax) capabilities
238 struct he_capabilities he_capab
;
242 #define IEEE80211_MODE_INFRA 0
243 #define IEEE80211_MODE_IBSS 1
244 #define IEEE80211_MODE_AP 2
245 #define IEEE80211_MODE_MESH 5
247 #define IEEE80211_CAP_ESS 0x0001
248 #define IEEE80211_CAP_IBSS 0x0002
249 #define IEEE80211_CAP_PRIVACY 0x0010
250 #define IEEE80211_CAP_RRM 0x1000
252 /* DMG (60 GHz) IEEE 802.11ad */
253 /* type - bits 0..1 */
254 #define IEEE80211_CAP_DMG_MASK 0x0003
255 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
256 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
257 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
259 #define WPA_SCAN_QUAL_INVALID BIT(0)
260 #define WPA_SCAN_NOISE_INVALID BIT(1)
261 #define WPA_SCAN_LEVEL_INVALID BIT(2)
262 #define WPA_SCAN_LEVEL_DBM BIT(3)
263 #define WPA_SCAN_ASSOCIATED BIT(5)
266 * struct wpa_scan_res - Scan result for an BSS/IBSS
267 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
269 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
270 * @beacon_int: beacon interval in TUs (host byte order)
271 * @caps: capability information field in host byte order
272 * @qual: signal quality
273 * @noise: noise level
274 * @level: signal level
276 * @age: Age of the information in milliseconds (i.e., how many milliseconds
277 * ago the last Beacon or Probe Response frame was received)
278 * @est_throughput: Estimated throughput in kbps (this is calculated during
279 * scan result processing if left zero by the driver wrapper)
280 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
281 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
282 * of TSF of the BSS specified by %tsf_bssid.
283 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
284 * @ie_len: length of the following IE field in octets
285 * @beacon_ie_len: length of the following Beacon IE field in octets
287 * This structure is used as a generic format for scan results from the
288 * driver. Each driver interface implementation is responsible for converting
289 * the driver or OS specific scan results into this format.
291 * If the driver does not support reporting all IEs, the IE data structure is
292 * constructed of the IEs that are available. This field will also need to
293 * include SSID in IE format. All drivers are encouraged to be extended to
294 * report all IEs to make it easier to support future additions.
296 * This structure data is followed by ie_len octets of IEs from Probe Response
297 * frame (or if the driver does not indicate source of IEs, these may also be
298 * from Beacon frame). After the first set of IEs, another set of IEs may follow
299 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
301 struct wpa_scan_res
{
312 unsigned int est_throughput
;
315 u8 tsf_bssid
[ETH_ALEN
];
317 size_t beacon_ie_len
;
318 /* Followed by ie_len + beacon_ie_len octets of IE data */
322 * struct wpa_scan_results - Scan results
323 * @res: Array of pointers to allocated variable length scan result entries
324 * @num: Number of entries in the scan result array
325 * @fetch_time: Time when the results were fetched from the driver
327 struct wpa_scan_results
{
328 struct wpa_scan_res
**res
;
330 struct os_reltime fetch_time
;
334 * struct wpa_interface_info - Network interface information
335 * @next: Pointer to the next interface or NULL if this is the last one
336 * @ifname: Interface name that can be used with init() or init2()
337 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
339 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
340 * is not an allocated copy, i.e., get_interfaces() caller will not free
343 struct wpa_interface_info
{
344 struct wpa_interface_info
*next
;
347 const char *drv_name
;
350 #define WPAS_MAX_SCAN_SSIDS 16
353 * struct wpa_driver_scan_ssid - SSIDs to scan for
354 * @ssid - specific SSID to scan for (ProbeReq)
355 * %NULL or zero-length SSID is used to indicate active scan
356 * with wildcard SSID.
357 * @ssid_len - Length of the SSID in octets
359 struct wpa_driver_scan_ssid
{
365 * struct wpa_driver_scan_params - Scan parameters
366 * Data for struct wpa_driver_ops::scan2().
368 struct wpa_driver_scan_params
{
370 * ssids - SSIDs to scan for
372 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
375 * num_ssids - Number of entries in ssids array
376 * Zero indicates a request for a passive scan.
381 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
386 * extra_ies_len - Length of extra_ies in octets
388 size_t extra_ies_len
;
391 * freqs - Array of frequencies to scan or %NULL for all frequencies
393 * The frequency is set in MHz. The array is zero-terminated.
398 * filter_ssids - Filter for reporting SSIDs
400 * This optional parameter can be used to request the driver wrapper to
401 * filter scan results to include only the specified SSIDs. %NULL
402 * indicates that no filtering is to be done. This can be used to
403 * reduce memory needs for scan results in environments that have large
404 * number of APs with different SSIDs.
406 * The driver wrapper is allowed to take this allocated buffer into its
407 * own use by setting the pointer to %NULL. In that case, the driver
408 * wrapper is responsible for freeing the buffer with os_free() once it
409 * is not needed anymore.
411 struct wpa_driver_scan_filter
{
412 u8 ssid
[SSID_MAX_LEN
];
417 * num_filter_ssids - Number of entries in filter_ssids array
419 size_t num_filter_ssids
;
422 * filter_rssi - Filter by RSSI
424 * The driver may filter scan results in firmware to reduce host
425 * wakeups and thereby save power. Specify the RSSI threshold in s32
431 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
433 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
434 * Mbps from the support rates element(s) in the Probe Request frames
435 * and not to transmit the frames at any of those rates.
437 unsigned int p2p_probe
:1;
440 * only_new_results - Request driver to report only new results
442 * This is used to request the driver to report only BSSes that have
443 * been detected after this scan request has been started, i.e., to
444 * flush old cached BSS entries.
446 unsigned int only_new_results
:1;
449 * low_priority - Requests driver to use a lower scan priority
451 * This is used to request the driver to use a lower scan priority
452 * if it supports such a thing.
454 unsigned int low_priority
:1;
457 * mac_addr_rand - Requests driver to randomize MAC address
459 unsigned int mac_addr_rand
:1;
462 * mac_addr - MAC address used with randomization. The address cannot be
463 * a multicast one, i.e., bit 0 of byte 0 should not be set.
468 * mac_addr_mask - MAC address mask used with randomization.
470 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
471 * the mask should be taken as is from mac_addr. The mask should not
472 * allow the generation of a multicast address, i.e., bit 0 of byte 0
475 const u8
*mac_addr_mask
;
478 * sched_scan_plans - Scan plans for scheduled scan
480 * Each scan plan consists of the number of iterations to scan and the
481 * interval between scans. When a scan plan finishes (i.e., it was run
482 * for the specified number of iterations), the next scan plan is
483 * executed. The scan plans are executed in the order they appear in
484 * the array (lower index first). The last scan plan will run infinitely
485 * (until requested to stop), thus must not specify the number of
486 * iterations. All other scan plans must specify the number of
489 struct sched_scan_plan
{
490 u32 interval
; /* In seconds */
491 u32 iterations
; /* Zero to run infinitely */
495 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
497 unsigned int sched_scan_plans_num
;
500 * sched_scan_start_delay - Delay to use before starting the first scan
502 * Delay (in seconds) before scheduling first scan plan cycle. The
503 * driver may ignore this parameter and start immediately (or at any
504 * other time), if this feature is not supported.
506 u32 sched_scan_start_delay
;
509 * bssid - Specific BSSID to scan for
511 * This optional parameter can be used to replace the default wildcard
512 * BSSID with a specific BSSID to scan for if results are needed from
518 * scan_cookie - Unique identification representing the scan request
520 * This scan_cookie carries a unique identification representing the
521 * scan request if the host driver/kernel supports concurrent scan
522 * requests. This cookie is returned from the corresponding driver
525 * Note: Unlike other parameters in this structure, scan_cookie is used
526 * only to return information instead of setting parameters for the
532 * duration - Dwell time on each channel
534 * This optional parameter can be used to set the dwell time on each
540 * duration_mandatory - Whether the specified duration is mandatory
542 * If this is set, the duration specified by the %duration field is
543 * mandatory (and the driver should reject the scan request if it is
544 * unable to comply with the specified duration), otherwise it is the
545 * maximum duration and the actual duration may be shorter.
547 unsigned int duration_mandatory
:1;
550 * relative_rssi_set - Whether relative RSSI parameters are set
552 unsigned int relative_rssi_set
:1;
555 * relative_rssi - Relative RSSI for reporting better BSSs
557 * Amount of RSSI by which a BSS should be better than the current
558 * connected BSS to report the new BSS to user space.
563 * relative_adjust_band - Band to which RSSI should be adjusted
565 * The relative_adjust_rssi should be added to the band specified
566 * by relative_adjust_band.
568 enum set_band relative_adjust_band
;
571 * relative_adjust_rssi - RSSI to be added to relative_adjust_band
573 * An amount of relative_band_rssi should be added to the BSSs that
574 * belong to the band specified by relative_adjust_band while comparing
575 * with other bands for BSS reporting.
577 s8 relative_adjust_rssi
;
582 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0)
583 * - Accept broadcast Probe Response frame.
584 * - Probe Request frame deferral and suppression.
585 * - Max Channel Time - driver fills FILS request params IE with
586 * Maximum Channel Time.
587 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps.
589 unsigned int oce_scan
:1;
592 * NOTE: Whenever adding new parameters here, please make sure
593 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
599 * struct wpa_driver_auth_params - Authentication parameters
600 * Data for struct wpa_driver_ops::authenticate().
602 struct wpa_driver_auth_params
{
610 const u8
*wep_key
[4];
611 size_t wep_key_len
[4];
613 int local_state_change
;
616 * p2p - Whether this connection is a P2P group
621 * auth_data - Additional elements for Authentication frame
623 * This buffer starts with the Authentication transaction sequence
624 * number field. If no special handling of such elements is needed, this
625 * pointer is %NULL. This is used with SAE and FILS.
630 * auth_data_len - Length of auth_data buffer in octets
632 size_t auth_data_len
;
636 * enum wps_mode - WPS mode
640 * WPS_MODE_NONE - No WPS provisioning being used
645 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
650 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
656 * struct hostapd_freq_params - Channel parameters
658 struct hostapd_freq_params
{
660 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
662 enum hostapd_hw_mode mode
;
665 * freq - Primary channel center frequency in MHz
670 * channel - Channel number
675 * ht_enabled - Whether HT is enabled
680 * sec_channel_offset - Secondary channel offset for HT40
683 * -1 = HT40 enabled, secondary channel below primary,
684 * 1 = HT40 enabled, secondary channel above primary
686 int sec_channel_offset
;
689 * vht_enabled - Whether VHT is enabled
694 * he_enabled - Whether HE is enabled
699 * center_freq1 - Segment 0 center frequency in MHz
701 * Valid for both HT and VHT.
706 * center_freq2 - Segment 1 center frequency in MHz
708 * Non-zero only for bandwidth 80 and an 80+80 channel
713 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
719 * struct wpa_driver_sta_auth_params - Authentication parameters
720 * Data for struct wpa_driver_ops::sta_auth().
722 struct wpa_driver_sta_auth_params
{
725 * own_addr - Source address and BSSID for authentication frame
730 * addr - MAC address of the station to associate
735 * seq - authentication sequence number
740 * status - authentication response status code
745 * ie - authentication frame ie buffer
750 * len - ie buffer length
755 * fils_auth - Indicates whether FILS authentication is being performed
760 * fils_anonce - ANonce (required for FILS)
762 u8 fils_anonce
[WPA_NONCE_LEN
];
765 * fils_snonce - SNonce (required for FILS)
767 u8 fils_snonce
[WPA_NONCE_LEN
];
770 * fils_kek - key for encryption (required for FILS)
772 u8 fils_kek
[WPA_KEK_MAX_LEN
];
775 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
781 * struct wpa_driver_associate_params - Association parameters
782 * Data for struct wpa_driver_ops::associate().
784 struct wpa_driver_associate_params
{
786 * bssid - BSSID of the selected AP
787 * This can be %NULL, if ap_scan=2 mode is used and the driver is
788 * responsible for selecting with which BSS to associate. */
792 * bssid_hint - BSSID of a proposed AP
794 * This indicates which BSS has been found a suitable candidate for
795 * initial association for drivers that use driver/firmwate-based BSS
796 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
797 * the driver from selecting other BSSes in the ESS.
799 const u8
*bssid_hint
;
802 * ssid - The selected SSID
807 * ssid_len - Length of the SSID (1..32)
812 * freq - channel parameters
814 struct hostapd_freq_params freq
;
817 * freq_hint - Frequency of the channel the proposed AP is using
819 * This provides a channel on which a suitable BSS has been found as a
820 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
821 * limit the driver from selecting other channels for
822 * driver/firmware-based BSS selection.
827 * bg_scan_period - Background scan period in seconds, 0 to disable
828 * background scan, or -1 to indicate no change to default driver
834 * beacon_int - Beacon interval for IBSS or 0 to use driver default
839 * wpa_ie - WPA information element for (Re)Association Request
840 * WPA information element to be included in (Re)Association
841 * Request (including information element id and length). Use
842 * of this WPA IE is optional. If the driver generates the WPA
843 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
844 * key_mgmt_suite to select proper algorithms. In this case,
845 * the driver has to notify wpa_supplicant about the used WPA
846 * IE by generating an event that the interface code will
847 * convert into EVENT_ASSOCINFO data (see below).
849 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
850 * instead. The driver can determine which version is used by
851 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
854 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
859 * wpa_ie_len - length of the wpa_ie
864 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
866 unsigned int wpa_proto
;
869 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
871 * This is usually ignored if @wpa_ie is used.
873 unsigned int pairwise_suite
;
876 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
878 * This is usually ignored if @wpa_ie is used.
880 unsigned int group_suite
;
883 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
885 * This is usually ignored if @wpa_ie is used.
887 unsigned int mgmt_group_suite
;
890 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
892 * This is usually ignored if @wpa_ie is used.
894 unsigned int key_mgmt_suite
;
897 * auth_alg - Allowed authentication algorithms
898 * Bit field of WPA_AUTH_ALG_*
903 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
908 * wep_key - WEP keys for static WEP configuration
910 const u8
*wep_key
[4];
913 * wep_key_len - WEP key length for static WEP configuration
915 size_t wep_key_len
[4];
918 * wep_tx_keyidx - WEP TX key index for static WEP configuration
923 * mgmt_frame_protection - IEEE 802.11w management frame protection
925 enum mfp_options mgmt_frame_protection
;
928 * passphrase - RSN passphrase for PSK
930 * This value is made available only for WPA/WPA2-Personal (PSK) and
931 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
932 * is the 8..63 character ASCII passphrase, if available. Please note
933 * that this can be %NULL if passphrase was not used to generate the
934 * PSK. In that case, the psk field must be used to fetch the PSK.
936 const char *passphrase
;
939 * psk - RSN PSK (alternative for passphrase for PSK)
941 * This value is made available only for WPA/WPA2-Personal (PSK) and
942 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
943 * is the 32-octet (256-bit) PSK, if available. The driver wrapper
944 * should be prepared to handle %NULL value as an error.
949 * drop_unencrypted - Enable/disable unencrypted frame filtering
951 * Configure the driver to drop all non-EAPOL frames (both receive and
952 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
953 * still be allowed for key negotiation.
955 int drop_unencrypted
;
958 * prev_bssid - Previously used BSSID in this ESS
960 * When not %NULL, this is a request to use reassociation instead of
963 const u8
*prev_bssid
;
968 * If the driver needs to do special configuration for WPS association,
969 * this variable provides more information on what type of association
970 * is being requested. Most drivers should not need ot use this.
975 * p2p - Whether this connection is a P2P group
980 * uapsd - UAPSD parameters for the network
981 * -1 = do not change defaults
982 * AP mode: 1 = enabled, 0 = disabled
983 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
988 * fixed_bssid - Whether to force this BSSID in IBSS mode
989 * 1 = Fix this BSSID and prevent merges.
990 * 0 = Do not fix BSSID.
995 * fixed_freq - Fix control channel in IBSS mode
996 * 0 = don't fix control channel (default)
997 * 1 = fix control channel; this prevents IBSS merging with another
1003 * disable_ht - Disable HT (IEEE 802.11n) for this connection
1008 * htcaps - HT Capabilities over-rides
1010 * Only bits set in the mask will be used, and not all values are used
1011 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
1013 * Pointer to struct ieee80211_ht_capabilities.
1018 * htcaps_mask - HT Capabilities over-rides mask
1020 * Pointer to struct ieee80211_ht_capabilities.
1022 const u8
*htcaps_mask
;
1024 #ifdef CONFIG_VHT_OVERRIDES
1026 * disable_vht - Disable VHT for this connection
1031 * VHT capability overrides.
1033 const struct ieee80211_vht_capabilities
*vhtcaps
;
1034 const struct ieee80211_vht_capabilities
*vhtcaps_mask
;
1035 #endif /* CONFIG_VHT_OVERRIDES */
1038 * req_key_mgmt_offload - Request key management offload for connection
1040 * Request key management offload for this connection if the device
1043 int req_key_mgmt_offload
;
1046 * Flag for indicating whether this association includes support for
1047 * RRM (Radio Resource Measurements)
1052 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1053 * AP as usual. Valid for DMG network only.
1058 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1063 * fils_kek_len: Length of fils_kek in bytes
1065 size_t fils_kek_len
;
1068 * fils_nonces - Nonces for FILS association frame protection
1071 const u8
*fils_nonces
;
1074 * fils_nonces_len: Length of fils_nonce in bytes
1076 size_t fils_nonces_len
;
1079 * fils_erp_username - Username part of keyName-NAI
1081 const u8
*fils_erp_username
;
1084 * fils_erp_username_len - Length of fils_erp_username in bytes
1086 size_t fils_erp_username_len
;
1089 * fils_erp_realm - Realm/domain name to use in FILS ERP
1091 const u8
*fils_erp_realm
;
1094 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1096 size_t fils_erp_realm_len
;
1099 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1102 u16 fils_erp_next_seq_num
;
1105 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1106 * specified by fils_erp_username@fils_erp_realm.
1108 const u8
*fils_erp_rrk
;
1111 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1113 size_t fils_erp_rrk_len
;
1118 HIDDEN_SSID_ZERO_LEN
,
1119 HIDDEN_SSID_ZERO_CONTENTS
1122 enum ch_switch_state
{
1127 struct wowlan_triggers
{
1131 u8 gtk_rekey_failure
;
1132 u8 eap_identity_req
;
1133 u8 four_way_handshake
;
1137 struct wpa_driver_ap_params
{
1139 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1144 * head_len - Length of the head buffer in octets
1149 * tail - Beacon tail following TIM IE
1154 * tail_len - Length of the tail buffer in octets
1159 * dtim_period - DTIM period
1164 * beacon_int - Beacon interval
1169 * basic_rates: -1 terminated array of basic rates in 100 kbps
1171 * This parameter can be used to set a specific basic rate set for the
1172 * BSS. If %NULL, default basic rate set is used.
1177 * beacon_rate: Beacon frame data rate
1179 * This parameter can be used to set a specific Beacon frame data rate
1180 * for the BSS. The interpretation of this value depends on the
1181 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS). If
1182 * beacon_rate == 0 and rate_type == 0 (BEACON_RATE_LEGACY), the default
1183 * Beacon frame data rate is used.
1185 unsigned int beacon_rate
;
1188 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT)
1190 enum beacon_rate_type rate_type
;
1193 * proberesp - Probe Response template
1195 * This is used by drivers that reply to Probe Requests internally in
1196 * AP mode and require the full Probe Response template.
1201 * proberesp_len - Length of the proberesp buffer in octets
1203 size_t proberesp_len
;
1206 * ssid - The SSID to use in Beacon/Probe Response frames
1211 * ssid_len - Length of the SSID (1..32)
1216 * hide_ssid - Whether to hide the SSID
1218 enum hide_ssid hide_ssid
;
1221 * pairwise_ciphers - WPA_CIPHER_* bitfield
1223 unsigned int pairwise_ciphers
;
1226 * group_cipher - WPA_CIPHER_*
1228 unsigned int group_cipher
;
1231 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1233 unsigned int key_mgmt_suites
;
1236 * auth_algs - WPA_AUTH_ALG_* bitfield
1238 unsigned int auth_algs
;
1241 * wpa_version - WPA_PROTO_* bitfield
1243 unsigned int wpa_version
;
1246 * privacy - Whether privacy is used in the BSS
1251 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1253 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1254 * not use the full Beacon template.
1256 const struct wpabuf
*beacon_ies
;
1259 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1261 * This is used to add IEs like WPS IE and P2P IE by drivers that
1262 * reply to Probe Request frames internally.
1264 const struct wpabuf
*proberesp_ies
;
1267 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1269 * This is used to add IEs like WPS IE by drivers that reply to
1270 * (Re)Association Request frames internally.
1272 const struct wpabuf
*assocresp_ies
;
1275 * isolate - Whether to isolate frames between associated stations
1277 * If this is non-zero, the AP is requested to disable forwarding of
1278 * frames between associated stations.
1283 * cts_protect - Whether CTS protection is enabled
1288 * preamble - Whether short preamble is enabled
1293 * short_slot_time - Whether short slot time is enabled
1295 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1296 * not set (e.g., when 802.11g mode is not in use)
1298 int short_slot_time
;
1301 * ht_opmode - HT operation mode or -1 if HT not in use
1306 * interworking - Whether Interworking is enabled
1311 * hessid - Homogeneous ESS identifier or %NULL if not set
1316 * access_network_type - Access Network Type (0..15)
1318 * This is used for filtering Probe Request frames when Interworking is
1321 u8 access_network_type
;
1324 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1326 * This is used by driver which advertises this capability.
1328 int ap_max_inactivity
;
1331 * ctwindow - Client Traffic Window (in TUs)
1336 * smps_mode - SMPS mode
1338 * SMPS mode to be used by the AP, specified as the relevant bits of
1339 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1341 unsigned int smps_mode
;
1344 * disable_dgaf - Whether group-addressed frames are disabled
1349 * osen - Whether OSEN security is enabled
1354 * freq - Channel parameters for dynamic bandwidth changes
1356 struct hostapd_freq_params
*freq
;
1359 * reenable - Whether this is to re-enable beaconing
1364 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1365 * infrastructure BSS. Valid only for DMG network.
1370 * multicast_to_unicast - Whether to use multicast_to_unicast
1372 * If this is non-zero, the AP is requested to perform multicast to
1373 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1374 * 802.1Q). If enabled, such frames are to be sent to each station
1375 * separately, with the DA replaced by their own MAC address rather
1376 * than the group address.
1378 * Note that this may break certain expectations of the receiver, such
1379 * as the ability to drop unicast IP packets received within multicast
1380 * L2 frames, or the ability to not send ICMP destination unreachable
1381 * messages for packets received in L2 multicast (which is required,
1382 * but the receiver can't tell the difference if this new option is
1385 * This also doesn't implement the 802.11 DMS (directed multicast
1388 int multicast_to_unicast
;
1391 * ftm_responder - Whether FTM responder is enabled
1396 * lci - Binary data, the content of an LCI report IE with type 8 as
1397 * defined in IEEE Std 802.11-2016, 9.4.2.22.10
1399 const struct wpabuf
*lci
;
1402 * civic - Binary data, the content of a measurement report IE with
1403 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
1405 const struct wpabuf
*civic
;
1408 struct wpa_driver_mesh_bss_params
{
1409 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1410 #define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1411 #define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1412 #define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
1413 #define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010
1415 * TODO: Other mesh configuration parameters would go here.
1416 * See NL80211_MESHCONF_* for all the mesh config parameters.
1420 int peer_link_timeout
;
1426 struct wpa_driver_mesh_join_params
{
1429 const int *basic_rates
;
1432 struct hostapd_freq_params freq
;
1435 struct wpa_driver_mesh_bss_params conf
;
1436 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1437 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1438 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1439 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1444 * struct wpa_driver_capa - Driver capability information
1446 struct wpa_driver_capa
{
1447 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1448 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1449 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1450 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1451 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1452 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1453 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1454 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1455 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1456 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
1457 #define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
1458 #define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
1459 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1460 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1461 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1462 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
1463 #define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000
1464 /** Bitfield of supported key management suites */
1465 unsigned int key_mgmt
;
1467 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1468 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1469 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1470 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1471 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1472 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1473 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1474 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1475 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1476 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1477 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1478 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1479 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1480 /** Bitfield of supported cipher suites */
1483 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1484 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1485 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1486 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1489 /** Driver generated WPA/RSN IE */
1490 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1491 /** Driver needs static WEP key setup after association command */
1492 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1493 /** Driver takes care of all DFS operations */
1494 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1495 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1496 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1497 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008
1498 /** Driver is for a wired Ethernet interface */
1499 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1500 /** Driver provides separate commands for authentication and association (SME in
1501 * wpa_supplicant). */
1502 #define WPA_DRIVER_FLAGS_SME 0x00000020
1503 /** Driver supports AP mode */
1504 #define WPA_DRIVER_FLAGS_AP 0x00000040
1505 /** Driver needs static WEP key setup after association has been completed */
1506 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1507 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1508 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1509 /** Driver supports concurrent P2P operations */
1510 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1512 * Driver uses the initial interface as a dedicated management interface, i.e.,
1513 * it cannot be used for P2P group operations or non-P2P purposes.
1515 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1516 /** This interface is P2P capable (P2P GO or P2P Client) */
1517 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1518 /** Driver supports station and key removal when stopping an AP */
1519 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1521 * Driver uses the initial interface for P2P management interface and non-P2P
1522 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1523 * P2P group operations.
1525 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1527 * Driver is known to use sane error codes, i.e., when it indicates that
1528 * something (e.g., association) fails, there was indeed a failure and the
1529 * operation does not end up getting completed successfully later.
1531 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1532 /** Driver supports off-channel TX */
1533 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1534 /** Driver indicates TX status events for EAPOL Data frames */
1535 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1536 /** Driver indicates TX status events for Deauth/Disassoc frames */
1537 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1538 /** Driver supports roaming (BSS selection) in firmware */
1539 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1540 /** Driver supports operating as a TDLS peer */
1541 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1542 /** Driver requires external TDLS setup/teardown/discovery */
1543 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1544 /** Driver indicates support for Probe Response offloading in AP mode */
1545 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1546 /** Driver supports U-APSD in AP mode */
1547 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1548 /** Driver supports inactivity timer in AP mode */
1549 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1550 /** Driver expects user space implementation of MLME in AP mode */
1551 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1552 /** Driver supports SAE with user space SME */
1553 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1554 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1555 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1556 /** Driver supports IBSS (Ad-hoc) mode */
1557 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1558 /** Driver supports radar detection */
1559 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1560 /** Driver supports a dedicated interface for P2P Device */
1561 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1562 /** Driver supports QoS Mapping */
1563 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1564 /** Driver supports CSA in AP mode */
1565 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1566 /** Driver supports mesh */
1567 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1568 /** Driver support ACS offload */
1569 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1570 /** Driver supports key management offload */
1571 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1572 /** Driver supports TDLS channel switching */
1573 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1574 /** Driver supports IBSS with HT datarates */
1575 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
1576 /** Driver supports IBSS with VHT datarates */
1577 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
1578 /** Driver supports automatic band selection */
1579 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
1580 /** Driver supports simultaneous off-channel operations */
1581 #define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
1582 /** Driver supports full AP client state */
1583 #define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
1584 /** Driver supports P2P Listen offload */
1585 #define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
1586 /** Driver supports FILS */
1587 #define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
1588 /** Driver supports Beacon frame TX rate configuration (legacy rates) */
1589 #define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1590 /** Driver supports Beacon frame TX rate configuration (HT rates) */
1591 #define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1592 /** Driver supports Beacon frame TX rate configuration (VHT rates) */
1593 #define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
1594 /** Driver supports mgmt_tx with random TX address in non-connected state */
1595 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
1596 /** Driver supports mgmt_tx with random TX addr in connected state */
1597 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
1598 /** Driver supports better BSS reporting with sched_scan in connected mode */
1599 #define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
1600 /** Driver supports HE capabilities */
1601 #define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
1602 /** Driver supports FILS shared key offload */
1603 #define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
1604 /** Driver supports all OCE STA specific mandatory features */
1605 #define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
1606 /** Driver supports all OCE AP specific mandatory features */
1607 #define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
1609 * Driver supports all OCE STA-CFON specific mandatory features only.
1610 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
1611 * userspace shall assume that this driver may not support all OCE AP
1612 * functionality but can support only OCE STA-CFON functionality.
1614 #define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
1615 /** Driver supports MFP-optional in the connect command */
1616 #define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL
1617 /** Driver is a self-managed regulatory device */
1618 #define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL
1619 /** Driver supports FTM responder functionality */
1620 #define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL
1621 /** Driver support 4-way handshake offload for WPA-Personal */
1622 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
1625 #define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1626 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1628 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1629 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1630 unsigned int smps_modes
;
1632 unsigned int wmm_ac_supported
:1;
1634 unsigned int mac_addr_rand_scan_supported
:1;
1635 unsigned int mac_addr_rand_sched_scan_supported
:1;
1637 /** Maximum number of supported active probe SSIDs */
1640 /** Maximum number of supported active probe SSIDs for sched_scan */
1641 int max_sched_scan_ssids
;
1643 /** Maximum number of supported scan plans for scheduled scan */
1644 unsigned int max_sched_scan_plans
;
1646 /** Maximum interval in a scan plan. In seconds */
1647 u32 max_sched_scan_plan_interval
;
1649 /** Maximum number of iterations in a single scan plan */
1650 u32 max_sched_scan_plan_iterations
;
1652 /** Whether sched_scan (offloaded scanning) is supported */
1653 int sched_scan_supported
;
1655 /** Maximum number of supported match sets for sched_scan */
1659 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1661 unsigned int max_remain_on_chan
;
1664 * max_stations - Maximum number of associated stations the driver
1665 * supports in AP mode
1667 unsigned int max_stations
;
1670 * probe_resp_offloads - Bitmap of supported protocols by the driver
1671 * for Probe Response offloading.
1673 /** Driver Probe Response offloading support for WPS ver. 1 */
1674 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1675 /** Driver Probe Response offloading support for WPS ver. 2 */
1676 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1677 /** Driver Probe Response offloading support for P2P */
1678 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1679 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1680 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1681 unsigned int probe_resp_offloads
;
1683 unsigned int max_acl_mac_addrs
;
1686 * Number of supported concurrent channels
1688 unsigned int num_multichan_concurrent
;
1691 * extended_capa - extended capabilities in driver/device
1693 * Must be allocated and freed by driver and the pointers must be
1694 * valid for the lifetime of the driver, i.e., freed in deinit()
1696 const u8
*extended_capa
, *extended_capa_mask
;
1697 unsigned int extended_capa_len
;
1699 struct wowlan_triggers wowlan_triggers
;
1701 /** Driver adds the DS Params Set IE in Probe Request frames */
1702 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1703 /** Driver adds the WFA TPC IE in Probe Request frames */
1704 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1705 /** Driver handles quiet period requests */
1706 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1708 * Driver is capable of inserting the current TX power value into the body of
1709 * transmitted frames.
1710 * Background: Some Action frames include a TPC Report IE. This IE contains a
1711 * TX power field, which has to be updated by lower layers. One such Action
1712 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1713 * of spectrum management). Note that this insertion takes place at a fixed
1714 * offset, namely the 6th byte in the Action frame body.
1716 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1718 * Driver supports RRM. With this support, the driver will accept to use RRM in
1719 * (Re)Association Request frames, without supporting quiet period.
1721 #define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1723 /** Driver supports setting the scan dwell time */
1724 #define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
1725 /** Driver supports Beacon Report Measurement */
1726 #define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
1730 /* Driver concurrency capabilities */
1731 unsigned int conc_capab
;
1732 /* Maximum number of concurrent channels on 2.4 GHz */
1733 unsigned int max_conc_chan_2_4
;
1734 /* Maximum number of concurrent channels on 5 GHz */
1735 unsigned int max_conc_chan_5_0
;
1737 /* Maximum number of supported CSA counters */
1738 u16 max_csa_counters
;
1742 struct hostapd_data
;
1744 #define STA_DRV_DATA_TX_MCS BIT(0)
1745 #define STA_DRV_DATA_RX_MCS BIT(1)
1746 #define STA_DRV_DATA_TX_VHT_MCS BIT(2)
1747 #define STA_DRV_DATA_RX_VHT_MCS BIT(3)
1748 #define STA_DRV_DATA_TX_VHT_NSS BIT(4)
1749 #define STA_DRV_DATA_RX_VHT_NSS BIT(5)
1750 #define STA_DRV_DATA_TX_SHORT_GI BIT(6)
1751 #define STA_DRV_DATA_RX_SHORT_GI BIT(7)
1752 #define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
1754 struct hostap_sta_driver_data
{
1755 unsigned long rx_packets
, tx_packets
;
1756 unsigned long long rx_bytes
, tx_bytes
;
1757 unsigned long long rx_airtime
, tx_airtime
;
1758 int bytes_64bit
; /* whether 64-bit byte counters are supported */
1759 unsigned long current_tx_rate
;
1760 unsigned long current_rx_rate
;
1761 unsigned long inactive_msec
;
1762 unsigned long flags
; /* bitfield of STA_DRV_DATA_* */
1763 unsigned long num_ps_buf_frames
;
1764 unsigned long tx_retry_failed
;
1765 unsigned long tx_retry_count
;
1767 unsigned long backlog_packets
;
1768 unsigned long backlog_bytes
;
1778 struct hostapd_sta_add_params
{
1782 const u8
*supp_rates
;
1783 size_t supp_rates_len
;
1784 u16 listen_interval
;
1785 const struct ieee80211_ht_capabilities
*ht_capabilities
;
1786 const struct ieee80211_vht_capabilities
*vht_capabilities
;
1787 int vht_opmode_enabled
;
1789 const struct ieee80211_he_capabilities
*he_capab
;
1790 size_t he_capab_len
;
1791 u32 flags
; /* bitmask of WPA_STA_* flags */
1792 u32 flags_mask
; /* unset bits in flags */
1794 enum mesh_plink_state plink_state
;
1796 #endif /* CONFIG_MESH */
1797 int set
; /* Set STA parameters instead of add */
1799 const u8
*ext_capab
;
1800 size_t ext_capab_len
;
1801 const u8
*supp_channels
;
1802 size_t supp_channels_len
;
1803 const u8
*supp_oper_classes
;
1804 size_t supp_oper_classes_len
;
1808 struct mac_address
{
1812 struct hostapd_acl_params
{
1814 unsigned int num_mac_acl
;
1815 struct mac_address mac_acl
[0];
1818 enum wpa_driver_if_type
{
1820 * WPA_IF_STATION - Station mode interface
1825 * WPA_IF_AP_VLAN - AP mode VLAN interface
1827 * This interface shares its address and Beacon frame with the main
1833 * WPA_IF_AP_BSS - AP mode BSS interface
1835 * This interface has its own address and Beacon frame.
1840 * WPA_IF_P2P_GO - P2P Group Owner
1845 * WPA_IF_P2P_CLIENT - P2P Client
1850 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1851 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1856 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1857 * abstracted P2P Device function in the driver
1862 * WPA_IF_MESH - Mesh interface
1867 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1872 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1877 struct wpa_init_params
{
1881 const char *driver_params
;
1882 int use_pae_group_addr
;
1886 u8
*own_addr
; /* buffer for writing own MAC address */
1890 struct wpa_bss_params
{
1891 /** Interface name (for multi-SSID/VLAN support) */
1893 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1902 enum mfp_options ieee80211w
;
1905 #define WPA_STA_AUTHORIZED BIT(0)
1906 #define WPA_STA_WMM BIT(1)
1907 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1908 #define WPA_STA_MFP BIT(3)
1909 #define WPA_STA_TDLS_PEER BIT(4)
1910 #define WPA_STA_AUTHENTICATED BIT(5)
1911 #define WPA_STA_ASSOCIATED BIT(6)
1924 WNM_SLEEP_ENTER_CONFIRM
,
1925 WNM_SLEEP_ENTER_FAIL
,
1926 WNM_SLEEP_EXIT_CONFIRM
,
1927 WNM_SLEEP_EXIT_FAIL
,
1928 WNM_SLEEP_TFS_REQ_IE_ADD
, /* STA requests driver to add TFS req IE */
1929 WNM_SLEEP_TFS_REQ_IE_NONE
, /* STA requests empty TFS req IE */
1930 WNM_SLEEP_TFS_REQ_IE_SET
, /* AP requests driver to set TFS req IE for
1932 WNM_SLEEP_TFS_RESP_IE_ADD
, /* AP requests driver to add TFS resp IE
1934 WNM_SLEEP_TFS_RESP_IE_NONE
, /* AP requests empty TFS resp IE */
1935 WNM_SLEEP_TFS_RESP_IE_SET
, /* AP requests driver to set TFS resp IE
1937 WNM_SLEEP_TFS_IE_DEL
/* AP delete the TFS IE */
1940 /* enum smps_mode - SMPS mode definitions */
1951 #define WPA_INVALID_NOISE 9999
1954 * struct wpa_signal_info - Information about channel signal quality
1955 * @frequency: control frequency
1956 * @above_threshold: true if the above threshold was crossed
1957 * (relevant for a CQM event)
1958 * @current_signal: in dBm
1959 * @avg_signal: in dBm
1960 * @avg_beacon_signal: in dBm
1961 * @current_noise: %WPA_INVALID_NOISE if not supported
1962 * @current_txrate: current TX rate
1963 * @chanwidth: channel width
1964 * @center_frq1: center frequency for the first segment
1965 * @center_frq2: center frequency for the second segment (if relevant)
1967 struct wpa_signal_info
{
1969 int above_threshold
;
1972 int avg_beacon_signal
;
1975 enum chan_width chanwidth
;
1981 * struct wpa_channel_info - Information about the current channel
1982 * @frequency: Center frequency of the primary 20 MHz channel
1983 * @chanwidth: Width of the current operating channel
1984 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
1985 * This field is only filled in when using a 40 MHz channel.
1986 * @center_frq1: Center frequency of frequency segment 0
1987 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
1988 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
1989 * derived from center_frq2 for convenience.
1991 struct wpa_channel_info
{
1993 enum chan_width chanwidth
;
2001 * struct beacon_data - Beacon data
2002 * @head: Head portion of Beacon frame (before TIM IE)
2003 * @tail: Tail portion of Beacon frame (after TIM IE)
2004 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2005 * @proberesp_ies: Extra information element(s) to add into Probe Response
2007 * @assocresp_ies: Extra information element(s) to add into (Re)Association
2008 * Response frames or %NULL
2009 * @probe_resp: Probe Response frame template
2010 * @head_len: Length of @head
2011 * @tail_len: Length of @tail
2012 * @beacon_ies_len: Length of beacon_ies in octets
2013 * @proberesp_ies_len: Length of proberesp_ies in octets
2014 * @proberesp_ies_len: Length of proberesp_ies in octets
2015 * @probe_resp_len: Length of probe response template (@probe_resp)
2017 struct beacon_data
{
2024 size_t head_len
, tail_len
;
2025 size_t beacon_ies_len
;
2026 size_t proberesp_ies_len
;
2027 size_t assocresp_ies_len
;
2028 size_t probe_resp_len
;
2032 * struct csa_settings - Settings for channel switch command
2033 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2034 * @block_tx: 1 - block transmission for CSA period
2035 * @freq_params: Next channel frequency parameter
2036 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2037 * @beacon_after: Next beacon/probe resp/asooc resp info
2038 * @counter_offset_beacon: Offset to the count field in beacon's tail
2039 * @counter_offset_presp: Offset to the count field in probe resp.
2041 struct csa_settings
{
2045 struct hostapd_freq_params freq_params
;
2046 struct beacon_data beacon_csa
;
2047 struct beacon_data beacon_after
;
2049 u16 counter_offset_beacon
[2];
2050 u16 counter_offset_presp
[2];
2053 /* TDLS peer capabilities for send_tdls_mgmt() */
2054 enum tdls_peer_capability
{
2055 TDLS_PEER_HT
= BIT(0),
2056 TDLS_PEER_VHT
= BIT(1),
2057 TDLS_PEER_WMM
= BIT(2),
2060 /* valid info in the wmm_params struct */
2061 enum wmm_params_valid_info
{
2062 WMM_PARAMS_UAPSD_QUEUES_INFO
= BIT(0),
2066 * struct wmm_params - WMM parameterss configured for this association
2067 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2068 * of the struct contain valid information.
2069 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2070 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2077 #ifdef CONFIG_MACSEC
2078 struct macsec_init_params
{
2079 Boolean always_include_sci
;
2083 #endif /* CONFIG_MACSEC */
2085 enum drv_br_port_attr
{
2086 DRV_BR_PORT_ATTR_PROXYARP
,
2087 DRV_BR_PORT_ATTR_HAIRPIN_MODE
,
2090 enum drv_br_net_param
{
2091 DRV_BR_NET_PARAM_GARP_ACCEPT
,
2092 DRV_BR_MULTICAST_SNOOPING
,
2095 struct drv_acs_params
{
2096 /* Selected mode (HOSTAPD_MODE_*) */
2097 enum hostapd_hw_mode hw_mode
;
2099 /* Indicates whether HT is enabled */
2102 /* Indicates whether HT40 is enabled */
2105 /* Indicates whether VHT is enabled */
2108 /* Configured ACS channel width */
2111 /* ACS channel list info */
2112 unsigned int ch_list_len
;
2114 const int *freq_list
;
2117 struct wpa_bss_trans_info
{
2118 u8 mbo_transition_reason
;
2123 struct wpa_bss_candidate_info
{
2125 struct candidate_list
{
2132 struct wpa_pmkid_params
{
2136 const u8
*fils_cache_id
;
2142 /* Mask used to specify which connection parameters have to be updated */
2143 enum wpa_drv_update_connect_params_mask
{
2144 WPA_DRV_UPDATE_ASSOC_IES
= BIT(0),
2145 WPA_DRV_UPDATE_FILS_ERP_INFO
= BIT(1),
2146 WPA_DRV_UPDATE_AUTH_TYPE
= BIT(2),
2150 * struct external_auth - External authentication trigger parameters
2152 * These are used across the external authentication request and event
2154 * @action: Action type / trigger for external authentication. Only significant
2155 * for the event interface.
2156 * @bssid: BSSID of the peer with which the authentication has to happen. Used
2157 * by both the request and event interface.
2158 * @ssid: SSID of the AP. Used by both the request and event interface.
2159 * @ssid_len: SSID length in octets.
2160 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2161 * the request interface.
2162 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2163 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2164 * the real status code for failures. Used only for the request interface
2165 * from user space to the driver.
2166 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
2168 struct external_auth
{
2176 unsigned int key_mgmt_suite
;
2182 * struct wpa_driver_ops - Driver interface API definition
2184 * This structure defines the API that each driver interface needs to implement
2185 * for core wpa_supplicant code. All driver specific functionality is captured
2188 struct wpa_driver_ops
{
2189 /** Name of the driver interface */
2191 /** One line description of the driver interface */
2195 * get_bssid - Get the current BSSID
2196 * @priv: private driver interface data
2197 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2199 * Returns: 0 on success, -1 on failure
2201 * Query kernel driver for the current BSSID and copy it to bssid.
2202 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2205 int (*get_bssid
)(void *priv
, u8
*bssid
);
2208 * get_ssid - Get the current SSID
2209 * @priv: private driver interface data
2210 * @ssid: buffer for SSID (at least 32 bytes)
2212 * Returns: Length of the SSID on success, -1 on failure
2214 * Query kernel driver for the current SSID and copy it to ssid.
2215 * Returning zero is recommended if the STA is not associated.
2217 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2218 * can, at least in theory, contain control characters (including nul)
2219 * and as such, should be processed as binary data, not a printable
2222 int (*get_ssid
)(void *priv
, u8
*ssid
);
2225 * set_key - Configure encryption key
2226 * @ifname: Interface name (for multi-SSID/VLAN support)
2227 * @priv: private driver interface data
2228 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
2229 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
2230 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
2231 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
2232 * %WPA_ALG_BIP_CMAC_256);
2233 * %WPA_ALG_NONE clears the key.
2234 * @addr: Address of the peer STA (BSSID of the current AP when setting
2235 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
2236 * broadcast keys, %NULL for default keys that are used both for
2237 * broadcast and unicast; when clearing keys, %NULL is used to
2238 * indicate that both the broadcast-only and default key of the
2239 * specified key index is to be cleared
2240 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
2242 * @set_tx: configure this key as the default Tx key (only used when
2243 * driver does not support separate unicast/individual key
2244 * @seq: sequence number/packet number, seq_len octets, the next
2245 * packet number to be used for in replay protection; configured
2246 * for Rx keys (in most cases, this is only used with broadcast
2247 * keys and set to zero for unicast keys); %NULL if not set
2248 * @seq_len: length of the seq, depends on the algorithm:
2249 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
2250 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
2252 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
2253 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
2255 * Returns: 0 on success, -1 on failure
2257 * Configure the given key for the kernel driver. If the driver
2258 * supports separate individual keys (4 default keys + 1 individual),
2259 * addr can be used to determine whether the key is default or
2260 * individual. If only 4 keys are supported, the default key with key
2261 * index 0 is used as the individual key. STA must be configured to use
2262 * it as the default Tx key (set_tx is set) and accept Rx for all the
2263 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2264 * broadcast keys, so key index 0 is available for this kind of
2267 * Please note that TKIP keys include separate TX and RX MIC keys and
2268 * some drivers may expect them in different order than wpa_supplicant
2269 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
2270 * will trigger Michael MIC errors. This can be fixed by changing the
2271 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
2272 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2273 * example on how this can be done.
2275 int (*set_key
)(const char *ifname
, void *priv
, enum wpa_alg alg
,
2276 const u8
*addr
, int key_idx
, int set_tx
,
2277 const u8
*seq
, size_t seq_len
,
2278 const u8
*key
, size_t key_len
);
2281 * init - Initialize driver interface
2282 * @ctx: context to be used when calling wpa_supplicant functions,
2283 * e.g., wpa_supplicant_event()
2284 * @ifname: interface name, e.g., wlan0
2286 * Returns: Pointer to private data, %NULL on failure
2288 * Initialize driver interface, including event processing for kernel
2289 * driver events (e.g., associated, scan results, Michael MIC failure).
2290 * This function can allocate a private configuration data area for
2291 * @ctx, file descriptor, interface name, etc. information that may be
2292 * needed in future driver operations. If this is not used, non-NULL
2293 * value will need to be returned because %NULL is used to indicate
2294 * failure. The returned value will be used as 'void *priv' data for
2295 * all other driver_ops functions.
2297 * The main event loop (eloop.c) of wpa_supplicant can be used to
2298 * register callback for read sockets (eloop_register_read_sock()).
2300 * See below for more information about events and
2301 * wpa_supplicant_event() function.
2303 void * (*init
)(void *ctx
, const char *ifname
);
2306 * deinit - Deinitialize driver interface
2307 * @priv: private driver interface data from init()
2309 * Shut down driver interface and processing of driver events. Free
2310 * private data buffer if one was allocated in init() handler.
2312 void (*deinit
)(void *priv
);
2315 * set_param - Set driver configuration parameters
2316 * @priv: private driver interface data from init()
2317 * @param: driver specific configuration parameters
2319 * Returns: 0 on success, -1 on failure
2321 * Optional handler for notifying driver interface about configuration
2322 * parameters (driver_param).
2324 int (*set_param
)(void *priv
, const char *param
);
2327 * set_countermeasures - Enable/disable TKIP countermeasures
2328 * @priv: private driver interface data
2329 * @enabled: 1 = countermeasures enabled, 0 = disabled
2331 * Returns: 0 on success, -1 on failure
2333 * Configure TKIP countermeasures. When these are enabled, the driver
2334 * should drop all received and queued frames that are using TKIP.
2336 int (*set_countermeasures
)(void *priv
, int enabled
);
2339 * deauthenticate - Request driver to deauthenticate
2340 * @priv: private driver interface data
2341 * @addr: peer address (BSSID of the AP)
2342 * @reason_code: 16-bit reason code to be sent in the deauthentication
2345 * Returns: 0 on success, -1 on failure
2347 int (*deauthenticate
)(void *priv
, const u8
*addr
, u16 reason_code
);
2350 * associate - Request driver to associate
2351 * @priv: private driver interface data
2352 * @params: association parameters
2354 * Returns: 0 on success, -1 on failure
2356 int (*associate
)(void *priv
,
2357 struct wpa_driver_associate_params
*params
);
2360 * add_pmkid - Add PMKSA cache entry to the driver
2361 * @priv: private driver interface data
2362 * @params: PMKSA parameters
2364 * Returns: 0 on success, -1 on failure
2366 * This function is called when a new PMK is received, as a result of
2367 * either normal authentication or RSN pre-authentication. The PMKSA
2368 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2369 * ssid, fils_cache_id, pmkid, and pmk.
2371 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2372 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2373 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2374 * driver_ops function does not need to be implemented. Likewise, if
2375 * the driver does not support WPA, this function is not needed.
2377 int (*add_pmkid
)(void *priv
, struct wpa_pmkid_params
*params
);
2380 * remove_pmkid - Remove PMKSA cache entry to the driver
2381 * @priv: private driver interface data
2382 * @params: PMKSA parameters
2384 * Returns: 0 on success, -1 on failure
2386 * This function is called when the supplicant drops a PMKSA cache
2387 * entry for any reason. The PMKSA parameters are either a set of
2388 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
2390 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2391 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2392 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2393 * from wpa_supplicant, this driver_ops function does not need to be
2394 * implemented. Likewise, if the driver does not support WPA, this
2395 * function is not needed.
2397 int (*remove_pmkid
)(void *priv
, struct wpa_pmkid_params
*params
);
2400 * flush_pmkid - Flush PMKSA cache
2401 * @priv: private driver interface data
2403 * Returns: 0 on success, -1 on failure
2405 * This function is called when the supplicant drops all PMKSA cache
2406 * entries for any reason.
2408 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2409 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2410 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2411 * from wpa_supplicant, this driver_ops function does not need to be
2412 * implemented. Likewise, if the driver does not support WPA, this
2413 * function is not needed.
2415 int (*flush_pmkid
)(void *priv
);
2418 * get_capa - Get driver capabilities
2419 * @priv: private driver interface data
2421 * Returns: 0 on success, -1 on failure
2423 * Get driver/firmware/hardware capabilities.
2425 int (*get_capa
)(void *priv
, struct wpa_driver_capa
*capa
);
2428 * poll - Poll driver for association information
2429 * @priv: private driver interface data
2431 * This is an option callback that can be used when the driver does not
2432 * provide event mechanism for association events. This is called when
2433 * receiving WPA EAPOL-Key messages that require association
2434 * information. The driver interface is supposed to generate associnfo
2435 * event before returning from this callback function. In addition, the
2436 * driver interface should generate an association event after having
2437 * sent out associnfo.
2439 void (*poll
)(void *priv
);
2442 * get_ifindex - Get interface index
2443 * @priv: private driver interface data
2445 * Returns: Interface index
2447 unsigned int (*get_ifindex
)(void *priv
);
2450 * get_ifname - Get interface name
2451 * @priv: private driver interface data
2453 * Returns: Pointer to the interface name. This can differ from the
2454 * interface name used in init() call. Init() is called first.
2456 * This optional function can be used to allow the driver interface to
2457 * replace the interface name with something else, e.g., based on an
2458 * interface mapping from a more descriptive name.
2460 const char * (*get_ifname
)(void *priv
);
2463 * get_mac_addr - Get own MAC address
2464 * @priv: private driver interface data
2466 * Returns: Pointer to own MAC address or %NULL on failure
2468 * This optional function can be used to get the own MAC address of the
2469 * device from the driver interface code. This is only needed if the
2470 * l2_packet implementation for the OS does not provide easy access to
2472 const u8
* (*get_mac_addr
)(void *priv
);
2475 * set_operstate - Sets device operating state to DORMANT or UP
2476 * @priv: private driver interface data
2477 * @state: 0 = dormant, 1 = up
2478 * Returns: 0 on success, -1 on failure
2480 * This is an optional function that can be used on operating systems
2481 * that support a concept of controlling network device state from user
2482 * space applications. This function, if set, gets called with
2483 * state = 1 when authentication has been completed and with state = 0
2484 * when connection is lost.
2486 int (*set_operstate
)(void *priv
, int state
);
2489 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2490 * @priv: Private driver interface data
2491 * @addr: Address of the station for which to set protection (may be
2492 * %NULL for group keys)
2493 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2494 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2495 * Returns: 0 on success, -1 on failure
2497 * This is an optional function that can be used to set the driver to
2498 * require protection for Tx and/or Rx frames. This uses the layer
2499 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2500 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2501 * set protection operation; instead, they set protection implicitly
2502 * based on configured keys.
2504 int (*mlme_setprotection
)(void *priv
, const u8
*addr
, int protect_type
,
2508 * get_hw_feature_data - Get hardware support data (channels and rates)
2509 * @priv: Private driver interface data
2510 * @num_modes: Variable for returning the number of returned modes
2511 * flags: Variable for returning hardware feature flags
2512 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
2513 * Returns: Pointer to allocated hardware data on success or %NULL on
2514 * failure. Caller is responsible for freeing this.
2516 struct hostapd_hw_modes
* (*get_hw_feature_data
)(void *priv
,
2518 u16
*flags
, u8
*dfs
);
2521 * send_mlme - Send management frame from MLME
2522 * @priv: Private driver interface data
2523 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2524 * @data_len: Size of the management frame
2525 * @noack: Do not wait for this frame to be acked (disable retries)
2526 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2528 * @csa_offs: Array of CSA offsets or %NULL
2529 * @csa_offs_len: Number of elements in csa_offs
2530 * Returns: 0 on success, -1 on failure
2532 int (*send_mlme
)(void *priv
, const u8
*data
, size_t data_len
,
2533 int noack
, unsigned int freq
, const u16
*csa_offs
,
2534 size_t csa_offs_len
);
2537 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2538 * @priv: Private driver interface data
2539 * @md: Mobility domain (2 octets) (also included inside ies)
2540 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2541 * @ies_len: Length of FT IEs in bytes
2542 * Returns: 0 on success, -1 on failure
2544 * The supplicant uses this callback to let the driver know that keying
2545 * material for FT is available and that the driver can use the
2546 * provided IEs in the next message in FT authentication sequence.
2548 * This function is only needed for driver that support IEEE 802.11r
2549 * (Fast BSS Transition).
2551 int (*update_ft_ies
)(void *priv
, const u8
*md
, const u8
*ies
,
2555 * get_scan_results2 - Fetch the latest scan results
2556 * @priv: private driver interface data
2558 * Returns: Allocated buffer of scan results (caller is responsible for
2559 * freeing the data structure) on success, NULL on failure
2561 struct wpa_scan_results
* (*get_scan_results2
)(void *priv
);
2564 * set_country - Set country
2565 * @priv: Private driver interface data
2566 * @alpha2: country to which to switch to
2567 * Returns: 0 on success, -1 on failure
2569 * This function is for drivers which support some form
2570 * of setting a regulatory domain.
2572 int (*set_country
)(void *priv
, const char *alpha2
);
2575 * get_country - Get country
2576 * @priv: Private driver interface data
2577 * @alpha2: Buffer for returning country code (at least 3 octets)
2578 * Returns: 0 on success, -1 on failure
2580 int (*get_country
)(void *priv
, char *alpha2
);
2583 * global_init - Global driver initialization
2584 * @ctx: wpa_global pointer
2585 * Returns: Pointer to private data (global), %NULL on failure
2587 * This optional function is called to initialize the driver wrapper
2588 * for global data, i.e., data that applies to all interfaces. If this
2589 * function is implemented, global_deinit() will also need to be
2590 * implemented to free the private data. The driver will also likely
2591 * use init2() function instead of init() to get the pointer to global
2592 * data available to per-interface initializer.
2594 void * (*global_init
)(void *ctx
);
2597 * global_deinit - Global driver deinitialization
2598 * @priv: private driver global data from global_init()
2600 * Terminate any global driver related functionality and free the
2601 * global data structure.
2603 void (*global_deinit
)(void *priv
);
2606 * init2 - Initialize driver interface (with global data)
2607 * @ctx: context to be used when calling wpa_supplicant functions,
2608 * e.g., wpa_supplicant_event()
2609 * @ifname: interface name, e.g., wlan0
2610 * @global_priv: private driver global data from global_init()
2611 * Returns: Pointer to private data, %NULL on failure
2613 * This function can be used instead of init() if the driver wrapper
2616 void * (*init2
)(void *ctx
, const char *ifname
, void *global_priv
);
2619 * get_interfaces - Get information about available interfaces
2620 * @global_priv: private driver global data from global_init()
2621 * Returns: Allocated buffer of interface information (caller is
2622 * responsible for freeing the data structure) on success, NULL on
2625 struct wpa_interface_info
* (*get_interfaces
)(void *global_priv
);
2628 * scan2 - Request the driver to initiate scan
2629 * @priv: private driver interface data
2630 * @params: Scan parameters
2632 * Returns: 0 on success, -1 on failure
2634 * Once the scan results are ready, the driver should report scan
2635 * results event for wpa_supplicant which will eventually request the
2636 * results with wpa_driver_get_scan_results2().
2638 int (*scan2
)(void *priv
, struct wpa_driver_scan_params
*params
);
2641 * authenticate - Request driver to authenticate
2642 * @priv: private driver interface data
2643 * @params: authentication parameters
2644 * Returns: 0 on success, -1 on failure
2646 * This is an optional function that can be used with drivers that
2647 * support separate authentication and association steps, i.e., when
2648 * wpa_supplicant can act as the SME. If not implemented, associate()
2649 * function is expected to take care of IEEE 802.11 authentication,
2652 int (*authenticate
)(void *priv
,
2653 struct wpa_driver_auth_params
*params
);
2656 * set_ap - Set Beacon and Probe Response information for AP mode
2657 * @priv: Private driver interface data
2658 * @params: Parameters to use in AP mode
2660 * This function is used to configure Beacon template and/or extra IEs
2661 * to add for Beacon and Probe Response frames for the driver in
2662 * AP mode. The driver is responsible for building the full Beacon
2663 * frame by concatenating the head part with TIM IE generated by the
2664 * driver/firmware and finishing with the tail part. Depending on the
2665 * driver architectue, this can be done either by using the full
2666 * template or the set of additional IEs (e.g., WPS and P2P IE).
2667 * Similarly, Probe Response processing depends on the driver design.
2668 * If the driver (or firmware) takes care of replying to Probe Request
2669 * frames, the extra IEs provided here needs to be added to the Probe
2672 * Returns: 0 on success, -1 on failure
2674 int (*set_ap
)(void *priv
, struct wpa_driver_ap_params
*params
);
2677 * set_acl - Set ACL in AP mode
2678 * @priv: Private driver interface data
2679 * @params: Parameters to configure ACL
2680 * Returns: 0 on success, -1 on failure
2682 * This is used only for the drivers which support MAC address ACL.
2684 int (*set_acl
)(void *priv
, struct hostapd_acl_params
*params
);
2687 * hapd_init - Initialize driver interface (hostapd only)
2688 * @hapd: Pointer to hostapd context
2689 * @params: Configuration for the driver wrapper
2690 * Returns: Pointer to private data, %NULL on failure
2692 * This function is used instead of init() or init2() when the driver
2693 * wrapper is used with hostapd.
2695 void * (*hapd_init
)(struct hostapd_data
*hapd
,
2696 struct wpa_init_params
*params
);
2699 * hapd_deinit - Deinitialize driver interface (hostapd only)
2700 * @priv: Private driver interface data from hapd_init()
2702 void (*hapd_deinit
)(void *priv
);
2705 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2706 * @priv: Private driver interface data
2707 * @params: BSS parameters
2708 * Returns: 0 on success, -1 on failure
2710 * This is an optional function to configure the kernel driver to
2711 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2712 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2713 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2714 * for Beacon frames.
2716 * DEPRECATED - use set_ap() instead
2718 int (*set_ieee8021x
)(void *priv
, struct wpa_bss_params
*params
);
2721 * set_privacy - Enable/disable privacy (AP only)
2722 * @priv: Private driver interface data
2723 * @enabled: 1 = privacy enabled, 0 = disabled
2724 * Returns: 0 on success, -1 on failure
2726 * This is an optional function to configure privacy field in the
2727 * kernel driver for Beacon frames. This can be left undefined (set to
2728 * %NULL) if the driver uses the Beacon template from set_ap().
2730 * DEPRECATED - use set_ap() instead
2732 int (*set_privacy
)(void *priv
, int enabled
);
2735 * get_seqnum - Fetch the current TSC/packet number (AP only)
2736 * @ifname: The interface name (main or virtual)
2737 * @priv: Private driver interface data
2738 * @addr: MAC address of the station or %NULL for group keys
2740 * @seq: Buffer for returning the latest used TSC/packet number
2741 * Returns: 0 on success, -1 on failure
2743 * This function is used to fetch the last used TSC/packet number for
2744 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2745 * keys, so there is no strict requirement on implementing support for
2746 * unicast keys (i.e., addr != %NULL).
2748 int (*get_seqnum
)(const char *ifname
, void *priv
, const u8
*addr
,
2752 * flush - Flush all association stations (AP only)
2753 * @priv: Private driver interface data
2754 * Returns: 0 on success, -1 on failure
2756 * This function requests the driver to disassociate all associated
2757 * stations. This function does not need to be implemented if the
2758 * driver does not process association frames internally.
2760 int (*flush
)(void *priv
);
2763 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2764 * @priv: Private driver interface data
2765 * @elem: Information elements
2766 * @elem_len: Length of the elem buffer in octets
2767 * Returns: 0 on success, -1 on failure
2769 * This is an optional function to add information elements in the
2770 * kernel driver for Beacon and Probe Response frames. This can be left
2771 * undefined (set to %NULL) if the driver uses the Beacon template from
2774 * DEPRECATED - use set_ap() instead
2776 int (*set_generic_elem
)(void *priv
, const u8
*elem
, size_t elem_len
);
2779 * read_sta_data - Fetch station data
2780 * @priv: Private driver interface data
2781 * @data: Buffer for returning station information
2782 * @addr: MAC address of the station
2783 * Returns: 0 on success, -1 on failure
2785 int (*read_sta_data
)(void *priv
, struct hostap_sta_driver_data
*data
,
2789 * hapd_send_eapol - Send an EAPOL packet (AP only)
2790 * @priv: private driver interface data
2791 * @addr: Destination MAC address
2792 * @data: EAPOL packet starting with IEEE 802.1X header
2793 * @data_len: Length of the EAPOL packet in octets
2794 * @encrypt: Whether the frame should be encrypted
2795 * @own_addr: Source MAC address
2796 * @flags: WPA_STA_* flags for the destination station
2798 * Returns: 0 on success, -1 on failure
2800 int (*hapd_send_eapol
)(void *priv
, const u8
*addr
, const u8
*data
,
2801 size_t data_len
, int encrypt
,
2802 const u8
*own_addr
, u32 flags
);
2805 * sta_deauth - Deauthenticate a station (AP only)
2806 * @priv: Private driver interface data
2807 * @own_addr: Source address and BSSID for the Deauthentication frame
2808 * @addr: MAC address of the station to deauthenticate
2809 * @reason: Reason code for the Deauthentiation frame
2810 * Returns: 0 on success, -1 on failure
2812 * This function requests a specific station to be deauthenticated and
2813 * a Deauthentication frame to be sent to it.
2815 int (*sta_deauth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2819 * sta_disassoc - Disassociate a station (AP only)
2820 * @priv: Private driver interface data
2821 * @own_addr: Source address and BSSID for the Disassociation frame
2822 * @addr: MAC address of the station to disassociate
2823 * @reason: Reason code for the Disassociation frame
2824 * Returns: 0 on success, -1 on failure
2826 * This function requests a specific station to be disassociated and
2827 * a Disassociation frame to be sent to it.
2829 int (*sta_disassoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2833 * sta_remove - Remove a station entry (AP only)
2834 * @priv: Private driver interface data
2835 * @addr: MAC address of the station to be removed
2836 * Returns: 0 on success, -1 on failure
2838 int (*sta_remove
)(void *priv
, const u8
*addr
);
2841 * hapd_get_ssid - Get the current SSID (AP only)
2842 * @priv: Private driver interface data
2843 * @buf: Buffer for returning the SSID
2844 * @len: Maximum length of the buffer
2845 * Returns: Length of the SSID on success, -1 on failure
2847 * This function need not be implemented if the driver uses Beacon
2848 * template from set_ap() and does not reply to Probe Request frames.
2850 int (*hapd_get_ssid
)(void *priv
, u8
*buf
, int len
);
2853 * hapd_set_ssid - Set SSID (AP only)
2854 * @priv: Private driver interface data
2856 * @len: Length of the SSID in octets
2857 * Returns: 0 on success, -1 on failure
2859 * DEPRECATED - use set_ap() instead
2861 int (*hapd_set_ssid
)(void *priv
, const u8
*buf
, int len
);
2864 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2865 * @priv: Private driver interface data
2866 * @enabled: 1 = countermeasures enabled, 0 = disabled
2867 * Returns: 0 on success, -1 on failure
2869 * This need not be implemented if the driver does not take care of
2870 * association processing.
2872 int (*hapd_set_countermeasures
)(void *priv
, int enabled
);
2875 * sta_add - Add a station entry
2876 * @priv: Private driver interface data
2877 * @params: Station parameters
2878 * Returns: 0 on success, -1 on failure
2880 * This function is used to add or set (params->set 1) a station
2881 * entry in the driver. Adding STA entries is used only if the driver
2882 * does not take care of association processing.
2884 * With drivers that don't support full AP client state, this function
2885 * is used to add a station entry to the driver once the station has
2886 * completed association.
2888 * With TDLS, this function is used to add or set (params->set 1)
2889 * TDLS peer entries (even with drivers that do not support full AP
2892 int (*sta_add
)(void *priv
, struct hostapd_sta_add_params
*params
);
2895 * get_inact_sec - Get station inactivity duration (AP only)
2896 * @priv: Private driver interface data
2897 * @addr: Station address
2898 * Returns: Number of seconds station has been inactive, -1 on failure
2900 int (*get_inact_sec
)(void *priv
, const u8
*addr
);
2903 * sta_clear_stats - Clear station statistics (AP only)
2904 * @priv: Private driver interface data
2905 * @addr: Station address
2906 * Returns: 0 on success, -1 on failure
2908 int (*sta_clear_stats
)(void *priv
, const u8
*addr
);
2911 * set_freq - Set channel/frequency (AP only)
2912 * @priv: Private driver interface data
2913 * @freq: Channel parameters
2914 * Returns: 0 on success, -1 on failure
2916 int (*set_freq
)(void *priv
, struct hostapd_freq_params
*freq
);
2919 * set_rts - Set RTS threshold
2920 * @priv: Private driver interface data
2921 * @rts: RTS threshold in octets
2922 * Returns: 0 on success, -1 on failure
2924 int (*set_rts
)(void *priv
, int rts
);
2927 * set_frag - Set fragmentation threshold
2928 * @priv: Private driver interface data
2929 * @frag: Fragmentation threshold in octets
2930 * Returns: 0 on success, -1 on failure
2932 int (*set_frag
)(void *priv
, int frag
);
2935 * sta_set_flags - Set station flags (AP only)
2936 * @priv: Private driver interface data
2937 * @addr: Station address
2938 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2939 * @flags_or: Bitmap of WPA_STA_* flags to add
2940 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2941 * Returns: 0 on success, -1 on failure
2943 int (*sta_set_flags
)(void *priv
, const u8
*addr
,
2944 unsigned int total_flags
, unsigned int flags_or
,
2945 unsigned int flags_and
);
2948 * sta_set_airtime_weight - Set station airtime weight (AP only)
2949 * @priv: Private driver interface data
2950 * @addr: Station address
2951 * @weight: New weight for station airtime assignment
2952 * Returns: 0 on success, -1 on failure
2954 int (*sta_set_airtime_weight
)(void *priv
, const u8
*addr
,
2955 unsigned int weight
);
2958 * set_tx_queue_params - Set TX queue parameters
2959 * @priv: Private driver interface data
2960 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2964 * @burst_time: Maximum length for bursting in 0.1 msec units
2966 int (*set_tx_queue_params
)(void *priv
, int queue
, int aifs
, int cw_min
,
2967 int cw_max
, int burst_time
);
2970 * if_add - Add a virtual interface
2971 * @priv: Private driver interface data
2972 * @type: Interface type
2973 * @ifname: Interface name for the new virtual interface
2974 * @addr: Local address to use for the interface or %NULL to use the
2975 * parent interface address
2976 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2977 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2978 * not allowed (applies only to %WPA_IF_AP_BSS type)
2979 * @force_ifname: Buffer for returning an interface name that the
2980 * driver ended up using if it differs from the requested ifname
2981 * @if_addr: Buffer for returning the allocated interface address
2982 * (this may differ from the requested addr if the driver cannot
2983 * change interface address)
2984 * @bridge: Bridge interface to use or %NULL if no bridge configured
2985 * @use_existing: Whether to allow existing interface to be used
2986 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
2987 * Returns: 0 on success, -1 on failure
2989 int (*if_add
)(void *priv
, enum wpa_driver_if_type type
,
2990 const char *ifname
, const u8
*addr
, void *bss_ctx
,
2991 void **drv_priv
, char *force_ifname
, u8
*if_addr
,
2992 const char *bridge
, int use_existing
, int setup_ap
);
2995 * if_remove - Remove a virtual interface
2996 * @priv: Private driver interface data
2997 * @type: Interface type
2998 * @ifname: Interface name of the virtual interface to be removed
2999 * Returns: 0 on success, -1 on failure
3001 int (*if_remove
)(void *priv
, enum wpa_driver_if_type type
,
3002 const char *ifname
);
3005 * set_sta_vlan - Bind a station into a specific interface (AP only)
3006 * @priv: Private driver interface data
3007 * @ifname: Interface (main or virtual BSS or VLAN)
3008 * @addr: MAC address of the associated station
3010 * Returns: 0 on success, -1 on failure
3012 * This function is used to bind a station to a specific virtual
3013 * interface. It is only used if when virtual interfaces are supported,
3014 * e.g., to assign stations to different VLAN interfaces based on
3015 * information from a RADIUS server. This allows separate broadcast
3016 * domains to be used with a single BSS.
3018 int (*set_sta_vlan
)(void *priv
, const u8
*addr
, const char *ifname
,
3022 * commit - Optional commit changes handler (AP only)
3023 * @priv: driver private data
3024 * Returns: 0 on success, -1 on failure
3026 * This optional handler function can be registered if the driver
3027 * interface implementation needs to commit changes (e.g., by setting
3028 * network interface up) at the end of initial configuration. If set,
3029 * this handler will be called after initial setup has been completed.
3031 int (*commit
)(void *priv
);
3034 * send_ether - Send an ethernet packet (AP only)
3035 * @priv: private driver interface data
3036 * @dst: Destination MAC address
3037 * @src: Source MAC address
3039 * @data: EAPOL packet starting with IEEE 802.1X header
3040 * @data_len: Length of the EAPOL packet in octets
3041 * Returns: 0 on success, -1 on failure
3043 int (*send_ether
)(void *priv
, const u8
*dst
, const u8
*src
, u16 proto
,
3044 const u8
*data
, size_t data_len
);
3047 * set_radius_acl_auth - Notification of RADIUS ACL change
3048 * @priv: Private driver interface data
3049 * @mac: MAC address of the station
3050 * @accepted: Whether the station was accepted
3051 * @session_timeout: Session timeout for the station
3052 * Returns: 0 on success, -1 on failure
3054 int (*set_radius_acl_auth
)(void *priv
, const u8
*mac
, int accepted
,
3055 u32 session_timeout
);
3058 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3059 * @priv: Private driver interface data
3060 * @mac: MAC address of the station
3061 * Returns: 0 on success, -1 on failure
3063 int (*set_radius_acl_expire
)(void *priv
, const u8
*mac
);
3066 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
3067 * @priv: Private driver interface data
3068 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3069 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3071 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3072 * to remove extra IE(s)
3073 * Returns: 0 on success, -1 on failure
3075 * This is an optional function to add WPS IE in the kernel driver for
3076 * Beacon and Probe Response frames. This can be left undefined (set
3077 * to %NULL) if the driver uses the Beacon template from set_ap()
3078 * and does not process Probe Request frames. If the driver takes care
3079 * of (Re)Association frame processing, the assocresp buffer includes
3080 * WPS IE(s) that need to be added to (Re)Association Response frames
3081 * whenever a (Re)Association Request frame indicated use of WPS.
3083 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3084 * frames when operating as a GO. The driver is responsible for adding
3085 * timing related attributes (e.g., NoA) in addition to the IEs
3086 * included here by appending them after these buffers. This call is
3087 * also used to provide Probe Response IEs for P2P Listen state
3088 * operations for drivers that generate the Probe Response frames
3091 * DEPRECATED - use set_ap() instead
3093 int (*set_ap_wps_ie
)(void *priv
, const struct wpabuf
*beacon
,
3094 const struct wpabuf
*proberesp
,
3095 const struct wpabuf
*assocresp
);
3098 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3099 * @priv: Private driver interface data
3100 * @authorized: Whether the port is authorized
3101 * Returns: 0 on success, -1 on failure
3103 int (*set_supp_port
)(void *priv
, int authorized
);
3106 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3107 * @priv: Private driver interface data
3108 * @addr: MAC address of the associated station
3109 * @aid: Association ID
3110 * @val: 1 = bind to 4-address WDS; 0 = unbind
3111 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3112 * to indicate that bridge is not to be used
3113 * @ifname_wds: Buffer to return the interface name for the new WDS
3114 * station or %NULL to indicate name is not returned.
3115 * Returns: 0 on success, -1 on failure
3117 int (*set_wds_sta
)(void *priv
, const u8
*addr
, int aid
, int val
,
3118 const char *bridge_ifname
, char *ifname_wds
);
3121 * send_action - Transmit an Action frame
3122 * @priv: Private driver interface data
3123 * @freq: Frequency (in MHz) of the channel
3124 * @wait: Time to wait off-channel for a response (in ms), or zero
3125 * @dst: Destination MAC address (Address 1)
3126 * @src: Source MAC address (Address 2)
3127 * @bssid: BSSID (Address 3)
3129 * @data_len: data length in octets
3130 @ @no_cck: Whether CCK rates must not be used to transmit this frame
3131 * Returns: 0 on success, -1 on failure
3133 * This command can be used to request the driver to transmit an action
3134 * frame to the specified destination.
3136 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3137 * be transmitted on the given channel and the device will wait for a
3138 * response on that channel for the given wait time.
3140 * If the flag is not set, the wait time will be ignored. In this case,
3141 * if a remain-on-channel duration is in progress, the frame must be
3142 * transmitted on that channel; alternatively the frame may be sent on
3143 * the current operational channel (if in associated state in station
3144 * mode or while operating as an AP.)
3146 * If @src differs from the device MAC address, use of a random
3147 * transmitter address is requested for this message exchange.
3149 int (*send_action
)(void *priv
, unsigned int freq
, unsigned int wait
,
3150 const u8
*dst
, const u8
*src
, const u8
*bssid
,
3151 const u8
*data
, size_t data_len
, int no_cck
);
3154 * send_action_cancel_wait - Cancel action frame TX wait
3155 * @priv: Private driver interface data
3157 * This command cancels the wait time associated with sending an action
3158 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3159 * set in the driver flags.
3161 void (*send_action_cancel_wait
)(void *priv
);
3164 * remain_on_channel - Remain awake on a channel
3165 * @priv: Private driver interface data
3166 * @freq: Frequency (in MHz) of the channel
3167 * @duration: Duration in milliseconds
3168 * Returns: 0 on success, -1 on failure
3170 * This command is used to request the driver to remain awake on the
3171 * specified channel for the specified duration and report received
3172 * Action frames with EVENT_RX_MGMT events. Optionally, received
3173 * Probe Request frames may also be requested to be reported by calling
3174 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3176 * The driver may not be at the requested channel when this function
3177 * returns, i.e., the return code is only indicating whether the
3178 * request was accepted. The caller will need to wait until the
3179 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3180 * completed the channel change. This may take some time due to other
3181 * need for the radio and the caller should be prepared to timing out
3182 * its wait since there are no guarantees on when this request can be
3185 int (*remain_on_channel
)(void *priv
, unsigned int freq
,
3186 unsigned int duration
);
3189 * cancel_remain_on_channel - Cancel remain-on-channel operation
3190 * @priv: Private driver interface data
3192 * This command can be used to cancel a remain-on-channel operation
3193 * before its originally requested duration has passed. This could be
3194 * used, e.g., when remain_on_channel() is used to request extra time
3195 * to receive a response to an Action frame and the response is
3196 * received when there is still unneeded time remaining on the
3197 * remain-on-channel operation.
3199 int (*cancel_remain_on_channel
)(void *priv
);
3202 * probe_req_report - Request Probe Request frames to be indicated
3203 * @priv: Private driver interface data
3204 * @report: Whether to report received Probe Request frames
3205 * Returns: 0 on success, -1 on failure (or if not supported)
3207 * This command can be used to request the driver to indicate when
3208 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3209 * Since this operation may require extra resources, e.g., due to less
3210 * optimal hardware/firmware RX filtering, many drivers may disable
3211 * Probe Request reporting at least in station mode. This command is
3212 * used to notify the driver when the Probe Request frames need to be
3213 * reported, e.g., during remain-on-channel operations.
3215 int (*probe_req_report
)(void *priv
, int report
);
3218 * deinit_ap - Deinitialize AP mode
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. If the interface was not dynamically added,
3224 * change the driver mode to station mode to allow normal station
3225 * operations like scanning to be completed.
3227 int (*deinit_ap
)(void *priv
);
3230 * deinit_p2p_cli - Deinitialize P2P client mode
3231 * @priv: Private driver interface data
3232 * Returns: 0 on success, -1 on failure (or if not supported)
3234 * This optional function can be used to disable P2P client mode. If the
3235 * interface was not dynamically added, change the interface type back
3238 int (*deinit_p2p_cli
)(void *priv
);
3241 * suspend - Notification on system suspend/hibernate event
3242 * @priv: Private driver interface data
3244 void (*suspend
)(void *priv
);
3247 * resume - Notification on system resume/thaw event
3248 * @priv: Private driver interface data
3250 void (*resume
)(void *priv
);
3253 * signal_monitor - Set signal monitoring parameters
3254 * @priv: Private driver interface data
3255 * @threshold: Threshold value for signal change events; 0 = disabled
3256 * @hysteresis: Minimum change in signal strength before indicating a
3258 * Returns: 0 on success, -1 on failure (or if not supported)
3260 * This function can be used to configure monitoring of signal strength
3261 * with the current AP. Whenever signal strength drops below the
3262 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3263 * should be generated assuming the signal strength has changed at
3264 * least %hysteresis from the previously indicated signal change event.
3266 int (*signal_monitor
)(void *priv
, int threshold
, int hysteresis
);
3269 * send_frame - Send IEEE 802.11 frame (testing use only)
3270 * @priv: Private driver interface data
3271 * @data: IEEE 802.11 frame with IEEE 802.11 header
3272 * @data_len: Size of the frame
3273 * @encrypt: Whether to encrypt the frame (if keys are set)
3274 * Returns: 0 on success, -1 on failure
3276 * This function is only used for debugging purposes and is not
3277 * required to be implemented for normal operations.
3279 int (*send_frame
)(void *priv
, const u8
*data
, size_t data_len
,
3283 * get_noa - Get current Notice of Absence attribute payload
3284 * @priv: Private driver interface data
3285 * @buf: Buffer for returning NoA
3286 * @buf_len: Buffer length in octets
3287 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3288 * advertized, or -1 on failure
3290 * This function is used to fetch the current Notice of Absence
3291 * attribute value from GO.
3293 int (*get_noa
)(void *priv
, u8
*buf
, size_t buf_len
);
3296 * set_noa - Set Notice of Absence parameters for GO (testing)
3297 * @priv: Private driver interface data
3299 * @start: Start time in ms from next TBTT
3300 * @duration: Duration in ms
3301 * Returns: 0 on success or -1 on failure
3303 * This function is used to set Notice of Absence parameters for GO. It
3304 * is used only for testing. To disable NoA, all parameters are set to
3307 int (*set_noa
)(void *priv
, u8 count
, int start
, int duration
);
3310 * set_p2p_powersave - Set P2P power save options
3311 * @priv: Private driver interface data
3312 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3313 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3314 * @ctwindow: 0.. = change (msec), -1 = no change
3315 * Returns: 0 on success or -1 on failure
3317 int (*set_p2p_powersave
)(void *priv
, int legacy_ps
, int opp_ps
,
3321 * ampdu - Enable/disable aggregation
3322 * @priv: Private driver interface data
3323 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3324 * Returns: 0 on success or -1 on failure
3326 int (*ampdu
)(void *priv
, int ampdu
);
3329 * get_radio_name - Get physical radio name for the device
3330 * @priv: Private driver interface data
3331 * Returns: Radio name or %NULL if not known
3333 * The returned data must not be modified by the caller. It is assumed
3334 * that any interface that has the same radio name as another is
3335 * sharing the same physical radio. This information can be used to
3336 * share scan results etc. information between the virtual interfaces
3337 * to speed up various operations.
3339 const char * (*get_radio_name
)(void *priv
);
3342 * send_tdls_mgmt - for sending TDLS management packets
3343 * @priv: private driver interface data
3344 * @dst: Destination (peer) MAC address
3345 * @action_code: TDLS action code for the mssage
3346 * @dialog_token: Dialog Token to use in the message (if needed)
3347 * @status_code: Status Code or Reason Code to use (if needed)
3348 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
3349 * @initiator: Is the current end the TDLS link initiator
3350 * @buf: TDLS IEs to add to the message
3351 * @len: Length of buf in octets
3352 * Returns: 0 on success, negative (<0) on failure
3354 * This optional function can be used to send packet to driver which is
3355 * responsible for receiving and sending all TDLS packets.
3357 int (*send_tdls_mgmt
)(void *priv
, const u8
*dst
, u8 action_code
,
3358 u8 dialog_token
, u16 status_code
, u32 peer_capab
,
3359 int initiator
, const u8
*buf
, size_t len
);
3362 * tdls_oper - Ask the driver to perform high-level TDLS operations
3363 * @priv: Private driver interface data
3364 * @oper: TDLS high-level operation. See %enum tdls_oper
3365 * @peer: Destination (peer) MAC address
3366 * Returns: 0 on success, negative (<0) on failure
3368 * This optional function can be used to send high-level TDLS commands
3371 int (*tdls_oper
)(void *priv
, enum tdls_oper oper
, const u8
*peer
);
3374 * wnm_oper - Notify driver of the WNM frame reception
3375 * @priv: Private driver interface data
3376 * @oper: WNM operation. See %enum wnm_oper
3377 * @peer: Destination (peer) MAC address
3378 * @buf: Buffer for the driver to fill in (for getting IE)
3379 * @buf_len: Return the len of buf
3380 * Returns: 0 on success, negative (<0) on failure
3382 int (*wnm_oper
)(void *priv
, enum wnm_oper oper
, const u8
*peer
,
3383 u8
*buf
, u16
*buf_len
);
3386 * set_qos_map - Set QoS Map
3387 * @priv: Private driver interface data
3388 * @qos_map_set: QoS Map
3389 * @qos_map_set_len: Length of QoS Map
3391 int (*set_qos_map
)(void *priv
, const u8
*qos_map_set
,
3392 u8 qos_map_set_len
);
3395 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3396 * @priv: Private driver interface data
3397 * @version: IP version of the IP address, 4 or 6
3398 * @ipaddr: IP address for the neigh entry
3399 * @prefixlen: IP address prefix length
3400 * @addr: Corresponding MAC address
3401 * Returns: 0 on success, negative (<0) on failure
3403 int (*br_add_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
,
3404 int prefixlen
, const u8
*addr
);
3407 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3408 * @priv: Private driver interface data
3409 * @version: IP version of the IP address, 4 or 6
3410 * @ipaddr: IP address for the neigh entry
3411 * Returns: 0 on success, negative (<0) on failure
3413 int (*br_delete_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
);
3416 * br_port_set_attr - Set a bridge port attribute
3417 * @attr: Bridge port attribute to set
3418 * @val: Value to be set
3419 * Returns: 0 on success, negative (<0) on failure
3421 int (*br_port_set_attr
)(void *priv
, enum drv_br_port_attr attr
,
3425 * br_port_set_attr - Set a bridge network parameter
3426 * @param: Bridge parameter to set
3427 * @val: Value to be set
3428 * Returns: 0 on success, negative (<0) on failure
3430 int (*br_set_net_param
)(void *priv
, enum drv_br_net_param param
,
3434 * set_wowlan - Set wake-on-wireless triggers
3435 * @priv: Private driver interface data
3436 * @triggers: wowlan triggers
3438 int (*set_wowlan
)(void *priv
, const struct wowlan_triggers
*triggers
);
3441 * signal_poll - Get current connection information
3442 * @priv: Private driver interface data
3443 * @signal_info: Connection info structure
3445 int (*signal_poll
)(void *priv
, struct wpa_signal_info
*signal_info
);
3448 * channel_info - Get parameters of the current operating channel
3449 * @priv: Private driver interface data
3450 * @channel_info: Channel info structure
3451 * Returns: 0 on success, negative (<0) on failure
3453 int (*channel_info
)(void *priv
, struct wpa_channel_info
*channel_info
);
3456 * set_authmode - Set authentication algorithm(s) for static WEP
3457 * @priv: Private driver interface data
3458 * @authmode: 1=Open System, 2=Shared Key, 3=both
3459 * Returns: 0 on success, -1 on failure
3461 * This function can be used to set authentication algorithms for AP
3462 * mode when static WEP is used. If the driver uses user space MLME/SME
3463 * implementation, there is no need to implement this function.
3465 * DEPRECATED - use set_ap() instead
3467 int (*set_authmode
)(void *priv
, int authmode
);
3471 * driver_cmd - Execute driver-specific command
3472 * @priv: Private driver interface data
3473 * @cmd: Command to execute
3474 * @buf: Return buffer
3475 * @buf_len: Buffer length
3476 * Returns: 0 on success, -1 on failure
3478 int (*driver_cmd
)(void *priv
, char *cmd
, char *buf
, size_t buf_len
);
3479 #endif /* ANDROID */
3482 * vendor_cmd - Execute vendor specific command
3483 * @priv: Private driver interface data
3484 * @vendor_id: Vendor id
3485 * @subcmd: Vendor command id
3486 * @data: Vendor command parameters (%NULL if no parameters)
3487 * @data_len: Data length
3488 * @buf: Return buffer (%NULL to ignore reply)
3489 * Returns: 0 on success, negative (<0) on failure
3491 * This function handles vendor specific commands that are passed to
3492 * the driver/device. The command is identified by vendor id and
3493 * command id. Parameters can be passed as argument to the command
3494 * in the data buffer. Reply (if any) will be filled in the supplied
3497 * The exact driver behavior is driver interface and vendor specific. As
3498 * an example, this will be converted to a vendor specific cfg80211
3499 * command in case of the nl80211 driver interface.
3501 int (*vendor_cmd
)(void *priv
, unsigned int vendor_id
,
3502 unsigned int subcmd
, const u8
*data
, size_t data_len
,
3503 struct wpabuf
*buf
);
3506 * set_rekey_info - Set rekey information
3507 * @priv: Private driver interface data
3509 * @kek_len: KEK length in octets
3511 * @kck_len: KCK length in octets
3512 * @replay_ctr: Current EAPOL-Key Replay Counter
3514 * This optional function can be used to provide information for the
3515 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3516 * while the host (including wpa_supplicant) is sleeping.
3518 void (*set_rekey_info
)(void *priv
, const u8
*kek
, size_t kek_len
,
3519 const u8
*kck
, size_t kck_len
,
3520 const u8
*replay_ctr
);
3523 * sta_assoc - Station association indication
3524 * @priv: Private driver interface data
3525 * @own_addr: Source address and BSSID for association frame
3526 * @addr: MAC address of the station to associate
3527 * @reassoc: flag to indicate re-association
3528 * @status: association response status code
3529 * @ie: assoc response ie buffer
3530 * @len: ie buffer length
3531 * Returns: 0 on success, -1 on failure
3533 * This function indicates the driver to send (Re)Association
3534 * Response frame to the station.
3536 int (*sta_assoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
3537 int reassoc
, u16 status
, const u8
*ie
, size_t len
);
3540 * sta_auth - Station authentication indication
3541 * @priv: private driver interface data
3542 * @params: Station authentication parameters
3544 * Returns: 0 on success, -1 on failure
3546 int (*sta_auth
)(void *priv
,
3547 struct wpa_driver_sta_auth_params
*params
);
3550 * add_tspec - Add traffic stream
3551 * @priv: Private driver interface data
3552 * @addr: MAC address of the station to associate
3553 * @tspec_ie: tspec ie buffer
3554 * @tspec_ielen: tspec ie length
3555 * Returns: 0 on success, -1 on failure
3557 * This function adds the traffic steam for the station
3558 * and fills the medium_time in tspec_ie.
3560 int (*add_tspec
)(void *priv
, const u8
*addr
, u8
*tspec_ie
,
3561 size_t tspec_ielen
);
3564 * add_sta_node - Add a station node in the driver
3565 * @priv: Private driver interface data
3566 * @addr: MAC address of the station to add
3567 * @auth_alg: authentication algorithm used by the station
3568 * Returns: 0 on success, -1 on failure
3570 * This function adds the station node in the driver, when
3571 * the station gets added by FT-over-DS.
3573 int (*add_sta_node
)(void *priv
, const u8
*addr
, u16 auth_alg
);
3576 * sched_scan - Request the driver to initiate scheduled scan
3577 * @priv: Private driver interface data
3578 * @params: Scan parameters
3579 * Returns: 0 on success, -1 on failure
3581 * This operation should be used for scheduled scan offload to
3582 * the hardware. Every time scan results are available, the
3583 * driver should report scan results event for wpa_supplicant
3584 * which will eventually request the results with
3585 * wpa_driver_get_scan_results2(). This operation is optional
3586 * and if not provided or if it returns -1, we fall back to
3587 * normal host-scheduled scans.
3589 int (*sched_scan
)(void *priv
, struct wpa_driver_scan_params
*params
);
3592 * stop_sched_scan - Request the driver to stop a scheduled scan
3593 * @priv: Private driver interface data
3594 * Returns: 0 on success, -1 on failure
3596 * This should cause the scheduled scan to be stopped and
3597 * results should stop being sent. Must be supported if
3598 * sched_scan is supported.
3600 int (*stop_sched_scan
)(void *priv
);
3603 * poll_client - Probe (null data or such) the given station
3604 * @priv: Private driver interface data
3605 * @own_addr: MAC address of sending interface
3606 * @addr: MAC address of the station to probe
3607 * @qos: Indicates whether station is QoS station
3609 * This function is used to verify whether an associated station is
3610 * still present. This function does not need to be implemented if the
3611 * driver provides such inactivity polling mechanism.
3613 void (*poll_client
)(void *priv
, const u8
*own_addr
,
3614 const u8
*addr
, int qos
);
3617 * radio_disable - Disable/enable radio
3618 * @priv: Private driver interface data
3619 * @disabled: 1=disable 0=enable radio
3620 * Returns: 0 on success, -1 on failure
3622 * This optional command is for testing purposes. It can be used to
3623 * disable the radio on a testbed device to simulate out-of-radio-range
3626 int (*radio_disable
)(void *priv
, int disabled
);
3629 * switch_channel - Announce channel switch and migrate the GO to the
3631 * @priv: Private driver interface data
3632 * @settings: Settings for CSA period and new channel
3633 * Returns: 0 on success, -1 on failure
3635 * This function is used to move the GO to the legacy STA channel to
3636 * avoid frequency conflict in single channel concurrency.
3638 int (*switch_channel
)(void *priv
, struct csa_settings
*settings
);
3641 * add_tx_ts - Add traffic stream
3642 * @priv: Private driver interface data
3643 * @tsid: Traffic stream ID
3644 * @addr: Receiver address
3645 * @user_prio: User priority of the traffic stream
3646 * @admitted_time: Admitted time for this TS in units of
3647 * 32 microsecond periods (per second).
3648 * Returns: 0 on success, -1 on failure
3650 int (*add_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
, u8 user_prio
,
3654 * del_tx_ts - Delete traffic stream
3655 * @priv: Private driver interface data
3656 * @tsid: Traffic stream ID
3657 * @addr: Receiver address
3658 * Returns: 0 on success, -1 on failure
3660 int (*del_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
);
3663 * Enable channel-switching with TDLS peer
3664 * @priv: Private driver interface data
3665 * @addr: MAC address of the TDLS peer
3666 * @oper_class: Operating class of the switch channel
3667 * @params: Channel specification
3668 * Returns: 0 on success, -1 on failure
3670 * The function indicates to driver that it can start switching to a
3671 * different channel with a specified TDLS peer. The switching is
3672 * assumed on until canceled with tdls_disable_channel_switch().
3674 int (*tdls_enable_channel_switch
)(
3675 void *priv
, const u8
*addr
, u8 oper_class
,
3676 const struct hostapd_freq_params
*params
);
3679 * Disable channel switching with TDLS peer
3680 * @priv: Private driver interface data
3681 * @addr: MAC address of the TDLS peer
3682 * Returns: 0 on success, -1 on failure
3684 * This function indicates to the driver that it should stop switching
3685 * with a given TDLS peer.
3687 int (*tdls_disable_channel_switch
)(void *priv
, const u8
*addr
);
3690 * start_dfs_cac - Listen for radar interference on the channel
3691 * @priv: Private driver interface data
3692 * @freq: Channel parameters
3693 * Returns: 0 on success, -1 on failure
3695 int (*start_dfs_cac
)(void *priv
, struct hostapd_freq_params
*freq
);
3698 * stop_ap - Removes beacon from AP
3699 * @priv: Private driver interface data
3700 * Returns: 0 on success, -1 on failure (or if not supported)
3702 * This optional function can be used to disable AP mode related
3703 * configuration. Unlike deinit_ap, it does not change to station
3706 int (*stop_ap
)(void *priv
);
3709 * get_survey - Retrieve survey data
3710 * @priv: Private driver interface data
3711 * @freq: If set, survey data for the specified frequency is only
3712 * being requested. If not set, all survey data is requested.
3713 * Returns: 0 on success, -1 on failure
3715 * Use this to retrieve:
3717 * - the observed channel noise floor
3718 * - the amount of time we have spent on the channel
3719 * - the amount of time during which we have spent on the channel that
3720 * the radio has determined the medium is busy and we cannot
3722 * - the amount of time we have spent receiving data
3723 * - the amount of time we have spent transmitting data
3725 * This data can be used for spectrum heuristics. One example is
3726 * Automatic Channel Selection (ACS). The channel survey data is
3727 * kept on a linked list on the channel data, one entry is added
3728 * for each survey. The min_nf of the channel is updated for each
3731 int (*get_survey
)(void *priv
, unsigned int freq
);
3734 * status - Get driver interface status information
3735 * @priv: Private driver interface data
3736 * @buf: Buffer for printing the status information
3737 * @buflen: Maximum length of the buffer
3738 * Returns: Length of written status information or -1 on failure
3740 int (*status
)(void *priv
, char *buf
, size_t buflen
);
3743 * roaming - Set roaming policy for driver-based BSS selection
3744 * @priv: Private driver interface data
3745 * @allowed: Whether roaming within ESS is allowed
3746 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3747 * Returns: Length of written status information or -1 on failure
3749 * This optional callback can be used to update roaming policy from the
3750 * associate() command (bssid being set there indicates that the driver
3751 * should not roam before getting this roaming() call to allow roaming.
3752 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3753 * capability, roaming policy is handled within wpa_supplicant and there
3754 * is no need to implement or react to this callback.
3756 int (*roaming
)(void *priv
, int allowed
, const u8
*bssid
);
3759 * disable_fils - Enable/disable FILS feature
3760 * @priv: Private driver interface data
3761 * @disable: 0-enable and 1-disable FILS feature
3762 * Returns: 0 on success, -1 on failure
3764 * This callback can be used to configure driver and below layers to
3765 * enable/disable all FILS features.
3767 int (*disable_fils
)(void *priv
, int disable
);
3770 * set_mac_addr - Set MAC address
3771 * @priv: Private driver interface data
3772 * @addr: MAC address to use or %NULL for setting back to permanent
3773 * Returns: 0 on success, -1 on failure
3775 int (*set_mac_addr
)(void *priv
, const u8
*addr
);
3777 #ifdef CONFIG_MACSEC
3778 int (*macsec_init
)(void *priv
, struct macsec_init_params
*params
);
3780 int (*macsec_deinit
)(void *priv
);
3783 * macsec_get_capability - Inform MKA of this driver's capability
3784 * @priv: Private driver interface data
3785 * @cap: Driver's capability
3786 * Returns: 0 on success, -1 on failure
3788 int (*macsec_get_capability
)(void *priv
, enum macsec_cap
*cap
);
3791 * enable_protect_frames - Set protect frames status
3792 * @priv: Private driver interface data
3793 * @enabled: TRUE = protect frames enabled
3794 * FALSE = protect frames disabled
3795 * Returns: 0 on success, -1 on failure (or if not supported)
3797 int (*enable_protect_frames
)(void *priv
, Boolean enabled
);
3800 * enable_encrypt - Set encryption status
3801 * @priv: Private driver interface data
3802 * @enabled: TRUE = encrypt outgoing traffic
3803 * FALSE = integrity-only protection on outgoing traffic
3804 * Returns: 0 on success, -1 on failure (or if not supported)
3806 int (*enable_encrypt
)(void *priv
, Boolean enabled
);
3809 * set_replay_protect - Set replay protect status and window size
3810 * @priv: Private driver interface data
3811 * @enabled: TRUE = replay protect enabled
3812 * FALSE = replay protect disabled
3813 * @window: replay window size, valid only when replay protect enabled
3814 * Returns: 0 on success, -1 on failure (or if not supported)
3816 int (*set_replay_protect
)(void *priv
, Boolean enabled
, u32 window
);
3819 * set_current_cipher_suite - Set current cipher suite
3820 * @priv: Private driver interface data
3821 * @cs: EUI64 identifier
3822 * Returns: 0 on success, -1 on failure (or if not supported)
3824 int (*set_current_cipher_suite
)(void *priv
, u64 cs
);
3827 * enable_controlled_port - Set controlled port status
3828 * @priv: Private driver interface data
3829 * @enabled: TRUE = controlled port enabled
3830 * FALSE = controlled port disabled
3831 * Returns: 0 on success, -1 on failure (or if not supported)
3833 int (*enable_controlled_port
)(void *priv
, Boolean enabled
);
3836 * get_receive_lowest_pn - Get receive lowest pn
3837 * @priv: Private driver interface data
3838 * @sa: secure association
3839 * Returns: 0 on success, -1 on failure (or if not supported)
3841 int (*get_receive_lowest_pn
)(void *priv
, struct receive_sa
*sa
);
3844 * get_transmit_next_pn - Get transmit next pn
3845 * @priv: Private driver interface data
3846 * @sa: secure association
3847 * Returns: 0 on success, -1 on failure (or if not supported)
3849 int (*get_transmit_next_pn
)(void *priv
, struct transmit_sa
*sa
);
3852 * set_transmit_next_pn - Set transmit next pn
3853 * @priv: Private driver interface data
3854 * @sa: secure association
3855 * Returns: 0 on success, -1 on failure (or if not supported)
3857 int (*set_transmit_next_pn
)(void *priv
, struct transmit_sa
*sa
);
3860 * set_receive_lowest_pn - Set receive lowest PN
3861 * @priv: Private driver interface data
3862 * @sa: secure association
3863 * Returns: 0 on success, -1 on failure (or if not supported)
3865 int (*set_receive_lowest_pn
)(void *priv
, struct receive_sa
*sa
);
3868 * create_receive_sc - create secure channel for receiving
3869 * @priv: Private driver interface data
3870 * @sc: secure channel
3871 * @conf_offset: confidentiality offset (0, 30, or 50)
3872 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3874 * Returns: 0 on success, -1 on failure (or if not supported)
3876 int (*create_receive_sc
)(void *priv
, struct receive_sc
*sc
,
3877 unsigned int conf_offset
,
3881 * delete_receive_sc - delete secure connection for receiving
3882 * @priv: private driver interface data from init()
3883 * @sc: secure channel
3884 * Returns: 0 on success, -1 on failure
3886 int (*delete_receive_sc
)(void *priv
, struct receive_sc
*sc
);
3889 * create_receive_sa - create secure association for receive
3890 * @priv: private driver interface data from init()
3891 * @sa: secure association
3892 * Returns: 0 on success, -1 on failure
3894 int (*create_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3897 * delete_receive_sa - Delete secure association for receive
3898 * @priv: Private driver interface data from init()
3899 * @sa: Secure association
3900 * Returns: 0 on success, -1 on failure
3902 int (*delete_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3905 * enable_receive_sa - enable the SA for receive
3906 * @priv: private driver interface data from init()
3907 * @sa: secure association
3908 * Returns: 0 on success, -1 on failure
3910 int (*enable_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3913 * disable_receive_sa - disable SA for receive
3914 * @priv: private driver interface data from init()
3915 * @sa: secure association
3916 * Returns: 0 on success, -1 on failure
3918 int (*disable_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3921 * create_transmit_sc - create secure connection for transmit
3922 * @priv: private driver interface data from init()
3923 * @sc: secure channel
3924 * @conf_offset: confidentiality offset (0, 30, or 50)
3925 * Returns: 0 on success, -1 on failure
3927 int (*create_transmit_sc
)(void *priv
, struct transmit_sc
*sc
,
3928 unsigned int conf_offset
);
3931 * delete_transmit_sc - delete secure connection for transmit
3932 * @priv: private driver interface data from init()
3933 * @sc: secure channel
3934 * Returns: 0 on success, -1 on failure
3936 int (*delete_transmit_sc
)(void *priv
, struct transmit_sc
*sc
);
3939 * create_transmit_sa - create secure association for transmit
3940 * @priv: private driver interface data from init()
3941 * @sa: secure association
3942 * Returns: 0 on success, -1 on failure
3944 int (*create_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
3947 * delete_transmit_sa - Delete secure association for transmit
3948 * @priv: Private driver interface data from init()
3949 * @sa: Secure association
3950 * Returns: 0 on success, -1 on failure
3952 int (*delete_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
3955 * enable_transmit_sa - enable SA for transmit
3956 * @priv: private driver interface data from init()
3957 * @sa: secure association
3958 * Returns: 0 on success, -1 on failure
3960 int (*enable_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
3963 * disable_transmit_sa - disable SA for transmit
3964 * @priv: private driver interface data from init()
3965 * @sa: secure association
3966 * Returns: 0 on success, -1 on failure
3968 int (*disable_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
3969 #endif /* CONFIG_MACSEC */
3972 * init_mesh - Driver specific initialization for mesh
3973 * @priv: Private driver interface data
3974 * Returns: 0 on success, -1 on failure
3976 int (*init_mesh
)(void *priv
);
3979 * join_mesh - Join a mesh network
3980 * @priv: Private driver interface data
3981 * @params: Mesh configuration parameters
3982 * Returns: 0 on success, -1 on failure
3984 int (*join_mesh
)(void *priv
,
3985 struct wpa_driver_mesh_join_params
*params
);
3988 * leave_mesh - Leave a mesh network
3989 * @priv: Private driver interface data
3990 * Returns 0 on success, -1 on failure
3992 int (*leave_mesh
)(void *priv
);
3995 * do_acs - Automatically select channel
3996 * @priv: Private driver interface data
3997 * @params: Parameters for ACS
3998 * Returns 0 on success, -1 on failure
4000 * This command can be used to offload ACS to the driver if the driver
4001 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
4003 int (*do_acs
)(void *priv
, struct drv_acs_params
*params
);
4006 * set_band - Notify driver of band selection
4007 * @priv: Private driver interface data
4008 * @band: The selected band(s)
4009 * Returns 0 on success, -1 on failure
4011 int (*set_band
)(void *priv
, enum set_band band
);
4014 * get_pref_freq_list - Get preferred frequency list for an interface
4015 * @priv: Private driver interface data
4016 * @if_type: Interface type
4017 * @num: Number of channels
4018 * @freq_list: Preferred channel frequency list encoded in MHz values
4019 * Returns 0 on success, -1 on failure
4021 * This command can be used to query the preferred frequency list from
4022 * the driver specific to a particular interface type.
4024 int (*get_pref_freq_list
)(void *priv
, enum wpa_driver_if_type if_type
,
4025 unsigned int *num
, unsigned int *freq_list
);
4028 * set_prob_oper_freq - Indicate probable P2P operating channel
4029 * @priv: Private driver interface data
4030 * @freq: Channel frequency in MHz
4031 * Returns 0 on success, -1 on failure
4033 * This command can be used to inform the driver of the operating
4034 * frequency that an ongoing P2P group formation is likely to come up
4035 * on. Local device is assuming P2P Client role.
4037 int (*set_prob_oper_freq
)(void *priv
, unsigned int freq
);
4040 * abort_scan - Request the driver to abort an ongoing scan
4041 * @priv: Private driver interface data
4042 * @scan_cookie: Cookie identifying the scan request. This is used only
4043 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4044 * was used to trigger scan. Otherwise, 0 is used.
4045 * Returns 0 on success, -1 on failure
4047 int (*abort_scan
)(void *priv
, u64 scan_cookie
);
4050 * configure_data_frame_filters - Request to configure frame filters
4051 * @priv: Private driver interface data
4052 * @filter_flags: The type of frames to filter (bitfield of
4053 * WPA_DATA_FRAME_FILTER_FLAG_*)
4054 * Returns: 0 on success or -1 on failure
4056 int (*configure_data_frame_filters
)(void *priv
, u32 filter_flags
);
4059 * get_ext_capab - Get extended capabilities for the specified interface
4060 * @priv: Private driver interface data
4061 * @type: Interface type for which to get extended capabilities
4062 * @ext_capab: Extended capabilities fetched
4063 * @ext_capab_mask: Extended capabilities mask
4064 * @ext_capab_len: Length of the extended capabilities
4065 * Returns: 0 on success or -1 on failure
4067 int (*get_ext_capab
)(void *priv
, enum wpa_driver_if_type type
,
4068 const u8
**ext_capab
, const u8
**ext_capab_mask
,
4069 unsigned int *ext_capab_len
);
4072 * p2p_lo_start - Start offloading P2P listen to device
4073 * @priv: Private driver interface data
4074 * @freq: Listening frequency (MHz) for P2P listen
4075 * @period: Length of the listen operation in milliseconds
4076 * @interval: Interval for running the listen operation in milliseconds
4077 * @count: Number of times to run the listen operation
4078 * @device_types: Device primary and secondary types
4079 * @dev_types_len: Number of bytes for device_types
4080 * @ies: P2P IE and WSC IE for Probe Response frames
4081 * @ies_len: Length of ies in bytes
4082 * Returns: 0 on success or -1 on failure
4084 int (*p2p_lo_start
)(void *priv
, unsigned int freq
,
4085 unsigned int period
, unsigned int interval
,
4087 const u8
*device_types
, size_t dev_types_len
,
4088 const u8
*ies
, size_t ies_len
);
4091 * p2p_lo_stop - Stop P2P listen offload
4092 * @priv: Private driver interface data
4093 * Returns: 0 on success or -1 on failure
4095 int (*p2p_lo_stop
)(void *priv
);
4098 * set_default_scan_ies - Set default scan IEs
4099 * @priv: Private driver interface data
4100 * @ies: Scan default IEs buffer
4101 * @ies_len: Length of IEs in bytes
4102 * Returns: 0 on success or -1 on failure
4104 * The driver can use these by default when there are no scan IEs coming
4105 * in the subsequent scan requests. Also in case of one or more of IEs
4106 * given in set_default_scan_ies() are missing in the subsequent scan
4107 * request, the driver should merge the missing scan IEs in the scan
4108 * request from the IEs set by set_default_scan_ies() in the Probe
4109 * Request frames sent.
4111 int (*set_default_scan_ies
)(void *priv
, const u8
*ies
, size_t ies_len
);
4114 * set_tdls_mode - Set TDLS trigger mode to the host driver
4115 * @priv: Private driver interface data
4116 * @tdls_external_control: Represents if TDLS external trigger control
4117 * mode is enabled/disabled.
4119 * This optional callback can be used to configure the TDLS external
4120 * trigger control mode to the host driver.
4122 int (*set_tdls_mode
)(void *priv
, int tdls_external_control
);
4125 * get_bss_transition_status - Get candidate BSS's transition status
4126 * @priv: Private driver interface data
4127 * @params: Candidate BSS list
4129 * Get the accept or reject reason code for a list of BSS transition
4132 struct wpa_bss_candidate_info
*
4133 (*get_bss_transition_status
)(void *priv
,
4134 struct wpa_bss_trans_info
*params
);
4136 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
4137 * @priv: Private driver interface data
4138 * @ignore_disallow: 0 to not ignore, 1 to ignore
4139 * Returns: 0 on success, -1 on failure
4141 int (*ignore_assoc_disallow
)(void *priv
, int ignore_disallow
);
4144 * set_bssid_blacklist - Set blacklist of BSSIDs to the driver
4145 * @priv: Private driver interface data
4146 * @num_bssid: Number of blacklist BSSIDs
4147 * @bssids: List of blacklisted BSSIDs
4149 int (*set_bssid_blacklist
)(void *priv
, unsigned int num_bssid
,
4153 * update_connect_params - Update the connection parameters
4154 * @priv: Private driver interface data
4155 * @params: Association parameters
4156 * @mask: Bit mask indicating which parameters in @params have to be
4158 * Returns: 0 on success, -1 on failure
4160 * Update the connection parameters when in connected state so that the
4161 * driver uses the updated parameters for subsequent roaming. This is
4162 * used only with drivers that implement internal BSS selection and
4165 int (*update_connect_params
)(
4166 void *priv
, struct wpa_driver_associate_params
*params
,
4167 enum wpa_drv_update_connect_params_mask mask
);
4170 * send_external_auth_status - Indicate the status of external
4171 * authentication processing to the host driver.
4172 * @priv: Private driver interface data
4173 * @params: Status of authentication processing.
4174 * Returns: 0 on success, -1 on failure
4176 int (*send_external_auth_status
)(void *priv
,
4177 struct external_auth
*params
);
4180 * set_4addr_mode - Set 4-address mode
4181 * @priv: Private driver interface data
4182 * @bridge_ifname: Bridge interface name
4183 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
4184 * Returns: 0 on success, < 0 on failure
4186 int (*set_4addr_mode
)(void *priv
, const char *bridge_ifname
, int val
);
4190 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
4192 enum wpa_event_type
{
4194 * EVENT_ASSOC - Association completed
4196 * This event needs to be delivered when the driver completes IEEE
4197 * 802.11 association or reassociation successfully.
4198 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
4199 * after this event has been generated. In addition, optional
4200 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
4201 * more information about the association. If the driver interface gets
4202 * both of these events at the same time, it can also include the
4203 * assoc_info data in EVENT_ASSOC call.
4208 * EVENT_DISASSOC - Association lost
4210 * This event should be called when association is lost either due to
4211 * receiving deauthenticate or disassociate frame from the AP or when
4212 * sending either of these frames to the current AP. If the driver
4213 * supports separate deauthentication event, EVENT_DISASSOC should only
4214 * be used for disassociation and EVENT_DEAUTH for deauthentication.
4215 * In AP mode, union wpa_event_data::disassoc_info is required.
4220 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
4222 * This event must be delivered when a Michael MIC error is detected by
4223 * the local driver. Additional data for event processing is
4224 * provided with union wpa_event_data::michael_mic_failure. This
4225 * information is used to request new encyption key and to initiate
4226 * TKIP countermeasures if needed.
4228 EVENT_MICHAEL_MIC_FAILURE
,
4231 * EVENT_SCAN_RESULTS - Scan results available
4233 * This event must be called whenever scan results are available to be
4234 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4235 * is expected to be used some time after struct wpa_driver_ops::scan()
4236 * is called. If the driver provides an unsolicited event when the scan
4237 * has been completed, this event can be used to trigger
4238 * EVENT_SCAN_RESULTS call. If such event is not available from the
4239 * driver, the driver wrapper code is expected to use a registered
4240 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
4241 * scan is expected to be completed. Optional information about
4242 * completed scan can be provided with union wpa_event_data::scan_info.
4247 * EVENT_ASSOCINFO - Report optional extra information for association
4249 * This event can be used to report extra association information for
4250 * EVENT_ASSOC processing. This extra information includes IEs from
4251 * association frames and Beacon/Probe Response frames in union
4252 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4253 * EVENT_ASSOC. Alternatively, the driver interface can include
4254 * assoc_info data in the EVENT_ASSOC call if it has all the
4255 * information available at the same point.
4260 * EVENT_INTERFACE_STATUS - Report interface status changes
4262 * This optional event can be used to report changes in interface
4263 * status (interface added/removed) using union
4264 * wpa_event_data::interface_status. This can be used to trigger
4265 * wpa_supplicant to stop and re-start processing for the interface,
4266 * e.g., when a cardbus card is ejected/inserted.
4268 EVENT_INTERFACE_STATUS
,
4271 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4273 * This event can be used to inform wpa_supplicant about candidates for
4274 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4275 * for scan request (ap_scan=2 mode), this event is required for
4276 * pre-authentication. If wpa_supplicant is performing scan request
4277 * (ap_scan=1), this event is optional since scan results can be used
4278 * to add pre-authentication candidates. union
4279 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4280 * candidate and priority of the candidate, e.g., based on the signal
4281 * strength, in order to try to pre-authenticate first with candidates
4282 * that are most likely targets for re-association.
4284 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4285 * on the candidate list. In addition, it can be called for the current
4286 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4287 * will automatically skip pre-authentication in cases where a valid
4288 * PMKSA exists. When more than one candidate exists, this event should
4289 * be generated once for each candidate.
4291 * Driver will be notified about successful pre-authentication with
4292 * struct wpa_driver_ops::add_pmkid() calls.
4294 EVENT_PMKID_CANDIDATE
,
4297 * EVENT_TDLS - Request TDLS operation
4299 * This event can be used to request a TDLS operation to be performed.
4304 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4306 * The driver is expected to report the received FT IEs from
4307 * FT authentication sequence from the AP. The FT IEs are included in
4308 * the extra information in union wpa_event_data::ft_ies.
4313 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4315 * The driver can use this event to inform wpa_supplicant about a STA
4316 * in an IBSS with which protected frames could be exchanged. This
4317 * event starts RSN authentication with the other STA to authenticate
4318 * the STA and set up encryption keys with it.
4320 EVENT_IBSS_RSN_START
,
4323 * EVENT_AUTH - Authentication result
4325 * This event should be called when authentication attempt has been
4326 * completed. This is only used if the driver supports separate
4327 * authentication step (struct wpa_driver_ops::authenticate).
4328 * Information about authentication result is included in
4329 * union wpa_event_data::auth.
4334 * EVENT_DEAUTH - Authentication lost
4336 * This event should be called when authentication is lost either due
4337 * to receiving deauthenticate frame from the AP or when sending that
4338 * frame to the current AP.
4339 * In AP mode, union wpa_event_data::deauth_info is required.
4344 * EVENT_ASSOC_REJECT - Association rejected
4346 * This event should be called when (re)association attempt has been
4347 * rejected by the AP. Information about the association response is
4348 * included in union wpa_event_data::assoc_reject.
4353 * EVENT_AUTH_TIMED_OUT - Authentication timed out
4355 EVENT_AUTH_TIMED_OUT
,
4358 * EVENT_ASSOC_TIMED_OUT - Association timed out
4360 EVENT_ASSOC_TIMED_OUT
,
4363 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
4365 EVENT_WPS_BUTTON_PUSHED
,
4368 * EVENT_TX_STATUS - Report TX status
4373 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
4375 EVENT_RX_FROM_UNKNOWN
,
4378 * EVENT_RX_MGMT - Report RX of a management frame
4383 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
4385 * This event is used to indicate when the driver has started the
4386 * requested remain-on-channel duration. Information about the
4387 * operation is included in union wpa_event_data::remain_on_channel.
4389 EVENT_REMAIN_ON_CHANNEL
,
4392 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
4394 * This event is used to indicate when the driver has completed
4395 * remain-on-channel duration, i.e., may noot be available on the
4396 * requested channel anymore. Information about the
4397 * operation is included in union wpa_event_data::remain_on_channel.
4399 EVENT_CANCEL_REMAIN_ON_CHANNEL
,
4402 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
4404 * This event is used to indicate when a Probe Request frame has been
4405 * received. Information about the received frame is included in
4406 * union wpa_event_data::rx_probe_req. The driver is required to report
4407 * these events only after successfully completed probe_req_report()
4408 * commands to request the events (i.e., report parameter is non-zero)
4409 * in station mode. In AP mode, Probe Request frames should always be
4415 * EVENT_NEW_STA - New wired device noticed
4417 * This event is used to indicate that a new device has been detected
4418 * in a network that does not use association-like functionality (i.e.,
4419 * mainly wired Ethernet). This can be used to start EAPOL
4420 * authenticator when receiving a frame from a device. The address of
4421 * the device is included in union wpa_event_data::new_sta.
4426 * EVENT_EAPOL_RX - Report received EAPOL frame
4428 * When in AP mode with hostapd, this event is required to be used to
4429 * deliver the receive EAPOL frames from the driver.
4434 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4436 * This event is used to indicate changes in the signal strength
4437 * observed in frames received from the current AP if signal strength
4438 * monitoring has been enabled with signal_monitor().
4440 EVENT_SIGNAL_CHANGE
,
4443 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4445 * This event is used to indicate that the interface was enabled after
4446 * having been previously disabled, e.g., due to rfkill.
4448 EVENT_INTERFACE_ENABLED
,
4451 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4453 * This event is used to indicate that the interface was disabled,
4454 * e.g., due to rfkill.
4456 EVENT_INTERFACE_DISABLED
,
4459 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4461 * This event is used to indicate that the channel list has changed,
4462 * e.g., because of a regulatory domain change triggered by scan
4463 * results including an AP advertising a country code.
4465 EVENT_CHANNEL_LIST_CHANGED
,
4468 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4470 * This event is used to indicate that the driver cannot maintain this
4471 * interface in its operation mode anymore. The most likely use for
4472 * this is to indicate that AP mode operation is not available due to
4473 * operating channel would need to be changed to a DFS channel when
4474 * the driver does not support radar detection and another virtual
4475 * interfaces caused the operating channel to change. Other similar
4476 * resource conflicts could also trigger this for station mode
4477 * interfaces. This event can be propagated when channel switching
4480 EVENT_INTERFACE_UNAVAILABLE
,
4483 * EVENT_BEST_CHANNEL
4485 * Driver generates this event whenever it detects a better channel
4486 * (e.g., based on RSSI or channel use). This information can be used
4487 * to improve channel selection for a new AP/P2P group.
4492 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4494 * This event should be called when a Deauthentication frame is dropped
4495 * due to it not being protected (MFP/IEEE 802.11w).
4496 * union wpa_event_data::unprot_deauth is required to provide more
4497 * details of the frame.
4499 EVENT_UNPROT_DEAUTH
,
4502 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4504 * This event should be called when a Disassociation frame is dropped
4505 * due to it not being protected (MFP/IEEE 802.11w).
4506 * union wpa_event_data::unprot_disassoc is required to provide more
4507 * details of the frame.
4509 EVENT_UNPROT_DISASSOC
,
4512 * EVENT_STATION_LOW_ACK
4514 * Driver generates this event whenever it detected that a particular
4515 * station was lost. Detection can be through massive transmission
4516 * failures for example.
4518 EVENT_STATION_LOW_ACK
,
4521 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4523 EVENT_IBSS_PEER_LOST
,
4526 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4528 * This event carries the new replay counter to notify wpa_supplicant
4529 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4530 * completed Group Key Handshake while the host (including
4531 * wpa_supplicant was sleeping).
4533 EVENT_DRIVER_GTK_REKEY
,
4536 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4538 EVENT_SCHED_SCAN_STOPPED
,
4541 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4543 * This event indicates that the station responded to the poll
4544 * initiated with @poll_client.
4546 EVENT_DRIVER_CLIENT_POLL_OK
,
4549 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4551 EVENT_EAPOL_TX_STATUS
,
4554 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4556 * Described in wpa_event_data.ch_switch
4561 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
4563 * This is a pre-switch event indicating the shortly following switch
4564 * of operating channels.
4566 * Described in wpa_event_data.ch_switch
4568 EVENT_CH_SWITCH_STARTED
,
4570 * EVENT_WNM - Request WNM operation
4572 * This event can be used to request a WNM operation to be performed.
4577 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4579 * This event indicates that the driver reported a connection failure
4580 * with the specified client (for example, max client reached, etc.) in
4583 EVENT_CONNECT_FAILED_REASON
,
4586 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
4588 * A radar has been detected on the supplied frequency, hostapd should
4589 * react accordingly (e.g., change channel).
4591 EVENT_DFS_RADAR_DETECTED
,
4594 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
4596 * After a successful CAC, the channel can be marked clear and used.
4598 EVENT_DFS_CAC_FINISHED
,
4601 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
4603 * The CAC was not successful, and the channel remains in the previous
4604 * state. This may happen due to a radar being detected or other
4605 * external influences.
4607 EVENT_DFS_CAC_ABORTED
,
4610 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
4612 * The channel which was previously unavailable is now available again.
4614 EVENT_DFS_NOP_FINISHED
,
4617 * EVENT_SURVEY - Received survey data
4619 * This event gets triggered when a driver query is issued for survey
4620 * data and the requested data becomes available. The returned data is
4621 * stored in struct survey_results. The results provide at most one
4622 * survey entry for each frequency and at minimum will provide one
4623 * survey entry for one frequency. The survey data can be os_malloc()'d
4624 * and then os_free()'d, so the event callback must only copy data.
4629 * EVENT_SCAN_STARTED - Scan started
4631 * This indicates that driver has started a scan operation either based
4632 * on a request from wpa_supplicant/hostapd or from another application.
4633 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4634 * completed (either successfully or by getting cancelled).
4639 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4641 * This event indicates a set of frequency ranges that should be avoided
4642 * to reduce issues due to interference or internal co-existence
4643 * information in the driver.
4645 EVENT_AVOID_FREQUENCIES
,
4648 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4650 EVENT_NEW_PEER_CANDIDATE
,
4653 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4655 * Indicates a pair of primary and secondary channels chosen by ACS
4658 EVENT_ACS_CHANNEL_SELECTED
,
4661 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4664 * This event indicates that channel availability check has been started
4665 * on a DFS frequency by a driver that supports DFS Offload.
4667 EVENT_DFS_CAC_STARTED
,
4670 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4675 * EVENT_BEACON_LOSS - Beacon loss detected
4677 * This event indicates that no Beacon frames has been received from
4678 * the current AP. This may indicate that the AP is not anymore in
4684 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
4685 * done previously (Pre-CAC) on the channel has expired. This would
4686 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
4687 * channel will be moved from available to usable. A new CAC has to be
4688 * performed before start operating on this channel.
4690 EVENT_DFS_PRE_CAC_EXPIRED
,
4693 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
4694 * that do not define separate commands for authentication and
4695 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
4696 * authentication to wpa_supplicant. This event carries all the
4697 * necessary information from the host driver for the authentication to
4700 EVENT_EXTERNAL_AUTH
,
4703 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
4705 * This event should be indicated when the driver completes the 4-way
4706 * handshake. This event should be preceded by an EVENT_ASSOC that
4707 * indicates the completion of IEEE 802.11 association.
4709 EVENT_PORT_AUTHORIZED
,
4712 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
4715 EVENT_STATION_OPMODE_CHANGED
,
4718 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
4720 * This event is emitted when the MAC changes while the interface is
4721 * enabled. When an interface was disabled and becomes enabled, it
4722 * must be always assumed that the MAC possibly changed.
4724 EVENT_INTERFACE_MAC_CHANGED
,
4727 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
4729 * This event is emitted when an interface is added/removed for WDS STA.
4731 EVENT_WDS_STA_INTERFACE_STATUS
,
4736 * struct freq_survey - Channel survey info
4738 * @ifidx: Interface index in which this survey was observed
4739 * @freq: Center of frequency of the surveyed channel
4740 * @nf: Channel noise floor in dBm
4741 * @channel_time: Amount of time in ms the radio spent on the channel
4742 * @channel_time_busy: Amount of time in ms the radio detected some signal
4743 * that indicated to the radio the channel was not clear
4744 * @channel_time_rx: Amount of time the radio spent receiving data
4745 * @channel_time_tx: Amount of time the radio spent transmitting data
4746 * @filled: bitmask indicating which fields have been reported, see
4747 * SURVEY_HAS_* defines.
4748 * @list: Internal list pointers
4750 struct freq_survey
{
4755 u64 channel_time_busy
;
4756 u64 channel_time_rx
;
4757 u64 channel_time_tx
;
4758 unsigned int filled
;
4759 struct dl_list list
;
4762 #define SURVEY_HAS_NF BIT(0)
4763 #define SURVEY_HAS_CHAN_TIME BIT(1)
4764 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4765 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4766 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4770 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4772 union wpa_event_data
{
4774 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4776 * This structure is optional for EVENT_ASSOC calls and required for
4777 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4778 * driver interface does not need to generate separate EVENT_ASSOCINFO
4783 * reassoc - Flag to indicate association or reassociation
4788 * req_ies - (Re)Association Request IEs
4790 * If the driver generates WPA/RSN IE, this event data must be
4791 * returned for WPA handshake to have needed information. If
4792 * wpa_supplicant-generated WPA/RSN IE is used, this
4793 * information event is optional.
4795 * This should start with the first IE (fixed fields before IEs
4796 * are not included).
4801 * req_ies_len - Length of req_ies in bytes
4806 * resp_ies - (Re)Association Response IEs
4808 * Optional association data from the driver. This data is not
4809 * required WPA, but may be useful for some protocols and as
4810 * such, should be reported if this is available to the driver
4813 * This should start with the first IE (fixed fields before IEs
4814 * are not included).
4819 * resp_ies_len - Length of resp_ies in bytes
4821 size_t resp_ies_len
;
4824 * resp_frame - (Re)Association Response frame
4826 const u8
*resp_frame
;
4829 * resp_frame_len - (Re)Association Response frame length
4831 size_t resp_frame_len
;
4834 * beacon_ies - Beacon or Probe Response IEs
4836 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4837 * Probe Response frames from the current AP (i.e., the one
4838 * that the client just associated with). This information is
4839 * used to update WPA/RSN IE for the AP. If this field is not
4840 * set, the results from previous scan will be used. If no
4841 * data for the new AP is found, scan results will be requested
4842 * again (without scan request). At this point, the driver is
4843 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4846 * This should start with the first IE (fixed fields before IEs
4847 * are not included).
4849 const u8
*beacon_ies
;
4852 * beacon_ies_len - Length of beacon_ies */
4853 size_t beacon_ies_len
;
4856 * freq - Frequency of the operational channel in MHz
4861 * wmm_params - WMM parameters used in this association.
4863 struct wmm_params wmm_params
;
4866 * addr - Station address (for AP mode)
4871 * The following is the key management offload information
4874 * @key_replay_ctr_len
4882 * authorized - Status of key management offload,
4888 * key_replay_ctr - Key replay counter value last used
4889 * in a valid EAPOL-Key frame
4891 const u8
*key_replay_ctr
;
4894 * key_replay_ctr_len - The length of key_replay_ctr
4896 size_t key_replay_ctr_len
;
4899 * ptk_kck - The derived PTK KCK
4904 * ptk_kek_len - The length of ptk_kck
4909 * ptk_kek - The derived PTK KEK
4910 * This is used in key management offload and also in FILS SK
4916 * ptk_kek_len - The length of ptk_kek
4921 * subnet_status - The subnet status:
4922 * 0 = unknown, 1 = unchanged, 2 = changed
4927 * The following information is used in FILS SK offload
4928 * @fils_erp_next_seq_num
4935 * fils_erp_next_seq_num - The next sequence number to use in
4938 u16 fils_erp_next_seq_num
;
4941 * fils_pmk - A new PMK if generated in case of FILS
4947 * fils_pmk_len - Length of fils_pmk
4949 size_t fils_pmk_len
;
4952 * fils_pmkid - PMKID used or generated in FILS authentication
4954 const u8
*fils_pmkid
;
4958 * struct disassoc_info - Data for EVENT_DISASSOC events
4960 struct disassoc_info
{
4962 * addr - Station address (for AP mode)
4967 * reason_code - Reason Code (host byte order) used in
4968 * Deauthentication frame
4973 * ie - Optional IE(s) in Disassociation frame
4978 * ie_len - Length of ie buffer in octets
4983 * locally_generated - Whether the frame was locally generated
4985 int locally_generated
;
4989 * struct deauth_info - Data for EVENT_DEAUTH events
4991 struct deauth_info
{
4993 * addr - Station address (for AP mode)
4998 * reason_code - Reason Code (host byte order) used in
4999 * Deauthentication frame
5004 * ie - Optional IE(s) in Deauthentication frame
5009 * ie_len - Length of ie buffer in octets
5014 * locally_generated - Whether the frame was locally generated
5016 int locally_generated
;
5020 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
5022 struct michael_mic_failure
{
5025 } michael_mic_failure
;
5028 * struct interface_status - Data for EVENT_INTERFACE_STATUS
5030 struct interface_status
{
5031 unsigned int ifindex
;
5034 EVENT_INTERFACE_ADDED
, EVENT_INTERFACE_REMOVED
5039 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
5041 struct pmkid_candidate
{
5042 /** BSSID of the PMKID candidate */
5044 /** Smaller the index, higher the priority */
5046 /** Whether RSN IE includes pre-authenticate flag */
5051 * struct tdls - Data for EVENT_TDLS
5057 TDLS_REQUEST_TEARDOWN
,
5058 TDLS_REQUEST_DISCOVER
,
5060 u16 reason_code
; /* for teardown */
5064 * struct wnm - Data for EVENT_WNM
5082 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
5084 * During FT (IEEE 802.11r) authentication sequence, the driver is
5085 * expected to use this event to report received FT IEs (MDIE, FTIE,
5086 * RSN IE, TIE, possible resource request) to the supplicant. The FT
5087 * IEs for the next message will be delivered through the
5088 * struct wpa_driver_ops::update_ft_ies() callback.
5094 u8 target_ap
[ETH_ALEN
];
5095 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
5097 /** Length of ric_ies buffer in octets */
5102 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
5104 struct ibss_rsn_start
{
5109 * struct auth_info - Data for EVENT_AUTH events
5115 u16 auth_transaction
;
5122 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
5124 struct assoc_reject
{
5126 * bssid - BSSID of the AP that rejected association
5131 * resp_ies - (Re)Association Response IEs
5133 * Optional association data from the driver. This data is not
5134 * required WPA, but may be useful for some protocols and as
5135 * such, should be reported if this is available to the driver
5138 * This should start with the first IE (fixed fields before IEs
5139 * are not included).
5144 * resp_ies_len - Length of resp_ies in bytes
5146 size_t resp_ies_len
;
5149 * status_code - Status Code from (Re)association Response
5154 * timed_out - Whether failure is due to timeout (etc.) rather
5155 * than explicit rejection response from the AP.
5160 * timeout_reason - Reason for the timeout
5162 const char *timeout_reason
;
5165 * fils_erp_next_seq_num - The next sequence number to use in
5168 u16 fils_erp_next_seq_num
;
5171 struct timeout_event
{
5176 * struct tx_status - Data for EVENT_TX_STATUS events
5188 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
5190 struct rx_from_unknown
{
5197 * struct rx_mgmt - Data for EVENT_RX_MGMT events
5205 * drv_priv - Pointer to store driver private BSS information
5207 * If not set to NULL, this is used for comparison with
5208 * hostapd_data->drv_priv to determine which BSS should process
5214 * freq - Frequency (in MHz) on which the frame was received
5219 * ssi_signal - Signal strength in dBm (or 0 if not available)
5225 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
5227 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
5229 struct remain_on_channel
{
5231 * freq - Channel frequency in MHz
5236 * duration - Duration to remain on the channel in milliseconds
5238 unsigned int duration
;
5239 } remain_on_channel
;
5242 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
5243 * @aborted: Whether the scan was aborted
5244 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
5245 * @num_freqs: Number of entries in freqs array
5246 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
5248 * @num_ssids: Number of entries in ssids array
5249 * @external_scan: Whether the scan info is for an external scan
5250 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
5251 * 0 if the source of the scan event is a vendor scan
5252 * @scan_start_tsf: Time when the scan started in terms of TSF of the
5253 * BSS that the interface that requested the scan is connected to
5255 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
5262 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
5267 u8 scan_start_tsf_bssid
[ETH_ALEN
];
5271 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
5273 struct rx_probe_req
{
5275 * sa - Source address of the received Probe Request frame
5280 * da - Destination address of the received Probe Request frame
5281 * or %NULL if not available
5286 * bssid - BSSID of the received Probe Request frame or %NULL
5292 * ie - IEs from the Probe Request body
5297 * ie_len - Length of ie buffer in octets
5302 * signal - signal strength in dBm (or 0 if not available)
5308 * struct new_sta - Data for EVENT_NEW_STA events
5315 * struct eapol_rx - Data for EVENT_EAPOL_RX events
5324 * signal_change - Data for EVENT_SIGNAL_CHANGE events
5326 struct wpa_signal_info signal_change
;
5329 * struct best_channel - Data for EVENT_BEST_CHANNEL events
5330 * @freq_24: Best 2.4 GHz band channel frequency in MHz
5331 * @freq_5: Best 5 GHz band channel frequency in MHz
5332 * @freq_overall: Best channel frequency in MHz
5334 * 0 can be used to indicate no preference in either band.
5336 struct best_channel
{
5342 struct unprot_deauth
{
5348 struct unprot_disassoc
{
5355 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
5356 * @addr: station address
5357 * @num_packets: Number of packets lost (consecutive packets not
5366 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
5368 struct ibss_peer_lost
{
5373 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
5375 struct driver_gtk_rekey
{
5377 const u8
*replay_ctr
;
5381 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
5382 * @addr: station address
5384 struct client_poll
{
5389 * struct eapol_tx_status
5390 * @dst: Original destination
5391 * @data: Data starting with IEEE 802.1X header (!)
5392 * @data_len: Length of data
5393 * @ack: Indicates ack or lost frame
5395 * This corresponds to hapd_send_eapol if the frame sent
5396 * there isn't just reported as EVENT_TX_STATUS.
5398 struct eapol_tx_status
{
5407 * @freq: Frequency of new channel in MHz
5408 * @ht_enabled: Whether this is an HT channel
5409 * @ch_offset: Secondary channel offset
5410 * @ch_width: Channel width
5411 * @cf1: Center frequency 1
5412 * @cf2: Center frequency 2
5418 enum chan_width ch_width
;
5424 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
5425 * @addr: Remote client address
5426 * @code: Reason code for connection failure
5428 struct connect_failed_reason
{
5434 } connect_failed_reason
;
5437 * struct dfs_event - Data for radar detected events
5438 * @freq: Frequency of the channel in MHz
5444 enum chan_width chan_width
;
5450 * survey_results - Survey result data for EVENT_SURVEY
5451 * @freq_filter: Requested frequency survey filter, 0 if request
5452 * was for all survey data
5453 * @survey_list: Linked list of survey data (struct freq_survey)
5455 struct survey_results
{
5456 unsigned int freq_filter
;
5457 struct dl_list survey_list
; /* struct freq_survey */
5461 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
5462 * @initiator: Initiator of the regulatory change
5463 * @type: Regulatory change type
5464 * @alpha2: Country code (or "" if not available)
5466 struct channel_list_changed
{
5467 enum reg_change_initiator initiator
;
5470 } channel_list_changed
;
5473 * freq_range - List of frequency ranges
5475 * This is used as the data with EVENT_AVOID_FREQUENCIES.
5477 struct wpa_freq_range_list freq_range
;
5482 * @peer: Peer address
5484 * @ie_len: Length of @ies
5486 * Notification of new candidate mesh peer.
5495 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
5496 * @pri_channel: Selected primary channel
5497 * @sec_channel: Selected secondary channel
5498 * @vht_seg0_center_ch: VHT mode Segment0 center channel
5499 * @vht_seg1_center_ch: VHT mode Segment1 center channel
5500 * @ch_width: Selected Channel width by driver. Driver may choose to
5501 * change hostapd configured ACS channel width due driver internal
5502 * channel restrictions.
5503 * hw_mode: Selected band (used with hw_mode=any)
5505 struct acs_selected_channels
{
5508 u8 vht_seg0_center_ch
;
5509 u8 vht_seg1_center_ch
;
5511 enum hostapd_hw_mode hw_mode
;
5512 } acs_selected_channels
;
5515 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
5516 * @reason_code: Reason for stopping offload
5517 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
5519 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
5521 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
5523 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
5524 * supported by device.
5526 struct p2p_lo_stop
{
5528 P2P_LO_STOPPED_REASON_COMPLETE
= 0,
5529 P2P_LO_STOPPED_REASON_RECV_STOP_CMD
,
5530 P2P_LO_STOPPED_REASON_INVALID_PARAM
,
5531 P2P_LO_STOPPED_REASON_NOT_SUPPORTED
,
5535 /* For EVENT_EXTERNAL_AUTH */
5536 struct external_auth external_auth
;
5539 * struct sta_opmode - Station's operation mode change event
5540 * @addr: The station MAC address
5541 * @smps_mode: SMPS mode of the station
5542 * @chan_width: Channel width of the station
5543 * @rx_nss: RX_NSS of the station
5545 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
5549 enum smps_mode smps_mode
;
5550 enum chan_width chan_width
;
5555 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
5557 struct wds_sta_interface
{
5564 } wds_sta_interface
;
5568 * wpa_supplicant_event - Report a driver event for wpa_supplicant
5569 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5570 * with struct wpa_driver_ops::init()
5571 * @event: event type (defined above)
5572 * @data: possible extra data for the event
5574 * Driver wrapper code should call this function whenever an event is received
5577 void wpa_supplicant_event(void *ctx
, enum wpa_event_type event
,
5578 union wpa_event_data
*data
);
5581 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
5582 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5583 * with struct wpa_driver_ops::init()
5584 * @event: event type (defined above)
5585 * @data: possible extra data for the event
5587 * Same as wpa_supplicant_event(), but we search for the interface in
5590 void wpa_supplicant_event_global(void *ctx
, enum wpa_event_type event
,
5591 union wpa_event_data
*data
);
5594 * The following inline functions are provided for convenience to simplify
5595 * event indication for some of the common events.
5598 static inline void drv_event_assoc(void *ctx
, const u8
*addr
, const u8
*ie
,
5599 size_t ielen
, int reassoc
)
5601 union wpa_event_data event
;
5602 os_memset(&event
, 0, sizeof(event
));
5603 event
.assoc_info
.reassoc
= reassoc
;
5604 event
.assoc_info
.req_ies
= ie
;
5605 event
.assoc_info
.req_ies_len
= ielen
;
5606 event
.assoc_info
.addr
= addr
;
5607 wpa_supplicant_event(ctx
, EVENT_ASSOC
, &event
);
5610 static inline void drv_event_disassoc(void *ctx
, const u8
*addr
)
5612 union wpa_event_data event
;
5613 os_memset(&event
, 0, sizeof(event
));
5614 event
.disassoc_info
.addr
= addr
;
5615 wpa_supplicant_event(ctx
, EVENT_DISASSOC
, &event
);
5618 static inline void drv_event_eapol_rx(void *ctx
, const u8
*src
, const u8
*data
,
5621 union wpa_event_data event
;
5622 os_memset(&event
, 0, sizeof(event
));
5623 event
.eapol_rx
.src
= src
;
5624 event
.eapol_rx
.data
= data
;
5625 event
.eapol_rx
.data_len
= data_len
;
5626 wpa_supplicant_event(ctx
, EVENT_EAPOL_RX
, &event
);
5629 /* driver_common.c */
5630 void wpa_scan_results_free(struct wpa_scan_results
*res
);
5632 /* Convert wpa_event_type to a string for logging */
5633 const char * event_to_string(enum wpa_event_type event
);
5635 /* Convert chan_width to a string for logging and control interfaces */
5636 const char * channel_width_to_string(enum chan_width width
);
5638 int channel_width_to_int(enum chan_width width
);
5640 int ht_supported(const struct hostapd_hw_modes
*mode
);
5641 int vht_supported(const struct hostapd_hw_modes
*mode
);
5643 struct wowlan_triggers
*
5644 wpa_get_wowlan_triggers(const char *wowlan_triggers
,
5645 const struct wpa_driver_capa
*capa
);
5646 /* Convert driver flag to string */
5647 const char * driver_flag_to_string(u64 flag
);
5649 /* NULL terminated array of linked in driver wrappers */
5650 extern const struct wpa_driver_ops
*const wpa_drivers
[];
5653 /* Available drivers */
5655 #ifdef CONFIG_DRIVER_WEXT
5656 extern const struct wpa_driver_ops wpa_driver_wext_ops
; /* driver_wext.c */
5657 #endif /* CONFIG_DRIVER_WEXT */
5658 #ifdef CONFIG_DRIVER_NL80211
5659 /* driver_nl80211.c */
5660 extern const struct wpa_driver_ops wpa_driver_nl80211_ops
;
5661 #endif /* CONFIG_DRIVER_NL80211 */
5662 #ifdef CONFIG_DRIVER_HOSTAP
5663 extern const struct wpa_driver_ops wpa_driver_hostap_ops
; /* driver_hostap.c */
5664 #endif /* CONFIG_DRIVER_HOSTAP */
5665 #ifdef CONFIG_DRIVER_BSD
5666 extern const struct wpa_driver_ops wpa_driver_bsd_ops
; /* driver_bsd.c */
5667 #endif /* CONFIG_DRIVER_BSD */
5668 #ifdef CONFIG_DRIVER_OPENBSD
5669 /* driver_openbsd.c */
5670 extern const struct wpa_driver_ops wpa_driver_openbsd_ops
;
5671 #endif /* CONFIG_DRIVER_OPENBSD */
5672 #ifdef CONFIG_DRIVER_NDIS
5673 extern struct wpa_driver_ops wpa_driver_ndis_ops
; /* driver_ndis.c */
5674 #endif /* CONFIG_DRIVER_NDIS */
5675 #ifdef CONFIG_DRIVER_WIRED
5676 extern const struct wpa_driver_ops wpa_driver_wired_ops
; /* driver_wired.c */
5677 #endif /* CONFIG_DRIVER_WIRED */
5678 #ifdef CONFIG_DRIVER_MACSEC_QCA
5679 /* driver_macsec_qca.c */
5680 extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops
;
5681 #endif /* CONFIG_DRIVER_MACSEC_QCA */
5682 #ifdef CONFIG_DRIVER_MACSEC_LINUX
5683 /* driver_macsec_linux.c */
5684 extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops
;
5685 #endif /* CONFIG_DRIVER_MACSEC_LINUX */
5686 #ifdef CONFIG_DRIVER_ROBOSWITCH
5687 /* driver_roboswitch.c */
5688 extern const struct wpa_driver_ops wpa_driver_roboswitch_ops
;
5689 #endif /* CONFIG_DRIVER_ROBOSWITCH */
5690 #ifdef CONFIG_DRIVER_ATHEROS
5691 /* driver_atheros.c */
5692 extern const struct wpa_driver_ops wpa_driver_atheros_ops
;
5693 #endif /* CONFIG_DRIVER_ATHEROS */
5694 #ifdef CONFIG_DRIVER_NONE
5695 extern const struct wpa_driver_ops wpa_driver_none_ops
; /* driver_none.c */
5696 #endif /* CONFIG_DRIVER_NONE */
5698 #endif /* DRIVER_H */