blob: 212f16ca05cc53b1fa954a08b24a45b410d08f6e [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 Shmidt8d520ff2011-05-09 14:06:53 -0700239 * @ie_len: length of the following IE field in octets
240 * @beacon_ie_len: length of the following Beacon IE field in octets
241 *
242 * This structure is used as a generic format for scan results from the
243 * driver. Each driver interface implementation is responsible for converting
244 * the driver or OS specific scan results into this format.
245 *
246 * If the driver does not support reporting all IEs, the IE data structure is
247 * constructed of the IEs that are available. This field will also need to
248 * include SSID in IE format. All drivers are encouraged to be extended to
249 * report all IEs to make it easier to support future additions.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800250 *
251 * This structure data is followed by ie_len octets of IEs from Probe Response
252 * frame (or if the driver does not indicate source of IEs, these may also be
253 * from Beacon frame). After the first set of IEs, another set of IEs may follow
254 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700255 */
256struct wpa_scan_res {
257 unsigned int flags;
258 u8 bssid[ETH_ALEN];
259 int freq;
260 u16 beacon_int;
261 u16 caps;
262 int qual;
263 int noise;
264 int level;
265 u64 tsf;
266 unsigned int age;
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800267 unsigned int est_throughput;
268 int snr;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700269 size_t ie_len;
270 size_t beacon_ie_len;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800271 /* Followed by ie_len + beacon_ie_len octets of IE data */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700272};
273
274/**
275 * struct wpa_scan_results - Scan results
276 * @res: Array of pointers to allocated variable length scan result entries
277 * @num: Number of entries in the scan result array
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800278 * @fetch_time: Time when the results were fetched from the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700279 */
280struct wpa_scan_results {
281 struct wpa_scan_res **res;
282 size_t num;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800283 struct os_reltime fetch_time;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700284};
285
286/**
287 * struct wpa_interface_info - Network interface information
288 * @next: Pointer to the next interface or NULL if this is the last one
289 * @ifname: Interface name that can be used with init() or init2()
290 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
291 * not available
292 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
293 * is not an allocated copy, i.e., get_interfaces() caller will not free
294 * this)
295 */
296struct wpa_interface_info {
297 struct wpa_interface_info *next;
298 char *ifname;
299 char *desc;
300 const char *drv_name;
301};
302
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800303#define WPAS_MAX_SCAN_SSIDS 16
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700304
305/**
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800306 * struct wpa_driver_scan_ssid - SSIDs to scan for
307 * @ssid - specific SSID to scan for (ProbeReq)
308 * %NULL or zero-length SSID is used to indicate active scan
309 * with wildcard SSID.
310 * @ssid_len - Length of the SSID in octets
311 */
312struct wpa_driver_scan_ssid {
313 const u8 *ssid;
314 size_t ssid_len;
315};
316
317/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700318 * struct wpa_driver_scan_params - Scan parameters
319 * Data for struct wpa_driver_ops::scan2().
320 */
321struct wpa_driver_scan_params {
322 /**
323 * ssids - SSIDs to scan for
324 */
Dmitry Shmidtb97e4282016-02-08 10:16:07 -0800325 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700326
327 /**
328 * num_ssids - Number of entries in ssids array
329 * Zero indicates a request for a passive scan.
330 */
331 size_t num_ssids;
332
333 /**
334 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
335 */
336 const u8 *extra_ies;
337
338 /**
339 * extra_ies_len - Length of extra_ies in octets
340 */
341 size_t extra_ies_len;
342
343 /**
344 * freqs - Array of frequencies to scan or %NULL for all frequencies
345 *
346 * The frequency is set in MHz. The array is zero-terminated.
347 */
348 int *freqs;
349
350 /**
351 * filter_ssids - Filter for reporting SSIDs
352 *
353 * This optional parameter can be used to request the driver wrapper to
354 * filter scan results to include only the specified SSIDs. %NULL
355 * indicates that no filtering is to be done. This can be used to
356 * reduce memory needs for scan results in environments that have large
357 * number of APs with different SSIDs.
358 *
359 * The driver wrapper is allowed to take this allocated buffer into its
360 * own use by setting the pointer to %NULL. In that case, the driver
361 * wrapper is responsible for freeing the buffer with os_free() once it
362 * is not needed anymore.
363 */
364 struct wpa_driver_scan_filter {
Dmitry Shmidt9d9e6022015-04-23 10:34:55 -0700365 u8 ssid[SSID_MAX_LEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700366 size_t ssid_len;
367 } *filter_ssids;
368
369 /**
370 * num_filter_ssids - Number of entries in filter_ssids array
371 */
372 size_t num_filter_ssids;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800373
374 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700375 * filter_rssi - Filter by RSSI
376 *
377 * The driver may filter scan results in firmware to reduce host
378 * wakeups and thereby save power. Specify the RSSI threshold in s32
379 * dBm.
380 */
381 s32 filter_rssi;
382
383 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800384 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
385 *
386 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
387 * Mbps from the support rates element(s) in the Probe Request frames
388 * and not to transmit the frames at any of those rates.
389 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700390 unsigned int p2p_probe:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800391
392 /**
393 * only_new_results - Request driver to report only new results
394 *
395 * This is used to request the driver to report only BSSes that have
396 * been detected after this scan request has been started, i.e., to
397 * flush old cached BSS entries.
398 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700399 unsigned int only_new_results:1;
400
401 /**
402 * low_priority - Requests driver to use a lower scan priority
403 *
404 * This is used to request the driver to use a lower scan priority
405 * if it supports such a thing.
406 */
407 unsigned int low_priority:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800408
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800409 /**
410 * mac_addr_rand - Requests driver to randomize MAC address
411 */
412 unsigned int mac_addr_rand:1;
413
414 /**
415 * mac_addr - MAC address used with randomization. The address cannot be
416 * a multicast one, i.e., bit 0 of byte 0 should not be set.
417 */
418 const u8 *mac_addr;
419
420 /**
421 * mac_addr_mask - MAC address mask used with randomization.
422 *
423 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
424 * the mask should be taken as is from mac_addr. The mask should not
425 * allow the generation of a multicast address, i.e., bit 0 of byte 0
426 * must be set.
427 */
428 const u8 *mac_addr_mask;
429
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -0800430 /**
431 * sched_scan_plans - Scan plans for scheduled scan
432 *
433 * Each scan plan consists of the number of iterations to scan and the
434 * interval between scans. When a scan plan finishes (i.e., it was run
435 * for the specified number of iterations), the next scan plan is
436 * executed. The scan plans are executed in the order they appear in
437 * the array (lower index first). The last scan plan will run infinitely
438 * (until requested to stop), thus must not specify the number of
439 * iterations. All other scan plans must specify the number of
440 * iterations.
441 */
442 struct sched_scan_plan {
443 u32 interval; /* In seconds */
444 u32 iterations; /* Zero to run infinitely */
445 } *sched_scan_plans;
446
447 /**
448 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
449 */
450 unsigned int sched_scan_plans_num;
451
Dmitry Shmidt9c175262016-03-03 10:20:07 -0800452 /**
453 * bssid - Specific BSSID to scan for
454 *
455 * This optional parameter can be used to replace the default wildcard
456 * BSSID with a specific BSSID to scan for if results are needed from
457 * only a single BSS.
458 */
459 const u8 *bssid;
460
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800461 /**
462 * scan_cookie - Unique identification representing the scan request
463 *
464 * This scan_cookie carries a unique identification representing the
465 * scan request if the host driver/kernel supports concurrent scan
466 * requests. This cookie is returned from the corresponding driver
467 * interface.
468 *
469 * Note: Unlike other parameters in this structure, scan_cookie is used
470 * only to return information instead of setting parameters for the
471 * scan.
472 */
473 u64 scan_cookie;
474
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800475 /*
476 * NOTE: Whenever adding new parameters here, please make sure
477 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
478 * matching changes.
479 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700480};
481
482/**
483 * struct wpa_driver_auth_params - Authentication parameters
484 * Data for struct wpa_driver_ops::authenticate().
485 */
486struct wpa_driver_auth_params {
487 int freq;
488 const u8 *bssid;
489 const u8 *ssid;
490 size_t ssid_len;
491 int auth_alg;
492 const u8 *ie;
493 size_t ie_len;
494 const u8 *wep_key[4];
495 size_t wep_key_len[4];
496 int wep_tx_keyidx;
497 int local_state_change;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800498
499 /**
500 * p2p - Whether this connection is a P2P group
501 */
502 int p2p;
503
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800504 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800505 * auth_data - Additional elements for Authentication frame
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800506 *
507 * This buffer starts with the Authentication transaction sequence
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800508 * number field. If no special handling of such elements is needed, this
509 * pointer is %NULL. This is used with SAE and FILS.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800510 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800511 const u8 *auth_data;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800512
513 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800514 * auth_data_len - Length of auth_data buffer in octets
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800515 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800516 size_t auth_data_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700517};
518
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800519/**
520 * enum wps_mode - WPS mode
521 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700522enum wps_mode {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800523 /**
524 * WPS_MODE_NONE - No WPS provisioning being used
525 */
526 WPS_MODE_NONE,
527
528 /**
529 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
530 */
531 WPS_MODE_OPEN,
532
533 /**
534 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
535 */
536 WPS_MODE_PRIVACY
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700537};
538
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800539/**
540 * struct hostapd_freq_params - Channel parameters
541 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700542struct hostapd_freq_params {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800543 /**
544 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
545 */
546 enum hostapd_hw_mode mode;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700547
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800548 /**
549 * freq - Primary channel center frequency in MHz
550 */
551 int freq;
552
553 /**
554 * channel - Channel number
555 */
556 int channel;
557
558 /**
559 * ht_enabled - Whether HT is enabled
560 */
561 int ht_enabled;
562
563 /**
564 * sec_channel_offset - Secondary channel offset for HT40
565 *
566 * 0 = HT40 disabled,
567 * -1 = HT40 enabled, secondary channel below primary,
568 * 1 = HT40 enabled, secondary channel above primary
569 */
570 int sec_channel_offset;
571
572 /**
573 * vht_enabled - Whether VHT is enabled
574 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700575 int vht_enabled;
576
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800577 /**
578 * center_freq1 - Segment 0 center frequency in MHz
579 *
580 * Valid for both HT and VHT.
581 */
582 int center_freq1;
583
584 /**
585 * center_freq2 - Segment 1 center frequency in MHz
586 *
587 * Non-zero only for bandwidth 80 and an 80+80 channel
588 */
589 int center_freq2;
590
591 /**
592 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
593 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700594 int bandwidth;
595};
596
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700597/**
598 * struct wpa_driver_associate_params - Association parameters
599 * Data for struct wpa_driver_ops::associate().
600 */
601struct wpa_driver_associate_params {
602 /**
603 * bssid - BSSID of the selected AP
604 * This can be %NULL, if ap_scan=2 mode is used and the driver is
605 * responsible for selecting with which BSS to associate. */
606 const u8 *bssid;
607
608 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800609 * bssid_hint - BSSID of a proposed AP
610 *
611 * This indicates which BSS has been found a suitable candidate for
612 * initial association for drivers that use driver/firmwate-based BSS
613 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
614 * the driver from selecting other BSSes in the ESS.
615 */
616 const u8 *bssid_hint;
617
618 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700619 * ssid - The selected SSID
620 */
621 const u8 *ssid;
622
623 /**
624 * ssid_len - Length of the SSID (1..32)
625 */
626 size_t ssid_len;
627
628 /**
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700629 * freq - channel parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700630 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700631 struct hostapd_freq_params freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700632
633 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800634 * freq_hint - Frequency of the channel the proposed AP is using
635 *
636 * This provides a channel on which a suitable BSS has been found as a
637 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
638 * limit the driver from selecting other channels for
639 * driver/firmware-based BSS selection.
640 */
641 int freq_hint;
642
643 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700644 * bg_scan_period - Background scan period in seconds, 0 to disable
645 * background scan, or -1 to indicate no change to default driver
646 * configuration
647 */
648 int bg_scan_period;
649
650 /**
Dmitry Shmidt2ac5f602014-03-07 10:08:21 -0800651 * beacon_int - Beacon interval for IBSS or 0 to use driver default
652 */
653 int beacon_int;
654
655 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700656 * wpa_ie - WPA information element for (Re)Association Request
657 * WPA information element to be included in (Re)Association
658 * Request (including information element id and length). Use
659 * of this WPA IE is optional. If the driver generates the WPA
660 * IE, it can use pairwise_suite, group_suite, and
661 * key_mgmt_suite to select proper algorithms. In this case,
662 * the driver has to notify wpa_supplicant about the used WPA
663 * IE by generating an event that the interface code will
664 * convert into EVENT_ASSOCINFO data (see below).
665 *
666 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
667 * instead. The driver can determine which version is used by
668 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
669 * WPA2/RSN).
670 *
671 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
672 */
673 const u8 *wpa_ie;
674
675 /**
676 * wpa_ie_len - length of the wpa_ie
677 */
678 size_t wpa_ie_len;
679
680 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800681 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
682 */
683 unsigned int wpa_proto;
684
685 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800686 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700687 *
688 * This is usually ignored if @wpa_ie is used.
689 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800690 unsigned int pairwise_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700691
692 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800693 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700694 *
695 * This is usually ignored if @wpa_ie is used.
696 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800697 unsigned int group_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700698
699 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800700 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700701 *
702 * This is usually ignored if @wpa_ie is used.
703 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800704 unsigned int key_mgmt_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700705
706 /**
707 * auth_alg - Allowed authentication algorithms
708 * Bit field of WPA_AUTH_ALG_*
709 */
710 int auth_alg;
711
712 /**
713 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
714 */
715 int mode;
716
717 /**
718 * wep_key - WEP keys for static WEP configuration
719 */
720 const u8 *wep_key[4];
721
722 /**
723 * wep_key_len - WEP key length for static WEP configuration
724 */
725 size_t wep_key_len[4];
726
727 /**
728 * wep_tx_keyidx - WEP TX key index for static WEP configuration
729 */
730 int wep_tx_keyidx;
731
732 /**
733 * mgmt_frame_protection - IEEE 802.11w management frame protection
734 */
735 enum mfp_options mgmt_frame_protection;
736
737 /**
738 * ft_ies - IEEE 802.11r / FT information elements
739 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
740 * for fast transition, this parameter is set to include the IEs that
741 * are to be sent in the next FT Authentication Request message.
742 * update_ft_ies() handler is called to update the IEs for further
743 * FT messages in the sequence.
744 *
745 * The driver should use these IEs only if the target AP is advertising
746 * the same mobility domain as the one included in the MDIE here.
747 *
748 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
749 * AP after the initial association. These IEs can only be used if the
750 * target AP is advertising support for FT and is using the same MDIE
751 * and SSID as the current AP.
752 *
753 * The driver is responsible for reporting the FT IEs received from the
754 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
755 * type. update_ft_ies() handler will then be called with the FT IEs to
756 * include in the next frame in the authentication sequence.
757 */
758 const u8 *ft_ies;
759
760 /**
761 * ft_ies_len - Length of ft_ies in bytes
762 */
763 size_t ft_ies_len;
764
765 /**
766 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
767 *
768 * This value is provided to allow the driver interface easier access
769 * to the current mobility domain. This value is set to %NULL if no
770 * mobility domain is currently active.
771 */
772 const u8 *ft_md;
773
774 /**
775 * passphrase - RSN passphrase for PSK
776 *
777 * This value is made available only for WPA/WPA2-Personal (PSK) and
778 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
779 * the 8..63 character ASCII passphrase, if available. Please note that
780 * this can be %NULL if passphrase was not used to generate the PSK. In
781 * that case, the psk field must be used to fetch the PSK.
782 */
783 const char *passphrase;
784
785 /**
786 * psk - RSN PSK (alternative for passphrase for PSK)
787 *
788 * This value is made available only for WPA/WPA2-Personal (PSK) and
789 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
790 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
791 * be prepared to handle %NULL value as an error.
792 */
793 const u8 *psk;
794
795 /**
796 * drop_unencrypted - Enable/disable unencrypted frame filtering
797 *
798 * Configure the driver to drop all non-EAPOL frames (both receive and
799 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
800 * still be allowed for key negotiation.
801 */
802 int drop_unencrypted;
803
804 /**
805 * prev_bssid - Previously used BSSID in this ESS
806 *
807 * When not %NULL, this is a request to use reassociation instead of
808 * association.
809 */
810 const u8 *prev_bssid;
811
812 /**
813 * wps - WPS mode
814 *
815 * If the driver needs to do special configuration for WPS association,
816 * this variable provides more information on what type of association
817 * is being requested. Most drivers should not need ot use this.
818 */
819 enum wps_mode wps;
820
821 /**
822 * p2p - Whether this connection is a P2P group
823 */
824 int p2p;
825
826 /**
827 * uapsd - UAPSD parameters for the network
828 * -1 = do not change defaults
829 * AP mode: 1 = enabled, 0 = disabled
830 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
831 */
832 int uapsd;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800833
834 /**
835 * fixed_bssid - Whether to force this BSSID in IBSS mode
836 * 1 = Fix this BSSID and prevent merges.
837 * 0 = Do not fix BSSID.
838 */
839 int fixed_bssid;
840
841 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800842 * fixed_freq - Fix control channel in IBSS mode
843 * 0 = don't fix control channel (default)
844 * 1 = fix control channel; this prevents IBSS merging with another
845 * channel
846 */
847 int fixed_freq;
848
849 /**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800850 * disable_ht - Disable HT (IEEE 802.11n) for this connection
851 */
852 int disable_ht;
853
854 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800855 * htcaps - HT Capabilities over-rides
856 *
857 * Only bits set in the mask will be used, and not all values are used
858 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
859 *
860 * Pointer to struct ieee80211_ht_capabilities.
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800861 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800862 const u8 *htcaps;
863
864 /**
865 * htcaps_mask - HT Capabilities over-rides mask
866 *
867 * Pointer to struct ieee80211_ht_capabilities.
868 */
869 const u8 *htcaps_mask;
Dmitry Shmidt2f023192013-03-12 12:44:17 -0700870
871#ifdef CONFIG_VHT_OVERRIDES
872 /**
873 * disable_vht - Disable VHT for this connection
874 */
875 int disable_vht;
876
877 /**
878 * VHT capability overrides.
879 */
880 const struct ieee80211_vht_capabilities *vhtcaps;
881 const struct ieee80211_vht_capabilities *vhtcaps_mask;
882#endif /* CONFIG_VHT_OVERRIDES */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800883
884 /**
885 * req_key_mgmt_offload - Request key management offload for connection
886 *
887 * Request key management offload for this connection if the device
888 * supports it.
889 */
890 int req_key_mgmt_offload;
891
892 /**
893 * Flag for indicating whether this association includes support for
894 * RRM (Radio Resource Measurements)
895 */
896 int rrm_used;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800897
898 /**
899 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
900 * AP as usual. Valid for DMG network only.
901 */
902 int pbss;
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800903
904 /**
905 * fils_kek - KEK for FILS association frame protection (AES-SIV)
906 */
907 const u8 *fils_kek;
908
909 /**
910 * fils_kek_len: Length of fils_kek in bytes
911 */
912 size_t fils_kek_len;
913
914 /**
915 * fils_nonces - Nonces for FILS association frame protection
916 * (AES-SIV AAD)
917 */
918 const u8 *fils_nonces;
919
920 /**
921 * fils_nonces_len: Length of fils_nonce in bytes
922 */
923 size_t fils_nonces_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700924};
925
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800926enum hide_ssid {
927 NO_SSID_HIDING,
928 HIDDEN_SSID_ZERO_LEN,
929 HIDDEN_SSID_ZERO_CONTENTS
930};
931
Dmitry Shmidtb58836e2014-04-29 14:35:56 -0700932struct wowlan_triggers {
933 u8 any;
934 u8 disconnect;
935 u8 magic_pkt;
936 u8 gtk_rekey_failure;
937 u8 eap_identity_req;
938 u8 four_way_handshake;
939 u8 rfkill_release;
940};
941
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800942struct wpa_driver_ap_params {
943 /**
944 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
945 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -0800946 u8 *head;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800947
948 /**
949 * head_len - Length of the head buffer in octets
950 */
951 size_t head_len;
952
953 /**
954 * tail - Beacon tail following TIM IE
955 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -0800956 u8 *tail;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800957
958 /**
959 * tail_len - Length of the tail buffer in octets
960 */
961 size_t tail_len;
962
963 /**
964 * dtim_period - DTIM period
965 */
966 int dtim_period;
967
968 /**
969 * beacon_int - Beacon interval
970 */
971 int beacon_int;
972
973 /**
974 * basic_rates: -1 terminated array of basic rates in 100 kbps
975 *
976 * This parameter can be used to set a specific basic rate set for the
977 * BSS. If %NULL, default basic rate set is used.
978 */
979 int *basic_rates;
980
981 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -0800982 * beacon_rate: Beacon frame data rate
983 *
984 * This parameter can be used to set a specific Beacon frame data rate
985 * for the BSS. The interpretation of this value depends on the
986 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS). If
987 * beacon_rate == 0 and rate_type == 0 (BEACON_RATE_LEGACY), the default
988 * Beacon frame data rate is used.
989 */
990 unsigned int beacon_rate;
991
992 /**
993 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT)
994 */
995 enum beacon_rate_type rate_type;
996
997 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800998 * proberesp - Probe Response template
999 *
1000 * This is used by drivers that reply to Probe Requests internally in
1001 * AP mode and require the full Probe Response template.
1002 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001003 u8 *proberesp;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001004
1005 /**
1006 * proberesp_len - Length of the proberesp buffer in octets
1007 */
1008 size_t proberesp_len;
1009
1010 /**
1011 * ssid - The SSID to use in Beacon/Probe Response frames
1012 */
1013 const u8 *ssid;
1014
1015 /**
1016 * ssid_len - Length of the SSID (1..32)
1017 */
1018 size_t ssid_len;
1019
1020 /**
1021 * hide_ssid - Whether to hide the SSID
1022 */
1023 enum hide_ssid hide_ssid;
1024
1025 /**
1026 * pairwise_ciphers - WPA_CIPHER_* bitfield
1027 */
1028 unsigned int pairwise_ciphers;
1029
1030 /**
1031 * group_cipher - WPA_CIPHER_*
1032 */
1033 unsigned int group_cipher;
1034
1035 /**
1036 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1037 */
1038 unsigned int key_mgmt_suites;
1039
1040 /**
1041 * auth_algs - WPA_AUTH_ALG_* bitfield
1042 */
1043 unsigned int auth_algs;
1044
1045 /**
1046 * wpa_version - WPA_PROTO_* bitfield
1047 */
1048 unsigned int wpa_version;
1049
1050 /**
1051 * privacy - Whether privacy is used in the BSS
1052 */
1053 int privacy;
1054
1055 /**
1056 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1057 *
1058 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1059 * not use the full Beacon template.
1060 */
1061 const struct wpabuf *beacon_ies;
1062
1063 /**
1064 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1065 *
1066 * This is used to add IEs like WPS IE and P2P IE by drivers that
1067 * reply to Probe Request frames internally.
1068 */
1069 const struct wpabuf *proberesp_ies;
1070
1071 /**
1072 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1073 *
1074 * This is used to add IEs like WPS IE by drivers that reply to
1075 * (Re)Association Request frames internally.
1076 */
1077 const struct wpabuf *assocresp_ies;
1078
1079 /**
1080 * isolate - Whether to isolate frames between associated stations
1081 *
1082 * If this is non-zero, the AP is requested to disable forwarding of
1083 * frames between associated stations.
1084 */
1085 int isolate;
1086
1087 /**
1088 * cts_protect - Whether CTS protection is enabled
1089 */
1090 int cts_protect;
1091
1092 /**
1093 * preamble - Whether short preamble is enabled
1094 */
1095 int preamble;
1096
1097 /**
1098 * short_slot_time - Whether short slot time is enabled
1099 *
1100 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1101 * not set (e.g., when 802.11g mode is not in use)
1102 */
1103 int short_slot_time;
1104
1105 /**
1106 * ht_opmode - HT operation mode or -1 if HT not in use
1107 */
1108 int ht_opmode;
1109
1110 /**
1111 * interworking - Whether Interworking is enabled
1112 */
1113 int interworking;
1114
1115 /**
1116 * hessid - Homogeneous ESS identifier or %NULL if not set
1117 */
1118 const u8 *hessid;
1119
1120 /**
1121 * access_network_type - Access Network Type (0..15)
1122 *
1123 * This is used for filtering Probe Request frames when Interworking is
1124 * enabled.
1125 */
1126 u8 access_network_type;
Dmitry Shmidt04949592012-07-19 12:16:46 -07001127
1128 /**
1129 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1130 *
1131 * This is used by driver which advertises this capability.
1132 */
1133 int ap_max_inactivity;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001134
1135 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001136 * ctwindow - Client Traffic Window (in TUs)
1137 */
1138 u8 p2p_go_ctwindow;
1139
1140 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001141 * smps_mode - SMPS mode
1142 *
1143 * SMPS mode to be used by the AP, specified as the relevant bits of
1144 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1145 */
1146 unsigned int smps_mode;
1147
1148 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001149 * disable_dgaf - Whether group-addressed frames are disabled
1150 */
1151 int disable_dgaf;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001152
1153 /**
1154 * osen - Whether OSEN security is enabled
1155 */
1156 int osen;
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001157
1158 /**
1159 * freq - Channel parameters for dynamic bandwidth changes
1160 */
1161 struct hostapd_freq_params *freq;
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001162
1163 /**
1164 * reenable - Whether this is to re-enable beaconing
1165 */
1166 int reenable;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001167
1168 /**
1169 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1170 * infrastructure BSS. Valid only for DMG network.
1171 */
1172 int pbss;
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001173
1174 /**
1175 * multicast_to_unicast - Whether to use multicast_to_unicast
1176 *
1177 * If this is non-zero, the AP is requested to perform multicast to
1178 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1179 * 802.1Q). If enabled, such frames are to be sent to each station
1180 * separately, with the DA replaced by their own MAC address rather
1181 * than the group address.
1182 *
1183 * Note that this may break certain expectations of the receiver, such
1184 * as the ability to drop unicast IP packets received within multicast
1185 * L2 frames, or the ability to not send ICMP destination unreachable
1186 * messages for packets received in L2 multicast (which is required,
1187 * but the receiver can't tell the difference if this new option is
1188 * enabled.)
1189 *
1190 * This also doesn't implement the 802.11 DMS (directed multicast
1191 * service).
1192 */
1193 int multicast_to_unicast;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001194};
1195
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001196struct wpa_driver_mesh_bss_params {
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001197#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1198#define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1199#define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1200#define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001201 /*
1202 * TODO: Other mesh configuration parameters would go here.
1203 * See NL80211_MESHCONF_* for all the mesh config parameters.
1204 */
1205 unsigned int flags;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001206 int auto_plinks;
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001207 int peer_link_timeout;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001208 int max_peer_links;
1209 u16 ht_opmode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001210};
1211
1212struct wpa_driver_mesh_join_params {
1213 const u8 *meshid;
1214 int meshid_len;
1215 const int *basic_rates;
1216 const u8 *ies;
1217 int ie_len;
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001218 struct hostapd_freq_params freq;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001219 int beacon_int;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001220 int dtim_period;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001221 struct wpa_driver_mesh_bss_params conf;
1222#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1223#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1224#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1225#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1226 unsigned int flags;
1227};
1228
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001229/**
1230 * struct wpa_driver_capa - Driver capability information
1231 */
1232struct wpa_driver_capa {
1233#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1234#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1235#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1236#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1237#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1238#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1239#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001240#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001241#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1242#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001243 /** Bitfield of supported key management suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001244 unsigned int key_mgmt;
1245
1246#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1247#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1248#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1249#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
Dmitry Shmidt04949592012-07-19 12:16:46 -07001250#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001251#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001252#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1253#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1254#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1255#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1256#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1257#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001258#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001259 /** Bitfield of supported cipher suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001260 unsigned int enc;
1261
1262#define WPA_DRIVER_AUTH_OPEN 0x00000001
1263#define WPA_DRIVER_AUTH_SHARED 0x00000002
1264#define WPA_DRIVER_AUTH_LEAP 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001265 /** Bitfield of supported IEEE 802.11 authentication algorithms */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001266 unsigned int auth;
1267
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001268/** Driver generated WPA/RSN IE */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001269#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001270/** Driver needs static WEP key setup after association command */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001271#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001272/** Driver takes care of all DFS operations */
Dmitry Shmidtd11f0192014-03-24 12:09:47 -07001273#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001274/** Driver takes care of RSN 4-way handshake internally; PMK is configured with
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001275 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1276#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001277/** Driver is for a wired Ethernet interface */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001278#define WPA_DRIVER_FLAGS_WIRED 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001279/** Driver provides separate commands for authentication and association (SME in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001280 * wpa_supplicant). */
1281#define WPA_DRIVER_FLAGS_SME 0x00000020
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001282/** Driver supports AP mode */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001283#define WPA_DRIVER_FLAGS_AP 0x00000040
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001284/** Driver needs static WEP key setup after association has been completed */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001285#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001286/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001287#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001288/** Driver supports concurrent P2P operations */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001289#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001290/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001291 * Driver uses the initial interface as a dedicated management interface, i.e.,
1292 * it cannot be used for P2P group operations or non-P2P purposes.
1293 */
1294#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001295/** This interface is P2P capable (P2P GO or P2P Client) */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001296#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001297/** Driver supports station and key removal when stopping an AP */
Dmitry Shmidta38abf92014-03-06 13:38:44 -08001298#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001299/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001300 * Driver uses the initial interface for P2P management interface and non-P2P
1301 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1302 * P2P group operations.
1303 */
1304#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001305/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001306 * Driver is known to use sane error codes, i.e., when it indicates that
1307 * something (e.g., association) fails, there was indeed a failure and the
1308 * operation does not end up getting completed successfully later.
1309 */
1310#define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001311/** Driver supports off-channel TX */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001312#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001313/** Driver indicates TX status events for EAPOL Data frames */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001314#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001315/** Driver indicates TX status events for Deauth/Disassoc frames */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001316#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001317/** Driver supports roaming (BSS selection) in firmware */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001318#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001319/** Driver supports operating as a TDLS peer */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001320#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001321/** Driver requires external TDLS setup/teardown/discovery */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001322#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001323/** Driver indicates support for Probe Response offloading in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001324#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001325/** Driver supports U-APSD in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001326#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001327/** Driver supports inactivity timer in AP mode */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001328#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001329/** Driver expects user space implementation of MLME in AP mode */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001330#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001331/** Driver supports SAE with user space SME */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001332#define WPA_DRIVER_FLAGS_SAE 0x02000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001333/** Driver makes use of OBSS scan mechanism in wpa_supplicant */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001334#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001335/** Driver supports IBSS (Ad-hoc) mode */
Dmitry Shmidt700a1372013-03-15 14:14:44 -07001336#define WPA_DRIVER_FLAGS_IBSS 0x08000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001337/** Driver supports radar detection */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07001338#define WPA_DRIVER_FLAGS_RADAR 0x10000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001339/** Driver supports a dedicated interface for P2P Device */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001340#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001341/** Driver supports QoS Mapping */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001342#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001343/** Driver supports CSA in AP mode */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001344#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001345/** Driver supports mesh */
1346#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1347/** Driver support ACS offload */
1348#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1349/** Driver supports key management offload */
1350#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1351/** Driver supports TDLS channel switching */
1352#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001353/** Driver supports IBSS with HT datarates */
1354#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001355/** Driver supports IBSS with VHT datarates */
1356#define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07001357/** Driver supports automatic band selection */
1358#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001359/** Driver supports simultaneous off-channel operations */
1360#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001361/** Driver supports full AP client state */
1362#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001363/** Driver supports P2P Listen offload */
1364#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001365/** Driver supports FILS */
1366#define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08001367/** Driver supports Beacon frame TX rate configuration (legacy rates) */
1368#define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1369/** Driver supports Beacon frame TX rate configuration (HT rates) */
1370#define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1371/** Driver supports Beacon frame TX rate configuration (VHT rates) */
1372#define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001373 u64 flags;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001374
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001375#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1376 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1377
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001378#define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1379#define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1380 unsigned int smps_modes;
1381
1382 unsigned int wmm_ac_supported:1;
1383
1384 unsigned int mac_addr_rand_scan_supported:1;
1385 unsigned int mac_addr_rand_sched_scan_supported:1;
1386
1387 /** Maximum number of supported active probe SSIDs */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001388 int max_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001389
1390 /** Maximum number of supported active probe SSIDs for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001391 int max_sched_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001392
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08001393 /** Maximum number of supported scan plans for scheduled scan */
1394 unsigned int max_sched_scan_plans;
1395
1396 /** Maximum interval in a scan plan. In seconds */
1397 u32 max_sched_scan_plan_interval;
1398
1399 /** Maximum number of iterations in a single scan plan */
1400 u32 max_sched_scan_plan_iterations;
1401
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001402 /** Whether sched_scan (offloaded scanning) is supported */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001403 int sched_scan_supported;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001404
1405 /** Maximum number of supported match sets for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001406 int max_match_sets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001407
1408 /**
1409 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1410 */
1411 unsigned int max_remain_on_chan;
1412
1413 /**
1414 * max_stations - Maximum number of associated stations the driver
1415 * supports in AP mode
1416 */
1417 unsigned int max_stations;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001418
1419 /**
1420 * probe_resp_offloads - Bitmap of supported protocols by the driver
1421 * for Probe Response offloading.
1422 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001423/** Driver Probe Response offloading support for WPS ver. 1 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001424#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001425/** Driver Probe Response offloading support for WPS ver. 2 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001426#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001427/** Driver Probe Response offloading support for P2P */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001428#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001429/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001430#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1431 unsigned int probe_resp_offloads;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001432
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07001433 unsigned int max_acl_mac_addrs;
1434
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001435 /**
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07001436 * Number of supported concurrent channels
1437 */
1438 unsigned int num_multichan_concurrent;
1439
1440 /**
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001441 * extended_capa - extended capabilities in driver/device
1442 *
1443 * Must be allocated and freed by driver and the pointers must be
1444 * valid for the lifetime of the driver, i.e., freed in deinit()
1445 */
1446 const u8 *extended_capa, *extended_capa_mask;
1447 unsigned int extended_capa_len;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001448
1449 struct wowlan_triggers wowlan_triggers;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001450
1451/** Driver adds the DS Params Set IE in Probe Request frames */
1452#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1453/** Driver adds the WFA TPC IE in Probe Request frames */
1454#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1455/** Driver handles quiet period requests */
1456#define WPA_DRIVER_FLAGS_QUIET 0x00000004
1457/**
1458 * Driver is capable of inserting the current TX power value into the body of
1459 * transmitted frames.
1460 * Background: Some Action frames include a TPC Report IE. This IE contains a
1461 * TX power field, which has to be updated by lower layers. One such Action
1462 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1463 * of spectrum management). Note that this insertion takes place at a fixed
1464 * offset, namely the 6th byte in the Action frame body.
1465 */
1466#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001467/**
1468 * Driver supports RRM. With this support, the driver will accept to use RRM in
1469 * (Re)Association Request frames, without supporting quiet period.
1470 */
1471#define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1472
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001473 u32 rrm_flags;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001474
1475 /* Driver concurrency capabilities */
1476 unsigned int conc_capab;
1477 /* Maximum number of concurrent channels on 2.4 GHz */
1478 unsigned int max_conc_chan_2_4;
1479 /* Maximum number of concurrent channels on 5 GHz */
1480 unsigned int max_conc_chan_5_0;
1481
1482 /* Maximum number of supported CSA counters */
1483 u16 max_csa_counters;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001484};
1485
1486
1487struct hostapd_data;
1488
1489struct hostap_sta_driver_data {
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001490 unsigned long rx_packets, tx_packets;
1491 unsigned long long rx_bytes, tx_bytes;
1492 int bytes_64bit; /* whether 64-bit byte counters are supported */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001493 unsigned long current_tx_rate;
1494 unsigned long inactive_msec;
1495 unsigned long flags;
1496 unsigned long num_ps_buf_frames;
1497 unsigned long tx_retry_failed;
1498 unsigned long tx_retry_count;
1499 int last_rssi;
1500 int last_ack_rssi;
1501};
1502
1503struct hostapd_sta_add_params {
1504 const u8 *addr;
1505 u16 aid;
1506 u16 capability;
1507 const u8 *supp_rates;
1508 size_t supp_rates_len;
1509 u16 listen_interval;
1510 const struct ieee80211_ht_capabilities *ht_capabilities;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001511 const struct ieee80211_vht_capabilities *vht_capabilities;
Dmitry Shmidtbd14a572014-02-18 10:33:49 -08001512 int vht_opmode_enabled;
1513 u8 vht_opmode;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001514 u32 flags; /* bitmask of WPA_STA_* flags */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001515 u32 flags_mask; /* unset bits in flags */
1516#ifdef CONFIG_MESH
1517 enum mesh_plink_state plink_state;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001518 u16 peer_aid;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001519#endif /* CONFIG_MESH */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001520 int set; /* Set STA parameters instead of add */
1521 u8 qosinfo;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08001522 const u8 *ext_capab;
1523 size_t ext_capab_len;
Dmitry Shmidt344abd32014-01-14 13:17:00 -08001524 const u8 *supp_channels;
1525 size_t supp_channels_len;
1526 const u8 *supp_oper_classes;
1527 size_t supp_oper_classes_len;
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001528 int support_p2p_ps;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001529};
1530
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07001531struct mac_address {
1532 u8 addr[ETH_ALEN];
1533};
1534
1535struct hostapd_acl_params {
1536 u8 acl_policy;
1537 unsigned int num_mac_acl;
1538 struct mac_address mac_acl[0];
1539};
1540
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001541enum wpa_driver_if_type {
1542 /**
1543 * WPA_IF_STATION - Station mode interface
1544 */
1545 WPA_IF_STATION,
1546
1547 /**
1548 * WPA_IF_AP_VLAN - AP mode VLAN interface
1549 *
1550 * This interface shares its address and Beacon frame with the main
1551 * BSS.
1552 */
1553 WPA_IF_AP_VLAN,
1554
1555 /**
1556 * WPA_IF_AP_BSS - AP mode BSS interface
1557 *
1558 * This interface has its own address and Beacon frame.
1559 */
1560 WPA_IF_AP_BSS,
1561
1562 /**
1563 * WPA_IF_P2P_GO - P2P Group Owner
1564 */
1565 WPA_IF_P2P_GO,
1566
1567 /**
1568 * WPA_IF_P2P_CLIENT - P2P Client
1569 */
1570 WPA_IF_P2P_CLIENT,
1571
1572 /**
1573 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1574 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1575 */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001576 WPA_IF_P2P_GROUP,
1577
1578 /**
1579 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1580 * abstracted P2P Device function in the driver
1581 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001582 WPA_IF_P2P_DEVICE,
1583
1584 /*
1585 * WPA_IF_MESH - Mesh interface
1586 */
1587 WPA_IF_MESH,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001588
1589 /*
1590 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1591 */
1592 WPA_IF_TDLS,
1593
1594 /*
1595 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1596 */
1597 WPA_IF_IBSS,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001598};
1599
1600struct wpa_init_params {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001601 void *global_priv;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001602 const u8 *bssid;
1603 const char *ifname;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001604 const char *driver_params;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001605 int use_pae_group_addr;
1606 char **bridge;
1607 size_t num_bridge;
1608
1609 u8 *own_addr; /* buffer for writing own MAC address */
1610};
1611
1612
1613struct wpa_bss_params {
1614 /** Interface name (for multi-SSID/VLAN support) */
1615 const char *ifname;
1616 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1617 int enabled;
1618
1619 int wpa;
1620 int ieee802_1x;
1621 int wpa_group;
1622 int wpa_pairwise;
1623 int wpa_key_mgmt;
1624 int rsn_preauth;
1625 enum mfp_options ieee80211w;
1626};
1627
1628#define WPA_STA_AUTHORIZED BIT(0)
1629#define WPA_STA_WMM BIT(1)
1630#define WPA_STA_SHORT_PREAMBLE BIT(2)
1631#define WPA_STA_MFP BIT(3)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001632#define WPA_STA_TDLS_PEER BIT(4)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001633#define WPA_STA_AUTHENTICATED BIT(5)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001634#define WPA_STA_ASSOCIATED BIT(6)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001635
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001636enum tdls_oper {
1637 TDLS_DISCOVERY_REQ,
1638 TDLS_SETUP,
1639 TDLS_TEARDOWN,
1640 TDLS_ENABLE_LINK,
1641 TDLS_DISABLE_LINK,
1642 TDLS_ENABLE,
1643 TDLS_DISABLE
1644};
1645
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001646enum wnm_oper {
1647 WNM_SLEEP_ENTER_CONFIRM,
1648 WNM_SLEEP_ENTER_FAIL,
1649 WNM_SLEEP_EXIT_CONFIRM,
1650 WNM_SLEEP_EXIT_FAIL,
1651 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1652 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1653 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1654 * a STA */
1655 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1656 * for a STA */
1657 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1658 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1659 * for a STA */
1660 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1661};
1662
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001663/* enum chan_width - Channel width definitions */
1664enum chan_width {
1665 CHAN_WIDTH_20_NOHT,
1666 CHAN_WIDTH_20,
1667 CHAN_WIDTH_40,
1668 CHAN_WIDTH_80,
1669 CHAN_WIDTH_80P80,
1670 CHAN_WIDTH_160,
1671 CHAN_WIDTH_UNKNOWN
1672};
1673
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001674/**
1675 * struct wpa_signal_info - Information about channel signal quality
1676 */
1677struct wpa_signal_info {
1678 u32 frequency;
1679 int above_threshold;
1680 int current_signal;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001681 int avg_signal;
Dmitry Shmidtf73259c2015-03-17 11:00:54 -07001682 int avg_beacon_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001683 int current_noise;
1684 int current_txrate;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001685 enum chan_width chanwidth;
1686 int center_frq1;
1687 int center_frq2;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001688};
1689
1690/**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001691 * struct beacon_data - Beacon data
1692 * @head: Head portion of Beacon frame (before TIM IE)
1693 * @tail: Tail portion of Beacon frame (after TIM IE)
1694 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1695 * @proberesp_ies: Extra information element(s) to add into Probe Response
1696 * frames or %NULL
1697 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1698 * Response frames or %NULL
1699 * @probe_resp: Probe Response frame template
1700 * @head_len: Length of @head
1701 * @tail_len: Length of @tail
1702 * @beacon_ies_len: Length of beacon_ies in octets
1703 * @proberesp_ies_len: Length of proberesp_ies in octets
1704 * @proberesp_ies_len: Length of proberesp_ies in octets
1705 * @probe_resp_len: Length of probe response template (@probe_resp)
1706 */
1707struct beacon_data {
1708 u8 *head, *tail;
1709 u8 *beacon_ies;
1710 u8 *proberesp_ies;
1711 u8 *assocresp_ies;
1712 u8 *probe_resp;
1713
1714 size_t head_len, tail_len;
1715 size_t beacon_ies_len;
1716 size_t proberesp_ies_len;
1717 size_t assocresp_ies_len;
1718 size_t probe_resp_len;
1719};
1720
1721/**
1722 * struct csa_settings - Settings for channel switch command
1723 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1724 * @block_tx: 1 - block transmission for CSA period
1725 * @freq_params: Next channel frequency parameter
1726 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1727 * @beacon_after: Next beacon/probe resp/asooc resp info
1728 * @counter_offset_beacon: Offset to the count field in beacon's tail
1729 * @counter_offset_presp: Offset to the count field in probe resp.
1730 */
1731struct csa_settings {
1732 u8 cs_count;
1733 u8 block_tx;
1734
1735 struct hostapd_freq_params freq_params;
1736 struct beacon_data beacon_csa;
1737 struct beacon_data beacon_after;
1738
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001739 u16 counter_offset_beacon[2];
1740 u16 counter_offset_presp[2];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001741};
1742
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07001743/* TDLS peer capabilities for send_tdls_mgmt() */
1744enum tdls_peer_capability {
1745 TDLS_PEER_HT = BIT(0),
1746 TDLS_PEER_VHT = BIT(1),
1747 TDLS_PEER_WMM = BIT(2),
1748};
1749
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001750/* valid info in the wmm_params struct */
1751enum wmm_params_valid_info {
1752 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1753};
1754
1755/**
1756 * struct wmm_params - WMM parameterss configured for this association
1757 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1758 * of the struct contain valid information.
1759 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1760 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1761 */
1762struct wmm_params {
1763 u8 info_bitmap;
1764 u8 uapsd_queues;
1765};
1766
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001767#ifdef CONFIG_MACSEC
1768struct macsec_init_params {
1769 Boolean always_include_sci;
1770 Boolean use_es;
1771 Boolean use_scb;
1772};
1773#endif /* CONFIG_MACSEC */
1774
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001775enum drv_br_port_attr {
1776 DRV_BR_PORT_ATTR_PROXYARP,
1777 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1778};
1779
1780enum drv_br_net_param {
1781 DRV_BR_NET_PARAM_GARP_ACCEPT,
Dmitry Shmidt83474442015-04-15 13:47:09 -07001782 DRV_BR_MULTICAST_SNOOPING,
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001783};
1784
1785struct drv_acs_params {
1786 /* Selected mode (HOSTAPD_MODE_*) */
1787 enum hostapd_hw_mode hw_mode;
1788
1789 /* Indicates whether HT is enabled */
1790 int ht_enabled;
1791
1792 /* Indicates whether HT40 is enabled */
1793 int ht40_enabled;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07001794
1795 /* Indicates whether VHT is enabled */
1796 int vht_enabled;
1797
1798 /* Configured ACS channel width */
1799 u16 ch_width;
1800
1801 /* ACS channel list info */
1802 unsigned int ch_list_len;
1803 const u8 *ch_list;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001804 const int *freq_list;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001805};
1806
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001807
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001808/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001809 * struct wpa_driver_ops - Driver interface API definition
1810 *
1811 * This structure defines the API that each driver interface needs to implement
1812 * for core wpa_supplicant code. All driver specific functionality is captured
1813 * in this wrapper.
1814 */
1815struct wpa_driver_ops {
1816 /** Name of the driver interface */
1817 const char *name;
1818 /** One line description of the driver interface */
1819 const char *desc;
1820
1821 /**
1822 * get_bssid - Get the current BSSID
1823 * @priv: private driver interface data
1824 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1825 *
1826 * Returns: 0 on success, -1 on failure
1827 *
1828 * Query kernel driver for the current BSSID and copy it to bssid.
1829 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1830 * associated.
1831 */
1832 int (*get_bssid)(void *priv, u8 *bssid);
1833
1834 /**
1835 * get_ssid - Get the current SSID
1836 * @priv: private driver interface data
1837 * @ssid: buffer for SSID (at least 32 bytes)
1838 *
1839 * Returns: Length of the SSID on success, -1 on failure
1840 *
1841 * Query kernel driver for the current SSID and copy it to ssid.
1842 * Returning zero is recommended if the STA is not associated.
1843 *
1844 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1845 * can, at least in theory, contain control characters (including nul)
1846 * and as such, should be processed as binary data, not a printable
1847 * string.
1848 */
1849 int (*get_ssid)(void *priv, u8 *ssid);
1850
1851 /**
1852 * set_key - Configure encryption key
1853 * @ifname: Interface name (for multi-SSID/VLAN support)
1854 * @priv: private driver interface data
1855 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001856 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001857 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1858 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1859 * %WPA_ALG_BIP_CMAC_256);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001860 * %WPA_ALG_NONE clears the key.
1861 * @addr: Address of the peer STA (BSSID of the current AP when setting
1862 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1863 * broadcast keys, %NULL for default keys that are used both for
1864 * broadcast and unicast; when clearing keys, %NULL is used to
1865 * indicate that both the broadcast-only and default key of the
1866 * specified key index is to be cleared
1867 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1868 * IGTK
1869 * @set_tx: configure this key as the default Tx key (only used when
1870 * driver does not support separate unicast/individual key
1871 * @seq: sequence number/packet number, seq_len octets, the next
1872 * packet number to be used for in replay protection; configured
1873 * for Rx keys (in most cases, this is only used with broadcast
1874 * keys and set to zero for unicast keys); %NULL if not set
1875 * @seq_len: length of the seq, depends on the algorithm:
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001876 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001877 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1878 * 8-byte Rx Mic Key
1879 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001880 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001881 *
1882 * Returns: 0 on success, -1 on failure
1883 *
1884 * Configure the given key for the kernel driver. If the driver
1885 * supports separate individual keys (4 default keys + 1 individual),
1886 * addr can be used to determine whether the key is default or
1887 * individual. If only 4 keys are supported, the default key with key
1888 * index 0 is used as the individual key. STA must be configured to use
1889 * it as the default Tx key (set_tx is set) and accept Rx for all the
1890 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1891 * broadcast keys, so key index 0 is available for this kind of
1892 * configuration.
1893 *
1894 * Please note that TKIP keys include separate TX and RX MIC keys and
1895 * some drivers may expect them in different order than wpa_supplicant
1896 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1897 * will trigger Michael MIC errors. This can be fixed by changing the
1898 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1899 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1900 * example on how this can be done.
1901 */
1902 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1903 const u8 *addr, int key_idx, int set_tx,
1904 const u8 *seq, size_t seq_len,
1905 const u8 *key, size_t key_len);
1906
1907 /**
1908 * init - Initialize driver interface
1909 * @ctx: context to be used when calling wpa_supplicant functions,
1910 * e.g., wpa_supplicant_event()
1911 * @ifname: interface name, e.g., wlan0
1912 *
1913 * Returns: Pointer to private data, %NULL on failure
1914 *
1915 * Initialize driver interface, including event processing for kernel
1916 * driver events (e.g., associated, scan results, Michael MIC failure).
1917 * This function can allocate a private configuration data area for
1918 * @ctx, file descriptor, interface name, etc. information that may be
1919 * needed in future driver operations. If this is not used, non-NULL
1920 * value will need to be returned because %NULL is used to indicate
1921 * failure. The returned value will be used as 'void *priv' data for
1922 * all other driver_ops functions.
1923 *
1924 * The main event loop (eloop.c) of wpa_supplicant can be used to
1925 * register callback for read sockets (eloop_register_read_sock()).
1926 *
1927 * See below for more information about events and
1928 * wpa_supplicant_event() function.
1929 */
1930 void * (*init)(void *ctx, const char *ifname);
1931
1932 /**
1933 * deinit - Deinitialize driver interface
1934 * @priv: private driver interface data from init()
1935 *
1936 * Shut down driver interface and processing of driver events. Free
1937 * private data buffer if one was allocated in init() handler.
1938 */
1939 void (*deinit)(void *priv);
1940
1941 /**
1942 * set_param - Set driver configuration parameters
1943 * @priv: private driver interface data from init()
1944 * @param: driver specific configuration parameters
1945 *
1946 * Returns: 0 on success, -1 on failure
1947 *
1948 * Optional handler for notifying driver interface about configuration
1949 * parameters (driver_param).
1950 */
1951 int (*set_param)(void *priv, const char *param);
1952
1953 /**
1954 * set_countermeasures - Enable/disable TKIP countermeasures
1955 * @priv: private driver interface data
1956 * @enabled: 1 = countermeasures enabled, 0 = disabled
1957 *
1958 * Returns: 0 on success, -1 on failure
1959 *
1960 * Configure TKIP countermeasures. When these are enabled, the driver
1961 * should drop all received and queued frames that are using TKIP.
1962 */
1963 int (*set_countermeasures)(void *priv, int enabled);
1964
1965 /**
1966 * deauthenticate - Request driver to deauthenticate
1967 * @priv: private driver interface data
1968 * @addr: peer address (BSSID of the AP)
1969 * @reason_code: 16-bit reason code to be sent in the deauthentication
1970 * frame
1971 *
1972 * Returns: 0 on success, -1 on failure
1973 */
1974 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1975
1976 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001977 * associate - Request driver to associate
1978 * @priv: private driver interface data
1979 * @params: association parameters
1980 *
1981 * Returns: 0 on success, -1 on failure
1982 */
1983 int (*associate)(void *priv,
1984 struct wpa_driver_associate_params *params);
1985
1986 /**
1987 * add_pmkid - Add PMKSA cache entry to the driver
1988 * @priv: private driver interface data
1989 * @bssid: BSSID for the PMKSA cache entry
1990 * @pmkid: PMKID for the PMKSA cache entry
1991 *
1992 * Returns: 0 on success, -1 on failure
1993 *
1994 * This function is called when a new PMK is received, as a result of
1995 * either normal authentication or RSN pre-authentication.
1996 *
1997 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1998 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1999 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2000 * driver_ops function does not need to be implemented. Likewise, if
2001 * the driver does not support WPA, this function is not needed.
2002 */
2003 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
2004
2005 /**
2006 * remove_pmkid - Remove PMKSA cache entry to the driver
2007 * @priv: private driver interface data
2008 * @bssid: BSSID for the PMKSA cache entry
2009 * @pmkid: PMKID for the PMKSA cache entry
2010 *
2011 * Returns: 0 on success, -1 on failure
2012 *
2013 * This function is called when the supplicant drops a PMKSA cache
2014 * entry for any reason.
2015 *
2016 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2017 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2018 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2019 * from wpa_supplicant, this driver_ops function does not need to be
2020 * implemented. Likewise, if the driver does not support WPA, this
2021 * function is not needed.
2022 */
2023 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
2024
2025 /**
2026 * flush_pmkid - Flush PMKSA cache
2027 * @priv: private driver interface data
2028 *
2029 * Returns: 0 on success, -1 on failure
2030 *
2031 * This function is called when the supplicant drops all PMKSA cache
2032 * entries for any reason.
2033 *
2034 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2035 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2036 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2037 * from wpa_supplicant, this driver_ops function does not need to be
2038 * implemented. Likewise, if the driver does not support WPA, this
2039 * function is not needed.
2040 */
2041 int (*flush_pmkid)(void *priv);
2042
2043 /**
2044 * get_capa - Get driver capabilities
2045 * @priv: private driver interface data
2046 *
2047 * Returns: 0 on success, -1 on failure
2048 *
2049 * Get driver/firmware/hardware capabilities.
2050 */
2051 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
2052
2053 /**
2054 * poll - Poll driver for association information
2055 * @priv: private driver interface data
2056 *
2057 * This is an option callback that can be used when the driver does not
2058 * provide event mechanism for association events. This is called when
2059 * receiving WPA EAPOL-Key messages that require association
2060 * information. The driver interface is supposed to generate associnfo
2061 * event before returning from this callback function. In addition, the
2062 * driver interface should generate an association event after having
2063 * sent out associnfo.
2064 */
2065 void (*poll)(void *priv);
2066
2067 /**
Dmitry Shmidte4663042016-04-04 10:07:49 -07002068 * get_ifindex - Get interface index
2069 * @priv: private driver interface data
2070 *
2071 * Returns: Interface index
2072 */
2073 unsigned int (*get_ifindex)(void *priv);
2074
2075 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002076 * get_ifname - Get interface name
2077 * @priv: private driver interface data
2078 *
2079 * Returns: Pointer to the interface name. This can differ from the
2080 * interface name used in init() call. Init() is called first.
2081 *
2082 * This optional function can be used to allow the driver interface to
2083 * replace the interface name with something else, e.g., based on an
2084 * interface mapping from a more descriptive name.
2085 */
2086 const char * (*get_ifname)(void *priv);
2087
2088 /**
2089 * get_mac_addr - Get own MAC address
2090 * @priv: private driver interface data
2091 *
2092 * Returns: Pointer to own MAC address or %NULL on failure
2093 *
2094 * This optional function can be used to get the own MAC address of the
2095 * device from the driver interface code. This is only needed if the
2096 * l2_packet implementation for the OS does not provide easy access to
2097 * a MAC address. */
2098 const u8 * (*get_mac_addr)(void *priv);
2099
2100 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002101 * set_operstate - Sets device operating state to DORMANT or UP
2102 * @priv: private driver interface data
2103 * @state: 0 = dormant, 1 = up
2104 * Returns: 0 on success, -1 on failure
2105 *
2106 * This is an optional function that can be used on operating systems
2107 * that support a concept of controlling network device state from user
2108 * space applications. This function, if set, gets called with
2109 * state = 1 when authentication has been completed and with state = 0
2110 * when connection is lost.
2111 */
2112 int (*set_operstate)(void *priv, int state);
2113
2114 /**
2115 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2116 * @priv: Private driver interface data
2117 * @addr: Address of the station for which to set protection (may be
2118 * %NULL for group keys)
2119 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2120 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2121 * Returns: 0 on success, -1 on failure
2122 *
2123 * This is an optional function that can be used to set the driver to
2124 * require protection for Tx and/or Rx frames. This uses the layer
2125 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2126 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2127 * set protection operation; instead, they set protection implicitly
2128 * based on configured keys.
2129 */
2130 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2131 int key_type);
2132
2133 /**
2134 * get_hw_feature_data - Get hardware support data (channels and rates)
2135 * @priv: Private driver interface data
2136 * @num_modes: Variable for returning the number of returned modes
2137 * flags: Variable for returning hardware feature flags
2138 * Returns: Pointer to allocated hardware data on success or %NULL on
2139 * failure. Caller is responsible for freeing this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002140 */
2141 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2142 u16 *num_modes,
2143 u16 *flags);
2144
2145 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002146 * send_mlme - Send management frame from MLME
2147 * @priv: Private driver interface data
2148 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2149 * @data_len: Size of the management frame
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002150 * @noack: Do not wait for this frame to be acked (disable retries)
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07002151 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2152 * driver decide
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002153 * @csa_offs: Array of CSA offsets or %NULL
2154 * @csa_offs_len: Number of elements in csa_offs
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002155 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002156 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002157 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002158 int noack, unsigned int freq, const u16 *csa_offs,
2159 size_t csa_offs_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002160
2161 /**
2162 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2163 * @priv: Private driver interface data
2164 * @md: Mobility domain (2 octets) (also included inside ies)
2165 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2166 * @ies_len: Length of FT IEs in bytes
2167 * Returns: 0 on success, -1 on failure
2168 *
2169 * The supplicant uses this callback to let the driver know that keying
2170 * material for FT is available and that the driver can use the
2171 * provided IEs in the next message in FT authentication sequence.
2172 *
2173 * This function is only needed for driver that support IEEE 802.11r
2174 * (Fast BSS Transition).
2175 */
2176 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2177 size_t ies_len);
2178
2179 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002180 * get_scan_results2 - Fetch the latest scan results
2181 * @priv: private driver interface data
2182 *
2183 * Returns: Allocated buffer of scan results (caller is responsible for
2184 * freeing the data structure) on success, NULL on failure
2185 */
2186 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2187
2188 /**
2189 * set_country - Set country
2190 * @priv: Private driver interface data
2191 * @alpha2: country to which to switch to
2192 * Returns: 0 on success, -1 on failure
2193 *
2194 * This function is for drivers which support some form
2195 * of setting a regulatory domain.
2196 */
2197 int (*set_country)(void *priv, const char *alpha2);
2198
2199 /**
Dmitry Shmidtcce06662013-11-04 18:44:24 -08002200 * get_country - Get country
2201 * @priv: Private driver interface data
2202 * @alpha2: Buffer for returning country code (at least 3 octets)
2203 * Returns: 0 on success, -1 on failure
2204 */
2205 int (*get_country)(void *priv, char *alpha2);
2206
2207 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002208 * global_init - Global driver initialization
Dmitry Shmidte4663042016-04-04 10:07:49 -07002209 * @ctx: wpa_global pointer
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002210 * Returns: Pointer to private data (global), %NULL on failure
2211 *
2212 * This optional function is called to initialize the driver wrapper
2213 * for global data, i.e., data that applies to all interfaces. If this
2214 * function is implemented, global_deinit() will also need to be
2215 * implemented to free the private data. The driver will also likely
2216 * use init2() function instead of init() to get the pointer to global
2217 * data available to per-interface initializer.
2218 */
Dmitry Shmidte4663042016-04-04 10:07:49 -07002219 void * (*global_init)(void *ctx);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002220
2221 /**
2222 * global_deinit - Global driver deinitialization
2223 * @priv: private driver global data from global_init()
2224 *
2225 * Terminate any global driver related functionality and free the
2226 * global data structure.
2227 */
2228 void (*global_deinit)(void *priv);
2229
2230 /**
2231 * init2 - Initialize driver interface (with global data)
2232 * @ctx: context to be used when calling wpa_supplicant functions,
2233 * e.g., wpa_supplicant_event()
2234 * @ifname: interface name, e.g., wlan0
2235 * @global_priv: private driver global data from global_init()
2236 * Returns: Pointer to private data, %NULL on failure
2237 *
2238 * This function can be used instead of init() if the driver wrapper
2239 * uses global data.
2240 */
2241 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2242
2243 /**
2244 * get_interfaces - Get information about available interfaces
2245 * @global_priv: private driver global data from global_init()
2246 * Returns: Allocated buffer of interface information (caller is
2247 * responsible for freeing the data structure) on success, NULL on
2248 * failure
2249 */
2250 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2251
2252 /**
2253 * scan2 - Request the driver to initiate scan
2254 * @priv: private driver interface data
2255 * @params: Scan parameters
2256 *
2257 * Returns: 0 on success, -1 on failure
2258 *
2259 * Once the scan results are ready, the driver should report scan
2260 * results event for wpa_supplicant which will eventually request the
2261 * results with wpa_driver_get_scan_results2().
2262 */
2263 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2264
2265 /**
2266 * authenticate - Request driver to authenticate
2267 * @priv: private driver interface data
2268 * @params: authentication parameters
2269 * Returns: 0 on success, -1 on failure
2270 *
2271 * This is an optional function that can be used with drivers that
2272 * support separate authentication and association steps, i.e., when
2273 * wpa_supplicant can act as the SME. If not implemented, associate()
2274 * function is expected to take care of IEEE 802.11 authentication,
2275 * too.
2276 */
2277 int (*authenticate)(void *priv,
2278 struct wpa_driver_auth_params *params);
2279
2280 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002281 * set_ap - Set Beacon and Probe Response information for AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002282 * @priv: Private driver interface data
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002283 * @params: Parameters to use in AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002284 *
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002285 * This function is used to configure Beacon template and/or extra IEs
2286 * to add for Beacon and Probe Response frames for the driver in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002287 * AP mode. The driver is responsible for building the full Beacon
2288 * frame by concatenating the head part with TIM IE generated by the
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002289 * driver/firmware and finishing with the tail part. Depending on the
2290 * driver architectue, this can be done either by using the full
2291 * template or the set of additional IEs (e.g., WPS and P2P IE).
2292 * Similarly, Probe Response processing depends on the driver design.
2293 * If the driver (or firmware) takes care of replying to Probe Request
2294 * frames, the extra IEs provided here needs to be added to the Probe
2295 * Response frames.
2296 *
2297 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002298 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002299 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002300
2301 /**
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002302 * set_acl - Set ACL in AP mode
2303 * @priv: Private driver interface data
2304 * @params: Parameters to configure ACL
2305 * Returns: 0 on success, -1 on failure
2306 *
2307 * This is used only for the drivers which support MAC address ACL.
2308 */
2309 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2310
2311 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002312 * hapd_init - Initialize driver interface (hostapd only)
2313 * @hapd: Pointer to hostapd context
2314 * @params: Configuration for the driver wrapper
2315 * Returns: Pointer to private data, %NULL on failure
2316 *
2317 * This function is used instead of init() or init2() when the driver
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002318 * wrapper is used with hostapd.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002319 */
2320 void * (*hapd_init)(struct hostapd_data *hapd,
2321 struct wpa_init_params *params);
2322
2323 /**
2324 * hapd_deinit - Deinitialize driver interface (hostapd only)
2325 * @priv: Private driver interface data from hapd_init()
2326 */
2327 void (*hapd_deinit)(void *priv);
2328
2329 /**
2330 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2331 * @priv: Private driver interface data
2332 * @params: BSS parameters
2333 * Returns: 0 on success, -1 on failure
2334 *
2335 * This is an optional function to configure the kernel driver to
2336 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2337 * can be left undefined (set to %NULL) if IEEE 802.1X support is
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002338 * always enabled and the driver uses set_ap() to set WPA/RSN IE
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002339 * for Beacon frames.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002340 *
2341 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002342 */
2343 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2344
2345 /**
2346 * set_privacy - Enable/disable privacy (AP only)
2347 * @priv: Private driver interface data
2348 * @enabled: 1 = privacy enabled, 0 = disabled
2349 * Returns: 0 on success, -1 on failure
2350 *
2351 * This is an optional function to configure privacy field in the
2352 * kernel driver for Beacon frames. This can be left undefined (set to
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002353 * %NULL) if the driver uses the Beacon template from set_ap().
2354 *
2355 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002356 */
2357 int (*set_privacy)(void *priv, int enabled);
2358
2359 /**
2360 * get_seqnum - Fetch the current TSC/packet number (AP only)
2361 * @ifname: The interface name (main or virtual)
2362 * @priv: Private driver interface data
2363 * @addr: MAC address of the station or %NULL for group keys
2364 * @idx: Key index
2365 * @seq: Buffer for returning the latest used TSC/packet number
2366 * Returns: 0 on success, -1 on failure
2367 *
2368 * This function is used to fetch the last used TSC/packet number for
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002369 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2370 * keys, so there is no strict requirement on implementing support for
2371 * unicast keys (i.e., addr != %NULL).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002372 */
2373 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2374 int idx, u8 *seq);
2375
2376 /**
2377 * flush - Flush all association stations (AP only)
2378 * @priv: Private driver interface data
2379 * Returns: 0 on success, -1 on failure
2380 *
2381 * This function requests the driver to disassociate all associated
2382 * stations. This function does not need to be implemented if the
2383 * driver does not process association frames internally.
2384 */
2385 int (*flush)(void *priv);
2386
2387 /**
2388 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2389 * @priv: Private driver interface data
2390 * @elem: Information elements
2391 * @elem_len: Length of the elem buffer in octets
2392 * Returns: 0 on success, -1 on failure
2393 *
2394 * This is an optional function to add information elements in the
2395 * kernel driver for Beacon and Probe Response frames. This can be left
2396 * undefined (set to %NULL) if the driver uses the Beacon template from
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002397 * set_ap().
2398 *
2399 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002400 */
2401 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2402
2403 /**
Jouni Malinen1e6c57f2012-09-05 17:07:03 +03002404 * read_sta_data - Fetch station data
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002405 * @priv: Private driver interface data
2406 * @data: Buffer for returning station information
2407 * @addr: MAC address of the station
2408 * Returns: 0 on success, -1 on failure
2409 */
2410 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2411 const u8 *addr);
2412
2413 /**
2414 * hapd_send_eapol - Send an EAPOL packet (AP only)
2415 * @priv: private driver interface data
2416 * @addr: Destination MAC address
2417 * @data: EAPOL packet starting with IEEE 802.1X header
2418 * @data_len: Length of the EAPOL packet in octets
2419 * @encrypt: Whether the frame should be encrypted
2420 * @own_addr: Source MAC address
2421 * @flags: WPA_STA_* flags for the destination station
2422 *
2423 * Returns: 0 on success, -1 on failure
2424 */
2425 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2426 size_t data_len, int encrypt,
2427 const u8 *own_addr, u32 flags);
2428
2429 /**
2430 * sta_deauth - Deauthenticate a station (AP only)
2431 * @priv: Private driver interface data
2432 * @own_addr: Source address and BSSID for the Deauthentication frame
2433 * @addr: MAC address of the station to deauthenticate
2434 * @reason: Reason code for the Deauthentiation frame
2435 * Returns: 0 on success, -1 on failure
2436 *
2437 * This function requests a specific station to be deauthenticated and
2438 * a Deauthentication frame to be sent to it.
2439 */
2440 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2441 int reason);
2442
2443 /**
2444 * sta_disassoc - Disassociate a station (AP only)
2445 * @priv: Private driver interface data
2446 * @own_addr: Source address and BSSID for the Disassociation frame
2447 * @addr: MAC address of the station to disassociate
2448 * @reason: Reason code for the Disassociation frame
2449 * Returns: 0 on success, -1 on failure
2450 *
2451 * This function requests a specific station to be disassociated and
2452 * a Disassociation frame to be sent to it.
2453 */
2454 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2455 int reason);
2456
2457 /**
2458 * sta_remove - Remove a station entry (AP only)
2459 * @priv: Private driver interface data
2460 * @addr: MAC address of the station to be removed
2461 * Returns: 0 on success, -1 on failure
2462 */
2463 int (*sta_remove)(void *priv, const u8 *addr);
2464
2465 /**
2466 * hapd_get_ssid - Get the current SSID (AP only)
2467 * @priv: Private driver interface data
2468 * @buf: Buffer for returning the SSID
2469 * @len: Maximum length of the buffer
2470 * Returns: Length of the SSID on success, -1 on failure
2471 *
2472 * This function need not be implemented if the driver uses Beacon
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002473 * template from set_ap() and does not reply to Probe Request frames.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002474 */
2475 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2476
2477 /**
2478 * hapd_set_ssid - Set SSID (AP only)
2479 * @priv: Private driver interface data
2480 * @buf: SSID
2481 * @len: Length of the SSID in octets
2482 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002483 *
2484 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002485 */
2486 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2487
2488 /**
2489 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2490 * @priv: Private driver interface data
2491 * @enabled: 1 = countermeasures enabled, 0 = disabled
2492 * Returns: 0 on success, -1 on failure
2493 *
2494 * This need not be implemented if the driver does not take care of
2495 * association processing.
2496 */
2497 int (*hapd_set_countermeasures)(void *priv, int enabled);
2498
2499 /**
2500 * sta_add - Add a station entry
2501 * @priv: Private driver interface data
2502 * @params: Station parameters
2503 * Returns: 0 on success, -1 on failure
2504 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002505 * This function is used to add or set (params->set 1) a station
2506 * entry in the driver. Adding STA entries is used only if the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002507 * does not take care of association processing.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002508 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002509 * With drivers that don't support full AP client state, this function
2510 * is used to add a station entry to the driver once the station has
2511 * completed association.
2512 *
2513 * With TDLS, this function is used to add or set (params->set 1)
2514 * TDLS peer entries (even with drivers that do not support full AP
2515 * client state).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002516 */
2517 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2518
2519 /**
2520 * get_inact_sec - Get station inactivity duration (AP only)
2521 * @priv: Private driver interface data
2522 * @addr: Station address
2523 * Returns: Number of seconds station has been inactive, -1 on failure
2524 */
2525 int (*get_inact_sec)(void *priv, const u8 *addr);
2526
2527 /**
2528 * sta_clear_stats - Clear station statistics (AP only)
2529 * @priv: Private driver interface data
2530 * @addr: Station address
2531 * Returns: 0 on success, -1 on failure
2532 */
2533 int (*sta_clear_stats)(void *priv, const u8 *addr);
2534
2535 /**
2536 * set_freq - Set channel/frequency (AP only)
2537 * @priv: Private driver interface data
2538 * @freq: Channel parameters
2539 * Returns: 0 on success, -1 on failure
2540 */
2541 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2542
2543 /**
2544 * set_rts - Set RTS threshold
2545 * @priv: Private driver interface data
2546 * @rts: RTS threshold in octets
2547 * Returns: 0 on success, -1 on failure
2548 */
2549 int (*set_rts)(void *priv, int rts);
2550
2551 /**
2552 * set_frag - Set fragmentation threshold
2553 * @priv: Private driver interface data
2554 * @frag: Fragmentation threshold in octets
2555 * Returns: 0 on success, -1 on failure
2556 */
2557 int (*set_frag)(void *priv, int frag);
2558
2559 /**
2560 * sta_set_flags - Set station flags (AP only)
2561 * @priv: Private driver interface data
2562 * @addr: Station address
2563 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2564 * @flags_or: Bitmap of WPA_STA_* flags to add
2565 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2566 * Returns: 0 on success, -1 on failure
2567 */
2568 int (*sta_set_flags)(void *priv, const u8 *addr,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002569 unsigned int total_flags, unsigned int flags_or,
2570 unsigned int flags_and);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002571
2572 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002573 * set_tx_queue_params - Set TX queue parameters
2574 * @priv: Private driver interface data
2575 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2576 * @aifs: AIFS
2577 * @cw_min: cwMin
2578 * @cw_max: cwMax
2579 * @burst_time: Maximum length for bursting in 0.1 msec units
2580 */
2581 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2582 int cw_max, int burst_time);
2583
2584 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002585 * if_add - Add a virtual interface
2586 * @priv: Private driver interface data
2587 * @type: Interface type
2588 * @ifname: Interface name for the new virtual interface
2589 * @addr: Local address to use for the interface or %NULL to use the
2590 * parent interface address
2591 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2592 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2593 * not allowed (applies only to %WPA_IF_AP_BSS type)
2594 * @force_ifname: Buffer for returning an interface name that the
2595 * driver ended up using if it differs from the requested ifname
2596 * @if_addr: Buffer for returning the allocated interface address
2597 * (this may differ from the requested addr if the driver cannot
2598 * change interface address)
2599 * @bridge: Bridge interface to use or %NULL if no bridge configured
Dmitry Shmidtcce06662013-11-04 18:44:24 -08002600 * @use_existing: Whether to allow existing interface to be used
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08002601 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002602 * Returns: 0 on success, -1 on failure
2603 */
2604 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2605 const char *ifname, const u8 *addr, void *bss_ctx,
2606 void **drv_priv, char *force_ifname, u8 *if_addr,
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08002607 const char *bridge, int use_existing, int setup_ap);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002608
2609 /**
2610 * if_remove - Remove a virtual interface
2611 * @priv: Private driver interface data
2612 * @type: Interface type
2613 * @ifname: Interface name of the virtual interface to be removed
2614 * Returns: 0 on success, -1 on failure
2615 */
2616 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2617 const char *ifname);
2618
2619 /**
2620 * set_sta_vlan - Bind a station into a specific interface (AP only)
2621 * @priv: Private driver interface data
2622 * @ifname: Interface (main or virtual BSS or VLAN)
2623 * @addr: MAC address of the associated station
2624 * @vlan_id: VLAN ID
2625 * Returns: 0 on success, -1 on failure
2626 *
2627 * This function is used to bind a station to a specific virtual
2628 * interface. It is only used if when virtual interfaces are supported,
2629 * e.g., to assign stations to different VLAN interfaces based on
2630 * information from a RADIUS server. This allows separate broadcast
2631 * domains to be used with a single BSS.
2632 */
2633 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2634 int vlan_id);
2635
2636 /**
2637 * commit - Optional commit changes handler (AP only)
2638 * @priv: driver private data
2639 * Returns: 0 on success, -1 on failure
2640 *
2641 * This optional handler function can be registered if the driver
2642 * interface implementation needs to commit changes (e.g., by setting
2643 * network interface up) at the end of initial configuration. If set,
2644 * this handler will be called after initial setup has been completed.
2645 */
2646 int (*commit)(void *priv);
2647
2648 /**
2649 * send_ether - Send an ethernet packet (AP only)
2650 * @priv: private driver interface data
2651 * @dst: Destination MAC address
2652 * @src: Source MAC address
2653 * @proto: Ethertype
2654 * @data: EAPOL packet starting with IEEE 802.1X header
2655 * @data_len: Length of the EAPOL packet in octets
2656 * Returns: 0 on success, -1 on failure
2657 */
2658 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2659 const u8 *data, size_t data_len);
2660
2661 /**
2662 * set_radius_acl_auth - Notification of RADIUS ACL change
2663 * @priv: Private driver interface data
2664 * @mac: MAC address of the station
2665 * @accepted: Whether the station was accepted
2666 * @session_timeout: Session timeout for the station
2667 * Returns: 0 on success, -1 on failure
2668 */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07002669 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002670 u32 session_timeout);
2671
2672 /**
2673 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2674 * @priv: Private driver interface data
2675 * @mac: MAC address of the station
2676 * Returns: 0 on success, -1 on failure
2677 */
2678 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2679
2680 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002681 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2682 * @priv: Private driver interface data
2683 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2684 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2685 * extra IE(s)
2686 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2687 * to remove extra IE(s)
2688 * Returns: 0 on success, -1 on failure
2689 *
2690 * This is an optional function to add WPS IE in the kernel driver for
2691 * Beacon and Probe Response frames. This can be left undefined (set
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002692 * to %NULL) if the driver uses the Beacon template from set_ap()
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002693 * and does not process Probe Request frames. If the driver takes care
2694 * of (Re)Association frame processing, the assocresp buffer includes
2695 * WPS IE(s) that need to be added to (Re)Association Response frames
2696 * whenever a (Re)Association Request frame indicated use of WPS.
2697 *
2698 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2699 * frames when operating as a GO. The driver is responsible for adding
2700 * timing related attributes (e.g., NoA) in addition to the IEs
2701 * included here by appending them after these buffers. This call is
2702 * also used to provide Probe Response IEs for P2P Listen state
2703 * operations for drivers that generate the Probe Response frames
2704 * internally.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002705 *
2706 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002707 */
2708 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2709 const struct wpabuf *proberesp,
2710 const struct wpabuf *assocresp);
2711
2712 /**
2713 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2714 * @priv: Private driver interface data
2715 * @authorized: Whether the port is authorized
2716 * Returns: 0 on success, -1 on failure
2717 */
2718 int (*set_supp_port)(void *priv, int authorized);
2719
2720 /**
2721 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2722 * @priv: Private driver interface data
2723 * @addr: MAC address of the associated station
2724 * @aid: Association ID
2725 * @val: 1 = bind to 4-address WDS; 0 = unbind
2726 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2727 * to indicate that bridge is not to be used
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07002728 * @ifname_wds: Buffer to return the interface name for the new WDS
2729 * station or %NULL to indicate name is not returned.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002730 * Returns: 0 on success, -1 on failure
2731 */
2732 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07002733 const char *bridge_ifname, char *ifname_wds);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002734
2735 /**
2736 * send_action - Transmit an Action frame
2737 * @priv: Private driver interface data
2738 * @freq: Frequency (in MHz) of the channel
2739 * @wait: Time to wait off-channel for a response (in ms), or zero
2740 * @dst: Destination MAC address (Address 1)
2741 * @src: Source MAC address (Address 2)
2742 * @bssid: BSSID (Address 3)
2743 * @data: Frame body
2744 * @data_len: data length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002745 @ @no_cck: Whether CCK rates must not be used to transmit this frame
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002746 * Returns: 0 on success, -1 on failure
2747 *
2748 * This command can be used to request the driver to transmit an action
2749 * frame to the specified destination.
2750 *
2751 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2752 * be transmitted on the given channel and the device will wait for a
2753 * response on that channel for the given wait time.
2754 *
2755 * If the flag is not set, the wait time will be ignored. In this case,
2756 * if a remain-on-channel duration is in progress, the frame must be
2757 * transmitted on that channel; alternatively the frame may be sent on
2758 * the current operational channel (if in associated state in station
2759 * mode or while operating as an AP.)
2760 */
2761 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2762 const u8 *dst, const u8 *src, const u8 *bssid,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002763 const u8 *data, size_t data_len, int no_cck);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002764
2765 /**
2766 * send_action_cancel_wait - Cancel action frame TX wait
2767 * @priv: Private driver interface data
2768 *
2769 * This command cancels the wait time associated with sending an action
2770 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2771 * set in the driver flags.
2772 */
2773 void (*send_action_cancel_wait)(void *priv);
2774
2775 /**
2776 * remain_on_channel - Remain awake on a channel
2777 * @priv: Private driver interface data
2778 * @freq: Frequency (in MHz) of the channel
2779 * @duration: Duration in milliseconds
2780 * Returns: 0 on success, -1 on failure
2781 *
2782 * This command is used to request the driver to remain awake on the
2783 * specified channel for the specified duration and report received
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08002784 * Action frames with EVENT_RX_MGMT events. Optionally, received
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002785 * Probe Request frames may also be requested to be reported by calling
2786 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2787 *
2788 * The driver may not be at the requested channel when this function
2789 * returns, i.e., the return code is only indicating whether the
2790 * request was accepted. The caller will need to wait until the
2791 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2792 * completed the channel change. This may take some time due to other
2793 * need for the radio and the caller should be prepared to timing out
2794 * its wait since there are no guarantees on when this request can be
2795 * executed.
2796 */
2797 int (*remain_on_channel)(void *priv, unsigned int freq,
2798 unsigned int duration);
2799
2800 /**
2801 * cancel_remain_on_channel - Cancel remain-on-channel operation
2802 * @priv: Private driver interface data
2803 *
2804 * This command can be used to cancel a remain-on-channel operation
2805 * before its originally requested duration has passed. This could be
2806 * used, e.g., when remain_on_channel() is used to request extra time
2807 * to receive a response to an Action frame and the response is
2808 * received when there is still unneeded time remaining on the
2809 * remain-on-channel operation.
2810 */
2811 int (*cancel_remain_on_channel)(void *priv);
2812
2813 /**
2814 * probe_req_report - Request Probe Request frames to be indicated
2815 * @priv: Private driver interface data
2816 * @report: Whether to report received Probe Request frames
2817 * Returns: 0 on success, -1 on failure (or if not supported)
2818 *
2819 * This command can be used to request the driver to indicate when
2820 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2821 * Since this operation may require extra resources, e.g., due to less
2822 * optimal hardware/firmware RX filtering, many drivers may disable
2823 * Probe Request reporting at least in station mode. This command is
2824 * used to notify the driver when the Probe Request frames need to be
2825 * reported, e.g., during remain-on-channel operations.
2826 */
2827 int (*probe_req_report)(void *priv, int report);
2828
2829 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002830 * deinit_ap - Deinitialize AP mode
2831 * @priv: Private driver interface data
2832 * Returns: 0 on success, -1 on failure (or if not supported)
2833 *
2834 * This optional function can be used to disable AP mode related
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07002835 * configuration. If the interface was not dynamically added,
2836 * change the driver mode to station mode to allow normal station
2837 * operations like scanning to be completed.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002838 */
2839 int (*deinit_ap)(void *priv);
2840
2841 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07002842 * deinit_p2p_cli - Deinitialize P2P client mode
2843 * @priv: Private driver interface data
2844 * Returns: 0 on success, -1 on failure (or if not supported)
2845 *
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07002846 * This optional function can be used to disable P2P client mode. If the
2847 * interface was not dynamically added, change the interface type back
2848 * to station mode.
Dmitry Shmidt04949592012-07-19 12:16:46 -07002849 */
2850 int (*deinit_p2p_cli)(void *priv);
2851
2852 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002853 * suspend - Notification on system suspend/hibernate event
2854 * @priv: Private driver interface data
2855 */
2856 void (*suspend)(void *priv);
2857
2858 /**
2859 * resume - Notification on system resume/thaw event
2860 * @priv: Private driver interface data
2861 */
2862 void (*resume)(void *priv);
2863
2864 /**
2865 * signal_monitor - Set signal monitoring parameters
2866 * @priv: Private driver interface data
2867 * @threshold: Threshold value for signal change events; 0 = disabled
2868 * @hysteresis: Minimum change in signal strength before indicating a
2869 * new event
2870 * Returns: 0 on success, -1 on failure (or if not supported)
2871 *
2872 * This function can be used to configure monitoring of signal strength
2873 * with the current AP. Whenever signal strength drops below the
2874 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2875 * should be generated assuming the signal strength has changed at
2876 * least %hysteresis from the previously indicated signal change event.
2877 */
2878 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2879
2880 /**
2881 * send_frame - Send IEEE 802.11 frame (testing use only)
2882 * @priv: Private driver interface data
2883 * @data: IEEE 802.11 frame with IEEE 802.11 header
2884 * @data_len: Size of the frame
2885 * @encrypt: Whether to encrypt the frame (if keys are set)
2886 * Returns: 0 on success, -1 on failure
2887 *
2888 * This function is only used for debugging purposes and is not
2889 * required to be implemented for normal operations.
2890 */
2891 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2892 int encrypt);
2893
2894 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002895 * get_noa - Get current Notice of Absence attribute payload
2896 * @priv: Private driver interface data
2897 * @buf: Buffer for returning NoA
2898 * @buf_len: Buffer length in octets
2899 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2900 * advertized, or -1 on failure
2901 *
2902 * This function is used to fetch the current Notice of Absence
2903 * attribute value from GO.
2904 */
2905 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2906
2907 /**
2908 * set_noa - Set Notice of Absence parameters for GO (testing)
2909 * @priv: Private driver interface data
2910 * @count: Count
2911 * @start: Start time in ms from next TBTT
2912 * @duration: Duration in ms
2913 * Returns: 0 on success or -1 on failure
2914 *
2915 * This function is used to set Notice of Absence parameters for GO. It
2916 * is used only for testing. To disable NoA, all parameters are set to
2917 * 0.
2918 */
2919 int (*set_noa)(void *priv, u8 count, int start, int duration);
2920
2921 /**
2922 * set_p2p_powersave - Set P2P power save options
2923 * @priv: Private driver interface data
2924 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2925 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2926 * @ctwindow: 0.. = change (msec), -1 = no change
2927 * Returns: 0 on success or -1 on failure
2928 */
2929 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2930 int ctwindow);
2931
2932 /**
2933 * ampdu - Enable/disable aggregation
2934 * @priv: Private driver interface data
2935 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2936 * Returns: 0 on success or -1 on failure
2937 */
2938 int (*ampdu)(void *priv, int ampdu);
2939
2940 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002941 * get_radio_name - Get physical radio name for the device
2942 * @priv: Private driver interface data
2943 * Returns: Radio name or %NULL if not known
2944 *
2945 * The returned data must not be modified by the caller. It is assumed
2946 * that any interface that has the same radio name as another is
2947 * sharing the same physical radio. This information can be used to
2948 * share scan results etc. information between the virtual interfaces
2949 * to speed up various operations.
2950 */
2951 const char * (*get_radio_name)(void *priv);
2952
2953 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002954 * send_tdls_mgmt - for sending TDLS management packets
2955 * @priv: private driver interface data
2956 * @dst: Destination (peer) MAC address
2957 * @action_code: TDLS action code for the mssage
2958 * @dialog_token: Dialog Token to use in the message (if needed)
2959 * @status_code: Status Code or Reason Code to use (if needed)
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002960 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07002961 * @initiator: Is the current end the TDLS link initiator
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002962 * @buf: TDLS IEs to add to the message
2963 * @len: Length of buf in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002964 * Returns: 0 on success, negative (<0) on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002965 *
2966 * This optional function can be used to send packet to driver which is
2967 * responsible for receiving and sending all TDLS packets.
2968 */
2969 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002970 u8 dialog_token, u16 status_code, u32 peer_capab,
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07002971 int initiator, const u8 *buf, size_t len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002972
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002973 /**
2974 * tdls_oper - Ask the driver to perform high-level TDLS operations
2975 * @priv: Private driver interface data
2976 * @oper: TDLS high-level operation. See %enum tdls_oper
2977 * @peer: Destination (peer) MAC address
2978 * Returns: 0 on success, negative (<0) on failure
2979 *
2980 * This optional function can be used to send high-level TDLS commands
2981 * to the driver.
2982 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002983 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2984
2985 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002986 * wnm_oper - Notify driver of the WNM frame reception
2987 * @priv: Private driver interface data
2988 * @oper: WNM operation. See %enum wnm_oper
2989 * @peer: Destination (peer) MAC address
2990 * @buf: Buffer for the driver to fill in (for getting IE)
2991 * @buf_len: Return the len of buf
2992 * Returns: 0 on success, negative (<0) on failure
2993 */
2994 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2995 u8 *buf, u16 *buf_len);
2996
2997 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -07002998 * set_qos_map - Set QoS Map
2999 * @priv: Private driver interface data
3000 * @qos_map_set: QoS Map
3001 * @qos_map_set_len: Length of QoS Map
3002 */
3003 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
3004 u8 qos_map_set_len);
3005
3006 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003007 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3008 * @priv: Private driver interface data
3009 * @version: IP version of the IP address, 4 or 6
3010 * @ipaddr: IP address for the neigh entry
3011 * @prefixlen: IP address prefix length
3012 * @addr: Corresponding MAC address
3013 * Returns: 0 on success, negative (<0) on failure
3014 */
3015 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
3016 int prefixlen, const u8 *addr);
3017
3018 /**
3019 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3020 * @priv: Private driver interface data
3021 * @version: IP version of the IP address, 4 or 6
3022 * @ipaddr: IP address for the neigh entry
3023 * Returns: 0 on success, negative (<0) on failure
3024 */
3025 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
3026
3027 /**
3028 * br_port_set_attr - Set a bridge port attribute
3029 * @attr: Bridge port attribute to set
3030 * @val: Value to be set
3031 * Returns: 0 on success, negative (<0) on failure
3032 */
3033 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
3034 unsigned int val);
3035
3036 /**
3037 * br_port_set_attr - Set a bridge network parameter
3038 * @param: Bridge parameter to set
3039 * @val: Value to be set
3040 * Returns: 0 on success, negative (<0) on failure
3041 */
3042 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
3043 unsigned int val);
3044
3045 /**
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07003046 * set_wowlan - Set wake-on-wireless triggers
3047 * @priv: Private driver interface data
3048 * @triggers: wowlan triggers
3049 */
3050 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
3051
3052 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003053 * signal_poll - Get current connection information
3054 * @priv: Private driver interface data
3055 * @signal_info: Connection info structure
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07003056 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003057 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003058
3059 /**
Jouni Malinen75ecf522011-06-27 15:19:46 -07003060 * set_authmode - Set authentication algorithm(s) for static WEP
3061 * @priv: Private driver interface data
3062 * @authmode: 1=Open System, 2=Shared Key, 3=both
3063 * Returns: 0 on success, -1 on failure
3064 *
3065 * This function can be used to set authentication algorithms for AP
3066 * mode when static WEP is used. If the driver uses user space MLME/SME
3067 * implementation, there is no need to implement this function.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003068 *
3069 * DEPRECATED - use set_ap() instead
Jouni Malinen75ecf522011-06-27 15:19:46 -07003070 */
3071 int (*set_authmode)(void *priv, int authmode);
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003072
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003073#ifdef ANDROID
Jouni Malinen75ecf522011-06-27 15:19:46 -07003074 /**
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003075 * driver_cmd - Execute driver-specific command
3076 * @priv: Private driver interface data
3077 * @cmd: Command to execute
3078 * @buf: Return buffer
3079 * @buf_len: Buffer length
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003080 * Returns: 0 on success, -1 on failure
3081 */
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003082 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
3083#endif /* ANDROID */
3084
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003085 /**
Dmitry Shmidta38abf92014-03-06 13:38:44 -08003086 * vendor_cmd - Execute vendor specific command
3087 * @priv: Private driver interface data
3088 * @vendor_id: Vendor id
3089 * @subcmd: Vendor command id
3090 * @data: Vendor command parameters (%NULL if no parameters)
3091 * @data_len: Data length
3092 * @buf: Return buffer (%NULL to ignore reply)
3093 * Returns: 0 on success, negative (<0) on failure
3094 *
3095 * This function handles vendor specific commands that are passed to
3096 * the driver/device. The command is identified by vendor id and
3097 * command id. Parameters can be passed as argument to the command
3098 * in the data buffer. Reply (if any) will be filled in the supplied
3099 * return buffer.
3100 *
3101 * The exact driver behavior is driver interface and vendor specific. As
3102 * an example, this will be converted to a vendor specific cfg80211
3103 * command in case of the nl80211 driver interface.
3104 */
3105 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3106 unsigned int subcmd, const u8 *data, size_t data_len,
3107 struct wpabuf *buf);
3108
3109 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003110 * set_rekey_info - Set rekey information
3111 * @priv: Private driver interface data
3112 * @kek: Current KEK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003113 * @kek_len: KEK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003114 * @kck: Current KCK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003115 * @kck_len: KCK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003116 * @replay_ctr: Current EAPOL-Key Replay Counter
3117 *
3118 * This optional function can be used to provide information for the
3119 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3120 * while the host (including wpa_supplicant) is sleeping.
3121 */
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003122 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3123 const u8 *kck, size_t kck_len,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003124 const u8 *replay_ctr);
3125
3126 /**
3127 * sta_assoc - Station association indication
3128 * @priv: Private driver interface data
3129 * @own_addr: Source address and BSSID for association frame
3130 * @addr: MAC address of the station to associate
3131 * @reassoc: flag to indicate re-association
3132 * @status: association response status code
3133 * @ie: assoc response ie buffer
3134 * @len: ie buffer length
3135 * Returns: 0 on success, -1 on failure
3136 *
3137 * This function indicates the driver to send (Re)Association
3138 * Response frame to the station.
3139 */
3140 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3141 int reassoc, u16 status, const u8 *ie, size_t len);
3142
3143 /**
3144 * sta_auth - Station authentication indication
3145 * @priv: Private driver interface data
3146 * @own_addr: Source address and BSSID for authentication frame
3147 * @addr: MAC address of the station to associate
3148 * @seq: authentication sequence number
3149 * @status: authentication response status code
3150 * @ie: authentication frame ie buffer
3151 * @len: ie buffer length
3152 *
3153 * This function indicates the driver to send Authentication frame
3154 * to the station.
3155 */
3156 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
3157 u16 seq, u16 status, const u8 *ie, size_t len);
3158
3159 /**
3160 * add_tspec - Add traffic stream
3161 * @priv: Private driver interface data
3162 * @addr: MAC address of the station to associate
3163 * @tspec_ie: tspec ie buffer
3164 * @tspec_ielen: tspec ie length
3165 * Returns: 0 on success, -1 on failure
3166 *
3167 * This function adds the traffic steam for the station
3168 * and fills the medium_time in tspec_ie.
3169 */
3170 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3171 size_t tspec_ielen);
3172
3173 /**
3174 * add_sta_node - Add a station node in the driver
3175 * @priv: Private driver interface data
3176 * @addr: MAC address of the station to add
3177 * @auth_alg: authentication algorithm used by the station
3178 * Returns: 0 on success, -1 on failure
3179 *
3180 * This function adds the station node in the driver, when
3181 * the station gets added by FT-over-DS.
3182 */
3183 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
3184
3185 /**
3186 * sched_scan - Request the driver to initiate scheduled scan
3187 * @priv: Private driver interface data
3188 * @params: Scan parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003189 * Returns: 0 on success, -1 on failure
3190 *
3191 * This operation should be used for scheduled scan offload to
3192 * the hardware. Every time scan results are available, the
3193 * driver should report scan results event for wpa_supplicant
3194 * which will eventually request the results with
3195 * wpa_driver_get_scan_results2(). This operation is optional
3196 * and if not provided or if it returns -1, we fall back to
3197 * normal host-scheduled scans.
3198 */
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003199 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003200
3201 /**
3202 * stop_sched_scan - Request the driver to stop a scheduled scan
3203 * @priv: Private driver interface data
3204 * Returns: 0 on success, -1 on failure
3205 *
3206 * This should cause the scheduled scan to be stopped and
3207 * results should stop being sent. Must be supported if
3208 * sched_scan is supported.
3209 */
3210 int (*stop_sched_scan)(void *priv);
3211
3212 /**
3213 * poll_client - Probe (null data or such) the given station
3214 * @priv: Private driver interface data
3215 * @own_addr: MAC address of sending interface
3216 * @addr: MAC address of the station to probe
3217 * @qos: Indicates whether station is QoS station
3218 *
3219 * This function is used to verify whether an associated station is
3220 * still present. This function does not need to be implemented if the
3221 * driver provides such inactivity polling mechanism.
3222 */
3223 void (*poll_client)(void *priv, const u8 *own_addr,
3224 const u8 *addr, int qos);
Dmitry Shmidt04949592012-07-19 12:16:46 -07003225
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003226 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003227 * radio_disable - Disable/enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003228 * @priv: Private driver interface data
Dmitry Shmidt04949592012-07-19 12:16:46 -07003229 * @disabled: 1=disable 0=enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003230 * Returns: 0 on success, -1 on failure
3231 *
Dmitry Shmidt04949592012-07-19 12:16:46 -07003232 * This optional command is for testing purposes. It can be used to
3233 * disable the radio on a testbed device to simulate out-of-radio-range
3234 * conditions.
3235 */
3236 int (*radio_disable)(void *priv, int disabled);
3237
3238 /**
3239 * switch_channel - Announce channel switch and migrate the GO to the
3240 * given frequency
3241 * @priv: Private driver interface data
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003242 * @settings: Settings for CSA period and new channel
Dmitry Shmidt04949592012-07-19 12:16:46 -07003243 * Returns: 0 on success, -1 on failure
3244 *
3245 * This function is used to move the GO to the legacy STA channel to
3246 * avoid frequency conflict in single channel concurrency.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003247 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003248 int (*switch_channel)(void *priv, struct csa_settings *settings);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003249
3250 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003251 * add_tx_ts - Add traffic stream
3252 * @priv: Private driver interface data
3253 * @tsid: Traffic stream ID
3254 * @addr: Receiver address
3255 * @user_prio: User priority of the traffic stream
3256 * @admitted_time: Admitted time for this TS in units of
3257 * 32 microsecond periods (per second).
3258 * Returns: 0 on success, -1 on failure
3259 */
3260 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3261 u16 admitted_time);
3262
3263 /**
3264 * del_tx_ts - Delete traffic stream
3265 * @priv: Private driver interface data
3266 * @tsid: Traffic stream ID
3267 * @addr: Receiver address
3268 * Returns: 0 on success, -1 on failure
3269 */
3270 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3271
3272 /**
3273 * Enable channel-switching with TDLS peer
3274 * @priv: Private driver interface data
3275 * @addr: MAC address of the TDLS peer
3276 * @oper_class: Operating class of the switch channel
3277 * @params: Channel specification
3278 * Returns: 0 on success, -1 on failure
3279 *
3280 * The function indicates to driver that it can start switching to a
3281 * different channel with a specified TDLS peer. The switching is
3282 * assumed on until canceled with tdls_disable_channel_switch().
3283 */
3284 int (*tdls_enable_channel_switch)(
3285 void *priv, const u8 *addr, u8 oper_class,
3286 const struct hostapd_freq_params *params);
3287
3288 /**
3289 * Disable channel switching with TDLS peer
3290 * @priv: Private driver interface data
3291 * @addr: MAC address of the TDLS peer
3292 * Returns: 0 on success, -1 on failure
3293 *
3294 * This function indicates to the driver that it should stop switching
3295 * with a given TDLS peer.
3296 */
3297 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3298
3299 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003300 * start_dfs_cac - Listen for radar interference on the channel
3301 * @priv: Private driver interface data
Dmitry Shmidt051af732013-10-22 13:52:46 -07003302 * @freq: Channel parameters
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003303 * Returns: 0 on success, -1 on failure
3304 */
Dmitry Shmidt051af732013-10-22 13:52:46 -07003305 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003306
3307 /**
3308 * stop_ap - Removes beacon from AP
3309 * @priv: Private driver interface data
3310 * Returns: 0 on success, -1 on failure (or if not supported)
3311 *
3312 * This optional function can be used to disable AP mode related
3313 * configuration. Unlike deinit_ap, it does not change to station
3314 * mode.
3315 */
3316 int (*stop_ap)(void *priv);
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003317
3318 /**
3319 * get_survey - Retrieve survey data
3320 * @priv: Private driver interface data
3321 * @freq: If set, survey data for the specified frequency is only
3322 * being requested. If not set, all survey data is requested.
3323 * Returns: 0 on success, -1 on failure
3324 *
3325 * Use this to retrieve:
3326 *
3327 * - the observed channel noise floor
3328 * - the amount of time we have spent on the channel
3329 * - the amount of time during which we have spent on the channel that
3330 * the radio has determined the medium is busy and we cannot
3331 * transmit
3332 * - the amount of time we have spent receiving data
3333 * - the amount of time we have spent transmitting data
3334 *
3335 * This data can be used for spectrum heuristics. One example is
3336 * Automatic Channel Selection (ACS). The channel survey data is
3337 * kept on a linked list on the channel data, one entry is added
3338 * for each survey. The min_nf of the channel is updated for each
3339 * survey.
3340 */
3341 int (*get_survey)(void *priv, unsigned int freq);
Dmitry Shmidt56052862013-10-04 10:23:25 -07003342
3343 /**
3344 * status - Get driver interface status information
3345 * @priv: Private driver interface data
3346 * @buf: Buffer for printing tou the status information
3347 * @buflen: Maximum length of the buffer
3348 * Returns: Length of written status information or -1 on failure
3349 */
3350 int (*status)(void *priv, char *buf, size_t buflen);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003351
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07003352 /**
3353 * roaming - Set roaming policy for driver-based BSS selection
3354 * @priv: Private driver interface data
3355 * @allowed: Whether roaming within ESS is allowed
3356 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3357 * Returns: Length of written status information or -1 on failure
3358 *
3359 * This optional callback can be used to update roaming policy from the
3360 * associate() command (bssid being set there indicates that the driver
3361 * should not roam before getting this roaming() call to allow roaming.
3362 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3363 * capability, roaming policy is handled within wpa_supplicant and there
3364 * is no need to implement or react to this callback.
3365 */
3366 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3367
3368 /**
3369 * set_mac_addr - Set MAC address
3370 * @priv: Private driver interface data
3371 * @addr: MAC address to use or %NULL for setting back to permanent
3372 * Returns: 0 on success, -1 on failure
3373 */
3374 int (*set_mac_addr)(void *priv, const u8 *addr);
3375
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003376#ifdef CONFIG_MACSEC
3377 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3378
3379 int (*macsec_deinit)(void *priv);
3380
3381 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003382 * macsec_get_capability - Inform MKA of this driver's capability
3383 * @priv: Private driver interface data
3384 * @cap: Driver's capability
3385 * Returns: 0 on success, -1 on failure
3386 */
3387 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);
3388
3389 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003390 * enable_protect_frames - Set protect frames status
3391 * @priv: Private driver interface data
3392 * @enabled: TRUE = protect frames enabled
3393 * FALSE = protect frames disabled
3394 * Returns: 0 on success, -1 on failure (or if not supported)
3395 */
3396 int (*enable_protect_frames)(void *priv, Boolean enabled);
3397
3398 /**
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08003399 * enable_encrypt - Set encryption status
3400 * @priv: Private driver interface data
3401 * @enabled: TRUE = encrypt outgoing traffic
3402 * FALSE = integrity-only protection on outgoing traffic
3403 * Returns: 0 on success, -1 on failure (or if not supported)
3404 */
3405 int (*enable_encrypt)(void *priv, Boolean enabled);
3406
3407 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003408 * set_replay_protect - Set replay protect status and window size
3409 * @priv: Private driver interface data
3410 * @enabled: TRUE = replay protect enabled
3411 * FALSE = replay protect disabled
3412 * @window: replay window size, valid only when replay protect enabled
3413 * Returns: 0 on success, -1 on failure (or if not supported)
3414 */
3415 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3416
3417 /**
3418 * set_current_cipher_suite - Set current cipher suite
3419 * @priv: Private driver interface data
3420 * @cs: EUI64 identifier
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003421 * Returns: 0 on success, -1 on failure (or if not supported)
3422 */
Dmitry Shmidt7d175302016-09-06 13:11:34 -07003423 int (*set_current_cipher_suite)(void *priv, u64 cs);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003424
3425 /**
3426 * enable_controlled_port - Set controlled port status
3427 * @priv: Private driver interface data
3428 * @enabled: TRUE = controlled port enabled
3429 * FALSE = controlled port disabled
3430 * Returns: 0 on success, -1 on failure (or if not supported)
3431 */
3432 int (*enable_controlled_port)(void *priv, Boolean enabled);
3433
3434 /**
3435 * get_receive_lowest_pn - Get receive lowest pn
3436 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003437 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003438 * Returns: 0 on success, -1 on failure (or if not supported)
3439 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003440 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003441
3442 /**
3443 * get_transmit_next_pn - Get transmit next pn
3444 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003445 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003446 * Returns: 0 on success, -1 on failure (or if not supported)
3447 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003448 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003449
3450 /**
3451 * set_transmit_next_pn - Set transmit next pn
3452 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003453 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003454 * Returns: 0 on success, -1 on failure (or if not supported)
3455 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003456 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003457
3458 /**
3459 * create_receive_sc - create secure channel for receiving
3460 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003461 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003462 * @conf_offset: confidentiality offset (0, 30, or 50)
3463 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3464 * 2 = Strict)
3465 * Returns: 0 on success, -1 on failure (or if not supported)
3466 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003467 int (*create_receive_sc)(void *priv, struct receive_sc *sc,
3468 unsigned int conf_offset,
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003469 int validation);
3470
3471 /**
3472 * delete_receive_sc - delete secure connection for receiving
3473 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003474 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003475 * Returns: 0 on success, -1 on failure
3476 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003477 int (*delete_receive_sc)(void *priv, struct receive_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003478
3479 /**
3480 * create_receive_sa - create secure association for receive
3481 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003482 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003483 * Returns: 0 on success, -1 on failure
3484 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003485 int (*create_receive_sa)(void *priv, struct receive_sa *sa);
3486
3487 /**
3488 * delete_receive_sa - Delete secure association for receive
3489 * @priv: Private driver interface data from init()
3490 * @sa: Secure association
3491 * Returns: 0 on success, -1 on failure
3492 */
3493 int (*delete_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003494
3495 /**
3496 * enable_receive_sa - enable the SA for receive
3497 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003498 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003499 * Returns: 0 on success, -1 on failure
3500 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003501 int (*enable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003502
3503 /**
3504 * disable_receive_sa - disable SA for receive
3505 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003506 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003507 * Returns: 0 on success, -1 on failure
3508 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003509 int (*disable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003510
3511 /**
3512 * create_transmit_sc - create secure connection for transmit
3513 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003514 * @sc: secure channel
3515 * @conf_offset: confidentiality offset (0, 30, or 50)
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003516 * Returns: 0 on success, -1 on failure
3517 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003518 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
3519 unsigned int conf_offset);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003520
3521 /**
3522 * delete_transmit_sc - delete secure connection for transmit
3523 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003524 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003525 * Returns: 0 on success, -1 on failure
3526 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003527 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003528
3529 /**
3530 * create_transmit_sa - create secure association for transmit
3531 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003532 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003533 * Returns: 0 on success, -1 on failure
3534 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003535 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);
3536
3537 /**
3538 * delete_transmit_sa - Delete secure association for transmit
3539 * @priv: Private driver interface data from init()
3540 * @sa: Secure association
3541 * Returns: 0 on success, -1 on failure
3542 */
3543 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003544
3545 /**
3546 * enable_transmit_sa - enable SA for transmit
3547 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003548 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003549 * Returns: 0 on success, -1 on failure
3550 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003551 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003552
3553 /**
3554 * disable_transmit_sa - disable SA for transmit
3555 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003556 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003557 * Returns: 0 on success, -1 on failure
3558 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003559 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003560#endif /* CONFIG_MACSEC */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003561
3562 /**
3563 * init_mesh - Driver specific initialization for mesh
3564 * @priv: Private driver interface data
3565 * Returns: 0 on success, -1 on failure
3566 */
3567 int (*init_mesh)(void *priv);
3568
3569 /**
3570 * join_mesh - Join a mesh network
3571 * @priv: Private driver interface data
3572 * @params: Mesh configuration parameters
3573 * Returns: 0 on success, -1 on failure
3574 */
3575 int (*join_mesh)(void *priv,
3576 struct wpa_driver_mesh_join_params *params);
3577
3578 /**
3579 * leave_mesh - Leave a mesh network
3580 * @priv: Private driver interface data
3581 * Returns 0 on success, -1 on failure
3582 */
3583 int (*leave_mesh)(void *priv);
3584
3585 /**
3586 * do_acs - Automatically select channel
3587 * @priv: Private driver interface data
3588 * @params: Parameters for ACS
3589 * Returns 0 on success, -1 on failure
3590 *
3591 * This command can be used to offload ACS to the driver if the driver
3592 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3593 */
3594 int (*do_acs)(void *priv, struct drv_acs_params *params);
Ravi Joshie6ccb162015-07-16 17:45:41 -07003595
3596 /**
3597 * set_band - Notify driver of band selection
3598 * @priv: Private driver interface data
3599 * @band: The selected band(s)
3600 * Returns 0 on success, -1 on failure
3601 */
3602 int (*set_band)(void *priv, enum set_band band);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08003603
3604 /**
3605 * get_pref_freq_list - Get preferred frequency list for an interface
3606 * @priv: Private driver interface data
3607 * @if_type: Interface type
3608 * @num: Number of channels
3609 * @freq_list: Preferred channel frequency list encoded in MHz values
3610 * Returns 0 on success, -1 on failure
3611 *
3612 * This command can be used to query the preferred frequency list from
3613 * the driver specific to a particular interface type.
3614 */
3615 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
3616 unsigned int *num, unsigned int *freq_list);
3617
3618 /**
3619 * set_prob_oper_freq - Indicate probable P2P operating channel
3620 * @priv: Private driver interface data
3621 * @freq: Channel frequency in MHz
3622 * Returns 0 on success, -1 on failure
3623 *
3624 * This command can be used to inform the driver of the operating
3625 * frequency that an ongoing P2P group formation is likely to come up
3626 * on. Local device is assuming P2P Client role.
3627 */
3628 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003629
3630 /**
3631 * abort_scan - Request the driver to abort an ongoing scan
3632 * @priv: Private driver interface data
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08003633 * @scan_cookie: Cookie identifying the scan request. This is used only
3634 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
3635 * was used to trigger scan. Otherwise, 0 is used.
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003636 * Returns 0 on success, -1 on failure
3637 */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08003638 int (*abort_scan)(void *priv, u64 scan_cookie);
Dmitry Shmidt849734c2016-05-27 09:59:01 -07003639
3640 /**
3641 * configure_data_frame_filters - Request to configure frame filters
3642 * @priv: Private driver interface data
3643 * @filter_flags: The type of frames to filter (bitfield of
3644 * WPA_DATA_FRAME_FILTER_FLAG_*)
3645 * Returns: 0 on success or -1 on failure
3646 */
3647 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07003648
3649 /**
3650 * get_ext_capab - Get extended capabilities for the specified interface
3651 * @priv: Private driver interface data
3652 * @type: Interface type for which to get extended capabilities
3653 * @ext_capab: Extended capabilities fetched
3654 * @ext_capab_mask: Extended capabilities mask
3655 * @ext_capab_len: Length of the extended capabilities
3656 * Returns: 0 on success or -1 on failure
3657 */
3658 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
3659 const u8 **ext_capab, const u8 **ext_capab_mask,
3660 unsigned int *ext_capab_len);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07003661
3662 /**
3663 * p2p_lo_start - Start offloading P2P listen to device
3664 * @priv: Private driver interface data
3665 * @freq: Listening frequency (MHz) for P2P listen
3666 * @period: Length of the listen operation in milliseconds
3667 * @interval: Interval for running the listen operation in milliseconds
3668 * @count: Number of times to run the listen operation
3669 * @device_types: Device primary and secondary types
3670 * @dev_types_len: Number of bytes for device_types
3671 * @ies: P2P IE and WSC IE for Probe Response frames
3672 * @ies_len: Length of ies in bytes
3673 * Returns: 0 on success or -1 on failure
3674 */
3675 int (*p2p_lo_start)(void *priv, unsigned int freq,
3676 unsigned int period, unsigned int interval,
3677 unsigned int count,
3678 const u8 *device_types, size_t dev_types_len,
3679 const u8 *ies, size_t ies_len);
3680
3681 /**
3682 * p2p_lo_stop - Stop P2P listen offload
3683 * @priv: Private driver interface data
3684 * Returns: 0 on success or -1 on failure
3685 */
3686 int (*p2p_lo_stop)(void *priv);
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07003687
3688 /**
3689 * set_default_scan_ies - Set default scan IEs
3690 * @priv: Private driver interface data
3691 * @ies: Scan default IEs buffer
3692 * @ies_len: Length of IEs in bytes
3693 * Returns: 0 on success or -1 on failure
3694 *
3695 * The driver can use these by default when there are no scan IEs coming
3696 * in the subsequent scan requests. Also in case of one or more of IEs
3697 * given in set_default_scan_ies() are missing in the subsequent scan
3698 * request, the driver should merge the missing scan IEs in the scan
3699 * request from the IEs set by set_default_scan_ies() in the Probe
3700 * Request frames sent.
3701 */
3702 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
3703
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003704 /**
3705 * set_tdls_mode - Set TDLS trigger mode to the host driver
3706 * @priv: Private driver interface data
3707 * @tdls_external_control: Represents if TDLS external trigger control
3708 * mode is enabled/disabled.
3709 *
3710 * This optional callback can be used to configure the TDLS external
3711 * trigger control mode to the host driver.
3712 */
3713 int (*set_tdls_mode)(void *priv, int tdls_external_control);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003714};
3715
3716
3717/**
3718 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3719 */
3720enum wpa_event_type {
3721 /**
3722 * EVENT_ASSOC - Association completed
3723 *
3724 * This event needs to be delivered when the driver completes IEEE
3725 * 802.11 association or reassociation successfully.
3726 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3727 * after this event has been generated. In addition, optional
3728 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3729 * more information about the association. If the driver interface gets
3730 * both of these events at the same time, it can also include the
3731 * assoc_info data in EVENT_ASSOC call.
3732 */
3733 EVENT_ASSOC,
3734
3735 /**
3736 * EVENT_DISASSOC - Association lost
3737 *
3738 * This event should be called when association is lost either due to
3739 * receiving deauthenticate or disassociate frame from the AP or when
3740 * sending either of these frames to the current AP. If the driver
3741 * supports separate deauthentication event, EVENT_DISASSOC should only
3742 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3743 * In AP mode, union wpa_event_data::disassoc_info is required.
3744 */
3745 EVENT_DISASSOC,
3746
3747 /**
3748 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3749 *
3750 * This event must be delivered when a Michael MIC error is detected by
3751 * the local driver. Additional data for event processing is
3752 * provided with union wpa_event_data::michael_mic_failure. This
3753 * information is used to request new encyption key and to initiate
3754 * TKIP countermeasures if needed.
3755 */
3756 EVENT_MICHAEL_MIC_FAILURE,
3757
3758 /**
3759 * EVENT_SCAN_RESULTS - Scan results available
3760 *
3761 * This event must be called whenever scan results are available to be
3762 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3763 * is expected to be used some time after struct wpa_driver_ops::scan()
3764 * is called. If the driver provides an unsolicited event when the scan
3765 * has been completed, this event can be used to trigger
3766 * EVENT_SCAN_RESULTS call. If such event is not available from the
3767 * driver, the driver wrapper code is expected to use a registered
3768 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3769 * scan is expected to be completed. Optional information about
3770 * completed scan can be provided with union wpa_event_data::scan_info.
3771 */
3772 EVENT_SCAN_RESULTS,
3773
3774 /**
3775 * EVENT_ASSOCINFO - Report optional extra information for association
3776 *
3777 * This event can be used to report extra association information for
3778 * EVENT_ASSOC processing. This extra information includes IEs from
3779 * association frames and Beacon/Probe Response frames in union
3780 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3781 * EVENT_ASSOC. Alternatively, the driver interface can include
3782 * assoc_info data in the EVENT_ASSOC call if it has all the
3783 * information available at the same point.
3784 */
3785 EVENT_ASSOCINFO,
3786
3787 /**
3788 * EVENT_INTERFACE_STATUS - Report interface status changes
3789 *
3790 * This optional event can be used to report changes in interface
3791 * status (interface added/removed) using union
3792 * wpa_event_data::interface_status. This can be used to trigger
3793 * wpa_supplicant to stop and re-start processing for the interface,
3794 * e.g., when a cardbus card is ejected/inserted.
3795 */
3796 EVENT_INTERFACE_STATUS,
3797
3798 /**
3799 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3800 *
3801 * This event can be used to inform wpa_supplicant about candidates for
3802 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3803 * for scan request (ap_scan=2 mode), this event is required for
3804 * pre-authentication. If wpa_supplicant is performing scan request
3805 * (ap_scan=1), this event is optional since scan results can be used
3806 * to add pre-authentication candidates. union
3807 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3808 * candidate and priority of the candidate, e.g., based on the signal
3809 * strength, in order to try to pre-authenticate first with candidates
3810 * that are most likely targets for re-association.
3811 *
3812 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3813 * on the candidate list. In addition, it can be called for the current
3814 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3815 * will automatically skip pre-authentication in cases where a valid
3816 * PMKSA exists. When more than one candidate exists, this event should
3817 * be generated once for each candidate.
3818 *
3819 * Driver will be notified about successful pre-authentication with
3820 * struct wpa_driver_ops::add_pmkid() calls.
3821 */
3822 EVENT_PMKID_CANDIDATE,
3823
3824 /**
3825 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3826 *
3827 * This event can be used to inform wpa_supplicant about desire to set
3828 * up secure direct link connection between two stations as defined in
3829 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3830 * STAKey negotiation. The caller will need to set peer address for the
3831 * event.
3832 */
3833 EVENT_STKSTART,
3834
3835 /**
3836 * EVENT_TDLS - Request TDLS operation
3837 *
3838 * This event can be used to request a TDLS operation to be performed.
3839 */
3840 EVENT_TDLS,
3841
3842 /**
3843 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3844 *
3845 * The driver is expected to report the received FT IEs from
3846 * FT authentication sequence from the AP. The FT IEs are included in
3847 * the extra information in union wpa_event_data::ft_ies.
3848 */
3849 EVENT_FT_RESPONSE,
3850
3851 /**
3852 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3853 *
3854 * The driver can use this event to inform wpa_supplicant about a STA
3855 * in an IBSS with which protected frames could be exchanged. This
3856 * event starts RSN authentication with the other STA to authenticate
3857 * the STA and set up encryption keys with it.
3858 */
3859 EVENT_IBSS_RSN_START,
3860
3861 /**
3862 * EVENT_AUTH - Authentication result
3863 *
3864 * This event should be called when authentication attempt has been
3865 * completed. This is only used if the driver supports separate
3866 * authentication step (struct wpa_driver_ops::authenticate).
3867 * Information about authentication result is included in
3868 * union wpa_event_data::auth.
3869 */
3870 EVENT_AUTH,
3871
3872 /**
3873 * EVENT_DEAUTH - Authentication lost
3874 *
3875 * This event should be called when authentication is lost either due
3876 * to receiving deauthenticate frame from the AP or when sending that
3877 * frame to the current AP.
3878 * In AP mode, union wpa_event_data::deauth_info is required.
3879 */
3880 EVENT_DEAUTH,
3881
3882 /**
3883 * EVENT_ASSOC_REJECT - Association rejected
3884 *
3885 * This event should be called when (re)association attempt has been
3886 * rejected by the AP. Information about the association response is
3887 * included in union wpa_event_data::assoc_reject.
3888 */
3889 EVENT_ASSOC_REJECT,
3890
3891 /**
3892 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3893 */
3894 EVENT_AUTH_TIMED_OUT,
3895
3896 /**
3897 * EVENT_ASSOC_TIMED_OUT - Association timed out
3898 */
3899 EVENT_ASSOC_TIMED_OUT,
3900
3901 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003902 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3903 */
3904 EVENT_WPS_BUTTON_PUSHED,
3905
3906 /**
3907 * EVENT_TX_STATUS - Report TX status
3908 */
3909 EVENT_TX_STATUS,
3910
3911 /**
3912 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3913 */
3914 EVENT_RX_FROM_UNKNOWN,
3915
3916 /**
3917 * EVENT_RX_MGMT - Report RX of a management frame
3918 */
3919 EVENT_RX_MGMT,
3920
3921 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003922 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3923 *
3924 * This event is used to indicate when the driver has started the
3925 * requested remain-on-channel duration. Information about the
3926 * operation is included in union wpa_event_data::remain_on_channel.
3927 */
3928 EVENT_REMAIN_ON_CHANNEL,
3929
3930 /**
3931 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3932 *
3933 * This event is used to indicate when the driver has completed
3934 * remain-on-channel duration, i.e., may noot be available on the
3935 * requested channel anymore. Information about the
3936 * operation is included in union wpa_event_data::remain_on_channel.
3937 */
3938 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3939
3940 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003941 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3942 *
3943 * This event is used to indicate when a Probe Request frame has been
3944 * received. Information about the received frame is included in
3945 * union wpa_event_data::rx_probe_req. The driver is required to report
3946 * these events only after successfully completed probe_req_report()
3947 * commands to request the events (i.e., report parameter is non-zero)
3948 * in station mode. In AP mode, Probe Request frames should always be
3949 * reported.
3950 */
3951 EVENT_RX_PROBE_REQ,
3952
3953 /**
3954 * EVENT_NEW_STA - New wired device noticed
3955 *
3956 * This event is used to indicate that a new device has been detected
3957 * in a network that does not use association-like functionality (i.e.,
3958 * mainly wired Ethernet). This can be used to start EAPOL
3959 * authenticator when receiving a frame from a device. The address of
3960 * the device is included in union wpa_event_data::new_sta.
3961 */
3962 EVENT_NEW_STA,
3963
3964 /**
3965 * EVENT_EAPOL_RX - Report received EAPOL frame
3966 *
3967 * When in AP mode with hostapd, this event is required to be used to
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003968 * deliver the receive EAPOL frames from the driver.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003969 */
3970 EVENT_EAPOL_RX,
3971
3972 /**
3973 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3974 *
3975 * This event is used to indicate changes in the signal strength
3976 * observed in frames received from the current AP if signal strength
3977 * monitoring has been enabled with signal_monitor().
3978 */
3979 EVENT_SIGNAL_CHANGE,
3980
3981 /**
3982 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3983 *
3984 * This event is used to indicate that the interface was enabled after
3985 * having been previously disabled, e.g., due to rfkill.
3986 */
3987 EVENT_INTERFACE_ENABLED,
3988
3989 /**
3990 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3991 *
3992 * This event is used to indicate that the interface was disabled,
3993 * e.g., due to rfkill.
3994 */
3995 EVENT_INTERFACE_DISABLED,
3996
3997 /**
3998 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3999 *
4000 * This event is used to indicate that the channel list has changed,
4001 * e.g., because of a regulatory domain change triggered by scan
4002 * results including an AP advertising a country code.
4003 */
4004 EVENT_CHANNEL_LIST_CHANGED,
4005
4006 /**
4007 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4008 *
4009 * This event is used to indicate that the driver cannot maintain this
4010 * interface in its operation mode anymore. The most likely use for
4011 * this is to indicate that AP mode operation is not available due to
4012 * operating channel would need to be changed to a DFS channel when
4013 * the driver does not support radar detection and another virtual
4014 * interfaces caused the operating channel to change. Other similar
4015 * resource conflicts could also trigger this for station mode
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07004016 * interfaces. This event can be propagated when channel switching
4017 * fails.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004018 */
4019 EVENT_INTERFACE_UNAVAILABLE,
4020
4021 /**
4022 * EVENT_BEST_CHANNEL
4023 *
4024 * Driver generates this event whenever it detects a better channel
4025 * (e.g., based on RSSI or channel use). This information can be used
4026 * to improve channel selection for a new AP/P2P group.
4027 */
4028 EVENT_BEST_CHANNEL,
4029
4030 /**
4031 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4032 *
4033 * This event should be called when a Deauthentication frame is dropped
4034 * due to it not being protected (MFP/IEEE 802.11w).
4035 * union wpa_event_data::unprot_deauth is required to provide more
4036 * details of the frame.
4037 */
4038 EVENT_UNPROT_DEAUTH,
4039
4040 /**
4041 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4042 *
4043 * This event should be called when a Disassociation frame is dropped
4044 * due to it not being protected (MFP/IEEE 802.11w).
4045 * union wpa_event_data::unprot_disassoc is required to provide more
4046 * details of the frame.
4047 */
4048 EVENT_UNPROT_DISASSOC,
4049
4050 /**
4051 * EVENT_STATION_LOW_ACK
4052 *
4053 * Driver generates this event whenever it detected that a particular
4054 * station was lost. Detection can be through massive transmission
4055 * failures for example.
4056 */
4057 EVENT_STATION_LOW_ACK,
4058
4059 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004060 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4061 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004062 EVENT_IBSS_PEER_LOST,
4063
4064 /**
4065 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4066 *
4067 * This event carries the new replay counter to notify wpa_supplicant
4068 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4069 * completed Group Key Handshake while the host (including
4070 * wpa_supplicant was sleeping).
4071 */
4072 EVENT_DRIVER_GTK_REKEY,
4073
4074 /**
4075 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4076 */
4077 EVENT_SCHED_SCAN_STOPPED,
4078
4079 /**
4080 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4081 *
4082 * This event indicates that the station responded to the poll
4083 * initiated with @poll_client.
4084 */
4085 EVENT_DRIVER_CLIENT_POLL_OK,
4086
4087 /**
4088 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4089 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07004090 EVENT_EAPOL_TX_STATUS,
4091
4092 /**
4093 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4094 *
4095 * Described in wpa_event_data.ch_switch
4096 * */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004097 EVENT_CH_SWITCH,
4098
4099 /**
4100 * EVENT_WNM - Request WNM operation
4101 *
4102 * This event can be used to request a WNM operation to be performed.
4103 */
Dmitry Shmidtf8623282013-02-20 14:34:59 -08004104 EVENT_WNM,
4105
4106 /**
4107 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4108 *
4109 * This event indicates that the driver reported a connection failure
4110 * with the specified client (for example, max client reached, etc.) in
4111 * AP mode.
4112 */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004113 EVENT_CONNECT_FAILED_REASON,
4114
4115 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004116 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004117 *
4118 * A radar has been detected on the supplied frequency, hostapd should
4119 * react accordingly (e.g., change channel).
4120 */
4121 EVENT_DFS_RADAR_DETECTED,
4122
4123 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004124 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004125 *
4126 * After a successful CAC, the channel can be marked clear and used.
4127 */
4128 EVENT_DFS_CAC_FINISHED,
4129
4130 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004131 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004132 *
4133 * The CAC was not successful, and the channel remains in the previous
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004134 * state. This may happen due to a radar being detected or other
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004135 * external influences.
4136 */
4137 EVENT_DFS_CAC_ABORTED,
4138
4139 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004140 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004141 *
4142 * The channel which was previously unavailable is now available again.
4143 */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004144 EVENT_DFS_NOP_FINISHED,
4145
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08004146 /**
4147 * EVENT_SURVEY - Received survey data
4148 *
4149 * This event gets triggered when a driver query is issued for survey
4150 * data and the requested data becomes available. The returned data is
4151 * stored in struct survey_results. The results provide at most one
4152 * survey entry for each frequency and at minimum will provide one
4153 * survey entry for one frequency. The survey data can be os_malloc()'d
4154 * and then os_free()'d, so the event callback must only copy data.
4155 */
4156 EVENT_SURVEY,
4157
4158 /**
4159 * EVENT_SCAN_STARTED - Scan started
4160 *
4161 * This indicates that driver has started a scan operation either based
4162 * on a request from wpa_supplicant/hostapd or from another application.
4163 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4164 * completed (either successfully or by getting cancelled).
4165 */
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08004166 EVENT_SCAN_STARTED,
4167
4168 /**
4169 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4170 *
4171 * This event indicates a set of frequency ranges that should be avoided
4172 * to reduce issues due to interference or internal co-existence
4173 * information in the driver.
4174 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004175 EVENT_AVOID_FREQUENCIES,
4176
4177 /**
4178 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4179 */
4180 EVENT_NEW_PEER_CANDIDATE,
4181
4182 /**
4183 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4184 *
4185 * Indicates a pair of primary and secondary channels chosen by ACS
4186 * in device.
4187 */
4188 EVENT_ACS_CHANNEL_SELECTED,
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004189
4190 /**
4191 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4192 * been started.
4193 *
4194 * This event indicates that channel availability check has been started
4195 * on a DFS frequency by a driver that supports DFS Offload.
4196 */
4197 EVENT_DFS_CAC_STARTED,
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004198
4199 /**
4200 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4201 */
4202 EVENT_P2P_LO_STOP,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004203};
4204
4205
4206/**
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004207 * struct freq_survey - Channel survey info
4208 *
4209 * @ifidx: Interface index in which this survey was observed
4210 * @freq: Center of frequency of the surveyed channel
4211 * @nf: Channel noise floor in dBm
4212 * @channel_time: Amount of time in ms the radio spent on the channel
4213 * @channel_time_busy: Amount of time in ms the radio detected some signal
4214 * that indicated to the radio the channel was not clear
4215 * @channel_time_rx: Amount of time the radio spent receiving data
4216 * @channel_time_tx: Amount of time the radio spent transmitting data
4217 * @filled: bitmask indicating which fields have been reported, see
4218 * SURVEY_HAS_* defines.
4219 * @list: Internal list pointers
4220 */
4221struct freq_survey {
4222 u32 ifidx;
4223 unsigned int freq;
4224 s8 nf;
4225 u64 channel_time;
4226 u64 channel_time_busy;
4227 u64 channel_time_rx;
4228 u64 channel_time_tx;
4229 unsigned int filled;
4230 struct dl_list list;
4231};
4232
4233#define SURVEY_HAS_NF BIT(0)
4234#define SURVEY_HAS_CHAN_TIME BIT(1)
4235#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4236#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4237#define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4238
4239
4240/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004241 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4242 */
4243union wpa_event_data {
4244 /**
4245 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4246 *
4247 * This structure is optional for EVENT_ASSOC calls and required for
4248 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4249 * driver interface does not need to generate separate EVENT_ASSOCINFO
4250 * calls.
4251 */
4252 struct assoc_info {
4253 /**
4254 * reassoc - Flag to indicate association or reassociation
4255 */
4256 int reassoc;
4257
4258 /**
4259 * req_ies - (Re)Association Request IEs
4260 *
4261 * If the driver generates WPA/RSN IE, this event data must be
4262 * returned for WPA handshake to have needed information. If
4263 * wpa_supplicant-generated WPA/RSN IE is used, this
4264 * information event is optional.
4265 *
4266 * This should start with the first IE (fixed fields before IEs
4267 * are not included).
4268 */
4269 const u8 *req_ies;
4270
4271 /**
4272 * req_ies_len - Length of req_ies in bytes
4273 */
4274 size_t req_ies_len;
4275
4276 /**
4277 * resp_ies - (Re)Association Response IEs
4278 *
4279 * Optional association data from the driver. This data is not
4280 * required WPA, but may be useful for some protocols and as
4281 * such, should be reported if this is available to the driver
4282 * interface.
4283 *
4284 * This should start with the first IE (fixed fields before IEs
4285 * are not included).
4286 */
4287 const u8 *resp_ies;
4288
4289 /**
4290 * resp_ies_len - Length of resp_ies in bytes
4291 */
4292 size_t resp_ies_len;
4293
4294 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004295 * resp_frame - (Re)Association Response frame
4296 */
4297 const u8 *resp_frame;
4298
4299 /**
4300 * resp_frame_len - (Re)Association Response frame length
4301 */
4302 size_t resp_frame_len;
4303
4304 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004305 * beacon_ies - Beacon or Probe Response IEs
4306 *
4307 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4308 * Probe Response frames from the current AP (i.e., the one
4309 * that the client just associated with). This information is
4310 * used to update WPA/RSN IE for the AP. If this field is not
4311 * set, the results from previous scan will be used. If no
4312 * data for the new AP is found, scan results will be requested
4313 * again (without scan request). At this point, the driver is
4314 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4315 * used).
4316 *
4317 * This should start with the first IE (fixed fields before IEs
4318 * are not included).
4319 */
4320 const u8 *beacon_ies;
4321
4322 /**
4323 * beacon_ies_len - Length of beacon_ies */
4324 size_t beacon_ies_len;
4325
4326 /**
4327 * freq - Frequency of the operational channel in MHz
4328 */
4329 unsigned int freq;
4330
4331 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004332 * wmm_params - WMM parameters used in this association.
4333 */
4334 struct wmm_params wmm_params;
4335
4336 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004337 * addr - Station address (for AP mode)
4338 */
4339 const u8 *addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004340
4341 /**
4342 * The following is the key management offload information
4343 * @authorized
4344 * @key_replay_ctr
4345 * @key_replay_ctr_len
4346 * @ptk_kck
4347 * @ptk_kek_len
4348 * @ptk_kek
4349 * @ptk_kek_len
4350 */
4351
4352 /**
4353 * authorized - Status of key management offload,
4354 * 1 = successful
4355 */
4356 int authorized;
4357
4358 /**
4359 * key_replay_ctr - Key replay counter value last used
4360 * in a valid EAPOL-Key frame
4361 */
4362 const u8 *key_replay_ctr;
4363
4364 /**
4365 * key_replay_ctr_len - The length of key_replay_ctr
4366 */
4367 size_t key_replay_ctr_len;
4368
4369 /**
4370 * ptk_kck - The derived PTK KCK
4371 */
4372 const u8 *ptk_kck;
4373
4374 /**
4375 * ptk_kek_len - The length of ptk_kck
4376 */
4377 size_t ptk_kck_len;
4378
4379 /**
4380 * ptk_kek - The derived PTK KEK
4381 */
4382 const u8 *ptk_kek;
4383
4384 /**
4385 * ptk_kek_len - The length of ptk_kek
4386 */
4387 size_t ptk_kek_len;
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004388
4389 /**
4390 * subnet_status - The subnet status:
4391 * 0 = unknown, 1 = unchanged, 2 = changed
4392 */
4393 u8 subnet_status;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004394 } assoc_info;
4395
4396 /**
4397 * struct disassoc_info - Data for EVENT_DISASSOC events
4398 */
4399 struct disassoc_info {
4400 /**
4401 * addr - Station address (for AP mode)
4402 */
4403 const u8 *addr;
4404
4405 /**
4406 * reason_code - Reason Code (host byte order) used in
4407 * Deauthentication frame
4408 */
4409 u16 reason_code;
4410
4411 /**
4412 * ie - Optional IE(s) in Disassociation frame
4413 */
4414 const u8 *ie;
4415
4416 /**
4417 * ie_len - Length of ie buffer in octets
4418 */
4419 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08004420
4421 /**
4422 * locally_generated - Whether the frame was locally generated
4423 */
4424 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004425 } disassoc_info;
4426
4427 /**
4428 * struct deauth_info - Data for EVENT_DEAUTH events
4429 */
4430 struct deauth_info {
4431 /**
4432 * addr - Station address (for AP mode)
4433 */
4434 const u8 *addr;
4435
4436 /**
4437 * reason_code - Reason Code (host byte order) used in
4438 * Deauthentication frame
4439 */
4440 u16 reason_code;
4441
4442 /**
4443 * ie - Optional IE(s) in Deauthentication frame
4444 */
4445 const u8 *ie;
4446
4447 /**
4448 * ie_len - Length of ie buffer in octets
4449 */
4450 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08004451
4452 /**
4453 * locally_generated - Whether the frame was locally generated
4454 */
4455 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004456 } deauth_info;
4457
4458 /**
4459 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4460 */
4461 struct michael_mic_failure {
4462 int unicast;
4463 const u8 *src;
4464 } michael_mic_failure;
4465
4466 /**
4467 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4468 */
4469 struct interface_status {
Dmitry Shmidte4663042016-04-04 10:07:49 -07004470 unsigned int ifindex;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004471 char ifname[100];
4472 enum {
4473 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4474 } ievent;
4475 } interface_status;
4476
4477 /**
4478 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4479 */
4480 struct pmkid_candidate {
4481 /** BSSID of the PMKID candidate */
4482 u8 bssid[ETH_ALEN];
4483 /** Smaller the index, higher the priority */
4484 int index;
4485 /** Whether RSN IE includes pre-authenticate flag */
4486 int preauth;
4487 } pmkid_candidate;
4488
4489 /**
4490 * struct stkstart - Data for EVENT_STKSTART
4491 */
4492 struct stkstart {
4493 u8 peer[ETH_ALEN];
4494 } stkstart;
4495
4496 /**
4497 * struct tdls - Data for EVENT_TDLS
4498 */
4499 struct tdls {
4500 u8 peer[ETH_ALEN];
4501 enum {
4502 TDLS_REQUEST_SETUP,
Dmitry Shmidt4dd28dc2015-03-10 11:21:43 -07004503 TDLS_REQUEST_TEARDOWN,
4504 TDLS_REQUEST_DISCOVER,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004505 } oper;
4506 u16 reason_code; /* for teardown */
4507 } tdls;
4508
4509 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004510 * struct wnm - Data for EVENT_WNM
4511 */
4512 struct wnm {
4513 u8 addr[ETH_ALEN];
4514 enum {
4515 WNM_OPER_SLEEP,
4516 } oper;
4517 enum {
4518 WNM_SLEEP_ENTER,
4519 WNM_SLEEP_EXIT
4520 } sleep_action;
4521 int sleep_intval;
4522 u16 reason_code;
4523 u8 *buf;
4524 u16 buf_len;
4525 } wnm;
4526
4527 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004528 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4529 *
4530 * During FT (IEEE 802.11r) authentication sequence, the driver is
4531 * expected to use this event to report received FT IEs (MDIE, FTIE,
4532 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4533 * IEs for the next message will be delivered through the
4534 * struct wpa_driver_ops::update_ft_ies() callback.
4535 */
4536 struct ft_ies {
4537 const u8 *ies;
4538 size_t ies_len;
4539 int ft_action;
4540 u8 target_ap[ETH_ALEN];
4541 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4542 const u8 *ric_ies;
4543 /** Length of ric_ies buffer in octets */
4544 size_t ric_ies_len;
4545 } ft_ies;
4546
4547 /**
4548 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4549 */
4550 struct ibss_rsn_start {
4551 u8 peer[ETH_ALEN];
4552 } ibss_rsn_start;
4553
4554 /**
4555 * struct auth_info - Data for EVENT_AUTH events
4556 */
4557 struct auth_info {
4558 u8 peer[ETH_ALEN];
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004559 u8 bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004560 u16 auth_type;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004561 u16 auth_transaction;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004562 u16 status_code;
4563 const u8 *ies;
4564 size_t ies_len;
4565 } auth;
4566
4567 /**
4568 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4569 */
4570 struct assoc_reject {
4571 /**
4572 * bssid - BSSID of the AP that rejected association
4573 */
4574 const u8 *bssid;
4575
4576 /**
4577 * resp_ies - (Re)Association Response IEs
4578 *
4579 * Optional association data from the driver. This data is not
4580 * required WPA, but may be useful for some protocols and as
4581 * such, should be reported if this is available to the driver
4582 * interface.
4583 *
4584 * This should start with the first IE (fixed fields before IEs
4585 * are not included).
4586 */
4587 const u8 *resp_ies;
4588
4589 /**
4590 * resp_ies_len - Length of resp_ies in bytes
4591 */
4592 size_t resp_ies_len;
4593
4594 /**
4595 * status_code - Status Code from (Re)association Response
4596 */
4597 u16 status_code;
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07004598
4599 /**
4600 * timed_out - Whether failure is due to timeout (etc.) rather
4601 * than explicit rejection response from the AP.
4602 */
4603 int timed_out;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004604 } assoc_reject;
4605
4606 struct timeout_event {
4607 u8 addr[ETH_ALEN];
4608 } timeout_event;
4609
4610 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004611 * struct tx_status - Data for EVENT_TX_STATUS events
4612 */
4613 struct tx_status {
4614 u16 type;
4615 u16 stype;
4616 const u8 *dst;
4617 const u8 *data;
4618 size_t data_len;
4619 int ack;
4620 } tx_status;
4621
4622 /**
4623 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4624 */
4625 struct rx_from_unknown {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004626 const u8 *bssid;
4627 const u8 *addr;
4628 int wds;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004629 } rx_from_unknown;
4630
4631 /**
4632 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4633 */
4634 struct rx_mgmt {
4635 const u8 *frame;
4636 size_t frame_len;
4637 u32 datarate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004638
4639 /**
Dmitry Shmidt98660862014-03-11 17:26:21 -07004640 * drv_priv - Pointer to store driver private BSS information
4641 *
4642 * If not set to NULL, this is used for comparison with
4643 * hostapd_data->drv_priv to determine which BSS should process
4644 * the frame.
4645 */
4646 void *drv_priv;
4647
4648 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004649 * freq - Frequency (in MHz) on which the frame was received
4650 */
4651 int freq;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08004652
4653 /**
4654 * ssi_signal - Signal strength in dBm (or 0 if not available)
4655 */
4656 int ssi_signal;
4657 } rx_mgmt;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004658
4659 /**
4660 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4661 *
4662 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4663 */
4664 struct remain_on_channel {
4665 /**
4666 * freq - Channel frequency in MHz
4667 */
4668 unsigned int freq;
4669
4670 /**
4671 * duration - Duration to remain on the channel in milliseconds
4672 */
4673 unsigned int duration;
4674 } remain_on_channel;
4675
4676 /**
4677 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4678 * @aborted: Whether the scan was aborted
4679 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4680 * @num_freqs: Number of entries in freqs array
4681 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4682 * SSID)
4683 * @num_ssids: Number of entries in ssids array
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004684 * @external_scan: Whether the scan info is for an external scan
4685 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
4686 * 0 if the source of the scan event is a vendor scan
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004687 */
4688 struct scan_info {
4689 int aborted;
4690 const int *freqs;
4691 size_t num_freqs;
4692 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4693 size_t num_ssids;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004694 int external_scan;
4695 int nl_scan_event;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004696 } scan_info;
4697
4698 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004699 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4700 */
4701 struct rx_probe_req {
4702 /**
4703 * sa - Source address of the received Probe Request frame
4704 */
4705 const u8 *sa;
4706
4707 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004708 * da - Destination address of the received Probe Request frame
4709 * or %NULL if not available
4710 */
4711 const u8 *da;
4712
4713 /**
4714 * bssid - BSSID of the received Probe Request frame or %NULL
4715 * if not available
4716 */
4717 const u8 *bssid;
4718
4719 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004720 * ie - IEs from the Probe Request body
4721 */
4722 const u8 *ie;
4723
4724 /**
4725 * ie_len - Length of ie buffer in octets
4726 */
4727 size_t ie_len;
Dmitry Shmidt04949592012-07-19 12:16:46 -07004728
4729 /**
4730 * signal - signal strength in dBm (or 0 if not available)
4731 */
4732 int ssi_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004733 } rx_probe_req;
4734
4735 /**
4736 * struct new_sta - Data for EVENT_NEW_STA events
4737 */
4738 struct new_sta {
4739 const u8 *addr;
4740 } new_sta;
4741
4742 /**
4743 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4744 */
4745 struct eapol_rx {
4746 const u8 *src;
4747 const u8 *data;
4748 size_t data_len;
4749 } eapol_rx;
4750
4751 /**
4752 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4753 */
4754 struct wpa_signal_info signal_change;
4755
4756 /**
4757 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4758 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4759 * @freq_5: Best 5 GHz band channel frequency in MHz
4760 * @freq_overall: Best channel frequency in MHz
4761 *
4762 * 0 can be used to indicate no preference in either band.
4763 */
4764 struct best_channel {
4765 int freq_24;
4766 int freq_5;
4767 int freq_overall;
4768 } best_chan;
4769
4770 struct unprot_deauth {
4771 const u8 *sa;
4772 const u8 *da;
4773 u16 reason_code;
4774 } unprot_deauth;
4775
4776 struct unprot_disassoc {
4777 const u8 *sa;
4778 const u8 *da;
4779 u16 reason_code;
4780 } unprot_disassoc;
4781
4782 /**
4783 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4784 * @addr: station address
4785 */
4786 struct low_ack {
4787 u8 addr[ETH_ALEN];
4788 } low_ack;
4789
4790 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004791 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4792 */
4793 struct ibss_peer_lost {
4794 u8 peer[ETH_ALEN];
4795 } ibss_peer_lost;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004796
4797 /**
4798 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4799 */
4800 struct driver_gtk_rekey {
4801 const u8 *bssid;
4802 const u8 *replay_ctr;
4803 } driver_gtk_rekey;
4804
4805 /**
4806 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4807 * @addr: station address
4808 */
4809 struct client_poll {
4810 u8 addr[ETH_ALEN];
4811 } client_poll;
4812
4813 /**
4814 * struct eapol_tx_status
4815 * @dst: Original destination
4816 * @data: Data starting with IEEE 802.1X header (!)
4817 * @data_len: Length of data
4818 * @ack: Indicates ack or lost frame
4819 *
4820 * This corresponds to hapd_send_eapol if the frame sent
4821 * there isn't just reported as EVENT_TX_STATUS.
4822 */
4823 struct eapol_tx_status {
4824 const u8 *dst;
4825 const u8 *data;
4826 int data_len;
4827 int ack;
4828 } eapol_tx_status;
Dmitry Shmidt04949592012-07-19 12:16:46 -07004829
4830 /**
4831 * struct ch_switch
4832 * @freq: Frequency of new channel in MHz
4833 * @ht_enabled: Whether this is an HT channel
4834 * @ch_offset: Secondary channel offset
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08004835 * @ch_width: Channel width
4836 * @cf1: Center frequency 1
4837 * @cf2: Center frequency 2
Dmitry Shmidt04949592012-07-19 12:16:46 -07004838 */
4839 struct ch_switch {
4840 int freq;
4841 int ht_enabled;
4842 int ch_offset;
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08004843 enum chan_width ch_width;
4844 int cf1;
4845 int cf2;
Dmitry Shmidt04949592012-07-19 12:16:46 -07004846 } ch_switch;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08004847
4848 /**
4849 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4850 * @addr: Remote client address
4851 * @code: Reason code for connection failure
4852 */
4853 struct connect_failed_reason {
4854 u8 addr[ETH_ALEN];
4855 enum {
4856 MAX_CLIENT_REACHED,
4857 BLOCKED_CLIENT
4858 } code;
4859 } connect_failed_reason;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004860
4861 /**
4862 * struct dfs_event - Data for radar detected events
4863 * @freq: Frequency of the channel in MHz
4864 */
4865 struct dfs_event {
4866 int freq;
Dmitry Shmidt051af732013-10-22 13:52:46 -07004867 int ht_enabled;
4868 int chan_offset;
4869 enum chan_width chan_width;
4870 int cf1;
4871 int cf2;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004872 } dfs_event;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004873
4874 /**
4875 * survey_results - Survey result data for EVENT_SURVEY
4876 * @freq_filter: Requested frequency survey filter, 0 if request
4877 * was for all survey data
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004878 * @survey_list: Linked list of survey data (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004879 */
4880 struct survey_results {
4881 unsigned int freq_filter;
4882 struct dl_list survey_list; /* struct freq_survey */
4883 } survey_results;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08004884
4885 /**
4886 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4887 * @initiator: Initiator of the regulatory change
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07004888 * @type: Regulatory change type
4889 * @alpha2: Country code (or "" if not available)
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08004890 */
4891 struct channel_list_changed {
4892 enum reg_change_initiator initiator;
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07004893 enum reg_type type;
4894 char alpha2[3];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08004895 } channel_list_changed;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08004896
4897 /**
4898 * freq_range - List of frequency ranges
4899 *
4900 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4901 */
4902 struct wpa_freq_range_list freq_range;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004903
4904 /**
4905 * struct mesh_peer
4906 *
4907 * @peer: Peer address
4908 * @ies: Beacon IEs
4909 * @ie_len: Length of @ies
4910 *
4911 * Notification of new candidate mesh peer.
4912 */
4913 struct mesh_peer {
4914 const u8 *peer;
4915 const u8 *ies;
4916 size_t ie_len;
4917 } mesh_peer;
4918
4919 /**
4920 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4921 * @pri_channel: Selected primary channel
4922 * @sec_channel: Selected secondary channel
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07004923 * @vht_seg0_center_ch: VHT mode Segment0 center channel
4924 * @vht_seg1_center_ch: VHT mode Segment1 center channel
4925 * @ch_width: Selected Channel width by driver. Driver may choose to
4926 * change hostapd configured ACS channel width due driver internal
4927 * channel restrictions.
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07004928 * hw_mode: Selected band (used with hw_mode=any)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004929 */
4930 struct acs_selected_channels {
4931 u8 pri_channel;
4932 u8 sec_channel;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07004933 u8 vht_seg0_center_ch;
4934 u8 vht_seg1_center_ch;
4935 u16 ch_width;
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07004936 enum hostapd_hw_mode hw_mode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004937 } acs_selected_channels;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004938
4939 /**
4940 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
4941 * @reason_code: Reason for stopping offload
4942 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
4943 * scheduled.
4944 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
4945 * be stopped.
4946 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
4947 * parameters.
4948 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
4949 * supported by device.
4950 */
4951 struct p2p_lo_stop {
4952 enum {
4953 P2P_LO_STOPPED_REASON_COMPLETE = 0,
4954 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
4955 P2P_LO_STOPPED_REASON_INVALID_PARAM,
4956 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
4957 } reason_code;
4958 } p2p_lo_stop;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004959};
4960
4961/**
4962 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4963 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4964 * with struct wpa_driver_ops::init()
4965 * @event: event type (defined above)
4966 * @data: possible extra data for the event
4967 *
4968 * Driver wrapper code should call this function whenever an event is received
4969 * from the driver.
4970 */
4971void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4972 union wpa_event_data *data);
4973
Dmitry Shmidte4663042016-04-04 10:07:49 -07004974/**
4975 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
4976 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4977 * with struct wpa_driver_ops::init()
4978 * @event: event type (defined above)
4979 * @data: possible extra data for the event
4980 *
4981 * Same as wpa_supplicant_event(), but we search for the interface in
4982 * wpa_global.
4983 */
4984void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
4985 union wpa_event_data *data);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004986
4987/*
4988 * The following inline functions are provided for convenience to simplify
4989 * event indication for some of the common events.
4990 */
4991
4992static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4993 size_t ielen, int reassoc)
4994{
4995 union wpa_event_data event;
4996 os_memset(&event, 0, sizeof(event));
4997 event.assoc_info.reassoc = reassoc;
4998 event.assoc_info.req_ies = ie;
4999 event.assoc_info.req_ies_len = ielen;
5000 event.assoc_info.addr = addr;
5001 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
5002}
5003
5004static inline void drv_event_disassoc(void *ctx, const u8 *addr)
5005{
5006 union wpa_event_data event;
5007 os_memset(&event, 0, sizeof(event));
5008 event.disassoc_info.addr = addr;
5009 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
5010}
5011
5012static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
5013 size_t data_len)
5014{
5015 union wpa_event_data event;
5016 os_memset(&event, 0, sizeof(event));
5017 event.eapol_rx.src = src;
5018 event.eapol_rx.data = data;
5019 event.eapol_rx.data_len = data_len;
5020 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
5021}
5022
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08005023/* driver_common.c */
5024void wpa_scan_results_free(struct wpa_scan_results *res);
5025
5026/* Convert wpa_event_type to a string for logging */
5027const char * event_to_string(enum wpa_event_type event);
5028
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07005029/* Convert chan_width to a string for logging and control interfaces */
5030const char * channel_width_to_string(enum chan_width width);
5031
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005032int ht_supported(const struct hostapd_hw_modes *mode);
5033int vht_supported(const struct hostapd_hw_modes *mode);
5034
5035struct wowlan_triggers *
5036wpa_get_wowlan_triggers(const char *wowlan_triggers,
5037 const struct wpa_driver_capa *capa);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07005038/* Convert driver flag to string */
5039const char * driver_flag_to_string(u64 flag);
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08005040
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005041/* NULL terminated array of linked in driver wrappers */
Dmitry Shmidt1d755d02015-04-28 10:34:29 -07005042extern const struct wpa_driver_ops *const wpa_drivers[];
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08005043
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07005044
5045/* Available drivers */
5046
5047#ifdef CONFIG_DRIVER_WEXT
5048extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
5049#endif /* CONFIG_DRIVER_WEXT */
5050#ifdef CONFIG_DRIVER_NL80211
5051/* driver_nl80211.c */
5052extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
5053#endif /* CONFIG_DRIVER_NL80211 */
5054#ifdef CONFIG_DRIVER_HOSTAP
5055extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
5056#endif /* CONFIG_DRIVER_HOSTAP */
5057#ifdef CONFIG_DRIVER_BSD
5058extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
5059#endif /* CONFIG_DRIVER_BSD */
5060#ifdef CONFIG_DRIVER_OPENBSD
5061/* driver_openbsd.c */
5062extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
5063#endif /* CONFIG_DRIVER_OPENBSD */
5064#ifdef CONFIG_DRIVER_NDIS
5065extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
5066#endif /* CONFIG_DRIVER_NDIS */
5067#ifdef CONFIG_DRIVER_WIRED
5068extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
5069#endif /* CONFIG_DRIVER_WIRED */
5070#ifdef CONFIG_DRIVER_MACSEC_QCA
5071/* driver_macsec_qca.c */
5072extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
5073#endif /* CONFIG_DRIVER_MACSEC_QCA */
Dmitry Shmidtabb90a32016-12-05 15:34:39 -08005074#ifdef CONFIG_DRIVER_MACSEC_LINUX
5075/* driver_macsec_linux.c */
5076extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops;
5077#endif /* CONFIG_DRIVER_MACSEC_LINUX */
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07005078#ifdef CONFIG_DRIVER_ROBOSWITCH
5079/* driver_roboswitch.c */
5080extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
5081#endif /* CONFIG_DRIVER_ROBOSWITCH */
5082#ifdef CONFIG_DRIVER_ATHEROS
5083/* driver_atheros.c */
5084extern const struct wpa_driver_ops wpa_driver_atheros_ops;
5085#endif /* CONFIG_DRIVER_ATHEROS */
5086#ifdef CONFIG_DRIVER_NONE
5087extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
5088#endif /* CONFIG_DRIVER_NONE */
5089
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005090#endif /* DRIVER_H */