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_wmm_rule - WMM regulatory rule
106 * @min_cwmin: Lower bound of CW_min value
107 * @min_cwmax: Lower bound of CW_max value
108 * @min_aifs: Lower bound of AIFS value
109 * @max_txop: Upper bound of TXOP, value in units of 32 usec
111 struct hostapd_wmm_rule
{
119 * struct hostapd_channel_data - Channel information
121 struct hostapd_channel_data
{
123 * chan - Channel number (IEEE 802.11)
128 * freq - Frequency in MHz
133 * flag - Channel flags (HOSTAPD_CHAN_*)
138 * allowed_bw - Allowed channel width bitmask
140 * See enum hostapd_chan_width_attr.
145 * max_tx_power - Regulatory transmit power limit in dBm
150 * survey_list - Linked list of surveys (struct freq_survey)
152 struct dl_list survey_list
;
155 * min_nf - Minimum observed noise floor, in dBm, based on all
156 * surveyed channel data
162 * interference_factor - Computed interference factor on this
163 * channel (used internally in src/ap/acs.c; driver wrappers do not
166 long double interference_factor
;
167 #endif /* CONFIG_ACS */
170 * dfs_cac_ms - DFS CAC time in milliseconds
172 unsigned int dfs_cac_ms
;
175 * wmm_rules_valid - Indicates wmm_rules state
180 * wmm_rules - WMM regulatory rules
182 struct hostapd_wmm_rule wmm_rules
[WMM_AC_NUM
];
185 #define HE_MAX_MAC_CAPAB_SIZE 6
186 #define HE_MAX_PHY_CAPAB_SIZE 11
187 #define HE_MAX_MCS_CAPAB_SIZE 12
190 * struct he_capabilities - IEEE 802.11ax HE capabilities
192 struct he_capabilities
{
194 u8 phy_cap
[HE_MAX_PHY_CAPAB_SIZE
];
195 u8 mac_cap
[HE_MAX_MAC_CAPAB_SIZE
];
196 u8 mcs
[HE_MAX_MCS_CAPAB_SIZE
];
200 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
201 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
204 * struct hostapd_hw_modes - Supported hardware mode information
206 struct hostapd_hw_modes
{
208 * mode - Hardware mode
210 enum hostapd_hw_mode mode
;
213 * num_channels - Number of entries in the channels array
218 * channels - Array of supported channels
220 struct hostapd_channel_data
*channels
;
223 * num_rates - Number of entries in the rates array
228 * rates - Array of supported rates in 100 kbps units
233 * ht_capab - HT (IEEE 802.11n) capabilities
238 * mcs_set - MCS (IEEE 802.11n) rate parameters
243 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
248 * vht_capab - VHT (IEEE 802.11ac) capabilities
253 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
257 unsigned int flags
; /* HOSTAPD_MODE_FLAG_* */
260 * he_capab - HE (IEEE 802.11ax) capabilities
262 struct he_capabilities he_capab
;
266 #define IEEE80211_MODE_INFRA 0
267 #define IEEE80211_MODE_IBSS 1
268 #define IEEE80211_MODE_AP 2
269 #define IEEE80211_MODE_MESH 5
271 #define IEEE80211_CAP_ESS 0x0001
272 #define IEEE80211_CAP_IBSS 0x0002
273 #define IEEE80211_CAP_PRIVACY 0x0010
274 #define IEEE80211_CAP_RRM 0x1000
276 /* DMG (60 GHz) IEEE 802.11ad */
277 /* type - bits 0..1 */
278 #define IEEE80211_CAP_DMG_MASK 0x0003
279 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
280 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
281 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
283 #define WPA_SCAN_QUAL_INVALID BIT(0)
284 #define WPA_SCAN_NOISE_INVALID BIT(1)
285 #define WPA_SCAN_LEVEL_INVALID BIT(2)
286 #define WPA_SCAN_LEVEL_DBM BIT(3)
287 #define WPA_SCAN_ASSOCIATED BIT(5)
290 * struct wpa_scan_res - Scan result for an BSS/IBSS
291 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
293 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
294 * @beacon_int: beacon interval in TUs (host byte order)
295 * @caps: capability information field in host byte order
296 * @qual: signal quality
297 * @noise: noise level
298 * @level: signal level
300 * @age: Age of the information in milliseconds (i.e., how many milliseconds
301 * ago the last Beacon or Probe Response frame was received)
302 * @est_throughput: Estimated throughput in kbps (this is calculated during
303 * scan result processing if left zero by the driver wrapper)
304 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
305 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
306 * of TSF of the BSS specified by %tsf_bssid.
307 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
308 * @ie_len: length of the following IE field in octets
309 * @beacon_ie_len: length of the following Beacon IE field in octets
311 * This structure is used as a generic format for scan results from the
312 * driver. Each driver interface implementation is responsible for converting
313 * the driver or OS specific scan results into this format.
315 * If the driver does not support reporting all IEs, the IE data structure is
316 * constructed of the IEs that are available. This field will also need to
317 * include SSID in IE format. All drivers are encouraged to be extended to
318 * report all IEs to make it easier to support future additions.
320 * This structure data is followed by ie_len octets of IEs from Probe Response
321 * frame (or if the driver does not indicate source of IEs, these may also be
322 * from Beacon frame). After the first set of IEs, another set of IEs may follow
323 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
325 struct wpa_scan_res
{
336 unsigned int est_throughput
;
339 u8 tsf_bssid
[ETH_ALEN
];
341 size_t beacon_ie_len
;
342 /* Followed by ie_len + beacon_ie_len octets of IE data */
346 * struct wpa_scan_results - Scan results
347 * @res: Array of pointers to allocated variable length scan result entries
348 * @num: Number of entries in the scan result array
349 * @fetch_time: Time when the results were fetched from the driver
351 struct wpa_scan_results
{
352 struct wpa_scan_res
**res
;
354 struct os_reltime fetch_time
;
358 * struct wpa_interface_info - Network interface information
359 * @next: Pointer to the next interface or NULL if this is the last one
360 * @ifname: Interface name that can be used with init() or init2()
361 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
363 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
364 * is not an allocated copy, i.e., get_interfaces() caller will not free
367 struct wpa_interface_info
{
368 struct wpa_interface_info
*next
;
371 const char *drv_name
;
374 #define WPAS_MAX_SCAN_SSIDS 16
377 * struct wpa_driver_scan_ssid - SSIDs to scan for
378 * @ssid - specific SSID to scan for (ProbeReq)
379 * %NULL or zero-length SSID is used to indicate active scan
380 * with wildcard SSID.
381 * @ssid_len - Length of the SSID in octets
383 struct wpa_driver_scan_ssid
{
389 * struct wpa_driver_scan_params - Scan parameters
390 * Data for struct wpa_driver_ops::scan2().
392 struct wpa_driver_scan_params
{
394 * ssids - SSIDs to scan for
396 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
399 * num_ssids - Number of entries in ssids array
400 * Zero indicates a request for a passive scan.
405 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
410 * extra_ies_len - Length of extra_ies in octets
412 size_t extra_ies_len
;
415 * freqs - Array of frequencies to scan or %NULL for all frequencies
417 * The frequency is set in MHz. The array is zero-terminated.
422 * filter_ssids - Filter for reporting SSIDs
424 * This optional parameter can be used to request the driver wrapper to
425 * filter scan results to include only the specified SSIDs. %NULL
426 * indicates that no filtering is to be done. This can be used to
427 * reduce memory needs for scan results in environments that have large
428 * number of APs with different SSIDs.
430 * The driver wrapper is allowed to take this allocated buffer into its
431 * own use by setting the pointer to %NULL. In that case, the driver
432 * wrapper is responsible for freeing the buffer with os_free() once it
433 * is not needed anymore.
435 struct wpa_driver_scan_filter
{
436 u8 ssid
[SSID_MAX_LEN
];
441 * num_filter_ssids - Number of entries in filter_ssids array
443 size_t num_filter_ssids
;
446 * filter_rssi - Filter by RSSI
448 * The driver may filter scan results in firmware to reduce host
449 * wakeups and thereby save power. Specify the RSSI threshold in s32
455 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
457 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
458 * Mbps from the support rates element(s) in the Probe Request frames
459 * and not to transmit the frames at any of those rates.
461 unsigned int p2p_probe
:1;
464 * only_new_results - Request driver to report only new results
466 * This is used to request the driver to report only BSSes that have
467 * been detected after this scan request has been started, i.e., to
468 * flush old cached BSS entries.
470 unsigned int only_new_results
:1;
473 * low_priority - Requests driver to use a lower scan priority
475 * This is used to request the driver to use a lower scan priority
476 * if it supports such a thing.
478 unsigned int low_priority
:1;
481 * mac_addr_rand - Requests driver to randomize MAC address
483 unsigned int mac_addr_rand
:1;
486 * mac_addr - MAC address used with randomization. The address cannot be
487 * a multicast one, i.e., bit 0 of byte 0 should not be set.
492 * mac_addr_mask - MAC address mask used with randomization.
494 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
495 * the mask should be taken as is from mac_addr. The mask should not
496 * allow the generation of a multicast address, i.e., bit 0 of byte 0
499 const u8
*mac_addr_mask
;
502 * sched_scan_plans - Scan plans for scheduled scan
504 * Each scan plan consists of the number of iterations to scan and the
505 * interval between scans. When a scan plan finishes (i.e., it was run
506 * for the specified number of iterations), the next scan plan is
507 * executed. The scan plans are executed in the order they appear in
508 * the array (lower index first). The last scan plan will run infinitely
509 * (until requested to stop), thus must not specify the number of
510 * iterations. All other scan plans must specify the number of
513 struct sched_scan_plan
{
514 u32 interval
; /* In seconds */
515 u32 iterations
; /* Zero to run infinitely */
519 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
521 unsigned int sched_scan_plans_num
;
524 * sched_scan_start_delay - Delay to use before starting the first scan
526 * Delay (in seconds) before scheduling first scan plan cycle. The
527 * driver may ignore this parameter and start immediately (or at any
528 * other time), if this feature is not supported.
530 u32 sched_scan_start_delay
;
533 * bssid - Specific BSSID to scan for
535 * This optional parameter can be used to replace the default wildcard
536 * BSSID with a specific BSSID to scan for if results are needed from
542 * scan_cookie - Unique identification representing the scan request
544 * This scan_cookie carries a unique identification representing the
545 * scan request if the host driver/kernel supports concurrent scan
546 * requests. This cookie is returned from the corresponding driver
549 * Note: Unlike other parameters in this structure, scan_cookie is used
550 * only to return information instead of setting parameters for the
556 * duration - Dwell time on each channel
558 * This optional parameter can be used to set the dwell time on each
564 * duration_mandatory - Whether the specified duration is mandatory
566 * If this is set, the duration specified by the %duration field is
567 * mandatory (and the driver should reject the scan request if it is
568 * unable to comply with the specified duration), otherwise it is the
569 * maximum duration and the actual duration may be shorter.
571 unsigned int duration_mandatory
:1;
574 * relative_rssi_set - Whether relative RSSI parameters are set
576 unsigned int relative_rssi_set
:1;
579 * relative_rssi - Relative RSSI for reporting better BSSs
581 * Amount of RSSI by which a BSS should be better than the current
582 * connected BSS to report the new BSS to user space.
587 * relative_adjust_band - Band to which RSSI should be adjusted
589 * The relative_adjust_rssi should be added to the band specified
590 * by relative_adjust_band.
592 enum set_band relative_adjust_band
;
595 * relative_adjust_rssi - RSSI to be added to relative_adjust_band
597 * An amount of relative_band_rssi should be added to the BSSs that
598 * belong to the band specified by relative_adjust_band while comparing
599 * with other bands for BSS reporting.
601 s8 relative_adjust_rssi
;
606 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0)
607 * - Accept broadcast Probe Response frame.
608 * - Probe Request frame deferral and suppression.
609 * - Max Channel Time - driver fills FILS request params IE with
610 * Maximum Channel Time.
611 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps.
613 unsigned int oce_scan
:1;
616 * NOTE: Whenever adding new parameters here, please make sure
617 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
623 * struct wpa_driver_auth_params - Authentication parameters
624 * Data for struct wpa_driver_ops::authenticate().
626 struct wpa_driver_auth_params
{
634 const u8
*wep_key
[4];
635 size_t wep_key_len
[4];
637 int local_state_change
;
640 * p2p - Whether this connection is a P2P group
645 * auth_data - Additional elements for Authentication frame
647 * This buffer starts with the Authentication transaction sequence
648 * number field. If no special handling of such elements is needed, this
649 * pointer is %NULL. This is used with SAE and FILS.
654 * auth_data_len - Length of auth_data buffer in octets
656 size_t auth_data_len
;
660 * enum wps_mode - WPS mode
664 * WPS_MODE_NONE - No WPS provisioning being used
669 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
674 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
680 * struct hostapd_freq_params - Channel parameters
682 struct hostapd_freq_params
{
684 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
686 enum hostapd_hw_mode mode
;
689 * freq - Primary channel center frequency in MHz
694 * channel - Channel number
699 * ht_enabled - Whether HT is enabled
704 * sec_channel_offset - Secondary channel offset for HT40
707 * -1 = HT40 enabled, secondary channel below primary,
708 * 1 = HT40 enabled, secondary channel above primary
710 int sec_channel_offset
;
713 * vht_enabled - Whether VHT is enabled
718 * he_enabled - Whether HE is enabled
723 * center_freq1 - Segment 0 center frequency in MHz
725 * Valid for both HT and VHT.
730 * center_freq2 - Segment 1 center frequency in MHz
732 * Non-zero only for bandwidth 80 and an 80+80 channel
737 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
743 * struct wpa_driver_sta_auth_params - Authentication parameters
744 * Data for struct wpa_driver_ops::sta_auth().
746 struct wpa_driver_sta_auth_params
{
749 * own_addr - Source address and BSSID for authentication frame
754 * addr - MAC address of the station to associate
759 * seq - authentication sequence number
764 * status - authentication response status code
769 * ie - authentication frame ie buffer
774 * len - ie buffer length
779 * fils_auth - Indicates whether FILS authentication is being performed
784 * fils_anonce - ANonce (required for FILS)
786 u8 fils_anonce
[WPA_NONCE_LEN
];
789 * fils_snonce - SNonce (required for FILS)
791 u8 fils_snonce
[WPA_NONCE_LEN
];
794 * fils_kek - key for encryption (required for FILS)
796 u8 fils_kek
[WPA_KEK_MAX_LEN
];
799 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
805 * struct wpa_driver_associate_params - Association parameters
806 * Data for struct wpa_driver_ops::associate().
808 struct wpa_driver_associate_params
{
810 * bssid - BSSID of the selected AP
811 * This can be %NULL, if ap_scan=2 mode is used and the driver is
812 * responsible for selecting with which BSS to associate. */
816 * bssid_hint - BSSID of a proposed AP
818 * This indicates which BSS has been found a suitable candidate for
819 * initial association for drivers that use driver/firmwate-based BSS
820 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
821 * the driver from selecting other BSSes in the ESS.
823 const u8
*bssid_hint
;
826 * ssid - The selected SSID
831 * ssid_len - Length of the SSID (1..32)
836 * freq - channel parameters
838 struct hostapd_freq_params freq
;
841 * freq_hint - Frequency of the channel the proposed AP is using
843 * This provides a channel on which a suitable BSS has been found as a
844 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
845 * limit the driver from selecting other channels for
846 * driver/firmware-based BSS selection.
851 * bg_scan_period - Background scan period in seconds, 0 to disable
852 * background scan, or -1 to indicate no change to default driver
858 * beacon_int - Beacon interval for IBSS or 0 to use driver default
863 * wpa_ie - WPA information element for (Re)Association Request
864 * WPA information element to be included in (Re)Association
865 * Request (including information element id and length). Use
866 * of this WPA IE is optional. If the driver generates the WPA
867 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
868 * key_mgmt_suite to select proper algorithms. In this case,
869 * the driver has to notify wpa_supplicant about the used WPA
870 * IE by generating an event that the interface code will
871 * convert into EVENT_ASSOCINFO data (see below).
873 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
874 * instead. The driver can determine which version is used by
875 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
878 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
883 * wpa_ie_len - length of the wpa_ie
888 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
890 unsigned int wpa_proto
;
893 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
895 * This is usually ignored if @wpa_ie is used.
897 unsigned int pairwise_suite
;
900 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
902 * This is usually ignored if @wpa_ie is used.
904 unsigned int group_suite
;
907 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
909 * This is usually ignored if @wpa_ie is used.
911 unsigned int mgmt_group_suite
;
914 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
916 * This is usually ignored if @wpa_ie is used.
918 unsigned int key_mgmt_suite
;
921 * auth_alg - Allowed authentication algorithms
922 * Bit field of WPA_AUTH_ALG_*
927 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
932 * wep_key - WEP keys for static WEP configuration
934 const u8
*wep_key
[4];
937 * wep_key_len - WEP key length for static WEP configuration
939 size_t wep_key_len
[4];
942 * wep_tx_keyidx - WEP TX key index for static WEP configuration
947 * mgmt_frame_protection - IEEE 802.11w management frame protection
949 enum mfp_options mgmt_frame_protection
;
952 * passphrase - RSN passphrase for PSK
954 * This value is made available only for WPA/WPA2-Personal (PSK) and
955 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
956 * is the 8..63 character ASCII passphrase, if available. Please note
957 * that this can be %NULL if passphrase was not used to generate the
958 * PSK. In that case, the psk field must be used to fetch the PSK.
960 const char *passphrase
;
963 * psk - RSN PSK (alternative for passphrase for PSK)
965 * This value is made available only for WPA/WPA2-Personal (PSK) and
966 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
967 * is the 32-octet (256-bit) PSK, if available. The driver wrapper
968 * should be prepared to handle %NULL value as an error.
973 * drop_unencrypted - Enable/disable unencrypted frame filtering
975 * Configure the driver to drop all non-EAPOL frames (both receive and
976 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
977 * still be allowed for key negotiation.
979 int drop_unencrypted
;
982 * prev_bssid - Previously used BSSID in this ESS
984 * When not %NULL, this is a request to use reassociation instead of
987 const u8
*prev_bssid
;
992 * If the driver needs to do special configuration for WPS association,
993 * this variable provides more information on what type of association
994 * is being requested. Most drivers should not need ot use this.
999 * p2p - Whether this connection is a P2P group
1004 * uapsd - UAPSD parameters for the network
1005 * -1 = do not change defaults
1006 * AP mode: 1 = enabled, 0 = disabled
1007 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
1012 * fixed_bssid - Whether to force this BSSID in IBSS mode
1013 * 1 = Fix this BSSID and prevent merges.
1014 * 0 = Do not fix BSSID.
1019 * fixed_freq - Fix control channel in IBSS mode
1020 * 0 = don't fix control channel (default)
1021 * 1 = fix control channel; this prevents IBSS merging with another
1027 * disable_ht - Disable HT (IEEE 802.11n) for this connection
1032 * htcaps - HT Capabilities over-rides
1034 * Only bits set in the mask will be used, and not all values are used
1035 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
1037 * Pointer to struct ieee80211_ht_capabilities.
1042 * htcaps_mask - HT Capabilities over-rides mask
1044 * Pointer to struct ieee80211_ht_capabilities.
1046 const u8
*htcaps_mask
;
1048 #ifdef CONFIG_VHT_OVERRIDES
1050 * disable_vht - Disable VHT for this connection
1055 * VHT capability overrides.
1057 const struct ieee80211_vht_capabilities
*vhtcaps
;
1058 const struct ieee80211_vht_capabilities
*vhtcaps_mask
;
1059 #endif /* CONFIG_VHT_OVERRIDES */
1062 * req_key_mgmt_offload - Request key management offload for connection
1064 * Request key management offload for this connection if the device
1067 int req_key_mgmt_offload
;
1070 * Flag for indicating whether this association includes support for
1071 * RRM (Radio Resource Measurements)
1076 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1077 * AP as usual. Valid for DMG network only.
1082 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1087 * fils_kek_len: Length of fils_kek in bytes
1089 size_t fils_kek_len
;
1092 * fils_nonces - Nonces for FILS association frame protection
1095 const u8
*fils_nonces
;
1098 * fils_nonces_len: Length of fils_nonce in bytes
1100 size_t fils_nonces_len
;
1103 * fils_erp_username - Username part of keyName-NAI
1105 const u8
*fils_erp_username
;
1108 * fils_erp_username_len - Length of fils_erp_username in bytes
1110 size_t fils_erp_username_len
;
1113 * fils_erp_realm - Realm/domain name to use in FILS ERP
1115 const u8
*fils_erp_realm
;
1118 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1120 size_t fils_erp_realm_len
;
1123 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1126 u16 fils_erp_next_seq_num
;
1129 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1130 * specified by fils_erp_username@fils_erp_realm.
1132 const u8
*fils_erp_rrk
;
1135 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1137 size_t fils_erp_rrk_len
;
1142 HIDDEN_SSID_ZERO_LEN
,
1143 HIDDEN_SSID_ZERO_CONTENTS
1146 enum ch_switch_state
{
1151 struct wowlan_triggers
{
1155 u8 gtk_rekey_failure
;
1156 u8 eap_identity_req
;
1157 u8 four_way_handshake
;
1161 struct wpa_driver_ap_params
{
1163 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1168 * head_len - Length of the head buffer in octets
1173 * tail - Beacon tail following TIM IE
1178 * tail_len - Length of the tail buffer in octets
1183 * dtim_period - DTIM period
1188 * beacon_int - Beacon interval
1193 * basic_rates: -1 terminated array of basic rates in 100 kbps
1195 * This parameter can be used to set a specific basic rate set for the
1196 * BSS. If %NULL, default basic rate set is used.
1201 * beacon_rate: Beacon frame data rate
1203 * This parameter can be used to set a specific Beacon frame data rate
1204 * for the BSS. The interpretation of this value depends on the
1205 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS). If
1206 * beacon_rate == 0 and rate_type == 0 (BEACON_RATE_LEGACY), the default
1207 * Beacon frame data rate is used.
1209 unsigned int beacon_rate
;
1212 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT)
1214 enum beacon_rate_type rate_type
;
1217 * proberesp - Probe Response template
1219 * This is used by drivers that reply to Probe Requests internally in
1220 * AP mode and require the full Probe Response template.
1225 * proberesp_len - Length of the proberesp buffer in octets
1227 size_t proberesp_len
;
1230 * ssid - The SSID to use in Beacon/Probe Response frames
1235 * ssid_len - Length of the SSID (1..32)
1240 * hide_ssid - Whether to hide the SSID
1242 enum hide_ssid hide_ssid
;
1245 * pairwise_ciphers - WPA_CIPHER_* bitfield
1247 unsigned int pairwise_ciphers
;
1250 * group_cipher - WPA_CIPHER_*
1252 unsigned int group_cipher
;
1255 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1257 unsigned int key_mgmt_suites
;
1260 * auth_algs - WPA_AUTH_ALG_* bitfield
1262 unsigned int auth_algs
;
1265 * wpa_version - WPA_PROTO_* bitfield
1267 unsigned int wpa_version
;
1270 * privacy - Whether privacy is used in the BSS
1275 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1277 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1278 * not use the full Beacon template.
1280 const struct wpabuf
*beacon_ies
;
1283 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1285 * This is used to add IEs like WPS IE and P2P IE by drivers that
1286 * reply to Probe Request frames internally.
1288 const struct wpabuf
*proberesp_ies
;
1291 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1293 * This is used to add IEs like WPS IE by drivers that reply to
1294 * (Re)Association Request frames internally.
1296 const struct wpabuf
*assocresp_ies
;
1299 * isolate - Whether to isolate frames between associated stations
1301 * If this is non-zero, the AP is requested to disable forwarding of
1302 * frames between associated stations.
1307 * cts_protect - Whether CTS protection is enabled
1312 * preamble - Whether short preamble is enabled
1317 * short_slot_time - Whether short slot time is enabled
1319 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1320 * not set (e.g., when 802.11g mode is not in use)
1322 int short_slot_time
;
1325 * ht_opmode - HT operation mode or -1 if HT not in use
1330 * interworking - Whether Interworking is enabled
1335 * hessid - Homogeneous ESS identifier or %NULL if not set
1340 * access_network_type - Access Network Type (0..15)
1342 * This is used for filtering Probe Request frames when Interworking is
1345 u8 access_network_type
;
1348 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1350 * This is used by driver which advertises this capability.
1352 int ap_max_inactivity
;
1355 * ctwindow - Client Traffic Window (in TUs)
1360 * smps_mode - SMPS mode
1362 * SMPS mode to be used by the AP, specified as the relevant bits of
1363 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1365 unsigned int smps_mode
;
1368 * disable_dgaf - Whether group-addressed frames are disabled
1373 * osen - Whether OSEN security is enabled
1378 * freq - Channel parameters for dynamic bandwidth changes
1380 struct hostapd_freq_params
*freq
;
1383 * reenable - Whether this is to re-enable beaconing
1388 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1389 * infrastructure BSS. Valid only for DMG network.
1394 * multicast_to_unicast - Whether to use multicast_to_unicast
1396 * If this is non-zero, the AP is requested to perform multicast to
1397 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1398 * 802.1Q). If enabled, such frames are to be sent to each station
1399 * separately, with the DA replaced by their own MAC address rather
1400 * than the group address.
1402 * Note that this may break certain expectations of the receiver, such
1403 * as the ability to drop unicast IP packets received within multicast
1404 * L2 frames, or the ability to not send ICMP destination unreachable
1405 * messages for packets received in L2 multicast (which is required,
1406 * but the receiver can't tell the difference if this new option is
1409 * This also doesn't implement the 802.11 DMS (directed multicast
1412 int multicast_to_unicast
;
1415 * ftm_responder - Whether FTM responder is enabled
1420 * lci - Binary data, the content of an LCI report IE with type 8 as
1421 * defined in IEEE Std 802.11-2016, 9.4.2.22.10
1423 const struct wpabuf
*lci
;
1426 * civic - Binary data, the content of a measurement report IE with
1427 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
1429 const struct wpabuf
*civic
;
1432 struct wpa_driver_mesh_bss_params
{
1433 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1434 #define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1435 #define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1436 #define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
1437 #define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010
1439 * TODO: Other mesh configuration parameters would go here.
1440 * See NL80211_MESHCONF_* for all the mesh config parameters.
1444 int peer_link_timeout
;
1450 struct wpa_driver_mesh_join_params
{
1453 const int *basic_rates
;
1456 struct hostapd_freq_params freq
;
1459 struct wpa_driver_mesh_bss_params conf
;
1460 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1461 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1462 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1463 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1468 * struct wpa_driver_capa - Driver capability information
1470 struct wpa_driver_capa
{
1471 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1472 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1473 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1474 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1475 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1476 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1477 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1478 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1479 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1480 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
1481 #define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
1482 #define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
1483 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1484 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1485 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1486 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
1487 #define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000
1488 /** Bitfield of supported key management suites */
1489 unsigned int key_mgmt
;
1491 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1492 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1493 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1494 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1495 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1496 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1497 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1498 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1499 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1500 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1501 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1502 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1503 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1504 /** Bitfield of supported cipher suites */
1507 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1508 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1509 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1510 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1513 /** Driver generated WPA/RSN IE */
1514 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1515 /** Driver needs static WEP key setup after association command */
1516 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1517 /** Driver takes care of all DFS operations */
1518 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1519 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1520 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1521 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008
1522 /** Driver is for a wired Ethernet interface */
1523 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1524 /** Driver provides separate commands for authentication and association (SME in
1525 * wpa_supplicant). */
1526 #define WPA_DRIVER_FLAGS_SME 0x00000020
1527 /** Driver supports AP mode */
1528 #define WPA_DRIVER_FLAGS_AP 0x00000040
1529 /** Driver needs static WEP key setup after association has been completed */
1530 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1531 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1532 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1533 /** Driver supports concurrent P2P operations */
1534 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1536 * Driver uses the initial interface as a dedicated management interface, i.e.,
1537 * it cannot be used for P2P group operations or non-P2P purposes.
1539 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1540 /** This interface is P2P capable (P2P GO or P2P Client) */
1541 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1542 /** Driver supports station and key removal when stopping an AP */
1543 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1545 * Driver uses the initial interface for P2P management interface and non-P2P
1546 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1547 * P2P group operations.
1549 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1551 * Driver is known to use sane error codes, i.e., when it indicates that
1552 * something (e.g., association) fails, there was indeed a failure and the
1553 * operation does not end up getting completed successfully later.
1555 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1556 /** Driver supports off-channel TX */
1557 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1558 /** Driver indicates TX status events for EAPOL Data frames */
1559 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1560 /** Driver indicates TX status events for Deauth/Disassoc frames */
1561 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1562 /** Driver supports roaming (BSS selection) in firmware */
1563 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1564 /** Driver supports operating as a TDLS peer */
1565 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1566 /** Driver requires external TDLS setup/teardown/discovery */
1567 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1568 /** Driver indicates support for Probe Response offloading in AP mode */
1569 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1570 /** Driver supports U-APSD in AP mode */
1571 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1572 /** Driver supports inactivity timer in AP mode */
1573 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1574 /** Driver expects user space implementation of MLME in AP mode */
1575 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1576 /** Driver supports SAE with user space SME */
1577 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1578 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1579 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1580 /** Driver supports IBSS (Ad-hoc) mode */
1581 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1582 /** Driver supports radar detection */
1583 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1584 /** Driver supports a dedicated interface for P2P Device */
1585 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1586 /** Driver supports QoS Mapping */
1587 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1588 /** Driver supports CSA in AP mode */
1589 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1590 /** Driver supports mesh */
1591 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1592 /** Driver support ACS offload */
1593 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1594 /** Driver supports key management offload */
1595 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1596 /** Driver supports TDLS channel switching */
1597 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1598 /** Driver supports IBSS with HT datarates */
1599 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
1600 /** Driver supports IBSS with VHT datarates */
1601 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
1602 /** Driver supports automatic band selection */
1603 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
1604 /** Driver supports simultaneous off-channel operations */
1605 #define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
1606 /** Driver supports full AP client state */
1607 #define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
1608 /** Driver supports P2P Listen offload */
1609 #define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
1610 /** Driver supports FILS */
1611 #define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
1612 /** Driver supports Beacon frame TX rate configuration (legacy rates) */
1613 #define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1614 /** Driver supports Beacon frame TX rate configuration (HT rates) */
1615 #define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1616 /** Driver supports Beacon frame TX rate configuration (VHT rates) */
1617 #define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
1618 /** Driver supports mgmt_tx with random TX address in non-connected state */
1619 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
1620 /** Driver supports mgmt_tx with random TX addr in connected state */
1621 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
1622 /** Driver supports better BSS reporting with sched_scan in connected mode */
1623 #define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
1624 /** Driver supports HE capabilities */
1625 #define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
1626 /** Driver supports FILS shared key offload */
1627 #define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
1628 /** Driver supports all OCE STA specific mandatory features */
1629 #define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
1630 /** Driver supports all OCE AP specific mandatory features */
1631 #define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
1633 * Driver supports all OCE STA-CFON specific mandatory features only.
1634 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
1635 * userspace shall assume that this driver may not support all OCE AP
1636 * functionality but can support only OCE STA-CFON functionality.
1638 #define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
1639 /** Driver supports MFP-optional in the connect command */
1640 #define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL
1641 /** Driver is a self-managed regulatory device */
1642 #define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL
1643 /** Driver supports FTM responder functionality */
1644 #define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL
1645 /** Driver support 4-way handshake offload for WPA-Personal */
1646 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
1649 #define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1650 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1652 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1653 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1654 unsigned int smps_modes
;
1656 unsigned int wmm_ac_supported
:1;
1658 unsigned int mac_addr_rand_scan_supported
:1;
1659 unsigned int mac_addr_rand_sched_scan_supported
:1;
1661 /** Maximum number of supported active probe SSIDs */
1664 /** Maximum number of supported active probe SSIDs for sched_scan */
1665 int max_sched_scan_ssids
;
1667 /** Maximum number of supported scan plans for scheduled scan */
1668 unsigned int max_sched_scan_plans
;
1670 /** Maximum interval in a scan plan. In seconds */
1671 u32 max_sched_scan_plan_interval
;
1673 /** Maximum number of iterations in a single scan plan */
1674 u32 max_sched_scan_plan_iterations
;
1676 /** Whether sched_scan (offloaded scanning) is supported */
1677 int sched_scan_supported
;
1679 /** Maximum number of supported match sets for sched_scan */
1683 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1685 unsigned int max_remain_on_chan
;
1688 * max_stations - Maximum number of associated stations the driver
1689 * supports in AP mode
1691 unsigned int max_stations
;
1694 * probe_resp_offloads - Bitmap of supported protocols by the driver
1695 * for Probe Response offloading.
1697 /** Driver Probe Response offloading support for WPS ver. 1 */
1698 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1699 /** Driver Probe Response offloading support for WPS ver. 2 */
1700 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1701 /** Driver Probe Response offloading support for P2P */
1702 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1703 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1704 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1705 unsigned int probe_resp_offloads
;
1707 unsigned int max_acl_mac_addrs
;
1710 * Number of supported concurrent channels
1712 unsigned int num_multichan_concurrent
;
1715 * extended_capa - extended capabilities in driver/device
1717 * Must be allocated and freed by driver and the pointers must be
1718 * valid for the lifetime of the driver, i.e., freed in deinit()
1720 const u8
*extended_capa
, *extended_capa_mask
;
1721 unsigned int extended_capa_len
;
1723 struct wowlan_triggers wowlan_triggers
;
1725 /** Driver adds the DS Params Set IE in Probe Request frames */
1726 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1727 /** Driver adds the WFA TPC IE in Probe Request frames */
1728 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1729 /** Driver handles quiet period requests */
1730 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1732 * Driver is capable of inserting the current TX power value into the body of
1733 * transmitted frames.
1734 * Background: Some Action frames include a TPC Report IE. This IE contains a
1735 * TX power field, which has to be updated by lower layers. One such Action
1736 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1737 * of spectrum management). Note that this insertion takes place at a fixed
1738 * offset, namely the 6th byte in the Action frame body.
1740 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1742 * Driver supports RRM. With this support, the driver will accept to use RRM in
1743 * (Re)Association Request frames, without supporting quiet period.
1745 #define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1747 /** Driver supports setting the scan dwell time */
1748 #define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
1749 /** Driver supports Beacon Report Measurement */
1750 #define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
1754 /* Driver concurrency capabilities */
1755 unsigned int conc_capab
;
1756 /* Maximum number of concurrent channels on 2.4 GHz */
1757 unsigned int max_conc_chan_2_4
;
1758 /* Maximum number of concurrent channels on 5 GHz */
1759 unsigned int max_conc_chan_5_0
;
1761 /* Maximum number of supported CSA counters */
1762 u16 max_csa_counters
;
1766 struct hostapd_data
;
1768 #define STA_DRV_DATA_TX_MCS BIT(0)
1769 #define STA_DRV_DATA_RX_MCS BIT(1)
1770 #define STA_DRV_DATA_TX_VHT_MCS BIT(2)
1771 #define STA_DRV_DATA_RX_VHT_MCS BIT(3)
1772 #define STA_DRV_DATA_TX_VHT_NSS BIT(4)
1773 #define STA_DRV_DATA_RX_VHT_NSS BIT(5)
1774 #define STA_DRV_DATA_TX_SHORT_GI BIT(6)
1775 #define STA_DRV_DATA_RX_SHORT_GI BIT(7)
1776 #define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
1778 struct hostap_sta_driver_data
{
1779 unsigned long rx_packets
, tx_packets
;
1780 unsigned long long rx_bytes
, tx_bytes
;
1781 unsigned long long rx_airtime
, tx_airtime
;
1782 int bytes_64bit
; /* whether 64-bit byte counters are supported */
1783 unsigned long current_tx_rate
;
1784 unsigned long current_rx_rate
;
1785 unsigned long inactive_msec
;
1786 unsigned long flags
; /* bitfield of STA_DRV_DATA_* */
1787 unsigned long num_ps_buf_frames
;
1788 unsigned long tx_retry_failed
;
1789 unsigned long tx_retry_count
;
1791 unsigned long backlog_packets
;
1792 unsigned long backlog_bytes
;
1802 struct hostapd_sta_add_params
{
1806 const u8
*supp_rates
;
1807 size_t supp_rates_len
;
1808 u16 listen_interval
;
1809 const struct ieee80211_ht_capabilities
*ht_capabilities
;
1810 const struct ieee80211_vht_capabilities
*vht_capabilities
;
1811 int vht_opmode_enabled
;
1813 const struct ieee80211_he_capabilities
*he_capab
;
1814 size_t he_capab_len
;
1815 u32 flags
; /* bitmask of WPA_STA_* flags */
1816 u32 flags_mask
; /* unset bits in flags */
1818 enum mesh_plink_state plink_state
;
1820 #endif /* CONFIG_MESH */
1821 int set
; /* Set STA parameters instead of add */
1823 const u8
*ext_capab
;
1824 size_t ext_capab_len
;
1825 const u8
*supp_channels
;
1826 size_t supp_channels_len
;
1827 const u8
*supp_oper_classes
;
1828 size_t supp_oper_classes_len
;
1832 struct mac_address
{
1836 struct hostapd_acl_params
{
1838 unsigned int num_mac_acl
;
1839 struct mac_address mac_acl
[0];
1842 enum wpa_driver_if_type
{
1844 * WPA_IF_STATION - Station mode interface
1849 * WPA_IF_AP_VLAN - AP mode VLAN interface
1851 * This interface shares its address and Beacon frame with the main
1857 * WPA_IF_AP_BSS - AP mode BSS interface
1859 * This interface has its own address and Beacon frame.
1864 * WPA_IF_P2P_GO - P2P Group Owner
1869 * WPA_IF_P2P_CLIENT - P2P Client
1874 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1875 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1880 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1881 * abstracted P2P Device function in the driver
1886 * WPA_IF_MESH - Mesh interface
1891 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1896 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1901 struct wpa_init_params
{
1905 const char *driver_params
;
1906 int use_pae_group_addr
;
1910 u8
*own_addr
; /* buffer for writing own MAC address */
1914 struct wpa_bss_params
{
1915 /** Interface name (for multi-SSID/VLAN support) */
1917 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1926 enum mfp_options ieee80211w
;
1929 #define WPA_STA_AUTHORIZED BIT(0)
1930 #define WPA_STA_WMM BIT(1)
1931 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1932 #define WPA_STA_MFP BIT(3)
1933 #define WPA_STA_TDLS_PEER BIT(4)
1934 #define WPA_STA_AUTHENTICATED BIT(5)
1935 #define WPA_STA_ASSOCIATED BIT(6)
1948 WNM_SLEEP_ENTER_CONFIRM
,
1949 WNM_SLEEP_ENTER_FAIL
,
1950 WNM_SLEEP_EXIT_CONFIRM
,
1951 WNM_SLEEP_EXIT_FAIL
,
1952 WNM_SLEEP_TFS_REQ_IE_ADD
, /* STA requests driver to add TFS req IE */
1953 WNM_SLEEP_TFS_REQ_IE_NONE
, /* STA requests empty TFS req IE */
1954 WNM_SLEEP_TFS_REQ_IE_SET
, /* AP requests driver to set TFS req IE for
1956 WNM_SLEEP_TFS_RESP_IE_ADD
, /* AP requests driver to add TFS resp IE
1958 WNM_SLEEP_TFS_RESP_IE_NONE
, /* AP requests empty TFS resp IE */
1959 WNM_SLEEP_TFS_RESP_IE_SET
, /* AP requests driver to set TFS resp IE
1961 WNM_SLEEP_TFS_IE_DEL
/* AP delete the TFS IE */
1964 /* enum smps_mode - SMPS mode definitions */
1975 #define WPA_INVALID_NOISE 9999
1978 * struct wpa_signal_info - Information about channel signal quality
1979 * @frequency: control frequency
1980 * @above_threshold: true if the above threshold was crossed
1981 * (relevant for a CQM event)
1982 * @current_signal: in dBm
1983 * @avg_signal: in dBm
1984 * @avg_beacon_signal: in dBm
1985 * @current_noise: %WPA_INVALID_NOISE if not supported
1986 * @current_txrate: current TX rate
1987 * @chanwidth: channel width
1988 * @center_frq1: center frequency for the first segment
1989 * @center_frq2: center frequency for the second segment (if relevant)
1991 struct wpa_signal_info
{
1993 int above_threshold
;
1996 int avg_beacon_signal
;
1999 enum chan_width chanwidth
;
2005 * struct wpa_channel_info - Information about the current channel
2006 * @frequency: Center frequency of the primary 20 MHz channel
2007 * @chanwidth: Width of the current operating channel
2008 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
2009 * This field is only filled in when using a 40 MHz channel.
2010 * @center_frq1: Center frequency of frequency segment 0
2011 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
2012 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
2013 * derived from center_frq2 for convenience.
2015 struct wpa_channel_info
{
2017 enum chan_width chanwidth
;
2025 * struct beacon_data - Beacon data
2026 * @head: Head portion of Beacon frame (before TIM IE)
2027 * @tail: Tail portion of Beacon frame (after TIM IE)
2028 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2029 * @proberesp_ies: Extra information element(s) to add into Probe Response
2031 * @assocresp_ies: Extra information element(s) to add into (Re)Association
2032 * Response frames or %NULL
2033 * @probe_resp: Probe Response frame template
2034 * @head_len: Length of @head
2035 * @tail_len: Length of @tail
2036 * @beacon_ies_len: Length of beacon_ies in octets
2037 * @proberesp_ies_len: Length of proberesp_ies in octets
2038 * @proberesp_ies_len: Length of proberesp_ies in octets
2039 * @probe_resp_len: Length of probe response template (@probe_resp)
2041 struct beacon_data
{
2048 size_t head_len
, tail_len
;
2049 size_t beacon_ies_len
;
2050 size_t proberesp_ies_len
;
2051 size_t assocresp_ies_len
;
2052 size_t probe_resp_len
;
2056 * struct csa_settings - Settings for channel switch command
2057 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2058 * @block_tx: 1 - block transmission for CSA period
2059 * @freq_params: Next channel frequency parameter
2060 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2061 * @beacon_after: Next beacon/probe resp/asooc resp info
2062 * @counter_offset_beacon: Offset to the count field in beacon's tail
2063 * @counter_offset_presp: Offset to the count field in probe resp.
2065 struct csa_settings
{
2069 struct hostapd_freq_params freq_params
;
2070 struct beacon_data beacon_csa
;
2071 struct beacon_data beacon_after
;
2073 u16 counter_offset_beacon
[2];
2074 u16 counter_offset_presp
[2];
2077 /* TDLS peer capabilities for send_tdls_mgmt() */
2078 enum tdls_peer_capability
{
2079 TDLS_PEER_HT
= BIT(0),
2080 TDLS_PEER_VHT
= BIT(1),
2081 TDLS_PEER_WMM
= BIT(2),
2084 /* valid info in the wmm_params struct */
2085 enum wmm_params_valid_info
{
2086 WMM_PARAMS_UAPSD_QUEUES_INFO
= BIT(0),
2090 * struct wmm_params - WMM parameterss configured for this association
2091 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2092 * of the struct contain valid information.
2093 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2094 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2101 #ifdef CONFIG_MACSEC
2102 struct macsec_init_params
{
2103 Boolean always_include_sci
;
2107 #endif /* CONFIG_MACSEC */
2109 enum drv_br_port_attr
{
2110 DRV_BR_PORT_ATTR_PROXYARP
,
2111 DRV_BR_PORT_ATTR_HAIRPIN_MODE
,
2114 enum drv_br_net_param
{
2115 DRV_BR_NET_PARAM_GARP_ACCEPT
,
2116 DRV_BR_MULTICAST_SNOOPING
,
2119 struct drv_acs_params
{
2120 /* Selected mode (HOSTAPD_MODE_*) */
2121 enum hostapd_hw_mode hw_mode
;
2123 /* Indicates whether HT is enabled */
2126 /* Indicates whether HT40 is enabled */
2129 /* Indicates whether VHT is enabled */
2132 /* Configured ACS channel width */
2135 /* ACS channel list info */
2136 unsigned int ch_list_len
;
2138 const int *freq_list
;
2141 struct wpa_bss_trans_info
{
2142 u8 mbo_transition_reason
;
2147 struct wpa_bss_candidate_info
{
2149 struct candidate_list
{
2156 struct wpa_pmkid_params
{
2160 const u8
*fils_cache_id
;
2166 /* Mask used to specify which connection parameters have to be updated */
2167 enum wpa_drv_update_connect_params_mask
{
2168 WPA_DRV_UPDATE_ASSOC_IES
= BIT(0),
2169 WPA_DRV_UPDATE_FILS_ERP_INFO
= BIT(1),
2170 WPA_DRV_UPDATE_AUTH_TYPE
= BIT(2),
2174 * struct external_auth - External authentication trigger parameters
2176 * These are used across the external authentication request and event
2178 * @action: Action type / trigger for external authentication. Only significant
2179 * for the event interface.
2180 * @bssid: BSSID of the peer with which the authentication has to happen. Used
2181 * by both the request and event interface.
2182 * @ssid: SSID of the AP. Used by both the request and event interface.
2183 * @ssid_len: SSID length in octets.
2184 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2185 * the request interface.
2186 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2187 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2188 * the real status code for failures. Used only for the request interface
2189 * from user space to the driver.
2190 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
2192 struct external_auth
{
2200 unsigned int key_mgmt_suite
;
2206 * struct wpa_driver_ops - Driver interface API definition
2208 * This structure defines the API that each driver interface needs to implement
2209 * for core wpa_supplicant code. All driver specific functionality is captured
2212 struct wpa_driver_ops
{
2213 /** Name of the driver interface */
2215 /** One line description of the driver interface */
2219 * get_bssid - Get the current BSSID
2220 * @priv: private driver interface data
2221 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2223 * Returns: 0 on success, -1 on failure
2225 * Query kernel driver for the current BSSID and copy it to bssid.
2226 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2229 int (*get_bssid
)(void *priv
, u8
*bssid
);
2232 * get_ssid - Get the current SSID
2233 * @priv: private driver interface data
2234 * @ssid: buffer for SSID (at least 32 bytes)
2236 * Returns: Length of the SSID on success, -1 on failure
2238 * Query kernel driver for the current SSID and copy it to ssid.
2239 * Returning zero is recommended if the STA is not associated.
2241 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2242 * can, at least in theory, contain control characters (including nul)
2243 * and as such, should be processed as binary data, not a printable
2246 int (*get_ssid
)(void *priv
, u8
*ssid
);
2249 * set_key - Configure encryption key
2250 * @ifname: Interface name (for multi-SSID/VLAN support)
2251 * @priv: private driver interface data
2252 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
2253 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
2254 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
2255 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
2256 * %WPA_ALG_BIP_CMAC_256);
2257 * %WPA_ALG_NONE clears the key.
2258 * @addr: Address of the peer STA (BSSID of the current AP when setting
2259 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
2260 * broadcast keys, %NULL for default keys that are used both for
2261 * broadcast and unicast; when clearing keys, %NULL is used to
2262 * indicate that both the broadcast-only and default key of the
2263 * specified key index is to be cleared
2264 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
2266 * @set_tx: configure this key as the default Tx key (only used when
2267 * driver does not support separate unicast/individual key
2268 * @seq: sequence number/packet number, seq_len octets, the next
2269 * packet number to be used for in replay protection; configured
2270 * for Rx keys (in most cases, this is only used with broadcast
2271 * keys and set to zero for unicast keys); %NULL if not set
2272 * @seq_len: length of the seq, depends on the algorithm:
2273 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
2274 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
2276 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
2277 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
2279 * Returns: 0 on success, -1 on failure
2281 * Configure the given key for the kernel driver. If the driver
2282 * supports separate individual keys (4 default keys + 1 individual),
2283 * addr can be used to determine whether the key is default or
2284 * individual. If only 4 keys are supported, the default key with key
2285 * index 0 is used as the individual key. STA must be configured to use
2286 * it as the default Tx key (set_tx is set) and accept Rx for all the
2287 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2288 * broadcast keys, so key index 0 is available for this kind of
2291 * Please note that TKIP keys include separate TX and RX MIC keys and
2292 * some drivers may expect them in different order than wpa_supplicant
2293 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
2294 * will trigger Michael MIC errors. This can be fixed by changing the
2295 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
2296 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2297 * example on how this can be done.
2299 int (*set_key
)(const char *ifname
, void *priv
, enum wpa_alg alg
,
2300 const u8
*addr
, int key_idx
, int set_tx
,
2301 const u8
*seq
, size_t seq_len
,
2302 const u8
*key
, size_t key_len
);
2305 * init - Initialize driver interface
2306 * @ctx: context to be used when calling wpa_supplicant functions,
2307 * e.g., wpa_supplicant_event()
2308 * @ifname: interface name, e.g., wlan0
2310 * Returns: Pointer to private data, %NULL on failure
2312 * Initialize driver interface, including event processing for kernel
2313 * driver events (e.g., associated, scan results, Michael MIC failure).
2314 * This function can allocate a private configuration data area for
2315 * @ctx, file descriptor, interface name, etc. information that may be
2316 * needed in future driver operations. If this is not used, non-NULL
2317 * value will need to be returned because %NULL is used to indicate
2318 * failure. The returned value will be used as 'void *priv' data for
2319 * all other driver_ops functions.
2321 * The main event loop (eloop.c) of wpa_supplicant can be used to
2322 * register callback for read sockets (eloop_register_read_sock()).
2324 * See below for more information about events and
2325 * wpa_supplicant_event() function.
2327 void * (*init
)(void *ctx
, const char *ifname
);
2330 * deinit - Deinitialize driver interface
2331 * @priv: private driver interface data from init()
2333 * Shut down driver interface and processing of driver events. Free
2334 * private data buffer if one was allocated in init() handler.
2336 void (*deinit
)(void *priv
);
2339 * set_param - Set driver configuration parameters
2340 * @priv: private driver interface data from init()
2341 * @param: driver specific configuration parameters
2343 * Returns: 0 on success, -1 on failure
2345 * Optional handler for notifying driver interface about configuration
2346 * parameters (driver_param).
2348 int (*set_param
)(void *priv
, const char *param
);
2351 * set_countermeasures - Enable/disable TKIP countermeasures
2352 * @priv: private driver interface data
2353 * @enabled: 1 = countermeasures enabled, 0 = disabled
2355 * Returns: 0 on success, -1 on failure
2357 * Configure TKIP countermeasures. When these are enabled, the driver
2358 * should drop all received and queued frames that are using TKIP.
2360 int (*set_countermeasures
)(void *priv
, int enabled
);
2363 * deauthenticate - Request driver to deauthenticate
2364 * @priv: private driver interface data
2365 * @addr: peer address (BSSID of the AP)
2366 * @reason_code: 16-bit reason code to be sent in the deauthentication
2369 * Returns: 0 on success, -1 on failure
2371 int (*deauthenticate
)(void *priv
, const u8
*addr
, u16 reason_code
);
2374 * associate - Request driver to associate
2375 * @priv: private driver interface data
2376 * @params: association parameters
2378 * Returns: 0 on success, -1 on failure
2380 int (*associate
)(void *priv
,
2381 struct wpa_driver_associate_params
*params
);
2384 * add_pmkid - Add PMKSA cache entry to the driver
2385 * @priv: private driver interface data
2386 * @params: PMKSA parameters
2388 * Returns: 0 on success, -1 on failure
2390 * This function is called when a new PMK is received, as a result of
2391 * either normal authentication or RSN pre-authentication. The PMKSA
2392 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2393 * ssid, fils_cache_id, pmkid, and pmk.
2395 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2396 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2397 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2398 * driver_ops function does not need to be implemented. Likewise, if
2399 * the driver does not support WPA, this function is not needed.
2401 int (*add_pmkid
)(void *priv
, struct wpa_pmkid_params
*params
);
2404 * remove_pmkid - Remove PMKSA cache entry to the driver
2405 * @priv: private driver interface data
2406 * @params: PMKSA parameters
2408 * Returns: 0 on success, -1 on failure
2410 * This function is called when the supplicant drops a PMKSA cache
2411 * entry for any reason. The PMKSA parameters are either a set of
2412 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
2414 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2415 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2416 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2417 * from wpa_supplicant, this driver_ops function does not need to be
2418 * implemented. Likewise, if the driver does not support WPA, this
2419 * function is not needed.
2421 int (*remove_pmkid
)(void *priv
, struct wpa_pmkid_params
*params
);
2424 * flush_pmkid - Flush PMKSA cache
2425 * @priv: private driver interface data
2427 * Returns: 0 on success, -1 on failure
2429 * This function is called when the supplicant drops all PMKSA cache
2430 * entries for any reason.
2432 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2433 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2434 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2435 * from wpa_supplicant, this driver_ops function does not need to be
2436 * implemented. Likewise, if the driver does not support WPA, this
2437 * function is not needed.
2439 int (*flush_pmkid
)(void *priv
);
2442 * get_capa - Get driver capabilities
2443 * @priv: private driver interface data
2445 * Returns: 0 on success, -1 on failure
2447 * Get driver/firmware/hardware capabilities.
2449 int (*get_capa
)(void *priv
, struct wpa_driver_capa
*capa
);
2452 * poll - Poll driver for association information
2453 * @priv: private driver interface data
2455 * This is an option callback that can be used when the driver does not
2456 * provide event mechanism for association events. This is called when
2457 * receiving WPA EAPOL-Key messages that require association
2458 * information. The driver interface is supposed to generate associnfo
2459 * event before returning from this callback function. In addition, the
2460 * driver interface should generate an association event after having
2461 * sent out associnfo.
2463 void (*poll
)(void *priv
);
2466 * get_ifindex - Get interface index
2467 * @priv: private driver interface data
2469 * Returns: Interface index
2471 unsigned int (*get_ifindex
)(void *priv
);
2474 * get_ifname - Get interface name
2475 * @priv: private driver interface data
2477 * Returns: Pointer to the interface name. This can differ from the
2478 * interface name used in init() call. Init() is called first.
2480 * This optional function can be used to allow the driver interface to
2481 * replace the interface name with something else, e.g., based on an
2482 * interface mapping from a more descriptive name.
2484 const char * (*get_ifname
)(void *priv
);
2487 * get_mac_addr - Get own MAC address
2488 * @priv: private driver interface data
2490 * Returns: Pointer to own MAC address or %NULL on failure
2492 * This optional function can be used to get the own MAC address of the
2493 * device from the driver interface code. This is only needed if the
2494 * l2_packet implementation for the OS does not provide easy access to
2496 const u8
* (*get_mac_addr
)(void *priv
);
2499 * set_operstate - Sets device operating state to DORMANT or UP
2500 * @priv: private driver interface data
2501 * @state: 0 = dormant, 1 = up
2502 * Returns: 0 on success, -1 on failure
2504 * This is an optional function that can be used on operating systems
2505 * that support a concept of controlling network device state from user
2506 * space applications. This function, if set, gets called with
2507 * state = 1 when authentication has been completed and with state = 0
2508 * when connection is lost.
2510 int (*set_operstate
)(void *priv
, int state
);
2513 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2514 * @priv: Private driver interface data
2515 * @addr: Address of the station for which to set protection (may be
2516 * %NULL for group keys)
2517 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2518 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2519 * Returns: 0 on success, -1 on failure
2521 * This is an optional function that can be used to set the driver to
2522 * require protection for Tx and/or Rx frames. This uses the layer
2523 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2524 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2525 * set protection operation; instead, they set protection implicitly
2526 * based on configured keys.
2528 int (*mlme_setprotection
)(void *priv
, const u8
*addr
, int protect_type
,
2532 * get_hw_feature_data - Get hardware support data (channels and rates)
2533 * @priv: Private driver interface data
2534 * @num_modes: Variable for returning the number of returned modes
2535 * flags: Variable for returning hardware feature flags
2536 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
2537 * Returns: Pointer to allocated hardware data on success or %NULL on
2538 * failure. Caller is responsible for freeing this.
2540 struct hostapd_hw_modes
* (*get_hw_feature_data
)(void *priv
,
2542 u16
*flags
, u8
*dfs
);
2545 * send_mlme - Send management frame from MLME
2546 * @priv: Private driver interface data
2547 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2548 * @data_len: Size of the management frame
2549 * @noack: Do not wait for this frame to be acked (disable retries)
2550 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2552 * @csa_offs: Array of CSA offsets or %NULL
2553 * @csa_offs_len: Number of elements in csa_offs
2554 * Returns: 0 on success, -1 on failure
2556 int (*send_mlme
)(void *priv
, const u8
*data
, size_t data_len
,
2557 int noack
, unsigned int freq
, const u16
*csa_offs
,
2558 size_t csa_offs_len
);
2561 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2562 * @priv: Private driver interface data
2563 * @md: Mobility domain (2 octets) (also included inside ies)
2564 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2565 * @ies_len: Length of FT IEs in bytes
2566 * Returns: 0 on success, -1 on failure
2568 * The supplicant uses this callback to let the driver know that keying
2569 * material for FT is available and that the driver can use the
2570 * provided IEs in the next message in FT authentication sequence.
2572 * This function is only needed for driver that support IEEE 802.11r
2573 * (Fast BSS Transition).
2575 int (*update_ft_ies
)(void *priv
, const u8
*md
, const u8
*ies
,
2579 * get_scan_results2 - Fetch the latest scan results
2580 * @priv: private driver interface data
2582 * Returns: Allocated buffer of scan results (caller is responsible for
2583 * freeing the data structure) on success, NULL on failure
2585 struct wpa_scan_results
* (*get_scan_results2
)(void *priv
);
2588 * set_country - Set country
2589 * @priv: Private driver interface data
2590 * @alpha2: country to which to switch to
2591 * Returns: 0 on success, -1 on failure
2593 * This function is for drivers which support some form
2594 * of setting a regulatory domain.
2596 int (*set_country
)(void *priv
, const char *alpha2
);
2599 * get_country - Get country
2600 * @priv: Private driver interface data
2601 * @alpha2: Buffer for returning country code (at least 3 octets)
2602 * Returns: 0 on success, -1 on failure
2604 int (*get_country
)(void *priv
, char *alpha2
);
2607 * global_init - Global driver initialization
2608 * @ctx: wpa_global pointer
2609 * Returns: Pointer to private data (global), %NULL on failure
2611 * This optional function is called to initialize the driver wrapper
2612 * for global data, i.e., data that applies to all interfaces. If this
2613 * function is implemented, global_deinit() will also need to be
2614 * implemented to free the private data. The driver will also likely
2615 * use init2() function instead of init() to get the pointer to global
2616 * data available to per-interface initializer.
2618 void * (*global_init
)(void *ctx
);
2621 * global_deinit - Global driver deinitialization
2622 * @priv: private driver global data from global_init()
2624 * Terminate any global driver related functionality and free the
2625 * global data structure.
2627 void (*global_deinit
)(void *priv
);
2630 * init2 - Initialize driver interface (with global data)
2631 * @ctx: context to be used when calling wpa_supplicant functions,
2632 * e.g., wpa_supplicant_event()
2633 * @ifname: interface name, e.g., wlan0
2634 * @global_priv: private driver global data from global_init()
2635 * Returns: Pointer to private data, %NULL on failure
2637 * This function can be used instead of init() if the driver wrapper
2640 void * (*init2
)(void *ctx
, const char *ifname
, void *global_priv
);
2643 * get_interfaces - Get information about available interfaces
2644 * @global_priv: private driver global data from global_init()
2645 * Returns: Allocated buffer of interface information (caller is
2646 * responsible for freeing the data structure) on success, NULL on
2649 struct wpa_interface_info
* (*get_interfaces
)(void *global_priv
);
2652 * scan2 - Request the driver to initiate scan
2653 * @priv: private driver interface data
2654 * @params: Scan parameters
2656 * Returns: 0 on success, -1 on failure
2658 * Once the scan results are ready, the driver should report scan
2659 * results event for wpa_supplicant which will eventually request the
2660 * results with wpa_driver_get_scan_results2().
2662 int (*scan2
)(void *priv
, struct wpa_driver_scan_params
*params
);
2665 * authenticate - Request driver to authenticate
2666 * @priv: private driver interface data
2667 * @params: authentication parameters
2668 * Returns: 0 on success, -1 on failure
2670 * This is an optional function that can be used with drivers that
2671 * support separate authentication and association steps, i.e., when
2672 * wpa_supplicant can act as the SME. If not implemented, associate()
2673 * function is expected to take care of IEEE 802.11 authentication,
2676 int (*authenticate
)(void *priv
,
2677 struct wpa_driver_auth_params
*params
);
2680 * set_ap - Set Beacon and Probe Response information for AP mode
2681 * @priv: Private driver interface data
2682 * @params: Parameters to use in AP mode
2684 * This function is used to configure Beacon template and/or extra IEs
2685 * to add for Beacon and Probe Response frames for the driver in
2686 * AP mode. The driver is responsible for building the full Beacon
2687 * frame by concatenating the head part with TIM IE generated by the
2688 * driver/firmware and finishing with the tail part. Depending on the
2689 * driver architectue, this can be done either by using the full
2690 * template or the set of additional IEs (e.g., WPS and P2P IE).
2691 * Similarly, Probe Response processing depends on the driver design.
2692 * If the driver (or firmware) takes care of replying to Probe Request
2693 * frames, the extra IEs provided here needs to be added to the Probe
2696 * Returns: 0 on success, -1 on failure
2698 int (*set_ap
)(void *priv
, struct wpa_driver_ap_params
*params
);
2701 * set_acl - Set ACL in AP mode
2702 * @priv: Private driver interface data
2703 * @params: Parameters to configure ACL
2704 * Returns: 0 on success, -1 on failure
2706 * This is used only for the drivers which support MAC address ACL.
2708 int (*set_acl
)(void *priv
, struct hostapd_acl_params
*params
);
2711 * hapd_init - Initialize driver interface (hostapd only)
2712 * @hapd: Pointer to hostapd context
2713 * @params: Configuration for the driver wrapper
2714 * Returns: Pointer to private data, %NULL on failure
2716 * This function is used instead of init() or init2() when the driver
2717 * wrapper is used with hostapd.
2719 void * (*hapd_init
)(struct hostapd_data
*hapd
,
2720 struct wpa_init_params
*params
);
2723 * hapd_deinit - Deinitialize driver interface (hostapd only)
2724 * @priv: Private driver interface data from hapd_init()
2726 void (*hapd_deinit
)(void *priv
);
2729 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2730 * @priv: Private driver interface data
2731 * @params: BSS parameters
2732 * Returns: 0 on success, -1 on failure
2734 * This is an optional function to configure the kernel driver to
2735 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2736 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2737 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2738 * for Beacon frames.
2740 * DEPRECATED - use set_ap() instead
2742 int (*set_ieee8021x
)(void *priv
, struct wpa_bss_params
*params
);
2745 * set_privacy - Enable/disable privacy (AP only)
2746 * @priv: Private driver interface data
2747 * @enabled: 1 = privacy enabled, 0 = disabled
2748 * Returns: 0 on success, -1 on failure
2750 * This is an optional function to configure privacy field in the
2751 * kernel driver for Beacon frames. This can be left undefined (set to
2752 * %NULL) if the driver uses the Beacon template from set_ap().
2754 * DEPRECATED - use set_ap() instead
2756 int (*set_privacy
)(void *priv
, int enabled
);
2759 * get_seqnum - Fetch the current TSC/packet number (AP only)
2760 * @ifname: The interface name (main or virtual)
2761 * @priv: Private driver interface data
2762 * @addr: MAC address of the station or %NULL for group keys
2764 * @seq: Buffer for returning the latest used TSC/packet number
2765 * Returns: 0 on success, -1 on failure
2767 * This function is used to fetch the last used TSC/packet number for
2768 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2769 * keys, so there is no strict requirement on implementing support for
2770 * unicast keys (i.e., addr != %NULL).
2772 int (*get_seqnum
)(const char *ifname
, void *priv
, const u8
*addr
,
2776 * flush - Flush all association stations (AP only)
2777 * @priv: Private driver interface data
2778 * Returns: 0 on success, -1 on failure
2780 * This function requests the driver to disassociate all associated
2781 * stations. This function does not need to be implemented if the
2782 * driver does not process association frames internally.
2784 int (*flush
)(void *priv
);
2787 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2788 * @priv: Private driver interface data
2789 * @elem: Information elements
2790 * @elem_len: Length of the elem buffer in octets
2791 * Returns: 0 on success, -1 on failure
2793 * This is an optional function to add information elements in the
2794 * kernel driver for Beacon and Probe Response frames. This can be left
2795 * undefined (set to %NULL) if the driver uses the Beacon template from
2798 * DEPRECATED - use set_ap() instead
2800 int (*set_generic_elem
)(void *priv
, const u8
*elem
, size_t elem_len
);
2803 * read_sta_data - Fetch station data
2804 * @priv: Private driver interface data
2805 * @data: Buffer for returning station information
2806 * @addr: MAC address of the station
2807 * Returns: 0 on success, -1 on failure
2809 int (*read_sta_data
)(void *priv
, struct hostap_sta_driver_data
*data
,
2813 * hapd_send_eapol - Send an EAPOL packet (AP only)
2814 * @priv: private driver interface data
2815 * @addr: Destination MAC address
2816 * @data: EAPOL packet starting with IEEE 802.1X header
2817 * @data_len: Length of the EAPOL packet in octets
2818 * @encrypt: Whether the frame should be encrypted
2819 * @own_addr: Source MAC address
2820 * @flags: WPA_STA_* flags for the destination station
2822 * Returns: 0 on success, -1 on failure
2824 int (*hapd_send_eapol
)(void *priv
, const u8
*addr
, const u8
*data
,
2825 size_t data_len
, int encrypt
,
2826 const u8
*own_addr
, u32 flags
);
2829 * sta_deauth - Deauthenticate a station (AP only)
2830 * @priv: Private driver interface data
2831 * @own_addr: Source address and BSSID for the Deauthentication frame
2832 * @addr: MAC address of the station to deauthenticate
2833 * @reason: Reason code for the Deauthentiation frame
2834 * Returns: 0 on success, -1 on failure
2836 * This function requests a specific station to be deauthenticated and
2837 * a Deauthentication frame to be sent to it.
2839 int (*sta_deauth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2843 * sta_disassoc - Disassociate a station (AP only)
2844 * @priv: Private driver interface data
2845 * @own_addr: Source address and BSSID for the Disassociation frame
2846 * @addr: MAC address of the station to disassociate
2847 * @reason: Reason code for the Disassociation frame
2848 * Returns: 0 on success, -1 on failure
2850 * This function requests a specific station to be disassociated and
2851 * a Disassociation frame to be sent to it.
2853 int (*sta_disassoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2857 * sta_remove - Remove a station entry (AP only)
2858 * @priv: Private driver interface data
2859 * @addr: MAC address of the station to be removed
2860 * Returns: 0 on success, -1 on failure
2862 int (*sta_remove
)(void *priv
, const u8
*addr
);
2865 * hapd_get_ssid - Get the current SSID (AP only)
2866 * @priv: Private driver interface data
2867 * @buf: Buffer for returning the SSID
2868 * @len: Maximum length of the buffer
2869 * Returns: Length of the SSID on success, -1 on failure
2871 * This function need not be implemented if the driver uses Beacon
2872 * template from set_ap() and does not reply to Probe Request frames.
2874 int (*hapd_get_ssid
)(void *priv
, u8
*buf
, int len
);
2877 * hapd_set_ssid - Set SSID (AP only)
2878 * @priv: Private driver interface data
2880 * @len: Length of the SSID in octets
2881 * Returns: 0 on success, -1 on failure
2883 * DEPRECATED - use set_ap() instead
2885 int (*hapd_set_ssid
)(void *priv
, const u8
*buf
, int len
);
2888 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2889 * @priv: Private driver interface data
2890 * @enabled: 1 = countermeasures enabled, 0 = disabled
2891 * Returns: 0 on success, -1 on failure
2893 * This need not be implemented if the driver does not take care of
2894 * association processing.
2896 int (*hapd_set_countermeasures
)(void *priv
, int enabled
);
2899 * sta_add - Add a station entry
2900 * @priv: Private driver interface data
2901 * @params: Station parameters
2902 * Returns: 0 on success, -1 on failure
2904 * This function is used to add or set (params->set 1) a station
2905 * entry in the driver. Adding STA entries is used only if the driver
2906 * does not take care of association processing.
2908 * With drivers that don't support full AP client state, this function
2909 * is used to add a station entry to the driver once the station has
2910 * completed association.
2912 * With TDLS, this function is used to add or set (params->set 1)
2913 * TDLS peer entries (even with drivers that do not support full AP
2916 int (*sta_add
)(void *priv
, struct hostapd_sta_add_params
*params
);
2919 * get_inact_sec - Get station inactivity duration (AP only)
2920 * @priv: Private driver interface data
2921 * @addr: Station address
2922 * Returns: Number of seconds station has been inactive, -1 on failure
2924 int (*get_inact_sec
)(void *priv
, const u8
*addr
);
2927 * sta_clear_stats - Clear station statistics (AP only)
2928 * @priv: Private driver interface data
2929 * @addr: Station address
2930 * Returns: 0 on success, -1 on failure
2932 int (*sta_clear_stats
)(void *priv
, const u8
*addr
);
2935 * set_freq - Set channel/frequency (AP only)
2936 * @priv: Private driver interface data
2937 * @freq: Channel parameters
2938 * Returns: 0 on success, -1 on failure
2940 int (*set_freq
)(void *priv
, struct hostapd_freq_params
*freq
);
2943 * set_rts - Set RTS threshold
2944 * @priv: Private driver interface data
2945 * @rts: RTS threshold in octets
2946 * Returns: 0 on success, -1 on failure
2948 int (*set_rts
)(void *priv
, int rts
);
2951 * set_frag - Set fragmentation threshold
2952 * @priv: Private driver interface data
2953 * @frag: Fragmentation threshold in octets
2954 * Returns: 0 on success, -1 on failure
2956 int (*set_frag
)(void *priv
, int frag
);
2959 * sta_set_flags - Set station flags (AP only)
2960 * @priv: Private driver interface data
2961 * @addr: Station address
2962 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2963 * @flags_or: Bitmap of WPA_STA_* flags to add
2964 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2965 * Returns: 0 on success, -1 on failure
2967 int (*sta_set_flags
)(void *priv
, const u8
*addr
,
2968 unsigned int total_flags
, unsigned int flags_or
,
2969 unsigned int flags_and
);
2972 * sta_set_airtime_weight - Set station airtime weight (AP only)
2973 * @priv: Private driver interface data
2974 * @addr: Station address
2975 * @weight: New weight for station airtime assignment
2976 * Returns: 0 on success, -1 on failure
2978 int (*sta_set_airtime_weight
)(void *priv
, const u8
*addr
,
2979 unsigned int weight
);
2982 * set_tx_queue_params - Set TX queue parameters
2983 * @priv: Private driver interface data
2984 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2988 * @burst_time: Maximum length for bursting in 0.1 msec units
2990 int (*set_tx_queue_params
)(void *priv
, int queue
, int aifs
, int cw_min
,
2991 int cw_max
, int burst_time
);
2994 * if_add - Add a virtual interface
2995 * @priv: Private driver interface data
2996 * @type: Interface type
2997 * @ifname: Interface name for the new virtual interface
2998 * @addr: Local address to use for the interface or %NULL to use the
2999 * parent interface address
3000 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
3001 * @drv_priv: Pointer for overwriting the driver context or %NULL if
3002 * not allowed (applies only to %WPA_IF_AP_BSS type)
3003 * @force_ifname: Buffer for returning an interface name that the
3004 * driver ended up using if it differs from the requested ifname
3005 * @if_addr: Buffer for returning the allocated interface address
3006 * (this may differ from the requested addr if the driver cannot
3007 * change interface address)
3008 * @bridge: Bridge interface to use or %NULL if no bridge configured
3009 * @use_existing: Whether to allow existing interface to be used
3010 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
3011 * Returns: 0 on success, -1 on failure
3013 int (*if_add
)(void *priv
, enum wpa_driver_if_type type
,
3014 const char *ifname
, const u8
*addr
, void *bss_ctx
,
3015 void **drv_priv
, char *force_ifname
, u8
*if_addr
,
3016 const char *bridge
, int use_existing
, int setup_ap
);
3019 * if_remove - Remove a virtual interface
3020 * @priv: Private driver interface data
3021 * @type: Interface type
3022 * @ifname: Interface name of the virtual interface to be removed
3023 * Returns: 0 on success, -1 on failure
3025 int (*if_remove
)(void *priv
, enum wpa_driver_if_type type
,
3026 const char *ifname
);
3029 * set_sta_vlan - Bind a station into a specific interface (AP only)
3030 * @priv: Private driver interface data
3031 * @ifname: Interface (main or virtual BSS or VLAN)
3032 * @addr: MAC address of the associated station
3034 * Returns: 0 on success, -1 on failure
3036 * This function is used to bind a station to a specific virtual
3037 * interface. It is only used if when virtual interfaces are supported,
3038 * e.g., to assign stations to different VLAN interfaces based on
3039 * information from a RADIUS server. This allows separate broadcast
3040 * domains to be used with a single BSS.
3042 int (*set_sta_vlan
)(void *priv
, const u8
*addr
, const char *ifname
,
3046 * commit - Optional commit changes handler (AP only)
3047 * @priv: driver private data
3048 * Returns: 0 on success, -1 on failure
3050 * This optional handler function can be registered if the driver
3051 * interface implementation needs to commit changes (e.g., by setting
3052 * network interface up) at the end of initial configuration. If set,
3053 * this handler will be called after initial setup has been completed.
3055 int (*commit
)(void *priv
);
3058 * send_ether - Send an ethernet packet (AP only)
3059 * @priv: private driver interface data
3060 * @dst: Destination MAC address
3061 * @src: Source MAC address
3063 * @data: EAPOL packet starting with IEEE 802.1X header
3064 * @data_len: Length of the EAPOL packet in octets
3065 * Returns: 0 on success, -1 on failure
3067 int (*send_ether
)(void *priv
, const u8
*dst
, const u8
*src
, u16 proto
,
3068 const u8
*data
, size_t data_len
);
3071 * set_radius_acl_auth - Notification of RADIUS ACL change
3072 * @priv: Private driver interface data
3073 * @mac: MAC address of the station
3074 * @accepted: Whether the station was accepted
3075 * @session_timeout: Session timeout for the station
3076 * Returns: 0 on success, -1 on failure
3078 int (*set_radius_acl_auth
)(void *priv
, const u8
*mac
, int accepted
,
3079 u32 session_timeout
);
3082 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3083 * @priv: Private driver interface data
3084 * @mac: MAC address of the station
3085 * Returns: 0 on success, -1 on failure
3087 int (*set_radius_acl_expire
)(void *priv
, const u8
*mac
);
3090 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
3091 * @priv: Private driver interface data
3092 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3093 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3095 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3096 * to remove extra IE(s)
3097 * Returns: 0 on success, -1 on failure
3099 * This is an optional function to add WPS IE in the kernel driver for
3100 * Beacon and Probe Response frames. This can be left undefined (set
3101 * to %NULL) if the driver uses the Beacon template from set_ap()
3102 * and does not process Probe Request frames. If the driver takes care
3103 * of (Re)Association frame processing, the assocresp buffer includes
3104 * WPS IE(s) that need to be added to (Re)Association Response frames
3105 * whenever a (Re)Association Request frame indicated use of WPS.
3107 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3108 * frames when operating as a GO. The driver is responsible for adding
3109 * timing related attributes (e.g., NoA) in addition to the IEs
3110 * included here by appending them after these buffers. This call is
3111 * also used to provide Probe Response IEs for P2P Listen state
3112 * operations for drivers that generate the Probe Response frames
3115 * DEPRECATED - use set_ap() instead
3117 int (*set_ap_wps_ie
)(void *priv
, const struct wpabuf
*beacon
,
3118 const struct wpabuf
*proberesp
,
3119 const struct wpabuf
*assocresp
);
3122 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3123 * @priv: Private driver interface data
3124 * @authorized: Whether the port is authorized
3125 * Returns: 0 on success, -1 on failure
3127 int (*set_supp_port
)(void *priv
, int authorized
);
3130 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3131 * @priv: Private driver interface data
3132 * @addr: MAC address of the associated station
3133 * @aid: Association ID
3134 * @val: 1 = bind to 4-address WDS; 0 = unbind
3135 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3136 * to indicate that bridge is not to be used
3137 * @ifname_wds: Buffer to return the interface name for the new WDS
3138 * station or %NULL to indicate name is not returned.
3139 * Returns: 0 on success, -1 on failure
3141 int (*set_wds_sta
)(void *priv
, const u8
*addr
, int aid
, int val
,
3142 const char *bridge_ifname
, char *ifname_wds
);
3145 * send_action - Transmit an Action frame
3146 * @priv: Private driver interface data
3147 * @freq: Frequency (in MHz) of the channel
3148 * @wait: Time to wait off-channel for a response (in ms), or zero
3149 * @dst: Destination MAC address (Address 1)
3150 * @src: Source MAC address (Address 2)
3151 * @bssid: BSSID (Address 3)
3153 * @data_len: data length in octets
3154 @ @no_cck: Whether CCK rates must not be used to transmit this frame
3155 * Returns: 0 on success, -1 on failure
3157 * This command can be used to request the driver to transmit an action
3158 * frame to the specified destination.
3160 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3161 * be transmitted on the given channel and the device will wait for a
3162 * response on that channel for the given wait time.
3164 * If the flag is not set, the wait time will be ignored. In this case,
3165 * if a remain-on-channel duration is in progress, the frame must be
3166 * transmitted on that channel; alternatively the frame may be sent on
3167 * the current operational channel (if in associated state in station
3168 * mode or while operating as an AP.)
3170 * If @src differs from the device MAC address, use of a random
3171 * transmitter address is requested for this message exchange.
3173 int (*send_action
)(void *priv
, unsigned int freq
, unsigned int wait
,
3174 const u8
*dst
, const u8
*src
, const u8
*bssid
,
3175 const u8
*data
, size_t data_len
, int no_cck
);
3178 * send_action_cancel_wait - Cancel action frame TX wait
3179 * @priv: Private driver interface data
3181 * This command cancels the wait time associated with sending an action
3182 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3183 * set in the driver flags.
3185 void (*send_action_cancel_wait
)(void *priv
);
3188 * remain_on_channel - Remain awake on a channel
3189 * @priv: Private driver interface data
3190 * @freq: Frequency (in MHz) of the channel
3191 * @duration: Duration in milliseconds
3192 * Returns: 0 on success, -1 on failure
3194 * This command is used to request the driver to remain awake on the
3195 * specified channel for the specified duration and report received
3196 * Action frames with EVENT_RX_MGMT events. Optionally, received
3197 * Probe Request frames may also be requested to be reported by calling
3198 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3200 * The driver may not be at the requested channel when this function
3201 * returns, i.e., the return code is only indicating whether the
3202 * request was accepted. The caller will need to wait until the
3203 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3204 * completed the channel change. This may take some time due to other
3205 * need for the radio and the caller should be prepared to timing out
3206 * its wait since there are no guarantees on when this request can be
3209 int (*remain_on_channel
)(void *priv
, unsigned int freq
,
3210 unsigned int duration
);
3213 * cancel_remain_on_channel - Cancel remain-on-channel operation
3214 * @priv: Private driver interface data
3216 * This command can be used to cancel a remain-on-channel operation
3217 * before its originally requested duration has passed. This could be
3218 * used, e.g., when remain_on_channel() is used to request extra time
3219 * to receive a response to an Action frame and the response is
3220 * received when there is still unneeded time remaining on the
3221 * remain-on-channel operation.
3223 int (*cancel_remain_on_channel
)(void *priv
);
3226 * probe_req_report - Request Probe Request frames to be indicated
3227 * @priv: Private driver interface data
3228 * @report: Whether to report received Probe Request frames
3229 * Returns: 0 on success, -1 on failure (or if not supported)
3231 * This command can be used to request the driver to indicate when
3232 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3233 * Since this operation may require extra resources, e.g., due to less
3234 * optimal hardware/firmware RX filtering, many drivers may disable
3235 * Probe Request reporting at least in station mode. This command is
3236 * used to notify the driver when the Probe Request frames need to be
3237 * reported, e.g., during remain-on-channel operations.
3239 int (*probe_req_report
)(void *priv
, int report
);
3242 * deinit_ap - Deinitialize AP mode
3243 * @priv: Private driver interface data
3244 * Returns: 0 on success, -1 on failure (or if not supported)
3246 * This optional function can be used to disable AP mode related
3247 * configuration. If the interface was not dynamically added,
3248 * change the driver mode to station mode to allow normal station
3249 * operations like scanning to be completed.
3251 int (*deinit_ap
)(void *priv
);
3254 * deinit_p2p_cli - Deinitialize P2P client mode
3255 * @priv: Private driver interface data
3256 * Returns: 0 on success, -1 on failure (or if not supported)
3258 * This optional function can be used to disable P2P client mode. If the
3259 * interface was not dynamically added, change the interface type back
3262 int (*deinit_p2p_cli
)(void *priv
);
3265 * suspend - Notification on system suspend/hibernate event
3266 * @priv: Private driver interface data
3268 void (*suspend
)(void *priv
);
3271 * resume - Notification on system resume/thaw event
3272 * @priv: Private driver interface data
3274 void (*resume
)(void *priv
);
3277 * signal_monitor - Set signal monitoring parameters
3278 * @priv: Private driver interface data
3279 * @threshold: Threshold value for signal change events; 0 = disabled
3280 * @hysteresis: Minimum change in signal strength before indicating a
3282 * Returns: 0 on success, -1 on failure (or if not supported)
3284 * This function can be used to configure monitoring of signal strength
3285 * with the current AP. Whenever signal strength drops below the
3286 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3287 * should be generated assuming the signal strength has changed at
3288 * least %hysteresis from the previously indicated signal change event.
3290 int (*signal_monitor
)(void *priv
, int threshold
, int hysteresis
);
3293 * send_frame - Send IEEE 802.11 frame (testing use only)
3294 * @priv: Private driver interface data
3295 * @data: IEEE 802.11 frame with IEEE 802.11 header
3296 * @data_len: Size of the frame
3297 * @encrypt: Whether to encrypt the frame (if keys are set)
3298 * Returns: 0 on success, -1 on failure
3300 * This function is only used for debugging purposes and is not
3301 * required to be implemented for normal operations.
3303 int (*send_frame
)(void *priv
, const u8
*data
, size_t data_len
,
3307 * get_noa - Get current Notice of Absence attribute payload
3308 * @priv: Private driver interface data
3309 * @buf: Buffer for returning NoA
3310 * @buf_len: Buffer length in octets
3311 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3312 * advertized, or -1 on failure
3314 * This function is used to fetch the current Notice of Absence
3315 * attribute value from GO.
3317 int (*get_noa
)(void *priv
, u8
*buf
, size_t buf_len
);
3320 * set_noa - Set Notice of Absence parameters for GO (testing)
3321 * @priv: Private driver interface data
3323 * @start: Start time in ms from next TBTT
3324 * @duration: Duration in ms
3325 * Returns: 0 on success or -1 on failure
3327 * This function is used to set Notice of Absence parameters for GO. It
3328 * is used only for testing. To disable NoA, all parameters are set to
3331 int (*set_noa
)(void *priv
, u8 count
, int start
, int duration
);
3334 * set_p2p_powersave - Set P2P power save options
3335 * @priv: Private driver interface data
3336 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3337 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3338 * @ctwindow: 0.. = change (msec), -1 = no change
3339 * Returns: 0 on success or -1 on failure
3341 int (*set_p2p_powersave
)(void *priv
, int legacy_ps
, int opp_ps
,
3345 * ampdu - Enable/disable aggregation
3346 * @priv: Private driver interface data
3347 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3348 * Returns: 0 on success or -1 on failure
3350 int (*ampdu
)(void *priv
, int ampdu
);
3353 * get_radio_name - Get physical radio name for the device
3354 * @priv: Private driver interface data
3355 * Returns: Radio name or %NULL if not known
3357 * The returned data must not be modified by the caller. It is assumed
3358 * that any interface that has the same radio name as another is
3359 * sharing the same physical radio. This information can be used to
3360 * share scan results etc. information between the virtual interfaces
3361 * to speed up various operations.
3363 const char * (*get_radio_name
)(void *priv
);
3366 * send_tdls_mgmt - for sending TDLS management packets
3367 * @priv: private driver interface data
3368 * @dst: Destination (peer) MAC address
3369 * @action_code: TDLS action code for the mssage
3370 * @dialog_token: Dialog Token to use in the message (if needed)
3371 * @status_code: Status Code or Reason Code to use (if needed)
3372 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
3373 * @initiator: Is the current end the TDLS link initiator
3374 * @buf: TDLS IEs to add to the message
3375 * @len: Length of buf in octets
3376 * Returns: 0 on success, negative (<0) on failure
3378 * This optional function can be used to send packet to driver which is
3379 * responsible for receiving and sending all TDLS packets.
3381 int (*send_tdls_mgmt
)(void *priv
, const u8
*dst
, u8 action_code
,
3382 u8 dialog_token
, u16 status_code
, u32 peer_capab
,
3383 int initiator
, const u8
*buf
, size_t len
);
3386 * tdls_oper - Ask the driver to perform high-level TDLS operations
3387 * @priv: Private driver interface data
3388 * @oper: TDLS high-level operation. See %enum tdls_oper
3389 * @peer: Destination (peer) MAC address
3390 * Returns: 0 on success, negative (<0) on failure
3392 * This optional function can be used to send high-level TDLS commands
3395 int (*tdls_oper
)(void *priv
, enum tdls_oper oper
, const u8
*peer
);
3398 * wnm_oper - Notify driver of the WNM frame reception
3399 * @priv: Private driver interface data
3400 * @oper: WNM operation. See %enum wnm_oper
3401 * @peer: Destination (peer) MAC address
3402 * @buf: Buffer for the driver to fill in (for getting IE)
3403 * @buf_len: Return the len of buf
3404 * Returns: 0 on success, negative (<0) on failure
3406 int (*wnm_oper
)(void *priv
, enum wnm_oper oper
, const u8
*peer
,
3407 u8
*buf
, u16
*buf_len
);
3410 * set_qos_map - Set QoS Map
3411 * @priv: Private driver interface data
3412 * @qos_map_set: QoS Map
3413 * @qos_map_set_len: Length of QoS Map
3415 int (*set_qos_map
)(void *priv
, const u8
*qos_map_set
,
3416 u8 qos_map_set_len
);
3419 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3420 * @priv: Private driver interface data
3421 * @version: IP version of the IP address, 4 or 6
3422 * @ipaddr: IP address for the neigh entry
3423 * @prefixlen: IP address prefix length
3424 * @addr: Corresponding MAC address
3425 * Returns: 0 on success, negative (<0) on failure
3427 int (*br_add_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
,
3428 int prefixlen
, const u8
*addr
);
3431 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3432 * @priv: Private driver interface data
3433 * @version: IP version of the IP address, 4 or 6
3434 * @ipaddr: IP address for the neigh entry
3435 * Returns: 0 on success, negative (<0) on failure
3437 int (*br_delete_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
);
3440 * br_port_set_attr - Set a bridge port attribute
3441 * @attr: Bridge port attribute to set
3442 * @val: Value to be set
3443 * Returns: 0 on success, negative (<0) on failure
3445 int (*br_port_set_attr
)(void *priv
, enum drv_br_port_attr attr
,
3449 * br_port_set_attr - Set a bridge network parameter
3450 * @param: Bridge parameter to set
3451 * @val: Value to be set
3452 * Returns: 0 on success, negative (<0) on failure
3454 int (*br_set_net_param
)(void *priv
, enum drv_br_net_param param
,
3458 * set_wowlan - Set wake-on-wireless triggers
3459 * @priv: Private driver interface data
3460 * @triggers: wowlan triggers
3462 int (*set_wowlan
)(void *priv
, const struct wowlan_triggers
*triggers
);
3465 * signal_poll - Get current connection information
3466 * @priv: Private driver interface data
3467 * @signal_info: Connection info structure
3469 int (*signal_poll
)(void *priv
, struct wpa_signal_info
*signal_info
);
3472 * channel_info - Get parameters of the current operating channel
3473 * @priv: Private driver interface data
3474 * @channel_info: Channel info structure
3475 * Returns: 0 on success, negative (<0) on failure
3477 int (*channel_info
)(void *priv
, struct wpa_channel_info
*channel_info
);
3480 * set_authmode - Set authentication algorithm(s) for static WEP
3481 * @priv: Private driver interface data
3482 * @authmode: 1=Open System, 2=Shared Key, 3=both
3483 * Returns: 0 on success, -1 on failure
3485 * This function can be used to set authentication algorithms for AP
3486 * mode when static WEP is used. If the driver uses user space MLME/SME
3487 * implementation, there is no need to implement this function.
3489 * DEPRECATED - use set_ap() instead
3491 int (*set_authmode
)(void *priv
, int authmode
);
3495 * driver_cmd - Execute driver-specific command
3496 * @priv: Private driver interface data
3497 * @cmd: Command to execute
3498 * @buf: Return buffer
3499 * @buf_len: Buffer length
3500 * Returns: 0 on success, -1 on failure
3502 int (*driver_cmd
)(void *priv
, char *cmd
, char *buf
, size_t buf_len
);
3503 #endif /* ANDROID */
3506 * vendor_cmd - Execute vendor specific command
3507 * @priv: Private driver interface data
3508 * @vendor_id: Vendor id
3509 * @subcmd: Vendor command id
3510 * @data: Vendor command parameters (%NULL if no parameters)
3511 * @data_len: Data length
3512 * @buf: Return buffer (%NULL to ignore reply)
3513 * Returns: 0 on success, negative (<0) on failure
3515 * This function handles vendor specific commands that are passed to
3516 * the driver/device. The command is identified by vendor id and
3517 * command id. Parameters can be passed as argument to the command
3518 * in the data buffer. Reply (if any) will be filled in the supplied
3521 * The exact driver behavior is driver interface and vendor specific. As
3522 * an example, this will be converted to a vendor specific cfg80211
3523 * command in case of the nl80211 driver interface.
3525 int (*vendor_cmd
)(void *priv
, unsigned int vendor_id
,
3526 unsigned int subcmd
, const u8
*data
, size_t data_len
,
3527 struct wpabuf
*buf
);
3530 * set_rekey_info - Set rekey information
3531 * @priv: Private driver interface data
3533 * @kek_len: KEK length in octets
3535 * @kck_len: KCK length in octets
3536 * @replay_ctr: Current EAPOL-Key Replay Counter
3538 * This optional function can be used to provide information for the
3539 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3540 * while the host (including wpa_supplicant) is sleeping.
3542 void (*set_rekey_info
)(void *priv
, const u8
*kek
, size_t kek_len
,
3543 const u8
*kck
, size_t kck_len
,
3544 const u8
*replay_ctr
);
3547 * sta_assoc - Station association indication
3548 * @priv: Private driver interface data
3549 * @own_addr: Source address and BSSID for association frame
3550 * @addr: MAC address of the station to associate
3551 * @reassoc: flag to indicate re-association
3552 * @status: association response status code
3553 * @ie: assoc response ie buffer
3554 * @len: ie buffer length
3555 * Returns: 0 on success, -1 on failure
3557 * This function indicates the driver to send (Re)Association
3558 * Response frame to the station.
3560 int (*sta_assoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
3561 int reassoc
, u16 status
, const u8
*ie
, size_t len
);
3564 * sta_auth - Station authentication indication
3565 * @priv: private driver interface data
3566 * @params: Station authentication parameters
3568 * Returns: 0 on success, -1 on failure
3570 int (*sta_auth
)(void *priv
,
3571 struct wpa_driver_sta_auth_params
*params
);
3574 * add_tspec - Add traffic stream
3575 * @priv: Private driver interface data
3576 * @addr: MAC address of the station to associate
3577 * @tspec_ie: tspec ie buffer
3578 * @tspec_ielen: tspec ie length
3579 * Returns: 0 on success, -1 on failure
3581 * This function adds the traffic steam for the station
3582 * and fills the medium_time in tspec_ie.
3584 int (*add_tspec
)(void *priv
, const u8
*addr
, u8
*tspec_ie
,
3585 size_t tspec_ielen
);
3588 * add_sta_node - Add a station node in the driver
3589 * @priv: Private driver interface data
3590 * @addr: MAC address of the station to add
3591 * @auth_alg: authentication algorithm used by the station
3592 * Returns: 0 on success, -1 on failure
3594 * This function adds the station node in the driver, when
3595 * the station gets added by FT-over-DS.
3597 int (*add_sta_node
)(void *priv
, const u8
*addr
, u16 auth_alg
);
3600 * sched_scan - Request the driver to initiate scheduled scan
3601 * @priv: Private driver interface data
3602 * @params: Scan parameters
3603 * Returns: 0 on success, -1 on failure
3605 * This operation should be used for scheduled scan offload to
3606 * the hardware. Every time scan results are available, the
3607 * driver should report scan results event for wpa_supplicant
3608 * which will eventually request the results with
3609 * wpa_driver_get_scan_results2(). This operation is optional
3610 * and if not provided or if it returns -1, we fall back to
3611 * normal host-scheduled scans.
3613 int (*sched_scan
)(void *priv
, struct wpa_driver_scan_params
*params
);
3616 * stop_sched_scan - Request the driver to stop a scheduled scan
3617 * @priv: Private driver interface data
3618 * Returns: 0 on success, -1 on failure
3620 * This should cause the scheduled scan to be stopped and
3621 * results should stop being sent. Must be supported if
3622 * sched_scan is supported.
3624 int (*stop_sched_scan
)(void *priv
);
3627 * poll_client - Probe (null data or such) the given station
3628 * @priv: Private driver interface data
3629 * @own_addr: MAC address of sending interface
3630 * @addr: MAC address of the station to probe
3631 * @qos: Indicates whether station is QoS station
3633 * This function is used to verify whether an associated station is
3634 * still present. This function does not need to be implemented if the
3635 * driver provides such inactivity polling mechanism.
3637 void (*poll_client
)(void *priv
, const u8
*own_addr
,
3638 const u8
*addr
, int qos
);
3641 * radio_disable - Disable/enable radio
3642 * @priv: Private driver interface data
3643 * @disabled: 1=disable 0=enable radio
3644 * Returns: 0 on success, -1 on failure
3646 * This optional command is for testing purposes. It can be used to
3647 * disable the radio on a testbed device to simulate out-of-radio-range
3650 int (*radio_disable
)(void *priv
, int disabled
);
3653 * switch_channel - Announce channel switch and migrate the GO to the
3655 * @priv: Private driver interface data
3656 * @settings: Settings for CSA period and new channel
3657 * Returns: 0 on success, -1 on failure
3659 * This function is used to move the GO to the legacy STA channel to
3660 * avoid frequency conflict in single channel concurrency.
3662 int (*switch_channel
)(void *priv
, struct csa_settings
*settings
);
3665 * add_tx_ts - Add traffic stream
3666 * @priv: Private driver interface data
3667 * @tsid: Traffic stream ID
3668 * @addr: Receiver address
3669 * @user_prio: User priority of the traffic stream
3670 * @admitted_time: Admitted time for this TS in units of
3671 * 32 microsecond periods (per second).
3672 * Returns: 0 on success, -1 on failure
3674 int (*add_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
, u8 user_prio
,
3678 * del_tx_ts - Delete traffic stream
3679 * @priv: Private driver interface data
3680 * @tsid: Traffic stream ID
3681 * @addr: Receiver address
3682 * Returns: 0 on success, -1 on failure
3684 int (*del_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
);
3687 * Enable channel-switching with TDLS peer
3688 * @priv: Private driver interface data
3689 * @addr: MAC address of the TDLS peer
3690 * @oper_class: Operating class of the switch channel
3691 * @params: Channel specification
3692 * Returns: 0 on success, -1 on failure
3694 * The function indicates to driver that it can start switching to a
3695 * different channel with a specified TDLS peer. The switching is
3696 * assumed on until canceled with tdls_disable_channel_switch().
3698 int (*tdls_enable_channel_switch
)(
3699 void *priv
, const u8
*addr
, u8 oper_class
,
3700 const struct hostapd_freq_params
*params
);
3703 * Disable channel switching with TDLS peer
3704 * @priv: Private driver interface data
3705 * @addr: MAC address of the TDLS peer
3706 * Returns: 0 on success, -1 on failure
3708 * This function indicates to the driver that it should stop switching
3709 * with a given TDLS peer.
3711 int (*tdls_disable_channel_switch
)(void *priv
, const u8
*addr
);
3714 * start_dfs_cac - Listen for radar interference on the channel
3715 * @priv: Private driver interface data
3716 * @freq: Channel parameters
3717 * Returns: 0 on success, -1 on failure
3719 int (*start_dfs_cac
)(void *priv
, struct hostapd_freq_params
*freq
);
3722 * stop_ap - Removes beacon from AP
3723 * @priv: Private driver interface data
3724 * Returns: 0 on success, -1 on failure (or if not supported)
3726 * This optional function can be used to disable AP mode related
3727 * configuration. Unlike deinit_ap, it does not change to station
3730 int (*stop_ap
)(void *priv
);
3733 * get_survey - Retrieve survey data
3734 * @priv: Private driver interface data
3735 * @freq: If set, survey data for the specified frequency is only
3736 * being requested. If not set, all survey data is requested.
3737 * Returns: 0 on success, -1 on failure
3739 * Use this to retrieve:
3741 * - the observed channel noise floor
3742 * - the amount of time we have spent on the channel
3743 * - the amount of time during which we have spent on the channel that
3744 * the radio has determined the medium is busy and we cannot
3746 * - the amount of time we have spent receiving data
3747 * - the amount of time we have spent transmitting data
3749 * This data can be used for spectrum heuristics. One example is
3750 * Automatic Channel Selection (ACS). The channel survey data is
3751 * kept on a linked list on the channel data, one entry is added
3752 * for each survey. The min_nf of the channel is updated for each
3755 int (*get_survey
)(void *priv
, unsigned int freq
);
3758 * status - Get driver interface status information
3759 * @priv: Private driver interface data
3760 * @buf: Buffer for printing the status information
3761 * @buflen: Maximum length of the buffer
3762 * Returns: Length of written status information or -1 on failure
3764 int (*status
)(void *priv
, char *buf
, size_t buflen
);
3767 * roaming - Set roaming policy for driver-based BSS selection
3768 * @priv: Private driver interface data
3769 * @allowed: Whether roaming within ESS is allowed
3770 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3771 * Returns: Length of written status information or -1 on failure
3773 * This optional callback can be used to update roaming policy from the
3774 * associate() command (bssid being set there indicates that the driver
3775 * should not roam before getting this roaming() call to allow roaming.
3776 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3777 * capability, roaming policy is handled within wpa_supplicant and there
3778 * is no need to implement or react to this callback.
3780 int (*roaming
)(void *priv
, int allowed
, const u8
*bssid
);
3783 * disable_fils - Enable/disable FILS feature
3784 * @priv: Private driver interface data
3785 * @disable: 0-enable and 1-disable FILS feature
3786 * Returns: 0 on success, -1 on failure
3788 * This callback can be used to configure driver and below layers to
3789 * enable/disable all FILS features.
3791 int (*disable_fils
)(void *priv
, int disable
);
3794 * set_mac_addr - Set MAC address
3795 * @priv: Private driver interface data
3796 * @addr: MAC address to use or %NULL for setting back to permanent
3797 * Returns: 0 on success, -1 on failure
3799 int (*set_mac_addr
)(void *priv
, const u8
*addr
);
3801 #ifdef CONFIG_MACSEC
3802 int (*macsec_init
)(void *priv
, struct macsec_init_params
*params
);
3804 int (*macsec_deinit
)(void *priv
);
3807 * macsec_get_capability - Inform MKA of this driver's capability
3808 * @priv: Private driver interface data
3809 * @cap: Driver's capability
3810 * Returns: 0 on success, -1 on failure
3812 int (*macsec_get_capability
)(void *priv
, enum macsec_cap
*cap
);
3815 * enable_protect_frames - Set protect frames status
3816 * @priv: Private driver interface data
3817 * @enabled: TRUE = protect frames enabled
3818 * FALSE = protect frames disabled
3819 * Returns: 0 on success, -1 on failure (or if not supported)
3821 int (*enable_protect_frames
)(void *priv
, Boolean enabled
);
3824 * enable_encrypt - Set encryption status
3825 * @priv: Private driver interface data
3826 * @enabled: TRUE = encrypt outgoing traffic
3827 * FALSE = integrity-only protection on outgoing traffic
3828 * Returns: 0 on success, -1 on failure (or if not supported)
3830 int (*enable_encrypt
)(void *priv
, Boolean enabled
);
3833 * set_replay_protect - Set replay protect status and window size
3834 * @priv: Private driver interface data
3835 * @enabled: TRUE = replay protect enabled
3836 * FALSE = replay protect disabled
3837 * @window: replay window size, valid only when replay protect enabled
3838 * Returns: 0 on success, -1 on failure (or if not supported)
3840 int (*set_replay_protect
)(void *priv
, Boolean enabled
, u32 window
);
3843 * set_current_cipher_suite - Set current cipher suite
3844 * @priv: Private driver interface data
3845 * @cs: EUI64 identifier
3846 * Returns: 0 on success, -1 on failure (or if not supported)
3848 int (*set_current_cipher_suite
)(void *priv
, u64 cs
);
3851 * enable_controlled_port - Set controlled port status
3852 * @priv: Private driver interface data
3853 * @enabled: TRUE = controlled port enabled
3854 * FALSE = controlled port disabled
3855 * Returns: 0 on success, -1 on failure (or if not supported)
3857 int (*enable_controlled_port
)(void *priv
, Boolean enabled
);
3860 * get_receive_lowest_pn - Get 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 (*get_receive_lowest_pn
)(void *priv
, struct receive_sa
*sa
);
3868 * get_transmit_next_pn - Get transmit next pn
3869 * @priv: Private driver interface data
3870 * @sa: secure association
3871 * Returns: 0 on success, -1 on failure (or if not supported)
3873 int (*get_transmit_next_pn
)(void *priv
, struct transmit_sa
*sa
);
3876 * set_transmit_next_pn - Set transmit next pn
3877 * @priv: Private driver interface data
3878 * @sa: secure association
3879 * Returns: 0 on success, -1 on failure (or if not supported)
3881 int (*set_transmit_next_pn
)(void *priv
, struct transmit_sa
*sa
);
3884 * set_receive_lowest_pn - Set receive lowest PN
3885 * @priv: Private driver interface data
3886 * @sa: secure association
3887 * Returns: 0 on success, -1 on failure (or if not supported)
3889 int (*set_receive_lowest_pn
)(void *priv
, struct receive_sa
*sa
);
3892 * create_receive_sc - create secure channel for receiving
3893 * @priv: Private driver interface data
3894 * @sc: secure channel
3895 * @conf_offset: confidentiality offset (0, 30, or 50)
3896 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3898 * Returns: 0 on success, -1 on failure (or if not supported)
3900 int (*create_receive_sc
)(void *priv
, struct receive_sc
*sc
,
3901 unsigned int conf_offset
,
3905 * delete_receive_sc - delete secure connection for receiving
3906 * @priv: private driver interface data from init()
3907 * @sc: secure channel
3908 * Returns: 0 on success, -1 on failure
3910 int (*delete_receive_sc
)(void *priv
, struct receive_sc
*sc
);
3913 * create_receive_sa - create secure association for receive
3914 * @priv: private driver interface data from init()
3915 * @sa: secure association
3916 * Returns: 0 on success, -1 on failure
3918 int (*create_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3921 * delete_receive_sa - Delete secure association for receive
3922 * @priv: Private driver interface data from init()
3923 * @sa: Secure association
3924 * Returns: 0 on success, -1 on failure
3926 int (*delete_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3929 * enable_receive_sa - enable the SA for receive
3930 * @priv: private driver interface data from init()
3931 * @sa: secure association
3932 * Returns: 0 on success, -1 on failure
3934 int (*enable_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3937 * disable_receive_sa - disable SA for receive
3938 * @priv: private driver interface data from init()
3939 * @sa: secure association
3940 * Returns: 0 on success, -1 on failure
3942 int (*disable_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3945 * create_transmit_sc - create secure connection for transmit
3946 * @priv: private driver interface data from init()
3947 * @sc: secure channel
3948 * @conf_offset: confidentiality offset (0, 30, or 50)
3949 * Returns: 0 on success, -1 on failure
3951 int (*create_transmit_sc
)(void *priv
, struct transmit_sc
*sc
,
3952 unsigned int conf_offset
);
3955 * delete_transmit_sc - delete secure connection for transmit
3956 * @priv: private driver interface data from init()
3957 * @sc: secure channel
3958 * Returns: 0 on success, -1 on failure
3960 int (*delete_transmit_sc
)(void *priv
, struct transmit_sc
*sc
);
3963 * create_transmit_sa - create secure association for transmit
3964 * @priv: private driver interface data from init()
3965 * @sa: secure association
3966 * Returns: 0 on success, -1 on failure
3968 int (*create_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
3971 * delete_transmit_sa - Delete secure association for transmit
3972 * @priv: Private driver interface data from init()
3973 * @sa: Secure association
3974 * Returns: 0 on success, -1 on failure
3976 int (*delete_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
3979 * enable_transmit_sa - enable SA for transmit
3980 * @priv: private driver interface data from init()
3981 * @sa: secure association
3982 * Returns: 0 on success, -1 on failure
3984 int (*enable_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
3987 * disable_transmit_sa - disable SA for transmit
3988 * @priv: private driver interface data from init()
3989 * @sa: secure association
3990 * Returns: 0 on success, -1 on failure
3992 int (*disable_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
3993 #endif /* CONFIG_MACSEC */
3996 * init_mesh - Driver specific initialization for mesh
3997 * @priv: Private driver interface data
3998 * Returns: 0 on success, -1 on failure
4000 int (*init_mesh
)(void *priv
);
4003 * join_mesh - Join a mesh network
4004 * @priv: Private driver interface data
4005 * @params: Mesh configuration parameters
4006 * Returns: 0 on success, -1 on failure
4008 int (*join_mesh
)(void *priv
,
4009 struct wpa_driver_mesh_join_params
*params
);
4012 * leave_mesh - Leave a mesh network
4013 * @priv: Private driver interface data
4014 * Returns 0 on success, -1 on failure
4016 int (*leave_mesh
)(void *priv
);
4019 * probe_mesh_link - Inject a frame over direct mesh link to a given
4020 * peer skipping the next_hop lookup from mpath table.
4021 * @priv: Private driver interface data
4022 * @addr: Peer MAC address
4023 * @eth: Ethernet frame to be sent
4024 * @len: Ethernet frame lengtn in bytes
4025 * Returns 0 on success, -1 on failure
4027 int (*probe_mesh_link
)(void *priv
, const u8
*addr
, const u8
*eth
,
4031 * do_acs - Automatically select channel
4032 * @priv: Private driver interface data
4033 * @params: Parameters for ACS
4034 * Returns 0 on success, -1 on failure
4036 * This command can be used to offload ACS to the driver if the driver
4037 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
4039 int (*do_acs
)(void *priv
, struct drv_acs_params
*params
);
4042 * set_band - Notify driver of band selection
4043 * @priv: Private driver interface data
4044 * @band: The selected band(s)
4045 * Returns 0 on success, -1 on failure
4047 int (*set_band
)(void *priv
, enum set_band band
);
4050 * get_pref_freq_list - Get preferred frequency list for an interface
4051 * @priv: Private driver interface data
4052 * @if_type: Interface type
4053 * @num: Number of channels
4054 * @freq_list: Preferred channel frequency list encoded in MHz values
4055 * Returns 0 on success, -1 on failure
4057 * This command can be used to query the preferred frequency list from
4058 * the driver specific to a particular interface type.
4060 int (*get_pref_freq_list
)(void *priv
, enum wpa_driver_if_type if_type
,
4061 unsigned int *num
, unsigned int *freq_list
);
4064 * set_prob_oper_freq - Indicate probable P2P operating channel
4065 * @priv: Private driver interface data
4066 * @freq: Channel frequency in MHz
4067 * Returns 0 on success, -1 on failure
4069 * This command can be used to inform the driver of the operating
4070 * frequency that an ongoing P2P group formation is likely to come up
4071 * on. Local device is assuming P2P Client role.
4073 int (*set_prob_oper_freq
)(void *priv
, unsigned int freq
);
4076 * abort_scan - Request the driver to abort an ongoing scan
4077 * @priv: Private driver interface data
4078 * @scan_cookie: Cookie identifying the scan request. This is used only
4079 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4080 * was used to trigger scan. Otherwise, 0 is used.
4081 * Returns 0 on success, -1 on failure
4083 int (*abort_scan
)(void *priv
, u64 scan_cookie
);
4086 * configure_data_frame_filters - Request to configure frame filters
4087 * @priv: Private driver interface data
4088 * @filter_flags: The type of frames to filter (bitfield of
4089 * WPA_DATA_FRAME_FILTER_FLAG_*)
4090 * Returns: 0 on success or -1 on failure
4092 int (*configure_data_frame_filters
)(void *priv
, u32 filter_flags
);
4095 * get_ext_capab - Get extended capabilities for the specified interface
4096 * @priv: Private driver interface data
4097 * @type: Interface type for which to get extended capabilities
4098 * @ext_capab: Extended capabilities fetched
4099 * @ext_capab_mask: Extended capabilities mask
4100 * @ext_capab_len: Length of the extended capabilities
4101 * Returns: 0 on success or -1 on failure
4103 int (*get_ext_capab
)(void *priv
, enum wpa_driver_if_type type
,
4104 const u8
**ext_capab
, const u8
**ext_capab_mask
,
4105 unsigned int *ext_capab_len
);
4108 * p2p_lo_start - Start offloading P2P listen to device
4109 * @priv: Private driver interface data
4110 * @freq: Listening frequency (MHz) for P2P listen
4111 * @period: Length of the listen operation in milliseconds
4112 * @interval: Interval for running the listen operation in milliseconds
4113 * @count: Number of times to run the listen operation
4114 * @device_types: Device primary and secondary types
4115 * @dev_types_len: Number of bytes for device_types
4116 * @ies: P2P IE and WSC IE for Probe Response frames
4117 * @ies_len: Length of ies in bytes
4118 * Returns: 0 on success or -1 on failure
4120 int (*p2p_lo_start
)(void *priv
, unsigned int freq
,
4121 unsigned int period
, unsigned int interval
,
4123 const u8
*device_types
, size_t dev_types_len
,
4124 const u8
*ies
, size_t ies_len
);
4127 * p2p_lo_stop - Stop P2P listen offload
4128 * @priv: Private driver interface data
4129 * Returns: 0 on success or -1 on failure
4131 int (*p2p_lo_stop
)(void *priv
);
4134 * set_default_scan_ies - Set default scan IEs
4135 * @priv: Private driver interface data
4136 * @ies: Scan default IEs buffer
4137 * @ies_len: Length of IEs in bytes
4138 * Returns: 0 on success or -1 on failure
4140 * The driver can use these by default when there are no scan IEs coming
4141 * in the subsequent scan requests. Also in case of one or more of IEs
4142 * given in set_default_scan_ies() are missing in the subsequent scan
4143 * request, the driver should merge the missing scan IEs in the scan
4144 * request from the IEs set by set_default_scan_ies() in the Probe
4145 * Request frames sent.
4147 int (*set_default_scan_ies
)(void *priv
, const u8
*ies
, size_t ies_len
);
4150 * set_tdls_mode - Set TDLS trigger mode to the host driver
4151 * @priv: Private driver interface data
4152 * @tdls_external_control: Represents if TDLS external trigger control
4153 * mode is enabled/disabled.
4155 * This optional callback can be used to configure the TDLS external
4156 * trigger control mode to the host driver.
4158 int (*set_tdls_mode
)(void *priv
, int tdls_external_control
);
4161 * get_bss_transition_status - Get candidate BSS's transition status
4162 * @priv: Private driver interface data
4163 * @params: Candidate BSS list
4165 * Get the accept or reject reason code for a list of BSS transition
4168 struct wpa_bss_candidate_info
*
4169 (*get_bss_transition_status
)(void *priv
,
4170 struct wpa_bss_trans_info
*params
);
4172 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
4173 * @priv: Private driver interface data
4174 * @ignore_disallow: 0 to not ignore, 1 to ignore
4175 * Returns: 0 on success, -1 on failure
4177 int (*ignore_assoc_disallow
)(void *priv
, int ignore_disallow
);
4180 * set_bssid_blacklist - Set blacklist of BSSIDs to the driver
4181 * @priv: Private driver interface data
4182 * @num_bssid: Number of blacklist BSSIDs
4183 * @bssids: List of blacklisted BSSIDs
4185 int (*set_bssid_blacklist
)(void *priv
, unsigned int num_bssid
,
4189 * update_connect_params - Update the connection parameters
4190 * @priv: Private driver interface data
4191 * @params: Association parameters
4192 * @mask: Bit mask indicating which parameters in @params have to be
4194 * Returns: 0 on success, -1 on failure
4196 * Update the connection parameters when in connected state so that the
4197 * driver uses the updated parameters for subsequent roaming. This is
4198 * used only with drivers that implement internal BSS selection and
4201 int (*update_connect_params
)(
4202 void *priv
, struct wpa_driver_associate_params
*params
,
4203 enum wpa_drv_update_connect_params_mask mask
);
4206 * send_external_auth_status - Indicate the status of external
4207 * authentication processing to the host driver.
4208 * @priv: Private driver interface data
4209 * @params: Status of authentication processing.
4210 * Returns: 0 on success, -1 on failure
4212 int (*send_external_auth_status
)(void *priv
,
4213 struct external_auth
*params
);
4216 * set_4addr_mode - Set 4-address mode
4217 * @priv: Private driver interface data
4218 * @bridge_ifname: Bridge interface name
4219 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
4220 * Returns: 0 on success, < 0 on failure
4222 int (*set_4addr_mode
)(void *priv
, const char *bridge_ifname
, int val
);
4226 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
4228 enum wpa_event_type
{
4230 * EVENT_ASSOC - Association completed
4232 * This event needs to be delivered when the driver completes IEEE
4233 * 802.11 association or reassociation successfully.
4234 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
4235 * after this event has been generated. In addition, optional
4236 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
4237 * more information about the association. If the driver interface gets
4238 * both of these events at the same time, it can also include the
4239 * assoc_info data in EVENT_ASSOC call.
4244 * EVENT_DISASSOC - Association lost
4246 * This event should be called when association is lost either due to
4247 * receiving deauthenticate or disassociate frame from the AP or when
4248 * sending either of these frames to the current AP. If the driver
4249 * supports separate deauthentication event, EVENT_DISASSOC should only
4250 * be used for disassociation and EVENT_DEAUTH for deauthentication.
4251 * In AP mode, union wpa_event_data::disassoc_info is required.
4256 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
4258 * This event must be delivered when a Michael MIC error is detected by
4259 * the local driver. Additional data for event processing is
4260 * provided with union wpa_event_data::michael_mic_failure. This
4261 * information is used to request new encyption key and to initiate
4262 * TKIP countermeasures if needed.
4264 EVENT_MICHAEL_MIC_FAILURE
,
4267 * EVENT_SCAN_RESULTS - Scan results available
4269 * This event must be called whenever scan results are available to be
4270 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4271 * is expected to be used some time after struct wpa_driver_ops::scan()
4272 * is called. If the driver provides an unsolicited event when the scan
4273 * has been completed, this event can be used to trigger
4274 * EVENT_SCAN_RESULTS call. If such event is not available from the
4275 * driver, the driver wrapper code is expected to use a registered
4276 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
4277 * scan is expected to be completed. Optional information about
4278 * completed scan can be provided with union wpa_event_data::scan_info.
4283 * EVENT_ASSOCINFO - Report optional extra information for association
4285 * This event can be used to report extra association information for
4286 * EVENT_ASSOC processing. This extra information includes IEs from
4287 * association frames and Beacon/Probe Response frames in union
4288 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4289 * EVENT_ASSOC. Alternatively, the driver interface can include
4290 * assoc_info data in the EVENT_ASSOC call if it has all the
4291 * information available at the same point.
4296 * EVENT_INTERFACE_STATUS - Report interface status changes
4298 * This optional event can be used to report changes in interface
4299 * status (interface added/removed) using union
4300 * wpa_event_data::interface_status. This can be used to trigger
4301 * wpa_supplicant to stop and re-start processing for the interface,
4302 * e.g., when a cardbus card is ejected/inserted.
4304 EVENT_INTERFACE_STATUS
,
4307 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4309 * This event can be used to inform wpa_supplicant about candidates for
4310 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4311 * for scan request (ap_scan=2 mode), this event is required for
4312 * pre-authentication. If wpa_supplicant is performing scan request
4313 * (ap_scan=1), this event is optional since scan results can be used
4314 * to add pre-authentication candidates. union
4315 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4316 * candidate and priority of the candidate, e.g., based on the signal
4317 * strength, in order to try to pre-authenticate first with candidates
4318 * that are most likely targets for re-association.
4320 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4321 * on the candidate list. In addition, it can be called for the current
4322 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4323 * will automatically skip pre-authentication in cases where a valid
4324 * PMKSA exists. When more than one candidate exists, this event should
4325 * be generated once for each candidate.
4327 * Driver will be notified about successful pre-authentication with
4328 * struct wpa_driver_ops::add_pmkid() calls.
4330 EVENT_PMKID_CANDIDATE
,
4333 * EVENT_TDLS - Request TDLS operation
4335 * This event can be used to request a TDLS operation to be performed.
4340 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4342 * The driver is expected to report the received FT IEs from
4343 * FT authentication sequence from the AP. The FT IEs are included in
4344 * the extra information in union wpa_event_data::ft_ies.
4349 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4351 * The driver can use this event to inform wpa_supplicant about a STA
4352 * in an IBSS with which protected frames could be exchanged. This
4353 * event starts RSN authentication with the other STA to authenticate
4354 * the STA and set up encryption keys with it.
4356 EVENT_IBSS_RSN_START
,
4359 * EVENT_AUTH - Authentication result
4361 * This event should be called when authentication attempt has been
4362 * completed. This is only used if the driver supports separate
4363 * authentication step (struct wpa_driver_ops::authenticate).
4364 * Information about authentication result is included in
4365 * union wpa_event_data::auth.
4370 * EVENT_DEAUTH - Authentication lost
4372 * This event should be called when authentication is lost either due
4373 * to receiving deauthenticate frame from the AP or when sending that
4374 * frame to the current AP.
4375 * In AP mode, union wpa_event_data::deauth_info is required.
4380 * EVENT_ASSOC_REJECT - Association rejected
4382 * This event should be called when (re)association attempt has been
4383 * rejected by the AP. Information about the association response is
4384 * included in union wpa_event_data::assoc_reject.
4389 * EVENT_AUTH_TIMED_OUT - Authentication timed out
4391 EVENT_AUTH_TIMED_OUT
,
4394 * EVENT_ASSOC_TIMED_OUT - Association timed out
4396 EVENT_ASSOC_TIMED_OUT
,
4399 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
4401 EVENT_WPS_BUTTON_PUSHED
,
4404 * EVENT_TX_STATUS - Report TX status
4409 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
4411 EVENT_RX_FROM_UNKNOWN
,
4414 * EVENT_RX_MGMT - Report RX of a management frame
4419 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
4421 * This event is used to indicate when the driver has started the
4422 * requested remain-on-channel duration. Information about the
4423 * operation is included in union wpa_event_data::remain_on_channel.
4425 EVENT_REMAIN_ON_CHANNEL
,
4428 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
4430 * This event is used to indicate when the driver has completed
4431 * remain-on-channel duration, i.e., may noot be available on the
4432 * requested channel anymore. Information about the
4433 * operation is included in union wpa_event_data::remain_on_channel.
4435 EVENT_CANCEL_REMAIN_ON_CHANNEL
,
4438 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
4440 * This event is used to indicate when a Probe Request frame has been
4441 * received. Information about the received frame is included in
4442 * union wpa_event_data::rx_probe_req. The driver is required to report
4443 * these events only after successfully completed probe_req_report()
4444 * commands to request the events (i.e., report parameter is non-zero)
4445 * in station mode. In AP mode, Probe Request frames should always be
4451 * EVENT_NEW_STA - New wired device noticed
4453 * This event is used to indicate that a new device has been detected
4454 * in a network that does not use association-like functionality (i.e.,
4455 * mainly wired Ethernet). This can be used to start EAPOL
4456 * authenticator when receiving a frame from a device. The address of
4457 * the device is included in union wpa_event_data::new_sta.
4462 * EVENT_EAPOL_RX - Report received EAPOL frame
4464 * When in AP mode with hostapd, this event is required to be used to
4465 * deliver the receive EAPOL frames from the driver.
4470 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4472 * This event is used to indicate changes in the signal strength
4473 * observed in frames received from the current AP if signal strength
4474 * monitoring has been enabled with signal_monitor().
4476 EVENT_SIGNAL_CHANGE
,
4479 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4481 * This event is used to indicate that the interface was enabled after
4482 * having been previously disabled, e.g., due to rfkill.
4484 EVENT_INTERFACE_ENABLED
,
4487 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4489 * This event is used to indicate that the interface was disabled,
4490 * e.g., due to rfkill.
4492 EVENT_INTERFACE_DISABLED
,
4495 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4497 * This event is used to indicate that the channel list has changed,
4498 * e.g., because of a regulatory domain change triggered by scan
4499 * results including an AP advertising a country code.
4501 EVENT_CHANNEL_LIST_CHANGED
,
4504 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4506 * This event is used to indicate that the driver cannot maintain this
4507 * interface in its operation mode anymore. The most likely use for
4508 * this is to indicate that AP mode operation is not available due to
4509 * operating channel would need to be changed to a DFS channel when
4510 * the driver does not support radar detection and another virtual
4511 * interfaces caused the operating channel to change. Other similar
4512 * resource conflicts could also trigger this for station mode
4513 * interfaces. This event can be propagated when channel switching
4516 EVENT_INTERFACE_UNAVAILABLE
,
4519 * EVENT_BEST_CHANNEL
4521 * Driver generates this event whenever it detects a better channel
4522 * (e.g., based on RSSI or channel use). This information can be used
4523 * to improve channel selection for a new AP/P2P group.
4528 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4530 * This event should be called when a Deauthentication frame is dropped
4531 * due to it not being protected (MFP/IEEE 802.11w).
4532 * union wpa_event_data::unprot_deauth is required to provide more
4533 * details of the frame.
4535 EVENT_UNPROT_DEAUTH
,
4538 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4540 * This event should be called when a Disassociation frame is dropped
4541 * due to it not being protected (MFP/IEEE 802.11w).
4542 * union wpa_event_data::unprot_disassoc is required to provide more
4543 * details of the frame.
4545 EVENT_UNPROT_DISASSOC
,
4548 * EVENT_STATION_LOW_ACK
4550 * Driver generates this event whenever it detected that a particular
4551 * station was lost. Detection can be through massive transmission
4552 * failures for example.
4554 EVENT_STATION_LOW_ACK
,
4557 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4559 EVENT_IBSS_PEER_LOST
,
4562 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4564 * This event carries the new replay counter to notify wpa_supplicant
4565 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4566 * completed Group Key Handshake while the host (including
4567 * wpa_supplicant was sleeping).
4569 EVENT_DRIVER_GTK_REKEY
,
4572 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4574 EVENT_SCHED_SCAN_STOPPED
,
4577 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4579 * This event indicates that the station responded to the poll
4580 * initiated with @poll_client.
4582 EVENT_DRIVER_CLIENT_POLL_OK
,
4585 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4587 EVENT_EAPOL_TX_STATUS
,
4590 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4592 * Described in wpa_event_data.ch_switch
4597 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
4599 * This is a pre-switch event indicating the shortly following switch
4600 * of operating channels.
4602 * Described in wpa_event_data.ch_switch
4604 EVENT_CH_SWITCH_STARTED
,
4606 * EVENT_WNM - Request WNM operation
4608 * This event can be used to request a WNM operation to be performed.
4613 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4615 * This event indicates that the driver reported a connection failure
4616 * with the specified client (for example, max client reached, etc.) in
4619 EVENT_CONNECT_FAILED_REASON
,
4622 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
4624 * A radar has been detected on the supplied frequency, hostapd should
4625 * react accordingly (e.g., change channel).
4627 EVENT_DFS_RADAR_DETECTED
,
4630 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
4632 * After a successful CAC, the channel can be marked clear and used.
4634 EVENT_DFS_CAC_FINISHED
,
4637 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
4639 * The CAC was not successful, and the channel remains in the previous
4640 * state. This may happen due to a radar being detected or other
4641 * external influences.
4643 EVENT_DFS_CAC_ABORTED
,
4646 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
4648 * The channel which was previously unavailable is now available again.
4650 EVENT_DFS_NOP_FINISHED
,
4653 * EVENT_SURVEY - Received survey data
4655 * This event gets triggered when a driver query is issued for survey
4656 * data and the requested data becomes available. The returned data is
4657 * stored in struct survey_results. The results provide at most one
4658 * survey entry for each frequency and at minimum will provide one
4659 * survey entry for one frequency. The survey data can be os_malloc()'d
4660 * and then os_free()'d, so the event callback must only copy data.
4665 * EVENT_SCAN_STARTED - Scan started
4667 * This indicates that driver has started a scan operation either based
4668 * on a request from wpa_supplicant/hostapd or from another application.
4669 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4670 * completed (either successfully or by getting cancelled).
4675 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4677 * This event indicates a set of frequency ranges that should be avoided
4678 * to reduce issues due to interference or internal co-existence
4679 * information in the driver.
4681 EVENT_AVOID_FREQUENCIES
,
4684 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4686 EVENT_NEW_PEER_CANDIDATE
,
4689 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4691 * Indicates a pair of primary and secondary channels chosen by ACS
4694 EVENT_ACS_CHANNEL_SELECTED
,
4697 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4700 * This event indicates that channel availability check has been started
4701 * on a DFS frequency by a driver that supports DFS Offload.
4703 EVENT_DFS_CAC_STARTED
,
4706 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4711 * EVENT_BEACON_LOSS - Beacon loss detected
4713 * This event indicates that no Beacon frames has been received from
4714 * the current AP. This may indicate that the AP is not anymore in
4720 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
4721 * done previously (Pre-CAC) on the channel has expired. This would
4722 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
4723 * channel will be moved from available to usable. A new CAC has to be
4724 * performed before start operating on this channel.
4726 EVENT_DFS_PRE_CAC_EXPIRED
,
4729 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
4730 * that do not define separate commands for authentication and
4731 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
4732 * authentication to wpa_supplicant. This event carries all the
4733 * necessary information from the host driver for the authentication to
4736 EVENT_EXTERNAL_AUTH
,
4739 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
4741 * This event should be indicated when the driver completes the 4-way
4742 * handshake. This event should be preceded by an EVENT_ASSOC that
4743 * indicates the completion of IEEE 802.11 association.
4745 EVENT_PORT_AUTHORIZED
,
4748 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
4751 EVENT_STATION_OPMODE_CHANGED
,
4754 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
4756 * This event is emitted when the MAC changes while the interface is
4757 * enabled. When an interface was disabled and becomes enabled, it
4758 * must be always assumed that the MAC possibly changed.
4760 EVENT_INTERFACE_MAC_CHANGED
,
4763 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
4765 * This event is emitted when an interface is added/removed for WDS STA.
4767 EVENT_WDS_STA_INTERFACE_STATUS
,
4772 * struct freq_survey - Channel survey info
4774 * @ifidx: Interface index in which this survey was observed
4775 * @freq: Center of frequency of the surveyed channel
4776 * @nf: Channel noise floor in dBm
4777 * @channel_time: Amount of time in ms the radio spent on the channel
4778 * @channel_time_busy: Amount of time in ms the radio detected some signal
4779 * that indicated to the radio the channel was not clear
4780 * @channel_time_rx: Amount of time the radio spent receiving data
4781 * @channel_time_tx: Amount of time the radio spent transmitting data
4782 * @filled: bitmask indicating which fields have been reported, see
4783 * SURVEY_HAS_* defines.
4784 * @list: Internal list pointers
4786 struct freq_survey
{
4791 u64 channel_time_busy
;
4792 u64 channel_time_rx
;
4793 u64 channel_time_tx
;
4794 unsigned int filled
;
4795 struct dl_list list
;
4798 #define SURVEY_HAS_NF BIT(0)
4799 #define SURVEY_HAS_CHAN_TIME BIT(1)
4800 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4801 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4802 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4806 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4808 union wpa_event_data
{
4810 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4812 * This structure is optional for EVENT_ASSOC calls and required for
4813 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4814 * driver interface does not need to generate separate EVENT_ASSOCINFO
4819 * reassoc - Flag to indicate association or reassociation
4824 * req_ies - (Re)Association Request IEs
4826 * If the driver generates WPA/RSN IE, this event data must be
4827 * returned for WPA handshake to have needed information. If
4828 * wpa_supplicant-generated WPA/RSN IE is used, this
4829 * information event is optional.
4831 * This should start with the first IE (fixed fields before IEs
4832 * are not included).
4837 * req_ies_len - Length of req_ies in bytes
4842 * resp_ies - (Re)Association Response IEs
4844 * Optional association data from the driver. This data is not
4845 * required WPA, but may be useful for some protocols and as
4846 * such, should be reported if this is available to the driver
4849 * This should start with the first IE (fixed fields before IEs
4850 * are not included).
4855 * resp_ies_len - Length of resp_ies in bytes
4857 size_t resp_ies_len
;
4860 * resp_frame - (Re)Association Response frame
4862 const u8
*resp_frame
;
4865 * resp_frame_len - (Re)Association Response frame length
4867 size_t resp_frame_len
;
4870 * beacon_ies - Beacon or Probe Response IEs
4872 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4873 * Probe Response frames from the current AP (i.e., the one
4874 * that the client just associated with). This information is
4875 * used to update WPA/RSN IE for the AP. If this field is not
4876 * set, the results from previous scan will be used. If no
4877 * data for the new AP is found, scan results will be requested
4878 * again (without scan request). At this point, the driver is
4879 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4882 * This should start with the first IE (fixed fields before IEs
4883 * are not included).
4885 const u8
*beacon_ies
;
4888 * beacon_ies_len - Length of beacon_ies */
4889 size_t beacon_ies_len
;
4892 * freq - Frequency of the operational channel in MHz
4897 * wmm_params - WMM parameters used in this association.
4899 struct wmm_params wmm_params
;
4902 * addr - Station address (for AP mode)
4907 * The following is the key management offload information
4910 * @key_replay_ctr_len
4918 * authorized - Status of key management offload,
4924 * key_replay_ctr - Key replay counter value last used
4925 * in a valid EAPOL-Key frame
4927 const u8
*key_replay_ctr
;
4930 * key_replay_ctr_len - The length of key_replay_ctr
4932 size_t key_replay_ctr_len
;
4935 * ptk_kck - The derived PTK KCK
4940 * ptk_kek_len - The length of ptk_kck
4945 * ptk_kek - The derived PTK KEK
4946 * This is used in key management offload and also in FILS SK
4952 * ptk_kek_len - The length of ptk_kek
4957 * subnet_status - The subnet status:
4958 * 0 = unknown, 1 = unchanged, 2 = changed
4963 * The following information is used in FILS SK offload
4964 * @fils_erp_next_seq_num
4971 * fils_erp_next_seq_num - The next sequence number to use in
4974 u16 fils_erp_next_seq_num
;
4977 * fils_pmk - A new PMK if generated in case of FILS
4983 * fils_pmk_len - Length of fils_pmk
4985 size_t fils_pmk_len
;
4988 * fils_pmkid - PMKID used or generated in FILS authentication
4990 const u8
*fils_pmkid
;
4994 * struct disassoc_info - Data for EVENT_DISASSOC events
4996 struct disassoc_info
{
4998 * addr - Station address (for AP mode)
5003 * reason_code - Reason Code (host byte order) used in
5004 * Deauthentication frame
5009 * ie - Optional IE(s) in Disassociation frame
5014 * ie_len - Length of ie buffer in octets
5019 * locally_generated - Whether the frame was locally generated
5021 int locally_generated
;
5025 * struct deauth_info - Data for EVENT_DEAUTH events
5027 struct deauth_info
{
5029 * addr - Station address (for AP mode)
5034 * reason_code - Reason Code (host byte order) used in
5035 * Deauthentication frame
5040 * ie - Optional IE(s) in Deauthentication frame
5045 * ie_len - Length of ie buffer in octets
5050 * locally_generated - Whether the frame was locally generated
5052 int locally_generated
;
5056 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
5058 struct michael_mic_failure
{
5061 } michael_mic_failure
;
5064 * struct interface_status - Data for EVENT_INTERFACE_STATUS
5066 struct interface_status
{
5067 unsigned int ifindex
;
5070 EVENT_INTERFACE_ADDED
, EVENT_INTERFACE_REMOVED
5075 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
5077 struct pmkid_candidate
{
5078 /** BSSID of the PMKID candidate */
5080 /** Smaller the index, higher the priority */
5082 /** Whether RSN IE includes pre-authenticate flag */
5087 * struct tdls - Data for EVENT_TDLS
5093 TDLS_REQUEST_TEARDOWN
,
5094 TDLS_REQUEST_DISCOVER
,
5096 u16 reason_code
; /* for teardown */
5100 * struct wnm - Data for EVENT_WNM
5118 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
5120 * During FT (IEEE 802.11r) authentication sequence, the driver is
5121 * expected to use this event to report received FT IEs (MDIE, FTIE,
5122 * RSN IE, TIE, possible resource request) to the supplicant. The FT
5123 * IEs for the next message will be delivered through the
5124 * struct wpa_driver_ops::update_ft_ies() callback.
5130 u8 target_ap
[ETH_ALEN
];
5131 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
5133 /** Length of ric_ies buffer in octets */
5138 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
5140 struct ibss_rsn_start
{
5145 * struct auth_info - Data for EVENT_AUTH events
5151 u16 auth_transaction
;
5158 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
5160 struct assoc_reject
{
5162 * bssid - BSSID of the AP that rejected association
5167 * resp_ies - (Re)Association Response IEs
5169 * Optional association data from the driver. This data is not
5170 * required WPA, but may be useful for some protocols and as
5171 * such, should be reported if this is available to the driver
5174 * This should start with the first IE (fixed fields before IEs
5175 * are not included).
5180 * resp_ies_len - Length of resp_ies in bytes
5182 size_t resp_ies_len
;
5185 * status_code - Status Code from (Re)association Response
5190 * timed_out - Whether failure is due to timeout (etc.) rather
5191 * than explicit rejection response from the AP.
5196 * timeout_reason - Reason for the timeout
5198 const char *timeout_reason
;
5201 * fils_erp_next_seq_num - The next sequence number to use in
5204 u16 fils_erp_next_seq_num
;
5207 struct timeout_event
{
5212 * struct tx_status - Data for EVENT_TX_STATUS events
5224 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
5226 struct rx_from_unknown
{
5233 * struct rx_mgmt - Data for EVENT_RX_MGMT events
5241 * drv_priv - Pointer to store driver private BSS information
5243 * If not set to NULL, this is used for comparison with
5244 * hostapd_data->drv_priv to determine which BSS should process
5250 * freq - Frequency (in MHz) on which the frame was received
5255 * ssi_signal - Signal strength in dBm (or 0 if not available)
5261 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
5263 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
5265 struct remain_on_channel
{
5267 * freq - Channel frequency in MHz
5272 * duration - Duration to remain on the channel in milliseconds
5274 unsigned int duration
;
5275 } remain_on_channel
;
5278 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
5279 * @aborted: Whether the scan was aborted
5280 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
5281 * @num_freqs: Number of entries in freqs array
5282 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
5284 * @num_ssids: Number of entries in ssids array
5285 * @external_scan: Whether the scan info is for an external scan
5286 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
5287 * 0 if the source of the scan event is a vendor scan
5288 * @scan_start_tsf: Time when the scan started in terms of TSF of the
5289 * BSS that the interface that requested the scan is connected to
5291 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
5298 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
5303 u8 scan_start_tsf_bssid
[ETH_ALEN
];
5307 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
5309 struct rx_probe_req
{
5311 * sa - Source address of the received Probe Request frame
5316 * da - Destination address of the received Probe Request frame
5317 * or %NULL if not available
5322 * bssid - BSSID of the received Probe Request frame or %NULL
5328 * ie - IEs from the Probe Request body
5333 * ie_len - Length of ie buffer in octets
5338 * signal - signal strength in dBm (or 0 if not available)
5344 * struct new_sta - Data for EVENT_NEW_STA events
5351 * struct eapol_rx - Data for EVENT_EAPOL_RX events
5360 * signal_change - Data for EVENT_SIGNAL_CHANGE events
5362 struct wpa_signal_info signal_change
;
5365 * struct best_channel - Data for EVENT_BEST_CHANNEL events
5366 * @freq_24: Best 2.4 GHz band channel frequency in MHz
5367 * @freq_5: Best 5 GHz band channel frequency in MHz
5368 * @freq_overall: Best channel frequency in MHz
5370 * 0 can be used to indicate no preference in either band.
5372 struct best_channel
{
5378 struct unprot_deauth
{
5384 struct unprot_disassoc
{
5391 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
5392 * @addr: station address
5393 * @num_packets: Number of packets lost (consecutive packets not
5402 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
5404 struct ibss_peer_lost
{
5409 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
5411 struct driver_gtk_rekey
{
5413 const u8
*replay_ctr
;
5417 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
5418 * @addr: station address
5420 struct client_poll
{
5425 * struct eapol_tx_status
5426 * @dst: Original destination
5427 * @data: Data starting with IEEE 802.1X header (!)
5428 * @data_len: Length of data
5429 * @ack: Indicates ack or lost frame
5431 * This corresponds to hapd_send_eapol if the frame sent
5432 * there isn't just reported as EVENT_TX_STATUS.
5434 struct eapol_tx_status
{
5443 * @freq: Frequency of new channel in MHz
5444 * @ht_enabled: Whether this is an HT channel
5445 * @ch_offset: Secondary channel offset
5446 * @ch_width: Channel width
5447 * @cf1: Center frequency 1
5448 * @cf2: Center frequency 2
5454 enum chan_width ch_width
;
5460 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
5461 * @addr: Remote client address
5462 * @code: Reason code for connection failure
5464 struct connect_failed_reason
{
5470 } connect_failed_reason
;
5473 * struct dfs_event - Data for radar detected events
5474 * @freq: Frequency of the channel in MHz
5480 enum chan_width chan_width
;
5486 * survey_results - Survey result data for EVENT_SURVEY
5487 * @freq_filter: Requested frequency survey filter, 0 if request
5488 * was for all survey data
5489 * @survey_list: Linked list of survey data (struct freq_survey)
5491 struct survey_results
{
5492 unsigned int freq_filter
;
5493 struct dl_list survey_list
; /* struct freq_survey */
5497 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
5498 * @initiator: Initiator of the regulatory change
5499 * @type: Regulatory change type
5500 * @alpha2: Country code (or "" if not available)
5502 struct channel_list_changed
{
5503 enum reg_change_initiator initiator
;
5506 } channel_list_changed
;
5509 * freq_range - List of frequency ranges
5511 * This is used as the data with EVENT_AVOID_FREQUENCIES.
5513 struct wpa_freq_range_list freq_range
;
5518 * @peer: Peer address
5520 * @ie_len: Length of @ies
5522 * Notification of new candidate mesh peer.
5531 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
5532 * @pri_channel: Selected primary channel
5533 * @sec_channel: Selected secondary channel
5534 * @vht_seg0_center_ch: VHT mode Segment0 center channel
5535 * @vht_seg1_center_ch: VHT mode Segment1 center channel
5536 * @ch_width: Selected Channel width by driver. Driver may choose to
5537 * change hostapd configured ACS channel width due driver internal
5538 * channel restrictions.
5539 * hw_mode: Selected band (used with hw_mode=any)
5541 struct acs_selected_channels
{
5544 u8 vht_seg0_center_ch
;
5545 u8 vht_seg1_center_ch
;
5547 enum hostapd_hw_mode hw_mode
;
5548 } acs_selected_channels
;
5551 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
5552 * @reason_code: Reason for stopping offload
5553 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
5555 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
5557 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
5559 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
5560 * supported by device.
5562 struct p2p_lo_stop
{
5564 P2P_LO_STOPPED_REASON_COMPLETE
= 0,
5565 P2P_LO_STOPPED_REASON_RECV_STOP_CMD
,
5566 P2P_LO_STOPPED_REASON_INVALID_PARAM
,
5567 P2P_LO_STOPPED_REASON_NOT_SUPPORTED
,
5571 /* For EVENT_EXTERNAL_AUTH */
5572 struct external_auth external_auth
;
5575 * struct sta_opmode - Station's operation mode change event
5576 * @addr: The station MAC address
5577 * @smps_mode: SMPS mode of the station
5578 * @chan_width: Channel width of the station
5579 * @rx_nss: RX_NSS of the station
5581 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
5585 enum smps_mode smps_mode
;
5586 enum chan_width chan_width
;
5591 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
5593 struct wds_sta_interface
{
5600 } wds_sta_interface
;
5604 * wpa_supplicant_event - Report a driver event for wpa_supplicant
5605 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5606 * with struct wpa_driver_ops::init()
5607 * @event: event type (defined above)
5608 * @data: possible extra data for the event
5610 * Driver wrapper code should call this function whenever an event is received
5613 void wpa_supplicant_event(void *ctx
, enum wpa_event_type event
,
5614 union wpa_event_data
*data
);
5617 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
5618 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5619 * with struct wpa_driver_ops::init()
5620 * @event: event type (defined above)
5621 * @data: possible extra data for the event
5623 * Same as wpa_supplicant_event(), but we search for the interface in
5626 void wpa_supplicant_event_global(void *ctx
, enum wpa_event_type event
,
5627 union wpa_event_data
*data
);
5630 * The following inline functions are provided for convenience to simplify
5631 * event indication for some of the common events.
5634 static inline void drv_event_assoc(void *ctx
, const u8
*addr
, const u8
*ie
,
5635 size_t ielen
, int reassoc
)
5637 union wpa_event_data event
;
5638 os_memset(&event
, 0, sizeof(event
));
5639 event
.assoc_info
.reassoc
= reassoc
;
5640 event
.assoc_info
.req_ies
= ie
;
5641 event
.assoc_info
.req_ies_len
= ielen
;
5642 event
.assoc_info
.addr
= addr
;
5643 wpa_supplicant_event(ctx
, EVENT_ASSOC
, &event
);
5646 static inline void drv_event_disassoc(void *ctx
, const u8
*addr
)
5648 union wpa_event_data event
;
5649 os_memset(&event
, 0, sizeof(event
));
5650 event
.disassoc_info
.addr
= addr
;
5651 wpa_supplicant_event(ctx
, EVENT_DISASSOC
, &event
);
5654 static inline void drv_event_eapol_rx(void *ctx
, const u8
*src
, const u8
*data
,
5657 union wpa_event_data event
;
5658 os_memset(&event
, 0, sizeof(event
));
5659 event
.eapol_rx
.src
= src
;
5660 event
.eapol_rx
.data
= data
;
5661 event
.eapol_rx
.data_len
= data_len
;
5662 wpa_supplicant_event(ctx
, EVENT_EAPOL_RX
, &event
);
5665 /* driver_common.c */
5666 void wpa_scan_results_free(struct wpa_scan_results
*res
);
5668 /* Convert wpa_event_type to a string for logging */
5669 const char * event_to_string(enum wpa_event_type event
);
5671 /* Convert chan_width to a string for logging and control interfaces */
5672 const char * channel_width_to_string(enum chan_width width
);
5674 int channel_width_to_int(enum chan_width width
);
5676 int ht_supported(const struct hostapd_hw_modes
*mode
);
5677 int vht_supported(const struct hostapd_hw_modes
*mode
);
5679 struct wowlan_triggers
*
5680 wpa_get_wowlan_triggers(const char *wowlan_triggers
,
5681 const struct wpa_driver_capa
*capa
);
5682 /* Convert driver flag to string */
5683 const char * driver_flag_to_string(u64 flag
);
5685 /* NULL terminated array of linked in driver wrappers */
5686 extern const struct wpa_driver_ops
*const wpa_drivers
[];
5689 /* Available drivers */
5691 #ifdef CONFIG_DRIVER_WEXT
5692 extern const struct wpa_driver_ops wpa_driver_wext_ops
; /* driver_wext.c */
5693 #endif /* CONFIG_DRIVER_WEXT */
5694 #ifdef CONFIG_DRIVER_NL80211
5695 /* driver_nl80211.c */
5696 extern const struct wpa_driver_ops wpa_driver_nl80211_ops
;
5697 #endif /* CONFIG_DRIVER_NL80211 */
5698 #ifdef CONFIG_DRIVER_HOSTAP
5699 extern const struct wpa_driver_ops wpa_driver_hostap_ops
; /* driver_hostap.c */
5700 #endif /* CONFIG_DRIVER_HOSTAP */
5701 #ifdef CONFIG_DRIVER_BSD
5702 extern const struct wpa_driver_ops wpa_driver_bsd_ops
; /* driver_bsd.c */
5703 #endif /* CONFIG_DRIVER_BSD */
5704 #ifdef CONFIG_DRIVER_OPENBSD
5705 /* driver_openbsd.c */
5706 extern const struct wpa_driver_ops wpa_driver_openbsd_ops
;
5707 #endif /* CONFIG_DRIVER_OPENBSD */
5708 #ifdef CONFIG_DRIVER_NDIS
5709 extern struct wpa_driver_ops wpa_driver_ndis_ops
; /* driver_ndis.c */
5710 #endif /* CONFIG_DRIVER_NDIS */
5711 #ifdef CONFIG_DRIVER_WIRED
5712 extern const struct wpa_driver_ops wpa_driver_wired_ops
; /* driver_wired.c */
5713 #endif /* CONFIG_DRIVER_WIRED */
5714 #ifdef CONFIG_DRIVER_MACSEC_QCA
5715 /* driver_macsec_qca.c */
5716 extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops
;
5717 #endif /* CONFIG_DRIVER_MACSEC_QCA */
5718 #ifdef CONFIG_DRIVER_MACSEC_LINUX
5719 /* driver_macsec_linux.c */
5720 extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops
;
5721 #endif /* CONFIG_DRIVER_MACSEC_LINUX */
5722 #ifdef CONFIG_DRIVER_ROBOSWITCH
5723 /* driver_roboswitch.c */
5724 extern const struct wpa_driver_ops wpa_driver_roboswitch_ops
;
5725 #endif /* CONFIG_DRIVER_ROBOSWITCH */
5726 #ifdef CONFIG_DRIVER_ATHEROS
5727 /* driver_atheros.c */
5728 extern const struct wpa_driver_ops wpa_driver_atheros_ops
;
5729 #endif /* CONFIG_DRIVER_ATHEROS */
5730 #ifdef CONFIG_DRIVER_NONE
5731 extern const struct wpa_driver_ops wpa_driver_none_ops
; /* driver_none.c */
5732 #endif /* CONFIG_DRIVER_NONE */
5734 #endif /* DRIVER_H */