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_MAC_CAPAB_0 0
186 #define HE_MAX_MAC_CAPAB_SIZE 6
187 #define HE_MAX_PHY_CAPAB_SIZE 11
188 #define HE_MAX_MCS_CAPAB_SIZE 12
189 #define HE_MAX_PPET_CAPAB_SIZE 25
192 * struct he_capabilities - IEEE 802.11ax HE capabilities
194 struct he_capabilities
{
196 u8 phy_cap
[HE_MAX_PHY_CAPAB_SIZE
];
197 u8 mac_cap
[HE_MAX_MAC_CAPAB_SIZE
];
198 u8 mcs
[HE_MAX_MCS_CAPAB_SIZE
];
199 u8 ppet
[HE_MAX_PPET_CAPAB_SIZE
];
202 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
203 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
206 enum ieee80211_op_mode
{
207 IEEE80211_MODE_INFRA
= 0,
208 IEEE80211_MODE_IBSS
= 1,
209 IEEE80211_MODE_AP
= 2,
210 IEEE80211_MODE_MESH
= 5,
212 /* only add new entries before IEEE80211_MODE_NUM */
217 * struct ieee80211_edmg_config - EDMG configuration
219 * This structure describes most essential parameters needed
220 * for IEEE 802.11ay EDMG configuration
222 * @channels: Bitmap that indicates the 2.16 GHz channel(s)
223 * that are allowed to be used for transmissions.
224 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
225 * Set to 0 to indicate EDMG not supported.
226 * @bw_config: Channel BW Configuration subfield encodes
227 * the allowed channel bandwidth configurations
229 struct ieee80211_edmg_config
{
231 enum edmg_bw_config bw_config
;
235 * struct hostapd_hw_modes - Supported hardware mode information
237 struct hostapd_hw_modes
{
239 * mode - Hardware mode
241 enum hostapd_hw_mode mode
;
244 * num_channels - Number of entries in the channels array
249 * channels - Array of supported channels
251 struct hostapd_channel_data
*channels
;
254 * num_rates - Number of entries in the rates array
259 * rates - Array of supported rates in 100 kbps units
264 * ht_capab - HT (IEEE 802.11n) capabilities
269 * mcs_set - MCS (IEEE 802.11n) rate parameters
274 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
279 * vht_capab - VHT (IEEE 802.11ac) capabilities
284 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
288 unsigned int flags
; /* HOSTAPD_MODE_FLAG_* */
291 * he_capab - HE (IEEE 802.11ax) capabilities
293 struct he_capabilities he_capab
[IEEE80211_MODE_NUM
];
296 * This structure describes the most essential parameters needed
297 * for IEEE 802.11ay EDMG configuration.
299 struct ieee80211_edmg_config edmg
;
303 #define IEEE80211_CAP_ESS 0x0001
304 #define IEEE80211_CAP_IBSS 0x0002
305 #define IEEE80211_CAP_PRIVACY 0x0010
306 #define IEEE80211_CAP_RRM 0x1000
308 /* DMG (60 GHz) IEEE 802.11ad */
309 /* type - bits 0..1 */
310 #define IEEE80211_CAP_DMG_MASK 0x0003
311 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
312 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
313 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
315 #define WPA_SCAN_QUAL_INVALID BIT(0)
316 #define WPA_SCAN_NOISE_INVALID BIT(1)
317 #define WPA_SCAN_LEVEL_INVALID BIT(2)
318 #define WPA_SCAN_LEVEL_DBM BIT(3)
319 #define WPA_SCAN_ASSOCIATED BIT(5)
322 * struct wpa_scan_res - Scan result for an BSS/IBSS
323 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
325 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
326 * @beacon_int: beacon interval in TUs (host byte order)
327 * @caps: capability information field in host byte order
328 * @qual: signal quality
329 * @noise: noise level
330 * @level: signal level
332 * @age: Age of the information in milliseconds (i.e., how many milliseconds
333 * ago the last Beacon or Probe Response frame was received)
334 * @est_throughput: Estimated throughput in kbps (this is calculated during
335 * scan result processing if left zero by the driver wrapper)
336 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
337 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
338 * of TSF of the BSS specified by %tsf_bssid.
339 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
340 * @ie_len: length of the following IE field in octets
341 * @beacon_ie_len: length of the following Beacon IE field in octets
343 * This structure is used as a generic format for scan results from the
344 * driver. Each driver interface implementation is responsible for converting
345 * the driver or OS specific scan results into this format.
347 * If the driver does not support reporting all IEs, the IE data structure is
348 * constructed of the IEs that are available. This field will also need to
349 * include SSID in IE format. All drivers are encouraged to be extended to
350 * report all IEs to make it easier to support future additions.
352 * This structure data is followed by ie_len octets of IEs from Probe Response
353 * frame (or if the driver does not indicate source of IEs, these may also be
354 * from Beacon frame). After the first set of IEs, another set of IEs may follow
355 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
357 struct wpa_scan_res
{
368 unsigned int est_throughput
;
371 u8 tsf_bssid
[ETH_ALEN
];
373 size_t beacon_ie_len
;
374 /* Followed by ie_len + beacon_ie_len octets of IE data */
378 * struct wpa_scan_results - Scan results
379 * @res: Array of pointers to allocated variable length scan result entries
380 * @num: Number of entries in the scan result array
381 * @fetch_time: Time when the results were fetched from the driver
383 struct wpa_scan_results
{
384 struct wpa_scan_res
**res
;
386 struct os_reltime fetch_time
;
390 * struct wpa_interface_info - Network interface information
391 * @next: Pointer to the next interface or NULL if this is the last one
392 * @ifname: Interface name that can be used with init() or init2()
393 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
395 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
396 * is not an allocated copy, i.e., get_interfaces() caller will not free
399 struct wpa_interface_info
{
400 struct wpa_interface_info
*next
;
403 const char *drv_name
;
406 #define WPAS_MAX_SCAN_SSIDS 16
409 * struct wpa_driver_scan_ssid - SSIDs to scan for
410 * @ssid - specific SSID to scan for (ProbeReq)
411 * %NULL or zero-length SSID is used to indicate active scan
412 * with wildcard SSID.
413 * @ssid_len - Length of the SSID in octets
415 struct wpa_driver_scan_ssid
{
421 * struct wpa_driver_scan_params - Scan parameters
422 * Data for struct wpa_driver_ops::scan2().
424 struct wpa_driver_scan_params
{
426 * ssids - SSIDs to scan for
428 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
431 * num_ssids - Number of entries in ssids array
432 * Zero indicates a request for a passive scan.
437 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
442 * extra_ies_len - Length of extra_ies in octets
444 size_t extra_ies_len
;
447 * freqs - Array of frequencies to scan or %NULL for all frequencies
449 * The frequency is set in MHz. The array is zero-terminated.
454 * filter_ssids - Filter for reporting SSIDs
456 * This optional parameter can be used to request the driver wrapper to
457 * filter scan results to include only the specified SSIDs. %NULL
458 * indicates that no filtering is to be done. This can be used to
459 * reduce memory needs for scan results in environments that have large
460 * number of APs with different SSIDs.
462 * The driver wrapper is allowed to take this allocated buffer into its
463 * own use by setting the pointer to %NULL. In that case, the driver
464 * wrapper is responsible for freeing the buffer with os_free() once it
465 * is not needed anymore.
467 struct wpa_driver_scan_filter
{
468 u8 ssid
[SSID_MAX_LEN
];
473 * num_filter_ssids - Number of entries in filter_ssids array
475 size_t num_filter_ssids
;
478 * filter_rssi - Filter by RSSI
480 * The driver may filter scan results in firmware to reduce host
481 * wakeups and thereby save power. Specify the RSSI threshold in s32
487 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
489 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
490 * Mbps from the support rates element(s) in the Probe Request frames
491 * and not to transmit the frames at any of those rates.
493 unsigned int p2p_probe
:1;
496 * only_new_results - Request driver to report only new results
498 * This is used to request the driver to report only BSSes that have
499 * been detected after this scan request has been started, i.e., to
500 * flush old cached BSS entries.
502 unsigned int only_new_results
:1;
505 * low_priority - Requests driver to use a lower scan priority
507 * This is used to request the driver to use a lower scan priority
508 * if it supports such a thing.
510 unsigned int low_priority
:1;
513 * mac_addr_rand - Requests driver to randomize MAC address
515 unsigned int mac_addr_rand
:1;
518 * mac_addr - MAC address used with randomization. The address cannot be
519 * a multicast one, i.e., bit 0 of byte 0 should not be set.
524 * mac_addr_mask - MAC address mask used with randomization.
526 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
527 * the mask should be taken as is from mac_addr. The mask should not
528 * allow the generation of a multicast address, i.e., bit 0 of byte 0
531 const u8
*mac_addr_mask
;
534 * sched_scan_plans - Scan plans for scheduled scan
536 * Each scan plan consists of the number of iterations to scan and the
537 * interval between scans. When a scan plan finishes (i.e., it was run
538 * for the specified number of iterations), the next scan plan is
539 * executed. The scan plans are executed in the order they appear in
540 * the array (lower index first). The last scan plan will run infinitely
541 * (until requested to stop), thus must not specify the number of
542 * iterations. All other scan plans must specify the number of
545 struct sched_scan_plan
{
546 u32 interval
; /* In seconds */
547 u32 iterations
; /* Zero to run infinitely */
551 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
553 unsigned int sched_scan_plans_num
;
556 * sched_scan_start_delay - Delay to use before starting the first scan
558 * Delay (in seconds) before scheduling first scan plan cycle. The
559 * driver may ignore this parameter and start immediately (or at any
560 * other time), if this feature is not supported.
562 u32 sched_scan_start_delay
;
565 * bssid - Specific BSSID to scan for
567 * This optional parameter can be used to replace the default wildcard
568 * BSSID with a specific BSSID to scan for if results are needed from
574 * scan_cookie - Unique identification representing the scan request
576 * This scan_cookie carries a unique identification representing the
577 * scan request if the host driver/kernel supports concurrent scan
578 * requests. This cookie is returned from the corresponding driver
581 * Note: Unlike other parameters in this structure, scan_cookie is used
582 * only to return information instead of setting parameters for the
588 * duration - Dwell time on each channel
590 * This optional parameter can be used to set the dwell time on each
596 * duration_mandatory - Whether the specified duration is mandatory
598 * If this is set, the duration specified by the %duration field is
599 * mandatory (and the driver should reject the scan request if it is
600 * unable to comply with the specified duration), otherwise it is the
601 * maximum duration and the actual duration may be shorter.
603 unsigned int duration_mandatory
:1;
606 * relative_rssi_set - Whether relative RSSI parameters are set
608 unsigned int relative_rssi_set
:1;
611 * relative_rssi - Relative RSSI for reporting better BSSs
613 * Amount of RSSI by which a BSS should be better than the current
614 * connected BSS to report the new BSS to user space.
619 * relative_adjust_band - Band to which RSSI should be adjusted
621 * The relative_adjust_rssi should be added to the band specified
622 * by relative_adjust_band.
624 enum set_band relative_adjust_band
;
627 * relative_adjust_rssi - RSSI to be added to relative_adjust_band
629 * An amount of relative_band_rssi should be added to the BSSs that
630 * belong to the band specified by relative_adjust_band while comparing
631 * with other bands for BSS reporting.
633 s8 relative_adjust_rssi
;
638 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0)
639 * - Accept broadcast Probe Response frame.
640 * - Probe Request frame deferral and suppression.
641 * - Max Channel Time - driver fills FILS request params IE with
642 * Maximum Channel Time.
643 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps.
645 unsigned int oce_scan
:1;
648 * NOTE: Whenever adding new parameters here, please make sure
649 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
655 * struct wpa_driver_auth_params - Authentication parameters
656 * Data for struct wpa_driver_ops::authenticate().
658 struct wpa_driver_auth_params
{
666 const u8
*wep_key
[4];
667 size_t wep_key_len
[4];
669 int local_state_change
;
672 * p2p - Whether this connection is a P2P group
677 * auth_data - Additional elements for Authentication frame
679 * This buffer starts with the Authentication transaction sequence
680 * number field. If no special handling of such elements is needed, this
681 * pointer is %NULL. This is used with SAE and FILS.
686 * auth_data_len - Length of auth_data buffer in octets
688 size_t auth_data_len
;
692 * enum wps_mode - WPS mode
696 * WPS_MODE_NONE - No WPS provisioning being used
701 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
706 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
712 * struct hostapd_freq_params - Channel parameters
714 struct hostapd_freq_params
{
716 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
718 enum hostapd_hw_mode mode
;
721 * freq - Primary channel center frequency in MHz
726 * channel - Channel number
731 * ht_enabled - Whether HT is enabled
736 * sec_channel_offset - Secondary channel offset for HT40
739 * -1 = HT40 enabled, secondary channel below primary,
740 * 1 = HT40 enabled, secondary channel above primary
742 int sec_channel_offset
;
745 * vht_enabled - Whether VHT is enabled
750 * he_enabled - Whether HE is enabled
755 * center_freq1 - Segment 0 center frequency in MHz
757 * Valid for both HT and VHT.
762 * center_freq2 - Segment 1 center frequency in MHz
764 * Non-zero only for bandwidth 80 and an 80+80 channel
769 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
774 * This structure describes the most essential parameters needed
775 * for IEEE 802.11ay EDMG configuration.
777 struct ieee80211_edmg_config edmg
;
781 * struct wpa_driver_sta_auth_params - Authentication parameters
782 * Data for struct wpa_driver_ops::sta_auth().
784 struct wpa_driver_sta_auth_params
{
787 * own_addr - Source address and BSSID for authentication frame
792 * addr - MAC address of the station to associate
797 * seq - authentication sequence number
802 * status - authentication response status code
807 * ie - authentication frame ie buffer
812 * len - ie buffer length
817 * fils_auth - Indicates whether FILS authentication is being performed
822 * fils_anonce - ANonce (required for FILS)
824 u8 fils_anonce
[WPA_NONCE_LEN
];
827 * fils_snonce - SNonce (required for FILS)
829 u8 fils_snonce
[WPA_NONCE_LEN
];
832 * fils_kek - key for encryption (required for FILS)
834 u8 fils_kek
[WPA_KEK_MAX_LEN
];
837 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
843 * struct wpa_driver_associate_params - Association parameters
844 * Data for struct wpa_driver_ops::associate().
846 struct wpa_driver_associate_params
{
848 * bssid - BSSID of the selected AP
849 * This can be %NULL, if ap_scan=2 mode is used and the driver is
850 * responsible for selecting with which BSS to associate. */
854 * bssid_hint - BSSID of a proposed AP
856 * This indicates which BSS has been found a suitable candidate for
857 * initial association for drivers that use driver/firmwate-based BSS
858 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
859 * the driver from selecting other BSSes in the ESS.
861 const u8
*bssid_hint
;
864 * ssid - The selected SSID
869 * ssid_len - Length of the SSID (1..32)
874 * freq - channel parameters
876 struct hostapd_freq_params freq
;
879 * freq_hint - Frequency of the channel the proposed AP is using
881 * This provides a channel on which a suitable BSS has been found as a
882 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
883 * limit the driver from selecting other channels for
884 * driver/firmware-based BSS selection.
889 * bg_scan_period - Background scan period in seconds, 0 to disable
890 * background scan, or -1 to indicate no change to default driver
896 * beacon_int - Beacon interval for IBSS or 0 to use driver default
901 * wpa_ie - WPA information element for (Re)Association Request
902 * WPA information element to be included in (Re)Association
903 * Request (including information element id and length). Use
904 * of this WPA IE is optional. If the driver generates the WPA
905 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
906 * key_mgmt_suite to select proper algorithms. In this case,
907 * the driver has to notify wpa_supplicant about the used WPA
908 * IE by generating an event that the interface code will
909 * convert into EVENT_ASSOCINFO data (see below).
911 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
912 * instead. The driver can determine which version is used by
913 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
916 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
921 * wpa_ie_len - length of the wpa_ie
926 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
928 unsigned int wpa_proto
;
931 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
933 * This is usually ignored if @wpa_ie is used.
935 unsigned int pairwise_suite
;
938 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
940 * This is usually ignored if @wpa_ie is used.
942 unsigned int group_suite
;
945 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
947 * This is usually ignored if @wpa_ie is used.
949 unsigned int mgmt_group_suite
;
952 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
954 * This is usually ignored if @wpa_ie is used.
956 unsigned int key_mgmt_suite
;
959 * auth_alg - Allowed authentication algorithms
960 * Bit field of WPA_AUTH_ALG_*
965 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
970 * wep_key - WEP keys for static WEP configuration
972 const u8
*wep_key
[4];
975 * wep_key_len - WEP key length for static WEP configuration
977 size_t wep_key_len
[4];
980 * wep_tx_keyidx - WEP TX key index for static WEP configuration
985 * mgmt_frame_protection - IEEE 802.11w management frame protection
987 enum mfp_options mgmt_frame_protection
;
990 * passphrase - RSN passphrase for PSK
992 * This value is made available only for WPA/WPA2-Personal (PSK) and
993 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
994 * is the 8..63 character ASCII passphrase, if available. Please note
995 * that this can be %NULL if passphrase was not used to generate the
996 * PSK. In that case, the psk field must be used to fetch the PSK.
998 const char *passphrase
;
1001 * psk - RSN PSK (alternative for passphrase for PSK)
1003 * This value is made available only for WPA/WPA2-Personal (PSK) and
1004 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
1005 * is the 32-octet (256-bit) PSK, if available. The driver wrapper
1006 * should be prepared to handle %NULL value as an error.
1011 * drop_unencrypted - Enable/disable unencrypted frame filtering
1013 * Configure the driver to drop all non-EAPOL frames (both receive and
1014 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
1015 * still be allowed for key negotiation.
1017 int drop_unencrypted
;
1020 * prev_bssid - Previously used BSSID in this ESS
1022 * When not %NULL, this is a request to use reassociation instead of
1025 const u8
*prev_bssid
;
1030 * If the driver needs to do special configuration for WPS association,
1031 * this variable provides more information on what type of association
1032 * is being requested. Most drivers should not need ot use this.
1037 * p2p - Whether this connection is a P2P group
1042 * uapsd - UAPSD parameters for the network
1043 * -1 = do not change defaults
1044 * AP mode: 1 = enabled, 0 = disabled
1045 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
1050 * fixed_bssid - Whether to force this BSSID in IBSS mode
1051 * 1 = Fix this BSSID and prevent merges.
1052 * 0 = Do not fix BSSID.
1057 * fixed_freq - Fix control channel in IBSS mode
1058 * 0 = don't fix control channel (default)
1059 * 1 = fix control channel; this prevents IBSS merging with another
1065 * disable_ht - Disable HT (IEEE 802.11n) for this connection
1070 * htcaps - HT Capabilities over-rides
1072 * Only bits set in the mask will be used, and not all values are used
1073 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
1075 * Pointer to struct ieee80211_ht_capabilities.
1080 * htcaps_mask - HT Capabilities over-rides mask
1082 * Pointer to struct ieee80211_ht_capabilities.
1084 const u8
*htcaps_mask
;
1086 #ifdef CONFIG_VHT_OVERRIDES
1088 * disable_vht - Disable VHT for this connection
1093 * VHT capability overrides.
1095 const struct ieee80211_vht_capabilities
*vhtcaps
;
1096 const struct ieee80211_vht_capabilities
*vhtcaps_mask
;
1097 #endif /* CONFIG_VHT_OVERRIDES */
1100 * req_key_mgmt_offload - Request key management offload for connection
1102 * Request key management offload for this connection if the device
1105 int req_key_mgmt_offload
;
1108 * req_handshake_offload - Request EAPOL handshake offload
1110 * Request EAPOL handshake offload for this connection if the device
1113 int req_handshake_offload
;
1116 * Flag for indicating whether this association includes support for
1117 * RRM (Radio Resource Measurements)
1122 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1123 * AP as usual. Valid for DMG network only.
1128 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1133 * fils_kek_len: Length of fils_kek in bytes
1135 size_t fils_kek_len
;
1138 * fils_nonces - Nonces for FILS association frame protection
1141 const u8
*fils_nonces
;
1144 * fils_nonces_len: Length of fils_nonce in bytes
1146 size_t fils_nonces_len
;
1149 * fils_erp_username - Username part of keyName-NAI
1151 const u8
*fils_erp_username
;
1154 * fils_erp_username_len - Length of fils_erp_username in bytes
1156 size_t fils_erp_username_len
;
1159 * fils_erp_realm - Realm/domain name to use in FILS ERP
1161 const u8
*fils_erp_realm
;
1164 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1166 size_t fils_erp_realm_len
;
1169 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1172 u16 fils_erp_next_seq_num
;
1175 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1176 * specified by fils_erp_username@fils_erp_realm.
1178 const u8
*fils_erp_rrk
;
1181 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1183 size_t fils_erp_rrk_len
;
1188 HIDDEN_SSID_ZERO_LEN
,
1189 HIDDEN_SSID_ZERO_CONTENTS
1192 enum ch_switch_state
{
1197 struct wowlan_triggers
{
1201 u8 gtk_rekey_failure
;
1202 u8 eap_identity_req
;
1203 u8 four_way_handshake
;
1207 struct wpa_driver_ap_params
{
1209 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1214 * head_len - Length of the head buffer in octets
1219 * tail - Beacon tail following TIM IE
1224 * tail_len - Length of the tail buffer in octets
1229 * dtim_period - DTIM period
1234 * beacon_int - Beacon interval
1239 * basic_rates: -1 terminated array of basic rates in 100 kbps
1241 * This parameter can be used to set a specific basic rate set for the
1242 * BSS. If %NULL, default basic rate set is used.
1247 * beacon_rate: Beacon frame data rate
1249 * This parameter can be used to set a specific Beacon frame data rate
1250 * for the BSS. The interpretation of this value depends on the
1251 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS). If
1252 * beacon_rate == 0 and rate_type == 0 (BEACON_RATE_LEGACY), the default
1253 * Beacon frame data rate is used.
1255 unsigned int beacon_rate
;
1258 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT)
1260 enum beacon_rate_type rate_type
;
1263 * proberesp - Probe Response template
1265 * This is used by drivers that reply to Probe Requests internally in
1266 * AP mode and require the full Probe Response template.
1271 * proberesp_len - Length of the proberesp buffer in octets
1273 size_t proberesp_len
;
1276 * ssid - The SSID to use in Beacon/Probe Response frames
1281 * ssid_len - Length of the SSID (1..32)
1286 * hide_ssid - Whether to hide the SSID
1288 enum hide_ssid hide_ssid
;
1291 * pairwise_ciphers - WPA_CIPHER_* bitfield
1293 unsigned int pairwise_ciphers
;
1296 * group_cipher - WPA_CIPHER_*
1298 unsigned int group_cipher
;
1301 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1303 unsigned int key_mgmt_suites
;
1306 * auth_algs - WPA_AUTH_ALG_* bitfield
1308 unsigned int auth_algs
;
1311 * wpa_version - WPA_PROTO_* bitfield
1313 unsigned int wpa_version
;
1316 * privacy - Whether privacy is used in the BSS
1321 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1323 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1324 * not use the full Beacon template.
1326 const struct wpabuf
*beacon_ies
;
1329 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1331 * This is used to add IEs like WPS IE and P2P IE by drivers that
1332 * reply to Probe Request frames internally.
1334 const struct wpabuf
*proberesp_ies
;
1337 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1339 * This is used to add IEs like WPS IE by drivers that reply to
1340 * (Re)Association Request frames internally.
1342 const struct wpabuf
*assocresp_ies
;
1345 * isolate - Whether to isolate frames between associated stations
1347 * If this is non-zero, the AP is requested to disable forwarding of
1348 * frames between associated stations.
1353 * cts_protect - Whether CTS protection is enabled
1358 * preamble - Whether short preamble is enabled
1363 * short_slot_time - Whether short slot time is enabled
1365 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1366 * not set (e.g., when 802.11g mode is not in use)
1368 int short_slot_time
;
1371 * ht_opmode - HT operation mode or -1 if HT not in use
1376 * interworking - Whether Interworking is enabled
1381 * hessid - Homogeneous ESS identifier or %NULL if not set
1386 * access_network_type - Access Network Type (0..15)
1388 * This is used for filtering Probe Request frames when Interworking is
1391 u8 access_network_type
;
1394 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1396 * This is used by driver which advertises this capability.
1398 int ap_max_inactivity
;
1401 * ctwindow - Client Traffic Window (in TUs)
1406 * disable_dgaf - Whether group-addressed frames are disabled
1411 * osen - Whether OSEN security is enabled
1416 * freq - Channel parameters for dynamic bandwidth changes
1418 struct hostapd_freq_params
*freq
;
1421 * reenable - Whether this is to re-enable beaconing
1426 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1427 * infrastructure BSS. Valid only for DMG network.
1432 * multicast_to_unicast - Whether to use multicast_to_unicast
1434 * If this is non-zero, the AP is requested to perform multicast to
1435 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1436 * 802.1Q). If enabled, such frames are to be sent to each station
1437 * separately, with the DA replaced by their own MAC address rather
1438 * than the group address.
1440 * Note that this may break certain expectations of the receiver, such
1441 * as the ability to drop unicast IP packets received within multicast
1442 * L2 frames, or the ability to not send ICMP destination unreachable
1443 * messages for packets received in L2 multicast (which is required,
1444 * but the receiver can't tell the difference if this new option is
1447 * This also doesn't implement the 802.11 DMS (directed multicast
1450 int multicast_to_unicast
;
1453 * ftm_responder - Whether FTM responder is enabled
1458 * lci - Binary data, the content of an LCI report IE with type 8 as
1459 * defined in IEEE Std 802.11-2016, 9.4.2.22.10
1461 const struct wpabuf
*lci
;
1464 * civic - Binary data, the content of a measurement report IE with
1465 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
1467 const struct wpabuf
*civic
;
1470 * he_spr - Whether Spatial Reuse is enabled
1475 * he_spr_srg_obss_pd_min_offset - Minimum TX power offset
1477 int he_spr_srg_obss_pd_min_offset
;
1480 * he_spr_srg_obss_pd_max_offset - Maximum TX power offset
1482 int he_spr_srg_obss_pd_max_offset
;
1485 * he_bss_color - Whether the BSS Color is disabled
1487 int he_bss_color_disabled
;
1490 * he_bss_color_partial - The BSS Color AID equation
1492 int he_bss_color_partial
;
1495 * he_bss_color - The BSS Color of the AP
1500 * twt_responder - Whether Target Wait Time responder is enabled
1505 struct wpa_driver_mesh_bss_params
{
1506 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1507 #define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1508 #define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1509 #define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
1510 #define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010
1512 * TODO: Other mesh configuration parameters would go here.
1513 * See NL80211_MESHCONF_* for all the mesh config parameters.
1517 int peer_link_timeout
;
1523 struct wpa_driver_mesh_join_params
{
1526 const int *basic_rates
;
1529 struct hostapd_freq_params freq
;
1532 struct wpa_driver_mesh_bss_params conf
;
1533 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1534 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1535 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1536 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1540 struct wpa_driver_set_key_params
{
1542 * ifname - Interface name (for multi-SSID/VLAN support) */
1546 * alg - Encryption algorithm
1548 * (%WPA_ALG_NONE, %WPA_ALG_WEP, %WPA_ALG_TKIP, %WPA_ALG_CCMP,
1549 * %WPA_ALG_IGTK, %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1550 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256, %WPA_ALG_BIP_CMAC_256);
1551 * %WPA_ALG_NONE clears the key. */
1555 * addr - Address of the peer STA
1557 * (BSSID of the current AP when setting pairwise key in station mode),
1558 * ff:ff:ff:ff:ff:ff for broadcast keys, %NULL for default keys that
1559 * are used both for broadcast and unicast; when clearing keys, %NULL
1560 * is used to indicate that both the broadcast-only and default key of
1561 * the specified key index is to be cleared */
1565 * key_idx - Key index
1567 * (0..3), usually 0 for unicast keys; 4..5 for IGTK; 6..7 for BIGTK */
1571 * set_tx - Configure this key as the default Tx key
1573 * Only used when driver does not support separate unicast/individual
1578 * seq - Sequence number/packet number
1580 * seq_len octets, the next packet number to be used for in replay
1581 * protection; configured for Rx keys (in most cases, this is only used
1582 * with broadcast keys and set to zero for unicast keys); %NULL if not
1587 * seq_len - Length of the seq, depends on the algorithm
1589 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets */
1595 * TKIP: 16-byte temporal key, 8-byte Tx Mic key, 8-byte Rx Mic Key */
1599 * key_len - Length of the key buffer in octets
1601 * WEP: 5 or 13, TKIP: 32, CCMP/GCMP: 16, IGTK: 16 */
1605 * vlan_id - VLAN index (0..4095) for VLAN offload cases */
1609 * key_flag - Additional key flags
1612 * Set when an already installed key must be updated.
1613 * So far the only use-case is changing RX/TX status for
1614 * pairwise keys. Must not be set when deleting a key.
1616 * Set when the key is also a default key. Must not be set when
1619 * The key is valid for RX. Must not be set when deleting a key.
1621 * The key is valid for TX. Must not be set when deleting a key.
1623 * The key is a broadcast or group key.
1624 * %KEY_FLAG_PAIRWISE
1625 * The key is a pairwise key.
1627 * The key is a Pairwise Master Key (PMK).
1629 * Valid and pre-defined combinations are:
1630 * %KEY_FLAG_GROUP_RX_TX
1631 * WEP key not to be installed as default key.
1632 * %KEY_FLAG_GROUP_RX_TX_DEFAULT
1633 * Default WEP or WPA-NONE key.
1634 * %KEY_FLAG_GROUP_RX
1635 * GTK key valid for RX only.
1636 * %KEY_FLAG_GROUP_TX_DEFAULT
1637 * GTK key valid for TX only, immediately taking over TX.
1638 * %KEY_FLAG_PAIRWISE_RX_TX
1639 * Pairwise key immediately becoming the active pairwise key.
1640 * %KEY_FLAG_PAIRWISE_RX
1641 * Pairwise key not yet valid for TX. (Only usable when Extended
1642 * Key ID is supported by the driver.)
1643 * %KEY_FLAG_PAIRWISE_RX_TX_MODIFY
1644 * Enable TX for a pairwise key installed with
1645 * KEY_FLAG_PAIRWISE_RX.
1647 * Not a valid standalone key type but pre-defined to be combined
1648 * with other key_flags:
1651 enum key_flag key_flag
;
1655 * struct wpa_driver_capa - Driver capability information
1657 struct wpa_driver_capa
{
1658 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1659 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1660 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1661 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1662 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1663 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1664 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1665 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1666 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1667 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
1668 #define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
1669 #define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
1670 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1671 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1672 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1673 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
1674 #define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000
1675 /** Bitfield of supported key management suites */
1676 unsigned int key_mgmt
;
1678 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1679 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1680 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1681 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1682 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1683 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1684 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1685 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1686 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1687 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1688 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1689 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1690 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1691 /** Bitfield of supported cipher suites */
1694 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1695 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1696 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1697 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1700 /** Driver generated WPA/RSN IE */
1701 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1702 /** Driver needs static WEP key setup after association command */
1703 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1704 /** Driver takes care of all DFS operations */
1705 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1706 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1707 * struct wpa_driver_ops::set_key using key_flag = KEY_FLAG_PMK */
1708 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008
1709 /** Driver is for a wired Ethernet interface */
1710 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1711 /** Driver provides separate commands for authentication and association (SME in
1712 * wpa_supplicant). */
1713 #define WPA_DRIVER_FLAGS_SME 0x00000020
1714 /** Driver supports AP mode */
1715 #define WPA_DRIVER_FLAGS_AP 0x00000040
1716 /** Driver needs static WEP key setup after association has been completed */
1717 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1718 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1719 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1720 /** Driver supports concurrent P2P operations */
1721 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1723 * Driver uses the initial interface as a dedicated management interface, i.e.,
1724 * it cannot be used for P2P group operations or non-P2P purposes.
1726 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1727 /** This interface is P2P capable (P2P GO or P2P Client) */
1728 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1729 /** Driver supports station and key removal when stopping an AP */
1730 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1732 * Driver uses the initial interface for P2P management interface and non-P2P
1733 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1734 * P2P group operations.
1736 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1738 * Driver is known to use sane error codes, i.e., when it indicates that
1739 * something (e.g., association) fails, there was indeed a failure and the
1740 * operation does not end up getting completed successfully later.
1742 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1743 /** Driver supports off-channel TX */
1744 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1745 /** Driver indicates TX status events for EAPOL Data frames */
1746 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1747 /** Driver indicates TX status events for Deauth/Disassoc frames */
1748 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1749 /** Driver supports roaming (BSS selection) in firmware */
1750 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1751 /** Driver supports operating as a TDLS peer */
1752 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1753 /** Driver requires external TDLS setup/teardown/discovery */
1754 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1755 /** Driver indicates support for Probe Response offloading in AP mode */
1756 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1757 /** Driver supports U-APSD in AP mode */
1758 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1759 /** Driver supports inactivity timer in AP mode */
1760 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1761 /** Driver expects user space implementation of MLME in AP mode */
1762 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1763 /** Driver supports SAE with user space SME */
1764 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1765 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1766 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1767 /** Driver supports IBSS (Ad-hoc) mode */
1768 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1769 /** Driver supports radar detection */
1770 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1771 /** Driver supports a dedicated interface for P2P Device */
1772 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1773 /** Driver supports QoS Mapping */
1774 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1775 /** Driver supports CSA in AP mode */
1776 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1777 /** Driver supports mesh */
1778 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1779 /** Driver support ACS offload */
1780 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1781 /** Driver supports key management offload */
1782 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1783 /** Driver supports TDLS channel switching */
1784 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1785 /** Driver supports IBSS with HT datarates */
1786 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
1787 /** Driver supports IBSS with VHT datarates */
1788 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
1789 /** Driver supports automatic band selection */
1790 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
1791 /** Driver supports simultaneous off-channel operations */
1792 #define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
1793 /** Driver supports full AP client state */
1794 #define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
1795 /** Driver supports P2P Listen offload */
1796 #define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
1797 /** Driver supports FILS */
1798 #define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
1799 /** Driver supports Beacon frame TX rate configuration (legacy rates) */
1800 #define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1801 /** Driver supports Beacon frame TX rate configuration (HT rates) */
1802 #define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1803 /** Driver supports Beacon frame TX rate configuration (VHT rates) */
1804 #define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
1805 /** Driver supports mgmt_tx with random TX address in non-connected state */
1806 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
1807 /** Driver supports mgmt_tx with random TX addr in connected state */
1808 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
1809 /** Driver supports better BSS reporting with sched_scan in connected mode */
1810 #define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
1811 /** Driver supports HE capabilities */
1812 #define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
1813 /** Driver supports FILS shared key offload */
1814 #define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
1815 /** Driver supports all OCE STA specific mandatory features */
1816 #define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
1817 /** Driver supports all OCE AP specific mandatory features */
1818 #define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
1820 * Driver supports all OCE STA-CFON specific mandatory features only.
1821 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
1822 * userspace shall assume that this driver may not support all OCE AP
1823 * functionality but can support only OCE STA-CFON functionality.
1825 #define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
1826 /** Driver supports MFP-optional in the connect command */
1827 #define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL
1828 /** Driver is a self-managed regulatory device */
1829 #define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL
1830 /** Driver supports FTM responder functionality */
1831 #define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL
1832 /** Driver support 4-way handshake offload for WPA-Personal */
1833 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
1834 /** Driver supports a separate control port for EAPOL frames */
1835 #define WPA_DRIVER_FLAGS_CONTROL_PORT 0x0400000000000000ULL
1836 /** Driver supports VLAN offload */
1837 #define WPA_DRIVER_FLAGS_VLAN_OFFLOAD 0x0800000000000000ULL
1838 /** Driver supports UPDATE_FT_IES command */
1839 #define WPA_DRIVER_FLAGS_UPDATE_FT_IES 0x1000000000000000ULL
1840 /** Driver can correctly rekey PTKs without Extended Key ID */
1841 #define WPA_DRIVER_FLAGS_SAFE_PTK0_REKEYS 0x2000000000000000ULL
1842 /** Driver supports Beacon protection */
1843 #define WPA_DRIVER_FLAGS_BEACON_PROTECTION 0x4000000000000000ULL
1844 /** Driver supports Extended Key ID */
1845 #define WPA_DRIVER_FLAGS_EXTENDED_KEY_ID 0x8000000000000000ULL
1848 #define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1849 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1851 unsigned int wmm_ac_supported
:1;
1853 unsigned int mac_addr_rand_scan_supported
:1;
1854 unsigned int mac_addr_rand_sched_scan_supported
:1;
1856 /** Maximum number of supported active probe SSIDs */
1859 /** Maximum number of supported active probe SSIDs for sched_scan */
1860 int max_sched_scan_ssids
;
1862 /** Maximum number of supported scan plans for scheduled scan */
1863 unsigned int max_sched_scan_plans
;
1865 /** Maximum interval in a scan plan. In seconds */
1866 u32 max_sched_scan_plan_interval
;
1868 /** Maximum number of iterations in a single scan plan */
1869 u32 max_sched_scan_plan_iterations
;
1871 /** Whether sched_scan (offloaded scanning) is supported */
1872 int sched_scan_supported
;
1874 /** Maximum number of supported match sets for sched_scan */
1878 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1880 unsigned int max_remain_on_chan
;
1883 * max_stations - Maximum number of associated stations the driver
1884 * supports in AP mode
1886 unsigned int max_stations
;
1889 * probe_resp_offloads - Bitmap of supported protocols by the driver
1890 * for Probe Response offloading.
1892 /** Driver Probe Response offloading support for WPS ver. 1 */
1893 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1894 /** Driver Probe Response offloading support for WPS ver. 2 */
1895 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1896 /** Driver Probe Response offloading support for P2P */
1897 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1898 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1899 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1900 unsigned int probe_resp_offloads
;
1902 unsigned int max_acl_mac_addrs
;
1905 * Number of supported concurrent channels
1907 unsigned int num_multichan_concurrent
;
1910 * extended_capa - extended capabilities in driver/device
1912 * Must be allocated and freed by driver and the pointers must be
1913 * valid for the lifetime of the driver, i.e., freed in deinit()
1915 const u8
*extended_capa
, *extended_capa_mask
;
1916 unsigned int extended_capa_len
;
1918 struct wowlan_triggers wowlan_triggers
;
1920 /** Driver adds the DS Params Set IE in Probe Request frames */
1921 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1922 /** Driver adds the WFA TPC IE in Probe Request frames */
1923 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1924 /** Driver handles quiet period requests */
1925 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1927 * Driver is capable of inserting the current TX power value into the body of
1928 * transmitted frames.
1929 * Background: Some Action frames include a TPC Report IE. This IE contains a
1930 * TX power field, which has to be updated by lower layers. One such Action
1931 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1932 * of spectrum management). Note that this insertion takes place at a fixed
1933 * offset, namely the 6th byte in the Action frame body.
1935 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1937 * Driver supports RRM. With this support, the driver will accept to use RRM in
1938 * (Re)Association Request frames, without supporting quiet period.
1940 #define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1942 /** Driver supports setting the scan dwell time */
1943 #define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
1944 /** Driver supports Beacon Report Measurement */
1945 #define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
1949 /* Driver concurrency capabilities */
1950 unsigned int conc_capab
;
1951 /* Maximum number of concurrent channels on 2.4 GHz */
1952 unsigned int max_conc_chan_2_4
;
1953 /* Maximum number of concurrent channels on 5 GHz */
1954 unsigned int max_conc_chan_5_0
;
1956 /* Maximum number of supported CSA counters */
1957 u16 max_csa_counters
;
1961 struct hostapd_data
;
1963 #define STA_DRV_DATA_TX_MCS BIT(0)
1964 #define STA_DRV_DATA_RX_MCS BIT(1)
1965 #define STA_DRV_DATA_TX_VHT_MCS BIT(2)
1966 #define STA_DRV_DATA_RX_VHT_MCS BIT(3)
1967 #define STA_DRV_DATA_TX_VHT_NSS BIT(4)
1968 #define STA_DRV_DATA_RX_VHT_NSS BIT(5)
1969 #define STA_DRV_DATA_TX_SHORT_GI BIT(6)
1970 #define STA_DRV_DATA_RX_SHORT_GI BIT(7)
1971 #define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
1973 struct hostap_sta_driver_data
{
1974 unsigned long rx_packets
, tx_packets
;
1975 unsigned long long rx_bytes
, tx_bytes
;
1976 unsigned long long rx_airtime
, tx_airtime
;
1977 int bytes_64bit
; /* whether 64-bit byte counters are supported */
1978 unsigned long current_tx_rate
;
1979 unsigned long current_rx_rate
;
1980 unsigned long inactive_msec
;
1981 unsigned long flags
; /* bitfield of STA_DRV_DATA_* */
1982 unsigned long num_ps_buf_frames
;
1983 unsigned long tx_retry_failed
;
1984 unsigned long tx_retry_count
;
1986 unsigned long backlog_packets
;
1987 unsigned long backlog_bytes
;
1997 struct hostapd_sta_add_params
{
2001 const u8
*supp_rates
;
2002 size_t supp_rates_len
;
2003 u16 listen_interval
;
2004 const struct ieee80211_ht_capabilities
*ht_capabilities
;
2005 const struct ieee80211_vht_capabilities
*vht_capabilities
;
2006 int vht_opmode_enabled
;
2008 const struct ieee80211_he_capabilities
*he_capab
;
2009 size_t he_capab_len
;
2010 u32 flags
; /* bitmask of WPA_STA_* flags */
2011 u32 flags_mask
; /* unset bits in flags */
2013 enum mesh_plink_state plink_state
;
2015 #endif /* CONFIG_MESH */
2016 int set
; /* Set STA parameters instead of add */
2018 const u8
*ext_capab
;
2019 size_t ext_capab_len
;
2020 const u8
*supp_channels
;
2021 size_t supp_channels_len
;
2022 const u8
*supp_oper_classes
;
2023 size_t supp_oper_classes_len
;
2027 struct mac_address
{
2031 struct hostapd_acl_params
{
2033 unsigned int num_mac_acl
;
2034 struct mac_address mac_acl
[0];
2037 enum wpa_driver_if_type
{
2039 * WPA_IF_STATION - Station mode interface
2044 * WPA_IF_AP_VLAN - AP mode VLAN interface
2046 * This interface shares its address and Beacon frame with the main
2052 * WPA_IF_AP_BSS - AP mode BSS interface
2054 * This interface has its own address and Beacon frame.
2059 * WPA_IF_P2P_GO - P2P Group Owner
2064 * WPA_IF_P2P_CLIENT - P2P Client
2069 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
2070 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
2075 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
2076 * abstracted P2P Device function in the driver
2081 * WPA_IF_MESH - Mesh interface
2086 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
2091 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
2096 struct wpa_init_params
{
2100 const char *driver_params
;
2101 int use_pae_group_addr
;
2105 u8
*own_addr
; /* buffer for writing own MAC address */
2109 struct wpa_bss_params
{
2110 /** Interface name (for multi-SSID/VLAN support) */
2112 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
2121 enum mfp_options ieee80211w
;
2124 #define WPA_STA_AUTHORIZED BIT(0)
2125 #define WPA_STA_WMM BIT(1)
2126 #define WPA_STA_SHORT_PREAMBLE BIT(2)
2127 #define WPA_STA_MFP BIT(3)
2128 #define WPA_STA_TDLS_PEER BIT(4)
2129 #define WPA_STA_AUTHENTICATED BIT(5)
2130 #define WPA_STA_ASSOCIATED BIT(6)
2143 WNM_SLEEP_ENTER_CONFIRM
,
2144 WNM_SLEEP_ENTER_FAIL
,
2145 WNM_SLEEP_EXIT_CONFIRM
,
2146 WNM_SLEEP_EXIT_FAIL
,
2147 WNM_SLEEP_TFS_REQ_IE_ADD
, /* STA requests driver to add TFS req IE */
2148 WNM_SLEEP_TFS_REQ_IE_NONE
, /* STA requests empty TFS req IE */
2149 WNM_SLEEP_TFS_REQ_IE_SET
, /* AP requests driver to set TFS req IE for
2151 WNM_SLEEP_TFS_RESP_IE_ADD
, /* AP requests driver to add TFS resp IE
2153 WNM_SLEEP_TFS_RESP_IE_NONE
, /* AP requests empty TFS resp IE */
2154 WNM_SLEEP_TFS_RESP_IE_SET
, /* AP requests driver to set TFS resp IE
2156 WNM_SLEEP_TFS_IE_DEL
/* AP delete the TFS IE */
2159 /* enum smps_mode - SMPS mode definitions */
2170 #define WPA_INVALID_NOISE 9999
2173 * struct wpa_signal_info - Information about channel signal quality
2174 * @frequency: control frequency
2175 * @above_threshold: true if the above threshold was crossed
2176 * (relevant for a CQM event)
2177 * @current_signal: in dBm
2178 * @avg_signal: in dBm
2179 * @avg_beacon_signal: in dBm
2180 * @current_noise: %WPA_INVALID_NOISE if not supported
2181 * @current_txrate: current TX rate
2182 * @chanwidth: channel width
2183 * @center_frq1: center frequency for the first segment
2184 * @center_frq2: center frequency for the second segment (if relevant)
2186 struct wpa_signal_info
{
2188 int above_threshold
;
2191 int avg_beacon_signal
;
2194 enum chan_width chanwidth
;
2200 * struct wpa_channel_info - Information about the current channel
2201 * @frequency: Center frequency of the primary 20 MHz channel
2202 * @chanwidth: Width of the current operating channel
2203 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
2204 * This field is only filled in when using a 40 MHz channel.
2205 * @center_frq1: Center frequency of frequency segment 0
2206 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
2207 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
2208 * derived from center_frq2 for convenience.
2210 struct wpa_channel_info
{
2212 enum chan_width chanwidth
;
2220 * struct beacon_data - Beacon data
2221 * @head: Head portion of Beacon frame (before TIM IE)
2222 * @tail: Tail portion of Beacon frame (after TIM IE)
2223 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2224 * @proberesp_ies: Extra information element(s) to add into Probe Response
2226 * @assocresp_ies: Extra information element(s) to add into (Re)Association
2227 * Response frames or %NULL
2228 * @probe_resp: Probe Response frame template
2229 * @head_len: Length of @head
2230 * @tail_len: Length of @tail
2231 * @beacon_ies_len: Length of beacon_ies in octets
2232 * @proberesp_ies_len: Length of proberesp_ies in octets
2233 * @proberesp_ies_len: Length of proberesp_ies in octets
2234 * @probe_resp_len: Length of probe response template (@probe_resp)
2236 struct beacon_data
{
2243 size_t head_len
, tail_len
;
2244 size_t beacon_ies_len
;
2245 size_t proberesp_ies_len
;
2246 size_t assocresp_ies_len
;
2247 size_t probe_resp_len
;
2251 * struct csa_settings - Settings for channel switch command
2252 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2253 * @block_tx: 1 - block transmission for CSA period
2254 * @freq_params: Next channel frequency parameter
2255 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2256 * @beacon_after: Next beacon/probe resp/asooc resp info
2257 * @counter_offset_beacon: Offset to the count field in beacon's tail
2258 * @counter_offset_presp: Offset to the count field in probe resp.
2260 struct csa_settings
{
2264 struct hostapd_freq_params freq_params
;
2265 struct beacon_data beacon_csa
;
2266 struct beacon_data beacon_after
;
2268 u16 counter_offset_beacon
[2];
2269 u16 counter_offset_presp
[2];
2272 /* TDLS peer capabilities for send_tdls_mgmt() */
2273 enum tdls_peer_capability
{
2274 TDLS_PEER_HT
= BIT(0),
2275 TDLS_PEER_VHT
= BIT(1),
2276 TDLS_PEER_WMM
= BIT(2),
2279 /* valid info in the wmm_params struct */
2280 enum wmm_params_valid_info
{
2281 WMM_PARAMS_UAPSD_QUEUES_INFO
= BIT(0),
2285 * struct wmm_params - WMM parameterss configured for this association
2286 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2287 * of the struct contain valid information.
2288 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2289 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2296 #ifdef CONFIG_MACSEC
2297 struct macsec_init_params
{
2298 Boolean always_include_sci
;
2302 #endif /* CONFIG_MACSEC */
2304 enum drv_br_port_attr
{
2305 DRV_BR_PORT_ATTR_PROXYARP
,
2306 DRV_BR_PORT_ATTR_HAIRPIN_MODE
,
2309 enum drv_br_net_param
{
2310 DRV_BR_NET_PARAM_GARP_ACCEPT
,
2311 DRV_BR_MULTICAST_SNOOPING
,
2314 struct drv_acs_params
{
2315 /* Selected mode (HOSTAPD_MODE_*) */
2316 enum hostapd_hw_mode hw_mode
;
2318 /* Indicates whether HT is enabled */
2321 /* Indicates whether HT40 is enabled */
2324 /* Indicates whether VHT is enabled */
2327 /* Configured ACS channel width */
2330 /* ACS frequency list info */
2331 const int *freq_list
;
2333 /* Indicates whether EDMG is enabled */
2337 struct wpa_bss_trans_info
{
2338 u8 mbo_transition_reason
;
2343 struct wpa_bss_candidate_info
{
2345 struct candidate_list
{
2352 struct wpa_pmkid_params
{
2356 const u8
*fils_cache_id
;
2361 u8 pmk_reauth_threshold
;
2364 /* Mask used to specify which connection parameters have to be updated */
2365 enum wpa_drv_update_connect_params_mask
{
2366 WPA_DRV_UPDATE_ASSOC_IES
= BIT(0),
2367 WPA_DRV_UPDATE_FILS_ERP_INFO
= BIT(1),
2368 WPA_DRV_UPDATE_AUTH_TYPE
= BIT(2),
2372 * struct external_auth - External authentication trigger parameters
2374 * These are used across the external authentication request and event
2376 * @action: Action type / trigger for external authentication. Only significant
2377 * for the event interface.
2378 * @bssid: BSSID of the peer with which the authentication has to happen. Used
2379 * by both the request and event interface.
2380 * @ssid: SSID of the AP. Used by both the request and event interface.
2381 * @ssid_len: SSID length in octets.
2382 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2383 * the request interface.
2384 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2385 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2386 * the real status code for failures. Used only for the request interface
2387 * from user space to the driver.
2388 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
2390 struct external_auth
{
2398 unsigned int key_mgmt_suite
;
2404 * struct wpa_driver_ops - Driver interface API definition
2406 * This structure defines the API that each driver interface needs to implement
2407 * for core wpa_supplicant code. All driver specific functionality is captured
2410 struct wpa_driver_ops
{
2411 /** Name of the driver interface */
2413 /** One line description of the driver interface */
2417 * get_bssid - Get the current BSSID
2418 * @priv: private driver interface data
2419 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2421 * Returns: 0 on success, -1 on failure
2423 * Query kernel driver for the current BSSID and copy it to bssid.
2424 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2427 int (*get_bssid
)(void *priv
, u8
*bssid
);
2430 * get_ssid - Get the current SSID
2431 * @priv: private driver interface data
2432 * @ssid: buffer for SSID (at least 32 bytes)
2434 * Returns: Length of the SSID on success, -1 on failure
2436 * Query kernel driver for the current SSID and copy it to ssid.
2437 * Returning zero is recommended if the STA is not associated.
2439 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2440 * can, at least in theory, contain control characters (including nul)
2441 * and as such, should be processed as binary data, not a printable
2444 int (*get_ssid
)(void *priv
, u8
*ssid
);
2447 * set_key - Configure encryption key
2448 * @priv: private driver interface data
2449 * @params: Key parameters
2450 * Returns: 0 on success, -1 on failure
2452 * Configure the given key for the kernel driver. If the driver
2453 * supports separate individual keys (4 default keys + 1 individual),
2454 * addr can be used to determine whether the key is default or
2455 * individual. If only 4 keys are supported, the default key with key
2456 * index 0 is used as the individual key. STA must be configured to use
2457 * it as the default Tx key (set_tx is set) and accept Rx for all the
2458 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2459 * broadcast keys, so key index 0 is available for this kind of
2462 * Please note that TKIP keys include separate TX and RX MIC keys and
2463 * some drivers may expect them in different order than wpa_supplicant
2464 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
2465 * will trigger Michael MIC errors. This can be fixed by changing the
2466 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
2467 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2468 * example on how this can be done.
2470 int (*set_key
)(void *priv
, struct wpa_driver_set_key_params
*params
);
2473 * init - Initialize driver interface
2474 * @ctx: context to be used when calling wpa_supplicant functions,
2475 * e.g., wpa_supplicant_event()
2476 * @ifname: interface name, e.g., wlan0
2478 * Returns: Pointer to private data, %NULL on failure
2480 * Initialize driver interface, including event processing for kernel
2481 * driver events (e.g., associated, scan results, Michael MIC failure).
2482 * This function can allocate a private configuration data area for
2483 * @ctx, file descriptor, interface name, etc. information that may be
2484 * needed in future driver operations. If this is not used, non-NULL
2485 * value will need to be returned because %NULL is used to indicate
2486 * failure. The returned value will be used as 'void *priv' data for
2487 * all other driver_ops functions.
2489 * The main event loop (eloop.c) of wpa_supplicant can be used to
2490 * register callback for read sockets (eloop_register_read_sock()).
2492 * See below for more information about events and
2493 * wpa_supplicant_event() function.
2495 void * (*init
)(void *ctx
, const char *ifname
);
2498 * deinit - Deinitialize driver interface
2499 * @priv: private driver interface data from init()
2501 * Shut down driver interface and processing of driver events. Free
2502 * private data buffer if one was allocated in init() handler.
2504 void (*deinit
)(void *priv
);
2507 * set_param - Set driver configuration parameters
2508 * @priv: private driver interface data from init()
2509 * @param: driver specific configuration parameters
2511 * Returns: 0 on success, -1 on failure
2513 * Optional handler for notifying driver interface about configuration
2514 * parameters (driver_param).
2516 int (*set_param
)(void *priv
, const char *param
);
2519 * set_countermeasures - Enable/disable TKIP countermeasures
2520 * @priv: private driver interface data
2521 * @enabled: 1 = countermeasures enabled, 0 = disabled
2523 * Returns: 0 on success, -1 on failure
2525 * Configure TKIP countermeasures. When these are enabled, the driver
2526 * should drop all received and queued frames that are using TKIP.
2528 int (*set_countermeasures
)(void *priv
, int enabled
);
2531 * deauthenticate - Request driver to deauthenticate
2532 * @priv: private driver interface data
2533 * @addr: peer address (BSSID of the AP)
2534 * @reason_code: 16-bit reason code to be sent in the deauthentication
2537 * Returns: 0 on success, -1 on failure
2539 int (*deauthenticate
)(void *priv
, const u8
*addr
, u16 reason_code
);
2542 * associate - Request driver to associate
2543 * @priv: private driver interface data
2544 * @params: association parameters
2546 * Returns: 0 on success, -1 on failure
2548 int (*associate
)(void *priv
,
2549 struct wpa_driver_associate_params
*params
);
2552 * add_pmkid - Add PMKSA cache entry to the driver
2553 * @priv: private driver interface data
2554 * @params: PMKSA parameters
2556 * Returns: 0 on success, -1 on failure
2558 * This function is called when a new PMK is received, as a result of
2559 * either normal authentication or RSN pre-authentication. The PMKSA
2560 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2561 * ssid, fils_cache_id, pmkid, and pmk.
2563 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2564 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2565 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2566 * driver_ops function does not need to be implemented. Likewise, if
2567 * the driver does not support WPA, this function is not needed.
2569 int (*add_pmkid
)(void *priv
, struct wpa_pmkid_params
*params
);
2572 * remove_pmkid - Remove PMKSA cache entry to the driver
2573 * @priv: private driver interface data
2574 * @params: PMKSA parameters
2576 * Returns: 0 on success, -1 on failure
2578 * This function is called when the supplicant drops a PMKSA cache
2579 * entry for any reason. The PMKSA parameters are either a set of
2580 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
2582 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2583 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2584 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2585 * from wpa_supplicant, this driver_ops function does not need to be
2586 * implemented. Likewise, if the driver does not support WPA, this
2587 * function is not needed.
2589 int (*remove_pmkid
)(void *priv
, struct wpa_pmkid_params
*params
);
2592 * flush_pmkid - Flush PMKSA cache
2593 * @priv: private driver interface data
2595 * Returns: 0 on success, -1 on failure
2597 * This function is called when the supplicant drops all PMKSA cache
2598 * entries for any reason.
2600 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2601 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2602 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2603 * from wpa_supplicant, this driver_ops function does not need to be
2604 * implemented. Likewise, if the driver does not support WPA, this
2605 * function is not needed.
2607 int (*flush_pmkid
)(void *priv
);
2610 * get_capa - Get driver capabilities
2611 * @priv: private driver interface data
2613 * Returns: 0 on success, -1 on failure
2615 * Get driver/firmware/hardware capabilities.
2617 int (*get_capa
)(void *priv
, struct wpa_driver_capa
*capa
);
2620 * poll - Poll driver for association information
2621 * @priv: private driver interface data
2623 * This is an option callback that can be used when the driver does not
2624 * provide event mechanism for association events. This is called when
2625 * receiving WPA EAPOL-Key messages that require association
2626 * information. The driver interface is supposed to generate associnfo
2627 * event before returning from this callback function. In addition, the
2628 * driver interface should generate an association event after having
2629 * sent out associnfo.
2631 void (*poll
)(void *priv
);
2634 * get_ifindex - Get interface index
2635 * @priv: private driver interface data
2637 * Returns: Interface index
2639 unsigned int (*get_ifindex
)(void *priv
);
2642 * get_ifname - Get interface name
2643 * @priv: private driver interface data
2645 * Returns: Pointer to the interface name. This can differ from the
2646 * interface name used in init() call. Init() is called first.
2648 * This optional function can be used to allow the driver interface to
2649 * replace the interface name with something else, e.g., based on an
2650 * interface mapping from a more descriptive name.
2652 const char * (*get_ifname
)(void *priv
);
2655 * get_mac_addr - Get own MAC address
2656 * @priv: private driver interface data
2658 * Returns: Pointer to own MAC address or %NULL on failure
2660 * This optional function can be used to get the own MAC address of the
2661 * device from the driver interface code. This is only needed if the
2662 * l2_packet implementation for the OS does not provide easy access to
2664 const u8
* (*get_mac_addr
)(void *priv
);
2667 * set_operstate - Sets device operating state to DORMANT or UP
2668 * @priv: private driver interface data
2669 * @state: 0 = dormant, 1 = up
2670 * Returns: 0 on success, -1 on failure
2672 * This is an optional function that can be used on operating systems
2673 * that support a concept of controlling network device state from user
2674 * space applications. This function, if set, gets called with
2675 * state = 1 when authentication has been completed and with state = 0
2676 * when connection is lost.
2678 int (*set_operstate
)(void *priv
, int state
);
2681 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2682 * @priv: Private driver interface data
2683 * @addr: Address of the station for which to set protection (may be
2684 * %NULL for group keys)
2685 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2686 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2687 * Returns: 0 on success, -1 on failure
2689 * This is an optional function that can be used to set the driver to
2690 * require protection for Tx and/or Rx frames. This uses the layer
2691 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2692 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2693 * set protection operation; instead, they set protection implicitly
2694 * based on configured keys.
2696 int (*mlme_setprotection
)(void *priv
, const u8
*addr
, int protect_type
,
2700 * get_hw_feature_data - Get hardware support data (channels and rates)
2701 * @priv: Private driver interface data
2702 * @num_modes: Variable for returning the number of returned modes
2703 * flags: Variable for returning hardware feature flags
2704 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
2705 * Returns: Pointer to allocated hardware data on success or %NULL on
2706 * failure. Caller is responsible for freeing this.
2708 struct hostapd_hw_modes
* (*get_hw_feature_data
)(void *priv
,
2710 u16
*flags
, u8
*dfs
);
2713 * send_mlme - Send management frame from MLME
2714 * @priv: Private driver interface data
2715 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2716 * @data_len: Size of the management frame
2717 * @noack: Do not wait for this frame to be acked (disable retries)
2718 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2720 * @csa_offs: Array of CSA offsets or %NULL
2721 * @csa_offs_len: Number of elements in csa_offs
2722 * @no_encrypt: Do not encrypt frame even if appropriate key exists
2723 * (used only for testing purposes)
2724 * @wait: Time to wait off-channel for a response (in ms), or zero
2725 * Returns: 0 on success, -1 on failure
2727 int (*send_mlme
)(void *priv
, const u8
*data
, size_t data_len
,
2728 int noack
, unsigned int freq
, const u16
*csa_offs
,
2729 size_t csa_offs_len
, int no_encrypt
,
2733 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2734 * @priv: Private driver interface data
2735 * @md: Mobility domain (2 octets) (also included inside ies)
2736 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2737 * @ies_len: Length of FT IEs in bytes
2738 * Returns: 0 on success, -1 on failure
2740 * The supplicant uses this callback to let the driver know that keying
2741 * material for FT is available and that the driver can use the
2742 * provided IEs in the next message in FT authentication sequence.
2744 * This function is only needed for driver that support IEEE 802.11r
2745 * (Fast BSS Transition).
2747 int (*update_ft_ies
)(void *priv
, const u8
*md
, const u8
*ies
,
2751 * get_scan_results2 - Fetch the latest scan results
2752 * @priv: private driver interface data
2754 * Returns: Allocated buffer of scan results (caller is responsible for
2755 * freeing the data structure) on success, NULL on failure
2757 struct wpa_scan_results
* (*get_scan_results2
)(void *priv
);
2760 * set_country - Set country
2761 * @priv: Private driver interface data
2762 * @alpha2: country to which to switch to
2763 * Returns: 0 on success, -1 on failure
2765 * This function is for drivers which support some form
2766 * of setting a regulatory domain.
2768 int (*set_country
)(void *priv
, const char *alpha2
);
2771 * get_country - Get country
2772 * @priv: Private driver interface data
2773 * @alpha2: Buffer for returning country code (at least 3 octets)
2774 * Returns: 0 on success, -1 on failure
2776 int (*get_country
)(void *priv
, char *alpha2
);
2779 * global_init - Global driver initialization
2780 * @ctx: wpa_global pointer
2781 * Returns: Pointer to private data (global), %NULL on failure
2783 * This optional function is called to initialize the driver wrapper
2784 * for global data, i.e., data that applies to all interfaces. If this
2785 * function is implemented, global_deinit() will also need to be
2786 * implemented to free the private data. The driver will also likely
2787 * use init2() function instead of init() to get the pointer to global
2788 * data available to per-interface initializer.
2790 void * (*global_init
)(void *ctx
);
2793 * global_deinit - Global driver deinitialization
2794 * @priv: private driver global data from global_init()
2796 * Terminate any global driver related functionality and free the
2797 * global data structure.
2799 void (*global_deinit
)(void *priv
);
2802 * init2 - Initialize driver interface (with global data)
2803 * @ctx: context to be used when calling wpa_supplicant functions,
2804 * e.g., wpa_supplicant_event()
2805 * @ifname: interface name, e.g., wlan0
2806 * @global_priv: private driver global data from global_init()
2807 * Returns: Pointer to private data, %NULL on failure
2809 * This function can be used instead of init() if the driver wrapper
2812 void * (*init2
)(void *ctx
, const char *ifname
, void *global_priv
);
2815 * get_interfaces - Get information about available interfaces
2816 * @global_priv: private driver global data from global_init()
2817 * Returns: Allocated buffer of interface information (caller is
2818 * responsible for freeing the data structure) on success, NULL on
2821 struct wpa_interface_info
* (*get_interfaces
)(void *global_priv
);
2824 * scan2 - Request the driver to initiate scan
2825 * @priv: private driver interface data
2826 * @params: Scan parameters
2828 * Returns: 0 on success, -1 on failure
2830 * Once the scan results are ready, the driver should report scan
2831 * results event for wpa_supplicant which will eventually request the
2832 * results with wpa_driver_get_scan_results2().
2834 int (*scan2
)(void *priv
, struct wpa_driver_scan_params
*params
);
2837 * authenticate - Request driver to authenticate
2838 * @priv: private driver interface data
2839 * @params: authentication parameters
2840 * Returns: 0 on success, -1 on failure
2842 * This is an optional function that can be used with drivers that
2843 * support separate authentication and association steps, i.e., when
2844 * wpa_supplicant can act as the SME. If not implemented, associate()
2845 * function is expected to take care of IEEE 802.11 authentication,
2848 int (*authenticate
)(void *priv
,
2849 struct wpa_driver_auth_params
*params
);
2852 * set_ap - Set Beacon and Probe Response information for AP mode
2853 * @priv: Private driver interface data
2854 * @params: Parameters to use in AP mode
2856 * This function is used to configure Beacon template and/or extra IEs
2857 * to add for Beacon and Probe Response frames for the driver in
2858 * AP mode. The driver is responsible for building the full Beacon
2859 * frame by concatenating the head part with TIM IE generated by the
2860 * driver/firmware and finishing with the tail part. Depending on the
2861 * driver architectue, this can be done either by using the full
2862 * template or the set of additional IEs (e.g., WPS and P2P IE).
2863 * Similarly, Probe Response processing depends on the driver design.
2864 * If the driver (or firmware) takes care of replying to Probe Request
2865 * frames, the extra IEs provided here needs to be added to the Probe
2868 * Returns: 0 on success, -1 on failure
2870 int (*set_ap
)(void *priv
, struct wpa_driver_ap_params
*params
);
2873 * set_acl - Set ACL in AP mode
2874 * @priv: Private driver interface data
2875 * @params: Parameters to configure ACL
2876 * Returns: 0 on success, -1 on failure
2878 * This is used only for the drivers which support MAC address ACL.
2880 int (*set_acl
)(void *priv
, struct hostapd_acl_params
*params
);
2883 * hapd_init - Initialize driver interface (hostapd only)
2884 * @hapd: Pointer to hostapd context
2885 * @params: Configuration for the driver wrapper
2886 * Returns: Pointer to private data, %NULL on failure
2888 * This function is used instead of init() or init2() when the driver
2889 * wrapper is used with hostapd.
2891 void * (*hapd_init
)(struct hostapd_data
*hapd
,
2892 struct wpa_init_params
*params
);
2895 * hapd_deinit - Deinitialize driver interface (hostapd only)
2896 * @priv: Private driver interface data from hapd_init()
2898 void (*hapd_deinit
)(void *priv
);
2901 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2902 * @priv: Private driver interface data
2903 * @params: BSS parameters
2904 * Returns: 0 on success, -1 on failure
2906 * This is an optional function to configure the kernel driver to
2907 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2908 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2909 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2910 * for Beacon frames.
2912 * DEPRECATED - use set_ap() instead
2914 int (*set_ieee8021x
)(void *priv
, struct wpa_bss_params
*params
);
2917 * set_privacy - Enable/disable privacy (AP only)
2918 * @priv: Private driver interface data
2919 * @enabled: 1 = privacy enabled, 0 = disabled
2920 * Returns: 0 on success, -1 on failure
2922 * This is an optional function to configure privacy field in the
2923 * kernel driver for Beacon frames. This can be left undefined (set to
2924 * %NULL) if the driver uses the Beacon template from set_ap().
2926 * DEPRECATED - use set_ap() instead
2928 int (*set_privacy
)(void *priv
, int enabled
);
2931 * get_seqnum - Fetch the current TSC/packet number (AP only)
2932 * @ifname: The interface name (main or virtual)
2933 * @priv: Private driver interface data
2934 * @addr: MAC address of the station or %NULL for group keys
2936 * @seq: Buffer for returning the latest used TSC/packet number
2937 * Returns: 0 on success, -1 on failure
2939 * This function is used to fetch the last used TSC/packet number for
2940 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2941 * keys, so there is no strict requirement on implementing support for
2942 * unicast keys (i.e., addr != %NULL).
2944 int (*get_seqnum
)(const char *ifname
, void *priv
, const u8
*addr
,
2948 * flush - Flush all association stations (AP only)
2949 * @priv: Private driver interface data
2950 * Returns: 0 on success, -1 on failure
2952 * This function requests the driver to disassociate all associated
2953 * stations. This function does not need to be implemented if the
2954 * driver does not process association frames internally.
2956 int (*flush
)(void *priv
);
2959 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2960 * @priv: Private driver interface data
2961 * @elem: Information elements
2962 * @elem_len: Length of the elem buffer in octets
2963 * Returns: 0 on success, -1 on failure
2965 * This is an optional function to add information elements in the
2966 * kernel driver for Beacon and Probe Response frames. This can be left
2967 * undefined (set to %NULL) if the driver uses the Beacon template from
2970 * DEPRECATED - use set_ap() instead
2972 int (*set_generic_elem
)(void *priv
, const u8
*elem
, size_t elem_len
);
2975 * read_sta_data - Fetch station data
2976 * @priv: Private driver interface data
2977 * @data: Buffer for returning station information
2978 * @addr: MAC address of the station
2979 * Returns: 0 on success, -1 on failure
2981 int (*read_sta_data
)(void *priv
, struct hostap_sta_driver_data
*data
,
2985 * tx_control_port - Send a frame over the 802.1X controlled port
2986 * @priv: Private driver interface data
2987 * @dest: Destination MAC address
2988 * @proto: Ethertype in host byte order
2989 * @buf: Frame payload starting from IEEE 802.1X header
2990 * @len: Frame payload length
2991 * @no_encrypt: Do not encrypt frame
2993 * Returns 0 on success, else an error
2995 * This is like a normal Ethernet send except that the driver is aware
2996 * (by other means than the Ethertype) that this frame is special,
2997 * and more importantly it gains an ordering between the transmission of
2998 * the frame and other driver management operations such as key
2999 * installations. This can be used to work around known limitations in
3000 * IEEE 802.11 protocols such as race conditions between rekeying 4-way
3001 * handshake message 4/4 and a PTK being overwritten.
3003 * This function is only used for a given interface if the driver
3004 * instance reports WPA_DRIVER_FLAGS_CONTROL_PORT capability. Otherwise,
3005 * API users will fall back to sending the frame via a normal socket.
3007 int (*tx_control_port
)(void *priv
, const u8
*dest
,
3008 u16 proto
, const u8
*buf
, size_t len
,
3012 * hapd_send_eapol - Send an EAPOL packet (AP only)
3013 * @priv: private driver interface data
3014 * @addr: Destination MAC address
3015 * @data: EAPOL packet starting with IEEE 802.1X header
3016 * @data_len: Length of the EAPOL packet in octets
3017 * @encrypt: Whether the frame should be encrypted
3018 * @own_addr: Source MAC address
3019 * @flags: WPA_STA_* flags for the destination station
3021 * Returns: 0 on success, -1 on failure
3023 int (*hapd_send_eapol
)(void *priv
, const u8
*addr
, const u8
*data
,
3024 size_t data_len
, int encrypt
,
3025 const u8
*own_addr
, u32 flags
);
3028 * sta_deauth - Deauthenticate a station (AP only)
3029 * @priv: Private driver interface data
3030 * @own_addr: Source address and BSSID for the Deauthentication frame
3031 * @addr: MAC address of the station to deauthenticate
3032 * @reason: Reason code for the Deauthentiation frame
3033 * Returns: 0 on success, -1 on failure
3035 * This function requests a specific station to be deauthenticated and
3036 * a Deauthentication frame to be sent to it.
3038 int (*sta_deauth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
3042 * sta_disassoc - Disassociate a station (AP only)
3043 * @priv: Private driver interface data
3044 * @own_addr: Source address and BSSID for the Disassociation frame
3045 * @addr: MAC address of the station to disassociate
3046 * @reason: Reason code for the Disassociation frame
3047 * Returns: 0 on success, -1 on failure
3049 * This function requests a specific station to be disassociated and
3050 * a Disassociation frame to be sent to it.
3052 int (*sta_disassoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
3056 * sta_remove - Remove a station entry (AP only)
3057 * @priv: Private driver interface data
3058 * @addr: MAC address of the station to be removed
3059 * Returns: 0 on success, -1 on failure
3061 int (*sta_remove
)(void *priv
, const u8
*addr
);
3064 * hapd_get_ssid - Get the current SSID (AP only)
3065 * @priv: Private driver interface data
3066 * @buf: Buffer for returning the SSID
3067 * @len: Maximum length of the buffer
3068 * Returns: Length of the SSID on success, -1 on failure
3070 * This function need not be implemented if the driver uses Beacon
3071 * template from set_ap() and does not reply to Probe Request frames.
3073 int (*hapd_get_ssid
)(void *priv
, u8
*buf
, int len
);
3076 * hapd_set_ssid - Set SSID (AP only)
3077 * @priv: Private driver interface data
3079 * @len: Length of the SSID in octets
3080 * Returns: 0 on success, -1 on failure
3082 * DEPRECATED - use set_ap() instead
3084 int (*hapd_set_ssid
)(void *priv
, const u8
*buf
, int len
);
3087 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
3088 * @priv: Private driver interface data
3089 * @enabled: 1 = countermeasures enabled, 0 = disabled
3090 * Returns: 0 on success, -1 on failure
3092 * This need not be implemented if the driver does not take care of
3093 * association processing.
3095 int (*hapd_set_countermeasures
)(void *priv
, int enabled
);
3098 * sta_add - Add a station entry
3099 * @priv: Private driver interface data
3100 * @params: Station parameters
3101 * Returns: 0 on success, -1 on failure
3103 * This function is used to add or set (params->set 1) a station
3104 * entry in the driver. Adding STA entries is used only if the driver
3105 * does not take care of association processing.
3107 * With drivers that don't support full AP client state, this function
3108 * is used to add a station entry to the driver once the station has
3109 * completed association.
3111 * With TDLS, this function is used to add or set (params->set 1)
3112 * TDLS peer entries (even with drivers that do not support full AP
3115 int (*sta_add
)(void *priv
, struct hostapd_sta_add_params
*params
);
3118 * get_inact_sec - Get station inactivity duration (AP only)
3119 * @priv: Private driver interface data
3120 * @addr: Station address
3121 * Returns: Number of seconds station has been inactive, -1 on failure
3123 int (*get_inact_sec
)(void *priv
, const u8
*addr
);
3126 * sta_clear_stats - Clear station statistics (AP only)
3127 * @priv: Private driver interface data
3128 * @addr: Station address
3129 * Returns: 0 on success, -1 on failure
3131 int (*sta_clear_stats
)(void *priv
, const u8
*addr
);
3134 * set_freq - Set channel/frequency (AP only)
3135 * @priv: Private driver interface data
3136 * @freq: Channel parameters
3137 * Returns: 0 on success, -1 on failure
3139 int (*set_freq
)(void *priv
, struct hostapd_freq_params
*freq
);
3142 * set_rts - Set RTS threshold
3143 * @priv: Private driver interface data
3144 * @rts: RTS threshold in octets
3145 * Returns: 0 on success, -1 on failure
3147 int (*set_rts
)(void *priv
, int rts
);
3150 * set_frag - Set fragmentation threshold
3151 * @priv: Private driver interface data
3152 * @frag: Fragmentation threshold in octets
3153 * Returns: 0 on success, -1 on failure
3155 int (*set_frag
)(void *priv
, int frag
);
3158 * sta_set_flags - Set station flags (AP only)
3159 * @priv: Private driver interface data
3160 * @addr: Station address
3161 * @total_flags: Bitmap of all WPA_STA_* flags currently set
3162 * @flags_or: Bitmap of WPA_STA_* flags to add
3163 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
3164 * Returns: 0 on success, -1 on failure
3166 int (*sta_set_flags
)(void *priv
, const u8
*addr
,
3167 unsigned int total_flags
, unsigned int flags_or
,
3168 unsigned int flags_and
);
3171 * sta_set_airtime_weight - Set station airtime weight (AP only)
3172 * @priv: Private driver interface data
3173 * @addr: Station address
3174 * @weight: New weight for station airtime assignment
3175 * Returns: 0 on success, -1 on failure
3177 int (*sta_set_airtime_weight
)(void *priv
, const u8
*addr
,
3178 unsigned int weight
);
3181 * set_tx_queue_params - Set TX queue parameters
3182 * @priv: Private driver interface data
3183 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
3187 * @burst_time: Maximum length for bursting in 0.1 msec units
3189 int (*set_tx_queue_params
)(void *priv
, int queue
, int aifs
, int cw_min
,
3190 int cw_max
, int burst_time
);
3193 * if_add - Add a virtual interface
3194 * @priv: Private driver interface data
3195 * @type: Interface type
3196 * @ifname: Interface name for the new virtual interface
3197 * @addr: Local address to use for the interface or %NULL to use the
3198 * parent interface address
3199 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
3200 * @drv_priv: Pointer for overwriting the driver context or %NULL if
3201 * not allowed (applies only to %WPA_IF_AP_BSS type)
3202 * @force_ifname: Buffer for returning an interface name that the
3203 * driver ended up using if it differs from the requested ifname
3204 * @if_addr: Buffer for returning the allocated interface address
3205 * (this may differ from the requested addr if the driver cannot
3206 * change interface address)
3207 * @bridge: Bridge interface to use or %NULL if no bridge configured
3208 * @use_existing: Whether to allow existing interface to be used
3209 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
3210 * Returns: 0 on success, -1 on failure
3212 int (*if_add
)(void *priv
, enum wpa_driver_if_type type
,
3213 const char *ifname
, const u8
*addr
, void *bss_ctx
,
3214 void **drv_priv
, char *force_ifname
, u8
*if_addr
,
3215 const char *bridge
, int use_existing
, int setup_ap
);
3218 * if_remove - Remove a virtual interface
3219 * @priv: Private driver interface data
3220 * @type: Interface type
3221 * @ifname: Interface name of the virtual interface to be removed
3222 * Returns: 0 on success, -1 on failure
3224 int (*if_remove
)(void *priv
, enum wpa_driver_if_type type
,
3225 const char *ifname
);
3228 * set_sta_vlan - Bind a station into a specific interface (AP only)
3229 * @priv: Private driver interface data
3230 * @ifname: Interface (main or virtual BSS or VLAN)
3231 * @addr: MAC address of the associated station
3233 * Returns: 0 on success, -1 on failure
3235 * This function is used to bind a station to a specific virtual
3236 * interface. It is only used if when virtual interfaces are supported,
3237 * e.g., to assign stations to different VLAN interfaces based on
3238 * information from a RADIUS server. This allows separate broadcast
3239 * domains to be used with a single BSS.
3241 int (*set_sta_vlan
)(void *priv
, const u8
*addr
, const char *ifname
,
3245 * commit - Optional commit changes handler (AP only)
3246 * @priv: driver private data
3247 * Returns: 0 on success, -1 on failure
3249 * This optional handler function can be registered if the driver
3250 * interface implementation needs to commit changes (e.g., by setting
3251 * network interface up) at the end of initial configuration. If set,
3252 * this handler will be called after initial setup has been completed.
3254 int (*commit
)(void *priv
);
3257 * set_radius_acl_auth - Notification of RADIUS ACL change
3258 * @priv: Private driver interface data
3259 * @mac: MAC address of the station
3260 * @accepted: Whether the station was accepted
3261 * @session_timeout: Session timeout for the station
3262 * Returns: 0 on success, -1 on failure
3264 int (*set_radius_acl_auth
)(void *priv
, const u8
*mac
, int accepted
,
3265 u32 session_timeout
);
3268 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3269 * @priv: Private driver interface data
3270 * @mac: MAC address of the station
3271 * Returns: 0 on success, -1 on failure
3273 int (*set_radius_acl_expire
)(void *priv
, const u8
*mac
);
3276 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
3277 * @priv: Private driver interface data
3278 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3279 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3281 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3282 * to remove extra IE(s)
3283 * Returns: 0 on success, -1 on failure
3285 * This is an optional function to add WPS IE in the kernel driver for
3286 * Beacon and Probe Response frames. This can be left undefined (set
3287 * to %NULL) if the driver uses the Beacon template from set_ap()
3288 * and does not process Probe Request frames. If the driver takes care
3289 * of (Re)Association frame processing, the assocresp buffer includes
3290 * WPS IE(s) that need to be added to (Re)Association Response frames
3291 * whenever a (Re)Association Request frame indicated use of WPS.
3293 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3294 * frames when operating as a GO. The driver is responsible for adding
3295 * timing related attributes (e.g., NoA) in addition to the IEs
3296 * included here by appending them after these buffers. This call is
3297 * also used to provide Probe Response IEs for P2P Listen state
3298 * operations for drivers that generate the Probe Response frames
3301 * DEPRECATED - use set_ap() instead
3303 int (*set_ap_wps_ie
)(void *priv
, const struct wpabuf
*beacon
,
3304 const struct wpabuf
*proberesp
,
3305 const struct wpabuf
*assocresp
);
3308 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3309 * @priv: Private driver interface data
3310 * @authorized: Whether the port is authorized
3311 * Returns: 0 on success, -1 on failure
3313 int (*set_supp_port
)(void *priv
, int authorized
);
3316 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3317 * @priv: Private driver interface data
3318 * @addr: MAC address of the associated station
3319 * @aid: Association ID
3320 * @val: 1 = bind to 4-address WDS; 0 = unbind
3321 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3322 * to indicate that bridge is not to be used
3323 * @ifname_wds: Buffer to return the interface name for the new WDS
3324 * station or %NULL to indicate name is not returned.
3325 * Returns: 0 on success, -1 on failure
3327 int (*set_wds_sta
)(void *priv
, const u8
*addr
, int aid
, int val
,
3328 const char *bridge_ifname
, char *ifname_wds
);
3331 * send_action - Transmit an Action frame
3332 * @priv: Private driver interface data
3333 * @freq: Frequency (in MHz) of the channel
3334 * @wait: Time to wait off-channel for a response (in ms), or zero
3335 * @dst: Destination MAC address (Address 1)
3336 * @src: Source MAC address (Address 2)
3337 * @bssid: BSSID (Address 3)
3339 * @data_len: data length in octets
3340 @ @no_cck: Whether CCK rates must not be used to transmit this frame
3341 * Returns: 0 on success, -1 on failure
3343 * This command can be used to request the driver to transmit an action
3344 * frame to the specified destination.
3346 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3347 * be transmitted on the given channel and the device will wait for a
3348 * response on that channel for the given wait time.
3350 * If the flag is not set, the wait time will be ignored. In this case,
3351 * if a remain-on-channel duration is in progress, the frame must be
3352 * transmitted on that channel; alternatively the frame may be sent on
3353 * the current operational channel (if in associated state in station
3354 * mode or while operating as an AP.)
3356 * If @src differs from the device MAC address, use of a random
3357 * transmitter address is requested for this message exchange.
3359 int (*send_action
)(void *priv
, unsigned int freq
, unsigned int wait
,
3360 const u8
*dst
, const u8
*src
, const u8
*bssid
,
3361 const u8
*data
, size_t data_len
, int no_cck
);
3364 * send_action_cancel_wait - Cancel action frame TX wait
3365 * @priv: Private driver interface data
3367 * This command cancels the wait time associated with sending an action
3368 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3369 * set in the driver flags.
3371 void (*send_action_cancel_wait
)(void *priv
);
3374 * remain_on_channel - Remain awake on a channel
3375 * @priv: Private driver interface data
3376 * @freq: Frequency (in MHz) of the channel
3377 * @duration: Duration in milliseconds
3378 * Returns: 0 on success, -1 on failure
3380 * This command is used to request the driver to remain awake on the
3381 * specified channel for the specified duration and report received
3382 * Action frames with EVENT_RX_MGMT events. Optionally, received
3383 * Probe Request frames may also be requested to be reported by calling
3384 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3386 * The driver may not be at the requested channel when this function
3387 * returns, i.e., the return code is only indicating whether the
3388 * request was accepted. The caller will need to wait until the
3389 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3390 * completed the channel change. This may take some time due to other
3391 * need for the radio and the caller should be prepared to timing out
3392 * its wait since there are no guarantees on when this request can be
3395 int (*remain_on_channel
)(void *priv
, unsigned int freq
,
3396 unsigned int duration
);
3399 * cancel_remain_on_channel - Cancel remain-on-channel operation
3400 * @priv: Private driver interface data
3402 * This command can be used to cancel a remain-on-channel operation
3403 * before its originally requested duration has passed. This could be
3404 * used, e.g., when remain_on_channel() is used to request extra time
3405 * to receive a response to an Action frame and the response is
3406 * received when there is still unneeded time remaining on the
3407 * remain-on-channel operation.
3409 int (*cancel_remain_on_channel
)(void *priv
);
3412 * probe_req_report - Request Probe Request frames to be indicated
3413 * @priv: Private driver interface data
3414 * @report: Whether to report received Probe Request frames
3415 * Returns: 0 on success, -1 on failure (or if not supported)
3417 * This command can be used to request the driver to indicate when
3418 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3419 * Since this operation may require extra resources, e.g., due to less
3420 * optimal hardware/firmware RX filtering, many drivers may disable
3421 * Probe Request reporting at least in station mode. This command is
3422 * used to notify the driver when the Probe Request frames need to be
3423 * reported, e.g., during remain-on-channel operations.
3425 int (*probe_req_report
)(void *priv
, int report
);
3428 * deinit_ap - Deinitialize AP mode
3429 * @priv: Private driver interface data
3430 * Returns: 0 on success, -1 on failure (or if not supported)
3432 * This optional function can be used to disable AP mode related
3433 * configuration. If the interface was not dynamically added,
3434 * change the driver mode to station mode to allow normal station
3435 * operations like scanning to be completed.
3437 int (*deinit_ap
)(void *priv
);
3440 * deinit_p2p_cli - Deinitialize P2P client mode
3441 * @priv: Private driver interface data
3442 * Returns: 0 on success, -1 on failure (or if not supported)
3444 * This optional function can be used to disable P2P client mode. If the
3445 * interface was not dynamically added, change the interface type back
3448 int (*deinit_p2p_cli
)(void *priv
);
3451 * suspend - Notification on system suspend/hibernate event
3452 * @priv: Private driver interface data
3454 void (*suspend
)(void *priv
);
3457 * resume - Notification on system resume/thaw event
3458 * @priv: Private driver interface data
3460 void (*resume
)(void *priv
);
3463 * signal_monitor - Set signal monitoring parameters
3464 * @priv: Private driver interface data
3465 * @threshold: Threshold value for signal change events; 0 = disabled
3466 * @hysteresis: Minimum change in signal strength before indicating a
3468 * Returns: 0 on success, -1 on failure (or if not supported)
3470 * This function can be used to configure monitoring of signal strength
3471 * with the current AP. Whenever signal strength drops below the
3472 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3473 * should be generated assuming the signal strength has changed at
3474 * least %hysteresis from the previously indicated signal change event.
3476 int (*signal_monitor
)(void *priv
, int threshold
, int hysteresis
);
3479 * get_noa - Get current Notice of Absence attribute payload
3480 * @priv: Private driver interface data
3481 * @buf: Buffer for returning NoA
3482 * @buf_len: Buffer length in octets
3483 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3484 * advertized, or -1 on failure
3486 * This function is used to fetch the current Notice of Absence
3487 * attribute value from GO.
3489 int (*get_noa
)(void *priv
, u8
*buf
, size_t buf_len
);
3492 * set_noa - Set Notice of Absence parameters for GO (testing)
3493 * @priv: Private driver interface data
3495 * @start: Start time in ms from next TBTT
3496 * @duration: Duration in ms
3497 * Returns: 0 on success or -1 on failure
3499 * This function is used to set Notice of Absence parameters for GO. It
3500 * is used only for testing. To disable NoA, all parameters are set to
3503 int (*set_noa
)(void *priv
, u8 count
, int start
, int duration
);
3506 * set_p2p_powersave - Set P2P power save options
3507 * @priv: Private driver interface data
3508 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3509 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3510 * @ctwindow: 0.. = change (msec), -1 = no change
3511 * Returns: 0 on success or -1 on failure
3513 int (*set_p2p_powersave
)(void *priv
, int legacy_ps
, int opp_ps
,
3517 * ampdu - Enable/disable aggregation
3518 * @priv: Private driver interface data
3519 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3520 * Returns: 0 on success or -1 on failure
3522 int (*ampdu
)(void *priv
, int ampdu
);
3525 * get_radio_name - Get physical radio name for the device
3526 * @priv: Private driver interface data
3527 * Returns: Radio name or %NULL if not known
3529 * The returned data must not be modified by the caller. It is assumed
3530 * that any interface that has the same radio name as another is
3531 * sharing the same physical radio. This information can be used to
3532 * share scan results etc. information between the virtual interfaces
3533 * to speed up various operations.
3535 const char * (*get_radio_name
)(void *priv
);
3538 * send_tdls_mgmt - for sending TDLS management packets
3539 * @priv: private driver interface data
3540 * @dst: Destination (peer) MAC address
3541 * @action_code: TDLS action code for the mssage
3542 * @dialog_token: Dialog Token to use in the message (if needed)
3543 * @status_code: Status Code or Reason Code to use (if needed)
3544 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
3545 * @initiator: Is the current end the TDLS link initiator
3546 * @buf: TDLS IEs to add to the message
3547 * @len: Length of buf in octets
3548 * Returns: 0 on success, negative (<0) on failure
3550 * This optional function can be used to send packet to driver which is
3551 * responsible for receiving and sending all TDLS packets.
3553 int (*send_tdls_mgmt
)(void *priv
, const u8
*dst
, u8 action_code
,
3554 u8 dialog_token
, u16 status_code
, u32 peer_capab
,
3555 int initiator
, const u8
*buf
, size_t len
);
3558 * tdls_oper - Ask the driver to perform high-level TDLS operations
3559 * @priv: Private driver interface data
3560 * @oper: TDLS high-level operation. See %enum tdls_oper
3561 * @peer: Destination (peer) MAC address
3562 * Returns: 0 on success, negative (<0) on failure
3564 * This optional function can be used to send high-level TDLS commands
3567 int (*tdls_oper
)(void *priv
, enum tdls_oper oper
, const u8
*peer
);
3570 * wnm_oper - Notify driver of the WNM frame reception
3571 * @priv: Private driver interface data
3572 * @oper: WNM operation. See %enum wnm_oper
3573 * @peer: Destination (peer) MAC address
3574 * @buf: Buffer for the driver to fill in (for getting IE)
3575 * @buf_len: Return the len of buf
3576 * Returns: 0 on success, negative (<0) on failure
3578 int (*wnm_oper
)(void *priv
, enum wnm_oper oper
, const u8
*peer
,
3579 u8
*buf
, u16
*buf_len
);
3582 * set_qos_map - Set QoS Map
3583 * @priv: Private driver interface data
3584 * @qos_map_set: QoS Map
3585 * @qos_map_set_len: Length of QoS Map
3587 int (*set_qos_map
)(void *priv
, const u8
*qos_map_set
,
3588 u8 qos_map_set_len
);
3591 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3592 * @priv: Private driver interface data
3593 * @version: IP version of the IP address, 4 or 6
3594 * @ipaddr: IP address for the neigh entry
3595 * @prefixlen: IP address prefix length
3596 * @addr: Corresponding MAC address
3597 * Returns: 0 on success, negative (<0) on failure
3599 int (*br_add_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
,
3600 int prefixlen
, const u8
*addr
);
3603 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3604 * @priv: Private driver interface data
3605 * @version: IP version of the IP address, 4 or 6
3606 * @ipaddr: IP address for the neigh entry
3607 * Returns: 0 on success, negative (<0) on failure
3609 int (*br_delete_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
);
3612 * br_port_set_attr - Set a bridge port attribute
3613 * @attr: Bridge port attribute to set
3614 * @val: Value to be set
3615 * Returns: 0 on success, negative (<0) on failure
3617 int (*br_port_set_attr
)(void *priv
, enum drv_br_port_attr attr
,
3621 * br_port_set_attr - Set a bridge network parameter
3622 * @param: Bridge parameter to set
3623 * @val: Value to be set
3624 * Returns: 0 on success, negative (<0) on failure
3626 int (*br_set_net_param
)(void *priv
, enum drv_br_net_param param
,
3630 * get_wowlan - Get wake-on-wireless status
3631 * @priv: Private driver interface data
3633 int (*get_wowlan
)(void *priv
);
3636 * set_wowlan - Set wake-on-wireless triggers
3637 * @priv: Private driver interface data
3638 * @triggers: wowlan triggers
3640 int (*set_wowlan
)(void *priv
, const struct wowlan_triggers
*triggers
);
3643 * signal_poll - Get current connection information
3644 * @priv: Private driver interface data
3645 * @signal_info: Connection info structure
3647 int (*signal_poll
)(void *priv
, struct wpa_signal_info
*signal_info
);
3650 * channel_info - Get parameters of the current operating channel
3651 * @priv: Private driver interface data
3652 * @channel_info: Channel info structure
3653 * Returns: 0 on success, negative (<0) on failure
3655 int (*channel_info
)(void *priv
, struct wpa_channel_info
*channel_info
);
3658 * set_authmode - Set authentication algorithm(s) for static WEP
3659 * @priv: Private driver interface data
3660 * @authmode: 1=Open System, 2=Shared Key, 3=both
3661 * Returns: 0 on success, -1 on failure
3663 * This function can be used to set authentication algorithms for AP
3664 * mode when static WEP is used. If the driver uses user space MLME/SME
3665 * implementation, there is no need to implement this function.
3667 * DEPRECATED - use set_ap() instead
3669 int (*set_authmode
)(void *priv
, int authmode
);
3673 * driver_cmd - Execute driver-specific command
3674 * @priv: Private driver interface data
3675 * @cmd: Command to execute
3676 * @buf: Return buffer
3677 * @buf_len: Buffer length
3678 * Returns: 0 on success, -1 on failure
3680 int (*driver_cmd
)(void *priv
, char *cmd
, char *buf
, size_t buf_len
);
3681 #endif /* ANDROID */
3684 * vendor_cmd - Execute vendor specific command
3685 * @priv: Private driver interface data
3686 * @vendor_id: Vendor id
3687 * @subcmd: Vendor command id
3688 * @data: Vendor command parameters (%NULL if no parameters)
3689 * @data_len: Data length
3690 * @buf: Return buffer (%NULL to ignore reply)
3691 * Returns: 0 on success, negative (<0) on failure
3693 * This function handles vendor specific commands that are passed to
3694 * the driver/device. The command is identified by vendor id and
3695 * command id. Parameters can be passed as argument to the command
3696 * in the data buffer. Reply (if any) will be filled in the supplied
3699 * The exact driver behavior is driver interface and vendor specific. As
3700 * an example, this will be converted to a vendor specific cfg80211
3701 * command in case of the nl80211 driver interface.
3703 int (*vendor_cmd
)(void *priv
, unsigned int vendor_id
,
3704 unsigned int subcmd
, const u8
*data
, size_t data_len
,
3705 struct wpabuf
*buf
);
3708 * set_rekey_info - Set rekey information
3709 * @priv: Private driver interface data
3711 * @kek_len: KEK length in octets
3713 * @kck_len: KCK length in octets
3714 * @replay_ctr: Current EAPOL-Key Replay Counter
3716 * This optional function can be used to provide information for the
3717 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3718 * while the host (including wpa_supplicant) is sleeping.
3720 void (*set_rekey_info
)(void *priv
, const u8
*kek
, size_t kek_len
,
3721 const u8
*kck
, size_t kck_len
,
3722 const u8
*replay_ctr
);
3725 * sta_assoc - Station association indication
3726 * @priv: Private driver interface data
3727 * @own_addr: Source address and BSSID for association frame
3728 * @addr: MAC address of the station to associate
3729 * @reassoc: flag to indicate re-association
3730 * @status: association response status code
3731 * @ie: assoc response ie buffer
3732 * @len: ie buffer length
3733 * Returns: 0 on success, -1 on failure
3735 * This function indicates the driver to send (Re)Association
3736 * Response frame to the station.
3738 int (*sta_assoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
3739 int reassoc
, u16 status
, const u8
*ie
, size_t len
);
3742 * sta_auth - Station authentication indication
3743 * @priv: private driver interface data
3744 * @params: Station authentication parameters
3746 * Returns: 0 on success, -1 on failure
3748 int (*sta_auth
)(void *priv
,
3749 struct wpa_driver_sta_auth_params
*params
);
3752 * add_tspec - Add traffic stream
3753 * @priv: Private driver interface data
3754 * @addr: MAC address of the station to associate
3755 * @tspec_ie: tspec ie buffer
3756 * @tspec_ielen: tspec ie length
3757 * Returns: 0 on success, -1 on failure
3759 * This function adds the traffic steam for the station
3760 * and fills the medium_time in tspec_ie.
3762 int (*add_tspec
)(void *priv
, const u8
*addr
, u8
*tspec_ie
,
3763 size_t tspec_ielen
);
3766 * add_sta_node - Add a station node in the driver
3767 * @priv: Private driver interface data
3768 * @addr: MAC address of the station to add
3769 * @auth_alg: authentication algorithm used by the station
3770 * Returns: 0 on success, -1 on failure
3772 * This function adds the station node in the driver, when
3773 * the station gets added by FT-over-DS.
3775 int (*add_sta_node
)(void *priv
, const u8
*addr
, u16 auth_alg
);
3778 * sched_scan - Request the driver to initiate scheduled scan
3779 * @priv: Private driver interface data
3780 * @params: Scan parameters
3781 * Returns: 0 on success, -1 on failure
3783 * This operation should be used for scheduled scan offload to
3784 * the hardware. Every time scan results are available, the
3785 * driver should report scan results event for wpa_supplicant
3786 * which will eventually request the results with
3787 * wpa_driver_get_scan_results2(). This operation is optional
3788 * and if not provided or if it returns -1, we fall back to
3789 * normal host-scheduled scans.
3791 int (*sched_scan
)(void *priv
, struct wpa_driver_scan_params
*params
);
3794 * stop_sched_scan - Request the driver to stop a scheduled scan
3795 * @priv: Private driver interface data
3796 * Returns: 0 on success, -1 on failure
3798 * This should cause the scheduled scan to be stopped and
3799 * results should stop being sent. Must be supported if
3800 * sched_scan is supported.
3802 int (*stop_sched_scan
)(void *priv
);
3805 * poll_client - Probe (null data or such) the given station
3806 * @priv: Private driver interface data
3807 * @own_addr: MAC address of sending interface
3808 * @addr: MAC address of the station to probe
3809 * @qos: Indicates whether station is QoS station
3811 * This function is used to verify whether an associated station is
3812 * still present. This function does not need to be implemented if the
3813 * driver provides such inactivity polling mechanism.
3815 void (*poll_client
)(void *priv
, const u8
*own_addr
,
3816 const u8
*addr
, int qos
);
3819 * radio_disable - Disable/enable radio
3820 * @priv: Private driver interface data
3821 * @disabled: 1=disable 0=enable radio
3822 * Returns: 0 on success, -1 on failure
3824 * This optional command is for testing purposes. It can be used to
3825 * disable the radio on a testbed device to simulate out-of-radio-range
3828 int (*radio_disable
)(void *priv
, int disabled
);
3831 * switch_channel - Announce channel switch and migrate the GO to the
3833 * @priv: Private driver interface data
3834 * @settings: Settings for CSA period and new channel
3835 * Returns: 0 on success, -1 on failure
3837 * This function is used to move the GO to the legacy STA channel to
3838 * avoid frequency conflict in single channel concurrency.
3840 int (*switch_channel
)(void *priv
, struct csa_settings
*settings
);
3843 * add_tx_ts - Add traffic stream
3844 * @priv: Private driver interface data
3845 * @tsid: Traffic stream ID
3846 * @addr: Receiver address
3847 * @user_prio: User priority of the traffic stream
3848 * @admitted_time: Admitted time for this TS in units of
3849 * 32 microsecond periods (per second).
3850 * Returns: 0 on success, -1 on failure
3852 int (*add_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
, u8 user_prio
,
3856 * del_tx_ts - Delete traffic stream
3857 * @priv: Private driver interface data
3858 * @tsid: Traffic stream ID
3859 * @addr: Receiver address
3860 * Returns: 0 on success, -1 on failure
3862 int (*del_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
);
3865 * Enable channel-switching with TDLS peer
3866 * @priv: Private driver interface data
3867 * @addr: MAC address of the TDLS peer
3868 * @oper_class: Operating class of the switch channel
3869 * @params: Channel specification
3870 * Returns: 0 on success, -1 on failure
3872 * The function indicates to driver that it can start switching to a
3873 * different channel with a specified TDLS peer. The switching is
3874 * assumed on until canceled with tdls_disable_channel_switch().
3876 int (*tdls_enable_channel_switch
)(
3877 void *priv
, const u8
*addr
, u8 oper_class
,
3878 const struct hostapd_freq_params
*params
);
3881 * Disable channel switching with TDLS peer
3882 * @priv: Private driver interface data
3883 * @addr: MAC address of the TDLS peer
3884 * Returns: 0 on success, -1 on failure
3886 * This function indicates to the driver that it should stop switching
3887 * with a given TDLS peer.
3889 int (*tdls_disable_channel_switch
)(void *priv
, const u8
*addr
);
3892 * start_dfs_cac - Listen for radar interference on the channel
3893 * @priv: Private driver interface data
3894 * @freq: Channel parameters
3895 * Returns: 0 on success, -1 on failure
3897 int (*start_dfs_cac
)(void *priv
, struct hostapd_freq_params
*freq
);
3900 * stop_ap - Removes beacon from AP
3901 * @priv: Private driver interface data
3902 * Returns: 0 on success, -1 on failure (or if not supported)
3904 * This optional function can be used to disable AP mode related
3905 * configuration. Unlike deinit_ap, it does not change to station
3908 int (*stop_ap
)(void *priv
);
3911 * get_survey - Retrieve survey data
3912 * @priv: Private driver interface data
3913 * @freq: If set, survey data for the specified frequency is only
3914 * being requested. If not set, all survey data is requested.
3915 * Returns: 0 on success, -1 on failure
3917 * Use this to retrieve:
3919 * - the observed channel noise floor
3920 * - the amount of time we have spent on the channel
3921 * - the amount of time during which we have spent on the channel that
3922 * the radio has determined the medium is busy and we cannot
3924 * - the amount of time we have spent receiving data
3925 * - the amount of time we have spent transmitting data
3927 * This data can be used for spectrum heuristics. One example is
3928 * Automatic Channel Selection (ACS). The channel survey data is
3929 * kept on a linked list on the channel data, one entry is added
3930 * for each survey. The min_nf of the channel is updated for each
3933 int (*get_survey
)(void *priv
, unsigned int freq
);
3936 * status - Get driver interface status information
3937 * @priv: Private driver interface data
3938 * @buf: Buffer for printing the status information
3939 * @buflen: Maximum length of the buffer
3940 * Returns: Length of written status information or -1 on failure
3942 int (*status
)(void *priv
, char *buf
, size_t buflen
);
3945 * roaming - Set roaming policy for driver-based BSS selection
3946 * @priv: Private driver interface data
3947 * @allowed: Whether roaming within ESS is allowed
3948 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3949 * Returns: Length of written status information or -1 on failure
3951 * This optional callback can be used to update roaming policy from the
3952 * associate() command (bssid being set there indicates that the driver
3953 * should not roam before getting this roaming() call to allow roaming.
3954 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3955 * capability, roaming policy is handled within wpa_supplicant and there
3956 * is no need to implement or react to this callback.
3958 int (*roaming
)(void *priv
, int allowed
, const u8
*bssid
);
3961 * disable_fils - Enable/disable FILS feature
3962 * @priv: Private driver interface data
3963 * @disable: 0-enable and 1-disable FILS feature
3964 * Returns: 0 on success, -1 on failure
3966 * This callback can be used to configure driver and below layers to
3967 * enable/disable all FILS features.
3969 int (*disable_fils
)(void *priv
, int disable
);
3972 * set_mac_addr - Set MAC address
3973 * @priv: Private driver interface data
3974 * @addr: MAC address to use or %NULL for setting back to permanent
3975 * Returns: 0 on success, -1 on failure
3977 int (*set_mac_addr
)(void *priv
, const u8
*addr
);
3979 #ifdef CONFIG_MACSEC
3980 int (*macsec_init
)(void *priv
, struct macsec_init_params
*params
);
3982 int (*macsec_deinit
)(void *priv
);
3985 * macsec_get_capability - Inform MKA of this driver's capability
3986 * @priv: Private driver interface data
3987 * @cap: Driver's capability
3988 * Returns: 0 on success, -1 on failure
3990 int (*macsec_get_capability
)(void *priv
, enum macsec_cap
*cap
);
3993 * enable_protect_frames - Set protect frames status
3994 * @priv: Private driver interface data
3995 * @enabled: TRUE = protect frames enabled
3996 * FALSE = protect frames disabled
3997 * Returns: 0 on success, -1 on failure (or if not supported)
3999 int (*enable_protect_frames
)(void *priv
, Boolean enabled
);
4002 * enable_encrypt - Set encryption status
4003 * @priv: Private driver interface data
4004 * @enabled: TRUE = encrypt outgoing traffic
4005 * FALSE = integrity-only protection on outgoing traffic
4006 * Returns: 0 on success, -1 on failure (or if not supported)
4008 int (*enable_encrypt
)(void *priv
, Boolean enabled
);
4011 * set_replay_protect - Set replay protect status and window size
4012 * @priv: Private driver interface data
4013 * @enabled: TRUE = replay protect enabled
4014 * FALSE = replay protect disabled
4015 * @window: replay window size, valid only when replay protect enabled
4016 * Returns: 0 on success, -1 on failure (or if not supported)
4018 int (*set_replay_protect
)(void *priv
, Boolean enabled
, u32 window
);
4021 * set_current_cipher_suite - Set current cipher suite
4022 * @priv: Private driver interface data
4023 * @cs: EUI64 identifier
4024 * Returns: 0 on success, -1 on failure (or if not supported)
4026 int (*set_current_cipher_suite
)(void *priv
, u64 cs
);
4029 * enable_controlled_port - Set controlled port status
4030 * @priv: Private driver interface data
4031 * @enabled: TRUE = controlled port enabled
4032 * FALSE = controlled port disabled
4033 * Returns: 0 on success, -1 on failure (or if not supported)
4035 int (*enable_controlled_port
)(void *priv
, Boolean enabled
);
4038 * get_receive_lowest_pn - Get receive lowest pn
4039 * @priv: Private driver interface data
4040 * @sa: secure association
4041 * Returns: 0 on success, -1 on failure (or if not supported)
4043 int (*get_receive_lowest_pn
)(void *priv
, struct receive_sa
*sa
);
4046 * get_transmit_next_pn - Get transmit next pn
4047 * @priv: Private driver interface data
4048 * @sa: secure association
4049 * Returns: 0 on success, -1 on failure (or if not supported)
4051 int (*get_transmit_next_pn
)(void *priv
, struct transmit_sa
*sa
);
4054 * set_transmit_next_pn - Set transmit next pn
4055 * @priv: Private driver interface data
4056 * @sa: secure association
4057 * Returns: 0 on success, -1 on failure (or if not supported)
4059 int (*set_transmit_next_pn
)(void *priv
, struct transmit_sa
*sa
);
4062 * set_receive_lowest_pn - Set receive lowest PN
4063 * @priv: Private driver interface data
4064 * @sa: secure association
4065 * Returns: 0 on success, -1 on failure (or if not supported)
4067 int (*set_receive_lowest_pn
)(void *priv
, struct receive_sa
*sa
);
4070 * create_receive_sc - create secure channel for receiving
4071 * @priv: Private driver interface data
4072 * @sc: secure channel
4073 * @conf_offset: confidentiality offset (0, 30, or 50)
4074 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
4076 * Returns: 0 on success, -1 on failure (or if not supported)
4078 int (*create_receive_sc
)(void *priv
, struct receive_sc
*sc
,
4079 unsigned int conf_offset
,
4083 * delete_receive_sc - delete secure connection for receiving
4084 * @priv: private driver interface data from init()
4085 * @sc: secure channel
4086 * Returns: 0 on success, -1 on failure
4088 int (*delete_receive_sc
)(void *priv
, struct receive_sc
*sc
);
4091 * create_receive_sa - create secure association for receive
4092 * @priv: private driver interface data from init()
4093 * @sa: secure association
4094 * Returns: 0 on success, -1 on failure
4096 int (*create_receive_sa
)(void *priv
, struct receive_sa
*sa
);
4099 * delete_receive_sa - Delete secure association for receive
4100 * @priv: Private driver interface data from init()
4101 * @sa: Secure association
4102 * Returns: 0 on success, -1 on failure
4104 int (*delete_receive_sa
)(void *priv
, struct receive_sa
*sa
);
4107 * enable_receive_sa - enable the SA for receive
4108 * @priv: private driver interface data from init()
4109 * @sa: secure association
4110 * Returns: 0 on success, -1 on failure
4112 int (*enable_receive_sa
)(void *priv
, struct receive_sa
*sa
);
4115 * disable_receive_sa - disable SA for receive
4116 * @priv: private driver interface data from init()
4117 * @sa: secure association
4118 * Returns: 0 on success, -1 on failure
4120 int (*disable_receive_sa
)(void *priv
, struct receive_sa
*sa
);
4123 * create_transmit_sc - create secure connection for transmit
4124 * @priv: private driver interface data from init()
4125 * @sc: secure channel
4126 * @conf_offset: confidentiality offset (0, 30, or 50)
4127 * Returns: 0 on success, -1 on failure
4129 int (*create_transmit_sc
)(void *priv
, struct transmit_sc
*sc
,
4130 unsigned int conf_offset
);
4133 * delete_transmit_sc - delete secure connection for transmit
4134 * @priv: private driver interface data from init()
4135 * @sc: secure channel
4136 * Returns: 0 on success, -1 on failure
4138 int (*delete_transmit_sc
)(void *priv
, struct transmit_sc
*sc
);
4141 * create_transmit_sa - create secure association for transmit
4142 * @priv: private driver interface data from init()
4143 * @sa: secure association
4144 * Returns: 0 on success, -1 on failure
4146 int (*create_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
4149 * delete_transmit_sa - Delete secure association for transmit
4150 * @priv: Private driver interface data from init()
4151 * @sa: Secure association
4152 * Returns: 0 on success, -1 on failure
4154 int (*delete_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
4157 * enable_transmit_sa - enable SA for transmit
4158 * @priv: private driver interface data from init()
4159 * @sa: secure association
4160 * Returns: 0 on success, -1 on failure
4162 int (*enable_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
4165 * disable_transmit_sa - disable SA for transmit
4166 * @priv: private driver interface data from init()
4167 * @sa: secure association
4168 * Returns: 0 on success, -1 on failure
4170 int (*disable_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
4171 #endif /* CONFIG_MACSEC */
4174 * init_mesh - Driver specific initialization for mesh
4175 * @priv: Private driver interface data
4176 * Returns: 0 on success, -1 on failure
4178 int (*init_mesh
)(void *priv
);
4181 * join_mesh - Join a mesh network
4182 * @priv: Private driver interface data
4183 * @params: Mesh configuration parameters
4184 * Returns: 0 on success, -1 on failure
4186 int (*join_mesh
)(void *priv
,
4187 struct wpa_driver_mesh_join_params
*params
);
4190 * leave_mesh - Leave a mesh network
4191 * @priv: Private driver interface data
4192 * Returns 0 on success, -1 on failure
4194 int (*leave_mesh
)(void *priv
);
4197 * probe_mesh_link - Inject a frame over direct mesh link to a given
4198 * peer skipping the next_hop lookup from mpath table.
4199 * @priv: Private driver interface data
4200 * @addr: Peer MAC address
4201 * @eth: Ethernet frame to be sent
4202 * @len: Ethernet frame lengtn in bytes
4203 * Returns 0 on success, -1 on failure
4205 int (*probe_mesh_link
)(void *priv
, const u8
*addr
, const u8
*eth
,
4209 * do_acs - Automatically select channel
4210 * @priv: Private driver interface data
4211 * @params: Parameters for ACS
4212 * Returns 0 on success, -1 on failure
4214 * This command can be used to offload ACS to the driver if the driver
4215 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
4217 int (*do_acs
)(void *priv
, struct drv_acs_params
*params
);
4220 * set_band - Notify driver of band selection
4221 * @priv: Private driver interface data
4222 * @band: The selected band(s)
4223 * Returns 0 on success, -1 on failure
4225 int (*set_band
)(void *priv
, enum set_band band
);
4228 * get_pref_freq_list - Get preferred frequency list for an interface
4229 * @priv: Private driver interface data
4230 * @if_type: Interface type
4231 * @num: Number of channels
4232 * @freq_list: Preferred channel frequency list encoded in MHz values
4233 * Returns 0 on success, -1 on failure
4235 * This command can be used to query the preferred frequency list from
4236 * the driver specific to a particular interface type.
4238 int (*get_pref_freq_list
)(void *priv
, enum wpa_driver_if_type if_type
,
4239 unsigned int *num
, unsigned int *freq_list
);
4242 * set_prob_oper_freq - Indicate probable P2P operating channel
4243 * @priv: Private driver interface data
4244 * @freq: Channel frequency in MHz
4245 * Returns 0 on success, -1 on failure
4247 * This command can be used to inform the driver of the operating
4248 * frequency that an ongoing P2P group formation is likely to come up
4249 * on. Local device is assuming P2P Client role.
4251 int (*set_prob_oper_freq
)(void *priv
, unsigned int freq
);
4254 * abort_scan - Request the driver to abort an ongoing scan
4255 * @priv: Private driver interface data
4256 * @scan_cookie: Cookie identifying the scan request. This is used only
4257 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4258 * was used to trigger scan. Otherwise, 0 is used.
4259 * Returns 0 on success, -1 on failure
4261 int (*abort_scan
)(void *priv
, u64 scan_cookie
);
4264 * configure_data_frame_filters - Request to configure frame filters
4265 * @priv: Private driver interface data
4266 * @filter_flags: The type of frames to filter (bitfield of
4267 * WPA_DATA_FRAME_FILTER_FLAG_*)
4268 * Returns: 0 on success or -1 on failure
4270 int (*configure_data_frame_filters
)(void *priv
, u32 filter_flags
);
4273 * get_ext_capab - Get extended capabilities for the specified interface
4274 * @priv: Private driver interface data
4275 * @type: Interface type for which to get extended capabilities
4276 * @ext_capab: Extended capabilities fetched
4277 * @ext_capab_mask: Extended capabilities mask
4278 * @ext_capab_len: Length of the extended capabilities
4279 * Returns: 0 on success or -1 on failure
4281 int (*get_ext_capab
)(void *priv
, enum wpa_driver_if_type type
,
4282 const u8
**ext_capab
, const u8
**ext_capab_mask
,
4283 unsigned int *ext_capab_len
);
4286 * p2p_lo_start - Start offloading P2P listen to device
4287 * @priv: Private driver interface data
4288 * @freq: Listening frequency (MHz) for P2P listen
4289 * @period: Length of the listen operation in milliseconds
4290 * @interval: Interval for running the listen operation in milliseconds
4291 * @count: Number of times to run the listen operation
4292 * @device_types: Device primary and secondary types
4293 * @dev_types_len: Number of bytes for device_types
4294 * @ies: P2P IE and WSC IE for Probe Response frames
4295 * @ies_len: Length of ies in bytes
4296 * Returns: 0 on success or -1 on failure
4298 int (*p2p_lo_start
)(void *priv
, unsigned int freq
,
4299 unsigned int period
, unsigned int interval
,
4301 const u8
*device_types
, size_t dev_types_len
,
4302 const u8
*ies
, size_t ies_len
);
4305 * p2p_lo_stop - Stop P2P listen offload
4306 * @priv: Private driver interface data
4307 * Returns: 0 on success or -1 on failure
4309 int (*p2p_lo_stop
)(void *priv
);
4312 * set_default_scan_ies - Set default scan IEs
4313 * @priv: Private driver interface data
4314 * @ies: Scan default IEs buffer
4315 * @ies_len: Length of IEs in bytes
4316 * Returns: 0 on success or -1 on failure
4318 * The driver can use these by default when there are no scan IEs coming
4319 * in the subsequent scan requests. Also in case of one or more of IEs
4320 * given in set_default_scan_ies() are missing in the subsequent scan
4321 * request, the driver should merge the missing scan IEs in the scan
4322 * request from the IEs set by set_default_scan_ies() in the Probe
4323 * Request frames sent.
4325 int (*set_default_scan_ies
)(void *priv
, const u8
*ies
, size_t ies_len
);
4328 * set_tdls_mode - Set TDLS trigger mode to the host driver
4329 * @priv: Private driver interface data
4330 * @tdls_external_control: Represents if TDLS external trigger control
4331 * mode is enabled/disabled.
4333 * This optional callback can be used to configure the TDLS external
4334 * trigger control mode to the host driver.
4336 int (*set_tdls_mode
)(void *priv
, int tdls_external_control
);
4339 * get_bss_transition_status - Get candidate BSS's transition status
4340 * @priv: Private driver interface data
4341 * @params: Candidate BSS list
4343 * Get the accept or reject reason code for a list of BSS transition
4346 struct wpa_bss_candidate_info
*
4347 (*get_bss_transition_status
)(void *priv
,
4348 struct wpa_bss_trans_info
*params
);
4350 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
4351 * @priv: Private driver interface data
4352 * @ignore_disallow: 0 to not ignore, 1 to ignore
4353 * Returns: 0 on success, -1 on failure
4355 int (*ignore_assoc_disallow
)(void *priv
, int ignore_disallow
);
4358 * set_bssid_blacklist - Set blacklist of BSSIDs to the driver
4359 * @priv: Private driver interface data
4360 * @num_bssid: Number of blacklist BSSIDs
4361 * @bssids: List of blacklisted BSSIDs
4363 int (*set_bssid_blacklist
)(void *priv
, unsigned int num_bssid
,
4367 * update_connect_params - Update the connection parameters
4368 * @priv: Private driver interface data
4369 * @params: Association parameters
4370 * @mask: Bit mask indicating which parameters in @params have to be
4372 * Returns: 0 on success, -1 on failure
4374 * Update the connection parameters when in connected state so that the
4375 * driver uses the updated parameters for subsequent roaming. This is
4376 * used only with drivers that implement internal BSS selection and
4379 int (*update_connect_params
)(
4380 void *priv
, struct wpa_driver_associate_params
*params
,
4381 enum wpa_drv_update_connect_params_mask mask
);
4384 * send_external_auth_status - Indicate the status of external
4385 * authentication processing to the host driver.
4386 * @priv: Private driver interface data
4387 * @params: Status of authentication processing.
4388 * Returns: 0 on success, -1 on failure
4390 int (*send_external_auth_status
)(void *priv
,
4391 struct external_auth
*params
);
4394 * set_4addr_mode - Set 4-address mode
4395 * @priv: Private driver interface data
4396 * @bridge_ifname: Bridge interface name
4397 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
4398 * Returns: 0 on success, < 0 on failure
4400 int (*set_4addr_mode
)(void *priv
, const char *bridge_ifname
, int val
);
4403 * update_dh_ie - Update DH IE
4404 * @priv: Private driver interface data
4405 * @peer_mac: Peer MAC address
4406 * @reason_code: Reacon code
4408 * @ie_len: DH IE length in bytes
4409 * Returns: 0 on success, -1 on failure
4411 * This callback is used to let the driver know the DH processing result
4412 * and DH IE for a pending association.
4414 int (*update_dh_ie
)(void *priv
, const u8
*peer_mac
, u16 reason_code
,
4415 const u8
*ie
, size_t ie_len
);
4419 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
4421 enum wpa_event_type
{
4423 * EVENT_ASSOC - Association completed
4425 * This event needs to be delivered when the driver completes IEEE
4426 * 802.11 association or reassociation successfully.
4427 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
4428 * after this event has been generated. In addition, optional
4429 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
4430 * more information about the association. If the driver interface gets
4431 * both of these events at the same time, it can also include the
4432 * assoc_info data in EVENT_ASSOC call.
4437 * EVENT_DISASSOC - Association lost
4439 * This event should be called when association is lost either due to
4440 * receiving deauthenticate or disassociate frame from the AP or when
4441 * sending either of these frames to the current AP. If the driver
4442 * supports separate deauthentication event, EVENT_DISASSOC should only
4443 * be used for disassociation and EVENT_DEAUTH for deauthentication.
4444 * In AP mode, union wpa_event_data::disassoc_info is required.
4449 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
4451 * This event must be delivered when a Michael MIC error is detected by
4452 * the local driver. Additional data for event processing is
4453 * provided with union wpa_event_data::michael_mic_failure. This
4454 * information is used to request new encyption key and to initiate
4455 * TKIP countermeasures if needed.
4457 EVENT_MICHAEL_MIC_FAILURE
,
4460 * EVENT_SCAN_RESULTS - Scan results available
4462 * This event must be called whenever scan results are available to be
4463 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4464 * is expected to be used some time after struct wpa_driver_ops::scan()
4465 * is called. If the driver provides an unsolicited event when the scan
4466 * has been completed, this event can be used to trigger
4467 * EVENT_SCAN_RESULTS call. If such event is not available from the
4468 * driver, the driver wrapper code is expected to use a registered
4469 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
4470 * scan is expected to be completed. Optional information about
4471 * completed scan can be provided with union wpa_event_data::scan_info.
4476 * EVENT_ASSOCINFO - Report optional extra information for association
4478 * This event can be used to report extra association information for
4479 * EVENT_ASSOC processing. This extra information includes IEs from
4480 * association frames and Beacon/Probe Response frames in union
4481 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4482 * EVENT_ASSOC. Alternatively, the driver interface can include
4483 * assoc_info data in the EVENT_ASSOC call if it has all the
4484 * information available at the same point.
4489 * EVENT_INTERFACE_STATUS - Report interface status changes
4491 * This optional event can be used to report changes in interface
4492 * status (interface added/removed) using union
4493 * wpa_event_data::interface_status. This can be used to trigger
4494 * wpa_supplicant to stop and re-start processing for the interface,
4495 * e.g., when a cardbus card is ejected/inserted.
4497 EVENT_INTERFACE_STATUS
,
4500 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4502 * This event can be used to inform wpa_supplicant about candidates for
4503 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4504 * for scan request (ap_scan=2 mode), this event is required for
4505 * pre-authentication. If wpa_supplicant is performing scan request
4506 * (ap_scan=1), this event is optional since scan results can be used
4507 * to add pre-authentication candidates. union
4508 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4509 * candidate and priority of the candidate, e.g., based on the signal
4510 * strength, in order to try to pre-authenticate first with candidates
4511 * that are most likely targets for re-association.
4513 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4514 * on the candidate list. In addition, it can be called for the current
4515 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4516 * will automatically skip pre-authentication in cases where a valid
4517 * PMKSA exists. When more than one candidate exists, this event should
4518 * be generated once for each candidate.
4520 * Driver will be notified about successful pre-authentication with
4521 * struct wpa_driver_ops::add_pmkid() calls.
4523 EVENT_PMKID_CANDIDATE
,
4526 * EVENT_TDLS - Request TDLS operation
4528 * This event can be used to request a TDLS operation to be performed.
4533 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4535 * The driver is expected to report the received FT IEs from
4536 * FT authentication sequence from the AP. The FT IEs are included in
4537 * the extra information in union wpa_event_data::ft_ies.
4542 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4544 * The driver can use this event to inform wpa_supplicant about a STA
4545 * in an IBSS with which protected frames could be exchanged. This
4546 * event starts RSN authentication with the other STA to authenticate
4547 * the STA and set up encryption keys with it.
4549 EVENT_IBSS_RSN_START
,
4552 * EVENT_AUTH - Authentication result
4554 * This event should be called when authentication attempt has been
4555 * completed. This is only used if the driver supports separate
4556 * authentication step (struct wpa_driver_ops::authenticate).
4557 * Information about authentication result is included in
4558 * union wpa_event_data::auth.
4563 * EVENT_DEAUTH - Authentication lost
4565 * This event should be called when authentication is lost either due
4566 * to receiving deauthenticate frame from the AP or when sending that
4567 * frame to the current AP.
4568 * In AP mode, union wpa_event_data::deauth_info is required.
4573 * EVENT_ASSOC_REJECT - Association rejected
4575 * This event should be called when (re)association attempt has been
4576 * rejected by the AP. Information about the association response is
4577 * included in union wpa_event_data::assoc_reject.
4582 * EVENT_AUTH_TIMED_OUT - Authentication timed out
4584 EVENT_AUTH_TIMED_OUT
,
4587 * EVENT_ASSOC_TIMED_OUT - Association timed out
4589 EVENT_ASSOC_TIMED_OUT
,
4592 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
4594 EVENT_WPS_BUTTON_PUSHED
,
4597 * EVENT_TX_STATUS - Report TX status
4602 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
4604 EVENT_RX_FROM_UNKNOWN
,
4607 * EVENT_RX_MGMT - Report RX of a management frame
4612 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
4614 * This event is used to indicate when the driver has started the
4615 * requested remain-on-channel duration. Information about the
4616 * operation is included in union wpa_event_data::remain_on_channel.
4618 EVENT_REMAIN_ON_CHANNEL
,
4621 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
4623 * This event is used to indicate when the driver has completed
4624 * remain-on-channel duration, i.e., may noot be available on the
4625 * requested channel anymore. Information about the
4626 * operation is included in union wpa_event_data::remain_on_channel.
4628 EVENT_CANCEL_REMAIN_ON_CHANNEL
,
4631 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
4633 * This event is used to indicate when a Probe Request frame has been
4634 * received. Information about the received frame is included in
4635 * union wpa_event_data::rx_probe_req. The driver is required to report
4636 * these events only after successfully completed probe_req_report()
4637 * commands to request the events (i.e., report parameter is non-zero)
4638 * in station mode. In AP mode, Probe Request frames should always be
4644 * EVENT_NEW_STA - New wired device noticed
4646 * This event is used to indicate that a new device has been detected
4647 * in a network that does not use association-like functionality (i.e.,
4648 * mainly wired Ethernet). This can be used to start EAPOL
4649 * authenticator when receiving a frame from a device. The address of
4650 * the device is included in union wpa_event_data::new_sta.
4655 * EVENT_EAPOL_RX - Report received EAPOL frame
4657 * When in AP mode with hostapd, this event is required to be used to
4658 * deliver the receive EAPOL frames from the driver.
4663 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4665 * This event is used to indicate changes in the signal strength
4666 * observed in frames received from the current AP if signal strength
4667 * monitoring has been enabled with signal_monitor().
4669 EVENT_SIGNAL_CHANGE
,
4672 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4674 * This event is used to indicate that the interface was enabled after
4675 * having been previously disabled, e.g., due to rfkill.
4677 EVENT_INTERFACE_ENABLED
,
4680 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4682 * This event is used to indicate that the interface was disabled,
4683 * e.g., due to rfkill.
4685 EVENT_INTERFACE_DISABLED
,
4688 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4690 * This event is used to indicate that the channel list has changed,
4691 * e.g., because of a regulatory domain change triggered by scan
4692 * results including an AP advertising a country code.
4694 EVENT_CHANNEL_LIST_CHANGED
,
4697 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4699 * This event is used to indicate that the driver cannot maintain this
4700 * interface in its operation mode anymore. The most likely use for
4701 * this is to indicate that AP mode operation is not available due to
4702 * operating channel would need to be changed to a DFS channel when
4703 * the driver does not support radar detection and another virtual
4704 * interfaces caused the operating channel to change. Other similar
4705 * resource conflicts could also trigger this for station mode
4706 * interfaces. This event can be propagated when channel switching
4709 EVENT_INTERFACE_UNAVAILABLE
,
4712 * EVENT_BEST_CHANNEL
4714 * Driver generates this event whenever it detects a better channel
4715 * (e.g., based on RSSI or channel use). This information can be used
4716 * to improve channel selection for a new AP/P2P group.
4721 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4723 * This event should be called when a Deauthentication frame is dropped
4724 * due to it not being protected (MFP/IEEE 802.11w).
4725 * union wpa_event_data::unprot_deauth is required to provide more
4726 * details of the frame.
4728 EVENT_UNPROT_DEAUTH
,
4731 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4733 * This event should be called when a Disassociation frame is dropped
4734 * due to it not being protected (MFP/IEEE 802.11w).
4735 * union wpa_event_data::unprot_disassoc is required to provide more
4736 * details of the frame.
4738 EVENT_UNPROT_DISASSOC
,
4741 * EVENT_STATION_LOW_ACK
4743 * Driver generates this event whenever it detected that a particular
4744 * station was lost. Detection can be through massive transmission
4745 * failures for example.
4747 EVENT_STATION_LOW_ACK
,
4750 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4752 EVENT_IBSS_PEER_LOST
,
4755 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4757 * This event carries the new replay counter to notify wpa_supplicant
4758 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4759 * completed Group Key Handshake while the host (including
4760 * wpa_supplicant was sleeping).
4762 EVENT_DRIVER_GTK_REKEY
,
4765 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4767 EVENT_SCHED_SCAN_STOPPED
,
4770 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4772 * This event indicates that the station responded to the poll
4773 * initiated with @poll_client.
4775 EVENT_DRIVER_CLIENT_POLL_OK
,
4778 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4780 EVENT_EAPOL_TX_STATUS
,
4783 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4785 * Described in wpa_event_data.ch_switch
4790 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
4792 * This is a pre-switch event indicating the shortly following switch
4793 * of operating channels.
4795 * Described in wpa_event_data.ch_switch
4797 EVENT_CH_SWITCH_STARTED
,
4799 * EVENT_WNM - Request WNM operation
4801 * This event can be used to request a WNM operation to be performed.
4806 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4808 * This event indicates that the driver reported a connection failure
4809 * with the specified client (for example, max client reached, etc.) in
4812 EVENT_CONNECT_FAILED_REASON
,
4815 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
4817 * A radar has been detected on the supplied frequency, hostapd should
4818 * react accordingly (e.g., change channel).
4820 EVENT_DFS_RADAR_DETECTED
,
4823 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
4825 * After a successful CAC, the channel can be marked clear and used.
4827 EVENT_DFS_CAC_FINISHED
,
4830 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
4832 * The CAC was not successful, and the channel remains in the previous
4833 * state. This may happen due to a radar being detected or other
4834 * external influences.
4836 EVENT_DFS_CAC_ABORTED
,
4839 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
4841 * The channel which was previously unavailable is now available again.
4843 EVENT_DFS_NOP_FINISHED
,
4846 * EVENT_SURVEY - Received survey data
4848 * This event gets triggered when a driver query is issued for survey
4849 * data and the requested data becomes available. The returned data is
4850 * stored in struct survey_results. The results provide at most one
4851 * survey entry for each frequency and at minimum will provide one
4852 * survey entry for one frequency. The survey data can be os_malloc()'d
4853 * and then os_free()'d, so the event callback must only copy data.
4858 * EVENT_SCAN_STARTED - Scan started
4860 * This indicates that driver has started a scan operation either based
4861 * on a request from wpa_supplicant/hostapd or from another application.
4862 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4863 * completed (either successfully or by getting cancelled).
4868 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4870 * This event indicates a set of frequency ranges that should be avoided
4871 * to reduce issues due to interference or internal co-existence
4872 * information in the driver.
4874 EVENT_AVOID_FREQUENCIES
,
4877 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4879 EVENT_NEW_PEER_CANDIDATE
,
4882 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4884 * Indicates a pair of primary and secondary channels chosen by ACS
4887 EVENT_ACS_CHANNEL_SELECTED
,
4890 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4893 * This event indicates that channel availability check has been started
4894 * on a DFS frequency by a driver that supports DFS Offload.
4896 EVENT_DFS_CAC_STARTED
,
4899 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4904 * EVENT_BEACON_LOSS - Beacon loss detected
4906 * This event indicates that no Beacon frames has been received from
4907 * the current AP. This may indicate that the AP is not anymore in
4913 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
4914 * done previously (Pre-CAC) on the channel has expired. This would
4915 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
4916 * channel will be moved from available to usable. A new CAC has to be
4917 * performed before start operating on this channel.
4919 EVENT_DFS_PRE_CAC_EXPIRED
,
4922 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
4923 * that do not define separate commands for authentication and
4924 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
4925 * authentication to wpa_supplicant. This event carries all the
4926 * necessary information from the host driver for the authentication to
4929 EVENT_EXTERNAL_AUTH
,
4932 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
4934 * This event should be indicated when the driver completes the 4-way
4935 * handshake. This event should be preceded by an EVENT_ASSOC that
4936 * indicates the completion of IEEE 802.11 association.
4938 EVENT_PORT_AUTHORIZED
,
4941 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
4944 EVENT_STATION_OPMODE_CHANGED
,
4947 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
4949 * This event is emitted when the MAC changes while the interface is
4950 * enabled. When an interface was disabled and becomes enabled, it
4951 * must be always assumed that the MAC possibly changed.
4953 EVENT_INTERFACE_MAC_CHANGED
,
4956 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
4958 * This event is emitted when an interface is added/removed for WDS STA.
4960 EVENT_WDS_STA_INTERFACE_STATUS
,
4963 * EVENT_UPDATE_DH - Notification of updated DH information
4970 * struct freq_survey - Channel survey info
4972 * @ifidx: Interface index in which this survey was observed
4973 * @freq: Center of frequency of the surveyed channel
4974 * @nf: Channel noise floor in dBm
4975 * @channel_time: Amount of time in ms the radio spent on the channel
4976 * @channel_time_busy: Amount of time in ms the radio detected some signal
4977 * that indicated to the radio the channel was not clear
4978 * @channel_time_rx: Amount of time the radio spent receiving data
4979 * @channel_time_tx: Amount of time the radio spent transmitting data
4980 * @filled: bitmask indicating which fields have been reported, see
4981 * SURVEY_HAS_* defines.
4982 * @list: Internal list pointers
4984 struct freq_survey
{
4989 u64 channel_time_busy
;
4990 u64 channel_time_rx
;
4991 u64 channel_time_tx
;
4992 unsigned int filled
;
4993 struct dl_list list
;
4996 #define SURVEY_HAS_NF BIT(0)
4997 #define SURVEY_HAS_CHAN_TIME BIT(1)
4998 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4999 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
5000 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
5004 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
5006 union wpa_event_data
{
5008 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
5010 * This structure is optional for EVENT_ASSOC calls and required for
5011 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
5012 * driver interface does not need to generate separate EVENT_ASSOCINFO
5017 * reassoc - Flag to indicate association or reassociation
5022 * req_ies - (Re)Association Request IEs
5024 * If the driver generates WPA/RSN IE, this event data must be
5025 * returned for WPA handshake to have needed information. If
5026 * wpa_supplicant-generated WPA/RSN IE is used, this
5027 * information event is optional.
5029 * This should start with the first IE (fixed fields before IEs
5030 * are not included).
5035 * req_ies_len - Length of req_ies in bytes
5040 * resp_ies - (Re)Association Response IEs
5042 * Optional association data from the driver. This data is not
5043 * required WPA, but may be useful for some protocols and as
5044 * such, should be reported if this is available to the driver
5047 * This should start with the first IE (fixed fields before IEs
5048 * are not included).
5053 * resp_ies_len - Length of resp_ies in bytes
5055 size_t resp_ies_len
;
5058 * resp_frame - (Re)Association Response frame
5060 const u8
*resp_frame
;
5063 * resp_frame_len - (Re)Association Response frame length
5065 size_t resp_frame_len
;
5068 * beacon_ies - Beacon or Probe Response IEs
5070 * Optional Beacon/ProbeResp data: IEs included in Beacon or
5071 * Probe Response frames from the current AP (i.e., the one
5072 * that the client just associated with). This information is
5073 * used to update WPA/RSN IE for the AP. If this field is not
5074 * set, the results from previous scan will be used. If no
5075 * data for the new AP is found, scan results will be requested
5076 * again (without scan request). At this point, the driver is
5077 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
5080 * This should start with the first IE (fixed fields before IEs
5081 * are not included).
5083 const u8
*beacon_ies
;
5086 * beacon_ies_len - Length of beacon_ies */
5087 size_t beacon_ies_len
;
5090 * freq - Frequency of the operational channel in MHz
5095 * wmm_params - WMM parameters used in this association.
5097 struct wmm_params wmm_params
;
5100 * addr - Station address (for AP mode)
5105 * The following is the key management offload information
5108 * @key_replay_ctr_len
5116 * authorized - Status of key management offload,
5122 * key_replay_ctr - Key replay counter value last used
5123 * in a valid EAPOL-Key frame
5125 const u8
*key_replay_ctr
;
5128 * key_replay_ctr_len - The length of key_replay_ctr
5130 size_t key_replay_ctr_len
;
5133 * ptk_kck - The derived PTK KCK
5138 * ptk_kek_len - The length of ptk_kck
5143 * ptk_kek - The derived PTK KEK
5144 * This is used in key management offload and also in FILS SK
5150 * ptk_kek_len - The length of ptk_kek
5155 * subnet_status - The subnet status:
5156 * 0 = unknown, 1 = unchanged, 2 = changed
5161 * The following information is used in FILS SK offload
5162 * @fils_erp_next_seq_num
5169 * fils_erp_next_seq_num - The next sequence number to use in
5172 u16 fils_erp_next_seq_num
;
5175 * fils_pmk - A new PMK if generated in case of FILS
5181 * fils_pmk_len - Length of fils_pmk
5183 size_t fils_pmk_len
;
5186 * fils_pmkid - PMKID used or generated in FILS authentication
5188 const u8
*fils_pmkid
;
5192 * struct disassoc_info - Data for EVENT_DISASSOC events
5194 struct disassoc_info
{
5196 * addr - Station address (for AP mode)
5201 * reason_code - Reason Code (host byte order) used in
5202 * Deauthentication frame
5207 * ie - Optional IE(s) in Disassociation frame
5212 * ie_len - Length of ie buffer in octets
5217 * locally_generated - Whether the frame was locally generated
5219 int locally_generated
;
5223 * struct deauth_info - Data for EVENT_DEAUTH events
5225 struct deauth_info
{
5227 * addr - Station address (for AP mode)
5232 * reason_code - Reason Code (host byte order) used in
5233 * Deauthentication frame
5238 * ie - Optional IE(s) in Deauthentication frame
5243 * ie_len - Length of ie buffer in octets
5248 * locally_generated - Whether the frame was locally generated
5250 int locally_generated
;
5254 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
5256 struct michael_mic_failure
{
5259 } michael_mic_failure
;
5262 * struct interface_status - Data for EVENT_INTERFACE_STATUS
5264 struct interface_status
{
5265 unsigned int ifindex
;
5268 EVENT_INTERFACE_ADDED
, EVENT_INTERFACE_REMOVED
5273 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
5275 struct pmkid_candidate
{
5276 /** BSSID of the PMKID candidate */
5278 /** Smaller the index, higher the priority */
5280 /** Whether RSN IE includes pre-authenticate flag */
5285 * struct tdls - Data for EVENT_TDLS
5291 TDLS_REQUEST_TEARDOWN
,
5292 TDLS_REQUEST_DISCOVER
,
5294 u16 reason_code
; /* for teardown */
5298 * struct wnm - Data for EVENT_WNM
5316 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
5318 * During FT (IEEE 802.11r) authentication sequence, the driver is
5319 * expected to use this event to report received FT IEs (MDIE, FTIE,
5320 * RSN IE, TIE, possible resource request) to the supplicant. The FT
5321 * IEs for the next message will be delivered through the
5322 * struct wpa_driver_ops::update_ft_ies() callback.
5328 u8 target_ap
[ETH_ALEN
];
5329 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
5331 /** Length of ric_ies buffer in octets */
5336 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
5338 struct ibss_rsn_start
{
5343 * struct auth_info - Data for EVENT_AUTH events
5349 u16 auth_transaction
;
5356 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
5358 struct assoc_reject
{
5360 * bssid - BSSID of the AP that rejected association
5365 * resp_ies - (Re)Association Response IEs
5367 * Optional association data from the driver. This data is not
5368 * required WPA, but may be useful for some protocols and as
5369 * such, should be reported if this is available to the driver
5372 * This should start with the first IE (fixed fields before IEs
5373 * are not included).
5378 * resp_ies_len - Length of resp_ies in bytes
5380 size_t resp_ies_len
;
5383 * status_code - Status Code from (Re)association Response
5388 * timed_out - Whether failure is due to timeout (etc.) rather
5389 * than explicit rejection response from the AP.
5394 * timeout_reason - Reason for the timeout
5396 const char *timeout_reason
;
5399 * fils_erp_next_seq_num - The next sequence number to use in
5402 u16 fils_erp_next_seq_num
;
5405 struct timeout_event
{
5410 * struct tx_status - Data for EVENT_TX_STATUS events
5422 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
5424 struct rx_from_unknown
{
5431 * struct rx_mgmt - Data for EVENT_RX_MGMT events
5439 * drv_priv - Pointer to store driver private BSS information
5441 * If not set to NULL, this is used for comparison with
5442 * hostapd_data->drv_priv to determine which BSS should process
5448 * freq - Frequency (in MHz) on which the frame was received
5453 * ssi_signal - Signal strength in dBm (or 0 if not available)
5459 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
5461 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
5463 struct remain_on_channel
{
5465 * freq - Channel frequency in MHz
5470 * duration - Duration to remain on the channel in milliseconds
5472 unsigned int duration
;
5473 } remain_on_channel
;
5476 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
5477 * @aborted: Whether the scan was aborted
5478 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
5479 * @num_freqs: Number of entries in freqs array
5480 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
5482 * @num_ssids: Number of entries in ssids array
5483 * @external_scan: Whether the scan info is for an external scan
5484 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
5485 * 0 if the source of the scan event is a vendor scan
5486 * @scan_start_tsf: Time when the scan started in terms of TSF of the
5487 * BSS that the interface that requested the scan is connected to
5489 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
5496 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
5501 u8 scan_start_tsf_bssid
[ETH_ALEN
];
5505 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
5507 struct rx_probe_req
{
5509 * sa - Source address of the received Probe Request frame
5514 * da - Destination address of the received Probe Request frame
5515 * or %NULL if not available
5520 * bssid - BSSID of the received Probe Request frame or %NULL
5526 * ie - IEs from the Probe Request body
5531 * ie_len - Length of ie buffer in octets
5536 * signal - signal strength in dBm (or 0 if not available)
5542 * struct new_sta - Data for EVENT_NEW_STA events
5549 * struct eapol_rx - Data for EVENT_EAPOL_RX events
5558 * signal_change - Data for EVENT_SIGNAL_CHANGE events
5560 struct wpa_signal_info signal_change
;
5563 * struct best_channel - Data for EVENT_BEST_CHANNEL events
5564 * @freq_24: Best 2.4 GHz band channel frequency in MHz
5565 * @freq_5: Best 5 GHz band channel frequency in MHz
5566 * @freq_overall: Best channel frequency in MHz
5568 * 0 can be used to indicate no preference in either band.
5570 struct best_channel
{
5576 struct unprot_deauth
{
5582 struct unprot_disassoc
{
5589 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
5590 * @addr: station address
5591 * @num_packets: Number of packets lost (consecutive packets not
5600 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
5602 struct ibss_peer_lost
{
5607 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
5609 struct driver_gtk_rekey
{
5611 const u8
*replay_ctr
;
5615 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
5616 * @addr: station address
5618 struct client_poll
{
5623 * struct eapol_tx_status
5624 * @dst: Original destination
5625 * @data: Data starting with IEEE 802.1X header (!)
5626 * @data_len: Length of data
5627 * @ack: Indicates ack or lost frame
5629 * This corresponds to hapd_send_eapol if the frame sent
5630 * there isn't just reported as EVENT_TX_STATUS.
5632 struct eapol_tx_status
{
5641 * @freq: Frequency of new channel in MHz
5642 * @ht_enabled: Whether this is an HT channel
5643 * @ch_offset: Secondary channel offset
5644 * @ch_width: Channel width
5645 * @cf1: Center frequency 1
5646 * @cf2: Center frequency 2
5652 enum chan_width ch_width
;
5658 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
5659 * @addr: Remote client address
5660 * @code: Reason code for connection failure
5662 struct connect_failed_reason
{
5668 } connect_failed_reason
;
5671 * struct dfs_event - Data for radar detected events
5672 * @freq: Frequency of the channel in MHz
5678 enum chan_width chan_width
;
5684 * survey_results - Survey result data for EVENT_SURVEY
5685 * @freq_filter: Requested frequency survey filter, 0 if request
5686 * was for all survey data
5687 * @survey_list: Linked list of survey data (struct freq_survey)
5689 struct survey_results
{
5690 unsigned int freq_filter
;
5691 struct dl_list survey_list
; /* struct freq_survey */
5695 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
5696 * @initiator: Initiator of the regulatory change
5697 * @type: Regulatory change type
5698 * @alpha2: Country code (or "" if not available)
5700 struct channel_list_changed
{
5701 enum reg_change_initiator initiator
;
5704 } channel_list_changed
;
5707 * freq_range - List of frequency ranges
5709 * This is used as the data with EVENT_AVOID_FREQUENCIES.
5711 struct wpa_freq_range_list freq_range
;
5716 * @peer: Peer address
5718 * @ie_len: Length of @ies
5720 * Notification of new candidate mesh peer.
5729 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
5730 * @pri_freq: Selected primary frequency
5731 * @sec_freq: Selected secondary frequency
5732 * @edmg_channel: Selected EDMG channel
5733 * @vht_seg0_center_ch: VHT mode Segment0 center channel
5734 * The value is the index of the channel center frequency for
5735 * 20 MHz, 40 MHz, and 80 MHz channels. The value is the center
5736 * frequency index of the primary 80 MHz segment for 160 MHz and
5737 * 80+80 MHz channels.
5738 * @vht_seg1_center_ch: VHT mode Segment1 center channel
5739 * The value is zero for 20 MHz, 40 MHz, and 80 MHz channels. The
5740 * value is the index of the channel center frequency for 160 MHz
5741 * channels and the center frequency index of the secondary 80 MHz
5742 * segment for 80+80 MHz channels.
5743 * @ch_width: Selected Channel width by driver. Driver may choose to
5744 * change hostapd configured ACS channel width due driver internal
5745 * channel restrictions.
5746 * hw_mode: Selected band (used with hw_mode=any)
5748 struct acs_selected_channels
{
5749 unsigned int pri_freq
;
5750 unsigned int sec_freq
;
5752 u8 vht_seg0_center_ch
;
5753 u8 vht_seg1_center_ch
;
5755 enum hostapd_hw_mode hw_mode
;
5756 } acs_selected_channels
;
5759 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
5760 * @reason_code: Reason for stopping offload
5761 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
5763 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
5765 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
5767 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
5768 * supported by device.
5770 struct p2p_lo_stop
{
5772 P2P_LO_STOPPED_REASON_COMPLETE
= 0,
5773 P2P_LO_STOPPED_REASON_RECV_STOP_CMD
,
5774 P2P_LO_STOPPED_REASON_INVALID_PARAM
,
5775 P2P_LO_STOPPED_REASON_NOT_SUPPORTED
,
5779 /* For EVENT_EXTERNAL_AUTH */
5780 struct external_auth external_auth
;
5783 * struct sta_opmode - Station's operation mode change event
5784 * @addr: The station MAC address
5785 * @smps_mode: SMPS mode of the station
5786 * @chan_width: Channel width of the station
5787 * @rx_nss: RX_NSS of the station
5789 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
5793 enum smps_mode smps_mode
;
5794 enum chan_width chan_width
;
5799 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
5801 struct wds_sta_interface
{
5808 } wds_sta_interface
;
5811 * struct update_dh - Data for EVENT_UPDATE_DH
5821 * wpa_supplicant_event - Report a driver event for wpa_supplicant
5822 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5823 * with struct wpa_driver_ops::init()
5824 * @event: event type (defined above)
5825 * @data: possible extra data for the event
5827 * Driver wrapper code should call this function whenever an event is received
5830 void wpa_supplicant_event(void *ctx
, enum wpa_event_type event
,
5831 union wpa_event_data
*data
);
5834 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
5835 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5836 * with struct wpa_driver_ops::init()
5837 * @event: event type (defined above)
5838 * @data: possible extra data for the event
5840 * Same as wpa_supplicant_event(), but we search for the interface in
5843 void wpa_supplicant_event_global(void *ctx
, enum wpa_event_type event
,
5844 union wpa_event_data
*data
);
5847 * The following inline functions are provided for convenience to simplify
5848 * event indication for some of the common events.
5851 static inline void drv_event_assoc(void *ctx
, const u8
*addr
, const u8
*ie
,
5852 size_t ielen
, int reassoc
)
5854 union wpa_event_data event
;
5855 os_memset(&event
, 0, sizeof(event
));
5856 event
.assoc_info
.reassoc
= reassoc
;
5857 event
.assoc_info
.req_ies
= ie
;
5858 event
.assoc_info
.req_ies_len
= ielen
;
5859 event
.assoc_info
.addr
= addr
;
5860 wpa_supplicant_event(ctx
, EVENT_ASSOC
, &event
);
5863 static inline void drv_event_disassoc(void *ctx
, const u8
*addr
)
5865 union wpa_event_data event
;
5866 os_memset(&event
, 0, sizeof(event
));
5867 event
.disassoc_info
.addr
= addr
;
5868 wpa_supplicant_event(ctx
, EVENT_DISASSOC
, &event
);
5871 static inline void drv_event_eapol_rx(void *ctx
, const u8
*src
, const u8
*data
,
5874 union wpa_event_data event
;
5875 os_memset(&event
, 0, sizeof(event
));
5876 event
.eapol_rx
.src
= src
;
5877 event
.eapol_rx
.data
= data
;
5878 event
.eapol_rx
.data_len
= data_len
;
5879 wpa_supplicant_event(ctx
, EVENT_EAPOL_RX
, &event
);
5882 /* driver_common.c */
5883 void wpa_scan_results_free(struct wpa_scan_results
*res
);
5885 /* Convert wpa_event_type to a string for logging */
5886 const char * event_to_string(enum wpa_event_type event
);
5888 /* Convert chan_width to a string for logging and control interfaces */
5889 const char * channel_width_to_string(enum chan_width width
);
5891 int channel_width_to_int(enum chan_width width
);
5893 int ht_supported(const struct hostapd_hw_modes
*mode
);
5894 int vht_supported(const struct hostapd_hw_modes
*mode
);
5896 struct wowlan_triggers
*
5897 wpa_get_wowlan_triggers(const char *wowlan_triggers
,
5898 const struct wpa_driver_capa
*capa
);
5899 /* Convert driver flag to string */
5900 const char * driver_flag_to_string(u64 flag
);
5902 /* NULL terminated array of linked in driver wrappers */
5903 extern const struct wpa_driver_ops
*const wpa_drivers
[];
5906 /* Available drivers */
5908 #ifdef CONFIG_DRIVER_WEXT
5909 extern const struct wpa_driver_ops wpa_driver_wext_ops
; /* driver_wext.c */
5910 #endif /* CONFIG_DRIVER_WEXT */
5911 #ifdef CONFIG_DRIVER_NL80211
5912 /* driver_nl80211.c */
5913 extern const struct wpa_driver_ops wpa_driver_nl80211_ops
;
5914 #endif /* CONFIG_DRIVER_NL80211 */
5915 #ifdef CONFIG_DRIVER_HOSTAP
5916 extern const struct wpa_driver_ops wpa_driver_hostap_ops
; /* driver_hostap.c */
5917 #endif /* CONFIG_DRIVER_HOSTAP */
5918 #ifdef CONFIG_DRIVER_BSD
5919 extern const struct wpa_driver_ops wpa_driver_bsd_ops
; /* driver_bsd.c */
5920 #endif /* CONFIG_DRIVER_BSD */
5921 #ifdef CONFIG_DRIVER_OPENBSD
5922 /* driver_openbsd.c */
5923 extern const struct wpa_driver_ops wpa_driver_openbsd_ops
;
5924 #endif /* CONFIG_DRIVER_OPENBSD */
5925 #ifdef CONFIG_DRIVER_NDIS
5926 extern struct wpa_driver_ops wpa_driver_ndis_ops
; /* driver_ndis.c */
5927 #endif /* CONFIG_DRIVER_NDIS */
5928 #ifdef CONFIG_DRIVER_WIRED
5929 extern const struct wpa_driver_ops wpa_driver_wired_ops
; /* driver_wired.c */
5930 #endif /* CONFIG_DRIVER_WIRED */
5931 #ifdef CONFIG_DRIVER_MACSEC_QCA
5932 /* driver_macsec_qca.c */
5933 extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops
;
5934 #endif /* CONFIG_DRIVER_MACSEC_QCA */
5935 #ifdef CONFIG_DRIVER_MACSEC_LINUX
5936 /* driver_macsec_linux.c */
5937 extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops
;
5938 #endif /* CONFIG_DRIVER_MACSEC_LINUX */
5939 #ifdef CONFIG_DRIVER_ROBOSWITCH
5940 /* driver_roboswitch.c */
5941 extern const struct wpa_driver_ops wpa_driver_roboswitch_ops
;
5942 #endif /* CONFIG_DRIVER_ROBOSWITCH */
5943 #ifdef CONFIG_DRIVER_ATHEROS
5944 /* driver_atheros.c */
5945 extern const struct wpa_driver_ops wpa_driver_atheros_ops
;
5946 #endif /* CONFIG_DRIVER_ATHEROS */
5947 #ifdef CONFIG_DRIVER_NONE
5948 extern const struct wpa_driver_ops wpa_driver_none_ops
; /* driver_none.c */
5949 #endif /* CONFIG_DRIVER_NONE */
5951 #endif /* DRIVER_H */