blob: e8defaba2118913d2bef5c59743568ebf7ff510e [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
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800648 /*
649 * NOTE: Whenever adding new parameters here, please make sure
650 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
651 * matching changes.
652 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700653};
654
655/**
656 * struct wpa_driver_auth_params - Authentication parameters
657 * Data for struct wpa_driver_ops::authenticate().
658 */
659struct wpa_driver_auth_params {
660 int freq;
661 const u8 *bssid;
662 const u8 *ssid;
663 size_t ssid_len;
664 int auth_alg;
665 const u8 *ie;
666 size_t ie_len;
667 const u8 *wep_key[4];
668 size_t wep_key_len[4];
669 int wep_tx_keyidx;
670 int local_state_change;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800671
672 /**
673 * p2p - Whether this connection is a P2P group
674 */
675 int p2p;
676
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800677 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800678 * auth_data - Additional elements for Authentication frame
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800679 *
680 * This buffer starts with the Authentication transaction sequence
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800681 * number field. If no special handling of such elements is needed, this
682 * pointer is %NULL. This is used with SAE and FILS.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800683 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800684 const u8 *auth_data;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800685
686 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800687 * auth_data_len - Length of auth_data buffer in octets
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800688 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800689 size_t auth_data_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700690};
691
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800692/**
693 * enum wps_mode - WPS mode
694 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700695enum wps_mode {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800696 /**
697 * WPS_MODE_NONE - No WPS provisioning being used
698 */
699 WPS_MODE_NONE,
700
701 /**
702 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
703 */
704 WPS_MODE_OPEN,
705
706 /**
707 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
708 */
709 WPS_MODE_PRIVACY
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700710};
711
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800712/**
713 * struct hostapd_freq_params - Channel parameters
714 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700715struct hostapd_freq_params {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800716 /**
717 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
718 */
719 enum hostapd_hw_mode mode;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700720
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800721 /**
722 * freq - Primary channel center frequency in MHz
723 */
724 int freq;
725
726 /**
727 * channel - Channel number
728 */
729 int channel;
730
731 /**
732 * ht_enabled - Whether HT is enabled
733 */
734 int ht_enabled;
735
736 /**
737 * sec_channel_offset - Secondary channel offset for HT40
738 *
739 * 0 = HT40 disabled,
740 * -1 = HT40 enabled, secondary channel below primary,
741 * 1 = HT40 enabled, secondary channel above primary
742 */
743 int sec_channel_offset;
744
745 /**
746 * vht_enabled - Whether VHT is enabled
747 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700748 int vht_enabled;
749
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800750 /**
Hai Shalom81f62d82019-07-22 12:10:00 -0700751 * he_enabled - Whether HE is enabled
752 */
753 int he_enabled;
754
755 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800756 * center_freq1 - Segment 0 center frequency in MHz
757 *
758 * Valid for both HT and VHT.
759 */
760 int center_freq1;
761
762 /**
763 * center_freq2 - Segment 1 center frequency in MHz
764 *
765 * Non-zero only for bandwidth 80 and an 80+80 channel
766 */
767 int center_freq2;
768
769 /**
770 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
771 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700772 int bandwidth;
Hai Shalomc3565922019-10-28 11:58:20 -0700773
774 /**
775 * This structure describes the most essential parameters needed
776 * for IEEE 802.11ay EDMG configuration.
777 */
778 struct ieee80211_edmg_config edmg;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700779};
780
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700781/**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700782 * struct wpa_driver_sta_auth_params - Authentication parameters
783 * Data for struct wpa_driver_ops::sta_auth().
784 */
785struct wpa_driver_sta_auth_params {
786
787 /**
788 * own_addr - Source address and BSSID for authentication frame
789 */
790 const u8 *own_addr;
791
792 /**
793 * addr - MAC address of the station to associate
794 */
795 const u8 *addr;
796
797 /**
798 * seq - authentication sequence number
799 */
800 u16 seq;
801
802 /**
803 * status - authentication response status code
804 */
805 u16 status;
806
807 /**
808 * ie - authentication frame ie buffer
809 */
810 const u8 *ie;
811
812 /**
813 * len - ie buffer length
814 */
815 size_t len;
816
817 /**
818 * fils_auth - Indicates whether FILS authentication is being performed
819 */
820 int fils_auth;
821
822 /**
823 * fils_anonce - ANonce (required for FILS)
824 */
825 u8 fils_anonce[WPA_NONCE_LEN];
826
827 /**
828 * fils_snonce - SNonce (required for FILS)
829 */
830 u8 fils_snonce[WPA_NONCE_LEN];
831
832 /**
833 * fils_kek - key for encryption (required for FILS)
834 */
835 u8 fils_kek[WPA_KEK_MAX_LEN];
836
837 /**
838 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
839 */
840 size_t fils_kek_len;
841};
842
843/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700844 * struct wpa_driver_associate_params - Association parameters
845 * Data for struct wpa_driver_ops::associate().
846 */
847struct wpa_driver_associate_params {
848 /**
849 * bssid - BSSID of the selected AP
850 * This can be %NULL, if ap_scan=2 mode is used and the driver is
851 * responsible for selecting with which BSS to associate. */
852 const u8 *bssid;
853
854 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800855 * bssid_hint - BSSID of a proposed AP
856 *
857 * This indicates which BSS has been found a suitable candidate for
858 * initial association for drivers that use driver/firmwate-based BSS
859 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
860 * the driver from selecting other BSSes in the ESS.
861 */
862 const u8 *bssid_hint;
863
864 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700865 * ssid - The selected SSID
866 */
867 const u8 *ssid;
868
869 /**
870 * ssid_len - Length of the SSID (1..32)
871 */
872 size_t ssid_len;
873
874 /**
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700875 * freq - channel parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700876 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700877 struct hostapd_freq_params freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700878
879 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800880 * freq_hint - Frequency of the channel the proposed AP is using
881 *
882 * This provides a channel on which a suitable BSS has been found as a
883 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
884 * limit the driver from selecting other channels for
885 * driver/firmware-based BSS selection.
886 */
887 int freq_hint;
888
889 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700890 * bg_scan_period - Background scan period in seconds, 0 to disable
891 * background scan, or -1 to indicate no change to default driver
892 * configuration
893 */
894 int bg_scan_period;
895
896 /**
Dmitry Shmidt2ac5f602014-03-07 10:08:21 -0800897 * beacon_int - Beacon interval for IBSS or 0 to use driver default
898 */
899 int beacon_int;
900
901 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700902 * wpa_ie - WPA information element for (Re)Association Request
903 * WPA information element to be included in (Re)Association
904 * Request (including information element id and length). Use
905 * of this WPA IE is optional. If the driver generates the WPA
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700906 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700907 * key_mgmt_suite to select proper algorithms. In this case,
908 * the driver has to notify wpa_supplicant about the used WPA
909 * IE by generating an event that the interface code will
910 * convert into EVENT_ASSOCINFO data (see below).
911 *
912 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
913 * instead. The driver can determine which version is used by
914 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
915 * WPA2/RSN).
916 *
917 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
918 */
919 const u8 *wpa_ie;
920
921 /**
922 * wpa_ie_len - length of the wpa_ie
923 */
924 size_t wpa_ie_len;
925
926 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800927 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
928 */
929 unsigned int wpa_proto;
930
931 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800932 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700933 *
934 * This is usually ignored if @wpa_ie is used.
935 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800936 unsigned int pairwise_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700937
938 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800939 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700940 *
941 * This is usually ignored if @wpa_ie is used.
942 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800943 unsigned int group_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700944
945 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700946 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
947 *
948 * This is usually ignored if @wpa_ie is used.
949 */
950 unsigned int mgmt_group_suite;
951
952 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800953 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700954 *
955 * This is usually ignored if @wpa_ie is used.
956 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800957 unsigned int key_mgmt_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700958
959 /**
960 * auth_alg - Allowed authentication algorithms
961 * Bit field of WPA_AUTH_ALG_*
962 */
963 int auth_alg;
964
965 /**
966 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
967 */
968 int mode;
969
970 /**
971 * wep_key - WEP keys for static WEP configuration
972 */
973 const u8 *wep_key[4];
974
975 /**
976 * wep_key_len - WEP key length for static WEP configuration
977 */
978 size_t wep_key_len[4];
979
980 /**
981 * wep_tx_keyidx - WEP TX key index for static WEP configuration
982 */
983 int wep_tx_keyidx;
984
985 /**
986 * mgmt_frame_protection - IEEE 802.11w management frame protection
987 */
988 enum mfp_options mgmt_frame_protection;
989
990 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700991 * passphrase - RSN passphrase for PSK
992 *
993 * This value is made available only for WPA/WPA2-Personal (PSK) and
Hai Shalom74f70d42019-02-11 14:42:39 -0800994 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
995 * is the 8..63 character ASCII passphrase, if available. Please note
996 * that this can be %NULL if passphrase was not used to generate the
997 * PSK. In that case, the psk field must be used to fetch the PSK.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700998 */
999 const char *passphrase;
1000
1001 /**
1002 * psk - RSN PSK (alternative for passphrase for PSK)
1003 *
1004 * This value is made available only for WPA/WPA2-Personal (PSK) and
Hai Shalom74f70d42019-02-11 14:42:39 -08001005 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
1006 * is the 32-octet (256-bit) PSK, if available. The driver wrapper
1007 * should be prepared to handle %NULL value as an error.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001008 */
1009 const u8 *psk;
1010
1011 /**
1012 * drop_unencrypted - Enable/disable unencrypted frame filtering
1013 *
1014 * Configure the driver to drop all non-EAPOL frames (both receive and
1015 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
1016 * still be allowed for key negotiation.
1017 */
1018 int drop_unencrypted;
1019
1020 /**
1021 * prev_bssid - Previously used BSSID in this ESS
1022 *
1023 * When not %NULL, this is a request to use reassociation instead of
1024 * association.
1025 */
1026 const u8 *prev_bssid;
1027
1028 /**
1029 * wps - WPS mode
1030 *
1031 * If the driver needs to do special configuration for WPS association,
1032 * this variable provides more information on what type of association
1033 * is being requested. Most drivers should not need ot use this.
1034 */
1035 enum wps_mode wps;
1036
1037 /**
1038 * p2p - Whether this connection is a P2P group
1039 */
1040 int p2p;
1041
1042 /**
1043 * uapsd - UAPSD parameters for the network
1044 * -1 = do not change defaults
1045 * AP mode: 1 = enabled, 0 = disabled
1046 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
1047 */
1048 int uapsd;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001049
1050 /**
1051 * fixed_bssid - Whether to force this BSSID in IBSS mode
1052 * 1 = Fix this BSSID and prevent merges.
1053 * 0 = Do not fix BSSID.
1054 */
1055 int fixed_bssid;
1056
1057 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001058 * fixed_freq - Fix control channel in IBSS mode
1059 * 0 = don't fix control channel (default)
1060 * 1 = fix control channel; this prevents IBSS merging with another
1061 * channel
1062 */
1063 int fixed_freq;
1064
1065 /**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001066 * disable_ht - Disable HT (IEEE 802.11n) for this connection
1067 */
1068 int disable_ht;
1069
1070 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001071 * htcaps - HT Capabilities over-rides
1072 *
1073 * Only bits set in the mask will be used, and not all values are used
1074 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
1075 *
1076 * Pointer to struct ieee80211_ht_capabilities.
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001077 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001078 const u8 *htcaps;
1079
1080 /**
1081 * htcaps_mask - HT Capabilities over-rides mask
1082 *
1083 * Pointer to struct ieee80211_ht_capabilities.
1084 */
1085 const u8 *htcaps_mask;
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001086
1087#ifdef CONFIG_VHT_OVERRIDES
1088 /**
1089 * disable_vht - Disable VHT for this connection
1090 */
1091 int disable_vht;
1092
1093 /**
1094 * VHT capability overrides.
1095 */
1096 const struct ieee80211_vht_capabilities *vhtcaps;
1097 const struct ieee80211_vht_capabilities *vhtcaps_mask;
1098#endif /* CONFIG_VHT_OVERRIDES */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001099
Hai Shalomfdcde762020-04-02 11:19:20 -07001100#ifdef CONFIG_HE_OVERRIDES
1101 /**
1102 * disable_he - Disable HE for this connection
1103 */
1104 int disable_he;
1105#endif /* CONFIG_HE_OVERRIDES */
1106
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001107 /**
1108 * req_key_mgmt_offload - Request key management offload for connection
1109 *
1110 * Request key management offload for this connection if the device
1111 * supports it.
1112 */
1113 int req_key_mgmt_offload;
1114
1115 /**
Hai Shalomc3565922019-10-28 11:58:20 -07001116 * req_handshake_offload - Request EAPOL handshake offload
1117 *
1118 * Request EAPOL handshake offload for this connection if the device
1119 * supports it.
1120 */
1121 int req_handshake_offload;
1122
1123 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001124 * Flag for indicating whether this association includes support for
1125 * RRM (Radio Resource Measurements)
1126 */
1127 int rrm_used;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001128
1129 /**
1130 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1131 * AP as usual. Valid for DMG network only.
1132 */
1133 int pbss;
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001134
1135 /**
1136 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1137 */
1138 const u8 *fils_kek;
1139
1140 /**
1141 * fils_kek_len: Length of fils_kek in bytes
1142 */
1143 size_t fils_kek_len;
1144
1145 /**
1146 * fils_nonces - Nonces for FILS association frame protection
1147 * (AES-SIV AAD)
1148 */
1149 const u8 *fils_nonces;
1150
1151 /**
1152 * fils_nonces_len: Length of fils_nonce in bytes
1153 */
1154 size_t fils_nonces_len;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001155
1156 /**
1157 * fils_erp_username - Username part of keyName-NAI
1158 */
1159 const u8 *fils_erp_username;
1160
1161 /**
1162 * fils_erp_username_len - Length of fils_erp_username in bytes
1163 */
1164 size_t fils_erp_username_len;
1165
1166 /**
1167 * fils_erp_realm - Realm/domain name to use in FILS ERP
1168 */
1169 const u8 *fils_erp_realm;
1170
1171 /**
1172 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1173 */
1174 size_t fils_erp_realm_len;
1175
1176 /**
1177 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1178 * messages
1179 */
1180 u16 fils_erp_next_seq_num;
1181
1182 /**
1183 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1184 * specified by fils_erp_username@fils_erp_realm.
1185 */
1186 const u8 *fils_erp_rrk;
1187
1188 /**
1189 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1190 */
1191 size_t fils_erp_rrk_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001192};
1193
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001194enum hide_ssid {
1195 NO_SSID_HIDING,
1196 HIDDEN_SSID_ZERO_LEN,
1197 HIDDEN_SSID_ZERO_CONTENTS
1198};
1199
Hai Shalom81f62d82019-07-22 12:10:00 -07001200enum ch_switch_state {
1201 CH_SW_STARTED,
1202 CH_SW_FINISHED
1203};
1204
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001205struct wowlan_triggers {
1206 u8 any;
1207 u8 disconnect;
1208 u8 magic_pkt;
1209 u8 gtk_rekey_failure;
1210 u8 eap_identity_req;
1211 u8 four_way_handshake;
1212 u8 rfkill_release;
1213};
1214
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001215struct wpa_driver_ap_params {
1216 /**
1217 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1218 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001219 u8 *head;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001220
1221 /**
1222 * head_len - Length of the head buffer in octets
1223 */
1224 size_t head_len;
1225
1226 /**
1227 * tail - Beacon tail following TIM IE
1228 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001229 u8 *tail;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001230
1231 /**
1232 * tail_len - Length of the tail buffer in octets
1233 */
1234 size_t tail_len;
1235
1236 /**
1237 * dtim_period - DTIM period
1238 */
1239 int dtim_period;
1240
1241 /**
1242 * beacon_int - Beacon interval
1243 */
1244 int beacon_int;
1245
1246 /**
1247 * basic_rates: -1 terminated array of basic rates in 100 kbps
1248 *
1249 * This parameter can be used to set a specific basic rate set for the
1250 * BSS. If %NULL, default basic rate set is used.
1251 */
1252 int *basic_rates;
1253
1254 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001255 * beacon_rate: Beacon frame data rate
1256 *
1257 * This parameter can be used to set a specific Beacon frame data rate
1258 * for the BSS. The interpretation of this value depends on the
1259 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS). If
1260 * beacon_rate == 0 and rate_type == 0 (BEACON_RATE_LEGACY), the default
1261 * Beacon frame data rate is used.
1262 */
1263 unsigned int beacon_rate;
1264
1265 /**
1266 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT)
1267 */
1268 enum beacon_rate_type rate_type;
1269
1270 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001271 * proberesp - Probe Response template
1272 *
1273 * This is used by drivers that reply to Probe Requests internally in
1274 * AP mode and require the full Probe Response template.
1275 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001276 u8 *proberesp;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001277
1278 /**
1279 * proberesp_len - Length of the proberesp buffer in octets
1280 */
1281 size_t proberesp_len;
1282
1283 /**
1284 * ssid - The SSID to use in Beacon/Probe Response frames
1285 */
1286 const u8 *ssid;
1287
1288 /**
1289 * ssid_len - Length of the SSID (1..32)
1290 */
1291 size_t ssid_len;
1292
1293 /**
1294 * hide_ssid - Whether to hide the SSID
1295 */
1296 enum hide_ssid hide_ssid;
1297
1298 /**
1299 * pairwise_ciphers - WPA_CIPHER_* bitfield
1300 */
1301 unsigned int pairwise_ciphers;
1302
1303 /**
1304 * group_cipher - WPA_CIPHER_*
1305 */
1306 unsigned int group_cipher;
1307
1308 /**
1309 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1310 */
1311 unsigned int key_mgmt_suites;
1312
1313 /**
1314 * auth_algs - WPA_AUTH_ALG_* bitfield
1315 */
1316 unsigned int auth_algs;
1317
1318 /**
1319 * wpa_version - WPA_PROTO_* bitfield
1320 */
1321 unsigned int wpa_version;
1322
1323 /**
1324 * privacy - Whether privacy is used in the BSS
1325 */
1326 int privacy;
1327
1328 /**
1329 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1330 *
1331 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1332 * not use the full Beacon template.
1333 */
1334 const struct wpabuf *beacon_ies;
1335
1336 /**
1337 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1338 *
1339 * This is used to add IEs like WPS IE and P2P IE by drivers that
1340 * reply to Probe Request frames internally.
1341 */
1342 const struct wpabuf *proberesp_ies;
1343
1344 /**
1345 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1346 *
1347 * This is used to add IEs like WPS IE by drivers that reply to
1348 * (Re)Association Request frames internally.
1349 */
1350 const struct wpabuf *assocresp_ies;
1351
1352 /**
1353 * isolate - Whether to isolate frames between associated stations
1354 *
1355 * If this is non-zero, the AP is requested to disable forwarding of
1356 * frames between associated stations.
1357 */
1358 int isolate;
1359
1360 /**
1361 * cts_protect - Whether CTS protection is enabled
1362 */
1363 int cts_protect;
1364
1365 /**
1366 * preamble - Whether short preamble is enabled
1367 */
1368 int preamble;
1369
1370 /**
1371 * short_slot_time - Whether short slot time is enabled
1372 *
1373 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1374 * not set (e.g., when 802.11g mode is not in use)
1375 */
1376 int short_slot_time;
1377
1378 /**
1379 * ht_opmode - HT operation mode or -1 if HT not in use
1380 */
1381 int ht_opmode;
1382
1383 /**
1384 * interworking - Whether Interworking is enabled
1385 */
1386 int interworking;
1387
1388 /**
1389 * hessid - Homogeneous ESS identifier or %NULL if not set
1390 */
1391 const u8 *hessid;
1392
1393 /**
1394 * access_network_type - Access Network Type (0..15)
1395 *
1396 * This is used for filtering Probe Request frames when Interworking is
1397 * enabled.
1398 */
1399 u8 access_network_type;
Dmitry Shmidt04949592012-07-19 12:16:46 -07001400
1401 /**
1402 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1403 *
1404 * This is used by driver which advertises this capability.
1405 */
1406 int ap_max_inactivity;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001407
1408 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001409 * ctwindow - Client Traffic Window (in TUs)
1410 */
1411 u8 p2p_go_ctwindow;
1412
1413 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001414 * disable_dgaf - Whether group-addressed frames are disabled
1415 */
1416 int disable_dgaf;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001417
1418 /**
1419 * osen - Whether OSEN security is enabled
1420 */
1421 int osen;
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001422
1423 /**
1424 * freq - Channel parameters for dynamic bandwidth changes
1425 */
1426 struct hostapd_freq_params *freq;
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001427
1428 /**
1429 * reenable - Whether this is to re-enable beaconing
1430 */
1431 int reenable;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001432
1433 /**
1434 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1435 * infrastructure BSS. Valid only for DMG network.
1436 */
1437 int pbss;
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001438
1439 /**
1440 * multicast_to_unicast - Whether to use multicast_to_unicast
1441 *
1442 * If this is non-zero, the AP is requested to perform multicast to
1443 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1444 * 802.1Q). If enabled, such frames are to be sent to each station
1445 * separately, with the DA replaced by their own MAC address rather
1446 * than the group address.
1447 *
1448 * Note that this may break certain expectations of the receiver, such
1449 * as the ability to drop unicast IP packets received within multicast
1450 * L2 frames, or the ability to not send ICMP destination unreachable
1451 * messages for packets received in L2 multicast (which is required,
1452 * but the receiver can't tell the difference if this new option is
1453 * enabled.)
1454 *
1455 * This also doesn't implement the 802.11 DMS (directed multicast
1456 * service).
1457 */
1458 int multicast_to_unicast;
Hai Shalom74f70d42019-02-11 14:42:39 -08001459
1460 /**
1461 * ftm_responder - Whether FTM responder is enabled
1462 */
1463 int ftm_responder;
1464
1465 /**
1466 * lci - Binary data, the content of an LCI report IE with type 8 as
1467 * defined in IEEE Std 802.11-2016, 9.4.2.22.10
1468 */
1469 const struct wpabuf *lci;
1470
1471 /**
1472 * civic - Binary data, the content of a measurement report IE with
1473 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
1474 */
1475 const struct wpabuf *civic;
Hai Shalomc3565922019-10-28 11:58:20 -07001476
1477 /**
1478 * he_spr - Whether Spatial Reuse is enabled
1479 */
1480 int he_spr;
1481
1482 /**
1483 * he_spr_srg_obss_pd_min_offset - Minimum TX power offset
1484 */
1485 int he_spr_srg_obss_pd_min_offset;
1486
1487 /**
1488 * he_spr_srg_obss_pd_max_offset - Maximum TX power offset
1489 */
1490 int he_spr_srg_obss_pd_max_offset;
Hai Shalomfdcde762020-04-02 11:19:20 -07001491
1492 /**
1493 * he_bss_color - Whether the BSS Color is disabled
1494 */
1495 int he_bss_color_disabled;
1496
1497 /**
1498 * he_bss_color_partial - The BSS Color AID equation
1499 */
1500 int he_bss_color_partial;
1501
1502 /**
1503 * he_bss_color - The BSS Color of the AP
1504 */
1505 int he_bss_color;
1506
1507 /**
1508 * twt_responder - Whether Target Wait Time responder is enabled
1509 */
1510 int twt_responder;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001511};
1512
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001513struct wpa_driver_mesh_bss_params {
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001514#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1515#define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1516#define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1517#define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001518#define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001519 /*
1520 * TODO: Other mesh configuration parameters would go here.
1521 * See NL80211_MESHCONF_* for all the mesh config parameters.
1522 */
1523 unsigned int flags;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001524 int auto_plinks;
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001525 int peer_link_timeout;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001526 int max_peer_links;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001527 int rssi_threshold;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001528 u16 ht_opmode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001529};
1530
1531struct wpa_driver_mesh_join_params {
1532 const u8 *meshid;
1533 int meshid_len;
1534 const int *basic_rates;
1535 const u8 *ies;
1536 int ie_len;
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001537 struct hostapd_freq_params freq;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001538 int beacon_int;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001539 int dtim_period;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001540 struct wpa_driver_mesh_bss_params conf;
1541#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1542#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1543#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1544#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1545 unsigned int flags;
1546};
1547
Hai Shalomfdcde762020-04-02 11:19:20 -07001548struct wpa_driver_set_key_params {
1549 /**
1550 * ifname - Interface name (for multi-SSID/VLAN support) */
1551 const char *ifname;
1552
1553 /**
1554 * alg - Encryption algorithm
1555 *
1556 * (%WPA_ALG_NONE, %WPA_ALG_WEP, %WPA_ALG_TKIP, %WPA_ALG_CCMP,
Hai Shalom4fbc08f2020-05-18 12:37:00 -07001557 * %WPA_ALG_BIP_AES_CMAC_128, %WPA_ALG_GCMP, %WPA_ALG_GCMP_256,
1558 * %WPA_ALG_CCMP_256, %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1559 * %WPA_ALG_BIP_CMAC_256);
Hai Shalomfdcde762020-04-02 11:19:20 -07001560 * %WPA_ALG_NONE clears the key. */
1561 enum wpa_alg alg;
1562
1563 /**
1564 * addr - Address of the peer STA
1565 *
1566 * (BSSID of the current AP when setting pairwise key in station mode),
1567 * ff:ff:ff:ff:ff:ff for broadcast keys, %NULL for default keys that
1568 * are used both for broadcast and unicast; when clearing keys, %NULL
1569 * is used to indicate that both the broadcast-only and default key of
1570 * the specified key index is to be cleared */
1571 const u8 *addr;
1572
1573 /**
1574 * key_idx - Key index
1575 *
1576 * (0..3), usually 0 for unicast keys; 4..5 for IGTK; 6..7 for BIGTK */
1577 int key_idx;
1578
1579 /**
1580 * set_tx - Configure this key as the default Tx key
1581 *
1582 * Only used when driver does not support separate unicast/individual
1583 * key */
1584 int set_tx;
1585
1586 /**
1587 * seq - Sequence number/packet number
1588 *
1589 * seq_len octets, the next packet number to be used for in replay
1590 * protection; configured for Rx keys (in most cases, this is only used
1591 * with broadcast keys and set to zero for unicast keys); %NULL if not
1592 * set */
1593 const u8 *seq;
1594
1595 /**
1596 * seq_len - Length of the seq, depends on the algorithm
1597 *
1598 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets */
1599 size_t seq_len;
1600
1601 /**
1602 * key - Key buffer
1603 *
1604 * TKIP: 16-byte temporal key, 8-byte Tx Mic key, 8-byte Rx Mic Key */
1605 const u8 *key;
1606
1607 /**
1608 * key_len - Length of the key buffer in octets
1609 *
1610 * WEP: 5 or 13, TKIP: 32, CCMP/GCMP: 16, IGTK: 16 */
1611 size_t key_len;
1612
1613 /**
1614 * vlan_id - VLAN index (0..4095) for VLAN offload cases */
1615 int vlan_id;
1616
1617 /**
1618 * key_flag - Additional key flags
1619 *
1620 * %KEY_FLAG_MODIFY
1621 * Set when an already installed key must be updated.
1622 * So far the only use-case is changing RX/TX status for
1623 * pairwise keys. Must not be set when deleting a key.
1624 * %KEY_FLAG_DEFAULT
1625 * Set when the key is also a default key. Must not be set when
1626 * deleting a key.
1627 * %KEY_FLAG_RX
1628 * The key is valid for RX. Must not be set when deleting a key.
1629 * %KEY_FLAG_TX
1630 * The key is valid for TX. Must not be set when deleting a key.
1631 * %KEY_FLAG_GROUP
1632 * The key is a broadcast or group key.
1633 * %KEY_FLAG_PAIRWISE
1634 * The key is a pairwise key.
1635 * %KEY_FLAG_PMK
1636 * The key is a Pairwise Master Key (PMK).
1637 *
1638 * Valid and pre-defined combinations are:
1639 * %KEY_FLAG_GROUP_RX_TX
1640 * WEP key not to be installed as default key.
1641 * %KEY_FLAG_GROUP_RX_TX_DEFAULT
1642 * Default WEP or WPA-NONE key.
1643 * %KEY_FLAG_GROUP_RX
1644 * GTK key valid for RX only.
1645 * %KEY_FLAG_GROUP_TX_DEFAULT
1646 * GTK key valid for TX only, immediately taking over TX.
1647 * %KEY_FLAG_PAIRWISE_RX_TX
1648 * Pairwise key immediately becoming the active pairwise key.
1649 * %KEY_FLAG_PAIRWISE_RX
1650 * Pairwise key not yet valid for TX. (Only usable when Extended
1651 * Key ID is supported by the driver.)
1652 * %KEY_FLAG_PAIRWISE_RX_TX_MODIFY
1653 * Enable TX for a pairwise key installed with
1654 * KEY_FLAG_PAIRWISE_RX.
1655 *
1656 * Not a valid standalone key type but pre-defined to be combined
1657 * with other key_flags:
1658 * %KEY_FLAG_RX_TX
1659 * RX/TX key. */
1660 enum key_flag key_flag;
1661};
1662
Hai Shalom4fbc08f2020-05-18 12:37:00 -07001663enum wpa_driver_if_type {
1664 /**
1665 * WPA_IF_STATION - Station mode interface
1666 */
1667 WPA_IF_STATION,
1668
1669 /**
1670 * WPA_IF_AP_VLAN - AP mode VLAN interface
1671 *
1672 * This interface shares its address and Beacon frame with the main
1673 * BSS.
1674 */
1675 WPA_IF_AP_VLAN,
1676
1677 /**
1678 * WPA_IF_AP_BSS - AP mode BSS interface
1679 *
1680 * This interface has its own address and Beacon frame.
1681 */
1682 WPA_IF_AP_BSS,
1683
1684 /**
1685 * WPA_IF_P2P_GO - P2P Group Owner
1686 */
1687 WPA_IF_P2P_GO,
1688
1689 /**
1690 * WPA_IF_P2P_CLIENT - P2P Client
1691 */
1692 WPA_IF_P2P_CLIENT,
1693
1694 /**
1695 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1696 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1697 */
1698 WPA_IF_P2P_GROUP,
1699
1700 /**
1701 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1702 * abstracted P2P Device function in the driver
1703 */
1704 WPA_IF_P2P_DEVICE,
1705
1706 /*
1707 * WPA_IF_MESH - Mesh interface
1708 */
1709 WPA_IF_MESH,
1710
1711 /*
1712 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1713 */
1714 WPA_IF_TDLS,
1715
1716 /*
1717 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1718 */
1719 WPA_IF_IBSS,
1720
1721 /*
1722 * WPA_IF_NAN - NAN Device
1723 */
1724 WPA_IF_NAN,
1725
1726 /* keep last */
1727 WPA_IF_MAX
1728};
1729
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001730/**
1731 * struct wpa_driver_capa - Driver capability information
1732 */
1733struct wpa_driver_capa {
1734#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1735#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1736#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1737#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1738#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1739#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1740#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001741#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001742#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1743#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001744#define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
1745#define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
1746#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1747#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1748#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1749#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
Hai Shalom74f70d42019-02-11 14:42:39 -08001750#define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000
Tanmay Garga7fd80d2020-05-18 15:52:44 +05301751#define WPA_DRIVER_CAPA_KEY_MGMT_802_1X_SHA256 0x00020000
1752#define WPA_DRIVER_CAPA_KEY_MGMT_PSK_SHA256 0x00040000
1753#define WPA_DRIVER_CAPA_KEY_MGMT_TPK_HANDSHAKE 0x00080000
1754#define WPA_DRIVER_CAPA_KEY_MGMT_FT_SAE 0x00100000
1755#define WPA_DRIVER_CAPA_KEY_MGMT_FT_802_1X_SHA384 0x00200000
1756#define WPA_DRIVER_CAPA_KEY_MGMT_CCKM 0x00400000
1757#define WPA_DRIVER_CAPA_KEY_MGMT_OSEN 0x00800000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001758 /** Bitfield of supported key management suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001759 unsigned int key_mgmt;
Hai Shalom4fbc08f2020-05-18 12:37:00 -07001760 unsigned int key_mgmt_iftype[WPA_IF_MAX];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001761
1762#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1763#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1764#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1765#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
Dmitry Shmidt04949592012-07-19 12:16:46 -07001766#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001767#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001768#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1769#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1770#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1771#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1772#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1773#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001774#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001775 /** Bitfield of supported cipher suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001776 unsigned int enc;
1777
1778#define WPA_DRIVER_AUTH_OPEN 0x00000001
1779#define WPA_DRIVER_AUTH_SHARED 0x00000002
1780#define WPA_DRIVER_AUTH_LEAP 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001781 /** Bitfield of supported IEEE 802.11 authentication algorithms */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001782 unsigned int auth;
1783
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001784/** Driver generated WPA/RSN IE */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001785#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001786/** Driver needs static WEP key setup after association command */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001787#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001788/** Driver takes care of all DFS operations */
Dmitry Shmidtd11f0192014-03-24 12:09:47 -07001789#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001790/** Driver takes care of RSN 4-way handshake internally; PMK is configured with
Hai Shalomfdcde762020-04-02 11:19:20 -07001791 * struct wpa_driver_ops::set_key using key_flag = KEY_FLAG_PMK */
Hai Shalom74f70d42019-02-11 14:42:39 -08001792#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001793/** Driver is for a wired Ethernet interface */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001794#define WPA_DRIVER_FLAGS_WIRED 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001795/** Driver provides separate commands for authentication and association (SME in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001796 * wpa_supplicant). */
1797#define WPA_DRIVER_FLAGS_SME 0x00000020
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001798/** Driver supports AP mode */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001799#define WPA_DRIVER_FLAGS_AP 0x00000040
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001800/** Driver needs static WEP key setup after association has been completed */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001801#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001802/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001803#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001804/** Driver supports concurrent P2P operations */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001805#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001806/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001807 * Driver uses the initial interface as a dedicated management interface, i.e.,
1808 * it cannot be used for P2P group operations or non-P2P purposes.
1809 */
1810#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001811/** This interface is P2P capable (P2P GO or P2P Client) */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001812#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001813/** Driver supports station and key removal when stopping an AP */
Dmitry Shmidta38abf92014-03-06 13:38:44 -08001814#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001815/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001816 * Driver uses the initial interface for P2P management interface and non-P2P
1817 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1818 * P2P group operations.
1819 */
1820#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001821/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001822 * Driver is known to use sane error codes, i.e., when it indicates that
1823 * something (e.g., association) fails, there was indeed a failure and the
1824 * operation does not end up getting completed successfully later.
1825 */
1826#define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001827/** Driver supports off-channel TX */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001828#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001829/** Driver indicates TX status events for EAPOL Data frames */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001830#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001831/** Driver indicates TX status events for Deauth/Disassoc frames */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001832#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001833/** Driver supports roaming (BSS selection) in firmware */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001834#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001835/** Driver supports operating as a TDLS peer */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001836#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001837/** Driver requires external TDLS setup/teardown/discovery */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001838#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001839/** Driver indicates support for Probe Response offloading in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001840#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001841/** Driver supports U-APSD in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001842#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001843/** Driver supports inactivity timer in AP mode */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001844#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001845/** Driver expects user space implementation of MLME in AP mode */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001846#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001847/** Driver supports SAE with user space SME */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001848#define WPA_DRIVER_FLAGS_SAE 0x02000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001849/** Driver makes use of OBSS scan mechanism in wpa_supplicant */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001850#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001851/** Driver supports IBSS (Ad-hoc) mode */
Dmitry Shmidt700a1372013-03-15 14:14:44 -07001852#define WPA_DRIVER_FLAGS_IBSS 0x08000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001853/** Driver supports radar detection */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07001854#define WPA_DRIVER_FLAGS_RADAR 0x10000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001855/** Driver supports a dedicated interface for P2P Device */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001856#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001857/** Driver supports QoS Mapping */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001858#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001859/** Driver supports CSA in AP mode */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001860#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001861/** Driver supports mesh */
1862#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1863/** Driver support ACS offload */
1864#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1865/** Driver supports key management offload */
1866#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1867/** Driver supports TDLS channel switching */
1868#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001869/** Driver supports IBSS with HT datarates */
1870#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001871/** Driver supports IBSS with VHT datarates */
1872#define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07001873/** Driver supports automatic band selection */
1874#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001875/** Driver supports simultaneous off-channel operations */
1876#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001877/** Driver supports full AP client state */
1878#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001879/** Driver supports P2P Listen offload */
1880#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001881/** Driver supports FILS */
1882#define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001883/** Driver supports Beacon frame TX rate configuration (legacy rates) */
1884#define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1885/** Driver supports Beacon frame TX rate configuration (HT rates) */
1886#define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1887/** Driver supports Beacon frame TX rate configuration (VHT rates) */
1888#define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08001889/** Driver supports mgmt_tx with random TX address in non-connected state */
1890#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
1891/** Driver supports mgmt_tx with random TX addr in connected state */
1892#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
1893/** Driver supports better BSS reporting with sched_scan in connected mode */
1894#define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
1895/** Driver supports HE capabilities */
1896#define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001897/** Driver supports FILS shared key offload */
1898#define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
1899/** Driver supports all OCE STA specific mandatory features */
1900#define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
1901/** Driver supports all OCE AP specific mandatory features */
1902#define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
1903/**
1904 * Driver supports all OCE STA-CFON specific mandatory features only.
1905 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
1906 * userspace shall assume that this driver may not support all OCE AP
1907 * functionality but can support only OCE STA-CFON functionality.
1908 */
1909#define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
Roshan Pius3a1667e2018-07-03 15:17:14 -07001910/** Driver supports MFP-optional in the connect command */
1911#define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL
Hai Shalom39ba6fc2019-01-22 12:40:38 -08001912/** Driver is a self-managed regulatory device */
1913#define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL
Hai Shalom74f70d42019-02-11 14:42:39 -08001914/** Driver supports FTM responder functionality */
1915#define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL
1916/** Driver support 4-way handshake offload for WPA-Personal */
1917#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
Hai Shalomb755a2a2020-04-23 21:49:02 -07001918/** Driver supports a separate control port TX for EAPOL frames */
Hai Shalomfdcde762020-04-02 11:19:20 -07001919#define WPA_DRIVER_FLAGS_CONTROL_PORT 0x0400000000000000ULL
1920/** Driver supports VLAN offload */
1921#define WPA_DRIVER_FLAGS_VLAN_OFFLOAD 0x0800000000000000ULL
1922/** Driver supports UPDATE_FT_IES command */
1923#define WPA_DRIVER_FLAGS_UPDATE_FT_IES 0x1000000000000000ULL
1924/** Driver can correctly rekey PTKs without Extended Key ID */
1925#define WPA_DRIVER_FLAGS_SAFE_PTK0_REKEYS 0x2000000000000000ULL
1926/** Driver supports Beacon protection */
1927#define WPA_DRIVER_FLAGS_BEACON_PROTECTION 0x4000000000000000ULL
1928/** Driver supports Extended Key ID */
1929#define WPA_DRIVER_FLAGS_EXTENDED_KEY_ID 0x8000000000000000ULL
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001930 u64 flags;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001931
Hai Shalomb755a2a2020-04-23 21:49:02 -07001932/** Driver supports a separate control port RX for EAPOL frames */
1933#define WPA_DRIVER_FLAGS2_CONTROL_PORT_RX 0x0000000000000001ULL
Hai Shalom899fcc72020-10-19 14:38:18 -07001934/** Driver supports TX status reports for EAPOL frames through control port */
1935#define WPA_DRIVER_FLAGS2_CONTROL_PORT_TX_STATUS 0x0000000000000002ULL
Hai Shalomb755a2a2020-04-23 21:49:02 -07001936 u64 flags2;
1937
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001938#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1939 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1940
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001941 unsigned int wmm_ac_supported:1;
1942
1943 unsigned int mac_addr_rand_scan_supported:1;
1944 unsigned int mac_addr_rand_sched_scan_supported:1;
1945
1946 /** Maximum number of supported active probe SSIDs */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001947 int max_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001948
1949 /** Maximum number of supported active probe SSIDs for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001950 int max_sched_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001951
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08001952 /** Maximum number of supported scan plans for scheduled scan */
1953 unsigned int max_sched_scan_plans;
1954
1955 /** Maximum interval in a scan plan. In seconds */
1956 u32 max_sched_scan_plan_interval;
1957
1958 /** Maximum number of iterations in a single scan plan */
1959 u32 max_sched_scan_plan_iterations;
1960
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001961 /** Whether sched_scan (offloaded scanning) is supported */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001962 int sched_scan_supported;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001963
1964 /** Maximum number of supported match sets for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001965 int max_match_sets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001966
1967 /**
1968 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1969 */
1970 unsigned int max_remain_on_chan;
1971
1972 /**
1973 * max_stations - Maximum number of associated stations the driver
1974 * supports in AP mode
1975 */
1976 unsigned int max_stations;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001977
1978 /**
1979 * probe_resp_offloads - Bitmap of supported protocols by the driver
1980 * for Probe Response offloading.
1981 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001982/** Driver Probe Response offloading support for WPS ver. 1 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001983#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001984/** Driver Probe Response offloading support for WPS ver. 2 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001985#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001986/** Driver Probe Response offloading support for P2P */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001987#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001988/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001989#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1990 unsigned int probe_resp_offloads;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001991
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07001992 unsigned int max_acl_mac_addrs;
1993
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001994 /**
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07001995 * Number of supported concurrent channels
1996 */
1997 unsigned int num_multichan_concurrent;
1998
1999 /**
Dmitry Shmidt444d5672013-04-01 13:08:44 -07002000 * extended_capa - extended capabilities in driver/device
2001 *
2002 * Must be allocated and freed by driver and the pointers must be
2003 * valid for the lifetime of the driver, i.e., freed in deinit()
2004 */
2005 const u8 *extended_capa, *extended_capa_mask;
2006 unsigned int extended_capa_len;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07002007
2008 struct wowlan_triggers wowlan_triggers;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002009
2010/** Driver adds the DS Params Set IE in Probe Request frames */
2011#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
2012/** Driver adds the WFA TPC IE in Probe Request frames */
2013#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
2014/** Driver handles quiet period requests */
2015#define WPA_DRIVER_FLAGS_QUIET 0x00000004
2016/**
2017 * Driver is capable of inserting the current TX power value into the body of
2018 * transmitted frames.
2019 * Background: Some Action frames include a TPC Report IE. This IE contains a
2020 * TX power field, which has to be updated by lower layers. One such Action
2021 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
2022 * of spectrum management). Note that this insertion takes place at a fixed
2023 * offset, namely the 6th byte in the Action frame body.
2024 */
2025#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
Dmitry Shmidt849734c2016-05-27 09:59:01 -07002026/**
2027 * Driver supports RRM. With this support, the driver will accept to use RRM in
2028 * (Re)Association Request frames, without supporting quiet period.
2029 */
2030#define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
2031
Dmitry Shmidt29333592017-01-09 12:27:11 -08002032/** Driver supports setting the scan dwell time */
2033#define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
2034/** Driver supports Beacon Report Measurement */
2035#define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
2036
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002037 u32 rrm_flags;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002038
2039 /* Driver concurrency capabilities */
2040 unsigned int conc_capab;
2041 /* Maximum number of concurrent channels on 2.4 GHz */
2042 unsigned int max_conc_chan_2_4;
2043 /* Maximum number of concurrent channels on 5 GHz */
2044 unsigned int max_conc_chan_5_0;
2045
2046 /* Maximum number of supported CSA counters */
2047 u16 max_csa_counters;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002048};
2049
2050
2051struct hostapd_data;
2052
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002053#define STA_DRV_DATA_TX_MCS BIT(0)
2054#define STA_DRV_DATA_RX_MCS BIT(1)
2055#define STA_DRV_DATA_TX_VHT_MCS BIT(2)
2056#define STA_DRV_DATA_RX_VHT_MCS BIT(3)
2057#define STA_DRV_DATA_TX_VHT_NSS BIT(4)
2058#define STA_DRV_DATA_RX_VHT_NSS BIT(5)
2059#define STA_DRV_DATA_TX_SHORT_GI BIT(6)
2060#define STA_DRV_DATA_RX_SHORT_GI BIT(7)
Roshan Pius3a1667e2018-07-03 15:17:14 -07002061#define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002062
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002063struct hostap_sta_driver_data {
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002064 unsigned long rx_packets, tx_packets;
2065 unsigned long long rx_bytes, tx_bytes;
Hai Shalom81f62d82019-07-22 12:10:00 -07002066 unsigned long long rx_airtime, tx_airtime;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002067 int bytes_64bit; /* whether 64-bit byte counters are supported */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002068 unsigned long current_tx_rate;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002069 unsigned long current_rx_rate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002070 unsigned long inactive_msec;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002071 unsigned long flags; /* bitfield of STA_DRV_DATA_* */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002072 unsigned long num_ps_buf_frames;
2073 unsigned long tx_retry_failed;
2074 unsigned long tx_retry_count;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002075 s8 last_ack_rssi;
Hai Shalom81f62d82019-07-22 12:10:00 -07002076 unsigned long backlog_packets;
2077 unsigned long backlog_bytes;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002078 s8 signal;
2079 u8 rx_vhtmcs;
2080 u8 tx_vhtmcs;
2081 u8 rx_mcs;
2082 u8 tx_mcs;
2083 u8 rx_vht_nss;
2084 u8 tx_vht_nss;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002085};
2086
2087struct hostapd_sta_add_params {
2088 const u8 *addr;
2089 u16 aid;
2090 u16 capability;
2091 const u8 *supp_rates;
2092 size_t supp_rates_len;
2093 u16 listen_interval;
2094 const struct ieee80211_ht_capabilities *ht_capabilities;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08002095 const struct ieee80211_vht_capabilities *vht_capabilities;
Dmitry Shmidtbd14a572014-02-18 10:33:49 -08002096 int vht_opmode_enabled;
2097 u8 vht_opmode;
Hai Shalom81f62d82019-07-22 12:10:00 -07002098 const struct ieee80211_he_capabilities *he_capab;
2099 size_t he_capab_len;
Hai Shalom4fbc08f2020-05-18 12:37:00 -07002100 const struct ieee80211_he_6ghz_band_cap *he_6ghz_capab;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002101 u32 flags; /* bitmask of WPA_STA_* flags */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002102 u32 flags_mask; /* unset bits in flags */
2103#ifdef CONFIG_MESH
2104 enum mesh_plink_state plink_state;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07002105 u16 peer_aid;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002106#endif /* CONFIG_MESH */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002107 int set; /* Set STA parameters instead of add */
2108 u8 qosinfo;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08002109 const u8 *ext_capab;
2110 size_t ext_capab_len;
Dmitry Shmidt344abd32014-01-14 13:17:00 -08002111 const u8 *supp_channels;
2112 size_t supp_channels_len;
2113 const u8 *supp_oper_classes;
2114 size_t supp_oper_classes_len;
Dmitry Shmidt849734c2016-05-27 09:59:01 -07002115 int support_p2p_ps;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002116};
2117
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002118struct mac_address {
2119 u8 addr[ETH_ALEN];
2120};
2121
2122struct hostapd_acl_params {
2123 u8 acl_policy;
2124 unsigned int num_mac_acl;
2125 struct mac_address mac_acl[0];
2126};
2127
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002128struct wpa_init_params {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002129 void *global_priv;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002130 const u8 *bssid;
2131 const char *ifname;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002132 const char *driver_params;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002133 int use_pae_group_addr;
2134 char **bridge;
2135 size_t num_bridge;
2136
2137 u8 *own_addr; /* buffer for writing own MAC address */
2138};
2139
2140
2141struct wpa_bss_params {
2142 /** Interface name (for multi-SSID/VLAN support) */
2143 const char *ifname;
2144 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
2145 int enabled;
2146
2147 int wpa;
2148 int ieee802_1x;
2149 int wpa_group;
2150 int wpa_pairwise;
2151 int wpa_key_mgmt;
2152 int rsn_preauth;
2153 enum mfp_options ieee80211w;
2154};
2155
2156#define WPA_STA_AUTHORIZED BIT(0)
2157#define WPA_STA_WMM BIT(1)
2158#define WPA_STA_SHORT_PREAMBLE BIT(2)
2159#define WPA_STA_MFP BIT(3)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002160#define WPA_STA_TDLS_PEER BIT(4)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002161#define WPA_STA_AUTHENTICATED BIT(5)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002162#define WPA_STA_ASSOCIATED BIT(6)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002163
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002164enum tdls_oper {
2165 TDLS_DISCOVERY_REQ,
2166 TDLS_SETUP,
2167 TDLS_TEARDOWN,
2168 TDLS_ENABLE_LINK,
2169 TDLS_DISABLE_LINK,
2170 TDLS_ENABLE,
2171 TDLS_DISABLE
2172};
2173
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002174enum wnm_oper {
2175 WNM_SLEEP_ENTER_CONFIRM,
2176 WNM_SLEEP_ENTER_FAIL,
2177 WNM_SLEEP_EXIT_CONFIRM,
2178 WNM_SLEEP_EXIT_FAIL,
2179 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
2180 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
2181 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
2182 * a STA */
2183 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
2184 * for a STA */
2185 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
2186 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
2187 * for a STA */
2188 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
2189};
2190
Roshan Pius3a1667e2018-07-03 15:17:14 -07002191/* enum smps_mode - SMPS mode definitions */
2192enum smps_mode {
2193 SMPS_AUTOMATIC,
2194 SMPS_OFF,
2195 SMPS_DYNAMIC,
2196 SMPS_STATIC,
2197
2198 /* Keep last */
2199 SMPS_INVALID,
2200};
2201
Hai Shalom74f70d42019-02-11 14:42:39 -08002202#define WPA_INVALID_NOISE 9999
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002203
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002204/**
2205 * struct wpa_signal_info - Information about channel signal quality
Hai Shalom74f70d42019-02-11 14:42:39 -08002206 * @frequency: control frequency
2207 * @above_threshold: true if the above threshold was crossed
2208 * (relevant for a CQM event)
2209 * @current_signal: in dBm
2210 * @avg_signal: in dBm
2211 * @avg_beacon_signal: in dBm
2212 * @current_noise: %WPA_INVALID_NOISE if not supported
2213 * @current_txrate: current TX rate
2214 * @chanwidth: channel width
2215 * @center_frq1: center frequency for the first segment
2216 * @center_frq2: center frequency for the second segment (if relevant)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002217 */
2218struct wpa_signal_info {
2219 u32 frequency;
2220 int above_threshold;
2221 int current_signal;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002222 int avg_signal;
Dmitry Shmidtf73259c2015-03-17 11:00:54 -07002223 int avg_beacon_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002224 int current_noise;
2225 int current_txrate;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002226 enum chan_width chanwidth;
2227 int center_frq1;
2228 int center_frq2;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002229};
2230
2231/**
Hai Shalom74f70d42019-02-11 14:42:39 -08002232 * struct wpa_channel_info - Information about the current channel
2233 * @frequency: Center frequency of the primary 20 MHz channel
2234 * @chanwidth: Width of the current operating channel
2235 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
2236 * This field is only filled in when using a 40 MHz channel.
2237 * @center_frq1: Center frequency of frequency segment 0
2238 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
2239 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
2240 * derived from center_frq2 for convenience.
2241 */
2242struct wpa_channel_info {
2243 u32 frequency;
2244 enum chan_width chanwidth;
2245 int sec_channel;
2246 int center_frq1;
2247 int center_frq2;
2248 u8 seg1_idx;
2249};
2250
2251/**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002252 * struct beacon_data - Beacon data
2253 * @head: Head portion of Beacon frame (before TIM IE)
2254 * @tail: Tail portion of Beacon frame (after TIM IE)
2255 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2256 * @proberesp_ies: Extra information element(s) to add into Probe Response
2257 * frames or %NULL
2258 * @assocresp_ies: Extra information element(s) to add into (Re)Association
2259 * Response frames or %NULL
2260 * @probe_resp: Probe Response frame template
2261 * @head_len: Length of @head
2262 * @tail_len: Length of @tail
2263 * @beacon_ies_len: Length of beacon_ies in octets
2264 * @proberesp_ies_len: Length of proberesp_ies in octets
2265 * @proberesp_ies_len: Length of proberesp_ies in octets
2266 * @probe_resp_len: Length of probe response template (@probe_resp)
2267 */
2268struct beacon_data {
2269 u8 *head, *tail;
2270 u8 *beacon_ies;
2271 u8 *proberesp_ies;
2272 u8 *assocresp_ies;
2273 u8 *probe_resp;
2274
2275 size_t head_len, tail_len;
2276 size_t beacon_ies_len;
2277 size_t proberesp_ies_len;
2278 size_t assocresp_ies_len;
2279 size_t probe_resp_len;
2280};
2281
2282/**
2283 * struct csa_settings - Settings for channel switch command
2284 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2285 * @block_tx: 1 - block transmission for CSA period
2286 * @freq_params: Next channel frequency parameter
2287 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2288 * @beacon_after: Next beacon/probe resp/asooc resp info
2289 * @counter_offset_beacon: Offset to the count field in beacon's tail
2290 * @counter_offset_presp: Offset to the count field in probe resp.
2291 */
2292struct csa_settings {
2293 u8 cs_count;
2294 u8 block_tx;
2295
2296 struct hostapd_freq_params freq_params;
2297 struct beacon_data beacon_csa;
2298 struct beacon_data beacon_after;
2299
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002300 u16 counter_offset_beacon[2];
2301 u16 counter_offset_presp[2];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002302};
2303
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002304/* TDLS peer capabilities for send_tdls_mgmt() */
2305enum tdls_peer_capability {
2306 TDLS_PEER_HT = BIT(0),
2307 TDLS_PEER_VHT = BIT(1),
2308 TDLS_PEER_WMM = BIT(2),
2309};
2310
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002311/* valid info in the wmm_params struct */
2312enum wmm_params_valid_info {
2313 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
2314};
2315
2316/**
2317 * struct wmm_params - WMM parameterss configured for this association
2318 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2319 * of the struct contain valid information.
2320 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2321 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2322 */
2323struct wmm_params {
2324 u8 info_bitmap;
2325 u8 uapsd_queues;
2326};
2327
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002328#ifdef CONFIG_MACSEC
2329struct macsec_init_params {
Hai Shalome21d4e82020-04-29 16:34:06 -07002330 bool always_include_sci;
2331 bool use_es;
2332 bool use_scb;
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002333};
2334#endif /* CONFIG_MACSEC */
2335
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002336enum drv_br_port_attr {
2337 DRV_BR_PORT_ATTR_PROXYARP,
2338 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
2339};
2340
2341enum drv_br_net_param {
2342 DRV_BR_NET_PARAM_GARP_ACCEPT,
Dmitry Shmidt83474442015-04-15 13:47:09 -07002343 DRV_BR_MULTICAST_SNOOPING,
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002344};
2345
2346struct drv_acs_params {
2347 /* Selected mode (HOSTAPD_MODE_*) */
2348 enum hostapd_hw_mode hw_mode;
2349
2350 /* Indicates whether HT is enabled */
2351 int ht_enabled;
2352
2353 /* Indicates whether HT40 is enabled */
2354 int ht40_enabled;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07002355
2356 /* Indicates whether VHT is enabled */
2357 int vht_enabled;
2358
2359 /* Configured ACS channel width */
2360 u16 ch_width;
2361
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08002362 /* ACS frequency list info */
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002363 const int *freq_list;
Hai Shalomfdcde762020-04-02 11:19:20 -07002364
2365 /* Indicates whether EDMG is enabled */
2366 int edmg_enabled;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002367};
2368
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002369struct wpa_bss_trans_info {
2370 u8 mbo_transition_reason;
2371 u8 n_candidates;
2372 u8 *bssid;
2373};
2374
2375struct wpa_bss_candidate_info {
2376 u8 num;
2377 struct candidate_list {
2378 u8 bssid[ETH_ALEN];
2379 u8 is_accept;
2380 u32 reject_reason;
2381 } *candidates;
2382};
2383
2384struct wpa_pmkid_params {
2385 const u8 *bssid;
2386 const u8 *ssid;
2387 size_t ssid_len;
2388 const u8 *fils_cache_id;
2389 const u8 *pmkid;
2390 const u8 *pmk;
2391 size_t pmk_len;
Hai Shalomfdcde762020-04-02 11:19:20 -07002392 u32 pmk_lifetime;
2393 u8 pmk_reauth_threshold;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002394};
2395
2396/* Mask used to specify which connection parameters have to be updated */
2397enum wpa_drv_update_connect_params_mask {
2398 WPA_DRV_UPDATE_ASSOC_IES = BIT(0),
2399 WPA_DRV_UPDATE_FILS_ERP_INFO = BIT(1),
2400 WPA_DRV_UPDATE_AUTH_TYPE = BIT(2),
2401};
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002402
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002403/**
Roshan Pius3a1667e2018-07-03 15:17:14 -07002404 * struct external_auth - External authentication trigger parameters
2405 *
2406 * These are used across the external authentication request and event
2407 * interfaces.
2408 * @action: Action type / trigger for external authentication. Only significant
2409 * for the event interface.
2410 * @bssid: BSSID of the peer with which the authentication has to happen. Used
2411 * by both the request and event interface.
2412 * @ssid: SSID of the AP. Used by both the request and event interface.
2413 * @ssid_len: SSID length in octets.
2414 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2415 * the request interface.
2416 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2417 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2418 * the real status code for failures. Used only for the request interface
2419 * from user space to the driver.
Hai Shalom5f92bc92019-04-18 11:54:11 -07002420 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
Roshan Pius3a1667e2018-07-03 15:17:14 -07002421 */
2422struct external_auth {
2423 enum {
2424 EXT_AUTH_START,
2425 EXT_AUTH_ABORT,
2426 } action;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002427 const u8 *bssid;
2428 const u8 *ssid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002429 size_t ssid_len;
2430 unsigned int key_mgmt_suite;
2431 u16 status;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002432 const u8 *pmkid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002433};
2434
2435/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002436 * struct wpa_driver_ops - Driver interface API definition
2437 *
2438 * This structure defines the API that each driver interface needs to implement
2439 * for core wpa_supplicant code. All driver specific functionality is captured
2440 * in this wrapper.
2441 */
2442struct wpa_driver_ops {
2443 /** Name of the driver interface */
2444 const char *name;
2445 /** One line description of the driver interface */
2446 const char *desc;
2447
2448 /**
2449 * get_bssid - Get the current BSSID
2450 * @priv: private driver interface data
2451 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2452 *
2453 * Returns: 0 on success, -1 on failure
2454 *
2455 * Query kernel driver for the current BSSID and copy it to bssid.
2456 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2457 * associated.
2458 */
2459 int (*get_bssid)(void *priv, u8 *bssid);
2460
2461 /**
2462 * get_ssid - Get the current SSID
2463 * @priv: private driver interface data
2464 * @ssid: buffer for SSID (at least 32 bytes)
2465 *
2466 * Returns: Length of the SSID on success, -1 on failure
2467 *
2468 * Query kernel driver for the current SSID and copy it to ssid.
2469 * Returning zero is recommended if the STA is not associated.
2470 *
2471 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2472 * can, at least in theory, contain control characters (including nul)
2473 * and as such, should be processed as binary data, not a printable
2474 * string.
2475 */
2476 int (*get_ssid)(void *priv, u8 *ssid);
2477
2478 /**
2479 * set_key - Configure encryption key
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002480 * @priv: private driver interface data
Hai Shalomfdcde762020-04-02 11:19:20 -07002481 * @params: Key parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002482 * Returns: 0 on success, -1 on failure
2483 *
2484 * Configure the given key for the kernel driver. If the driver
2485 * supports separate individual keys (4 default keys + 1 individual),
2486 * addr can be used to determine whether the key is default or
2487 * individual. If only 4 keys are supported, the default key with key
2488 * index 0 is used as the individual key. STA must be configured to use
2489 * it as the default Tx key (set_tx is set) and accept Rx for all the
2490 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2491 * broadcast keys, so key index 0 is available for this kind of
2492 * configuration.
2493 *
2494 * Please note that TKIP keys include separate TX and RX MIC keys and
2495 * some drivers may expect them in different order than wpa_supplicant
2496 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
2497 * will trigger Michael MIC errors. This can be fixed by changing the
2498 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
2499 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2500 * example on how this can be done.
2501 */
Hai Shalomfdcde762020-04-02 11:19:20 -07002502 int (*set_key)(void *priv, struct wpa_driver_set_key_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002503
2504 /**
2505 * init - Initialize driver interface
2506 * @ctx: context to be used when calling wpa_supplicant functions,
2507 * e.g., wpa_supplicant_event()
2508 * @ifname: interface name, e.g., wlan0
2509 *
2510 * Returns: Pointer to private data, %NULL on failure
2511 *
2512 * Initialize driver interface, including event processing for kernel
2513 * driver events (e.g., associated, scan results, Michael MIC failure).
2514 * This function can allocate a private configuration data area for
2515 * @ctx, file descriptor, interface name, etc. information that may be
2516 * needed in future driver operations. If this is not used, non-NULL
2517 * value will need to be returned because %NULL is used to indicate
2518 * failure. The returned value will be used as 'void *priv' data for
2519 * all other driver_ops functions.
2520 *
2521 * The main event loop (eloop.c) of wpa_supplicant can be used to
2522 * register callback for read sockets (eloop_register_read_sock()).
2523 *
2524 * See below for more information about events and
2525 * wpa_supplicant_event() function.
2526 */
2527 void * (*init)(void *ctx, const char *ifname);
2528
2529 /**
2530 * deinit - Deinitialize driver interface
2531 * @priv: private driver interface data from init()
2532 *
2533 * Shut down driver interface and processing of driver events. Free
2534 * private data buffer if one was allocated in init() handler.
2535 */
2536 void (*deinit)(void *priv);
2537
2538 /**
2539 * set_param - Set driver configuration parameters
2540 * @priv: private driver interface data from init()
2541 * @param: driver specific configuration parameters
2542 *
2543 * Returns: 0 on success, -1 on failure
2544 *
2545 * Optional handler for notifying driver interface about configuration
2546 * parameters (driver_param).
2547 */
2548 int (*set_param)(void *priv, const char *param);
2549
2550 /**
2551 * set_countermeasures - Enable/disable TKIP countermeasures
2552 * @priv: private driver interface data
2553 * @enabled: 1 = countermeasures enabled, 0 = disabled
2554 *
2555 * Returns: 0 on success, -1 on failure
2556 *
2557 * Configure TKIP countermeasures. When these are enabled, the driver
2558 * should drop all received and queued frames that are using TKIP.
2559 */
2560 int (*set_countermeasures)(void *priv, int enabled);
2561
2562 /**
2563 * deauthenticate - Request driver to deauthenticate
2564 * @priv: private driver interface data
2565 * @addr: peer address (BSSID of the AP)
2566 * @reason_code: 16-bit reason code to be sent in the deauthentication
2567 * frame
2568 *
2569 * Returns: 0 on success, -1 on failure
2570 */
Hai Shalom81f62d82019-07-22 12:10:00 -07002571 int (*deauthenticate)(void *priv, const u8 *addr, u16 reason_code);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002572
2573 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002574 * associate - Request driver to associate
2575 * @priv: private driver interface data
2576 * @params: association parameters
2577 *
2578 * Returns: 0 on success, -1 on failure
2579 */
2580 int (*associate)(void *priv,
2581 struct wpa_driver_associate_params *params);
2582
2583 /**
2584 * add_pmkid - Add PMKSA cache entry to the driver
2585 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002586 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002587 *
2588 * Returns: 0 on success, -1 on failure
2589 *
2590 * This function is called when a new PMK is received, as a result of
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002591 * either normal authentication or RSN pre-authentication. The PMKSA
2592 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2593 * ssid, fils_cache_id, pmkid, and pmk.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002594 *
2595 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2596 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2597 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2598 * driver_ops function does not need to be implemented. Likewise, if
2599 * the driver does not support WPA, this function is not needed.
2600 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002601 int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002602
2603 /**
2604 * remove_pmkid - Remove PMKSA cache entry to the driver
2605 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002606 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002607 *
2608 * Returns: 0 on success, -1 on failure
2609 *
2610 * This function is called when the supplicant drops a PMKSA cache
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002611 * entry for any reason. The PMKSA parameters are either a set of
2612 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002613 *
2614 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2615 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2616 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2617 * from wpa_supplicant, this driver_ops function does not need to be
2618 * implemented. Likewise, if the driver does not support WPA, this
2619 * function is not needed.
2620 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002621 int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002622
2623 /**
2624 * flush_pmkid - Flush PMKSA cache
2625 * @priv: private driver interface data
2626 *
2627 * Returns: 0 on success, -1 on failure
2628 *
2629 * This function is called when the supplicant drops all PMKSA cache
2630 * entries for any reason.
2631 *
2632 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2633 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2634 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2635 * from wpa_supplicant, this driver_ops function does not need to be
2636 * implemented. Likewise, if the driver does not support WPA, this
2637 * function is not needed.
2638 */
2639 int (*flush_pmkid)(void *priv);
2640
2641 /**
2642 * get_capa - Get driver capabilities
2643 * @priv: private driver interface data
2644 *
2645 * Returns: 0 on success, -1 on failure
2646 *
2647 * Get driver/firmware/hardware capabilities.
2648 */
2649 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
2650
2651 /**
2652 * poll - Poll driver for association information
2653 * @priv: private driver interface data
2654 *
2655 * This is an option callback that can be used when the driver does not
2656 * provide event mechanism for association events. This is called when
2657 * receiving WPA EAPOL-Key messages that require association
2658 * information. The driver interface is supposed to generate associnfo
2659 * event before returning from this callback function. In addition, the
2660 * driver interface should generate an association event after having
2661 * sent out associnfo.
2662 */
2663 void (*poll)(void *priv);
2664
2665 /**
Dmitry Shmidte4663042016-04-04 10:07:49 -07002666 * get_ifindex - Get interface index
2667 * @priv: private driver interface data
2668 *
2669 * Returns: Interface index
2670 */
2671 unsigned int (*get_ifindex)(void *priv);
2672
2673 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002674 * get_ifname - Get interface name
2675 * @priv: private driver interface data
2676 *
2677 * Returns: Pointer to the interface name. This can differ from the
2678 * interface name used in init() call. Init() is called first.
2679 *
2680 * This optional function can be used to allow the driver interface to
2681 * replace the interface name with something else, e.g., based on an
2682 * interface mapping from a more descriptive name.
2683 */
2684 const char * (*get_ifname)(void *priv);
2685
2686 /**
2687 * get_mac_addr - Get own MAC address
2688 * @priv: private driver interface data
2689 *
2690 * Returns: Pointer to own MAC address or %NULL on failure
2691 *
2692 * This optional function can be used to get the own MAC address of the
2693 * device from the driver interface code. This is only needed if the
2694 * l2_packet implementation for the OS does not provide easy access to
2695 * a MAC address. */
2696 const u8 * (*get_mac_addr)(void *priv);
2697
2698 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002699 * set_operstate - Sets device operating state to DORMANT or UP
2700 * @priv: private driver interface data
2701 * @state: 0 = dormant, 1 = up
2702 * Returns: 0 on success, -1 on failure
2703 *
2704 * This is an optional function that can be used on operating systems
2705 * that support a concept of controlling network device state from user
2706 * space applications. This function, if set, gets called with
2707 * state = 1 when authentication has been completed and with state = 0
2708 * when connection is lost.
2709 */
2710 int (*set_operstate)(void *priv, int state);
2711
2712 /**
2713 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2714 * @priv: Private driver interface data
2715 * @addr: Address of the station for which to set protection (may be
2716 * %NULL for group keys)
2717 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2718 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2719 * Returns: 0 on success, -1 on failure
2720 *
2721 * This is an optional function that can be used to set the driver to
2722 * require protection for Tx and/or Rx frames. This uses the layer
2723 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2724 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2725 * set protection operation; instead, they set protection implicitly
2726 * based on configured keys.
2727 */
2728 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2729 int key_type);
2730
2731 /**
2732 * get_hw_feature_data - Get hardware support data (channels and rates)
2733 * @priv: Private driver interface data
2734 * @num_modes: Variable for returning the number of returned modes
2735 * flags: Variable for returning hardware feature flags
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002736 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002737 * Returns: Pointer to allocated hardware data on success or %NULL on
2738 * failure. Caller is responsible for freeing this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002739 */
2740 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2741 u16 *num_modes,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002742 u16 *flags, u8 *dfs);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002743
2744 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002745 * send_mlme - Send management frame from MLME
2746 * @priv: Private driver interface data
2747 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2748 * @data_len: Size of the management frame
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002749 * @noack: Do not wait for this frame to be acked (disable retries)
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07002750 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2751 * driver decide
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002752 * @csa_offs: Array of CSA offsets or %NULL
2753 * @csa_offs_len: Number of elements in csa_offs
Hai Shalomfdcde762020-04-02 11:19:20 -07002754 * @no_encrypt: Do not encrypt frame even if appropriate key exists
2755 * (used only for testing purposes)
2756 * @wait: Time to wait off-channel for a response (in ms), or zero
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002757 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002758 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002759 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002760 int noack, unsigned int freq, const u16 *csa_offs,
Hai Shalomfdcde762020-04-02 11:19:20 -07002761 size_t csa_offs_len, int no_encrypt,
2762 unsigned int wait);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002763
2764 /**
2765 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2766 * @priv: Private driver interface data
2767 * @md: Mobility domain (2 octets) (also included inside ies)
2768 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2769 * @ies_len: Length of FT IEs in bytes
2770 * Returns: 0 on success, -1 on failure
2771 *
2772 * The supplicant uses this callback to let the driver know that keying
2773 * material for FT is available and that the driver can use the
2774 * provided IEs in the next message in FT authentication sequence.
2775 *
2776 * This function is only needed for driver that support IEEE 802.11r
2777 * (Fast BSS Transition).
2778 */
2779 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2780 size_t ies_len);
2781
2782 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002783 * get_scan_results2 - Fetch the latest scan results
2784 * @priv: private driver interface data
2785 *
2786 * Returns: Allocated buffer of scan results (caller is responsible for
2787 * freeing the data structure) on success, NULL on failure
2788 */
2789 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2790
2791 /**
2792 * set_country - Set country
2793 * @priv: Private driver interface data
2794 * @alpha2: country to which to switch to
2795 * Returns: 0 on success, -1 on failure
2796 *
2797 * This function is for drivers which support some form
2798 * of setting a regulatory domain.
2799 */
2800 int (*set_country)(void *priv, const char *alpha2);
2801
2802 /**
Dmitry Shmidtcce06662013-11-04 18:44:24 -08002803 * get_country - Get country
2804 * @priv: Private driver interface data
2805 * @alpha2: Buffer for returning country code (at least 3 octets)
2806 * Returns: 0 on success, -1 on failure
2807 */
2808 int (*get_country)(void *priv, char *alpha2);
2809
2810 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002811 * global_init - Global driver initialization
Dmitry Shmidte4663042016-04-04 10:07:49 -07002812 * @ctx: wpa_global pointer
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002813 * Returns: Pointer to private data (global), %NULL on failure
2814 *
2815 * This optional function is called to initialize the driver wrapper
2816 * for global data, i.e., data that applies to all interfaces. If this
2817 * function is implemented, global_deinit() will also need to be
2818 * implemented to free the private data. The driver will also likely
2819 * use init2() function instead of init() to get the pointer to global
2820 * data available to per-interface initializer.
2821 */
Dmitry Shmidte4663042016-04-04 10:07:49 -07002822 void * (*global_init)(void *ctx);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002823
2824 /**
2825 * global_deinit - Global driver deinitialization
2826 * @priv: private driver global data from global_init()
2827 *
2828 * Terminate any global driver related functionality and free the
2829 * global data structure.
2830 */
2831 void (*global_deinit)(void *priv);
2832
2833 /**
2834 * init2 - Initialize driver interface (with global data)
2835 * @ctx: context to be used when calling wpa_supplicant functions,
2836 * e.g., wpa_supplicant_event()
2837 * @ifname: interface name, e.g., wlan0
2838 * @global_priv: private driver global data from global_init()
2839 * Returns: Pointer to private data, %NULL on failure
2840 *
2841 * This function can be used instead of init() if the driver wrapper
2842 * uses global data.
2843 */
2844 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2845
2846 /**
2847 * get_interfaces - Get information about available interfaces
2848 * @global_priv: private driver global data from global_init()
2849 * Returns: Allocated buffer of interface information (caller is
2850 * responsible for freeing the data structure) on success, NULL on
2851 * failure
2852 */
2853 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2854
2855 /**
2856 * scan2 - Request the driver to initiate scan
2857 * @priv: private driver interface data
2858 * @params: Scan parameters
2859 *
2860 * Returns: 0 on success, -1 on failure
2861 *
2862 * Once the scan results are ready, the driver should report scan
2863 * results event for wpa_supplicant which will eventually request the
2864 * results with wpa_driver_get_scan_results2().
2865 */
2866 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2867
2868 /**
2869 * authenticate - Request driver to authenticate
2870 * @priv: private driver interface data
2871 * @params: authentication parameters
2872 * Returns: 0 on success, -1 on failure
2873 *
2874 * This is an optional function that can be used with drivers that
2875 * support separate authentication and association steps, i.e., when
2876 * wpa_supplicant can act as the SME. If not implemented, associate()
2877 * function is expected to take care of IEEE 802.11 authentication,
2878 * too.
2879 */
2880 int (*authenticate)(void *priv,
2881 struct wpa_driver_auth_params *params);
2882
2883 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002884 * set_ap - Set Beacon and Probe Response information for AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002885 * @priv: Private driver interface data
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002886 * @params: Parameters to use in AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002887 *
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002888 * This function is used to configure Beacon template and/or extra IEs
2889 * to add for Beacon and Probe Response frames for the driver in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002890 * AP mode. The driver is responsible for building the full Beacon
2891 * frame by concatenating the head part with TIM IE generated by the
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002892 * driver/firmware and finishing with the tail part. Depending on the
2893 * driver architectue, this can be done either by using the full
2894 * template or the set of additional IEs (e.g., WPS and P2P IE).
2895 * Similarly, Probe Response processing depends on the driver design.
2896 * If the driver (or firmware) takes care of replying to Probe Request
2897 * frames, the extra IEs provided here needs to be added to the Probe
2898 * Response frames.
2899 *
2900 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002901 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002902 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002903
2904 /**
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002905 * set_acl - Set ACL in AP mode
2906 * @priv: Private driver interface data
2907 * @params: Parameters to configure ACL
2908 * Returns: 0 on success, -1 on failure
2909 *
2910 * This is used only for the drivers which support MAC address ACL.
2911 */
2912 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2913
2914 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002915 * hapd_init - Initialize driver interface (hostapd only)
2916 * @hapd: Pointer to hostapd context
2917 * @params: Configuration for the driver wrapper
2918 * Returns: Pointer to private data, %NULL on failure
2919 *
2920 * This function is used instead of init() or init2() when the driver
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002921 * wrapper is used with hostapd.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002922 */
2923 void * (*hapd_init)(struct hostapd_data *hapd,
2924 struct wpa_init_params *params);
2925
2926 /**
2927 * hapd_deinit - Deinitialize driver interface (hostapd only)
2928 * @priv: Private driver interface data from hapd_init()
2929 */
2930 void (*hapd_deinit)(void *priv);
2931
2932 /**
2933 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2934 * @priv: Private driver interface data
2935 * @params: BSS parameters
2936 * Returns: 0 on success, -1 on failure
2937 *
2938 * This is an optional function to configure the kernel driver to
2939 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2940 * can be left undefined (set to %NULL) if IEEE 802.1X support is
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002941 * always enabled and the driver uses set_ap() to set WPA/RSN IE
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002942 * for Beacon frames.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002943 *
2944 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002945 */
2946 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2947
2948 /**
2949 * set_privacy - Enable/disable privacy (AP only)
2950 * @priv: Private driver interface data
2951 * @enabled: 1 = privacy enabled, 0 = disabled
2952 * Returns: 0 on success, -1 on failure
2953 *
2954 * This is an optional function to configure privacy field in the
2955 * kernel driver for Beacon frames. This can be left undefined (set to
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002956 * %NULL) if the driver uses the Beacon template from set_ap().
2957 *
2958 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002959 */
2960 int (*set_privacy)(void *priv, int enabled);
2961
2962 /**
2963 * get_seqnum - Fetch the current TSC/packet number (AP only)
2964 * @ifname: The interface name (main or virtual)
2965 * @priv: Private driver interface data
2966 * @addr: MAC address of the station or %NULL for group keys
2967 * @idx: Key index
2968 * @seq: Buffer for returning the latest used TSC/packet number
2969 * Returns: 0 on success, -1 on failure
2970 *
2971 * This function is used to fetch the last used TSC/packet number for
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002972 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2973 * keys, so there is no strict requirement on implementing support for
2974 * unicast keys (i.e., addr != %NULL).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002975 */
2976 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2977 int idx, u8 *seq);
2978
2979 /**
2980 * flush - Flush all association stations (AP only)
2981 * @priv: Private driver interface data
2982 * Returns: 0 on success, -1 on failure
2983 *
2984 * This function requests the driver to disassociate all associated
2985 * stations. This function does not need to be implemented if the
2986 * driver does not process association frames internally.
2987 */
2988 int (*flush)(void *priv);
2989
2990 /**
2991 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2992 * @priv: Private driver interface data
2993 * @elem: Information elements
2994 * @elem_len: Length of the elem buffer in octets
2995 * Returns: 0 on success, -1 on failure
2996 *
2997 * This is an optional function to add information elements in the
2998 * kernel driver for Beacon and Probe Response frames. This can be left
2999 * undefined (set to %NULL) if the driver uses the Beacon template from
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003000 * set_ap().
3001 *
3002 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003003 */
3004 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
3005
3006 /**
Jouni Malinen1e6c57f2012-09-05 17:07:03 +03003007 * read_sta_data - Fetch station data
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003008 * @priv: Private driver interface data
3009 * @data: Buffer for returning station information
3010 * @addr: MAC address of the station
3011 * Returns: 0 on success, -1 on failure
3012 */
3013 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
3014 const u8 *addr);
3015
3016 /**
Hai Shalomfdcde762020-04-02 11:19:20 -07003017 * tx_control_port - Send a frame over the 802.1X controlled port
3018 * @priv: Private driver interface data
3019 * @dest: Destination MAC address
3020 * @proto: Ethertype in host byte order
3021 * @buf: Frame payload starting from IEEE 802.1X header
3022 * @len: Frame payload length
3023 * @no_encrypt: Do not encrypt frame
3024 *
3025 * Returns 0 on success, else an error
3026 *
3027 * This is like a normal Ethernet send except that the driver is aware
3028 * (by other means than the Ethertype) that this frame is special,
3029 * and more importantly it gains an ordering between the transmission of
3030 * the frame and other driver management operations such as key
3031 * installations. This can be used to work around known limitations in
3032 * IEEE 802.11 protocols such as race conditions between rekeying 4-way
3033 * handshake message 4/4 and a PTK being overwritten.
3034 *
3035 * This function is only used for a given interface if the driver
3036 * instance reports WPA_DRIVER_FLAGS_CONTROL_PORT capability. Otherwise,
3037 * API users will fall back to sending the frame via a normal socket.
3038 */
3039 int (*tx_control_port)(void *priv, const u8 *dest,
3040 u16 proto, const u8 *buf, size_t len,
3041 int no_encrypt);
3042
3043 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003044 * hapd_send_eapol - Send an EAPOL packet (AP only)
3045 * @priv: private driver interface data
3046 * @addr: Destination MAC address
3047 * @data: EAPOL packet starting with IEEE 802.1X header
3048 * @data_len: Length of the EAPOL packet in octets
3049 * @encrypt: Whether the frame should be encrypted
3050 * @own_addr: Source MAC address
3051 * @flags: WPA_STA_* flags for the destination station
3052 *
3053 * Returns: 0 on success, -1 on failure
3054 */
3055 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
3056 size_t data_len, int encrypt,
3057 const u8 *own_addr, u32 flags);
3058
3059 /**
3060 * sta_deauth - Deauthenticate a station (AP only)
3061 * @priv: Private driver interface data
3062 * @own_addr: Source address and BSSID for the Deauthentication frame
3063 * @addr: MAC address of the station to deauthenticate
3064 * @reason: Reason code for the Deauthentiation frame
3065 * Returns: 0 on success, -1 on failure
3066 *
3067 * This function requests a specific station to be deauthenticated and
3068 * a Deauthentication frame to be sent to it.
3069 */
3070 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07003071 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003072
3073 /**
3074 * sta_disassoc - Disassociate a station (AP only)
3075 * @priv: Private driver interface data
3076 * @own_addr: Source address and BSSID for the Disassociation frame
3077 * @addr: MAC address of the station to disassociate
3078 * @reason: Reason code for the Disassociation frame
3079 * Returns: 0 on success, -1 on failure
3080 *
3081 * This function requests a specific station to be disassociated and
3082 * a Disassociation frame to be sent to it.
3083 */
3084 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07003085 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003086
3087 /**
3088 * sta_remove - Remove a station entry (AP only)
3089 * @priv: Private driver interface data
3090 * @addr: MAC address of the station to be removed
3091 * Returns: 0 on success, -1 on failure
3092 */
3093 int (*sta_remove)(void *priv, const u8 *addr);
3094
3095 /**
3096 * hapd_get_ssid - Get the current SSID (AP only)
3097 * @priv: Private driver interface data
3098 * @buf: Buffer for returning the SSID
3099 * @len: Maximum length of the buffer
3100 * Returns: Length of the SSID on success, -1 on failure
3101 *
3102 * This function need not be implemented if the driver uses Beacon
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003103 * template from set_ap() and does not reply to Probe Request frames.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003104 */
3105 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
3106
3107 /**
3108 * hapd_set_ssid - Set SSID (AP only)
3109 * @priv: Private driver interface data
3110 * @buf: SSID
3111 * @len: Length of the SSID in octets
3112 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003113 *
3114 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003115 */
3116 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
3117
3118 /**
3119 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
3120 * @priv: Private driver interface data
3121 * @enabled: 1 = countermeasures enabled, 0 = disabled
3122 * Returns: 0 on success, -1 on failure
3123 *
3124 * This need not be implemented if the driver does not take care of
3125 * association processing.
3126 */
3127 int (*hapd_set_countermeasures)(void *priv, int enabled);
3128
3129 /**
3130 * sta_add - Add a station entry
3131 * @priv: Private driver interface data
3132 * @params: Station parameters
3133 * Returns: 0 on success, -1 on failure
3134 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08003135 * This function is used to add or set (params->set 1) a station
3136 * entry in the driver. Adding STA entries is used only if the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003137 * does not take care of association processing.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003138 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08003139 * With drivers that don't support full AP client state, this function
3140 * is used to add a station entry to the driver once the station has
3141 * completed association.
3142 *
3143 * With TDLS, this function is used to add or set (params->set 1)
3144 * TDLS peer entries (even with drivers that do not support full AP
3145 * client state).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003146 */
3147 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
3148
3149 /**
3150 * get_inact_sec - Get station inactivity duration (AP only)
3151 * @priv: Private driver interface data
3152 * @addr: Station address
3153 * Returns: Number of seconds station has been inactive, -1 on failure
3154 */
3155 int (*get_inact_sec)(void *priv, const u8 *addr);
3156
3157 /**
3158 * sta_clear_stats - Clear station statistics (AP only)
3159 * @priv: Private driver interface data
3160 * @addr: Station address
3161 * Returns: 0 on success, -1 on failure
3162 */
3163 int (*sta_clear_stats)(void *priv, const u8 *addr);
3164
3165 /**
3166 * set_freq - Set channel/frequency (AP only)
3167 * @priv: Private driver interface data
3168 * @freq: Channel parameters
3169 * Returns: 0 on success, -1 on failure
3170 */
3171 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
3172
3173 /**
3174 * set_rts - Set RTS threshold
3175 * @priv: Private driver interface data
3176 * @rts: RTS threshold in octets
3177 * Returns: 0 on success, -1 on failure
3178 */
3179 int (*set_rts)(void *priv, int rts);
3180
3181 /**
3182 * set_frag - Set fragmentation threshold
3183 * @priv: Private driver interface data
3184 * @frag: Fragmentation threshold in octets
3185 * Returns: 0 on success, -1 on failure
3186 */
3187 int (*set_frag)(void *priv, int frag);
3188
3189 /**
3190 * sta_set_flags - Set station flags (AP only)
3191 * @priv: Private driver interface data
3192 * @addr: Station address
3193 * @total_flags: Bitmap of all WPA_STA_* flags currently set
3194 * @flags_or: Bitmap of WPA_STA_* flags to add
3195 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
3196 * Returns: 0 on success, -1 on failure
3197 */
3198 int (*sta_set_flags)(void *priv, const u8 *addr,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08003199 unsigned int total_flags, unsigned int flags_or,
3200 unsigned int flags_and);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003201
3202 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07003203 * sta_set_airtime_weight - Set station airtime weight (AP only)
3204 * @priv: Private driver interface data
3205 * @addr: Station address
3206 * @weight: New weight for station airtime assignment
3207 * Returns: 0 on success, -1 on failure
3208 */
3209 int (*sta_set_airtime_weight)(void *priv, const u8 *addr,
3210 unsigned int weight);
3211
3212 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003213 * set_tx_queue_params - Set TX queue parameters
3214 * @priv: Private driver interface data
3215 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
3216 * @aifs: AIFS
3217 * @cw_min: cwMin
3218 * @cw_max: cwMax
3219 * @burst_time: Maximum length for bursting in 0.1 msec units
3220 */
3221 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
3222 int cw_max, int burst_time);
3223
3224 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003225 * if_add - Add a virtual interface
3226 * @priv: Private driver interface data
3227 * @type: Interface type
3228 * @ifname: Interface name for the new virtual interface
3229 * @addr: Local address to use for the interface or %NULL to use the
3230 * parent interface address
3231 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
3232 * @drv_priv: Pointer for overwriting the driver context or %NULL if
3233 * not allowed (applies only to %WPA_IF_AP_BSS type)
3234 * @force_ifname: Buffer for returning an interface name that the
3235 * driver ended up using if it differs from the requested ifname
3236 * @if_addr: Buffer for returning the allocated interface address
3237 * (this may differ from the requested addr if the driver cannot
3238 * change interface address)
3239 * @bridge: Bridge interface to use or %NULL if no bridge configured
Dmitry Shmidtcce06662013-11-04 18:44:24 -08003240 * @use_existing: Whether to allow existing interface to be used
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003241 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003242 * Returns: 0 on success, -1 on failure
3243 */
3244 int (*if_add)(void *priv, enum wpa_driver_if_type type,
3245 const char *ifname, const u8 *addr, void *bss_ctx,
3246 void **drv_priv, char *force_ifname, u8 *if_addr,
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003247 const char *bridge, int use_existing, int setup_ap);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003248
3249 /**
3250 * if_remove - Remove a virtual interface
3251 * @priv: Private driver interface data
3252 * @type: Interface type
3253 * @ifname: Interface name of the virtual interface to be removed
3254 * Returns: 0 on success, -1 on failure
3255 */
3256 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
3257 const char *ifname);
3258
3259 /**
3260 * set_sta_vlan - Bind a station into a specific interface (AP only)
3261 * @priv: Private driver interface data
3262 * @ifname: Interface (main or virtual BSS or VLAN)
3263 * @addr: MAC address of the associated station
3264 * @vlan_id: VLAN ID
3265 * Returns: 0 on success, -1 on failure
3266 *
3267 * This function is used to bind a station to a specific virtual
3268 * interface. It is only used if when virtual interfaces are supported,
3269 * e.g., to assign stations to different VLAN interfaces based on
3270 * information from a RADIUS server. This allows separate broadcast
3271 * domains to be used with a single BSS.
3272 */
3273 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
3274 int vlan_id);
3275
3276 /**
3277 * commit - Optional commit changes handler (AP only)
3278 * @priv: driver private data
3279 * Returns: 0 on success, -1 on failure
3280 *
3281 * This optional handler function can be registered if the driver
3282 * interface implementation needs to commit changes (e.g., by setting
3283 * network interface up) at the end of initial configuration. If set,
3284 * this handler will be called after initial setup has been completed.
3285 */
3286 int (*commit)(void *priv);
3287
3288 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003289 * set_radius_acl_auth - Notification of RADIUS ACL change
3290 * @priv: Private driver interface data
3291 * @mac: MAC address of the station
3292 * @accepted: Whether the station was accepted
3293 * @session_timeout: Session timeout for the station
3294 * Returns: 0 on success, -1 on failure
3295 */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003296 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003297 u32 session_timeout);
3298
3299 /**
3300 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3301 * @priv: Private driver interface data
3302 * @mac: MAC address of the station
3303 * Returns: 0 on success, -1 on failure
3304 */
3305 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
3306
3307 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003308 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
3309 * @priv: Private driver interface data
3310 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3311 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3312 * extra IE(s)
3313 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3314 * to remove extra IE(s)
3315 * Returns: 0 on success, -1 on failure
3316 *
3317 * This is an optional function to add WPS IE in the kernel driver for
3318 * Beacon and Probe Response frames. This can be left undefined (set
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003319 * to %NULL) if the driver uses the Beacon template from set_ap()
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003320 * and does not process Probe Request frames. If the driver takes care
3321 * of (Re)Association frame processing, the assocresp buffer includes
3322 * WPS IE(s) that need to be added to (Re)Association Response frames
3323 * whenever a (Re)Association Request frame indicated use of WPS.
3324 *
3325 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3326 * frames when operating as a GO. The driver is responsible for adding
3327 * timing related attributes (e.g., NoA) in addition to the IEs
3328 * included here by appending them after these buffers. This call is
3329 * also used to provide Probe Response IEs for P2P Listen state
3330 * operations for drivers that generate the Probe Response frames
3331 * internally.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003332 *
3333 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003334 */
3335 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
3336 const struct wpabuf *proberesp,
3337 const struct wpabuf *assocresp);
3338
3339 /**
3340 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3341 * @priv: Private driver interface data
3342 * @authorized: Whether the port is authorized
3343 * Returns: 0 on success, -1 on failure
3344 */
3345 int (*set_supp_port)(void *priv, int authorized);
3346
3347 /**
3348 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3349 * @priv: Private driver interface data
3350 * @addr: MAC address of the associated station
3351 * @aid: Association ID
3352 * @val: 1 = bind to 4-address WDS; 0 = unbind
3353 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3354 * to indicate that bridge is not to be used
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07003355 * @ifname_wds: Buffer to return the interface name for the new WDS
3356 * station or %NULL to indicate name is not returned.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003357 * Returns: 0 on success, -1 on failure
3358 */
3359 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003360 const char *bridge_ifname, char *ifname_wds);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003361
3362 /**
3363 * send_action - Transmit an Action frame
3364 * @priv: Private driver interface data
3365 * @freq: Frequency (in MHz) of the channel
3366 * @wait: Time to wait off-channel for a response (in ms), or zero
3367 * @dst: Destination MAC address (Address 1)
3368 * @src: Source MAC address (Address 2)
3369 * @bssid: BSSID (Address 3)
3370 * @data: Frame body
3371 * @data_len: data length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003372 @ @no_cck: Whether CCK rates must not be used to transmit this frame
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003373 * Returns: 0 on success, -1 on failure
3374 *
3375 * This command can be used to request the driver to transmit an action
3376 * frame to the specified destination.
3377 *
3378 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3379 * be transmitted on the given channel and the device will wait for a
3380 * response on that channel for the given wait time.
3381 *
3382 * If the flag is not set, the wait time will be ignored. In this case,
3383 * if a remain-on-channel duration is in progress, the frame must be
3384 * transmitted on that channel; alternatively the frame may be sent on
3385 * the current operational channel (if in associated state in station
3386 * mode or while operating as an AP.)
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08003387 *
3388 * If @src differs from the device MAC address, use of a random
3389 * transmitter address is requested for this message exchange.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003390 */
3391 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
3392 const u8 *dst, const u8 *src, const u8 *bssid,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003393 const u8 *data, size_t data_len, int no_cck);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003394
3395 /**
3396 * send_action_cancel_wait - Cancel action frame TX wait
3397 * @priv: Private driver interface data
3398 *
3399 * This command cancels the wait time associated with sending an action
3400 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3401 * set in the driver flags.
3402 */
3403 void (*send_action_cancel_wait)(void *priv);
3404
3405 /**
3406 * remain_on_channel - Remain awake on a channel
3407 * @priv: Private driver interface data
3408 * @freq: Frequency (in MHz) of the channel
3409 * @duration: Duration in milliseconds
3410 * Returns: 0 on success, -1 on failure
3411 *
3412 * This command is used to request the driver to remain awake on the
3413 * specified channel for the specified duration and report received
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08003414 * Action frames with EVENT_RX_MGMT events. Optionally, received
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003415 * Probe Request frames may also be requested to be reported by calling
3416 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3417 *
3418 * The driver may not be at the requested channel when this function
3419 * returns, i.e., the return code is only indicating whether the
3420 * request was accepted. The caller will need to wait until the
3421 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3422 * completed the channel change. This may take some time due to other
3423 * need for the radio and the caller should be prepared to timing out
3424 * its wait since there are no guarantees on when this request can be
3425 * executed.
3426 */
3427 int (*remain_on_channel)(void *priv, unsigned int freq,
3428 unsigned int duration);
3429
3430 /**
3431 * cancel_remain_on_channel - Cancel remain-on-channel operation
3432 * @priv: Private driver interface data
3433 *
3434 * This command can be used to cancel a remain-on-channel operation
3435 * before its originally requested duration has passed. This could be
3436 * used, e.g., when remain_on_channel() is used to request extra time
3437 * to receive a response to an Action frame and the response is
3438 * received when there is still unneeded time remaining on the
3439 * remain-on-channel operation.
3440 */
3441 int (*cancel_remain_on_channel)(void *priv);
3442
3443 /**
3444 * probe_req_report - Request Probe Request frames to be indicated
3445 * @priv: Private driver interface data
3446 * @report: Whether to report received Probe Request frames
3447 * Returns: 0 on success, -1 on failure (or if not supported)
3448 *
3449 * This command can be used to request the driver to indicate when
3450 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3451 * Since this operation may require extra resources, e.g., due to less
3452 * optimal hardware/firmware RX filtering, many drivers may disable
3453 * Probe Request reporting at least in station mode. This command is
3454 * used to notify the driver when the Probe Request frames need to be
3455 * reported, e.g., during remain-on-channel operations.
3456 */
3457 int (*probe_req_report)(void *priv, int report);
3458
3459 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003460 * deinit_ap - Deinitialize AP mode
3461 * @priv: Private driver interface data
3462 * Returns: 0 on success, -1 on failure (or if not supported)
3463 *
3464 * This optional function can be used to disable AP mode related
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003465 * configuration. If the interface was not dynamically added,
3466 * change the driver mode to station mode to allow normal station
3467 * operations like scanning to be completed.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003468 */
3469 int (*deinit_ap)(void *priv);
3470
3471 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003472 * deinit_p2p_cli - Deinitialize P2P client mode
3473 * @priv: Private driver interface data
3474 * Returns: 0 on success, -1 on failure (or if not supported)
3475 *
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003476 * This optional function can be used to disable P2P client mode. If the
3477 * interface was not dynamically added, change the interface type back
3478 * to station mode.
Dmitry Shmidt04949592012-07-19 12:16:46 -07003479 */
3480 int (*deinit_p2p_cli)(void *priv);
3481
3482 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003483 * suspend - Notification on system suspend/hibernate event
3484 * @priv: Private driver interface data
3485 */
3486 void (*suspend)(void *priv);
3487
3488 /**
3489 * resume - Notification on system resume/thaw event
3490 * @priv: Private driver interface data
3491 */
3492 void (*resume)(void *priv);
3493
3494 /**
3495 * signal_monitor - Set signal monitoring parameters
3496 * @priv: Private driver interface data
3497 * @threshold: Threshold value for signal change events; 0 = disabled
3498 * @hysteresis: Minimum change in signal strength before indicating a
3499 * new event
3500 * Returns: 0 on success, -1 on failure (or if not supported)
3501 *
3502 * This function can be used to configure monitoring of signal strength
3503 * with the current AP. Whenever signal strength drops below the
3504 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3505 * should be generated assuming the signal strength has changed at
3506 * least %hysteresis from the previously indicated signal change event.
3507 */
3508 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
3509
3510 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003511 * get_noa - Get current Notice of Absence attribute payload
3512 * @priv: Private driver interface data
3513 * @buf: Buffer for returning NoA
3514 * @buf_len: Buffer length in octets
3515 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3516 * advertized, or -1 on failure
3517 *
3518 * This function is used to fetch the current Notice of Absence
3519 * attribute value from GO.
3520 */
3521 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
3522
3523 /**
3524 * set_noa - Set Notice of Absence parameters for GO (testing)
3525 * @priv: Private driver interface data
3526 * @count: Count
3527 * @start: Start time in ms from next TBTT
3528 * @duration: Duration in ms
3529 * Returns: 0 on success or -1 on failure
3530 *
3531 * This function is used to set Notice of Absence parameters for GO. It
3532 * is used only for testing. To disable NoA, all parameters are set to
3533 * 0.
3534 */
3535 int (*set_noa)(void *priv, u8 count, int start, int duration);
3536
3537 /**
3538 * set_p2p_powersave - Set P2P power save options
3539 * @priv: Private driver interface data
3540 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3541 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3542 * @ctwindow: 0.. = change (msec), -1 = no change
3543 * Returns: 0 on success or -1 on failure
3544 */
3545 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
3546 int ctwindow);
3547
3548 /**
3549 * ampdu - Enable/disable aggregation
3550 * @priv: Private driver interface data
3551 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3552 * Returns: 0 on success or -1 on failure
3553 */
3554 int (*ampdu)(void *priv, int ampdu);
3555
3556 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003557 * get_radio_name - Get physical radio name for the device
3558 * @priv: Private driver interface data
3559 * Returns: Radio name or %NULL if not known
3560 *
3561 * The returned data must not be modified by the caller. It is assumed
3562 * that any interface that has the same radio name as another is
3563 * sharing the same physical radio. This information can be used to
3564 * share scan results etc. information between the virtual interfaces
3565 * to speed up various operations.
3566 */
3567 const char * (*get_radio_name)(void *priv);
3568
3569 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003570 * send_tdls_mgmt - for sending TDLS management packets
3571 * @priv: private driver interface data
3572 * @dst: Destination (peer) MAC address
3573 * @action_code: TDLS action code for the mssage
3574 * @dialog_token: Dialog Token to use in the message (if needed)
3575 * @status_code: Status Code or Reason Code to use (if needed)
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003576 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003577 * @initiator: Is the current end the TDLS link initiator
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003578 * @buf: TDLS IEs to add to the message
3579 * @len: Length of buf in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003580 * Returns: 0 on success, negative (<0) on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003581 *
3582 * This optional function can be used to send packet to driver which is
3583 * responsible for receiving and sending all TDLS packets.
3584 */
3585 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003586 u8 dialog_token, u16 status_code, u32 peer_capab,
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003587 int initiator, const u8 *buf, size_t len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003588
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003589 /**
3590 * tdls_oper - Ask the driver to perform high-level TDLS operations
3591 * @priv: Private driver interface data
3592 * @oper: TDLS high-level operation. See %enum tdls_oper
3593 * @peer: Destination (peer) MAC address
3594 * Returns: 0 on success, negative (<0) on failure
3595 *
3596 * This optional function can be used to send high-level TDLS commands
3597 * to the driver.
3598 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003599 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
3600
3601 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07003602 * wnm_oper - Notify driver of the WNM frame reception
3603 * @priv: Private driver interface data
3604 * @oper: WNM operation. See %enum wnm_oper
3605 * @peer: Destination (peer) MAC address
3606 * @buf: Buffer for the driver to fill in (for getting IE)
3607 * @buf_len: Return the len of buf
3608 * Returns: 0 on success, negative (<0) on failure
3609 */
3610 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
3611 u8 *buf, u16 *buf_len);
3612
3613 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -07003614 * set_qos_map - Set QoS Map
3615 * @priv: Private driver interface data
3616 * @qos_map_set: QoS Map
3617 * @qos_map_set_len: Length of QoS Map
3618 */
3619 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
3620 u8 qos_map_set_len);
3621
3622 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003623 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3624 * @priv: Private driver interface data
3625 * @version: IP version of the IP address, 4 or 6
3626 * @ipaddr: IP address for the neigh entry
3627 * @prefixlen: IP address prefix length
3628 * @addr: Corresponding MAC address
3629 * Returns: 0 on success, negative (<0) on failure
3630 */
3631 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
3632 int prefixlen, const u8 *addr);
3633
3634 /**
3635 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3636 * @priv: Private driver interface data
3637 * @version: IP version of the IP address, 4 or 6
3638 * @ipaddr: IP address for the neigh entry
3639 * Returns: 0 on success, negative (<0) on failure
3640 */
3641 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
3642
3643 /**
3644 * br_port_set_attr - Set a bridge port attribute
3645 * @attr: Bridge port attribute to set
3646 * @val: Value to be set
3647 * Returns: 0 on success, negative (<0) on failure
3648 */
3649 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
3650 unsigned int val);
3651
3652 /**
3653 * br_port_set_attr - Set a bridge network parameter
3654 * @param: Bridge parameter to set
3655 * @val: Value to be set
3656 * Returns: 0 on success, negative (<0) on failure
3657 */
3658 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
3659 unsigned int val);
3660
3661 /**
Hai Shalomfdcde762020-04-02 11:19:20 -07003662 * get_wowlan - Get wake-on-wireless status
3663 * @priv: Private driver interface data
3664 */
3665 int (*get_wowlan)(void *priv);
3666
3667 /**
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07003668 * set_wowlan - Set wake-on-wireless triggers
3669 * @priv: Private driver interface data
3670 * @triggers: wowlan triggers
3671 */
3672 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
3673
3674 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003675 * signal_poll - Get current connection information
3676 * @priv: Private driver interface data
3677 * @signal_info: Connection info structure
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003678 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003679 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003680
3681 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08003682 * channel_info - Get parameters of the current operating channel
3683 * @priv: Private driver interface data
3684 * @channel_info: Channel info structure
3685 * Returns: 0 on success, negative (<0) on failure
3686 */
3687 int (*channel_info)(void *priv, struct wpa_channel_info *channel_info);
3688
3689 /**
Jouni Malinen75ecf522011-06-27 15:19:46 -07003690 * set_authmode - Set authentication algorithm(s) for static WEP
3691 * @priv: Private driver interface data
3692 * @authmode: 1=Open System, 2=Shared Key, 3=both
3693 * Returns: 0 on success, -1 on failure
3694 *
3695 * This function can be used to set authentication algorithms for AP
3696 * mode when static WEP is used. If the driver uses user space MLME/SME
3697 * implementation, there is no need to implement this function.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003698 *
3699 * DEPRECATED - use set_ap() instead
Jouni Malinen75ecf522011-06-27 15:19:46 -07003700 */
3701 int (*set_authmode)(void *priv, int authmode);
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003702
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003703#ifdef ANDROID
Jouni Malinen75ecf522011-06-27 15:19:46 -07003704 /**
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003705 * driver_cmd - Execute driver-specific command
3706 * @priv: Private driver interface data
3707 * @cmd: Command to execute
3708 * @buf: Return buffer
3709 * @buf_len: Buffer length
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003710 * Returns: 0 on success, -1 on failure
3711 */
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003712 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
3713#endif /* ANDROID */
3714
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003715 /**
Dmitry Shmidta38abf92014-03-06 13:38:44 -08003716 * vendor_cmd - Execute vendor specific command
3717 * @priv: Private driver interface data
3718 * @vendor_id: Vendor id
3719 * @subcmd: Vendor command id
3720 * @data: Vendor command parameters (%NULL if no parameters)
3721 * @data_len: Data length
3722 * @buf: Return buffer (%NULL to ignore reply)
3723 * Returns: 0 on success, negative (<0) on failure
3724 *
3725 * This function handles vendor specific commands that are passed to
3726 * the driver/device. The command is identified by vendor id and
3727 * command id. Parameters can be passed as argument to the command
3728 * in the data buffer. Reply (if any) will be filled in the supplied
3729 * return buffer.
3730 *
3731 * The exact driver behavior is driver interface and vendor specific. As
3732 * an example, this will be converted to a vendor specific cfg80211
3733 * command in case of the nl80211 driver interface.
3734 */
3735 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3736 unsigned int subcmd, const u8 *data, size_t data_len,
3737 struct wpabuf *buf);
3738
3739 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003740 * set_rekey_info - Set rekey information
3741 * @priv: Private driver interface data
3742 * @kek: Current KEK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003743 * @kek_len: KEK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003744 * @kck: Current KCK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003745 * @kck_len: KCK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003746 * @replay_ctr: Current EAPOL-Key Replay Counter
3747 *
3748 * This optional function can be used to provide information for the
3749 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3750 * while the host (including wpa_supplicant) is sleeping.
3751 */
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003752 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3753 const u8 *kck, size_t kck_len,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003754 const u8 *replay_ctr);
3755
3756 /**
3757 * sta_assoc - Station association indication
3758 * @priv: Private driver interface data
3759 * @own_addr: Source address and BSSID for association frame
3760 * @addr: MAC address of the station to associate
3761 * @reassoc: flag to indicate re-association
3762 * @status: association response status code
3763 * @ie: assoc response ie buffer
3764 * @len: ie buffer length
3765 * Returns: 0 on success, -1 on failure
3766 *
3767 * This function indicates the driver to send (Re)Association
3768 * Response frame to the station.
3769 */
3770 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3771 int reassoc, u16 status, const u8 *ie, size_t len);
3772
3773 /**
3774 * sta_auth - Station authentication indication
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003775 * @priv: private driver interface data
3776 * @params: Station authentication parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003777 *
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003778 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003779 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003780 int (*sta_auth)(void *priv,
3781 struct wpa_driver_sta_auth_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003782
3783 /**
3784 * add_tspec - Add traffic stream
3785 * @priv: Private driver interface data
3786 * @addr: MAC address of the station to associate
3787 * @tspec_ie: tspec ie buffer
3788 * @tspec_ielen: tspec ie length
3789 * Returns: 0 on success, -1 on failure
3790 *
3791 * This function adds the traffic steam for the station
3792 * and fills the medium_time in tspec_ie.
3793 */
3794 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3795 size_t tspec_ielen);
3796
3797 /**
3798 * add_sta_node - Add a station node in the driver
3799 * @priv: Private driver interface data
3800 * @addr: MAC address of the station to add
3801 * @auth_alg: authentication algorithm used by the station
3802 * Returns: 0 on success, -1 on failure
3803 *
3804 * This function adds the station node in the driver, when
3805 * the station gets added by FT-over-DS.
3806 */
3807 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
3808
3809 /**
3810 * sched_scan - Request the driver to initiate scheduled scan
3811 * @priv: Private driver interface data
3812 * @params: Scan parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003813 * Returns: 0 on success, -1 on failure
3814 *
3815 * This operation should be used for scheduled scan offload to
3816 * the hardware. Every time scan results are available, the
3817 * driver should report scan results event for wpa_supplicant
3818 * which will eventually request the results with
3819 * wpa_driver_get_scan_results2(). This operation is optional
3820 * and if not provided or if it returns -1, we fall back to
3821 * normal host-scheduled scans.
3822 */
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003823 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003824
3825 /**
3826 * stop_sched_scan - Request the driver to stop a scheduled scan
3827 * @priv: Private driver interface data
3828 * Returns: 0 on success, -1 on failure
3829 *
3830 * This should cause the scheduled scan to be stopped and
3831 * results should stop being sent. Must be supported if
3832 * sched_scan is supported.
3833 */
3834 int (*stop_sched_scan)(void *priv);
3835
3836 /**
3837 * poll_client - Probe (null data or such) the given station
3838 * @priv: Private driver interface data
3839 * @own_addr: MAC address of sending interface
3840 * @addr: MAC address of the station to probe
3841 * @qos: Indicates whether station is QoS station
3842 *
3843 * This function is used to verify whether an associated station is
3844 * still present. This function does not need to be implemented if the
3845 * driver provides such inactivity polling mechanism.
3846 */
3847 void (*poll_client)(void *priv, const u8 *own_addr,
3848 const u8 *addr, int qos);
Dmitry Shmidt04949592012-07-19 12:16:46 -07003849
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003850 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003851 * radio_disable - Disable/enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003852 * @priv: Private driver interface data
Dmitry Shmidt04949592012-07-19 12:16:46 -07003853 * @disabled: 1=disable 0=enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003854 * Returns: 0 on success, -1 on failure
3855 *
Dmitry Shmidt04949592012-07-19 12:16:46 -07003856 * This optional command is for testing purposes. It can be used to
3857 * disable the radio on a testbed device to simulate out-of-radio-range
3858 * conditions.
3859 */
3860 int (*radio_disable)(void *priv, int disabled);
3861
3862 /**
3863 * switch_channel - Announce channel switch and migrate the GO to the
3864 * given frequency
3865 * @priv: Private driver interface data
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003866 * @settings: Settings for CSA period and new channel
Dmitry Shmidt04949592012-07-19 12:16:46 -07003867 * Returns: 0 on success, -1 on failure
3868 *
3869 * This function is used to move the GO to the legacy STA channel to
3870 * avoid frequency conflict in single channel concurrency.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003871 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003872 int (*switch_channel)(void *priv, struct csa_settings *settings);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003873
3874 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003875 * add_tx_ts - Add traffic stream
3876 * @priv: Private driver interface data
3877 * @tsid: Traffic stream ID
3878 * @addr: Receiver address
3879 * @user_prio: User priority of the traffic stream
3880 * @admitted_time: Admitted time for this TS in units of
3881 * 32 microsecond periods (per second).
3882 * Returns: 0 on success, -1 on failure
3883 */
3884 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3885 u16 admitted_time);
3886
3887 /**
3888 * del_tx_ts - Delete traffic stream
3889 * @priv: Private driver interface data
3890 * @tsid: Traffic stream ID
3891 * @addr: Receiver address
3892 * Returns: 0 on success, -1 on failure
3893 */
3894 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3895
3896 /**
3897 * Enable channel-switching with TDLS peer
3898 * @priv: Private driver interface data
3899 * @addr: MAC address of the TDLS peer
3900 * @oper_class: Operating class of the switch channel
3901 * @params: Channel specification
3902 * Returns: 0 on success, -1 on failure
3903 *
3904 * The function indicates to driver that it can start switching to a
3905 * different channel with a specified TDLS peer. The switching is
3906 * assumed on until canceled with tdls_disable_channel_switch().
3907 */
3908 int (*tdls_enable_channel_switch)(
3909 void *priv, const u8 *addr, u8 oper_class,
3910 const struct hostapd_freq_params *params);
3911
3912 /**
3913 * Disable channel switching with TDLS peer
3914 * @priv: Private driver interface data
3915 * @addr: MAC address of the TDLS peer
3916 * Returns: 0 on success, -1 on failure
3917 *
3918 * This function indicates to the driver that it should stop switching
3919 * with a given TDLS peer.
3920 */
3921 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3922
3923 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003924 * start_dfs_cac - Listen for radar interference on the channel
3925 * @priv: Private driver interface data
Dmitry Shmidt051af732013-10-22 13:52:46 -07003926 * @freq: Channel parameters
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003927 * Returns: 0 on success, -1 on failure
3928 */
Dmitry Shmidt051af732013-10-22 13:52:46 -07003929 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003930
3931 /**
3932 * stop_ap - Removes beacon from AP
3933 * @priv: Private driver interface data
3934 * Returns: 0 on success, -1 on failure (or if not supported)
3935 *
3936 * This optional function can be used to disable AP mode related
3937 * configuration. Unlike deinit_ap, it does not change to station
3938 * mode.
3939 */
3940 int (*stop_ap)(void *priv);
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003941
3942 /**
3943 * get_survey - Retrieve survey data
3944 * @priv: Private driver interface data
3945 * @freq: If set, survey data for the specified frequency is only
3946 * being requested. If not set, all survey data is requested.
3947 * Returns: 0 on success, -1 on failure
3948 *
3949 * Use this to retrieve:
3950 *
3951 * - the observed channel noise floor
3952 * - the amount of time we have spent on the channel
3953 * - the amount of time during which we have spent on the channel that
3954 * the radio has determined the medium is busy and we cannot
3955 * transmit
3956 * - the amount of time we have spent receiving data
3957 * - the amount of time we have spent transmitting data
3958 *
3959 * This data can be used for spectrum heuristics. One example is
3960 * Automatic Channel Selection (ACS). The channel survey data is
3961 * kept on a linked list on the channel data, one entry is added
3962 * for each survey. The min_nf of the channel is updated for each
3963 * survey.
3964 */
3965 int (*get_survey)(void *priv, unsigned int freq);
Dmitry Shmidt56052862013-10-04 10:23:25 -07003966
3967 /**
3968 * status - Get driver interface status information
3969 * @priv: Private driver interface data
Hai Shalom74f70d42019-02-11 14:42:39 -08003970 * @buf: Buffer for printing the status information
Dmitry Shmidt56052862013-10-04 10:23:25 -07003971 * @buflen: Maximum length of the buffer
3972 * Returns: Length of written status information or -1 on failure
3973 */
3974 int (*status)(void *priv, char *buf, size_t buflen);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003975
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07003976 /**
3977 * roaming - Set roaming policy for driver-based BSS selection
3978 * @priv: Private driver interface data
3979 * @allowed: Whether roaming within ESS is allowed
3980 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3981 * Returns: Length of written status information or -1 on failure
3982 *
3983 * This optional callback can be used to update roaming policy from the
3984 * associate() command (bssid being set there indicates that the driver
3985 * should not roam before getting this roaming() call to allow roaming.
3986 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3987 * capability, roaming policy is handled within wpa_supplicant and there
3988 * is no need to implement or react to this callback.
3989 */
3990 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3991
3992 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -07003993 * disable_fils - Enable/disable FILS feature
3994 * @priv: Private driver interface data
3995 * @disable: 0-enable and 1-disable FILS feature
3996 * Returns: 0 on success, -1 on failure
3997 *
3998 * This callback can be used to configure driver and below layers to
3999 * enable/disable all FILS features.
4000 */
4001 int (*disable_fils)(void *priv, int disable);
4002
4003 /**
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07004004 * set_mac_addr - Set MAC address
4005 * @priv: Private driver interface data
4006 * @addr: MAC address to use or %NULL for setting back to permanent
4007 * Returns: 0 on success, -1 on failure
4008 */
4009 int (*set_mac_addr)(void *priv, const u8 *addr);
4010
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004011#ifdef CONFIG_MACSEC
4012 int (*macsec_init)(void *priv, struct macsec_init_params *params);
4013
4014 int (*macsec_deinit)(void *priv);
4015
4016 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004017 * macsec_get_capability - Inform MKA of this driver's capability
4018 * @priv: Private driver interface data
4019 * @cap: Driver's capability
4020 * Returns: 0 on success, -1 on failure
4021 */
4022 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);
4023
4024 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004025 * enable_protect_frames - Set protect frames status
4026 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004027 * @enabled: true = protect frames enabled
4028 * false = protect frames disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004029 * Returns: 0 on success, -1 on failure (or if not supported)
4030 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004031 int (*enable_protect_frames)(void *priv, bool enabled);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004032
4033 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004034 * enable_encrypt - Set encryption status
4035 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004036 * @enabled: true = encrypt outgoing traffic
4037 * false = integrity-only protection on outgoing traffic
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004038 * Returns: 0 on success, -1 on failure (or if not supported)
4039 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004040 int (*enable_encrypt)(void *priv, bool enabled);
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004041
4042 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004043 * set_replay_protect - Set replay protect status and window size
4044 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004045 * @enabled: true = replay protect enabled
4046 * false = replay protect disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004047 * @window: replay window size, valid only when replay protect enabled
4048 * Returns: 0 on success, -1 on failure (or if not supported)
4049 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004050 int (*set_replay_protect)(void *priv, bool enabled, u32 window);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004051
4052 /**
4053 * set_current_cipher_suite - Set current cipher suite
4054 * @priv: Private driver interface data
4055 * @cs: EUI64 identifier
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004056 * Returns: 0 on success, -1 on failure (or if not supported)
4057 */
Dmitry Shmidt7d175302016-09-06 13:11:34 -07004058 int (*set_current_cipher_suite)(void *priv, u64 cs);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004059
4060 /**
4061 * enable_controlled_port - Set controlled port status
4062 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004063 * @enabled: true = controlled port enabled
4064 * false = controlled port disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004065 * Returns: 0 on success, -1 on failure (or if not supported)
4066 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004067 int (*enable_controlled_port)(void *priv, bool enabled);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004068
4069 /**
4070 * get_receive_lowest_pn - Get receive lowest pn
4071 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004072 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004073 * Returns: 0 on success, -1 on failure (or if not supported)
4074 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004075 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004076
4077 /**
4078 * get_transmit_next_pn - Get transmit next pn
4079 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004080 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004081 * Returns: 0 on success, -1 on failure (or if not supported)
4082 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004083 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004084
4085 /**
4086 * set_transmit_next_pn - Set transmit next pn
4087 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004088 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004089 * Returns: 0 on success, -1 on failure (or if not supported)
4090 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004091 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004092
4093 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08004094 * set_receive_lowest_pn - Set receive lowest PN
4095 * @priv: Private driver interface data
4096 * @sa: secure association
4097 * Returns: 0 on success, -1 on failure (or if not supported)
4098 */
4099 int (*set_receive_lowest_pn)(void *priv, struct receive_sa *sa);
4100
4101 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004102 * create_receive_sc - create secure channel for receiving
4103 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004104 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004105 * @conf_offset: confidentiality offset (0, 30, or 50)
4106 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
4107 * 2 = Strict)
4108 * Returns: 0 on success, -1 on failure (or if not supported)
4109 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004110 int (*create_receive_sc)(void *priv, struct receive_sc *sc,
4111 unsigned int conf_offset,
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004112 int validation);
4113
4114 /**
4115 * delete_receive_sc - delete secure connection for receiving
4116 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004117 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004118 * Returns: 0 on success, -1 on failure
4119 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004120 int (*delete_receive_sc)(void *priv, struct receive_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004121
4122 /**
4123 * create_receive_sa - create secure association for receive
4124 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004125 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004126 * Returns: 0 on success, -1 on failure
4127 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004128 int (*create_receive_sa)(void *priv, struct receive_sa *sa);
4129
4130 /**
4131 * delete_receive_sa - Delete secure association for receive
4132 * @priv: Private driver interface data from init()
4133 * @sa: Secure association
4134 * Returns: 0 on success, -1 on failure
4135 */
4136 int (*delete_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004137
4138 /**
4139 * enable_receive_sa - enable the SA for receive
4140 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004141 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004142 * Returns: 0 on success, -1 on failure
4143 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004144 int (*enable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004145
4146 /**
4147 * disable_receive_sa - disable SA for receive
4148 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004149 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004150 * Returns: 0 on success, -1 on failure
4151 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004152 int (*disable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004153
4154 /**
4155 * create_transmit_sc - create secure connection for transmit
4156 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004157 * @sc: secure channel
4158 * @conf_offset: confidentiality offset (0, 30, or 50)
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004159 * Returns: 0 on success, -1 on failure
4160 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004161 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
4162 unsigned int conf_offset);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004163
4164 /**
4165 * delete_transmit_sc - delete secure connection for transmit
4166 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004167 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004168 * Returns: 0 on success, -1 on failure
4169 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004170 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004171
4172 /**
4173 * create_transmit_sa - create secure association for transmit
4174 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004175 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004176 * Returns: 0 on success, -1 on failure
4177 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004178 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);
4179
4180 /**
4181 * delete_transmit_sa - Delete secure association for transmit
4182 * @priv: Private driver interface data from init()
4183 * @sa: Secure association
4184 * Returns: 0 on success, -1 on failure
4185 */
4186 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004187
4188 /**
4189 * enable_transmit_sa - enable SA for transmit
4190 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004191 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004192 * Returns: 0 on success, -1 on failure
4193 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004194 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004195
4196 /**
4197 * disable_transmit_sa - disable SA for transmit
4198 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004199 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004200 * Returns: 0 on success, -1 on failure
4201 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004202 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004203#endif /* CONFIG_MACSEC */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004204
4205 /**
4206 * init_mesh - Driver specific initialization for mesh
4207 * @priv: Private driver interface data
4208 * Returns: 0 on success, -1 on failure
4209 */
4210 int (*init_mesh)(void *priv);
4211
4212 /**
4213 * join_mesh - Join a mesh network
4214 * @priv: Private driver interface data
4215 * @params: Mesh configuration parameters
4216 * Returns: 0 on success, -1 on failure
4217 */
4218 int (*join_mesh)(void *priv,
4219 struct wpa_driver_mesh_join_params *params);
4220
4221 /**
4222 * leave_mesh - Leave a mesh network
4223 * @priv: Private driver interface data
4224 * Returns 0 on success, -1 on failure
4225 */
4226 int (*leave_mesh)(void *priv);
4227
4228 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07004229 * probe_mesh_link - Inject a frame over direct mesh link to a given
4230 * peer skipping the next_hop lookup from mpath table.
4231 * @priv: Private driver interface data
4232 * @addr: Peer MAC address
4233 * @eth: Ethernet frame to be sent
4234 * @len: Ethernet frame lengtn in bytes
4235 * Returns 0 on success, -1 on failure
4236 */
4237 int (*probe_mesh_link)(void *priv, const u8 *addr, const u8 *eth,
4238 size_t len);
4239
4240 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004241 * do_acs - Automatically select channel
4242 * @priv: Private driver interface data
4243 * @params: Parameters for ACS
4244 * Returns 0 on success, -1 on failure
4245 *
4246 * This command can be used to offload ACS to the driver if the driver
4247 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
4248 */
4249 int (*do_acs)(void *priv, struct drv_acs_params *params);
Ravi Joshie6ccb162015-07-16 17:45:41 -07004250
4251 /**
4252 * set_band - Notify driver of band selection
4253 * @priv: Private driver interface data
4254 * @band: The selected band(s)
4255 * Returns 0 on success, -1 on failure
4256 */
4257 int (*set_band)(void *priv, enum set_band band);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004258
4259 /**
4260 * get_pref_freq_list - Get preferred frequency list for an interface
4261 * @priv: Private driver interface data
4262 * @if_type: Interface type
4263 * @num: Number of channels
4264 * @freq_list: Preferred channel frequency list encoded in MHz values
4265 * Returns 0 on success, -1 on failure
4266 *
4267 * This command can be used to query the preferred frequency list from
4268 * the driver specific to a particular interface type.
4269 */
4270 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
4271 unsigned int *num, unsigned int *freq_list);
4272
4273 /**
4274 * set_prob_oper_freq - Indicate probable P2P operating channel
4275 * @priv: Private driver interface data
4276 * @freq: Channel frequency in MHz
4277 * Returns 0 on success, -1 on failure
4278 *
4279 * This command can be used to inform the driver of the operating
4280 * frequency that an ongoing P2P group formation is likely to come up
4281 * on. Local device is assuming P2P Client role.
4282 */
4283 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004284
4285 /**
4286 * abort_scan - Request the driver to abort an ongoing scan
4287 * @priv: Private driver interface data
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004288 * @scan_cookie: Cookie identifying the scan request. This is used only
4289 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4290 * was used to trigger scan. Otherwise, 0 is used.
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004291 * Returns 0 on success, -1 on failure
4292 */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004293 int (*abort_scan)(void *priv, u64 scan_cookie);
Dmitry Shmidt849734c2016-05-27 09:59:01 -07004294
4295 /**
4296 * configure_data_frame_filters - Request to configure frame filters
4297 * @priv: Private driver interface data
4298 * @filter_flags: The type of frames to filter (bitfield of
4299 * WPA_DATA_FRAME_FILTER_FLAG_*)
4300 * Returns: 0 on success or -1 on failure
4301 */
4302 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07004303
4304 /**
4305 * get_ext_capab - Get extended capabilities for the specified interface
4306 * @priv: Private driver interface data
4307 * @type: Interface type for which to get extended capabilities
4308 * @ext_capab: Extended capabilities fetched
4309 * @ext_capab_mask: Extended capabilities mask
4310 * @ext_capab_len: Length of the extended capabilities
4311 * Returns: 0 on success or -1 on failure
4312 */
4313 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
4314 const u8 **ext_capab, const u8 **ext_capab_mask,
4315 unsigned int *ext_capab_len);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004316
4317 /**
4318 * p2p_lo_start - Start offloading P2P listen to device
4319 * @priv: Private driver interface data
4320 * @freq: Listening frequency (MHz) for P2P listen
4321 * @period: Length of the listen operation in milliseconds
4322 * @interval: Interval for running the listen operation in milliseconds
4323 * @count: Number of times to run the listen operation
4324 * @device_types: Device primary and secondary types
4325 * @dev_types_len: Number of bytes for device_types
4326 * @ies: P2P IE and WSC IE for Probe Response frames
4327 * @ies_len: Length of ies in bytes
4328 * Returns: 0 on success or -1 on failure
4329 */
4330 int (*p2p_lo_start)(void *priv, unsigned int freq,
4331 unsigned int period, unsigned int interval,
4332 unsigned int count,
4333 const u8 *device_types, size_t dev_types_len,
4334 const u8 *ies, size_t ies_len);
4335
4336 /**
4337 * p2p_lo_stop - Stop P2P listen offload
4338 * @priv: Private driver interface data
4339 * Returns: 0 on success or -1 on failure
4340 */
4341 int (*p2p_lo_stop)(void *priv);
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07004342
4343 /**
4344 * set_default_scan_ies - Set default scan IEs
4345 * @priv: Private driver interface data
4346 * @ies: Scan default IEs buffer
4347 * @ies_len: Length of IEs in bytes
4348 * Returns: 0 on success or -1 on failure
4349 *
4350 * The driver can use these by default when there are no scan IEs coming
4351 * in the subsequent scan requests. Also in case of one or more of IEs
4352 * given in set_default_scan_ies() are missing in the subsequent scan
4353 * request, the driver should merge the missing scan IEs in the scan
4354 * request from the IEs set by set_default_scan_ies() in the Probe
4355 * Request frames sent.
4356 */
4357 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
4358
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004359 /**
4360 * set_tdls_mode - Set TDLS trigger mode to the host driver
4361 * @priv: Private driver interface data
4362 * @tdls_external_control: Represents if TDLS external trigger control
4363 * mode is enabled/disabled.
4364 *
4365 * This optional callback can be used to configure the TDLS external
4366 * trigger control mode to the host driver.
4367 */
4368 int (*set_tdls_mode)(void *priv, int tdls_external_control);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004369
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004370 /**
4371 * get_bss_transition_status - Get candidate BSS's transition status
4372 * @priv: Private driver interface data
4373 * @params: Candidate BSS list
4374 *
4375 * Get the accept or reject reason code for a list of BSS transition
4376 * candidates.
4377 */
4378 struct wpa_bss_candidate_info *
4379 (*get_bss_transition_status)(void *priv,
4380 struct wpa_bss_trans_info *params);
4381 /**
4382 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
4383 * @priv: Private driver interface data
4384 * @ignore_disallow: 0 to not ignore, 1 to ignore
4385 * Returns: 0 on success, -1 on failure
4386 */
4387 int (*ignore_assoc_disallow)(void *priv, int ignore_disallow);
4388
4389 /**
Hai Shalom899fcc72020-10-19 14:38:18 -07004390 * set_bssid_tmp_disallow - Set disallowed BSSIDs to the driver
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004391 * @priv: Private driver interface data
Hai Shalom899fcc72020-10-19 14:38:18 -07004392 * @num_bssid: Number of temporarily disallowed BSSIDs
4393 * @bssids: List of temporarily disallowed BSSIDs
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004394 */
Hai Shalom899fcc72020-10-19 14:38:18 -07004395 int (*set_bssid_tmp_disallow)(void *priv, unsigned int num_bssid,
4396 const u8 *bssid);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004397
4398 /**
4399 * update_connect_params - Update the connection parameters
4400 * @priv: Private driver interface data
4401 * @params: Association parameters
4402 * @mask: Bit mask indicating which parameters in @params have to be
4403 * updated
4404 * Returns: 0 on success, -1 on failure
4405 *
4406 * Update the connection parameters when in connected state so that the
4407 * driver uses the updated parameters for subsequent roaming. This is
4408 * used only with drivers that implement internal BSS selection and
4409 * roaming.
4410 */
4411 int (*update_connect_params)(
4412 void *priv, struct wpa_driver_associate_params *params,
4413 enum wpa_drv_update_connect_params_mask mask);
Roshan Pius3a1667e2018-07-03 15:17:14 -07004414
4415 /**
4416 * send_external_auth_status - Indicate the status of external
4417 * authentication processing to the host driver.
4418 * @priv: Private driver interface data
4419 * @params: Status of authentication processing.
4420 * Returns: 0 on success, -1 on failure
4421 */
4422 int (*send_external_auth_status)(void *priv,
4423 struct external_auth *params);
Hai Shalom74f70d42019-02-11 14:42:39 -08004424
4425 /**
4426 * set_4addr_mode - Set 4-address mode
4427 * @priv: Private driver interface data
4428 * @bridge_ifname: Bridge interface name
4429 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
4430 * Returns: 0 on success, < 0 on failure
4431 */
4432 int (*set_4addr_mode)(void *priv, const char *bridge_ifname, int val);
Hai Shalom81f62d82019-07-22 12:10:00 -07004433
4434 /**
4435 * update_dh_ie - Update DH IE
4436 * @priv: Private driver interface data
4437 * @peer_mac: Peer MAC address
4438 * @reason_code: Reacon code
4439 * @ie: DH IE
4440 * @ie_len: DH IE length in bytes
4441 * Returns: 0 on success, -1 on failure
4442 *
4443 * This callback is used to let the driver know the DH processing result
4444 * and DH IE for a pending association.
4445 */
4446 int (*update_dh_ie)(void *priv, const u8 *peer_mac, u16 reason_code,
4447 const u8 *ie, size_t ie_len);
Hai Shalomb755a2a2020-04-23 21:49:02 -07004448
4449 /**
4450 * dpp_listen - Notify driver about start/stop of DPP listen
4451 * @priv: Private driver interface data
4452 * @enable: Whether listen state is enabled (or disabled)
4453 * Returns: 0 on success, -1 on failure
4454 *
4455 * This optional callback can be used to update RX frame filtering to
4456 * explicitly allow reception of broadcast Public Action frames.
4457 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004458 int (*dpp_listen)(void *priv, bool enable);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004459};
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004460
4461/**
4462 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
4463 */
4464enum wpa_event_type {
4465 /**
4466 * EVENT_ASSOC - Association completed
4467 *
4468 * This event needs to be delivered when the driver completes IEEE
4469 * 802.11 association or reassociation successfully.
4470 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
4471 * after this event has been generated. In addition, optional
4472 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
4473 * more information about the association. If the driver interface gets
4474 * both of these events at the same time, it can also include the
4475 * assoc_info data in EVENT_ASSOC call.
4476 */
4477 EVENT_ASSOC,
4478
4479 /**
4480 * EVENT_DISASSOC - Association lost
4481 *
4482 * This event should be called when association is lost either due to
4483 * receiving deauthenticate or disassociate frame from the AP or when
4484 * sending either of these frames to the current AP. If the driver
4485 * supports separate deauthentication event, EVENT_DISASSOC should only
4486 * be used for disassociation and EVENT_DEAUTH for deauthentication.
4487 * In AP mode, union wpa_event_data::disassoc_info is required.
4488 */
4489 EVENT_DISASSOC,
4490
4491 /**
4492 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
4493 *
4494 * This event must be delivered when a Michael MIC error is detected by
4495 * the local driver. Additional data for event processing is
4496 * provided with union wpa_event_data::michael_mic_failure. This
4497 * information is used to request new encyption key and to initiate
4498 * TKIP countermeasures if needed.
4499 */
4500 EVENT_MICHAEL_MIC_FAILURE,
4501
4502 /**
4503 * EVENT_SCAN_RESULTS - Scan results available
4504 *
4505 * This event must be called whenever scan results are available to be
4506 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4507 * is expected to be used some time after struct wpa_driver_ops::scan()
4508 * is called. If the driver provides an unsolicited event when the scan
4509 * has been completed, this event can be used to trigger
4510 * EVENT_SCAN_RESULTS call. If such event is not available from the
4511 * driver, the driver wrapper code is expected to use a registered
4512 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
4513 * scan is expected to be completed. Optional information about
4514 * completed scan can be provided with union wpa_event_data::scan_info.
4515 */
4516 EVENT_SCAN_RESULTS,
4517
4518 /**
4519 * EVENT_ASSOCINFO - Report optional extra information for association
4520 *
4521 * This event can be used to report extra association information for
4522 * EVENT_ASSOC processing. This extra information includes IEs from
4523 * association frames and Beacon/Probe Response frames in union
4524 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4525 * EVENT_ASSOC. Alternatively, the driver interface can include
4526 * assoc_info data in the EVENT_ASSOC call if it has all the
4527 * information available at the same point.
4528 */
4529 EVENT_ASSOCINFO,
4530
4531 /**
4532 * EVENT_INTERFACE_STATUS - Report interface status changes
4533 *
4534 * This optional event can be used to report changes in interface
4535 * status (interface added/removed) using union
4536 * wpa_event_data::interface_status. This can be used to trigger
4537 * wpa_supplicant to stop and re-start processing for the interface,
4538 * e.g., when a cardbus card is ejected/inserted.
4539 */
4540 EVENT_INTERFACE_STATUS,
4541
4542 /**
4543 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4544 *
4545 * This event can be used to inform wpa_supplicant about candidates for
4546 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4547 * for scan request (ap_scan=2 mode), this event is required for
4548 * pre-authentication. If wpa_supplicant is performing scan request
4549 * (ap_scan=1), this event is optional since scan results can be used
4550 * to add pre-authentication candidates. union
4551 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4552 * candidate and priority of the candidate, e.g., based on the signal
4553 * strength, in order to try to pre-authenticate first with candidates
4554 * that are most likely targets for re-association.
4555 *
4556 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4557 * on the candidate list. In addition, it can be called for the current
4558 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4559 * will automatically skip pre-authentication in cases where a valid
4560 * PMKSA exists. When more than one candidate exists, this event should
4561 * be generated once for each candidate.
4562 *
4563 * Driver will be notified about successful pre-authentication with
4564 * struct wpa_driver_ops::add_pmkid() calls.
4565 */
4566 EVENT_PMKID_CANDIDATE,
4567
4568 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004569 * EVENT_TDLS - Request TDLS operation
4570 *
4571 * This event can be used to request a TDLS operation to be performed.
4572 */
4573 EVENT_TDLS,
4574
4575 /**
4576 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4577 *
4578 * The driver is expected to report the received FT IEs from
4579 * FT authentication sequence from the AP. The FT IEs are included in
4580 * the extra information in union wpa_event_data::ft_ies.
4581 */
4582 EVENT_FT_RESPONSE,
4583
4584 /**
4585 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4586 *
4587 * The driver can use this event to inform wpa_supplicant about a STA
4588 * in an IBSS with which protected frames could be exchanged. This
4589 * event starts RSN authentication with the other STA to authenticate
4590 * the STA and set up encryption keys with it.
4591 */
4592 EVENT_IBSS_RSN_START,
4593
4594 /**
4595 * EVENT_AUTH - Authentication result
4596 *
4597 * This event should be called when authentication attempt has been
4598 * completed. This is only used if the driver supports separate
4599 * authentication step (struct wpa_driver_ops::authenticate).
4600 * Information about authentication result is included in
4601 * union wpa_event_data::auth.
4602 */
4603 EVENT_AUTH,
4604
4605 /**
4606 * EVENT_DEAUTH - Authentication lost
4607 *
4608 * This event should be called when authentication is lost either due
4609 * to receiving deauthenticate frame from the AP or when sending that
4610 * frame to the current AP.
4611 * In AP mode, union wpa_event_data::deauth_info is required.
4612 */
4613 EVENT_DEAUTH,
4614
4615 /**
4616 * EVENT_ASSOC_REJECT - Association rejected
4617 *
4618 * This event should be called when (re)association attempt has been
4619 * rejected by the AP. Information about the association response is
4620 * included in union wpa_event_data::assoc_reject.
4621 */
4622 EVENT_ASSOC_REJECT,
4623
4624 /**
4625 * EVENT_AUTH_TIMED_OUT - Authentication timed out
4626 */
4627 EVENT_AUTH_TIMED_OUT,
4628
4629 /**
4630 * EVENT_ASSOC_TIMED_OUT - Association timed out
4631 */
4632 EVENT_ASSOC_TIMED_OUT,
4633
4634 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004635 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
4636 */
4637 EVENT_WPS_BUTTON_PUSHED,
4638
4639 /**
4640 * EVENT_TX_STATUS - Report TX status
4641 */
4642 EVENT_TX_STATUS,
4643
4644 /**
4645 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
4646 */
4647 EVENT_RX_FROM_UNKNOWN,
4648
4649 /**
4650 * EVENT_RX_MGMT - Report RX of a management frame
4651 */
4652 EVENT_RX_MGMT,
4653
4654 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004655 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
4656 *
4657 * This event is used to indicate when the driver has started the
4658 * requested remain-on-channel duration. Information about the
4659 * operation is included in union wpa_event_data::remain_on_channel.
4660 */
4661 EVENT_REMAIN_ON_CHANNEL,
4662
4663 /**
4664 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
4665 *
4666 * This event is used to indicate when the driver has completed
4667 * remain-on-channel duration, i.e., may noot be available on the
4668 * requested channel anymore. Information about the
4669 * operation is included in union wpa_event_data::remain_on_channel.
4670 */
4671 EVENT_CANCEL_REMAIN_ON_CHANNEL,
4672
4673 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004674 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
4675 *
4676 * This event is used to indicate when a Probe Request frame has been
4677 * received. Information about the received frame is included in
4678 * union wpa_event_data::rx_probe_req. The driver is required to report
4679 * these events only after successfully completed probe_req_report()
4680 * commands to request the events (i.e., report parameter is non-zero)
4681 * in station mode. In AP mode, Probe Request frames should always be
4682 * reported.
4683 */
4684 EVENT_RX_PROBE_REQ,
4685
4686 /**
4687 * EVENT_NEW_STA - New wired device noticed
4688 *
4689 * This event is used to indicate that a new device has been detected
4690 * in a network that does not use association-like functionality (i.e.,
4691 * mainly wired Ethernet). This can be used to start EAPOL
4692 * authenticator when receiving a frame from a device. The address of
4693 * the device is included in union wpa_event_data::new_sta.
4694 */
4695 EVENT_NEW_STA,
4696
4697 /**
4698 * EVENT_EAPOL_RX - Report received EAPOL frame
4699 *
4700 * When in AP mode with hostapd, this event is required to be used to
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004701 * deliver the receive EAPOL frames from the driver.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004702 */
4703 EVENT_EAPOL_RX,
4704
4705 /**
4706 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4707 *
4708 * This event is used to indicate changes in the signal strength
4709 * observed in frames received from the current AP if signal strength
4710 * monitoring has been enabled with signal_monitor().
4711 */
4712 EVENT_SIGNAL_CHANGE,
4713
4714 /**
4715 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4716 *
4717 * This event is used to indicate that the interface was enabled after
4718 * having been previously disabled, e.g., due to rfkill.
4719 */
4720 EVENT_INTERFACE_ENABLED,
4721
4722 /**
4723 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4724 *
4725 * This event is used to indicate that the interface was disabled,
4726 * e.g., due to rfkill.
4727 */
4728 EVENT_INTERFACE_DISABLED,
4729
4730 /**
4731 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4732 *
4733 * This event is used to indicate that the channel list has changed,
4734 * e.g., because of a regulatory domain change triggered by scan
4735 * results including an AP advertising a country code.
4736 */
4737 EVENT_CHANNEL_LIST_CHANGED,
4738
4739 /**
4740 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4741 *
4742 * This event is used to indicate that the driver cannot maintain this
4743 * interface in its operation mode anymore. The most likely use for
4744 * this is to indicate that AP mode operation is not available due to
4745 * operating channel would need to be changed to a DFS channel when
4746 * the driver does not support radar detection and another virtual
4747 * interfaces caused the operating channel to change. Other similar
4748 * resource conflicts could also trigger this for station mode
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07004749 * interfaces. This event can be propagated when channel switching
4750 * fails.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004751 */
4752 EVENT_INTERFACE_UNAVAILABLE,
4753
4754 /**
4755 * EVENT_BEST_CHANNEL
4756 *
4757 * Driver generates this event whenever it detects a better channel
4758 * (e.g., based on RSSI or channel use). This information can be used
4759 * to improve channel selection for a new AP/P2P group.
4760 */
4761 EVENT_BEST_CHANNEL,
4762
4763 /**
4764 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4765 *
4766 * This event should be called when a Deauthentication frame is dropped
4767 * due to it not being protected (MFP/IEEE 802.11w).
4768 * union wpa_event_data::unprot_deauth is required to provide more
4769 * details of the frame.
4770 */
4771 EVENT_UNPROT_DEAUTH,
4772
4773 /**
4774 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4775 *
4776 * This event should be called when a Disassociation frame is dropped
4777 * due to it not being protected (MFP/IEEE 802.11w).
4778 * union wpa_event_data::unprot_disassoc is required to provide more
4779 * details of the frame.
4780 */
4781 EVENT_UNPROT_DISASSOC,
4782
4783 /**
4784 * EVENT_STATION_LOW_ACK
4785 *
4786 * Driver generates this event whenever it detected that a particular
4787 * station was lost. Detection can be through massive transmission
4788 * failures for example.
4789 */
4790 EVENT_STATION_LOW_ACK,
4791
4792 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004793 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4794 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004795 EVENT_IBSS_PEER_LOST,
4796
4797 /**
4798 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4799 *
4800 * This event carries the new replay counter to notify wpa_supplicant
4801 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4802 * completed Group Key Handshake while the host (including
4803 * wpa_supplicant was sleeping).
4804 */
4805 EVENT_DRIVER_GTK_REKEY,
4806
4807 /**
4808 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4809 */
4810 EVENT_SCHED_SCAN_STOPPED,
4811
4812 /**
4813 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4814 *
4815 * This event indicates that the station responded to the poll
4816 * initiated with @poll_client.
4817 */
4818 EVENT_DRIVER_CLIENT_POLL_OK,
4819
4820 /**
4821 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4822 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07004823 EVENT_EAPOL_TX_STATUS,
4824
4825 /**
4826 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4827 *
4828 * Described in wpa_event_data.ch_switch
4829 * */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004830 EVENT_CH_SWITCH,
4831
4832 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07004833 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
4834 *
4835 * This is a pre-switch event indicating the shortly following switch
4836 * of operating channels.
4837 *
4838 * Described in wpa_event_data.ch_switch
4839 */
4840 EVENT_CH_SWITCH_STARTED,
4841 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004842 * EVENT_WNM - Request WNM operation
4843 *
4844 * This event can be used to request a WNM operation to be performed.
4845 */
Dmitry Shmidtf8623282013-02-20 14:34:59 -08004846 EVENT_WNM,
4847
4848 /**
4849 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4850 *
4851 * This event indicates that the driver reported a connection failure
4852 * with the specified client (for example, max client reached, etc.) in
4853 * AP mode.
4854 */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004855 EVENT_CONNECT_FAILED_REASON,
4856
4857 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004858 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004859 *
4860 * A radar has been detected on the supplied frequency, hostapd should
4861 * react accordingly (e.g., change channel).
4862 */
4863 EVENT_DFS_RADAR_DETECTED,
4864
4865 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004866 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004867 *
4868 * After a successful CAC, the channel can be marked clear and used.
4869 */
4870 EVENT_DFS_CAC_FINISHED,
4871
4872 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004873 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004874 *
4875 * The CAC was not successful, and the channel remains in the previous
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004876 * state. This may happen due to a radar being detected or other
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004877 * external influences.
4878 */
4879 EVENT_DFS_CAC_ABORTED,
4880
4881 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004882 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004883 *
4884 * The channel which was previously unavailable is now available again.
4885 */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004886 EVENT_DFS_NOP_FINISHED,
4887
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08004888 /**
4889 * EVENT_SURVEY - Received survey data
4890 *
4891 * This event gets triggered when a driver query is issued for survey
4892 * data and the requested data becomes available. The returned data is
4893 * stored in struct survey_results. The results provide at most one
4894 * survey entry for each frequency and at minimum will provide one
4895 * survey entry for one frequency. The survey data can be os_malloc()'d
4896 * and then os_free()'d, so the event callback must only copy data.
4897 */
4898 EVENT_SURVEY,
4899
4900 /**
4901 * EVENT_SCAN_STARTED - Scan started
4902 *
4903 * This indicates that driver has started a scan operation either based
4904 * on a request from wpa_supplicant/hostapd or from another application.
4905 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4906 * completed (either successfully or by getting cancelled).
4907 */
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08004908 EVENT_SCAN_STARTED,
4909
4910 /**
4911 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4912 *
4913 * This event indicates a set of frequency ranges that should be avoided
4914 * to reduce issues due to interference or internal co-existence
4915 * information in the driver.
4916 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004917 EVENT_AVOID_FREQUENCIES,
4918
4919 /**
4920 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4921 */
4922 EVENT_NEW_PEER_CANDIDATE,
4923
4924 /**
4925 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4926 *
4927 * Indicates a pair of primary and secondary channels chosen by ACS
4928 * in device.
4929 */
4930 EVENT_ACS_CHANNEL_SELECTED,
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004931
4932 /**
4933 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4934 * been started.
4935 *
4936 * This event indicates that channel availability check has been started
4937 * on a DFS frequency by a driver that supports DFS Offload.
4938 */
4939 EVENT_DFS_CAC_STARTED,
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004940
4941 /**
4942 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4943 */
4944 EVENT_P2P_LO_STOP,
Paul Stewart092955c2017-02-06 09:13:09 -08004945
4946 /**
4947 * EVENT_BEACON_LOSS - Beacon loss detected
4948 *
4949 * This event indicates that no Beacon frames has been received from
4950 * the current AP. This may indicate that the AP is not anymore in
4951 * range.
4952 */
4953 EVENT_BEACON_LOSS,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004954
4955 /**
4956 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
4957 * done previously (Pre-CAC) on the channel has expired. This would
4958 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
4959 * channel will be moved from available to usable. A new CAC has to be
4960 * performed before start operating on this channel.
4961 */
4962 EVENT_DFS_PRE_CAC_EXPIRED,
Roshan Pius3a1667e2018-07-03 15:17:14 -07004963
4964 /**
4965 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
4966 * that do not define separate commands for authentication and
4967 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
4968 * authentication to wpa_supplicant. This event carries all the
4969 * necessary information from the host driver for the authentication to
4970 * happen.
4971 */
4972 EVENT_EXTERNAL_AUTH,
4973
4974 /**
4975 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
4976 *
4977 * This event should be indicated when the driver completes the 4-way
4978 * handshake. This event should be preceded by an EVENT_ASSOC that
4979 * indicates the completion of IEEE 802.11 association.
4980 */
4981 EVENT_PORT_AUTHORIZED,
4982
4983 /**
4984 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
4985 * change event.
4986 */
4987 EVENT_STATION_OPMODE_CHANGED,
4988
4989 /**
4990 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
4991 *
4992 * This event is emitted when the MAC changes while the interface is
4993 * enabled. When an interface was disabled and becomes enabled, it
4994 * must be always assumed that the MAC possibly changed.
4995 */
4996 EVENT_INTERFACE_MAC_CHANGED,
4997
4998 /**
4999 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
5000 *
5001 * This event is emitted when an interface is added/removed for WDS STA.
5002 */
5003 EVENT_WDS_STA_INTERFACE_STATUS,
Hai Shalom81f62d82019-07-22 12:10:00 -07005004
5005 /**
5006 * EVENT_UPDATE_DH - Notification of updated DH information
5007 */
5008 EVENT_UPDATE_DH,
Hai Shalomfdcde762020-04-02 11:19:20 -07005009
5010 /**
5011 * EVENT_UNPROT_BEACON - Unprotected Beacon frame received
5012 *
5013 * This event should be called when a Beacon frame is dropped due to it
5014 * not being protected correctly. union wpa_event_data::unprot_beacon
5015 * is required to provide more details of the frame.
5016 */
5017 EVENT_UNPROT_BEACON,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005018};
5019
5020
5021/**
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005022 * struct freq_survey - Channel survey info
5023 *
5024 * @ifidx: Interface index in which this survey was observed
5025 * @freq: Center of frequency of the surveyed channel
5026 * @nf: Channel noise floor in dBm
5027 * @channel_time: Amount of time in ms the radio spent on the channel
5028 * @channel_time_busy: Amount of time in ms the radio detected some signal
5029 * that indicated to the radio the channel was not clear
5030 * @channel_time_rx: Amount of time the radio spent receiving data
5031 * @channel_time_tx: Amount of time the radio spent transmitting data
5032 * @filled: bitmask indicating which fields have been reported, see
5033 * SURVEY_HAS_* defines.
5034 * @list: Internal list pointers
5035 */
5036struct freq_survey {
5037 u32 ifidx;
5038 unsigned int freq;
5039 s8 nf;
5040 u64 channel_time;
5041 u64 channel_time_busy;
5042 u64 channel_time_rx;
5043 u64 channel_time_tx;
5044 unsigned int filled;
5045 struct dl_list list;
5046};
5047
5048#define SURVEY_HAS_NF BIT(0)
5049#define SURVEY_HAS_CHAN_TIME BIT(1)
5050#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
5051#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
5052#define SURVEY_HAS_CHAN_TIME_TX BIT(4)
5053
5054
5055/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005056 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
5057 */
5058union wpa_event_data {
5059 /**
5060 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
5061 *
5062 * This structure is optional for EVENT_ASSOC calls and required for
5063 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
5064 * driver interface does not need to generate separate EVENT_ASSOCINFO
5065 * calls.
5066 */
5067 struct assoc_info {
5068 /**
5069 * reassoc - Flag to indicate association or reassociation
5070 */
5071 int reassoc;
5072
5073 /**
5074 * req_ies - (Re)Association Request IEs
5075 *
5076 * If the driver generates WPA/RSN IE, this event data must be
5077 * returned for WPA handshake to have needed information. If
5078 * wpa_supplicant-generated WPA/RSN IE is used, this
5079 * information event is optional.
5080 *
5081 * This should start with the first IE (fixed fields before IEs
5082 * are not included).
5083 */
5084 const u8 *req_ies;
5085
5086 /**
5087 * req_ies_len - Length of req_ies in bytes
5088 */
5089 size_t req_ies_len;
5090
5091 /**
5092 * resp_ies - (Re)Association Response IEs
5093 *
5094 * Optional association data from the driver. This data is not
5095 * required WPA, but may be useful for some protocols and as
5096 * such, should be reported if this is available to the driver
5097 * interface.
5098 *
5099 * This should start with the first IE (fixed fields before IEs
5100 * are not included).
5101 */
5102 const u8 *resp_ies;
5103
5104 /**
5105 * resp_ies_len - Length of resp_ies in bytes
5106 */
5107 size_t resp_ies_len;
5108
5109 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08005110 * resp_frame - (Re)Association Response frame
5111 */
5112 const u8 *resp_frame;
5113
5114 /**
5115 * resp_frame_len - (Re)Association Response frame length
5116 */
5117 size_t resp_frame_len;
5118
5119 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005120 * beacon_ies - Beacon or Probe Response IEs
5121 *
5122 * Optional Beacon/ProbeResp data: IEs included in Beacon or
5123 * Probe Response frames from the current AP (i.e., the one
5124 * that the client just associated with). This information is
5125 * used to update WPA/RSN IE for the AP. If this field is not
5126 * set, the results from previous scan will be used. If no
5127 * data for the new AP is found, scan results will be requested
5128 * again (without scan request). At this point, the driver is
5129 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
5130 * used).
5131 *
5132 * This should start with the first IE (fixed fields before IEs
5133 * are not included).
5134 */
5135 const u8 *beacon_ies;
5136
5137 /**
5138 * beacon_ies_len - Length of beacon_ies */
5139 size_t beacon_ies_len;
5140
5141 /**
5142 * freq - Frequency of the operational channel in MHz
5143 */
5144 unsigned int freq;
5145
5146 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005147 * wmm_params - WMM parameters used in this association.
5148 */
5149 struct wmm_params wmm_params;
5150
5151 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005152 * addr - Station address (for AP mode)
5153 */
5154 const u8 *addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005155
5156 /**
5157 * The following is the key management offload information
5158 * @authorized
5159 * @key_replay_ctr
5160 * @key_replay_ctr_len
5161 * @ptk_kck
5162 * @ptk_kek_len
5163 * @ptk_kek
5164 * @ptk_kek_len
5165 */
5166
5167 /**
5168 * authorized - Status of key management offload,
5169 * 1 = successful
5170 */
5171 int authorized;
5172
5173 /**
5174 * key_replay_ctr - Key replay counter value last used
5175 * in a valid EAPOL-Key frame
5176 */
5177 const u8 *key_replay_ctr;
5178
5179 /**
5180 * key_replay_ctr_len - The length of key_replay_ctr
5181 */
5182 size_t key_replay_ctr_len;
5183
5184 /**
5185 * ptk_kck - The derived PTK KCK
5186 */
5187 const u8 *ptk_kck;
5188
5189 /**
5190 * ptk_kek_len - The length of ptk_kck
5191 */
5192 size_t ptk_kck_len;
5193
5194 /**
5195 * ptk_kek - The derived PTK KEK
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005196 * This is used in key management offload and also in FILS SK
5197 * offload.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005198 */
5199 const u8 *ptk_kek;
5200
5201 /**
5202 * ptk_kek_len - The length of ptk_kek
5203 */
5204 size_t ptk_kek_len;
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08005205
5206 /**
5207 * subnet_status - The subnet status:
5208 * 0 = unknown, 1 = unchanged, 2 = changed
5209 */
5210 u8 subnet_status;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005211
5212 /**
5213 * The following information is used in FILS SK offload
5214 * @fils_erp_next_seq_num
5215 * @fils_pmk
5216 * @fils_pmk_len
5217 * @fils_pmkid
5218 */
5219
5220 /**
5221 * fils_erp_next_seq_num - The next sequence number to use in
5222 * FILS ERP messages
5223 */
5224 u16 fils_erp_next_seq_num;
5225
5226 /**
5227 * fils_pmk - A new PMK if generated in case of FILS
5228 * authentication
5229 */
5230 const u8 *fils_pmk;
5231
5232 /**
5233 * fils_pmk_len - Length of fils_pmk
5234 */
5235 size_t fils_pmk_len;
5236
5237 /**
5238 * fils_pmkid - PMKID used or generated in FILS authentication
5239 */
5240 const u8 *fils_pmkid;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005241 } assoc_info;
5242
5243 /**
5244 * struct disassoc_info - Data for EVENT_DISASSOC events
5245 */
5246 struct disassoc_info {
5247 /**
5248 * addr - Station address (for AP mode)
5249 */
5250 const u8 *addr;
5251
5252 /**
5253 * reason_code - Reason Code (host byte order) used in
5254 * Deauthentication frame
5255 */
5256 u16 reason_code;
5257
5258 /**
5259 * ie - Optional IE(s) in Disassociation frame
5260 */
5261 const u8 *ie;
5262
5263 /**
5264 * ie_len - Length of ie buffer in octets
5265 */
5266 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005267
5268 /**
5269 * locally_generated - Whether the frame was locally generated
5270 */
5271 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005272 } disassoc_info;
5273
5274 /**
5275 * struct deauth_info - Data for EVENT_DEAUTH events
5276 */
5277 struct deauth_info {
5278 /**
5279 * addr - Station address (for AP mode)
5280 */
5281 const u8 *addr;
5282
5283 /**
5284 * reason_code - Reason Code (host byte order) used in
5285 * Deauthentication frame
5286 */
5287 u16 reason_code;
5288
5289 /**
5290 * ie - Optional IE(s) in Deauthentication frame
5291 */
5292 const u8 *ie;
5293
5294 /**
5295 * ie_len - Length of ie buffer in octets
5296 */
5297 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005298
5299 /**
5300 * locally_generated - Whether the frame was locally generated
5301 */
5302 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005303 } deauth_info;
5304
5305 /**
5306 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
5307 */
5308 struct michael_mic_failure {
5309 int unicast;
5310 const u8 *src;
5311 } michael_mic_failure;
5312
5313 /**
5314 * struct interface_status - Data for EVENT_INTERFACE_STATUS
5315 */
5316 struct interface_status {
Dmitry Shmidte4663042016-04-04 10:07:49 -07005317 unsigned int ifindex;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005318 char ifname[100];
5319 enum {
5320 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
5321 } ievent;
5322 } interface_status;
5323
5324 /**
5325 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
5326 */
5327 struct pmkid_candidate {
5328 /** BSSID of the PMKID candidate */
5329 u8 bssid[ETH_ALEN];
5330 /** Smaller the index, higher the priority */
5331 int index;
5332 /** Whether RSN IE includes pre-authenticate flag */
5333 int preauth;
5334 } pmkid_candidate;
5335
5336 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005337 * struct tdls - Data for EVENT_TDLS
5338 */
5339 struct tdls {
5340 u8 peer[ETH_ALEN];
5341 enum {
5342 TDLS_REQUEST_SETUP,
Dmitry Shmidt4dd28dc2015-03-10 11:21:43 -07005343 TDLS_REQUEST_TEARDOWN,
5344 TDLS_REQUEST_DISCOVER,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005345 } oper;
5346 u16 reason_code; /* for teardown */
5347 } tdls;
5348
5349 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07005350 * struct wnm - Data for EVENT_WNM
5351 */
5352 struct wnm {
5353 u8 addr[ETH_ALEN];
5354 enum {
5355 WNM_OPER_SLEEP,
5356 } oper;
5357 enum {
5358 WNM_SLEEP_ENTER,
5359 WNM_SLEEP_EXIT
5360 } sleep_action;
5361 int sleep_intval;
5362 u16 reason_code;
5363 u8 *buf;
5364 u16 buf_len;
5365 } wnm;
5366
5367 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005368 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
5369 *
5370 * During FT (IEEE 802.11r) authentication sequence, the driver is
5371 * expected to use this event to report received FT IEs (MDIE, FTIE,
5372 * RSN IE, TIE, possible resource request) to the supplicant. The FT
5373 * IEs for the next message will be delivered through the
5374 * struct wpa_driver_ops::update_ft_ies() callback.
5375 */
5376 struct ft_ies {
5377 const u8 *ies;
5378 size_t ies_len;
5379 int ft_action;
5380 u8 target_ap[ETH_ALEN];
5381 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
5382 const u8 *ric_ies;
5383 /** Length of ric_ies buffer in octets */
5384 size_t ric_ies_len;
5385 } ft_ies;
5386
5387 /**
5388 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
5389 */
5390 struct ibss_rsn_start {
5391 u8 peer[ETH_ALEN];
5392 } ibss_rsn_start;
5393
5394 /**
5395 * struct auth_info - Data for EVENT_AUTH events
5396 */
5397 struct auth_info {
5398 u8 peer[ETH_ALEN];
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005399 u8 bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005400 u16 auth_type;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005401 u16 auth_transaction;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005402 u16 status_code;
5403 const u8 *ies;
5404 size_t ies_len;
5405 } auth;
5406
5407 /**
5408 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
5409 */
5410 struct assoc_reject {
5411 /**
5412 * bssid - BSSID of the AP that rejected association
5413 */
5414 const u8 *bssid;
5415
5416 /**
5417 * resp_ies - (Re)Association Response IEs
5418 *
5419 * Optional association data from the driver. This data is not
5420 * required WPA, but may be useful for some protocols and as
5421 * such, should be reported if this is available to the driver
5422 * interface.
5423 *
5424 * This should start with the first IE (fixed fields before IEs
5425 * are not included).
5426 */
5427 const u8 *resp_ies;
5428
5429 /**
5430 * resp_ies_len - Length of resp_ies in bytes
5431 */
5432 size_t resp_ies_len;
5433
5434 /**
5435 * status_code - Status Code from (Re)association Response
5436 */
5437 u16 status_code;
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07005438
5439 /**
5440 * timed_out - Whether failure is due to timeout (etc.) rather
5441 * than explicit rejection response from the AP.
5442 */
5443 int timed_out;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08005444
5445 /**
5446 * timeout_reason - Reason for the timeout
5447 */
5448 const char *timeout_reason;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005449
5450 /**
5451 * fils_erp_next_seq_num - The next sequence number to use in
5452 * FILS ERP messages
5453 */
5454 u16 fils_erp_next_seq_num;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005455 } assoc_reject;
5456
5457 struct timeout_event {
5458 u8 addr[ETH_ALEN];
5459 } timeout_event;
5460
5461 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005462 * struct tx_status - Data for EVENT_TX_STATUS events
5463 */
5464 struct tx_status {
5465 u16 type;
5466 u16 stype;
5467 const u8 *dst;
5468 const u8 *data;
5469 size_t data_len;
5470 int ack;
5471 } tx_status;
5472
5473 /**
5474 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
5475 */
5476 struct rx_from_unknown {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005477 const u8 *bssid;
5478 const u8 *addr;
5479 int wds;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005480 } rx_from_unknown;
5481
5482 /**
5483 * struct rx_mgmt - Data for EVENT_RX_MGMT events
5484 */
5485 struct rx_mgmt {
5486 const u8 *frame;
5487 size_t frame_len;
5488 u32 datarate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005489
5490 /**
Dmitry Shmidt98660862014-03-11 17:26:21 -07005491 * drv_priv - Pointer to store driver private BSS information
5492 *
5493 * If not set to NULL, this is used for comparison with
5494 * hostapd_data->drv_priv to determine which BSS should process
5495 * the frame.
5496 */
5497 void *drv_priv;
5498
5499 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005500 * freq - Frequency (in MHz) on which the frame was received
5501 */
5502 int freq;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005503
5504 /**
5505 * ssi_signal - Signal strength in dBm (or 0 if not available)
5506 */
5507 int ssi_signal;
5508 } rx_mgmt;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005509
5510 /**
5511 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
5512 *
5513 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
5514 */
5515 struct remain_on_channel {
5516 /**
5517 * freq - Channel frequency in MHz
5518 */
5519 unsigned int freq;
5520
5521 /**
5522 * duration - Duration to remain on the channel in milliseconds
5523 */
5524 unsigned int duration;
5525 } remain_on_channel;
5526
5527 /**
5528 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
5529 * @aborted: Whether the scan was aborted
5530 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
5531 * @num_freqs: Number of entries in freqs array
5532 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
5533 * SSID)
5534 * @num_ssids: Number of entries in ssids array
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08005535 * @external_scan: Whether the scan info is for an external scan
5536 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
5537 * 0 if the source of the scan event is a vendor scan
Dmitry Shmidt29333592017-01-09 12:27:11 -08005538 * @scan_start_tsf: Time when the scan started in terms of TSF of the
5539 * BSS that the interface that requested the scan is connected to
5540 * (if available).
5541 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
5542 * is set.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005543 */
5544 struct scan_info {
5545 int aborted;
5546 const int *freqs;
5547 size_t num_freqs;
5548 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
5549 size_t num_ssids;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08005550 int external_scan;
5551 int nl_scan_event;
Dmitry Shmidt29333592017-01-09 12:27:11 -08005552 u64 scan_start_tsf;
5553 u8 scan_start_tsf_bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005554 } scan_info;
5555
5556 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005557 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
5558 */
5559 struct rx_probe_req {
5560 /**
5561 * sa - Source address of the received Probe Request frame
5562 */
5563 const u8 *sa;
5564
5565 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005566 * da - Destination address of the received Probe Request frame
5567 * or %NULL if not available
5568 */
5569 const u8 *da;
5570
5571 /**
5572 * bssid - BSSID of the received Probe Request frame or %NULL
5573 * if not available
5574 */
5575 const u8 *bssid;
5576
5577 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005578 * ie - IEs from the Probe Request body
5579 */
5580 const u8 *ie;
5581
5582 /**
5583 * ie_len - Length of ie buffer in octets
5584 */
5585 size_t ie_len;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005586
5587 /**
5588 * signal - signal strength in dBm (or 0 if not available)
5589 */
5590 int ssi_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005591 } rx_probe_req;
5592
5593 /**
5594 * struct new_sta - Data for EVENT_NEW_STA events
5595 */
5596 struct new_sta {
5597 const u8 *addr;
5598 } new_sta;
5599
5600 /**
5601 * struct eapol_rx - Data for EVENT_EAPOL_RX events
5602 */
5603 struct eapol_rx {
5604 const u8 *src;
5605 const u8 *data;
5606 size_t data_len;
5607 } eapol_rx;
5608
5609 /**
5610 * signal_change - Data for EVENT_SIGNAL_CHANGE events
5611 */
5612 struct wpa_signal_info signal_change;
5613
5614 /**
5615 * struct best_channel - Data for EVENT_BEST_CHANNEL events
5616 * @freq_24: Best 2.4 GHz band channel frequency in MHz
5617 * @freq_5: Best 5 GHz band channel frequency in MHz
5618 * @freq_overall: Best channel frequency in MHz
5619 *
5620 * 0 can be used to indicate no preference in either band.
5621 */
5622 struct best_channel {
5623 int freq_24;
5624 int freq_5;
5625 int freq_overall;
5626 } best_chan;
5627
5628 struct unprot_deauth {
5629 const u8 *sa;
5630 const u8 *da;
5631 u16 reason_code;
5632 } unprot_deauth;
5633
5634 struct unprot_disassoc {
5635 const u8 *sa;
5636 const u8 *da;
5637 u16 reason_code;
5638 } unprot_disassoc;
5639
5640 /**
5641 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
5642 * @addr: station address
Paul Stewart092955c2017-02-06 09:13:09 -08005643 * @num_packets: Number of packets lost (consecutive packets not
5644 * acknowledged)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005645 */
5646 struct low_ack {
5647 u8 addr[ETH_ALEN];
Paul Stewart092955c2017-02-06 09:13:09 -08005648 u32 num_packets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005649 } low_ack;
5650
5651 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005652 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
5653 */
5654 struct ibss_peer_lost {
5655 u8 peer[ETH_ALEN];
5656 } ibss_peer_lost;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005657
5658 /**
5659 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
5660 */
5661 struct driver_gtk_rekey {
5662 const u8 *bssid;
5663 const u8 *replay_ctr;
5664 } driver_gtk_rekey;
5665
5666 /**
5667 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
5668 * @addr: station address
5669 */
5670 struct client_poll {
5671 u8 addr[ETH_ALEN];
5672 } client_poll;
5673
5674 /**
5675 * struct eapol_tx_status
5676 * @dst: Original destination
5677 * @data: Data starting with IEEE 802.1X header (!)
5678 * @data_len: Length of data
5679 * @ack: Indicates ack or lost frame
5680 *
5681 * This corresponds to hapd_send_eapol if the frame sent
5682 * there isn't just reported as EVENT_TX_STATUS.
5683 */
5684 struct eapol_tx_status {
5685 const u8 *dst;
5686 const u8 *data;
5687 int data_len;
5688 int ack;
5689 } eapol_tx_status;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005690
5691 /**
5692 * struct ch_switch
5693 * @freq: Frequency of new channel in MHz
5694 * @ht_enabled: Whether this is an HT channel
5695 * @ch_offset: Secondary channel offset
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08005696 * @ch_width: Channel width
5697 * @cf1: Center frequency 1
5698 * @cf2: Center frequency 2
Dmitry Shmidt04949592012-07-19 12:16:46 -07005699 */
5700 struct ch_switch {
5701 int freq;
5702 int ht_enabled;
5703 int ch_offset;
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08005704 enum chan_width ch_width;
5705 int cf1;
5706 int cf2;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005707 } ch_switch;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08005708
5709 /**
5710 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
5711 * @addr: Remote client address
5712 * @code: Reason code for connection failure
5713 */
5714 struct connect_failed_reason {
5715 u8 addr[ETH_ALEN];
5716 enum {
5717 MAX_CLIENT_REACHED,
5718 BLOCKED_CLIENT
5719 } code;
5720 } connect_failed_reason;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005721
5722 /**
5723 * struct dfs_event - Data for radar detected events
5724 * @freq: Frequency of the channel in MHz
5725 */
5726 struct dfs_event {
5727 int freq;
Dmitry Shmidt051af732013-10-22 13:52:46 -07005728 int ht_enabled;
5729 int chan_offset;
5730 enum chan_width chan_width;
5731 int cf1;
5732 int cf2;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005733 } dfs_event;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005734
5735 /**
5736 * survey_results - Survey result data for EVENT_SURVEY
5737 * @freq_filter: Requested frequency survey filter, 0 if request
5738 * was for all survey data
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005739 * @survey_list: Linked list of survey data (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005740 */
5741 struct survey_results {
5742 unsigned int freq_filter;
5743 struct dl_list survey_list; /* struct freq_survey */
5744 } survey_results;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005745
5746 /**
5747 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
5748 * @initiator: Initiator of the regulatory change
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07005749 * @type: Regulatory change type
5750 * @alpha2: Country code (or "" if not available)
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005751 */
5752 struct channel_list_changed {
5753 enum reg_change_initiator initiator;
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07005754 enum reg_type type;
5755 char alpha2[3];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005756 } channel_list_changed;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08005757
5758 /**
5759 * freq_range - List of frequency ranges
5760 *
5761 * This is used as the data with EVENT_AVOID_FREQUENCIES.
5762 */
5763 struct wpa_freq_range_list freq_range;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005764
5765 /**
5766 * struct mesh_peer
5767 *
5768 * @peer: Peer address
5769 * @ies: Beacon IEs
5770 * @ie_len: Length of @ies
5771 *
5772 * Notification of new candidate mesh peer.
5773 */
5774 struct mesh_peer {
5775 const u8 *peer;
5776 const u8 *ies;
5777 size_t ie_len;
5778 } mesh_peer;
5779
5780 /**
5781 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08005782 * @pri_freq: Selected primary frequency
5783 * @sec_freq: Selected secondary frequency
Hai Shalomfdcde762020-04-02 11:19:20 -07005784 * @edmg_channel: Selected EDMG channel
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005785 * @vht_seg0_center_ch: VHT mode Segment0 center channel
Hai Shalomfdcde762020-04-02 11:19:20 -07005786 * The value is the index of the channel center frequency for
5787 * 20 MHz, 40 MHz, and 80 MHz channels. The value is the center
5788 * frequency index of the primary 80 MHz segment for 160 MHz and
5789 * 80+80 MHz channels.
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005790 * @vht_seg1_center_ch: VHT mode Segment1 center channel
Hai Shalomfdcde762020-04-02 11:19:20 -07005791 * The value is zero for 20 MHz, 40 MHz, and 80 MHz channels. The
5792 * value is the index of the channel center frequency for 160 MHz
5793 * channels and the center frequency index of the secondary 80 MHz
5794 * segment for 80+80 MHz channels.
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005795 * @ch_width: Selected Channel width by driver. Driver may choose to
5796 * change hostapd configured ACS channel width due driver internal
5797 * channel restrictions.
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07005798 * hw_mode: Selected band (used with hw_mode=any)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005799 */
5800 struct acs_selected_channels {
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08005801 unsigned int pri_freq;
5802 unsigned int sec_freq;
Hai Shalomfdcde762020-04-02 11:19:20 -07005803 u8 edmg_channel;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005804 u8 vht_seg0_center_ch;
5805 u8 vht_seg1_center_ch;
5806 u16 ch_width;
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07005807 enum hostapd_hw_mode hw_mode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005808 } acs_selected_channels;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005809
5810 /**
5811 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
5812 * @reason_code: Reason for stopping offload
5813 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
5814 * scheduled.
5815 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
5816 * be stopped.
5817 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
5818 * parameters.
5819 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
5820 * supported by device.
5821 */
5822 struct p2p_lo_stop {
5823 enum {
5824 P2P_LO_STOPPED_REASON_COMPLETE = 0,
5825 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
5826 P2P_LO_STOPPED_REASON_INVALID_PARAM,
5827 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
5828 } reason_code;
5829 } p2p_lo_stop;
Roshan Pius3a1667e2018-07-03 15:17:14 -07005830
5831 /* For EVENT_EXTERNAL_AUTH */
5832 struct external_auth external_auth;
5833
5834 /**
5835 * struct sta_opmode - Station's operation mode change event
5836 * @addr: The station MAC address
5837 * @smps_mode: SMPS mode of the station
5838 * @chan_width: Channel width of the station
5839 * @rx_nss: RX_NSS of the station
5840 *
5841 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
5842 */
5843 struct sta_opmode {
5844 const u8 *addr;
5845 enum smps_mode smps_mode;
5846 enum chan_width chan_width;
5847 u8 rx_nss;
5848 } sta_opmode;
5849
5850 /**
5851 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
5852 */
5853 struct wds_sta_interface {
5854 const u8 *sta_addr;
5855 const char *ifname;
5856 enum {
5857 INTERFACE_ADDED,
5858 INTERFACE_REMOVED
5859 } istatus;
5860 } wds_sta_interface;
Hai Shalom81f62d82019-07-22 12:10:00 -07005861
5862 /**
5863 * struct update_dh - Data for EVENT_UPDATE_DH
5864 */
5865 struct update_dh {
5866 const u8 *peer;
5867 const u8 *ie;
5868 size_t ie_len;
5869 } update_dh;
Hai Shalomfdcde762020-04-02 11:19:20 -07005870
5871 /**
5872 * struct unprot_beacon - Data for EVENT_UNPROT_BEACON
5873 */
5874 struct unprot_beacon {
5875 const u8 *sa;
5876 } unprot_beacon;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005877};
5878
5879/**
5880 * wpa_supplicant_event - Report a driver event for wpa_supplicant
5881 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5882 * with struct wpa_driver_ops::init()
5883 * @event: event type (defined above)
5884 * @data: possible extra data for the event
5885 *
5886 * Driver wrapper code should call this function whenever an event is received
5887 * from the driver.
5888 */
5889void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
5890 union wpa_event_data *data);
5891
Dmitry Shmidte4663042016-04-04 10:07:49 -07005892/**
5893 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
5894 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5895 * with struct wpa_driver_ops::init()
5896 * @event: event type (defined above)
5897 * @data: possible extra data for the event
5898 *
5899 * Same as wpa_supplicant_event(), but we search for the interface in
5900 * wpa_global.
5901 */
5902void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
5903 union wpa_event_data *data);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005904
5905/*
5906 * The following inline functions are provided for convenience to simplify
5907 * event indication for some of the common events.
5908 */
5909
5910static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
5911 size_t ielen, int reassoc)
5912{
5913 union wpa_event_data event;
5914 os_memset(&event, 0, sizeof(event));
5915 event.assoc_info.reassoc = reassoc;
5916 event.assoc_info.req_ies = ie;
5917 event.assoc_info.req_ies_len = ielen;
5918 event.assoc_info.addr = addr;
5919 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
5920}
5921
5922static inline void drv_event_disassoc(void *ctx, const u8 *addr)
5923{
5924 union wpa_event_data event;
5925 os_memset(&event, 0, sizeof(event));
5926 event.disassoc_info.addr = addr;
5927 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
5928}
5929
5930static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
5931 size_t data_len)
5932{
5933 union wpa_event_data event;
5934 os_memset(&event, 0, sizeof(event));
5935 event.eapol_rx.src = src;
5936 event.eapol_rx.data = data;
5937 event.eapol_rx.data_len = data_len;
5938 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
5939}
5940
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005941/* driver_common.c */
5942void wpa_scan_results_free(struct wpa_scan_results *res);
5943
5944/* Convert wpa_event_type to a string for logging */
5945const char * event_to_string(enum wpa_event_type event);
5946
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07005947/* Convert chan_width to a string for logging and control interfaces */
5948const char * channel_width_to_string(enum chan_width width);
5949
Hai Shalom74f70d42019-02-11 14:42:39 -08005950int channel_width_to_int(enum chan_width width);
5951
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005952int ht_supported(const struct hostapd_hw_modes *mode);
5953int vht_supported(const struct hostapd_hw_modes *mode);
5954
5955struct wowlan_triggers *
5956wpa_get_wowlan_triggers(const char *wowlan_triggers,
5957 const struct wpa_driver_capa *capa);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005958/* Convert driver flag to string */
5959const char * driver_flag_to_string(u64 flag);
Hai Shalomb755a2a2020-04-23 21:49:02 -07005960const char * driver_flag2_to_string(u64 flag2);
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005961
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005962/* NULL terminated array of linked in driver wrappers */
Dmitry Shmidt1d755d02015-04-28 10:34:29 -07005963extern const struct wpa_driver_ops *const wpa_drivers[];
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005964
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07005965
5966/* Available drivers */
5967
5968#ifdef CONFIG_DRIVER_WEXT
5969extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
5970#endif /* CONFIG_DRIVER_WEXT */
5971#ifdef CONFIG_DRIVER_NL80211
5972/* driver_nl80211.c */
5973extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
5974#endif /* CONFIG_DRIVER_NL80211 */
5975#ifdef CONFIG_DRIVER_HOSTAP
5976extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
5977#endif /* CONFIG_DRIVER_HOSTAP */
5978#ifdef CONFIG_DRIVER_BSD
5979extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
5980#endif /* CONFIG_DRIVER_BSD */
5981#ifdef CONFIG_DRIVER_OPENBSD
5982/* driver_openbsd.c */
5983extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
5984#endif /* CONFIG_DRIVER_OPENBSD */
5985#ifdef CONFIG_DRIVER_NDIS
5986extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
5987#endif /* CONFIG_DRIVER_NDIS */
5988#ifdef CONFIG_DRIVER_WIRED
5989extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
5990#endif /* CONFIG_DRIVER_WIRED */
5991#ifdef CONFIG_DRIVER_MACSEC_QCA
5992/* driver_macsec_qca.c */
5993extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
5994#endif /* CONFIG_DRIVER_MACSEC_QCA */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08005995#ifdef CONFIG_DRIVER_MACSEC_LINUX
5996/* driver_macsec_linux.c */
5997extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops;
5998#endif /* CONFIG_DRIVER_MACSEC_LINUX */
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07005999#ifdef CONFIG_DRIVER_ROBOSWITCH
6000/* driver_roboswitch.c */
6001extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
6002#endif /* CONFIG_DRIVER_ROBOSWITCH */
6003#ifdef CONFIG_DRIVER_ATHEROS
6004/* driver_atheros.c */
6005extern const struct wpa_driver_ops wpa_driver_atheros_ops;
6006#endif /* CONFIG_DRIVER_ATHEROS */
6007#ifdef CONFIG_DRIVER_NONE
6008extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
6009#endif /* CONFIG_DRIVER_NONE */
6010
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006011#endif /* DRIVER_H */