2 * Driver interface definition
3 * Copyright (c) 2003-2017, Jouni Malinen <j@w1.fi>
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
8 * This file defines a driver interface used by both %wpa_supplicant and
9 * hostapd. The first part of the file defines data structures used in various
10 * driver operations. This is followed by the struct wpa_driver_ops that each
11 * driver wrapper will beed to define with callback functions for requesting
12 * driver operations. After this, there are definitions for driver event
13 * reporting with wpa_supplicant_event() and some convenience helper functions
14 * that can be used to report events.
20 #define WPA_SUPPLICANT_DRIVER_VERSION 4
22 #include "common/defs.h"
23 #include "common/ieee802_11_defs.h"
24 #include "common/wpa_common.h"
26 #include "pae/ieee802_1x_kay.h"
27 #endif /* CONFIG_MACSEC */
28 #include "utils/list.h"
30 #define HOSTAPD_CHAN_DISABLED 0x00000001
31 #define HOSTAPD_CHAN_NO_IR 0x00000002
32 #define HOSTAPD_CHAN_RADAR 0x00000008
33 #define HOSTAPD_CHAN_HT40PLUS 0x00000010
34 #define HOSTAPD_CHAN_HT40MINUS 0x00000020
35 #define HOSTAPD_CHAN_HT40 0x00000040
36 #define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
38 #define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
39 #define HOSTAPD_CHAN_DFS_USABLE 0x00000100
40 #define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
41 #define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
42 #define HOSTAPD_CHAN_DFS_MASK 0x00000300
44 #define HOSTAPD_CHAN_VHT_10_70 0x00000800
45 #define HOSTAPD_CHAN_VHT_30_50 0x00001000
46 #define HOSTAPD_CHAN_VHT_50_30 0x00002000
47 #define HOSTAPD_CHAN_VHT_70_10 0x00004000
49 #define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
50 #define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
52 #define HOSTAPD_CHAN_VHT_10_150 0x00100000
53 #define HOSTAPD_CHAN_VHT_30_130 0x00200000
54 #define HOSTAPD_CHAN_VHT_50_110 0x00400000
55 #define HOSTAPD_CHAN_VHT_70_90 0x00800000
56 #define HOSTAPD_CHAN_VHT_90_70 0x01000000
57 #define HOSTAPD_CHAN_VHT_110_50 0x02000000
58 #define HOSTAPD_CHAN_VHT_130_30 0x04000000
59 #define HOSTAPD_CHAN_VHT_150_10 0x08000000
61 /* Allowed bandwidth mask */
62 enum hostapd_chan_width_attr
{
63 HOSTAPD_CHAN_WIDTH_10
= BIT(0),
64 HOSTAPD_CHAN_WIDTH_20
= BIT(1),
65 HOSTAPD_CHAN_WIDTH_40P
= BIT(2),
66 HOSTAPD_CHAN_WIDTH_40M
= BIT(3),
67 HOSTAPD_CHAN_WIDTH_80
= BIT(4),
68 HOSTAPD_CHAN_WIDTH_160
= BIT(5),
71 /* Filter gratuitous ARP */
72 #define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
73 /* Filter unsolicited Neighbor Advertisement */
74 #define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
75 /* Filter unicast IP packets encrypted using the GTK */
76 #define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)
78 #define HOSTAPD_DFS_REGION_FCC 1
79 #define HOSTAPD_DFS_REGION_ETSI 2
80 #define HOSTAPD_DFS_REGION_JP 3
83 * enum reg_change_initiator - Regulatory change initiator
85 enum reg_change_initiator
{
89 REGDOM_SET_BY_COUNTRY_IE
,
94 * enum reg_type - Regulatory change types
100 REGDOM_TYPE_CUSTOM_WORLD
,
101 REGDOM_TYPE_INTERSECTION
,
105 * struct hostapd_channel_data - Channel information
107 struct hostapd_channel_data
{
109 * chan - Channel number (IEEE 802.11)
114 * freq - Frequency in MHz
119 * flag - Channel flags (HOSTAPD_CHAN_*)
124 * allowed_bw - Allowed channel width bitmask
126 * See enum hostapd_chan_width_attr.
131 * max_tx_power - Regulatory transmit power limit in dBm
136 * survey_list - Linked list of surveys (struct freq_survey)
138 struct dl_list survey_list
;
141 * min_nf - Minimum observed noise floor, in dBm, based on all
142 * surveyed channel data
148 * interference_factor - Computed interference factor on this
149 * channel (used internally in src/ap/acs.c; driver wrappers do not
152 long double interference_factor
;
153 #endif /* CONFIG_ACS */
156 * dfs_cac_ms - DFS CAC time in milliseconds
158 unsigned int dfs_cac_ms
;
161 #define HE_MAX_NUM_SS 8
162 #define HE_MAX_MAC_CAPAB_SIZE 6
163 #define HE_MAX_PHY_CAPAB_SIZE 11
164 #define HE_MAX_MCS_CAPAB_SIZE 12
167 * struct he_ppe_threshold - IEEE 802.11ax HE PPE Threshold
169 struct he_ppe_threshold
{
172 u32 ppet16_ppet8_ru3_ru0
[HE_MAX_NUM_SS
];
176 * struct he_capabilities - IEEE 802.11ax HE capabilities
178 struct he_capabilities
{
180 u8 phy_cap
[HE_MAX_PHY_CAPAB_SIZE
];
181 u8 mac_cap
[HE_MAX_MAC_CAPAB_SIZE
];
182 u8 mcs
[HE_MAX_MCS_CAPAB_SIZE
];
183 struct he_ppe_threshold ppet
;
186 #define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
187 #define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
190 * struct hostapd_hw_modes - Supported hardware mode information
192 struct hostapd_hw_modes
{
194 * mode - Hardware mode
196 enum hostapd_hw_mode mode
;
199 * num_channels - Number of entries in the channels array
204 * channels - Array of supported channels
206 struct hostapd_channel_data
*channels
;
209 * num_rates - Number of entries in the rates array
214 * rates - Array of supported rates in 100 kbps units
219 * ht_capab - HT (IEEE 802.11n) capabilities
224 * mcs_set - MCS (IEEE 802.11n) rate parameters
229 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
234 * vht_capab - VHT (IEEE 802.11ac) capabilities
239 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
243 unsigned int flags
; /* HOSTAPD_MODE_FLAG_* */
246 * he_capab - HE (IEEE 802.11ax) capabilities
248 struct he_capabilities he_capab
;
252 #define IEEE80211_MODE_INFRA 0
253 #define IEEE80211_MODE_IBSS 1
254 #define IEEE80211_MODE_AP 2
255 #define IEEE80211_MODE_MESH 5
257 #define IEEE80211_CAP_ESS 0x0001
258 #define IEEE80211_CAP_IBSS 0x0002
259 #define IEEE80211_CAP_PRIVACY 0x0010
260 #define IEEE80211_CAP_RRM 0x1000
262 /* DMG (60 GHz) IEEE 802.11ad */
263 /* type - bits 0..1 */
264 #define IEEE80211_CAP_DMG_MASK 0x0003
265 #define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
266 #define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
267 #define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
269 #define WPA_SCAN_QUAL_INVALID BIT(0)
270 #define WPA_SCAN_NOISE_INVALID BIT(1)
271 #define WPA_SCAN_LEVEL_INVALID BIT(2)
272 #define WPA_SCAN_LEVEL_DBM BIT(3)
273 #define WPA_SCAN_ASSOCIATED BIT(5)
276 * struct wpa_scan_res - Scan result for an BSS/IBSS
277 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
279 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
280 * @beacon_int: beacon interval in TUs (host byte order)
281 * @caps: capability information field in host byte order
282 * @qual: signal quality
283 * @noise: noise level
284 * @level: signal level
286 * @age: Age of the information in milliseconds (i.e., how many milliseconds
287 * ago the last Beacon or Probe Response frame was received)
288 * @est_throughput: Estimated throughput in kbps (this is calculated during
289 * scan result processing if left zero by the driver wrapper)
290 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
291 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
292 * of TSF of the BSS specified by %tsf_bssid.
293 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
294 * @ie_len: length of the following IE field in octets
295 * @beacon_ie_len: length of the following Beacon IE field in octets
297 * This structure is used as a generic format for scan results from the
298 * driver. Each driver interface implementation is responsible for converting
299 * the driver or OS specific scan results into this format.
301 * If the driver does not support reporting all IEs, the IE data structure is
302 * constructed of the IEs that are available. This field will also need to
303 * include SSID in IE format. All drivers are encouraged to be extended to
304 * report all IEs to make it easier to support future additions.
306 * This structure data is followed by ie_len octets of IEs from Probe Response
307 * frame (or if the driver does not indicate source of IEs, these may also be
308 * from Beacon frame). After the first set of IEs, another set of IEs may follow
309 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
311 struct wpa_scan_res
{
322 unsigned int est_throughput
;
325 u8 tsf_bssid
[ETH_ALEN
];
327 size_t beacon_ie_len
;
328 /* Followed by ie_len + beacon_ie_len octets of IE data */
332 * struct wpa_scan_results - Scan results
333 * @res: Array of pointers to allocated variable length scan result entries
334 * @num: Number of entries in the scan result array
335 * @fetch_time: Time when the results were fetched from the driver
337 struct wpa_scan_results
{
338 struct wpa_scan_res
**res
;
340 struct os_reltime fetch_time
;
344 * struct wpa_interface_info - Network interface information
345 * @next: Pointer to the next interface or NULL if this is the last one
346 * @ifname: Interface name that can be used with init() or init2()
347 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
349 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
350 * is not an allocated copy, i.e., get_interfaces() caller will not free
353 struct wpa_interface_info
{
354 struct wpa_interface_info
*next
;
357 const char *drv_name
;
360 #define WPAS_MAX_SCAN_SSIDS 16
363 * struct wpa_driver_scan_ssid - SSIDs to scan for
364 * @ssid - specific SSID to scan for (ProbeReq)
365 * %NULL or zero-length SSID is used to indicate active scan
366 * with wildcard SSID.
367 * @ssid_len - Length of the SSID in octets
369 struct wpa_driver_scan_ssid
{
375 * struct wpa_driver_scan_params - Scan parameters
376 * Data for struct wpa_driver_ops::scan2().
378 struct wpa_driver_scan_params
{
380 * ssids - SSIDs to scan for
382 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
385 * num_ssids - Number of entries in ssids array
386 * Zero indicates a request for a passive scan.
391 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
396 * extra_ies_len - Length of extra_ies in octets
398 size_t extra_ies_len
;
401 * freqs - Array of frequencies to scan or %NULL for all frequencies
403 * The frequency is set in MHz. The array is zero-terminated.
408 * filter_ssids - Filter for reporting SSIDs
410 * This optional parameter can be used to request the driver wrapper to
411 * filter scan results to include only the specified SSIDs. %NULL
412 * indicates that no filtering is to be done. This can be used to
413 * reduce memory needs for scan results in environments that have large
414 * number of APs with different SSIDs.
416 * The driver wrapper is allowed to take this allocated buffer into its
417 * own use by setting the pointer to %NULL. In that case, the driver
418 * wrapper is responsible for freeing the buffer with os_free() once it
419 * is not needed anymore.
421 struct wpa_driver_scan_filter
{
422 u8 ssid
[SSID_MAX_LEN
];
427 * num_filter_ssids - Number of entries in filter_ssids array
429 size_t num_filter_ssids
;
432 * filter_rssi - Filter by RSSI
434 * The driver may filter scan results in firmware to reduce host
435 * wakeups and thereby save power. Specify the RSSI threshold in s32
441 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
443 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
444 * Mbps from the support rates element(s) in the Probe Request frames
445 * and not to transmit the frames at any of those rates.
447 unsigned int p2p_probe
:1;
450 * only_new_results - Request driver to report only new results
452 * This is used to request the driver to report only BSSes that have
453 * been detected after this scan request has been started, i.e., to
454 * flush old cached BSS entries.
456 unsigned int only_new_results
:1;
459 * low_priority - Requests driver to use a lower scan priority
461 * This is used to request the driver to use a lower scan priority
462 * if it supports such a thing.
464 unsigned int low_priority
:1;
467 * mac_addr_rand - Requests driver to randomize MAC address
469 unsigned int mac_addr_rand
:1;
472 * mac_addr - MAC address used with randomization. The address cannot be
473 * a multicast one, i.e., bit 0 of byte 0 should not be set.
478 * mac_addr_mask - MAC address mask used with randomization.
480 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
481 * the mask should be taken as is from mac_addr. The mask should not
482 * allow the generation of a multicast address, i.e., bit 0 of byte 0
485 const u8
*mac_addr_mask
;
488 * sched_scan_plans - Scan plans for scheduled scan
490 * Each scan plan consists of the number of iterations to scan and the
491 * interval between scans. When a scan plan finishes (i.e., it was run
492 * for the specified number of iterations), the next scan plan is
493 * executed. The scan plans are executed in the order they appear in
494 * the array (lower index first). The last scan plan will run infinitely
495 * (until requested to stop), thus must not specify the number of
496 * iterations. All other scan plans must specify the number of
499 struct sched_scan_plan
{
500 u32 interval
; /* In seconds */
501 u32 iterations
; /* Zero to run infinitely */
505 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
507 unsigned int sched_scan_plans_num
;
510 * sched_scan_start_delay - Delay to use before starting the first scan
512 * Delay (in seconds) before scheduling first scan plan cycle. The
513 * driver may ignore this parameter and start immediately (or at any
514 * other time), if this feature is not supported.
516 u32 sched_scan_start_delay
;
519 * bssid - Specific BSSID to scan for
521 * This optional parameter can be used to replace the default wildcard
522 * BSSID with a specific BSSID to scan for if results are needed from
528 * scan_cookie - Unique identification representing the scan request
530 * This scan_cookie carries a unique identification representing the
531 * scan request if the host driver/kernel supports concurrent scan
532 * requests. This cookie is returned from the corresponding driver
535 * Note: Unlike other parameters in this structure, scan_cookie is used
536 * only to return information instead of setting parameters for the
542 * duration - Dwell time on each channel
544 * This optional parameter can be used to set the dwell time on each
550 * duration_mandatory - Whether the specified duration is mandatory
552 * If this is set, the duration specified by the %duration field is
553 * mandatory (and the driver should reject the scan request if it is
554 * unable to comply with the specified duration), otherwise it is the
555 * maximum duration and the actual duration may be shorter.
557 unsigned int duration_mandatory
:1;
560 * relative_rssi_set - Whether relative RSSI parameters are set
562 unsigned int relative_rssi_set
:1;
565 * relative_rssi - Relative RSSI for reporting better BSSs
567 * Amount of RSSI by which a BSS should be better than the current
568 * connected BSS to report the new BSS to user space.
573 * relative_adjust_band - Band to which RSSI should be adjusted
575 * The relative_adjust_rssi should be added to the band specified
576 * by relative_adjust_band.
578 enum set_band relative_adjust_band
;
581 * relative_adjust_rssi - RSSI to be added to relative_adjust_band
583 * An amount of relative_band_rssi should be added to the BSSs that
584 * belong to the band specified by relative_adjust_band while comparing
585 * with other bands for BSS reporting.
587 s8 relative_adjust_rssi
;
592 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0)
593 * - Accept broadcast Probe Response frame.
594 * - Probe Request frame deferral and suppression.
595 * - Max Channel Time - driver fills FILS request params IE with
596 * Maximum Channel Time.
597 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps.
599 unsigned int oce_scan
:1;
602 * NOTE: Whenever adding new parameters here, please make sure
603 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
609 * struct wpa_driver_auth_params - Authentication parameters
610 * Data for struct wpa_driver_ops::authenticate().
612 struct wpa_driver_auth_params
{
620 const u8
*wep_key
[4];
621 size_t wep_key_len
[4];
623 int local_state_change
;
626 * p2p - Whether this connection is a P2P group
631 * auth_data - Additional elements for Authentication frame
633 * This buffer starts with the Authentication transaction sequence
634 * number field. If no special handling of such elements is needed, this
635 * pointer is %NULL. This is used with SAE and FILS.
640 * auth_data_len - Length of auth_data buffer in octets
642 size_t auth_data_len
;
646 * enum wps_mode - WPS mode
650 * WPS_MODE_NONE - No WPS provisioning being used
655 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
660 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
666 * struct hostapd_freq_params - Channel parameters
668 struct hostapd_freq_params
{
670 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
672 enum hostapd_hw_mode mode
;
675 * freq - Primary channel center frequency in MHz
680 * channel - Channel number
685 * ht_enabled - Whether HT is enabled
690 * sec_channel_offset - Secondary channel offset for HT40
693 * -1 = HT40 enabled, secondary channel below primary,
694 * 1 = HT40 enabled, secondary channel above primary
696 int sec_channel_offset
;
699 * vht_enabled - Whether VHT is enabled
704 * center_freq1 - Segment 0 center frequency in MHz
706 * Valid for both HT and VHT.
711 * center_freq2 - Segment 1 center frequency in MHz
713 * Non-zero only for bandwidth 80 and an 80+80 channel
718 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
724 * struct wpa_driver_sta_auth_params - Authentication parameters
725 * Data for struct wpa_driver_ops::sta_auth().
727 struct wpa_driver_sta_auth_params
{
730 * own_addr - Source address and BSSID for authentication frame
735 * addr - MAC address of the station to associate
740 * seq - authentication sequence number
745 * status - authentication response status code
750 * ie - authentication frame ie buffer
755 * len - ie buffer length
760 * fils_auth - Indicates whether FILS authentication is being performed
765 * fils_anonce - ANonce (required for FILS)
767 u8 fils_anonce
[WPA_NONCE_LEN
];
770 * fils_snonce - SNonce (required for FILS)
772 u8 fils_snonce
[WPA_NONCE_LEN
];
775 * fils_kek - key for encryption (required for FILS)
777 u8 fils_kek
[WPA_KEK_MAX_LEN
];
780 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
786 * struct wpa_driver_associate_params - Association parameters
787 * Data for struct wpa_driver_ops::associate().
789 struct wpa_driver_associate_params
{
791 * bssid - BSSID of the selected AP
792 * This can be %NULL, if ap_scan=2 mode is used and the driver is
793 * responsible for selecting with which BSS to associate. */
797 * bssid_hint - BSSID of a proposed AP
799 * This indicates which BSS has been found a suitable candidate for
800 * initial association for drivers that use driver/firmwate-based BSS
801 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
802 * the driver from selecting other BSSes in the ESS.
804 const u8
*bssid_hint
;
807 * ssid - The selected SSID
812 * ssid_len - Length of the SSID (1..32)
817 * freq - channel parameters
819 struct hostapd_freq_params freq
;
822 * freq_hint - Frequency of the channel the proposed AP is using
824 * This provides a channel on which a suitable BSS has been found as a
825 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
826 * limit the driver from selecting other channels for
827 * driver/firmware-based BSS selection.
832 * bg_scan_period - Background scan period in seconds, 0 to disable
833 * background scan, or -1 to indicate no change to default driver
839 * beacon_int - Beacon interval for IBSS or 0 to use driver default
844 * wpa_ie - WPA information element for (Re)Association Request
845 * WPA information element to be included in (Re)Association
846 * Request (including information element id and length). Use
847 * of this WPA IE is optional. If the driver generates the WPA
848 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
849 * key_mgmt_suite to select proper algorithms. In this case,
850 * the driver has to notify wpa_supplicant about the used WPA
851 * IE by generating an event that the interface code will
852 * convert into EVENT_ASSOCINFO data (see below).
854 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
855 * instead. The driver can determine which version is used by
856 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
859 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
864 * wpa_ie_len - length of the wpa_ie
869 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
871 unsigned int wpa_proto
;
874 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
876 * This is usually ignored if @wpa_ie is used.
878 unsigned int pairwise_suite
;
881 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
883 * This is usually ignored if @wpa_ie is used.
885 unsigned int group_suite
;
888 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
890 * This is usually ignored if @wpa_ie is used.
892 unsigned int mgmt_group_suite
;
895 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
897 * This is usually ignored if @wpa_ie is used.
899 unsigned int key_mgmt_suite
;
902 * auth_alg - Allowed authentication algorithms
903 * Bit field of WPA_AUTH_ALG_*
908 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
913 * wep_key - WEP keys for static WEP configuration
915 const u8
*wep_key
[4];
918 * wep_key_len - WEP key length for static WEP configuration
920 size_t wep_key_len
[4];
923 * wep_tx_keyidx - WEP TX key index for static WEP configuration
928 * mgmt_frame_protection - IEEE 802.11w management frame protection
930 enum mfp_options mgmt_frame_protection
;
933 * passphrase - RSN passphrase for PSK
935 * This value is made available only for WPA/WPA2-Personal (PSK) and
936 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
937 * is the 8..63 character ASCII passphrase, if available. Please note
938 * that this can be %NULL if passphrase was not used to generate the
939 * PSK. In that case, the psk field must be used to fetch the PSK.
941 const char *passphrase
;
944 * psk - RSN PSK (alternative for passphrase for PSK)
946 * This value is made available only for WPA/WPA2-Personal (PSK) and
947 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
948 * is the 32-octet (256-bit) PSK, if available. The driver wrapper
949 * should be prepared to handle %NULL value as an error.
954 * drop_unencrypted - Enable/disable unencrypted frame filtering
956 * Configure the driver to drop all non-EAPOL frames (both receive and
957 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
958 * still be allowed for key negotiation.
960 int drop_unencrypted
;
963 * prev_bssid - Previously used BSSID in this ESS
965 * When not %NULL, this is a request to use reassociation instead of
968 const u8
*prev_bssid
;
973 * If the driver needs to do special configuration for WPS association,
974 * this variable provides more information on what type of association
975 * is being requested. Most drivers should not need ot use this.
980 * p2p - Whether this connection is a P2P group
985 * uapsd - UAPSD parameters for the network
986 * -1 = do not change defaults
987 * AP mode: 1 = enabled, 0 = disabled
988 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
993 * fixed_bssid - Whether to force this BSSID in IBSS mode
994 * 1 = Fix this BSSID and prevent merges.
995 * 0 = Do not fix BSSID.
1000 * fixed_freq - Fix control channel in IBSS mode
1001 * 0 = don't fix control channel (default)
1002 * 1 = fix control channel; this prevents IBSS merging with another
1008 * disable_ht - Disable HT (IEEE 802.11n) for this connection
1013 * htcaps - HT Capabilities over-rides
1015 * Only bits set in the mask will be used, and not all values are used
1016 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
1018 * Pointer to struct ieee80211_ht_capabilities.
1023 * htcaps_mask - HT Capabilities over-rides mask
1025 * Pointer to struct ieee80211_ht_capabilities.
1027 const u8
*htcaps_mask
;
1029 #ifdef CONFIG_VHT_OVERRIDES
1031 * disable_vht - Disable VHT for this connection
1036 * VHT capability overrides.
1038 const struct ieee80211_vht_capabilities
*vhtcaps
;
1039 const struct ieee80211_vht_capabilities
*vhtcaps_mask
;
1040 #endif /* CONFIG_VHT_OVERRIDES */
1043 * req_key_mgmt_offload - Request key management offload for connection
1045 * Request key management offload for this connection if the device
1048 int req_key_mgmt_offload
;
1051 * Flag for indicating whether this association includes support for
1052 * RRM (Radio Resource Measurements)
1057 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1058 * AP as usual. Valid for DMG network only.
1063 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1068 * fils_kek_len: Length of fils_kek in bytes
1070 size_t fils_kek_len
;
1073 * fils_nonces - Nonces for FILS association frame protection
1076 const u8
*fils_nonces
;
1079 * fils_nonces_len: Length of fils_nonce in bytes
1081 size_t fils_nonces_len
;
1084 * fils_erp_username - Username part of keyName-NAI
1086 const u8
*fils_erp_username
;
1089 * fils_erp_username_len - Length of fils_erp_username in bytes
1091 size_t fils_erp_username_len
;
1094 * fils_erp_realm - Realm/domain name to use in FILS ERP
1096 const u8
*fils_erp_realm
;
1099 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1101 size_t fils_erp_realm_len
;
1104 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1107 u16 fils_erp_next_seq_num
;
1110 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1111 * specified by fils_erp_username@fils_erp_realm.
1113 const u8
*fils_erp_rrk
;
1116 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1118 size_t fils_erp_rrk_len
;
1123 HIDDEN_SSID_ZERO_LEN
,
1124 HIDDEN_SSID_ZERO_CONTENTS
1127 enum ch_switch_state
{
1132 struct wowlan_triggers
{
1136 u8 gtk_rekey_failure
;
1137 u8 eap_identity_req
;
1138 u8 four_way_handshake
;
1142 struct wpa_driver_ap_params
{
1144 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1149 * head_len - Length of the head buffer in octets
1154 * tail - Beacon tail following TIM IE
1159 * tail_len - Length of the tail buffer in octets
1164 * dtim_period - DTIM period
1169 * beacon_int - Beacon interval
1174 * basic_rates: -1 terminated array of basic rates in 100 kbps
1176 * This parameter can be used to set a specific basic rate set for the
1177 * BSS. If %NULL, default basic rate set is used.
1182 * beacon_rate: Beacon frame data rate
1184 * This parameter can be used to set a specific Beacon frame data rate
1185 * for the BSS. The interpretation of this value depends on the
1186 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS). If
1187 * beacon_rate == 0 and rate_type == 0 (BEACON_RATE_LEGACY), the default
1188 * Beacon frame data rate is used.
1190 unsigned int beacon_rate
;
1193 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT)
1195 enum beacon_rate_type rate_type
;
1198 * proberesp - Probe Response template
1200 * This is used by drivers that reply to Probe Requests internally in
1201 * AP mode and require the full Probe Response template.
1206 * proberesp_len - Length of the proberesp buffer in octets
1208 size_t proberesp_len
;
1211 * ssid - The SSID to use in Beacon/Probe Response frames
1216 * ssid_len - Length of the SSID (1..32)
1221 * hide_ssid - Whether to hide the SSID
1223 enum hide_ssid hide_ssid
;
1226 * pairwise_ciphers - WPA_CIPHER_* bitfield
1228 unsigned int pairwise_ciphers
;
1231 * group_cipher - WPA_CIPHER_*
1233 unsigned int group_cipher
;
1236 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1238 unsigned int key_mgmt_suites
;
1241 * auth_algs - WPA_AUTH_ALG_* bitfield
1243 unsigned int auth_algs
;
1246 * wpa_version - WPA_PROTO_* bitfield
1248 unsigned int wpa_version
;
1251 * privacy - Whether privacy is used in the BSS
1256 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1258 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1259 * not use the full Beacon template.
1261 const struct wpabuf
*beacon_ies
;
1264 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1266 * This is used to add IEs like WPS IE and P2P IE by drivers that
1267 * reply to Probe Request frames internally.
1269 const struct wpabuf
*proberesp_ies
;
1272 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1274 * This is used to add IEs like WPS IE by drivers that reply to
1275 * (Re)Association Request frames internally.
1277 const struct wpabuf
*assocresp_ies
;
1280 * isolate - Whether to isolate frames between associated stations
1282 * If this is non-zero, the AP is requested to disable forwarding of
1283 * frames between associated stations.
1288 * cts_protect - Whether CTS protection is enabled
1293 * preamble - Whether short preamble is enabled
1298 * short_slot_time - Whether short slot time is enabled
1300 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1301 * not set (e.g., when 802.11g mode is not in use)
1303 int short_slot_time
;
1306 * ht_opmode - HT operation mode or -1 if HT not in use
1311 * interworking - Whether Interworking is enabled
1316 * hessid - Homogeneous ESS identifier or %NULL if not set
1321 * access_network_type - Access Network Type (0..15)
1323 * This is used for filtering Probe Request frames when Interworking is
1326 u8 access_network_type
;
1329 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1331 * This is used by driver which advertises this capability.
1333 int ap_max_inactivity
;
1336 * ctwindow - Client Traffic Window (in TUs)
1341 * smps_mode - SMPS mode
1343 * SMPS mode to be used by the AP, specified as the relevant bits of
1344 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1346 unsigned int smps_mode
;
1349 * disable_dgaf - Whether group-addressed frames are disabled
1354 * osen - Whether OSEN security is enabled
1359 * freq - Channel parameters for dynamic bandwidth changes
1361 struct hostapd_freq_params
*freq
;
1364 * reenable - Whether this is to re-enable beaconing
1369 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1370 * infrastructure BSS. Valid only for DMG network.
1375 * multicast_to_unicast - Whether to use multicast_to_unicast
1377 * If this is non-zero, the AP is requested to perform multicast to
1378 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1379 * 802.1Q). If enabled, such frames are to be sent to each station
1380 * separately, with the DA replaced by their own MAC address rather
1381 * than the group address.
1383 * Note that this may break certain expectations of the receiver, such
1384 * as the ability to drop unicast IP packets received within multicast
1385 * L2 frames, or the ability to not send ICMP destination unreachable
1386 * messages for packets received in L2 multicast (which is required,
1387 * but the receiver can't tell the difference if this new option is
1390 * This also doesn't implement the 802.11 DMS (directed multicast
1393 int multicast_to_unicast
;
1396 * ftm_responder - Whether FTM responder is enabled
1401 * lci - Binary data, the content of an LCI report IE with type 8 as
1402 * defined in IEEE Std 802.11-2016, 9.4.2.22.10
1404 const struct wpabuf
*lci
;
1407 * civic - Binary data, the content of a measurement report IE with
1408 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
1410 const struct wpabuf
*civic
;
1413 struct wpa_driver_mesh_bss_params
{
1414 #define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1415 #define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1416 #define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1417 #define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
1418 #define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010
1420 * TODO: Other mesh configuration parameters would go here.
1421 * See NL80211_MESHCONF_* for all the mesh config parameters.
1425 int peer_link_timeout
;
1431 struct wpa_driver_mesh_join_params
{
1434 const int *basic_rates
;
1437 struct hostapd_freq_params freq
;
1440 struct wpa_driver_mesh_bss_params conf
;
1441 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1442 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1443 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1444 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1449 * struct wpa_driver_capa - Driver capability information
1451 struct wpa_driver_capa
{
1452 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1453 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1454 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1455 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1456 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1457 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1458 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
1459 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
1460 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1461 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
1462 #define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
1463 #define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
1464 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1465 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1466 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1467 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
1468 #define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000
1469 /** Bitfield of supported key management suites */
1470 unsigned int key_mgmt
;
1472 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1473 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1474 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1475 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
1476 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
1477 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
1478 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1479 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1480 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1481 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1482 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1483 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
1484 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
1485 /** Bitfield of supported cipher suites */
1488 #define WPA_DRIVER_AUTH_OPEN 0x00000001
1489 #define WPA_DRIVER_AUTH_SHARED 0x00000002
1490 #define WPA_DRIVER_AUTH_LEAP 0x00000004
1491 /** Bitfield of supported IEEE 802.11 authentication algorithms */
1494 /** Driver generated WPA/RSN IE */
1495 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
1496 /** Driver needs static WEP key setup after association command */
1497 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
1498 /** Driver takes care of all DFS operations */
1499 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
1500 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with
1501 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1502 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008
1503 /** Driver is for a wired Ethernet interface */
1504 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
1505 /** Driver provides separate commands for authentication and association (SME in
1506 * wpa_supplicant). */
1507 #define WPA_DRIVER_FLAGS_SME 0x00000020
1508 /** Driver supports AP mode */
1509 #define WPA_DRIVER_FLAGS_AP 0x00000040
1510 /** Driver needs static WEP key setup after association has been completed */
1511 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
1512 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
1513 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
1514 /** Driver supports concurrent P2P operations */
1515 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
1517 * Driver uses the initial interface as a dedicated management interface, i.e.,
1518 * it cannot be used for P2P group operations or non-P2P purposes.
1520 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
1521 /** This interface is P2P capable (P2P GO or P2P Client) */
1522 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
1523 /** Driver supports station and key removal when stopping an AP */
1524 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
1526 * Driver uses the initial interface for P2P management interface and non-P2P
1527 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1528 * P2P group operations.
1530 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
1532 * Driver is known to use sane error codes, i.e., when it indicates that
1533 * something (e.g., association) fails, there was indeed a failure and the
1534 * operation does not end up getting completed successfully later.
1536 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
1537 /** Driver supports off-channel TX */
1538 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
1539 /** Driver indicates TX status events for EAPOL Data frames */
1540 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
1541 /** Driver indicates TX status events for Deauth/Disassoc frames */
1542 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
1543 /** Driver supports roaming (BSS selection) in firmware */
1544 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
1545 /** Driver supports operating as a TDLS peer */
1546 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
1547 /** Driver requires external TDLS setup/teardown/discovery */
1548 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
1549 /** Driver indicates support for Probe Response offloading in AP mode */
1550 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
1551 /** Driver supports U-APSD in AP mode */
1552 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
1553 /** Driver supports inactivity timer in AP mode */
1554 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
1555 /** Driver expects user space implementation of MLME in AP mode */
1556 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
1557 /** Driver supports SAE with user space SME */
1558 #define WPA_DRIVER_FLAGS_SAE 0x02000000
1559 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */
1560 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
1561 /** Driver supports IBSS (Ad-hoc) mode */
1562 #define WPA_DRIVER_FLAGS_IBSS 0x08000000
1563 /** Driver supports radar detection */
1564 #define WPA_DRIVER_FLAGS_RADAR 0x10000000
1565 /** Driver supports a dedicated interface for P2P Device */
1566 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
1567 /** Driver supports QoS Mapping */
1568 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
1569 /** Driver supports CSA in AP mode */
1570 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
1571 /** Driver supports mesh */
1572 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1573 /** Driver support ACS offload */
1574 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1575 /** Driver supports key management offload */
1576 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1577 /** Driver supports TDLS channel switching */
1578 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1579 /** Driver supports IBSS with HT datarates */
1580 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
1581 /** Driver supports IBSS with VHT datarates */
1582 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
1583 /** Driver supports automatic band selection */
1584 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
1585 /** Driver supports simultaneous off-channel operations */
1586 #define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
1587 /** Driver supports full AP client state */
1588 #define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
1589 /** Driver supports P2P Listen offload */
1590 #define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
1591 /** Driver supports FILS */
1592 #define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
1593 /** Driver supports Beacon frame TX rate configuration (legacy rates) */
1594 #define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1595 /** Driver supports Beacon frame TX rate configuration (HT rates) */
1596 #define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1597 /** Driver supports Beacon frame TX rate configuration (VHT rates) */
1598 #define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
1599 /** Driver supports mgmt_tx with random TX address in non-connected state */
1600 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
1601 /** Driver supports mgmt_tx with random TX addr in connected state */
1602 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
1603 /** Driver supports better BSS reporting with sched_scan in connected mode */
1604 #define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
1605 /** Driver supports HE capabilities */
1606 #define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
1607 /** Driver supports FILS shared key offload */
1608 #define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
1609 /** Driver supports all OCE STA specific mandatory features */
1610 #define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
1611 /** Driver supports all OCE AP specific mandatory features */
1612 #define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
1614 * Driver supports all OCE STA-CFON specific mandatory features only.
1615 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
1616 * userspace shall assume that this driver may not support all OCE AP
1617 * functionality but can support only OCE STA-CFON functionality.
1619 #define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
1620 /** Driver supports MFP-optional in the connect command */
1621 #define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL
1622 /** Driver is a self-managed regulatory device */
1623 #define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL
1624 /** Driver supports FTM responder functionality */
1625 #define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL
1626 /** Driver support 4-way handshake offload for WPA-Personal */
1627 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
1630 #define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1631 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1633 #define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1634 #define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1635 unsigned int smps_modes
;
1637 unsigned int wmm_ac_supported
:1;
1639 unsigned int mac_addr_rand_scan_supported
:1;
1640 unsigned int mac_addr_rand_sched_scan_supported
:1;
1642 /** Maximum number of supported active probe SSIDs */
1645 /** Maximum number of supported active probe SSIDs for sched_scan */
1646 int max_sched_scan_ssids
;
1648 /** Maximum number of supported scan plans for scheduled scan */
1649 unsigned int max_sched_scan_plans
;
1651 /** Maximum interval in a scan plan. In seconds */
1652 u32 max_sched_scan_plan_interval
;
1654 /** Maximum number of iterations in a single scan plan */
1655 u32 max_sched_scan_plan_iterations
;
1657 /** Whether sched_scan (offloaded scanning) is supported */
1658 int sched_scan_supported
;
1660 /** Maximum number of supported match sets for sched_scan */
1664 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1666 unsigned int max_remain_on_chan
;
1669 * max_stations - Maximum number of associated stations the driver
1670 * supports in AP mode
1672 unsigned int max_stations
;
1675 * probe_resp_offloads - Bitmap of supported protocols by the driver
1676 * for Probe Response offloading.
1678 /** Driver Probe Response offloading support for WPS ver. 1 */
1679 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
1680 /** Driver Probe Response offloading support for WPS ver. 2 */
1681 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
1682 /** Driver Probe Response offloading support for P2P */
1683 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
1684 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
1685 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1686 unsigned int probe_resp_offloads
;
1688 unsigned int max_acl_mac_addrs
;
1691 * Number of supported concurrent channels
1693 unsigned int num_multichan_concurrent
;
1696 * extended_capa - extended capabilities in driver/device
1698 * Must be allocated and freed by driver and the pointers must be
1699 * valid for the lifetime of the driver, i.e., freed in deinit()
1701 const u8
*extended_capa
, *extended_capa_mask
;
1702 unsigned int extended_capa_len
;
1704 struct wowlan_triggers wowlan_triggers
;
1706 /** Driver adds the DS Params Set IE in Probe Request frames */
1707 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1708 /** Driver adds the WFA TPC IE in Probe Request frames */
1709 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1710 /** Driver handles quiet period requests */
1711 #define WPA_DRIVER_FLAGS_QUIET 0x00000004
1713 * Driver is capable of inserting the current TX power value into the body of
1714 * transmitted frames.
1715 * Background: Some Action frames include a TPC Report IE. This IE contains a
1716 * TX power field, which has to be updated by lower layers. One such Action
1717 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1718 * of spectrum management). Note that this insertion takes place at a fixed
1719 * offset, namely the 6th byte in the Action frame body.
1721 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1723 * Driver supports RRM. With this support, the driver will accept to use RRM in
1724 * (Re)Association Request frames, without supporting quiet period.
1726 #define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1728 /** Driver supports setting the scan dwell time */
1729 #define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
1730 /** Driver supports Beacon Report Measurement */
1731 #define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
1735 /* Driver concurrency capabilities */
1736 unsigned int conc_capab
;
1737 /* Maximum number of concurrent channels on 2.4 GHz */
1738 unsigned int max_conc_chan_2_4
;
1739 /* Maximum number of concurrent channels on 5 GHz */
1740 unsigned int max_conc_chan_5_0
;
1742 /* Maximum number of supported CSA counters */
1743 u16 max_csa_counters
;
1747 struct hostapd_data
;
1749 #define STA_DRV_DATA_TX_MCS BIT(0)
1750 #define STA_DRV_DATA_RX_MCS BIT(1)
1751 #define STA_DRV_DATA_TX_VHT_MCS BIT(2)
1752 #define STA_DRV_DATA_RX_VHT_MCS BIT(3)
1753 #define STA_DRV_DATA_TX_VHT_NSS BIT(4)
1754 #define STA_DRV_DATA_RX_VHT_NSS BIT(5)
1755 #define STA_DRV_DATA_TX_SHORT_GI BIT(6)
1756 #define STA_DRV_DATA_RX_SHORT_GI BIT(7)
1757 #define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
1759 struct hostap_sta_driver_data
{
1760 unsigned long rx_packets
, tx_packets
;
1761 unsigned long long rx_bytes
, tx_bytes
;
1762 unsigned long long rx_airtime
, tx_airtime
;
1763 int bytes_64bit
; /* whether 64-bit byte counters are supported */
1764 unsigned long current_tx_rate
;
1765 unsigned long current_rx_rate
;
1766 unsigned long inactive_msec
;
1767 unsigned long flags
; /* bitfield of STA_DRV_DATA_* */
1768 unsigned long num_ps_buf_frames
;
1769 unsigned long tx_retry_failed
;
1770 unsigned long tx_retry_count
;
1772 unsigned long backlog_packets
;
1773 unsigned long backlog_bytes
;
1783 struct hostapd_sta_add_params
{
1787 const u8
*supp_rates
;
1788 size_t supp_rates_len
;
1789 u16 listen_interval
;
1790 const struct ieee80211_ht_capabilities
*ht_capabilities
;
1791 const struct ieee80211_vht_capabilities
*vht_capabilities
;
1792 int vht_opmode_enabled
;
1794 u32 flags
; /* bitmask of WPA_STA_* flags */
1795 u32 flags_mask
; /* unset bits in flags */
1797 enum mesh_plink_state plink_state
;
1799 #endif /* CONFIG_MESH */
1800 int set
; /* Set STA parameters instead of add */
1802 const u8
*ext_capab
;
1803 size_t ext_capab_len
;
1804 const u8
*supp_channels
;
1805 size_t supp_channels_len
;
1806 const u8
*supp_oper_classes
;
1807 size_t supp_oper_classes_len
;
1811 struct mac_address
{
1815 struct hostapd_acl_params
{
1817 unsigned int num_mac_acl
;
1818 struct mac_address mac_acl
[0];
1821 enum wpa_driver_if_type
{
1823 * WPA_IF_STATION - Station mode interface
1828 * WPA_IF_AP_VLAN - AP mode VLAN interface
1830 * This interface shares its address and Beacon frame with the main
1836 * WPA_IF_AP_BSS - AP mode BSS interface
1838 * This interface has its own address and Beacon frame.
1843 * WPA_IF_P2P_GO - P2P Group Owner
1848 * WPA_IF_P2P_CLIENT - P2P Client
1853 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1854 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1859 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1860 * abstracted P2P Device function in the driver
1865 * WPA_IF_MESH - Mesh interface
1870 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1875 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1880 struct wpa_init_params
{
1884 const char *driver_params
;
1885 int use_pae_group_addr
;
1889 u8
*own_addr
; /* buffer for writing own MAC address */
1893 struct wpa_bss_params
{
1894 /** Interface name (for multi-SSID/VLAN support) */
1896 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1905 enum mfp_options ieee80211w
;
1908 #define WPA_STA_AUTHORIZED BIT(0)
1909 #define WPA_STA_WMM BIT(1)
1910 #define WPA_STA_SHORT_PREAMBLE BIT(2)
1911 #define WPA_STA_MFP BIT(3)
1912 #define WPA_STA_TDLS_PEER BIT(4)
1913 #define WPA_STA_AUTHENTICATED BIT(5)
1914 #define WPA_STA_ASSOCIATED BIT(6)
1927 WNM_SLEEP_ENTER_CONFIRM
,
1928 WNM_SLEEP_ENTER_FAIL
,
1929 WNM_SLEEP_EXIT_CONFIRM
,
1930 WNM_SLEEP_EXIT_FAIL
,
1931 WNM_SLEEP_TFS_REQ_IE_ADD
, /* STA requests driver to add TFS req IE */
1932 WNM_SLEEP_TFS_REQ_IE_NONE
, /* STA requests empty TFS req IE */
1933 WNM_SLEEP_TFS_REQ_IE_SET
, /* AP requests driver to set TFS req IE for
1935 WNM_SLEEP_TFS_RESP_IE_ADD
, /* AP requests driver to add TFS resp IE
1937 WNM_SLEEP_TFS_RESP_IE_NONE
, /* AP requests empty TFS resp IE */
1938 WNM_SLEEP_TFS_RESP_IE_SET
, /* AP requests driver to set TFS resp IE
1940 WNM_SLEEP_TFS_IE_DEL
/* AP delete the TFS IE */
1943 /* enum smps_mode - SMPS mode definitions */
1954 #define WPA_INVALID_NOISE 9999
1957 * struct wpa_signal_info - Information about channel signal quality
1958 * @frequency: control frequency
1959 * @above_threshold: true if the above threshold was crossed
1960 * (relevant for a CQM event)
1961 * @current_signal: in dBm
1962 * @avg_signal: in dBm
1963 * @avg_beacon_signal: in dBm
1964 * @current_noise: %WPA_INVALID_NOISE if not supported
1965 * @current_txrate: current TX rate
1966 * @chanwidth: channel width
1967 * @center_frq1: center frequency for the first segment
1968 * @center_frq2: center frequency for the second segment (if relevant)
1970 struct wpa_signal_info
{
1972 int above_threshold
;
1975 int avg_beacon_signal
;
1978 enum chan_width chanwidth
;
1984 * struct wpa_channel_info - Information about the current channel
1985 * @frequency: Center frequency of the primary 20 MHz channel
1986 * @chanwidth: Width of the current operating channel
1987 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
1988 * This field is only filled in when using a 40 MHz channel.
1989 * @center_frq1: Center frequency of frequency segment 0
1990 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
1991 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
1992 * derived from center_frq2 for convenience.
1994 struct wpa_channel_info
{
1996 enum chan_width chanwidth
;
2004 * struct beacon_data - Beacon data
2005 * @head: Head portion of Beacon frame (before TIM IE)
2006 * @tail: Tail portion of Beacon frame (after TIM IE)
2007 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2008 * @proberesp_ies: Extra information element(s) to add into Probe Response
2010 * @assocresp_ies: Extra information element(s) to add into (Re)Association
2011 * Response frames or %NULL
2012 * @probe_resp: Probe Response frame template
2013 * @head_len: Length of @head
2014 * @tail_len: Length of @tail
2015 * @beacon_ies_len: Length of beacon_ies in octets
2016 * @proberesp_ies_len: Length of proberesp_ies in octets
2017 * @proberesp_ies_len: Length of proberesp_ies in octets
2018 * @probe_resp_len: Length of probe response template (@probe_resp)
2020 struct beacon_data
{
2027 size_t head_len
, tail_len
;
2028 size_t beacon_ies_len
;
2029 size_t proberesp_ies_len
;
2030 size_t assocresp_ies_len
;
2031 size_t probe_resp_len
;
2035 * struct csa_settings - Settings for channel switch command
2036 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2037 * @block_tx: 1 - block transmission for CSA period
2038 * @freq_params: Next channel frequency parameter
2039 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2040 * @beacon_after: Next beacon/probe resp/asooc resp info
2041 * @counter_offset_beacon: Offset to the count field in beacon's tail
2042 * @counter_offset_presp: Offset to the count field in probe resp.
2044 struct csa_settings
{
2048 struct hostapd_freq_params freq_params
;
2049 struct beacon_data beacon_csa
;
2050 struct beacon_data beacon_after
;
2052 u16 counter_offset_beacon
[2];
2053 u16 counter_offset_presp
[2];
2056 /* TDLS peer capabilities for send_tdls_mgmt() */
2057 enum tdls_peer_capability
{
2058 TDLS_PEER_HT
= BIT(0),
2059 TDLS_PEER_VHT
= BIT(1),
2060 TDLS_PEER_WMM
= BIT(2),
2063 /* valid info in the wmm_params struct */
2064 enum wmm_params_valid_info
{
2065 WMM_PARAMS_UAPSD_QUEUES_INFO
= BIT(0),
2069 * struct wmm_params - WMM parameterss configured for this association
2070 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2071 * of the struct contain valid information.
2072 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2073 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2080 #ifdef CONFIG_MACSEC
2081 struct macsec_init_params
{
2082 Boolean always_include_sci
;
2086 #endif /* CONFIG_MACSEC */
2088 enum drv_br_port_attr
{
2089 DRV_BR_PORT_ATTR_PROXYARP
,
2090 DRV_BR_PORT_ATTR_HAIRPIN_MODE
,
2093 enum drv_br_net_param
{
2094 DRV_BR_NET_PARAM_GARP_ACCEPT
,
2095 DRV_BR_MULTICAST_SNOOPING
,
2098 struct drv_acs_params
{
2099 /* Selected mode (HOSTAPD_MODE_*) */
2100 enum hostapd_hw_mode hw_mode
;
2102 /* Indicates whether HT is enabled */
2105 /* Indicates whether HT40 is enabled */
2108 /* Indicates whether VHT is enabled */
2111 /* Configured ACS channel width */
2114 /* ACS channel list info */
2115 unsigned int ch_list_len
;
2117 const int *freq_list
;
2120 struct wpa_bss_trans_info
{
2121 u8 mbo_transition_reason
;
2126 struct wpa_bss_candidate_info
{
2128 struct candidate_list
{
2135 struct wpa_pmkid_params
{
2139 const u8
*fils_cache_id
;
2145 /* Mask used to specify which connection parameters have to be updated */
2146 enum wpa_drv_update_connect_params_mask
{
2147 WPA_DRV_UPDATE_ASSOC_IES
= BIT(0),
2148 WPA_DRV_UPDATE_FILS_ERP_INFO
= BIT(1),
2149 WPA_DRV_UPDATE_AUTH_TYPE
= BIT(2),
2153 * struct external_auth - External authentication trigger parameters
2155 * These are used across the external authentication request and event
2157 * @action: Action type / trigger for external authentication. Only significant
2158 * for the event interface.
2159 * @bssid: BSSID of the peer with which the authentication has to happen. Used
2160 * by both the request and event interface.
2161 * @ssid: SSID of the AP. Used by both the request and event interface.
2162 * @ssid_len: SSID length in octets.
2163 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2164 * the request interface.
2165 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2166 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2167 * the real status code for failures. Used only for the request interface
2168 * from user space to the driver.
2169 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
2171 struct external_auth
{
2179 unsigned int key_mgmt_suite
;
2185 * struct wpa_driver_ops - Driver interface API definition
2187 * This structure defines the API that each driver interface needs to implement
2188 * for core wpa_supplicant code. All driver specific functionality is captured
2191 struct wpa_driver_ops
{
2192 /** Name of the driver interface */
2194 /** One line description of the driver interface */
2198 * get_bssid - Get the current BSSID
2199 * @priv: private driver interface data
2200 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2202 * Returns: 0 on success, -1 on failure
2204 * Query kernel driver for the current BSSID and copy it to bssid.
2205 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2208 int (*get_bssid
)(void *priv
, u8
*bssid
);
2211 * get_ssid - Get the current SSID
2212 * @priv: private driver interface data
2213 * @ssid: buffer for SSID (at least 32 bytes)
2215 * Returns: Length of the SSID on success, -1 on failure
2217 * Query kernel driver for the current SSID and copy it to ssid.
2218 * Returning zero is recommended if the STA is not associated.
2220 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2221 * can, at least in theory, contain control characters (including nul)
2222 * and as such, should be processed as binary data, not a printable
2225 int (*get_ssid
)(void *priv
, u8
*ssid
);
2228 * set_key - Configure encryption key
2229 * @ifname: Interface name (for multi-SSID/VLAN support)
2230 * @priv: private driver interface data
2231 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
2232 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
2233 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
2234 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
2235 * %WPA_ALG_BIP_CMAC_256);
2236 * %WPA_ALG_NONE clears the key.
2237 * @addr: Address of the peer STA (BSSID of the current AP when setting
2238 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
2239 * broadcast keys, %NULL for default keys that are used both for
2240 * broadcast and unicast; when clearing keys, %NULL is used to
2241 * indicate that both the broadcast-only and default key of the
2242 * specified key index is to be cleared
2243 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
2245 * @set_tx: configure this key as the default Tx key (only used when
2246 * driver does not support separate unicast/individual key
2247 * @seq: sequence number/packet number, seq_len octets, the next
2248 * packet number to be used for in replay protection; configured
2249 * for Rx keys (in most cases, this is only used with broadcast
2250 * keys and set to zero for unicast keys); %NULL if not set
2251 * @seq_len: length of the seq, depends on the algorithm:
2252 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
2253 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
2255 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
2256 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
2258 * Returns: 0 on success, -1 on failure
2260 * Configure the given key for the kernel driver. If the driver
2261 * supports separate individual keys (4 default keys + 1 individual),
2262 * addr can be used to determine whether the key is default or
2263 * individual. If only 4 keys are supported, the default key with key
2264 * index 0 is used as the individual key. STA must be configured to use
2265 * it as the default Tx key (set_tx is set) and accept Rx for all the
2266 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2267 * broadcast keys, so key index 0 is available for this kind of
2270 * Please note that TKIP keys include separate TX and RX MIC keys and
2271 * some drivers may expect them in different order than wpa_supplicant
2272 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
2273 * will trigger Michael MIC errors. This can be fixed by changing the
2274 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
2275 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2276 * example on how this can be done.
2278 int (*set_key
)(const char *ifname
, void *priv
, enum wpa_alg alg
,
2279 const u8
*addr
, int key_idx
, int set_tx
,
2280 const u8
*seq
, size_t seq_len
,
2281 const u8
*key
, size_t key_len
);
2284 * init - Initialize driver interface
2285 * @ctx: context to be used when calling wpa_supplicant functions,
2286 * e.g., wpa_supplicant_event()
2287 * @ifname: interface name, e.g., wlan0
2289 * Returns: Pointer to private data, %NULL on failure
2291 * Initialize driver interface, including event processing for kernel
2292 * driver events (e.g., associated, scan results, Michael MIC failure).
2293 * This function can allocate a private configuration data area for
2294 * @ctx, file descriptor, interface name, etc. information that may be
2295 * needed in future driver operations. If this is not used, non-NULL
2296 * value will need to be returned because %NULL is used to indicate
2297 * failure. The returned value will be used as 'void *priv' data for
2298 * all other driver_ops functions.
2300 * The main event loop (eloop.c) of wpa_supplicant can be used to
2301 * register callback for read sockets (eloop_register_read_sock()).
2303 * See below for more information about events and
2304 * wpa_supplicant_event() function.
2306 void * (*init
)(void *ctx
, const char *ifname
);
2309 * deinit - Deinitialize driver interface
2310 * @priv: private driver interface data from init()
2312 * Shut down driver interface and processing of driver events. Free
2313 * private data buffer if one was allocated in init() handler.
2315 void (*deinit
)(void *priv
);
2318 * set_param - Set driver configuration parameters
2319 * @priv: private driver interface data from init()
2320 * @param: driver specific configuration parameters
2322 * Returns: 0 on success, -1 on failure
2324 * Optional handler for notifying driver interface about configuration
2325 * parameters (driver_param).
2327 int (*set_param
)(void *priv
, const char *param
);
2330 * set_countermeasures - Enable/disable TKIP countermeasures
2331 * @priv: private driver interface data
2332 * @enabled: 1 = countermeasures enabled, 0 = disabled
2334 * Returns: 0 on success, -1 on failure
2336 * Configure TKIP countermeasures. When these are enabled, the driver
2337 * should drop all received and queued frames that are using TKIP.
2339 int (*set_countermeasures
)(void *priv
, int enabled
);
2342 * deauthenticate - Request driver to deauthenticate
2343 * @priv: private driver interface data
2344 * @addr: peer address (BSSID of the AP)
2345 * @reason_code: 16-bit reason code to be sent in the deauthentication
2348 * Returns: 0 on success, -1 on failure
2350 int (*deauthenticate
)(void *priv
, const u8
*addr
, u16 reason_code
);
2353 * associate - Request driver to associate
2354 * @priv: private driver interface data
2355 * @params: association parameters
2357 * Returns: 0 on success, -1 on failure
2359 int (*associate
)(void *priv
,
2360 struct wpa_driver_associate_params
*params
);
2363 * add_pmkid - Add PMKSA cache entry to the driver
2364 * @priv: private driver interface data
2365 * @params: PMKSA parameters
2367 * Returns: 0 on success, -1 on failure
2369 * This function is called when a new PMK is received, as a result of
2370 * either normal authentication or RSN pre-authentication. The PMKSA
2371 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2372 * ssid, fils_cache_id, pmkid, and pmk.
2374 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2375 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2376 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2377 * driver_ops function does not need to be implemented. Likewise, if
2378 * the driver does not support WPA, this function is not needed.
2380 int (*add_pmkid
)(void *priv
, struct wpa_pmkid_params
*params
);
2383 * remove_pmkid - Remove PMKSA cache entry to the driver
2384 * @priv: private driver interface data
2385 * @params: PMKSA parameters
2387 * Returns: 0 on success, -1 on failure
2389 * This function is called when the supplicant drops a PMKSA cache
2390 * entry for any reason. The PMKSA parameters are either a set of
2391 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
2393 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2394 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2395 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2396 * from wpa_supplicant, this driver_ops function does not need to be
2397 * implemented. Likewise, if the driver does not support WPA, this
2398 * function is not needed.
2400 int (*remove_pmkid
)(void *priv
, struct wpa_pmkid_params
*params
);
2403 * flush_pmkid - Flush PMKSA cache
2404 * @priv: private driver interface data
2406 * Returns: 0 on success, -1 on failure
2408 * This function is called when the supplicant drops all PMKSA cache
2409 * entries for any reason.
2411 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2412 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2413 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2414 * from wpa_supplicant, this driver_ops function does not need to be
2415 * implemented. Likewise, if the driver does not support WPA, this
2416 * function is not needed.
2418 int (*flush_pmkid
)(void *priv
);
2421 * get_capa - Get driver capabilities
2422 * @priv: private driver interface data
2424 * Returns: 0 on success, -1 on failure
2426 * Get driver/firmware/hardware capabilities.
2428 int (*get_capa
)(void *priv
, struct wpa_driver_capa
*capa
);
2431 * poll - Poll driver for association information
2432 * @priv: private driver interface data
2434 * This is an option callback that can be used when the driver does not
2435 * provide event mechanism for association events. This is called when
2436 * receiving WPA EAPOL-Key messages that require association
2437 * information. The driver interface is supposed to generate associnfo
2438 * event before returning from this callback function. In addition, the
2439 * driver interface should generate an association event after having
2440 * sent out associnfo.
2442 void (*poll
)(void *priv
);
2445 * get_ifindex - Get interface index
2446 * @priv: private driver interface data
2448 * Returns: Interface index
2450 unsigned int (*get_ifindex
)(void *priv
);
2453 * get_ifname - Get interface name
2454 * @priv: private driver interface data
2456 * Returns: Pointer to the interface name. This can differ from the
2457 * interface name used in init() call. Init() is called first.
2459 * This optional function can be used to allow the driver interface to
2460 * replace the interface name with something else, e.g., based on an
2461 * interface mapping from a more descriptive name.
2463 const char * (*get_ifname
)(void *priv
);
2466 * get_mac_addr - Get own MAC address
2467 * @priv: private driver interface data
2469 * Returns: Pointer to own MAC address or %NULL on failure
2471 * This optional function can be used to get the own MAC address of the
2472 * device from the driver interface code. This is only needed if the
2473 * l2_packet implementation for the OS does not provide easy access to
2475 const u8
* (*get_mac_addr
)(void *priv
);
2478 * set_operstate - Sets device operating state to DORMANT or UP
2479 * @priv: private driver interface data
2480 * @state: 0 = dormant, 1 = up
2481 * Returns: 0 on success, -1 on failure
2483 * This is an optional function that can be used on operating systems
2484 * that support a concept of controlling network device state from user
2485 * space applications. This function, if set, gets called with
2486 * state = 1 when authentication has been completed and with state = 0
2487 * when connection is lost.
2489 int (*set_operstate
)(void *priv
, int state
);
2492 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2493 * @priv: Private driver interface data
2494 * @addr: Address of the station for which to set protection (may be
2495 * %NULL for group keys)
2496 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2497 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2498 * Returns: 0 on success, -1 on failure
2500 * This is an optional function that can be used to set the driver to
2501 * require protection for Tx and/or Rx frames. This uses the layer
2502 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2503 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2504 * set protection operation; instead, they set protection implicitly
2505 * based on configured keys.
2507 int (*mlme_setprotection
)(void *priv
, const u8
*addr
, int protect_type
,
2511 * get_hw_feature_data - Get hardware support data (channels and rates)
2512 * @priv: Private driver interface data
2513 * @num_modes: Variable for returning the number of returned modes
2514 * flags: Variable for returning hardware feature flags
2515 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
2516 * Returns: Pointer to allocated hardware data on success or %NULL on
2517 * failure. Caller is responsible for freeing this.
2519 struct hostapd_hw_modes
* (*get_hw_feature_data
)(void *priv
,
2521 u16
*flags
, u8
*dfs
);
2524 * send_mlme - Send management frame from MLME
2525 * @priv: Private driver interface data
2526 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2527 * @data_len: Size of the management frame
2528 * @noack: Do not wait for this frame to be acked (disable retries)
2529 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2531 * @csa_offs: Array of CSA offsets or %NULL
2532 * @csa_offs_len: Number of elements in csa_offs
2533 * Returns: 0 on success, -1 on failure
2535 int (*send_mlme
)(void *priv
, const u8
*data
, size_t data_len
,
2536 int noack
, unsigned int freq
, const u16
*csa_offs
,
2537 size_t csa_offs_len
);
2540 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2541 * @priv: Private driver interface data
2542 * @md: Mobility domain (2 octets) (also included inside ies)
2543 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2544 * @ies_len: Length of FT IEs in bytes
2545 * Returns: 0 on success, -1 on failure
2547 * The supplicant uses this callback to let the driver know that keying
2548 * material for FT is available and that the driver can use the
2549 * provided IEs in the next message in FT authentication sequence.
2551 * This function is only needed for driver that support IEEE 802.11r
2552 * (Fast BSS Transition).
2554 int (*update_ft_ies
)(void *priv
, const u8
*md
, const u8
*ies
,
2558 * get_scan_results2 - Fetch the latest scan results
2559 * @priv: private driver interface data
2561 * Returns: Allocated buffer of scan results (caller is responsible for
2562 * freeing the data structure) on success, NULL on failure
2564 struct wpa_scan_results
* (*get_scan_results2
)(void *priv
);
2567 * set_country - Set country
2568 * @priv: Private driver interface data
2569 * @alpha2: country to which to switch to
2570 * Returns: 0 on success, -1 on failure
2572 * This function is for drivers which support some form
2573 * of setting a regulatory domain.
2575 int (*set_country
)(void *priv
, const char *alpha2
);
2578 * get_country - Get country
2579 * @priv: Private driver interface data
2580 * @alpha2: Buffer for returning country code (at least 3 octets)
2581 * Returns: 0 on success, -1 on failure
2583 int (*get_country
)(void *priv
, char *alpha2
);
2586 * global_init - Global driver initialization
2587 * @ctx: wpa_global pointer
2588 * Returns: Pointer to private data (global), %NULL on failure
2590 * This optional function is called to initialize the driver wrapper
2591 * for global data, i.e., data that applies to all interfaces. If this
2592 * function is implemented, global_deinit() will also need to be
2593 * implemented to free the private data. The driver will also likely
2594 * use init2() function instead of init() to get the pointer to global
2595 * data available to per-interface initializer.
2597 void * (*global_init
)(void *ctx
);
2600 * global_deinit - Global driver deinitialization
2601 * @priv: private driver global data from global_init()
2603 * Terminate any global driver related functionality and free the
2604 * global data structure.
2606 void (*global_deinit
)(void *priv
);
2609 * init2 - Initialize driver interface (with global data)
2610 * @ctx: context to be used when calling wpa_supplicant functions,
2611 * e.g., wpa_supplicant_event()
2612 * @ifname: interface name, e.g., wlan0
2613 * @global_priv: private driver global data from global_init()
2614 * Returns: Pointer to private data, %NULL on failure
2616 * This function can be used instead of init() if the driver wrapper
2619 void * (*init2
)(void *ctx
, const char *ifname
, void *global_priv
);
2622 * get_interfaces - Get information about available interfaces
2623 * @global_priv: private driver global data from global_init()
2624 * Returns: Allocated buffer of interface information (caller is
2625 * responsible for freeing the data structure) on success, NULL on
2628 struct wpa_interface_info
* (*get_interfaces
)(void *global_priv
);
2631 * scan2 - Request the driver to initiate scan
2632 * @priv: private driver interface data
2633 * @params: Scan parameters
2635 * Returns: 0 on success, -1 on failure
2637 * Once the scan results are ready, the driver should report scan
2638 * results event for wpa_supplicant which will eventually request the
2639 * results with wpa_driver_get_scan_results2().
2641 int (*scan2
)(void *priv
, struct wpa_driver_scan_params
*params
);
2644 * authenticate - Request driver to authenticate
2645 * @priv: private driver interface data
2646 * @params: authentication parameters
2647 * Returns: 0 on success, -1 on failure
2649 * This is an optional function that can be used with drivers that
2650 * support separate authentication and association steps, i.e., when
2651 * wpa_supplicant can act as the SME. If not implemented, associate()
2652 * function is expected to take care of IEEE 802.11 authentication,
2655 int (*authenticate
)(void *priv
,
2656 struct wpa_driver_auth_params
*params
);
2659 * set_ap - Set Beacon and Probe Response information for AP mode
2660 * @priv: Private driver interface data
2661 * @params: Parameters to use in AP mode
2663 * This function is used to configure Beacon template and/or extra IEs
2664 * to add for Beacon and Probe Response frames for the driver in
2665 * AP mode. The driver is responsible for building the full Beacon
2666 * frame by concatenating the head part with TIM IE generated by the
2667 * driver/firmware and finishing with the tail part. Depending on the
2668 * driver architectue, this can be done either by using the full
2669 * template or the set of additional IEs (e.g., WPS and P2P IE).
2670 * Similarly, Probe Response processing depends on the driver design.
2671 * If the driver (or firmware) takes care of replying to Probe Request
2672 * frames, the extra IEs provided here needs to be added to the Probe
2675 * Returns: 0 on success, -1 on failure
2677 int (*set_ap
)(void *priv
, struct wpa_driver_ap_params
*params
);
2680 * set_acl - Set ACL in AP mode
2681 * @priv: Private driver interface data
2682 * @params: Parameters to configure ACL
2683 * Returns: 0 on success, -1 on failure
2685 * This is used only for the drivers which support MAC address ACL.
2687 int (*set_acl
)(void *priv
, struct hostapd_acl_params
*params
);
2690 * hapd_init - Initialize driver interface (hostapd only)
2691 * @hapd: Pointer to hostapd context
2692 * @params: Configuration for the driver wrapper
2693 * Returns: Pointer to private data, %NULL on failure
2695 * This function is used instead of init() or init2() when the driver
2696 * wrapper is used with hostapd.
2698 void * (*hapd_init
)(struct hostapd_data
*hapd
,
2699 struct wpa_init_params
*params
);
2702 * hapd_deinit - Deinitialize driver interface (hostapd only)
2703 * @priv: Private driver interface data from hapd_init()
2705 void (*hapd_deinit
)(void *priv
);
2708 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2709 * @priv: Private driver interface data
2710 * @params: BSS parameters
2711 * Returns: 0 on success, -1 on failure
2713 * This is an optional function to configure the kernel driver to
2714 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2715 * can be left undefined (set to %NULL) if IEEE 802.1X support is
2716 * always enabled and the driver uses set_ap() to set WPA/RSN IE
2717 * for Beacon frames.
2719 * DEPRECATED - use set_ap() instead
2721 int (*set_ieee8021x
)(void *priv
, struct wpa_bss_params
*params
);
2724 * set_privacy - Enable/disable privacy (AP only)
2725 * @priv: Private driver interface data
2726 * @enabled: 1 = privacy enabled, 0 = disabled
2727 * Returns: 0 on success, -1 on failure
2729 * This is an optional function to configure privacy field in the
2730 * kernel driver for Beacon frames. This can be left undefined (set to
2731 * %NULL) if the driver uses the Beacon template from set_ap().
2733 * DEPRECATED - use set_ap() instead
2735 int (*set_privacy
)(void *priv
, int enabled
);
2738 * get_seqnum - Fetch the current TSC/packet number (AP only)
2739 * @ifname: The interface name (main or virtual)
2740 * @priv: Private driver interface data
2741 * @addr: MAC address of the station or %NULL for group keys
2743 * @seq: Buffer for returning the latest used TSC/packet number
2744 * Returns: 0 on success, -1 on failure
2746 * This function is used to fetch the last used TSC/packet number for
2747 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2748 * keys, so there is no strict requirement on implementing support for
2749 * unicast keys (i.e., addr != %NULL).
2751 int (*get_seqnum
)(const char *ifname
, void *priv
, const u8
*addr
,
2755 * flush - Flush all association stations (AP only)
2756 * @priv: Private driver interface data
2757 * Returns: 0 on success, -1 on failure
2759 * This function requests the driver to disassociate all associated
2760 * stations. This function does not need to be implemented if the
2761 * driver does not process association frames internally.
2763 int (*flush
)(void *priv
);
2766 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2767 * @priv: Private driver interface data
2768 * @elem: Information elements
2769 * @elem_len: Length of the elem buffer in octets
2770 * Returns: 0 on success, -1 on failure
2772 * This is an optional function to add information elements in the
2773 * kernel driver for Beacon and Probe Response frames. This can be left
2774 * undefined (set to %NULL) if the driver uses the Beacon template from
2777 * DEPRECATED - use set_ap() instead
2779 int (*set_generic_elem
)(void *priv
, const u8
*elem
, size_t elem_len
);
2782 * read_sta_data - Fetch station data
2783 * @priv: Private driver interface data
2784 * @data: Buffer for returning station information
2785 * @addr: MAC address of the station
2786 * Returns: 0 on success, -1 on failure
2788 int (*read_sta_data
)(void *priv
, struct hostap_sta_driver_data
*data
,
2792 * hapd_send_eapol - Send an EAPOL packet (AP only)
2793 * @priv: private driver interface data
2794 * @addr: Destination MAC address
2795 * @data: EAPOL packet starting with IEEE 802.1X header
2796 * @data_len: Length of the EAPOL packet in octets
2797 * @encrypt: Whether the frame should be encrypted
2798 * @own_addr: Source MAC address
2799 * @flags: WPA_STA_* flags for the destination station
2801 * Returns: 0 on success, -1 on failure
2803 int (*hapd_send_eapol
)(void *priv
, const u8
*addr
, const u8
*data
,
2804 size_t data_len
, int encrypt
,
2805 const u8
*own_addr
, u32 flags
);
2808 * sta_deauth - Deauthenticate a station (AP only)
2809 * @priv: Private driver interface data
2810 * @own_addr: Source address and BSSID for the Deauthentication frame
2811 * @addr: MAC address of the station to deauthenticate
2812 * @reason: Reason code for the Deauthentiation frame
2813 * Returns: 0 on success, -1 on failure
2815 * This function requests a specific station to be deauthenticated and
2816 * a Deauthentication frame to be sent to it.
2818 int (*sta_deauth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2822 * sta_disassoc - Disassociate a station (AP only)
2823 * @priv: Private driver interface data
2824 * @own_addr: Source address and BSSID for the Disassociation frame
2825 * @addr: MAC address of the station to disassociate
2826 * @reason: Reason code for the Disassociation frame
2827 * Returns: 0 on success, -1 on failure
2829 * This function requests a specific station to be disassociated and
2830 * a Disassociation frame to be sent to it.
2832 int (*sta_disassoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
2836 * sta_remove - Remove a station entry (AP only)
2837 * @priv: Private driver interface data
2838 * @addr: MAC address of the station to be removed
2839 * Returns: 0 on success, -1 on failure
2841 int (*sta_remove
)(void *priv
, const u8
*addr
);
2844 * hapd_get_ssid - Get the current SSID (AP only)
2845 * @priv: Private driver interface data
2846 * @buf: Buffer for returning the SSID
2847 * @len: Maximum length of the buffer
2848 * Returns: Length of the SSID on success, -1 on failure
2850 * This function need not be implemented if the driver uses Beacon
2851 * template from set_ap() and does not reply to Probe Request frames.
2853 int (*hapd_get_ssid
)(void *priv
, u8
*buf
, int len
);
2856 * hapd_set_ssid - Set SSID (AP only)
2857 * @priv: Private driver interface data
2859 * @len: Length of the SSID in octets
2860 * Returns: 0 on success, -1 on failure
2862 * DEPRECATED - use set_ap() instead
2864 int (*hapd_set_ssid
)(void *priv
, const u8
*buf
, int len
);
2867 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2868 * @priv: Private driver interface data
2869 * @enabled: 1 = countermeasures enabled, 0 = disabled
2870 * Returns: 0 on success, -1 on failure
2872 * This need not be implemented if the driver does not take care of
2873 * association processing.
2875 int (*hapd_set_countermeasures
)(void *priv
, int enabled
);
2878 * sta_add - Add a station entry
2879 * @priv: Private driver interface data
2880 * @params: Station parameters
2881 * Returns: 0 on success, -1 on failure
2883 * This function is used to add or set (params->set 1) a station
2884 * entry in the driver. Adding STA entries is used only if the driver
2885 * does not take care of association processing.
2887 * With drivers that don't support full AP client state, this function
2888 * is used to add a station entry to the driver once the station has
2889 * completed association.
2891 * With TDLS, this function is used to add or set (params->set 1)
2892 * TDLS peer entries (even with drivers that do not support full AP
2895 int (*sta_add
)(void *priv
, struct hostapd_sta_add_params
*params
);
2898 * get_inact_sec - Get station inactivity duration (AP only)
2899 * @priv: Private driver interface data
2900 * @addr: Station address
2901 * Returns: Number of seconds station has been inactive, -1 on failure
2903 int (*get_inact_sec
)(void *priv
, const u8
*addr
);
2906 * sta_clear_stats - Clear station statistics (AP only)
2907 * @priv: Private driver interface data
2908 * @addr: Station address
2909 * Returns: 0 on success, -1 on failure
2911 int (*sta_clear_stats
)(void *priv
, const u8
*addr
);
2914 * set_freq - Set channel/frequency (AP only)
2915 * @priv: Private driver interface data
2916 * @freq: Channel parameters
2917 * Returns: 0 on success, -1 on failure
2919 int (*set_freq
)(void *priv
, struct hostapd_freq_params
*freq
);
2922 * set_rts - Set RTS threshold
2923 * @priv: Private driver interface data
2924 * @rts: RTS threshold in octets
2925 * Returns: 0 on success, -1 on failure
2927 int (*set_rts
)(void *priv
, int rts
);
2930 * set_frag - Set fragmentation threshold
2931 * @priv: Private driver interface data
2932 * @frag: Fragmentation threshold in octets
2933 * Returns: 0 on success, -1 on failure
2935 int (*set_frag
)(void *priv
, int frag
);
2938 * sta_set_flags - Set station flags (AP only)
2939 * @priv: Private driver interface data
2940 * @addr: Station address
2941 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2942 * @flags_or: Bitmap of WPA_STA_* flags to add
2943 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2944 * Returns: 0 on success, -1 on failure
2946 int (*sta_set_flags
)(void *priv
, const u8
*addr
,
2947 unsigned int total_flags
, unsigned int flags_or
,
2948 unsigned int flags_and
);
2951 * sta_set_airtime_weight - Set station airtime weight (AP only)
2952 * @priv: Private driver interface data
2953 * @addr: Station address
2954 * @weight: New weight for station airtime assignment
2955 * Returns: 0 on success, -1 on failure
2957 int (*sta_set_airtime_weight
)(void *priv
, const u8
*addr
,
2958 unsigned int weight
);
2961 * set_tx_queue_params - Set TX queue parameters
2962 * @priv: Private driver interface data
2963 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2967 * @burst_time: Maximum length for bursting in 0.1 msec units
2969 int (*set_tx_queue_params
)(void *priv
, int queue
, int aifs
, int cw_min
,
2970 int cw_max
, int burst_time
);
2973 * if_add - Add a virtual interface
2974 * @priv: Private driver interface data
2975 * @type: Interface type
2976 * @ifname: Interface name for the new virtual interface
2977 * @addr: Local address to use for the interface or %NULL to use the
2978 * parent interface address
2979 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2980 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2981 * not allowed (applies only to %WPA_IF_AP_BSS type)
2982 * @force_ifname: Buffer for returning an interface name that the
2983 * driver ended up using if it differs from the requested ifname
2984 * @if_addr: Buffer for returning the allocated interface address
2985 * (this may differ from the requested addr if the driver cannot
2986 * change interface address)
2987 * @bridge: Bridge interface to use or %NULL if no bridge configured
2988 * @use_existing: Whether to allow existing interface to be used
2989 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
2990 * Returns: 0 on success, -1 on failure
2992 int (*if_add
)(void *priv
, enum wpa_driver_if_type type
,
2993 const char *ifname
, const u8
*addr
, void *bss_ctx
,
2994 void **drv_priv
, char *force_ifname
, u8
*if_addr
,
2995 const char *bridge
, int use_existing
, int setup_ap
);
2998 * if_remove - Remove a virtual interface
2999 * @priv: Private driver interface data
3000 * @type: Interface type
3001 * @ifname: Interface name of the virtual interface to be removed
3002 * Returns: 0 on success, -1 on failure
3004 int (*if_remove
)(void *priv
, enum wpa_driver_if_type type
,
3005 const char *ifname
);
3008 * set_sta_vlan - Bind a station into a specific interface (AP only)
3009 * @priv: Private driver interface data
3010 * @ifname: Interface (main or virtual BSS or VLAN)
3011 * @addr: MAC address of the associated station
3013 * Returns: 0 on success, -1 on failure
3015 * This function is used to bind a station to a specific virtual
3016 * interface. It is only used if when virtual interfaces are supported,
3017 * e.g., to assign stations to different VLAN interfaces based on
3018 * information from a RADIUS server. This allows separate broadcast
3019 * domains to be used with a single BSS.
3021 int (*set_sta_vlan
)(void *priv
, const u8
*addr
, const char *ifname
,
3025 * commit - Optional commit changes handler (AP only)
3026 * @priv: driver private data
3027 * Returns: 0 on success, -1 on failure
3029 * This optional handler function can be registered if the driver
3030 * interface implementation needs to commit changes (e.g., by setting
3031 * network interface up) at the end of initial configuration. If set,
3032 * this handler will be called after initial setup has been completed.
3034 int (*commit
)(void *priv
);
3037 * send_ether - Send an ethernet packet (AP only)
3038 * @priv: private driver interface data
3039 * @dst: Destination MAC address
3040 * @src: Source MAC address
3042 * @data: EAPOL packet starting with IEEE 802.1X header
3043 * @data_len: Length of the EAPOL packet in octets
3044 * Returns: 0 on success, -1 on failure
3046 int (*send_ether
)(void *priv
, const u8
*dst
, const u8
*src
, u16 proto
,
3047 const u8
*data
, size_t data_len
);
3050 * set_radius_acl_auth - Notification of RADIUS ACL change
3051 * @priv: Private driver interface data
3052 * @mac: MAC address of the station
3053 * @accepted: Whether the station was accepted
3054 * @session_timeout: Session timeout for the station
3055 * Returns: 0 on success, -1 on failure
3057 int (*set_radius_acl_auth
)(void *priv
, const u8
*mac
, int accepted
,
3058 u32 session_timeout
);
3061 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3062 * @priv: Private driver interface data
3063 * @mac: MAC address of the station
3064 * Returns: 0 on success, -1 on failure
3066 int (*set_radius_acl_expire
)(void *priv
, const u8
*mac
);
3069 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
3070 * @priv: Private driver interface data
3071 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3072 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3074 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3075 * to remove extra IE(s)
3076 * Returns: 0 on success, -1 on failure
3078 * This is an optional function to add WPS IE in the kernel driver for
3079 * Beacon and Probe Response frames. This can be left undefined (set
3080 * to %NULL) if the driver uses the Beacon template from set_ap()
3081 * and does not process Probe Request frames. If the driver takes care
3082 * of (Re)Association frame processing, the assocresp buffer includes
3083 * WPS IE(s) that need to be added to (Re)Association Response frames
3084 * whenever a (Re)Association Request frame indicated use of WPS.
3086 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3087 * frames when operating as a GO. The driver is responsible for adding
3088 * timing related attributes (e.g., NoA) in addition to the IEs
3089 * included here by appending them after these buffers. This call is
3090 * also used to provide Probe Response IEs for P2P Listen state
3091 * operations for drivers that generate the Probe Response frames
3094 * DEPRECATED - use set_ap() instead
3096 int (*set_ap_wps_ie
)(void *priv
, const struct wpabuf
*beacon
,
3097 const struct wpabuf
*proberesp
,
3098 const struct wpabuf
*assocresp
);
3101 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3102 * @priv: Private driver interface data
3103 * @authorized: Whether the port is authorized
3104 * Returns: 0 on success, -1 on failure
3106 int (*set_supp_port
)(void *priv
, int authorized
);
3109 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3110 * @priv: Private driver interface data
3111 * @addr: MAC address of the associated station
3112 * @aid: Association ID
3113 * @val: 1 = bind to 4-address WDS; 0 = unbind
3114 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3115 * to indicate that bridge is not to be used
3116 * @ifname_wds: Buffer to return the interface name for the new WDS
3117 * station or %NULL to indicate name is not returned.
3118 * Returns: 0 on success, -1 on failure
3120 int (*set_wds_sta
)(void *priv
, const u8
*addr
, int aid
, int val
,
3121 const char *bridge_ifname
, char *ifname_wds
);
3124 * send_action - Transmit an Action frame
3125 * @priv: Private driver interface data
3126 * @freq: Frequency (in MHz) of the channel
3127 * @wait: Time to wait off-channel for a response (in ms), or zero
3128 * @dst: Destination MAC address (Address 1)
3129 * @src: Source MAC address (Address 2)
3130 * @bssid: BSSID (Address 3)
3132 * @data_len: data length in octets
3133 @ @no_cck: Whether CCK rates must not be used to transmit this frame
3134 * Returns: 0 on success, -1 on failure
3136 * This command can be used to request the driver to transmit an action
3137 * frame to the specified destination.
3139 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3140 * be transmitted on the given channel and the device will wait for a
3141 * response on that channel for the given wait time.
3143 * If the flag is not set, the wait time will be ignored. In this case,
3144 * if a remain-on-channel duration is in progress, the frame must be
3145 * transmitted on that channel; alternatively the frame may be sent on
3146 * the current operational channel (if in associated state in station
3147 * mode or while operating as an AP.)
3149 * If @src differs from the device MAC address, use of a random
3150 * transmitter address is requested for this message exchange.
3152 int (*send_action
)(void *priv
, unsigned int freq
, unsigned int wait
,
3153 const u8
*dst
, const u8
*src
, const u8
*bssid
,
3154 const u8
*data
, size_t data_len
, int no_cck
);
3157 * send_action_cancel_wait - Cancel action frame TX wait
3158 * @priv: Private driver interface data
3160 * This command cancels the wait time associated with sending an action
3161 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3162 * set in the driver flags.
3164 void (*send_action_cancel_wait
)(void *priv
);
3167 * remain_on_channel - Remain awake on a channel
3168 * @priv: Private driver interface data
3169 * @freq: Frequency (in MHz) of the channel
3170 * @duration: Duration in milliseconds
3171 * Returns: 0 on success, -1 on failure
3173 * This command is used to request the driver to remain awake on the
3174 * specified channel for the specified duration and report received
3175 * Action frames with EVENT_RX_MGMT events. Optionally, received
3176 * Probe Request frames may also be requested to be reported by calling
3177 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3179 * The driver may not be at the requested channel when this function
3180 * returns, i.e., the return code is only indicating whether the
3181 * request was accepted. The caller will need to wait until the
3182 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3183 * completed the channel change. This may take some time due to other
3184 * need for the radio and the caller should be prepared to timing out
3185 * its wait since there are no guarantees on when this request can be
3188 int (*remain_on_channel
)(void *priv
, unsigned int freq
,
3189 unsigned int duration
);
3192 * cancel_remain_on_channel - Cancel remain-on-channel operation
3193 * @priv: Private driver interface data
3195 * This command can be used to cancel a remain-on-channel operation
3196 * before its originally requested duration has passed. This could be
3197 * used, e.g., when remain_on_channel() is used to request extra time
3198 * to receive a response to an Action frame and the response is
3199 * received when there is still unneeded time remaining on the
3200 * remain-on-channel operation.
3202 int (*cancel_remain_on_channel
)(void *priv
);
3205 * probe_req_report - Request Probe Request frames to be indicated
3206 * @priv: Private driver interface data
3207 * @report: Whether to report received Probe Request frames
3208 * Returns: 0 on success, -1 on failure (or if not supported)
3210 * This command can be used to request the driver to indicate when
3211 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3212 * Since this operation may require extra resources, e.g., due to less
3213 * optimal hardware/firmware RX filtering, many drivers may disable
3214 * Probe Request reporting at least in station mode. This command is
3215 * used to notify the driver when the Probe Request frames need to be
3216 * reported, e.g., during remain-on-channel operations.
3218 int (*probe_req_report
)(void *priv
, int report
);
3221 * deinit_ap - Deinitialize AP mode
3222 * @priv: Private driver interface data
3223 * Returns: 0 on success, -1 on failure (or if not supported)
3225 * This optional function can be used to disable AP mode related
3226 * configuration. If the interface was not dynamically added,
3227 * change the driver mode to station mode to allow normal station
3228 * operations like scanning to be completed.
3230 int (*deinit_ap
)(void *priv
);
3233 * deinit_p2p_cli - Deinitialize P2P client mode
3234 * @priv: Private driver interface data
3235 * Returns: 0 on success, -1 on failure (or if not supported)
3237 * This optional function can be used to disable P2P client mode. If the
3238 * interface was not dynamically added, change the interface type back
3241 int (*deinit_p2p_cli
)(void *priv
);
3244 * suspend - Notification on system suspend/hibernate event
3245 * @priv: Private driver interface data
3247 void (*suspend
)(void *priv
);
3250 * resume - Notification on system resume/thaw event
3251 * @priv: Private driver interface data
3253 void (*resume
)(void *priv
);
3256 * signal_monitor - Set signal monitoring parameters
3257 * @priv: Private driver interface data
3258 * @threshold: Threshold value for signal change events; 0 = disabled
3259 * @hysteresis: Minimum change in signal strength before indicating a
3261 * Returns: 0 on success, -1 on failure (or if not supported)
3263 * This function can be used to configure monitoring of signal strength
3264 * with the current AP. Whenever signal strength drops below the
3265 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3266 * should be generated assuming the signal strength has changed at
3267 * least %hysteresis from the previously indicated signal change event.
3269 int (*signal_monitor
)(void *priv
, int threshold
, int hysteresis
);
3272 * send_frame - Send IEEE 802.11 frame (testing use only)
3273 * @priv: Private driver interface data
3274 * @data: IEEE 802.11 frame with IEEE 802.11 header
3275 * @data_len: Size of the frame
3276 * @encrypt: Whether to encrypt the frame (if keys are set)
3277 * Returns: 0 on success, -1 on failure
3279 * This function is only used for debugging purposes and is not
3280 * required to be implemented for normal operations.
3282 int (*send_frame
)(void *priv
, const u8
*data
, size_t data_len
,
3286 * get_noa - Get current Notice of Absence attribute payload
3287 * @priv: Private driver interface data
3288 * @buf: Buffer for returning NoA
3289 * @buf_len: Buffer length in octets
3290 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3291 * advertized, or -1 on failure
3293 * This function is used to fetch the current Notice of Absence
3294 * attribute value from GO.
3296 int (*get_noa
)(void *priv
, u8
*buf
, size_t buf_len
);
3299 * set_noa - Set Notice of Absence parameters for GO (testing)
3300 * @priv: Private driver interface data
3302 * @start: Start time in ms from next TBTT
3303 * @duration: Duration in ms
3304 * Returns: 0 on success or -1 on failure
3306 * This function is used to set Notice of Absence parameters for GO. It
3307 * is used only for testing. To disable NoA, all parameters are set to
3310 int (*set_noa
)(void *priv
, u8 count
, int start
, int duration
);
3313 * set_p2p_powersave - Set P2P power save options
3314 * @priv: Private driver interface data
3315 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3316 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3317 * @ctwindow: 0.. = change (msec), -1 = no change
3318 * Returns: 0 on success or -1 on failure
3320 int (*set_p2p_powersave
)(void *priv
, int legacy_ps
, int opp_ps
,
3324 * ampdu - Enable/disable aggregation
3325 * @priv: Private driver interface data
3326 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3327 * Returns: 0 on success or -1 on failure
3329 int (*ampdu
)(void *priv
, int ampdu
);
3332 * get_radio_name - Get physical radio name for the device
3333 * @priv: Private driver interface data
3334 * Returns: Radio name or %NULL if not known
3336 * The returned data must not be modified by the caller. It is assumed
3337 * that any interface that has the same radio name as another is
3338 * sharing the same physical radio. This information can be used to
3339 * share scan results etc. information between the virtual interfaces
3340 * to speed up various operations.
3342 const char * (*get_radio_name
)(void *priv
);
3345 * send_tdls_mgmt - for sending TDLS management packets
3346 * @priv: private driver interface data
3347 * @dst: Destination (peer) MAC address
3348 * @action_code: TDLS action code for the mssage
3349 * @dialog_token: Dialog Token to use in the message (if needed)
3350 * @status_code: Status Code or Reason Code to use (if needed)
3351 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
3352 * @initiator: Is the current end the TDLS link initiator
3353 * @buf: TDLS IEs to add to the message
3354 * @len: Length of buf in octets
3355 * Returns: 0 on success, negative (<0) on failure
3357 * This optional function can be used to send packet to driver which is
3358 * responsible for receiving and sending all TDLS packets.
3360 int (*send_tdls_mgmt
)(void *priv
, const u8
*dst
, u8 action_code
,
3361 u8 dialog_token
, u16 status_code
, u32 peer_capab
,
3362 int initiator
, const u8
*buf
, size_t len
);
3365 * tdls_oper - Ask the driver to perform high-level TDLS operations
3366 * @priv: Private driver interface data
3367 * @oper: TDLS high-level operation. See %enum tdls_oper
3368 * @peer: Destination (peer) MAC address
3369 * Returns: 0 on success, negative (<0) on failure
3371 * This optional function can be used to send high-level TDLS commands
3374 int (*tdls_oper
)(void *priv
, enum tdls_oper oper
, const u8
*peer
);
3377 * wnm_oper - Notify driver of the WNM frame reception
3378 * @priv: Private driver interface data
3379 * @oper: WNM operation. See %enum wnm_oper
3380 * @peer: Destination (peer) MAC address
3381 * @buf: Buffer for the driver to fill in (for getting IE)
3382 * @buf_len: Return the len of buf
3383 * Returns: 0 on success, negative (<0) on failure
3385 int (*wnm_oper
)(void *priv
, enum wnm_oper oper
, const u8
*peer
,
3386 u8
*buf
, u16
*buf_len
);
3389 * set_qos_map - Set QoS Map
3390 * @priv: Private driver interface data
3391 * @qos_map_set: QoS Map
3392 * @qos_map_set_len: Length of QoS Map
3394 int (*set_qos_map
)(void *priv
, const u8
*qos_map_set
,
3395 u8 qos_map_set_len
);
3398 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3399 * @priv: Private driver interface data
3400 * @version: IP version of the IP address, 4 or 6
3401 * @ipaddr: IP address for the neigh entry
3402 * @prefixlen: IP address prefix length
3403 * @addr: Corresponding MAC address
3404 * Returns: 0 on success, negative (<0) on failure
3406 int (*br_add_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
,
3407 int prefixlen
, const u8
*addr
);
3410 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3411 * @priv: Private driver interface data
3412 * @version: IP version of the IP address, 4 or 6
3413 * @ipaddr: IP address for the neigh entry
3414 * Returns: 0 on success, negative (<0) on failure
3416 int (*br_delete_ip_neigh
)(void *priv
, u8 version
, const u8
*ipaddr
);
3419 * br_port_set_attr - Set a bridge port attribute
3420 * @attr: Bridge port attribute to set
3421 * @val: Value to be set
3422 * Returns: 0 on success, negative (<0) on failure
3424 int (*br_port_set_attr
)(void *priv
, enum drv_br_port_attr attr
,
3428 * br_port_set_attr - Set a bridge network parameter
3429 * @param: Bridge parameter to set
3430 * @val: Value to be set
3431 * Returns: 0 on success, negative (<0) on failure
3433 int (*br_set_net_param
)(void *priv
, enum drv_br_net_param param
,
3437 * set_wowlan - Set wake-on-wireless triggers
3438 * @priv: Private driver interface data
3439 * @triggers: wowlan triggers
3441 int (*set_wowlan
)(void *priv
, const struct wowlan_triggers
*triggers
);
3444 * signal_poll - Get current connection information
3445 * @priv: Private driver interface data
3446 * @signal_info: Connection info structure
3448 int (*signal_poll
)(void *priv
, struct wpa_signal_info
*signal_info
);
3451 * channel_info - Get parameters of the current operating channel
3452 * @priv: Private driver interface data
3453 * @channel_info: Channel info structure
3454 * Returns: 0 on success, negative (<0) on failure
3456 int (*channel_info
)(void *priv
, struct wpa_channel_info
*channel_info
);
3459 * set_authmode - Set authentication algorithm(s) for static WEP
3460 * @priv: Private driver interface data
3461 * @authmode: 1=Open System, 2=Shared Key, 3=both
3462 * Returns: 0 on success, -1 on failure
3464 * This function can be used to set authentication algorithms for AP
3465 * mode when static WEP is used. If the driver uses user space MLME/SME
3466 * implementation, there is no need to implement this function.
3468 * DEPRECATED - use set_ap() instead
3470 int (*set_authmode
)(void *priv
, int authmode
);
3474 * driver_cmd - Execute driver-specific command
3475 * @priv: Private driver interface data
3476 * @cmd: Command to execute
3477 * @buf: Return buffer
3478 * @buf_len: Buffer length
3479 * Returns: 0 on success, -1 on failure
3481 int (*driver_cmd
)(void *priv
, char *cmd
, char *buf
, size_t buf_len
);
3482 #endif /* ANDROID */
3485 * vendor_cmd - Execute vendor specific command
3486 * @priv: Private driver interface data
3487 * @vendor_id: Vendor id
3488 * @subcmd: Vendor command id
3489 * @data: Vendor command parameters (%NULL if no parameters)
3490 * @data_len: Data length
3491 * @buf: Return buffer (%NULL to ignore reply)
3492 * Returns: 0 on success, negative (<0) on failure
3494 * This function handles vendor specific commands that are passed to
3495 * the driver/device. The command is identified by vendor id and
3496 * command id. Parameters can be passed as argument to the command
3497 * in the data buffer. Reply (if any) will be filled in the supplied
3500 * The exact driver behavior is driver interface and vendor specific. As
3501 * an example, this will be converted to a vendor specific cfg80211
3502 * command in case of the nl80211 driver interface.
3504 int (*vendor_cmd
)(void *priv
, unsigned int vendor_id
,
3505 unsigned int subcmd
, const u8
*data
, size_t data_len
,
3506 struct wpabuf
*buf
);
3509 * set_rekey_info - Set rekey information
3510 * @priv: Private driver interface data
3512 * @kek_len: KEK length in octets
3514 * @kck_len: KCK length in octets
3515 * @replay_ctr: Current EAPOL-Key Replay Counter
3517 * This optional function can be used to provide information for the
3518 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3519 * while the host (including wpa_supplicant) is sleeping.
3521 void (*set_rekey_info
)(void *priv
, const u8
*kek
, size_t kek_len
,
3522 const u8
*kck
, size_t kck_len
,
3523 const u8
*replay_ctr
);
3526 * sta_assoc - Station association indication
3527 * @priv: Private driver interface data
3528 * @own_addr: Source address and BSSID for association frame
3529 * @addr: MAC address of the station to associate
3530 * @reassoc: flag to indicate re-association
3531 * @status: association response status code
3532 * @ie: assoc response ie buffer
3533 * @len: ie buffer length
3534 * Returns: 0 on success, -1 on failure
3536 * This function indicates the driver to send (Re)Association
3537 * Response frame to the station.
3539 int (*sta_assoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
3540 int reassoc
, u16 status
, const u8
*ie
, size_t len
);
3543 * sta_auth - Station authentication indication
3544 * @priv: private driver interface data
3545 * @params: Station authentication parameters
3547 * Returns: 0 on success, -1 on failure
3549 int (*sta_auth
)(void *priv
,
3550 struct wpa_driver_sta_auth_params
*params
);
3553 * add_tspec - Add traffic stream
3554 * @priv: Private driver interface data
3555 * @addr: MAC address of the station to associate
3556 * @tspec_ie: tspec ie buffer
3557 * @tspec_ielen: tspec ie length
3558 * Returns: 0 on success, -1 on failure
3560 * This function adds the traffic steam for the station
3561 * and fills the medium_time in tspec_ie.
3563 int (*add_tspec
)(void *priv
, const u8
*addr
, u8
*tspec_ie
,
3564 size_t tspec_ielen
);
3567 * add_sta_node - Add a station node in the driver
3568 * @priv: Private driver interface data
3569 * @addr: MAC address of the station to add
3570 * @auth_alg: authentication algorithm used by the station
3571 * Returns: 0 on success, -1 on failure
3573 * This function adds the station node in the driver, when
3574 * the station gets added by FT-over-DS.
3576 int (*add_sta_node
)(void *priv
, const u8
*addr
, u16 auth_alg
);
3579 * sched_scan - Request the driver to initiate scheduled scan
3580 * @priv: Private driver interface data
3581 * @params: Scan parameters
3582 * Returns: 0 on success, -1 on failure
3584 * This operation should be used for scheduled scan offload to
3585 * the hardware. Every time scan results are available, the
3586 * driver should report scan results event for wpa_supplicant
3587 * which will eventually request the results with
3588 * wpa_driver_get_scan_results2(). This operation is optional
3589 * and if not provided or if it returns -1, we fall back to
3590 * normal host-scheduled scans.
3592 int (*sched_scan
)(void *priv
, struct wpa_driver_scan_params
*params
);
3595 * stop_sched_scan - Request the driver to stop a scheduled scan
3596 * @priv: Private driver interface data
3597 * Returns: 0 on success, -1 on failure
3599 * This should cause the scheduled scan to be stopped and
3600 * results should stop being sent. Must be supported if
3601 * sched_scan is supported.
3603 int (*stop_sched_scan
)(void *priv
);
3606 * poll_client - Probe (null data or such) the given station
3607 * @priv: Private driver interface data
3608 * @own_addr: MAC address of sending interface
3609 * @addr: MAC address of the station to probe
3610 * @qos: Indicates whether station is QoS station
3612 * This function is used to verify whether an associated station is
3613 * still present. This function does not need to be implemented if the
3614 * driver provides such inactivity polling mechanism.
3616 void (*poll_client
)(void *priv
, const u8
*own_addr
,
3617 const u8
*addr
, int qos
);
3620 * radio_disable - Disable/enable radio
3621 * @priv: Private driver interface data
3622 * @disabled: 1=disable 0=enable radio
3623 * Returns: 0 on success, -1 on failure
3625 * This optional command is for testing purposes. It can be used to
3626 * disable the radio on a testbed device to simulate out-of-radio-range
3629 int (*radio_disable
)(void *priv
, int disabled
);
3632 * switch_channel - Announce channel switch and migrate the GO to the
3634 * @priv: Private driver interface data
3635 * @settings: Settings for CSA period and new channel
3636 * Returns: 0 on success, -1 on failure
3638 * This function is used to move the GO to the legacy STA channel to
3639 * avoid frequency conflict in single channel concurrency.
3641 int (*switch_channel
)(void *priv
, struct csa_settings
*settings
);
3644 * add_tx_ts - Add traffic stream
3645 * @priv: Private driver interface data
3646 * @tsid: Traffic stream ID
3647 * @addr: Receiver address
3648 * @user_prio: User priority of the traffic stream
3649 * @admitted_time: Admitted time for this TS in units of
3650 * 32 microsecond periods (per second).
3651 * Returns: 0 on success, -1 on failure
3653 int (*add_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
, u8 user_prio
,
3657 * del_tx_ts - Delete traffic stream
3658 * @priv: Private driver interface data
3659 * @tsid: Traffic stream ID
3660 * @addr: Receiver address
3661 * Returns: 0 on success, -1 on failure
3663 int (*del_tx_ts
)(void *priv
, u8 tsid
, const u8
*addr
);
3666 * Enable channel-switching with TDLS peer
3667 * @priv: Private driver interface data
3668 * @addr: MAC address of the TDLS peer
3669 * @oper_class: Operating class of the switch channel
3670 * @params: Channel specification
3671 * Returns: 0 on success, -1 on failure
3673 * The function indicates to driver that it can start switching to a
3674 * different channel with a specified TDLS peer. The switching is
3675 * assumed on until canceled with tdls_disable_channel_switch().
3677 int (*tdls_enable_channel_switch
)(
3678 void *priv
, const u8
*addr
, u8 oper_class
,
3679 const struct hostapd_freq_params
*params
);
3682 * Disable channel switching with TDLS peer
3683 * @priv: Private driver interface data
3684 * @addr: MAC address of the TDLS peer
3685 * Returns: 0 on success, -1 on failure
3687 * This function indicates to the driver that it should stop switching
3688 * with a given TDLS peer.
3690 int (*tdls_disable_channel_switch
)(void *priv
, const u8
*addr
);
3693 * start_dfs_cac - Listen for radar interference on the channel
3694 * @priv: Private driver interface data
3695 * @freq: Channel parameters
3696 * Returns: 0 on success, -1 on failure
3698 int (*start_dfs_cac
)(void *priv
, struct hostapd_freq_params
*freq
);
3701 * stop_ap - Removes beacon from AP
3702 * @priv: Private driver interface data
3703 * Returns: 0 on success, -1 on failure (or if not supported)
3705 * This optional function can be used to disable AP mode related
3706 * configuration. Unlike deinit_ap, it does not change to station
3709 int (*stop_ap
)(void *priv
);
3712 * get_survey - Retrieve survey data
3713 * @priv: Private driver interface data
3714 * @freq: If set, survey data for the specified frequency is only
3715 * being requested. If not set, all survey data is requested.
3716 * Returns: 0 on success, -1 on failure
3718 * Use this to retrieve:
3720 * - the observed channel noise floor
3721 * - the amount of time we have spent on the channel
3722 * - the amount of time during which we have spent on the channel that
3723 * the radio has determined the medium is busy and we cannot
3725 * - the amount of time we have spent receiving data
3726 * - the amount of time we have spent transmitting data
3728 * This data can be used for spectrum heuristics. One example is
3729 * Automatic Channel Selection (ACS). The channel survey data is
3730 * kept on a linked list on the channel data, one entry is added
3731 * for each survey. The min_nf of the channel is updated for each
3734 int (*get_survey
)(void *priv
, unsigned int freq
);
3737 * status - Get driver interface status information
3738 * @priv: Private driver interface data
3739 * @buf: Buffer for printing the status information
3740 * @buflen: Maximum length of the buffer
3741 * Returns: Length of written status information or -1 on failure
3743 int (*status
)(void *priv
, char *buf
, size_t buflen
);
3746 * roaming - Set roaming policy for driver-based BSS selection
3747 * @priv: Private driver interface data
3748 * @allowed: Whether roaming within ESS is allowed
3749 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3750 * Returns: Length of written status information or -1 on failure
3752 * This optional callback can be used to update roaming policy from the
3753 * associate() command (bssid being set there indicates that the driver
3754 * should not roam before getting this roaming() call to allow roaming.
3755 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3756 * capability, roaming policy is handled within wpa_supplicant and there
3757 * is no need to implement or react to this callback.
3759 int (*roaming
)(void *priv
, int allowed
, const u8
*bssid
);
3762 * disable_fils - Enable/disable FILS feature
3763 * @priv: Private driver interface data
3764 * @disable: 0-enable and 1-disable FILS feature
3765 * Returns: 0 on success, -1 on failure
3767 * This callback can be used to configure driver and below layers to
3768 * enable/disable all FILS features.
3770 int (*disable_fils
)(void *priv
, int disable
);
3773 * set_mac_addr - Set MAC address
3774 * @priv: Private driver interface data
3775 * @addr: MAC address to use or %NULL for setting back to permanent
3776 * Returns: 0 on success, -1 on failure
3778 int (*set_mac_addr
)(void *priv
, const u8
*addr
);
3780 #ifdef CONFIG_MACSEC
3781 int (*macsec_init
)(void *priv
, struct macsec_init_params
*params
);
3783 int (*macsec_deinit
)(void *priv
);
3786 * macsec_get_capability - Inform MKA of this driver's capability
3787 * @priv: Private driver interface data
3788 * @cap: Driver's capability
3789 * Returns: 0 on success, -1 on failure
3791 int (*macsec_get_capability
)(void *priv
, enum macsec_cap
*cap
);
3794 * enable_protect_frames - Set protect frames status
3795 * @priv: Private driver interface data
3796 * @enabled: TRUE = protect frames enabled
3797 * FALSE = protect frames disabled
3798 * Returns: 0 on success, -1 on failure (or if not supported)
3800 int (*enable_protect_frames
)(void *priv
, Boolean enabled
);
3803 * enable_encrypt - Set encryption status
3804 * @priv: Private driver interface data
3805 * @enabled: TRUE = encrypt outgoing traffic
3806 * FALSE = integrity-only protection on outgoing traffic
3807 * Returns: 0 on success, -1 on failure (or if not supported)
3809 int (*enable_encrypt
)(void *priv
, Boolean enabled
);
3812 * set_replay_protect - Set replay protect status and window size
3813 * @priv: Private driver interface data
3814 * @enabled: TRUE = replay protect enabled
3815 * FALSE = replay protect disabled
3816 * @window: replay window size, valid only when replay protect enabled
3817 * Returns: 0 on success, -1 on failure (or if not supported)
3819 int (*set_replay_protect
)(void *priv
, Boolean enabled
, u32 window
);
3822 * set_current_cipher_suite - Set current cipher suite
3823 * @priv: Private driver interface data
3824 * @cs: EUI64 identifier
3825 * Returns: 0 on success, -1 on failure (or if not supported)
3827 int (*set_current_cipher_suite
)(void *priv
, u64 cs
);
3830 * enable_controlled_port - Set controlled port status
3831 * @priv: Private driver interface data
3832 * @enabled: TRUE = controlled port enabled
3833 * FALSE = controlled port disabled
3834 * Returns: 0 on success, -1 on failure (or if not supported)
3836 int (*enable_controlled_port
)(void *priv
, Boolean enabled
);
3839 * get_receive_lowest_pn - Get receive lowest pn
3840 * @priv: Private driver interface data
3841 * @sa: secure association
3842 * Returns: 0 on success, -1 on failure (or if not supported)
3844 int (*get_receive_lowest_pn
)(void *priv
, struct receive_sa
*sa
);
3847 * get_transmit_next_pn - Get transmit next pn
3848 * @priv: Private driver interface data
3849 * @sa: secure association
3850 * Returns: 0 on success, -1 on failure (or if not supported)
3852 int (*get_transmit_next_pn
)(void *priv
, struct transmit_sa
*sa
);
3855 * set_transmit_next_pn - Set transmit next pn
3856 * @priv: Private driver interface data
3857 * @sa: secure association
3858 * Returns: 0 on success, -1 on failure (or if not supported)
3860 int (*set_transmit_next_pn
)(void *priv
, struct transmit_sa
*sa
);
3863 * set_receive_lowest_pn - Set receive lowest PN
3864 * @priv: Private driver interface data
3865 * @sa: secure association
3866 * Returns: 0 on success, -1 on failure (or if not supported)
3868 int (*set_receive_lowest_pn
)(void *priv
, struct receive_sa
*sa
);
3871 * create_receive_sc - create secure channel for receiving
3872 * @priv: Private driver interface data
3873 * @sc: secure channel
3874 * @conf_offset: confidentiality offset (0, 30, or 50)
3875 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3877 * Returns: 0 on success, -1 on failure (or if not supported)
3879 int (*create_receive_sc
)(void *priv
, struct receive_sc
*sc
,
3880 unsigned int conf_offset
,
3884 * delete_receive_sc - delete secure connection for receiving
3885 * @priv: private driver interface data from init()
3886 * @sc: secure channel
3887 * Returns: 0 on success, -1 on failure
3889 int (*delete_receive_sc
)(void *priv
, struct receive_sc
*sc
);
3892 * create_receive_sa - create secure association for receive
3893 * @priv: private driver interface data from init()
3894 * @sa: secure association
3895 * Returns: 0 on success, -1 on failure
3897 int (*create_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3900 * delete_receive_sa - Delete secure association for receive
3901 * @priv: Private driver interface data from init()
3902 * @sa: Secure association
3903 * Returns: 0 on success, -1 on failure
3905 int (*delete_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3908 * enable_receive_sa - enable the SA for receive
3909 * @priv: private driver interface data from init()
3910 * @sa: secure association
3911 * Returns: 0 on success, -1 on failure
3913 int (*enable_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3916 * disable_receive_sa - disable SA for receive
3917 * @priv: private driver interface data from init()
3918 * @sa: secure association
3919 * Returns: 0 on success, -1 on failure
3921 int (*disable_receive_sa
)(void *priv
, struct receive_sa
*sa
);
3924 * create_transmit_sc - create secure connection for transmit
3925 * @priv: private driver interface data from init()
3926 * @sc: secure channel
3927 * @conf_offset: confidentiality offset (0, 30, or 50)
3928 * Returns: 0 on success, -1 on failure
3930 int (*create_transmit_sc
)(void *priv
, struct transmit_sc
*sc
,
3931 unsigned int conf_offset
);
3934 * delete_transmit_sc - delete secure connection for transmit
3935 * @priv: private driver interface data from init()
3936 * @sc: secure channel
3937 * Returns: 0 on success, -1 on failure
3939 int (*delete_transmit_sc
)(void *priv
, struct transmit_sc
*sc
);
3942 * create_transmit_sa - create secure association for transmit
3943 * @priv: private driver interface data from init()
3944 * @sa: secure association
3945 * Returns: 0 on success, -1 on failure
3947 int (*create_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
3950 * delete_transmit_sa - Delete secure association for transmit
3951 * @priv: Private driver interface data from init()
3952 * @sa: Secure association
3953 * Returns: 0 on success, -1 on failure
3955 int (*delete_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
3958 * enable_transmit_sa - enable SA for transmit
3959 * @priv: private driver interface data from init()
3960 * @sa: secure association
3961 * Returns: 0 on success, -1 on failure
3963 int (*enable_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
3966 * disable_transmit_sa - disable SA for transmit
3967 * @priv: private driver interface data from init()
3968 * @sa: secure association
3969 * Returns: 0 on success, -1 on failure
3971 int (*disable_transmit_sa
)(void *priv
, struct transmit_sa
*sa
);
3972 #endif /* CONFIG_MACSEC */
3975 * init_mesh - Driver specific initialization for mesh
3976 * @priv: Private driver interface data
3977 * Returns: 0 on success, -1 on failure
3979 int (*init_mesh
)(void *priv
);
3982 * join_mesh - Join a mesh network
3983 * @priv: Private driver interface data
3984 * @params: Mesh configuration parameters
3985 * Returns: 0 on success, -1 on failure
3987 int (*join_mesh
)(void *priv
,
3988 struct wpa_driver_mesh_join_params
*params
);
3991 * leave_mesh - Leave a mesh network
3992 * @priv: Private driver interface data
3993 * Returns 0 on success, -1 on failure
3995 int (*leave_mesh
)(void *priv
);
3998 * do_acs - Automatically select channel
3999 * @priv: Private driver interface data
4000 * @params: Parameters for ACS
4001 * Returns 0 on success, -1 on failure
4003 * This command can be used to offload ACS to the driver if the driver
4004 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
4006 int (*do_acs
)(void *priv
, struct drv_acs_params
*params
);
4009 * set_band - Notify driver of band selection
4010 * @priv: Private driver interface data
4011 * @band: The selected band(s)
4012 * Returns 0 on success, -1 on failure
4014 int (*set_band
)(void *priv
, enum set_band band
);
4017 * get_pref_freq_list - Get preferred frequency list for an interface
4018 * @priv: Private driver interface data
4019 * @if_type: Interface type
4020 * @num: Number of channels
4021 * @freq_list: Preferred channel frequency list encoded in MHz values
4022 * Returns 0 on success, -1 on failure
4024 * This command can be used to query the preferred frequency list from
4025 * the driver specific to a particular interface type.
4027 int (*get_pref_freq_list
)(void *priv
, enum wpa_driver_if_type if_type
,
4028 unsigned int *num
, unsigned int *freq_list
);
4031 * set_prob_oper_freq - Indicate probable P2P operating channel
4032 * @priv: Private driver interface data
4033 * @freq: Channel frequency in MHz
4034 * Returns 0 on success, -1 on failure
4036 * This command can be used to inform the driver of the operating
4037 * frequency that an ongoing P2P group formation is likely to come up
4038 * on. Local device is assuming P2P Client role.
4040 int (*set_prob_oper_freq
)(void *priv
, unsigned int freq
);
4043 * abort_scan - Request the driver to abort an ongoing scan
4044 * @priv: Private driver interface data
4045 * @scan_cookie: Cookie identifying the scan request. This is used only
4046 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4047 * was used to trigger scan. Otherwise, 0 is used.
4048 * Returns 0 on success, -1 on failure
4050 int (*abort_scan
)(void *priv
, u64 scan_cookie
);
4053 * configure_data_frame_filters - Request to configure frame filters
4054 * @priv: Private driver interface data
4055 * @filter_flags: The type of frames to filter (bitfield of
4056 * WPA_DATA_FRAME_FILTER_FLAG_*)
4057 * Returns: 0 on success or -1 on failure
4059 int (*configure_data_frame_filters
)(void *priv
, u32 filter_flags
);
4062 * get_ext_capab - Get extended capabilities for the specified interface
4063 * @priv: Private driver interface data
4064 * @type: Interface type for which to get extended capabilities
4065 * @ext_capab: Extended capabilities fetched
4066 * @ext_capab_mask: Extended capabilities mask
4067 * @ext_capab_len: Length of the extended capabilities
4068 * Returns: 0 on success or -1 on failure
4070 int (*get_ext_capab
)(void *priv
, enum wpa_driver_if_type type
,
4071 const u8
**ext_capab
, const u8
**ext_capab_mask
,
4072 unsigned int *ext_capab_len
);
4075 * p2p_lo_start - Start offloading P2P listen to device
4076 * @priv: Private driver interface data
4077 * @freq: Listening frequency (MHz) for P2P listen
4078 * @period: Length of the listen operation in milliseconds
4079 * @interval: Interval for running the listen operation in milliseconds
4080 * @count: Number of times to run the listen operation
4081 * @device_types: Device primary and secondary types
4082 * @dev_types_len: Number of bytes for device_types
4083 * @ies: P2P IE and WSC IE for Probe Response frames
4084 * @ies_len: Length of ies in bytes
4085 * Returns: 0 on success or -1 on failure
4087 int (*p2p_lo_start
)(void *priv
, unsigned int freq
,
4088 unsigned int period
, unsigned int interval
,
4090 const u8
*device_types
, size_t dev_types_len
,
4091 const u8
*ies
, size_t ies_len
);
4094 * p2p_lo_stop - Stop P2P listen offload
4095 * @priv: Private driver interface data
4096 * Returns: 0 on success or -1 on failure
4098 int (*p2p_lo_stop
)(void *priv
);
4101 * set_default_scan_ies - Set default scan IEs
4102 * @priv: Private driver interface data
4103 * @ies: Scan default IEs buffer
4104 * @ies_len: Length of IEs in bytes
4105 * Returns: 0 on success or -1 on failure
4107 * The driver can use these by default when there are no scan IEs coming
4108 * in the subsequent scan requests. Also in case of one or more of IEs
4109 * given in set_default_scan_ies() are missing in the subsequent scan
4110 * request, the driver should merge the missing scan IEs in the scan
4111 * request from the IEs set by set_default_scan_ies() in the Probe
4112 * Request frames sent.
4114 int (*set_default_scan_ies
)(void *priv
, const u8
*ies
, size_t ies_len
);
4117 * set_tdls_mode - Set TDLS trigger mode to the host driver
4118 * @priv: Private driver interface data
4119 * @tdls_external_control: Represents if TDLS external trigger control
4120 * mode is enabled/disabled.
4122 * This optional callback can be used to configure the TDLS external
4123 * trigger control mode to the host driver.
4125 int (*set_tdls_mode
)(void *priv
, int tdls_external_control
);
4128 * get_bss_transition_status - Get candidate BSS's transition status
4129 * @priv: Private driver interface data
4130 * @params: Candidate BSS list
4132 * Get the accept or reject reason code for a list of BSS transition
4135 struct wpa_bss_candidate_info
*
4136 (*get_bss_transition_status
)(void *priv
,
4137 struct wpa_bss_trans_info
*params
);
4139 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
4140 * @priv: Private driver interface data
4141 * @ignore_disallow: 0 to not ignore, 1 to ignore
4142 * Returns: 0 on success, -1 on failure
4144 int (*ignore_assoc_disallow
)(void *priv
, int ignore_disallow
);
4147 * set_bssid_blacklist - Set blacklist of BSSIDs to the driver
4148 * @priv: Private driver interface data
4149 * @num_bssid: Number of blacklist BSSIDs
4150 * @bssids: List of blacklisted BSSIDs
4152 int (*set_bssid_blacklist
)(void *priv
, unsigned int num_bssid
,
4156 * update_connect_params - Update the connection parameters
4157 * @priv: Private driver interface data
4158 * @params: Association parameters
4159 * @mask: Bit mask indicating which parameters in @params have to be
4161 * Returns: 0 on success, -1 on failure
4163 * Update the connection parameters when in connected state so that the
4164 * driver uses the updated parameters for subsequent roaming. This is
4165 * used only with drivers that implement internal BSS selection and
4168 int (*update_connect_params
)(
4169 void *priv
, struct wpa_driver_associate_params
*params
,
4170 enum wpa_drv_update_connect_params_mask mask
);
4173 * send_external_auth_status - Indicate the status of external
4174 * authentication processing to the host driver.
4175 * @priv: Private driver interface data
4176 * @params: Status of authentication processing.
4177 * Returns: 0 on success, -1 on failure
4179 int (*send_external_auth_status
)(void *priv
,
4180 struct external_auth
*params
);
4183 * set_4addr_mode - Set 4-address mode
4184 * @priv: Private driver interface data
4185 * @bridge_ifname: Bridge interface name
4186 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
4187 * Returns: 0 on success, < 0 on failure
4189 int (*set_4addr_mode
)(void *priv
, const char *bridge_ifname
, int val
);
4193 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
4195 enum wpa_event_type
{
4197 * EVENT_ASSOC - Association completed
4199 * This event needs to be delivered when the driver completes IEEE
4200 * 802.11 association or reassociation successfully.
4201 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
4202 * after this event has been generated. In addition, optional
4203 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
4204 * more information about the association. If the driver interface gets
4205 * both of these events at the same time, it can also include the
4206 * assoc_info data in EVENT_ASSOC call.
4211 * EVENT_DISASSOC - Association lost
4213 * This event should be called when association is lost either due to
4214 * receiving deauthenticate or disassociate frame from the AP or when
4215 * sending either of these frames to the current AP. If the driver
4216 * supports separate deauthentication event, EVENT_DISASSOC should only
4217 * be used for disassociation and EVENT_DEAUTH for deauthentication.
4218 * In AP mode, union wpa_event_data::disassoc_info is required.
4223 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
4225 * This event must be delivered when a Michael MIC error is detected by
4226 * the local driver. Additional data for event processing is
4227 * provided with union wpa_event_data::michael_mic_failure. This
4228 * information is used to request new encyption key and to initiate
4229 * TKIP countermeasures if needed.
4231 EVENT_MICHAEL_MIC_FAILURE
,
4234 * EVENT_SCAN_RESULTS - Scan results available
4236 * This event must be called whenever scan results are available to be
4237 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4238 * is expected to be used some time after struct wpa_driver_ops::scan()
4239 * is called. If the driver provides an unsolicited event when the scan
4240 * has been completed, this event can be used to trigger
4241 * EVENT_SCAN_RESULTS call. If such event is not available from the
4242 * driver, the driver wrapper code is expected to use a registered
4243 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
4244 * scan is expected to be completed. Optional information about
4245 * completed scan can be provided with union wpa_event_data::scan_info.
4250 * EVENT_ASSOCINFO - Report optional extra information for association
4252 * This event can be used to report extra association information for
4253 * EVENT_ASSOC processing. This extra information includes IEs from
4254 * association frames and Beacon/Probe Response frames in union
4255 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4256 * EVENT_ASSOC. Alternatively, the driver interface can include
4257 * assoc_info data in the EVENT_ASSOC call if it has all the
4258 * information available at the same point.
4263 * EVENT_INTERFACE_STATUS - Report interface status changes
4265 * This optional event can be used to report changes in interface
4266 * status (interface added/removed) using union
4267 * wpa_event_data::interface_status. This can be used to trigger
4268 * wpa_supplicant to stop and re-start processing for the interface,
4269 * e.g., when a cardbus card is ejected/inserted.
4271 EVENT_INTERFACE_STATUS
,
4274 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4276 * This event can be used to inform wpa_supplicant about candidates for
4277 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4278 * for scan request (ap_scan=2 mode), this event is required for
4279 * pre-authentication. If wpa_supplicant is performing scan request
4280 * (ap_scan=1), this event is optional since scan results can be used
4281 * to add pre-authentication candidates. union
4282 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4283 * candidate and priority of the candidate, e.g., based on the signal
4284 * strength, in order to try to pre-authenticate first with candidates
4285 * that are most likely targets for re-association.
4287 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4288 * on the candidate list. In addition, it can be called for the current
4289 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4290 * will automatically skip pre-authentication in cases where a valid
4291 * PMKSA exists. When more than one candidate exists, this event should
4292 * be generated once for each candidate.
4294 * Driver will be notified about successful pre-authentication with
4295 * struct wpa_driver_ops::add_pmkid() calls.
4297 EVENT_PMKID_CANDIDATE
,
4300 * EVENT_TDLS - Request TDLS operation
4302 * This event can be used to request a TDLS operation to be performed.
4307 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4309 * The driver is expected to report the received FT IEs from
4310 * FT authentication sequence from the AP. The FT IEs are included in
4311 * the extra information in union wpa_event_data::ft_ies.
4316 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4318 * The driver can use this event to inform wpa_supplicant about a STA
4319 * in an IBSS with which protected frames could be exchanged. This
4320 * event starts RSN authentication with the other STA to authenticate
4321 * the STA and set up encryption keys with it.
4323 EVENT_IBSS_RSN_START
,
4326 * EVENT_AUTH - Authentication result
4328 * This event should be called when authentication attempt has been
4329 * completed. This is only used if the driver supports separate
4330 * authentication step (struct wpa_driver_ops::authenticate).
4331 * Information about authentication result is included in
4332 * union wpa_event_data::auth.
4337 * EVENT_DEAUTH - Authentication lost
4339 * This event should be called when authentication is lost either due
4340 * to receiving deauthenticate frame from the AP or when sending that
4341 * frame to the current AP.
4342 * In AP mode, union wpa_event_data::deauth_info is required.
4347 * EVENT_ASSOC_REJECT - Association rejected
4349 * This event should be called when (re)association attempt has been
4350 * rejected by the AP. Information about the association response is
4351 * included in union wpa_event_data::assoc_reject.
4356 * EVENT_AUTH_TIMED_OUT - Authentication timed out
4358 EVENT_AUTH_TIMED_OUT
,
4361 * EVENT_ASSOC_TIMED_OUT - Association timed out
4363 EVENT_ASSOC_TIMED_OUT
,
4366 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
4368 EVENT_WPS_BUTTON_PUSHED
,
4371 * EVENT_TX_STATUS - Report TX status
4376 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
4378 EVENT_RX_FROM_UNKNOWN
,
4381 * EVENT_RX_MGMT - Report RX of a management frame
4386 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
4388 * This event is used to indicate when the driver has started the
4389 * requested remain-on-channel duration. Information about the
4390 * operation is included in union wpa_event_data::remain_on_channel.
4392 EVENT_REMAIN_ON_CHANNEL
,
4395 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
4397 * This event is used to indicate when the driver has completed
4398 * remain-on-channel duration, i.e., may noot be available on the
4399 * requested channel anymore. Information about the
4400 * operation is included in union wpa_event_data::remain_on_channel.
4402 EVENT_CANCEL_REMAIN_ON_CHANNEL
,
4405 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
4407 * This event is used to indicate when a Probe Request frame has been
4408 * received. Information about the received frame is included in
4409 * union wpa_event_data::rx_probe_req. The driver is required to report
4410 * these events only after successfully completed probe_req_report()
4411 * commands to request the events (i.e., report parameter is non-zero)
4412 * in station mode. In AP mode, Probe Request frames should always be
4418 * EVENT_NEW_STA - New wired device noticed
4420 * This event is used to indicate that a new device has been detected
4421 * in a network that does not use association-like functionality (i.e.,
4422 * mainly wired Ethernet). This can be used to start EAPOL
4423 * authenticator when receiving a frame from a device. The address of
4424 * the device is included in union wpa_event_data::new_sta.
4429 * EVENT_EAPOL_RX - Report received EAPOL frame
4431 * When in AP mode with hostapd, this event is required to be used to
4432 * deliver the receive EAPOL frames from the driver.
4437 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4439 * This event is used to indicate changes in the signal strength
4440 * observed in frames received from the current AP if signal strength
4441 * monitoring has been enabled with signal_monitor().
4443 EVENT_SIGNAL_CHANGE
,
4446 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4448 * This event is used to indicate that the interface was enabled after
4449 * having been previously disabled, e.g., due to rfkill.
4451 EVENT_INTERFACE_ENABLED
,
4454 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4456 * This event is used to indicate that the interface was disabled,
4457 * e.g., due to rfkill.
4459 EVENT_INTERFACE_DISABLED
,
4462 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4464 * This event is used to indicate that the channel list has changed,
4465 * e.g., because of a regulatory domain change triggered by scan
4466 * results including an AP advertising a country code.
4468 EVENT_CHANNEL_LIST_CHANGED
,
4471 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4473 * This event is used to indicate that the driver cannot maintain this
4474 * interface in its operation mode anymore. The most likely use for
4475 * this is to indicate that AP mode operation is not available due to
4476 * operating channel would need to be changed to a DFS channel when
4477 * the driver does not support radar detection and another virtual
4478 * interfaces caused the operating channel to change. Other similar
4479 * resource conflicts could also trigger this for station mode
4480 * interfaces. This event can be propagated when channel switching
4483 EVENT_INTERFACE_UNAVAILABLE
,
4486 * EVENT_BEST_CHANNEL
4488 * Driver generates this event whenever it detects a better channel
4489 * (e.g., based on RSSI or channel use). This information can be used
4490 * to improve channel selection for a new AP/P2P group.
4495 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4497 * This event should be called when a Deauthentication frame is dropped
4498 * due to it not being protected (MFP/IEEE 802.11w).
4499 * union wpa_event_data::unprot_deauth is required to provide more
4500 * details of the frame.
4502 EVENT_UNPROT_DEAUTH
,
4505 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4507 * This event should be called when a Disassociation frame is dropped
4508 * due to it not being protected (MFP/IEEE 802.11w).
4509 * union wpa_event_data::unprot_disassoc is required to provide more
4510 * details of the frame.
4512 EVENT_UNPROT_DISASSOC
,
4515 * EVENT_STATION_LOW_ACK
4517 * Driver generates this event whenever it detected that a particular
4518 * station was lost. Detection can be through massive transmission
4519 * failures for example.
4521 EVENT_STATION_LOW_ACK
,
4524 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4526 EVENT_IBSS_PEER_LOST
,
4529 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4531 * This event carries the new replay counter to notify wpa_supplicant
4532 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4533 * completed Group Key Handshake while the host (including
4534 * wpa_supplicant was sleeping).
4536 EVENT_DRIVER_GTK_REKEY
,
4539 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4541 EVENT_SCHED_SCAN_STOPPED
,
4544 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4546 * This event indicates that the station responded to the poll
4547 * initiated with @poll_client.
4549 EVENT_DRIVER_CLIENT_POLL_OK
,
4552 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4554 EVENT_EAPOL_TX_STATUS
,
4557 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4559 * Described in wpa_event_data.ch_switch
4564 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
4566 * This is a pre-switch event indicating the shortly following switch
4567 * of operating channels.
4569 * Described in wpa_event_data.ch_switch
4571 EVENT_CH_SWITCH_STARTED
,
4573 * EVENT_WNM - Request WNM operation
4575 * This event can be used to request a WNM operation to be performed.
4580 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4582 * This event indicates that the driver reported a connection failure
4583 * with the specified client (for example, max client reached, etc.) in
4586 EVENT_CONNECT_FAILED_REASON
,
4589 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
4591 * A radar has been detected on the supplied frequency, hostapd should
4592 * react accordingly (e.g., change channel).
4594 EVENT_DFS_RADAR_DETECTED
,
4597 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
4599 * After a successful CAC, the channel can be marked clear and used.
4601 EVENT_DFS_CAC_FINISHED
,
4604 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
4606 * The CAC was not successful, and the channel remains in the previous
4607 * state. This may happen due to a radar being detected or other
4608 * external influences.
4610 EVENT_DFS_CAC_ABORTED
,
4613 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
4615 * The channel which was previously unavailable is now available again.
4617 EVENT_DFS_NOP_FINISHED
,
4620 * EVENT_SURVEY - Received survey data
4622 * This event gets triggered when a driver query is issued for survey
4623 * data and the requested data becomes available. The returned data is
4624 * stored in struct survey_results. The results provide at most one
4625 * survey entry for each frequency and at minimum will provide one
4626 * survey entry for one frequency. The survey data can be os_malloc()'d
4627 * and then os_free()'d, so the event callback must only copy data.
4632 * EVENT_SCAN_STARTED - Scan started
4634 * This indicates that driver has started a scan operation either based
4635 * on a request from wpa_supplicant/hostapd or from another application.
4636 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4637 * completed (either successfully or by getting cancelled).
4642 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4644 * This event indicates a set of frequency ranges that should be avoided
4645 * to reduce issues due to interference or internal co-existence
4646 * information in the driver.
4648 EVENT_AVOID_FREQUENCIES
,
4651 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4653 EVENT_NEW_PEER_CANDIDATE
,
4656 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4658 * Indicates a pair of primary and secondary channels chosen by ACS
4661 EVENT_ACS_CHANNEL_SELECTED
,
4664 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4667 * This event indicates that channel availability check has been started
4668 * on a DFS frequency by a driver that supports DFS Offload.
4670 EVENT_DFS_CAC_STARTED
,
4673 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4678 * EVENT_BEACON_LOSS - Beacon loss detected
4680 * This event indicates that no Beacon frames has been received from
4681 * the current AP. This may indicate that the AP is not anymore in
4687 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
4688 * done previously (Pre-CAC) on the channel has expired. This would
4689 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
4690 * channel will be moved from available to usable. A new CAC has to be
4691 * performed before start operating on this channel.
4693 EVENT_DFS_PRE_CAC_EXPIRED
,
4696 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
4697 * that do not define separate commands for authentication and
4698 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
4699 * authentication to wpa_supplicant. This event carries all the
4700 * necessary information from the host driver for the authentication to
4703 EVENT_EXTERNAL_AUTH
,
4706 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
4708 * This event should be indicated when the driver completes the 4-way
4709 * handshake. This event should be preceded by an EVENT_ASSOC that
4710 * indicates the completion of IEEE 802.11 association.
4712 EVENT_PORT_AUTHORIZED
,
4715 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
4718 EVENT_STATION_OPMODE_CHANGED
,
4721 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
4723 * This event is emitted when the MAC changes while the interface is
4724 * enabled. When an interface was disabled and becomes enabled, it
4725 * must be always assumed that the MAC possibly changed.
4727 EVENT_INTERFACE_MAC_CHANGED
,
4730 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
4732 * This event is emitted when an interface is added/removed for WDS STA.
4734 EVENT_WDS_STA_INTERFACE_STATUS
,
4739 * struct freq_survey - Channel survey info
4741 * @ifidx: Interface index in which this survey was observed
4742 * @freq: Center of frequency of the surveyed channel
4743 * @nf: Channel noise floor in dBm
4744 * @channel_time: Amount of time in ms the radio spent on the channel
4745 * @channel_time_busy: Amount of time in ms the radio detected some signal
4746 * that indicated to the radio the channel was not clear
4747 * @channel_time_rx: Amount of time the radio spent receiving data
4748 * @channel_time_tx: Amount of time the radio spent transmitting data
4749 * @filled: bitmask indicating which fields have been reported, see
4750 * SURVEY_HAS_* defines.
4751 * @list: Internal list pointers
4753 struct freq_survey
{
4758 u64 channel_time_busy
;
4759 u64 channel_time_rx
;
4760 u64 channel_time_tx
;
4761 unsigned int filled
;
4762 struct dl_list list
;
4765 #define SURVEY_HAS_NF BIT(0)
4766 #define SURVEY_HAS_CHAN_TIME BIT(1)
4767 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4768 #define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4769 #define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4773 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4775 union wpa_event_data
{
4777 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4779 * This structure is optional for EVENT_ASSOC calls and required for
4780 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4781 * driver interface does not need to generate separate EVENT_ASSOCINFO
4786 * reassoc - Flag to indicate association or reassociation
4791 * req_ies - (Re)Association Request IEs
4793 * If the driver generates WPA/RSN IE, this event data must be
4794 * returned for WPA handshake to have needed information. If
4795 * wpa_supplicant-generated WPA/RSN IE is used, this
4796 * information event is optional.
4798 * This should start with the first IE (fixed fields before IEs
4799 * are not included).
4804 * req_ies_len - Length of req_ies in bytes
4809 * resp_ies - (Re)Association Response IEs
4811 * Optional association data from the driver. This data is not
4812 * required WPA, but may be useful for some protocols and as
4813 * such, should be reported if this is available to the driver
4816 * This should start with the first IE (fixed fields before IEs
4817 * are not included).
4822 * resp_ies_len - Length of resp_ies in bytes
4824 size_t resp_ies_len
;
4827 * resp_frame - (Re)Association Response frame
4829 const u8
*resp_frame
;
4832 * resp_frame_len - (Re)Association Response frame length
4834 size_t resp_frame_len
;
4837 * beacon_ies - Beacon or Probe Response IEs
4839 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4840 * Probe Response frames from the current AP (i.e., the one
4841 * that the client just associated with). This information is
4842 * used to update WPA/RSN IE for the AP. If this field is not
4843 * set, the results from previous scan will be used. If no
4844 * data for the new AP is found, scan results will be requested
4845 * again (without scan request). At this point, the driver is
4846 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4849 * This should start with the first IE (fixed fields before IEs
4850 * are not included).
4852 const u8
*beacon_ies
;
4855 * beacon_ies_len - Length of beacon_ies */
4856 size_t beacon_ies_len
;
4859 * freq - Frequency of the operational channel in MHz
4864 * wmm_params - WMM parameters used in this association.
4866 struct wmm_params wmm_params
;
4869 * addr - Station address (for AP mode)
4874 * The following is the key management offload information
4877 * @key_replay_ctr_len
4885 * authorized - Status of key management offload,
4891 * key_replay_ctr - Key replay counter value last used
4892 * in a valid EAPOL-Key frame
4894 const u8
*key_replay_ctr
;
4897 * key_replay_ctr_len - The length of key_replay_ctr
4899 size_t key_replay_ctr_len
;
4902 * ptk_kck - The derived PTK KCK
4907 * ptk_kek_len - The length of ptk_kck
4912 * ptk_kek - The derived PTK KEK
4913 * This is used in key management offload and also in FILS SK
4919 * ptk_kek_len - The length of ptk_kek
4924 * subnet_status - The subnet status:
4925 * 0 = unknown, 1 = unchanged, 2 = changed
4930 * The following information is used in FILS SK offload
4931 * @fils_erp_next_seq_num
4938 * fils_erp_next_seq_num - The next sequence number to use in
4941 u16 fils_erp_next_seq_num
;
4944 * fils_pmk - A new PMK if generated in case of FILS
4950 * fils_pmk_len - Length of fils_pmk
4952 size_t fils_pmk_len
;
4955 * fils_pmkid - PMKID used or generated in FILS authentication
4957 const u8
*fils_pmkid
;
4961 * struct disassoc_info - Data for EVENT_DISASSOC events
4963 struct disassoc_info
{
4965 * addr - Station address (for AP mode)
4970 * reason_code - Reason Code (host byte order) used in
4971 * Deauthentication frame
4976 * ie - Optional IE(s) in Disassociation frame
4981 * ie_len - Length of ie buffer in octets
4986 * locally_generated - Whether the frame was locally generated
4988 int locally_generated
;
4992 * struct deauth_info - Data for EVENT_DEAUTH events
4994 struct deauth_info
{
4996 * addr - Station address (for AP mode)
5001 * reason_code - Reason Code (host byte order) used in
5002 * Deauthentication frame
5007 * ie - Optional IE(s) in Deauthentication frame
5012 * ie_len - Length of ie buffer in octets
5017 * locally_generated - Whether the frame was locally generated
5019 int locally_generated
;
5023 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
5025 struct michael_mic_failure
{
5028 } michael_mic_failure
;
5031 * struct interface_status - Data for EVENT_INTERFACE_STATUS
5033 struct interface_status
{
5034 unsigned int ifindex
;
5037 EVENT_INTERFACE_ADDED
, EVENT_INTERFACE_REMOVED
5042 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
5044 struct pmkid_candidate
{
5045 /** BSSID of the PMKID candidate */
5047 /** Smaller the index, higher the priority */
5049 /** Whether RSN IE includes pre-authenticate flag */
5054 * struct tdls - Data for EVENT_TDLS
5060 TDLS_REQUEST_TEARDOWN
,
5061 TDLS_REQUEST_DISCOVER
,
5063 u16 reason_code
; /* for teardown */
5067 * struct wnm - Data for EVENT_WNM
5085 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
5087 * During FT (IEEE 802.11r) authentication sequence, the driver is
5088 * expected to use this event to report received FT IEs (MDIE, FTIE,
5089 * RSN IE, TIE, possible resource request) to the supplicant. The FT
5090 * IEs for the next message will be delivered through the
5091 * struct wpa_driver_ops::update_ft_ies() callback.
5097 u8 target_ap
[ETH_ALEN
];
5098 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
5100 /** Length of ric_ies buffer in octets */
5105 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
5107 struct ibss_rsn_start
{
5112 * struct auth_info - Data for EVENT_AUTH events
5118 u16 auth_transaction
;
5125 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
5127 struct assoc_reject
{
5129 * bssid - BSSID of the AP that rejected association
5134 * resp_ies - (Re)Association Response IEs
5136 * Optional association data from the driver. This data is not
5137 * required WPA, but may be useful for some protocols and as
5138 * such, should be reported if this is available to the driver
5141 * This should start with the first IE (fixed fields before IEs
5142 * are not included).
5147 * resp_ies_len - Length of resp_ies in bytes
5149 size_t resp_ies_len
;
5152 * status_code - Status Code from (Re)association Response
5157 * timed_out - Whether failure is due to timeout (etc.) rather
5158 * than explicit rejection response from the AP.
5163 * timeout_reason - Reason for the timeout
5165 const char *timeout_reason
;
5168 * fils_erp_next_seq_num - The next sequence number to use in
5171 u16 fils_erp_next_seq_num
;
5174 struct timeout_event
{
5179 * struct tx_status - Data for EVENT_TX_STATUS events
5191 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
5193 struct rx_from_unknown
{
5200 * struct rx_mgmt - Data for EVENT_RX_MGMT events
5208 * drv_priv - Pointer to store driver private BSS information
5210 * If not set to NULL, this is used for comparison with
5211 * hostapd_data->drv_priv to determine which BSS should process
5217 * freq - Frequency (in MHz) on which the frame was received
5222 * ssi_signal - Signal strength in dBm (or 0 if not available)
5228 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
5230 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
5232 struct remain_on_channel
{
5234 * freq - Channel frequency in MHz
5239 * duration - Duration to remain on the channel in milliseconds
5241 unsigned int duration
;
5242 } remain_on_channel
;
5245 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
5246 * @aborted: Whether the scan was aborted
5247 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
5248 * @num_freqs: Number of entries in freqs array
5249 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
5251 * @num_ssids: Number of entries in ssids array
5252 * @external_scan: Whether the scan info is for an external scan
5253 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
5254 * 0 if the source of the scan event is a vendor scan
5255 * @scan_start_tsf: Time when the scan started in terms of TSF of the
5256 * BSS that the interface that requested the scan is connected to
5258 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
5265 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
5270 u8 scan_start_tsf_bssid
[ETH_ALEN
];
5274 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
5276 struct rx_probe_req
{
5278 * sa - Source address of the received Probe Request frame
5283 * da - Destination address of the received Probe Request frame
5284 * or %NULL if not available
5289 * bssid - BSSID of the received Probe Request frame or %NULL
5295 * ie - IEs from the Probe Request body
5300 * ie_len - Length of ie buffer in octets
5305 * signal - signal strength in dBm (or 0 if not available)
5311 * struct new_sta - Data for EVENT_NEW_STA events
5318 * struct eapol_rx - Data for EVENT_EAPOL_RX events
5327 * signal_change - Data for EVENT_SIGNAL_CHANGE events
5329 struct wpa_signal_info signal_change
;
5332 * struct best_channel - Data for EVENT_BEST_CHANNEL events
5333 * @freq_24: Best 2.4 GHz band channel frequency in MHz
5334 * @freq_5: Best 5 GHz band channel frequency in MHz
5335 * @freq_overall: Best channel frequency in MHz
5337 * 0 can be used to indicate no preference in either band.
5339 struct best_channel
{
5345 struct unprot_deauth
{
5351 struct unprot_disassoc
{
5358 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
5359 * @addr: station address
5360 * @num_packets: Number of packets lost (consecutive packets not
5369 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
5371 struct ibss_peer_lost
{
5376 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
5378 struct driver_gtk_rekey
{
5380 const u8
*replay_ctr
;
5384 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
5385 * @addr: station address
5387 struct client_poll
{
5392 * struct eapol_tx_status
5393 * @dst: Original destination
5394 * @data: Data starting with IEEE 802.1X header (!)
5395 * @data_len: Length of data
5396 * @ack: Indicates ack or lost frame
5398 * This corresponds to hapd_send_eapol if the frame sent
5399 * there isn't just reported as EVENT_TX_STATUS.
5401 struct eapol_tx_status
{
5410 * @freq: Frequency of new channel in MHz
5411 * @ht_enabled: Whether this is an HT channel
5412 * @ch_offset: Secondary channel offset
5413 * @ch_width: Channel width
5414 * @cf1: Center frequency 1
5415 * @cf2: Center frequency 2
5421 enum chan_width ch_width
;
5427 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
5428 * @addr: Remote client address
5429 * @code: Reason code for connection failure
5431 struct connect_failed_reason
{
5437 } connect_failed_reason
;
5440 * struct dfs_event - Data for radar detected events
5441 * @freq: Frequency of the channel in MHz
5447 enum chan_width chan_width
;
5453 * survey_results - Survey result data for EVENT_SURVEY
5454 * @freq_filter: Requested frequency survey filter, 0 if request
5455 * was for all survey data
5456 * @survey_list: Linked list of survey data (struct freq_survey)
5458 struct survey_results
{
5459 unsigned int freq_filter
;
5460 struct dl_list survey_list
; /* struct freq_survey */
5464 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
5465 * @initiator: Initiator of the regulatory change
5466 * @type: Regulatory change type
5467 * @alpha2: Country code (or "" if not available)
5469 struct channel_list_changed
{
5470 enum reg_change_initiator initiator
;
5473 } channel_list_changed
;
5476 * freq_range - List of frequency ranges
5478 * This is used as the data with EVENT_AVOID_FREQUENCIES.
5480 struct wpa_freq_range_list freq_range
;
5485 * @peer: Peer address
5487 * @ie_len: Length of @ies
5489 * Notification of new candidate mesh peer.
5498 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
5499 * @pri_channel: Selected primary channel
5500 * @sec_channel: Selected secondary channel
5501 * @vht_seg0_center_ch: VHT mode Segment0 center channel
5502 * @vht_seg1_center_ch: VHT mode Segment1 center channel
5503 * @ch_width: Selected Channel width by driver. Driver may choose to
5504 * change hostapd configured ACS channel width due driver internal
5505 * channel restrictions.
5506 * hw_mode: Selected band (used with hw_mode=any)
5508 struct acs_selected_channels
{
5511 u8 vht_seg0_center_ch
;
5512 u8 vht_seg1_center_ch
;
5514 enum hostapd_hw_mode hw_mode
;
5515 } acs_selected_channels
;
5518 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
5519 * @reason_code: Reason for stopping offload
5520 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
5522 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
5524 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
5526 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
5527 * supported by device.
5529 struct p2p_lo_stop
{
5531 P2P_LO_STOPPED_REASON_COMPLETE
= 0,
5532 P2P_LO_STOPPED_REASON_RECV_STOP_CMD
,
5533 P2P_LO_STOPPED_REASON_INVALID_PARAM
,
5534 P2P_LO_STOPPED_REASON_NOT_SUPPORTED
,
5538 /* For EVENT_EXTERNAL_AUTH */
5539 struct external_auth external_auth
;
5542 * struct sta_opmode - Station's operation mode change event
5543 * @addr: The station MAC address
5544 * @smps_mode: SMPS mode of the station
5545 * @chan_width: Channel width of the station
5546 * @rx_nss: RX_NSS of the station
5548 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
5552 enum smps_mode smps_mode
;
5553 enum chan_width chan_width
;
5558 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
5560 struct wds_sta_interface
{
5567 } wds_sta_interface
;
5571 * wpa_supplicant_event - Report a driver event for wpa_supplicant
5572 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5573 * with struct wpa_driver_ops::init()
5574 * @event: event type (defined above)
5575 * @data: possible extra data for the event
5577 * Driver wrapper code should call this function whenever an event is received
5580 void wpa_supplicant_event(void *ctx
, enum wpa_event_type event
,
5581 union wpa_event_data
*data
);
5584 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
5585 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5586 * with struct wpa_driver_ops::init()
5587 * @event: event type (defined above)
5588 * @data: possible extra data for the event
5590 * Same as wpa_supplicant_event(), but we search for the interface in
5593 void wpa_supplicant_event_global(void *ctx
, enum wpa_event_type event
,
5594 union wpa_event_data
*data
);
5597 * The following inline functions are provided for convenience to simplify
5598 * event indication for some of the common events.
5601 static inline void drv_event_assoc(void *ctx
, const u8
*addr
, const u8
*ie
,
5602 size_t ielen
, int reassoc
)
5604 union wpa_event_data event
;
5605 os_memset(&event
, 0, sizeof(event
));
5606 event
.assoc_info
.reassoc
= reassoc
;
5607 event
.assoc_info
.req_ies
= ie
;
5608 event
.assoc_info
.req_ies_len
= ielen
;
5609 event
.assoc_info
.addr
= addr
;
5610 wpa_supplicant_event(ctx
, EVENT_ASSOC
, &event
);
5613 static inline void drv_event_disassoc(void *ctx
, const u8
*addr
)
5615 union wpa_event_data event
;
5616 os_memset(&event
, 0, sizeof(event
));
5617 event
.disassoc_info
.addr
= addr
;
5618 wpa_supplicant_event(ctx
, EVENT_DISASSOC
, &event
);
5621 static inline void drv_event_eapol_rx(void *ctx
, const u8
*src
, const u8
*data
,
5624 union wpa_event_data event
;
5625 os_memset(&event
, 0, sizeof(event
));
5626 event
.eapol_rx
.src
= src
;
5627 event
.eapol_rx
.data
= data
;
5628 event
.eapol_rx
.data_len
= data_len
;
5629 wpa_supplicant_event(ctx
, EVENT_EAPOL_RX
, &event
);
5632 /* driver_common.c */
5633 void wpa_scan_results_free(struct wpa_scan_results
*res
);
5635 /* Convert wpa_event_type to a string for logging */
5636 const char * event_to_string(enum wpa_event_type event
);
5638 /* Convert chan_width to a string for logging and control interfaces */
5639 const char * channel_width_to_string(enum chan_width width
);
5641 int channel_width_to_int(enum chan_width width
);
5643 int ht_supported(const struct hostapd_hw_modes
*mode
);
5644 int vht_supported(const struct hostapd_hw_modes
*mode
);
5646 struct wowlan_triggers
*
5647 wpa_get_wowlan_triggers(const char *wowlan_triggers
,
5648 const struct wpa_driver_capa
*capa
);
5649 /* Convert driver flag to string */
5650 const char * driver_flag_to_string(u64 flag
);
5652 /* NULL terminated array of linked in driver wrappers */
5653 extern const struct wpa_driver_ops
*const wpa_drivers
[];
5656 /* Available drivers */
5658 #ifdef CONFIG_DRIVER_WEXT
5659 extern const struct wpa_driver_ops wpa_driver_wext_ops
; /* driver_wext.c */
5660 #endif /* CONFIG_DRIVER_WEXT */
5661 #ifdef CONFIG_DRIVER_NL80211
5662 /* driver_nl80211.c */
5663 extern const struct wpa_driver_ops wpa_driver_nl80211_ops
;
5664 #endif /* CONFIG_DRIVER_NL80211 */
5665 #ifdef CONFIG_DRIVER_HOSTAP
5666 extern const struct wpa_driver_ops wpa_driver_hostap_ops
; /* driver_hostap.c */
5667 #endif /* CONFIG_DRIVER_HOSTAP */
5668 #ifdef CONFIG_DRIVER_BSD
5669 extern const struct wpa_driver_ops wpa_driver_bsd_ops
; /* driver_bsd.c */
5670 #endif /* CONFIG_DRIVER_BSD */
5671 #ifdef CONFIG_DRIVER_OPENBSD
5672 /* driver_openbsd.c */
5673 extern const struct wpa_driver_ops wpa_driver_openbsd_ops
;
5674 #endif /* CONFIG_DRIVER_OPENBSD */
5675 #ifdef CONFIG_DRIVER_NDIS
5676 extern struct wpa_driver_ops wpa_driver_ndis_ops
; /* driver_ndis.c */
5677 #endif /* CONFIG_DRIVER_NDIS */
5678 #ifdef CONFIG_DRIVER_WIRED
5679 extern const struct wpa_driver_ops wpa_driver_wired_ops
; /* driver_wired.c */
5680 #endif /* CONFIG_DRIVER_WIRED */
5681 #ifdef CONFIG_DRIVER_MACSEC_QCA
5682 /* driver_macsec_qca.c */
5683 extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops
;
5684 #endif /* CONFIG_DRIVER_MACSEC_QCA */
5685 #ifdef CONFIG_DRIVER_MACSEC_LINUX
5686 /* driver_macsec_linux.c */
5687 extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops
;
5688 #endif /* CONFIG_DRIVER_MACSEC_LINUX */
5689 #ifdef CONFIG_DRIVER_ROBOSWITCH
5690 /* driver_roboswitch.c */
5691 extern const struct wpa_driver_ops wpa_driver_roboswitch_ops
;
5692 #endif /* CONFIG_DRIVER_ROBOSWITCH */
5693 #ifdef CONFIG_DRIVER_ATHEROS
5694 /* driver_atheros.c */
5695 extern const struct wpa_driver_ops wpa_driver_atheros_ops
;
5696 #endif /* CONFIG_DRIVER_ATHEROS */
5697 #ifdef CONFIG_DRIVER_NONE
5698 extern const struct wpa_driver_ops wpa_driver_none_ops
; /* driver_none.c */
5699 #endif /* CONFIG_DRIVER_NONE */
5701 #endif /* DRIVER_H */