blob: 032bbd8921966240c498da6376e8b2ac6b5b48a6 [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];
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800200};
201
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800202#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -0700203#define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800204
Hai Shalom81f62d82019-07-22 12:10:00 -0700205
206enum ieee80211_op_mode {
207 IEEE80211_MODE_INFRA = 0,
208 IEEE80211_MODE_IBSS = 1,
209 IEEE80211_MODE_AP = 2,
210 IEEE80211_MODE_MESH = 5,
211
212 /* only add new entries before IEEE80211_MODE_NUM */
213 IEEE80211_MODE_NUM
214};
215
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700216/**
Hai Shalomc3565922019-10-28 11:58:20 -0700217 * struct ieee80211_edmg_config - EDMG configuration
218 *
219 * This structure describes most essential parameters needed
220 * for IEEE 802.11ay EDMG configuration
221 *
222 * @channels: Bitmap that indicates the 2.16 GHz channel(s)
223 * that are allowed to be used for transmissions.
224 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
225 * Set to 0 to indicate EDMG not supported.
226 * @bw_config: Channel BW Configuration subfield encodes
227 * the allowed channel bandwidth configurations
228 */
229struct ieee80211_edmg_config {
230 u8 channels;
231 enum edmg_bw_config bw_config;
232};
233
234/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700235 * struct hostapd_hw_modes - Supported hardware mode information
236 */
237struct hostapd_hw_modes {
238 /**
239 * mode - Hardware mode
240 */
241 enum hostapd_hw_mode mode;
242
243 /**
244 * num_channels - Number of entries in the channels array
245 */
246 int num_channels;
247
248 /**
249 * channels - Array of supported channels
250 */
251 struct hostapd_channel_data *channels;
252
253 /**
254 * num_rates - Number of entries in the rates array
255 */
256 int num_rates;
257
258 /**
259 * rates - Array of supported rates in 100 kbps units
260 */
261 int *rates;
262
263 /**
264 * ht_capab - HT (IEEE 802.11n) capabilities
265 */
266 u16 ht_capab;
267
268 /**
269 * mcs_set - MCS (IEEE 802.11n) rate parameters
270 */
271 u8 mcs_set[16];
272
273 /**
274 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
275 */
276 u8 a_mpdu_params;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800277
Dmitry Shmidt04949592012-07-19 12:16:46 -0700278 /**
279 * vht_capab - VHT (IEEE 802.11ac) capabilities
280 */
281 u32 vht_capab;
282
283 /**
284 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
285 */
286 u8 vht_mcs_set[8];
287
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800288 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800289
290 /**
291 * he_capab - HE (IEEE 802.11ax) capabilities
292 */
Hai Shalom81f62d82019-07-22 12:10:00 -0700293 struct he_capabilities he_capab[IEEE80211_MODE_NUM];
Hai Shalomc3565922019-10-28 11:58:20 -0700294
295 /**
296 * This structure describes the most essential parameters needed
297 * for IEEE 802.11ay EDMG configuration.
298 */
299 struct ieee80211_edmg_config edmg;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700300};
301
302
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700303#define IEEE80211_CAP_ESS 0x0001
304#define IEEE80211_CAP_IBSS 0x0002
305#define IEEE80211_CAP_PRIVACY 0x0010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800306#define IEEE80211_CAP_RRM 0x1000
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700307
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800308/* DMG (60 GHz) IEEE 802.11ad */
309/* type - bits 0..1 */
310#define IEEE80211_CAP_DMG_MASK 0x0003
311#define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
312#define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
313#define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
314
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700315#define WPA_SCAN_QUAL_INVALID BIT(0)
316#define WPA_SCAN_NOISE_INVALID BIT(1)
317#define WPA_SCAN_LEVEL_INVALID BIT(2)
318#define WPA_SCAN_LEVEL_DBM BIT(3)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700319#define WPA_SCAN_ASSOCIATED BIT(5)
320
321/**
322 * struct wpa_scan_res - Scan result for an BSS/IBSS
323 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
324 * @bssid: BSSID
325 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
326 * @beacon_int: beacon interval in TUs (host byte order)
327 * @caps: capability information field in host byte order
328 * @qual: signal quality
329 * @noise: noise level
330 * @level: signal level
331 * @tsf: Timestamp
332 * @age: Age of the information in milliseconds (i.e., how many milliseconds
333 * ago the last Beacon or Probe Response frame was received)
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800334 * @est_throughput: Estimated throughput in kbps (this is calculated during
335 * scan result processing if left zero by the driver wrapper)
336 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
Dmitry Shmidt29333592017-01-09 12:27:11 -0800337 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
338 * of TSF of the BSS specified by %tsf_bssid.
339 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700340 * @ie_len: length of the following IE field in octets
341 * @beacon_ie_len: length of the following Beacon IE field in octets
342 *
343 * This structure is used as a generic format for scan results from the
344 * driver. Each driver interface implementation is responsible for converting
345 * the driver or OS specific scan results into this format.
346 *
347 * If the driver does not support reporting all IEs, the IE data structure is
348 * constructed of the IEs that are available. This field will also need to
349 * include SSID in IE format. All drivers are encouraged to be extended to
350 * report all IEs to make it easier to support future additions.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800351 *
352 * This structure data is followed by ie_len octets of IEs from Probe Response
353 * frame (or if the driver does not indicate source of IEs, these may also be
354 * from Beacon frame). After the first set of IEs, another set of IEs may follow
355 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700356 */
357struct wpa_scan_res {
358 unsigned int flags;
359 u8 bssid[ETH_ALEN];
360 int freq;
361 u16 beacon_int;
362 u16 caps;
363 int qual;
364 int noise;
365 int level;
366 u64 tsf;
367 unsigned int age;
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800368 unsigned int est_throughput;
369 int snr;
Dmitry Shmidt29333592017-01-09 12:27:11 -0800370 u64 parent_tsf;
371 u8 tsf_bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700372 size_t ie_len;
373 size_t beacon_ie_len;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800374 /* Followed by ie_len + beacon_ie_len octets of IE data */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700375};
376
377/**
378 * struct wpa_scan_results - Scan results
379 * @res: Array of pointers to allocated variable length scan result entries
380 * @num: Number of entries in the scan result array
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800381 * @fetch_time: Time when the results were fetched from the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700382 */
383struct wpa_scan_results {
384 struct wpa_scan_res **res;
385 size_t num;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800386 struct os_reltime fetch_time;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700387};
388
389/**
390 * struct wpa_interface_info - Network interface information
391 * @next: Pointer to the next interface or NULL if this is the last one
392 * @ifname: Interface name that can be used with init() or init2()
393 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
394 * not available
395 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
396 * is not an allocated copy, i.e., get_interfaces() caller will not free
397 * this)
398 */
399struct wpa_interface_info {
400 struct wpa_interface_info *next;
401 char *ifname;
402 char *desc;
403 const char *drv_name;
404};
405
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800406#define WPAS_MAX_SCAN_SSIDS 16
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700407
408/**
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800409 * struct wpa_driver_scan_ssid - SSIDs to scan for
410 * @ssid - specific SSID to scan for (ProbeReq)
411 * %NULL or zero-length SSID is used to indicate active scan
412 * with wildcard SSID.
413 * @ssid_len - Length of the SSID in octets
414 */
415struct wpa_driver_scan_ssid {
416 const u8 *ssid;
417 size_t ssid_len;
418};
419
420/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700421 * struct wpa_driver_scan_params - Scan parameters
422 * Data for struct wpa_driver_ops::scan2().
423 */
424struct wpa_driver_scan_params {
425 /**
426 * ssids - SSIDs to scan for
427 */
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800428 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700429
430 /**
431 * num_ssids - Number of entries in ssids array
432 * Zero indicates a request for a passive scan.
433 */
434 size_t num_ssids;
435
436 /**
437 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
438 */
439 const u8 *extra_ies;
440
441 /**
442 * extra_ies_len - Length of extra_ies in octets
443 */
444 size_t extra_ies_len;
445
446 /**
447 * freqs - Array of frequencies to scan or %NULL for all frequencies
448 *
449 * The frequency is set in MHz. The array is zero-terminated.
450 */
451 int *freqs;
452
453 /**
454 * filter_ssids - Filter for reporting SSIDs
455 *
456 * This optional parameter can be used to request the driver wrapper to
457 * filter scan results to include only the specified SSIDs. %NULL
458 * indicates that no filtering is to be done. This can be used to
459 * reduce memory needs for scan results in environments that have large
460 * number of APs with different SSIDs.
461 *
462 * The driver wrapper is allowed to take this allocated buffer into its
463 * own use by setting the pointer to %NULL. In that case, the driver
464 * wrapper is responsible for freeing the buffer with os_free() once it
465 * is not needed anymore.
466 */
467 struct wpa_driver_scan_filter {
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -0700468 u8 ssid[SSID_MAX_LEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700469 size_t ssid_len;
470 } *filter_ssids;
471
472 /**
473 * num_filter_ssids - Number of entries in filter_ssids array
474 */
475 size_t num_filter_ssids;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800476
477 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700478 * filter_rssi - Filter by RSSI
479 *
480 * The driver may filter scan results in firmware to reduce host
481 * wakeups and thereby save power. Specify the RSSI threshold in s32
482 * dBm.
483 */
484 s32 filter_rssi;
485
486 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800487 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
488 *
489 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
490 * Mbps from the support rates element(s) in the Probe Request frames
491 * and not to transmit the frames at any of those rates.
492 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700493 unsigned int p2p_probe:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800494
495 /**
496 * only_new_results - Request driver to report only new results
497 *
498 * This is used to request the driver to report only BSSes that have
499 * been detected after this scan request has been started, i.e., to
500 * flush old cached BSS entries.
501 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700502 unsigned int only_new_results:1;
503
504 /**
505 * low_priority - Requests driver to use a lower scan priority
506 *
507 * This is used to request the driver to use a lower scan priority
508 * if it supports such a thing.
509 */
510 unsigned int low_priority:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800511
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800512 /**
513 * mac_addr_rand - Requests driver to randomize MAC address
514 */
515 unsigned int mac_addr_rand:1;
516
517 /**
518 * mac_addr - MAC address used with randomization. The address cannot be
519 * a multicast one, i.e., bit 0 of byte 0 should not be set.
520 */
Hai Shalomc3565922019-10-28 11:58:20 -0700521 u8 *mac_addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800522
523 /**
524 * mac_addr_mask - MAC address mask used with randomization.
525 *
526 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
527 * the mask should be taken as is from mac_addr. The mask should not
528 * allow the generation of a multicast address, i.e., bit 0 of byte 0
529 * must be set.
530 */
531 const u8 *mac_addr_mask;
532
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800533 /**
534 * sched_scan_plans - Scan plans for scheduled scan
535 *
536 * Each scan plan consists of the number of iterations to scan and the
537 * interval between scans. When a scan plan finishes (i.e., it was run
538 * for the specified number of iterations), the next scan plan is
539 * executed. The scan plans are executed in the order they appear in
540 * the array (lower index first). The last scan plan will run infinitely
541 * (until requested to stop), thus must not specify the number of
542 * iterations. All other scan plans must specify the number of
543 * iterations.
544 */
545 struct sched_scan_plan {
546 u32 interval; /* In seconds */
547 u32 iterations; /* Zero to run infinitely */
548 } *sched_scan_plans;
549
550 /**
551 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
552 */
553 unsigned int sched_scan_plans_num;
554
Dmitry Shmidt9c175262016-03-03 10:20:07 -0800555 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700556 * sched_scan_start_delay - Delay to use before starting the first scan
557 *
558 * Delay (in seconds) before scheduling first scan plan cycle. The
559 * driver may ignore this parameter and start immediately (or at any
560 * other time), if this feature is not supported.
561 */
562 u32 sched_scan_start_delay;
563
564 /**
Dmitry Shmidt9c175262016-03-03 10:20:07 -0800565 * bssid - Specific BSSID to scan for
566 *
567 * This optional parameter can be used to replace the default wildcard
568 * BSSID with a specific BSSID to scan for if results are needed from
569 * only a single BSS.
570 */
571 const u8 *bssid;
572
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800573 /**
574 * scan_cookie - Unique identification representing the scan request
575 *
576 * This scan_cookie carries a unique identification representing the
577 * scan request if the host driver/kernel supports concurrent scan
578 * requests. This cookie is returned from the corresponding driver
579 * interface.
580 *
581 * Note: Unlike other parameters in this structure, scan_cookie is used
582 * only to return information instead of setting parameters for the
583 * scan.
584 */
585 u64 scan_cookie;
586
Dmitry Shmidt29333592017-01-09 12:27:11 -0800587 /**
588 * duration - Dwell time on each channel
589 *
590 * This optional parameter can be used to set the dwell time on each
591 * channel. In TUs.
592 */
593 u16 duration;
594
595 /**
596 * duration_mandatory - Whether the specified duration is mandatory
597 *
598 * If this is set, the duration specified by the %duration field is
599 * mandatory (and the driver should reject the scan request if it is
600 * unable to comply with the specified duration), otherwise it is the
601 * maximum duration and the actual duration may be shorter.
602 */
603 unsigned int duration_mandatory:1;
604
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800605 /**
606 * relative_rssi_set - Whether relative RSSI parameters are set
607 */
608 unsigned int relative_rssi_set:1;
609
610 /**
611 * relative_rssi - Relative RSSI for reporting better BSSs
612 *
613 * Amount of RSSI by which a BSS should be better than the current
614 * connected BSS to report the new BSS to user space.
615 */
616 s8 relative_rssi;
617
618 /**
619 * relative_adjust_band - Band to which RSSI should be adjusted
620 *
621 * The relative_adjust_rssi should be added to the band specified
622 * by relative_adjust_band.
623 */
624 enum set_band relative_adjust_band;
625
626 /**
627 * relative_adjust_rssi - RSSI to be added to relative_adjust_band
628 *
629 * An amount of relative_band_rssi should be added to the BSSs that
630 * belong to the band specified by relative_adjust_band while comparing
631 * with other bands for BSS reporting.
632 */
633 s8 relative_adjust_rssi;
634
Hai Shalomce48b4a2018-09-05 11:41:35 -0700635 /**
636 * oce_scan
637 *
638 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0)
639 * - Accept broadcast Probe Response frame.
640 * - Probe Request frame deferral and suppression.
641 * - Max Channel Time - driver fills FILS request params IE with
642 * Maximum Channel Time.
643 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps.
644 */
645 unsigned int oce_scan:1;
646
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800647 /*
648 * NOTE: Whenever adding new parameters here, please make sure
649 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
650 * matching changes.
651 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700652};
653
654/**
655 * struct wpa_driver_auth_params - Authentication parameters
656 * Data for struct wpa_driver_ops::authenticate().
657 */
658struct wpa_driver_auth_params {
659 int freq;
660 const u8 *bssid;
661 const u8 *ssid;
662 size_t ssid_len;
663 int auth_alg;
664 const u8 *ie;
665 size_t ie_len;
666 const u8 *wep_key[4];
667 size_t wep_key_len[4];
668 int wep_tx_keyidx;
669 int local_state_change;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800670
671 /**
672 * p2p - Whether this connection is a P2P group
673 */
674 int p2p;
675
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800676 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800677 * auth_data - Additional elements for Authentication frame
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800678 *
679 * This buffer starts with the Authentication transaction sequence
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800680 * number field. If no special handling of such elements is needed, this
681 * pointer is %NULL. This is used with SAE and FILS.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800682 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800683 const u8 *auth_data;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800684
685 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800686 * auth_data_len - Length of auth_data buffer in octets
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800687 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800688 size_t auth_data_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700689};
690
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800691/**
692 * enum wps_mode - WPS mode
693 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700694enum wps_mode {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800695 /**
696 * WPS_MODE_NONE - No WPS provisioning being used
697 */
698 WPS_MODE_NONE,
699
700 /**
701 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
702 */
703 WPS_MODE_OPEN,
704
705 /**
706 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
707 */
708 WPS_MODE_PRIVACY
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700709};
710
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800711/**
712 * struct hostapd_freq_params - Channel parameters
713 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700714struct hostapd_freq_params {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800715 /**
716 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
717 */
718 enum hostapd_hw_mode mode;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700719
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800720 /**
721 * freq - Primary channel center frequency in MHz
722 */
723 int freq;
724
725 /**
726 * channel - Channel number
727 */
728 int channel;
729
730 /**
731 * ht_enabled - Whether HT is enabled
732 */
733 int ht_enabled;
734
735 /**
736 * sec_channel_offset - Secondary channel offset for HT40
737 *
738 * 0 = HT40 disabled,
739 * -1 = HT40 enabled, secondary channel below primary,
740 * 1 = HT40 enabled, secondary channel above primary
741 */
742 int sec_channel_offset;
743
744 /**
745 * vht_enabled - Whether VHT is enabled
746 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700747 int vht_enabled;
748
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800749 /**
Hai Shalom81f62d82019-07-22 12:10:00 -0700750 * he_enabled - Whether HE is enabled
751 */
752 int he_enabled;
753
754 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800755 * center_freq1 - Segment 0 center frequency in MHz
756 *
757 * Valid for both HT and VHT.
758 */
759 int center_freq1;
760
761 /**
762 * center_freq2 - Segment 1 center frequency in MHz
763 *
764 * Non-zero only for bandwidth 80 and an 80+80 channel
765 */
766 int center_freq2;
767
768 /**
769 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
770 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700771 int bandwidth;
Hai Shalomc3565922019-10-28 11:58:20 -0700772
773 /**
774 * This structure describes the most essential parameters needed
775 * for IEEE 802.11ay EDMG configuration.
776 */
777 struct ieee80211_edmg_config edmg;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700778};
779
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700780/**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700781 * struct wpa_driver_sta_auth_params - Authentication parameters
782 * Data for struct wpa_driver_ops::sta_auth().
783 */
784struct wpa_driver_sta_auth_params {
785
786 /**
787 * own_addr - Source address and BSSID for authentication frame
788 */
789 const u8 *own_addr;
790
791 /**
792 * addr - MAC address of the station to associate
793 */
794 const u8 *addr;
795
796 /**
797 * seq - authentication sequence number
798 */
799 u16 seq;
800
801 /**
802 * status - authentication response status code
803 */
804 u16 status;
805
806 /**
807 * ie - authentication frame ie buffer
808 */
809 const u8 *ie;
810
811 /**
812 * len - ie buffer length
813 */
814 size_t len;
815
816 /**
817 * fils_auth - Indicates whether FILS authentication is being performed
818 */
819 int fils_auth;
820
821 /**
822 * fils_anonce - ANonce (required for FILS)
823 */
824 u8 fils_anonce[WPA_NONCE_LEN];
825
826 /**
827 * fils_snonce - SNonce (required for FILS)
828 */
829 u8 fils_snonce[WPA_NONCE_LEN];
830
831 /**
832 * fils_kek - key for encryption (required for FILS)
833 */
834 u8 fils_kek[WPA_KEK_MAX_LEN];
835
836 /**
837 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
838 */
839 size_t fils_kek_len;
840};
841
842/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700843 * struct wpa_driver_associate_params - Association parameters
844 * Data for struct wpa_driver_ops::associate().
845 */
846struct wpa_driver_associate_params {
847 /**
848 * bssid - BSSID of the selected AP
849 * This can be %NULL, if ap_scan=2 mode is used and the driver is
850 * responsible for selecting with which BSS to associate. */
851 const u8 *bssid;
852
853 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800854 * bssid_hint - BSSID of a proposed AP
855 *
856 * This indicates which BSS has been found a suitable candidate for
857 * initial association for drivers that use driver/firmwate-based BSS
858 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
859 * the driver from selecting other BSSes in the ESS.
860 */
861 const u8 *bssid_hint;
862
863 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700864 * ssid - The selected SSID
865 */
866 const u8 *ssid;
867
868 /**
869 * ssid_len - Length of the SSID (1..32)
870 */
871 size_t ssid_len;
872
873 /**
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700874 * freq - channel parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700875 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700876 struct hostapd_freq_params freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700877
878 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800879 * freq_hint - Frequency of the channel the proposed AP is using
880 *
881 * This provides a channel on which a suitable BSS has been found as a
882 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
883 * limit the driver from selecting other channels for
884 * driver/firmware-based BSS selection.
885 */
886 int freq_hint;
887
888 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700889 * bg_scan_period - Background scan period in seconds, 0 to disable
890 * background scan, or -1 to indicate no change to default driver
891 * configuration
892 */
893 int bg_scan_period;
894
895 /**
Dmitry Shmidt2ac5f602014-03-07 10:08:21 -0800896 * beacon_int - Beacon interval for IBSS or 0 to use driver default
897 */
898 int beacon_int;
899
900 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700901 * wpa_ie - WPA information element for (Re)Association Request
902 * WPA information element to be included in (Re)Association
903 * Request (including information element id and length). Use
904 * of this WPA IE is optional. If the driver generates the WPA
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700905 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700906 * key_mgmt_suite to select proper algorithms. In this case,
907 * the driver has to notify wpa_supplicant about the used WPA
908 * IE by generating an event that the interface code will
909 * convert into EVENT_ASSOCINFO data (see below).
910 *
911 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
912 * instead. The driver can determine which version is used by
913 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
914 * WPA2/RSN).
915 *
916 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
917 */
918 const u8 *wpa_ie;
919
920 /**
921 * wpa_ie_len - length of the wpa_ie
922 */
923 size_t wpa_ie_len;
924
925 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800926 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
927 */
928 unsigned int wpa_proto;
929
930 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800931 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700932 *
933 * This is usually ignored if @wpa_ie is used.
934 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800935 unsigned int pairwise_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700936
937 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800938 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700939 *
940 * This is usually ignored if @wpa_ie is used.
941 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800942 unsigned int group_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700943
944 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700945 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
946 *
947 * This is usually ignored if @wpa_ie is used.
948 */
949 unsigned int mgmt_group_suite;
950
951 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800952 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700953 *
954 * This is usually ignored if @wpa_ie is used.
955 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800956 unsigned int key_mgmt_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700957
958 /**
959 * auth_alg - Allowed authentication algorithms
960 * Bit field of WPA_AUTH_ALG_*
961 */
962 int auth_alg;
963
964 /**
965 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
966 */
967 int mode;
968
969 /**
970 * wep_key - WEP keys for static WEP configuration
971 */
972 const u8 *wep_key[4];
973
974 /**
975 * wep_key_len - WEP key length for static WEP configuration
976 */
977 size_t wep_key_len[4];
978
979 /**
980 * wep_tx_keyidx - WEP TX key index for static WEP configuration
981 */
982 int wep_tx_keyidx;
983
984 /**
985 * mgmt_frame_protection - IEEE 802.11w management frame protection
986 */
987 enum mfp_options mgmt_frame_protection;
988
989 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700990 * passphrase - RSN passphrase for PSK
991 *
992 * This value is made available only for WPA/WPA2-Personal (PSK) and
Hai Shalom74f70d42019-02-11 14:42:39 -0800993 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
994 * is the 8..63 character ASCII passphrase, if available. Please note
995 * that this can be %NULL if passphrase was not used to generate the
996 * PSK. In that case, the psk field must be used to fetch the PSK.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700997 */
998 const char *passphrase;
999
1000 /**
1001 * psk - RSN PSK (alternative for passphrase for PSK)
1002 *
1003 * This value is made available only for WPA/WPA2-Personal (PSK) and
Hai Shalom74f70d42019-02-11 14:42:39 -08001004 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
1005 * is the 32-octet (256-bit) PSK, if available. The driver wrapper
1006 * should be prepared to handle %NULL value as an error.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001007 */
1008 const u8 *psk;
1009
1010 /**
1011 * drop_unencrypted - Enable/disable unencrypted frame filtering
1012 *
1013 * Configure the driver to drop all non-EAPOL frames (both receive and
1014 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
1015 * still be allowed for key negotiation.
1016 */
1017 int drop_unencrypted;
1018
1019 /**
1020 * prev_bssid - Previously used BSSID in this ESS
1021 *
1022 * When not %NULL, this is a request to use reassociation instead of
1023 * association.
1024 */
1025 const u8 *prev_bssid;
1026
1027 /**
1028 * wps - WPS mode
1029 *
1030 * If the driver needs to do special configuration for WPS association,
1031 * this variable provides more information on what type of association
1032 * is being requested. Most drivers should not need ot use this.
1033 */
1034 enum wps_mode wps;
1035
1036 /**
1037 * p2p - Whether this connection is a P2P group
1038 */
1039 int p2p;
1040
1041 /**
1042 * uapsd - UAPSD parameters for the network
1043 * -1 = do not change defaults
1044 * AP mode: 1 = enabled, 0 = disabled
1045 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
1046 */
1047 int uapsd;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001048
1049 /**
1050 * fixed_bssid - Whether to force this BSSID in IBSS mode
1051 * 1 = Fix this BSSID and prevent merges.
1052 * 0 = Do not fix BSSID.
1053 */
1054 int fixed_bssid;
1055
1056 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001057 * fixed_freq - Fix control channel in IBSS mode
1058 * 0 = don't fix control channel (default)
1059 * 1 = fix control channel; this prevents IBSS merging with another
1060 * channel
1061 */
1062 int fixed_freq;
1063
1064 /**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001065 * disable_ht - Disable HT (IEEE 802.11n) for this connection
1066 */
1067 int disable_ht;
1068
1069 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001070 * htcaps - HT Capabilities over-rides
1071 *
1072 * Only bits set in the mask will be used, and not all values are used
1073 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
1074 *
1075 * Pointer to struct ieee80211_ht_capabilities.
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001076 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001077 const u8 *htcaps;
1078
1079 /**
1080 * htcaps_mask - HT Capabilities over-rides mask
1081 *
1082 * Pointer to struct ieee80211_ht_capabilities.
1083 */
1084 const u8 *htcaps_mask;
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001085
1086#ifdef CONFIG_VHT_OVERRIDES
1087 /**
1088 * disable_vht - Disable VHT for this connection
1089 */
1090 int disable_vht;
1091
1092 /**
1093 * VHT capability overrides.
1094 */
1095 const struct ieee80211_vht_capabilities *vhtcaps;
1096 const struct ieee80211_vht_capabilities *vhtcaps_mask;
1097#endif /* CONFIG_VHT_OVERRIDES */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001098
Hai Shalomfdcde762020-04-02 11:19:20 -07001099#ifdef CONFIG_HE_OVERRIDES
1100 /**
1101 * disable_he - Disable HE for this connection
1102 */
1103 int disable_he;
1104#endif /* CONFIG_HE_OVERRIDES */
1105
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001106 /**
1107 * req_key_mgmt_offload - Request key management offload for connection
1108 *
1109 * Request key management offload for this connection if the device
1110 * supports it.
1111 */
1112 int req_key_mgmt_offload;
1113
1114 /**
Hai Shalomc3565922019-10-28 11:58:20 -07001115 * req_handshake_offload - Request EAPOL handshake offload
1116 *
1117 * Request EAPOL handshake offload for this connection if the device
1118 * supports it.
1119 */
1120 int req_handshake_offload;
1121
1122 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001123 * Flag for indicating whether this association includes support for
1124 * RRM (Radio Resource Measurements)
1125 */
1126 int rrm_used;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001127
1128 /**
1129 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1130 * AP as usual. Valid for DMG network only.
1131 */
1132 int pbss;
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001133
1134 /**
1135 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1136 */
1137 const u8 *fils_kek;
1138
1139 /**
1140 * fils_kek_len: Length of fils_kek in bytes
1141 */
1142 size_t fils_kek_len;
1143
1144 /**
1145 * fils_nonces - Nonces for FILS association frame protection
1146 * (AES-SIV AAD)
1147 */
1148 const u8 *fils_nonces;
1149
1150 /**
1151 * fils_nonces_len: Length of fils_nonce in bytes
1152 */
1153 size_t fils_nonces_len;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001154
1155 /**
1156 * fils_erp_username - Username part of keyName-NAI
1157 */
1158 const u8 *fils_erp_username;
1159
1160 /**
1161 * fils_erp_username_len - Length of fils_erp_username in bytes
1162 */
1163 size_t fils_erp_username_len;
1164
1165 /**
1166 * fils_erp_realm - Realm/domain name to use in FILS ERP
1167 */
1168 const u8 *fils_erp_realm;
1169
1170 /**
1171 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1172 */
1173 size_t fils_erp_realm_len;
1174
1175 /**
1176 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1177 * messages
1178 */
1179 u16 fils_erp_next_seq_num;
1180
1181 /**
1182 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1183 * specified by fils_erp_username@fils_erp_realm.
1184 */
1185 const u8 *fils_erp_rrk;
1186
1187 /**
1188 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1189 */
1190 size_t fils_erp_rrk_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001191};
1192
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001193enum hide_ssid {
1194 NO_SSID_HIDING,
1195 HIDDEN_SSID_ZERO_LEN,
1196 HIDDEN_SSID_ZERO_CONTENTS
1197};
1198
Hai Shalom81f62d82019-07-22 12:10:00 -07001199enum ch_switch_state {
1200 CH_SW_STARTED,
1201 CH_SW_FINISHED
1202};
1203
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001204struct wowlan_triggers {
1205 u8 any;
1206 u8 disconnect;
1207 u8 magic_pkt;
1208 u8 gtk_rekey_failure;
1209 u8 eap_identity_req;
1210 u8 four_way_handshake;
1211 u8 rfkill_release;
1212};
1213
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001214struct wpa_driver_ap_params {
1215 /**
1216 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1217 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001218 u8 *head;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001219
1220 /**
1221 * head_len - Length of the head buffer in octets
1222 */
1223 size_t head_len;
1224
1225 /**
1226 * tail - Beacon tail following TIM IE
1227 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001228 u8 *tail;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001229
1230 /**
1231 * tail_len - Length of the tail buffer in octets
1232 */
1233 size_t tail_len;
1234
1235 /**
1236 * dtim_period - DTIM period
1237 */
1238 int dtim_period;
1239
1240 /**
1241 * beacon_int - Beacon interval
1242 */
1243 int beacon_int;
1244
1245 /**
1246 * basic_rates: -1 terminated array of basic rates in 100 kbps
1247 *
1248 * This parameter can be used to set a specific basic rate set for the
1249 * BSS. If %NULL, default basic rate set is used.
1250 */
1251 int *basic_rates;
1252
1253 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001254 * beacon_rate: Beacon frame data rate
1255 *
1256 * This parameter can be used to set a specific Beacon frame data rate
1257 * for the BSS. The interpretation of this value depends on the
1258 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS). If
1259 * beacon_rate == 0 and rate_type == 0 (BEACON_RATE_LEGACY), the default
1260 * Beacon frame data rate is used.
1261 */
1262 unsigned int beacon_rate;
1263
1264 /**
1265 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT)
1266 */
1267 enum beacon_rate_type rate_type;
1268
1269 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001270 * proberesp - Probe Response template
1271 *
1272 * This is used by drivers that reply to Probe Requests internally in
1273 * AP mode and require the full Probe Response template.
1274 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001275 u8 *proberesp;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001276
1277 /**
1278 * proberesp_len - Length of the proberesp buffer in octets
1279 */
1280 size_t proberesp_len;
1281
1282 /**
1283 * ssid - The SSID to use in Beacon/Probe Response frames
1284 */
1285 const u8 *ssid;
1286
1287 /**
1288 * ssid_len - Length of the SSID (1..32)
1289 */
1290 size_t ssid_len;
1291
1292 /**
1293 * hide_ssid - Whether to hide the SSID
1294 */
1295 enum hide_ssid hide_ssid;
1296
1297 /**
1298 * pairwise_ciphers - WPA_CIPHER_* bitfield
1299 */
1300 unsigned int pairwise_ciphers;
1301
1302 /**
1303 * group_cipher - WPA_CIPHER_*
1304 */
1305 unsigned int group_cipher;
1306
1307 /**
1308 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1309 */
1310 unsigned int key_mgmt_suites;
1311
1312 /**
1313 * auth_algs - WPA_AUTH_ALG_* bitfield
1314 */
1315 unsigned int auth_algs;
1316
1317 /**
1318 * wpa_version - WPA_PROTO_* bitfield
1319 */
1320 unsigned int wpa_version;
1321
1322 /**
1323 * privacy - Whether privacy is used in the BSS
1324 */
1325 int privacy;
1326
1327 /**
1328 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1329 *
1330 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1331 * not use the full Beacon template.
1332 */
1333 const struct wpabuf *beacon_ies;
1334
1335 /**
1336 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1337 *
1338 * This is used to add IEs like WPS IE and P2P IE by drivers that
1339 * reply to Probe Request frames internally.
1340 */
1341 const struct wpabuf *proberesp_ies;
1342
1343 /**
1344 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1345 *
1346 * This is used to add IEs like WPS IE by drivers that reply to
1347 * (Re)Association Request frames internally.
1348 */
1349 const struct wpabuf *assocresp_ies;
1350
1351 /**
1352 * isolate - Whether to isolate frames between associated stations
1353 *
1354 * If this is non-zero, the AP is requested to disable forwarding of
1355 * frames between associated stations.
1356 */
1357 int isolate;
1358
1359 /**
1360 * cts_protect - Whether CTS protection is enabled
1361 */
1362 int cts_protect;
1363
1364 /**
1365 * preamble - Whether short preamble is enabled
1366 */
1367 int preamble;
1368
1369 /**
1370 * short_slot_time - Whether short slot time is enabled
1371 *
1372 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1373 * not set (e.g., when 802.11g mode is not in use)
1374 */
1375 int short_slot_time;
1376
1377 /**
1378 * ht_opmode - HT operation mode or -1 if HT not in use
1379 */
1380 int ht_opmode;
1381
1382 /**
1383 * interworking - Whether Interworking is enabled
1384 */
1385 int interworking;
1386
1387 /**
1388 * hessid - Homogeneous ESS identifier or %NULL if not set
1389 */
1390 const u8 *hessid;
1391
1392 /**
1393 * access_network_type - Access Network Type (0..15)
1394 *
1395 * This is used for filtering Probe Request frames when Interworking is
1396 * enabled.
1397 */
1398 u8 access_network_type;
Dmitry Shmidt04949592012-07-19 12:16:46 -07001399
1400 /**
1401 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1402 *
1403 * This is used by driver which advertises this capability.
1404 */
1405 int ap_max_inactivity;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001406
1407 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001408 * ctwindow - Client Traffic Window (in TUs)
1409 */
1410 u8 p2p_go_ctwindow;
1411
1412 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001413 * disable_dgaf - Whether group-addressed frames are disabled
1414 */
1415 int disable_dgaf;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001416
1417 /**
1418 * osen - Whether OSEN security is enabled
1419 */
1420 int osen;
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001421
1422 /**
1423 * freq - Channel parameters for dynamic bandwidth changes
1424 */
1425 struct hostapd_freq_params *freq;
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001426
1427 /**
1428 * reenable - Whether this is to re-enable beaconing
1429 */
1430 int reenable;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001431
1432 /**
1433 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1434 * infrastructure BSS. Valid only for DMG network.
1435 */
1436 int pbss;
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001437
1438 /**
1439 * multicast_to_unicast - Whether to use multicast_to_unicast
1440 *
1441 * If this is non-zero, the AP is requested to perform multicast to
1442 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1443 * 802.1Q). If enabled, such frames are to be sent to each station
1444 * separately, with the DA replaced by their own MAC address rather
1445 * than the group address.
1446 *
1447 * Note that this may break certain expectations of the receiver, such
1448 * as the ability to drop unicast IP packets received within multicast
1449 * L2 frames, or the ability to not send ICMP destination unreachable
1450 * messages for packets received in L2 multicast (which is required,
1451 * but the receiver can't tell the difference if this new option is
1452 * enabled.)
1453 *
1454 * This also doesn't implement the 802.11 DMS (directed multicast
1455 * service).
1456 */
1457 int multicast_to_unicast;
Hai Shalom74f70d42019-02-11 14:42:39 -08001458
1459 /**
1460 * ftm_responder - Whether FTM responder is enabled
1461 */
1462 int ftm_responder;
1463
1464 /**
1465 * lci - Binary data, the content of an LCI report IE with type 8 as
1466 * defined in IEEE Std 802.11-2016, 9.4.2.22.10
1467 */
1468 const struct wpabuf *lci;
1469
1470 /**
1471 * civic - Binary data, the content of a measurement report IE with
1472 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
1473 */
1474 const struct wpabuf *civic;
Hai Shalomc3565922019-10-28 11:58:20 -07001475
1476 /**
1477 * he_spr - Whether Spatial Reuse is enabled
1478 */
1479 int he_spr;
1480
1481 /**
1482 * he_spr_srg_obss_pd_min_offset - Minimum TX power offset
1483 */
1484 int he_spr_srg_obss_pd_min_offset;
1485
1486 /**
1487 * he_spr_srg_obss_pd_max_offset - Maximum TX power offset
1488 */
1489 int he_spr_srg_obss_pd_max_offset;
Hai Shalomfdcde762020-04-02 11:19:20 -07001490
1491 /**
1492 * he_bss_color - Whether the BSS Color is disabled
1493 */
1494 int he_bss_color_disabled;
1495
1496 /**
1497 * he_bss_color_partial - The BSS Color AID equation
1498 */
1499 int he_bss_color_partial;
1500
1501 /**
1502 * he_bss_color - The BSS Color of the AP
1503 */
1504 int he_bss_color;
1505
1506 /**
1507 * twt_responder - Whether Target Wait Time responder is enabled
1508 */
1509 int twt_responder;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001510};
1511
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001512struct wpa_driver_mesh_bss_params {
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001513#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1514#define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1515#define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1516#define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001517#define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001518 /*
1519 * TODO: Other mesh configuration parameters would go here.
1520 * See NL80211_MESHCONF_* for all the mesh config parameters.
1521 */
1522 unsigned int flags;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001523 int auto_plinks;
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001524 int peer_link_timeout;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001525 int max_peer_links;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001526 int rssi_threshold;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001527 u16 ht_opmode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001528};
1529
1530struct wpa_driver_mesh_join_params {
1531 const u8 *meshid;
1532 int meshid_len;
1533 const int *basic_rates;
1534 const u8 *ies;
1535 int ie_len;
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001536 struct hostapd_freq_params freq;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001537 int beacon_int;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001538 int dtim_period;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001539 struct wpa_driver_mesh_bss_params conf;
1540#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1541#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1542#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1543#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1544 unsigned int flags;
1545};
1546
Hai Shalomfdcde762020-04-02 11:19:20 -07001547struct wpa_driver_set_key_params {
1548 /**
1549 * ifname - Interface name (for multi-SSID/VLAN support) */
1550 const char *ifname;
1551
1552 /**
1553 * alg - Encryption algorithm
1554 *
1555 * (%WPA_ALG_NONE, %WPA_ALG_WEP, %WPA_ALG_TKIP, %WPA_ALG_CCMP,
1556 * %WPA_ALG_IGTK, %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1557 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256, %WPA_ALG_BIP_CMAC_256);
1558 * %WPA_ALG_NONE clears the key. */
1559 enum wpa_alg alg;
1560
1561 /**
1562 * addr - Address of the peer STA
1563 *
1564 * (BSSID of the current AP when setting pairwise key in station mode),
1565 * ff:ff:ff:ff:ff:ff for broadcast keys, %NULL for default keys that
1566 * are used both for broadcast and unicast; when clearing keys, %NULL
1567 * is used to indicate that both the broadcast-only and default key of
1568 * the specified key index is to be cleared */
1569 const u8 *addr;
1570
1571 /**
1572 * key_idx - Key index
1573 *
1574 * (0..3), usually 0 for unicast keys; 4..5 for IGTK; 6..7 for BIGTK */
1575 int key_idx;
1576
1577 /**
1578 * set_tx - Configure this key as the default Tx key
1579 *
1580 * Only used when driver does not support separate unicast/individual
1581 * key */
1582 int set_tx;
1583
1584 /**
1585 * seq - Sequence number/packet number
1586 *
1587 * seq_len octets, the next packet number to be used for in replay
1588 * protection; configured for Rx keys (in most cases, this is only used
1589 * with broadcast keys and set to zero for unicast keys); %NULL if not
1590 * set */
1591 const u8 *seq;
1592
1593 /**
1594 * seq_len - Length of the seq, depends on the algorithm
1595 *
1596 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets */
1597 size_t seq_len;
1598
1599 /**
1600 * key - Key buffer
1601 *
1602 * TKIP: 16-byte temporal key, 8-byte Tx Mic key, 8-byte Rx Mic Key */
1603 const u8 *key;
1604
1605 /**
1606 * key_len - Length of the key buffer in octets
1607 *
1608 * WEP: 5 or 13, TKIP: 32, CCMP/GCMP: 16, IGTK: 16 */
1609 size_t key_len;
1610
1611 /**
1612 * vlan_id - VLAN index (0..4095) for VLAN offload cases */
1613 int vlan_id;
1614
1615 /**
1616 * key_flag - Additional key flags
1617 *
1618 * %KEY_FLAG_MODIFY
1619 * Set when an already installed key must be updated.
1620 * So far the only use-case is changing RX/TX status for
1621 * pairwise keys. Must not be set when deleting a key.
1622 * %KEY_FLAG_DEFAULT
1623 * Set when the key is also a default key. Must not be set when
1624 * deleting a key.
1625 * %KEY_FLAG_RX
1626 * The key is valid for RX. Must not be set when deleting a key.
1627 * %KEY_FLAG_TX
1628 * The key is valid for TX. Must not be set when deleting a key.
1629 * %KEY_FLAG_GROUP
1630 * The key is a broadcast or group key.
1631 * %KEY_FLAG_PAIRWISE
1632 * The key is a pairwise key.
1633 * %KEY_FLAG_PMK
1634 * The key is a Pairwise Master Key (PMK).
1635 *
1636 * Valid and pre-defined combinations are:
1637 * %KEY_FLAG_GROUP_RX_TX
1638 * WEP key not to be installed as default key.
1639 * %KEY_FLAG_GROUP_RX_TX_DEFAULT
1640 * Default WEP or WPA-NONE key.
1641 * %KEY_FLAG_GROUP_RX
1642 * GTK key valid for RX only.
1643 * %KEY_FLAG_GROUP_TX_DEFAULT
1644 * GTK key valid for TX only, immediately taking over TX.
1645 * %KEY_FLAG_PAIRWISE_RX_TX
1646 * Pairwise key immediately becoming the active pairwise key.
1647 * %KEY_FLAG_PAIRWISE_RX
1648 * Pairwise key not yet valid for TX. (Only usable when Extended
1649 * Key ID is supported by the driver.)
1650 * %KEY_FLAG_PAIRWISE_RX_TX_MODIFY
1651 * Enable TX for a pairwise key installed with
1652 * KEY_FLAG_PAIRWISE_RX.
1653 *
1654 * Not a valid standalone key type but pre-defined to be combined
1655 * with other key_flags:
1656 * %KEY_FLAG_RX_TX
1657 * RX/TX key. */
1658 enum key_flag key_flag;
1659};
1660
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001661/**
1662 * struct wpa_driver_capa - Driver capability information
1663 */
1664struct wpa_driver_capa {
1665#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1666#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1667#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1668#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1669#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1670#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1671#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001672#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001673#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1674#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001675#define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
1676#define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
1677#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1678#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1679#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1680#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
Hai Shalom74f70d42019-02-11 14:42:39 -08001681#define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001682 /** Bitfield of supported key management suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001683 unsigned int key_mgmt;
1684
1685#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1686#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1687#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1688#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
Dmitry Shmidt04949592012-07-19 12:16:46 -07001689#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001690#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001691#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1692#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1693#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1694#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1695#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1696#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001697#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001698 /** Bitfield of supported cipher suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001699 unsigned int enc;
1700
1701#define WPA_DRIVER_AUTH_OPEN 0x00000001
1702#define WPA_DRIVER_AUTH_SHARED 0x00000002
1703#define WPA_DRIVER_AUTH_LEAP 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001704 /** Bitfield of supported IEEE 802.11 authentication algorithms */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001705 unsigned int auth;
1706
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001707/** Driver generated WPA/RSN IE */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001708#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001709/** Driver needs static WEP key setup after association command */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001710#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001711/** Driver takes care of all DFS operations */
Dmitry Shmidtd11f0192014-03-24 12:09:47 -07001712#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001713/** Driver takes care of RSN 4-way handshake internally; PMK is configured with
Hai Shalomfdcde762020-04-02 11:19:20 -07001714 * struct wpa_driver_ops::set_key using key_flag = KEY_FLAG_PMK */
Hai Shalom74f70d42019-02-11 14:42:39 -08001715#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001716/** Driver is for a wired Ethernet interface */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001717#define WPA_DRIVER_FLAGS_WIRED 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001718/** Driver provides separate commands for authentication and association (SME in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001719 * wpa_supplicant). */
1720#define WPA_DRIVER_FLAGS_SME 0x00000020
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001721/** Driver supports AP mode */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001722#define WPA_DRIVER_FLAGS_AP 0x00000040
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001723/** Driver needs static WEP key setup after association has been completed */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001724#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001725/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001726#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001727/** Driver supports concurrent P2P operations */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001728#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001729/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001730 * Driver uses the initial interface as a dedicated management interface, i.e.,
1731 * it cannot be used for P2P group operations or non-P2P purposes.
1732 */
1733#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001734/** This interface is P2P capable (P2P GO or P2P Client) */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001735#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001736/** Driver supports station and key removal when stopping an AP */
Dmitry Shmidta38abf92014-03-06 13:38:44 -08001737#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001738/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001739 * Driver uses the initial interface for P2P management interface and non-P2P
1740 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1741 * P2P group operations.
1742 */
1743#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001744/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001745 * Driver is known to use sane error codes, i.e., when it indicates that
1746 * something (e.g., association) fails, there was indeed a failure and the
1747 * operation does not end up getting completed successfully later.
1748 */
1749#define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001750/** Driver supports off-channel TX */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001751#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001752/** Driver indicates TX status events for EAPOL Data frames */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001753#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001754/** Driver indicates TX status events for Deauth/Disassoc frames */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001755#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001756/** Driver supports roaming (BSS selection) in firmware */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001757#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001758/** Driver supports operating as a TDLS peer */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001759#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001760/** Driver requires external TDLS setup/teardown/discovery */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001761#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001762/** Driver indicates support for Probe Response offloading in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001763#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001764/** Driver supports U-APSD in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001765#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001766/** Driver supports inactivity timer in AP mode */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001767#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001768/** Driver expects user space implementation of MLME in AP mode */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001769#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001770/** Driver supports SAE with user space SME */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001771#define WPA_DRIVER_FLAGS_SAE 0x02000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001772/** Driver makes use of OBSS scan mechanism in wpa_supplicant */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001773#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001774/** Driver supports IBSS (Ad-hoc) mode */
Dmitry Shmidt700a1372013-03-15 14:14:44 -07001775#define WPA_DRIVER_FLAGS_IBSS 0x08000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001776/** Driver supports radar detection */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07001777#define WPA_DRIVER_FLAGS_RADAR 0x10000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001778/** Driver supports a dedicated interface for P2P Device */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001779#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001780/** Driver supports QoS Mapping */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001781#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001782/** Driver supports CSA in AP mode */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001783#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001784/** Driver supports mesh */
1785#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1786/** Driver support ACS offload */
1787#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1788/** Driver supports key management offload */
1789#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1790/** Driver supports TDLS channel switching */
1791#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001792/** Driver supports IBSS with HT datarates */
1793#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001794/** Driver supports IBSS with VHT datarates */
1795#define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07001796/** Driver supports automatic band selection */
1797#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001798/** Driver supports simultaneous off-channel operations */
1799#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001800/** Driver supports full AP client state */
1801#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001802/** Driver supports P2P Listen offload */
1803#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001804/** Driver supports FILS */
1805#define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001806/** Driver supports Beacon frame TX rate configuration (legacy rates) */
1807#define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1808/** Driver supports Beacon frame TX rate configuration (HT rates) */
1809#define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1810/** Driver supports Beacon frame TX rate configuration (VHT rates) */
1811#define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08001812/** Driver supports mgmt_tx with random TX address in non-connected state */
1813#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
1814/** Driver supports mgmt_tx with random TX addr in connected state */
1815#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
1816/** Driver supports better BSS reporting with sched_scan in connected mode */
1817#define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
1818/** Driver supports HE capabilities */
1819#define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001820/** Driver supports FILS shared key offload */
1821#define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
1822/** Driver supports all OCE STA specific mandatory features */
1823#define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
1824/** Driver supports all OCE AP specific mandatory features */
1825#define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
1826/**
1827 * Driver supports all OCE STA-CFON specific mandatory features only.
1828 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
1829 * userspace shall assume that this driver may not support all OCE AP
1830 * functionality but can support only OCE STA-CFON functionality.
1831 */
1832#define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
Roshan Pius3a1667e2018-07-03 15:17:14 -07001833/** Driver supports MFP-optional in the connect command */
1834#define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL
Hai Shalom39ba6fc2019-01-22 12:40:38 -08001835/** Driver is a self-managed regulatory device */
1836#define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL
Hai Shalom74f70d42019-02-11 14:42:39 -08001837/** Driver supports FTM responder functionality */
1838#define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL
1839/** Driver support 4-way handshake offload for WPA-Personal */
1840#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
Hai Shalomfdcde762020-04-02 11:19:20 -07001841/** Driver supports a separate control port for EAPOL frames */
1842#define WPA_DRIVER_FLAGS_CONTROL_PORT 0x0400000000000000ULL
1843/** Driver supports VLAN offload */
1844#define WPA_DRIVER_FLAGS_VLAN_OFFLOAD 0x0800000000000000ULL
1845/** Driver supports UPDATE_FT_IES command */
1846#define WPA_DRIVER_FLAGS_UPDATE_FT_IES 0x1000000000000000ULL
1847/** Driver can correctly rekey PTKs without Extended Key ID */
1848#define WPA_DRIVER_FLAGS_SAFE_PTK0_REKEYS 0x2000000000000000ULL
1849/** Driver supports Beacon protection */
1850#define WPA_DRIVER_FLAGS_BEACON_PROTECTION 0x4000000000000000ULL
1851/** Driver supports Extended Key ID */
1852#define WPA_DRIVER_FLAGS_EXTENDED_KEY_ID 0x8000000000000000ULL
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001853 u64 flags;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001854
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001855#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1856 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1857
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001858 unsigned int wmm_ac_supported:1;
1859
1860 unsigned int mac_addr_rand_scan_supported:1;
1861 unsigned int mac_addr_rand_sched_scan_supported:1;
1862
1863 /** Maximum number of supported active probe SSIDs */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001864 int max_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001865
1866 /** Maximum number of supported active probe SSIDs for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001867 int max_sched_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001868
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08001869 /** Maximum number of supported scan plans for scheduled scan */
1870 unsigned int max_sched_scan_plans;
1871
1872 /** Maximum interval in a scan plan. In seconds */
1873 u32 max_sched_scan_plan_interval;
1874
1875 /** Maximum number of iterations in a single scan plan */
1876 u32 max_sched_scan_plan_iterations;
1877
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001878 /** Whether sched_scan (offloaded scanning) is supported */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001879 int sched_scan_supported;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001880
1881 /** Maximum number of supported match sets for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001882 int max_match_sets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001883
1884 /**
1885 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1886 */
1887 unsigned int max_remain_on_chan;
1888
1889 /**
1890 * max_stations - Maximum number of associated stations the driver
1891 * supports in AP mode
1892 */
1893 unsigned int max_stations;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001894
1895 /**
1896 * probe_resp_offloads - Bitmap of supported protocols by the driver
1897 * for Probe Response offloading.
1898 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001899/** Driver Probe Response offloading support for WPS ver. 1 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001900#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001901/** Driver Probe Response offloading support for WPS ver. 2 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001902#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001903/** Driver Probe Response offloading support for P2P */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001904#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001905/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001906#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1907 unsigned int probe_resp_offloads;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001908
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07001909 unsigned int max_acl_mac_addrs;
1910
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001911 /**
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07001912 * Number of supported concurrent channels
1913 */
1914 unsigned int num_multichan_concurrent;
1915
1916 /**
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001917 * extended_capa - extended capabilities in driver/device
1918 *
1919 * Must be allocated and freed by driver and the pointers must be
1920 * valid for the lifetime of the driver, i.e., freed in deinit()
1921 */
1922 const u8 *extended_capa, *extended_capa_mask;
1923 unsigned int extended_capa_len;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001924
1925 struct wowlan_triggers wowlan_triggers;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001926
1927/** Driver adds the DS Params Set IE in Probe Request frames */
1928#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1929/** Driver adds the WFA TPC IE in Probe Request frames */
1930#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1931/** Driver handles quiet period requests */
1932#define WPA_DRIVER_FLAGS_QUIET 0x00000004
1933/**
1934 * Driver is capable of inserting the current TX power value into the body of
1935 * transmitted frames.
1936 * Background: Some Action frames include a TPC Report IE. This IE contains a
1937 * TX power field, which has to be updated by lower layers. One such Action
1938 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1939 * of spectrum management). Note that this insertion takes place at a fixed
1940 * offset, namely the 6th byte in the Action frame body.
1941 */
1942#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001943/**
1944 * Driver supports RRM. With this support, the driver will accept to use RRM in
1945 * (Re)Association Request frames, without supporting quiet period.
1946 */
1947#define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1948
Dmitry Shmidt29333592017-01-09 12:27:11 -08001949/** Driver supports setting the scan dwell time */
1950#define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
1951/** Driver supports Beacon Report Measurement */
1952#define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
1953
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001954 u32 rrm_flags;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001955
1956 /* Driver concurrency capabilities */
1957 unsigned int conc_capab;
1958 /* Maximum number of concurrent channels on 2.4 GHz */
1959 unsigned int max_conc_chan_2_4;
1960 /* Maximum number of concurrent channels on 5 GHz */
1961 unsigned int max_conc_chan_5_0;
1962
1963 /* Maximum number of supported CSA counters */
1964 u16 max_csa_counters;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001965};
1966
1967
1968struct hostapd_data;
1969
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001970#define STA_DRV_DATA_TX_MCS BIT(0)
1971#define STA_DRV_DATA_RX_MCS BIT(1)
1972#define STA_DRV_DATA_TX_VHT_MCS BIT(2)
1973#define STA_DRV_DATA_RX_VHT_MCS BIT(3)
1974#define STA_DRV_DATA_TX_VHT_NSS BIT(4)
1975#define STA_DRV_DATA_RX_VHT_NSS BIT(5)
1976#define STA_DRV_DATA_TX_SHORT_GI BIT(6)
1977#define STA_DRV_DATA_RX_SHORT_GI BIT(7)
Roshan Pius3a1667e2018-07-03 15:17:14 -07001978#define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001979
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001980struct hostap_sta_driver_data {
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001981 unsigned long rx_packets, tx_packets;
1982 unsigned long long rx_bytes, tx_bytes;
Hai Shalom81f62d82019-07-22 12:10:00 -07001983 unsigned long long rx_airtime, tx_airtime;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001984 int bytes_64bit; /* whether 64-bit byte counters are supported */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001985 unsigned long current_tx_rate;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001986 unsigned long current_rx_rate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001987 unsigned long inactive_msec;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001988 unsigned long flags; /* bitfield of STA_DRV_DATA_* */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001989 unsigned long num_ps_buf_frames;
1990 unsigned long tx_retry_failed;
1991 unsigned long tx_retry_count;
Roshan Pius3a1667e2018-07-03 15:17:14 -07001992 s8 last_ack_rssi;
Hai Shalom81f62d82019-07-22 12:10:00 -07001993 unsigned long backlog_packets;
1994 unsigned long backlog_bytes;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001995 s8 signal;
1996 u8 rx_vhtmcs;
1997 u8 tx_vhtmcs;
1998 u8 rx_mcs;
1999 u8 tx_mcs;
2000 u8 rx_vht_nss;
2001 u8 tx_vht_nss;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002002};
2003
2004struct hostapd_sta_add_params {
2005 const u8 *addr;
2006 u16 aid;
2007 u16 capability;
2008 const u8 *supp_rates;
2009 size_t supp_rates_len;
2010 u16 listen_interval;
2011 const struct ieee80211_ht_capabilities *ht_capabilities;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08002012 const struct ieee80211_vht_capabilities *vht_capabilities;
Dmitry Shmidtbd14a572014-02-18 10:33:49 -08002013 int vht_opmode_enabled;
2014 u8 vht_opmode;
Hai Shalom81f62d82019-07-22 12:10:00 -07002015 const struct ieee80211_he_capabilities *he_capab;
2016 size_t he_capab_len;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002017 u32 flags; /* bitmask of WPA_STA_* flags */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002018 u32 flags_mask; /* unset bits in flags */
2019#ifdef CONFIG_MESH
2020 enum mesh_plink_state plink_state;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07002021 u16 peer_aid;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002022#endif /* CONFIG_MESH */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002023 int set; /* Set STA parameters instead of add */
2024 u8 qosinfo;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08002025 const u8 *ext_capab;
2026 size_t ext_capab_len;
Dmitry Shmidt344abd32014-01-14 13:17:00 -08002027 const u8 *supp_channels;
2028 size_t supp_channels_len;
2029 const u8 *supp_oper_classes;
2030 size_t supp_oper_classes_len;
Dmitry Shmidt849734c2016-05-27 09:59:01 -07002031 int support_p2p_ps;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002032};
2033
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002034struct mac_address {
2035 u8 addr[ETH_ALEN];
2036};
2037
2038struct hostapd_acl_params {
2039 u8 acl_policy;
2040 unsigned int num_mac_acl;
2041 struct mac_address mac_acl[0];
2042};
2043
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002044enum wpa_driver_if_type {
2045 /**
2046 * WPA_IF_STATION - Station mode interface
2047 */
2048 WPA_IF_STATION,
2049
2050 /**
2051 * WPA_IF_AP_VLAN - AP mode VLAN interface
2052 *
2053 * This interface shares its address and Beacon frame with the main
2054 * BSS.
2055 */
2056 WPA_IF_AP_VLAN,
2057
2058 /**
2059 * WPA_IF_AP_BSS - AP mode BSS interface
2060 *
2061 * This interface has its own address and Beacon frame.
2062 */
2063 WPA_IF_AP_BSS,
2064
2065 /**
2066 * WPA_IF_P2P_GO - P2P Group Owner
2067 */
2068 WPA_IF_P2P_GO,
2069
2070 /**
2071 * WPA_IF_P2P_CLIENT - P2P Client
2072 */
2073 WPA_IF_P2P_CLIENT,
2074
2075 /**
2076 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
2077 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
2078 */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002079 WPA_IF_P2P_GROUP,
2080
2081 /**
2082 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
2083 * abstracted P2P Device function in the driver
2084 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002085 WPA_IF_P2P_DEVICE,
2086
2087 /*
2088 * WPA_IF_MESH - Mesh interface
2089 */
2090 WPA_IF_MESH,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002091
2092 /*
2093 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
2094 */
2095 WPA_IF_TDLS,
2096
2097 /*
2098 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
2099 */
2100 WPA_IF_IBSS,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002101};
2102
2103struct wpa_init_params {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002104 void *global_priv;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002105 const u8 *bssid;
2106 const char *ifname;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002107 const char *driver_params;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002108 int use_pae_group_addr;
2109 char **bridge;
2110 size_t num_bridge;
2111
2112 u8 *own_addr; /* buffer for writing own MAC address */
2113};
2114
2115
2116struct wpa_bss_params {
2117 /** Interface name (for multi-SSID/VLAN support) */
2118 const char *ifname;
2119 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
2120 int enabled;
2121
2122 int wpa;
2123 int ieee802_1x;
2124 int wpa_group;
2125 int wpa_pairwise;
2126 int wpa_key_mgmt;
2127 int rsn_preauth;
2128 enum mfp_options ieee80211w;
2129};
2130
2131#define WPA_STA_AUTHORIZED BIT(0)
2132#define WPA_STA_WMM BIT(1)
2133#define WPA_STA_SHORT_PREAMBLE BIT(2)
2134#define WPA_STA_MFP BIT(3)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002135#define WPA_STA_TDLS_PEER BIT(4)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002136#define WPA_STA_AUTHENTICATED BIT(5)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002137#define WPA_STA_ASSOCIATED BIT(6)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002138
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002139enum tdls_oper {
2140 TDLS_DISCOVERY_REQ,
2141 TDLS_SETUP,
2142 TDLS_TEARDOWN,
2143 TDLS_ENABLE_LINK,
2144 TDLS_DISABLE_LINK,
2145 TDLS_ENABLE,
2146 TDLS_DISABLE
2147};
2148
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002149enum wnm_oper {
2150 WNM_SLEEP_ENTER_CONFIRM,
2151 WNM_SLEEP_ENTER_FAIL,
2152 WNM_SLEEP_EXIT_CONFIRM,
2153 WNM_SLEEP_EXIT_FAIL,
2154 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
2155 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
2156 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
2157 * a STA */
2158 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
2159 * for a STA */
2160 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
2161 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
2162 * for a STA */
2163 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
2164};
2165
Roshan Pius3a1667e2018-07-03 15:17:14 -07002166/* enum smps_mode - SMPS mode definitions */
2167enum smps_mode {
2168 SMPS_AUTOMATIC,
2169 SMPS_OFF,
2170 SMPS_DYNAMIC,
2171 SMPS_STATIC,
2172
2173 /* Keep last */
2174 SMPS_INVALID,
2175};
2176
Hai Shalom74f70d42019-02-11 14:42:39 -08002177#define WPA_INVALID_NOISE 9999
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002178
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002179/**
2180 * struct wpa_signal_info - Information about channel signal quality
Hai Shalom74f70d42019-02-11 14:42:39 -08002181 * @frequency: control frequency
2182 * @above_threshold: true if the above threshold was crossed
2183 * (relevant for a CQM event)
2184 * @current_signal: in dBm
2185 * @avg_signal: in dBm
2186 * @avg_beacon_signal: in dBm
2187 * @current_noise: %WPA_INVALID_NOISE if not supported
2188 * @current_txrate: current TX rate
2189 * @chanwidth: channel width
2190 * @center_frq1: center frequency for the first segment
2191 * @center_frq2: center frequency for the second segment (if relevant)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002192 */
2193struct wpa_signal_info {
2194 u32 frequency;
2195 int above_threshold;
2196 int current_signal;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002197 int avg_signal;
Dmitry Shmidtf73259c2015-03-17 11:00:54 -07002198 int avg_beacon_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002199 int current_noise;
2200 int current_txrate;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002201 enum chan_width chanwidth;
2202 int center_frq1;
2203 int center_frq2;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002204};
2205
2206/**
Hai Shalom74f70d42019-02-11 14:42:39 -08002207 * struct wpa_channel_info - Information about the current channel
2208 * @frequency: Center frequency of the primary 20 MHz channel
2209 * @chanwidth: Width of the current operating channel
2210 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
2211 * This field is only filled in when using a 40 MHz channel.
2212 * @center_frq1: Center frequency of frequency segment 0
2213 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
2214 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
2215 * derived from center_frq2 for convenience.
2216 */
2217struct wpa_channel_info {
2218 u32 frequency;
2219 enum chan_width chanwidth;
2220 int sec_channel;
2221 int center_frq1;
2222 int center_frq2;
2223 u8 seg1_idx;
2224};
2225
2226/**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002227 * struct beacon_data - Beacon data
2228 * @head: Head portion of Beacon frame (before TIM IE)
2229 * @tail: Tail portion of Beacon frame (after TIM IE)
2230 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2231 * @proberesp_ies: Extra information element(s) to add into Probe Response
2232 * frames or %NULL
2233 * @assocresp_ies: Extra information element(s) to add into (Re)Association
2234 * Response frames or %NULL
2235 * @probe_resp: Probe Response frame template
2236 * @head_len: Length of @head
2237 * @tail_len: Length of @tail
2238 * @beacon_ies_len: Length of beacon_ies in octets
2239 * @proberesp_ies_len: Length of proberesp_ies in octets
2240 * @proberesp_ies_len: Length of proberesp_ies in octets
2241 * @probe_resp_len: Length of probe response template (@probe_resp)
2242 */
2243struct beacon_data {
2244 u8 *head, *tail;
2245 u8 *beacon_ies;
2246 u8 *proberesp_ies;
2247 u8 *assocresp_ies;
2248 u8 *probe_resp;
2249
2250 size_t head_len, tail_len;
2251 size_t beacon_ies_len;
2252 size_t proberesp_ies_len;
2253 size_t assocresp_ies_len;
2254 size_t probe_resp_len;
2255};
2256
2257/**
2258 * struct csa_settings - Settings for channel switch command
2259 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2260 * @block_tx: 1 - block transmission for CSA period
2261 * @freq_params: Next channel frequency parameter
2262 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2263 * @beacon_after: Next beacon/probe resp/asooc resp info
2264 * @counter_offset_beacon: Offset to the count field in beacon's tail
2265 * @counter_offset_presp: Offset to the count field in probe resp.
2266 */
2267struct csa_settings {
2268 u8 cs_count;
2269 u8 block_tx;
2270
2271 struct hostapd_freq_params freq_params;
2272 struct beacon_data beacon_csa;
2273 struct beacon_data beacon_after;
2274
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002275 u16 counter_offset_beacon[2];
2276 u16 counter_offset_presp[2];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002277};
2278
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002279/* TDLS peer capabilities for send_tdls_mgmt() */
2280enum tdls_peer_capability {
2281 TDLS_PEER_HT = BIT(0),
2282 TDLS_PEER_VHT = BIT(1),
2283 TDLS_PEER_WMM = BIT(2),
2284};
2285
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002286/* valid info in the wmm_params struct */
2287enum wmm_params_valid_info {
2288 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
2289};
2290
2291/**
2292 * struct wmm_params - WMM parameterss configured for this association
2293 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2294 * of the struct contain valid information.
2295 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2296 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2297 */
2298struct wmm_params {
2299 u8 info_bitmap;
2300 u8 uapsd_queues;
2301};
2302
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002303#ifdef CONFIG_MACSEC
2304struct macsec_init_params {
2305 Boolean always_include_sci;
2306 Boolean use_es;
2307 Boolean use_scb;
2308};
2309#endif /* CONFIG_MACSEC */
2310
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002311enum drv_br_port_attr {
2312 DRV_BR_PORT_ATTR_PROXYARP,
2313 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
2314};
2315
2316enum drv_br_net_param {
2317 DRV_BR_NET_PARAM_GARP_ACCEPT,
Dmitry Shmidt83474442015-04-15 13:47:09 -07002318 DRV_BR_MULTICAST_SNOOPING,
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002319};
2320
2321struct drv_acs_params {
2322 /* Selected mode (HOSTAPD_MODE_*) */
2323 enum hostapd_hw_mode hw_mode;
2324
2325 /* Indicates whether HT is enabled */
2326 int ht_enabled;
2327
2328 /* Indicates whether HT40 is enabled */
2329 int ht40_enabled;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07002330
2331 /* Indicates whether VHT is enabled */
2332 int vht_enabled;
2333
2334 /* Configured ACS channel width */
2335 u16 ch_width;
2336
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08002337 /* ACS frequency list info */
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002338 const int *freq_list;
Hai Shalomfdcde762020-04-02 11:19:20 -07002339
2340 /* Indicates whether EDMG is enabled */
2341 int edmg_enabled;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002342};
2343
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002344struct wpa_bss_trans_info {
2345 u8 mbo_transition_reason;
2346 u8 n_candidates;
2347 u8 *bssid;
2348};
2349
2350struct wpa_bss_candidate_info {
2351 u8 num;
2352 struct candidate_list {
2353 u8 bssid[ETH_ALEN];
2354 u8 is_accept;
2355 u32 reject_reason;
2356 } *candidates;
2357};
2358
2359struct wpa_pmkid_params {
2360 const u8 *bssid;
2361 const u8 *ssid;
2362 size_t ssid_len;
2363 const u8 *fils_cache_id;
2364 const u8 *pmkid;
2365 const u8 *pmk;
2366 size_t pmk_len;
Hai Shalomfdcde762020-04-02 11:19:20 -07002367 u32 pmk_lifetime;
2368 u8 pmk_reauth_threshold;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002369};
2370
2371/* Mask used to specify which connection parameters have to be updated */
2372enum wpa_drv_update_connect_params_mask {
2373 WPA_DRV_UPDATE_ASSOC_IES = BIT(0),
2374 WPA_DRV_UPDATE_FILS_ERP_INFO = BIT(1),
2375 WPA_DRV_UPDATE_AUTH_TYPE = BIT(2),
2376};
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002377
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002378/**
Roshan Pius3a1667e2018-07-03 15:17:14 -07002379 * struct external_auth - External authentication trigger parameters
2380 *
2381 * These are used across the external authentication request and event
2382 * interfaces.
2383 * @action: Action type / trigger for external authentication. Only significant
2384 * for the event interface.
2385 * @bssid: BSSID of the peer with which the authentication has to happen. Used
2386 * by both the request and event interface.
2387 * @ssid: SSID of the AP. Used by both the request and event interface.
2388 * @ssid_len: SSID length in octets.
2389 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2390 * the request interface.
2391 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2392 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2393 * the real status code for failures. Used only for the request interface
2394 * from user space to the driver.
Hai Shalom5f92bc92019-04-18 11:54:11 -07002395 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
Roshan Pius3a1667e2018-07-03 15:17:14 -07002396 */
2397struct external_auth {
2398 enum {
2399 EXT_AUTH_START,
2400 EXT_AUTH_ABORT,
2401 } action;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002402 const u8 *bssid;
2403 const u8 *ssid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002404 size_t ssid_len;
2405 unsigned int key_mgmt_suite;
2406 u16 status;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002407 const u8 *pmkid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002408};
2409
2410/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002411 * struct wpa_driver_ops - Driver interface API definition
2412 *
2413 * This structure defines the API that each driver interface needs to implement
2414 * for core wpa_supplicant code. All driver specific functionality is captured
2415 * in this wrapper.
2416 */
2417struct wpa_driver_ops {
2418 /** Name of the driver interface */
2419 const char *name;
2420 /** One line description of the driver interface */
2421 const char *desc;
2422
2423 /**
2424 * get_bssid - Get the current BSSID
2425 * @priv: private driver interface data
2426 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2427 *
2428 * Returns: 0 on success, -1 on failure
2429 *
2430 * Query kernel driver for the current BSSID and copy it to bssid.
2431 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2432 * associated.
2433 */
2434 int (*get_bssid)(void *priv, u8 *bssid);
2435
2436 /**
2437 * get_ssid - Get the current SSID
2438 * @priv: private driver interface data
2439 * @ssid: buffer for SSID (at least 32 bytes)
2440 *
2441 * Returns: Length of the SSID on success, -1 on failure
2442 *
2443 * Query kernel driver for the current SSID and copy it to ssid.
2444 * Returning zero is recommended if the STA is not associated.
2445 *
2446 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2447 * can, at least in theory, contain control characters (including nul)
2448 * and as such, should be processed as binary data, not a printable
2449 * string.
2450 */
2451 int (*get_ssid)(void *priv, u8 *ssid);
2452
2453 /**
2454 * set_key - Configure encryption key
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002455 * @priv: private driver interface data
Hai Shalomfdcde762020-04-02 11:19:20 -07002456 * @params: Key parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002457 * Returns: 0 on success, -1 on failure
2458 *
2459 * Configure the given key for the kernel driver. If the driver
2460 * supports separate individual keys (4 default keys + 1 individual),
2461 * addr can be used to determine whether the key is default or
2462 * individual. If only 4 keys are supported, the default key with key
2463 * index 0 is used as the individual key. STA must be configured to use
2464 * it as the default Tx key (set_tx is set) and accept Rx for all the
2465 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2466 * broadcast keys, so key index 0 is available for this kind of
2467 * configuration.
2468 *
2469 * Please note that TKIP keys include separate TX and RX MIC keys and
2470 * some drivers may expect them in different order than wpa_supplicant
2471 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
2472 * will trigger Michael MIC errors. This can be fixed by changing the
2473 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
2474 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2475 * example on how this can be done.
2476 */
Hai Shalomfdcde762020-04-02 11:19:20 -07002477 int (*set_key)(void *priv, struct wpa_driver_set_key_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002478
2479 /**
2480 * init - Initialize driver interface
2481 * @ctx: context to be used when calling wpa_supplicant functions,
2482 * e.g., wpa_supplicant_event()
2483 * @ifname: interface name, e.g., wlan0
2484 *
2485 * Returns: Pointer to private data, %NULL on failure
2486 *
2487 * Initialize driver interface, including event processing for kernel
2488 * driver events (e.g., associated, scan results, Michael MIC failure).
2489 * This function can allocate a private configuration data area for
2490 * @ctx, file descriptor, interface name, etc. information that may be
2491 * needed in future driver operations. If this is not used, non-NULL
2492 * value will need to be returned because %NULL is used to indicate
2493 * failure. The returned value will be used as 'void *priv' data for
2494 * all other driver_ops functions.
2495 *
2496 * The main event loop (eloop.c) of wpa_supplicant can be used to
2497 * register callback for read sockets (eloop_register_read_sock()).
2498 *
2499 * See below for more information about events and
2500 * wpa_supplicant_event() function.
2501 */
2502 void * (*init)(void *ctx, const char *ifname);
2503
2504 /**
2505 * deinit - Deinitialize driver interface
2506 * @priv: private driver interface data from init()
2507 *
2508 * Shut down driver interface and processing of driver events. Free
2509 * private data buffer if one was allocated in init() handler.
2510 */
2511 void (*deinit)(void *priv);
2512
2513 /**
2514 * set_param - Set driver configuration parameters
2515 * @priv: private driver interface data from init()
2516 * @param: driver specific configuration parameters
2517 *
2518 * Returns: 0 on success, -1 on failure
2519 *
2520 * Optional handler for notifying driver interface about configuration
2521 * parameters (driver_param).
2522 */
2523 int (*set_param)(void *priv, const char *param);
2524
2525 /**
2526 * set_countermeasures - Enable/disable TKIP countermeasures
2527 * @priv: private driver interface data
2528 * @enabled: 1 = countermeasures enabled, 0 = disabled
2529 *
2530 * Returns: 0 on success, -1 on failure
2531 *
2532 * Configure TKIP countermeasures. When these are enabled, the driver
2533 * should drop all received and queued frames that are using TKIP.
2534 */
2535 int (*set_countermeasures)(void *priv, int enabled);
2536
2537 /**
2538 * deauthenticate - Request driver to deauthenticate
2539 * @priv: private driver interface data
2540 * @addr: peer address (BSSID of the AP)
2541 * @reason_code: 16-bit reason code to be sent in the deauthentication
2542 * frame
2543 *
2544 * Returns: 0 on success, -1 on failure
2545 */
Hai Shalom81f62d82019-07-22 12:10:00 -07002546 int (*deauthenticate)(void *priv, const u8 *addr, u16 reason_code);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002547
2548 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002549 * associate - Request driver to associate
2550 * @priv: private driver interface data
2551 * @params: association parameters
2552 *
2553 * Returns: 0 on success, -1 on failure
2554 */
2555 int (*associate)(void *priv,
2556 struct wpa_driver_associate_params *params);
2557
2558 /**
2559 * add_pmkid - Add PMKSA cache entry to the driver
2560 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002561 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002562 *
2563 * Returns: 0 on success, -1 on failure
2564 *
2565 * This function is called when a new PMK is received, as a result of
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002566 * either normal authentication or RSN pre-authentication. The PMKSA
2567 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2568 * ssid, fils_cache_id, pmkid, and pmk.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002569 *
2570 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2571 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2572 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2573 * driver_ops function does not need to be implemented. Likewise, if
2574 * the driver does not support WPA, this function is not needed.
2575 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002576 int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002577
2578 /**
2579 * remove_pmkid - Remove PMKSA cache entry to the driver
2580 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002581 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002582 *
2583 * Returns: 0 on success, -1 on failure
2584 *
2585 * This function is called when the supplicant drops a PMKSA cache
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002586 * entry for any reason. The PMKSA parameters are either a set of
2587 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002588 *
2589 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2590 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2591 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2592 * from wpa_supplicant, this driver_ops function does not need to be
2593 * implemented. Likewise, if the driver does not support WPA, this
2594 * function is not needed.
2595 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002596 int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002597
2598 /**
2599 * flush_pmkid - Flush PMKSA cache
2600 * @priv: private driver interface data
2601 *
2602 * Returns: 0 on success, -1 on failure
2603 *
2604 * This function is called when the supplicant drops all PMKSA cache
2605 * entries for any reason.
2606 *
2607 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2608 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2609 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2610 * from wpa_supplicant, this driver_ops function does not need to be
2611 * implemented. Likewise, if the driver does not support WPA, this
2612 * function is not needed.
2613 */
2614 int (*flush_pmkid)(void *priv);
2615
2616 /**
2617 * get_capa - Get driver capabilities
2618 * @priv: private driver interface data
2619 *
2620 * Returns: 0 on success, -1 on failure
2621 *
2622 * Get driver/firmware/hardware capabilities.
2623 */
2624 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
2625
2626 /**
2627 * poll - Poll driver for association information
2628 * @priv: private driver interface data
2629 *
2630 * This is an option callback that can be used when the driver does not
2631 * provide event mechanism for association events. This is called when
2632 * receiving WPA EAPOL-Key messages that require association
2633 * information. The driver interface is supposed to generate associnfo
2634 * event before returning from this callback function. In addition, the
2635 * driver interface should generate an association event after having
2636 * sent out associnfo.
2637 */
2638 void (*poll)(void *priv);
2639
2640 /**
Dmitry Shmidte4663042016-04-04 10:07:49 -07002641 * get_ifindex - Get interface index
2642 * @priv: private driver interface data
2643 *
2644 * Returns: Interface index
2645 */
2646 unsigned int (*get_ifindex)(void *priv);
2647
2648 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002649 * get_ifname - Get interface name
2650 * @priv: private driver interface data
2651 *
2652 * Returns: Pointer to the interface name. This can differ from the
2653 * interface name used in init() call. Init() is called first.
2654 *
2655 * This optional function can be used to allow the driver interface to
2656 * replace the interface name with something else, e.g., based on an
2657 * interface mapping from a more descriptive name.
2658 */
2659 const char * (*get_ifname)(void *priv);
2660
2661 /**
2662 * get_mac_addr - Get own MAC address
2663 * @priv: private driver interface data
2664 *
2665 * Returns: Pointer to own MAC address or %NULL on failure
2666 *
2667 * This optional function can be used to get the own MAC address of the
2668 * device from the driver interface code. This is only needed if the
2669 * l2_packet implementation for the OS does not provide easy access to
2670 * a MAC address. */
2671 const u8 * (*get_mac_addr)(void *priv);
2672
2673 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002674 * set_operstate - Sets device operating state to DORMANT or UP
2675 * @priv: private driver interface data
2676 * @state: 0 = dormant, 1 = up
2677 * Returns: 0 on success, -1 on failure
2678 *
2679 * This is an optional function that can be used on operating systems
2680 * that support a concept of controlling network device state from user
2681 * space applications. This function, if set, gets called with
2682 * state = 1 when authentication has been completed and with state = 0
2683 * when connection is lost.
2684 */
2685 int (*set_operstate)(void *priv, int state);
2686
2687 /**
2688 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2689 * @priv: Private driver interface data
2690 * @addr: Address of the station for which to set protection (may be
2691 * %NULL for group keys)
2692 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2693 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2694 * Returns: 0 on success, -1 on failure
2695 *
2696 * This is an optional function that can be used to set the driver to
2697 * require protection for Tx and/or Rx frames. This uses the layer
2698 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2699 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2700 * set protection operation; instead, they set protection implicitly
2701 * based on configured keys.
2702 */
2703 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2704 int key_type);
2705
2706 /**
2707 * get_hw_feature_data - Get hardware support data (channels and rates)
2708 * @priv: Private driver interface data
2709 * @num_modes: Variable for returning the number of returned modes
2710 * flags: Variable for returning hardware feature flags
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002711 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002712 * Returns: Pointer to allocated hardware data on success or %NULL on
2713 * failure. Caller is responsible for freeing this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002714 */
2715 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2716 u16 *num_modes,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002717 u16 *flags, u8 *dfs);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002718
2719 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002720 * send_mlme - Send management frame from MLME
2721 * @priv: Private driver interface data
2722 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2723 * @data_len: Size of the management frame
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002724 * @noack: Do not wait for this frame to be acked (disable retries)
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07002725 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2726 * driver decide
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002727 * @csa_offs: Array of CSA offsets or %NULL
2728 * @csa_offs_len: Number of elements in csa_offs
Hai Shalomfdcde762020-04-02 11:19:20 -07002729 * @no_encrypt: Do not encrypt frame even if appropriate key exists
2730 * (used only for testing purposes)
2731 * @wait: Time to wait off-channel for a response (in ms), or zero
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002732 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002733 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002734 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002735 int noack, unsigned int freq, const u16 *csa_offs,
Hai Shalomfdcde762020-04-02 11:19:20 -07002736 size_t csa_offs_len, int no_encrypt,
2737 unsigned int wait);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002738
2739 /**
2740 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2741 * @priv: Private driver interface data
2742 * @md: Mobility domain (2 octets) (also included inside ies)
2743 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2744 * @ies_len: Length of FT IEs in bytes
2745 * Returns: 0 on success, -1 on failure
2746 *
2747 * The supplicant uses this callback to let the driver know that keying
2748 * material for FT is available and that the driver can use the
2749 * provided IEs in the next message in FT authentication sequence.
2750 *
2751 * This function is only needed for driver that support IEEE 802.11r
2752 * (Fast BSS Transition).
2753 */
2754 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2755 size_t ies_len);
2756
2757 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002758 * get_scan_results2 - Fetch the latest scan results
2759 * @priv: private driver interface data
2760 *
2761 * Returns: Allocated buffer of scan results (caller is responsible for
2762 * freeing the data structure) on success, NULL on failure
2763 */
2764 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2765
2766 /**
2767 * set_country - Set country
2768 * @priv: Private driver interface data
2769 * @alpha2: country to which to switch to
2770 * Returns: 0 on success, -1 on failure
2771 *
2772 * This function is for drivers which support some form
2773 * of setting a regulatory domain.
2774 */
2775 int (*set_country)(void *priv, const char *alpha2);
2776
2777 /**
Dmitry Shmidtcce06662013-11-04 18:44:24 -08002778 * get_country - Get country
2779 * @priv: Private driver interface data
2780 * @alpha2: Buffer for returning country code (at least 3 octets)
2781 * Returns: 0 on success, -1 on failure
2782 */
2783 int (*get_country)(void *priv, char *alpha2);
2784
2785 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002786 * global_init - Global driver initialization
Dmitry Shmidte4663042016-04-04 10:07:49 -07002787 * @ctx: wpa_global pointer
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002788 * Returns: Pointer to private data (global), %NULL on failure
2789 *
2790 * This optional function is called to initialize the driver wrapper
2791 * for global data, i.e., data that applies to all interfaces. If this
2792 * function is implemented, global_deinit() will also need to be
2793 * implemented to free the private data. The driver will also likely
2794 * use init2() function instead of init() to get the pointer to global
2795 * data available to per-interface initializer.
2796 */
Dmitry Shmidte4663042016-04-04 10:07:49 -07002797 void * (*global_init)(void *ctx);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002798
2799 /**
2800 * global_deinit - Global driver deinitialization
2801 * @priv: private driver global data from global_init()
2802 *
2803 * Terminate any global driver related functionality and free the
2804 * global data structure.
2805 */
2806 void (*global_deinit)(void *priv);
2807
2808 /**
2809 * init2 - Initialize driver interface (with global data)
2810 * @ctx: context to be used when calling wpa_supplicant functions,
2811 * e.g., wpa_supplicant_event()
2812 * @ifname: interface name, e.g., wlan0
2813 * @global_priv: private driver global data from global_init()
2814 * Returns: Pointer to private data, %NULL on failure
2815 *
2816 * This function can be used instead of init() if the driver wrapper
2817 * uses global data.
2818 */
2819 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2820
2821 /**
2822 * get_interfaces - Get information about available interfaces
2823 * @global_priv: private driver global data from global_init()
2824 * Returns: Allocated buffer of interface information (caller is
2825 * responsible for freeing the data structure) on success, NULL on
2826 * failure
2827 */
2828 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2829
2830 /**
2831 * scan2 - Request the driver to initiate scan
2832 * @priv: private driver interface data
2833 * @params: Scan parameters
2834 *
2835 * Returns: 0 on success, -1 on failure
2836 *
2837 * Once the scan results are ready, the driver should report scan
2838 * results event for wpa_supplicant which will eventually request the
2839 * results with wpa_driver_get_scan_results2().
2840 */
2841 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2842
2843 /**
2844 * authenticate - Request driver to authenticate
2845 * @priv: private driver interface data
2846 * @params: authentication parameters
2847 * Returns: 0 on success, -1 on failure
2848 *
2849 * This is an optional function that can be used with drivers that
2850 * support separate authentication and association steps, i.e., when
2851 * wpa_supplicant can act as the SME. If not implemented, associate()
2852 * function is expected to take care of IEEE 802.11 authentication,
2853 * too.
2854 */
2855 int (*authenticate)(void *priv,
2856 struct wpa_driver_auth_params *params);
2857
2858 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002859 * set_ap - Set Beacon and Probe Response information for AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002860 * @priv: Private driver interface data
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002861 * @params: Parameters to use in AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002862 *
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002863 * This function is used to configure Beacon template and/or extra IEs
2864 * to add for Beacon and Probe Response frames for the driver in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002865 * AP mode. The driver is responsible for building the full Beacon
2866 * frame by concatenating the head part with TIM IE generated by the
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002867 * driver/firmware and finishing with the tail part. Depending on the
2868 * driver architectue, this can be done either by using the full
2869 * template or the set of additional IEs (e.g., WPS and P2P IE).
2870 * Similarly, Probe Response processing depends on the driver design.
2871 * If the driver (or firmware) takes care of replying to Probe Request
2872 * frames, the extra IEs provided here needs to be added to the Probe
2873 * Response frames.
2874 *
2875 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002876 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002877 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002878
2879 /**
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002880 * set_acl - Set ACL in AP mode
2881 * @priv: Private driver interface data
2882 * @params: Parameters to configure ACL
2883 * Returns: 0 on success, -1 on failure
2884 *
2885 * This is used only for the drivers which support MAC address ACL.
2886 */
2887 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2888
2889 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002890 * hapd_init - Initialize driver interface (hostapd only)
2891 * @hapd: Pointer to hostapd context
2892 * @params: Configuration for the driver wrapper
2893 * Returns: Pointer to private data, %NULL on failure
2894 *
2895 * This function is used instead of init() or init2() when the driver
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002896 * wrapper is used with hostapd.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002897 */
2898 void * (*hapd_init)(struct hostapd_data *hapd,
2899 struct wpa_init_params *params);
2900
2901 /**
2902 * hapd_deinit - Deinitialize driver interface (hostapd only)
2903 * @priv: Private driver interface data from hapd_init()
2904 */
2905 void (*hapd_deinit)(void *priv);
2906
2907 /**
2908 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2909 * @priv: Private driver interface data
2910 * @params: BSS parameters
2911 * Returns: 0 on success, -1 on failure
2912 *
2913 * This is an optional function to configure the kernel driver to
2914 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2915 * can be left undefined (set to %NULL) if IEEE 802.1X support is
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002916 * always enabled and the driver uses set_ap() to set WPA/RSN IE
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002917 * for Beacon frames.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002918 *
2919 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002920 */
2921 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2922
2923 /**
2924 * set_privacy - Enable/disable privacy (AP only)
2925 * @priv: Private driver interface data
2926 * @enabled: 1 = privacy enabled, 0 = disabled
2927 * Returns: 0 on success, -1 on failure
2928 *
2929 * This is an optional function to configure privacy field in the
2930 * kernel driver for Beacon frames. This can be left undefined (set to
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002931 * %NULL) if the driver uses the Beacon template from set_ap().
2932 *
2933 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002934 */
2935 int (*set_privacy)(void *priv, int enabled);
2936
2937 /**
2938 * get_seqnum - Fetch the current TSC/packet number (AP only)
2939 * @ifname: The interface name (main or virtual)
2940 * @priv: Private driver interface data
2941 * @addr: MAC address of the station or %NULL for group keys
2942 * @idx: Key index
2943 * @seq: Buffer for returning the latest used TSC/packet number
2944 * Returns: 0 on success, -1 on failure
2945 *
2946 * This function is used to fetch the last used TSC/packet number for
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002947 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2948 * keys, so there is no strict requirement on implementing support for
2949 * unicast keys (i.e., addr != %NULL).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002950 */
2951 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2952 int idx, u8 *seq);
2953
2954 /**
2955 * flush - Flush all association stations (AP only)
2956 * @priv: Private driver interface data
2957 * Returns: 0 on success, -1 on failure
2958 *
2959 * This function requests the driver to disassociate all associated
2960 * stations. This function does not need to be implemented if the
2961 * driver does not process association frames internally.
2962 */
2963 int (*flush)(void *priv);
2964
2965 /**
2966 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2967 * @priv: Private driver interface data
2968 * @elem: Information elements
2969 * @elem_len: Length of the elem buffer in octets
2970 * Returns: 0 on success, -1 on failure
2971 *
2972 * This is an optional function to add information elements in the
2973 * kernel driver for Beacon and Probe Response frames. This can be left
2974 * undefined (set to %NULL) if the driver uses the Beacon template from
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002975 * set_ap().
2976 *
2977 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002978 */
2979 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2980
2981 /**
Jouni Malinen1e6c57f2012-09-05 17:07:03 +03002982 * read_sta_data - Fetch station data
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002983 * @priv: Private driver interface data
2984 * @data: Buffer for returning station information
2985 * @addr: MAC address of the station
2986 * Returns: 0 on success, -1 on failure
2987 */
2988 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2989 const u8 *addr);
2990
2991 /**
Hai Shalomfdcde762020-04-02 11:19:20 -07002992 * tx_control_port - Send a frame over the 802.1X controlled port
2993 * @priv: Private driver interface data
2994 * @dest: Destination MAC address
2995 * @proto: Ethertype in host byte order
2996 * @buf: Frame payload starting from IEEE 802.1X header
2997 * @len: Frame payload length
2998 * @no_encrypt: Do not encrypt frame
2999 *
3000 * Returns 0 on success, else an error
3001 *
3002 * This is like a normal Ethernet send except that the driver is aware
3003 * (by other means than the Ethertype) that this frame is special,
3004 * and more importantly it gains an ordering between the transmission of
3005 * the frame and other driver management operations such as key
3006 * installations. This can be used to work around known limitations in
3007 * IEEE 802.11 protocols such as race conditions between rekeying 4-way
3008 * handshake message 4/4 and a PTK being overwritten.
3009 *
3010 * This function is only used for a given interface if the driver
3011 * instance reports WPA_DRIVER_FLAGS_CONTROL_PORT capability. Otherwise,
3012 * API users will fall back to sending the frame via a normal socket.
3013 */
3014 int (*tx_control_port)(void *priv, const u8 *dest,
3015 u16 proto, const u8 *buf, size_t len,
3016 int no_encrypt);
3017
3018 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003019 * hapd_send_eapol - Send an EAPOL packet (AP only)
3020 * @priv: private driver interface data
3021 * @addr: Destination MAC address
3022 * @data: EAPOL packet starting with IEEE 802.1X header
3023 * @data_len: Length of the EAPOL packet in octets
3024 * @encrypt: Whether the frame should be encrypted
3025 * @own_addr: Source MAC address
3026 * @flags: WPA_STA_* flags for the destination station
3027 *
3028 * Returns: 0 on success, -1 on failure
3029 */
3030 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
3031 size_t data_len, int encrypt,
3032 const u8 *own_addr, u32 flags);
3033
3034 /**
3035 * sta_deauth - Deauthenticate a station (AP only)
3036 * @priv: Private driver interface data
3037 * @own_addr: Source address and BSSID for the Deauthentication frame
3038 * @addr: MAC address of the station to deauthenticate
3039 * @reason: Reason code for the Deauthentiation frame
3040 * Returns: 0 on success, -1 on failure
3041 *
3042 * This function requests a specific station to be deauthenticated and
3043 * a Deauthentication frame to be sent to it.
3044 */
3045 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07003046 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003047
3048 /**
3049 * sta_disassoc - Disassociate a station (AP only)
3050 * @priv: Private driver interface data
3051 * @own_addr: Source address and BSSID for the Disassociation frame
3052 * @addr: MAC address of the station to disassociate
3053 * @reason: Reason code for the Disassociation frame
3054 * Returns: 0 on success, -1 on failure
3055 *
3056 * This function requests a specific station to be disassociated and
3057 * a Disassociation frame to be sent to it.
3058 */
3059 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07003060 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003061
3062 /**
3063 * sta_remove - Remove a station entry (AP only)
3064 * @priv: Private driver interface data
3065 * @addr: MAC address of the station to be removed
3066 * Returns: 0 on success, -1 on failure
3067 */
3068 int (*sta_remove)(void *priv, const u8 *addr);
3069
3070 /**
3071 * hapd_get_ssid - Get the current SSID (AP only)
3072 * @priv: Private driver interface data
3073 * @buf: Buffer for returning the SSID
3074 * @len: Maximum length of the buffer
3075 * Returns: Length of the SSID on success, -1 on failure
3076 *
3077 * This function need not be implemented if the driver uses Beacon
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003078 * template from set_ap() and does not reply to Probe Request frames.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003079 */
3080 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
3081
3082 /**
3083 * hapd_set_ssid - Set SSID (AP only)
3084 * @priv: Private driver interface data
3085 * @buf: SSID
3086 * @len: Length of the SSID in octets
3087 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003088 *
3089 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003090 */
3091 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
3092
3093 /**
3094 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
3095 * @priv: Private driver interface data
3096 * @enabled: 1 = countermeasures enabled, 0 = disabled
3097 * Returns: 0 on success, -1 on failure
3098 *
3099 * This need not be implemented if the driver does not take care of
3100 * association processing.
3101 */
3102 int (*hapd_set_countermeasures)(void *priv, int enabled);
3103
3104 /**
3105 * sta_add - Add a station entry
3106 * @priv: Private driver interface data
3107 * @params: Station parameters
3108 * Returns: 0 on success, -1 on failure
3109 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08003110 * This function is used to add or set (params->set 1) a station
3111 * entry in the driver. Adding STA entries is used only if the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003112 * does not take care of association processing.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003113 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08003114 * With drivers that don't support full AP client state, this function
3115 * is used to add a station entry to the driver once the station has
3116 * completed association.
3117 *
3118 * With TDLS, this function is used to add or set (params->set 1)
3119 * TDLS peer entries (even with drivers that do not support full AP
3120 * client state).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003121 */
3122 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
3123
3124 /**
3125 * get_inact_sec - Get station inactivity duration (AP only)
3126 * @priv: Private driver interface data
3127 * @addr: Station address
3128 * Returns: Number of seconds station has been inactive, -1 on failure
3129 */
3130 int (*get_inact_sec)(void *priv, const u8 *addr);
3131
3132 /**
3133 * sta_clear_stats - Clear station statistics (AP only)
3134 * @priv: Private driver interface data
3135 * @addr: Station address
3136 * Returns: 0 on success, -1 on failure
3137 */
3138 int (*sta_clear_stats)(void *priv, const u8 *addr);
3139
3140 /**
3141 * set_freq - Set channel/frequency (AP only)
3142 * @priv: Private driver interface data
3143 * @freq: Channel parameters
3144 * Returns: 0 on success, -1 on failure
3145 */
3146 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
3147
3148 /**
3149 * set_rts - Set RTS threshold
3150 * @priv: Private driver interface data
3151 * @rts: RTS threshold in octets
3152 * Returns: 0 on success, -1 on failure
3153 */
3154 int (*set_rts)(void *priv, int rts);
3155
3156 /**
3157 * set_frag - Set fragmentation threshold
3158 * @priv: Private driver interface data
3159 * @frag: Fragmentation threshold in octets
3160 * Returns: 0 on success, -1 on failure
3161 */
3162 int (*set_frag)(void *priv, int frag);
3163
3164 /**
3165 * sta_set_flags - Set station flags (AP only)
3166 * @priv: Private driver interface data
3167 * @addr: Station address
3168 * @total_flags: Bitmap of all WPA_STA_* flags currently set
3169 * @flags_or: Bitmap of WPA_STA_* flags to add
3170 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
3171 * Returns: 0 on success, -1 on failure
3172 */
3173 int (*sta_set_flags)(void *priv, const u8 *addr,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08003174 unsigned int total_flags, unsigned int flags_or,
3175 unsigned int flags_and);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003176
3177 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07003178 * sta_set_airtime_weight - Set station airtime weight (AP only)
3179 * @priv: Private driver interface data
3180 * @addr: Station address
3181 * @weight: New weight for station airtime assignment
3182 * Returns: 0 on success, -1 on failure
3183 */
3184 int (*sta_set_airtime_weight)(void *priv, const u8 *addr,
3185 unsigned int weight);
3186
3187 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003188 * set_tx_queue_params - Set TX queue parameters
3189 * @priv: Private driver interface data
3190 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
3191 * @aifs: AIFS
3192 * @cw_min: cwMin
3193 * @cw_max: cwMax
3194 * @burst_time: Maximum length for bursting in 0.1 msec units
3195 */
3196 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
3197 int cw_max, int burst_time);
3198
3199 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003200 * if_add - Add a virtual interface
3201 * @priv: Private driver interface data
3202 * @type: Interface type
3203 * @ifname: Interface name for the new virtual interface
3204 * @addr: Local address to use for the interface or %NULL to use the
3205 * parent interface address
3206 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
3207 * @drv_priv: Pointer for overwriting the driver context or %NULL if
3208 * not allowed (applies only to %WPA_IF_AP_BSS type)
3209 * @force_ifname: Buffer for returning an interface name that the
3210 * driver ended up using if it differs from the requested ifname
3211 * @if_addr: Buffer for returning the allocated interface address
3212 * (this may differ from the requested addr if the driver cannot
3213 * change interface address)
3214 * @bridge: Bridge interface to use or %NULL if no bridge configured
Dmitry Shmidtcce06662013-11-04 18:44:24 -08003215 * @use_existing: Whether to allow existing interface to be used
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003216 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003217 * Returns: 0 on success, -1 on failure
3218 */
3219 int (*if_add)(void *priv, enum wpa_driver_if_type type,
3220 const char *ifname, const u8 *addr, void *bss_ctx,
3221 void **drv_priv, char *force_ifname, u8 *if_addr,
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003222 const char *bridge, int use_existing, int setup_ap);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003223
3224 /**
3225 * if_remove - Remove a virtual interface
3226 * @priv: Private driver interface data
3227 * @type: Interface type
3228 * @ifname: Interface name of the virtual interface to be removed
3229 * Returns: 0 on success, -1 on failure
3230 */
3231 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
3232 const char *ifname);
3233
3234 /**
3235 * set_sta_vlan - Bind a station into a specific interface (AP only)
3236 * @priv: Private driver interface data
3237 * @ifname: Interface (main or virtual BSS or VLAN)
3238 * @addr: MAC address of the associated station
3239 * @vlan_id: VLAN ID
3240 * Returns: 0 on success, -1 on failure
3241 *
3242 * This function is used to bind a station to a specific virtual
3243 * interface. It is only used if when virtual interfaces are supported,
3244 * e.g., to assign stations to different VLAN interfaces based on
3245 * information from a RADIUS server. This allows separate broadcast
3246 * domains to be used with a single BSS.
3247 */
3248 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
3249 int vlan_id);
3250
3251 /**
3252 * commit - Optional commit changes handler (AP only)
3253 * @priv: driver private data
3254 * Returns: 0 on success, -1 on failure
3255 *
3256 * This optional handler function can be registered if the driver
3257 * interface implementation needs to commit changes (e.g., by setting
3258 * network interface up) at the end of initial configuration. If set,
3259 * this handler will be called after initial setup has been completed.
3260 */
3261 int (*commit)(void *priv);
3262
3263 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003264 * set_radius_acl_auth - Notification of RADIUS ACL change
3265 * @priv: Private driver interface data
3266 * @mac: MAC address of the station
3267 * @accepted: Whether the station was accepted
3268 * @session_timeout: Session timeout for the station
3269 * Returns: 0 on success, -1 on failure
3270 */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003271 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003272 u32 session_timeout);
3273
3274 /**
3275 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3276 * @priv: Private driver interface data
3277 * @mac: MAC address of the station
3278 * Returns: 0 on success, -1 on failure
3279 */
3280 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
3281
3282 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003283 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
3284 * @priv: Private driver interface data
3285 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3286 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3287 * extra IE(s)
3288 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3289 * to remove extra IE(s)
3290 * Returns: 0 on success, -1 on failure
3291 *
3292 * This is an optional function to add WPS IE in the kernel driver for
3293 * Beacon and Probe Response frames. This can be left undefined (set
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003294 * to %NULL) if the driver uses the Beacon template from set_ap()
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003295 * and does not process Probe Request frames. If the driver takes care
3296 * of (Re)Association frame processing, the assocresp buffer includes
3297 * WPS IE(s) that need to be added to (Re)Association Response frames
3298 * whenever a (Re)Association Request frame indicated use of WPS.
3299 *
3300 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3301 * frames when operating as a GO. The driver is responsible for adding
3302 * timing related attributes (e.g., NoA) in addition to the IEs
3303 * included here by appending them after these buffers. This call is
3304 * also used to provide Probe Response IEs for P2P Listen state
3305 * operations for drivers that generate the Probe Response frames
3306 * internally.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003307 *
3308 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003309 */
3310 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
3311 const struct wpabuf *proberesp,
3312 const struct wpabuf *assocresp);
3313
3314 /**
3315 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3316 * @priv: Private driver interface data
3317 * @authorized: Whether the port is authorized
3318 * Returns: 0 on success, -1 on failure
3319 */
3320 int (*set_supp_port)(void *priv, int authorized);
3321
3322 /**
3323 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3324 * @priv: Private driver interface data
3325 * @addr: MAC address of the associated station
3326 * @aid: Association ID
3327 * @val: 1 = bind to 4-address WDS; 0 = unbind
3328 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3329 * to indicate that bridge is not to be used
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07003330 * @ifname_wds: Buffer to return the interface name for the new WDS
3331 * station or %NULL to indicate name is not returned.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003332 * Returns: 0 on success, -1 on failure
3333 */
3334 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003335 const char *bridge_ifname, char *ifname_wds);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003336
3337 /**
3338 * send_action - Transmit an Action frame
3339 * @priv: Private driver interface data
3340 * @freq: Frequency (in MHz) of the channel
3341 * @wait: Time to wait off-channel for a response (in ms), or zero
3342 * @dst: Destination MAC address (Address 1)
3343 * @src: Source MAC address (Address 2)
3344 * @bssid: BSSID (Address 3)
3345 * @data: Frame body
3346 * @data_len: data length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003347 @ @no_cck: Whether CCK rates must not be used to transmit this frame
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003348 * Returns: 0 on success, -1 on failure
3349 *
3350 * This command can be used to request the driver to transmit an action
3351 * frame to the specified destination.
3352 *
3353 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3354 * be transmitted on the given channel and the device will wait for a
3355 * response on that channel for the given wait time.
3356 *
3357 * If the flag is not set, the wait time will be ignored. In this case,
3358 * if a remain-on-channel duration is in progress, the frame must be
3359 * transmitted on that channel; alternatively the frame may be sent on
3360 * the current operational channel (if in associated state in station
3361 * mode or while operating as an AP.)
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08003362 *
3363 * If @src differs from the device MAC address, use of a random
3364 * transmitter address is requested for this message exchange.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003365 */
3366 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
3367 const u8 *dst, const u8 *src, const u8 *bssid,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003368 const u8 *data, size_t data_len, int no_cck);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003369
3370 /**
3371 * send_action_cancel_wait - Cancel action frame TX wait
3372 * @priv: Private driver interface data
3373 *
3374 * This command cancels the wait time associated with sending an action
3375 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3376 * set in the driver flags.
3377 */
3378 void (*send_action_cancel_wait)(void *priv);
3379
3380 /**
3381 * remain_on_channel - Remain awake on a channel
3382 * @priv: Private driver interface data
3383 * @freq: Frequency (in MHz) of the channel
3384 * @duration: Duration in milliseconds
3385 * Returns: 0 on success, -1 on failure
3386 *
3387 * This command is used to request the driver to remain awake on the
3388 * specified channel for the specified duration and report received
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08003389 * Action frames with EVENT_RX_MGMT events. Optionally, received
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003390 * Probe Request frames may also be requested to be reported by calling
3391 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3392 *
3393 * The driver may not be at the requested channel when this function
3394 * returns, i.e., the return code is only indicating whether the
3395 * request was accepted. The caller will need to wait until the
3396 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3397 * completed the channel change. This may take some time due to other
3398 * need for the radio and the caller should be prepared to timing out
3399 * its wait since there are no guarantees on when this request can be
3400 * executed.
3401 */
3402 int (*remain_on_channel)(void *priv, unsigned int freq,
3403 unsigned int duration);
3404
3405 /**
3406 * cancel_remain_on_channel - Cancel remain-on-channel operation
3407 * @priv: Private driver interface data
3408 *
3409 * This command can be used to cancel a remain-on-channel operation
3410 * before its originally requested duration has passed. This could be
3411 * used, e.g., when remain_on_channel() is used to request extra time
3412 * to receive a response to an Action frame and the response is
3413 * received when there is still unneeded time remaining on the
3414 * remain-on-channel operation.
3415 */
3416 int (*cancel_remain_on_channel)(void *priv);
3417
3418 /**
3419 * probe_req_report - Request Probe Request frames to be indicated
3420 * @priv: Private driver interface data
3421 * @report: Whether to report received Probe Request frames
3422 * Returns: 0 on success, -1 on failure (or if not supported)
3423 *
3424 * This command can be used to request the driver to indicate when
3425 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3426 * Since this operation may require extra resources, e.g., due to less
3427 * optimal hardware/firmware RX filtering, many drivers may disable
3428 * Probe Request reporting at least in station mode. This command is
3429 * used to notify the driver when the Probe Request frames need to be
3430 * reported, e.g., during remain-on-channel operations.
3431 */
3432 int (*probe_req_report)(void *priv, int report);
3433
3434 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003435 * deinit_ap - Deinitialize AP mode
3436 * @priv: Private driver interface data
3437 * Returns: 0 on success, -1 on failure (or if not supported)
3438 *
3439 * This optional function can be used to disable AP mode related
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003440 * configuration. If the interface was not dynamically added,
3441 * change the driver mode to station mode to allow normal station
3442 * operations like scanning to be completed.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003443 */
3444 int (*deinit_ap)(void *priv);
3445
3446 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003447 * deinit_p2p_cli - Deinitialize P2P client mode
3448 * @priv: Private driver interface data
3449 * Returns: 0 on success, -1 on failure (or if not supported)
3450 *
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003451 * This optional function can be used to disable P2P client mode. If the
3452 * interface was not dynamically added, change the interface type back
3453 * to station mode.
Dmitry Shmidt04949592012-07-19 12:16:46 -07003454 */
3455 int (*deinit_p2p_cli)(void *priv);
3456
3457 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003458 * suspend - Notification on system suspend/hibernate event
3459 * @priv: Private driver interface data
3460 */
3461 void (*suspend)(void *priv);
3462
3463 /**
3464 * resume - Notification on system resume/thaw event
3465 * @priv: Private driver interface data
3466 */
3467 void (*resume)(void *priv);
3468
3469 /**
3470 * signal_monitor - Set signal monitoring parameters
3471 * @priv: Private driver interface data
3472 * @threshold: Threshold value for signal change events; 0 = disabled
3473 * @hysteresis: Minimum change in signal strength before indicating a
3474 * new event
3475 * Returns: 0 on success, -1 on failure (or if not supported)
3476 *
3477 * This function can be used to configure monitoring of signal strength
3478 * with the current AP. Whenever signal strength drops below the
3479 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3480 * should be generated assuming the signal strength has changed at
3481 * least %hysteresis from the previously indicated signal change event.
3482 */
3483 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
3484
3485 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003486 * get_noa - Get current Notice of Absence attribute payload
3487 * @priv: Private driver interface data
3488 * @buf: Buffer for returning NoA
3489 * @buf_len: Buffer length in octets
3490 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3491 * advertized, or -1 on failure
3492 *
3493 * This function is used to fetch the current Notice of Absence
3494 * attribute value from GO.
3495 */
3496 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
3497
3498 /**
3499 * set_noa - Set Notice of Absence parameters for GO (testing)
3500 * @priv: Private driver interface data
3501 * @count: Count
3502 * @start: Start time in ms from next TBTT
3503 * @duration: Duration in ms
3504 * Returns: 0 on success or -1 on failure
3505 *
3506 * This function is used to set Notice of Absence parameters for GO. It
3507 * is used only for testing. To disable NoA, all parameters are set to
3508 * 0.
3509 */
3510 int (*set_noa)(void *priv, u8 count, int start, int duration);
3511
3512 /**
3513 * set_p2p_powersave - Set P2P power save options
3514 * @priv: Private driver interface data
3515 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3516 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3517 * @ctwindow: 0.. = change (msec), -1 = no change
3518 * Returns: 0 on success or -1 on failure
3519 */
3520 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
3521 int ctwindow);
3522
3523 /**
3524 * ampdu - Enable/disable aggregation
3525 * @priv: Private driver interface data
3526 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3527 * Returns: 0 on success or -1 on failure
3528 */
3529 int (*ampdu)(void *priv, int ampdu);
3530
3531 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003532 * get_radio_name - Get physical radio name for the device
3533 * @priv: Private driver interface data
3534 * Returns: Radio name or %NULL if not known
3535 *
3536 * The returned data must not be modified by the caller. It is assumed
3537 * that any interface that has the same radio name as another is
3538 * sharing the same physical radio. This information can be used to
3539 * share scan results etc. information between the virtual interfaces
3540 * to speed up various operations.
3541 */
3542 const char * (*get_radio_name)(void *priv);
3543
3544 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003545 * send_tdls_mgmt - for sending TDLS management packets
3546 * @priv: private driver interface data
3547 * @dst: Destination (peer) MAC address
3548 * @action_code: TDLS action code for the mssage
3549 * @dialog_token: Dialog Token to use in the message (if needed)
3550 * @status_code: Status Code or Reason Code to use (if needed)
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003551 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003552 * @initiator: Is the current end the TDLS link initiator
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003553 * @buf: TDLS IEs to add to the message
3554 * @len: Length of buf in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003555 * Returns: 0 on success, negative (<0) on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003556 *
3557 * This optional function can be used to send packet to driver which is
3558 * responsible for receiving and sending all TDLS packets.
3559 */
3560 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003561 u8 dialog_token, u16 status_code, u32 peer_capab,
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003562 int initiator, const u8 *buf, size_t len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003563
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003564 /**
3565 * tdls_oper - Ask the driver to perform high-level TDLS operations
3566 * @priv: Private driver interface data
3567 * @oper: TDLS high-level operation. See %enum tdls_oper
3568 * @peer: Destination (peer) MAC address
3569 * Returns: 0 on success, negative (<0) on failure
3570 *
3571 * This optional function can be used to send high-level TDLS commands
3572 * to the driver.
3573 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003574 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
3575
3576 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07003577 * wnm_oper - Notify driver of the WNM frame reception
3578 * @priv: Private driver interface data
3579 * @oper: WNM operation. See %enum wnm_oper
3580 * @peer: Destination (peer) MAC address
3581 * @buf: Buffer for the driver to fill in (for getting IE)
3582 * @buf_len: Return the len of buf
3583 * Returns: 0 on success, negative (<0) on failure
3584 */
3585 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
3586 u8 *buf, u16 *buf_len);
3587
3588 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -07003589 * set_qos_map - Set QoS Map
3590 * @priv: Private driver interface data
3591 * @qos_map_set: QoS Map
3592 * @qos_map_set_len: Length of QoS Map
3593 */
3594 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
3595 u8 qos_map_set_len);
3596
3597 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003598 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3599 * @priv: Private driver interface data
3600 * @version: IP version of the IP address, 4 or 6
3601 * @ipaddr: IP address for the neigh entry
3602 * @prefixlen: IP address prefix length
3603 * @addr: Corresponding MAC address
3604 * Returns: 0 on success, negative (<0) on failure
3605 */
3606 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
3607 int prefixlen, const u8 *addr);
3608
3609 /**
3610 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3611 * @priv: Private driver interface data
3612 * @version: IP version of the IP address, 4 or 6
3613 * @ipaddr: IP address for the neigh entry
3614 * Returns: 0 on success, negative (<0) on failure
3615 */
3616 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
3617
3618 /**
3619 * br_port_set_attr - Set a bridge port attribute
3620 * @attr: Bridge port attribute to set
3621 * @val: Value to be set
3622 * Returns: 0 on success, negative (<0) on failure
3623 */
3624 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
3625 unsigned int val);
3626
3627 /**
3628 * br_port_set_attr - Set a bridge network parameter
3629 * @param: Bridge parameter to set
3630 * @val: Value to be set
3631 * Returns: 0 on success, negative (<0) on failure
3632 */
3633 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
3634 unsigned int val);
3635
3636 /**
Hai Shalomfdcde762020-04-02 11:19:20 -07003637 * get_wowlan - Get wake-on-wireless status
3638 * @priv: Private driver interface data
3639 */
3640 int (*get_wowlan)(void *priv);
3641
3642 /**
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07003643 * set_wowlan - Set wake-on-wireless triggers
3644 * @priv: Private driver interface data
3645 * @triggers: wowlan triggers
3646 */
3647 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
3648
3649 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003650 * signal_poll - Get current connection information
3651 * @priv: Private driver interface data
3652 * @signal_info: Connection info structure
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003653 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003654 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003655
3656 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08003657 * channel_info - Get parameters of the current operating channel
3658 * @priv: Private driver interface data
3659 * @channel_info: Channel info structure
3660 * Returns: 0 on success, negative (<0) on failure
3661 */
3662 int (*channel_info)(void *priv, struct wpa_channel_info *channel_info);
3663
3664 /**
Jouni Malinen75ecf522011-06-27 15:19:46 -07003665 * set_authmode - Set authentication algorithm(s) for static WEP
3666 * @priv: Private driver interface data
3667 * @authmode: 1=Open System, 2=Shared Key, 3=both
3668 * Returns: 0 on success, -1 on failure
3669 *
3670 * This function can be used to set authentication algorithms for AP
3671 * mode when static WEP is used. If the driver uses user space MLME/SME
3672 * implementation, there is no need to implement this function.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003673 *
3674 * DEPRECATED - use set_ap() instead
Jouni Malinen75ecf522011-06-27 15:19:46 -07003675 */
3676 int (*set_authmode)(void *priv, int authmode);
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003677
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003678#ifdef ANDROID
Jouni Malinen75ecf522011-06-27 15:19:46 -07003679 /**
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003680 * driver_cmd - Execute driver-specific command
3681 * @priv: Private driver interface data
3682 * @cmd: Command to execute
3683 * @buf: Return buffer
3684 * @buf_len: Buffer length
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003685 * Returns: 0 on success, -1 on failure
3686 */
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003687 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
3688#endif /* ANDROID */
3689
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003690 /**
Dmitry Shmidta38abf92014-03-06 13:38:44 -08003691 * vendor_cmd - Execute vendor specific command
3692 * @priv: Private driver interface data
3693 * @vendor_id: Vendor id
3694 * @subcmd: Vendor command id
3695 * @data: Vendor command parameters (%NULL if no parameters)
3696 * @data_len: Data length
3697 * @buf: Return buffer (%NULL to ignore reply)
3698 * Returns: 0 on success, negative (<0) on failure
3699 *
3700 * This function handles vendor specific commands that are passed to
3701 * the driver/device. The command is identified by vendor id and
3702 * command id. Parameters can be passed as argument to the command
3703 * in the data buffer. Reply (if any) will be filled in the supplied
3704 * return buffer.
3705 *
3706 * The exact driver behavior is driver interface and vendor specific. As
3707 * an example, this will be converted to a vendor specific cfg80211
3708 * command in case of the nl80211 driver interface.
3709 */
3710 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3711 unsigned int subcmd, const u8 *data, size_t data_len,
3712 struct wpabuf *buf);
3713
3714 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003715 * set_rekey_info - Set rekey information
3716 * @priv: Private driver interface data
3717 * @kek: Current KEK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003718 * @kek_len: KEK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003719 * @kck: Current KCK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003720 * @kck_len: KCK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003721 * @replay_ctr: Current EAPOL-Key Replay Counter
3722 *
3723 * This optional function can be used to provide information for the
3724 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3725 * while the host (including wpa_supplicant) is sleeping.
3726 */
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003727 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3728 const u8 *kck, size_t kck_len,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003729 const u8 *replay_ctr);
3730
3731 /**
3732 * sta_assoc - Station association indication
3733 * @priv: Private driver interface data
3734 * @own_addr: Source address and BSSID for association frame
3735 * @addr: MAC address of the station to associate
3736 * @reassoc: flag to indicate re-association
3737 * @status: association response status code
3738 * @ie: assoc response ie buffer
3739 * @len: ie buffer length
3740 * Returns: 0 on success, -1 on failure
3741 *
3742 * This function indicates the driver to send (Re)Association
3743 * Response frame to the station.
3744 */
3745 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3746 int reassoc, u16 status, const u8 *ie, size_t len);
3747
3748 /**
3749 * sta_auth - Station authentication indication
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003750 * @priv: private driver interface data
3751 * @params: Station authentication parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003752 *
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003753 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003754 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003755 int (*sta_auth)(void *priv,
3756 struct wpa_driver_sta_auth_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003757
3758 /**
3759 * add_tspec - Add traffic stream
3760 * @priv: Private driver interface data
3761 * @addr: MAC address of the station to associate
3762 * @tspec_ie: tspec ie buffer
3763 * @tspec_ielen: tspec ie length
3764 * Returns: 0 on success, -1 on failure
3765 *
3766 * This function adds the traffic steam for the station
3767 * and fills the medium_time in tspec_ie.
3768 */
3769 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3770 size_t tspec_ielen);
3771
3772 /**
3773 * add_sta_node - Add a station node in the driver
3774 * @priv: Private driver interface data
3775 * @addr: MAC address of the station to add
3776 * @auth_alg: authentication algorithm used by the station
3777 * Returns: 0 on success, -1 on failure
3778 *
3779 * This function adds the station node in the driver, when
3780 * the station gets added by FT-over-DS.
3781 */
3782 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
3783
3784 /**
3785 * sched_scan - Request the driver to initiate scheduled scan
3786 * @priv: Private driver interface data
3787 * @params: Scan parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003788 * Returns: 0 on success, -1 on failure
3789 *
3790 * This operation should be used for scheduled scan offload to
3791 * the hardware. Every time scan results are available, the
3792 * driver should report scan results event for wpa_supplicant
3793 * which will eventually request the results with
3794 * wpa_driver_get_scan_results2(). This operation is optional
3795 * and if not provided or if it returns -1, we fall back to
3796 * normal host-scheduled scans.
3797 */
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003798 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003799
3800 /**
3801 * stop_sched_scan - Request the driver to stop a scheduled scan
3802 * @priv: Private driver interface data
3803 * Returns: 0 on success, -1 on failure
3804 *
3805 * This should cause the scheduled scan to be stopped and
3806 * results should stop being sent. Must be supported if
3807 * sched_scan is supported.
3808 */
3809 int (*stop_sched_scan)(void *priv);
3810
3811 /**
3812 * poll_client - Probe (null data or such) the given station
3813 * @priv: Private driver interface data
3814 * @own_addr: MAC address of sending interface
3815 * @addr: MAC address of the station to probe
3816 * @qos: Indicates whether station is QoS station
3817 *
3818 * This function is used to verify whether an associated station is
3819 * still present. This function does not need to be implemented if the
3820 * driver provides such inactivity polling mechanism.
3821 */
3822 void (*poll_client)(void *priv, const u8 *own_addr,
3823 const u8 *addr, int qos);
Dmitry Shmidt04949592012-07-19 12:16:46 -07003824
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003825 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003826 * radio_disable - Disable/enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003827 * @priv: Private driver interface data
Dmitry Shmidt04949592012-07-19 12:16:46 -07003828 * @disabled: 1=disable 0=enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003829 * Returns: 0 on success, -1 on failure
3830 *
Dmitry Shmidt04949592012-07-19 12:16:46 -07003831 * This optional command is for testing purposes. It can be used to
3832 * disable the radio on a testbed device to simulate out-of-radio-range
3833 * conditions.
3834 */
3835 int (*radio_disable)(void *priv, int disabled);
3836
3837 /**
3838 * switch_channel - Announce channel switch and migrate the GO to the
3839 * given frequency
3840 * @priv: Private driver interface data
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003841 * @settings: Settings for CSA period and new channel
Dmitry Shmidt04949592012-07-19 12:16:46 -07003842 * Returns: 0 on success, -1 on failure
3843 *
3844 * This function is used to move the GO to the legacy STA channel to
3845 * avoid frequency conflict in single channel concurrency.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003846 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003847 int (*switch_channel)(void *priv, struct csa_settings *settings);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003848
3849 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003850 * add_tx_ts - Add traffic stream
3851 * @priv: Private driver interface data
3852 * @tsid: Traffic stream ID
3853 * @addr: Receiver address
3854 * @user_prio: User priority of the traffic stream
3855 * @admitted_time: Admitted time for this TS in units of
3856 * 32 microsecond periods (per second).
3857 * Returns: 0 on success, -1 on failure
3858 */
3859 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3860 u16 admitted_time);
3861
3862 /**
3863 * del_tx_ts - Delete traffic stream
3864 * @priv: Private driver interface data
3865 * @tsid: Traffic stream ID
3866 * @addr: Receiver address
3867 * Returns: 0 on success, -1 on failure
3868 */
3869 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3870
3871 /**
3872 * Enable channel-switching with TDLS peer
3873 * @priv: Private driver interface data
3874 * @addr: MAC address of the TDLS peer
3875 * @oper_class: Operating class of the switch channel
3876 * @params: Channel specification
3877 * Returns: 0 on success, -1 on failure
3878 *
3879 * The function indicates to driver that it can start switching to a
3880 * different channel with a specified TDLS peer. The switching is
3881 * assumed on until canceled with tdls_disable_channel_switch().
3882 */
3883 int (*tdls_enable_channel_switch)(
3884 void *priv, const u8 *addr, u8 oper_class,
3885 const struct hostapd_freq_params *params);
3886
3887 /**
3888 * Disable channel switching with TDLS peer
3889 * @priv: Private driver interface data
3890 * @addr: MAC address of the TDLS peer
3891 * Returns: 0 on success, -1 on failure
3892 *
3893 * This function indicates to the driver that it should stop switching
3894 * with a given TDLS peer.
3895 */
3896 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3897
3898 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003899 * start_dfs_cac - Listen for radar interference on the channel
3900 * @priv: Private driver interface data
Dmitry Shmidt051af732013-10-22 13:52:46 -07003901 * @freq: Channel parameters
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003902 * Returns: 0 on success, -1 on failure
3903 */
Dmitry Shmidt051af732013-10-22 13:52:46 -07003904 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003905
3906 /**
3907 * stop_ap - Removes beacon from AP
3908 * @priv: Private driver interface data
3909 * Returns: 0 on success, -1 on failure (or if not supported)
3910 *
3911 * This optional function can be used to disable AP mode related
3912 * configuration. Unlike deinit_ap, it does not change to station
3913 * mode.
3914 */
3915 int (*stop_ap)(void *priv);
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003916
3917 /**
3918 * get_survey - Retrieve survey data
3919 * @priv: Private driver interface data
3920 * @freq: If set, survey data for the specified frequency is only
3921 * being requested. If not set, all survey data is requested.
3922 * Returns: 0 on success, -1 on failure
3923 *
3924 * Use this to retrieve:
3925 *
3926 * - the observed channel noise floor
3927 * - the amount of time we have spent on the channel
3928 * - the amount of time during which we have spent on the channel that
3929 * the radio has determined the medium is busy and we cannot
3930 * transmit
3931 * - the amount of time we have spent receiving data
3932 * - the amount of time we have spent transmitting data
3933 *
3934 * This data can be used for spectrum heuristics. One example is
3935 * Automatic Channel Selection (ACS). The channel survey data is
3936 * kept on a linked list on the channel data, one entry is added
3937 * for each survey. The min_nf of the channel is updated for each
3938 * survey.
3939 */
3940 int (*get_survey)(void *priv, unsigned int freq);
Dmitry Shmidt56052862013-10-04 10:23:25 -07003941
3942 /**
3943 * status - Get driver interface status information
3944 * @priv: Private driver interface data
Hai Shalom74f70d42019-02-11 14:42:39 -08003945 * @buf: Buffer for printing the status information
Dmitry Shmidt56052862013-10-04 10:23:25 -07003946 * @buflen: Maximum length of the buffer
3947 * Returns: Length of written status information or -1 on failure
3948 */
3949 int (*status)(void *priv, char *buf, size_t buflen);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003950
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07003951 /**
3952 * roaming - Set roaming policy for driver-based BSS selection
3953 * @priv: Private driver interface data
3954 * @allowed: Whether roaming within ESS is allowed
3955 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3956 * Returns: Length of written status information or -1 on failure
3957 *
3958 * This optional callback can be used to update roaming policy from the
3959 * associate() command (bssid being set there indicates that the driver
3960 * should not roam before getting this roaming() call to allow roaming.
3961 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3962 * capability, roaming policy is handled within wpa_supplicant and there
3963 * is no need to implement or react to this callback.
3964 */
3965 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3966
3967 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -07003968 * disable_fils - Enable/disable FILS feature
3969 * @priv: Private driver interface data
3970 * @disable: 0-enable and 1-disable FILS feature
3971 * Returns: 0 on success, -1 on failure
3972 *
3973 * This callback can be used to configure driver and below layers to
3974 * enable/disable all FILS features.
3975 */
3976 int (*disable_fils)(void *priv, int disable);
3977
3978 /**
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07003979 * set_mac_addr - Set MAC address
3980 * @priv: Private driver interface data
3981 * @addr: MAC address to use or %NULL for setting back to permanent
3982 * Returns: 0 on success, -1 on failure
3983 */
3984 int (*set_mac_addr)(void *priv, const u8 *addr);
3985
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003986#ifdef CONFIG_MACSEC
3987 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3988
3989 int (*macsec_deinit)(void *priv);
3990
3991 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003992 * macsec_get_capability - Inform MKA of this driver's capability
3993 * @priv: Private driver interface data
3994 * @cap: Driver's capability
3995 * Returns: 0 on success, -1 on failure
3996 */
3997 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);
3998
3999 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004000 * enable_protect_frames - Set protect frames status
4001 * @priv: Private driver interface data
4002 * @enabled: TRUE = protect frames enabled
4003 * FALSE = protect frames disabled
4004 * Returns: 0 on success, -1 on failure (or if not supported)
4005 */
4006 int (*enable_protect_frames)(void *priv, Boolean enabled);
4007
4008 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004009 * enable_encrypt - Set encryption status
4010 * @priv: Private driver interface data
4011 * @enabled: TRUE = encrypt outgoing traffic
4012 * FALSE = integrity-only protection on outgoing traffic
4013 * Returns: 0 on success, -1 on failure (or if not supported)
4014 */
4015 int (*enable_encrypt)(void *priv, Boolean enabled);
4016
4017 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004018 * set_replay_protect - Set replay protect status and window size
4019 * @priv: Private driver interface data
4020 * @enabled: TRUE = replay protect enabled
4021 * FALSE = replay protect disabled
4022 * @window: replay window size, valid only when replay protect enabled
4023 * Returns: 0 on success, -1 on failure (or if not supported)
4024 */
4025 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
4026
4027 /**
4028 * set_current_cipher_suite - Set current cipher suite
4029 * @priv: Private driver interface data
4030 * @cs: EUI64 identifier
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004031 * Returns: 0 on success, -1 on failure (or if not supported)
4032 */
Dmitry Shmidt7d175302016-09-06 13:11:34 -07004033 int (*set_current_cipher_suite)(void *priv, u64 cs);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004034
4035 /**
4036 * enable_controlled_port - Set controlled port status
4037 * @priv: Private driver interface data
4038 * @enabled: TRUE = controlled port enabled
4039 * FALSE = controlled port disabled
4040 * Returns: 0 on success, -1 on failure (or if not supported)
4041 */
4042 int (*enable_controlled_port)(void *priv, Boolean enabled);
4043
4044 /**
4045 * get_receive_lowest_pn - Get receive lowest pn
4046 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004047 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004048 * Returns: 0 on success, -1 on failure (or if not supported)
4049 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004050 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004051
4052 /**
4053 * get_transmit_next_pn - Get transmit next pn
4054 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004055 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004056 * Returns: 0 on success, -1 on failure (or if not supported)
4057 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004058 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004059
4060 /**
4061 * set_transmit_next_pn - Set transmit next pn
4062 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004063 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004064 * Returns: 0 on success, -1 on failure (or if not supported)
4065 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004066 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004067
4068 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08004069 * set_receive_lowest_pn - Set receive lowest PN
4070 * @priv: Private driver interface data
4071 * @sa: secure association
4072 * Returns: 0 on success, -1 on failure (or if not supported)
4073 */
4074 int (*set_receive_lowest_pn)(void *priv, struct receive_sa *sa);
4075
4076 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004077 * create_receive_sc - create secure channel for receiving
4078 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004079 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004080 * @conf_offset: confidentiality offset (0, 30, or 50)
4081 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
4082 * 2 = Strict)
4083 * Returns: 0 on success, -1 on failure (or if not supported)
4084 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004085 int (*create_receive_sc)(void *priv, struct receive_sc *sc,
4086 unsigned int conf_offset,
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004087 int validation);
4088
4089 /**
4090 * delete_receive_sc - delete secure connection for receiving
4091 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004092 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004093 * Returns: 0 on success, -1 on failure
4094 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004095 int (*delete_receive_sc)(void *priv, struct receive_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004096
4097 /**
4098 * create_receive_sa - create secure association for receive
4099 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004100 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004101 * Returns: 0 on success, -1 on failure
4102 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004103 int (*create_receive_sa)(void *priv, struct receive_sa *sa);
4104
4105 /**
4106 * delete_receive_sa - Delete secure association for receive
4107 * @priv: Private driver interface data from init()
4108 * @sa: Secure association
4109 * Returns: 0 on success, -1 on failure
4110 */
4111 int (*delete_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004112
4113 /**
4114 * enable_receive_sa - enable the SA for receive
4115 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004116 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004117 * Returns: 0 on success, -1 on failure
4118 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004119 int (*enable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004120
4121 /**
4122 * disable_receive_sa - disable SA for receive
4123 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004124 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004125 * Returns: 0 on success, -1 on failure
4126 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004127 int (*disable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004128
4129 /**
4130 * create_transmit_sc - create secure connection for transmit
4131 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004132 * @sc: secure channel
4133 * @conf_offset: confidentiality offset (0, 30, or 50)
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004134 * Returns: 0 on success, -1 on failure
4135 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004136 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
4137 unsigned int conf_offset);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004138
4139 /**
4140 * delete_transmit_sc - delete secure connection for transmit
4141 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004142 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004143 * Returns: 0 on success, -1 on failure
4144 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004145 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004146
4147 /**
4148 * create_transmit_sa - create secure association for transmit
4149 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004150 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004151 * Returns: 0 on success, -1 on failure
4152 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004153 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);
4154
4155 /**
4156 * delete_transmit_sa - Delete secure association for transmit
4157 * @priv: Private driver interface data from init()
4158 * @sa: Secure association
4159 * Returns: 0 on success, -1 on failure
4160 */
4161 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004162
4163 /**
4164 * enable_transmit_sa - enable SA for transmit
4165 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004166 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004167 * Returns: 0 on success, -1 on failure
4168 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004169 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004170
4171 /**
4172 * disable_transmit_sa - disable SA for transmit
4173 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004174 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004175 * Returns: 0 on success, -1 on failure
4176 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004177 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004178#endif /* CONFIG_MACSEC */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004179
4180 /**
4181 * init_mesh - Driver specific initialization for mesh
4182 * @priv: Private driver interface data
4183 * Returns: 0 on success, -1 on failure
4184 */
4185 int (*init_mesh)(void *priv);
4186
4187 /**
4188 * join_mesh - Join a mesh network
4189 * @priv: Private driver interface data
4190 * @params: Mesh configuration parameters
4191 * Returns: 0 on success, -1 on failure
4192 */
4193 int (*join_mesh)(void *priv,
4194 struct wpa_driver_mesh_join_params *params);
4195
4196 /**
4197 * leave_mesh - Leave a mesh network
4198 * @priv: Private driver interface data
4199 * Returns 0 on success, -1 on failure
4200 */
4201 int (*leave_mesh)(void *priv);
4202
4203 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07004204 * probe_mesh_link - Inject a frame over direct mesh link to a given
4205 * peer skipping the next_hop lookup from mpath table.
4206 * @priv: Private driver interface data
4207 * @addr: Peer MAC address
4208 * @eth: Ethernet frame to be sent
4209 * @len: Ethernet frame lengtn in bytes
4210 * Returns 0 on success, -1 on failure
4211 */
4212 int (*probe_mesh_link)(void *priv, const u8 *addr, const u8 *eth,
4213 size_t len);
4214
4215 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004216 * do_acs - Automatically select channel
4217 * @priv: Private driver interface data
4218 * @params: Parameters for ACS
4219 * Returns 0 on success, -1 on failure
4220 *
4221 * This command can be used to offload ACS to the driver if the driver
4222 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
4223 */
4224 int (*do_acs)(void *priv, struct drv_acs_params *params);
Ravi Joshie6ccb162015-07-16 17:45:41 -07004225
4226 /**
4227 * set_band - Notify driver of band selection
4228 * @priv: Private driver interface data
4229 * @band: The selected band(s)
4230 * Returns 0 on success, -1 on failure
4231 */
4232 int (*set_band)(void *priv, enum set_band band);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004233
4234 /**
4235 * get_pref_freq_list - Get preferred frequency list for an interface
4236 * @priv: Private driver interface data
4237 * @if_type: Interface type
4238 * @num: Number of channels
4239 * @freq_list: Preferred channel frequency list encoded in MHz values
4240 * Returns 0 on success, -1 on failure
4241 *
4242 * This command can be used to query the preferred frequency list from
4243 * the driver specific to a particular interface type.
4244 */
4245 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
4246 unsigned int *num, unsigned int *freq_list);
4247
4248 /**
4249 * set_prob_oper_freq - Indicate probable P2P operating channel
4250 * @priv: Private driver interface data
4251 * @freq: Channel frequency in MHz
4252 * Returns 0 on success, -1 on failure
4253 *
4254 * This command can be used to inform the driver of the operating
4255 * frequency that an ongoing P2P group formation is likely to come up
4256 * on. Local device is assuming P2P Client role.
4257 */
4258 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004259
4260 /**
4261 * abort_scan - Request the driver to abort an ongoing scan
4262 * @priv: Private driver interface data
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004263 * @scan_cookie: Cookie identifying the scan request. This is used only
4264 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4265 * was used to trigger scan. Otherwise, 0 is used.
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004266 * Returns 0 on success, -1 on failure
4267 */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004268 int (*abort_scan)(void *priv, u64 scan_cookie);
Dmitry Shmidt849734c2016-05-27 09:59:01 -07004269
4270 /**
4271 * configure_data_frame_filters - Request to configure frame filters
4272 * @priv: Private driver interface data
4273 * @filter_flags: The type of frames to filter (bitfield of
4274 * WPA_DATA_FRAME_FILTER_FLAG_*)
4275 * Returns: 0 on success or -1 on failure
4276 */
4277 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07004278
4279 /**
4280 * get_ext_capab - Get extended capabilities for the specified interface
4281 * @priv: Private driver interface data
4282 * @type: Interface type for which to get extended capabilities
4283 * @ext_capab: Extended capabilities fetched
4284 * @ext_capab_mask: Extended capabilities mask
4285 * @ext_capab_len: Length of the extended capabilities
4286 * Returns: 0 on success or -1 on failure
4287 */
4288 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
4289 const u8 **ext_capab, const u8 **ext_capab_mask,
4290 unsigned int *ext_capab_len);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004291
4292 /**
4293 * p2p_lo_start - Start offloading P2P listen to device
4294 * @priv: Private driver interface data
4295 * @freq: Listening frequency (MHz) for P2P listen
4296 * @period: Length of the listen operation in milliseconds
4297 * @interval: Interval for running the listen operation in milliseconds
4298 * @count: Number of times to run the listen operation
4299 * @device_types: Device primary and secondary types
4300 * @dev_types_len: Number of bytes for device_types
4301 * @ies: P2P IE and WSC IE for Probe Response frames
4302 * @ies_len: Length of ies in bytes
4303 * Returns: 0 on success or -1 on failure
4304 */
4305 int (*p2p_lo_start)(void *priv, unsigned int freq,
4306 unsigned int period, unsigned int interval,
4307 unsigned int count,
4308 const u8 *device_types, size_t dev_types_len,
4309 const u8 *ies, size_t ies_len);
4310
4311 /**
4312 * p2p_lo_stop - Stop P2P listen offload
4313 * @priv: Private driver interface data
4314 * Returns: 0 on success or -1 on failure
4315 */
4316 int (*p2p_lo_stop)(void *priv);
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07004317
4318 /**
4319 * set_default_scan_ies - Set default scan IEs
4320 * @priv: Private driver interface data
4321 * @ies: Scan default IEs buffer
4322 * @ies_len: Length of IEs in bytes
4323 * Returns: 0 on success or -1 on failure
4324 *
4325 * The driver can use these by default when there are no scan IEs coming
4326 * in the subsequent scan requests. Also in case of one or more of IEs
4327 * given in set_default_scan_ies() are missing in the subsequent scan
4328 * request, the driver should merge the missing scan IEs in the scan
4329 * request from the IEs set by set_default_scan_ies() in the Probe
4330 * Request frames sent.
4331 */
4332 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
4333
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004334 /**
4335 * set_tdls_mode - Set TDLS trigger mode to the host driver
4336 * @priv: Private driver interface data
4337 * @tdls_external_control: Represents if TDLS external trigger control
4338 * mode is enabled/disabled.
4339 *
4340 * This optional callback can be used to configure the TDLS external
4341 * trigger control mode to the host driver.
4342 */
4343 int (*set_tdls_mode)(void *priv, int tdls_external_control);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004344
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004345 /**
4346 * get_bss_transition_status - Get candidate BSS's transition status
4347 * @priv: Private driver interface data
4348 * @params: Candidate BSS list
4349 *
4350 * Get the accept or reject reason code for a list of BSS transition
4351 * candidates.
4352 */
4353 struct wpa_bss_candidate_info *
4354 (*get_bss_transition_status)(void *priv,
4355 struct wpa_bss_trans_info *params);
4356 /**
4357 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
4358 * @priv: Private driver interface data
4359 * @ignore_disallow: 0 to not ignore, 1 to ignore
4360 * Returns: 0 on success, -1 on failure
4361 */
4362 int (*ignore_assoc_disallow)(void *priv, int ignore_disallow);
4363
4364 /**
4365 * set_bssid_blacklist - Set blacklist of BSSIDs to the driver
4366 * @priv: Private driver interface data
4367 * @num_bssid: Number of blacklist BSSIDs
4368 * @bssids: List of blacklisted BSSIDs
4369 */
4370 int (*set_bssid_blacklist)(void *priv, unsigned int num_bssid,
4371 const u8 *bssid);
4372
4373 /**
4374 * update_connect_params - Update the connection parameters
4375 * @priv: Private driver interface data
4376 * @params: Association parameters
4377 * @mask: Bit mask indicating which parameters in @params have to be
4378 * updated
4379 * Returns: 0 on success, -1 on failure
4380 *
4381 * Update the connection parameters when in connected state so that the
4382 * driver uses the updated parameters for subsequent roaming. This is
4383 * used only with drivers that implement internal BSS selection and
4384 * roaming.
4385 */
4386 int (*update_connect_params)(
4387 void *priv, struct wpa_driver_associate_params *params,
4388 enum wpa_drv_update_connect_params_mask mask);
Roshan Pius3a1667e2018-07-03 15:17:14 -07004389
4390 /**
4391 * send_external_auth_status - Indicate the status of external
4392 * authentication processing to the host driver.
4393 * @priv: Private driver interface data
4394 * @params: Status of authentication processing.
4395 * Returns: 0 on success, -1 on failure
4396 */
4397 int (*send_external_auth_status)(void *priv,
4398 struct external_auth *params);
Hai Shalom74f70d42019-02-11 14:42:39 -08004399
4400 /**
4401 * set_4addr_mode - Set 4-address mode
4402 * @priv: Private driver interface data
4403 * @bridge_ifname: Bridge interface name
4404 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
4405 * Returns: 0 on success, < 0 on failure
4406 */
4407 int (*set_4addr_mode)(void *priv, const char *bridge_ifname, int val);
Hai Shalom81f62d82019-07-22 12:10:00 -07004408
4409 /**
4410 * update_dh_ie - Update DH IE
4411 * @priv: Private driver interface data
4412 * @peer_mac: Peer MAC address
4413 * @reason_code: Reacon code
4414 * @ie: DH IE
4415 * @ie_len: DH IE length in bytes
4416 * Returns: 0 on success, -1 on failure
4417 *
4418 * This callback is used to let the driver know the DH processing result
4419 * and DH IE for a pending association.
4420 */
4421 int (*update_dh_ie)(void *priv, const u8 *peer_mac, u16 reason_code,
4422 const u8 *ie, size_t ie_len);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004423};
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004424
4425/**
4426 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
4427 */
4428enum wpa_event_type {
4429 /**
4430 * EVENT_ASSOC - Association completed
4431 *
4432 * This event needs to be delivered when the driver completes IEEE
4433 * 802.11 association or reassociation successfully.
4434 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
4435 * after this event has been generated. In addition, optional
4436 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
4437 * more information about the association. If the driver interface gets
4438 * both of these events at the same time, it can also include the
4439 * assoc_info data in EVENT_ASSOC call.
4440 */
4441 EVENT_ASSOC,
4442
4443 /**
4444 * EVENT_DISASSOC - Association lost
4445 *
4446 * This event should be called when association is lost either due to
4447 * receiving deauthenticate or disassociate frame from the AP or when
4448 * sending either of these frames to the current AP. If the driver
4449 * supports separate deauthentication event, EVENT_DISASSOC should only
4450 * be used for disassociation and EVENT_DEAUTH for deauthentication.
4451 * In AP mode, union wpa_event_data::disassoc_info is required.
4452 */
4453 EVENT_DISASSOC,
4454
4455 /**
4456 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
4457 *
4458 * This event must be delivered when a Michael MIC error is detected by
4459 * the local driver. Additional data for event processing is
4460 * provided with union wpa_event_data::michael_mic_failure. This
4461 * information is used to request new encyption key and to initiate
4462 * TKIP countermeasures if needed.
4463 */
4464 EVENT_MICHAEL_MIC_FAILURE,
4465
4466 /**
4467 * EVENT_SCAN_RESULTS - Scan results available
4468 *
4469 * This event must be called whenever scan results are available to be
4470 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4471 * is expected to be used some time after struct wpa_driver_ops::scan()
4472 * is called. If the driver provides an unsolicited event when the scan
4473 * has been completed, this event can be used to trigger
4474 * EVENT_SCAN_RESULTS call. If such event is not available from the
4475 * driver, the driver wrapper code is expected to use a registered
4476 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
4477 * scan is expected to be completed. Optional information about
4478 * completed scan can be provided with union wpa_event_data::scan_info.
4479 */
4480 EVENT_SCAN_RESULTS,
4481
4482 /**
4483 * EVENT_ASSOCINFO - Report optional extra information for association
4484 *
4485 * This event can be used to report extra association information for
4486 * EVENT_ASSOC processing. This extra information includes IEs from
4487 * association frames and Beacon/Probe Response frames in union
4488 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4489 * EVENT_ASSOC. Alternatively, the driver interface can include
4490 * assoc_info data in the EVENT_ASSOC call if it has all the
4491 * information available at the same point.
4492 */
4493 EVENT_ASSOCINFO,
4494
4495 /**
4496 * EVENT_INTERFACE_STATUS - Report interface status changes
4497 *
4498 * This optional event can be used to report changes in interface
4499 * status (interface added/removed) using union
4500 * wpa_event_data::interface_status. This can be used to trigger
4501 * wpa_supplicant to stop and re-start processing for the interface,
4502 * e.g., when a cardbus card is ejected/inserted.
4503 */
4504 EVENT_INTERFACE_STATUS,
4505
4506 /**
4507 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4508 *
4509 * This event can be used to inform wpa_supplicant about candidates for
4510 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4511 * for scan request (ap_scan=2 mode), this event is required for
4512 * pre-authentication. If wpa_supplicant is performing scan request
4513 * (ap_scan=1), this event is optional since scan results can be used
4514 * to add pre-authentication candidates. union
4515 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4516 * candidate and priority of the candidate, e.g., based on the signal
4517 * strength, in order to try to pre-authenticate first with candidates
4518 * that are most likely targets for re-association.
4519 *
4520 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4521 * on the candidate list. In addition, it can be called for the current
4522 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4523 * will automatically skip pre-authentication in cases where a valid
4524 * PMKSA exists. When more than one candidate exists, this event should
4525 * be generated once for each candidate.
4526 *
4527 * Driver will be notified about successful pre-authentication with
4528 * struct wpa_driver_ops::add_pmkid() calls.
4529 */
4530 EVENT_PMKID_CANDIDATE,
4531
4532 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004533 * EVENT_TDLS - Request TDLS operation
4534 *
4535 * This event can be used to request a TDLS operation to be performed.
4536 */
4537 EVENT_TDLS,
4538
4539 /**
4540 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4541 *
4542 * The driver is expected to report the received FT IEs from
4543 * FT authentication sequence from the AP. The FT IEs are included in
4544 * the extra information in union wpa_event_data::ft_ies.
4545 */
4546 EVENT_FT_RESPONSE,
4547
4548 /**
4549 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4550 *
4551 * The driver can use this event to inform wpa_supplicant about a STA
4552 * in an IBSS with which protected frames could be exchanged. This
4553 * event starts RSN authentication with the other STA to authenticate
4554 * the STA and set up encryption keys with it.
4555 */
4556 EVENT_IBSS_RSN_START,
4557
4558 /**
4559 * EVENT_AUTH - Authentication result
4560 *
4561 * This event should be called when authentication attempt has been
4562 * completed. This is only used if the driver supports separate
4563 * authentication step (struct wpa_driver_ops::authenticate).
4564 * Information about authentication result is included in
4565 * union wpa_event_data::auth.
4566 */
4567 EVENT_AUTH,
4568
4569 /**
4570 * EVENT_DEAUTH - Authentication lost
4571 *
4572 * This event should be called when authentication is lost either due
4573 * to receiving deauthenticate frame from the AP or when sending that
4574 * frame to the current AP.
4575 * In AP mode, union wpa_event_data::deauth_info is required.
4576 */
4577 EVENT_DEAUTH,
4578
4579 /**
4580 * EVENT_ASSOC_REJECT - Association rejected
4581 *
4582 * This event should be called when (re)association attempt has been
4583 * rejected by the AP. Information about the association response is
4584 * included in union wpa_event_data::assoc_reject.
4585 */
4586 EVENT_ASSOC_REJECT,
4587
4588 /**
4589 * EVENT_AUTH_TIMED_OUT - Authentication timed out
4590 */
4591 EVENT_AUTH_TIMED_OUT,
4592
4593 /**
4594 * EVENT_ASSOC_TIMED_OUT - Association timed out
4595 */
4596 EVENT_ASSOC_TIMED_OUT,
4597
4598 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004599 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
4600 */
4601 EVENT_WPS_BUTTON_PUSHED,
4602
4603 /**
4604 * EVENT_TX_STATUS - Report TX status
4605 */
4606 EVENT_TX_STATUS,
4607
4608 /**
4609 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
4610 */
4611 EVENT_RX_FROM_UNKNOWN,
4612
4613 /**
4614 * EVENT_RX_MGMT - Report RX of a management frame
4615 */
4616 EVENT_RX_MGMT,
4617
4618 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004619 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
4620 *
4621 * This event is used to indicate when the driver has started the
4622 * requested remain-on-channel duration. Information about the
4623 * operation is included in union wpa_event_data::remain_on_channel.
4624 */
4625 EVENT_REMAIN_ON_CHANNEL,
4626
4627 /**
4628 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
4629 *
4630 * This event is used to indicate when the driver has completed
4631 * remain-on-channel duration, i.e., may noot be available on the
4632 * requested channel anymore. Information about the
4633 * operation is included in union wpa_event_data::remain_on_channel.
4634 */
4635 EVENT_CANCEL_REMAIN_ON_CHANNEL,
4636
4637 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004638 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
4639 *
4640 * This event is used to indicate when a Probe Request frame has been
4641 * received. Information about the received frame is included in
4642 * union wpa_event_data::rx_probe_req. The driver is required to report
4643 * these events only after successfully completed probe_req_report()
4644 * commands to request the events (i.e., report parameter is non-zero)
4645 * in station mode. In AP mode, Probe Request frames should always be
4646 * reported.
4647 */
4648 EVENT_RX_PROBE_REQ,
4649
4650 /**
4651 * EVENT_NEW_STA - New wired device noticed
4652 *
4653 * This event is used to indicate that a new device has been detected
4654 * in a network that does not use association-like functionality (i.e.,
4655 * mainly wired Ethernet). This can be used to start EAPOL
4656 * authenticator when receiving a frame from a device. The address of
4657 * the device is included in union wpa_event_data::new_sta.
4658 */
4659 EVENT_NEW_STA,
4660
4661 /**
4662 * EVENT_EAPOL_RX - Report received EAPOL frame
4663 *
4664 * When in AP mode with hostapd, this event is required to be used to
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004665 * deliver the receive EAPOL frames from the driver.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004666 */
4667 EVENT_EAPOL_RX,
4668
4669 /**
4670 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4671 *
4672 * This event is used to indicate changes in the signal strength
4673 * observed in frames received from the current AP if signal strength
4674 * monitoring has been enabled with signal_monitor().
4675 */
4676 EVENT_SIGNAL_CHANGE,
4677
4678 /**
4679 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4680 *
4681 * This event is used to indicate that the interface was enabled after
4682 * having been previously disabled, e.g., due to rfkill.
4683 */
4684 EVENT_INTERFACE_ENABLED,
4685
4686 /**
4687 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4688 *
4689 * This event is used to indicate that the interface was disabled,
4690 * e.g., due to rfkill.
4691 */
4692 EVENT_INTERFACE_DISABLED,
4693
4694 /**
4695 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4696 *
4697 * This event is used to indicate that the channel list has changed,
4698 * e.g., because of a regulatory domain change triggered by scan
4699 * results including an AP advertising a country code.
4700 */
4701 EVENT_CHANNEL_LIST_CHANGED,
4702
4703 /**
4704 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4705 *
4706 * This event is used to indicate that the driver cannot maintain this
4707 * interface in its operation mode anymore. The most likely use for
4708 * this is to indicate that AP mode operation is not available due to
4709 * operating channel would need to be changed to a DFS channel when
4710 * the driver does not support radar detection and another virtual
4711 * interfaces caused the operating channel to change. Other similar
4712 * resource conflicts could also trigger this for station mode
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07004713 * interfaces. This event can be propagated when channel switching
4714 * fails.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004715 */
4716 EVENT_INTERFACE_UNAVAILABLE,
4717
4718 /**
4719 * EVENT_BEST_CHANNEL
4720 *
4721 * Driver generates this event whenever it detects a better channel
4722 * (e.g., based on RSSI or channel use). This information can be used
4723 * to improve channel selection for a new AP/P2P group.
4724 */
4725 EVENT_BEST_CHANNEL,
4726
4727 /**
4728 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4729 *
4730 * This event should be called when a Deauthentication frame is dropped
4731 * due to it not being protected (MFP/IEEE 802.11w).
4732 * union wpa_event_data::unprot_deauth is required to provide more
4733 * details of the frame.
4734 */
4735 EVENT_UNPROT_DEAUTH,
4736
4737 /**
4738 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4739 *
4740 * This event should be called when a Disassociation frame is dropped
4741 * due to it not being protected (MFP/IEEE 802.11w).
4742 * union wpa_event_data::unprot_disassoc is required to provide more
4743 * details of the frame.
4744 */
4745 EVENT_UNPROT_DISASSOC,
4746
4747 /**
4748 * EVENT_STATION_LOW_ACK
4749 *
4750 * Driver generates this event whenever it detected that a particular
4751 * station was lost. Detection can be through massive transmission
4752 * failures for example.
4753 */
4754 EVENT_STATION_LOW_ACK,
4755
4756 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004757 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4758 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004759 EVENT_IBSS_PEER_LOST,
4760
4761 /**
4762 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4763 *
4764 * This event carries the new replay counter to notify wpa_supplicant
4765 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4766 * completed Group Key Handshake while the host (including
4767 * wpa_supplicant was sleeping).
4768 */
4769 EVENT_DRIVER_GTK_REKEY,
4770
4771 /**
4772 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4773 */
4774 EVENT_SCHED_SCAN_STOPPED,
4775
4776 /**
4777 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4778 *
4779 * This event indicates that the station responded to the poll
4780 * initiated with @poll_client.
4781 */
4782 EVENT_DRIVER_CLIENT_POLL_OK,
4783
4784 /**
4785 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4786 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07004787 EVENT_EAPOL_TX_STATUS,
4788
4789 /**
4790 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4791 *
4792 * Described in wpa_event_data.ch_switch
4793 * */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004794 EVENT_CH_SWITCH,
4795
4796 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07004797 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
4798 *
4799 * This is a pre-switch event indicating the shortly following switch
4800 * of operating channels.
4801 *
4802 * Described in wpa_event_data.ch_switch
4803 */
4804 EVENT_CH_SWITCH_STARTED,
4805 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004806 * EVENT_WNM - Request WNM operation
4807 *
4808 * This event can be used to request a WNM operation to be performed.
4809 */
Dmitry Shmidtf8623282013-02-20 14:34:59 -08004810 EVENT_WNM,
4811
4812 /**
4813 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4814 *
4815 * This event indicates that the driver reported a connection failure
4816 * with the specified client (for example, max client reached, etc.) in
4817 * AP mode.
4818 */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004819 EVENT_CONNECT_FAILED_REASON,
4820
4821 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004822 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004823 *
4824 * A radar has been detected on the supplied frequency, hostapd should
4825 * react accordingly (e.g., change channel).
4826 */
4827 EVENT_DFS_RADAR_DETECTED,
4828
4829 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004830 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004831 *
4832 * After a successful CAC, the channel can be marked clear and used.
4833 */
4834 EVENT_DFS_CAC_FINISHED,
4835
4836 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004837 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004838 *
4839 * The CAC was not successful, and the channel remains in the previous
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004840 * state. This may happen due to a radar being detected or other
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004841 * external influences.
4842 */
4843 EVENT_DFS_CAC_ABORTED,
4844
4845 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004846 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004847 *
4848 * The channel which was previously unavailable is now available again.
4849 */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004850 EVENT_DFS_NOP_FINISHED,
4851
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08004852 /**
4853 * EVENT_SURVEY - Received survey data
4854 *
4855 * This event gets triggered when a driver query is issued for survey
4856 * data and the requested data becomes available. The returned data is
4857 * stored in struct survey_results. The results provide at most one
4858 * survey entry for each frequency and at minimum will provide one
4859 * survey entry for one frequency. The survey data can be os_malloc()'d
4860 * and then os_free()'d, so the event callback must only copy data.
4861 */
4862 EVENT_SURVEY,
4863
4864 /**
4865 * EVENT_SCAN_STARTED - Scan started
4866 *
4867 * This indicates that driver has started a scan operation either based
4868 * on a request from wpa_supplicant/hostapd or from another application.
4869 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4870 * completed (either successfully or by getting cancelled).
4871 */
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08004872 EVENT_SCAN_STARTED,
4873
4874 /**
4875 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4876 *
4877 * This event indicates a set of frequency ranges that should be avoided
4878 * to reduce issues due to interference or internal co-existence
4879 * information in the driver.
4880 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004881 EVENT_AVOID_FREQUENCIES,
4882
4883 /**
4884 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4885 */
4886 EVENT_NEW_PEER_CANDIDATE,
4887
4888 /**
4889 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4890 *
4891 * Indicates a pair of primary and secondary channels chosen by ACS
4892 * in device.
4893 */
4894 EVENT_ACS_CHANNEL_SELECTED,
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004895
4896 /**
4897 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4898 * been started.
4899 *
4900 * This event indicates that channel availability check has been started
4901 * on a DFS frequency by a driver that supports DFS Offload.
4902 */
4903 EVENT_DFS_CAC_STARTED,
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004904
4905 /**
4906 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4907 */
4908 EVENT_P2P_LO_STOP,
Paul Stewart092955c2017-02-06 09:13:09 -08004909
4910 /**
4911 * EVENT_BEACON_LOSS - Beacon loss detected
4912 *
4913 * This event indicates that no Beacon frames has been received from
4914 * the current AP. This may indicate that the AP is not anymore in
4915 * range.
4916 */
4917 EVENT_BEACON_LOSS,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004918
4919 /**
4920 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
4921 * done previously (Pre-CAC) on the channel has expired. This would
4922 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
4923 * channel will be moved from available to usable. A new CAC has to be
4924 * performed before start operating on this channel.
4925 */
4926 EVENT_DFS_PRE_CAC_EXPIRED,
Roshan Pius3a1667e2018-07-03 15:17:14 -07004927
4928 /**
4929 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
4930 * that do not define separate commands for authentication and
4931 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
4932 * authentication to wpa_supplicant. This event carries all the
4933 * necessary information from the host driver for the authentication to
4934 * happen.
4935 */
4936 EVENT_EXTERNAL_AUTH,
4937
4938 /**
4939 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
4940 *
4941 * This event should be indicated when the driver completes the 4-way
4942 * handshake. This event should be preceded by an EVENT_ASSOC that
4943 * indicates the completion of IEEE 802.11 association.
4944 */
4945 EVENT_PORT_AUTHORIZED,
4946
4947 /**
4948 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
4949 * change event.
4950 */
4951 EVENT_STATION_OPMODE_CHANGED,
4952
4953 /**
4954 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
4955 *
4956 * This event is emitted when the MAC changes while the interface is
4957 * enabled. When an interface was disabled and becomes enabled, it
4958 * must be always assumed that the MAC possibly changed.
4959 */
4960 EVENT_INTERFACE_MAC_CHANGED,
4961
4962 /**
4963 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
4964 *
4965 * This event is emitted when an interface is added/removed for WDS STA.
4966 */
4967 EVENT_WDS_STA_INTERFACE_STATUS,
Hai Shalom81f62d82019-07-22 12:10:00 -07004968
4969 /**
4970 * EVENT_UPDATE_DH - Notification of updated DH information
4971 */
4972 EVENT_UPDATE_DH,
Hai Shalomfdcde762020-04-02 11:19:20 -07004973
4974 /**
4975 * EVENT_UNPROT_BEACON - Unprotected Beacon frame received
4976 *
4977 * This event should be called when a Beacon frame is dropped due to it
4978 * not being protected correctly. union wpa_event_data::unprot_beacon
4979 * is required to provide more details of the frame.
4980 */
4981 EVENT_UNPROT_BEACON,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004982};
4983
4984
4985/**
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004986 * struct freq_survey - Channel survey info
4987 *
4988 * @ifidx: Interface index in which this survey was observed
4989 * @freq: Center of frequency of the surveyed channel
4990 * @nf: Channel noise floor in dBm
4991 * @channel_time: Amount of time in ms the radio spent on the channel
4992 * @channel_time_busy: Amount of time in ms the radio detected some signal
4993 * that indicated to the radio the channel was not clear
4994 * @channel_time_rx: Amount of time the radio spent receiving data
4995 * @channel_time_tx: Amount of time the radio spent transmitting data
4996 * @filled: bitmask indicating which fields have been reported, see
4997 * SURVEY_HAS_* defines.
4998 * @list: Internal list pointers
4999 */
5000struct freq_survey {
5001 u32 ifidx;
5002 unsigned int freq;
5003 s8 nf;
5004 u64 channel_time;
5005 u64 channel_time_busy;
5006 u64 channel_time_rx;
5007 u64 channel_time_tx;
5008 unsigned int filled;
5009 struct dl_list list;
5010};
5011
5012#define SURVEY_HAS_NF BIT(0)
5013#define SURVEY_HAS_CHAN_TIME BIT(1)
5014#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
5015#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
5016#define SURVEY_HAS_CHAN_TIME_TX BIT(4)
5017
5018
5019/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005020 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
5021 */
5022union wpa_event_data {
5023 /**
5024 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
5025 *
5026 * This structure is optional for EVENT_ASSOC calls and required for
5027 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
5028 * driver interface does not need to generate separate EVENT_ASSOCINFO
5029 * calls.
5030 */
5031 struct assoc_info {
5032 /**
5033 * reassoc - Flag to indicate association or reassociation
5034 */
5035 int reassoc;
5036
5037 /**
5038 * req_ies - (Re)Association Request IEs
5039 *
5040 * If the driver generates WPA/RSN IE, this event data must be
5041 * returned for WPA handshake to have needed information. If
5042 * wpa_supplicant-generated WPA/RSN IE is used, this
5043 * information event is optional.
5044 *
5045 * This should start with the first IE (fixed fields before IEs
5046 * are not included).
5047 */
5048 const u8 *req_ies;
5049
5050 /**
5051 * req_ies_len - Length of req_ies in bytes
5052 */
5053 size_t req_ies_len;
5054
5055 /**
5056 * resp_ies - (Re)Association Response IEs
5057 *
5058 * Optional association data from the driver. This data is not
5059 * required WPA, but may be useful for some protocols and as
5060 * such, should be reported if this is available to the driver
5061 * interface.
5062 *
5063 * This should start with the first IE (fixed fields before IEs
5064 * are not included).
5065 */
5066 const u8 *resp_ies;
5067
5068 /**
5069 * resp_ies_len - Length of resp_ies in bytes
5070 */
5071 size_t resp_ies_len;
5072
5073 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08005074 * resp_frame - (Re)Association Response frame
5075 */
5076 const u8 *resp_frame;
5077
5078 /**
5079 * resp_frame_len - (Re)Association Response frame length
5080 */
5081 size_t resp_frame_len;
5082
5083 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005084 * beacon_ies - Beacon or Probe Response IEs
5085 *
5086 * Optional Beacon/ProbeResp data: IEs included in Beacon or
5087 * Probe Response frames from the current AP (i.e., the one
5088 * that the client just associated with). This information is
5089 * used to update WPA/RSN IE for the AP. If this field is not
5090 * set, the results from previous scan will be used. If no
5091 * data for the new AP is found, scan results will be requested
5092 * again (without scan request). At this point, the driver is
5093 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
5094 * used).
5095 *
5096 * This should start with the first IE (fixed fields before IEs
5097 * are not included).
5098 */
5099 const u8 *beacon_ies;
5100
5101 /**
5102 * beacon_ies_len - Length of beacon_ies */
5103 size_t beacon_ies_len;
5104
5105 /**
5106 * freq - Frequency of the operational channel in MHz
5107 */
5108 unsigned int freq;
5109
5110 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005111 * wmm_params - WMM parameters used in this association.
5112 */
5113 struct wmm_params wmm_params;
5114
5115 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005116 * addr - Station address (for AP mode)
5117 */
5118 const u8 *addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005119
5120 /**
5121 * The following is the key management offload information
5122 * @authorized
5123 * @key_replay_ctr
5124 * @key_replay_ctr_len
5125 * @ptk_kck
5126 * @ptk_kek_len
5127 * @ptk_kek
5128 * @ptk_kek_len
5129 */
5130
5131 /**
5132 * authorized - Status of key management offload,
5133 * 1 = successful
5134 */
5135 int authorized;
5136
5137 /**
5138 * key_replay_ctr - Key replay counter value last used
5139 * in a valid EAPOL-Key frame
5140 */
5141 const u8 *key_replay_ctr;
5142
5143 /**
5144 * key_replay_ctr_len - The length of key_replay_ctr
5145 */
5146 size_t key_replay_ctr_len;
5147
5148 /**
5149 * ptk_kck - The derived PTK KCK
5150 */
5151 const u8 *ptk_kck;
5152
5153 /**
5154 * ptk_kek_len - The length of ptk_kck
5155 */
5156 size_t ptk_kck_len;
5157
5158 /**
5159 * ptk_kek - The derived PTK KEK
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005160 * This is used in key management offload and also in FILS SK
5161 * offload.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005162 */
5163 const u8 *ptk_kek;
5164
5165 /**
5166 * ptk_kek_len - The length of ptk_kek
5167 */
5168 size_t ptk_kek_len;
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08005169
5170 /**
5171 * subnet_status - The subnet status:
5172 * 0 = unknown, 1 = unchanged, 2 = changed
5173 */
5174 u8 subnet_status;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005175
5176 /**
5177 * The following information is used in FILS SK offload
5178 * @fils_erp_next_seq_num
5179 * @fils_pmk
5180 * @fils_pmk_len
5181 * @fils_pmkid
5182 */
5183
5184 /**
5185 * fils_erp_next_seq_num - The next sequence number to use in
5186 * FILS ERP messages
5187 */
5188 u16 fils_erp_next_seq_num;
5189
5190 /**
5191 * fils_pmk - A new PMK if generated in case of FILS
5192 * authentication
5193 */
5194 const u8 *fils_pmk;
5195
5196 /**
5197 * fils_pmk_len - Length of fils_pmk
5198 */
5199 size_t fils_pmk_len;
5200
5201 /**
5202 * fils_pmkid - PMKID used or generated in FILS authentication
5203 */
5204 const u8 *fils_pmkid;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005205 } assoc_info;
5206
5207 /**
5208 * struct disassoc_info - Data for EVENT_DISASSOC events
5209 */
5210 struct disassoc_info {
5211 /**
5212 * addr - Station address (for AP mode)
5213 */
5214 const u8 *addr;
5215
5216 /**
5217 * reason_code - Reason Code (host byte order) used in
5218 * Deauthentication frame
5219 */
5220 u16 reason_code;
5221
5222 /**
5223 * ie - Optional IE(s) in Disassociation frame
5224 */
5225 const u8 *ie;
5226
5227 /**
5228 * ie_len - Length of ie buffer in octets
5229 */
5230 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005231
5232 /**
5233 * locally_generated - Whether the frame was locally generated
5234 */
5235 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005236 } disassoc_info;
5237
5238 /**
5239 * struct deauth_info - Data for EVENT_DEAUTH events
5240 */
5241 struct deauth_info {
5242 /**
5243 * addr - Station address (for AP mode)
5244 */
5245 const u8 *addr;
5246
5247 /**
5248 * reason_code - Reason Code (host byte order) used in
5249 * Deauthentication frame
5250 */
5251 u16 reason_code;
5252
5253 /**
5254 * ie - Optional IE(s) in Deauthentication frame
5255 */
5256 const u8 *ie;
5257
5258 /**
5259 * ie_len - Length of ie buffer in octets
5260 */
5261 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005262
5263 /**
5264 * locally_generated - Whether the frame was locally generated
5265 */
5266 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005267 } deauth_info;
5268
5269 /**
5270 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
5271 */
5272 struct michael_mic_failure {
5273 int unicast;
5274 const u8 *src;
5275 } michael_mic_failure;
5276
5277 /**
5278 * struct interface_status - Data for EVENT_INTERFACE_STATUS
5279 */
5280 struct interface_status {
Dmitry Shmidte4663042016-04-04 10:07:49 -07005281 unsigned int ifindex;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005282 char ifname[100];
5283 enum {
5284 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
5285 } ievent;
5286 } interface_status;
5287
5288 /**
5289 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
5290 */
5291 struct pmkid_candidate {
5292 /** BSSID of the PMKID candidate */
5293 u8 bssid[ETH_ALEN];
5294 /** Smaller the index, higher the priority */
5295 int index;
5296 /** Whether RSN IE includes pre-authenticate flag */
5297 int preauth;
5298 } pmkid_candidate;
5299
5300 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005301 * struct tdls - Data for EVENT_TDLS
5302 */
5303 struct tdls {
5304 u8 peer[ETH_ALEN];
5305 enum {
5306 TDLS_REQUEST_SETUP,
Dmitry Shmidt4dd28dc2015-03-10 11:21:43 -07005307 TDLS_REQUEST_TEARDOWN,
5308 TDLS_REQUEST_DISCOVER,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005309 } oper;
5310 u16 reason_code; /* for teardown */
5311 } tdls;
5312
5313 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07005314 * struct wnm - Data for EVENT_WNM
5315 */
5316 struct wnm {
5317 u8 addr[ETH_ALEN];
5318 enum {
5319 WNM_OPER_SLEEP,
5320 } oper;
5321 enum {
5322 WNM_SLEEP_ENTER,
5323 WNM_SLEEP_EXIT
5324 } sleep_action;
5325 int sleep_intval;
5326 u16 reason_code;
5327 u8 *buf;
5328 u16 buf_len;
5329 } wnm;
5330
5331 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005332 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
5333 *
5334 * During FT (IEEE 802.11r) authentication sequence, the driver is
5335 * expected to use this event to report received FT IEs (MDIE, FTIE,
5336 * RSN IE, TIE, possible resource request) to the supplicant. The FT
5337 * IEs for the next message will be delivered through the
5338 * struct wpa_driver_ops::update_ft_ies() callback.
5339 */
5340 struct ft_ies {
5341 const u8 *ies;
5342 size_t ies_len;
5343 int ft_action;
5344 u8 target_ap[ETH_ALEN];
5345 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
5346 const u8 *ric_ies;
5347 /** Length of ric_ies buffer in octets */
5348 size_t ric_ies_len;
5349 } ft_ies;
5350
5351 /**
5352 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
5353 */
5354 struct ibss_rsn_start {
5355 u8 peer[ETH_ALEN];
5356 } ibss_rsn_start;
5357
5358 /**
5359 * struct auth_info - Data for EVENT_AUTH events
5360 */
5361 struct auth_info {
5362 u8 peer[ETH_ALEN];
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005363 u8 bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005364 u16 auth_type;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005365 u16 auth_transaction;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005366 u16 status_code;
5367 const u8 *ies;
5368 size_t ies_len;
5369 } auth;
5370
5371 /**
5372 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
5373 */
5374 struct assoc_reject {
5375 /**
5376 * bssid - BSSID of the AP that rejected association
5377 */
5378 const u8 *bssid;
5379
5380 /**
5381 * resp_ies - (Re)Association Response IEs
5382 *
5383 * Optional association data from the driver. This data is not
5384 * required WPA, but may be useful for some protocols and as
5385 * such, should be reported if this is available to the driver
5386 * interface.
5387 *
5388 * This should start with the first IE (fixed fields before IEs
5389 * are not included).
5390 */
5391 const u8 *resp_ies;
5392
5393 /**
5394 * resp_ies_len - Length of resp_ies in bytes
5395 */
5396 size_t resp_ies_len;
5397
5398 /**
5399 * status_code - Status Code from (Re)association Response
5400 */
5401 u16 status_code;
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07005402
5403 /**
5404 * timed_out - Whether failure is due to timeout (etc.) rather
5405 * than explicit rejection response from the AP.
5406 */
5407 int timed_out;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08005408
5409 /**
5410 * timeout_reason - Reason for the timeout
5411 */
5412 const char *timeout_reason;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005413
5414 /**
5415 * fils_erp_next_seq_num - The next sequence number to use in
5416 * FILS ERP messages
5417 */
5418 u16 fils_erp_next_seq_num;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005419 } assoc_reject;
5420
5421 struct timeout_event {
5422 u8 addr[ETH_ALEN];
5423 } timeout_event;
5424
5425 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005426 * struct tx_status - Data for EVENT_TX_STATUS events
5427 */
5428 struct tx_status {
5429 u16 type;
5430 u16 stype;
5431 const u8 *dst;
5432 const u8 *data;
5433 size_t data_len;
5434 int ack;
5435 } tx_status;
5436
5437 /**
5438 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
5439 */
5440 struct rx_from_unknown {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005441 const u8 *bssid;
5442 const u8 *addr;
5443 int wds;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005444 } rx_from_unknown;
5445
5446 /**
5447 * struct rx_mgmt - Data for EVENT_RX_MGMT events
5448 */
5449 struct rx_mgmt {
5450 const u8 *frame;
5451 size_t frame_len;
5452 u32 datarate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005453
5454 /**
Dmitry Shmidt98660862014-03-11 17:26:21 -07005455 * drv_priv - Pointer to store driver private BSS information
5456 *
5457 * If not set to NULL, this is used for comparison with
5458 * hostapd_data->drv_priv to determine which BSS should process
5459 * the frame.
5460 */
5461 void *drv_priv;
5462
5463 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005464 * freq - Frequency (in MHz) on which the frame was received
5465 */
5466 int freq;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005467
5468 /**
5469 * ssi_signal - Signal strength in dBm (or 0 if not available)
5470 */
5471 int ssi_signal;
5472 } rx_mgmt;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005473
5474 /**
5475 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
5476 *
5477 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
5478 */
5479 struct remain_on_channel {
5480 /**
5481 * freq - Channel frequency in MHz
5482 */
5483 unsigned int freq;
5484
5485 /**
5486 * duration - Duration to remain on the channel in milliseconds
5487 */
5488 unsigned int duration;
5489 } remain_on_channel;
5490
5491 /**
5492 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
5493 * @aborted: Whether the scan was aborted
5494 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
5495 * @num_freqs: Number of entries in freqs array
5496 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
5497 * SSID)
5498 * @num_ssids: Number of entries in ssids array
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08005499 * @external_scan: Whether the scan info is for an external scan
5500 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
5501 * 0 if the source of the scan event is a vendor scan
Dmitry Shmidt29333592017-01-09 12:27:11 -08005502 * @scan_start_tsf: Time when the scan started in terms of TSF of the
5503 * BSS that the interface that requested the scan is connected to
5504 * (if available).
5505 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
5506 * is set.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005507 */
5508 struct scan_info {
5509 int aborted;
5510 const int *freqs;
5511 size_t num_freqs;
5512 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
5513 size_t num_ssids;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08005514 int external_scan;
5515 int nl_scan_event;
Dmitry Shmidt29333592017-01-09 12:27:11 -08005516 u64 scan_start_tsf;
5517 u8 scan_start_tsf_bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005518 } scan_info;
5519
5520 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005521 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
5522 */
5523 struct rx_probe_req {
5524 /**
5525 * sa - Source address of the received Probe Request frame
5526 */
5527 const u8 *sa;
5528
5529 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005530 * da - Destination address of the received Probe Request frame
5531 * or %NULL if not available
5532 */
5533 const u8 *da;
5534
5535 /**
5536 * bssid - BSSID of the received Probe Request frame or %NULL
5537 * if not available
5538 */
5539 const u8 *bssid;
5540
5541 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005542 * ie - IEs from the Probe Request body
5543 */
5544 const u8 *ie;
5545
5546 /**
5547 * ie_len - Length of ie buffer in octets
5548 */
5549 size_t ie_len;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005550
5551 /**
5552 * signal - signal strength in dBm (or 0 if not available)
5553 */
5554 int ssi_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005555 } rx_probe_req;
5556
5557 /**
5558 * struct new_sta - Data for EVENT_NEW_STA events
5559 */
5560 struct new_sta {
5561 const u8 *addr;
5562 } new_sta;
5563
5564 /**
5565 * struct eapol_rx - Data for EVENT_EAPOL_RX events
5566 */
5567 struct eapol_rx {
5568 const u8 *src;
5569 const u8 *data;
5570 size_t data_len;
5571 } eapol_rx;
5572
5573 /**
5574 * signal_change - Data for EVENT_SIGNAL_CHANGE events
5575 */
5576 struct wpa_signal_info signal_change;
5577
5578 /**
5579 * struct best_channel - Data for EVENT_BEST_CHANNEL events
5580 * @freq_24: Best 2.4 GHz band channel frequency in MHz
5581 * @freq_5: Best 5 GHz band channel frequency in MHz
5582 * @freq_overall: Best channel frequency in MHz
5583 *
5584 * 0 can be used to indicate no preference in either band.
5585 */
5586 struct best_channel {
5587 int freq_24;
5588 int freq_5;
5589 int freq_overall;
5590 } best_chan;
5591
5592 struct unprot_deauth {
5593 const u8 *sa;
5594 const u8 *da;
5595 u16 reason_code;
5596 } unprot_deauth;
5597
5598 struct unprot_disassoc {
5599 const u8 *sa;
5600 const u8 *da;
5601 u16 reason_code;
5602 } unprot_disassoc;
5603
5604 /**
5605 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
5606 * @addr: station address
Paul Stewart092955c2017-02-06 09:13:09 -08005607 * @num_packets: Number of packets lost (consecutive packets not
5608 * acknowledged)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005609 */
5610 struct low_ack {
5611 u8 addr[ETH_ALEN];
Paul Stewart092955c2017-02-06 09:13:09 -08005612 u32 num_packets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005613 } low_ack;
5614
5615 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005616 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
5617 */
5618 struct ibss_peer_lost {
5619 u8 peer[ETH_ALEN];
5620 } ibss_peer_lost;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005621
5622 /**
5623 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
5624 */
5625 struct driver_gtk_rekey {
5626 const u8 *bssid;
5627 const u8 *replay_ctr;
5628 } driver_gtk_rekey;
5629
5630 /**
5631 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
5632 * @addr: station address
5633 */
5634 struct client_poll {
5635 u8 addr[ETH_ALEN];
5636 } client_poll;
5637
5638 /**
5639 * struct eapol_tx_status
5640 * @dst: Original destination
5641 * @data: Data starting with IEEE 802.1X header (!)
5642 * @data_len: Length of data
5643 * @ack: Indicates ack or lost frame
5644 *
5645 * This corresponds to hapd_send_eapol if the frame sent
5646 * there isn't just reported as EVENT_TX_STATUS.
5647 */
5648 struct eapol_tx_status {
5649 const u8 *dst;
5650 const u8 *data;
5651 int data_len;
5652 int ack;
5653 } eapol_tx_status;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005654
5655 /**
5656 * struct ch_switch
5657 * @freq: Frequency of new channel in MHz
5658 * @ht_enabled: Whether this is an HT channel
5659 * @ch_offset: Secondary channel offset
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08005660 * @ch_width: Channel width
5661 * @cf1: Center frequency 1
5662 * @cf2: Center frequency 2
Dmitry Shmidt04949592012-07-19 12:16:46 -07005663 */
5664 struct ch_switch {
5665 int freq;
5666 int ht_enabled;
5667 int ch_offset;
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08005668 enum chan_width ch_width;
5669 int cf1;
5670 int cf2;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005671 } ch_switch;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08005672
5673 /**
5674 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
5675 * @addr: Remote client address
5676 * @code: Reason code for connection failure
5677 */
5678 struct connect_failed_reason {
5679 u8 addr[ETH_ALEN];
5680 enum {
5681 MAX_CLIENT_REACHED,
5682 BLOCKED_CLIENT
5683 } code;
5684 } connect_failed_reason;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005685
5686 /**
5687 * struct dfs_event - Data for radar detected events
5688 * @freq: Frequency of the channel in MHz
5689 */
5690 struct dfs_event {
5691 int freq;
Dmitry Shmidt051af732013-10-22 13:52:46 -07005692 int ht_enabled;
5693 int chan_offset;
5694 enum chan_width chan_width;
5695 int cf1;
5696 int cf2;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005697 } dfs_event;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005698
5699 /**
5700 * survey_results - Survey result data for EVENT_SURVEY
5701 * @freq_filter: Requested frequency survey filter, 0 if request
5702 * was for all survey data
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005703 * @survey_list: Linked list of survey data (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005704 */
5705 struct survey_results {
5706 unsigned int freq_filter;
5707 struct dl_list survey_list; /* struct freq_survey */
5708 } survey_results;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005709
5710 /**
5711 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
5712 * @initiator: Initiator of the regulatory change
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07005713 * @type: Regulatory change type
5714 * @alpha2: Country code (or "" if not available)
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005715 */
5716 struct channel_list_changed {
5717 enum reg_change_initiator initiator;
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07005718 enum reg_type type;
5719 char alpha2[3];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005720 } channel_list_changed;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08005721
5722 /**
5723 * freq_range - List of frequency ranges
5724 *
5725 * This is used as the data with EVENT_AVOID_FREQUENCIES.
5726 */
5727 struct wpa_freq_range_list freq_range;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005728
5729 /**
5730 * struct mesh_peer
5731 *
5732 * @peer: Peer address
5733 * @ies: Beacon IEs
5734 * @ie_len: Length of @ies
5735 *
5736 * Notification of new candidate mesh peer.
5737 */
5738 struct mesh_peer {
5739 const u8 *peer;
5740 const u8 *ies;
5741 size_t ie_len;
5742 } mesh_peer;
5743
5744 /**
5745 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08005746 * @pri_freq: Selected primary frequency
5747 * @sec_freq: Selected secondary frequency
Hai Shalomfdcde762020-04-02 11:19:20 -07005748 * @edmg_channel: Selected EDMG channel
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005749 * @vht_seg0_center_ch: VHT mode Segment0 center channel
Hai Shalomfdcde762020-04-02 11:19:20 -07005750 * The value is the index of the channel center frequency for
5751 * 20 MHz, 40 MHz, and 80 MHz channels. The value is the center
5752 * frequency index of the primary 80 MHz segment for 160 MHz and
5753 * 80+80 MHz channels.
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005754 * @vht_seg1_center_ch: VHT mode Segment1 center channel
Hai Shalomfdcde762020-04-02 11:19:20 -07005755 * The value is zero for 20 MHz, 40 MHz, and 80 MHz channels. The
5756 * value is the index of the channel center frequency for 160 MHz
5757 * channels and the center frequency index of the secondary 80 MHz
5758 * segment for 80+80 MHz channels.
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005759 * @ch_width: Selected Channel width by driver. Driver may choose to
5760 * change hostapd configured ACS channel width due driver internal
5761 * channel restrictions.
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07005762 * hw_mode: Selected band (used with hw_mode=any)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005763 */
5764 struct acs_selected_channels {
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08005765 unsigned int pri_freq;
5766 unsigned int sec_freq;
Hai Shalomfdcde762020-04-02 11:19:20 -07005767 u8 edmg_channel;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005768 u8 vht_seg0_center_ch;
5769 u8 vht_seg1_center_ch;
5770 u16 ch_width;
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07005771 enum hostapd_hw_mode hw_mode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005772 } acs_selected_channels;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005773
5774 /**
5775 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
5776 * @reason_code: Reason for stopping offload
5777 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
5778 * scheduled.
5779 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
5780 * be stopped.
5781 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
5782 * parameters.
5783 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
5784 * supported by device.
5785 */
5786 struct p2p_lo_stop {
5787 enum {
5788 P2P_LO_STOPPED_REASON_COMPLETE = 0,
5789 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
5790 P2P_LO_STOPPED_REASON_INVALID_PARAM,
5791 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
5792 } reason_code;
5793 } p2p_lo_stop;
Roshan Pius3a1667e2018-07-03 15:17:14 -07005794
5795 /* For EVENT_EXTERNAL_AUTH */
5796 struct external_auth external_auth;
5797
5798 /**
5799 * struct sta_opmode - Station's operation mode change event
5800 * @addr: The station MAC address
5801 * @smps_mode: SMPS mode of the station
5802 * @chan_width: Channel width of the station
5803 * @rx_nss: RX_NSS of the station
5804 *
5805 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
5806 */
5807 struct sta_opmode {
5808 const u8 *addr;
5809 enum smps_mode smps_mode;
5810 enum chan_width chan_width;
5811 u8 rx_nss;
5812 } sta_opmode;
5813
5814 /**
5815 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
5816 */
5817 struct wds_sta_interface {
5818 const u8 *sta_addr;
5819 const char *ifname;
5820 enum {
5821 INTERFACE_ADDED,
5822 INTERFACE_REMOVED
5823 } istatus;
5824 } wds_sta_interface;
Hai Shalom81f62d82019-07-22 12:10:00 -07005825
5826 /**
5827 * struct update_dh - Data for EVENT_UPDATE_DH
5828 */
5829 struct update_dh {
5830 const u8 *peer;
5831 const u8 *ie;
5832 size_t ie_len;
5833 } update_dh;
Hai Shalomfdcde762020-04-02 11:19:20 -07005834
5835 /**
5836 * struct unprot_beacon - Data for EVENT_UNPROT_BEACON
5837 */
5838 struct unprot_beacon {
5839 const u8 *sa;
5840 } unprot_beacon;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005841};
5842
5843/**
5844 * wpa_supplicant_event - Report a driver event for wpa_supplicant
5845 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5846 * with struct wpa_driver_ops::init()
5847 * @event: event type (defined above)
5848 * @data: possible extra data for the event
5849 *
5850 * Driver wrapper code should call this function whenever an event is received
5851 * from the driver.
5852 */
5853void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
5854 union wpa_event_data *data);
5855
Dmitry Shmidte4663042016-04-04 10:07:49 -07005856/**
5857 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
5858 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5859 * with struct wpa_driver_ops::init()
5860 * @event: event type (defined above)
5861 * @data: possible extra data for the event
5862 *
5863 * Same as wpa_supplicant_event(), but we search for the interface in
5864 * wpa_global.
5865 */
5866void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
5867 union wpa_event_data *data);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005868
5869/*
5870 * The following inline functions are provided for convenience to simplify
5871 * event indication for some of the common events.
5872 */
5873
5874static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
5875 size_t ielen, int reassoc)
5876{
5877 union wpa_event_data event;
5878 os_memset(&event, 0, sizeof(event));
5879 event.assoc_info.reassoc = reassoc;
5880 event.assoc_info.req_ies = ie;
5881 event.assoc_info.req_ies_len = ielen;
5882 event.assoc_info.addr = addr;
5883 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
5884}
5885
5886static inline void drv_event_disassoc(void *ctx, const u8 *addr)
5887{
5888 union wpa_event_data event;
5889 os_memset(&event, 0, sizeof(event));
5890 event.disassoc_info.addr = addr;
5891 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
5892}
5893
5894static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
5895 size_t data_len)
5896{
5897 union wpa_event_data event;
5898 os_memset(&event, 0, sizeof(event));
5899 event.eapol_rx.src = src;
5900 event.eapol_rx.data = data;
5901 event.eapol_rx.data_len = data_len;
5902 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
5903}
5904
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005905/* driver_common.c */
5906void wpa_scan_results_free(struct wpa_scan_results *res);
5907
5908/* Convert wpa_event_type to a string for logging */
5909const char * event_to_string(enum wpa_event_type event);
5910
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07005911/* Convert chan_width to a string for logging and control interfaces */
5912const char * channel_width_to_string(enum chan_width width);
5913
Hai Shalom74f70d42019-02-11 14:42:39 -08005914int channel_width_to_int(enum chan_width width);
5915
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005916int ht_supported(const struct hostapd_hw_modes *mode);
5917int vht_supported(const struct hostapd_hw_modes *mode);
5918
5919struct wowlan_triggers *
5920wpa_get_wowlan_triggers(const char *wowlan_triggers,
5921 const struct wpa_driver_capa *capa);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005922/* Convert driver flag to string */
5923const char * driver_flag_to_string(u64 flag);
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005924
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005925/* NULL terminated array of linked in driver wrappers */
Dmitry Shmidt1d755d02015-04-28 10:34:29 -07005926extern const struct wpa_driver_ops *const wpa_drivers[];
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005927
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07005928
5929/* Available drivers */
5930
5931#ifdef CONFIG_DRIVER_WEXT
5932extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
5933#endif /* CONFIG_DRIVER_WEXT */
5934#ifdef CONFIG_DRIVER_NL80211
5935/* driver_nl80211.c */
5936extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
5937#endif /* CONFIG_DRIVER_NL80211 */
5938#ifdef CONFIG_DRIVER_HOSTAP
5939extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
5940#endif /* CONFIG_DRIVER_HOSTAP */
5941#ifdef CONFIG_DRIVER_BSD
5942extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
5943#endif /* CONFIG_DRIVER_BSD */
5944#ifdef CONFIG_DRIVER_OPENBSD
5945/* driver_openbsd.c */
5946extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
5947#endif /* CONFIG_DRIVER_OPENBSD */
5948#ifdef CONFIG_DRIVER_NDIS
5949extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
5950#endif /* CONFIG_DRIVER_NDIS */
5951#ifdef CONFIG_DRIVER_WIRED
5952extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
5953#endif /* CONFIG_DRIVER_WIRED */
5954#ifdef CONFIG_DRIVER_MACSEC_QCA
5955/* driver_macsec_qca.c */
5956extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
5957#endif /* CONFIG_DRIVER_MACSEC_QCA */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08005958#ifdef CONFIG_DRIVER_MACSEC_LINUX
5959/* driver_macsec_linux.c */
5960extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops;
5961#endif /* CONFIG_DRIVER_MACSEC_LINUX */
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07005962#ifdef CONFIG_DRIVER_ROBOSWITCH
5963/* driver_roboswitch.c */
5964extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
5965#endif /* CONFIG_DRIVER_ROBOSWITCH */
5966#ifdef CONFIG_DRIVER_ATHEROS
5967/* driver_atheros.c */
5968extern const struct wpa_driver_ops wpa_driver_atheros_ops;
5969#endif /* CONFIG_DRIVER_ATHEROS */
5970#ifdef CONFIG_DRIVER_NONE
5971extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
5972#endif /* CONFIG_DRIVER_NONE */
5973
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005974#endif /* DRIVER_H */