]> git.ipfire.org Git - thirdparty/hostap.git/blame - src/drivers/driver.h
HE: Add AP mode MLME/SME handling for HE stations
[thirdparty/hostap.git] / src / drivers / driver.h
CommitLineData
6fc6879b 1/*
e0498677 2 * Driver interface definition
68855672 3 * Copyright (c) 2003-2017, Jouni Malinen <j@w1.fi>
6fc6879b 4 *
0f3d578e
JM
5 * This software may be distributed under the terms of the BSD license.
6 * See README for more details.
e0498677
JM
7 *
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.
6fc6879b
JM
15 */
16
17#ifndef DRIVER_H
18#define DRIVER_H
19
642187d6 20#define WPA_SUPPLICANT_DRIVER_VERSION 4
6fc6879b 21
90973fb2 22#include "common/defs.h"
d9d1b952 23#include "common/ieee802_11_defs.h"
f46c154c 24#include "common/wpa_common.h"
f75f6e2b
SD
25#ifdef CONFIG_MACSEC
26#include "pae/ieee802_1x_kay.h"
27#endif /* CONFIG_MACSEC */
0185007c 28#include "utils/list.h"
6fc6879b 29
c5121837 30#define HOSTAPD_CHAN_DISABLED 0x00000001
0a443580 31#define HOSTAPD_CHAN_NO_IR 0x00000002
c5121837 32#define HOSTAPD_CHAN_RADAR 0x00000008
d8e66e80
JM
33#define HOSTAPD_CHAN_HT40PLUS 0x00000010
34#define HOSTAPD_CHAN_HT40MINUS 0x00000020
35#define HOSTAPD_CHAN_HT40 0x00000040
50f4f2a0 36#define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
c5121837 37
fc96522e
SW
38#define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
39#define HOSTAPD_CHAN_DFS_USABLE 0x00000100
40#define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
41#define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
42#define HOSTAPD_CHAN_DFS_MASK 0x00000300
43
53cfad46
EP
44#define HOSTAPD_CHAN_VHT_10_70 0x00000800
45#define HOSTAPD_CHAN_VHT_30_50 0x00001000
46#define HOSTAPD_CHAN_VHT_50_30 0x00002000
47#define HOSTAPD_CHAN_VHT_70_10 0x00004000
48
ea6bf29e
IP
49#define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
50#define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
51
bee5d8e0
AK
52#define HOSTAPD_CHAN_VHT_10_150 0x00100000
53#define HOSTAPD_CHAN_VHT_30_130 0x00200000
54#define HOSTAPD_CHAN_VHT_50_110 0x00400000
55#define HOSTAPD_CHAN_VHT_70_90 0x00800000
56#define HOSTAPD_CHAN_VHT_90_70 0x01000000
57#define HOSTAPD_CHAN_VHT_110_50 0x02000000
58#define HOSTAPD_CHAN_VHT_130_30 0x04000000
59#define HOSTAPD_CHAN_VHT_150_10 0x08000000
60
4299ad82
DL
61/* Allowed bandwidth mask */
62enum hostapd_chan_width_attr {
63 HOSTAPD_CHAN_WIDTH_10 = BIT(0),
64 HOSTAPD_CHAN_WIDTH_20 = BIT(1),
65 HOSTAPD_CHAN_WIDTH_40P = BIT(2),
66 HOSTAPD_CHAN_WIDTH_40M = BIT(3),
67 HOSTAPD_CHAN_WIDTH_80 = BIT(4),
68 HOSTAPD_CHAN_WIDTH_160 = BIT(5),
69};
70
e42adb9a
MG
71/* Filter gratuitous ARP */
72#define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
73/* Filter unsolicited Neighbor Advertisement */
74#define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
75/* Filter unicast IP packets encrypted using the GTK */
76#define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)
77
aa56e36d
VT
78#define HOSTAPD_DFS_REGION_FCC 1
79#define HOSTAPD_DFS_REGION_ETSI 2
80#define HOSTAPD_DFS_REGION_JP 3
81
4e8f31e2
JM
82/**
83 * enum reg_change_initiator - Regulatory change initiator
84 */
795baf77
AS
85enum reg_change_initiator {
86 REGDOM_SET_BY_CORE,
87 REGDOM_SET_BY_USER,
88 REGDOM_SET_BY_DRIVER,
89 REGDOM_SET_BY_COUNTRY_IE,
8597ebdb 90 REGDOM_BEACON_HINT,
795baf77
AS
91};
92
4e8f31e2
JM
93/**
94 * enum reg_type - Regulatory change types
95 */
142817b2
JM
96enum reg_type {
97 REGDOM_TYPE_UNKNOWN,
98 REGDOM_TYPE_COUNTRY,
99 REGDOM_TYPE_WORLD,
100 REGDOM_TYPE_CUSTOM_WORLD,
101 REGDOM_TYPE_INTERSECTION,
102};
103
e0498677
JM
104/**
105 * struct hostapd_channel_data - Channel information
106 */
c5121837 107struct hostapd_channel_data {
e0498677
JM
108 /**
109 * chan - Channel number (IEEE 802.11)
110 */
111 short chan;
112
113 /**
114 * freq - Frequency in MHz
115 */
c0976528 116 int freq;
e0498677
JM
117
118 /**
119 * flag - Channel flags (HOSTAPD_CHAN_*)
120 */
121 int flag;
122
4299ad82
DL
123 /**
124 * allowed_bw - Allowed channel width bitmask
125 *
126 * See enum hostapd_chan_width_attr.
127 */
128 u32 allowed_bw;
129
e0498677 130 /**
6651f1f9 131 * max_tx_power - Regulatory transmit power limit in dBm
e0498677
JM
132 */
133 u8 max_tx_power;
0185007c 134
4e8f31e2
JM
135 /**
136 * survey_list - Linked list of surveys (struct freq_survey)
0185007c
MK
137 */
138 struct dl_list survey_list;
139
140 /**
141 * min_nf - Minimum observed noise floor, in dBm, based on all
142 * surveyed channel data
143 */
144 s8 min_nf;
50f4f2a0
MK
145
146#ifdef CONFIG_ACS
147 /**
148 * interference_factor - Computed interference factor on this
149 * channel (used internally in src/ap/acs.c; driver wrappers do not
150 * need to set this)
151 */
152 long double interference_factor;
153#endif /* CONFIG_ACS */
bbbacbf2 154
4e8f31e2
JM
155 /**
156 * dfs_cac_ms - DFS CAC time in milliseconds
157 */
bbbacbf2 158 unsigned int dfs_cac_ms;
c5121837
JM
159};
160
5b3940d0
JC
161#define HE_MAX_MAC_CAPAB_SIZE 6
162#define HE_MAX_PHY_CAPAB_SIZE 11
163#define HE_MAX_MCS_CAPAB_SIZE 12
94380cb4 164
94380cb4
PX
165/**
166 * struct he_capabilities - IEEE 802.11ax HE capabilities
167 */
168struct he_capabilities {
169 u8 he_supported;
5b3940d0
JC
170 u8 phy_cap[HE_MAX_PHY_CAPAB_SIZE];
171 u8 mac_cap[HE_MAX_MAC_CAPAB_SIZE];
172 u8 mcs[HE_MAX_MCS_CAPAB_SIZE];
0dbc894f 173 u8 ppet[25];
94380cb4
PX
174};
175
e3b473eb 176#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
c8ebeda4 177#define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
e3b473eb 178
e0498677
JM
179/**
180 * struct hostapd_hw_modes - Supported hardware mode information
181 */
c5121837 182struct hostapd_hw_modes {
e0498677
JM
183 /**
184 * mode - Hardware mode
185 */
71934751 186 enum hostapd_hw_mode mode;
e0498677
JM
187
188 /**
189 * num_channels - Number of entries in the channels array
190 */
c5121837 191 int num_channels;
e0498677
JM
192
193 /**
194 * channels - Array of supported channels
195 */
c5121837 196 struct hostapd_channel_data *channels;
e0498677
JM
197
198 /**
199 * num_rates - Number of entries in the rates array
200 */
c5121837 201 int num_rates;
e0498677
JM
202
203 /**
204 * rates - Array of supported rates in 100 kbps units
205 */
206 int *rates;
207
208 /**
209 * ht_capab - HT (IEEE 802.11n) capabilities
210 */
c5121837 211 u16 ht_capab;
e0498677
JM
212
213 /**
214 * mcs_set - MCS (IEEE 802.11n) rate parameters
215 */
08eb154d 216 u8 mcs_set[16];
e0498677
JM
217
218 /**
219 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
220 */
be8eb8ab 221 u8 a_mpdu_params;
e3b473eb 222
efe45d14
MP
223 /**
224 * vht_capab - VHT (IEEE 802.11ac) capabilities
225 */
226 u32 vht_capab;
227
228 /**
229 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
230 */
231 u8 vht_mcs_set[8];
232
e3b473eb 233 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
94380cb4
PX
234
235 /**
236 * he_capab - HE (IEEE 802.11ax) capabilities
237 */
238 struct he_capabilities he_capab;
c5121837
JM
239};
240
241
6fc6879b
JM
242#define IEEE80211_MODE_INFRA 0
243#define IEEE80211_MODE_IBSS 1
ad1e68e6 244#define IEEE80211_MODE_AP 2
476e6bb6 245#define IEEE80211_MODE_MESH 5
6fc6879b
JM
246
247#define IEEE80211_CAP_ESS 0x0001
248#define IEEE80211_CAP_IBSS 0x0002
249#define IEEE80211_CAP_PRIVACY 0x0010
0dc957b9 250#define IEEE80211_CAP_RRM 0x1000
6fc6879b 251
ff3ad3c5
VK
252/* DMG (60 GHz) IEEE 802.11ad */
253/* type - bits 0..1 */
254#define IEEE80211_CAP_DMG_MASK 0x0003
255#define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
256#define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
257#define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
258
7c2849d2
JM
259#define WPA_SCAN_QUAL_INVALID BIT(0)
260#define WPA_SCAN_NOISE_INVALID BIT(1)
261#define WPA_SCAN_LEVEL_INVALID BIT(2)
262#define WPA_SCAN_LEVEL_DBM BIT(3)
e6b8efeb 263#define WPA_SCAN_ASSOCIATED BIT(5)
7c2849d2 264
6fc6879b
JM
265/**
266 * struct wpa_scan_res - Scan result for an BSS/IBSS
7c2849d2 267 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
6fc6879b
JM
268 * @bssid: BSSID
269 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
270 * @beacon_int: beacon interval in TUs (host byte order)
271 * @caps: capability information field in host byte order
272 * @qual: signal quality
273 * @noise: noise level
274 * @level: signal level
275 * @tsf: Timestamp
b3ad11bb
JM
276 * @age: Age of the information in milliseconds (i.e., how many milliseconds
277 * ago the last Beacon or Probe Response frame was received)
a1b790eb
JM
278 * @est_throughput: Estimated throughput in kbps (this is calculated during
279 * scan result processing if left zero by the driver wrapper)
280 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
c16b9f8d
AS
281 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
282 * of TSF of the BSS specified by %tsf_bssid.
283 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
6fc6879b 284 * @ie_len: length of the following IE field in octets
8c090654 285 * @beacon_ie_len: length of the following Beacon IE field in octets
6fc6879b
JM
286 *
287 * This structure is used as a generic format for scan results from the
288 * driver. Each driver interface implementation is responsible for converting
289 * the driver or OS specific scan results into this format.
290 *
291 * If the driver does not support reporting all IEs, the IE data structure is
292 * constructed of the IEs that are available. This field will also need to
293 * include SSID in IE format. All drivers are encouraged to be extended to
294 * report all IEs to make it easier to support future additions.
4e8f31e2
JM
295 *
296 * This structure data is followed by ie_len octets of IEs from Probe Response
297 * frame (or if the driver does not indicate source of IEs, these may also be
298 * from Beacon frame). After the first set of IEs, another set of IEs may follow
299 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
6fc6879b
JM
300 */
301struct wpa_scan_res {
7c2849d2 302 unsigned int flags;
6fc6879b
JM
303 u8 bssid[ETH_ALEN];
304 int freq;
305 u16 beacon_int;
306 u16 caps;
307 int qual;
308 int noise;
309 int level;
310 u64 tsf;
b3ad11bb 311 unsigned int age;
a1b790eb
JM
312 unsigned int est_throughput;
313 int snr;
c16b9f8d
AS
314 u64 parent_tsf;
315 u8 tsf_bssid[ETH_ALEN];
6fc6879b 316 size_t ie_len;
8c090654 317 size_t beacon_ie_len;
4e8f31e2 318 /* Followed by ie_len + beacon_ie_len octets of IE data */
6fc6879b
JM
319};
320
321/**
322 * struct wpa_scan_results - Scan results
323 * @res: Array of pointers to allocated variable length scan result entries
324 * @num: Number of entries in the scan result array
c5f10e80 325 * @fetch_time: Time when the results were fetched from the driver
6fc6879b
JM
326 */
327struct wpa_scan_results {
328 struct wpa_scan_res **res;
329 size_t num;
acb69cec 330 struct os_reltime fetch_time;
6fc6879b
JM
331};
332
4b4a8ae5
JM
333/**
334 * struct wpa_interface_info - Network interface information
335 * @next: Pointer to the next interface or NULL if this is the last one
336 * @ifname: Interface name that can be used with init() or init2()
337 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
338 * not available
60ad2c7b 339 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
4b4a8ae5
JM
340 * is not an allocated copy, i.e., get_interfaces() caller will not free
341 * this)
342 */
343struct wpa_interface_info {
344 struct wpa_interface_info *next;
345 char *ifname;
346 char *desc;
347 const char *drv_name;
348};
349
35b741fd 350#define WPAS_MAX_SCAN_SSIDS 16
fc2b7ed5 351
0ae86f90
RP
352/**
353 * struct wpa_driver_scan_ssid - SSIDs to scan for
354 * @ssid - specific SSID to scan for (ProbeReq)
355 * %NULL or zero-length SSID is used to indicate active scan
356 * with wildcard SSID.
357 * @ssid_len - Length of the SSID in octets
358 */
359struct wpa_driver_scan_ssid {
360 const u8 *ssid;
361 size_t ssid_len;
362};
363
fc2b7ed5
JM
364/**
365 * struct wpa_driver_scan_params - Scan parameters
366 * Data for struct wpa_driver_ops::scan2().
367 */
368struct wpa_driver_scan_params {
369 /**
370 * ssids - SSIDs to scan for
371 */
0ae86f90 372 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
fc2b7ed5
JM
373
374 /**
375 * num_ssids - Number of entries in ssids array
376 * Zero indicates a request for a passive scan.
377 */
378 size_t num_ssids;
379
380 /**
381 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
382 */
383 const u8 *extra_ies;
384
385 /**
386 * extra_ies_len - Length of extra_ies in octets
387 */
388 size_t extra_ies_len;
d3a98225
JM
389
390 /**
391 * freqs - Array of frequencies to scan or %NULL for all frequencies
392 *
393 * The frequency is set in MHz. The array is zero-terminated.
394 */
395 int *freqs;
3812464c
JM
396
397 /**
398 * filter_ssids - Filter for reporting SSIDs
399 *
400 * This optional parameter can be used to request the driver wrapper to
401 * filter scan results to include only the specified SSIDs. %NULL
402 * indicates that no filtering is to be done. This can be used to
403 * reduce memory needs for scan results in environments that have large
404 * number of APs with different SSIDs.
405 *
406 * The driver wrapper is allowed to take this allocated buffer into its
407 * own use by setting the pointer to %NULL. In that case, the driver
408 * wrapper is responsible for freeing the buffer with os_free() once it
409 * is not needed anymore.
410 */
411 struct wpa_driver_scan_filter {
d9d1b952 412 u8 ssid[SSID_MAX_LEN];
3812464c
JM
413 size_t ssid_len;
414 } *filter_ssids;
415
416 /**
417 * num_filter_ssids - Number of entries in filter_ssids array
418 */
419 size_t num_filter_ssids;
47185fc7 420
bf8d6d24
TP
421 /**
422 * filter_rssi - Filter by RSSI
423 *
424 * The driver may filter scan results in firmware to reduce host
425 * wakeups and thereby save power. Specify the RSSI threshold in s32
426 * dBm.
427 */
428 s32 filter_rssi;
429
47185fc7
RM
430 /**
431 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
432 *
433 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
434 * Mbps from the support rates element(s) in the Probe Request frames
435 * and not to transmit the frames at any of those rates.
436 */
57a8f8af 437 unsigned int p2p_probe:1;
949938aa
JM
438
439 /**
440 * only_new_results - Request driver to report only new results
441 *
442 * This is used to request the driver to report only BSSes that have
443 * been detected after this scan request has been started, i.e., to
444 * flush old cached BSS entries.
445 */
57a8f8af
JB
446 unsigned int only_new_results:1;
447
448 /**
449 * low_priority - Requests driver to use a lower scan priority
450 *
451 * This is used to request the driver to use a lower scan priority
452 * if it supports such a thing.
453 */
454 unsigned int low_priority:1;
dd43aaa5 455
ff23ed22
IP
456 /**
457 * mac_addr_rand - Requests driver to randomize MAC address
458 */
459 unsigned int mac_addr_rand:1;
460
461 /**
462 * mac_addr - MAC address used with randomization. The address cannot be
463 * a multicast one, i.e., bit 0 of byte 0 should not be set.
464 */
465 const u8 *mac_addr;
466
467 /**
468 * mac_addr_mask - MAC address mask used with randomization.
469 *
470 * Bits that are 0 in the mask should be randomized. Bits that are 1 in
471 * the mask should be taken as is from mac_addr. The mask should not
472 * allow the generation of a multicast address, i.e., bit 0 of byte 0
473 * must be set.
474 */
475 const u8 *mac_addr_mask;
476
09ea4309
AS
477 /**
478 * sched_scan_plans - Scan plans for scheduled scan
479 *
480 * Each scan plan consists of the number of iterations to scan and the
481 * interval between scans. When a scan plan finishes (i.e., it was run
482 * for the specified number of iterations), the next scan plan is
483 * executed. The scan plans are executed in the order they appear in
484 * the array (lower index first). The last scan plan will run infinitely
485 * (until requested to stop), thus must not specify the number of
486 * iterations. All other scan plans must specify the number of
487 * iterations.
488 */
489 struct sched_scan_plan {
490 u32 interval; /* In seconds */
491 u32 iterations; /* Zero to run infinitely */
492 } *sched_scan_plans;
493
494 /**
495 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
496 */
497 unsigned int sched_scan_plans_num;
498
d0330d57
PK
499 /**
500 * sched_scan_start_delay - Delay to use before starting the first scan
501 *
502 * Delay (in seconds) before scheduling first scan plan cycle. The
503 * driver may ignore this parameter and start immediately (or at any
504 * other time), if this feature is not supported.
505 */
506 u32 sched_scan_start_delay;
507
eb20cea5
JM
508 /**
509 * bssid - Specific BSSID to scan for
510 *
511 * This optional parameter can be used to replace the default wildcard
512 * BSSID with a specific BSSID to scan for if results are needed from
513 * only a single BSS.
514 */
515 const u8 *bssid;
516
eeb34a43
SD
517 /**
518 * scan_cookie - Unique identification representing the scan request
519 *
520 * This scan_cookie carries a unique identification representing the
521 * scan request if the host driver/kernel supports concurrent scan
522 * requests. This cookie is returned from the corresponding driver
523 * interface.
524 *
525 * Note: Unlike other parameters in this structure, scan_cookie is used
526 * only to return information instead of setting parameters for the
527 * scan.
528 */
529 u64 scan_cookie;
530
c16b9f8d
AS
531 /**
532 * duration - Dwell time on each channel
533 *
534 * This optional parameter can be used to set the dwell time on each
535 * channel. In TUs.
536 */
537 u16 duration;
538
539 /**
540 * duration_mandatory - Whether the specified duration is mandatory
541 *
542 * If this is set, the duration specified by the %duration field is
543 * mandatory (and the driver should reject the scan request if it is
544 * unable to comply with the specified duration), otherwise it is the
545 * maximum duration and the actual duration may be shorter.
546 */
547 unsigned int duration_mandatory:1;
548
20c846d9 549 /**
550 * relative_rssi_set - Whether relative RSSI parameters are set
551 */
552 unsigned int relative_rssi_set:1;
553
554 /**
555 * relative_rssi - Relative RSSI for reporting better BSSs
556 *
557 * Amount of RSSI by which a BSS should be better than the current
558 * connected BSS to report the new BSS to user space.
559 */
560 s8 relative_rssi;
561
562 /**
563 * relative_adjust_band - Band to which RSSI should be adjusted
564 *
565 * The relative_adjust_rssi should be added to the band specified
566 * by relative_adjust_band.
567 */
568 enum set_band relative_adjust_band;
569
570 /**
571 * relative_adjust_rssi - RSSI to be added to relative_adjust_band
572 *
573 * An amount of relative_band_rssi should be added to the BSSs that
574 * belong to the band specified by relative_adjust_band while comparing
575 * with other bands for BSS reporting.
576 */
577 s8 relative_adjust_rssi;
578
938dd97a
RZ
579 /**
580 * oce_scan
581 *
582 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0)
583 * - Accept broadcast Probe Response frame.
584 * - Probe Request frame deferral and suppression.
585 * - Max Channel Time - driver fills FILS request params IE with
586 * Maximum Channel Time.
587 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps.
588 */
589 unsigned int oce_scan:1;
590
dd43aaa5
JM
591 /*
592 * NOTE: Whenever adding new parameters here, please make sure
593 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
594 * matching changes.
595 */
fc2b7ed5
JM
596};
597
c2a04078
JM
598/**
599 * struct wpa_driver_auth_params - Authentication parameters
600 * Data for struct wpa_driver_ops::authenticate().
601 */
602struct wpa_driver_auth_params {
603 int freq;
604 const u8 *bssid;
605 const u8 *ssid;
606 size_t ssid_len;
607 int auth_alg;
608 const u8 *ie;
609 size_t ie_len;
a0b2f99b
JM
610 const u8 *wep_key[4];
611 size_t wep_key_len[4];
612 int wep_tx_keyidx;
2a7e7f4e 613 int local_state_change;
2f4f73b1
EP
614
615 /**
616 * p2p - Whether this connection is a P2P group
617 */
618 int p2p;
619
4e8f31e2 620 /**
ce16c489 621 * auth_data - Additional elements for Authentication frame
4e8f31e2
JM
622 *
623 * This buffer starts with the Authentication transaction sequence
ce16c489
JM
624 * number field. If no special handling of such elements is needed, this
625 * pointer is %NULL. This is used with SAE and FILS.
4e8f31e2 626 */
ce16c489 627 const u8 *auth_data;
c10347f2 628
4e8f31e2 629 /**
ce16c489 630 * auth_data_len - Length of auth_data buffer in octets
4e8f31e2 631 */
ce16c489 632 size_t auth_data_len;
c2a04078
JM
633};
634
4e8f31e2
JM
635/**
636 * enum wps_mode - WPS mode
637 */
0c80427d 638enum wps_mode {
4e8f31e2
JM
639 /**
640 * WPS_MODE_NONE - No WPS provisioning being used
641 */
642 WPS_MODE_NONE,
643
644 /**
645 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
646 */
647 WPS_MODE_OPEN,
648
649 /**
650 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
651 */
652 WPS_MODE_PRIVACY
0c80427d
JM
653};
654
4e8f31e2
JM
655/**
656 * struct hostapd_freq_params - Channel parameters
657 */
4ec68377 658struct hostapd_freq_params {
4e8f31e2
JM
659 /**
660 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
661 */
662 enum hostapd_hw_mode mode;
663
664 /**
665 * freq - Primary channel center frequency in MHz
666 */
4ec68377 667 int freq;
4e8f31e2
JM
668
669 /**
670 * channel - Channel number
671 */
4ec68377 672 int channel;
4e8f31e2
JM
673
674 /**
675 * ht_enabled - Whether HT is enabled
676 */
4ec68377 677 int ht_enabled;
4ec68377 678
4e8f31e2
JM
679 /**
680 * sec_channel_offset - Secondary channel offset for HT40
681 *
682 * 0 = HT40 disabled,
683 * -1 = HT40 enabled, secondary channel below primary,
684 * 1 = HT40 enabled, secondary channel above primary
685 */
686 int sec_channel_offset;
687
688 /**
689 * vht_enabled - Whether VHT is enabled
690 */
4ec68377
JD
691 int vht_enabled;
692
4e8f31e2
JM
693 /**
694 * center_freq1 - Segment 0 center frequency in MHz
695 *
696 * Valid for both HT and VHT.
697 */
698 int center_freq1;
699
700 /**
701 * center_freq2 - Segment 1 center frequency in MHz
702 *
703 * Non-zero only for bandwidth 80 and an 80+80 channel
704 */
705 int center_freq2;
706
707 /**
708 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
709 */
4ec68377
JD
710 int bandwidth;
711};
712
6b128fb2
JM
713/**
714 * struct wpa_driver_sta_auth_params - Authentication parameters
715 * Data for struct wpa_driver_ops::sta_auth().
716 */
717struct wpa_driver_sta_auth_params {
718
719 /**
720 * own_addr - Source address and BSSID for authentication frame
721 */
722 const u8 *own_addr;
723
724 /**
725 * addr - MAC address of the station to associate
726 */
727 const u8 *addr;
728
729 /**
730 * seq - authentication sequence number
731 */
732 u16 seq;
733
734 /**
735 * status - authentication response status code
736 */
737 u16 status;
738
739 /**
740 * ie - authentication frame ie buffer
741 */
742 const u8 *ie;
743
744 /**
745 * len - ie buffer length
746 */
747 size_t len;
f46c154c
JM
748
749 /**
750 * fils_auth - Indicates whether FILS authentication is being performed
751 */
752 int fils_auth;
753
754 /**
755 * fils_anonce - ANonce (required for FILS)
756 */
757 u8 fils_anonce[WPA_NONCE_LEN];
758
759 /**
760 * fils_snonce - SNonce (required for FILS)
761 */
762 u8 fils_snonce[WPA_NONCE_LEN];
763
764 /**
765 * fils_kek - key for encryption (required for FILS)
766 */
767 u8 fils_kek[WPA_KEK_MAX_LEN];
768
769 /**
770 * fils_kek_len - Length of the fils_kek in octets (required for FILS)
771 */
772 size_t fils_kek_len;
6b128fb2
JM
773};
774
6fc6879b
JM
775/**
776 * struct wpa_driver_associate_params - Association parameters
777 * Data for struct wpa_driver_ops::associate().
778 */
779struct wpa_driver_associate_params {
780 /**
781 * bssid - BSSID of the selected AP
782 * This can be %NULL, if ap_scan=2 mode is used and the driver is
783 * responsible for selecting with which BSS to associate. */
784 const u8 *bssid;
785
7ac7fd43
DS
786 /**
787 * bssid_hint - BSSID of a proposed AP
788 *
789 * This indicates which BSS has been found a suitable candidate for
790 * initial association for drivers that use driver/firmwate-based BSS
791 * selection. Unlike the @bssid parameter, @bssid_hint does not limit
792 * the driver from selecting other BSSes in the ESS.
793 */
794 const u8 *bssid_hint;
795
6fc6879b
JM
796 /**
797 * ssid - The selected SSID
798 */
799 const u8 *ssid;
e0498677
JM
800
801 /**
802 * ssid_len - Length of the SSID (1..32)
803 */
6fc6879b
JM
804 size_t ssid_len;
805
806 /**
4ec68377 807 * freq - channel parameters
6fc6879b 808 */
4ec68377 809 struct hostapd_freq_params freq;
6fc6879b 810
7ac7fd43
DS
811 /**
812 * freq_hint - Frequency of the channel the proposed AP is using
813 *
814 * This provides a channel on which a suitable BSS has been found as a
815 * hint for the driver. Unlike the @freq parameter, @freq_hint does not
816 * limit the driver from selecting other channels for
817 * driver/firmware-based BSS selection.
818 */
819 int freq_hint;
820
1f6c0ab8
BS
821 /**
822 * bg_scan_period - Background scan period in seconds, 0 to disable
823 * background scan, or -1 to indicate no change to default driver
824 * configuration
825 */
826 int bg_scan_period;
827
8f05577d
JM
828 /**
829 * beacon_int - Beacon interval for IBSS or 0 to use driver default
830 */
831 int beacon_int;
832
6fc6879b
JM
833 /**
834 * wpa_ie - WPA information element for (Re)Association Request
835 * WPA information element to be included in (Re)Association
836 * Request (including information element id and length). Use
837 * of this WPA IE is optional. If the driver generates the WPA
61a56c14 838 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
6fc6879b
JM
839 * key_mgmt_suite to select proper algorithms. In this case,
840 * the driver has to notify wpa_supplicant about the used WPA
841 * IE by generating an event that the interface code will
842 * convert into EVENT_ASSOCINFO data (see below).
843 *
844 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
845 * instead. The driver can determine which version is used by
846 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
847 * WPA2/RSN).
ad08c363
JM
848 *
849 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
6fc6879b
JM
850 */
851 const u8 *wpa_ie;
e0498677 852
6fc6879b
JM
853 /**
854 * wpa_ie_len - length of the wpa_ie
855 */
856 size_t wpa_ie_len;
857
64fa840a
JM
858 /**
859 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
860 */
861 unsigned int wpa_proto;
862
e0498677 863 /**
4848a38d 864 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
e0498677
JM
865 *
866 * This is usually ignored if @wpa_ie is used.
867 */
4848a38d 868 unsigned int pairwise_suite;
e0498677
JM
869
870 /**
4848a38d 871 * group_suite - Selected group cipher suite (WPA_CIPHER_*)
e0498677
JM
872 *
873 * This is usually ignored if @wpa_ie is used.
874 */
4848a38d 875 unsigned int group_suite;
e0498677 876
61a56c14
JM
877 /**
878 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
879 *
880 * This is usually ignored if @wpa_ie is used.
881 */
882 unsigned int mgmt_group_suite;
883
e0498677 884 /**
4848a38d 885 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
e0498677
JM
886 *
887 * This is usually ignored if @wpa_ie is used.
888 */
4848a38d 889 unsigned int key_mgmt_suite;
6fc6879b
JM
890
891 /**
892 * auth_alg - Allowed authentication algorithms
abd9fafa 893 * Bit field of WPA_AUTH_ALG_*
6fc6879b
JM
894 */
895 int auth_alg;
896
897 /**
898 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
899 */
900 int mode;
901
902 /**
903 * wep_key - WEP keys for static WEP configuration
904 */
905 const u8 *wep_key[4];
906
907 /**
908 * wep_key_len - WEP key length for static WEP configuration
909 */
910 size_t wep_key_len[4];
911
912 /**
913 * wep_tx_keyidx - WEP TX key index for static WEP configuration
914 */
915 int wep_tx_keyidx;
916
917 /**
918 * mgmt_frame_protection - IEEE 802.11w management frame protection
919 */
70f8cc8e 920 enum mfp_options mgmt_frame_protection;
6fc6879b 921
6fc6879b
JM
922 /**
923 * passphrase - RSN passphrase for PSK
924 *
925 * This value is made available only for WPA/WPA2-Personal (PSK) and
436ee2fd
AS
926 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
927 * is the 8..63 character ASCII passphrase, if available. Please note
928 * that this can be %NULL if passphrase was not used to generate the
929 * PSK. In that case, the psk field must be used to fetch the PSK.
6fc6879b
JM
930 */
931 const char *passphrase;
932
933 /**
934 * psk - RSN PSK (alternative for passphrase for PSK)
935 *
936 * This value is made available only for WPA/WPA2-Personal (PSK) and
436ee2fd
AS
937 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
938 * is the 32-octet (256-bit) PSK, if available. The driver wrapper
939 * should be prepared to handle %NULL value as an error.
6fc6879b
JM
940 */
941 const u8 *psk;
36b15723
JM
942
943 /**
944 * drop_unencrypted - Enable/disable unencrypted frame filtering
945 *
946 * Configure the driver to drop all non-EAPOL frames (both receive and
947 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
948 * still be allowed for key negotiation.
949 */
950 int drop_unencrypted;
62fa124c
JM
951
952 /**
953 * prev_bssid - Previously used BSSID in this ESS
954 *
955 * When not %NULL, this is a request to use reassociation instead of
956 * association.
957 */
958 const u8 *prev_bssid;
0c80427d
JM
959
960 /**
961 * wps - WPS mode
962 *
963 * If the driver needs to do special configuration for WPS association,
964 * this variable provides more information on what type of association
965 * is being requested. Most drivers should not need ot use this.
966 */
967 enum wps_mode wps;
75bde05d
JM
968
969 /**
970 * p2p - Whether this connection is a P2P group
971 */
972 int p2p;
eea2fd9e
JM
973
974 /**
975 * uapsd - UAPSD parameters for the network
976 * -1 = do not change defaults
977 * AP mode: 1 = enabled, 0 = disabled
978 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
979 */
980 int uapsd;
9e2af29f
NC
981
982 /**
983 * fixed_bssid - Whether to force this BSSID in IBSS mode
984 * 1 = Fix this BSSID and prevent merges.
985 * 0 = Do not fix BSSID.
986 */
987 int fixed_bssid;
80e8a5ee 988
4d9e6fba
JD
989 /**
990 * fixed_freq - Fix control channel in IBSS mode
991 * 0 = don't fix control channel (default)
992 * 1 = fix control channel; this prevents IBSS merging with another
993 * channel
994 */
995 int fixed_freq;
996
80e8a5ee
BG
997 /**
998 * disable_ht - Disable HT (IEEE 802.11n) for this connection
999 */
1000 int disable_ht;
1001
1002 /**
4e8f31e2
JM
1003 * htcaps - HT Capabilities over-rides
1004 *
1005 * Only bits set in the mask will be used, and not all values are used
1006 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
1007 *
1008 * Pointer to struct ieee80211_ht_capabilities.
1009 */
1010 const u8 *htcaps;
1011
1012 /**
1013 * htcaps_mask - HT Capabilities over-rides mask
1014 *
1015 * Pointer to struct ieee80211_ht_capabilities.
80e8a5ee 1016 */
4e8f31e2 1017 const u8 *htcaps_mask;
e9ee8dc3
JB
1018
1019#ifdef CONFIG_VHT_OVERRIDES
1020 /**
1021 * disable_vht - Disable VHT for this connection
1022 */
1023 int disable_vht;
1024
1025 /**
1026 * VHT capability overrides.
1027 */
1028 const struct ieee80211_vht_capabilities *vhtcaps;
1029 const struct ieee80211_vht_capabilities *vhtcaps_mask;
1030#endif /* CONFIG_VHT_OVERRIDES */
b41f2684
CL
1031
1032 /**
1033 * req_key_mgmt_offload - Request key management offload for connection
1034 *
1035 * Request key management offload for this connection if the device
1036 * supports it.
1037 */
1038 int req_key_mgmt_offload;
0dc957b9
AK
1039
1040 /**
1041 * Flag for indicating whether this association includes support for
1042 * RRM (Radio Resource Measurements)
1043 */
1044 int rrm_used;
86b5c400
LD
1045
1046 /**
1047 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
1048 * AP as usual. Valid for DMG network only.
1049 */
1050 int pbss;
ac56c395
JM
1051
1052 /**
1053 * fils_kek - KEK for FILS association frame protection (AES-SIV)
1054 */
1055 const u8 *fils_kek;
1056
1057 /**
1058 * fils_kek_len: Length of fils_kek in bytes
1059 */
1060 size_t fils_kek_len;
1061
1062 /**
1063 * fils_nonces - Nonces for FILS association frame protection
1064 * (AES-SIV AAD)
1065 */
1066 const u8 *fils_nonces;
1067
1068 /**
1069 * fils_nonces_len: Length of fils_nonce in bytes
1070 */
1071 size_t fils_nonces_len;
ad295f3b
VK
1072
1073 /**
1074 * fils_erp_username - Username part of keyName-NAI
1075 */
1076 const u8 *fils_erp_username;
1077
1078 /**
1079 * fils_erp_username_len - Length of fils_erp_username in bytes
1080 */
1081 size_t fils_erp_username_len;
1082
1083 /**
1084 * fils_erp_realm - Realm/domain name to use in FILS ERP
1085 */
1086 const u8 *fils_erp_realm;
1087
1088 /**
1089 * fils_erp_realm_len - Length of fils_erp_realm in bytes
1090 */
1091 size_t fils_erp_realm_len;
1092
1093 /**
1094 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
1095 * messages
1096 */
1097 u16 fils_erp_next_seq_num;
1098
1099 /**
1100 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
1101 * specified by fils_erp_username@fils_erp_realm.
1102 */
1103 const u8 *fils_erp_rrk;
1104
1105 /**
1106 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
1107 */
1108 size_t fils_erp_rrk_len;
6fc6879b
JM
1109};
1110
97a7a0b5
JM
1111enum hide_ssid {
1112 NO_SSID_HIDING,
1113 HIDDEN_SSID_ZERO_LEN,
1114 HIDDEN_SSID_ZERO_CONTENTS
1115};
1116
95f556f3
OD
1117enum ch_switch_state {
1118 CH_SW_STARTED,
1119 CH_SW_FINISHED
1120};
1121
e4fa8b12
EP
1122struct wowlan_triggers {
1123 u8 any;
1124 u8 disconnect;
1125 u8 magic_pkt;
1126 u8 gtk_rekey_failure;
1127 u8 eap_identity_req;
1128 u8 four_way_handshake;
1129 u8 rfkill_release;
1130};
1131
19c3b566
JM
1132struct wpa_driver_ap_params {
1133 /**
1134 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
1135 */
e44a384b 1136 u8 *head;
19c3b566
JM
1137
1138 /**
1139 * head_len - Length of the head buffer in octets
1140 */
1141 size_t head_len;
1142
1143 /**
1144 * tail - Beacon tail following TIM IE
1145 */
e44a384b 1146 u8 *tail;
19c3b566
JM
1147
1148 /**
1149 * tail_len - Length of the tail buffer in octets
1150 */
1151 size_t tail_len;
1152
1153 /**
1154 * dtim_period - DTIM period
1155 */
1156 int dtim_period;
1157
1158 /**
1159 * beacon_int - Beacon interval
1160 */
1161 int beacon_int;
ccb941e6 1162
e5693c47
JM
1163 /**
1164 * basic_rates: -1 terminated array of basic rates in 100 kbps
1165 *
1166 * This parameter can be used to set a specific basic rate set for the
1167 * BSS. If %NULL, default basic rate set is used.
1168 */
1169 int *basic_rates;
1170
29483a56
PK
1171 /**
1172 * beacon_rate: Beacon frame data rate
1173 *
1174 * This parameter can be used to set a specific Beacon frame data rate
1175 * for the BSS. The interpretation of this value depends on the
1176 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS). If
1177 * beacon_rate == 0 and rate_type == 0 (BEACON_RATE_LEGACY), the default
1178 * Beacon frame data rate is used.
1179 */
1180 unsigned int beacon_rate;
1181
1182 /**
1183 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT)
1184 */
1185 enum beacon_rate_type rate_type;
1186
5b99e21a
AN
1187 /**
1188 * proberesp - Probe Response template
1189 *
1190 * This is used by drivers that reply to Probe Requests internally in
1191 * AP mode and require the full Probe Response template.
1192 */
e44a384b 1193 u8 *proberesp;
5b99e21a
AN
1194
1195 /**
1196 * proberesp_len - Length of the proberesp buffer in octets
1197 */
1198 size_t proberesp_len;
1199
ccb941e6
JM
1200 /**
1201 * ssid - The SSID to use in Beacon/Probe Response frames
1202 */
1203 const u8 *ssid;
1204
1205 /**
1206 * ssid_len - Length of the SSID (1..32)
1207 */
1208 size_t ssid_len;
b11d1d64 1209
97a7a0b5
JM
1210 /**
1211 * hide_ssid - Whether to hide the SSID
1212 */
1213 enum hide_ssid hide_ssid;
1214
b11d1d64
JM
1215 /**
1216 * pairwise_ciphers - WPA_CIPHER_* bitfield
1217 */
1218 unsigned int pairwise_ciphers;
1219
1220 /**
1221 * group_cipher - WPA_CIPHER_*
1222 */
1223 unsigned int group_cipher;
1224
1225 /**
1226 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
1227 */
1228 unsigned int key_mgmt_suites;
1229
1230 /**
1231 * auth_algs - WPA_AUTH_ALG_* bitfield
1232 */
1233 unsigned int auth_algs;
1234
1235 /**
1236 * wpa_version - WPA_PROTO_* bitfield
1237 */
1238 unsigned int wpa_version;
1239
1240 /**
1241 * privacy - Whether privacy is used in the BSS
1242 */
1243 int privacy;
fb91db56
JM
1244
1245 /**
1246 * beacon_ies - WPS/P2P IE(s) for Beacon frames
1247 *
dcd1eb5b
JM
1248 * This is used to add IEs like WPS IE and P2P IE by drivers that do
1249 * not use the full Beacon template.
fb91db56
JM
1250 */
1251 const struct wpabuf *beacon_ies;
1252
1253 /**
1254 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
1255 *
1256 * This is used to add IEs like WPS IE and P2P IE by drivers that
1257 * reply to Probe Request frames internally.
1258 */
1259 const struct wpabuf *proberesp_ies;
1260
1261 /**
1262 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
062390ef
JM
1263 *
1264 * This is used to add IEs like WPS IE by drivers that reply to
1265 * (Re)Association Request frames internally.
fb91db56
JM
1266 */
1267 const struct wpabuf *assocresp_ies;
fd13a541
JM
1268
1269 /**
1270 * isolate - Whether to isolate frames between associated stations
1271 *
1272 * If this is non-zero, the AP is requested to disable forwarding of
e53a0c74 1273 * frames between associated stations.
fd13a541
JM
1274 */
1275 int isolate;
31357268
JM
1276
1277 /**
1278 * cts_protect - Whether CTS protection is enabled
1279 */
1280 int cts_protect;
1281
1282 /**
1283 * preamble - Whether short preamble is enabled
1284 */
1285 int preamble;
1286
1287 /**
1288 * short_slot_time - Whether short slot time is enabled
1289 *
1290 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
1291 * not set (e.g., when 802.11g mode is not in use)
1292 */
1293 int short_slot_time;
1294
1295 /**
1296 * ht_opmode - HT operation mode or -1 if HT not in use
1297 */
1298 int ht_opmode;
8a33a63f
JM
1299
1300 /**
1301 * interworking - Whether Interworking is enabled
1302 */
1303 int interworking;
1304
1305 /**
1306 * hessid - Homogeneous ESS identifier or %NULL if not set
1307 */
1308 const u8 *hessid;
16991cff
JM
1309
1310 /**
1311 * access_network_type - Access Network Type (0..15)
1312 *
1313 * This is used for filtering Probe Request frames when Interworking is
1314 * enabled.
1315 */
1316 u8 access_network_type;
a0133ee1
VT
1317
1318 /**
1319 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
1320 *
1321 * This is used by driver which advertises this capability.
1322 */
1323 int ap_max_inactivity;
83421850 1324
0b8bcaa5
EP
1325 /**
1326 * ctwindow - Client Traffic Window (in TUs)
1327 */
1328 u8 p2p_go_ctwindow;
1329
83421850 1330 /**
8f461b50
EP
1331 * smps_mode - SMPS mode
1332 *
1333 * SMPS mode to be used by the AP, specified as the relevant bits of
1334 * ht_capab (i.e. HT_CAP_INFO_SMPS_*).
1335 */
1336 unsigned int smps_mode;
1337
1338 /**
83421850
JM
1339 * disable_dgaf - Whether group-addressed frames are disabled
1340 */
1341 int disable_dgaf;
a14896e8
JM
1342
1343 /**
1344 * osen - Whether OSEN security is enabled
1345 */
1346 int osen;
196c9c7c
PX
1347
1348 /**
1349 * freq - Channel parameters for dynamic bandwidth changes
1350 */
1351 struct hostapd_freq_params *freq;
f33c8606
JM
1352
1353 /**
1354 * reenable - Whether this is to re-enable beaconing
1355 */
1356 int reenable;
86b5c400
LD
1357
1358 /**
1359 * pbss - Whether to start a PCP (in PBSS) instead of an AP in
1360 * infrastructure BSS. Valid only for DMG network.
1361 */
1362 int pbss;
34f7c699
MB
1363
1364 /**
1365 * multicast_to_unicast - Whether to use multicast_to_unicast
1366 *
1367 * If this is non-zero, the AP is requested to perform multicast to
1368 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
1369 * 802.1Q). If enabled, such frames are to be sent to each station
1370 * separately, with the DA replaced by their own MAC address rather
1371 * than the group address.
1372 *
1373 * Note that this may break certain expectations of the receiver, such
1374 * as the ability to drop unicast IP packets received within multicast
1375 * L2 frames, or the ability to not send ICMP destination unreachable
1376 * messages for packets received in L2 multicast (which is required,
1377 * but the receiver can't tell the difference if this new option is
1378 * enabled.)
1379 *
1380 * This also doesn't implement the 802.11 DMS (directed multicast
1381 * service).
1382 */
1383 int multicast_to_unicast;
4cb618cf
AO
1384
1385 /**
1386 * ftm_responder - Whether FTM responder is enabled
1387 */
1388 int ftm_responder;
1389
1390 /**
1391 * lci - Binary data, the content of an LCI report IE with type 8 as
1392 * defined in IEEE Std 802.11-2016, 9.4.2.22.10
1393 */
1394 const struct wpabuf *lci;
1395
1396 /**
1397 * civic - Binary data, the content of a measurement report IE with
1398 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
1399 */
1400 const struct wpabuf *civic;
19c3b566
JM
1401};
1402
6c1664f6 1403struct wpa_driver_mesh_bss_params {
2bd62171
MH
1404#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001
1405#define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
1406#define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004
052b8d38 1407#define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008
31a856a1 1408#define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010
6c1664f6
BC
1409 /*
1410 * TODO: Other mesh configuration parameters would go here.
1411 * See NL80211_MESHCONF_* for all the mesh config parameters.
1412 */
1413 unsigned int flags;
2bd62171 1414 int auto_plinks;
5a2a6de6 1415 int peer_link_timeout;
a1431ef8 1416 int max_peer_links;
31a856a1 1417 int rssi_threshold;
052b8d38 1418 u16 ht_opmode;
6c1664f6
BC
1419};
1420
1421struct wpa_driver_mesh_join_params {
1422 const u8 *meshid;
1423 int meshid_len;
1424 const int *basic_rates;
1425 const u8 *ies;
1426 int ie_len;
f7e889fa 1427 struct hostapd_freq_params freq;
9c58c5f7 1428 int beacon_int;
4ac2ea57 1429 int dtim_period;
6c1664f6
BC
1430 struct wpa_driver_mesh_bss_params conf;
1431#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
1432#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
1433#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
1434#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
1435 unsigned int flags;
1436};
1437
6fc6879b
JM
1438/**
1439 * struct wpa_driver_capa - Driver capability information
1440 */
1441struct wpa_driver_capa {
1442#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
1443#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
1444#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
1445#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
1446#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
1447#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
1448#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
369c8d7b 1449#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
399e6135
JM
1450#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100
1451#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200
f9561868 1452#define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400
567da5bb 1453#define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800
fe3e0bac
VK
1454#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000
1455#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000
1456#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
1457#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
8ec7c99e 1458#define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000
4e8f31e2 1459 /** Bitfield of supported key management suites */
6fc6879b
JM
1460 unsigned int key_mgmt;
1461
1462#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
1463#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
1464#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
1465#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
349493bd 1466#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
eb7719ff 1467#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
30675c34
JM
1468#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040
1469#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080
1470#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100
1471#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200
1472#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400
1473#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800
ae6f9272 1474#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000
4e8f31e2 1475 /** Bitfield of supported cipher suites */
6fc6879b
JM
1476 unsigned int enc;
1477
1478#define WPA_DRIVER_AUTH_OPEN 0x00000001
1479#define WPA_DRIVER_AUTH_SHARED 0x00000002
1480#define WPA_DRIVER_AUTH_LEAP 0x00000004
4e8f31e2 1481 /** Bitfield of supported IEEE 802.11 authentication algorithms */
6fc6879b
JM
1482 unsigned int auth;
1483
4e8f31e2 1484/** Driver generated WPA/RSN IE */
6fc6879b 1485#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
4e8f31e2 1486/** Driver needs static WEP key setup after association command */
6fc6879b 1487#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
4e8f31e2 1488/** Driver takes care of all DFS operations */
65d645ce 1489#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004
4e8f31e2 1490/** Driver takes care of RSN 4-way handshake internally; PMK is configured with
6fc6879b 1491 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
436ee2fd 1492#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008
4e8f31e2 1493/** Driver is for a wired Ethernet interface */
4ef1e644 1494#define WPA_DRIVER_FLAGS_WIRED 0x00000010
4e8f31e2 1495/** Driver provides separate commands for authentication and association (SME in
c2a04078
JM
1496 * wpa_supplicant). */
1497#define WPA_DRIVER_FLAGS_SME 0x00000020
4e8f31e2 1498/** Driver supports AP mode */
1581b38b 1499#define WPA_DRIVER_FLAGS_AP 0x00000040
4e8f31e2 1500/** Driver needs static WEP key setup after association has been completed */
0194fedb 1501#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
4e8f31e2 1502/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
196c9c7c 1503#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100
4e8f31e2 1504/** Driver supports concurrent P2P operations */
75bde05d 1505#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
4e8f31e2 1506/**
75bde05d 1507 * Driver uses the initial interface as a dedicated management interface, i.e.,
971e357f 1508 * it cannot be used for P2P group operations or non-P2P purposes.
75bde05d
JM
1509 */
1510#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
4e8f31e2 1511/** This interface is P2P capable (P2P GO or P2P Client) */
75bde05d 1512#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
4e8f31e2 1513/** Driver supports station and key removal when stopping an AP */
354c903f 1514#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000
4e8f31e2 1515/**
971e357f
JM
1516 * Driver uses the initial interface for P2P management interface and non-P2P
1517 * purposes (e.g., connect to infra AP), but this interface cannot be used for
1518 * P2P group operations.
1519 */
1520#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
4e8f31e2 1521/**
871f4dd0
JM
1522 * Driver is known to use sane error codes, i.e., when it indicates that
1523 * something (e.g., association) fails, there was indeed a failure and the
1524 * operation does not end up getting completed successfully later.
1525 */
1526#define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
4e8f31e2 1527/** Driver supports off-channel TX */
190b9062 1528#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
4e8f31e2 1529/** Driver indicates TX status events for EAPOL Data frames */
2fee890a 1530#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
4e8f31e2 1531/** Driver indicates TX status events for Deauth/Disassoc frames */
4dc03726 1532#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
4e8f31e2 1533/** Driver supports roaming (BSS selection) in firmware */
004ba773 1534#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
4e8f31e2 1535/** Driver supports operating as a TDLS peer */
03ea1786 1536#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
4e8f31e2 1537/** Driver requires external TDLS setup/teardown/discovery */
03ea1786 1538#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
4e8f31e2 1539/** Driver indicates support for Probe Response offloading in AP mode */
562c9d97 1540#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
4e8f31e2 1541/** Driver supports U-APSD in AP mode */
70619a5d 1542#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
4e8f31e2 1543/** Driver supports inactivity timer in AP mode */
a0133ee1 1544#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
4e8f31e2 1545/** Driver expects user space implementation of MLME in AP mode */
e5091674 1546#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
4e8f31e2 1547/** Driver supports SAE with user space SME */
c10347f2 1548#define WPA_DRIVER_FLAGS_SAE 0x02000000
4e8f31e2 1549/** Driver makes use of OBSS scan mechanism in wpa_supplicant */
368b1957 1550#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
4e8f31e2 1551/** Driver supports IBSS (Ad-hoc) mode */
65d52fc1 1552#define WPA_DRIVER_FLAGS_IBSS 0x08000000
4e8f31e2 1553/** Driver supports radar detection */
f295d0c8 1554#define WPA_DRIVER_FLAGS_RADAR 0x10000000
4e8f31e2 1555/** Driver supports a dedicated interface for P2P Device */
7aad838c 1556#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
4e8f31e2 1557/** Driver supports QoS Mapping */
429dd9af 1558#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000
4e8f31e2 1559/** Driver supports CSA in AP mode */
991aa9c7 1560#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000
4e8f31e2 1561/** Driver supports mesh */
24bd4e0b 1562#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL
4e8f31e2 1563/** Driver support ACS offload */
16689c7c 1564#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL
4e8f31e2 1565/** Driver supports key management offload */
15badebd 1566#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
4daa5729
AN
1567/** Driver supports TDLS channel switching */
1568#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL
1830817e
JD
1569/** Driver supports IBSS with HT datarates */
1570#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL
563ee183
JD
1571/** Driver supports IBSS with VHT datarates */
1572#define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL
3784c058
PX
1573/** Driver supports automatic band selection */
1574#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL
8e509745
KV
1575/** Driver supports simultaneous off-channel operations */
1576#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL
dc55b6b6
AB
1577/** Driver supports full AP client state */
1578#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
a6f5b193
PX
1579/** Driver supports P2P Listen offload */
1580#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL
061dac1d
JM
1581/** Driver supports FILS */
1582#define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL
29483a56
PK
1583/** Driver supports Beacon frame TX rate configuration (legacy rates) */
1584#define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
1585/** Driver supports Beacon frame TX rate configuration (HT rates) */
1586#define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL
1587/** Driver supports Beacon frame TX rate configuration (VHT rates) */
1588#define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL
8331c9b3
VK
1589/** Driver supports mgmt_tx with random TX address in non-connected state */
1590#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL
1591/** Driver supports mgmt_tx with random TX addr in connected state */
1592#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL
20c846d9 1593/** Driver supports better BSS reporting with sched_scan in connected mode */
1594#define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
94380cb4
PX
1595/** Driver supports HE capabilities */
1596#define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL
ad295f3b
VK
1597/** Driver supports FILS shared key offload */
1598#define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL
fb718f94
AP
1599/** Driver supports all OCE STA specific mandatory features */
1600#define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL
1601/** Driver supports all OCE AP specific mandatory features */
1602#define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL
1603/**
1604 * Driver supports all OCE STA-CFON specific mandatory features only.
1605 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
1606 * userspace shall assume that this driver may not support all OCE AP
1607 * functionality but can support only OCE STA-CFON functionality.
1608 */
1609#define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL
299d21e8
EG
1610/** Driver supports MFP-optional in the connect command */
1611#define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL
8aa4d552
PX
1612/** Driver is a self-managed regulatory device */
1613#define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL
4cb618cf
AO
1614/** Driver supports FTM responder functionality */
1615#define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL
436ee2fd
AS
1616/** Driver support 4-way handshake offload for WPA-Personal */
1617#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
24bd4e0b 1618 u64 flags;
80bc75f1 1619
dc55b6b6
AB
1620#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
1621 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)
1622
04ee647d
EP
1623#define WPA_DRIVER_SMPS_MODE_STATIC 0x00000001
1624#define WPA_DRIVER_SMPS_MODE_DYNAMIC 0x00000002
1625 unsigned int smps_modes;
1626
471cd6e1
MB
1627 unsigned int wmm_ac_supported:1;
1628
ff23ed22
IP
1629 unsigned int mac_addr_rand_scan_supported:1;
1630 unsigned int mac_addr_rand_sched_scan_supported:1;
1631
4e8f31e2 1632 /** Maximum number of supported active probe SSIDs */
80bc75f1 1633 int max_scan_ssids;
4e8f31e2
JM
1634
1635 /** Maximum number of supported active probe SSIDs for sched_scan */
cbdf3507 1636 int max_sched_scan_ssids;
4e8f31e2 1637
09ea4309
AS
1638 /** Maximum number of supported scan plans for scheduled scan */
1639 unsigned int max_sched_scan_plans;
1640
1641 /** Maximum interval in a scan plan. In seconds */
1642 u32 max_sched_scan_plan_interval;
1643
1644 /** Maximum number of iterations in a single scan plan */
1645 u32 max_sched_scan_plan_iterations;
1646
4e8f31e2 1647 /** Whether sched_scan (offloaded scanning) is supported */
cbdf3507 1648 int sched_scan_supported;
4e8f31e2
JM
1649
1650 /** Maximum number of supported match sets for sched_scan */
b59e6f26 1651 int max_match_sets;
814782b9
JM
1652
1653 /**
1654 * max_remain_on_chan - Maximum remain-on-channel duration in msec
1655 */
1656 unsigned int max_remain_on_chan;
c4ea4c5c
JM
1657
1658 /**
1659 * max_stations - Maximum number of associated stations the driver
1660 * supports in AP mode
1661 */
1662 unsigned int max_stations;
562c9d97
AN
1663
1664 /**
1665 * probe_resp_offloads - Bitmap of supported protocols by the driver
1666 * for Probe Response offloading.
1667 */
4e8f31e2 1668/** Driver Probe Response offloading support for WPS ver. 1 */
562c9d97 1669#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
4e8f31e2 1670/** Driver Probe Response offloading support for WPS ver. 2 */
562c9d97 1671#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
4e8f31e2 1672/** Driver Probe Response offloading support for P2P */
562c9d97 1673#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
4e8f31e2 1674/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
562c9d97
AN
1675#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
1676 unsigned int probe_resp_offloads;
8cd6b7bc 1677
3c4ca363
VN
1678 unsigned int max_acl_mac_addrs;
1679
4752147d
IP
1680 /**
1681 * Number of supported concurrent channels
1682 */
1683 unsigned int num_multichan_concurrent;
1684
8cd6b7bc
JB
1685 /**
1686 * extended_capa - extended capabilities in driver/device
1687 *
1688 * Must be allocated and freed by driver and the pointers must be
1689 * valid for the lifetime of the driver, i.e., freed in deinit()
1690 */
1691 const u8 *extended_capa, *extended_capa_mask;
1692 unsigned int extended_capa_len;
e4fa8b12
EP
1693
1694 struct wowlan_triggers wowlan_triggers;
0dc957b9 1695
4e8f31e2 1696/** Driver adds the DS Params Set IE in Probe Request frames */
0dc957b9 1697#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001
4e8f31e2 1698/** Driver adds the WFA TPC IE in Probe Request frames */
0dc957b9 1699#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002
4e8f31e2 1700/** Driver handles quiet period requests */
0dc957b9
AK
1701#define WPA_DRIVER_FLAGS_QUIET 0x00000004
1702/**
1703 * Driver is capable of inserting the current TX power value into the body of
1704 * transmitted frames.
1705 * Background: Some Action frames include a TPC Report IE. This IE contains a
1706 * TX power field, which has to be updated by lower layers. One such Action
1707 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
1708 * of spectrum management). Note that this insertion takes place at a fixed
1709 * offset, namely the 6th byte in the Action frame body.
1710 */
1711#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008
a7f0bb70
BL
1712/**
1713 * Driver supports RRM. With this support, the driver will accept to use RRM in
1714 * (Re)Association Request frames, without supporting quiet period.
1715 */
1716#define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010
1717
c16b9f8d
AS
1718/** Driver supports setting the scan dwell time */
1719#define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020
1720/** Driver supports Beacon Report Measurement */
1721#define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040
1722
0dc957b9 1723 u32 rrm_flags;
079a28f7
AK
1724
1725 /* Driver concurrency capabilities */
1726 unsigned int conc_capab;
1727 /* Maximum number of concurrent channels on 2.4 GHz */
1728 unsigned int max_conc_chan_2_4;
1729 /* Maximum number of concurrent channels on 5 GHz */
1730 unsigned int max_conc_chan_5_0;
366179d2
AO
1731
1732 /* Maximum number of supported CSA counters */
1733 u16 max_csa_counters;
6fc6879b
JM
1734};
1735
1736
c5121837
JM
1737struct hostapd_data;
1738
3567641e 1739#define STA_DRV_DATA_TX_MCS BIT(0)
1740#define STA_DRV_DATA_RX_MCS BIT(1)
1741#define STA_DRV_DATA_TX_VHT_MCS BIT(2)
1742#define STA_DRV_DATA_RX_VHT_MCS BIT(3)
1743#define STA_DRV_DATA_TX_VHT_NSS BIT(4)
1744#define STA_DRV_DATA_RX_VHT_NSS BIT(5)
1745#define STA_DRV_DATA_TX_SHORT_GI BIT(6)
1746#define STA_DRV_DATA_RX_SHORT_GI BIT(7)
72123a84 1747#define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
3567641e 1748
c5121837 1749struct hostap_sta_driver_data {
43022abd
NL
1750 unsigned long rx_packets, tx_packets;
1751 unsigned long long rx_bytes, tx_bytes;
58d4c236 1752 unsigned long long rx_airtime, tx_airtime;
43022abd 1753 int bytes_64bit; /* whether 64-bit byte counters are supported */
c5121837 1754 unsigned long current_tx_rate;
3567641e 1755 unsigned long current_rx_rate;
c5121837 1756 unsigned long inactive_msec;
3567641e 1757 unsigned long flags; /* bitfield of STA_DRV_DATA_* */
c5121837
JM
1758 unsigned long num_ps_buf_frames;
1759 unsigned long tx_retry_failed;
1760 unsigned long tx_retry_count;
72123a84 1761 s8 last_ack_rssi;
1d6f6385
THJ
1762 unsigned long backlog_packets;
1763 unsigned long backlog_bytes;
3567641e 1764 s8 signal;
1765 u8 rx_vhtmcs;
1766 u8 tx_vhtmcs;
1767 u8 rx_mcs;
1768 u8 tx_mcs;
1769 u8 rx_vht_nss;
1770 u8 tx_vht_nss;
c5121837
JM
1771};
1772
1773struct hostapd_sta_add_params {
1774 const u8 *addr;
1775 u16 aid;
1776 u16 capability;
1777 const u8 *supp_rates;
1778 size_t supp_rates_len;
c5121837 1779 u16 listen_interval;
fc4e2d95 1780 const struct ieee80211_ht_capabilities *ht_capabilities;
a9a1d0f0 1781 const struct ieee80211_vht_capabilities *vht_capabilities;
8a458116
MK
1782 int vht_opmode_enabled;
1783 u8 vht_opmode;
59d9c3a1
JC
1784 const struct ieee80211_he_capabilities *he_capab;
1785 size_t he_capab_len;
d83ab1fe 1786 u32 flags; /* bitmask of WPA_STA_* flags */
7e31703e 1787 u32 flags_mask; /* unset bits in flags */
7c7e7877
BC
1788#ifdef CONFIG_MESH
1789 enum mesh_plink_state plink_state;
e347cafe 1790 u16 peer_aid;
7c7e7877 1791#endif /* CONFIG_MESH */
45b722f1 1792 int set; /* Set STA parameters instead of add */
5d061637 1793 u8 qosinfo;
d16531c4
SD
1794 const u8 *ext_capab;
1795 size_t ext_capab_len;
3ed97271
SD
1796 const u8 *supp_channels;
1797 size_t supp_channels_len;
1798 const u8 *supp_oper_classes;
1799 size_t supp_oper_classes_len;
ae33239c 1800 int support_p2p_ps;
c5121837
JM
1801};
1802
3c4ca363
VN
1803struct mac_address {
1804 u8 addr[ETH_ALEN];
1805};
1806
1807struct hostapd_acl_params {
1808 u8 acl_policy;
1809 unsigned int num_mac_acl;
1810 struct mac_address mac_acl[0];
1811};
1812
22a7c9d7
JM
1813enum wpa_driver_if_type {
1814 /**
1815 * WPA_IF_STATION - Station mode interface
1816 */
1817 WPA_IF_STATION,
1818
1819 /**
1820 * WPA_IF_AP_VLAN - AP mode VLAN interface
1821 *
1822 * This interface shares its address and Beacon frame with the main
1823 * BSS.
1824 */
1825 WPA_IF_AP_VLAN,
1826
1827 /**
1828 * WPA_IF_AP_BSS - AP mode BSS interface
1829 *
1830 * This interface has its own address and Beacon frame.
1831 */
1832 WPA_IF_AP_BSS,
75bde05d
JM
1833
1834 /**
1835 * WPA_IF_P2P_GO - P2P Group Owner
1836 */
1837 WPA_IF_P2P_GO,
1838
1839 /**
1840 * WPA_IF_P2P_CLIENT - P2P Client
1841 */
1842 WPA_IF_P2P_CLIENT,
1843
1844 /**
1845 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1846 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1847 */
7aad838c
NS
1848 WPA_IF_P2P_GROUP,
1849
1850 /**
1851 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1852 * abstracted P2P Device function in the driver
1853 */
5b78493f
MH
1854 WPA_IF_P2P_DEVICE,
1855
1856 /*
1857 * WPA_IF_MESH - Mesh interface
1858 */
1859 WPA_IF_MESH,
98342208
AK
1860
1861 /*
1862 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
1863 */
1864 WPA_IF_TDLS,
1865
1866 /*
1867 * WPA_IF_IBSS - IBSS interface (used for pref freq only)
1868 */
1869 WPA_IF_IBSS,
c5121837
JM
1870};
1871
92f475b4 1872struct wpa_init_params {
4b24282a 1873 void *global_priv;
92f475b4
JM
1874 const u8 *bssid;
1875 const char *ifname;
0ecff8d7 1876 const char *driver_params;
92f475b4 1877 int use_pae_group_addr;
92f475b4
JM
1878 char **bridge;
1879 size_t num_bridge;
412036f5
JM
1880
1881 u8 *own_addr; /* buffer for writing own MAC address */
92f475b4
JM
1882};
1883
c5121837 1884
e3bd3912
JM
1885struct wpa_bss_params {
1886 /** Interface name (for multi-SSID/VLAN support) */
1887 const char *ifname;
1888 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1889 int enabled;
af586419
JM
1890
1891 int wpa;
1892 int ieee802_1x;
1893 int wpa_group;
1894 int wpa_pairwise;
1895 int wpa_key_mgmt;
1896 int rsn_preauth;
a1ca0292 1897 enum mfp_options ieee80211w;
e3bd3912
JM
1898};
1899
0de39516
JM
1900#define WPA_STA_AUTHORIZED BIT(0)
1901#define WPA_STA_WMM BIT(1)
1902#define WPA_STA_SHORT_PREAMBLE BIT(2)
1903#define WPA_STA_MFP BIT(3)
45b722f1 1904#define WPA_STA_TDLS_PEER BIT(4)
7a228b5c 1905#define WPA_STA_AUTHENTICATED BIT(5)
dc55b6b6 1906#define WPA_STA_ASSOCIATED BIT(6)
e3bd3912 1907
281ff0aa
GP
1908enum tdls_oper {
1909 TDLS_DISCOVERY_REQ,
1910 TDLS_SETUP,
1911 TDLS_TEARDOWN,
1912 TDLS_ENABLE_LINK,
b8f64582
JM
1913 TDLS_DISABLE_LINK,
1914 TDLS_ENABLE,
1915 TDLS_DISABLE
281ff0aa
GP
1916};
1917
a884be9d
XC
1918enum wnm_oper {
1919 WNM_SLEEP_ENTER_CONFIRM,
1920 WNM_SLEEP_ENTER_FAIL,
1921 WNM_SLEEP_EXIT_CONFIRM,
1922 WNM_SLEEP_EXIT_FAIL,
1923 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1924 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1925 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1926 * a STA */
1927 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1928 * for a STA */
1929 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1930 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1931 * for a STA */
1932 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1933};
1934
e8ada160
T
1935/* enum smps_mode - SMPS mode definitions */
1936enum smps_mode {
1937 SMPS_AUTOMATIC,
1938 SMPS_OFF,
1939 SMPS_DYNAMIC,
1940 SMPS_STATIC,
1941
1942 /* Keep last */
1943 SMPS_INVALID,
1944};
1945
941807f6
EG
1946#define WPA_INVALID_NOISE 9999
1947
1c5c7273
PS
1948/**
1949 * struct wpa_signal_info - Information about channel signal quality
941807f6
EG
1950 * @frequency: control frequency
1951 * @above_threshold: true if the above threshold was crossed
1952 * (relevant for a CQM event)
1953 * @current_signal: in dBm
1954 * @avg_signal: in dBm
1955 * @avg_beacon_signal: in dBm
1956 * @current_noise: %WPA_INVALID_NOISE if not supported
1957 * @current_txrate: current TX rate
1958 * @chanwidth: channel width
1959 * @center_frq1: center frequency for the first segment
1960 * @center_frq2: center frequency for the second segment (if relevant)
1c5c7273
PS
1961 */
1962struct wpa_signal_info {
1963 u32 frequency;
1964 int above_threshold;
1965 int current_signal;
95783298 1966 int avg_signal;
74fa78b2 1967 int avg_beacon_signal;
1c5c7273
PS
1968 int current_noise;
1969 int current_txrate;
2cc8d8f4
AO
1970 enum chan_width chanwidth;
1971 int center_frq1;
1972 int center_frq2;
1c5c7273
PS
1973};
1974
7f00dc6e
MV
1975/**
1976 * struct wpa_channel_info - Information about the current channel
1977 * @frequency: Center frequency of the primary 20 MHz channel
1978 * @chanwidth: Width of the current operating channel
1979 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
1980 * This field is only filled in when using a 40 MHz channel.
1981 * @center_frq1: Center frequency of frequency segment 0
1982 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
1983 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
1984 * derived from center_frq2 for convenience.
1985 */
1986struct wpa_channel_info {
1987 u32 frequency;
1988 enum chan_width chanwidth;
1989 int sec_channel;
1990 int center_frq1;
1991 int center_frq2;
1992 u8 seg1_idx;
1993};
1994
dcca2219
AO
1995/**
1996 * struct beacon_data - Beacon data
1997 * @head: Head portion of Beacon frame (before TIM IE)
1998 * @tail: Tail portion of Beacon frame (after TIM IE)
1999 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
2000 * @proberesp_ies: Extra information element(s) to add into Probe Response
2001 * frames or %NULL
2002 * @assocresp_ies: Extra information element(s) to add into (Re)Association
2003 * Response frames or %NULL
2004 * @probe_resp: Probe Response frame template
2005 * @head_len: Length of @head
2006 * @tail_len: Length of @tail
2007 * @beacon_ies_len: Length of beacon_ies in octets
2008 * @proberesp_ies_len: Length of proberesp_ies in octets
2009 * @proberesp_ies_len: Length of proberesp_ies in octets
2010 * @probe_resp_len: Length of probe response template (@probe_resp)
2011 */
2012struct beacon_data {
2013 u8 *head, *tail;
2014 u8 *beacon_ies;
2015 u8 *proberesp_ies;
2016 u8 *assocresp_ies;
2017 u8 *probe_resp;
2018
2019 size_t head_len, tail_len;
2020 size_t beacon_ies_len;
2021 size_t proberesp_ies_len;
2022 size_t assocresp_ies_len;
2023 size_t probe_resp_len;
2024};
2025
2026/**
2027 * struct csa_settings - Settings for channel switch command
2028 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
2029 * @block_tx: 1 - block transmission for CSA period
2030 * @freq_params: Next channel frequency parameter
2031 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
2032 * @beacon_after: Next beacon/probe resp/asooc resp info
2033 * @counter_offset_beacon: Offset to the count field in beacon's tail
2034 * @counter_offset_presp: Offset to the count field in probe resp.
2035 */
2036struct csa_settings {
2037 u8 cs_count;
2038 u8 block_tx;
2039
2040 struct hostapd_freq_params freq_params;
2041 struct beacon_data beacon_csa;
2042 struct beacon_data beacon_after;
2043
366179d2
AO
2044 u16 counter_offset_beacon[2];
2045 u16 counter_offset_presp[2];
dcca2219
AO
2046};
2047
96ecea5e
SD
2048/* TDLS peer capabilities for send_tdls_mgmt() */
2049enum tdls_peer_capability {
2050 TDLS_PEER_HT = BIT(0),
2051 TDLS_PEER_VHT = BIT(1),
2052 TDLS_PEER_WMM = BIT(2),
2053};
2054
0f14a44e
EP
2055/* valid info in the wmm_params struct */
2056enum wmm_params_valid_info {
2057 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
2058};
2059
2060/**
2061 * struct wmm_params - WMM parameterss configured for this association
2062 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
2063 * of the struct contain valid information.
2064 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
2065 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
2066 */
2067struct wmm_params {
2068 u8 info_bitmap;
2069 u8 uapsd_queues;
2070};
2071
7baec808
HW
2072#ifdef CONFIG_MACSEC
2073struct macsec_init_params {
2074 Boolean always_include_sci;
2075 Boolean use_es;
2076 Boolean use_scb;
2077};
2078#endif /* CONFIG_MACSEC */
2079
73d2294f
KP
2080enum drv_br_port_attr {
2081 DRV_BR_PORT_ATTR_PROXYARP,
2082 DRV_BR_PORT_ATTR_HAIRPIN_MODE,
2083};
2084
7565752d
KP
2085enum drv_br_net_param {
2086 DRV_BR_NET_PARAM_GARP_ACCEPT,
60eb9e17 2087 DRV_BR_MULTICAST_SNOOPING,
7565752d
KP
2088};
2089
16689c7c
PX
2090struct drv_acs_params {
2091 /* Selected mode (HOSTAPD_MODE_*) */
2092 enum hostapd_hw_mode hw_mode;
2093
2094 /* Indicates whether HT is enabled */
2095 int ht_enabled;
2096
2097 /* Indicates whether HT40 is enabled */
2098 int ht40_enabled;
857d9422
MM
2099
2100 /* Indicates whether VHT is enabled */
2101 int vht_enabled;
2102
2103 /* Configured ACS channel width */
2104 u16 ch_width;
2105
2106 /* ACS channel list info */
2107 unsigned int ch_list_len;
2108 const u8 *ch_list;
d0cdccd3 2109 const int *freq_list;
16689c7c
PX
2110};
2111
3ab48492
KV
2112struct wpa_bss_trans_info {
2113 u8 mbo_transition_reason;
2114 u8 n_candidates;
2115 u8 *bssid;
2116};
2117
2118struct wpa_bss_candidate_info {
2119 u8 num;
2120 struct candidate_list {
2121 u8 bssid[ETH_ALEN];
2122 u8 is_accept;
2123 u32 reject_reason;
2124 } *candidates;
2125};
7baec808 2126
6fbb5414
VK
2127struct wpa_pmkid_params {
2128 const u8 *bssid;
061a3d3d
VK
2129 const u8 *ssid;
2130 size_t ssid_len;
2131 const u8 *fils_cache_id;
6fbb5414 2132 const u8 *pmkid;
061a3d3d
VK
2133 const u8 *pmk;
2134 size_t pmk_len;
6fbb5414
VK
2135};
2136
3c67e977
VK
2137/* Mask used to specify which connection parameters have to be updated */
2138enum wpa_drv_update_connect_params_mask {
2139 WPA_DRV_UPDATE_ASSOC_IES = BIT(0),
2140 WPA_DRV_UPDATE_FILS_ERP_INFO = BIT(1),
2141 WPA_DRV_UPDATE_AUTH_TYPE = BIT(2),
2142};
2143
ba71cb82
SD
2144/**
2145 * struct external_auth - External authentication trigger parameters
2146 *
2147 * These are used across the external authentication request and event
2148 * interfaces.
2149 * @action: Action type / trigger for external authentication. Only significant
2150 * for the event interface.
2151 * @bssid: BSSID of the peer with which the authentication has to happen. Used
2152 * by both the request and event interface.
2153 * @ssid: SSID of the AP. Used by both the request and event interface.
2154 * @ssid_len: SSID length in octets.
2155 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
2156 * the request interface.
2157 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
2158 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
2159 * the real status code for failures. Used only for the request interface
2160 * from user space to the driver.
236e793e 2161 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
ba71cb82
SD
2162 */
2163struct external_auth {
2164 enum {
2165 EXT_AUTH_START,
2166 EXT_AUTH_ABORT,
2167 } action;
dd1a8cef
JM
2168 const u8 *bssid;
2169 const u8 *ssid;
ba71cb82
SD
2170 size_t ssid_len;
2171 unsigned int key_mgmt_suite;
2172 u16 status;
236e793e 2173 const u8 *pmkid;
ba71cb82
SD
2174};
2175
6fc6879b
JM
2176/**
2177 * struct wpa_driver_ops - Driver interface API definition
2178 *
2179 * This structure defines the API that each driver interface needs to implement
2180 * for core wpa_supplicant code. All driver specific functionality is captured
2181 * in this wrapper.
2182 */
2183struct wpa_driver_ops {
2184 /** Name of the driver interface */
2185 const char *name;
2186 /** One line description of the driver interface */
2187 const char *desc;
2188
2189 /**
2190 * get_bssid - Get the current BSSID
2191 * @priv: private driver interface data
2192 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
2193 *
2194 * Returns: 0 on success, -1 on failure
2195 *
2196 * Query kernel driver for the current BSSID and copy it to bssid.
2197 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
2198 * associated.
2199 */
2200 int (*get_bssid)(void *priv, u8 *bssid);
2201
2202 /**
2203 * get_ssid - Get the current SSID
2204 * @priv: private driver interface data
2205 * @ssid: buffer for SSID (at least 32 bytes)
2206 *
2207 * Returns: Length of the SSID on success, -1 on failure
2208 *
2209 * Query kernel driver for the current SSID and copy it to ssid.
2210 * Returning zero is recommended if the STA is not associated.
2211 *
2212 * Note: SSID is an array of octets, i.e., it is not nul terminated and
2213 * can, at least in theory, contain control characters (including nul)
2214 * and as such, should be processed as binary data, not a printable
2215 * string.
2216 */
2217 int (*get_ssid)(void *priv, u8 *ssid);
2218
6fc6879b
JM
2219 /**
2220 * set_key - Configure encryption key
642187d6 2221 * @ifname: Interface name (for multi-SSID/VLAN support)
6fc6879b
JM
2222 * @priv: private driver interface data
2223 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
eb7719ff 2224 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
30675c34
JM
2225 * %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, %WPA_ALG_CCMP_256,
2226 * %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
2227 * %WPA_ALG_BIP_CMAC_256);
6fc6879b 2228 * %WPA_ALG_NONE clears the key.
0382097e
JM
2229 * @addr: Address of the peer STA (BSSID of the current AP when setting
2230 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
2231 * broadcast keys, %NULL for default keys that are used both for
2232 * broadcast and unicast; when clearing keys, %NULL is used to
2233 * indicate that both the broadcast-only and default key of the
2234 * specified key index is to be cleared
6fc6879b
JM
2235 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
2236 * IGTK
2237 * @set_tx: configure this key as the default Tx key (only used when
2238 * driver does not support separate unicast/individual key
2239 * @seq: sequence number/packet number, seq_len octets, the next
2240 * packet number to be used for in replay protection; configured
2241 * for Rx keys (in most cases, this is only used with broadcast
da64c266 2242 * keys and set to zero for unicast keys); %NULL if not set
6fc6879b 2243 * @seq_len: length of the seq, depends on the algorithm:
eb7719ff 2244 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
6fc6879b
JM
2245 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
2246 * 8-byte Rx Mic Key
2247 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
eb7719ff 2248 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
6fc6879b
JM
2249 *
2250 * Returns: 0 on success, -1 on failure
2251 *
2252 * Configure the given key for the kernel driver. If the driver
2253 * supports separate individual keys (4 default keys + 1 individual),
2254 * addr can be used to determine whether the key is default or
2255 * individual. If only 4 keys are supported, the default key with key
2256 * index 0 is used as the individual key. STA must be configured to use
2257 * it as the default Tx key (set_tx is set) and accept Rx for all the
2258 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
2259 * broadcast keys, so key index 0 is available for this kind of
2260 * configuration.
2261 *
2262 * Please note that TKIP keys include separate TX and RX MIC keys and
2263 * some drivers may expect them in different order than wpa_supplicant
2264 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
61fbd3df 2265 * will trigger Michael MIC errors. This can be fixed by changing the
6fc6879b
JM
2266 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
2267 * in driver_*.c set_key() implementation, see driver_ndis.c for an
2268 * example on how this can be done.
2269 */
71934751 2270 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
642187d6
JM
2271 const u8 *addr, int key_idx, int set_tx,
2272 const u8 *seq, size_t seq_len,
6fc6879b
JM
2273 const u8 *key, size_t key_len);
2274
2275 /**
2276 * init - Initialize driver interface
2277 * @ctx: context to be used when calling wpa_supplicant functions,
2278 * e.g., wpa_supplicant_event()
2279 * @ifname: interface name, e.g., wlan0
2280 *
2281 * Returns: Pointer to private data, %NULL on failure
2282 *
2283 * Initialize driver interface, including event processing for kernel
2284 * driver events (e.g., associated, scan results, Michael MIC failure).
2285 * This function can allocate a private configuration data area for
2286 * @ctx, file descriptor, interface name, etc. information that may be
2287 * needed in future driver operations. If this is not used, non-NULL
2288 * value will need to be returned because %NULL is used to indicate
2289 * failure. The returned value will be used as 'void *priv' data for
2290 * all other driver_ops functions.
2291 *
2292 * The main event loop (eloop.c) of wpa_supplicant can be used to
2293 * register callback for read sockets (eloop_register_read_sock()).
2294 *
2295 * See below for more information about events and
2296 * wpa_supplicant_event() function.
2297 */
2298 void * (*init)(void *ctx, const char *ifname);
2299
2300 /**
2301 * deinit - Deinitialize driver interface
2302 * @priv: private driver interface data from init()
2303 *
2304 * Shut down driver interface and processing of driver events. Free
2305 * private data buffer if one was allocated in init() handler.
2306 */
2307 void (*deinit)(void *priv);
2308
2309 /**
2310 * set_param - Set driver configuration parameters
2311 * @priv: private driver interface data from init()
2312 * @param: driver specific configuration parameters
2313 *
2314 * Returns: 0 on success, -1 on failure
2315 *
2316 * Optional handler for notifying driver interface about configuration
2317 * parameters (driver_param).
2318 */
2319 int (*set_param)(void *priv, const char *param);
2320
2321 /**
2322 * set_countermeasures - Enable/disable TKIP countermeasures
2323 * @priv: private driver interface data
2324 * @enabled: 1 = countermeasures enabled, 0 = disabled
2325 *
2326 * Returns: 0 on success, -1 on failure
2327 *
2328 * Configure TKIP countermeasures. When these are enabled, the driver
2329 * should drop all received and queued frames that are using TKIP.
2330 */
2331 int (*set_countermeasures)(void *priv, int enabled);
2332
6fc6879b
JM
2333 /**
2334 * deauthenticate - Request driver to deauthenticate
2335 * @priv: private driver interface data
2336 * @addr: peer address (BSSID of the AP)
2337 * @reason_code: 16-bit reason code to be sent in the deauthentication
2338 * frame
2339 *
2340 * Returns: 0 on success, -1 on failure
2341 */
4be17ffb 2342 int (*deauthenticate)(void *priv, const u8 *addr, u16 reason_code);
6fc6879b 2343
6fc6879b
JM
2344 /**
2345 * associate - Request driver to associate
2346 * @priv: private driver interface data
2347 * @params: association parameters
2348 *
2349 * Returns: 0 on success, -1 on failure
2350 */
2351 int (*associate)(void *priv,
2352 struct wpa_driver_associate_params *params);
2353
6fc6879b
JM
2354 /**
2355 * add_pmkid - Add PMKSA cache entry to the driver
2356 * @priv: private driver interface data
6fbb5414 2357 * @params: PMKSA parameters
6fc6879b
JM
2358 *
2359 * Returns: 0 on success, -1 on failure
2360 *
2361 * This function is called when a new PMK is received, as a result of
061a3d3d
VK
2362 * either normal authentication or RSN pre-authentication. The PMKSA
2363 * parameters are either a set of bssid, pmkid, and pmk; or a set of
2364 * ssid, fils_cache_id, pmkid, and pmk.
6fc6879b
JM
2365 *
2366 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2367 * associate(), add_pmkid() can be used to add new PMKSA cache entries
2368 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
2369 * driver_ops function does not need to be implemented. Likewise, if
2370 * the driver does not support WPA, this function is not needed.
2371 */
6fbb5414 2372 int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params);
6fc6879b
JM
2373
2374 /**
2375 * remove_pmkid - Remove PMKSA cache entry to the driver
2376 * @priv: private driver interface data
6fbb5414 2377 * @params: PMKSA parameters
6fc6879b
JM
2378 *
2379 * Returns: 0 on success, -1 on failure
2380 *
2381 * This function is called when the supplicant drops a PMKSA cache
061a3d3d
VK
2382 * entry for any reason. The PMKSA parameters are either a set of
2383 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
6fc6879b
JM
2384 *
2385 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2386 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2387 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2388 * from wpa_supplicant, this driver_ops function does not need to be
2389 * implemented. Likewise, if the driver does not support WPA, this
2390 * function is not needed.
2391 */
6fbb5414 2392 int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params);
6fc6879b
JM
2393
2394 /**
2395 * flush_pmkid - Flush PMKSA cache
2396 * @priv: private driver interface data
2397 *
2398 * Returns: 0 on success, -1 on failure
2399 *
2400 * This function is called when the supplicant drops all PMKSA cache
2401 * entries for any reason.
2402 *
2403 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
2404 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
2405 * between the driver and wpa_supplicant. If the driver uses wpa_ie
2406 * from wpa_supplicant, this driver_ops function does not need to be
2407 * implemented. Likewise, if the driver does not support WPA, this
2408 * function is not needed.
2409 */
2410 int (*flush_pmkid)(void *priv);
2411
2412 /**
6179d2fd 2413 * get_capa - Get driver capabilities
6fc6879b
JM
2414 * @priv: private driver interface data
2415 *
2416 * Returns: 0 on success, -1 on failure
2417 *
2418 * Get driver/firmware/hardware capabilities.
2419 */
2420 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
2421
2422 /**
2423 * poll - Poll driver for association information
2424 * @priv: private driver interface data
2425 *
2426 * This is an option callback that can be used when the driver does not
2427 * provide event mechanism for association events. This is called when
2428 * receiving WPA EAPOL-Key messages that require association
2429 * information. The driver interface is supposed to generate associnfo
2430 * event before returning from this callback function. In addition, the
2431 * driver interface should generate an association event after having
2432 * sent out associnfo.
2433 */
2434 void (*poll)(void *priv);
2435
45e3fc72
RM
2436 /**
2437 * get_ifindex - Get interface index
2438 * @priv: private driver interface data
2439 *
2440 * Returns: Interface index
2441 */
2442 unsigned int (*get_ifindex)(void *priv);
2443
6fc6879b
JM
2444 /**
2445 * get_ifname - Get interface name
2446 * @priv: private driver interface data
2447 *
2448 * Returns: Pointer to the interface name. This can differ from the
e519314e 2449 * interface name used in init() call. Init() is called first.
6fc6879b
JM
2450 *
2451 * This optional function can be used to allow the driver interface to
2452 * replace the interface name with something else, e.g., based on an
2453 * interface mapping from a more descriptive name.
2454 */
2455 const char * (*get_ifname)(void *priv);
2456
2457 /**
2458 * get_mac_addr - Get own MAC address
2459 * @priv: private driver interface data
2460 *
2461 * Returns: Pointer to own MAC address or %NULL on failure
2462 *
2463 * This optional function can be used to get the own MAC address of the
2464 * device from the driver interface code. This is only needed if the
2465 * l2_packet implementation for the OS does not provide easy access to
2466 * a MAC address. */
2467 const u8 * (*get_mac_addr)(void *priv);
2468
6fc6879b
JM
2469 /**
2470 * set_operstate - Sets device operating state to DORMANT or UP
2471 * @priv: private driver interface data
2472 * @state: 0 = dormant, 1 = up
2473 * Returns: 0 on success, -1 on failure
2474 *
2475 * This is an optional function that can be used on operating systems
2476 * that support a concept of controlling network device state from user
2477 * space applications. This function, if set, gets called with
2478 * state = 1 when authentication has been completed and with state = 0
2479 * when connection is lost.
2480 */
2481 int (*set_operstate)(void *priv, int state);
2482
2483 /**
2484 * mlme_setprotection - MLME-SETPROTECTION.request primitive
2485 * @priv: Private driver interface data
2486 * @addr: Address of the station for which to set protection (may be
2487 * %NULL for group keys)
2488 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
2489 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
2490 * Returns: 0 on success, -1 on failure
2491 *
2492 * This is an optional function that can be used to set the driver to
2493 * require protection for Tx and/or Rx frames. This uses the layer
2494 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
2495 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
2496 * set protection operation; instead, they set protection implicitly
2497 * based on configured keys.
2498 */
2499 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
2500 int key_type);
2501
2502 /**
2503 * get_hw_feature_data - Get hardware support data (channels and rates)
2504 * @priv: Private driver interface data
2505 * @num_modes: Variable for returning the number of returned modes
2506 * flags: Variable for returning hardware feature flags
aa56e36d 2507 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
6fc6879b
JM
2508 * Returns: Pointer to allocated hardware data on success or %NULL on
2509 * failure. Caller is responsible for freeing this.
6fc6879b 2510 */
6caf9ca6
JM
2511 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
2512 u16 *num_modes,
aa56e36d 2513 u16 *flags, u8 *dfs);
6fc6879b 2514
6fc6879b
JM
2515 /**
2516 * send_mlme - Send management frame from MLME
2517 * @priv: Private driver interface data
2518 * @data: IEEE 802.11 management frame with IEEE 802.11 header
2519 * @data_len: Size of the management frame
8cfa3527 2520 * @noack: Do not wait for this frame to be acked (disable retries)
5d180a77
AO
2521 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
2522 * driver decide
2d3943ce
AO
2523 * @csa_offs: Array of CSA offsets or %NULL
2524 * @csa_offs_len: Number of elements in csa_offs
6fc6879b 2525 * Returns: 0 on success, -1 on failure
6fc6879b 2526 */
8cfa3527 2527 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
2d3943ce
AO
2528 int noack, unsigned int freq, const u16 *csa_offs,
2529 size_t csa_offs_len);
6fc6879b 2530
6fc6879b
JM
2531 /**
2532 * update_ft_ies - Update FT (IEEE 802.11r) IEs
2533 * @priv: Private driver interface data
2534 * @md: Mobility domain (2 octets) (also included inside ies)
2535 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
2536 * @ies_len: Length of FT IEs in bytes
2537 * Returns: 0 on success, -1 on failure
2538 *
2539 * The supplicant uses this callback to let the driver know that keying
2540 * material for FT is available and that the driver can use the
2541 * provided IEs in the next message in FT authentication sequence.
2542 *
2543 * This function is only needed for driver that support IEEE 802.11r
2544 * (Fast BSS Transition).
2545 */
2546 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
2547 size_t ies_len);
2548
6fc6879b
JM
2549 /**
2550 * get_scan_results2 - Fetch the latest scan results
2551 * @priv: private driver interface data
2552 *
2553 * Returns: Allocated buffer of scan results (caller is responsible for
2554 * freeing the data structure) on success, NULL on failure
2555 */
2556 struct wpa_scan_results * (*get_scan_results2)(void *priv);
2557
6d158490
LR
2558 /**
2559 * set_country - Set country
2560 * @priv: Private driver interface data
2561 * @alpha2: country to which to switch to
2562 * Returns: 0 on success, -1 on failure
2563 *
2564 * This function is for drivers which support some form
2565 * of setting a regulatory domain.
2566 */
2567 int (*set_country)(void *priv, const char *alpha2);
ac305589 2568
f0793bf1
JM
2569 /**
2570 * get_country - Get country
2571 * @priv: Private driver interface data
2572 * @alpha2: Buffer for returning country code (at least 3 octets)
2573 * Returns: 0 on success, -1 on failure
2574 */
2575 int (*get_country)(void *priv, char *alpha2);
2576
ac305589
JM
2577 /**
2578 * global_init - Global driver initialization
45e3fc72 2579 * @ctx: wpa_global pointer
ac305589
JM
2580 * Returns: Pointer to private data (global), %NULL on failure
2581 *
2582 * This optional function is called to initialize the driver wrapper
2583 * for global data, i.e., data that applies to all interfaces. If this
2584 * function is implemented, global_deinit() will also need to be
2585 * implemented to free the private data. The driver will also likely
2586 * use init2() function instead of init() to get the pointer to global
2587 * data available to per-interface initializer.
2588 */
45e3fc72 2589 void * (*global_init)(void *ctx);
ac305589
JM
2590
2591 /**
2592 * global_deinit - Global driver deinitialization
2593 * @priv: private driver global data from global_init()
2594 *
2595 * Terminate any global driver related functionality and free the
2596 * global data structure.
2597 */
2598 void (*global_deinit)(void *priv);
2599
2600 /**
2601 * init2 - Initialize driver interface (with global data)
2602 * @ctx: context to be used when calling wpa_supplicant functions,
2603 * e.g., wpa_supplicant_event()
2604 * @ifname: interface name, e.g., wlan0
2605 * @global_priv: private driver global data from global_init()
2606 * Returns: Pointer to private data, %NULL on failure
2607 *
2608 * This function can be used instead of init() if the driver wrapper
2609 * uses global data.
2610 */
2611 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
4b4a8ae5
JM
2612
2613 /**
2614 * get_interfaces - Get information about available interfaces
2615 * @global_priv: private driver global data from global_init()
2616 * Returns: Allocated buffer of interface information (caller is
2617 * responsible for freeing the data structure) on success, NULL on
2618 * failure
2619 */
2620 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
fc2b7ed5
JM
2621
2622 /**
2623 * scan2 - Request the driver to initiate scan
2624 * @priv: private driver interface data
2625 * @params: Scan parameters
2626 *
2627 * Returns: 0 on success, -1 on failure
2628 *
2629 * Once the scan results are ready, the driver should report scan
2630 * results event for wpa_supplicant which will eventually request the
2631 * results with wpa_driver_get_scan_results2().
2632 */
2633 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
c2a04078
JM
2634
2635 /**
2636 * authenticate - Request driver to authenticate
2637 * @priv: private driver interface data
2638 * @params: authentication parameters
2639 * Returns: 0 on success, -1 on failure
2640 *
2641 * This is an optional function that can be used with drivers that
2642 * support separate authentication and association steps, i.e., when
2643 * wpa_supplicant can act as the SME. If not implemented, associate()
2644 * function is expected to take care of IEEE 802.11 authentication,
2645 * too.
2646 */
d2440ba0
JM
2647 int (*authenticate)(void *priv,
2648 struct wpa_driver_auth_params *params);
2649
15333707 2650 /**
19c3b566 2651 * set_ap - Set Beacon and Probe Response information for AP mode
15333707 2652 * @priv: Private driver interface data
19c3b566 2653 * @params: Parameters to use in AP mode
15333707 2654 *
19c3b566
JM
2655 * This function is used to configure Beacon template and/or extra IEs
2656 * to add for Beacon and Probe Response frames for the driver in
15333707
JM
2657 * AP mode. The driver is responsible for building the full Beacon
2658 * frame by concatenating the head part with TIM IE generated by the
19c3b566
JM
2659 * driver/firmware and finishing with the tail part. Depending on the
2660 * driver architectue, this can be done either by using the full
2661 * template or the set of additional IEs (e.g., WPS and P2P IE).
2662 * Similarly, Probe Response processing depends on the driver design.
2663 * If the driver (or firmware) takes care of replying to Probe Request
2664 * frames, the extra IEs provided here needs to be added to the Probe
2665 * Response frames.
2666 *
2667 * Returns: 0 on success, -1 on failure
15333707 2668 */
19c3b566 2669 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
c5121837 2670
3c4ca363
VN
2671 /**
2672 * set_acl - Set ACL in AP mode
2673 * @priv: Private driver interface data
2674 * @params: Parameters to configure ACL
2675 * Returns: 0 on success, -1 on failure
2676 *
2677 * This is used only for the drivers which support MAC address ACL.
2678 */
2679 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
2680
15333707
JM
2681 /**
2682 * hapd_init - Initialize driver interface (hostapd only)
2683 * @hapd: Pointer to hostapd context
2684 * @params: Configuration for the driver wrapper
2685 * Returns: Pointer to private data, %NULL on failure
2686 *
2687 * This function is used instead of init() or init2() when the driver
ffbf1eaa 2688 * wrapper is used with hostapd.
15333707 2689 */
92f475b4
JM
2690 void * (*hapd_init)(struct hostapd_data *hapd,
2691 struct wpa_init_params *params);
15333707
JM
2692
2693 /**
2694 * hapd_deinit - Deinitialize driver interface (hostapd only)
2695 * @priv: Private driver interface data from hapd_init()
2696 */
c5121837
JM
2697 void (*hapd_deinit)(void *priv);
2698
2699 /**
15333707 2700 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
15333707 2701 * @priv: Private driver interface data
e3bd3912 2702 * @params: BSS parameters
c5121837
JM
2703 * Returns: 0 on success, -1 on failure
2704 *
15333707 2705 * This is an optional function to configure the kernel driver to
e3bd3912
JM
2706 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
2707 * can be left undefined (set to %NULL) if IEEE 802.1X support is
dcd1eb5b 2708 * always enabled and the driver uses set_ap() to set WPA/RSN IE
e3bd3912 2709 * for Beacon frames.
062390ef
JM
2710 *
2711 * DEPRECATED - use set_ap() instead
c5121837 2712 */
e3bd3912 2713 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
c5121837
JM
2714
2715 /**
15333707
JM
2716 * set_privacy - Enable/disable privacy (AP only)
2717 * @priv: Private driver interface data
c5121837 2718 * @enabled: 1 = privacy enabled, 0 = disabled
15333707 2719 * Returns: 0 on success, -1 on failure
c5121837 2720 *
15333707
JM
2721 * This is an optional function to configure privacy field in the
2722 * kernel driver for Beacon frames. This can be left undefined (set to
dcd1eb5b 2723 * %NULL) if the driver uses the Beacon template from set_ap().
062390ef
JM
2724 *
2725 * DEPRECATED - use set_ap() instead
c5121837 2726 */
d5dd016a 2727 int (*set_privacy)(void *priv, int enabled);
c5121837 2728
15333707
JM
2729 /**
2730 * get_seqnum - Fetch the current TSC/packet number (AP only)
2731 * @ifname: The interface name (main or virtual)
2732 * @priv: Private driver interface data
2733 * @addr: MAC address of the station or %NULL for group keys
2734 * @idx: Key index
2735 * @seq: Buffer for returning the latest used TSC/packet number
2736 * Returns: 0 on success, -1 on failure
2737 *
2738 * This function is used to fetch the last used TSC/packet number for
eb7719ff
JM
2739 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
2740 * keys, so there is no strict requirement on implementing support for
2741 * unicast keys (i.e., addr != %NULL).
15333707 2742 */
c5121837
JM
2743 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
2744 int idx, u8 *seq);
15333707 2745
15333707
JM
2746 /**
2747 * flush - Flush all association stations (AP only)
2748 * @priv: Private driver interface data
2749 * Returns: 0 on success, -1 on failure
2750 *
2751 * This function requests the driver to disassociate all associated
2752 * stations. This function does not need to be implemented if the
2753 * driver does not process association frames internally.
2754 */
c5121837 2755 int (*flush)(void *priv);
15333707
JM
2756
2757 /**
2758 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
15333707
JM
2759 * @priv: Private driver interface data
2760 * @elem: Information elements
2761 * @elem_len: Length of the elem buffer in octets
2762 * Returns: 0 on success, -1 on failure
2763 *
2764 * This is an optional function to add information elements in the
2765 * kernel driver for Beacon and Probe Response frames. This can be left
2766 * undefined (set to %NULL) if the driver uses the Beacon template from
dcd1eb5b 2767 * set_ap().
062390ef
JM
2768 *
2769 * DEPRECATED - use set_ap() instead
15333707 2770 */
aa484516 2771 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
c5121837 2772
15333707 2773 /**
d732463c 2774 * read_sta_data - Fetch station data
15333707
JM
2775 * @priv: Private driver interface data
2776 * @data: Buffer for returning station information
2777 * @addr: MAC address of the station
2778 * Returns: 0 on success, -1 on failure
2779 */
c5121837
JM
2780 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
2781 const u8 *addr);
15333707
JM
2782
2783 /**
2784 * hapd_send_eapol - Send an EAPOL packet (AP only)
2785 * @priv: private driver interface data
2786 * @addr: Destination MAC address
2787 * @data: EAPOL packet starting with IEEE 802.1X header
2788 * @data_len: Length of the EAPOL packet in octets
2789 * @encrypt: Whether the frame should be encrypted
2790 * @own_addr: Source MAC address
4378fc14 2791 * @flags: WPA_STA_* flags for the destination station
15333707
JM
2792 *
2793 * Returns: 0 on success, -1 on failure
2794 */
c5121837
JM
2795 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
2796 size_t data_len, int encrypt,
4378fc14 2797 const u8 *own_addr, u32 flags);
15333707 2798
90b8c4c5
JM
2799 /**
2800 * sta_deauth - Deauthenticate a station (AP only)
2801 * @priv: Private driver interface data
2802 * @own_addr: Source address and BSSID for the Deauthentication frame
2803 * @addr: MAC address of the station to deauthenticate
2804 * @reason: Reason code for the Deauthentiation frame
2805 * Returns: 0 on success, -1 on failure
2806 *
2807 * This function requests a specific station to be deauthenticated and
2808 * a Deauthentication frame to be sent to it.
2809 */
731723a5 2810 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
4be17ffb 2811 u16 reason);
90b8c4c5
JM
2812
2813 /**
2814 * sta_disassoc - Disassociate a station (AP only)
2815 * @priv: Private driver interface data
2816 * @own_addr: Source address and BSSID for the Disassociation frame
2817 * @addr: MAC address of the station to disassociate
2818 * @reason: Reason code for the Disassociation frame
2819 * Returns: 0 on success, -1 on failure
2820 *
2821 * This function requests a specific station to be disassociated and
2822 * a Disassociation frame to be sent to it.
2823 */
731723a5 2824 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
4be17ffb 2825 u16 reason);
90b8c4c5
JM
2826
2827 /**
2828 * sta_remove - Remove a station entry (AP only)
2829 * @priv: Private driver interface data
2830 * @addr: MAC address of the station to be removed
2831 * Returns: 0 on success, -1 on failure
2832 */
c5121837 2833 int (*sta_remove)(void *priv, const u8 *addr);
90b8c4c5
JM
2834
2835 /**
2836 * hapd_get_ssid - Get the current SSID (AP only)
90b8c4c5
JM
2837 * @priv: Private driver interface data
2838 * @buf: Buffer for returning the SSID
2839 * @len: Maximum length of the buffer
2840 * Returns: Length of the SSID on success, -1 on failure
2841 *
2842 * This function need not be implemented if the driver uses Beacon
dcd1eb5b 2843 * template from set_ap() and does not reply to Probe Request frames.
90b8c4c5 2844 */
8709de1a 2845 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
90b8c4c5
JM
2846
2847 /**
2848 * hapd_set_ssid - Set SSID (AP only)
90b8c4c5
JM
2849 * @priv: Private driver interface data
2850 * @buf: SSID
2851 * @len: Length of the SSID in octets
2852 * Returns: 0 on success, -1 on failure
062390ef
JM
2853 *
2854 * DEPRECATED - use set_ap() instead
90b8c4c5 2855 */
8709de1a
JM
2856 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
2857
90b8c4c5
JM
2858 /**
2859 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
2860 * @priv: Private driver interface data
2861 * @enabled: 1 = countermeasures enabled, 0 = disabled
2862 * Returns: 0 on success, -1 on failure
2863 *
2864 * This need not be implemented if the driver does not take care of
2865 * association processing.
2866 */
c5121837 2867 int (*hapd_set_countermeasures)(void *priv, int enabled);
90b8c4c5
JM
2868
2869 /**
2870 * sta_add - Add a station entry
90b8c4c5
JM
2871 * @priv: Private driver interface data
2872 * @params: Station parameters
2873 * Returns: 0 on success, -1 on failure
2874 *
dc55b6b6
AB
2875 * This function is used to add or set (params->set 1) a station
2876 * entry in the driver. Adding STA entries is used only if the driver
90b8c4c5 2877 * does not take care of association processing.
45b722f1 2878 *
dc55b6b6
AB
2879 * With drivers that don't support full AP client state, this function
2880 * is used to add a station entry to the driver once the station has
2881 * completed association.
2882 *
2883 * With TDLS, this function is used to add or set (params->set 1)
2884 * TDLS peer entries (even with drivers that do not support full AP
2885 * client state).
90b8c4c5 2886 */
62847751 2887 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
90b8c4c5
JM
2888
2889 /**
2890 * get_inact_sec - Get station inactivity duration (AP only)
2891 * @priv: Private driver interface data
2892 * @addr: Station address
2893 * Returns: Number of seconds station has been inactive, -1 on failure
2894 */
c5121837 2895 int (*get_inact_sec)(void *priv, const u8 *addr);
90b8c4c5
JM
2896
2897 /**
2898 * sta_clear_stats - Clear station statistics (AP only)
2899 * @priv: Private driver interface data
2900 * @addr: Station address
2901 * Returns: 0 on success, -1 on failure
2902 */
c5121837
JM
2903 int (*sta_clear_stats)(void *priv, const u8 *addr);
2904
90b8c4c5
JM
2905 /**
2906 * set_freq - Set channel/frequency (AP only)
2907 * @priv: Private driver interface data
2908 * @freq: Channel parameters
2909 * Returns: 0 on success, -1 on failure
2910 */
c5121837 2911 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
90b8c4c5
JM
2912
2913 /**
2914 * set_rts - Set RTS threshold
2915 * @priv: Private driver interface data
2916 * @rts: RTS threshold in octets
2917 * Returns: 0 on success, -1 on failure
2918 */
c5121837 2919 int (*set_rts)(void *priv, int rts);
90b8c4c5
JM
2920
2921 /**
2922 * set_frag - Set fragmentation threshold
2923 * @priv: Private driver interface data
2924 * @frag: Fragmentation threshold in octets
2925 * Returns: 0 on success, -1 on failure
2926 */
c5121837 2927 int (*set_frag)(void *priv, int frag);
c5121837 2928
90b8c4c5
JM
2929 /**
2930 * sta_set_flags - Set station flags (AP only)
2931 * @priv: Private driver interface data
2932 * @addr: Station address
0de39516
JM
2933 * @total_flags: Bitmap of all WPA_STA_* flags currently set
2934 * @flags_or: Bitmap of WPA_STA_* flags to add
2935 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
90b8c4c5
JM
2936 * Returns: 0 on success, -1 on failure
2937 */
3234cba4 2938 int (*sta_set_flags)(void *priv, const u8 *addr,
f97e3ce4
JM
2939 unsigned int total_flags, unsigned int flags_or,
2940 unsigned int flags_and);
90b8c4c5 2941
6720b948
THJ
2942 /**
2943 * sta_set_airtime_weight - Set station airtime weight (AP only)
2944 * @priv: Private driver interface data
2945 * @addr: Station address
2946 * @weight: New weight for station airtime assignment
2947 * Returns: 0 on success, -1 on failure
2948 */
2949 int (*sta_set_airtime_weight)(void *priv, const u8 *addr,
2950 unsigned int weight);
2951
90b8c4c5
JM
2952 /**
2953 * set_tx_queue_params - Set TX queue parameters
2954 * @priv: Private driver interface data
7e3c1781 2955 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
90b8c4c5
JM
2956 * @aifs: AIFS
2957 * @cw_min: cwMin
2958 * @cw_max: cwMax
2959 * @burst_time: Maximum length for bursting in 0.1 msec units
2960 */
c5121837
JM
2961 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
2962 int cw_max, int burst_time);
90b8c4c5 2963
22a7c9d7
JM
2964 /**
2965 * if_add - Add a virtual interface
15333707 2966 * @priv: Private driver interface data
22a7c9d7
JM
2967 * @type: Interface type
2968 * @ifname: Interface name for the new virtual interface
2969 * @addr: Local address to use for the interface or %NULL to use the
2970 * parent interface address
8043e725 2971 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
a2e40bb6
FF
2972 * @drv_priv: Pointer for overwriting the driver context or %NULL if
2973 * not allowed (applies only to %WPA_IF_AP_BSS type)
f3585c8a
JM
2974 * @force_ifname: Buffer for returning an interface name that the
2975 * driver ended up using if it differs from the requested ifname
2976 * @if_addr: Buffer for returning the allocated interface address
2977 * (this may differ from the requested addr if the driver cannot
2978 * change interface address)
e17a2477 2979 * @bridge: Bridge interface to use or %NULL if no bridge configured
2aec4f3c 2980 * @use_existing: Whether to allow existing interface to be used
d8a3b66d 2981 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
22a7c9d7
JM
2982 * Returns: 0 on success, -1 on failure
2983 */
7ab68865
JM
2984 int (*if_add)(void *priv, enum wpa_driver_if_type type,
2985 const char *ifname, const u8 *addr, void *bss_ctx,
e17a2477 2986 void **drv_priv, char *force_ifname, u8 *if_addr,
d8a3b66d 2987 const char *bridge, int use_existing, int setup_ap);
22a7c9d7
JM
2988
2989 /**
2990 * if_remove - Remove a virtual interface
2991 * @priv: Private driver interface data
2992 * @type: Interface type
2993 * @ifname: Interface name of the virtual interface to be removed
2994 * Returns: 0 on success, -1 on failure
2995 */
2996 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
2997 const char *ifname);
90b8c4c5 2998
15333707
JM
2999 /**
3000 * set_sta_vlan - Bind a station into a specific interface (AP only)
3001 * @priv: Private driver interface data
3002 * @ifname: Interface (main or virtual BSS or VLAN)
3003 * @addr: MAC address of the associated station
3004 * @vlan_id: VLAN ID
3005 * Returns: 0 on success, -1 on failure
3006 *
3007 * This function is used to bind a station to a specific virtual
3008 * interface. It is only used if when virtual interfaces are supported,
3009 * e.g., to assign stations to different VLAN interfaces based on
3010 * information from a RADIUS server. This allows separate broadcast
3011 * domains to be used with a single BSS.
3012 */
c5121837
JM
3013 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
3014 int vlan_id);
15333707 3015
c5121837 3016 /**
15333707 3017 * commit - Optional commit changes handler (AP only)
c5121837
JM
3018 * @priv: driver private data
3019 * Returns: 0 on success, -1 on failure
3020 *
3021 * This optional handler function can be registered if the driver
3022 * interface implementation needs to commit changes (e.g., by setting
3023 * network interface up) at the end of initial configuration. If set,
3024 * this handler will be called after initial setup has been completed.
3025 */
3026 int (*commit)(void *priv);
3027
90b8c4c5
JM
3028 /**
3029 * send_ether - Send an ethernet packet (AP only)
3030 * @priv: private driver interface data
3031 * @dst: Destination MAC address
3032 * @src: Source MAC address
3033 * @proto: Ethertype
3034 * @data: EAPOL packet starting with IEEE 802.1X header
3035 * @data_len: Length of the EAPOL packet in octets
3036 * Returns: 0 on success, -1 on failure
3037 */
c5121837
JM
3038 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
3039 const u8 *data, size_t data_len);
3040
90b8c4c5
JM
3041 /**
3042 * set_radius_acl_auth - Notification of RADIUS ACL change
3043 * @priv: Private driver interface data
3044 * @mac: MAC address of the station
3045 * @accepted: Whether the station was accepted
3046 * @session_timeout: Session timeout for the station
3047 * Returns: 0 on success, -1 on failure
3048 */
0e80ea2c 3049 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
c5121837 3050 u32 session_timeout);
90b8c4c5
JM
3051
3052 /**
3053 * set_radius_acl_expire - Notification of RADIUS ACL expiration
3054 * @priv: Private driver interface data
3055 * @mac: MAC address of the station
3056 * Returns: 0 on success, -1 on failure
3057 */
c5121837
JM
3058 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
3059
15333707 3060 /**
b3db190f 3061 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
15333707 3062 * @priv: Private driver interface data
b3db190f
JM
3063 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
3064 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
3065 * extra IE(s)
0e2e565a
JM
3066 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
3067 * to remove extra IE(s)
15333707
JM
3068 * Returns: 0 on success, -1 on failure
3069 *
3070 * This is an optional function to add WPS IE in the kernel driver for
14f79386 3071 * Beacon and Probe Response frames. This can be left undefined (set
dcd1eb5b 3072 * to %NULL) if the driver uses the Beacon template from set_ap()
0e2e565a
JM
3073 * and does not process Probe Request frames. If the driver takes care
3074 * of (Re)Association frame processing, the assocresp buffer includes
3075 * WPS IE(s) that need to be added to (Re)Association Response frames
3076 * whenever a (Re)Association Request frame indicated use of WPS.
75bde05d
JM
3077 *
3078 * This will also be used to add P2P IE(s) into Beacon/Probe Response
3079 * frames when operating as a GO. The driver is responsible for adding
3080 * timing related attributes (e.g., NoA) in addition to the IEs
3081 * included here by appending them after these buffers. This call is
3082 * also used to provide Probe Response IEs for P2P Listen state
3083 * operations for drivers that generate the Probe Response frames
3084 * internally.
062390ef
JM
3085 *
3086 * DEPRECATED - use set_ap() instead
15333707 3087 */
0ebdf627 3088 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
0e2e565a
JM
3089 const struct wpabuf *proberesp,
3090 const struct wpabuf *assocresp);
4bc181ec
JM
3091
3092 /**
3093 * set_supp_port - Set IEEE 802.1X Supplicant Port status
3094 * @priv: Private driver interface data
3095 * @authorized: Whether the port is authorized
3096 * Returns: 0 on success, -1 on failure
3097 */
3098 int (*set_supp_port)(void *priv, int authorized);
fbbfcbac
FF
3099
3100 /**
3101 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
3102 * @priv: Private driver interface data
3103 * @addr: MAC address of the associated station
3104 * @aid: Association ID
3105 * @val: 1 = bind to 4-address WDS; 0 = unbind
d38ae2ea
FF
3106 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
3107 * to indicate that bridge is not to be used
69dd2967
SM
3108 * @ifname_wds: Buffer to return the interface name for the new WDS
3109 * station or %NULL to indicate name is not returned.
fbbfcbac
FF
3110 * Returns: 0 on success, -1 on failure
3111 */
d38ae2ea 3112 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
0e80ea2c 3113 const char *bridge_ifname, char *ifname_wds);
504e905c 3114
55777702
JM
3115 /**
3116 * send_action - Transmit an Action frame
3117 * @priv: Private driver interface data
3118 * @freq: Frequency (in MHz) of the channel
190b9062 3119 * @wait: Time to wait off-channel for a response (in ms), or zero
e8828999
JM
3120 * @dst: Destination MAC address (Address 1)
3121 * @src: Source MAC address (Address 2)
3122 * @bssid: BSSID (Address 3)
55777702
JM
3123 * @data: Frame body
3124 * @data_len: data length in octets
b106173a 3125 @ @no_cck: Whether CCK rates must not be used to transmit this frame
55777702
JM
3126 * Returns: 0 on success, -1 on failure
3127 *
3128 * This command can be used to request the driver to transmit an action
190b9062
JB
3129 * frame to the specified destination.
3130 *
3131 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
3132 * be transmitted on the given channel and the device will wait for a
3133 * response on that channel for the given wait time.
3134 *
3135 * If the flag is not set, the wait time will be ignored. In this case,
3136 * if a remain-on-channel duration is in progress, the frame must be
3137 * transmitted on that channel; alternatively the frame may be sent on
3138 * the current operational channel (if in associated state in station
3139 * mode or while operating as an AP.)
8331c9b3
VK
3140 *
3141 * If @src differs from the device MAC address, use of a random
3142 * transmitter address is requested for this message exchange.
55777702 3143 */
190b9062 3144 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
e8828999 3145 const u8 *dst, const u8 *src, const u8 *bssid,
b106173a 3146 const u8 *data, size_t data_len, int no_cck);
55777702 3147
190b9062
JB
3148 /**
3149 * send_action_cancel_wait - Cancel action frame TX wait
3150 * @priv: Private driver interface data
3151 *
3152 * This command cancels the wait time associated with sending an action
3153 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
3154 * set in the driver flags.
3155 */
3156 void (*send_action_cancel_wait)(void *priv);
3157
55777702
JM
3158 /**
3159 * remain_on_channel - Remain awake on a channel
3160 * @priv: Private driver interface data
3161 * @freq: Frequency (in MHz) of the channel
3162 * @duration: Duration in milliseconds
3163 * Returns: 0 on success, -1 on failure
3164 *
3165 * This command is used to request the driver to remain awake on the
3166 * specified channel for the specified duration and report received
dbfb8e82 3167 * Action frames with EVENT_RX_MGMT events. Optionally, received
55777702
JM
3168 * Probe Request frames may also be requested to be reported by calling
3169 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
3170 *
3171 * The driver may not be at the requested channel when this function
3172 * returns, i.e., the return code is only indicating whether the
3173 * request was accepted. The caller will need to wait until the
3174 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
3175 * completed the channel change. This may take some time due to other
3176 * need for the radio and the caller should be prepared to timing out
3177 * its wait since there are no guarantees on when this request can be
3178 * executed.
3179 */
3180 int (*remain_on_channel)(void *priv, unsigned int freq,
3181 unsigned int duration);
3182
3183 /**
3184 * cancel_remain_on_channel - Cancel remain-on-channel operation
3185 * @priv: Private driver interface data
3186 *
3187 * This command can be used to cancel a remain-on-channel operation
3188 * before its originally requested duration has passed. This could be
3189 * used, e.g., when remain_on_channel() is used to request extra time
3190 * to receive a response to an Action frame and the response is
3191 * received when there is still unneeded time remaining on the
3192 * remain-on-channel operation.
3193 */
3194 int (*cancel_remain_on_channel)(void *priv);
3195
504e905c
JM
3196 /**
3197 * probe_req_report - Request Probe Request frames to be indicated
3198 * @priv: Private driver interface data
3199 * @report: Whether to report received Probe Request frames
3200 * Returns: 0 on success, -1 on failure (or if not supported)
3201 *
3202 * This command can be used to request the driver to indicate when
3203 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
3204 * Since this operation may require extra resources, e.g., due to less
3205 * optimal hardware/firmware RX filtering, many drivers may disable
3206 * Probe Request reporting at least in station mode. This command is
3207 * used to notify the driver when the Probe Request frames need to be
3208 * reported, e.g., during remain-on-channel operations.
3209 */
3210 int (*probe_req_report)(void *priv, int report);
4e5cb1a3 3211
af473088
JM
3212 /**
3213 * deinit_ap - Deinitialize AP mode
3214 * @priv: Private driver interface data
3215 * Returns: 0 on success, -1 on failure (or if not supported)
3216 *
3217 * This optional function can be used to disable AP mode related
60b13c20
IP
3218 * configuration. If the interface was not dynamically added,
3219 * change the driver mode to station mode to allow normal station
3220 * operations like scanning to be completed.
af473088
JM
3221 */
3222 int (*deinit_ap)(void *priv);
207ef3fb 3223
3c29244e
EP
3224 /**
3225 * deinit_p2p_cli - Deinitialize P2P client mode
3226 * @priv: Private driver interface data
3227 * Returns: 0 on success, -1 on failure (or if not supported)
3228 *
60b13c20
IP
3229 * This optional function can be used to disable P2P client mode. If the
3230 * interface was not dynamically added, change the interface type back
3231 * to station mode.
3c29244e
EP
3232 */
3233 int (*deinit_p2p_cli)(void *priv);
3234
207ef3fb
JM
3235 /**
3236 * suspend - Notification on system suspend/hibernate event
3237 * @priv: Private driver interface data
3238 */
3239 void (*suspend)(void *priv);
3240
3241 /**
3242 * resume - Notification on system resume/thaw event
3243 * @priv: Private driver interface data
3244 */
3245 void (*resume)(void *priv);
b625473c
JM
3246
3247 /**
3248 * signal_monitor - Set signal monitoring parameters
3249 * @priv: Private driver interface data
3250 * @threshold: Threshold value for signal change events; 0 = disabled
3251 * @hysteresis: Minimum change in signal strength before indicating a
3252 * new event
3253 * Returns: 0 on success, -1 on failure (or if not supported)
3254 *
3255 * This function can be used to configure monitoring of signal strength
3256 * with the current AP. Whenever signal strength drops below the
3257 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
3258 * should be generated assuming the signal strength has changed at
3259 * least %hysteresis from the previously indicated signal change event.
3260 */
3261 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
b91ab76e
JM
3262
3263 /**
3264 * send_frame - Send IEEE 802.11 frame (testing use only)
3265 * @priv: Private driver interface data
3266 * @data: IEEE 802.11 frame with IEEE 802.11 header
3267 * @data_len: Size of the frame
3268 * @encrypt: Whether to encrypt the frame (if keys are set)
3269 * Returns: 0 on success, -1 on failure
3270 *
3271 * This function is only used for debugging purposes and is not
3272 * required to be implemented for normal operations.
3273 */
3274 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
3275 int encrypt);
75bde05d 3276
75bde05d
JM
3277 /**
3278 * get_noa - Get current Notice of Absence attribute payload
3279 * @priv: Private driver interface data
3280 * @buf: Buffer for returning NoA
3281 * @buf_len: Buffer length in octets
3282 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
3283 * advertized, or -1 on failure
3284 *
3285 * This function is used to fetch the current Notice of Absence
3286 * attribute value from GO.
3287 */
3288 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
3289
3290 /**
3291 * set_noa - Set Notice of Absence parameters for GO (testing)
3292 * @priv: Private driver interface data
3293 * @count: Count
3294 * @start: Start time in ms from next TBTT
3295 * @duration: Duration in ms
3296 * Returns: 0 on success or -1 on failure
3297 *
3298 * This function is used to set Notice of Absence parameters for GO. It
3299 * is used only for testing. To disable NoA, all parameters are set to
3300 * 0.
3301 */
3302 int (*set_noa)(void *priv, u8 count, int start, int duration);
c381508d
JM
3303
3304 /**
3305 * set_p2p_powersave - Set P2P power save options
3306 * @priv: Private driver interface data
3307 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
3308 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
3309 * @ctwindow: 0.. = change (msec), -1 = no change
3310 * Returns: 0 on success or -1 on failure
3311 */
3312 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
3313 int ctwindow);
b6c79a99
JM
3314
3315 /**
3316 * ampdu - Enable/disable aggregation
3317 * @priv: Private driver interface data
3318 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
3319 * Returns: 0 on success or -1 on failure
3320 */
3321 int (*ampdu)(void *priv, int ampdu);
0f66abd2 3322
6859f1cb
BG
3323 /**
3324 * get_radio_name - Get physical radio name for the device
3325 * @priv: Private driver interface data
3326 * Returns: Radio name or %NULL if not known
3327 *
3328 * The returned data must not be modified by the caller. It is assumed
3329 * that any interface that has the same radio name as another is
3330 * sharing the same physical radio. This information can be used to
3331 * share scan results etc. information between the virtual interfaces
3332 * to speed up various operations.
3333 */
3334 const char * (*get_radio_name)(void *priv);
3ac17eba 3335
281ff0aa
GP
3336 /**
3337 * send_tdls_mgmt - for sending TDLS management packets
3338 * @priv: private driver interface data
3339 * @dst: Destination (peer) MAC address
3340 * @action_code: TDLS action code for the mssage
3341 * @dialog_token: Dialog Token to use in the message (if needed)
3342 * @status_code: Status Code or Reason Code to use (if needed)
96ecea5e 3343 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
984dadc2 3344 * @initiator: Is the current end the TDLS link initiator
281ff0aa
GP
3345 * @buf: TDLS IEs to add to the message
3346 * @len: Length of buf in octets
45b722f1 3347 * Returns: 0 on success, negative (<0) on failure
281ff0aa
GP
3348 *
3349 * This optional function can be used to send packet to driver which is
3350 * responsible for receiving and sending all TDLS packets.
3351 */
3352 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
96ecea5e 3353 u8 dialog_token, u16 status_code, u32 peer_capab,
984dadc2 3354 int initiator, const u8 *buf, size_t len);
281ff0aa 3355
45b722f1
AN
3356 /**
3357 * tdls_oper - Ask the driver to perform high-level TDLS operations
3358 * @priv: Private driver interface data
3359 * @oper: TDLS high-level operation. See %enum tdls_oper
3360 * @peer: Destination (peer) MAC address
3361 * Returns: 0 on success, negative (<0) on failure
3362 *
3363 * This optional function can be used to send high-level TDLS commands
3364 * to the driver.
3365 */
281ff0aa 3366 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
1c5c7273 3367
a884be9d
XC
3368 /**
3369 * wnm_oper - Notify driver of the WNM frame reception
3370 * @priv: Private driver interface data
3371 * @oper: WNM operation. See %enum wnm_oper
3372 * @peer: Destination (peer) MAC address
3373 * @buf: Buffer for the driver to fill in (for getting IE)
3374 * @buf_len: Return the len of buf
3375 * Returns: 0 on success, negative (<0) on failure
3376 */
3377 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
3378 u8 *buf, u16 *buf_len);
3379
c551700f
KP
3380 /**
3381 * set_qos_map - Set QoS Map
3382 * @priv: Private driver interface data
3383 * @qos_map_set: QoS Map
3384 * @qos_map_set_len: Length of QoS Map
3385 */
3386 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
3387 u8 qos_map_set_len);
3388
71103bed
KP
3389 /**
3390 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
3391 * @priv: Private driver interface data
ed4ddb6d
KP
3392 * @version: IP version of the IP address, 4 or 6
3393 * @ipaddr: IP address for the neigh entry
3394 * @prefixlen: IP address prefix length
71103bed
KP
3395 * @addr: Corresponding MAC address
3396 * Returns: 0 on success, negative (<0) on failure
3397 */
ed4ddb6d
KP
3398 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
3399 int prefixlen, const u8 *addr);
71103bed
KP
3400
3401 /**
3402 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
3403 * @priv: Private driver interface data
ed4ddb6d
KP
3404 * @version: IP version of the IP address, 4 or 6
3405 * @ipaddr: IP address for the neigh entry
71103bed
KP
3406 * Returns: 0 on success, negative (<0) on failure
3407 */
ed4ddb6d 3408 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);
71103bed 3409
73d2294f
KP
3410 /**
3411 * br_port_set_attr - Set a bridge port attribute
3412 * @attr: Bridge port attribute to set
3413 * @val: Value to be set
3414 * Returns: 0 on success, negative (<0) on failure
3415 */
3416 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
3417 unsigned int val);
3418
7565752d
KP
3419 /**
3420 * br_port_set_attr - Set a bridge network parameter
3421 * @param: Bridge parameter to set
3422 * @val: Value to be set
3423 * Returns: 0 on success, negative (<0) on failure
3424 */
3425 int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
3426 unsigned int val);
3427
e4fa8b12
EP
3428 /**
3429 * set_wowlan - Set wake-on-wireless triggers
3430 * @priv: Private driver interface data
3431 * @triggers: wowlan triggers
3432 */
3433 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);
3434
1c5c7273
PS
3435 /**
3436 * signal_poll - Get current connection information
3437 * @priv: Private driver interface data
3438 * @signal_info: Connection info structure
0e80ea2c 3439 */
1c5c7273 3440 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
41fd1d9e 3441
7f00dc6e
MV
3442 /**
3443 * channel_info - Get parameters of the current operating channel
3444 * @priv: Private driver interface data
3445 * @channel_info: Channel info structure
3446 * Returns: 0 on success, negative (<0) on failure
3447 */
3448 int (*channel_info)(void *priv, struct wpa_channel_info *channel_info);
3449
41fd1d9e
KZ
3450 /**
3451 * set_authmode - Set authentication algorithm(s) for static WEP
3452 * @priv: Private driver interface data
3453 * @authmode: 1=Open System, 2=Shared Key, 3=both
3454 * Returns: 0 on success, -1 on failure
3455 *
3456 * This function can be used to set authentication algorithms for AP
3457 * mode when static WEP is used. If the driver uses user space MLME/SME
3458 * implementation, there is no need to implement this function.
062390ef
JM
3459 *
3460 * DEPRECATED - use set_ap() instead
41fd1d9e
KZ
3461 */
3462 int (*set_authmode)(void *priv, int authmode);
b14a210c 3463
5e2c3490
JM
3464#ifdef ANDROID
3465 /**
3466 * driver_cmd - Execute driver-specific command
3467 * @priv: Private driver interface data
3468 * @cmd: Command to execute
3469 * @buf: Return buffer
3470 * @buf_len: Buffer length
3471 * Returns: 0 on success, -1 on failure
3472 */
3473 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
3474#endif /* ANDROID */
3475
adef8948
BL
3476 /**
3477 * vendor_cmd - Execute vendor specific command
3478 * @priv: Private driver interface data
3479 * @vendor_id: Vendor id
3480 * @subcmd: Vendor command id
3481 * @data: Vendor command parameters (%NULL if no parameters)
3482 * @data_len: Data length
3483 * @buf: Return buffer (%NULL to ignore reply)
3484 * Returns: 0 on success, negative (<0) on failure
3485 *
3486 * This function handles vendor specific commands that are passed to
3487 * the driver/device. The command is identified by vendor id and
3488 * command id. Parameters can be passed as argument to the command
3489 * in the data buffer. Reply (if any) will be filled in the supplied
3490 * return buffer.
3491 *
3492 * The exact driver behavior is driver interface and vendor specific. As
3493 * an example, this will be converted to a vendor specific cfg80211
3494 * command in case of the nl80211 driver interface.
3495 */
3496 int (*vendor_cmd)(void *priv, unsigned int vendor_id,
3497 unsigned int subcmd, const u8 *data, size_t data_len,
3498 struct wpabuf *buf);
3499
b14a210c
JB
3500 /**
3501 * set_rekey_info - Set rekey information
3502 * @priv: Private driver interface data
3503 * @kek: Current KEK
98cd3d1c 3504 * @kek_len: KEK length in octets
b14a210c 3505 * @kck: Current KCK
98cd3d1c 3506 * @kck_len: KCK length in octets
b14a210c
JB
3507 * @replay_ctr: Current EAPOL-Key Replay Counter
3508 *
3509 * This optional function can be used to provide information for the
3510 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
3511 * while the host (including wpa_supplicant) is sleeping.
3512 */
98cd3d1c
JM
3513 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
3514 const u8 *kck, size_t kck_len,
b14a210c 3515 const u8 *replay_ctr);
a52eba0f
SP
3516
3517 /**
3518 * sta_assoc - Station association indication
3519 * @priv: Private driver interface data
3520 * @own_addr: Source address and BSSID for association frame
3521 * @addr: MAC address of the station to associate
3522 * @reassoc: flag to indicate re-association
3523 * @status: association response status code
3524 * @ie: assoc response ie buffer
3525 * @len: ie buffer length
3526 * Returns: 0 on success, -1 on failure
3527 *
3528 * This function indicates the driver to send (Re)Association
3529 * Response frame to the station.
3530 */
3531 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
3532 int reassoc, u16 status, const u8 *ie, size_t len);
3533
3534 /**
3535 * sta_auth - Station authentication indication
6b128fb2
JM
3536 * @priv: private driver interface data
3537 * @params: Station authentication parameters
a52eba0f 3538 *
6b128fb2 3539 * Returns: 0 on success, -1 on failure
a52eba0f 3540 */
6b128fb2
JM
3541 int (*sta_auth)(void *priv,
3542 struct wpa_driver_sta_auth_params *params);
a52eba0f
SP
3543
3544 /**
3545 * add_tspec - Add traffic stream
3546 * @priv: Private driver interface data
3547 * @addr: MAC address of the station to associate
3548 * @tspec_ie: tspec ie buffer
3549 * @tspec_ielen: tspec ie length
3550 * Returns: 0 on success, -1 on failure
3551 *
3552 * This function adds the traffic steam for the station
3553 * and fills the medium_time in tspec_ie.
3554 */
3555 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
3556 size_t tspec_ielen);
3557
3558 /**
3559 * add_sta_node - Add a station node in the driver
3560 * @priv: Private driver interface data
3561 * @addr: MAC address of the station to add
3562 * @auth_alg: authentication algorithm used by the station
3563 * Returns: 0 on success, -1 on failure
3564 *
3565 * This function adds the station node in the driver, when
3566 * the station gets added by FT-over-DS.
3567 */
3568 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
cbdf3507
LC
3569
3570 /**
3571 * sched_scan - Request the driver to initiate scheduled scan
3572 * @priv: Private driver interface data
3573 * @params: Scan parameters
cbdf3507
LC
3574 * Returns: 0 on success, -1 on failure
3575 *
3576 * This operation should be used for scheduled scan offload to
3577 * the hardware. Every time scan results are available, the
3578 * driver should report scan results event for wpa_supplicant
3579 * which will eventually request the results with
3580 * wpa_driver_get_scan_results2(). This operation is optional
3581 * and if not provided or if it returns -1, we fall back to
3582 * normal host-scheduled scans.
3583 */
09ea4309 3584 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);
cbdf3507
LC
3585
3586 /**
3587 * stop_sched_scan - Request the driver to stop a scheduled scan
3588 * @priv: Private driver interface data
3589 * Returns: 0 on success, -1 on failure
3590 *
3591 * This should cause the scheduled scan to be stopped and
3592 * results should stop being sent. Must be supported if
3593 * sched_scan is supported.
3594 */
3595 int (*stop_sched_scan)(void *priv);
bcf24348
JB
3596
3597 /**
3598 * poll_client - Probe (null data or such) the given station
3599 * @priv: Private driver interface data
3600 * @own_addr: MAC address of sending interface
3601 * @addr: MAC address of the station to probe
3602 * @qos: Indicates whether station is QoS station
3603 *
3604 * This function is used to verify whether an associated station is
3605 * still present. This function does not need to be implemented if the
3606 * driver provides such inactivity polling mechanism.
3607 */
3608 void (*poll_client)(void *priv, const u8 *own_addr,
3609 const u8 *addr, int qos);
8b9d0bfa
JM
3610
3611 /**
3612 * radio_disable - Disable/enable radio
3613 * @priv: Private driver interface data
3614 * @disabled: 1=disable 0=enable radio
3615 * Returns: 0 on success, -1 on failure
3616 *
3617 * This optional command is for testing purposes. It can be used to
3618 * disable the radio on a testbed device to simulate out-of-radio-range
3619 * conditions.
3620 */
3621 int (*radio_disable)(void *priv, int disabled);
ef35f5a0
JJ
3622
3623 /**
3624 * switch_channel - Announce channel switch and migrate the GO to the
3625 * given frequency
3626 * @priv: Private driver interface data
dcca2219 3627 * @settings: Settings for CSA period and new channel
ef35f5a0
JJ
3628 * Returns: 0 on success, -1 on failure
3629 *
3630 * This function is used to move the GO to the legacy STA channel to
3631 * avoid frequency conflict in single channel concurrency.
3632 */
dcca2219 3633 int (*switch_channel)(void *priv, struct csa_settings *settings);
f90e9c1c 3634
471cd6e1
MB
3635 /**
3636 * add_tx_ts - Add traffic stream
3637 * @priv: Private driver interface data
3638 * @tsid: Traffic stream ID
3639 * @addr: Receiver address
3640 * @user_prio: User priority of the traffic stream
3641 * @admitted_time: Admitted time for this TS in units of
3642 * 32 microsecond periods (per second).
3643 * Returns: 0 on success, -1 on failure
3644 */
3645 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
3646 u16 admitted_time);
3647
3648 /**
3649 * del_tx_ts - Delete traffic stream
3650 * @priv: Private driver interface data
3651 * @tsid: Traffic stream ID
3652 * @addr: Receiver address
3653 * Returns: 0 on success, -1 on failure
3654 */
3655 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);
3656
6b90deae
AN
3657 /**
3658 * Enable channel-switching with TDLS peer
3659 * @priv: Private driver interface data
3660 * @addr: MAC address of the TDLS peer
3661 * @oper_class: Operating class of the switch channel
3662 * @params: Channel specification
3663 * Returns: 0 on success, -1 on failure
3664 *
3665 * The function indicates to driver that it can start switching to a
3666 * different channel with a specified TDLS peer. The switching is
3667 * assumed on until canceled with tdls_disable_channel_switch().
3668 */
3669 int (*tdls_enable_channel_switch)(
3670 void *priv, const u8 *addr, u8 oper_class,
3671 const struct hostapd_freq_params *params);
3672
3673 /**
3674 * Disable channel switching with TDLS peer
3675 * @priv: Private driver interface data
3676 * @addr: MAC address of the TDLS peer
3677 * Returns: 0 on success, -1 on failure
3678 *
3679 * This function indicates to the driver that it should stop switching
3680 * with a given TDLS peer.
3681 */
3682 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);
3683
f90e9c1c
SW
3684 /**
3685 * start_dfs_cac - Listen for radar interference on the channel
3686 * @priv: Private driver interface data
04e8003c 3687 * @freq: Channel parameters
f90e9c1c
SW
3688 * Returns: 0 on success, -1 on failure
3689 */
04e8003c 3690 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
695c7038
SW
3691
3692 /**
3693 * stop_ap - Removes beacon from AP
3694 * @priv: Private driver interface data
3695 * Returns: 0 on success, -1 on failure (or if not supported)
3696 *
3697 * This optional function can be used to disable AP mode related
3698 * configuration. Unlike deinit_ap, it does not change to station
3699 * mode.
3700 */
3701 int (*stop_ap)(void *priv);
0185007c
MK
3702
3703 /**
3704 * get_survey - Retrieve survey data
3705 * @priv: Private driver interface data
3706 * @freq: If set, survey data for the specified frequency is only
3707 * being requested. If not set, all survey data is requested.
3708 * Returns: 0 on success, -1 on failure
3709 *
3710 * Use this to retrieve:
3711 *
3712 * - the observed channel noise floor
3713 * - the amount of time we have spent on the channel
3714 * - the amount of time during which we have spent on the channel that
3715 * the radio has determined the medium is busy and we cannot
3716 * transmit
3717 * - the amount of time we have spent receiving data
3718 * - the amount of time we have spent transmitting data
3719 *
3720 * This data can be used for spectrum heuristics. One example is
3721 * Automatic Channel Selection (ACS). The channel survey data is
3722 * kept on a linked list on the channel data, one entry is added
3723 * for each survey. The min_nf of the channel is updated for each
3724 * survey.
3725 */
3726 int (*get_survey)(void *priv, unsigned int freq);
a771c07d
JM
3727
3728 /**
3729 * status - Get driver interface status information
3730 * @priv: Private driver interface data
d0dde080 3731 * @buf: Buffer for printing the status information
a771c07d
JM
3732 * @buflen: Maximum length of the buffer
3733 * Returns: Length of written status information or -1 on failure
3734 */
3735 int (*status)(void *priv, char *buf, size_t buflen);
7baec808 3736
0ef023e4
JM
3737 /**
3738 * roaming - Set roaming policy for driver-based BSS selection
3739 * @priv: Private driver interface data
3740 * @allowed: Whether roaming within ESS is allowed
3741 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
3742 * Returns: Length of written status information or -1 on failure
3743 *
3744 * This optional callback can be used to update roaming policy from the
3745 * associate() command (bssid being set there indicates that the driver
3746 * should not roam before getting this roaming() call to allow roaming.
3747 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
3748 * capability, roaming policy is handled within wpa_supplicant and there
3749 * is no need to implement or react to this callback.
3750 */
3751 int (*roaming)(void *priv, int allowed, const u8 *bssid);
3752
d98038bb 3753 /**
3754 * disable_fils - Enable/disable FILS feature
3755 * @priv: Private driver interface data
3756 * @disable: 0-enable and 1-disable FILS feature
3757 * Returns: 0 on success, -1 on failure
3758 *
3759 * This callback can be used to configure driver and below layers to
3760 * enable/disable all FILS features.
3761 */
3762 int (*disable_fils)(void *priv, int disable);
3763
fee354c7
JM
3764 /**
3765 * set_mac_addr - Set MAC address
3766 * @priv: Private driver interface data
3767 * @addr: MAC address to use or %NULL for setting back to permanent
3768 * Returns: 0 on success, -1 on failure
3769 */
3770 int (*set_mac_addr)(void *priv, const u8 *addr);
3771
7baec808
HW
3772#ifdef CONFIG_MACSEC
3773 int (*macsec_init)(void *priv, struct macsec_init_params *params);
3774
3775 int (*macsec_deinit)(void *priv);
3776
a25e4efc
SD
3777 /**
3778 * macsec_get_capability - Inform MKA of this driver's capability
3779 * @priv: Private driver interface data
3780 * @cap: Driver's capability
3781 * Returns: 0 on success, -1 on failure
3782 */
3783 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);
3784
7baec808
HW
3785 /**
3786 * enable_protect_frames - Set protect frames status
3787 * @priv: Private driver interface data
3788 * @enabled: TRUE = protect frames enabled
3789 * FALSE = protect frames disabled
3790 * Returns: 0 on success, -1 on failure (or if not supported)
3791 */
3792 int (*enable_protect_frames)(void *priv, Boolean enabled);
3793
1d3d0666
SD
3794 /**
3795 * enable_encrypt - Set encryption status
3796 * @priv: Private driver interface data
3797 * @enabled: TRUE = encrypt outgoing traffic
3798 * FALSE = integrity-only protection on outgoing traffic
3799 * Returns: 0 on success, -1 on failure (or if not supported)
3800 */
3801 int (*enable_encrypt)(void *priv, Boolean enabled);
3802
7baec808
HW
3803 /**
3804 * set_replay_protect - Set replay protect status and window size
3805 * @priv: Private driver interface data
3806 * @enabled: TRUE = replay protect enabled
3807 * FALSE = replay protect disabled
3808 * @window: replay window size, valid only when replay protect enabled
3809 * Returns: 0 on success, -1 on failure (or if not supported)
3810 */
3811 int (*set_replay_protect)(void *priv, Boolean enabled, u32 window);
3812
3813 /**
3814 * set_current_cipher_suite - Set current cipher suite
3815 * @priv: Private driver interface data
3816 * @cs: EUI64 identifier
7baec808
HW
3817 * Returns: 0 on success, -1 on failure (or if not supported)
3818 */
07a6bfe1 3819 int (*set_current_cipher_suite)(void *priv, u64 cs);
7baec808
HW
3820
3821 /**
3822 * enable_controlled_port - Set controlled port status
3823 * @priv: Private driver interface data
3824 * @enabled: TRUE = controlled port enabled
3825 * FALSE = controlled port disabled
3826 * Returns: 0 on success, -1 on failure (or if not supported)
3827 */
3828 int (*enable_controlled_port)(void *priv, Boolean enabled);
3829
3830 /**
3831 * get_receive_lowest_pn - Get receive lowest pn
3832 * @priv: Private driver interface data
7fa5eff8 3833 * @sa: secure association
7baec808
HW
3834 * Returns: 0 on success, -1 on failure (or if not supported)
3835 */
7fa5eff8 3836 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);
7baec808
HW
3837
3838 /**
3839 * get_transmit_next_pn - Get transmit next pn
3840 * @priv: Private driver interface data
7fa5eff8 3841 * @sa: secure association
7baec808
HW
3842 * Returns: 0 on success, -1 on failure (or if not supported)
3843 */
7fa5eff8 3844 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);
7baec808
HW
3845
3846 /**
3847 * set_transmit_next_pn - Set transmit next pn
3848 * @priv: Private driver interface data
7fa5eff8 3849 * @sa: secure association
7baec808
HW
3850 * Returns: 0 on success, -1 on failure (or if not supported)
3851 */
7fa5eff8 3852 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);
7baec808 3853
2fc06756
MS
3854 /**
3855 * set_receive_lowest_pn - Set receive lowest PN
3856 * @priv: Private driver interface data
3857 * @sa: secure association
3858 * Returns: 0 on success, -1 on failure (or if not supported)
3859 */
3860 int (*set_receive_lowest_pn)(void *priv, struct receive_sa *sa);
3861
7baec808
HW
3862 /**
3863 * create_receive_sc - create secure channel for receiving
3864 * @priv: Private driver interface data
5f5ca284 3865 * @sc: secure channel
7baec808
HW
3866 * @conf_offset: confidentiality offset (0, 30, or 50)
3867 * @validation: frame validation policy (0 = Disabled, 1 = Checked,
3868 * 2 = Strict)
3869 * Returns: 0 on success, -1 on failure (or if not supported)
3870 */
5f5ca284
SD
3871 int (*create_receive_sc)(void *priv, struct receive_sc *sc,
3872 unsigned int conf_offset,
7baec808
HW
3873 int validation);
3874
3875 /**
3876 * delete_receive_sc - delete secure connection for receiving
3877 * @priv: private driver interface data from init()
5f5ca284 3878 * @sc: secure channel
7baec808
HW
3879 * Returns: 0 on success, -1 on failure
3880 */
5f5ca284 3881 int (*delete_receive_sc)(void *priv, struct receive_sc *sc);
7baec808
HW
3882
3883 /**
3884 * create_receive_sa - create secure association for receive
3885 * @priv: private driver interface data from init()
cecdecdb 3886 * @sa: secure association
7baec808
HW
3887 * Returns: 0 on success, -1 on failure
3888 */
cecdecdb 3889 int (*create_receive_sa)(void *priv, struct receive_sa *sa);
7baec808 3890
23c3528a
SD
3891 /**
3892 * delete_receive_sa - Delete secure association for receive
3893 * @priv: Private driver interface data from init()
3894 * @sa: Secure association
3895 * Returns: 0 on success, -1 on failure
3896 */
3897 int (*delete_receive_sa)(void *priv, struct receive_sa *sa);
3898
7baec808
HW
3899 /**
3900 * enable_receive_sa - enable the SA for receive
3901 * @priv: private driver interface data from init()
cecdecdb 3902 * @sa: secure association
7baec808
HW
3903 * Returns: 0 on success, -1 on failure
3904 */
cecdecdb 3905 int (*enable_receive_sa)(void *priv, struct receive_sa *sa);
7baec808
HW
3906
3907 /**
3908 * disable_receive_sa - disable SA for receive
3909 * @priv: private driver interface data from init()
cecdecdb 3910 * @sa: secure association
7baec808
HW
3911 * Returns: 0 on success, -1 on failure
3912 */
cecdecdb 3913 int (*disable_receive_sa)(void *priv, struct receive_sa *sa);
7baec808 3914
7baec808
HW
3915 /**
3916 * create_transmit_sc - create secure connection for transmit
3917 * @priv: private driver interface data from init()
8ebfc7c2
SD
3918 * @sc: secure channel
3919 * @conf_offset: confidentiality offset (0, 30, or 50)
7baec808
HW
3920 * Returns: 0 on success, -1 on failure
3921 */
8ebfc7c2
SD
3922 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
3923 unsigned int conf_offset);
7baec808
HW
3924
3925 /**
3926 * delete_transmit_sc - delete secure connection for transmit
3927 * @priv: private driver interface data from init()
8ebfc7c2 3928 * @sc: secure channel
7baec808
HW
3929 * Returns: 0 on success, -1 on failure
3930 */
8ebfc7c2 3931 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);
7baec808
HW
3932
3933 /**
3934 * create_transmit_sa - create secure association for transmit
3935 * @priv: private driver interface data from init()
909c1b98 3936 * @sa: secure association
7baec808
HW
3937 * Returns: 0 on success, -1 on failure
3938 */
909c1b98 3939 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);
7baec808 3940
23c3528a
SD
3941 /**
3942 * delete_transmit_sa - Delete secure association for transmit
3943 * @priv: Private driver interface data from init()
3944 * @sa: Secure association
3945 * Returns: 0 on success, -1 on failure
3946 */
3947 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);
3948
7baec808
HW
3949 /**
3950 * enable_transmit_sa - enable SA for transmit
3951 * @priv: private driver interface data from init()
909c1b98 3952 * @sa: secure association
7baec808
HW
3953 * Returns: 0 on success, -1 on failure
3954 */
909c1b98 3955 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);
7baec808
HW
3956
3957 /**
3958 * disable_transmit_sa - disable SA for transmit
3959 * @priv: private driver interface data from init()
909c1b98 3960 * @sa: secure association
7baec808
HW
3961 * Returns: 0 on success, -1 on failure
3962 */
909c1b98 3963 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
7baec808 3964#endif /* CONFIG_MACSEC */
6c1664f6
BC
3965
3966 /**
3967 * init_mesh - Driver specific initialization for mesh
3968 * @priv: Private driver interface data
3969 * Returns: 0 on success, -1 on failure
3970 */
3971 int (*init_mesh)(void *priv);
3972
3973 /**
3974 * join_mesh - Join a mesh network
3975 * @priv: Private driver interface data
3976 * @params: Mesh configuration parameters
3977 * Returns: 0 on success, -1 on failure
3978 */
3979 int (*join_mesh)(void *priv,
3980 struct wpa_driver_mesh_join_params *params);
3981
3982 /**
3983 * leave_mesh - Leave a mesh network
3984 * @priv: Private driver interface data
3985 * Returns 0 on success, -1 on failure
3986 */
3987 int (*leave_mesh)(void *priv);
16689c7c
PX
3988
3989 /**
3990 * do_acs - Automatically select channel
3991 * @priv: Private driver interface data
3992 * @params: Parameters for ACS
3993 * Returns 0 on success, -1 on failure
3994 *
3995 * This command can be used to offload ACS to the driver if the driver
3996 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
3997 */
3998 int (*do_acs)(void *priv, struct drv_acs_params *params);
844dfeb8
SD
3999
4000 /**
4001 * set_band - Notify driver of band selection
4002 * @priv: Private driver interface data
4003 * @band: The selected band(s)
4004 * Returns 0 on success, -1 on failure
4005 */
4006 int (*set_band)(void *priv, enum set_band band);
7c813acf 4007
98342208
AK
4008 /**
4009 * get_pref_freq_list - Get preferred frequency list for an interface
4010 * @priv: Private driver interface data
4011 * @if_type: Interface type
4012 * @num: Number of channels
4013 * @freq_list: Preferred channel frequency list encoded in MHz values
4014 * Returns 0 on success, -1 on failure
4015 *
4016 * This command can be used to query the preferred frequency list from
4017 * the driver specific to a particular interface type.
4018 */
4019 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
4020 unsigned int *num, unsigned int *freq_list);
4021
7c813acf
AK
4022 /**
4023 * set_prob_oper_freq - Indicate probable P2P operating channel
4024 * @priv: Private driver interface data
4025 * @freq: Channel frequency in MHz
4026 * Returns 0 on success, -1 on failure
4027 *
4028 * This command can be used to inform the driver of the operating
4029 * frequency that an ongoing P2P group formation is likely to come up
4030 * on. Local device is assuming P2P Client role.
4031 */
4032 int (*set_prob_oper_freq)(void *priv, unsigned int freq);
4f30addb
KV
4033
4034 /**
4035 * abort_scan - Request the driver to abort an ongoing scan
4036 * @priv: Private driver interface data
eeb34a43
SD
4037 * @scan_cookie: Cookie identifying the scan request. This is used only
4038 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
4039 * was used to trigger scan. Otherwise, 0 is used.
4f30addb
KV
4040 * Returns 0 on success, -1 on failure
4041 */
eeb34a43 4042 int (*abort_scan)(void *priv, u64 scan_cookie);
e42adb9a
MG
4043
4044 /**
4045 * configure_data_frame_filters - Request to configure frame filters
4046 * @priv: Private driver interface data
4047 * @filter_flags: The type of frames to filter (bitfield of
4048 * WPA_DATA_FRAME_FILTER_FLAG_*)
4049 * Returns: 0 on success or -1 on failure
4050 */
4051 int (*configure_data_frame_filters)(void *priv, u32 filter_flags);
cc9a2575
KV
4052
4053 /**
4054 * get_ext_capab - Get extended capabilities for the specified interface
4055 * @priv: Private driver interface data
4056 * @type: Interface type for which to get extended capabilities
4057 * @ext_capab: Extended capabilities fetched
4058 * @ext_capab_mask: Extended capabilities mask
4059 * @ext_capab_len: Length of the extended capabilities
4060 * Returns: 0 on success or -1 on failure
4061 */
4062 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
4063 const u8 **ext_capab, const u8 **ext_capab_mask,
4064 unsigned int *ext_capab_len);
a6f5b193
PX
4065
4066 /**
4067 * p2p_lo_start - Start offloading P2P listen to device
4068 * @priv: Private driver interface data
4069 * @freq: Listening frequency (MHz) for P2P listen
4070 * @period: Length of the listen operation in milliseconds
4071 * @interval: Interval for running the listen operation in milliseconds
4072 * @count: Number of times to run the listen operation
4073 * @device_types: Device primary and secondary types
4074 * @dev_types_len: Number of bytes for device_types
4075 * @ies: P2P IE and WSC IE for Probe Response frames
4076 * @ies_len: Length of ies in bytes
4077 * Returns: 0 on success or -1 on failure
4078 */
4079 int (*p2p_lo_start)(void *priv, unsigned int freq,
4080 unsigned int period, unsigned int interval,
4081 unsigned int count,
4082 const u8 *device_types, size_t dev_types_len,
4083 const u8 *ies, size_t ies_len);
4084
4085 /**
4086 * p2p_lo_stop - Stop P2P listen offload
4087 * @priv: Private driver interface data
4088 * Returns: 0 on success or -1 on failure
4089 */
4090 int (*p2p_lo_stop)(void *priv);
cc9985d1 4091
4092 /**
4093 * set_default_scan_ies - Set default scan IEs
4094 * @priv: Private driver interface data
4095 * @ies: Scan default IEs buffer
4096 * @ies_len: Length of IEs in bytes
4097 * Returns: 0 on success or -1 on failure
4098 *
4099 * The driver can use these by default when there are no scan IEs coming
4100 * in the subsequent scan requests. Also in case of one or more of IEs
4101 * given in set_default_scan_ies() are missing in the subsequent scan
4102 * request, the driver should merge the missing scan IEs in the scan
4103 * request from the IEs set by set_default_scan_ies() in the Probe
4104 * Request frames sent.
4105 */
4106 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);
4107
2e4e4fb7
SD
4108 /**
4109 * set_tdls_mode - Set TDLS trigger mode to the host driver
4110 * @priv: Private driver interface data
4111 * @tdls_external_control: Represents if TDLS external trigger control
4112 * mode is enabled/disabled.
4113 *
4114 * This optional callback can be used to configure the TDLS external
4115 * trigger control mode to the host driver.
4116 */
4117 int (*set_tdls_mode)(void *priv, int tdls_external_control);
6fc6879b 4118
3ab48492
KV
4119 /**
4120 * get_bss_transition_status - Get candidate BSS's transition status
4121 * @priv: Private driver interface data
4122 * @params: Candidate BSS list
4123 *
4124 * Get the accept or reject reason code for a list of BSS transition
4125 * candidates.
4126 */
4127 struct wpa_bss_candidate_info *
4128 (*get_bss_transition_status)(void *priv,
4129 struct wpa_bss_trans_info *params);
178553b7
VK
4130 /**
4131 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
4132 * @priv: Private driver interface data
4133 * @ignore_disallow: 0 to not ignore, 1 to ignore
4134 * Returns: 0 on success, -1 on failure
4135 */
4136 int (*ignore_assoc_disallow)(void *priv, int ignore_disallow);
b04854ce
AP
4137
4138 /**
4139 * set_bssid_blacklist - Set blacklist of BSSIDs to the driver
4140 * @priv: Private driver interface data
4141 * @num_bssid: Number of blacklist BSSIDs
4142 * @bssids: List of blacklisted BSSIDs
4143 */
4144 int (*set_bssid_blacklist)(void *priv, unsigned int num_bssid,
4145 const u8 *bssid);
3c67e977
VK
4146
4147 /**
4148 * update_connect_params - Update the connection parameters
4149 * @priv: Private driver interface data
4150 * @params: Association parameters
4151 * @mask: Bit mask indicating which parameters in @params have to be
4152 * updated
4153 * Returns: 0 on success, -1 on failure
4154 *
4155 * Update the connection parameters when in connected state so that the
4156 * driver uses the updated parameters for subsequent roaming. This is
4157 * used only with drivers that implement internal BSS selection and
4158 * roaming.
4159 */
4160 int (*update_connect_params)(
4161 void *priv, struct wpa_driver_associate_params *params,
4162 enum wpa_drv_update_connect_params_mask mask);
ba71cb82
SD
4163
4164 /**
4165 * send_external_auth_status - Indicate the status of external
4166 * authentication processing to the host driver.
4167 * @priv: Private driver interface data
4168 * @params: Status of authentication processing.
4169 * Returns: 0 on success, -1 on failure
4170 */
4171 int (*send_external_auth_status)(void *priv,
4172 struct external_auth *params);
5abc7823
VN
4173
4174 /**
4175 * set_4addr_mode - Set 4-address mode
4176 * @priv: Private driver interface data
4177 * @bridge_ifname: Bridge interface name
4178 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
4179 * Returns: 0 on success, < 0 on failure
4180 */
4181 int (*set_4addr_mode)(void *priv, const char *bridge_ifname, int val);
3ab48492 4182};
e0498677 4183
6fc6879b
JM
4184/**
4185 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
4186 */
9646a8ab 4187enum wpa_event_type {
6fc6879b
JM
4188 /**
4189 * EVENT_ASSOC - Association completed
4190 *
4191 * This event needs to be delivered when the driver completes IEEE
4192 * 802.11 association or reassociation successfully.
4193 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
4194 * after this event has been generated. In addition, optional
4195 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
4196 * more information about the association. If the driver interface gets
4197 * both of these events at the same time, it can also include the
4198 * assoc_info data in EVENT_ASSOC call.
4199 */
4200 EVENT_ASSOC,
4201
4202 /**
4203 * EVENT_DISASSOC - Association lost
4204 *
4205 * This event should be called when association is lost either due to
4206 * receiving deauthenticate or disassociate frame from the AP or when
c2a04078
JM
4207 * sending either of these frames to the current AP. If the driver
4208 * supports separate deauthentication event, EVENT_DISASSOC should only
4209 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1d041bec 4210 * In AP mode, union wpa_event_data::disassoc_info is required.
6fc6879b
JM
4211 */
4212 EVENT_DISASSOC,
4213
4214 /**
4215 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
4216 *
4217 * This event must be delivered when a Michael MIC error is detected by
4218 * the local driver. Additional data for event processing is
4219 * provided with union wpa_event_data::michael_mic_failure. This
4220 * information is used to request new encyption key and to initiate
4221 * TKIP countermeasures if needed.
4222 */
4223 EVENT_MICHAEL_MIC_FAILURE,
4224
4225 /**
4226 * EVENT_SCAN_RESULTS - Scan results available
4227 *
4228 * This event must be called whenever scan results are available to be
4229 * fetched with struct wpa_driver_ops::get_scan_results(). This event
4230 * is expected to be used some time after struct wpa_driver_ops::scan()
4231 * is called. If the driver provides an unsolicited event when the scan
4232 * has been completed, this event can be used to trigger
4233 * EVENT_SCAN_RESULTS call. If such event is not available from the
4234 * driver, the driver wrapper code is expected to use a registered
4235 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
8d923a4a
JM
4236 * scan is expected to be completed. Optional information about
4237 * completed scan can be provided with union wpa_event_data::scan_info.
6fc6879b
JM
4238 */
4239 EVENT_SCAN_RESULTS,
4240
4241 /**
4242 * EVENT_ASSOCINFO - Report optional extra information for association
4243 *
4244 * This event can be used to report extra association information for
4245 * EVENT_ASSOC processing. This extra information includes IEs from
4246 * association frames and Beacon/Probe Response frames in union
4247 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
4248 * EVENT_ASSOC. Alternatively, the driver interface can include
4249 * assoc_info data in the EVENT_ASSOC call if it has all the
4250 * information available at the same point.
4251 */
4252 EVENT_ASSOCINFO,
4253
4254 /**
4255 * EVENT_INTERFACE_STATUS - Report interface status changes
4256 *
4257 * This optional event can be used to report changes in interface
4258 * status (interface added/removed) using union
4259 * wpa_event_data::interface_status. This can be used to trigger
4260 * wpa_supplicant to stop and re-start processing for the interface,
4261 * e.g., when a cardbus card is ejected/inserted.
4262 */
4263 EVENT_INTERFACE_STATUS,
4264
4265 /**
4266 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
4267 *
4268 * This event can be used to inform wpa_supplicant about candidates for
4269 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
4270 * for scan request (ap_scan=2 mode), this event is required for
4271 * pre-authentication. If wpa_supplicant is performing scan request
4272 * (ap_scan=1), this event is optional since scan results can be used
4273 * to add pre-authentication candidates. union
4274 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
4275 * candidate and priority of the candidate, e.g., based on the signal
4276 * strength, in order to try to pre-authenticate first with candidates
4277 * that are most likely targets for re-association.
4278 *
4279 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
4280 * on the candidate list. In addition, it can be called for the current
4281 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
4282 * will automatically skip pre-authentication in cases where a valid
4283 * PMKSA exists. When more than one candidate exists, this event should
4284 * be generated once for each candidate.
4285 *
4286 * Driver will be notified about successful pre-authentication with
4287 * struct wpa_driver_ops::add_pmkid() calls.
4288 */
4289 EVENT_PMKID_CANDIDATE,
4290
281ff0aa
GP
4291 /**
4292 * EVENT_TDLS - Request TDLS operation
4293 *
4294 * This event can be used to request a TDLS operation to be performed.
4295 */
4296 EVENT_TDLS,
4297
6fc6879b
JM
4298 /**
4299 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
4300 *
4301 * The driver is expected to report the received FT IEs from
4302 * FT authentication sequence from the AP. The FT IEs are included in
4303 * the extra information in union wpa_event_data::ft_ies.
4304 */
11ef8d35
JM
4305 EVENT_FT_RESPONSE,
4306
4307 /**
4308 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
4309 *
4310 * The driver can use this event to inform wpa_supplicant about a STA
4311 * in an IBSS with which protected frames could be exchanged. This
4312 * event starts RSN authentication with the other STA to authenticate
4313 * the STA and set up encryption keys with it.
4314 */
c2a04078
JM
4315 EVENT_IBSS_RSN_START,
4316
4317 /**
4318 * EVENT_AUTH - Authentication result
4319 *
4320 * This event should be called when authentication attempt has been
4321 * completed. This is only used if the driver supports separate
4322 * authentication step (struct wpa_driver_ops::authenticate).
4323 * Information about authentication result is included in
4324 * union wpa_event_data::auth.
4325 */
4326 EVENT_AUTH,
4327
4328 /**
4329 * EVENT_DEAUTH - Authentication lost
4330 *
4331 * This event should be called when authentication is lost either due
4332 * to receiving deauthenticate frame from the AP or when sending that
4333 * frame to the current AP.
1d041bec 4334 * In AP mode, union wpa_event_data::deauth_info is required.
c2a04078 4335 */
efa46078
JM
4336 EVENT_DEAUTH,
4337
4338 /**
4339 * EVENT_ASSOC_REJECT - Association rejected
4340 *
4341 * This event should be called when (re)association attempt has been
59ddf221 4342 * rejected by the AP. Information about the association response is
efa46078
JM
4343 * included in union wpa_event_data::assoc_reject.
4344 */
da1fb17c
JM
4345 EVENT_ASSOC_REJECT,
4346
4347 /**
4348 * EVENT_AUTH_TIMED_OUT - Authentication timed out
4349 */
4350 EVENT_AUTH_TIMED_OUT,
4351
4352 /**
4353 * EVENT_ASSOC_TIMED_OUT - Association timed out
4354 */
08fd8c15
JM
4355 EVENT_ASSOC_TIMED_OUT,
4356
fcf0f87d
JM
4357 /**
4358 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
4359 */
f8b1f695
JM
4360 EVENT_WPS_BUTTON_PUSHED,
4361
4362 /**
4363 * EVENT_TX_STATUS - Report TX status
4364 */
4365 EVENT_TX_STATUS,
4366
4367 /**
4368 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
4369 */
4370 EVENT_RX_FROM_UNKNOWN,
4371
4372 /**
4373 * EVENT_RX_MGMT - Report RX of a management frame
4374 */
245519e0
JM
4375 EVENT_RX_MGMT,
4376
55777702
JM
4377 /**
4378 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
4379 *
4380 * This event is used to indicate when the driver has started the
4381 * requested remain-on-channel duration. Information about the
4382 * operation is included in union wpa_event_data::remain_on_channel.
4383 */
4384 EVENT_REMAIN_ON_CHANNEL,
4385
4386 /**
4387 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
4388 *
4389 * This event is used to indicate when the driver has completed
4390 * remain-on-channel duration, i.e., may noot be available on the
4391 * requested channel anymore. Information about the
4392 * operation is included in union wpa_event_data::remain_on_channel.
4393 */
4394 EVENT_CANCEL_REMAIN_ON_CHANNEL,
4395
a0e0d3bb
JM
4396 /**
4397 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
4398 *
4399 * This event is used to indicate when a Probe Request frame has been
4400 * received. Information about the received frame is included in
504e905c
JM
4401 * union wpa_event_data::rx_probe_req. The driver is required to report
4402 * these events only after successfully completed probe_req_report()
4403 * commands to request the events (i.e., report parameter is non-zero)
4404 * in station mode. In AP mode, Probe Request frames should always be
4405 * reported.
a0e0d3bb 4406 */
a70a5d6d
JM
4407 EVENT_RX_PROBE_REQ,
4408
4409 /**
4410 * EVENT_NEW_STA - New wired device noticed
4411 *
4412 * This event is used to indicate that a new device has been detected
4413 * in a network that does not use association-like functionality (i.e.,
4414 * mainly wired Ethernet). This can be used to start EAPOL
4415 * authenticator when receiving a frame from a device. The address of
4416 * the device is included in union wpa_event_data::new_sta.
4417 */
a8e0505b
JM
4418 EVENT_NEW_STA,
4419
4420 /**
4421 * EVENT_EAPOL_RX - Report received EAPOL frame
4422 *
4423 * When in AP mode with hostapd, this event is required to be used to
2961bfa8 4424 * deliver the receive EAPOL frames from the driver.
a8e0505b 4425 */
b625473c
JM
4426 EVENT_EAPOL_RX,
4427
4428 /**
4429 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
4430 *
4431 * This event is used to indicate changes in the signal strength
4432 * observed in frames received from the current AP if signal strength
4433 * monitoring has been enabled with signal_monitor().
4434 */
8401a6b0
JM
4435 EVENT_SIGNAL_CHANGE,
4436
4437 /**
4438 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
4439 *
4440 * This event is used to indicate that the interface was enabled after
4441 * having been previously disabled, e.g., due to rfkill.
4442 */
4443 EVENT_INTERFACE_ENABLED,
4444
4445 /**
4446 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
4447 *
4448 * This event is used to indicate that the interface was disabled,
4449 * e.g., due to rfkill.
4450 */
b5c9da8d
JM
4451 EVENT_INTERFACE_DISABLED,
4452
4453 /**
4454 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
4455 *
4456 * This event is used to indicate that the channel list has changed,
4457 * e.g., because of a regulatory domain change triggered by scan
4458 * results including an AP advertising a country code.
4459 */
c973f386
JM
4460 EVENT_CHANNEL_LIST_CHANGED,
4461
4462 /**
4463 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
4464 *
4465 * This event is used to indicate that the driver cannot maintain this
4466 * interface in its operation mode anymore. The most likely use for
4467 * this is to indicate that AP mode operation is not available due to
4468 * operating channel would need to be changed to a DFS channel when
4469 * the driver does not support radar detection and another virtual
4470 * interfaces caused the operating channel to change. Other similar
4471 * resource conflicts could also trigger this for station mode
5841958f
MK
4472 * interfaces. This event can be propagated when channel switching
4473 * fails.
c973f386 4474 */
7cfc4ac3
AGS
4475 EVENT_INTERFACE_UNAVAILABLE,
4476
4477 /**
4478 * EVENT_BEST_CHANNEL
4479 *
4480 * Driver generates this event whenever it detects a better channel
4481 * (e.g., based on RSSI or channel use). This information can be used
4482 * to improve channel selection for a new AP/P2P group.
4483 */
7d878ca7
JM
4484 EVENT_BEST_CHANNEL,
4485
4486 /**
4487 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
4488 *
4489 * This event should be called when a Deauthentication frame is dropped
4490 * due to it not being protected (MFP/IEEE 802.11w).
4491 * union wpa_event_data::unprot_deauth is required to provide more
4492 * details of the frame.
4493 */
4494 EVENT_UNPROT_DEAUTH,
4495
4496 /**
4497 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
4498 *
4499 * This event should be called when a Disassociation frame is dropped
4500 * due to it not being protected (MFP/IEEE 802.11w).
4501 * union wpa_event_data::unprot_disassoc is required to provide more
4502 * details of the frame.
4503 */
4504 EVENT_UNPROT_DISASSOC,
0d7e5a3a
JB
4505
4506 /**
4507 * EVENT_STATION_LOW_ACK
4508 *
4509 * Driver generates this event whenever it detected that a particular
4510 * station was lost. Detection can be through massive transmission
4511 * failures for example.
4512 */
3ac17eba
JM
4513 EVENT_STATION_LOW_ACK,
4514
ea244d21
XC
4515 /**
4516 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
4517 */
b14a210c
JB
4518 EVENT_IBSS_PEER_LOST,
4519
4520 /**
4521 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
4522 *
4523 * This event carries the new replay counter to notify wpa_supplicant
4524 * of the current EAPOL-Key Replay Counter in case the driver/firmware
4525 * completed Group Key Handshake while the host (including
4526 * wpa_supplicant was sleeping).
4527 */
cbdf3507
LC
4528 EVENT_DRIVER_GTK_REKEY,
4529
4530 /**
4531 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
4532 */
bcf24348
JB
4533 EVENT_SCHED_SCAN_STOPPED,
4534
4535 /**
4536 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
4537 *
4538 * This event indicates that the station responded to the poll
4539 * initiated with @poll_client.
4540 */
dd840f79
JB
4541 EVENT_DRIVER_CLIENT_POLL_OK,
4542
4543 /**
4544 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
4545 */
1b487b8b
TP
4546 EVENT_EAPOL_TX_STATUS,
4547
4548 /**
4549 * EVENT_CH_SWITCH - AP or GO decided to switch channels
4550 *
4551 * Described in wpa_event_data.ch_switch
4552 * */
a884be9d
XC
4553 EVENT_CH_SWITCH,
4554
4555 /**
95f556f3
OD
4556 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
4557 *
4558 * This is a pre-switch event indicating the shortly following switch
4559 * of operating channels.
4560 *
4561 * Described in wpa_event_data.ch_switch
4562 */
4563 EVENT_CH_SWITCH_STARTED,
4564 /**
a884be9d
XC
4565 * EVENT_WNM - Request WNM operation
4566 *
4567 * This event can be used to request a WNM operation to be performed.
4568 */
3140803b
RM
4569 EVENT_WNM,
4570
4571 /**
4572 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
4573 *
4574 * This event indicates that the driver reported a connection failure
4575 * with the specified client (for example, max client reached, etc.) in
4576 * AP mode.
4577 */
04be54fa
SW
4578 EVENT_CONNECT_FAILED_REASON,
4579
4580 /**
480994da 4581 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
04be54fa
SW
4582 *
4583 * A radar has been detected on the supplied frequency, hostapd should
4584 * react accordingly (e.g., change channel).
4585 */
4586 EVENT_DFS_RADAR_DETECTED,
4587
4588 /**
480994da 4589 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
04be54fa
SW
4590 *
4591 * After a successful CAC, the channel can be marked clear and used.
4592 */
4593 EVENT_DFS_CAC_FINISHED,
4594
4595 /**
480994da 4596 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
04be54fa
SW
4597 *
4598 * The CAC was not successful, and the channel remains in the previous
641c73f8 4599 * state. This may happen due to a radar being detected or other
04be54fa
SW
4600 * external influences.
4601 */
4602 EVENT_DFS_CAC_ABORTED,
4603
4604 /**
480994da 4605 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
04be54fa
SW
4606 *
4607 * The channel which was previously unavailable is now available again.
4608 */
0185007c
MK
4609 EVENT_DFS_NOP_FINISHED,
4610
18ae2377
JM
4611 /**
4612 * EVENT_SURVEY - Received survey data
4613 *
4614 * This event gets triggered when a driver query is issued for survey
4615 * data and the requested data becomes available. The returned data is
4616 * stored in struct survey_results. The results provide at most one
4617 * survey entry for each frequency and at minimum will provide one
4618 * survey entry for one frequency. The survey data can be os_malloc()'d
4619 * and then os_free()'d, so the event callback must only copy data.
4620 */
a5f40eff
JM
4621 EVENT_SURVEY,
4622
4623 /**
4624 * EVENT_SCAN_STARTED - Scan started
4625 *
4626 * This indicates that driver has started a scan operation either based
4627 * on a request from wpa_supplicant/hostapd or from another application.
4628 * EVENT_SCAN_RESULTS is used to indicate when the scan has been
4629 * completed (either successfully or by getting cancelled).
4630 */
253f2e37
AH
4631 EVENT_SCAN_STARTED,
4632
4633 /**
4634 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
4635 *
4636 * This event indicates a set of frequency ranges that should be avoided
4637 * to reduce issues due to interference or internal co-existence
4638 * information in the driver.
4639 */
a52024c9
BC
4640 EVENT_AVOID_FREQUENCIES,
4641
4642 /**
4643 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
4644 */
16689c7c 4645 EVENT_NEW_PEER_CANDIDATE,
a52024c9 4646
16689c7c
PX
4647 /**
4648 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
4649 *
4650 * Indicates a pair of primary and secondary channels chosen by ACS
4651 * in device.
4652 */
4653 EVENT_ACS_CHANNEL_SELECTED,
480994da
AK
4654
4655 /**
4656 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
4657 * been started.
4658 *
4659 * This event indicates that channel availability check has been started
4660 * on a DFS frequency by a driver that supports DFS Offload.
4661 */
4662 EVENT_DFS_CAC_STARTED,
a6f5b193
PX
4663
4664 /**
4665 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
4666 */
4667 EVENT_P2P_LO_STOP,
68855672
JM
4668
4669 /**
4670 * EVENT_BEACON_LOSS - Beacon loss detected
4671 *
4672 * This event indicates that no Beacon frames has been received from
4673 * the current AP. This may indicate that the AP is not anymore in
4674 * range.
4675 */
4676 EVENT_BEACON_LOSS,
62c8c7f7
VT
4677
4678 /**
4679 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
4680 * done previously (Pre-CAC) on the channel has expired. This would
4681 * normally be on a non-ETSI DFS regulatory domain. DFS state of the
4682 * channel will be moved from available to usable. A new CAC has to be
4683 * performed before start operating on this channel.
4684 */
4685 EVENT_DFS_PRE_CAC_EXPIRED,
ba71cb82
SD
4686
4687 /**
4688 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
4689 * that do not define separate commands for authentication and
4690 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
4691 * authentication to wpa_supplicant. This event carries all the
4692 * necessary information from the host driver for the authentication to
4693 * happen.
4694 */
4695 EVENT_EXTERNAL_AUTH,
0a20bd7d
AS
4696
4697 /**
4698 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
4699 *
4700 * This event should be indicated when the driver completes the 4-way
4701 * handshake. This event should be preceded by an EVENT_ASSOC that
4702 * indicates the completion of IEEE 802.11 association.
4703 */
4704 EVENT_PORT_AUTHORIZED,
e8ada160
T
4705
4706 /**
4707 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
4708 * change event.
4709 */
4710 EVENT_STATION_OPMODE_CHANGED,
77a020a1
BG
4711
4712 /**
4713 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
4714 *
4715 * This event is emitted when the MAC changes while the interface is
4716 * enabled. When an interface was disabled and becomes enabled, it
4717 * must be always assumed that the MAC possibly changed.
4718 */
4719 EVENT_INTERFACE_MAC_CHANGED,
1952b626
BP
4720
4721 /**
4722 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
4723 *
4724 * This event is emitted when an interface is added/removed for WDS STA.
4725 */
4726 EVENT_WDS_STA_INTERFACE_STATUS,
9646a8ab 4727};
6fc6879b
JM
4728
4729
0185007c
MK
4730/**
4731 * struct freq_survey - Channel survey info
4732 *
4733 * @ifidx: Interface index in which this survey was observed
4734 * @freq: Center of frequency of the surveyed channel
4735 * @nf: Channel noise floor in dBm
4736 * @channel_time: Amount of time in ms the radio spent on the channel
4737 * @channel_time_busy: Amount of time in ms the radio detected some signal
4738 * that indicated to the radio the channel was not clear
4739 * @channel_time_rx: Amount of time the radio spent receiving data
4740 * @channel_time_tx: Amount of time the radio spent transmitting data
4741 * @filled: bitmask indicating which fields have been reported, see
4742 * SURVEY_HAS_* defines.
4743 * @list: Internal list pointers
4744 */
4745struct freq_survey {
4746 u32 ifidx;
4747 unsigned int freq;
4748 s8 nf;
4749 u64 channel_time;
4750 u64 channel_time_busy;
4751 u64 channel_time_rx;
4752 u64 channel_time_tx;
4753 unsigned int filled;
4754 struct dl_list list;
4755};
4756
4757#define SURVEY_HAS_NF BIT(0)
4758#define SURVEY_HAS_CHAN_TIME BIT(1)
4759#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
4760#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
4761#define SURVEY_HAS_CHAN_TIME_TX BIT(4)
4762
4763
6fc6879b
JM
4764/**
4765 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
4766 */
4767union wpa_event_data {
4768 /**
4769 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
4770 *
4771 * This structure is optional for EVENT_ASSOC calls and required for
4772 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
4773 * driver interface does not need to generate separate EVENT_ASSOCINFO
4774 * calls.
4775 */
4776 struct assoc_info {
39b08b5f
SP
4777 /**
4778 * reassoc - Flag to indicate association or reassociation
4779 */
4780 int reassoc;
4781
6fc6879b
JM
4782 /**
4783 * req_ies - (Re)Association Request IEs
4784 *
4785 * If the driver generates WPA/RSN IE, this event data must be
4786 * returned for WPA handshake to have needed information. If
4787 * wpa_supplicant-generated WPA/RSN IE is used, this
4788 * information event is optional.
4789 *
4790 * This should start with the first IE (fixed fields before IEs
4791 * are not included).
4792 */
1d041bec 4793 const u8 *req_ies;
6fc6879b
JM
4794
4795 /**
4796 * req_ies_len - Length of req_ies in bytes
4797 */
4798 size_t req_ies_len;
4799
4800 /**
4801 * resp_ies - (Re)Association Response IEs
4802 *
4803 * Optional association data from the driver. This data is not
4804 * required WPA, but may be useful for some protocols and as
4805 * such, should be reported if this is available to the driver
4806 * interface.
4807 *
4808 * This should start with the first IE (fixed fields before IEs
4809 * are not included).
4810 */
1d041bec 4811 const u8 *resp_ies;
6fc6879b
JM
4812
4813 /**
4814 * resp_ies_len - Length of resp_ies in bytes
4815 */
4816 size_t resp_ies_len;
4817
5b092fb6
JM
4818 /**
4819 * resp_frame - (Re)Association Response frame
4820 */
4821 const u8 *resp_frame;
4822
4823 /**
4824 * resp_frame_len - (Re)Association Response frame length
4825 */
4826 size_t resp_frame_len;
4827
6fc6879b
JM
4828 /**
4829 * beacon_ies - Beacon or Probe Response IEs
4830 *
4831 * Optional Beacon/ProbeResp data: IEs included in Beacon or
4832 * Probe Response frames from the current AP (i.e., the one
4833 * that the client just associated with). This information is
4834 * used to update WPA/RSN IE for the AP. If this field is not
4835 * set, the results from previous scan will be used. If no
4836 * data for the new AP is found, scan results will be requested
4837 * again (without scan request). At this point, the driver is
4838 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
4839 * used).
4840 *
4841 * This should start with the first IE (fixed fields before IEs
4842 * are not included).
4843 */
1d041bec 4844 const u8 *beacon_ies;
6fc6879b
JM
4845
4846 /**
4847 * beacon_ies_len - Length of beacon_ies */
4848 size_t beacon_ies_len;
4832ecd7
JM
4849
4850 /**
4851 * freq - Frequency of the operational channel in MHz
4852 */
4853 unsigned int freq;
1d041bec 4854
0f14a44e
EP
4855 /**
4856 * wmm_params - WMM parameters used in this association.
4857 */
4858 struct wmm_params wmm_params;
4859
1d041bec
JM
4860 /**
4861 * addr - Station address (for AP mode)
4862 */
4863 const u8 *addr;
b41f2684
CL
4864
4865 /**
4866 * The following is the key management offload information
4867 * @authorized
4868 * @key_replay_ctr
4869 * @key_replay_ctr_len
4870 * @ptk_kck
4871 * @ptk_kek_len
4872 * @ptk_kek
4873 * @ptk_kek_len
4874 */
4875
4876 /**
4877 * authorized - Status of key management offload,
4878 * 1 = successful
4879 */
4880 int authorized;
4881
4882 /**
4883 * key_replay_ctr - Key replay counter value last used
4884 * in a valid EAPOL-Key frame
4885 */
4886 const u8 *key_replay_ctr;
4887
4888 /**
4889 * key_replay_ctr_len - The length of key_replay_ctr
4890 */
4891 size_t key_replay_ctr_len;
4892
4893 /**
4894 * ptk_kck - The derived PTK KCK
4895 */
4896 const u8 *ptk_kck;
4897
4898 /**
4899 * ptk_kek_len - The length of ptk_kck
4900 */
4901 size_t ptk_kck_len;
4902
4903 /**
4904 * ptk_kek - The derived PTK KEK
ad295f3b
VK
4905 * This is used in key management offload and also in FILS SK
4906 * offload.
b41f2684
CL
4907 */
4908 const u8 *ptk_kek;
4909
4910 /**
4911 * ptk_kek_len - The length of ptk_kek
4912 */
4913 size_t ptk_kek_len;
f32227ed
RJ
4914
4915 /**
4916 * subnet_status - The subnet status:
4917 * 0 = unknown, 1 = unchanged, 2 = changed
4918 */
4919 u8 subnet_status;
ad295f3b
VK
4920
4921 /**
4922 * The following information is used in FILS SK offload
4923 * @fils_erp_next_seq_num
4924 * @fils_pmk
4925 * @fils_pmk_len
4926 * @fils_pmkid
4927 */
4928
4929 /**
4930 * fils_erp_next_seq_num - The next sequence number to use in
4931 * FILS ERP messages
4932 */
4933 u16 fils_erp_next_seq_num;
4934
4935 /**
4936 * fils_pmk - A new PMK if generated in case of FILS
4937 * authentication
4938 */
4939 const u8 *fils_pmk;
4940
4941 /**
4942 * fils_pmk_len - Length of fils_pmk
4943 */
4944 size_t fils_pmk_len;
4945
4946 /**
4947 * fils_pmkid - PMKID used or generated in FILS authentication
4948 */
4949 const u8 *fils_pmkid;
6fc6879b
JM
4950 } assoc_info;
4951
1d041bec
JM
4952 /**
4953 * struct disassoc_info - Data for EVENT_DISASSOC events
4954 */
4955 struct disassoc_info {
4956 /**
4957 * addr - Station address (for AP mode)
4958 */
4959 const u8 *addr;
0544b242
JM
4960
4961 /**
4962 * reason_code - Reason Code (host byte order) used in
4963 * Deauthentication frame
4964 */
4965 u16 reason_code;
75bde05d
JM
4966
4967 /**
4968 * ie - Optional IE(s) in Disassociation frame
4969 */
4970 const u8 *ie;
4971
4972 /**
4973 * ie_len - Length of ie buffer in octets
4974 */
4975 size_t ie_len;
3d9975d5
JM
4976
4977 /**
4978 * locally_generated - Whether the frame was locally generated
4979 */
4980 int locally_generated;
1d041bec
JM
4981 } disassoc_info;
4982
4983 /**
4984 * struct deauth_info - Data for EVENT_DEAUTH events
4985 */
4986 struct deauth_info {
4987 /**
4988 * addr - Station address (for AP mode)
4989 */
4990 const u8 *addr;
0544b242
JM
4991
4992 /**
4993 * reason_code - Reason Code (host byte order) used in
4994 * Deauthentication frame
4995 */
4996 u16 reason_code;
75bde05d
JM
4997
4998 /**
4999 * ie - Optional IE(s) in Deauthentication frame
5000 */
5001 const u8 *ie;
5002
5003 /**
5004 * ie_len - Length of ie buffer in octets
5005 */
5006 size_t ie_len;
3d9975d5
JM
5007
5008 /**
5009 * locally_generated - Whether the frame was locally generated
5010 */
5011 int locally_generated;
1d041bec
JM
5012 } deauth_info;
5013
6fc6879b
JM
5014 /**
5015 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
5016 */
5017 struct michael_mic_failure {
5018 int unicast;
ad1e68e6 5019 const u8 *src;
6fc6879b
JM
5020 } michael_mic_failure;
5021
5022 /**
5023 * struct interface_status - Data for EVENT_INTERFACE_STATUS
5024 */
5025 struct interface_status {
45e3fc72 5026 unsigned int ifindex;
6fc6879b
JM
5027 char ifname[100];
5028 enum {
5029 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
5030 } ievent;
5031 } interface_status;
5032
5033 /**
5034 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
5035 */
5036 struct pmkid_candidate {
5037 /** BSSID of the PMKID candidate */
5038 u8 bssid[ETH_ALEN];
5039 /** Smaller the index, higher the priority */
5040 int index;
5041 /** Whether RSN IE includes pre-authenticate flag */
5042 int preauth;
5043 } pmkid_candidate;
5044
281ff0aa
GP
5045 /**
5046 * struct tdls - Data for EVENT_TDLS
5047 */
5048 struct tdls {
5049 u8 peer[ETH_ALEN];
5050 enum {
5051 TDLS_REQUEST_SETUP,
c10ca2a6
SD
5052 TDLS_REQUEST_TEARDOWN,
5053 TDLS_REQUEST_DISCOVER,
281ff0aa
GP
5054 } oper;
5055 u16 reason_code; /* for teardown */
5056 } tdls;
5057
a884be9d
XC
5058 /**
5059 * struct wnm - Data for EVENT_WNM
5060 */
5061 struct wnm {
5062 u8 addr[ETH_ALEN];
5063 enum {
5064 WNM_OPER_SLEEP,
5065 } oper;
5066 enum {
5067 WNM_SLEEP_ENTER,
5068 WNM_SLEEP_EXIT
5069 } sleep_action;
5070 int sleep_intval;
5071 u16 reason_code;
5072 u8 *buf;
5073 u16 buf_len;
5074 } wnm;
5075
6fc6879b
JM
5076 /**
5077 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
5078 *
5079 * During FT (IEEE 802.11r) authentication sequence, the driver is
5080 * expected to use this event to report received FT IEs (MDIE, FTIE,
5081 * RSN IE, TIE, possible resource request) to the supplicant. The FT
5082 * IEs for the next message will be delivered through the
5083 * struct wpa_driver_ops::update_ft_ies() callback.
5084 */
5085 struct ft_ies {
5086 const u8 *ies;
5087 size_t ies_len;
5088 int ft_action;
5089 u8 target_ap[ETH_ALEN];
babfbf15
JM
5090 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
5091 const u8 *ric_ies;
5092 /** Length of ric_ies buffer in octets */
5093 size_t ric_ies_len;
6fc6879b 5094 } ft_ies;
11ef8d35
JM
5095
5096 /**
5097 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
5098 */
5099 struct ibss_rsn_start {
5100 u8 peer[ETH_ALEN];
5101 } ibss_rsn_start;
c2a04078
JM
5102
5103 /**
5104 * struct auth_info - Data for EVENT_AUTH events
5105 */
5106 struct auth_info {
5107 u8 peer[ETH_ALEN];
a52eba0f 5108 u8 bssid[ETH_ALEN];
c2a04078 5109 u16 auth_type;
a52eba0f 5110 u16 auth_transaction;
c2a04078
JM
5111 u16 status_code;
5112 const u8 *ies;
5113 size_t ies_len;
5114 } auth;
efa46078
JM
5115
5116 /**
5117 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
5118 */
5119 struct assoc_reject {
59ddf221
JM
5120 /**
5121 * bssid - BSSID of the AP that rejected association
5122 */
5123 const u8 *bssid;
5124
efa46078
JM
5125 /**
5126 * resp_ies - (Re)Association Response IEs
5127 *
5128 * Optional association data from the driver. This data is not
5129 * required WPA, but may be useful for some protocols and as
5130 * such, should be reported if this is available to the driver
5131 * interface.
5132 *
5133 * This should start with the first IE (fixed fields before IEs
5134 * are not included).
5135 */
59ddf221 5136 const u8 *resp_ies;
efa46078
JM
5137
5138 /**
5139 * resp_ies_len - Length of resp_ies in bytes
5140 */
5141 size_t resp_ies_len;
5142
5143 /**
5144 * status_code - Status Code from (Re)association Response
5145 */
5146 u16 status_code;
9a5160f5
JM
5147
5148 /**
5149 * timed_out - Whether failure is due to timeout (etc.) rather
5150 * than explicit rejection response from the AP.
5151 */
5152 int timed_out;
3f23260d
PK
5153
5154 /**
5155 * timeout_reason - Reason for the timeout
5156 */
5157 const char *timeout_reason;
ad295f3b
VK
5158
5159 /**
5160 * fils_erp_next_seq_num - The next sequence number to use in
5161 * FILS ERP messages
5162 */
5163 u16 fils_erp_next_seq_num;
efa46078 5164 } assoc_reject;
da1fb17c
JM
5165
5166 struct timeout_event {
5167 u8 addr[ETH_ALEN];
5168 } timeout_event;
08fd8c15 5169
f8b1f695
JM
5170 /**
5171 * struct tx_status - Data for EVENT_TX_STATUS events
5172 */
5173 struct tx_status {
5174 u16 type;
5175 u16 stype;
5176 const u8 *dst;
5177 const u8 *data;
5178 size_t data_len;
5179 int ack;
5180 } tx_status;
5181
5182 /**
5183 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
5184 */
5185 struct rx_from_unknown {
9b90955e
JB
5186 const u8 *bssid;
5187 const u8 *addr;
5188 int wds;
f8b1f695
JM
5189 } rx_from_unknown;
5190
5191 /**
5192 * struct rx_mgmt - Data for EVENT_RX_MGMT events
5193 */
5194 struct rx_mgmt {
b57e086c 5195 const u8 *frame;
f8b1f695 5196 size_t frame_len;
2a8b7416 5197 u32 datarate;
55777702 5198
1d91f504
SW
5199 /**
5200 * drv_priv - Pointer to store driver private BSS information
5201 *
5202 * If not set to NULL, this is used for comparison with
5203 * hostapd_data->drv_priv to determine which BSS should process
5204 * the frame.
5205 */
5206 void *drv_priv;
5207
55777702
JM
5208 /**
5209 * freq - Frequency (in MHz) on which the frame was received
5210 */
5211 int freq;
2d2ecf51
JM
5212
5213 /**
5214 * ssi_signal - Signal strength in dBm (or 0 if not available)
5215 */
5216 int ssi_signal;
dbfb8e82 5217 } rx_mgmt;
55777702
JM
5218
5219 /**
5220 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
5221 *
5222 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
5223 */
5224 struct remain_on_channel {
5225 /**
5226 * freq - Channel frequency in MHz
5227 */
5228 unsigned int freq;
5229
5230 /**
5231 * duration - Duration to remain on the channel in milliseconds
5232 */
5233 unsigned int duration;
5234 } remain_on_channel;
5235
8d923a4a
JM
5236 /**
5237 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
5238 * @aborted: Whether the scan was aborted
5239 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
5240 * @num_freqs: Number of entries in freqs array
5241 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
5242 * SSID)
5243 * @num_ssids: Number of entries in ssids array
adcd7c4b
KV
5244 * @external_scan: Whether the scan info is for an external scan
5245 * @nl_scan_event: 1 if the source of this scan event is a normal scan,
5246 * 0 if the source of the scan event is a vendor scan
c16b9f8d
AS
5247 * @scan_start_tsf: Time when the scan started in terms of TSF of the
5248 * BSS that the interface that requested the scan is connected to
5249 * (if available).
5250 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
5251 * is set.
8d923a4a
JM
5252 */
5253 struct scan_info {
5254 int aborted;
5255 const int *freqs;
5256 size_t num_freqs;
5257 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
5258 size_t num_ssids;
adcd7c4b
KV
5259 int external_scan;
5260 int nl_scan_event;
c16b9f8d
AS
5261 u64 scan_start_tsf;
5262 u8 scan_start_tsf_bssid[ETH_ALEN];
8d923a4a 5263 } scan_info;
245519e0 5264
a0e0d3bb
JM
5265 /**
5266 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
5267 */
5268 struct rx_probe_req {
5269 /**
5270 * sa - Source address of the received Probe Request frame
5271 */
5272 const u8 *sa;
5273
04a85e44
JM
5274 /**
5275 * da - Destination address of the received Probe Request frame
5276 * or %NULL if not available
5277 */
5278 const u8 *da;
5279
5280 /**
5281 * bssid - BSSID of the received Probe Request frame or %NULL
5282 * if not available
5283 */
5284 const u8 *bssid;
5285
a0e0d3bb
JM
5286 /**
5287 * ie - IEs from the Probe Request body
5288 */
5289 const u8 *ie;
5290
5291 /**
5292 * ie_len - Length of ie buffer in octets
5293 */
5294 size_t ie_len;
baf513d6
JB
5295
5296 /**
5297 * signal - signal strength in dBm (or 0 if not available)
5298 */
5299 int ssi_signal;
a0e0d3bb 5300 } rx_probe_req;
a70a5d6d
JM
5301
5302 /**
5303 * struct new_sta - Data for EVENT_NEW_STA events
5304 */
5305 struct new_sta {
5306 const u8 *addr;
5307 } new_sta;
a8e0505b
JM
5308
5309 /**
5310 * struct eapol_rx - Data for EVENT_EAPOL_RX events
5311 */
5312 struct eapol_rx {
5313 const u8 *src;
5314 const u8 *data;
5315 size_t data_len;
5316 } eapol_rx;
b625473c
JM
5317
5318 /**
1c5c7273 5319 * signal_change - Data for EVENT_SIGNAL_CHANGE events
b625473c 5320 */
1c5c7273 5321 struct wpa_signal_info signal_change;
7cfc4ac3
AGS
5322
5323 /**
5324 * struct best_channel - Data for EVENT_BEST_CHANNEL events
5325 * @freq_24: Best 2.4 GHz band channel frequency in MHz
5326 * @freq_5: Best 5 GHz band channel frequency in MHz
5327 * @freq_overall: Best channel frequency in MHz
5328 *
5329 * 0 can be used to indicate no preference in either band.
5330 */
5331 struct best_channel {
5332 int freq_24;
5333 int freq_5;
5334 int freq_overall;
5335 } best_chan;
7d878ca7
JM
5336
5337 struct unprot_deauth {
5338 const u8 *sa;
5339 const u8 *da;
5340 u16 reason_code;
5341 } unprot_deauth;
5342
5343 struct unprot_disassoc {
5344 const u8 *sa;
5345 const u8 *da;
5346 u16 reason_code;
5347 } unprot_disassoc;
0d7e5a3a
JB
5348
5349 /**
5350 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
5351 * @addr: station address
68855672
JM
5352 * @num_packets: Number of packets lost (consecutive packets not
5353 * acknowledged)
0d7e5a3a
JB
5354 */
5355 struct low_ack {
5356 u8 addr[ETH_ALEN];
68855672 5357 u32 num_packets;
0d7e5a3a 5358 } low_ack;
3ac17eba 5359
ea244d21
XC
5360 /**
5361 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
5362 */
5363 struct ibss_peer_lost {
5364 u8 peer[ETH_ALEN];
5365 } ibss_peer_lost;
b14a210c
JB
5366
5367 /**
5368 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
5369 */
5370 struct driver_gtk_rekey {
5371 const u8 *bssid;
5372 const u8 *replay_ctr;
5373 } driver_gtk_rekey;
bcf24348
JB
5374
5375 /**
5376 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
5377 * @addr: station address
5378 */
5379 struct client_poll {
5380 u8 addr[ETH_ALEN];
5381 } client_poll;
dd840f79
JB
5382
5383 /**
5384 * struct eapol_tx_status
5385 * @dst: Original destination
5386 * @data: Data starting with IEEE 802.1X header (!)
5387 * @data_len: Length of data
5388 * @ack: Indicates ack or lost frame
5389 *
5390 * This corresponds to hapd_send_eapol if the frame sent
5391 * there isn't just reported as EVENT_TX_STATUS.
5392 */
5393 struct eapol_tx_status {
5394 const u8 *dst;
5395 const u8 *data;
5396 int data_len;
5397 int ack;
5398 } eapol_tx_status;
1b487b8b
TP
5399
5400 /**
5401 * struct ch_switch
5402 * @freq: Frequency of new channel in MHz
5403 * @ht_enabled: Whether this is an HT channel
5404 * @ch_offset: Secondary channel offset
8d1fdde7
JD
5405 * @ch_width: Channel width
5406 * @cf1: Center frequency 1
5407 * @cf2: Center frequency 2
1b487b8b
TP
5408 */
5409 struct ch_switch {
5410 int freq;
5411 int ht_enabled;
5412 int ch_offset;
8d1fdde7
JD
5413 enum chan_width ch_width;
5414 int cf1;
5415 int cf2;
1b487b8b 5416 } ch_switch;
3140803b
RM
5417
5418 /**
5419 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
5420 * @addr: Remote client address
5421 * @code: Reason code for connection failure
5422 */
5423 struct connect_failed_reason {
5424 u8 addr[ETH_ALEN];
5425 enum {
5426 MAX_CLIENT_REACHED,
5427 BLOCKED_CLIENT
5428 } code;
5429 } connect_failed_reason;
04be54fa
SW
5430
5431 /**
5432 * struct dfs_event - Data for radar detected events
5433 * @freq: Frequency of the channel in MHz
5434 */
5435 struct dfs_event {
5436 int freq;
846de15d
JD
5437 int ht_enabled;
5438 int chan_offset;
5439 enum chan_width chan_width;
5440 int cf1;
5441 int cf2;
04be54fa 5442 } dfs_event;
0185007c
MK
5443
5444 /**
5445 * survey_results - Survey result data for EVENT_SURVEY
5446 * @freq_filter: Requested frequency survey filter, 0 if request
5447 * was for all survey data
4e8f31e2 5448 * @survey_list: Linked list of survey data (struct freq_survey)
0185007c
MK
5449 */
5450 struct survey_results {
5451 unsigned int freq_filter;
5452 struct dl_list survey_list; /* struct freq_survey */
5453 } survey_results;
795baf77
AS
5454
5455 /**
5456 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
5457 * @initiator: Initiator of the regulatory change
142817b2
JM
5458 * @type: Regulatory change type
5459 * @alpha2: Country code (or "" if not available)
795baf77
AS
5460 */
5461 struct channel_list_changed {
5462 enum reg_change_initiator initiator;
142817b2
JM
5463 enum reg_type type;
5464 char alpha2[3];
795baf77 5465 } channel_list_changed;
253f2e37
AH
5466
5467 /**
5468 * freq_range - List of frequency ranges
5469 *
5470 * This is used as the data with EVENT_AVOID_FREQUENCIES.
5471 */
5472 struct wpa_freq_range_list freq_range;
a52024c9
BC
5473
5474 /**
5475 * struct mesh_peer
5476 *
5477 * @peer: Peer address
5478 * @ies: Beacon IEs
5479 * @ie_len: Length of @ies
5480 *
5481 * Notification of new candidate mesh peer.
5482 */
5483 struct mesh_peer {
5484 const u8 *peer;
5485 const u8 *ies;
5486 size_t ie_len;
5487 } mesh_peer;
5488
16689c7c
PX
5489 /**
5490 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
5491 * @pri_channel: Selected primary channel
5492 * @sec_channel: Selected secondary channel
857d9422
MM
5493 * @vht_seg0_center_ch: VHT mode Segment0 center channel
5494 * @vht_seg1_center_ch: VHT mode Segment1 center channel
5495 * @ch_width: Selected Channel width by driver. Driver may choose to
5496 * change hostapd configured ACS channel width due driver internal
5497 * channel restrictions.
3784c058 5498 * hw_mode: Selected band (used with hw_mode=any)
16689c7c
PX
5499 */
5500 struct acs_selected_channels {
5501 u8 pri_channel;
5502 u8 sec_channel;
857d9422
MM
5503 u8 vht_seg0_center_ch;
5504 u8 vht_seg1_center_ch;
5505 u16 ch_width;
3784c058 5506 enum hostapd_hw_mode hw_mode;
16689c7c 5507 } acs_selected_channels;
a6f5b193
PX
5508
5509 /**
5510 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
5511 * @reason_code: Reason for stopping offload
5512 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
5513 * scheduled.
5514 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
5515 * be stopped.
5516 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
5517 * parameters.
5518 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
5519 * supported by device.
5520 */
5521 struct p2p_lo_stop {
5522 enum {
5523 P2P_LO_STOPPED_REASON_COMPLETE = 0,
5524 P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
5525 P2P_LO_STOPPED_REASON_INVALID_PARAM,
5526 P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
5527 } reason_code;
5528 } p2p_lo_stop;
ba71cb82
SD
5529
5530 /* For EVENT_EXTERNAL_AUTH */
5531 struct external_auth external_auth;
e8ada160
T
5532
5533 /**
5534 * struct sta_opmode - Station's operation mode change event
5535 * @addr: The station MAC address
5536 * @smps_mode: SMPS mode of the station
5537 * @chan_width: Channel width of the station
5538 * @rx_nss: RX_NSS of the station
5539 *
5540 * This is used as data with EVENT_STATION_OPMODE_CHANGED.
5541 */
5542 struct sta_opmode {
5543 const u8 *addr;
5544 enum smps_mode smps_mode;
5545 enum chan_width chan_width;
5546 u8 rx_nss;
5547 } sta_opmode;
1952b626
BP
5548
5549 /**
5550 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
5551 */
5552 struct wds_sta_interface {
5553 const u8 *sta_addr;
5554 const char *ifname;
5555 enum {
5556 INTERFACE_ADDED,
5557 INTERFACE_REMOVED
5558 } istatus;
5559 } wds_sta_interface;
6fc6879b
JM
5560};
5561
5562/**
5563 * wpa_supplicant_event - Report a driver event for wpa_supplicant
5564 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5565 * with struct wpa_driver_ops::init()
5566 * @event: event type (defined above)
5567 * @data: possible extra data for the event
5568 *
5569 * Driver wrapper code should call this function whenever an event is received
5570 * from the driver.
5571 */
9646a8ab 5572void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
6fc6879b
JM
5573 union wpa_event_data *data);
5574
45e3fc72
RM
5575/**
5576 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
5577 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
5578 * with struct wpa_driver_ops::init()
5579 * @event: event type (defined above)
5580 * @data: possible extra data for the event
5581 *
5582 * Same as wpa_supplicant_event(), but we search for the interface in
5583 * wpa_global.
5584 */
5585void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
5586 union wpa_event_data *data);
c5121837 5587
1d041bec
JM
5588/*
5589 * The following inline functions are provided for convenience to simplify
5590 * event indication for some of the common events.
5591 */
5592
5593static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
39b08b5f 5594 size_t ielen, int reassoc)
1d041bec
JM
5595{
5596 union wpa_event_data event;
5597 os_memset(&event, 0, sizeof(event));
39b08b5f 5598 event.assoc_info.reassoc = reassoc;
1d041bec
JM
5599 event.assoc_info.req_ies = ie;
5600 event.assoc_info.req_ies_len = ielen;
5601 event.assoc_info.addr = addr;
5602 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
5603}
5604
5605static inline void drv_event_disassoc(void *ctx, const u8 *addr)
5606{
5607 union wpa_event_data event;
5608 os_memset(&event, 0, sizeof(event));
5609 event.disassoc_info.addr = addr;
5610 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
5611}
c5121837 5612
baac6490
JM
5613static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
5614 size_t data_len)
5615{
5616 union wpa_event_data event;
5617 os_memset(&event, 0, sizeof(event));
5618 event.eapol_rx.src = src;
5619 event.eapol_rx.data = data;
5620 event.eapol_rx.data_len = data_len;
5621 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
5622}
5623
aea855d7
JM
5624/* driver_common.c */
5625void wpa_scan_results_free(struct wpa_scan_results *res);
9e0e6902 5626
6c3771d7
BG
5627/* Convert wpa_event_type to a string for logging */
5628const char * event_to_string(enum wpa_event_type event);
5629
7a4a93b9
DW
5630/* Convert chan_width to a string for logging and control interfaces */
5631const char * channel_width_to_string(enum chan_width width);
5632
d706e0d7
MV
5633int channel_width_to_int(enum chan_width width);
5634
3eafc494
JM
5635int ht_supported(const struct hostapd_hw_modes *mode);
5636int vht_supported(const struct hostapd_hw_modes *mode);
5637
88cb27c7
DS
5638struct wowlan_triggers *
5639wpa_get_wowlan_triggers(const char *wowlan_triggers,
5640 const struct wpa_driver_capa *capa);
4d7aab78
EL
5641/* Convert driver flag to string */
5642const char * driver_flag_to_string(u64 flag);
88cb27c7 5643
fcc61230 5644/* NULL terminated array of linked in driver wrappers */
8b423edb 5645extern const struct wpa_driver_ops *const wpa_drivers[];
fcc61230 5646
39ab6a5d
JM
5647
5648/* Available drivers */
5649
5650#ifdef CONFIG_DRIVER_WEXT
5651extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
5652#endif /* CONFIG_DRIVER_WEXT */
5653#ifdef CONFIG_DRIVER_NL80211
5654/* driver_nl80211.c */
5655extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
5656#endif /* CONFIG_DRIVER_NL80211 */
5657#ifdef CONFIG_DRIVER_HOSTAP
5658extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */
5659#endif /* CONFIG_DRIVER_HOSTAP */
5660#ifdef CONFIG_DRIVER_BSD
5661extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
5662#endif /* CONFIG_DRIVER_BSD */
5663#ifdef CONFIG_DRIVER_OPENBSD
5664/* driver_openbsd.c */
5665extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
5666#endif /* CONFIG_DRIVER_OPENBSD */
5667#ifdef CONFIG_DRIVER_NDIS
5668extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
5669#endif /* CONFIG_DRIVER_NDIS */
5670#ifdef CONFIG_DRIVER_WIRED
5671extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
5672#endif /* CONFIG_DRIVER_WIRED */
5673#ifdef CONFIG_DRIVER_MACSEC_QCA
5674/* driver_macsec_qca.c */
5675extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
5676#endif /* CONFIG_DRIVER_MACSEC_QCA */
f014d9db
SD
5677#ifdef CONFIG_DRIVER_MACSEC_LINUX
5678/* driver_macsec_linux.c */
5679extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops;
5680#endif /* CONFIG_DRIVER_MACSEC_LINUX */
39ab6a5d
JM
5681#ifdef CONFIG_DRIVER_ROBOSWITCH
5682/* driver_roboswitch.c */
5683extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
5684#endif /* CONFIG_DRIVER_ROBOSWITCH */
5685#ifdef CONFIG_DRIVER_ATHEROS
5686/* driver_atheros.c */
5687extern const struct wpa_driver_ops wpa_driver_atheros_ops;
5688#endif /* CONFIG_DRIVER_ATHEROS */
5689#ifdef CONFIG_DRIVER_NONE
5690extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
5691#endif /* CONFIG_DRIVER_NONE */
5692
6fc6879b 5693#endif /* DRIVER_H */