blob: 2c0c68505a18f5ea83fedaa2182ab7b7fb40ea32 [file] [log] [blame]
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001/*
2 * Driver interface definition
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08003 * Copyright (c) 2003-2014, 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 Shmidtb7b4d0e2013-08-26 12:09:05 -070023#include "utils/list.h"
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070024
25#define HOSTAPD_CHAN_DISABLED 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080026#define HOSTAPD_CHAN_NO_IR 0x00000002
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070027#define HOSTAPD_CHAN_RADAR 0x00000008
28#define HOSTAPD_CHAN_HT40PLUS 0x00000010
29#define HOSTAPD_CHAN_HT40MINUS 0x00000020
30#define HOSTAPD_CHAN_HT40 0x00000040
Dmitry Shmidt391c59f2013-09-03 12:16:28 -070031#define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070032
Dmitry Shmidtea69e842013-05-13 14:52:28 -070033#define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
34#define HOSTAPD_CHAN_DFS_USABLE 0x00000100
35#define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
36#define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
37#define HOSTAPD_CHAN_DFS_MASK 0x00000300
38
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -070039#define HOSTAPD_CHAN_VHT_10_70 0x00000800
40#define HOSTAPD_CHAN_VHT_30_50 0x00001000
41#define HOSTAPD_CHAN_VHT_50_30 0x00002000
42#define HOSTAPD_CHAN_VHT_70_10 0x00004000
43
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080044#define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
45#define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
46
47/**
48 * enum reg_change_initiator - Regulatory change initiator
49 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -080050enum reg_change_initiator {
51 REGDOM_SET_BY_CORE,
52 REGDOM_SET_BY_USER,
53 REGDOM_SET_BY_DRIVER,
54 REGDOM_SET_BY_COUNTRY_IE,
Dmitry Shmidt97672262014-02-03 13:02:54 -080055 REGDOM_BEACON_HINT,
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -080056};
57
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080058/**
59 * enum reg_type - Regulatory change types
60 */
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -070061enum reg_type {
62 REGDOM_TYPE_UNKNOWN,
63 REGDOM_TYPE_COUNTRY,
64 REGDOM_TYPE_WORLD,
65 REGDOM_TYPE_CUSTOM_WORLD,
66 REGDOM_TYPE_INTERSECTION,
67};
68
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070069/**
70 * struct hostapd_channel_data - Channel information
71 */
72struct hostapd_channel_data {
73 /**
74 * chan - Channel number (IEEE 802.11)
75 */
76 short chan;
77
78 /**
79 * freq - Frequency in MHz
80 */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -080081 int freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070082
83 /**
84 * flag - Channel flags (HOSTAPD_CHAN_*)
85 */
86 int flag;
87
88 /**
Dmitry Shmidt68d0e3e2013-10-28 17:59:21 -070089 * max_tx_power - Regulatory transmit power limit in dBm
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -070090 */
91 u8 max_tx_power;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -070092
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -080093 /**
94 * survey_list - Linked list of surveys (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -070095 */
96 struct dl_list survey_list;
97
98 /**
99 * min_nf - Minimum observed noise floor, in dBm, based on all
100 * surveyed channel data
101 */
102 s8 min_nf;
Dmitry Shmidt391c59f2013-09-03 12:16:28 -0700103
104#ifdef CONFIG_ACS
105 /**
106 * interference_factor - Computed interference factor on this
107 * channel (used internally in src/ap/acs.c; driver wrappers do not
108 * need to set this)
109 */
110 long double interference_factor;
111#endif /* CONFIG_ACS */
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -0700112
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800113 /**
114 * dfs_cac_ms - DFS CAC time in milliseconds
115 */
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -0700116 unsigned int dfs_cac_ms;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700117};
118
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800119#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -0700120#define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800121
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700122/**
123 * struct hostapd_hw_modes - Supported hardware mode information
124 */
125struct hostapd_hw_modes {
126 /**
127 * mode - Hardware mode
128 */
129 enum hostapd_hw_mode mode;
130
131 /**
132 * num_channels - Number of entries in the channels array
133 */
134 int num_channels;
135
136 /**
137 * channels - Array of supported channels
138 */
139 struct hostapd_channel_data *channels;
140
141 /**
142 * num_rates - Number of entries in the rates array
143 */
144 int num_rates;
145
146 /**
147 * rates - Array of supported rates in 100 kbps units
148 */
149 int *rates;
150
151 /**
152 * ht_capab - HT (IEEE 802.11n) capabilities
153 */
154 u16 ht_capab;
155
156 /**
157 * mcs_set - MCS (IEEE 802.11n) rate parameters
158 */
159 u8 mcs_set[16];
160
161 /**
162 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
163 */
164 u8 a_mpdu_params;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800165
Dmitry Shmidt04949592012-07-19 12:16:46 -0700166 /**
167 * vht_capab - VHT (IEEE 802.11ac) capabilities
168 */
169 u32 vht_capab;
170
171 /**
172 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
173 */
174 u8 vht_mcs_set[8];
175
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800176 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700177};
178
179
180#define IEEE80211_MODE_INFRA 0
181#define IEEE80211_MODE_IBSS 1
182#define IEEE80211_MODE_AP 2
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800183#define IEEE80211_MODE_MESH 5
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700184
185#define IEEE80211_CAP_ESS 0x0001
186#define IEEE80211_CAP_IBSS 0x0002
187#define IEEE80211_CAP_PRIVACY 0x0010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800188#define IEEE80211_CAP_RRM 0x1000
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700189
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800190/* DMG (60 GHz) IEEE 802.11ad */
191/* type - bits 0..1 */
192#define IEEE80211_CAP_DMG_MASK 0x0003
193#define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
194#define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
195#define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
196
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700197#define WPA_SCAN_QUAL_INVALID BIT(0)
198#define WPA_SCAN_NOISE_INVALID BIT(1)
199#define WPA_SCAN_LEVEL_INVALID BIT(2)
200#define WPA_SCAN_LEVEL_DBM BIT(3)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700201#define WPA_SCAN_ASSOCIATED BIT(5)
202
203/**
204 * struct wpa_scan_res - Scan result for an BSS/IBSS
205 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
206 * @bssid: BSSID
207 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
208 * @beacon_int: beacon interval in TUs (host byte order)
209 * @caps: capability information field in host byte order
210 * @qual: signal quality
211 * @noise: noise level
212 * @level: signal level
213 * @tsf: Timestamp
214 * @age: Age of the information in milliseconds (i.e., how many milliseconds
215 * ago the last Beacon or Probe Response frame was received)
216 * @ie_len: length of the following IE field in octets
217 * @beacon_ie_len: length of the following Beacon IE field in octets
218 *
219 * This structure is used as a generic format for scan results from the
220 * driver. Each driver interface implementation is responsible for converting
221 * the driver or OS specific scan results into this format.
222 *
223 * If the driver does not support reporting all IEs, the IE data structure is
224 * constructed of the IEs that are available. This field will also need to
225 * include SSID in IE format. All drivers are encouraged to be extended to
226 * report all IEs to make it easier to support future additions.
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800227 *
228 * This structure data is followed by ie_len octets of IEs from Probe Response
229 * frame (or if the driver does not indicate source of IEs, these may also be
230 * from Beacon frame). After the first set of IEs, another set of IEs may follow
231 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700232 */
233struct wpa_scan_res {
234 unsigned int flags;
235 u8 bssid[ETH_ALEN];
236 int freq;
237 u16 beacon_int;
238 u16 caps;
239 int qual;
240 int noise;
241 int level;
242 u64 tsf;
243 unsigned int age;
244 size_t ie_len;
245 size_t beacon_ie_len;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800246 /* Followed by ie_len + beacon_ie_len octets of IE data */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700247};
248
249/**
250 * struct wpa_scan_results - Scan results
251 * @res: Array of pointers to allocated variable length scan result entries
252 * @num: Number of entries in the scan result array
Dmitry Shmidtf8623282013-02-20 14:34:59 -0800253 * @fetch_time: Time when the results were fetched from the driver
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700254 */
255struct wpa_scan_results {
256 struct wpa_scan_res **res;
257 size_t num;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800258 struct os_reltime fetch_time;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700259};
260
261/**
262 * struct wpa_interface_info - Network interface information
263 * @next: Pointer to the next interface or NULL if this is the last one
264 * @ifname: Interface name that can be used with init() or init2()
265 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
266 * not available
267 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
268 * is not an allocated copy, i.e., get_interfaces() caller will not free
269 * this)
270 */
271struct wpa_interface_info {
272 struct wpa_interface_info *next;
273 char *ifname;
274 char *desc;
275 const char *drv_name;
276};
277
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800278#define WPAS_MAX_SCAN_SSIDS 16
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700279
280/**
281 * struct wpa_driver_scan_params - Scan parameters
282 * Data for struct wpa_driver_ops::scan2().
283 */
284struct wpa_driver_scan_params {
285 /**
286 * ssids - SSIDs to scan for
287 */
288 struct wpa_driver_scan_ssid {
289 /**
290 * ssid - specific SSID to scan for (ProbeReq)
291 * %NULL or zero-length SSID is used to indicate active scan
292 * with wildcard SSID.
293 */
294 const u8 *ssid;
295 /**
296 * ssid_len: Length of the SSID in octets
297 */
298 size_t ssid_len;
299 } ssids[WPAS_MAX_SCAN_SSIDS];
300
301 /**
302 * num_ssids - Number of entries in ssids array
303 * Zero indicates a request for a passive scan.
304 */
305 size_t num_ssids;
306
307 /**
308 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
309 */
310 const u8 *extra_ies;
311
312 /**
313 * extra_ies_len - Length of extra_ies in octets
314 */
315 size_t extra_ies_len;
316
317 /**
318 * freqs - Array of frequencies to scan or %NULL for all frequencies
319 *
320 * The frequency is set in MHz. The array is zero-terminated.
321 */
322 int *freqs;
323
324 /**
325 * filter_ssids - Filter for reporting SSIDs
326 *
327 * This optional parameter can be used to request the driver wrapper to
328 * filter scan results to include only the specified SSIDs. %NULL
329 * indicates that no filtering is to be done. This can be used to
330 * reduce memory needs for scan results in environments that have large
331 * number of APs with different SSIDs.
332 *
333 * The driver wrapper is allowed to take this allocated buffer into its
334 * own use by setting the pointer to %NULL. In that case, the driver
335 * wrapper is responsible for freeing the buffer with os_free() once it
336 * is not needed anymore.
337 */
338 struct wpa_driver_scan_filter {
339 u8 ssid[32];
340 size_t ssid_len;
341 } *filter_ssids;
342
343 /**
344 * num_filter_ssids - Number of entries in filter_ssids array
345 */
346 size_t num_filter_ssids;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800347
348 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -0700349 * filter_rssi - Filter by RSSI
350 *
351 * The driver may filter scan results in firmware to reduce host
352 * wakeups and thereby save power. Specify the RSSI threshold in s32
353 * dBm.
354 */
355 s32 filter_rssi;
356
357 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800358 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
359 *
360 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
361 * Mbps from the support rates element(s) in the Probe Request frames
362 * and not to transmit the frames at any of those rates.
363 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700364 unsigned int p2p_probe:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800365
366 /**
367 * only_new_results - Request driver to report only new results
368 *
369 * This is used to request the driver to report only BSSes that have
370 * been detected after this scan request has been started, i.e., to
371 * flush old cached BSS entries.
372 */
Dmitry Shmidt2271d3f2014-06-23 12:16:31 -0700373 unsigned int only_new_results:1;
374
375 /**
376 * low_priority - Requests driver to use a lower scan priority
377 *
378 * This is used to request the driver to use a lower scan priority
379 * if it supports such a thing.
380 */
381 unsigned int low_priority:1;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800382
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800383 /**
384 * mac_addr_rand - Requests driver to randomize MAC address
385 */
386 unsigned int mac_addr_rand:1;
387
388 /**
389 * mac_addr - MAC address used with randomization. The address cannot be
390 * a multicast one, i.e., bit 0 of byte 0 should not be set.
391 */
392 const u8 *mac_addr;
393
394 /**
395 * mac_addr_mask - MAC address mask used with randomization.
396 *
397 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
398 * the mask should be taken as is from mac_addr. The mask should not
399 * allow the generation of a multicast address, i.e., bit 0 of byte 0
400 * must be set.
401 */
402 const u8 *mac_addr_mask;
403
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800404 /*
405 * NOTE: Whenever adding new parameters here, please make sure
406 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
407 * matching changes.
408 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700409};
410
411/**
412 * struct wpa_driver_auth_params - Authentication parameters
413 * Data for struct wpa_driver_ops::authenticate().
414 */
415struct wpa_driver_auth_params {
416 int freq;
417 const u8 *bssid;
418 const u8 *ssid;
419 size_t ssid_len;
420 int auth_alg;
421 const u8 *ie;
422 size_t ie_len;
423 const u8 *wep_key[4];
424 size_t wep_key_len[4];
425 int wep_tx_keyidx;
426 int local_state_change;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800427
428 /**
429 * p2p - Whether this connection is a P2P group
430 */
431 int p2p;
432
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800433 /**
434 * sae_data - SAE elements for Authentication frame
435 *
436 * This buffer starts with the Authentication transaction sequence
437 * number field. If SAE is not used, this pointer is %NULL.
438 */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800439 const u8 *sae_data;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800440
441 /**
442 * sae_data_len - Length of sae_data buffer in octets
443 */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -0800444 size_t sae_data_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700445};
446
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800447/**
448 * enum wps_mode - WPS mode
449 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700450enum wps_mode {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800451 /**
452 * WPS_MODE_NONE - No WPS provisioning being used
453 */
454 WPS_MODE_NONE,
455
456 /**
457 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
458 */
459 WPS_MODE_OPEN,
460
461 /**
462 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
463 */
464 WPS_MODE_PRIVACY
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700465};
466
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800467/**
468 * struct hostapd_freq_params - Channel parameters
469 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700470struct hostapd_freq_params {
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800471 /**
472 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
473 */
474 enum hostapd_hw_mode mode;
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700475
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800476 /**
477 * freq - Primary channel center frequency in MHz
478 */
479 int freq;
480
481 /**
482 * channel - Channel number
483 */
484 int channel;
485
486 /**
487 * ht_enabled - Whether HT is enabled
488 */
489 int ht_enabled;
490
491 /**
492 * sec_channel_offset - Secondary channel offset for HT40
493 *
494 * 0 = HT40 disabled,
495 * -1 = HT40 enabled, secondary channel below primary,
496 * 1 = HT40 enabled, secondary channel above primary
497 */
498 int sec_channel_offset;
499
500 /**
501 * vht_enabled - Whether VHT is enabled
502 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700503 int vht_enabled;
504
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800505 /**
506 * center_freq1 - Segment 0 center frequency in MHz
507 *
508 * Valid for both HT and VHT.
509 */
510 int center_freq1;
511
512 /**
513 * center_freq2 - Segment 1 center frequency in MHz
514 *
515 * Non-zero only for bandwidth 80 and an 80+80 channel
516 */
517 int center_freq2;
518
519 /**
520 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
521 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700522 int bandwidth;
523};
524
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700525/**
526 * struct wpa_driver_associate_params - Association parameters
527 * Data for struct wpa_driver_ops::associate().
528 */
529struct wpa_driver_associate_params {
530 /**
531 * bssid - BSSID of the selected AP
532 * This can be %NULL, if ap_scan=2 mode is used and the driver is
533 * responsible for selecting with which BSS to associate. */
534 const u8 *bssid;
535
536 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800537 * bssid_hint - BSSID of a proposed AP
538 *
539 * This indicates which BSS has been found a suitable candidate for
540 * initial association for drivers that use driver/firmwate-based BSS
541 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
542 * the driver from selecting other BSSes in the ESS.
543 */
544 const u8 *bssid_hint;
545
546 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700547 * ssid - The selected SSID
548 */
549 const u8 *ssid;
550
551 /**
552 * ssid_len - Length of the SSID (1..32)
553 */
554 size_t ssid_len;
555
556 /**
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700557 * freq - channel parameters
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700558 */
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -0700559 struct hostapd_freq_params freq;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700560
561 /**
Dmitry Shmidt96be6222014-02-13 10:16:51 -0800562 * freq_hint - Frequency of the channel the proposed AP is using
563 *
564 * This provides a channel on which a suitable BSS has been found as a
565 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
566 * limit the driver from selecting other channels for
567 * driver/firmware-based BSS selection.
568 */
569 int freq_hint;
570
571 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -0700572 * bg_scan_period - Background scan period in seconds, 0 to disable
573 * background scan, or -1 to indicate no change to default driver
574 * configuration
575 */
576 int bg_scan_period;
577
578 /**
Dmitry Shmidt2ac5f602014-03-07 10:08:21 -0800579 * beacon_int - Beacon interval for IBSS or 0 to use driver default
580 */
581 int beacon_int;
582
583 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700584 * wpa_ie - WPA information element for (Re)Association Request
585 * WPA information element to be included in (Re)Association
586 * Request (including information element id and length). Use
587 * of this WPA IE is optional. If the driver generates the WPA
588 * IE, it can use pairwise_suite, group_suite, and
589 * key_mgmt_suite to select proper algorithms. In this case,
590 * the driver has to notify wpa_supplicant about the used WPA
591 * IE by generating an event that the interface code will
592 * convert into EVENT_ASSOCINFO data (see below).
593 *
594 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
595 * instead. The driver can determine which version is used by
596 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
597 * WPA2/RSN).
598 *
599 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
600 */
601 const u8 *wpa_ie;
602
603 /**
604 * wpa_ie_len - length of the wpa_ie
605 */
606 size_t wpa_ie_len;
607
608 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800609 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
610 */
611 unsigned int wpa_proto;
612
613 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800614 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700615 *
616 * This is usually ignored if @wpa_ie is used.
617 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800618 unsigned int pairwise_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700619
620 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800621 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700622 *
623 * This is usually ignored if @wpa_ie is used.
624 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800625 unsigned int group_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700626
627 /**
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800628 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700629 *
630 * This is usually ignored if @wpa_ie is used.
631 */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -0800632 unsigned int key_mgmt_suite;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700633
634 /**
635 * auth_alg - Allowed authentication algorithms
636 * Bit field of WPA_AUTH_ALG_*
637 */
638 int auth_alg;
639
640 /**
641 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
642 */
643 int mode;
644
645 /**
646 * wep_key - WEP keys for static WEP configuration
647 */
648 const u8 *wep_key[4];
649
650 /**
651 * wep_key_len - WEP key length for static WEP configuration
652 */
653 size_t wep_key_len[4];
654
655 /**
656 * wep_tx_keyidx - WEP TX key index for static WEP configuration
657 */
658 int wep_tx_keyidx;
659
660 /**
661 * mgmt_frame_protection - IEEE 802.11w management frame protection
662 */
663 enum mfp_options mgmt_frame_protection;
664
665 /**
666 * ft_ies - IEEE 802.11r / FT information elements
667 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
668 * for fast transition, this parameter is set to include the IEs that
669 * are to be sent in the next FT Authentication Request message.
670 * update_ft_ies() handler is called to update the IEs for further
671 * FT messages in the sequence.
672 *
673 * The driver should use these IEs only if the target AP is advertising
674 * the same mobility domain as the one included in the MDIE here.
675 *
676 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
677 * AP after the initial association. These IEs can only be used if the
678 * target AP is advertising support for FT and is using the same MDIE
679 * and SSID as the current AP.
680 *
681 * The driver is responsible for reporting the FT IEs received from the
682 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
683 * type. update_ft_ies() handler will then be called with the FT IEs to
684 * include in the next frame in the authentication sequence.
685 */
686 const u8 *ft_ies;
687
688 /**
689 * ft_ies_len - Length of ft_ies in bytes
690 */
691 size_t ft_ies_len;
692
693 /**
694 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
695 *
696 * This value is provided to allow the driver interface easier access
697 * to the current mobility domain. This value is set to %NULL if no
698 * mobility domain is currently active.
699 */
700 const u8 *ft_md;
701
702 /**
703 * passphrase - RSN passphrase for PSK
704 *
705 * This value is made available only for WPA/WPA2-Personal (PSK) and
706 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
707 * the 8..63 character ASCII passphrase, if available. Please note that
708 * this can be %NULL if passphrase was not used to generate the PSK. In
709 * that case, the psk field must be used to fetch the PSK.
710 */
711 const char *passphrase;
712
713 /**
714 * psk - RSN PSK (alternative for passphrase for PSK)
715 *
716 * This value is made available only for WPA/WPA2-Personal (PSK) and
717 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
718 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
719 * be prepared to handle %NULL value as an error.
720 */
721 const u8 *psk;
722
723 /**
724 * drop_unencrypted - Enable/disable unencrypted frame filtering
725 *
726 * Configure the driver to drop all non-EAPOL frames (both receive and
727 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
728 * still be allowed for key negotiation.
729 */
730 int drop_unencrypted;
731
732 /**
733 * prev_bssid - Previously used BSSID in this ESS
734 *
735 * When not %NULL, this is a request to use reassociation instead of
736 * association.
737 */
738 const u8 *prev_bssid;
739
740 /**
741 * wps - WPS mode
742 *
743 * If the driver needs to do special configuration for WPS association,
744 * this variable provides more information on what type of association
745 * is being requested. Most drivers should not need ot use this.
746 */
747 enum wps_mode wps;
748
749 /**
750 * p2p - Whether this connection is a P2P group
751 */
752 int p2p;
753
754 /**
755 * uapsd - UAPSD parameters for the network
756 * -1 = do not change defaults
757 * AP mode: 1 = enabled, 0 = disabled
758 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
759 */
760 int uapsd;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800761
762 /**
763 * fixed_bssid - Whether to force this BSSID in IBSS mode
764 * 1 = Fix this BSSID and prevent merges.
765 * 0 = Do not fix BSSID.
766 */
767 int fixed_bssid;
768
769 /**
770 * disable_ht - Disable HT (IEEE 802.11n) for this connection
771 */
772 int disable_ht;
773
774 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800775 * htcaps - HT Capabilities over-rides
776 *
777 * Only bits set in the mask will be used, and not all values are used
778 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
779 *
780 * Pointer to struct ieee80211_ht_capabilities.
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -0800781 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800782 const u8 *htcaps;
783
784 /**
785 * htcaps_mask - HT Capabilities over-rides mask
786 *
787 * Pointer to struct ieee80211_ht_capabilities.
788 */
789 const u8 *htcaps_mask;
Dmitry Shmidt2f023192013-03-12 12:44:17 -0700790
791#ifdef CONFIG_VHT_OVERRIDES
792 /**
793 * disable_vht - Disable VHT for this connection
794 */
795 int disable_vht;
796
797 /**
798 * VHT capability overrides.
799 */
800 const struct ieee80211_vht_capabilities *vhtcaps;
801 const struct ieee80211_vht_capabilities *vhtcaps_mask;
802#endif /* CONFIG_VHT_OVERRIDES */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -0800803
804 /**
805 * req_key_mgmt_offload - Request key management offload for connection
806 *
807 * Request key management offload for this connection if the device
808 * supports it.
809 */
810 int req_key_mgmt_offload;
811
812 /**
813 * Flag for indicating whether this association includes support for
814 * RRM (Radio Resource Measurements)
815 */
816 int rrm_used;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -0700817};
818
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800819enum hide_ssid {
820 NO_SSID_HIDING,
821 HIDDEN_SSID_ZERO_LEN,
822 HIDDEN_SSID_ZERO_CONTENTS
823};
824
Dmitry Shmidtb58836e2014-04-29 14:35:56 -0700825struct wowlan_triggers {
826 u8 any;
827 u8 disconnect;
828 u8 magic_pkt;
829 u8 gtk_rekey_failure;
830 u8 eap_identity_req;
831 u8 four_way_handshake;
832 u8 rfkill_release;
833};
834
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800835struct wpa_driver_ap_params {
836 /**
837 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
838 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -0800839 u8 *head;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800840
841 /**
842 * head_len - Length of the head buffer in octets
843 */
844 size_t head_len;
845
846 /**
847 * tail - Beacon tail following TIM IE
848 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -0800849 u8 *tail;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800850
851 /**
852 * tail_len - Length of the tail buffer in octets
853 */
854 size_t tail_len;
855
856 /**
857 * dtim_period - DTIM period
858 */
859 int dtim_period;
860
861 /**
862 * beacon_int - Beacon interval
863 */
864 int beacon_int;
865
866 /**
867 * basic_rates: -1 terminated array of basic rates in 100 kbps
868 *
869 * This parameter can be used to set a specific basic rate set for the
870 * BSS. If %NULL, default basic rate set is used.
871 */
872 int *basic_rates;
873
874 /**
875 * proberesp - Probe Response template
876 *
877 * This is used by drivers that reply to Probe Requests internally in
878 * AP mode and require the full Probe Response template.
879 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -0800880 u8 *proberesp;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -0800881
882 /**
883 * proberesp_len - Length of the proberesp buffer in octets
884 */
885 size_t proberesp_len;
886
887 /**
888 * ssid - The SSID to use in Beacon/Probe Response frames
889 */
890 const u8 *ssid;
891
892 /**
893 * ssid_len - Length of the SSID (1..32)
894 */
895 size_t ssid_len;
896
897 /**
898 * hide_ssid - Whether to hide the SSID
899 */
900 enum hide_ssid hide_ssid;
901
902 /**
903 * pairwise_ciphers - WPA_CIPHER_* bitfield
904 */
905 unsigned int pairwise_ciphers;
906
907 /**
908 * group_cipher - WPA_CIPHER_*
909 */
910 unsigned int group_cipher;
911
912 /**
913 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
914 */
915 unsigned int key_mgmt_suites;
916
917 /**
918 * auth_algs - WPA_AUTH_ALG_* bitfield
919 */
920 unsigned int auth_algs;
921
922 /**
923 * wpa_version - WPA_PROTO_* bitfield
924 */
925 unsigned int wpa_version;
926
927 /**
928 * privacy - Whether privacy is used in the BSS
929 */
930 int privacy;
931
932 /**
933 * beacon_ies - WPS/P2P IE(s) for Beacon frames
934 *
935 * This is used to add IEs like WPS IE and P2P IE by drivers that do
936 * not use the full Beacon template.
937 */
938 const struct wpabuf *beacon_ies;
939
940 /**
941 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
942 *
943 * This is used to add IEs like WPS IE and P2P IE by drivers that
944 * reply to Probe Request frames internally.
945 */
946 const struct wpabuf *proberesp_ies;
947
948 /**
949 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
950 *
951 * This is used to add IEs like WPS IE by drivers that reply to
952 * (Re)Association Request frames internally.
953 */
954 const struct wpabuf *assocresp_ies;
955
956 /**
957 * isolate - Whether to isolate frames between associated stations
958 *
959 * If this is non-zero, the AP is requested to disable forwarding of
960 * frames between associated stations.
961 */
962 int isolate;
963
964 /**
965 * cts_protect - Whether CTS protection is enabled
966 */
967 int cts_protect;
968
969 /**
970 * preamble - Whether short preamble is enabled
971 */
972 int preamble;
973
974 /**
975 * short_slot_time - Whether short slot time is enabled
976 *
977 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
978 * not set (e.g., when 802.11g mode is not in use)
979 */
980 int short_slot_time;
981
982 /**
983 * ht_opmode - HT operation mode or -1 if HT not in use
984 */
985 int ht_opmode;
986
987 /**
988 * interworking - Whether Interworking is enabled
989 */
990 int interworking;
991
992 /**
993 * hessid - Homogeneous ESS identifier or %NULL if not set
994 */
995 const u8 *hessid;
996
997 /**
998 * access_network_type - Access Network Type (0..15)
999 *
1000 * This is used for filtering Probe Request frames when Interworking is
1001 * enabled.
1002 */
1003 u8 access_network_type;
Dmitry Shmidt04949592012-07-19 12:16:46 -07001004
1005 /**
1006 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1007 *
1008 * This is used by driver which advertises this capability.
1009 */
1010 int ap_max_inactivity;
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001011
1012 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001013 * smps_mode - SMPS mode
1014 *
1015 * SMPS mode to be used by the AP, specified as the relevant bits of
1016 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1017 */
1018 unsigned int smps_mode;
1019
1020 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001021 * disable_dgaf - Whether group-addressed frames are disabled
1022 */
1023 int disable_dgaf;
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001024
1025 /**
1026 * osen - Whether OSEN security is enabled
1027 */
1028 int osen;
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001029
1030 /**
1031 * freq - Channel parameters for dynamic bandwidth changes
1032 */
1033 struct hostapd_freq_params *freq;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001034};
1035
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001036struct wpa_driver_mesh_bss_params {
1037#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1038 /*
1039 * TODO: Other mesh configuration parameters would go here.
1040 * See NL80211_MESHCONF_* for all the mesh config parameters.
1041 */
1042 unsigned int flags;
1043};
1044
1045struct wpa_driver_mesh_join_params {
1046 const u8 *meshid;
1047 int meshid_len;
1048 const int *basic_rates;
1049 const u8 *ies;
1050 int ie_len;
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001051 struct hostapd_freq_params freq;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001052 int beacon_int;
1053 int max_peer_links;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001054 struct wpa_driver_mesh_bss_params conf;
1055#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1056#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1057#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1058#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1059 unsigned int flags;
1060};
1061
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001062/**
1063 * struct wpa_driver_capa - Driver capability information
1064 */
1065struct wpa_driver_capa {
1066#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1067#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1068#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1069#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1070#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1071#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1072#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001073#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001074 /** Bitfield of supported key management suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001075 unsigned int key_mgmt;
1076
1077#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1078#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1079#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1080#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
Dmitry Shmidt04949592012-07-19 12:16:46 -07001081#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001082#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001083#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1084#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1085#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1086#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1087#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1088#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
Dmitry Shmidtf21452a2014-02-26 10:55:25 -08001089#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001090 /** Bitfield of supported cipher suites */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001091 unsigned int enc;
1092
1093#define WPA_DRIVER_AUTH_OPEN 0x00000001
1094#define WPA_DRIVER_AUTH_SHARED 0x00000002
1095#define WPA_DRIVER_AUTH_LEAP 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001096 /** Bitfield of supported IEEE 802.11 authentication algorithms */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001097 unsigned int auth;
1098
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001099/** Driver generated WPA/RSN IE */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001100#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001101/** Driver needs static WEP key setup after association command */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001102#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001103/** Driver takes care of all DFS operations */
Dmitry Shmidtd11f0192014-03-24 12:09:47 -07001104#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001105/** Driver takes care of RSN 4-way handshake internally; PMK is configured with
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001106 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
1107#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001108/** Driver is for a wired Ethernet interface */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001109#define WPA_DRIVER_FLAGS_WIRED 0x00000010
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001110/** Driver provides separate commands for authentication and association (SME in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001111 * wpa_supplicant). */
1112#define WPA_DRIVER_FLAGS_SME 0x00000020
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001113/** Driver supports AP mode */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001114#define WPA_DRIVER_FLAGS_AP 0x00000040
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001115/** Driver needs static WEP key setup after association has been completed */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001116#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001117/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07001118#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001119/** Driver supports concurrent P2P operations */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001120#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001121/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001122 * Driver uses the initial interface as a dedicated management interface, i.e.,
1123 * it cannot be used for P2P group operations or non-P2P purposes.
1124 */
1125#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001126/** This interface is P2P capable (P2P GO or P2P Client) */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001127#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001128/** Driver supports station and key removal when stopping an AP */
Dmitry Shmidta38abf92014-03-06 13:38:44 -08001129#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001130/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001131 * Driver uses the initial interface for P2P management interface and non-P2P
1132 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1133 * P2P group operations.
1134 */
1135#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001136/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001137 * Driver is known to use sane error codes, i.e., when it indicates that
1138 * something (e.g., association) fails, there was indeed a failure and the
1139 * operation does not end up getting completed successfully later.
1140 */
1141#define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001142/** Driver supports off-channel TX */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001143#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001144/** Driver indicates TX status events for EAPOL Data frames */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001145#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001146/** Driver indicates TX status events for Deauth/Disassoc frames */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001147#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001148/** Driver supports roaming (BSS selection) in firmware */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001149#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001150/** Driver supports operating as a TDLS peer */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001151#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001152/** Driver requires external TDLS setup/teardown/discovery */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001153#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001154/** Driver indicates support for Probe Response offloading in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001155#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001156/** Driver supports U-APSD in AP mode */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001157#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001158/** Driver supports inactivity timer in AP mode */
Dmitry Shmidt04949592012-07-19 12:16:46 -07001159#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001160/** Driver expects user space implementation of MLME in AP mode */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001161#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001162/** Driver supports SAE with user space SME */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001163#define WPA_DRIVER_FLAGS_SAE 0x02000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001164/** Driver makes use of OBSS scan mechanism in wpa_supplicant */
Dmitry Shmidtd5e49232012-12-03 15:08:10 -08001165#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001166/** Driver supports IBSS (Ad-hoc) mode */
Dmitry Shmidt700a1372013-03-15 14:14:44 -07001167#define WPA_DRIVER_FLAGS_IBSS 0x08000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001168/** Driver supports radar detection */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07001169#define WPA_DRIVER_FLAGS_RADAR 0x10000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001170/** Driver supports a dedicated interface for P2P Device */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001171#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001172/** Driver supports QoS Mapping */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001173#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001174/** Driver supports CSA in AP mode */
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001175#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001176/** Driver supports mesh */
1177#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
1178/** Driver support ACS offload */
1179#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
1180/** Driver supports key management offload */
1181#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
1182/** Driver supports TDLS channel switching */
1183#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
Dmitry Shmidtff787d52015-01-12 13:01:47 -08001184/** Driver supports IBSS with HT datarates */
1185#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001186 u64 flags;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001187
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001188#define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1189#define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1190 unsigned int smps_modes;
1191
1192 unsigned int wmm_ac_supported:1;
1193
1194 unsigned int mac_addr_rand_scan_supported:1;
1195 unsigned int mac_addr_rand_sched_scan_supported:1;
1196
1197 /** Maximum number of supported active probe SSIDs */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001198 int max_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001199
1200 /** Maximum number of supported active probe SSIDs for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001201 int max_sched_scan_ssids;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001202
1203 /** Whether sched_scan (offloaded scanning) is supported */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001204 int sched_scan_supported;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001205
1206 /** Maximum number of supported match sets for sched_scan */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001207 int max_match_sets;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001208
1209 /**
1210 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1211 */
1212 unsigned int max_remain_on_chan;
1213
1214 /**
1215 * max_stations - Maximum number of associated stations the driver
1216 * supports in AP mode
1217 */
1218 unsigned int max_stations;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001219
1220 /**
1221 * probe_resp_offloads - Bitmap of supported protocols by the driver
1222 * for Probe Response offloading.
1223 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001224/** Driver Probe Response offloading support for WPS ver. 1 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001225#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001226/** Driver Probe Response offloading support for WPS ver. 2 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001227#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001228/** Driver Probe Response offloading support for P2P */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001229#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001230/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001231#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1232 unsigned int probe_resp_offloads;
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001233
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07001234 unsigned int max_acl_mac_addrs;
1235
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001236 /**
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07001237 * Number of supported concurrent channels
1238 */
1239 unsigned int num_multichan_concurrent;
1240
1241 /**
Dmitry Shmidt444d5672013-04-01 13:08:44 -07001242 * extended_capa - extended capabilities in driver/device
1243 *
1244 * Must be allocated and freed by driver and the pointers must be
1245 * valid for the lifetime of the driver, i.e., freed in deinit()
1246 */
1247 const u8 *extended_capa, *extended_capa_mask;
1248 unsigned int extended_capa_len;
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07001249
1250 struct wowlan_triggers wowlan_triggers;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001251
1252/** Driver adds the DS Params Set IE in Probe Request frames */
1253#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
1254/** Driver adds the WFA TPC IE in Probe Request frames */
1255#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
1256/** Driver handles quiet period requests */
1257#define WPA_DRIVER_FLAGS_QUIET 0x00000004
1258/**
1259 * Driver is capable of inserting the current TX power value into the body of
1260 * transmitted frames.
1261 * Background: Some Action frames include a TPC Report IE. This IE contains a
1262 * TX power field, which has to be updated by lower layers. One such Action
1263 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1264 * of spectrum management). Note that this insertion takes place at a fixed
1265 * offset, namely the 6th byte in the Action frame body.
1266 */
1267#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
1268 u32 rrm_flags;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001269};
1270
1271
1272struct hostapd_data;
1273
1274struct hostap_sta_driver_data {
1275 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
1276 unsigned long current_tx_rate;
1277 unsigned long inactive_msec;
1278 unsigned long flags;
1279 unsigned long num_ps_buf_frames;
1280 unsigned long tx_retry_failed;
1281 unsigned long tx_retry_count;
1282 int last_rssi;
1283 int last_ack_rssi;
1284};
1285
1286struct hostapd_sta_add_params {
1287 const u8 *addr;
1288 u16 aid;
1289 u16 capability;
1290 const u8 *supp_rates;
1291 size_t supp_rates_len;
1292 u16 listen_interval;
1293 const struct ieee80211_ht_capabilities *ht_capabilities;
Dmitry Shmidta54fa5f2013-01-15 13:53:35 -08001294 const struct ieee80211_vht_capabilities *vht_capabilities;
Dmitry Shmidtbd14a572014-02-18 10:33:49 -08001295 int vht_opmode_enabled;
1296 u8 vht_opmode;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001297 u32 flags; /* bitmask of WPA_STA_* flags */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001298 u32 flags_mask; /* unset bits in flags */
1299#ifdef CONFIG_MESH
1300 enum mesh_plink_state plink_state;
1301#endif /* CONFIG_MESH */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001302 int set; /* Set STA parameters instead of add */
1303 u8 qosinfo;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08001304 const u8 *ext_capab;
1305 size_t ext_capab_len;
Dmitry Shmidt344abd32014-01-14 13:17:00 -08001306 const u8 *supp_channels;
1307 size_t supp_channels_len;
1308 const u8 *supp_oper_classes;
1309 size_t supp_oper_classes_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001310};
1311
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07001312struct mac_address {
1313 u8 addr[ETH_ALEN];
1314};
1315
1316struct hostapd_acl_params {
1317 u8 acl_policy;
1318 unsigned int num_mac_acl;
1319 struct mac_address mac_acl[0];
1320};
1321
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001322enum wpa_driver_if_type {
1323 /**
1324 * WPA_IF_STATION - Station mode interface
1325 */
1326 WPA_IF_STATION,
1327
1328 /**
1329 * WPA_IF_AP_VLAN - AP mode VLAN interface
1330 *
1331 * This interface shares its address and Beacon frame with the main
1332 * BSS.
1333 */
1334 WPA_IF_AP_VLAN,
1335
1336 /**
1337 * WPA_IF_AP_BSS - AP mode BSS interface
1338 *
1339 * This interface has its own address and Beacon frame.
1340 */
1341 WPA_IF_AP_BSS,
1342
1343 /**
1344 * WPA_IF_P2P_GO - P2P Group Owner
1345 */
1346 WPA_IF_P2P_GO,
1347
1348 /**
1349 * WPA_IF_P2P_CLIENT - P2P Client
1350 */
1351 WPA_IF_P2P_CLIENT,
1352
1353 /**
1354 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1355 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1356 */
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001357 WPA_IF_P2P_GROUP,
1358
1359 /**
1360 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1361 * abstracted P2P Device function in the driver
1362 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001363 WPA_IF_P2P_DEVICE,
1364
1365 /*
1366 * WPA_IF_MESH - Mesh interface
1367 */
1368 WPA_IF_MESH,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001369};
1370
1371struct wpa_init_params {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001372 void *global_priv;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001373 const u8 *bssid;
1374 const char *ifname;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001375 const char *driver_params;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001376 int use_pae_group_addr;
1377 char **bridge;
1378 size_t num_bridge;
1379
1380 u8 *own_addr; /* buffer for writing own MAC address */
1381};
1382
1383
1384struct wpa_bss_params {
1385 /** Interface name (for multi-SSID/VLAN support) */
1386 const char *ifname;
1387 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1388 int enabled;
1389
1390 int wpa;
1391 int ieee802_1x;
1392 int wpa_group;
1393 int wpa_pairwise;
1394 int wpa_key_mgmt;
1395 int rsn_preauth;
1396 enum mfp_options ieee80211w;
1397};
1398
1399#define WPA_STA_AUTHORIZED BIT(0)
1400#define WPA_STA_WMM BIT(1)
1401#define WPA_STA_SHORT_PREAMBLE BIT(2)
1402#define WPA_STA_MFP BIT(3)
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001403#define WPA_STA_TDLS_PEER BIT(4)
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001404#define WPA_STA_AUTHENTICATED BIT(5)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001405
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001406enum tdls_oper {
1407 TDLS_DISCOVERY_REQ,
1408 TDLS_SETUP,
1409 TDLS_TEARDOWN,
1410 TDLS_ENABLE_LINK,
1411 TDLS_DISABLE_LINK,
1412 TDLS_ENABLE,
1413 TDLS_DISABLE
1414};
1415
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001416enum wnm_oper {
1417 WNM_SLEEP_ENTER_CONFIRM,
1418 WNM_SLEEP_ENTER_FAIL,
1419 WNM_SLEEP_EXIT_CONFIRM,
1420 WNM_SLEEP_EXIT_FAIL,
1421 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1422 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1423 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1424 * a STA */
1425 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1426 * for a STA */
1427 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1428 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1429 * for a STA */
1430 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1431};
1432
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001433/* enum chan_width - Channel width definitions */
1434enum chan_width {
1435 CHAN_WIDTH_20_NOHT,
1436 CHAN_WIDTH_20,
1437 CHAN_WIDTH_40,
1438 CHAN_WIDTH_80,
1439 CHAN_WIDTH_80P80,
1440 CHAN_WIDTH_160,
1441 CHAN_WIDTH_UNKNOWN
1442};
1443
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001444/**
1445 * struct wpa_signal_info - Information about channel signal quality
1446 */
1447struct wpa_signal_info {
1448 u32 frequency;
1449 int above_threshold;
1450 int current_signal;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001451 int avg_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001452 int current_noise;
1453 int current_txrate;
Dmitry Shmidt34af3062013-07-11 10:46:32 -07001454 enum chan_width chanwidth;
1455 int center_frq1;
1456 int center_frq2;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001457};
1458
1459/**
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001460 * struct beacon_data - Beacon data
1461 * @head: Head portion of Beacon frame (before TIM IE)
1462 * @tail: Tail portion of Beacon frame (after TIM IE)
1463 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
1464 * @proberesp_ies: Extra information element(s) to add into Probe Response
1465 * frames or %NULL
1466 * @assocresp_ies: Extra information element(s) to add into (Re)Association
1467 * Response frames or %NULL
1468 * @probe_resp: Probe Response frame template
1469 * @head_len: Length of @head
1470 * @tail_len: Length of @tail
1471 * @beacon_ies_len: Length of beacon_ies in octets
1472 * @proberesp_ies_len: Length of proberesp_ies in octets
1473 * @proberesp_ies_len: Length of proberesp_ies in octets
1474 * @probe_resp_len: Length of probe response template (@probe_resp)
1475 */
1476struct beacon_data {
1477 u8 *head, *tail;
1478 u8 *beacon_ies;
1479 u8 *proberesp_ies;
1480 u8 *assocresp_ies;
1481 u8 *probe_resp;
1482
1483 size_t head_len, tail_len;
1484 size_t beacon_ies_len;
1485 size_t proberesp_ies_len;
1486 size_t assocresp_ies_len;
1487 size_t probe_resp_len;
1488};
1489
1490/**
1491 * struct csa_settings - Settings for channel switch command
1492 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
1493 * @block_tx: 1 - block transmission for CSA period
1494 * @freq_params: Next channel frequency parameter
1495 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
1496 * @beacon_after: Next beacon/probe resp/asooc resp info
1497 * @counter_offset_beacon: Offset to the count field in beacon's tail
1498 * @counter_offset_presp: Offset to the count field in probe resp.
1499 */
1500struct csa_settings {
1501 u8 cs_count;
1502 u8 block_tx;
1503
1504 struct hostapd_freq_params freq_params;
1505 struct beacon_data beacon_csa;
1506 struct beacon_data beacon_after;
1507
1508 u16 counter_offset_beacon;
1509 u16 counter_offset_presp;
1510};
1511
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07001512/* TDLS peer capabilities for send_tdls_mgmt() */
1513enum tdls_peer_capability {
1514 TDLS_PEER_HT = BIT(0),
1515 TDLS_PEER_VHT = BIT(1),
1516 TDLS_PEER_WMM = BIT(2),
1517};
1518
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001519/* valid info in the wmm_params struct */
1520enum wmm_params_valid_info {
1521 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
1522};
1523
1524/**
1525 * struct wmm_params - WMM parameterss configured for this association
1526 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
1527 * of the struct contain valid information.
1528 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
1529 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
1530 */
1531struct wmm_params {
1532 u8 info_bitmap;
1533 u8 uapsd_queues;
1534};
1535
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001536#ifdef CONFIG_MACSEC
1537struct macsec_init_params {
1538 Boolean always_include_sci;
1539 Boolean use_es;
1540 Boolean use_scb;
1541};
1542#endif /* CONFIG_MACSEC */
1543
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08001544enum drv_br_port_attr {
1545 DRV_BR_PORT_ATTR_PROXYARP,
1546 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
1547};
1548
1549enum drv_br_net_param {
1550 DRV_BR_NET_PARAM_GARP_ACCEPT,
1551};
1552
1553struct drv_acs_params {
1554 /* Selected mode (HOSTAPD_MODE_*) */
1555 enum hostapd_hw_mode hw_mode;
1556
1557 /* Indicates whether HT is enabled */
1558 int ht_enabled;
1559
1560 /* Indicates whether HT40 is enabled */
1561 int ht40_enabled;
1562};
1563
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07001564
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08001565/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001566 * struct wpa_driver_ops - Driver interface API definition
1567 *
1568 * This structure defines the API that each driver interface needs to implement
1569 * for core wpa_supplicant code. All driver specific functionality is captured
1570 * in this wrapper.
1571 */
1572struct wpa_driver_ops {
1573 /** Name of the driver interface */
1574 const char *name;
1575 /** One line description of the driver interface */
1576 const char *desc;
1577
1578 /**
1579 * get_bssid - Get the current BSSID
1580 * @priv: private driver interface data
1581 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1582 *
1583 * Returns: 0 on success, -1 on failure
1584 *
1585 * Query kernel driver for the current BSSID and copy it to bssid.
1586 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1587 * associated.
1588 */
1589 int (*get_bssid)(void *priv, u8 *bssid);
1590
1591 /**
1592 * get_ssid - Get the current SSID
1593 * @priv: private driver interface data
1594 * @ssid: buffer for SSID (at least 32 bytes)
1595 *
1596 * Returns: Length of the SSID on success, -1 on failure
1597 *
1598 * Query kernel driver for the current SSID and copy it to ssid.
1599 * Returning zero is recommended if the STA is not associated.
1600 *
1601 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1602 * can, at least in theory, contain control characters (including nul)
1603 * and as such, should be processed as binary data, not a printable
1604 * string.
1605 */
1606 int (*get_ssid)(void *priv, u8 *ssid);
1607
1608 /**
1609 * set_key - Configure encryption key
1610 * @ifname: Interface name (for multi-SSID/VLAN support)
1611 * @priv: private driver interface data
1612 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001613 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08001614 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
1615 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
1616 * %WPA_ALG_BIP_CMAC_256);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001617 * %WPA_ALG_NONE clears the key.
1618 * @addr: Address of the peer STA (BSSID of the current AP when setting
1619 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1620 * broadcast keys, %NULL for default keys that are used both for
1621 * broadcast and unicast; when clearing keys, %NULL is used to
1622 * indicate that both the broadcast-only and default key of the
1623 * specified key index is to be cleared
1624 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1625 * IGTK
1626 * @set_tx: configure this key as the default Tx key (only used when
1627 * driver does not support separate unicast/individual key
1628 * @seq: sequence number/packet number, seq_len octets, the next
1629 * packet number to be used for in replay protection; configured
1630 * for Rx keys (in most cases, this is only used with broadcast
1631 * keys and set to zero for unicast keys); %NULL if not set
1632 * @seq_len: length of the seq, depends on the algorithm:
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001633 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001634 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1635 * 8-byte Rx Mic Key
1636 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07001637 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001638 *
1639 * Returns: 0 on success, -1 on failure
1640 *
1641 * Configure the given key for the kernel driver. If the driver
1642 * supports separate individual keys (4 default keys + 1 individual),
1643 * addr can be used to determine whether the key is default or
1644 * individual. If only 4 keys are supported, the default key with key
1645 * index 0 is used as the individual key. STA must be configured to use
1646 * it as the default Tx key (set_tx is set) and accept Rx for all the
1647 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1648 * broadcast keys, so key index 0 is available for this kind of
1649 * configuration.
1650 *
1651 * Please note that TKIP keys include separate TX and RX MIC keys and
1652 * some drivers may expect them in different order than wpa_supplicant
1653 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
1654 * will trigger Michael MIC errors. This can be fixed by changing the
1655 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1656 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1657 * example on how this can be done.
1658 */
1659 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
1660 const u8 *addr, int key_idx, int set_tx,
1661 const u8 *seq, size_t seq_len,
1662 const u8 *key, size_t key_len);
1663
1664 /**
1665 * init - Initialize driver interface
1666 * @ctx: context to be used when calling wpa_supplicant functions,
1667 * e.g., wpa_supplicant_event()
1668 * @ifname: interface name, e.g., wlan0
1669 *
1670 * Returns: Pointer to private data, %NULL on failure
1671 *
1672 * Initialize driver interface, including event processing for kernel
1673 * driver events (e.g., associated, scan results, Michael MIC failure).
1674 * This function can allocate a private configuration data area for
1675 * @ctx, file descriptor, interface name, etc. information that may be
1676 * needed in future driver operations. If this is not used, non-NULL
1677 * value will need to be returned because %NULL is used to indicate
1678 * failure. The returned value will be used as 'void *priv' data for
1679 * all other driver_ops functions.
1680 *
1681 * The main event loop (eloop.c) of wpa_supplicant can be used to
1682 * register callback for read sockets (eloop_register_read_sock()).
1683 *
1684 * See below for more information about events and
1685 * wpa_supplicant_event() function.
1686 */
1687 void * (*init)(void *ctx, const char *ifname);
1688
1689 /**
1690 * deinit - Deinitialize driver interface
1691 * @priv: private driver interface data from init()
1692 *
1693 * Shut down driver interface and processing of driver events. Free
1694 * private data buffer if one was allocated in init() handler.
1695 */
1696 void (*deinit)(void *priv);
1697
1698 /**
1699 * set_param - Set driver configuration parameters
1700 * @priv: private driver interface data from init()
1701 * @param: driver specific configuration parameters
1702 *
1703 * Returns: 0 on success, -1 on failure
1704 *
1705 * Optional handler for notifying driver interface about configuration
1706 * parameters (driver_param).
1707 */
1708 int (*set_param)(void *priv, const char *param);
1709
1710 /**
1711 * set_countermeasures - Enable/disable TKIP countermeasures
1712 * @priv: private driver interface data
1713 * @enabled: 1 = countermeasures enabled, 0 = disabled
1714 *
1715 * Returns: 0 on success, -1 on failure
1716 *
1717 * Configure TKIP countermeasures. When these are enabled, the driver
1718 * should drop all received and queued frames that are using TKIP.
1719 */
1720 int (*set_countermeasures)(void *priv, int enabled);
1721
1722 /**
1723 * deauthenticate - Request driver to deauthenticate
1724 * @priv: private driver interface data
1725 * @addr: peer address (BSSID of the AP)
1726 * @reason_code: 16-bit reason code to be sent in the deauthentication
1727 * frame
1728 *
1729 * Returns: 0 on success, -1 on failure
1730 */
1731 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1732
1733 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001734 * associate - Request driver to associate
1735 * @priv: private driver interface data
1736 * @params: association parameters
1737 *
1738 * Returns: 0 on success, -1 on failure
1739 */
1740 int (*associate)(void *priv,
1741 struct wpa_driver_associate_params *params);
1742
1743 /**
1744 * add_pmkid - Add PMKSA cache entry to the driver
1745 * @priv: private driver interface data
1746 * @bssid: BSSID for the PMKSA cache entry
1747 * @pmkid: PMKID for the PMKSA cache entry
1748 *
1749 * Returns: 0 on success, -1 on failure
1750 *
1751 * This function is called when a new PMK is received, as a result of
1752 * either normal authentication or RSN pre-authentication.
1753 *
1754 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1755 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1756 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1757 * driver_ops function does not need to be implemented. Likewise, if
1758 * the driver does not support WPA, this function is not needed.
1759 */
1760 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1761
1762 /**
1763 * remove_pmkid - Remove PMKSA cache entry to the driver
1764 * @priv: private driver interface data
1765 * @bssid: BSSID for the PMKSA cache entry
1766 * @pmkid: PMKID for the PMKSA cache entry
1767 *
1768 * Returns: 0 on success, -1 on failure
1769 *
1770 * This function is called when the supplicant drops a PMKSA cache
1771 * entry for any reason.
1772 *
1773 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1774 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1775 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1776 * from wpa_supplicant, this driver_ops function does not need to be
1777 * implemented. Likewise, if the driver does not support WPA, this
1778 * function is not needed.
1779 */
1780 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1781
1782 /**
1783 * flush_pmkid - Flush PMKSA cache
1784 * @priv: private driver interface data
1785 *
1786 * Returns: 0 on success, -1 on failure
1787 *
1788 * This function is called when the supplicant drops all PMKSA cache
1789 * entries for any reason.
1790 *
1791 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1792 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1793 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1794 * from wpa_supplicant, this driver_ops function does not need to be
1795 * implemented. Likewise, if the driver does not support WPA, this
1796 * function is not needed.
1797 */
1798 int (*flush_pmkid)(void *priv);
1799
1800 /**
1801 * get_capa - Get driver capabilities
1802 * @priv: private driver interface data
1803 *
1804 * Returns: 0 on success, -1 on failure
1805 *
1806 * Get driver/firmware/hardware capabilities.
1807 */
1808 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1809
1810 /**
1811 * poll - Poll driver for association information
1812 * @priv: private driver interface data
1813 *
1814 * This is an option callback that can be used when the driver does not
1815 * provide event mechanism for association events. This is called when
1816 * receiving WPA EAPOL-Key messages that require association
1817 * information. The driver interface is supposed to generate associnfo
1818 * event before returning from this callback function. In addition, the
1819 * driver interface should generate an association event after having
1820 * sent out associnfo.
1821 */
1822 void (*poll)(void *priv);
1823
1824 /**
1825 * get_ifname - Get interface name
1826 * @priv: private driver interface data
1827 *
1828 * Returns: Pointer to the interface name. This can differ from the
1829 * interface name used in init() call. Init() is called first.
1830 *
1831 * This optional function can be used to allow the driver interface to
1832 * replace the interface name with something else, e.g., based on an
1833 * interface mapping from a more descriptive name.
1834 */
1835 const char * (*get_ifname)(void *priv);
1836
1837 /**
1838 * get_mac_addr - Get own MAC address
1839 * @priv: private driver interface data
1840 *
1841 * Returns: Pointer to own MAC address or %NULL on failure
1842 *
1843 * This optional function can be used to get the own MAC address of the
1844 * device from the driver interface code. This is only needed if the
1845 * l2_packet implementation for the OS does not provide easy access to
1846 * a MAC address. */
1847 const u8 * (*get_mac_addr)(void *priv);
1848
1849 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001850 * set_operstate - Sets device operating state to DORMANT or UP
1851 * @priv: private driver interface data
1852 * @state: 0 = dormant, 1 = up
1853 * Returns: 0 on success, -1 on failure
1854 *
1855 * This is an optional function that can be used on operating systems
1856 * that support a concept of controlling network device state from user
1857 * space applications. This function, if set, gets called with
1858 * state = 1 when authentication has been completed and with state = 0
1859 * when connection is lost.
1860 */
1861 int (*set_operstate)(void *priv, int state);
1862
1863 /**
1864 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1865 * @priv: Private driver interface data
1866 * @addr: Address of the station for which to set protection (may be
1867 * %NULL for group keys)
1868 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1869 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1870 * Returns: 0 on success, -1 on failure
1871 *
1872 * This is an optional function that can be used to set the driver to
1873 * require protection for Tx and/or Rx frames. This uses the layer
1874 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1875 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1876 * set protection operation; instead, they set protection implicitly
1877 * based on configured keys.
1878 */
1879 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1880 int key_type);
1881
1882 /**
1883 * get_hw_feature_data - Get hardware support data (channels and rates)
1884 * @priv: Private driver interface data
1885 * @num_modes: Variable for returning the number of returned modes
1886 * flags: Variable for returning hardware feature flags
1887 * Returns: Pointer to allocated hardware data on success or %NULL on
1888 * failure. Caller is responsible for freeing this.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001889 */
1890 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1891 u16 *num_modes,
1892 u16 *flags);
1893
1894 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001895 * send_mlme - Send management frame from MLME
1896 * @priv: Private driver interface data
1897 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1898 * @data_len: Size of the management frame
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001899 * @noack: Do not wait for this frame to be acked (disable retries)
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001900 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001901 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08001902 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1903 int noack);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001904
1905 /**
1906 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1907 * @priv: Private driver interface data
1908 * @md: Mobility domain (2 octets) (also included inside ies)
1909 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1910 * @ies_len: Length of FT IEs in bytes
1911 * Returns: 0 on success, -1 on failure
1912 *
1913 * The supplicant uses this callback to let the driver know that keying
1914 * material for FT is available and that the driver can use the
1915 * provided IEs in the next message in FT authentication sequence.
1916 *
1917 * This function is only needed for driver that support IEEE 802.11r
1918 * (Fast BSS Transition).
1919 */
1920 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1921 size_t ies_len);
1922
1923 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001924 * get_scan_results2 - Fetch the latest scan results
1925 * @priv: private driver interface data
1926 *
1927 * Returns: Allocated buffer of scan results (caller is responsible for
1928 * freeing the data structure) on success, NULL on failure
1929 */
1930 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1931
1932 /**
1933 * set_country - Set country
1934 * @priv: Private driver interface data
1935 * @alpha2: country to which to switch to
1936 * Returns: 0 on success, -1 on failure
1937 *
1938 * This function is for drivers which support some form
1939 * of setting a regulatory domain.
1940 */
1941 int (*set_country)(void *priv, const char *alpha2);
1942
1943 /**
Dmitry Shmidtcce06662013-11-04 18:44:24 -08001944 * get_country - Get country
1945 * @priv: Private driver interface data
1946 * @alpha2: Buffer for returning country code (at least 3 octets)
1947 * Returns: 0 on success, -1 on failure
1948 */
1949 int (*get_country)(void *priv, char *alpha2);
1950
1951 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07001952 * global_init - Global driver initialization
1953 * Returns: Pointer to private data (global), %NULL on failure
1954 *
1955 * This optional function is called to initialize the driver wrapper
1956 * for global data, i.e., data that applies to all interfaces. If this
1957 * function is implemented, global_deinit() will also need to be
1958 * implemented to free the private data. The driver will also likely
1959 * use init2() function instead of init() to get the pointer to global
1960 * data available to per-interface initializer.
1961 */
1962 void * (*global_init)(void);
1963
1964 /**
1965 * global_deinit - Global driver deinitialization
1966 * @priv: private driver global data from global_init()
1967 *
1968 * Terminate any global driver related functionality and free the
1969 * global data structure.
1970 */
1971 void (*global_deinit)(void *priv);
1972
1973 /**
1974 * init2 - Initialize driver interface (with global data)
1975 * @ctx: context to be used when calling wpa_supplicant functions,
1976 * e.g., wpa_supplicant_event()
1977 * @ifname: interface name, e.g., wlan0
1978 * @global_priv: private driver global data from global_init()
1979 * Returns: Pointer to private data, %NULL on failure
1980 *
1981 * This function can be used instead of init() if the driver wrapper
1982 * uses global data.
1983 */
1984 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1985
1986 /**
1987 * get_interfaces - Get information about available interfaces
1988 * @global_priv: private driver global data from global_init()
1989 * Returns: Allocated buffer of interface information (caller is
1990 * responsible for freeing the data structure) on success, NULL on
1991 * failure
1992 */
1993 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1994
1995 /**
1996 * scan2 - Request the driver to initiate scan
1997 * @priv: private driver interface data
1998 * @params: Scan parameters
1999 *
2000 * Returns: 0 on success, -1 on failure
2001 *
2002 * Once the scan results are ready, the driver should report scan
2003 * results event for wpa_supplicant which will eventually request the
2004 * results with wpa_driver_get_scan_results2().
2005 */
2006 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
2007
2008 /**
2009 * authenticate - Request driver to authenticate
2010 * @priv: private driver interface data
2011 * @params: authentication parameters
2012 * Returns: 0 on success, -1 on failure
2013 *
2014 * This is an optional function that can be used with drivers that
2015 * support separate authentication and association steps, i.e., when
2016 * wpa_supplicant can act as the SME. If not implemented, associate()
2017 * function is expected to take care of IEEE 802.11 authentication,
2018 * too.
2019 */
2020 int (*authenticate)(void *priv,
2021 struct wpa_driver_auth_params *params);
2022
2023 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002024 * set_ap - Set Beacon and Probe Response information for AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002025 * @priv: Private driver interface data
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002026 * @params: Parameters to use in AP mode
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002027 *
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002028 * This function is used to configure Beacon template and/or extra IEs
2029 * to add for Beacon and Probe Response frames for the driver in
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002030 * AP mode. The driver is responsible for building the full Beacon
2031 * frame by concatenating the head part with TIM IE generated by the
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002032 * driver/firmware and finishing with the tail part. Depending on the
2033 * driver architectue, this can be done either by using the full
2034 * template or the set of additional IEs (e.g., WPS and P2P IE).
2035 * Similarly, Probe Response processing depends on the driver design.
2036 * If the driver (or firmware) takes care of replying to Probe Request
2037 * frames, the extra IEs provided here needs to be added to the Probe
2038 * Response frames.
2039 *
2040 * Returns: 0 on success, -1 on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002041 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002042 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002043
2044 /**
Dmitry Shmidt8bae4132013-06-06 11:25:10 -07002045 * set_acl - Set ACL in AP mode
2046 * @priv: Private driver interface data
2047 * @params: Parameters to configure ACL
2048 * Returns: 0 on success, -1 on failure
2049 *
2050 * This is used only for the drivers which support MAC address ACL.
2051 */
2052 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2053
2054 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002055 * hapd_init - Initialize driver interface (hostapd only)
2056 * @hapd: Pointer to hostapd context
2057 * @params: Configuration for the driver wrapper
2058 * Returns: Pointer to private data, %NULL on failure
2059 *
2060 * This function is used instead of init() or init2() when the driver
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002061 * wrapper is used with hostapd.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002062 */
2063 void * (*hapd_init)(struct hostapd_data *hapd,
2064 struct wpa_init_params *params);
2065
2066 /**
2067 * hapd_deinit - Deinitialize driver interface (hostapd only)
2068 * @priv: Private driver interface data from hapd_init()
2069 */
2070 void (*hapd_deinit)(void *priv);
2071
2072 /**
2073 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
2074 * @priv: Private driver interface data
2075 * @params: BSS parameters
2076 * Returns: 0 on success, -1 on failure
2077 *
2078 * This is an optional function to configure the kernel driver to
2079 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2080 * can be left undefined (set to %NULL) if IEEE 802.1X support is
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002081 * always enabled and the driver uses set_ap() to set WPA/RSN IE
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002082 * for Beacon frames.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002083 *
2084 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002085 */
2086 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
2087
2088 /**
2089 * set_privacy - Enable/disable privacy (AP only)
2090 * @priv: Private driver interface data
2091 * @enabled: 1 = privacy enabled, 0 = disabled
2092 * Returns: 0 on success, -1 on failure
2093 *
2094 * This is an optional function to configure privacy field in the
2095 * kernel driver for Beacon frames. This can be left undefined (set to
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002096 * %NULL) if the driver uses the Beacon template from set_ap().
2097 *
2098 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002099 */
2100 int (*set_privacy)(void *priv, int enabled);
2101
2102 /**
2103 * get_seqnum - Fetch the current TSC/packet number (AP only)
2104 * @ifname: The interface name (main or virtual)
2105 * @priv: Private driver interface data
2106 * @addr: MAC address of the station or %NULL for group keys
2107 * @idx: Key index
2108 * @seq: Buffer for returning the latest used TSC/packet number
2109 * Returns: 0 on success, -1 on failure
2110 *
2111 * This function is used to fetch the last used TSC/packet number for
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002112 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2113 * keys, so there is no strict requirement on implementing support for
2114 * unicast keys (i.e., addr != %NULL).
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002115 */
2116 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2117 int idx, u8 *seq);
2118
2119 /**
2120 * flush - Flush all association stations (AP only)
2121 * @priv: Private driver interface data
2122 * Returns: 0 on success, -1 on failure
2123 *
2124 * This function requests the driver to disassociate all associated
2125 * stations. This function does not need to be implemented if the
2126 * driver does not process association frames internally.
2127 */
2128 int (*flush)(void *priv);
2129
2130 /**
2131 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
2132 * @priv: Private driver interface data
2133 * @elem: Information elements
2134 * @elem_len: Length of the elem buffer in octets
2135 * Returns: 0 on success, -1 on failure
2136 *
2137 * This is an optional function to add information elements in the
2138 * kernel driver for Beacon and Probe Response frames. This can be left
2139 * undefined (set to %NULL) if the driver uses the Beacon template from
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002140 * set_ap().
2141 *
2142 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002143 */
2144 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
2145
2146 /**
Jouni Malinen1e6c57f2012-09-05 17:07:03 +03002147 * read_sta_data - Fetch station data
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002148 * @priv: Private driver interface data
2149 * @data: Buffer for returning station information
2150 * @addr: MAC address of the station
2151 * Returns: 0 on success, -1 on failure
2152 */
2153 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2154 const u8 *addr);
2155
2156 /**
2157 * hapd_send_eapol - Send an EAPOL packet (AP only)
2158 * @priv: private driver interface data
2159 * @addr: Destination MAC address
2160 * @data: EAPOL packet starting with IEEE 802.1X header
2161 * @data_len: Length of the EAPOL packet in octets
2162 * @encrypt: Whether the frame should be encrypted
2163 * @own_addr: Source MAC address
2164 * @flags: WPA_STA_* flags for the destination station
2165 *
2166 * Returns: 0 on success, -1 on failure
2167 */
2168 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2169 size_t data_len, int encrypt,
2170 const u8 *own_addr, u32 flags);
2171
2172 /**
2173 * sta_deauth - Deauthenticate a station (AP only)
2174 * @priv: Private driver interface data
2175 * @own_addr: Source address and BSSID for the Deauthentication frame
2176 * @addr: MAC address of the station to deauthenticate
2177 * @reason: Reason code for the Deauthentiation frame
2178 * Returns: 0 on success, -1 on failure
2179 *
2180 * This function requests a specific station to be deauthenticated and
2181 * a Deauthentication frame to be sent to it.
2182 */
2183 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
2184 int reason);
2185
2186 /**
2187 * sta_disassoc - Disassociate a station (AP only)
2188 * @priv: Private driver interface data
2189 * @own_addr: Source address and BSSID for the Disassociation frame
2190 * @addr: MAC address of the station to disassociate
2191 * @reason: Reason code for the Disassociation frame
2192 * Returns: 0 on success, -1 on failure
2193 *
2194 * This function requests a specific station to be disassociated and
2195 * a Disassociation frame to be sent to it.
2196 */
2197 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
2198 int reason);
2199
2200 /**
2201 * sta_remove - Remove a station entry (AP only)
2202 * @priv: Private driver interface data
2203 * @addr: MAC address of the station to be removed
2204 * Returns: 0 on success, -1 on failure
2205 */
2206 int (*sta_remove)(void *priv, const u8 *addr);
2207
2208 /**
2209 * hapd_get_ssid - Get the current SSID (AP only)
2210 * @priv: Private driver interface data
2211 * @buf: Buffer for returning the SSID
2212 * @len: Maximum length of the buffer
2213 * Returns: Length of the SSID on success, -1 on failure
2214 *
2215 * This function need not be implemented if the driver uses Beacon
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002216 * template from set_ap() and does not reply to Probe Request frames.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002217 */
2218 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
2219
2220 /**
2221 * hapd_set_ssid - Set SSID (AP only)
2222 * @priv: Private driver interface data
2223 * @buf: SSID
2224 * @len: Length of the SSID in octets
2225 * Returns: 0 on success, -1 on failure
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002226 *
2227 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002228 */
2229 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2230
2231 /**
2232 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2233 * @priv: Private driver interface data
2234 * @enabled: 1 = countermeasures enabled, 0 = disabled
2235 * Returns: 0 on success, -1 on failure
2236 *
2237 * This need not be implemented if the driver does not take care of
2238 * association processing.
2239 */
2240 int (*hapd_set_countermeasures)(void *priv, int enabled);
2241
2242 /**
2243 * sta_add - Add a station entry
2244 * @priv: Private driver interface data
2245 * @params: Station parameters
2246 * Returns: 0 on success, -1 on failure
2247 *
2248 * This function is used to add a station entry to the driver once the
2249 * station has completed association. This is only used if the driver
2250 * does not take care of association processing.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002251 *
2252 * With TDLS, this function is also used to add or set (params->set 1)
2253 * TDLS peer entries.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002254 */
2255 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
2256
2257 /**
2258 * get_inact_sec - Get station inactivity duration (AP only)
2259 * @priv: Private driver interface data
2260 * @addr: Station address
2261 * Returns: Number of seconds station has been inactive, -1 on failure
2262 */
2263 int (*get_inact_sec)(void *priv, const u8 *addr);
2264
2265 /**
2266 * sta_clear_stats - Clear station statistics (AP only)
2267 * @priv: Private driver interface data
2268 * @addr: Station address
2269 * Returns: 0 on success, -1 on failure
2270 */
2271 int (*sta_clear_stats)(void *priv, const u8 *addr);
2272
2273 /**
2274 * set_freq - Set channel/frequency (AP only)
2275 * @priv: Private driver interface data
2276 * @freq: Channel parameters
2277 * Returns: 0 on success, -1 on failure
2278 */
2279 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
2280
2281 /**
2282 * set_rts - Set RTS threshold
2283 * @priv: Private driver interface data
2284 * @rts: RTS threshold in octets
2285 * Returns: 0 on success, -1 on failure
2286 */
2287 int (*set_rts)(void *priv, int rts);
2288
2289 /**
2290 * set_frag - Set fragmentation threshold
2291 * @priv: Private driver interface data
2292 * @frag: Fragmentation threshold in octets
2293 * Returns: 0 on success, -1 on failure
2294 */
2295 int (*set_frag)(void *priv, int frag);
2296
2297 /**
2298 * sta_set_flags - Set station flags (AP only)
2299 * @priv: Private driver interface data
2300 * @addr: Station address
2301 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2302 * @flags_or: Bitmap of WPA_STA_* flags to add
2303 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
2304 * Returns: 0 on success, -1 on failure
2305 */
2306 int (*sta_set_flags)(void *priv, const u8 *addr,
2307 int total_flags, int flags_or, int flags_and);
2308
2309 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002310 * set_tx_queue_params - Set TX queue parameters
2311 * @priv: Private driver interface data
2312 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
2313 * @aifs: AIFS
2314 * @cw_min: cwMin
2315 * @cw_max: cwMax
2316 * @burst_time: Maximum length for bursting in 0.1 msec units
2317 */
2318 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2319 int cw_max, int burst_time);
2320
2321 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002322 * if_add - Add a virtual interface
2323 * @priv: Private driver interface data
2324 * @type: Interface type
2325 * @ifname: Interface name for the new virtual interface
2326 * @addr: Local address to use for the interface or %NULL to use the
2327 * parent interface address
2328 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
2329 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2330 * not allowed (applies only to %WPA_IF_AP_BSS type)
2331 * @force_ifname: Buffer for returning an interface name that the
2332 * driver ended up using if it differs from the requested ifname
2333 * @if_addr: Buffer for returning the allocated interface address
2334 * (this may differ from the requested addr if the driver cannot
2335 * change interface address)
2336 * @bridge: Bridge interface to use or %NULL if no bridge configured
Dmitry Shmidtcce06662013-11-04 18:44:24 -08002337 * @use_existing: Whether to allow existing interface to be used
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002338 * Returns: 0 on success, -1 on failure
2339 */
2340 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2341 const char *ifname, const u8 *addr, void *bss_ctx,
2342 void **drv_priv, char *force_ifname, u8 *if_addr,
Dmitry Shmidtcce06662013-11-04 18:44:24 -08002343 const char *bridge, int use_existing);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002344
2345 /**
2346 * if_remove - Remove a virtual interface
2347 * @priv: Private driver interface data
2348 * @type: Interface type
2349 * @ifname: Interface name of the virtual interface to be removed
2350 * Returns: 0 on success, -1 on failure
2351 */
2352 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2353 const char *ifname);
2354
2355 /**
2356 * set_sta_vlan - Bind a station into a specific interface (AP only)
2357 * @priv: Private driver interface data
2358 * @ifname: Interface (main or virtual BSS or VLAN)
2359 * @addr: MAC address of the associated station
2360 * @vlan_id: VLAN ID
2361 * Returns: 0 on success, -1 on failure
2362 *
2363 * This function is used to bind a station to a specific virtual
2364 * interface. It is only used if when virtual interfaces are supported,
2365 * e.g., to assign stations to different VLAN interfaces based on
2366 * information from a RADIUS server. This allows separate broadcast
2367 * domains to be used with a single BSS.
2368 */
2369 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
2370 int vlan_id);
2371
2372 /**
2373 * commit - Optional commit changes handler (AP only)
2374 * @priv: driver private data
2375 * Returns: 0 on success, -1 on failure
2376 *
2377 * This optional handler function can be registered if the driver
2378 * interface implementation needs to commit changes (e.g., by setting
2379 * network interface up) at the end of initial configuration. If set,
2380 * this handler will be called after initial setup has been completed.
2381 */
2382 int (*commit)(void *priv);
2383
2384 /**
2385 * send_ether - Send an ethernet packet (AP only)
2386 * @priv: private driver interface data
2387 * @dst: Destination MAC address
2388 * @src: Source MAC address
2389 * @proto: Ethertype
2390 * @data: EAPOL packet starting with IEEE 802.1X header
2391 * @data_len: Length of the EAPOL packet in octets
2392 * Returns: 0 on success, -1 on failure
2393 */
2394 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2395 const u8 *data, size_t data_len);
2396
2397 /**
2398 * set_radius_acl_auth - Notification of RADIUS ACL change
2399 * @priv: Private driver interface data
2400 * @mac: MAC address of the station
2401 * @accepted: Whether the station was accepted
2402 * @session_timeout: Session timeout for the station
2403 * Returns: 0 on success, -1 on failure
2404 */
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07002405 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002406 u32 session_timeout);
2407
2408 /**
2409 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2410 * @priv: Private driver interface data
2411 * @mac: MAC address of the station
2412 * Returns: 0 on success, -1 on failure
2413 */
2414 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2415
2416 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002417 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
2418 * @priv: Private driver interface data
2419 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2420 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2421 * extra IE(s)
2422 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2423 * to remove extra IE(s)
2424 * Returns: 0 on success, -1 on failure
2425 *
2426 * This is an optional function to add WPS IE in the kernel driver for
2427 * Beacon and Probe Response frames. This can be left undefined (set
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002428 * to %NULL) if the driver uses the Beacon template from set_ap()
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002429 * and does not process Probe Request frames. If the driver takes care
2430 * of (Re)Association frame processing, the assocresp buffer includes
2431 * WPS IE(s) that need to be added to (Re)Association Response frames
2432 * whenever a (Re)Association Request frame indicated use of WPS.
2433 *
2434 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2435 * frames when operating as a GO. The driver is responsible for adding
2436 * timing related attributes (e.g., NoA) in addition to the IEs
2437 * included here by appending them after these buffers. This call is
2438 * also used to provide Probe Response IEs for P2P Listen state
2439 * operations for drivers that generate the Probe Response frames
2440 * internally.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002441 *
2442 * DEPRECATED - use set_ap() instead
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002443 */
2444 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
2445 const struct wpabuf *proberesp,
2446 const struct wpabuf *assocresp);
2447
2448 /**
2449 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2450 * @priv: Private driver interface data
2451 * @authorized: Whether the port is authorized
2452 * Returns: 0 on success, -1 on failure
2453 */
2454 int (*set_supp_port)(void *priv, int authorized);
2455
2456 /**
2457 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2458 * @priv: Private driver interface data
2459 * @addr: MAC address of the associated station
2460 * @aid: Association ID
2461 * @val: 1 = bind to 4-address WDS; 0 = unbind
2462 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2463 * to indicate that bridge is not to be used
Dmitry Shmidtc2ebb4b2013-07-24 12:57:51 -07002464 * @ifname_wds: Buffer to return the interface name for the new WDS
2465 * station or %NULL to indicate name is not returned.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002466 * Returns: 0 on success, -1 on failure
2467 */
2468 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07002469 const char *bridge_ifname, char *ifname_wds);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002470
2471 /**
2472 * send_action - Transmit an Action frame
2473 * @priv: Private driver interface data
2474 * @freq: Frequency (in MHz) of the channel
2475 * @wait: Time to wait off-channel for a response (in ms), or zero
2476 * @dst: Destination MAC address (Address 1)
2477 * @src: Source MAC address (Address 2)
2478 * @bssid: BSSID (Address 3)
2479 * @data: Frame body
2480 * @data_len: data length in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002481 @ @no_cck: Whether CCK rates must not be used to transmit this frame
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002482 * Returns: 0 on success, -1 on failure
2483 *
2484 * This command can be used to request the driver to transmit an action
2485 * frame to the specified destination.
2486 *
2487 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2488 * be transmitted on the given channel and the device will wait for a
2489 * response on that channel for the given wait time.
2490 *
2491 * If the flag is not set, the wait time will be ignored. In this case,
2492 * if a remain-on-channel duration is in progress, the frame must be
2493 * transmitted on that channel; alternatively the frame may be sent on
2494 * the current operational channel (if in associated state in station
2495 * mode or while operating as an AP.)
2496 */
2497 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
2498 const u8 *dst, const u8 *src, const u8 *bssid,
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002499 const u8 *data, size_t data_len, int no_cck);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002500
2501 /**
2502 * send_action_cancel_wait - Cancel action frame TX wait
2503 * @priv: Private driver interface data
2504 *
2505 * This command cancels the wait time associated with sending an action
2506 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2507 * set in the driver flags.
2508 */
2509 void (*send_action_cancel_wait)(void *priv);
2510
2511 /**
2512 * remain_on_channel - Remain awake on a channel
2513 * @priv: Private driver interface data
2514 * @freq: Frequency (in MHz) of the channel
2515 * @duration: Duration in milliseconds
2516 * Returns: 0 on success, -1 on failure
2517 *
2518 * This command is used to request the driver to remain awake on the
2519 * specified channel for the specified duration and report received
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08002520 * Action frames with EVENT_RX_MGMT events. Optionally, received
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002521 * Probe Request frames may also be requested to be reported by calling
2522 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2523 *
2524 * The driver may not be at the requested channel when this function
2525 * returns, i.e., the return code is only indicating whether the
2526 * request was accepted. The caller will need to wait until the
2527 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2528 * completed the channel change. This may take some time due to other
2529 * need for the radio and the caller should be prepared to timing out
2530 * its wait since there are no guarantees on when this request can be
2531 * executed.
2532 */
2533 int (*remain_on_channel)(void *priv, unsigned int freq,
2534 unsigned int duration);
2535
2536 /**
2537 * cancel_remain_on_channel - Cancel remain-on-channel operation
2538 * @priv: Private driver interface data
2539 *
2540 * This command can be used to cancel a remain-on-channel operation
2541 * before its originally requested duration has passed. This could be
2542 * used, e.g., when remain_on_channel() is used to request extra time
2543 * to receive a response to an Action frame and the response is
2544 * received when there is still unneeded time remaining on the
2545 * remain-on-channel operation.
2546 */
2547 int (*cancel_remain_on_channel)(void *priv);
2548
2549 /**
2550 * probe_req_report - Request Probe Request frames to be indicated
2551 * @priv: Private driver interface data
2552 * @report: Whether to report received Probe Request frames
2553 * Returns: 0 on success, -1 on failure (or if not supported)
2554 *
2555 * This command can be used to request the driver to indicate when
2556 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2557 * Since this operation may require extra resources, e.g., due to less
2558 * optimal hardware/firmware RX filtering, many drivers may disable
2559 * Probe Request reporting at least in station mode. This command is
2560 * used to notify the driver when the Probe Request frames need to be
2561 * reported, e.g., during remain-on-channel operations.
2562 */
2563 int (*probe_req_report)(void *priv, int report);
2564
2565 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002566 * deinit_ap - Deinitialize AP mode
2567 * @priv: Private driver interface data
2568 * Returns: 0 on success, -1 on failure (or if not supported)
2569 *
2570 * This optional function can be used to disable AP mode related
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07002571 * configuration. If the interface was not dynamically added,
2572 * change the driver mode to station mode to allow normal station
2573 * operations like scanning to be completed.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002574 */
2575 int (*deinit_ap)(void *priv);
2576
2577 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07002578 * deinit_p2p_cli - Deinitialize P2P client mode
2579 * @priv: Private driver interface data
2580 * Returns: 0 on success, -1 on failure (or if not supported)
2581 *
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07002582 * This optional function can be used to disable P2P client mode. If the
2583 * interface was not dynamically added, change the interface type back
2584 * to station mode.
Dmitry Shmidt04949592012-07-19 12:16:46 -07002585 */
2586 int (*deinit_p2p_cli)(void *priv);
2587
2588 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002589 * suspend - Notification on system suspend/hibernate event
2590 * @priv: Private driver interface data
2591 */
2592 void (*suspend)(void *priv);
2593
2594 /**
2595 * resume - Notification on system resume/thaw event
2596 * @priv: Private driver interface data
2597 */
2598 void (*resume)(void *priv);
2599
2600 /**
2601 * signal_monitor - Set signal monitoring parameters
2602 * @priv: Private driver interface data
2603 * @threshold: Threshold value for signal change events; 0 = disabled
2604 * @hysteresis: Minimum change in signal strength before indicating a
2605 * new event
2606 * Returns: 0 on success, -1 on failure (or if not supported)
2607 *
2608 * This function can be used to configure monitoring of signal strength
2609 * with the current AP. Whenever signal strength drops below the
2610 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2611 * should be generated assuming the signal strength has changed at
2612 * least %hysteresis from the previously indicated signal change event.
2613 */
2614 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
2615
2616 /**
2617 * send_frame - Send IEEE 802.11 frame (testing use only)
2618 * @priv: Private driver interface data
2619 * @data: IEEE 802.11 frame with IEEE 802.11 header
2620 * @data_len: Size of the frame
2621 * @encrypt: Whether to encrypt the frame (if keys are set)
2622 * Returns: 0 on success, -1 on failure
2623 *
2624 * This function is only used for debugging purposes and is not
2625 * required to be implemented for normal operations.
2626 */
2627 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2628 int encrypt);
2629
2630 /**
2631 * shared_freq - Get operating frequency of shared interface(s)
2632 * @priv: Private driver interface data
2633 * Returns: Operating frequency in MHz, 0 if no shared operation in
2634 * use, or -1 on failure
2635 *
2636 * This command can be used to request the current operating frequency
2637 * of any virtual interface that shares the same radio to provide
2638 * information for channel selection for other virtual interfaces.
2639 */
2640 int (*shared_freq)(void *priv);
2641
2642 /**
2643 * get_noa - Get current Notice of Absence attribute payload
2644 * @priv: Private driver interface data
2645 * @buf: Buffer for returning NoA
2646 * @buf_len: Buffer length in octets
2647 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2648 * advertized, or -1 on failure
2649 *
2650 * This function is used to fetch the current Notice of Absence
2651 * attribute value from GO.
2652 */
2653 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2654
2655 /**
2656 * set_noa - Set Notice of Absence parameters for GO (testing)
2657 * @priv: Private driver interface data
2658 * @count: Count
2659 * @start: Start time in ms from next TBTT
2660 * @duration: Duration in ms
2661 * Returns: 0 on success or -1 on failure
2662 *
2663 * This function is used to set Notice of Absence parameters for GO. It
2664 * is used only for testing. To disable NoA, all parameters are set to
2665 * 0.
2666 */
2667 int (*set_noa)(void *priv, u8 count, int start, int duration);
2668
2669 /**
2670 * set_p2p_powersave - Set P2P power save options
2671 * @priv: Private driver interface data
2672 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2673 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2674 * @ctwindow: 0.. = change (msec), -1 = no change
2675 * Returns: 0 on success or -1 on failure
2676 */
2677 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2678 int ctwindow);
2679
2680 /**
2681 * ampdu - Enable/disable aggregation
2682 * @priv: Private driver interface data
2683 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2684 * Returns: 0 on success or -1 on failure
2685 */
2686 int (*ampdu)(void *priv, int ampdu);
2687
2688 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002689 * get_radio_name - Get physical radio name for the device
2690 * @priv: Private driver interface data
2691 * Returns: Radio name or %NULL if not known
2692 *
2693 * The returned data must not be modified by the caller. It is assumed
2694 * that any interface that has the same radio name as another is
2695 * sharing the same physical radio. This information can be used to
2696 * share scan results etc. information between the virtual interfaces
2697 * to speed up various operations.
2698 */
2699 const char * (*get_radio_name)(void *priv);
2700
2701 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002702 * send_tdls_mgmt - for sending TDLS management packets
2703 * @priv: private driver interface data
2704 * @dst: Destination (peer) MAC address
2705 * @action_code: TDLS action code for the mssage
2706 * @dialog_token: Dialog Token to use in the message (if needed)
2707 * @status_code: Status Code or Reason Code to use (if needed)
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002708 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07002709 * @initiator: Is the current end the TDLS link initiator
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002710 * @buf: TDLS IEs to add to the message
2711 * @len: Length of buf in octets
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002712 * Returns: 0 on success, negative (<0) on failure
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002713 *
2714 * This optional function can be used to send packet to driver which is
2715 * responsible for receiving and sending all TDLS packets.
2716 */
2717 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
Dmitry Shmidtdf5a7e42014-04-02 12:59:59 -07002718 u8 dialog_token, u16 status_code, u32 peer_capab,
Dmitry Shmidt9ead16e2014-10-07 13:15:23 -07002719 int initiator, const u8 *buf, size_t len);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002720
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002721 /**
2722 * tdls_oper - Ask the driver to perform high-level TDLS operations
2723 * @priv: Private driver interface data
2724 * @oper: TDLS high-level operation. See %enum tdls_oper
2725 * @peer: Destination (peer) MAC address
2726 * Returns: 0 on success, negative (<0) on failure
2727 *
2728 * This optional function can be used to send high-level TDLS commands
2729 * to the driver.
2730 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002731 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
2732
2733 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07002734 * wnm_oper - Notify driver of the WNM frame reception
2735 * @priv: Private driver interface data
2736 * @oper: WNM operation. See %enum wnm_oper
2737 * @peer: Destination (peer) MAC address
2738 * @buf: Buffer for the driver to fill in (for getting IE)
2739 * @buf_len: Return the len of buf
2740 * Returns: 0 on success, negative (<0) on failure
2741 */
2742 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2743 u8 *buf, u16 *buf_len);
2744
2745 /**
Dmitry Shmidt051af732013-10-22 13:52:46 -07002746 * set_qos_map - Set QoS Map
2747 * @priv: Private driver interface data
2748 * @qos_map_set: QoS Map
2749 * @qos_map_set_len: Length of QoS Map
2750 */
2751 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2752 u8 qos_map_set_len);
2753
2754 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002755 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
2756 * @priv: Private driver interface data
2757 * @version: IP version of the IP address, 4 or 6
2758 * @ipaddr: IP address for the neigh entry
2759 * @prefixlen: IP address prefix length
2760 * @addr: Corresponding MAC address
2761 * Returns: 0 on success, negative (<0) on failure
2762 */
2763 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
2764 int prefixlen, const u8 *addr);
2765
2766 /**
2767 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
2768 * @priv: Private driver interface data
2769 * @version: IP version of the IP address, 4 or 6
2770 * @ipaddr: IP address for the neigh entry
2771 * Returns: 0 on success, negative (<0) on failure
2772 */
2773 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
2774
2775 /**
2776 * br_port_set_attr - Set a bridge port attribute
2777 * @attr: Bridge port attribute to set
2778 * @val: Value to be set
2779 * Returns: 0 on success, negative (<0) on failure
2780 */
2781 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
2782 unsigned int val);
2783
2784 /**
2785 * br_port_set_attr - Set a bridge network parameter
2786 * @param: Bridge parameter to set
2787 * @val: Value to be set
2788 * Returns: 0 on success, negative (<0) on failure
2789 */
2790 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
2791 unsigned int val);
2792
2793 /**
Dmitry Shmidtb58836e2014-04-29 14:35:56 -07002794 * set_wowlan - Set wake-on-wireless triggers
2795 * @priv: Private driver interface data
2796 * @triggers: wowlan triggers
2797 */
2798 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
2799
2800 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002801 * signal_poll - Get current connection information
2802 * @priv: Private driver interface data
2803 * @signal_info: Connection info structure
Dmitry Shmidt7832adb2014-04-29 10:53:02 -07002804 */
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07002805 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07002806
2807 /**
Jouni Malinen75ecf522011-06-27 15:19:46 -07002808 * set_authmode - Set authentication algorithm(s) for static WEP
2809 * @priv: Private driver interface data
2810 * @authmode: 1=Open System, 2=Shared Key, 3=both
2811 * Returns: 0 on success, -1 on failure
2812 *
2813 * This function can be used to set authentication algorithms for AP
2814 * mode when static WEP is used. If the driver uses user space MLME/SME
2815 * implementation, there is no need to implement this function.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002816 *
2817 * DEPRECATED - use set_ap() instead
Jouni Malinen75ecf522011-06-27 15:19:46 -07002818 */
2819 int (*set_authmode)(void *priv, int authmode);
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08002820
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002821#ifdef ANDROID
Jouni Malinen75ecf522011-06-27 15:19:46 -07002822 /**
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08002823 * driver_cmd - Execute driver-specific command
2824 * @priv: Private driver interface data
2825 * @cmd: Command to execute
2826 * @buf: Return buffer
2827 * @buf_len: Buffer length
Dmitry Shmidtbd567ad2011-05-09 14:17:09 -07002828 * Returns: 0 on success, -1 on failure
2829 */
Dmitry Shmidt292b0c32013-11-22 12:54:42 -08002830 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
2831#endif /* ANDROID */
2832
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002833 /**
Dmitry Shmidta38abf92014-03-06 13:38:44 -08002834 * vendor_cmd - Execute vendor specific command
2835 * @priv: Private driver interface data
2836 * @vendor_id: Vendor id
2837 * @subcmd: Vendor command id
2838 * @data: Vendor command parameters (%NULL if no parameters)
2839 * @data_len: Data length
2840 * @buf: Return buffer (%NULL to ignore reply)
2841 * Returns: 0 on success, negative (<0) on failure
2842 *
2843 * This function handles vendor specific commands that are passed to
2844 * the driver/device. The command is identified by vendor id and
2845 * command id. Parameters can be passed as argument to the command
2846 * in the data buffer. Reply (if any) will be filled in the supplied
2847 * return buffer.
2848 *
2849 * The exact driver behavior is driver interface and vendor specific. As
2850 * an example, this will be converted to a vendor specific cfg80211
2851 * command in case of the nl80211 driver interface.
2852 */
2853 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
2854 unsigned int subcmd, const u8 *data, size_t data_len,
2855 struct wpabuf *buf);
2856
2857 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002858 * set_rekey_info - Set rekey information
2859 * @priv: Private driver interface data
2860 * @kek: Current KEK
2861 * @kck: Current KCK
2862 * @replay_ctr: Current EAPOL-Key Replay Counter
2863 *
2864 * This optional function can be used to provide information for the
2865 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2866 * while the host (including wpa_supplicant) is sleeping.
2867 */
2868 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2869 const u8 *replay_ctr);
2870
2871 /**
2872 * sta_assoc - Station association indication
2873 * @priv: Private driver interface data
2874 * @own_addr: Source address and BSSID for association frame
2875 * @addr: MAC address of the station to associate
2876 * @reassoc: flag to indicate re-association
2877 * @status: association response status code
2878 * @ie: assoc response ie buffer
2879 * @len: ie buffer length
2880 * Returns: 0 on success, -1 on failure
2881 *
2882 * This function indicates the driver to send (Re)Association
2883 * Response frame to the station.
2884 */
2885 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2886 int reassoc, u16 status, const u8 *ie, size_t len);
2887
2888 /**
2889 * sta_auth - Station authentication indication
2890 * @priv: Private driver interface data
2891 * @own_addr: Source address and BSSID for authentication frame
2892 * @addr: MAC address of the station to associate
2893 * @seq: authentication sequence number
2894 * @status: authentication response status code
2895 * @ie: authentication frame ie buffer
2896 * @len: ie buffer length
2897 *
2898 * This function indicates the driver to send Authentication frame
2899 * to the station.
2900 */
2901 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2902 u16 seq, u16 status, const u8 *ie, size_t len);
2903
2904 /**
2905 * add_tspec - Add traffic stream
2906 * @priv: Private driver interface data
2907 * @addr: MAC address of the station to associate
2908 * @tspec_ie: tspec ie buffer
2909 * @tspec_ielen: tspec ie length
2910 * Returns: 0 on success, -1 on failure
2911 *
2912 * This function adds the traffic steam for the station
2913 * and fills the medium_time in tspec_ie.
2914 */
2915 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2916 size_t tspec_ielen);
2917
2918 /**
2919 * add_sta_node - Add a station node in the driver
2920 * @priv: Private driver interface data
2921 * @addr: MAC address of the station to add
2922 * @auth_alg: authentication algorithm used by the station
2923 * Returns: 0 on success, -1 on failure
2924 *
2925 * This function adds the station node in the driver, when
2926 * the station gets added by FT-over-DS.
2927 */
2928 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
2929
2930 /**
2931 * sched_scan - Request the driver to initiate scheduled scan
2932 * @priv: Private driver interface data
2933 * @params: Scan parameters
2934 * @interval: Interval between scan cycles in milliseconds
2935 * Returns: 0 on success, -1 on failure
2936 *
2937 * This operation should be used for scheduled scan offload to
2938 * the hardware. Every time scan results are available, the
2939 * driver should report scan results event for wpa_supplicant
2940 * which will eventually request the results with
2941 * wpa_driver_get_scan_results2(). This operation is optional
2942 * and if not provided or if it returns -1, we fall back to
2943 * normal host-scheduled scans.
2944 */
2945 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2946 u32 interval);
2947
2948 /**
2949 * stop_sched_scan - Request the driver to stop a scheduled scan
2950 * @priv: Private driver interface data
2951 * Returns: 0 on success, -1 on failure
2952 *
2953 * This should cause the scheduled scan to be stopped and
2954 * results should stop being sent. Must be supported if
2955 * sched_scan is supported.
2956 */
2957 int (*stop_sched_scan)(void *priv);
2958
2959 /**
2960 * poll_client - Probe (null data or such) the given station
2961 * @priv: Private driver interface data
2962 * @own_addr: MAC address of sending interface
2963 * @addr: MAC address of the station to probe
2964 * @qos: Indicates whether station is QoS station
2965 *
2966 * This function is used to verify whether an associated station is
2967 * still present. This function does not need to be implemented if the
2968 * driver provides such inactivity polling mechanism.
2969 */
2970 void (*poll_client)(void *priv, const u8 *own_addr,
2971 const u8 *addr, int qos);
Dmitry Shmidt04949592012-07-19 12:16:46 -07002972
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002973 /**
Dmitry Shmidt04949592012-07-19 12:16:46 -07002974 * radio_disable - Disable/enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002975 * @priv: Private driver interface data
Dmitry Shmidt04949592012-07-19 12:16:46 -07002976 * @disabled: 1=disable 0=enable radio
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002977 * Returns: 0 on success, -1 on failure
2978 *
Dmitry Shmidt04949592012-07-19 12:16:46 -07002979 * This optional command is for testing purposes. It can be used to
2980 * disable the radio on a testbed device to simulate out-of-radio-range
2981 * conditions.
2982 */
2983 int (*radio_disable)(void *priv, int disabled);
2984
2985 /**
2986 * switch_channel - Announce channel switch and migrate the GO to the
2987 * given frequency
2988 * @priv: Private driver interface data
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002989 * @settings: Settings for CSA period and new channel
Dmitry Shmidt04949592012-07-19 12:16:46 -07002990 * Returns: 0 on success, -1 on failure
2991 *
2992 * This function is used to move the GO to the legacy STA channel to
2993 * avoid frequency conflict in single channel concurrency.
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08002994 */
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08002995 int (*switch_channel)(void *priv, struct csa_settings *settings);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07002996
2997 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08002998 * add_tx_ts - Add traffic stream
2999 * @priv: Private driver interface data
3000 * @tsid: Traffic stream ID
3001 * @addr: Receiver address
3002 * @user_prio: User priority of the traffic stream
3003 * @admitted_time: Admitted time for this TS in units of
3004 * 32 microsecond periods (per second).
3005 * Returns: 0 on success, -1 on failure
3006 */
3007 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3008 u16 admitted_time);
3009
3010 /**
3011 * del_tx_ts - Delete traffic stream
3012 * @priv: Private driver interface data
3013 * @tsid: Traffic stream ID
3014 * @addr: Receiver address
3015 * Returns: 0 on success, -1 on failure
3016 */
3017 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3018
3019 /**
3020 * Enable channel-switching with TDLS peer
3021 * @priv: Private driver interface data
3022 * @addr: MAC address of the TDLS peer
3023 * @oper_class: Operating class of the switch channel
3024 * @params: Channel specification
3025 * Returns: 0 on success, -1 on failure
3026 *
3027 * The function indicates to driver that it can start switching to a
3028 * different channel with a specified TDLS peer. The switching is
3029 * assumed on until canceled with tdls_disable_channel_switch().
3030 */
3031 int (*tdls_enable_channel_switch)(
3032 void *priv, const u8 *addr, u8 oper_class,
3033 const struct hostapd_freq_params *params);
3034
3035 /**
3036 * Disable channel switching with TDLS peer
3037 * @priv: Private driver interface data
3038 * @addr: MAC address of the TDLS peer
3039 * Returns: 0 on success, -1 on failure
3040 *
3041 * This function indicates to the driver that it should stop switching
3042 * with a given TDLS peer.
3043 */
3044 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3045
3046 /**
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003047 * start_dfs_cac - Listen for radar interference on the channel
3048 * @priv: Private driver interface data
Dmitry Shmidt051af732013-10-22 13:52:46 -07003049 * @freq: Channel parameters
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003050 * Returns: 0 on success, -1 on failure
3051 */
Dmitry Shmidt051af732013-10-22 13:52:46 -07003052 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003053
3054 /**
3055 * stop_ap - Removes beacon from AP
3056 * @priv: Private driver interface data
3057 * Returns: 0 on success, -1 on failure (or if not supported)
3058 *
3059 * This optional function can be used to disable AP mode related
3060 * configuration. Unlike deinit_ap, it does not change to station
3061 * mode.
3062 */
3063 int (*stop_ap)(void *priv);
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003064
3065 /**
3066 * get_survey - Retrieve survey data
3067 * @priv: Private driver interface data
3068 * @freq: If set, survey data for the specified frequency is only
3069 * being requested. If not set, all survey data is requested.
3070 * Returns: 0 on success, -1 on failure
3071 *
3072 * Use this to retrieve:
3073 *
3074 * - the observed channel noise floor
3075 * - the amount of time we have spent on the channel
3076 * - the amount of time during which we have spent on the channel that
3077 * the radio has determined the medium is busy and we cannot
3078 * transmit
3079 * - the amount of time we have spent receiving data
3080 * - the amount of time we have spent transmitting data
3081 *
3082 * This data can be used for spectrum heuristics. One example is
3083 * Automatic Channel Selection (ACS). The channel survey data is
3084 * kept on a linked list on the channel data, one entry is added
3085 * for each survey. The min_nf of the channel is updated for each
3086 * survey.
3087 */
3088 int (*get_survey)(void *priv, unsigned int freq);
Dmitry Shmidt56052862013-10-04 10:23:25 -07003089
3090 /**
3091 * status - Get driver interface status information
3092 * @priv: Private driver interface data
3093 * @buf: Buffer for printing tou the status information
3094 * @buflen: Maximum length of the buffer
3095 * Returns: Length of written status information or -1 on failure
3096 */
3097 int (*status)(void *priv, char *buf, size_t buflen);
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003098
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07003099 /**
3100 * roaming - Set roaming policy for driver-based BSS selection
3101 * @priv: Private driver interface data
3102 * @allowed: Whether roaming within ESS is allowed
3103 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3104 * Returns: Length of written status information or -1 on failure
3105 *
3106 * This optional callback can be used to update roaming policy from the
3107 * associate() command (bssid being set there indicates that the driver
3108 * should not roam before getting this roaming() call to allow roaming.
3109 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3110 * capability, roaming policy is handled within wpa_supplicant and there
3111 * is no need to implement or react to this callback.
3112 */
3113 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3114
3115 /**
3116 * set_mac_addr - Set MAC address
3117 * @priv: Private driver interface data
3118 * @addr: MAC address to use or %NULL for setting back to permanent
3119 * Returns: 0 on success, -1 on failure
3120 */
3121 int (*set_mac_addr)(void *priv, const u8 *addr);
3122
Dmitry Shmidt5a1480c2014-05-12 09:46:02 -07003123#ifdef CONFIG_MACSEC
3124 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3125
3126 int (*macsec_deinit)(void *priv);
3127
3128 /**
3129 * enable_protect_frames - Set protect frames status
3130 * @priv: Private driver interface data
3131 * @enabled: TRUE = protect frames enabled
3132 * FALSE = protect frames disabled
3133 * Returns: 0 on success, -1 on failure (or if not supported)
3134 */
3135 int (*enable_protect_frames)(void *priv, Boolean enabled);
3136
3137 /**
3138 * set_replay_protect - Set replay protect status and window size
3139 * @priv: Private driver interface data
3140 * @enabled: TRUE = replay protect enabled
3141 * FALSE = replay protect disabled
3142 * @window: replay window size, valid only when replay protect enabled
3143 * Returns: 0 on success, -1 on failure (or if not supported)
3144 */
3145 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3146
3147 /**
3148 * set_current_cipher_suite - Set current cipher suite
3149 * @priv: Private driver interface data
3150 * @cs: EUI64 identifier
3151 * @cs_len: Length of the cs buffer in octets
3152 * Returns: 0 on success, -1 on failure (or if not supported)
3153 */
3154 int (*set_current_cipher_suite)(void *priv, const u8 *cs,
3155 size_t cs_len);
3156
3157 /**
3158 * enable_controlled_port - Set controlled port status
3159 * @priv: Private driver interface data
3160 * @enabled: TRUE = controlled port enabled
3161 * FALSE = controlled port disabled
3162 * Returns: 0 on success, -1 on failure (or if not supported)
3163 */
3164 int (*enable_controlled_port)(void *priv, Boolean enabled);
3165
3166 /**
3167 * get_receive_lowest_pn - Get receive lowest pn
3168 * @priv: Private driver interface data
3169 * @channel: secure channel
3170 * @an: association number
3171 * @lowest_pn: lowest accept pn
3172 * Returns: 0 on success, -1 on failure (or if not supported)
3173 */
3174 int (*get_receive_lowest_pn)(void *priv, u32 channel, u8 an,
3175 u32 *lowest_pn);
3176
3177 /**
3178 * get_transmit_next_pn - Get transmit next pn
3179 * @priv: Private driver interface data
3180 * @channel: secure channel
3181 * @an: association number
3182 * @next_pn: next pn
3183 * Returns: 0 on success, -1 on failure (or if not supported)
3184 */
3185 int (*get_transmit_next_pn)(void *priv, u32 channel, u8 an,
3186 u32 *next_pn);
3187
3188 /**
3189 * set_transmit_next_pn - Set transmit next pn
3190 * @priv: Private driver interface data
3191 * @channel: secure channel
3192 * @an: association number
3193 * @next_pn: next pn
3194 * Returns: 0 on success, -1 on failure (or if not supported)
3195 */
3196 int (*set_transmit_next_pn)(void *priv, u32 channel, u8 an,
3197 u32 next_pn);
3198
3199 /**
3200 * get_available_receive_sc - get available receive channel
3201 * @priv: Private driver interface data
3202 * @channel: secure channel
3203 * Returns: 0 on success, -1 on failure (or if not supported)
3204 */
3205 int (*get_available_receive_sc)(void *priv, u32 *channel);
3206
3207 /**
3208 * create_receive_sc - create secure channel for receiving
3209 * @priv: Private driver interface data
3210 * @channel: secure channel
3211 * @sci_addr: secure channel identifier - address
3212 * @sci_port: secure channel identifier - port
3213 * @conf_offset: confidentiality offset (0, 30, or 50)
3214 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3215 * 2 = Strict)
3216 * Returns: 0 on success, -1 on failure (or if not supported)
3217 */
3218 int (*create_receive_sc)(void *priv, u32 channel, const u8 *sci_addr,
3219 u16 sci_port, unsigned int conf_offset,
3220 int validation);
3221
3222 /**
3223 * delete_receive_sc - delete secure connection for receiving
3224 * @priv: private driver interface data from init()
3225 * @channel: secure channel
3226 * Returns: 0 on success, -1 on failure
3227 */
3228 int (*delete_receive_sc)(void *priv, u32 channel);
3229
3230 /**
3231 * create_receive_sa - create secure association for receive
3232 * @priv: private driver interface data from init()
3233 * @channel: secure channel
3234 * @an: association number
3235 * @lowest_pn: the lowest packet number can be received
3236 * @sak: the secure association key
3237 * Returns: 0 on success, -1 on failure
3238 */
3239 int (*create_receive_sa)(void *priv, u32 channel, u8 an,
3240 u32 lowest_pn, const u8 *sak);
3241
3242 /**
3243 * enable_receive_sa - enable the SA for receive
3244 * @priv: private driver interface data from init()
3245 * @channel: secure channel
3246 * @an: association number
3247 * Returns: 0 on success, -1 on failure
3248 */
3249 int (*enable_receive_sa)(void *priv, u32 channel, u8 an);
3250
3251 /**
3252 * disable_receive_sa - disable SA for receive
3253 * @priv: private driver interface data from init()
3254 * @channel: secure channel index
3255 * @an: association number
3256 * Returns: 0 on success, -1 on failure
3257 */
3258 int (*disable_receive_sa)(void *priv, u32 channel, u8 an);
3259
3260 /**
3261 * get_available_transmit_sc - get available transmit channel
3262 * @priv: Private driver interface data
3263 * @channel: secure channel
3264 * Returns: 0 on success, -1 on failure (or if not supported)
3265 */
3266 int (*get_available_transmit_sc)(void *priv, u32 *channel);
3267
3268 /**
3269 * create_transmit_sc - create secure connection for transmit
3270 * @priv: private driver interface data from init()
3271 * @channel: secure channel
3272 * @sci_addr: secure channel identifier - address
3273 * @sci_port: secure channel identifier - port
3274 * Returns: 0 on success, -1 on failure
3275 */
3276 int (*create_transmit_sc)(void *priv, u32 channel, const u8 *sci_addr,
3277 u16 sci_port, unsigned int conf_offset);
3278
3279 /**
3280 * delete_transmit_sc - delete secure connection for transmit
3281 * @priv: private driver interface data from init()
3282 * @channel: secure channel
3283 * Returns: 0 on success, -1 on failure
3284 */
3285 int (*delete_transmit_sc)(void *priv, u32 channel);
3286
3287 /**
3288 * create_transmit_sa - create secure association for transmit
3289 * @priv: private driver interface data from init()
3290 * @channel: secure channel index
3291 * @an: association number
3292 * @next_pn: the packet number used as next transmit packet
3293 * @confidentiality: True if the SA is to provide confidentiality
3294 * as well as integrity
3295 * @sak: the secure association key
3296 * Returns: 0 on success, -1 on failure
3297 */
3298 int (*create_transmit_sa)(void *priv, u32 channel, u8 an, u32 next_pn,
3299 Boolean confidentiality, const u8 *sak);
3300
3301 /**
3302 * enable_transmit_sa - enable SA for transmit
3303 * @priv: private driver interface data from init()
3304 * @channel: secure channel
3305 * @an: association number
3306 * Returns: 0 on success, -1 on failure
3307 */
3308 int (*enable_transmit_sa)(void *priv, u32 channel, u8 an);
3309
3310 /**
3311 * disable_transmit_sa - disable SA for transmit
3312 * @priv: private driver interface data from init()
3313 * @channel: secure channel
3314 * @an: association number
3315 * Returns: 0 on success, -1 on failure
3316 */
3317 int (*disable_transmit_sa)(void *priv, u32 channel, u8 an);
3318#endif /* CONFIG_MACSEC */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003319
3320 /**
3321 * init_mesh - Driver specific initialization for mesh
3322 * @priv: Private driver interface data
3323 * Returns: 0 on success, -1 on failure
3324 */
3325 int (*init_mesh)(void *priv);
3326
3327 /**
3328 * join_mesh - Join a mesh network
3329 * @priv: Private driver interface data
3330 * @params: Mesh configuration parameters
3331 * Returns: 0 on success, -1 on failure
3332 */
3333 int (*join_mesh)(void *priv,
3334 struct wpa_driver_mesh_join_params *params);
3335
3336 /**
3337 * leave_mesh - Leave a mesh network
3338 * @priv: Private driver interface data
3339 * Returns 0 on success, -1 on failure
3340 */
3341 int (*leave_mesh)(void *priv);
3342
3343 /**
3344 * do_acs - Automatically select channel
3345 * @priv: Private driver interface data
3346 * @params: Parameters for ACS
3347 * Returns 0 on success, -1 on failure
3348 *
3349 * This command can be used to offload ACS to the driver if the driver
3350 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3351 */
3352 int (*do_acs)(void *priv, struct drv_acs_params *params);
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003353};
3354
3355
3356/**
3357 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
3358 */
3359enum wpa_event_type {
3360 /**
3361 * EVENT_ASSOC - Association completed
3362 *
3363 * This event needs to be delivered when the driver completes IEEE
3364 * 802.11 association or reassociation successfully.
3365 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
3366 * after this event has been generated. In addition, optional
3367 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
3368 * more information about the association. If the driver interface gets
3369 * both of these events at the same time, it can also include the
3370 * assoc_info data in EVENT_ASSOC call.
3371 */
3372 EVENT_ASSOC,
3373
3374 /**
3375 * EVENT_DISASSOC - Association lost
3376 *
3377 * This event should be called when association is lost either due to
3378 * receiving deauthenticate or disassociate frame from the AP or when
3379 * sending either of these frames to the current AP. If the driver
3380 * supports separate deauthentication event, EVENT_DISASSOC should only
3381 * be used for disassociation and EVENT_DEAUTH for deauthentication.
3382 * In AP mode, union wpa_event_data::disassoc_info is required.
3383 */
3384 EVENT_DISASSOC,
3385
3386 /**
3387 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
3388 *
3389 * This event must be delivered when a Michael MIC error is detected by
3390 * the local driver. Additional data for event processing is
3391 * provided with union wpa_event_data::michael_mic_failure. This
3392 * information is used to request new encyption key and to initiate
3393 * TKIP countermeasures if needed.
3394 */
3395 EVENT_MICHAEL_MIC_FAILURE,
3396
3397 /**
3398 * EVENT_SCAN_RESULTS - Scan results available
3399 *
3400 * This event must be called whenever scan results are available to be
3401 * fetched with struct wpa_driver_ops::get_scan_results(). This event
3402 * is expected to be used some time after struct wpa_driver_ops::scan()
3403 * is called. If the driver provides an unsolicited event when the scan
3404 * has been completed, this event can be used to trigger
3405 * EVENT_SCAN_RESULTS call. If such event is not available from the
3406 * driver, the driver wrapper code is expected to use a registered
3407 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
3408 * scan is expected to be completed. Optional information about
3409 * completed scan can be provided with union wpa_event_data::scan_info.
3410 */
3411 EVENT_SCAN_RESULTS,
3412
3413 /**
3414 * EVENT_ASSOCINFO - Report optional extra information for association
3415 *
3416 * This event can be used to report extra association information for
3417 * EVENT_ASSOC processing. This extra information includes IEs from
3418 * association frames and Beacon/Probe Response frames in union
3419 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
3420 * EVENT_ASSOC. Alternatively, the driver interface can include
3421 * assoc_info data in the EVENT_ASSOC call if it has all the
3422 * information available at the same point.
3423 */
3424 EVENT_ASSOCINFO,
3425
3426 /**
3427 * EVENT_INTERFACE_STATUS - Report interface status changes
3428 *
3429 * This optional event can be used to report changes in interface
3430 * status (interface added/removed) using union
3431 * wpa_event_data::interface_status. This can be used to trigger
3432 * wpa_supplicant to stop and re-start processing for the interface,
3433 * e.g., when a cardbus card is ejected/inserted.
3434 */
3435 EVENT_INTERFACE_STATUS,
3436
3437 /**
3438 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
3439 *
3440 * This event can be used to inform wpa_supplicant about candidates for
3441 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
3442 * for scan request (ap_scan=2 mode), this event is required for
3443 * pre-authentication. If wpa_supplicant is performing scan request
3444 * (ap_scan=1), this event is optional since scan results can be used
3445 * to add pre-authentication candidates. union
3446 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
3447 * candidate and priority of the candidate, e.g., based on the signal
3448 * strength, in order to try to pre-authenticate first with candidates
3449 * that are most likely targets for re-association.
3450 *
3451 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
3452 * on the candidate list. In addition, it can be called for the current
3453 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
3454 * will automatically skip pre-authentication in cases where a valid
3455 * PMKSA exists. When more than one candidate exists, this event should
3456 * be generated once for each candidate.
3457 *
3458 * Driver will be notified about successful pre-authentication with
3459 * struct wpa_driver_ops::add_pmkid() calls.
3460 */
3461 EVENT_PMKID_CANDIDATE,
3462
3463 /**
3464 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
3465 *
3466 * This event can be used to inform wpa_supplicant about desire to set
3467 * up secure direct link connection between two stations as defined in
3468 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
3469 * STAKey negotiation. The caller will need to set peer address for the
3470 * event.
3471 */
3472 EVENT_STKSTART,
3473
3474 /**
3475 * EVENT_TDLS - Request TDLS operation
3476 *
3477 * This event can be used to request a TDLS operation to be performed.
3478 */
3479 EVENT_TDLS,
3480
3481 /**
3482 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
3483 *
3484 * The driver is expected to report the received FT IEs from
3485 * FT authentication sequence from the AP. The FT IEs are included in
3486 * the extra information in union wpa_event_data::ft_ies.
3487 */
3488 EVENT_FT_RESPONSE,
3489
3490 /**
3491 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
3492 *
3493 * The driver can use this event to inform wpa_supplicant about a STA
3494 * in an IBSS with which protected frames could be exchanged. This
3495 * event starts RSN authentication with the other STA to authenticate
3496 * the STA and set up encryption keys with it.
3497 */
3498 EVENT_IBSS_RSN_START,
3499
3500 /**
3501 * EVENT_AUTH - Authentication result
3502 *
3503 * This event should be called when authentication attempt has been
3504 * completed. This is only used if the driver supports separate
3505 * authentication step (struct wpa_driver_ops::authenticate).
3506 * Information about authentication result is included in
3507 * union wpa_event_data::auth.
3508 */
3509 EVENT_AUTH,
3510
3511 /**
3512 * EVENT_DEAUTH - Authentication lost
3513 *
3514 * This event should be called when authentication is lost either due
3515 * to receiving deauthenticate frame from the AP or when sending that
3516 * frame to the current AP.
3517 * In AP mode, union wpa_event_data::deauth_info is required.
3518 */
3519 EVENT_DEAUTH,
3520
3521 /**
3522 * EVENT_ASSOC_REJECT - Association rejected
3523 *
3524 * This event should be called when (re)association attempt has been
3525 * rejected by the AP. Information about the association response is
3526 * included in union wpa_event_data::assoc_reject.
3527 */
3528 EVENT_ASSOC_REJECT,
3529
3530 /**
3531 * EVENT_AUTH_TIMED_OUT - Authentication timed out
3532 */
3533 EVENT_AUTH_TIMED_OUT,
3534
3535 /**
3536 * EVENT_ASSOC_TIMED_OUT - Association timed out
3537 */
3538 EVENT_ASSOC_TIMED_OUT,
3539
3540 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003541 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
3542 */
3543 EVENT_WPS_BUTTON_PUSHED,
3544
3545 /**
3546 * EVENT_TX_STATUS - Report TX status
3547 */
3548 EVENT_TX_STATUS,
3549
3550 /**
3551 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3552 */
3553 EVENT_RX_FROM_UNKNOWN,
3554
3555 /**
3556 * EVENT_RX_MGMT - Report RX of a management frame
3557 */
3558 EVENT_RX_MGMT,
3559
3560 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003561 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3562 *
3563 * This event is used to indicate when the driver has started the
3564 * requested remain-on-channel duration. Information about the
3565 * operation is included in union wpa_event_data::remain_on_channel.
3566 */
3567 EVENT_REMAIN_ON_CHANNEL,
3568
3569 /**
3570 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3571 *
3572 * This event is used to indicate when the driver has completed
3573 * remain-on-channel duration, i.e., may noot be available on the
3574 * requested channel anymore. Information about the
3575 * operation is included in union wpa_event_data::remain_on_channel.
3576 */
3577 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3578
3579 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003580 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3581 *
3582 * This event is used to indicate when a Probe Request frame has been
3583 * received. Information about the received frame is included in
3584 * union wpa_event_data::rx_probe_req. The driver is required to report
3585 * these events only after successfully completed probe_req_report()
3586 * commands to request the events (i.e., report parameter is non-zero)
3587 * in station mode. In AP mode, Probe Request frames should always be
3588 * reported.
3589 */
3590 EVENT_RX_PROBE_REQ,
3591
3592 /**
3593 * EVENT_NEW_STA - New wired device noticed
3594 *
3595 * This event is used to indicate that a new device has been detected
3596 * in a network that does not use association-like functionality (i.e.,
3597 * mainly wired Ethernet). This can be used to start EAPOL
3598 * authenticator when receiving a frame from a device. The address of
3599 * the device is included in union wpa_event_data::new_sta.
3600 */
3601 EVENT_NEW_STA,
3602
3603 /**
3604 * EVENT_EAPOL_RX - Report received EAPOL frame
3605 *
3606 * When in AP mode with hostapd, this event is required to be used to
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003607 * deliver the receive EAPOL frames from the driver.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003608 */
3609 EVENT_EAPOL_RX,
3610
3611 /**
3612 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3613 *
3614 * This event is used to indicate changes in the signal strength
3615 * observed in frames received from the current AP if signal strength
3616 * monitoring has been enabled with signal_monitor().
3617 */
3618 EVENT_SIGNAL_CHANGE,
3619
3620 /**
3621 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3622 *
3623 * This event is used to indicate that the interface was enabled after
3624 * having been previously disabled, e.g., due to rfkill.
3625 */
3626 EVENT_INTERFACE_ENABLED,
3627
3628 /**
3629 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3630 *
3631 * This event is used to indicate that the interface was disabled,
3632 * e.g., due to rfkill.
3633 */
3634 EVENT_INTERFACE_DISABLED,
3635
3636 /**
3637 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3638 *
3639 * This event is used to indicate that the channel list has changed,
3640 * e.g., because of a regulatory domain change triggered by scan
3641 * results including an AP advertising a country code.
3642 */
3643 EVENT_CHANNEL_LIST_CHANGED,
3644
3645 /**
3646 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3647 *
3648 * This event is used to indicate that the driver cannot maintain this
3649 * interface in its operation mode anymore. The most likely use for
3650 * this is to indicate that AP mode operation is not available due to
3651 * operating channel would need to be changed to a DFS channel when
3652 * the driver does not support radar detection and another virtual
3653 * interfaces caused the operating channel to change. Other similar
3654 * resource conflicts could also trigger this for station mode
Dmitry Shmidtd30ac602014-06-30 09:54:22 -07003655 * interfaces. This event can be propagated when channel switching
3656 * fails.
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003657 */
3658 EVENT_INTERFACE_UNAVAILABLE,
3659
3660 /**
3661 * EVENT_BEST_CHANNEL
3662 *
3663 * Driver generates this event whenever it detects a better channel
3664 * (e.g., based on RSSI or channel use). This information can be used
3665 * to improve channel selection for a new AP/P2P group.
3666 */
3667 EVENT_BEST_CHANNEL,
3668
3669 /**
3670 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3671 *
3672 * This event should be called when a Deauthentication frame is dropped
3673 * due to it not being protected (MFP/IEEE 802.11w).
3674 * union wpa_event_data::unprot_deauth is required to provide more
3675 * details of the frame.
3676 */
3677 EVENT_UNPROT_DEAUTH,
3678
3679 /**
3680 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3681 *
3682 * This event should be called when a Disassociation frame is dropped
3683 * due to it not being protected (MFP/IEEE 802.11w).
3684 * union wpa_event_data::unprot_disassoc is required to provide more
3685 * details of the frame.
3686 */
3687 EVENT_UNPROT_DISASSOC,
3688
3689 /**
3690 * EVENT_STATION_LOW_ACK
3691 *
3692 * Driver generates this event whenever it detected that a particular
3693 * station was lost. Detection can be through massive transmission
3694 * failures for example.
3695 */
3696 EVENT_STATION_LOW_ACK,
3697
3698 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003699 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3700 */
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08003701 EVENT_IBSS_PEER_LOST,
3702
3703 /**
3704 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3705 *
3706 * This event carries the new replay counter to notify wpa_supplicant
3707 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3708 * completed Group Key Handshake while the host (including
3709 * wpa_supplicant was sleeping).
3710 */
3711 EVENT_DRIVER_GTK_REKEY,
3712
3713 /**
3714 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3715 */
3716 EVENT_SCHED_SCAN_STOPPED,
3717
3718 /**
3719 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3720 *
3721 * This event indicates that the station responded to the poll
3722 * initiated with @poll_client.
3723 */
3724 EVENT_DRIVER_CLIENT_POLL_OK,
3725
3726 /**
3727 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3728 */
Dmitry Shmidt04949592012-07-19 12:16:46 -07003729 EVENT_EAPOL_TX_STATUS,
3730
3731 /**
3732 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3733 *
3734 * Described in wpa_event_data.ch_switch
3735 * */
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07003736 EVENT_CH_SWITCH,
3737
3738 /**
3739 * EVENT_WNM - Request WNM operation
3740 *
3741 * This event can be used to request a WNM operation to be performed.
3742 */
Dmitry Shmidtf8623282013-02-20 14:34:59 -08003743 EVENT_WNM,
3744
3745 /**
3746 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3747 *
3748 * This event indicates that the driver reported a connection failure
3749 * with the specified client (for example, max client reached, etc.) in
3750 * AP mode.
3751 */
Dmitry Shmidtea69e842013-05-13 14:52:28 -07003752 EVENT_CONNECT_FAILED_REASON,
3753
3754 /**
3755 * EVENT_RADAR_DETECTED - Notify of radar detection
3756 *
3757 * A radar has been detected on the supplied frequency, hostapd should
3758 * react accordingly (e.g., change channel).
3759 */
3760 EVENT_DFS_RADAR_DETECTED,
3761
3762 /**
3763 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3764 *
3765 * After a successful CAC, the channel can be marked clear and used.
3766 */
3767 EVENT_DFS_CAC_FINISHED,
3768
3769 /**
3770 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3771 *
3772 * The CAC was not successful, and the channel remains in the previous
3773 * state. This may happen due to a radar beeing detected or other
3774 * external influences.
3775 */
3776 EVENT_DFS_CAC_ABORTED,
3777
3778 /**
3779 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3780 *
3781 * The channel which was previously unavailable is now available again.
3782 */
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003783 EVENT_DFS_NOP_FINISHED,
3784
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08003785 /**
3786 * EVENT_SURVEY - Received survey data
3787 *
3788 * This event gets triggered when a driver query is issued for survey
3789 * data and the requested data becomes available. The returned data is
3790 * stored in struct survey_results. The results provide at most one
3791 * survey entry for each frequency and at minimum will provide one
3792 * survey entry for one frequency. The survey data can be os_malloc()'d
3793 * and then os_free()'d, so the event callback must only copy data.
3794 */
3795 EVENT_SURVEY,
3796
3797 /**
3798 * EVENT_SCAN_STARTED - Scan started
3799 *
3800 * This indicates that driver has started a scan operation either based
3801 * on a request from wpa_supplicant/hostapd or from another application.
3802 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
3803 * completed (either successfully or by getting cancelled).
3804 */
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08003805 EVENT_SCAN_STARTED,
3806
3807 /**
3808 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
3809 *
3810 * This event indicates a set of frequency ranges that should be avoided
3811 * to reduce issues due to interference or internal co-existence
3812 * information in the driver.
3813 */
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003814 EVENT_AVOID_FREQUENCIES,
3815
3816 /**
3817 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
3818 */
3819 EVENT_NEW_PEER_CANDIDATE,
3820
3821 /**
3822 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
3823 *
3824 * Indicates a pair of primary and secondary channels chosen by ACS
3825 * in device.
3826 */
3827 EVENT_ACS_CHANNEL_SELECTED,
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003828};
3829
3830
3831/**
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07003832 * struct freq_survey - Channel survey info
3833 *
3834 * @ifidx: Interface index in which this survey was observed
3835 * @freq: Center of frequency of the surveyed channel
3836 * @nf: Channel noise floor in dBm
3837 * @channel_time: Amount of time in ms the radio spent on the channel
3838 * @channel_time_busy: Amount of time in ms the radio detected some signal
3839 * that indicated to the radio the channel was not clear
3840 * @channel_time_rx: Amount of time the radio spent receiving data
3841 * @channel_time_tx: Amount of time the radio spent transmitting data
3842 * @filled: bitmask indicating which fields have been reported, see
3843 * SURVEY_HAS_* defines.
3844 * @list: Internal list pointers
3845 */
3846struct freq_survey {
3847 u32 ifidx;
3848 unsigned int freq;
3849 s8 nf;
3850 u64 channel_time;
3851 u64 channel_time_busy;
3852 u64 channel_time_rx;
3853 u64 channel_time_tx;
3854 unsigned int filled;
3855 struct dl_list list;
3856};
3857
3858#define SURVEY_HAS_NF BIT(0)
3859#define SURVEY_HAS_CHAN_TIME BIT(1)
3860#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3861#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3862#define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3863
3864
3865/**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003866 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3867 */
3868union wpa_event_data {
3869 /**
3870 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3871 *
3872 * This structure is optional for EVENT_ASSOC calls and required for
3873 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3874 * driver interface does not need to generate separate EVENT_ASSOCINFO
3875 * calls.
3876 */
3877 struct assoc_info {
3878 /**
3879 * reassoc - Flag to indicate association or reassociation
3880 */
3881 int reassoc;
3882
3883 /**
3884 * req_ies - (Re)Association Request IEs
3885 *
3886 * If the driver generates WPA/RSN IE, this event data must be
3887 * returned for WPA handshake to have needed information. If
3888 * wpa_supplicant-generated WPA/RSN IE is used, this
3889 * information event is optional.
3890 *
3891 * This should start with the first IE (fixed fields before IEs
3892 * are not included).
3893 */
3894 const u8 *req_ies;
3895
3896 /**
3897 * req_ies_len - Length of req_ies in bytes
3898 */
3899 size_t req_ies_len;
3900
3901 /**
3902 * resp_ies - (Re)Association Response IEs
3903 *
3904 * Optional association data from the driver. This data is not
3905 * required WPA, but may be useful for some protocols and as
3906 * such, should be reported if this is available to the driver
3907 * interface.
3908 *
3909 * This should start with the first IE (fixed fields before IEs
3910 * are not included).
3911 */
3912 const u8 *resp_ies;
3913
3914 /**
3915 * resp_ies_len - Length of resp_ies in bytes
3916 */
3917 size_t resp_ies_len;
3918
3919 /**
3920 * beacon_ies - Beacon or Probe Response IEs
3921 *
3922 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3923 * Probe Response frames from the current AP (i.e., the one
3924 * that the client just associated with). This information is
3925 * used to update WPA/RSN IE for the AP. If this field is not
3926 * set, the results from previous scan will be used. If no
3927 * data for the new AP is found, scan results will be requested
3928 * again (without scan request). At this point, the driver is
3929 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3930 * used).
3931 *
3932 * This should start with the first IE (fixed fields before IEs
3933 * are not included).
3934 */
3935 const u8 *beacon_ies;
3936
3937 /**
3938 * beacon_ies_len - Length of beacon_ies */
3939 size_t beacon_ies_len;
3940
3941 /**
3942 * freq - Frequency of the operational channel in MHz
3943 */
3944 unsigned int freq;
3945
3946 /**
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003947 * wmm_params - WMM parameters used in this association.
3948 */
3949 struct wmm_params wmm_params;
3950
3951 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07003952 * addr - Station address (for AP mode)
3953 */
3954 const u8 *addr;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08003955
3956 /**
3957 * The following is the key management offload information
3958 * @authorized
3959 * @key_replay_ctr
3960 * @key_replay_ctr_len
3961 * @ptk_kck
3962 * @ptk_kek_len
3963 * @ptk_kek
3964 * @ptk_kek_len
3965 */
3966
3967 /**
3968 * authorized - Status of key management offload,
3969 * 1 = successful
3970 */
3971 int authorized;
3972
3973 /**
3974 * key_replay_ctr - Key replay counter value last used
3975 * in a valid EAPOL-Key frame
3976 */
3977 const u8 *key_replay_ctr;
3978
3979 /**
3980 * key_replay_ctr_len - The length of key_replay_ctr
3981 */
3982 size_t key_replay_ctr_len;
3983
3984 /**
3985 * ptk_kck - The derived PTK KCK
3986 */
3987 const u8 *ptk_kck;
3988
3989 /**
3990 * ptk_kek_len - The length of ptk_kck
3991 */
3992 size_t ptk_kck_len;
3993
3994 /**
3995 * ptk_kek - The derived PTK KEK
3996 */
3997 const u8 *ptk_kek;
3998
3999 /**
4000 * ptk_kek_len - The length of ptk_kek
4001 */
4002 size_t ptk_kek_len;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004003 } assoc_info;
4004
4005 /**
4006 * struct disassoc_info - Data for EVENT_DISASSOC events
4007 */
4008 struct disassoc_info {
4009 /**
4010 * addr - Station address (for AP mode)
4011 */
4012 const u8 *addr;
4013
4014 /**
4015 * reason_code - Reason Code (host byte order) used in
4016 * Deauthentication frame
4017 */
4018 u16 reason_code;
4019
4020 /**
4021 * ie - Optional IE(s) in Disassociation frame
4022 */
4023 const u8 *ie;
4024
4025 /**
4026 * ie_len - Length of ie buffer in octets
4027 */
4028 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08004029
4030 /**
4031 * locally_generated - Whether the frame was locally generated
4032 */
4033 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004034 } disassoc_info;
4035
4036 /**
4037 * struct deauth_info - Data for EVENT_DEAUTH events
4038 */
4039 struct deauth_info {
4040 /**
4041 * addr - Station address (for AP mode)
4042 */
4043 const u8 *addr;
4044
4045 /**
4046 * reason_code - Reason Code (host byte order) used in
4047 * Deauthentication frame
4048 */
4049 u16 reason_code;
4050
4051 /**
4052 * ie - Optional IE(s) in Deauthentication frame
4053 */
4054 const u8 *ie;
4055
4056 /**
4057 * ie_len - Length of ie buffer in octets
4058 */
4059 size_t ie_len;
Dmitry Shmidtc5ec7f52012-03-06 16:33:24 -08004060
4061 /**
4062 * locally_generated - Whether the frame was locally generated
4063 */
4064 int locally_generated;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004065 } deauth_info;
4066
4067 /**
4068 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
4069 */
4070 struct michael_mic_failure {
4071 int unicast;
4072 const u8 *src;
4073 } michael_mic_failure;
4074
4075 /**
4076 * struct interface_status - Data for EVENT_INTERFACE_STATUS
4077 */
4078 struct interface_status {
4079 char ifname[100];
4080 enum {
4081 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
4082 } ievent;
4083 } interface_status;
4084
4085 /**
4086 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
4087 */
4088 struct pmkid_candidate {
4089 /** BSSID of the PMKID candidate */
4090 u8 bssid[ETH_ALEN];
4091 /** Smaller the index, higher the priority */
4092 int index;
4093 /** Whether RSN IE includes pre-authenticate flag */
4094 int preauth;
4095 } pmkid_candidate;
4096
4097 /**
4098 * struct stkstart - Data for EVENT_STKSTART
4099 */
4100 struct stkstart {
4101 u8 peer[ETH_ALEN];
4102 } stkstart;
4103
4104 /**
4105 * struct tdls - Data for EVENT_TDLS
4106 */
4107 struct tdls {
4108 u8 peer[ETH_ALEN];
4109 enum {
4110 TDLS_REQUEST_SETUP,
4111 TDLS_REQUEST_TEARDOWN
4112 } oper;
4113 u16 reason_code; /* for teardown */
4114 } tdls;
4115
4116 /**
Dmitry Shmidt61d9df32012-08-29 16:22:06 -07004117 * struct wnm - Data for EVENT_WNM
4118 */
4119 struct wnm {
4120 u8 addr[ETH_ALEN];
4121 enum {
4122 WNM_OPER_SLEEP,
4123 } oper;
4124 enum {
4125 WNM_SLEEP_ENTER,
4126 WNM_SLEEP_EXIT
4127 } sleep_action;
4128 int sleep_intval;
4129 u16 reason_code;
4130 u8 *buf;
4131 u16 buf_len;
4132 } wnm;
4133
4134 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004135 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
4136 *
4137 * During FT (IEEE 802.11r) authentication sequence, the driver is
4138 * expected to use this event to report received FT IEs (MDIE, FTIE,
4139 * RSN IE, TIE, possible resource request) to the supplicant. The FT
4140 * IEs for the next message will be delivered through the
4141 * struct wpa_driver_ops::update_ft_ies() callback.
4142 */
4143 struct ft_ies {
4144 const u8 *ies;
4145 size_t ies_len;
4146 int ft_action;
4147 u8 target_ap[ETH_ALEN];
4148 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
4149 const u8 *ric_ies;
4150 /** Length of ric_ies buffer in octets */
4151 size_t ric_ies_len;
4152 } ft_ies;
4153
4154 /**
4155 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
4156 */
4157 struct ibss_rsn_start {
4158 u8 peer[ETH_ALEN];
4159 } ibss_rsn_start;
4160
4161 /**
4162 * struct auth_info - Data for EVENT_AUTH events
4163 */
4164 struct auth_info {
4165 u8 peer[ETH_ALEN];
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004166 u8 bssid[ETH_ALEN];
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004167 u16 auth_type;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004168 u16 auth_transaction;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004169 u16 status_code;
4170 const u8 *ies;
4171 size_t ies_len;
4172 } auth;
4173
4174 /**
4175 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
4176 */
4177 struct assoc_reject {
4178 /**
4179 * bssid - BSSID of the AP that rejected association
4180 */
4181 const u8 *bssid;
4182
4183 /**
4184 * resp_ies - (Re)Association Response IEs
4185 *
4186 * Optional association data from the driver. This data is not
4187 * required WPA, but may be useful for some protocols and as
4188 * such, should be reported if this is available to the driver
4189 * interface.
4190 *
4191 * This should start with the first IE (fixed fields before IEs
4192 * are not included).
4193 */
4194 const u8 *resp_ies;
4195
4196 /**
4197 * resp_ies_len - Length of resp_ies in bytes
4198 */
4199 size_t resp_ies_len;
4200
4201 /**
4202 * status_code - Status Code from (Re)association Response
4203 */
4204 u16 status_code;
4205 } assoc_reject;
4206
4207 struct timeout_event {
4208 u8 addr[ETH_ALEN];
4209 } timeout_event;
4210
4211 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004212 * struct tx_status - Data for EVENT_TX_STATUS events
4213 */
4214 struct tx_status {
4215 u16 type;
4216 u16 stype;
4217 const u8 *dst;
4218 const u8 *data;
4219 size_t data_len;
4220 int ack;
4221 } tx_status;
4222
4223 /**
4224 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
4225 */
4226 struct rx_from_unknown {
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004227 const u8 *bssid;
4228 const u8 *addr;
4229 int wds;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004230 } rx_from_unknown;
4231
4232 /**
4233 * struct rx_mgmt - Data for EVENT_RX_MGMT events
4234 */
4235 struct rx_mgmt {
4236 const u8 *frame;
4237 size_t frame_len;
4238 u32 datarate;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004239
4240 /**
Dmitry Shmidt98660862014-03-11 17:26:21 -07004241 * drv_priv - Pointer to store driver private BSS information
4242 *
4243 * If not set to NULL, this is used for comparison with
4244 * hostapd_data->drv_priv to determine which BSS should process
4245 * the frame.
4246 */
4247 void *drv_priv;
4248
4249 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004250 * freq - Frequency (in MHz) on which the frame was received
4251 */
4252 int freq;
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08004253
4254 /**
4255 * ssi_signal - Signal strength in dBm (or 0 if not available)
4256 */
4257 int ssi_signal;
4258 } rx_mgmt;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004259
4260 /**
4261 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
4262 *
4263 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
4264 */
4265 struct remain_on_channel {
4266 /**
4267 * freq - Channel frequency in MHz
4268 */
4269 unsigned int freq;
4270
4271 /**
4272 * duration - Duration to remain on the channel in milliseconds
4273 */
4274 unsigned int duration;
4275 } remain_on_channel;
4276
4277 /**
4278 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
4279 * @aborted: Whether the scan was aborted
4280 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
4281 * @num_freqs: Number of entries in freqs array
4282 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
4283 * SSID)
4284 * @num_ssids: Number of entries in ssids array
4285 */
4286 struct scan_info {
4287 int aborted;
4288 const int *freqs;
4289 size_t num_freqs;
4290 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
4291 size_t num_ssids;
4292 } scan_info;
4293
4294 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004295 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
4296 */
4297 struct rx_probe_req {
4298 /**
4299 * sa - Source address of the received Probe Request frame
4300 */
4301 const u8 *sa;
4302
4303 /**
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004304 * da - Destination address of the received Probe Request frame
4305 * or %NULL if not available
4306 */
4307 const u8 *da;
4308
4309 /**
4310 * bssid - BSSID of the received Probe Request frame or %NULL
4311 * if not available
4312 */
4313 const u8 *bssid;
4314
4315 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004316 * ie - IEs from the Probe Request body
4317 */
4318 const u8 *ie;
4319
4320 /**
4321 * ie_len - Length of ie buffer in octets
4322 */
4323 size_t ie_len;
Dmitry Shmidt04949592012-07-19 12:16:46 -07004324
4325 /**
4326 * signal - signal strength in dBm (or 0 if not available)
4327 */
4328 int ssi_signal;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004329 } rx_probe_req;
4330
4331 /**
4332 * struct new_sta - Data for EVENT_NEW_STA events
4333 */
4334 struct new_sta {
4335 const u8 *addr;
4336 } new_sta;
4337
4338 /**
4339 * struct eapol_rx - Data for EVENT_EAPOL_RX events
4340 */
4341 struct eapol_rx {
4342 const u8 *src;
4343 const u8 *data;
4344 size_t data_len;
4345 } eapol_rx;
4346
4347 /**
4348 * signal_change - Data for EVENT_SIGNAL_CHANGE events
4349 */
4350 struct wpa_signal_info signal_change;
4351
4352 /**
4353 * struct best_channel - Data for EVENT_BEST_CHANNEL events
4354 * @freq_24: Best 2.4 GHz band channel frequency in MHz
4355 * @freq_5: Best 5 GHz band channel frequency in MHz
4356 * @freq_overall: Best channel frequency in MHz
4357 *
4358 * 0 can be used to indicate no preference in either band.
4359 */
4360 struct best_channel {
4361 int freq_24;
4362 int freq_5;
4363 int freq_overall;
4364 } best_chan;
4365
4366 struct unprot_deauth {
4367 const u8 *sa;
4368 const u8 *da;
4369 u16 reason_code;
4370 } unprot_deauth;
4371
4372 struct unprot_disassoc {
4373 const u8 *sa;
4374 const u8 *da;
4375 u16 reason_code;
4376 } unprot_disassoc;
4377
4378 /**
4379 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
4380 * @addr: station address
4381 */
4382 struct low_ack {
4383 u8 addr[ETH_ALEN];
4384 } low_ack;
4385
4386 /**
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004387 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
4388 */
4389 struct ibss_peer_lost {
4390 u8 peer[ETH_ALEN];
4391 } ibss_peer_lost;
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004392
4393 /**
4394 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
4395 */
4396 struct driver_gtk_rekey {
4397 const u8 *bssid;
4398 const u8 *replay_ctr;
4399 } driver_gtk_rekey;
4400
4401 /**
4402 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
4403 * @addr: station address
4404 */
4405 struct client_poll {
4406 u8 addr[ETH_ALEN];
4407 } client_poll;
4408
4409 /**
4410 * struct eapol_tx_status
4411 * @dst: Original destination
4412 * @data: Data starting with IEEE 802.1X header (!)
4413 * @data_len: Length of data
4414 * @ack: Indicates ack or lost frame
4415 *
4416 * This corresponds to hapd_send_eapol if the frame sent
4417 * there isn't just reported as EVENT_TX_STATUS.
4418 */
4419 struct eapol_tx_status {
4420 const u8 *dst;
4421 const u8 *data;
4422 int data_len;
4423 int ack;
4424 } eapol_tx_status;
Dmitry Shmidt04949592012-07-19 12:16:46 -07004425
4426 /**
4427 * struct ch_switch
4428 * @freq: Frequency of new channel in MHz
4429 * @ht_enabled: Whether this is an HT channel
4430 * @ch_offset: Secondary channel offset
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08004431 * @ch_width: Channel width
4432 * @cf1: Center frequency 1
4433 * @cf2: Center frequency 2
Dmitry Shmidt04949592012-07-19 12:16:46 -07004434 */
4435 struct ch_switch {
4436 int freq;
4437 int ht_enabled;
4438 int ch_offset;
Dmitry Shmidt04f534e2013-12-09 15:50:16 -08004439 enum chan_width ch_width;
4440 int cf1;
4441 int cf2;
Dmitry Shmidt04949592012-07-19 12:16:46 -07004442 } ch_switch;
Dmitry Shmidtf8623282013-02-20 14:34:59 -08004443
4444 /**
4445 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
4446 * @addr: Remote client address
4447 * @code: Reason code for connection failure
4448 */
4449 struct connect_failed_reason {
4450 u8 addr[ETH_ALEN];
4451 enum {
4452 MAX_CLIENT_REACHED,
4453 BLOCKED_CLIENT
4454 } code;
4455 } connect_failed_reason;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004456
4457 /**
4458 * struct dfs_event - Data for radar detected events
4459 * @freq: Frequency of the channel in MHz
4460 */
4461 struct dfs_event {
4462 int freq;
Dmitry Shmidt051af732013-10-22 13:52:46 -07004463 int ht_enabled;
4464 int chan_offset;
4465 enum chan_width chan_width;
4466 int cf1;
4467 int cf2;
Dmitry Shmidtea69e842013-05-13 14:52:28 -07004468 } dfs_event;
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004469
4470 /**
4471 * survey_results - Survey result data for EVENT_SURVEY
4472 * @freq_filter: Requested frequency survey filter, 0 if request
4473 * was for all survey data
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004474 * @survey_list: Linked list of survey data (struct freq_survey)
Dmitry Shmidtb7b4d0e2013-08-26 12:09:05 -07004475 */
4476 struct survey_results {
4477 unsigned int freq_filter;
4478 struct dl_list survey_list; /* struct freq_survey */
4479 } survey_results;
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08004480
4481 /**
4482 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
4483 * @initiator: Initiator of the regulatory change
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07004484 * @type: Regulatory change type
4485 * @alpha2: Country code (or "" if not available)
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08004486 */
4487 struct channel_list_changed {
4488 enum reg_change_initiator initiator;
Dmitry Shmidt7dba0e52014-04-14 10:49:15 -07004489 enum reg_type type;
4490 char alpha2[3];
Dmitry Shmidte0e48dc2013-11-18 12:00:06 -08004491 } channel_list_changed;
Dmitry Shmidtcf32e602014-01-28 10:57:39 -08004492
4493 /**
4494 * freq_range - List of frequency ranges
4495 *
4496 * This is used as the data with EVENT_AVOID_FREQUENCIES.
4497 */
4498 struct wpa_freq_range_list freq_range;
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004499
4500 /**
4501 * struct mesh_peer
4502 *
4503 * @peer: Peer address
4504 * @ies: Beacon IEs
4505 * @ie_len: Length of @ies
4506 *
4507 * Notification of new candidate mesh peer.
4508 */
4509 struct mesh_peer {
4510 const u8 *peer;
4511 const u8 *ies;
4512 size_t ie_len;
4513 } mesh_peer;
4514
4515 /**
4516 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
4517 * @pri_channel: Selected primary channel
4518 * @sec_channel: Selected secondary channel
4519 */
4520 struct acs_selected_channels {
4521 u8 pri_channel;
4522 u8 sec_channel;
4523 } acs_selected_channels;
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004524};
4525
4526/**
4527 * wpa_supplicant_event - Report a driver event for wpa_supplicant
4528 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
4529 * with struct wpa_driver_ops::init()
4530 * @event: event type (defined above)
4531 * @data: possible extra data for the event
4532 *
4533 * Driver wrapper code should call this function whenever an event is received
4534 * from the driver.
4535 */
4536void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
4537 union wpa_event_data *data);
4538
4539
4540/*
4541 * The following inline functions are provided for convenience to simplify
4542 * event indication for some of the common events.
4543 */
4544
4545static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
4546 size_t ielen, int reassoc)
4547{
4548 union wpa_event_data event;
4549 os_memset(&event, 0, sizeof(event));
4550 event.assoc_info.reassoc = reassoc;
4551 event.assoc_info.req_ies = ie;
4552 event.assoc_info.req_ies_len = ielen;
4553 event.assoc_info.addr = addr;
4554 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4555}
4556
4557static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4558{
4559 union wpa_event_data event;
4560 os_memset(&event, 0, sizeof(event));
4561 event.disassoc_info.addr = addr;
4562 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4563}
4564
4565static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4566 size_t data_len)
4567{
4568 union wpa_event_data event;
4569 os_memset(&event, 0, sizeof(event));
4570 event.eapol_rx.src = src;
4571 event.eapol_rx.data = data;
4572 event.eapol_rx.data_len = data_len;
4573 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4574}
4575
Dmitry Shmidt1f69aa52012-01-24 16:10:04 -08004576/* driver_common.c */
4577void wpa_scan_results_free(struct wpa_scan_results *res);
4578
4579/* Convert wpa_event_type to a string for logging */
4580const char * event_to_string(enum wpa_event_type event);
4581
Dmitry Shmidt661b4f72014-09-29 14:58:27 -07004582/* Convert chan_width to a string for logging and control interfaces */
4583const char * channel_width_to_string(enum chan_width width);
4584
Dmitry Shmidt6c0da2b2015-01-05 13:08:17 -08004585int ht_supported(const struct hostapd_hw_modes *mode);
4586int vht_supported(const struct hostapd_hw_modes *mode);
4587
4588struct wowlan_triggers *
4589wpa_get_wowlan_triggers(const char *wowlan_triggers,
4590 const struct wpa_driver_capa *capa);
4591
Dmitry Shmidtfb79edc2014-01-10 10:45:54 -08004592/* NULL terminated array of linked in driver wrappers */
4593extern struct wpa_driver_ops *wpa_drivers[];
4594
Dmitry Shmidt8d520ff2011-05-09 14:06:53 -07004595#endif /* DRIVER_H */