blob: 9a6db909da5def64ae6ee6275b2bbd4fafab09e7 [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 Shmidtfb79edc2014-01-10 10:45:54 -0800461 /*
462 * NOTE: Whenever adding new parameters here, please make sure
463 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
464 * matching changes.
465 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700466};
467
468/**
469 * struct wpa_driver_auth_params - Authentication parameters
470 * Data for struct wpa_driver_ops::authenticate().
471 */
472struct wpa_driver_auth_params {
473 int freq;
474 const u8 *bssid;
475 const u8 *ssid;
476 size_t ssid_len;
477 int auth_alg;
478 const u8 *ie;
479 size_t ie_len;
480 const u8 *wep_key[4];
481 size_t wep_key_len[4];
482 int wep_tx_keyidx;
483 int local_state_change;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800484
485 /**
486 * p2p - Whether this connection is a P2P group
487 */
488 int p2p;
489
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800490 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800491 * auth_data - Additional elements for Authentication frame
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800492 *
493 * This buffer starts with the Authentication transaction sequence
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800494 * number field. If no special handling of such elements is needed, this
495 * pointer is %NULL. This is used with SAE and FILS.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800496 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800497 const u8 *auth_data;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800498
499 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800500 * auth_data_len - Length of auth_data buffer in octets
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800501 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800502 size_t auth_data_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700503};
504
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800505/**
506 * enum wps_mode - WPS mode
507 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700508enum wps_mode {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800509 /**
510 * WPS_MODE_NONE - No WPS provisioning being used
511 */
512 WPS_MODE_NONE,
513
514 /**
515 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
516 */
517 WPS_MODE_OPEN,
518
519 /**
520 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
521 */
522 WPS_MODE_PRIVACY
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700523};
524
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800525/**
526 * struct hostapd_freq_params - Channel parameters
527 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700528struct hostapd_freq_params {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800529 /**
530 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
531 */
532 enum hostapd_hw_mode mode;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700533
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800534 /**
535 * freq - Primary channel center frequency in MHz
536 */
537 int freq;
538
539 /**
540 * channel - Channel number
541 */
542 int channel;
543
544 /**
545 * ht_enabled - Whether HT is enabled
546 */
547 int ht_enabled;
548
549 /**
550 * sec_channel_offset - Secondary channel offset for HT40
551 *
552 * 0 = HT40 disabled,
553 * -1 = HT40 enabled, secondary channel below primary,
554 * 1 = HT40 enabled, secondary channel above primary
555 */
556 int sec_channel_offset;
557
558 /**
559 * vht_enabled - Whether VHT is enabled
560 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700561 int vht_enabled;
562
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800563 /**
564 * center_freq1 - Segment 0 center frequency in MHz
565 *
566 * Valid for both HT and VHT.
567 */
568 int center_freq1;
569
570 /**
571 * center_freq2 - Segment 1 center frequency in MHz
572 *
573 * Non-zero only for bandwidth 80 and an 80+80 channel
574 */
575 int center_freq2;
576
577 /**
578 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
579 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700580 int bandwidth;
581};
582
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700583/**
584 * struct wpa_driver_associate_params - Association parameters
585 * Data for struct wpa_driver_ops::associate().
586 */
587struct wpa_driver_associate_params {
588 /**
589 * bssid - BSSID of the selected AP
590 * This can be %NULL, if ap_scan=2 mode is used and the driver is
591 * responsible for selecting with which BSS to associate. */
592 const u8 *bssid;
593
594 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800595 * bssid_hint - BSSID of a proposed AP
596 *
597 * This indicates which BSS has been found a suitable candidate for
598 * initial association for drivers that use driver/firmwate-based BSS
599 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
600 * the driver from selecting other BSSes in the ESS.
601 */
602 const u8 *bssid_hint;
603
604 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700605 * ssid - The selected SSID
606 */
607 const u8 *ssid;
608
609 /**
610 * ssid_len - Length of the SSID (1..32)
611 */
612 size_t ssid_len;
613
614 /**
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700615 * freq - channel parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700616 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700617 struct hostapd_freq_params freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700618
619 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800620 * freq_hint - Frequency of the channel the proposed AP is using
621 *
622 * This provides a channel on which a suitable BSS has been found as a
623 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
624 * limit the driver from selecting other channels for
625 * driver/firmware-based BSS selection.
626 */
627 int freq_hint;
628
629 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700630 * bg_scan_period - Background scan period in seconds, 0 to disable
631 * background scan, or -1 to indicate no change to default driver
632 * configuration
633 */
634 int bg_scan_period;
635
636 /**
Dmitry Shmidt2ac5f602014-03-07 10:08:21 -0800637 * beacon_int - Beacon interval for IBSS or 0 to use driver default
638 */
639 int beacon_int;
640
641 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700642 * wpa_ie - WPA information element for (Re)Association Request
643 * WPA information element to be included in (Re)Association
644 * Request (including information element id and length). Use
645 * of this WPA IE is optional. If the driver generates the WPA
646 * IE, it can use pairwise_suite, group_suite, and
647 * key_mgmt_suite to select proper algorithms. In this case,
648 * the driver has to notify wpa_supplicant about the used WPA
649 * IE by generating an event that the interface code will
650 * convert into EVENT_ASSOCINFO data (see below).
651 *
652 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
653 * instead. The driver can determine which version is used by
654 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
655 * WPA2/RSN).
656 *
657 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
658 */
659 const u8 *wpa_ie;
660
661 /**
662 * wpa_ie_len - length of the wpa_ie
663 */
664 size_t wpa_ie_len;
665
666 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800667 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
668 */
669 unsigned int wpa_proto;
670
671 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800672 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700673 *
674 * This is usually ignored if @wpa_ie is used.
675 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800676 unsigned int pairwise_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700677
678 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800679 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700680 *
681 * This is usually ignored if @wpa_ie is used.
682 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800683 unsigned int group_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700684
685 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800686 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
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 key_mgmt_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700691
692 /**
693 * auth_alg - Allowed authentication algorithms
694 * Bit field of WPA_AUTH_ALG_*
695 */
696 int auth_alg;
697
698 /**
699 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
700 */
701 int mode;
702
703 /**
704 * wep_key - WEP keys for static WEP configuration
705 */
706 const u8 *wep_key[4];
707
708 /**
709 * wep_key_len - WEP key length for static WEP configuration
710 */
711 size_t wep_key_len[4];
712
713 /**
714 * wep_tx_keyidx - WEP TX key index for static WEP configuration
715 */
716 int wep_tx_keyidx;
717
718 /**
719 * mgmt_frame_protection - IEEE 802.11w management frame protection
720 */
721 enum mfp_options mgmt_frame_protection;
722
723 /**
724 * ft_ies - IEEE 802.11r / FT information elements
725 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
726 * for fast transition, this parameter is set to include the IEs that
727 * are to be sent in the next FT Authentication Request message.
728 * update_ft_ies() handler is called to update the IEs for further
729 * FT messages in the sequence.
730 *
731 * The driver should use these IEs only if the target AP is advertising
732 * the same mobility domain as the one included in the MDIE here.
733 *
734 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
735 * AP after the initial association. These IEs can only be used if the
736 * target AP is advertising support for FT and is using the same MDIE
737 * and SSID as the current AP.
738 *
739 * The driver is responsible for reporting the FT IEs received from the
740 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
741 * type. update_ft_ies() handler will then be called with the FT IEs to
742 * include in the next frame in the authentication sequence.
743 */
744 const u8 *ft_ies;
745
746 /**
747 * ft_ies_len - Length of ft_ies in bytes
748 */
749 size_t ft_ies_len;
750
751 /**
752 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
753 *
754 * This value is provided to allow the driver interface easier access
755 * to the current mobility domain. This value is set to %NULL if no
756 * mobility domain is currently active.
757 */
758 const u8 *ft_md;
759
760 /**
761 * passphrase - RSN passphrase for PSK
762 *
763 * This value is made available only for WPA/WPA2-Personal (PSK) and
764 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
765 * the 8..63 character ASCII passphrase, if available. Please note that
766 * this can be %NULL if passphrase was not used to generate the PSK. In
767 * that case, the psk field must be used to fetch the PSK.
768 */
769 const char *passphrase;
770
771 /**
772 * psk - RSN PSK (alternative for passphrase for PSK)
773 *
774 * This value is made available only for WPA/WPA2-Personal (PSK) and
775 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
776 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
777 * be prepared to handle %NULL value as an error.
778 */
779 const u8 *psk;
780
781 /**
782 * drop_unencrypted - Enable/disable unencrypted frame filtering
783 *
784 * Configure the driver to drop all non-EAPOL frames (both receive and
785 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
786 * still be allowed for key negotiation.
787 */
788 int drop_unencrypted;
789
790 /**
791 * prev_bssid - Previously used BSSID in this ESS
792 *
793 * When not %NULL, this is a request to use reassociation instead of
794 * association.
795 */
796 const u8 *prev_bssid;
797
798 /**
799 * wps - WPS mode
800 *
801 * If the driver needs to do special configuration for WPS association,
802 * this variable provides more information on what type of association
803 * is being requested. Most drivers should not need ot use this.
804 */
805 enum wps_mode wps;
806
807 /**
808 * p2p - Whether this connection is a P2P group
809 */
810 int p2p;
811
812 /**
813 * uapsd - UAPSD parameters for the network
814 * -1 = do not change defaults
815 * AP mode: 1 = enabled, 0 = disabled
816 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
817 */
818 int uapsd;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800819
820 /**
821 * fixed_bssid - Whether to force this BSSID in IBSS mode
822 * 1 = Fix this BSSID and prevent merges.
823 * 0 = Do not fix BSSID.
824 */
825 int fixed_bssid;
826
827 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -0800828 * fixed_freq - Fix control channel in IBSS mode
829 * 0 = don't fix control channel (default)
830 * 1 = fix control channel; this prevents IBSS merging with another
831 * channel
832 */
833 int fixed_freq;
834
835 /**
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800836 * disable_ht - Disable HT (IEEE 802.11n) for this connection
837 */
838 int disable_ht;
839
840 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800841 * htcaps - HT Capabilities over-rides
842 *
843 * Only bits set in the mask will be used, and not all values are used
844 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
845 *
846 * Pointer to struct ieee80211_ht_capabilities.
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800847 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800848 const u8 *htcaps;
849
850 /**
851 * htcaps_mask - HT Capabilities over-rides mask
852 *
853 * Pointer to struct ieee80211_ht_capabilities.
854 */
855 const u8 *htcaps_mask;
Dmitry Shmidt2f023192013-03-12 12:44:17 -0700856
857#ifdef CONFIG_VHT_OVERRIDES
858 /**
859 * disable_vht - Disable VHT for this connection
860 */
861 int disable_vht;
862
863 /**
864 * VHT capability overrides.
865 */
866 const struct ieee80211_vht_capabilities *vhtcaps;
867 const struct ieee80211_vht_capabilities *vhtcaps_mask;
868#endif /* CONFIG_VHT_OVERRIDES */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800869
870 /**
871 * req_key_mgmt_offload - Request key management offload for connection
872 *
873 * Request key management offload for this connection if the device
874 * supports it.
875 */
876 int req_key_mgmt_offload;
877
878 /**
879 * Flag for indicating whether this association includes support for
880 * RRM (Radio Resource Measurements)
881 */
882 int rrm_used;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -0800883
884 /**
885 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
886 * AP as usual. Valid for DMG network only.
887 */
888 int pbss;
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -0800889
890 /**
891 * fils_kek - KEK for FILS association frame protection (AES-SIV)
892 */
893 const u8 *fils_kek;
894
895 /**
896 * fils_kek_len: Length of fils_kek in bytes
897 */
898 size_t fils_kek_len;
899
900 /**
901 * fils_nonces - Nonces for FILS association frame protection
902 * (AES-SIV AAD)
903 */
904 const u8 *fils_nonces;
905
906 /**
907 * fils_nonces_len: Length of fils_nonce in bytes
908 */
909 size_t fils_nonces_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700910};
911
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800912enum hide_ssid {
913 NO_SSID_HIDING,
914 HIDDEN_SSID_ZERO_LEN,
915 HIDDEN_SSID_ZERO_CONTENTS
916};
917
Dmitry Shmidtb58836e2014-04-29 14:35:56 -0700918struct wowlan_triggers {
919 u8 any;
920 u8 disconnect;
921 u8 magic_pkt;
922 u8 gtk_rekey_failure;
923 u8 eap_identity_req;
924 u8 four_way_handshake;
925 u8 rfkill_release;
926};
927
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800928struct wpa_driver_ap_params {
929 /**
930 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
931 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -0800932 u8 *head;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800933
934 /**
935 * head_len - Length of the head buffer in octets
936 */
937 size_t head_len;
938
939 /**
940 * tail - Beacon tail following TIM IE
941 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -0800942 u8 *tail;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800943
944 /**
945 * tail_len - Length of the tail buffer in octets
946 */
947 size_t tail_len;
948
949 /**
950 * dtim_period - DTIM period
951 */
952 int dtim_period;
953
954 /**
955 * beacon_int - Beacon interval
956 */
957 int beacon_int;
958
959 /**
960 * basic_rates: -1 terminated array of basic rates in 100 kbps
961 *
962 * This parameter can be used to set a specific basic rate set for the
963 * BSS. If %NULL, default basic rate set is used.
964 */
965 int *basic_rates;
966
967 /**
968 * proberesp - Probe Response template
969 *
970 * This is used by drivers that reply to Probe Requests internally in
971 * AP mode and require the full Probe Response template.
972 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -0800973 u8 *proberesp;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800974
975 /**
976 * proberesp_len - Length of the proberesp buffer in octets
977 */
978 size_t proberesp_len;
979
980 /**
981 * ssid - The SSID to use in Beacon/Probe Response frames
982 */
983 const u8 *ssid;
984
985 /**
986 * ssid_len - Length of the SSID (1..32)
987 */
988 size_t ssid_len;
989
990 /**
991 * hide_ssid - Whether to hide the SSID
992 */
993 enum hide_ssid hide_ssid;
994
995 /**
996 * pairwise_ciphers - WPA_CIPHER_* bitfield
997 */
998 unsigned int pairwise_ciphers;
999
1000 /**
1001 * group_cipher - WPA_CIPHER_*
1002 */
1003 unsigned int group_cipher;
1004
1005 /**
1006 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1007 */
1008 unsigned int key_mgmt_suites;
1009
1010 /**
1011 * auth_algs - WPA_AUTH_ALG_* bitfield
1012 */
1013 unsigned int auth_algs;
1014
1015 /**
1016 * wpa_version - WPA_PROTO_* bitfield
1017 */
1018 unsigned int wpa_version;
1019
1020 /**
1021 * privacy - Whether privacy is used in the BSS
1022 */
1023 int privacy;
1024
1025 /**
1026 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1027 *
1028 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1029 * not use the full Beacon template.
1030 */
1031 const struct wpabuf *beacon_ies;
1032
1033 /**
1034 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1035 *
1036 * This is used to add IEs like WPS IE and P2P IE by drivers that
1037 * reply to Probe Request frames internally.
1038 */
1039 const struct wpabuf *proberesp_ies;
1040
1041 /**
1042 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
1043 *
1044 * This is used to add IEs like WPS IE by drivers that reply to
1045 * (Re)Association Request frames internally.
1046 */
1047 const struct wpabuf *assocresp_ies;
1048
1049 /**
1050 * isolate - Whether to isolate frames between associated stations
1051 *
1052 * If this is non-zero, the AP is requested to disable forwarding of
1053 * frames between associated stations.
1054 */
1055 int isolate;
1056
1057 /**
1058 * cts_protect - Whether CTS protection is enabled
1059 */
1060 int cts_protect;
1061
1062 /**
1063 * preamble - Whether short preamble is enabled
1064 */
1065 int preamble;
1066
1067 /**
1068 * short_slot_time - Whether short slot time is enabled
1069 *
1070 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1071 * not set (e.g., when 802.11g mode is not in use)
1072 */
1073 int short_slot_time;
1074
1075 /**
1076 * ht_opmode - HT operation mode or -1 if HT not in use
1077 */
1078 int ht_opmode;
1079
1080 /**
1081 * interworking - Whether Interworking is enabled
1082 */
1083 int interworking;
1084
1085 /**
1086 * hessid - Homogeneous ESS identifier or %NULL if not set
1087 */
1088 const u8 *hessid;
1089
1090 /**
1091 * access_network_type - Access Network Type (0..15)
1092 *
1093 * This is used for filtering Probe Request frames when Interworking is
1094 * enabled.
1095 */
1096 u8 access_network_type;
Dmitry Shmidt04949592012-07-19 12:16:46 -07001097
1098 /**
1099 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1100 *
1101 * This is used by driver which advertises this capability.
1102 */
1103 int ap_max_inactivity;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001104
1105 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001106 * ctwindow - Client Traffic Window (in TUs)
1107 */
1108 u8 p2p_go_ctwindow;
1109
1110 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001111 * smps_mode - SMPS mode
1112 *
1113 * SMPS mode to be used by the AP, specified as the relevant bits of
1114 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1115 */
1116 unsigned int smps_mode;
1117
1118 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001119 * disable_dgaf - Whether group-addressed frames are disabled
1120 */
1121 int disable_dgaf;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001122
1123 /**
1124 * osen - Whether OSEN security is enabled
1125 */
1126 int osen;
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001127
1128 /**
1129 * freq - Channel parameters for dynamic bandwidth changes
1130 */
1131 struct hostapd_freq_params *freq;
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001132
1133 /**
1134 * reenable - Whether this is to re-enable beaconing
1135 */
1136 int reenable;
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001137
1138 /**
1139 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1140 * infrastructure BSS. Valid only for DMG network.
1141 */
1142 int pbss;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001143};
1144
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001145struct wpa_driver_mesh_bss_params {
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001146#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1147#define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1148#define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
1149#define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001150 /*
1151 * TODO: Other mesh configuration parameters would go here.
1152 * See NL80211_MESHCONF_* for all the mesh config parameters.
1153 */
1154 unsigned int flags;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001155 int auto_plinks;
Dmitry Shmidt2f74e362015-01-21 13:19:05 -08001156 int peer_link_timeout;
Dmitry Shmidtd13095b2016-08-22 14:02:19 -07001157 int max_peer_links;
1158 u16 ht_opmode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001159};
1160
1161struct wpa_driver_mesh_join_params {
1162 const u8 *meshid;
1163 int meshid_len;
1164 const int *basic_rates;
1165 const u8 *ies;
1166 int ie_len;
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001167 struct hostapd_freq_params freq;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001168 int beacon_int;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001169 int dtim_period;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001170 struct wpa_driver_mesh_bss_params conf;
1171#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1172#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1173#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1174#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1175 unsigned int flags;
1176};
1177
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001178/**
1179 * struct wpa_driver_capa - Driver capability information
1180 */
1181struct wpa_driver_capa {
1182#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1183#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1184#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1185#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1186#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1187#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1188#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001189#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
Dmitry Shmidt807291d2015-01-27 13:40:23 -08001190#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1191#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001192 /** Bitfield of supported key management suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001193 unsigned int key_mgmt;
1194
1195#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1196#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1197#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1198#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
Dmitry Shmidt04949592012-07-19 12:16:46 -07001199#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001200#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001201#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1202#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1203#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1204#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1205#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1206#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001207#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001208 /** Bitfield of supported cipher suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001209 unsigned int enc;
1210
1211#define WPA_DRIVER_AUTH_OPEN 0x00000001
1212#define WPA_DRIVER_AUTH_SHARED 0x00000002
1213#define WPA_DRIVER_AUTH_LEAP 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001214 /** Bitfield of supported IEEE 802.11 authentication algorithms */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001215 unsigned int auth;
1216
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001217/** Driver generated WPA/RSN IE */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001218#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001219/** Driver needs static WEP key setup after association command */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001220#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001221/** Driver takes care of all DFS operations */
Dmitry Shmidtd11f0192014-03-24 12:09:47 -07001222#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001223/** Driver takes care of RSN 4-way handshake internally; PMK is configured with
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001224 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1225#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001226/** Driver is for a wired Ethernet interface */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001227#define WPA_DRIVER_FLAGS_WIRED 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001228/** Driver provides separate commands for authentication and association (SME in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001229 * wpa_supplicant). */
1230#define WPA_DRIVER_FLAGS_SME 0x00000020
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001231/** Driver supports AP mode */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001232#define WPA_DRIVER_FLAGS_AP 0x00000040
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001233/** Driver needs static WEP key setup after association has been completed */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001234#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001235/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001236#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001237/** Driver supports concurrent P2P operations */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001238#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001239/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001240 * Driver uses the initial interface as a dedicated management interface, i.e.,
1241 * it cannot be used for P2P group operations or non-P2P purposes.
1242 */
1243#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001244/** This interface is P2P capable (P2P GO or P2P Client) */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001245#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001246/** Driver supports station and key removal when stopping an AP */
Dmitry Shmidta38abf92014-03-06 13:38:44 -08001247#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001248/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001249 * Driver uses the initial interface for P2P management interface and non-P2P
1250 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1251 * P2P group operations.
1252 */
1253#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001254/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001255 * Driver is known to use sane error codes, i.e., when it indicates that
1256 * something (e.g., association) fails, there was indeed a failure and the
1257 * operation does not end up getting completed successfully later.
1258 */
1259#define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001260/** Driver supports off-channel TX */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001261#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001262/** Driver indicates TX status events for EAPOL Data frames */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001263#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001264/** Driver indicates TX status events for Deauth/Disassoc frames */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001265#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001266/** Driver supports roaming (BSS selection) in firmware */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001267#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001268/** Driver supports operating as a TDLS peer */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001269#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001270/** Driver requires external TDLS setup/teardown/discovery */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001271#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001272/** Driver indicates support for Probe Response offloading in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001273#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001274/** Driver supports U-APSD in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001275#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001276/** Driver supports inactivity timer in AP mode */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001277#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001278/** Driver expects user space implementation of MLME in AP mode */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001279#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001280/** Driver supports SAE with user space SME */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001281#define WPA_DRIVER_FLAGS_SAE 0x02000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001282/** Driver makes use of OBSS scan mechanism in wpa_supplicant */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001283#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001284/** Driver supports IBSS (Ad-hoc) mode */
Dmitry Shmidt700a1372013-03-15 14:14:44 -07001285#define WPA_DRIVER_FLAGS_IBSS 0x08000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001286/** Driver supports radar detection */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07001287#define WPA_DRIVER_FLAGS_RADAR 0x10000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001288/** Driver supports a dedicated interface for P2P Device */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001289#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001290/** Driver supports QoS Mapping */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001291#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001292/** Driver supports CSA in AP mode */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001293#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001294/** Driver supports mesh */
1295#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1296/** Driver support ACS offload */
1297#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1298/** Driver supports key management offload */
1299#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1300/** Driver supports TDLS channel switching */
1301#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001302/** Driver supports IBSS with HT datarates */
1303#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
Dmitry Shmidt7f656022015-02-25 14:36:37 -08001304/** Driver supports IBSS with VHT datarates */
1305#define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07001306/** Driver supports automatic band selection */
1307#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001308/** Driver supports simultaneous off-channel operations */
1309#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001310/** Driver supports full AP client state */
1311#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001312/** Driver supports P2P Listen offload */
1313#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08001314/** Driver supports FILS */
1315#define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001316 u64 flags;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001317
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001318#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1319 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1320
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001321#define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1322#define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1323 unsigned int smps_modes;
1324
1325 unsigned int wmm_ac_supported:1;
1326
1327 unsigned int mac_addr_rand_scan_supported:1;
1328 unsigned int mac_addr_rand_sched_scan_supported:1;
1329
1330 /** Maximum number of supported active probe SSIDs */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001331 int max_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001332
1333 /** Maximum number of supported active probe SSIDs for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001334 int max_sched_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001335
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08001336 /** Maximum number of supported scan plans for scheduled scan */
1337 unsigned int max_sched_scan_plans;
1338
1339 /** Maximum interval in a scan plan. In seconds */
1340 u32 max_sched_scan_plan_interval;
1341
1342 /** Maximum number of iterations in a single scan plan */
1343 u32 max_sched_scan_plan_iterations;
1344
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001345 /** Whether sched_scan (offloaded scanning) is supported */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001346 int sched_scan_supported;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001347
1348 /** Maximum number of supported match sets for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001349 int max_match_sets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001350
1351 /**
1352 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1353 */
1354 unsigned int max_remain_on_chan;
1355
1356 /**
1357 * max_stations - Maximum number of associated stations the driver
1358 * supports in AP mode
1359 */
1360 unsigned int max_stations;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001361
1362 /**
1363 * probe_resp_offloads - Bitmap of supported protocols by the driver
1364 * for Probe Response offloading.
1365 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001366/** Driver Probe Response offloading support for WPS ver. 1 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001367#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001368/** Driver Probe Response offloading support for WPS ver. 2 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001369#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001370/** Driver Probe Response offloading support for P2P */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001371#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001372/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001373#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1374 unsigned int probe_resp_offloads;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001375
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07001376 unsigned int max_acl_mac_addrs;
1377
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001378 /**
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07001379 * Number of supported concurrent channels
1380 */
1381 unsigned int num_multichan_concurrent;
1382
1383 /**
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001384 * extended_capa - extended capabilities in driver/device
1385 *
1386 * Must be allocated and freed by driver and the pointers must be
1387 * valid for the lifetime of the driver, i.e., freed in deinit()
1388 */
1389 const u8 *extended_capa, *extended_capa_mask;
1390 unsigned int extended_capa_len;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001391
1392 struct wowlan_triggers wowlan_triggers;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001393
1394/** Driver adds the DS Params Set IE in Probe Request frames */
1395#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1396/** Driver adds the WFA TPC IE in Probe Request frames */
1397#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1398/** Driver handles quiet period requests */
1399#define WPA_DRIVER_FLAGS_QUIET 0x00000004
1400/**
1401 * Driver is capable of inserting the current TX power value into the body of
1402 * transmitted frames.
1403 * Background: Some Action frames include a TPC Report IE. This IE contains a
1404 * TX power field, which has to be updated by lower layers. One such Action
1405 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1406 * of spectrum management). Note that this insertion takes place at a fixed
1407 * offset, namely the 6th byte in the Action frame body.
1408 */
1409#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001410/**
1411 * Driver supports RRM. With this support, the driver will accept to use RRM in
1412 * (Re)Association Request frames, without supporting quiet period.
1413 */
1414#define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1415
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001416 u32 rrm_flags;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001417
1418 /* Driver concurrency capabilities */
1419 unsigned int conc_capab;
1420 /* Maximum number of concurrent channels on 2.4 GHz */
1421 unsigned int max_conc_chan_2_4;
1422 /* Maximum number of concurrent channels on 5 GHz */
1423 unsigned int max_conc_chan_5_0;
1424
1425 /* Maximum number of supported CSA counters */
1426 u16 max_csa_counters;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001427};
1428
1429
1430struct hostapd_data;
1431
1432struct hostap_sta_driver_data {
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001433 unsigned long rx_packets, tx_packets;
1434 unsigned long long rx_bytes, tx_bytes;
1435 int bytes_64bit; /* whether 64-bit byte counters are supported */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001436 unsigned long current_tx_rate;
1437 unsigned long inactive_msec;
1438 unsigned long flags;
1439 unsigned long num_ps_buf_frames;
1440 unsigned long tx_retry_failed;
1441 unsigned long tx_retry_count;
1442 int last_rssi;
1443 int last_ack_rssi;
1444};
1445
1446struct hostapd_sta_add_params {
1447 const u8 *addr;
1448 u16 aid;
1449 u16 capability;
1450 const u8 *supp_rates;
1451 size_t supp_rates_len;
1452 u16 listen_interval;
1453 const struct ieee80211_ht_capabilities *ht_capabilities;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001454 const struct ieee80211_vht_capabilities *vht_capabilities;
Dmitry Shmidtbd14a572014-02-18 10:33:49 -08001455 int vht_opmode_enabled;
1456 u8 vht_opmode;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001457 u32 flags; /* bitmask of WPA_STA_* flags */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001458 u32 flags_mask; /* unset bits in flags */
1459#ifdef CONFIG_MESH
1460 enum mesh_plink_state plink_state;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07001461 u16 peer_aid;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001462#endif /* CONFIG_MESH */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001463 int set; /* Set STA parameters instead of add */
1464 u8 qosinfo;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08001465 const u8 *ext_capab;
1466 size_t ext_capab_len;
Dmitry Shmidt344abd32014-01-14 13:17:00 -08001467 const u8 *supp_channels;
1468 size_t supp_channels_len;
1469 const u8 *supp_oper_classes;
1470 size_t supp_oper_classes_len;
Dmitry Shmidt849734c2016-05-27 09:59:01 -07001471 int support_p2p_ps;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001472};
1473
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07001474struct mac_address {
1475 u8 addr[ETH_ALEN];
1476};
1477
1478struct hostapd_acl_params {
1479 u8 acl_policy;
1480 unsigned int num_mac_acl;
1481 struct mac_address mac_acl[0];
1482};
1483
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001484enum wpa_driver_if_type {
1485 /**
1486 * WPA_IF_STATION - Station mode interface
1487 */
1488 WPA_IF_STATION,
1489
1490 /**
1491 * WPA_IF_AP_VLAN - AP mode VLAN interface
1492 *
1493 * This interface shares its address and Beacon frame with the main
1494 * BSS.
1495 */
1496 WPA_IF_AP_VLAN,
1497
1498 /**
1499 * WPA_IF_AP_BSS - AP mode BSS interface
1500 *
1501 * This interface has its own address and Beacon frame.
1502 */
1503 WPA_IF_AP_BSS,
1504
1505 /**
1506 * WPA_IF_P2P_GO - P2P Group Owner
1507 */
1508 WPA_IF_P2P_GO,
1509
1510 /**
1511 * WPA_IF_P2P_CLIENT - P2P Client
1512 */
1513 WPA_IF_P2P_CLIENT,
1514
1515 /**
1516 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1517 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1518 */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001519 WPA_IF_P2P_GROUP,
1520
1521 /**
1522 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1523 * abstracted P2P Device function in the driver
1524 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001525 WPA_IF_P2P_DEVICE,
1526
1527 /*
1528 * WPA_IF_MESH - Mesh interface
1529 */
1530 WPA_IF_MESH,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001531
1532 /*
1533 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1534 */
1535 WPA_IF_TDLS,
1536
1537 /*
1538 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1539 */
1540 WPA_IF_IBSS,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001541};
1542
1543struct wpa_init_params {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001544 void *global_priv;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001545 const u8 *bssid;
1546 const char *ifname;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001547 const char *driver_params;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001548 int use_pae_group_addr;
1549 char **bridge;
1550 size_t num_bridge;
1551
1552 u8 *own_addr; /* buffer for writing own MAC address */
1553};
1554
1555
1556struct wpa_bss_params {
1557 /** Interface name (for multi-SSID/VLAN support) */
1558 const char *ifname;
1559 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1560 int enabled;
1561
1562 int wpa;
1563 int ieee802_1x;
1564 int wpa_group;
1565 int wpa_pairwise;
1566 int wpa_key_mgmt;
1567 int rsn_preauth;
1568 enum mfp_options ieee80211w;
1569};
1570
1571#define WPA_STA_AUTHORIZED BIT(0)
1572#define WPA_STA_WMM BIT(1)
1573#define WPA_STA_SHORT_PREAMBLE BIT(2)
1574#define WPA_STA_MFP BIT(3)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001575#define WPA_STA_TDLS_PEER BIT(4)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001576#define WPA_STA_AUTHENTICATED BIT(5)
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08001577#define WPA_STA_ASSOCIATED BIT(6)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001578
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001579enum tdls_oper {
1580 TDLS_DISCOVERY_REQ,
1581 TDLS_SETUP,
1582 TDLS_TEARDOWN,
1583 TDLS_ENABLE_LINK,
1584 TDLS_DISABLE_LINK,
1585 TDLS_ENABLE,
1586 TDLS_DISABLE
1587};
1588
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001589enum wnm_oper {
1590 WNM_SLEEP_ENTER_CONFIRM,
1591 WNM_SLEEP_ENTER_FAIL,
1592 WNM_SLEEP_EXIT_CONFIRM,
1593 WNM_SLEEP_EXIT_FAIL,
1594 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1595 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1596 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1597 * a STA */
1598 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1599 * for a STA */
1600 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1601 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1602 * for a STA */
1603 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1604};
1605
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001606/* enum chan_width - Channel width definitions */
1607enum chan_width {
1608 CHAN_WIDTH_20_NOHT,
1609 CHAN_WIDTH_20,
1610 CHAN_WIDTH_40,
1611 CHAN_WIDTH_80,
1612 CHAN_WIDTH_80P80,
1613 CHAN_WIDTH_160,
1614 CHAN_WIDTH_UNKNOWN
1615};
1616
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001617/**
1618 * struct wpa_signal_info - Information about channel signal quality
1619 */
1620struct wpa_signal_info {
1621 u32 frequency;
1622 int above_threshold;
1623 int current_signal;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001624 int avg_signal;
Dmitry Shmidtf73259c2015-03-17 11:00:54 -07001625 int avg_beacon_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001626 int current_noise;
1627 int current_txrate;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001628 enum chan_width chanwidth;
1629 int center_frq1;
1630 int center_frq2;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001631};
1632
1633/**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001634 * struct beacon_data - Beacon data
1635 * @head: Head portion of Beacon frame (before TIM IE)
1636 * @tail: Tail portion of Beacon frame (after TIM IE)
1637 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1638 * @proberesp_ies: Extra information element(s) to add into Probe Response
1639 * frames or %NULL
1640 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1641 * Response frames or %NULL
1642 * @probe_resp: Probe Response frame template
1643 * @head_len: Length of @head
1644 * @tail_len: Length of @tail
1645 * @beacon_ies_len: Length of beacon_ies in octets
1646 * @proberesp_ies_len: Length of proberesp_ies in octets
1647 * @proberesp_ies_len: Length of proberesp_ies in octets
1648 * @probe_resp_len: Length of probe response template (@probe_resp)
1649 */
1650struct beacon_data {
1651 u8 *head, *tail;
1652 u8 *beacon_ies;
1653 u8 *proberesp_ies;
1654 u8 *assocresp_ies;
1655 u8 *probe_resp;
1656
1657 size_t head_len, tail_len;
1658 size_t beacon_ies_len;
1659 size_t proberesp_ies_len;
1660 size_t assocresp_ies_len;
1661 size_t probe_resp_len;
1662};
1663
1664/**
1665 * struct csa_settings - Settings for channel switch command
1666 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1667 * @block_tx: 1 - block transmission for CSA period
1668 * @freq_params: Next channel frequency parameter
1669 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1670 * @beacon_after: Next beacon/probe resp/asooc resp info
1671 * @counter_offset_beacon: Offset to the count field in beacon's tail
1672 * @counter_offset_presp: Offset to the count field in probe resp.
1673 */
1674struct csa_settings {
1675 u8 cs_count;
1676 u8 block_tx;
1677
1678 struct hostapd_freq_params freq_params;
1679 struct beacon_data beacon_csa;
1680 struct beacon_data beacon_after;
1681
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001682 u16 counter_offset_beacon[2];
1683 u16 counter_offset_presp[2];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001684};
1685
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07001686/* TDLS peer capabilities for send_tdls_mgmt() */
1687enum tdls_peer_capability {
1688 TDLS_PEER_HT = BIT(0),
1689 TDLS_PEER_VHT = BIT(1),
1690 TDLS_PEER_WMM = BIT(2),
1691};
1692
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001693/* valid info in the wmm_params struct */
1694enum wmm_params_valid_info {
1695 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1696};
1697
1698/**
1699 * struct wmm_params - WMM parameterss configured for this association
1700 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1701 * of the struct contain valid information.
1702 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1703 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1704 */
1705struct wmm_params {
1706 u8 info_bitmap;
1707 u8 uapsd_queues;
1708};
1709
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001710#ifdef CONFIG_MACSEC
1711struct macsec_init_params {
1712 Boolean always_include_sci;
1713 Boolean use_es;
1714 Boolean use_scb;
1715};
1716#endif /* CONFIG_MACSEC */
1717
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001718enum drv_br_port_attr {
1719 DRV_BR_PORT_ATTR_PROXYARP,
1720 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1721};
1722
1723enum drv_br_net_param {
1724 DRV_BR_NET_PARAM_GARP_ACCEPT,
Dmitry Shmidt83474442015-04-15 13:47:09 -07001725 DRV_BR_MULTICAST_SNOOPING,
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001726};
1727
1728struct drv_acs_params {
1729 /* Selected mode (HOSTAPD_MODE_*) */
1730 enum hostapd_hw_mode hw_mode;
1731
1732 /* Indicates whether HT is enabled */
1733 int ht_enabled;
1734
1735 /* Indicates whether HT40 is enabled */
1736 int ht40_enabled;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07001737
1738 /* Indicates whether VHT is enabled */
1739 int vht_enabled;
1740
1741 /* Configured ACS channel width */
1742 u16 ch_width;
1743
1744 /* ACS channel list info */
1745 unsigned int ch_list_len;
1746 const u8 *ch_list;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08001747 const int *freq_list;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001748};
1749
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001750
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001751/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001752 * struct wpa_driver_ops - Driver interface API definition
1753 *
1754 * This structure defines the API that each driver interface needs to implement
1755 * for core wpa_supplicant code. All driver specific functionality is captured
1756 * in this wrapper.
1757 */
1758struct wpa_driver_ops {
1759 /** Name of the driver interface */
1760 const char *name;
1761 /** One line description of the driver interface */
1762 const char *desc;
1763
1764 /**
1765 * get_bssid - Get the current BSSID
1766 * @priv: private driver interface data
1767 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1768 *
1769 * Returns: 0 on success, -1 on failure
1770 *
1771 * Query kernel driver for the current BSSID and copy it to bssid.
1772 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1773 * associated.
1774 */
1775 int (*get_bssid)(void *priv, u8 *bssid);
1776
1777 /**
1778 * get_ssid - Get the current SSID
1779 * @priv: private driver interface data
1780 * @ssid: buffer for SSID (at least 32 bytes)
1781 *
1782 * Returns: Length of the SSID on success, -1 on failure
1783 *
1784 * Query kernel driver for the current SSID and copy it to ssid.
1785 * Returning zero is recommended if the STA is not associated.
1786 *
1787 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1788 * can, at least in theory, contain control characters (including nul)
1789 * and as such, should be processed as binary data, not a printable
1790 * string.
1791 */
1792 int (*get_ssid)(void *priv, u8 *ssid);
1793
1794 /**
1795 * set_key - Configure encryption key
1796 * @ifname: Interface name (for multi-SSID/VLAN support)
1797 * @priv: private driver interface data
1798 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001799 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001800 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1801 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1802 * %WPA_ALG_BIP_CMAC_256);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001803 * %WPA_ALG_NONE clears the key.
1804 * @addr: Address of the peer STA (BSSID of the current AP when setting
1805 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1806 * broadcast keys, %NULL for default keys that are used both for
1807 * broadcast and unicast; when clearing keys, %NULL is used to
1808 * indicate that both the broadcast-only and default key of the
1809 * specified key index is to be cleared
1810 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1811 * IGTK
1812 * @set_tx: configure this key as the default Tx key (only used when
1813 * driver does not support separate unicast/individual key
1814 * @seq: sequence number/packet number, seq_len octets, the next
1815 * packet number to be used for in replay protection; configured
1816 * for Rx keys (in most cases, this is only used with broadcast
1817 * keys and set to zero for unicast keys); %NULL if not set
1818 * @seq_len: length of the seq, depends on the algorithm:
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001819 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001820 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1821 * 8-byte Rx Mic Key
1822 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001823 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001824 *
1825 * Returns: 0 on success, -1 on failure
1826 *
1827 * Configure the given key for the kernel driver. If the driver
1828 * supports separate individual keys (4 default keys + 1 individual),
1829 * addr can be used to determine whether the key is default or
1830 * individual. If only 4 keys are supported, the default key with key
1831 * index 0 is used as the individual key. STA must be configured to use
1832 * it as the default Tx key (set_tx is set) and accept Rx for all the
1833 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1834 * broadcast keys, so key index 0 is available for this kind of
1835 * configuration.
1836 *
1837 * Please note that TKIP keys include separate TX and RX MIC keys and
1838 * some drivers may expect them in different order than wpa_supplicant
1839 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1840 * will trigger Michael MIC errors. This can be fixed by changing the
1841 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1842 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1843 * example on how this can be done.
1844 */
1845 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1846 const u8 *addr, int key_idx, int set_tx,
1847 const u8 *seq, size_t seq_len,
1848 const u8 *key, size_t key_len);
1849
1850 /**
1851 * init - Initialize driver interface
1852 * @ctx: context to be used when calling wpa_supplicant functions,
1853 * e.g., wpa_supplicant_event()
1854 * @ifname: interface name, e.g., wlan0
1855 *
1856 * Returns: Pointer to private data, %NULL on failure
1857 *
1858 * Initialize driver interface, including event processing for kernel
1859 * driver events (e.g., associated, scan results, Michael MIC failure).
1860 * This function can allocate a private configuration data area for
1861 * @ctx, file descriptor, interface name, etc. information that may be
1862 * needed in future driver operations. If this is not used, non-NULL
1863 * value will need to be returned because %NULL is used to indicate
1864 * failure. The returned value will be used as 'void *priv' data for
1865 * all other driver_ops functions.
1866 *
1867 * The main event loop (eloop.c) of wpa_supplicant can be used to
1868 * register callback for read sockets (eloop_register_read_sock()).
1869 *
1870 * See below for more information about events and
1871 * wpa_supplicant_event() function.
1872 */
1873 void * (*init)(void *ctx, const char *ifname);
1874
1875 /**
1876 * deinit - Deinitialize driver interface
1877 * @priv: private driver interface data from init()
1878 *
1879 * Shut down driver interface and processing of driver events. Free
1880 * private data buffer if one was allocated in init() handler.
1881 */
1882 void (*deinit)(void *priv);
1883
1884 /**
1885 * set_param - Set driver configuration parameters
1886 * @priv: private driver interface data from init()
1887 * @param: driver specific configuration parameters
1888 *
1889 * Returns: 0 on success, -1 on failure
1890 *
1891 * Optional handler for notifying driver interface about configuration
1892 * parameters (driver_param).
1893 */
1894 int (*set_param)(void *priv, const char *param);
1895
1896 /**
1897 * set_countermeasures - Enable/disable TKIP countermeasures
1898 * @priv: private driver interface data
1899 * @enabled: 1 = countermeasures enabled, 0 = disabled
1900 *
1901 * Returns: 0 on success, -1 on failure
1902 *
1903 * Configure TKIP countermeasures. When these are enabled, the driver
1904 * should drop all received and queued frames that are using TKIP.
1905 */
1906 int (*set_countermeasures)(void *priv, int enabled);
1907
1908 /**
1909 * deauthenticate - Request driver to deauthenticate
1910 * @priv: private driver interface data
1911 * @addr: peer address (BSSID of the AP)
1912 * @reason_code: 16-bit reason code to be sent in the deauthentication
1913 * frame
1914 *
1915 * Returns: 0 on success, -1 on failure
1916 */
1917 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1918
1919 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001920 * associate - Request driver to associate
1921 * @priv: private driver interface data
1922 * @params: association parameters
1923 *
1924 * Returns: 0 on success, -1 on failure
1925 */
1926 int (*associate)(void *priv,
1927 struct wpa_driver_associate_params *params);
1928
1929 /**
1930 * add_pmkid - Add PMKSA cache entry to the driver
1931 * @priv: private driver interface data
1932 * @bssid: BSSID for the PMKSA cache entry
1933 * @pmkid: PMKID for the PMKSA cache entry
1934 *
1935 * Returns: 0 on success, -1 on failure
1936 *
1937 * This function is called when a new PMK is received, as a result of
1938 * either normal authentication or RSN pre-authentication.
1939 *
1940 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1941 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1942 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1943 * driver_ops function does not need to be implemented. Likewise, if
1944 * the driver does not support WPA, this function is not needed.
1945 */
1946 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1947
1948 /**
1949 * remove_pmkid - Remove PMKSA cache entry to the driver
1950 * @priv: private driver interface data
1951 * @bssid: BSSID for the PMKSA cache entry
1952 * @pmkid: PMKID for the PMKSA cache entry
1953 *
1954 * Returns: 0 on success, -1 on failure
1955 *
1956 * This function is called when the supplicant drops a PMKSA cache
1957 * entry for any reason.
1958 *
1959 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1960 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1961 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1962 * from wpa_supplicant, this driver_ops function does not need to be
1963 * implemented. Likewise, if the driver does not support WPA, this
1964 * function is not needed.
1965 */
1966 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1967
1968 /**
1969 * flush_pmkid - Flush PMKSA cache
1970 * @priv: private driver interface data
1971 *
1972 * Returns: 0 on success, -1 on failure
1973 *
1974 * This function is called when the supplicant drops all PMKSA cache
1975 * entries for any reason.
1976 *
1977 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1978 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1979 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1980 * from wpa_supplicant, this driver_ops function does not need to be
1981 * implemented. Likewise, if the driver does not support WPA, this
1982 * function is not needed.
1983 */
1984 int (*flush_pmkid)(void *priv);
1985
1986 /**
1987 * get_capa - Get driver capabilities
1988 * @priv: private driver interface data
1989 *
1990 * Returns: 0 on success, -1 on failure
1991 *
1992 * Get driver/firmware/hardware capabilities.
1993 */
1994 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1995
1996 /**
1997 * poll - Poll driver for association information
1998 * @priv: private driver interface data
1999 *
2000 * This is an option callback that can be used when the driver does not
2001 * provide event mechanism for association events. This is called when
2002 * receiving WPA EAPOL-Key messages that require association
2003 * information. The driver interface is supposed to generate associnfo
2004 * event before returning from this callback function. In addition, the
2005 * driver interface should generate an association event after having
2006 * sent out associnfo.
2007 */
2008 void (*poll)(void *priv);
2009
2010 /**
Dmitry Shmidte4663042016-04-04 10:07:49 -07002011 * get_ifindex - Get interface index
2012 * @priv: private driver interface data
2013 *
2014 * Returns: Interface index
2015 */
2016 unsigned int (*get_ifindex)(void *priv);
2017
2018 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002019 * get_ifname - Get interface name
2020 * @priv: private driver interface data
2021 *
2022 * Returns: Pointer to the interface name. This can differ from the
2023 * interface name used in init() call. Init() is called first.
2024 *
2025 * This optional function can be used to allow the driver interface to
2026 * replace the interface name with something else, e.g., based on an
2027 * interface mapping from a more descriptive name.
2028 */
2029 const char * (*get_ifname)(void *priv);
2030
2031 /**
2032 * get_mac_addr - Get own MAC address
2033 * @priv: private driver interface data
2034 *
2035 * Returns: Pointer to own MAC address or %NULL on failure
2036 *
2037 * This optional function can be used to get the own MAC address of the
2038 * device from the driver interface code. This is only needed if the
2039 * l2_packet implementation for the OS does not provide easy access to
2040 * a MAC address. */
2041 const u8 * (*get_mac_addr)(void *priv);
2042
2043 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002044 * set_operstate - Sets device operating state to DORMANT or UP
2045 * @priv: private driver interface data
2046 * @state: 0 = dormant, 1 = up
2047 * Returns: 0 on success, -1 on failure
2048 *
2049 * This is an optional function that can be used on operating systems
2050 * that support a concept of controlling network device state from user
2051 * space applications. This function, if set, gets called with
2052 * state = 1 when authentication has been completed and with state = 0
2053 * when connection is lost.
2054 */
2055 int (*set_operstate)(void *priv, int state);
2056
2057 /**
2058 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2059 * @priv: Private driver interface data
2060 * @addr: Address of the station for which to set protection (may be
2061 * %NULL for group keys)
2062 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2063 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2064 * Returns: 0 on success, -1 on failure
2065 *
2066 * This is an optional function that can be used to set the driver to
2067 * require protection for Tx and/or Rx frames. This uses the layer
2068 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2069 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2070 * set protection operation; instead, they set protection implicitly
2071 * based on configured keys.
2072 */
2073 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2074 int key_type);
2075
2076 /**
2077 * get_hw_feature_data - Get hardware support data (channels and rates)
2078 * @priv: Private driver interface data
2079 * @num_modes: Variable for returning the number of returned modes
2080 * flags: Variable for returning hardware feature flags
2081 * Returns: Pointer to allocated hardware data on success or %NULL on
2082 * failure. Caller is responsible for freeing this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002083 */
2084 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2085 u16 *num_modes,
2086 u16 *flags);
2087
2088 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002089 * send_mlme - Send management frame from MLME
2090 * @priv: Private driver interface data
2091 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2092 * @data_len: Size of the management frame
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002093 * @noack: Do not wait for this frame to be acked (disable retries)
Dmitry Shmidta3dc3092015-06-23 11:21:28 -07002094 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2095 * driver decide
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002096 * @csa_offs: Array of CSA offsets or %NULL
2097 * @csa_offs_len: Number of elements in csa_offs
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002098 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002099 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002100 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002101 int noack, unsigned int freq, const u16 *csa_offs,
2102 size_t csa_offs_len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002103
2104 /**
2105 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2106 * @priv: Private driver interface data
2107 * @md: Mobility domain (2 octets) (also included inside ies)
2108 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2109 * @ies_len: Length of FT IEs in bytes
2110 * Returns: 0 on success, -1 on failure
2111 *
2112 * The supplicant uses this callback to let the driver know that keying
2113 * material for FT is available and that the driver can use the
2114 * provided IEs in the next message in FT authentication sequence.
2115 *
2116 * This function is only needed for driver that support IEEE 802.11r
2117 * (Fast BSS Transition).
2118 */
2119 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2120 size_t ies_len);
2121
2122 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002123 * get_scan_results2 - Fetch the latest scan results
2124 * @priv: private driver interface data
2125 *
2126 * Returns: Allocated buffer of scan results (caller is responsible for
2127 * freeing the data structure) on success, NULL on failure
2128 */
2129 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2130
2131 /**
2132 * set_country - Set country
2133 * @priv: Private driver interface data
2134 * @alpha2: country to which to switch to
2135 * Returns: 0 on success, -1 on failure
2136 *
2137 * This function is for drivers which support some form
2138 * of setting a regulatory domain.
2139 */
2140 int (*set_country)(void *priv, const char *alpha2);
2141
2142 /**
Dmitry Shmidtcce06662013-11-04 18:44:24 -08002143 * get_country - Get country
2144 * @priv: Private driver interface data
2145 * @alpha2: Buffer for returning country code (at least 3 octets)
2146 * Returns: 0 on success, -1 on failure
2147 */
2148 int (*get_country)(void *priv, char *alpha2);
2149
2150 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002151 * global_init - Global driver initialization
Dmitry Shmidte4663042016-04-04 10:07:49 -07002152 * @ctx: wpa_global pointer
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002153 * Returns: Pointer to private data (global), %NULL on failure
2154 *
2155 * This optional function is called to initialize the driver wrapper
2156 * for global data, i.e., data that applies to all interfaces. If this
2157 * function is implemented, global_deinit() will also need to be
2158 * implemented to free the private data. The driver will also likely
2159 * use init2() function instead of init() to get the pointer to global
2160 * data available to per-interface initializer.
2161 */
Dmitry Shmidte4663042016-04-04 10:07:49 -07002162 void * (*global_init)(void *ctx);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002163
2164 /**
2165 * global_deinit - Global driver deinitialization
2166 * @priv: private driver global data from global_init()
2167 *
2168 * Terminate any global driver related functionality and free the
2169 * global data structure.
2170 */
2171 void (*global_deinit)(void *priv);
2172
2173 /**
2174 * init2 - Initialize driver interface (with global data)
2175 * @ctx: context to be used when calling wpa_supplicant functions,
2176 * e.g., wpa_supplicant_event()
2177 * @ifname: interface name, e.g., wlan0
2178 * @global_priv: private driver global data from global_init()
2179 * Returns: Pointer to private data, %NULL on failure
2180 *
2181 * This function can be used instead of init() if the driver wrapper
2182 * uses global data.
2183 */
2184 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
2185
2186 /**
2187 * get_interfaces - Get information about available interfaces
2188 * @global_priv: private driver global data from global_init()
2189 * Returns: Allocated buffer of interface information (caller is
2190 * responsible for freeing the data structure) on success, NULL on
2191 * failure
2192 */
2193 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
2194
2195 /**
2196 * scan2 - Request the driver to initiate scan
2197 * @priv: private driver interface data
2198 * @params: Scan parameters
2199 *
2200 * Returns: 0 on success, -1 on failure
2201 *
2202 * Once the scan results are ready, the driver should report scan
2203 * results event for wpa_supplicant which will eventually request the
2204 * results with wpa_driver_get_scan_results2().
2205 */
2206 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2207
2208 /**
2209 * authenticate - Request driver to authenticate
2210 * @priv: private driver interface data
2211 * @params: authentication parameters
2212 * Returns: 0 on success, -1 on failure
2213 *
2214 * This is an optional function that can be used with drivers that
2215 * support separate authentication and association steps, i.e., when
2216 * wpa_supplicant can act as the SME. If not implemented, associate()
2217 * function is expected to take care of IEEE 802.11 authentication,
2218 * too.
2219 */
2220 int (*authenticate)(void *priv,
2221 struct wpa_driver_auth_params *params);
2222
2223 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002224 * set_ap - Set Beacon and Probe Response information for AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002225 * @priv: Private driver interface data
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002226 * @params: Parameters to use in AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002227 *
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002228 * This function is used to configure Beacon template and/or extra IEs
2229 * to add for Beacon and Probe Response frames for the driver in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002230 * AP mode. The driver is responsible for building the full Beacon
2231 * frame by concatenating the head part with TIM IE generated by the
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002232 * driver/firmware and finishing with the tail part. Depending on the
2233 * driver architectue, this can be done either by using the full
2234 * template or the set of additional IEs (e.g., WPS and P2P IE).
2235 * Similarly, Probe Response processing depends on the driver design.
2236 * If the driver (or firmware) takes care of replying to Probe Request
2237 * frames, the extra IEs provided here needs to be added to the Probe
2238 * Response frames.
2239 *
2240 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002241 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002242 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002243
2244 /**
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002245 * set_acl - Set ACL in AP mode
2246 * @priv: Private driver interface data
2247 * @params: Parameters to configure ACL
2248 * Returns: 0 on success, -1 on failure
2249 *
2250 * This is used only for the drivers which support MAC address ACL.
2251 */
2252 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2253
2254 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002255 * hapd_init - Initialize driver interface (hostapd only)
2256 * @hapd: Pointer to hostapd context
2257 * @params: Configuration for the driver wrapper
2258 * Returns: Pointer to private data, %NULL on failure
2259 *
2260 * This function is used instead of init() or init2() when the driver
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002261 * wrapper is used with hostapd.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002262 */
2263 void * (*hapd_init)(struct hostapd_data *hapd,
2264 struct wpa_init_params *params);
2265
2266 /**
2267 * hapd_deinit - Deinitialize driver interface (hostapd only)
2268 * @priv: Private driver interface data from hapd_init()
2269 */
2270 void (*hapd_deinit)(void *priv);
2271
2272 /**
2273 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2274 * @priv: Private driver interface data
2275 * @params: BSS parameters
2276 * Returns: 0 on success, -1 on failure
2277 *
2278 * This is an optional function to configure the kernel driver to
2279 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2280 * can be left undefined (set to %NULL) if IEEE 802.1X support is
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002281 * always enabled and the driver uses set_ap() to set WPA/RSN IE
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002282 * for Beacon frames.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002283 *
2284 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002285 */
2286 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2287
2288 /**
2289 * set_privacy - Enable/disable privacy (AP only)
2290 * @priv: Private driver interface data
2291 * @enabled: 1 = privacy enabled, 0 = disabled
2292 * Returns: 0 on success, -1 on failure
2293 *
2294 * This is an optional function to configure privacy field in the
2295 * kernel driver for Beacon frames. This can be left undefined (set to
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002296 * %NULL) if the driver uses the Beacon template from set_ap().
2297 *
2298 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002299 */
2300 int (*set_privacy)(void *priv, int enabled);
2301
2302 /**
2303 * get_seqnum - Fetch the current TSC/packet number (AP only)
2304 * @ifname: The interface name (main or virtual)
2305 * @priv: Private driver interface data
2306 * @addr: MAC address of the station or %NULL for group keys
2307 * @idx: Key index
2308 * @seq: Buffer for returning the latest used TSC/packet number
2309 * Returns: 0 on success, -1 on failure
2310 *
2311 * This function is used to fetch the last used TSC/packet number for
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002312 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2313 * keys, so there is no strict requirement on implementing support for
2314 * unicast keys (i.e., addr != %NULL).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002315 */
2316 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2317 int idx, u8 *seq);
2318
2319 /**
2320 * flush - Flush all association stations (AP only)
2321 * @priv: Private driver interface data
2322 * Returns: 0 on success, -1 on failure
2323 *
2324 * This function requests the driver to disassociate all associated
2325 * stations. This function does not need to be implemented if the
2326 * driver does not process association frames internally.
2327 */
2328 int (*flush)(void *priv);
2329
2330 /**
2331 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2332 * @priv: Private driver interface data
2333 * @elem: Information elements
2334 * @elem_len: Length of the elem buffer in octets
2335 * Returns: 0 on success, -1 on failure
2336 *
2337 * This is an optional function to add information elements in the
2338 * kernel driver for Beacon and Probe Response frames. This can be left
2339 * undefined (set to %NULL) if the driver uses the Beacon template from
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002340 * set_ap().
2341 *
2342 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002343 */
2344 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2345
2346 /**
Jouni Malinen1e6c57f2012-09-05 17:07:03 +03002347 * read_sta_data - Fetch station data
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002348 * @priv: Private driver interface data
2349 * @data: Buffer for returning station information
2350 * @addr: MAC address of the station
2351 * Returns: 0 on success, -1 on failure
2352 */
2353 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2354 const u8 *addr);
2355
2356 /**
2357 * hapd_send_eapol - Send an EAPOL packet (AP only)
2358 * @priv: private driver interface data
2359 * @addr: Destination MAC address
2360 * @data: EAPOL packet starting with IEEE 802.1X header
2361 * @data_len: Length of the EAPOL packet in octets
2362 * @encrypt: Whether the frame should be encrypted
2363 * @own_addr: Source MAC address
2364 * @flags: WPA_STA_* flags for the destination station
2365 *
2366 * Returns: 0 on success, -1 on failure
2367 */
2368 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2369 size_t data_len, int encrypt,
2370 const u8 *own_addr, u32 flags);
2371
2372 /**
2373 * sta_deauth - Deauthenticate a station (AP only)
2374 * @priv: Private driver interface data
2375 * @own_addr: Source address and BSSID for the Deauthentication frame
2376 * @addr: MAC address of the station to deauthenticate
2377 * @reason: Reason code for the Deauthentiation frame
2378 * Returns: 0 on success, -1 on failure
2379 *
2380 * This function requests a specific station to be deauthenticated and
2381 * a Deauthentication frame to be sent to it.
2382 */
2383 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2384 int reason);
2385
2386 /**
2387 * sta_disassoc - Disassociate a station (AP only)
2388 * @priv: Private driver interface data
2389 * @own_addr: Source address and BSSID for the Disassociation frame
2390 * @addr: MAC address of the station to disassociate
2391 * @reason: Reason code for the Disassociation frame
2392 * Returns: 0 on success, -1 on failure
2393 *
2394 * This function requests a specific station to be disassociated and
2395 * a Disassociation frame to be sent to it.
2396 */
2397 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2398 int reason);
2399
2400 /**
2401 * sta_remove - Remove a station entry (AP only)
2402 * @priv: Private driver interface data
2403 * @addr: MAC address of the station to be removed
2404 * Returns: 0 on success, -1 on failure
2405 */
2406 int (*sta_remove)(void *priv, const u8 *addr);
2407
2408 /**
2409 * hapd_get_ssid - Get the current SSID (AP only)
2410 * @priv: Private driver interface data
2411 * @buf: Buffer for returning the SSID
2412 * @len: Maximum length of the buffer
2413 * Returns: Length of the SSID on success, -1 on failure
2414 *
2415 * This function need not be implemented if the driver uses Beacon
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002416 * template from set_ap() and does not reply to Probe Request frames.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002417 */
2418 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2419
2420 /**
2421 * hapd_set_ssid - Set SSID (AP only)
2422 * @priv: Private driver interface data
2423 * @buf: SSID
2424 * @len: Length of the SSID in octets
2425 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002426 *
2427 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002428 */
2429 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2430
2431 /**
2432 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2433 * @priv: Private driver interface data
2434 * @enabled: 1 = countermeasures enabled, 0 = disabled
2435 * Returns: 0 on success, -1 on failure
2436 *
2437 * This need not be implemented if the driver does not take care of
2438 * association processing.
2439 */
2440 int (*hapd_set_countermeasures)(void *priv, int enabled);
2441
2442 /**
2443 * sta_add - Add a station entry
2444 * @priv: Private driver interface data
2445 * @params: Station parameters
2446 * Returns: 0 on success, -1 on failure
2447 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002448 * This function is used to add or set (params->set 1) a station
2449 * entry in the driver. Adding STA entries is used only if the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002450 * does not take care of association processing.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002451 *
Dmitry Shmidt57c2d392016-02-23 13:40:19 -08002452 * With drivers that don't support full AP client state, this function
2453 * is used to add a station entry to the driver once the station has
2454 * completed association.
2455 *
2456 * With TDLS, this function is used to add or set (params->set 1)
2457 * TDLS peer entries (even with drivers that do not support full AP
2458 * client state).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002459 */
2460 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2461
2462 /**
2463 * get_inact_sec - Get station inactivity duration (AP only)
2464 * @priv: Private driver interface data
2465 * @addr: Station address
2466 * Returns: Number of seconds station has been inactive, -1 on failure
2467 */
2468 int (*get_inact_sec)(void *priv, const u8 *addr);
2469
2470 /**
2471 * sta_clear_stats - Clear station statistics (AP only)
2472 * @priv: Private driver interface data
2473 * @addr: Station address
2474 * Returns: 0 on success, -1 on failure
2475 */
2476 int (*sta_clear_stats)(void *priv, const u8 *addr);
2477
2478 /**
2479 * set_freq - Set channel/frequency (AP only)
2480 * @priv: Private driver interface data
2481 * @freq: Channel parameters
2482 * Returns: 0 on success, -1 on failure
2483 */
2484 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2485
2486 /**
2487 * set_rts - Set RTS threshold
2488 * @priv: Private driver interface data
2489 * @rts: RTS threshold in octets
2490 * Returns: 0 on success, -1 on failure
2491 */
2492 int (*set_rts)(void *priv, int rts);
2493
2494 /**
2495 * set_frag - Set fragmentation threshold
2496 * @priv: Private driver interface data
2497 * @frag: Fragmentation threshold in octets
2498 * Returns: 0 on success, -1 on failure
2499 */
2500 int (*set_frag)(void *priv, int frag);
2501
2502 /**
2503 * sta_set_flags - Set station flags (AP only)
2504 * @priv: Private driver interface data
2505 * @addr: Station address
2506 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2507 * @flags_or: Bitmap of WPA_STA_* flags to add
2508 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2509 * Returns: 0 on success, -1 on failure
2510 */
2511 int (*sta_set_flags)(void *priv, const u8 *addr,
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08002512 unsigned int total_flags, unsigned int flags_or,
2513 unsigned int flags_and);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002514
2515 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002516 * set_tx_queue_params - Set TX queue parameters
2517 * @priv: Private driver interface data
2518 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2519 * @aifs: AIFS
2520 * @cw_min: cwMin
2521 * @cw_max: cwMax
2522 * @burst_time: Maximum length for bursting in 0.1 msec units
2523 */
2524 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2525 int cw_max, int burst_time);
2526
2527 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002528 * if_add - Add a virtual interface
2529 * @priv: Private driver interface data
2530 * @type: Interface type
2531 * @ifname: Interface name for the new virtual interface
2532 * @addr: Local address to use for the interface or %NULL to use the
2533 * parent interface address
2534 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2535 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2536 * not allowed (applies only to %WPA_IF_AP_BSS type)
2537 * @force_ifname: Buffer for returning an interface name that the
2538 * driver ended up using if it differs from the requested ifname
2539 * @if_addr: Buffer for returning the allocated interface address
2540 * (this may differ from the requested addr if the driver cannot
2541 * change interface address)
2542 * @bridge: Bridge interface to use or %NULL if no bridge configured
Dmitry Shmidtcce06662013-11-04 18:44:24 -08002543 * @use_existing: Whether to allow existing interface to be used
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08002544 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002545 * Returns: 0 on success, -1 on failure
2546 */
2547 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2548 const char *ifname, const u8 *addr, void *bss_ctx,
2549 void **drv_priv, char *force_ifname, u8 *if_addr,
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08002550 const char *bridge, int use_existing, int setup_ap);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002551
2552 /**
2553 * if_remove - Remove a virtual interface
2554 * @priv: Private driver interface data
2555 * @type: Interface type
2556 * @ifname: Interface name of the virtual interface to be removed
2557 * Returns: 0 on success, -1 on failure
2558 */
2559 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2560 const char *ifname);
2561
2562 /**
2563 * set_sta_vlan - Bind a station into a specific interface (AP only)
2564 * @priv: Private driver interface data
2565 * @ifname: Interface (main or virtual BSS or VLAN)
2566 * @addr: MAC address of the associated station
2567 * @vlan_id: VLAN ID
2568 * Returns: 0 on success, -1 on failure
2569 *
2570 * This function is used to bind a station to a specific virtual
2571 * interface. It is only used if when virtual interfaces are supported,
2572 * e.g., to assign stations to different VLAN interfaces based on
2573 * information from a RADIUS server. This allows separate broadcast
2574 * domains to be used with a single BSS.
2575 */
2576 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2577 int vlan_id);
2578
2579 /**
2580 * commit - Optional commit changes handler (AP only)
2581 * @priv: driver private data
2582 * Returns: 0 on success, -1 on failure
2583 *
2584 * This optional handler function can be registered if the driver
2585 * interface implementation needs to commit changes (e.g., by setting
2586 * network interface up) at the end of initial configuration. If set,
2587 * this handler will be called after initial setup has been completed.
2588 */
2589 int (*commit)(void *priv);
2590
2591 /**
2592 * send_ether - Send an ethernet packet (AP only)
2593 * @priv: private driver interface data
2594 * @dst: Destination MAC address
2595 * @src: Source MAC address
2596 * @proto: Ethertype
2597 * @data: EAPOL packet starting with IEEE 802.1X header
2598 * @data_len: Length of the EAPOL packet in octets
2599 * Returns: 0 on success, -1 on failure
2600 */
2601 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2602 const u8 *data, size_t data_len);
2603
2604 /**
2605 * set_radius_acl_auth - Notification of RADIUS ACL change
2606 * @priv: Private driver interface data
2607 * @mac: MAC address of the station
2608 * @accepted: Whether the station was accepted
2609 * @session_timeout: Session timeout for the station
2610 * Returns: 0 on success, -1 on failure
2611 */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07002612 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002613 u32 session_timeout);
2614
2615 /**
2616 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2617 * @priv: Private driver interface data
2618 * @mac: MAC address of the station
2619 * Returns: 0 on success, -1 on failure
2620 */
2621 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2622
2623 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002624 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2625 * @priv: Private driver interface data
2626 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2627 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2628 * extra IE(s)
2629 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2630 * to remove extra IE(s)
2631 * Returns: 0 on success, -1 on failure
2632 *
2633 * This is an optional function to add WPS IE in the kernel driver for
2634 * Beacon and Probe Response frames. This can be left undefined (set
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002635 * to %NULL) if the driver uses the Beacon template from set_ap()
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002636 * and does not process Probe Request frames. If the driver takes care
2637 * of (Re)Association frame processing, the assocresp buffer includes
2638 * WPS IE(s) that need to be added to (Re)Association Response frames
2639 * whenever a (Re)Association Request frame indicated use of WPS.
2640 *
2641 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2642 * frames when operating as a GO. The driver is responsible for adding
2643 * timing related attributes (e.g., NoA) in addition to the IEs
2644 * included here by appending them after these buffers. This call is
2645 * also used to provide Probe Response IEs for P2P Listen state
2646 * operations for drivers that generate the Probe Response frames
2647 * internally.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002648 *
2649 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002650 */
2651 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2652 const struct wpabuf *proberesp,
2653 const struct wpabuf *assocresp);
2654
2655 /**
2656 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2657 * @priv: Private driver interface data
2658 * @authorized: Whether the port is authorized
2659 * Returns: 0 on success, -1 on failure
2660 */
2661 int (*set_supp_port)(void *priv, int authorized);
2662
2663 /**
2664 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2665 * @priv: Private driver interface data
2666 * @addr: MAC address of the associated station
2667 * @aid: Association ID
2668 * @val: 1 = bind to 4-address WDS; 0 = unbind
2669 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2670 * to indicate that bridge is not to be used
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07002671 * @ifname_wds: Buffer to return the interface name for the new WDS
2672 * station or %NULL to indicate name is not returned.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002673 * Returns: 0 on success, -1 on failure
2674 */
2675 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07002676 const char *bridge_ifname, char *ifname_wds);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002677
2678 /**
2679 * send_action - Transmit an Action frame
2680 * @priv: Private driver interface data
2681 * @freq: Frequency (in MHz) of the channel
2682 * @wait: Time to wait off-channel for a response (in ms), or zero
2683 * @dst: Destination MAC address (Address 1)
2684 * @src: Source MAC address (Address 2)
2685 * @bssid: BSSID (Address 3)
2686 * @data: Frame body
2687 * @data_len: data length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002688 @ @no_cck: Whether CCK rates must not be used to transmit this frame
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002689 * Returns: 0 on success, -1 on failure
2690 *
2691 * This command can be used to request the driver to transmit an action
2692 * frame to the specified destination.
2693 *
2694 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2695 * be transmitted on the given channel and the device will wait for a
2696 * response on that channel for the given wait time.
2697 *
2698 * If the flag is not set, the wait time will be ignored. In this case,
2699 * if a remain-on-channel duration is in progress, the frame must be
2700 * transmitted on that channel; alternatively the frame may be sent on
2701 * the current operational channel (if in associated state in station
2702 * mode or while operating as an AP.)
2703 */
2704 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2705 const u8 *dst, const u8 *src, const u8 *bssid,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002706 const u8 *data, size_t data_len, int no_cck);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002707
2708 /**
2709 * send_action_cancel_wait - Cancel action frame TX wait
2710 * @priv: Private driver interface data
2711 *
2712 * This command cancels the wait time associated with sending an action
2713 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2714 * set in the driver flags.
2715 */
2716 void (*send_action_cancel_wait)(void *priv);
2717
2718 /**
2719 * remain_on_channel - Remain awake on a channel
2720 * @priv: Private driver interface data
2721 * @freq: Frequency (in MHz) of the channel
2722 * @duration: Duration in milliseconds
2723 * Returns: 0 on success, -1 on failure
2724 *
2725 * This command is used to request the driver to remain awake on the
2726 * specified channel for the specified duration and report received
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08002727 * Action frames with EVENT_RX_MGMT events. Optionally, received
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002728 * Probe Request frames may also be requested to be reported by calling
2729 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2730 *
2731 * The driver may not be at the requested channel when this function
2732 * returns, i.e., the return code is only indicating whether the
2733 * request was accepted. The caller will need to wait until the
2734 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2735 * completed the channel change. This may take some time due to other
2736 * need for the radio and the caller should be prepared to timing out
2737 * its wait since there are no guarantees on when this request can be
2738 * executed.
2739 */
2740 int (*remain_on_channel)(void *priv, unsigned int freq,
2741 unsigned int duration);
2742
2743 /**
2744 * cancel_remain_on_channel - Cancel remain-on-channel operation
2745 * @priv: Private driver interface data
2746 *
2747 * This command can be used to cancel a remain-on-channel operation
2748 * before its originally requested duration has passed. This could be
2749 * used, e.g., when remain_on_channel() is used to request extra time
2750 * to receive a response to an Action frame and the response is
2751 * received when there is still unneeded time remaining on the
2752 * remain-on-channel operation.
2753 */
2754 int (*cancel_remain_on_channel)(void *priv);
2755
2756 /**
2757 * probe_req_report - Request Probe Request frames to be indicated
2758 * @priv: Private driver interface data
2759 * @report: Whether to report received Probe Request frames
2760 * Returns: 0 on success, -1 on failure (or if not supported)
2761 *
2762 * This command can be used to request the driver to indicate when
2763 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2764 * Since this operation may require extra resources, e.g., due to less
2765 * optimal hardware/firmware RX filtering, many drivers may disable
2766 * Probe Request reporting at least in station mode. This command is
2767 * used to notify the driver when the Probe Request frames need to be
2768 * reported, e.g., during remain-on-channel operations.
2769 */
2770 int (*probe_req_report)(void *priv, int report);
2771
2772 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002773 * deinit_ap - Deinitialize AP mode
2774 * @priv: Private driver interface data
2775 * Returns: 0 on success, -1 on failure (or if not supported)
2776 *
2777 * This optional function can be used to disable AP mode related
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07002778 * configuration. If the interface was not dynamically added,
2779 * change the driver mode to station mode to allow normal station
2780 * operations like scanning to be completed.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002781 */
2782 int (*deinit_ap)(void *priv);
2783
2784 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07002785 * deinit_p2p_cli - Deinitialize P2P client mode
2786 * @priv: Private driver interface data
2787 * Returns: 0 on success, -1 on failure (or if not supported)
2788 *
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07002789 * This optional function can be used to disable P2P client mode. If the
2790 * interface was not dynamically added, change the interface type back
2791 * to station mode.
Dmitry Shmidt04949592012-07-19 12:16:46 -07002792 */
2793 int (*deinit_p2p_cli)(void *priv);
2794
2795 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002796 * suspend - Notification on system suspend/hibernate event
2797 * @priv: Private driver interface data
2798 */
2799 void (*suspend)(void *priv);
2800
2801 /**
2802 * resume - Notification on system resume/thaw event
2803 * @priv: Private driver interface data
2804 */
2805 void (*resume)(void *priv);
2806
2807 /**
2808 * signal_monitor - Set signal monitoring parameters
2809 * @priv: Private driver interface data
2810 * @threshold: Threshold value for signal change events; 0 = disabled
2811 * @hysteresis: Minimum change in signal strength before indicating a
2812 * new event
2813 * Returns: 0 on success, -1 on failure (or if not supported)
2814 *
2815 * This function can be used to configure monitoring of signal strength
2816 * with the current AP. Whenever signal strength drops below the
2817 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2818 * should be generated assuming the signal strength has changed at
2819 * least %hysteresis from the previously indicated signal change event.
2820 */
2821 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2822
2823 /**
2824 * send_frame - Send IEEE 802.11 frame (testing use only)
2825 * @priv: Private driver interface data
2826 * @data: IEEE 802.11 frame with IEEE 802.11 header
2827 * @data_len: Size of the frame
2828 * @encrypt: Whether to encrypt the frame (if keys are set)
2829 * Returns: 0 on success, -1 on failure
2830 *
2831 * This function is only used for debugging purposes and is not
2832 * required to be implemented for normal operations.
2833 */
2834 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2835 int encrypt);
2836
2837 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002838 * get_noa - Get current Notice of Absence attribute payload
2839 * @priv: Private driver interface data
2840 * @buf: Buffer for returning NoA
2841 * @buf_len: Buffer length in octets
2842 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2843 * advertized, or -1 on failure
2844 *
2845 * This function is used to fetch the current Notice of Absence
2846 * attribute value from GO.
2847 */
2848 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2849
2850 /**
2851 * set_noa - Set Notice of Absence parameters for GO (testing)
2852 * @priv: Private driver interface data
2853 * @count: Count
2854 * @start: Start time in ms from next TBTT
2855 * @duration: Duration in ms
2856 * Returns: 0 on success or -1 on failure
2857 *
2858 * This function is used to set Notice of Absence parameters for GO. It
2859 * is used only for testing. To disable NoA, all parameters are set to
2860 * 0.
2861 */
2862 int (*set_noa)(void *priv, u8 count, int start, int duration);
2863
2864 /**
2865 * set_p2p_powersave - Set P2P power save options
2866 * @priv: Private driver interface data
2867 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2868 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2869 * @ctwindow: 0.. = change (msec), -1 = no change
2870 * Returns: 0 on success or -1 on failure
2871 */
2872 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2873 int ctwindow);
2874
2875 /**
2876 * ampdu - Enable/disable aggregation
2877 * @priv: Private driver interface data
2878 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2879 * Returns: 0 on success or -1 on failure
2880 */
2881 int (*ampdu)(void *priv, int ampdu);
2882
2883 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002884 * get_radio_name - Get physical radio name for the device
2885 * @priv: Private driver interface data
2886 * Returns: Radio name or %NULL if not known
2887 *
2888 * The returned data must not be modified by the caller. It is assumed
2889 * that any interface that has the same radio name as another is
2890 * sharing the same physical radio. This information can be used to
2891 * share scan results etc. information between the virtual interfaces
2892 * to speed up various operations.
2893 */
2894 const char * (*get_radio_name)(void *priv);
2895
2896 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002897 * send_tdls_mgmt - for sending TDLS management packets
2898 * @priv: private driver interface data
2899 * @dst: Destination (peer) MAC address
2900 * @action_code: TDLS action code for the mssage
2901 * @dialog_token: Dialog Token to use in the message (if needed)
2902 * @status_code: Status Code or Reason Code to use (if needed)
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002903 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07002904 * @initiator: Is the current end the TDLS link initiator
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002905 * @buf: TDLS IEs to add to the message
2906 * @len: Length of buf in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002907 * Returns: 0 on success, negative (<0) on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002908 *
2909 * This optional function can be used to send packet to driver which is
2910 * responsible for receiving and sending all TDLS packets.
2911 */
2912 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002913 u8 dialog_token, u16 status_code, u32 peer_capab,
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07002914 int initiator, const u8 *buf, size_t len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002915
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002916 /**
2917 * tdls_oper - Ask the driver to perform high-level TDLS operations
2918 * @priv: Private driver interface data
2919 * @oper: TDLS high-level operation. See %enum tdls_oper
2920 * @peer: Destination (peer) MAC address
2921 * Returns: 0 on success, negative (<0) on failure
2922 *
2923 * This optional function can be used to send high-level TDLS commands
2924 * to the driver.
2925 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002926 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2927
2928 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002929 * wnm_oper - Notify driver of the WNM frame reception
2930 * @priv: Private driver interface data
2931 * @oper: WNM operation. See %enum wnm_oper
2932 * @peer: Destination (peer) MAC address
2933 * @buf: Buffer for the driver to fill in (for getting IE)
2934 * @buf_len: Return the len of buf
2935 * Returns: 0 on success, negative (<0) on failure
2936 */
2937 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2938 u8 *buf, u16 *buf_len);
2939
2940 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -07002941 * set_qos_map - Set QoS Map
2942 * @priv: Private driver interface data
2943 * @qos_map_set: QoS Map
2944 * @qos_map_set_len: Length of QoS Map
2945 */
2946 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2947 u8 qos_map_set_len);
2948
2949 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002950 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2951 * @priv: Private driver interface data
2952 * @version: IP version of the IP address, 4 or 6
2953 * @ipaddr: IP address for the neigh entry
2954 * @prefixlen: IP address prefix length
2955 * @addr: Corresponding MAC address
2956 * Returns: 0 on success, negative (<0) on failure
2957 */
2958 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2959 int prefixlen, const u8 *addr);
2960
2961 /**
2962 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2963 * @priv: Private driver interface data
2964 * @version: IP version of the IP address, 4 or 6
2965 * @ipaddr: IP address for the neigh entry
2966 * Returns: 0 on success, negative (<0) on failure
2967 */
2968 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2969
2970 /**
2971 * br_port_set_attr - Set a bridge port attribute
2972 * @attr: Bridge port attribute to set
2973 * @val: Value to be set
2974 * Returns: 0 on success, negative (<0) on failure
2975 */
2976 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2977 unsigned int val);
2978
2979 /**
2980 * br_port_set_attr - Set a bridge network parameter
2981 * @param: Bridge parameter to set
2982 * @val: Value to be set
2983 * Returns: 0 on success, negative (<0) on failure
2984 */
2985 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2986 unsigned int val);
2987
2988 /**
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07002989 * set_wowlan - Set wake-on-wireless triggers
2990 * @priv: Private driver interface data
2991 * @triggers: wowlan triggers
2992 */
2993 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2994
2995 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002996 * signal_poll - Get current connection information
2997 * @priv: Private driver interface data
2998 * @signal_info: Connection info structure
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07002999 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003000 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003001
3002 /**
Jouni Malinen75ecf522011-06-27 15:19:46 -07003003 * set_authmode - Set authentication algorithm(s) for static WEP
3004 * @priv: Private driver interface data
3005 * @authmode: 1=Open System, 2=Shared Key, 3=both
3006 * Returns: 0 on success, -1 on failure
3007 *
3008 * This function can be used to set authentication algorithms for AP
3009 * mode when static WEP is used. If the driver uses user space MLME/SME
3010 * implementation, there is no need to implement this function.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003011 *
3012 * DEPRECATED - use set_ap() instead
Jouni Malinen75ecf522011-06-27 15:19:46 -07003013 */
3014 int (*set_authmode)(void *priv, int authmode);
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003015
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003016#ifdef ANDROID
Jouni Malinen75ecf522011-06-27 15:19:46 -07003017 /**
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003018 * driver_cmd - Execute driver-specific command
3019 * @priv: Private driver interface data
3020 * @cmd: Command to execute
3021 * @buf: Return buffer
3022 * @buf_len: Buffer length
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07003023 * Returns: 0 on success, -1 on failure
3024 */
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08003025 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
3026#endif /* ANDROID */
3027
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003028 /**
Dmitry Shmidta38abf92014-03-06 13:38:44 -08003029 * vendor_cmd - Execute vendor specific command
3030 * @priv: Private driver interface data
3031 * @vendor_id: Vendor id
3032 * @subcmd: Vendor command id
3033 * @data: Vendor command parameters (%NULL if no parameters)
3034 * @data_len: Data length
3035 * @buf: Return buffer (%NULL to ignore reply)
3036 * Returns: 0 on success, negative (<0) on failure
3037 *
3038 * This function handles vendor specific commands that are passed to
3039 * the driver/device. The command is identified by vendor id and
3040 * command id. Parameters can be passed as argument to the command
3041 * in the data buffer. Reply (if any) will be filled in the supplied
3042 * return buffer.
3043 *
3044 * The exact driver behavior is driver interface and vendor specific. As
3045 * an example, this will be converted to a vendor specific cfg80211
3046 * command in case of the nl80211 driver interface.
3047 */
3048 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3049 unsigned int subcmd, const u8 *data, size_t data_len,
3050 struct wpabuf *buf);
3051
3052 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003053 * set_rekey_info - Set rekey information
3054 * @priv: Private driver interface data
3055 * @kek: Current KEK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003056 * @kek_len: KEK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003057 * @kck: Current KCK
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003058 * @kck_len: KCK length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003059 * @replay_ctr: Current EAPOL-Key Replay Counter
3060 *
3061 * This optional function can be used to provide information for the
3062 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3063 * while the host (including wpa_supplicant) is sleeping.
3064 */
Dmitry Shmidt807291d2015-01-27 13:40:23 -08003065 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3066 const u8 *kck, size_t kck_len,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003067 const u8 *replay_ctr);
3068
3069 /**
3070 * sta_assoc - Station association indication
3071 * @priv: Private driver interface data
3072 * @own_addr: Source address and BSSID for association frame
3073 * @addr: MAC address of the station to associate
3074 * @reassoc: flag to indicate re-association
3075 * @status: association response status code
3076 * @ie: assoc response ie buffer
3077 * @len: ie buffer length
3078 * Returns: 0 on success, -1 on failure
3079 *
3080 * This function indicates the driver to send (Re)Association
3081 * Response frame to the station.
3082 */
3083 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3084 int reassoc, u16 status, const u8 *ie, size_t len);
3085
3086 /**
3087 * sta_auth - Station authentication indication
3088 * @priv: Private driver interface data
3089 * @own_addr: Source address and BSSID for authentication frame
3090 * @addr: MAC address of the station to associate
3091 * @seq: authentication sequence number
3092 * @status: authentication response status code
3093 * @ie: authentication frame ie buffer
3094 * @len: ie buffer length
3095 *
3096 * This function indicates the driver to send Authentication frame
3097 * to the station.
3098 */
3099 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
3100 u16 seq, u16 status, const u8 *ie, size_t len);
3101
3102 /**
3103 * add_tspec - Add traffic stream
3104 * @priv: Private driver interface data
3105 * @addr: MAC address of the station to associate
3106 * @tspec_ie: tspec ie buffer
3107 * @tspec_ielen: tspec ie length
3108 * Returns: 0 on success, -1 on failure
3109 *
3110 * This function adds the traffic steam for the station
3111 * and fills the medium_time in tspec_ie.
3112 */
3113 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3114 size_t tspec_ielen);
3115
3116 /**
3117 * add_sta_node - Add a station node in the driver
3118 * @priv: Private driver interface data
3119 * @addr: MAC address of the station to add
3120 * @auth_alg: authentication algorithm used by the station
3121 * Returns: 0 on success, -1 on failure
3122 *
3123 * This function adds the station node in the driver, when
3124 * the station gets added by FT-over-DS.
3125 */
3126 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
3127
3128 /**
3129 * sched_scan - Request the driver to initiate scheduled scan
3130 * @priv: Private driver interface data
3131 * @params: Scan parameters
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003132 * Returns: 0 on success, -1 on failure
3133 *
3134 * This operation should be used for scheduled scan offload to
3135 * the hardware. Every time scan results are available, the
3136 * driver should report scan results event for wpa_supplicant
3137 * which will eventually request the results with
3138 * wpa_driver_get_scan_results2(). This operation is optional
3139 * and if not provided or if it returns -1, we fall back to
3140 * normal host-scheduled scans.
3141 */
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003142 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003143
3144 /**
3145 * stop_sched_scan - Request the driver to stop a scheduled scan
3146 * @priv: Private driver interface data
3147 * Returns: 0 on success, -1 on failure
3148 *
3149 * This should cause the scheduled scan to be stopped and
3150 * results should stop being sent. Must be supported if
3151 * sched_scan is supported.
3152 */
3153 int (*stop_sched_scan)(void *priv);
3154
3155 /**
3156 * poll_client - Probe (null data or such) the given station
3157 * @priv: Private driver interface data
3158 * @own_addr: MAC address of sending interface
3159 * @addr: MAC address of the station to probe
3160 * @qos: Indicates whether station is QoS station
3161 *
3162 * This function is used to verify whether an associated station is
3163 * still present. This function does not need to be implemented if the
3164 * driver provides such inactivity polling mechanism.
3165 */
3166 void (*poll_client)(void *priv, const u8 *own_addr,
3167 const u8 *addr, int qos);
Dmitry Shmidt04949592012-07-19 12:16:46 -07003168
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003169 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07003170 * radio_disable - Disable/enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003171 * @priv: Private driver interface data
Dmitry Shmidt04949592012-07-19 12:16:46 -07003172 * @disabled: 1=disable 0=enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003173 * Returns: 0 on success, -1 on failure
3174 *
Dmitry Shmidt04949592012-07-19 12:16:46 -07003175 * This optional command is for testing purposes. It can be used to
3176 * disable the radio on a testbed device to simulate out-of-radio-range
3177 * conditions.
3178 */
3179 int (*radio_disable)(void *priv, int disabled);
3180
3181 /**
3182 * switch_channel - Announce channel switch and migrate the GO to the
3183 * given frequency
3184 * @priv: Private driver interface data
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003185 * @settings: Settings for CSA period and new channel
Dmitry Shmidt04949592012-07-19 12:16:46 -07003186 * Returns: 0 on success, -1 on failure
3187 *
3188 * This function is used to move the GO to the legacy STA channel to
3189 * avoid frequency conflict in single channel concurrency.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003190 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08003191 int (*switch_channel)(void *priv, struct csa_settings *settings);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003192
3193 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003194 * add_tx_ts - Add traffic stream
3195 * @priv: Private driver interface data
3196 * @tsid: Traffic stream ID
3197 * @addr: Receiver address
3198 * @user_prio: User priority of the traffic stream
3199 * @admitted_time: Admitted time for this TS in units of
3200 * 32 microsecond periods (per second).
3201 * Returns: 0 on success, -1 on failure
3202 */
3203 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3204 u16 admitted_time);
3205
3206 /**
3207 * del_tx_ts - Delete traffic stream
3208 * @priv: Private driver interface data
3209 * @tsid: Traffic stream ID
3210 * @addr: Receiver address
3211 * Returns: 0 on success, -1 on failure
3212 */
3213 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3214
3215 /**
3216 * Enable channel-switching with TDLS peer
3217 * @priv: Private driver interface data
3218 * @addr: MAC address of the TDLS peer
3219 * @oper_class: Operating class of the switch channel
3220 * @params: Channel specification
3221 * Returns: 0 on success, -1 on failure
3222 *
3223 * The function indicates to driver that it can start switching to a
3224 * different channel with a specified TDLS peer. The switching is
3225 * assumed on until canceled with tdls_disable_channel_switch().
3226 */
3227 int (*tdls_enable_channel_switch)(
3228 void *priv, const u8 *addr, u8 oper_class,
3229 const struct hostapd_freq_params *params);
3230
3231 /**
3232 * Disable channel switching with TDLS peer
3233 * @priv: Private driver interface data
3234 * @addr: MAC address of the TDLS peer
3235 * Returns: 0 on success, -1 on failure
3236 *
3237 * This function indicates to the driver that it should stop switching
3238 * with a given TDLS peer.
3239 */
3240 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3241
3242 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003243 * start_dfs_cac - Listen for radar interference on the channel
3244 * @priv: Private driver interface data
Dmitry Shmidt051af732013-10-22 13:52:46 -07003245 * @freq: Channel parameters
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003246 * Returns: 0 on success, -1 on failure
3247 */
Dmitry Shmidt051af732013-10-22 13:52:46 -07003248 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003249
3250 /**
3251 * stop_ap - Removes beacon from AP
3252 * @priv: Private driver interface data
3253 * Returns: 0 on success, -1 on failure (or if not supported)
3254 *
3255 * This optional function can be used to disable AP mode related
3256 * configuration. Unlike deinit_ap, it does not change to station
3257 * mode.
3258 */
3259 int (*stop_ap)(void *priv);
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003260
3261 /**
3262 * get_survey - Retrieve survey data
3263 * @priv: Private driver interface data
3264 * @freq: If set, survey data for the specified frequency is only
3265 * being requested. If not set, all survey data is requested.
3266 * Returns: 0 on success, -1 on failure
3267 *
3268 * Use this to retrieve:
3269 *
3270 * - the observed channel noise floor
3271 * - the amount of time we have spent on the channel
3272 * - the amount of time during which we have spent on the channel that
3273 * the radio has determined the medium is busy and we cannot
3274 * transmit
3275 * - the amount of time we have spent receiving data
3276 * - the amount of time we have spent transmitting data
3277 *
3278 * This data can be used for spectrum heuristics. One example is
3279 * Automatic Channel Selection (ACS). The channel survey data is
3280 * kept on a linked list on the channel data, one entry is added
3281 * for each survey. The min_nf of the channel is updated for each
3282 * survey.
3283 */
3284 int (*get_survey)(void *priv, unsigned int freq);
Dmitry Shmidt56052862013-10-04 10:23:25 -07003285
3286 /**
3287 * status - Get driver interface status information
3288 * @priv: Private driver interface data
3289 * @buf: Buffer for printing tou the status information
3290 * @buflen: Maximum length of the buffer
3291 * Returns: Length of written status information or -1 on failure
3292 */
3293 int (*status)(void *priv, char *buf, size_t buflen);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003294
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07003295 /**
3296 * roaming - Set roaming policy for driver-based BSS selection
3297 * @priv: Private driver interface data
3298 * @allowed: Whether roaming within ESS is allowed
3299 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3300 * Returns: Length of written status information or -1 on failure
3301 *
3302 * This optional callback can be used to update roaming policy from the
3303 * associate() command (bssid being set there indicates that the driver
3304 * should not roam before getting this roaming() call to allow roaming.
3305 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3306 * capability, roaming policy is handled within wpa_supplicant and there
3307 * is no need to implement or react to this callback.
3308 */
3309 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3310
3311 /**
3312 * set_mac_addr - Set MAC address
3313 * @priv: Private driver interface data
3314 * @addr: MAC address to use or %NULL for setting back to permanent
3315 * Returns: 0 on success, -1 on failure
3316 */
3317 int (*set_mac_addr)(void *priv, const u8 *addr);
3318
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003319#ifdef CONFIG_MACSEC
3320 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3321
3322 int (*macsec_deinit)(void *priv);
3323
3324 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003325 * macsec_get_capability - Inform MKA of this driver's capability
3326 * @priv: Private driver interface data
3327 * @cap: Driver's capability
3328 * Returns: 0 on success, -1 on failure
3329 */
3330 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);
3331
3332 /**
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003333 * enable_protect_frames - Set protect frames status
3334 * @priv: Private driver interface data
3335 * @enabled: TRUE = protect frames enabled
3336 * FALSE = protect frames disabled
3337 * Returns: 0 on success, -1 on failure (or if not supported)
3338 */
3339 int (*enable_protect_frames)(void *priv, Boolean enabled);
3340
3341 /**
3342 * set_replay_protect - Set replay protect status and window size
3343 * @priv: Private driver interface data
3344 * @enabled: TRUE = replay protect enabled
3345 * FALSE = replay protect disabled
3346 * @window: replay window size, valid only when replay protect enabled
3347 * Returns: 0 on success, -1 on failure (or if not supported)
3348 */
3349 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3350
3351 /**
3352 * set_current_cipher_suite - Set current cipher suite
3353 * @priv: Private driver interface data
3354 * @cs: EUI64 identifier
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003355 * Returns: 0 on success, -1 on failure (or if not supported)
3356 */
Dmitry Shmidt7d175302016-09-06 13:11:34 -07003357 int (*set_current_cipher_suite)(void *priv, u64 cs);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003358
3359 /**
3360 * enable_controlled_port - Set controlled port status
3361 * @priv: Private driver interface data
3362 * @enabled: TRUE = controlled port enabled
3363 * FALSE = controlled port disabled
3364 * Returns: 0 on success, -1 on failure (or if not supported)
3365 */
3366 int (*enable_controlled_port)(void *priv, Boolean enabled);
3367
3368 /**
3369 * get_receive_lowest_pn - Get receive lowest pn
3370 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003371 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003372 * Returns: 0 on success, -1 on failure (or if not supported)
3373 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003374 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003375
3376 /**
3377 * get_transmit_next_pn - Get transmit next pn
3378 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003379 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003380 * Returns: 0 on success, -1 on failure (or if not supported)
3381 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003382 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003383
3384 /**
3385 * set_transmit_next_pn - Set transmit next pn
3386 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003387 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003388 * Returns: 0 on success, -1 on failure (or if not supported)
3389 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003390 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003391
3392 /**
3393 * create_receive_sc - create secure channel for receiving
3394 * @priv: Private driver interface data
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003395 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003396 * @conf_offset: confidentiality offset (0, 30, or 50)
3397 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3398 * 2 = Strict)
3399 * Returns: 0 on success, -1 on failure (or if not supported)
3400 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003401 int (*create_receive_sc)(void *priv, struct receive_sc *sc,
3402 unsigned int conf_offset,
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003403 int validation);
3404
3405 /**
3406 * delete_receive_sc - delete secure connection for receiving
3407 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003408 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003409 * Returns: 0 on success, -1 on failure
3410 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003411 int (*delete_receive_sc)(void *priv, struct receive_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003412
3413 /**
3414 * create_receive_sa - create secure association for receive
3415 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003416 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003417 * Returns: 0 on success, -1 on failure
3418 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003419 int (*create_receive_sa)(void *priv, struct receive_sa *sa);
3420
3421 /**
3422 * delete_receive_sa - Delete secure association for receive
3423 * @priv: Private driver interface data from init()
3424 * @sa: Secure association
3425 * Returns: 0 on success, -1 on failure
3426 */
3427 int (*delete_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003428
3429 /**
3430 * enable_receive_sa - enable the SA for receive
3431 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003432 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003433 * Returns: 0 on success, -1 on failure
3434 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003435 int (*enable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003436
3437 /**
3438 * disable_receive_sa - disable SA for receive
3439 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003440 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003441 * Returns: 0 on success, -1 on failure
3442 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003443 int (*disable_receive_sa)(void *priv, struct receive_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003444
3445 /**
3446 * create_transmit_sc - create secure connection for transmit
3447 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003448 * @sc: secure channel
3449 * @conf_offset: confidentiality offset (0, 30, or 50)
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003450 * Returns: 0 on success, -1 on failure
3451 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003452 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
3453 unsigned int conf_offset);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003454
3455 /**
3456 * delete_transmit_sc - delete secure connection for transmit
3457 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003458 * @sc: secure channel
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003459 * Returns: 0 on success, -1 on failure
3460 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003461 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003462
3463 /**
3464 * create_transmit_sa - create secure association for transmit
3465 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003466 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003467 * Returns: 0 on success, -1 on failure
3468 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003469 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);
3470
3471 /**
3472 * delete_transmit_sa - Delete secure association for transmit
3473 * @priv: Private driver interface data from init()
3474 * @sa: Secure association
3475 * Returns: 0 on success, -1 on failure
3476 */
3477 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003478
3479 /**
3480 * enable_transmit_sa - enable SA for transmit
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 (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003486
3487 /**
3488 * disable_transmit_sa - disable SA for transmit
3489 * @priv: private driver interface data from init()
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003490 * @sa: secure association
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003491 * Returns: 0 on success, -1 on failure
3492 */
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003493 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003494#endif /* CONFIG_MACSEC */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003495
3496 /**
3497 * init_mesh - Driver specific initialization for mesh
3498 * @priv: Private driver interface data
3499 * Returns: 0 on success, -1 on failure
3500 */
3501 int (*init_mesh)(void *priv);
3502
3503 /**
3504 * join_mesh - Join a mesh network
3505 * @priv: Private driver interface data
3506 * @params: Mesh configuration parameters
3507 * Returns: 0 on success, -1 on failure
3508 */
3509 int (*join_mesh)(void *priv,
3510 struct wpa_driver_mesh_join_params *params);
3511
3512 /**
3513 * leave_mesh - Leave a mesh network
3514 * @priv: Private driver interface data
3515 * Returns 0 on success, -1 on failure
3516 */
3517 int (*leave_mesh)(void *priv);
3518
3519 /**
3520 * do_acs - Automatically select channel
3521 * @priv: Private driver interface data
3522 * @params: Parameters for ACS
3523 * Returns 0 on success, -1 on failure
3524 *
3525 * This command can be used to offload ACS to the driver if the driver
3526 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3527 */
3528 int (*do_acs)(void *priv, struct drv_acs_params *params);
Ravi Joshie6ccb162015-07-16 17:45:41 -07003529
3530 /**
3531 * set_band - Notify driver of band selection
3532 * @priv: Private driver interface data
3533 * @band: The selected band(s)
3534 * Returns 0 on success, -1 on failure
3535 */
3536 int (*set_band)(void *priv, enum set_band band);
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08003537
3538 /**
3539 * get_pref_freq_list - Get preferred frequency list for an interface
3540 * @priv: Private driver interface data
3541 * @if_type: Interface type
3542 * @num: Number of channels
3543 * @freq_list: Preferred channel frequency list encoded in MHz values
3544 * Returns 0 on success, -1 on failure
3545 *
3546 * This command can be used to query the preferred frequency list from
3547 * the driver specific to a particular interface type.
3548 */
3549 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
3550 unsigned int *num, unsigned int *freq_list);
3551
3552 /**
3553 * set_prob_oper_freq - Indicate probable P2P operating channel
3554 * @priv: Private driver interface data
3555 * @freq: Channel frequency in MHz
3556 * Returns 0 on success, -1 on failure
3557 *
3558 * This command can be used to inform the driver of the operating
3559 * frequency that an ongoing P2P group formation is likely to come up
3560 * on. Local device is assuming P2P Client role.
3561 */
3562 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08003563
3564 /**
3565 * abort_scan - Request the driver to abort an ongoing scan
3566 * @priv: Private driver interface data
3567 * Returns 0 on success, -1 on failure
3568 */
3569 int (*abort_scan)(void *priv);
Dmitry Shmidt849734c2016-05-27 09:59:01 -07003570
3571 /**
3572 * configure_data_frame_filters - Request to configure frame filters
3573 * @priv: Private driver interface data
3574 * @filter_flags: The type of frames to filter (bitfield of
3575 * WPA_DATA_FRAME_FILTER_FLAG_*)
3576 * Returns: 0 on success or -1 on failure
3577 */
3578 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07003579
3580 /**
3581 * get_ext_capab - Get extended capabilities for the specified interface
3582 * @priv: Private driver interface data
3583 * @type: Interface type for which to get extended capabilities
3584 * @ext_capab: Extended capabilities fetched
3585 * @ext_capab_mask: Extended capabilities mask
3586 * @ext_capab_len: Length of the extended capabilities
3587 * Returns: 0 on success or -1 on failure
3588 */
3589 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
3590 const u8 **ext_capab, const u8 **ext_capab_mask,
3591 unsigned int *ext_capab_len);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07003592
3593 /**
3594 * p2p_lo_start - Start offloading P2P listen to device
3595 * @priv: Private driver interface data
3596 * @freq: Listening frequency (MHz) for P2P listen
3597 * @period: Length of the listen operation in milliseconds
3598 * @interval: Interval for running the listen operation in milliseconds
3599 * @count: Number of times to run the listen operation
3600 * @device_types: Device primary and secondary types
3601 * @dev_types_len: Number of bytes for device_types
3602 * @ies: P2P IE and WSC IE for Probe Response frames
3603 * @ies_len: Length of ies in bytes
3604 * Returns: 0 on success or -1 on failure
3605 */
3606 int (*p2p_lo_start)(void *priv, unsigned int freq,
3607 unsigned int period, unsigned int interval,
3608 unsigned int count,
3609 const u8 *device_types, size_t dev_types_len,
3610 const u8 *ies, size_t ies_len);
3611
3612 /**
3613 * p2p_lo_stop - Stop P2P listen offload
3614 * @priv: Private driver interface data
3615 * Returns: 0 on success or -1 on failure
3616 */
3617 int (*p2p_lo_stop)(void *priv);
Dmitry Shmidt7f2c7532016-08-15 09:48:12 -07003618
3619 /**
3620 * set_default_scan_ies - Set default scan IEs
3621 * @priv: Private driver interface data
3622 * @ies: Scan default IEs buffer
3623 * @ies_len: Length of IEs in bytes
3624 * Returns: 0 on success or -1 on failure
3625 *
3626 * The driver can use these by default when there are no scan IEs coming
3627 * in the subsequent scan requests. Also in case of one or more of IEs
3628 * given in set_default_scan_ies() are missing in the subsequent scan
3629 * request, the driver should merge the missing scan IEs in the scan
3630 * request from the IEs set by set_default_scan_ies() in the Probe
3631 * Request frames sent.
3632 */
3633 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
3634
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08003635 /**
3636 * set_tdls_mode - Set TDLS trigger mode to the host driver
3637 * @priv: Private driver interface data
3638 * @tdls_external_control: Represents if TDLS external trigger control
3639 * mode is enabled/disabled.
3640 *
3641 * This optional callback can be used to configure the TDLS external
3642 * trigger control mode to the host driver.
3643 */
3644 int (*set_tdls_mode)(void *priv, int tdls_external_control);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003645};
3646
3647
3648/**
3649 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3650 */
3651enum wpa_event_type {
3652 /**
3653 * EVENT_ASSOC - Association completed
3654 *
3655 * This event needs to be delivered when the driver completes IEEE
3656 * 802.11 association or reassociation successfully.
3657 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3658 * after this event has been generated. In addition, optional
3659 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3660 * more information about the association. If the driver interface gets
3661 * both of these events at the same time, it can also include the
3662 * assoc_info data in EVENT_ASSOC call.
3663 */
3664 EVENT_ASSOC,
3665
3666 /**
3667 * EVENT_DISASSOC - Association lost
3668 *
3669 * This event should be called when association is lost either due to
3670 * receiving deauthenticate or disassociate frame from the AP or when
3671 * sending either of these frames to the current AP. If the driver
3672 * supports separate deauthentication event, EVENT_DISASSOC should only
3673 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3674 * In AP mode, union wpa_event_data::disassoc_info is required.
3675 */
3676 EVENT_DISASSOC,
3677
3678 /**
3679 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3680 *
3681 * This event must be delivered when a Michael MIC error is detected by
3682 * the local driver. Additional data for event processing is
3683 * provided with union wpa_event_data::michael_mic_failure. This
3684 * information is used to request new encyption key and to initiate
3685 * TKIP countermeasures if needed.
3686 */
3687 EVENT_MICHAEL_MIC_FAILURE,
3688
3689 /**
3690 * EVENT_SCAN_RESULTS - Scan results available
3691 *
3692 * This event must be called whenever scan results are available to be
3693 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3694 * is expected to be used some time after struct wpa_driver_ops::scan()
3695 * is called. If the driver provides an unsolicited event when the scan
3696 * has been completed, this event can be used to trigger
3697 * EVENT_SCAN_RESULTS call. If such event is not available from the
3698 * driver, the driver wrapper code is expected to use a registered
3699 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3700 * scan is expected to be completed. Optional information about
3701 * completed scan can be provided with union wpa_event_data::scan_info.
3702 */
3703 EVENT_SCAN_RESULTS,
3704
3705 /**
3706 * EVENT_ASSOCINFO - Report optional extra information for association
3707 *
3708 * This event can be used to report extra association information for
3709 * EVENT_ASSOC processing. This extra information includes IEs from
3710 * association frames and Beacon/Probe Response frames in union
3711 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3712 * EVENT_ASSOC. Alternatively, the driver interface can include
3713 * assoc_info data in the EVENT_ASSOC call if it has all the
3714 * information available at the same point.
3715 */
3716 EVENT_ASSOCINFO,
3717
3718 /**
3719 * EVENT_INTERFACE_STATUS - Report interface status changes
3720 *
3721 * This optional event can be used to report changes in interface
3722 * status (interface added/removed) using union
3723 * wpa_event_data::interface_status. This can be used to trigger
3724 * wpa_supplicant to stop and re-start processing for the interface,
3725 * e.g., when a cardbus card is ejected/inserted.
3726 */
3727 EVENT_INTERFACE_STATUS,
3728
3729 /**
3730 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3731 *
3732 * This event can be used to inform wpa_supplicant about candidates for
3733 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3734 * for scan request (ap_scan=2 mode), this event is required for
3735 * pre-authentication. If wpa_supplicant is performing scan request
3736 * (ap_scan=1), this event is optional since scan results can be used
3737 * to add pre-authentication candidates. union
3738 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3739 * candidate and priority of the candidate, e.g., based on the signal
3740 * strength, in order to try to pre-authenticate first with candidates
3741 * that are most likely targets for re-association.
3742 *
3743 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3744 * on the candidate list. In addition, it can be called for the current
3745 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3746 * will automatically skip pre-authentication in cases where a valid
3747 * PMKSA exists. When more than one candidate exists, this event should
3748 * be generated once for each candidate.
3749 *
3750 * Driver will be notified about successful pre-authentication with
3751 * struct wpa_driver_ops::add_pmkid() calls.
3752 */
3753 EVENT_PMKID_CANDIDATE,
3754
3755 /**
3756 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3757 *
3758 * This event can be used to inform wpa_supplicant about desire to set
3759 * up secure direct link connection between two stations as defined in
3760 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3761 * STAKey negotiation. The caller will need to set peer address for the
3762 * event.
3763 */
3764 EVENT_STKSTART,
3765
3766 /**
3767 * EVENT_TDLS - Request TDLS operation
3768 *
3769 * This event can be used to request a TDLS operation to be performed.
3770 */
3771 EVENT_TDLS,
3772
3773 /**
3774 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3775 *
3776 * The driver is expected to report the received FT IEs from
3777 * FT authentication sequence from the AP. The FT IEs are included in
3778 * the extra information in union wpa_event_data::ft_ies.
3779 */
3780 EVENT_FT_RESPONSE,
3781
3782 /**
3783 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3784 *
3785 * The driver can use this event to inform wpa_supplicant about a STA
3786 * in an IBSS with which protected frames could be exchanged. This
3787 * event starts RSN authentication with the other STA to authenticate
3788 * the STA and set up encryption keys with it.
3789 */
3790 EVENT_IBSS_RSN_START,
3791
3792 /**
3793 * EVENT_AUTH - Authentication result
3794 *
3795 * This event should be called when authentication attempt has been
3796 * completed. This is only used if the driver supports separate
3797 * authentication step (struct wpa_driver_ops::authenticate).
3798 * Information about authentication result is included in
3799 * union wpa_event_data::auth.
3800 */
3801 EVENT_AUTH,
3802
3803 /**
3804 * EVENT_DEAUTH - Authentication lost
3805 *
3806 * This event should be called when authentication is lost either due
3807 * to receiving deauthenticate frame from the AP or when sending that
3808 * frame to the current AP.
3809 * In AP mode, union wpa_event_data::deauth_info is required.
3810 */
3811 EVENT_DEAUTH,
3812
3813 /**
3814 * EVENT_ASSOC_REJECT - Association rejected
3815 *
3816 * This event should be called when (re)association attempt has been
3817 * rejected by the AP. Information about the association response is
3818 * included in union wpa_event_data::assoc_reject.
3819 */
3820 EVENT_ASSOC_REJECT,
3821
3822 /**
3823 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3824 */
3825 EVENT_AUTH_TIMED_OUT,
3826
3827 /**
3828 * EVENT_ASSOC_TIMED_OUT - Association timed out
3829 */
3830 EVENT_ASSOC_TIMED_OUT,
3831
3832 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003833 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3834 */
3835 EVENT_WPS_BUTTON_PUSHED,
3836
3837 /**
3838 * EVENT_TX_STATUS - Report TX status
3839 */
3840 EVENT_TX_STATUS,
3841
3842 /**
3843 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3844 */
3845 EVENT_RX_FROM_UNKNOWN,
3846
3847 /**
3848 * EVENT_RX_MGMT - Report RX of a management frame
3849 */
3850 EVENT_RX_MGMT,
3851
3852 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003853 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3854 *
3855 * This event is used to indicate when the driver has started the
3856 * requested remain-on-channel duration. Information about the
3857 * operation is included in union wpa_event_data::remain_on_channel.
3858 */
3859 EVENT_REMAIN_ON_CHANNEL,
3860
3861 /**
3862 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3863 *
3864 * This event is used to indicate when the driver has completed
3865 * remain-on-channel duration, i.e., may noot be available on the
3866 * requested channel anymore. Information about the
3867 * operation is included in union wpa_event_data::remain_on_channel.
3868 */
3869 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3870
3871 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003872 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3873 *
3874 * This event is used to indicate when a Probe Request frame has been
3875 * received. Information about the received frame is included in
3876 * union wpa_event_data::rx_probe_req. The driver is required to report
3877 * these events only after successfully completed probe_req_report()
3878 * commands to request the events (i.e., report parameter is non-zero)
3879 * in station mode. In AP mode, Probe Request frames should always be
3880 * reported.
3881 */
3882 EVENT_RX_PROBE_REQ,
3883
3884 /**
3885 * EVENT_NEW_STA - New wired device noticed
3886 *
3887 * This event is used to indicate that a new device has been detected
3888 * in a network that does not use association-like functionality (i.e.,
3889 * mainly wired Ethernet). This can be used to start EAPOL
3890 * authenticator when receiving a frame from a device. The address of
3891 * the device is included in union wpa_event_data::new_sta.
3892 */
3893 EVENT_NEW_STA,
3894
3895 /**
3896 * EVENT_EAPOL_RX - Report received EAPOL frame
3897 *
3898 * When in AP mode with hostapd, this event is required to be used to
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003899 * deliver the receive EAPOL frames from the driver.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003900 */
3901 EVENT_EAPOL_RX,
3902
3903 /**
3904 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3905 *
3906 * This event is used to indicate changes in the signal strength
3907 * observed in frames received from the current AP if signal strength
3908 * monitoring has been enabled with signal_monitor().
3909 */
3910 EVENT_SIGNAL_CHANGE,
3911
3912 /**
3913 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3914 *
3915 * This event is used to indicate that the interface was enabled after
3916 * having been previously disabled, e.g., due to rfkill.
3917 */
3918 EVENT_INTERFACE_ENABLED,
3919
3920 /**
3921 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3922 *
3923 * This event is used to indicate that the interface was disabled,
3924 * e.g., due to rfkill.
3925 */
3926 EVENT_INTERFACE_DISABLED,
3927
3928 /**
3929 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3930 *
3931 * This event is used to indicate that the channel list has changed,
3932 * e.g., because of a regulatory domain change triggered by scan
3933 * results including an AP advertising a country code.
3934 */
3935 EVENT_CHANNEL_LIST_CHANGED,
3936
3937 /**
3938 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3939 *
3940 * This event is used to indicate that the driver cannot maintain this
3941 * interface in its operation mode anymore. The most likely use for
3942 * this is to indicate that AP mode operation is not available due to
3943 * operating channel would need to be changed to a DFS channel when
3944 * the driver does not support radar detection and another virtual
3945 * interfaces caused the operating channel to change. Other similar
3946 * resource conflicts could also trigger this for station mode
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07003947 * interfaces. This event can be propagated when channel switching
3948 * fails.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003949 */
3950 EVENT_INTERFACE_UNAVAILABLE,
3951
3952 /**
3953 * EVENT_BEST_CHANNEL
3954 *
3955 * Driver generates this event whenever it detects a better channel
3956 * (e.g., based on RSSI or channel use). This information can be used
3957 * to improve channel selection for a new AP/P2P group.
3958 */
3959 EVENT_BEST_CHANNEL,
3960
3961 /**
3962 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3963 *
3964 * This event should be called when a Deauthentication frame is dropped
3965 * due to it not being protected (MFP/IEEE 802.11w).
3966 * union wpa_event_data::unprot_deauth is required to provide more
3967 * details of the frame.
3968 */
3969 EVENT_UNPROT_DEAUTH,
3970
3971 /**
3972 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3973 *
3974 * This event should be called when a Disassociation frame is dropped
3975 * due to it not being protected (MFP/IEEE 802.11w).
3976 * union wpa_event_data::unprot_disassoc is required to provide more
3977 * details of the frame.
3978 */
3979 EVENT_UNPROT_DISASSOC,
3980
3981 /**
3982 * EVENT_STATION_LOW_ACK
3983 *
3984 * Driver generates this event whenever it detected that a particular
3985 * station was lost. Detection can be through massive transmission
3986 * failures for example.
3987 */
3988 EVENT_STATION_LOW_ACK,
3989
3990 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003991 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3992 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003993 EVENT_IBSS_PEER_LOST,
3994
3995 /**
3996 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3997 *
3998 * This event carries the new replay counter to notify wpa_supplicant
3999 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4000 * completed Group Key Handshake while the host (including
4001 * wpa_supplicant was sleeping).
4002 */
4003 EVENT_DRIVER_GTK_REKEY,
4004
4005 /**
4006 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4007 */
4008 EVENT_SCHED_SCAN_STOPPED,
4009
4010 /**
4011 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4012 *
4013 * This event indicates that the station responded to the poll
4014 * initiated with @poll_client.
4015 */
4016 EVENT_DRIVER_CLIENT_POLL_OK,
4017
4018 /**
4019 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4020 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07004021 EVENT_EAPOL_TX_STATUS,
4022
4023 /**
4024 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4025 *
4026 * Described in wpa_event_data.ch_switch
4027 * */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004028 EVENT_CH_SWITCH,
4029
4030 /**
4031 * EVENT_WNM - Request WNM operation
4032 *
4033 * This event can be used to request a WNM operation to be performed.
4034 */
Dmitry Shmidtf8623282013-02-20 14:34:59 -08004035 EVENT_WNM,
4036
4037 /**
4038 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4039 *
4040 * This event indicates that the driver reported a connection failure
4041 * with the specified client (for example, max client reached, etc.) in
4042 * AP mode.
4043 */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004044 EVENT_CONNECT_FAILED_REASON,
4045
4046 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004047 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004048 *
4049 * A radar has been detected on the supplied frequency, hostapd should
4050 * react accordingly (e.g., change channel).
4051 */
4052 EVENT_DFS_RADAR_DETECTED,
4053
4054 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004055 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004056 *
4057 * After a successful CAC, the channel can be marked clear and used.
4058 */
4059 EVENT_DFS_CAC_FINISHED,
4060
4061 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004062 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004063 *
4064 * The CAC was not successful, and the channel remains in the previous
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004065 * state. This may happen due to a radar being detected or other
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004066 * external influences.
4067 */
4068 EVENT_DFS_CAC_ABORTED,
4069
4070 /**
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004071 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004072 *
4073 * The channel which was previously unavailable is now available again.
4074 */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004075 EVENT_DFS_NOP_FINISHED,
4076
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08004077 /**
4078 * EVENT_SURVEY - Received survey data
4079 *
4080 * This event gets triggered when a driver query is issued for survey
4081 * data and the requested data becomes available. The returned data is
4082 * stored in struct survey_results. The results provide at most one
4083 * survey entry for each frequency and at minimum will provide one
4084 * survey entry for one frequency. The survey data can be os_malloc()'d
4085 * and then os_free()'d, so the event callback must only copy data.
4086 */
4087 EVENT_SURVEY,
4088
4089 /**
4090 * EVENT_SCAN_STARTED - Scan started
4091 *
4092 * This indicates that driver has started a scan operation either based
4093 * on a request from wpa_supplicant/hostapd or from another application.
4094 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4095 * completed (either successfully or by getting cancelled).
4096 */
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08004097 EVENT_SCAN_STARTED,
4098
4099 /**
4100 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4101 *
4102 * This event indicates a set of frequency ranges that should be avoided
4103 * to reduce issues due to interference or internal co-existence
4104 * information in the driver.
4105 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004106 EVENT_AVOID_FREQUENCIES,
4107
4108 /**
4109 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4110 */
4111 EVENT_NEW_PEER_CANDIDATE,
4112
4113 /**
4114 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4115 *
4116 * Indicates a pair of primary and secondary channels chosen by ACS
4117 * in device.
4118 */
4119 EVENT_ACS_CHANNEL_SELECTED,
Dmitry Shmidt7f656022015-02-25 14:36:37 -08004120
4121 /**
4122 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4123 * been started.
4124 *
4125 * This event indicates that channel availability check has been started
4126 * on a DFS frequency by a driver that supports DFS Offload.
4127 */
4128 EVENT_DFS_CAC_STARTED,
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004129
4130 /**
4131 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4132 */
4133 EVENT_P2P_LO_STOP,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004134};
4135
4136
4137/**
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004138 * struct freq_survey - Channel survey info
4139 *
4140 * @ifidx: Interface index in which this survey was observed
4141 * @freq: Center of frequency of the surveyed channel
4142 * @nf: Channel noise floor in dBm
4143 * @channel_time: Amount of time in ms the radio spent on the channel
4144 * @channel_time_busy: Amount of time in ms the radio detected some signal
4145 * that indicated to the radio the channel was not clear
4146 * @channel_time_rx: Amount of time the radio spent receiving data
4147 * @channel_time_tx: Amount of time the radio spent transmitting data
4148 * @filled: bitmask indicating which fields have been reported, see
4149 * SURVEY_HAS_* defines.
4150 * @list: Internal list pointers
4151 */
4152struct freq_survey {
4153 u32 ifidx;
4154 unsigned int freq;
4155 s8 nf;
4156 u64 channel_time;
4157 u64 channel_time_busy;
4158 u64 channel_time_rx;
4159 u64 channel_time_tx;
4160 unsigned int filled;
4161 struct dl_list list;
4162};
4163
4164#define SURVEY_HAS_NF BIT(0)
4165#define SURVEY_HAS_CHAN_TIME BIT(1)
4166#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4167#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4168#define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4169
4170
4171/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004172 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4173 */
4174union wpa_event_data {
4175 /**
4176 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4177 *
4178 * This structure is optional for EVENT_ASSOC calls and required for
4179 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4180 * driver interface does not need to generate separate EVENT_ASSOCINFO
4181 * calls.
4182 */
4183 struct assoc_info {
4184 /**
4185 * reassoc - Flag to indicate association or reassociation
4186 */
4187 int reassoc;
4188
4189 /**
4190 * req_ies - (Re)Association Request IEs
4191 *
4192 * If the driver generates WPA/RSN IE, this event data must be
4193 * returned for WPA handshake to have needed information. If
4194 * wpa_supplicant-generated WPA/RSN IE is used, this
4195 * information event is optional.
4196 *
4197 * This should start with the first IE (fixed fields before IEs
4198 * are not included).
4199 */
4200 const u8 *req_ies;
4201
4202 /**
4203 * req_ies_len - Length of req_ies in bytes
4204 */
4205 size_t req_ies_len;
4206
4207 /**
4208 * resp_ies - (Re)Association Response IEs
4209 *
4210 * Optional association data from the driver. This data is not
4211 * required WPA, but may be useful for some protocols and as
4212 * such, should be reported if this is available to the driver
4213 * interface.
4214 *
4215 * This should start with the first IE (fixed fields before IEs
4216 * are not included).
4217 */
4218 const u8 *resp_ies;
4219
4220 /**
4221 * resp_ies_len - Length of resp_ies in bytes
4222 */
4223 size_t resp_ies_len;
4224
4225 /**
Dmitry Shmidt9839ecd2016-11-07 11:05:47 -08004226 * resp_frame - (Re)Association Response frame
4227 */
4228 const u8 *resp_frame;
4229
4230 /**
4231 * resp_frame_len - (Re)Association Response frame length
4232 */
4233 size_t resp_frame_len;
4234
4235 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004236 * beacon_ies - Beacon or Probe Response IEs
4237 *
4238 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4239 * Probe Response frames from the current AP (i.e., the one
4240 * that the client just associated with). This information is
4241 * used to update WPA/RSN IE for the AP. If this field is not
4242 * set, the results from previous scan will be used. If no
4243 * data for the new AP is found, scan results will be requested
4244 * again (without scan request). At this point, the driver is
4245 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4246 * used).
4247 *
4248 * This should start with the first IE (fixed fields before IEs
4249 * are not included).
4250 */
4251 const u8 *beacon_ies;
4252
4253 /**
4254 * beacon_ies_len - Length of beacon_ies */
4255 size_t beacon_ies_len;
4256
4257 /**
4258 * freq - Frequency of the operational channel in MHz
4259 */
4260 unsigned int freq;
4261
4262 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004263 * wmm_params - WMM parameters used in this association.
4264 */
4265 struct wmm_params wmm_params;
4266
4267 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004268 * addr - Station address (for AP mode)
4269 */
4270 const u8 *addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004271
4272 /**
4273 * The following is the key management offload information
4274 * @authorized
4275 * @key_replay_ctr
4276 * @key_replay_ctr_len
4277 * @ptk_kck
4278 * @ptk_kek_len
4279 * @ptk_kek
4280 * @ptk_kek_len
4281 */
4282
4283 /**
4284 * authorized - Status of key management offload,
4285 * 1 = successful
4286 */
4287 int authorized;
4288
4289 /**
4290 * key_replay_ctr - Key replay counter value last used
4291 * in a valid EAPOL-Key frame
4292 */
4293 const u8 *key_replay_ctr;
4294
4295 /**
4296 * key_replay_ctr_len - The length of key_replay_ctr
4297 */
4298 size_t key_replay_ctr_len;
4299
4300 /**
4301 * ptk_kck - The derived PTK KCK
4302 */
4303 const u8 *ptk_kck;
4304
4305 /**
4306 * ptk_kek_len - The length of ptk_kck
4307 */
4308 size_t ptk_kck_len;
4309
4310 /**
4311 * ptk_kek - The derived PTK KEK
4312 */
4313 const u8 *ptk_kek;
4314
4315 /**
4316 * ptk_kek_len - The length of ptk_kek
4317 */
4318 size_t ptk_kek_len;
Dmitry Shmidtd7ff03d2015-12-04 14:49:35 -08004319
4320 /**
4321 * subnet_status - The subnet status:
4322 * 0 = unknown, 1 = unchanged, 2 = changed
4323 */
4324 u8 subnet_status;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004325 } assoc_info;
4326
4327 /**
4328 * struct disassoc_info - Data for EVENT_DISASSOC events
4329 */
4330 struct disassoc_info {
4331 /**
4332 * addr - Station address (for AP mode)
4333 */
4334 const u8 *addr;
4335
4336 /**
4337 * reason_code - Reason Code (host byte order) used in
4338 * Deauthentication frame
4339 */
4340 u16 reason_code;
4341
4342 /**
4343 * ie - Optional IE(s) in Disassociation frame
4344 */
4345 const u8 *ie;
4346
4347 /**
4348 * ie_len - Length of ie buffer in octets
4349 */
4350 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08004351
4352 /**
4353 * locally_generated - Whether the frame was locally generated
4354 */
4355 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004356 } disassoc_info;
4357
4358 /**
4359 * struct deauth_info - Data for EVENT_DEAUTH events
4360 */
4361 struct deauth_info {
4362 /**
4363 * addr - Station address (for AP mode)
4364 */
4365 const u8 *addr;
4366
4367 /**
4368 * reason_code - Reason Code (host byte order) used in
4369 * Deauthentication frame
4370 */
4371 u16 reason_code;
4372
4373 /**
4374 * ie - Optional IE(s) in Deauthentication frame
4375 */
4376 const u8 *ie;
4377
4378 /**
4379 * ie_len - Length of ie buffer in octets
4380 */
4381 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08004382
4383 /**
4384 * locally_generated - Whether the frame was locally generated
4385 */
4386 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004387 } deauth_info;
4388
4389 /**
4390 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4391 */
4392 struct michael_mic_failure {
4393 int unicast;
4394 const u8 *src;
4395 } michael_mic_failure;
4396
4397 /**
4398 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4399 */
4400 struct interface_status {
Dmitry Shmidte4663042016-04-04 10:07:49 -07004401 unsigned int ifindex;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004402 char ifname[100];
4403 enum {
4404 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4405 } ievent;
4406 } interface_status;
4407
4408 /**
4409 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4410 */
4411 struct pmkid_candidate {
4412 /** BSSID of the PMKID candidate */
4413 u8 bssid[ETH_ALEN];
4414 /** Smaller the index, higher the priority */
4415 int index;
4416 /** Whether RSN IE includes pre-authenticate flag */
4417 int preauth;
4418 } pmkid_candidate;
4419
4420 /**
4421 * struct stkstart - Data for EVENT_STKSTART
4422 */
4423 struct stkstart {
4424 u8 peer[ETH_ALEN];
4425 } stkstart;
4426
4427 /**
4428 * struct tdls - Data for EVENT_TDLS
4429 */
4430 struct tdls {
4431 u8 peer[ETH_ALEN];
4432 enum {
4433 TDLS_REQUEST_SETUP,
Dmitry Shmidt4dd28dc2015-03-10 11:21:43 -07004434 TDLS_REQUEST_TEARDOWN,
4435 TDLS_REQUEST_DISCOVER,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004436 } oper;
4437 u16 reason_code; /* for teardown */
4438 } tdls;
4439
4440 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004441 * struct wnm - Data for EVENT_WNM
4442 */
4443 struct wnm {
4444 u8 addr[ETH_ALEN];
4445 enum {
4446 WNM_OPER_SLEEP,
4447 } oper;
4448 enum {
4449 WNM_SLEEP_ENTER,
4450 WNM_SLEEP_EXIT
4451 } sleep_action;
4452 int sleep_intval;
4453 u16 reason_code;
4454 u8 *buf;
4455 u16 buf_len;
4456 } wnm;
4457
4458 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004459 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4460 *
4461 * During FT (IEEE 802.11r) authentication sequence, the driver is
4462 * expected to use this event to report received FT IEs (MDIE, FTIE,
4463 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4464 * IEs for the next message will be delivered through the
4465 * struct wpa_driver_ops::update_ft_ies() callback.
4466 */
4467 struct ft_ies {
4468 const u8 *ies;
4469 size_t ies_len;
4470 int ft_action;
4471 u8 target_ap[ETH_ALEN];
4472 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4473 const u8 *ric_ies;
4474 /** Length of ric_ies buffer in octets */
4475 size_t ric_ies_len;
4476 } ft_ies;
4477
4478 /**
4479 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4480 */
4481 struct ibss_rsn_start {
4482 u8 peer[ETH_ALEN];
4483 } ibss_rsn_start;
4484
4485 /**
4486 * struct auth_info - Data for EVENT_AUTH events
4487 */
4488 struct auth_info {
4489 u8 peer[ETH_ALEN];
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004490 u8 bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004491 u16 auth_type;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004492 u16 auth_transaction;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004493 u16 status_code;
4494 const u8 *ies;
4495 size_t ies_len;
4496 } auth;
4497
4498 /**
4499 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4500 */
4501 struct assoc_reject {
4502 /**
4503 * bssid - BSSID of the AP that rejected association
4504 */
4505 const u8 *bssid;
4506
4507 /**
4508 * resp_ies - (Re)Association Response IEs
4509 *
4510 * Optional association data from the driver. This data is not
4511 * required WPA, but may be useful for some protocols and as
4512 * such, should be reported if this is available to the driver
4513 * interface.
4514 *
4515 * This should start with the first IE (fixed fields before IEs
4516 * are not included).
4517 */
4518 const u8 *resp_ies;
4519
4520 /**
4521 * resp_ies_len - Length of resp_ies in bytes
4522 */
4523 size_t resp_ies_len;
4524
4525 /**
4526 * status_code - Status Code from (Re)association Response
4527 */
4528 u16 status_code;
Dmitry Shmidtd5ab1b52016-06-21 12:38:41 -07004529
4530 /**
4531 * timed_out - Whether failure is due to timeout (etc.) rather
4532 * than explicit rejection response from the AP.
4533 */
4534 int timed_out;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004535 } assoc_reject;
4536
4537 struct timeout_event {
4538 u8 addr[ETH_ALEN];
4539 } timeout_event;
4540
4541 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004542 * struct tx_status - Data for EVENT_TX_STATUS events
4543 */
4544 struct tx_status {
4545 u16 type;
4546 u16 stype;
4547 const u8 *dst;
4548 const u8 *data;
4549 size_t data_len;
4550 int ack;
4551 } tx_status;
4552
4553 /**
4554 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4555 */
4556 struct rx_from_unknown {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004557 const u8 *bssid;
4558 const u8 *addr;
4559 int wds;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004560 } rx_from_unknown;
4561
4562 /**
4563 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4564 */
4565 struct rx_mgmt {
4566 const u8 *frame;
4567 size_t frame_len;
4568 u32 datarate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004569
4570 /**
Dmitry Shmidt98660862014-03-11 17:26:21 -07004571 * drv_priv - Pointer to store driver private BSS information
4572 *
4573 * If not set to NULL, this is used for comparison with
4574 * hostapd_data->drv_priv to determine which BSS should process
4575 * the frame.
4576 */
4577 void *drv_priv;
4578
4579 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004580 * freq - Frequency (in MHz) on which the frame was received
4581 */
4582 int freq;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08004583
4584 /**
4585 * ssi_signal - Signal strength in dBm (or 0 if not available)
4586 */
4587 int ssi_signal;
4588 } rx_mgmt;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004589
4590 /**
4591 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4592 *
4593 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4594 */
4595 struct remain_on_channel {
4596 /**
4597 * freq - Channel frequency in MHz
4598 */
4599 unsigned int freq;
4600
4601 /**
4602 * duration - Duration to remain on the channel in milliseconds
4603 */
4604 unsigned int duration;
4605 } remain_on_channel;
4606
4607 /**
4608 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4609 * @aborted: Whether the scan was aborted
4610 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4611 * @num_freqs: Number of entries in freqs array
4612 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4613 * SSID)
4614 * @num_ssids: Number of entries in ssids array
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004615 * @external_scan: Whether the scan info is for an external scan
4616 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
4617 * 0 if the source of the scan event is a vendor scan
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004618 */
4619 struct scan_info {
4620 int aborted;
4621 const int *freqs;
4622 size_t num_freqs;
4623 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4624 size_t num_ssids;
Dmitry Shmidtd80a4012015-11-05 16:35:40 -08004625 int external_scan;
4626 int nl_scan_event;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004627 } scan_info;
4628
4629 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004630 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4631 */
4632 struct rx_probe_req {
4633 /**
4634 * sa - Source address of the received Probe Request frame
4635 */
4636 const u8 *sa;
4637
4638 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004639 * da - Destination address of the received Probe Request frame
4640 * or %NULL if not available
4641 */
4642 const u8 *da;
4643
4644 /**
4645 * bssid - BSSID of the received Probe Request frame or %NULL
4646 * if not available
4647 */
4648 const u8 *bssid;
4649
4650 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004651 * ie - IEs from the Probe Request body
4652 */
4653 const u8 *ie;
4654
4655 /**
4656 * ie_len - Length of ie buffer in octets
4657 */
4658 size_t ie_len;
Dmitry Shmidt04949592012-07-19 12:16:46 -07004659
4660 /**
4661 * signal - signal strength in dBm (or 0 if not available)
4662 */
4663 int ssi_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004664 } rx_probe_req;
4665
4666 /**
4667 * struct new_sta - Data for EVENT_NEW_STA events
4668 */
4669 struct new_sta {
4670 const u8 *addr;
4671 } new_sta;
4672
4673 /**
4674 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4675 */
4676 struct eapol_rx {
4677 const u8 *src;
4678 const u8 *data;
4679 size_t data_len;
4680 } eapol_rx;
4681
4682 /**
4683 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4684 */
4685 struct wpa_signal_info signal_change;
4686
4687 /**
4688 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4689 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4690 * @freq_5: Best 5 GHz band channel frequency in MHz
4691 * @freq_overall: Best channel frequency in MHz
4692 *
4693 * 0 can be used to indicate no preference in either band.
4694 */
4695 struct best_channel {
4696 int freq_24;
4697 int freq_5;
4698 int freq_overall;
4699 } best_chan;
4700
4701 struct unprot_deauth {
4702 const u8 *sa;
4703 const u8 *da;
4704 u16 reason_code;
4705 } unprot_deauth;
4706
4707 struct unprot_disassoc {
4708 const u8 *sa;
4709 const u8 *da;
4710 u16 reason_code;
4711 } unprot_disassoc;
4712
4713 /**
4714 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4715 * @addr: station address
4716 */
4717 struct low_ack {
4718 u8 addr[ETH_ALEN];
4719 } low_ack;
4720
4721 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004722 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4723 */
4724 struct ibss_peer_lost {
4725 u8 peer[ETH_ALEN];
4726 } ibss_peer_lost;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004727
4728 /**
4729 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4730 */
4731 struct driver_gtk_rekey {
4732 const u8 *bssid;
4733 const u8 *replay_ctr;
4734 } driver_gtk_rekey;
4735
4736 /**
4737 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4738 * @addr: station address
4739 */
4740 struct client_poll {
4741 u8 addr[ETH_ALEN];
4742 } client_poll;
4743
4744 /**
4745 * struct eapol_tx_status
4746 * @dst: Original destination
4747 * @data: Data starting with IEEE 802.1X header (!)
4748 * @data_len: Length of data
4749 * @ack: Indicates ack or lost frame
4750 *
4751 * This corresponds to hapd_send_eapol if the frame sent
4752 * there isn't just reported as EVENT_TX_STATUS.
4753 */
4754 struct eapol_tx_status {
4755 const u8 *dst;
4756 const u8 *data;
4757 int data_len;
4758 int ack;
4759 } eapol_tx_status;
Dmitry Shmidt04949592012-07-19 12:16:46 -07004760
4761 /**
4762 * struct ch_switch
4763 * @freq: Frequency of new channel in MHz
4764 * @ht_enabled: Whether this is an HT channel
4765 * @ch_offset: Secondary channel offset
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08004766 * @ch_width: Channel width
4767 * @cf1: Center frequency 1
4768 * @cf2: Center frequency 2
Dmitry Shmidt04949592012-07-19 12:16:46 -07004769 */
4770 struct ch_switch {
4771 int freq;
4772 int ht_enabled;
4773 int ch_offset;
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08004774 enum chan_width ch_width;
4775 int cf1;
4776 int cf2;
Dmitry Shmidt04949592012-07-19 12:16:46 -07004777 } ch_switch;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08004778
4779 /**
4780 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4781 * @addr: Remote client address
4782 * @code: Reason code for connection failure
4783 */
4784 struct connect_failed_reason {
4785 u8 addr[ETH_ALEN];
4786 enum {
4787 MAX_CLIENT_REACHED,
4788 BLOCKED_CLIENT
4789 } code;
4790 } connect_failed_reason;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004791
4792 /**
4793 * struct dfs_event - Data for radar detected events
4794 * @freq: Frequency of the channel in MHz
4795 */
4796 struct dfs_event {
4797 int freq;
Dmitry Shmidt051af732013-10-22 13:52:46 -07004798 int ht_enabled;
4799 int chan_offset;
4800 enum chan_width chan_width;
4801 int cf1;
4802 int cf2;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004803 } dfs_event;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004804
4805 /**
4806 * survey_results - Survey result data for EVENT_SURVEY
4807 * @freq_filter: Requested frequency survey filter, 0 if request
4808 * was for all survey data
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004809 * @survey_list: Linked list of survey data (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004810 */
4811 struct survey_results {
4812 unsigned int freq_filter;
4813 struct dl_list survey_list; /* struct freq_survey */
4814 } survey_results;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08004815
4816 /**
4817 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4818 * @initiator: Initiator of the regulatory change
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07004819 * @type: Regulatory change type
4820 * @alpha2: Country code (or "" if not available)
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08004821 */
4822 struct channel_list_changed {
4823 enum reg_change_initiator initiator;
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07004824 enum reg_type type;
4825 char alpha2[3];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08004826 } channel_list_changed;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08004827
4828 /**
4829 * freq_range - List of frequency ranges
4830 *
4831 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4832 */
4833 struct wpa_freq_range_list freq_range;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004834
4835 /**
4836 * struct mesh_peer
4837 *
4838 * @peer: Peer address
4839 * @ies: Beacon IEs
4840 * @ie_len: Length of @ies
4841 *
4842 * Notification of new candidate mesh peer.
4843 */
4844 struct mesh_peer {
4845 const u8 *peer;
4846 const u8 *ies;
4847 size_t ie_len;
4848 } mesh_peer;
4849
4850 /**
4851 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4852 * @pri_channel: Selected primary channel
4853 * @sec_channel: Selected secondary channel
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07004854 * @vht_seg0_center_ch: VHT mode Segment0 center channel
4855 * @vht_seg1_center_ch: VHT mode Segment1 center channel
4856 * @ch_width: Selected Channel width by driver. Driver may choose to
4857 * change hostapd configured ACS channel width due driver internal
4858 * channel restrictions.
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07004859 * hw_mode: Selected band (used with hw_mode=any)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004860 */
4861 struct acs_selected_channels {
4862 u8 pri_channel;
4863 u8 sec_channel;
Dmitry Shmidtdda10c22015-03-24 16:05:01 -07004864 u8 vht_seg0_center_ch;
4865 u8 vht_seg1_center_ch;
4866 u16 ch_width;
Dmitry Shmidtb1e52102015-05-29 12:36:29 -07004867 enum hostapd_hw_mode hw_mode;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004868 } acs_selected_channels;
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004869
4870 /**
4871 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
4872 * @reason_code: Reason for stopping offload
4873 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
4874 * scheduled.
4875 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
4876 * be stopped.
4877 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
4878 * parameters.
4879 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
4880 * supported by device.
4881 */
4882 struct p2p_lo_stop {
4883 enum {
4884 P2P_LO_STOPPED_REASON_COMPLETE = 0,
4885 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
4886 P2P_LO_STOPPED_REASON_INVALID_PARAM,
4887 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
4888 } reason_code;
4889 } p2p_lo_stop;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004890};
4891
4892/**
4893 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4894 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4895 * with struct wpa_driver_ops::init()
4896 * @event: event type (defined above)
4897 * @data: possible extra data for the event
4898 *
4899 * Driver wrapper code should call this function whenever an event is received
4900 * from the driver.
4901 */
4902void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4903 union wpa_event_data *data);
4904
Dmitry Shmidte4663042016-04-04 10:07:49 -07004905/**
4906 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
4907 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4908 * with struct wpa_driver_ops::init()
4909 * @event: event type (defined above)
4910 * @data: possible extra data for the event
4911 *
4912 * Same as wpa_supplicant_event(), but we search for the interface in
4913 * wpa_global.
4914 */
4915void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
4916 union wpa_event_data *data);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004917
4918/*
4919 * The following inline functions are provided for convenience to simplify
4920 * event indication for some of the common events.
4921 */
4922
4923static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4924 size_t ielen, int reassoc)
4925{
4926 union wpa_event_data event;
4927 os_memset(&event, 0, sizeof(event));
4928 event.assoc_info.reassoc = reassoc;
4929 event.assoc_info.req_ies = ie;
4930 event.assoc_info.req_ies_len = ielen;
4931 event.assoc_info.addr = addr;
4932 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4933}
4934
4935static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4936{
4937 union wpa_event_data event;
4938 os_memset(&event, 0, sizeof(event));
4939 event.disassoc_info.addr = addr;
4940 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4941}
4942
4943static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4944 size_t data_len)
4945{
4946 union wpa_event_data event;
4947 os_memset(&event, 0, sizeof(event));
4948 event.eapol_rx.src = src;
4949 event.eapol_rx.data = data;
4950 event.eapol_rx.data_len = data_len;
4951 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4952}
4953
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004954/* driver_common.c */
4955void wpa_scan_results_free(struct wpa_scan_results *res);
4956
4957/* Convert wpa_event_type to a string for logging */
4958const char * event_to_string(enum wpa_event_type event);
4959
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07004960/* Convert chan_width to a string for logging and control interfaces */
4961const char * channel_width_to_string(enum chan_width width);
4962
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004963int ht_supported(const struct hostapd_hw_modes *mode);
4964int vht_supported(const struct hostapd_hw_modes *mode);
4965
4966struct wowlan_triggers *
4967wpa_get_wowlan_triggers(const char *wowlan_triggers,
4968 const struct wpa_driver_capa *capa);
Dmitry Shmidt58d12ad2016-07-28 10:07:03 -07004969/* Convert driver flag to string */
4970const char * driver_flag_to_string(u64 flag);
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004971
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08004972/* NULL terminated array of linked in driver wrappers */
Dmitry Shmidt1d755d02015-04-28 10:34:29 -07004973extern const struct wpa_driver_ops *const wpa_drivers[];
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08004974
Dmitry Shmidt4ae50e62016-06-27 13:48:39 -07004975
4976/* Available drivers */
4977
4978#ifdef CONFIG_DRIVER_WEXT
4979extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
4980#endif /* CONFIG_DRIVER_WEXT */
4981#ifdef CONFIG_DRIVER_NL80211
4982/* driver_nl80211.c */
4983extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
4984#endif /* CONFIG_DRIVER_NL80211 */
4985#ifdef CONFIG_DRIVER_HOSTAP
4986extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
4987#endif /* CONFIG_DRIVER_HOSTAP */
4988#ifdef CONFIG_DRIVER_BSD
4989extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
4990#endif /* CONFIG_DRIVER_BSD */
4991#ifdef CONFIG_DRIVER_OPENBSD
4992/* driver_openbsd.c */
4993extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
4994#endif /* CONFIG_DRIVER_OPENBSD */
4995#ifdef CONFIG_DRIVER_NDIS
4996extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
4997#endif /* CONFIG_DRIVER_NDIS */
4998#ifdef CONFIG_DRIVER_WIRED
4999extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
5000#endif /* CONFIG_DRIVER_WIRED */
5001#ifdef CONFIG_DRIVER_MACSEC_QCA
5002/* driver_macsec_qca.c */
5003extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
5004#endif /* CONFIG_DRIVER_MACSEC_QCA */
5005#ifdef CONFIG_DRIVER_ROBOSWITCH
5006/* driver_roboswitch.c */
5007extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
5008#endif /* CONFIG_DRIVER_ROBOSWITCH */
5009#ifdef CONFIG_DRIVER_ATHEROS
5010/* driver_atheros.c */
5011extern const struct wpa_driver_ops wpa_driver_atheros_ops;
5012#endif /* CONFIG_DRIVER_ATHEROS */
5013#ifdef CONFIG_DRIVER_NONE
5014extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
5015#endif /* CONFIG_DRIVER_NONE */
5016
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07005017#endif /* DRIVER_H */