blob: 291d4d6efb950936da8ecd08a71927bae5ea2cd5 [file] [log] [blame]
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001/*
2 * Driver interface definition
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003 * Copyright (c) 2003-2015, 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 Shmidt9839ecd2016-11-07 11:05:47 -080024#ifdef CONFIG_MACSEC
25#include "pae/ieee802_1x_kay.h"
26#endif /* CONFIG_MACSEC */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -070027#include "utils/list.h"
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070028
29#define HOSTAPD_CHAN_DISABLED 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080030#define HOSTAPD_CHAN_NO_IR 0x00000002
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070031#define HOSTAPD_CHAN_RADAR 0x00000008
32#define HOSTAPD_CHAN_HT40PLUS 0x00000010
33#define HOSTAPD_CHAN_HT40MINUS 0x00000020
34#define HOSTAPD_CHAN_HT40 0x00000040
Dmitry Shmidt391c59f2013-09-03 12:16:28 -070035#define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070036
Dmitry Shmidtea69e842013-05-13 14:52:28 -070037#define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
38#define HOSTAPD_CHAN_DFS_USABLE 0x00000100
39#define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
40#define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
41#define HOSTAPD_CHAN_DFS_MASK 0x00000300
42
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -070043#define HOSTAPD_CHAN_VHT_10_70 0x00000800
44#define HOSTAPD_CHAN_VHT_30_50 0x00001000
45#define HOSTAPD_CHAN_VHT_50_30 0x00002000
46#define HOSTAPD_CHAN_VHT_70_10 0x00004000
47
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080048#define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
49#define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
50
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -080051#define HOSTAPD_CHAN_VHT_10_150 0x00100000
52#define HOSTAPD_CHAN_VHT_30_130 0x00200000
53#define HOSTAPD_CHAN_VHT_50_110 0x00400000
54#define HOSTAPD_CHAN_VHT_70_90 0x00800000
55#define HOSTAPD_CHAN_VHT_90_70 0x01000000
56#define HOSTAPD_CHAN_VHT_110_50 0x02000000
57#define HOSTAPD_CHAN_VHT_130_30 0x04000000
58#define HOSTAPD_CHAN_VHT_150_10 0x08000000
59
Dmitry Shmidt849734c2016-05-27 09:59:01 -070060/* Filter gratuitous ARP */
61#define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
62/* Filter unsolicited Neighbor Advertisement */
63#define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
64/* Filter unicast IP packets encrypted using the GTK */
65#define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)
66
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080067/**
68 * enum reg_change_initiator - Regulatory change initiator
69 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -080070enum reg_change_initiator {
71 REGDOM_SET_BY_CORE,
72 REGDOM_SET_BY_USER,
73 REGDOM_SET_BY_DRIVER,
74 REGDOM_SET_BY_COUNTRY_IE,
Dmitry Shmidt97672262014-02-03 13:02:54 -080075 REGDOM_BEACON_HINT,
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -080076};
77
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080078/**
79 * enum reg_type - Regulatory change types
80 */
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -070081enum reg_type {
82 REGDOM_TYPE_UNKNOWN,
83 REGDOM_TYPE_COUNTRY,
84 REGDOM_TYPE_WORLD,
85 REGDOM_TYPE_CUSTOM_WORLD,
86 REGDOM_TYPE_INTERSECTION,
87};
88
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070089/**
90 * struct hostapd_channel_data - Channel information
91 */
92struct hostapd_channel_data {
93 /**
94 * chan - Channel number (IEEE 802.11)
95 */
96 short chan;
97
98 /**
99 * freq - Frequency in MHz
100 */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800101 int freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700102
103 /**
104 * flag - Channel flags (HOSTAPD_CHAN_*)
105 */
106 int flag;
107
108 /**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -0700109 * max_tx_power - Regulatory transmit power limit in dBm
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700110 */
111 u8 max_tx_power;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -0700112
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800113 /**
114 * survey_list - Linked list of surveys (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -0700115 */
116 struct dl_list survey_list;
117
118 /**
119 * min_nf - Minimum observed noise floor, in dBm, based on all
120 * surveyed channel data
121 */
122 s8 min_nf;
Dmitry Shmidt391c59f2013-09-03 12:16:28 -0700123
124#ifdef CONFIG_ACS
125 /**
126 * interference_factor - Computed interference factor on this
127 * channel (used internally in src/ap/acs.c; driver wrappers do not
128 * need to set this)
129 */
130 long double interference_factor;
131#endif /* CONFIG_ACS */
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -0700132
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800133 /**
134 * dfs_cac_ms - DFS CAC time in milliseconds
135 */
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -0700136 unsigned int dfs_cac_ms;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700137};
138
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800139#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -0700140#define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800141
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700142/**
143 * struct hostapd_hw_modes - Supported hardware mode information
144 */
145struct hostapd_hw_modes {
146 /**
147 * mode - Hardware mode
148 */
149 enum hostapd_hw_mode mode;
150
151 /**
152 * num_channels - Number of entries in the channels array
153 */
154 int num_channels;
155
156 /**
157 * channels - Array of supported channels
158 */
159 struct hostapd_channel_data *channels;
160
161 /**
162 * num_rates - Number of entries in the rates array
163 */
164 int num_rates;
165
166 /**
167 * rates - Array of supported rates in 100 kbps units
168 */
169 int *rates;
170
171 /**
172 * ht_capab - HT (IEEE 802.11n) capabilities
173 */
174 u16 ht_capab;
175
176 /**
177 * mcs_set - MCS (IEEE 802.11n) rate parameters
178 */
179 u8 mcs_set[16];
180
181 /**
182 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
183 */
184 u8 a_mpdu_params;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800185
Dmitry Shmidt04949592012-07-19 12:16:46 -0700186 /**
187 * vht_capab - VHT (IEEE 802.11ac) capabilities
188 */
189 u32 vht_capab;
190
191 /**
192 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
193 */
194 u8 vht_mcs_set[8];
195
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800196 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700197};
198
199
200#define IEEE80211_MODE_INFRA 0
201#define IEEE80211_MODE_IBSS 1
202#define IEEE80211_MODE_AP 2
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800203#define IEEE80211_MODE_MESH 5
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700204
205#define IEEE80211_CAP_ESS 0x0001
206#define IEEE80211_CAP_IBSS 0x0002
207#define IEEE80211_CAP_PRIVACY 0x0010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800208#define IEEE80211_CAP_RRM 0x1000
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700209
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800210/* DMG (60 GHz) IEEE 802.11ad */
211/* type - bits 0..1 */
212#define IEEE80211_CAP_DMG_MASK 0x0003
213#define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
214#define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
215#define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
216
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700217#define WPA_SCAN_QUAL_INVALID BIT(0)
218#define WPA_SCAN_NOISE_INVALID BIT(1)
219#define WPA_SCAN_LEVEL_INVALID BIT(2)
220#define WPA_SCAN_LEVEL_DBM BIT(3)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700221#define WPA_SCAN_ASSOCIATED BIT(5)
222
223/**
224 * struct wpa_scan_res - Scan result for an BSS/IBSS
225 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
226 * @bssid: BSSID
227 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
228 * @beacon_int: beacon interval in TUs (host byte order)
229 * @caps: capability information field in host byte order
230 * @qual: signal quality
231 * @noise: noise level
232 * @level: signal level
233 * @tsf: Timestamp
234 * @age: Age of the information in milliseconds (i.e., how many milliseconds
235 * ago the last Beacon or Probe Response frame was received)
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800236 * @est_throughput: Estimated throughput in kbps (this is calculated during
237 * scan result processing if left zero by the driver wrapper)
238 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
Dmitry Shmidt29333592017-01-09 12:27:11 -0800239 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
240 * of TSF of the BSS specified by %tsf_bssid.
241 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700242 * @ie_len: length of the following IE field in octets
243 * @beacon_ie_len: length of the following Beacon IE field in octets
244 *
245 * This structure is used as a generic format for scan results from the
246 * driver. Each driver interface implementation is responsible for converting
247 * the driver or OS specific scan results into this format.
248 *
249 * If the driver does not support reporting all IEs, the IE data structure is
250 * constructed of the IEs that are available. This field will also need to
251 * include SSID in IE format. All drivers are encouraged to be extended to
252 * report all IEs to make it easier to support future additions.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800253 *
254 * This structure data is followed by ie_len octets of IEs from Probe Response
255 * frame (or if the driver does not indicate source of IEs, these may also be
256 * from Beacon frame). After the first set of IEs, another set of IEs may follow
257 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700258 */
259struct wpa_scan_res {
260 unsigned int flags;
261 u8 bssid[ETH_ALEN];
262 int freq;
263 u16 beacon_int;
264 u16 caps;
265 int qual;
266 int noise;
267 int level;
268 u64 tsf;
269 unsigned int age;
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800270 unsigned int est_throughput;
271 int snr;
Dmitry Shmidt29333592017-01-09 12:27:11 -0800272 u64 parent_tsf;
273 u8 tsf_bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700274 size_t ie_len;
275 size_t beacon_ie_len;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800276 /* Followed by ie_len + beacon_ie_len octets of IE data */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700277};
278
279/**
280 * struct wpa_scan_results - Scan results
281 * @res: Array of pointers to allocated variable length scan result entries
282 * @num: Number of entries in the scan result array
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800283 * @fetch_time: Time when the results were fetched from the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700284 */
285struct wpa_scan_results {
286 struct wpa_scan_res **res;
287 size_t num;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800288 struct os_reltime fetch_time;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700289};
290
291/**
292 * struct wpa_interface_info - Network interface information
293 * @next: Pointer to the next interface or NULL if this is the last one
294 * @ifname: Interface name that can be used with init() or init2()
295 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
296 * not available
297 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
298 * is not an allocated copy, i.e., get_interfaces() caller will not free
299 * this)
300 */
301struct wpa_interface_info {
302 struct wpa_interface_info *next;
303 char *ifname;
304 char *desc;
305 const char *drv_name;
306};
307
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800308#define WPAS_MAX_SCAN_SSIDS 16
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700309
310/**
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800311 * struct wpa_driver_scan_ssid - SSIDs to scan for
312 * @ssid - specific SSID to scan for (ProbeReq)
313 * %NULL or zero-length SSID is used to indicate active scan
314 * with wildcard SSID.
315 * @ssid_len - Length of the SSID in octets
316 */
317struct wpa_driver_scan_ssid {
318 const u8 *ssid;
319 size_t ssid_len;
320};
321
322/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700323 * struct wpa_driver_scan_params - Scan parameters
324 * Data for struct wpa_driver_ops::scan2().
325 */
326struct wpa_driver_scan_params {
327 /**
328 * ssids - SSIDs to scan for
329 */
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800330 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700331
332 /**
333 * num_ssids - Number of entries in ssids array
334 * Zero indicates a request for a passive scan.
335 */
336 size_t num_ssids;
337
338 /**
339 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
340 */
341 const u8 *extra_ies;
342
343 /**
344 * extra_ies_len - Length of extra_ies in octets
345 */
346 size_t extra_ies_len;
347
348 /**
349 * freqs - Array of frequencies to scan or %NULL for all frequencies
350 *
351 * The frequency is set in MHz. The array is zero-terminated.
352 */
353 int *freqs;
354
355 /**
356 * filter_ssids - Filter for reporting SSIDs
357 *
358 * This optional parameter can be used to request the driver wrapper to
359 * filter scan results to include only the specified SSIDs. %NULL
360 * indicates that no filtering is to be done. This can be used to
361 * reduce memory needs for scan results in environments that have large
362 * number of APs with different SSIDs.
363 *
364 * The driver wrapper is allowed to take this allocated buffer into its
365 * own use by setting the pointer to %NULL. In that case, the driver
366 * wrapper is responsible for freeing the buffer with os_free() once it
367 * is not needed anymore.
368 */
369 struct wpa_driver_scan_filter {
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -0700370 u8 ssid[SSID_MAX_LEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700371 size_t ssid_len;
372 } *filter_ssids;
373
374 /**
375 * num_filter_ssids - Number of entries in filter_ssids array
376 */
377 size_t num_filter_ssids;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800378
379 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700380 * filter_rssi - Filter by RSSI
381 *
382 * The driver may filter scan results in firmware to reduce host
383 * wakeups and thereby save power. Specify the RSSI threshold in s32
384 * dBm.
385 */
386 s32 filter_rssi;
387
388 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800389 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
390 *
391 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
392 * Mbps from the support rates element(s) in the Probe Request frames
393 * and not to transmit the frames at any of those rates.
394 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700395 unsigned int p2p_probe:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800396
397 /**
398 * only_new_results - Request driver to report only new results
399 *
400 * This is used to request the driver to report only BSSes that have
401 * been detected after this scan request has been started, i.e., to
402 * flush old cached BSS entries.
403 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700404 unsigned int only_new_results:1;
405
406 /**
407 * low_priority - Requests driver to use a lower scan priority
408 *
409 * This is used to request the driver to use a lower scan priority
410 * if it supports such a thing.
411 */
412 unsigned int low_priority:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800413
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800414 /**
415 * mac_addr_rand - Requests driver to randomize MAC address
416 */
417 unsigned int mac_addr_rand:1;
418
419 /**
420 * mac_addr - MAC address used with randomization. The address cannot be
421 * a multicast one, i.e., bit 0 of byte 0 should not be set.
422 */
423 const u8 *mac_addr;
424
425 /**
426 * mac_addr_mask - MAC address mask used with randomization.
427 *
428 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
429 * the mask should be taken as is from mac_addr. The mask should not
430 * allow the generation of a multicast address, i.e., bit 0 of byte 0
431 * must be set.
432 */
433 const u8 *mac_addr_mask;
434
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800435 /**
436 * sched_scan_plans - Scan plans for scheduled scan
437 *
438 * Each scan plan consists of the number of iterations to scan and the
439 * interval between scans. When a scan plan finishes (i.e., it was run
440 * for the specified number of iterations), the next scan plan is
441 * executed. The scan plans are executed in the order they appear in
442 * the array (lower index first). The last scan plan will run infinitely
443 * (until requested to stop), thus must not specify the number of
444 * iterations. All other scan plans must specify the number of
445 * iterations.
446 */
447 struct sched_scan_plan {
448 u32 interval; /* In seconds */
449 u32 iterations; /* Zero to run infinitely */
450 } *sched_scan_plans;
451
452 /**
453 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
454 */
455 unsigned int sched_scan_plans_num;
456
Dmitry Shmidt9c175262016-03-03 10:20:07 -0800457 /**
458 * bssid - Specific BSSID to scan for
459 *
460 * This optional parameter can be used to replace the default wildcard
461 * BSSID with a specific BSSID to scan for if results are needed from
462 * only a single BSS.
463 */
464 const u8 *bssid;
465
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800466 /**
467 * scan_cookie - Unique identification representing the scan request
468 *
469 * This scan_cookie carries a unique identification representing the
470 * scan request if the host driver/kernel supports concurrent scan
471 * requests. This cookie is returned from the corresponding driver
472 * interface.
473 *
474 * Note: Unlike other parameters in this structure, scan_cookie is used
475 * only to return information instead of setting parameters for the
476 * scan.
477 */
478 u64 scan_cookie;
479
Dmitry Shmidt29333592017-01-09 12:27:11 -0800480 /**
481 * duration - Dwell time on each channel
482 *
483 * This optional parameter can be used to set the dwell time on each
484 * channel. In TUs.
485 */
486 u16 duration;
487
488 /**
489 * duration_mandatory - Whether the specified duration is mandatory
490 *
491 * If this is set, the duration specified by the %duration field is
492 * mandatory (and the driver should reject the scan request if it is
493 * unable to comply with the specified duration), otherwise it is the
494 * maximum duration and the actual duration may be shorter.
495 */
496 unsigned int duration_mandatory:1;
497
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800498 /*
499 * NOTE: Whenever adding new parameters here, please make sure
500 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
501 * matching changes.
502 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700503};
504
505/**
506 * struct wpa_driver_auth_params - Authentication parameters
507 * Data for struct wpa_driver_ops::authenticate().
508 */
509struct wpa_driver_auth_params {
510 int freq;
511 const u8 *bssid;
512 const u8 *ssid;
513 size_t ssid_len;
514 int auth_alg;
515 const u8 *ie;
516 size_t ie_len;
517 const u8 *wep_key[4];
518 size_t wep_key_len[4];
519 int wep_tx_keyidx;
520 int local_state_change;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800521
522 /**
523 * p2p - Whether this connection is a P2P group
524 */
525 int p2p;
526
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800527 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800528 * auth_data - Additional elements for Authentication frame
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800529 *
530 * This buffer starts with the Authentication transaction sequence
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800531 * number field. If no special handling of such elements is needed, this
532 * pointer is %NULL. This is used with SAE and FILS.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800533 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800534 const u8 *auth_data;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800535
536 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800537 * auth_data_len - Length of auth_data buffer in octets
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800538 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800539 size_t auth_data_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700540};
541
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800542/**
543 * enum wps_mode - WPS mode
544 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700545enum wps_mode {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800546 /**
547 * WPS_MODE_NONE - No WPS provisioning being used
548 */
549 WPS_MODE_NONE,
550
551 /**
552 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
553 */
554 WPS_MODE_OPEN,
555
556 /**
557 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
558 */
559 WPS_MODE_PRIVACY
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700560};
561
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800562/**
563 * struct hostapd_freq_params - Channel parameters
564 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700565struct hostapd_freq_params {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800566 /**
567 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
568 */
569 enum hostapd_hw_mode mode;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700570
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800571 /**
572 * freq - Primary channel center frequency in MHz
573 */
574 int freq;
575
576 /**
577 * channel - Channel number
578 */
579 int channel;
580
581 /**
582 * ht_enabled - Whether HT is enabled
583 */
584 int ht_enabled;
585
586 /**
587 * sec_channel_offset - Secondary channel offset for HT40
588 *
589 * 0 = HT40 disabled,
590 * -1 = HT40 enabled, secondary channel below primary,
591 * 1 = HT40 enabled, secondary channel above primary
592 */
593 int sec_channel_offset;
594
595 /**
596 * vht_enabled - Whether VHT is enabled
597 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700598 int vht_enabled;
599
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800600 /**
601 * center_freq1 - Segment 0 center frequency in MHz
602 *
603 * Valid for both HT and VHT.
604 */
605 int center_freq1;
606
607 /**
608 * center_freq2 - Segment 1 center frequency in MHz
609 *
610 * Non-zero only for bandwidth 80 and an 80+80 channel
611 */
612 int center_freq2;
613
614 /**
615 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
616 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700617 int bandwidth;
618};
619
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700620/**
621 * struct wpa_driver_associate_params - Association parameters
622 * Data for struct wpa_driver_ops::associate().
623 */
624struct wpa_driver_associate_params {
625 /**
626 * bssid - BSSID of the selected AP
627 * This can be %NULL, if ap_scan=2 mode is used and the driver is
628 * responsible for selecting with which BSS to associate. */
629 const u8 *bssid;
630
631 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800632 * bssid_hint - BSSID of a proposed AP
633 *
634 * This indicates which BSS has been found a suitable candidate for
635 * initial association for drivers that use driver/firmwate-based BSS
636 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
637 * the driver from selecting other BSSes in the ESS.
638 */
639 const u8 *bssid_hint;
640
641 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700642 * ssid - The selected SSID
643 */
644 const u8 *ssid;
645
646 /**
647 * ssid_len - Length of the SSID (1..32)
648 */
649 size_t ssid_len;
650
651 /**
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700652 * freq - channel parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700653 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700654 struct hostapd_freq_params freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700655
656 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800657 * freq_hint - Frequency of the channel the proposed AP is using
658 *
659 * This provides a channel on which a suitable BSS has been found as a
660 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
661 * limit the driver from selecting other channels for
662 * driver/firmware-based BSS selection.
663 */
664 int freq_hint;
665
666 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700667 * bg_scan_period - Background scan period in seconds, 0 to disable
668 * background scan, or -1 to indicate no change to default driver
669 * configuration
670 */
671 int bg_scan_period;
672
673 /**
Dmitry Shmidt2ac5f602014-03-07 10:08:21 -0800674 * beacon_int - Beacon interval for IBSS or 0 to use driver default
675 */
676 int beacon_int;
677
678 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700679 * wpa_ie - WPA information element for (Re)Association Request
680 * WPA information element to be included in (Re)Association
681 * Request (including information element id and length). Use
682 * of this WPA IE is optional. If the driver generates the WPA
683 * IE, it can use pairwise_suite, group_suite, and
684 * key_mgmt_suite to select proper algorithms. In this case,
685 * the driver has to notify wpa_supplicant about the used WPA
686 * IE by generating an event that the interface code will
687 * convert into EVENT_ASSOCINFO data (see below).
688 *
689 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
690 * instead. The driver can determine which version is used by
691 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
692 * WPA2/RSN).
693 *
694 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
695 */
696 const u8 *wpa_ie;
697
698 /**
699 * wpa_ie_len - length of the wpa_ie
700 */
701 size_t wpa_ie_len;
702
703 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800704 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
705 */
706 unsigned int wpa_proto;
707
708 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800709 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700710 *
711 * This is usually ignored if @wpa_ie is used.
712 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800713 unsigned int pairwise_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700714
715 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800716 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700717 *
718 * This is usually ignored if @wpa_ie is used.
719 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800720 unsigned int group_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700721
722 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800723 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700724 *
725 * This is usually ignored if @wpa_ie is used.
726 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800727 unsigned int key_mgmt_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700728
729 /**
730 * auth_alg - Allowed authentication algorithms
731 * Bit field of WPA_AUTH_ALG_*
732 */
733 int auth_alg;
734
735 /**
736 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
737 */
738 int mode;
739
740 /**
741 * wep_key - WEP keys for static WEP configuration
742 */
743 const u8 *wep_key[4];
744
745 /**
746 * wep_key_len - WEP key length for static WEP configuration
747 */
748 size_t wep_key_len[4];
749
750 /**
751 * wep_tx_keyidx - WEP TX key index for static WEP configuration
752 */
753 int wep_tx_keyidx;
754
755 /**
756 * mgmt_frame_protection - IEEE 802.11w management frame protection
757 */
758 enum mfp_options mgmt_frame_protection;
759
760 /**
761 * ft_ies - IEEE 802.11r / FT information elements
762 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
763 * for fast transition, this parameter is set to include the IEs that
764 * are to be sent in the next FT Authentication Request message.
765 * update_ft_ies() handler is called to update the IEs for further
766 * FT messages in the sequence.
767 *
768 * The driver should use these IEs only if the target AP is advertising
769 * the same mobility domain as the one included in the MDIE here.
770 *
771 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
772 * AP after the initial association. These IEs can only be used if the
773 * target AP is advertising support for FT and is using the same MDIE
774 * and SSID as the current AP.
775 *
776 * The driver is responsible for reporting the FT IEs received from the
777 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
778 * type. update_ft_ies() handler will then be called with the FT IEs to
779 * include in the next frame in the authentication sequence.
780 */
781 const u8 *ft_ies;
782
783 /**
784 * ft_ies_len - Length of ft_ies in bytes
785 */
786 size_t ft_ies_len;
787
788 /**
789 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
790 *
791 * This value is provided to allow the driver interface easier access
792 * to the current mobility domain. This value is set to %NULL if no
793 * mobility domain is currently active.
794 */
795 const u8 *ft_md;
796
797 /**
798 * passphrase - RSN passphrase for PSK
799 *
800 * This value is made available only for WPA/WPA2-Personal (PSK) and
801 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
802 * the 8..63 character ASCII passphrase, if available. Please note that
803 * this can be %NULL if passphrase was not used to generate the PSK. In
804 * that case, the psk field must be used to fetch the PSK.
805 */
806 const char *passphrase;
807
808 /**
809 * psk - RSN PSK (alternative for passphrase for PSK)
810 *
811 * This value is made available only for WPA/WPA2-Personal (PSK) and
812 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
813 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
814 * be prepared to handle %NULL value as an error.
815 */
816 const u8 *psk;
817
818 /**
819 * drop_unencrypted - Enable/disable unencrypted frame filtering
820 *
821 * Configure the driver to drop all non-EAPOL frames (both receive and
822 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
823 * still be allowed for key negotiation.
824 */
825 int drop_unencrypted;
826
827 /**
828 * prev_bssid - Previously used BSSID in this ESS
829 *
830 * When not %NULL, this is a request to use reassociation instead of
831 * association.
832 */
833 const u8 *prev_bssid;
834
835 /**
836 * wps - WPS mode
837 *
838 * If the driver needs to do special configuration for WPS association,
839 * this variable provides more information on what type of association
840 * is being requested. Most drivers should not need ot use this.
841 */
842 enum wps_mode wps;
843
844 /**
845 * p2p - Whether this connection is a P2P group
846 */
847 int p2p;
848
849 /**
850 * uapsd - UAPSD parameters for the network
851 * -1 = do not change defaults
852 * AP mode: 1 = enabled, 0 = disabled
853 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
854 */
855 int uapsd;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800856
857 /**
858 * fixed_bssid - Whether to force this BSSID in IBSS mode
859 * 1 = Fix this BSSID and prevent merges.
860 * 0 = Do not fix BSSID.
861 */
862 int fixed_bssid;
863
864 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800865 * fixed_freq - Fix control channel in IBSS mode
866 * 0 = don't fix control channel (default)
867 * 1 = fix control channel; this prevents IBSS merging with another
868 * channel
869 */
870 int fixed_freq;
871
872 /**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800873 * disable_ht - Disable HT (IEEE 802.11n) for this connection
874 */
875 int disable_ht;
876
877 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800878 * htcaps - HT Capabilities over-rides
879 *
880 * Only bits set in the mask will be used, and not all values are used
881 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
882 *
883 * Pointer to struct ieee80211_ht_capabilities.
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800884 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800885 const u8 *htcaps;
886
887 /**
888 * htcaps_mask - HT Capabilities over-rides mask
889 *
890 * Pointer to struct ieee80211_ht_capabilities.
891 */
892 const u8 *htcaps_mask;
Dmitry Shmidt2f023192013-03-12 12:44:17 -0700893
894#ifdef CONFIG_VHT_OVERRIDES
895 /**
896 * disable_vht - Disable VHT for this connection
897 */
898 int disable_vht;
899
900 /**
901 * VHT capability overrides.
902 */
903 const struct ieee80211_vht_capabilities *vhtcaps;
904 const struct ieee80211_vht_capabilities *vhtcaps_mask;
905#endif /* CONFIG_VHT_OVERRIDES */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800906
907 /**
908 * req_key_mgmt_offload - Request key management offload for connection
909 *
910 * Request key management offload for this connection if the device
911 * supports it.
912 */
913 int req_key_mgmt_offload;
914
915 /**
916 * Flag for indicating whether this association includes support for
917 * RRM (Radio Resource Measurements)
918 */
919 int rrm_used;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800920
921 /**
922 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
923 * AP as usual. Valid for DMG network only.
924 */
925 int pbss;
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800926
927 /**
928 * fils_kek - KEK for FILS association frame protection (AES-SIV)
929 */
930 const u8 *fils_kek;
931
932 /**
933 * fils_kek_len: Length of fils_kek in bytes
934 */
935 size_t fils_kek_len;
936
937 /**
938 * fils_nonces - Nonces for FILS association frame protection
939 * (AES-SIV AAD)
940 */
941 const u8 *fils_nonces;
942
943 /**
944 * fils_nonces_len: Length of fils_nonce in bytes
945 */
946 size_t fils_nonces_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700947};
948
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800949enum hide_ssid {
950 NO_SSID_HIDING,
951 HIDDEN_SSID_ZERO_LEN,
952 HIDDEN_SSID_ZERO_CONTENTS
953};
954
Dmitry Shmidtb58836e2014-04-29 14:35:56 -0700955struct wowlan_triggers {
956 u8 any;
957 u8 disconnect;
958 u8 magic_pkt;
959 u8 gtk_rekey_failure;
960 u8 eap_identity_req;
961 u8 four_way_handshake;
962 u8 rfkill_release;
963};
964
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800965struct wpa_driver_ap_params {
966 /**
967 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
968 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -0800969 u8 *head;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800970
971 /**
972 * head_len - Length of the head buffer in octets
973 */
974 size_t head_len;
975
976 /**
977 * tail - Beacon tail following TIM IE
978 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -0800979 u8 *tail;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800980
981 /**
982 * tail_len - Length of the tail buffer in octets
983 */
984 size_t tail_len;
985
986 /**
987 * dtim_period - DTIM period
988 */
989 int dtim_period;
990
991 /**
992 * beacon_int - Beacon interval
993 */
994 int beacon_int;
995
996 /**
997 * basic_rates: -1 terminated array of basic rates in 100 kbps
998 *
999 * This parameter can be used to set a specific basic rate set for the
1000 * BSS. If %NULL, default basic rate set is used.
1001 */
1002 int *basic_rates;
1003
1004 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001005 * beacon_rate: Beacon frame data rate
1006 *
1007 * This parameter can be used to set a specific Beacon frame data rate
1008 * for the BSS. The interpretation of this value depends on the
1009 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS). If
1010 * beacon_rate == 0 and rate_type == 0 (BEACON_RATE_LEGACY), the default
1011 * Beacon frame data rate is used.
1012 */
1013 unsigned int beacon_rate;
1014
1015 /**
1016 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT)
1017 */
1018 enum beacon_rate_type rate_type;
1019
1020 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001021 * proberesp - Probe Response template
1022 *
1023 * This is used by drivers that reply to Probe Requests internally in
1024 * AP mode and require the full Probe Response template.
1025 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001026 u8 *proberesp;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001027
1028 /**
1029 * proberesp_len - Length of the proberesp buffer in octets
1030 */
1031 size_t proberesp_len;
1032
1033 /**
1034 * ssid - The SSID to use in Beacon/Probe Response frames
1035 */
1036 const u8 *ssid;
1037
1038 /**
1039 * ssid_len - Length of the SSID (1..32)
1040 */
1041 size_t ssid_len;
1042
1043 /**
1044 * hide_ssid - Whether to hide the SSID
1045 */
1046 enum hide_ssid hide_ssid;
1047
1048 /**
1049 * pairwise_ciphers - WPA_CIPHER_* bitfield
1050 */
1051 unsigned int pairwise_ciphers;
1052
1053 /**
1054 * group_cipher - WPA_CIPHER_*
1055 */
1056 unsigned int group_cipher;
1057
1058 /**
1059 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1060 */
1061 unsigned int key_mgmt_suites;
1062
1063 /**
1064 * auth_algs - WPA_AUTH_ALG_* bitfield
1065 */
1066 unsigned int auth_algs;
1067
1068 /**
1069 * wpa_version - WPA_PROTO_* bitfield
1070 */
1071 unsigned int wpa_version;
1072
1073 /**
1074 * privacy - Whether privacy is used in the BSS
1075 */
1076 int privacy;
1077
1078 /**
1079 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1080 *
1081 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1082 * not use the full Beacon template.
1083 */
1084 const struct wpabuf *beacon_ies;
1085
1086 /**
1087 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1088 *
1089 * This is used to add IEs like WPS IE and P2P IE by drivers that
1090 * reply to Probe Request frames internally.
1091 */
1092 const struct wpabuf *proberesp_ies;
1093
1094 /**
1095 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1096 *
1097 * This is used to add IEs like WPS IE by drivers that reply to
1098 * (Re)Association Request frames internally.
1099 */
1100 const struct wpabuf *assocresp_ies;
1101
1102 /**
1103 * isolate - Whether to isolate frames between associated stations
1104 *
1105 * If this is non-zero, the AP is requested to disable forwarding of
1106 * frames between associated stations.
1107 */
1108 int isolate;
1109
1110 /**
1111 * cts_protect - Whether CTS protection is enabled
1112 */
1113 int cts_protect;
1114
1115 /**
1116 * preamble - Whether short preamble is enabled
1117 */
1118 int preamble;
1119
1120 /**
1121 * short_slot_time - Whether short slot time is enabled
1122 *
1123 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1124 * not set (e.g., when 802.11g mode is not in use)
1125 */
1126 int short_slot_time;
1127
1128 /**
1129 * ht_opmode - HT operation mode or -1 if HT not in use
1130 */
1131 int ht_opmode;
1132
1133 /**
1134 * interworking - Whether Interworking is enabled
1135 */
1136 int interworking;
1137
1138 /**
1139 * hessid - Homogeneous ESS identifier or %NULL if not set
1140 */
1141 const u8 *hessid;
1142
1143 /**
1144 * access_network_type - Access Network Type (0..15)
1145 *
1146 * This is used for filtering Probe Request frames when Interworking is
1147 * enabled.
1148 */
1149 u8 access_network_type;
Dmitry Shmidt04949592012-07-19 12:16:46 -07001150
1151 /**
1152 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1153 *
1154 * This is used by driver which advertises this capability.
1155 */
1156 int ap_max_inactivity;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001157
1158 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001159 * ctwindow - Client Traffic Window (in TUs)
1160 */
1161 u8 p2p_go_ctwindow;
1162
1163 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001164 * smps_mode - SMPS mode
1165 *
1166 * SMPS mode to be used by the AP, specified as the relevant bits of
1167 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1168 */
1169 unsigned int smps_mode;
1170
1171 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001172 * disable_dgaf - Whether group-addressed frames are disabled
1173 */
1174 int disable_dgaf;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001175
1176 /**
1177 * osen - Whether OSEN security is enabled
1178 */
1179 int osen;
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001180
1181 /**
1182 * freq - Channel parameters for dynamic bandwidth changes
1183 */
1184 struct hostapd_freq_params *freq;
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001185
1186 /**
1187 * reenable - Whether this is to re-enable beaconing
1188 */
1189 int reenable;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001190
1191 /**
1192 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1193 * infrastructure BSS. Valid only for DMG network.
1194 */
1195 int pbss;
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001196
1197 /**
1198 * multicast_to_unicast - Whether to use multicast_to_unicast
1199 *
1200 * If this is non-zero, the AP is requested to perform multicast to
1201 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1202 * 802.1Q). If enabled, such frames are to be sent to each station
1203 * separately, with the DA replaced by their own MAC address rather
1204 * than the group address.
1205 *
1206 * Note that this may break certain expectations of the receiver, such
1207 * as the ability to drop unicast IP packets received within multicast
1208 * L2 frames, or the ability to not send ICMP destination unreachable
1209 * messages for packets received in L2 multicast (which is required,
1210 * but the receiver can't tell the difference if this new option is
1211 * enabled.)
1212 *
1213 * This also doesn't implement the 802.11 DMS (directed multicast
1214 * service).
1215 */
1216 int multicast_to_unicast;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001217};
1218
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001219struct wpa_driver_mesh_bss_params {
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001220#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1221#define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1222#define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1223#define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001224 /*
1225 * TODO: Other mesh configuration parameters would go here.
1226 * See NL80211_MESHCONF_* for all the mesh config parameters.
1227 */
1228 unsigned int flags;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001229 int auto_plinks;
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001230 int peer_link_timeout;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001231 int max_peer_links;
1232 u16 ht_opmode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001233};
1234
1235struct wpa_driver_mesh_join_params {
1236 const u8 *meshid;
1237 int meshid_len;
1238 const int *basic_rates;
1239 const u8 *ies;
1240 int ie_len;
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001241 struct hostapd_freq_params freq;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001242 int beacon_int;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001243 int dtim_period;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001244 struct wpa_driver_mesh_bss_params conf;
1245#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1246#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1247#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1248#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1249 unsigned int flags;
1250};
1251
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001252/**
1253 * struct wpa_driver_capa - Driver capability information
1254 */
1255struct wpa_driver_capa {
1256#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1257#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1258#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1259#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1260#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1261#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1262#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001263#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001264#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1265#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001266 /** Bitfield of supported key management suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001267 unsigned int key_mgmt;
1268
1269#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1270#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1271#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1272#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
Dmitry Shmidt04949592012-07-19 12:16:46 -07001273#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001274#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001275#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1276#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1277#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1278#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1279#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1280#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001281#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001282 /** Bitfield of supported cipher suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001283 unsigned int enc;
1284
1285#define WPA_DRIVER_AUTH_OPEN 0x00000001
1286#define WPA_DRIVER_AUTH_SHARED 0x00000002
1287#define WPA_DRIVER_AUTH_LEAP 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001288 /** Bitfield of supported IEEE 802.11 authentication algorithms */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001289 unsigned int auth;
1290
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001291/** Driver generated WPA/RSN IE */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001292#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001293/** Driver needs static WEP key setup after association command */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001294#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001295/** Driver takes care of all DFS operations */
Dmitry Shmidtd11f0192014-03-24 12:09:47 -07001296#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001297/** Driver takes care of RSN 4-way handshake internally; PMK is configured with
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001298 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1299#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001300/** Driver is for a wired Ethernet interface */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001301#define WPA_DRIVER_FLAGS_WIRED 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001302/** Driver provides separate commands for authentication and association (SME in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001303 * wpa_supplicant). */
1304#define WPA_DRIVER_FLAGS_SME 0x00000020
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001305/** Driver supports AP mode */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001306#define WPA_DRIVER_FLAGS_AP 0x00000040
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001307/** Driver needs static WEP key setup after association has been completed */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001308#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001309/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001310#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001311/** Driver supports concurrent P2P operations */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001312#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001313/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001314 * Driver uses the initial interface as a dedicated management interface, i.e.,
1315 * it cannot be used for P2P group operations or non-P2P purposes.
1316 */
1317#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001318/** This interface is P2P capable (P2P GO or P2P Client) */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001319#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001320/** Driver supports station and key removal when stopping an AP */
Dmitry Shmidta38abf92014-03-06 13:38:44 -08001321#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001322/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001323 * Driver uses the initial interface for P2P management interface and non-P2P
1324 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1325 * P2P group operations.
1326 */
1327#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001328/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001329 * Driver is known to use sane error codes, i.e., when it indicates that
1330 * something (e.g., association) fails, there was indeed a failure and the
1331 * operation does not end up getting completed successfully later.
1332 */
1333#define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001334/** Driver supports off-channel TX */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001335#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001336/** Driver indicates TX status events for EAPOL Data frames */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001337#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001338/** Driver indicates TX status events for Deauth/Disassoc frames */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001339#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001340/** Driver supports roaming (BSS selection) in firmware */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001341#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001342/** Driver supports operating as a TDLS peer */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001343#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001344/** Driver requires external TDLS setup/teardown/discovery */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001345#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001346/** Driver indicates support for Probe Response offloading in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001347#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001348/** Driver supports U-APSD in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001349#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001350/** Driver supports inactivity timer in AP mode */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001351#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001352/** Driver expects user space implementation of MLME in AP mode */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001353#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001354/** Driver supports SAE with user space SME */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001355#define WPA_DRIVER_FLAGS_SAE 0x02000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001356/** Driver makes use of OBSS scan mechanism in wpa_supplicant */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001357#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001358/** Driver supports IBSS (Ad-hoc) mode */
Dmitry Shmidt700a1372013-03-15 14:14:44 -07001359#define WPA_DRIVER_FLAGS_IBSS 0x08000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001360/** Driver supports radar detection */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07001361#define WPA_DRIVER_FLAGS_RADAR 0x10000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001362/** Driver supports a dedicated interface for P2P Device */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001363#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001364/** Driver supports QoS Mapping */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001365#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001366/** Driver supports CSA in AP mode */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001367#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001368/** Driver supports mesh */
1369#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1370/** Driver support ACS offload */
1371#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1372/** Driver supports key management offload */
1373#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1374/** Driver supports TDLS channel switching */
1375#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001376/** Driver supports IBSS with HT datarates */
1377#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001378/** Driver supports IBSS with VHT datarates */
1379#define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07001380/** Driver supports automatic band selection */
1381#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001382/** Driver supports simultaneous off-channel operations */
1383#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001384/** Driver supports full AP client state */
1385#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001386/** Driver supports P2P Listen offload */
1387#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001388/** Driver supports FILS */
1389#define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001390/** Driver supports Beacon frame TX rate configuration (legacy rates) */
1391#define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1392/** Driver supports Beacon frame TX rate configuration (HT rates) */
1393#define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1394/** Driver supports Beacon frame TX rate configuration (VHT rates) */
1395#define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001396 u64 flags;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001397
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001398#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1399 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1400
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001401#define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1402#define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1403 unsigned int smps_modes;
1404
1405 unsigned int wmm_ac_supported:1;
1406
1407 unsigned int mac_addr_rand_scan_supported:1;
1408 unsigned int mac_addr_rand_sched_scan_supported:1;
1409
1410 /** Maximum number of supported active probe SSIDs */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001411 int max_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001412
1413 /** Maximum number of supported active probe SSIDs for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001414 int max_sched_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001415
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08001416 /** Maximum number of supported scan plans for scheduled scan */
1417 unsigned int max_sched_scan_plans;
1418
1419 /** Maximum interval in a scan plan. In seconds */
1420 u32 max_sched_scan_plan_interval;
1421
1422 /** Maximum number of iterations in a single scan plan */
1423 u32 max_sched_scan_plan_iterations;
1424
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001425 /** Whether sched_scan (offloaded scanning) is supported */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001426 int sched_scan_supported;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001427
1428 /** Maximum number of supported match sets for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001429 int max_match_sets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001430
1431 /**
1432 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1433 */
1434 unsigned int max_remain_on_chan;
1435
1436 /**
1437 * max_stations - Maximum number of associated stations the driver
1438 * supports in AP mode
1439 */
1440 unsigned int max_stations;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001441
1442 /**
1443 * probe_resp_offloads - Bitmap of supported protocols by the driver
1444 * for Probe Response offloading.
1445 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001446/** Driver Probe Response offloading support for WPS ver. 1 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001447#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001448/** Driver Probe Response offloading support for WPS ver. 2 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001449#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001450/** Driver Probe Response offloading support for P2P */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001451#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001452/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001453#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1454 unsigned int probe_resp_offloads;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001455
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07001456 unsigned int max_acl_mac_addrs;
1457
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001458 /**
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07001459 * Number of supported concurrent channels
1460 */
1461 unsigned int num_multichan_concurrent;
1462
1463 /**
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001464 * extended_capa - extended capabilities in driver/device
1465 *
1466 * Must be allocated and freed by driver and the pointers must be
1467 * valid for the lifetime of the driver, i.e., freed in deinit()
1468 */
1469 const u8 *extended_capa, *extended_capa_mask;
1470 unsigned int extended_capa_len;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001471
1472 struct wowlan_triggers wowlan_triggers;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001473
1474/** Driver adds the DS Params Set IE in Probe Request frames */
1475#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1476/** Driver adds the WFA TPC IE in Probe Request frames */
1477#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1478/** Driver handles quiet period requests */
1479#define WPA_DRIVER_FLAGS_QUIET 0x00000004
1480/**
1481 * Driver is capable of inserting the current TX power value into the body of
1482 * transmitted frames.
1483 * Background: Some Action frames include a TPC Report IE. This IE contains a
1484 * TX power field, which has to be updated by lower layers. One such Action
1485 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1486 * of spectrum management). Note that this insertion takes place at a fixed
1487 * offset, namely the 6th byte in the Action frame body.
1488 */
1489#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001490/**
1491 * Driver supports RRM. With this support, the driver will accept to use RRM in
1492 * (Re)Association Request frames, without supporting quiet period.
1493 */
1494#define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1495
Dmitry Shmidt29333592017-01-09 12:27:11 -08001496/** Driver supports setting the scan dwell time */
1497#define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
1498/** Driver supports Beacon Report Measurement */
1499#define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
1500
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001501 u32 rrm_flags;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001502
1503 /* Driver concurrency capabilities */
1504 unsigned int conc_capab;
1505 /* Maximum number of concurrent channels on 2.4 GHz */
1506 unsigned int max_conc_chan_2_4;
1507 /* Maximum number of concurrent channels on 5 GHz */
1508 unsigned int max_conc_chan_5_0;
1509
1510 /* Maximum number of supported CSA counters */
1511 u16 max_csa_counters;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001512};
1513
1514
1515struct hostapd_data;
1516
1517struct hostap_sta_driver_data {
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001518 unsigned long rx_packets, tx_packets;
1519 unsigned long long rx_bytes, tx_bytes;
1520 int bytes_64bit; /* whether 64-bit byte counters are supported */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001521 unsigned long current_tx_rate;
1522 unsigned long inactive_msec;
1523 unsigned long flags;
1524 unsigned long num_ps_buf_frames;
1525 unsigned long tx_retry_failed;
1526 unsigned long tx_retry_count;
1527 int last_rssi;
1528 int last_ack_rssi;
1529};
1530
1531struct hostapd_sta_add_params {
1532 const u8 *addr;
1533 u16 aid;
1534 u16 capability;
1535 const u8 *supp_rates;
1536 size_t supp_rates_len;
1537 u16 listen_interval;
1538 const struct ieee80211_ht_capabilities *ht_capabilities;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001539 const struct ieee80211_vht_capabilities *vht_capabilities;
Dmitry Shmidtbd14a572014-02-18 10:33:49 -08001540 int vht_opmode_enabled;
1541 u8 vht_opmode;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001542 u32 flags; /* bitmask of WPA_STA_* flags */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001543 u32 flags_mask; /* unset bits in flags */
1544#ifdef CONFIG_MESH
1545 enum mesh_plink_state plink_state;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001546 u16 peer_aid;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001547#endif /* CONFIG_MESH */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001548 int set; /* Set STA parameters instead of add */
1549 u8 qosinfo;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08001550 const u8 *ext_capab;
1551 size_t ext_capab_len;
Dmitry Shmidt344abd32014-01-14 13:17:00 -08001552 const u8 *supp_channels;
1553 size_t supp_channels_len;
1554 const u8 *supp_oper_classes;
1555 size_t supp_oper_classes_len;
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001556 int support_p2p_ps;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001557};
1558
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07001559struct mac_address {
1560 u8 addr[ETH_ALEN];
1561};
1562
1563struct hostapd_acl_params {
1564 u8 acl_policy;
1565 unsigned int num_mac_acl;
1566 struct mac_address mac_acl[0];
1567};
1568
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001569enum wpa_driver_if_type {
1570 /**
1571 * WPA_IF_STATION - Station mode interface
1572 */
1573 WPA_IF_STATION,
1574
1575 /**
1576 * WPA_IF_AP_VLAN - AP mode VLAN interface
1577 *
1578 * This interface shares its address and Beacon frame with the main
1579 * BSS.
1580 */
1581 WPA_IF_AP_VLAN,
1582
1583 /**
1584 * WPA_IF_AP_BSS - AP mode BSS interface
1585 *
1586 * This interface has its own address and Beacon frame.
1587 */
1588 WPA_IF_AP_BSS,
1589
1590 /**
1591 * WPA_IF_P2P_GO - P2P Group Owner
1592 */
1593 WPA_IF_P2P_GO,
1594
1595 /**
1596 * WPA_IF_P2P_CLIENT - P2P Client
1597 */
1598 WPA_IF_P2P_CLIENT,
1599
1600 /**
1601 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1602 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1603 */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001604 WPA_IF_P2P_GROUP,
1605
1606 /**
1607 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1608 * abstracted P2P Device function in the driver
1609 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001610 WPA_IF_P2P_DEVICE,
1611
1612 /*
1613 * WPA_IF_MESH - Mesh interface
1614 */
1615 WPA_IF_MESH,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001616
1617 /*
1618 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1619 */
1620 WPA_IF_TDLS,
1621
1622 /*
1623 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1624 */
1625 WPA_IF_IBSS,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001626};
1627
1628struct wpa_init_params {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001629 void *global_priv;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001630 const u8 *bssid;
1631 const char *ifname;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001632 const char *driver_params;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001633 int use_pae_group_addr;
1634 char **bridge;
1635 size_t num_bridge;
1636
1637 u8 *own_addr; /* buffer for writing own MAC address */
1638};
1639
1640
1641struct wpa_bss_params {
1642 /** Interface name (for multi-SSID/VLAN support) */
1643 const char *ifname;
1644 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1645 int enabled;
1646
1647 int wpa;
1648 int ieee802_1x;
1649 int wpa_group;
1650 int wpa_pairwise;
1651 int wpa_key_mgmt;
1652 int rsn_preauth;
1653 enum mfp_options ieee80211w;
1654};
1655
1656#define WPA_STA_AUTHORIZED BIT(0)
1657#define WPA_STA_WMM BIT(1)
1658#define WPA_STA_SHORT_PREAMBLE BIT(2)
1659#define WPA_STA_MFP BIT(3)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001660#define WPA_STA_TDLS_PEER BIT(4)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001661#define WPA_STA_AUTHENTICATED BIT(5)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001662#define WPA_STA_ASSOCIATED BIT(6)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001663
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001664enum tdls_oper {
1665 TDLS_DISCOVERY_REQ,
1666 TDLS_SETUP,
1667 TDLS_TEARDOWN,
1668 TDLS_ENABLE_LINK,
1669 TDLS_DISABLE_LINK,
1670 TDLS_ENABLE,
1671 TDLS_DISABLE
1672};
1673
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001674enum wnm_oper {
1675 WNM_SLEEP_ENTER_CONFIRM,
1676 WNM_SLEEP_ENTER_FAIL,
1677 WNM_SLEEP_EXIT_CONFIRM,
1678 WNM_SLEEP_EXIT_FAIL,
1679 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1680 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1681 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1682 * a STA */
1683 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1684 * for a STA */
1685 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1686 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1687 * for a STA */
1688 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1689};
1690
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001691/* enum chan_width - Channel width definitions */
1692enum chan_width {
1693 CHAN_WIDTH_20_NOHT,
1694 CHAN_WIDTH_20,
1695 CHAN_WIDTH_40,
1696 CHAN_WIDTH_80,
1697 CHAN_WIDTH_80P80,
1698 CHAN_WIDTH_160,
1699 CHAN_WIDTH_UNKNOWN
1700};
1701
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001702/**
1703 * struct wpa_signal_info - Information about channel signal quality
1704 */
1705struct wpa_signal_info {
1706 u32 frequency;
1707 int above_threshold;
1708 int current_signal;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001709 int avg_signal;
Dmitry Shmidtf73259c2015-03-17 11:00:54 -07001710 int avg_beacon_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001711 int current_noise;
1712 int current_txrate;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001713 enum chan_width chanwidth;
1714 int center_frq1;
1715 int center_frq2;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001716};
1717
1718/**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001719 * struct beacon_data - Beacon data
1720 * @head: Head portion of Beacon frame (before TIM IE)
1721 * @tail: Tail portion of Beacon frame (after TIM IE)
1722 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1723 * @proberesp_ies: Extra information element(s) to add into Probe Response
1724 * frames or %NULL
1725 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1726 * Response frames or %NULL
1727 * @probe_resp: Probe Response frame template
1728 * @head_len: Length of @head
1729 * @tail_len: Length of @tail
1730 * @beacon_ies_len: Length of beacon_ies in octets
1731 * @proberesp_ies_len: Length of proberesp_ies in octets
1732 * @proberesp_ies_len: Length of proberesp_ies in octets
1733 * @probe_resp_len: Length of probe response template (@probe_resp)
1734 */
1735struct beacon_data {
1736 u8 *head, *tail;
1737 u8 *beacon_ies;
1738 u8 *proberesp_ies;
1739 u8 *assocresp_ies;
1740 u8 *probe_resp;
1741
1742 size_t head_len, tail_len;
1743 size_t beacon_ies_len;
1744 size_t proberesp_ies_len;
1745 size_t assocresp_ies_len;
1746 size_t probe_resp_len;
1747};
1748
1749/**
1750 * struct csa_settings - Settings for channel switch command
1751 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1752 * @block_tx: 1 - block transmission for CSA period
1753 * @freq_params: Next channel frequency parameter
1754 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1755 * @beacon_after: Next beacon/probe resp/asooc resp info
1756 * @counter_offset_beacon: Offset to the count field in beacon's tail
1757 * @counter_offset_presp: Offset to the count field in probe resp.
1758 */
1759struct csa_settings {
1760 u8 cs_count;
1761 u8 block_tx;
1762
1763 struct hostapd_freq_params freq_params;
1764 struct beacon_data beacon_csa;
1765 struct beacon_data beacon_after;
1766
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001767 u16 counter_offset_beacon[2];
1768 u16 counter_offset_presp[2];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001769};
1770
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07001771/* TDLS peer capabilities for send_tdls_mgmt() */
1772enum tdls_peer_capability {
1773 TDLS_PEER_HT = BIT(0),
1774 TDLS_PEER_VHT = BIT(1),
1775 TDLS_PEER_WMM = BIT(2),
1776};
1777
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001778/* valid info in the wmm_params struct */
1779enum wmm_params_valid_info {
1780 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1781};
1782
1783/**
1784 * struct wmm_params - WMM parameterss configured for this association
1785 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1786 * of the struct contain valid information.
1787 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1788 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1789 */
1790struct wmm_params {
1791 u8 info_bitmap;
1792 u8 uapsd_queues;
1793};
1794
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001795#ifdef CONFIG_MACSEC
1796struct macsec_init_params {
1797 Boolean always_include_sci;
1798 Boolean use_es;
1799 Boolean use_scb;
1800};
1801#endif /* CONFIG_MACSEC */
1802
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001803enum drv_br_port_attr {
1804 DRV_BR_PORT_ATTR_PROXYARP,
1805 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1806};
1807
1808enum drv_br_net_param {
1809 DRV_BR_NET_PARAM_GARP_ACCEPT,
Dmitry Shmidt83474442015-04-15 13:47:09 -07001810 DRV_BR_MULTICAST_SNOOPING,
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001811};
1812
1813struct drv_acs_params {
1814 /* Selected mode (HOSTAPD_MODE_*) */
1815 enum hostapd_hw_mode hw_mode;
1816
1817 /* Indicates whether HT is enabled */
1818 int ht_enabled;
1819
1820 /* Indicates whether HT40 is enabled */
1821 int ht40_enabled;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07001822
1823 /* Indicates whether VHT is enabled */
1824 int vht_enabled;
1825
1826 /* Configured ACS channel width */
1827 u16 ch_width;
1828
1829 /* ACS channel list info */
1830 unsigned int ch_list_len;
1831 const u8 *ch_list;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001832 const int *freq_list;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001833};
1834
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001835
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001836/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001837 * struct wpa_driver_ops - Driver interface API definition
1838 *
1839 * This structure defines the API that each driver interface needs to implement
1840 * for core wpa_supplicant code. All driver specific functionality is captured
1841 * in this wrapper.
1842 */
1843struct wpa_driver_ops {
1844 /** Name of the driver interface */
1845 const char *name;
1846 /** One line description of the driver interface */
1847 const char *desc;
1848
1849 /**
1850 * get_bssid - Get the current BSSID
1851 * @priv: private driver interface data
1852 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1853 *
1854 * Returns: 0 on success, -1 on failure
1855 *
1856 * Query kernel driver for the current BSSID and copy it to bssid.
1857 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1858 * associated.
1859 */
1860 int (*get_bssid)(void *priv, u8 *bssid);
1861
1862 /**
1863 * get_ssid - Get the current SSID
1864 * @priv: private driver interface data
1865 * @ssid: buffer for SSID (at least 32 bytes)
1866 *
1867 * Returns: Length of the SSID on success, -1 on failure
1868 *
1869 * Query kernel driver for the current SSID and copy it to ssid.
1870 * Returning zero is recommended if the STA is not associated.
1871 *
1872 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1873 * can, at least in theory, contain control characters (including nul)
1874 * and as such, should be processed as binary data, not a printable
1875 * string.
1876 */
1877 int (*get_ssid)(void *priv, u8 *ssid);
1878
1879 /**
1880 * set_key - Configure encryption key
1881 * @ifname: Interface name (for multi-SSID/VLAN support)
1882 * @priv: private driver interface data
1883 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001884 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001885 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1886 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1887 * %WPA_ALG_BIP_CMAC_256);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001888 * %WPA_ALG_NONE clears the key.
1889 * @addr: Address of the peer STA (BSSID of the current AP when setting
1890 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1891 * broadcast keys, %NULL for default keys that are used both for
1892 * broadcast and unicast; when clearing keys, %NULL is used to
1893 * indicate that both the broadcast-only and default key of the
1894 * specified key index is to be cleared
1895 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1896 * IGTK
1897 * @set_tx: configure this key as the default Tx key (only used when
1898 * driver does not support separate unicast/individual key
1899 * @seq: sequence number/packet number, seq_len octets, the next
1900 * packet number to be used for in replay protection; configured
1901 * for Rx keys (in most cases, this is only used with broadcast
1902 * keys and set to zero for unicast keys); %NULL if not set
1903 * @seq_len: length of the seq, depends on the algorithm:
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001904 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001905 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1906 * 8-byte Rx Mic Key
1907 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001908 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001909 *
1910 * Returns: 0 on success, -1 on failure
1911 *
1912 * Configure the given key for the kernel driver. If the driver
1913 * supports separate individual keys (4 default keys + 1 individual),
1914 * addr can be used to determine whether the key is default or
1915 * individual. If only 4 keys are supported, the default key with key
1916 * index 0 is used as the individual key. STA must be configured to use
1917 * it as the default Tx key (set_tx is set) and accept Rx for all the
1918 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1919 * broadcast keys, so key index 0 is available for this kind of
1920 * configuration.
1921 *
1922 * Please note that TKIP keys include separate TX and RX MIC keys and
1923 * some drivers may expect them in different order than wpa_supplicant
1924 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1925 * will trigger Michael MIC errors. This can be fixed by changing the
1926 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1927 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1928 * example on how this can be done.
1929 */
1930 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1931 const u8 *addr, int key_idx, int set_tx,
1932 const u8 *seq, size_t seq_len,
1933 const u8 *key, size_t key_len);
1934
1935 /**
1936 * init - Initialize driver interface
1937 * @ctx: context to be used when calling wpa_supplicant functions,
1938 * e.g., wpa_supplicant_event()
1939 * @ifname: interface name, e.g., wlan0
1940 *
1941 * Returns: Pointer to private data, %NULL on failure
1942 *
1943 * Initialize driver interface, including event processing for kernel
1944 * driver events (e.g., associated, scan results, Michael MIC failure).
1945 * This function can allocate a private configuration data area for
1946 * @ctx, file descriptor, interface name, etc. information that may be
1947 * needed in future driver operations. If this is not used, non-NULL
1948 * value will need to be returned because %NULL is used to indicate
1949 * failure. The returned value will be used as 'void *priv' data for
1950 * all other driver_ops functions.
1951 *
1952 * The main event loop (eloop.c) of wpa_supplicant can be used to
1953 * register callback for read sockets (eloop_register_read_sock()).
1954 *
1955 * See below for more information about events and
1956 * wpa_supplicant_event() function.
1957 */
1958 void * (*init)(void *ctx, const char *ifname);
1959
1960 /**
1961 * deinit - Deinitialize driver interface
1962 * @priv: private driver interface data from init()
1963 *
1964 * Shut down driver interface and processing of driver events. Free
1965 * private data buffer if one was allocated in init() handler.
1966 */
1967 void (*deinit)(void *priv);
1968
1969 /**
1970 * set_param - Set driver configuration parameters
1971 * @priv: private driver interface data from init()
1972 * @param: driver specific configuration parameters
1973 *
1974 * Returns: 0 on success, -1 on failure
1975 *
1976 * Optional handler for notifying driver interface about configuration
1977 * parameters (driver_param).
1978 */
1979 int (*set_param)(void *priv, const char *param);
1980
1981 /**
1982 * set_countermeasures - Enable/disable TKIP countermeasures
1983 * @priv: private driver interface data
1984 * @enabled: 1 = countermeasures enabled, 0 = disabled
1985 *
1986 * Returns: 0 on success, -1 on failure
1987 *
1988 * Configure TKIP countermeasures. When these are enabled, the driver
1989 * should drop all received and queued frames that are using TKIP.
1990 */
1991 int (*set_countermeasures)(void *priv, int enabled);
1992
1993 /**
1994 * deauthenticate - Request driver to deauthenticate
1995 * @priv: private driver interface data
1996 * @addr: peer address (BSSID of the AP)
1997 * @reason_code: 16-bit reason code to be sent in the deauthentication
1998 * frame
1999 *
2000 * Returns: 0 on success, -1 on failure
2001 */
2002 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
2003
2004 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002005 * associate - Request driver to associate
2006 * @priv: private driver interface data
2007 * @params: association parameters
2008 *
2009 * Returns: 0 on success, -1 on failure
2010 */
2011 int (*associate)(void *priv,
2012 struct wpa_driver_associate_params *params);
2013
2014 /**
2015 * add_pmkid - Add PMKSA cache entry to the driver
2016 * @priv: private driver interface data
2017 * @bssid: BSSID for the PMKSA cache entry
2018 * @pmkid: PMKID for the PMKSA cache entry
2019 *
2020 * Returns: 0 on success, -1 on failure
2021 *
2022 * This function is called when a new PMK is received, as a result of
2023 * either normal authentication or RSN pre-authentication.
2024 *
2025 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2026 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2027 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2028 * driver_ops function does not need to be implemented. Likewise, if
2029 * the driver does not support WPA, this function is not needed.
2030 */
2031 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
2032
2033 /**
2034 * remove_pmkid - Remove PMKSA cache entry to the driver
2035 * @priv: private driver interface data
2036 * @bssid: BSSID for the PMKSA cache entry
2037 * @pmkid: PMKID for the PMKSA cache entry
2038 *
2039 * Returns: 0 on success, -1 on failure
2040 *
2041 * This function is called when the supplicant drops a PMKSA cache
2042 * entry for any reason.
2043 *
2044 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2045 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2046 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2047 * from wpa_supplicant, this driver_ops function does not need to be
2048 * implemented. Likewise, if the driver does not support WPA, this
2049 * function is not needed.
2050 */
2051 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
2052
2053 /**
2054 * flush_pmkid - Flush PMKSA cache
2055 * @priv: private driver interface data
2056 *
2057 * Returns: 0 on success, -1 on failure
2058 *
2059 * This function is called when the supplicant drops all PMKSA cache
2060 * entries for any reason.
2061 *
2062 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2063 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2064 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2065 * from wpa_supplicant, this driver_ops function does not need to be
2066 * implemented. Likewise, if the driver does not support WPA, this
2067 * function is not needed.
2068 */
2069 int (*flush_pmkid)(void *priv);
2070
2071 /**
2072 * get_capa - Get driver capabilities
2073 * @priv: private driver interface data
2074 *
2075 * Returns: 0 on success, -1 on failure
2076 *
2077 * Get driver/firmware/hardware capabilities.
2078 */
2079 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
2080
2081 /**
2082 * poll - Poll driver for association information
2083 * @priv: private driver interface data
2084 *
2085 * This is an option callback that can be used when the driver does not
2086 * provide event mechanism for association events. This is called when
2087 * receiving WPA EAPOL-Key messages that require association
2088 * information. The driver interface is supposed to generate associnfo
2089 * event before returning from this callback function. In addition, the
2090 * driver interface should generate an association event after having
2091 * sent out associnfo.
2092 */
2093 void (*poll)(void *priv);
2094
2095 /**
Dmitry Shmidte4663042016-04-04 10:07:49 -07002096 * get_ifindex - Get interface index
2097 * @priv: private driver interface data
2098 *
2099 * Returns: Interface index
2100 */
2101 unsigned int (*get_ifindex)(void *priv);
2102
2103 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002104 * get_ifname - Get interface name
2105 * @priv: private driver interface data
2106 *
2107 * Returns: Pointer to the interface name. This can differ from the
2108 * interface name used in init() call. Init() is called first.
2109 *
2110 * This optional function can be used to allow the driver interface to
2111 * replace the interface name with something else, e.g., based on an
2112 * interface mapping from a more descriptive name.
2113 */
2114 const char * (*get_ifname)(void *priv);
2115
2116 /**
2117 * get_mac_addr - Get own MAC address
2118 * @priv: private driver interface data
2119 *
2120 * Returns: Pointer to own MAC address or %NULL on failure
2121 *
2122 * This optional function can be used to get the own MAC address of the
2123 * device from the driver interface code. This is only needed if the
2124 * l2_packet implementation for the OS does not provide easy access to
2125 * a MAC address. */
2126 const u8 * (*get_mac_addr)(void *priv);
2127
2128 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002129 * set_operstate - Sets device operating state to DORMANT or UP
2130 * @priv: private driver interface data
2131 * @state: 0 = dormant, 1 = up
2132 * Returns: 0 on success, -1 on failure
2133 *
2134 * This is an optional function that can be used on operating systems
2135 * that support a concept of controlling network device state from user
2136 * space applications. This function, if set, gets called with
2137 * state = 1 when authentication has been completed and with state = 0
2138 * when connection is lost.
2139 */
2140 int (*set_operstate)(void *priv, int state);
2141
2142 /**
2143 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2144 * @priv: Private driver interface data
2145 * @addr: Address of the station for which to set protection (may be
2146 * %NULL for group keys)
2147 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2148 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2149 * Returns: 0 on success, -1 on failure
2150 *
2151 * This is an optional function that can be used to set the driver to
2152 * require protection for Tx and/or Rx frames. This uses the layer
2153 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2154 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2155 * set protection operation; instead, they set protection implicitly
2156 * based on configured keys.
2157 */
2158 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2159 int key_type);
2160
2161 /**
2162 * get_hw_feature_data - Get hardware support data (channels and rates)
2163 * @priv: Private driver interface data
2164 * @num_modes: Variable for returning the number of returned modes
2165 * flags: Variable for returning hardware feature flags
2166 * Returns: Pointer to allocated hardware data on success or %NULL on
2167 * failure. Caller is responsible for freeing this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002168 */
2169 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2170 u16 *num_modes,
2171 u16 *flags);
2172
2173 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002174 * send_mlme - Send management frame from MLME
2175 * @priv: Private driver interface data
2176 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2177 * @data_len: Size of the management frame
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002178 * @noack: Do not wait for this frame to be acked (disable retries)
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07002179 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2180 * driver decide
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002181 * @csa_offs: Array of CSA offsets or %NULL
2182 * @csa_offs_len: Number of elements in csa_offs
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002183 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002184 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002185 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002186 int noack, unsigned int freq, const u16 *csa_offs,
2187 size_t csa_offs_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002188
2189 /**
2190 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2191 * @priv: Private driver interface data
2192 * @md: Mobility domain (2 octets) (also included inside ies)
2193 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2194 * @ies_len: Length of FT IEs in bytes
2195 * Returns: 0 on success, -1 on failure
2196 *
2197 * The supplicant uses this callback to let the driver know that keying
2198 * material for FT is available and that the driver can use the
2199 * provided IEs in the next message in FT authentication sequence.
2200 *
2201 * This function is only needed for driver that support IEEE 802.11r
2202 * (Fast BSS Transition).
2203 */
2204 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2205 size_t ies_len);
2206
2207 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002208 * get_scan_results2 - Fetch the latest scan results
2209 * @priv: private driver interface data
2210 *
2211 * Returns: Allocated buffer of scan results (caller is responsible for
2212 * freeing the data structure) on success, NULL on failure
2213 */
2214 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2215
2216 /**
2217 * set_country - Set country
2218 * @priv: Private driver interface data
2219 * @alpha2: country to which to switch to
2220 * Returns: 0 on success, -1 on failure
2221 *
2222 * This function is for drivers which support some form
2223 * of setting a regulatory domain.
2224 */
2225 int (*set_country)(void *priv, const char *alpha2);
2226
2227 /**
Dmitry Shmidtcce06662013-11-04 18:44:24 -08002228 * get_country - Get country
2229 * @priv: Private driver interface data
2230 * @alpha2: Buffer for returning country code (at least 3 octets)
2231 * Returns: 0 on success, -1 on failure
2232 */
2233 int (*get_country)(void *priv, char *alpha2);
2234
2235 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002236 * global_init - Global driver initialization
Dmitry Shmidte4663042016-04-04 10:07:49 -07002237 * @ctx: wpa_global pointer
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002238 * Returns: Pointer to private data (global), %NULL on failure
2239 *
2240 * This optional function is called to initialize the driver wrapper
2241 * for global data, i.e., data that applies to all interfaces. If this
2242 * function is implemented, global_deinit() will also need to be
2243 * implemented to free the private data. The driver will also likely
2244 * use init2() function instead of init() to get the pointer to global
2245 * data available to per-interface initializer.
2246 */
Dmitry Shmidte4663042016-04-04 10:07:49 -07002247 void * (*global_init)(void *ctx);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002248
2249 /**
2250 * global_deinit - Global driver deinitialization
2251 * @priv: private driver global data from global_init()
2252 *
2253 * Terminate any global driver related functionality and free the
2254 * global data structure.
2255 */
2256 void (*global_deinit)(void *priv);
2257
2258 /**
2259 * init2 - Initialize driver interface (with global data)
2260 * @ctx: context to be used when calling wpa_supplicant functions,
2261 * e.g., wpa_supplicant_event()
2262 * @ifname: interface name, e.g., wlan0
2263 * @global_priv: private driver global data from global_init()
2264 * Returns: Pointer to private data, %NULL on failure
2265 *
2266 * This function can be used instead of init() if the driver wrapper
2267 * uses global data.
2268 */
2269 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2270
2271 /**
2272 * get_interfaces - Get information about available interfaces
2273 * @global_priv: private driver global data from global_init()
2274 * Returns: Allocated buffer of interface information (caller is
2275 * responsible for freeing the data structure) on success, NULL on
2276 * failure
2277 */
2278 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2279
2280 /**
2281 * scan2 - Request the driver to initiate scan
2282 * @priv: private driver interface data
2283 * @params: Scan parameters
2284 *
2285 * Returns: 0 on success, -1 on failure
2286 *
2287 * Once the scan results are ready, the driver should report scan
2288 * results event for wpa_supplicant which will eventually request the
2289 * results with wpa_driver_get_scan_results2().
2290 */
2291 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2292
2293 /**
2294 * authenticate - Request driver to authenticate
2295 * @priv: private driver interface data
2296 * @params: authentication parameters
2297 * Returns: 0 on success, -1 on failure
2298 *
2299 * This is an optional function that can be used with drivers that
2300 * support separate authentication and association steps, i.e., when
2301 * wpa_supplicant can act as the SME. If not implemented, associate()
2302 * function is expected to take care of IEEE 802.11 authentication,
2303 * too.
2304 */
2305 int (*authenticate)(void *priv,
2306 struct wpa_driver_auth_params *params);
2307
2308 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002309 * set_ap - Set Beacon and Probe Response information for AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002310 * @priv: Private driver interface data
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002311 * @params: Parameters to use in AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002312 *
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002313 * This function is used to configure Beacon template and/or extra IEs
2314 * to add for Beacon and Probe Response frames for the driver in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002315 * AP mode. The driver is responsible for building the full Beacon
2316 * frame by concatenating the head part with TIM IE generated by the
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002317 * driver/firmware and finishing with the tail part. Depending on the
2318 * driver architectue, this can be done either by using the full
2319 * template or the set of additional IEs (e.g., WPS and P2P IE).
2320 * Similarly, Probe Response processing depends on the driver design.
2321 * If the driver (or firmware) takes care of replying to Probe Request
2322 * frames, the extra IEs provided here needs to be added to the Probe
2323 * Response frames.
2324 *
2325 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002326 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002327 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002328
2329 /**
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002330 * set_acl - Set ACL in AP mode
2331 * @priv: Private driver interface data
2332 * @params: Parameters to configure ACL
2333 * Returns: 0 on success, -1 on failure
2334 *
2335 * This is used only for the drivers which support MAC address ACL.
2336 */
2337 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2338
2339 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002340 * hapd_init - Initialize driver interface (hostapd only)
2341 * @hapd: Pointer to hostapd context
2342 * @params: Configuration for the driver wrapper
2343 * Returns: Pointer to private data, %NULL on failure
2344 *
2345 * This function is used instead of init() or init2() when the driver
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002346 * wrapper is used with hostapd.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002347 */
2348 void * (*hapd_init)(struct hostapd_data *hapd,
2349 struct wpa_init_params *params);
2350
2351 /**
2352 * hapd_deinit - Deinitialize driver interface (hostapd only)
2353 * @priv: Private driver interface data from hapd_init()
2354 */
2355 void (*hapd_deinit)(void *priv);
2356
2357 /**
2358 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2359 * @priv: Private driver interface data
2360 * @params: BSS parameters
2361 * Returns: 0 on success, -1 on failure
2362 *
2363 * This is an optional function to configure the kernel driver to
2364 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2365 * can be left undefined (set to %NULL) if IEEE 802.1X support is
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002366 * always enabled and the driver uses set_ap() to set WPA/RSN IE
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002367 * for Beacon frames.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002368 *
2369 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002370 */
2371 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2372
2373 /**
2374 * set_privacy - Enable/disable privacy (AP only)
2375 * @priv: Private driver interface data
2376 * @enabled: 1 = privacy enabled, 0 = disabled
2377 * Returns: 0 on success, -1 on failure
2378 *
2379 * This is an optional function to configure privacy field in the
2380 * kernel driver for Beacon frames. This can be left undefined (set to
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002381 * %NULL) if the driver uses the Beacon template from set_ap().
2382 *
2383 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002384 */
2385 int (*set_privacy)(void *priv, int enabled);
2386
2387 /**
2388 * get_seqnum - Fetch the current TSC/packet number (AP only)
2389 * @ifname: The interface name (main or virtual)
2390 * @priv: Private driver interface data
2391 * @addr: MAC address of the station or %NULL for group keys
2392 * @idx: Key index
2393 * @seq: Buffer for returning the latest used TSC/packet number
2394 * Returns: 0 on success, -1 on failure
2395 *
2396 * This function is used to fetch the last used TSC/packet number for
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002397 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2398 * keys, so there is no strict requirement on implementing support for
2399 * unicast keys (i.e., addr != %NULL).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002400 */
2401 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2402 int idx, u8 *seq);
2403
2404 /**
2405 * flush - Flush all association stations (AP only)
2406 * @priv: Private driver interface data
2407 * Returns: 0 on success, -1 on failure
2408 *
2409 * This function requests the driver to disassociate all associated
2410 * stations. This function does not need to be implemented if the
2411 * driver does not process association frames internally.
2412 */
2413 int (*flush)(void *priv);
2414
2415 /**
2416 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2417 * @priv: Private driver interface data
2418 * @elem: Information elements
2419 * @elem_len: Length of the elem buffer in octets
2420 * Returns: 0 on success, -1 on failure
2421 *
2422 * This is an optional function to add information elements in the
2423 * kernel driver for Beacon and Probe Response frames. This can be left
2424 * undefined (set to %NULL) if the driver uses the Beacon template from
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002425 * set_ap().
2426 *
2427 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002428 */
2429 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2430
2431 /**
Jouni Malinen1e6c57f2012-09-05 17:07:03 +03002432 * read_sta_data - Fetch station data
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002433 * @priv: Private driver interface data
2434 * @data: Buffer for returning station information
2435 * @addr: MAC address of the station
2436 * Returns: 0 on success, -1 on failure
2437 */
2438 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2439 const u8 *addr);
2440
2441 /**
2442 * hapd_send_eapol - Send an EAPOL packet (AP only)
2443 * @priv: private driver interface data
2444 * @addr: Destination MAC address
2445 * @data: EAPOL packet starting with IEEE 802.1X header
2446 * @data_len: Length of the EAPOL packet in octets
2447 * @encrypt: Whether the frame should be encrypted
2448 * @own_addr: Source MAC address
2449 * @flags: WPA_STA_* flags for the destination station
2450 *
2451 * Returns: 0 on success, -1 on failure
2452 */
2453 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2454 size_t data_len, int encrypt,
2455 const u8 *own_addr, u32 flags);
2456
2457 /**
2458 * sta_deauth - Deauthenticate a station (AP only)
2459 * @priv: Private driver interface data
2460 * @own_addr: Source address and BSSID for the Deauthentication frame
2461 * @addr: MAC address of the station to deauthenticate
2462 * @reason: Reason code for the Deauthentiation frame
2463 * Returns: 0 on success, -1 on failure
2464 *
2465 * This function requests a specific station to be deauthenticated and
2466 * a Deauthentication frame to be sent to it.
2467 */
2468 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2469 int reason);
2470
2471 /**
2472 * sta_disassoc - Disassociate a station (AP only)
2473 * @priv: Private driver interface data
2474 * @own_addr: Source address and BSSID for the Disassociation frame
2475 * @addr: MAC address of the station to disassociate
2476 * @reason: Reason code for the Disassociation frame
2477 * Returns: 0 on success, -1 on failure
2478 *
2479 * This function requests a specific station to be disassociated and
2480 * a Disassociation frame to be sent to it.
2481 */
2482 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2483 int reason);
2484
2485 /**
2486 * sta_remove - Remove a station entry (AP only)
2487 * @priv: Private driver interface data
2488 * @addr: MAC address of the station to be removed
2489 * Returns: 0 on success, -1 on failure
2490 */
2491 int (*sta_remove)(void *priv, const u8 *addr);
2492
2493 /**
2494 * hapd_get_ssid - Get the current SSID (AP only)
2495 * @priv: Private driver interface data
2496 * @buf: Buffer for returning the SSID
2497 * @len: Maximum length of the buffer
2498 * Returns: Length of the SSID on success, -1 on failure
2499 *
2500 * This function need not be implemented if the driver uses Beacon
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002501 * template from set_ap() and does not reply to Probe Request frames.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002502 */
2503 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2504
2505 /**
2506 * hapd_set_ssid - Set SSID (AP only)
2507 * @priv: Private driver interface data
2508 * @buf: SSID
2509 * @len: Length of the SSID in octets
2510 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002511 *
2512 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002513 */
2514 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2515
2516 /**
2517 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2518 * @priv: Private driver interface data
2519 * @enabled: 1 = countermeasures enabled, 0 = disabled
2520 * Returns: 0 on success, -1 on failure
2521 *
2522 * This need not be implemented if the driver does not take care of
2523 * association processing.
2524 */
2525 int (*hapd_set_countermeasures)(void *priv, int enabled);
2526
2527 /**
2528 * sta_add - Add a station entry
2529 * @priv: Private driver interface data
2530 * @params: Station parameters
2531 * Returns: 0 on success, -1 on failure
2532 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002533 * This function is used to add or set (params->set 1) a station
2534 * entry in the driver. Adding STA entries is used only if the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002535 * does not take care of association processing.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002536 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002537 * With drivers that don't support full AP client state, this function
2538 * is used to add a station entry to the driver once the station has
2539 * completed association.
2540 *
2541 * With TDLS, this function is used to add or set (params->set 1)
2542 * TDLS peer entries (even with drivers that do not support full AP
2543 * client state).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002544 */
2545 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2546
2547 /**
2548 * get_inact_sec - Get station inactivity duration (AP only)
2549 * @priv: Private driver interface data
2550 * @addr: Station address
2551 * Returns: Number of seconds station has been inactive, -1 on failure
2552 */
2553 int (*get_inact_sec)(void *priv, const u8 *addr);
2554
2555 /**
2556 * sta_clear_stats - Clear station statistics (AP only)
2557 * @priv: Private driver interface data
2558 * @addr: Station address
2559 * Returns: 0 on success, -1 on failure
2560 */
2561 int (*sta_clear_stats)(void *priv, const u8 *addr);
2562
2563 /**
2564 * set_freq - Set channel/frequency (AP only)
2565 * @priv: Private driver interface data
2566 * @freq: Channel parameters
2567 * Returns: 0 on success, -1 on failure
2568 */
2569 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2570
2571 /**
2572 * set_rts - Set RTS threshold
2573 * @priv: Private driver interface data
2574 * @rts: RTS threshold in octets
2575 * Returns: 0 on success, -1 on failure
2576 */
2577 int (*set_rts)(void *priv, int rts);
2578
2579 /**
2580 * set_frag - Set fragmentation threshold
2581 * @priv: Private driver interface data
2582 * @frag: Fragmentation threshold in octets
2583 * Returns: 0 on success, -1 on failure
2584 */
2585 int (*set_frag)(void *priv, int frag);
2586
2587 /**
2588 * sta_set_flags - Set station flags (AP only)
2589 * @priv: Private driver interface data
2590 * @addr: Station address
2591 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2592 * @flags_or: Bitmap of WPA_STA_* flags to add
2593 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2594 * Returns: 0 on success, -1 on failure
2595 */
2596 int (*sta_set_flags)(void *priv, const u8 *addr,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002597 unsigned int total_flags, unsigned int flags_or,
2598 unsigned int flags_and);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002599
2600 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002601 * set_tx_queue_params - Set TX queue parameters
2602 * @priv: Private driver interface data
2603 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2604 * @aifs: AIFS
2605 * @cw_min: cwMin
2606 * @cw_max: cwMax
2607 * @burst_time: Maximum length for bursting in 0.1 msec units
2608 */
2609 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2610 int cw_max, int burst_time);
2611
2612 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002613 * if_add - Add a virtual interface
2614 * @priv: Private driver interface data
2615 * @type: Interface type
2616 * @ifname: Interface name for the new virtual interface
2617 * @addr: Local address to use for the interface or %NULL to use the
2618 * parent interface address
2619 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2620 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2621 * not allowed (applies only to %WPA_IF_AP_BSS type)
2622 * @force_ifname: Buffer for returning an interface name that the
2623 * driver ended up using if it differs from the requested ifname
2624 * @if_addr: Buffer for returning the allocated interface address
2625 * (this may differ from the requested addr if the driver cannot
2626 * change interface address)
2627 * @bridge: Bridge interface to use or %NULL if no bridge configured
Dmitry Shmidtcce06662013-11-04 18:44:24 -08002628 * @use_existing: Whether to allow existing interface to be used
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08002629 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002630 * Returns: 0 on success, -1 on failure
2631 */
2632 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2633 const char *ifname, const u8 *addr, void *bss_ctx,
2634 void **drv_priv, char *force_ifname, u8 *if_addr,
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08002635 const char *bridge, int use_existing, int setup_ap);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002636
2637 /**
2638 * if_remove - Remove a virtual interface
2639 * @priv: Private driver interface data
2640 * @type: Interface type
2641 * @ifname: Interface name of the virtual interface to be removed
2642 * Returns: 0 on success, -1 on failure
2643 */
2644 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2645 const char *ifname);
2646
2647 /**
2648 * set_sta_vlan - Bind a station into a specific interface (AP only)
2649 * @priv: Private driver interface data
2650 * @ifname: Interface (main or virtual BSS or VLAN)
2651 * @addr: MAC address of the associated station
2652 * @vlan_id: VLAN ID
2653 * Returns: 0 on success, -1 on failure
2654 *
2655 * This function is used to bind a station to a specific virtual
2656 * interface. It is only used if when virtual interfaces are supported,
2657 * e.g., to assign stations to different VLAN interfaces based on
2658 * information from a RADIUS server. This allows separate broadcast
2659 * domains to be used with a single BSS.
2660 */
2661 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2662 int vlan_id);
2663
2664 /**
2665 * commit - Optional commit changes handler (AP only)
2666 * @priv: driver private data
2667 * Returns: 0 on success, -1 on failure
2668 *
2669 * This optional handler function can be registered if the driver
2670 * interface implementation needs to commit changes (e.g., by setting
2671 * network interface up) at the end of initial configuration. If set,
2672 * this handler will be called after initial setup has been completed.
2673 */
2674 int (*commit)(void *priv);
2675
2676 /**
2677 * send_ether - Send an ethernet packet (AP only)
2678 * @priv: private driver interface data
2679 * @dst: Destination MAC address
2680 * @src: Source MAC address
2681 * @proto: Ethertype
2682 * @data: EAPOL packet starting with IEEE 802.1X header
2683 * @data_len: Length of the EAPOL packet in octets
2684 * Returns: 0 on success, -1 on failure
2685 */
2686 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2687 const u8 *data, size_t data_len);
2688
2689 /**
2690 * set_radius_acl_auth - Notification of RADIUS ACL change
2691 * @priv: Private driver interface data
2692 * @mac: MAC address of the station
2693 * @accepted: Whether the station was accepted
2694 * @session_timeout: Session timeout for the station
2695 * Returns: 0 on success, -1 on failure
2696 */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07002697 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002698 u32 session_timeout);
2699
2700 /**
2701 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2702 * @priv: Private driver interface data
2703 * @mac: MAC address of the station
2704 * Returns: 0 on success, -1 on failure
2705 */
2706 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2707
2708 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002709 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2710 * @priv: Private driver interface data
2711 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2712 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2713 * extra IE(s)
2714 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2715 * to remove extra IE(s)
2716 * Returns: 0 on success, -1 on failure
2717 *
2718 * This is an optional function to add WPS IE in the kernel driver for
2719 * Beacon and Probe Response frames. This can be left undefined (set
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002720 * to %NULL) if the driver uses the Beacon template from set_ap()
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002721 * and does not process Probe Request frames. If the driver takes care
2722 * of (Re)Association frame processing, the assocresp buffer includes
2723 * WPS IE(s) that need to be added to (Re)Association Response frames
2724 * whenever a (Re)Association Request frame indicated use of WPS.
2725 *
2726 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2727 * frames when operating as a GO. The driver is responsible for adding
2728 * timing related attributes (e.g., NoA) in addition to the IEs
2729 * included here by appending them after these buffers. This call is
2730 * also used to provide Probe Response IEs for P2P Listen state
2731 * operations for drivers that generate the Probe Response frames
2732 * internally.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002733 *
2734 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002735 */
2736 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2737 const struct wpabuf *proberesp,
2738 const struct wpabuf *assocresp);
2739
2740 /**
2741 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2742 * @priv: Private driver interface data
2743 * @authorized: Whether the port is authorized
2744 * Returns: 0 on success, -1 on failure
2745 */
2746 int (*set_supp_port)(void *priv, int authorized);
2747
2748 /**
2749 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2750 * @priv: Private driver interface data
2751 * @addr: MAC address of the associated station
2752 * @aid: Association ID
2753 * @val: 1 = bind to 4-address WDS; 0 = unbind
2754 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2755 * to indicate that bridge is not to be used
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07002756 * @ifname_wds: Buffer to return the interface name for the new WDS
2757 * station or %NULL to indicate name is not returned.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002758 * Returns: 0 on success, -1 on failure
2759 */
2760 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07002761 const char *bridge_ifname, char *ifname_wds);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002762
2763 /**
2764 * send_action - Transmit an Action frame
2765 * @priv: Private driver interface data
2766 * @freq: Frequency (in MHz) of the channel
2767 * @wait: Time to wait off-channel for a response (in ms), or zero
2768 * @dst: Destination MAC address (Address 1)
2769 * @src: Source MAC address (Address 2)
2770 * @bssid: BSSID (Address 3)
2771 * @data: Frame body
2772 * @data_len: data length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002773 @ @no_cck: Whether CCK rates must not be used to transmit this frame
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002774 * Returns: 0 on success, -1 on failure
2775 *
2776 * This command can be used to request the driver to transmit an action
2777 * frame to the specified destination.
2778 *
2779 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2780 * be transmitted on the given channel and the device will wait for a
2781 * response on that channel for the given wait time.
2782 *
2783 * If the flag is not set, the wait time will be ignored. In this case,
2784 * if a remain-on-channel duration is in progress, the frame must be
2785 * transmitted on that channel; alternatively the frame may be sent on
2786 * the current operational channel (if in associated state in station
2787 * mode or while operating as an AP.)
2788 */
2789 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2790 const u8 *dst, const u8 *src, const u8 *bssid,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002791 const u8 *data, size_t data_len, int no_cck);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002792
2793 /**
2794 * send_action_cancel_wait - Cancel action frame TX wait
2795 * @priv: Private driver interface data
2796 *
2797 * This command cancels the wait time associated with sending an action
2798 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2799 * set in the driver flags.
2800 */
2801 void (*send_action_cancel_wait)(void *priv);
2802
2803 /**
2804 * remain_on_channel - Remain awake on a channel
2805 * @priv: Private driver interface data
2806 * @freq: Frequency (in MHz) of the channel
2807 * @duration: Duration in milliseconds
2808 * Returns: 0 on success, -1 on failure
2809 *
2810 * This command is used to request the driver to remain awake on the
2811 * specified channel for the specified duration and report received
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08002812 * Action frames with EVENT_RX_MGMT events. Optionally, received
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002813 * Probe Request frames may also be requested to be reported by calling
2814 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2815 *
2816 * The driver may not be at the requested channel when this function
2817 * returns, i.e., the return code is only indicating whether the
2818 * request was accepted. The caller will need to wait until the
2819 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2820 * completed the channel change. This may take some time due to other
2821 * need for the radio and the caller should be prepared to timing out
2822 * its wait since there are no guarantees on when this request can be
2823 * executed.
2824 */
2825 int (*remain_on_channel)(void *priv, unsigned int freq,
2826 unsigned int duration);
2827
2828 /**
2829 * cancel_remain_on_channel - Cancel remain-on-channel operation
2830 * @priv: Private driver interface data
2831 *
2832 * This command can be used to cancel a remain-on-channel operation
2833 * before its originally requested duration has passed. This could be
2834 * used, e.g., when remain_on_channel() is used to request extra time
2835 * to receive a response to an Action frame and the response is
2836 * received when there is still unneeded time remaining on the
2837 * remain-on-channel operation.
2838 */
2839 int (*cancel_remain_on_channel)(void *priv);
2840
2841 /**
2842 * probe_req_report - Request Probe Request frames to be indicated
2843 * @priv: Private driver interface data
2844 * @report: Whether to report received Probe Request frames
2845 * Returns: 0 on success, -1 on failure (or if not supported)
2846 *
2847 * This command can be used to request the driver to indicate when
2848 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2849 * Since this operation may require extra resources, e.g., due to less
2850 * optimal hardware/firmware RX filtering, many drivers may disable
2851 * Probe Request reporting at least in station mode. This command is
2852 * used to notify the driver when the Probe Request frames need to be
2853 * reported, e.g., during remain-on-channel operations.
2854 */
2855 int (*probe_req_report)(void *priv, int report);
2856
2857 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002858 * deinit_ap - Deinitialize AP mode
2859 * @priv: Private driver interface data
2860 * Returns: 0 on success, -1 on failure (or if not supported)
2861 *
2862 * This optional function can be used to disable AP mode related
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07002863 * configuration. If the interface was not dynamically added,
2864 * change the driver mode to station mode to allow normal station
2865 * operations like scanning to be completed.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002866 */
2867 int (*deinit_ap)(void *priv);
2868
2869 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07002870 * deinit_p2p_cli - Deinitialize P2P client mode
2871 * @priv: Private driver interface data
2872 * Returns: 0 on success, -1 on failure (or if not supported)
2873 *
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07002874 * This optional function can be used to disable P2P client mode. If the
2875 * interface was not dynamically added, change the interface type back
2876 * to station mode.
Dmitry Shmidt04949592012-07-19 12:16:46 -07002877 */
2878 int (*deinit_p2p_cli)(void *priv);
2879
2880 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002881 * suspend - Notification on system suspend/hibernate event
2882 * @priv: Private driver interface data
2883 */
2884 void (*suspend)(void *priv);
2885
2886 /**
2887 * resume - Notification on system resume/thaw event
2888 * @priv: Private driver interface data
2889 */
2890 void (*resume)(void *priv);
2891
2892 /**
2893 * signal_monitor - Set signal monitoring parameters
2894 * @priv: Private driver interface data
2895 * @threshold: Threshold value for signal change events; 0 = disabled
2896 * @hysteresis: Minimum change in signal strength before indicating a
2897 * new event
2898 * Returns: 0 on success, -1 on failure (or if not supported)
2899 *
2900 * This function can be used to configure monitoring of signal strength
2901 * with the current AP. Whenever signal strength drops below the
2902 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2903 * should be generated assuming the signal strength has changed at
2904 * least %hysteresis from the previously indicated signal change event.
2905 */
2906 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2907
2908 /**
2909 * send_frame - Send IEEE 802.11 frame (testing use only)
2910 * @priv: Private driver interface data
2911 * @data: IEEE 802.11 frame with IEEE 802.11 header
2912 * @data_len: Size of the frame
2913 * @encrypt: Whether to encrypt the frame (if keys are set)
2914 * Returns: 0 on success, -1 on failure
2915 *
2916 * This function is only used for debugging purposes and is not
2917 * required to be implemented for normal operations.
2918 */
2919 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2920 int encrypt);
2921
2922 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002923 * get_noa - Get current Notice of Absence attribute payload
2924 * @priv: Private driver interface data
2925 * @buf: Buffer for returning NoA
2926 * @buf_len: Buffer length in octets
2927 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2928 * advertized, or -1 on failure
2929 *
2930 * This function is used to fetch the current Notice of Absence
2931 * attribute value from GO.
2932 */
2933 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2934
2935 /**
2936 * set_noa - Set Notice of Absence parameters for GO (testing)
2937 * @priv: Private driver interface data
2938 * @count: Count
2939 * @start: Start time in ms from next TBTT
2940 * @duration: Duration in ms
2941 * Returns: 0 on success or -1 on failure
2942 *
2943 * This function is used to set Notice of Absence parameters for GO. It
2944 * is used only for testing. To disable NoA, all parameters are set to
2945 * 0.
2946 */
2947 int (*set_noa)(void *priv, u8 count, int start, int duration);
2948
2949 /**
2950 * set_p2p_powersave - Set P2P power save options
2951 * @priv: Private driver interface data
2952 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2953 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2954 * @ctwindow: 0.. = change (msec), -1 = no change
2955 * Returns: 0 on success or -1 on failure
2956 */
2957 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2958 int ctwindow);
2959
2960 /**
2961 * ampdu - Enable/disable aggregation
2962 * @priv: Private driver interface data
2963 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2964 * Returns: 0 on success or -1 on failure
2965 */
2966 int (*ampdu)(void *priv, int ampdu);
2967
2968 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002969 * get_radio_name - Get physical radio name for the device
2970 * @priv: Private driver interface data
2971 * Returns: Radio name or %NULL if not known
2972 *
2973 * The returned data must not be modified by the caller. It is assumed
2974 * that any interface that has the same radio name as another is
2975 * sharing the same physical radio. This information can be used to
2976 * share scan results etc. information between the virtual interfaces
2977 * to speed up various operations.
2978 */
2979 const char * (*get_radio_name)(void *priv);
2980
2981 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002982 * send_tdls_mgmt - for sending TDLS management packets
2983 * @priv: private driver interface data
2984 * @dst: Destination (peer) MAC address
2985 * @action_code: TDLS action code for the mssage
2986 * @dialog_token: Dialog Token to use in the message (if needed)
2987 * @status_code: Status Code or Reason Code to use (if needed)
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002988 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07002989 * @initiator: Is the current end the TDLS link initiator
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002990 * @buf: TDLS IEs to add to the message
2991 * @len: Length of buf in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002992 * Returns: 0 on success, negative (<0) on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002993 *
2994 * This optional function can be used to send packet to driver which is
2995 * responsible for receiving and sending all TDLS packets.
2996 */
2997 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002998 u8 dialog_token, u16 status_code, u32 peer_capab,
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07002999 int initiator, const u8 *buf, size_t len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003000
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003001 /**
3002 * tdls_oper - Ask the driver to perform high-level TDLS operations
3003 * @priv: Private driver interface data
3004 * @oper: TDLS high-level operation. See %enum tdls_oper
3005 * @peer: Destination (peer) MAC address
3006 * Returns: 0 on success, negative (<0) on failure
3007 *
3008 * This optional function can be used to send high-level TDLS commands
3009 * to the driver.
3010 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003011 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
3012
3013 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07003014 * wnm_oper - Notify driver of the WNM frame reception
3015 * @priv: Private driver interface data
3016 * @oper: WNM operation. See %enum wnm_oper
3017 * @peer: Destination (peer) MAC address
3018 * @buf: Buffer for the driver to fill in (for getting IE)
3019 * @buf_len: Return the len of buf
3020 * Returns: 0 on success, negative (<0) on failure
3021 */
3022 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
3023 u8 *buf, u16 *buf_len);
3024
3025 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -07003026 * set_qos_map - Set QoS Map
3027 * @priv: Private driver interface data
3028 * @qos_map_set: QoS Map
3029 * @qos_map_set_len: Length of QoS Map
3030 */
3031 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
3032 u8 qos_map_set_len);
3033
3034 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003035 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3036 * @priv: Private driver interface data
3037 * @version: IP version of the IP address, 4 or 6
3038 * @ipaddr: IP address for the neigh entry
3039 * @prefixlen: IP address prefix length
3040 * @addr: Corresponding MAC address
3041 * Returns: 0 on success, negative (<0) on failure
3042 */
3043 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
3044 int prefixlen, const u8 *addr);
3045
3046 /**
3047 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3048 * @priv: Private driver interface data
3049 * @version: IP version of the IP address, 4 or 6
3050 * @ipaddr: IP address for the neigh entry
3051 * Returns: 0 on success, negative (<0) on failure
3052 */
3053 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
3054
3055 /**
3056 * br_port_set_attr - Set a bridge port attribute
3057 * @attr: Bridge port attribute to set
3058 * @val: Value to be set
3059 * Returns: 0 on success, negative (<0) on failure
3060 */
3061 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
3062 unsigned int val);
3063
3064 /**
3065 * br_port_set_attr - Set a bridge network parameter
3066 * @param: Bridge parameter to set
3067 * @val: Value to be set
3068 * Returns: 0 on success, negative (<0) on failure
3069 */
3070 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
3071 unsigned int val);
3072
3073 /**
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07003074 * set_wowlan - Set wake-on-wireless triggers
3075 * @priv: Private driver interface data
3076 * @triggers: wowlan triggers
3077 */
3078 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
3079
3080 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003081 * signal_poll - Get current connection information
3082 * @priv: Private driver interface data
3083 * @signal_info: Connection info structure
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003084 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003085 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003086
3087 /**
Jouni Malinen75ecf522011-06-27 15:19:46 -07003088 * set_authmode - Set authentication algorithm(s) for static WEP
3089 * @priv: Private driver interface data
3090 * @authmode: 1=Open System, 2=Shared Key, 3=both
3091 * Returns: 0 on success, -1 on failure
3092 *
3093 * This function can be used to set authentication algorithms for AP
3094 * mode when static WEP is used. If the driver uses user space MLME/SME
3095 * implementation, there is no need to implement this function.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003096 *
3097 * DEPRECATED - use set_ap() instead
Jouni Malinen75ecf522011-06-27 15:19:46 -07003098 */
3099 int (*set_authmode)(void *priv, int authmode);
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003100
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003101#ifdef ANDROID
Jouni Malinen75ecf522011-06-27 15:19:46 -07003102 /**
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003103 * driver_cmd - Execute driver-specific command
3104 * @priv: Private driver interface data
3105 * @cmd: Command to execute
3106 * @buf: Return buffer
3107 * @buf_len: Buffer length
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003108 * Returns: 0 on success, -1 on failure
3109 */
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003110 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
3111#endif /* ANDROID */
3112
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003113 /**
Dmitry Shmidta38abf92014-03-06 13:38:44 -08003114 * vendor_cmd - Execute vendor specific command
3115 * @priv: Private driver interface data
3116 * @vendor_id: Vendor id
3117 * @subcmd: Vendor command id
3118 * @data: Vendor command parameters (%NULL if no parameters)
3119 * @data_len: Data length
3120 * @buf: Return buffer (%NULL to ignore reply)
3121 * Returns: 0 on success, negative (<0) on failure
3122 *
3123 * This function handles vendor specific commands that are passed to
3124 * the driver/device. The command is identified by vendor id and
3125 * command id. Parameters can be passed as argument to the command
3126 * in the data buffer. Reply (if any) will be filled in the supplied
3127 * return buffer.
3128 *
3129 * The exact driver behavior is driver interface and vendor specific. As
3130 * an example, this will be converted to a vendor specific cfg80211
3131 * command in case of the nl80211 driver interface.
3132 */
3133 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3134 unsigned int subcmd, const u8 *data, size_t data_len,
3135 struct wpabuf *buf);
3136
3137 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003138 * set_rekey_info - Set rekey information
3139 * @priv: Private driver interface data
3140 * @kek: Current KEK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003141 * @kek_len: KEK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003142 * @kck: Current KCK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003143 * @kck_len: KCK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003144 * @replay_ctr: Current EAPOL-Key Replay Counter
3145 *
3146 * This optional function can be used to provide information for the
3147 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3148 * while the host (including wpa_supplicant) is sleeping.
3149 */
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003150 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3151 const u8 *kck, size_t kck_len,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003152 const u8 *replay_ctr);
3153
3154 /**
3155 * sta_assoc - Station association indication
3156 * @priv: Private driver interface data
3157 * @own_addr: Source address and BSSID for association frame
3158 * @addr: MAC address of the station to associate
3159 * @reassoc: flag to indicate re-association
3160 * @status: association response status code
3161 * @ie: assoc response ie buffer
3162 * @len: ie buffer length
3163 * Returns: 0 on success, -1 on failure
3164 *
3165 * This function indicates the driver to send (Re)Association
3166 * Response frame to the station.
3167 */
3168 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3169 int reassoc, u16 status, const u8 *ie, size_t len);
3170
3171 /**
3172 * sta_auth - Station authentication indication
3173 * @priv: Private driver interface data
3174 * @own_addr: Source address and BSSID for authentication frame
3175 * @addr: MAC address of the station to associate
3176 * @seq: authentication sequence number
3177 * @status: authentication response status code
3178 * @ie: authentication frame ie buffer
3179 * @len: ie buffer length
3180 *
3181 * This function indicates the driver to send Authentication frame
3182 * to the station.
3183 */
3184 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
3185 u16 seq, u16 status, const u8 *ie, size_t len);
3186
3187 /**
3188 * add_tspec - Add traffic stream
3189 * @priv: Private driver interface data
3190 * @addr: MAC address of the station to associate
3191 * @tspec_ie: tspec ie buffer
3192 * @tspec_ielen: tspec ie length
3193 * Returns: 0 on success, -1 on failure
3194 *
3195 * This function adds the traffic steam for the station
3196 * and fills the medium_time in tspec_ie.
3197 */
3198 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3199 size_t tspec_ielen);
3200
3201 /**
3202 * add_sta_node - Add a station node in the driver
3203 * @priv: Private driver interface data
3204 * @addr: MAC address of the station to add
3205 * @auth_alg: authentication algorithm used by the station
3206 * Returns: 0 on success, -1 on failure
3207 *
3208 * This function adds the station node in the driver, when
3209 * the station gets added by FT-over-DS.
3210 */
3211 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
3212
3213 /**
3214 * sched_scan - Request the driver to initiate scheduled scan
3215 * @priv: Private driver interface data
3216 * @params: Scan parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003217 * Returns: 0 on success, -1 on failure
3218 *
3219 * This operation should be used for scheduled scan offload to
3220 * the hardware. Every time scan results are available, the
3221 * driver should report scan results event for wpa_supplicant
3222 * which will eventually request the results with
3223 * wpa_driver_get_scan_results2(). This operation is optional
3224 * and if not provided or if it returns -1, we fall back to
3225 * normal host-scheduled scans.
3226 */
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003227 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003228
3229 /**
3230 * stop_sched_scan - Request the driver to stop a scheduled scan
3231 * @priv: Private driver interface data
3232 * Returns: 0 on success, -1 on failure
3233 *
3234 * This should cause the scheduled scan to be stopped and
3235 * results should stop being sent. Must be supported if
3236 * sched_scan is supported.
3237 */
3238 int (*stop_sched_scan)(void *priv);
3239
3240 /**
3241 * poll_client - Probe (null data or such) the given station
3242 * @priv: Private driver interface data
3243 * @own_addr: MAC address of sending interface
3244 * @addr: MAC address of the station to probe
3245 * @qos: Indicates whether station is QoS station
3246 *
3247 * This function is used to verify whether an associated station is
3248 * still present. This function does not need to be implemented if the
3249 * driver provides such inactivity polling mechanism.
3250 */
3251 void (*poll_client)(void *priv, const u8 *own_addr,
3252 const u8 *addr, int qos);
Dmitry Shmidt04949592012-07-19 12:16:46 -07003253
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003254 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003255 * radio_disable - Disable/enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003256 * @priv: Private driver interface data
Dmitry Shmidt04949592012-07-19 12:16:46 -07003257 * @disabled: 1=disable 0=enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003258 * Returns: 0 on success, -1 on failure
3259 *
Dmitry Shmidt04949592012-07-19 12:16:46 -07003260 * This optional command is for testing purposes. It can be used to
3261 * disable the radio on a testbed device to simulate out-of-radio-range
3262 * conditions.
3263 */
3264 int (*radio_disable)(void *priv, int disabled);
3265
3266 /**
3267 * switch_channel - Announce channel switch and migrate the GO to the
3268 * given frequency
3269 * @priv: Private driver interface data
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003270 * @settings: Settings for CSA period and new channel
Dmitry Shmidt04949592012-07-19 12:16:46 -07003271 * Returns: 0 on success, -1 on failure
3272 *
3273 * This function is used to move the GO to the legacy STA channel to
3274 * avoid frequency conflict in single channel concurrency.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003275 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003276 int (*switch_channel)(void *priv, struct csa_settings *settings);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003277
3278 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003279 * add_tx_ts - Add traffic stream
3280 * @priv: Private driver interface data
3281 * @tsid: Traffic stream ID
3282 * @addr: Receiver address
3283 * @user_prio: User priority of the traffic stream
3284 * @admitted_time: Admitted time for this TS in units of
3285 * 32 microsecond periods (per second).
3286 * Returns: 0 on success, -1 on failure
3287 */
3288 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3289 u16 admitted_time);
3290
3291 /**
3292 * del_tx_ts - Delete traffic stream
3293 * @priv: Private driver interface data
3294 * @tsid: Traffic stream ID
3295 * @addr: Receiver address
3296 * Returns: 0 on success, -1 on failure
3297 */
3298 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3299
3300 /**
3301 * Enable channel-switching with TDLS peer
3302 * @priv: Private driver interface data
3303 * @addr: MAC address of the TDLS peer
3304 * @oper_class: Operating class of the switch channel
3305 * @params: Channel specification
3306 * Returns: 0 on success, -1 on failure
3307 *
3308 * The function indicates to driver that it can start switching to a
3309 * different channel with a specified TDLS peer. The switching is
3310 * assumed on until canceled with tdls_disable_channel_switch().
3311 */
3312 int (*tdls_enable_channel_switch)(
3313 void *priv, const u8 *addr, u8 oper_class,
3314 const struct hostapd_freq_params *params);
3315
3316 /**
3317 * Disable channel switching with TDLS peer
3318 * @priv: Private driver interface data
3319 * @addr: MAC address of the TDLS peer
3320 * Returns: 0 on success, -1 on failure
3321 *
3322 * This function indicates to the driver that it should stop switching
3323 * with a given TDLS peer.
3324 */
3325 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3326
3327 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003328 * start_dfs_cac - Listen for radar interference on the channel
3329 * @priv: Private driver interface data
Dmitry Shmidt051af732013-10-22 13:52:46 -07003330 * @freq: Channel parameters
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003331 * Returns: 0 on success, -1 on failure
3332 */
Dmitry Shmidt051af732013-10-22 13:52:46 -07003333 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003334
3335 /**
3336 * stop_ap - Removes beacon from AP
3337 * @priv: Private driver interface data
3338 * Returns: 0 on success, -1 on failure (or if not supported)
3339 *
3340 * This optional function can be used to disable AP mode related
3341 * configuration. Unlike deinit_ap, it does not change to station
3342 * mode.
3343 */
3344 int (*stop_ap)(void *priv);
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003345
3346 /**
3347 * get_survey - Retrieve survey data
3348 * @priv: Private driver interface data
3349 * @freq: If set, survey data for the specified frequency is only
3350 * being requested. If not set, all survey data is requested.
3351 * Returns: 0 on success, -1 on failure
3352 *
3353 * Use this to retrieve:
3354 *
3355 * - the observed channel noise floor
3356 * - the amount of time we have spent on the channel
3357 * - the amount of time during which we have spent on the channel that
3358 * the radio has determined the medium is busy and we cannot
3359 * transmit
3360 * - the amount of time we have spent receiving data
3361 * - the amount of time we have spent transmitting data
3362 *
3363 * This data can be used for spectrum heuristics. One example is
3364 * Automatic Channel Selection (ACS). The channel survey data is
3365 * kept on a linked list on the channel data, one entry is added
3366 * for each survey. The min_nf of the channel is updated for each
3367 * survey.
3368 */
3369 int (*get_survey)(void *priv, unsigned int freq);
Dmitry Shmidt56052862013-10-04 10:23:25 -07003370
3371 /**
3372 * status - Get driver interface status information
3373 * @priv: Private driver interface data
3374 * @buf: Buffer for printing tou the status information
3375 * @buflen: Maximum length of the buffer
3376 * Returns: Length of written status information or -1 on failure
3377 */
3378 int (*status)(void *priv, char *buf, size_t buflen);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003379
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07003380 /**
3381 * roaming - Set roaming policy for driver-based BSS selection
3382 * @priv: Private driver interface data
3383 * @allowed: Whether roaming within ESS is allowed
3384 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3385 * Returns: Length of written status information or -1 on failure
3386 *
3387 * This optional callback can be used to update roaming policy from the
3388 * associate() command (bssid being set there indicates that the driver
3389 * should not roam before getting this roaming() call to allow roaming.
3390 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3391 * capability, roaming policy is handled within wpa_supplicant and there
3392 * is no need to implement or react to this callback.
3393 */
3394 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3395
3396 /**
3397 * set_mac_addr - Set MAC address
3398 * @priv: Private driver interface data
3399 * @addr: MAC address to use or %NULL for setting back to permanent
3400 * Returns: 0 on success, -1 on failure
3401 */
3402 int (*set_mac_addr)(void *priv, const u8 *addr);
3403
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003404#ifdef CONFIG_MACSEC
3405 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3406
3407 int (*macsec_deinit)(void *priv);
3408
3409 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003410 * macsec_get_capability - Inform MKA of this driver's capability
3411 * @priv: Private driver interface data
3412 * @cap: Driver's capability
3413 * Returns: 0 on success, -1 on failure
3414 */
3415 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);
3416
3417 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003418 * enable_protect_frames - Set protect frames status
3419 * @priv: Private driver interface data
3420 * @enabled: TRUE = protect frames enabled
3421 * FALSE = protect frames disabled
3422 * Returns: 0 on success, -1 on failure (or if not supported)
3423 */
3424 int (*enable_protect_frames)(void *priv, Boolean enabled);
3425
3426 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08003427 * enable_encrypt - Set encryption status
3428 * @priv: Private driver interface data
3429 * @enabled: TRUE = encrypt outgoing traffic
3430 * FALSE = integrity-only protection on outgoing traffic
3431 * Returns: 0 on success, -1 on failure (or if not supported)
3432 */
3433 int (*enable_encrypt)(void *priv, Boolean enabled);
3434
3435 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003436 * set_replay_protect - Set replay protect status and window size
3437 * @priv: Private driver interface data
3438 * @enabled: TRUE = replay protect enabled
3439 * FALSE = replay protect disabled
3440 * @window: replay window size, valid only when replay protect enabled
3441 * Returns: 0 on success, -1 on failure (or if not supported)
3442 */
3443 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3444
3445 /**
3446 * set_current_cipher_suite - Set current cipher suite
3447 * @priv: Private driver interface data
3448 * @cs: EUI64 identifier
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003449 * Returns: 0 on success, -1 on failure (or if not supported)
3450 */
Dmitry Shmidt7d175302016-09-06 13:11:34 -07003451 int (*set_current_cipher_suite)(void *priv, u64 cs);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003452
3453 /**
3454 * enable_controlled_port - Set controlled port status
3455 * @priv: Private driver interface data
3456 * @enabled: TRUE = controlled port enabled
3457 * FALSE = controlled port disabled
3458 * Returns: 0 on success, -1 on failure (or if not supported)
3459 */
3460 int (*enable_controlled_port)(void *priv, Boolean enabled);
3461
3462 /**
3463 * get_receive_lowest_pn - Get receive lowest pn
3464 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003465 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003466 * Returns: 0 on success, -1 on failure (or if not supported)
3467 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003468 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003469
3470 /**
3471 * get_transmit_next_pn - Get transmit next pn
3472 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003473 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003474 * Returns: 0 on success, -1 on failure (or if not supported)
3475 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003476 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003477
3478 /**
3479 * set_transmit_next_pn - Set transmit next pn
3480 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003481 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003482 * Returns: 0 on success, -1 on failure (or if not supported)
3483 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003484 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003485
3486 /**
3487 * create_receive_sc - create secure channel for receiving
3488 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003489 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003490 * @conf_offset: confidentiality offset (0, 30, or 50)
3491 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3492 * 2 = Strict)
3493 * Returns: 0 on success, -1 on failure (or if not supported)
3494 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003495 int (*create_receive_sc)(void *priv, struct receive_sc *sc,
3496 unsigned int conf_offset,
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003497 int validation);
3498
3499 /**
3500 * delete_receive_sc - delete secure connection for receiving
3501 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003502 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003503 * Returns: 0 on success, -1 on failure
3504 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003505 int (*delete_receive_sc)(void *priv, struct receive_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003506
3507 /**
3508 * create_receive_sa - create secure association for receive
3509 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003510 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003511 * Returns: 0 on success, -1 on failure
3512 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003513 int (*create_receive_sa)(void *priv, struct receive_sa *sa);
3514
3515 /**
3516 * delete_receive_sa - Delete secure association for receive
3517 * @priv: Private driver interface data from init()
3518 * @sa: Secure association
3519 * Returns: 0 on success, -1 on failure
3520 */
3521 int (*delete_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003522
3523 /**
3524 * enable_receive_sa - enable the SA for receive
3525 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003526 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003527 * Returns: 0 on success, -1 on failure
3528 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003529 int (*enable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003530
3531 /**
3532 * disable_receive_sa - disable SA for receive
3533 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003534 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003535 * Returns: 0 on success, -1 on failure
3536 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003537 int (*disable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003538
3539 /**
3540 * create_transmit_sc - create secure connection for transmit
3541 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003542 * @sc: secure channel
3543 * @conf_offset: confidentiality offset (0, 30, or 50)
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003544 * Returns: 0 on success, -1 on failure
3545 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003546 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
3547 unsigned int conf_offset);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003548
3549 /**
3550 * delete_transmit_sc - delete secure connection for transmit
3551 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003552 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003553 * Returns: 0 on success, -1 on failure
3554 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003555 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003556
3557 /**
3558 * create_transmit_sa - create secure association for transmit
3559 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003560 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003561 * Returns: 0 on success, -1 on failure
3562 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003563 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);
3564
3565 /**
3566 * delete_transmit_sa - Delete secure association for transmit
3567 * @priv: Private driver interface data from init()
3568 * @sa: Secure association
3569 * Returns: 0 on success, -1 on failure
3570 */
3571 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003572
3573 /**
3574 * enable_transmit_sa - enable SA for transmit
3575 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003576 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003577 * Returns: 0 on success, -1 on failure
3578 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003579 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003580
3581 /**
3582 * disable_transmit_sa - disable SA for transmit
3583 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003584 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003585 * Returns: 0 on success, -1 on failure
3586 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003587 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003588#endif /* CONFIG_MACSEC */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003589
3590 /**
3591 * init_mesh - Driver specific initialization for mesh
3592 * @priv: Private driver interface data
3593 * Returns: 0 on success, -1 on failure
3594 */
3595 int (*init_mesh)(void *priv);
3596
3597 /**
3598 * join_mesh - Join a mesh network
3599 * @priv: Private driver interface data
3600 * @params: Mesh configuration parameters
3601 * Returns: 0 on success, -1 on failure
3602 */
3603 int (*join_mesh)(void *priv,
3604 struct wpa_driver_mesh_join_params *params);
3605
3606 /**
3607 * leave_mesh - Leave a mesh network
3608 * @priv: Private driver interface data
3609 * Returns 0 on success, -1 on failure
3610 */
3611 int (*leave_mesh)(void *priv);
3612
3613 /**
3614 * do_acs - Automatically select channel
3615 * @priv: Private driver interface data
3616 * @params: Parameters for ACS
3617 * Returns 0 on success, -1 on failure
3618 *
3619 * This command can be used to offload ACS to the driver if the driver
3620 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3621 */
3622 int (*do_acs)(void *priv, struct drv_acs_params *params);
Ravi Joshie6ccb162015-07-16 17:45:41 -07003623
3624 /**
3625 * set_band - Notify driver of band selection
3626 * @priv: Private driver interface data
3627 * @band: The selected band(s)
3628 * Returns 0 on success, -1 on failure
3629 */
3630 int (*set_band)(void *priv, enum set_band band);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08003631
3632 /**
3633 * get_pref_freq_list - Get preferred frequency list for an interface
3634 * @priv: Private driver interface data
3635 * @if_type: Interface type
3636 * @num: Number of channels
3637 * @freq_list: Preferred channel frequency list encoded in MHz values
3638 * Returns 0 on success, -1 on failure
3639 *
3640 * This command can be used to query the preferred frequency list from
3641 * the driver specific to a particular interface type.
3642 */
3643 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
3644 unsigned int *num, unsigned int *freq_list);
3645
3646 /**
3647 * set_prob_oper_freq - Indicate probable P2P operating channel
3648 * @priv: Private driver interface data
3649 * @freq: Channel frequency in MHz
3650 * Returns 0 on success, -1 on failure
3651 *
3652 * This command can be used to inform the driver of the operating
3653 * frequency that an ongoing P2P group formation is likely to come up
3654 * on. Local device is assuming P2P Client role.
3655 */
3656 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003657
3658 /**
3659 * abort_scan - Request the driver to abort an ongoing scan
3660 * @priv: Private driver interface data
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08003661 * @scan_cookie: Cookie identifying the scan request. This is used only
3662 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
3663 * was used to trigger scan. Otherwise, 0 is used.
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003664 * Returns 0 on success, -1 on failure
3665 */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08003666 int (*abort_scan)(void *priv, u64 scan_cookie);
Dmitry Shmidt849734c2016-05-27 09:59:01 -07003667
3668 /**
3669 * configure_data_frame_filters - Request to configure frame filters
3670 * @priv: Private driver interface data
3671 * @filter_flags: The type of frames to filter (bitfield of
3672 * WPA_DATA_FRAME_FILTER_FLAG_*)
3673 * Returns: 0 on success or -1 on failure
3674 */
3675 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07003676
3677 /**
3678 * get_ext_capab - Get extended capabilities for the specified interface
3679 * @priv: Private driver interface data
3680 * @type: Interface type for which to get extended capabilities
3681 * @ext_capab: Extended capabilities fetched
3682 * @ext_capab_mask: Extended capabilities mask
3683 * @ext_capab_len: Length of the extended capabilities
3684 * Returns: 0 on success or -1 on failure
3685 */
3686 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
3687 const u8 **ext_capab, const u8 **ext_capab_mask,
3688 unsigned int *ext_capab_len);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07003689
3690 /**
3691 * p2p_lo_start - Start offloading P2P listen to device
3692 * @priv: Private driver interface data
3693 * @freq: Listening frequency (MHz) for P2P listen
3694 * @period: Length of the listen operation in milliseconds
3695 * @interval: Interval for running the listen operation in milliseconds
3696 * @count: Number of times to run the listen operation
3697 * @device_types: Device primary and secondary types
3698 * @dev_types_len: Number of bytes for device_types
3699 * @ies: P2P IE and WSC IE for Probe Response frames
3700 * @ies_len: Length of ies in bytes
3701 * Returns: 0 on success or -1 on failure
3702 */
3703 int (*p2p_lo_start)(void *priv, unsigned int freq,
3704 unsigned int period, unsigned int interval,
3705 unsigned int count,
3706 const u8 *device_types, size_t dev_types_len,
3707 const u8 *ies, size_t ies_len);
3708
3709 /**
3710 * p2p_lo_stop - Stop P2P listen offload
3711 * @priv: Private driver interface data
3712 * Returns: 0 on success or -1 on failure
3713 */
3714 int (*p2p_lo_stop)(void *priv);
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07003715
3716 /**
3717 * set_default_scan_ies - Set default scan IEs
3718 * @priv: Private driver interface data
3719 * @ies: Scan default IEs buffer
3720 * @ies_len: Length of IEs in bytes
3721 * Returns: 0 on success or -1 on failure
3722 *
3723 * The driver can use these by default when there are no scan IEs coming
3724 * in the subsequent scan requests. Also in case of one or more of IEs
3725 * given in set_default_scan_ies() are missing in the subsequent scan
3726 * request, the driver should merge the missing scan IEs in the scan
3727 * request from the IEs set by set_default_scan_ies() in the Probe
3728 * Request frames sent.
3729 */
3730 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
3731
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003732 /**
3733 * set_tdls_mode - Set TDLS trigger mode to the host driver
3734 * @priv: Private driver interface data
3735 * @tdls_external_control: Represents if TDLS external trigger control
3736 * mode is enabled/disabled.
3737 *
3738 * This optional callback can be used to configure the TDLS external
3739 * trigger control mode to the host driver.
3740 */
3741 int (*set_tdls_mode)(void *priv, int tdls_external_control);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003742};
3743
3744
3745/**
3746 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3747 */
3748enum wpa_event_type {
3749 /**
3750 * EVENT_ASSOC - Association completed
3751 *
3752 * This event needs to be delivered when the driver completes IEEE
3753 * 802.11 association or reassociation successfully.
3754 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3755 * after this event has been generated. In addition, optional
3756 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3757 * more information about the association. If the driver interface gets
3758 * both of these events at the same time, it can also include the
3759 * assoc_info data in EVENT_ASSOC call.
3760 */
3761 EVENT_ASSOC,
3762
3763 /**
3764 * EVENT_DISASSOC - Association lost
3765 *
3766 * This event should be called when association is lost either due to
3767 * receiving deauthenticate or disassociate frame from the AP or when
3768 * sending either of these frames to the current AP. If the driver
3769 * supports separate deauthentication event, EVENT_DISASSOC should only
3770 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3771 * In AP mode, union wpa_event_data::disassoc_info is required.
3772 */
3773 EVENT_DISASSOC,
3774
3775 /**
3776 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3777 *
3778 * This event must be delivered when a Michael MIC error is detected by
3779 * the local driver. Additional data for event processing is
3780 * provided with union wpa_event_data::michael_mic_failure. This
3781 * information is used to request new encyption key and to initiate
3782 * TKIP countermeasures if needed.
3783 */
3784 EVENT_MICHAEL_MIC_FAILURE,
3785
3786 /**
3787 * EVENT_SCAN_RESULTS - Scan results available
3788 *
3789 * This event must be called whenever scan results are available to be
3790 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3791 * is expected to be used some time after struct wpa_driver_ops::scan()
3792 * is called. If the driver provides an unsolicited event when the scan
3793 * has been completed, this event can be used to trigger
3794 * EVENT_SCAN_RESULTS call. If such event is not available from the
3795 * driver, the driver wrapper code is expected to use a registered
3796 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3797 * scan is expected to be completed. Optional information about
3798 * completed scan can be provided with union wpa_event_data::scan_info.
3799 */
3800 EVENT_SCAN_RESULTS,
3801
3802 /**
3803 * EVENT_ASSOCINFO - Report optional extra information for association
3804 *
3805 * This event can be used to report extra association information for
3806 * EVENT_ASSOC processing. This extra information includes IEs from
3807 * association frames and Beacon/Probe Response frames in union
3808 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3809 * EVENT_ASSOC. Alternatively, the driver interface can include
3810 * assoc_info data in the EVENT_ASSOC call if it has all the
3811 * information available at the same point.
3812 */
3813 EVENT_ASSOCINFO,
3814
3815 /**
3816 * EVENT_INTERFACE_STATUS - Report interface status changes
3817 *
3818 * This optional event can be used to report changes in interface
3819 * status (interface added/removed) using union
3820 * wpa_event_data::interface_status. This can be used to trigger
3821 * wpa_supplicant to stop and re-start processing for the interface,
3822 * e.g., when a cardbus card is ejected/inserted.
3823 */
3824 EVENT_INTERFACE_STATUS,
3825
3826 /**
3827 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3828 *
3829 * This event can be used to inform wpa_supplicant about candidates for
3830 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3831 * for scan request (ap_scan=2 mode), this event is required for
3832 * pre-authentication. If wpa_supplicant is performing scan request
3833 * (ap_scan=1), this event is optional since scan results can be used
3834 * to add pre-authentication candidates. union
3835 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3836 * candidate and priority of the candidate, e.g., based on the signal
3837 * strength, in order to try to pre-authenticate first with candidates
3838 * that are most likely targets for re-association.
3839 *
3840 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3841 * on the candidate list. In addition, it can be called for the current
3842 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3843 * will automatically skip pre-authentication in cases where a valid
3844 * PMKSA exists. When more than one candidate exists, this event should
3845 * be generated once for each candidate.
3846 *
3847 * Driver will be notified about successful pre-authentication with
3848 * struct wpa_driver_ops::add_pmkid() calls.
3849 */
3850 EVENT_PMKID_CANDIDATE,
3851
3852 /**
3853 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3854 *
3855 * This event can be used to inform wpa_supplicant about desire to set
3856 * up secure direct link connection between two stations as defined in
3857 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3858 * STAKey negotiation. The caller will need to set peer address for the
3859 * event.
3860 */
3861 EVENT_STKSTART,
3862
3863 /**
3864 * EVENT_TDLS - Request TDLS operation
3865 *
3866 * This event can be used to request a TDLS operation to be performed.
3867 */
3868 EVENT_TDLS,
3869
3870 /**
3871 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3872 *
3873 * The driver is expected to report the received FT IEs from
3874 * FT authentication sequence from the AP. The FT IEs are included in
3875 * the extra information in union wpa_event_data::ft_ies.
3876 */
3877 EVENT_FT_RESPONSE,
3878
3879 /**
3880 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3881 *
3882 * The driver can use this event to inform wpa_supplicant about a STA
3883 * in an IBSS with which protected frames could be exchanged. This
3884 * event starts RSN authentication with the other STA to authenticate
3885 * the STA and set up encryption keys with it.
3886 */
3887 EVENT_IBSS_RSN_START,
3888
3889 /**
3890 * EVENT_AUTH - Authentication result
3891 *
3892 * This event should be called when authentication attempt has been
3893 * completed. This is only used if the driver supports separate
3894 * authentication step (struct wpa_driver_ops::authenticate).
3895 * Information about authentication result is included in
3896 * union wpa_event_data::auth.
3897 */
3898 EVENT_AUTH,
3899
3900 /**
3901 * EVENT_DEAUTH - Authentication lost
3902 *
3903 * This event should be called when authentication is lost either due
3904 * to receiving deauthenticate frame from the AP or when sending that
3905 * frame to the current AP.
3906 * In AP mode, union wpa_event_data::deauth_info is required.
3907 */
3908 EVENT_DEAUTH,
3909
3910 /**
3911 * EVENT_ASSOC_REJECT - Association rejected
3912 *
3913 * This event should be called when (re)association attempt has been
3914 * rejected by the AP. Information about the association response is
3915 * included in union wpa_event_data::assoc_reject.
3916 */
3917 EVENT_ASSOC_REJECT,
3918
3919 /**
3920 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3921 */
3922 EVENT_AUTH_TIMED_OUT,
3923
3924 /**
3925 * EVENT_ASSOC_TIMED_OUT - Association timed out
3926 */
3927 EVENT_ASSOC_TIMED_OUT,
3928
3929 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003930 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3931 */
3932 EVENT_WPS_BUTTON_PUSHED,
3933
3934 /**
3935 * EVENT_TX_STATUS - Report TX status
3936 */
3937 EVENT_TX_STATUS,
3938
3939 /**
3940 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3941 */
3942 EVENT_RX_FROM_UNKNOWN,
3943
3944 /**
3945 * EVENT_RX_MGMT - Report RX of a management frame
3946 */
3947 EVENT_RX_MGMT,
3948
3949 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003950 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3951 *
3952 * This event is used to indicate when the driver has started the
3953 * requested remain-on-channel duration. Information about the
3954 * operation is included in union wpa_event_data::remain_on_channel.
3955 */
3956 EVENT_REMAIN_ON_CHANNEL,
3957
3958 /**
3959 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3960 *
3961 * This event is used to indicate when the driver has completed
3962 * remain-on-channel duration, i.e., may noot be available on the
3963 * requested channel anymore. Information about the
3964 * operation is included in union wpa_event_data::remain_on_channel.
3965 */
3966 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3967
3968 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003969 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3970 *
3971 * This event is used to indicate when a Probe Request frame has been
3972 * received. Information about the received frame is included in
3973 * union wpa_event_data::rx_probe_req. The driver is required to report
3974 * these events only after successfully completed probe_req_report()
3975 * commands to request the events (i.e., report parameter is non-zero)
3976 * in station mode. In AP mode, Probe Request frames should always be
3977 * reported.
3978 */
3979 EVENT_RX_PROBE_REQ,
3980
3981 /**
3982 * EVENT_NEW_STA - New wired device noticed
3983 *
3984 * This event is used to indicate that a new device has been detected
3985 * in a network that does not use association-like functionality (i.e.,
3986 * mainly wired Ethernet). This can be used to start EAPOL
3987 * authenticator when receiving a frame from a device. The address of
3988 * the device is included in union wpa_event_data::new_sta.
3989 */
3990 EVENT_NEW_STA,
3991
3992 /**
3993 * EVENT_EAPOL_RX - Report received EAPOL frame
3994 *
3995 * When in AP mode with hostapd, this event is required to be used to
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003996 * deliver the receive EAPOL frames from the driver.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003997 */
3998 EVENT_EAPOL_RX,
3999
4000 /**
4001 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4002 *
4003 * This event is used to indicate changes in the signal strength
4004 * observed in frames received from the current AP if signal strength
4005 * monitoring has been enabled with signal_monitor().
4006 */
4007 EVENT_SIGNAL_CHANGE,
4008
4009 /**
4010 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4011 *
4012 * This event is used to indicate that the interface was enabled after
4013 * having been previously disabled, e.g., due to rfkill.
4014 */
4015 EVENT_INTERFACE_ENABLED,
4016
4017 /**
4018 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4019 *
4020 * This event is used to indicate that the interface was disabled,
4021 * e.g., due to rfkill.
4022 */
4023 EVENT_INTERFACE_DISABLED,
4024
4025 /**
4026 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4027 *
4028 * This event is used to indicate that the channel list has changed,
4029 * e.g., because of a regulatory domain change triggered by scan
4030 * results including an AP advertising a country code.
4031 */
4032 EVENT_CHANNEL_LIST_CHANGED,
4033
4034 /**
4035 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4036 *
4037 * This event is used to indicate that the driver cannot maintain this
4038 * interface in its operation mode anymore. The most likely use for
4039 * this is to indicate that AP mode operation is not available due to
4040 * operating channel would need to be changed to a DFS channel when
4041 * the driver does not support radar detection and another virtual
4042 * interfaces caused the operating channel to change. Other similar
4043 * resource conflicts could also trigger this for station mode
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07004044 * interfaces. This event can be propagated when channel switching
4045 * fails.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004046 */
4047 EVENT_INTERFACE_UNAVAILABLE,
4048
4049 /**
4050 * EVENT_BEST_CHANNEL
4051 *
4052 * Driver generates this event whenever it detects a better channel
4053 * (e.g., based on RSSI or channel use). This information can be used
4054 * to improve channel selection for a new AP/P2P group.
4055 */
4056 EVENT_BEST_CHANNEL,
4057
4058 /**
4059 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4060 *
4061 * This event should be called when a Deauthentication frame is dropped
4062 * due to it not being protected (MFP/IEEE 802.11w).
4063 * union wpa_event_data::unprot_deauth is required to provide more
4064 * details of the frame.
4065 */
4066 EVENT_UNPROT_DEAUTH,
4067
4068 /**
4069 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4070 *
4071 * This event should be called when a Disassociation frame is dropped
4072 * due to it not being protected (MFP/IEEE 802.11w).
4073 * union wpa_event_data::unprot_disassoc is required to provide more
4074 * details of the frame.
4075 */
4076 EVENT_UNPROT_DISASSOC,
4077
4078 /**
4079 * EVENT_STATION_LOW_ACK
4080 *
4081 * Driver generates this event whenever it detected that a particular
4082 * station was lost. Detection can be through massive transmission
4083 * failures for example.
4084 */
4085 EVENT_STATION_LOW_ACK,
4086
4087 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004088 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4089 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004090 EVENT_IBSS_PEER_LOST,
4091
4092 /**
4093 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4094 *
4095 * This event carries the new replay counter to notify wpa_supplicant
4096 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4097 * completed Group Key Handshake while the host (including
4098 * wpa_supplicant was sleeping).
4099 */
4100 EVENT_DRIVER_GTK_REKEY,
4101
4102 /**
4103 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4104 */
4105 EVENT_SCHED_SCAN_STOPPED,
4106
4107 /**
4108 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4109 *
4110 * This event indicates that the station responded to the poll
4111 * initiated with @poll_client.
4112 */
4113 EVENT_DRIVER_CLIENT_POLL_OK,
4114
4115 /**
4116 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4117 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07004118 EVENT_EAPOL_TX_STATUS,
4119
4120 /**
4121 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4122 *
4123 * Described in wpa_event_data.ch_switch
4124 * */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004125 EVENT_CH_SWITCH,
4126
4127 /**
4128 * EVENT_WNM - Request WNM operation
4129 *
4130 * This event can be used to request a WNM operation to be performed.
4131 */
Dmitry Shmidtf8623282013-02-20 14:34:59 -08004132 EVENT_WNM,
4133
4134 /**
4135 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4136 *
4137 * This event indicates that the driver reported a connection failure
4138 * with the specified client (for example, max client reached, etc.) in
4139 * AP mode.
4140 */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004141 EVENT_CONNECT_FAILED_REASON,
4142
4143 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004144 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004145 *
4146 * A radar has been detected on the supplied frequency, hostapd should
4147 * react accordingly (e.g., change channel).
4148 */
4149 EVENT_DFS_RADAR_DETECTED,
4150
4151 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004152 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004153 *
4154 * After a successful CAC, the channel can be marked clear and used.
4155 */
4156 EVENT_DFS_CAC_FINISHED,
4157
4158 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004159 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004160 *
4161 * The CAC was not successful, and the channel remains in the previous
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004162 * state. This may happen due to a radar being detected or other
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004163 * external influences.
4164 */
4165 EVENT_DFS_CAC_ABORTED,
4166
4167 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004168 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004169 *
4170 * The channel which was previously unavailable is now available again.
4171 */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004172 EVENT_DFS_NOP_FINISHED,
4173
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08004174 /**
4175 * EVENT_SURVEY - Received survey data
4176 *
4177 * This event gets triggered when a driver query is issued for survey
4178 * data and the requested data becomes available. The returned data is
4179 * stored in struct survey_results. The results provide at most one
4180 * survey entry for each frequency and at minimum will provide one
4181 * survey entry for one frequency. The survey data can be os_malloc()'d
4182 * and then os_free()'d, so the event callback must only copy data.
4183 */
4184 EVENT_SURVEY,
4185
4186 /**
4187 * EVENT_SCAN_STARTED - Scan started
4188 *
4189 * This indicates that driver has started a scan operation either based
4190 * on a request from wpa_supplicant/hostapd or from another application.
4191 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4192 * completed (either successfully or by getting cancelled).
4193 */
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08004194 EVENT_SCAN_STARTED,
4195
4196 /**
4197 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4198 *
4199 * This event indicates a set of frequency ranges that should be avoided
4200 * to reduce issues due to interference or internal co-existence
4201 * information in the driver.
4202 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004203 EVENT_AVOID_FREQUENCIES,
4204
4205 /**
4206 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4207 */
4208 EVENT_NEW_PEER_CANDIDATE,
4209
4210 /**
4211 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4212 *
4213 * Indicates a pair of primary and secondary channels chosen by ACS
4214 * in device.
4215 */
4216 EVENT_ACS_CHANNEL_SELECTED,
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004217
4218 /**
4219 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4220 * been started.
4221 *
4222 * This event indicates that channel availability check has been started
4223 * on a DFS frequency by a driver that supports DFS Offload.
4224 */
4225 EVENT_DFS_CAC_STARTED,
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004226
4227 /**
4228 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4229 */
4230 EVENT_P2P_LO_STOP,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004231};
4232
4233
4234/**
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004235 * struct freq_survey - Channel survey info
4236 *
4237 * @ifidx: Interface index in which this survey was observed
4238 * @freq: Center of frequency of the surveyed channel
4239 * @nf: Channel noise floor in dBm
4240 * @channel_time: Amount of time in ms the radio spent on the channel
4241 * @channel_time_busy: Amount of time in ms the radio detected some signal
4242 * that indicated to the radio the channel was not clear
4243 * @channel_time_rx: Amount of time the radio spent receiving data
4244 * @channel_time_tx: Amount of time the radio spent transmitting data
4245 * @filled: bitmask indicating which fields have been reported, see
4246 * SURVEY_HAS_* defines.
4247 * @list: Internal list pointers
4248 */
4249struct freq_survey {
4250 u32 ifidx;
4251 unsigned int freq;
4252 s8 nf;
4253 u64 channel_time;
4254 u64 channel_time_busy;
4255 u64 channel_time_rx;
4256 u64 channel_time_tx;
4257 unsigned int filled;
4258 struct dl_list list;
4259};
4260
4261#define SURVEY_HAS_NF BIT(0)
4262#define SURVEY_HAS_CHAN_TIME BIT(1)
4263#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4264#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4265#define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4266
4267
4268/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004269 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4270 */
4271union wpa_event_data {
4272 /**
4273 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4274 *
4275 * This structure is optional for EVENT_ASSOC calls and required for
4276 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4277 * driver interface does not need to generate separate EVENT_ASSOCINFO
4278 * calls.
4279 */
4280 struct assoc_info {
4281 /**
4282 * reassoc - Flag to indicate association or reassociation
4283 */
4284 int reassoc;
4285
4286 /**
4287 * req_ies - (Re)Association Request IEs
4288 *
4289 * If the driver generates WPA/RSN IE, this event data must be
4290 * returned for WPA handshake to have needed information. If
4291 * wpa_supplicant-generated WPA/RSN IE is used, this
4292 * information event is optional.
4293 *
4294 * This should start with the first IE (fixed fields before IEs
4295 * are not included).
4296 */
4297 const u8 *req_ies;
4298
4299 /**
4300 * req_ies_len - Length of req_ies in bytes
4301 */
4302 size_t req_ies_len;
4303
4304 /**
4305 * resp_ies - (Re)Association Response IEs
4306 *
4307 * Optional association data from the driver. This data is not
4308 * required WPA, but may be useful for some protocols and as
4309 * such, should be reported if this is available to the driver
4310 * interface.
4311 *
4312 * This should start with the first IE (fixed fields before IEs
4313 * are not included).
4314 */
4315 const u8 *resp_ies;
4316
4317 /**
4318 * resp_ies_len - Length of resp_ies in bytes
4319 */
4320 size_t resp_ies_len;
4321
4322 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004323 * resp_frame - (Re)Association Response frame
4324 */
4325 const u8 *resp_frame;
4326
4327 /**
4328 * resp_frame_len - (Re)Association Response frame length
4329 */
4330 size_t resp_frame_len;
4331
4332 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004333 * beacon_ies - Beacon or Probe Response IEs
4334 *
4335 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4336 * Probe Response frames from the current AP (i.e., the one
4337 * that the client just associated with). This information is
4338 * used to update WPA/RSN IE for the AP. If this field is not
4339 * set, the results from previous scan will be used. If no
4340 * data for the new AP is found, scan results will be requested
4341 * again (without scan request). At this point, the driver is
4342 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4343 * used).
4344 *
4345 * This should start with the first IE (fixed fields before IEs
4346 * are not included).
4347 */
4348 const u8 *beacon_ies;
4349
4350 /**
4351 * beacon_ies_len - Length of beacon_ies */
4352 size_t beacon_ies_len;
4353
4354 /**
4355 * freq - Frequency of the operational channel in MHz
4356 */
4357 unsigned int freq;
4358
4359 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004360 * wmm_params - WMM parameters used in this association.
4361 */
4362 struct wmm_params wmm_params;
4363
4364 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004365 * addr - Station address (for AP mode)
4366 */
4367 const u8 *addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004368
4369 /**
4370 * The following is the key management offload information
4371 * @authorized
4372 * @key_replay_ctr
4373 * @key_replay_ctr_len
4374 * @ptk_kck
4375 * @ptk_kek_len
4376 * @ptk_kek
4377 * @ptk_kek_len
4378 */
4379
4380 /**
4381 * authorized - Status of key management offload,
4382 * 1 = successful
4383 */
4384 int authorized;
4385
4386 /**
4387 * key_replay_ctr - Key replay counter value last used
4388 * in a valid EAPOL-Key frame
4389 */
4390 const u8 *key_replay_ctr;
4391
4392 /**
4393 * key_replay_ctr_len - The length of key_replay_ctr
4394 */
4395 size_t key_replay_ctr_len;
4396
4397 /**
4398 * ptk_kck - The derived PTK KCK
4399 */
4400 const u8 *ptk_kck;
4401
4402 /**
4403 * ptk_kek_len - The length of ptk_kck
4404 */
4405 size_t ptk_kck_len;
4406
4407 /**
4408 * ptk_kek - The derived PTK KEK
4409 */
4410 const u8 *ptk_kek;
4411
4412 /**
4413 * ptk_kek_len - The length of ptk_kek
4414 */
4415 size_t ptk_kek_len;
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004416
4417 /**
4418 * subnet_status - The subnet status:
4419 * 0 = unknown, 1 = unchanged, 2 = changed
4420 */
4421 u8 subnet_status;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004422 } assoc_info;
4423
4424 /**
4425 * struct disassoc_info - Data for EVENT_DISASSOC events
4426 */
4427 struct disassoc_info {
4428 /**
4429 * addr - Station address (for AP mode)
4430 */
4431 const u8 *addr;
4432
4433 /**
4434 * reason_code - Reason Code (host byte order) used in
4435 * Deauthentication frame
4436 */
4437 u16 reason_code;
4438
4439 /**
4440 * ie - Optional IE(s) in Disassociation frame
4441 */
4442 const u8 *ie;
4443
4444 /**
4445 * ie_len - Length of ie buffer in octets
4446 */
4447 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08004448
4449 /**
4450 * locally_generated - Whether the frame was locally generated
4451 */
4452 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004453 } disassoc_info;
4454
4455 /**
4456 * struct deauth_info - Data for EVENT_DEAUTH events
4457 */
4458 struct deauth_info {
4459 /**
4460 * addr - Station address (for AP mode)
4461 */
4462 const u8 *addr;
4463
4464 /**
4465 * reason_code - Reason Code (host byte order) used in
4466 * Deauthentication frame
4467 */
4468 u16 reason_code;
4469
4470 /**
4471 * ie - Optional IE(s) in Deauthentication frame
4472 */
4473 const u8 *ie;
4474
4475 /**
4476 * ie_len - Length of ie buffer in octets
4477 */
4478 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08004479
4480 /**
4481 * locally_generated - Whether the frame was locally generated
4482 */
4483 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004484 } deauth_info;
4485
4486 /**
4487 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4488 */
4489 struct michael_mic_failure {
4490 int unicast;
4491 const u8 *src;
4492 } michael_mic_failure;
4493
4494 /**
4495 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4496 */
4497 struct interface_status {
Dmitry Shmidte4663042016-04-04 10:07:49 -07004498 unsigned int ifindex;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004499 char ifname[100];
4500 enum {
4501 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4502 } ievent;
4503 } interface_status;
4504
4505 /**
4506 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4507 */
4508 struct pmkid_candidate {
4509 /** BSSID of the PMKID candidate */
4510 u8 bssid[ETH_ALEN];
4511 /** Smaller the index, higher the priority */
4512 int index;
4513 /** Whether RSN IE includes pre-authenticate flag */
4514 int preauth;
4515 } pmkid_candidate;
4516
4517 /**
4518 * struct stkstart - Data for EVENT_STKSTART
4519 */
4520 struct stkstart {
4521 u8 peer[ETH_ALEN];
4522 } stkstart;
4523
4524 /**
4525 * struct tdls - Data for EVENT_TDLS
4526 */
4527 struct tdls {
4528 u8 peer[ETH_ALEN];
4529 enum {
4530 TDLS_REQUEST_SETUP,
Dmitry Shmidt4dd28dc2015-03-10 11:21:43 -07004531 TDLS_REQUEST_TEARDOWN,
4532 TDLS_REQUEST_DISCOVER,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004533 } oper;
4534 u16 reason_code; /* for teardown */
4535 } tdls;
4536
4537 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004538 * struct wnm - Data for EVENT_WNM
4539 */
4540 struct wnm {
4541 u8 addr[ETH_ALEN];
4542 enum {
4543 WNM_OPER_SLEEP,
4544 } oper;
4545 enum {
4546 WNM_SLEEP_ENTER,
4547 WNM_SLEEP_EXIT
4548 } sleep_action;
4549 int sleep_intval;
4550 u16 reason_code;
4551 u8 *buf;
4552 u16 buf_len;
4553 } wnm;
4554
4555 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004556 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4557 *
4558 * During FT (IEEE 802.11r) authentication sequence, the driver is
4559 * expected to use this event to report received FT IEs (MDIE, FTIE,
4560 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4561 * IEs for the next message will be delivered through the
4562 * struct wpa_driver_ops::update_ft_ies() callback.
4563 */
4564 struct ft_ies {
4565 const u8 *ies;
4566 size_t ies_len;
4567 int ft_action;
4568 u8 target_ap[ETH_ALEN];
4569 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4570 const u8 *ric_ies;
4571 /** Length of ric_ies buffer in octets */
4572 size_t ric_ies_len;
4573 } ft_ies;
4574
4575 /**
4576 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4577 */
4578 struct ibss_rsn_start {
4579 u8 peer[ETH_ALEN];
4580 } ibss_rsn_start;
4581
4582 /**
4583 * struct auth_info - Data for EVENT_AUTH events
4584 */
4585 struct auth_info {
4586 u8 peer[ETH_ALEN];
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004587 u8 bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004588 u16 auth_type;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004589 u16 auth_transaction;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004590 u16 status_code;
4591 const u8 *ies;
4592 size_t ies_len;
4593 } auth;
4594
4595 /**
4596 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4597 */
4598 struct assoc_reject {
4599 /**
4600 * bssid - BSSID of the AP that rejected association
4601 */
4602 const u8 *bssid;
4603
4604 /**
4605 * resp_ies - (Re)Association Response IEs
4606 *
4607 * Optional association data from the driver. This data is not
4608 * required WPA, but may be useful for some protocols and as
4609 * such, should be reported if this is available to the driver
4610 * interface.
4611 *
4612 * This should start with the first IE (fixed fields before IEs
4613 * are not included).
4614 */
4615 const u8 *resp_ies;
4616
4617 /**
4618 * resp_ies_len - Length of resp_ies in bytes
4619 */
4620 size_t resp_ies_len;
4621
4622 /**
4623 * status_code - Status Code from (Re)association Response
4624 */
4625 u16 status_code;
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07004626
4627 /**
4628 * timed_out - Whether failure is due to timeout (etc.) rather
4629 * than explicit rejection response from the AP.
4630 */
4631 int timed_out;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004632 } assoc_reject;
4633
4634 struct timeout_event {
4635 u8 addr[ETH_ALEN];
4636 } timeout_event;
4637
4638 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004639 * struct tx_status - Data for EVENT_TX_STATUS events
4640 */
4641 struct tx_status {
4642 u16 type;
4643 u16 stype;
4644 const u8 *dst;
4645 const u8 *data;
4646 size_t data_len;
4647 int ack;
4648 } tx_status;
4649
4650 /**
4651 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4652 */
4653 struct rx_from_unknown {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004654 const u8 *bssid;
4655 const u8 *addr;
4656 int wds;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004657 } rx_from_unknown;
4658
4659 /**
4660 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4661 */
4662 struct rx_mgmt {
4663 const u8 *frame;
4664 size_t frame_len;
4665 u32 datarate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004666
4667 /**
Dmitry Shmidt98660862014-03-11 17:26:21 -07004668 * drv_priv - Pointer to store driver private BSS information
4669 *
4670 * If not set to NULL, this is used for comparison with
4671 * hostapd_data->drv_priv to determine which BSS should process
4672 * the frame.
4673 */
4674 void *drv_priv;
4675
4676 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004677 * freq - Frequency (in MHz) on which the frame was received
4678 */
4679 int freq;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08004680
4681 /**
4682 * ssi_signal - Signal strength in dBm (or 0 if not available)
4683 */
4684 int ssi_signal;
4685 } rx_mgmt;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004686
4687 /**
4688 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4689 *
4690 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4691 */
4692 struct remain_on_channel {
4693 /**
4694 * freq - Channel frequency in MHz
4695 */
4696 unsigned int freq;
4697
4698 /**
4699 * duration - Duration to remain on the channel in milliseconds
4700 */
4701 unsigned int duration;
4702 } remain_on_channel;
4703
4704 /**
4705 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4706 * @aborted: Whether the scan was aborted
4707 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4708 * @num_freqs: Number of entries in freqs array
4709 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4710 * SSID)
4711 * @num_ssids: Number of entries in ssids array
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004712 * @external_scan: Whether the scan info is for an external scan
4713 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
4714 * 0 if the source of the scan event is a vendor scan
Dmitry Shmidt29333592017-01-09 12:27:11 -08004715 * @scan_start_tsf: Time when the scan started in terms of TSF of the
4716 * BSS that the interface that requested the scan is connected to
4717 * (if available).
4718 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
4719 * is set.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004720 */
4721 struct scan_info {
4722 int aborted;
4723 const int *freqs;
4724 size_t num_freqs;
4725 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4726 size_t num_ssids;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004727 int external_scan;
4728 int nl_scan_event;
Dmitry Shmidt29333592017-01-09 12:27:11 -08004729 u64 scan_start_tsf;
4730 u8 scan_start_tsf_bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004731 } scan_info;
4732
4733 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004734 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4735 */
4736 struct rx_probe_req {
4737 /**
4738 * sa - Source address of the received Probe Request frame
4739 */
4740 const u8 *sa;
4741
4742 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004743 * da - Destination address of the received Probe Request frame
4744 * or %NULL if not available
4745 */
4746 const u8 *da;
4747
4748 /**
4749 * bssid - BSSID of the received Probe Request frame or %NULL
4750 * if not available
4751 */
4752 const u8 *bssid;
4753
4754 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004755 * ie - IEs from the Probe Request body
4756 */
4757 const u8 *ie;
4758
4759 /**
4760 * ie_len - Length of ie buffer in octets
4761 */
4762 size_t ie_len;
Dmitry Shmidt04949592012-07-19 12:16:46 -07004763
4764 /**
4765 * signal - signal strength in dBm (or 0 if not available)
4766 */
4767 int ssi_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004768 } rx_probe_req;
4769
4770 /**
4771 * struct new_sta - Data for EVENT_NEW_STA events
4772 */
4773 struct new_sta {
4774 const u8 *addr;
4775 } new_sta;
4776
4777 /**
4778 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4779 */
4780 struct eapol_rx {
4781 const u8 *src;
4782 const u8 *data;
4783 size_t data_len;
4784 } eapol_rx;
4785
4786 /**
4787 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4788 */
4789 struct wpa_signal_info signal_change;
4790
4791 /**
4792 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4793 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4794 * @freq_5: Best 5 GHz band channel frequency in MHz
4795 * @freq_overall: Best channel frequency in MHz
4796 *
4797 * 0 can be used to indicate no preference in either band.
4798 */
4799 struct best_channel {
4800 int freq_24;
4801 int freq_5;
4802 int freq_overall;
4803 } best_chan;
4804
4805 struct unprot_deauth {
4806 const u8 *sa;
4807 const u8 *da;
4808 u16 reason_code;
4809 } unprot_deauth;
4810
4811 struct unprot_disassoc {
4812 const u8 *sa;
4813 const u8 *da;
4814 u16 reason_code;
4815 } unprot_disassoc;
4816
4817 /**
4818 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4819 * @addr: station address
4820 */
4821 struct low_ack {
4822 u8 addr[ETH_ALEN];
4823 } low_ack;
4824
4825 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004826 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4827 */
4828 struct ibss_peer_lost {
4829 u8 peer[ETH_ALEN];
4830 } ibss_peer_lost;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004831
4832 /**
4833 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4834 */
4835 struct driver_gtk_rekey {
4836 const u8 *bssid;
4837 const u8 *replay_ctr;
4838 } driver_gtk_rekey;
4839
4840 /**
4841 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4842 * @addr: station address
4843 */
4844 struct client_poll {
4845 u8 addr[ETH_ALEN];
4846 } client_poll;
4847
4848 /**
4849 * struct eapol_tx_status
4850 * @dst: Original destination
4851 * @data: Data starting with IEEE 802.1X header (!)
4852 * @data_len: Length of data
4853 * @ack: Indicates ack or lost frame
4854 *
4855 * This corresponds to hapd_send_eapol if the frame sent
4856 * there isn't just reported as EVENT_TX_STATUS.
4857 */
4858 struct eapol_tx_status {
4859 const u8 *dst;
4860 const u8 *data;
4861 int data_len;
4862 int ack;
4863 } eapol_tx_status;
Dmitry Shmidt04949592012-07-19 12:16:46 -07004864
4865 /**
4866 * struct ch_switch
4867 * @freq: Frequency of new channel in MHz
4868 * @ht_enabled: Whether this is an HT channel
4869 * @ch_offset: Secondary channel offset
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08004870 * @ch_width: Channel width
4871 * @cf1: Center frequency 1
4872 * @cf2: Center frequency 2
Dmitry Shmidt04949592012-07-19 12:16:46 -07004873 */
4874 struct ch_switch {
4875 int freq;
4876 int ht_enabled;
4877 int ch_offset;
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08004878 enum chan_width ch_width;
4879 int cf1;
4880 int cf2;
Dmitry Shmidt04949592012-07-19 12:16:46 -07004881 } ch_switch;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08004882
4883 /**
4884 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4885 * @addr: Remote client address
4886 * @code: Reason code for connection failure
4887 */
4888 struct connect_failed_reason {
4889 u8 addr[ETH_ALEN];
4890 enum {
4891 MAX_CLIENT_REACHED,
4892 BLOCKED_CLIENT
4893 } code;
4894 } connect_failed_reason;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004895
4896 /**
4897 * struct dfs_event - Data for radar detected events
4898 * @freq: Frequency of the channel in MHz
4899 */
4900 struct dfs_event {
4901 int freq;
Dmitry Shmidt051af732013-10-22 13:52:46 -07004902 int ht_enabled;
4903 int chan_offset;
4904 enum chan_width chan_width;
4905 int cf1;
4906 int cf2;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004907 } dfs_event;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004908
4909 /**
4910 * survey_results - Survey result data for EVENT_SURVEY
4911 * @freq_filter: Requested frequency survey filter, 0 if request
4912 * was for all survey data
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004913 * @survey_list: Linked list of survey data (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004914 */
4915 struct survey_results {
4916 unsigned int freq_filter;
4917 struct dl_list survey_list; /* struct freq_survey */
4918 } survey_results;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08004919
4920 /**
4921 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4922 * @initiator: Initiator of the regulatory change
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07004923 * @type: Regulatory change type
4924 * @alpha2: Country code (or "" if not available)
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08004925 */
4926 struct channel_list_changed {
4927 enum reg_change_initiator initiator;
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07004928 enum reg_type type;
4929 char alpha2[3];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08004930 } channel_list_changed;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08004931
4932 /**
4933 * freq_range - List of frequency ranges
4934 *
4935 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4936 */
4937 struct wpa_freq_range_list freq_range;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004938
4939 /**
4940 * struct mesh_peer
4941 *
4942 * @peer: Peer address
4943 * @ies: Beacon IEs
4944 * @ie_len: Length of @ies
4945 *
4946 * Notification of new candidate mesh peer.
4947 */
4948 struct mesh_peer {
4949 const u8 *peer;
4950 const u8 *ies;
4951 size_t ie_len;
4952 } mesh_peer;
4953
4954 /**
4955 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4956 * @pri_channel: Selected primary channel
4957 * @sec_channel: Selected secondary channel
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07004958 * @vht_seg0_center_ch: VHT mode Segment0 center channel
4959 * @vht_seg1_center_ch: VHT mode Segment1 center channel
4960 * @ch_width: Selected Channel width by driver. Driver may choose to
4961 * change hostapd configured ACS channel width due driver internal
4962 * channel restrictions.
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07004963 * hw_mode: Selected band (used with hw_mode=any)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004964 */
4965 struct acs_selected_channels {
4966 u8 pri_channel;
4967 u8 sec_channel;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07004968 u8 vht_seg0_center_ch;
4969 u8 vht_seg1_center_ch;
4970 u16 ch_width;
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07004971 enum hostapd_hw_mode hw_mode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004972 } acs_selected_channels;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004973
4974 /**
4975 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
4976 * @reason_code: Reason for stopping offload
4977 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
4978 * scheduled.
4979 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
4980 * be stopped.
4981 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
4982 * parameters.
4983 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
4984 * supported by device.
4985 */
4986 struct p2p_lo_stop {
4987 enum {
4988 P2P_LO_STOPPED_REASON_COMPLETE = 0,
4989 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
4990 P2P_LO_STOPPED_REASON_INVALID_PARAM,
4991 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
4992 } reason_code;
4993 } p2p_lo_stop;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004994};
4995
4996/**
4997 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4998 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4999 * with struct wpa_driver_ops::init()
5000 * @event: event type (defined above)
5001 * @data: possible extra data for the event
5002 *
5003 * Driver wrapper code should call this function whenever an event is received
5004 * from the driver.
5005 */
5006void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
5007 union wpa_event_data *data);
5008
Dmitry Shmidte4663042016-04-04 10:07:49 -07005009/**
5010 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
5011 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5012 * with struct wpa_driver_ops::init()
5013 * @event: event type (defined above)
5014 * @data: possible extra data for the event
5015 *
5016 * Same as wpa_supplicant_event(), but we search for the interface in
5017 * wpa_global.
5018 */
5019void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
5020 union wpa_event_data *data);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005021
5022/*
5023 * The following inline functions are provided for convenience to simplify
5024 * event indication for some of the common events.
5025 */
5026
5027static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
5028 size_t ielen, int reassoc)
5029{
5030 union wpa_event_data event;
5031 os_memset(&event, 0, sizeof(event));
5032 event.assoc_info.reassoc = reassoc;
5033 event.assoc_info.req_ies = ie;
5034 event.assoc_info.req_ies_len = ielen;
5035 event.assoc_info.addr = addr;
5036 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
5037}
5038
5039static inline void drv_event_disassoc(void *ctx, const u8 *addr)
5040{
5041 union wpa_event_data event;
5042 os_memset(&event, 0, sizeof(event));
5043 event.disassoc_info.addr = addr;
5044 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
5045}
5046
5047static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
5048 size_t data_len)
5049{
5050 union wpa_event_data event;
5051 os_memset(&event, 0, sizeof(event));
5052 event.eapol_rx.src = src;
5053 event.eapol_rx.data = data;
5054 event.eapol_rx.data_len = data_len;
5055 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
5056}
5057
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005058/* driver_common.c */
5059void wpa_scan_results_free(struct wpa_scan_results *res);
5060
5061/* Convert wpa_event_type to a string for logging */
5062const char * event_to_string(enum wpa_event_type event);
5063
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07005064/* Convert chan_width to a string for logging and control interfaces */
5065const char * channel_width_to_string(enum chan_width width);
5066
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005067int ht_supported(const struct hostapd_hw_modes *mode);
5068int vht_supported(const struct hostapd_hw_modes *mode);
5069
5070struct wowlan_triggers *
5071wpa_get_wowlan_triggers(const char *wowlan_triggers,
5072 const struct wpa_driver_capa *capa);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005073/* Convert driver flag to string */
5074const char * driver_flag_to_string(u64 flag);
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005075
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005076/* NULL terminated array of linked in driver wrappers */
Dmitry Shmidt1d755d02015-04-28 10:34:29 -07005077extern const struct wpa_driver_ops *const wpa_drivers[];
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005078
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07005079
5080/* Available drivers */
5081
5082#ifdef CONFIG_DRIVER_WEXT
5083extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
5084#endif /* CONFIG_DRIVER_WEXT */
5085#ifdef CONFIG_DRIVER_NL80211
5086/* driver_nl80211.c */
5087extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
5088#endif /* CONFIG_DRIVER_NL80211 */
5089#ifdef CONFIG_DRIVER_HOSTAP
5090extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
5091#endif /* CONFIG_DRIVER_HOSTAP */
5092#ifdef CONFIG_DRIVER_BSD
5093extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
5094#endif /* CONFIG_DRIVER_BSD */
5095#ifdef CONFIG_DRIVER_OPENBSD
5096/* driver_openbsd.c */
5097extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
5098#endif /* CONFIG_DRIVER_OPENBSD */
5099#ifdef CONFIG_DRIVER_NDIS
5100extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
5101#endif /* CONFIG_DRIVER_NDIS */
5102#ifdef CONFIG_DRIVER_WIRED
5103extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
5104#endif /* CONFIG_DRIVER_WIRED */
5105#ifdef CONFIG_DRIVER_MACSEC_QCA
5106/* driver_macsec_qca.c */
5107extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
5108#endif /* CONFIG_DRIVER_MACSEC_QCA */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08005109#ifdef CONFIG_DRIVER_MACSEC_LINUX
5110/* driver_macsec_linux.c */
5111extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops;
5112#endif /* CONFIG_DRIVER_MACSEC_LINUX */
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07005113#ifdef CONFIG_DRIVER_ROBOSWITCH
5114/* driver_roboswitch.c */
5115extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
5116#endif /* CONFIG_DRIVER_ROBOSWITCH */
5117#ifdef CONFIG_DRIVER_ATHEROS
5118/* driver_atheros.c */
5119extern const struct wpa_driver_ops wpa_driver_atheros_ops;
5120#endif /* CONFIG_DRIVER_ATHEROS */
5121#ifdef CONFIG_DRIVER_NONE
5122extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
5123#endif /* CONFIG_DRIVER_NONE */
5124
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005125#endif /* DRIVER_H */