blob: 1e2e332a643aa1a1a665d62f51ddbaca40229ce4 [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,
Hai Shalom4fbc08f2020-05-18 12:37:00 -07001556 * %WPA_ALG_BIP_AES_CMAC_128, %WPA_ALG_GCMP, %WPA_ALG_GCMP_256,
1557 * %WPA_ALG_CCMP_256, %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1558 * %WPA_ALG_BIP_CMAC_256);
Hai Shalomfdcde762020-04-02 11:19:20 -07001559 * %WPA_ALG_NONE clears the key. */
1560 enum wpa_alg alg;
1561
1562 /**
1563 * addr - Address of the peer STA
1564 *
1565 * (BSSID of the current AP when setting pairwise key in station mode),
1566 * ff:ff:ff:ff:ff:ff for broadcast keys, %NULL for default keys that
1567 * are used both for broadcast and unicast; when clearing keys, %NULL
1568 * is used to indicate that both the broadcast-only and default key of
1569 * the specified key index is to be cleared */
1570 const u8 *addr;
1571
1572 /**
1573 * key_idx - Key index
1574 *
1575 * (0..3), usually 0 for unicast keys; 4..5 for IGTK; 6..7 for BIGTK */
1576 int key_idx;
1577
1578 /**
1579 * set_tx - Configure this key as the default Tx key
1580 *
1581 * Only used when driver does not support separate unicast/individual
1582 * key */
1583 int set_tx;
1584
1585 /**
1586 * seq - Sequence number/packet number
1587 *
1588 * seq_len octets, the next packet number to be used for in replay
1589 * protection; configured for Rx keys (in most cases, this is only used
1590 * with broadcast keys and set to zero for unicast keys); %NULL if not
1591 * set */
1592 const u8 *seq;
1593
1594 /**
1595 * seq_len - Length of the seq, depends on the algorithm
1596 *
1597 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets */
1598 size_t seq_len;
1599
1600 /**
1601 * key - Key buffer
1602 *
1603 * TKIP: 16-byte temporal key, 8-byte Tx Mic key, 8-byte Rx Mic Key */
1604 const u8 *key;
1605
1606 /**
1607 * key_len - Length of the key buffer in octets
1608 *
1609 * WEP: 5 or 13, TKIP: 32, CCMP/GCMP: 16, IGTK: 16 */
1610 size_t key_len;
1611
1612 /**
1613 * vlan_id - VLAN index (0..4095) for VLAN offload cases */
1614 int vlan_id;
1615
1616 /**
1617 * key_flag - Additional key flags
1618 *
1619 * %KEY_FLAG_MODIFY
1620 * Set when an already installed key must be updated.
1621 * So far the only use-case is changing RX/TX status for
1622 * pairwise keys. Must not be set when deleting a key.
1623 * %KEY_FLAG_DEFAULT
1624 * Set when the key is also a default key. Must not be set when
1625 * deleting a key.
1626 * %KEY_FLAG_RX
1627 * The key is valid for RX. Must not be set when deleting a key.
1628 * %KEY_FLAG_TX
1629 * The key is valid for TX. Must not be set when deleting a key.
1630 * %KEY_FLAG_GROUP
1631 * The key is a broadcast or group key.
1632 * %KEY_FLAG_PAIRWISE
1633 * The key is a pairwise key.
1634 * %KEY_FLAG_PMK
1635 * The key is a Pairwise Master Key (PMK).
1636 *
1637 * Valid and pre-defined combinations are:
1638 * %KEY_FLAG_GROUP_RX_TX
1639 * WEP key not to be installed as default key.
1640 * %KEY_FLAG_GROUP_RX_TX_DEFAULT
1641 * Default WEP or WPA-NONE key.
1642 * %KEY_FLAG_GROUP_RX
1643 * GTK key valid for RX only.
1644 * %KEY_FLAG_GROUP_TX_DEFAULT
1645 * GTK key valid for TX only, immediately taking over TX.
1646 * %KEY_FLAG_PAIRWISE_RX_TX
1647 * Pairwise key immediately becoming the active pairwise key.
1648 * %KEY_FLAG_PAIRWISE_RX
1649 * Pairwise key not yet valid for TX. (Only usable when Extended
1650 * Key ID is supported by the driver.)
1651 * %KEY_FLAG_PAIRWISE_RX_TX_MODIFY
1652 * Enable TX for a pairwise key installed with
1653 * KEY_FLAG_PAIRWISE_RX.
1654 *
1655 * Not a valid standalone key type but pre-defined to be combined
1656 * with other key_flags:
1657 * %KEY_FLAG_RX_TX
1658 * RX/TX key. */
1659 enum key_flag key_flag;
1660};
1661
Hai Shalom4fbc08f2020-05-18 12:37:00 -07001662enum wpa_driver_if_type {
1663 /**
1664 * WPA_IF_STATION - Station mode interface
1665 */
1666 WPA_IF_STATION,
1667
1668 /**
1669 * WPA_IF_AP_VLAN - AP mode VLAN interface
1670 *
1671 * This interface shares its address and Beacon frame with the main
1672 * BSS.
1673 */
1674 WPA_IF_AP_VLAN,
1675
1676 /**
1677 * WPA_IF_AP_BSS - AP mode BSS interface
1678 *
1679 * This interface has its own address and Beacon frame.
1680 */
1681 WPA_IF_AP_BSS,
1682
1683 /**
1684 * WPA_IF_P2P_GO - P2P Group Owner
1685 */
1686 WPA_IF_P2P_GO,
1687
1688 /**
1689 * WPA_IF_P2P_CLIENT - P2P Client
1690 */
1691 WPA_IF_P2P_CLIENT,
1692
1693 /**
1694 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1695 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1696 */
1697 WPA_IF_P2P_GROUP,
1698
1699 /**
1700 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1701 * abstracted P2P Device function in the driver
1702 */
1703 WPA_IF_P2P_DEVICE,
1704
1705 /*
1706 * WPA_IF_MESH - Mesh interface
1707 */
1708 WPA_IF_MESH,
1709
1710 /*
1711 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1712 */
1713 WPA_IF_TDLS,
1714
1715 /*
1716 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1717 */
1718 WPA_IF_IBSS,
1719
1720 /*
1721 * WPA_IF_NAN - NAN Device
1722 */
1723 WPA_IF_NAN,
1724
1725 /* keep last */
1726 WPA_IF_MAX
1727};
1728
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001729/**
1730 * struct wpa_driver_capa - Driver capability information
1731 */
1732struct wpa_driver_capa {
1733#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1734#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1735#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1736#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1737#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1738#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1739#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001740#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001741#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1742#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001743#define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
1744#define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
1745#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1746#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1747#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1748#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
Hai Shalom74f70d42019-02-11 14:42:39 -08001749#define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001750 /** Bitfield of supported key management suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001751 unsigned int key_mgmt;
Hai Shalom4fbc08f2020-05-18 12:37:00 -07001752 unsigned int key_mgmt_iftype[WPA_IF_MAX];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001753
1754#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1755#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1756#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1757#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
Dmitry Shmidt04949592012-07-19 12:16:46 -07001758#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001759#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001760#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1761#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1762#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1763#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1764#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1765#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001766#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001767 /** Bitfield of supported cipher suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001768 unsigned int enc;
1769
1770#define WPA_DRIVER_AUTH_OPEN 0x00000001
1771#define WPA_DRIVER_AUTH_SHARED 0x00000002
1772#define WPA_DRIVER_AUTH_LEAP 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001773 /** Bitfield of supported IEEE 802.11 authentication algorithms */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001774 unsigned int auth;
1775
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001776/** Driver generated WPA/RSN IE */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001777#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001778/** Driver needs static WEP key setup after association command */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001779#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001780/** Driver takes care of all DFS operations */
Dmitry Shmidtd11f0192014-03-24 12:09:47 -07001781#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001782/** Driver takes care of RSN 4-way handshake internally; PMK is configured with
Hai Shalomfdcde762020-04-02 11:19:20 -07001783 * struct wpa_driver_ops::set_key using key_flag = KEY_FLAG_PMK */
Hai Shalom74f70d42019-02-11 14:42:39 -08001784#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001785/** Driver is for a wired Ethernet interface */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001786#define WPA_DRIVER_FLAGS_WIRED 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001787/** Driver provides separate commands for authentication and association (SME in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001788 * wpa_supplicant). */
1789#define WPA_DRIVER_FLAGS_SME 0x00000020
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001790/** Driver supports AP mode */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001791#define WPA_DRIVER_FLAGS_AP 0x00000040
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001792/** Driver needs static WEP key setup after association has been completed */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001793#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001794/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001795#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001796/** Driver supports concurrent P2P operations */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001797#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001798/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001799 * Driver uses the initial interface as a dedicated management interface, i.e.,
1800 * it cannot be used for P2P group operations or non-P2P purposes.
1801 */
1802#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001803/** This interface is P2P capable (P2P GO or P2P Client) */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001804#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001805/** Driver supports station and key removal when stopping an AP */
Dmitry Shmidta38abf92014-03-06 13:38:44 -08001806#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001807/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001808 * Driver uses the initial interface for P2P management interface and non-P2P
1809 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1810 * P2P group operations.
1811 */
1812#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001813/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001814 * Driver is known to use sane error codes, i.e., when it indicates that
1815 * something (e.g., association) fails, there was indeed a failure and the
1816 * operation does not end up getting completed successfully later.
1817 */
1818#define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001819/** Driver supports off-channel TX */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001820#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001821/** Driver indicates TX status events for EAPOL Data frames */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001822#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001823/** Driver indicates TX status events for Deauth/Disassoc frames */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001824#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001825/** Driver supports roaming (BSS selection) in firmware */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001826#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001827/** Driver supports operating as a TDLS peer */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001828#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001829/** Driver requires external TDLS setup/teardown/discovery */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001830#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001831/** Driver indicates support for Probe Response offloading in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001832#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001833/** Driver supports U-APSD in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001834#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001835/** Driver supports inactivity timer in AP mode */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001836#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001837/** Driver expects user space implementation of MLME in AP mode */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001838#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001839/** Driver supports SAE with user space SME */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001840#define WPA_DRIVER_FLAGS_SAE 0x02000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001841/** Driver makes use of OBSS scan mechanism in wpa_supplicant */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001842#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001843/** Driver supports IBSS (Ad-hoc) mode */
Dmitry Shmidt700a1372013-03-15 14:14:44 -07001844#define WPA_DRIVER_FLAGS_IBSS 0x08000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001845/** Driver supports radar detection */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07001846#define WPA_DRIVER_FLAGS_RADAR 0x10000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001847/** Driver supports a dedicated interface for P2P Device */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001848#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001849/** Driver supports QoS Mapping */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001850#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001851/** Driver supports CSA in AP mode */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001852#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001853/** Driver supports mesh */
1854#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1855/** Driver support ACS offload */
1856#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1857/** Driver supports key management offload */
1858#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1859/** Driver supports TDLS channel switching */
1860#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001861/** Driver supports IBSS with HT datarates */
1862#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001863/** Driver supports IBSS with VHT datarates */
1864#define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07001865/** Driver supports automatic band selection */
1866#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001867/** Driver supports simultaneous off-channel operations */
1868#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001869/** Driver supports full AP client state */
1870#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001871/** Driver supports P2P Listen offload */
1872#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001873/** Driver supports FILS */
1874#define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001875/** Driver supports Beacon frame TX rate configuration (legacy rates) */
1876#define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1877/** Driver supports Beacon frame TX rate configuration (HT rates) */
1878#define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1879/** Driver supports Beacon frame TX rate configuration (VHT rates) */
1880#define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08001881/** Driver supports mgmt_tx with random TX address in non-connected state */
1882#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
1883/** Driver supports mgmt_tx with random TX addr in connected state */
1884#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
1885/** Driver supports better BSS reporting with sched_scan in connected mode */
1886#define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
1887/** Driver supports HE capabilities */
1888#define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001889/** Driver supports FILS shared key offload */
1890#define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
1891/** Driver supports all OCE STA specific mandatory features */
1892#define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
1893/** Driver supports all OCE AP specific mandatory features */
1894#define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
1895/**
1896 * Driver supports all OCE STA-CFON specific mandatory features only.
1897 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
1898 * userspace shall assume that this driver may not support all OCE AP
1899 * functionality but can support only OCE STA-CFON functionality.
1900 */
1901#define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
Roshan Pius3a1667e2018-07-03 15:17:14 -07001902/** Driver supports MFP-optional in the connect command */
1903#define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL
Hai Shalom39ba6fc2019-01-22 12:40:38 -08001904/** Driver is a self-managed regulatory device */
1905#define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL
Hai Shalom74f70d42019-02-11 14:42:39 -08001906/** Driver supports FTM responder functionality */
1907#define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL
1908/** Driver support 4-way handshake offload for WPA-Personal */
1909#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
Hai Shalomb755a2a2020-04-23 21:49:02 -07001910/** Driver supports a separate control port TX for EAPOL frames */
Hai Shalomfdcde762020-04-02 11:19:20 -07001911#define WPA_DRIVER_FLAGS_CONTROL_PORT 0x0400000000000000ULL
1912/** Driver supports VLAN offload */
1913#define WPA_DRIVER_FLAGS_VLAN_OFFLOAD 0x0800000000000000ULL
1914/** Driver supports UPDATE_FT_IES command */
1915#define WPA_DRIVER_FLAGS_UPDATE_FT_IES 0x1000000000000000ULL
1916/** Driver can correctly rekey PTKs without Extended Key ID */
1917#define WPA_DRIVER_FLAGS_SAFE_PTK0_REKEYS 0x2000000000000000ULL
1918/** Driver supports Beacon protection */
1919#define WPA_DRIVER_FLAGS_BEACON_PROTECTION 0x4000000000000000ULL
1920/** Driver supports Extended Key ID */
1921#define WPA_DRIVER_FLAGS_EXTENDED_KEY_ID 0x8000000000000000ULL
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001922 u64 flags;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001923
Hai Shalomb755a2a2020-04-23 21:49:02 -07001924/** Driver supports a separate control port RX for EAPOL frames */
1925#define WPA_DRIVER_FLAGS2_CONTROL_PORT_RX 0x0000000000000001ULL
1926 u64 flags2;
1927
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001928#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1929 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1930
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001931 unsigned int wmm_ac_supported:1;
1932
1933 unsigned int mac_addr_rand_scan_supported:1;
1934 unsigned int mac_addr_rand_sched_scan_supported:1;
1935
1936 /** Maximum number of supported active probe SSIDs */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001937 int max_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001938
1939 /** Maximum number of supported active probe SSIDs for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001940 int max_sched_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001941
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08001942 /** Maximum number of supported scan plans for scheduled scan */
1943 unsigned int max_sched_scan_plans;
1944
1945 /** Maximum interval in a scan plan. In seconds */
1946 u32 max_sched_scan_plan_interval;
1947
1948 /** Maximum number of iterations in a single scan plan */
1949 u32 max_sched_scan_plan_iterations;
1950
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001951 /** Whether sched_scan (offloaded scanning) is supported */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001952 int sched_scan_supported;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001953
1954 /** Maximum number of supported match sets for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001955 int max_match_sets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001956
1957 /**
1958 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1959 */
1960 unsigned int max_remain_on_chan;
1961
1962 /**
1963 * max_stations - Maximum number of associated stations the driver
1964 * supports in AP mode
1965 */
1966 unsigned int max_stations;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001967
1968 /**
1969 * probe_resp_offloads - Bitmap of supported protocols by the driver
1970 * for Probe Response offloading.
1971 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001972/** Driver Probe Response offloading support for WPS ver. 1 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001973#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001974/** Driver Probe Response offloading support for WPS ver. 2 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001975#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001976/** Driver Probe Response offloading support for P2P */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001977#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001978/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001979#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1980 unsigned int probe_resp_offloads;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001981
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07001982 unsigned int max_acl_mac_addrs;
1983
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001984 /**
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07001985 * Number of supported concurrent channels
1986 */
1987 unsigned int num_multichan_concurrent;
1988
1989 /**
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001990 * extended_capa - extended capabilities in driver/device
1991 *
1992 * Must be allocated and freed by driver and the pointers must be
1993 * valid for the lifetime of the driver, i.e., freed in deinit()
1994 */
1995 const u8 *extended_capa, *extended_capa_mask;
1996 unsigned int extended_capa_len;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001997
1998 struct wowlan_triggers wowlan_triggers;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001999
2000/** Driver adds the DS Params Set IE in Probe Request frames */
2001#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
2002/** Driver adds the WFA TPC IE in Probe Request frames */
2003#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
2004/** Driver handles quiet period requests */
2005#define WPA_DRIVER_FLAGS_QUIET 0x00000004
2006/**
2007 * Driver is capable of inserting the current TX power value into the body of
2008 * transmitted frames.
2009 * Background: Some Action frames include a TPC Report IE. This IE contains a
2010 * TX power field, which has to be updated by lower layers. One such Action
2011 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
2012 * of spectrum management). Note that this insertion takes place at a fixed
2013 * offset, namely the 6th byte in the Action frame body.
2014 */
2015#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
Dmitry Shmidt849734c2016-05-27 09:59:01 -07002016/**
2017 * Driver supports RRM. With this support, the driver will accept to use RRM in
2018 * (Re)Association Request frames, without supporting quiet period.
2019 */
2020#define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
2021
Dmitry Shmidt29333592017-01-09 12:27:11 -08002022/** Driver supports setting the scan dwell time */
2023#define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
2024/** Driver supports Beacon Report Measurement */
2025#define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
2026
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002027 u32 rrm_flags;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002028
2029 /* Driver concurrency capabilities */
2030 unsigned int conc_capab;
2031 /* Maximum number of concurrent channels on 2.4 GHz */
2032 unsigned int max_conc_chan_2_4;
2033 /* Maximum number of concurrent channels on 5 GHz */
2034 unsigned int max_conc_chan_5_0;
2035
2036 /* Maximum number of supported CSA counters */
2037 u16 max_csa_counters;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002038};
2039
2040
2041struct hostapd_data;
2042
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002043#define STA_DRV_DATA_TX_MCS BIT(0)
2044#define STA_DRV_DATA_RX_MCS BIT(1)
2045#define STA_DRV_DATA_TX_VHT_MCS BIT(2)
2046#define STA_DRV_DATA_RX_VHT_MCS BIT(3)
2047#define STA_DRV_DATA_TX_VHT_NSS BIT(4)
2048#define STA_DRV_DATA_RX_VHT_NSS BIT(5)
2049#define STA_DRV_DATA_TX_SHORT_GI BIT(6)
2050#define STA_DRV_DATA_RX_SHORT_GI BIT(7)
Roshan Pius3a1667e2018-07-03 15:17:14 -07002051#define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002052
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002053struct hostap_sta_driver_data {
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002054 unsigned long rx_packets, tx_packets;
2055 unsigned long long rx_bytes, tx_bytes;
Hai Shalom81f62d82019-07-22 12:10:00 -07002056 unsigned long long rx_airtime, tx_airtime;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002057 int bytes_64bit; /* whether 64-bit byte counters are supported */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002058 unsigned long current_tx_rate;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002059 unsigned long current_rx_rate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002060 unsigned long inactive_msec;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002061 unsigned long flags; /* bitfield of STA_DRV_DATA_* */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002062 unsigned long num_ps_buf_frames;
2063 unsigned long tx_retry_failed;
2064 unsigned long tx_retry_count;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002065 s8 last_ack_rssi;
Hai Shalom81f62d82019-07-22 12:10:00 -07002066 unsigned long backlog_packets;
2067 unsigned long backlog_bytes;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002068 s8 signal;
2069 u8 rx_vhtmcs;
2070 u8 tx_vhtmcs;
2071 u8 rx_mcs;
2072 u8 tx_mcs;
2073 u8 rx_vht_nss;
2074 u8 tx_vht_nss;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002075};
2076
2077struct hostapd_sta_add_params {
2078 const u8 *addr;
2079 u16 aid;
2080 u16 capability;
2081 const u8 *supp_rates;
2082 size_t supp_rates_len;
2083 u16 listen_interval;
2084 const struct ieee80211_ht_capabilities *ht_capabilities;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08002085 const struct ieee80211_vht_capabilities *vht_capabilities;
Dmitry Shmidtbd14a572014-02-18 10:33:49 -08002086 int vht_opmode_enabled;
2087 u8 vht_opmode;
Hai Shalom81f62d82019-07-22 12:10:00 -07002088 const struct ieee80211_he_capabilities *he_capab;
2089 size_t he_capab_len;
Hai Shalom4fbc08f2020-05-18 12:37:00 -07002090 const struct ieee80211_he_6ghz_band_cap *he_6ghz_capab;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002091 u32 flags; /* bitmask of WPA_STA_* flags */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002092 u32 flags_mask; /* unset bits in flags */
2093#ifdef CONFIG_MESH
2094 enum mesh_plink_state plink_state;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07002095 u16 peer_aid;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002096#endif /* CONFIG_MESH */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002097 int set; /* Set STA parameters instead of add */
2098 u8 qosinfo;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08002099 const u8 *ext_capab;
2100 size_t ext_capab_len;
Dmitry Shmidt344abd32014-01-14 13:17:00 -08002101 const u8 *supp_channels;
2102 size_t supp_channels_len;
2103 const u8 *supp_oper_classes;
2104 size_t supp_oper_classes_len;
Dmitry Shmidt849734c2016-05-27 09:59:01 -07002105 int support_p2p_ps;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002106};
2107
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002108struct mac_address {
2109 u8 addr[ETH_ALEN];
2110};
2111
2112struct hostapd_acl_params {
2113 u8 acl_policy;
2114 unsigned int num_mac_acl;
2115 struct mac_address mac_acl[0];
2116};
2117
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002118struct wpa_init_params {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002119 void *global_priv;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002120 const u8 *bssid;
2121 const char *ifname;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002122 const char *driver_params;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002123 int use_pae_group_addr;
2124 char **bridge;
2125 size_t num_bridge;
2126
2127 u8 *own_addr; /* buffer for writing own MAC address */
2128};
2129
2130
2131struct wpa_bss_params {
2132 /** Interface name (for multi-SSID/VLAN support) */
2133 const char *ifname;
2134 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
2135 int enabled;
2136
2137 int wpa;
2138 int ieee802_1x;
2139 int wpa_group;
2140 int wpa_pairwise;
2141 int wpa_key_mgmt;
2142 int rsn_preauth;
2143 enum mfp_options ieee80211w;
2144};
2145
2146#define WPA_STA_AUTHORIZED BIT(0)
2147#define WPA_STA_WMM BIT(1)
2148#define WPA_STA_SHORT_PREAMBLE BIT(2)
2149#define WPA_STA_MFP BIT(3)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002150#define WPA_STA_TDLS_PEER BIT(4)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002151#define WPA_STA_AUTHENTICATED BIT(5)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002152#define WPA_STA_ASSOCIATED BIT(6)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002153
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002154enum tdls_oper {
2155 TDLS_DISCOVERY_REQ,
2156 TDLS_SETUP,
2157 TDLS_TEARDOWN,
2158 TDLS_ENABLE_LINK,
2159 TDLS_DISABLE_LINK,
2160 TDLS_ENABLE,
2161 TDLS_DISABLE
2162};
2163
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002164enum wnm_oper {
2165 WNM_SLEEP_ENTER_CONFIRM,
2166 WNM_SLEEP_ENTER_FAIL,
2167 WNM_SLEEP_EXIT_CONFIRM,
2168 WNM_SLEEP_EXIT_FAIL,
2169 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
2170 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
2171 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
2172 * a STA */
2173 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
2174 * for a STA */
2175 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
2176 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
2177 * for a STA */
2178 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
2179};
2180
Roshan Pius3a1667e2018-07-03 15:17:14 -07002181/* enum smps_mode - SMPS mode definitions */
2182enum smps_mode {
2183 SMPS_AUTOMATIC,
2184 SMPS_OFF,
2185 SMPS_DYNAMIC,
2186 SMPS_STATIC,
2187
2188 /* Keep last */
2189 SMPS_INVALID,
2190};
2191
Hai Shalom74f70d42019-02-11 14:42:39 -08002192#define WPA_INVALID_NOISE 9999
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002193
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002194/**
2195 * struct wpa_signal_info - Information about channel signal quality
Hai Shalom74f70d42019-02-11 14:42:39 -08002196 * @frequency: control frequency
2197 * @above_threshold: true if the above threshold was crossed
2198 * (relevant for a CQM event)
2199 * @current_signal: in dBm
2200 * @avg_signal: in dBm
2201 * @avg_beacon_signal: in dBm
2202 * @current_noise: %WPA_INVALID_NOISE if not supported
2203 * @current_txrate: current TX rate
2204 * @chanwidth: channel width
2205 * @center_frq1: center frequency for the first segment
2206 * @center_frq2: center frequency for the second segment (if relevant)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002207 */
2208struct wpa_signal_info {
2209 u32 frequency;
2210 int above_threshold;
2211 int current_signal;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002212 int avg_signal;
Dmitry Shmidtf73259c2015-03-17 11:00:54 -07002213 int avg_beacon_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002214 int current_noise;
2215 int current_txrate;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002216 enum chan_width chanwidth;
2217 int center_frq1;
2218 int center_frq2;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002219};
2220
2221/**
Hai Shalom74f70d42019-02-11 14:42:39 -08002222 * struct wpa_channel_info - Information about the current channel
2223 * @frequency: Center frequency of the primary 20 MHz channel
2224 * @chanwidth: Width of the current operating channel
2225 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
2226 * This field is only filled in when using a 40 MHz channel.
2227 * @center_frq1: Center frequency of frequency segment 0
2228 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
2229 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
2230 * derived from center_frq2 for convenience.
2231 */
2232struct wpa_channel_info {
2233 u32 frequency;
2234 enum chan_width chanwidth;
2235 int sec_channel;
2236 int center_frq1;
2237 int center_frq2;
2238 u8 seg1_idx;
2239};
2240
2241/**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002242 * struct beacon_data - Beacon data
2243 * @head: Head portion of Beacon frame (before TIM IE)
2244 * @tail: Tail portion of Beacon frame (after TIM IE)
2245 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2246 * @proberesp_ies: Extra information element(s) to add into Probe Response
2247 * frames or %NULL
2248 * @assocresp_ies: Extra information element(s) to add into (Re)Association
2249 * Response frames or %NULL
2250 * @probe_resp: Probe Response frame template
2251 * @head_len: Length of @head
2252 * @tail_len: Length of @tail
2253 * @beacon_ies_len: Length of beacon_ies in octets
2254 * @proberesp_ies_len: Length of proberesp_ies in octets
2255 * @proberesp_ies_len: Length of proberesp_ies in octets
2256 * @probe_resp_len: Length of probe response template (@probe_resp)
2257 */
2258struct beacon_data {
2259 u8 *head, *tail;
2260 u8 *beacon_ies;
2261 u8 *proberesp_ies;
2262 u8 *assocresp_ies;
2263 u8 *probe_resp;
2264
2265 size_t head_len, tail_len;
2266 size_t beacon_ies_len;
2267 size_t proberesp_ies_len;
2268 size_t assocresp_ies_len;
2269 size_t probe_resp_len;
2270};
2271
2272/**
2273 * struct csa_settings - Settings for channel switch command
2274 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2275 * @block_tx: 1 - block transmission for CSA period
2276 * @freq_params: Next channel frequency parameter
2277 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2278 * @beacon_after: Next beacon/probe resp/asooc resp info
2279 * @counter_offset_beacon: Offset to the count field in beacon's tail
2280 * @counter_offset_presp: Offset to the count field in probe resp.
2281 */
2282struct csa_settings {
2283 u8 cs_count;
2284 u8 block_tx;
2285
2286 struct hostapd_freq_params freq_params;
2287 struct beacon_data beacon_csa;
2288 struct beacon_data beacon_after;
2289
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002290 u16 counter_offset_beacon[2];
2291 u16 counter_offset_presp[2];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002292};
2293
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002294/* TDLS peer capabilities for send_tdls_mgmt() */
2295enum tdls_peer_capability {
2296 TDLS_PEER_HT = BIT(0),
2297 TDLS_PEER_VHT = BIT(1),
2298 TDLS_PEER_WMM = BIT(2),
2299};
2300
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002301/* valid info in the wmm_params struct */
2302enum wmm_params_valid_info {
2303 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
2304};
2305
2306/**
2307 * struct wmm_params - WMM parameterss configured for this association
2308 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2309 * of the struct contain valid information.
2310 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2311 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2312 */
2313struct wmm_params {
2314 u8 info_bitmap;
2315 u8 uapsd_queues;
2316};
2317
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002318#ifdef CONFIG_MACSEC
2319struct macsec_init_params {
Hai Shalome21d4e82020-04-29 16:34:06 -07002320 bool always_include_sci;
2321 bool use_es;
2322 bool use_scb;
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002323};
2324#endif /* CONFIG_MACSEC */
2325
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002326enum drv_br_port_attr {
2327 DRV_BR_PORT_ATTR_PROXYARP,
2328 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
2329};
2330
2331enum drv_br_net_param {
2332 DRV_BR_NET_PARAM_GARP_ACCEPT,
Dmitry Shmidt83474442015-04-15 13:47:09 -07002333 DRV_BR_MULTICAST_SNOOPING,
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002334};
2335
2336struct drv_acs_params {
2337 /* Selected mode (HOSTAPD_MODE_*) */
2338 enum hostapd_hw_mode hw_mode;
2339
2340 /* Indicates whether HT is enabled */
2341 int ht_enabled;
2342
2343 /* Indicates whether HT40 is enabled */
2344 int ht40_enabled;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07002345
2346 /* Indicates whether VHT is enabled */
2347 int vht_enabled;
2348
2349 /* Configured ACS channel width */
2350 u16 ch_width;
2351
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08002352 /* ACS frequency list info */
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002353 const int *freq_list;
Hai Shalomfdcde762020-04-02 11:19:20 -07002354
2355 /* Indicates whether EDMG is enabled */
2356 int edmg_enabled;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002357};
2358
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002359struct wpa_bss_trans_info {
2360 u8 mbo_transition_reason;
2361 u8 n_candidates;
2362 u8 *bssid;
2363};
2364
2365struct wpa_bss_candidate_info {
2366 u8 num;
2367 struct candidate_list {
2368 u8 bssid[ETH_ALEN];
2369 u8 is_accept;
2370 u32 reject_reason;
2371 } *candidates;
2372};
2373
2374struct wpa_pmkid_params {
2375 const u8 *bssid;
2376 const u8 *ssid;
2377 size_t ssid_len;
2378 const u8 *fils_cache_id;
2379 const u8 *pmkid;
2380 const u8 *pmk;
2381 size_t pmk_len;
Hai Shalomfdcde762020-04-02 11:19:20 -07002382 u32 pmk_lifetime;
2383 u8 pmk_reauth_threshold;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002384};
2385
2386/* Mask used to specify which connection parameters have to be updated */
2387enum wpa_drv_update_connect_params_mask {
2388 WPA_DRV_UPDATE_ASSOC_IES = BIT(0),
2389 WPA_DRV_UPDATE_FILS_ERP_INFO = BIT(1),
2390 WPA_DRV_UPDATE_AUTH_TYPE = BIT(2),
2391};
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002392
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002393/**
Roshan Pius3a1667e2018-07-03 15:17:14 -07002394 * struct external_auth - External authentication trigger parameters
2395 *
2396 * These are used across the external authentication request and event
2397 * interfaces.
2398 * @action: Action type / trigger for external authentication. Only significant
2399 * for the event interface.
2400 * @bssid: BSSID of the peer with which the authentication has to happen. Used
2401 * by both the request and event interface.
2402 * @ssid: SSID of the AP. Used by both the request and event interface.
2403 * @ssid_len: SSID length in octets.
2404 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2405 * the request interface.
2406 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2407 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2408 * the real status code for failures. Used only for the request interface
2409 * from user space to the driver.
Hai Shalom5f92bc92019-04-18 11:54:11 -07002410 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
Roshan Pius3a1667e2018-07-03 15:17:14 -07002411 */
2412struct external_auth {
2413 enum {
2414 EXT_AUTH_START,
2415 EXT_AUTH_ABORT,
2416 } action;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002417 const u8 *bssid;
2418 const u8 *ssid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002419 size_t ssid_len;
2420 unsigned int key_mgmt_suite;
2421 u16 status;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002422 const u8 *pmkid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002423};
2424
2425/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002426 * struct wpa_driver_ops - Driver interface API definition
2427 *
2428 * This structure defines the API that each driver interface needs to implement
2429 * for core wpa_supplicant code. All driver specific functionality is captured
2430 * in this wrapper.
2431 */
2432struct wpa_driver_ops {
2433 /** Name of the driver interface */
2434 const char *name;
2435 /** One line description of the driver interface */
2436 const char *desc;
2437
2438 /**
2439 * get_bssid - Get the current BSSID
2440 * @priv: private driver interface data
2441 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2442 *
2443 * Returns: 0 on success, -1 on failure
2444 *
2445 * Query kernel driver for the current BSSID and copy it to bssid.
2446 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2447 * associated.
2448 */
2449 int (*get_bssid)(void *priv, u8 *bssid);
2450
2451 /**
2452 * get_ssid - Get the current SSID
2453 * @priv: private driver interface data
2454 * @ssid: buffer for SSID (at least 32 bytes)
2455 *
2456 * Returns: Length of the SSID on success, -1 on failure
2457 *
2458 * Query kernel driver for the current SSID and copy it to ssid.
2459 * Returning zero is recommended if the STA is not associated.
2460 *
2461 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2462 * can, at least in theory, contain control characters (including nul)
2463 * and as such, should be processed as binary data, not a printable
2464 * string.
2465 */
2466 int (*get_ssid)(void *priv, u8 *ssid);
2467
2468 /**
2469 * set_key - Configure encryption key
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002470 * @priv: private driver interface data
Hai Shalomfdcde762020-04-02 11:19:20 -07002471 * @params: Key parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002472 * Returns: 0 on success, -1 on failure
2473 *
2474 * Configure the given key for the kernel driver. If the driver
2475 * supports separate individual keys (4 default keys + 1 individual),
2476 * addr can be used to determine whether the key is default or
2477 * individual. If only 4 keys are supported, the default key with key
2478 * index 0 is used as the individual key. STA must be configured to use
2479 * it as the default Tx key (set_tx is set) and accept Rx for all the
2480 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2481 * broadcast keys, so key index 0 is available for this kind of
2482 * configuration.
2483 *
2484 * Please note that TKIP keys include separate TX and RX MIC keys and
2485 * some drivers may expect them in different order than wpa_supplicant
2486 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
2487 * will trigger Michael MIC errors. This can be fixed by changing the
2488 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
2489 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2490 * example on how this can be done.
2491 */
Hai Shalomfdcde762020-04-02 11:19:20 -07002492 int (*set_key)(void *priv, struct wpa_driver_set_key_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002493
2494 /**
2495 * init - Initialize driver interface
2496 * @ctx: context to be used when calling wpa_supplicant functions,
2497 * e.g., wpa_supplicant_event()
2498 * @ifname: interface name, e.g., wlan0
2499 *
2500 * Returns: Pointer to private data, %NULL on failure
2501 *
2502 * Initialize driver interface, including event processing for kernel
2503 * driver events (e.g., associated, scan results, Michael MIC failure).
2504 * This function can allocate a private configuration data area for
2505 * @ctx, file descriptor, interface name, etc. information that may be
2506 * needed in future driver operations. If this is not used, non-NULL
2507 * value will need to be returned because %NULL is used to indicate
2508 * failure. The returned value will be used as 'void *priv' data for
2509 * all other driver_ops functions.
2510 *
2511 * The main event loop (eloop.c) of wpa_supplicant can be used to
2512 * register callback for read sockets (eloop_register_read_sock()).
2513 *
2514 * See below for more information about events and
2515 * wpa_supplicant_event() function.
2516 */
2517 void * (*init)(void *ctx, const char *ifname);
2518
2519 /**
2520 * deinit - Deinitialize driver interface
2521 * @priv: private driver interface data from init()
2522 *
2523 * Shut down driver interface and processing of driver events. Free
2524 * private data buffer if one was allocated in init() handler.
2525 */
2526 void (*deinit)(void *priv);
2527
2528 /**
2529 * set_param - Set driver configuration parameters
2530 * @priv: private driver interface data from init()
2531 * @param: driver specific configuration parameters
2532 *
2533 * Returns: 0 on success, -1 on failure
2534 *
2535 * Optional handler for notifying driver interface about configuration
2536 * parameters (driver_param).
2537 */
2538 int (*set_param)(void *priv, const char *param);
2539
2540 /**
2541 * set_countermeasures - Enable/disable TKIP countermeasures
2542 * @priv: private driver interface data
2543 * @enabled: 1 = countermeasures enabled, 0 = disabled
2544 *
2545 * Returns: 0 on success, -1 on failure
2546 *
2547 * Configure TKIP countermeasures. When these are enabled, the driver
2548 * should drop all received and queued frames that are using TKIP.
2549 */
2550 int (*set_countermeasures)(void *priv, int enabled);
2551
2552 /**
2553 * deauthenticate - Request driver to deauthenticate
2554 * @priv: private driver interface data
2555 * @addr: peer address (BSSID of the AP)
2556 * @reason_code: 16-bit reason code to be sent in the deauthentication
2557 * frame
2558 *
2559 * Returns: 0 on success, -1 on failure
2560 */
Hai Shalom81f62d82019-07-22 12:10:00 -07002561 int (*deauthenticate)(void *priv, const u8 *addr, u16 reason_code);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002562
2563 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002564 * associate - Request driver to associate
2565 * @priv: private driver interface data
2566 * @params: association parameters
2567 *
2568 * Returns: 0 on success, -1 on failure
2569 */
2570 int (*associate)(void *priv,
2571 struct wpa_driver_associate_params *params);
2572
2573 /**
2574 * add_pmkid - Add PMKSA cache entry to the driver
2575 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002576 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002577 *
2578 * Returns: 0 on success, -1 on failure
2579 *
2580 * This function is called when a new PMK is received, as a result of
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002581 * either normal authentication or RSN pre-authentication. The PMKSA
2582 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2583 * ssid, fils_cache_id, pmkid, and pmk.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002584 *
2585 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2586 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2587 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2588 * driver_ops function does not need to be implemented. Likewise, if
2589 * the driver does not support WPA, this function is not needed.
2590 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002591 int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002592
2593 /**
2594 * remove_pmkid - Remove PMKSA cache entry to the driver
2595 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002596 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002597 *
2598 * Returns: 0 on success, -1 on failure
2599 *
2600 * This function is called when the supplicant drops a PMKSA cache
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002601 * entry for any reason. The PMKSA parameters are either a set of
2602 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002603 *
2604 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2605 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2606 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2607 * from wpa_supplicant, this driver_ops function does not need to be
2608 * implemented. Likewise, if the driver does not support WPA, this
2609 * function is not needed.
2610 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002611 int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002612
2613 /**
2614 * flush_pmkid - Flush PMKSA cache
2615 * @priv: private driver interface data
2616 *
2617 * Returns: 0 on success, -1 on failure
2618 *
2619 * This function is called when the supplicant drops all PMKSA cache
2620 * entries for any reason.
2621 *
2622 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2623 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2624 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2625 * from wpa_supplicant, this driver_ops function does not need to be
2626 * implemented. Likewise, if the driver does not support WPA, this
2627 * function is not needed.
2628 */
2629 int (*flush_pmkid)(void *priv);
2630
2631 /**
2632 * get_capa - Get driver capabilities
2633 * @priv: private driver interface data
2634 *
2635 * Returns: 0 on success, -1 on failure
2636 *
2637 * Get driver/firmware/hardware capabilities.
2638 */
2639 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
2640
2641 /**
2642 * poll - Poll driver for association information
2643 * @priv: private driver interface data
2644 *
2645 * This is an option callback that can be used when the driver does not
2646 * provide event mechanism for association events. This is called when
2647 * receiving WPA EAPOL-Key messages that require association
2648 * information. The driver interface is supposed to generate associnfo
2649 * event before returning from this callback function. In addition, the
2650 * driver interface should generate an association event after having
2651 * sent out associnfo.
2652 */
2653 void (*poll)(void *priv);
2654
2655 /**
Dmitry Shmidte4663042016-04-04 10:07:49 -07002656 * get_ifindex - Get interface index
2657 * @priv: private driver interface data
2658 *
2659 * Returns: Interface index
2660 */
2661 unsigned int (*get_ifindex)(void *priv);
2662
2663 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002664 * get_ifname - Get interface name
2665 * @priv: private driver interface data
2666 *
2667 * Returns: Pointer to the interface name. This can differ from the
2668 * interface name used in init() call. Init() is called first.
2669 *
2670 * This optional function can be used to allow the driver interface to
2671 * replace the interface name with something else, e.g., based on an
2672 * interface mapping from a more descriptive name.
2673 */
2674 const char * (*get_ifname)(void *priv);
2675
2676 /**
2677 * get_mac_addr - Get own MAC address
2678 * @priv: private driver interface data
2679 *
2680 * Returns: Pointer to own MAC address or %NULL on failure
2681 *
2682 * This optional function can be used to get the own MAC address of the
2683 * device from the driver interface code. This is only needed if the
2684 * l2_packet implementation for the OS does not provide easy access to
2685 * a MAC address. */
2686 const u8 * (*get_mac_addr)(void *priv);
2687
2688 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002689 * set_operstate - Sets device operating state to DORMANT or UP
2690 * @priv: private driver interface data
2691 * @state: 0 = dormant, 1 = up
2692 * Returns: 0 on success, -1 on failure
2693 *
2694 * This is an optional function that can be used on operating systems
2695 * that support a concept of controlling network device state from user
2696 * space applications. This function, if set, gets called with
2697 * state = 1 when authentication has been completed and with state = 0
2698 * when connection is lost.
2699 */
2700 int (*set_operstate)(void *priv, int state);
2701
2702 /**
2703 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2704 * @priv: Private driver interface data
2705 * @addr: Address of the station for which to set protection (may be
2706 * %NULL for group keys)
2707 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2708 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2709 * Returns: 0 on success, -1 on failure
2710 *
2711 * This is an optional function that can be used to set the driver to
2712 * require protection for Tx and/or Rx frames. This uses the layer
2713 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2714 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2715 * set protection operation; instead, they set protection implicitly
2716 * based on configured keys.
2717 */
2718 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2719 int key_type);
2720
2721 /**
2722 * get_hw_feature_data - Get hardware support data (channels and rates)
2723 * @priv: Private driver interface data
2724 * @num_modes: Variable for returning the number of returned modes
2725 * flags: Variable for returning hardware feature flags
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002726 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002727 * Returns: Pointer to allocated hardware data on success or %NULL on
2728 * failure. Caller is responsible for freeing this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002729 */
2730 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2731 u16 *num_modes,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002732 u16 *flags, u8 *dfs);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002733
2734 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002735 * send_mlme - Send management frame from MLME
2736 * @priv: Private driver interface data
2737 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2738 * @data_len: Size of the management frame
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002739 * @noack: Do not wait for this frame to be acked (disable retries)
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07002740 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2741 * driver decide
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002742 * @csa_offs: Array of CSA offsets or %NULL
2743 * @csa_offs_len: Number of elements in csa_offs
Hai Shalomfdcde762020-04-02 11:19:20 -07002744 * @no_encrypt: Do not encrypt frame even if appropriate key exists
2745 * (used only for testing purposes)
2746 * @wait: Time to wait off-channel for a response (in ms), or zero
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002747 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002748 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002749 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002750 int noack, unsigned int freq, const u16 *csa_offs,
Hai Shalomfdcde762020-04-02 11:19:20 -07002751 size_t csa_offs_len, int no_encrypt,
2752 unsigned int wait);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002753
2754 /**
2755 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2756 * @priv: Private driver interface data
2757 * @md: Mobility domain (2 octets) (also included inside ies)
2758 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2759 * @ies_len: Length of FT IEs in bytes
2760 * Returns: 0 on success, -1 on failure
2761 *
2762 * The supplicant uses this callback to let the driver know that keying
2763 * material for FT is available and that the driver can use the
2764 * provided IEs in the next message in FT authentication sequence.
2765 *
2766 * This function is only needed for driver that support IEEE 802.11r
2767 * (Fast BSS Transition).
2768 */
2769 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2770 size_t ies_len);
2771
2772 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002773 * get_scan_results2 - Fetch the latest scan results
2774 * @priv: private driver interface data
2775 *
2776 * Returns: Allocated buffer of scan results (caller is responsible for
2777 * freeing the data structure) on success, NULL on failure
2778 */
2779 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2780
2781 /**
2782 * set_country - Set country
2783 * @priv: Private driver interface data
2784 * @alpha2: country to which to switch to
2785 * Returns: 0 on success, -1 on failure
2786 *
2787 * This function is for drivers which support some form
2788 * of setting a regulatory domain.
2789 */
2790 int (*set_country)(void *priv, const char *alpha2);
2791
2792 /**
Dmitry Shmidtcce06662013-11-04 18:44:24 -08002793 * get_country - Get country
2794 * @priv: Private driver interface data
2795 * @alpha2: Buffer for returning country code (at least 3 octets)
2796 * Returns: 0 on success, -1 on failure
2797 */
2798 int (*get_country)(void *priv, char *alpha2);
2799
2800 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002801 * global_init - Global driver initialization
Dmitry Shmidte4663042016-04-04 10:07:49 -07002802 * @ctx: wpa_global pointer
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002803 * Returns: Pointer to private data (global), %NULL on failure
2804 *
2805 * This optional function is called to initialize the driver wrapper
2806 * for global data, i.e., data that applies to all interfaces. If this
2807 * function is implemented, global_deinit() will also need to be
2808 * implemented to free the private data. The driver will also likely
2809 * use init2() function instead of init() to get the pointer to global
2810 * data available to per-interface initializer.
2811 */
Dmitry Shmidte4663042016-04-04 10:07:49 -07002812 void * (*global_init)(void *ctx);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002813
2814 /**
2815 * global_deinit - Global driver deinitialization
2816 * @priv: private driver global data from global_init()
2817 *
2818 * Terminate any global driver related functionality and free the
2819 * global data structure.
2820 */
2821 void (*global_deinit)(void *priv);
2822
2823 /**
2824 * init2 - Initialize driver interface (with global data)
2825 * @ctx: context to be used when calling wpa_supplicant functions,
2826 * e.g., wpa_supplicant_event()
2827 * @ifname: interface name, e.g., wlan0
2828 * @global_priv: private driver global data from global_init()
2829 * Returns: Pointer to private data, %NULL on failure
2830 *
2831 * This function can be used instead of init() if the driver wrapper
2832 * uses global data.
2833 */
2834 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2835
2836 /**
2837 * get_interfaces - Get information about available interfaces
2838 * @global_priv: private driver global data from global_init()
2839 * Returns: Allocated buffer of interface information (caller is
2840 * responsible for freeing the data structure) on success, NULL on
2841 * failure
2842 */
2843 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2844
2845 /**
2846 * scan2 - Request the driver to initiate scan
2847 * @priv: private driver interface data
2848 * @params: Scan parameters
2849 *
2850 * Returns: 0 on success, -1 on failure
2851 *
2852 * Once the scan results are ready, the driver should report scan
2853 * results event for wpa_supplicant which will eventually request the
2854 * results with wpa_driver_get_scan_results2().
2855 */
2856 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2857
2858 /**
2859 * authenticate - Request driver to authenticate
2860 * @priv: private driver interface data
2861 * @params: authentication parameters
2862 * Returns: 0 on success, -1 on failure
2863 *
2864 * This is an optional function that can be used with drivers that
2865 * support separate authentication and association steps, i.e., when
2866 * wpa_supplicant can act as the SME. If not implemented, associate()
2867 * function is expected to take care of IEEE 802.11 authentication,
2868 * too.
2869 */
2870 int (*authenticate)(void *priv,
2871 struct wpa_driver_auth_params *params);
2872
2873 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002874 * set_ap - Set Beacon and Probe Response information for AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002875 * @priv: Private driver interface data
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002876 * @params: Parameters to use in AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002877 *
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002878 * This function is used to configure Beacon template and/or extra IEs
2879 * to add for Beacon and Probe Response frames for the driver in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002880 * AP mode. The driver is responsible for building the full Beacon
2881 * frame by concatenating the head part with TIM IE generated by the
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002882 * driver/firmware and finishing with the tail part. Depending on the
2883 * driver architectue, this can be done either by using the full
2884 * template or the set of additional IEs (e.g., WPS and P2P IE).
2885 * Similarly, Probe Response processing depends on the driver design.
2886 * If the driver (or firmware) takes care of replying to Probe Request
2887 * frames, the extra IEs provided here needs to be added to the Probe
2888 * Response frames.
2889 *
2890 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002891 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002892 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002893
2894 /**
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002895 * set_acl - Set ACL in AP mode
2896 * @priv: Private driver interface data
2897 * @params: Parameters to configure ACL
2898 * Returns: 0 on success, -1 on failure
2899 *
2900 * This is used only for the drivers which support MAC address ACL.
2901 */
2902 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2903
2904 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002905 * hapd_init - Initialize driver interface (hostapd only)
2906 * @hapd: Pointer to hostapd context
2907 * @params: Configuration for the driver wrapper
2908 * Returns: Pointer to private data, %NULL on failure
2909 *
2910 * This function is used instead of init() or init2() when the driver
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002911 * wrapper is used with hostapd.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002912 */
2913 void * (*hapd_init)(struct hostapd_data *hapd,
2914 struct wpa_init_params *params);
2915
2916 /**
2917 * hapd_deinit - Deinitialize driver interface (hostapd only)
2918 * @priv: Private driver interface data from hapd_init()
2919 */
2920 void (*hapd_deinit)(void *priv);
2921
2922 /**
2923 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2924 * @priv: Private driver interface data
2925 * @params: BSS parameters
2926 * Returns: 0 on success, -1 on failure
2927 *
2928 * This is an optional function to configure the kernel driver to
2929 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2930 * can be left undefined (set to %NULL) if IEEE 802.1X support is
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002931 * always enabled and the driver uses set_ap() to set WPA/RSN IE
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002932 * for Beacon frames.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002933 *
2934 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002935 */
2936 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2937
2938 /**
2939 * set_privacy - Enable/disable privacy (AP only)
2940 * @priv: Private driver interface data
2941 * @enabled: 1 = privacy enabled, 0 = disabled
2942 * Returns: 0 on success, -1 on failure
2943 *
2944 * This is an optional function to configure privacy field in the
2945 * kernel driver for Beacon frames. This can be left undefined (set to
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002946 * %NULL) if the driver uses the Beacon template from set_ap().
2947 *
2948 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002949 */
2950 int (*set_privacy)(void *priv, int enabled);
2951
2952 /**
2953 * get_seqnum - Fetch the current TSC/packet number (AP only)
2954 * @ifname: The interface name (main or virtual)
2955 * @priv: Private driver interface data
2956 * @addr: MAC address of the station or %NULL for group keys
2957 * @idx: Key index
2958 * @seq: Buffer for returning the latest used TSC/packet number
2959 * Returns: 0 on success, -1 on failure
2960 *
2961 * This function is used to fetch the last used TSC/packet number for
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002962 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2963 * keys, so there is no strict requirement on implementing support for
2964 * unicast keys (i.e., addr != %NULL).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002965 */
2966 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2967 int idx, u8 *seq);
2968
2969 /**
2970 * flush - Flush all association stations (AP only)
2971 * @priv: Private driver interface data
2972 * Returns: 0 on success, -1 on failure
2973 *
2974 * This function requests the driver to disassociate all associated
2975 * stations. This function does not need to be implemented if the
2976 * driver does not process association frames internally.
2977 */
2978 int (*flush)(void *priv);
2979
2980 /**
2981 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2982 * @priv: Private driver interface data
2983 * @elem: Information elements
2984 * @elem_len: Length of the elem buffer in octets
2985 * Returns: 0 on success, -1 on failure
2986 *
2987 * This is an optional function to add information elements in the
2988 * kernel driver for Beacon and Probe Response frames. This can be left
2989 * undefined (set to %NULL) if the driver uses the Beacon template from
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002990 * set_ap().
2991 *
2992 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002993 */
2994 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2995
2996 /**
Jouni Malinen1e6c57f2012-09-05 17:07:03 +03002997 * read_sta_data - Fetch station data
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002998 * @priv: Private driver interface data
2999 * @data: Buffer for returning station information
3000 * @addr: MAC address of the station
3001 * Returns: 0 on success, -1 on failure
3002 */
3003 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
3004 const u8 *addr);
3005
3006 /**
Hai Shalomfdcde762020-04-02 11:19:20 -07003007 * tx_control_port - Send a frame over the 802.1X controlled port
3008 * @priv: Private driver interface data
3009 * @dest: Destination MAC address
3010 * @proto: Ethertype in host byte order
3011 * @buf: Frame payload starting from IEEE 802.1X header
3012 * @len: Frame payload length
3013 * @no_encrypt: Do not encrypt frame
3014 *
3015 * Returns 0 on success, else an error
3016 *
3017 * This is like a normal Ethernet send except that the driver is aware
3018 * (by other means than the Ethertype) that this frame is special,
3019 * and more importantly it gains an ordering between the transmission of
3020 * the frame and other driver management operations such as key
3021 * installations. This can be used to work around known limitations in
3022 * IEEE 802.11 protocols such as race conditions between rekeying 4-way
3023 * handshake message 4/4 and a PTK being overwritten.
3024 *
3025 * This function is only used for a given interface if the driver
3026 * instance reports WPA_DRIVER_FLAGS_CONTROL_PORT capability. Otherwise,
3027 * API users will fall back to sending the frame via a normal socket.
3028 */
3029 int (*tx_control_port)(void *priv, const u8 *dest,
3030 u16 proto, const u8 *buf, size_t len,
3031 int no_encrypt);
3032
3033 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003034 * hapd_send_eapol - Send an EAPOL packet (AP only)
3035 * @priv: private driver interface data
3036 * @addr: Destination MAC address
3037 * @data: EAPOL packet starting with IEEE 802.1X header
3038 * @data_len: Length of the EAPOL packet in octets
3039 * @encrypt: Whether the frame should be encrypted
3040 * @own_addr: Source MAC address
3041 * @flags: WPA_STA_* flags for the destination station
3042 *
3043 * Returns: 0 on success, -1 on failure
3044 */
3045 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
3046 size_t data_len, int encrypt,
3047 const u8 *own_addr, u32 flags);
3048
3049 /**
3050 * sta_deauth - Deauthenticate a station (AP only)
3051 * @priv: Private driver interface data
3052 * @own_addr: Source address and BSSID for the Deauthentication frame
3053 * @addr: MAC address of the station to deauthenticate
3054 * @reason: Reason code for the Deauthentiation frame
3055 * Returns: 0 on success, -1 on failure
3056 *
3057 * This function requests a specific station to be deauthenticated and
3058 * a Deauthentication frame to be sent to it.
3059 */
3060 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07003061 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003062
3063 /**
3064 * sta_disassoc - Disassociate a station (AP only)
3065 * @priv: Private driver interface data
3066 * @own_addr: Source address and BSSID for the Disassociation frame
3067 * @addr: MAC address of the station to disassociate
3068 * @reason: Reason code for the Disassociation frame
3069 * Returns: 0 on success, -1 on failure
3070 *
3071 * This function requests a specific station to be disassociated and
3072 * a Disassociation frame to be sent to it.
3073 */
3074 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07003075 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003076
3077 /**
3078 * sta_remove - Remove a station entry (AP only)
3079 * @priv: Private driver interface data
3080 * @addr: MAC address of the station to be removed
3081 * Returns: 0 on success, -1 on failure
3082 */
3083 int (*sta_remove)(void *priv, const u8 *addr);
3084
3085 /**
3086 * hapd_get_ssid - Get the current SSID (AP only)
3087 * @priv: Private driver interface data
3088 * @buf: Buffer for returning the SSID
3089 * @len: Maximum length of the buffer
3090 * Returns: Length of the SSID on success, -1 on failure
3091 *
3092 * This function need not be implemented if the driver uses Beacon
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003093 * template from set_ap() and does not reply to Probe Request frames.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003094 */
3095 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
3096
3097 /**
3098 * hapd_set_ssid - Set SSID (AP only)
3099 * @priv: Private driver interface data
3100 * @buf: SSID
3101 * @len: Length of the SSID in octets
3102 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003103 *
3104 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003105 */
3106 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
3107
3108 /**
3109 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
3110 * @priv: Private driver interface data
3111 * @enabled: 1 = countermeasures enabled, 0 = disabled
3112 * Returns: 0 on success, -1 on failure
3113 *
3114 * This need not be implemented if the driver does not take care of
3115 * association processing.
3116 */
3117 int (*hapd_set_countermeasures)(void *priv, int enabled);
3118
3119 /**
3120 * sta_add - Add a station entry
3121 * @priv: Private driver interface data
3122 * @params: Station parameters
3123 * Returns: 0 on success, -1 on failure
3124 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08003125 * This function is used to add or set (params->set 1) a station
3126 * entry in the driver. Adding STA entries is used only if the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003127 * does not take care of association processing.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003128 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08003129 * With drivers that don't support full AP client state, this function
3130 * is used to add a station entry to the driver once the station has
3131 * completed association.
3132 *
3133 * With TDLS, this function is used to add or set (params->set 1)
3134 * TDLS peer entries (even with drivers that do not support full AP
3135 * client state).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003136 */
3137 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
3138
3139 /**
3140 * get_inact_sec - Get station inactivity duration (AP only)
3141 * @priv: Private driver interface data
3142 * @addr: Station address
3143 * Returns: Number of seconds station has been inactive, -1 on failure
3144 */
3145 int (*get_inact_sec)(void *priv, const u8 *addr);
3146
3147 /**
3148 * sta_clear_stats - Clear station statistics (AP only)
3149 * @priv: Private driver interface data
3150 * @addr: Station address
3151 * Returns: 0 on success, -1 on failure
3152 */
3153 int (*sta_clear_stats)(void *priv, const u8 *addr);
3154
3155 /**
3156 * set_freq - Set channel/frequency (AP only)
3157 * @priv: Private driver interface data
3158 * @freq: Channel parameters
3159 * Returns: 0 on success, -1 on failure
3160 */
3161 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
3162
3163 /**
3164 * set_rts - Set RTS threshold
3165 * @priv: Private driver interface data
3166 * @rts: RTS threshold in octets
3167 * Returns: 0 on success, -1 on failure
3168 */
3169 int (*set_rts)(void *priv, int rts);
3170
3171 /**
3172 * set_frag - Set fragmentation threshold
3173 * @priv: Private driver interface data
3174 * @frag: Fragmentation threshold in octets
3175 * Returns: 0 on success, -1 on failure
3176 */
3177 int (*set_frag)(void *priv, int frag);
3178
3179 /**
3180 * sta_set_flags - Set station flags (AP only)
3181 * @priv: Private driver interface data
3182 * @addr: Station address
3183 * @total_flags: Bitmap of all WPA_STA_* flags currently set
3184 * @flags_or: Bitmap of WPA_STA_* flags to add
3185 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
3186 * Returns: 0 on success, -1 on failure
3187 */
3188 int (*sta_set_flags)(void *priv, const u8 *addr,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08003189 unsigned int total_flags, unsigned int flags_or,
3190 unsigned int flags_and);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003191
3192 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07003193 * sta_set_airtime_weight - Set station airtime weight (AP only)
3194 * @priv: Private driver interface data
3195 * @addr: Station address
3196 * @weight: New weight for station airtime assignment
3197 * Returns: 0 on success, -1 on failure
3198 */
3199 int (*sta_set_airtime_weight)(void *priv, const u8 *addr,
3200 unsigned int weight);
3201
3202 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003203 * set_tx_queue_params - Set TX queue parameters
3204 * @priv: Private driver interface data
3205 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
3206 * @aifs: AIFS
3207 * @cw_min: cwMin
3208 * @cw_max: cwMax
3209 * @burst_time: Maximum length for bursting in 0.1 msec units
3210 */
3211 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
3212 int cw_max, int burst_time);
3213
3214 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003215 * if_add - Add a virtual interface
3216 * @priv: Private driver interface data
3217 * @type: Interface type
3218 * @ifname: Interface name for the new virtual interface
3219 * @addr: Local address to use for the interface or %NULL to use the
3220 * parent interface address
3221 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
3222 * @drv_priv: Pointer for overwriting the driver context or %NULL if
3223 * not allowed (applies only to %WPA_IF_AP_BSS type)
3224 * @force_ifname: Buffer for returning an interface name that the
3225 * driver ended up using if it differs from the requested ifname
3226 * @if_addr: Buffer for returning the allocated interface address
3227 * (this may differ from the requested addr if the driver cannot
3228 * change interface address)
3229 * @bridge: Bridge interface to use or %NULL if no bridge configured
Dmitry Shmidtcce06662013-11-04 18:44:24 -08003230 * @use_existing: Whether to allow existing interface to be used
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003231 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003232 * Returns: 0 on success, -1 on failure
3233 */
3234 int (*if_add)(void *priv, enum wpa_driver_if_type type,
3235 const char *ifname, const u8 *addr, void *bss_ctx,
3236 void **drv_priv, char *force_ifname, u8 *if_addr,
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003237 const char *bridge, int use_existing, int setup_ap);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003238
3239 /**
3240 * if_remove - Remove a virtual interface
3241 * @priv: Private driver interface data
3242 * @type: Interface type
3243 * @ifname: Interface name of the virtual interface to be removed
3244 * Returns: 0 on success, -1 on failure
3245 */
3246 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
3247 const char *ifname);
3248
3249 /**
3250 * set_sta_vlan - Bind a station into a specific interface (AP only)
3251 * @priv: Private driver interface data
3252 * @ifname: Interface (main or virtual BSS or VLAN)
3253 * @addr: MAC address of the associated station
3254 * @vlan_id: VLAN ID
3255 * Returns: 0 on success, -1 on failure
3256 *
3257 * This function is used to bind a station to a specific virtual
3258 * interface. It is only used if when virtual interfaces are supported,
3259 * e.g., to assign stations to different VLAN interfaces based on
3260 * information from a RADIUS server. This allows separate broadcast
3261 * domains to be used with a single BSS.
3262 */
3263 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
3264 int vlan_id);
3265
3266 /**
3267 * commit - Optional commit changes handler (AP only)
3268 * @priv: driver private data
3269 * Returns: 0 on success, -1 on failure
3270 *
3271 * This optional handler function can be registered if the driver
3272 * interface implementation needs to commit changes (e.g., by setting
3273 * network interface up) at the end of initial configuration. If set,
3274 * this handler will be called after initial setup has been completed.
3275 */
3276 int (*commit)(void *priv);
3277
3278 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003279 * set_radius_acl_auth - Notification of RADIUS ACL change
3280 * @priv: Private driver interface data
3281 * @mac: MAC address of the station
3282 * @accepted: Whether the station was accepted
3283 * @session_timeout: Session timeout for the station
3284 * Returns: 0 on success, -1 on failure
3285 */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003286 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003287 u32 session_timeout);
3288
3289 /**
3290 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3291 * @priv: Private driver interface data
3292 * @mac: MAC address of the station
3293 * Returns: 0 on success, -1 on failure
3294 */
3295 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
3296
3297 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003298 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
3299 * @priv: Private driver interface data
3300 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3301 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3302 * extra IE(s)
3303 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3304 * to remove extra IE(s)
3305 * Returns: 0 on success, -1 on failure
3306 *
3307 * This is an optional function to add WPS IE in the kernel driver for
3308 * Beacon and Probe Response frames. This can be left undefined (set
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003309 * to %NULL) if the driver uses the Beacon template from set_ap()
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003310 * and does not process Probe Request frames. If the driver takes care
3311 * of (Re)Association frame processing, the assocresp buffer includes
3312 * WPS IE(s) that need to be added to (Re)Association Response frames
3313 * whenever a (Re)Association Request frame indicated use of WPS.
3314 *
3315 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3316 * frames when operating as a GO. The driver is responsible for adding
3317 * timing related attributes (e.g., NoA) in addition to the IEs
3318 * included here by appending them after these buffers. This call is
3319 * also used to provide Probe Response IEs for P2P Listen state
3320 * operations for drivers that generate the Probe Response frames
3321 * internally.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003322 *
3323 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003324 */
3325 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
3326 const struct wpabuf *proberesp,
3327 const struct wpabuf *assocresp);
3328
3329 /**
3330 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3331 * @priv: Private driver interface data
3332 * @authorized: Whether the port is authorized
3333 * Returns: 0 on success, -1 on failure
3334 */
3335 int (*set_supp_port)(void *priv, int authorized);
3336
3337 /**
3338 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3339 * @priv: Private driver interface data
3340 * @addr: MAC address of the associated station
3341 * @aid: Association ID
3342 * @val: 1 = bind to 4-address WDS; 0 = unbind
3343 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3344 * to indicate that bridge is not to be used
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07003345 * @ifname_wds: Buffer to return the interface name for the new WDS
3346 * station or %NULL to indicate name is not returned.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003347 * Returns: 0 on success, -1 on failure
3348 */
3349 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003350 const char *bridge_ifname, char *ifname_wds);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003351
3352 /**
3353 * send_action - Transmit an Action frame
3354 * @priv: Private driver interface data
3355 * @freq: Frequency (in MHz) of the channel
3356 * @wait: Time to wait off-channel for a response (in ms), or zero
3357 * @dst: Destination MAC address (Address 1)
3358 * @src: Source MAC address (Address 2)
3359 * @bssid: BSSID (Address 3)
3360 * @data: Frame body
3361 * @data_len: data length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003362 @ @no_cck: Whether CCK rates must not be used to transmit this frame
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003363 * Returns: 0 on success, -1 on failure
3364 *
3365 * This command can be used to request the driver to transmit an action
3366 * frame to the specified destination.
3367 *
3368 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3369 * be transmitted on the given channel and the device will wait for a
3370 * response on that channel for the given wait time.
3371 *
3372 * If the flag is not set, the wait time will be ignored. In this case,
3373 * if a remain-on-channel duration is in progress, the frame must be
3374 * transmitted on that channel; alternatively the frame may be sent on
3375 * the current operational channel (if in associated state in station
3376 * mode or while operating as an AP.)
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08003377 *
3378 * If @src differs from the device MAC address, use of a random
3379 * transmitter address is requested for this message exchange.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003380 */
3381 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
3382 const u8 *dst, const u8 *src, const u8 *bssid,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003383 const u8 *data, size_t data_len, int no_cck);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003384
3385 /**
3386 * send_action_cancel_wait - Cancel action frame TX wait
3387 * @priv: Private driver interface data
3388 *
3389 * This command cancels the wait time associated with sending an action
3390 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3391 * set in the driver flags.
3392 */
3393 void (*send_action_cancel_wait)(void *priv);
3394
3395 /**
3396 * remain_on_channel - Remain awake on a channel
3397 * @priv: Private driver interface data
3398 * @freq: Frequency (in MHz) of the channel
3399 * @duration: Duration in milliseconds
3400 * Returns: 0 on success, -1 on failure
3401 *
3402 * This command is used to request the driver to remain awake on the
3403 * specified channel for the specified duration and report received
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08003404 * Action frames with EVENT_RX_MGMT events. Optionally, received
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003405 * Probe Request frames may also be requested to be reported by calling
3406 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3407 *
3408 * The driver may not be at the requested channel when this function
3409 * returns, i.e., the return code is only indicating whether the
3410 * request was accepted. The caller will need to wait until the
3411 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3412 * completed the channel change. This may take some time due to other
3413 * need for the radio and the caller should be prepared to timing out
3414 * its wait since there are no guarantees on when this request can be
3415 * executed.
3416 */
3417 int (*remain_on_channel)(void *priv, unsigned int freq,
3418 unsigned int duration);
3419
3420 /**
3421 * cancel_remain_on_channel - Cancel remain-on-channel operation
3422 * @priv: Private driver interface data
3423 *
3424 * This command can be used to cancel a remain-on-channel operation
3425 * before its originally requested duration has passed. This could be
3426 * used, e.g., when remain_on_channel() is used to request extra time
3427 * to receive a response to an Action frame and the response is
3428 * received when there is still unneeded time remaining on the
3429 * remain-on-channel operation.
3430 */
3431 int (*cancel_remain_on_channel)(void *priv);
3432
3433 /**
3434 * probe_req_report - Request Probe Request frames to be indicated
3435 * @priv: Private driver interface data
3436 * @report: Whether to report received Probe Request frames
3437 * Returns: 0 on success, -1 on failure (or if not supported)
3438 *
3439 * This command can be used to request the driver to indicate when
3440 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3441 * Since this operation may require extra resources, e.g., due to less
3442 * optimal hardware/firmware RX filtering, many drivers may disable
3443 * Probe Request reporting at least in station mode. This command is
3444 * used to notify the driver when the Probe Request frames need to be
3445 * reported, e.g., during remain-on-channel operations.
3446 */
3447 int (*probe_req_report)(void *priv, int report);
3448
3449 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003450 * deinit_ap - Deinitialize AP mode
3451 * @priv: Private driver interface data
3452 * Returns: 0 on success, -1 on failure (or if not supported)
3453 *
3454 * This optional function can be used to disable AP mode related
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003455 * configuration. If the interface was not dynamically added,
3456 * change the driver mode to station mode to allow normal station
3457 * operations like scanning to be completed.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003458 */
3459 int (*deinit_ap)(void *priv);
3460
3461 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003462 * deinit_p2p_cli - Deinitialize P2P client mode
3463 * @priv: Private driver interface data
3464 * Returns: 0 on success, -1 on failure (or if not supported)
3465 *
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003466 * This optional function can be used to disable P2P client mode. If the
3467 * interface was not dynamically added, change the interface type back
3468 * to station mode.
Dmitry Shmidt04949592012-07-19 12:16:46 -07003469 */
3470 int (*deinit_p2p_cli)(void *priv);
3471
3472 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003473 * suspend - Notification on system suspend/hibernate event
3474 * @priv: Private driver interface data
3475 */
3476 void (*suspend)(void *priv);
3477
3478 /**
3479 * resume - Notification on system resume/thaw event
3480 * @priv: Private driver interface data
3481 */
3482 void (*resume)(void *priv);
3483
3484 /**
3485 * signal_monitor - Set signal monitoring parameters
3486 * @priv: Private driver interface data
3487 * @threshold: Threshold value for signal change events; 0 = disabled
3488 * @hysteresis: Minimum change in signal strength before indicating a
3489 * new event
3490 * Returns: 0 on success, -1 on failure (or if not supported)
3491 *
3492 * This function can be used to configure monitoring of signal strength
3493 * with the current AP. Whenever signal strength drops below the
3494 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3495 * should be generated assuming the signal strength has changed at
3496 * least %hysteresis from the previously indicated signal change event.
3497 */
3498 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
3499
3500 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003501 * get_noa - Get current Notice of Absence attribute payload
3502 * @priv: Private driver interface data
3503 * @buf: Buffer for returning NoA
3504 * @buf_len: Buffer length in octets
3505 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3506 * advertized, or -1 on failure
3507 *
3508 * This function is used to fetch the current Notice of Absence
3509 * attribute value from GO.
3510 */
3511 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
3512
3513 /**
3514 * set_noa - Set Notice of Absence parameters for GO (testing)
3515 * @priv: Private driver interface data
3516 * @count: Count
3517 * @start: Start time in ms from next TBTT
3518 * @duration: Duration in ms
3519 * Returns: 0 on success or -1 on failure
3520 *
3521 * This function is used to set Notice of Absence parameters for GO. It
3522 * is used only for testing. To disable NoA, all parameters are set to
3523 * 0.
3524 */
3525 int (*set_noa)(void *priv, u8 count, int start, int duration);
3526
3527 /**
3528 * set_p2p_powersave - Set P2P power save options
3529 * @priv: Private driver interface data
3530 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3531 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3532 * @ctwindow: 0.. = change (msec), -1 = no change
3533 * Returns: 0 on success or -1 on failure
3534 */
3535 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
3536 int ctwindow);
3537
3538 /**
3539 * ampdu - Enable/disable aggregation
3540 * @priv: Private driver interface data
3541 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3542 * Returns: 0 on success or -1 on failure
3543 */
3544 int (*ampdu)(void *priv, int ampdu);
3545
3546 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003547 * get_radio_name - Get physical radio name for the device
3548 * @priv: Private driver interface data
3549 * Returns: Radio name or %NULL if not known
3550 *
3551 * The returned data must not be modified by the caller. It is assumed
3552 * that any interface that has the same radio name as another is
3553 * sharing the same physical radio. This information can be used to
3554 * share scan results etc. information between the virtual interfaces
3555 * to speed up various operations.
3556 */
3557 const char * (*get_radio_name)(void *priv);
3558
3559 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003560 * send_tdls_mgmt - for sending TDLS management packets
3561 * @priv: private driver interface data
3562 * @dst: Destination (peer) MAC address
3563 * @action_code: TDLS action code for the mssage
3564 * @dialog_token: Dialog Token to use in the message (if needed)
3565 * @status_code: Status Code or Reason Code to use (if needed)
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003566 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003567 * @initiator: Is the current end the TDLS link initiator
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003568 * @buf: TDLS IEs to add to the message
3569 * @len: Length of buf in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003570 * Returns: 0 on success, negative (<0) on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003571 *
3572 * This optional function can be used to send packet to driver which is
3573 * responsible for receiving and sending all TDLS packets.
3574 */
3575 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003576 u8 dialog_token, u16 status_code, u32 peer_capab,
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003577 int initiator, const u8 *buf, size_t len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003578
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003579 /**
3580 * tdls_oper - Ask the driver to perform high-level TDLS operations
3581 * @priv: Private driver interface data
3582 * @oper: TDLS high-level operation. See %enum tdls_oper
3583 * @peer: Destination (peer) MAC address
3584 * Returns: 0 on success, negative (<0) on failure
3585 *
3586 * This optional function can be used to send high-level TDLS commands
3587 * to the driver.
3588 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003589 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
3590
3591 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07003592 * wnm_oper - Notify driver of the WNM frame reception
3593 * @priv: Private driver interface data
3594 * @oper: WNM operation. See %enum wnm_oper
3595 * @peer: Destination (peer) MAC address
3596 * @buf: Buffer for the driver to fill in (for getting IE)
3597 * @buf_len: Return the len of buf
3598 * Returns: 0 on success, negative (<0) on failure
3599 */
3600 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
3601 u8 *buf, u16 *buf_len);
3602
3603 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -07003604 * set_qos_map - Set QoS Map
3605 * @priv: Private driver interface data
3606 * @qos_map_set: QoS Map
3607 * @qos_map_set_len: Length of QoS Map
3608 */
3609 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
3610 u8 qos_map_set_len);
3611
3612 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003613 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3614 * @priv: Private driver interface data
3615 * @version: IP version of the IP address, 4 or 6
3616 * @ipaddr: IP address for the neigh entry
3617 * @prefixlen: IP address prefix length
3618 * @addr: Corresponding MAC address
3619 * Returns: 0 on success, negative (<0) on failure
3620 */
3621 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
3622 int prefixlen, const u8 *addr);
3623
3624 /**
3625 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3626 * @priv: Private driver interface data
3627 * @version: IP version of the IP address, 4 or 6
3628 * @ipaddr: IP address for the neigh entry
3629 * Returns: 0 on success, negative (<0) on failure
3630 */
3631 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
3632
3633 /**
3634 * br_port_set_attr - Set a bridge port attribute
3635 * @attr: Bridge port attribute to set
3636 * @val: Value to be set
3637 * Returns: 0 on success, negative (<0) on failure
3638 */
3639 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
3640 unsigned int val);
3641
3642 /**
3643 * br_port_set_attr - Set a bridge network parameter
3644 * @param: Bridge parameter to set
3645 * @val: Value to be set
3646 * Returns: 0 on success, negative (<0) on failure
3647 */
3648 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
3649 unsigned int val);
3650
3651 /**
Hai Shalomfdcde762020-04-02 11:19:20 -07003652 * get_wowlan - Get wake-on-wireless status
3653 * @priv: Private driver interface data
3654 */
3655 int (*get_wowlan)(void *priv);
3656
3657 /**
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07003658 * set_wowlan - Set wake-on-wireless triggers
3659 * @priv: Private driver interface data
3660 * @triggers: wowlan triggers
3661 */
3662 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
3663
3664 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003665 * signal_poll - Get current connection information
3666 * @priv: Private driver interface data
3667 * @signal_info: Connection info structure
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003668 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003669 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003670
3671 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08003672 * channel_info - Get parameters of the current operating channel
3673 * @priv: Private driver interface data
3674 * @channel_info: Channel info structure
3675 * Returns: 0 on success, negative (<0) on failure
3676 */
3677 int (*channel_info)(void *priv, struct wpa_channel_info *channel_info);
3678
3679 /**
Jouni Malinen75ecf522011-06-27 15:19:46 -07003680 * set_authmode - Set authentication algorithm(s) for static WEP
3681 * @priv: Private driver interface data
3682 * @authmode: 1=Open System, 2=Shared Key, 3=both
3683 * Returns: 0 on success, -1 on failure
3684 *
3685 * This function can be used to set authentication algorithms for AP
3686 * mode when static WEP is used. If the driver uses user space MLME/SME
3687 * implementation, there is no need to implement this function.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003688 *
3689 * DEPRECATED - use set_ap() instead
Jouni Malinen75ecf522011-06-27 15:19:46 -07003690 */
3691 int (*set_authmode)(void *priv, int authmode);
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003692
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003693#ifdef ANDROID
Jouni Malinen75ecf522011-06-27 15:19:46 -07003694 /**
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003695 * driver_cmd - Execute driver-specific command
3696 * @priv: Private driver interface data
3697 * @cmd: Command to execute
3698 * @buf: Return buffer
3699 * @buf_len: Buffer length
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003700 * Returns: 0 on success, -1 on failure
3701 */
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003702 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
3703#endif /* ANDROID */
3704
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003705 /**
Dmitry Shmidta38abf92014-03-06 13:38:44 -08003706 * vendor_cmd - Execute vendor specific command
3707 * @priv: Private driver interface data
3708 * @vendor_id: Vendor id
3709 * @subcmd: Vendor command id
3710 * @data: Vendor command parameters (%NULL if no parameters)
3711 * @data_len: Data length
3712 * @buf: Return buffer (%NULL to ignore reply)
3713 * Returns: 0 on success, negative (<0) on failure
3714 *
3715 * This function handles vendor specific commands that are passed to
3716 * the driver/device. The command is identified by vendor id and
3717 * command id. Parameters can be passed as argument to the command
3718 * in the data buffer. Reply (if any) will be filled in the supplied
3719 * return buffer.
3720 *
3721 * The exact driver behavior is driver interface and vendor specific. As
3722 * an example, this will be converted to a vendor specific cfg80211
3723 * command in case of the nl80211 driver interface.
3724 */
3725 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3726 unsigned int subcmd, const u8 *data, size_t data_len,
3727 struct wpabuf *buf);
3728
3729 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003730 * set_rekey_info - Set rekey information
3731 * @priv: Private driver interface data
3732 * @kek: Current KEK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003733 * @kek_len: KEK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003734 * @kck: Current KCK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003735 * @kck_len: KCK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003736 * @replay_ctr: Current EAPOL-Key Replay Counter
3737 *
3738 * This optional function can be used to provide information for the
3739 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3740 * while the host (including wpa_supplicant) is sleeping.
3741 */
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003742 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3743 const u8 *kck, size_t kck_len,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003744 const u8 *replay_ctr);
3745
3746 /**
3747 * sta_assoc - Station association indication
3748 * @priv: Private driver interface data
3749 * @own_addr: Source address and BSSID for association frame
3750 * @addr: MAC address of the station to associate
3751 * @reassoc: flag to indicate re-association
3752 * @status: association response status code
3753 * @ie: assoc response ie buffer
3754 * @len: ie buffer length
3755 * Returns: 0 on success, -1 on failure
3756 *
3757 * This function indicates the driver to send (Re)Association
3758 * Response frame to the station.
3759 */
3760 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3761 int reassoc, u16 status, const u8 *ie, size_t len);
3762
3763 /**
3764 * sta_auth - Station authentication indication
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003765 * @priv: private driver interface data
3766 * @params: Station authentication parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003767 *
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003768 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003769 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003770 int (*sta_auth)(void *priv,
3771 struct wpa_driver_sta_auth_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003772
3773 /**
3774 * add_tspec - Add traffic stream
3775 * @priv: Private driver interface data
3776 * @addr: MAC address of the station to associate
3777 * @tspec_ie: tspec ie buffer
3778 * @tspec_ielen: tspec ie length
3779 * Returns: 0 on success, -1 on failure
3780 *
3781 * This function adds the traffic steam for the station
3782 * and fills the medium_time in tspec_ie.
3783 */
3784 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3785 size_t tspec_ielen);
3786
3787 /**
3788 * add_sta_node - Add a station node in the driver
3789 * @priv: Private driver interface data
3790 * @addr: MAC address of the station to add
3791 * @auth_alg: authentication algorithm used by the station
3792 * Returns: 0 on success, -1 on failure
3793 *
3794 * This function adds the station node in the driver, when
3795 * the station gets added by FT-over-DS.
3796 */
3797 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
3798
3799 /**
3800 * sched_scan - Request the driver to initiate scheduled scan
3801 * @priv: Private driver interface data
3802 * @params: Scan parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003803 * Returns: 0 on success, -1 on failure
3804 *
3805 * This operation should be used for scheduled scan offload to
3806 * the hardware. Every time scan results are available, the
3807 * driver should report scan results event for wpa_supplicant
3808 * which will eventually request the results with
3809 * wpa_driver_get_scan_results2(). This operation is optional
3810 * and if not provided or if it returns -1, we fall back to
3811 * normal host-scheduled scans.
3812 */
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003813 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003814
3815 /**
3816 * stop_sched_scan - Request the driver to stop a scheduled scan
3817 * @priv: Private driver interface data
3818 * Returns: 0 on success, -1 on failure
3819 *
3820 * This should cause the scheduled scan to be stopped and
3821 * results should stop being sent. Must be supported if
3822 * sched_scan is supported.
3823 */
3824 int (*stop_sched_scan)(void *priv);
3825
3826 /**
3827 * poll_client - Probe (null data or such) the given station
3828 * @priv: Private driver interface data
3829 * @own_addr: MAC address of sending interface
3830 * @addr: MAC address of the station to probe
3831 * @qos: Indicates whether station is QoS station
3832 *
3833 * This function is used to verify whether an associated station is
3834 * still present. This function does not need to be implemented if the
3835 * driver provides such inactivity polling mechanism.
3836 */
3837 void (*poll_client)(void *priv, const u8 *own_addr,
3838 const u8 *addr, int qos);
Dmitry Shmidt04949592012-07-19 12:16:46 -07003839
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003840 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003841 * radio_disable - Disable/enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003842 * @priv: Private driver interface data
Dmitry Shmidt04949592012-07-19 12:16:46 -07003843 * @disabled: 1=disable 0=enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003844 * Returns: 0 on success, -1 on failure
3845 *
Dmitry Shmidt04949592012-07-19 12:16:46 -07003846 * This optional command is for testing purposes. It can be used to
3847 * disable the radio on a testbed device to simulate out-of-radio-range
3848 * conditions.
3849 */
3850 int (*radio_disable)(void *priv, int disabled);
3851
3852 /**
3853 * switch_channel - Announce channel switch and migrate the GO to the
3854 * given frequency
3855 * @priv: Private driver interface data
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003856 * @settings: Settings for CSA period and new channel
Dmitry Shmidt04949592012-07-19 12:16:46 -07003857 * Returns: 0 on success, -1 on failure
3858 *
3859 * This function is used to move the GO to the legacy STA channel to
3860 * avoid frequency conflict in single channel concurrency.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003861 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003862 int (*switch_channel)(void *priv, struct csa_settings *settings);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003863
3864 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003865 * add_tx_ts - Add traffic stream
3866 * @priv: Private driver interface data
3867 * @tsid: Traffic stream ID
3868 * @addr: Receiver address
3869 * @user_prio: User priority of the traffic stream
3870 * @admitted_time: Admitted time for this TS in units of
3871 * 32 microsecond periods (per second).
3872 * Returns: 0 on success, -1 on failure
3873 */
3874 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3875 u16 admitted_time);
3876
3877 /**
3878 * del_tx_ts - Delete traffic stream
3879 * @priv: Private driver interface data
3880 * @tsid: Traffic stream ID
3881 * @addr: Receiver address
3882 * Returns: 0 on success, -1 on failure
3883 */
3884 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3885
3886 /**
3887 * Enable channel-switching with TDLS peer
3888 * @priv: Private driver interface data
3889 * @addr: MAC address of the TDLS peer
3890 * @oper_class: Operating class of the switch channel
3891 * @params: Channel specification
3892 * Returns: 0 on success, -1 on failure
3893 *
3894 * The function indicates to driver that it can start switching to a
3895 * different channel with a specified TDLS peer. The switching is
3896 * assumed on until canceled with tdls_disable_channel_switch().
3897 */
3898 int (*tdls_enable_channel_switch)(
3899 void *priv, const u8 *addr, u8 oper_class,
3900 const struct hostapd_freq_params *params);
3901
3902 /**
3903 * Disable channel switching with TDLS peer
3904 * @priv: Private driver interface data
3905 * @addr: MAC address of the TDLS peer
3906 * Returns: 0 on success, -1 on failure
3907 *
3908 * This function indicates to the driver that it should stop switching
3909 * with a given TDLS peer.
3910 */
3911 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3912
3913 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003914 * start_dfs_cac - Listen for radar interference on the channel
3915 * @priv: Private driver interface data
Dmitry Shmidt051af732013-10-22 13:52:46 -07003916 * @freq: Channel parameters
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003917 * Returns: 0 on success, -1 on failure
3918 */
Dmitry Shmidt051af732013-10-22 13:52:46 -07003919 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003920
3921 /**
3922 * stop_ap - Removes beacon from AP
3923 * @priv: Private driver interface data
3924 * Returns: 0 on success, -1 on failure (or if not supported)
3925 *
3926 * This optional function can be used to disable AP mode related
3927 * configuration. Unlike deinit_ap, it does not change to station
3928 * mode.
3929 */
3930 int (*stop_ap)(void *priv);
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003931
3932 /**
3933 * get_survey - Retrieve survey data
3934 * @priv: Private driver interface data
3935 * @freq: If set, survey data for the specified frequency is only
3936 * being requested. If not set, all survey data is requested.
3937 * Returns: 0 on success, -1 on failure
3938 *
3939 * Use this to retrieve:
3940 *
3941 * - the observed channel noise floor
3942 * - the amount of time we have spent on the channel
3943 * - the amount of time during which we have spent on the channel that
3944 * the radio has determined the medium is busy and we cannot
3945 * transmit
3946 * - the amount of time we have spent receiving data
3947 * - the amount of time we have spent transmitting data
3948 *
3949 * This data can be used for spectrum heuristics. One example is
3950 * Automatic Channel Selection (ACS). The channel survey data is
3951 * kept on a linked list on the channel data, one entry is added
3952 * for each survey. The min_nf of the channel is updated for each
3953 * survey.
3954 */
3955 int (*get_survey)(void *priv, unsigned int freq);
Dmitry Shmidt56052862013-10-04 10:23:25 -07003956
3957 /**
3958 * status - Get driver interface status information
3959 * @priv: Private driver interface data
Hai Shalom74f70d42019-02-11 14:42:39 -08003960 * @buf: Buffer for printing the status information
Dmitry Shmidt56052862013-10-04 10:23:25 -07003961 * @buflen: Maximum length of the buffer
3962 * Returns: Length of written status information or -1 on failure
3963 */
3964 int (*status)(void *priv, char *buf, size_t buflen);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003965
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07003966 /**
3967 * roaming - Set roaming policy for driver-based BSS selection
3968 * @priv: Private driver interface data
3969 * @allowed: Whether roaming within ESS is allowed
3970 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3971 * Returns: Length of written status information or -1 on failure
3972 *
3973 * This optional callback can be used to update roaming policy from the
3974 * associate() command (bssid being set there indicates that the driver
3975 * should not roam before getting this roaming() call to allow roaming.
3976 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3977 * capability, roaming policy is handled within wpa_supplicant and there
3978 * is no need to implement or react to this callback.
3979 */
3980 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3981
3982 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -07003983 * disable_fils - Enable/disable FILS feature
3984 * @priv: Private driver interface data
3985 * @disable: 0-enable and 1-disable FILS feature
3986 * Returns: 0 on success, -1 on failure
3987 *
3988 * This callback can be used to configure driver and below layers to
3989 * enable/disable all FILS features.
3990 */
3991 int (*disable_fils)(void *priv, int disable);
3992
3993 /**
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07003994 * set_mac_addr - Set MAC address
3995 * @priv: Private driver interface data
3996 * @addr: MAC address to use or %NULL for setting back to permanent
3997 * Returns: 0 on success, -1 on failure
3998 */
3999 int (*set_mac_addr)(void *priv, const u8 *addr);
4000
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004001#ifdef CONFIG_MACSEC
4002 int (*macsec_init)(void *priv, struct macsec_init_params *params);
4003
4004 int (*macsec_deinit)(void *priv);
4005
4006 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004007 * macsec_get_capability - Inform MKA of this driver's capability
4008 * @priv: Private driver interface data
4009 * @cap: Driver's capability
4010 * Returns: 0 on success, -1 on failure
4011 */
4012 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);
4013
4014 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004015 * enable_protect_frames - Set protect frames status
4016 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004017 * @enabled: true = protect frames enabled
4018 * false = protect frames disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004019 * Returns: 0 on success, -1 on failure (or if not supported)
4020 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004021 int (*enable_protect_frames)(void *priv, bool enabled);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004022
4023 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004024 * enable_encrypt - Set encryption status
4025 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004026 * @enabled: true = encrypt outgoing traffic
4027 * false = integrity-only protection on outgoing traffic
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004028 * Returns: 0 on success, -1 on failure (or if not supported)
4029 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004030 int (*enable_encrypt)(void *priv, bool enabled);
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004031
4032 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004033 * set_replay_protect - Set replay protect status and window size
4034 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004035 * @enabled: true = replay protect enabled
4036 * false = replay protect disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004037 * @window: replay window size, valid only when replay protect enabled
4038 * Returns: 0 on success, -1 on failure (or if not supported)
4039 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004040 int (*set_replay_protect)(void *priv, bool enabled, u32 window);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004041
4042 /**
4043 * set_current_cipher_suite - Set current cipher suite
4044 * @priv: Private driver interface data
4045 * @cs: EUI64 identifier
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004046 * Returns: 0 on success, -1 on failure (or if not supported)
4047 */
Dmitry Shmidt7d175302016-09-06 13:11:34 -07004048 int (*set_current_cipher_suite)(void *priv, u64 cs);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004049
4050 /**
4051 * enable_controlled_port - Set controlled port status
4052 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004053 * @enabled: true = controlled port enabled
4054 * false = controlled port disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004055 * Returns: 0 on success, -1 on failure (or if not supported)
4056 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004057 int (*enable_controlled_port)(void *priv, bool enabled);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004058
4059 /**
4060 * get_receive_lowest_pn - Get receive lowest pn
4061 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004062 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004063 * Returns: 0 on success, -1 on failure (or if not supported)
4064 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004065 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004066
4067 /**
4068 * get_transmit_next_pn - Get transmit next pn
4069 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004070 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004071 * Returns: 0 on success, -1 on failure (or if not supported)
4072 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004073 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004074
4075 /**
4076 * set_transmit_next_pn - Set transmit next pn
4077 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004078 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004079 * Returns: 0 on success, -1 on failure (or if not supported)
4080 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004081 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004082
4083 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08004084 * set_receive_lowest_pn - Set receive lowest PN
4085 * @priv: Private driver interface data
4086 * @sa: secure association
4087 * Returns: 0 on success, -1 on failure (or if not supported)
4088 */
4089 int (*set_receive_lowest_pn)(void *priv, struct receive_sa *sa);
4090
4091 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004092 * create_receive_sc - create secure channel for receiving
4093 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004094 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004095 * @conf_offset: confidentiality offset (0, 30, or 50)
4096 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
4097 * 2 = Strict)
4098 * Returns: 0 on success, -1 on failure (or if not supported)
4099 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004100 int (*create_receive_sc)(void *priv, struct receive_sc *sc,
4101 unsigned int conf_offset,
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004102 int validation);
4103
4104 /**
4105 * delete_receive_sc - delete secure connection for receiving
4106 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004107 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004108 * Returns: 0 on success, -1 on failure
4109 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004110 int (*delete_receive_sc)(void *priv, struct receive_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004111
4112 /**
4113 * create_receive_sa - create secure association for receive
4114 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004115 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004116 * Returns: 0 on success, -1 on failure
4117 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004118 int (*create_receive_sa)(void *priv, struct receive_sa *sa);
4119
4120 /**
4121 * delete_receive_sa - Delete secure association for receive
4122 * @priv: Private driver interface data from init()
4123 * @sa: Secure association
4124 * Returns: 0 on success, -1 on failure
4125 */
4126 int (*delete_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004127
4128 /**
4129 * enable_receive_sa - enable the SA for receive
4130 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004131 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004132 * Returns: 0 on success, -1 on failure
4133 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004134 int (*enable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004135
4136 /**
4137 * disable_receive_sa - disable SA for receive
4138 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004139 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004140 * Returns: 0 on success, -1 on failure
4141 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004142 int (*disable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004143
4144 /**
4145 * create_transmit_sc - create secure connection for transmit
4146 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004147 * @sc: secure channel
4148 * @conf_offset: confidentiality offset (0, 30, or 50)
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004149 * Returns: 0 on success, -1 on failure
4150 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004151 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
4152 unsigned int conf_offset);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004153
4154 /**
4155 * delete_transmit_sc - delete secure connection for transmit
4156 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004157 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004158 * Returns: 0 on success, -1 on failure
4159 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004160 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004161
4162 /**
4163 * create_transmit_sa - create secure association for transmit
4164 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004165 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004166 * Returns: 0 on success, -1 on failure
4167 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004168 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);
4169
4170 /**
4171 * delete_transmit_sa - Delete secure association for transmit
4172 * @priv: Private driver interface data from init()
4173 * @sa: Secure association
4174 * Returns: 0 on success, -1 on failure
4175 */
4176 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004177
4178 /**
4179 * enable_transmit_sa - enable SA for transmit
4180 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004181 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004182 * Returns: 0 on success, -1 on failure
4183 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004184 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004185
4186 /**
4187 * disable_transmit_sa - disable SA for transmit
4188 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004189 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004190 * Returns: 0 on success, -1 on failure
4191 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004192 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004193#endif /* CONFIG_MACSEC */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004194
4195 /**
4196 * init_mesh - Driver specific initialization for mesh
4197 * @priv: Private driver interface data
4198 * Returns: 0 on success, -1 on failure
4199 */
4200 int (*init_mesh)(void *priv);
4201
4202 /**
4203 * join_mesh - Join a mesh network
4204 * @priv: Private driver interface data
4205 * @params: Mesh configuration parameters
4206 * Returns: 0 on success, -1 on failure
4207 */
4208 int (*join_mesh)(void *priv,
4209 struct wpa_driver_mesh_join_params *params);
4210
4211 /**
4212 * leave_mesh - Leave a mesh network
4213 * @priv: Private driver interface data
4214 * Returns 0 on success, -1 on failure
4215 */
4216 int (*leave_mesh)(void *priv);
4217
4218 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07004219 * probe_mesh_link - Inject a frame over direct mesh link to a given
4220 * peer skipping the next_hop lookup from mpath table.
4221 * @priv: Private driver interface data
4222 * @addr: Peer MAC address
4223 * @eth: Ethernet frame to be sent
4224 * @len: Ethernet frame lengtn in bytes
4225 * Returns 0 on success, -1 on failure
4226 */
4227 int (*probe_mesh_link)(void *priv, const u8 *addr, const u8 *eth,
4228 size_t len);
4229
4230 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004231 * do_acs - Automatically select channel
4232 * @priv: Private driver interface data
4233 * @params: Parameters for ACS
4234 * Returns 0 on success, -1 on failure
4235 *
4236 * This command can be used to offload ACS to the driver if the driver
4237 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
4238 */
4239 int (*do_acs)(void *priv, struct drv_acs_params *params);
Ravi Joshie6ccb162015-07-16 17:45:41 -07004240
4241 /**
4242 * set_band - Notify driver of band selection
4243 * @priv: Private driver interface data
4244 * @band: The selected band(s)
4245 * Returns 0 on success, -1 on failure
4246 */
4247 int (*set_band)(void *priv, enum set_band band);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004248
4249 /**
4250 * get_pref_freq_list - Get preferred frequency list for an interface
4251 * @priv: Private driver interface data
4252 * @if_type: Interface type
4253 * @num: Number of channels
4254 * @freq_list: Preferred channel frequency list encoded in MHz values
4255 * Returns 0 on success, -1 on failure
4256 *
4257 * This command can be used to query the preferred frequency list from
4258 * the driver specific to a particular interface type.
4259 */
4260 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
4261 unsigned int *num, unsigned int *freq_list);
4262
4263 /**
4264 * set_prob_oper_freq - Indicate probable P2P operating channel
4265 * @priv: Private driver interface data
4266 * @freq: Channel frequency in MHz
4267 * Returns 0 on success, -1 on failure
4268 *
4269 * This command can be used to inform the driver of the operating
4270 * frequency that an ongoing P2P group formation is likely to come up
4271 * on. Local device is assuming P2P Client role.
4272 */
4273 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004274
4275 /**
4276 * abort_scan - Request the driver to abort an ongoing scan
4277 * @priv: Private driver interface data
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004278 * @scan_cookie: Cookie identifying the scan request. This is used only
4279 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4280 * was used to trigger scan. Otherwise, 0 is used.
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004281 * Returns 0 on success, -1 on failure
4282 */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004283 int (*abort_scan)(void *priv, u64 scan_cookie);
Dmitry Shmidt849734c2016-05-27 09:59:01 -07004284
4285 /**
4286 * configure_data_frame_filters - Request to configure frame filters
4287 * @priv: Private driver interface data
4288 * @filter_flags: The type of frames to filter (bitfield of
4289 * WPA_DATA_FRAME_FILTER_FLAG_*)
4290 * Returns: 0 on success or -1 on failure
4291 */
4292 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07004293
4294 /**
4295 * get_ext_capab - Get extended capabilities for the specified interface
4296 * @priv: Private driver interface data
4297 * @type: Interface type for which to get extended capabilities
4298 * @ext_capab: Extended capabilities fetched
4299 * @ext_capab_mask: Extended capabilities mask
4300 * @ext_capab_len: Length of the extended capabilities
4301 * Returns: 0 on success or -1 on failure
4302 */
4303 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
4304 const u8 **ext_capab, const u8 **ext_capab_mask,
4305 unsigned int *ext_capab_len);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004306
4307 /**
4308 * p2p_lo_start - Start offloading P2P listen to device
4309 * @priv: Private driver interface data
4310 * @freq: Listening frequency (MHz) for P2P listen
4311 * @period: Length of the listen operation in milliseconds
4312 * @interval: Interval for running the listen operation in milliseconds
4313 * @count: Number of times to run the listen operation
4314 * @device_types: Device primary and secondary types
4315 * @dev_types_len: Number of bytes for device_types
4316 * @ies: P2P IE and WSC IE for Probe Response frames
4317 * @ies_len: Length of ies in bytes
4318 * Returns: 0 on success or -1 on failure
4319 */
4320 int (*p2p_lo_start)(void *priv, unsigned int freq,
4321 unsigned int period, unsigned int interval,
4322 unsigned int count,
4323 const u8 *device_types, size_t dev_types_len,
4324 const u8 *ies, size_t ies_len);
4325
4326 /**
4327 * p2p_lo_stop - Stop P2P listen offload
4328 * @priv: Private driver interface data
4329 * Returns: 0 on success or -1 on failure
4330 */
4331 int (*p2p_lo_stop)(void *priv);
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07004332
4333 /**
4334 * set_default_scan_ies - Set default scan IEs
4335 * @priv: Private driver interface data
4336 * @ies: Scan default IEs buffer
4337 * @ies_len: Length of IEs in bytes
4338 * Returns: 0 on success or -1 on failure
4339 *
4340 * The driver can use these by default when there are no scan IEs coming
4341 * in the subsequent scan requests. Also in case of one or more of IEs
4342 * given in set_default_scan_ies() are missing in the subsequent scan
4343 * request, the driver should merge the missing scan IEs in the scan
4344 * request from the IEs set by set_default_scan_ies() in the Probe
4345 * Request frames sent.
4346 */
4347 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
4348
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004349 /**
4350 * set_tdls_mode - Set TDLS trigger mode to the host driver
4351 * @priv: Private driver interface data
4352 * @tdls_external_control: Represents if TDLS external trigger control
4353 * mode is enabled/disabled.
4354 *
4355 * This optional callback can be used to configure the TDLS external
4356 * trigger control mode to the host driver.
4357 */
4358 int (*set_tdls_mode)(void *priv, int tdls_external_control);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004359
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004360 /**
4361 * get_bss_transition_status - Get candidate BSS's transition status
4362 * @priv: Private driver interface data
4363 * @params: Candidate BSS list
4364 *
4365 * Get the accept or reject reason code for a list of BSS transition
4366 * candidates.
4367 */
4368 struct wpa_bss_candidate_info *
4369 (*get_bss_transition_status)(void *priv,
4370 struct wpa_bss_trans_info *params);
4371 /**
4372 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
4373 * @priv: Private driver interface data
4374 * @ignore_disallow: 0 to not ignore, 1 to ignore
4375 * Returns: 0 on success, -1 on failure
4376 */
4377 int (*ignore_assoc_disallow)(void *priv, int ignore_disallow);
4378
4379 /**
4380 * set_bssid_blacklist - Set blacklist of BSSIDs to the driver
4381 * @priv: Private driver interface data
4382 * @num_bssid: Number of blacklist BSSIDs
4383 * @bssids: List of blacklisted BSSIDs
4384 */
4385 int (*set_bssid_blacklist)(void *priv, unsigned int num_bssid,
4386 const u8 *bssid);
4387
4388 /**
4389 * update_connect_params - Update the connection parameters
4390 * @priv: Private driver interface data
4391 * @params: Association parameters
4392 * @mask: Bit mask indicating which parameters in @params have to be
4393 * updated
4394 * Returns: 0 on success, -1 on failure
4395 *
4396 * Update the connection parameters when in connected state so that the
4397 * driver uses the updated parameters for subsequent roaming. This is
4398 * used only with drivers that implement internal BSS selection and
4399 * roaming.
4400 */
4401 int (*update_connect_params)(
4402 void *priv, struct wpa_driver_associate_params *params,
4403 enum wpa_drv_update_connect_params_mask mask);
Roshan Pius3a1667e2018-07-03 15:17:14 -07004404
4405 /**
4406 * send_external_auth_status - Indicate the status of external
4407 * authentication processing to the host driver.
4408 * @priv: Private driver interface data
4409 * @params: Status of authentication processing.
4410 * Returns: 0 on success, -1 on failure
4411 */
4412 int (*send_external_auth_status)(void *priv,
4413 struct external_auth *params);
Hai Shalom74f70d42019-02-11 14:42:39 -08004414
4415 /**
4416 * set_4addr_mode - Set 4-address mode
4417 * @priv: Private driver interface data
4418 * @bridge_ifname: Bridge interface name
4419 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
4420 * Returns: 0 on success, < 0 on failure
4421 */
4422 int (*set_4addr_mode)(void *priv, const char *bridge_ifname, int val);
Hai Shalom81f62d82019-07-22 12:10:00 -07004423
4424 /**
4425 * update_dh_ie - Update DH IE
4426 * @priv: Private driver interface data
4427 * @peer_mac: Peer MAC address
4428 * @reason_code: Reacon code
4429 * @ie: DH IE
4430 * @ie_len: DH IE length in bytes
4431 * Returns: 0 on success, -1 on failure
4432 *
4433 * This callback is used to let the driver know the DH processing result
4434 * and DH IE for a pending association.
4435 */
4436 int (*update_dh_ie)(void *priv, const u8 *peer_mac, u16 reason_code,
4437 const u8 *ie, size_t ie_len);
Hai Shalomb755a2a2020-04-23 21:49:02 -07004438
4439 /**
4440 * dpp_listen - Notify driver about start/stop of DPP listen
4441 * @priv: Private driver interface data
4442 * @enable: Whether listen state is enabled (or disabled)
4443 * Returns: 0 on success, -1 on failure
4444 *
4445 * This optional callback can be used to update RX frame filtering to
4446 * explicitly allow reception of broadcast Public Action frames.
4447 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004448 int (*dpp_listen)(void *priv, bool enable);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004449};
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004450
4451/**
4452 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
4453 */
4454enum wpa_event_type {
4455 /**
4456 * EVENT_ASSOC - Association completed
4457 *
4458 * This event needs to be delivered when the driver completes IEEE
4459 * 802.11 association or reassociation successfully.
4460 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
4461 * after this event has been generated. In addition, optional
4462 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
4463 * more information about the association. If the driver interface gets
4464 * both of these events at the same time, it can also include the
4465 * assoc_info data in EVENT_ASSOC call.
4466 */
4467 EVENT_ASSOC,
4468
4469 /**
4470 * EVENT_DISASSOC - Association lost
4471 *
4472 * This event should be called when association is lost either due to
4473 * receiving deauthenticate or disassociate frame from the AP or when
4474 * sending either of these frames to the current AP. If the driver
4475 * supports separate deauthentication event, EVENT_DISASSOC should only
4476 * be used for disassociation and EVENT_DEAUTH for deauthentication.
4477 * In AP mode, union wpa_event_data::disassoc_info is required.
4478 */
4479 EVENT_DISASSOC,
4480
4481 /**
4482 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
4483 *
4484 * This event must be delivered when a Michael MIC error is detected by
4485 * the local driver. Additional data for event processing is
4486 * provided with union wpa_event_data::michael_mic_failure. This
4487 * information is used to request new encyption key and to initiate
4488 * TKIP countermeasures if needed.
4489 */
4490 EVENT_MICHAEL_MIC_FAILURE,
4491
4492 /**
4493 * EVENT_SCAN_RESULTS - Scan results available
4494 *
4495 * This event must be called whenever scan results are available to be
4496 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4497 * is expected to be used some time after struct wpa_driver_ops::scan()
4498 * is called. If the driver provides an unsolicited event when the scan
4499 * has been completed, this event can be used to trigger
4500 * EVENT_SCAN_RESULTS call. If such event is not available from the
4501 * driver, the driver wrapper code is expected to use a registered
4502 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
4503 * scan is expected to be completed. Optional information about
4504 * completed scan can be provided with union wpa_event_data::scan_info.
4505 */
4506 EVENT_SCAN_RESULTS,
4507
4508 /**
4509 * EVENT_ASSOCINFO - Report optional extra information for association
4510 *
4511 * This event can be used to report extra association information for
4512 * EVENT_ASSOC processing. This extra information includes IEs from
4513 * association frames and Beacon/Probe Response frames in union
4514 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4515 * EVENT_ASSOC. Alternatively, the driver interface can include
4516 * assoc_info data in the EVENT_ASSOC call if it has all the
4517 * information available at the same point.
4518 */
4519 EVENT_ASSOCINFO,
4520
4521 /**
4522 * EVENT_INTERFACE_STATUS - Report interface status changes
4523 *
4524 * This optional event can be used to report changes in interface
4525 * status (interface added/removed) using union
4526 * wpa_event_data::interface_status. This can be used to trigger
4527 * wpa_supplicant to stop and re-start processing for the interface,
4528 * e.g., when a cardbus card is ejected/inserted.
4529 */
4530 EVENT_INTERFACE_STATUS,
4531
4532 /**
4533 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4534 *
4535 * This event can be used to inform wpa_supplicant about candidates for
4536 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4537 * for scan request (ap_scan=2 mode), this event is required for
4538 * pre-authentication. If wpa_supplicant is performing scan request
4539 * (ap_scan=1), this event is optional since scan results can be used
4540 * to add pre-authentication candidates. union
4541 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4542 * candidate and priority of the candidate, e.g., based on the signal
4543 * strength, in order to try to pre-authenticate first with candidates
4544 * that are most likely targets for re-association.
4545 *
4546 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4547 * on the candidate list. In addition, it can be called for the current
4548 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4549 * will automatically skip pre-authentication in cases where a valid
4550 * PMKSA exists. When more than one candidate exists, this event should
4551 * be generated once for each candidate.
4552 *
4553 * Driver will be notified about successful pre-authentication with
4554 * struct wpa_driver_ops::add_pmkid() calls.
4555 */
4556 EVENT_PMKID_CANDIDATE,
4557
4558 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004559 * EVENT_TDLS - Request TDLS operation
4560 *
4561 * This event can be used to request a TDLS operation to be performed.
4562 */
4563 EVENT_TDLS,
4564
4565 /**
4566 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4567 *
4568 * The driver is expected to report the received FT IEs from
4569 * FT authentication sequence from the AP. The FT IEs are included in
4570 * the extra information in union wpa_event_data::ft_ies.
4571 */
4572 EVENT_FT_RESPONSE,
4573
4574 /**
4575 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4576 *
4577 * The driver can use this event to inform wpa_supplicant about a STA
4578 * in an IBSS with which protected frames could be exchanged. This
4579 * event starts RSN authentication with the other STA to authenticate
4580 * the STA and set up encryption keys with it.
4581 */
4582 EVENT_IBSS_RSN_START,
4583
4584 /**
4585 * EVENT_AUTH - Authentication result
4586 *
4587 * This event should be called when authentication attempt has been
4588 * completed. This is only used if the driver supports separate
4589 * authentication step (struct wpa_driver_ops::authenticate).
4590 * Information about authentication result is included in
4591 * union wpa_event_data::auth.
4592 */
4593 EVENT_AUTH,
4594
4595 /**
4596 * EVENT_DEAUTH - Authentication lost
4597 *
4598 * This event should be called when authentication is lost either due
4599 * to receiving deauthenticate frame from the AP or when sending that
4600 * frame to the current AP.
4601 * In AP mode, union wpa_event_data::deauth_info is required.
4602 */
4603 EVENT_DEAUTH,
4604
4605 /**
4606 * EVENT_ASSOC_REJECT - Association rejected
4607 *
4608 * This event should be called when (re)association attempt has been
4609 * rejected by the AP. Information about the association response is
4610 * included in union wpa_event_data::assoc_reject.
4611 */
4612 EVENT_ASSOC_REJECT,
4613
4614 /**
4615 * EVENT_AUTH_TIMED_OUT - Authentication timed out
4616 */
4617 EVENT_AUTH_TIMED_OUT,
4618
4619 /**
4620 * EVENT_ASSOC_TIMED_OUT - Association timed out
4621 */
4622 EVENT_ASSOC_TIMED_OUT,
4623
4624 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004625 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
4626 */
4627 EVENT_WPS_BUTTON_PUSHED,
4628
4629 /**
4630 * EVENT_TX_STATUS - Report TX status
4631 */
4632 EVENT_TX_STATUS,
4633
4634 /**
4635 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
4636 */
4637 EVENT_RX_FROM_UNKNOWN,
4638
4639 /**
4640 * EVENT_RX_MGMT - Report RX of a management frame
4641 */
4642 EVENT_RX_MGMT,
4643
4644 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004645 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
4646 *
4647 * This event is used to indicate when the driver has started the
4648 * requested remain-on-channel duration. Information about the
4649 * operation is included in union wpa_event_data::remain_on_channel.
4650 */
4651 EVENT_REMAIN_ON_CHANNEL,
4652
4653 /**
4654 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
4655 *
4656 * This event is used to indicate when the driver has completed
4657 * remain-on-channel duration, i.e., may noot be available on the
4658 * requested channel anymore. Information about the
4659 * operation is included in union wpa_event_data::remain_on_channel.
4660 */
4661 EVENT_CANCEL_REMAIN_ON_CHANNEL,
4662
4663 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004664 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
4665 *
4666 * This event is used to indicate when a Probe Request frame has been
4667 * received. Information about the received frame is included in
4668 * union wpa_event_data::rx_probe_req. The driver is required to report
4669 * these events only after successfully completed probe_req_report()
4670 * commands to request the events (i.e., report parameter is non-zero)
4671 * in station mode. In AP mode, Probe Request frames should always be
4672 * reported.
4673 */
4674 EVENT_RX_PROBE_REQ,
4675
4676 /**
4677 * EVENT_NEW_STA - New wired device noticed
4678 *
4679 * This event is used to indicate that a new device has been detected
4680 * in a network that does not use association-like functionality (i.e.,
4681 * mainly wired Ethernet). This can be used to start EAPOL
4682 * authenticator when receiving a frame from a device. The address of
4683 * the device is included in union wpa_event_data::new_sta.
4684 */
4685 EVENT_NEW_STA,
4686
4687 /**
4688 * EVENT_EAPOL_RX - Report received EAPOL frame
4689 *
4690 * When in AP mode with hostapd, this event is required to be used to
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004691 * deliver the receive EAPOL frames from the driver.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004692 */
4693 EVENT_EAPOL_RX,
4694
4695 /**
4696 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4697 *
4698 * This event is used to indicate changes in the signal strength
4699 * observed in frames received from the current AP if signal strength
4700 * monitoring has been enabled with signal_monitor().
4701 */
4702 EVENT_SIGNAL_CHANGE,
4703
4704 /**
4705 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4706 *
4707 * This event is used to indicate that the interface was enabled after
4708 * having been previously disabled, e.g., due to rfkill.
4709 */
4710 EVENT_INTERFACE_ENABLED,
4711
4712 /**
4713 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4714 *
4715 * This event is used to indicate that the interface was disabled,
4716 * e.g., due to rfkill.
4717 */
4718 EVENT_INTERFACE_DISABLED,
4719
4720 /**
4721 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4722 *
4723 * This event is used to indicate that the channel list has changed,
4724 * e.g., because of a regulatory domain change triggered by scan
4725 * results including an AP advertising a country code.
4726 */
4727 EVENT_CHANNEL_LIST_CHANGED,
4728
4729 /**
4730 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4731 *
4732 * This event is used to indicate that the driver cannot maintain this
4733 * interface in its operation mode anymore. The most likely use for
4734 * this is to indicate that AP mode operation is not available due to
4735 * operating channel would need to be changed to a DFS channel when
4736 * the driver does not support radar detection and another virtual
4737 * interfaces caused the operating channel to change. Other similar
4738 * resource conflicts could also trigger this for station mode
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07004739 * interfaces. This event can be propagated when channel switching
4740 * fails.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004741 */
4742 EVENT_INTERFACE_UNAVAILABLE,
4743
4744 /**
4745 * EVENT_BEST_CHANNEL
4746 *
4747 * Driver generates this event whenever it detects a better channel
4748 * (e.g., based on RSSI or channel use). This information can be used
4749 * to improve channel selection for a new AP/P2P group.
4750 */
4751 EVENT_BEST_CHANNEL,
4752
4753 /**
4754 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4755 *
4756 * This event should be called when a Deauthentication frame is dropped
4757 * due to it not being protected (MFP/IEEE 802.11w).
4758 * union wpa_event_data::unprot_deauth is required to provide more
4759 * details of the frame.
4760 */
4761 EVENT_UNPROT_DEAUTH,
4762
4763 /**
4764 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4765 *
4766 * This event should be called when a Disassociation frame is dropped
4767 * due to it not being protected (MFP/IEEE 802.11w).
4768 * union wpa_event_data::unprot_disassoc is required to provide more
4769 * details of the frame.
4770 */
4771 EVENT_UNPROT_DISASSOC,
4772
4773 /**
4774 * EVENT_STATION_LOW_ACK
4775 *
4776 * Driver generates this event whenever it detected that a particular
4777 * station was lost. Detection can be through massive transmission
4778 * failures for example.
4779 */
4780 EVENT_STATION_LOW_ACK,
4781
4782 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004783 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4784 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004785 EVENT_IBSS_PEER_LOST,
4786
4787 /**
4788 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4789 *
4790 * This event carries the new replay counter to notify wpa_supplicant
4791 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4792 * completed Group Key Handshake while the host (including
4793 * wpa_supplicant was sleeping).
4794 */
4795 EVENT_DRIVER_GTK_REKEY,
4796
4797 /**
4798 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4799 */
4800 EVENT_SCHED_SCAN_STOPPED,
4801
4802 /**
4803 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4804 *
4805 * This event indicates that the station responded to the poll
4806 * initiated with @poll_client.
4807 */
4808 EVENT_DRIVER_CLIENT_POLL_OK,
4809
4810 /**
4811 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4812 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07004813 EVENT_EAPOL_TX_STATUS,
4814
4815 /**
4816 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4817 *
4818 * Described in wpa_event_data.ch_switch
4819 * */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004820 EVENT_CH_SWITCH,
4821
4822 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07004823 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
4824 *
4825 * This is a pre-switch event indicating the shortly following switch
4826 * of operating channels.
4827 *
4828 * Described in wpa_event_data.ch_switch
4829 */
4830 EVENT_CH_SWITCH_STARTED,
4831 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004832 * EVENT_WNM - Request WNM operation
4833 *
4834 * This event can be used to request a WNM operation to be performed.
4835 */
Dmitry Shmidtf8623282013-02-20 14:34:59 -08004836 EVENT_WNM,
4837
4838 /**
4839 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4840 *
4841 * This event indicates that the driver reported a connection failure
4842 * with the specified client (for example, max client reached, etc.) in
4843 * AP mode.
4844 */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004845 EVENT_CONNECT_FAILED_REASON,
4846
4847 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004848 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004849 *
4850 * A radar has been detected on the supplied frequency, hostapd should
4851 * react accordingly (e.g., change channel).
4852 */
4853 EVENT_DFS_RADAR_DETECTED,
4854
4855 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004856 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004857 *
4858 * After a successful CAC, the channel can be marked clear and used.
4859 */
4860 EVENT_DFS_CAC_FINISHED,
4861
4862 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004863 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004864 *
4865 * The CAC was not successful, and the channel remains in the previous
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004866 * state. This may happen due to a radar being detected or other
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004867 * external influences.
4868 */
4869 EVENT_DFS_CAC_ABORTED,
4870
4871 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004872 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004873 *
4874 * The channel which was previously unavailable is now available again.
4875 */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004876 EVENT_DFS_NOP_FINISHED,
4877
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08004878 /**
4879 * EVENT_SURVEY - Received survey data
4880 *
4881 * This event gets triggered when a driver query is issued for survey
4882 * data and the requested data becomes available. The returned data is
4883 * stored in struct survey_results. The results provide at most one
4884 * survey entry for each frequency and at minimum will provide one
4885 * survey entry for one frequency. The survey data can be os_malloc()'d
4886 * and then os_free()'d, so the event callback must only copy data.
4887 */
4888 EVENT_SURVEY,
4889
4890 /**
4891 * EVENT_SCAN_STARTED - Scan started
4892 *
4893 * This indicates that driver has started a scan operation either based
4894 * on a request from wpa_supplicant/hostapd or from another application.
4895 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4896 * completed (either successfully or by getting cancelled).
4897 */
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08004898 EVENT_SCAN_STARTED,
4899
4900 /**
4901 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4902 *
4903 * This event indicates a set of frequency ranges that should be avoided
4904 * to reduce issues due to interference or internal co-existence
4905 * information in the driver.
4906 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004907 EVENT_AVOID_FREQUENCIES,
4908
4909 /**
4910 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4911 */
4912 EVENT_NEW_PEER_CANDIDATE,
4913
4914 /**
4915 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4916 *
4917 * Indicates a pair of primary and secondary channels chosen by ACS
4918 * in device.
4919 */
4920 EVENT_ACS_CHANNEL_SELECTED,
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004921
4922 /**
4923 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4924 * been started.
4925 *
4926 * This event indicates that channel availability check has been started
4927 * on a DFS frequency by a driver that supports DFS Offload.
4928 */
4929 EVENT_DFS_CAC_STARTED,
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004930
4931 /**
4932 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4933 */
4934 EVENT_P2P_LO_STOP,
Paul Stewart092955c2017-02-06 09:13:09 -08004935
4936 /**
4937 * EVENT_BEACON_LOSS - Beacon loss detected
4938 *
4939 * This event indicates that no Beacon frames has been received from
4940 * the current AP. This may indicate that the AP is not anymore in
4941 * range.
4942 */
4943 EVENT_BEACON_LOSS,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004944
4945 /**
4946 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
4947 * done previously (Pre-CAC) on the channel has expired. This would
4948 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
4949 * channel will be moved from available to usable. A new CAC has to be
4950 * performed before start operating on this channel.
4951 */
4952 EVENT_DFS_PRE_CAC_EXPIRED,
Roshan Pius3a1667e2018-07-03 15:17:14 -07004953
4954 /**
4955 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
4956 * that do not define separate commands for authentication and
4957 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
4958 * authentication to wpa_supplicant. This event carries all the
4959 * necessary information from the host driver for the authentication to
4960 * happen.
4961 */
4962 EVENT_EXTERNAL_AUTH,
4963
4964 /**
4965 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
4966 *
4967 * This event should be indicated when the driver completes the 4-way
4968 * handshake. This event should be preceded by an EVENT_ASSOC that
4969 * indicates the completion of IEEE 802.11 association.
4970 */
4971 EVENT_PORT_AUTHORIZED,
4972
4973 /**
4974 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
4975 * change event.
4976 */
4977 EVENT_STATION_OPMODE_CHANGED,
4978
4979 /**
4980 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
4981 *
4982 * This event is emitted when the MAC changes while the interface is
4983 * enabled. When an interface was disabled and becomes enabled, it
4984 * must be always assumed that the MAC possibly changed.
4985 */
4986 EVENT_INTERFACE_MAC_CHANGED,
4987
4988 /**
4989 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
4990 *
4991 * This event is emitted when an interface is added/removed for WDS STA.
4992 */
4993 EVENT_WDS_STA_INTERFACE_STATUS,
Hai Shalom81f62d82019-07-22 12:10:00 -07004994
4995 /**
4996 * EVENT_UPDATE_DH - Notification of updated DH information
4997 */
4998 EVENT_UPDATE_DH,
Hai Shalomfdcde762020-04-02 11:19:20 -07004999
5000 /**
5001 * EVENT_UNPROT_BEACON - Unprotected Beacon frame received
5002 *
5003 * This event should be called when a Beacon frame is dropped due to it
5004 * not being protected correctly. union wpa_event_data::unprot_beacon
5005 * is required to provide more details of the frame.
5006 */
5007 EVENT_UNPROT_BEACON,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005008};
5009
5010
5011/**
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005012 * struct freq_survey - Channel survey info
5013 *
5014 * @ifidx: Interface index in which this survey was observed
5015 * @freq: Center of frequency of the surveyed channel
5016 * @nf: Channel noise floor in dBm
5017 * @channel_time: Amount of time in ms the radio spent on the channel
5018 * @channel_time_busy: Amount of time in ms the radio detected some signal
5019 * that indicated to the radio the channel was not clear
5020 * @channel_time_rx: Amount of time the radio spent receiving data
5021 * @channel_time_tx: Amount of time the radio spent transmitting data
5022 * @filled: bitmask indicating which fields have been reported, see
5023 * SURVEY_HAS_* defines.
5024 * @list: Internal list pointers
5025 */
5026struct freq_survey {
5027 u32 ifidx;
5028 unsigned int freq;
5029 s8 nf;
5030 u64 channel_time;
5031 u64 channel_time_busy;
5032 u64 channel_time_rx;
5033 u64 channel_time_tx;
5034 unsigned int filled;
5035 struct dl_list list;
5036};
5037
5038#define SURVEY_HAS_NF BIT(0)
5039#define SURVEY_HAS_CHAN_TIME BIT(1)
5040#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
5041#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
5042#define SURVEY_HAS_CHAN_TIME_TX BIT(4)
5043
5044
5045/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005046 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
5047 */
5048union wpa_event_data {
5049 /**
5050 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
5051 *
5052 * This structure is optional for EVENT_ASSOC calls and required for
5053 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
5054 * driver interface does not need to generate separate EVENT_ASSOCINFO
5055 * calls.
5056 */
5057 struct assoc_info {
5058 /**
5059 * reassoc - Flag to indicate association or reassociation
5060 */
5061 int reassoc;
5062
5063 /**
5064 * req_ies - (Re)Association Request IEs
5065 *
5066 * If the driver generates WPA/RSN IE, this event data must be
5067 * returned for WPA handshake to have needed information. If
5068 * wpa_supplicant-generated WPA/RSN IE is used, this
5069 * information event is optional.
5070 *
5071 * This should start with the first IE (fixed fields before IEs
5072 * are not included).
5073 */
5074 const u8 *req_ies;
5075
5076 /**
5077 * req_ies_len - Length of req_ies in bytes
5078 */
5079 size_t req_ies_len;
5080
5081 /**
5082 * resp_ies - (Re)Association Response IEs
5083 *
5084 * Optional association data from the driver. This data is not
5085 * required WPA, but may be useful for some protocols and as
5086 * such, should be reported if this is available to the driver
5087 * interface.
5088 *
5089 * This should start with the first IE (fixed fields before IEs
5090 * are not included).
5091 */
5092 const u8 *resp_ies;
5093
5094 /**
5095 * resp_ies_len - Length of resp_ies in bytes
5096 */
5097 size_t resp_ies_len;
5098
5099 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08005100 * resp_frame - (Re)Association Response frame
5101 */
5102 const u8 *resp_frame;
5103
5104 /**
5105 * resp_frame_len - (Re)Association Response frame length
5106 */
5107 size_t resp_frame_len;
5108
5109 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005110 * beacon_ies - Beacon or Probe Response IEs
5111 *
5112 * Optional Beacon/ProbeResp data: IEs included in Beacon or
5113 * Probe Response frames from the current AP (i.e., the one
5114 * that the client just associated with). This information is
5115 * used to update WPA/RSN IE for the AP. If this field is not
5116 * set, the results from previous scan will be used. If no
5117 * data for the new AP is found, scan results will be requested
5118 * again (without scan request). At this point, the driver is
5119 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
5120 * used).
5121 *
5122 * This should start with the first IE (fixed fields before IEs
5123 * are not included).
5124 */
5125 const u8 *beacon_ies;
5126
5127 /**
5128 * beacon_ies_len - Length of beacon_ies */
5129 size_t beacon_ies_len;
5130
5131 /**
5132 * freq - Frequency of the operational channel in MHz
5133 */
5134 unsigned int freq;
5135
5136 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005137 * wmm_params - WMM parameters used in this association.
5138 */
5139 struct wmm_params wmm_params;
5140
5141 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005142 * addr - Station address (for AP mode)
5143 */
5144 const u8 *addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005145
5146 /**
5147 * The following is the key management offload information
5148 * @authorized
5149 * @key_replay_ctr
5150 * @key_replay_ctr_len
5151 * @ptk_kck
5152 * @ptk_kek_len
5153 * @ptk_kek
5154 * @ptk_kek_len
5155 */
5156
5157 /**
5158 * authorized - Status of key management offload,
5159 * 1 = successful
5160 */
5161 int authorized;
5162
5163 /**
5164 * key_replay_ctr - Key replay counter value last used
5165 * in a valid EAPOL-Key frame
5166 */
5167 const u8 *key_replay_ctr;
5168
5169 /**
5170 * key_replay_ctr_len - The length of key_replay_ctr
5171 */
5172 size_t key_replay_ctr_len;
5173
5174 /**
5175 * ptk_kck - The derived PTK KCK
5176 */
5177 const u8 *ptk_kck;
5178
5179 /**
5180 * ptk_kek_len - The length of ptk_kck
5181 */
5182 size_t ptk_kck_len;
5183
5184 /**
5185 * ptk_kek - The derived PTK KEK
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005186 * This is used in key management offload and also in FILS SK
5187 * offload.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005188 */
5189 const u8 *ptk_kek;
5190
5191 /**
5192 * ptk_kek_len - The length of ptk_kek
5193 */
5194 size_t ptk_kek_len;
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08005195
5196 /**
5197 * subnet_status - The subnet status:
5198 * 0 = unknown, 1 = unchanged, 2 = changed
5199 */
5200 u8 subnet_status;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005201
5202 /**
5203 * The following information is used in FILS SK offload
5204 * @fils_erp_next_seq_num
5205 * @fils_pmk
5206 * @fils_pmk_len
5207 * @fils_pmkid
5208 */
5209
5210 /**
5211 * fils_erp_next_seq_num - The next sequence number to use in
5212 * FILS ERP messages
5213 */
5214 u16 fils_erp_next_seq_num;
5215
5216 /**
5217 * fils_pmk - A new PMK if generated in case of FILS
5218 * authentication
5219 */
5220 const u8 *fils_pmk;
5221
5222 /**
5223 * fils_pmk_len - Length of fils_pmk
5224 */
5225 size_t fils_pmk_len;
5226
5227 /**
5228 * fils_pmkid - PMKID used or generated in FILS authentication
5229 */
5230 const u8 *fils_pmkid;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005231 } assoc_info;
5232
5233 /**
5234 * struct disassoc_info - Data for EVENT_DISASSOC events
5235 */
5236 struct disassoc_info {
5237 /**
5238 * addr - Station address (for AP mode)
5239 */
5240 const u8 *addr;
5241
5242 /**
5243 * reason_code - Reason Code (host byte order) used in
5244 * Deauthentication frame
5245 */
5246 u16 reason_code;
5247
5248 /**
5249 * ie - Optional IE(s) in Disassociation frame
5250 */
5251 const u8 *ie;
5252
5253 /**
5254 * ie_len - Length of ie buffer in octets
5255 */
5256 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005257
5258 /**
5259 * locally_generated - Whether the frame was locally generated
5260 */
5261 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005262 } disassoc_info;
5263
5264 /**
5265 * struct deauth_info - Data for EVENT_DEAUTH events
5266 */
5267 struct deauth_info {
5268 /**
5269 * addr - Station address (for AP mode)
5270 */
5271 const u8 *addr;
5272
5273 /**
5274 * reason_code - Reason Code (host byte order) used in
5275 * Deauthentication frame
5276 */
5277 u16 reason_code;
5278
5279 /**
5280 * ie - Optional IE(s) in Deauthentication frame
5281 */
5282 const u8 *ie;
5283
5284 /**
5285 * ie_len - Length of ie buffer in octets
5286 */
5287 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005288
5289 /**
5290 * locally_generated - Whether the frame was locally generated
5291 */
5292 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005293 } deauth_info;
5294
5295 /**
5296 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
5297 */
5298 struct michael_mic_failure {
5299 int unicast;
5300 const u8 *src;
5301 } michael_mic_failure;
5302
5303 /**
5304 * struct interface_status - Data for EVENT_INTERFACE_STATUS
5305 */
5306 struct interface_status {
Dmitry Shmidte4663042016-04-04 10:07:49 -07005307 unsigned int ifindex;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005308 char ifname[100];
5309 enum {
5310 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
5311 } ievent;
5312 } interface_status;
5313
5314 /**
5315 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
5316 */
5317 struct pmkid_candidate {
5318 /** BSSID of the PMKID candidate */
5319 u8 bssid[ETH_ALEN];
5320 /** Smaller the index, higher the priority */
5321 int index;
5322 /** Whether RSN IE includes pre-authenticate flag */
5323 int preauth;
5324 } pmkid_candidate;
5325
5326 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005327 * struct tdls - Data for EVENT_TDLS
5328 */
5329 struct tdls {
5330 u8 peer[ETH_ALEN];
5331 enum {
5332 TDLS_REQUEST_SETUP,
Dmitry Shmidt4dd28dc2015-03-10 11:21:43 -07005333 TDLS_REQUEST_TEARDOWN,
5334 TDLS_REQUEST_DISCOVER,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005335 } oper;
5336 u16 reason_code; /* for teardown */
5337 } tdls;
5338
5339 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07005340 * struct wnm - Data for EVENT_WNM
5341 */
5342 struct wnm {
5343 u8 addr[ETH_ALEN];
5344 enum {
5345 WNM_OPER_SLEEP,
5346 } oper;
5347 enum {
5348 WNM_SLEEP_ENTER,
5349 WNM_SLEEP_EXIT
5350 } sleep_action;
5351 int sleep_intval;
5352 u16 reason_code;
5353 u8 *buf;
5354 u16 buf_len;
5355 } wnm;
5356
5357 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005358 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
5359 *
5360 * During FT (IEEE 802.11r) authentication sequence, the driver is
5361 * expected to use this event to report received FT IEs (MDIE, FTIE,
5362 * RSN IE, TIE, possible resource request) to the supplicant. The FT
5363 * IEs for the next message will be delivered through the
5364 * struct wpa_driver_ops::update_ft_ies() callback.
5365 */
5366 struct ft_ies {
5367 const u8 *ies;
5368 size_t ies_len;
5369 int ft_action;
5370 u8 target_ap[ETH_ALEN];
5371 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
5372 const u8 *ric_ies;
5373 /** Length of ric_ies buffer in octets */
5374 size_t ric_ies_len;
5375 } ft_ies;
5376
5377 /**
5378 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
5379 */
5380 struct ibss_rsn_start {
5381 u8 peer[ETH_ALEN];
5382 } ibss_rsn_start;
5383
5384 /**
5385 * struct auth_info - Data for EVENT_AUTH events
5386 */
5387 struct auth_info {
5388 u8 peer[ETH_ALEN];
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005389 u8 bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005390 u16 auth_type;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005391 u16 auth_transaction;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005392 u16 status_code;
5393 const u8 *ies;
5394 size_t ies_len;
5395 } auth;
5396
5397 /**
5398 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
5399 */
5400 struct assoc_reject {
5401 /**
5402 * bssid - BSSID of the AP that rejected association
5403 */
5404 const u8 *bssid;
5405
5406 /**
5407 * resp_ies - (Re)Association Response IEs
5408 *
5409 * Optional association data from the driver. This data is not
5410 * required WPA, but may be useful for some protocols and as
5411 * such, should be reported if this is available to the driver
5412 * interface.
5413 *
5414 * This should start with the first IE (fixed fields before IEs
5415 * are not included).
5416 */
5417 const u8 *resp_ies;
5418
5419 /**
5420 * resp_ies_len - Length of resp_ies in bytes
5421 */
5422 size_t resp_ies_len;
5423
5424 /**
5425 * status_code - Status Code from (Re)association Response
5426 */
5427 u16 status_code;
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07005428
5429 /**
5430 * timed_out - Whether failure is due to timeout (etc.) rather
5431 * than explicit rejection response from the AP.
5432 */
5433 int timed_out;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08005434
5435 /**
5436 * timeout_reason - Reason for the timeout
5437 */
5438 const char *timeout_reason;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005439
5440 /**
5441 * fils_erp_next_seq_num - The next sequence number to use in
5442 * FILS ERP messages
5443 */
5444 u16 fils_erp_next_seq_num;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005445 } assoc_reject;
5446
5447 struct timeout_event {
5448 u8 addr[ETH_ALEN];
5449 } timeout_event;
5450
5451 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005452 * struct tx_status - Data for EVENT_TX_STATUS events
5453 */
5454 struct tx_status {
5455 u16 type;
5456 u16 stype;
5457 const u8 *dst;
5458 const u8 *data;
5459 size_t data_len;
5460 int ack;
5461 } tx_status;
5462
5463 /**
5464 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
5465 */
5466 struct rx_from_unknown {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005467 const u8 *bssid;
5468 const u8 *addr;
5469 int wds;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005470 } rx_from_unknown;
5471
5472 /**
5473 * struct rx_mgmt - Data for EVENT_RX_MGMT events
5474 */
5475 struct rx_mgmt {
5476 const u8 *frame;
5477 size_t frame_len;
5478 u32 datarate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005479
5480 /**
Dmitry Shmidt98660862014-03-11 17:26:21 -07005481 * drv_priv - Pointer to store driver private BSS information
5482 *
5483 * If not set to NULL, this is used for comparison with
5484 * hostapd_data->drv_priv to determine which BSS should process
5485 * the frame.
5486 */
5487 void *drv_priv;
5488
5489 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005490 * freq - Frequency (in MHz) on which the frame was received
5491 */
5492 int freq;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005493
5494 /**
5495 * ssi_signal - Signal strength in dBm (or 0 if not available)
5496 */
5497 int ssi_signal;
5498 } rx_mgmt;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005499
5500 /**
5501 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
5502 *
5503 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
5504 */
5505 struct remain_on_channel {
5506 /**
5507 * freq - Channel frequency in MHz
5508 */
5509 unsigned int freq;
5510
5511 /**
5512 * duration - Duration to remain on the channel in milliseconds
5513 */
5514 unsigned int duration;
5515 } remain_on_channel;
5516
5517 /**
5518 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
5519 * @aborted: Whether the scan was aborted
5520 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
5521 * @num_freqs: Number of entries in freqs array
5522 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
5523 * SSID)
5524 * @num_ssids: Number of entries in ssids array
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08005525 * @external_scan: Whether the scan info is for an external scan
5526 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
5527 * 0 if the source of the scan event is a vendor scan
Dmitry Shmidt29333592017-01-09 12:27:11 -08005528 * @scan_start_tsf: Time when the scan started in terms of TSF of the
5529 * BSS that the interface that requested the scan is connected to
5530 * (if available).
5531 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
5532 * is set.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005533 */
5534 struct scan_info {
5535 int aborted;
5536 const int *freqs;
5537 size_t num_freqs;
5538 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
5539 size_t num_ssids;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08005540 int external_scan;
5541 int nl_scan_event;
Dmitry Shmidt29333592017-01-09 12:27:11 -08005542 u64 scan_start_tsf;
5543 u8 scan_start_tsf_bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005544 } scan_info;
5545
5546 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005547 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
5548 */
5549 struct rx_probe_req {
5550 /**
5551 * sa - Source address of the received Probe Request frame
5552 */
5553 const u8 *sa;
5554
5555 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005556 * da - Destination address of the received Probe Request frame
5557 * or %NULL if not available
5558 */
5559 const u8 *da;
5560
5561 /**
5562 * bssid - BSSID of the received Probe Request frame or %NULL
5563 * if not available
5564 */
5565 const u8 *bssid;
5566
5567 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005568 * ie - IEs from the Probe Request body
5569 */
5570 const u8 *ie;
5571
5572 /**
5573 * ie_len - Length of ie buffer in octets
5574 */
5575 size_t ie_len;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005576
5577 /**
5578 * signal - signal strength in dBm (or 0 if not available)
5579 */
5580 int ssi_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005581 } rx_probe_req;
5582
5583 /**
5584 * struct new_sta - Data for EVENT_NEW_STA events
5585 */
5586 struct new_sta {
5587 const u8 *addr;
5588 } new_sta;
5589
5590 /**
5591 * struct eapol_rx - Data for EVENT_EAPOL_RX events
5592 */
5593 struct eapol_rx {
5594 const u8 *src;
5595 const u8 *data;
5596 size_t data_len;
5597 } eapol_rx;
5598
5599 /**
5600 * signal_change - Data for EVENT_SIGNAL_CHANGE events
5601 */
5602 struct wpa_signal_info signal_change;
5603
5604 /**
5605 * struct best_channel - Data for EVENT_BEST_CHANNEL events
5606 * @freq_24: Best 2.4 GHz band channel frequency in MHz
5607 * @freq_5: Best 5 GHz band channel frequency in MHz
5608 * @freq_overall: Best channel frequency in MHz
5609 *
5610 * 0 can be used to indicate no preference in either band.
5611 */
5612 struct best_channel {
5613 int freq_24;
5614 int freq_5;
5615 int freq_overall;
5616 } best_chan;
5617
5618 struct unprot_deauth {
5619 const u8 *sa;
5620 const u8 *da;
5621 u16 reason_code;
5622 } unprot_deauth;
5623
5624 struct unprot_disassoc {
5625 const u8 *sa;
5626 const u8 *da;
5627 u16 reason_code;
5628 } unprot_disassoc;
5629
5630 /**
5631 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
5632 * @addr: station address
Paul Stewart092955c2017-02-06 09:13:09 -08005633 * @num_packets: Number of packets lost (consecutive packets not
5634 * acknowledged)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005635 */
5636 struct low_ack {
5637 u8 addr[ETH_ALEN];
Paul Stewart092955c2017-02-06 09:13:09 -08005638 u32 num_packets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005639 } low_ack;
5640
5641 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005642 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
5643 */
5644 struct ibss_peer_lost {
5645 u8 peer[ETH_ALEN];
5646 } ibss_peer_lost;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005647
5648 /**
5649 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
5650 */
5651 struct driver_gtk_rekey {
5652 const u8 *bssid;
5653 const u8 *replay_ctr;
5654 } driver_gtk_rekey;
5655
5656 /**
5657 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
5658 * @addr: station address
5659 */
5660 struct client_poll {
5661 u8 addr[ETH_ALEN];
5662 } client_poll;
5663
5664 /**
5665 * struct eapol_tx_status
5666 * @dst: Original destination
5667 * @data: Data starting with IEEE 802.1X header (!)
5668 * @data_len: Length of data
5669 * @ack: Indicates ack or lost frame
5670 *
5671 * This corresponds to hapd_send_eapol if the frame sent
5672 * there isn't just reported as EVENT_TX_STATUS.
5673 */
5674 struct eapol_tx_status {
5675 const u8 *dst;
5676 const u8 *data;
5677 int data_len;
5678 int ack;
5679 } eapol_tx_status;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005680
5681 /**
5682 * struct ch_switch
5683 * @freq: Frequency of new channel in MHz
5684 * @ht_enabled: Whether this is an HT channel
5685 * @ch_offset: Secondary channel offset
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08005686 * @ch_width: Channel width
5687 * @cf1: Center frequency 1
5688 * @cf2: Center frequency 2
Dmitry Shmidt04949592012-07-19 12:16:46 -07005689 */
5690 struct ch_switch {
5691 int freq;
5692 int ht_enabled;
5693 int ch_offset;
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08005694 enum chan_width ch_width;
5695 int cf1;
5696 int cf2;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005697 } ch_switch;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08005698
5699 /**
5700 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
5701 * @addr: Remote client address
5702 * @code: Reason code for connection failure
5703 */
5704 struct connect_failed_reason {
5705 u8 addr[ETH_ALEN];
5706 enum {
5707 MAX_CLIENT_REACHED,
5708 BLOCKED_CLIENT
5709 } code;
5710 } connect_failed_reason;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005711
5712 /**
5713 * struct dfs_event - Data for radar detected events
5714 * @freq: Frequency of the channel in MHz
5715 */
5716 struct dfs_event {
5717 int freq;
Dmitry Shmidt051af732013-10-22 13:52:46 -07005718 int ht_enabled;
5719 int chan_offset;
5720 enum chan_width chan_width;
5721 int cf1;
5722 int cf2;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005723 } dfs_event;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005724
5725 /**
5726 * survey_results - Survey result data for EVENT_SURVEY
5727 * @freq_filter: Requested frequency survey filter, 0 if request
5728 * was for all survey data
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005729 * @survey_list: Linked list of survey data (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005730 */
5731 struct survey_results {
5732 unsigned int freq_filter;
5733 struct dl_list survey_list; /* struct freq_survey */
5734 } survey_results;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005735
5736 /**
5737 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
5738 * @initiator: Initiator of the regulatory change
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07005739 * @type: Regulatory change type
5740 * @alpha2: Country code (or "" if not available)
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005741 */
5742 struct channel_list_changed {
5743 enum reg_change_initiator initiator;
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07005744 enum reg_type type;
5745 char alpha2[3];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005746 } channel_list_changed;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08005747
5748 /**
5749 * freq_range - List of frequency ranges
5750 *
5751 * This is used as the data with EVENT_AVOID_FREQUENCIES.
5752 */
5753 struct wpa_freq_range_list freq_range;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005754
5755 /**
5756 * struct mesh_peer
5757 *
5758 * @peer: Peer address
5759 * @ies: Beacon IEs
5760 * @ie_len: Length of @ies
5761 *
5762 * Notification of new candidate mesh peer.
5763 */
5764 struct mesh_peer {
5765 const u8 *peer;
5766 const u8 *ies;
5767 size_t ie_len;
5768 } mesh_peer;
5769
5770 /**
5771 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08005772 * @pri_freq: Selected primary frequency
5773 * @sec_freq: Selected secondary frequency
Hai Shalomfdcde762020-04-02 11:19:20 -07005774 * @edmg_channel: Selected EDMG channel
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005775 * @vht_seg0_center_ch: VHT mode Segment0 center channel
Hai Shalomfdcde762020-04-02 11:19:20 -07005776 * The value is the index of the channel center frequency for
5777 * 20 MHz, 40 MHz, and 80 MHz channels. The value is the center
5778 * frequency index of the primary 80 MHz segment for 160 MHz and
5779 * 80+80 MHz channels.
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005780 * @vht_seg1_center_ch: VHT mode Segment1 center channel
Hai Shalomfdcde762020-04-02 11:19:20 -07005781 * The value is zero for 20 MHz, 40 MHz, and 80 MHz channels. The
5782 * value is the index of the channel center frequency for 160 MHz
5783 * channels and the center frequency index of the secondary 80 MHz
5784 * segment for 80+80 MHz channels.
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005785 * @ch_width: Selected Channel width by driver. Driver may choose to
5786 * change hostapd configured ACS channel width due driver internal
5787 * channel restrictions.
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07005788 * hw_mode: Selected band (used with hw_mode=any)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005789 */
5790 struct acs_selected_channels {
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08005791 unsigned int pri_freq;
5792 unsigned int sec_freq;
Hai Shalomfdcde762020-04-02 11:19:20 -07005793 u8 edmg_channel;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005794 u8 vht_seg0_center_ch;
5795 u8 vht_seg1_center_ch;
5796 u16 ch_width;
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07005797 enum hostapd_hw_mode hw_mode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005798 } acs_selected_channels;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005799
5800 /**
5801 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
5802 * @reason_code: Reason for stopping offload
5803 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
5804 * scheduled.
5805 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
5806 * be stopped.
5807 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
5808 * parameters.
5809 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
5810 * supported by device.
5811 */
5812 struct p2p_lo_stop {
5813 enum {
5814 P2P_LO_STOPPED_REASON_COMPLETE = 0,
5815 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
5816 P2P_LO_STOPPED_REASON_INVALID_PARAM,
5817 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
5818 } reason_code;
5819 } p2p_lo_stop;
Roshan Pius3a1667e2018-07-03 15:17:14 -07005820
5821 /* For EVENT_EXTERNAL_AUTH */
5822 struct external_auth external_auth;
5823
5824 /**
5825 * struct sta_opmode - Station's operation mode change event
5826 * @addr: The station MAC address
5827 * @smps_mode: SMPS mode of the station
5828 * @chan_width: Channel width of the station
5829 * @rx_nss: RX_NSS of the station
5830 *
5831 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
5832 */
5833 struct sta_opmode {
5834 const u8 *addr;
5835 enum smps_mode smps_mode;
5836 enum chan_width chan_width;
5837 u8 rx_nss;
5838 } sta_opmode;
5839
5840 /**
5841 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
5842 */
5843 struct wds_sta_interface {
5844 const u8 *sta_addr;
5845 const char *ifname;
5846 enum {
5847 INTERFACE_ADDED,
5848 INTERFACE_REMOVED
5849 } istatus;
5850 } wds_sta_interface;
Hai Shalom81f62d82019-07-22 12:10:00 -07005851
5852 /**
5853 * struct update_dh - Data for EVENT_UPDATE_DH
5854 */
5855 struct update_dh {
5856 const u8 *peer;
5857 const u8 *ie;
5858 size_t ie_len;
5859 } update_dh;
Hai Shalomfdcde762020-04-02 11:19:20 -07005860
5861 /**
5862 * struct unprot_beacon - Data for EVENT_UNPROT_BEACON
5863 */
5864 struct unprot_beacon {
5865 const u8 *sa;
5866 } unprot_beacon;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005867};
5868
5869/**
5870 * wpa_supplicant_event - Report a driver event for wpa_supplicant
5871 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5872 * with struct wpa_driver_ops::init()
5873 * @event: event type (defined above)
5874 * @data: possible extra data for the event
5875 *
5876 * Driver wrapper code should call this function whenever an event is received
5877 * from the driver.
5878 */
5879void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
5880 union wpa_event_data *data);
5881
Dmitry Shmidte4663042016-04-04 10:07:49 -07005882/**
5883 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
5884 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5885 * with struct wpa_driver_ops::init()
5886 * @event: event type (defined above)
5887 * @data: possible extra data for the event
5888 *
5889 * Same as wpa_supplicant_event(), but we search for the interface in
5890 * wpa_global.
5891 */
5892void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
5893 union wpa_event_data *data);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005894
5895/*
5896 * The following inline functions are provided for convenience to simplify
5897 * event indication for some of the common events.
5898 */
5899
5900static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
5901 size_t ielen, int reassoc)
5902{
5903 union wpa_event_data event;
5904 os_memset(&event, 0, sizeof(event));
5905 event.assoc_info.reassoc = reassoc;
5906 event.assoc_info.req_ies = ie;
5907 event.assoc_info.req_ies_len = ielen;
5908 event.assoc_info.addr = addr;
5909 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
5910}
5911
5912static inline void drv_event_disassoc(void *ctx, const u8 *addr)
5913{
5914 union wpa_event_data event;
5915 os_memset(&event, 0, sizeof(event));
5916 event.disassoc_info.addr = addr;
5917 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
5918}
5919
5920static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
5921 size_t data_len)
5922{
5923 union wpa_event_data event;
5924 os_memset(&event, 0, sizeof(event));
5925 event.eapol_rx.src = src;
5926 event.eapol_rx.data = data;
5927 event.eapol_rx.data_len = data_len;
5928 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
5929}
5930
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005931/* driver_common.c */
5932void wpa_scan_results_free(struct wpa_scan_results *res);
5933
5934/* Convert wpa_event_type to a string for logging */
5935const char * event_to_string(enum wpa_event_type event);
5936
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07005937/* Convert chan_width to a string for logging and control interfaces */
5938const char * channel_width_to_string(enum chan_width width);
5939
Hai Shalom74f70d42019-02-11 14:42:39 -08005940int channel_width_to_int(enum chan_width width);
5941
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005942int ht_supported(const struct hostapd_hw_modes *mode);
5943int vht_supported(const struct hostapd_hw_modes *mode);
5944
5945struct wowlan_triggers *
5946wpa_get_wowlan_triggers(const char *wowlan_triggers,
5947 const struct wpa_driver_capa *capa);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005948/* Convert driver flag to string */
5949const char * driver_flag_to_string(u64 flag);
Hai Shalomb755a2a2020-04-23 21:49:02 -07005950const char * driver_flag2_to_string(u64 flag2);
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005951
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005952/* NULL terminated array of linked in driver wrappers */
Dmitry Shmidt1d755d02015-04-28 10:34:29 -07005953extern const struct wpa_driver_ops *const wpa_drivers[];
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005954
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07005955
5956/* Available drivers */
5957
5958#ifdef CONFIG_DRIVER_WEXT
5959extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
5960#endif /* CONFIG_DRIVER_WEXT */
5961#ifdef CONFIG_DRIVER_NL80211
5962/* driver_nl80211.c */
5963extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
5964#endif /* CONFIG_DRIVER_NL80211 */
5965#ifdef CONFIG_DRIVER_HOSTAP
5966extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
5967#endif /* CONFIG_DRIVER_HOSTAP */
5968#ifdef CONFIG_DRIVER_BSD
5969extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
5970#endif /* CONFIG_DRIVER_BSD */
5971#ifdef CONFIG_DRIVER_OPENBSD
5972/* driver_openbsd.c */
5973extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
5974#endif /* CONFIG_DRIVER_OPENBSD */
5975#ifdef CONFIG_DRIVER_NDIS
5976extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
5977#endif /* CONFIG_DRIVER_NDIS */
5978#ifdef CONFIG_DRIVER_WIRED
5979extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
5980#endif /* CONFIG_DRIVER_WIRED */
5981#ifdef CONFIG_DRIVER_MACSEC_QCA
5982/* driver_macsec_qca.c */
5983extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
5984#endif /* CONFIG_DRIVER_MACSEC_QCA */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08005985#ifdef CONFIG_DRIVER_MACSEC_LINUX
5986/* driver_macsec_linux.c */
5987extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops;
5988#endif /* CONFIG_DRIVER_MACSEC_LINUX */
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07005989#ifdef CONFIG_DRIVER_ROBOSWITCH
5990/* driver_roboswitch.c */
5991extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
5992#endif /* CONFIG_DRIVER_ROBOSWITCH */
5993#ifdef CONFIG_DRIVER_ATHEROS
5994/* driver_atheros.c */
5995extern const struct wpa_driver_ops wpa_driver_atheros_ops;
5996#endif /* CONFIG_DRIVER_ATHEROS */
5997#ifdef CONFIG_DRIVER_NONE
5998extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
5999#endif /* CONFIG_DRIVER_NONE */
6000
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006001#endif /* DRIVER_H */