blob: e3b13bc251978f03fe6d757d1cfdf77cbc8115da [file] [log] [blame]
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001/*
2 * Driver interface definition
Paul Stewart092955c2017-02-06 09:13:09 -08003 * Copyright (c) 2003-2017, Jouni Malinen <j@w1.fi>
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004 *
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07007 *
8 * This file defines a driver interface used by both %wpa_supplicant and
9 * hostapd. The first part of the file defines data structures used in various
10 * driver operations. This is followed by the struct wpa_driver_ops that each
11 * driver wrapper will beed to define with callback functions for requesting
12 * driver operations. After this, there are definitions for driver event
13 * reporting with wpa_supplicant_event() and some convenience helper functions
14 * that can be used to report events.
15 */
16
17#ifndef DRIVER_H
18#define DRIVER_H
19
20#define WPA_SUPPLICANT_DRIVER_VERSION 4
21
22#include "common/defs.h"
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -070023#include "common/ieee802_11_defs.h"
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070024#include "common/wpa_common.h"
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -080025#ifdef CONFIG_MACSEC
26#include "pae/ieee802_1x_kay.h"
27#endif /* CONFIG_MACSEC */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -070028#include "utils/list.h"
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070029
30#define HOSTAPD_CHAN_DISABLED 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080031#define HOSTAPD_CHAN_NO_IR 0x00000002
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070032#define HOSTAPD_CHAN_RADAR 0x00000008
33#define HOSTAPD_CHAN_HT40PLUS 0x00000010
34#define HOSTAPD_CHAN_HT40MINUS 0x00000020
35#define HOSTAPD_CHAN_HT40 0x00000040
Dmitry Shmidt391c59f2013-09-03 12:16:28 -070036#define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070037
Dmitry Shmidtea69e842013-05-13 14:52:28 -070038#define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
39#define HOSTAPD_CHAN_DFS_USABLE 0x00000100
40#define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
41#define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
42#define HOSTAPD_CHAN_DFS_MASK 0x00000300
43
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -070044#define HOSTAPD_CHAN_VHT_10_70 0x00000800
45#define HOSTAPD_CHAN_VHT_30_50 0x00001000
46#define HOSTAPD_CHAN_VHT_50_30 0x00002000
47#define HOSTAPD_CHAN_VHT_70_10 0x00004000
48
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080049#define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
50#define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
51
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -080052#define HOSTAPD_CHAN_VHT_10_150 0x00100000
53#define HOSTAPD_CHAN_VHT_30_130 0x00200000
54#define HOSTAPD_CHAN_VHT_50_110 0x00400000
55#define HOSTAPD_CHAN_VHT_70_90 0x00800000
56#define HOSTAPD_CHAN_VHT_90_70 0x01000000
57#define HOSTAPD_CHAN_VHT_110_50 0x02000000
58#define HOSTAPD_CHAN_VHT_130_30 0x04000000
59#define HOSTAPD_CHAN_VHT_150_10 0x08000000
60
Hai Shalom74f70d42019-02-11 14:42:39 -080061/* Allowed bandwidth mask */
62enum hostapd_chan_width_attr {
63 HOSTAPD_CHAN_WIDTH_10 = BIT(0),
64 HOSTAPD_CHAN_WIDTH_20 = BIT(1),
65 HOSTAPD_CHAN_WIDTH_40P = BIT(2),
66 HOSTAPD_CHAN_WIDTH_40M = BIT(3),
67 HOSTAPD_CHAN_WIDTH_80 = BIT(4),
68 HOSTAPD_CHAN_WIDTH_160 = BIT(5),
69};
70
Dmitry Shmidt849734c2016-05-27 09:59:01 -070071/* Filter gratuitous ARP */
72#define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
73/* Filter unsolicited Neighbor Advertisement */
74#define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
75/* Filter unicast IP packets encrypted using the GTK */
76#define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)
77
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070078#define HOSTAPD_DFS_REGION_FCC 1
79#define HOSTAPD_DFS_REGION_ETSI 2
80#define HOSTAPD_DFS_REGION_JP 3
81
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080082/**
83 * enum reg_change_initiator - Regulatory change initiator
84 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -080085enum reg_change_initiator {
86 REGDOM_SET_BY_CORE,
87 REGDOM_SET_BY_USER,
88 REGDOM_SET_BY_DRIVER,
89 REGDOM_SET_BY_COUNTRY_IE,
Dmitry Shmidt97672262014-02-03 13:02:54 -080090 REGDOM_BEACON_HINT,
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -080091};
92
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080093/**
94 * enum reg_type - Regulatory change types
95 */
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -070096enum reg_type {
97 REGDOM_TYPE_UNKNOWN,
98 REGDOM_TYPE_COUNTRY,
99 REGDOM_TYPE_WORLD,
100 REGDOM_TYPE_CUSTOM_WORLD,
101 REGDOM_TYPE_INTERSECTION,
102};
103
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700104/**
Hai Shalom81f62d82019-07-22 12:10:00 -0700105 * struct hostapd_wmm_rule - WMM regulatory rule
106 * @min_cwmin: Lower bound of CW_min value
107 * @min_cwmax: Lower bound of CW_max value
108 * @min_aifs: Lower bound of AIFS value
109 * @max_txop: Upper bound of TXOP, value in units of 32 usec
110 */
111struct hostapd_wmm_rule {
112 int min_cwmin;
113 int min_cwmax;
114 int min_aifs;
115 int max_txop;
116};
117
118/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700119 * struct hostapd_channel_data - Channel information
120 */
121struct hostapd_channel_data {
122 /**
123 * chan - Channel number (IEEE 802.11)
124 */
125 short chan;
126
127 /**
128 * freq - Frequency in MHz
129 */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800130 int freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700131
132 /**
133 * flag - Channel flags (HOSTAPD_CHAN_*)
134 */
135 int flag;
136
137 /**
Hai Shalom74f70d42019-02-11 14:42:39 -0800138 * allowed_bw - Allowed channel width bitmask
139 *
140 * See enum hostapd_chan_width_attr.
141 */
142 u32 allowed_bw;
143
144 /**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -0700145 * max_tx_power - Regulatory transmit power limit in dBm
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700146 */
147 u8 max_tx_power;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -0700148
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800149 /**
150 * survey_list - Linked list of surveys (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -0700151 */
152 struct dl_list survey_list;
153
154 /**
155 * min_nf - Minimum observed noise floor, in dBm, based on all
156 * surveyed channel data
157 */
158 s8 min_nf;
Dmitry Shmidt391c59f2013-09-03 12:16:28 -0700159
160#ifdef CONFIG_ACS
161 /**
162 * interference_factor - Computed interference factor on this
163 * channel (used internally in src/ap/acs.c; driver wrappers do not
164 * need to set this)
165 */
166 long double interference_factor;
167#endif /* CONFIG_ACS */
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -0700168
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800169 /**
170 * dfs_cac_ms - DFS CAC time in milliseconds
171 */
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -0700172 unsigned int dfs_cac_ms;
Hai Shalom81f62d82019-07-22 12:10:00 -0700173
174 /**
175 * wmm_rules_valid - Indicates wmm_rules state
176 */
177 int wmm_rules_valid;
178
179 /**
180 * wmm_rules - WMM regulatory rules
181 */
182 struct hostapd_wmm_rule wmm_rules[WMM_AC_NUM];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700183};
184
Hai Shalomfdcde762020-04-02 11:19:20 -0700185#define HE_MAC_CAPAB_0 0
Hai Shalom81f62d82019-07-22 12:10:00 -0700186#define HE_MAX_MAC_CAPAB_SIZE 6
187#define HE_MAX_PHY_CAPAB_SIZE 11
188#define HE_MAX_MCS_CAPAB_SIZE 12
189#define HE_MAX_PPET_CAPAB_SIZE 25
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800190
191/**
192 * struct he_capabilities - IEEE 802.11ax HE capabilities
193 */
194struct he_capabilities {
195 u8 he_supported;
Hai Shalom81f62d82019-07-22 12:10:00 -0700196 u8 phy_cap[HE_MAX_PHY_CAPAB_SIZE];
197 u8 mac_cap[HE_MAX_MAC_CAPAB_SIZE];
198 u8 mcs[HE_MAX_MCS_CAPAB_SIZE];
199 u8 ppet[HE_MAX_PPET_CAPAB_SIZE];
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800200};
201
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800202#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -0700203#define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800204
Hai Shalom81f62d82019-07-22 12:10:00 -0700205
206enum ieee80211_op_mode {
207 IEEE80211_MODE_INFRA = 0,
208 IEEE80211_MODE_IBSS = 1,
209 IEEE80211_MODE_AP = 2,
210 IEEE80211_MODE_MESH = 5,
211
212 /* only add new entries before IEEE80211_MODE_NUM */
213 IEEE80211_MODE_NUM
214};
215
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700216/**
Hai Shalomc3565922019-10-28 11:58:20 -0700217 * struct ieee80211_edmg_config - EDMG configuration
218 *
219 * This structure describes most essential parameters needed
220 * for IEEE 802.11ay EDMG configuration
221 *
222 * @channels: Bitmap that indicates the 2.16 GHz channel(s)
223 * that are allowed to be used for transmissions.
224 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
225 * Set to 0 to indicate EDMG not supported.
226 * @bw_config: Channel BW Configuration subfield encodes
227 * the allowed channel bandwidth configurations
228 */
229struct ieee80211_edmg_config {
230 u8 channels;
231 enum edmg_bw_config bw_config;
232};
233
234/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700235 * struct hostapd_hw_modes - Supported hardware mode information
236 */
237struct hostapd_hw_modes {
238 /**
239 * mode - Hardware mode
240 */
241 enum hostapd_hw_mode mode;
242
243 /**
244 * num_channels - Number of entries in the channels array
245 */
246 int num_channels;
247
248 /**
249 * channels - Array of supported channels
250 */
251 struct hostapd_channel_data *channels;
252
253 /**
254 * num_rates - Number of entries in the rates array
255 */
256 int num_rates;
257
258 /**
259 * rates - Array of supported rates in 100 kbps units
260 */
261 int *rates;
262
263 /**
264 * ht_capab - HT (IEEE 802.11n) capabilities
265 */
266 u16 ht_capab;
267
268 /**
269 * mcs_set - MCS (IEEE 802.11n) rate parameters
270 */
271 u8 mcs_set[16];
272
273 /**
274 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
275 */
276 u8 a_mpdu_params;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800277
Dmitry Shmidt04949592012-07-19 12:16:46 -0700278 /**
279 * vht_capab - VHT (IEEE 802.11ac) capabilities
280 */
281 u32 vht_capab;
282
283 /**
284 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
285 */
286 u8 vht_mcs_set[8];
287
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800288 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800289
290 /**
291 * he_capab - HE (IEEE 802.11ax) capabilities
292 */
Hai Shalom81f62d82019-07-22 12:10:00 -0700293 struct he_capabilities he_capab[IEEE80211_MODE_NUM];
Hai Shalomc3565922019-10-28 11:58:20 -0700294
295 /**
296 * This structure describes the most essential parameters needed
297 * for IEEE 802.11ay EDMG configuration.
298 */
299 struct ieee80211_edmg_config edmg;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700300};
301
302
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700303#define IEEE80211_CAP_ESS 0x0001
304#define IEEE80211_CAP_IBSS 0x0002
305#define IEEE80211_CAP_PRIVACY 0x0010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800306#define IEEE80211_CAP_RRM 0x1000
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700307
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800308/* DMG (60 GHz) IEEE 802.11ad */
309/* type - bits 0..1 */
310#define IEEE80211_CAP_DMG_MASK 0x0003
311#define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
312#define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
313#define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
314
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700315#define WPA_SCAN_QUAL_INVALID BIT(0)
316#define WPA_SCAN_NOISE_INVALID BIT(1)
317#define WPA_SCAN_LEVEL_INVALID BIT(2)
318#define WPA_SCAN_LEVEL_DBM BIT(3)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700319#define WPA_SCAN_ASSOCIATED BIT(5)
320
321/**
322 * struct wpa_scan_res - Scan result for an BSS/IBSS
323 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
324 * @bssid: BSSID
325 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
326 * @beacon_int: beacon interval in TUs (host byte order)
327 * @caps: capability information field in host byte order
328 * @qual: signal quality
329 * @noise: noise level
330 * @level: signal level
331 * @tsf: Timestamp
332 * @age: Age of the information in milliseconds (i.e., how many milliseconds
333 * ago the last Beacon or Probe Response frame was received)
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800334 * @est_throughput: Estimated throughput in kbps (this is calculated during
335 * scan result processing if left zero by the driver wrapper)
336 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
Dmitry Shmidt29333592017-01-09 12:27:11 -0800337 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
338 * of TSF of the BSS specified by %tsf_bssid.
339 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700340 * @ie_len: length of the following IE field in octets
341 * @beacon_ie_len: length of the following Beacon IE field in octets
342 *
343 * This structure is used as a generic format for scan results from the
344 * driver. Each driver interface implementation is responsible for converting
345 * the driver or OS specific scan results into this format.
346 *
347 * If the driver does not support reporting all IEs, the IE data structure is
348 * constructed of the IEs that are available. This field will also need to
349 * include SSID in IE format. All drivers are encouraged to be extended to
350 * report all IEs to make it easier to support future additions.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800351 *
352 * This structure data is followed by ie_len octets of IEs from Probe Response
353 * frame (or if the driver does not indicate source of IEs, these may also be
354 * from Beacon frame). After the first set of IEs, another set of IEs may follow
355 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700356 */
357struct wpa_scan_res {
358 unsigned int flags;
359 u8 bssid[ETH_ALEN];
360 int freq;
361 u16 beacon_int;
362 u16 caps;
363 int qual;
364 int noise;
365 int level;
366 u64 tsf;
367 unsigned int age;
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800368 unsigned int est_throughput;
369 int snr;
Dmitry Shmidt29333592017-01-09 12:27:11 -0800370 u64 parent_tsf;
371 u8 tsf_bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700372 size_t ie_len;
373 size_t beacon_ie_len;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800374 /* Followed by ie_len + beacon_ie_len octets of IE data */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700375};
376
377/**
378 * struct wpa_scan_results - Scan results
379 * @res: Array of pointers to allocated variable length scan result entries
380 * @num: Number of entries in the scan result array
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800381 * @fetch_time: Time when the results were fetched from the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700382 */
383struct wpa_scan_results {
384 struct wpa_scan_res **res;
385 size_t num;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800386 struct os_reltime fetch_time;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700387};
388
389/**
390 * struct wpa_interface_info - Network interface information
391 * @next: Pointer to the next interface or NULL if this is the last one
392 * @ifname: Interface name that can be used with init() or init2()
393 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
394 * not available
395 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
396 * is not an allocated copy, i.e., get_interfaces() caller will not free
397 * this)
398 */
399struct wpa_interface_info {
400 struct wpa_interface_info *next;
401 char *ifname;
402 char *desc;
403 const char *drv_name;
404};
405
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800406#define WPAS_MAX_SCAN_SSIDS 16
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700407
408/**
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800409 * struct wpa_driver_scan_ssid - SSIDs to scan for
410 * @ssid - specific SSID to scan for (ProbeReq)
411 * %NULL or zero-length SSID is used to indicate active scan
412 * with wildcard SSID.
413 * @ssid_len - Length of the SSID in octets
414 */
415struct wpa_driver_scan_ssid {
416 const u8 *ssid;
417 size_t ssid_len;
418};
419
420/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700421 * struct wpa_driver_scan_params - Scan parameters
422 * Data for struct wpa_driver_ops::scan2().
423 */
424struct wpa_driver_scan_params {
425 /**
426 * ssids - SSIDs to scan for
427 */
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800428 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700429
430 /**
431 * num_ssids - Number of entries in ssids array
432 * Zero indicates a request for a passive scan.
433 */
434 size_t num_ssids;
435
436 /**
437 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
438 */
439 const u8 *extra_ies;
440
441 /**
442 * extra_ies_len - Length of extra_ies in octets
443 */
444 size_t extra_ies_len;
445
446 /**
447 * freqs - Array of frequencies to scan or %NULL for all frequencies
448 *
449 * The frequency is set in MHz. The array is zero-terminated.
450 */
451 int *freqs;
452
453 /**
454 * filter_ssids - Filter for reporting SSIDs
455 *
456 * This optional parameter can be used to request the driver wrapper to
457 * filter scan results to include only the specified SSIDs. %NULL
458 * indicates that no filtering is to be done. This can be used to
459 * reduce memory needs for scan results in environments that have large
460 * number of APs with different SSIDs.
461 *
462 * The driver wrapper is allowed to take this allocated buffer into its
463 * own use by setting the pointer to %NULL. In that case, the driver
464 * wrapper is responsible for freeing the buffer with os_free() once it
465 * is not needed anymore.
466 */
467 struct wpa_driver_scan_filter {
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -0700468 u8 ssid[SSID_MAX_LEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700469 size_t ssid_len;
470 } *filter_ssids;
471
472 /**
473 * num_filter_ssids - Number of entries in filter_ssids array
474 */
475 size_t num_filter_ssids;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800476
477 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700478 * filter_rssi - Filter by RSSI
479 *
480 * The driver may filter scan results in firmware to reduce host
481 * wakeups and thereby save power. Specify the RSSI threshold in s32
482 * dBm.
483 */
484 s32 filter_rssi;
485
486 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800487 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
488 *
489 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
490 * Mbps from the support rates element(s) in the Probe Request frames
491 * and not to transmit the frames at any of those rates.
492 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700493 unsigned int p2p_probe:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800494
495 /**
496 * only_new_results - Request driver to report only new results
497 *
498 * This is used to request the driver to report only BSSes that have
499 * been detected after this scan request has been started, i.e., to
500 * flush old cached BSS entries.
501 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700502 unsigned int only_new_results:1;
503
504 /**
505 * low_priority - Requests driver to use a lower scan priority
506 *
507 * This is used to request the driver to use a lower scan priority
508 * if it supports such a thing.
509 */
510 unsigned int low_priority:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800511
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800512 /**
513 * mac_addr_rand - Requests driver to randomize MAC address
514 */
515 unsigned int mac_addr_rand:1;
516
517 /**
518 * mac_addr - MAC address used with randomization. The address cannot be
519 * a multicast one, i.e., bit 0 of byte 0 should not be set.
520 */
Hai Shalomc3565922019-10-28 11:58:20 -0700521 u8 *mac_addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800522
523 /**
524 * mac_addr_mask - MAC address mask used with randomization.
525 *
526 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
527 * the mask should be taken as is from mac_addr. The mask should not
528 * allow the generation of a multicast address, i.e., bit 0 of byte 0
529 * must be set.
530 */
531 const u8 *mac_addr_mask;
532
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800533 /**
534 * sched_scan_plans - Scan plans for scheduled scan
535 *
536 * Each scan plan consists of the number of iterations to scan and the
537 * interval between scans. When a scan plan finishes (i.e., it was run
538 * for the specified number of iterations), the next scan plan is
539 * executed. The scan plans are executed in the order they appear in
540 * the array (lower index first). The last scan plan will run infinitely
541 * (until requested to stop), thus must not specify the number of
542 * iterations. All other scan plans must specify the number of
543 * iterations.
544 */
545 struct sched_scan_plan {
546 u32 interval; /* In seconds */
547 u32 iterations; /* Zero to run infinitely */
548 } *sched_scan_plans;
549
550 /**
551 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
552 */
553 unsigned int sched_scan_plans_num;
554
Dmitry Shmidt9c175262016-03-03 10:20:07 -0800555 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700556 * sched_scan_start_delay - Delay to use before starting the first scan
557 *
558 * Delay (in seconds) before scheduling first scan plan cycle. The
559 * driver may ignore this parameter and start immediately (or at any
560 * other time), if this feature is not supported.
561 */
562 u32 sched_scan_start_delay;
563
564 /**
Dmitry Shmidt9c175262016-03-03 10:20:07 -0800565 * bssid - Specific BSSID to scan for
566 *
567 * This optional parameter can be used to replace the default wildcard
568 * BSSID with a specific BSSID to scan for if results are needed from
569 * only a single BSS.
570 */
571 const u8 *bssid;
572
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800573 /**
574 * scan_cookie - Unique identification representing the scan request
575 *
576 * This scan_cookie carries a unique identification representing the
577 * scan request if the host driver/kernel supports concurrent scan
578 * requests. This cookie is returned from the corresponding driver
579 * interface.
580 *
581 * Note: Unlike other parameters in this structure, scan_cookie is used
582 * only to return information instead of setting parameters for the
583 * scan.
584 */
585 u64 scan_cookie;
586
Dmitry Shmidt29333592017-01-09 12:27:11 -0800587 /**
588 * duration - Dwell time on each channel
589 *
590 * This optional parameter can be used to set the dwell time on each
591 * channel. In TUs.
592 */
593 u16 duration;
594
595 /**
596 * duration_mandatory - Whether the specified duration is mandatory
597 *
598 * If this is set, the duration specified by the %duration field is
599 * mandatory (and the driver should reject the scan request if it is
600 * unable to comply with the specified duration), otherwise it is the
601 * maximum duration and the actual duration may be shorter.
602 */
603 unsigned int duration_mandatory:1;
604
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800605 /**
606 * relative_rssi_set - Whether relative RSSI parameters are set
607 */
608 unsigned int relative_rssi_set:1;
609
610 /**
611 * relative_rssi - Relative RSSI for reporting better BSSs
612 *
613 * Amount of RSSI by which a BSS should be better than the current
614 * connected BSS to report the new BSS to user space.
615 */
616 s8 relative_rssi;
617
618 /**
619 * relative_adjust_band - Band to which RSSI should be adjusted
620 *
621 * The relative_adjust_rssi should be added to the band specified
622 * by relative_adjust_band.
623 */
624 enum set_band relative_adjust_band;
625
626 /**
627 * relative_adjust_rssi - RSSI to be added to relative_adjust_band
628 *
629 * An amount of relative_band_rssi should be added to the BSSs that
630 * belong to the band specified by relative_adjust_band while comparing
631 * with other bands for BSS reporting.
632 */
633 s8 relative_adjust_rssi;
634
Hai Shalomce48b4a2018-09-05 11:41:35 -0700635 /**
636 * oce_scan
637 *
638 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0)
639 * - Accept broadcast Probe Response frame.
640 * - Probe Request frame deferral and suppression.
641 * - Max Channel Time - driver fills FILS request params IE with
642 * Maximum Channel Time.
643 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps.
644 */
645 unsigned int oce_scan:1;
646
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800647 /*
648 * NOTE: Whenever adding new parameters here, please make sure
649 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
650 * matching changes.
651 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700652};
653
654/**
655 * struct wpa_driver_auth_params - Authentication parameters
656 * Data for struct wpa_driver_ops::authenticate().
657 */
658struct wpa_driver_auth_params {
659 int freq;
660 const u8 *bssid;
661 const u8 *ssid;
662 size_t ssid_len;
663 int auth_alg;
664 const u8 *ie;
665 size_t ie_len;
666 const u8 *wep_key[4];
667 size_t wep_key_len[4];
668 int wep_tx_keyidx;
669 int local_state_change;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800670
671 /**
672 * p2p - Whether this connection is a P2P group
673 */
674 int p2p;
675
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800676 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800677 * auth_data - Additional elements for Authentication frame
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800678 *
679 * This buffer starts with the Authentication transaction sequence
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800680 * number field. If no special handling of such elements is needed, this
681 * pointer is %NULL. This is used with SAE and FILS.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800682 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800683 const u8 *auth_data;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800684
685 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800686 * auth_data_len - Length of auth_data buffer in octets
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800687 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800688 size_t auth_data_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700689};
690
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800691/**
692 * enum wps_mode - WPS mode
693 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700694enum wps_mode {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800695 /**
696 * WPS_MODE_NONE - No WPS provisioning being used
697 */
698 WPS_MODE_NONE,
699
700 /**
701 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
702 */
703 WPS_MODE_OPEN,
704
705 /**
706 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
707 */
708 WPS_MODE_PRIVACY
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700709};
710
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800711/**
712 * struct hostapd_freq_params - Channel parameters
713 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700714struct hostapd_freq_params {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800715 /**
716 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
717 */
718 enum hostapd_hw_mode mode;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700719
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800720 /**
721 * freq - Primary channel center frequency in MHz
722 */
723 int freq;
724
725 /**
726 * channel - Channel number
727 */
728 int channel;
729
730 /**
731 * ht_enabled - Whether HT is enabled
732 */
733 int ht_enabled;
734
735 /**
736 * sec_channel_offset - Secondary channel offset for HT40
737 *
738 * 0 = HT40 disabled,
739 * -1 = HT40 enabled, secondary channel below primary,
740 * 1 = HT40 enabled, secondary channel above primary
741 */
742 int sec_channel_offset;
743
744 /**
745 * vht_enabled - Whether VHT is enabled
746 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700747 int vht_enabled;
748
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800749 /**
Hai Shalom81f62d82019-07-22 12:10:00 -0700750 * he_enabled - Whether HE is enabled
751 */
752 int he_enabled;
753
754 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800755 * center_freq1 - Segment 0 center frequency in MHz
756 *
757 * Valid for both HT and VHT.
758 */
759 int center_freq1;
760
761 /**
762 * center_freq2 - Segment 1 center frequency in MHz
763 *
764 * Non-zero only for bandwidth 80 and an 80+80 channel
765 */
766 int center_freq2;
767
768 /**
769 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
770 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700771 int bandwidth;
Hai Shalomc3565922019-10-28 11:58:20 -0700772
773 /**
774 * This structure describes the most essential parameters needed
775 * for IEEE 802.11ay EDMG configuration.
776 */
777 struct ieee80211_edmg_config edmg;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700778};
779
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700780/**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700781 * struct wpa_driver_sta_auth_params - Authentication parameters
782 * Data for struct wpa_driver_ops::sta_auth().
783 */
784struct wpa_driver_sta_auth_params {
785
786 /**
787 * own_addr - Source address and BSSID for authentication frame
788 */
789 const u8 *own_addr;
790
791 /**
792 * addr - MAC address of the station to associate
793 */
794 const u8 *addr;
795
796 /**
797 * seq - authentication sequence number
798 */
799 u16 seq;
800
801 /**
802 * status - authentication response status code
803 */
804 u16 status;
805
806 /**
807 * ie - authentication frame ie buffer
808 */
809 const u8 *ie;
810
811 /**
812 * len - ie buffer length
813 */
814 size_t len;
815
816 /**
817 * fils_auth - Indicates whether FILS authentication is being performed
818 */
819 int fils_auth;
820
821 /**
822 * fils_anonce - ANonce (required for FILS)
823 */
824 u8 fils_anonce[WPA_NONCE_LEN];
825
826 /**
827 * fils_snonce - SNonce (required for FILS)
828 */
829 u8 fils_snonce[WPA_NONCE_LEN];
830
831 /**
832 * fils_kek - key for encryption (required for FILS)
833 */
834 u8 fils_kek[WPA_KEK_MAX_LEN];
835
836 /**
837 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
838 */
839 size_t fils_kek_len;
840};
841
842/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700843 * struct wpa_driver_associate_params - Association parameters
844 * Data for struct wpa_driver_ops::associate().
845 */
846struct wpa_driver_associate_params {
847 /**
848 * bssid - BSSID of the selected AP
849 * This can be %NULL, if ap_scan=2 mode is used and the driver is
850 * responsible for selecting with which BSS to associate. */
851 const u8 *bssid;
852
853 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800854 * bssid_hint - BSSID of a proposed AP
855 *
856 * This indicates which BSS has been found a suitable candidate for
857 * initial association for drivers that use driver/firmwate-based BSS
858 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
859 * the driver from selecting other BSSes in the ESS.
860 */
861 const u8 *bssid_hint;
862
863 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700864 * ssid - The selected SSID
865 */
866 const u8 *ssid;
867
868 /**
869 * ssid_len - Length of the SSID (1..32)
870 */
871 size_t ssid_len;
872
873 /**
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700874 * freq - channel parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700875 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700876 struct hostapd_freq_params freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700877
878 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800879 * freq_hint - Frequency of the channel the proposed AP is using
880 *
881 * This provides a channel on which a suitable BSS has been found as a
882 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
883 * limit the driver from selecting other channels for
884 * driver/firmware-based BSS selection.
885 */
886 int freq_hint;
887
888 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700889 * bg_scan_period - Background scan period in seconds, 0 to disable
890 * background scan, or -1 to indicate no change to default driver
891 * configuration
892 */
893 int bg_scan_period;
894
895 /**
Dmitry Shmidt2ac5f602014-03-07 10:08:21 -0800896 * beacon_int - Beacon interval for IBSS or 0 to use driver default
897 */
898 int beacon_int;
899
900 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700901 * wpa_ie - WPA information element for (Re)Association Request
902 * WPA information element to be included in (Re)Association
903 * Request (including information element id and length). Use
904 * of this WPA IE is optional. If the driver generates the WPA
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700905 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700906 * key_mgmt_suite to select proper algorithms. In this case,
907 * the driver has to notify wpa_supplicant about the used WPA
908 * IE by generating an event that the interface code will
909 * convert into EVENT_ASSOCINFO data (see below).
910 *
911 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
912 * instead. The driver can determine which version is used by
913 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
914 * WPA2/RSN).
915 *
916 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
917 */
918 const u8 *wpa_ie;
919
920 /**
921 * wpa_ie_len - length of the wpa_ie
922 */
923 size_t wpa_ie_len;
924
925 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800926 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
927 */
928 unsigned int wpa_proto;
929
930 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800931 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700932 *
933 * This is usually ignored if @wpa_ie is used.
934 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800935 unsigned int pairwise_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700936
937 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800938 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700939 *
940 * This is usually ignored if @wpa_ie is used.
941 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800942 unsigned int group_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700943
944 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700945 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
946 *
947 * This is usually ignored if @wpa_ie is used.
948 */
949 unsigned int mgmt_group_suite;
950
951 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800952 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700953 *
954 * This is usually ignored if @wpa_ie is used.
955 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800956 unsigned int key_mgmt_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700957
958 /**
959 * auth_alg - Allowed authentication algorithms
960 * Bit field of WPA_AUTH_ALG_*
961 */
962 int auth_alg;
963
964 /**
965 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
966 */
967 int mode;
968
969 /**
970 * wep_key - WEP keys for static WEP configuration
971 */
972 const u8 *wep_key[4];
973
974 /**
975 * wep_key_len - WEP key length for static WEP configuration
976 */
977 size_t wep_key_len[4];
978
979 /**
980 * wep_tx_keyidx - WEP TX key index for static WEP configuration
981 */
982 int wep_tx_keyidx;
983
984 /**
985 * mgmt_frame_protection - IEEE 802.11w management frame protection
986 */
987 enum mfp_options mgmt_frame_protection;
988
989 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700990 * passphrase - RSN passphrase for PSK
991 *
992 * This value is made available only for WPA/WPA2-Personal (PSK) and
Hai Shalom74f70d42019-02-11 14:42:39 -0800993 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
994 * is the 8..63 character ASCII passphrase, if available. Please note
995 * that this can be %NULL if passphrase was not used to generate the
996 * PSK. In that case, the psk field must be used to fetch the PSK.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700997 */
998 const char *passphrase;
999
1000 /**
1001 * psk - RSN PSK (alternative for passphrase for PSK)
1002 *
1003 * This value is made available only for WPA/WPA2-Personal (PSK) and
Hai Shalom74f70d42019-02-11 14:42:39 -08001004 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
1005 * is the 32-octet (256-bit) PSK, if available. The driver wrapper
1006 * should be prepared to handle %NULL value as an error.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001007 */
1008 const u8 *psk;
1009
1010 /**
1011 * drop_unencrypted - Enable/disable unencrypted frame filtering
1012 *
1013 * Configure the driver to drop all non-EAPOL frames (both receive and
1014 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
1015 * still be allowed for key negotiation.
1016 */
1017 int drop_unencrypted;
1018
1019 /**
1020 * prev_bssid - Previously used BSSID in this ESS
1021 *
1022 * When not %NULL, this is a request to use reassociation instead of
1023 * association.
1024 */
1025 const u8 *prev_bssid;
1026
1027 /**
1028 * wps - WPS mode
1029 *
1030 * If the driver needs to do special configuration for WPS association,
1031 * this variable provides more information on what type of association
1032 * is being requested. Most drivers should not need ot use this.
1033 */
1034 enum wps_mode wps;
1035
1036 /**
1037 * p2p - Whether this connection is a P2P group
1038 */
1039 int p2p;
1040
1041 /**
1042 * uapsd - UAPSD parameters for the network
1043 * -1 = do not change defaults
1044 * AP mode: 1 = enabled, 0 = disabled
1045 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
1046 */
1047 int uapsd;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001048
1049 /**
1050 * fixed_bssid - Whether to force this BSSID in IBSS mode
1051 * 1 = Fix this BSSID and prevent merges.
1052 * 0 = Do not fix BSSID.
1053 */
1054 int fixed_bssid;
1055
1056 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001057 * fixed_freq - Fix control channel in IBSS mode
1058 * 0 = don't fix control channel (default)
1059 * 1 = fix control channel; this prevents IBSS merging with another
1060 * channel
1061 */
1062 int fixed_freq;
1063
1064 /**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001065 * disable_ht - Disable HT (IEEE 802.11n) for this connection
1066 */
1067 int disable_ht;
1068
1069 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001070 * htcaps - HT Capabilities over-rides
1071 *
1072 * Only bits set in the mask will be used, and not all values are used
1073 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
1074 *
1075 * Pointer to struct ieee80211_ht_capabilities.
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001076 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001077 const u8 *htcaps;
1078
1079 /**
1080 * htcaps_mask - HT Capabilities over-rides mask
1081 *
1082 * Pointer to struct ieee80211_ht_capabilities.
1083 */
1084 const u8 *htcaps_mask;
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001085
1086#ifdef CONFIG_VHT_OVERRIDES
1087 /**
1088 * disable_vht - Disable VHT for this connection
1089 */
1090 int disable_vht;
1091
1092 /**
1093 * VHT capability overrides.
1094 */
1095 const struct ieee80211_vht_capabilities *vhtcaps;
1096 const struct ieee80211_vht_capabilities *vhtcaps_mask;
1097#endif /* CONFIG_VHT_OVERRIDES */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001098
Hai Shalomfdcde762020-04-02 11:19:20 -07001099#ifdef CONFIG_HE_OVERRIDES
1100 /**
1101 * disable_he - Disable HE for this connection
1102 */
1103 int disable_he;
1104#endif /* CONFIG_HE_OVERRIDES */
1105
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001106 /**
1107 * req_key_mgmt_offload - Request key management offload for connection
1108 *
1109 * Request key management offload for this connection if the device
1110 * supports it.
1111 */
1112 int req_key_mgmt_offload;
1113
1114 /**
Hai Shalomc3565922019-10-28 11:58:20 -07001115 * req_handshake_offload - Request EAPOL handshake offload
1116 *
1117 * Request EAPOL handshake offload for this connection if the device
1118 * supports it.
1119 */
1120 int req_handshake_offload;
1121
1122 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001123 * Flag for indicating whether this association includes support for
1124 * RRM (Radio Resource Measurements)
1125 */
1126 int rrm_used;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001127
1128 /**
1129 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1130 * AP as usual. Valid for DMG network only.
1131 */
1132 int pbss;
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001133
1134 /**
1135 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1136 */
1137 const u8 *fils_kek;
1138
1139 /**
1140 * fils_kek_len: Length of fils_kek in bytes
1141 */
1142 size_t fils_kek_len;
1143
1144 /**
1145 * fils_nonces - Nonces for FILS association frame protection
1146 * (AES-SIV AAD)
1147 */
1148 const u8 *fils_nonces;
1149
1150 /**
1151 * fils_nonces_len: Length of fils_nonce in bytes
1152 */
1153 size_t fils_nonces_len;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001154
1155 /**
1156 * fils_erp_username - Username part of keyName-NAI
1157 */
1158 const u8 *fils_erp_username;
1159
1160 /**
1161 * fils_erp_username_len - Length of fils_erp_username in bytes
1162 */
1163 size_t fils_erp_username_len;
1164
1165 /**
1166 * fils_erp_realm - Realm/domain name to use in FILS ERP
1167 */
1168 const u8 *fils_erp_realm;
1169
1170 /**
1171 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1172 */
1173 size_t fils_erp_realm_len;
1174
1175 /**
1176 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1177 * messages
1178 */
1179 u16 fils_erp_next_seq_num;
1180
1181 /**
1182 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1183 * specified by fils_erp_username@fils_erp_realm.
1184 */
1185 const u8 *fils_erp_rrk;
1186
1187 /**
1188 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1189 */
1190 size_t fils_erp_rrk_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001191};
1192
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001193enum hide_ssid {
1194 NO_SSID_HIDING,
1195 HIDDEN_SSID_ZERO_LEN,
1196 HIDDEN_SSID_ZERO_CONTENTS
1197};
1198
Hai Shalom81f62d82019-07-22 12:10:00 -07001199enum ch_switch_state {
1200 CH_SW_STARTED,
1201 CH_SW_FINISHED
1202};
1203
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001204struct wowlan_triggers {
1205 u8 any;
1206 u8 disconnect;
1207 u8 magic_pkt;
1208 u8 gtk_rekey_failure;
1209 u8 eap_identity_req;
1210 u8 four_way_handshake;
1211 u8 rfkill_release;
1212};
1213
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001214struct wpa_driver_ap_params {
1215 /**
1216 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1217 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001218 u8 *head;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001219
1220 /**
1221 * head_len - Length of the head buffer in octets
1222 */
1223 size_t head_len;
1224
1225 /**
1226 * tail - Beacon tail following TIM IE
1227 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001228 u8 *tail;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001229
1230 /**
1231 * tail_len - Length of the tail buffer in octets
1232 */
1233 size_t tail_len;
1234
1235 /**
1236 * dtim_period - DTIM period
1237 */
1238 int dtim_period;
1239
1240 /**
1241 * beacon_int - Beacon interval
1242 */
1243 int beacon_int;
1244
1245 /**
1246 * basic_rates: -1 terminated array of basic rates in 100 kbps
1247 *
1248 * This parameter can be used to set a specific basic rate set for the
1249 * BSS. If %NULL, default basic rate set is used.
1250 */
1251 int *basic_rates;
1252
1253 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001254 * beacon_rate: Beacon frame data rate
1255 *
1256 * This parameter can be used to set a specific Beacon frame data rate
1257 * for the BSS. The interpretation of this value depends on the
1258 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS). If
1259 * beacon_rate == 0 and rate_type == 0 (BEACON_RATE_LEGACY), the default
1260 * Beacon frame data rate is used.
1261 */
1262 unsigned int beacon_rate;
1263
1264 /**
1265 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT)
1266 */
1267 enum beacon_rate_type rate_type;
1268
1269 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001270 * proberesp - Probe Response template
1271 *
1272 * This is used by drivers that reply to Probe Requests internally in
1273 * AP mode and require the full Probe Response template.
1274 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001275 u8 *proberesp;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001276
1277 /**
1278 * proberesp_len - Length of the proberesp buffer in octets
1279 */
1280 size_t proberesp_len;
1281
1282 /**
1283 * ssid - The SSID to use in Beacon/Probe Response frames
1284 */
1285 const u8 *ssid;
1286
1287 /**
1288 * ssid_len - Length of the SSID (1..32)
1289 */
1290 size_t ssid_len;
1291
1292 /**
1293 * hide_ssid - Whether to hide the SSID
1294 */
1295 enum hide_ssid hide_ssid;
1296
1297 /**
1298 * pairwise_ciphers - WPA_CIPHER_* bitfield
1299 */
1300 unsigned int pairwise_ciphers;
1301
1302 /**
1303 * group_cipher - WPA_CIPHER_*
1304 */
1305 unsigned int group_cipher;
1306
1307 /**
1308 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1309 */
1310 unsigned int key_mgmt_suites;
1311
1312 /**
1313 * auth_algs - WPA_AUTH_ALG_* bitfield
1314 */
1315 unsigned int auth_algs;
1316
1317 /**
1318 * wpa_version - WPA_PROTO_* bitfield
1319 */
1320 unsigned int wpa_version;
1321
1322 /**
1323 * privacy - Whether privacy is used in the BSS
1324 */
1325 int privacy;
1326
1327 /**
1328 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1329 *
1330 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1331 * not use the full Beacon template.
1332 */
1333 const struct wpabuf *beacon_ies;
1334
1335 /**
1336 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1337 *
1338 * This is used to add IEs like WPS IE and P2P IE by drivers that
1339 * reply to Probe Request frames internally.
1340 */
1341 const struct wpabuf *proberesp_ies;
1342
1343 /**
1344 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1345 *
1346 * This is used to add IEs like WPS IE by drivers that reply to
1347 * (Re)Association Request frames internally.
1348 */
1349 const struct wpabuf *assocresp_ies;
1350
1351 /**
1352 * isolate - Whether to isolate frames between associated stations
1353 *
1354 * If this is non-zero, the AP is requested to disable forwarding of
1355 * frames between associated stations.
1356 */
1357 int isolate;
1358
1359 /**
1360 * cts_protect - Whether CTS protection is enabled
1361 */
1362 int cts_protect;
1363
1364 /**
1365 * preamble - Whether short preamble is enabled
1366 */
1367 int preamble;
1368
1369 /**
1370 * short_slot_time - Whether short slot time is enabled
1371 *
1372 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1373 * not set (e.g., when 802.11g mode is not in use)
1374 */
1375 int short_slot_time;
1376
1377 /**
1378 * ht_opmode - HT operation mode or -1 if HT not in use
1379 */
1380 int ht_opmode;
1381
1382 /**
1383 * interworking - Whether Interworking is enabled
1384 */
1385 int interworking;
1386
1387 /**
1388 * hessid - Homogeneous ESS identifier or %NULL if not set
1389 */
1390 const u8 *hessid;
1391
1392 /**
1393 * access_network_type - Access Network Type (0..15)
1394 *
1395 * This is used for filtering Probe Request frames when Interworking is
1396 * enabled.
1397 */
1398 u8 access_network_type;
Dmitry Shmidt04949592012-07-19 12:16:46 -07001399
1400 /**
1401 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1402 *
1403 * This is used by driver which advertises this capability.
1404 */
1405 int ap_max_inactivity;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001406
1407 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001408 * ctwindow - Client Traffic Window (in TUs)
1409 */
1410 u8 p2p_go_ctwindow;
1411
1412 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001413 * disable_dgaf - Whether group-addressed frames are disabled
1414 */
1415 int disable_dgaf;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001416
1417 /**
1418 * osen - Whether OSEN security is enabled
1419 */
1420 int osen;
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001421
1422 /**
1423 * freq - Channel parameters for dynamic bandwidth changes
1424 */
1425 struct hostapd_freq_params *freq;
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001426
1427 /**
1428 * reenable - Whether this is to re-enable beaconing
1429 */
1430 int reenable;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001431
1432 /**
1433 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1434 * infrastructure BSS. Valid only for DMG network.
1435 */
1436 int pbss;
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001437
1438 /**
1439 * multicast_to_unicast - Whether to use multicast_to_unicast
1440 *
1441 * If this is non-zero, the AP is requested to perform multicast to
1442 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1443 * 802.1Q). If enabled, such frames are to be sent to each station
1444 * separately, with the DA replaced by their own MAC address rather
1445 * than the group address.
1446 *
1447 * Note that this may break certain expectations of the receiver, such
1448 * as the ability to drop unicast IP packets received within multicast
1449 * L2 frames, or the ability to not send ICMP destination unreachable
1450 * messages for packets received in L2 multicast (which is required,
1451 * but the receiver can't tell the difference if this new option is
1452 * enabled.)
1453 *
1454 * This also doesn't implement the 802.11 DMS (directed multicast
1455 * service).
1456 */
1457 int multicast_to_unicast;
Hai Shalom74f70d42019-02-11 14:42:39 -08001458
1459 /**
1460 * ftm_responder - Whether FTM responder is enabled
1461 */
1462 int ftm_responder;
1463
1464 /**
1465 * lci - Binary data, the content of an LCI report IE with type 8 as
1466 * defined in IEEE Std 802.11-2016, 9.4.2.22.10
1467 */
1468 const struct wpabuf *lci;
1469
1470 /**
1471 * civic - Binary data, the content of a measurement report IE with
1472 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
1473 */
1474 const struct wpabuf *civic;
Hai Shalomc3565922019-10-28 11:58:20 -07001475
1476 /**
1477 * he_spr - Whether Spatial Reuse is enabled
1478 */
1479 int he_spr;
1480
1481 /**
1482 * he_spr_srg_obss_pd_min_offset - Minimum TX power offset
1483 */
1484 int he_spr_srg_obss_pd_min_offset;
1485
1486 /**
1487 * he_spr_srg_obss_pd_max_offset - Maximum TX power offset
1488 */
1489 int he_spr_srg_obss_pd_max_offset;
Hai Shalomfdcde762020-04-02 11:19:20 -07001490
1491 /**
1492 * he_bss_color - Whether the BSS Color is disabled
1493 */
1494 int he_bss_color_disabled;
1495
1496 /**
1497 * he_bss_color_partial - The BSS Color AID equation
1498 */
1499 int he_bss_color_partial;
1500
1501 /**
1502 * he_bss_color - The BSS Color of the AP
1503 */
1504 int he_bss_color;
1505
1506 /**
1507 * twt_responder - Whether Target Wait Time responder is enabled
1508 */
1509 int twt_responder;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001510};
1511
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001512struct wpa_driver_mesh_bss_params {
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001513#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1514#define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1515#define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1516#define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001517#define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001518 /*
1519 * TODO: Other mesh configuration parameters would go here.
1520 * See NL80211_MESHCONF_* for all the mesh config parameters.
1521 */
1522 unsigned int flags;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001523 int auto_plinks;
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001524 int peer_link_timeout;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001525 int max_peer_links;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001526 int rssi_threshold;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001527 u16 ht_opmode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001528};
1529
1530struct wpa_driver_mesh_join_params {
1531 const u8 *meshid;
1532 int meshid_len;
1533 const int *basic_rates;
1534 const u8 *ies;
1535 int ie_len;
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001536 struct hostapd_freq_params freq;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001537 int beacon_int;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001538 int dtim_period;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001539 struct wpa_driver_mesh_bss_params conf;
1540#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1541#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1542#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1543#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1544 unsigned int flags;
1545};
1546
Hai Shalomfdcde762020-04-02 11:19:20 -07001547struct wpa_driver_set_key_params {
1548 /**
1549 * ifname - Interface name (for multi-SSID/VLAN support) */
1550 const char *ifname;
1551
1552 /**
1553 * alg - Encryption algorithm
1554 *
1555 * (%WPA_ALG_NONE, %WPA_ALG_WEP, %WPA_ALG_TKIP, %WPA_ALG_CCMP,
1556 * %WPA_ALG_IGTK, %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1557 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256, %WPA_ALG_BIP_CMAC_256);
1558 * %WPA_ALG_NONE clears the key. */
1559 enum wpa_alg alg;
1560
1561 /**
1562 * addr - Address of the peer STA
1563 *
1564 * (BSSID of the current AP when setting pairwise key in station mode),
1565 * ff:ff:ff:ff:ff:ff for broadcast keys, %NULL for default keys that
1566 * are used both for broadcast and unicast; when clearing keys, %NULL
1567 * is used to indicate that both the broadcast-only and default key of
1568 * the specified key index is to be cleared */
1569 const u8 *addr;
1570
1571 /**
1572 * key_idx - Key index
1573 *
1574 * (0..3), usually 0 for unicast keys; 4..5 for IGTK; 6..7 for BIGTK */
1575 int key_idx;
1576
1577 /**
1578 * set_tx - Configure this key as the default Tx key
1579 *
1580 * Only used when driver does not support separate unicast/individual
1581 * key */
1582 int set_tx;
1583
1584 /**
1585 * seq - Sequence number/packet number
1586 *
1587 * seq_len octets, the next packet number to be used for in replay
1588 * protection; configured for Rx keys (in most cases, this is only used
1589 * with broadcast keys and set to zero for unicast keys); %NULL if not
1590 * set */
1591 const u8 *seq;
1592
1593 /**
1594 * seq_len - Length of the seq, depends on the algorithm
1595 *
1596 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets */
1597 size_t seq_len;
1598
1599 /**
1600 * key - Key buffer
1601 *
1602 * TKIP: 16-byte temporal key, 8-byte Tx Mic key, 8-byte Rx Mic Key */
1603 const u8 *key;
1604
1605 /**
1606 * key_len - Length of the key buffer in octets
1607 *
1608 * WEP: 5 or 13, TKIP: 32, CCMP/GCMP: 16, IGTK: 16 */
1609 size_t key_len;
1610
1611 /**
1612 * vlan_id - VLAN index (0..4095) for VLAN offload cases */
1613 int vlan_id;
1614
1615 /**
1616 * key_flag - Additional key flags
1617 *
1618 * %KEY_FLAG_MODIFY
1619 * Set when an already installed key must be updated.
1620 * So far the only use-case is changing RX/TX status for
1621 * pairwise keys. Must not be set when deleting a key.
1622 * %KEY_FLAG_DEFAULT
1623 * Set when the key is also a default key. Must not be set when
1624 * deleting a key.
1625 * %KEY_FLAG_RX
1626 * The key is valid for RX. Must not be set when deleting a key.
1627 * %KEY_FLAG_TX
1628 * The key is valid for TX. Must not be set when deleting a key.
1629 * %KEY_FLAG_GROUP
1630 * The key is a broadcast or group key.
1631 * %KEY_FLAG_PAIRWISE
1632 * The key is a pairwise key.
1633 * %KEY_FLAG_PMK
1634 * The key is a Pairwise Master Key (PMK).
1635 *
1636 * Valid and pre-defined combinations are:
1637 * %KEY_FLAG_GROUP_RX_TX
1638 * WEP key not to be installed as default key.
1639 * %KEY_FLAG_GROUP_RX_TX_DEFAULT
1640 * Default WEP or WPA-NONE key.
1641 * %KEY_FLAG_GROUP_RX
1642 * GTK key valid for RX only.
1643 * %KEY_FLAG_GROUP_TX_DEFAULT
1644 * GTK key valid for TX only, immediately taking over TX.
1645 * %KEY_FLAG_PAIRWISE_RX_TX
1646 * Pairwise key immediately becoming the active pairwise key.
1647 * %KEY_FLAG_PAIRWISE_RX
1648 * Pairwise key not yet valid for TX. (Only usable when Extended
1649 * Key ID is supported by the driver.)
1650 * %KEY_FLAG_PAIRWISE_RX_TX_MODIFY
1651 * Enable TX for a pairwise key installed with
1652 * KEY_FLAG_PAIRWISE_RX.
1653 *
1654 * Not a valid standalone key type but pre-defined to be combined
1655 * with other key_flags:
1656 * %KEY_FLAG_RX_TX
1657 * RX/TX key. */
1658 enum key_flag key_flag;
1659};
1660
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001661/**
1662 * struct wpa_driver_capa - Driver capability information
1663 */
1664struct wpa_driver_capa {
1665#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1666#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1667#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1668#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1669#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1670#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1671#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001672#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001673#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1674#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001675#define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
1676#define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
1677#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1678#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1679#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1680#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
Hai Shalom74f70d42019-02-11 14:42:39 -08001681#define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001682 /** Bitfield of supported key management suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001683 unsigned int key_mgmt;
1684
1685#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1686#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1687#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1688#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
Dmitry Shmidt04949592012-07-19 12:16:46 -07001689#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001690#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001691#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1692#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1693#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1694#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1695#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1696#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001697#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001698 /** Bitfield of supported cipher suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001699 unsigned int enc;
1700
1701#define WPA_DRIVER_AUTH_OPEN 0x00000001
1702#define WPA_DRIVER_AUTH_SHARED 0x00000002
1703#define WPA_DRIVER_AUTH_LEAP 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001704 /** Bitfield of supported IEEE 802.11 authentication algorithms */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001705 unsigned int auth;
1706
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001707/** Driver generated WPA/RSN IE */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001708#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001709/** Driver needs static WEP key setup after association command */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001710#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001711/** Driver takes care of all DFS operations */
Dmitry Shmidtd11f0192014-03-24 12:09:47 -07001712#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001713/** Driver takes care of RSN 4-way handshake internally; PMK is configured with
Hai Shalomfdcde762020-04-02 11:19:20 -07001714 * struct wpa_driver_ops::set_key using key_flag = KEY_FLAG_PMK */
Hai Shalom74f70d42019-02-11 14:42:39 -08001715#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001716/** Driver is for a wired Ethernet interface */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001717#define WPA_DRIVER_FLAGS_WIRED 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001718/** Driver provides separate commands for authentication and association (SME in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001719 * wpa_supplicant). */
1720#define WPA_DRIVER_FLAGS_SME 0x00000020
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001721/** Driver supports AP mode */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001722#define WPA_DRIVER_FLAGS_AP 0x00000040
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001723/** Driver needs static WEP key setup after association has been completed */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001724#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001725/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001726#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001727/** Driver supports concurrent P2P operations */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001728#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001729/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001730 * Driver uses the initial interface as a dedicated management interface, i.e.,
1731 * it cannot be used for P2P group operations or non-P2P purposes.
1732 */
1733#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001734/** This interface is P2P capable (P2P GO or P2P Client) */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001735#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001736/** Driver supports station and key removal when stopping an AP */
Dmitry Shmidta38abf92014-03-06 13:38:44 -08001737#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001738/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001739 * Driver uses the initial interface for P2P management interface and non-P2P
1740 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1741 * P2P group operations.
1742 */
1743#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001744/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001745 * Driver is known to use sane error codes, i.e., when it indicates that
1746 * something (e.g., association) fails, there was indeed a failure and the
1747 * operation does not end up getting completed successfully later.
1748 */
1749#define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001750/** Driver supports off-channel TX */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001751#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001752/** Driver indicates TX status events for EAPOL Data frames */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001753#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001754/** Driver indicates TX status events for Deauth/Disassoc frames */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001755#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001756/** Driver supports roaming (BSS selection) in firmware */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001757#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001758/** Driver supports operating as a TDLS peer */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001759#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001760/** Driver requires external TDLS setup/teardown/discovery */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001761#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001762/** Driver indicates support for Probe Response offloading in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001763#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001764/** Driver supports U-APSD in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001765#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001766/** Driver supports inactivity timer in AP mode */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001767#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001768/** Driver expects user space implementation of MLME in AP mode */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001769#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001770/** Driver supports SAE with user space SME */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001771#define WPA_DRIVER_FLAGS_SAE 0x02000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001772/** Driver makes use of OBSS scan mechanism in wpa_supplicant */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001773#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001774/** Driver supports IBSS (Ad-hoc) mode */
Dmitry Shmidt700a1372013-03-15 14:14:44 -07001775#define WPA_DRIVER_FLAGS_IBSS 0x08000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001776/** Driver supports radar detection */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07001777#define WPA_DRIVER_FLAGS_RADAR 0x10000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001778/** Driver supports a dedicated interface for P2P Device */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001779#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001780/** Driver supports QoS Mapping */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001781#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001782/** Driver supports CSA in AP mode */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001783#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001784/** Driver supports mesh */
1785#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1786/** Driver support ACS offload */
1787#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1788/** Driver supports key management offload */
1789#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1790/** Driver supports TDLS channel switching */
1791#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001792/** Driver supports IBSS with HT datarates */
1793#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001794/** Driver supports IBSS with VHT datarates */
1795#define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07001796/** Driver supports automatic band selection */
1797#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001798/** Driver supports simultaneous off-channel operations */
1799#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001800/** Driver supports full AP client state */
1801#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001802/** Driver supports P2P Listen offload */
1803#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001804/** Driver supports FILS */
1805#define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001806/** Driver supports Beacon frame TX rate configuration (legacy rates) */
1807#define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1808/** Driver supports Beacon frame TX rate configuration (HT rates) */
1809#define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1810/** Driver supports Beacon frame TX rate configuration (VHT rates) */
1811#define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08001812/** Driver supports mgmt_tx with random TX address in non-connected state */
1813#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
1814/** Driver supports mgmt_tx with random TX addr in connected state */
1815#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
1816/** Driver supports better BSS reporting with sched_scan in connected mode */
1817#define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
1818/** Driver supports HE capabilities */
1819#define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001820/** Driver supports FILS shared key offload */
1821#define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
1822/** Driver supports all OCE STA specific mandatory features */
1823#define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
1824/** Driver supports all OCE AP specific mandatory features */
1825#define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
1826/**
1827 * Driver supports all OCE STA-CFON specific mandatory features only.
1828 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
1829 * userspace shall assume that this driver may not support all OCE AP
1830 * functionality but can support only OCE STA-CFON functionality.
1831 */
1832#define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
Roshan Pius3a1667e2018-07-03 15:17:14 -07001833/** Driver supports MFP-optional in the connect command */
1834#define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL
Hai Shalom39ba6fc2019-01-22 12:40:38 -08001835/** Driver is a self-managed regulatory device */
1836#define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL
Hai Shalom74f70d42019-02-11 14:42:39 -08001837/** Driver supports FTM responder functionality */
1838#define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL
1839/** Driver support 4-way handshake offload for WPA-Personal */
1840#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
Hai Shalomb755a2a2020-04-23 21:49:02 -07001841/** Driver supports a separate control port TX for EAPOL frames */
Hai Shalomfdcde762020-04-02 11:19:20 -07001842#define WPA_DRIVER_FLAGS_CONTROL_PORT 0x0400000000000000ULL
1843/** Driver supports VLAN offload */
1844#define WPA_DRIVER_FLAGS_VLAN_OFFLOAD 0x0800000000000000ULL
1845/** Driver supports UPDATE_FT_IES command */
1846#define WPA_DRIVER_FLAGS_UPDATE_FT_IES 0x1000000000000000ULL
1847/** Driver can correctly rekey PTKs without Extended Key ID */
1848#define WPA_DRIVER_FLAGS_SAFE_PTK0_REKEYS 0x2000000000000000ULL
1849/** Driver supports Beacon protection */
1850#define WPA_DRIVER_FLAGS_BEACON_PROTECTION 0x4000000000000000ULL
1851/** Driver supports Extended Key ID */
1852#define WPA_DRIVER_FLAGS_EXTENDED_KEY_ID 0x8000000000000000ULL
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001853 u64 flags;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001854
Hai Shalomb755a2a2020-04-23 21:49:02 -07001855/** Driver supports a separate control port RX for EAPOL frames */
1856#define WPA_DRIVER_FLAGS2_CONTROL_PORT_RX 0x0000000000000001ULL
1857 u64 flags2;
1858
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001859#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1860 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1861
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001862 unsigned int wmm_ac_supported:1;
1863
1864 unsigned int mac_addr_rand_scan_supported:1;
1865 unsigned int mac_addr_rand_sched_scan_supported:1;
1866
1867 /** Maximum number of supported active probe SSIDs */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001868 int max_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001869
1870 /** Maximum number of supported active probe SSIDs for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001871 int max_sched_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001872
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08001873 /** Maximum number of supported scan plans for scheduled scan */
1874 unsigned int max_sched_scan_plans;
1875
1876 /** Maximum interval in a scan plan. In seconds */
1877 u32 max_sched_scan_plan_interval;
1878
1879 /** Maximum number of iterations in a single scan plan */
1880 u32 max_sched_scan_plan_iterations;
1881
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001882 /** Whether sched_scan (offloaded scanning) is supported */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001883 int sched_scan_supported;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001884
1885 /** Maximum number of supported match sets for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001886 int max_match_sets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001887
1888 /**
1889 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1890 */
1891 unsigned int max_remain_on_chan;
1892
1893 /**
1894 * max_stations - Maximum number of associated stations the driver
1895 * supports in AP mode
1896 */
1897 unsigned int max_stations;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001898
1899 /**
1900 * probe_resp_offloads - Bitmap of supported protocols by the driver
1901 * for Probe Response offloading.
1902 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001903/** Driver Probe Response offloading support for WPS ver. 1 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001904#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001905/** Driver Probe Response offloading support for WPS ver. 2 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001906#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001907/** Driver Probe Response offloading support for P2P */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001908#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001909/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001910#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1911 unsigned int probe_resp_offloads;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001912
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07001913 unsigned int max_acl_mac_addrs;
1914
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001915 /**
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07001916 * Number of supported concurrent channels
1917 */
1918 unsigned int num_multichan_concurrent;
1919
1920 /**
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001921 * extended_capa - extended capabilities in driver/device
1922 *
1923 * Must be allocated and freed by driver and the pointers must be
1924 * valid for the lifetime of the driver, i.e., freed in deinit()
1925 */
1926 const u8 *extended_capa, *extended_capa_mask;
1927 unsigned int extended_capa_len;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001928
1929 struct wowlan_triggers wowlan_triggers;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001930
1931/** Driver adds the DS Params Set IE in Probe Request frames */
1932#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1933/** Driver adds the WFA TPC IE in Probe Request frames */
1934#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1935/** Driver handles quiet period requests */
1936#define WPA_DRIVER_FLAGS_QUIET 0x00000004
1937/**
1938 * Driver is capable of inserting the current TX power value into the body of
1939 * transmitted frames.
1940 * Background: Some Action frames include a TPC Report IE. This IE contains a
1941 * TX power field, which has to be updated by lower layers. One such Action
1942 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1943 * of spectrum management). Note that this insertion takes place at a fixed
1944 * offset, namely the 6th byte in the Action frame body.
1945 */
1946#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001947/**
1948 * Driver supports RRM. With this support, the driver will accept to use RRM in
1949 * (Re)Association Request frames, without supporting quiet period.
1950 */
1951#define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1952
Dmitry Shmidt29333592017-01-09 12:27:11 -08001953/** Driver supports setting the scan dwell time */
1954#define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
1955/** Driver supports Beacon Report Measurement */
1956#define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
1957
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001958 u32 rrm_flags;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001959
1960 /* Driver concurrency capabilities */
1961 unsigned int conc_capab;
1962 /* Maximum number of concurrent channels on 2.4 GHz */
1963 unsigned int max_conc_chan_2_4;
1964 /* Maximum number of concurrent channels on 5 GHz */
1965 unsigned int max_conc_chan_5_0;
1966
1967 /* Maximum number of supported CSA counters */
1968 u16 max_csa_counters;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001969};
1970
1971
1972struct hostapd_data;
1973
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001974#define STA_DRV_DATA_TX_MCS BIT(0)
1975#define STA_DRV_DATA_RX_MCS BIT(1)
1976#define STA_DRV_DATA_TX_VHT_MCS BIT(2)
1977#define STA_DRV_DATA_RX_VHT_MCS BIT(3)
1978#define STA_DRV_DATA_TX_VHT_NSS BIT(4)
1979#define STA_DRV_DATA_RX_VHT_NSS BIT(5)
1980#define STA_DRV_DATA_TX_SHORT_GI BIT(6)
1981#define STA_DRV_DATA_RX_SHORT_GI BIT(7)
Roshan Pius3a1667e2018-07-03 15:17:14 -07001982#define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001983
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001984struct hostap_sta_driver_data {
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001985 unsigned long rx_packets, tx_packets;
1986 unsigned long long rx_bytes, tx_bytes;
Hai Shalom81f62d82019-07-22 12:10:00 -07001987 unsigned long long rx_airtime, tx_airtime;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001988 int bytes_64bit; /* whether 64-bit byte counters are supported */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001989 unsigned long current_tx_rate;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001990 unsigned long current_rx_rate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001991 unsigned long inactive_msec;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001992 unsigned long flags; /* bitfield of STA_DRV_DATA_* */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001993 unsigned long num_ps_buf_frames;
1994 unsigned long tx_retry_failed;
1995 unsigned long tx_retry_count;
Roshan Pius3a1667e2018-07-03 15:17:14 -07001996 s8 last_ack_rssi;
Hai Shalom81f62d82019-07-22 12:10:00 -07001997 unsigned long backlog_packets;
1998 unsigned long backlog_bytes;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001999 s8 signal;
2000 u8 rx_vhtmcs;
2001 u8 tx_vhtmcs;
2002 u8 rx_mcs;
2003 u8 tx_mcs;
2004 u8 rx_vht_nss;
2005 u8 tx_vht_nss;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002006};
2007
2008struct hostapd_sta_add_params {
2009 const u8 *addr;
2010 u16 aid;
2011 u16 capability;
2012 const u8 *supp_rates;
2013 size_t supp_rates_len;
2014 u16 listen_interval;
2015 const struct ieee80211_ht_capabilities *ht_capabilities;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08002016 const struct ieee80211_vht_capabilities *vht_capabilities;
Dmitry Shmidtbd14a572014-02-18 10:33:49 -08002017 int vht_opmode_enabled;
2018 u8 vht_opmode;
Hai Shalom81f62d82019-07-22 12:10:00 -07002019 const struct ieee80211_he_capabilities *he_capab;
2020 size_t he_capab_len;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002021 u32 flags; /* bitmask of WPA_STA_* flags */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002022 u32 flags_mask; /* unset bits in flags */
2023#ifdef CONFIG_MESH
2024 enum mesh_plink_state plink_state;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07002025 u16 peer_aid;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002026#endif /* CONFIG_MESH */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002027 int set; /* Set STA parameters instead of add */
2028 u8 qosinfo;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08002029 const u8 *ext_capab;
2030 size_t ext_capab_len;
Dmitry Shmidt344abd32014-01-14 13:17:00 -08002031 const u8 *supp_channels;
2032 size_t supp_channels_len;
2033 const u8 *supp_oper_classes;
2034 size_t supp_oper_classes_len;
Dmitry Shmidt849734c2016-05-27 09:59:01 -07002035 int support_p2p_ps;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002036};
2037
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002038struct mac_address {
2039 u8 addr[ETH_ALEN];
2040};
2041
2042struct hostapd_acl_params {
2043 u8 acl_policy;
2044 unsigned int num_mac_acl;
2045 struct mac_address mac_acl[0];
2046};
2047
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002048enum wpa_driver_if_type {
2049 /**
2050 * WPA_IF_STATION - Station mode interface
2051 */
2052 WPA_IF_STATION,
2053
2054 /**
2055 * WPA_IF_AP_VLAN - AP mode VLAN interface
2056 *
2057 * This interface shares its address and Beacon frame with the main
2058 * BSS.
2059 */
2060 WPA_IF_AP_VLAN,
2061
2062 /**
2063 * WPA_IF_AP_BSS - AP mode BSS interface
2064 *
2065 * This interface has its own address and Beacon frame.
2066 */
2067 WPA_IF_AP_BSS,
2068
2069 /**
2070 * WPA_IF_P2P_GO - P2P Group Owner
2071 */
2072 WPA_IF_P2P_GO,
2073
2074 /**
2075 * WPA_IF_P2P_CLIENT - P2P Client
2076 */
2077 WPA_IF_P2P_CLIENT,
2078
2079 /**
2080 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
2081 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
2082 */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002083 WPA_IF_P2P_GROUP,
2084
2085 /**
2086 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
2087 * abstracted P2P Device function in the driver
2088 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002089 WPA_IF_P2P_DEVICE,
2090
2091 /*
2092 * WPA_IF_MESH - Mesh interface
2093 */
2094 WPA_IF_MESH,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002095
2096 /*
2097 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
2098 */
2099 WPA_IF_TDLS,
2100
2101 /*
2102 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
2103 */
2104 WPA_IF_IBSS,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002105};
2106
2107struct wpa_init_params {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002108 void *global_priv;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002109 const u8 *bssid;
2110 const char *ifname;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002111 const char *driver_params;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002112 int use_pae_group_addr;
2113 char **bridge;
2114 size_t num_bridge;
2115
2116 u8 *own_addr; /* buffer for writing own MAC address */
2117};
2118
2119
2120struct wpa_bss_params {
2121 /** Interface name (for multi-SSID/VLAN support) */
2122 const char *ifname;
2123 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
2124 int enabled;
2125
2126 int wpa;
2127 int ieee802_1x;
2128 int wpa_group;
2129 int wpa_pairwise;
2130 int wpa_key_mgmt;
2131 int rsn_preauth;
2132 enum mfp_options ieee80211w;
2133};
2134
2135#define WPA_STA_AUTHORIZED BIT(0)
2136#define WPA_STA_WMM BIT(1)
2137#define WPA_STA_SHORT_PREAMBLE BIT(2)
2138#define WPA_STA_MFP BIT(3)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002139#define WPA_STA_TDLS_PEER BIT(4)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002140#define WPA_STA_AUTHENTICATED BIT(5)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002141#define WPA_STA_ASSOCIATED BIT(6)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002142
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002143enum tdls_oper {
2144 TDLS_DISCOVERY_REQ,
2145 TDLS_SETUP,
2146 TDLS_TEARDOWN,
2147 TDLS_ENABLE_LINK,
2148 TDLS_DISABLE_LINK,
2149 TDLS_ENABLE,
2150 TDLS_DISABLE
2151};
2152
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002153enum wnm_oper {
2154 WNM_SLEEP_ENTER_CONFIRM,
2155 WNM_SLEEP_ENTER_FAIL,
2156 WNM_SLEEP_EXIT_CONFIRM,
2157 WNM_SLEEP_EXIT_FAIL,
2158 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
2159 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
2160 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
2161 * a STA */
2162 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
2163 * for a STA */
2164 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
2165 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
2166 * for a STA */
2167 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
2168};
2169
Roshan Pius3a1667e2018-07-03 15:17:14 -07002170/* enum smps_mode - SMPS mode definitions */
2171enum smps_mode {
2172 SMPS_AUTOMATIC,
2173 SMPS_OFF,
2174 SMPS_DYNAMIC,
2175 SMPS_STATIC,
2176
2177 /* Keep last */
2178 SMPS_INVALID,
2179};
2180
Hai Shalom74f70d42019-02-11 14:42:39 -08002181#define WPA_INVALID_NOISE 9999
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002182
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002183/**
2184 * struct wpa_signal_info - Information about channel signal quality
Hai Shalom74f70d42019-02-11 14:42:39 -08002185 * @frequency: control frequency
2186 * @above_threshold: true if the above threshold was crossed
2187 * (relevant for a CQM event)
2188 * @current_signal: in dBm
2189 * @avg_signal: in dBm
2190 * @avg_beacon_signal: in dBm
2191 * @current_noise: %WPA_INVALID_NOISE if not supported
2192 * @current_txrate: current TX rate
2193 * @chanwidth: channel width
2194 * @center_frq1: center frequency for the first segment
2195 * @center_frq2: center frequency for the second segment (if relevant)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002196 */
2197struct wpa_signal_info {
2198 u32 frequency;
2199 int above_threshold;
2200 int current_signal;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002201 int avg_signal;
Dmitry Shmidtf73259c2015-03-17 11:00:54 -07002202 int avg_beacon_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002203 int current_noise;
2204 int current_txrate;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002205 enum chan_width chanwidth;
2206 int center_frq1;
2207 int center_frq2;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002208};
2209
2210/**
Hai Shalom74f70d42019-02-11 14:42:39 -08002211 * struct wpa_channel_info - Information about the current channel
2212 * @frequency: Center frequency of the primary 20 MHz channel
2213 * @chanwidth: Width of the current operating channel
2214 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
2215 * This field is only filled in when using a 40 MHz channel.
2216 * @center_frq1: Center frequency of frequency segment 0
2217 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
2218 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
2219 * derived from center_frq2 for convenience.
2220 */
2221struct wpa_channel_info {
2222 u32 frequency;
2223 enum chan_width chanwidth;
2224 int sec_channel;
2225 int center_frq1;
2226 int center_frq2;
2227 u8 seg1_idx;
2228};
2229
2230/**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002231 * struct beacon_data - Beacon data
2232 * @head: Head portion of Beacon frame (before TIM IE)
2233 * @tail: Tail portion of Beacon frame (after TIM IE)
2234 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2235 * @proberesp_ies: Extra information element(s) to add into Probe Response
2236 * frames or %NULL
2237 * @assocresp_ies: Extra information element(s) to add into (Re)Association
2238 * Response frames or %NULL
2239 * @probe_resp: Probe Response frame template
2240 * @head_len: Length of @head
2241 * @tail_len: Length of @tail
2242 * @beacon_ies_len: Length of beacon_ies in octets
2243 * @proberesp_ies_len: Length of proberesp_ies in octets
2244 * @proberesp_ies_len: Length of proberesp_ies in octets
2245 * @probe_resp_len: Length of probe response template (@probe_resp)
2246 */
2247struct beacon_data {
2248 u8 *head, *tail;
2249 u8 *beacon_ies;
2250 u8 *proberesp_ies;
2251 u8 *assocresp_ies;
2252 u8 *probe_resp;
2253
2254 size_t head_len, tail_len;
2255 size_t beacon_ies_len;
2256 size_t proberesp_ies_len;
2257 size_t assocresp_ies_len;
2258 size_t probe_resp_len;
2259};
2260
2261/**
2262 * struct csa_settings - Settings for channel switch command
2263 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2264 * @block_tx: 1 - block transmission for CSA period
2265 * @freq_params: Next channel frequency parameter
2266 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2267 * @beacon_after: Next beacon/probe resp/asooc resp info
2268 * @counter_offset_beacon: Offset to the count field in beacon's tail
2269 * @counter_offset_presp: Offset to the count field in probe resp.
2270 */
2271struct csa_settings {
2272 u8 cs_count;
2273 u8 block_tx;
2274
2275 struct hostapd_freq_params freq_params;
2276 struct beacon_data beacon_csa;
2277 struct beacon_data beacon_after;
2278
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002279 u16 counter_offset_beacon[2];
2280 u16 counter_offset_presp[2];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002281};
2282
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002283/* TDLS peer capabilities for send_tdls_mgmt() */
2284enum tdls_peer_capability {
2285 TDLS_PEER_HT = BIT(0),
2286 TDLS_PEER_VHT = BIT(1),
2287 TDLS_PEER_WMM = BIT(2),
2288};
2289
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002290/* valid info in the wmm_params struct */
2291enum wmm_params_valid_info {
2292 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
2293};
2294
2295/**
2296 * struct wmm_params - WMM parameterss configured for this association
2297 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2298 * of the struct contain valid information.
2299 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2300 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2301 */
2302struct wmm_params {
2303 u8 info_bitmap;
2304 u8 uapsd_queues;
2305};
2306
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002307#ifdef CONFIG_MACSEC
2308struct macsec_init_params {
Hai Shalome21d4e82020-04-29 16:34:06 -07002309 bool always_include_sci;
2310 bool use_es;
2311 bool use_scb;
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002312};
2313#endif /* CONFIG_MACSEC */
2314
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002315enum drv_br_port_attr {
2316 DRV_BR_PORT_ATTR_PROXYARP,
2317 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
2318};
2319
2320enum drv_br_net_param {
2321 DRV_BR_NET_PARAM_GARP_ACCEPT,
Dmitry Shmidt83474442015-04-15 13:47:09 -07002322 DRV_BR_MULTICAST_SNOOPING,
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002323};
2324
2325struct drv_acs_params {
2326 /* Selected mode (HOSTAPD_MODE_*) */
2327 enum hostapd_hw_mode hw_mode;
2328
2329 /* Indicates whether HT is enabled */
2330 int ht_enabled;
2331
2332 /* Indicates whether HT40 is enabled */
2333 int ht40_enabled;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07002334
2335 /* Indicates whether VHT is enabled */
2336 int vht_enabled;
2337
2338 /* Configured ACS channel width */
2339 u16 ch_width;
2340
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08002341 /* ACS frequency list info */
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002342 const int *freq_list;
Hai Shalomfdcde762020-04-02 11:19:20 -07002343
2344 /* Indicates whether EDMG is enabled */
2345 int edmg_enabled;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002346};
2347
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002348struct wpa_bss_trans_info {
2349 u8 mbo_transition_reason;
2350 u8 n_candidates;
2351 u8 *bssid;
2352};
2353
2354struct wpa_bss_candidate_info {
2355 u8 num;
2356 struct candidate_list {
2357 u8 bssid[ETH_ALEN];
2358 u8 is_accept;
2359 u32 reject_reason;
2360 } *candidates;
2361};
2362
2363struct wpa_pmkid_params {
2364 const u8 *bssid;
2365 const u8 *ssid;
2366 size_t ssid_len;
2367 const u8 *fils_cache_id;
2368 const u8 *pmkid;
2369 const u8 *pmk;
2370 size_t pmk_len;
Hai Shalomfdcde762020-04-02 11:19:20 -07002371 u32 pmk_lifetime;
2372 u8 pmk_reauth_threshold;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002373};
2374
2375/* Mask used to specify which connection parameters have to be updated */
2376enum wpa_drv_update_connect_params_mask {
2377 WPA_DRV_UPDATE_ASSOC_IES = BIT(0),
2378 WPA_DRV_UPDATE_FILS_ERP_INFO = BIT(1),
2379 WPA_DRV_UPDATE_AUTH_TYPE = BIT(2),
2380};
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002381
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002382/**
Roshan Pius3a1667e2018-07-03 15:17:14 -07002383 * struct external_auth - External authentication trigger parameters
2384 *
2385 * These are used across the external authentication request and event
2386 * interfaces.
2387 * @action: Action type / trigger for external authentication. Only significant
2388 * for the event interface.
2389 * @bssid: BSSID of the peer with which the authentication has to happen. Used
2390 * by both the request and event interface.
2391 * @ssid: SSID of the AP. Used by both the request and event interface.
2392 * @ssid_len: SSID length in octets.
2393 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2394 * the request interface.
2395 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2396 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2397 * the real status code for failures. Used only for the request interface
2398 * from user space to the driver.
Hai Shalom5f92bc92019-04-18 11:54:11 -07002399 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
Roshan Pius3a1667e2018-07-03 15:17:14 -07002400 */
2401struct external_auth {
2402 enum {
2403 EXT_AUTH_START,
2404 EXT_AUTH_ABORT,
2405 } action;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002406 const u8 *bssid;
2407 const u8 *ssid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002408 size_t ssid_len;
2409 unsigned int key_mgmt_suite;
2410 u16 status;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002411 const u8 *pmkid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002412};
2413
2414/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002415 * struct wpa_driver_ops - Driver interface API definition
2416 *
2417 * This structure defines the API that each driver interface needs to implement
2418 * for core wpa_supplicant code. All driver specific functionality is captured
2419 * in this wrapper.
2420 */
2421struct wpa_driver_ops {
2422 /** Name of the driver interface */
2423 const char *name;
2424 /** One line description of the driver interface */
2425 const char *desc;
2426
2427 /**
2428 * get_bssid - Get the current BSSID
2429 * @priv: private driver interface data
2430 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2431 *
2432 * Returns: 0 on success, -1 on failure
2433 *
2434 * Query kernel driver for the current BSSID and copy it to bssid.
2435 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2436 * associated.
2437 */
2438 int (*get_bssid)(void *priv, u8 *bssid);
2439
2440 /**
2441 * get_ssid - Get the current SSID
2442 * @priv: private driver interface data
2443 * @ssid: buffer for SSID (at least 32 bytes)
2444 *
2445 * Returns: Length of the SSID on success, -1 on failure
2446 *
2447 * Query kernel driver for the current SSID and copy it to ssid.
2448 * Returning zero is recommended if the STA is not associated.
2449 *
2450 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2451 * can, at least in theory, contain control characters (including nul)
2452 * and as such, should be processed as binary data, not a printable
2453 * string.
2454 */
2455 int (*get_ssid)(void *priv, u8 *ssid);
2456
2457 /**
2458 * set_key - Configure encryption key
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002459 * @priv: private driver interface data
Hai Shalomfdcde762020-04-02 11:19:20 -07002460 * @params: Key parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002461 * Returns: 0 on success, -1 on failure
2462 *
2463 * Configure the given key for the kernel driver. If the driver
2464 * supports separate individual keys (4 default keys + 1 individual),
2465 * addr can be used to determine whether the key is default or
2466 * individual. If only 4 keys are supported, the default key with key
2467 * index 0 is used as the individual key. STA must be configured to use
2468 * it as the default Tx key (set_tx is set) and accept Rx for all the
2469 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2470 * broadcast keys, so key index 0 is available for this kind of
2471 * configuration.
2472 *
2473 * Please note that TKIP keys include separate TX and RX MIC keys and
2474 * some drivers may expect them in different order than wpa_supplicant
2475 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
2476 * will trigger Michael MIC errors. This can be fixed by changing the
2477 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
2478 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2479 * example on how this can be done.
2480 */
Hai Shalomfdcde762020-04-02 11:19:20 -07002481 int (*set_key)(void *priv, struct wpa_driver_set_key_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002482
2483 /**
2484 * init - Initialize driver interface
2485 * @ctx: context to be used when calling wpa_supplicant functions,
2486 * e.g., wpa_supplicant_event()
2487 * @ifname: interface name, e.g., wlan0
2488 *
2489 * Returns: Pointer to private data, %NULL on failure
2490 *
2491 * Initialize driver interface, including event processing for kernel
2492 * driver events (e.g., associated, scan results, Michael MIC failure).
2493 * This function can allocate a private configuration data area for
2494 * @ctx, file descriptor, interface name, etc. information that may be
2495 * needed in future driver operations. If this is not used, non-NULL
2496 * value will need to be returned because %NULL is used to indicate
2497 * failure. The returned value will be used as 'void *priv' data for
2498 * all other driver_ops functions.
2499 *
2500 * The main event loop (eloop.c) of wpa_supplicant can be used to
2501 * register callback for read sockets (eloop_register_read_sock()).
2502 *
2503 * See below for more information about events and
2504 * wpa_supplicant_event() function.
2505 */
2506 void * (*init)(void *ctx, const char *ifname);
2507
2508 /**
2509 * deinit - Deinitialize driver interface
2510 * @priv: private driver interface data from init()
2511 *
2512 * Shut down driver interface and processing of driver events. Free
2513 * private data buffer if one was allocated in init() handler.
2514 */
2515 void (*deinit)(void *priv);
2516
2517 /**
2518 * set_param - Set driver configuration parameters
2519 * @priv: private driver interface data from init()
2520 * @param: driver specific configuration parameters
2521 *
2522 * Returns: 0 on success, -1 on failure
2523 *
2524 * Optional handler for notifying driver interface about configuration
2525 * parameters (driver_param).
2526 */
2527 int (*set_param)(void *priv, const char *param);
2528
2529 /**
2530 * set_countermeasures - Enable/disable TKIP countermeasures
2531 * @priv: private driver interface data
2532 * @enabled: 1 = countermeasures enabled, 0 = disabled
2533 *
2534 * Returns: 0 on success, -1 on failure
2535 *
2536 * Configure TKIP countermeasures. When these are enabled, the driver
2537 * should drop all received and queued frames that are using TKIP.
2538 */
2539 int (*set_countermeasures)(void *priv, int enabled);
2540
2541 /**
2542 * deauthenticate - Request driver to deauthenticate
2543 * @priv: private driver interface data
2544 * @addr: peer address (BSSID of the AP)
2545 * @reason_code: 16-bit reason code to be sent in the deauthentication
2546 * frame
2547 *
2548 * Returns: 0 on success, -1 on failure
2549 */
Hai Shalom81f62d82019-07-22 12:10:00 -07002550 int (*deauthenticate)(void *priv, const u8 *addr, u16 reason_code);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002551
2552 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002553 * associate - Request driver to associate
2554 * @priv: private driver interface data
2555 * @params: association parameters
2556 *
2557 * Returns: 0 on success, -1 on failure
2558 */
2559 int (*associate)(void *priv,
2560 struct wpa_driver_associate_params *params);
2561
2562 /**
2563 * add_pmkid - Add PMKSA cache entry to the driver
2564 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002565 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002566 *
2567 * Returns: 0 on success, -1 on failure
2568 *
2569 * This function is called when a new PMK is received, as a result of
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002570 * either normal authentication or RSN pre-authentication. The PMKSA
2571 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2572 * ssid, fils_cache_id, pmkid, and pmk.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002573 *
2574 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2575 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2576 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2577 * driver_ops function does not need to be implemented. Likewise, if
2578 * the driver does not support WPA, this function is not needed.
2579 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002580 int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002581
2582 /**
2583 * remove_pmkid - Remove PMKSA cache entry to the driver
2584 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002585 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002586 *
2587 * Returns: 0 on success, -1 on failure
2588 *
2589 * This function is called when the supplicant drops a PMKSA cache
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002590 * entry for any reason. The PMKSA parameters are either a set of
2591 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002592 *
2593 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2594 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2595 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2596 * from wpa_supplicant, this driver_ops function does not need to be
2597 * implemented. Likewise, if the driver does not support WPA, this
2598 * function is not needed.
2599 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002600 int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002601
2602 /**
2603 * flush_pmkid - Flush PMKSA cache
2604 * @priv: private driver interface data
2605 *
2606 * Returns: 0 on success, -1 on failure
2607 *
2608 * This function is called when the supplicant drops all PMKSA cache
2609 * entries for any reason.
2610 *
2611 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2612 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2613 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2614 * from wpa_supplicant, this driver_ops function does not need to be
2615 * implemented. Likewise, if the driver does not support WPA, this
2616 * function is not needed.
2617 */
2618 int (*flush_pmkid)(void *priv);
2619
2620 /**
2621 * get_capa - Get driver capabilities
2622 * @priv: private driver interface data
2623 *
2624 * Returns: 0 on success, -1 on failure
2625 *
2626 * Get driver/firmware/hardware capabilities.
2627 */
2628 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
2629
2630 /**
2631 * poll - Poll driver for association information
2632 * @priv: private driver interface data
2633 *
2634 * This is an option callback that can be used when the driver does not
2635 * provide event mechanism for association events. This is called when
2636 * receiving WPA EAPOL-Key messages that require association
2637 * information. The driver interface is supposed to generate associnfo
2638 * event before returning from this callback function. In addition, the
2639 * driver interface should generate an association event after having
2640 * sent out associnfo.
2641 */
2642 void (*poll)(void *priv);
2643
2644 /**
Dmitry Shmidte4663042016-04-04 10:07:49 -07002645 * get_ifindex - Get interface index
2646 * @priv: private driver interface data
2647 *
2648 * Returns: Interface index
2649 */
2650 unsigned int (*get_ifindex)(void *priv);
2651
2652 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002653 * get_ifname - Get interface name
2654 * @priv: private driver interface data
2655 *
2656 * Returns: Pointer to the interface name. This can differ from the
2657 * interface name used in init() call. Init() is called first.
2658 *
2659 * This optional function can be used to allow the driver interface to
2660 * replace the interface name with something else, e.g., based on an
2661 * interface mapping from a more descriptive name.
2662 */
2663 const char * (*get_ifname)(void *priv);
2664
2665 /**
2666 * get_mac_addr - Get own MAC address
2667 * @priv: private driver interface data
2668 *
2669 * Returns: Pointer to own MAC address or %NULL on failure
2670 *
2671 * This optional function can be used to get the own MAC address of the
2672 * device from the driver interface code. This is only needed if the
2673 * l2_packet implementation for the OS does not provide easy access to
2674 * a MAC address. */
2675 const u8 * (*get_mac_addr)(void *priv);
2676
2677 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002678 * set_operstate - Sets device operating state to DORMANT or UP
2679 * @priv: private driver interface data
2680 * @state: 0 = dormant, 1 = up
2681 * Returns: 0 on success, -1 on failure
2682 *
2683 * This is an optional function that can be used on operating systems
2684 * that support a concept of controlling network device state from user
2685 * space applications. This function, if set, gets called with
2686 * state = 1 when authentication has been completed and with state = 0
2687 * when connection is lost.
2688 */
2689 int (*set_operstate)(void *priv, int state);
2690
2691 /**
2692 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2693 * @priv: Private driver interface data
2694 * @addr: Address of the station for which to set protection (may be
2695 * %NULL for group keys)
2696 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2697 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2698 * Returns: 0 on success, -1 on failure
2699 *
2700 * This is an optional function that can be used to set the driver to
2701 * require protection for Tx and/or Rx frames. This uses the layer
2702 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2703 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2704 * set protection operation; instead, they set protection implicitly
2705 * based on configured keys.
2706 */
2707 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2708 int key_type);
2709
2710 /**
2711 * get_hw_feature_data - Get hardware support data (channels and rates)
2712 * @priv: Private driver interface data
2713 * @num_modes: Variable for returning the number of returned modes
2714 * flags: Variable for returning hardware feature flags
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002715 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002716 * Returns: Pointer to allocated hardware data on success or %NULL on
2717 * failure. Caller is responsible for freeing this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002718 */
2719 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2720 u16 *num_modes,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002721 u16 *flags, u8 *dfs);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002722
2723 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002724 * send_mlme - Send management frame from MLME
2725 * @priv: Private driver interface data
2726 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2727 * @data_len: Size of the management frame
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002728 * @noack: Do not wait for this frame to be acked (disable retries)
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07002729 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2730 * driver decide
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002731 * @csa_offs: Array of CSA offsets or %NULL
2732 * @csa_offs_len: Number of elements in csa_offs
Hai Shalomfdcde762020-04-02 11:19:20 -07002733 * @no_encrypt: Do not encrypt frame even if appropriate key exists
2734 * (used only for testing purposes)
2735 * @wait: Time to wait off-channel for a response (in ms), or zero
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002736 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002737 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002738 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002739 int noack, unsigned int freq, const u16 *csa_offs,
Hai Shalomfdcde762020-04-02 11:19:20 -07002740 size_t csa_offs_len, int no_encrypt,
2741 unsigned int wait);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002742
2743 /**
2744 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2745 * @priv: Private driver interface data
2746 * @md: Mobility domain (2 octets) (also included inside ies)
2747 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2748 * @ies_len: Length of FT IEs in bytes
2749 * Returns: 0 on success, -1 on failure
2750 *
2751 * The supplicant uses this callback to let the driver know that keying
2752 * material for FT is available and that the driver can use the
2753 * provided IEs in the next message in FT authentication sequence.
2754 *
2755 * This function is only needed for driver that support IEEE 802.11r
2756 * (Fast BSS Transition).
2757 */
2758 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2759 size_t ies_len);
2760
2761 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002762 * get_scan_results2 - Fetch the latest scan results
2763 * @priv: private driver interface data
2764 *
2765 * Returns: Allocated buffer of scan results (caller is responsible for
2766 * freeing the data structure) on success, NULL on failure
2767 */
2768 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2769
2770 /**
2771 * set_country - Set country
2772 * @priv: Private driver interface data
2773 * @alpha2: country to which to switch to
2774 * Returns: 0 on success, -1 on failure
2775 *
2776 * This function is for drivers which support some form
2777 * of setting a regulatory domain.
2778 */
2779 int (*set_country)(void *priv, const char *alpha2);
2780
2781 /**
Dmitry Shmidtcce06662013-11-04 18:44:24 -08002782 * get_country - Get country
2783 * @priv: Private driver interface data
2784 * @alpha2: Buffer for returning country code (at least 3 octets)
2785 * Returns: 0 on success, -1 on failure
2786 */
2787 int (*get_country)(void *priv, char *alpha2);
2788
2789 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002790 * global_init - Global driver initialization
Dmitry Shmidte4663042016-04-04 10:07:49 -07002791 * @ctx: wpa_global pointer
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002792 * Returns: Pointer to private data (global), %NULL on failure
2793 *
2794 * This optional function is called to initialize the driver wrapper
2795 * for global data, i.e., data that applies to all interfaces. If this
2796 * function is implemented, global_deinit() will also need to be
2797 * implemented to free the private data. The driver will also likely
2798 * use init2() function instead of init() to get the pointer to global
2799 * data available to per-interface initializer.
2800 */
Dmitry Shmidte4663042016-04-04 10:07:49 -07002801 void * (*global_init)(void *ctx);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002802
2803 /**
2804 * global_deinit - Global driver deinitialization
2805 * @priv: private driver global data from global_init()
2806 *
2807 * Terminate any global driver related functionality and free the
2808 * global data structure.
2809 */
2810 void (*global_deinit)(void *priv);
2811
2812 /**
2813 * init2 - Initialize driver interface (with global data)
2814 * @ctx: context to be used when calling wpa_supplicant functions,
2815 * e.g., wpa_supplicant_event()
2816 * @ifname: interface name, e.g., wlan0
2817 * @global_priv: private driver global data from global_init()
2818 * Returns: Pointer to private data, %NULL on failure
2819 *
2820 * This function can be used instead of init() if the driver wrapper
2821 * uses global data.
2822 */
2823 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2824
2825 /**
2826 * get_interfaces - Get information about available interfaces
2827 * @global_priv: private driver global data from global_init()
2828 * Returns: Allocated buffer of interface information (caller is
2829 * responsible for freeing the data structure) on success, NULL on
2830 * failure
2831 */
2832 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2833
2834 /**
2835 * scan2 - Request the driver to initiate scan
2836 * @priv: private driver interface data
2837 * @params: Scan parameters
2838 *
2839 * Returns: 0 on success, -1 on failure
2840 *
2841 * Once the scan results are ready, the driver should report scan
2842 * results event for wpa_supplicant which will eventually request the
2843 * results with wpa_driver_get_scan_results2().
2844 */
2845 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2846
2847 /**
2848 * authenticate - Request driver to authenticate
2849 * @priv: private driver interface data
2850 * @params: authentication parameters
2851 * Returns: 0 on success, -1 on failure
2852 *
2853 * This is an optional function that can be used with drivers that
2854 * support separate authentication and association steps, i.e., when
2855 * wpa_supplicant can act as the SME. If not implemented, associate()
2856 * function is expected to take care of IEEE 802.11 authentication,
2857 * too.
2858 */
2859 int (*authenticate)(void *priv,
2860 struct wpa_driver_auth_params *params);
2861
2862 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002863 * set_ap - Set Beacon and Probe Response information for AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002864 * @priv: Private driver interface data
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002865 * @params: Parameters to use in AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002866 *
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002867 * This function is used to configure Beacon template and/or extra IEs
2868 * to add for Beacon and Probe Response frames for the driver in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002869 * AP mode. The driver is responsible for building the full Beacon
2870 * frame by concatenating the head part with TIM IE generated by the
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002871 * driver/firmware and finishing with the tail part. Depending on the
2872 * driver architectue, this can be done either by using the full
2873 * template or the set of additional IEs (e.g., WPS and P2P IE).
2874 * Similarly, Probe Response processing depends on the driver design.
2875 * If the driver (or firmware) takes care of replying to Probe Request
2876 * frames, the extra IEs provided here needs to be added to the Probe
2877 * Response frames.
2878 *
2879 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002880 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002881 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002882
2883 /**
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002884 * set_acl - Set ACL in AP mode
2885 * @priv: Private driver interface data
2886 * @params: Parameters to configure ACL
2887 * Returns: 0 on success, -1 on failure
2888 *
2889 * This is used only for the drivers which support MAC address ACL.
2890 */
2891 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2892
2893 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002894 * hapd_init - Initialize driver interface (hostapd only)
2895 * @hapd: Pointer to hostapd context
2896 * @params: Configuration for the driver wrapper
2897 * Returns: Pointer to private data, %NULL on failure
2898 *
2899 * This function is used instead of init() or init2() when the driver
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002900 * wrapper is used with hostapd.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002901 */
2902 void * (*hapd_init)(struct hostapd_data *hapd,
2903 struct wpa_init_params *params);
2904
2905 /**
2906 * hapd_deinit - Deinitialize driver interface (hostapd only)
2907 * @priv: Private driver interface data from hapd_init()
2908 */
2909 void (*hapd_deinit)(void *priv);
2910
2911 /**
2912 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2913 * @priv: Private driver interface data
2914 * @params: BSS parameters
2915 * Returns: 0 on success, -1 on failure
2916 *
2917 * This is an optional function to configure the kernel driver to
2918 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2919 * can be left undefined (set to %NULL) if IEEE 802.1X support is
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002920 * always enabled and the driver uses set_ap() to set WPA/RSN IE
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002921 * for Beacon frames.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002922 *
2923 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002924 */
2925 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2926
2927 /**
2928 * set_privacy - Enable/disable privacy (AP only)
2929 * @priv: Private driver interface data
2930 * @enabled: 1 = privacy enabled, 0 = disabled
2931 * Returns: 0 on success, -1 on failure
2932 *
2933 * This is an optional function to configure privacy field in the
2934 * kernel driver for Beacon frames. This can be left undefined (set to
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002935 * %NULL) if the driver uses the Beacon template from set_ap().
2936 *
2937 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002938 */
2939 int (*set_privacy)(void *priv, int enabled);
2940
2941 /**
2942 * get_seqnum - Fetch the current TSC/packet number (AP only)
2943 * @ifname: The interface name (main or virtual)
2944 * @priv: Private driver interface data
2945 * @addr: MAC address of the station or %NULL for group keys
2946 * @idx: Key index
2947 * @seq: Buffer for returning the latest used TSC/packet number
2948 * Returns: 0 on success, -1 on failure
2949 *
2950 * This function is used to fetch the last used TSC/packet number for
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002951 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2952 * keys, so there is no strict requirement on implementing support for
2953 * unicast keys (i.e., addr != %NULL).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002954 */
2955 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2956 int idx, u8 *seq);
2957
2958 /**
2959 * flush - Flush all association stations (AP only)
2960 * @priv: Private driver interface data
2961 * Returns: 0 on success, -1 on failure
2962 *
2963 * This function requests the driver to disassociate all associated
2964 * stations. This function does not need to be implemented if the
2965 * driver does not process association frames internally.
2966 */
2967 int (*flush)(void *priv);
2968
2969 /**
2970 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2971 * @priv: Private driver interface data
2972 * @elem: Information elements
2973 * @elem_len: Length of the elem buffer in octets
2974 * Returns: 0 on success, -1 on failure
2975 *
2976 * This is an optional function to add information elements in the
2977 * kernel driver for Beacon and Probe Response frames. This can be left
2978 * undefined (set to %NULL) if the driver uses the Beacon template from
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002979 * set_ap().
2980 *
2981 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002982 */
2983 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2984
2985 /**
Jouni Malinen1e6c57f2012-09-05 17:07:03 +03002986 * read_sta_data - Fetch station data
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002987 * @priv: Private driver interface data
2988 * @data: Buffer for returning station information
2989 * @addr: MAC address of the station
2990 * Returns: 0 on success, -1 on failure
2991 */
2992 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2993 const u8 *addr);
2994
2995 /**
Hai Shalomfdcde762020-04-02 11:19:20 -07002996 * tx_control_port - Send a frame over the 802.1X controlled port
2997 * @priv: Private driver interface data
2998 * @dest: Destination MAC address
2999 * @proto: Ethertype in host byte order
3000 * @buf: Frame payload starting from IEEE 802.1X header
3001 * @len: Frame payload length
3002 * @no_encrypt: Do not encrypt frame
3003 *
3004 * Returns 0 on success, else an error
3005 *
3006 * This is like a normal Ethernet send except that the driver is aware
3007 * (by other means than the Ethertype) that this frame is special,
3008 * and more importantly it gains an ordering between the transmission of
3009 * the frame and other driver management operations such as key
3010 * installations. This can be used to work around known limitations in
3011 * IEEE 802.11 protocols such as race conditions between rekeying 4-way
3012 * handshake message 4/4 and a PTK being overwritten.
3013 *
3014 * This function is only used for a given interface if the driver
3015 * instance reports WPA_DRIVER_FLAGS_CONTROL_PORT capability. Otherwise,
3016 * API users will fall back to sending the frame via a normal socket.
3017 */
3018 int (*tx_control_port)(void *priv, const u8 *dest,
3019 u16 proto, const u8 *buf, size_t len,
3020 int no_encrypt);
3021
3022 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003023 * hapd_send_eapol - Send an EAPOL packet (AP only)
3024 * @priv: private driver interface data
3025 * @addr: Destination MAC address
3026 * @data: EAPOL packet starting with IEEE 802.1X header
3027 * @data_len: Length of the EAPOL packet in octets
3028 * @encrypt: Whether the frame should be encrypted
3029 * @own_addr: Source MAC address
3030 * @flags: WPA_STA_* flags for the destination station
3031 *
3032 * Returns: 0 on success, -1 on failure
3033 */
3034 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
3035 size_t data_len, int encrypt,
3036 const u8 *own_addr, u32 flags);
3037
3038 /**
3039 * sta_deauth - Deauthenticate a station (AP only)
3040 * @priv: Private driver interface data
3041 * @own_addr: Source address and BSSID for the Deauthentication frame
3042 * @addr: MAC address of the station to deauthenticate
3043 * @reason: Reason code for the Deauthentiation frame
3044 * Returns: 0 on success, -1 on failure
3045 *
3046 * This function requests a specific station to be deauthenticated and
3047 * a Deauthentication frame to be sent to it.
3048 */
3049 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07003050 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003051
3052 /**
3053 * sta_disassoc - Disassociate a station (AP only)
3054 * @priv: Private driver interface data
3055 * @own_addr: Source address and BSSID for the Disassociation frame
3056 * @addr: MAC address of the station to disassociate
3057 * @reason: Reason code for the Disassociation frame
3058 * Returns: 0 on success, -1 on failure
3059 *
3060 * This function requests a specific station to be disassociated and
3061 * a Disassociation frame to be sent to it.
3062 */
3063 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07003064 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003065
3066 /**
3067 * sta_remove - Remove a station entry (AP only)
3068 * @priv: Private driver interface data
3069 * @addr: MAC address of the station to be removed
3070 * Returns: 0 on success, -1 on failure
3071 */
3072 int (*sta_remove)(void *priv, const u8 *addr);
3073
3074 /**
3075 * hapd_get_ssid - Get the current SSID (AP only)
3076 * @priv: Private driver interface data
3077 * @buf: Buffer for returning the SSID
3078 * @len: Maximum length of the buffer
3079 * Returns: Length of the SSID on success, -1 on failure
3080 *
3081 * This function need not be implemented if the driver uses Beacon
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003082 * template from set_ap() and does not reply to Probe Request frames.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003083 */
3084 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
3085
3086 /**
3087 * hapd_set_ssid - Set SSID (AP only)
3088 * @priv: Private driver interface data
3089 * @buf: SSID
3090 * @len: Length of the SSID in octets
3091 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003092 *
3093 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003094 */
3095 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
3096
3097 /**
3098 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
3099 * @priv: Private driver interface data
3100 * @enabled: 1 = countermeasures enabled, 0 = disabled
3101 * Returns: 0 on success, -1 on failure
3102 *
3103 * This need not be implemented if the driver does not take care of
3104 * association processing.
3105 */
3106 int (*hapd_set_countermeasures)(void *priv, int enabled);
3107
3108 /**
3109 * sta_add - Add a station entry
3110 * @priv: Private driver interface data
3111 * @params: Station parameters
3112 * Returns: 0 on success, -1 on failure
3113 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08003114 * This function is used to add or set (params->set 1) a station
3115 * entry in the driver. Adding STA entries is used only if the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003116 * does not take care of association processing.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003117 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08003118 * With drivers that don't support full AP client state, this function
3119 * is used to add a station entry to the driver once the station has
3120 * completed association.
3121 *
3122 * With TDLS, this function is used to add or set (params->set 1)
3123 * TDLS peer entries (even with drivers that do not support full AP
3124 * client state).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003125 */
3126 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
3127
3128 /**
3129 * get_inact_sec - Get station inactivity duration (AP only)
3130 * @priv: Private driver interface data
3131 * @addr: Station address
3132 * Returns: Number of seconds station has been inactive, -1 on failure
3133 */
3134 int (*get_inact_sec)(void *priv, const u8 *addr);
3135
3136 /**
3137 * sta_clear_stats - Clear station statistics (AP only)
3138 * @priv: Private driver interface data
3139 * @addr: Station address
3140 * Returns: 0 on success, -1 on failure
3141 */
3142 int (*sta_clear_stats)(void *priv, const u8 *addr);
3143
3144 /**
3145 * set_freq - Set channel/frequency (AP only)
3146 * @priv: Private driver interface data
3147 * @freq: Channel parameters
3148 * Returns: 0 on success, -1 on failure
3149 */
3150 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
3151
3152 /**
3153 * set_rts - Set RTS threshold
3154 * @priv: Private driver interface data
3155 * @rts: RTS threshold in octets
3156 * Returns: 0 on success, -1 on failure
3157 */
3158 int (*set_rts)(void *priv, int rts);
3159
3160 /**
3161 * set_frag - Set fragmentation threshold
3162 * @priv: Private driver interface data
3163 * @frag: Fragmentation threshold in octets
3164 * Returns: 0 on success, -1 on failure
3165 */
3166 int (*set_frag)(void *priv, int frag);
3167
3168 /**
3169 * sta_set_flags - Set station flags (AP only)
3170 * @priv: Private driver interface data
3171 * @addr: Station address
3172 * @total_flags: Bitmap of all WPA_STA_* flags currently set
3173 * @flags_or: Bitmap of WPA_STA_* flags to add
3174 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
3175 * Returns: 0 on success, -1 on failure
3176 */
3177 int (*sta_set_flags)(void *priv, const u8 *addr,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08003178 unsigned int total_flags, unsigned int flags_or,
3179 unsigned int flags_and);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003180
3181 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07003182 * sta_set_airtime_weight - Set station airtime weight (AP only)
3183 * @priv: Private driver interface data
3184 * @addr: Station address
3185 * @weight: New weight for station airtime assignment
3186 * Returns: 0 on success, -1 on failure
3187 */
3188 int (*sta_set_airtime_weight)(void *priv, const u8 *addr,
3189 unsigned int weight);
3190
3191 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003192 * set_tx_queue_params - Set TX queue parameters
3193 * @priv: Private driver interface data
3194 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
3195 * @aifs: AIFS
3196 * @cw_min: cwMin
3197 * @cw_max: cwMax
3198 * @burst_time: Maximum length for bursting in 0.1 msec units
3199 */
3200 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
3201 int cw_max, int burst_time);
3202
3203 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003204 * if_add - Add a virtual interface
3205 * @priv: Private driver interface data
3206 * @type: Interface type
3207 * @ifname: Interface name for the new virtual interface
3208 * @addr: Local address to use for the interface or %NULL to use the
3209 * parent interface address
3210 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
3211 * @drv_priv: Pointer for overwriting the driver context or %NULL if
3212 * not allowed (applies only to %WPA_IF_AP_BSS type)
3213 * @force_ifname: Buffer for returning an interface name that the
3214 * driver ended up using if it differs from the requested ifname
3215 * @if_addr: Buffer for returning the allocated interface address
3216 * (this may differ from the requested addr if the driver cannot
3217 * change interface address)
3218 * @bridge: Bridge interface to use or %NULL if no bridge configured
Dmitry Shmidtcce06662013-11-04 18:44:24 -08003219 * @use_existing: Whether to allow existing interface to be used
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003220 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003221 * Returns: 0 on success, -1 on failure
3222 */
3223 int (*if_add)(void *priv, enum wpa_driver_if_type type,
3224 const char *ifname, const u8 *addr, void *bss_ctx,
3225 void **drv_priv, char *force_ifname, u8 *if_addr,
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003226 const char *bridge, int use_existing, int setup_ap);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003227
3228 /**
3229 * if_remove - Remove a virtual interface
3230 * @priv: Private driver interface data
3231 * @type: Interface type
3232 * @ifname: Interface name of the virtual interface to be removed
3233 * Returns: 0 on success, -1 on failure
3234 */
3235 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
3236 const char *ifname);
3237
3238 /**
3239 * set_sta_vlan - Bind a station into a specific interface (AP only)
3240 * @priv: Private driver interface data
3241 * @ifname: Interface (main or virtual BSS or VLAN)
3242 * @addr: MAC address of the associated station
3243 * @vlan_id: VLAN ID
3244 * Returns: 0 on success, -1 on failure
3245 *
3246 * This function is used to bind a station to a specific virtual
3247 * interface. It is only used if when virtual interfaces are supported,
3248 * e.g., to assign stations to different VLAN interfaces based on
3249 * information from a RADIUS server. This allows separate broadcast
3250 * domains to be used with a single BSS.
3251 */
3252 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
3253 int vlan_id);
3254
3255 /**
3256 * commit - Optional commit changes handler (AP only)
3257 * @priv: driver private data
3258 * Returns: 0 on success, -1 on failure
3259 *
3260 * This optional handler function can be registered if the driver
3261 * interface implementation needs to commit changes (e.g., by setting
3262 * network interface up) at the end of initial configuration. If set,
3263 * this handler will be called after initial setup has been completed.
3264 */
3265 int (*commit)(void *priv);
3266
3267 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003268 * set_radius_acl_auth - Notification of RADIUS ACL change
3269 * @priv: Private driver interface data
3270 * @mac: MAC address of the station
3271 * @accepted: Whether the station was accepted
3272 * @session_timeout: Session timeout for the station
3273 * Returns: 0 on success, -1 on failure
3274 */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003275 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003276 u32 session_timeout);
3277
3278 /**
3279 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3280 * @priv: Private driver interface data
3281 * @mac: MAC address of the station
3282 * Returns: 0 on success, -1 on failure
3283 */
3284 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
3285
3286 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003287 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
3288 * @priv: Private driver interface data
3289 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3290 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3291 * extra IE(s)
3292 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3293 * to remove extra IE(s)
3294 * Returns: 0 on success, -1 on failure
3295 *
3296 * This is an optional function to add WPS IE in the kernel driver for
3297 * Beacon and Probe Response frames. This can be left undefined (set
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003298 * to %NULL) if the driver uses the Beacon template from set_ap()
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003299 * and does not process Probe Request frames. If the driver takes care
3300 * of (Re)Association frame processing, the assocresp buffer includes
3301 * WPS IE(s) that need to be added to (Re)Association Response frames
3302 * whenever a (Re)Association Request frame indicated use of WPS.
3303 *
3304 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3305 * frames when operating as a GO. The driver is responsible for adding
3306 * timing related attributes (e.g., NoA) in addition to the IEs
3307 * included here by appending them after these buffers. This call is
3308 * also used to provide Probe Response IEs for P2P Listen state
3309 * operations for drivers that generate the Probe Response frames
3310 * internally.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003311 *
3312 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003313 */
3314 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
3315 const struct wpabuf *proberesp,
3316 const struct wpabuf *assocresp);
3317
3318 /**
3319 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3320 * @priv: Private driver interface data
3321 * @authorized: Whether the port is authorized
3322 * Returns: 0 on success, -1 on failure
3323 */
3324 int (*set_supp_port)(void *priv, int authorized);
3325
3326 /**
3327 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3328 * @priv: Private driver interface data
3329 * @addr: MAC address of the associated station
3330 * @aid: Association ID
3331 * @val: 1 = bind to 4-address WDS; 0 = unbind
3332 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3333 * to indicate that bridge is not to be used
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07003334 * @ifname_wds: Buffer to return the interface name for the new WDS
3335 * station or %NULL to indicate name is not returned.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003336 * Returns: 0 on success, -1 on failure
3337 */
3338 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003339 const char *bridge_ifname, char *ifname_wds);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003340
3341 /**
3342 * send_action - Transmit an Action frame
3343 * @priv: Private driver interface data
3344 * @freq: Frequency (in MHz) of the channel
3345 * @wait: Time to wait off-channel for a response (in ms), or zero
3346 * @dst: Destination MAC address (Address 1)
3347 * @src: Source MAC address (Address 2)
3348 * @bssid: BSSID (Address 3)
3349 * @data: Frame body
3350 * @data_len: data length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003351 @ @no_cck: Whether CCK rates must not be used to transmit this frame
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003352 * Returns: 0 on success, -1 on failure
3353 *
3354 * This command can be used to request the driver to transmit an action
3355 * frame to the specified destination.
3356 *
3357 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3358 * be transmitted on the given channel and the device will wait for a
3359 * response on that channel for the given wait time.
3360 *
3361 * If the flag is not set, the wait time will be ignored. In this case,
3362 * if a remain-on-channel duration is in progress, the frame must be
3363 * transmitted on that channel; alternatively the frame may be sent on
3364 * the current operational channel (if in associated state in station
3365 * mode or while operating as an AP.)
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08003366 *
3367 * If @src differs from the device MAC address, use of a random
3368 * transmitter address is requested for this message exchange.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003369 */
3370 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
3371 const u8 *dst, const u8 *src, const u8 *bssid,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003372 const u8 *data, size_t data_len, int no_cck);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003373
3374 /**
3375 * send_action_cancel_wait - Cancel action frame TX wait
3376 * @priv: Private driver interface data
3377 *
3378 * This command cancels the wait time associated with sending an action
3379 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3380 * set in the driver flags.
3381 */
3382 void (*send_action_cancel_wait)(void *priv);
3383
3384 /**
3385 * remain_on_channel - Remain awake on a channel
3386 * @priv: Private driver interface data
3387 * @freq: Frequency (in MHz) of the channel
3388 * @duration: Duration in milliseconds
3389 * Returns: 0 on success, -1 on failure
3390 *
3391 * This command is used to request the driver to remain awake on the
3392 * specified channel for the specified duration and report received
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08003393 * Action frames with EVENT_RX_MGMT events. Optionally, received
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003394 * Probe Request frames may also be requested to be reported by calling
3395 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3396 *
3397 * The driver may not be at the requested channel when this function
3398 * returns, i.e., the return code is only indicating whether the
3399 * request was accepted. The caller will need to wait until the
3400 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3401 * completed the channel change. This may take some time due to other
3402 * need for the radio and the caller should be prepared to timing out
3403 * its wait since there are no guarantees on when this request can be
3404 * executed.
3405 */
3406 int (*remain_on_channel)(void *priv, unsigned int freq,
3407 unsigned int duration);
3408
3409 /**
3410 * cancel_remain_on_channel - Cancel remain-on-channel operation
3411 * @priv: Private driver interface data
3412 *
3413 * This command can be used to cancel a remain-on-channel operation
3414 * before its originally requested duration has passed. This could be
3415 * used, e.g., when remain_on_channel() is used to request extra time
3416 * to receive a response to an Action frame and the response is
3417 * received when there is still unneeded time remaining on the
3418 * remain-on-channel operation.
3419 */
3420 int (*cancel_remain_on_channel)(void *priv);
3421
3422 /**
3423 * probe_req_report - Request Probe Request frames to be indicated
3424 * @priv: Private driver interface data
3425 * @report: Whether to report received Probe Request frames
3426 * Returns: 0 on success, -1 on failure (or if not supported)
3427 *
3428 * This command can be used to request the driver to indicate when
3429 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3430 * Since this operation may require extra resources, e.g., due to less
3431 * optimal hardware/firmware RX filtering, many drivers may disable
3432 * Probe Request reporting at least in station mode. This command is
3433 * used to notify the driver when the Probe Request frames need to be
3434 * reported, e.g., during remain-on-channel operations.
3435 */
3436 int (*probe_req_report)(void *priv, int report);
3437
3438 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003439 * deinit_ap - Deinitialize AP mode
3440 * @priv: Private driver interface data
3441 * Returns: 0 on success, -1 on failure (or if not supported)
3442 *
3443 * This optional function can be used to disable AP mode related
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003444 * configuration. If the interface was not dynamically added,
3445 * change the driver mode to station mode to allow normal station
3446 * operations like scanning to be completed.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003447 */
3448 int (*deinit_ap)(void *priv);
3449
3450 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003451 * deinit_p2p_cli - Deinitialize P2P client mode
3452 * @priv: Private driver interface data
3453 * Returns: 0 on success, -1 on failure (or if not supported)
3454 *
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003455 * This optional function can be used to disable P2P client mode. If the
3456 * interface was not dynamically added, change the interface type back
3457 * to station mode.
Dmitry Shmidt04949592012-07-19 12:16:46 -07003458 */
3459 int (*deinit_p2p_cli)(void *priv);
3460
3461 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003462 * suspend - Notification on system suspend/hibernate event
3463 * @priv: Private driver interface data
3464 */
3465 void (*suspend)(void *priv);
3466
3467 /**
3468 * resume - Notification on system resume/thaw event
3469 * @priv: Private driver interface data
3470 */
3471 void (*resume)(void *priv);
3472
3473 /**
3474 * signal_monitor - Set signal monitoring parameters
3475 * @priv: Private driver interface data
3476 * @threshold: Threshold value for signal change events; 0 = disabled
3477 * @hysteresis: Minimum change in signal strength before indicating a
3478 * new event
3479 * Returns: 0 on success, -1 on failure (or if not supported)
3480 *
3481 * This function can be used to configure monitoring of signal strength
3482 * with the current AP. Whenever signal strength drops below the
3483 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3484 * should be generated assuming the signal strength has changed at
3485 * least %hysteresis from the previously indicated signal change event.
3486 */
3487 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
3488
3489 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003490 * get_noa - Get current Notice of Absence attribute payload
3491 * @priv: Private driver interface data
3492 * @buf: Buffer for returning NoA
3493 * @buf_len: Buffer length in octets
3494 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3495 * advertized, or -1 on failure
3496 *
3497 * This function is used to fetch the current Notice of Absence
3498 * attribute value from GO.
3499 */
3500 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
3501
3502 /**
3503 * set_noa - Set Notice of Absence parameters for GO (testing)
3504 * @priv: Private driver interface data
3505 * @count: Count
3506 * @start: Start time in ms from next TBTT
3507 * @duration: Duration in ms
3508 * Returns: 0 on success or -1 on failure
3509 *
3510 * This function is used to set Notice of Absence parameters for GO. It
3511 * is used only for testing. To disable NoA, all parameters are set to
3512 * 0.
3513 */
3514 int (*set_noa)(void *priv, u8 count, int start, int duration);
3515
3516 /**
3517 * set_p2p_powersave - Set P2P power save options
3518 * @priv: Private driver interface data
3519 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3520 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3521 * @ctwindow: 0.. = change (msec), -1 = no change
3522 * Returns: 0 on success or -1 on failure
3523 */
3524 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
3525 int ctwindow);
3526
3527 /**
3528 * ampdu - Enable/disable aggregation
3529 * @priv: Private driver interface data
3530 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3531 * Returns: 0 on success or -1 on failure
3532 */
3533 int (*ampdu)(void *priv, int ampdu);
3534
3535 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003536 * get_radio_name - Get physical radio name for the device
3537 * @priv: Private driver interface data
3538 * Returns: Radio name or %NULL if not known
3539 *
3540 * The returned data must not be modified by the caller. It is assumed
3541 * that any interface that has the same radio name as another is
3542 * sharing the same physical radio. This information can be used to
3543 * share scan results etc. information between the virtual interfaces
3544 * to speed up various operations.
3545 */
3546 const char * (*get_radio_name)(void *priv);
3547
3548 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003549 * send_tdls_mgmt - for sending TDLS management packets
3550 * @priv: private driver interface data
3551 * @dst: Destination (peer) MAC address
3552 * @action_code: TDLS action code for the mssage
3553 * @dialog_token: Dialog Token to use in the message (if needed)
3554 * @status_code: Status Code or Reason Code to use (if needed)
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003555 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003556 * @initiator: Is the current end the TDLS link initiator
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003557 * @buf: TDLS IEs to add to the message
3558 * @len: Length of buf in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003559 * Returns: 0 on success, negative (<0) on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003560 *
3561 * This optional function can be used to send packet to driver which is
3562 * responsible for receiving and sending all TDLS packets.
3563 */
3564 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003565 u8 dialog_token, u16 status_code, u32 peer_capab,
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003566 int initiator, const u8 *buf, size_t len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003567
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003568 /**
3569 * tdls_oper - Ask the driver to perform high-level TDLS operations
3570 * @priv: Private driver interface data
3571 * @oper: TDLS high-level operation. See %enum tdls_oper
3572 * @peer: Destination (peer) MAC address
3573 * Returns: 0 on success, negative (<0) on failure
3574 *
3575 * This optional function can be used to send high-level TDLS commands
3576 * to the driver.
3577 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003578 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
3579
3580 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07003581 * wnm_oper - Notify driver of the WNM frame reception
3582 * @priv: Private driver interface data
3583 * @oper: WNM operation. See %enum wnm_oper
3584 * @peer: Destination (peer) MAC address
3585 * @buf: Buffer for the driver to fill in (for getting IE)
3586 * @buf_len: Return the len of buf
3587 * Returns: 0 on success, negative (<0) on failure
3588 */
3589 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
3590 u8 *buf, u16 *buf_len);
3591
3592 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -07003593 * set_qos_map - Set QoS Map
3594 * @priv: Private driver interface data
3595 * @qos_map_set: QoS Map
3596 * @qos_map_set_len: Length of QoS Map
3597 */
3598 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
3599 u8 qos_map_set_len);
3600
3601 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003602 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3603 * @priv: Private driver interface data
3604 * @version: IP version of the IP address, 4 or 6
3605 * @ipaddr: IP address for the neigh entry
3606 * @prefixlen: IP address prefix length
3607 * @addr: Corresponding MAC address
3608 * Returns: 0 on success, negative (<0) on failure
3609 */
3610 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
3611 int prefixlen, const u8 *addr);
3612
3613 /**
3614 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3615 * @priv: Private driver interface data
3616 * @version: IP version of the IP address, 4 or 6
3617 * @ipaddr: IP address for the neigh entry
3618 * Returns: 0 on success, negative (<0) on failure
3619 */
3620 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
3621
3622 /**
3623 * br_port_set_attr - Set a bridge port attribute
3624 * @attr: Bridge port attribute to set
3625 * @val: Value to be set
3626 * Returns: 0 on success, negative (<0) on failure
3627 */
3628 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
3629 unsigned int val);
3630
3631 /**
3632 * br_port_set_attr - Set a bridge network parameter
3633 * @param: Bridge parameter to set
3634 * @val: Value to be set
3635 * Returns: 0 on success, negative (<0) on failure
3636 */
3637 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
3638 unsigned int val);
3639
3640 /**
Hai Shalomfdcde762020-04-02 11:19:20 -07003641 * get_wowlan - Get wake-on-wireless status
3642 * @priv: Private driver interface data
3643 */
3644 int (*get_wowlan)(void *priv);
3645
3646 /**
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07003647 * set_wowlan - Set wake-on-wireless triggers
3648 * @priv: Private driver interface data
3649 * @triggers: wowlan triggers
3650 */
3651 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
3652
3653 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003654 * signal_poll - Get current connection information
3655 * @priv: Private driver interface data
3656 * @signal_info: Connection info structure
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003657 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003658 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003659
3660 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08003661 * channel_info - Get parameters of the current operating channel
3662 * @priv: Private driver interface data
3663 * @channel_info: Channel info structure
3664 * Returns: 0 on success, negative (<0) on failure
3665 */
3666 int (*channel_info)(void *priv, struct wpa_channel_info *channel_info);
3667
3668 /**
Jouni Malinen75ecf522011-06-27 15:19:46 -07003669 * set_authmode - Set authentication algorithm(s) for static WEP
3670 * @priv: Private driver interface data
3671 * @authmode: 1=Open System, 2=Shared Key, 3=both
3672 * Returns: 0 on success, -1 on failure
3673 *
3674 * This function can be used to set authentication algorithms for AP
3675 * mode when static WEP is used. If the driver uses user space MLME/SME
3676 * implementation, there is no need to implement this function.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003677 *
3678 * DEPRECATED - use set_ap() instead
Jouni Malinen75ecf522011-06-27 15:19:46 -07003679 */
3680 int (*set_authmode)(void *priv, int authmode);
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003681
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003682#ifdef ANDROID
Jouni Malinen75ecf522011-06-27 15:19:46 -07003683 /**
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003684 * driver_cmd - Execute driver-specific command
3685 * @priv: Private driver interface data
3686 * @cmd: Command to execute
3687 * @buf: Return buffer
3688 * @buf_len: Buffer length
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003689 * Returns: 0 on success, -1 on failure
3690 */
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003691 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
3692#endif /* ANDROID */
3693
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003694 /**
Dmitry Shmidta38abf92014-03-06 13:38:44 -08003695 * vendor_cmd - Execute vendor specific command
3696 * @priv: Private driver interface data
3697 * @vendor_id: Vendor id
3698 * @subcmd: Vendor command id
3699 * @data: Vendor command parameters (%NULL if no parameters)
3700 * @data_len: Data length
3701 * @buf: Return buffer (%NULL to ignore reply)
3702 * Returns: 0 on success, negative (<0) on failure
3703 *
3704 * This function handles vendor specific commands that are passed to
3705 * the driver/device. The command is identified by vendor id and
3706 * command id. Parameters can be passed as argument to the command
3707 * in the data buffer. Reply (if any) will be filled in the supplied
3708 * return buffer.
3709 *
3710 * The exact driver behavior is driver interface and vendor specific. As
3711 * an example, this will be converted to a vendor specific cfg80211
3712 * command in case of the nl80211 driver interface.
3713 */
3714 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3715 unsigned int subcmd, const u8 *data, size_t data_len,
3716 struct wpabuf *buf);
3717
3718 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003719 * set_rekey_info - Set rekey information
3720 * @priv: Private driver interface data
3721 * @kek: Current KEK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003722 * @kek_len: KEK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003723 * @kck: Current KCK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003724 * @kck_len: KCK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003725 * @replay_ctr: Current EAPOL-Key Replay Counter
3726 *
3727 * This optional function can be used to provide information for the
3728 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3729 * while the host (including wpa_supplicant) is sleeping.
3730 */
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003731 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3732 const u8 *kck, size_t kck_len,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003733 const u8 *replay_ctr);
3734
3735 /**
3736 * sta_assoc - Station association indication
3737 * @priv: Private driver interface data
3738 * @own_addr: Source address and BSSID for association frame
3739 * @addr: MAC address of the station to associate
3740 * @reassoc: flag to indicate re-association
3741 * @status: association response status code
3742 * @ie: assoc response ie buffer
3743 * @len: ie buffer length
3744 * Returns: 0 on success, -1 on failure
3745 *
3746 * This function indicates the driver to send (Re)Association
3747 * Response frame to the station.
3748 */
3749 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3750 int reassoc, u16 status, const u8 *ie, size_t len);
3751
3752 /**
3753 * sta_auth - Station authentication indication
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003754 * @priv: private driver interface data
3755 * @params: Station authentication parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003756 *
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003757 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003758 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003759 int (*sta_auth)(void *priv,
3760 struct wpa_driver_sta_auth_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003761
3762 /**
3763 * add_tspec - Add traffic stream
3764 * @priv: Private driver interface data
3765 * @addr: MAC address of the station to associate
3766 * @tspec_ie: tspec ie buffer
3767 * @tspec_ielen: tspec ie length
3768 * Returns: 0 on success, -1 on failure
3769 *
3770 * This function adds the traffic steam for the station
3771 * and fills the medium_time in tspec_ie.
3772 */
3773 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3774 size_t tspec_ielen);
3775
3776 /**
3777 * add_sta_node - Add a station node in the driver
3778 * @priv: Private driver interface data
3779 * @addr: MAC address of the station to add
3780 * @auth_alg: authentication algorithm used by the station
3781 * Returns: 0 on success, -1 on failure
3782 *
3783 * This function adds the station node in the driver, when
3784 * the station gets added by FT-over-DS.
3785 */
3786 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
3787
3788 /**
3789 * sched_scan - Request the driver to initiate scheduled scan
3790 * @priv: Private driver interface data
3791 * @params: Scan parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003792 * Returns: 0 on success, -1 on failure
3793 *
3794 * This operation should be used for scheduled scan offload to
3795 * the hardware. Every time scan results are available, the
3796 * driver should report scan results event for wpa_supplicant
3797 * which will eventually request the results with
3798 * wpa_driver_get_scan_results2(). This operation is optional
3799 * and if not provided or if it returns -1, we fall back to
3800 * normal host-scheduled scans.
3801 */
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003802 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003803
3804 /**
3805 * stop_sched_scan - Request the driver to stop a scheduled scan
3806 * @priv: Private driver interface data
3807 * Returns: 0 on success, -1 on failure
3808 *
3809 * This should cause the scheduled scan to be stopped and
3810 * results should stop being sent. Must be supported if
3811 * sched_scan is supported.
3812 */
3813 int (*stop_sched_scan)(void *priv);
3814
3815 /**
3816 * poll_client - Probe (null data or such) the given station
3817 * @priv: Private driver interface data
3818 * @own_addr: MAC address of sending interface
3819 * @addr: MAC address of the station to probe
3820 * @qos: Indicates whether station is QoS station
3821 *
3822 * This function is used to verify whether an associated station is
3823 * still present. This function does not need to be implemented if the
3824 * driver provides such inactivity polling mechanism.
3825 */
3826 void (*poll_client)(void *priv, const u8 *own_addr,
3827 const u8 *addr, int qos);
Dmitry Shmidt04949592012-07-19 12:16:46 -07003828
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003829 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003830 * radio_disable - Disable/enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003831 * @priv: Private driver interface data
Dmitry Shmidt04949592012-07-19 12:16:46 -07003832 * @disabled: 1=disable 0=enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003833 * Returns: 0 on success, -1 on failure
3834 *
Dmitry Shmidt04949592012-07-19 12:16:46 -07003835 * This optional command is for testing purposes. It can be used to
3836 * disable the radio on a testbed device to simulate out-of-radio-range
3837 * conditions.
3838 */
3839 int (*radio_disable)(void *priv, int disabled);
3840
3841 /**
3842 * switch_channel - Announce channel switch and migrate the GO to the
3843 * given frequency
3844 * @priv: Private driver interface data
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003845 * @settings: Settings for CSA period and new channel
Dmitry Shmidt04949592012-07-19 12:16:46 -07003846 * Returns: 0 on success, -1 on failure
3847 *
3848 * This function is used to move the GO to the legacy STA channel to
3849 * avoid frequency conflict in single channel concurrency.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003850 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003851 int (*switch_channel)(void *priv, struct csa_settings *settings);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003852
3853 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003854 * add_tx_ts - Add traffic stream
3855 * @priv: Private driver interface data
3856 * @tsid: Traffic stream ID
3857 * @addr: Receiver address
3858 * @user_prio: User priority of the traffic stream
3859 * @admitted_time: Admitted time for this TS in units of
3860 * 32 microsecond periods (per second).
3861 * Returns: 0 on success, -1 on failure
3862 */
3863 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3864 u16 admitted_time);
3865
3866 /**
3867 * del_tx_ts - Delete traffic stream
3868 * @priv: Private driver interface data
3869 * @tsid: Traffic stream ID
3870 * @addr: Receiver address
3871 * Returns: 0 on success, -1 on failure
3872 */
3873 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3874
3875 /**
3876 * Enable channel-switching with TDLS peer
3877 * @priv: Private driver interface data
3878 * @addr: MAC address of the TDLS peer
3879 * @oper_class: Operating class of the switch channel
3880 * @params: Channel specification
3881 * Returns: 0 on success, -1 on failure
3882 *
3883 * The function indicates to driver that it can start switching to a
3884 * different channel with a specified TDLS peer. The switching is
3885 * assumed on until canceled with tdls_disable_channel_switch().
3886 */
3887 int (*tdls_enable_channel_switch)(
3888 void *priv, const u8 *addr, u8 oper_class,
3889 const struct hostapd_freq_params *params);
3890
3891 /**
3892 * Disable channel switching with TDLS peer
3893 * @priv: Private driver interface data
3894 * @addr: MAC address of the TDLS peer
3895 * Returns: 0 on success, -1 on failure
3896 *
3897 * This function indicates to the driver that it should stop switching
3898 * with a given TDLS peer.
3899 */
3900 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3901
3902 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003903 * start_dfs_cac - Listen for radar interference on the channel
3904 * @priv: Private driver interface data
Dmitry Shmidt051af732013-10-22 13:52:46 -07003905 * @freq: Channel parameters
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003906 * Returns: 0 on success, -1 on failure
3907 */
Dmitry Shmidt051af732013-10-22 13:52:46 -07003908 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003909
3910 /**
3911 * stop_ap - Removes beacon from AP
3912 * @priv: Private driver interface data
3913 * Returns: 0 on success, -1 on failure (or if not supported)
3914 *
3915 * This optional function can be used to disable AP mode related
3916 * configuration. Unlike deinit_ap, it does not change to station
3917 * mode.
3918 */
3919 int (*stop_ap)(void *priv);
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003920
3921 /**
3922 * get_survey - Retrieve survey data
3923 * @priv: Private driver interface data
3924 * @freq: If set, survey data for the specified frequency is only
3925 * being requested. If not set, all survey data is requested.
3926 * Returns: 0 on success, -1 on failure
3927 *
3928 * Use this to retrieve:
3929 *
3930 * - the observed channel noise floor
3931 * - the amount of time we have spent on the channel
3932 * - the amount of time during which we have spent on the channel that
3933 * the radio has determined the medium is busy and we cannot
3934 * transmit
3935 * - the amount of time we have spent receiving data
3936 * - the amount of time we have spent transmitting data
3937 *
3938 * This data can be used for spectrum heuristics. One example is
3939 * Automatic Channel Selection (ACS). The channel survey data is
3940 * kept on a linked list on the channel data, one entry is added
3941 * for each survey. The min_nf of the channel is updated for each
3942 * survey.
3943 */
3944 int (*get_survey)(void *priv, unsigned int freq);
Dmitry Shmidt56052862013-10-04 10:23:25 -07003945
3946 /**
3947 * status - Get driver interface status information
3948 * @priv: Private driver interface data
Hai Shalom74f70d42019-02-11 14:42:39 -08003949 * @buf: Buffer for printing the status information
Dmitry Shmidt56052862013-10-04 10:23:25 -07003950 * @buflen: Maximum length of the buffer
3951 * Returns: Length of written status information or -1 on failure
3952 */
3953 int (*status)(void *priv, char *buf, size_t buflen);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003954
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07003955 /**
3956 * roaming - Set roaming policy for driver-based BSS selection
3957 * @priv: Private driver interface data
3958 * @allowed: Whether roaming within ESS is allowed
3959 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3960 * Returns: Length of written status information or -1 on failure
3961 *
3962 * This optional callback can be used to update roaming policy from the
3963 * associate() command (bssid being set there indicates that the driver
3964 * should not roam before getting this roaming() call to allow roaming.
3965 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3966 * capability, roaming policy is handled within wpa_supplicant and there
3967 * is no need to implement or react to this callback.
3968 */
3969 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3970
3971 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -07003972 * disable_fils - Enable/disable FILS feature
3973 * @priv: Private driver interface data
3974 * @disable: 0-enable and 1-disable FILS feature
3975 * Returns: 0 on success, -1 on failure
3976 *
3977 * This callback can be used to configure driver and below layers to
3978 * enable/disable all FILS features.
3979 */
3980 int (*disable_fils)(void *priv, int disable);
3981
3982 /**
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07003983 * set_mac_addr - Set MAC address
3984 * @priv: Private driver interface data
3985 * @addr: MAC address to use or %NULL for setting back to permanent
3986 * Returns: 0 on success, -1 on failure
3987 */
3988 int (*set_mac_addr)(void *priv, const u8 *addr);
3989
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003990#ifdef CONFIG_MACSEC
3991 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3992
3993 int (*macsec_deinit)(void *priv);
3994
3995 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003996 * macsec_get_capability - Inform MKA of this driver's capability
3997 * @priv: Private driver interface data
3998 * @cap: Driver's capability
3999 * Returns: 0 on success, -1 on failure
4000 */
4001 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);
4002
4003 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004004 * enable_protect_frames - Set protect frames status
4005 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004006 * @enabled: true = protect frames enabled
4007 * false = protect frames disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004008 * Returns: 0 on success, -1 on failure (or if not supported)
4009 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004010 int (*enable_protect_frames)(void *priv, bool enabled);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004011
4012 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004013 * enable_encrypt - Set encryption status
4014 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004015 * @enabled: true = encrypt outgoing traffic
4016 * false = integrity-only protection on outgoing traffic
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004017 * Returns: 0 on success, -1 on failure (or if not supported)
4018 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004019 int (*enable_encrypt)(void *priv, bool enabled);
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004020
4021 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004022 * set_replay_protect - Set replay protect status and window size
4023 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004024 * @enabled: true = replay protect enabled
4025 * false = replay protect disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004026 * @window: replay window size, valid only when replay protect enabled
4027 * Returns: 0 on success, -1 on failure (or if not supported)
4028 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004029 int (*set_replay_protect)(void *priv, bool enabled, u32 window);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004030
4031 /**
4032 * set_current_cipher_suite - Set current cipher suite
4033 * @priv: Private driver interface data
4034 * @cs: EUI64 identifier
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004035 * Returns: 0 on success, -1 on failure (or if not supported)
4036 */
Dmitry Shmidt7d175302016-09-06 13:11:34 -07004037 int (*set_current_cipher_suite)(void *priv, u64 cs);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004038
4039 /**
4040 * enable_controlled_port - Set controlled port status
4041 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004042 * @enabled: true = controlled port enabled
4043 * false = controlled port disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004044 * Returns: 0 on success, -1 on failure (or if not supported)
4045 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004046 int (*enable_controlled_port)(void *priv, bool enabled);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004047
4048 /**
4049 * get_receive_lowest_pn - Get receive lowest pn
4050 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004051 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004052 * Returns: 0 on success, -1 on failure (or if not supported)
4053 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004054 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004055
4056 /**
4057 * get_transmit_next_pn - Get transmit next pn
4058 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004059 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004060 * Returns: 0 on success, -1 on failure (or if not supported)
4061 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004062 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004063
4064 /**
4065 * set_transmit_next_pn - Set transmit next pn
4066 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004067 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004068 * Returns: 0 on success, -1 on failure (or if not supported)
4069 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004070 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004071
4072 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08004073 * set_receive_lowest_pn - Set receive lowest PN
4074 * @priv: Private driver interface data
4075 * @sa: secure association
4076 * Returns: 0 on success, -1 on failure (or if not supported)
4077 */
4078 int (*set_receive_lowest_pn)(void *priv, struct receive_sa *sa);
4079
4080 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004081 * create_receive_sc - create secure channel for receiving
4082 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004083 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004084 * @conf_offset: confidentiality offset (0, 30, or 50)
4085 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
4086 * 2 = Strict)
4087 * Returns: 0 on success, -1 on failure (or if not supported)
4088 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004089 int (*create_receive_sc)(void *priv, struct receive_sc *sc,
4090 unsigned int conf_offset,
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004091 int validation);
4092
4093 /**
4094 * delete_receive_sc - delete secure connection for receiving
4095 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004096 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004097 * Returns: 0 on success, -1 on failure
4098 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004099 int (*delete_receive_sc)(void *priv, struct receive_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004100
4101 /**
4102 * create_receive_sa - create secure association for receive
4103 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004104 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004105 * Returns: 0 on success, -1 on failure
4106 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004107 int (*create_receive_sa)(void *priv, struct receive_sa *sa);
4108
4109 /**
4110 * delete_receive_sa - Delete secure association for receive
4111 * @priv: Private driver interface data from init()
4112 * @sa: Secure association
4113 * Returns: 0 on success, -1 on failure
4114 */
4115 int (*delete_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004116
4117 /**
4118 * enable_receive_sa - enable the SA for receive
4119 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004120 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004121 * Returns: 0 on success, -1 on failure
4122 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004123 int (*enable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004124
4125 /**
4126 * disable_receive_sa - disable SA for receive
4127 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004128 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004129 * Returns: 0 on success, -1 on failure
4130 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004131 int (*disable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004132
4133 /**
4134 * create_transmit_sc - create secure connection for transmit
4135 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004136 * @sc: secure channel
4137 * @conf_offset: confidentiality offset (0, 30, or 50)
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004138 * Returns: 0 on success, -1 on failure
4139 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004140 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
4141 unsigned int conf_offset);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004142
4143 /**
4144 * delete_transmit_sc - delete secure connection for transmit
4145 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004146 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004147 * Returns: 0 on success, -1 on failure
4148 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004149 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004150
4151 /**
4152 * create_transmit_sa - create secure association for transmit
4153 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004154 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004155 * Returns: 0 on success, -1 on failure
4156 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004157 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);
4158
4159 /**
4160 * delete_transmit_sa - Delete secure association for transmit
4161 * @priv: Private driver interface data from init()
4162 * @sa: Secure association
4163 * Returns: 0 on success, -1 on failure
4164 */
4165 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004166
4167 /**
4168 * enable_transmit_sa - enable SA for transmit
4169 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004170 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004171 * Returns: 0 on success, -1 on failure
4172 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004173 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004174
4175 /**
4176 * disable_transmit_sa - disable SA for transmit
4177 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004178 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004179 * Returns: 0 on success, -1 on failure
4180 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004181 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004182#endif /* CONFIG_MACSEC */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004183
4184 /**
4185 * init_mesh - Driver specific initialization for mesh
4186 * @priv: Private driver interface data
4187 * Returns: 0 on success, -1 on failure
4188 */
4189 int (*init_mesh)(void *priv);
4190
4191 /**
4192 * join_mesh - Join a mesh network
4193 * @priv: Private driver interface data
4194 * @params: Mesh configuration parameters
4195 * Returns: 0 on success, -1 on failure
4196 */
4197 int (*join_mesh)(void *priv,
4198 struct wpa_driver_mesh_join_params *params);
4199
4200 /**
4201 * leave_mesh - Leave a mesh network
4202 * @priv: Private driver interface data
4203 * Returns 0 on success, -1 on failure
4204 */
4205 int (*leave_mesh)(void *priv);
4206
4207 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07004208 * probe_mesh_link - Inject a frame over direct mesh link to a given
4209 * peer skipping the next_hop lookup from mpath table.
4210 * @priv: Private driver interface data
4211 * @addr: Peer MAC address
4212 * @eth: Ethernet frame to be sent
4213 * @len: Ethernet frame lengtn in bytes
4214 * Returns 0 on success, -1 on failure
4215 */
4216 int (*probe_mesh_link)(void *priv, const u8 *addr, const u8 *eth,
4217 size_t len);
4218
4219 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004220 * do_acs - Automatically select channel
4221 * @priv: Private driver interface data
4222 * @params: Parameters for ACS
4223 * Returns 0 on success, -1 on failure
4224 *
4225 * This command can be used to offload ACS to the driver if the driver
4226 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
4227 */
4228 int (*do_acs)(void *priv, struct drv_acs_params *params);
Ravi Joshie6ccb162015-07-16 17:45:41 -07004229
4230 /**
4231 * set_band - Notify driver of band selection
4232 * @priv: Private driver interface data
4233 * @band: The selected band(s)
4234 * Returns 0 on success, -1 on failure
4235 */
4236 int (*set_band)(void *priv, enum set_band band);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004237
4238 /**
4239 * get_pref_freq_list - Get preferred frequency list for an interface
4240 * @priv: Private driver interface data
4241 * @if_type: Interface type
4242 * @num: Number of channels
4243 * @freq_list: Preferred channel frequency list encoded in MHz values
4244 * Returns 0 on success, -1 on failure
4245 *
4246 * This command can be used to query the preferred frequency list from
4247 * the driver specific to a particular interface type.
4248 */
4249 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
4250 unsigned int *num, unsigned int *freq_list);
4251
4252 /**
4253 * set_prob_oper_freq - Indicate probable P2P operating channel
4254 * @priv: Private driver interface data
4255 * @freq: Channel frequency in MHz
4256 * Returns 0 on success, -1 on failure
4257 *
4258 * This command can be used to inform the driver of the operating
4259 * frequency that an ongoing P2P group formation is likely to come up
4260 * on. Local device is assuming P2P Client role.
4261 */
4262 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004263
4264 /**
4265 * abort_scan - Request the driver to abort an ongoing scan
4266 * @priv: Private driver interface data
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004267 * @scan_cookie: Cookie identifying the scan request. This is used only
4268 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4269 * was used to trigger scan. Otherwise, 0 is used.
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004270 * Returns 0 on success, -1 on failure
4271 */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004272 int (*abort_scan)(void *priv, u64 scan_cookie);
Dmitry Shmidt849734c2016-05-27 09:59:01 -07004273
4274 /**
4275 * configure_data_frame_filters - Request to configure frame filters
4276 * @priv: Private driver interface data
4277 * @filter_flags: The type of frames to filter (bitfield of
4278 * WPA_DATA_FRAME_FILTER_FLAG_*)
4279 * Returns: 0 on success or -1 on failure
4280 */
4281 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07004282
4283 /**
4284 * get_ext_capab - Get extended capabilities for the specified interface
4285 * @priv: Private driver interface data
4286 * @type: Interface type for which to get extended capabilities
4287 * @ext_capab: Extended capabilities fetched
4288 * @ext_capab_mask: Extended capabilities mask
4289 * @ext_capab_len: Length of the extended capabilities
4290 * Returns: 0 on success or -1 on failure
4291 */
4292 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
4293 const u8 **ext_capab, const u8 **ext_capab_mask,
4294 unsigned int *ext_capab_len);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004295
4296 /**
4297 * p2p_lo_start - Start offloading P2P listen to device
4298 * @priv: Private driver interface data
4299 * @freq: Listening frequency (MHz) for P2P listen
4300 * @period: Length of the listen operation in milliseconds
4301 * @interval: Interval for running the listen operation in milliseconds
4302 * @count: Number of times to run the listen operation
4303 * @device_types: Device primary and secondary types
4304 * @dev_types_len: Number of bytes for device_types
4305 * @ies: P2P IE and WSC IE for Probe Response frames
4306 * @ies_len: Length of ies in bytes
4307 * Returns: 0 on success or -1 on failure
4308 */
4309 int (*p2p_lo_start)(void *priv, unsigned int freq,
4310 unsigned int period, unsigned int interval,
4311 unsigned int count,
4312 const u8 *device_types, size_t dev_types_len,
4313 const u8 *ies, size_t ies_len);
4314
4315 /**
4316 * p2p_lo_stop - Stop P2P listen offload
4317 * @priv: Private driver interface data
4318 * Returns: 0 on success or -1 on failure
4319 */
4320 int (*p2p_lo_stop)(void *priv);
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07004321
4322 /**
4323 * set_default_scan_ies - Set default scan IEs
4324 * @priv: Private driver interface data
4325 * @ies: Scan default IEs buffer
4326 * @ies_len: Length of IEs in bytes
4327 * Returns: 0 on success or -1 on failure
4328 *
4329 * The driver can use these by default when there are no scan IEs coming
4330 * in the subsequent scan requests. Also in case of one or more of IEs
4331 * given in set_default_scan_ies() are missing in the subsequent scan
4332 * request, the driver should merge the missing scan IEs in the scan
4333 * request from the IEs set by set_default_scan_ies() in the Probe
4334 * Request frames sent.
4335 */
4336 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
4337
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004338 /**
4339 * set_tdls_mode - Set TDLS trigger mode to the host driver
4340 * @priv: Private driver interface data
4341 * @tdls_external_control: Represents if TDLS external trigger control
4342 * mode is enabled/disabled.
4343 *
4344 * This optional callback can be used to configure the TDLS external
4345 * trigger control mode to the host driver.
4346 */
4347 int (*set_tdls_mode)(void *priv, int tdls_external_control);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004348
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004349 /**
4350 * get_bss_transition_status - Get candidate BSS's transition status
4351 * @priv: Private driver interface data
4352 * @params: Candidate BSS list
4353 *
4354 * Get the accept or reject reason code for a list of BSS transition
4355 * candidates.
4356 */
4357 struct wpa_bss_candidate_info *
4358 (*get_bss_transition_status)(void *priv,
4359 struct wpa_bss_trans_info *params);
4360 /**
4361 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
4362 * @priv: Private driver interface data
4363 * @ignore_disallow: 0 to not ignore, 1 to ignore
4364 * Returns: 0 on success, -1 on failure
4365 */
4366 int (*ignore_assoc_disallow)(void *priv, int ignore_disallow);
4367
4368 /**
4369 * set_bssid_blacklist - Set blacklist of BSSIDs to the driver
4370 * @priv: Private driver interface data
4371 * @num_bssid: Number of blacklist BSSIDs
4372 * @bssids: List of blacklisted BSSIDs
4373 */
4374 int (*set_bssid_blacklist)(void *priv, unsigned int num_bssid,
4375 const u8 *bssid);
4376
4377 /**
4378 * update_connect_params - Update the connection parameters
4379 * @priv: Private driver interface data
4380 * @params: Association parameters
4381 * @mask: Bit mask indicating which parameters in @params have to be
4382 * updated
4383 * Returns: 0 on success, -1 on failure
4384 *
4385 * Update the connection parameters when in connected state so that the
4386 * driver uses the updated parameters for subsequent roaming. This is
4387 * used only with drivers that implement internal BSS selection and
4388 * roaming.
4389 */
4390 int (*update_connect_params)(
4391 void *priv, struct wpa_driver_associate_params *params,
4392 enum wpa_drv_update_connect_params_mask mask);
Roshan Pius3a1667e2018-07-03 15:17:14 -07004393
4394 /**
4395 * send_external_auth_status - Indicate the status of external
4396 * authentication processing to the host driver.
4397 * @priv: Private driver interface data
4398 * @params: Status of authentication processing.
4399 * Returns: 0 on success, -1 on failure
4400 */
4401 int (*send_external_auth_status)(void *priv,
4402 struct external_auth *params);
Hai Shalom74f70d42019-02-11 14:42:39 -08004403
4404 /**
4405 * set_4addr_mode - Set 4-address mode
4406 * @priv: Private driver interface data
4407 * @bridge_ifname: Bridge interface name
4408 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
4409 * Returns: 0 on success, < 0 on failure
4410 */
4411 int (*set_4addr_mode)(void *priv, const char *bridge_ifname, int val);
Hai Shalom81f62d82019-07-22 12:10:00 -07004412
4413 /**
4414 * update_dh_ie - Update DH IE
4415 * @priv: Private driver interface data
4416 * @peer_mac: Peer MAC address
4417 * @reason_code: Reacon code
4418 * @ie: DH IE
4419 * @ie_len: DH IE length in bytes
4420 * Returns: 0 on success, -1 on failure
4421 *
4422 * This callback is used to let the driver know the DH processing result
4423 * and DH IE for a pending association.
4424 */
4425 int (*update_dh_ie)(void *priv, const u8 *peer_mac, u16 reason_code,
4426 const u8 *ie, size_t ie_len);
Hai Shalomb755a2a2020-04-23 21:49:02 -07004427
4428 /**
4429 * dpp_listen - Notify driver about start/stop of DPP listen
4430 * @priv: Private driver interface data
4431 * @enable: Whether listen state is enabled (or disabled)
4432 * Returns: 0 on success, -1 on failure
4433 *
4434 * This optional callback can be used to update RX frame filtering to
4435 * explicitly allow reception of broadcast Public Action frames.
4436 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004437 int (*dpp_listen)(void *priv, bool enable);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004438};
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004439
4440/**
4441 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
4442 */
4443enum wpa_event_type {
4444 /**
4445 * EVENT_ASSOC - Association completed
4446 *
4447 * This event needs to be delivered when the driver completes IEEE
4448 * 802.11 association or reassociation successfully.
4449 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
4450 * after this event has been generated. In addition, optional
4451 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
4452 * more information about the association. If the driver interface gets
4453 * both of these events at the same time, it can also include the
4454 * assoc_info data in EVENT_ASSOC call.
4455 */
4456 EVENT_ASSOC,
4457
4458 /**
4459 * EVENT_DISASSOC - Association lost
4460 *
4461 * This event should be called when association is lost either due to
4462 * receiving deauthenticate or disassociate frame from the AP or when
4463 * sending either of these frames to the current AP. If the driver
4464 * supports separate deauthentication event, EVENT_DISASSOC should only
4465 * be used for disassociation and EVENT_DEAUTH for deauthentication.
4466 * In AP mode, union wpa_event_data::disassoc_info is required.
4467 */
4468 EVENT_DISASSOC,
4469
4470 /**
4471 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
4472 *
4473 * This event must be delivered when a Michael MIC error is detected by
4474 * the local driver. Additional data for event processing is
4475 * provided with union wpa_event_data::michael_mic_failure. This
4476 * information is used to request new encyption key and to initiate
4477 * TKIP countermeasures if needed.
4478 */
4479 EVENT_MICHAEL_MIC_FAILURE,
4480
4481 /**
4482 * EVENT_SCAN_RESULTS - Scan results available
4483 *
4484 * This event must be called whenever scan results are available to be
4485 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4486 * is expected to be used some time after struct wpa_driver_ops::scan()
4487 * is called. If the driver provides an unsolicited event when the scan
4488 * has been completed, this event can be used to trigger
4489 * EVENT_SCAN_RESULTS call. If such event is not available from the
4490 * driver, the driver wrapper code is expected to use a registered
4491 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
4492 * scan is expected to be completed. Optional information about
4493 * completed scan can be provided with union wpa_event_data::scan_info.
4494 */
4495 EVENT_SCAN_RESULTS,
4496
4497 /**
4498 * EVENT_ASSOCINFO - Report optional extra information for association
4499 *
4500 * This event can be used to report extra association information for
4501 * EVENT_ASSOC processing. This extra information includes IEs from
4502 * association frames and Beacon/Probe Response frames in union
4503 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4504 * EVENT_ASSOC. Alternatively, the driver interface can include
4505 * assoc_info data in the EVENT_ASSOC call if it has all the
4506 * information available at the same point.
4507 */
4508 EVENT_ASSOCINFO,
4509
4510 /**
4511 * EVENT_INTERFACE_STATUS - Report interface status changes
4512 *
4513 * This optional event can be used to report changes in interface
4514 * status (interface added/removed) using union
4515 * wpa_event_data::interface_status. This can be used to trigger
4516 * wpa_supplicant to stop and re-start processing for the interface,
4517 * e.g., when a cardbus card is ejected/inserted.
4518 */
4519 EVENT_INTERFACE_STATUS,
4520
4521 /**
4522 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4523 *
4524 * This event can be used to inform wpa_supplicant about candidates for
4525 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4526 * for scan request (ap_scan=2 mode), this event is required for
4527 * pre-authentication. If wpa_supplicant is performing scan request
4528 * (ap_scan=1), this event is optional since scan results can be used
4529 * to add pre-authentication candidates. union
4530 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4531 * candidate and priority of the candidate, e.g., based on the signal
4532 * strength, in order to try to pre-authenticate first with candidates
4533 * that are most likely targets for re-association.
4534 *
4535 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4536 * on the candidate list. In addition, it can be called for the current
4537 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4538 * will automatically skip pre-authentication in cases where a valid
4539 * PMKSA exists. When more than one candidate exists, this event should
4540 * be generated once for each candidate.
4541 *
4542 * Driver will be notified about successful pre-authentication with
4543 * struct wpa_driver_ops::add_pmkid() calls.
4544 */
4545 EVENT_PMKID_CANDIDATE,
4546
4547 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004548 * EVENT_TDLS - Request TDLS operation
4549 *
4550 * This event can be used to request a TDLS operation to be performed.
4551 */
4552 EVENT_TDLS,
4553
4554 /**
4555 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4556 *
4557 * The driver is expected to report the received FT IEs from
4558 * FT authentication sequence from the AP. The FT IEs are included in
4559 * the extra information in union wpa_event_data::ft_ies.
4560 */
4561 EVENT_FT_RESPONSE,
4562
4563 /**
4564 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4565 *
4566 * The driver can use this event to inform wpa_supplicant about a STA
4567 * in an IBSS with which protected frames could be exchanged. This
4568 * event starts RSN authentication with the other STA to authenticate
4569 * the STA and set up encryption keys with it.
4570 */
4571 EVENT_IBSS_RSN_START,
4572
4573 /**
4574 * EVENT_AUTH - Authentication result
4575 *
4576 * This event should be called when authentication attempt has been
4577 * completed. This is only used if the driver supports separate
4578 * authentication step (struct wpa_driver_ops::authenticate).
4579 * Information about authentication result is included in
4580 * union wpa_event_data::auth.
4581 */
4582 EVENT_AUTH,
4583
4584 /**
4585 * EVENT_DEAUTH - Authentication lost
4586 *
4587 * This event should be called when authentication is lost either due
4588 * to receiving deauthenticate frame from the AP or when sending that
4589 * frame to the current AP.
4590 * In AP mode, union wpa_event_data::deauth_info is required.
4591 */
4592 EVENT_DEAUTH,
4593
4594 /**
4595 * EVENT_ASSOC_REJECT - Association rejected
4596 *
4597 * This event should be called when (re)association attempt has been
4598 * rejected by the AP. Information about the association response is
4599 * included in union wpa_event_data::assoc_reject.
4600 */
4601 EVENT_ASSOC_REJECT,
4602
4603 /**
4604 * EVENT_AUTH_TIMED_OUT - Authentication timed out
4605 */
4606 EVENT_AUTH_TIMED_OUT,
4607
4608 /**
4609 * EVENT_ASSOC_TIMED_OUT - Association timed out
4610 */
4611 EVENT_ASSOC_TIMED_OUT,
4612
4613 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004614 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
4615 */
4616 EVENT_WPS_BUTTON_PUSHED,
4617
4618 /**
4619 * EVENT_TX_STATUS - Report TX status
4620 */
4621 EVENT_TX_STATUS,
4622
4623 /**
4624 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
4625 */
4626 EVENT_RX_FROM_UNKNOWN,
4627
4628 /**
4629 * EVENT_RX_MGMT - Report RX of a management frame
4630 */
4631 EVENT_RX_MGMT,
4632
4633 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004634 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
4635 *
4636 * This event is used to indicate when the driver has started the
4637 * requested remain-on-channel duration. Information about the
4638 * operation is included in union wpa_event_data::remain_on_channel.
4639 */
4640 EVENT_REMAIN_ON_CHANNEL,
4641
4642 /**
4643 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
4644 *
4645 * This event is used to indicate when the driver has completed
4646 * remain-on-channel duration, i.e., may noot be available on the
4647 * requested channel anymore. Information about the
4648 * operation is included in union wpa_event_data::remain_on_channel.
4649 */
4650 EVENT_CANCEL_REMAIN_ON_CHANNEL,
4651
4652 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004653 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
4654 *
4655 * This event is used to indicate when a Probe Request frame has been
4656 * received. Information about the received frame is included in
4657 * union wpa_event_data::rx_probe_req. The driver is required to report
4658 * these events only after successfully completed probe_req_report()
4659 * commands to request the events (i.e., report parameter is non-zero)
4660 * in station mode. In AP mode, Probe Request frames should always be
4661 * reported.
4662 */
4663 EVENT_RX_PROBE_REQ,
4664
4665 /**
4666 * EVENT_NEW_STA - New wired device noticed
4667 *
4668 * This event is used to indicate that a new device has been detected
4669 * in a network that does not use association-like functionality (i.e.,
4670 * mainly wired Ethernet). This can be used to start EAPOL
4671 * authenticator when receiving a frame from a device. The address of
4672 * the device is included in union wpa_event_data::new_sta.
4673 */
4674 EVENT_NEW_STA,
4675
4676 /**
4677 * EVENT_EAPOL_RX - Report received EAPOL frame
4678 *
4679 * When in AP mode with hostapd, this event is required to be used to
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004680 * deliver the receive EAPOL frames from the driver.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004681 */
4682 EVENT_EAPOL_RX,
4683
4684 /**
4685 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4686 *
4687 * This event is used to indicate changes in the signal strength
4688 * observed in frames received from the current AP if signal strength
4689 * monitoring has been enabled with signal_monitor().
4690 */
4691 EVENT_SIGNAL_CHANGE,
4692
4693 /**
4694 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4695 *
4696 * This event is used to indicate that the interface was enabled after
4697 * having been previously disabled, e.g., due to rfkill.
4698 */
4699 EVENT_INTERFACE_ENABLED,
4700
4701 /**
4702 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4703 *
4704 * This event is used to indicate that the interface was disabled,
4705 * e.g., due to rfkill.
4706 */
4707 EVENT_INTERFACE_DISABLED,
4708
4709 /**
4710 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4711 *
4712 * This event is used to indicate that the channel list has changed,
4713 * e.g., because of a regulatory domain change triggered by scan
4714 * results including an AP advertising a country code.
4715 */
4716 EVENT_CHANNEL_LIST_CHANGED,
4717
4718 /**
4719 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4720 *
4721 * This event is used to indicate that the driver cannot maintain this
4722 * interface in its operation mode anymore. The most likely use for
4723 * this is to indicate that AP mode operation is not available due to
4724 * operating channel would need to be changed to a DFS channel when
4725 * the driver does not support radar detection and another virtual
4726 * interfaces caused the operating channel to change. Other similar
4727 * resource conflicts could also trigger this for station mode
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07004728 * interfaces. This event can be propagated when channel switching
4729 * fails.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004730 */
4731 EVENT_INTERFACE_UNAVAILABLE,
4732
4733 /**
4734 * EVENT_BEST_CHANNEL
4735 *
4736 * Driver generates this event whenever it detects a better channel
4737 * (e.g., based on RSSI or channel use). This information can be used
4738 * to improve channel selection for a new AP/P2P group.
4739 */
4740 EVENT_BEST_CHANNEL,
4741
4742 /**
4743 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4744 *
4745 * This event should be called when a Deauthentication frame is dropped
4746 * due to it not being protected (MFP/IEEE 802.11w).
4747 * union wpa_event_data::unprot_deauth is required to provide more
4748 * details of the frame.
4749 */
4750 EVENT_UNPROT_DEAUTH,
4751
4752 /**
4753 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4754 *
4755 * This event should be called when a Disassociation frame is dropped
4756 * due to it not being protected (MFP/IEEE 802.11w).
4757 * union wpa_event_data::unprot_disassoc is required to provide more
4758 * details of the frame.
4759 */
4760 EVENT_UNPROT_DISASSOC,
4761
4762 /**
4763 * EVENT_STATION_LOW_ACK
4764 *
4765 * Driver generates this event whenever it detected that a particular
4766 * station was lost. Detection can be through massive transmission
4767 * failures for example.
4768 */
4769 EVENT_STATION_LOW_ACK,
4770
4771 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004772 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4773 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004774 EVENT_IBSS_PEER_LOST,
4775
4776 /**
4777 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4778 *
4779 * This event carries the new replay counter to notify wpa_supplicant
4780 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4781 * completed Group Key Handshake while the host (including
4782 * wpa_supplicant was sleeping).
4783 */
4784 EVENT_DRIVER_GTK_REKEY,
4785
4786 /**
4787 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4788 */
4789 EVENT_SCHED_SCAN_STOPPED,
4790
4791 /**
4792 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4793 *
4794 * This event indicates that the station responded to the poll
4795 * initiated with @poll_client.
4796 */
4797 EVENT_DRIVER_CLIENT_POLL_OK,
4798
4799 /**
4800 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4801 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07004802 EVENT_EAPOL_TX_STATUS,
4803
4804 /**
4805 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4806 *
4807 * Described in wpa_event_data.ch_switch
4808 * */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004809 EVENT_CH_SWITCH,
4810
4811 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07004812 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
4813 *
4814 * This is a pre-switch event indicating the shortly following switch
4815 * of operating channels.
4816 *
4817 * Described in wpa_event_data.ch_switch
4818 */
4819 EVENT_CH_SWITCH_STARTED,
4820 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004821 * EVENT_WNM - Request WNM operation
4822 *
4823 * This event can be used to request a WNM operation to be performed.
4824 */
Dmitry Shmidtf8623282013-02-20 14:34:59 -08004825 EVENT_WNM,
4826
4827 /**
4828 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4829 *
4830 * This event indicates that the driver reported a connection failure
4831 * with the specified client (for example, max client reached, etc.) in
4832 * AP mode.
4833 */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004834 EVENT_CONNECT_FAILED_REASON,
4835
4836 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004837 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004838 *
4839 * A radar has been detected on the supplied frequency, hostapd should
4840 * react accordingly (e.g., change channel).
4841 */
4842 EVENT_DFS_RADAR_DETECTED,
4843
4844 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004845 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004846 *
4847 * After a successful CAC, the channel can be marked clear and used.
4848 */
4849 EVENT_DFS_CAC_FINISHED,
4850
4851 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004852 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004853 *
4854 * The CAC was not successful, and the channel remains in the previous
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004855 * state. This may happen due to a radar being detected or other
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004856 * external influences.
4857 */
4858 EVENT_DFS_CAC_ABORTED,
4859
4860 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004861 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004862 *
4863 * The channel which was previously unavailable is now available again.
4864 */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004865 EVENT_DFS_NOP_FINISHED,
4866
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08004867 /**
4868 * EVENT_SURVEY - Received survey data
4869 *
4870 * This event gets triggered when a driver query is issued for survey
4871 * data and the requested data becomes available. The returned data is
4872 * stored in struct survey_results. The results provide at most one
4873 * survey entry for each frequency and at minimum will provide one
4874 * survey entry for one frequency. The survey data can be os_malloc()'d
4875 * and then os_free()'d, so the event callback must only copy data.
4876 */
4877 EVENT_SURVEY,
4878
4879 /**
4880 * EVENT_SCAN_STARTED - Scan started
4881 *
4882 * This indicates that driver has started a scan operation either based
4883 * on a request from wpa_supplicant/hostapd or from another application.
4884 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4885 * completed (either successfully or by getting cancelled).
4886 */
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08004887 EVENT_SCAN_STARTED,
4888
4889 /**
4890 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4891 *
4892 * This event indicates a set of frequency ranges that should be avoided
4893 * to reduce issues due to interference or internal co-existence
4894 * information in the driver.
4895 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004896 EVENT_AVOID_FREQUENCIES,
4897
4898 /**
4899 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4900 */
4901 EVENT_NEW_PEER_CANDIDATE,
4902
4903 /**
4904 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4905 *
4906 * Indicates a pair of primary and secondary channels chosen by ACS
4907 * in device.
4908 */
4909 EVENT_ACS_CHANNEL_SELECTED,
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004910
4911 /**
4912 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4913 * been started.
4914 *
4915 * This event indicates that channel availability check has been started
4916 * on a DFS frequency by a driver that supports DFS Offload.
4917 */
4918 EVENT_DFS_CAC_STARTED,
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004919
4920 /**
4921 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4922 */
4923 EVENT_P2P_LO_STOP,
Paul Stewart092955c2017-02-06 09:13:09 -08004924
4925 /**
4926 * EVENT_BEACON_LOSS - Beacon loss detected
4927 *
4928 * This event indicates that no Beacon frames has been received from
4929 * the current AP. This may indicate that the AP is not anymore in
4930 * range.
4931 */
4932 EVENT_BEACON_LOSS,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004933
4934 /**
4935 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
4936 * done previously (Pre-CAC) on the channel has expired. This would
4937 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
4938 * channel will be moved from available to usable. A new CAC has to be
4939 * performed before start operating on this channel.
4940 */
4941 EVENT_DFS_PRE_CAC_EXPIRED,
Roshan Pius3a1667e2018-07-03 15:17:14 -07004942
4943 /**
4944 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
4945 * that do not define separate commands for authentication and
4946 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
4947 * authentication to wpa_supplicant. This event carries all the
4948 * necessary information from the host driver for the authentication to
4949 * happen.
4950 */
4951 EVENT_EXTERNAL_AUTH,
4952
4953 /**
4954 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
4955 *
4956 * This event should be indicated when the driver completes the 4-way
4957 * handshake. This event should be preceded by an EVENT_ASSOC that
4958 * indicates the completion of IEEE 802.11 association.
4959 */
4960 EVENT_PORT_AUTHORIZED,
4961
4962 /**
4963 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
4964 * change event.
4965 */
4966 EVENT_STATION_OPMODE_CHANGED,
4967
4968 /**
4969 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
4970 *
4971 * This event is emitted when the MAC changes while the interface is
4972 * enabled. When an interface was disabled and becomes enabled, it
4973 * must be always assumed that the MAC possibly changed.
4974 */
4975 EVENT_INTERFACE_MAC_CHANGED,
4976
4977 /**
4978 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
4979 *
4980 * This event is emitted when an interface is added/removed for WDS STA.
4981 */
4982 EVENT_WDS_STA_INTERFACE_STATUS,
Hai Shalom81f62d82019-07-22 12:10:00 -07004983
4984 /**
4985 * EVENT_UPDATE_DH - Notification of updated DH information
4986 */
4987 EVENT_UPDATE_DH,
Hai Shalomfdcde762020-04-02 11:19:20 -07004988
4989 /**
4990 * EVENT_UNPROT_BEACON - Unprotected Beacon frame received
4991 *
4992 * This event should be called when a Beacon frame is dropped due to it
4993 * not being protected correctly. union wpa_event_data::unprot_beacon
4994 * is required to provide more details of the frame.
4995 */
4996 EVENT_UNPROT_BEACON,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004997};
4998
4999
5000/**
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005001 * struct freq_survey - Channel survey info
5002 *
5003 * @ifidx: Interface index in which this survey was observed
5004 * @freq: Center of frequency of the surveyed channel
5005 * @nf: Channel noise floor in dBm
5006 * @channel_time: Amount of time in ms the radio spent on the channel
5007 * @channel_time_busy: Amount of time in ms the radio detected some signal
5008 * that indicated to the radio the channel was not clear
5009 * @channel_time_rx: Amount of time the radio spent receiving data
5010 * @channel_time_tx: Amount of time the radio spent transmitting data
5011 * @filled: bitmask indicating which fields have been reported, see
5012 * SURVEY_HAS_* defines.
5013 * @list: Internal list pointers
5014 */
5015struct freq_survey {
5016 u32 ifidx;
5017 unsigned int freq;
5018 s8 nf;
5019 u64 channel_time;
5020 u64 channel_time_busy;
5021 u64 channel_time_rx;
5022 u64 channel_time_tx;
5023 unsigned int filled;
5024 struct dl_list list;
5025};
5026
5027#define SURVEY_HAS_NF BIT(0)
5028#define SURVEY_HAS_CHAN_TIME BIT(1)
5029#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
5030#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
5031#define SURVEY_HAS_CHAN_TIME_TX BIT(4)
5032
5033
5034/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005035 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
5036 */
5037union wpa_event_data {
5038 /**
5039 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
5040 *
5041 * This structure is optional for EVENT_ASSOC calls and required for
5042 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
5043 * driver interface does not need to generate separate EVENT_ASSOCINFO
5044 * calls.
5045 */
5046 struct assoc_info {
5047 /**
5048 * reassoc - Flag to indicate association or reassociation
5049 */
5050 int reassoc;
5051
5052 /**
5053 * req_ies - (Re)Association Request IEs
5054 *
5055 * If the driver generates WPA/RSN IE, this event data must be
5056 * returned for WPA handshake to have needed information. If
5057 * wpa_supplicant-generated WPA/RSN IE is used, this
5058 * information event is optional.
5059 *
5060 * This should start with the first IE (fixed fields before IEs
5061 * are not included).
5062 */
5063 const u8 *req_ies;
5064
5065 /**
5066 * req_ies_len - Length of req_ies in bytes
5067 */
5068 size_t req_ies_len;
5069
5070 /**
5071 * resp_ies - (Re)Association Response IEs
5072 *
5073 * Optional association data from the driver. This data is not
5074 * required WPA, but may be useful for some protocols and as
5075 * such, should be reported if this is available to the driver
5076 * interface.
5077 *
5078 * This should start with the first IE (fixed fields before IEs
5079 * are not included).
5080 */
5081 const u8 *resp_ies;
5082
5083 /**
5084 * resp_ies_len - Length of resp_ies in bytes
5085 */
5086 size_t resp_ies_len;
5087
5088 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08005089 * resp_frame - (Re)Association Response frame
5090 */
5091 const u8 *resp_frame;
5092
5093 /**
5094 * resp_frame_len - (Re)Association Response frame length
5095 */
5096 size_t resp_frame_len;
5097
5098 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005099 * beacon_ies - Beacon or Probe Response IEs
5100 *
5101 * Optional Beacon/ProbeResp data: IEs included in Beacon or
5102 * Probe Response frames from the current AP (i.e., the one
5103 * that the client just associated with). This information is
5104 * used to update WPA/RSN IE for the AP. If this field is not
5105 * set, the results from previous scan will be used. If no
5106 * data for the new AP is found, scan results will be requested
5107 * again (without scan request). At this point, the driver is
5108 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
5109 * used).
5110 *
5111 * This should start with the first IE (fixed fields before IEs
5112 * are not included).
5113 */
5114 const u8 *beacon_ies;
5115
5116 /**
5117 * beacon_ies_len - Length of beacon_ies */
5118 size_t beacon_ies_len;
5119
5120 /**
5121 * freq - Frequency of the operational channel in MHz
5122 */
5123 unsigned int freq;
5124
5125 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005126 * wmm_params - WMM parameters used in this association.
5127 */
5128 struct wmm_params wmm_params;
5129
5130 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005131 * addr - Station address (for AP mode)
5132 */
5133 const u8 *addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005134
5135 /**
5136 * The following is the key management offload information
5137 * @authorized
5138 * @key_replay_ctr
5139 * @key_replay_ctr_len
5140 * @ptk_kck
5141 * @ptk_kek_len
5142 * @ptk_kek
5143 * @ptk_kek_len
5144 */
5145
5146 /**
5147 * authorized - Status of key management offload,
5148 * 1 = successful
5149 */
5150 int authorized;
5151
5152 /**
5153 * key_replay_ctr - Key replay counter value last used
5154 * in a valid EAPOL-Key frame
5155 */
5156 const u8 *key_replay_ctr;
5157
5158 /**
5159 * key_replay_ctr_len - The length of key_replay_ctr
5160 */
5161 size_t key_replay_ctr_len;
5162
5163 /**
5164 * ptk_kck - The derived PTK KCK
5165 */
5166 const u8 *ptk_kck;
5167
5168 /**
5169 * ptk_kek_len - The length of ptk_kck
5170 */
5171 size_t ptk_kck_len;
5172
5173 /**
5174 * ptk_kek - The derived PTK KEK
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005175 * This is used in key management offload and also in FILS SK
5176 * offload.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005177 */
5178 const u8 *ptk_kek;
5179
5180 /**
5181 * ptk_kek_len - The length of ptk_kek
5182 */
5183 size_t ptk_kek_len;
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08005184
5185 /**
5186 * subnet_status - The subnet status:
5187 * 0 = unknown, 1 = unchanged, 2 = changed
5188 */
5189 u8 subnet_status;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005190
5191 /**
5192 * The following information is used in FILS SK offload
5193 * @fils_erp_next_seq_num
5194 * @fils_pmk
5195 * @fils_pmk_len
5196 * @fils_pmkid
5197 */
5198
5199 /**
5200 * fils_erp_next_seq_num - The next sequence number to use in
5201 * FILS ERP messages
5202 */
5203 u16 fils_erp_next_seq_num;
5204
5205 /**
5206 * fils_pmk - A new PMK if generated in case of FILS
5207 * authentication
5208 */
5209 const u8 *fils_pmk;
5210
5211 /**
5212 * fils_pmk_len - Length of fils_pmk
5213 */
5214 size_t fils_pmk_len;
5215
5216 /**
5217 * fils_pmkid - PMKID used or generated in FILS authentication
5218 */
5219 const u8 *fils_pmkid;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005220 } assoc_info;
5221
5222 /**
5223 * struct disassoc_info - Data for EVENT_DISASSOC events
5224 */
5225 struct disassoc_info {
5226 /**
5227 * addr - Station address (for AP mode)
5228 */
5229 const u8 *addr;
5230
5231 /**
5232 * reason_code - Reason Code (host byte order) used in
5233 * Deauthentication frame
5234 */
5235 u16 reason_code;
5236
5237 /**
5238 * ie - Optional IE(s) in Disassociation frame
5239 */
5240 const u8 *ie;
5241
5242 /**
5243 * ie_len - Length of ie buffer in octets
5244 */
5245 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005246
5247 /**
5248 * locally_generated - Whether the frame was locally generated
5249 */
5250 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005251 } disassoc_info;
5252
5253 /**
5254 * struct deauth_info - Data for EVENT_DEAUTH events
5255 */
5256 struct deauth_info {
5257 /**
5258 * addr - Station address (for AP mode)
5259 */
5260 const u8 *addr;
5261
5262 /**
5263 * reason_code - Reason Code (host byte order) used in
5264 * Deauthentication frame
5265 */
5266 u16 reason_code;
5267
5268 /**
5269 * ie - Optional IE(s) in Deauthentication frame
5270 */
5271 const u8 *ie;
5272
5273 /**
5274 * ie_len - Length of ie buffer in octets
5275 */
5276 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005277
5278 /**
5279 * locally_generated - Whether the frame was locally generated
5280 */
5281 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005282 } deauth_info;
5283
5284 /**
5285 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
5286 */
5287 struct michael_mic_failure {
5288 int unicast;
5289 const u8 *src;
5290 } michael_mic_failure;
5291
5292 /**
5293 * struct interface_status - Data for EVENT_INTERFACE_STATUS
5294 */
5295 struct interface_status {
Dmitry Shmidte4663042016-04-04 10:07:49 -07005296 unsigned int ifindex;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005297 char ifname[100];
5298 enum {
5299 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
5300 } ievent;
5301 } interface_status;
5302
5303 /**
5304 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
5305 */
5306 struct pmkid_candidate {
5307 /** BSSID of the PMKID candidate */
5308 u8 bssid[ETH_ALEN];
5309 /** Smaller the index, higher the priority */
5310 int index;
5311 /** Whether RSN IE includes pre-authenticate flag */
5312 int preauth;
5313 } pmkid_candidate;
5314
5315 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005316 * struct tdls - Data for EVENT_TDLS
5317 */
5318 struct tdls {
5319 u8 peer[ETH_ALEN];
5320 enum {
5321 TDLS_REQUEST_SETUP,
Dmitry Shmidt4dd28dc2015-03-10 11:21:43 -07005322 TDLS_REQUEST_TEARDOWN,
5323 TDLS_REQUEST_DISCOVER,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005324 } oper;
5325 u16 reason_code; /* for teardown */
5326 } tdls;
5327
5328 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07005329 * struct wnm - Data for EVENT_WNM
5330 */
5331 struct wnm {
5332 u8 addr[ETH_ALEN];
5333 enum {
5334 WNM_OPER_SLEEP,
5335 } oper;
5336 enum {
5337 WNM_SLEEP_ENTER,
5338 WNM_SLEEP_EXIT
5339 } sleep_action;
5340 int sleep_intval;
5341 u16 reason_code;
5342 u8 *buf;
5343 u16 buf_len;
5344 } wnm;
5345
5346 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005347 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
5348 *
5349 * During FT (IEEE 802.11r) authentication sequence, the driver is
5350 * expected to use this event to report received FT IEs (MDIE, FTIE,
5351 * RSN IE, TIE, possible resource request) to the supplicant. The FT
5352 * IEs for the next message will be delivered through the
5353 * struct wpa_driver_ops::update_ft_ies() callback.
5354 */
5355 struct ft_ies {
5356 const u8 *ies;
5357 size_t ies_len;
5358 int ft_action;
5359 u8 target_ap[ETH_ALEN];
5360 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
5361 const u8 *ric_ies;
5362 /** Length of ric_ies buffer in octets */
5363 size_t ric_ies_len;
5364 } ft_ies;
5365
5366 /**
5367 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
5368 */
5369 struct ibss_rsn_start {
5370 u8 peer[ETH_ALEN];
5371 } ibss_rsn_start;
5372
5373 /**
5374 * struct auth_info - Data for EVENT_AUTH events
5375 */
5376 struct auth_info {
5377 u8 peer[ETH_ALEN];
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005378 u8 bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005379 u16 auth_type;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005380 u16 auth_transaction;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005381 u16 status_code;
5382 const u8 *ies;
5383 size_t ies_len;
5384 } auth;
5385
5386 /**
5387 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
5388 */
5389 struct assoc_reject {
5390 /**
5391 * bssid - BSSID of the AP that rejected association
5392 */
5393 const u8 *bssid;
5394
5395 /**
5396 * resp_ies - (Re)Association Response IEs
5397 *
5398 * Optional association data from the driver. This data is not
5399 * required WPA, but may be useful for some protocols and as
5400 * such, should be reported if this is available to the driver
5401 * interface.
5402 *
5403 * This should start with the first IE (fixed fields before IEs
5404 * are not included).
5405 */
5406 const u8 *resp_ies;
5407
5408 /**
5409 * resp_ies_len - Length of resp_ies in bytes
5410 */
5411 size_t resp_ies_len;
5412
5413 /**
5414 * status_code - Status Code from (Re)association Response
5415 */
5416 u16 status_code;
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07005417
5418 /**
5419 * timed_out - Whether failure is due to timeout (etc.) rather
5420 * than explicit rejection response from the AP.
5421 */
5422 int timed_out;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08005423
5424 /**
5425 * timeout_reason - Reason for the timeout
5426 */
5427 const char *timeout_reason;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005428
5429 /**
5430 * fils_erp_next_seq_num - The next sequence number to use in
5431 * FILS ERP messages
5432 */
5433 u16 fils_erp_next_seq_num;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005434 } assoc_reject;
5435
5436 struct timeout_event {
5437 u8 addr[ETH_ALEN];
5438 } timeout_event;
5439
5440 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005441 * struct tx_status - Data for EVENT_TX_STATUS events
5442 */
5443 struct tx_status {
5444 u16 type;
5445 u16 stype;
5446 const u8 *dst;
5447 const u8 *data;
5448 size_t data_len;
5449 int ack;
5450 } tx_status;
5451
5452 /**
5453 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
5454 */
5455 struct rx_from_unknown {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005456 const u8 *bssid;
5457 const u8 *addr;
5458 int wds;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005459 } rx_from_unknown;
5460
5461 /**
5462 * struct rx_mgmt - Data for EVENT_RX_MGMT events
5463 */
5464 struct rx_mgmt {
5465 const u8 *frame;
5466 size_t frame_len;
5467 u32 datarate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005468
5469 /**
Dmitry Shmidt98660862014-03-11 17:26:21 -07005470 * drv_priv - Pointer to store driver private BSS information
5471 *
5472 * If not set to NULL, this is used for comparison with
5473 * hostapd_data->drv_priv to determine which BSS should process
5474 * the frame.
5475 */
5476 void *drv_priv;
5477
5478 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005479 * freq - Frequency (in MHz) on which the frame was received
5480 */
5481 int freq;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005482
5483 /**
5484 * ssi_signal - Signal strength in dBm (or 0 if not available)
5485 */
5486 int ssi_signal;
5487 } rx_mgmt;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005488
5489 /**
5490 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
5491 *
5492 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
5493 */
5494 struct remain_on_channel {
5495 /**
5496 * freq - Channel frequency in MHz
5497 */
5498 unsigned int freq;
5499
5500 /**
5501 * duration - Duration to remain on the channel in milliseconds
5502 */
5503 unsigned int duration;
5504 } remain_on_channel;
5505
5506 /**
5507 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
5508 * @aborted: Whether the scan was aborted
5509 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
5510 * @num_freqs: Number of entries in freqs array
5511 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
5512 * SSID)
5513 * @num_ssids: Number of entries in ssids array
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08005514 * @external_scan: Whether the scan info is for an external scan
5515 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
5516 * 0 if the source of the scan event is a vendor scan
Dmitry Shmidt29333592017-01-09 12:27:11 -08005517 * @scan_start_tsf: Time when the scan started in terms of TSF of the
5518 * BSS that the interface that requested the scan is connected to
5519 * (if available).
5520 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
5521 * is set.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005522 */
5523 struct scan_info {
5524 int aborted;
5525 const int *freqs;
5526 size_t num_freqs;
5527 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
5528 size_t num_ssids;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08005529 int external_scan;
5530 int nl_scan_event;
Dmitry Shmidt29333592017-01-09 12:27:11 -08005531 u64 scan_start_tsf;
5532 u8 scan_start_tsf_bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005533 } scan_info;
5534
5535 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005536 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
5537 */
5538 struct rx_probe_req {
5539 /**
5540 * sa - Source address of the received Probe Request frame
5541 */
5542 const u8 *sa;
5543
5544 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005545 * da - Destination address of the received Probe Request frame
5546 * or %NULL if not available
5547 */
5548 const u8 *da;
5549
5550 /**
5551 * bssid - BSSID of the received Probe Request frame or %NULL
5552 * if not available
5553 */
5554 const u8 *bssid;
5555
5556 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005557 * ie - IEs from the Probe Request body
5558 */
5559 const u8 *ie;
5560
5561 /**
5562 * ie_len - Length of ie buffer in octets
5563 */
5564 size_t ie_len;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005565
5566 /**
5567 * signal - signal strength in dBm (or 0 if not available)
5568 */
5569 int ssi_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005570 } rx_probe_req;
5571
5572 /**
5573 * struct new_sta - Data for EVENT_NEW_STA events
5574 */
5575 struct new_sta {
5576 const u8 *addr;
5577 } new_sta;
5578
5579 /**
5580 * struct eapol_rx - Data for EVENT_EAPOL_RX events
5581 */
5582 struct eapol_rx {
5583 const u8 *src;
5584 const u8 *data;
5585 size_t data_len;
5586 } eapol_rx;
5587
5588 /**
5589 * signal_change - Data for EVENT_SIGNAL_CHANGE events
5590 */
5591 struct wpa_signal_info signal_change;
5592
5593 /**
5594 * struct best_channel - Data for EVENT_BEST_CHANNEL events
5595 * @freq_24: Best 2.4 GHz band channel frequency in MHz
5596 * @freq_5: Best 5 GHz band channel frequency in MHz
5597 * @freq_overall: Best channel frequency in MHz
5598 *
5599 * 0 can be used to indicate no preference in either band.
5600 */
5601 struct best_channel {
5602 int freq_24;
5603 int freq_5;
5604 int freq_overall;
5605 } best_chan;
5606
5607 struct unprot_deauth {
5608 const u8 *sa;
5609 const u8 *da;
5610 u16 reason_code;
5611 } unprot_deauth;
5612
5613 struct unprot_disassoc {
5614 const u8 *sa;
5615 const u8 *da;
5616 u16 reason_code;
5617 } unprot_disassoc;
5618
5619 /**
5620 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
5621 * @addr: station address
Paul Stewart092955c2017-02-06 09:13:09 -08005622 * @num_packets: Number of packets lost (consecutive packets not
5623 * acknowledged)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005624 */
5625 struct low_ack {
5626 u8 addr[ETH_ALEN];
Paul Stewart092955c2017-02-06 09:13:09 -08005627 u32 num_packets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005628 } low_ack;
5629
5630 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005631 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
5632 */
5633 struct ibss_peer_lost {
5634 u8 peer[ETH_ALEN];
5635 } ibss_peer_lost;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005636
5637 /**
5638 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
5639 */
5640 struct driver_gtk_rekey {
5641 const u8 *bssid;
5642 const u8 *replay_ctr;
5643 } driver_gtk_rekey;
5644
5645 /**
5646 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
5647 * @addr: station address
5648 */
5649 struct client_poll {
5650 u8 addr[ETH_ALEN];
5651 } client_poll;
5652
5653 /**
5654 * struct eapol_tx_status
5655 * @dst: Original destination
5656 * @data: Data starting with IEEE 802.1X header (!)
5657 * @data_len: Length of data
5658 * @ack: Indicates ack or lost frame
5659 *
5660 * This corresponds to hapd_send_eapol if the frame sent
5661 * there isn't just reported as EVENT_TX_STATUS.
5662 */
5663 struct eapol_tx_status {
5664 const u8 *dst;
5665 const u8 *data;
5666 int data_len;
5667 int ack;
5668 } eapol_tx_status;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005669
5670 /**
5671 * struct ch_switch
5672 * @freq: Frequency of new channel in MHz
5673 * @ht_enabled: Whether this is an HT channel
5674 * @ch_offset: Secondary channel offset
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08005675 * @ch_width: Channel width
5676 * @cf1: Center frequency 1
5677 * @cf2: Center frequency 2
Dmitry Shmidt04949592012-07-19 12:16:46 -07005678 */
5679 struct ch_switch {
5680 int freq;
5681 int ht_enabled;
5682 int ch_offset;
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08005683 enum chan_width ch_width;
5684 int cf1;
5685 int cf2;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005686 } ch_switch;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08005687
5688 /**
5689 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
5690 * @addr: Remote client address
5691 * @code: Reason code for connection failure
5692 */
5693 struct connect_failed_reason {
5694 u8 addr[ETH_ALEN];
5695 enum {
5696 MAX_CLIENT_REACHED,
5697 BLOCKED_CLIENT
5698 } code;
5699 } connect_failed_reason;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005700
5701 /**
5702 * struct dfs_event - Data for radar detected events
5703 * @freq: Frequency of the channel in MHz
5704 */
5705 struct dfs_event {
5706 int freq;
Dmitry Shmidt051af732013-10-22 13:52:46 -07005707 int ht_enabled;
5708 int chan_offset;
5709 enum chan_width chan_width;
5710 int cf1;
5711 int cf2;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005712 } dfs_event;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005713
5714 /**
5715 * survey_results - Survey result data for EVENT_SURVEY
5716 * @freq_filter: Requested frequency survey filter, 0 if request
5717 * was for all survey data
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005718 * @survey_list: Linked list of survey data (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005719 */
5720 struct survey_results {
5721 unsigned int freq_filter;
5722 struct dl_list survey_list; /* struct freq_survey */
5723 } survey_results;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005724
5725 /**
5726 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
5727 * @initiator: Initiator of the regulatory change
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07005728 * @type: Regulatory change type
5729 * @alpha2: Country code (or "" if not available)
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005730 */
5731 struct channel_list_changed {
5732 enum reg_change_initiator initiator;
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07005733 enum reg_type type;
5734 char alpha2[3];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005735 } channel_list_changed;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08005736
5737 /**
5738 * freq_range - List of frequency ranges
5739 *
5740 * This is used as the data with EVENT_AVOID_FREQUENCIES.
5741 */
5742 struct wpa_freq_range_list freq_range;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005743
5744 /**
5745 * struct mesh_peer
5746 *
5747 * @peer: Peer address
5748 * @ies: Beacon IEs
5749 * @ie_len: Length of @ies
5750 *
5751 * Notification of new candidate mesh peer.
5752 */
5753 struct mesh_peer {
5754 const u8 *peer;
5755 const u8 *ies;
5756 size_t ie_len;
5757 } mesh_peer;
5758
5759 /**
5760 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08005761 * @pri_freq: Selected primary frequency
5762 * @sec_freq: Selected secondary frequency
Hai Shalomfdcde762020-04-02 11:19:20 -07005763 * @edmg_channel: Selected EDMG channel
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005764 * @vht_seg0_center_ch: VHT mode Segment0 center channel
Hai Shalomfdcde762020-04-02 11:19:20 -07005765 * The value is the index of the channel center frequency for
5766 * 20 MHz, 40 MHz, and 80 MHz channels. The value is the center
5767 * frequency index of the primary 80 MHz segment for 160 MHz and
5768 * 80+80 MHz channels.
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005769 * @vht_seg1_center_ch: VHT mode Segment1 center channel
Hai Shalomfdcde762020-04-02 11:19:20 -07005770 * The value is zero for 20 MHz, 40 MHz, and 80 MHz channels. The
5771 * value is the index of the channel center frequency for 160 MHz
5772 * channels and the center frequency index of the secondary 80 MHz
5773 * segment for 80+80 MHz channels.
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005774 * @ch_width: Selected Channel width by driver. Driver may choose to
5775 * change hostapd configured ACS channel width due driver internal
5776 * channel restrictions.
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07005777 * hw_mode: Selected band (used with hw_mode=any)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005778 */
5779 struct acs_selected_channels {
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08005780 unsigned int pri_freq;
5781 unsigned int sec_freq;
Hai Shalomfdcde762020-04-02 11:19:20 -07005782 u8 edmg_channel;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005783 u8 vht_seg0_center_ch;
5784 u8 vht_seg1_center_ch;
5785 u16 ch_width;
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07005786 enum hostapd_hw_mode hw_mode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005787 } acs_selected_channels;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005788
5789 /**
5790 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
5791 * @reason_code: Reason for stopping offload
5792 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
5793 * scheduled.
5794 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
5795 * be stopped.
5796 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
5797 * parameters.
5798 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
5799 * supported by device.
5800 */
5801 struct p2p_lo_stop {
5802 enum {
5803 P2P_LO_STOPPED_REASON_COMPLETE = 0,
5804 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
5805 P2P_LO_STOPPED_REASON_INVALID_PARAM,
5806 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
5807 } reason_code;
5808 } p2p_lo_stop;
Roshan Pius3a1667e2018-07-03 15:17:14 -07005809
5810 /* For EVENT_EXTERNAL_AUTH */
5811 struct external_auth external_auth;
5812
5813 /**
5814 * struct sta_opmode - Station's operation mode change event
5815 * @addr: The station MAC address
5816 * @smps_mode: SMPS mode of the station
5817 * @chan_width: Channel width of the station
5818 * @rx_nss: RX_NSS of the station
5819 *
5820 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
5821 */
5822 struct sta_opmode {
5823 const u8 *addr;
5824 enum smps_mode smps_mode;
5825 enum chan_width chan_width;
5826 u8 rx_nss;
5827 } sta_opmode;
5828
5829 /**
5830 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
5831 */
5832 struct wds_sta_interface {
5833 const u8 *sta_addr;
5834 const char *ifname;
5835 enum {
5836 INTERFACE_ADDED,
5837 INTERFACE_REMOVED
5838 } istatus;
5839 } wds_sta_interface;
Hai Shalom81f62d82019-07-22 12:10:00 -07005840
5841 /**
5842 * struct update_dh - Data for EVENT_UPDATE_DH
5843 */
5844 struct update_dh {
5845 const u8 *peer;
5846 const u8 *ie;
5847 size_t ie_len;
5848 } update_dh;
Hai Shalomfdcde762020-04-02 11:19:20 -07005849
5850 /**
5851 * struct unprot_beacon - Data for EVENT_UNPROT_BEACON
5852 */
5853 struct unprot_beacon {
5854 const u8 *sa;
5855 } unprot_beacon;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005856};
5857
5858/**
5859 * wpa_supplicant_event - Report a driver event for wpa_supplicant
5860 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5861 * with struct wpa_driver_ops::init()
5862 * @event: event type (defined above)
5863 * @data: possible extra data for the event
5864 *
5865 * Driver wrapper code should call this function whenever an event is received
5866 * from the driver.
5867 */
5868void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
5869 union wpa_event_data *data);
5870
Dmitry Shmidte4663042016-04-04 10:07:49 -07005871/**
5872 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
5873 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5874 * with struct wpa_driver_ops::init()
5875 * @event: event type (defined above)
5876 * @data: possible extra data for the event
5877 *
5878 * Same as wpa_supplicant_event(), but we search for the interface in
5879 * wpa_global.
5880 */
5881void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
5882 union wpa_event_data *data);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005883
5884/*
5885 * The following inline functions are provided for convenience to simplify
5886 * event indication for some of the common events.
5887 */
5888
5889static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
5890 size_t ielen, int reassoc)
5891{
5892 union wpa_event_data event;
5893 os_memset(&event, 0, sizeof(event));
5894 event.assoc_info.reassoc = reassoc;
5895 event.assoc_info.req_ies = ie;
5896 event.assoc_info.req_ies_len = ielen;
5897 event.assoc_info.addr = addr;
5898 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
5899}
5900
5901static inline void drv_event_disassoc(void *ctx, const u8 *addr)
5902{
5903 union wpa_event_data event;
5904 os_memset(&event, 0, sizeof(event));
5905 event.disassoc_info.addr = addr;
5906 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
5907}
5908
5909static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
5910 size_t data_len)
5911{
5912 union wpa_event_data event;
5913 os_memset(&event, 0, sizeof(event));
5914 event.eapol_rx.src = src;
5915 event.eapol_rx.data = data;
5916 event.eapol_rx.data_len = data_len;
5917 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
5918}
5919
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005920/* driver_common.c */
5921void wpa_scan_results_free(struct wpa_scan_results *res);
5922
5923/* Convert wpa_event_type to a string for logging */
5924const char * event_to_string(enum wpa_event_type event);
5925
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07005926/* Convert chan_width to a string for logging and control interfaces */
5927const char * channel_width_to_string(enum chan_width width);
5928
Hai Shalom74f70d42019-02-11 14:42:39 -08005929int channel_width_to_int(enum chan_width width);
5930
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005931int ht_supported(const struct hostapd_hw_modes *mode);
5932int vht_supported(const struct hostapd_hw_modes *mode);
5933
5934struct wowlan_triggers *
5935wpa_get_wowlan_triggers(const char *wowlan_triggers,
5936 const struct wpa_driver_capa *capa);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005937/* Convert driver flag to string */
5938const char * driver_flag_to_string(u64 flag);
Hai Shalomb755a2a2020-04-23 21:49:02 -07005939const char * driver_flag2_to_string(u64 flag2);
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005940
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005941/* NULL terminated array of linked in driver wrappers */
Dmitry Shmidt1d755d02015-04-28 10:34:29 -07005942extern const struct wpa_driver_ops *const wpa_drivers[];
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005943
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07005944
5945/* Available drivers */
5946
5947#ifdef CONFIG_DRIVER_WEXT
5948extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
5949#endif /* CONFIG_DRIVER_WEXT */
5950#ifdef CONFIG_DRIVER_NL80211
5951/* driver_nl80211.c */
5952extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
5953#endif /* CONFIG_DRIVER_NL80211 */
5954#ifdef CONFIG_DRIVER_HOSTAP
5955extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
5956#endif /* CONFIG_DRIVER_HOSTAP */
5957#ifdef CONFIG_DRIVER_BSD
5958extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
5959#endif /* CONFIG_DRIVER_BSD */
5960#ifdef CONFIG_DRIVER_OPENBSD
5961/* driver_openbsd.c */
5962extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
5963#endif /* CONFIG_DRIVER_OPENBSD */
5964#ifdef CONFIG_DRIVER_NDIS
5965extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
5966#endif /* CONFIG_DRIVER_NDIS */
5967#ifdef CONFIG_DRIVER_WIRED
5968extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
5969#endif /* CONFIG_DRIVER_WIRED */
5970#ifdef CONFIG_DRIVER_MACSEC_QCA
5971/* driver_macsec_qca.c */
5972extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
5973#endif /* CONFIG_DRIVER_MACSEC_QCA */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08005974#ifdef CONFIG_DRIVER_MACSEC_LINUX
5975/* driver_macsec_linux.c */
5976extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops;
5977#endif /* CONFIG_DRIVER_MACSEC_LINUX */
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07005978#ifdef CONFIG_DRIVER_ROBOSWITCH
5979/* driver_roboswitch.c */
5980extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
5981#endif /* CONFIG_DRIVER_ROBOSWITCH */
5982#ifdef CONFIG_DRIVER_ATHEROS
5983/* driver_atheros.c */
5984extern const struct wpa_driver_ops wpa_driver_atheros_ops;
5985#endif /* CONFIG_DRIVER_ATHEROS */
5986#ifdef CONFIG_DRIVER_NONE
5987extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
5988#endif /* CONFIG_DRIVER_NONE */
5989
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005990#endif /* DRIVER_H */