blob: 8a5cdb8e95a87d1dfc2affb7b394b6993949de05 [file] [log] [blame]
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001/*
2 * Driver interface definition
Paul Stewart092955c2017-02-06 09:13:09 -08003 * Copyright (c) 2003-2017, Jouni Malinen <j@w1.fi>
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004 *
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07007 *
8 * This file defines a driver interface used by both %wpa_supplicant and
9 * hostapd. The first part of the file defines data structures used in various
10 * driver operations. This is followed by the struct wpa_driver_ops that each
11 * driver wrapper will beed to define with callback functions for requesting
12 * driver operations. After this, there are definitions for driver event
13 * reporting with wpa_supplicant_event() and some convenience helper functions
14 * that can be used to report events.
15 */
16
17#ifndef DRIVER_H
18#define DRIVER_H
19
20#define WPA_SUPPLICANT_DRIVER_VERSION 4
21
22#include "common/defs.h"
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -070023#include "common/ieee802_11_defs.h"
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070024#include "common/wpa_common.h"
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -080025#ifdef CONFIG_MACSEC
26#include "pae/ieee802_1x_kay.h"
27#endif /* CONFIG_MACSEC */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -070028#include "utils/list.h"
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070029
30#define HOSTAPD_CHAN_DISABLED 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080031#define HOSTAPD_CHAN_NO_IR 0x00000002
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070032#define HOSTAPD_CHAN_RADAR 0x00000008
33#define HOSTAPD_CHAN_HT40PLUS 0x00000010
34#define HOSTAPD_CHAN_HT40MINUS 0x00000020
35#define HOSTAPD_CHAN_HT40 0x00000040
Dmitry Shmidt391c59f2013-09-03 12:16:28 -070036#define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070037
Dmitry Shmidtea69e842013-05-13 14:52:28 -070038#define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
39#define HOSTAPD_CHAN_DFS_USABLE 0x00000100
40#define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
41#define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
42#define HOSTAPD_CHAN_DFS_MASK 0x00000300
43
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -070044#define HOSTAPD_CHAN_VHT_10_70 0x00000800
45#define HOSTAPD_CHAN_VHT_30_50 0x00001000
46#define HOSTAPD_CHAN_VHT_50_30 0x00002000
47#define HOSTAPD_CHAN_VHT_70_10 0x00004000
48
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080049#define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
50#define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
51
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -080052#define HOSTAPD_CHAN_VHT_10_150 0x00100000
53#define HOSTAPD_CHAN_VHT_30_130 0x00200000
54#define HOSTAPD_CHAN_VHT_50_110 0x00400000
55#define HOSTAPD_CHAN_VHT_70_90 0x00800000
56#define HOSTAPD_CHAN_VHT_90_70 0x01000000
57#define HOSTAPD_CHAN_VHT_110_50 0x02000000
58#define HOSTAPD_CHAN_VHT_130_30 0x04000000
59#define HOSTAPD_CHAN_VHT_150_10 0x08000000
60
Hai Shalom74f70d42019-02-11 14:42:39 -080061/* Allowed bandwidth mask */
62enum hostapd_chan_width_attr {
63 HOSTAPD_CHAN_WIDTH_10 = BIT(0),
64 HOSTAPD_CHAN_WIDTH_20 = BIT(1),
65 HOSTAPD_CHAN_WIDTH_40P = BIT(2),
66 HOSTAPD_CHAN_WIDTH_40M = BIT(3),
67 HOSTAPD_CHAN_WIDTH_80 = BIT(4),
68 HOSTAPD_CHAN_WIDTH_160 = BIT(5),
69};
70
Dmitry Shmidt849734c2016-05-27 09:59:01 -070071/* Filter gratuitous ARP */
72#define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
73/* Filter unsolicited Neighbor Advertisement */
74#define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
75/* Filter unicast IP packets encrypted using the GTK */
76#define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)
77
Dmitry Shmidtd2986c22017-10-23 14:22:09 -070078#define HOSTAPD_DFS_REGION_FCC 1
79#define HOSTAPD_DFS_REGION_ETSI 2
80#define HOSTAPD_DFS_REGION_JP 3
81
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080082/**
83 * enum reg_change_initiator - Regulatory change initiator
84 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -080085enum reg_change_initiator {
86 REGDOM_SET_BY_CORE,
87 REGDOM_SET_BY_USER,
88 REGDOM_SET_BY_DRIVER,
89 REGDOM_SET_BY_COUNTRY_IE,
Dmitry Shmidt97672262014-02-03 13:02:54 -080090 REGDOM_BEACON_HINT,
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -080091};
92
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080093/**
94 * enum reg_type - Regulatory change types
95 */
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -070096enum reg_type {
97 REGDOM_TYPE_UNKNOWN,
98 REGDOM_TYPE_COUNTRY,
99 REGDOM_TYPE_WORLD,
100 REGDOM_TYPE_CUSTOM_WORLD,
101 REGDOM_TYPE_INTERSECTION,
102};
103
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700104/**
Hai Shalom81f62d82019-07-22 12:10:00 -0700105 * struct hostapd_wmm_rule - WMM regulatory rule
106 * @min_cwmin: Lower bound of CW_min value
107 * @min_cwmax: Lower bound of CW_max value
108 * @min_aifs: Lower bound of AIFS value
109 * @max_txop: Upper bound of TXOP, value in units of 32 usec
110 */
111struct hostapd_wmm_rule {
112 int min_cwmin;
113 int min_cwmax;
114 int min_aifs;
115 int max_txop;
116};
117
118/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700119 * struct hostapd_channel_data - Channel information
120 */
121struct hostapd_channel_data {
122 /**
123 * chan - Channel number (IEEE 802.11)
124 */
125 short chan;
126
127 /**
128 * freq - Frequency in MHz
129 */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800130 int freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700131
132 /**
133 * flag - Channel flags (HOSTAPD_CHAN_*)
134 */
135 int flag;
136
137 /**
Hai Shalom74f70d42019-02-11 14:42:39 -0800138 * allowed_bw - Allowed channel width bitmask
139 *
140 * See enum hostapd_chan_width_attr.
141 */
142 u32 allowed_bw;
143
144 /**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -0700145 * max_tx_power - Regulatory transmit power limit in dBm
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700146 */
147 u8 max_tx_power;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -0700148
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800149 /**
150 * survey_list - Linked list of surveys (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -0700151 */
152 struct dl_list survey_list;
153
154 /**
155 * min_nf - Minimum observed noise floor, in dBm, based on all
156 * surveyed channel data
157 */
158 s8 min_nf;
Dmitry Shmidt391c59f2013-09-03 12:16:28 -0700159
160#ifdef CONFIG_ACS
161 /**
162 * interference_factor - Computed interference factor on this
163 * channel (used internally in src/ap/acs.c; driver wrappers do not
164 * need to set this)
165 */
166 long double interference_factor;
167#endif /* CONFIG_ACS */
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -0700168
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800169 /**
170 * dfs_cac_ms - DFS CAC time in milliseconds
171 */
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -0700172 unsigned int dfs_cac_ms;
Hai Shalom81f62d82019-07-22 12:10:00 -0700173
174 /**
175 * wmm_rules_valid - Indicates wmm_rules state
176 */
177 int wmm_rules_valid;
178
179 /**
180 * wmm_rules - WMM regulatory rules
181 */
182 struct hostapd_wmm_rule wmm_rules[WMM_AC_NUM];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700183};
184
Hai Shalom81f62d82019-07-22 12:10:00 -0700185#define HE_MAX_MAC_CAPAB_SIZE 6
186#define HE_MAX_PHY_CAPAB_SIZE 11
187#define HE_MAX_MCS_CAPAB_SIZE 12
188#define HE_MAX_PPET_CAPAB_SIZE 25
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800189
190/**
191 * struct he_capabilities - IEEE 802.11ax HE capabilities
192 */
193struct he_capabilities {
194 u8 he_supported;
Hai Shalom81f62d82019-07-22 12:10:00 -0700195 u8 phy_cap[HE_MAX_PHY_CAPAB_SIZE];
196 u8 mac_cap[HE_MAX_MAC_CAPAB_SIZE];
197 u8 mcs[HE_MAX_MCS_CAPAB_SIZE];
198 u8 ppet[HE_MAX_PPET_CAPAB_SIZE];
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800199};
200
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800201#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -0700202#define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800203
Hai Shalom81f62d82019-07-22 12:10:00 -0700204
205enum ieee80211_op_mode {
206 IEEE80211_MODE_INFRA = 0,
207 IEEE80211_MODE_IBSS = 1,
208 IEEE80211_MODE_AP = 2,
209 IEEE80211_MODE_MESH = 5,
210
211 /* only add new entries before IEEE80211_MODE_NUM */
212 IEEE80211_MODE_NUM
213};
214
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700215/**
216 * struct hostapd_hw_modes - Supported hardware mode information
217 */
218struct hostapd_hw_modes {
219 /**
220 * mode - Hardware mode
221 */
222 enum hostapd_hw_mode mode;
223
224 /**
225 * num_channels - Number of entries in the channels array
226 */
227 int num_channels;
228
229 /**
230 * channels - Array of supported channels
231 */
232 struct hostapd_channel_data *channels;
233
234 /**
235 * num_rates - Number of entries in the rates array
236 */
237 int num_rates;
238
239 /**
240 * rates - Array of supported rates in 100 kbps units
241 */
242 int *rates;
243
244 /**
245 * ht_capab - HT (IEEE 802.11n) capabilities
246 */
247 u16 ht_capab;
248
249 /**
250 * mcs_set - MCS (IEEE 802.11n) rate parameters
251 */
252 u8 mcs_set[16];
253
254 /**
255 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
256 */
257 u8 a_mpdu_params;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800258
Dmitry Shmidt04949592012-07-19 12:16:46 -0700259 /**
260 * vht_capab - VHT (IEEE 802.11ac) capabilities
261 */
262 u32 vht_capab;
263
264 /**
265 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
266 */
267 u8 vht_mcs_set[8];
268
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800269 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800270
271 /**
272 * he_capab - HE (IEEE 802.11ax) capabilities
273 */
Hai Shalom81f62d82019-07-22 12:10:00 -0700274 struct he_capabilities he_capab[IEEE80211_MODE_NUM];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700275};
276
277
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700278#define IEEE80211_CAP_ESS 0x0001
279#define IEEE80211_CAP_IBSS 0x0002
280#define IEEE80211_CAP_PRIVACY 0x0010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800281#define IEEE80211_CAP_RRM 0x1000
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700282
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800283/* DMG (60 GHz) IEEE 802.11ad */
284/* type - bits 0..1 */
285#define IEEE80211_CAP_DMG_MASK 0x0003
286#define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
287#define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
288#define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
289
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700290#define WPA_SCAN_QUAL_INVALID BIT(0)
291#define WPA_SCAN_NOISE_INVALID BIT(1)
292#define WPA_SCAN_LEVEL_INVALID BIT(2)
293#define WPA_SCAN_LEVEL_DBM BIT(3)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700294#define WPA_SCAN_ASSOCIATED BIT(5)
295
296/**
297 * struct wpa_scan_res - Scan result for an BSS/IBSS
298 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
299 * @bssid: BSSID
300 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
301 * @beacon_int: beacon interval in TUs (host byte order)
302 * @caps: capability information field in host byte order
303 * @qual: signal quality
304 * @noise: noise level
305 * @level: signal level
306 * @tsf: Timestamp
307 * @age: Age of the information in milliseconds (i.e., how many milliseconds
308 * ago the last Beacon or Probe Response frame was received)
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800309 * @est_throughput: Estimated throughput in kbps (this is calculated during
310 * scan result processing if left zero by the driver wrapper)
311 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
Dmitry Shmidt29333592017-01-09 12:27:11 -0800312 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
313 * of TSF of the BSS specified by %tsf_bssid.
314 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700315 * @ie_len: length of the following IE field in octets
316 * @beacon_ie_len: length of the following Beacon IE field in octets
317 *
318 * This structure is used as a generic format for scan results from the
319 * driver. Each driver interface implementation is responsible for converting
320 * the driver or OS specific scan results into this format.
321 *
322 * If the driver does not support reporting all IEs, the IE data structure is
323 * constructed of the IEs that are available. This field will also need to
324 * include SSID in IE format. All drivers are encouraged to be extended to
325 * report all IEs to make it easier to support future additions.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800326 *
327 * This structure data is followed by ie_len octets of IEs from Probe Response
328 * frame (or if the driver does not indicate source of IEs, these may also be
329 * from Beacon frame). After the first set of IEs, another set of IEs may follow
330 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700331 */
332struct wpa_scan_res {
333 unsigned int flags;
334 u8 bssid[ETH_ALEN];
335 int freq;
336 u16 beacon_int;
337 u16 caps;
338 int qual;
339 int noise;
340 int level;
341 u64 tsf;
342 unsigned int age;
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800343 unsigned int est_throughput;
344 int snr;
Dmitry Shmidt29333592017-01-09 12:27:11 -0800345 u64 parent_tsf;
346 u8 tsf_bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700347 size_t ie_len;
348 size_t beacon_ie_len;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800349 /* Followed by ie_len + beacon_ie_len octets of IE data */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700350};
351
352/**
353 * struct wpa_scan_results - Scan results
354 * @res: Array of pointers to allocated variable length scan result entries
355 * @num: Number of entries in the scan result array
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800356 * @fetch_time: Time when the results were fetched from the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700357 */
358struct wpa_scan_results {
359 struct wpa_scan_res **res;
360 size_t num;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800361 struct os_reltime fetch_time;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700362};
363
364/**
365 * struct wpa_interface_info - Network interface information
366 * @next: Pointer to the next interface or NULL if this is the last one
367 * @ifname: Interface name that can be used with init() or init2()
368 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
369 * not available
370 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
371 * is not an allocated copy, i.e., get_interfaces() caller will not free
372 * this)
373 */
374struct wpa_interface_info {
375 struct wpa_interface_info *next;
376 char *ifname;
377 char *desc;
378 const char *drv_name;
379};
380
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800381#define WPAS_MAX_SCAN_SSIDS 16
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700382
383/**
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800384 * struct wpa_driver_scan_ssid - SSIDs to scan for
385 * @ssid - specific SSID to scan for (ProbeReq)
386 * %NULL or zero-length SSID is used to indicate active scan
387 * with wildcard SSID.
388 * @ssid_len - Length of the SSID in octets
389 */
390struct wpa_driver_scan_ssid {
391 const u8 *ssid;
392 size_t ssid_len;
393};
394
395/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700396 * struct wpa_driver_scan_params - Scan parameters
397 * Data for struct wpa_driver_ops::scan2().
398 */
399struct wpa_driver_scan_params {
400 /**
401 * ssids - SSIDs to scan for
402 */
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800403 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700404
405 /**
406 * num_ssids - Number of entries in ssids array
407 * Zero indicates a request for a passive scan.
408 */
409 size_t num_ssids;
410
411 /**
412 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
413 */
414 const u8 *extra_ies;
415
416 /**
417 * extra_ies_len - Length of extra_ies in octets
418 */
419 size_t extra_ies_len;
420
421 /**
422 * freqs - Array of frequencies to scan or %NULL for all frequencies
423 *
424 * The frequency is set in MHz. The array is zero-terminated.
425 */
426 int *freqs;
427
428 /**
429 * filter_ssids - Filter for reporting SSIDs
430 *
431 * This optional parameter can be used to request the driver wrapper to
432 * filter scan results to include only the specified SSIDs. %NULL
433 * indicates that no filtering is to be done. This can be used to
434 * reduce memory needs for scan results in environments that have large
435 * number of APs with different SSIDs.
436 *
437 * The driver wrapper is allowed to take this allocated buffer into its
438 * own use by setting the pointer to %NULL. In that case, the driver
439 * wrapper is responsible for freeing the buffer with os_free() once it
440 * is not needed anymore.
441 */
442 struct wpa_driver_scan_filter {
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -0700443 u8 ssid[SSID_MAX_LEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700444 size_t ssid_len;
445 } *filter_ssids;
446
447 /**
448 * num_filter_ssids - Number of entries in filter_ssids array
449 */
450 size_t num_filter_ssids;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800451
452 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700453 * filter_rssi - Filter by RSSI
454 *
455 * The driver may filter scan results in firmware to reduce host
456 * wakeups and thereby save power. Specify the RSSI threshold in s32
457 * dBm.
458 */
459 s32 filter_rssi;
460
461 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800462 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
463 *
464 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
465 * Mbps from the support rates element(s) in the Probe Request frames
466 * and not to transmit the frames at any of those rates.
467 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700468 unsigned int p2p_probe:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800469
470 /**
471 * only_new_results - Request driver to report only new results
472 *
473 * This is used to request the driver to report only BSSes that have
474 * been detected after this scan request has been started, i.e., to
475 * flush old cached BSS entries.
476 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700477 unsigned int only_new_results:1;
478
479 /**
480 * low_priority - Requests driver to use a lower scan priority
481 *
482 * This is used to request the driver to use a lower scan priority
483 * if it supports such a thing.
484 */
485 unsigned int low_priority:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800486
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800487 /**
488 * mac_addr_rand - Requests driver to randomize MAC address
489 */
490 unsigned int mac_addr_rand:1;
491
492 /**
493 * mac_addr - MAC address used with randomization. The address cannot be
494 * a multicast one, i.e., bit 0 of byte 0 should not be set.
495 */
496 const u8 *mac_addr;
497
498 /**
499 * mac_addr_mask - MAC address mask used with randomization.
500 *
501 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
502 * the mask should be taken as is from mac_addr. The mask should not
503 * allow the generation of a multicast address, i.e., bit 0 of byte 0
504 * must be set.
505 */
506 const u8 *mac_addr_mask;
507
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800508 /**
509 * sched_scan_plans - Scan plans for scheduled scan
510 *
511 * Each scan plan consists of the number of iterations to scan and the
512 * interval between scans. When a scan plan finishes (i.e., it was run
513 * for the specified number of iterations), the next scan plan is
514 * executed. The scan plans are executed in the order they appear in
515 * the array (lower index first). The last scan plan will run infinitely
516 * (until requested to stop), thus must not specify the number of
517 * iterations. All other scan plans must specify the number of
518 * iterations.
519 */
520 struct sched_scan_plan {
521 u32 interval; /* In seconds */
522 u32 iterations; /* Zero to run infinitely */
523 } *sched_scan_plans;
524
525 /**
526 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
527 */
528 unsigned int sched_scan_plans_num;
529
Dmitry Shmidt9c175262016-03-03 10:20:07 -0800530 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700531 * sched_scan_start_delay - Delay to use before starting the first scan
532 *
533 * Delay (in seconds) before scheduling first scan plan cycle. The
534 * driver may ignore this parameter and start immediately (or at any
535 * other time), if this feature is not supported.
536 */
537 u32 sched_scan_start_delay;
538
539 /**
Dmitry Shmidt9c175262016-03-03 10:20:07 -0800540 * bssid - Specific BSSID to scan for
541 *
542 * This optional parameter can be used to replace the default wildcard
543 * BSSID with a specific BSSID to scan for if results are needed from
544 * only a single BSS.
545 */
546 const u8 *bssid;
547
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800548 /**
549 * scan_cookie - Unique identification representing the scan request
550 *
551 * This scan_cookie carries a unique identification representing the
552 * scan request if the host driver/kernel supports concurrent scan
553 * requests. This cookie is returned from the corresponding driver
554 * interface.
555 *
556 * Note: Unlike other parameters in this structure, scan_cookie is used
557 * only to return information instead of setting parameters for the
558 * scan.
559 */
560 u64 scan_cookie;
561
Dmitry Shmidt29333592017-01-09 12:27:11 -0800562 /**
563 * duration - Dwell time on each channel
564 *
565 * This optional parameter can be used to set the dwell time on each
566 * channel. In TUs.
567 */
568 u16 duration;
569
570 /**
571 * duration_mandatory - Whether the specified duration is mandatory
572 *
573 * If this is set, the duration specified by the %duration field is
574 * mandatory (and the driver should reject the scan request if it is
575 * unable to comply with the specified duration), otherwise it is the
576 * maximum duration and the actual duration may be shorter.
577 */
578 unsigned int duration_mandatory:1;
579
Dmitry Shmidtebd93af2017-02-21 13:40:44 -0800580 /**
581 * relative_rssi_set - Whether relative RSSI parameters are set
582 */
583 unsigned int relative_rssi_set:1;
584
585 /**
586 * relative_rssi - Relative RSSI for reporting better BSSs
587 *
588 * Amount of RSSI by which a BSS should be better than the current
589 * connected BSS to report the new BSS to user space.
590 */
591 s8 relative_rssi;
592
593 /**
594 * relative_adjust_band - Band to which RSSI should be adjusted
595 *
596 * The relative_adjust_rssi should be added to the band specified
597 * by relative_adjust_band.
598 */
599 enum set_band relative_adjust_band;
600
601 /**
602 * relative_adjust_rssi - RSSI to be added to relative_adjust_band
603 *
604 * An amount of relative_band_rssi should be added to the BSSs that
605 * belong to the band specified by relative_adjust_band while comparing
606 * with other bands for BSS reporting.
607 */
608 s8 relative_adjust_rssi;
609
Hai Shalomce48b4a2018-09-05 11:41:35 -0700610 /**
611 * oce_scan
612 *
613 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0)
614 * - Accept broadcast Probe Response frame.
615 * - Probe Request frame deferral and suppression.
616 * - Max Channel Time - driver fills FILS request params IE with
617 * Maximum Channel Time.
618 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps.
619 */
620 unsigned int oce_scan:1;
621
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800622 /*
623 * NOTE: Whenever adding new parameters here, please make sure
624 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
625 * matching changes.
626 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700627};
628
629/**
630 * struct wpa_driver_auth_params - Authentication parameters
631 * Data for struct wpa_driver_ops::authenticate().
632 */
633struct wpa_driver_auth_params {
634 int freq;
635 const u8 *bssid;
636 const u8 *ssid;
637 size_t ssid_len;
638 int auth_alg;
639 const u8 *ie;
640 size_t ie_len;
641 const u8 *wep_key[4];
642 size_t wep_key_len[4];
643 int wep_tx_keyidx;
644 int local_state_change;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800645
646 /**
647 * p2p - Whether this connection is a P2P group
648 */
649 int p2p;
650
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800651 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800652 * auth_data - Additional elements for Authentication frame
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800653 *
654 * This buffer starts with the Authentication transaction sequence
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800655 * number field. If no special handling of such elements is needed, this
656 * pointer is %NULL. This is used with SAE and FILS.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800657 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800658 const u8 *auth_data;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800659
660 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800661 * auth_data_len - Length of auth_data buffer in octets
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800662 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800663 size_t auth_data_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700664};
665
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800666/**
667 * enum wps_mode - WPS mode
668 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700669enum wps_mode {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800670 /**
671 * WPS_MODE_NONE - No WPS provisioning being used
672 */
673 WPS_MODE_NONE,
674
675 /**
676 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
677 */
678 WPS_MODE_OPEN,
679
680 /**
681 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
682 */
683 WPS_MODE_PRIVACY
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700684};
685
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800686/**
687 * struct hostapd_freq_params - Channel parameters
688 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700689struct hostapd_freq_params {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800690 /**
691 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
692 */
693 enum hostapd_hw_mode mode;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700694
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800695 /**
696 * freq - Primary channel center frequency in MHz
697 */
698 int freq;
699
700 /**
701 * channel - Channel number
702 */
703 int channel;
704
705 /**
706 * ht_enabled - Whether HT is enabled
707 */
708 int ht_enabled;
709
710 /**
711 * sec_channel_offset - Secondary channel offset for HT40
712 *
713 * 0 = HT40 disabled,
714 * -1 = HT40 enabled, secondary channel below primary,
715 * 1 = HT40 enabled, secondary channel above primary
716 */
717 int sec_channel_offset;
718
719 /**
720 * vht_enabled - Whether VHT is enabled
721 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700722 int vht_enabled;
723
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800724 /**
Hai Shalom81f62d82019-07-22 12:10:00 -0700725 * he_enabled - Whether HE is enabled
726 */
727 int he_enabled;
728
729 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800730 * center_freq1 - Segment 0 center frequency in MHz
731 *
732 * Valid for both HT and VHT.
733 */
734 int center_freq1;
735
736 /**
737 * center_freq2 - Segment 1 center frequency in MHz
738 *
739 * Non-zero only for bandwidth 80 and an 80+80 channel
740 */
741 int center_freq2;
742
743 /**
744 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
745 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700746 int bandwidth;
747};
748
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700749/**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700750 * struct wpa_driver_sta_auth_params - Authentication parameters
751 * Data for struct wpa_driver_ops::sta_auth().
752 */
753struct wpa_driver_sta_auth_params {
754
755 /**
756 * own_addr - Source address and BSSID for authentication frame
757 */
758 const u8 *own_addr;
759
760 /**
761 * addr - MAC address of the station to associate
762 */
763 const u8 *addr;
764
765 /**
766 * seq - authentication sequence number
767 */
768 u16 seq;
769
770 /**
771 * status - authentication response status code
772 */
773 u16 status;
774
775 /**
776 * ie - authentication frame ie buffer
777 */
778 const u8 *ie;
779
780 /**
781 * len - ie buffer length
782 */
783 size_t len;
784
785 /**
786 * fils_auth - Indicates whether FILS authentication is being performed
787 */
788 int fils_auth;
789
790 /**
791 * fils_anonce - ANonce (required for FILS)
792 */
793 u8 fils_anonce[WPA_NONCE_LEN];
794
795 /**
796 * fils_snonce - SNonce (required for FILS)
797 */
798 u8 fils_snonce[WPA_NONCE_LEN];
799
800 /**
801 * fils_kek - key for encryption (required for FILS)
802 */
803 u8 fils_kek[WPA_KEK_MAX_LEN];
804
805 /**
806 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
807 */
808 size_t fils_kek_len;
809};
810
811/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700812 * struct wpa_driver_associate_params - Association parameters
813 * Data for struct wpa_driver_ops::associate().
814 */
815struct wpa_driver_associate_params {
816 /**
817 * bssid - BSSID of the selected AP
818 * This can be %NULL, if ap_scan=2 mode is used and the driver is
819 * responsible for selecting with which BSS to associate. */
820 const u8 *bssid;
821
822 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800823 * bssid_hint - BSSID of a proposed AP
824 *
825 * This indicates which BSS has been found a suitable candidate for
826 * initial association for drivers that use driver/firmwate-based BSS
827 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
828 * the driver from selecting other BSSes in the ESS.
829 */
830 const u8 *bssid_hint;
831
832 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700833 * ssid - The selected SSID
834 */
835 const u8 *ssid;
836
837 /**
838 * ssid_len - Length of the SSID (1..32)
839 */
840 size_t ssid_len;
841
842 /**
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700843 * freq - channel parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700844 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700845 struct hostapd_freq_params freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700846
847 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800848 * freq_hint - Frequency of the channel the proposed AP is using
849 *
850 * This provides a channel on which a suitable BSS has been found as a
851 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
852 * limit the driver from selecting other channels for
853 * driver/firmware-based BSS selection.
854 */
855 int freq_hint;
856
857 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700858 * bg_scan_period - Background scan period in seconds, 0 to disable
859 * background scan, or -1 to indicate no change to default driver
860 * configuration
861 */
862 int bg_scan_period;
863
864 /**
Dmitry Shmidt2ac5f602014-03-07 10:08:21 -0800865 * beacon_int - Beacon interval for IBSS or 0 to use driver default
866 */
867 int beacon_int;
868
869 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700870 * wpa_ie - WPA information element for (Re)Association Request
871 * WPA information element to be included in (Re)Association
872 * Request (including information element id and length). Use
873 * of this WPA IE is optional. If the driver generates the WPA
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700874 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700875 * key_mgmt_suite to select proper algorithms. In this case,
876 * the driver has to notify wpa_supplicant about the used WPA
877 * IE by generating an event that the interface code will
878 * convert into EVENT_ASSOCINFO data (see below).
879 *
880 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
881 * instead. The driver can determine which version is used by
882 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
883 * WPA2/RSN).
884 *
885 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
886 */
887 const u8 *wpa_ie;
888
889 /**
890 * wpa_ie_len - length of the wpa_ie
891 */
892 size_t wpa_ie_len;
893
894 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800895 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
896 */
897 unsigned int wpa_proto;
898
899 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800900 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700901 *
902 * This is usually ignored if @wpa_ie is used.
903 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800904 unsigned int pairwise_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700905
906 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800907 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700908 *
909 * This is usually ignored if @wpa_ie is used.
910 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800911 unsigned int group_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700912
913 /**
Dmitry Shmidtd2986c22017-10-23 14:22:09 -0700914 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
915 *
916 * This is usually ignored if @wpa_ie is used.
917 */
918 unsigned int mgmt_group_suite;
919
920 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800921 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700922 *
923 * This is usually ignored if @wpa_ie is used.
924 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800925 unsigned int key_mgmt_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700926
927 /**
928 * auth_alg - Allowed authentication algorithms
929 * Bit field of WPA_AUTH_ALG_*
930 */
931 int auth_alg;
932
933 /**
934 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
935 */
936 int mode;
937
938 /**
939 * wep_key - WEP keys for static WEP configuration
940 */
941 const u8 *wep_key[4];
942
943 /**
944 * wep_key_len - WEP key length for static WEP configuration
945 */
946 size_t wep_key_len[4];
947
948 /**
949 * wep_tx_keyidx - WEP TX key index for static WEP configuration
950 */
951 int wep_tx_keyidx;
952
953 /**
954 * mgmt_frame_protection - IEEE 802.11w management frame protection
955 */
956 enum mfp_options mgmt_frame_protection;
957
958 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700959 * passphrase - RSN passphrase for PSK
960 *
961 * This value is made available only for WPA/WPA2-Personal (PSK) and
Hai Shalom74f70d42019-02-11 14:42:39 -0800962 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
963 * is the 8..63 character ASCII passphrase, if available. Please note
964 * that this can be %NULL if passphrase was not used to generate the
965 * PSK. In that case, the psk field must be used to fetch the PSK.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700966 */
967 const char *passphrase;
968
969 /**
970 * psk - RSN PSK (alternative for passphrase for PSK)
971 *
972 * This value is made available only for WPA/WPA2-Personal (PSK) and
Hai Shalom74f70d42019-02-11 14:42:39 -0800973 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
974 * is the 32-octet (256-bit) PSK, if available. The driver wrapper
975 * should be prepared to handle %NULL value as an error.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700976 */
977 const u8 *psk;
978
979 /**
980 * drop_unencrypted - Enable/disable unencrypted frame filtering
981 *
982 * Configure the driver to drop all non-EAPOL frames (both receive and
983 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
984 * still be allowed for key negotiation.
985 */
986 int drop_unencrypted;
987
988 /**
989 * prev_bssid - Previously used BSSID in this ESS
990 *
991 * When not %NULL, this is a request to use reassociation instead of
992 * association.
993 */
994 const u8 *prev_bssid;
995
996 /**
997 * wps - WPS mode
998 *
999 * If the driver needs to do special configuration for WPS association,
1000 * this variable provides more information on what type of association
1001 * is being requested. Most drivers should not need ot use this.
1002 */
1003 enum wps_mode wps;
1004
1005 /**
1006 * p2p - Whether this connection is a P2P group
1007 */
1008 int p2p;
1009
1010 /**
1011 * uapsd - UAPSD parameters for the network
1012 * -1 = do not change defaults
1013 * AP mode: 1 = enabled, 0 = disabled
1014 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
1015 */
1016 int uapsd;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001017
1018 /**
1019 * fixed_bssid - Whether to force this BSSID in IBSS mode
1020 * 1 = Fix this BSSID and prevent merges.
1021 * 0 = Do not fix BSSID.
1022 */
1023 int fixed_bssid;
1024
1025 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001026 * fixed_freq - Fix control channel in IBSS mode
1027 * 0 = don't fix control channel (default)
1028 * 1 = fix control channel; this prevents IBSS merging with another
1029 * channel
1030 */
1031 int fixed_freq;
1032
1033 /**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001034 * disable_ht - Disable HT (IEEE 802.11n) for this connection
1035 */
1036 int disable_ht;
1037
1038 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001039 * htcaps - HT Capabilities over-rides
1040 *
1041 * Only bits set in the mask will be used, and not all values are used
1042 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
1043 *
1044 * Pointer to struct ieee80211_ht_capabilities.
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08001045 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001046 const u8 *htcaps;
1047
1048 /**
1049 * htcaps_mask - HT Capabilities over-rides mask
1050 *
1051 * Pointer to struct ieee80211_ht_capabilities.
1052 */
1053 const u8 *htcaps_mask;
Dmitry Shmidt2f023192013-03-12 12:44:17 -07001054
1055#ifdef CONFIG_VHT_OVERRIDES
1056 /**
1057 * disable_vht - Disable VHT for this connection
1058 */
1059 int disable_vht;
1060
1061 /**
1062 * VHT capability overrides.
1063 */
1064 const struct ieee80211_vht_capabilities *vhtcaps;
1065 const struct ieee80211_vht_capabilities *vhtcaps_mask;
1066#endif /* CONFIG_VHT_OVERRIDES */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001067
1068 /**
1069 * req_key_mgmt_offload - Request key management offload for connection
1070 *
1071 * Request key management offload for this connection if the device
1072 * supports it.
1073 */
1074 int req_key_mgmt_offload;
1075
1076 /**
1077 * Flag for indicating whether this association includes support for
1078 * RRM (Radio Resource Measurements)
1079 */
1080 int rrm_used;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001081
1082 /**
1083 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1084 * AP as usual. Valid for DMG network only.
1085 */
1086 int pbss;
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001087
1088 /**
1089 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1090 */
1091 const u8 *fils_kek;
1092
1093 /**
1094 * fils_kek_len: Length of fils_kek in bytes
1095 */
1096 size_t fils_kek_len;
1097
1098 /**
1099 * fils_nonces - Nonces for FILS association frame protection
1100 * (AES-SIV AAD)
1101 */
1102 const u8 *fils_nonces;
1103
1104 /**
1105 * fils_nonces_len: Length of fils_nonce in bytes
1106 */
1107 size_t fils_nonces_len;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001108
1109 /**
1110 * fils_erp_username - Username part of keyName-NAI
1111 */
1112 const u8 *fils_erp_username;
1113
1114 /**
1115 * fils_erp_username_len - Length of fils_erp_username in bytes
1116 */
1117 size_t fils_erp_username_len;
1118
1119 /**
1120 * fils_erp_realm - Realm/domain name to use in FILS ERP
1121 */
1122 const u8 *fils_erp_realm;
1123
1124 /**
1125 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1126 */
1127 size_t fils_erp_realm_len;
1128
1129 /**
1130 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1131 * messages
1132 */
1133 u16 fils_erp_next_seq_num;
1134
1135 /**
1136 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1137 * specified by fils_erp_username@fils_erp_realm.
1138 */
1139 const u8 *fils_erp_rrk;
1140
1141 /**
1142 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1143 */
1144 size_t fils_erp_rrk_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001145};
1146
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001147enum hide_ssid {
1148 NO_SSID_HIDING,
1149 HIDDEN_SSID_ZERO_LEN,
1150 HIDDEN_SSID_ZERO_CONTENTS
1151};
1152
Hai Shalom81f62d82019-07-22 12:10:00 -07001153enum ch_switch_state {
1154 CH_SW_STARTED,
1155 CH_SW_FINISHED
1156};
1157
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001158struct wowlan_triggers {
1159 u8 any;
1160 u8 disconnect;
1161 u8 magic_pkt;
1162 u8 gtk_rekey_failure;
1163 u8 eap_identity_req;
1164 u8 four_way_handshake;
1165 u8 rfkill_release;
1166};
1167
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001168struct wpa_driver_ap_params {
1169 /**
1170 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1171 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001172 u8 *head;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001173
1174 /**
1175 * head_len - Length of the head buffer in octets
1176 */
1177 size_t head_len;
1178
1179 /**
1180 * tail - Beacon tail following TIM IE
1181 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001182 u8 *tail;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001183
1184 /**
1185 * tail_len - Length of the tail buffer in octets
1186 */
1187 size_t tail_len;
1188
1189 /**
1190 * dtim_period - DTIM period
1191 */
1192 int dtim_period;
1193
1194 /**
1195 * beacon_int - Beacon interval
1196 */
1197 int beacon_int;
1198
1199 /**
1200 * basic_rates: -1 terminated array of basic rates in 100 kbps
1201 *
1202 * This parameter can be used to set a specific basic rate set for the
1203 * BSS. If %NULL, default basic rate set is used.
1204 */
1205 int *basic_rates;
1206
1207 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001208 * beacon_rate: Beacon frame data rate
1209 *
1210 * This parameter can be used to set a specific Beacon frame data rate
1211 * for the BSS. The interpretation of this value depends on the
1212 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS). If
1213 * beacon_rate == 0 and rate_type == 0 (BEACON_RATE_LEGACY), the default
1214 * Beacon frame data rate is used.
1215 */
1216 unsigned int beacon_rate;
1217
1218 /**
1219 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT)
1220 */
1221 enum beacon_rate_type rate_type;
1222
1223 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001224 * proberesp - Probe Response template
1225 *
1226 * This is used by drivers that reply to Probe Requests internally in
1227 * AP mode and require the full Probe Response template.
1228 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001229 u8 *proberesp;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001230
1231 /**
1232 * proberesp_len - Length of the proberesp buffer in octets
1233 */
1234 size_t proberesp_len;
1235
1236 /**
1237 * ssid - The SSID to use in Beacon/Probe Response frames
1238 */
1239 const u8 *ssid;
1240
1241 /**
1242 * ssid_len - Length of the SSID (1..32)
1243 */
1244 size_t ssid_len;
1245
1246 /**
1247 * hide_ssid - Whether to hide the SSID
1248 */
1249 enum hide_ssid hide_ssid;
1250
1251 /**
1252 * pairwise_ciphers - WPA_CIPHER_* bitfield
1253 */
1254 unsigned int pairwise_ciphers;
1255
1256 /**
1257 * group_cipher - WPA_CIPHER_*
1258 */
1259 unsigned int group_cipher;
1260
1261 /**
1262 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1263 */
1264 unsigned int key_mgmt_suites;
1265
1266 /**
1267 * auth_algs - WPA_AUTH_ALG_* bitfield
1268 */
1269 unsigned int auth_algs;
1270
1271 /**
1272 * wpa_version - WPA_PROTO_* bitfield
1273 */
1274 unsigned int wpa_version;
1275
1276 /**
1277 * privacy - Whether privacy is used in the BSS
1278 */
1279 int privacy;
1280
1281 /**
1282 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1283 *
1284 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1285 * not use the full Beacon template.
1286 */
1287 const struct wpabuf *beacon_ies;
1288
1289 /**
1290 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1291 *
1292 * This is used to add IEs like WPS IE and P2P IE by drivers that
1293 * reply to Probe Request frames internally.
1294 */
1295 const struct wpabuf *proberesp_ies;
1296
1297 /**
1298 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1299 *
1300 * This is used to add IEs like WPS IE by drivers that reply to
1301 * (Re)Association Request frames internally.
1302 */
1303 const struct wpabuf *assocresp_ies;
1304
1305 /**
1306 * isolate - Whether to isolate frames between associated stations
1307 *
1308 * If this is non-zero, the AP is requested to disable forwarding of
1309 * frames between associated stations.
1310 */
1311 int isolate;
1312
1313 /**
1314 * cts_protect - Whether CTS protection is enabled
1315 */
1316 int cts_protect;
1317
1318 /**
1319 * preamble - Whether short preamble is enabled
1320 */
1321 int preamble;
1322
1323 /**
1324 * short_slot_time - Whether short slot time is enabled
1325 *
1326 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1327 * not set (e.g., when 802.11g mode is not in use)
1328 */
1329 int short_slot_time;
1330
1331 /**
1332 * ht_opmode - HT operation mode or -1 if HT not in use
1333 */
1334 int ht_opmode;
1335
1336 /**
1337 * interworking - Whether Interworking is enabled
1338 */
1339 int interworking;
1340
1341 /**
1342 * hessid - Homogeneous ESS identifier or %NULL if not set
1343 */
1344 const u8 *hessid;
1345
1346 /**
1347 * access_network_type - Access Network Type (0..15)
1348 *
1349 * This is used for filtering Probe Request frames when Interworking is
1350 * enabled.
1351 */
1352 u8 access_network_type;
Dmitry Shmidt04949592012-07-19 12:16:46 -07001353
1354 /**
1355 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1356 *
1357 * This is used by driver which advertises this capability.
1358 */
1359 int ap_max_inactivity;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001360
1361 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001362 * ctwindow - Client Traffic Window (in TUs)
1363 */
1364 u8 p2p_go_ctwindow;
1365
1366 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001367 * smps_mode - SMPS mode
1368 *
1369 * SMPS mode to be used by the AP, specified as the relevant bits of
1370 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1371 */
1372 unsigned int smps_mode;
1373
1374 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001375 * disable_dgaf - Whether group-addressed frames are disabled
1376 */
1377 int disable_dgaf;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001378
1379 /**
1380 * osen - Whether OSEN security is enabled
1381 */
1382 int osen;
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001383
1384 /**
1385 * freq - Channel parameters for dynamic bandwidth changes
1386 */
1387 struct hostapd_freq_params *freq;
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001388
1389 /**
1390 * reenable - Whether this is to re-enable beaconing
1391 */
1392 int reenable;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001393
1394 /**
1395 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1396 * infrastructure BSS. Valid only for DMG network.
1397 */
1398 int pbss;
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001399
1400 /**
1401 * multicast_to_unicast - Whether to use multicast_to_unicast
1402 *
1403 * If this is non-zero, the AP is requested to perform multicast to
1404 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1405 * 802.1Q). If enabled, such frames are to be sent to each station
1406 * separately, with the DA replaced by their own MAC address rather
1407 * than the group address.
1408 *
1409 * Note that this may break certain expectations of the receiver, such
1410 * as the ability to drop unicast IP packets received within multicast
1411 * L2 frames, or the ability to not send ICMP destination unreachable
1412 * messages for packets received in L2 multicast (which is required,
1413 * but the receiver can't tell the difference if this new option is
1414 * enabled.)
1415 *
1416 * This also doesn't implement the 802.11 DMS (directed multicast
1417 * service).
1418 */
1419 int multicast_to_unicast;
Hai Shalom74f70d42019-02-11 14:42:39 -08001420
1421 /**
1422 * ftm_responder - Whether FTM responder is enabled
1423 */
1424 int ftm_responder;
1425
1426 /**
1427 * lci - Binary data, the content of an LCI report IE with type 8 as
1428 * defined in IEEE Std 802.11-2016, 9.4.2.22.10
1429 */
1430 const struct wpabuf *lci;
1431
1432 /**
1433 * civic - Binary data, the content of a measurement report IE with
1434 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
1435 */
1436 const struct wpabuf *civic;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001437};
1438
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001439struct wpa_driver_mesh_bss_params {
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001440#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1441#define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1442#define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1443#define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001444#define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001445 /*
1446 * TODO: Other mesh configuration parameters would go here.
1447 * See NL80211_MESHCONF_* for all the mesh config parameters.
1448 */
1449 unsigned int flags;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001450 int auto_plinks;
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001451 int peer_link_timeout;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001452 int max_peer_links;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001453 int rssi_threshold;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001454 u16 ht_opmode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001455};
1456
1457struct wpa_driver_mesh_join_params {
1458 const u8 *meshid;
1459 int meshid_len;
1460 const int *basic_rates;
1461 const u8 *ies;
1462 int ie_len;
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001463 struct hostapd_freq_params freq;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001464 int beacon_int;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001465 int dtim_period;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001466 struct wpa_driver_mesh_bss_params conf;
1467#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1468#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1469#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1470#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1471 unsigned int flags;
1472};
1473
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001474/**
1475 * struct wpa_driver_capa - Driver capability information
1476 */
1477struct wpa_driver_capa {
1478#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1479#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1480#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1481#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1482#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1483#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1484#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001485#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001486#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1487#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001488#define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
1489#define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
1490#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1491#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1492#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1493#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
Hai Shalom74f70d42019-02-11 14:42:39 -08001494#define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001495 /** Bitfield of supported key management suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001496 unsigned int key_mgmt;
1497
1498#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1499#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1500#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1501#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
Dmitry Shmidt04949592012-07-19 12:16:46 -07001502#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001503#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001504#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1505#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1506#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1507#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1508#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1509#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001510#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001511 /** Bitfield of supported cipher suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001512 unsigned int enc;
1513
1514#define WPA_DRIVER_AUTH_OPEN 0x00000001
1515#define WPA_DRIVER_AUTH_SHARED 0x00000002
1516#define WPA_DRIVER_AUTH_LEAP 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001517 /** Bitfield of supported IEEE 802.11 authentication algorithms */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001518 unsigned int auth;
1519
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001520/** Driver generated WPA/RSN IE */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001521#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001522/** Driver needs static WEP key setup after association command */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001523#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001524/** Driver takes care of all DFS operations */
Dmitry Shmidtd11f0192014-03-24 12:09:47 -07001525#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001526/** Driver takes care of RSN 4-way handshake internally; PMK is configured with
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001527 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
Hai Shalom74f70d42019-02-11 14:42:39 -08001528#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001529/** Driver is for a wired Ethernet interface */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001530#define WPA_DRIVER_FLAGS_WIRED 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001531/** Driver provides separate commands for authentication and association (SME in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001532 * wpa_supplicant). */
1533#define WPA_DRIVER_FLAGS_SME 0x00000020
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001534/** Driver supports AP mode */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001535#define WPA_DRIVER_FLAGS_AP 0x00000040
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001536/** Driver needs static WEP key setup after association has been completed */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001537#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001538/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001539#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001540/** Driver supports concurrent P2P operations */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001541#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001542/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001543 * Driver uses the initial interface as a dedicated management interface, i.e.,
1544 * it cannot be used for P2P group operations or non-P2P purposes.
1545 */
1546#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001547/** This interface is P2P capable (P2P GO or P2P Client) */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001548#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001549/** Driver supports station and key removal when stopping an AP */
Dmitry Shmidta38abf92014-03-06 13:38:44 -08001550#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001551/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001552 * Driver uses the initial interface for P2P management interface and non-P2P
1553 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1554 * P2P group operations.
1555 */
1556#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001557/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001558 * Driver is known to use sane error codes, i.e., when it indicates that
1559 * something (e.g., association) fails, there was indeed a failure and the
1560 * operation does not end up getting completed successfully later.
1561 */
1562#define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001563/** Driver supports off-channel TX */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001564#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001565/** Driver indicates TX status events for EAPOL Data frames */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001566#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001567/** Driver indicates TX status events for Deauth/Disassoc frames */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001568#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001569/** Driver supports roaming (BSS selection) in firmware */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001570#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001571/** Driver supports operating as a TDLS peer */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001572#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001573/** Driver requires external TDLS setup/teardown/discovery */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001574#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001575/** Driver indicates support for Probe Response offloading in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001576#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001577/** Driver supports U-APSD in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001578#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001579/** Driver supports inactivity timer in AP mode */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001580#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001581/** Driver expects user space implementation of MLME in AP mode */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001582#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001583/** Driver supports SAE with user space SME */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001584#define WPA_DRIVER_FLAGS_SAE 0x02000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001585/** Driver makes use of OBSS scan mechanism in wpa_supplicant */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001586#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001587/** Driver supports IBSS (Ad-hoc) mode */
Dmitry Shmidt700a1372013-03-15 14:14:44 -07001588#define WPA_DRIVER_FLAGS_IBSS 0x08000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001589/** Driver supports radar detection */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07001590#define WPA_DRIVER_FLAGS_RADAR 0x10000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001591/** Driver supports a dedicated interface for P2P Device */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001592#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001593/** Driver supports QoS Mapping */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001594#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001595/** Driver supports CSA in AP mode */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001596#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001597/** Driver supports mesh */
1598#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1599/** Driver support ACS offload */
1600#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1601/** Driver supports key management offload */
1602#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1603/** Driver supports TDLS channel switching */
1604#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001605/** Driver supports IBSS with HT datarates */
1606#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001607/** Driver supports IBSS with VHT datarates */
1608#define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07001609/** Driver supports automatic band selection */
1610#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001611/** Driver supports simultaneous off-channel operations */
1612#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001613/** Driver supports full AP client state */
1614#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001615/** Driver supports P2P Listen offload */
1616#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001617/** Driver supports FILS */
1618#define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001619/** Driver supports Beacon frame TX rate configuration (legacy rates) */
1620#define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1621/** Driver supports Beacon frame TX rate configuration (HT rates) */
1622#define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1623/** Driver supports Beacon frame TX rate configuration (VHT rates) */
1624#define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08001625/** Driver supports mgmt_tx with random TX address in non-connected state */
1626#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
1627/** Driver supports mgmt_tx with random TX addr in connected state */
1628#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
1629/** Driver supports better BSS reporting with sched_scan in connected mode */
1630#define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
1631/** Driver supports HE capabilities */
1632#define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001633/** Driver supports FILS shared key offload */
1634#define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
1635/** Driver supports all OCE STA specific mandatory features */
1636#define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
1637/** Driver supports all OCE AP specific mandatory features */
1638#define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
1639/**
1640 * Driver supports all OCE STA-CFON specific mandatory features only.
1641 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
1642 * userspace shall assume that this driver may not support all OCE AP
1643 * functionality but can support only OCE STA-CFON functionality.
1644 */
1645#define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
Roshan Pius3a1667e2018-07-03 15:17:14 -07001646/** Driver supports MFP-optional in the connect command */
1647#define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL
Hai Shalom39ba6fc2019-01-22 12:40:38 -08001648/** Driver is a self-managed regulatory device */
1649#define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL
Hai Shalom74f70d42019-02-11 14:42:39 -08001650/** Driver supports FTM responder functionality */
1651#define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL
1652/** Driver support 4-way handshake offload for WPA-Personal */
1653#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001654 u64 flags;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001655
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001656#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1657 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1658
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001659#define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1660#define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1661 unsigned int smps_modes;
1662
1663 unsigned int wmm_ac_supported:1;
1664
1665 unsigned int mac_addr_rand_scan_supported:1;
1666 unsigned int mac_addr_rand_sched_scan_supported:1;
1667
1668 /** Maximum number of supported active probe SSIDs */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001669 int max_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001670
1671 /** Maximum number of supported active probe SSIDs for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001672 int max_sched_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001673
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08001674 /** Maximum number of supported scan plans for scheduled scan */
1675 unsigned int max_sched_scan_plans;
1676
1677 /** Maximum interval in a scan plan. In seconds */
1678 u32 max_sched_scan_plan_interval;
1679
1680 /** Maximum number of iterations in a single scan plan */
1681 u32 max_sched_scan_plan_iterations;
1682
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001683 /** Whether sched_scan (offloaded scanning) is supported */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001684 int sched_scan_supported;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001685
1686 /** Maximum number of supported match sets for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001687 int max_match_sets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001688
1689 /**
1690 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1691 */
1692 unsigned int max_remain_on_chan;
1693
1694 /**
1695 * max_stations - Maximum number of associated stations the driver
1696 * supports in AP mode
1697 */
1698 unsigned int max_stations;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001699
1700 /**
1701 * probe_resp_offloads - Bitmap of supported protocols by the driver
1702 * for Probe Response offloading.
1703 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001704/** Driver Probe Response offloading support for WPS ver. 1 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001705#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001706/** Driver Probe Response offloading support for WPS ver. 2 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001707#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001708/** Driver Probe Response offloading support for P2P */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001709#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001710/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001711#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1712 unsigned int probe_resp_offloads;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001713
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07001714 unsigned int max_acl_mac_addrs;
1715
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001716 /**
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07001717 * Number of supported concurrent channels
1718 */
1719 unsigned int num_multichan_concurrent;
1720
1721 /**
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001722 * extended_capa - extended capabilities in driver/device
1723 *
1724 * Must be allocated and freed by driver and the pointers must be
1725 * valid for the lifetime of the driver, i.e., freed in deinit()
1726 */
1727 const u8 *extended_capa, *extended_capa_mask;
1728 unsigned int extended_capa_len;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001729
1730 struct wowlan_triggers wowlan_triggers;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001731
1732/** Driver adds the DS Params Set IE in Probe Request frames */
1733#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1734/** Driver adds the WFA TPC IE in Probe Request frames */
1735#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1736/** Driver handles quiet period requests */
1737#define WPA_DRIVER_FLAGS_QUIET 0x00000004
1738/**
1739 * Driver is capable of inserting the current TX power value into the body of
1740 * transmitted frames.
1741 * Background: Some Action frames include a TPC Report IE. This IE contains a
1742 * TX power field, which has to be updated by lower layers. One such Action
1743 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1744 * of spectrum management). Note that this insertion takes place at a fixed
1745 * offset, namely the 6th byte in the Action frame body.
1746 */
1747#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001748/**
1749 * Driver supports RRM. With this support, the driver will accept to use RRM in
1750 * (Re)Association Request frames, without supporting quiet period.
1751 */
1752#define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1753
Dmitry Shmidt29333592017-01-09 12:27:11 -08001754/** Driver supports setting the scan dwell time */
1755#define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
1756/** Driver supports Beacon Report Measurement */
1757#define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
1758
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001759 u32 rrm_flags;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001760
1761 /* Driver concurrency capabilities */
1762 unsigned int conc_capab;
1763 /* Maximum number of concurrent channels on 2.4 GHz */
1764 unsigned int max_conc_chan_2_4;
1765 /* Maximum number of concurrent channels on 5 GHz */
1766 unsigned int max_conc_chan_5_0;
1767
1768 /* Maximum number of supported CSA counters */
1769 u16 max_csa_counters;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001770};
1771
1772
1773struct hostapd_data;
1774
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001775#define STA_DRV_DATA_TX_MCS BIT(0)
1776#define STA_DRV_DATA_RX_MCS BIT(1)
1777#define STA_DRV_DATA_TX_VHT_MCS BIT(2)
1778#define STA_DRV_DATA_RX_VHT_MCS BIT(3)
1779#define STA_DRV_DATA_TX_VHT_NSS BIT(4)
1780#define STA_DRV_DATA_RX_VHT_NSS BIT(5)
1781#define STA_DRV_DATA_TX_SHORT_GI BIT(6)
1782#define STA_DRV_DATA_RX_SHORT_GI BIT(7)
Roshan Pius3a1667e2018-07-03 15:17:14 -07001783#define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001784
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001785struct hostap_sta_driver_data {
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001786 unsigned long rx_packets, tx_packets;
1787 unsigned long long rx_bytes, tx_bytes;
Hai Shalom81f62d82019-07-22 12:10:00 -07001788 unsigned long long rx_airtime, tx_airtime;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001789 int bytes_64bit; /* whether 64-bit byte counters are supported */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001790 unsigned long current_tx_rate;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001791 unsigned long current_rx_rate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001792 unsigned long inactive_msec;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001793 unsigned long flags; /* bitfield of STA_DRV_DATA_* */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001794 unsigned long num_ps_buf_frames;
1795 unsigned long tx_retry_failed;
1796 unsigned long tx_retry_count;
Roshan Pius3a1667e2018-07-03 15:17:14 -07001797 s8 last_ack_rssi;
Hai Shalom81f62d82019-07-22 12:10:00 -07001798 unsigned long backlog_packets;
1799 unsigned long backlog_bytes;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07001800 s8 signal;
1801 u8 rx_vhtmcs;
1802 u8 tx_vhtmcs;
1803 u8 rx_mcs;
1804 u8 tx_mcs;
1805 u8 rx_vht_nss;
1806 u8 tx_vht_nss;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001807};
1808
1809struct hostapd_sta_add_params {
1810 const u8 *addr;
1811 u16 aid;
1812 u16 capability;
1813 const u8 *supp_rates;
1814 size_t supp_rates_len;
1815 u16 listen_interval;
1816 const struct ieee80211_ht_capabilities *ht_capabilities;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001817 const struct ieee80211_vht_capabilities *vht_capabilities;
Dmitry Shmidtbd14a572014-02-18 10:33:49 -08001818 int vht_opmode_enabled;
1819 u8 vht_opmode;
Hai Shalom81f62d82019-07-22 12:10:00 -07001820 const struct ieee80211_he_capabilities *he_capab;
1821 size_t he_capab_len;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001822 u32 flags; /* bitmask of WPA_STA_* flags */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001823 u32 flags_mask; /* unset bits in flags */
1824#ifdef CONFIG_MESH
1825 enum mesh_plink_state plink_state;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001826 u16 peer_aid;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001827#endif /* CONFIG_MESH */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001828 int set; /* Set STA parameters instead of add */
1829 u8 qosinfo;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08001830 const u8 *ext_capab;
1831 size_t ext_capab_len;
Dmitry Shmidt344abd32014-01-14 13:17:00 -08001832 const u8 *supp_channels;
1833 size_t supp_channels_len;
1834 const u8 *supp_oper_classes;
1835 size_t supp_oper_classes_len;
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001836 int support_p2p_ps;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001837};
1838
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07001839struct mac_address {
1840 u8 addr[ETH_ALEN];
1841};
1842
1843struct hostapd_acl_params {
1844 u8 acl_policy;
1845 unsigned int num_mac_acl;
1846 struct mac_address mac_acl[0];
1847};
1848
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001849enum wpa_driver_if_type {
1850 /**
1851 * WPA_IF_STATION - Station mode interface
1852 */
1853 WPA_IF_STATION,
1854
1855 /**
1856 * WPA_IF_AP_VLAN - AP mode VLAN interface
1857 *
1858 * This interface shares its address and Beacon frame with the main
1859 * BSS.
1860 */
1861 WPA_IF_AP_VLAN,
1862
1863 /**
1864 * WPA_IF_AP_BSS - AP mode BSS interface
1865 *
1866 * This interface has its own address and Beacon frame.
1867 */
1868 WPA_IF_AP_BSS,
1869
1870 /**
1871 * WPA_IF_P2P_GO - P2P Group Owner
1872 */
1873 WPA_IF_P2P_GO,
1874
1875 /**
1876 * WPA_IF_P2P_CLIENT - P2P Client
1877 */
1878 WPA_IF_P2P_CLIENT,
1879
1880 /**
1881 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1882 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1883 */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001884 WPA_IF_P2P_GROUP,
1885
1886 /**
1887 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1888 * abstracted P2P Device function in the driver
1889 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001890 WPA_IF_P2P_DEVICE,
1891
1892 /*
1893 * WPA_IF_MESH - Mesh interface
1894 */
1895 WPA_IF_MESH,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001896
1897 /*
1898 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1899 */
1900 WPA_IF_TDLS,
1901
1902 /*
1903 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1904 */
1905 WPA_IF_IBSS,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001906};
1907
1908struct wpa_init_params {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001909 void *global_priv;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001910 const u8 *bssid;
1911 const char *ifname;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001912 const char *driver_params;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001913 int use_pae_group_addr;
1914 char **bridge;
1915 size_t num_bridge;
1916
1917 u8 *own_addr; /* buffer for writing own MAC address */
1918};
1919
1920
1921struct wpa_bss_params {
1922 /** Interface name (for multi-SSID/VLAN support) */
1923 const char *ifname;
1924 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1925 int enabled;
1926
1927 int wpa;
1928 int ieee802_1x;
1929 int wpa_group;
1930 int wpa_pairwise;
1931 int wpa_key_mgmt;
1932 int rsn_preauth;
1933 enum mfp_options ieee80211w;
1934};
1935
1936#define WPA_STA_AUTHORIZED BIT(0)
1937#define WPA_STA_WMM BIT(1)
1938#define WPA_STA_SHORT_PREAMBLE BIT(2)
1939#define WPA_STA_MFP BIT(3)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001940#define WPA_STA_TDLS_PEER BIT(4)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001941#define WPA_STA_AUTHENTICATED BIT(5)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001942#define WPA_STA_ASSOCIATED BIT(6)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001943
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001944enum tdls_oper {
1945 TDLS_DISCOVERY_REQ,
1946 TDLS_SETUP,
1947 TDLS_TEARDOWN,
1948 TDLS_ENABLE_LINK,
1949 TDLS_DISABLE_LINK,
1950 TDLS_ENABLE,
1951 TDLS_DISABLE
1952};
1953
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001954enum wnm_oper {
1955 WNM_SLEEP_ENTER_CONFIRM,
1956 WNM_SLEEP_ENTER_FAIL,
1957 WNM_SLEEP_EXIT_CONFIRM,
1958 WNM_SLEEP_EXIT_FAIL,
1959 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1960 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1961 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1962 * a STA */
1963 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1964 * for a STA */
1965 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1966 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1967 * for a STA */
1968 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1969};
1970
Roshan Pius3a1667e2018-07-03 15:17:14 -07001971/* enum smps_mode - SMPS mode definitions */
1972enum smps_mode {
1973 SMPS_AUTOMATIC,
1974 SMPS_OFF,
1975 SMPS_DYNAMIC,
1976 SMPS_STATIC,
1977
1978 /* Keep last */
1979 SMPS_INVALID,
1980};
1981
Hai Shalom74f70d42019-02-11 14:42:39 -08001982#define WPA_INVALID_NOISE 9999
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001983
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001984/**
1985 * struct wpa_signal_info - Information about channel signal quality
Hai Shalom74f70d42019-02-11 14:42:39 -08001986 * @frequency: control frequency
1987 * @above_threshold: true if the above threshold was crossed
1988 * (relevant for a CQM event)
1989 * @current_signal: in dBm
1990 * @avg_signal: in dBm
1991 * @avg_beacon_signal: in dBm
1992 * @current_noise: %WPA_INVALID_NOISE if not supported
1993 * @current_txrate: current TX rate
1994 * @chanwidth: channel width
1995 * @center_frq1: center frequency for the first segment
1996 * @center_frq2: center frequency for the second segment (if relevant)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001997 */
1998struct wpa_signal_info {
1999 u32 frequency;
2000 int above_threshold;
2001 int current_signal;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002002 int avg_signal;
Dmitry Shmidtf73259c2015-03-17 11:00:54 -07002003 int avg_beacon_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002004 int current_noise;
2005 int current_txrate;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07002006 enum chan_width chanwidth;
2007 int center_frq1;
2008 int center_frq2;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002009};
2010
2011/**
Hai Shalom74f70d42019-02-11 14:42:39 -08002012 * struct wpa_channel_info - Information about the current channel
2013 * @frequency: Center frequency of the primary 20 MHz channel
2014 * @chanwidth: Width of the current operating channel
2015 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
2016 * This field is only filled in when using a 40 MHz channel.
2017 * @center_frq1: Center frequency of frequency segment 0
2018 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
2019 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
2020 * derived from center_frq2 for convenience.
2021 */
2022struct wpa_channel_info {
2023 u32 frequency;
2024 enum chan_width chanwidth;
2025 int sec_channel;
2026 int center_frq1;
2027 int center_frq2;
2028 u8 seg1_idx;
2029};
2030
2031/**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002032 * struct beacon_data - Beacon data
2033 * @head: Head portion of Beacon frame (before TIM IE)
2034 * @tail: Tail portion of Beacon frame (after TIM IE)
2035 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2036 * @proberesp_ies: Extra information element(s) to add into Probe Response
2037 * frames or %NULL
2038 * @assocresp_ies: Extra information element(s) to add into (Re)Association
2039 * Response frames or %NULL
2040 * @probe_resp: Probe Response frame template
2041 * @head_len: Length of @head
2042 * @tail_len: Length of @tail
2043 * @beacon_ies_len: Length of beacon_ies in octets
2044 * @proberesp_ies_len: Length of proberesp_ies in octets
2045 * @proberesp_ies_len: Length of proberesp_ies in octets
2046 * @probe_resp_len: Length of probe response template (@probe_resp)
2047 */
2048struct beacon_data {
2049 u8 *head, *tail;
2050 u8 *beacon_ies;
2051 u8 *proberesp_ies;
2052 u8 *assocresp_ies;
2053 u8 *probe_resp;
2054
2055 size_t head_len, tail_len;
2056 size_t beacon_ies_len;
2057 size_t proberesp_ies_len;
2058 size_t assocresp_ies_len;
2059 size_t probe_resp_len;
2060};
2061
2062/**
2063 * struct csa_settings - Settings for channel switch command
2064 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2065 * @block_tx: 1 - block transmission for CSA period
2066 * @freq_params: Next channel frequency parameter
2067 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2068 * @beacon_after: Next beacon/probe resp/asooc resp info
2069 * @counter_offset_beacon: Offset to the count field in beacon's tail
2070 * @counter_offset_presp: Offset to the count field in probe resp.
2071 */
2072struct csa_settings {
2073 u8 cs_count;
2074 u8 block_tx;
2075
2076 struct hostapd_freq_params freq_params;
2077 struct beacon_data beacon_csa;
2078 struct beacon_data beacon_after;
2079
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002080 u16 counter_offset_beacon[2];
2081 u16 counter_offset_presp[2];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002082};
2083
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002084/* TDLS peer capabilities for send_tdls_mgmt() */
2085enum tdls_peer_capability {
2086 TDLS_PEER_HT = BIT(0),
2087 TDLS_PEER_VHT = BIT(1),
2088 TDLS_PEER_WMM = BIT(2),
2089};
2090
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002091/* valid info in the wmm_params struct */
2092enum wmm_params_valid_info {
2093 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
2094};
2095
2096/**
2097 * struct wmm_params - WMM parameterss configured for this association
2098 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2099 * of the struct contain valid information.
2100 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2101 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2102 */
2103struct wmm_params {
2104 u8 info_bitmap;
2105 u8 uapsd_queues;
2106};
2107
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002108#ifdef CONFIG_MACSEC
2109struct macsec_init_params {
2110 Boolean always_include_sci;
2111 Boolean use_es;
2112 Boolean use_scb;
2113};
2114#endif /* CONFIG_MACSEC */
2115
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002116enum drv_br_port_attr {
2117 DRV_BR_PORT_ATTR_PROXYARP,
2118 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
2119};
2120
2121enum drv_br_net_param {
2122 DRV_BR_NET_PARAM_GARP_ACCEPT,
Dmitry Shmidt83474442015-04-15 13:47:09 -07002123 DRV_BR_MULTICAST_SNOOPING,
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002124};
2125
2126struct drv_acs_params {
2127 /* Selected mode (HOSTAPD_MODE_*) */
2128 enum hostapd_hw_mode hw_mode;
2129
2130 /* Indicates whether HT is enabled */
2131 int ht_enabled;
2132
2133 /* Indicates whether HT40 is enabled */
2134 int ht40_enabled;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07002135
2136 /* Indicates whether VHT is enabled */
2137 int vht_enabled;
2138
2139 /* Configured ACS channel width */
2140 u16 ch_width;
2141
2142 /* ACS channel list info */
2143 unsigned int ch_list_len;
2144 const u8 *ch_list;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002145 const int *freq_list;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002146};
2147
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002148struct wpa_bss_trans_info {
2149 u8 mbo_transition_reason;
2150 u8 n_candidates;
2151 u8 *bssid;
2152};
2153
2154struct wpa_bss_candidate_info {
2155 u8 num;
2156 struct candidate_list {
2157 u8 bssid[ETH_ALEN];
2158 u8 is_accept;
2159 u32 reject_reason;
2160 } *candidates;
2161};
2162
2163struct wpa_pmkid_params {
2164 const u8 *bssid;
2165 const u8 *ssid;
2166 size_t ssid_len;
2167 const u8 *fils_cache_id;
2168 const u8 *pmkid;
2169 const u8 *pmk;
2170 size_t pmk_len;
2171};
2172
2173/* Mask used to specify which connection parameters have to be updated */
2174enum wpa_drv_update_connect_params_mask {
2175 WPA_DRV_UPDATE_ASSOC_IES = BIT(0),
2176 WPA_DRV_UPDATE_FILS_ERP_INFO = BIT(1),
2177 WPA_DRV_UPDATE_AUTH_TYPE = BIT(2),
2178};
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07002179
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002180/**
Roshan Pius3a1667e2018-07-03 15:17:14 -07002181 * struct external_auth - External authentication trigger parameters
2182 *
2183 * These are used across the external authentication request and event
2184 * interfaces.
2185 * @action: Action type / trigger for external authentication. Only significant
2186 * for the event interface.
2187 * @bssid: BSSID of the peer with which the authentication has to happen. Used
2188 * by both the request and event interface.
2189 * @ssid: SSID of the AP. Used by both the request and event interface.
2190 * @ssid_len: SSID length in octets.
2191 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2192 * the request interface.
2193 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2194 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2195 * the real status code for failures. Used only for the request interface
2196 * from user space to the driver.
Hai Shalom5f92bc92019-04-18 11:54:11 -07002197 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
Roshan Pius3a1667e2018-07-03 15:17:14 -07002198 */
2199struct external_auth {
2200 enum {
2201 EXT_AUTH_START,
2202 EXT_AUTH_ABORT,
2203 } action;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002204 const u8 *bssid;
2205 const u8 *ssid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002206 size_t ssid_len;
2207 unsigned int key_mgmt_suite;
2208 u16 status;
Hai Shalom5f92bc92019-04-18 11:54:11 -07002209 const u8 *pmkid;
Roshan Pius3a1667e2018-07-03 15:17:14 -07002210};
2211
2212/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002213 * struct wpa_driver_ops - Driver interface API definition
2214 *
2215 * This structure defines the API that each driver interface needs to implement
2216 * for core wpa_supplicant code. All driver specific functionality is captured
2217 * in this wrapper.
2218 */
2219struct wpa_driver_ops {
2220 /** Name of the driver interface */
2221 const char *name;
2222 /** One line description of the driver interface */
2223 const char *desc;
2224
2225 /**
2226 * get_bssid - Get the current BSSID
2227 * @priv: private driver interface data
2228 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2229 *
2230 * Returns: 0 on success, -1 on failure
2231 *
2232 * Query kernel driver for the current BSSID and copy it to bssid.
2233 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2234 * associated.
2235 */
2236 int (*get_bssid)(void *priv, u8 *bssid);
2237
2238 /**
2239 * get_ssid - Get the current SSID
2240 * @priv: private driver interface data
2241 * @ssid: buffer for SSID (at least 32 bytes)
2242 *
2243 * Returns: Length of the SSID on success, -1 on failure
2244 *
2245 * Query kernel driver for the current SSID and copy it to ssid.
2246 * Returning zero is recommended if the STA is not associated.
2247 *
2248 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2249 * can, at least in theory, contain control characters (including nul)
2250 * and as such, should be processed as binary data, not a printable
2251 * string.
2252 */
2253 int (*get_ssid)(void *priv, u8 *ssid);
2254
2255 /**
2256 * set_key - Configure encryption key
2257 * @ifname: Interface name (for multi-SSID/VLAN support)
2258 * @priv: private driver interface data
2259 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002260 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08002261 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
2262 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
2263 * %WPA_ALG_BIP_CMAC_256);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002264 * %WPA_ALG_NONE clears the key.
2265 * @addr: Address of the peer STA (BSSID of the current AP when setting
2266 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
2267 * broadcast keys, %NULL for default keys that are used both for
2268 * broadcast and unicast; when clearing keys, %NULL is used to
2269 * indicate that both the broadcast-only and default key of the
2270 * specified key index is to be cleared
2271 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
2272 * IGTK
2273 * @set_tx: configure this key as the default Tx key (only used when
2274 * driver does not support separate unicast/individual key
2275 * @seq: sequence number/packet number, seq_len octets, the next
2276 * packet number to be used for in replay protection; configured
2277 * for Rx keys (in most cases, this is only used with broadcast
2278 * keys and set to zero for unicast keys); %NULL if not set
2279 * @seq_len: length of the seq, depends on the algorithm:
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002280 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002281 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
2282 * 8-byte Rx Mic Key
2283 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002284 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002285 *
2286 * Returns: 0 on success, -1 on failure
2287 *
2288 * Configure the given key for the kernel driver. If the driver
2289 * supports separate individual keys (4 default keys + 1 individual),
2290 * addr can be used to determine whether the key is default or
2291 * individual. If only 4 keys are supported, the default key with key
2292 * index 0 is used as the individual key. STA must be configured to use
2293 * it as the default Tx key (set_tx is set) and accept Rx for all the
2294 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2295 * broadcast keys, so key index 0 is available for this kind of
2296 * configuration.
2297 *
2298 * Please note that TKIP keys include separate TX and RX MIC keys and
2299 * some drivers may expect them in different order than wpa_supplicant
2300 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
2301 * will trigger Michael MIC errors. This can be fixed by changing the
2302 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
2303 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2304 * example on how this can be done.
2305 */
2306 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
2307 const u8 *addr, int key_idx, int set_tx,
2308 const u8 *seq, size_t seq_len,
2309 const u8 *key, size_t key_len);
2310
2311 /**
2312 * init - Initialize driver interface
2313 * @ctx: context to be used when calling wpa_supplicant functions,
2314 * e.g., wpa_supplicant_event()
2315 * @ifname: interface name, e.g., wlan0
2316 *
2317 * Returns: Pointer to private data, %NULL on failure
2318 *
2319 * Initialize driver interface, including event processing for kernel
2320 * driver events (e.g., associated, scan results, Michael MIC failure).
2321 * This function can allocate a private configuration data area for
2322 * @ctx, file descriptor, interface name, etc. information that may be
2323 * needed in future driver operations. If this is not used, non-NULL
2324 * value will need to be returned because %NULL is used to indicate
2325 * failure. The returned value will be used as 'void *priv' data for
2326 * all other driver_ops functions.
2327 *
2328 * The main event loop (eloop.c) of wpa_supplicant can be used to
2329 * register callback for read sockets (eloop_register_read_sock()).
2330 *
2331 * See below for more information about events and
2332 * wpa_supplicant_event() function.
2333 */
2334 void * (*init)(void *ctx, const char *ifname);
2335
2336 /**
2337 * deinit - Deinitialize driver interface
2338 * @priv: private driver interface data from init()
2339 *
2340 * Shut down driver interface and processing of driver events. Free
2341 * private data buffer if one was allocated in init() handler.
2342 */
2343 void (*deinit)(void *priv);
2344
2345 /**
2346 * set_param - Set driver configuration parameters
2347 * @priv: private driver interface data from init()
2348 * @param: driver specific configuration parameters
2349 *
2350 * Returns: 0 on success, -1 on failure
2351 *
2352 * Optional handler for notifying driver interface about configuration
2353 * parameters (driver_param).
2354 */
2355 int (*set_param)(void *priv, const char *param);
2356
2357 /**
2358 * set_countermeasures - Enable/disable TKIP countermeasures
2359 * @priv: private driver interface data
2360 * @enabled: 1 = countermeasures enabled, 0 = disabled
2361 *
2362 * Returns: 0 on success, -1 on failure
2363 *
2364 * Configure TKIP countermeasures. When these are enabled, the driver
2365 * should drop all received and queued frames that are using TKIP.
2366 */
2367 int (*set_countermeasures)(void *priv, int enabled);
2368
2369 /**
2370 * deauthenticate - Request driver to deauthenticate
2371 * @priv: private driver interface data
2372 * @addr: peer address (BSSID of the AP)
2373 * @reason_code: 16-bit reason code to be sent in the deauthentication
2374 * frame
2375 *
2376 * Returns: 0 on success, -1 on failure
2377 */
Hai Shalom81f62d82019-07-22 12:10:00 -07002378 int (*deauthenticate)(void *priv, const u8 *addr, u16 reason_code);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002379
2380 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002381 * associate - Request driver to associate
2382 * @priv: private driver interface data
2383 * @params: association parameters
2384 *
2385 * Returns: 0 on success, -1 on failure
2386 */
2387 int (*associate)(void *priv,
2388 struct wpa_driver_associate_params *params);
2389
2390 /**
2391 * add_pmkid - Add PMKSA cache entry to the driver
2392 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002393 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002394 *
2395 * Returns: 0 on success, -1 on failure
2396 *
2397 * This function is called when a new PMK is received, as a result of
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002398 * either normal authentication or RSN pre-authentication. The PMKSA
2399 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2400 * ssid, fils_cache_id, pmkid, and pmk.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002401 *
2402 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2403 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2404 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2405 * driver_ops function does not need to be implemented. Likewise, if
2406 * the driver does not support WPA, this function is not needed.
2407 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002408 int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002409
2410 /**
2411 * remove_pmkid - Remove PMKSA cache entry to the driver
2412 * @priv: private driver interface data
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002413 * @params: PMKSA parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002414 *
2415 * Returns: 0 on success, -1 on failure
2416 *
2417 * This function is called when the supplicant drops a PMKSA cache
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002418 * entry for any reason. The PMKSA parameters are either a set of
2419 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002420 *
2421 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2422 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2423 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2424 * from wpa_supplicant, this driver_ops function does not need to be
2425 * implemented. Likewise, if the driver does not support WPA, this
2426 * function is not needed.
2427 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002428 int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002429
2430 /**
2431 * flush_pmkid - Flush PMKSA cache
2432 * @priv: private driver interface data
2433 *
2434 * Returns: 0 on success, -1 on failure
2435 *
2436 * This function is called when the supplicant drops all PMKSA cache
2437 * entries for any reason.
2438 *
2439 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2440 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2441 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2442 * from wpa_supplicant, this driver_ops function does not need to be
2443 * implemented. Likewise, if the driver does not support WPA, this
2444 * function is not needed.
2445 */
2446 int (*flush_pmkid)(void *priv);
2447
2448 /**
2449 * get_capa - Get driver capabilities
2450 * @priv: private driver interface data
2451 *
2452 * Returns: 0 on success, -1 on failure
2453 *
2454 * Get driver/firmware/hardware capabilities.
2455 */
2456 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
2457
2458 /**
2459 * poll - Poll driver for association information
2460 * @priv: private driver interface data
2461 *
2462 * This is an option callback that can be used when the driver does not
2463 * provide event mechanism for association events. This is called when
2464 * receiving WPA EAPOL-Key messages that require association
2465 * information. The driver interface is supposed to generate associnfo
2466 * event before returning from this callback function. In addition, the
2467 * driver interface should generate an association event after having
2468 * sent out associnfo.
2469 */
2470 void (*poll)(void *priv);
2471
2472 /**
Dmitry Shmidte4663042016-04-04 10:07:49 -07002473 * get_ifindex - Get interface index
2474 * @priv: private driver interface data
2475 *
2476 * Returns: Interface index
2477 */
2478 unsigned int (*get_ifindex)(void *priv);
2479
2480 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002481 * get_ifname - Get interface name
2482 * @priv: private driver interface data
2483 *
2484 * Returns: Pointer to the interface name. This can differ from the
2485 * interface name used in init() call. Init() is called first.
2486 *
2487 * This optional function can be used to allow the driver interface to
2488 * replace the interface name with something else, e.g., based on an
2489 * interface mapping from a more descriptive name.
2490 */
2491 const char * (*get_ifname)(void *priv);
2492
2493 /**
2494 * get_mac_addr - Get own MAC address
2495 * @priv: private driver interface data
2496 *
2497 * Returns: Pointer to own MAC address or %NULL on failure
2498 *
2499 * This optional function can be used to get the own MAC address of the
2500 * device from the driver interface code. This is only needed if the
2501 * l2_packet implementation for the OS does not provide easy access to
2502 * a MAC address. */
2503 const u8 * (*get_mac_addr)(void *priv);
2504
2505 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002506 * set_operstate - Sets device operating state to DORMANT or UP
2507 * @priv: private driver interface data
2508 * @state: 0 = dormant, 1 = up
2509 * Returns: 0 on success, -1 on failure
2510 *
2511 * This is an optional function that can be used on operating systems
2512 * that support a concept of controlling network device state from user
2513 * space applications. This function, if set, gets called with
2514 * state = 1 when authentication has been completed and with state = 0
2515 * when connection is lost.
2516 */
2517 int (*set_operstate)(void *priv, int state);
2518
2519 /**
2520 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2521 * @priv: Private driver interface data
2522 * @addr: Address of the station for which to set protection (may be
2523 * %NULL for group keys)
2524 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2525 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2526 * Returns: 0 on success, -1 on failure
2527 *
2528 * This is an optional function that can be used to set the driver to
2529 * require protection for Tx and/or Rx frames. This uses the layer
2530 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2531 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2532 * set protection operation; instead, they set protection implicitly
2533 * based on configured keys.
2534 */
2535 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2536 int key_type);
2537
2538 /**
2539 * get_hw_feature_data - Get hardware support data (channels and rates)
2540 * @priv: Private driver interface data
2541 * @num_modes: Variable for returning the number of returned modes
2542 * flags: Variable for returning hardware feature flags
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002543 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002544 * Returns: Pointer to allocated hardware data on success or %NULL on
2545 * failure. Caller is responsible for freeing this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002546 */
2547 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2548 u16 *num_modes,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07002549 u16 *flags, u8 *dfs);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002550
2551 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002552 * send_mlme - Send management frame from MLME
2553 * @priv: Private driver interface data
2554 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2555 * @data_len: Size of the management frame
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002556 * @noack: Do not wait for this frame to be acked (disable retries)
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07002557 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2558 * driver decide
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002559 * @csa_offs: Array of CSA offsets or %NULL
2560 * @csa_offs_len: Number of elements in csa_offs
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002561 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002562 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002563 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002564 int noack, unsigned int freq, const u16 *csa_offs,
2565 size_t csa_offs_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002566
2567 /**
2568 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2569 * @priv: Private driver interface data
2570 * @md: Mobility domain (2 octets) (also included inside ies)
2571 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2572 * @ies_len: Length of FT IEs in bytes
2573 * Returns: 0 on success, -1 on failure
2574 *
2575 * The supplicant uses this callback to let the driver know that keying
2576 * material for FT is available and that the driver can use the
2577 * provided IEs in the next message in FT authentication sequence.
2578 *
2579 * This function is only needed for driver that support IEEE 802.11r
2580 * (Fast BSS Transition).
2581 */
2582 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2583 size_t ies_len);
2584
2585 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002586 * get_scan_results2 - Fetch the latest scan results
2587 * @priv: private driver interface data
2588 *
2589 * Returns: Allocated buffer of scan results (caller is responsible for
2590 * freeing the data structure) on success, NULL on failure
2591 */
2592 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2593
2594 /**
2595 * set_country - Set country
2596 * @priv: Private driver interface data
2597 * @alpha2: country to which to switch to
2598 * Returns: 0 on success, -1 on failure
2599 *
2600 * This function is for drivers which support some form
2601 * of setting a regulatory domain.
2602 */
2603 int (*set_country)(void *priv, const char *alpha2);
2604
2605 /**
Dmitry Shmidtcce06662013-11-04 18:44:24 -08002606 * get_country - Get country
2607 * @priv: Private driver interface data
2608 * @alpha2: Buffer for returning country code (at least 3 octets)
2609 * Returns: 0 on success, -1 on failure
2610 */
2611 int (*get_country)(void *priv, char *alpha2);
2612
2613 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002614 * global_init - Global driver initialization
Dmitry Shmidte4663042016-04-04 10:07:49 -07002615 * @ctx: wpa_global pointer
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002616 * Returns: Pointer to private data (global), %NULL on failure
2617 *
2618 * This optional function is called to initialize the driver wrapper
2619 * for global data, i.e., data that applies to all interfaces. If this
2620 * function is implemented, global_deinit() will also need to be
2621 * implemented to free the private data. The driver will also likely
2622 * use init2() function instead of init() to get the pointer to global
2623 * data available to per-interface initializer.
2624 */
Dmitry Shmidte4663042016-04-04 10:07:49 -07002625 void * (*global_init)(void *ctx);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002626
2627 /**
2628 * global_deinit - Global driver deinitialization
2629 * @priv: private driver global data from global_init()
2630 *
2631 * Terminate any global driver related functionality and free the
2632 * global data structure.
2633 */
2634 void (*global_deinit)(void *priv);
2635
2636 /**
2637 * init2 - Initialize driver interface (with global data)
2638 * @ctx: context to be used when calling wpa_supplicant functions,
2639 * e.g., wpa_supplicant_event()
2640 * @ifname: interface name, e.g., wlan0
2641 * @global_priv: private driver global data from global_init()
2642 * Returns: Pointer to private data, %NULL on failure
2643 *
2644 * This function can be used instead of init() if the driver wrapper
2645 * uses global data.
2646 */
2647 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2648
2649 /**
2650 * get_interfaces - Get information about available interfaces
2651 * @global_priv: private driver global data from global_init()
2652 * Returns: Allocated buffer of interface information (caller is
2653 * responsible for freeing the data structure) on success, NULL on
2654 * failure
2655 */
2656 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2657
2658 /**
2659 * scan2 - Request the driver to initiate scan
2660 * @priv: private driver interface data
2661 * @params: Scan parameters
2662 *
2663 * Returns: 0 on success, -1 on failure
2664 *
2665 * Once the scan results are ready, the driver should report scan
2666 * results event for wpa_supplicant which will eventually request the
2667 * results with wpa_driver_get_scan_results2().
2668 */
2669 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2670
2671 /**
2672 * authenticate - Request driver to authenticate
2673 * @priv: private driver interface data
2674 * @params: authentication parameters
2675 * Returns: 0 on success, -1 on failure
2676 *
2677 * This is an optional function that can be used with drivers that
2678 * support separate authentication and association steps, i.e., when
2679 * wpa_supplicant can act as the SME. If not implemented, associate()
2680 * function is expected to take care of IEEE 802.11 authentication,
2681 * too.
2682 */
2683 int (*authenticate)(void *priv,
2684 struct wpa_driver_auth_params *params);
2685
2686 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002687 * set_ap - Set Beacon and Probe Response information for AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002688 * @priv: Private driver interface data
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002689 * @params: Parameters to use in AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002690 *
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002691 * This function is used to configure Beacon template and/or extra IEs
2692 * to add for Beacon and Probe Response frames for the driver in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002693 * AP mode. The driver is responsible for building the full Beacon
2694 * frame by concatenating the head part with TIM IE generated by the
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002695 * driver/firmware and finishing with the tail part. Depending on the
2696 * driver architectue, this can be done either by using the full
2697 * template or the set of additional IEs (e.g., WPS and P2P IE).
2698 * Similarly, Probe Response processing depends on the driver design.
2699 * If the driver (or firmware) takes care of replying to Probe Request
2700 * frames, the extra IEs provided here needs to be added to the Probe
2701 * Response frames.
2702 *
2703 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002704 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002705 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002706
2707 /**
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002708 * set_acl - Set ACL in AP mode
2709 * @priv: Private driver interface data
2710 * @params: Parameters to configure ACL
2711 * Returns: 0 on success, -1 on failure
2712 *
2713 * This is used only for the drivers which support MAC address ACL.
2714 */
2715 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2716
2717 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002718 * hapd_init - Initialize driver interface (hostapd only)
2719 * @hapd: Pointer to hostapd context
2720 * @params: Configuration for the driver wrapper
2721 * Returns: Pointer to private data, %NULL on failure
2722 *
2723 * This function is used instead of init() or init2() when the driver
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002724 * wrapper is used with hostapd.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002725 */
2726 void * (*hapd_init)(struct hostapd_data *hapd,
2727 struct wpa_init_params *params);
2728
2729 /**
2730 * hapd_deinit - Deinitialize driver interface (hostapd only)
2731 * @priv: Private driver interface data from hapd_init()
2732 */
2733 void (*hapd_deinit)(void *priv);
2734
2735 /**
2736 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2737 * @priv: Private driver interface data
2738 * @params: BSS parameters
2739 * Returns: 0 on success, -1 on failure
2740 *
2741 * This is an optional function to configure the kernel driver to
2742 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2743 * can be left undefined (set to %NULL) if IEEE 802.1X support is
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002744 * always enabled and the driver uses set_ap() to set WPA/RSN IE
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002745 * for Beacon frames.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002746 *
2747 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002748 */
2749 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2750
2751 /**
2752 * set_privacy - Enable/disable privacy (AP only)
2753 * @priv: Private driver interface data
2754 * @enabled: 1 = privacy enabled, 0 = disabled
2755 * Returns: 0 on success, -1 on failure
2756 *
2757 * This is an optional function to configure privacy field in the
2758 * kernel driver for Beacon frames. This can be left undefined (set to
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002759 * %NULL) if the driver uses the Beacon template from set_ap().
2760 *
2761 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002762 */
2763 int (*set_privacy)(void *priv, int enabled);
2764
2765 /**
2766 * get_seqnum - Fetch the current TSC/packet number (AP only)
2767 * @ifname: The interface name (main or virtual)
2768 * @priv: Private driver interface data
2769 * @addr: MAC address of the station or %NULL for group keys
2770 * @idx: Key index
2771 * @seq: Buffer for returning the latest used TSC/packet number
2772 * Returns: 0 on success, -1 on failure
2773 *
2774 * This function is used to fetch the last used TSC/packet number for
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002775 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2776 * keys, so there is no strict requirement on implementing support for
2777 * unicast keys (i.e., addr != %NULL).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002778 */
2779 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2780 int idx, u8 *seq);
2781
2782 /**
2783 * flush - Flush all association stations (AP only)
2784 * @priv: Private driver interface data
2785 * Returns: 0 on success, -1 on failure
2786 *
2787 * This function requests the driver to disassociate all associated
2788 * stations. This function does not need to be implemented if the
2789 * driver does not process association frames internally.
2790 */
2791 int (*flush)(void *priv);
2792
2793 /**
2794 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2795 * @priv: Private driver interface data
2796 * @elem: Information elements
2797 * @elem_len: Length of the elem buffer in octets
2798 * Returns: 0 on success, -1 on failure
2799 *
2800 * This is an optional function to add information elements in the
2801 * kernel driver for Beacon and Probe Response frames. This can be left
2802 * undefined (set to %NULL) if the driver uses the Beacon template from
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002803 * set_ap().
2804 *
2805 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002806 */
2807 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2808
2809 /**
Jouni Malinen1e6c57f2012-09-05 17:07:03 +03002810 * read_sta_data - Fetch station data
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002811 * @priv: Private driver interface data
2812 * @data: Buffer for returning station information
2813 * @addr: MAC address of the station
2814 * Returns: 0 on success, -1 on failure
2815 */
2816 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2817 const u8 *addr);
2818
2819 /**
2820 * hapd_send_eapol - Send an EAPOL packet (AP only)
2821 * @priv: private driver interface data
2822 * @addr: Destination MAC address
2823 * @data: EAPOL packet starting with IEEE 802.1X header
2824 * @data_len: Length of the EAPOL packet in octets
2825 * @encrypt: Whether the frame should be encrypted
2826 * @own_addr: Source MAC address
2827 * @flags: WPA_STA_* flags for the destination station
2828 *
2829 * Returns: 0 on success, -1 on failure
2830 */
2831 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2832 size_t data_len, int encrypt,
2833 const u8 *own_addr, u32 flags);
2834
2835 /**
2836 * sta_deauth - Deauthenticate a station (AP only)
2837 * @priv: Private driver interface data
2838 * @own_addr: Source address and BSSID for the Deauthentication frame
2839 * @addr: MAC address of the station to deauthenticate
2840 * @reason: Reason code for the Deauthentiation frame
2841 * Returns: 0 on success, -1 on failure
2842 *
2843 * This function requests a specific station to be deauthenticated and
2844 * a Deauthentication frame to be sent to it.
2845 */
2846 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07002847 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002848
2849 /**
2850 * sta_disassoc - Disassociate a station (AP only)
2851 * @priv: Private driver interface data
2852 * @own_addr: Source address and BSSID for the Disassociation frame
2853 * @addr: MAC address of the station to disassociate
2854 * @reason: Reason code for the Disassociation frame
2855 * Returns: 0 on success, -1 on failure
2856 *
2857 * This function requests a specific station to be disassociated and
2858 * a Disassociation frame to be sent to it.
2859 */
2860 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
Hai Shalom81f62d82019-07-22 12:10:00 -07002861 u16 reason);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002862
2863 /**
2864 * sta_remove - Remove a station entry (AP only)
2865 * @priv: Private driver interface data
2866 * @addr: MAC address of the station to be removed
2867 * Returns: 0 on success, -1 on failure
2868 */
2869 int (*sta_remove)(void *priv, const u8 *addr);
2870
2871 /**
2872 * hapd_get_ssid - Get the current SSID (AP only)
2873 * @priv: Private driver interface data
2874 * @buf: Buffer for returning the SSID
2875 * @len: Maximum length of the buffer
2876 * Returns: Length of the SSID on success, -1 on failure
2877 *
2878 * This function need not be implemented if the driver uses Beacon
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002879 * template from set_ap() and does not reply to Probe Request frames.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002880 */
2881 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2882
2883 /**
2884 * hapd_set_ssid - Set SSID (AP only)
2885 * @priv: Private driver interface data
2886 * @buf: SSID
2887 * @len: Length of the SSID in octets
2888 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002889 *
2890 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002891 */
2892 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2893
2894 /**
2895 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2896 * @priv: Private driver interface data
2897 * @enabled: 1 = countermeasures enabled, 0 = disabled
2898 * Returns: 0 on success, -1 on failure
2899 *
2900 * This need not be implemented if the driver does not take care of
2901 * association processing.
2902 */
2903 int (*hapd_set_countermeasures)(void *priv, int enabled);
2904
2905 /**
2906 * sta_add - Add a station entry
2907 * @priv: Private driver interface data
2908 * @params: Station parameters
2909 * Returns: 0 on success, -1 on failure
2910 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002911 * This function is used to add or set (params->set 1) a station
2912 * entry in the driver. Adding STA entries is used only if the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002913 * does not take care of association processing.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002914 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002915 * With drivers that don't support full AP client state, this function
2916 * is used to add a station entry to the driver once the station has
2917 * completed association.
2918 *
2919 * With TDLS, this function is used to add or set (params->set 1)
2920 * TDLS peer entries (even with drivers that do not support full AP
2921 * client state).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002922 */
2923 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2924
2925 /**
2926 * get_inact_sec - Get station inactivity duration (AP only)
2927 * @priv: Private driver interface data
2928 * @addr: Station address
2929 * Returns: Number of seconds station has been inactive, -1 on failure
2930 */
2931 int (*get_inact_sec)(void *priv, const u8 *addr);
2932
2933 /**
2934 * sta_clear_stats - Clear station statistics (AP only)
2935 * @priv: Private driver interface data
2936 * @addr: Station address
2937 * Returns: 0 on success, -1 on failure
2938 */
2939 int (*sta_clear_stats)(void *priv, const u8 *addr);
2940
2941 /**
2942 * set_freq - Set channel/frequency (AP only)
2943 * @priv: Private driver interface data
2944 * @freq: Channel parameters
2945 * Returns: 0 on success, -1 on failure
2946 */
2947 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2948
2949 /**
2950 * set_rts - Set RTS threshold
2951 * @priv: Private driver interface data
2952 * @rts: RTS threshold in octets
2953 * Returns: 0 on success, -1 on failure
2954 */
2955 int (*set_rts)(void *priv, int rts);
2956
2957 /**
2958 * set_frag - Set fragmentation threshold
2959 * @priv: Private driver interface data
2960 * @frag: Fragmentation threshold in octets
2961 * Returns: 0 on success, -1 on failure
2962 */
2963 int (*set_frag)(void *priv, int frag);
2964
2965 /**
2966 * sta_set_flags - Set station flags (AP only)
2967 * @priv: Private driver interface data
2968 * @addr: Station address
2969 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2970 * @flags_or: Bitmap of WPA_STA_* flags to add
2971 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2972 * Returns: 0 on success, -1 on failure
2973 */
2974 int (*sta_set_flags)(void *priv, const u8 *addr,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002975 unsigned int total_flags, unsigned int flags_or,
2976 unsigned int flags_and);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002977
2978 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07002979 * sta_set_airtime_weight - Set station airtime weight (AP only)
2980 * @priv: Private driver interface data
2981 * @addr: Station address
2982 * @weight: New weight for station airtime assignment
2983 * Returns: 0 on success, -1 on failure
2984 */
2985 int (*sta_set_airtime_weight)(void *priv, const u8 *addr,
2986 unsigned int weight);
2987
2988 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002989 * set_tx_queue_params - Set TX queue parameters
2990 * @priv: Private driver interface data
2991 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2992 * @aifs: AIFS
2993 * @cw_min: cwMin
2994 * @cw_max: cwMax
2995 * @burst_time: Maximum length for bursting in 0.1 msec units
2996 */
2997 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2998 int cw_max, int burst_time);
2999
3000 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003001 * if_add - Add a virtual interface
3002 * @priv: Private driver interface data
3003 * @type: Interface type
3004 * @ifname: Interface name for the new virtual interface
3005 * @addr: Local address to use for the interface or %NULL to use the
3006 * parent interface address
3007 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
3008 * @drv_priv: Pointer for overwriting the driver context or %NULL if
3009 * not allowed (applies only to %WPA_IF_AP_BSS type)
3010 * @force_ifname: Buffer for returning an interface name that the
3011 * driver ended up using if it differs from the requested ifname
3012 * @if_addr: Buffer for returning the allocated interface address
3013 * (this may differ from the requested addr if the driver cannot
3014 * change interface address)
3015 * @bridge: Bridge interface to use or %NULL if no bridge configured
Dmitry Shmidtcce06662013-11-04 18:44:24 -08003016 * @use_existing: Whether to allow existing interface to be used
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003017 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003018 * Returns: 0 on success, -1 on failure
3019 */
3020 int (*if_add)(void *priv, enum wpa_driver_if_type type,
3021 const char *ifname, const u8 *addr, void *bss_ctx,
3022 void **drv_priv, char *force_ifname, u8 *if_addr,
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003023 const char *bridge, int use_existing, int setup_ap);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003024
3025 /**
3026 * if_remove - Remove a virtual interface
3027 * @priv: Private driver interface data
3028 * @type: Interface type
3029 * @ifname: Interface name of the virtual interface to be removed
3030 * Returns: 0 on success, -1 on failure
3031 */
3032 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
3033 const char *ifname);
3034
3035 /**
3036 * set_sta_vlan - Bind a station into a specific interface (AP only)
3037 * @priv: Private driver interface data
3038 * @ifname: Interface (main or virtual BSS or VLAN)
3039 * @addr: MAC address of the associated station
3040 * @vlan_id: VLAN ID
3041 * Returns: 0 on success, -1 on failure
3042 *
3043 * This function is used to bind a station to a specific virtual
3044 * interface. It is only used if when virtual interfaces are supported,
3045 * e.g., to assign stations to different VLAN interfaces based on
3046 * information from a RADIUS server. This allows separate broadcast
3047 * domains to be used with a single BSS.
3048 */
3049 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
3050 int vlan_id);
3051
3052 /**
3053 * commit - Optional commit changes handler (AP only)
3054 * @priv: driver private data
3055 * Returns: 0 on success, -1 on failure
3056 *
3057 * This optional handler function can be registered if the driver
3058 * interface implementation needs to commit changes (e.g., by setting
3059 * network interface up) at the end of initial configuration. If set,
3060 * this handler will be called after initial setup has been completed.
3061 */
3062 int (*commit)(void *priv);
3063
3064 /**
3065 * send_ether - Send an ethernet packet (AP only)
3066 * @priv: private driver interface data
3067 * @dst: Destination MAC address
3068 * @src: Source MAC address
3069 * @proto: Ethertype
3070 * @data: EAPOL packet starting with IEEE 802.1X header
3071 * @data_len: Length of the EAPOL packet in octets
3072 * Returns: 0 on success, -1 on failure
3073 */
3074 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
3075 const u8 *data, size_t data_len);
3076
3077 /**
3078 * set_radius_acl_auth - Notification of RADIUS ACL change
3079 * @priv: Private driver interface data
3080 * @mac: MAC address of the station
3081 * @accepted: Whether the station was accepted
3082 * @session_timeout: Session timeout for the station
3083 * Returns: 0 on success, -1 on failure
3084 */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003085 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003086 u32 session_timeout);
3087
3088 /**
3089 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3090 * @priv: Private driver interface data
3091 * @mac: MAC address of the station
3092 * Returns: 0 on success, -1 on failure
3093 */
3094 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
3095
3096 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003097 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
3098 * @priv: Private driver interface data
3099 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3100 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3101 * extra IE(s)
3102 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3103 * to remove extra IE(s)
3104 * Returns: 0 on success, -1 on failure
3105 *
3106 * This is an optional function to add WPS IE in the kernel driver for
3107 * Beacon and Probe Response frames. This can be left undefined (set
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003108 * to %NULL) if the driver uses the Beacon template from set_ap()
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003109 * and does not process Probe Request frames. If the driver takes care
3110 * of (Re)Association frame processing, the assocresp buffer includes
3111 * WPS IE(s) that need to be added to (Re)Association Response frames
3112 * whenever a (Re)Association Request frame indicated use of WPS.
3113 *
3114 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3115 * frames when operating as a GO. The driver is responsible for adding
3116 * timing related attributes (e.g., NoA) in addition to the IEs
3117 * included here by appending them after these buffers. This call is
3118 * also used to provide Probe Response IEs for P2P Listen state
3119 * operations for drivers that generate the Probe Response frames
3120 * internally.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003121 *
3122 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003123 */
3124 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
3125 const struct wpabuf *proberesp,
3126 const struct wpabuf *assocresp);
3127
3128 /**
3129 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3130 * @priv: Private driver interface data
3131 * @authorized: Whether the port is authorized
3132 * Returns: 0 on success, -1 on failure
3133 */
3134 int (*set_supp_port)(void *priv, int authorized);
3135
3136 /**
3137 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3138 * @priv: Private driver interface data
3139 * @addr: MAC address of the associated station
3140 * @aid: Association ID
3141 * @val: 1 = bind to 4-address WDS; 0 = unbind
3142 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3143 * to indicate that bridge is not to be used
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07003144 * @ifname_wds: Buffer to return the interface name for the new WDS
3145 * station or %NULL to indicate name is not returned.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003146 * Returns: 0 on success, -1 on failure
3147 */
3148 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003149 const char *bridge_ifname, char *ifname_wds);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003150
3151 /**
3152 * send_action - Transmit an Action frame
3153 * @priv: Private driver interface data
3154 * @freq: Frequency (in MHz) of the channel
3155 * @wait: Time to wait off-channel for a response (in ms), or zero
3156 * @dst: Destination MAC address (Address 1)
3157 * @src: Source MAC address (Address 2)
3158 * @bssid: BSSID (Address 3)
3159 * @data: Frame body
3160 * @data_len: data length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003161 @ @no_cck: Whether CCK rates must not be used to transmit this frame
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003162 * Returns: 0 on success, -1 on failure
3163 *
3164 * This command can be used to request the driver to transmit an action
3165 * frame to the specified destination.
3166 *
3167 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3168 * be transmitted on the given channel and the device will wait for a
3169 * response on that channel for the given wait time.
3170 *
3171 * If the flag is not set, the wait time will be ignored. In this case,
3172 * if a remain-on-channel duration is in progress, the frame must be
3173 * transmitted on that channel; alternatively the frame may be sent on
3174 * the current operational channel (if in associated state in station
3175 * mode or while operating as an AP.)
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08003176 *
3177 * If @src differs from the device MAC address, use of a random
3178 * transmitter address is requested for this message exchange.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003179 */
3180 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
3181 const u8 *dst, const u8 *src, const u8 *bssid,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003182 const u8 *data, size_t data_len, int no_cck);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003183
3184 /**
3185 * send_action_cancel_wait - Cancel action frame TX wait
3186 * @priv: Private driver interface data
3187 *
3188 * This command cancels the wait time associated with sending an action
3189 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3190 * set in the driver flags.
3191 */
3192 void (*send_action_cancel_wait)(void *priv);
3193
3194 /**
3195 * remain_on_channel - Remain awake on a channel
3196 * @priv: Private driver interface data
3197 * @freq: Frequency (in MHz) of the channel
3198 * @duration: Duration in milliseconds
3199 * Returns: 0 on success, -1 on failure
3200 *
3201 * This command is used to request the driver to remain awake on the
3202 * specified channel for the specified duration and report received
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08003203 * Action frames with EVENT_RX_MGMT events. Optionally, received
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003204 * Probe Request frames may also be requested to be reported by calling
3205 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3206 *
3207 * The driver may not be at the requested channel when this function
3208 * returns, i.e., the return code is only indicating whether the
3209 * request was accepted. The caller will need to wait until the
3210 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3211 * completed the channel change. This may take some time due to other
3212 * need for the radio and the caller should be prepared to timing out
3213 * its wait since there are no guarantees on when this request can be
3214 * executed.
3215 */
3216 int (*remain_on_channel)(void *priv, unsigned int freq,
3217 unsigned int duration);
3218
3219 /**
3220 * cancel_remain_on_channel - Cancel remain-on-channel operation
3221 * @priv: Private driver interface data
3222 *
3223 * This command can be used to cancel a remain-on-channel operation
3224 * before its originally requested duration has passed. This could be
3225 * used, e.g., when remain_on_channel() is used to request extra time
3226 * to receive a response to an Action frame and the response is
3227 * received when there is still unneeded time remaining on the
3228 * remain-on-channel operation.
3229 */
3230 int (*cancel_remain_on_channel)(void *priv);
3231
3232 /**
3233 * probe_req_report - Request Probe Request frames to be indicated
3234 * @priv: Private driver interface data
3235 * @report: Whether to report received Probe Request frames
3236 * Returns: 0 on success, -1 on failure (or if not supported)
3237 *
3238 * This command can be used to request the driver to indicate when
3239 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3240 * Since this operation may require extra resources, e.g., due to less
3241 * optimal hardware/firmware RX filtering, many drivers may disable
3242 * Probe Request reporting at least in station mode. This command is
3243 * used to notify the driver when the Probe Request frames need to be
3244 * reported, e.g., during remain-on-channel operations.
3245 */
3246 int (*probe_req_report)(void *priv, int report);
3247
3248 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003249 * deinit_ap - Deinitialize AP mode
3250 * @priv: Private driver interface data
3251 * Returns: 0 on success, -1 on failure (or if not supported)
3252 *
3253 * This optional function can be used to disable AP mode related
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003254 * configuration. If the interface was not dynamically added,
3255 * change the driver mode to station mode to allow normal station
3256 * operations like scanning to be completed.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003257 */
3258 int (*deinit_ap)(void *priv);
3259
3260 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003261 * deinit_p2p_cli - Deinitialize P2P client mode
3262 * @priv: Private driver interface data
3263 * Returns: 0 on success, -1 on failure (or if not supported)
3264 *
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003265 * This optional function can be used to disable P2P client mode. If the
3266 * interface was not dynamically added, change the interface type back
3267 * to station mode.
Dmitry Shmidt04949592012-07-19 12:16:46 -07003268 */
3269 int (*deinit_p2p_cli)(void *priv);
3270
3271 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003272 * suspend - Notification on system suspend/hibernate event
3273 * @priv: Private driver interface data
3274 */
3275 void (*suspend)(void *priv);
3276
3277 /**
3278 * resume - Notification on system resume/thaw event
3279 * @priv: Private driver interface data
3280 */
3281 void (*resume)(void *priv);
3282
3283 /**
3284 * signal_monitor - Set signal monitoring parameters
3285 * @priv: Private driver interface data
3286 * @threshold: Threshold value for signal change events; 0 = disabled
3287 * @hysteresis: Minimum change in signal strength before indicating a
3288 * new event
3289 * Returns: 0 on success, -1 on failure (or if not supported)
3290 *
3291 * This function can be used to configure monitoring of signal strength
3292 * with the current AP. Whenever signal strength drops below the
3293 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3294 * should be generated assuming the signal strength has changed at
3295 * least %hysteresis from the previously indicated signal change event.
3296 */
3297 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
3298
3299 /**
3300 * send_frame - Send IEEE 802.11 frame (testing use only)
3301 * @priv: Private driver interface data
3302 * @data: IEEE 802.11 frame with IEEE 802.11 header
3303 * @data_len: Size of the frame
3304 * @encrypt: Whether to encrypt the frame (if keys are set)
3305 * Returns: 0 on success, -1 on failure
3306 *
3307 * This function is only used for debugging purposes and is not
3308 * required to be implemented for normal operations.
3309 */
3310 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
3311 int encrypt);
3312
3313 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003314 * get_noa - Get current Notice of Absence attribute payload
3315 * @priv: Private driver interface data
3316 * @buf: Buffer for returning NoA
3317 * @buf_len: Buffer length in octets
3318 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3319 * advertized, or -1 on failure
3320 *
3321 * This function is used to fetch the current Notice of Absence
3322 * attribute value from GO.
3323 */
3324 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
3325
3326 /**
3327 * set_noa - Set Notice of Absence parameters for GO (testing)
3328 * @priv: Private driver interface data
3329 * @count: Count
3330 * @start: Start time in ms from next TBTT
3331 * @duration: Duration in ms
3332 * Returns: 0 on success or -1 on failure
3333 *
3334 * This function is used to set Notice of Absence parameters for GO. It
3335 * is used only for testing. To disable NoA, all parameters are set to
3336 * 0.
3337 */
3338 int (*set_noa)(void *priv, u8 count, int start, int duration);
3339
3340 /**
3341 * set_p2p_powersave - Set P2P power save options
3342 * @priv: Private driver interface data
3343 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3344 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3345 * @ctwindow: 0.. = change (msec), -1 = no change
3346 * Returns: 0 on success or -1 on failure
3347 */
3348 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
3349 int ctwindow);
3350
3351 /**
3352 * ampdu - Enable/disable aggregation
3353 * @priv: Private driver interface data
3354 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3355 * Returns: 0 on success or -1 on failure
3356 */
3357 int (*ampdu)(void *priv, int ampdu);
3358
3359 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003360 * get_radio_name - Get physical radio name for the device
3361 * @priv: Private driver interface data
3362 * Returns: Radio name or %NULL if not known
3363 *
3364 * The returned data must not be modified by the caller. It is assumed
3365 * that any interface that has the same radio name as another is
3366 * sharing the same physical radio. This information can be used to
3367 * share scan results etc. information between the virtual interfaces
3368 * to speed up various operations.
3369 */
3370 const char * (*get_radio_name)(void *priv);
3371
3372 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003373 * send_tdls_mgmt - for sending TDLS management packets
3374 * @priv: private driver interface data
3375 * @dst: Destination (peer) MAC address
3376 * @action_code: TDLS action code for the mssage
3377 * @dialog_token: Dialog Token to use in the message (if needed)
3378 * @status_code: Status Code or Reason Code to use (if needed)
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003379 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003380 * @initiator: Is the current end the TDLS link initiator
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003381 * @buf: TDLS IEs to add to the message
3382 * @len: Length of buf in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003383 * Returns: 0 on success, negative (<0) on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003384 *
3385 * This optional function can be used to send packet to driver which is
3386 * responsible for receiving and sending all TDLS packets.
3387 */
3388 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07003389 u8 dialog_token, u16 status_code, u32 peer_capab,
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07003390 int initiator, const u8 *buf, size_t len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003391
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003392 /**
3393 * tdls_oper - Ask the driver to perform high-level TDLS operations
3394 * @priv: Private driver interface data
3395 * @oper: TDLS high-level operation. See %enum tdls_oper
3396 * @peer: Destination (peer) MAC address
3397 * Returns: 0 on success, negative (<0) on failure
3398 *
3399 * This optional function can be used to send high-level TDLS commands
3400 * to the driver.
3401 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003402 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
3403
3404 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07003405 * wnm_oper - Notify driver of the WNM frame reception
3406 * @priv: Private driver interface data
3407 * @oper: WNM operation. See %enum wnm_oper
3408 * @peer: Destination (peer) MAC address
3409 * @buf: Buffer for the driver to fill in (for getting IE)
3410 * @buf_len: Return the len of buf
3411 * Returns: 0 on success, negative (<0) on failure
3412 */
3413 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
3414 u8 *buf, u16 *buf_len);
3415
3416 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -07003417 * set_qos_map - Set QoS Map
3418 * @priv: Private driver interface data
3419 * @qos_map_set: QoS Map
3420 * @qos_map_set_len: Length of QoS Map
3421 */
3422 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
3423 u8 qos_map_set_len);
3424
3425 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003426 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3427 * @priv: Private driver interface data
3428 * @version: IP version of the IP address, 4 or 6
3429 * @ipaddr: IP address for the neigh entry
3430 * @prefixlen: IP address prefix length
3431 * @addr: Corresponding MAC address
3432 * Returns: 0 on success, negative (<0) on failure
3433 */
3434 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
3435 int prefixlen, const u8 *addr);
3436
3437 /**
3438 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3439 * @priv: Private driver interface data
3440 * @version: IP version of the IP address, 4 or 6
3441 * @ipaddr: IP address for the neigh entry
3442 * Returns: 0 on success, negative (<0) on failure
3443 */
3444 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
3445
3446 /**
3447 * br_port_set_attr - Set a bridge port attribute
3448 * @attr: Bridge port attribute to set
3449 * @val: Value to be set
3450 * Returns: 0 on success, negative (<0) on failure
3451 */
3452 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
3453 unsigned int val);
3454
3455 /**
3456 * br_port_set_attr - Set a bridge network parameter
3457 * @param: Bridge parameter to set
3458 * @val: Value to be set
3459 * Returns: 0 on success, negative (<0) on failure
3460 */
3461 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
3462 unsigned int val);
3463
3464 /**
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07003465 * set_wowlan - Set wake-on-wireless triggers
3466 * @priv: Private driver interface data
3467 * @triggers: wowlan triggers
3468 */
3469 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
3470
3471 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003472 * signal_poll - Get current connection information
3473 * @priv: Private driver interface data
3474 * @signal_info: Connection info structure
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003475 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003476 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003477
3478 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08003479 * channel_info - Get parameters of the current operating channel
3480 * @priv: Private driver interface data
3481 * @channel_info: Channel info structure
3482 * Returns: 0 on success, negative (<0) on failure
3483 */
3484 int (*channel_info)(void *priv, struct wpa_channel_info *channel_info);
3485
3486 /**
Jouni Malinen75ecf522011-06-27 15:19:46 -07003487 * set_authmode - Set authentication algorithm(s) for static WEP
3488 * @priv: Private driver interface data
3489 * @authmode: 1=Open System, 2=Shared Key, 3=both
3490 * Returns: 0 on success, -1 on failure
3491 *
3492 * This function can be used to set authentication algorithms for AP
3493 * mode when static WEP is used. If the driver uses user space MLME/SME
3494 * implementation, there is no need to implement this function.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003495 *
3496 * DEPRECATED - use set_ap() instead
Jouni Malinen75ecf522011-06-27 15:19:46 -07003497 */
3498 int (*set_authmode)(void *priv, int authmode);
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003499
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003500#ifdef ANDROID
Jouni Malinen75ecf522011-06-27 15:19:46 -07003501 /**
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003502 * driver_cmd - Execute driver-specific command
3503 * @priv: Private driver interface data
3504 * @cmd: Command to execute
3505 * @buf: Return buffer
3506 * @buf_len: Buffer length
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003507 * Returns: 0 on success, -1 on failure
3508 */
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003509 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
3510#endif /* ANDROID */
3511
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003512 /**
Dmitry Shmidta38abf92014-03-06 13:38:44 -08003513 * vendor_cmd - Execute vendor specific command
3514 * @priv: Private driver interface data
3515 * @vendor_id: Vendor id
3516 * @subcmd: Vendor command id
3517 * @data: Vendor command parameters (%NULL if no parameters)
3518 * @data_len: Data length
3519 * @buf: Return buffer (%NULL to ignore reply)
3520 * Returns: 0 on success, negative (<0) on failure
3521 *
3522 * This function handles vendor specific commands that are passed to
3523 * the driver/device. The command is identified by vendor id and
3524 * command id. Parameters can be passed as argument to the command
3525 * in the data buffer. Reply (if any) will be filled in the supplied
3526 * return buffer.
3527 *
3528 * The exact driver behavior is driver interface and vendor specific. As
3529 * an example, this will be converted to a vendor specific cfg80211
3530 * command in case of the nl80211 driver interface.
3531 */
3532 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3533 unsigned int subcmd, const u8 *data, size_t data_len,
3534 struct wpabuf *buf);
3535
3536 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003537 * set_rekey_info - Set rekey information
3538 * @priv: Private driver interface data
3539 * @kek: Current KEK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003540 * @kek_len: KEK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003541 * @kck: Current KCK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003542 * @kck_len: KCK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003543 * @replay_ctr: Current EAPOL-Key Replay Counter
3544 *
3545 * This optional function can be used to provide information for the
3546 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3547 * while the host (including wpa_supplicant) is sleeping.
3548 */
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003549 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3550 const u8 *kck, size_t kck_len,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003551 const u8 *replay_ctr);
3552
3553 /**
3554 * sta_assoc - Station association indication
3555 * @priv: Private driver interface data
3556 * @own_addr: Source address and BSSID for association frame
3557 * @addr: MAC address of the station to associate
3558 * @reassoc: flag to indicate re-association
3559 * @status: association response status code
3560 * @ie: assoc response ie buffer
3561 * @len: ie buffer length
3562 * Returns: 0 on success, -1 on failure
3563 *
3564 * This function indicates the driver to send (Re)Association
3565 * Response frame to the station.
3566 */
3567 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3568 int reassoc, u16 status, const u8 *ie, size_t len);
3569
3570 /**
3571 * sta_auth - Station authentication indication
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003572 * @priv: private driver interface data
3573 * @params: Station authentication parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003574 *
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003575 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003576 */
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07003577 int (*sta_auth)(void *priv,
3578 struct wpa_driver_sta_auth_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003579
3580 /**
3581 * add_tspec - Add traffic stream
3582 * @priv: Private driver interface data
3583 * @addr: MAC address of the station to associate
3584 * @tspec_ie: tspec ie buffer
3585 * @tspec_ielen: tspec ie length
3586 * Returns: 0 on success, -1 on failure
3587 *
3588 * This function adds the traffic steam for the station
3589 * and fills the medium_time in tspec_ie.
3590 */
3591 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3592 size_t tspec_ielen);
3593
3594 /**
3595 * add_sta_node - Add a station node in the driver
3596 * @priv: Private driver interface data
3597 * @addr: MAC address of the station to add
3598 * @auth_alg: authentication algorithm used by the station
3599 * Returns: 0 on success, -1 on failure
3600 *
3601 * This function adds the station node in the driver, when
3602 * the station gets added by FT-over-DS.
3603 */
3604 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
3605
3606 /**
3607 * sched_scan - Request the driver to initiate scheduled scan
3608 * @priv: Private driver interface data
3609 * @params: Scan parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003610 * Returns: 0 on success, -1 on failure
3611 *
3612 * This operation should be used for scheduled scan offload to
3613 * the hardware. Every time scan results are available, the
3614 * driver should report scan results event for wpa_supplicant
3615 * which will eventually request the results with
3616 * wpa_driver_get_scan_results2(). This operation is optional
3617 * and if not provided or if it returns -1, we fall back to
3618 * normal host-scheduled scans.
3619 */
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003620 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003621
3622 /**
3623 * stop_sched_scan - Request the driver to stop a scheduled scan
3624 * @priv: Private driver interface data
3625 * Returns: 0 on success, -1 on failure
3626 *
3627 * This should cause the scheduled scan to be stopped and
3628 * results should stop being sent. Must be supported if
3629 * sched_scan is supported.
3630 */
3631 int (*stop_sched_scan)(void *priv);
3632
3633 /**
3634 * poll_client - Probe (null data or such) the given station
3635 * @priv: Private driver interface data
3636 * @own_addr: MAC address of sending interface
3637 * @addr: MAC address of the station to probe
3638 * @qos: Indicates whether station is QoS station
3639 *
3640 * This function is used to verify whether an associated station is
3641 * still present. This function does not need to be implemented if the
3642 * driver provides such inactivity polling mechanism.
3643 */
3644 void (*poll_client)(void *priv, const u8 *own_addr,
3645 const u8 *addr, int qos);
Dmitry Shmidt04949592012-07-19 12:16:46 -07003646
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003647 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003648 * radio_disable - Disable/enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003649 * @priv: Private driver interface data
Dmitry Shmidt04949592012-07-19 12:16:46 -07003650 * @disabled: 1=disable 0=enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003651 * Returns: 0 on success, -1 on failure
3652 *
Dmitry Shmidt04949592012-07-19 12:16:46 -07003653 * This optional command is for testing purposes. It can be used to
3654 * disable the radio on a testbed device to simulate out-of-radio-range
3655 * conditions.
3656 */
3657 int (*radio_disable)(void *priv, int disabled);
3658
3659 /**
3660 * switch_channel - Announce channel switch and migrate the GO to the
3661 * given frequency
3662 * @priv: Private driver interface data
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003663 * @settings: Settings for CSA period and new channel
Dmitry Shmidt04949592012-07-19 12:16:46 -07003664 * Returns: 0 on success, -1 on failure
3665 *
3666 * This function is used to move the GO to the legacy STA channel to
3667 * avoid frequency conflict in single channel concurrency.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003668 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003669 int (*switch_channel)(void *priv, struct csa_settings *settings);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003670
3671 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003672 * add_tx_ts - Add traffic stream
3673 * @priv: Private driver interface data
3674 * @tsid: Traffic stream ID
3675 * @addr: Receiver address
3676 * @user_prio: User priority of the traffic stream
3677 * @admitted_time: Admitted time for this TS in units of
3678 * 32 microsecond periods (per second).
3679 * Returns: 0 on success, -1 on failure
3680 */
3681 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3682 u16 admitted_time);
3683
3684 /**
3685 * del_tx_ts - Delete traffic stream
3686 * @priv: Private driver interface data
3687 * @tsid: Traffic stream ID
3688 * @addr: Receiver address
3689 * Returns: 0 on success, -1 on failure
3690 */
3691 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3692
3693 /**
3694 * Enable channel-switching with TDLS peer
3695 * @priv: Private driver interface data
3696 * @addr: MAC address of the TDLS peer
3697 * @oper_class: Operating class of the switch channel
3698 * @params: Channel specification
3699 * Returns: 0 on success, -1 on failure
3700 *
3701 * The function indicates to driver that it can start switching to a
3702 * different channel with a specified TDLS peer. The switching is
3703 * assumed on until canceled with tdls_disable_channel_switch().
3704 */
3705 int (*tdls_enable_channel_switch)(
3706 void *priv, const u8 *addr, u8 oper_class,
3707 const struct hostapd_freq_params *params);
3708
3709 /**
3710 * Disable channel switching with TDLS peer
3711 * @priv: Private driver interface data
3712 * @addr: MAC address of the TDLS peer
3713 * Returns: 0 on success, -1 on failure
3714 *
3715 * This function indicates to the driver that it should stop switching
3716 * with a given TDLS peer.
3717 */
3718 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3719
3720 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003721 * start_dfs_cac - Listen for radar interference on the channel
3722 * @priv: Private driver interface data
Dmitry Shmidt051af732013-10-22 13:52:46 -07003723 * @freq: Channel parameters
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003724 * Returns: 0 on success, -1 on failure
3725 */
Dmitry Shmidt051af732013-10-22 13:52:46 -07003726 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003727
3728 /**
3729 * stop_ap - Removes beacon from AP
3730 * @priv: Private driver interface data
3731 * Returns: 0 on success, -1 on failure (or if not supported)
3732 *
3733 * This optional function can be used to disable AP mode related
3734 * configuration. Unlike deinit_ap, it does not change to station
3735 * mode.
3736 */
3737 int (*stop_ap)(void *priv);
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003738
3739 /**
3740 * get_survey - Retrieve survey data
3741 * @priv: Private driver interface data
3742 * @freq: If set, survey data for the specified frequency is only
3743 * being requested. If not set, all survey data is requested.
3744 * Returns: 0 on success, -1 on failure
3745 *
3746 * Use this to retrieve:
3747 *
3748 * - the observed channel noise floor
3749 * - the amount of time we have spent on the channel
3750 * - the amount of time during which we have spent on the channel that
3751 * the radio has determined the medium is busy and we cannot
3752 * transmit
3753 * - the amount of time we have spent receiving data
3754 * - the amount of time we have spent transmitting data
3755 *
3756 * This data can be used for spectrum heuristics. One example is
3757 * Automatic Channel Selection (ACS). The channel survey data is
3758 * kept on a linked list on the channel data, one entry is added
3759 * for each survey. The min_nf of the channel is updated for each
3760 * survey.
3761 */
3762 int (*get_survey)(void *priv, unsigned int freq);
Dmitry Shmidt56052862013-10-04 10:23:25 -07003763
3764 /**
3765 * status - Get driver interface status information
3766 * @priv: Private driver interface data
Hai Shalom74f70d42019-02-11 14:42:39 -08003767 * @buf: Buffer for printing the status information
Dmitry Shmidt56052862013-10-04 10:23:25 -07003768 * @buflen: Maximum length of the buffer
3769 * Returns: Length of written status information or -1 on failure
3770 */
3771 int (*status)(void *priv, char *buf, size_t buflen);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003772
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07003773 /**
3774 * roaming - Set roaming policy for driver-based BSS selection
3775 * @priv: Private driver interface data
3776 * @allowed: Whether roaming within ESS is allowed
3777 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3778 * Returns: Length of written status information or -1 on failure
3779 *
3780 * This optional callback can be used to update roaming policy from the
3781 * associate() command (bssid being set there indicates that the driver
3782 * should not roam before getting this roaming() call to allow roaming.
3783 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3784 * capability, roaming policy is handled within wpa_supplicant and there
3785 * is no need to implement or react to this callback.
3786 */
3787 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3788
3789 /**
Roshan Pius3a1667e2018-07-03 15:17:14 -07003790 * disable_fils - Enable/disable FILS feature
3791 * @priv: Private driver interface data
3792 * @disable: 0-enable and 1-disable FILS feature
3793 * Returns: 0 on success, -1 on failure
3794 *
3795 * This callback can be used to configure driver and below layers to
3796 * enable/disable all FILS features.
3797 */
3798 int (*disable_fils)(void *priv, int disable);
3799
3800 /**
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07003801 * set_mac_addr - Set MAC address
3802 * @priv: Private driver interface data
3803 * @addr: MAC address to use or %NULL for setting back to permanent
3804 * Returns: 0 on success, -1 on failure
3805 */
3806 int (*set_mac_addr)(void *priv, const u8 *addr);
3807
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003808#ifdef CONFIG_MACSEC
3809 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3810
3811 int (*macsec_deinit)(void *priv);
3812
3813 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003814 * macsec_get_capability - Inform MKA of this driver's capability
3815 * @priv: Private driver interface data
3816 * @cap: Driver's capability
3817 * Returns: 0 on success, -1 on failure
3818 */
3819 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);
3820
3821 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003822 * enable_protect_frames - Set protect frames status
3823 * @priv: Private driver interface data
3824 * @enabled: TRUE = protect frames enabled
3825 * FALSE = protect frames disabled
3826 * Returns: 0 on success, -1 on failure (or if not supported)
3827 */
3828 int (*enable_protect_frames)(void *priv, Boolean enabled);
3829
3830 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08003831 * enable_encrypt - Set encryption status
3832 * @priv: Private driver interface data
3833 * @enabled: TRUE = encrypt outgoing traffic
3834 * FALSE = integrity-only protection on outgoing traffic
3835 * Returns: 0 on success, -1 on failure (or if not supported)
3836 */
3837 int (*enable_encrypt)(void *priv, Boolean enabled);
3838
3839 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003840 * set_replay_protect - Set replay protect status and window size
3841 * @priv: Private driver interface data
3842 * @enabled: TRUE = replay protect enabled
3843 * FALSE = replay protect disabled
3844 * @window: replay window size, valid only when replay protect enabled
3845 * Returns: 0 on success, -1 on failure (or if not supported)
3846 */
3847 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3848
3849 /**
3850 * set_current_cipher_suite - Set current cipher suite
3851 * @priv: Private driver interface data
3852 * @cs: EUI64 identifier
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003853 * Returns: 0 on success, -1 on failure (or if not supported)
3854 */
Dmitry Shmidt7d175302016-09-06 13:11:34 -07003855 int (*set_current_cipher_suite)(void *priv, u64 cs);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003856
3857 /**
3858 * enable_controlled_port - Set controlled port status
3859 * @priv: Private driver interface data
3860 * @enabled: TRUE = controlled port enabled
3861 * FALSE = controlled port disabled
3862 * Returns: 0 on success, -1 on failure (or if not supported)
3863 */
3864 int (*enable_controlled_port)(void *priv, Boolean enabled);
3865
3866 /**
3867 * get_receive_lowest_pn - Get receive lowest pn
3868 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003869 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003870 * Returns: 0 on success, -1 on failure (or if not supported)
3871 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003872 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003873
3874 /**
3875 * get_transmit_next_pn - Get transmit next pn
3876 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003877 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003878 * Returns: 0 on success, -1 on failure (or if not supported)
3879 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003880 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003881
3882 /**
3883 * set_transmit_next_pn - Set transmit next pn
3884 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003885 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003886 * Returns: 0 on success, -1 on failure (or if not supported)
3887 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003888 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003889
3890 /**
Hai Shalom74f70d42019-02-11 14:42:39 -08003891 * set_receive_lowest_pn - Set receive lowest PN
3892 * @priv: Private driver interface data
3893 * @sa: secure association
3894 * Returns: 0 on success, -1 on failure (or if not supported)
3895 */
3896 int (*set_receive_lowest_pn)(void *priv, struct receive_sa *sa);
3897
3898 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003899 * create_receive_sc - create secure channel for receiving
3900 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003901 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003902 * @conf_offset: confidentiality offset (0, 30, or 50)
3903 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3904 * 2 = Strict)
3905 * Returns: 0 on success, -1 on failure (or if not supported)
3906 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003907 int (*create_receive_sc)(void *priv, struct receive_sc *sc,
3908 unsigned int conf_offset,
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003909 int validation);
3910
3911 /**
3912 * delete_receive_sc - delete secure connection for receiving
3913 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003914 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003915 * Returns: 0 on success, -1 on failure
3916 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003917 int (*delete_receive_sc)(void *priv, struct receive_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003918
3919 /**
3920 * create_receive_sa - create secure association for receive
3921 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003922 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003923 * Returns: 0 on success, -1 on failure
3924 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003925 int (*create_receive_sa)(void *priv, struct receive_sa *sa);
3926
3927 /**
3928 * delete_receive_sa - Delete secure association for receive
3929 * @priv: Private driver interface data from init()
3930 * @sa: Secure association
3931 * Returns: 0 on success, -1 on failure
3932 */
3933 int (*delete_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003934
3935 /**
3936 * enable_receive_sa - enable the SA for receive
3937 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003938 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003939 * Returns: 0 on success, -1 on failure
3940 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003941 int (*enable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003942
3943 /**
3944 * disable_receive_sa - disable SA for receive
3945 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003946 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003947 * Returns: 0 on success, -1 on failure
3948 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003949 int (*disable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003950
3951 /**
3952 * create_transmit_sc - create secure connection for transmit
3953 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003954 * @sc: secure channel
3955 * @conf_offset: confidentiality offset (0, 30, or 50)
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003956 * Returns: 0 on success, -1 on failure
3957 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003958 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
3959 unsigned int conf_offset);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003960
3961 /**
3962 * delete_transmit_sc - delete secure connection for transmit
3963 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003964 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003965 * Returns: 0 on success, -1 on failure
3966 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003967 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003968
3969 /**
3970 * create_transmit_sa - create secure association for transmit
3971 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003972 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003973 * Returns: 0 on success, -1 on failure
3974 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003975 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);
3976
3977 /**
3978 * delete_transmit_sa - Delete secure association for transmit
3979 * @priv: Private driver interface data from init()
3980 * @sa: Secure association
3981 * Returns: 0 on success, -1 on failure
3982 */
3983 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003984
3985 /**
3986 * enable_transmit_sa - enable SA for transmit
3987 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003988 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003989 * Returns: 0 on success, -1 on failure
3990 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003991 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003992
3993 /**
3994 * disable_transmit_sa - disable SA for transmit
3995 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003996 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003997 * Returns: 0 on success, -1 on failure
3998 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003999 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07004000#endif /* CONFIG_MACSEC */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004001
4002 /**
4003 * init_mesh - Driver specific initialization for mesh
4004 * @priv: Private driver interface data
4005 * Returns: 0 on success, -1 on failure
4006 */
4007 int (*init_mesh)(void *priv);
4008
4009 /**
4010 * join_mesh - Join a mesh network
4011 * @priv: Private driver interface data
4012 * @params: Mesh configuration parameters
4013 * Returns: 0 on success, -1 on failure
4014 */
4015 int (*join_mesh)(void *priv,
4016 struct wpa_driver_mesh_join_params *params);
4017
4018 /**
4019 * leave_mesh - Leave a mesh network
4020 * @priv: Private driver interface data
4021 * Returns 0 on success, -1 on failure
4022 */
4023 int (*leave_mesh)(void *priv);
4024
4025 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07004026 * probe_mesh_link - Inject a frame over direct mesh link to a given
4027 * peer skipping the next_hop lookup from mpath table.
4028 * @priv: Private driver interface data
4029 * @addr: Peer MAC address
4030 * @eth: Ethernet frame to be sent
4031 * @len: Ethernet frame lengtn in bytes
4032 * Returns 0 on success, -1 on failure
4033 */
4034 int (*probe_mesh_link)(void *priv, const u8 *addr, const u8 *eth,
4035 size_t len);
4036
4037 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004038 * do_acs - Automatically select channel
4039 * @priv: Private driver interface data
4040 * @params: Parameters for ACS
4041 * Returns 0 on success, -1 on failure
4042 *
4043 * This command can be used to offload ACS to the driver if the driver
4044 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
4045 */
4046 int (*do_acs)(void *priv, struct drv_acs_params *params);
Ravi Joshie6ccb162015-07-16 17:45:41 -07004047
4048 /**
4049 * set_band - Notify driver of band selection
4050 * @priv: Private driver interface data
4051 * @band: The selected band(s)
4052 * Returns 0 on success, -1 on failure
4053 */
4054 int (*set_band)(void *priv, enum set_band band);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004055
4056 /**
4057 * get_pref_freq_list - Get preferred frequency list for an interface
4058 * @priv: Private driver interface data
4059 * @if_type: Interface type
4060 * @num: Number of channels
4061 * @freq_list: Preferred channel frequency list encoded in MHz values
4062 * Returns 0 on success, -1 on failure
4063 *
4064 * This command can be used to query the preferred frequency list from
4065 * the driver specific to a particular interface type.
4066 */
4067 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
4068 unsigned int *num, unsigned int *freq_list);
4069
4070 /**
4071 * set_prob_oper_freq - Indicate probable P2P operating channel
4072 * @priv: Private driver interface data
4073 * @freq: Channel frequency in MHz
4074 * Returns 0 on success, -1 on failure
4075 *
4076 * This command can be used to inform the driver of the operating
4077 * frequency that an ongoing P2P group formation is likely to come up
4078 * on. Local device is assuming P2P Client role.
4079 */
4080 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004081
4082 /**
4083 * abort_scan - Request the driver to abort an ongoing scan
4084 * @priv: Private driver interface data
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004085 * @scan_cookie: Cookie identifying the scan request. This is used only
4086 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4087 * was used to trigger scan. Otherwise, 0 is used.
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004088 * Returns 0 on success, -1 on failure
4089 */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08004090 int (*abort_scan)(void *priv, u64 scan_cookie);
Dmitry Shmidt849734c2016-05-27 09:59:01 -07004091
4092 /**
4093 * configure_data_frame_filters - Request to configure frame filters
4094 * @priv: Private driver interface data
4095 * @filter_flags: The type of frames to filter (bitfield of
4096 * WPA_DATA_FRAME_FILTER_FLAG_*)
4097 * Returns: 0 on success or -1 on failure
4098 */
4099 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07004100
4101 /**
4102 * get_ext_capab - Get extended capabilities for the specified interface
4103 * @priv: Private driver interface data
4104 * @type: Interface type for which to get extended capabilities
4105 * @ext_capab: Extended capabilities fetched
4106 * @ext_capab_mask: Extended capabilities mask
4107 * @ext_capab_len: Length of the extended capabilities
4108 * Returns: 0 on success or -1 on failure
4109 */
4110 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
4111 const u8 **ext_capab, const u8 **ext_capab_mask,
4112 unsigned int *ext_capab_len);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004113
4114 /**
4115 * p2p_lo_start - Start offloading P2P listen to device
4116 * @priv: Private driver interface data
4117 * @freq: Listening frequency (MHz) for P2P listen
4118 * @period: Length of the listen operation in milliseconds
4119 * @interval: Interval for running the listen operation in milliseconds
4120 * @count: Number of times to run the listen operation
4121 * @device_types: Device primary and secondary types
4122 * @dev_types_len: Number of bytes for device_types
4123 * @ies: P2P IE and WSC IE for Probe Response frames
4124 * @ies_len: Length of ies in bytes
4125 * Returns: 0 on success or -1 on failure
4126 */
4127 int (*p2p_lo_start)(void *priv, unsigned int freq,
4128 unsigned int period, unsigned int interval,
4129 unsigned int count,
4130 const u8 *device_types, size_t dev_types_len,
4131 const u8 *ies, size_t ies_len);
4132
4133 /**
4134 * p2p_lo_stop - Stop P2P listen offload
4135 * @priv: Private driver interface data
4136 * Returns: 0 on success or -1 on failure
4137 */
4138 int (*p2p_lo_stop)(void *priv);
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07004139
4140 /**
4141 * set_default_scan_ies - Set default scan IEs
4142 * @priv: Private driver interface data
4143 * @ies: Scan default IEs buffer
4144 * @ies_len: Length of IEs in bytes
4145 * Returns: 0 on success or -1 on failure
4146 *
4147 * The driver can use these by default when there are no scan IEs coming
4148 * in the subsequent scan requests. Also in case of one or more of IEs
4149 * given in set_default_scan_ies() are missing in the subsequent scan
4150 * request, the driver should merge the missing scan IEs in the scan
4151 * request from the IEs set by set_default_scan_ies() in the Probe
4152 * Request frames sent.
4153 */
4154 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
4155
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004156 /**
4157 * set_tdls_mode - Set TDLS trigger mode to the host driver
4158 * @priv: Private driver interface data
4159 * @tdls_external_control: Represents if TDLS external trigger control
4160 * mode is enabled/disabled.
4161 *
4162 * This optional callback can be used to configure the TDLS external
4163 * trigger control mode to the host driver.
4164 */
4165 int (*set_tdls_mode)(void *priv, int tdls_external_control);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004166
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004167 /**
4168 * get_bss_transition_status - Get candidate BSS's transition status
4169 * @priv: Private driver interface data
4170 * @params: Candidate BSS list
4171 *
4172 * Get the accept or reject reason code for a list of BSS transition
4173 * candidates.
4174 */
4175 struct wpa_bss_candidate_info *
4176 (*get_bss_transition_status)(void *priv,
4177 struct wpa_bss_trans_info *params);
4178 /**
4179 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
4180 * @priv: Private driver interface data
4181 * @ignore_disallow: 0 to not ignore, 1 to ignore
4182 * Returns: 0 on success, -1 on failure
4183 */
4184 int (*ignore_assoc_disallow)(void *priv, int ignore_disallow);
4185
4186 /**
4187 * set_bssid_blacklist - Set blacklist of BSSIDs to the driver
4188 * @priv: Private driver interface data
4189 * @num_bssid: Number of blacklist BSSIDs
4190 * @bssids: List of blacklisted BSSIDs
4191 */
4192 int (*set_bssid_blacklist)(void *priv, unsigned int num_bssid,
4193 const u8 *bssid);
4194
4195 /**
4196 * update_connect_params - Update the connection parameters
4197 * @priv: Private driver interface data
4198 * @params: Association parameters
4199 * @mask: Bit mask indicating which parameters in @params have to be
4200 * updated
4201 * Returns: 0 on success, -1 on failure
4202 *
4203 * Update the connection parameters when in connected state so that the
4204 * driver uses the updated parameters for subsequent roaming. This is
4205 * used only with drivers that implement internal BSS selection and
4206 * roaming.
4207 */
4208 int (*update_connect_params)(
4209 void *priv, struct wpa_driver_associate_params *params,
4210 enum wpa_drv_update_connect_params_mask mask);
Roshan Pius3a1667e2018-07-03 15:17:14 -07004211
4212 /**
4213 * send_external_auth_status - Indicate the status of external
4214 * authentication processing to the host driver.
4215 * @priv: Private driver interface data
4216 * @params: Status of authentication processing.
4217 * Returns: 0 on success, -1 on failure
4218 */
4219 int (*send_external_auth_status)(void *priv,
4220 struct external_auth *params);
Hai Shalom74f70d42019-02-11 14:42:39 -08004221
4222 /**
4223 * set_4addr_mode - Set 4-address mode
4224 * @priv: Private driver interface data
4225 * @bridge_ifname: Bridge interface name
4226 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
4227 * Returns: 0 on success, < 0 on failure
4228 */
4229 int (*set_4addr_mode)(void *priv, const char *bridge_ifname, int val);
Hai Shalom81f62d82019-07-22 12:10:00 -07004230
4231 /**
4232 * update_dh_ie - Update DH IE
4233 * @priv: Private driver interface data
4234 * @peer_mac: Peer MAC address
4235 * @reason_code: Reacon code
4236 * @ie: DH IE
4237 * @ie_len: DH IE length in bytes
4238 * Returns: 0 on success, -1 on failure
4239 *
4240 * This callback is used to let the driver know the DH processing result
4241 * and DH IE for a pending association.
4242 */
4243 int (*update_dh_ie)(void *priv, const u8 *peer_mac, u16 reason_code,
4244 const u8 *ie, size_t ie_len);
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004245};
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004246
4247/**
4248 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
4249 */
4250enum wpa_event_type {
4251 /**
4252 * EVENT_ASSOC - Association completed
4253 *
4254 * This event needs to be delivered when the driver completes IEEE
4255 * 802.11 association or reassociation successfully.
4256 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
4257 * after this event has been generated. In addition, optional
4258 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
4259 * more information about the association. If the driver interface gets
4260 * both of these events at the same time, it can also include the
4261 * assoc_info data in EVENT_ASSOC call.
4262 */
4263 EVENT_ASSOC,
4264
4265 /**
4266 * EVENT_DISASSOC - Association lost
4267 *
4268 * This event should be called when association is lost either due to
4269 * receiving deauthenticate or disassociate frame from the AP or when
4270 * sending either of these frames to the current AP. If the driver
4271 * supports separate deauthentication event, EVENT_DISASSOC should only
4272 * be used for disassociation and EVENT_DEAUTH for deauthentication.
4273 * In AP mode, union wpa_event_data::disassoc_info is required.
4274 */
4275 EVENT_DISASSOC,
4276
4277 /**
4278 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
4279 *
4280 * This event must be delivered when a Michael MIC error is detected by
4281 * the local driver. Additional data for event processing is
4282 * provided with union wpa_event_data::michael_mic_failure. This
4283 * information is used to request new encyption key and to initiate
4284 * TKIP countermeasures if needed.
4285 */
4286 EVENT_MICHAEL_MIC_FAILURE,
4287
4288 /**
4289 * EVENT_SCAN_RESULTS - Scan results available
4290 *
4291 * This event must be called whenever scan results are available to be
4292 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4293 * is expected to be used some time after struct wpa_driver_ops::scan()
4294 * is called. If the driver provides an unsolicited event when the scan
4295 * has been completed, this event can be used to trigger
4296 * EVENT_SCAN_RESULTS call. If such event is not available from the
4297 * driver, the driver wrapper code is expected to use a registered
4298 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
4299 * scan is expected to be completed. Optional information about
4300 * completed scan can be provided with union wpa_event_data::scan_info.
4301 */
4302 EVENT_SCAN_RESULTS,
4303
4304 /**
4305 * EVENT_ASSOCINFO - Report optional extra information for association
4306 *
4307 * This event can be used to report extra association information for
4308 * EVENT_ASSOC processing. This extra information includes IEs from
4309 * association frames and Beacon/Probe Response frames in union
4310 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4311 * EVENT_ASSOC. Alternatively, the driver interface can include
4312 * assoc_info data in the EVENT_ASSOC call if it has all the
4313 * information available at the same point.
4314 */
4315 EVENT_ASSOCINFO,
4316
4317 /**
4318 * EVENT_INTERFACE_STATUS - Report interface status changes
4319 *
4320 * This optional event can be used to report changes in interface
4321 * status (interface added/removed) using union
4322 * wpa_event_data::interface_status. This can be used to trigger
4323 * wpa_supplicant to stop and re-start processing for the interface,
4324 * e.g., when a cardbus card is ejected/inserted.
4325 */
4326 EVENT_INTERFACE_STATUS,
4327
4328 /**
4329 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4330 *
4331 * This event can be used to inform wpa_supplicant about candidates for
4332 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4333 * for scan request (ap_scan=2 mode), this event is required for
4334 * pre-authentication. If wpa_supplicant is performing scan request
4335 * (ap_scan=1), this event is optional since scan results can be used
4336 * to add pre-authentication candidates. union
4337 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4338 * candidate and priority of the candidate, e.g., based on the signal
4339 * strength, in order to try to pre-authenticate first with candidates
4340 * that are most likely targets for re-association.
4341 *
4342 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4343 * on the candidate list. In addition, it can be called for the current
4344 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4345 * will automatically skip pre-authentication in cases where a valid
4346 * PMKSA exists. When more than one candidate exists, this event should
4347 * be generated once for each candidate.
4348 *
4349 * Driver will be notified about successful pre-authentication with
4350 * struct wpa_driver_ops::add_pmkid() calls.
4351 */
4352 EVENT_PMKID_CANDIDATE,
4353
4354 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004355 * EVENT_TDLS - Request TDLS operation
4356 *
4357 * This event can be used to request a TDLS operation to be performed.
4358 */
4359 EVENT_TDLS,
4360
4361 /**
4362 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4363 *
4364 * The driver is expected to report the received FT IEs from
4365 * FT authentication sequence from the AP. The FT IEs are included in
4366 * the extra information in union wpa_event_data::ft_ies.
4367 */
4368 EVENT_FT_RESPONSE,
4369
4370 /**
4371 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4372 *
4373 * The driver can use this event to inform wpa_supplicant about a STA
4374 * in an IBSS with which protected frames could be exchanged. This
4375 * event starts RSN authentication with the other STA to authenticate
4376 * the STA and set up encryption keys with it.
4377 */
4378 EVENT_IBSS_RSN_START,
4379
4380 /**
4381 * EVENT_AUTH - Authentication result
4382 *
4383 * This event should be called when authentication attempt has been
4384 * completed. This is only used if the driver supports separate
4385 * authentication step (struct wpa_driver_ops::authenticate).
4386 * Information about authentication result is included in
4387 * union wpa_event_data::auth.
4388 */
4389 EVENT_AUTH,
4390
4391 /**
4392 * EVENT_DEAUTH - Authentication lost
4393 *
4394 * This event should be called when authentication is lost either due
4395 * to receiving deauthenticate frame from the AP or when sending that
4396 * frame to the current AP.
4397 * In AP mode, union wpa_event_data::deauth_info is required.
4398 */
4399 EVENT_DEAUTH,
4400
4401 /**
4402 * EVENT_ASSOC_REJECT - Association rejected
4403 *
4404 * This event should be called when (re)association attempt has been
4405 * rejected by the AP. Information about the association response is
4406 * included in union wpa_event_data::assoc_reject.
4407 */
4408 EVENT_ASSOC_REJECT,
4409
4410 /**
4411 * EVENT_AUTH_TIMED_OUT - Authentication timed out
4412 */
4413 EVENT_AUTH_TIMED_OUT,
4414
4415 /**
4416 * EVENT_ASSOC_TIMED_OUT - Association timed out
4417 */
4418 EVENT_ASSOC_TIMED_OUT,
4419
4420 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004421 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
4422 */
4423 EVENT_WPS_BUTTON_PUSHED,
4424
4425 /**
4426 * EVENT_TX_STATUS - Report TX status
4427 */
4428 EVENT_TX_STATUS,
4429
4430 /**
4431 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
4432 */
4433 EVENT_RX_FROM_UNKNOWN,
4434
4435 /**
4436 * EVENT_RX_MGMT - Report RX of a management frame
4437 */
4438 EVENT_RX_MGMT,
4439
4440 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004441 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
4442 *
4443 * This event is used to indicate when the driver has started the
4444 * requested remain-on-channel duration. Information about the
4445 * operation is included in union wpa_event_data::remain_on_channel.
4446 */
4447 EVENT_REMAIN_ON_CHANNEL,
4448
4449 /**
4450 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
4451 *
4452 * This event is used to indicate when the driver has completed
4453 * remain-on-channel duration, i.e., may noot be available on the
4454 * requested channel anymore. Information about the
4455 * operation is included in union wpa_event_data::remain_on_channel.
4456 */
4457 EVENT_CANCEL_REMAIN_ON_CHANNEL,
4458
4459 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004460 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
4461 *
4462 * This event is used to indicate when a Probe Request frame has been
4463 * received. Information about the received frame is included in
4464 * union wpa_event_data::rx_probe_req. The driver is required to report
4465 * these events only after successfully completed probe_req_report()
4466 * commands to request the events (i.e., report parameter is non-zero)
4467 * in station mode. In AP mode, Probe Request frames should always be
4468 * reported.
4469 */
4470 EVENT_RX_PROBE_REQ,
4471
4472 /**
4473 * EVENT_NEW_STA - New wired device noticed
4474 *
4475 * This event is used to indicate that a new device has been detected
4476 * in a network that does not use association-like functionality (i.e.,
4477 * mainly wired Ethernet). This can be used to start EAPOL
4478 * authenticator when receiving a frame from a device. The address of
4479 * the device is included in union wpa_event_data::new_sta.
4480 */
4481 EVENT_NEW_STA,
4482
4483 /**
4484 * EVENT_EAPOL_RX - Report received EAPOL frame
4485 *
4486 * When in AP mode with hostapd, this event is required to be used to
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004487 * deliver the receive EAPOL frames from the driver.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004488 */
4489 EVENT_EAPOL_RX,
4490
4491 /**
4492 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4493 *
4494 * This event is used to indicate changes in the signal strength
4495 * observed in frames received from the current AP if signal strength
4496 * monitoring has been enabled with signal_monitor().
4497 */
4498 EVENT_SIGNAL_CHANGE,
4499
4500 /**
4501 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4502 *
4503 * This event is used to indicate that the interface was enabled after
4504 * having been previously disabled, e.g., due to rfkill.
4505 */
4506 EVENT_INTERFACE_ENABLED,
4507
4508 /**
4509 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4510 *
4511 * This event is used to indicate that the interface was disabled,
4512 * e.g., due to rfkill.
4513 */
4514 EVENT_INTERFACE_DISABLED,
4515
4516 /**
4517 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4518 *
4519 * This event is used to indicate that the channel list has changed,
4520 * e.g., because of a regulatory domain change triggered by scan
4521 * results including an AP advertising a country code.
4522 */
4523 EVENT_CHANNEL_LIST_CHANGED,
4524
4525 /**
4526 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4527 *
4528 * This event is used to indicate that the driver cannot maintain this
4529 * interface in its operation mode anymore. The most likely use for
4530 * this is to indicate that AP mode operation is not available due to
4531 * operating channel would need to be changed to a DFS channel when
4532 * the driver does not support radar detection and another virtual
4533 * interfaces caused the operating channel to change. Other similar
4534 * resource conflicts could also trigger this for station mode
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07004535 * interfaces. This event can be propagated when channel switching
4536 * fails.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004537 */
4538 EVENT_INTERFACE_UNAVAILABLE,
4539
4540 /**
4541 * EVENT_BEST_CHANNEL
4542 *
4543 * Driver generates this event whenever it detects a better channel
4544 * (e.g., based on RSSI or channel use). This information can be used
4545 * to improve channel selection for a new AP/P2P group.
4546 */
4547 EVENT_BEST_CHANNEL,
4548
4549 /**
4550 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4551 *
4552 * This event should be called when a Deauthentication frame is dropped
4553 * due to it not being protected (MFP/IEEE 802.11w).
4554 * union wpa_event_data::unprot_deauth is required to provide more
4555 * details of the frame.
4556 */
4557 EVENT_UNPROT_DEAUTH,
4558
4559 /**
4560 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4561 *
4562 * This event should be called when a Disassociation frame is dropped
4563 * due to it not being protected (MFP/IEEE 802.11w).
4564 * union wpa_event_data::unprot_disassoc is required to provide more
4565 * details of the frame.
4566 */
4567 EVENT_UNPROT_DISASSOC,
4568
4569 /**
4570 * EVENT_STATION_LOW_ACK
4571 *
4572 * Driver generates this event whenever it detected that a particular
4573 * station was lost. Detection can be through massive transmission
4574 * failures for example.
4575 */
4576 EVENT_STATION_LOW_ACK,
4577
4578 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004579 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4580 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004581 EVENT_IBSS_PEER_LOST,
4582
4583 /**
4584 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4585 *
4586 * This event carries the new replay counter to notify wpa_supplicant
4587 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4588 * completed Group Key Handshake while the host (including
4589 * wpa_supplicant was sleeping).
4590 */
4591 EVENT_DRIVER_GTK_REKEY,
4592
4593 /**
4594 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4595 */
4596 EVENT_SCHED_SCAN_STOPPED,
4597
4598 /**
4599 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4600 *
4601 * This event indicates that the station responded to the poll
4602 * initiated with @poll_client.
4603 */
4604 EVENT_DRIVER_CLIENT_POLL_OK,
4605
4606 /**
4607 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4608 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07004609 EVENT_EAPOL_TX_STATUS,
4610
4611 /**
4612 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4613 *
4614 * Described in wpa_event_data.ch_switch
4615 * */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004616 EVENT_CH_SWITCH,
4617
4618 /**
Hai Shalom81f62d82019-07-22 12:10:00 -07004619 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
4620 *
4621 * This is a pre-switch event indicating the shortly following switch
4622 * of operating channels.
4623 *
4624 * Described in wpa_event_data.ch_switch
4625 */
4626 EVENT_CH_SWITCH_STARTED,
4627 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004628 * EVENT_WNM - Request WNM operation
4629 *
4630 * This event can be used to request a WNM operation to be performed.
4631 */
Dmitry Shmidtf8623282013-02-20 14:34:59 -08004632 EVENT_WNM,
4633
4634 /**
4635 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4636 *
4637 * This event indicates that the driver reported a connection failure
4638 * with the specified client (for example, max client reached, etc.) in
4639 * AP mode.
4640 */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004641 EVENT_CONNECT_FAILED_REASON,
4642
4643 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004644 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004645 *
4646 * A radar has been detected on the supplied frequency, hostapd should
4647 * react accordingly (e.g., change channel).
4648 */
4649 EVENT_DFS_RADAR_DETECTED,
4650
4651 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004652 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004653 *
4654 * After a successful CAC, the channel can be marked clear and used.
4655 */
4656 EVENT_DFS_CAC_FINISHED,
4657
4658 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004659 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004660 *
4661 * The CAC was not successful, and the channel remains in the previous
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004662 * state. This may happen due to a radar being detected or other
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004663 * external influences.
4664 */
4665 EVENT_DFS_CAC_ABORTED,
4666
4667 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004668 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004669 *
4670 * The channel which was previously unavailable is now available again.
4671 */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004672 EVENT_DFS_NOP_FINISHED,
4673
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08004674 /**
4675 * EVENT_SURVEY - Received survey data
4676 *
4677 * This event gets triggered when a driver query is issued for survey
4678 * data and the requested data becomes available. The returned data is
4679 * stored in struct survey_results. The results provide at most one
4680 * survey entry for each frequency and at minimum will provide one
4681 * survey entry for one frequency. The survey data can be os_malloc()'d
4682 * and then os_free()'d, so the event callback must only copy data.
4683 */
4684 EVENT_SURVEY,
4685
4686 /**
4687 * EVENT_SCAN_STARTED - Scan started
4688 *
4689 * This indicates that driver has started a scan operation either based
4690 * on a request from wpa_supplicant/hostapd or from another application.
4691 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4692 * completed (either successfully or by getting cancelled).
4693 */
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08004694 EVENT_SCAN_STARTED,
4695
4696 /**
4697 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4698 *
4699 * This event indicates a set of frequency ranges that should be avoided
4700 * to reduce issues due to interference or internal co-existence
4701 * information in the driver.
4702 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004703 EVENT_AVOID_FREQUENCIES,
4704
4705 /**
4706 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4707 */
4708 EVENT_NEW_PEER_CANDIDATE,
4709
4710 /**
4711 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4712 *
4713 * Indicates a pair of primary and secondary channels chosen by ACS
4714 * in device.
4715 */
4716 EVENT_ACS_CHANNEL_SELECTED,
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004717
4718 /**
4719 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4720 * been started.
4721 *
4722 * This event indicates that channel availability check has been started
4723 * on a DFS frequency by a driver that supports DFS Offload.
4724 */
4725 EVENT_DFS_CAC_STARTED,
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004726
4727 /**
4728 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4729 */
4730 EVENT_P2P_LO_STOP,
Paul Stewart092955c2017-02-06 09:13:09 -08004731
4732 /**
4733 * EVENT_BEACON_LOSS - Beacon loss detected
4734 *
4735 * This event indicates that no Beacon frames has been received from
4736 * the current AP. This may indicate that the AP is not anymore in
4737 * range.
4738 */
4739 EVENT_BEACON_LOSS,
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004740
4741 /**
4742 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
4743 * done previously (Pre-CAC) on the channel has expired. This would
4744 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
4745 * channel will be moved from available to usable. A new CAC has to be
4746 * performed before start operating on this channel.
4747 */
4748 EVENT_DFS_PRE_CAC_EXPIRED,
Roshan Pius3a1667e2018-07-03 15:17:14 -07004749
4750 /**
4751 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
4752 * that do not define separate commands for authentication and
4753 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
4754 * authentication to wpa_supplicant. This event carries all the
4755 * necessary information from the host driver for the authentication to
4756 * happen.
4757 */
4758 EVENT_EXTERNAL_AUTH,
4759
4760 /**
4761 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
4762 *
4763 * This event should be indicated when the driver completes the 4-way
4764 * handshake. This event should be preceded by an EVENT_ASSOC that
4765 * indicates the completion of IEEE 802.11 association.
4766 */
4767 EVENT_PORT_AUTHORIZED,
4768
4769 /**
4770 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
4771 * change event.
4772 */
4773 EVENT_STATION_OPMODE_CHANGED,
4774
4775 /**
4776 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
4777 *
4778 * This event is emitted when the MAC changes while the interface is
4779 * enabled. When an interface was disabled and becomes enabled, it
4780 * must be always assumed that the MAC possibly changed.
4781 */
4782 EVENT_INTERFACE_MAC_CHANGED,
4783
4784 /**
4785 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
4786 *
4787 * This event is emitted when an interface is added/removed for WDS STA.
4788 */
4789 EVENT_WDS_STA_INTERFACE_STATUS,
Hai Shalom81f62d82019-07-22 12:10:00 -07004790
4791 /**
4792 * EVENT_UPDATE_DH - Notification of updated DH information
4793 */
4794 EVENT_UPDATE_DH,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004795};
4796
4797
4798/**
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004799 * struct freq_survey - Channel survey info
4800 *
4801 * @ifidx: Interface index in which this survey was observed
4802 * @freq: Center of frequency of the surveyed channel
4803 * @nf: Channel noise floor in dBm
4804 * @channel_time: Amount of time in ms the radio spent on the channel
4805 * @channel_time_busy: Amount of time in ms the radio detected some signal
4806 * that indicated to the radio the channel was not clear
4807 * @channel_time_rx: Amount of time the radio spent receiving data
4808 * @channel_time_tx: Amount of time the radio spent transmitting data
4809 * @filled: bitmask indicating which fields have been reported, see
4810 * SURVEY_HAS_* defines.
4811 * @list: Internal list pointers
4812 */
4813struct freq_survey {
4814 u32 ifidx;
4815 unsigned int freq;
4816 s8 nf;
4817 u64 channel_time;
4818 u64 channel_time_busy;
4819 u64 channel_time_rx;
4820 u64 channel_time_tx;
4821 unsigned int filled;
4822 struct dl_list list;
4823};
4824
4825#define SURVEY_HAS_NF BIT(0)
4826#define SURVEY_HAS_CHAN_TIME BIT(1)
4827#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4828#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4829#define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4830
4831
4832/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004833 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4834 */
4835union wpa_event_data {
4836 /**
4837 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4838 *
4839 * This structure is optional for EVENT_ASSOC calls and required for
4840 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4841 * driver interface does not need to generate separate EVENT_ASSOCINFO
4842 * calls.
4843 */
4844 struct assoc_info {
4845 /**
4846 * reassoc - Flag to indicate association or reassociation
4847 */
4848 int reassoc;
4849
4850 /**
4851 * req_ies - (Re)Association Request IEs
4852 *
4853 * If the driver generates WPA/RSN IE, this event data must be
4854 * returned for WPA handshake to have needed information. If
4855 * wpa_supplicant-generated WPA/RSN IE is used, this
4856 * information event is optional.
4857 *
4858 * This should start with the first IE (fixed fields before IEs
4859 * are not included).
4860 */
4861 const u8 *req_ies;
4862
4863 /**
4864 * req_ies_len - Length of req_ies in bytes
4865 */
4866 size_t req_ies_len;
4867
4868 /**
4869 * resp_ies - (Re)Association Response IEs
4870 *
4871 * Optional association data from the driver. This data is not
4872 * required WPA, but may be useful for some protocols and as
4873 * such, should be reported if this is available to the driver
4874 * interface.
4875 *
4876 * This should start with the first IE (fixed fields before IEs
4877 * are not included).
4878 */
4879 const u8 *resp_ies;
4880
4881 /**
4882 * resp_ies_len - Length of resp_ies in bytes
4883 */
4884 size_t resp_ies_len;
4885
4886 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004887 * resp_frame - (Re)Association Response frame
4888 */
4889 const u8 *resp_frame;
4890
4891 /**
4892 * resp_frame_len - (Re)Association Response frame length
4893 */
4894 size_t resp_frame_len;
4895
4896 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004897 * beacon_ies - Beacon or Probe Response IEs
4898 *
4899 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4900 * Probe Response frames from the current AP (i.e., the one
4901 * that the client just associated with). This information is
4902 * used to update WPA/RSN IE for the AP. If this field is not
4903 * set, the results from previous scan will be used. If no
4904 * data for the new AP is found, scan results will be requested
4905 * again (without scan request). At this point, the driver is
4906 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4907 * used).
4908 *
4909 * This should start with the first IE (fixed fields before IEs
4910 * are not included).
4911 */
4912 const u8 *beacon_ies;
4913
4914 /**
4915 * beacon_ies_len - Length of beacon_ies */
4916 size_t beacon_ies_len;
4917
4918 /**
4919 * freq - Frequency of the operational channel in MHz
4920 */
4921 unsigned int freq;
4922
4923 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004924 * wmm_params - WMM parameters used in this association.
4925 */
4926 struct wmm_params wmm_params;
4927
4928 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004929 * addr - Station address (for AP mode)
4930 */
4931 const u8 *addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004932
4933 /**
4934 * The following is the key management offload information
4935 * @authorized
4936 * @key_replay_ctr
4937 * @key_replay_ctr_len
4938 * @ptk_kck
4939 * @ptk_kek_len
4940 * @ptk_kek
4941 * @ptk_kek_len
4942 */
4943
4944 /**
4945 * authorized - Status of key management offload,
4946 * 1 = successful
4947 */
4948 int authorized;
4949
4950 /**
4951 * key_replay_ctr - Key replay counter value last used
4952 * in a valid EAPOL-Key frame
4953 */
4954 const u8 *key_replay_ctr;
4955
4956 /**
4957 * key_replay_ctr_len - The length of key_replay_ctr
4958 */
4959 size_t key_replay_ctr_len;
4960
4961 /**
4962 * ptk_kck - The derived PTK KCK
4963 */
4964 const u8 *ptk_kck;
4965
4966 /**
4967 * ptk_kek_len - The length of ptk_kck
4968 */
4969 size_t ptk_kck_len;
4970
4971 /**
4972 * ptk_kek - The derived PTK KEK
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004973 * This is used in key management offload and also in FILS SK
4974 * offload.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004975 */
4976 const u8 *ptk_kek;
4977
4978 /**
4979 * ptk_kek_len - The length of ptk_kek
4980 */
4981 size_t ptk_kek_len;
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004982
4983 /**
4984 * subnet_status - The subnet status:
4985 * 0 = unknown, 1 = unchanged, 2 = changed
4986 */
4987 u8 subnet_status;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07004988
4989 /**
4990 * The following information is used in FILS SK offload
4991 * @fils_erp_next_seq_num
4992 * @fils_pmk
4993 * @fils_pmk_len
4994 * @fils_pmkid
4995 */
4996
4997 /**
4998 * fils_erp_next_seq_num - The next sequence number to use in
4999 * FILS ERP messages
5000 */
5001 u16 fils_erp_next_seq_num;
5002
5003 /**
5004 * fils_pmk - A new PMK if generated in case of FILS
5005 * authentication
5006 */
5007 const u8 *fils_pmk;
5008
5009 /**
5010 * fils_pmk_len - Length of fils_pmk
5011 */
5012 size_t fils_pmk_len;
5013
5014 /**
5015 * fils_pmkid - PMKID used or generated in FILS authentication
5016 */
5017 const u8 *fils_pmkid;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005018 } assoc_info;
5019
5020 /**
5021 * struct disassoc_info - Data for EVENT_DISASSOC events
5022 */
5023 struct disassoc_info {
5024 /**
5025 * addr - Station address (for AP mode)
5026 */
5027 const u8 *addr;
5028
5029 /**
5030 * reason_code - Reason Code (host byte order) used in
5031 * Deauthentication frame
5032 */
5033 u16 reason_code;
5034
5035 /**
5036 * ie - Optional IE(s) in Disassociation frame
5037 */
5038 const u8 *ie;
5039
5040 /**
5041 * ie_len - Length of ie buffer in octets
5042 */
5043 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005044
5045 /**
5046 * locally_generated - Whether the frame was locally generated
5047 */
5048 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005049 } disassoc_info;
5050
5051 /**
5052 * struct deauth_info - Data for EVENT_DEAUTH events
5053 */
5054 struct deauth_info {
5055 /**
5056 * addr - Station address (for AP mode)
5057 */
5058 const u8 *addr;
5059
5060 /**
5061 * reason_code - Reason Code (host byte order) used in
5062 * Deauthentication frame
5063 */
5064 u16 reason_code;
5065
5066 /**
5067 * ie - Optional IE(s) in Deauthentication frame
5068 */
5069 const u8 *ie;
5070
5071 /**
5072 * ie_len - Length of ie buffer in octets
5073 */
5074 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08005075
5076 /**
5077 * locally_generated - Whether the frame was locally generated
5078 */
5079 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005080 } deauth_info;
5081
5082 /**
5083 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
5084 */
5085 struct michael_mic_failure {
5086 int unicast;
5087 const u8 *src;
5088 } michael_mic_failure;
5089
5090 /**
5091 * struct interface_status - Data for EVENT_INTERFACE_STATUS
5092 */
5093 struct interface_status {
Dmitry Shmidte4663042016-04-04 10:07:49 -07005094 unsigned int ifindex;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005095 char ifname[100];
5096 enum {
5097 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
5098 } ievent;
5099 } interface_status;
5100
5101 /**
5102 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
5103 */
5104 struct pmkid_candidate {
5105 /** BSSID of the PMKID candidate */
5106 u8 bssid[ETH_ALEN];
5107 /** Smaller the index, higher the priority */
5108 int index;
5109 /** Whether RSN IE includes pre-authenticate flag */
5110 int preauth;
5111 } pmkid_candidate;
5112
5113 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005114 * struct tdls - Data for EVENT_TDLS
5115 */
5116 struct tdls {
5117 u8 peer[ETH_ALEN];
5118 enum {
5119 TDLS_REQUEST_SETUP,
Dmitry Shmidt4dd28dc2015-03-10 11:21:43 -07005120 TDLS_REQUEST_TEARDOWN,
5121 TDLS_REQUEST_DISCOVER,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005122 } oper;
5123 u16 reason_code; /* for teardown */
5124 } tdls;
5125
5126 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07005127 * struct wnm - Data for EVENT_WNM
5128 */
5129 struct wnm {
5130 u8 addr[ETH_ALEN];
5131 enum {
5132 WNM_OPER_SLEEP,
5133 } oper;
5134 enum {
5135 WNM_SLEEP_ENTER,
5136 WNM_SLEEP_EXIT
5137 } sleep_action;
5138 int sleep_intval;
5139 u16 reason_code;
5140 u8 *buf;
5141 u16 buf_len;
5142 } wnm;
5143
5144 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005145 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
5146 *
5147 * During FT (IEEE 802.11r) authentication sequence, the driver is
5148 * expected to use this event to report received FT IEs (MDIE, FTIE,
5149 * RSN IE, TIE, possible resource request) to the supplicant. The FT
5150 * IEs for the next message will be delivered through the
5151 * struct wpa_driver_ops::update_ft_ies() callback.
5152 */
5153 struct ft_ies {
5154 const u8 *ies;
5155 size_t ies_len;
5156 int ft_action;
5157 u8 target_ap[ETH_ALEN];
5158 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
5159 const u8 *ric_ies;
5160 /** Length of ric_ies buffer in octets */
5161 size_t ric_ies_len;
5162 } ft_ies;
5163
5164 /**
5165 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
5166 */
5167 struct ibss_rsn_start {
5168 u8 peer[ETH_ALEN];
5169 } ibss_rsn_start;
5170
5171 /**
5172 * struct auth_info - Data for EVENT_AUTH events
5173 */
5174 struct auth_info {
5175 u8 peer[ETH_ALEN];
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005176 u8 bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005177 u16 auth_type;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005178 u16 auth_transaction;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005179 u16 status_code;
5180 const u8 *ies;
5181 size_t ies_len;
5182 } auth;
5183
5184 /**
5185 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
5186 */
5187 struct assoc_reject {
5188 /**
5189 * bssid - BSSID of the AP that rejected association
5190 */
5191 const u8 *bssid;
5192
5193 /**
5194 * resp_ies - (Re)Association Response IEs
5195 *
5196 * Optional association data from the driver. This data is not
5197 * required WPA, but may be useful for some protocols and as
5198 * such, should be reported if this is available to the driver
5199 * interface.
5200 *
5201 * This should start with the first IE (fixed fields before IEs
5202 * are not included).
5203 */
5204 const u8 *resp_ies;
5205
5206 /**
5207 * resp_ies_len - Length of resp_ies in bytes
5208 */
5209 size_t resp_ies_len;
5210
5211 /**
5212 * status_code - Status Code from (Re)association Response
5213 */
5214 u16 status_code;
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07005215
5216 /**
5217 * timed_out - Whether failure is due to timeout (etc.) rather
5218 * than explicit rejection response from the AP.
5219 */
5220 int timed_out;
Dmitry Shmidtebd93af2017-02-21 13:40:44 -08005221
5222 /**
5223 * timeout_reason - Reason for the timeout
5224 */
5225 const char *timeout_reason;
Dmitry Shmidtd2986c22017-10-23 14:22:09 -07005226
5227 /**
5228 * fils_erp_next_seq_num - The next sequence number to use in
5229 * FILS ERP messages
5230 */
5231 u16 fils_erp_next_seq_num;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005232 } assoc_reject;
5233
5234 struct timeout_event {
5235 u8 addr[ETH_ALEN];
5236 } timeout_event;
5237
5238 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005239 * struct tx_status - Data for EVENT_TX_STATUS events
5240 */
5241 struct tx_status {
5242 u16 type;
5243 u16 stype;
5244 const u8 *dst;
5245 const u8 *data;
5246 size_t data_len;
5247 int ack;
5248 } tx_status;
5249
5250 /**
5251 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
5252 */
5253 struct rx_from_unknown {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005254 const u8 *bssid;
5255 const u8 *addr;
5256 int wds;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005257 } rx_from_unknown;
5258
5259 /**
5260 * struct rx_mgmt - Data for EVENT_RX_MGMT events
5261 */
5262 struct rx_mgmt {
5263 const u8 *frame;
5264 size_t frame_len;
5265 u32 datarate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005266
5267 /**
Dmitry Shmidt98660862014-03-11 17:26:21 -07005268 * drv_priv - Pointer to store driver private BSS information
5269 *
5270 * If not set to NULL, this is used for comparison with
5271 * hostapd_data->drv_priv to determine which BSS should process
5272 * the frame.
5273 */
5274 void *drv_priv;
5275
5276 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005277 * freq - Frequency (in MHz) on which the frame was received
5278 */
5279 int freq;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005280
5281 /**
5282 * ssi_signal - Signal strength in dBm (or 0 if not available)
5283 */
5284 int ssi_signal;
5285 } rx_mgmt;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005286
5287 /**
5288 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
5289 *
5290 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
5291 */
5292 struct remain_on_channel {
5293 /**
5294 * freq - Channel frequency in MHz
5295 */
5296 unsigned int freq;
5297
5298 /**
5299 * duration - Duration to remain on the channel in milliseconds
5300 */
5301 unsigned int duration;
5302 } remain_on_channel;
5303
5304 /**
5305 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
5306 * @aborted: Whether the scan was aborted
5307 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
5308 * @num_freqs: Number of entries in freqs array
5309 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
5310 * SSID)
5311 * @num_ssids: Number of entries in ssids array
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08005312 * @external_scan: Whether the scan info is for an external scan
5313 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
5314 * 0 if the source of the scan event is a vendor scan
Dmitry Shmidt29333592017-01-09 12:27:11 -08005315 * @scan_start_tsf: Time when the scan started in terms of TSF of the
5316 * BSS that the interface that requested the scan is connected to
5317 * (if available).
5318 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
5319 * is set.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005320 */
5321 struct scan_info {
5322 int aborted;
5323 const int *freqs;
5324 size_t num_freqs;
5325 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
5326 size_t num_ssids;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08005327 int external_scan;
5328 int nl_scan_event;
Dmitry Shmidt29333592017-01-09 12:27:11 -08005329 u64 scan_start_tsf;
5330 u8 scan_start_tsf_bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005331 } scan_info;
5332
5333 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005334 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
5335 */
5336 struct rx_probe_req {
5337 /**
5338 * sa - Source address of the received Probe Request frame
5339 */
5340 const u8 *sa;
5341
5342 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005343 * da - Destination address of the received Probe Request frame
5344 * or %NULL if not available
5345 */
5346 const u8 *da;
5347
5348 /**
5349 * bssid - BSSID of the received Probe Request frame or %NULL
5350 * if not available
5351 */
5352 const u8 *bssid;
5353
5354 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005355 * ie - IEs from the Probe Request body
5356 */
5357 const u8 *ie;
5358
5359 /**
5360 * ie_len - Length of ie buffer in octets
5361 */
5362 size_t ie_len;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005363
5364 /**
5365 * signal - signal strength in dBm (or 0 if not available)
5366 */
5367 int ssi_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005368 } rx_probe_req;
5369
5370 /**
5371 * struct new_sta - Data for EVENT_NEW_STA events
5372 */
5373 struct new_sta {
5374 const u8 *addr;
5375 } new_sta;
5376
5377 /**
5378 * struct eapol_rx - Data for EVENT_EAPOL_RX events
5379 */
5380 struct eapol_rx {
5381 const u8 *src;
5382 const u8 *data;
5383 size_t data_len;
5384 } eapol_rx;
5385
5386 /**
5387 * signal_change - Data for EVENT_SIGNAL_CHANGE events
5388 */
5389 struct wpa_signal_info signal_change;
5390
5391 /**
5392 * struct best_channel - Data for EVENT_BEST_CHANNEL events
5393 * @freq_24: Best 2.4 GHz band channel frequency in MHz
5394 * @freq_5: Best 5 GHz band channel frequency in MHz
5395 * @freq_overall: Best channel frequency in MHz
5396 *
5397 * 0 can be used to indicate no preference in either band.
5398 */
5399 struct best_channel {
5400 int freq_24;
5401 int freq_5;
5402 int freq_overall;
5403 } best_chan;
5404
5405 struct unprot_deauth {
5406 const u8 *sa;
5407 const u8 *da;
5408 u16 reason_code;
5409 } unprot_deauth;
5410
5411 struct unprot_disassoc {
5412 const u8 *sa;
5413 const u8 *da;
5414 u16 reason_code;
5415 } unprot_disassoc;
5416
5417 /**
5418 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
5419 * @addr: station address
Paul Stewart092955c2017-02-06 09:13:09 -08005420 * @num_packets: Number of packets lost (consecutive packets not
5421 * acknowledged)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005422 */
5423 struct low_ack {
5424 u8 addr[ETH_ALEN];
Paul Stewart092955c2017-02-06 09:13:09 -08005425 u32 num_packets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005426 } low_ack;
5427
5428 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005429 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
5430 */
5431 struct ibss_peer_lost {
5432 u8 peer[ETH_ALEN];
5433 } ibss_peer_lost;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005434
5435 /**
5436 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
5437 */
5438 struct driver_gtk_rekey {
5439 const u8 *bssid;
5440 const u8 *replay_ctr;
5441 } driver_gtk_rekey;
5442
5443 /**
5444 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
5445 * @addr: station address
5446 */
5447 struct client_poll {
5448 u8 addr[ETH_ALEN];
5449 } client_poll;
5450
5451 /**
5452 * struct eapol_tx_status
5453 * @dst: Original destination
5454 * @data: Data starting with IEEE 802.1X header (!)
5455 * @data_len: Length of data
5456 * @ack: Indicates ack or lost frame
5457 *
5458 * This corresponds to hapd_send_eapol if the frame sent
5459 * there isn't just reported as EVENT_TX_STATUS.
5460 */
5461 struct eapol_tx_status {
5462 const u8 *dst;
5463 const u8 *data;
5464 int data_len;
5465 int ack;
5466 } eapol_tx_status;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005467
5468 /**
5469 * struct ch_switch
5470 * @freq: Frequency of new channel in MHz
5471 * @ht_enabled: Whether this is an HT channel
5472 * @ch_offset: Secondary channel offset
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08005473 * @ch_width: Channel width
5474 * @cf1: Center frequency 1
5475 * @cf2: Center frequency 2
Dmitry Shmidt04949592012-07-19 12:16:46 -07005476 */
5477 struct ch_switch {
5478 int freq;
5479 int ht_enabled;
5480 int ch_offset;
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08005481 enum chan_width ch_width;
5482 int cf1;
5483 int cf2;
Dmitry Shmidt04949592012-07-19 12:16:46 -07005484 } ch_switch;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08005485
5486 /**
5487 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
5488 * @addr: Remote client address
5489 * @code: Reason code for connection failure
5490 */
5491 struct connect_failed_reason {
5492 u8 addr[ETH_ALEN];
5493 enum {
5494 MAX_CLIENT_REACHED,
5495 BLOCKED_CLIENT
5496 } code;
5497 } connect_failed_reason;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005498
5499 /**
5500 * struct dfs_event - Data for radar detected events
5501 * @freq: Frequency of the channel in MHz
5502 */
5503 struct dfs_event {
5504 int freq;
Dmitry Shmidt051af732013-10-22 13:52:46 -07005505 int ht_enabled;
5506 int chan_offset;
5507 enum chan_width chan_width;
5508 int cf1;
5509 int cf2;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07005510 } dfs_event;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005511
5512 /**
5513 * survey_results - Survey result data for EVENT_SURVEY
5514 * @freq_filter: Requested frequency survey filter, 0 if request
5515 * was for all survey data
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005516 * @survey_list: Linked list of survey data (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07005517 */
5518 struct survey_results {
5519 unsigned int freq_filter;
5520 struct dl_list survey_list; /* struct freq_survey */
5521 } survey_results;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005522
5523 /**
5524 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
5525 * @initiator: Initiator of the regulatory change
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07005526 * @type: Regulatory change type
5527 * @alpha2: Country code (or "" if not available)
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005528 */
5529 struct channel_list_changed {
5530 enum reg_change_initiator initiator;
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07005531 enum reg_type type;
5532 char alpha2[3];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08005533 } channel_list_changed;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08005534
5535 /**
5536 * freq_range - List of frequency ranges
5537 *
5538 * This is used as the data with EVENT_AVOID_FREQUENCIES.
5539 */
5540 struct wpa_freq_range_list freq_range;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005541
5542 /**
5543 * struct mesh_peer
5544 *
5545 * @peer: Peer address
5546 * @ies: Beacon IEs
5547 * @ie_len: Length of @ies
5548 *
5549 * Notification of new candidate mesh peer.
5550 */
5551 struct mesh_peer {
5552 const u8 *peer;
5553 const u8 *ies;
5554 size_t ie_len;
5555 } mesh_peer;
5556
5557 /**
5558 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
5559 * @pri_channel: Selected primary channel
5560 * @sec_channel: Selected secondary channel
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005561 * @vht_seg0_center_ch: VHT mode Segment0 center channel
5562 * @vht_seg1_center_ch: VHT mode Segment1 center channel
5563 * @ch_width: Selected Channel width by driver. Driver may choose to
5564 * change hostapd configured ACS channel width due driver internal
5565 * channel restrictions.
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07005566 * hw_mode: Selected band (used with hw_mode=any)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005567 */
5568 struct acs_selected_channels {
5569 u8 pri_channel;
5570 u8 sec_channel;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07005571 u8 vht_seg0_center_ch;
5572 u8 vht_seg1_center_ch;
5573 u16 ch_width;
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07005574 enum hostapd_hw_mode hw_mode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005575 } acs_selected_channels;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005576
5577 /**
5578 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
5579 * @reason_code: Reason for stopping offload
5580 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
5581 * scheduled.
5582 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
5583 * be stopped.
5584 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
5585 * parameters.
5586 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
5587 * supported by device.
5588 */
5589 struct p2p_lo_stop {
5590 enum {
5591 P2P_LO_STOPPED_REASON_COMPLETE = 0,
5592 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
5593 P2P_LO_STOPPED_REASON_INVALID_PARAM,
5594 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
5595 } reason_code;
5596 } p2p_lo_stop;
Roshan Pius3a1667e2018-07-03 15:17:14 -07005597
5598 /* For EVENT_EXTERNAL_AUTH */
5599 struct external_auth external_auth;
5600
5601 /**
5602 * struct sta_opmode - Station's operation mode change event
5603 * @addr: The station MAC address
5604 * @smps_mode: SMPS mode of the station
5605 * @chan_width: Channel width of the station
5606 * @rx_nss: RX_NSS of the station
5607 *
5608 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
5609 */
5610 struct sta_opmode {
5611 const u8 *addr;
5612 enum smps_mode smps_mode;
5613 enum chan_width chan_width;
5614 u8 rx_nss;
5615 } sta_opmode;
5616
5617 /**
5618 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
5619 */
5620 struct wds_sta_interface {
5621 const u8 *sta_addr;
5622 const char *ifname;
5623 enum {
5624 INTERFACE_ADDED,
5625 INTERFACE_REMOVED
5626 } istatus;
5627 } wds_sta_interface;
Hai Shalom81f62d82019-07-22 12:10:00 -07005628
5629 /**
5630 * struct update_dh - Data for EVENT_UPDATE_DH
5631 */
5632 struct update_dh {
5633 const u8 *peer;
5634 const u8 *ie;
5635 size_t ie_len;
5636 } update_dh;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005637};
5638
5639/**
5640 * wpa_supplicant_event - Report a driver event for wpa_supplicant
5641 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5642 * with struct wpa_driver_ops::init()
5643 * @event: event type (defined above)
5644 * @data: possible extra data for the event
5645 *
5646 * Driver wrapper code should call this function whenever an event is received
5647 * from the driver.
5648 */
5649void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
5650 union wpa_event_data *data);
5651
Dmitry Shmidte4663042016-04-04 10:07:49 -07005652/**
5653 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
5654 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5655 * with struct wpa_driver_ops::init()
5656 * @event: event type (defined above)
5657 * @data: possible extra data for the event
5658 *
5659 * Same as wpa_supplicant_event(), but we search for the interface in
5660 * wpa_global.
5661 */
5662void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
5663 union wpa_event_data *data);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005664
5665/*
5666 * The following inline functions are provided for convenience to simplify
5667 * event indication for some of the common events.
5668 */
5669
5670static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
5671 size_t ielen, int reassoc)
5672{
5673 union wpa_event_data event;
5674 os_memset(&event, 0, sizeof(event));
5675 event.assoc_info.reassoc = reassoc;
5676 event.assoc_info.req_ies = ie;
5677 event.assoc_info.req_ies_len = ielen;
5678 event.assoc_info.addr = addr;
5679 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
5680}
5681
5682static inline void drv_event_disassoc(void *ctx, const u8 *addr)
5683{
5684 union wpa_event_data event;
5685 os_memset(&event, 0, sizeof(event));
5686 event.disassoc_info.addr = addr;
5687 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
5688}
5689
5690static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
5691 size_t data_len)
5692{
5693 union wpa_event_data event;
5694 os_memset(&event, 0, sizeof(event));
5695 event.eapol_rx.src = src;
5696 event.eapol_rx.data = data;
5697 event.eapol_rx.data_len = data_len;
5698 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
5699}
5700
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005701/* driver_common.c */
5702void wpa_scan_results_free(struct wpa_scan_results *res);
5703
5704/* Convert wpa_event_type to a string for logging */
5705const char * event_to_string(enum wpa_event_type event);
5706
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07005707/* Convert chan_width to a string for logging and control interfaces */
5708const char * channel_width_to_string(enum chan_width width);
5709
Hai Shalom74f70d42019-02-11 14:42:39 -08005710int channel_width_to_int(enum chan_width width);
5711
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005712int ht_supported(const struct hostapd_hw_modes *mode);
5713int vht_supported(const struct hostapd_hw_modes *mode);
5714
5715struct wowlan_triggers *
5716wpa_get_wowlan_triggers(const char *wowlan_triggers,
5717 const struct wpa_driver_capa *capa);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005718/* Convert driver flag to string */
5719const char * driver_flag_to_string(u64 flag);
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005720
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005721/* NULL terminated array of linked in driver wrappers */
Dmitry Shmidt1d755d02015-04-28 10:34:29 -07005722extern const struct wpa_driver_ops *const wpa_drivers[];
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005723
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07005724
5725/* Available drivers */
5726
5727#ifdef CONFIG_DRIVER_WEXT
5728extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
5729#endif /* CONFIG_DRIVER_WEXT */
5730#ifdef CONFIG_DRIVER_NL80211
5731/* driver_nl80211.c */
5732extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
5733#endif /* CONFIG_DRIVER_NL80211 */
5734#ifdef CONFIG_DRIVER_HOSTAP
5735extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
5736#endif /* CONFIG_DRIVER_HOSTAP */
5737#ifdef CONFIG_DRIVER_BSD
5738extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
5739#endif /* CONFIG_DRIVER_BSD */
5740#ifdef CONFIG_DRIVER_OPENBSD
5741/* driver_openbsd.c */
5742extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
5743#endif /* CONFIG_DRIVER_OPENBSD */
5744#ifdef CONFIG_DRIVER_NDIS
5745extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
5746#endif /* CONFIG_DRIVER_NDIS */
5747#ifdef CONFIG_DRIVER_WIRED
5748extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
5749#endif /* CONFIG_DRIVER_WIRED */
5750#ifdef CONFIG_DRIVER_MACSEC_QCA
5751/* driver_macsec_qca.c */
5752extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
5753#endif /* CONFIG_DRIVER_MACSEC_QCA */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08005754#ifdef CONFIG_DRIVER_MACSEC_LINUX
5755/* driver_macsec_linux.c */
5756extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops;
5757#endif /* CONFIG_DRIVER_MACSEC_LINUX */
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07005758#ifdef CONFIG_DRIVER_ROBOSWITCH
5759/* driver_roboswitch.c */
5760extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
5761#endif /* CONFIG_DRIVER_ROBOSWITCH */
5762#ifdef CONFIG_DRIVER_ATHEROS
5763/* driver_atheros.c */
5764extern const struct wpa_driver_ops wpa_driver_atheros_ops;
5765#endif /* CONFIG_DRIVER_ATHEROS */
5766#ifdef CONFIG_DRIVER_NONE
5767extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
5768#endif /* CONFIG_DRIVER_NONE */
5769
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005770#endif /* DRIVER_H */