blob: 8b92e1293888f3b40bd8f994eeff102ad74c96ce [file] [log] [blame]
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001/*
2 * Driver interface definition
Paul Stewart092955c2017-02-06 09:13:09 -08003 * Copyright (c) 2003-2017, Jouni Malinen <j@w1.fi>
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004 *
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07007 *
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.
15 */
16
17#ifndef DRIVER_H
18#define DRIVER_H
19
20#define WPA_SUPPLICANT_DRIVER_VERSION 4
21
22#include "common/defs.h"
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -070023#include "common/ieee802_11_defs.h"
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070024#include "common/wpa_common.h"
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -080025#ifdef CONFIG_MACSEC
26#include "pae/ieee802_1x_kay.h"
27#endif /* CONFIG_MACSEC */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -070028#include "utils/list.h"
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070029
30#define HOSTAPD_CHAN_DISABLED 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080031#define HOSTAPD_CHAN_NO_IR 0x00000002
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070032#define HOSTAPD_CHAN_RADAR 0x00000008
33#define HOSTAPD_CHAN_HT40PLUS 0x00000010
34#define HOSTAPD_CHAN_HT40MINUS 0x00000020
35#define HOSTAPD_CHAN_HT40 0x00000040
Dmitry Shmidt391c59f2013-09-03 12:16:28 -070036#define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070037
Dmitry Shmidtea69e842013-05-13 14:52:28 -070038#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
43
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -070044#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
48
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080049#define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
50#define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
51
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -080052#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
60
Hai Shalom74f70d42019-02-11 14:42:39 -080061/* Allowed bandwidth mask */
62enum 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),
69};
70
Dmitry Shmidt849734c2016-05-27 09:59:01 -070071/* 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)
77
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070078#define HOSTAPD_DFS_REGION_FCC 1
79#define HOSTAPD_DFS_REGION_ETSI 2
80#define HOSTAPD_DFS_REGION_JP 3
81
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080082/**
83 * enum reg_change_initiator - Regulatory change initiator
84 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -080085enum reg_change_initiator {
86 REGDOM_SET_BY_CORE,
87 REGDOM_SET_BY_USER,
88 REGDOM_SET_BY_DRIVER,
89 REGDOM_SET_BY_COUNTRY_IE,
Dmitry Shmidt97672262014-02-03 13:02:54 -080090 REGDOM_BEACON_HINT,
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -080091};
92
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080093/**
94 * enum reg_type - Regulatory change types
95 */
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -070096enum reg_type {
97 REGDOM_TYPE_UNKNOWN,
98 REGDOM_TYPE_COUNTRY,
99 REGDOM_TYPE_WORLD,
100 REGDOM_TYPE_CUSTOM_WORLD,
101 REGDOM_TYPE_INTERSECTION,
102};
103
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700104/**
Hai Shalom81f62d82019-07-22 12:10:00 -0700105 * struct hostapd_wmm_rule - WMM regulatory rule
106 * @min_cwmin: Lower bound of CW_min value
107 * @min_cwmax: Lower bound of CW_max value
108 * @min_aifs: Lower bound of AIFS value
109 * @max_txop: Upper bound of TXOP, value in units of 32 usec
110 */
111struct hostapd_wmm_rule {
112 int min_cwmin;
113 int min_cwmax;
114 int min_aifs;
115 int max_txop;
116};
117
118/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700119 * struct hostapd_channel_data - Channel information
120 */
121struct hostapd_channel_data {
122 /**
123 * chan - Channel number (IEEE 802.11)
124 */
125 short chan;
126
127 /**
128 * freq - Frequency in MHz
129 */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800130 int freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700131
132 /**
133 * flag - Channel flags (HOSTAPD_CHAN_*)
134 */
135 int flag;
136
137 /**
Hai Shalom74f70d42019-02-11 14:42:39 -0800138 * allowed_bw - Allowed channel width bitmask
139 *
140 * See enum hostapd_chan_width_attr.
141 */
142 u32 allowed_bw;
143
144 /**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -0700145 * max_tx_power - Regulatory transmit power limit in dBm
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700146 */
147 u8 max_tx_power;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -0700148
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800149 /**
150 * survey_list - Linked list of surveys (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -0700151 */
152 struct dl_list survey_list;
153
154 /**
155 * min_nf - Minimum observed noise floor, in dBm, based on all
156 * surveyed channel data
157 */
158 s8 min_nf;
Dmitry Shmidt391c59f2013-09-03 12:16:28 -0700159
160#ifdef CONFIG_ACS
161 /**
162 * interference_factor - Computed interference factor on this
163 * channel (used internally in src/ap/acs.c; driver wrappers do not
164 * need to set this)
165 */
166 long double interference_factor;
167#endif /* CONFIG_ACS */
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -0700168
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800169 /**
170 * dfs_cac_ms - DFS CAC time in milliseconds
171 */
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -0700172 unsigned int dfs_cac_ms;
Hai Shalom81f62d82019-07-22 12:10:00 -0700173
174 /**
175 * wmm_rules_valid - Indicates wmm_rules state
176 */
177 int wmm_rules_valid;
178
179 /**
180 * wmm_rules - WMM regulatory rules
181 */
182 struct hostapd_wmm_rule wmm_rules[WMM_AC_NUM];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700183};
184
Hai Shalomfdcde762020-04-02 11:19:20 -0700185#define HE_MAC_CAPAB_0 0
Hai Shalom81f62d82019-07-22 12:10:00 -0700186#define HE_MAX_MAC_CAPAB_SIZE 6
187#define HE_MAX_PHY_CAPAB_SIZE 11
188#define HE_MAX_MCS_CAPAB_SIZE 12
189#define HE_MAX_PPET_CAPAB_SIZE 25
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800190
191/**
192 * struct he_capabilities - IEEE 802.11ax HE capabilities
193 */
194struct he_capabilities {
195 u8 he_supported;
Hai Shalom81f62d82019-07-22 12:10:00 -0700196 u8 phy_cap[HE_MAX_PHY_CAPAB_SIZE];
197 u8 mac_cap[HE_MAX_MAC_CAPAB_SIZE];
198 u8 mcs[HE_MAX_MCS_CAPAB_SIZE];
199 u8 ppet[HE_MAX_PPET_CAPAB_SIZE];
Hai Shalom899fcc72020-10-19 14:38:18 -0700200 u16 he_6ghz_capa;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800201};
202
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800203#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -0700204#define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800205
Hai Shalom81f62d82019-07-22 12:10:00 -0700206
207enum ieee80211_op_mode {
208 IEEE80211_MODE_INFRA = 0,
209 IEEE80211_MODE_IBSS = 1,
210 IEEE80211_MODE_AP = 2,
211 IEEE80211_MODE_MESH = 5,
212
213 /* only add new entries before IEEE80211_MODE_NUM */
214 IEEE80211_MODE_NUM
215};
216
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700217/**
Hai Shalomc3565922019-10-28 11:58:20 -0700218 * struct ieee80211_edmg_config - EDMG configuration
219 *
220 * This structure describes most essential parameters needed
221 * for IEEE 802.11ay EDMG configuration
222 *
223 * @channels: Bitmap that indicates the 2.16 GHz channel(s)
224 * that are allowed to be used for transmissions.
225 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
226 * Set to 0 to indicate EDMG not supported.
227 * @bw_config: Channel BW Configuration subfield encodes
228 * the allowed channel bandwidth configurations
229 */
230struct ieee80211_edmg_config {
231 u8 channels;
232 enum edmg_bw_config bw_config;
233};
234
235/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700236 * struct hostapd_hw_modes - Supported hardware mode information
237 */
238struct hostapd_hw_modes {
239 /**
240 * mode - Hardware mode
241 */
242 enum hostapd_hw_mode mode;
243
244 /**
245 * num_channels - Number of entries in the channels array
246 */
247 int num_channels;
248
249 /**
250 * channels - Array of supported channels
251 */
252 struct hostapd_channel_data *channels;
253
254 /**
255 * num_rates - Number of entries in the rates array
256 */
257 int num_rates;
258
259 /**
260 * rates - Array of supported rates in 100 kbps units
261 */
262 int *rates;
263
264 /**
265 * ht_capab - HT (IEEE 802.11n) capabilities
266 */
267 u16 ht_capab;
268
269 /**
270 * mcs_set - MCS (IEEE 802.11n) rate parameters
271 */
272 u8 mcs_set[16];
273
274 /**
275 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
276 */
277 u8 a_mpdu_params;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800278
Dmitry Shmidt04949592012-07-19 12:16:46 -0700279 /**
280 * vht_capab - VHT (IEEE 802.11ac) capabilities
281 */
282 u32 vht_capab;
283
284 /**
285 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
286 */
287 u8 vht_mcs_set[8];
288
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800289 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800290
291 /**
292 * he_capab - HE (IEEE 802.11ax) capabilities
293 */
Hai Shalom81f62d82019-07-22 12:10:00 -0700294 struct he_capabilities he_capab[IEEE80211_MODE_NUM];
Hai Shalomc3565922019-10-28 11:58:20 -0700295
296 /**
297 * This structure describes the most essential parameters needed
298 * for IEEE 802.11ay EDMG configuration.
299 */
300 struct ieee80211_edmg_config edmg;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700301};
302
303
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700304#define IEEE80211_CAP_ESS 0x0001
305#define IEEE80211_CAP_IBSS 0x0002
306#define IEEE80211_CAP_PRIVACY 0x0010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800307#define IEEE80211_CAP_RRM 0x1000
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700308
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800309/* DMG (60 GHz) IEEE 802.11ad */
310/* type - bits 0..1 */
311#define IEEE80211_CAP_DMG_MASK 0x0003
312#define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
313#define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
314#define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
315
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700316#define WPA_SCAN_QUAL_INVALID BIT(0)
317#define WPA_SCAN_NOISE_INVALID BIT(1)
318#define WPA_SCAN_LEVEL_INVALID BIT(2)
319#define WPA_SCAN_LEVEL_DBM BIT(3)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700320#define WPA_SCAN_ASSOCIATED BIT(5)
321
322/**
323 * struct wpa_scan_res - Scan result for an BSS/IBSS
324 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
325 * @bssid: BSSID
326 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
327 * @beacon_int: beacon interval in TUs (host byte order)
328 * @caps: capability information field in host byte order
329 * @qual: signal quality
330 * @noise: noise level
331 * @level: signal level
332 * @tsf: Timestamp
333 * @age: Age of the information in milliseconds (i.e., how many milliseconds
334 * ago the last Beacon or Probe Response frame was received)
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800335 * @est_throughput: Estimated throughput in kbps (this is calculated during
336 * scan result processing if left zero by the driver wrapper)
337 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
Dmitry Shmidt29333592017-01-09 12:27:11 -0800338 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
339 * of TSF of the BSS specified by %tsf_bssid.
340 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700341 * @ie_len: length of the following IE field in octets
342 * @beacon_ie_len: length of the following Beacon IE field in octets
343 *
344 * This structure is used as a generic format for scan results from the
345 * driver. Each driver interface implementation is responsible for converting
346 * the driver or OS specific scan results into this format.
347 *
348 * If the driver does not support reporting all IEs, the IE data structure is
349 * constructed of the IEs that are available. This field will also need to
350 * include SSID in IE format. All drivers are encouraged to be extended to
351 * report all IEs to make it easier to support future additions.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800352 *
353 * This structure data is followed by ie_len octets of IEs from Probe Response
354 * frame (or if the driver does not indicate source of IEs, these may also be
355 * from Beacon frame). After the first set of IEs, another set of IEs may follow
356 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700357 */
358struct wpa_scan_res {
359 unsigned int flags;
360 u8 bssid[ETH_ALEN];
361 int freq;
362 u16 beacon_int;
363 u16 caps;
364 int qual;
365 int noise;
366 int level;
367 u64 tsf;
368 unsigned int age;
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800369 unsigned int est_throughput;
370 int snr;
Dmitry Shmidt29333592017-01-09 12:27:11 -0800371 u64 parent_tsf;
372 u8 tsf_bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700373 size_t ie_len;
374 size_t beacon_ie_len;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800375 /* Followed by ie_len + beacon_ie_len octets of IE data */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700376};
377
378/**
379 * struct wpa_scan_results - Scan results
380 * @res: Array of pointers to allocated variable length scan result entries
381 * @num: Number of entries in the scan result array
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800382 * @fetch_time: Time when the results were fetched from the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700383 */
384struct wpa_scan_results {
385 struct wpa_scan_res **res;
386 size_t num;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800387 struct os_reltime fetch_time;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700388};
389
390/**
391 * struct wpa_interface_info - Network interface information
392 * @next: Pointer to the next interface or NULL if this is the last one
393 * @ifname: Interface name that can be used with init() or init2()
394 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
395 * not available
396 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
397 * is not an allocated copy, i.e., get_interfaces() caller will not free
398 * this)
399 */
400struct wpa_interface_info {
401 struct wpa_interface_info *next;
402 char *ifname;
403 char *desc;
404 const char *drv_name;
405};
406
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800407#define WPAS_MAX_SCAN_SSIDS 16
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700408
409/**
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800410 * struct wpa_driver_scan_ssid - SSIDs to scan for
411 * @ssid - specific SSID to scan for (ProbeReq)
412 * %NULL or zero-length SSID is used to indicate active scan
413 * with wildcard SSID.
414 * @ssid_len - Length of the SSID in octets
415 */
416struct wpa_driver_scan_ssid {
417 const u8 *ssid;
418 size_t ssid_len;
419};
420
421/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700422 * struct wpa_driver_scan_params - Scan parameters
423 * Data for struct wpa_driver_ops::scan2().
424 */
425struct wpa_driver_scan_params {
426 /**
427 * ssids - SSIDs to scan for
428 */
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800429 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700430
431 /**
432 * num_ssids - Number of entries in ssids array
433 * Zero indicates a request for a passive scan.
434 */
435 size_t num_ssids;
436
437 /**
438 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
439 */
440 const u8 *extra_ies;
441
442 /**
443 * extra_ies_len - Length of extra_ies in octets
444 */
445 size_t extra_ies_len;
446
447 /**
448 * freqs - Array of frequencies to scan or %NULL for all frequencies
449 *
450 * The frequency is set in MHz. The array is zero-terminated.
451 */
452 int *freqs;
453
454 /**
455 * filter_ssids - Filter for reporting SSIDs
456 *
457 * This optional parameter can be used to request the driver wrapper to
458 * filter scan results to include only the specified SSIDs. %NULL
459 * indicates that no filtering is to be done. This can be used to
460 * reduce memory needs for scan results in environments that have large
461 * number of APs with different SSIDs.
462 *
463 * The driver wrapper is allowed to take this allocated buffer into its
464 * own use by setting the pointer to %NULL. In that case, the driver
465 * wrapper is responsible for freeing the buffer with os_free() once it
466 * is not needed anymore.
467 */
468 struct wpa_driver_scan_filter {
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -0700469 u8 ssid[SSID_MAX_LEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700470 size_t ssid_len;
471 } *filter_ssids;
472
473 /**
474 * num_filter_ssids - Number of entries in filter_ssids array
475 */
476 size_t num_filter_ssids;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800477
478 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700479 * filter_rssi - Filter by RSSI
480 *
481 * The driver may filter scan results in firmware to reduce host
482 * wakeups and thereby save power. Specify the RSSI threshold in s32
483 * dBm.
484 */
485 s32 filter_rssi;
486
487 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800488 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
489 *
490 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
491 * Mbps from the support rates element(s) in the Probe Request frames
492 * and not to transmit the frames at any of those rates.
493 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700494 unsigned int p2p_probe:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800495
496 /**
497 * only_new_results - Request driver to report only new results
498 *
499 * This is used to request the driver to report only BSSes that have
500 * been detected after this scan request has been started, i.e., to
501 * flush old cached BSS entries.
502 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700503 unsigned int only_new_results:1;
504
505 /**
506 * low_priority - Requests driver to use a lower scan priority
507 *
508 * This is used to request the driver to use a lower scan priority
509 * if it supports such a thing.
510 */
511 unsigned int low_priority:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800512
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800513 /**
514 * mac_addr_rand - Requests driver to randomize MAC address
515 */
516 unsigned int mac_addr_rand:1;
517
518 /**
519 * mac_addr - MAC address used with randomization. The address cannot be
520 * a multicast one, i.e., bit 0 of byte 0 should not be set.
521 */
Hai Shalomc3565922019-10-28 11:58:20 -0700522 u8 *mac_addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800523
524 /**
525 * mac_addr_mask - MAC address mask used with randomization.
526 *
527 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
528 * the mask should be taken as is from mac_addr. The mask should not
529 * allow the generation of a multicast address, i.e., bit 0 of byte 0
530 * must be set.
531 */
532 const u8 *mac_addr_mask;
533
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800534 /**
535 * sched_scan_plans - Scan plans for scheduled scan
536 *
537 * Each scan plan consists of the number of iterations to scan and the
538 * interval between scans. When a scan plan finishes (i.e., it was run
539 * for the specified number of iterations), the next scan plan is
540 * executed. The scan plans are executed in the order they appear in
541 * the array (lower index first). The last scan plan will run infinitely
542 * (until requested to stop), thus must not specify the number of
543 * iterations. All other scan plans must specify the number of
544 * iterations.
545 */
546 struct sched_scan_plan {
547 u32 interval; /* In seconds */
548 u32 iterations; /* Zero to run infinitely */
549 } *sched_scan_plans;
550
551 /**
552 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
553 */
554 unsigned int sched_scan_plans_num;
555
Dmitry Shmidt9c175262016-03-03 10:20:07 -0800556 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700557 * sched_scan_start_delay - Delay to use before starting the first scan
558 *
559 * Delay (in seconds) before scheduling first scan plan cycle. The
560 * driver may ignore this parameter and start immediately (or at any
561 * other time), if this feature is not supported.
562 */
563 u32 sched_scan_start_delay;
564
565 /**
Dmitry Shmidt9c175262016-03-03 10:20:07 -0800566 * bssid - Specific BSSID to scan for
567 *
568 * This optional parameter can be used to replace the default wildcard
569 * BSSID with a specific BSSID to scan for if results are needed from
570 * only a single BSS.
571 */
572 const u8 *bssid;
573
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800574 /**
575 * scan_cookie - Unique identification representing the scan request
576 *
577 * This scan_cookie carries a unique identification representing the
578 * scan request if the host driver/kernel supports concurrent scan
579 * requests. This cookie is returned from the corresponding driver
580 * interface.
581 *
582 * Note: Unlike other parameters in this structure, scan_cookie is used
583 * only to return information instead of setting parameters for the
584 * scan.
585 */
586 u64 scan_cookie;
587
Dmitry Shmidt29333592017-01-09 12:27:11 -0800588 /**
589 * duration - Dwell time on each channel
590 *
591 * This optional parameter can be used to set the dwell time on each
592 * channel. In TUs.
593 */
594 u16 duration;
595
596 /**
597 * duration_mandatory - Whether the specified duration is mandatory
598 *
599 * If this is set, the duration specified by the %duration field is
600 * mandatory (and the driver should reject the scan request if it is
601 * unable to comply with the specified duration), otherwise it is the
602 * maximum duration and the actual duration may be shorter.
603 */
604 unsigned int duration_mandatory:1;
605
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800606 /**
607 * relative_rssi_set - Whether relative RSSI parameters are set
608 */
609 unsigned int relative_rssi_set:1;
610
611 /**
612 * relative_rssi - Relative RSSI for reporting better BSSs
613 *
614 * Amount of RSSI by which a BSS should be better than the current
615 * connected BSS to report the new BSS to user space.
616 */
617 s8 relative_rssi;
618
619 /**
620 * relative_adjust_band - Band to which RSSI should be adjusted
621 *
622 * The relative_adjust_rssi should be added to the band specified
623 * by relative_adjust_band.
624 */
625 enum set_band relative_adjust_band;
626
627 /**
628 * relative_adjust_rssi - RSSI to be added to relative_adjust_band
629 *
630 * An amount of relative_band_rssi should be added to the BSSs that
631 * belong to the band specified by relative_adjust_band while comparing
632 * with other bands for BSS reporting.
633 */
634 s8 relative_adjust_rssi;
635
Hai Shalomce48b4a2018-09-05 11:41:35 -0700636 /**
637 * oce_scan
638 *
639 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0)
640 * - Accept broadcast Probe Response frame.
641 * - Probe Request frame deferral and suppression.
642 * - Max Channel Time - driver fills FILS request params IE with
643 * Maximum Channel Time.
644 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps.
645 */
646 unsigned int oce_scan:1;
647
Hai Shalomc1a21442022-02-04 13:43:00 -0800648 /**
649 * p2p_include_6ghz - Include 6 GHz channels for P2P full scan
650 *
651 */
652 unsigned int p2p_include_6ghz:1;
653
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800654 /*
655 * NOTE: Whenever adding new parameters here, please make sure
656 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
657 * matching changes.
658 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700659};
660
661/**
662 * struct wpa_driver_auth_params - Authentication parameters
663 * Data for struct wpa_driver_ops::authenticate().
664 */
665struct wpa_driver_auth_params {
666 int freq;
667 const u8 *bssid;
668 const u8 *ssid;
669 size_t ssid_len;
670 int auth_alg;
671 const u8 *ie;
672 size_t ie_len;
673 const u8 *wep_key[4];
674 size_t wep_key_len[4];
675 int wep_tx_keyidx;
676 int local_state_change;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800677
678 /**
679 * p2p - Whether this connection is a P2P group
680 */
681 int p2p;
682
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800683 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800684 * auth_data - Additional elements for Authentication frame
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800685 *
686 * This buffer starts with the Authentication transaction sequence
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800687 * number field. If no special handling of such elements is needed, this
688 * pointer is %NULL. This is used with SAE and FILS.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800689 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800690 const u8 *auth_data;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800691
692 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800693 * auth_data_len - Length of auth_data buffer in octets
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800694 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800695 size_t auth_data_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700696};
697
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800698/**
699 * enum wps_mode - WPS mode
700 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700701enum wps_mode {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800702 /**
703 * WPS_MODE_NONE - No WPS provisioning being used
704 */
705 WPS_MODE_NONE,
706
707 /**
708 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
709 */
710 WPS_MODE_OPEN,
711
712 /**
713 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
714 */
715 WPS_MODE_PRIVACY
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700716};
717
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800718/**
719 * struct hostapd_freq_params - Channel parameters
720 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700721struct hostapd_freq_params {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800722 /**
723 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
724 */
725 enum hostapd_hw_mode mode;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700726
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800727 /**
728 * freq - Primary channel center frequency in MHz
729 */
730 int freq;
731
732 /**
733 * channel - Channel number
734 */
735 int channel;
736
737 /**
738 * ht_enabled - Whether HT is enabled
739 */
740 int ht_enabled;
741
742 /**
743 * sec_channel_offset - Secondary channel offset for HT40
744 *
745 * 0 = HT40 disabled,
746 * -1 = HT40 enabled, secondary channel below primary,
747 * 1 = HT40 enabled, secondary channel above primary
748 */
749 int sec_channel_offset;
750
751 /**
752 * vht_enabled - Whether VHT is enabled
753 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700754 int vht_enabled;
755
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800756 /**
Hai Shalom81f62d82019-07-22 12:10:00 -0700757 * he_enabled - Whether HE is enabled
758 */
759 int he_enabled;
760
761 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800762 * center_freq1 - Segment 0 center frequency in MHz
763 *
764 * Valid for both HT and VHT.
765 */
766 int center_freq1;
767
768 /**
769 * center_freq2 - Segment 1 center frequency in MHz
770 *
771 * Non-zero only for bandwidth 80 and an 80+80 channel
772 */
773 int center_freq2;
774
775 /**
776 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
777 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700778 int bandwidth;
Hai Shalomc3565922019-10-28 11:58:20 -0700779
780 /**
781 * This structure describes the most essential parameters needed
782 * for IEEE 802.11ay EDMG configuration.
783 */
784 struct ieee80211_edmg_config edmg;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700785};
786
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700787/**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700788 * struct wpa_driver_sta_auth_params - Authentication parameters
789 * Data for struct wpa_driver_ops::sta_auth().
790 */
791struct wpa_driver_sta_auth_params {
792
793 /**
794 * own_addr - Source address and BSSID for authentication frame
795 */
796 const u8 *own_addr;
797
798 /**
799 * addr - MAC address of the station to associate
800 */
801 const u8 *addr;
802
803 /**
804 * seq - authentication sequence number
805 */
806 u16 seq;
807
808 /**
809 * status - authentication response status code
810 */
811 u16 status;
812
813 /**
814 * ie - authentication frame ie buffer
815 */
816 const u8 *ie;
817
818 /**
819 * len - ie buffer length
820 */
821 size_t len;
822
823 /**
824 * fils_auth - Indicates whether FILS authentication is being performed
825 */
826 int fils_auth;
827
828 /**
829 * fils_anonce - ANonce (required for FILS)
830 */
831 u8 fils_anonce[WPA_NONCE_LEN];
832
833 /**
834 * fils_snonce - SNonce (required for FILS)
835 */
836 u8 fils_snonce[WPA_NONCE_LEN];
837
838 /**
839 * fils_kek - key for encryption (required for FILS)
840 */
841 u8 fils_kek[WPA_KEK_MAX_LEN];
842
843 /**
844 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
845 */
846 size_t fils_kek_len;
847};
848
849/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700850 * struct wpa_driver_associate_params - Association parameters
851 * Data for struct wpa_driver_ops::associate().
852 */
853struct wpa_driver_associate_params {
854 /**
855 * bssid - BSSID of the selected AP
856 * This can be %NULL, if ap_scan=2 mode is used and the driver is
857 * responsible for selecting with which BSS to associate. */
858 const u8 *bssid;
859
860 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800861 * bssid_hint - BSSID of a proposed AP
862 *
863 * This indicates which BSS has been found a suitable candidate for
864 * initial association for drivers that use driver/firmwate-based BSS
865 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
866 * the driver from selecting other BSSes in the ESS.
867 */
868 const u8 *bssid_hint;
869
870 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700871 * ssid - The selected SSID
872 */
873 const u8 *ssid;
874
875 /**
876 * ssid_len - Length of the SSID (1..32)
877 */
878 size_t ssid_len;
879
880 /**
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700881 * freq - channel parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700882 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700883 struct hostapd_freq_params freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700884
885 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800886 * freq_hint - Frequency of the channel the proposed AP is using
887 *
888 * This provides a channel on which a suitable BSS has been found as a
889 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
890 * limit the driver from selecting other channels for
891 * driver/firmware-based BSS selection.
892 */
893 int freq_hint;
894
895 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700896 * bg_scan_period - Background scan period in seconds, 0 to disable
897 * background scan, or -1 to indicate no change to default driver
898 * configuration
899 */
900 int bg_scan_period;
901
902 /**
Dmitry Shmidt2ac5f602014-03-07 10:08:21 -0800903 * beacon_int - Beacon interval for IBSS or 0 to use driver default
904 */
905 int beacon_int;
906
907 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700908 * wpa_ie - WPA information element for (Re)Association Request
909 * WPA information element to be included in (Re)Association
910 * Request (including information element id and length). Use
911 * of this WPA IE is optional. If the driver generates the WPA
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700912 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700913 * key_mgmt_suite to select proper algorithms. In this case,
914 * the driver has to notify wpa_supplicant about the used WPA
915 * IE by generating an event that the interface code will
916 * convert into EVENT_ASSOCINFO data (see below).
917 *
918 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
919 * instead. The driver can determine which version is used by
920 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
921 * WPA2/RSN).
922 *
923 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
924 */
925 const u8 *wpa_ie;
926
927 /**
928 * wpa_ie_len - length of the wpa_ie
929 */
930 size_t wpa_ie_len;
931
932 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800933 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
934 */
935 unsigned int wpa_proto;
936
937 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800938 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700939 *
940 * This is usually ignored if @wpa_ie is used.
941 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800942 unsigned int pairwise_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700943
944 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800945 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700946 *
947 * This is usually ignored if @wpa_ie is used.
948 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800949 unsigned int group_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700950
951 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700952 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
953 *
954 * This is usually ignored if @wpa_ie is used.
955 */
956 unsigned int mgmt_group_suite;
957
958 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800959 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700960 *
961 * This is usually ignored if @wpa_ie is used.
962 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800963 unsigned int key_mgmt_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700964
965 /**
966 * auth_alg - Allowed authentication algorithms
967 * Bit field of WPA_AUTH_ALG_*
968 */
969 int auth_alg;
970
971 /**
972 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
973 */
974 int mode;
975
976 /**
977 * wep_key - WEP keys for static WEP configuration
978 */
979 const u8 *wep_key[4];
980
981 /**
982 * wep_key_len - WEP key length for static WEP configuration
983 */
984 size_t wep_key_len[4];
985
986 /**
987 * wep_tx_keyidx - WEP TX key index for static WEP configuration
988 */
989 int wep_tx_keyidx;
990
991 /**
992 * mgmt_frame_protection - IEEE 802.11w management frame protection
993 */
994 enum mfp_options mgmt_frame_protection;
995
996 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700997 * passphrase - RSN passphrase for PSK
998 *
999 * This value is made available only for WPA/WPA2-Personal (PSK) and
Hai Shalom74f70d42019-02-11 14:42:39 -08001000 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
1001 * is the 8..63 character ASCII passphrase, if available. Please note
1002 * that this can be %NULL if passphrase was not used to generate the
1003 * PSK. In that case, the psk field must be used to fetch the PSK.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001004 */
1005 const char *passphrase;
1006
1007 /**
1008 * psk - RSN PSK (alternative for passphrase for PSK)
1009 *
1010 * This value is made available only for WPA/WPA2-Personal (PSK) and
Hai Shalom74f70d42019-02-11 14:42:39 -08001011 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
1012 * is the 32-octet (256-bit) PSK, if available. The driver wrapper
1013 * should be prepared to handle %NULL value as an error.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001014 */
1015 const u8 *psk;
1016
1017 /**
1018 * drop_unencrypted - Enable/disable unencrypted frame filtering
1019 *
1020 * Configure the driver to drop all non-EAPOL frames (both receive and
1021 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
1022 * still be allowed for key negotiation.
1023 */
1024 int drop_unencrypted;
1025
1026 /**
1027 * prev_bssid - Previously used BSSID in this ESS
1028 *
1029 * When not %NULL, this is a request to use reassociation instead of
1030 * association.
1031 */
1032 const u8 *prev_bssid;
1033
1034 /**
1035 * wps - WPS mode
1036 *
1037 * If the driver needs to do special configuration for WPS association,
1038 * this variable provides more information on what type of association
1039 * is being requested. Most drivers should not need ot use this.
1040 */
1041 enum wps_mode wps;
1042
1043 /**
1044 * p2p - Whether this connection is a P2P group
1045 */
1046 int p2p;
1047
1048 /**
1049 * uapsd - UAPSD parameters for the network
1050 * -1 = do not change defaults
1051 * AP mode: 1 = enabled, 0 = disabled
1052 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
1053 */
1054 int uapsd;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001055
1056 /**
1057 * fixed_bssid - Whether to force this BSSID in IBSS mode
1058 * 1 = Fix this BSSID and prevent merges.
1059 * 0 = Do not fix BSSID.
1060 */
1061 int fixed_bssid;
1062
1063 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001064 * fixed_freq - Fix control channel in IBSS mode
1065 * 0 = don't fix control channel (default)
1066 * 1 = fix control channel; this prevents IBSS merging with another
1067 * channel
1068 */
1069 int fixed_freq;
1070
1071 /**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001072 * disable_ht - Disable HT (IEEE 802.11n) for this connection
1073 */
1074 int disable_ht;
1075
1076 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001077 * htcaps - HT Capabilities over-rides
1078 *
1079 * Only bits set in the mask will be used, and not all values are used
1080 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
1081 *
1082 * Pointer to struct ieee80211_ht_capabilities.
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001083 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001084 const u8 *htcaps;
1085
1086 /**
1087 * htcaps_mask - HT Capabilities over-rides mask
1088 *
1089 * Pointer to struct ieee80211_ht_capabilities.
1090 */
1091 const u8 *htcaps_mask;
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001092
1093#ifdef CONFIG_VHT_OVERRIDES
1094 /**
1095 * disable_vht - Disable VHT for this connection
1096 */
1097 int disable_vht;
1098
1099 /**
1100 * VHT capability overrides.
1101 */
1102 const struct ieee80211_vht_capabilities *vhtcaps;
1103 const struct ieee80211_vht_capabilities *vhtcaps_mask;
1104#endif /* CONFIG_VHT_OVERRIDES */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001105
Hai Shalomfdcde762020-04-02 11:19:20 -07001106#ifdef CONFIG_HE_OVERRIDES
1107 /**
1108 * disable_he - Disable HE for this connection
1109 */
1110 int disable_he;
1111#endif /* CONFIG_HE_OVERRIDES */
1112
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001113 /**
1114 * req_key_mgmt_offload - Request key management offload for connection
1115 *
1116 * Request key management offload for this connection if the device
1117 * supports it.
1118 */
1119 int req_key_mgmt_offload;
1120
1121 /**
Hai Shalomc3565922019-10-28 11:58:20 -07001122 * req_handshake_offload - Request EAPOL handshake offload
1123 *
1124 * Request EAPOL handshake offload for this connection if the device
1125 * supports it.
1126 */
1127 int req_handshake_offload;
1128
1129 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001130 * Flag for indicating whether this association includes support for
1131 * RRM (Radio Resource Measurements)
1132 */
1133 int rrm_used;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001134
1135 /**
1136 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1137 * AP as usual. Valid for DMG network only.
1138 */
1139 int pbss;
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001140
1141 /**
1142 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1143 */
1144 const u8 *fils_kek;
1145
1146 /**
1147 * fils_kek_len: Length of fils_kek in bytes
1148 */
1149 size_t fils_kek_len;
1150
1151 /**
1152 * fils_nonces - Nonces for FILS association frame protection
1153 * (AES-SIV AAD)
1154 */
1155 const u8 *fils_nonces;
1156
1157 /**
1158 * fils_nonces_len: Length of fils_nonce in bytes
1159 */
1160 size_t fils_nonces_len;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001161
1162 /**
1163 * fils_erp_username - Username part of keyName-NAI
1164 */
1165 const u8 *fils_erp_username;
1166
1167 /**
1168 * fils_erp_username_len - Length of fils_erp_username in bytes
1169 */
1170 size_t fils_erp_username_len;
1171
1172 /**
1173 * fils_erp_realm - Realm/domain name to use in FILS ERP
1174 */
1175 const u8 *fils_erp_realm;
1176
1177 /**
1178 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1179 */
1180 size_t fils_erp_realm_len;
1181
1182 /**
1183 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1184 * messages
1185 */
1186 u16 fils_erp_next_seq_num;
1187
1188 /**
1189 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1190 * specified by fils_erp_username@fils_erp_realm.
1191 */
1192 const u8 *fils_erp_rrk;
1193
1194 /**
1195 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1196 */
1197 size_t fils_erp_rrk_len;
Hai Shalom60840252021-02-19 19:02:11 -08001198
1199 /**
1200 * sae_pwe - SAE mechanism for PWE derivation
1201 * 0 = hunting-and-pecking loop only
1202 * 1 = hash-to-element only
1203 * 2 = both hunting-and-pecking loop and hash-to-element enabled
1204 */
1205 int sae_pwe;
Vinayak Yadawade62409f2022-01-20 12:32:07 +05301206#ifdef CONFIG_DRIVER_NL80211_BRCM
1207 /**
1208 * td_policy - Transition Disable Policy
1209 */
1210 u32 td_policy;
1211#endif /* CONFIG_DRIVER_NL80211_BRCM */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001212};
1213
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001214enum hide_ssid {
1215 NO_SSID_HIDING,
1216 HIDDEN_SSID_ZERO_LEN,
1217 HIDDEN_SSID_ZERO_CONTENTS
1218};
1219
Hai Shalom81f62d82019-07-22 12:10:00 -07001220enum ch_switch_state {
1221 CH_SW_STARTED,
1222 CH_SW_FINISHED
1223};
1224
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001225struct wowlan_triggers {
1226 u8 any;
1227 u8 disconnect;
1228 u8 magic_pkt;
1229 u8 gtk_rekey_failure;
1230 u8 eap_identity_req;
1231 u8 four_way_handshake;
1232 u8 rfkill_release;
1233};
1234
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001235struct wpa_driver_ap_params {
1236 /**
1237 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1238 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001239 u8 *head;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001240
1241 /**
1242 * head_len - Length of the head buffer in octets
1243 */
1244 size_t head_len;
1245
1246 /**
1247 * tail - Beacon tail following TIM IE
1248 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001249 u8 *tail;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001250
1251 /**
1252 * tail_len - Length of the tail buffer in octets
1253 */
1254 size_t tail_len;
1255
1256 /**
1257 * dtim_period - DTIM period
1258 */
1259 int dtim_period;
1260
1261 /**
1262 * beacon_int - Beacon interval
1263 */
1264 int beacon_int;
1265
1266 /**
1267 * basic_rates: -1 terminated array of basic rates in 100 kbps
1268 *
1269 * This parameter can be used to set a specific basic rate set for the
1270 * BSS. If %NULL, default basic rate set is used.
1271 */
1272 int *basic_rates;
1273
1274 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001275 * beacon_rate: Beacon frame data rate
1276 *
1277 * This parameter can be used to set a specific Beacon frame data rate
1278 * for the BSS. The interpretation of this value depends on the
Hai Shalom60840252021-02-19 19:02:11 -08001279 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS,
1280 * HE: HE-MCS). If beacon_rate == 0 and rate_type == 0
1281 * (BEACON_RATE_LEGACY), the default Beacon frame data rate is used.
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001282 */
1283 unsigned int beacon_rate;
1284
1285 /**
Hai Shalom60840252021-02-19 19:02:11 -08001286 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT/HE)
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001287 */
1288 enum beacon_rate_type rate_type;
1289
1290 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001291 * proberesp - Probe Response template
1292 *
1293 * This is used by drivers that reply to Probe Requests internally in
1294 * AP mode and require the full Probe Response template.
1295 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001296 u8 *proberesp;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001297
1298 /**
1299 * proberesp_len - Length of the proberesp buffer in octets
1300 */
1301 size_t proberesp_len;
1302
1303 /**
1304 * ssid - The SSID to use in Beacon/Probe Response frames
1305 */
1306 const u8 *ssid;
1307
1308 /**
1309 * ssid_len - Length of the SSID (1..32)
1310 */
1311 size_t ssid_len;
1312
1313 /**
1314 * hide_ssid - Whether to hide the SSID
1315 */
1316 enum hide_ssid hide_ssid;
1317
1318 /**
1319 * pairwise_ciphers - WPA_CIPHER_* bitfield
1320 */
1321 unsigned int pairwise_ciphers;
1322
1323 /**
1324 * group_cipher - WPA_CIPHER_*
1325 */
1326 unsigned int group_cipher;
1327
1328 /**
1329 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1330 */
1331 unsigned int key_mgmt_suites;
1332
1333 /**
1334 * auth_algs - WPA_AUTH_ALG_* bitfield
1335 */
1336 unsigned int auth_algs;
1337
1338 /**
1339 * wpa_version - WPA_PROTO_* bitfield
1340 */
1341 unsigned int wpa_version;
1342
1343 /**
1344 * privacy - Whether privacy is used in the BSS
1345 */
1346 int privacy;
1347
1348 /**
1349 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1350 *
1351 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1352 * not use the full Beacon template.
1353 */
1354 const struct wpabuf *beacon_ies;
1355
1356 /**
1357 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1358 *
1359 * This is used to add IEs like WPS IE and P2P IE by drivers that
1360 * reply to Probe Request frames internally.
1361 */
1362 const struct wpabuf *proberesp_ies;
1363
1364 /**
1365 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1366 *
1367 * This is used to add IEs like WPS IE by drivers that reply to
1368 * (Re)Association Request frames internally.
1369 */
1370 const struct wpabuf *assocresp_ies;
1371
1372 /**
1373 * isolate - Whether to isolate frames between associated stations
1374 *
1375 * If this is non-zero, the AP is requested to disable forwarding of
1376 * frames between associated stations.
1377 */
1378 int isolate;
1379
1380 /**
1381 * cts_protect - Whether CTS protection is enabled
1382 */
1383 int cts_protect;
1384
1385 /**
1386 * preamble - Whether short preamble is enabled
1387 */
1388 int preamble;
1389
1390 /**
1391 * short_slot_time - Whether short slot time is enabled
1392 *
1393 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1394 * not set (e.g., when 802.11g mode is not in use)
1395 */
1396 int short_slot_time;
1397
1398 /**
1399 * ht_opmode - HT operation mode or -1 if HT not in use
1400 */
1401 int ht_opmode;
1402
1403 /**
1404 * interworking - Whether Interworking is enabled
1405 */
1406 int interworking;
1407
1408 /**
1409 * hessid - Homogeneous ESS identifier or %NULL if not set
1410 */
1411 const u8 *hessid;
1412
1413 /**
1414 * access_network_type - Access Network Type (0..15)
1415 *
1416 * This is used for filtering Probe Request frames when Interworking is
1417 * enabled.
1418 */
1419 u8 access_network_type;
Dmitry Shmidt04949592012-07-19 12:16:46 -07001420
1421 /**
1422 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1423 *
1424 * This is used by driver which advertises this capability.
1425 */
1426 int ap_max_inactivity;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001427
1428 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001429 * ctwindow - Client Traffic Window (in TUs)
1430 */
1431 u8 p2p_go_ctwindow;
1432
1433 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001434 * disable_dgaf - Whether group-addressed frames are disabled
1435 */
1436 int disable_dgaf;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001437
1438 /**
1439 * osen - Whether OSEN security is enabled
1440 */
1441 int osen;
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001442
1443 /**
1444 * freq - Channel parameters for dynamic bandwidth changes
1445 */
1446 struct hostapd_freq_params *freq;
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001447
1448 /**
1449 * reenable - Whether this is to re-enable beaconing
1450 */
1451 int reenable;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001452
1453 /**
1454 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1455 * infrastructure BSS. Valid only for DMG network.
1456 */
1457 int pbss;
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001458
1459 /**
1460 * multicast_to_unicast - Whether to use multicast_to_unicast
1461 *
1462 * If this is non-zero, the AP is requested to perform multicast to
1463 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1464 * 802.1Q). If enabled, such frames are to be sent to each station
1465 * separately, with the DA replaced by their own MAC address rather
1466 * than the group address.
1467 *
1468 * Note that this may break certain expectations of the receiver, such
1469 * as the ability to drop unicast IP packets received within multicast
1470 * L2 frames, or the ability to not send ICMP destination unreachable
1471 * messages for packets received in L2 multicast (which is required,
1472 * but the receiver can't tell the difference if this new option is
1473 * enabled.)
1474 *
1475 * This also doesn't implement the 802.11 DMS (directed multicast
1476 * service).
1477 */
1478 int multicast_to_unicast;
Hai Shalom74f70d42019-02-11 14:42:39 -08001479
1480 /**
1481 * ftm_responder - Whether FTM responder is enabled
1482 */
1483 int ftm_responder;
1484
1485 /**
1486 * lci - Binary data, the content of an LCI report IE with type 8 as
1487 * defined in IEEE Std 802.11-2016, 9.4.2.22.10
1488 */
1489 const struct wpabuf *lci;
1490
1491 /**
1492 * civic - Binary data, the content of a measurement report IE with
1493 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
1494 */
1495 const struct wpabuf *civic;
Hai Shalomc3565922019-10-28 11:58:20 -07001496
1497 /**
Hai Shalom60840252021-02-19 19:02:11 -08001498 * he_spr_ctrl - Spatial Reuse control field of SPR element
Hai Shalomc3565922019-10-28 11:58:20 -07001499 */
Hai Shalom60840252021-02-19 19:02:11 -08001500 u8 he_spr_ctrl;
1501
1502 /**
1503 * he_spr_non_srg_obss_pd_max_offset - Non-SRG Maximum TX power offset
1504 */
1505 u8 he_spr_non_srg_obss_pd_max_offset;
Hai Shalomc3565922019-10-28 11:58:20 -07001506
1507 /**
1508 * he_spr_srg_obss_pd_min_offset - Minimum TX power offset
1509 */
Hai Shalom60840252021-02-19 19:02:11 -08001510 u8 he_spr_srg_obss_pd_min_offset;
Hai Shalomc3565922019-10-28 11:58:20 -07001511
1512 /**
1513 * he_spr_srg_obss_pd_max_offset - Maximum TX power offset
1514 */
Hai Shalom60840252021-02-19 19:02:11 -08001515 u8 he_spr_srg_obss_pd_max_offset;
1516
1517 /**
1518 * he_spr_bss_color_bitmap - BSS color values used by members of the
1519 * SRG.
1520 */
1521 u8 he_spr_bss_color_bitmap[8];
1522
1523 /**
1524 * he_spr_partial_bssid_bitmap - Partial BSSID values used by members
1525 * of the SRG.
1526 */
1527 u8 he_spr_partial_bssid_bitmap[8];
Hai Shalomfdcde762020-04-02 11:19:20 -07001528
1529 /**
1530 * he_bss_color - Whether the BSS Color is disabled
1531 */
1532 int he_bss_color_disabled;
1533
1534 /**
1535 * he_bss_color_partial - The BSS Color AID equation
1536 */
1537 int he_bss_color_partial;
1538
1539 /**
1540 * he_bss_color - The BSS Color of the AP
1541 */
1542 int he_bss_color;
1543
1544 /**
1545 * twt_responder - Whether Target Wait Time responder is enabled
1546 */
1547 int twt_responder;
Hai Shalom60840252021-02-19 19:02:11 -08001548
1549 /**
1550 * sae_pwe - SAE mechanism for PWE derivation
1551 * 0 = hunting-and-pecking loop only
1552 * 1 = hash-to-element only
1553 * 2 = both hunting-and-pecking loop and hash-to-element enabled
1554 */
1555 int sae_pwe;
1556
1557 /**
1558 * FILS Discovery frame minimum interval in TUs
1559 */
1560 u32 fd_min_int;
1561
1562 /**
1563 * FILS Discovery frame maximum interval in TUs (0 = FD frame disabled)
1564 */
1565 u32 fd_max_int;
1566
1567 /**
1568 * FILS Discovery frame template data
1569 */
1570 u8 *fd_frame_tmpl;
1571
1572 /**
1573 * FILS Discovery frame template length
1574 */
1575 size_t fd_frame_tmpl_len;
1576
1577 /**
1578 * Unsolicited broadcast Probe Response interval in TUs
1579 */
1580 unsigned int unsol_bcast_probe_resp_interval;
1581
1582 /**
1583 * Unsolicited broadcast Probe Response template data
1584 */
1585 u8 *unsol_bcast_probe_resp_tmpl;
1586
1587 /**
1588 * Unsolicited broadcast Probe Response template length
1589 */
1590 size_t unsol_bcast_probe_resp_tmpl_len;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001591};
1592
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001593struct wpa_driver_mesh_bss_params {
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001594#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1595#define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1596#define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1597#define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001598#define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010
Hai Shalomc1a21442022-02-04 13:43:00 -08001599#define WPA_DRIVER_MESH_CONF_FLAG_FORWARDING 0x00000020
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001600 /*
1601 * TODO: Other mesh configuration parameters would go here.
1602 * See NL80211_MESHCONF_* for all the mesh config parameters.
1603 */
1604 unsigned int flags;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001605 int auto_plinks;
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001606 int peer_link_timeout;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001607 int max_peer_links;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001608 int rssi_threshold;
Hai Shalomc1a21442022-02-04 13:43:00 -08001609 int forwarding;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001610 u16 ht_opmode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001611};
1612
1613struct wpa_driver_mesh_join_params {
1614 const u8 *meshid;
1615 int meshid_len;
1616 const int *basic_rates;
1617 const u8 *ies;
1618 int ie_len;
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001619 struct hostapd_freq_params freq;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001620 int beacon_int;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001621 int dtim_period;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001622 struct wpa_driver_mesh_bss_params conf;
1623#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1624#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1625#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1626#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1627 unsigned int flags;
Hai Shalom60840252021-02-19 19:02:11 -08001628 bool handle_dfs;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001629};
1630
Hai Shalomfdcde762020-04-02 11:19:20 -07001631struct wpa_driver_set_key_params {
1632 /**
1633 * ifname - Interface name (for multi-SSID/VLAN support) */
1634 const char *ifname;
1635
1636 /**
1637 * alg - Encryption algorithm
1638 *
1639 * (%WPA_ALG_NONE, %WPA_ALG_WEP, %WPA_ALG_TKIP, %WPA_ALG_CCMP,
Hai Shalom4fbc08f2020-05-18 12:37:00 -07001640 * %WPA_ALG_BIP_AES_CMAC_128, %WPA_ALG_GCMP, %WPA_ALG_GCMP_256,
1641 * %WPA_ALG_CCMP_256, %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1642 * %WPA_ALG_BIP_CMAC_256);
Hai Shalomfdcde762020-04-02 11:19:20 -07001643 * %WPA_ALG_NONE clears the key. */
1644 enum wpa_alg alg;
1645
1646 /**
1647 * addr - Address of the peer STA
1648 *
1649 * (BSSID of the current AP when setting pairwise key in station mode),
1650 * ff:ff:ff:ff:ff:ff for broadcast keys, %NULL for default keys that
1651 * are used both for broadcast and unicast; when clearing keys, %NULL
1652 * is used to indicate that both the broadcast-only and default key of
1653 * the specified key index is to be cleared */
1654 const u8 *addr;
1655
1656 /**
1657 * key_idx - Key index
1658 *
1659 * (0..3), usually 0 for unicast keys; 4..5 for IGTK; 6..7 for BIGTK */
1660 int key_idx;
1661
1662 /**
1663 * set_tx - Configure this key as the default Tx key
1664 *
1665 * Only used when driver does not support separate unicast/individual
1666 * key */
1667 int set_tx;
1668
1669 /**
1670 * seq - Sequence number/packet number
1671 *
1672 * seq_len octets, the next packet number to be used for in replay
1673 * protection; configured for Rx keys (in most cases, this is only used
1674 * with broadcast keys and set to zero for unicast keys); %NULL if not
1675 * set */
1676 const u8 *seq;
1677
1678 /**
1679 * seq_len - Length of the seq, depends on the algorithm
1680 *
1681 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets */
1682 size_t seq_len;
1683
1684 /**
1685 * key - Key buffer
1686 *
1687 * TKIP: 16-byte temporal key, 8-byte Tx Mic key, 8-byte Rx Mic Key */
1688 const u8 *key;
1689
1690 /**
1691 * key_len - Length of the key buffer in octets
1692 *
1693 * WEP: 5 or 13, TKIP: 32, CCMP/GCMP: 16, IGTK: 16 */
1694 size_t key_len;
1695
1696 /**
1697 * vlan_id - VLAN index (0..4095) for VLAN offload cases */
1698 int vlan_id;
1699
1700 /**
1701 * key_flag - Additional key flags
1702 *
1703 * %KEY_FLAG_MODIFY
1704 * Set when an already installed key must be updated.
1705 * So far the only use-case is changing RX/TX status for
1706 * pairwise keys. Must not be set when deleting a key.
1707 * %KEY_FLAG_DEFAULT
1708 * Set when the key is also a default key. Must not be set when
1709 * deleting a key.
1710 * %KEY_FLAG_RX
1711 * The key is valid for RX. Must not be set when deleting a key.
1712 * %KEY_FLAG_TX
1713 * The key is valid for TX. Must not be set when deleting a key.
1714 * %KEY_FLAG_GROUP
1715 * The key is a broadcast or group key.
1716 * %KEY_FLAG_PAIRWISE
1717 * The key is a pairwise key.
1718 * %KEY_FLAG_PMK
1719 * The key is a Pairwise Master Key (PMK).
1720 *
1721 * Valid and pre-defined combinations are:
1722 * %KEY_FLAG_GROUP_RX_TX
1723 * WEP key not to be installed as default key.
1724 * %KEY_FLAG_GROUP_RX_TX_DEFAULT
1725 * Default WEP or WPA-NONE key.
1726 * %KEY_FLAG_GROUP_RX
1727 * GTK key valid for RX only.
1728 * %KEY_FLAG_GROUP_TX_DEFAULT
1729 * GTK key valid for TX only, immediately taking over TX.
1730 * %KEY_FLAG_PAIRWISE_RX_TX
1731 * Pairwise key immediately becoming the active pairwise key.
1732 * %KEY_FLAG_PAIRWISE_RX
1733 * Pairwise key not yet valid for TX. (Only usable when Extended
1734 * Key ID is supported by the driver.)
1735 * %KEY_FLAG_PAIRWISE_RX_TX_MODIFY
1736 * Enable TX for a pairwise key installed with
1737 * KEY_FLAG_PAIRWISE_RX.
1738 *
1739 * Not a valid standalone key type but pre-defined to be combined
1740 * with other key_flags:
1741 * %KEY_FLAG_RX_TX
1742 * RX/TX key. */
1743 enum key_flag key_flag;
1744};
1745
Hai Shalom4fbc08f2020-05-18 12:37:00 -07001746enum wpa_driver_if_type {
1747 /**
1748 * WPA_IF_STATION - Station mode interface
1749 */
1750 WPA_IF_STATION,
1751
1752 /**
1753 * WPA_IF_AP_VLAN - AP mode VLAN interface
1754 *
1755 * This interface shares its address and Beacon frame with the main
1756 * BSS.
1757 */
1758 WPA_IF_AP_VLAN,
1759
1760 /**
1761 * WPA_IF_AP_BSS - AP mode BSS interface
1762 *
1763 * This interface has its own address and Beacon frame.
1764 */
1765 WPA_IF_AP_BSS,
1766
1767 /**
1768 * WPA_IF_P2P_GO - P2P Group Owner
1769 */
1770 WPA_IF_P2P_GO,
1771
1772 /**
1773 * WPA_IF_P2P_CLIENT - P2P Client
1774 */
1775 WPA_IF_P2P_CLIENT,
1776
1777 /**
1778 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1779 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1780 */
1781 WPA_IF_P2P_GROUP,
1782
1783 /**
1784 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1785 * abstracted P2P Device function in the driver
1786 */
1787 WPA_IF_P2P_DEVICE,
1788
1789 /*
1790 * WPA_IF_MESH - Mesh interface
1791 */
1792 WPA_IF_MESH,
1793
1794 /*
1795 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1796 */
1797 WPA_IF_TDLS,
1798
1799 /*
1800 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1801 */
1802 WPA_IF_IBSS,
1803
1804 /*
1805 * WPA_IF_NAN - NAN Device
1806 */
1807 WPA_IF_NAN,
1808
1809 /* keep last */
1810 WPA_IF_MAX
1811};
1812
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001813/**
1814 * struct wpa_driver_capa - Driver capability information
1815 */
1816struct wpa_driver_capa {
1817#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1818#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1819#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1820#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1821#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1822#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1823#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001824#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001825#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1826#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001827#define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
1828#define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
1829#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1830#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1831#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1832#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
Hai Shalom74f70d42019-02-11 14:42:39 -08001833#define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000
Tanmay Garga7fd80d2020-05-18 15:52:44 +05301834#define WPA_DRIVER_CAPA_KEY_MGMT_802_1X_SHA256 0x00020000
1835#define WPA_DRIVER_CAPA_KEY_MGMT_PSK_SHA256 0x00040000
1836#define WPA_DRIVER_CAPA_KEY_MGMT_TPK_HANDSHAKE 0x00080000
1837#define WPA_DRIVER_CAPA_KEY_MGMT_FT_SAE 0x00100000
1838#define WPA_DRIVER_CAPA_KEY_MGMT_FT_802_1X_SHA384 0x00200000
1839#define WPA_DRIVER_CAPA_KEY_MGMT_CCKM 0x00400000
1840#define WPA_DRIVER_CAPA_KEY_MGMT_OSEN 0x00800000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001841 /** Bitfield of supported key management suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001842 unsigned int key_mgmt;
Hai Shalom4fbc08f2020-05-18 12:37:00 -07001843 unsigned int key_mgmt_iftype[WPA_IF_MAX];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001844
1845#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1846#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1847#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1848#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
Dmitry Shmidt04949592012-07-19 12:16:46 -07001849#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001850#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001851#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1852#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1853#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1854#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1855#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1856#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001857#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001858 /** Bitfield of supported cipher suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001859 unsigned int enc;
1860
1861#define WPA_DRIVER_AUTH_OPEN 0x00000001
1862#define WPA_DRIVER_AUTH_SHARED 0x00000002
1863#define WPA_DRIVER_AUTH_LEAP 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001864 /** Bitfield of supported IEEE 802.11 authentication algorithms */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001865 unsigned int auth;
1866
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001867/** Driver generated WPA/RSN IE */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001868#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001869/** Driver needs static WEP key setup after association command */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001870#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001871/** Driver takes care of all DFS operations */
Dmitry Shmidtd11f0192014-03-24 12:09:47 -07001872#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001873/** Driver takes care of RSN 4-way handshake internally; PMK is configured with
Hai Shalomfdcde762020-04-02 11:19:20 -07001874 * struct wpa_driver_ops::set_key using key_flag = KEY_FLAG_PMK */
Hai Shalom74f70d42019-02-11 14:42:39 -08001875#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001876/** Driver is for a wired Ethernet interface */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001877#define WPA_DRIVER_FLAGS_WIRED 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001878/** Driver provides separate commands for authentication and association (SME in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001879 * wpa_supplicant). */
1880#define WPA_DRIVER_FLAGS_SME 0x00000020
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001881/** Driver supports AP mode */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001882#define WPA_DRIVER_FLAGS_AP 0x00000040
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001883/** Driver needs static WEP key setup after association has been completed */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001884#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001885/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001886#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001887/** Driver supports concurrent P2P operations */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001888#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001889/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001890 * Driver uses the initial interface as a dedicated management interface, i.e.,
1891 * it cannot be used for P2P group operations or non-P2P purposes.
1892 */
1893#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001894/** This interface is P2P capable (P2P GO or P2P Client) */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001895#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001896/** Driver supports station and key removal when stopping an AP */
Dmitry Shmidta38abf92014-03-06 13:38:44 -08001897#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001898/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001899 * Driver uses the initial interface for P2P management interface and non-P2P
1900 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1901 * P2P group operations.
1902 */
1903#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001904/**
Hai Shalomc1a21442022-02-04 13:43:00 -08001905 * Driver is known to use valid error codes, i.e., when it indicates that
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001906 * something (e.g., association) fails, there was indeed a failure and the
1907 * operation does not end up getting completed successfully later.
1908 */
Hai Shalomc1a21442022-02-04 13:43:00 -08001909#define WPA_DRIVER_FLAGS_VALID_ERROR_CODES 0x00004000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001910/** Driver supports off-channel TX */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001911#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001912/** Driver indicates TX status events for EAPOL Data frames */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001913#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001914/** Driver indicates TX status events for Deauth/Disassoc frames */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001915#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001916/** Driver supports roaming (BSS selection) in firmware */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001917#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001918/** Driver supports operating as a TDLS peer */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001919#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001920/** Driver requires external TDLS setup/teardown/discovery */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001921#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001922/** Driver indicates support for Probe Response offloading in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001923#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001924/** Driver supports U-APSD in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001925#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001926/** Driver supports inactivity timer in AP mode */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001927#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001928/** Driver expects user space implementation of MLME in AP mode */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001929#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001930/** Driver supports SAE with user space SME */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001931#define WPA_DRIVER_FLAGS_SAE 0x02000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001932/** Driver makes use of OBSS scan mechanism in wpa_supplicant */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001933#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001934/** Driver supports IBSS (Ad-hoc) mode */
Dmitry Shmidt700a1372013-03-15 14:14:44 -07001935#define WPA_DRIVER_FLAGS_IBSS 0x08000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001936/** Driver supports radar detection */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07001937#define WPA_DRIVER_FLAGS_RADAR 0x10000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001938/** Driver supports a dedicated interface for P2P Device */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001939#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001940/** Driver supports QoS Mapping */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001941#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001942/** Driver supports CSA in AP mode */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001943#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001944/** Driver supports mesh */
1945#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1946/** Driver support ACS offload */
1947#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1948/** Driver supports key management offload */
1949#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1950/** Driver supports TDLS channel switching */
1951#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001952/** Driver supports IBSS with HT datarates */
1953#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001954/** Driver supports IBSS with VHT datarates */
1955#define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07001956/** Driver supports automatic band selection */
1957#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001958/** Driver supports simultaneous off-channel operations */
1959#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001960/** Driver supports full AP client state */
1961#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001962/** Driver supports P2P Listen offload */
1963#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001964/** Driver supports FILS */
1965#define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001966/** Driver supports Beacon frame TX rate configuration (legacy rates) */
1967#define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1968/** Driver supports Beacon frame TX rate configuration (HT rates) */
1969#define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1970/** Driver supports Beacon frame TX rate configuration (VHT rates) */
1971#define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08001972/** Driver supports mgmt_tx with random TX address in non-connected state */
1973#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
1974/** Driver supports mgmt_tx with random TX addr in connected state */
1975#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
1976/** Driver supports better BSS reporting with sched_scan in connected mode */
1977#define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
1978/** Driver supports HE capabilities */
1979#define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001980/** Driver supports FILS shared key offload */
1981#define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
1982/** Driver supports all OCE STA specific mandatory features */
1983#define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
1984/** Driver supports all OCE AP specific mandatory features */
1985#define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
1986/**
1987 * Driver supports all OCE STA-CFON specific mandatory features only.
1988 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
1989 * userspace shall assume that this driver may not support all OCE AP
1990 * functionality but can support only OCE STA-CFON functionality.
1991 */
1992#define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
Roshan Pius3a1667e2018-07-03 15:17:14 -07001993/** Driver supports MFP-optional in the connect command */
1994#define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL
Hai Shalom39ba6fc2019-01-22 12:40:38 -08001995/** Driver is a self-managed regulatory device */
1996#define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL
Hai Shalom74f70d42019-02-11 14:42:39 -08001997/** Driver supports FTM responder functionality */
1998#define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL
1999/** Driver support 4-way handshake offload for WPA-Personal */
2000#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
Hai Shalomb755a2a2020-04-23 21:49:02 -07002001/** Driver supports a separate control port TX for EAPOL frames */
Hai Shalomfdcde762020-04-02 11:19:20 -07002002#define WPA_DRIVER_FLAGS_CONTROL_PORT 0x0400000000000000ULL
2003/** Driver supports VLAN offload */
2004#define WPA_DRIVER_FLAGS_VLAN_OFFLOAD 0x0800000000000000ULL
2005/** Driver supports UPDATE_FT_IES command */
2006#define WPA_DRIVER_FLAGS_UPDATE_FT_IES 0x1000000000000000ULL
2007/** Driver can correctly rekey PTKs without Extended Key ID */
2008#define WPA_DRIVER_FLAGS_SAFE_PTK0_REKEYS 0x2000000000000000ULL
2009/** Driver supports Beacon protection */
2010#define WPA_DRIVER_FLAGS_BEACON_PROTECTION 0x4000000000000000ULL
2011/** Driver supports Extended Key ID */
2012#define WPA_DRIVER_FLAGS_EXTENDED_KEY_ID 0x8000000000000000ULL
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002013 u64 flags;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002014
Hai Shalomb755a2a2020-04-23 21:49:02 -07002015/** Driver supports a separate control port RX for EAPOL frames */
2016#define WPA_DRIVER_FLAGS2_CONTROL_PORT_RX 0x0000000000000001ULL
Hai Shalom899fcc72020-10-19 14:38:18 -07002017/** Driver supports TX status reports for EAPOL frames through control port */
2018#define WPA_DRIVER_FLAGS2_CONTROL_PORT_TX_STATUS 0x0000000000000002ULL
Hai Shalom60840252021-02-19 19:02:11 -08002019/** Driver supports secure LTF */
2020#define WPA_DRIVER_FLAGS2_SEC_LTF 0x0000000000000004ULL
2021/** Driver supports secure RTT measurement exchange */
2022#define WPA_DRIVER_FLAGS2_SEC_RTT 0x0000000000000008ULL
2023/**
2024 * Driver supports protection of range negotiation and measurement management
2025 * frames
2026 */
2027#define WPA_DRIVER_FLAGS2_PROT_RANGE_NEG 0x0000000000000010ULL
2028/** Driver supports Beacon frame TX rate configuration (HE rates) */
2029#define WPA_DRIVER_FLAGS2_BEACON_RATE_HE 0x0000000000000020ULL
2030/** Driver supports Beacon protection only in client mode */
2031#define WPA_DRIVER_FLAGS2_BEACON_PROTECTION_CLIENT 0x0000000000000040ULL
2032/** Driver supports Operating Channel Validation */
2033#define WPA_DRIVER_FLAGS2_OCV 0x0000000000000080ULL
2034/** Driver expects user space implementation of SME in AP mode */
2035#define WPA_DRIVER_FLAGS2_AP_SME 0x0000000000000100ULL
Hai Shalomb755a2a2020-04-23 21:49:02 -07002036 u64 flags2;
2037
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002038#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
2039 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
2040
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002041 unsigned int wmm_ac_supported:1;
2042
2043 unsigned int mac_addr_rand_scan_supported:1;
2044 unsigned int mac_addr_rand_sched_scan_supported:1;
2045
2046 /** Maximum number of supported active probe SSIDs */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002047 int max_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002048
2049 /** Maximum number of supported active probe SSIDs for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002050 int max_sched_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002051
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08002052 /** Maximum number of supported scan plans for scheduled scan */
2053 unsigned int max_sched_scan_plans;
2054
2055 /** Maximum interval in a scan plan. In seconds */
2056 u32 max_sched_scan_plan_interval;
2057
2058 /** Maximum number of iterations in a single scan plan */
2059 u32 max_sched_scan_plan_iterations;
2060
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002061 /** Whether sched_scan (offloaded scanning) is supported */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002062 int sched_scan_supported;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002063
2064 /** Maximum number of supported match sets for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002065 int max_match_sets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002066
2067 /**
2068 * max_remain_on_chan - Maximum remain-on-channel duration in msec
2069 */
2070 unsigned int max_remain_on_chan;
2071
2072 /**
2073 * max_stations - Maximum number of associated stations the driver
2074 * supports in AP mode
2075 */
2076 unsigned int max_stations;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002077
2078 /**
2079 * probe_resp_offloads - Bitmap of supported protocols by the driver
2080 * for Probe Response offloading.
2081 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002082/** Driver Probe Response offloading support for WPS ver. 1 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002083#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002084/** Driver Probe Response offloading support for WPS ver. 2 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002085#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002086/** Driver Probe Response offloading support for P2P */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002087#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002088/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002089#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
2090 unsigned int probe_resp_offloads;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07002091
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002092 unsigned int max_acl_mac_addrs;
2093
Dmitry Shmidt444d5672013-04-01 13:08:44 -07002094 /**
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07002095 * Number of supported concurrent channels
2096 */
2097 unsigned int num_multichan_concurrent;
2098
2099 /**
Dmitry Shmidt444d5672013-04-01 13:08:44 -07002100 * extended_capa - extended capabilities in driver/device
2101 *
2102 * Must be allocated and freed by driver and the pointers must be
2103 * valid for the lifetime of the driver, i.e., freed in deinit()
2104 */
2105 const u8 *extended_capa, *extended_capa_mask;
2106 unsigned int extended_capa_len;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07002107
2108 struct wowlan_triggers wowlan_triggers;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002109
2110/** Driver adds the DS Params Set IE in Probe Request frames */
2111#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
2112/** Driver adds the WFA TPC IE in Probe Request frames */
2113#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
2114/** Driver handles quiet period requests */
2115#define WPA_DRIVER_FLAGS_QUIET 0x00000004
2116/**
2117 * Driver is capable of inserting the current TX power value into the body of
2118 * transmitted frames.
2119 * Background: Some Action frames include a TPC Report IE. This IE contains a
2120 * TX power field, which has to be updated by lower layers. One such Action
2121 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
2122 * of spectrum management). Note that this insertion takes place at a fixed
2123 * offset, namely the 6th byte in the Action frame body.
2124 */
2125#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
Dmitry Shmidt849734c2016-05-27 09:59:01 -07002126/**
2127 * Driver supports RRM. With this support, the driver will accept to use RRM in
2128 * (Re)Association Request frames, without supporting quiet period.
2129 */
2130#define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
2131
Dmitry Shmidt29333592017-01-09 12:27:11 -08002132/** Driver supports setting the scan dwell time */
2133#define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
2134/** Driver supports Beacon Report Measurement */
2135#define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
2136
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002137 u32 rrm_flags;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002138
2139 /* Driver concurrency capabilities */
2140 unsigned int conc_capab;
2141 /* Maximum number of concurrent channels on 2.4 GHz */
2142 unsigned int max_conc_chan_2_4;
2143 /* Maximum number of concurrent channels on 5 GHz */
2144 unsigned int max_conc_chan_5_0;
2145
2146 /* Maximum number of supported CSA counters */
2147 u16 max_csa_counters;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002148};
2149
2150
2151struct hostapd_data;
2152
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002153#define STA_DRV_DATA_TX_MCS BIT(0)
2154#define STA_DRV_DATA_RX_MCS BIT(1)
2155#define STA_DRV_DATA_TX_VHT_MCS BIT(2)
2156#define STA_DRV_DATA_RX_VHT_MCS BIT(3)
2157#define STA_DRV_DATA_TX_VHT_NSS BIT(4)
2158#define STA_DRV_DATA_RX_VHT_NSS BIT(5)
2159#define STA_DRV_DATA_TX_SHORT_GI BIT(6)
2160#define STA_DRV_DATA_RX_SHORT_GI BIT(7)
Roshan Pius3a1667e2018-07-03 15:17:14 -07002161#define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
Hai Shalomc1a21442022-02-04 13:43:00 -08002162#define STA_DRV_DATA_CONN_TIME BIT(9)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002163
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002164struct hostap_sta_driver_data {
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002165 unsigned long rx_packets, tx_packets;
2166 unsigned long long rx_bytes, tx_bytes;
Hai Shalom81f62d82019-07-22 12:10:00 -07002167 unsigned long long rx_airtime, tx_airtime;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002168 int bytes_64bit; /* whether 64-bit byte counters are supported */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002169 unsigned long current_tx_rate;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002170 unsigned long current_rx_rate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002171 unsigned long inactive_msec;
Hai Shalomc1a21442022-02-04 13:43:00 -08002172 unsigned long connected_sec;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002173 unsigned long flags; /* bitfield of STA_DRV_DATA_* */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002174 unsigned long num_ps_buf_frames;
2175 unsigned long tx_retry_failed;
2176 unsigned long tx_retry_count;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002177 s8 last_ack_rssi;
Hai Shalom81f62d82019-07-22 12:10:00 -07002178 unsigned long backlog_packets;
2179 unsigned long backlog_bytes;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002180 s8 signal;
2181 u8 rx_vhtmcs;
2182 u8 tx_vhtmcs;
2183 u8 rx_mcs;
2184 u8 tx_mcs;
2185 u8 rx_vht_nss;
2186 u8 tx_vht_nss;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002187};
2188
2189struct hostapd_sta_add_params {
2190 const u8 *addr;
2191 u16 aid;
2192 u16 capability;
2193 const u8 *supp_rates;
2194 size_t supp_rates_len;
2195 u16 listen_interval;
2196 const struct ieee80211_ht_capabilities *ht_capabilities;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08002197 const struct ieee80211_vht_capabilities *vht_capabilities;
Dmitry Shmidtbd14a572014-02-18 10:33:49 -08002198 int vht_opmode_enabled;
2199 u8 vht_opmode;
Hai Shalom81f62d82019-07-22 12:10:00 -07002200 const struct ieee80211_he_capabilities *he_capab;
2201 size_t he_capab_len;
Hai Shalom4fbc08f2020-05-18 12:37:00 -07002202 const struct ieee80211_he_6ghz_band_cap *he_6ghz_capab;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002203 u32 flags; /* bitmask of WPA_STA_* flags */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002204 u32 flags_mask; /* unset bits in flags */
2205#ifdef CONFIG_MESH
2206 enum mesh_plink_state plink_state;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07002207 u16 peer_aid;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002208#endif /* CONFIG_MESH */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002209 int set; /* Set STA parameters instead of add */
2210 u8 qosinfo;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08002211 const u8 *ext_capab;
2212 size_t ext_capab_len;
Dmitry Shmidt344abd32014-01-14 13:17:00 -08002213 const u8 *supp_channels;
2214 size_t supp_channels_len;
2215 const u8 *supp_oper_classes;
2216 size_t supp_oper_classes_len;
Dmitry Shmidt849734c2016-05-27 09:59:01 -07002217 int support_p2p_ps;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002218};
2219
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002220struct mac_address {
2221 u8 addr[ETH_ALEN];
2222};
2223
2224struct hostapd_acl_params {
2225 u8 acl_policy;
2226 unsigned int num_mac_acl;
2227 struct mac_address mac_acl[0];
2228};
2229
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002230struct wpa_init_params {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002231 void *global_priv;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002232 const u8 *bssid;
2233 const char *ifname;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002234 const char *driver_params;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002235 int use_pae_group_addr;
2236 char **bridge;
2237 size_t num_bridge;
2238
2239 u8 *own_addr; /* buffer for writing own MAC address */
2240};
2241
2242
2243struct wpa_bss_params {
2244 /** Interface name (for multi-SSID/VLAN support) */
2245 const char *ifname;
2246 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
2247 int enabled;
2248
2249 int wpa;
2250 int ieee802_1x;
2251 int wpa_group;
2252 int wpa_pairwise;
2253 int wpa_key_mgmt;
2254 int rsn_preauth;
2255 enum mfp_options ieee80211w;
2256};
2257
2258#define WPA_STA_AUTHORIZED BIT(0)
2259#define WPA_STA_WMM BIT(1)
2260#define WPA_STA_SHORT_PREAMBLE BIT(2)
2261#define WPA_STA_MFP BIT(3)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002262#define WPA_STA_TDLS_PEER BIT(4)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002263#define WPA_STA_AUTHENTICATED BIT(5)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002264#define WPA_STA_ASSOCIATED BIT(6)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002265
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002266enum tdls_oper {
2267 TDLS_DISCOVERY_REQ,
2268 TDLS_SETUP,
2269 TDLS_TEARDOWN,
2270 TDLS_ENABLE_LINK,
2271 TDLS_DISABLE_LINK,
2272 TDLS_ENABLE,
2273 TDLS_DISABLE
2274};
2275
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002276enum wnm_oper {
2277 WNM_SLEEP_ENTER_CONFIRM,
2278 WNM_SLEEP_ENTER_FAIL,
2279 WNM_SLEEP_EXIT_CONFIRM,
2280 WNM_SLEEP_EXIT_FAIL,
2281 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
2282 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
2283 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
2284 * a STA */
2285 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
2286 * for a STA */
2287 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
2288 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
2289 * for a STA */
2290 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
2291};
2292
Roshan Pius3a1667e2018-07-03 15:17:14 -07002293/* enum smps_mode - SMPS mode definitions */
2294enum smps_mode {
2295 SMPS_AUTOMATIC,
2296 SMPS_OFF,
2297 SMPS_DYNAMIC,
2298 SMPS_STATIC,
2299
2300 /* Keep last */
2301 SMPS_INVALID,
2302};
2303
Hai Shalom74f70d42019-02-11 14:42:39 -08002304#define WPA_INVALID_NOISE 9999
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002305
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002306/**
2307 * struct wpa_signal_info - Information about channel signal quality
Hai Shalom74f70d42019-02-11 14:42:39 -08002308 * @frequency: control frequency
2309 * @above_threshold: true if the above threshold was crossed
2310 * (relevant for a CQM event)
2311 * @current_signal: in dBm
2312 * @avg_signal: in dBm
2313 * @avg_beacon_signal: in dBm
2314 * @current_noise: %WPA_INVALID_NOISE if not supported
2315 * @current_txrate: current TX rate
2316 * @chanwidth: channel width
2317 * @center_frq1: center frequency for the first segment
2318 * @center_frq2: center frequency for the second segment (if relevant)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002319 */
2320struct wpa_signal_info {
2321 u32 frequency;
2322 int above_threshold;
2323 int current_signal;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002324 int avg_signal;
Dmitry Shmidtf73259c2015-03-17 11:00:54 -07002325 int avg_beacon_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002326 int current_noise;
2327 int current_txrate;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002328 enum chan_width chanwidth;
2329 int center_frq1;
2330 int center_frq2;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002331};
2332
2333/**
Hai Shalom74f70d42019-02-11 14:42:39 -08002334 * struct wpa_channel_info - Information about the current channel
2335 * @frequency: Center frequency of the primary 20 MHz channel
2336 * @chanwidth: Width of the current operating channel
2337 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
2338 * This field is only filled in when using a 40 MHz channel.
2339 * @center_frq1: Center frequency of frequency segment 0
2340 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
2341 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
2342 * derived from center_frq2 for convenience.
2343 */
2344struct wpa_channel_info {
2345 u32 frequency;
2346 enum chan_width chanwidth;
2347 int sec_channel;
2348 int center_frq1;
2349 int center_frq2;
2350 u8 seg1_idx;
2351};
2352
2353/**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002354 * struct beacon_data - Beacon data
2355 * @head: Head portion of Beacon frame (before TIM IE)
2356 * @tail: Tail portion of Beacon frame (after TIM IE)
2357 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2358 * @proberesp_ies: Extra information element(s) to add into Probe Response
2359 * frames or %NULL
2360 * @assocresp_ies: Extra information element(s) to add into (Re)Association
2361 * Response frames or %NULL
2362 * @probe_resp: Probe Response frame template
2363 * @head_len: Length of @head
2364 * @tail_len: Length of @tail
2365 * @beacon_ies_len: Length of beacon_ies in octets
2366 * @proberesp_ies_len: Length of proberesp_ies in octets
2367 * @proberesp_ies_len: Length of proberesp_ies in octets
2368 * @probe_resp_len: Length of probe response template (@probe_resp)
2369 */
2370struct beacon_data {
2371 u8 *head, *tail;
2372 u8 *beacon_ies;
2373 u8 *proberesp_ies;
2374 u8 *assocresp_ies;
2375 u8 *probe_resp;
2376
2377 size_t head_len, tail_len;
2378 size_t beacon_ies_len;
2379 size_t proberesp_ies_len;
2380 size_t assocresp_ies_len;
2381 size_t probe_resp_len;
2382};
2383
2384/**
2385 * struct csa_settings - Settings for channel switch command
2386 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2387 * @block_tx: 1 - block transmission for CSA period
2388 * @freq_params: Next channel frequency parameter
2389 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2390 * @beacon_after: Next beacon/probe resp/asooc resp info
2391 * @counter_offset_beacon: Offset to the count field in beacon's tail
2392 * @counter_offset_presp: Offset to the count field in probe resp.
2393 */
2394struct csa_settings {
2395 u8 cs_count;
2396 u8 block_tx;
2397
2398 struct hostapd_freq_params freq_params;
2399 struct beacon_data beacon_csa;
2400 struct beacon_data beacon_after;
2401
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002402 u16 counter_offset_beacon[2];
2403 u16 counter_offset_presp[2];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002404};
2405
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002406/* TDLS peer capabilities for send_tdls_mgmt() */
2407enum tdls_peer_capability {
2408 TDLS_PEER_HT = BIT(0),
2409 TDLS_PEER_VHT = BIT(1),
2410 TDLS_PEER_WMM = BIT(2),
Hai Shalomc1a21442022-02-04 13:43:00 -08002411 TDLS_PEER_HE = BIT(3),
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002412};
2413
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002414/* valid info in the wmm_params struct */
2415enum wmm_params_valid_info {
2416 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
2417};
2418
2419/**
2420 * struct wmm_params - WMM parameterss configured for this association
2421 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2422 * of the struct contain valid information.
2423 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2424 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2425 */
2426struct wmm_params {
2427 u8 info_bitmap;
2428 u8 uapsd_queues;
2429};
2430
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002431#ifdef CONFIG_MACSEC
2432struct macsec_init_params {
Hai Shalome21d4e82020-04-29 16:34:06 -07002433 bool always_include_sci;
2434 bool use_es;
2435 bool use_scb;
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002436};
2437#endif /* CONFIG_MACSEC */
2438
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002439enum drv_br_port_attr {
2440 DRV_BR_PORT_ATTR_PROXYARP,
2441 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
2442};
2443
2444enum drv_br_net_param {
2445 DRV_BR_NET_PARAM_GARP_ACCEPT,
Dmitry Shmidt83474442015-04-15 13:47:09 -07002446 DRV_BR_MULTICAST_SNOOPING,
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002447};
2448
2449struct drv_acs_params {
2450 /* Selected mode (HOSTAPD_MODE_*) */
2451 enum hostapd_hw_mode hw_mode;
2452
2453 /* Indicates whether HT is enabled */
2454 int ht_enabled;
2455
2456 /* Indicates whether HT40 is enabled */
2457 int ht40_enabled;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07002458
2459 /* Indicates whether VHT is enabled */
2460 int vht_enabled;
2461
2462 /* Configured ACS channel width */
2463 u16 ch_width;
2464
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08002465 /* ACS frequency list info */
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002466 const int *freq_list;
Hai Shalomfdcde762020-04-02 11:19:20 -07002467
2468 /* Indicates whether EDMG is enabled */
2469 int edmg_enabled;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002470};
2471
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002472struct wpa_bss_trans_info {
2473 u8 mbo_transition_reason;
2474 u8 n_candidates;
2475 u8 *bssid;
2476};
2477
2478struct wpa_bss_candidate_info {
2479 u8 num;
2480 struct candidate_list {
2481 u8 bssid[ETH_ALEN];
2482 u8 is_accept;
2483 u32 reject_reason;
2484 } *candidates;
2485};
2486
2487struct wpa_pmkid_params {
2488 const u8 *bssid;
2489 const u8 *ssid;
2490 size_t ssid_len;
2491 const u8 *fils_cache_id;
2492 const u8 *pmkid;
2493 const u8 *pmk;
2494 size_t pmk_len;
Hai Shalomfdcde762020-04-02 11:19:20 -07002495 u32 pmk_lifetime;
2496 u8 pmk_reauth_threshold;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002497};
2498
2499/* Mask used to specify which connection parameters have to be updated */
2500enum wpa_drv_update_connect_params_mask {
2501 WPA_DRV_UPDATE_ASSOC_IES = BIT(0),
2502 WPA_DRV_UPDATE_FILS_ERP_INFO = BIT(1),
2503 WPA_DRV_UPDATE_AUTH_TYPE = BIT(2),
Vinayak Yadawade62409f2022-01-20 12:32:07 +05302504#ifdef CONFIG_DRIVER_NL80211_BRCM
2505 WPA_DRV_UPDATE_TD_POLICY = BIT(3),
2506#endif /* CONFIG_DRIVER_NL80211_BRCM */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002507};
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002508
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002509/**
Roshan Pius3a1667e2018-07-03 15:17:14 -07002510 * struct external_auth - External authentication trigger parameters
2511 *
2512 * These are used across the external authentication request and event
2513 * interfaces.
2514 * @action: Action type / trigger for external authentication. Only significant
2515 * for the event interface.
2516 * @bssid: BSSID of the peer with which the authentication has to happen. Used
2517 * by both the request and event interface.
2518 * @ssid: SSID of the AP. Used by both the request and event interface.
2519 * @ssid_len: SSID length in octets.
2520 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2521 * the request interface.
2522 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2523 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2524 * the real status code for failures. Used only for the request interface
2525 * from user space to the driver.
Hai Shalom5f92bc92019-04-18 11:54:11 -07002526 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
Roshan Pius3a1667e2018-07-03 15:17:14 -07002527 */
2528struct external_auth {
2529 enum {
2530 EXT_AUTH_START,
2531 EXT_AUTH_ABORT,
2532 } action;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002533 const u8 *bssid;
2534 const u8 *ssid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002535 size_t ssid_len;
2536 unsigned int key_mgmt_suite;
2537 u16 status;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002538 const u8 *pmkid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002539};
2540
Hai Shalom60840252021-02-19 19:02:11 -08002541/* enum nested_attr - Used to specify if subcommand uses nested attributes */
2542enum nested_attr {
2543 NESTED_ATTR_NOT_USED = 0,
2544 NESTED_ATTR_USED = 1,
2545 NESTED_ATTR_UNSPECIFIED = 2,
2546};
2547
Roshan Pius3a1667e2018-07-03 15:17:14 -07002548/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002549 * struct wpa_driver_ops - Driver interface API definition
2550 *
2551 * This structure defines the API that each driver interface needs to implement
2552 * for core wpa_supplicant code. All driver specific functionality is captured
2553 * in this wrapper.
2554 */
2555struct wpa_driver_ops {
2556 /** Name of the driver interface */
2557 const char *name;
2558 /** One line description of the driver interface */
2559 const char *desc;
2560
2561 /**
2562 * get_bssid - Get the current BSSID
2563 * @priv: private driver interface data
2564 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2565 *
2566 * Returns: 0 on success, -1 on failure
2567 *
2568 * Query kernel driver for the current BSSID and copy it to bssid.
2569 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2570 * associated.
2571 */
2572 int (*get_bssid)(void *priv, u8 *bssid);
2573
2574 /**
2575 * get_ssid - Get the current SSID
2576 * @priv: private driver interface data
2577 * @ssid: buffer for SSID (at least 32 bytes)
2578 *
2579 * Returns: Length of the SSID on success, -1 on failure
2580 *
2581 * Query kernel driver for the current SSID and copy it to ssid.
2582 * Returning zero is recommended if the STA is not associated.
2583 *
2584 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2585 * can, at least in theory, contain control characters (including nul)
2586 * and as such, should be processed as binary data, not a printable
2587 * string.
2588 */
2589 int (*get_ssid)(void *priv, u8 *ssid);
2590
2591 /**
2592 * set_key - Configure encryption key
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002593 * @priv: private driver interface data
Hai Shalomfdcde762020-04-02 11:19:20 -07002594 * @params: Key parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002595 * Returns: 0 on success, -1 on failure
2596 *
2597 * Configure the given key for the kernel driver. If the driver
2598 * supports separate individual keys (4 default keys + 1 individual),
2599 * addr can be used to determine whether the key is default or
2600 * individual. If only 4 keys are supported, the default key with key
2601 * index 0 is used as the individual key. STA must be configured to use
2602 * it as the default Tx key (set_tx is set) and accept Rx for all the
2603 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2604 * broadcast keys, so key index 0 is available for this kind of
2605 * configuration.
2606 *
2607 * Please note that TKIP keys include separate TX and RX MIC keys and
2608 * some drivers may expect them in different order than wpa_supplicant
2609 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
2610 * will trigger Michael MIC errors. This can be fixed by changing the
2611 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
2612 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2613 * example on how this can be done.
2614 */
Hai Shalomfdcde762020-04-02 11:19:20 -07002615 int (*set_key)(void *priv, struct wpa_driver_set_key_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002616
2617 /**
2618 * init - Initialize driver interface
2619 * @ctx: context to be used when calling wpa_supplicant functions,
2620 * e.g., wpa_supplicant_event()
2621 * @ifname: interface name, e.g., wlan0
2622 *
2623 * Returns: Pointer to private data, %NULL on failure
2624 *
2625 * Initialize driver interface, including event processing for kernel
2626 * driver events (e.g., associated, scan results, Michael MIC failure).
2627 * This function can allocate a private configuration data area for
2628 * @ctx, file descriptor, interface name, etc. information that may be
2629 * needed in future driver operations. If this is not used, non-NULL
2630 * value will need to be returned because %NULL is used to indicate
2631 * failure. The returned value will be used as 'void *priv' data for
2632 * all other driver_ops functions.
2633 *
2634 * The main event loop (eloop.c) of wpa_supplicant can be used to
2635 * register callback for read sockets (eloop_register_read_sock()).
2636 *
2637 * See below for more information about events and
2638 * wpa_supplicant_event() function.
2639 */
2640 void * (*init)(void *ctx, const char *ifname);
2641
2642 /**
2643 * deinit - Deinitialize driver interface
2644 * @priv: private driver interface data from init()
2645 *
2646 * Shut down driver interface and processing of driver events. Free
2647 * private data buffer if one was allocated in init() handler.
2648 */
2649 void (*deinit)(void *priv);
2650
2651 /**
2652 * set_param - Set driver configuration parameters
2653 * @priv: private driver interface data from init()
2654 * @param: driver specific configuration parameters
2655 *
2656 * Returns: 0 on success, -1 on failure
2657 *
2658 * Optional handler for notifying driver interface about configuration
2659 * parameters (driver_param).
2660 */
2661 int (*set_param)(void *priv, const char *param);
2662
2663 /**
2664 * set_countermeasures - Enable/disable TKIP countermeasures
2665 * @priv: private driver interface data
2666 * @enabled: 1 = countermeasures enabled, 0 = disabled
2667 *
2668 * Returns: 0 on success, -1 on failure
2669 *
2670 * Configure TKIP countermeasures. When these are enabled, the driver
2671 * should drop all received and queued frames that are using TKIP.
2672 */
2673 int (*set_countermeasures)(void *priv, int enabled);
2674
2675 /**
2676 * deauthenticate - Request driver to deauthenticate
2677 * @priv: private driver interface data
2678 * @addr: peer address (BSSID of the AP)
2679 * @reason_code: 16-bit reason code to be sent in the deauthentication
2680 * frame
2681 *
2682 * Returns: 0 on success, -1 on failure
2683 */
Hai Shalom81f62d82019-07-22 12:10:00 -07002684 int (*deauthenticate)(void *priv, const u8 *addr, u16 reason_code);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002685
2686 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002687 * associate - Request driver to associate
2688 * @priv: private driver interface data
2689 * @params: association parameters
2690 *
2691 * Returns: 0 on success, -1 on failure
2692 */
2693 int (*associate)(void *priv,
2694 struct wpa_driver_associate_params *params);
2695
2696 /**
2697 * add_pmkid - Add PMKSA cache entry to the driver
2698 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002699 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002700 *
2701 * Returns: 0 on success, -1 on failure
2702 *
2703 * This function is called when a new PMK is received, as a result of
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002704 * either normal authentication or RSN pre-authentication. The PMKSA
2705 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2706 * ssid, fils_cache_id, pmkid, and pmk.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002707 *
2708 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2709 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2710 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2711 * driver_ops function does not need to be implemented. Likewise, if
2712 * the driver does not support WPA, this function is not needed.
2713 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002714 int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002715
2716 /**
2717 * remove_pmkid - Remove PMKSA cache entry to the driver
2718 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002719 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002720 *
2721 * Returns: 0 on success, -1 on failure
2722 *
2723 * This function is called when the supplicant drops a PMKSA cache
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002724 * entry for any reason. The PMKSA parameters are either a set of
2725 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002726 *
2727 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2728 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2729 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2730 * from wpa_supplicant, this driver_ops function does not need to be
2731 * implemented. Likewise, if the driver does not support WPA, this
2732 * function is not needed.
2733 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002734 int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002735
2736 /**
2737 * flush_pmkid - Flush PMKSA cache
2738 * @priv: private driver interface data
2739 *
2740 * Returns: 0 on success, -1 on failure
2741 *
2742 * This function is called when the supplicant drops all PMKSA cache
2743 * entries for any reason.
2744 *
2745 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2746 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2747 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2748 * from wpa_supplicant, this driver_ops function does not need to be
2749 * implemented. Likewise, if the driver does not support WPA, this
2750 * function is not needed.
2751 */
2752 int (*flush_pmkid)(void *priv);
2753
2754 /**
2755 * get_capa - Get driver capabilities
2756 * @priv: private driver interface data
2757 *
2758 * Returns: 0 on success, -1 on failure
2759 *
2760 * Get driver/firmware/hardware capabilities.
2761 */
2762 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
2763
2764 /**
2765 * poll - Poll driver for association information
2766 * @priv: private driver interface data
2767 *
2768 * This is an option callback that can be used when the driver does not
2769 * provide event mechanism for association events. This is called when
2770 * receiving WPA EAPOL-Key messages that require association
2771 * information. The driver interface is supposed to generate associnfo
2772 * event before returning from this callback function. In addition, the
2773 * driver interface should generate an association event after having
2774 * sent out associnfo.
2775 */
2776 void (*poll)(void *priv);
2777
2778 /**
Dmitry Shmidte4663042016-04-04 10:07:49 -07002779 * get_ifindex - Get interface index
2780 * @priv: private driver interface data
2781 *
2782 * Returns: Interface index
2783 */
2784 unsigned int (*get_ifindex)(void *priv);
2785
2786 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002787 * get_ifname - Get interface name
2788 * @priv: private driver interface data
2789 *
2790 * Returns: Pointer to the interface name. This can differ from the
2791 * interface name used in init() call. Init() is called first.
2792 *
2793 * This optional function can be used to allow the driver interface to
2794 * replace the interface name with something else, e.g., based on an
2795 * interface mapping from a more descriptive name.
2796 */
2797 const char * (*get_ifname)(void *priv);
2798
2799 /**
2800 * get_mac_addr - Get own MAC address
2801 * @priv: private driver interface data
2802 *
2803 * Returns: Pointer to own MAC address or %NULL on failure
2804 *
2805 * This optional function can be used to get the own MAC address of the
2806 * device from the driver interface code. This is only needed if the
2807 * l2_packet implementation for the OS does not provide easy access to
2808 * a MAC address. */
2809 const u8 * (*get_mac_addr)(void *priv);
2810
2811 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002812 * set_operstate - Sets device operating state to DORMANT or UP
2813 * @priv: private driver interface data
2814 * @state: 0 = dormant, 1 = up
2815 * Returns: 0 on success, -1 on failure
2816 *
2817 * This is an optional function that can be used on operating systems
2818 * that support a concept of controlling network device state from user
2819 * space applications. This function, if set, gets called with
2820 * state = 1 when authentication has been completed and with state = 0
2821 * when connection is lost.
2822 */
2823 int (*set_operstate)(void *priv, int state);
2824
2825 /**
2826 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2827 * @priv: Private driver interface data
2828 * @addr: Address of the station for which to set protection (may be
2829 * %NULL for group keys)
2830 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2831 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2832 * Returns: 0 on success, -1 on failure
2833 *
2834 * This is an optional function that can be used to set the driver to
2835 * require protection for Tx and/or Rx frames. This uses the layer
2836 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2837 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2838 * set protection operation; instead, they set protection implicitly
2839 * based on configured keys.
2840 */
2841 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2842 int key_type);
2843
2844 /**
2845 * get_hw_feature_data - Get hardware support data (channels and rates)
2846 * @priv: Private driver interface data
2847 * @num_modes: Variable for returning the number of returned modes
2848 * flags: Variable for returning hardware feature flags
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002849 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002850 * Returns: Pointer to allocated hardware data on success or %NULL on
2851 * failure. Caller is responsible for freeing this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002852 */
2853 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2854 u16 *num_modes,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002855 u16 *flags, u8 *dfs);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002856
2857 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002858 * send_mlme - Send management frame from MLME
2859 * @priv: Private driver interface data
2860 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2861 * @data_len: Size of the management frame
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002862 * @noack: Do not wait for this frame to be acked (disable retries)
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07002863 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2864 * driver decide
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002865 * @csa_offs: Array of CSA offsets or %NULL
2866 * @csa_offs_len: Number of elements in csa_offs
Hai Shalomfdcde762020-04-02 11:19:20 -07002867 * @no_encrypt: Do not encrypt frame even if appropriate key exists
2868 * (used only for testing purposes)
2869 * @wait: Time to wait off-channel for a response (in ms), or zero
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002870 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002871 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002872 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002873 int noack, unsigned int freq, const u16 *csa_offs,
Hai Shalomfdcde762020-04-02 11:19:20 -07002874 size_t csa_offs_len, int no_encrypt,
2875 unsigned int wait);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002876
2877 /**
2878 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2879 * @priv: Private driver interface data
2880 * @md: Mobility domain (2 octets) (also included inside ies)
2881 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2882 * @ies_len: Length of FT IEs in bytes
2883 * Returns: 0 on success, -1 on failure
2884 *
2885 * The supplicant uses this callback to let the driver know that keying
2886 * material for FT is available and that the driver can use the
2887 * provided IEs in the next message in FT authentication sequence.
2888 *
2889 * This function is only needed for driver that support IEEE 802.11r
2890 * (Fast BSS Transition).
2891 */
2892 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2893 size_t ies_len);
2894
2895 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002896 * get_scan_results2 - Fetch the latest scan results
2897 * @priv: private driver interface data
2898 *
2899 * Returns: Allocated buffer of scan results (caller is responsible for
2900 * freeing the data structure) on success, NULL on failure
2901 */
2902 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2903
2904 /**
2905 * set_country - Set country
2906 * @priv: Private driver interface data
2907 * @alpha2: country to which to switch to
2908 * Returns: 0 on success, -1 on failure
2909 *
2910 * This function is for drivers which support some form
2911 * of setting a regulatory domain.
2912 */
2913 int (*set_country)(void *priv, const char *alpha2);
2914
2915 /**
Dmitry Shmidtcce06662013-11-04 18:44:24 -08002916 * get_country - Get country
2917 * @priv: Private driver interface data
2918 * @alpha2: Buffer for returning country code (at least 3 octets)
2919 * Returns: 0 on success, -1 on failure
2920 */
2921 int (*get_country)(void *priv, char *alpha2);
2922
2923 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002924 * global_init - Global driver initialization
Dmitry Shmidte4663042016-04-04 10:07:49 -07002925 * @ctx: wpa_global pointer
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002926 * Returns: Pointer to private data (global), %NULL on failure
2927 *
2928 * This optional function is called to initialize the driver wrapper
2929 * for global data, i.e., data that applies to all interfaces. If this
2930 * function is implemented, global_deinit() will also need to be
2931 * implemented to free the private data. The driver will also likely
2932 * use init2() function instead of init() to get the pointer to global
2933 * data available to per-interface initializer.
2934 */
Dmitry Shmidte4663042016-04-04 10:07:49 -07002935 void * (*global_init)(void *ctx);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002936
2937 /**
2938 * global_deinit - Global driver deinitialization
2939 * @priv: private driver global data from global_init()
2940 *
2941 * Terminate any global driver related functionality and free the
2942 * global data structure.
2943 */
2944 void (*global_deinit)(void *priv);
2945
2946 /**
2947 * init2 - Initialize driver interface (with global data)
2948 * @ctx: context to be used when calling wpa_supplicant functions,
2949 * e.g., wpa_supplicant_event()
2950 * @ifname: interface name, e.g., wlan0
2951 * @global_priv: private driver global data from global_init()
2952 * Returns: Pointer to private data, %NULL on failure
2953 *
2954 * This function can be used instead of init() if the driver wrapper
2955 * uses global data.
2956 */
2957 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2958
2959 /**
2960 * get_interfaces - Get information about available interfaces
2961 * @global_priv: private driver global data from global_init()
2962 * Returns: Allocated buffer of interface information (caller is
2963 * responsible for freeing the data structure) on success, NULL on
2964 * failure
2965 */
2966 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2967
2968 /**
2969 * scan2 - Request the driver to initiate scan
2970 * @priv: private driver interface data
2971 * @params: Scan parameters
2972 *
2973 * Returns: 0 on success, -1 on failure
2974 *
2975 * Once the scan results are ready, the driver should report scan
2976 * results event for wpa_supplicant which will eventually request the
2977 * results with wpa_driver_get_scan_results2().
2978 */
2979 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2980
2981 /**
2982 * authenticate - Request driver to authenticate
2983 * @priv: private driver interface data
2984 * @params: authentication parameters
2985 * Returns: 0 on success, -1 on failure
2986 *
2987 * This is an optional function that can be used with drivers that
2988 * support separate authentication and association steps, i.e., when
2989 * wpa_supplicant can act as the SME. If not implemented, associate()
2990 * function is expected to take care of IEEE 802.11 authentication,
2991 * too.
2992 */
2993 int (*authenticate)(void *priv,
2994 struct wpa_driver_auth_params *params);
2995
2996 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002997 * set_ap - Set Beacon and Probe Response information for AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002998 * @priv: Private driver interface data
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002999 * @params: Parameters to use in AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003000 *
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003001 * This function is used to configure Beacon template and/or extra IEs
3002 * to add for Beacon and Probe Response frames for the driver in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003003 * AP mode. The driver is responsible for building the full Beacon
3004 * frame by concatenating the head part with TIM IE generated by the
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003005 * driver/firmware and finishing with the tail part. Depending on the
3006 * driver architectue, this can be done either by using the full
3007 * template or the set of additional IEs (e.g., WPS and P2P IE).
3008 * Similarly, Probe Response processing depends on the driver design.
3009 * If the driver (or firmware) takes care of replying to Probe Request
3010 * frames, the extra IEs provided here needs to be added to the Probe
3011 * Response frames.
3012 *
3013 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003014 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003015 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003016
3017 /**
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07003018 * set_acl - Set ACL in AP mode
3019 * @priv: Private driver interface data
3020 * @params: Parameters to configure ACL
3021 * Returns: 0 on success, -1 on failure
3022 *
3023 * This is used only for the drivers which support MAC address ACL.
3024 */
3025 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
3026
3027 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003028 * hapd_init - Initialize driver interface (hostapd only)
3029 * @hapd: Pointer to hostapd context
3030 * @params: Configuration for the driver wrapper
3031 * Returns: Pointer to private data, %NULL on failure
3032 *
3033 * This function is used instead of init() or init2() when the driver
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003034 * wrapper is used with hostapd.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003035 */
3036 void * (*hapd_init)(struct hostapd_data *hapd,
3037 struct wpa_init_params *params);
3038
3039 /**
3040 * hapd_deinit - Deinitialize driver interface (hostapd only)
3041 * @priv: Private driver interface data from hapd_init()
3042 */
3043 void (*hapd_deinit)(void *priv);
3044
3045 /**
3046 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
3047 * @priv: Private driver interface data
3048 * @params: BSS parameters
3049 * Returns: 0 on success, -1 on failure
3050 *
3051 * This is an optional function to configure the kernel driver to
3052 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
3053 * can be left undefined (set to %NULL) if IEEE 802.1X support is
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003054 * always enabled and the driver uses set_ap() to set WPA/RSN IE
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003055 * for Beacon frames.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003056 *
3057 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003058 */
3059 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
3060
3061 /**
3062 * set_privacy - Enable/disable privacy (AP only)
3063 * @priv: Private driver interface data
3064 * @enabled: 1 = privacy enabled, 0 = disabled
3065 * Returns: 0 on success, -1 on failure
3066 *
3067 * This is an optional function to configure privacy field in the
3068 * kernel driver for Beacon frames. This can be left undefined (set to
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003069 * %NULL) if the driver uses the Beacon template from set_ap().
3070 *
3071 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003072 */
3073 int (*set_privacy)(void *priv, int enabled);
3074
3075 /**
3076 * get_seqnum - Fetch the current TSC/packet number (AP only)
3077 * @ifname: The interface name (main or virtual)
3078 * @priv: Private driver interface data
3079 * @addr: MAC address of the station or %NULL for group keys
3080 * @idx: Key index
3081 * @seq: Buffer for returning the latest used TSC/packet number
3082 * Returns: 0 on success, -1 on failure
3083 *
3084 * This function is used to fetch the last used TSC/packet number for
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07003085 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
3086 * keys, so there is no strict requirement on implementing support for
3087 * unicast keys (i.e., addr != %NULL).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003088 */
3089 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
3090 int idx, u8 *seq);
3091
3092 /**
3093 * flush - Flush all association stations (AP only)
3094 * @priv: Private driver interface data
3095 * Returns: 0 on success, -1 on failure
3096 *
3097 * This function requests the driver to disassociate all associated
3098 * stations. This function does not need to be implemented if the
3099 * driver does not process association frames internally.
3100 */
3101 int (*flush)(void *priv);
3102
3103 /**
3104 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
3105 * @priv: Private driver interface data
3106 * @elem: Information elements
3107 * @elem_len: Length of the elem buffer in octets
3108 * Returns: 0 on success, -1 on failure
3109 *
3110 * This is an optional function to add information elements in the
3111 * kernel driver for Beacon and Probe Response frames. This can be left
3112 * undefined (set to %NULL) if the driver uses the Beacon template from
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003113 * set_ap().
3114 *
3115 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003116 */
3117 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
3118
3119 /**
Jouni Malinen1e6c57f2012-09-05 17:07:03 +03003120 * read_sta_data - Fetch station data
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003121 * @priv: Private driver interface data
3122 * @data: Buffer for returning station information
3123 * @addr: MAC address of the station
3124 * Returns: 0 on success, -1 on failure
3125 */
3126 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
3127 const u8 *addr);
3128
3129 /**
Hai Shalomfdcde762020-04-02 11:19:20 -07003130 * tx_control_port - Send a frame over the 802.1X controlled port
3131 * @priv: Private driver interface data
3132 * @dest: Destination MAC address
3133 * @proto: Ethertype in host byte order
3134 * @buf: Frame payload starting from IEEE 802.1X header
3135 * @len: Frame payload length
3136 * @no_encrypt: Do not encrypt frame
3137 *
3138 * Returns 0 on success, else an error
3139 *
3140 * This is like a normal Ethernet send except that the driver is aware
3141 * (by other means than the Ethertype) that this frame is special,
3142 * and more importantly it gains an ordering between the transmission of
3143 * the frame and other driver management operations such as key
3144 * installations. This can be used to work around known limitations in
3145 * IEEE 802.11 protocols such as race conditions between rekeying 4-way
3146 * handshake message 4/4 and a PTK being overwritten.
3147 *
3148 * This function is only used for a given interface if the driver
3149 * instance reports WPA_DRIVER_FLAGS_CONTROL_PORT capability. Otherwise,
3150 * API users will fall back to sending the frame via a normal socket.
3151 */
3152 int (*tx_control_port)(void *priv, const u8 *dest,
3153 u16 proto, const u8 *buf, size_t len,
3154 int no_encrypt);
3155
3156 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003157 * hapd_send_eapol - Send an EAPOL packet (AP only)
3158 * @priv: private driver interface data
3159 * @addr: Destination MAC address
3160 * @data: EAPOL packet starting with IEEE 802.1X header
3161 * @data_len: Length of the EAPOL packet in octets
3162 * @encrypt: Whether the frame should be encrypted
3163 * @own_addr: Source MAC address
3164 * @flags: WPA_STA_* flags for the destination station
3165 *
3166 * Returns: 0 on success, -1 on failure
3167 */
3168 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
3169 size_t data_len, int encrypt,
3170 const u8 *own_addr, u32 flags);
3171
3172 /**
3173 * sta_deauth - Deauthenticate a station (AP only)
3174 * @priv: Private driver interface data
3175 * @own_addr: Source address and BSSID for the Deauthentication frame
3176 * @addr: MAC address of the station to deauthenticate
3177 * @reason: Reason code for the Deauthentiation frame
3178 * Returns: 0 on success, -1 on failure
3179 *
3180 * This function requests a specific station to be deauthenticated and
3181 * a Deauthentication frame to be sent to it.
3182 */
3183 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07003184 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003185
3186 /**
3187 * sta_disassoc - Disassociate a station (AP only)
3188 * @priv: Private driver interface data
3189 * @own_addr: Source address and BSSID for the Disassociation frame
3190 * @addr: MAC address of the station to disassociate
3191 * @reason: Reason code for the Disassociation frame
3192 * Returns: 0 on success, -1 on failure
3193 *
3194 * This function requests a specific station to be disassociated and
3195 * a Disassociation frame to be sent to it.
3196 */
3197 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07003198 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003199
3200 /**
3201 * sta_remove - Remove a station entry (AP only)
3202 * @priv: Private driver interface data
3203 * @addr: MAC address of the station to be removed
3204 * Returns: 0 on success, -1 on failure
3205 */
3206 int (*sta_remove)(void *priv, const u8 *addr);
3207
3208 /**
3209 * hapd_get_ssid - Get the current SSID (AP only)
3210 * @priv: Private driver interface data
3211 * @buf: Buffer for returning the SSID
3212 * @len: Maximum length of the buffer
3213 * Returns: Length of the SSID on success, -1 on failure
3214 *
3215 * This function need not be implemented if the driver uses Beacon
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003216 * template from set_ap() and does not reply to Probe Request frames.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003217 */
3218 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
3219
3220 /**
3221 * hapd_set_ssid - Set SSID (AP only)
3222 * @priv: Private driver interface data
3223 * @buf: SSID
3224 * @len: Length of the SSID in octets
3225 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003226 *
3227 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003228 */
3229 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
3230
3231 /**
3232 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
3233 * @priv: Private driver interface data
3234 * @enabled: 1 = countermeasures enabled, 0 = disabled
3235 * Returns: 0 on success, -1 on failure
3236 *
3237 * This need not be implemented if the driver does not take care of
3238 * association processing.
3239 */
3240 int (*hapd_set_countermeasures)(void *priv, int enabled);
3241
3242 /**
3243 * sta_add - Add a station entry
3244 * @priv: Private driver interface data
3245 * @params: Station parameters
3246 * Returns: 0 on success, -1 on failure
3247 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08003248 * This function is used to add or set (params->set 1) a station
3249 * entry in the driver. Adding STA entries is used only if the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003250 * does not take care of association processing.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003251 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08003252 * With drivers that don't support full AP client state, this function
3253 * is used to add a station entry to the driver once the station has
3254 * completed association.
3255 *
3256 * With TDLS, this function is used to add or set (params->set 1)
3257 * TDLS peer entries (even with drivers that do not support full AP
3258 * client state).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003259 */
3260 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
3261
3262 /**
3263 * get_inact_sec - Get station inactivity duration (AP only)
3264 * @priv: Private driver interface data
3265 * @addr: Station address
3266 * Returns: Number of seconds station has been inactive, -1 on failure
3267 */
3268 int (*get_inact_sec)(void *priv, const u8 *addr);
3269
3270 /**
3271 * sta_clear_stats - Clear station statistics (AP only)
3272 * @priv: Private driver interface data
3273 * @addr: Station address
3274 * Returns: 0 on success, -1 on failure
3275 */
3276 int (*sta_clear_stats)(void *priv, const u8 *addr);
3277
3278 /**
3279 * set_freq - Set channel/frequency (AP only)
3280 * @priv: Private driver interface data
3281 * @freq: Channel parameters
3282 * Returns: 0 on success, -1 on failure
3283 */
3284 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
3285
3286 /**
3287 * set_rts - Set RTS threshold
3288 * @priv: Private driver interface data
3289 * @rts: RTS threshold in octets
3290 * Returns: 0 on success, -1 on failure
3291 */
3292 int (*set_rts)(void *priv, int rts);
3293
3294 /**
3295 * set_frag - Set fragmentation threshold
3296 * @priv: Private driver interface data
3297 * @frag: Fragmentation threshold in octets
3298 * Returns: 0 on success, -1 on failure
3299 */
3300 int (*set_frag)(void *priv, int frag);
3301
3302 /**
3303 * sta_set_flags - Set station flags (AP only)
3304 * @priv: Private driver interface data
3305 * @addr: Station address
3306 * @total_flags: Bitmap of all WPA_STA_* flags currently set
3307 * @flags_or: Bitmap of WPA_STA_* flags to add
3308 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
3309 * Returns: 0 on success, -1 on failure
3310 */
3311 int (*sta_set_flags)(void *priv, const u8 *addr,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08003312 unsigned int total_flags, unsigned int flags_or,
3313 unsigned int flags_and);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003314
3315 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07003316 * sta_set_airtime_weight - Set station airtime weight (AP only)
3317 * @priv: Private driver interface data
3318 * @addr: Station address
3319 * @weight: New weight for station airtime assignment
3320 * Returns: 0 on success, -1 on failure
3321 */
3322 int (*sta_set_airtime_weight)(void *priv, const u8 *addr,
3323 unsigned int weight);
3324
3325 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003326 * set_tx_queue_params - Set TX queue parameters
3327 * @priv: Private driver interface data
3328 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
3329 * @aifs: AIFS
3330 * @cw_min: cwMin
3331 * @cw_max: cwMax
3332 * @burst_time: Maximum length for bursting in 0.1 msec units
3333 */
3334 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
3335 int cw_max, int burst_time);
3336
3337 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003338 * if_add - Add a virtual interface
3339 * @priv: Private driver interface data
3340 * @type: Interface type
3341 * @ifname: Interface name for the new virtual interface
3342 * @addr: Local address to use for the interface or %NULL to use the
3343 * parent interface address
3344 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
3345 * @drv_priv: Pointer for overwriting the driver context or %NULL if
3346 * not allowed (applies only to %WPA_IF_AP_BSS type)
3347 * @force_ifname: Buffer for returning an interface name that the
3348 * driver ended up using if it differs from the requested ifname
3349 * @if_addr: Buffer for returning the allocated interface address
3350 * (this may differ from the requested addr if the driver cannot
3351 * change interface address)
3352 * @bridge: Bridge interface to use or %NULL if no bridge configured
Dmitry Shmidtcce06662013-11-04 18:44:24 -08003353 * @use_existing: Whether to allow existing interface to be used
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003354 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003355 * Returns: 0 on success, -1 on failure
3356 */
3357 int (*if_add)(void *priv, enum wpa_driver_if_type type,
3358 const char *ifname, const u8 *addr, void *bss_ctx,
3359 void **drv_priv, char *force_ifname, u8 *if_addr,
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003360 const char *bridge, int use_existing, int setup_ap);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003361
3362 /**
3363 * if_remove - Remove a virtual interface
3364 * @priv: Private driver interface data
3365 * @type: Interface type
3366 * @ifname: Interface name of the virtual interface to be removed
3367 * Returns: 0 on success, -1 on failure
3368 */
3369 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
3370 const char *ifname);
3371
3372 /**
3373 * set_sta_vlan - Bind a station into a specific interface (AP only)
3374 * @priv: Private driver interface data
3375 * @ifname: Interface (main or virtual BSS or VLAN)
3376 * @addr: MAC address of the associated station
3377 * @vlan_id: VLAN ID
3378 * Returns: 0 on success, -1 on failure
3379 *
3380 * This function is used to bind a station to a specific virtual
3381 * interface. It is only used if when virtual interfaces are supported,
3382 * e.g., to assign stations to different VLAN interfaces based on
3383 * information from a RADIUS server. This allows separate broadcast
3384 * domains to be used with a single BSS.
3385 */
3386 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
3387 int vlan_id);
3388
3389 /**
3390 * commit - Optional commit changes handler (AP only)
3391 * @priv: driver private data
3392 * Returns: 0 on success, -1 on failure
3393 *
3394 * This optional handler function can be registered if the driver
3395 * interface implementation needs to commit changes (e.g., by setting
3396 * network interface up) at the end of initial configuration. If set,
3397 * this handler will be called after initial setup has been completed.
3398 */
3399 int (*commit)(void *priv);
3400
3401 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003402 * set_radius_acl_auth - Notification of RADIUS ACL change
3403 * @priv: Private driver interface data
3404 * @mac: MAC address of the station
3405 * @accepted: Whether the station was accepted
3406 * @session_timeout: Session timeout for the station
3407 * Returns: 0 on success, -1 on failure
3408 */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003409 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003410 u32 session_timeout);
3411
3412 /**
3413 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3414 * @priv: Private driver interface data
3415 * @mac: MAC address of the station
3416 * Returns: 0 on success, -1 on failure
3417 */
3418 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
3419
3420 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003421 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
3422 * @priv: Private driver interface data
3423 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3424 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3425 * extra IE(s)
3426 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3427 * to remove extra IE(s)
3428 * Returns: 0 on success, -1 on failure
3429 *
3430 * This is an optional function to add WPS IE in the kernel driver for
3431 * Beacon and Probe Response frames. This can be left undefined (set
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003432 * to %NULL) if the driver uses the Beacon template from set_ap()
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003433 * and does not process Probe Request frames. If the driver takes care
3434 * of (Re)Association frame processing, the assocresp buffer includes
3435 * WPS IE(s) that need to be added to (Re)Association Response frames
3436 * whenever a (Re)Association Request frame indicated use of WPS.
3437 *
3438 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3439 * frames when operating as a GO. The driver is responsible for adding
3440 * timing related attributes (e.g., NoA) in addition to the IEs
3441 * included here by appending them after these buffers. This call is
3442 * also used to provide Probe Response IEs for P2P Listen state
3443 * operations for drivers that generate the Probe Response frames
3444 * internally.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003445 *
3446 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003447 */
3448 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
3449 const struct wpabuf *proberesp,
3450 const struct wpabuf *assocresp);
3451
3452 /**
3453 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3454 * @priv: Private driver interface data
3455 * @authorized: Whether the port is authorized
3456 * Returns: 0 on success, -1 on failure
3457 */
3458 int (*set_supp_port)(void *priv, int authorized);
3459
3460 /**
3461 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3462 * @priv: Private driver interface data
3463 * @addr: MAC address of the associated station
3464 * @aid: Association ID
3465 * @val: 1 = bind to 4-address WDS; 0 = unbind
3466 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3467 * to indicate that bridge is not to be used
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07003468 * @ifname_wds: Buffer to return the interface name for the new WDS
3469 * station or %NULL to indicate name is not returned.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003470 * Returns: 0 on success, -1 on failure
3471 */
3472 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003473 const char *bridge_ifname, char *ifname_wds);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003474
3475 /**
3476 * send_action - Transmit an Action frame
3477 * @priv: Private driver interface data
3478 * @freq: Frequency (in MHz) of the channel
3479 * @wait: Time to wait off-channel for a response (in ms), or zero
3480 * @dst: Destination MAC address (Address 1)
3481 * @src: Source MAC address (Address 2)
3482 * @bssid: BSSID (Address 3)
3483 * @data: Frame body
3484 * @data_len: data length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003485 @ @no_cck: Whether CCK rates must not be used to transmit this frame
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003486 * Returns: 0 on success, -1 on failure
3487 *
3488 * This command can be used to request the driver to transmit an action
3489 * frame to the specified destination.
3490 *
3491 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3492 * be transmitted on the given channel and the device will wait for a
3493 * response on that channel for the given wait time.
3494 *
3495 * If the flag is not set, the wait time will be ignored. In this case,
3496 * if a remain-on-channel duration is in progress, the frame must be
3497 * transmitted on that channel; alternatively the frame may be sent on
3498 * the current operational channel (if in associated state in station
3499 * mode or while operating as an AP.)
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08003500 *
3501 * If @src differs from the device MAC address, use of a random
3502 * transmitter address is requested for this message exchange.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003503 */
3504 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
3505 const u8 *dst, const u8 *src, const u8 *bssid,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003506 const u8 *data, size_t data_len, int no_cck);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003507
3508 /**
3509 * send_action_cancel_wait - Cancel action frame TX wait
3510 * @priv: Private driver interface data
3511 *
3512 * This command cancels the wait time associated with sending an action
3513 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3514 * set in the driver flags.
3515 */
3516 void (*send_action_cancel_wait)(void *priv);
3517
3518 /**
3519 * remain_on_channel - Remain awake on a channel
3520 * @priv: Private driver interface data
3521 * @freq: Frequency (in MHz) of the channel
3522 * @duration: Duration in milliseconds
3523 * Returns: 0 on success, -1 on failure
3524 *
3525 * This command is used to request the driver to remain awake on the
3526 * specified channel for the specified duration and report received
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08003527 * Action frames with EVENT_RX_MGMT events. Optionally, received
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003528 * Probe Request frames may also be requested to be reported by calling
3529 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3530 *
3531 * The driver may not be at the requested channel when this function
3532 * returns, i.e., the return code is only indicating whether the
3533 * request was accepted. The caller will need to wait until the
3534 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3535 * completed the channel change. This may take some time due to other
3536 * need for the radio and the caller should be prepared to timing out
3537 * its wait since there are no guarantees on when this request can be
3538 * executed.
3539 */
3540 int (*remain_on_channel)(void *priv, unsigned int freq,
3541 unsigned int duration);
3542
3543 /**
3544 * cancel_remain_on_channel - Cancel remain-on-channel operation
3545 * @priv: Private driver interface data
3546 *
3547 * This command can be used to cancel a remain-on-channel operation
3548 * before its originally requested duration has passed. This could be
3549 * used, e.g., when remain_on_channel() is used to request extra time
3550 * to receive a response to an Action frame and the response is
3551 * received when there is still unneeded time remaining on the
3552 * remain-on-channel operation.
3553 */
3554 int (*cancel_remain_on_channel)(void *priv);
3555
3556 /**
3557 * probe_req_report - Request Probe Request frames to be indicated
3558 * @priv: Private driver interface data
3559 * @report: Whether to report received Probe Request frames
3560 * Returns: 0 on success, -1 on failure (or if not supported)
3561 *
3562 * This command can be used to request the driver to indicate when
3563 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3564 * Since this operation may require extra resources, e.g., due to less
3565 * optimal hardware/firmware RX filtering, many drivers may disable
3566 * Probe Request reporting at least in station mode. This command is
3567 * used to notify the driver when the Probe Request frames need to be
3568 * reported, e.g., during remain-on-channel operations.
3569 */
3570 int (*probe_req_report)(void *priv, int report);
3571
3572 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003573 * deinit_ap - Deinitialize AP mode
3574 * @priv: Private driver interface data
3575 * Returns: 0 on success, -1 on failure (or if not supported)
3576 *
3577 * This optional function can be used to disable AP mode related
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003578 * configuration. If the interface was not dynamically added,
3579 * change the driver mode to station mode to allow normal station
3580 * operations like scanning to be completed.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003581 */
3582 int (*deinit_ap)(void *priv);
3583
3584 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003585 * deinit_p2p_cli - Deinitialize P2P client mode
3586 * @priv: Private driver interface data
3587 * Returns: 0 on success, -1 on failure (or if not supported)
3588 *
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003589 * This optional function can be used to disable P2P client mode. If the
3590 * interface was not dynamically added, change the interface type back
3591 * to station mode.
Dmitry Shmidt04949592012-07-19 12:16:46 -07003592 */
3593 int (*deinit_p2p_cli)(void *priv);
3594
3595 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003596 * suspend - Notification on system suspend/hibernate event
3597 * @priv: Private driver interface data
3598 */
3599 void (*suspend)(void *priv);
3600
3601 /**
3602 * resume - Notification on system resume/thaw event
3603 * @priv: Private driver interface data
3604 */
3605 void (*resume)(void *priv);
3606
3607 /**
3608 * signal_monitor - Set signal monitoring parameters
3609 * @priv: Private driver interface data
3610 * @threshold: Threshold value for signal change events; 0 = disabled
3611 * @hysteresis: Minimum change in signal strength before indicating a
3612 * new event
3613 * Returns: 0 on success, -1 on failure (or if not supported)
3614 *
3615 * This function can be used to configure monitoring of signal strength
3616 * with the current AP. Whenever signal strength drops below the
3617 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3618 * should be generated assuming the signal strength has changed at
3619 * least %hysteresis from the previously indicated signal change event.
3620 */
3621 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
3622
3623 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003624 * get_noa - Get current Notice of Absence attribute payload
3625 * @priv: Private driver interface data
3626 * @buf: Buffer for returning NoA
3627 * @buf_len: Buffer length in octets
3628 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3629 * advertized, or -1 on failure
3630 *
3631 * This function is used to fetch the current Notice of Absence
3632 * attribute value from GO.
3633 */
3634 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
3635
3636 /**
3637 * set_noa - Set Notice of Absence parameters for GO (testing)
3638 * @priv: Private driver interface data
3639 * @count: Count
3640 * @start: Start time in ms from next TBTT
3641 * @duration: Duration in ms
3642 * Returns: 0 on success or -1 on failure
3643 *
3644 * This function is used to set Notice of Absence parameters for GO. It
3645 * is used only for testing. To disable NoA, all parameters are set to
3646 * 0.
3647 */
3648 int (*set_noa)(void *priv, u8 count, int start, int duration);
3649
3650 /**
3651 * set_p2p_powersave - Set P2P power save options
3652 * @priv: Private driver interface data
3653 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3654 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3655 * @ctwindow: 0.. = change (msec), -1 = no change
3656 * Returns: 0 on success or -1 on failure
3657 */
3658 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
3659 int ctwindow);
3660
3661 /**
3662 * ampdu - Enable/disable aggregation
3663 * @priv: Private driver interface data
3664 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3665 * Returns: 0 on success or -1 on failure
3666 */
3667 int (*ampdu)(void *priv, int ampdu);
3668
3669 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003670 * get_radio_name - Get physical radio name for the device
3671 * @priv: Private driver interface data
3672 * Returns: Radio name or %NULL if not known
3673 *
3674 * The returned data must not be modified by the caller. It is assumed
3675 * that any interface that has the same radio name as another is
3676 * sharing the same physical radio. This information can be used to
3677 * share scan results etc. information between the virtual interfaces
3678 * to speed up various operations.
3679 */
3680 const char * (*get_radio_name)(void *priv);
3681
3682 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003683 * send_tdls_mgmt - for sending TDLS management packets
3684 * @priv: private driver interface data
3685 * @dst: Destination (peer) MAC address
3686 * @action_code: TDLS action code for the mssage
3687 * @dialog_token: Dialog Token to use in the message (if needed)
3688 * @status_code: Status Code or Reason Code to use (if needed)
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003689 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003690 * @initiator: Is the current end the TDLS link initiator
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003691 * @buf: TDLS IEs to add to the message
3692 * @len: Length of buf in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003693 * Returns: 0 on success, negative (<0) on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003694 *
3695 * This optional function can be used to send packet to driver which is
3696 * responsible for receiving and sending all TDLS packets.
3697 */
3698 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003699 u8 dialog_token, u16 status_code, u32 peer_capab,
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003700 int initiator, const u8 *buf, size_t len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003701
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003702 /**
3703 * tdls_oper - Ask the driver to perform high-level TDLS operations
3704 * @priv: Private driver interface data
3705 * @oper: TDLS high-level operation. See %enum tdls_oper
3706 * @peer: Destination (peer) MAC address
3707 * Returns: 0 on success, negative (<0) on failure
3708 *
3709 * This optional function can be used to send high-level TDLS commands
3710 * to the driver.
3711 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003712 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
3713
3714 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07003715 * wnm_oper - Notify driver of the WNM frame reception
3716 * @priv: Private driver interface data
3717 * @oper: WNM operation. See %enum wnm_oper
3718 * @peer: Destination (peer) MAC address
3719 * @buf: Buffer for the driver to fill in (for getting IE)
3720 * @buf_len: Return the len of buf
3721 * Returns: 0 on success, negative (<0) on failure
3722 */
3723 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
3724 u8 *buf, u16 *buf_len);
3725
3726 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -07003727 * set_qos_map - Set QoS Map
3728 * @priv: Private driver interface data
3729 * @qos_map_set: QoS Map
3730 * @qos_map_set_len: Length of QoS Map
3731 */
3732 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
3733 u8 qos_map_set_len);
3734
3735 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003736 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3737 * @priv: Private driver interface data
3738 * @version: IP version of the IP address, 4 or 6
3739 * @ipaddr: IP address for the neigh entry
3740 * @prefixlen: IP address prefix length
3741 * @addr: Corresponding MAC address
3742 * Returns: 0 on success, negative (<0) on failure
3743 */
3744 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
3745 int prefixlen, const u8 *addr);
3746
3747 /**
3748 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3749 * @priv: Private driver interface data
3750 * @version: IP version of the IP address, 4 or 6
3751 * @ipaddr: IP address for the neigh entry
3752 * Returns: 0 on success, negative (<0) on failure
3753 */
3754 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
3755
3756 /**
3757 * br_port_set_attr - Set a bridge port attribute
3758 * @attr: Bridge port attribute to set
3759 * @val: Value to be set
3760 * Returns: 0 on success, negative (<0) on failure
3761 */
3762 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
3763 unsigned int val);
3764
3765 /**
3766 * br_port_set_attr - Set a bridge network parameter
3767 * @param: Bridge parameter to set
3768 * @val: Value to be set
3769 * Returns: 0 on success, negative (<0) on failure
3770 */
3771 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
3772 unsigned int val);
3773
3774 /**
Hai Shalomfdcde762020-04-02 11:19:20 -07003775 * get_wowlan - Get wake-on-wireless status
3776 * @priv: Private driver interface data
3777 */
3778 int (*get_wowlan)(void *priv);
3779
3780 /**
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07003781 * set_wowlan - Set wake-on-wireless triggers
3782 * @priv: Private driver interface data
3783 * @triggers: wowlan triggers
3784 */
3785 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
3786
3787 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003788 * signal_poll - Get current connection information
3789 * @priv: Private driver interface data
3790 * @signal_info: Connection info structure
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003791 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003792 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003793
3794 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08003795 * channel_info - Get parameters of the current operating channel
3796 * @priv: Private driver interface data
3797 * @channel_info: Channel info structure
3798 * Returns: 0 on success, negative (<0) on failure
3799 */
3800 int (*channel_info)(void *priv, struct wpa_channel_info *channel_info);
3801
3802 /**
Jouni Malinen75ecf522011-06-27 15:19:46 -07003803 * set_authmode - Set authentication algorithm(s) for static WEP
3804 * @priv: Private driver interface data
3805 * @authmode: 1=Open System, 2=Shared Key, 3=both
3806 * Returns: 0 on success, -1 on failure
3807 *
3808 * This function can be used to set authentication algorithms for AP
3809 * mode when static WEP is used. If the driver uses user space MLME/SME
3810 * implementation, there is no need to implement this function.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003811 *
3812 * DEPRECATED - use set_ap() instead
Jouni Malinen75ecf522011-06-27 15:19:46 -07003813 */
3814 int (*set_authmode)(void *priv, int authmode);
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003815
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003816#ifdef ANDROID
Jouni Malinen75ecf522011-06-27 15:19:46 -07003817 /**
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003818 * driver_cmd - Execute driver-specific command
3819 * @priv: Private driver interface data
3820 * @cmd: Command to execute
3821 * @buf: Return buffer
3822 * @buf_len: Buffer length
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003823 * Returns: 0 on success, -1 on failure
3824 */
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003825 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
3826#endif /* ANDROID */
3827
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003828 /**
Dmitry Shmidta38abf92014-03-06 13:38:44 -08003829 * vendor_cmd - Execute vendor specific command
3830 * @priv: Private driver interface data
3831 * @vendor_id: Vendor id
3832 * @subcmd: Vendor command id
Hai Shalom60840252021-02-19 19:02:11 -08003833 * @nested_attr_flag: Specifies if vendor subcommand uses nested
3834 * attributes or not
Dmitry Shmidta38abf92014-03-06 13:38:44 -08003835 * @data: Vendor command parameters (%NULL if no parameters)
3836 * @data_len: Data length
3837 * @buf: Return buffer (%NULL to ignore reply)
3838 * Returns: 0 on success, negative (<0) on failure
3839 *
3840 * This function handles vendor specific commands that are passed to
3841 * the driver/device. The command is identified by vendor id and
Hai Shalom60840252021-02-19 19:02:11 -08003842 * command id. The nested_attr_flag specifies whether the subcommand
3843 * uses nested attributes or not. Parameters can be passed
3844 * as argument to the command in the data buffer. Reply (if any) will be
3845 * filled in the supplied return buffer.
Dmitry Shmidta38abf92014-03-06 13:38:44 -08003846 *
3847 * The exact driver behavior is driver interface and vendor specific. As
3848 * an example, this will be converted to a vendor specific cfg80211
3849 * command in case of the nl80211 driver interface.
3850 */
3851 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3852 unsigned int subcmd, const u8 *data, size_t data_len,
Hai Shalom60840252021-02-19 19:02:11 -08003853 enum nested_attr nested_attr_flag,
Dmitry Shmidta38abf92014-03-06 13:38:44 -08003854 struct wpabuf *buf);
3855
3856 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003857 * set_rekey_info - Set rekey information
3858 * @priv: Private driver interface data
3859 * @kek: Current KEK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003860 * @kek_len: KEK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003861 * @kck: Current KCK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003862 * @kck_len: KCK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003863 * @replay_ctr: Current EAPOL-Key Replay Counter
3864 *
3865 * This optional function can be used to provide information for the
3866 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3867 * while the host (including wpa_supplicant) is sleeping.
3868 */
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003869 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3870 const u8 *kck, size_t kck_len,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003871 const u8 *replay_ctr);
3872
3873 /**
3874 * sta_assoc - Station association indication
3875 * @priv: Private driver interface data
3876 * @own_addr: Source address and BSSID for association frame
3877 * @addr: MAC address of the station to associate
3878 * @reassoc: flag to indicate re-association
3879 * @status: association response status code
3880 * @ie: assoc response ie buffer
3881 * @len: ie buffer length
3882 * Returns: 0 on success, -1 on failure
3883 *
3884 * This function indicates the driver to send (Re)Association
3885 * Response frame to the station.
3886 */
3887 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3888 int reassoc, u16 status, const u8 *ie, size_t len);
3889
3890 /**
3891 * sta_auth - Station authentication indication
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003892 * @priv: private driver interface data
3893 * @params: Station authentication parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003894 *
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003895 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003896 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003897 int (*sta_auth)(void *priv,
3898 struct wpa_driver_sta_auth_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003899
3900 /**
3901 * add_tspec - Add traffic stream
3902 * @priv: Private driver interface data
3903 * @addr: MAC address of the station to associate
3904 * @tspec_ie: tspec ie buffer
3905 * @tspec_ielen: tspec ie length
3906 * Returns: 0 on success, -1 on failure
3907 *
3908 * This function adds the traffic steam for the station
3909 * and fills the medium_time in tspec_ie.
3910 */
3911 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3912 size_t tspec_ielen);
3913
3914 /**
3915 * add_sta_node - Add a station node in the driver
3916 * @priv: Private driver interface data
3917 * @addr: MAC address of the station to add
3918 * @auth_alg: authentication algorithm used by the station
3919 * Returns: 0 on success, -1 on failure
3920 *
3921 * This function adds the station node in the driver, when
3922 * the station gets added by FT-over-DS.
3923 */
3924 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
3925
3926 /**
3927 * sched_scan - Request the driver to initiate scheduled scan
3928 * @priv: Private driver interface data
3929 * @params: Scan parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003930 * Returns: 0 on success, -1 on failure
3931 *
3932 * This operation should be used for scheduled scan offload to
3933 * the hardware. Every time scan results are available, the
3934 * driver should report scan results event for wpa_supplicant
3935 * which will eventually request the results with
3936 * wpa_driver_get_scan_results2(). This operation is optional
3937 * and if not provided or if it returns -1, we fall back to
3938 * normal host-scheduled scans.
3939 */
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003940 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003941
3942 /**
3943 * stop_sched_scan - Request the driver to stop a scheduled scan
3944 * @priv: Private driver interface data
3945 * Returns: 0 on success, -1 on failure
3946 *
3947 * This should cause the scheduled scan to be stopped and
3948 * results should stop being sent. Must be supported if
3949 * sched_scan is supported.
3950 */
3951 int (*stop_sched_scan)(void *priv);
3952
3953 /**
3954 * poll_client - Probe (null data or such) the given station
3955 * @priv: Private driver interface data
3956 * @own_addr: MAC address of sending interface
3957 * @addr: MAC address of the station to probe
3958 * @qos: Indicates whether station is QoS station
3959 *
3960 * This function is used to verify whether an associated station is
3961 * still present. This function does not need to be implemented if the
3962 * driver provides such inactivity polling mechanism.
3963 */
3964 void (*poll_client)(void *priv, const u8 *own_addr,
3965 const u8 *addr, int qos);
Dmitry Shmidt04949592012-07-19 12:16:46 -07003966
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003967 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003968 * radio_disable - Disable/enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003969 * @priv: Private driver interface data
Dmitry Shmidt04949592012-07-19 12:16:46 -07003970 * @disabled: 1=disable 0=enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003971 * Returns: 0 on success, -1 on failure
3972 *
Dmitry Shmidt04949592012-07-19 12:16:46 -07003973 * This optional command is for testing purposes. It can be used to
3974 * disable the radio on a testbed device to simulate out-of-radio-range
3975 * conditions.
3976 */
3977 int (*radio_disable)(void *priv, int disabled);
3978
3979 /**
3980 * switch_channel - Announce channel switch and migrate the GO to the
3981 * given frequency
3982 * @priv: Private driver interface data
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003983 * @settings: Settings for CSA period and new channel
Dmitry Shmidt04949592012-07-19 12:16:46 -07003984 * Returns: 0 on success, -1 on failure
3985 *
3986 * This function is used to move the GO to the legacy STA channel to
3987 * avoid frequency conflict in single channel concurrency.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003988 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003989 int (*switch_channel)(void *priv, struct csa_settings *settings);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003990
3991 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003992 * add_tx_ts - Add traffic stream
3993 * @priv: Private driver interface data
3994 * @tsid: Traffic stream ID
3995 * @addr: Receiver address
3996 * @user_prio: User priority of the traffic stream
3997 * @admitted_time: Admitted time for this TS in units of
3998 * 32 microsecond periods (per second).
3999 * Returns: 0 on success, -1 on failure
4000 */
4001 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
4002 u16 admitted_time);
4003
4004 /**
4005 * del_tx_ts - Delete traffic stream
4006 * @priv: Private driver interface data
4007 * @tsid: Traffic stream ID
4008 * @addr: Receiver address
4009 * Returns: 0 on success, -1 on failure
4010 */
4011 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
4012
4013 /**
4014 * Enable channel-switching with TDLS peer
4015 * @priv: Private driver interface data
4016 * @addr: MAC address of the TDLS peer
4017 * @oper_class: Operating class of the switch channel
4018 * @params: Channel specification
4019 * Returns: 0 on success, -1 on failure
4020 *
4021 * The function indicates to driver that it can start switching to a
4022 * different channel with a specified TDLS peer. The switching is
4023 * assumed on until canceled with tdls_disable_channel_switch().
4024 */
4025 int (*tdls_enable_channel_switch)(
4026 void *priv, const u8 *addr, u8 oper_class,
4027 const struct hostapd_freq_params *params);
4028
4029 /**
4030 * Disable channel switching with TDLS peer
4031 * @priv: Private driver interface data
4032 * @addr: MAC address of the TDLS peer
4033 * Returns: 0 on success, -1 on failure
4034 *
4035 * This function indicates to the driver that it should stop switching
4036 * with a given TDLS peer.
4037 */
4038 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
4039
4040 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004041 * start_dfs_cac - Listen for radar interference on the channel
4042 * @priv: Private driver interface data
Dmitry Shmidt051af732013-10-22 13:52:46 -07004043 * @freq: Channel parameters
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004044 * Returns: 0 on success, -1 on failure
4045 */
Dmitry Shmidt051af732013-10-22 13:52:46 -07004046 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004047
4048 /**
4049 * stop_ap - Removes beacon from AP
4050 * @priv: Private driver interface data
4051 * Returns: 0 on success, -1 on failure (or if not supported)
4052 *
4053 * This optional function can be used to disable AP mode related
4054 * configuration. Unlike deinit_ap, it does not change to station
4055 * mode.
4056 */
4057 int (*stop_ap)(void *priv);
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004058
4059 /**
4060 * get_survey - Retrieve survey data
4061 * @priv: Private driver interface data
4062 * @freq: If set, survey data for the specified frequency is only
4063 * being requested. If not set, all survey data is requested.
4064 * Returns: 0 on success, -1 on failure
4065 *
4066 * Use this to retrieve:
4067 *
4068 * - the observed channel noise floor
4069 * - the amount of time we have spent on the channel
4070 * - the amount of time during which we have spent on the channel that
4071 * the radio has determined the medium is busy and we cannot
4072 * transmit
4073 * - the amount of time we have spent receiving data
4074 * - the amount of time we have spent transmitting data
4075 *
4076 * This data can be used for spectrum heuristics. One example is
4077 * Automatic Channel Selection (ACS). The channel survey data is
4078 * kept on a linked list on the channel data, one entry is added
4079 * for each survey. The min_nf of the channel is updated for each
4080 * survey.
4081 */
4082 int (*get_survey)(void *priv, unsigned int freq);
Dmitry Shmidt56052862013-10-04 10:23:25 -07004083
4084 /**
4085 * status - Get driver interface status information
4086 * @priv: Private driver interface data
Hai Shalom74f70d42019-02-11 14:42:39 -08004087 * @buf: Buffer for printing the status information
Dmitry Shmidt56052862013-10-04 10:23:25 -07004088 * @buflen: Maximum length of the buffer
4089 * Returns: Length of written status information or -1 on failure
4090 */
4091 int (*status)(void *priv, char *buf, size_t buflen);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004092
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07004093 /**
4094 * roaming - Set roaming policy for driver-based BSS selection
4095 * @priv: Private driver interface data
4096 * @allowed: Whether roaming within ESS is allowed
4097 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
4098 * Returns: Length of written status information or -1 on failure
4099 *
4100 * This optional callback can be used to update roaming policy from the
4101 * associate() command (bssid being set there indicates that the driver
4102 * should not roam before getting this roaming() call to allow roaming.
4103 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
4104 * capability, roaming policy is handled within wpa_supplicant and there
4105 * is no need to implement or react to this callback.
4106 */
4107 int (*roaming)(void *priv, int allowed, const u8 *bssid);
4108
4109 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -07004110 * disable_fils - Enable/disable FILS feature
4111 * @priv: Private driver interface data
4112 * @disable: 0-enable and 1-disable FILS feature
4113 * Returns: 0 on success, -1 on failure
4114 *
4115 * This callback can be used to configure driver and below layers to
4116 * enable/disable all FILS features.
4117 */
4118 int (*disable_fils)(void *priv, int disable);
4119
4120 /**
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07004121 * set_mac_addr - Set MAC address
4122 * @priv: Private driver interface data
4123 * @addr: MAC address to use or %NULL for setting back to permanent
4124 * Returns: 0 on success, -1 on failure
4125 */
4126 int (*set_mac_addr)(void *priv, const u8 *addr);
4127
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004128#ifdef CONFIG_MACSEC
4129 int (*macsec_init)(void *priv, struct macsec_init_params *params);
4130
4131 int (*macsec_deinit)(void *priv);
4132
4133 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004134 * macsec_get_capability - Inform MKA of this driver's capability
4135 * @priv: Private driver interface data
4136 * @cap: Driver's capability
4137 * Returns: 0 on success, -1 on failure
4138 */
4139 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);
4140
4141 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004142 * enable_protect_frames - Set protect frames status
4143 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004144 * @enabled: true = protect frames enabled
4145 * false = protect frames disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004146 * Returns: 0 on success, -1 on failure (or if not supported)
4147 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004148 int (*enable_protect_frames)(void *priv, bool enabled);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004149
4150 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004151 * enable_encrypt - Set encryption status
4152 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004153 * @enabled: true = encrypt outgoing traffic
4154 * false = integrity-only protection on outgoing traffic
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004155 * Returns: 0 on success, -1 on failure (or if not supported)
4156 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004157 int (*enable_encrypt)(void *priv, bool enabled);
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004158
4159 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004160 * set_replay_protect - Set replay protect status and window size
4161 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004162 * @enabled: true = replay protect enabled
4163 * false = replay protect disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004164 * @window: replay window size, valid only when replay protect enabled
4165 * Returns: 0 on success, -1 on failure (or if not supported)
4166 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004167 int (*set_replay_protect)(void *priv, bool enabled, u32 window);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004168
4169 /**
4170 * set_current_cipher_suite - Set current cipher suite
4171 * @priv: Private driver interface data
4172 * @cs: EUI64 identifier
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004173 * Returns: 0 on success, -1 on failure (or if not supported)
4174 */
Dmitry Shmidt7d175302016-09-06 13:11:34 -07004175 int (*set_current_cipher_suite)(void *priv, u64 cs);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004176
4177 /**
4178 * enable_controlled_port - Set controlled port status
4179 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004180 * @enabled: true = controlled port enabled
4181 * false = controlled port disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004182 * Returns: 0 on success, -1 on failure (or if not supported)
4183 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004184 int (*enable_controlled_port)(void *priv, bool enabled);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004185
4186 /**
4187 * get_receive_lowest_pn - Get receive lowest pn
4188 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004189 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004190 * Returns: 0 on success, -1 on failure (or if not supported)
4191 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004192 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004193
4194 /**
4195 * get_transmit_next_pn - Get transmit next pn
4196 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004197 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004198 * Returns: 0 on success, -1 on failure (or if not supported)
4199 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004200 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004201
4202 /**
4203 * set_transmit_next_pn - Set transmit next pn
4204 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004205 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004206 * Returns: 0 on success, -1 on failure (or if not supported)
4207 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004208 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004209
4210 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08004211 * set_receive_lowest_pn - Set receive lowest PN
4212 * @priv: Private driver interface data
4213 * @sa: secure association
4214 * Returns: 0 on success, -1 on failure (or if not supported)
4215 */
4216 int (*set_receive_lowest_pn)(void *priv, struct receive_sa *sa);
4217
4218 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004219 * create_receive_sc - create secure channel for receiving
4220 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004221 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004222 * @conf_offset: confidentiality offset (0, 30, or 50)
4223 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
4224 * 2 = Strict)
4225 * Returns: 0 on success, -1 on failure (or if not supported)
4226 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004227 int (*create_receive_sc)(void *priv, struct receive_sc *sc,
4228 unsigned int conf_offset,
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004229 int validation);
4230
4231 /**
4232 * delete_receive_sc - delete secure connection for receiving
4233 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004234 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004235 * Returns: 0 on success, -1 on failure
4236 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004237 int (*delete_receive_sc)(void *priv, struct receive_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004238
4239 /**
4240 * create_receive_sa - create secure association for receive
4241 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004242 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004243 * Returns: 0 on success, -1 on failure
4244 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004245 int (*create_receive_sa)(void *priv, struct receive_sa *sa);
4246
4247 /**
4248 * delete_receive_sa - Delete secure association for receive
4249 * @priv: Private driver interface data from init()
4250 * @sa: Secure association
4251 * Returns: 0 on success, -1 on failure
4252 */
4253 int (*delete_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004254
4255 /**
4256 * enable_receive_sa - enable the SA for receive
4257 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004258 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004259 * Returns: 0 on success, -1 on failure
4260 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004261 int (*enable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004262
4263 /**
4264 * disable_receive_sa - disable SA for receive
4265 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004266 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004267 * Returns: 0 on success, -1 on failure
4268 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004269 int (*disable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004270
4271 /**
4272 * create_transmit_sc - create secure connection for transmit
4273 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004274 * @sc: secure channel
4275 * @conf_offset: confidentiality offset (0, 30, or 50)
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004276 * Returns: 0 on success, -1 on failure
4277 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004278 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
4279 unsigned int conf_offset);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004280
4281 /**
4282 * delete_transmit_sc - delete secure connection for transmit
4283 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004284 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004285 * Returns: 0 on success, -1 on failure
4286 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004287 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004288
4289 /**
4290 * create_transmit_sa - create secure association for transmit
4291 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004292 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004293 * Returns: 0 on success, -1 on failure
4294 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004295 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);
4296
4297 /**
4298 * delete_transmit_sa - Delete secure association for transmit
4299 * @priv: Private driver interface data from init()
4300 * @sa: Secure association
4301 * Returns: 0 on success, -1 on failure
4302 */
4303 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004304
4305 /**
4306 * enable_transmit_sa - enable SA for transmit
4307 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004308 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004309 * Returns: 0 on success, -1 on failure
4310 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004311 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004312
4313 /**
4314 * disable_transmit_sa - disable SA for transmit
4315 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004316 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004317 * Returns: 0 on success, -1 on failure
4318 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004319 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004320#endif /* CONFIG_MACSEC */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004321
4322 /**
4323 * init_mesh - Driver specific initialization for mesh
4324 * @priv: Private driver interface data
4325 * Returns: 0 on success, -1 on failure
4326 */
4327 int (*init_mesh)(void *priv);
4328
4329 /**
4330 * join_mesh - Join a mesh network
4331 * @priv: Private driver interface data
4332 * @params: Mesh configuration parameters
4333 * Returns: 0 on success, -1 on failure
4334 */
4335 int (*join_mesh)(void *priv,
4336 struct wpa_driver_mesh_join_params *params);
4337
4338 /**
4339 * leave_mesh - Leave a mesh network
4340 * @priv: Private driver interface data
4341 * Returns 0 on success, -1 on failure
4342 */
4343 int (*leave_mesh)(void *priv);
4344
4345 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07004346 * probe_mesh_link - Inject a frame over direct mesh link to a given
4347 * peer skipping the next_hop lookup from mpath table.
4348 * @priv: Private driver interface data
4349 * @addr: Peer MAC address
4350 * @eth: Ethernet frame to be sent
4351 * @len: Ethernet frame lengtn in bytes
4352 * Returns 0 on success, -1 on failure
4353 */
4354 int (*probe_mesh_link)(void *priv, const u8 *addr, const u8 *eth,
4355 size_t len);
4356
4357 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004358 * do_acs - Automatically select channel
4359 * @priv: Private driver interface data
4360 * @params: Parameters for ACS
4361 * Returns 0 on success, -1 on failure
4362 *
4363 * This command can be used to offload ACS to the driver if the driver
4364 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
4365 */
4366 int (*do_acs)(void *priv, struct drv_acs_params *params);
Ravi Joshie6ccb162015-07-16 17:45:41 -07004367
4368 /**
Hai Shalom60840252021-02-19 19:02:11 -08004369 * set_band - Notify driver of band(s) selection
Ravi Joshie6ccb162015-07-16 17:45:41 -07004370 * @priv: Private driver interface data
Hai Shalom60840252021-02-19 19:02:11 -08004371 * @band_mask: The selected band(s) bit mask (from enum set_band)
Ravi Joshie6ccb162015-07-16 17:45:41 -07004372 * Returns 0 on success, -1 on failure
4373 */
Hai Shalom60840252021-02-19 19:02:11 -08004374 int (*set_band)(void *priv, u32 band_mask);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004375
4376 /**
4377 * get_pref_freq_list - Get preferred frequency list for an interface
4378 * @priv: Private driver interface data
4379 * @if_type: Interface type
4380 * @num: Number of channels
4381 * @freq_list: Preferred channel frequency list encoded in MHz values
4382 * Returns 0 on success, -1 on failure
4383 *
4384 * This command can be used to query the preferred frequency list from
4385 * the driver specific to a particular interface type.
4386 */
4387 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
4388 unsigned int *num, unsigned int *freq_list);
4389
4390 /**
4391 * set_prob_oper_freq - Indicate probable P2P operating channel
4392 * @priv: Private driver interface data
4393 * @freq: Channel frequency in MHz
4394 * Returns 0 on success, -1 on failure
4395 *
4396 * This command can be used to inform the driver of the operating
4397 * frequency that an ongoing P2P group formation is likely to come up
4398 * on. Local device is assuming P2P Client role.
4399 */
4400 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004401
4402 /**
4403 * abort_scan - Request the driver to abort an ongoing scan
4404 * @priv: Private driver interface data
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004405 * @scan_cookie: Cookie identifying the scan request. This is used only
4406 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4407 * was used to trigger scan. Otherwise, 0 is used.
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004408 * Returns 0 on success, -1 on failure
4409 */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004410 int (*abort_scan)(void *priv, u64 scan_cookie);
Dmitry Shmidt849734c2016-05-27 09:59:01 -07004411
4412 /**
4413 * configure_data_frame_filters - Request to configure frame filters
4414 * @priv: Private driver interface data
4415 * @filter_flags: The type of frames to filter (bitfield of
4416 * WPA_DATA_FRAME_FILTER_FLAG_*)
4417 * Returns: 0 on success or -1 on failure
4418 */
4419 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07004420
4421 /**
4422 * get_ext_capab - Get extended capabilities for the specified interface
4423 * @priv: Private driver interface data
4424 * @type: Interface type for which to get extended capabilities
4425 * @ext_capab: Extended capabilities fetched
4426 * @ext_capab_mask: Extended capabilities mask
4427 * @ext_capab_len: Length of the extended capabilities
4428 * Returns: 0 on success or -1 on failure
4429 */
4430 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
4431 const u8 **ext_capab, const u8 **ext_capab_mask,
4432 unsigned int *ext_capab_len);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004433
4434 /**
4435 * p2p_lo_start - Start offloading P2P listen to device
4436 * @priv: Private driver interface data
4437 * @freq: Listening frequency (MHz) for P2P listen
4438 * @period: Length of the listen operation in milliseconds
4439 * @interval: Interval for running the listen operation in milliseconds
4440 * @count: Number of times to run the listen operation
4441 * @device_types: Device primary and secondary types
4442 * @dev_types_len: Number of bytes for device_types
4443 * @ies: P2P IE and WSC IE for Probe Response frames
4444 * @ies_len: Length of ies in bytes
4445 * Returns: 0 on success or -1 on failure
4446 */
4447 int (*p2p_lo_start)(void *priv, unsigned int freq,
4448 unsigned int period, unsigned int interval,
4449 unsigned int count,
4450 const u8 *device_types, size_t dev_types_len,
4451 const u8 *ies, size_t ies_len);
4452
4453 /**
4454 * p2p_lo_stop - Stop P2P listen offload
4455 * @priv: Private driver interface data
4456 * Returns: 0 on success or -1 on failure
4457 */
4458 int (*p2p_lo_stop)(void *priv);
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07004459
4460 /**
4461 * set_default_scan_ies - Set default scan IEs
4462 * @priv: Private driver interface data
4463 * @ies: Scan default IEs buffer
4464 * @ies_len: Length of IEs in bytes
4465 * Returns: 0 on success or -1 on failure
4466 *
4467 * The driver can use these by default when there are no scan IEs coming
4468 * in the subsequent scan requests. Also in case of one or more of IEs
4469 * given in set_default_scan_ies() are missing in the subsequent scan
4470 * request, the driver should merge the missing scan IEs in the scan
4471 * request from the IEs set by set_default_scan_ies() in the Probe
4472 * Request frames sent.
4473 */
4474 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
4475
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004476 /**
4477 * set_tdls_mode - Set TDLS trigger mode to the host driver
4478 * @priv: Private driver interface data
4479 * @tdls_external_control: Represents if TDLS external trigger control
4480 * mode is enabled/disabled.
4481 *
4482 * This optional callback can be used to configure the TDLS external
4483 * trigger control mode to the host driver.
4484 */
4485 int (*set_tdls_mode)(void *priv, int tdls_external_control);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004486
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004487 /**
4488 * get_bss_transition_status - Get candidate BSS's transition status
4489 * @priv: Private driver interface data
4490 * @params: Candidate BSS list
4491 *
4492 * Get the accept or reject reason code for a list of BSS transition
4493 * candidates.
4494 */
4495 struct wpa_bss_candidate_info *
4496 (*get_bss_transition_status)(void *priv,
4497 struct wpa_bss_trans_info *params);
4498 /**
4499 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
4500 * @priv: Private driver interface data
4501 * @ignore_disallow: 0 to not ignore, 1 to ignore
4502 * Returns: 0 on success, -1 on failure
4503 */
4504 int (*ignore_assoc_disallow)(void *priv, int ignore_disallow);
4505
4506 /**
Hai Shalom899fcc72020-10-19 14:38:18 -07004507 * set_bssid_tmp_disallow - Set disallowed BSSIDs to the driver
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004508 * @priv: Private driver interface data
Hai Shalom899fcc72020-10-19 14:38:18 -07004509 * @num_bssid: Number of temporarily disallowed BSSIDs
4510 * @bssids: List of temporarily disallowed BSSIDs
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004511 */
Hai Shalom899fcc72020-10-19 14:38:18 -07004512 int (*set_bssid_tmp_disallow)(void *priv, unsigned int num_bssid,
4513 const u8 *bssid);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004514
4515 /**
4516 * update_connect_params - Update the connection parameters
4517 * @priv: Private driver interface data
4518 * @params: Association parameters
4519 * @mask: Bit mask indicating which parameters in @params have to be
4520 * updated
4521 * Returns: 0 on success, -1 on failure
4522 *
4523 * Update the connection parameters when in connected state so that the
4524 * driver uses the updated parameters for subsequent roaming. This is
4525 * used only with drivers that implement internal BSS selection and
4526 * roaming.
4527 */
4528 int (*update_connect_params)(
4529 void *priv, struct wpa_driver_associate_params *params,
4530 enum wpa_drv_update_connect_params_mask mask);
Roshan Pius3a1667e2018-07-03 15:17:14 -07004531
4532 /**
4533 * send_external_auth_status - Indicate the status of external
4534 * authentication processing to the host driver.
4535 * @priv: Private driver interface data
4536 * @params: Status of authentication processing.
4537 * Returns: 0 on success, -1 on failure
4538 */
4539 int (*send_external_auth_status)(void *priv,
4540 struct external_auth *params);
Hai Shalom74f70d42019-02-11 14:42:39 -08004541
4542 /**
4543 * set_4addr_mode - Set 4-address mode
4544 * @priv: Private driver interface data
4545 * @bridge_ifname: Bridge interface name
4546 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
4547 * Returns: 0 on success, < 0 on failure
4548 */
4549 int (*set_4addr_mode)(void *priv, const char *bridge_ifname, int val);
Hai Shalom81f62d82019-07-22 12:10:00 -07004550
4551 /**
4552 * update_dh_ie - Update DH IE
4553 * @priv: Private driver interface data
4554 * @peer_mac: Peer MAC address
4555 * @reason_code: Reacon code
4556 * @ie: DH IE
4557 * @ie_len: DH IE length in bytes
4558 * Returns: 0 on success, -1 on failure
4559 *
4560 * This callback is used to let the driver know the DH processing result
4561 * and DH IE for a pending association.
4562 */
4563 int (*update_dh_ie)(void *priv, const u8 *peer_mac, u16 reason_code,
4564 const u8 *ie, size_t ie_len);
Hai Shalomb755a2a2020-04-23 21:49:02 -07004565
4566 /**
4567 * dpp_listen - Notify driver about start/stop of DPP listen
4568 * @priv: Private driver interface data
4569 * @enable: Whether listen state is enabled (or disabled)
4570 * Returns: 0 on success, -1 on failure
4571 *
4572 * This optional callback can be used to update RX frame filtering to
4573 * explicitly allow reception of broadcast Public Action frames.
4574 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004575 int (*dpp_listen)(void *priv, bool enable);
Hai Shalomc1a21442022-02-04 13:43:00 -08004576
4577#ifdef CONFIG_TESTING_OPTIONS
4578 int (*register_frame)(void *priv, u16 type,
4579 const u8 *match, size_t match_len,
4580 bool multicast);
4581#endif /* CONFIG_TESTING_OPTIONS */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004582};
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004583
4584/**
4585 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
4586 */
4587enum wpa_event_type {
4588 /**
4589 * EVENT_ASSOC - Association completed
4590 *
4591 * This event needs to be delivered when the driver completes IEEE
4592 * 802.11 association or reassociation successfully.
4593 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
4594 * after this event has been generated. In addition, optional
4595 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
4596 * more information about the association. If the driver interface gets
4597 * both of these events at the same time, it can also include the
4598 * assoc_info data in EVENT_ASSOC call.
4599 */
4600 EVENT_ASSOC,
4601
4602 /**
4603 * EVENT_DISASSOC - Association lost
4604 *
4605 * This event should be called when association is lost either due to
4606 * receiving deauthenticate or disassociate frame from the AP or when
4607 * sending either of these frames to the current AP. If the driver
4608 * supports separate deauthentication event, EVENT_DISASSOC should only
4609 * be used for disassociation and EVENT_DEAUTH for deauthentication.
4610 * In AP mode, union wpa_event_data::disassoc_info is required.
4611 */
4612 EVENT_DISASSOC,
4613
4614 /**
4615 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
4616 *
4617 * This event must be delivered when a Michael MIC error is detected by
4618 * the local driver. Additional data for event processing is
4619 * provided with union wpa_event_data::michael_mic_failure. This
4620 * information is used to request new encyption key and to initiate
4621 * TKIP countermeasures if needed.
4622 */
4623 EVENT_MICHAEL_MIC_FAILURE,
4624
4625 /**
4626 * EVENT_SCAN_RESULTS - Scan results available
4627 *
4628 * This event must be called whenever scan results are available to be
4629 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4630 * is expected to be used some time after struct wpa_driver_ops::scan()
4631 * is called. If the driver provides an unsolicited event when the scan
4632 * has been completed, this event can be used to trigger
4633 * EVENT_SCAN_RESULTS call. If such event is not available from the
4634 * driver, the driver wrapper code is expected to use a registered
4635 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
4636 * scan is expected to be completed. Optional information about
4637 * completed scan can be provided with union wpa_event_data::scan_info.
4638 */
4639 EVENT_SCAN_RESULTS,
4640
4641 /**
4642 * EVENT_ASSOCINFO - Report optional extra information for association
4643 *
4644 * This event can be used to report extra association information for
4645 * EVENT_ASSOC processing. This extra information includes IEs from
4646 * association frames and Beacon/Probe Response frames in union
4647 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4648 * EVENT_ASSOC. Alternatively, the driver interface can include
4649 * assoc_info data in the EVENT_ASSOC call if it has all the
4650 * information available at the same point.
4651 */
4652 EVENT_ASSOCINFO,
4653
4654 /**
4655 * EVENT_INTERFACE_STATUS - Report interface status changes
4656 *
4657 * This optional event can be used to report changes in interface
4658 * status (interface added/removed) using union
4659 * wpa_event_data::interface_status. This can be used to trigger
4660 * wpa_supplicant to stop and re-start processing for the interface,
4661 * e.g., when a cardbus card is ejected/inserted.
4662 */
4663 EVENT_INTERFACE_STATUS,
4664
4665 /**
4666 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4667 *
4668 * This event can be used to inform wpa_supplicant about candidates for
4669 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4670 * for scan request (ap_scan=2 mode), this event is required for
4671 * pre-authentication. If wpa_supplicant is performing scan request
4672 * (ap_scan=1), this event is optional since scan results can be used
4673 * to add pre-authentication candidates. union
4674 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4675 * candidate and priority of the candidate, e.g., based on the signal
4676 * strength, in order to try to pre-authenticate first with candidates
4677 * that are most likely targets for re-association.
4678 *
4679 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4680 * on the candidate list. In addition, it can be called for the current
4681 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4682 * will automatically skip pre-authentication in cases where a valid
4683 * PMKSA exists. When more than one candidate exists, this event should
4684 * be generated once for each candidate.
4685 *
4686 * Driver will be notified about successful pre-authentication with
4687 * struct wpa_driver_ops::add_pmkid() calls.
4688 */
4689 EVENT_PMKID_CANDIDATE,
4690
4691 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004692 * EVENT_TDLS - Request TDLS operation
4693 *
4694 * This event can be used to request a TDLS operation to be performed.
4695 */
4696 EVENT_TDLS,
4697
4698 /**
4699 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4700 *
4701 * The driver is expected to report the received FT IEs from
4702 * FT authentication sequence from the AP. The FT IEs are included in
4703 * the extra information in union wpa_event_data::ft_ies.
4704 */
4705 EVENT_FT_RESPONSE,
4706
4707 /**
4708 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4709 *
4710 * The driver can use this event to inform wpa_supplicant about a STA
4711 * in an IBSS with which protected frames could be exchanged. This
4712 * event starts RSN authentication with the other STA to authenticate
4713 * the STA and set up encryption keys with it.
4714 */
4715 EVENT_IBSS_RSN_START,
4716
4717 /**
4718 * EVENT_AUTH - Authentication result
4719 *
4720 * This event should be called when authentication attempt has been
4721 * completed. This is only used if the driver supports separate
4722 * authentication step (struct wpa_driver_ops::authenticate).
4723 * Information about authentication result is included in
4724 * union wpa_event_data::auth.
4725 */
4726 EVENT_AUTH,
4727
4728 /**
4729 * EVENT_DEAUTH - Authentication lost
4730 *
4731 * This event should be called when authentication is lost either due
4732 * to receiving deauthenticate frame from the AP or when sending that
4733 * frame to the current AP.
4734 * In AP mode, union wpa_event_data::deauth_info is required.
4735 */
4736 EVENT_DEAUTH,
4737
4738 /**
4739 * EVENT_ASSOC_REJECT - Association rejected
4740 *
4741 * This event should be called when (re)association attempt has been
4742 * rejected by the AP. Information about the association response is
4743 * included in union wpa_event_data::assoc_reject.
4744 */
4745 EVENT_ASSOC_REJECT,
4746
4747 /**
4748 * EVENT_AUTH_TIMED_OUT - Authentication timed out
4749 */
4750 EVENT_AUTH_TIMED_OUT,
4751
4752 /**
4753 * EVENT_ASSOC_TIMED_OUT - Association timed out
4754 */
4755 EVENT_ASSOC_TIMED_OUT,
4756
4757 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004758 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
4759 */
4760 EVENT_WPS_BUTTON_PUSHED,
4761
4762 /**
4763 * EVENT_TX_STATUS - Report TX status
4764 */
4765 EVENT_TX_STATUS,
4766
4767 /**
4768 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
4769 */
4770 EVENT_RX_FROM_UNKNOWN,
4771
4772 /**
4773 * EVENT_RX_MGMT - Report RX of a management frame
4774 */
4775 EVENT_RX_MGMT,
4776
4777 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004778 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
4779 *
4780 * This event is used to indicate when the driver has started the
4781 * requested remain-on-channel duration. Information about the
4782 * operation is included in union wpa_event_data::remain_on_channel.
4783 */
4784 EVENT_REMAIN_ON_CHANNEL,
4785
4786 /**
4787 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
4788 *
4789 * This event is used to indicate when the driver has completed
4790 * remain-on-channel duration, i.e., may noot be available on the
4791 * requested channel anymore. Information about the
4792 * operation is included in union wpa_event_data::remain_on_channel.
4793 */
4794 EVENT_CANCEL_REMAIN_ON_CHANNEL,
4795
4796 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004797 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
4798 *
4799 * This event is used to indicate when a Probe Request frame has been
4800 * received. Information about the received frame is included in
4801 * union wpa_event_data::rx_probe_req. The driver is required to report
4802 * these events only after successfully completed probe_req_report()
4803 * commands to request the events (i.e., report parameter is non-zero)
4804 * in station mode. In AP mode, Probe Request frames should always be
4805 * reported.
4806 */
4807 EVENT_RX_PROBE_REQ,
4808
4809 /**
4810 * EVENT_NEW_STA - New wired device noticed
4811 *
4812 * This event is used to indicate that a new device has been detected
4813 * in a network that does not use association-like functionality (i.e.,
4814 * mainly wired Ethernet). This can be used to start EAPOL
4815 * authenticator when receiving a frame from a device. The address of
4816 * the device is included in union wpa_event_data::new_sta.
4817 */
4818 EVENT_NEW_STA,
4819
4820 /**
4821 * EVENT_EAPOL_RX - Report received EAPOL frame
4822 *
4823 * When in AP mode with hostapd, this event is required to be used to
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004824 * deliver the receive EAPOL frames from the driver.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004825 */
4826 EVENT_EAPOL_RX,
4827
4828 /**
4829 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4830 *
4831 * This event is used to indicate changes in the signal strength
4832 * observed in frames received from the current AP if signal strength
4833 * monitoring has been enabled with signal_monitor().
4834 */
4835 EVENT_SIGNAL_CHANGE,
4836
4837 /**
4838 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4839 *
4840 * This event is used to indicate that the interface was enabled after
4841 * having been previously disabled, e.g., due to rfkill.
4842 */
4843 EVENT_INTERFACE_ENABLED,
4844
4845 /**
4846 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4847 *
4848 * This event is used to indicate that the interface was disabled,
4849 * e.g., due to rfkill.
4850 */
4851 EVENT_INTERFACE_DISABLED,
4852
4853 /**
4854 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4855 *
4856 * This event is used to indicate that the channel list has changed,
4857 * e.g., because of a regulatory domain change triggered by scan
4858 * results including an AP advertising a country code.
4859 */
4860 EVENT_CHANNEL_LIST_CHANGED,
4861
4862 /**
4863 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4864 *
4865 * This event is used to indicate that the driver cannot maintain this
4866 * interface in its operation mode anymore. The most likely use for
4867 * this is to indicate that AP mode operation is not available due to
4868 * operating channel would need to be changed to a DFS channel when
4869 * the driver does not support radar detection and another virtual
4870 * interfaces caused the operating channel to change. Other similar
4871 * resource conflicts could also trigger this for station mode
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07004872 * interfaces. This event can be propagated when channel switching
4873 * fails.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004874 */
4875 EVENT_INTERFACE_UNAVAILABLE,
4876
4877 /**
4878 * EVENT_BEST_CHANNEL
4879 *
4880 * Driver generates this event whenever it detects a better channel
4881 * (e.g., based on RSSI or channel use). This information can be used
4882 * to improve channel selection for a new AP/P2P group.
4883 */
4884 EVENT_BEST_CHANNEL,
4885
4886 /**
4887 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4888 *
4889 * This event should be called when a Deauthentication frame is dropped
4890 * due to it not being protected (MFP/IEEE 802.11w).
4891 * union wpa_event_data::unprot_deauth is required to provide more
4892 * details of the frame.
4893 */
4894 EVENT_UNPROT_DEAUTH,
4895
4896 /**
4897 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4898 *
4899 * This event should be called when a Disassociation frame is dropped
4900 * due to it not being protected (MFP/IEEE 802.11w).
4901 * union wpa_event_data::unprot_disassoc is required to provide more
4902 * details of the frame.
4903 */
4904 EVENT_UNPROT_DISASSOC,
4905
4906 /**
4907 * EVENT_STATION_LOW_ACK
4908 *
4909 * Driver generates this event whenever it detected that a particular
4910 * station was lost. Detection can be through massive transmission
4911 * failures for example.
4912 */
4913 EVENT_STATION_LOW_ACK,
4914
4915 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004916 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4917 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004918 EVENT_IBSS_PEER_LOST,
4919
4920 /**
4921 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4922 *
4923 * This event carries the new replay counter to notify wpa_supplicant
4924 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4925 * completed Group Key Handshake while the host (including
4926 * wpa_supplicant was sleeping).
4927 */
4928 EVENT_DRIVER_GTK_REKEY,
4929
4930 /**
4931 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4932 */
4933 EVENT_SCHED_SCAN_STOPPED,
4934
4935 /**
4936 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4937 *
4938 * This event indicates that the station responded to the poll
4939 * initiated with @poll_client.
4940 */
4941 EVENT_DRIVER_CLIENT_POLL_OK,
4942
4943 /**
4944 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4945 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07004946 EVENT_EAPOL_TX_STATUS,
4947
4948 /**
4949 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4950 *
4951 * Described in wpa_event_data.ch_switch
4952 * */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004953 EVENT_CH_SWITCH,
4954
4955 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07004956 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
4957 *
4958 * This is a pre-switch event indicating the shortly following switch
4959 * of operating channels.
4960 *
4961 * Described in wpa_event_data.ch_switch
4962 */
4963 EVENT_CH_SWITCH_STARTED,
4964 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004965 * EVENT_WNM - Request WNM operation
4966 *
4967 * This event can be used to request a WNM operation to be performed.
4968 */
Dmitry Shmidtf8623282013-02-20 14:34:59 -08004969 EVENT_WNM,
4970
4971 /**
4972 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4973 *
4974 * This event indicates that the driver reported a connection failure
4975 * with the specified client (for example, max client reached, etc.) in
4976 * AP mode.
4977 */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004978 EVENT_CONNECT_FAILED_REASON,
4979
4980 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004981 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004982 *
4983 * A radar has been detected on the supplied frequency, hostapd should
4984 * react accordingly (e.g., change channel).
4985 */
4986 EVENT_DFS_RADAR_DETECTED,
4987
4988 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004989 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004990 *
4991 * After a successful CAC, the channel can be marked clear and used.
4992 */
4993 EVENT_DFS_CAC_FINISHED,
4994
4995 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004996 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004997 *
4998 * The CAC was not successful, and the channel remains in the previous
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004999 * state. This may happen due to a radar being detected or other
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005000 * external influences.
5001 */
5002 EVENT_DFS_CAC_ABORTED,
5003
5004 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08005005 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005006 *
5007 * The channel which was previously unavailable is now available again.
5008 */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005009 EVENT_DFS_NOP_FINISHED,
5010
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005011 /**
5012 * EVENT_SURVEY - Received survey data
5013 *
5014 * This event gets triggered when a driver query is issued for survey
5015 * data and the requested data becomes available. The returned data is
5016 * stored in struct survey_results. The results provide at most one
5017 * survey entry for each frequency and at minimum will provide one
5018 * survey entry for one frequency. The survey data can be os_malloc()'d
5019 * and then os_free()'d, so the event callback must only copy data.
5020 */
5021 EVENT_SURVEY,
5022
5023 /**
5024 * EVENT_SCAN_STARTED - Scan started
5025 *
5026 * This indicates that driver has started a scan operation either based
5027 * on a request from wpa_supplicant/hostapd or from another application.
5028 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
5029 * completed (either successfully or by getting cancelled).
5030 */
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08005031 EVENT_SCAN_STARTED,
5032
5033 /**
5034 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
5035 *
5036 * This event indicates a set of frequency ranges that should be avoided
5037 * to reduce issues due to interference or internal co-existence
5038 * information in the driver.
5039 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005040 EVENT_AVOID_FREQUENCIES,
5041
5042 /**
5043 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
5044 */
5045 EVENT_NEW_PEER_CANDIDATE,
5046
5047 /**
5048 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
5049 *
5050 * Indicates a pair of primary and secondary channels chosen by ACS
5051 * in device.
5052 */
5053 EVENT_ACS_CHANNEL_SELECTED,
Dmitry Shmidt7f656022015-02-25 14:36:37 -08005054
5055 /**
5056 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
5057 * been started.
5058 *
5059 * This event indicates that channel availability check has been started
5060 * on a DFS frequency by a driver that supports DFS Offload.
5061 */
5062 EVENT_DFS_CAC_STARTED,
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005063
5064 /**
5065 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
5066 */
5067 EVENT_P2P_LO_STOP,
Paul Stewart092955c2017-02-06 09:13:09 -08005068
5069 /**
5070 * EVENT_BEACON_LOSS - Beacon loss detected
5071 *
5072 * This event indicates that no Beacon frames has been received from
5073 * the current AP. This may indicate that the AP is not anymore in
5074 * range.
5075 */
5076 EVENT_BEACON_LOSS,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005077
5078 /**
5079 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
5080 * done previously (Pre-CAC) on the channel has expired. This would
5081 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
5082 * channel will be moved from available to usable. A new CAC has to be
5083 * performed before start operating on this channel.
5084 */
5085 EVENT_DFS_PRE_CAC_EXPIRED,
Roshan Pius3a1667e2018-07-03 15:17:14 -07005086
5087 /**
5088 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
5089 * that do not define separate commands for authentication and
5090 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
5091 * authentication to wpa_supplicant. This event carries all the
5092 * necessary information from the host driver for the authentication to
5093 * happen.
5094 */
5095 EVENT_EXTERNAL_AUTH,
5096
5097 /**
5098 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
5099 *
5100 * This event should be indicated when the driver completes the 4-way
5101 * handshake. This event should be preceded by an EVENT_ASSOC that
5102 * indicates the completion of IEEE 802.11 association.
5103 */
5104 EVENT_PORT_AUTHORIZED,
5105
5106 /**
5107 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
5108 * change event.
5109 */
5110 EVENT_STATION_OPMODE_CHANGED,
5111
5112 /**
5113 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
5114 *
5115 * This event is emitted when the MAC changes while the interface is
5116 * enabled. When an interface was disabled and becomes enabled, it
5117 * must be always assumed that the MAC possibly changed.
5118 */
5119 EVENT_INTERFACE_MAC_CHANGED,
5120
5121 /**
5122 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
5123 *
5124 * This event is emitted when an interface is added/removed for WDS STA.
5125 */
5126 EVENT_WDS_STA_INTERFACE_STATUS,
Hai Shalom81f62d82019-07-22 12:10:00 -07005127
5128 /**
5129 * EVENT_UPDATE_DH - Notification of updated DH information
5130 */
5131 EVENT_UPDATE_DH,
Hai Shalomfdcde762020-04-02 11:19:20 -07005132
5133 /**
5134 * EVENT_UNPROT_BEACON - Unprotected Beacon frame received
5135 *
5136 * This event should be called when a Beacon frame is dropped due to it
5137 * not being protected correctly. union wpa_event_data::unprot_beacon
5138 * is required to provide more details of the frame.
5139 */
5140 EVENT_UNPROT_BEACON,
Hai Shalomc1a21442022-02-04 13:43:00 -08005141
5142 /**
5143 * EVENT_TX_WAIT_EXPIRE - TX wait timed out
5144 *
5145 * This event is used to indicate when the driver has completed
5146 * wait for a response frame based on a TX request that specified a
5147 * non-zero wait time and that has not been explicitly cancelled.
5148 */
5149 EVENT_TX_WAIT_EXPIRE,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005150};
5151
5152
5153/**
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005154 * struct freq_survey - Channel survey info
5155 *
5156 * @ifidx: Interface index in which this survey was observed
5157 * @freq: Center of frequency of the surveyed channel
5158 * @nf: Channel noise floor in dBm
5159 * @channel_time: Amount of time in ms the radio spent on the channel
5160 * @channel_time_busy: Amount of time in ms the radio detected some signal
5161 * that indicated to the radio the channel was not clear
5162 * @channel_time_rx: Amount of time the radio spent receiving data
5163 * @channel_time_tx: Amount of time the radio spent transmitting data
5164 * @filled: bitmask indicating which fields have been reported, see
5165 * SURVEY_HAS_* defines.
5166 * @list: Internal list pointers
5167 */
5168struct freq_survey {
5169 u32 ifidx;
5170 unsigned int freq;
5171 s8 nf;
5172 u64 channel_time;
5173 u64 channel_time_busy;
5174 u64 channel_time_rx;
5175 u64 channel_time_tx;
5176 unsigned int filled;
5177 struct dl_list list;
5178};
5179
5180#define SURVEY_HAS_NF BIT(0)
5181#define SURVEY_HAS_CHAN_TIME BIT(1)
5182#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
5183#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
5184#define SURVEY_HAS_CHAN_TIME_TX BIT(4)
5185
Hai Shalom60840252021-02-19 19:02:11 -08005186/**
5187 * enum sta_connect_fail_reason_codes - STA connect failure reason code values
5188 * @STA_CONNECT_FAIL_REASON_UNSPECIFIED: No reason code specified for
5189 * connection failure.
5190 * @STA_CONNECT_FAIL_REASON_NO_BSS_FOUND: No Probe Response frame received
5191 * for unicast Probe Request frame.
5192 * @STA_CONNECT_FAIL_REASON_AUTH_TX_FAIL: STA failed to send auth request.
5193 * @STA_CONNECT_FAIL_REASON_AUTH_NO_ACK_RECEIVED: AP didn't send ACK for
5194 * auth request.
5195 * @STA_CONNECT_FAIL_REASON_AUTH_NO_RESP_RECEIVED: Auth response is not
5196 * received from AP.
5197 * @STA_CONNECT_FAIL_REASON_ASSOC_REQ_TX_FAIL: STA failed to send
5198 * Association Request frame.
5199 * @STA_CONNECT_FAIL_REASON_ASSOC_NO_ACK_RECEIVED: AP didn't send ACK for
5200 * Association Request frame.
5201 * @STA_CONNECT_FAIL_REASON_ASSOC_NO_RESP_RECEIVED: Association Response
5202 * frame is not received from AP.
5203 */
5204enum sta_connect_fail_reason_codes {
5205 STA_CONNECT_FAIL_REASON_UNSPECIFIED = 0,
5206 STA_CONNECT_FAIL_REASON_NO_BSS_FOUND = 1,
5207 STA_CONNECT_FAIL_REASON_AUTH_TX_FAIL = 2,
5208 STA_CONNECT_FAIL_REASON_AUTH_NO_ACK_RECEIVED = 3,
5209 STA_CONNECT_FAIL_REASON_AUTH_NO_RESP_RECEIVED = 4,
5210 STA_CONNECT_FAIL_REASON_ASSOC_REQ_TX_FAIL = 5,
5211 STA_CONNECT_FAIL_REASON_ASSOC_NO_ACK_RECEIVED = 6,
5212 STA_CONNECT_FAIL_REASON_ASSOC_NO_RESP_RECEIVED = 7,
5213};
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005214
5215/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005216 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
5217 */
5218union wpa_event_data {
5219 /**
5220 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
5221 *
5222 * This structure is optional for EVENT_ASSOC calls and required for
5223 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
5224 * driver interface does not need to generate separate EVENT_ASSOCINFO
5225 * calls.
5226 */
5227 struct assoc_info {
5228 /**
5229 * reassoc - Flag to indicate association or reassociation
5230 */
5231 int reassoc;
5232
5233 /**
5234 * req_ies - (Re)Association Request IEs
5235 *
5236 * If the driver generates WPA/RSN IE, this event data must be
5237 * returned for WPA handshake to have needed information. If
5238 * wpa_supplicant-generated WPA/RSN IE is used, this
5239 * information event is optional.
5240 *
5241 * This should start with the first IE (fixed fields before IEs
5242 * are not included).
5243 */
5244 const u8 *req_ies;
5245
5246 /**
5247 * req_ies_len - Length of req_ies in bytes
5248 */
5249 size_t req_ies_len;
5250
5251 /**
5252 * resp_ies - (Re)Association Response IEs
5253 *
5254 * Optional association data from the driver. This data is not
5255 * required WPA, but may be useful for some protocols and as
5256 * such, should be reported if this is available to the driver
5257 * interface.
5258 *
5259 * This should start with the first IE (fixed fields before IEs
5260 * are not included).
5261 */
5262 const u8 *resp_ies;
5263
5264 /**
5265 * resp_ies_len - Length of resp_ies in bytes
5266 */
5267 size_t resp_ies_len;
5268
5269 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08005270 * resp_frame - (Re)Association Response frame
5271 */
5272 const u8 *resp_frame;
5273
5274 /**
5275 * resp_frame_len - (Re)Association Response frame length
5276 */
5277 size_t resp_frame_len;
5278
5279 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005280 * beacon_ies - Beacon or Probe Response IEs
5281 *
5282 * Optional Beacon/ProbeResp data: IEs included in Beacon or
5283 * Probe Response frames from the current AP (i.e., the one
5284 * that the client just associated with). This information is
5285 * used to update WPA/RSN IE for the AP. If this field is not
5286 * set, the results from previous scan will be used. If no
5287 * data for the new AP is found, scan results will be requested
5288 * again (without scan request). At this point, the driver is
5289 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
5290 * used).
5291 *
5292 * This should start with the first IE (fixed fields before IEs
5293 * are not included).
5294 */
5295 const u8 *beacon_ies;
5296
5297 /**
5298 * beacon_ies_len - Length of beacon_ies */
5299 size_t beacon_ies_len;
5300
5301 /**
5302 * freq - Frequency of the operational channel in MHz
5303 */
5304 unsigned int freq;
5305
5306 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005307 * wmm_params - WMM parameters used in this association.
5308 */
5309 struct wmm_params wmm_params;
5310
5311 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005312 * addr - Station address (for AP mode)
5313 */
5314 const u8 *addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005315
5316 /**
5317 * The following is the key management offload information
5318 * @authorized
5319 * @key_replay_ctr
5320 * @key_replay_ctr_len
5321 * @ptk_kck
5322 * @ptk_kek_len
5323 * @ptk_kek
5324 * @ptk_kek_len
5325 */
5326
5327 /**
5328 * authorized - Status of key management offload,
5329 * 1 = successful
5330 */
5331 int authorized;
5332
5333 /**
5334 * key_replay_ctr - Key replay counter value last used
5335 * in a valid EAPOL-Key frame
5336 */
5337 const u8 *key_replay_ctr;
5338
5339 /**
5340 * key_replay_ctr_len - The length of key_replay_ctr
5341 */
5342 size_t key_replay_ctr_len;
5343
5344 /**
5345 * ptk_kck - The derived PTK KCK
5346 */
5347 const u8 *ptk_kck;
5348
5349 /**
5350 * ptk_kek_len - The length of ptk_kck
5351 */
5352 size_t ptk_kck_len;
5353
5354 /**
5355 * ptk_kek - The derived PTK KEK
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005356 * This is used in key management offload and also in FILS SK
5357 * offload.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005358 */
5359 const u8 *ptk_kek;
5360
5361 /**
5362 * ptk_kek_len - The length of ptk_kek
5363 */
5364 size_t ptk_kek_len;
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08005365
5366 /**
5367 * subnet_status - The subnet status:
5368 * 0 = unknown, 1 = unchanged, 2 = changed
5369 */
5370 u8 subnet_status;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005371
5372 /**
5373 * The following information is used in FILS SK offload
5374 * @fils_erp_next_seq_num
5375 * @fils_pmk
5376 * @fils_pmk_len
5377 * @fils_pmkid
5378 */
5379
5380 /**
5381 * fils_erp_next_seq_num - The next sequence number to use in
5382 * FILS ERP messages
5383 */
5384 u16 fils_erp_next_seq_num;
5385
5386 /**
5387 * fils_pmk - A new PMK if generated in case of FILS
5388 * authentication
5389 */
5390 const u8 *fils_pmk;
5391
5392 /**
5393 * fils_pmk_len - Length of fils_pmk
5394 */
5395 size_t fils_pmk_len;
5396
5397 /**
5398 * fils_pmkid - PMKID used or generated in FILS authentication
5399 */
5400 const u8 *fils_pmkid;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005401 } assoc_info;
5402
5403 /**
5404 * struct disassoc_info - Data for EVENT_DISASSOC events
5405 */
5406 struct disassoc_info {
5407 /**
5408 * addr - Station address (for AP mode)
5409 */
5410 const u8 *addr;
5411
5412 /**
5413 * reason_code - Reason Code (host byte order) used in
5414 * Deauthentication frame
5415 */
5416 u16 reason_code;
5417
5418 /**
5419 * ie - Optional IE(s) in Disassociation frame
5420 */
5421 const u8 *ie;
5422
5423 /**
5424 * ie_len - Length of ie buffer in octets
5425 */
5426 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005427
5428 /**
5429 * locally_generated - Whether the frame was locally generated
5430 */
5431 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005432 } disassoc_info;
5433
5434 /**
5435 * struct deauth_info - Data for EVENT_DEAUTH events
5436 */
5437 struct deauth_info {
5438 /**
5439 * addr - Station address (for AP mode)
5440 */
5441 const u8 *addr;
5442
5443 /**
5444 * reason_code - Reason Code (host byte order) used in
5445 * Deauthentication frame
5446 */
5447 u16 reason_code;
5448
5449 /**
5450 * ie - Optional IE(s) in Deauthentication frame
5451 */
5452 const u8 *ie;
5453
5454 /**
5455 * ie_len - Length of ie buffer in octets
5456 */
5457 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005458
5459 /**
5460 * locally_generated - Whether the frame was locally generated
5461 */
5462 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005463 } deauth_info;
5464
5465 /**
5466 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
5467 */
5468 struct michael_mic_failure {
5469 int unicast;
5470 const u8 *src;
5471 } michael_mic_failure;
5472
5473 /**
5474 * struct interface_status - Data for EVENT_INTERFACE_STATUS
5475 */
5476 struct interface_status {
Dmitry Shmidte4663042016-04-04 10:07:49 -07005477 unsigned int ifindex;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005478 char ifname[100];
5479 enum {
5480 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
5481 } ievent;
5482 } interface_status;
5483
5484 /**
5485 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
5486 */
5487 struct pmkid_candidate {
5488 /** BSSID of the PMKID candidate */
5489 u8 bssid[ETH_ALEN];
5490 /** Smaller the index, higher the priority */
5491 int index;
5492 /** Whether RSN IE includes pre-authenticate flag */
5493 int preauth;
5494 } pmkid_candidate;
5495
5496 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005497 * struct tdls - Data for EVENT_TDLS
5498 */
5499 struct tdls {
5500 u8 peer[ETH_ALEN];
5501 enum {
5502 TDLS_REQUEST_SETUP,
Dmitry Shmidt4dd28dc2015-03-10 11:21:43 -07005503 TDLS_REQUEST_TEARDOWN,
5504 TDLS_REQUEST_DISCOVER,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005505 } oper;
5506 u16 reason_code; /* for teardown */
5507 } tdls;
5508
5509 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07005510 * struct wnm - Data for EVENT_WNM
5511 */
5512 struct wnm {
5513 u8 addr[ETH_ALEN];
5514 enum {
5515 WNM_OPER_SLEEP,
5516 } oper;
5517 enum {
5518 WNM_SLEEP_ENTER,
5519 WNM_SLEEP_EXIT
5520 } sleep_action;
5521 int sleep_intval;
5522 u16 reason_code;
5523 u8 *buf;
5524 u16 buf_len;
5525 } wnm;
5526
5527 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005528 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
5529 *
5530 * During FT (IEEE 802.11r) authentication sequence, the driver is
5531 * expected to use this event to report received FT IEs (MDIE, FTIE,
5532 * RSN IE, TIE, possible resource request) to the supplicant. The FT
5533 * IEs for the next message will be delivered through the
5534 * struct wpa_driver_ops::update_ft_ies() callback.
5535 */
5536 struct ft_ies {
5537 const u8 *ies;
5538 size_t ies_len;
5539 int ft_action;
5540 u8 target_ap[ETH_ALEN];
5541 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
5542 const u8 *ric_ies;
5543 /** Length of ric_ies buffer in octets */
5544 size_t ric_ies_len;
5545 } ft_ies;
5546
5547 /**
5548 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
5549 */
5550 struct ibss_rsn_start {
5551 u8 peer[ETH_ALEN];
5552 } ibss_rsn_start;
5553
5554 /**
5555 * struct auth_info - Data for EVENT_AUTH events
5556 */
5557 struct auth_info {
5558 u8 peer[ETH_ALEN];
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005559 u8 bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005560 u16 auth_type;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005561 u16 auth_transaction;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005562 u16 status_code;
5563 const u8 *ies;
5564 size_t ies_len;
5565 } auth;
5566
5567 /**
5568 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
5569 */
5570 struct assoc_reject {
5571 /**
5572 * bssid - BSSID of the AP that rejected association
5573 */
5574 const u8 *bssid;
5575
5576 /**
5577 * resp_ies - (Re)Association Response IEs
5578 *
5579 * Optional association data from the driver. This data is not
5580 * required WPA, but may be useful for some protocols and as
5581 * such, should be reported if this is available to the driver
5582 * interface.
5583 *
5584 * This should start with the first IE (fixed fields before IEs
5585 * are not included).
5586 */
5587 const u8 *resp_ies;
5588
5589 /**
5590 * resp_ies_len - Length of resp_ies in bytes
5591 */
5592 size_t resp_ies_len;
5593
5594 /**
5595 * status_code - Status Code from (Re)association Response
5596 */
5597 u16 status_code;
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07005598
5599 /**
5600 * timed_out - Whether failure is due to timeout (etc.) rather
5601 * than explicit rejection response from the AP.
5602 */
5603 int timed_out;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08005604
5605 /**
5606 * timeout_reason - Reason for the timeout
5607 */
5608 const char *timeout_reason;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005609
5610 /**
5611 * fils_erp_next_seq_num - The next sequence number to use in
5612 * FILS ERP messages
5613 */
5614 u16 fils_erp_next_seq_num;
Hai Shalom60840252021-02-19 19:02:11 -08005615
5616 /**
5617 * reason_code - Connection failure reason code from the driver
5618 */
5619 enum sta_connect_fail_reason_codes reason_code;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005620 } assoc_reject;
5621
5622 struct timeout_event {
5623 u8 addr[ETH_ALEN];
5624 } timeout_event;
5625
5626 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005627 * struct tx_status - Data for EVENT_TX_STATUS events
5628 */
5629 struct tx_status {
5630 u16 type;
5631 u16 stype;
5632 const u8 *dst;
5633 const u8 *data;
5634 size_t data_len;
5635 int ack;
5636 } tx_status;
5637
5638 /**
5639 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
5640 */
5641 struct rx_from_unknown {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005642 const u8 *bssid;
5643 const u8 *addr;
5644 int wds;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005645 } rx_from_unknown;
5646
5647 /**
5648 * struct rx_mgmt - Data for EVENT_RX_MGMT events
5649 */
5650 struct rx_mgmt {
5651 const u8 *frame;
5652 size_t frame_len;
5653 u32 datarate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005654
5655 /**
Dmitry Shmidt98660862014-03-11 17:26:21 -07005656 * drv_priv - Pointer to store driver private BSS information
5657 *
5658 * If not set to NULL, this is used for comparison with
5659 * hostapd_data->drv_priv to determine which BSS should process
5660 * the frame.
5661 */
5662 void *drv_priv;
5663
5664 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005665 * freq - Frequency (in MHz) on which the frame was received
5666 */
5667 int freq;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005668
5669 /**
5670 * ssi_signal - Signal strength in dBm (or 0 if not available)
5671 */
5672 int ssi_signal;
5673 } rx_mgmt;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005674
5675 /**
5676 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
5677 *
5678 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
5679 */
5680 struct remain_on_channel {
5681 /**
5682 * freq - Channel frequency in MHz
5683 */
5684 unsigned int freq;
5685
5686 /**
5687 * duration - Duration to remain on the channel in milliseconds
5688 */
5689 unsigned int duration;
5690 } remain_on_channel;
5691
5692 /**
5693 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
5694 * @aborted: Whether the scan was aborted
5695 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
5696 * @num_freqs: Number of entries in freqs array
5697 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
5698 * SSID)
5699 * @num_ssids: Number of entries in ssids array
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08005700 * @external_scan: Whether the scan info is for an external scan
5701 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
5702 * 0 if the source of the scan event is a vendor scan
Dmitry Shmidt29333592017-01-09 12:27:11 -08005703 * @scan_start_tsf: Time when the scan started in terms of TSF of the
5704 * BSS that the interface that requested the scan is connected to
5705 * (if available).
5706 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
5707 * is set.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005708 */
5709 struct scan_info {
5710 int aborted;
5711 const int *freqs;
5712 size_t num_freqs;
5713 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
5714 size_t num_ssids;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08005715 int external_scan;
5716 int nl_scan_event;
Dmitry Shmidt29333592017-01-09 12:27:11 -08005717 u64 scan_start_tsf;
5718 u8 scan_start_tsf_bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005719 } scan_info;
5720
5721 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005722 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
5723 */
5724 struct rx_probe_req {
5725 /**
5726 * sa - Source address of the received Probe Request frame
5727 */
5728 const u8 *sa;
5729
5730 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005731 * da - Destination address of the received Probe Request frame
5732 * or %NULL if not available
5733 */
5734 const u8 *da;
5735
5736 /**
5737 * bssid - BSSID of the received Probe Request frame or %NULL
5738 * if not available
5739 */
5740 const u8 *bssid;
5741
5742 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005743 * ie - IEs from the Probe Request body
5744 */
5745 const u8 *ie;
5746
5747 /**
5748 * ie_len - Length of ie buffer in octets
5749 */
5750 size_t ie_len;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005751
5752 /**
5753 * signal - signal strength in dBm (or 0 if not available)
5754 */
5755 int ssi_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005756 } rx_probe_req;
5757
5758 /**
5759 * struct new_sta - Data for EVENT_NEW_STA events
5760 */
5761 struct new_sta {
5762 const u8 *addr;
5763 } new_sta;
5764
5765 /**
5766 * struct eapol_rx - Data for EVENT_EAPOL_RX events
5767 */
5768 struct eapol_rx {
5769 const u8 *src;
5770 const u8 *data;
5771 size_t data_len;
5772 } eapol_rx;
5773
5774 /**
5775 * signal_change - Data for EVENT_SIGNAL_CHANGE events
5776 */
5777 struct wpa_signal_info signal_change;
5778
5779 /**
5780 * struct best_channel - Data for EVENT_BEST_CHANNEL events
5781 * @freq_24: Best 2.4 GHz band channel frequency in MHz
5782 * @freq_5: Best 5 GHz band channel frequency in MHz
5783 * @freq_overall: Best channel frequency in MHz
5784 *
5785 * 0 can be used to indicate no preference in either band.
5786 */
5787 struct best_channel {
5788 int freq_24;
5789 int freq_5;
5790 int freq_overall;
5791 } best_chan;
5792
5793 struct unprot_deauth {
5794 const u8 *sa;
5795 const u8 *da;
5796 u16 reason_code;
5797 } unprot_deauth;
5798
5799 struct unprot_disassoc {
5800 const u8 *sa;
5801 const u8 *da;
5802 u16 reason_code;
5803 } unprot_disassoc;
5804
5805 /**
5806 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
5807 * @addr: station address
Paul Stewart092955c2017-02-06 09:13:09 -08005808 * @num_packets: Number of packets lost (consecutive packets not
5809 * acknowledged)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005810 */
5811 struct low_ack {
5812 u8 addr[ETH_ALEN];
Paul Stewart092955c2017-02-06 09:13:09 -08005813 u32 num_packets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005814 } low_ack;
5815
5816 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005817 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
5818 */
5819 struct ibss_peer_lost {
5820 u8 peer[ETH_ALEN];
5821 } ibss_peer_lost;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005822
5823 /**
5824 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
5825 */
5826 struct driver_gtk_rekey {
5827 const u8 *bssid;
5828 const u8 *replay_ctr;
5829 } driver_gtk_rekey;
5830
5831 /**
5832 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
5833 * @addr: station address
5834 */
5835 struct client_poll {
5836 u8 addr[ETH_ALEN];
5837 } client_poll;
5838
5839 /**
5840 * struct eapol_tx_status
5841 * @dst: Original destination
5842 * @data: Data starting with IEEE 802.1X header (!)
5843 * @data_len: Length of data
5844 * @ack: Indicates ack or lost frame
5845 *
5846 * This corresponds to hapd_send_eapol if the frame sent
5847 * there isn't just reported as EVENT_TX_STATUS.
5848 */
5849 struct eapol_tx_status {
5850 const u8 *dst;
5851 const u8 *data;
5852 int data_len;
5853 int ack;
5854 } eapol_tx_status;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005855
5856 /**
5857 * struct ch_switch
5858 * @freq: Frequency of new channel in MHz
5859 * @ht_enabled: Whether this is an HT channel
5860 * @ch_offset: Secondary channel offset
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08005861 * @ch_width: Channel width
5862 * @cf1: Center frequency 1
5863 * @cf2: Center frequency 2
Dmitry Shmidt04949592012-07-19 12:16:46 -07005864 */
5865 struct ch_switch {
5866 int freq;
5867 int ht_enabled;
5868 int ch_offset;
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08005869 enum chan_width ch_width;
5870 int cf1;
5871 int cf2;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005872 } ch_switch;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08005873
5874 /**
5875 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
5876 * @addr: Remote client address
5877 * @code: Reason code for connection failure
5878 */
5879 struct connect_failed_reason {
5880 u8 addr[ETH_ALEN];
5881 enum {
5882 MAX_CLIENT_REACHED,
5883 BLOCKED_CLIENT
5884 } code;
5885 } connect_failed_reason;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005886
5887 /**
5888 * struct dfs_event - Data for radar detected events
5889 * @freq: Frequency of the channel in MHz
5890 */
5891 struct dfs_event {
5892 int freq;
Dmitry Shmidt051af732013-10-22 13:52:46 -07005893 int ht_enabled;
5894 int chan_offset;
5895 enum chan_width chan_width;
5896 int cf1;
5897 int cf2;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005898 } dfs_event;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005899
5900 /**
5901 * survey_results - Survey result data for EVENT_SURVEY
5902 * @freq_filter: Requested frequency survey filter, 0 if request
5903 * was for all survey data
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005904 * @survey_list: Linked list of survey data (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005905 */
5906 struct survey_results {
5907 unsigned int freq_filter;
5908 struct dl_list survey_list; /* struct freq_survey */
5909 } survey_results;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005910
5911 /**
5912 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
5913 * @initiator: Initiator of the regulatory change
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07005914 * @type: Regulatory change type
5915 * @alpha2: Country code (or "" if not available)
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005916 */
5917 struct channel_list_changed {
5918 enum reg_change_initiator initiator;
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07005919 enum reg_type type;
5920 char alpha2[3];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005921 } channel_list_changed;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08005922
5923 /**
5924 * freq_range - List of frequency ranges
5925 *
5926 * This is used as the data with EVENT_AVOID_FREQUENCIES.
5927 */
5928 struct wpa_freq_range_list freq_range;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005929
5930 /**
5931 * struct mesh_peer
5932 *
5933 * @peer: Peer address
5934 * @ies: Beacon IEs
5935 * @ie_len: Length of @ies
5936 *
5937 * Notification of new candidate mesh peer.
5938 */
5939 struct mesh_peer {
5940 const u8 *peer;
5941 const u8 *ies;
5942 size_t ie_len;
5943 } mesh_peer;
5944
5945 /**
5946 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08005947 * @pri_freq: Selected primary frequency
5948 * @sec_freq: Selected secondary frequency
Hai Shalomfdcde762020-04-02 11:19:20 -07005949 * @edmg_channel: Selected EDMG channel
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005950 * @vht_seg0_center_ch: VHT mode Segment0 center channel
Hai Shalomfdcde762020-04-02 11:19:20 -07005951 * The value is the index of the channel center frequency for
5952 * 20 MHz, 40 MHz, and 80 MHz channels. The value is the center
5953 * frequency index of the primary 80 MHz segment for 160 MHz and
5954 * 80+80 MHz channels.
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005955 * @vht_seg1_center_ch: VHT mode Segment1 center channel
Hai Shalomfdcde762020-04-02 11:19:20 -07005956 * The value is zero for 20 MHz, 40 MHz, and 80 MHz channels. The
5957 * value is the index of the channel center frequency for 160 MHz
5958 * channels and the center frequency index of the secondary 80 MHz
5959 * segment for 80+80 MHz channels.
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005960 * @ch_width: Selected Channel width by driver. Driver may choose to
5961 * change hostapd configured ACS channel width due driver internal
5962 * channel restrictions.
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07005963 * hw_mode: Selected band (used with hw_mode=any)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005964 */
5965 struct acs_selected_channels {
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08005966 unsigned int pri_freq;
5967 unsigned int sec_freq;
Hai Shalomfdcde762020-04-02 11:19:20 -07005968 u8 edmg_channel;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005969 u8 vht_seg0_center_ch;
5970 u8 vht_seg1_center_ch;
5971 u16 ch_width;
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07005972 enum hostapd_hw_mode hw_mode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005973 } acs_selected_channels;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005974
5975 /**
5976 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
5977 * @reason_code: Reason for stopping offload
5978 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
5979 * scheduled.
5980 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
5981 * be stopped.
5982 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
5983 * parameters.
5984 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
5985 * supported by device.
5986 */
5987 struct p2p_lo_stop {
5988 enum {
5989 P2P_LO_STOPPED_REASON_COMPLETE = 0,
5990 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
5991 P2P_LO_STOPPED_REASON_INVALID_PARAM,
5992 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
5993 } reason_code;
5994 } p2p_lo_stop;
Roshan Pius3a1667e2018-07-03 15:17:14 -07005995
5996 /* For EVENT_EXTERNAL_AUTH */
5997 struct external_auth external_auth;
5998
5999 /**
6000 * struct sta_opmode - Station's operation mode change event
6001 * @addr: The station MAC address
6002 * @smps_mode: SMPS mode of the station
6003 * @chan_width: Channel width of the station
6004 * @rx_nss: RX_NSS of the station
6005 *
6006 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
6007 */
6008 struct sta_opmode {
6009 const u8 *addr;
6010 enum smps_mode smps_mode;
6011 enum chan_width chan_width;
6012 u8 rx_nss;
6013 } sta_opmode;
6014
6015 /**
6016 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
6017 */
6018 struct wds_sta_interface {
6019 const u8 *sta_addr;
6020 const char *ifname;
6021 enum {
6022 INTERFACE_ADDED,
6023 INTERFACE_REMOVED
6024 } istatus;
6025 } wds_sta_interface;
Hai Shalom81f62d82019-07-22 12:10:00 -07006026
6027 /**
6028 * struct update_dh - Data for EVENT_UPDATE_DH
6029 */
6030 struct update_dh {
6031 const u8 *peer;
6032 const u8 *ie;
6033 size_t ie_len;
6034 } update_dh;
Hai Shalomfdcde762020-04-02 11:19:20 -07006035
6036 /**
6037 * struct unprot_beacon - Data for EVENT_UNPROT_BEACON
6038 */
6039 struct unprot_beacon {
6040 const u8 *sa;
6041 } unprot_beacon;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006042};
6043
6044/**
6045 * wpa_supplicant_event - Report a driver event for wpa_supplicant
6046 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
6047 * with struct wpa_driver_ops::init()
6048 * @event: event type (defined above)
6049 * @data: possible extra data for the event
6050 *
6051 * Driver wrapper code should call this function whenever an event is received
6052 * from the driver.
6053 */
6054void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
6055 union wpa_event_data *data);
6056
Dmitry Shmidte4663042016-04-04 10:07:49 -07006057/**
6058 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
6059 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
6060 * with struct wpa_driver_ops::init()
6061 * @event: event type (defined above)
6062 * @data: possible extra data for the event
6063 *
6064 * Same as wpa_supplicant_event(), but we search for the interface in
6065 * wpa_global.
6066 */
6067void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
6068 union wpa_event_data *data);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006069
6070/*
6071 * The following inline functions are provided for convenience to simplify
6072 * event indication for some of the common events.
6073 */
6074
6075static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
6076 size_t ielen, int reassoc)
6077{
6078 union wpa_event_data event;
6079 os_memset(&event, 0, sizeof(event));
6080 event.assoc_info.reassoc = reassoc;
6081 event.assoc_info.req_ies = ie;
6082 event.assoc_info.req_ies_len = ielen;
6083 event.assoc_info.addr = addr;
6084 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
6085}
6086
6087static inline void drv_event_disassoc(void *ctx, const u8 *addr)
6088{
6089 union wpa_event_data event;
6090 os_memset(&event, 0, sizeof(event));
6091 event.disassoc_info.addr = addr;
6092 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
6093}
6094
6095static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
6096 size_t data_len)
6097{
6098 union wpa_event_data event;
6099 os_memset(&event, 0, sizeof(event));
6100 event.eapol_rx.src = src;
6101 event.eapol_rx.data = data;
6102 event.eapol_rx.data_len = data_len;
6103 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
6104}
6105
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08006106/* driver_common.c */
6107void wpa_scan_results_free(struct wpa_scan_results *res);
6108
6109/* Convert wpa_event_type to a string for logging */
6110const char * event_to_string(enum wpa_event_type event);
6111
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07006112/* Convert chan_width to a string for logging and control interfaces */
6113const char * channel_width_to_string(enum chan_width width);
6114
Hai Shalom74f70d42019-02-11 14:42:39 -08006115int channel_width_to_int(enum chan_width width);
6116
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08006117int ht_supported(const struct hostapd_hw_modes *mode);
6118int vht_supported(const struct hostapd_hw_modes *mode);
6119
6120struct wowlan_triggers *
6121wpa_get_wowlan_triggers(const char *wowlan_triggers,
6122 const struct wpa_driver_capa *capa);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07006123/* Convert driver flag to string */
6124const char * driver_flag_to_string(u64 flag);
Hai Shalomb755a2a2020-04-23 21:49:02 -07006125const char * driver_flag2_to_string(u64 flag2);
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08006126
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08006127/* NULL terminated array of linked in driver wrappers */
Dmitry Shmidt1d755d02015-04-28 10:34:29 -07006128extern const struct wpa_driver_ops *const wpa_drivers[];
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08006129
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07006130
6131/* Available drivers */
6132
6133#ifdef CONFIG_DRIVER_WEXT
6134extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
6135#endif /* CONFIG_DRIVER_WEXT */
6136#ifdef CONFIG_DRIVER_NL80211
6137/* driver_nl80211.c */
6138extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
6139#endif /* CONFIG_DRIVER_NL80211 */
6140#ifdef CONFIG_DRIVER_HOSTAP
6141extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
6142#endif /* CONFIG_DRIVER_HOSTAP */
6143#ifdef CONFIG_DRIVER_BSD
6144extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
6145#endif /* CONFIG_DRIVER_BSD */
6146#ifdef CONFIG_DRIVER_OPENBSD
6147/* driver_openbsd.c */
6148extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
6149#endif /* CONFIG_DRIVER_OPENBSD */
6150#ifdef CONFIG_DRIVER_NDIS
6151extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
6152#endif /* CONFIG_DRIVER_NDIS */
6153#ifdef CONFIG_DRIVER_WIRED
6154extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
6155#endif /* CONFIG_DRIVER_WIRED */
6156#ifdef CONFIG_DRIVER_MACSEC_QCA
6157/* driver_macsec_qca.c */
6158extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
6159#endif /* CONFIG_DRIVER_MACSEC_QCA */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08006160#ifdef CONFIG_DRIVER_MACSEC_LINUX
6161/* driver_macsec_linux.c */
6162extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops;
6163#endif /* CONFIG_DRIVER_MACSEC_LINUX */
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07006164#ifdef CONFIG_DRIVER_ROBOSWITCH
6165/* driver_roboswitch.c */
6166extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
6167#endif /* CONFIG_DRIVER_ROBOSWITCH */
6168#ifdef CONFIG_DRIVER_ATHEROS
6169/* driver_atheros.c */
6170extern const struct wpa_driver_ops wpa_driver_atheros_ops;
6171#endif /* CONFIG_DRIVER_ATHEROS */
6172#ifdef CONFIG_DRIVER_NONE
6173extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
6174#endif /* CONFIG_DRIVER_NONE */
6175
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006176#endif /* DRIVER_H */