blob: 12b46b64ad9f4bf7d1e15f437c9946c1d2d61785 [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),
Sunil8cd6f4d2022-06-28 18:40:46 +000069 HOSTAPD_CHAN_WIDTH_320 = BIT(6),
Hai Shalom74f70d42019-02-11 14:42:39 -080070};
71
Dmitry Shmidt849734c2016-05-27 09:59:01 -070072/* Filter gratuitous ARP */
73#define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
74/* Filter unsolicited Neighbor Advertisement */
75#define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
76/* Filter unicast IP packets encrypted using the GTK */
77#define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)
78
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070079#define HOSTAPD_DFS_REGION_FCC 1
80#define HOSTAPD_DFS_REGION_ETSI 2
81#define HOSTAPD_DFS_REGION_JP 3
82
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080083/**
84 * enum reg_change_initiator - Regulatory change initiator
85 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -080086enum reg_change_initiator {
87 REGDOM_SET_BY_CORE,
88 REGDOM_SET_BY_USER,
89 REGDOM_SET_BY_DRIVER,
90 REGDOM_SET_BY_COUNTRY_IE,
Dmitry Shmidt97672262014-02-03 13:02:54 -080091 REGDOM_BEACON_HINT,
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -080092};
93
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080094/**
95 * enum reg_type - Regulatory change types
96 */
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -070097enum reg_type {
98 REGDOM_TYPE_UNKNOWN,
99 REGDOM_TYPE_COUNTRY,
100 REGDOM_TYPE_WORLD,
101 REGDOM_TYPE_CUSTOM_WORLD,
102 REGDOM_TYPE_INTERSECTION,
103};
104
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700105/**
Hai Shalom81f62d82019-07-22 12:10:00 -0700106 * struct hostapd_wmm_rule - WMM regulatory rule
107 * @min_cwmin: Lower bound of CW_min value
108 * @min_cwmax: Lower bound of CW_max value
109 * @min_aifs: Lower bound of AIFS value
110 * @max_txop: Upper bound of TXOP, value in units of 32 usec
111 */
112struct hostapd_wmm_rule {
113 int min_cwmin;
114 int min_cwmax;
115 int min_aifs;
116 int max_txop;
117};
118
119/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700120 * struct hostapd_channel_data - Channel information
121 */
122struct hostapd_channel_data {
123 /**
124 * chan - Channel number (IEEE 802.11)
125 */
126 short chan;
127
128 /**
129 * freq - Frequency in MHz
130 */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800131 int freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700132
133 /**
134 * flag - Channel flags (HOSTAPD_CHAN_*)
135 */
136 int flag;
137
138 /**
Hai Shalom74f70d42019-02-11 14:42:39 -0800139 * allowed_bw - Allowed channel width bitmask
140 *
141 * See enum hostapd_chan_width_attr.
142 */
143 u32 allowed_bw;
144
145 /**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -0700146 * max_tx_power - Regulatory transmit power limit in dBm
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700147 */
148 u8 max_tx_power;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -0700149
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800150 /**
151 * survey_list - Linked list of surveys (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -0700152 */
153 struct dl_list survey_list;
154
155 /**
156 * min_nf - Minimum observed noise floor, in dBm, based on all
157 * surveyed channel data
158 */
159 s8 min_nf;
Dmitry Shmidt391c59f2013-09-03 12:16:28 -0700160
161#ifdef CONFIG_ACS
162 /**
163 * interference_factor - Computed interference factor on this
164 * channel (used internally in src/ap/acs.c; driver wrappers do not
165 * need to set this)
166 */
167 long double interference_factor;
168#endif /* CONFIG_ACS */
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -0700169
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800170 /**
171 * dfs_cac_ms - DFS CAC time in milliseconds
172 */
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -0700173 unsigned int dfs_cac_ms;
Hai Shalom81f62d82019-07-22 12:10:00 -0700174
175 /**
176 * wmm_rules_valid - Indicates wmm_rules state
177 */
178 int wmm_rules_valid;
179
180 /**
181 * wmm_rules - WMM regulatory rules
182 */
183 struct hostapd_wmm_rule wmm_rules[WMM_AC_NUM];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700184};
185
Hai Shalomfdcde762020-04-02 11:19:20 -0700186#define HE_MAC_CAPAB_0 0
Hai Shalom81f62d82019-07-22 12:10:00 -0700187#define HE_MAX_MAC_CAPAB_SIZE 6
188#define HE_MAX_PHY_CAPAB_SIZE 11
189#define HE_MAX_MCS_CAPAB_SIZE 12
190#define HE_MAX_PPET_CAPAB_SIZE 25
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800191
192/**
193 * struct he_capabilities - IEEE 802.11ax HE capabilities
194 */
195struct he_capabilities {
196 u8 he_supported;
Hai Shalom81f62d82019-07-22 12:10:00 -0700197 u8 phy_cap[HE_MAX_PHY_CAPAB_SIZE];
198 u8 mac_cap[HE_MAX_MAC_CAPAB_SIZE];
199 u8 mcs[HE_MAX_MCS_CAPAB_SIZE];
200 u8 ppet[HE_MAX_PPET_CAPAB_SIZE];
Hai Shalom899fcc72020-10-19 14:38:18 -0700201 u16 he_6ghz_capa;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800202};
203
Sunil Ravia04bd252022-05-02 22:54:18 -0700204/* struct eht_capabilities - IEEE 802.11be EHT capabilities */
205struct eht_capabilities {
206 bool eht_supported;
207 u16 mac_cap;
208 u8 phy_cap[EHT_PHY_CAPAB_LEN];
209 u8 mcs[EHT_MCS_NSS_CAPAB_LEN];
210 u8 ppet[EHT_PPE_THRESH_CAPAB_LEN];
211};
212
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800213#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -0700214#define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800215
Hai Shalom81f62d82019-07-22 12:10:00 -0700216
217enum ieee80211_op_mode {
218 IEEE80211_MODE_INFRA = 0,
219 IEEE80211_MODE_IBSS = 1,
220 IEEE80211_MODE_AP = 2,
221 IEEE80211_MODE_MESH = 5,
222
223 /* only add new entries before IEEE80211_MODE_NUM */
224 IEEE80211_MODE_NUM
225};
226
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700227/**
Hai Shalomc3565922019-10-28 11:58:20 -0700228 * struct ieee80211_edmg_config - EDMG configuration
229 *
230 * This structure describes most essential parameters needed
231 * for IEEE 802.11ay EDMG configuration
232 *
233 * @channels: Bitmap that indicates the 2.16 GHz channel(s)
234 * that are allowed to be used for transmissions.
235 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
236 * Set to 0 to indicate EDMG not supported.
237 * @bw_config: Channel BW Configuration subfield encodes
238 * the allowed channel bandwidth configurations
239 */
240struct ieee80211_edmg_config {
241 u8 channels;
242 enum edmg_bw_config bw_config;
243};
244
245/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700246 * struct hostapd_hw_modes - Supported hardware mode information
247 */
248struct hostapd_hw_modes {
249 /**
250 * mode - Hardware mode
251 */
252 enum hostapd_hw_mode mode;
253
254 /**
255 * num_channels - Number of entries in the channels array
256 */
257 int num_channels;
258
259 /**
260 * channels - Array of supported channels
261 */
262 struct hostapd_channel_data *channels;
263
264 /**
265 * num_rates - Number of entries in the rates array
266 */
267 int num_rates;
268
269 /**
270 * rates - Array of supported rates in 100 kbps units
271 */
272 int *rates;
273
274 /**
275 * ht_capab - HT (IEEE 802.11n) capabilities
276 */
277 u16 ht_capab;
278
279 /**
280 * mcs_set - MCS (IEEE 802.11n) rate parameters
281 */
282 u8 mcs_set[16];
283
284 /**
285 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
286 */
287 u8 a_mpdu_params;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800288
Dmitry Shmidt04949592012-07-19 12:16:46 -0700289 /**
290 * vht_capab - VHT (IEEE 802.11ac) capabilities
291 */
292 u32 vht_capab;
293
294 /**
295 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
296 */
297 u8 vht_mcs_set[8];
298
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800299 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800300
301 /**
302 * he_capab - HE (IEEE 802.11ax) capabilities
303 */
Hai Shalom81f62d82019-07-22 12:10:00 -0700304 struct he_capabilities he_capab[IEEE80211_MODE_NUM];
Hai Shalomc3565922019-10-28 11:58:20 -0700305
306 /**
307 * This structure describes the most essential parameters needed
308 * for IEEE 802.11ay EDMG configuration.
309 */
310 struct ieee80211_edmg_config edmg;
Sunil Ravia04bd252022-05-02 22:54:18 -0700311
312 /**
313 * eht_capab - EHT (IEEE 802.11be) capabilities
314 */
315 struct eht_capabilities eht_capab[IEEE80211_MODE_NUM];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700316};
317
318
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700319#define IEEE80211_CAP_ESS 0x0001
320#define IEEE80211_CAP_IBSS 0x0002
321#define IEEE80211_CAP_PRIVACY 0x0010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800322#define IEEE80211_CAP_RRM 0x1000
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700323
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800324/* DMG (60 GHz) IEEE 802.11ad */
325/* type - bits 0..1 */
326#define IEEE80211_CAP_DMG_MASK 0x0003
327#define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
328#define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
329#define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
330
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700331#define WPA_SCAN_QUAL_INVALID BIT(0)
332#define WPA_SCAN_NOISE_INVALID BIT(1)
333#define WPA_SCAN_LEVEL_INVALID BIT(2)
334#define WPA_SCAN_LEVEL_DBM BIT(3)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700335#define WPA_SCAN_ASSOCIATED BIT(5)
336
337/**
338 * struct wpa_scan_res - Scan result for an BSS/IBSS
339 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
340 * @bssid: BSSID
341 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
342 * @beacon_int: beacon interval in TUs (host byte order)
343 * @caps: capability information field in host byte order
344 * @qual: signal quality
345 * @noise: noise level
346 * @level: signal level
347 * @tsf: Timestamp
348 * @age: Age of the information in milliseconds (i.e., how many milliseconds
349 * ago the last Beacon or Probe Response frame was received)
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800350 * @est_throughput: Estimated throughput in kbps (this is calculated during
351 * scan result processing if left zero by the driver wrapper)
352 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
Dmitry Shmidt29333592017-01-09 12:27:11 -0800353 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
354 * of TSF of the BSS specified by %tsf_bssid.
355 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
Sunil Ravia04bd252022-05-02 22:54:18 -0700356 * @beacon_newer: Whether the Beacon frame data is known to be newer
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700357 * @ie_len: length of the following IE field in octets
358 * @beacon_ie_len: length of the following Beacon IE field in octets
359 *
360 * This structure is used as a generic format for scan results from the
361 * driver. Each driver interface implementation is responsible for converting
362 * the driver or OS specific scan results into this format.
363 *
364 * If the driver does not support reporting all IEs, the IE data structure is
365 * constructed of the IEs that are available. This field will also need to
366 * include SSID in IE format. All drivers are encouraged to be extended to
367 * report all IEs to make it easier to support future additions.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800368 *
369 * This structure data is followed by ie_len octets of IEs from Probe Response
370 * frame (or if the driver does not indicate source of IEs, these may also be
371 * from Beacon frame). After the first set of IEs, another set of IEs may follow
372 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700373 */
374struct wpa_scan_res {
375 unsigned int flags;
376 u8 bssid[ETH_ALEN];
377 int freq;
378 u16 beacon_int;
379 u16 caps;
380 int qual;
381 int noise;
382 int level;
383 u64 tsf;
384 unsigned int age;
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800385 unsigned int est_throughput;
386 int snr;
Dmitry Shmidt29333592017-01-09 12:27:11 -0800387 u64 parent_tsf;
388 u8 tsf_bssid[ETH_ALEN];
Sunil Ravia04bd252022-05-02 22:54:18 -0700389 bool beacon_newer;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700390 size_t ie_len;
391 size_t beacon_ie_len;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800392 /* Followed by ie_len + beacon_ie_len octets of IE data */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700393};
394
395/**
396 * struct wpa_scan_results - Scan results
397 * @res: Array of pointers to allocated variable length scan result entries
398 * @num: Number of entries in the scan result array
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800399 * @fetch_time: Time when the results were fetched from the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700400 */
401struct wpa_scan_results {
402 struct wpa_scan_res **res;
403 size_t num;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800404 struct os_reltime fetch_time;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700405};
406
407/**
408 * struct wpa_interface_info - Network interface information
409 * @next: Pointer to the next interface or NULL if this is the last one
410 * @ifname: Interface name that can be used with init() or init2()
411 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
412 * not available
413 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
414 * is not an allocated copy, i.e., get_interfaces() caller will not free
415 * this)
416 */
417struct wpa_interface_info {
418 struct wpa_interface_info *next;
419 char *ifname;
420 char *desc;
421 const char *drv_name;
422};
423
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800424#define WPAS_MAX_SCAN_SSIDS 16
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700425
426/**
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800427 * struct wpa_driver_scan_ssid - SSIDs to scan for
428 * @ssid - specific SSID to scan for (ProbeReq)
429 * %NULL or zero-length SSID is used to indicate active scan
430 * with wildcard SSID.
431 * @ssid_len - Length of the SSID in octets
432 */
433struct wpa_driver_scan_ssid {
434 const u8 *ssid;
435 size_t ssid_len;
436};
437
438/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700439 * struct wpa_driver_scan_params - Scan parameters
440 * Data for struct wpa_driver_ops::scan2().
441 */
442struct wpa_driver_scan_params {
443 /**
444 * ssids - SSIDs to scan for
445 */
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800446 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700447
448 /**
449 * num_ssids - Number of entries in ssids array
450 * Zero indicates a request for a passive scan.
451 */
452 size_t num_ssids;
453
454 /**
455 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
456 */
457 const u8 *extra_ies;
458
459 /**
460 * extra_ies_len - Length of extra_ies in octets
461 */
462 size_t extra_ies_len;
463
464 /**
465 * freqs - Array of frequencies to scan or %NULL for all frequencies
466 *
467 * The frequency is set in MHz. The array is zero-terminated.
468 */
469 int *freqs;
470
471 /**
472 * filter_ssids - Filter for reporting SSIDs
473 *
474 * This optional parameter can be used to request the driver wrapper to
475 * filter scan results to include only the specified SSIDs. %NULL
476 * indicates that no filtering is to be done. This can be used to
477 * reduce memory needs for scan results in environments that have large
478 * number of APs with different SSIDs.
479 *
480 * The driver wrapper is allowed to take this allocated buffer into its
481 * own use by setting the pointer to %NULL. In that case, the driver
482 * wrapper is responsible for freeing the buffer with os_free() once it
483 * is not needed anymore.
484 */
485 struct wpa_driver_scan_filter {
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -0700486 u8 ssid[SSID_MAX_LEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700487 size_t ssid_len;
488 } *filter_ssids;
489
490 /**
491 * num_filter_ssids - Number of entries in filter_ssids array
492 */
493 size_t num_filter_ssids;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800494
495 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700496 * filter_rssi - Filter by RSSI
497 *
498 * The driver may filter scan results in firmware to reduce host
499 * wakeups and thereby save power. Specify the RSSI threshold in s32
500 * dBm.
501 */
502 s32 filter_rssi;
503
504 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800505 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
506 *
507 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
508 * Mbps from the support rates element(s) in the Probe Request frames
509 * and not to transmit the frames at any of those rates.
510 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700511 unsigned int p2p_probe:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800512
513 /**
514 * only_new_results - Request driver to report only new results
515 *
516 * This is used to request the driver to report only BSSes that have
517 * been detected after this scan request has been started, i.e., to
518 * flush old cached BSS entries.
519 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700520 unsigned int only_new_results:1;
521
522 /**
523 * low_priority - Requests driver to use a lower scan priority
524 *
525 * This is used to request the driver to use a lower scan priority
526 * if it supports such a thing.
527 */
528 unsigned int low_priority:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800529
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800530 /**
531 * mac_addr_rand - Requests driver to randomize MAC address
532 */
533 unsigned int mac_addr_rand:1;
534
535 /**
536 * mac_addr - MAC address used with randomization. The address cannot be
537 * a multicast one, i.e., bit 0 of byte 0 should not be set.
538 */
Hai Shalomc3565922019-10-28 11:58:20 -0700539 u8 *mac_addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800540
541 /**
542 * mac_addr_mask - MAC address mask used with randomization.
543 *
544 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
545 * the mask should be taken as is from mac_addr. The mask should not
546 * allow the generation of a multicast address, i.e., bit 0 of byte 0
547 * must be set.
548 */
549 const u8 *mac_addr_mask;
550
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800551 /**
552 * sched_scan_plans - Scan plans for scheduled scan
553 *
554 * Each scan plan consists of the number of iterations to scan and the
555 * interval between scans. When a scan plan finishes (i.e., it was run
556 * for the specified number of iterations), the next scan plan is
557 * executed. The scan plans are executed in the order they appear in
558 * the array (lower index first). The last scan plan will run infinitely
559 * (until requested to stop), thus must not specify the number of
560 * iterations. All other scan plans must specify the number of
561 * iterations.
562 */
563 struct sched_scan_plan {
564 u32 interval; /* In seconds */
565 u32 iterations; /* Zero to run infinitely */
566 } *sched_scan_plans;
567
568 /**
569 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
570 */
571 unsigned int sched_scan_plans_num;
572
Dmitry Shmidt9c175262016-03-03 10:20:07 -0800573 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700574 * sched_scan_start_delay - Delay to use before starting the first scan
575 *
576 * Delay (in seconds) before scheduling first scan plan cycle. The
577 * driver may ignore this parameter and start immediately (or at any
578 * other time), if this feature is not supported.
579 */
580 u32 sched_scan_start_delay;
581
582 /**
Dmitry Shmidt9c175262016-03-03 10:20:07 -0800583 * bssid - Specific BSSID to scan for
584 *
585 * This optional parameter can be used to replace the default wildcard
586 * BSSID with a specific BSSID to scan for if results are needed from
587 * only a single BSS.
588 */
589 const u8 *bssid;
590
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800591 /**
592 * scan_cookie - Unique identification representing the scan request
593 *
594 * This scan_cookie carries a unique identification representing the
595 * scan request if the host driver/kernel supports concurrent scan
596 * requests. This cookie is returned from the corresponding driver
597 * interface.
598 *
599 * Note: Unlike other parameters in this structure, scan_cookie is used
600 * only to return information instead of setting parameters for the
601 * scan.
602 */
603 u64 scan_cookie;
604
Dmitry Shmidt29333592017-01-09 12:27:11 -0800605 /**
606 * duration - Dwell time on each channel
607 *
608 * This optional parameter can be used to set the dwell time on each
609 * channel. In TUs.
610 */
611 u16 duration;
612
613 /**
614 * duration_mandatory - Whether the specified duration is mandatory
615 *
616 * If this is set, the duration specified by the %duration field is
617 * mandatory (and the driver should reject the scan request if it is
618 * unable to comply with the specified duration), otherwise it is the
619 * maximum duration and the actual duration may be shorter.
620 */
621 unsigned int duration_mandatory:1;
622
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800623 /**
624 * relative_rssi_set - Whether relative RSSI parameters are set
625 */
626 unsigned int relative_rssi_set:1;
627
628 /**
629 * relative_rssi - Relative RSSI for reporting better BSSs
630 *
631 * Amount of RSSI by which a BSS should be better than the current
632 * connected BSS to report the new BSS to user space.
633 */
634 s8 relative_rssi;
635
636 /**
637 * relative_adjust_band - Band to which RSSI should be adjusted
638 *
639 * The relative_adjust_rssi should be added to the band specified
640 * by relative_adjust_band.
641 */
642 enum set_band relative_adjust_band;
643
644 /**
645 * relative_adjust_rssi - RSSI to be added to relative_adjust_band
646 *
647 * An amount of relative_band_rssi should be added to the BSSs that
648 * belong to the band specified by relative_adjust_band while comparing
649 * with other bands for BSS reporting.
650 */
651 s8 relative_adjust_rssi;
652
Hai Shalomce48b4a2018-09-05 11:41:35 -0700653 /**
654 * oce_scan
655 *
656 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0)
657 * - Accept broadcast Probe Response frame.
658 * - Probe Request frame deferral and suppression.
659 * - Max Channel Time - driver fills FILS request params IE with
660 * Maximum Channel Time.
661 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps.
662 */
663 unsigned int oce_scan:1;
664
Hai Shalomc1a21442022-02-04 13:43:00 -0800665 /**
666 * p2p_include_6ghz - Include 6 GHz channels for P2P full scan
667 *
668 */
669 unsigned int p2p_include_6ghz:1;
670
Sunil8cd6f4d2022-06-28 18:40:46 +0000671 /**
672 * non_coloc_6ghz - Force scanning of non-PSC 6 GHz channels
673 *
674 * If this is set, the driver should scan non-PSC channels from the
675 * scan request even if neighbor reports from 2.4/5 GHz APs did not
676 * report a co-located AP on these channels. The default is to scan
677 * non-PSC channels only if a co-located AP was reported on the channel.
678 */
679 unsigned int non_coloc_6ghz:1;
680
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800681 /*
682 * NOTE: Whenever adding new parameters here, please make sure
683 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
684 * matching changes.
685 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700686};
687
688/**
689 * struct wpa_driver_auth_params - Authentication parameters
690 * Data for struct wpa_driver_ops::authenticate().
691 */
692struct wpa_driver_auth_params {
693 int freq;
694 const u8 *bssid;
695 const u8 *ssid;
696 size_t ssid_len;
697 int auth_alg;
698 const u8 *ie;
699 size_t ie_len;
700 const u8 *wep_key[4];
701 size_t wep_key_len[4];
702 int wep_tx_keyidx;
703 int local_state_change;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800704
705 /**
706 * p2p - Whether this connection is a P2P group
707 */
708 int p2p;
709
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800710 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800711 * auth_data - Additional elements for Authentication frame
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800712 *
713 * This buffer starts with the Authentication transaction sequence
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800714 * number field. If no special handling of such elements is needed, this
715 * pointer is %NULL. This is used with SAE and FILS.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800716 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800717 const u8 *auth_data;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800718
719 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800720 * auth_data_len - Length of auth_data buffer in octets
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800721 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800722 size_t auth_data_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700723};
724
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800725/**
726 * enum wps_mode - WPS mode
727 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700728enum wps_mode {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800729 /**
730 * WPS_MODE_NONE - No WPS provisioning being used
731 */
732 WPS_MODE_NONE,
733
734 /**
735 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
736 */
737 WPS_MODE_OPEN,
738
739 /**
740 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
741 */
742 WPS_MODE_PRIVACY
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700743};
744
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800745/**
746 * struct hostapd_freq_params - Channel parameters
747 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700748struct hostapd_freq_params {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800749 /**
750 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
751 */
752 enum hostapd_hw_mode mode;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700753
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800754 /**
755 * freq - Primary channel center frequency in MHz
756 */
757 int freq;
758
759 /**
760 * channel - Channel number
761 */
762 int channel;
763
764 /**
765 * ht_enabled - Whether HT is enabled
766 */
767 int ht_enabled;
768
769 /**
770 * sec_channel_offset - Secondary channel offset for HT40
771 *
772 * 0 = HT40 disabled,
773 * -1 = HT40 enabled, secondary channel below primary,
774 * 1 = HT40 enabled, secondary channel above primary
775 */
776 int sec_channel_offset;
777
778 /**
779 * vht_enabled - Whether VHT is enabled
780 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700781 int vht_enabled;
782
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800783 /**
Hai Shalom81f62d82019-07-22 12:10:00 -0700784 * he_enabled - Whether HE is enabled
785 */
786 int he_enabled;
787
788 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800789 * center_freq1 - Segment 0 center frequency in MHz
790 *
791 * Valid for both HT and VHT.
792 */
793 int center_freq1;
794
795 /**
796 * center_freq2 - Segment 1 center frequency in MHz
797 *
798 * Non-zero only for bandwidth 80 and an 80+80 channel
799 */
800 int center_freq2;
801
802 /**
803 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
804 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700805 int bandwidth;
Hai Shalomc3565922019-10-28 11:58:20 -0700806
807 /**
808 * This structure describes the most essential parameters needed
809 * for IEEE 802.11ay EDMG configuration.
810 */
811 struct ieee80211_edmg_config edmg;
Sunil Ravia04bd252022-05-02 22:54:18 -0700812
813 /**
814 * radar_background - Whether radar/CAC background is requested
815 */
816 bool radar_background;
817
818 /**
819 * eht_enabled - Whether EHT is enabled
820 */
821 bool eht_enabled;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700822};
823
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700824/**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700825 * struct wpa_driver_sta_auth_params - Authentication parameters
826 * Data for struct wpa_driver_ops::sta_auth().
827 */
828struct wpa_driver_sta_auth_params {
829
830 /**
831 * own_addr - Source address and BSSID for authentication frame
832 */
833 const u8 *own_addr;
834
835 /**
836 * addr - MAC address of the station to associate
837 */
838 const u8 *addr;
839
840 /**
841 * seq - authentication sequence number
842 */
843 u16 seq;
844
845 /**
846 * status - authentication response status code
847 */
848 u16 status;
849
850 /**
851 * ie - authentication frame ie buffer
852 */
853 const u8 *ie;
854
855 /**
856 * len - ie buffer length
857 */
858 size_t len;
859
860 /**
861 * fils_auth - Indicates whether FILS authentication is being performed
862 */
863 int fils_auth;
864
865 /**
866 * fils_anonce - ANonce (required for FILS)
867 */
868 u8 fils_anonce[WPA_NONCE_LEN];
869
870 /**
871 * fils_snonce - SNonce (required for FILS)
872 */
873 u8 fils_snonce[WPA_NONCE_LEN];
874
875 /**
876 * fils_kek - key for encryption (required for FILS)
877 */
878 u8 fils_kek[WPA_KEK_MAX_LEN];
879
880 /**
881 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
882 */
883 size_t fils_kek_len;
884};
885
886/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700887 * struct wpa_driver_associate_params - Association parameters
888 * Data for struct wpa_driver_ops::associate().
889 */
890struct wpa_driver_associate_params {
891 /**
892 * bssid - BSSID of the selected AP
893 * This can be %NULL, if ap_scan=2 mode is used and the driver is
894 * responsible for selecting with which BSS to associate. */
895 const u8 *bssid;
896
897 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800898 * bssid_hint - BSSID of a proposed AP
899 *
900 * This indicates which BSS has been found a suitable candidate for
901 * initial association for drivers that use driver/firmwate-based BSS
902 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
903 * the driver from selecting other BSSes in the ESS.
904 */
905 const u8 *bssid_hint;
906
907 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700908 * ssid - The selected SSID
909 */
910 const u8 *ssid;
911
912 /**
913 * ssid_len - Length of the SSID (1..32)
914 */
915 size_t ssid_len;
916
917 /**
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700918 * freq - channel parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700919 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700920 struct hostapd_freq_params freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700921
922 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800923 * freq_hint - Frequency of the channel the proposed AP is using
924 *
925 * This provides a channel on which a suitable BSS has been found as a
926 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
927 * limit the driver from selecting other channels for
928 * driver/firmware-based BSS selection.
929 */
930 int freq_hint;
931
932 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700933 * bg_scan_period - Background scan period in seconds, 0 to disable
934 * background scan, or -1 to indicate no change to default driver
935 * configuration
936 */
937 int bg_scan_period;
938
939 /**
Dmitry Shmidt2ac5f602014-03-07 10:08:21 -0800940 * beacon_int - Beacon interval for IBSS or 0 to use driver default
941 */
942 int beacon_int;
943
944 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700945 * wpa_ie - WPA information element for (Re)Association Request
946 * WPA information element to be included in (Re)Association
947 * Request (including information element id and length). Use
948 * of this WPA IE is optional. If the driver generates the WPA
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700949 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700950 * key_mgmt_suite to select proper algorithms. In this case,
951 * the driver has to notify wpa_supplicant about the used WPA
952 * IE by generating an event that the interface code will
953 * convert into EVENT_ASSOCINFO data (see below).
954 *
955 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
956 * instead. The driver can determine which version is used by
957 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
958 * WPA2/RSN).
959 *
960 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
961 */
962 const u8 *wpa_ie;
963
964 /**
965 * wpa_ie_len - length of the wpa_ie
966 */
967 size_t wpa_ie_len;
968
969 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800970 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
971 */
972 unsigned int wpa_proto;
973
974 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800975 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700976 *
977 * This is usually ignored if @wpa_ie is used.
978 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800979 unsigned int pairwise_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700980
981 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800982 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700983 *
984 * This is usually ignored if @wpa_ie is used.
985 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800986 unsigned int group_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700987
988 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700989 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
990 *
991 * This is usually ignored if @wpa_ie is used.
992 */
993 unsigned int mgmt_group_suite;
994
995 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800996 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700997 *
998 * This is usually ignored if @wpa_ie is used.
999 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001000 unsigned int key_mgmt_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001001
1002 /**
1003 * auth_alg - Allowed authentication algorithms
1004 * Bit field of WPA_AUTH_ALG_*
1005 */
1006 int auth_alg;
1007
1008 /**
1009 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
1010 */
1011 int mode;
1012
1013 /**
1014 * wep_key - WEP keys for static WEP configuration
1015 */
1016 const u8 *wep_key[4];
1017
1018 /**
1019 * wep_key_len - WEP key length for static WEP configuration
1020 */
1021 size_t wep_key_len[4];
1022
1023 /**
1024 * wep_tx_keyidx - WEP TX key index for static WEP configuration
1025 */
1026 int wep_tx_keyidx;
1027
1028 /**
1029 * mgmt_frame_protection - IEEE 802.11w management frame protection
1030 */
1031 enum mfp_options mgmt_frame_protection;
1032
1033 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001034 * passphrase - RSN passphrase for PSK
1035 *
1036 * This value is made available only for WPA/WPA2-Personal (PSK) and
Hai Shalom74f70d42019-02-11 14:42:39 -08001037 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
1038 * is the 8..63 character ASCII passphrase, if available. Please note
1039 * that this can be %NULL if passphrase was not used to generate the
1040 * PSK. In that case, the psk field must be used to fetch the PSK.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001041 */
1042 const char *passphrase;
1043
1044 /**
1045 * psk - RSN PSK (alternative for passphrase for PSK)
1046 *
1047 * This value is made available only for WPA/WPA2-Personal (PSK) and
Hai Shalom74f70d42019-02-11 14:42:39 -08001048 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
1049 * is the 32-octet (256-bit) PSK, if available. The driver wrapper
1050 * should be prepared to handle %NULL value as an error.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001051 */
1052 const u8 *psk;
1053
1054 /**
1055 * drop_unencrypted - Enable/disable unencrypted frame filtering
1056 *
1057 * Configure the driver to drop all non-EAPOL frames (both receive and
1058 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
1059 * still be allowed for key negotiation.
1060 */
1061 int drop_unencrypted;
1062
1063 /**
1064 * prev_bssid - Previously used BSSID in this ESS
1065 *
1066 * When not %NULL, this is a request to use reassociation instead of
1067 * association.
1068 */
1069 const u8 *prev_bssid;
1070
1071 /**
1072 * wps - WPS mode
1073 *
1074 * If the driver needs to do special configuration for WPS association,
1075 * this variable provides more information on what type of association
Sunil Ravia04bd252022-05-02 22:54:18 -07001076 * is being requested. Most drivers should not need to use this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001077 */
1078 enum wps_mode wps;
1079
1080 /**
1081 * p2p - Whether this connection is a P2P group
1082 */
1083 int p2p;
1084
1085 /**
1086 * uapsd - UAPSD parameters for the network
1087 * -1 = do not change defaults
1088 * AP mode: 1 = enabled, 0 = disabled
1089 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
1090 */
1091 int uapsd;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001092
1093 /**
1094 * fixed_bssid - Whether to force this BSSID in IBSS mode
1095 * 1 = Fix this BSSID and prevent merges.
1096 * 0 = Do not fix BSSID.
1097 */
1098 int fixed_bssid;
1099
1100 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001101 * fixed_freq - Fix control channel in IBSS mode
1102 * 0 = don't fix control channel (default)
1103 * 1 = fix control channel; this prevents IBSS merging with another
1104 * channel
1105 */
1106 int fixed_freq;
1107
1108 /**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001109 * disable_ht - Disable HT (IEEE 802.11n) for this connection
1110 */
1111 int disable_ht;
1112
1113 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001114 * htcaps - HT Capabilities over-rides
1115 *
1116 * Only bits set in the mask will be used, and not all values are used
1117 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
1118 *
1119 * Pointer to struct ieee80211_ht_capabilities.
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001120 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001121 const u8 *htcaps;
1122
1123 /**
1124 * htcaps_mask - HT Capabilities over-rides mask
1125 *
1126 * Pointer to struct ieee80211_ht_capabilities.
1127 */
1128 const u8 *htcaps_mask;
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001129
1130#ifdef CONFIG_VHT_OVERRIDES
1131 /**
1132 * disable_vht - Disable VHT for this connection
1133 */
1134 int disable_vht;
1135
1136 /**
1137 * VHT capability overrides.
1138 */
1139 const struct ieee80211_vht_capabilities *vhtcaps;
1140 const struct ieee80211_vht_capabilities *vhtcaps_mask;
1141#endif /* CONFIG_VHT_OVERRIDES */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001142
Hai Shalomfdcde762020-04-02 11:19:20 -07001143#ifdef CONFIG_HE_OVERRIDES
1144 /**
1145 * disable_he - Disable HE for this connection
1146 */
1147 int disable_he;
1148#endif /* CONFIG_HE_OVERRIDES */
1149
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001150 /**
1151 * req_key_mgmt_offload - Request key management offload for connection
1152 *
1153 * Request key management offload for this connection if the device
1154 * supports it.
1155 */
1156 int req_key_mgmt_offload;
1157
1158 /**
Hai Shalomc3565922019-10-28 11:58:20 -07001159 * req_handshake_offload - Request EAPOL handshake offload
1160 *
1161 * Request EAPOL handshake offload for this connection if the device
1162 * supports it.
1163 */
1164 int req_handshake_offload;
1165
1166 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001167 * Flag for indicating whether this association includes support for
1168 * RRM (Radio Resource Measurements)
1169 */
1170 int rrm_used;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001171
1172 /**
1173 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1174 * AP as usual. Valid for DMG network only.
1175 */
1176 int pbss;
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001177
1178 /**
1179 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1180 */
1181 const u8 *fils_kek;
1182
1183 /**
1184 * fils_kek_len: Length of fils_kek in bytes
1185 */
1186 size_t fils_kek_len;
1187
1188 /**
1189 * fils_nonces - Nonces for FILS association frame protection
1190 * (AES-SIV AAD)
1191 */
1192 const u8 *fils_nonces;
1193
1194 /**
1195 * fils_nonces_len: Length of fils_nonce in bytes
1196 */
1197 size_t fils_nonces_len;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001198
1199 /**
1200 * fils_erp_username - Username part of keyName-NAI
1201 */
1202 const u8 *fils_erp_username;
1203
1204 /**
1205 * fils_erp_username_len - Length of fils_erp_username in bytes
1206 */
1207 size_t fils_erp_username_len;
1208
1209 /**
1210 * fils_erp_realm - Realm/domain name to use in FILS ERP
1211 */
1212 const u8 *fils_erp_realm;
1213
1214 /**
1215 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1216 */
1217 size_t fils_erp_realm_len;
1218
1219 /**
1220 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1221 * messages
1222 */
1223 u16 fils_erp_next_seq_num;
1224
1225 /**
1226 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1227 * specified by fils_erp_username@fils_erp_realm.
1228 */
1229 const u8 *fils_erp_rrk;
1230
1231 /**
1232 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1233 */
1234 size_t fils_erp_rrk_len;
Hai Shalom60840252021-02-19 19:02:11 -08001235
1236 /**
1237 * sae_pwe - SAE mechanism for PWE derivation
1238 * 0 = hunting-and-pecking loop only
1239 * 1 = hash-to-element only
1240 * 2 = both hunting-and-pecking loop and hash-to-element enabled
1241 */
1242 int sae_pwe;
Vinayak Yadawade62409f2022-01-20 12:32:07 +05301243#ifdef CONFIG_DRIVER_NL80211_BRCM
1244 /**
1245 * td_policy - Transition Disable Policy
1246 */
1247 u32 td_policy;
1248#endif /* CONFIG_DRIVER_NL80211_BRCM */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001249};
1250
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001251enum hide_ssid {
1252 NO_SSID_HIDING,
1253 HIDDEN_SSID_ZERO_LEN,
1254 HIDDEN_SSID_ZERO_CONTENTS
1255};
1256
Hai Shalom81f62d82019-07-22 12:10:00 -07001257enum ch_switch_state {
1258 CH_SW_STARTED,
1259 CH_SW_FINISHED
1260};
1261
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001262struct wowlan_triggers {
1263 u8 any;
1264 u8 disconnect;
1265 u8 magic_pkt;
1266 u8 gtk_rekey_failure;
1267 u8 eap_identity_req;
1268 u8 four_way_handshake;
1269 u8 rfkill_release;
1270};
1271
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001272struct wpa_driver_ap_params {
1273 /**
1274 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1275 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001276 u8 *head;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001277
1278 /**
1279 * head_len - Length of the head buffer in octets
1280 */
1281 size_t head_len;
1282
1283 /**
1284 * tail - Beacon tail following TIM IE
1285 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001286 u8 *tail;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001287
1288 /**
1289 * tail_len - Length of the tail buffer in octets
1290 */
1291 size_t tail_len;
1292
1293 /**
1294 * dtim_period - DTIM period
1295 */
1296 int dtim_period;
1297
1298 /**
1299 * beacon_int - Beacon interval
1300 */
1301 int beacon_int;
1302
1303 /**
1304 * basic_rates: -1 terminated array of basic rates in 100 kbps
1305 *
1306 * This parameter can be used to set a specific basic rate set for the
1307 * BSS. If %NULL, default basic rate set is used.
1308 */
1309 int *basic_rates;
1310
1311 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001312 * beacon_rate: Beacon frame data rate
1313 *
1314 * This parameter can be used to set a specific Beacon frame data rate
1315 * for the BSS. The interpretation of this value depends on the
Hai Shalom60840252021-02-19 19:02:11 -08001316 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS,
1317 * HE: HE-MCS). If beacon_rate == 0 and rate_type == 0
1318 * (BEACON_RATE_LEGACY), the default Beacon frame data rate is used.
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001319 */
1320 unsigned int beacon_rate;
1321
1322 /**
Hai Shalom60840252021-02-19 19:02:11 -08001323 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT/HE)
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001324 */
1325 enum beacon_rate_type rate_type;
1326
1327 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001328 * proberesp - Probe Response template
1329 *
1330 * This is used by drivers that reply to Probe Requests internally in
1331 * AP mode and require the full Probe Response template.
1332 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001333 u8 *proberesp;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001334
1335 /**
1336 * proberesp_len - Length of the proberesp buffer in octets
1337 */
1338 size_t proberesp_len;
1339
1340 /**
1341 * ssid - The SSID to use in Beacon/Probe Response frames
1342 */
1343 const u8 *ssid;
1344
1345 /**
1346 * ssid_len - Length of the SSID (1..32)
1347 */
1348 size_t ssid_len;
1349
1350 /**
1351 * hide_ssid - Whether to hide the SSID
1352 */
1353 enum hide_ssid hide_ssid;
1354
1355 /**
1356 * pairwise_ciphers - WPA_CIPHER_* bitfield
1357 */
1358 unsigned int pairwise_ciphers;
1359
1360 /**
1361 * group_cipher - WPA_CIPHER_*
1362 */
1363 unsigned int group_cipher;
1364
1365 /**
1366 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1367 */
1368 unsigned int key_mgmt_suites;
1369
1370 /**
1371 * auth_algs - WPA_AUTH_ALG_* bitfield
1372 */
1373 unsigned int auth_algs;
1374
1375 /**
1376 * wpa_version - WPA_PROTO_* bitfield
1377 */
1378 unsigned int wpa_version;
1379
1380 /**
1381 * privacy - Whether privacy is used in the BSS
1382 */
1383 int privacy;
1384
1385 /**
1386 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1387 *
1388 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1389 * not use the full Beacon template.
1390 */
1391 const struct wpabuf *beacon_ies;
1392
1393 /**
1394 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1395 *
1396 * This is used to add IEs like WPS IE and P2P IE by drivers that
1397 * reply to Probe Request frames internally.
1398 */
1399 const struct wpabuf *proberesp_ies;
1400
1401 /**
1402 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1403 *
1404 * This is used to add IEs like WPS IE by drivers that reply to
1405 * (Re)Association Request frames internally.
1406 */
1407 const struct wpabuf *assocresp_ies;
1408
1409 /**
1410 * isolate - Whether to isolate frames between associated stations
1411 *
1412 * If this is non-zero, the AP is requested to disable forwarding of
1413 * frames between associated stations.
1414 */
1415 int isolate;
1416
1417 /**
1418 * cts_protect - Whether CTS protection is enabled
1419 */
1420 int cts_protect;
1421
1422 /**
1423 * preamble - Whether short preamble is enabled
1424 */
1425 int preamble;
1426
1427 /**
1428 * short_slot_time - Whether short slot time is enabled
1429 *
1430 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1431 * not set (e.g., when 802.11g mode is not in use)
1432 */
1433 int short_slot_time;
1434
1435 /**
1436 * ht_opmode - HT operation mode or -1 if HT not in use
1437 */
1438 int ht_opmode;
1439
1440 /**
1441 * interworking - Whether Interworking is enabled
1442 */
1443 int interworking;
1444
1445 /**
1446 * hessid - Homogeneous ESS identifier or %NULL if not set
1447 */
1448 const u8 *hessid;
1449
1450 /**
1451 * access_network_type - Access Network Type (0..15)
1452 *
1453 * This is used for filtering Probe Request frames when Interworking is
1454 * enabled.
1455 */
1456 u8 access_network_type;
Dmitry Shmidt04949592012-07-19 12:16:46 -07001457
1458 /**
1459 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1460 *
1461 * This is used by driver which advertises this capability.
1462 */
1463 int ap_max_inactivity;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001464
1465 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001466 * ctwindow - Client Traffic Window (in TUs)
1467 */
1468 u8 p2p_go_ctwindow;
1469
1470 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001471 * disable_dgaf - Whether group-addressed frames are disabled
1472 */
1473 int disable_dgaf;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001474
1475 /**
1476 * osen - Whether OSEN security is enabled
1477 */
1478 int osen;
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001479
1480 /**
1481 * freq - Channel parameters for dynamic bandwidth changes
1482 */
1483 struct hostapd_freq_params *freq;
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001484
1485 /**
1486 * reenable - Whether this is to re-enable beaconing
1487 */
1488 int reenable;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001489
1490 /**
1491 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1492 * infrastructure BSS. Valid only for DMG network.
1493 */
1494 int pbss;
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001495
1496 /**
1497 * multicast_to_unicast - Whether to use multicast_to_unicast
1498 *
1499 * If this is non-zero, the AP is requested to perform multicast to
1500 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1501 * 802.1Q). If enabled, such frames are to be sent to each station
1502 * separately, with the DA replaced by their own MAC address rather
1503 * than the group address.
1504 *
1505 * Note that this may break certain expectations of the receiver, such
1506 * as the ability to drop unicast IP packets received within multicast
1507 * L2 frames, or the ability to not send ICMP destination unreachable
1508 * messages for packets received in L2 multicast (which is required,
1509 * but the receiver can't tell the difference if this new option is
1510 * enabled.)
1511 *
1512 * This also doesn't implement the 802.11 DMS (directed multicast
1513 * service).
1514 */
1515 int multicast_to_unicast;
Hai Shalom74f70d42019-02-11 14:42:39 -08001516
1517 /**
1518 * ftm_responder - Whether FTM responder is enabled
1519 */
1520 int ftm_responder;
1521
1522 /**
1523 * lci - Binary data, the content of an LCI report IE with type 8 as
1524 * defined in IEEE Std 802.11-2016, 9.4.2.22.10
1525 */
1526 const struct wpabuf *lci;
1527
1528 /**
1529 * civic - Binary data, the content of a measurement report IE with
1530 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
1531 */
1532 const struct wpabuf *civic;
Hai Shalomc3565922019-10-28 11:58:20 -07001533
1534 /**
Hai Shalom60840252021-02-19 19:02:11 -08001535 * he_spr_ctrl - Spatial Reuse control field of SPR element
Hai Shalomc3565922019-10-28 11:58:20 -07001536 */
Hai Shalom60840252021-02-19 19:02:11 -08001537 u8 he_spr_ctrl;
1538
1539 /**
1540 * he_spr_non_srg_obss_pd_max_offset - Non-SRG Maximum TX power offset
1541 */
1542 u8 he_spr_non_srg_obss_pd_max_offset;
Hai Shalomc3565922019-10-28 11:58:20 -07001543
1544 /**
1545 * he_spr_srg_obss_pd_min_offset - Minimum TX power offset
1546 */
Hai Shalom60840252021-02-19 19:02:11 -08001547 u8 he_spr_srg_obss_pd_min_offset;
Hai Shalomc3565922019-10-28 11:58:20 -07001548
1549 /**
1550 * he_spr_srg_obss_pd_max_offset - Maximum TX power offset
1551 */
Hai Shalom60840252021-02-19 19:02:11 -08001552 u8 he_spr_srg_obss_pd_max_offset;
1553
1554 /**
1555 * he_spr_bss_color_bitmap - BSS color values used by members of the
1556 * SRG.
1557 */
1558 u8 he_spr_bss_color_bitmap[8];
1559
1560 /**
1561 * he_spr_partial_bssid_bitmap - Partial BSSID values used by members
1562 * of the SRG.
1563 */
1564 u8 he_spr_partial_bssid_bitmap[8];
Hai Shalomfdcde762020-04-02 11:19:20 -07001565
1566 /**
1567 * he_bss_color - Whether the BSS Color is disabled
1568 */
1569 int he_bss_color_disabled;
1570
1571 /**
1572 * he_bss_color_partial - The BSS Color AID equation
1573 */
1574 int he_bss_color_partial;
1575
1576 /**
1577 * he_bss_color - The BSS Color of the AP
1578 */
1579 int he_bss_color;
1580
1581 /**
1582 * twt_responder - Whether Target Wait Time responder is enabled
1583 */
1584 int twt_responder;
Hai Shalom60840252021-02-19 19:02:11 -08001585
1586 /**
1587 * sae_pwe - SAE mechanism for PWE derivation
1588 * 0 = hunting-and-pecking loop only
1589 * 1 = hash-to-element only
1590 * 2 = both hunting-and-pecking loop and hash-to-element enabled
1591 */
1592 int sae_pwe;
1593
1594 /**
1595 * FILS Discovery frame minimum interval in TUs
1596 */
1597 u32 fd_min_int;
1598
1599 /**
1600 * FILS Discovery frame maximum interval in TUs (0 = FD frame disabled)
1601 */
1602 u32 fd_max_int;
1603
1604 /**
1605 * FILS Discovery frame template data
1606 */
1607 u8 *fd_frame_tmpl;
1608
1609 /**
1610 * FILS Discovery frame template length
1611 */
1612 size_t fd_frame_tmpl_len;
1613
1614 /**
1615 * Unsolicited broadcast Probe Response interval in TUs
1616 */
1617 unsigned int unsol_bcast_probe_resp_interval;
1618
1619 /**
1620 * Unsolicited broadcast Probe Response template data
1621 */
1622 u8 *unsol_bcast_probe_resp_tmpl;
1623
1624 /**
1625 * Unsolicited broadcast Probe Response template length
1626 */
1627 size_t unsol_bcast_probe_resp_tmpl_len;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001628};
1629
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001630struct wpa_driver_mesh_bss_params {
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001631#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1632#define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1633#define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1634#define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001635#define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010
Hai Shalomc1a21442022-02-04 13:43:00 -08001636#define WPA_DRIVER_MESH_CONF_FLAG_FORWARDING 0x00000020
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001637 /*
1638 * TODO: Other mesh configuration parameters would go here.
1639 * See NL80211_MESHCONF_* for all the mesh config parameters.
1640 */
1641 unsigned int flags;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001642 int auto_plinks;
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001643 int peer_link_timeout;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001644 int max_peer_links;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001645 int rssi_threshold;
Hai Shalomc1a21442022-02-04 13:43:00 -08001646 int forwarding;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001647 u16 ht_opmode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001648};
1649
1650struct wpa_driver_mesh_join_params {
1651 const u8 *meshid;
1652 int meshid_len;
1653 const int *basic_rates;
1654 const u8 *ies;
1655 int ie_len;
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001656 struct hostapd_freq_params freq;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001657 int beacon_int;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001658 int dtim_period;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001659 struct wpa_driver_mesh_bss_params conf;
1660#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1661#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1662#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1663#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1664 unsigned int flags;
Hai Shalom60840252021-02-19 19:02:11 -08001665 bool handle_dfs;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001666};
1667
Hai Shalomfdcde762020-04-02 11:19:20 -07001668struct wpa_driver_set_key_params {
1669 /**
1670 * ifname - Interface name (for multi-SSID/VLAN support) */
1671 const char *ifname;
1672
1673 /**
1674 * alg - Encryption algorithm
1675 *
1676 * (%WPA_ALG_NONE, %WPA_ALG_WEP, %WPA_ALG_TKIP, %WPA_ALG_CCMP,
Hai Shalom4fbc08f2020-05-18 12:37:00 -07001677 * %WPA_ALG_BIP_AES_CMAC_128, %WPA_ALG_GCMP, %WPA_ALG_GCMP_256,
1678 * %WPA_ALG_CCMP_256, %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1679 * %WPA_ALG_BIP_CMAC_256);
Hai Shalomfdcde762020-04-02 11:19:20 -07001680 * %WPA_ALG_NONE clears the key. */
1681 enum wpa_alg alg;
1682
1683 /**
1684 * addr - Address of the peer STA
1685 *
1686 * (BSSID of the current AP when setting pairwise key in station mode),
1687 * ff:ff:ff:ff:ff:ff for broadcast keys, %NULL for default keys that
1688 * are used both for broadcast and unicast; when clearing keys, %NULL
1689 * is used to indicate that both the broadcast-only and default key of
1690 * the specified key index is to be cleared */
1691 const u8 *addr;
1692
1693 /**
1694 * key_idx - Key index
1695 *
1696 * (0..3), usually 0 for unicast keys; 4..5 for IGTK; 6..7 for BIGTK */
1697 int key_idx;
1698
1699 /**
1700 * set_tx - Configure this key as the default Tx key
1701 *
1702 * Only used when driver does not support separate unicast/individual
1703 * key */
1704 int set_tx;
1705
1706 /**
1707 * seq - Sequence number/packet number
1708 *
1709 * seq_len octets, the next packet number to be used for in replay
1710 * protection; configured for Rx keys (in most cases, this is only used
1711 * with broadcast keys and set to zero for unicast keys); %NULL if not
1712 * set */
1713 const u8 *seq;
1714
1715 /**
1716 * seq_len - Length of the seq, depends on the algorithm
1717 *
1718 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets */
1719 size_t seq_len;
1720
1721 /**
1722 * key - Key buffer
1723 *
1724 * TKIP: 16-byte temporal key, 8-byte Tx Mic key, 8-byte Rx Mic Key */
1725 const u8 *key;
1726
1727 /**
1728 * key_len - Length of the key buffer in octets
1729 *
1730 * WEP: 5 or 13, TKIP: 32, CCMP/GCMP: 16, IGTK: 16 */
1731 size_t key_len;
1732
1733 /**
1734 * vlan_id - VLAN index (0..4095) for VLAN offload cases */
1735 int vlan_id;
1736
1737 /**
1738 * key_flag - Additional key flags
1739 *
1740 * %KEY_FLAG_MODIFY
1741 * Set when an already installed key must be updated.
1742 * So far the only use-case is changing RX/TX status for
1743 * pairwise keys. Must not be set when deleting a key.
1744 * %KEY_FLAG_DEFAULT
1745 * Set when the key is also a default key. Must not be set when
1746 * deleting a key.
1747 * %KEY_FLAG_RX
1748 * The key is valid for RX. Must not be set when deleting a key.
1749 * %KEY_FLAG_TX
1750 * The key is valid for TX. Must not be set when deleting a key.
1751 * %KEY_FLAG_GROUP
1752 * The key is a broadcast or group key.
1753 * %KEY_FLAG_PAIRWISE
1754 * The key is a pairwise key.
1755 * %KEY_FLAG_PMK
1756 * The key is a Pairwise Master Key (PMK).
1757 *
1758 * Valid and pre-defined combinations are:
1759 * %KEY_FLAG_GROUP_RX_TX
1760 * WEP key not to be installed as default key.
1761 * %KEY_FLAG_GROUP_RX_TX_DEFAULT
1762 * Default WEP or WPA-NONE key.
1763 * %KEY_FLAG_GROUP_RX
1764 * GTK key valid for RX only.
1765 * %KEY_FLAG_GROUP_TX_DEFAULT
1766 * GTK key valid for TX only, immediately taking over TX.
1767 * %KEY_FLAG_PAIRWISE_RX_TX
1768 * Pairwise key immediately becoming the active pairwise key.
1769 * %KEY_FLAG_PAIRWISE_RX
1770 * Pairwise key not yet valid for TX. (Only usable when Extended
1771 * Key ID is supported by the driver.)
1772 * %KEY_FLAG_PAIRWISE_RX_TX_MODIFY
1773 * Enable TX for a pairwise key installed with
1774 * KEY_FLAG_PAIRWISE_RX.
1775 *
1776 * Not a valid standalone key type but pre-defined to be combined
1777 * with other key_flags:
1778 * %KEY_FLAG_RX_TX
1779 * RX/TX key. */
1780 enum key_flag key_flag;
1781};
1782
Hai Shalom4fbc08f2020-05-18 12:37:00 -07001783enum wpa_driver_if_type {
1784 /**
1785 * WPA_IF_STATION - Station mode interface
1786 */
1787 WPA_IF_STATION,
1788
1789 /**
1790 * WPA_IF_AP_VLAN - AP mode VLAN interface
1791 *
1792 * This interface shares its address and Beacon frame with the main
1793 * BSS.
1794 */
1795 WPA_IF_AP_VLAN,
1796
1797 /**
1798 * WPA_IF_AP_BSS - AP mode BSS interface
1799 *
1800 * This interface has its own address and Beacon frame.
1801 */
1802 WPA_IF_AP_BSS,
1803
1804 /**
1805 * WPA_IF_P2P_GO - P2P Group Owner
1806 */
1807 WPA_IF_P2P_GO,
1808
1809 /**
1810 * WPA_IF_P2P_CLIENT - P2P Client
1811 */
1812 WPA_IF_P2P_CLIENT,
1813
1814 /**
1815 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1816 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1817 */
1818 WPA_IF_P2P_GROUP,
1819
1820 /**
Sunil Ravia04bd252022-05-02 22:54:18 -07001821 * WPA_IF_P2P_DEVICE - P2P Device interface is used to identify the
Hai Shalom4fbc08f2020-05-18 12:37:00 -07001822 * abstracted P2P Device function in the driver
1823 */
1824 WPA_IF_P2P_DEVICE,
1825
1826 /*
1827 * WPA_IF_MESH - Mesh interface
1828 */
1829 WPA_IF_MESH,
1830
1831 /*
1832 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1833 */
1834 WPA_IF_TDLS,
1835
1836 /*
1837 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1838 */
1839 WPA_IF_IBSS,
1840
1841 /*
1842 * WPA_IF_NAN - NAN Device
1843 */
1844 WPA_IF_NAN,
1845
1846 /* keep last */
1847 WPA_IF_MAX
1848};
1849
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001850/**
1851 * struct wpa_driver_capa - Driver capability information
1852 */
1853struct wpa_driver_capa {
1854#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1855#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1856#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1857#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1858#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1859#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1860#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001861#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001862#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1863#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001864#define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
1865#define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
1866#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1867#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1868#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1869#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
Hai Shalom74f70d42019-02-11 14:42:39 -08001870#define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000
Tanmay Garga7fd80d2020-05-18 15:52:44 +05301871#define WPA_DRIVER_CAPA_KEY_MGMT_802_1X_SHA256 0x00020000
1872#define WPA_DRIVER_CAPA_KEY_MGMT_PSK_SHA256 0x00040000
1873#define WPA_DRIVER_CAPA_KEY_MGMT_TPK_HANDSHAKE 0x00080000
1874#define WPA_DRIVER_CAPA_KEY_MGMT_FT_SAE 0x00100000
1875#define WPA_DRIVER_CAPA_KEY_MGMT_FT_802_1X_SHA384 0x00200000
1876#define WPA_DRIVER_CAPA_KEY_MGMT_CCKM 0x00400000
1877#define WPA_DRIVER_CAPA_KEY_MGMT_OSEN 0x00800000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001878 /** Bitfield of supported key management suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001879 unsigned int key_mgmt;
Hai Shalom4fbc08f2020-05-18 12:37:00 -07001880 unsigned int key_mgmt_iftype[WPA_IF_MAX];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001881
1882#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1883#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1884#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1885#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
Dmitry Shmidt04949592012-07-19 12:16:46 -07001886#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001887#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001888#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1889#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1890#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1891#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1892#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1893#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001894#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001895 /** Bitfield of supported cipher suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001896 unsigned int enc;
1897
1898#define WPA_DRIVER_AUTH_OPEN 0x00000001
1899#define WPA_DRIVER_AUTH_SHARED 0x00000002
1900#define WPA_DRIVER_AUTH_LEAP 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001901 /** Bitfield of supported IEEE 802.11 authentication algorithms */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001902 unsigned int auth;
1903
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001904/** Driver generated WPA/RSN IE */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001905#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001906/** Driver needs static WEP key setup after association command */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001907#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001908/** Driver takes care of all DFS operations */
Dmitry Shmidtd11f0192014-03-24 12:09:47 -07001909#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001910/** Driver takes care of RSN 4-way handshake internally; PMK is configured with
Hai Shalomfdcde762020-04-02 11:19:20 -07001911 * struct wpa_driver_ops::set_key using key_flag = KEY_FLAG_PMK */
Hai Shalom74f70d42019-02-11 14:42:39 -08001912#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001913/** Driver is for a wired Ethernet interface */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001914#define WPA_DRIVER_FLAGS_WIRED 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001915/** Driver provides separate commands for authentication and association (SME in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001916 * wpa_supplicant). */
1917#define WPA_DRIVER_FLAGS_SME 0x00000020
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001918/** Driver supports AP mode */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001919#define WPA_DRIVER_FLAGS_AP 0x00000040
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001920/** Driver needs static WEP key setup after association has been completed */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001921#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001922/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001923#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001924/** Driver supports concurrent P2P operations */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001925#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001926/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001927 * Driver uses the initial interface as a dedicated management interface, i.e.,
1928 * it cannot be used for P2P group operations or non-P2P purposes.
1929 */
1930#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001931/** This interface is P2P capable (P2P GO or P2P Client) */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001932#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001933/** Driver supports station and key removal when stopping an AP */
Dmitry Shmidta38abf92014-03-06 13:38:44 -08001934#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001935/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001936 * Driver uses the initial interface for P2P management interface and non-P2P
1937 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1938 * P2P group operations.
1939 */
1940#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001941/**
Hai Shalomc1a21442022-02-04 13:43:00 -08001942 * Driver is known to use valid error codes, i.e., when it indicates that
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001943 * something (e.g., association) fails, there was indeed a failure and the
1944 * operation does not end up getting completed successfully later.
1945 */
Hai Shalomc1a21442022-02-04 13:43:00 -08001946#define WPA_DRIVER_FLAGS_VALID_ERROR_CODES 0x00004000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001947/** Driver supports off-channel TX */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001948#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001949/** Driver indicates TX status events for EAPOL Data frames */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001950#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001951/** Driver indicates TX status events for Deauth/Disassoc frames */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001952#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001953/** Driver supports roaming (BSS selection) in firmware */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001954#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001955/** Driver supports operating as a TDLS peer */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001956#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001957/** Driver requires external TDLS setup/teardown/discovery */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001958#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001959/** Driver indicates support for Probe Response offloading in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001960#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001961/** Driver supports U-APSD in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001962#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001963/** Driver supports inactivity timer in AP mode */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001964#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001965/** Driver expects user space implementation of MLME in AP mode */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001966#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001967/** Driver supports SAE with user space SME */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001968#define WPA_DRIVER_FLAGS_SAE 0x02000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001969/** Driver makes use of OBSS scan mechanism in wpa_supplicant */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001970#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001971/** Driver supports IBSS (Ad-hoc) mode */
Dmitry Shmidt700a1372013-03-15 14:14:44 -07001972#define WPA_DRIVER_FLAGS_IBSS 0x08000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001973/** Driver supports radar detection */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07001974#define WPA_DRIVER_FLAGS_RADAR 0x10000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001975/** Driver supports a dedicated interface for P2P Device */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001976#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001977/** Driver supports QoS Mapping */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001978#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001979/** Driver supports CSA in AP mode */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001980#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001981/** Driver supports mesh */
1982#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1983/** Driver support ACS offload */
1984#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1985/** Driver supports key management offload */
1986#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1987/** Driver supports TDLS channel switching */
1988#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001989/** Driver supports IBSS with HT datarates */
1990#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001991/** Driver supports IBSS with VHT datarates */
1992#define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07001993/** Driver supports automatic band selection */
1994#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001995/** Driver supports simultaneous off-channel operations */
1996#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001997/** Driver supports full AP client state */
1998#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001999/** Driver supports P2P Listen offload */
2000#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08002001/** Driver supports FILS */
2002#define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08002003/** Driver supports Beacon frame TX rate configuration (legacy rates) */
2004#define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
2005/** Driver supports Beacon frame TX rate configuration (HT rates) */
2006#define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
2007/** Driver supports Beacon frame TX rate configuration (VHT rates) */
2008#define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08002009/** Driver supports mgmt_tx with random TX address in non-connected state */
2010#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
2011/** Driver supports mgmt_tx with random TX addr in connected state */
2012#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
2013/** Driver supports better BSS reporting with sched_scan in connected mode */
2014#define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
2015/** Driver supports HE capabilities */
2016#define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002017/** Driver supports FILS shared key offload */
2018#define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
2019/** Driver supports all OCE STA specific mandatory features */
2020#define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
2021/** Driver supports all OCE AP specific mandatory features */
2022#define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
2023/**
2024 * Driver supports all OCE STA-CFON specific mandatory features only.
2025 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
2026 * userspace shall assume that this driver may not support all OCE AP
2027 * functionality but can support only OCE STA-CFON functionality.
2028 */
2029#define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
Roshan Pius3a1667e2018-07-03 15:17:14 -07002030/** Driver supports MFP-optional in the connect command */
2031#define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL
Hai Shalom39ba6fc2019-01-22 12:40:38 -08002032/** Driver is a self-managed regulatory device */
2033#define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL
Hai Shalom74f70d42019-02-11 14:42:39 -08002034/** Driver supports FTM responder functionality */
2035#define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL
2036/** Driver support 4-way handshake offload for WPA-Personal */
2037#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
Hai Shalomb755a2a2020-04-23 21:49:02 -07002038/** Driver supports a separate control port TX for EAPOL frames */
Hai Shalomfdcde762020-04-02 11:19:20 -07002039#define WPA_DRIVER_FLAGS_CONTROL_PORT 0x0400000000000000ULL
2040/** Driver supports VLAN offload */
2041#define WPA_DRIVER_FLAGS_VLAN_OFFLOAD 0x0800000000000000ULL
2042/** Driver supports UPDATE_FT_IES command */
2043#define WPA_DRIVER_FLAGS_UPDATE_FT_IES 0x1000000000000000ULL
2044/** Driver can correctly rekey PTKs without Extended Key ID */
2045#define WPA_DRIVER_FLAGS_SAFE_PTK0_REKEYS 0x2000000000000000ULL
2046/** Driver supports Beacon protection */
2047#define WPA_DRIVER_FLAGS_BEACON_PROTECTION 0x4000000000000000ULL
2048/** Driver supports Extended Key ID */
2049#define WPA_DRIVER_FLAGS_EXTENDED_KEY_ID 0x8000000000000000ULL
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002050 u64 flags;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002051
Hai Shalomb755a2a2020-04-23 21:49:02 -07002052/** Driver supports a separate control port RX for EAPOL frames */
2053#define WPA_DRIVER_FLAGS2_CONTROL_PORT_RX 0x0000000000000001ULL
Hai Shalom899fcc72020-10-19 14:38:18 -07002054/** Driver supports TX status reports for EAPOL frames through control port */
2055#define WPA_DRIVER_FLAGS2_CONTROL_PORT_TX_STATUS 0x0000000000000002ULL
Hai Shalom60840252021-02-19 19:02:11 -08002056/** Driver supports secure LTF */
2057#define WPA_DRIVER_FLAGS2_SEC_LTF 0x0000000000000004ULL
2058/** Driver supports secure RTT measurement exchange */
2059#define WPA_DRIVER_FLAGS2_SEC_RTT 0x0000000000000008ULL
2060/**
2061 * Driver supports protection of range negotiation and measurement management
2062 * frames
2063 */
2064#define WPA_DRIVER_FLAGS2_PROT_RANGE_NEG 0x0000000000000010ULL
2065/** Driver supports Beacon frame TX rate configuration (HE rates) */
2066#define WPA_DRIVER_FLAGS2_BEACON_RATE_HE 0x0000000000000020ULL
2067/** Driver supports Beacon protection only in client mode */
2068#define WPA_DRIVER_FLAGS2_BEACON_PROTECTION_CLIENT 0x0000000000000040ULL
2069/** Driver supports Operating Channel Validation */
2070#define WPA_DRIVER_FLAGS2_OCV 0x0000000000000080ULL
2071/** Driver expects user space implementation of SME in AP mode */
2072#define WPA_DRIVER_FLAGS2_AP_SME 0x0000000000000100ULL
Sunil Ravia04bd252022-05-02 22:54:18 -07002073/** Driver handles SA Query procedures in AP mode */
2074#define WPA_DRIVER_FLAGS2_SA_QUERY_OFFLOAD_AP 0x0000000000000200ULL
2075/** Driver supports background radar/CAC detection */
2076#define WPA_DRIVER_RADAR_BACKGROUND 0x0000000000000400ULL
Hai Shalomb755a2a2020-04-23 21:49:02 -07002077 u64 flags2;
2078
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002079#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
2080 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
2081
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002082 unsigned int wmm_ac_supported:1;
2083
2084 unsigned int mac_addr_rand_scan_supported:1;
2085 unsigned int mac_addr_rand_sched_scan_supported:1;
2086
2087 /** Maximum number of supported active probe SSIDs */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002088 int max_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002089
2090 /** Maximum number of supported active probe SSIDs for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002091 int max_sched_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002092
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08002093 /** Maximum number of supported scan plans for scheduled scan */
2094 unsigned int max_sched_scan_plans;
2095
2096 /** Maximum interval in a scan plan. In seconds */
2097 u32 max_sched_scan_plan_interval;
2098
2099 /** Maximum number of iterations in a single scan plan */
2100 u32 max_sched_scan_plan_iterations;
2101
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002102 /** Whether sched_scan (offloaded scanning) is supported */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002103 int sched_scan_supported;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002104
2105 /** Maximum number of supported match sets for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002106 int max_match_sets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002107
2108 /**
2109 * max_remain_on_chan - Maximum remain-on-channel duration in msec
2110 */
2111 unsigned int max_remain_on_chan;
2112
2113 /**
2114 * max_stations - Maximum number of associated stations the driver
2115 * supports in AP mode
2116 */
2117 unsigned int max_stations;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002118
2119 /**
2120 * probe_resp_offloads - Bitmap of supported protocols by the driver
2121 * for Probe Response offloading.
2122 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002123/** Driver Probe Response offloading support for WPS ver. 1 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002124#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002125/** Driver Probe Response offloading support for WPS ver. 2 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002126#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002127/** Driver Probe Response offloading support for P2P */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002128#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002129/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002130#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
2131 unsigned int probe_resp_offloads;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07002132
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002133 unsigned int max_acl_mac_addrs;
2134
Dmitry Shmidt444d5672013-04-01 13:08:44 -07002135 /**
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07002136 * Number of supported concurrent channels
2137 */
2138 unsigned int num_multichan_concurrent;
2139
2140 /**
Dmitry Shmidt444d5672013-04-01 13:08:44 -07002141 * extended_capa - extended capabilities in driver/device
2142 *
2143 * Must be allocated and freed by driver and the pointers must be
2144 * valid for the lifetime of the driver, i.e., freed in deinit()
2145 */
2146 const u8 *extended_capa, *extended_capa_mask;
2147 unsigned int extended_capa_len;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07002148
2149 struct wowlan_triggers wowlan_triggers;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002150
2151/** Driver adds the DS Params Set IE in Probe Request frames */
2152#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
2153/** Driver adds the WFA TPC IE in Probe Request frames */
2154#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
2155/** Driver handles quiet period requests */
2156#define WPA_DRIVER_FLAGS_QUIET 0x00000004
2157/**
2158 * Driver is capable of inserting the current TX power value into the body of
2159 * transmitted frames.
2160 * Background: Some Action frames include a TPC Report IE. This IE contains a
2161 * TX power field, which has to be updated by lower layers. One such Action
2162 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
2163 * of spectrum management). Note that this insertion takes place at a fixed
2164 * offset, namely the 6th byte in the Action frame body.
2165 */
2166#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
Dmitry Shmidt849734c2016-05-27 09:59:01 -07002167/**
2168 * Driver supports RRM. With this support, the driver will accept to use RRM in
2169 * (Re)Association Request frames, without supporting quiet period.
2170 */
2171#define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
2172
Dmitry Shmidt29333592017-01-09 12:27:11 -08002173/** Driver supports setting the scan dwell time */
2174#define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
2175/** Driver supports Beacon Report Measurement */
2176#define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
2177
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002178 u32 rrm_flags;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002179
2180 /* Driver concurrency capabilities */
2181 unsigned int conc_capab;
2182 /* Maximum number of concurrent channels on 2.4 GHz */
2183 unsigned int max_conc_chan_2_4;
2184 /* Maximum number of concurrent channels on 5 GHz */
2185 unsigned int max_conc_chan_5_0;
2186
2187 /* Maximum number of supported CSA counters */
2188 u16 max_csa_counters;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002189};
2190
2191
2192struct hostapd_data;
2193
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002194#define STA_DRV_DATA_TX_MCS BIT(0)
2195#define STA_DRV_DATA_RX_MCS BIT(1)
2196#define STA_DRV_DATA_TX_VHT_MCS BIT(2)
2197#define STA_DRV_DATA_RX_VHT_MCS BIT(3)
2198#define STA_DRV_DATA_TX_VHT_NSS BIT(4)
2199#define STA_DRV_DATA_RX_VHT_NSS BIT(5)
2200#define STA_DRV_DATA_TX_SHORT_GI BIT(6)
2201#define STA_DRV_DATA_RX_SHORT_GI BIT(7)
Roshan Pius3a1667e2018-07-03 15:17:14 -07002202#define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
Hai Shalomc1a21442022-02-04 13:43:00 -08002203#define STA_DRV_DATA_CONN_TIME BIT(9)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002204
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002205struct hostap_sta_driver_data {
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002206 unsigned long rx_packets, tx_packets;
2207 unsigned long long rx_bytes, tx_bytes;
Hai Shalom81f62d82019-07-22 12:10:00 -07002208 unsigned long long rx_airtime, tx_airtime;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002209 int bytes_64bit; /* whether 64-bit byte counters are supported */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002210 unsigned long current_tx_rate;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002211 unsigned long current_rx_rate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002212 unsigned long inactive_msec;
Hai Shalomc1a21442022-02-04 13:43:00 -08002213 unsigned long connected_sec;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002214 unsigned long flags; /* bitfield of STA_DRV_DATA_* */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002215 unsigned long num_ps_buf_frames;
2216 unsigned long tx_retry_failed;
2217 unsigned long tx_retry_count;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002218 s8 last_ack_rssi;
Hai Shalom81f62d82019-07-22 12:10:00 -07002219 unsigned long backlog_packets;
2220 unsigned long backlog_bytes;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002221 s8 signal;
2222 u8 rx_vhtmcs;
2223 u8 tx_vhtmcs;
2224 u8 rx_mcs;
2225 u8 tx_mcs;
2226 u8 rx_vht_nss;
2227 u8 tx_vht_nss;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002228};
2229
2230struct hostapd_sta_add_params {
2231 const u8 *addr;
2232 u16 aid;
2233 u16 capability;
2234 const u8 *supp_rates;
2235 size_t supp_rates_len;
2236 u16 listen_interval;
2237 const struct ieee80211_ht_capabilities *ht_capabilities;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08002238 const struct ieee80211_vht_capabilities *vht_capabilities;
Dmitry Shmidtbd14a572014-02-18 10:33:49 -08002239 int vht_opmode_enabled;
2240 u8 vht_opmode;
Hai Shalom81f62d82019-07-22 12:10:00 -07002241 const struct ieee80211_he_capabilities *he_capab;
2242 size_t he_capab_len;
Hai Shalom4fbc08f2020-05-18 12:37:00 -07002243 const struct ieee80211_he_6ghz_band_cap *he_6ghz_capab;
Sunil Ravia04bd252022-05-02 22:54:18 -07002244 const struct ieee80211_eht_capabilities *eht_capab;
2245 size_t eht_capab_len;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002246 u32 flags; /* bitmask of WPA_STA_* flags */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002247 u32 flags_mask; /* unset bits in flags */
2248#ifdef CONFIG_MESH
2249 enum mesh_plink_state plink_state;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07002250 u16 peer_aid;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002251#endif /* CONFIG_MESH */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002252 int set; /* Set STA parameters instead of add */
2253 u8 qosinfo;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08002254 const u8 *ext_capab;
2255 size_t ext_capab_len;
Dmitry Shmidt344abd32014-01-14 13:17:00 -08002256 const u8 *supp_channels;
2257 size_t supp_channels_len;
2258 const u8 *supp_oper_classes;
2259 size_t supp_oper_classes_len;
Dmitry Shmidt849734c2016-05-27 09:59:01 -07002260 int support_p2p_ps;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002261};
2262
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002263struct mac_address {
2264 u8 addr[ETH_ALEN];
2265};
2266
2267struct hostapd_acl_params {
2268 u8 acl_policy;
2269 unsigned int num_mac_acl;
2270 struct mac_address mac_acl[0];
2271};
2272
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002273struct wpa_init_params {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002274 void *global_priv;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002275 const u8 *bssid;
2276 const char *ifname;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002277 const char *driver_params;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002278 int use_pae_group_addr;
2279 char **bridge;
2280 size_t num_bridge;
2281
2282 u8 *own_addr; /* buffer for writing own MAC address */
2283};
2284
2285
2286struct wpa_bss_params {
2287 /** Interface name (for multi-SSID/VLAN support) */
2288 const char *ifname;
2289 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
2290 int enabled;
2291
2292 int wpa;
2293 int ieee802_1x;
2294 int wpa_group;
2295 int wpa_pairwise;
2296 int wpa_key_mgmt;
2297 int rsn_preauth;
2298 enum mfp_options ieee80211w;
2299};
2300
2301#define WPA_STA_AUTHORIZED BIT(0)
2302#define WPA_STA_WMM BIT(1)
2303#define WPA_STA_SHORT_PREAMBLE BIT(2)
2304#define WPA_STA_MFP BIT(3)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002305#define WPA_STA_TDLS_PEER BIT(4)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002306#define WPA_STA_AUTHENTICATED BIT(5)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002307#define WPA_STA_ASSOCIATED BIT(6)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002308
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002309enum tdls_oper {
2310 TDLS_DISCOVERY_REQ,
2311 TDLS_SETUP,
2312 TDLS_TEARDOWN,
2313 TDLS_ENABLE_LINK,
2314 TDLS_DISABLE_LINK,
2315 TDLS_ENABLE,
2316 TDLS_DISABLE
2317};
2318
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002319enum wnm_oper {
2320 WNM_SLEEP_ENTER_CONFIRM,
2321 WNM_SLEEP_ENTER_FAIL,
2322 WNM_SLEEP_EXIT_CONFIRM,
2323 WNM_SLEEP_EXIT_FAIL,
2324 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
2325 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
2326 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
2327 * a STA */
2328 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
2329 * for a STA */
2330 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
2331 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
2332 * for a STA */
2333 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
2334};
2335
Roshan Pius3a1667e2018-07-03 15:17:14 -07002336/* enum smps_mode - SMPS mode definitions */
2337enum smps_mode {
2338 SMPS_AUTOMATIC,
2339 SMPS_OFF,
2340 SMPS_DYNAMIC,
2341 SMPS_STATIC,
2342
2343 /* Keep last */
2344 SMPS_INVALID,
2345};
2346
Hai Shalom74f70d42019-02-11 14:42:39 -08002347#define WPA_INVALID_NOISE 9999
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002348
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002349/**
2350 * struct wpa_signal_info - Information about channel signal quality
Hai Shalom74f70d42019-02-11 14:42:39 -08002351 * @frequency: control frequency
2352 * @above_threshold: true if the above threshold was crossed
2353 * (relevant for a CQM event)
2354 * @current_signal: in dBm
2355 * @avg_signal: in dBm
2356 * @avg_beacon_signal: in dBm
2357 * @current_noise: %WPA_INVALID_NOISE if not supported
2358 * @current_txrate: current TX rate
2359 * @chanwidth: channel width
2360 * @center_frq1: center frequency for the first segment
2361 * @center_frq2: center frequency for the second segment (if relevant)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002362 */
2363struct wpa_signal_info {
2364 u32 frequency;
2365 int above_threshold;
2366 int current_signal;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002367 int avg_signal;
Dmitry Shmidtf73259c2015-03-17 11:00:54 -07002368 int avg_beacon_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002369 int current_noise;
2370 int current_txrate;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002371 enum chan_width chanwidth;
2372 int center_frq1;
2373 int center_frq2;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002374};
2375
2376/**
Hai Shalom74f70d42019-02-11 14:42:39 -08002377 * struct wpa_channel_info - Information about the current channel
2378 * @frequency: Center frequency of the primary 20 MHz channel
2379 * @chanwidth: Width of the current operating channel
2380 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
2381 * This field is only filled in when using a 40 MHz channel.
2382 * @center_frq1: Center frequency of frequency segment 0
2383 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
2384 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
2385 * derived from center_frq2 for convenience.
2386 */
2387struct wpa_channel_info {
2388 u32 frequency;
2389 enum chan_width chanwidth;
2390 int sec_channel;
2391 int center_frq1;
2392 int center_frq2;
2393 u8 seg1_idx;
2394};
2395
2396/**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002397 * struct beacon_data - Beacon data
2398 * @head: Head portion of Beacon frame (before TIM IE)
2399 * @tail: Tail portion of Beacon frame (after TIM IE)
2400 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2401 * @proberesp_ies: Extra information element(s) to add into Probe Response
2402 * frames or %NULL
2403 * @assocresp_ies: Extra information element(s) to add into (Re)Association
2404 * Response frames or %NULL
2405 * @probe_resp: Probe Response frame template
2406 * @head_len: Length of @head
2407 * @tail_len: Length of @tail
2408 * @beacon_ies_len: Length of beacon_ies in octets
2409 * @proberesp_ies_len: Length of proberesp_ies in octets
2410 * @proberesp_ies_len: Length of proberesp_ies in octets
2411 * @probe_resp_len: Length of probe response template (@probe_resp)
2412 */
2413struct beacon_data {
2414 u8 *head, *tail;
2415 u8 *beacon_ies;
2416 u8 *proberesp_ies;
2417 u8 *assocresp_ies;
2418 u8 *probe_resp;
2419
2420 size_t head_len, tail_len;
2421 size_t beacon_ies_len;
2422 size_t proberesp_ies_len;
2423 size_t assocresp_ies_len;
2424 size_t probe_resp_len;
2425};
2426
2427/**
2428 * struct csa_settings - Settings for channel switch command
2429 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2430 * @block_tx: 1 - block transmission for CSA period
2431 * @freq_params: Next channel frequency parameter
2432 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2433 * @beacon_after: Next beacon/probe resp/asooc resp info
2434 * @counter_offset_beacon: Offset to the count field in beacon's tail
2435 * @counter_offset_presp: Offset to the count field in probe resp.
2436 */
2437struct csa_settings {
2438 u8 cs_count;
2439 u8 block_tx;
2440
2441 struct hostapd_freq_params freq_params;
2442 struct beacon_data beacon_csa;
2443 struct beacon_data beacon_after;
2444
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002445 u16 counter_offset_beacon[2];
2446 u16 counter_offset_presp[2];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002447};
2448
Sunil Ravia04bd252022-05-02 22:54:18 -07002449/**
2450 * struct cca_settings - Settings for color switch command
2451 * @cca_count: Count in Beacon frames (TBTT) to perform the switch
2452 * @cca_color: The new color that we are switching to
2453 * @beacon_cca: Beacon/Probe Response/(Re)Association Response frame info for
2454 * color switch period
2455 * @beacon_after: Next Beacon/Probe Response/(Re)Association Response frame info
2456 * @counter_offset_beacon: Offset to the count field in Beacon frame tail
2457 * @counter_offset_presp: Offset to the count field in Probe Response frame
2458 */
2459struct cca_settings {
2460 u8 cca_count;
2461 u8 cca_color;
2462
2463 struct beacon_data beacon_cca;
2464 struct beacon_data beacon_after;
2465
2466 u16 counter_offset_beacon;
2467 u16 counter_offset_presp;
2468};
2469
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002470/* TDLS peer capabilities for send_tdls_mgmt() */
2471enum tdls_peer_capability {
2472 TDLS_PEER_HT = BIT(0),
2473 TDLS_PEER_VHT = BIT(1),
2474 TDLS_PEER_WMM = BIT(2),
Hai Shalomc1a21442022-02-04 13:43:00 -08002475 TDLS_PEER_HE = BIT(3),
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002476};
2477
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002478/* valid info in the wmm_params struct */
2479enum wmm_params_valid_info {
2480 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
2481};
2482
2483/**
2484 * struct wmm_params - WMM parameterss configured for this association
2485 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2486 * of the struct contain valid information.
2487 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2488 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2489 */
2490struct wmm_params {
2491 u8 info_bitmap;
2492 u8 uapsd_queues;
2493};
2494
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002495#ifdef CONFIG_MACSEC
2496struct macsec_init_params {
Hai Shalome21d4e82020-04-29 16:34:06 -07002497 bool always_include_sci;
2498 bool use_es;
2499 bool use_scb;
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002500};
2501#endif /* CONFIG_MACSEC */
2502
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002503enum drv_br_port_attr {
2504 DRV_BR_PORT_ATTR_PROXYARP,
2505 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
2506};
2507
2508enum drv_br_net_param {
2509 DRV_BR_NET_PARAM_GARP_ACCEPT,
Dmitry Shmidt83474442015-04-15 13:47:09 -07002510 DRV_BR_MULTICAST_SNOOPING,
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002511};
2512
2513struct drv_acs_params {
2514 /* Selected mode (HOSTAPD_MODE_*) */
2515 enum hostapd_hw_mode hw_mode;
2516
2517 /* Indicates whether HT is enabled */
2518 int ht_enabled;
2519
2520 /* Indicates whether HT40 is enabled */
2521 int ht40_enabled;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07002522
2523 /* Indicates whether VHT is enabled */
2524 int vht_enabled;
2525
2526 /* Configured ACS channel width */
2527 u16 ch_width;
2528
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08002529 /* ACS frequency list info */
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002530 const int *freq_list;
Hai Shalomfdcde762020-04-02 11:19:20 -07002531
2532 /* Indicates whether EDMG is enabled */
2533 int edmg_enabled;
Sunil Ravia04bd252022-05-02 22:54:18 -07002534
2535 /* Indicates whether EHT is enabled */
2536 bool eht_enabled;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002537};
2538
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002539struct wpa_bss_trans_info {
2540 u8 mbo_transition_reason;
2541 u8 n_candidates;
2542 u8 *bssid;
2543};
2544
2545struct wpa_bss_candidate_info {
2546 u8 num;
2547 struct candidate_list {
2548 u8 bssid[ETH_ALEN];
2549 u8 is_accept;
2550 u32 reject_reason;
2551 } *candidates;
2552};
2553
2554struct wpa_pmkid_params {
2555 const u8 *bssid;
2556 const u8 *ssid;
2557 size_t ssid_len;
2558 const u8 *fils_cache_id;
2559 const u8 *pmkid;
2560 const u8 *pmk;
2561 size_t pmk_len;
Hai Shalomfdcde762020-04-02 11:19:20 -07002562 u32 pmk_lifetime;
2563 u8 pmk_reauth_threshold;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002564};
2565
2566/* Mask used to specify which connection parameters have to be updated */
2567enum wpa_drv_update_connect_params_mask {
2568 WPA_DRV_UPDATE_ASSOC_IES = BIT(0),
2569 WPA_DRV_UPDATE_FILS_ERP_INFO = BIT(1),
2570 WPA_DRV_UPDATE_AUTH_TYPE = BIT(2),
Vinayak Yadawade62409f2022-01-20 12:32:07 +05302571#ifdef CONFIG_DRIVER_NL80211_BRCM
2572 WPA_DRV_UPDATE_TD_POLICY = BIT(3),
2573#endif /* CONFIG_DRIVER_NL80211_BRCM */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002574};
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002575
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002576/**
Roshan Pius3a1667e2018-07-03 15:17:14 -07002577 * struct external_auth - External authentication trigger parameters
2578 *
2579 * These are used across the external authentication request and event
2580 * interfaces.
2581 * @action: Action type / trigger for external authentication. Only significant
2582 * for the event interface.
2583 * @bssid: BSSID of the peer with which the authentication has to happen. Used
2584 * by both the request and event interface.
2585 * @ssid: SSID of the AP. Used by both the request and event interface.
2586 * @ssid_len: SSID length in octets.
2587 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2588 * the request interface.
2589 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2590 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2591 * the real status code for failures. Used only for the request interface
2592 * from user space to the driver.
Hai Shalom5f92bc92019-04-18 11:54:11 -07002593 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
Roshan Pius3a1667e2018-07-03 15:17:14 -07002594 */
2595struct external_auth {
2596 enum {
2597 EXT_AUTH_START,
2598 EXT_AUTH_ABORT,
2599 } action;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002600 const u8 *bssid;
2601 const u8 *ssid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002602 size_t ssid_len;
2603 unsigned int key_mgmt_suite;
2604 u16 status;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002605 const u8 *pmkid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002606};
2607
Hai Shalom60840252021-02-19 19:02:11 -08002608/* enum nested_attr - Used to specify if subcommand uses nested attributes */
2609enum nested_attr {
2610 NESTED_ATTR_NOT_USED = 0,
2611 NESTED_ATTR_USED = 1,
2612 NESTED_ATTR_UNSPECIFIED = 2,
2613};
2614
Sunil8cd6f4d2022-06-28 18:40:46 +00002615/* Preferred channel list information */
2616
2617/* GO role */
2618#define WEIGHTED_PCL_GO BIT(0)
2619/* P2P Client role */
2620#define WEIGHTED_PCL_CLI BIT(1)
2621/* Must be considered for operating channel */
2622#define WEIGHTED_PCL_MUST_CONSIDER BIT(2)
2623/* Should be excluded in GO negotiation */
2624#define WEIGHTED_PCL_EXCLUDE BIT(3)
2625
2626/* Preferred channel list with weight */
2627struct weighted_pcl {
2628 u32 freq; /* MHz */
2629 u8 weight;
2630 u32 flag; /* bitmap for WEIGHTED_PCL_* */
2631};
2632
Roshan Pius3a1667e2018-07-03 15:17:14 -07002633/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002634 * struct wpa_driver_ops - Driver interface API definition
2635 *
2636 * This structure defines the API that each driver interface needs to implement
2637 * for core wpa_supplicant code. All driver specific functionality is captured
2638 * in this wrapper.
2639 */
2640struct wpa_driver_ops {
2641 /** Name of the driver interface */
2642 const char *name;
2643 /** One line description of the driver interface */
2644 const char *desc;
2645
2646 /**
2647 * get_bssid - Get the current BSSID
2648 * @priv: private driver interface data
2649 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2650 *
2651 * Returns: 0 on success, -1 on failure
2652 *
2653 * Query kernel driver for the current BSSID and copy it to bssid.
2654 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2655 * associated.
2656 */
2657 int (*get_bssid)(void *priv, u8 *bssid);
2658
2659 /**
2660 * get_ssid - Get the current SSID
2661 * @priv: private driver interface data
2662 * @ssid: buffer for SSID (at least 32 bytes)
2663 *
2664 * Returns: Length of the SSID on success, -1 on failure
2665 *
2666 * Query kernel driver for the current SSID and copy it to ssid.
2667 * Returning zero is recommended if the STA is not associated.
2668 *
2669 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2670 * can, at least in theory, contain control characters (including nul)
2671 * and as such, should be processed as binary data, not a printable
2672 * string.
2673 */
2674 int (*get_ssid)(void *priv, u8 *ssid);
2675
2676 /**
2677 * set_key - Configure encryption key
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002678 * @priv: private driver interface data
Hai Shalomfdcde762020-04-02 11:19:20 -07002679 * @params: Key parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002680 * Returns: 0 on success, -1 on failure
2681 *
2682 * Configure the given key for the kernel driver. If the driver
2683 * supports separate individual keys (4 default keys + 1 individual),
2684 * addr can be used to determine whether the key is default or
2685 * individual. If only 4 keys are supported, the default key with key
2686 * index 0 is used as the individual key. STA must be configured to use
2687 * it as the default Tx key (set_tx is set) and accept Rx for all the
2688 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2689 * broadcast keys, so key index 0 is available for this kind of
2690 * configuration.
2691 *
2692 * Please note that TKIP keys include separate TX and RX MIC keys and
2693 * some drivers may expect them in different order than wpa_supplicant
2694 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
2695 * will trigger Michael MIC errors. This can be fixed by changing the
Sunil Ravia04bd252022-05-02 22:54:18 -07002696 * order of MIC keys by swapping the bytes 16..23 and 24..31 of the key
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002697 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2698 * example on how this can be done.
2699 */
Hai Shalomfdcde762020-04-02 11:19:20 -07002700 int (*set_key)(void *priv, struct wpa_driver_set_key_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002701
2702 /**
2703 * init - Initialize driver interface
2704 * @ctx: context to be used when calling wpa_supplicant functions,
2705 * e.g., wpa_supplicant_event()
2706 * @ifname: interface name, e.g., wlan0
2707 *
2708 * Returns: Pointer to private data, %NULL on failure
2709 *
2710 * Initialize driver interface, including event processing for kernel
2711 * driver events (e.g., associated, scan results, Michael MIC failure).
2712 * This function can allocate a private configuration data area for
2713 * @ctx, file descriptor, interface name, etc. information that may be
2714 * needed in future driver operations. If this is not used, non-NULL
2715 * value will need to be returned because %NULL is used to indicate
2716 * failure. The returned value will be used as 'void *priv' data for
2717 * all other driver_ops functions.
2718 *
2719 * The main event loop (eloop.c) of wpa_supplicant can be used to
2720 * register callback for read sockets (eloop_register_read_sock()).
2721 *
2722 * See below for more information about events and
2723 * wpa_supplicant_event() function.
2724 */
2725 void * (*init)(void *ctx, const char *ifname);
2726
2727 /**
2728 * deinit - Deinitialize driver interface
2729 * @priv: private driver interface data from init()
2730 *
2731 * Shut down driver interface and processing of driver events. Free
2732 * private data buffer if one was allocated in init() handler.
2733 */
2734 void (*deinit)(void *priv);
2735
2736 /**
2737 * set_param - Set driver configuration parameters
2738 * @priv: private driver interface data from init()
2739 * @param: driver specific configuration parameters
2740 *
2741 * Returns: 0 on success, -1 on failure
2742 *
2743 * Optional handler for notifying driver interface about configuration
2744 * parameters (driver_param).
2745 */
2746 int (*set_param)(void *priv, const char *param);
2747
2748 /**
2749 * set_countermeasures - Enable/disable TKIP countermeasures
2750 * @priv: private driver interface data
2751 * @enabled: 1 = countermeasures enabled, 0 = disabled
2752 *
2753 * Returns: 0 on success, -1 on failure
2754 *
2755 * Configure TKIP countermeasures. When these are enabled, the driver
2756 * should drop all received and queued frames that are using TKIP.
2757 */
2758 int (*set_countermeasures)(void *priv, int enabled);
2759
2760 /**
2761 * deauthenticate - Request driver to deauthenticate
2762 * @priv: private driver interface data
2763 * @addr: peer address (BSSID of the AP)
2764 * @reason_code: 16-bit reason code to be sent in the deauthentication
2765 * frame
2766 *
2767 * Returns: 0 on success, -1 on failure
2768 */
Hai Shalom81f62d82019-07-22 12:10:00 -07002769 int (*deauthenticate)(void *priv, const u8 *addr, u16 reason_code);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002770
2771 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002772 * associate - Request driver to associate
2773 * @priv: private driver interface data
2774 * @params: association parameters
2775 *
2776 * Returns: 0 on success, -1 on failure
2777 */
2778 int (*associate)(void *priv,
2779 struct wpa_driver_associate_params *params);
2780
2781 /**
2782 * add_pmkid - Add PMKSA cache entry to the driver
2783 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002784 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002785 *
2786 * Returns: 0 on success, -1 on failure
2787 *
2788 * This function is called when a new PMK is received, as a result of
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002789 * either normal authentication or RSN pre-authentication. The PMKSA
2790 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2791 * ssid, fils_cache_id, pmkid, and pmk.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002792 *
2793 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2794 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2795 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2796 * driver_ops function does not need to be implemented. Likewise, if
2797 * the driver does not support WPA, this function is not needed.
2798 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002799 int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002800
2801 /**
2802 * remove_pmkid - Remove PMKSA cache entry to the driver
2803 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002804 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002805 *
2806 * Returns: 0 on success, -1 on failure
2807 *
2808 * This function is called when the supplicant drops a PMKSA cache
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002809 * entry for any reason. The PMKSA parameters are either a set of
2810 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002811 *
2812 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2813 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2814 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2815 * from wpa_supplicant, this driver_ops function does not need to be
2816 * implemented. Likewise, if the driver does not support WPA, this
2817 * function is not needed.
2818 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002819 int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002820
2821 /**
2822 * flush_pmkid - Flush PMKSA cache
2823 * @priv: private driver interface data
2824 *
2825 * Returns: 0 on success, -1 on failure
2826 *
2827 * This function is called when the supplicant drops all PMKSA cache
2828 * entries for any reason.
2829 *
2830 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2831 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2832 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2833 * from wpa_supplicant, this driver_ops function does not need to be
2834 * implemented. Likewise, if the driver does not support WPA, this
2835 * function is not needed.
2836 */
2837 int (*flush_pmkid)(void *priv);
2838
2839 /**
2840 * get_capa - Get driver capabilities
2841 * @priv: private driver interface data
2842 *
2843 * Returns: 0 on success, -1 on failure
2844 *
2845 * Get driver/firmware/hardware capabilities.
2846 */
2847 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
2848
2849 /**
2850 * poll - Poll driver for association information
2851 * @priv: private driver interface data
2852 *
2853 * This is an option callback that can be used when the driver does not
2854 * provide event mechanism for association events. This is called when
2855 * receiving WPA EAPOL-Key messages that require association
2856 * information. The driver interface is supposed to generate associnfo
2857 * event before returning from this callback function. In addition, the
2858 * driver interface should generate an association event after having
2859 * sent out associnfo.
2860 */
2861 void (*poll)(void *priv);
2862
2863 /**
Dmitry Shmidte4663042016-04-04 10:07:49 -07002864 * get_ifindex - Get interface index
2865 * @priv: private driver interface data
2866 *
2867 * Returns: Interface index
2868 */
2869 unsigned int (*get_ifindex)(void *priv);
2870
2871 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002872 * get_ifname - Get interface name
2873 * @priv: private driver interface data
2874 *
2875 * Returns: Pointer to the interface name. This can differ from the
2876 * interface name used in init() call. Init() is called first.
2877 *
2878 * This optional function can be used to allow the driver interface to
2879 * replace the interface name with something else, e.g., based on an
2880 * interface mapping from a more descriptive name.
2881 */
2882 const char * (*get_ifname)(void *priv);
2883
2884 /**
2885 * get_mac_addr - Get own MAC address
2886 * @priv: private driver interface data
2887 *
2888 * Returns: Pointer to own MAC address or %NULL on failure
2889 *
2890 * This optional function can be used to get the own MAC address of the
2891 * device from the driver interface code. This is only needed if the
2892 * l2_packet implementation for the OS does not provide easy access to
2893 * a MAC address. */
2894 const u8 * (*get_mac_addr)(void *priv);
2895
2896 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002897 * set_operstate - Sets device operating state to DORMANT or UP
2898 * @priv: private driver interface data
2899 * @state: 0 = dormant, 1 = up
2900 * Returns: 0 on success, -1 on failure
2901 *
2902 * This is an optional function that can be used on operating systems
2903 * that support a concept of controlling network device state from user
2904 * space applications. This function, if set, gets called with
2905 * state = 1 when authentication has been completed and with state = 0
2906 * when connection is lost.
2907 */
2908 int (*set_operstate)(void *priv, int state);
2909
2910 /**
2911 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2912 * @priv: Private driver interface data
2913 * @addr: Address of the station for which to set protection (may be
2914 * %NULL for group keys)
2915 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2916 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2917 * Returns: 0 on success, -1 on failure
2918 *
2919 * This is an optional function that can be used to set the driver to
2920 * require protection for Tx and/or Rx frames. This uses the layer
2921 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2922 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2923 * set protection operation; instead, they set protection implicitly
2924 * based on configured keys.
2925 */
2926 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2927 int key_type);
2928
2929 /**
2930 * get_hw_feature_data - Get hardware support data (channels and rates)
2931 * @priv: Private driver interface data
2932 * @num_modes: Variable for returning the number of returned modes
2933 * flags: Variable for returning hardware feature flags
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002934 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002935 * Returns: Pointer to allocated hardware data on success or %NULL on
2936 * failure. Caller is responsible for freeing this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002937 */
2938 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2939 u16 *num_modes,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002940 u16 *flags, u8 *dfs);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002941
2942 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002943 * send_mlme - Send management frame from MLME
2944 * @priv: Private driver interface data
2945 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2946 * @data_len: Size of the management frame
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002947 * @noack: Do not wait for this frame to be acked (disable retries)
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07002948 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2949 * driver decide
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002950 * @csa_offs: Array of CSA offsets or %NULL
2951 * @csa_offs_len: Number of elements in csa_offs
Hai Shalomfdcde762020-04-02 11:19:20 -07002952 * @no_encrypt: Do not encrypt frame even if appropriate key exists
2953 * (used only for testing purposes)
2954 * @wait: Time to wait off-channel for a response (in ms), or zero
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002955 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002956 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002957 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002958 int noack, unsigned int freq, const u16 *csa_offs,
Hai Shalomfdcde762020-04-02 11:19:20 -07002959 size_t csa_offs_len, int no_encrypt,
2960 unsigned int wait);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002961
2962 /**
2963 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2964 * @priv: Private driver interface data
2965 * @md: Mobility domain (2 octets) (also included inside ies)
2966 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2967 * @ies_len: Length of FT IEs in bytes
2968 * Returns: 0 on success, -1 on failure
2969 *
2970 * The supplicant uses this callback to let the driver know that keying
2971 * material for FT is available and that the driver can use the
2972 * provided IEs in the next message in FT authentication sequence.
2973 *
2974 * This function is only needed for driver that support IEEE 802.11r
2975 * (Fast BSS Transition).
2976 */
2977 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2978 size_t ies_len);
2979
2980 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002981 * get_scan_results2 - Fetch the latest scan results
2982 * @priv: private driver interface data
2983 *
2984 * Returns: Allocated buffer of scan results (caller is responsible for
2985 * freeing the data structure) on success, NULL on failure
2986 */
2987 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2988
2989 /**
2990 * set_country - Set country
2991 * @priv: Private driver interface data
2992 * @alpha2: country to which to switch to
2993 * Returns: 0 on success, -1 on failure
2994 *
2995 * This function is for drivers which support some form
2996 * of setting a regulatory domain.
2997 */
2998 int (*set_country)(void *priv, const char *alpha2);
2999
3000 /**
Dmitry Shmidtcce06662013-11-04 18:44:24 -08003001 * get_country - Get country
3002 * @priv: Private driver interface data
3003 * @alpha2: Buffer for returning country code (at least 3 octets)
3004 * Returns: 0 on success, -1 on failure
3005 */
3006 int (*get_country)(void *priv, char *alpha2);
3007
3008 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003009 * global_init - Global driver initialization
Dmitry Shmidte4663042016-04-04 10:07:49 -07003010 * @ctx: wpa_global pointer
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003011 * Returns: Pointer to private data (global), %NULL on failure
3012 *
3013 * This optional function is called to initialize the driver wrapper
3014 * for global data, i.e., data that applies to all interfaces. If this
3015 * function is implemented, global_deinit() will also need to be
3016 * implemented to free the private data. The driver will also likely
3017 * use init2() function instead of init() to get the pointer to global
3018 * data available to per-interface initializer.
3019 */
Dmitry Shmidte4663042016-04-04 10:07:49 -07003020 void * (*global_init)(void *ctx);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003021
3022 /**
3023 * global_deinit - Global driver deinitialization
3024 * @priv: private driver global data from global_init()
3025 *
3026 * Terminate any global driver related functionality and free the
3027 * global data structure.
3028 */
3029 void (*global_deinit)(void *priv);
3030
3031 /**
3032 * init2 - Initialize driver interface (with global data)
3033 * @ctx: context to be used when calling wpa_supplicant functions,
3034 * e.g., wpa_supplicant_event()
3035 * @ifname: interface name, e.g., wlan0
3036 * @global_priv: private driver global data from global_init()
3037 * Returns: Pointer to private data, %NULL on failure
3038 *
3039 * This function can be used instead of init() if the driver wrapper
3040 * uses global data.
3041 */
3042 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
3043
3044 /**
3045 * get_interfaces - Get information about available interfaces
3046 * @global_priv: private driver global data from global_init()
3047 * Returns: Allocated buffer of interface information (caller is
3048 * responsible for freeing the data structure) on success, NULL on
3049 * failure
3050 */
3051 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
3052
3053 /**
3054 * scan2 - Request the driver to initiate scan
3055 * @priv: private driver interface data
3056 * @params: Scan parameters
3057 *
3058 * Returns: 0 on success, -1 on failure
3059 *
3060 * Once the scan results are ready, the driver should report scan
3061 * results event for wpa_supplicant which will eventually request the
3062 * results with wpa_driver_get_scan_results2().
3063 */
3064 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
3065
3066 /**
3067 * authenticate - Request driver to authenticate
3068 * @priv: private driver interface data
3069 * @params: authentication parameters
3070 * Returns: 0 on success, -1 on failure
3071 *
3072 * This is an optional function that can be used with drivers that
3073 * support separate authentication and association steps, i.e., when
3074 * wpa_supplicant can act as the SME. If not implemented, associate()
3075 * function is expected to take care of IEEE 802.11 authentication,
3076 * too.
3077 */
3078 int (*authenticate)(void *priv,
3079 struct wpa_driver_auth_params *params);
3080
3081 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003082 * set_ap - Set Beacon and Probe Response information for AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003083 * @priv: Private driver interface data
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003084 * @params: Parameters to use in AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003085 *
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003086 * This function is used to configure Beacon template and/or extra IEs
3087 * to add for Beacon and Probe Response frames for the driver in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003088 * AP mode. The driver is responsible for building the full Beacon
3089 * frame by concatenating the head part with TIM IE generated by the
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003090 * driver/firmware and finishing with the tail part. Depending on the
3091 * driver architectue, this can be done either by using the full
3092 * template or the set of additional IEs (e.g., WPS and P2P IE).
3093 * Similarly, Probe Response processing depends on the driver design.
3094 * If the driver (or firmware) takes care of replying to Probe Request
3095 * frames, the extra IEs provided here needs to be added to the Probe
3096 * Response frames.
3097 *
3098 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003099 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003100 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003101
3102 /**
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07003103 * set_acl - Set ACL in AP mode
3104 * @priv: Private driver interface data
3105 * @params: Parameters to configure ACL
3106 * Returns: 0 on success, -1 on failure
3107 *
3108 * This is used only for the drivers which support MAC address ACL.
3109 */
3110 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
3111
3112 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003113 * hapd_init - Initialize driver interface (hostapd only)
3114 * @hapd: Pointer to hostapd context
3115 * @params: Configuration for the driver wrapper
3116 * Returns: Pointer to private data, %NULL on failure
3117 *
3118 * This function is used instead of init() or init2() when the driver
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003119 * wrapper is used with hostapd.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003120 */
3121 void * (*hapd_init)(struct hostapd_data *hapd,
3122 struct wpa_init_params *params);
3123
3124 /**
3125 * hapd_deinit - Deinitialize driver interface (hostapd only)
3126 * @priv: Private driver interface data from hapd_init()
3127 */
3128 void (*hapd_deinit)(void *priv);
3129
3130 /**
3131 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
3132 * @priv: Private driver interface data
3133 * @params: BSS parameters
3134 * Returns: 0 on success, -1 on failure
3135 *
3136 * This is an optional function to configure the kernel driver to
3137 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
3138 * can be left undefined (set to %NULL) if IEEE 802.1X support is
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003139 * always enabled and the driver uses set_ap() to set WPA/RSN IE
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003140 * for Beacon frames.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003141 *
3142 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003143 */
3144 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
3145
3146 /**
3147 * set_privacy - Enable/disable privacy (AP only)
3148 * @priv: Private driver interface data
3149 * @enabled: 1 = privacy enabled, 0 = disabled
3150 * Returns: 0 on success, -1 on failure
3151 *
3152 * This is an optional function to configure privacy field in the
3153 * kernel driver for Beacon frames. This can be left undefined (set to
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003154 * %NULL) if the driver uses the Beacon template from set_ap().
3155 *
3156 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003157 */
3158 int (*set_privacy)(void *priv, int enabled);
3159
3160 /**
3161 * get_seqnum - Fetch the current TSC/packet number (AP only)
3162 * @ifname: The interface name (main or virtual)
3163 * @priv: Private driver interface data
3164 * @addr: MAC address of the station or %NULL for group keys
3165 * @idx: Key index
3166 * @seq: Buffer for returning the latest used TSC/packet number
3167 * Returns: 0 on success, -1 on failure
3168 *
3169 * This function is used to fetch the last used TSC/packet number for
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07003170 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
3171 * keys, so there is no strict requirement on implementing support for
3172 * unicast keys (i.e., addr != %NULL).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003173 */
3174 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
3175 int idx, u8 *seq);
3176
3177 /**
3178 * flush - Flush all association stations (AP only)
3179 * @priv: Private driver interface data
3180 * Returns: 0 on success, -1 on failure
3181 *
3182 * This function requests the driver to disassociate all associated
3183 * stations. This function does not need to be implemented if the
3184 * driver does not process association frames internally.
3185 */
3186 int (*flush)(void *priv);
3187
3188 /**
3189 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
3190 * @priv: Private driver interface data
3191 * @elem: Information elements
3192 * @elem_len: Length of the elem buffer in octets
3193 * Returns: 0 on success, -1 on failure
3194 *
3195 * This is an optional function to add information elements in the
3196 * kernel driver for Beacon and Probe Response frames. This can be left
3197 * undefined (set to %NULL) if the driver uses the Beacon template from
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003198 * set_ap().
3199 *
3200 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003201 */
3202 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
3203
3204 /**
Jouni Malinen1e6c57f2012-09-05 17:07:03 +03003205 * read_sta_data - Fetch station data
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003206 * @priv: Private driver interface data
3207 * @data: Buffer for returning station information
3208 * @addr: MAC address of the station
3209 * Returns: 0 on success, -1 on failure
3210 */
3211 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
3212 const u8 *addr);
3213
3214 /**
Hai Shalomfdcde762020-04-02 11:19:20 -07003215 * tx_control_port - Send a frame over the 802.1X controlled port
3216 * @priv: Private driver interface data
3217 * @dest: Destination MAC address
3218 * @proto: Ethertype in host byte order
3219 * @buf: Frame payload starting from IEEE 802.1X header
3220 * @len: Frame payload length
3221 * @no_encrypt: Do not encrypt frame
3222 *
3223 * Returns 0 on success, else an error
3224 *
3225 * This is like a normal Ethernet send except that the driver is aware
3226 * (by other means than the Ethertype) that this frame is special,
3227 * and more importantly it gains an ordering between the transmission of
3228 * the frame and other driver management operations such as key
3229 * installations. This can be used to work around known limitations in
3230 * IEEE 802.11 protocols such as race conditions between rekeying 4-way
3231 * handshake message 4/4 and a PTK being overwritten.
3232 *
3233 * This function is only used for a given interface if the driver
3234 * instance reports WPA_DRIVER_FLAGS_CONTROL_PORT capability. Otherwise,
3235 * API users will fall back to sending the frame via a normal socket.
3236 */
3237 int (*tx_control_port)(void *priv, const u8 *dest,
3238 u16 proto, const u8 *buf, size_t len,
3239 int no_encrypt);
3240
3241 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003242 * hapd_send_eapol - Send an EAPOL packet (AP only)
3243 * @priv: private driver interface data
3244 * @addr: Destination MAC address
3245 * @data: EAPOL packet starting with IEEE 802.1X header
3246 * @data_len: Length of the EAPOL packet in octets
3247 * @encrypt: Whether the frame should be encrypted
3248 * @own_addr: Source MAC address
3249 * @flags: WPA_STA_* flags for the destination station
3250 *
3251 * Returns: 0 on success, -1 on failure
3252 */
3253 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
3254 size_t data_len, int encrypt,
3255 const u8 *own_addr, u32 flags);
3256
3257 /**
3258 * sta_deauth - Deauthenticate a station (AP only)
3259 * @priv: Private driver interface data
3260 * @own_addr: Source address and BSSID for the Deauthentication frame
3261 * @addr: MAC address of the station to deauthenticate
3262 * @reason: Reason code for the Deauthentiation frame
3263 * Returns: 0 on success, -1 on failure
3264 *
3265 * This function requests a specific station to be deauthenticated and
3266 * a Deauthentication frame to be sent to it.
3267 */
3268 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07003269 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003270
3271 /**
3272 * sta_disassoc - Disassociate a station (AP only)
3273 * @priv: Private driver interface data
3274 * @own_addr: Source address and BSSID for the Disassociation frame
3275 * @addr: MAC address of the station to disassociate
3276 * @reason: Reason code for the Disassociation frame
3277 * Returns: 0 on success, -1 on failure
3278 *
3279 * This function requests a specific station to be disassociated and
3280 * a Disassociation frame to be sent to it.
3281 */
3282 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07003283 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003284
3285 /**
3286 * sta_remove - Remove a station entry (AP only)
3287 * @priv: Private driver interface data
3288 * @addr: MAC address of the station to be removed
3289 * Returns: 0 on success, -1 on failure
3290 */
3291 int (*sta_remove)(void *priv, const u8 *addr);
3292
3293 /**
3294 * hapd_get_ssid - Get the current SSID (AP only)
3295 * @priv: Private driver interface data
3296 * @buf: Buffer for returning the SSID
3297 * @len: Maximum length of the buffer
3298 * Returns: Length of the SSID on success, -1 on failure
3299 *
3300 * This function need not be implemented if the driver uses Beacon
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003301 * template from set_ap() and does not reply to Probe Request frames.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003302 */
3303 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
3304
3305 /**
3306 * hapd_set_ssid - Set SSID (AP only)
3307 * @priv: Private driver interface data
3308 * @buf: SSID
3309 * @len: Length of the SSID in octets
3310 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003311 *
3312 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003313 */
3314 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
3315
3316 /**
3317 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
3318 * @priv: Private driver interface data
3319 * @enabled: 1 = countermeasures enabled, 0 = disabled
3320 * Returns: 0 on success, -1 on failure
3321 *
3322 * This need not be implemented if the driver does not take care of
3323 * association processing.
3324 */
3325 int (*hapd_set_countermeasures)(void *priv, int enabled);
3326
3327 /**
3328 * sta_add - Add a station entry
3329 * @priv: Private driver interface data
3330 * @params: Station parameters
3331 * Returns: 0 on success, -1 on failure
3332 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08003333 * This function is used to add or set (params->set 1) a station
3334 * entry in the driver. Adding STA entries is used only if the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003335 * does not take care of association processing.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003336 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08003337 * With drivers that don't support full AP client state, this function
3338 * is used to add a station entry to the driver once the station has
3339 * completed association.
3340 *
3341 * With TDLS, this function is used to add or set (params->set 1)
3342 * TDLS peer entries (even with drivers that do not support full AP
3343 * client state).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003344 */
3345 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
3346
3347 /**
3348 * get_inact_sec - Get station inactivity duration (AP only)
3349 * @priv: Private driver interface data
3350 * @addr: Station address
3351 * Returns: Number of seconds station has been inactive, -1 on failure
3352 */
3353 int (*get_inact_sec)(void *priv, const u8 *addr);
3354
3355 /**
3356 * sta_clear_stats - Clear station statistics (AP only)
3357 * @priv: Private driver interface data
3358 * @addr: Station address
3359 * Returns: 0 on success, -1 on failure
3360 */
3361 int (*sta_clear_stats)(void *priv, const u8 *addr);
3362
3363 /**
3364 * set_freq - Set channel/frequency (AP only)
3365 * @priv: Private driver interface data
3366 * @freq: Channel parameters
3367 * Returns: 0 on success, -1 on failure
3368 */
3369 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
3370
3371 /**
3372 * set_rts - Set RTS threshold
3373 * @priv: Private driver interface data
3374 * @rts: RTS threshold in octets
3375 * Returns: 0 on success, -1 on failure
3376 */
3377 int (*set_rts)(void *priv, int rts);
3378
3379 /**
3380 * set_frag - Set fragmentation threshold
3381 * @priv: Private driver interface data
3382 * @frag: Fragmentation threshold in octets
3383 * Returns: 0 on success, -1 on failure
3384 */
3385 int (*set_frag)(void *priv, int frag);
3386
3387 /**
3388 * sta_set_flags - Set station flags (AP only)
3389 * @priv: Private driver interface data
3390 * @addr: Station address
3391 * @total_flags: Bitmap of all WPA_STA_* flags currently set
3392 * @flags_or: Bitmap of WPA_STA_* flags to add
3393 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
3394 * Returns: 0 on success, -1 on failure
3395 */
3396 int (*sta_set_flags)(void *priv, const u8 *addr,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08003397 unsigned int total_flags, unsigned int flags_or,
3398 unsigned int flags_and);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003399
3400 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07003401 * sta_set_airtime_weight - Set station airtime weight (AP only)
3402 * @priv: Private driver interface data
3403 * @addr: Station address
3404 * @weight: New weight for station airtime assignment
3405 * Returns: 0 on success, -1 on failure
3406 */
3407 int (*sta_set_airtime_weight)(void *priv, const u8 *addr,
3408 unsigned int weight);
3409
3410 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003411 * set_tx_queue_params - Set TX queue parameters
3412 * @priv: Private driver interface data
3413 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
3414 * @aifs: AIFS
3415 * @cw_min: cwMin
3416 * @cw_max: cwMax
3417 * @burst_time: Maximum length for bursting in 0.1 msec units
3418 */
3419 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
3420 int cw_max, int burst_time);
3421
3422 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003423 * if_add - Add a virtual interface
3424 * @priv: Private driver interface data
3425 * @type: Interface type
3426 * @ifname: Interface name for the new virtual interface
3427 * @addr: Local address to use for the interface or %NULL to use the
3428 * parent interface address
3429 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
3430 * @drv_priv: Pointer for overwriting the driver context or %NULL if
3431 * not allowed (applies only to %WPA_IF_AP_BSS type)
3432 * @force_ifname: Buffer for returning an interface name that the
3433 * driver ended up using if it differs from the requested ifname
3434 * @if_addr: Buffer for returning the allocated interface address
3435 * (this may differ from the requested addr if the driver cannot
3436 * change interface address)
3437 * @bridge: Bridge interface to use or %NULL if no bridge configured
Dmitry Shmidtcce06662013-11-04 18:44:24 -08003438 * @use_existing: Whether to allow existing interface to be used
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003439 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003440 * Returns: 0 on success, -1 on failure
3441 */
3442 int (*if_add)(void *priv, enum wpa_driver_if_type type,
3443 const char *ifname, const u8 *addr, void *bss_ctx,
3444 void **drv_priv, char *force_ifname, u8 *if_addr,
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003445 const char *bridge, int use_existing, int setup_ap);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003446
3447 /**
3448 * if_remove - Remove a virtual interface
3449 * @priv: Private driver interface data
3450 * @type: Interface type
3451 * @ifname: Interface name of the virtual interface to be removed
3452 * Returns: 0 on success, -1 on failure
3453 */
3454 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
3455 const char *ifname);
3456
3457 /**
3458 * set_sta_vlan - Bind a station into a specific interface (AP only)
3459 * @priv: Private driver interface data
3460 * @ifname: Interface (main or virtual BSS or VLAN)
3461 * @addr: MAC address of the associated station
3462 * @vlan_id: VLAN ID
3463 * Returns: 0 on success, -1 on failure
3464 *
3465 * This function is used to bind a station to a specific virtual
3466 * interface. It is only used if when virtual interfaces are supported,
3467 * e.g., to assign stations to different VLAN interfaces based on
3468 * information from a RADIUS server. This allows separate broadcast
3469 * domains to be used with a single BSS.
3470 */
3471 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
3472 int vlan_id);
3473
3474 /**
3475 * commit - Optional commit changes handler (AP only)
3476 * @priv: driver private data
3477 * Returns: 0 on success, -1 on failure
3478 *
3479 * This optional handler function can be registered if the driver
3480 * interface implementation needs to commit changes (e.g., by setting
3481 * network interface up) at the end of initial configuration. If set,
3482 * this handler will be called after initial setup has been completed.
3483 */
3484 int (*commit)(void *priv);
3485
3486 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003487 * set_radius_acl_auth - Notification of RADIUS ACL change
3488 * @priv: Private driver interface data
3489 * @mac: MAC address of the station
3490 * @accepted: Whether the station was accepted
3491 * @session_timeout: Session timeout for the station
3492 * Returns: 0 on success, -1 on failure
3493 */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003494 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003495 u32 session_timeout);
3496
3497 /**
3498 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3499 * @priv: Private driver interface data
3500 * @mac: MAC address of the station
3501 * Returns: 0 on success, -1 on failure
3502 */
3503 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
3504
3505 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003506 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
3507 * @priv: Private driver interface data
3508 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3509 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3510 * extra IE(s)
3511 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3512 * to remove extra IE(s)
3513 * Returns: 0 on success, -1 on failure
3514 *
3515 * This is an optional function to add WPS IE in the kernel driver for
3516 * Beacon and Probe Response frames. This can be left undefined (set
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003517 * to %NULL) if the driver uses the Beacon template from set_ap()
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003518 * and does not process Probe Request frames. If the driver takes care
3519 * of (Re)Association frame processing, the assocresp buffer includes
3520 * WPS IE(s) that need to be added to (Re)Association Response frames
3521 * whenever a (Re)Association Request frame indicated use of WPS.
3522 *
3523 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3524 * frames when operating as a GO. The driver is responsible for adding
3525 * timing related attributes (e.g., NoA) in addition to the IEs
3526 * included here by appending them after these buffers. This call is
3527 * also used to provide Probe Response IEs for P2P Listen state
3528 * operations for drivers that generate the Probe Response frames
3529 * internally.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003530 *
3531 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003532 */
3533 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
3534 const struct wpabuf *proberesp,
3535 const struct wpabuf *assocresp);
3536
3537 /**
3538 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3539 * @priv: Private driver interface data
3540 * @authorized: Whether the port is authorized
3541 * Returns: 0 on success, -1 on failure
3542 */
3543 int (*set_supp_port)(void *priv, int authorized);
3544
3545 /**
3546 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3547 * @priv: Private driver interface data
3548 * @addr: MAC address of the associated station
3549 * @aid: Association ID
3550 * @val: 1 = bind to 4-address WDS; 0 = unbind
3551 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3552 * to indicate that bridge is not to be used
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07003553 * @ifname_wds: Buffer to return the interface name for the new WDS
3554 * station or %NULL to indicate name is not returned.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003555 * Returns: 0 on success, -1 on failure
3556 */
3557 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003558 const char *bridge_ifname, char *ifname_wds);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003559
3560 /**
3561 * send_action - Transmit an Action frame
3562 * @priv: Private driver interface data
3563 * @freq: Frequency (in MHz) of the channel
3564 * @wait: Time to wait off-channel for a response (in ms), or zero
3565 * @dst: Destination MAC address (Address 1)
3566 * @src: Source MAC address (Address 2)
3567 * @bssid: BSSID (Address 3)
3568 * @data: Frame body
3569 * @data_len: data length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003570 @ @no_cck: Whether CCK rates must not be used to transmit this frame
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003571 * Returns: 0 on success, -1 on failure
3572 *
3573 * This command can be used to request the driver to transmit an action
3574 * frame to the specified destination.
3575 *
3576 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3577 * be transmitted on the given channel and the device will wait for a
3578 * response on that channel for the given wait time.
3579 *
3580 * If the flag is not set, the wait time will be ignored. In this case,
3581 * if a remain-on-channel duration is in progress, the frame must be
3582 * transmitted on that channel; alternatively the frame may be sent on
3583 * the current operational channel (if in associated state in station
3584 * mode or while operating as an AP.)
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08003585 *
3586 * If @src differs from the device MAC address, use of a random
3587 * transmitter address is requested for this message exchange.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003588 */
3589 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
3590 const u8 *dst, const u8 *src, const u8 *bssid,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003591 const u8 *data, size_t data_len, int no_cck);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003592
3593 /**
3594 * send_action_cancel_wait - Cancel action frame TX wait
3595 * @priv: Private driver interface data
3596 *
3597 * This command cancels the wait time associated with sending an action
3598 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3599 * set in the driver flags.
3600 */
3601 void (*send_action_cancel_wait)(void *priv);
3602
3603 /**
3604 * remain_on_channel - Remain awake on a channel
3605 * @priv: Private driver interface data
3606 * @freq: Frequency (in MHz) of the channel
3607 * @duration: Duration in milliseconds
3608 * Returns: 0 on success, -1 on failure
3609 *
3610 * This command is used to request the driver to remain awake on the
3611 * specified channel for the specified duration and report received
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08003612 * Action frames with EVENT_RX_MGMT events. Optionally, received
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003613 * Probe Request frames may also be requested to be reported by calling
3614 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3615 *
3616 * The driver may not be at the requested channel when this function
3617 * returns, i.e., the return code is only indicating whether the
3618 * request was accepted. The caller will need to wait until the
3619 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3620 * completed the channel change. This may take some time due to other
3621 * need for the radio and the caller should be prepared to timing out
3622 * its wait since there are no guarantees on when this request can be
3623 * executed.
3624 */
3625 int (*remain_on_channel)(void *priv, unsigned int freq,
3626 unsigned int duration);
3627
3628 /**
3629 * cancel_remain_on_channel - Cancel remain-on-channel operation
3630 * @priv: Private driver interface data
3631 *
3632 * This command can be used to cancel a remain-on-channel operation
3633 * before its originally requested duration has passed. This could be
3634 * used, e.g., when remain_on_channel() is used to request extra time
3635 * to receive a response to an Action frame and the response is
3636 * received when there is still unneeded time remaining on the
3637 * remain-on-channel operation.
3638 */
3639 int (*cancel_remain_on_channel)(void *priv);
3640
3641 /**
3642 * probe_req_report - Request Probe Request frames to be indicated
3643 * @priv: Private driver interface data
3644 * @report: Whether to report received Probe Request frames
3645 * Returns: 0 on success, -1 on failure (or if not supported)
3646 *
3647 * This command can be used to request the driver to indicate when
3648 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3649 * Since this operation may require extra resources, e.g., due to less
3650 * optimal hardware/firmware RX filtering, many drivers may disable
3651 * Probe Request reporting at least in station mode. This command is
3652 * used to notify the driver when the Probe Request frames need to be
3653 * reported, e.g., during remain-on-channel operations.
3654 */
3655 int (*probe_req_report)(void *priv, int report);
3656
3657 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003658 * deinit_ap - Deinitialize AP mode
3659 * @priv: Private driver interface data
3660 * Returns: 0 on success, -1 on failure (or if not supported)
3661 *
3662 * This optional function can be used to disable AP mode related
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003663 * configuration. If the interface was not dynamically added,
3664 * change the driver mode to station mode to allow normal station
3665 * operations like scanning to be completed.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003666 */
3667 int (*deinit_ap)(void *priv);
3668
3669 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003670 * deinit_p2p_cli - Deinitialize P2P client mode
3671 * @priv: Private driver interface data
3672 * Returns: 0 on success, -1 on failure (or if not supported)
3673 *
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003674 * This optional function can be used to disable P2P client mode. If the
3675 * interface was not dynamically added, change the interface type back
3676 * to station mode.
Dmitry Shmidt04949592012-07-19 12:16:46 -07003677 */
3678 int (*deinit_p2p_cli)(void *priv);
3679
3680 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003681 * suspend - Notification on system suspend/hibernate event
3682 * @priv: Private driver interface data
3683 */
3684 void (*suspend)(void *priv);
3685
3686 /**
3687 * resume - Notification on system resume/thaw event
3688 * @priv: Private driver interface data
3689 */
3690 void (*resume)(void *priv);
3691
3692 /**
3693 * signal_monitor - Set signal monitoring parameters
3694 * @priv: Private driver interface data
3695 * @threshold: Threshold value for signal change events; 0 = disabled
3696 * @hysteresis: Minimum change in signal strength before indicating a
3697 * new event
3698 * Returns: 0 on success, -1 on failure (or if not supported)
3699 *
3700 * This function can be used to configure monitoring of signal strength
3701 * with the current AP. Whenever signal strength drops below the
3702 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3703 * should be generated assuming the signal strength has changed at
3704 * least %hysteresis from the previously indicated signal change event.
3705 */
3706 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
3707
3708 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003709 * get_noa - Get current Notice of Absence attribute payload
3710 * @priv: Private driver interface data
3711 * @buf: Buffer for returning NoA
3712 * @buf_len: Buffer length in octets
3713 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3714 * advertized, or -1 on failure
3715 *
3716 * This function is used to fetch the current Notice of Absence
3717 * attribute value from GO.
3718 */
3719 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
3720
3721 /**
3722 * set_noa - Set Notice of Absence parameters for GO (testing)
3723 * @priv: Private driver interface data
3724 * @count: Count
3725 * @start: Start time in ms from next TBTT
3726 * @duration: Duration in ms
3727 * Returns: 0 on success or -1 on failure
3728 *
3729 * This function is used to set Notice of Absence parameters for GO. It
3730 * is used only for testing. To disable NoA, all parameters are set to
3731 * 0.
3732 */
3733 int (*set_noa)(void *priv, u8 count, int start, int duration);
3734
3735 /**
3736 * set_p2p_powersave - Set P2P power save options
3737 * @priv: Private driver interface data
3738 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3739 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3740 * @ctwindow: 0.. = change (msec), -1 = no change
3741 * Returns: 0 on success or -1 on failure
3742 */
3743 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
3744 int ctwindow);
3745
3746 /**
3747 * ampdu - Enable/disable aggregation
3748 * @priv: Private driver interface data
3749 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3750 * Returns: 0 on success or -1 on failure
3751 */
3752 int (*ampdu)(void *priv, int ampdu);
3753
3754 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003755 * get_radio_name - Get physical radio name for the device
3756 * @priv: Private driver interface data
3757 * Returns: Radio name or %NULL if not known
3758 *
3759 * The returned data must not be modified by the caller. It is assumed
3760 * that any interface that has the same radio name as another is
3761 * sharing the same physical radio. This information can be used to
3762 * share scan results etc. information between the virtual interfaces
3763 * to speed up various operations.
3764 */
3765 const char * (*get_radio_name)(void *priv);
3766
3767 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003768 * send_tdls_mgmt - for sending TDLS management packets
3769 * @priv: private driver interface data
3770 * @dst: Destination (peer) MAC address
3771 * @action_code: TDLS action code for the mssage
3772 * @dialog_token: Dialog Token to use in the message (if needed)
3773 * @status_code: Status Code or Reason Code to use (if needed)
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003774 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003775 * @initiator: Is the current end the TDLS link initiator
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003776 * @buf: TDLS IEs to add to the message
3777 * @len: Length of buf in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003778 * Returns: 0 on success, negative (<0) on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003779 *
3780 * This optional function can be used to send packet to driver which is
3781 * responsible for receiving and sending all TDLS packets.
3782 */
3783 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003784 u8 dialog_token, u16 status_code, u32 peer_capab,
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003785 int initiator, const u8 *buf, size_t len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003786
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003787 /**
3788 * tdls_oper - Ask the driver to perform high-level TDLS operations
3789 * @priv: Private driver interface data
3790 * @oper: TDLS high-level operation. See %enum tdls_oper
3791 * @peer: Destination (peer) MAC address
3792 * Returns: 0 on success, negative (<0) on failure
3793 *
3794 * This optional function can be used to send high-level TDLS commands
3795 * to the driver.
3796 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003797 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
3798
3799 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07003800 * wnm_oper - Notify driver of the WNM frame reception
3801 * @priv: Private driver interface data
3802 * @oper: WNM operation. See %enum wnm_oper
3803 * @peer: Destination (peer) MAC address
3804 * @buf: Buffer for the driver to fill in (for getting IE)
3805 * @buf_len: Return the len of buf
3806 * Returns: 0 on success, negative (<0) on failure
3807 */
3808 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
3809 u8 *buf, u16 *buf_len);
3810
3811 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -07003812 * set_qos_map - Set QoS Map
3813 * @priv: Private driver interface data
3814 * @qos_map_set: QoS Map
3815 * @qos_map_set_len: Length of QoS Map
3816 */
3817 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
3818 u8 qos_map_set_len);
3819
3820 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003821 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3822 * @priv: Private driver interface data
3823 * @version: IP version of the IP address, 4 or 6
3824 * @ipaddr: IP address for the neigh entry
3825 * @prefixlen: IP address prefix length
3826 * @addr: Corresponding MAC address
3827 * Returns: 0 on success, negative (<0) on failure
3828 */
3829 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
3830 int prefixlen, const u8 *addr);
3831
3832 /**
3833 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3834 * @priv: Private driver interface data
3835 * @version: IP version of the IP address, 4 or 6
3836 * @ipaddr: IP address for the neigh entry
3837 * Returns: 0 on success, negative (<0) on failure
3838 */
3839 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
3840
3841 /**
3842 * br_port_set_attr - Set a bridge port attribute
3843 * @attr: Bridge port attribute to set
3844 * @val: Value to be set
3845 * Returns: 0 on success, negative (<0) on failure
3846 */
3847 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
3848 unsigned int val);
3849
3850 /**
3851 * br_port_set_attr - Set a bridge network parameter
3852 * @param: Bridge parameter to set
3853 * @val: Value to be set
3854 * Returns: 0 on success, negative (<0) on failure
3855 */
3856 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
3857 unsigned int val);
3858
3859 /**
Hai Shalomfdcde762020-04-02 11:19:20 -07003860 * get_wowlan - Get wake-on-wireless status
3861 * @priv: Private driver interface data
3862 */
3863 int (*get_wowlan)(void *priv);
3864
3865 /**
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07003866 * set_wowlan - Set wake-on-wireless triggers
3867 * @priv: Private driver interface data
3868 * @triggers: wowlan triggers
3869 */
3870 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
3871
3872 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003873 * signal_poll - Get current connection information
3874 * @priv: Private driver interface data
3875 * @signal_info: Connection info structure
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003876 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003877 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003878
3879 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08003880 * channel_info - Get parameters of the current operating channel
3881 * @priv: Private driver interface data
3882 * @channel_info: Channel info structure
3883 * Returns: 0 on success, negative (<0) on failure
3884 */
3885 int (*channel_info)(void *priv, struct wpa_channel_info *channel_info);
3886
3887 /**
Jouni Malinen75ecf522011-06-27 15:19:46 -07003888 * set_authmode - Set authentication algorithm(s) for static WEP
3889 * @priv: Private driver interface data
3890 * @authmode: 1=Open System, 2=Shared Key, 3=both
3891 * Returns: 0 on success, -1 on failure
3892 *
3893 * This function can be used to set authentication algorithms for AP
3894 * mode when static WEP is used. If the driver uses user space MLME/SME
3895 * implementation, there is no need to implement this function.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003896 *
3897 * DEPRECATED - use set_ap() instead
Jouni Malinen75ecf522011-06-27 15:19:46 -07003898 */
3899 int (*set_authmode)(void *priv, int authmode);
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003900
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003901#ifdef ANDROID
Jouni Malinen75ecf522011-06-27 15:19:46 -07003902 /**
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003903 * driver_cmd - Execute driver-specific command
3904 * @priv: Private driver interface data
3905 * @cmd: Command to execute
3906 * @buf: Return buffer
3907 * @buf_len: Buffer length
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003908 * Returns: 0 on success, -1 on failure
3909 */
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003910 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
3911#endif /* ANDROID */
3912
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003913 /**
Dmitry Shmidta38abf92014-03-06 13:38:44 -08003914 * vendor_cmd - Execute vendor specific command
3915 * @priv: Private driver interface data
3916 * @vendor_id: Vendor id
3917 * @subcmd: Vendor command id
Hai Shalom60840252021-02-19 19:02:11 -08003918 * @nested_attr_flag: Specifies if vendor subcommand uses nested
3919 * attributes or not
Dmitry Shmidta38abf92014-03-06 13:38:44 -08003920 * @data: Vendor command parameters (%NULL if no parameters)
3921 * @data_len: Data length
3922 * @buf: Return buffer (%NULL to ignore reply)
3923 * Returns: 0 on success, negative (<0) on failure
3924 *
3925 * This function handles vendor specific commands that are passed to
3926 * the driver/device. The command is identified by vendor id and
Hai Shalom60840252021-02-19 19:02:11 -08003927 * command id. The nested_attr_flag specifies whether the subcommand
3928 * uses nested attributes or not. Parameters can be passed
3929 * as argument to the command in the data buffer. Reply (if any) will be
3930 * filled in the supplied return buffer.
Dmitry Shmidta38abf92014-03-06 13:38:44 -08003931 *
3932 * The exact driver behavior is driver interface and vendor specific. As
3933 * an example, this will be converted to a vendor specific cfg80211
3934 * command in case of the nl80211 driver interface.
3935 */
3936 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3937 unsigned int subcmd, const u8 *data, size_t data_len,
Hai Shalom60840252021-02-19 19:02:11 -08003938 enum nested_attr nested_attr_flag,
Dmitry Shmidta38abf92014-03-06 13:38:44 -08003939 struct wpabuf *buf);
3940
3941 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003942 * set_rekey_info - Set rekey information
3943 * @priv: Private driver interface data
3944 * @kek: Current KEK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003945 * @kek_len: KEK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003946 * @kck: Current KCK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003947 * @kck_len: KCK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003948 * @replay_ctr: Current EAPOL-Key Replay Counter
3949 *
3950 * This optional function can be used to provide information for the
3951 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3952 * while the host (including wpa_supplicant) is sleeping.
3953 */
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003954 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3955 const u8 *kck, size_t kck_len,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003956 const u8 *replay_ctr);
3957
3958 /**
3959 * sta_assoc - Station association indication
3960 * @priv: Private driver interface data
3961 * @own_addr: Source address and BSSID for association frame
3962 * @addr: MAC address of the station to associate
3963 * @reassoc: flag to indicate re-association
3964 * @status: association response status code
3965 * @ie: assoc response ie buffer
3966 * @len: ie buffer length
3967 * Returns: 0 on success, -1 on failure
3968 *
3969 * This function indicates the driver to send (Re)Association
3970 * Response frame to the station.
3971 */
3972 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3973 int reassoc, u16 status, const u8 *ie, size_t len);
3974
3975 /**
3976 * sta_auth - Station authentication indication
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003977 * @priv: private driver interface data
3978 * @params: Station authentication parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003979 *
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003980 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003981 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003982 int (*sta_auth)(void *priv,
3983 struct wpa_driver_sta_auth_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003984
3985 /**
3986 * add_tspec - Add traffic stream
3987 * @priv: Private driver interface data
3988 * @addr: MAC address of the station to associate
3989 * @tspec_ie: tspec ie buffer
3990 * @tspec_ielen: tspec ie length
3991 * Returns: 0 on success, -1 on failure
3992 *
3993 * This function adds the traffic steam for the station
3994 * and fills the medium_time in tspec_ie.
3995 */
3996 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3997 size_t tspec_ielen);
3998
3999 /**
4000 * add_sta_node - Add a station node in the driver
4001 * @priv: Private driver interface data
4002 * @addr: MAC address of the station to add
4003 * @auth_alg: authentication algorithm used by the station
4004 * Returns: 0 on success, -1 on failure
4005 *
4006 * This function adds the station node in the driver, when
4007 * the station gets added by FT-over-DS.
4008 */
4009 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
4010
4011 /**
4012 * sched_scan - Request the driver to initiate scheduled scan
4013 * @priv: Private driver interface data
4014 * @params: Scan parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004015 * Returns: 0 on success, -1 on failure
4016 *
4017 * This operation should be used for scheduled scan offload to
4018 * the hardware. Every time scan results are available, the
4019 * driver should report scan results event for wpa_supplicant
4020 * which will eventually request the results with
4021 * wpa_driver_get_scan_results2(). This operation is optional
4022 * and if not provided or if it returns -1, we fall back to
4023 * normal host-scheduled scans.
4024 */
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004025 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004026
4027 /**
4028 * stop_sched_scan - Request the driver to stop a scheduled scan
4029 * @priv: Private driver interface data
4030 * Returns: 0 on success, -1 on failure
4031 *
4032 * This should cause the scheduled scan to be stopped and
4033 * results should stop being sent. Must be supported if
4034 * sched_scan is supported.
4035 */
4036 int (*stop_sched_scan)(void *priv);
4037
4038 /**
4039 * poll_client - Probe (null data or such) the given station
4040 * @priv: Private driver interface data
4041 * @own_addr: MAC address of sending interface
4042 * @addr: MAC address of the station to probe
4043 * @qos: Indicates whether station is QoS station
4044 *
4045 * This function is used to verify whether an associated station is
4046 * still present. This function does not need to be implemented if the
4047 * driver provides such inactivity polling mechanism.
4048 */
4049 void (*poll_client)(void *priv, const u8 *own_addr,
4050 const u8 *addr, int qos);
Dmitry Shmidt04949592012-07-19 12:16:46 -07004051
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004052 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07004053 * radio_disable - Disable/enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004054 * @priv: Private driver interface data
Dmitry Shmidt04949592012-07-19 12:16:46 -07004055 * @disabled: 1=disable 0=enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004056 * Returns: 0 on success, -1 on failure
4057 *
Dmitry Shmidt04949592012-07-19 12:16:46 -07004058 * This optional command is for testing purposes. It can be used to
4059 * disable the radio on a testbed device to simulate out-of-radio-range
4060 * conditions.
4061 */
4062 int (*radio_disable)(void *priv, int disabled);
4063
4064 /**
4065 * switch_channel - Announce channel switch and migrate the GO to the
4066 * given frequency
4067 * @priv: Private driver interface data
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08004068 * @settings: Settings for CSA period and new channel
Dmitry Shmidt04949592012-07-19 12:16:46 -07004069 * Returns: 0 on success, -1 on failure
4070 *
4071 * This function is used to move the GO to the legacy STA channel to
4072 * avoid frequency conflict in single channel concurrency.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004073 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08004074 int (*switch_channel)(void *priv, struct csa_settings *settings);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004075
4076 /**
Sunil Ravia04bd252022-05-02 22:54:18 -07004077 * switch_color - Announce color switch and migrate the BSS to the
4078 * given color
4079 * @priv: Private driver interface data
4080 * @settings: Settings for CCA period and new color
4081 * Returns: 0 on success, -1 on failure
4082 *
4083 * This function is used to move the BSS to its new color.
4084 */
4085 int (*switch_color)(void *priv, struct cca_settings *settings);
4086
4087 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004088 * add_tx_ts - Add traffic stream
4089 * @priv: Private driver interface data
4090 * @tsid: Traffic stream ID
4091 * @addr: Receiver address
4092 * @user_prio: User priority of the traffic stream
4093 * @admitted_time: Admitted time for this TS in units of
4094 * 32 microsecond periods (per second).
4095 * Returns: 0 on success, -1 on failure
4096 */
4097 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
4098 u16 admitted_time);
4099
4100 /**
4101 * del_tx_ts - Delete traffic stream
4102 * @priv: Private driver interface data
4103 * @tsid: Traffic stream ID
4104 * @addr: Receiver address
4105 * Returns: 0 on success, -1 on failure
4106 */
4107 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
4108
4109 /**
4110 * Enable channel-switching with TDLS peer
4111 * @priv: Private driver interface data
4112 * @addr: MAC address of the TDLS peer
4113 * @oper_class: Operating class of the switch channel
4114 * @params: Channel specification
4115 * Returns: 0 on success, -1 on failure
4116 *
4117 * The function indicates to driver that it can start switching to a
4118 * different channel with a specified TDLS peer. The switching is
4119 * assumed on until canceled with tdls_disable_channel_switch().
4120 */
4121 int (*tdls_enable_channel_switch)(
4122 void *priv, const u8 *addr, u8 oper_class,
4123 const struct hostapd_freq_params *params);
4124
4125 /**
4126 * Disable channel switching with TDLS peer
4127 * @priv: Private driver interface data
4128 * @addr: MAC address of the TDLS peer
4129 * Returns: 0 on success, -1 on failure
4130 *
4131 * This function indicates to the driver that it should stop switching
4132 * with a given TDLS peer.
4133 */
4134 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
4135
4136 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004137 * start_dfs_cac - Listen for radar interference on the channel
4138 * @priv: Private driver interface data
Dmitry Shmidt051af732013-10-22 13:52:46 -07004139 * @freq: Channel parameters
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004140 * Returns: 0 on success, -1 on failure
4141 */
Dmitry Shmidt051af732013-10-22 13:52:46 -07004142 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004143
4144 /**
4145 * stop_ap - Removes beacon from AP
4146 * @priv: Private driver interface data
4147 * Returns: 0 on success, -1 on failure (or if not supported)
4148 *
4149 * This optional function can be used to disable AP mode related
4150 * configuration. Unlike deinit_ap, it does not change to station
4151 * mode.
4152 */
4153 int (*stop_ap)(void *priv);
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004154
4155 /**
4156 * get_survey - Retrieve survey data
4157 * @priv: Private driver interface data
4158 * @freq: If set, survey data for the specified frequency is only
4159 * being requested. If not set, all survey data is requested.
4160 * Returns: 0 on success, -1 on failure
4161 *
4162 * Use this to retrieve:
4163 *
4164 * - the observed channel noise floor
4165 * - the amount of time we have spent on the channel
4166 * - the amount of time during which we have spent on the channel that
4167 * the radio has determined the medium is busy and we cannot
4168 * transmit
4169 * - the amount of time we have spent receiving data
4170 * - the amount of time we have spent transmitting data
4171 *
4172 * This data can be used for spectrum heuristics. One example is
4173 * Automatic Channel Selection (ACS). The channel survey data is
4174 * kept on a linked list on the channel data, one entry is added
4175 * for each survey. The min_nf of the channel is updated for each
4176 * survey.
4177 */
4178 int (*get_survey)(void *priv, unsigned int freq);
Dmitry Shmidt56052862013-10-04 10:23:25 -07004179
4180 /**
4181 * status - Get driver interface status information
4182 * @priv: Private driver interface data
Hai Shalom74f70d42019-02-11 14:42:39 -08004183 * @buf: Buffer for printing the status information
Dmitry Shmidt56052862013-10-04 10:23:25 -07004184 * @buflen: Maximum length of the buffer
4185 * Returns: Length of written status information or -1 on failure
4186 */
4187 int (*status)(void *priv, char *buf, size_t buflen);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004188
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07004189 /**
4190 * roaming - Set roaming policy for driver-based BSS selection
4191 * @priv: Private driver interface data
4192 * @allowed: Whether roaming within ESS is allowed
4193 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
4194 * Returns: Length of written status information or -1 on failure
4195 *
4196 * This optional callback can be used to update roaming policy from the
4197 * associate() command (bssid being set there indicates that the driver
4198 * should not roam before getting this roaming() call to allow roaming.
4199 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
4200 * capability, roaming policy is handled within wpa_supplicant and there
4201 * is no need to implement or react to this callback.
4202 */
4203 int (*roaming)(void *priv, int allowed, const u8 *bssid);
4204
4205 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -07004206 * disable_fils - Enable/disable FILS feature
4207 * @priv: Private driver interface data
4208 * @disable: 0-enable and 1-disable FILS feature
4209 * Returns: 0 on success, -1 on failure
4210 *
4211 * This callback can be used to configure driver and below layers to
4212 * enable/disable all FILS features.
4213 */
4214 int (*disable_fils)(void *priv, int disable);
4215
4216 /**
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07004217 * set_mac_addr - Set MAC address
4218 * @priv: Private driver interface data
4219 * @addr: MAC address to use or %NULL for setting back to permanent
4220 * Returns: 0 on success, -1 on failure
4221 */
4222 int (*set_mac_addr)(void *priv, const u8 *addr);
4223
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004224#ifdef CONFIG_MACSEC
4225 int (*macsec_init)(void *priv, struct macsec_init_params *params);
4226
4227 int (*macsec_deinit)(void *priv);
4228
4229 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004230 * macsec_get_capability - Inform MKA of this driver's capability
4231 * @priv: Private driver interface data
4232 * @cap: Driver's capability
4233 * Returns: 0 on success, -1 on failure
4234 */
4235 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);
4236
4237 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004238 * enable_protect_frames - Set protect frames status
4239 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004240 * @enabled: true = protect frames enabled
4241 * false = protect frames disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004242 * Returns: 0 on success, -1 on failure (or if not supported)
4243 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004244 int (*enable_protect_frames)(void *priv, bool enabled);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004245
4246 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004247 * enable_encrypt - Set encryption status
4248 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004249 * @enabled: true = encrypt outgoing traffic
4250 * false = integrity-only protection on outgoing traffic
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004251 * Returns: 0 on success, -1 on failure (or if not supported)
4252 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004253 int (*enable_encrypt)(void *priv, bool enabled);
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004254
4255 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004256 * set_replay_protect - Set replay protect status and window size
4257 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004258 * @enabled: true = replay protect enabled
4259 * false = replay protect disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004260 * @window: replay window size, valid only when replay protect enabled
4261 * Returns: 0 on success, -1 on failure (or if not supported)
4262 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004263 int (*set_replay_protect)(void *priv, bool enabled, u32 window);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004264
4265 /**
4266 * set_current_cipher_suite - Set current cipher suite
4267 * @priv: Private driver interface data
4268 * @cs: EUI64 identifier
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004269 * Returns: 0 on success, -1 on failure (or if not supported)
4270 */
Dmitry Shmidt7d175302016-09-06 13:11:34 -07004271 int (*set_current_cipher_suite)(void *priv, u64 cs);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004272
4273 /**
4274 * enable_controlled_port - Set controlled port status
4275 * @priv: Private driver interface data
Hai Shalome21d4e82020-04-29 16:34:06 -07004276 * @enabled: true = controlled port enabled
4277 * false = controlled port disabled
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004278 * Returns: 0 on success, -1 on failure (or if not supported)
4279 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004280 int (*enable_controlled_port)(void *priv, bool enabled);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004281
4282 /**
4283 * get_receive_lowest_pn - Get receive lowest pn
4284 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004285 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004286 * Returns: 0 on success, -1 on failure (or if not supported)
4287 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004288 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004289
4290 /**
4291 * get_transmit_next_pn - Get transmit next pn
4292 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004293 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004294 * Returns: 0 on success, -1 on failure (or if not supported)
4295 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004296 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004297
4298 /**
4299 * set_transmit_next_pn - Set transmit next pn
4300 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004301 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004302 * Returns: 0 on success, -1 on failure (or if not supported)
4303 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004304 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004305
4306 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08004307 * set_receive_lowest_pn - Set receive lowest PN
4308 * @priv: Private driver interface data
4309 * @sa: secure association
4310 * Returns: 0 on success, -1 on failure (or if not supported)
4311 */
4312 int (*set_receive_lowest_pn)(void *priv, struct receive_sa *sa);
4313
4314 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004315 * create_receive_sc - create secure channel for receiving
4316 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004317 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004318 * @conf_offset: confidentiality offset (0, 30, or 50)
4319 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
4320 * 2 = Strict)
4321 * Returns: 0 on success, -1 on failure (or if not supported)
4322 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004323 int (*create_receive_sc)(void *priv, struct receive_sc *sc,
4324 unsigned int conf_offset,
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004325 int validation);
4326
4327 /**
4328 * delete_receive_sc - delete secure connection for receiving
4329 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004330 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004331 * Returns: 0 on success, -1 on failure
4332 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004333 int (*delete_receive_sc)(void *priv, struct receive_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004334
4335 /**
4336 * create_receive_sa - create secure association for receive
4337 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004338 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004339 * Returns: 0 on success, -1 on failure
4340 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004341 int (*create_receive_sa)(void *priv, struct receive_sa *sa);
4342
4343 /**
4344 * delete_receive_sa - Delete secure association for receive
4345 * @priv: Private driver interface data from init()
4346 * @sa: Secure association
4347 * Returns: 0 on success, -1 on failure
4348 */
4349 int (*delete_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004350
4351 /**
4352 * enable_receive_sa - enable the SA for receive
4353 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004354 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004355 * Returns: 0 on success, -1 on failure
4356 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004357 int (*enable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004358
4359 /**
4360 * disable_receive_sa - disable SA for receive
4361 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004362 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004363 * Returns: 0 on success, -1 on failure
4364 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004365 int (*disable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004366
4367 /**
4368 * create_transmit_sc - create secure connection for transmit
4369 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004370 * @sc: secure channel
4371 * @conf_offset: confidentiality offset (0, 30, or 50)
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004372 * Returns: 0 on success, -1 on failure
4373 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004374 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
4375 unsigned int conf_offset);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004376
4377 /**
4378 * delete_transmit_sc - delete secure connection for transmit
4379 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004380 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004381 * Returns: 0 on success, -1 on failure
4382 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004383 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004384
4385 /**
4386 * create_transmit_sa - create secure association for transmit
4387 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004388 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004389 * Returns: 0 on success, -1 on failure
4390 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004391 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);
4392
4393 /**
4394 * delete_transmit_sa - Delete secure association for transmit
4395 * @priv: Private driver interface data from init()
4396 * @sa: Secure association
4397 * Returns: 0 on success, -1 on failure
4398 */
4399 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004400
4401 /**
4402 * enable_transmit_sa - enable SA for transmit
4403 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004404 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004405 * Returns: 0 on success, -1 on failure
4406 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004407 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004408
4409 /**
4410 * disable_transmit_sa - disable SA for transmit
4411 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004412 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004413 * Returns: 0 on success, -1 on failure
4414 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004415 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004416#endif /* CONFIG_MACSEC */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004417
4418 /**
4419 * init_mesh - Driver specific initialization for mesh
4420 * @priv: Private driver interface data
4421 * Returns: 0 on success, -1 on failure
4422 */
4423 int (*init_mesh)(void *priv);
4424
4425 /**
4426 * join_mesh - Join a mesh network
4427 * @priv: Private driver interface data
4428 * @params: Mesh configuration parameters
4429 * Returns: 0 on success, -1 on failure
4430 */
4431 int (*join_mesh)(void *priv,
4432 struct wpa_driver_mesh_join_params *params);
4433
4434 /**
4435 * leave_mesh - Leave a mesh network
4436 * @priv: Private driver interface data
4437 * Returns 0 on success, -1 on failure
4438 */
4439 int (*leave_mesh)(void *priv);
4440
4441 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07004442 * probe_mesh_link - Inject a frame over direct mesh link to a given
4443 * peer skipping the next_hop lookup from mpath table.
4444 * @priv: Private driver interface data
4445 * @addr: Peer MAC address
4446 * @eth: Ethernet frame to be sent
4447 * @len: Ethernet frame lengtn in bytes
4448 * Returns 0 on success, -1 on failure
4449 */
4450 int (*probe_mesh_link)(void *priv, const u8 *addr, const u8 *eth,
4451 size_t len);
4452
4453 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004454 * do_acs - Automatically select channel
4455 * @priv: Private driver interface data
4456 * @params: Parameters for ACS
4457 * Returns 0 on success, -1 on failure
4458 *
4459 * This command can be used to offload ACS to the driver if the driver
4460 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
4461 */
4462 int (*do_acs)(void *priv, struct drv_acs_params *params);
Ravi Joshie6ccb162015-07-16 17:45:41 -07004463
4464 /**
Hai Shalom60840252021-02-19 19:02:11 -08004465 * set_band - Notify driver of band(s) selection
Ravi Joshie6ccb162015-07-16 17:45:41 -07004466 * @priv: Private driver interface data
Hai Shalom60840252021-02-19 19:02:11 -08004467 * @band_mask: The selected band(s) bit mask (from enum set_band)
Ravi Joshie6ccb162015-07-16 17:45:41 -07004468 * Returns 0 on success, -1 on failure
4469 */
Hai Shalom60840252021-02-19 19:02:11 -08004470 int (*set_band)(void *priv, u32 band_mask);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004471
4472 /**
4473 * get_pref_freq_list - Get preferred frequency list for an interface
4474 * @priv: Private driver interface data
4475 * @if_type: Interface type
4476 * @num: Number of channels
Sunil8cd6f4d2022-06-28 18:40:46 +00004477 * @freq_list: Weighted preferred channel list
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004478 * Returns 0 on success, -1 on failure
4479 *
4480 * This command can be used to query the preferred frequency list from
Sunil8cd6f4d2022-06-28 18:40:46 +00004481 * the driver specific to a particular interface type. The freq_list
4482 * array needs to have room for *num entries. *num will be updated to
4483 * indicate the number of entries fetched from the driver.
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004484 */
4485 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
Sunil8cd6f4d2022-06-28 18:40:46 +00004486 unsigned int *num,
4487 struct weighted_pcl *freq_list);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004488
4489 /**
4490 * set_prob_oper_freq - Indicate probable P2P operating channel
4491 * @priv: Private driver interface data
4492 * @freq: Channel frequency in MHz
4493 * Returns 0 on success, -1 on failure
4494 *
4495 * This command can be used to inform the driver of the operating
4496 * frequency that an ongoing P2P group formation is likely to come up
4497 * on. Local device is assuming P2P Client role.
4498 */
4499 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004500
4501 /**
4502 * abort_scan - Request the driver to abort an ongoing scan
4503 * @priv: Private driver interface data
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004504 * @scan_cookie: Cookie identifying the scan request. This is used only
4505 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4506 * was used to trigger scan. Otherwise, 0 is used.
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004507 * Returns 0 on success, -1 on failure
4508 */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004509 int (*abort_scan)(void *priv, u64 scan_cookie);
Dmitry Shmidt849734c2016-05-27 09:59:01 -07004510
4511 /**
4512 * configure_data_frame_filters - Request to configure frame filters
4513 * @priv: Private driver interface data
4514 * @filter_flags: The type of frames to filter (bitfield of
4515 * WPA_DATA_FRAME_FILTER_FLAG_*)
4516 * Returns: 0 on success or -1 on failure
4517 */
4518 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07004519
4520 /**
4521 * get_ext_capab - Get extended capabilities for the specified interface
4522 * @priv: Private driver interface data
4523 * @type: Interface type for which to get extended capabilities
4524 * @ext_capab: Extended capabilities fetched
4525 * @ext_capab_mask: Extended capabilities mask
4526 * @ext_capab_len: Length of the extended capabilities
4527 * Returns: 0 on success or -1 on failure
4528 */
4529 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
4530 const u8 **ext_capab, const u8 **ext_capab_mask,
4531 unsigned int *ext_capab_len);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004532
4533 /**
4534 * p2p_lo_start - Start offloading P2P listen to device
4535 * @priv: Private driver interface data
4536 * @freq: Listening frequency (MHz) for P2P listen
4537 * @period: Length of the listen operation in milliseconds
4538 * @interval: Interval for running the listen operation in milliseconds
4539 * @count: Number of times to run the listen operation
4540 * @device_types: Device primary and secondary types
4541 * @dev_types_len: Number of bytes for device_types
4542 * @ies: P2P IE and WSC IE for Probe Response frames
4543 * @ies_len: Length of ies in bytes
4544 * Returns: 0 on success or -1 on failure
4545 */
4546 int (*p2p_lo_start)(void *priv, unsigned int freq,
4547 unsigned int period, unsigned int interval,
4548 unsigned int count,
4549 const u8 *device_types, size_t dev_types_len,
4550 const u8 *ies, size_t ies_len);
4551
4552 /**
4553 * p2p_lo_stop - Stop P2P listen offload
4554 * @priv: Private driver interface data
4555 * Returns: 0 on success or -1 on failure
4556 */
4557 int (*p2p_lo_stop)(void *priv);
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07004558
4559 /**
4560 * set_default_scan_ies - Set default scan IEs
4561 * @priv: Private driver interface data
4562 * @ies: Scan default IEs buffer
4563 * @ies_len: Length of IEs in bytes
4564 * Returns: 0 on success or -1 on failure
4565 *
4566 * The driver can use these by default when there are no scan IEs coming
4567 * in the subsequent scan requests. Also in case of one or more of IEs
4568 * given in set_default_scan_ies() are missing in the subsequent scan
4569 * request, the driver should merge the missing scan IEs in the scan
4570 * request from the IEs set by set_default_scan_ies() in the Probe
4571 * Request frames sent.
4572 */
4573 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
4574
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004575 /**
4576 * set_tdls_mode - Set TDLS trigger mode to the host driver
4577 * @priv: Private driver interface data
4578 * @tdls_external_control: Represents if TDLS external trigger control
4579 * mode is enabled/disabled.
4580 *
4581 * This optional callback can be used to configure the TDLS external
4582 * trigger control mode to the host driver.
4583 */
4584 int (*set_tdls_mode)(void *priv, int tdls_external_control);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004585
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004586 /**
4587 * get_bss_transition_status - Get candidate BSS's transition status
4588 * @priv: Private driver interface data
4589 * @params: Candidate BSS list
4590 *
4591 * Get the accept or reject reason code for a list of BSS transition
4592 * candidates.
4593 */
4594 struct wpa_bss_candidate_info *
4595 (*get_bss_transition_status)(void *priv,
4596 struct wpa_bss_trans_info *params);
4597 /**
4598 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
4599 * @priv: Private driver interface data
4600 * @ignore_disallow: 0 to not ignore, 1 to ignore
4601 * Returns: 0 on success, -1 on failure
4602 */
4603 int (*ignore_assoc_disallow)(void *priv, int ignore_disallow);
4604
4605 /**
Hai Shalom899fcc72020-10-19 14:38:18 -07004606 * set_bssid_tmp_disallow - Set disallowed BSSIDs to the driver
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004607 * @priv: Private driver interface data
Hai Shalom899fcc72020-10-19 14:38:18 -07004608 * @num_bssid: Number of temporarily disallowed BSSIDs
4609 * @bssids: List of temporarily disallowed BSSIDs
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004610 */
Hai Shalom899fcc72020-10-19 14:38:18 -07004611 int (*set_bssid_tmp_disallow)(void *priv, unsigned int num_bssid,
4612 const u8 *bssid);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004613
4614 /**
4615 * update_connect_params - Update the connection parameters
4616 * @priv: Private driver interface data
4617 * @params: Association parameters
4618 * @mask: Bit mask indicating which parameters in @params have to be
4619 * updated
4620 * Returns: 0 on success, -1 on failure
4621 *
4622 * Update the connection parameters when in connected state so that the
4623 * driver uses the updated parameters for subsequent roaming. This is
4624 * used only with drivers that implement internal BSS selection and
4625 * roaming.
4626 */
4627 int (*update_connect_params)(
4628 void *priv, struct wpa_driver_associate_params *params,
4629 enum wpa_drv_update_connect_params_mask mask);
Roshan Pius3a1667e2018-07-03 15:17:14 -07004630
4631 /**
4632 * send_external_auth_status - Indicate the status of external
4633 * authentication processing to the host driver.
4634 * @priv: Private driver interface data
4635 * @params: Status of authentication processing.
4636 * Returns: 0 on success, -1 on failure
4637 */
4638 int (*send_external_auth_status)(void *priv,
4639 struct external_auth *params);
Hai Shalom74f70d42019-02-11 14:42:39 -08004640
4641 /**
4642 * set_4addr_mode - Set 4-address mode
4643 * @priv: Private driver interface data
4644 * @bridge_ifname: Bridge interface name
4645 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
4646 * Returns: 0 on success, < 0 on failure
4647 */
4648 int (*set_4addr_mode)(void *priv, const char *bridge_ifname, int val);
Hai Shalom81f62d82019-07-22 12:10:00 -07004649
4650 /**
4651 * update_dh_ie - Update DH IE
4652 * @priv: Private driver interface data
4653 * @peer_mac: Peer MAC address
4654 * @reason_code: Reacon code
4655 * @ie: DH IE
4656 * @ie_len: DH IE length in bytes
4657 * Returns: 0 on success, -1 on failure
4658 *
4659 * This callback is used to let the driver know the DH processing result
4660 * and DH IE for a pending association.
4661 */
4662 int (*update_dh_ie)(void *priv, const u8 *peer_mac, u16 reason_code,
4663 const u8 *ie, size_t ie_len);
Hai Shalomb755a2a2020-04-23 21:49:02 -07004664
4665 /**
4666 * dpp_listen - Notify driver about start/stop of DPP listen
4667 * @priv: Private driver interface data
4668 * @enable: Whether listen state is enabled (or disabled)
4669 * Returns: 0 on success, -1 on failure
4670 *
4671 * This optional callback can be used to update RX frame filtering to
4672 * explicitly allow reception of broadcast Public Action frames.
4673 */
Hai Shalome21d4e82020-04-29 16:34:06 -07004674 int (*dpp_listen)(void *priv, bool enable);
Hai Shalomc1a21442022-02-04 13:43:00 -08004675
4676#ifdef CONFIG_TESTING_OPTIONS
4677 int (*register_frame)(void *priv, u16 type,
4678 const u8 *match, size_t match_len,
4679 bool multicast);
4680#endif /* CONFIG_TESTING_OPTIONS */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004681};
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004682
4683/**
4684 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
4685 */
4686enum wpa_event_type {
4687 /**
4688 * EVENT_ASSOC - Association completed
4689 *
4690 * This event needs to be delivered when the driver completes IEEE
4691 * 802.11 association or reassociation successfully.
4692 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
4693 * after this event has been generated. In addition, optional
4694 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
4695 * more information about the association. If the driver interface gets
4696 * both of these events at the same time, it can also include the
4697 * assoc_info data in EVENT_ASSOC call.
4698 */
4699 EVENT_ASSOC,
4700
4701 /**
4702 * EVENT_DISASSOC - Association lost
4703 *
4704 * This event should be called when association is lost either due to
4705 * receiving deauthenticate or disassociate frame from the AP or when
4706 * sending either of these frames to the current AP. If the driver
4707 * supports separate deauthentication event, EVENT_DISASSOC should only
4708 * be used for disassociation and EVENT_DEAUTH for deauthentication.
4709 * In AP mode, union wpa_event_data::disassoc_info is required.
4710 */
4711 EVENT_DISASSOC,
4712
4713 /**
4714 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
4715 *
4716 * This event must be delivered when a Michael MIC error is detected by
4717 * the local driver. Additional data for event processing is
4718 * provided with union wpa_event_data::michael_mic_failure. This
Sunil Ravia04bd252022-05-02 22:54:18 -07004719 * information is used to request new encryption key and to initiate
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004720 * TKIP countermeasures if needed.
4721 */
4722 EVENT_MICHAEL_MIC_FAILURE,
4723
4724 /**
4725 * EVENT_SCAN_RESULTS - Scan results available
4726 *
4727 * This event must be called whenever scan results are available to be
4728 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4729 * is expected to be used some time after struct wpa_driver_ops::scan()
4730 * is called. If the driver provides an unsolicited event when the scan
4731 * has been completed, this event can be used to trigger
4732 * EVENT_SCAN_RESULTS call. If such event is not available from the
4733 * driver, the driver wrapper code is expected to use a registered
4734 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
4735 * scan is expected to be completed. Optional information about
4736 * completed scan can be provided with union wpa_event_data::scan_info.
4737 */
4738 EVENT_SCAN_RESULTS,
4739
4740 /**
4741 * EVENT_ASSOCINFO - Report optional extra information for association
4742 *
4743 * This event can be used to report extra association information for
4744 * EVENT_ASSOC processing. This extra information includes IEs from
4745 * association frames and Beacon/Probe Response frames in union
4746 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4747 * EVENT_ASSOC. Alternatively, the driver interface can include
4748 * assoc_info data in the EVENT_ASSOC call if it has all the
4749 * information available at the same point.
4750 */
4751 EVENT_ASSOCINFO,
4752
4753 /**
4754 * EVENT_INTERFACE_STATUS - Report interface status changes
4755 *
4756 * This optional event can be used to report changes in interface
4757 * status (interface added/removed) using union
4758 * wpa_event_data::interface_status. This can be used to trigger
4759 * wpa_supplicant to stop and re-start processing for the interface,
4760 * e.g., when a cardbus card is ejected/inserted.
4761 */
4762 EVENT_INTERFACE_STATUS,
4763
4764 /**
4765 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4766 *
4767 * This event can be used to inform wpa_supplicant about candidates for
4768 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4769 * for scan request (ap_scan=2 mode), this event is required for
4770 * pre-authentication. If wpa_supplicant is performing scan request
4771 * (ap_scan=1), this event is optional since scan results can be used
4772 * to add pre-authentication candidates. union
4773 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4774 * candidate and priority of the candidate, e.g., based on the signal
4775 * strength, in order to try to pre-authenticate first with candidates
4776 * that are most likely targets for re-association.
4777 *
4778 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4779 * on the candidate list. In addition, it can be called for the current
4780 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4781 * will automatically skip pre-authentication in cases where a valid
4782 * PMKSA exists. When more than one candidate exists, this event should
4783 * be generated once for each candidate.
4784 *
4785 * Driver will be notified about successful pre-authentication with
4786 * struct wpa_driver_ops::add_pmkid() calls.
4787 */
4788 EVENT_PMKID_CANDIDATE,
4789
4790 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004791 * EVENT_TDLS - Request TDLS operation
4792 *
4793 * This event can be used to request a TDLS operation to be performed.
4794 */
4795 EVENT_TDLS,
4796
4797 /**
4798 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4799 *
4800 * The driver is expected to report the received FT IEs from
4801 * FT authentication sequence from the AP. The FT IEs are included in
4802 * the extra information in union wpa_event_data::ft_ies.
4803 */
4804 EVENT_FT_RESPONSE,
4805
4806 /**
4807 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4808 *
4809 * The driver can use this event to inform wpa_supplicant about a STA
4810 * in an IBSS with which protected frames could be exchanged. This
4811 * event starts RSN authentication with the other STA to authenticate
4812 * the STA and set up encryption keys with it.
4813 */
4814 EVENT_IBSS_RSN_START,
4815
4816 /**
4817 * EVENT_AUTH - Authentication result
4818 *
4819 * This event should be called when authentication attempt has been
4820 * completed. This is only used if the driver supports separate
4821 * authentication step (struct wpa_driver_ops::authenticate).
4822 * Information about authentication result is included in
4823 * union wpa_event_data::auth.
4824 */
4825 EVENT_AUTH,
4826
4827 /**
4828 * EVENT_DEAUTH - Authentication lost
4829 *
4830 * This event should be called when authentication is lost either due
4831 * to receiving deauthenticate frame from the AP or when sending that
4832 * frame to the current AP.
4833 * In AP mode, union wpa_event_data::deauth_info is required.
4834 */
4835 EVENT_DEAUTH,
4836
4837 /**
4838 * EVENT_ASSOC_REJECT - Association rejected
4839 *
4840 * This event should be called when (re)association attempt has been
4841 * rejected by the AP. Information about the association response is
4842 * included in union wpa_event_data::assoc_reject.
4843 */
4844 EVENT_ASSOC_REJECT,
4845
4846 /**
4847 * EVENT_AUTH_TIMED_OUT - Authentication timed out
4848 */
4849 EVENT_AUTH_TIMED_OUT,
4850
4851 /**
4852 * EVENT_ASSOC_TIMED_OUT - Association timed out
4853 */
4854 EVENT_ASSOC_TIMED_OUT,
4855
4856 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004857 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
4858 */
4859 EVENT_WPS_BUTTON_PUSHED,
4860
4861 /**
4862 * EVENT_TX_STATUS - Report TX status
4863 */
4864 EVENT_TX_STATUS,
4865
4866 /**
4867 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
4868 */
4869 EVENT_RX_FROM_UNKNOWN,
4870
4871 /**
4872 * EVENT_RX_MGMT - Report RX of a management frame
4873 */
4874 EVENT_RX_MGMT,
4875
4876 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004877 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
4878 *
4879 * This event is used to indicate when the driver has started the
4880 * requested remain-on-channel duration. Information about the
4881 * operation is included in union wpa_event_data::remain_on_channel.
4882 */
4883 EVENT_REMAIN_ON_CHANNEL,
4884
4885 /**
4886 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
4887 *
4888 * This event is used to indicate when the driver has completed
4889 * remain-on-channel duration, i.e., may noot be available on the
4890 * requested channel anymore. Information about the
4891 * operation is included in union wpa_event_data::remain_on_channel.
4892 */
4893 EVENT_CANCEL_REMAIN_ON_CHANNEL,
4894
4895 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004896 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
4897 *
4898 * This event is used to indicate when a Probe Request frame has been
4899 * received. Information about the received frame is included in
4900 * union wpa_event_data::rx_probe_req. The driver is required to report
4901 * these events only after successfully completed probe_req_report()
4902 * commands to request the events (i.e., report parameter is non-zero)
4903 * in station mode. In AP mode, Probe Request frames should always be
4904 * reported.
4905 */
4906 EVENT_RX_PROBE_REQ,
4907
4908 /**
4909 * EVENT_NEW_STA - New wired device noticed
4910 *
4911 * This event is used to indicate that a new device has been detected
4912 * in a network that does not use association-like functionality (i.e.,
4913 * mainly wired Ethernet). This can be used to start EAPOL
4914 * authenticator when receiving a frame from a device. The address of
4915 * the device is included in union wpa_event_data::new_sta.
4916 */
4917 EVENT_NEW_STA,
4918
4919 /**
4920 * EVENT_EAPOL_RX - Report received EAPOL frame
4921 *
4922 * When in AP mode with hostapd, this event is required to be used to
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004923 * deliver the receive EAPOL frames from the driver.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004924 */
4925 EVENT_EAPOL_RX,
4926
4927 /**
4928 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4929 *
4930 * This event is used to indicate changes in the signal strength
4931 * observed in frames received from the current AP if signal strength
4932 * monitoring has been enabled with signal_monitor().
4933 */
4934 EVENT_SIGNAL_CHANGE,
4935
4936 /**
4937 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4938 *
4939 * This event is used to indicate that the interface was enabled after
4940 * having been previously disabled, e.g., due to rfkill.
4941 */
4942 EVENT_INTERFACE_ENABLED,
4943
4944 /**
4945 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4946 *
4947 * This event is used to indicate that the interface was disabled,
4948 * e.g., due to rfkill.
4949 */
4950 EVENT_INTERFACE_DISABLED,
4951
4952 /**
4953 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4954 *
4955 * This event is used to indicate that the channel list has changed,
4956 * e.g., because of a regulatory domain change triggered by scan
4957 * results including an AP advertising a country code.
4958 */
4959 EVENT_CHANNEL_LIST_CHANGED,
4960
4961 /**
4962 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4963 *
4964 * This event is used to indicate that the driver cannot maintain this
4965 * interface in its operation mode anymore. The most likely use for
4966 * this is to indicate that AP mode operation is not available due to
4967 * operating channel would need to be changed to a DFS channel when
4968 * the driver does not support radar detection and another virtual
4969 * interfaces caused the operating channel to change. Other similar
4970 * resource conflicts could also trigger this for station mode
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07004971 * interfaces. This event can be propagated when channel switching
4972 * fails.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004973 */
4974 EVENT_INTERFACE_UNAVAILABLE,
4975
4976 /**
4977 * EVENT_BEST_CHANNEL
4978 *
4979 * Driver generates this event whenever it detects a better channel
4980 * (e.g., based on RSSI or channel use). This information can be used
4981 * to improve channel selection for a new AP/P2P group.
4982 */
4983 EVENT_BEST_CHANNEL,
4984
4985 /**
4986 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4987 *
4988 * This event should be called when a Deauthentication frame is dropped
4989 * due to it not being protected (MFP/IEEE 802.11w).
4990 * union wpa_event_data::unprot_deauth is required to provide more
4991 * details of the frame.
4992 */
4993 EVENT_UNPROT_DEAUTH,
4994
4995 /**
4996 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4997 *
4998 * This event should be called when a Disassociation frame is dropped
4999 * due to it not being protected (MFP/IEEE 802.11w).
5000 * union wpa_event_data::unprot_disassoc is required to provide more
5001 * details of the frame.
5002 */
5003 EVENT_UNPROT_DISASSOC,
5004
5005 /**
5006 * EVENT_STATION_LOW_ACK
5007 *
5008 * Driver generates this event whenever it detected that a particular
5009 * station was lost. Detection can be through massive transmission
5010 * failures for example.
5011 */
5012 EVENT_STATION_LOW_ACK,
5013
5014 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005015 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
5016 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005017 EVENT_IBSS_PEER_LOST,
5018
5019 /**
5020 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
5021 *
5022 * This event carries the new replay counter to notify wpa_supplicant
5023 * of the current EAPOL-Key Replay Counter in case the driver/firmware
5024 * completed Group Key Handshake while the host (including
5025 * wpa_supplicant was sleeping).
5026 */
5027 EVENT_DRIVER_GTK_REKEY,
5028
5029 /**
5030 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
5031 */
5032 EVENT_SCHED_SCAN_STOPPED,
5033
5034 /**
5035 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
5036 *
5037 * This event indicates that the station responded to the poll
5038 * initiated with @poll_client.
5039 */
5040 EVENT_DRIVER_CLIENT_POLL_OK,
5041
5042 /**
5043 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
5044 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07005045 EVENT_EAPOL_TX_STATUS,
5046
5047 /**
5048 * EVENT_CH_SWITCH - AP or GO decided to switch channels
5049 *
5050 * Described in wpa_event_data.ch_switch
5051 * */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07005052 EVENT_CH_SWITCH,
5053
5054 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07005055 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
5056 *
5057 * This is a pre-switch event indicating the shortly following switch
5058 * of operating channels.
5059 *
5060 * Described in wpa_event_data.ch_switch
5061 */
5062 EVENT_CH_SWITCH_STARTED,
5063 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07005064 * EVENT_WNM - Request WNM operation
5065 *
5066 * This event can be used to request a WNM operation to be performed.
5067 */
Dmitry Shmidtf8623282013-02-20 14:34:59 -08005068 EVENT_WNM,
5069
5070 /**
5071 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
5072 *
5073 * This event indicates that the driver reported a connection failure
5074 * with the specified client (for example, max client reached, etc.) in
5075 * AP mode.
5076 */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005077 EVENT_CONNECT_FAILED_REASON,
5078
5079 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08005080 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005081 *
5082 * A radar has been detected on the supplied frequency, hostapd should
5083 * react accordingly (e.g., change channel).
5084 */
5085 EVENT_DFS_RADAR_DETECTED,
5086
5087 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08005088 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005089 *
5090 * After a successful CAC, the channel can be marked clear and used.
5091 */
5092 EVENT_DFS_CAC_FINISHED,
5093
5094 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08005095 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005096 *
5097 * The CAC was not successful, and the channel remains in the previous
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08005098 * state. This may happen due to a radar being detected or other
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005099 * external influences.
5100 */
5101 EVENT_DFS_CAC_ABORTED,
5102
5103 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08005104 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005105 *
5106 * The channel which was previously unavailable is now available again.
5107 */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005108 EVENT_DFS_NOP_FINISHED,
5109
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005110 /**
5111 * EVENT_SURVEY - Received survey data
5112 *
5113 * This event gets triggered when a driver query is issued for survey
5114 * data and the requested data becomes available. The returned data is
5115 * stored in struct survey_results. The results provide at most one
5116 * survey entry for each frequency and at minimum will provide one
5117 * survey entry for one frequency. The survey data can be os_malloc()'d
5118 * and then os_free()'d, so the event callback must only copy data.
5119 */
5120 EVENT_SURVEY,
5121
5122 /**
5123 * EVENT_SCAN_STARTED - Scan started
5124 *
5125 * This indicates that driver has started a scan operation either based
5126 * on a request from wpa_supplicant/hostapd or from another application.
5127 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
5128 * completed (either successfully or by getting cancelled).
5129 */
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08005130 EVENT_SCAN_STARTED,
5131
5132 /**
5133 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
5134 *
5135 * This event indicates a set of frequency ranges that should be avoided
5136 * to reduce issues due to interference or internal co-existence
5137 * information in the driver.
5138 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005139 EVENT_AVOID_FREQUENCIES,
5140
5141 /**
5142 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
5143 */
5144 EVENT_NEW_PEER_CANDIDATE,
5145
5146 /**
5147 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
5148 *
5149 * Indicates a pair of primary and secondary channels chosen by ACS
5150 * in device.
5151 */
5152 EVENT_ACS_CHANNEL_SELECTED,
Dmitry Shmidt7f656022015-02-25 14:36:37 -08005153
5154 /**
5155 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
5156 * been started.
5157 *
5158 * This event indicates that channel availability check has been started
5159 * on a DFS frequency by a driver that supports DFS Offload.
5160 */
5161 EVENT_DFS_CAC_STARTED,
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005162
5163 /**
5164 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
5165 */
5166 EVENT_P2P_LO_STOP,
Paul Stewart092955c2017-02-06 09:13:09 -08005167
5168 /**
5169 * EVENT_BEACON_LOSS - Beacon loss detected
5170 *
5171 * This event indicates that no Beacon frames has been received from
5172 * the current AP. This may indicate that the AP is not anymore in
5173 * range.
5174 */
5175 EVENT_BEACON_LOSS,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005176
5177 /**
5178 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
5179 * done previously (Pre-CAC) on the channel has expired. This would
5180 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
5181 * channel will be moved from available to usable. A new CAC has to be
5182 * performed before start operating on this channel.
5183 */
5184 EVENT_DFS_PRE_CAC_EXPIRED,
Roshan Pius3a1667e2018-07-03 15:17:14 -07005185
5186 /**
5187 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
5188 * that do not define separate commands for authentication and
5189 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
5190 * authentication to wpa_supplicant. This event carries all the
5191 * necessary information from the host driver for the authentication to
5192 * happen.
5193 */
5194 EVENT_EXTERNAL_AUTH,
5195
5196 /**
5197 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
5198 *
5199 * This event should be indicated when the driver completes the 4-way
5200 * handshake. This event should be preceded by an EVENT_ASSOC that
5201 * indicates the completion of IEEE 802.11 association.
5202 */
5203 EVENT_PORT_AUTHORIZED,
5204
5205 /**
5206 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
5207 * change event.
5208 */
5209 EVENT_STATION_OPMODE_CHANGED,
5210
5211 /**
5212 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
5213 *
5214 * This event is emitted when the MAC changes while the interface is
5215 * enabled. When an interface was disabled and becomes enabled, it
5216 * must be always assumed that the MAC possibly changed.
5217 */
5218 EVENT_INTERFACE_MAC_CHANGED,
5219
5220 /**
5221 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
5222 *
5223 * This event is emitted when an interface is added/removed for WDS STA.
5224 */
5225 EVENT_WDS_STA_INTERFACE_STATUS,
Hai Shalom81f62d82019-07-22 12:10:00 -07005226
5227 /**
5228 * EVENT_UPDATE_DH - Notification of updated DH information
5229 */
5230 EVENT_UPDATE_DH,
Hai Shalomfdcde762020-04-02 11:19:20 -07005231
5232 /**
5233 * EVENT_UNPROT_BEACON - Unprotected Beacon frame received
5234 *
5235 * This event should be called when a Beacon frame is dropped due to it
5236 * not being protected correctly. union wpa_event_data::unprot_beacon
5237 * is required to provide more details of the frame.
5238 */
5239 EVENT_UNPROT_BEACON,
Hai Shalomc1a21442022-02-04 13:43:00 -08005240
5241 /**
5242 * EVENT_TX_WAIT_EXPIRE - TX wait timed out
5243 *
5244 * This event is used to indicate when the driver has completed
5245 * wait for a response frame based on a TX request that specified a
5246 * non-zero wait time and that has not been explicitly cancelled.
5247 */
5248 EVENT_TX_WAIT_EXPIRE,
Sunil Ravia04bd252022-05-02 22:54:18 -07005249
5250 /**
5251 * EVENT_BSS_COLOR_COLLISION - Notification of a BSS color collision
5252 */
5253 EVENT_BSS_COLOR_COLLISION,
5254
5255 /**
5256 * EVENT_CCA_STARTED_NOTIFY - Notification that CCA has started
5257 */
5258 EVENT_CCA_STARTED_NOTIFY,
5259
5260 /**
5261 * EVENT_CCA_ABORTED_NOTIFY - Notification that CCA has aborted
5262 */
5263 EVENT_CCA_ABORTED_NOTIFY,
5264
5265 /**
5266 * EVENT_CCA_NOTIFY - Notification that CCA has completed
5267 */
5268 EVENT_CCA_NOTIFY,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005269};
5270
5271
5272/**
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005273 * struct freq_survey - Channel survey info
5274 *
5275 * @ifidx: Interface index in which this survey was observed
5276 * @freq: Center of frequency of the surveyed channel
5277 * @nf: Channel noise floor in dBm
5278 * @channel_time: Amount of time in ms the radio spent on the channel
5279 * @channel_time_busy: Amount of time in ms the radio detected some signal
5280 * that indicated to the radio the channel was not clear
5281 * @channel_time_rx: Amount of time the radio spent receiving data
5282 * @channel_time_tx: Amount of time the radio spent transmitting data
5283 * @filled: bitmask indicating which fields have been reported, see
5284 * SURVEY_HAS_* defines.
5285 * @list: Internal list pointers
5286 */
5287struct freq_survey {
5288 u32 ifidx;
5289 unsigned int freq;
5290 s8 nf;
5291 u64 channel_time;
5292 u64 channel_time_busy;
5293 u64 channel_time_rx;
5294 u64 channel_time_tx;
5295 unsigned int filled;
5296 struct dl_list list;
5297};
5298
5299#define SURVEY_HAS_NF BIT(0)
5300#define SURVEY_HAS_CHAN_TIME BIT(1)
5301#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
5302#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
5303#define SURVEY_HAS_CHAN_TIME_TX BIT(4)
5304
Hai Shalom60840252021-02-19 19:02:11 -08005305/**
5306 * enum sta_connect_fail_reason_codes - STA connect failure reason code values
5307 * @STA_CONNECT_FAIL_REASON_UNSPECIFIED: No reason code specified for
5308 * connection failure.
5309 * @STA_CONNECT_FAIL_REASON_NO_BSS_FOUND: No Probe Response frame received
5310 * for unicast Probe Request frame.
5311 * @STA_CONNECT_FAIL_REASON_AUTH_TX_FAIL: STA failed to send auth request.
5312 * @STA_CONNECT_FAIL_REASON_AUTH_NO_ACK_RECEIVED: AP didn't send ACK for
5313 * auth request.
5314 * @STA_CONNECT_FAIL_REASON_AUTH_NO_RESP_RECEIVED: Auth response is not
5315 * received from AP.
5316 * @STA_CONNECT_FAIL_REASON_ASSOC_REQ_TX_FAIL: STA failed to send
5317 * Association Request frame.
5318 * @STA_CONNECT_FAIL_REASON_ASSOC_NO_ACK_RECEIVED: AP didn't send ACK for
5319 * Association Request frame.
5320 * @STA_CONNECT_FAIL_REASON_ASSOC_NO_RESP_RECEIVED: Association Response
5321 * frame is not received from AP.
5322 */
5323enum sta_connect_fail_reason_codes {
5324 STA_CONNECT_FAIL_REASON_UNSPECIFIED = 0,
5325 STA_CONNECT_FAIL_REASON_NO_BSS_FOUND = 1,
5326 STA_CONNECT_FAIL_REASON_AUTH_TX_FAIL = 2,
5327 STA_CONNECT_FAIL_REASON_AUTH_NO_ACK_RECEIVED = 3,
5328 STA_CONNECT_FAIL_REASON_AUTH_NO_RESP_RECEIVED = 4,
5329 STA_CONNECT_FAIL_REASON_ASSOC_REQ_TX_FAIL = 5,
5330 STA_CONNECT_FAIL_REASON_ASSOC_NO_ACK_RECEIVED = 6,
5331 STA_CONNECT_FAIL_REASON_ASSOC_NO_RESP_RECEIVED = 7,
5332};
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005333
5334/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005335 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
5336 */
5337union wpa_event_data {
5338 /**
5339 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
5340 *
5341 * This structure is optional for EVENT_ASSOC calls and required for
5342 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
5343 * driver interface does not need to generate separate EVENT_ASSOCINFO
5344 * calls.
5345 */
5346 struct assoc_info {
5347 /**
5348 * reassoc - Flag to indicate association or reassociation
5349 */
5350 int reassoc;
5351
5352 /**
5353 * req_ies - (Re)Association Request IEs
5354 *
5355 * If the driver generates WPA/RSN IE, this event data must be
5356 * returned for WPA handshake to have needed information. If
5357 * wpa_supplicant-generated WPA/RSN IE is used, this
5358 * information event is optional.
5359 *
5360 * This should start with the first IE (fixed fields before IEs
5361 * are not included).
5362 */
5363 const u8 *req_ies;
5364
5365 /**
5366 * req_ies_len - Length of req_ies in bytes
5367 */
5368 size_t req_ies_len;
5369
5370 /**
5371 * resp_ies - (Re)Association Response IEs
5372 *
5373 * Optional association data from the driver. This data is not
5374 * required WPA, but may be useful for some protocols and as
5375 * such, should be reported if this is available to the driver
5376 * interface.
5377 *
5378 * This should start with the first IE (fixed fields before IEs
5379 * are not included).
5380 */
5381 const u8 *resp_ies;
5382
5383 /**
5384 * resp_ies_len - Length of resp_ies in bytes
5385 */
5386 size_t resp_ies_len;
5387
5388 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08005389 * resp_frame - (Re)Association Response frame
5390 */
5391 const u8 *resp_frame;
5392
5393 /**
5394 * resp_frame_len - (Re)Association Response frame length
5395 */
5396 size_t resp_frame_len;
5397
5398 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005399 * beacon_ies - Beacon or Probe Response IEs
5400 *
5401 * Optional Beacon/ProbeResp data: IEs included in Beacon or
5402 * Probe Response frames from the current AP (i.e., the one
5403 * that the client just associated with). This information is
5404 * used to update WPA/RSN IE for the AP. If this field is not
5405 * set, the results from previous scan will be used. If no
5406 * data for the new AP is found, scan results will be requested
5407 * again (without scan request). At this point, the driver is
5408 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
5409 * used).
5410 *
5411 * This should start with the first IE (fixed fields before IEs
5412 * are not included).
5413 */
5414 const u8 *beacon_ies;
5415
5416 /**
5417 * beacon_ies_len - Length of beacon_ies */
5418 size_t beacon_ies_len;
5419
5420 /**
5421 * freq - Frequency of the operational channel in MHz
5422 */
5423 unsigned int freq;
5424
5425 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005426 * wmm_params - WMM parameters used in this association.
5427 */
5428 struct wmm_params wmm_params;
5429
5430 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005431 * addr - Station address (for AP mode)
5432 */
5433 const u8 *addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005434
5435 /**
5436 * The following is the key management offload information
5437 * @authorized
5438 * @key_replay_ctr
5439 * @key_replay_ctr_len
5440 * @ptk_kck
5441 * @ptk_kek_len
5442 * @ptk_kek
5443 * @ptk_kek_len
5444 */
5445
5446 /**
5447 * authorized - Status of key management offload,
5448 * 1 = successful
5449 */
5450 int authorized;
5451
5452 /**
5453 * key_replay_ctr - Key replay counter value last used
5454 * in a valid EAPOL-Key frame
5455 */
5456 const u8 *key_replay_ctr;
5457
5458 /**
5459 * key_replay_ctr_len - The length of key_replay_ctr
5460 */
5461 size_t key_replay_ctr_len;
5462
5463 /**
5464 * ptk_kck - The derived PTK KCK
5465 */
5466 const u8 *ptk_kck;
5467
5468 /**
5469 * ptk_kek_len - The length of ptk_kck
5470 */
5471 size_t ptk_kck_len;
5472
5473 /**
5474 * ptk_kek - The derived PTK KEK
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005475 * This is used in key management offload and also in FILS SK
5476 * offload.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005477 */
5478 const u8 *ptk_kek;
5479
5480 /**
5481 * ptk_kek_len - The length of ptk_kek
5482 */
5483 size_t ptk_kek_len;
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08005484
5485 /**
5486 * subnet_status - The subnet status:
5487 * 0 = unknown, 1 = unchanged, 2 = changed
5488 */
5489 u8 subnet_status;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005490
5491 /**
5492 * The following information is used in FILS SK offload
5493 * @fils_erp_next_seq_num
5494 * @fils_pmk
5495 * @fils_pmk_len
5496 * @fils_pmkid
5497 */
5498
5499 /**
5500 * fils_erp_next_seq_num - The next sequence number to use in
5501 * FILS ERP messages
5502 */
5503 u16 fils_erp_next_seq_num;
5504
5505 /**
5506 * fils_pmk - A new PMK if generated in case of FILS
5507 * authentication
5508 */
5509 const u8 *fils_pmk;
5510
5511 /**
5512 * fils_pmk_len - Length of fils_pmk
5513 */
5514 size_t fils_pmk_len;
5515
5516 /**
5517 * fils_pmkid - PMKID used or generated in FILS authentication
5518 */
5519 const u8 *fils_pmkid;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005520 } assoc_info;
5521
5522 /**
5523 * struct disassoc_info - Data for EVENT_DISASSOC events
5524 */
5525 struct disassoc_info {
5526 /**
5527 * addr - Station address (for AP mode)
5528 */
5529 const u8 *addr;
5530
5531 /**
5532 * reason_code - Reason Code (host byte order) used in
5533 * Deauthentication frame
5534 */
5535 u16 reason_code;
5536
5537 /**
5538 * ie - Optional IE(s) in Disassociation frame
5539 */
5540 const u8 *ie;
5541
5542 /**
5543 * ie_len - Length of ie buffer in octets
5544 */
5545 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005546
5547 /**
5548 * locally_generated - Whether the frame was locally generated
5549 */
5550 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005551 } disassoc_info;
5552
5553 /**
5554 * struct deauth_info - Data for EVENT_DEAUTH events
5555 */
5556 struct deauth_info {
5557 /**
5558 * addr - Station address (for AP mode)
5559 */
5560 const u8 *addr;
5561
5562 /**
5563 * reason_code - Reason Code (host byte order) used in
5564 * Deauthentication frame
5565 */
5566 u16 reason_code;
5567
5568 /**
5569 * ie - Optional IE(s) in Deauthentication frame
5570 */
5571 const u8 *ie;
5572
5573 /**
5574 * ie_len - Length of ie buffer in octets
5575 */
5576 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005577
5578 /**
5579 * locally_generated - Whether the frame was locally generated
5580 */
5581 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005582 } deauth_info;
5583
5584 /**
5585 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
5586 */
5587 struct michael_mic_failure {
5588 int unicast;
5589 const u8 *src;
5590 } michael_mic_failure;
5591
5592 /**
5593 * struct interface_status - Data for EVENT_INTERFACE_STATUS
5594 */
5595 struct interface_status {
Dmitry Shmidte4663042016-04-04 10:07:49 -07005596 unsigned int ifindex;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005597 char ifname[100];
5598 enum {
5599 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
5600 } ievent;
5601 } interface_status;
5602
5603 /**
5604 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
5605 */
5606 struct pmkid_candidate {
5607 /** BSSID of the PMKID candidate */
5608 u8 bssid[ETH_ALEN];
5609 /** Smaller the index, higher the priority */
5610 int index;
5611 /** Whether RSN IE includes pre-authenticate flag */
5612 int preauth;
5613 } pmkid_candidate;
5614
5615 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005616 * struct tdls - Data for EVENT_TDLS
5617 */
5618 struct tdls {
5619 u8 peer[ETH_ALEN];
5620 enum {
5621 TDLS_REQUEST_SETUP,
Dmitry Shmidt4dd28dc2015-03-10 11:21:43 -07005622 TDLS_REQUEST_TEARDOWN,
5623 TDLS_REQUEST_DISCOVER,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005624 } oper;
5625 u16 reason_code; /* for teardown */
5626 } tdls;
5627
5628 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07005629 * struct wnm - Data for EVENT_WNM
5630 */
5631 struct wnm {
5632 u8 addr[ETH_ALEN];
5633 enum {
5634 WNM_OPER_SLEEP,
5635 } oper;
5636 enum {
5637 WNM_SLEEP_ENTER,
5638 WNM_SLEEP_EXIT
5639 } sleep_action;
5640 int sleep_intval;
5641 u16 reason_code;
5642 u8 *buf;
5643 u16 buf_len;
5644 } wnm;
5645
5646 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005647 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
5648 *
5649 * During FT (IEEE 802.11r) authentication sequence, the driver is
5650 * expected to use this event to report received FT IEs (MDIE, FTIE,
5651 * RSN IE, TIE, possible resource request) to the supplicant. The FT
5652 * IEs for the next message will be delivered through the
5653 * struct wpa_driver_ops::update_ft_ies() callback.
5654 */
5655 struct ft_ies {
5656 const u8 *ies;
5657 size_t ies_len;
5658 int ft_action;
5659 u8 target_ap[ETH_ALEN];
5660 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
5661 const u8 *ric_ies;
5662 /** Length of ric_ies buffer in octets */
5663 size_t ric_ies_len;
5664 } ft_ies;
5665
5666 /**
5667 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
5668 */
5669 struct ibss_rsn_start {
5670 u8 peer[ETH_ALEN];
5671 } ibss_rsn_start;
5672
5673 /**
5674 * struct auth_info - Data for EVENT_AUTH events
5675 */
5676 struct auth_info {
5677 u8 peer[ETH_ALEN];
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005678 u8 bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005679 u16 auth_type;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005680 u16 auth_transaction;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005681 u16 status_code;
5682 const u8 *ies;
5683 size_t ies_len;
5684 } auth;
5685
5686 /**
5687 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
5688 */
5689 struct assoc_reject {
5690 /**
5691 * bssid - BSSID of the AP that rejected association
5692 */
5693 const u8 *bssid;
5694
5695 /**
5696 * resp_ies - (Re)Association Response IEs
5697 *
5698 * Optional association data from the driver. This data is not
5699 * required WPA, but may be useful for some protocols and as
5700 * such, should be reported if this is available to the driver
5701 * interface.
5702 *
5703 * This should start with the first IE (fixed fields before IEs
5704 * are not included).
5705 */
5706 const u8 *resp_ies;
5707
5708 /**
5709 * resp_ies_len - Length of resp_ies in bytes
5710 */
5711 size_t resp_ies_len;
5712
5713 /**
5714 * status_code - Status Code from (Re)association Response
5715 */
5716 u16 status_code;
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07005717
5718 /**
5719 * timed_out - Whether failure is due to timeout (etc.) rather
5720 * than explicit rejection response from the AP.
5721 */
5722 int timed_out;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08005723
5724 /**
5725 * timeout_reason - Reason for the timeout
5726 */
5727 const char *timeout_reason;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005728
5729 /**
5730 * fils_erp_next_seq_num - The next sequence number to use in
5731 * FILS ERP messages
5732 */
5733 u16 fils_erp_next_seq_num;
Hai Shalom60840252021-02-19 19:02:11 -08005734
5735 /**
5736 * reason_code - Connection failure reason code from the driver
5737 */
5738 enum sta_connect_fail_reason_codes reason_code;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005739 } assoc_reject;
5740
5741 struct timeout_event {
5742 u8 addr[ETH_ALEN];
5743 } timeout_event;
5744
5745 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005746 * struct tx_status - Data for EVENT_TX_STATUS events
5747 */
5748 struct tx_status {
5749 u16 type;
5750 u16 stype;
5751 const u8 *dst;
5752 const u8 *data;
5753 size_t data_len;
5754 int ack;
5755 } tx_status;
5756
5757 /**
5758 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
5759 */
5760 struct rx_from_unknown {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005761 const u8 *bssid;
5762 const u8 *addr;
5763 int wds;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005764 } rx_from_unknown;
5765
5766 /**
5767 * struct rx_mgmt - Data for EVENT_RX_MGMT events
5768 */
5769 struct rx_mgmt {
5770 const u8 *frame;
5771 size_t frame_len;
5772 u32 datarate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005773
5774 /**
Dmitry Shmidt98660862014-03-11 17:26:21 -07005775 * drv_priv - Pointer to store driver private BSS information
5776 *
5777 * If not set to NULL, this is used for comparison with
5778 * hostapd_data->drv_priv to determine which BSS should process
5779 * the frame.
5780 */
5781 void *drv_priv;
5782
5783 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005784 * freq - Frequency (in MHz) on which the frame was received
5785 */
5786 int freq;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005787
5788 /**
5789 * ssi_signal - Signal strength in dBm (or 0 if not available)
5790 */
5791 int ssi_signal;
5792 } rx_mgmt;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005793
5794 /**
5795 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
5796 *
5797 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
5798 */
5799 struct remain_on_channel {
5800 /**
5801 * freq - Channel frequency in MHz
5802 */
5803 unsigned int freq;
5804
5805 /**
5806 * duration - Duration to remain on the channel in milliseconds
5807 */
5808 unsigned int duration;
5809 } remain_on_channel;
5810
5811 /**
5812 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
5813 * @aborted: Whether the scan was aborted
5814 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
5815 * @num_freqs: Number of entries in freqs array
5816 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
5817 * SSID)
5818 * @num_ssids: Number of entries in ssids array
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08005819 * @external_scan: Whether the scan info is for an external scan
5820 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
5821 * 0 if the source of the scan event is a vendor scan
Dmitry Shmidt29333592017-01-09 12:27:11 -08005822 * @scan_start_tsf: Time when the scan started in terms of TSF of the
5823 * BSS that the interface that requested the scan is connected to
5824 * (if available).
5825 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
5826 * is set.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005827 */
5828 struct scan_info {
5829 int aborted;
5830 const int *freqs;
5831 size_t num_freqs;
5832 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
5833 size_t num_ssids;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08005834 int external_scan;
5835 int nl_scan_event;
Dmitry Shmidt29333592017-01-09 12:27:11 -08005836 u64 scan_start_tsf;
5837 u8 scan_start_tsf_bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005838 } scan_info;
5839
5840 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005841 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
5842 */
5843 struct rx_probe_req {
5844 /**
5845 * sa - Source address of the received Probe Request frame
5846 */
5847 const u8 *sa;
5848
5849 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005850 * da - Destination address of the received Probe Request frame
5851 * or %NULL if not available
5852 */
5853 const u8 *da;
5854
5855 /**
5856 * bssid - BSSID of the received Probe Request frame or %NULL
5857 * if not available
5858 */
5859 const u8 *bssid;
5860
5861 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005862 * ie - IEs from the Probe Request body
5863 */
5864 const u8 *ie;
5865
5866 /**
5867 * ie_len - Length of ie buffer in octets
5868 */
5869 size_t ie_len;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005870
5871 /**
5872 * signal - signal strength in dBm (or 0 if not available)
5873 */
5874 int ssi_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005875 } rx_probe_req;
5876
5877 /**
5878 * struct new_sta - Data for EVENT_NEW_STA events
5879 */
5880 struct new_sta {
5881 const u8 *addr;
5882 } new_sta;
5883
5884 /**
5885 * struct eapol_rx - Data for EVENT_EAPOL_RX events
5886 */
5887 struct eapol_rx {
5888 const u8 *src;
5889 const u8 *data;
5890 size_t data_len;
Sunil8cd6f4d2022-06-28 18:40:46 +00005891 enum frame_encryption encrypted;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005892 } eapol_rx;
5893
5894 /**
5895 * signal_change - Data for EVENT_SIGNAL_CHANGE events
5896 */
5897 struct wpa_signal_info signal_change;
5898
5899 /**
5900 * struct best_channel - Data for EVENT_BEST_CHANNEL events
5901 * @freq_24: Best 2.4 GHz band channel frequency in MHz
5902 * @freq_5: Best 5 GHz band channel frequency in MHz
5903 * @freq_overall: Best channel frequency in MHz
5904 *
5905 * 0 can be used to indicate no preference in either band.
5906 */
5907 struct best_channel {
5908 int freq_24;
5909 int freq_5;
5910 int freq_overall;
5911 } best_chan;
5912
5913 struct unprot_deauth {
5914 const u8 *sa;
5915 const u8 *da;
5916 u16 reason_code;
5917 } unprot_deauth;
5918
5919 struct unprot_disassoc {
5920 const u8 *sa;
5921 const u8 *da;
5922 u16 reason_code;
5923 } unprot_disassoc;
5924
5925 /**
5926 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
5927 * @addr: station address
Paul Stewart092955c2017-02-06 09:13:09 -08005928 * @num_packets: Number of packets lost (consecutive packets not
5929 * acknowledged)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005930 */
5931 struct low_ack {
5932 u8 addr[ETH_ALEN];
Paul Stewart092955c2017-02-06 09:13:09 -08005933 u32 num_packets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005934 } low_ack;
5935
5936 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005937 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
5938 */
5939 struct ibss_peer_lost {
5940 u8 peer[ETH_ALEN];
5941 } ibss_peer_lost;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005942
5943 /**
5944 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
5945 */
5946 struct driver_gtk_rekey {
5947 const u8 *bssid;
5948 const u8 *replay_ctr;
5949 } driver_gtk_rekey;
5950
5951 /**
5952 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
5953 * @addr: station address
5954 */
5955 struct client_poll {
5956 u8 addr[ETH_ALEN];
5957 } client_poll;
5958
5959 /**
5960 * struct eapol_tx_status
5961 * @dst: Original destination
5962 * @data: Data starting with IEEE 802.1X header (!)
5963 * @data_len: Length of data
5964 * @ack: Indicates ack or lost frame
5965 *
5966 * This corresponds to hapd_send_eapol if the frame sent
5967 * there isn't just reported as EVENT_TX_STATUS.
5968 */
5969 struct eapol_tx_status {
5970 const u8 *dst;
5971 const u8 *data;
5972 int data_len;
5973 int ack;
5974 } eapol_tx_status;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005975
5976 /**
5977 * struct ch_switch
5978 * @freq: Frequency of new channel in MHz
5979 * @ht_enabled: Whether this is an HT channel
5980 * @ch_offset: Secondary channel offset
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08005981 * @ch_width: Channel width
5982 * @cf1: Center frequency 1
5983 * @cf2: Center frequency 2
Dmitry Shmidt04949592012-07-19 12:16:46 -07005984 */
5985 struct ch_switch {
5986 int freq;
5987 int ht_enabled;
5988 int ch_offset;
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08005989 enum chan_width ch_width;
5990 int cf1;
5991 int cf2;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005992 } ch_switch;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08005993
5994 /**
5995 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
5996 * @addr: Remote client address
5997 * @code: Reason code for connection failure
5998 */
5999 struct connect_failed_reason {
6000 u8 addr[ETH_ALEN];
6001 enum {
6002 MAX_CLIENT_REACHED,
6003 BLOCKED_CLIENT
6004 } code;
6005 } connect_failed_reason;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07006006
6007 /**
6008 * struct dfs_event - Data for radar detected events
6009 * @freq: Frequency of the channel in MHz
6010 */
6011 struct dfs_event {
6012 int freq;
Dmitry Shmidt051af732013-10-22 13:52:46 -07006013 int ht_enabled;
6014 int chan_offset;
6015 enum chan_width chan_width;
6016 int cf1;
6017 int cf2;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07006018 } dfs_event;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07006019
6020 /**
6021 * survey_results - Survey result data for EVENT_SURVEY
6022 * @freq_filter: Requested frequency survey filter, 0 if request
6023 * was for all survey data
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08006024 * @survey_list: Linked list of survey data (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07006025 */
6026 struct survey_results {
6027 unsigned int freq_filter;
6028 struct dl_list survey_list; /* struct freq_survey */
6029 } survey_results;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08006030
6031 /**
6032 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
6033 * @initiator: Initiator of the regulatory change
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07006034 * @type: Regulatory change type
6035 * @alpha2: Country code (or "" if not available)
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08006036 */
6037 struct channel_list_changed {
6038 enum reg_change_initiator initiator;
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07006039 enum reg_type type;
6040 char alpha2[3];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08006041 } channel_list_changed;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08006042
6043 /**
6044 * freq_range - List of frequency ranges
6045 *
6046 * This is used as the data with EVENT_AVOID_FREQUENCIES.
6047 */
6048 struct wpa_freq_range_list freq_range;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08006049
6050 /**
6051 * struct mesh_peer
6052 *
6053 * @peer: Peer address
6054 * @ies: Beacon IEs
6055 * @ie_len: Length of @ies
6056 *
6057 * Notification of new candidate mesh peer.
6058 */
6059 struct mesh_peer {
6060 const u8 *peer;
6061 const u8 *ies;
6062 size_t ie_len;
6063 } mesh_peer;
6064
6065 /**
6066 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08006067 * @pri_freq: Selected primary frequency
6068 * @sec_freq: Selected secondary frequency
Hai Shalomfdcde762020-04-02 11:19:20 -07006069 * @edmg_channel: Selected EDMG channel
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07006070 * @vht_seg0_center_ch: VHT mode Segment0 center channel
Hai Shalomfdcde762020-04-02 11:19:20 -07006071 * The value is the index of the channel center frequency for
6072 * 20 MHz, 40 MHz, and 80 MHz channels. The value is the center
6073 * frequency index of the primary 80 MHz segment for 160 MHz and
6074 * 80+80 MHz channels.
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07006075 * @vht_seg1_center_ch: VHT mode Segment1 center channel
Hai Shalomfdcde762020-04-02 11:19:20 -07006076 * The value is zero for 20 MHz, 40 MHz, and 80 MHz channels. The
6077 * value is the index of the channel center frequency for 160 MHz
6078 * channels and the center frequency index of the secondary 80 MHz
6079 * segment for 80+80 MHz channels.
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07006080 * @ch_width: Selected Channel width by driver. Driver may choose to
6081 * change hostapd configured ACS channel width due driver internal
6082 * channel restrictions.
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07006083 * hw_mode: Selected band (used with hw_mode=any)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08006084 */
6085 struct acs_selected_channels {
Ahmed ElArabawy0ff61c52019-12-26 12:38:39 -08006086 unsigned int pri_freq;
6087 unsigned int sec_freq;
Hai Shalomfdcde762020-04-02 11:19:20 -07006088 u8 edmg_channel;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07006089 u8 vht_seg0_center_ch;
6090 u8 vht_seg1_center_ch;
6091 u16 ch_width;
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07006092 enum hostapd_hw_mode hw_mode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08006093 } acs_selected_channels;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07006094
6095 /**
6096 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
6097 * @reason_code: Reason for stopping offload
6098 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
6099 * scheduled.
6100 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
6101 * be stopped.
6102 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
6103 * parameters.
6104 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
6105 * supported by device.
6106 */
6107 struct p2p_lo_stop {
6108 enum {
6109 P2P_LO_STOPPED_REASON_COMPLETE = 0,
6110 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
6111 P2P_LO_STOPPED_REASON_INVALID_PARAM,
6112 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
6113 } reason_code;
6114 } p2p_lo_stop;
Roshan Pius3a1667e2018-07-03 15:17:14 -07006115
6116 /* For EVENT_EXTERNAL_AUTH */
6117 struct external_auth external_auth;
6118
6119 /**
6120 * struct sta_opmode - Station's operation mode change event
6121 * @addr: The station MAC address
6122 * @smps_mode: SMPS mode of the station
6123 * @chan_width: Channel width of the station
6124 * @rx_nss: RX_NSS of the station
6125 *
6126 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
6127 */
6128 struct sta_opmode {
6129 const u8 *addr;
6130 enum smps_mode smps_mode;
6131 enum chan_width chan_width;
6132 u8 rx_nss;
6133 } sta_opmode;
6134
6135 /**
6136 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
6137 */
6138 struct wds_sta_interface {
6139 const u8 *sta_addr;
6140 const char *ifname;
6141 enum {
6142 INTERFACE_ADDED,
6143 INTERFACE_REMOVED
6144 } istatus;
6145 } wds_sta_interface;
Hai Shalom81f62d82019-07-22 12:10:00 -07006146
6147 /**
6148 * struct update_dh - Data for EVENT_UPDATE_DH
6149 */
6150 struct update_dh {
6151 const u8 *peer;
6152 const u8 *ie;
6153 size_t ie_len;
6154 } update_dh;
Hai Shalomfdcde762020-04-02 11:19:20 -07006155
6156 /**
6157 * struct unprot_beacon - Data for EVENT_UNPROT_BEACON
6158 */
6159 struct unprot_beacon {
6160 const u8 *sa;
6161 } unprot_beacon;
Sunil Ravia04bd252022-05-02 22:54:18 -07006162
6163 /**
6164 * struct bss_color_collision - Data for EVENT_BSS_COLOR_COLLISION
6165 */
6166 struct bss_color_collision {
6167 u64 bitmap;
6168 } bss_color_collision;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006169};
6170
6171/**
6172 * wpa_supplicant_event - Report a driver event for wpa_supplicant
6173 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
6174 * with struct wpa_driver_ops::init()
6175 * @event: event type (defined above)
6176 * @data: possible extra data for the event
6177 *
6178 * Driver wrapper code should call this function whenever an event is received
6179 * from the driver.
6180 */
6181void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
6182 union wpa_event_data *data);
6183
Dmitry Shmidte4663042016-04-04 10:07:49 -07006184/**
6185 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
6186 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
6187 * with struct wpa_driver_ops::init()
6188 * @event: event type (defined above)
6189 * @data: possible extra data for the event
6190 *
6191 * Same as wpa_supplicant_event(), but we search for the interface in
6192 * wpa_global.
6193 */
6194void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
6195 union wpa_event_data *data);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006196
6197/*
6198 * The following inline functions are provided for convenience to simplify
6199 * event indication for some of the common events.
6200 */
6201
6202static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
6203 size_t ielen, int reassoc)
6204{
6205 union wpa_event_data event;
6206 os_memset(&event, 0, sizeof(event));
6207 event.assoc_info.reassoc = reassoc;
6208 event.assoc_info.req_ies = ie;
6209 event.assoc_info.req_ies_len = ielen;
6210 event.assoc_info.addr = addr;
6211 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
6212}
6213
6214static inline void drv_event_disassoc(void *ctx, const u8 *addr)
6215{
6216 union wpa_event_data event;
6217 os_memset(&event, 0, sizeof(event));
6218 event.disassoc_info.addr = addr;
6219 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
6220}
6221
6222static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
6223 size_t data_len)
6224{
6225 union wpa_event_data event;
6226 os_memset(&event, 0, sizeof(event));
6227 event.eapol_rx.src = src;
6228 event.eapol_rx.data = data;
6229 event.eapol_rx.data_len = data_len;
Sunil8cd6f4d2022-06-28 18:40:46 +00006230 event.eapol_rx.encrypted = FRAME_ENCRYPTION_UNKNOWN;
6231 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
6232}
6233
6234static inline void drv_event_eapol_rx2(void *ctx, const u8 *src, const u8 *data,
6235 size_t data_len,
6236 enum frame_encryption encrypted)
6237{
6238 union wpa_event_data event;
6239 os_memset(&event, 0, sizeof(event));
6240 event.eapol_rx.src = src;
6241 event.eapol_rx.data = data;
6242 event.eapol_rx.data_len = data_len;
6243 event.eapol_rx.encrypted = encrypted;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006244 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
6245}
6246
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08006247/* driver_common.c */
6248void wpa_scan_results_free(struct wpa_scan_results *res);
6249
6250/* Convert wpa_event_type to a string for logging */
6251const char * event_to_string(enum wpa_event_type event);
6252
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07006253/* Convert chan_width to a string for logging and control interfaces */
6254const char * channel_width_to_string(enum chan_width width);
6255
Hai Shalom74f70d42019-02-11 14:42:39 -08006256int channel_width_to_int(enum chan_width width);
6257
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08006258int ht_supported(const struct hostapd_hw_modes *mode);
6259int vht_supported(const struct hostapd_hw_modes *mode);
6260
6261struct wowlan_triggers *
6262wpa_get_wowlan_triggers(const char *wowlan_triggers,
6263 const struct wpa_driver_capa *capa);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07006264/* Convert driver flag to string */
6265const char * driver_flag_to_string(u64 flag);
Hai Shalomb755a2a2020-04-23 21:49:02 -07006266const char * driver_flag2_to_string(u64 flag2);
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08006267
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08006268/* NULL terminated array of linked in driver wrappers */
Dmitry Shmidt1d755d02015-04-28 10:34:29 -07006269extern const struct wpa_driver_ops *const wpa_drivers[];
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08006270
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07006271
6272/* Available drivers */
6273
6274#ifdef CONFIG_DRIVER_WEXT
6275extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
6276#endif /* CONFIG_DRIVER_WEXT */
6277#ifdef CONFIG_DRIVER_NL80211
6278/* driver_nl80211.c */
6279extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
6280#endif /* CONFIG_DRIVER_NL80211 */
6281#ifdef CONFIG_DRIVER_HOSTAP
6282extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
6283#endif /* CONFIG_DRIVER_HOSTAP */
6284#ifdef CONFIG_DRIVER_BSD
6285extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
6286#endif /* CONFIG_DRIVER_BSD */
6287#ifdef CONFIG_DRIVER_OPENBSD
6288/* driver_openbsd.c */
6289extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
6290#endif /* CONFIG_DRIVER_OPENBSD */
6291#ifdef CONFIG_DRIVER_NDIS
6292extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
6293#endif /* CONFIG_DRIVER_NDIS */
6294#ifdef CONFIG_DRIVER_WIRED
6295extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
6296#endif /* CONFIG_DRIVER_WIRED */
6297#ifdef CONFIG_DRIVER_MACSEC_QCA
6298/* driver_macsec_qca.c */
6299extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
6300#endif /* CONFIG_DRIVER_MACSEC_QCA */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08006301#ifdef CONFIG_DRIVER_MACSEC_LINUX
6302/* driver_macsec_linux.c */
6303extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops;
6304#endif /* CONFIG_DRIVER_MACSEC_LINUX */
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07006305#ifdef CONFIG_DRIVER_ROBOSWITCH
6306/* driver_roboswitch.c */
6307extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
6308#endif /* CONFIG_DRIVER_ROBOSWITCH */
6309#ifdef CONFIG_DRIVER_ATHEROS
6310/* driver_atheros.c */
6311extern const struct wpa_driver_ops wpa_driver_atheros_ops;
6312#endif /* CONFIG_DRIVER_ATHEROS */
6313#ifdef CONFIG_DRIVER_NONE
6314extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
6315#endif /* CONFIG_DRIVER_NONE */
6316
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07006317#endif /* DRIVER_H */