]> git.ipfire.org Git - thirdparty/hostap.git/blame - src/drivers/driver.h
hostapd: Add ctrl_iface events for ACS
[thirdparty/hostap.git] / src / drivers / driver.h
CommitLineData
6fc6879b 1/*
e0498677 2 * Driver interface definition
3d9975d5 3 * Copyright (c) 2003-2012, 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"
0185007c 23#include "utils/list.h"
6fc6879b 24
c5121837
JM
25#define HOSTAPD_CHAN_DISABLED 0x00000001
26#define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
27#define HOSTAPD_CHAN_NO_IBSS 0x00000004
28#define HOSTAPD_CHAN_RADAR 0x00000008
d8e66e80
JM
29#define HOSTAPD_CHAN_HT40PLUS 0x00000010
30#define HOSTAPD_CHAN_HT40MINUS 0x00000020
31#define HOSTAPD_CHAN_HT40 0x00000040
50f4f2a0 32#define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080
c5121837 33
fc96522e
SW
34#define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
35#define HOSTAPD_CHAN_DFS_USABLE 0x00000100
36#define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
37#define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
38#define HOSTAPD_CHAN_DFS_MASK 0x00000300
39
53cfad46
EP
40#define HOSTAPD_CHAN_VHT_10_70 0x00000800
41#define HOSTAPD_CHAN_VHT_30_50 0x00001000
42#define HOSTAPD_CHAN_VHT_50_30 0x00002000
43#define HOSTAPD_CHAN_VHT_70_10 0x00004000
44
e0498677
JM
45/**
46 * struct hostapd_channel_data - Channel information
47 */
c5121837 48struct hostapd_channel_data {
e0498677
JM
49 /**
50 * chan - Channel number (IEEE 802.11)
51 */
52 short chan;
53
54 /**
55 * freq - Frequency in MHz
56 */
c0976528 57 int freq;
e0498677
JM
58
59 /**
60 * flag - Channel flags (HOSTAPD_CHAN_*)
61 */
62 int flag;
63
64 /**
6651f1f9 65 * max_tx_power - Regulatory transmit power limit in dBm
e0498677
JM
66 */
67 u8 max_tx_power;
0185007c
MK
68
69 /*
70 * survey_list - Linked list of surveys
71 */
72 struct dl_list survey_list;
73
74 /**
75 * min_nf - Minimum observed noise floor, in dBm, based on all
76 * surveyed channel data
77 */
78 s8 min_nf;
50f4f2a0
MK
79
80#ifdef CONFIG_ACS
81 /**
82 * interference_factor - Computed interference factor on this
83 * channel (used internally in src/ap/acs.c; driver wrappers do not
84 * need to set this)
85 */
86 long double interference_factor;
87#endif /* CONFIG_ACS */
c5121837
JM
88};
89
e3b473eb 90#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
c8ebeda4 91#define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
e3b473eb 92
e0498677
JM
93/**
94 * struct hostapd_hw_modes - Supported hardware mode information
95 */
c5121837 96struct hostapd_hw_modes {
e0498677
JM
97 /**
98 * mode - Hardware mode
99 */
71934751 100 enum hostapd_hw_mode mode;
e0498677
JM
101
102 /**
103 * num_channels - Number of entries in the channels array
104 */
c5121837 105 int num_channels;
e0498677
JM
106
107 /**
108 * channels - Array of supported channels
109 */
c5121837 110 struct hostapd_channel_data *channels;
e0498677
JM
111
112 /**
113 * num_rates - Number of entries in the rates array
114 */
c5121837 115 int num_rates;
e0498677
JM
116
117 /**
118 * rates - Array of supported rates in 100 kbps units
119 */
120 int *rates;
121
122 /**
123 * ht_capab - HT (IEEE 802.11n) capabilities
124 */
c5121837 125 u16 ht_capab;
e0498677
JM
126
127 /**
128 * mcs_set - MCS (IEEE 802.11n) rate parameters
129 */
08eb154d 130 u8 mcs_set[16];
e0498677
JM
131
132 /**
133 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
134 */
be8eb8ab 135 u8 a_mpdu_params;
e3b473eb 136
efe45d14
MP
137 /**
138 * vht_capab - VHT (IEEE 802.11ac) capabilities
139 */
140 u32 vht_capab;
141
142 /**
143 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
144 */
145 u8 vht_mcs_set[8];
146
e3b473eb 147 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */
c5121837
JM
148};
149
150
6fc6879b
JM
151#define IEEE80211_MODE_INFRA 0
152#define IEEE80211_MODE_IBSS 1
ad1e68e6 153#define IEEE80211_MODE_AP 2
6fc6879b
JM
154
155#define IEEE80211_CAP_ESS 0x0001
156#define IEEE80211_CAP_IBSS 0x0002
157#define IEEE80211_CAP_PRIVACY 0x0010
158
ff3ad3c5
VK
159/* DMG (60 GHz) IEEE 802.11ad */
160/* type - bits 0..1 */
161#define IEEE80211_CAP_DMG_MASK 0x0003
162#define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */
163#define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */
164#define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */
165
7c2849d2
JM
166#define WPA_SCAN_QUAL_INVALID BIT(0)
167#define WPA_SCAN_NOISE_INVALID BIT(1)
168#define WPA_SCAN_LEVEL_INVALID BIT(2)
169#define WPA_SCAN_LEVEL_DBM BIT(3)
e6b8efeb
JM
170#define WPA_SCAN_AUTHENTICATED BIT(4)
171#define WPA_SCAN_ASSOCIATED BIT(5)
7c2849d2 172
6fc6879b
JM
173/**
174 * struct wpa_scan_res - Scan result for an BSS/IBSS
7c2849d2 175 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
6fc6879b
JM
176 * @bssid: BSSID
177 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
178 * @beacon_int: beacon interval in TUs (host byte order)
179 * @caps: capability information field in host byte order
180 * @qual: signal quality
181 * @noise: noise level
182 * @level: signal level
183 * @tsf: Timestamp
b3ad11bb
JM
184 * @age: Age of the information in milliseconds (i.e., how many milliseconds
185 * ago the last Beacon or Probe Response frame was received)
6fc6879b 186 * @ie_len: length of the following IE field in octets
8c090654 187 * @beacon_ie_len: length of the following Beacon IE field in octets
6fc6879b
JM
188 *
189 * This structure is used as a generic format for scan results from the
190 * driver. Each driver interface implementation is responsible for converting
191 * the driver or OS specific scan results into this format.
192 *
193 * If the driver does not support reporting all IEs, the IE data structure is
194 * constructed of the IEs that are available. This field will also need to
195 * include SSID in IE format. All drivers are encouraged to be extended to
196 * report all IEs to make it easier to support future additions.
197 */
198struct wpa_scan_res {
7c2849d2 199 unsigned int flags;
6fc6879b
JM
200 u8 bssid[ETH_ALEN];
201 int freq;
202 u16 beacon_int;
203 u16 caps;
204 int qual;
205 int noise;
206 int level;
207 u64 tsf;
b3ad11bb 208 unsigned int age;
6fc6879b 209 size_t ie_len;
8c090654
JM
210 size_t beacon_ie_len;
211 /*
212 * Followed by ie_len octets of IEs from Probe Response frame (or if
213 * the driver does not indicate source of IEs, these may also be from
214 * Beacon frame). After the first set of IEs, another set of IEs may
215 * follow (with beacon_ie_len octets of data) if the driver provides
216 * both IE sets.
217 */
6fc6879b
JM
218};
219
220/**
221 * struct wpa_scan_results - Scan results
222 * @res: Array of pointers to allocated variable length scan result entries
223 * @num: Number of entries in the scan result array
c5f10e80 224 * @fetch_time: Time when the results were fetched from the driver
6fc6879b
JM
225 */
226struct wpa_scan_results {
227 struct wpa_scan_res **res;
228 size_t num;
c5f10e80 229 struct os_time fetch_time;
6fc6879b
JM
230};
231
4b4a8ae5
JM
232/**
233 * struct wpa_interface_info - Network interface information
234 * @next: Pointer to the next interface or NULL if this is the last one
235 * @ifname: Interface name that can be used with init() or init2()
236 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
237 * not available
60ad2c7b 238 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
4b4a8ae5
JM
239 * is not an allocated copy, i.e., get_interfaces() caller will not free
240 * this)
241 */
242struct wpa_interface_info {
243 struct wpa_interface_info *next;
244 char *ifname;
245 char *desc;
246 const char *drv_name;
247};
248
35b741fd 249#define WPAS_MAX_SCAN_SSIDS 16
fc2b7ed5
JM
250
251/**
252 * struct wpa_driver_scan_params - Scan parameters
253 * Data for struct wpa_driver_ops::scan2().
254 */
255struct wpa_driver_scan_params {
256 /**
257 * ssids - SSIDs to scan for
258 */
259 struct wpa_driver_scan_ssid {
260 /**
261 * ssid - specific SSID to scan for (ProbeReq)
262 * %NULL or zero-length SSID is used to indicate active scan
ba2a573c 263 * with wildcard SSID.
fc2b7ed5
JM
264 */
265 const u8 *ssid;
266 /**
267 * ssid_len: Length of the SSID in octets
268 */
269 size_t ssid_len;
270 } ssids[WPAS_MAX_SCAN_SSIDS];
271
272 /**
273 * num_ssids - Number of entries in ssids array
274 * Zero indicates a request for a passive scan.
275 */
276 size_t num_ssids;
277
278 /**
279 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
280 */
281 const u8 *extra_ies;
282
283 /**
284 * extra_ies_len - Length of extra_ies in octets
285 */
286 size_t extra_ies_len;
d3a98225
JM
287
288 /**
289 * freqs - Array of frequencies to scan or %NULL for all frequencies
290 *
291 * The frequency is set in MHz. The array is zero-terminated.
292 */
293 int *freqs;
3812464c
JM
294
295 /**
296 * filter_ssids - Filter for reporting SSIDs
297 *
298 * This optional parameter can be used to request the driver wrapper to
299 * filter scan results to include only the specified SSIDs. %NULL
300 * indicates that no filtering is to be done. This can be used to
301 * reduce memory needs for scan results in environments that have large
302 * number of APs with different SSIDs.
303 *
304 * The driver wrapper is allowed to take this allocated buffer into its
305 * own use by setting the pointer to %NULL. In that case, the driver
306 * wrapper is responsible for freeing the buffer with os_free() once it
307 * is not needed anymore.
308 */
309 struct wpa_driver_scan_filter {
310 u8 ssid[32];
311 size_t ssid_len;
312 } *filter_ssids;
313
314 /**
315 * num_filter_ssids - Number of entries in filter_ssids array
316 */
317 size_t num_filter_ssids;
47185fc7 318
bf8d6d24
TP
319 /**
320 * filter_rssi - Filter by RSSI
321 *
322 * The driver may filter scan results in firmware to reduce host
323 * wakeups and thereby save power. Specify the RSSI threshold in s32
324 * dBm.
325 */
326 s32 filter_rssi;
327
47185fc7
RM
328 /**
329 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
330 *
331 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
332 * Mbps from the support rates element(s) in the Probe Request frames
333 * and not to transmit the frames at any of those rates.
334 */
335 u8 p2p_probe;
fc2b7ed5
JM
336};
337
c2a04078
JM
338/**
339 * struct wpa_driver_auth_params - Authentication parameters
340 * Data for struct wpa_driver_ops::authenticate().
341 */
342struct wpa_driver_auth_params {
343 int freq;
344 const u8 *bssid;
345 const u8 *ssid;
346 size_t ssid_len;
347 int auth_alg;
348 const u8 *ie;
349 size_t ie_len;
a0b2f99b
JM
350 const u8 *wep_key[4];
351 size_t wep_key_len[4];
352 int wep_tx_keyidx;
2a7e7f4e 353 int local_state_change;
2f4f73b1
EP
354
355 /**
356 * p2p - Whether this connection is a P2P group
357 */
358 int p2p;
359
c10347f2
JM
360 const u8 *sae_data;
361 size_t sae_data_len;
362
c2a04078
JM
363};
364
0c80427d
JM
365enum wps_mode {
366 WPS_MODE_NONE /* no WPS provisioning being used */,
367 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */,
368 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection
369 */
370};
371
6fc6879b
JM
372/**
373 * struct wpa_driver_associate_params - Association parameters
374 * Data for struct wpa_driver_ops::associate().
375 */
376struct wpa_driver_associate_params {
377 /**
378 * bssid - BSSID of the selected AP
379 * This can be %NULL, if ap_scan=2 mode is used and the driver is
380 * responsible for selecting with which BSS to associate. */
381 const u8 *bssid;
382
383 /**
384 * ssid - The selected SSID
385 */
386 const u8 *ssid;
e0498677
JM
387
388 /**
389 * ssid_len - Length of the SSID (1..32)
390 */
6fc6879b
JM
391 size_t ssid_len;
392
393 /**
394 * freq - Frequency of the channel the selected AP is using
395 * Frequency that the selected AP is using (in MHz as
396 * reported in the scan results)
397 */
398 int freq;
399
1f6c0ab8
BS
400 /**
401 * bg_scan_period - Background scan period in seconds, 0 to disable
402 * background scan, or -1 to indicate no change to default driver
403 * configuration
404 */
405 int bg_scan_period;
406
6fc6879b
JM
407 /**
408 * wpa_ie - WPA information element for (Re)Association Request
409 * WPA information element to be included in (Re)Association
410 * Request (including information element id and length). Use
411 * of this WPA IE is optional. If the driver generates the WPA
412 * IE, it can use pairwise_suite, group_suite, and
413 * key_mgmt_suite to select proper algorithms. In this case,
414 * the driver has to notify wpa_supplicant about the used WPA
415 * IE by generating an event that the interface code will
416 * convert into EVENT_ASSOCINFO data (see below).
417 *
418 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
419 * instead. The driver can determine which version is used by
420 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
421 * WPA2/RSN).
ad08c363
JM
422 *
423 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
6fc6879b
JM
424 */
425 const u8 *wpa_ie;
e0498677 426
6fc6879b
JM
427 /**
428 * wpa_ie_len - length of the wpa_ie
429 */
430 size_t wpa_ie_len;
431
64fa840a
JM
432 /**
433 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
434 */
435 unsigned int wpa_proto;
436
e0498677
JM
437 /**
438 * pairwise_suite - Selected pairwise cipher suite
439 *
440 * This is usually ignored if @wpa_ie is used.
441 */
71934751 442 enum wpa_cipher pairwise_suite;
e0498677
JM
443
444 /**
445 * group_suite - Selected group cipher suite
446 *
447 * This is usually ignored if @wpa_ie is used.
448 */
71934751 449 enum wpa_cipher group_suite;
e0498677
JM
450
451 /**
452 * key_mgmt_suite - Selected key management suite
453 *
454 * This is usually ignored if @wpa_ie is used.
455 */
71934751 456 enum wpa_key_mgmt key_mgmt_suite;
6fc6879b
JM
457
458 /**
459 * auth_alg - Allowed authentication algorithms
abd9fafa 460 * Bit field of WPA_AUTH_ALG_*
6fc6879b
JM
461 */
462 int auth_alg;
463
464 /**
465 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
466 */
467 int mode;
468
469 /**
470 * wep_key - WEP keys for static WEP configuration
471 */
472 const u8 *wep_key[4];
473
474 /**
475 * wep_key_len - WEP key length for static WEP configuration
476 */
477 size_t wep_key_len[4];
478
479 /**
480 * wep_tx_keyidx - WEP TX key index for static WEP configuration
481 */
482 int wep_tx_keyidx;
483
484 /**
485 * mgmt_frame_protection - IEEE 802.11w management frame protection
486 */
70f8cc8e 487 enum mfp_options mgmt_frame_protection;
6fc6879b
JM
488
489 /**
490 * ft_ies - IEEE 802.11r / FT information elements
491 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
492 * for fast transition, this parameter is set to include the IEs that
493 * are to be sent in the next FT Authentication Request message.
494 * update_ft_ies() handler is called to update the IEs for further
495 * FT messages in the sequence.
496 *
497 * The driver should use these IEs only if the target AP is advertising
498 * the same mobility domain as the one included in the MDIE here.
499 *
500 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
501 * AP after the initial association. These IEs can only be used if the
502 * target AP is advertising support for FT and is using the same MDIE
503 * and SSID as the current AP.
504 *
505 * The driver is responsible for reporting the FT IEs received from the
506 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
507 * type. update_ft_ies() handler will then be called with the FT IEs to
508 * include in the next frame in the authentication sequence.
509 */
510 const u8 *ft_ies;
511
512 /**
513 * ft_ies_len - Length of ft_ies in bytes
514 */
515 size_t ft_ies_len;
516
517 /**
518 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
519 *
520 * This value is provided to allow the driver interface easier access
521 * to the current mobility domain. This value is set to %NULL if no
522 * mobility domain is currently active.
523 */
524 const u8 *ft_md;
525
526 /**
527 * passphrase - RSN passphrase for PSK
528 *
529 * This value is made available only for WPA/WPA2-Personal (PSK) and
530 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
531 * the 8..63 character ASCII passphrase, if available. Please note that
532 * this can be %NULL if passphrase was not used to generate the PSK. In
533 * that case, the psk field must be used to fetch the PSK.
534 */
535 const char *passphrase;
536
537 /**
538 * psk - RSN PSK (alternative for passphrase for PSK)
539 *
540 * This value is made available only for WPA/WPA2-Personal (PSK) and
541 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
542 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
543 * be prepared to handle %NULL value as an error.
544 */
545 const u8 *psk;
36b15723
JM
546
547 /**
548 * drop_unencrypted - Enable/disable unencrypted frame filtering
549 *
550 * Configure the driver to drop all non-EAPOL frames (both receive and
551 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
552 * still be allowed for key negotiation.
553 */
554 int drop_unencrypted;
62fa124c
JM
555
556 /**
557 * prev_bssid - Previously used BSSID in this ESS
558 *
559 * When not %NULL, this is a request to use reassociation instead of
560 * association.
561 */
562 const u8 *prev_bssid;
0c80427d
JM
563
564 /**
565 * wps - WPS mode
566 *
567 * If the driver needs to do special configuration for WPS association,
568 * this variable provides more information on what type of association
569 * is being requested. Most drivers should not need ot use this.
570 */
571 enum wps_mode wps;
75bde05d
JM
572
573 /**
574 * p2p - Whether this connection is a P2P group
575 */
576 int p2p;
eea2fd9e
JM
577
578 /**
579 * uapsd - UAPSD parameters for the network
580 * -1 = do not change defaults
581 * AP mode: 1 = enabled, 0 = disabled
582 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
583 */
584 int uapsd;
9e2af29f
NC
585
586 /**
587 * fixed_bssid - Whether to force this BSSID in IBSS mode
588 * 1 = Fix this BSSID and prevent merges.
589 * 0 = Do not fix BSSID.
590 */
591 int fixed_bssid;
80e8a5ee
BG
592
593 /**
594 * disable_ht - Disable HT (IEEE 802.11n) for this connection
595 */
596 int disable_ht;
597
598 /**
599 * HT Capabilities over-rides. Only bits set in the mask will be used,
600 * and not all values are used by the kernel anyway. Currently, MCS,
601 * MPDU and MSDU fields are used.
602 */
603 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */
604 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */
e9ee8dc3
JB
605
606#ifdef CONFIG_VHT_OVERRIDES
607 /**
608 * disable_vht - Disable VHT for this connection
609 */
610 int disable_vht;
611
612 /**
613 * VHT capability overrides.
614 */
615 const struct ieee80211_vht_capabilities *vhtcaps;
616 const struct ieee80211_vht_capabilities *vhtcaps_mask;
617#endif /* CONFIG_VHT_OVERRIDES */
6fc6879b
JM
618};
619
97a7a0b5
JM
620enum hide_ssid {
621 NO_SSID_HIDING,
622 HIDDEN_SSID_ZERO_LEN,
623 HIDDEN_SSID_ZERO_CONTENTS
624};
625
19c3b566
JM
626struct wpa_driver_ap_params {
627 /**
628 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
629 */
630 const u8 *head;
631
632 /**
633 * head_len - Length of the head buffer in octets
634 */
635 size_t head_len;
636
637 /**
638 * tail - Beacon tail following TIM IE
639 */
640 const u8 *tail;
641
642 /**
643 * tail_len - Length of the tail buffer in octets
644 */
645 size_t tail_len;
646
647 /**
648 * dtim_period - DTIM period
649 */
650 int dtim_period;
651
652 /**
653 * beacon_int - Beacon interval
654 */
655 int beacon_int;
ccb941e6 656
e5693c47
JM
657 /**
658 * basic_rates: -1 terminated array of basic rates in 100 kbps
659 *
660 * This parameter can be used to set a specific basic rate set for the
661 * BSS. If %NULL, default basic rate set is used.
662 */
663 int *basic_rates;
664
5b99e21a
AN
665 /**
666 * proberesp - Probe Response template
667 *
668 * This is used by drivers that reply to Probe Requests internally in
669 * AP mode and require the full Probe Response template.
670 */
671 const u8 *proberesp;
672
673 /**
674 * proberesp_len - Length of the proberesp buffer in octets
675 */
676 size_t proberesp_len;
677
ccb941e6
JM
678 /**
679 * ssid - The SSID to use in Beacon/Probe Response frames
680 */
681 const u8 *ssid;
682
683 /**
684 * ssid_len - Length of the SSID (1..32)
685 */
686 size_t ssid_len;
b11d1d64 687
97a7a0b5
JM
688 /**
689 * hide_ssid - Whether to hide the SSID
690 */
691 enum hide_ssid hide_ssid;
692
b11d1d64
JM
693 /**
694 * pairwise_ciphers - WPA_CIPHER_* bitfield
695 */
696 unsigned int pairwise_ciphers;
697
698 /**
699 * group_cipher - WPA_CIPHER_*
700 */
701 unsigned int group_cipher;
702
703 /**
704 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
705 */
706 unsigned int key_mgmt_suites;
707
708 /**
709 * auth_algs - WPA_AUTH_ALG_* bitfield
710 */
711 unsigned int auth_algs;
712
713 /**
714 * wpa_version - WPA_PROTO_* bitfield
715 */
716 unsigned int wpa_version;
717
718 /**
719 * privacy - Whether privacy is used in the BSS
720 */
721 int privacy;
fb91db56
JM
722
723 /**
724 * beacon_ies - WPS/P2P IE(s) for Beacon frames
725 *
dcd1eb5b
JM
726 * This is used to add IEs like WPS IE and P2P IE by drivers that do
727 * not use the full Beacon template.
fb91db56
JM
728 */
729 const struct wpabuf *beacon_ies;
730
731 /**
732 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
733 *
734 * This is used to add IEs like WPS IE and P2P IE by drivers that
735 * reply to Probe Request frames internally.
736 */
737 const struct wpabuf *proberesp_ies;
738
739 /**
740 * assocresp_ies - WPS IE(s) for (Re)Association Response frames
062390ef
JM
741 *
742 * This is used to add IEs like WPS IE by drivers that reply to
743 * (Re)Association Request frames internally.
fb91db56
JM
744 */
745 const struct wpabuf *assocresp_ies;
fd13a541
JM
746
747 /**
748 * isolate - Whether to isolate frames between associated stations
749 *
750 * If this is non-zero, the AP is requested to disable forwarding of
e53a0c74 751 * frames between associated stations.
fd13a541
JM
752 */
753 int isolate;
31357268
JM
754
755 /**
756 * cts_protect - Whether CTS protection is enabled
757 */
758 int cts_protect;
759
760 /**
761 * preamble - Whether short preamble is enabled
762 */
763 int preamble;
764
765 /**
766 * short_slot_time - Whether short slot time is enabled
767 *
768 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
769 * not set (e.g., when 802.11g mode is not in use)
770 */
771 int short_slot_time;
772
773 /**
774 * ht_opmode - HT operation mode or -1 if HT not in use
775 */
776 int ht_opmode;
8a33a63f
JM
777
778 /**
779 * interworking - Whether Interworking is enabled
780 */
781 int interworking;
782
783 /**
784 * hessid - Homogeneous ESS identifier or %NULL if not set
785 */
786 const u8 *hessid;
16991cff
JM
787
788 /**
789 * access_network_type - Access Network Type (0..15)
790 *
791 * This is used for filtering Probe Request frames when Interworking is
792 * enabled.
793 */
794 u8 access_network_type;
a0133ee1
VT
795
796 /**
797 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
798 *
799 * This is used by driver which advertises this capability.
800 */
801 int ap_max_inactivity;
83421850
JM
802
803 /**
804 * disable_dgaf - Whether group-addressed frames are disabled
805 */
806 int disable_dgaf;
19c3b566
JM
807};
808
6fc6879b
JM
809/**
810 * struct wpa_driver_capa - Driver capability information
811 */
812struct wpa_driver_capa {
813#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
814#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
815#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
816#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
817#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
818#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
819#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
369c8d7b 820#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
6fc6879b
JM
821 unsigned int key_mgmt;
822
823#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
824#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
825#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
826#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
349493bd 827#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010
eb7719ff 828#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020
6fc6879b
JM
829 unsigned int enc;
830
831#define WPA_DRIVER_AUTH_OPEN 0x00000001
832#define WPA_DRIVER_AUTH_SHARED 0x00000002
833#define WPA_DRIVER_AUTH_LEAP 0x00000004
834 unsigned int auth;
835
836/* Driver generated WPA/RSN IE */
837#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
0194fedb 838/* Driver needs static WEP key setup after association command */
6fc6879b 839#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
17fbb751 840/* unused: 0x00000004 */
6fc6879b
JM
841/* Driver takes care of RSN 4-way handshake internally; PMK is configured with
842 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
843#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
4ef1e644 844#define WPA_DRIVER_FLAGS_WIRED 0x00000010
c2a04078
JM
845/* Driver provides separate commands for authentication and association (SME in
846 * wpa_supplicant). */
847#define WPA_DRIVER_FLAGS_SME 0x00000020
1581b38b
JM
848/* Driver supports AP mode */
849#define WPA_DRIVER_FLAGS_AP 0x00000040
0194fedb
JB
850/* Driver needs static WEP key setup after association has been completed */
851#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
75bde05d
JM
852/* Driver takes care of P2P management operations */
853#define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100
854/* Driver supports concurrent P2P operations */
855#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
856/*
857 * Driver uses the initial interface as a dedicated management interface, i.e.,
971e357f 858 * it cannot be used for P2P group operations or non-P2P purposes.
75bde05d
JM
859 */
860#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400
7aad838c 861/* This interface is P2P capable (P2P GO or P2P Client) */
75bde05d 862#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800
93265969 863/* unused: 0x00001000 */
971e357f
JM
864/*
865 * Driver uses the initial interface for P2P management interface and non-P2P
866 * purposes (e.g., connect to infra AP), but this interface cannot be used for
867 * P2P group operations.
868 */
869#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000
871f4dd0
JM
870/*
871 * Driver is known to use sane error codes, i.e., when it indicates that
872 * something (e.g., association) fails, there was indeed a failure and the
873 * operation does not end up getting completed successfully later.
874 */
875#define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000
190b9062
JB
876/* Driver supports off-channel TX */
877#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000
2fee890a
JM
878/* Driver indicates TX status events for EAPOL Data frames */
879#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000
4dc03726
JM
880/* Driver indicates TX status events for Deauth/Disassoc frames */
881#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000
004ba773
VN
882/* Driver supports roaming (BSS selection) in firmware */
883#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000
03ea1786
AN
884/* Driver supports operating as a TDLS peer */
885#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000
886/* Driver requires external TDLS setup/teardown/discovery */
887#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000
562c9d97
AN
888/* Driver indicates support for Probe Response offloading in AP mode */
889#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000
70619a5d
EP
890/* Driver supports U-APSD in AP mode */
891#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000
a0133ee1
VT
892/* Driver supports inactivity timer in AP mode */
893#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000
e5091674
JM
894/* Driver expects user space implementation of MLME in AP mode */
895#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000
c10347f2
JM
896/* Driver supports SAE with user space SME */
897#define WPA_DRIVER_FLAGS_SAE 0x02000000
368b1957
AK
898/* Driver makes use of OBSS scan mechanism in wpa_supplicant */
899#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000
65d52fc1
BR
900/* Driver supports IBSS (Ad-hoc) mode */
901#define WPA_DRIVER_FLAGS_IBSS 0x08000000
f295d0c8
SW
902/* Driver supports radar detection */
903#define WPA_DRIVER_FLAGS_RADAR 0x10000000
7aad838c
NS
904/* Driver supports a dedicated interface for P2P Device */
905#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000
6fc6879b 906 unsigned int flags;
80bc75f1
JM
907
908 int max_scan_ssids;
cbdf3507
LC
909 int max_sched_scan_ssids;
910 int sched_scan_supported;
b59e6f26 911 int max_match_sets;
814782b9
JM
912
913 /**
914 * max_remain_on_chan - Maximum remain-on-channel duration in msec
915 */
916 unsigned int max_remain_on_chan;
c4ea4c5c
JM
917
918 /**
919 * max_stations - Maximum number of associated stations the driver
920 * supports in AP mode
921 */
922 unsigned int max_stations;
562c9d97
AN
923
924 /**
925 * probe_resp_offloads - Bitmap of supported protocols by the driver
926 * for Probe Response offloading.
927 */
928/* Driver Probe Response offloading support for WPS ver. 1 */
929#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001
930/* Driver Probe Response offloading support for WPS ver. 2 */
931#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002
932/* Driver Probe Response offloading support for P2P */
933#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004
934/* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
935#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008
936 unsigned int probe_resp_offloads;
8cd6b7bc 937
3c4ca363
VN
938 unsigned int max_acl_mac_addrs;
939
4752147d
IP
940 /**
941 * Number of supported concurrent channels
942 */
943 unsigned int num_multichan_concurrent;
944
8cd6b7bc
JB
945 /**
946 * extended_capa - extended capabilities in driver/device
947 *
948 * Must be allocated and freed by driver and the pointers must be
949 * valid for the lifetime of the driver, i.e., freed in deinit()
950 */
951 const u8 *extended_capa, *extended_capa_mask;
952 unsigned int extended_capa_len;
6fc6879b
JM
953};
954
955
c5121837
JM
956struct hostapd_data;
957
958struct hostap_sta_driver_data {
959 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
960 unsigned long current_tx_rate;
961 unsigned long inactive_msec;
962 unsigned long flags;
963 unsigned long num_ps_buf_frames;
964 unsigned long tx_retry_failed;
965 unsigned long tx_retry_count;
966 int last_rssi;
967 int last_ack_rssi;
968};
969
970struct hostapd_sta_add_params {
971 const u8 *addr;
972 u16 aid;
973 u16 capability;
974 const u8 *supp_rates;
975 size_t supp_rates_len;
c5121837 976 u16 listen_interval;
fc4e2d95 977 const struct ieee80211_ht_capabilities *ht_capabilities;
a9a1d0f0 978 const struct ieee80211_vht_capabilities *vht_capabilities;
d83ab1fe 979 u32 flags; /* bitmask of WPA_STA_* flags */
45b722f1 980 int set; /* Set STA parameters instead of add */
5d061637 981 u8 qosinfo;
d16531c4
SD
982 const u8 *ext_capab;
983 size_t ext_capab_len;
c5121837
JM
984};
985
986struct hostapd_freq_params {
987 int mode;
988 int freq;
989 int channel;
fa476336 990 /* for HT */
c5121837
JM
991 int ht_enabled;
992 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
993 * secondary channel below primary, 1 = HT40
994 * enabled, secondary channel above primary */
fa476336
JB
995
996 /* for VHT */
997 int vht_enabled;
998
999 /* valid for both HT and VHT, center_freq2 is non-zero
1000 * only for bandwidth 80 and an 80+80 channel */
1001 int center_freq1, center_freq2;
1002 int bandwidth;
c5121837
JM
1003};
1004
3c4ca363
VN
1005struct mac_address {
1006 u8 addr[ETH_ALEN];
1007};
1008
1009struct hostapd_acl_params {
1010 u8 acl_policy;
1011 unsigned int num_mac_acl;
1012 struct mac_address mac_acl[0];
1013};
1014
22a7c9d7
JM
1015enum wpa_driver_if_type {
1016 /**
1017 * WPA_IF_STATION - Station mode interface
1018 */
1019 WPA_IF_STATION,
1020
1021 /**
1022 * WPA_IF_AP_VLAN - AP mode VLAN interface
1023 *
1024 * This interface shares its address and Beacon frame with the main
1025 * BSS.
1026 */
1027 WPA_IF_AP_VLAN,
1028
1029 /**
1030 * WPA_IF_AP_BSS - AP mode BSS interface
1031 *
1032 * This interface has its own address and Beacon frame.
1033 */
1034 WPA_IF_AP_BSS,
75bde05d
JM
1035
1036 /**
1037 * WPA_IF_P2P_GO - P2P Group Owner
1038 */
1039 WPA_IF_P2P_GO,
1040
1041 /**
1042 * WPA_IF_P2P_CLIENT - P2P Client
1043 */
1044 WPA_IF_P2P_CLIENT,
1045
1046 /**
1047 * WPA_IF_P2P_GROUP - P2P Group interface (will become either
1048 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
1049 */
7aad838c
NS
1050 WPA_IF_P2P_GROUP,
1051
1052 /**
1053 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the
1054 * abstracted P2P Device function in the driver
1055 */
1056 WPA_IF_P2P_DEVICE
c5121837
JM
1057};
1058
92f475b4 1059struct wpa_init_params {
4b24282a 1060 void *global_priv;
92f475b4
JM
1061 const u8 *bssid;
1062 const char *ifname;
1063 const u8 *ssid;
1064 size_t ssid_len;
1065 const char *test_socket;
1066 int use_pae_group_addr;
92f475b4
JM
1067 char **bridge;
1068 size_t num_bridge;
412036f5
JM
1069
1070 u8 *own_addr; /* buffer for writing own MAC address */
92f475b4
JM
1071};
1072
c5121837 1073
e3bd3912
JM
1074struct wpa_bss_params {
1075 /** Interface name (for multi-SSID/VLAN support) */
1076 const char *ifname;
1077 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
1078 int enabled;
af586419
JM
1079
1080 int wpa;
1081 int ieee802_1x;
1082 int wpa_group;
1083 int wpa_pairwise;
1084 int wpa_key_mgmt;
1085 int rsn_preauth;
a1ca0292 1086 enum mfp_options ieee80211w;
e3bd3912
JM
1087};
1088
0de39516
JM
1089#define WPA_STA_AUTHORIZED BIT(0)
1090#define WPA_STA_WMM BIT(1)
1091#define WPA_STA_SHORT_PREAMBLE BIT(2)
1092#define WPA_STA_MFP BIT(3)
45b722f1 1093#define WPA_STA_TDLS_PEER BIT(4)
e3bd3912 1094
3ac17eba
JM
1095/**
1096 * struct p2p_params - P2P parameters for driver-based P2P management
1097 */
1098struct p2p_params {
1099 const char *dev_name;
1100 u8 pri_dev_type[8];
1101#define DRV_MAX_SEC_DEV_TYPES 5
1102 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8];
1103 size_t num_sec_dev_types;
1104};
1105
281ff0aa
GP
1106enum tdls_oper {
1107 TDLS_DISCOVERY_REQ,
1108 TDLS_SETUP,
1109 TDLS_TEARDOWN,
1110 TDLS_ENABLE_LINK,
b8f64582
JM
1111 TDLS_DISABLE_LINK,
1112 TDLS_ENABLE,
1113 TDLS_DISABLE
281ff0aa
GP
1114};
1115
a884be9d
XC
1116enum wnm_oper {
1117 WNM_SLEEP_ENTER_CONFIRM,
1118 WNM_SLEEP_ENTER_FAIL,
1119 WNM_SLEEP_EXIT_CONFIRM,
1120 WNM_SLEEP_EXIT_FAIL,
1121 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */
1122 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */
1123 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for
1124 * a STA */
1125 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE
1126 * for a STA */
1127 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
1128 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE
1129 * for a STA */
1130 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */
1131};
1132
2cc8d8f4
AO
1133/* enum chan_width - Channel width definitions */
1134enum chan_width {
1135 CHAN_WIDTH_20_NOHT,
1136 CHAN_WIDTH_20,
1137 CHAN_WIDTH_40,
1138 CHAN_WIDTH_80,
1139 CHAN_WIDTH_80P80,
1140 CHAN_WIDTH_160,
1141 CHAN_WIDTH_UNKNOWN
1142};
1143
1c5c7273
PS
1144/**
1145 * struct wpa_signal_info - Information about channel signal quality
1146 */
1147struct wpa_signal_info {
1148 u32 frequency;
1149 int above_threshold;
1150 int current_signal;
95783298 1151 int avg_signal;
1c5c7273
PS
1152 int current_noise;
1153 int current_txrate;
2cc8d8f4
AO
1154 enum chan_width chanwidth;
1155 int center_frq1;
1156 int center_frq2;
1c5c7273
PS
1157};
1158
6fc6879b
JM
1159/**
1160 * struct wpa_driver_ops - Driver interface API definition
1161 *
1162 * This structure defines the API that each driver interface needs to implement
1163 * for core wpa_supplicant code. All driver specific functionality is captured
1164 * in this wrapper.
1165 */
1166struct wpa_driver_ops {
1167 /** Name of the driver interface */
1168 const char *name;
1169 /** One line description of the driver interface */
1170 const char *desc;
1171
1172 /**
1173 * get_bssid - Get the current BSSID
1174 * @priv: private driver interface data
1175 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
1176 *
1177 * Returns: 0 on success, -1 on failure
1178 *
1179 * Query kernel driver for the current BSSID and copy it to bssid.
1180 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
1181 * associated.
1182 */
1183 int (*get_bssid)(void *priv, u8 *bssid);
1184
1185 /**
1186 * get_ssid - Get the current SSID
1187 * @priv: private driver interface data
1188 * @ssid: buffer for SSID (at least 32 bytes)
1189 *
1190 * Returns: Length of the SSID on success, -1 on failure
1191 *
1192 * Query kernel driver for the current SSID and copy it to ssid.
1193 * Returning zero is recommended if the STA is not associated.
1194 *
1195 * Note: SSID is an array of octets, i.e., it is not nul terminated and
1196 * can, at least in theory, contain control characters (including nul)
1197 * and as such, should be processed as binary data, not a printable
1198 * string.
1199 */
1200 int (*get_ssid)(void *priv, u8 *ssid);
1201
6fc6879b
JM
1202 /**
1203 * set_key - Configure encryption key
642187d6 1204 * @ifname: Interface name (for multi-SSID/VLAN support)
6fc6879b
JM
1205 * @priv: private driver interface data
1206 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
eb7719ff
JM
1207 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK,
1208 * %WPA_ALG_GCMP);
6fc6879b 1209 * %WPA_ALG_NONE clears the key.
0382097e
JM
1210 * @addr: Address of the peer STA (BSSID of the current AP when setting
1211 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for
1212 * broadcast keys, %NULL for default keys that are used both for
1213 * broadcast and unicast; when clearing keys, %NULL is used to
1214 * indicate that both the broadcast-only and default key of the
1215 * specified key index is to be cleared
6fc6879b
JM
1216 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
1217 * IGTK
1218 * @set_tx: configure this key as the default Tx key (only used when
1219 * driver does not support separate unicast/individual key
1220 * @seq: sequence number/packet number, seq_len octets, the next
1221 * packet number to be used for in replay protection; configured
1222 * for Rx keys (in most cases, this is only used with broadcast
da64c266 1223 * keys and set to zero for unicast keys); %NULL if not set
6fc6879b 1224 * @seq_len: length of the seq, depends on the algorithm:
eb7719ff 1225 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets
6fc6879b
JM
1226 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
1227 * 8-byte Rx Mic Key
1228 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
eb7719ff 1229 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16)
6fc6879b
JM
1230 *
1231 * Returns: 0 on success, -1 on failure
1232 *
1233 * Configure the given key for the kernel driver. If the driver
1234 * supports separate individual keys (4 default keys + 1 individual),
1235 * addr can be used to determine whether the key is default or
1236 * individual. If only 4 keys are supported, the default key with key
1237 * index 0 is used as the individual key. STA must be configured to use
1238 * it as the default Tx key (set_tx is set) and accept Rx for all the
1239 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
1240 * broadcast keys, so key index 0 is available for this kind of
1241 * configuration.
1242 *
1243 * Please note that TKIP keys include separate TX and RX MIC keys and
1244 * some drivers may expect them in different order than wpa_supplicant
1245 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
61fbd3df 1246 * will trigger Michael MIC errors. This can be fixed by changing the
6fc6879b
JM
1247 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
1248 * in driver_*.c set_key() implementation, see driver_ndis.c for an
1249 * example on how this can be done.
1250 */
71934751 1251 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg,
642187d6
JM
1252 const u8 *addr, int key_idx, int set_tx,
1253 const u8 *seq, size_t seq_len,
6fc6879b
JM
1254 const u8 *key, size_t key_len);
1255
1256 /**
1257 * init - Initialize driver interface
1258 * @ctx: context to be used when calling wpa_supplicant functions,
1259 * e.g., wpa_supplicant_event()
1260 * @ifname: interface name, e.g., wlan0
1261 *
1262 * Returns: Pointer to private data, %NULL on failure
1263 *
1264 * Initialize driver interface, including event processing for kernel
1265 * driver events (e.g., associated, scan results, Michael MIC failure).
1266 * This function can allocate a private configuration data area for
1267 * @ctx, file descriptor, interface name, etc. information that may be
1268 * needed in future driver operations. If this is not used, non-NULL
1269 * value will need to be returned because %NULL is used to indicate
1270 * failure. The returned value will be used as 'void *priv' data for
1271 * all other driver_ops functions.
1272 *
1273 * The main event loop (eloop.c) of wpa_supplicant can be used to
1274 * register callback for read sockets (eloop_register_read_sock()).
1275 *
1276 * See below for more information about events and
1277 * wpa_supplicant_event() function.
1278 */
1279 void * (*init)(void *ctx, const char *ifname);
1280
1281 /**
1282 * deinit - Deinitialize driver interface
1283 * @priv: private driver interface data from init()
1284 *
1285 * Shut down driver interface and processing of driver events. Free
1286 * private data buffer if one was allocated in init() handler.
1287 */
1288 void (*deinit)(void *priv);
1289
1290 /**
1291 * set_param - Set driver configuration parameters
1292 * @priv: private driver interface data from init()
1293 * @param: driver specific configuration parameters
1294 *
1295 * Returns: 0 on success, -1 on failure
1296 *
1297 * Optional handler for notifying driver interface about configuration
1298 * parameters (driver_param).
1299 */
1300 int (*set_param)(void *priv, const char *param);
1301
1302 /**
1303 * set_countermeasures - Enable/disable TKIP countermeasures
1304 * @priv: private driver interface data
1305 * @enabled: 1 = countermeasures enabled, 0 = disabled
1306 *
1307 * Returns: 0 on success, -1 on failure
1308 *
1309 * Configure TKIP countermeasures. When these are enabled, the driver
1310 * should drop all received and queued frames that are using TKIP.
1311 */
1312 int (*set_countermeasures)(void *priv, int enabled);
1313
6fc6879b
JM
1314 /**
1315 * deauthenticate - Request driver to deauthenticate
1316 * @priv: private driver interface data
1317 * @addr: peer address (BSSID of the AP)
1318 * @reason_code: 16-bit reason code to be sent in the deauthentication
1319 * frame
1320 *
1321 * Returns: 0 on success, -1 on failure
1322 */
1323 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
1324
6fc6879b
JM
1325 /**
1326 * associate - Request driver to associate
1327 * @priv: private driver interface data
1328 * @params: association parameters
1329 *
1330 * Returns: 0 on success, -1 on failure
1331 */
1332 int (*associate)(void *priv,
1333 struct wpa_driver_associate_params *params);
1334
6fc6879b
JM
1335 /**
1336 * add_pmkid - Add PMKSA cache entry to the driver
1337 * @priv: private driver interface data
1338 * @bssid: BSSID for the PMKSA cache entry
1339 * @pmkid: PMKID for the PMKSA cache entry
1340 *
1341 * Returns: 0 on success, -1 on failure
1342 *
1343 * This function is called when a new PMK is received, as a result of
1344 * either normal authentication or RSN pre-authentication.
1345 *
1346 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1347 * associate(), add_pmkid() can be used to add new PMKSA cache entries
1348 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
1349 * driver_ops function does not need to be implemented. Likewise, if
1350 * the driver does not support WPA, this function is not needed.
1351 */
1352 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1353
1354 /**
1355 * remove_pmkid - Remove PMKSA cache entry to the driver
1356 * @priv: private driver interface data
1357 * @bssid: BSSID for the PMKSA cache entry
1358 * @pmkid: PMKID for the PMKSA cache entry
1359 *
1360 * Returns: 0 on success, -1 on failure
1361 *
1362 * This function is called when the supplicant drops a PMKSA cache
1363 * entry for any reason.
1364 *
1365 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1366 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1367 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1368 * from wpa_supplicant, this driver_ops function does not need to be
1369 * implemented. Likewise, if the driver does not support WPA, this
1370 * function is not needed.
1371 */
1372 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
1373
1374 /**
1375 * flush_pmkid - Flush PMKSA cache
1376 * @priv: private driver interface data
1377 *
1378 * Returns: 0 on success, -1 on failure
1379 *
1380 * This function is called when the supplicant drops all PMKSA cache
1381 * entries for any reason.
1382 *
1383 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
1384 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
1385 * between the driver and wpa_supplicant. If the driver uses wpa_ie
1386 * from wpa_supplicant, this driver_ops function does not need to be
1387 * implemented. Likewise, if the driver does not support WPA, this
1388 * function is not needed.
1389 */
1390 int (*flush_pmkid)(void *priv);
1391
1392 /**
6179d2fd 1393 * get_capa - Get driver capabilities
6fc6879b
JM
1394 * @priv: private driver interface data
1395 *
1396 * Returns: 0 on success, -1 on failure
1397 *
1398 * Get driver/firmware/hardware capabilities.
1399 */
1400 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
1401
1402 /**
1403 * poll - Poll driver for association information
1404 * @priv: private driver interface data
1405 *
1406 * This is an option callback that can be used when the driver does not
1407 * provide event mechanism for association events. This is called when
1408 * receiving WPA EAPOL-Key messages that require association
1409 * information. The driver interface is supposed to generate associnfo
1410 * event before returning from this callback function. In addition, the
1411 * driver interface should generate an association event after having
1412 * sent out associnfo.
1413 */
1414 void (*poll)(void *priv);
1415
1416 /**
1417 * get_ifname - Get interface name
1418 * @priv: private driver interface data
1419 *
1420 * Returns: Pointer to the interface name. This can differ from the
e519314e 1421 * interface name used in init() call. Init() is called first.
6fc6879b
JM
1422 *
1423 * This optional function can be used to allow the driver interface to
1424 * replace the interface name with something else, e.g., based on an
1425 * interface mapping from a more descriptive name.
1426 */
1427 const char * (*get_ifname)(void *priv);
1428
1429 /**
1430 * get_mac_addr - Get own MAC address
1431 * @priv: private driver interface data
1432 *
1433 * Returns: Pointer to own MAC address or %NULL on failure
1434 *
1435 * This optional function can be used to get the own MAC address of the
1436 * device from the driver interface code. This is only needed if the
1437 * l2_packet implementation for the OS does not provide easy access to
1438 * a MAC address. */
1439 const u8 * (*get_mac_addr)(void *priv);
1440
1441 /**
1442 * send_eapol - Optional function for sending EAPOL packets
1443 * @priv: private driver interface data
1444 * @dest: Destination MAC address
1445 * @proto: Ethertype
1446 * @data: EAPOL packet starting with IEEE 802.1X header
1447 * @data_len: Size of the EAPOL packet
1448 *
1449 * Returns: 0 on success, -1 on failure
1450 *
1451 * This optional function can be used to override l2_packet operations
1452 * with driver specific functionality. If this function pointer is set,
1453 * l2_packet module is not used at all and the driver interface code is
1454 * responsible for receiving and sending all EAPOL packets. The
a8e0505b
JM
1455 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
1456 * event. The driver interface is required to implement get_mac_addr()
1457 * handler if send_eapol() is used.
6fc6879b
JM
1458 */
1459 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
1460 const u8 *data, size_t data_len);
1461
1462 /**
1463 * set_operstate - Sets device operating state to DORMANT or UP
1464 * @priv: private driver interface data
1465 * @state: 0 = dormant, 1 = up
1466 * Returns: 0 on success, -1 on failure
1467 *
1468 * This is an optional function that can be used on operating systems
1469 * that support a concept of controlling network device state from user
1470 * space applications. This function, if set, gets called with
1471 * state = 1 when authentication has been completed and with state = 0
1472 * when connection is lost.
1473 */
1474 int (*set_operstate)(void *priv, int state);
1475
1476 /**
1477 * mlme_setprotection - MLME-SETPROTECTION.request primitive
1478 * @priv: Private driver interface data
1479 * @addr: Address of the station for which to set protection (may be
1480 * %NULL for group keys)
1481 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
1482 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
1483 * Returns: 0 on success, -1 on failure
1484 *
1485 * This is an optional function that can be used to set the driver to
1486 * require protection for Tx and/or Rx frames. This uses the layer
1487 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
1488 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
1489 * set protection operation; instead, they set protection implicitly
1490 * based on configured keys.
1491 */
1492 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
1493 int key_type);
1494
1495 /**
1496 * get_hw_feature_data - Get hardware support data (channels and rates)
1497 * @priv: Private driver interface data
1498 * @num_modes: Variable for returning the number of returned modes
1499 * flags: Variable for returning hardware feature flags
1500 * Returns: Pointer to allocated hardware data on success or %NULL on
1501 * failure. Caller is responsible for freeing this.
6fc6879b 1502 */
6caf9ca6
JM
1503 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
1504 u16 *num_modes,
1505 u16 *flags);
6fc6879b 1506
6fc6879b
JM
1507 /**
1508 * send_mlme - Send management frame from MLME
1509 * @priv: Private driver interface data
1510 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1511 * @data_len: Size of the management frame
8cfa3527 1512 * @noack: Do not wait for this frame to be acked (disable retries)
6fc6879b 1513 * Returns: 0 on success, -1 on failure
6fc6879b 1514 */
8cfa3527
HS
1515 int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
1516 int noack);
6fc6879b 1517
6fc6879b
JM
1518 /**
1519 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1520 * @priv: Private driver interface data
1521 * @md: Mobility domain (2 octets) (also included inside ies)
1522 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1523 * @ies_len: Length of FT IEs in bytes
1524 * Returns: 0 on success, -1 on failure
1525 *
1526 * The supplicant uses this callback to let the driver know that keying
1527 * material for FT is available and that the driver can use the
1528 * provided IEs in the next message in FT authentication sequence.
1529 *
1530 * This function is only needed for driver that support IEEE 802.11r
1531 * (Fast BSS Transition).
1532 */
1533 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1534 size_t ies_len);
1535
1536 /**
1537 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1538 * @priv: Private driver interface data
1539 * @action: Action field value
1540 * @target_ap: Target AP address
1541 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1542 * @ies_len: Length of FT IEs in bytes
1543 * Returns: 0 on success, -1 on failure
1544 *
1545 * The supplicant uses this callback to request the driver to transmit
1546 * an FT Action frame (action category 6) for over-the-DS fast BSS
1547 * transition.
1548 */
1549 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1550 const u8 *ies, size_t ies_len);
1551
1552 /**
1553 * get_scan_results2 - Fetch the latest scan results
1554 * @priv: private driver interface data
1555 *
1556 * Returns: Allocated buffer of scan results (caller is responsible for
1557 * freeing the data structure) on success, NULL on failure
1558 */
1559 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1560
6d158490
LR
1561 /**
1562 * set_country - Set country
1563 * @priv: Private driver interface data
1564 * @alpha2: country to which to switch to
1565 * Returns: 0 on success, -1 on failure
1566 *
1567 * This function is for drivers which support some form
1568 * of setting a regulatory domain.
1569 */
1570 int (*set_country)(void *priv, const char *alpha2);
ac305589
JM
1571
1572 /**
1573 * global_init - Global driver initialization
1574 * Returns: Pointer to private data (global), %NULL on failure
1575 *
1576 * This optional function is called to initialize the driver wrapper
1577 * for global data, i.e., data that applies to all interfaces. If this
1578 * function is implemented, global_deinit() will also need to be
1579 * implemented to free the private data. The driver will also likely
1580 * use init2() function instead of init() to get the pointer to global
1581 * data available to per-interface initializer.
1582 */
1583 void * (*global_init)(void);
1584
1585 /**
1586 * global_deinit - Global driver deinitialization
1587 * @priv: private driver global data from global_init()
1588 *
1589 * Terminate any global driver related functionality and free the
1590 * global data structure.
1591 */
1592 void (*global_deinit)(void *priv);
1593
1594 /**
1595 * init2 - Initialize driver interface (with global data)
1596 * @ctx: context to be used when calling wpa_supplicant functions,
1597 * e.g., wpa_supplicant_event()
1598 * @ifname: interface name, e.g., wlan0
1599 * @global_priv: private driver global data from global_init()
1600 * Returns: Pointer to private data, %NULL on failure
1601 *
1602 * This function can be used instead of init() if the driver wrapper
1603 * uses global data.
1604 */
1605 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
4b4a8ae5
JM
1606
1607 /**
1608 * get_interfaces - Get information about available interfaces
1609 * @global_priv: private driver global data from global_init()
1610 * Returns: Allocated buffer of interface information (caller is
1611 * responsible for freeing the data structure) on success, NULL on
1612 * failure
1613 */
1614 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
fc2b7ed5
JM
1615
1616 /**
1617 * scan2 - Request the driver to initiate scan
1618 * @priv: private driver interface data
1619 * @params: Scan parameters
1620 *
1621 * Returns: 0 on success, -1 on failure
1622 *
1623 * Once the scan results are ready, the driver should report scan
1624 * results event for wpa_supplicant which will eventually request the
1625 * results with wpa_driver_get_scan_results2().
1626 */
1627 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
c2a04078
JM
1628
1629 /**
1630 * authenticate - Request driver to authenticate
1631 * @priv: private driver interface data
1632 * @params: authentication parameters
1633 * Returns: 0 on success, -1 on failure
1634 *
1635 * This is an optional function that can be used with drivers that
1636 * support separate authentication and association steps, i.e., when
1637 * wpa_supplicant can act as the SME. If not implemented, associate()
1638 * function is expected to take care of IEEE 802.11 authentication,
1639 * too.
1640 */
d2440ba0
JM
1641 int (*authenticate)(void *priv,
1642 struct wpa_driver_auth_params *params);
1643
15333707 1644 /**
19c3b566 1645 * set_ap - Set Beacon and Probe Response information for AP mode
15333707 1646 * @priv: Private driver interface data
19c3b566 1647 * @params: Parameters to use in AP mode
15333707 1648 *
19c3b566
JM
1649 * This function is used to configure Beacon template and/or extra IEs
1650 * to add for Beacon and Probe Response frames for the driver in
15333707
JM
1651 * AP mode. The driver is responsible for building the full Beacon
1652 * frame by concatenating the head part with TIM IE generated by the
19c3b566
JM
1653 * driver/firmware and finishing with the tail part. Depending on the
1654 * driver architectue, this can be done either by using the full
1655 * template or the set of additional IEs (e.g., WPS and P2P IE).
1656 * Similarly, Probe Response processing depends on the driver design.
1657 * If the driver (or firmware) takes care of replying to Probe Request
1658 * frames, the extra IEs provided here needs to be added to the Probe
1659 * Response frames.
1660 *
1661 * Returns: 0 on success, -1 on failure
15333707 1662 */
19c3b566 1663 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);
c5121837 1664
3c4ca363
VN
1665 /**
1666 * set_acl - Set ACL in AP mode
1667 * @priv: Private driver interface data
1668 * @params: Parameters to configure ACL
1669 * Returns: 0 on success, -1 on failure
1670 *
1671 * This is used only for the drivers which support MAC address ACL.
1672 */
1673 int (*set_acl)(void *priv, struct hostapd_acl_params *params);
1674
15333707
JM
1675 /**
1676 * hapd_init - Initialize driver interface (hostapd only)
1677 * @hapd: Pointer to hostapd context
1678 * @params: Configuration for the driver wrapper
1679 * Returns: Pointer to private data, %NULL on failure
1680 *
1681 * This function is used instead of init() or init2() when the driver
ffbf1eaa 1682 * wrapper is used with hostapd.
15333707 1683 */
92f475b4
JM
1684 void * (*hapd_init)(struct hostapd_data *hapd,
1685 struct wpa_init_params *params);
15333707
JM
1686
1687 /**
1688 * hapd_deinit - Deinitialize driver interface (hostapd only)
1689 * @priv: Private driver interface data from hapd_init()
1690 */
c5121837
JM
1691 void (*hapd_deinit)(void *priv);
1692
1693 /**
15333707 1694 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
15333707 1695 * @priv: Private driver interface data
e3bd3912 1696 * @params: BSS parameters
c5121837
JM
1697 * Returns: 0 on success, -1 on failure
1698 *
15333707 1699 * This is an optional function to configure the kernel driver to
e3bd3912
JM
1700 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1701 * can be left undefined (set to %NULL) if IEEE 802.1X support is
dcd1eb5b 1702 * always enabled and the driver uses set_ap() to set WPA/RSN IE
e3bd3912 1703 * for Beacon frames.
062390ef
JM
1704 *
1705 * DEPRECATED - use set_ap() instead
c5121837 1706 */
e3bd3912 1707 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);
c5121837
JM
1708
1709 /**
15333707
JM
1710 * set_privacy - Enable/disable privacy (AP only)
1711 * @priv: Private driver interface data
c5121837 1712 * @enabled: 1 = privacy enabled, 0 = disabled
15333707 1713 * Returns: 0 on success, -1 on failure
c5121837 1714 *
15333707
JM
1715 * This is an optional function to configure privacy field in the
1716 * kernel driver for Beacon frames. This can be left undefined (set to
dcd1eb5b 1717 * %NULL) if the driver uses the Beacon template from set_ap().
062390ef
JM
1718 *
1719 * DEPRECATED - use set_ap() instead
c5121837 1720 */
d5dd016a 1721 int (*set_privacy)(void *priv, int enabled);
c5121837 1722
15333707
JM
1723 /**
1724 * get_seqnum - Fetch the current TSC/packet number (AP only)
1725 * @ifname: The interface name (main or virtual)
1726 * @priv: Private driver interface data
1727 * @addr: MAC address of the station or %NULL for group keys
1728 * @idx: Key index
1729 * @seq: Buffer for returning the latest used TSC/packet number
1730 * Returns: 0 on success, -1 on failure
1731 *
1732 * This function is used to fetch the last used TSC/packet number for
eb7719ff
JM
1733 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
1734 * keys, so there is no strict requirement on implementing support for
1735 * unicast keys (i.e., addr != %NULL).
15333707 1736 */
c5121837
JM
1737 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1738 int idx, u8 *seq);
15333707 1739
15333707
JM
1740 /**
1741 * flush - Flush all association stations (AP only)
1742 * @priv: Private driver interface data
1743 * Returns: 0 on success, -1 on failure
1744 *
1745 * This function requests the driver to disassociate all associated
1746 * stations. This function does not need to be implemented if the
1747 * driver does not process association frames internally.
1748 */
c5121837 1749 int (*flush)(void *priv);
15333707
JM
1750
1751 /**
1752 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
15333707
JM
1753 * @priv: Private driver interface data
1754 * @elem: Information elements
1755 * @elem_len: Length of the elem buffer in octets
1756 * Returns: 0 on success, -1 on failure
1757 *
1758 * This is an optional function to add information elements in the
1759 * kernel driver for Beacon and Probe Response frames. This can be left
1760 * undefined (set to %NULL) if the driver uses the Beacon template from
dcd1eb5b 1761 * set_ap().
062390ef
JM
1762 *
1763 * DEPRECATED - use set_ap() instead
15333707 1764 */
aa484516 1765 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);
c5121837 1766
15333707 1767 /**
d732463c 1768 * read_sta_data - Fetch station data
15333707
JM
1769 * @priv: Private driver interface data
1770 * @data: Buffer for returning station information
1771 * @addr: MAC address of the station
1772 * Returns: 0 on success, -1 on failure
1773 */
c5121837
JM
1774 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1775 const u8 *addr);
15333707
JM
1776
1777 /**
1778 * hapd_send_eapol - Send an EAPOL packet (AP only)
1779 * @priv: private driver interface data
1780 * @addr: Destination MAC address
1781 * @data: EAPOL packet starting with IEEE 802.1X header
1782 * @data_len: Length of the EAPOL packet in octets
1783 * @encrypt: Whether the frame should be encrypted
1784 * @own_addr: Source MAC address
4378fc14 1785 * @flags: WPA_STA_* flags for the destination station
15333707
JM
1786 *
1787 * Returns: 0 on success, -1 on failure
1788 */
c5121837
JM
1789 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1790 size_t data_len, int encrypt,
4378fc14 1791 const u8 *own_addr, u32 flags);
15333707 1792
90b8c4c5
JM
1793 /**
1794 * sta_deauth - Deauthenticate a station (AP only)
1795 * @priv: Private driver interface data
1796 * @own_addr: Source address and BSSID for the Deauthentication frame
1797 * @addr: MAC address of the station to deauthenticate
1798 * @reason: Reason code for the Deauthentiation frame
1799 * Returns: 0 on success, -1 on failure
1800 *
1801 * This function requests a specific station to be deauthenticated and
1802 * a Deauthentication frame to be sent to it.
1803 */
731723a5
JM
1804 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1805 int reason);
90b8c4c5
JM
1806
1807 /**
1808 * sta_disassoc - Disassociate a station (AP only)
1809 * @priv: Private driver interface data
1810 * @own_addr: Source address and BSSID for the Disassociation frame
1811 * @addr: MAC address of the station to disassociate
1812 * @reason: Reason code for the Disassociation frame
1813 * Returns: 0 on success, -1 on failure
1814 *
1815 * This function requests a specific station to be disassociated and
1816 * a Disassociation frame to be sent to it.
1817 */
731723a5
JM
1818 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1819 int reason);
90b8c4c5
JM
1820
1821 /**
1822 * sta_remove - Remove a station entry (AP only)
1823 * @priv: Private driver interface data
1824 * @addr: MAC address of the station to be removed
1825 * Returns: 0 on success, -1 on failure
1826 */
c5121837 1827 int (*sta_remove)(void *priv, const u8 *addr);
90b8c4c5
JM
1828
1829 /**
1830 * hapd_get_ssid - Get the current SSID (AP only)
90b8c4c5
JM
1831 * @priv: Private driver interface data
1832 * @buf: Buffer for returning the SSID
1833 * @len: Maximum length of the buffer
1834 * Returns: Length of the SSID on success, -1 on failure
1835 *
1836 * This function need not be implemented if the driver uses Beacon
dcd1eb5b 1837 * template from set_ap() and does not reply to Probe Request frames.
90b8c4c5 1838 */
8709de1a 1839 int (*hapd_get_ssid)(void *priv, u8 *buf, int len);
90b8c4c5
JM
1840
1841 /**
1842 * hapd_set_ssid - Set SSID (AP only)
90b8c4c5
JM
1843 * @priv: Private driver interface data
1844 * @buf: SSID
1845 * @len: Length of the SSID in octets
1846 * Returns: 0 on success, -1 on failure
062390ef
JM
1847 *
1848 * DEPRECATED - use set_ap() instead
90b8c4c5 1849 */
8709de1a
JM
1850 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);
1851
90b8c4c5
JM
1852 /**
1853 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1854 * @priv: Private driver interface data
1855 * @enabled: 1 = countermeasures enabled, 0 = disabled
1856 * Returns: 0 on success, -1 on failure
1857 *
1858 * This need not be implemented if the driver does not take care of
1859 * association processing.
1860 */
c5121837 1861 int (*hapd_set_countermeasures)(void *priv, int enabled);
90b8c4c5
JM
1862
1863 /**
1864 * sta_add - Add a station entry
90b8c4c5
JM
1865 * @priv: Private driver interface data
1866 * @params: Station parameters
1867 * Returns: 0 on success, -1 on failure
1868 *
1869 * This function is used to add a station entry to the driver once the
1870 * station has completed association. This is only used if the driver
1871 * does not take care of association processing.
45b722f1
AN
1872 *
1873 * With TDLS, this function is also used to add or set (params->set 1)
1874 * TDLS peer entries.
90b8c4c5 1875 */
62847751 1876 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);
90b8c4c5
JM
1877
1878 /**
1879 * get_inact_sec - Get station inactivity duration (AP only)
1880 * @priv: Private driver interface data
1881 * @addr: Station address
1882 * Returns: Number of seconds station has been inactive, -1 on failure
1883 */
c5121837 1884 int (*get_inact_sec)(void *priv, const u8 *addr);
90b8c4c5
JM
1885
1886 /**
1887 * sta_clear_stats - Clear station statistics (AP only)
1888 * @priv: Private driver interface data
1889 * @addr: Station address
1890 * Returns: 0 on success, -1 on failure
1891 */
c5121837
JM
1892 int (*sta_clear_stats)(void *priv, const u8 *addr);
1893
90b8c4c5
JM
1894 /**
1895 * set_freq - Set channel/frequency (AP only)
1896 * @priv: Private driver interface data
1897 * @freq: Channel parameters
1898 * Returns: 0 on success, -1 on failure
1899 */
c5121837 1900 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
90b8c4c5
JM
1901
1902 /**
1903 * set_rts - Set RTS threshold
1904 * @priv: Private driver interface data
1905 * @rts: RTS threshold in octets
1906 * Returns: 0 on success, -1 on failure
1907 */
c5121837 1908 int (*set_rts)(void *priv, int rts);
90b8c4c5
JM
1909
1910 /**
1911 * set_frag - Set fragmentation threshold
1912 * @priv: Private driver interface data
1913 * @frag: Fragmentation threshold in octets
1914 * Returns: 0 on success, -1 on failure
1915 */
c5121837 1916 int (*set_frag)(void *priv, int frag);
c5121837 1917
90b8c4c5
JM
1918 /**
1919 * sta_set_flags - Set station flags (AP only)
1920 * @priv: Private driver interface data
1921 * @addr: Station address
0de39516
JM
1922 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1923 * @flags_or: Bitmap of WPA_STA_* flags to add
1924 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
90b8c4c5
JM
1925 * Returns: 0 on success, -1 on failure
1926 */
3234cba4 1927 int (*sta_set_flags)(void *priv, const u8 *addr,
c5121837 1928 int total_flags, int flags_or, int flags_and);
90b8c4c5 1929
90b8c4c5
JM
1930 /**
1931 * set_tx_queue_params - Set TX queue parameters
1932 * @priv: Private driver interface data
7e3c1781 1933 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
90b8c4c5
JM
1934 * @aifs: AIFS
1935 * @cw_min: cwMin
1936 * @cw_max: cwMax
1937 * @burst_time: Maximum length for bursting in 0.1 msec units
1938 */
c5121837
JM
1939 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1940 int cw_max, int burst_time);
90b8c4c5 1941
22a7c9d7
JM
1942 /**
1943 * if_add - Add a virtual interface
15333707 1944 * @priv: Private driver interface data
22a7c9d7
JM
1945 * @type: Interface type
1946 * @ifname: Interface name for the new virtual interface
1947 * @addr: Local address to use for the interface or %NULL to use the
1948 * parent interface address
8043e725 1949 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
a2e40bb6
FF
1950 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1951 * not allowed (applies only to %WPA_IF_AP_BSS type)
f3585c8a
JM
1952 * @force_ifname: Buffer for returning an interface name that the
1953 * driver ended up using if it differs from the requested ifname
1954 * @if_addr: Buffer for returning the allocated interface address
1955 * (this may differ from the requested addr if the driver cannot
1956 * change interface address)
e17a2477 1957 * @bridge: Bridge interface to use or %NULL if no bridge configured
2aec4f3c 1958 * @use_existing: Whether to allow existing interface to be used
22a7c9d7
JM
1959 * Returns: 0 on success, -1 on failure
1960 */
7ab68865
JM
1961 int (*if_add)(void *priv, enum wpa_driver_if_type type,
1962 const char *ifname, const u8 *addr, void *bss_ctx,
e17a2477 1963 void **drv_priv, char *force_ifname, u8 *if_addr,
2aec4f3c 1964 const char *bridge, int use_existing);
22a7c9d7
JM
1965
1966 /**
1967 * if_remove - Remove a virtual interface
1968 * @priv: Private driver interface data
1969 * @type: Interface type
1970 * @ifname: Interface name of the virtual interface to be removed
1971 * Returns: 0 on success, -1 on failure
1972 */
1973 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1974 const char *ifname);
90b8c4c5 1975
15333707
JM
1976 /**
1977 * set_sta_vlan - Bind a station into a specific interface (AP only)
1978 * @priv: Private driver interface data
1979 * @ifname: Interface (main or virtual BSS or VLAN)
1980 * @addr: MAC address of the associated station
1981 * @vlan_id: VLAN ID
1982 * Returns: 0 on success, -1 on failure
1983 *
1984 * This function is used to bind a station to a specific virtual
1985 * interface. It is only used if when virtual interfaces are supported,
1986 * e.g., to assign stations to different VLAN interfaces based on
1987 * information from a RADIUS server. This allows separate broadcast
1988 * domains to be used with a single BSS.
1989 */
c5121837
JM
1990 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1991 int vlan_id);
15333707 1992
c5121837 1993 /**
15333707 1994 * commit - Optional commit changes handler (AP only)
c5121837
JM
1995 * @priv: driver private data
1996 * Returns: 0 on success, -1 on failure
1997 *
1998 * This optional handler function can be registered if the driver
1999 * interface implementation needs to commit changes (e.g., by setting
2000 * network interface up) at the end of initial configuration. If set,
2001 * this handler will be called after initial setup has been completed.
2002 */
2003 int (*commit)(void *priv);
2004
90b8c4c5
JM
2005 /**
2006 * send_ether - Send an ethernet packet (AP only)
2007 * @priv: private driver interface data
2008 * @dst: Destination MAC address
2009 * @src: Source MAC address
2010 * @proto: Ethertype
2011 * @data: EAPOL packet starting with IEEE 802.1X header
2012 * @data_len: Length of the EAPOL packet in octets
2013 * Returns: 0 on success, -1 on failure
2014 */
c5121837
JM
2015 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
2016 const u8 *data, size_t data_len);
2017
90b8c4c5
JM
2018 /**
2019 * set_radius_acl_auth - Notification of RADIUS ACL change
2020 * @priv: Private driver interface data
2021 * @mac: MAC address of the station
2022 * @accepted: Whether the station was accepted
2023 * @session_timeout: Session timeout for the station
2024 * Returns: 0 on success, -1 on failure
2025 */
c5121837
JM
2026 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
2027 u32 session_timeout);
90b8c4c5
JM
2028
2029 /**
2030 * set_radius_acl_expire - Notification of RADIUS ACL expiration
2031 * @priv: Private driver interface data
2032 * @mac: MAC address of the station
2033 * Returns: 0 on success, -1 on failure
2034 */
c5121837
JM
2035 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
2036
15333707 2037 /**
b3db190f 2038 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
15333707 2039 * @priv: Private driver interface data
b3db190f
JM
2040 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
2041 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
2042 * extra IE(s)
0e2e565a
JM
2043 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
2044 * to remove extra IE(s)
15333707
JM
2045 * Returns: 0 on success, -1 on failure
2046 *
2047 * This is an optional function to add WPS IE in the kernel driver for
14f79386 2048 * Beacon and Probe Response frames. This can be left undefined (set
dcd1eb5b 2049 * to %NULL) if the driver uses the Beacon template from set_ap()
0e2e565a
JM
2050 * and does not process Probe Request frames. If the driver takes care
2051 * of (Re)Association frame processing, the assocresp buffer includes
2052 * WPS IE(s) that need to be added to (Re)Association Response frames
2053 * whenever a (Re)Association Request frame indicated use of WPS.
75bde05d
JM
2054 *
2055 * This will also be used to add P2P IE(s) into Beacon/Probe Response
2056 * frames when operating as a GO. The driver is responsible for adding
2057 * timing related attributes (e.g., NoA) in addition to the IEs
2058 * included here by appending them after these buffers. This call is
2059 * also used to provide Probe Response IEs for P2P Listen state
2060 * operations for drivers that generate the Probe Response frames
2061 * internally.
062390ef
JM
2062 *
2063 * DEPRECATED - use set_ap() instead
15333707 2064 */
0ebdf627 2065 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
0e2e565a
JM
2066 const struct wpabuf *proberesp,
2067 const struct wpabuf *assocresp);
4bc181ec
JM
2068
2069 /**
2070 * set_supp_port - Set IEEE 802.1X Supplicant Port status
2071 * @priv: Private driver interface data
2072 * @authorized: Whether the port is authorized
2073 * Returns: 0 on success, -1 on failure
2074 */
2075 int (*set_supp_port)(void *priv, int authorized);
fbbfcbac
FF
2076
2077 /**
2078 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
2079 * @priv: Private driver interface data
2080 * @addr: MAC address of the associated station
2081 * @aid: Association ID
2082 * @val: 1 = bind to 4-address WDS; 0 = unbind
d38ae2ea
FF
2083 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
2084 * to indicate that bridge is not to be used
69dd2967
SM
2085 * @ifname_wds: Buffer to return the interface name for the new WDS
2086 * station or %NULL to indicate name is not returned.
fbbfcbac
FF
2087 * Returns: 0 on success, -1 on failure
2088 */
d38ae2ea 2089 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
69dd2967 2090 const char *bridge_ifname, char *ifname_wds);
504e905c 2091
55777702
JM
2092 /**
2093 * send_action - Transmit an Action frame
2094 * @priv: Private driver interface data
2095 * @freq: Frequency (in MHz) of the channel
190b9062 2096 * @wait: Time to wait off-channel for a response (in ms), or zero
e8828999
JM
2097 * @dst: Destination MAC address (Address 1)
2098 * @src: Source MAC address (Address 2)
2099 * @bssid: BSSID (Address 3)
55777702
JM
2100 * @data: Frame body
2101 * @data_len: data length in octets
b106173a 2102 @ @no_cck: Whether CCK rates must not be used to transmit this frame
55777702
JM
2103 * Returns: 0 on success, -1 on failure
2104 *
2105 * This command can be used to request the driver to transmit an action
190b9062
JB
2106 * frame to the specified destination.
2107 *
2108 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
2109 * be transmitted on the given channel and the device will wait for a
2110 * response on that channel for the given wait time.
2111 *
2112 * If the flag is not set, the wait time will be ignored. In this case,
2113 * if a remain-on-channel duration is in progress, the frame must be
2114 * transmitted on that channel; alternatively the frame may be sent on
2115 * the current operational channel (if in associated state in station
2116 * mode or while operating as an AP.)
55777702 2117 */
190b9062 2118 int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
e8828999 2119 const u8 *dst, const u8 *src, const u8 *bssid,
b106173a 2120 const u8 *data, size_t data_len, int no_cck);
55777702 2121
190b9062
JB
2122 /**
2123 * send_action_cancel_wait - Cancel action frame TX wait
2124 * @priv: Private driver interface data
2125 *
2126 * This command cancels the wait time associated with sending an action
2127 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
2128 * set in the driver flags.
2129 */
2130 void (*send_action_cancel_wait)(void *priv);
2131
55777702
JM
2132 /**
2133 * remain_on_channel - Remain awake on a channel
2134 * @priv: Private driver interface data
2135 * @freq: Frequency (in MHz) of the channel
2136 * @duration: Duration in milliseconds
2137 * Returns: 0 on success, -1 on failure
2138 *
2139 * This command is used to request the driver to remain awake on the
2140 * specified channel for the specified duration and report received
2141 * Action frames with EVENT_RX_ACTION events. Optionally, received
2142 * Probe Request frames may also be requested to be reported by calling
2143 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
2144 *
2145 * The driver may not be at the requested channel when this function
2146 * returns, i.e., the return code is only indicating whether the
2147 * request was accepted. The caller will need to wait until the
2148 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
2149 * completed the channel change. This may take some time due to other
2150 * need for the radio and the caller should be prepared to timing out
2151 * its wait since there are no guarantees on when this request can be
2152 * executed.
2153 */
2154 int (*remain_on_channel)(void *priv, unsigned int freq,
2155 unsigned int duration);
2156
2157 /**
2158 * cancel_remain_on_channel - Cancel remain-on-channel operation
2159 * @priv: Private driver interface data
2160 *
2161 * This command can be used to cancel a remain-on-channel operation
2162 * before its originally requested duration has passed. This could be
2163 * used, e.g., when remain_on_channel() is used to request extra time
2164 * to receive a response to an Action frame and the response is
2165 * received when there is still unneeded time remaining on the
2166 * remain-on-channel operation.
2167 */
2168 int (*cancel_remain_on_channel)(void *priv);
2169
504e905c
JM
2170 /**
2171 * probe_req_report - Request Probe Request frames to be indicated
2172 * @priv: Private driver interface data
2173 * @report: Whether to report received Probe Request frames
2174 * Returns: 0 on success, -1 on failure (or if not supported)
2175 *
2176 * This command can be used to request the driver to indicate when
2177 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
2178 * Since this operation may require extra resources, e.g., due to less
2179 * optimal hardware/firmware RX filtering, many drivers may disable
2180 * Probe Request reporting at least in station mode. This command is
2181 * used to notify the driver when the Probe Request frames need to be
2182 * reported, e.g., during remain-on-channel operations.
2183 */
2184 int (*probe_req_report)(void *priv, int report);
4e5cb1a3 2185
af473088
JM
2186 /**
2187 * deinit_ap - Deinitialize AP mode
2188 * @priv: Private driver interface data
2189 * Returns: 0 on success, -1 on failure (or if not supported)
2190 *
2191 * This optional function can be used to disable AP mode related
60b13c20
IP
2192 * configuration. If the interface was not dynamically added,
2193 * change the driver mode to station mode to allow normal station
2194 * operations like scanning to be completed.
af473088
JM
2195 */
2196 int (*deinit_ap)(void *priv);
207ef3fb 2197
3c29244e
EP
2198 /**
2199 * deinit_p2p_cli - Deinitialize P2P client mode
2200 * @priv: Private driver interface data
2201 * Returns: 0 on success, -1 on failure (or if not supported)
2202 *
60b13c20
IP
2203 * This optional function can be used to disable P2P client mode. If the
2204 * interface was not dynamically added, change the interface type back
2205 * to station mode.
3c29244e
EP
2206 */
2207 int (*deinit_p2p_cli)(void *priv);
2208
207ef3fb
JM
2209 /**
2210 * suspend - Notification on system suspend/hibernate event
2211 * @priv: Private driver interface data
2212 */
2213 void (*suspend)(void *priv);
2214
2215 /**
2216 * resume - Notification on system resume/thaw event
2217 * @priv: Private driver interface data
2218 */
2219 void (*resume)(void *priv);
b625473c
JM
2220
2221 /**
2222 * signal_monitor - Set signal monitoring parameters
2223 * @priv: Private driver interface data
2224 * @threshold: Threshold value for signal change events; 0 = disabled
2225 * @hysteresis: Minimum change in signal strength before indicating a
2226 * new event
2227 * Returns: 0 on success, -1 on failure (or if not supported)
2228 *
2229 * This function can be used to configure monitoring of signal strength
2230 * with the current AP. Whenever signal strength drops below the
2231 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
2232 * should be generated assuming the signal strength has changed at
2233 * least %hysteresis from the previously indicated signal change event.
2234 */
2235 int (*signal_monitor)(void *priv, int threshold, int hysteresis);
b91ab76e
JM
2236
2237 /**
2238 * send_frame - Send IEEE 802.11 frame (testing use only)
2239 * @priv: Private driver interface data
2240 * @data: IEEE 802.11 frame with IEEE 802.11 header
2241 * @data_len: Size of the frame
2242 * @encrypt: Whether to encrypt the frame (if keys are set)
2243 * Returns: 0 on success, -1 on failure
2244 *
2245 * This function is only used for debugging purposes and is not
2246 * required to be implemented for normal operations.
2247 */
2248 int (*send_frame)(void *priv, const u8 *data, size_t data_len,
2249 int encrypt);
75bde05d
JM
2250
2251 /**
2252 * shared_freq - Get operating frequency of shared interface(s)
2253 * @priv: Private driver interface data
2254 * Returns: Operating frequency in MHz, 0 if no shared operation in
2255 * use, or -1 on failure
2256 *
2257 * This command can be used to request the current operating frequency
2258 * of any virtual interface that shares the same radio to provide
2259 * information for channel selection for other virtual interfaces.
2260 */
2261 int (*shared_freq)(void *priv);
2262
2263 /**
2264 * get_noa - Get current Notice of Absence attribute payload
2265 * @priv: Private driver interface data
2266 * @buf: Buffer for returning NoA
2267 * @buf_len: Buffer length in octets
2268 * Returns: Number of octets used in buf, 0 to indicate no NoA is being
2269 * advertized, or -1 on failure
2270 *
2271 * This function is used to fetch the current Notice of Absence
2272 * attribute value from GO.
2273 */
2274 int (*get_noa)(void *priv, u8 *buf, size_t buf_len);
2275
2276 /**
2277 * set_noa - Set Notice of Absence parameters for GO (testing)
2278 * @priv: Private driver interface data
2279 * @count: Count
2280 * @start: Start time in ms from next TBTT
2281 * @duration: Duration in ms
2282 * Returns: 0 on success or -1 on failure
2283 *
2284 * This function is used to set Notice of Absence parameters for GO. It
2285 * is used only for testing. To disable NoA, all parameters are set to
2286 * 0.
2287 */
2288 int (*set_noa)(void *priv, u8 count, int start, int duration);
c381508d
JM
2289
2290 /**
2291 * set_p2p_powersave - Set P2P power save options
2292 * @priv: Private driver interface data
2293 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
2294 * @opp_ps: 0 = disable, 1 = enable, -1 = no change
2295 * @ctwindow: 0.. = change (msec), -1 = no change
2296 * Returns: 0 on success or -1 on failure
2297 */
2298 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
2299 int ctwindow);
b6c79a99
JM
2300
2301 /**
2302 * ampdu - Enable/disable aggregation
2303 * @priv: Private driver interface data
2304 * @ampdu: 1/0 = enable/disable A-MPDU aggregation
2305 * Returns: 0 on success or -1 on failure
2306 */
2307 int (*ampdu)(void *priv, int ampdu);
0f66abd2 2308
6859f1cb
BG
2309 /**
2310 * get_radio_name - Get physical radio name for the device
2311 * @priv: Private driver interface data
2312 * Returns: Radio name or %NULL if not known
2313 *
2314 * The returned data must not be modified by the caller. It is assumed
2315 * that any interface that has the same radio name as another is
2316 * sharing the same physical radio. This information can be used to
2317 * share scan results etc. information between the virtual interfaces
2318 * to speed up various operations.
2319 */
2320 const char * (*get_radio_name)(void *priv);
3ac17eba
JM
2321
2322 /**
2323 * p2p_find - Start P2P Device Discovery
2324 * @priv: Private driver interface data
2325 * @timeout: Timeout for find operation in seconds or 0 for no timeout
2326 * @type: Device Discovery type (enum p2p_discovery_type)
2327 * Returns: 0 on success, -1 on failure
2328 *
2329 * This function is only used if the driver implements P2P management,
2330 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2331 * struct wpa_driver_capa.
2332 */
2333 int (*p2p_find)(void *priv, unsigned int timeout, int type);
2334
2335 /**
2336 * p2p_stop_find - Stop P2P Device Discovery
2337 * @priv: Private driver interface data
2338 * Returns: 0 on success, -1 on failure
2339 *
2340 * This function is only used if the driver implements P2P management,
2341 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2342 * struct wpa_driver_capa.
2343 */
2344 int (*p2p_stop_find)(void *priv);
2345
2346 /**
2347 * p2p_listen - Start P2P Listen state for specified duration
2348 * @priv: Private driver interface data
2349 * @timeout: Listen state duration in milliseconds
2350 * Returns: 0 on success, -1 on failure
2351 *
2352 * This function can be used to request the P2P module to keep the
2353 * device discoverable on the listen channel for an extended set of
2354 * time. At least in its current form, this is mainly used for testing
2355 * purposes and may not be of much use for normal P2P operations.
2356 *
2357 * This function is only used if the driver implements P2P management,
2358 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2359 * struct wpa_driver_capa.
2360 */
2361 int (*p2p_listen)(void *priv, unsigned int timeout);
2362
2363 /**
2364 * p2p_connect - Start P2P group formation (GO negotiation)
2365 * @priv: Private driver interface data
2366 * @peer_addr: MAC address of the peer P2P client
2367 * @wps_method: enum p2p_wps_method value indicating config method
2368 * @go_intent: Local GO intent value (1..15)
2369 * @own_interface_addr: Intended interface address to use with the
2370 * group
2371 * @force_freq: The only allowed channel frequency in MHz or 0
2372 * @persistent_group: Whether to create persistent group
2373 * Returns: 0 on success, -1 on failure
2374 *
2375 * This function is only used if the driver implements P2P management,
2376 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2377 * struct wpa_driver_capa.
2378 */
2379 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method,
2380 int go_intent, const u8 *own_interface_addr,
2381 unsigned int force_freq, int persistent_group);
2382
2383 /**
2384 * wps_success_cb - Report successfully completed WPS provisioning
2385 * @priv: Private driver interface data
2386 * @peer_addr: Peer address
2387 * Returns: 0 on success, -1 on failure
2388 *
2389 * This function is used to report successfully completed WPS
2390 * provisioning during group formation in both GO/Registrar and
2391 * client/Enrollee roles.
2392 *
2393 * This function is only used if the driver implements P2P management,
2394 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2395 * struct wpa_driver_capa.
2396 */
2397 int (*wps_success_cb)(void *priv, const u8 *peer_addr);
2398
2399 /**
2400 * p2p_group_formation_failed - Report failed WPS provisioning
2401 * @priv: Private driver interface data
2402 * Returns: 0 on success, -1 on failure
2403 *
2404 * This function is used to report failed group formation. This can
2405 * happen either due to failed WPS provisioning or due to 15 second
2406 * timeout during the provisioning phase.
2407 *
2408 * This function is only used if the driver implements P2P management,
2409 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2410 * struct wpa_driver_capa.
2411 */
2412 int (*p2p_group_formation_failed)(void *priv);
2413
2414 /**
2415 * p2p_set_params - Set P2P parameters
2416 * @priv: Private driver interface data
2417 * @params: P2P parameters
2418 * Returns: 0 on success, -1 on failure
2419 *
2420 * This function is only used if the driver implements P2P management,
2421 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2422 * struct wpa_driver_capa.
2423 */
2424 int (*p2p_set_params)(void *priv, const struct p2p_params *params);
2425
2426 /**
2427 * p2p_prov_disc_req - Send Provision Discovery Request
2428 * @priv: Private driver interface data
2429 * @peer_addr: MAC address of the peer P2P client
2430 * @config_methods: WPS Config Methods value (only one bit set)
2431 * Returns: 0 on success, -1 on failure
2432 *
2433 * This function can be used to request a discovered P2P peer to
2434 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared
2435 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The
2436 * Provision Discovery Request frame is transmitted once immediately
2437 * and if no response is received, the frame will be sent again
2438 * whenever the target device is discovered during device dsicovery
2439 * (start with a p2p_find() call). Response from the peer is indicated
2440 * with the EVENT_P2P_PROV_DISC_RESPONSE event.
2441 *
2442 * This function is only used if the driver implements P2P management,
2443 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2444 * struct wpa_driver_capa.
2445 */
2446 int (*p2p_prov_disc_req)(void *priv, const u8 *peer_addr,
8c5f7309 2447 u16 config_methods, int join);
3ac17eba
JM
2448
2449 /**
2450 * p2p_sd_request - Schedule a service discovery query
2451 * @priv: Private driver interface data
2452 * @dst: Destination peer or %NULL to apply for all peers
2453 * @tlvs: P2P Service Query TLV(s)
2454 * Returns: Reference to the query or 0 on failure
2455 *
2456 * Response to the query is indicated with the
2457 * EVENT_P2P_SD_RESPONSE driver event.
2458 *
2459 * This function is only used if the driver implements P2P management,
2460 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2461 * struct wpa_driver_capa.
2462 */
2463 u64 (*p2p_sd_request)(void *priv, const u8 *dst,
2464 const struct wpabuf *tlvs);
2465
2466 /**
2467 * p2p_sd_cancel_request - Cancel a pending service discovery query
2468 * @priv: Private driver interface data
2469 * @req: Query reference from p2p_sd_request()
2470 * Returns: 0 on success, -1 on failure
2471 *
2472 * This function is only used if the driver implements P2P management,
2473 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2474 * struct wpa_driver_capa.
2475 */
2476 int (*p2p_sd_cancel_request)(void *priv, u64 req);
2477
2478 /**
2479 * p2p_sd_response - Send response to a service discovery query
2480 * @priv: Private driver interface data
2481 * @freq: Frequency from EVENT_P2P_SD_REQUEST event
2482 * @dst: Destination address from EVENT_P2P_SD_REQUEST event
2483 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event
2484 * @resp_tlvs: P2P Service Response TLV(s)
2485 * Returns: 0 on success, -1 on failure
2486 *
2487 * This function is called as a response to the request indicated with
2488 * the EVENT_P2P_SD_REQUEST driver event.
2489 *
2490 * This function is only used if the driver implements P2P management,
2491 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2492 * struct wpa_driver_capa.
2493 */
2494 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst,
2495 u8 dialog_token,
2496 const struct wpabuf *resp_tlvs);
2497
2498 /**
2499 * p2p_service_update - Indicate a change in local services
2500 * @priv: Private driver interface data
2501 * Returns: 0 on success, -1 on failure
2502 *
2503 * This function needs to be called whenever there is a change in
2504 * availability of the local services. This will increment the
2505 * Service Update Indicator value which will be used in SD Request and
2506 * Response frames.
2507 *
2508 * This function is only used if the driver implements P2P management,
2509 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in
2510 * struct wpa_driver_capa.
2511 */
2512 int (*p2p_service_update)(void *priv);
2513
2514 /**
2515 * p2p_reject - Reject peer device (explicitly block connections)
2516 * @priv: Private driver interface data
2517 * @addr: MAC address of the peer
2518 * Returns: 0 on success, -1 on failure
2519 */
2520 int (*p2p_reject)(void *priv, const u8 *addr);
2521
2522 /**
2523 * p2p_invite - Invite a P2P Device into a group
2524 * @priv: Private driver interface data
2525 * @peer: Device Address of the peer P2P Device
2526 * @role: Local role in the group
2527 * @bssid: Group BSSID or %NULL if not known
2528 * @ssid: Group SSID
2529 * @ssid_len: Length of ssid in octets
2530 * @go_dev_addr: Forced GO Device Address or %NULL if none
2531 * @persistent_group: Whether this is to reinvoke a persistent group
2532 * Returns: 0 on success, -1 on failure
2533 */
2534 int (*p2p_invite)(void *priv, const u8 *peer, int role,
2535 const u8 *bssid, const u8 *ssid, size_t ssid_len,
2536 const u8 *go_dev_addr, int persistent_group);
281ff0aa
GP
2537
2538 /**
2539 * send_tdls_mgmt - for sending TDLS management packets
2540 * @priv: private driver interface data
2541 * @dst: Destination (peer) MAC address
2542 * @action_code: TDLS action code for the mssage
2543 * @dialog_token: Dialog Token to use in the message (if needed)
2544 * @status_code: Status Code or Reason Code to use (if needed)
2545 * @buf: TDLS IEs to add to the message
2546 * @len: Length of buf in octets
45b722f1 2547 * Returns: 0 on success, negative (<0) on failure
281ff0aa
GP
2548 *
2549 * This optional function can be used to send packet to driver which is
2550 * responsible for receiving and sending all TDLS packets.
2551 */
2552 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
2553 u8 dialog_token, u16 status_code,
2554 const u8 *buf, size_t len);
2555
45b722f1
AN
2556 /**
2557 * tdls_oper - Ask the driver to perform high-level TDLS operations
2558 * @priv: Private driver interface data
2559 * @oper: TDLS high-level operation. See %enum tdls_oper
2560 * @peer: Destination (peer) MAC address
2561 * Returns: 0 on success, negative (<0) on failure
2562 *
2563 * This optional function can be used to send high-level TDLS commands
2564 * to the driver.
2565 */
281ff0aa 2566 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);
1c5c7273 2567
a884be9d
XC
2568 /**
2569 * wnm_oper - Notify driver of the WNM frame reception
2570 * @priv: Private driver interface data
2571 * @oper: WNM operation. See %enum wnm_oper
2572 * @peer: Destination (peer) MAC address
2573 * @buf: Buffer for the driver to fill in (for getting IE)
2574 * @buf_len: Return the len of buf
2575 * Returns: 0 on success, negative (<0) on failure
2576 */
2577 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
2578 u8 *buf, u16 *buf_len);
2579
c551700f
KP
2580 /**
2581 * set_qos_map - Set QoS Map
2582 * @priv: Private driver interface data
2583 * @qos_map_set: QoS Map
2584 * @qos_map_set_len: Length of QoS Map
2585 */
2586 int (*set_qos_map)(void *priv, const u8 *qos_map_set,
2587 u8 qos_map_set_len);
2588
1c5c7273
PS
2589 /**
2590 * signal_poll - Get current connection information
2591 * @priv: Private driver interface data
2592 * @signal_info: Connection info structure
2593 */
2594 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);
41fd1d9e
KZ
2595
2596 /**
2597 * set_authmode - Set authentication algorithm(s) for static WEP
2598 * @priv: Private driver interface data
2599 * @authmode: 1=Open System, 2=Shared Key, 3=both
2600 * Returns: 0 on success, -1 on failure
2601 *
2602 * This function can be used to set authentication algorithms for AP
2603 * mode when static WEP is used. If the driver uses user space MLME/SME
2604 * implementation, there is no need to implement this function.
062390ef
JM
2605 *
2606 * DEPRECATED - use set_ap() instead
41fd1d9e
KZ
2607 */
2608 int (*set_authmode)(void *priv, int authmode);
b14a210c
JB
2609
2610 /**
2611 * set_rekey_info - Set rekey information
2612 * @priv: Private driver interface data
2613 * @kek: Current KEK
2614 * @kck: Current KCK
2615 * @replay_ctr: Current EAPOL-Key Replay Counter
2616 *
2617 * This optional function can be used to provide information for the
2618 * driver/firmware to process EAPOL-Key frames in Group Key Handshake
2619 * while the host (including wpa_supplicant) is sleeping.
2620 */
2621 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck,
2622 const u8 *replay_ctr);
a52eba0f
SP
2623
2624 /**
2625 * sta_assoc - Station association indication
2626 * @priv: Private driver interface data
2627 * @own_addr: Source address and BSSID for association frame
2628 * @addr: MAC address of the station to associate
2629 * @reassoc: flag to indicate re-association
2630 * @status: association response status code
2631 * @ie: assoc response ie buffer
2632 * @len: ie buffer length
2633 * Returns: 0 on success, -1 on failure
2634 *
2635 * This function indicates the driver to send (Re)Association
2636 * Response frame to the station.
2637 */
2638 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
2639 int reassoc, u16 status, const u8 *ie, size_t len);
2640
2641 /**
2642 * sta_auth - Station authentication indication
2643 * @priv: Private driver interface data
2644 * @own_addr: Source address and BSSID for authentication frame
2645 * @addr: MAC address of the station to associate
2646 * @seq: authentication sequence number
2647 * @status: authentication response status code
2648 * @ie: authentication frame ie buffer
2649 * @len: ie buffer length
2650 *
2651 * This function indicates the driver to send Authentication frame
2652 * to the station.
2653 */
2654 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr,
2655 u16 seq, u16 status, const u8 *ie, size_t len);
2656
2657 /**
2658 * add_tspec - Add traffic stream
2659 * @priv: Private driver interface data
2660 * @addr: MAC address of the station to associate
2661 * @tspec_ie: tspec ie buffer
2662 * @tspec_ielen: tspec ie length
2663 * Returns: 0 on success, -1 on failure
2664 *
2665 * This function adds the traffic steam for the station
2666 * and fills the medium_time in tspec_ie.
2667 */
2668 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie,
2669 size_t tspec_ielen);
2670
2671 /**
2672 * add_sta_node - Add a station node in the driver
2673 * @priv: Private driver interface data
2674 * @addr: MAC address of the station to add
2675 * @auth_alg: authentication algorithm used by the station
2676 * Returns: 0 on success, -1 on failure
2677 *
2678 * This function adds the station node in the driver, when
2679 * the station gets added by FT-over-DS.
2680 */
2681 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);
cbdf3507
LC
2682
2683 /**
2684 * sched_scan - Request the driver to initiate scheduled scan
2685 * @priv: Private driver interface data
2686 * @params: Scan parameters
2687 * @interval: Interval between scan cycles in milliseconds
2688 * Returns: 0 on success, -1 on failure
2689 *
2690 * This operation should be used for scheduled scan offload to
2691 * the hardware. Every time scan results are available, the
2692 * driver should report scan results event for wpa_supplicant
2693 * which will eventually request the results with
2694 * wpa_driver_get_scan_results2(). This operation is optional
2695 * and if not provided or if it returns -1, we fall back to
2696 * normal host-scheduled scans.
2697 */
2698 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params,
2699 u32 interval);
2700
2701 /**
2702 * stop_sched_scan - Request the driver to stop a scheduled scan
2703 * @priv: Private driver interface data
2704 * Returns: 0 on success, -1 on failure
2705 *
2706 * This should cause the scheduled scan to be stopped and
2707 * results should stop being sent. Must be supported if
2708 * sched_scan is supported.
2709 */
2710 int (*stop_sched_scan)(void *priv);
bcf24348
JB
2711
2712 /**
2713 * poll_client - Probe (null data or such) the given station
2714 * @priv: Private driver interface data
2715 * @own_addr: MAC address of sending interface
2716 * @addr: MAC address of the station to probe
2717 * @qos: Indicates whether station is QoS station
2718 *
2719 * This function is used to verify whether an associated station is
2720 * still present. This function does not need to be implemented if the
2721 * driver provides such inactivity polling mechanism.
2722 */
2723 void (*poll_client)(void *priv, const u8 *own_addr,
2724 const u8 *addr, int qos);
8b9d0bfa
JM
2725
2726 /**
2727 * radio_disable - Disable/enable radio
2728 * @priv: Private driver interface data
2729 * @disabled: 1=disable 0=enable radio
2730 * Returns: 0 on success, -1 on failure
2731 *
2732 * This optional command is for testing purposes. It can be used to
2733 * disable the radio on a testbed device to simulate out-of-radio-range
2734 * conditions.
2735 */
2736 int (*radio_disable)(void *priv, int disabled);
ef35f5a0
JJ
2737
2738 /**
2739 * switch_channel - Announce channel switch and migrate the GO to the
2740 * given frequency
2741 * @priv: Private driver interface data
2742 * @freq: Frequency in MHz
2743 * Returns: 0 on success, -1 on failure
2744 *
2745 * This function is used to move the GO to the legacy STA channel to
2746 * avoid frequency conflict in single channel concurrency.
2747 */
2748 int (*switch_channel)(void *priv, unsigned int freq);
f90e9c1c
SW
2749
2750 /**
2751 * start_dfs_cac - Listen for radar interference on the channel
2752 * @priv: Private driver interface data
04e8003c 2753 * @freq: Channel parameters
f90e9c1c
SW
2754 * Returns: 0 on success, -1 on failure
2755 */
04e8003c 2756 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);
695c7038
SW
2757
2758 /**
2759 * stop_ap - Removes beacon from AP
2760 * @priv: Private driver interface data
2761 * Returns: 0 on success, -1 on failure (or if not supported)
2762 *
2763 * This optional function can be used to disable AP mode related
2764 * configuration. Unlike deinit_ap, it does not change to station
2765 * mode.
2766 */
2767 int (*stop_ap)(void *priv);
0185007c
MK
2768
2769 /**
2770 * get_survey - Retrieve survey data
2771 * @priv: Private driver interface data
2772 * @freq: If set, survey data for the specified frequency is only
2773 * being requested. If not set, all survey data is requested.
2774 * Returns: 0 on success, -1 on failure
2775 *
2776 * Use this to retrieve:
2777 *
2778 * - the observed channel noise floor
2779 * - the amount of time we have spent on the channel
2780 * - the amount of time during which we have spent on the channel that
2781 * the radio has determined the medium is busy and we cannot
2782 * transmit
2783 * - the amount of time we have spent receiving data
2784 * - the amount of time we have spent transmitting data
2785 *
2786 * This data can be used for spectrum heuristics. One example is
2787 * Automatic Channel Selection (ACS). The channel survey data is
2788 * kept on a linked list on the channel data, one entry is added
2789 * for each survey. The min_nf of the channel is updated for each
2790 * survey.
2791 */
2792 int (*get_survey)(void *priv, unsigned int freq);
a771c07d
JM
2793
2794 /**
2795 * status - Get driver interface status information
2796 * @priv: Private driver interface data
2797 * @buf: Buffer for printing tou the status information
2798 * @buflen: Maximum length of the buffer
2799 * Returns: Length of written status information or -1 on failure
2800 */
2801 int (*status)(void *priv, char *buf, size_t buflen);
6fc6879b
JM
2802};
2803
e0498677 2804
6fc6879b
JM
2805/**
2806 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
2807 */
9646a8ab 2808enum wpa_event_type {
6fc6879b
JM
2809 /**
2810 * EVENT_ASSOC - Association completed
2811 *
2812 * This event needs to be delivered when the driver completes IEEE
2813 * 802.11 association or reassociation successfully.
2814 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
2815 * after this event has been generated. In addition, optional
2816 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
2817 * more information about the association. If the driver interface gets
2818 * both of these events at the same time, it can also include the
2819 * assoc_info data in EVENT_ASSOC call.
2820 */
2821 EVENT_ASSOC,
2822
2823 /**
2824 * EVENT_DISASSOC - Association lost
2825 *
2826 * This event should be called when association is lost either due to
2827 * receiving deauthenticate or disassociate frame from the AP or when
c2a04078
JM
2828 * sending either of these frames to the current AP. If the driver
2829 * supports separate deauthentication event, EVENT_DISASSOC should only
2830 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1d041bec 2831 * In AP mode, union wpa_event_data::disassoc_info is required.
6fc6879b
JM
2832 */
2833 EVENT_DISASSOC,
2834
2835 /**
2836 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
2837 *
2838 * This event must be delivered when a Michael MIC error is detected by
2839 * the local driver. Additional data for event processing is
2840 * provided with union wpa_event_data::michael_mic_failure. This
2841 * information is used to request new encyption key and to initiate
2842 * TKIP countermeasures if needed.
2843 */
2844 EVENT_MICHAEL_MIC_FAILURE,
2845
2846 /**
2847 * EVENT_SCAN_RESULTS - Scan results available
2848 *
2849 * This event must be called whenever scan results are available to be
2850 * fetched with struct wpa_driver_ops::get_scan_results(). This event
2851 * is expected to be used some time after struct wpa_driver_ops::scan()
2852 * is called. If the driver provides an unsolicited event when the scan
2853 * has been completed, this event can be used to trigger
2854 * EVENT_SCAN_RESULTS call. If such event is not available from the
2855 * driver, the driver wrapper code is expected to use a registered
2856 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
8d923a4a
JM
2857 * scan is expected to be completed. Optional information about
2858 * completed scan can be provided with union wpa_event_data::scan_info.
6fc6879b
JM
2859 */
2860 EVENT_SCAN_RESULTS,
2861
2862 /**
2863 * EVENT_ASSOCINFO - Report optional extra information for association
2864 *
2865 * This event can be used to report extra association information for
2866 * EVENT_ASSOC processing. This extra information includes IEs from
2867 * association frames and Beacon/Probe Response frames in union
2868 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
2869 * EVENT_ASSOC. Alternatively, the driver interface can include
2870 * assoc_info data in the EVENT_ASSOC call if it has all the
2871 * information available at the same point.
2872 */
2873 EVENT_ASSOCINFO,
2874
2875 /**
2876 * EVENT_INTERFACE_STATUS - Report interface status changes
2877 *
2878 * This optional event can be used to report changes in interface
2879 * status (interface added/removed) using union
2880 * wpa_event_data::interface_status. This can be used to trigger
2881 * wpa_supplicant to stop and re-start processing for the interface,
2882 * e.g., when a cardbus card is ejected/inserted.
2883 */
2884 EVENT_INTERFACE_STATUS,
2885
2886 /**
2887 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
2888 *
2889 * This event can be used to inform wpa_supplicant about candidates for
2890 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
2891 * for scan request (ap_scan=2 mode), this event is required for
2892 * pre-authentication. If wpa_supplicant is performing scan request
2893 * (ap_scan=1), this event is optional since scan results can be used
2894 * to add pre-authentication candidates. union
2895 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
2896 * candidate and priority of the candidate, e.g., based on the signal
2897 * strength, in order to try to pre-authenticate first with candidates
2898 * that are most likely targets for re-association.
2899 *
2900 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
2901 * on the candidate list. In addition, it can be called for the current
2902 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
2903 * will automatically skip pre-authentication in cases where a valid
2904 * PMKSA exists. When more than one candidate exists, this event should
2905 * be generated once for each candidate.
2906 *
2907 * Driver will be notified about successful pre-authentication with
2908 * struct wpa_driver_ops::add_pmkid() calls.
2909 */
2910 EVENT_PMKID_CANDIDATE,
2911
2912 /**
2913 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
2914 *
2915 * This event can be used to inform wpa_supplicant about desire to set
2916 * up secure direct link connection between two stations as defined in
2917 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
2918 * STAKey negotiation. The caller will need to set peer address for the
2919 * event.
2920 */
2921 EVENT_STKSTART,
2922
281ff0aa
GP
2923 /**
2924 * EVENT_TDLS - Request TDLS operation
2925 *
2926 * This event can be used to request a TDLS operation to be performed.
2927 */
2928 EVENT_TDLS,
2929
6fc6879b
JM
2930 /**
2931 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
2932 *
2933 * The driver is expected to report the received FT IEs from
2934 * FT authentication sequence from the AP. The FT IEs are included in
2935 * the extra information in union wpa_event_data::ft_ies.
2936 */
11ef8d35
JM
2937 EVENT_FT_RESPONSE,
2938
2939 /**
2940 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
2941 *
2942 * The driver can use this event to inform wpa_supplicant about a STA
2943 * in an IBSS with which protected frames could be exchanged. This
2944 * event starts RSN authentication with the other STA to authenticate
2945 * the STA and set up encryption keys with it.
2946 */
c2a04078
JM
2947 EVENT_IBSS_RSN_START,
2948
2949 /**
2950 * EVENT_AUTH - Authentication result
2951 *
2952 * This event should be called when authentication attempt has been
2953 * completed. This is only used if the driver supports separate
2954 * authentication step (struct wpa_driver_ops::authenticate).
2955 * Information about authentication result is included in
2956 * union wpa_event_data::auth.
2957 */
2958 EVENT_AUTH,
2959
2960 /**
2961 * EVENT_DEAUTH - Authentication lost
2962 *
2963 * This event should be called when authentication is lost either due
2964 * to receiving deauthenticate frame from the AP or when sending that
2965 * frame to the current AP.
1d041bec 2966 * In AP mode, union wpa_event_data::deauth_info is required.
c2a04078 2967 */
efa46078
JM
2968 EVENT_DEAUTH,
2969
2970 /**
2971 * EVENT_ASSOC_REJECT - Association rejected
2972 *
2973 * This event should be called when (re)association attempt has been
59ddf221 2974 * rejected by the AP. Information about the association response is
efa46078
JM
2975 * included in union wpa_event_data::assoc_reject.
2976 */
da1fb17c
JM
2977 EVENT_ASSOC_REJECT,
2978
2979 /**
2980 * EVENT_AUTH_TIMED_OUT - Authentication timed out
2981 */
2982 EVENT_AUTH_TIMED_OUT,
2983
2984 /**
2985 * EVENT_ASSOC_TIMED_OUT - Association timed out
2986 */
08fd8c15
JM
2987 EVENT_ASSOC_TIMED_OUT,
2988
2989 /**
2990 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
2991 */
fcf0f87d
JM
2992 EVENT_FT_RRB_RX,
2993
2994 /**
2995 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
2996 */
f8b1f695
JM
2997 EVENT_WPS_BUTTON_PUSHED,
2998
2999 /**
3000 * EVENT_TX_STATUS - Report TX status
3001 */
3002 EVENT_TX_STATUS,
3003
3004 /**
3005 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
3006 */
3007 EVENT_RX_FROM_UNKNOWN,
3008
3009 /**
3010 * EVENT_RX_MGMT - Report RX of a management frame
3011 */
245519e0
JM
3012 EVENT_RX_MGMT,
3013
55777702
JM
3014 /**
3015 * EVENT_RX_ACTION - Action frame received
3016 *
3017 * This event is used to indicate when an Action frame has been
3018 * received. Information about the received frame is included in
3019 * union wpa_event_data::rx_action.
3020 */
3021 EVENT_RX_ACTION,
3022
3023 /**
3024 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
3025 *
3026 * This event is used to indicate when the driver has started the
3027 * requested remain-on-channel duration. Information about the
3028 * operation is included in union wpa_event_data::remain_on_channel.
3029 */
3030 EVENT_REMAIN_ON_CHANNEL,
3031
3032 /**
3033 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
3034 *
3035 * This event is used to indicate when the driver has completed
3036 * remain-on-channel duration, i.e., may noot be available on the
3037 * requested channel anymore. Information about the
3038 * operation is included in union wpa_event_data::remain_on_channel.
3039 */
3040 EVENT_CANCEL_REMAIN_ON_CHANNEL,
3041
245519e0
JM
3042 /**
3043 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
3044 *
3045 * This event is used only by driver_test.c and userspace MLME.
3046 */
a0e0d3bb
JM
3047 EVENT_MLME_RX,
3048
3049 /**
3050 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
3051 *
3052 * This event is used to indicate when a Probe Request frame has been
3053 * received. Information about the received frame is included in
504e905c
JM
3054 * union wpa_event_data::rx_probe_req. The driver is required to report
3055 * these events only after successfully completed probe_req_report()
3056 * commands to request the events (i.e., report parameter is non-zero)
3057 * in station mode. In AP mode, Probe Request frames should always be
3058 * reported.
a0e0d3bb 3059 */
a70a5d6d
JM
3060 EVENT_RX_PROBE_REQ,
3061
3062 /**
3063 * EVENT_NEW_STA - New wired device noticed
3064 *
3065 * This event is used to indicate that a new device has been detected
3066 * in a network that does not use association-like functionality (i.e.,
3067 * mainly wired Ethernet). This can be used to start EAPOL
3068 * authenticator when receiving a frame from a device. The address of
3069 * the device is included in union wpa_event_data::new_sta.
3070 */
a8e0505b
JM
3071 EVENT_NEW_STA,
3072
3073 /**
3074 * EVENT_EAPOL_RX - Report received EAPOL frame
3075 *
3076 * When in AP mode with hostapd, this event is required to be used to
3077 * deliver the receive EAPOL frames from the driver. With
3078 * %wpa_supplicant, this event is used only if the send_eapol() handler
3079 * is used to override the use of l2_packet for EAPOL frame TX.
3080 */
b625473c
JM
3081 EVENT_EAPOL_RX,
3082
3083 /**
3084 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
3085 *
3086 * This event is used to indicate changes in the signal strength
3087 * observed in frames received from the current AP if signal strength
3088 * monitoring has been enabled with signal_monitor().
3089 */
8401a6b0
JM
3090 EVENT_SIGNAL_CHANGE,
3091
3092 /**
3093 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
3094 *
3095 * This event is used to indicate that the interface was enabled after
3096 * having been previously disabled, e.g., due to rfkill.
3097 */
3098 EVENT_INTERFACE_ENABLED,
3099
3100 /**
3101 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
3102 *
3103 * This event is used to indicate that the interface was disabled,
3104 * e.g., due to rfkill.
3105 */
b5c9da8d
JM
3106 EVENT_INTERFACE_DISABLED,
3107
3108 /**
3109 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
3110 *
3111 * This event is used to indicate that the channel list has changed,
3112 * e.g., because of a regulatory domain change triggered by scan
3113 * results including an AP advertising a country code.
3114 */
c973f386
JM
3115 EVENT_CHANNEL_LIST_CHANGED,
3116
3117 /**
3118 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
3119 *
3120 * This event is used to indicate that the driver cannot maintain this
3121 * interface in its operation mode anymore. The most likely use for
3122 * this is to indicate that AP mode operation is not available due to
3123 * operating channel would need to be changed to a DFS channel when
3124 * the driver does not support radar detection and another virtual
3125 * interfaces caused the operating channel to change. Other similar
3126 * resource conflicts could also trigger this for station mode
3127 * interfaces.
3128 */
7cfc4ac3
AGS
3129 EVENT_INTERFACE_UNAVAILABLE,
3130
3131 /**
3132 * EVENT_BEST_CHANNEL
3133 *
3134 * Driver generates this event whenever it detects a better channel
3135 * (e.g., based on RSSI or channel use). This information can be used
3136 * to improve channel selection for a new AP/P2P group.
3137 */
7d878ca7
JM
3138 EVENT_BEST_CHANNEL,
3139
3140 /**
3141 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
3142 *
3143 * This event should be called when a Deauthentication frame is dropped
3144 * due to it not being protected (MFP/IEEE 802.11w).
3145 * union wpa_event_data::unprot_deauth is required to provide more
3146 * details of the frame.
3147 */
3148 EVENT_UNPROT_DEAUTH,
3149
3150 /**
3151 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
3152 *
3153 * This event should be called when a Disassociation frame is dropped
3154 * due to it not being protected (MFP/IEEE 802.11w).
3155 * union wpa_event_data::unprot_disassoc is required to provide more
3156 * details of the frame.
3157 */
3158 EVENT_UNPROT_DISASSOC,
0d7e5a3a
JB
3159
3160 /**
3161 * EVENT_STATION_LOW_ACK
3162 *
3163 * Driver generates this event whenever it detected that a particular
3164 * station was lost. Detection can be through massive transmission
3165 * failures for example.
3166 */
3ac17eba
JM
3167 EVENT_STATION_LOW_ACK,
3168
3169 /**
3170 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device
3171 *
3172 * This event is used only if the driver implements P2P management
3173 * internally. Event data is stored in
3174 * union wpa_event_data::p2p_dev_found.
3175 */
3176 EVENT_P2P_DEV_FOUND,
3177
3178 /**
3179 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request
3180 *
3181 * This event is used only if the driver implements P2P management
3182 * internally. Event data is stored in
3183 * union wpa_event_data::p2p_go_neg_req_rx.
3184 */
3185 EVENT_P2P_GO_NEG_REQ_RX,
3186
3187 /**
3188 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation
3189 *
3190 * This event is used only if the driver implements P2P management
3191 * internally. Event data is stored in
3192 * union wpa_event_data::p2p_go_neg_completed.
3193 */
3194 EVENT_P2P_GO_NEG_COMPLETED,
3195
3196 EVENT_P2P_PROV_DISC_REQUEST,
3197 EVENT_P2P_PROV_DISC_RESPONSE,
3198 EVENT_P2P_SD_REQUEST,
ea244d21
XC
3199 EVENT_P2P_SD_RESPONSE,
3200
3201 /**
3202 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
3203 */
b14a210c
JB
3204 EVENT_IBSS_PEER_LOST,
3205
3206 /**
3207 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
3208 *
3209 * This event carries the new replay counter to notify wpa_supplicant
3210 * of the current EAPOL-Key Replay Counter in case the driver/firmware
3211 * completed Group Key Handshake while the host (including
3212 * wpa_supplicant was sleeping).
3213 */
cbdf3507
LC
3214 EVENT_DRIVER_GTK_REKEY,
3215
3216 /**
3217 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
3218 */
bcf24348
JB
3219 EVENT_SCHED_SCAN_STOPPED,
3220
3221 /**
3222 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
3223 *
3224 * This event indicates that the station responded to the poll
3225 * initiated with @poll_client.
3226 */
dd840f79
JB
3227 EVENT_DRIVER_CLIENT_POLL_OK,
3228
3229 /**
3230 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
3231 */
1b487b8b
TP
3232 EVENT_EAPOL_TX_STATUS,
3233
3234 /**
3235 * EVENT_CH_SWITCH - AP or GO decided to switch channels
3236 *
3237 * Described in wpa_event_data.ch_switch
3238 * */
a884be9d
XC
3239 EVENT_CH_SWITCH,
3240
3241 /**
3242 * EVENT_WNM - Request WNM operation
3243 *
3244 * This event can be used to request a WNM operation to be performed.
3245 */
3140803b
RM
3246 EVENT_WNM,
3247
3248 /**
3249 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
3250 *
3251 * This event indicates that the driver reported a connection failure
3252 * with the specified client (for example, max client reached, etc.) in
3253 * AP mode.
3254 */
04be54fa
SW
3255 EVENT_CONNECT_FAILED_REASON,
3256
3257 /**
3258 * EVENT_RADAR_DETECTED - Notify of radar detection
3259 *
3260 * A radar has been detected on the supplied frequency, hostapd should
3261 * react accordingly (e.g., change channel).
3262 */
3263 EVENT_DFS_RADAR_DETECTED,
3264
3265 /**
3266 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed
3267 *
3268 * After a successful CAC, the channel can be marked clear and used.
3269 */
3270 EVENT_DFS_CAC_FINISHED,
3271
3272 /**
3273 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted
3274 *
3275 * The CAC was not successful, and the channel remains in the previous
3276 * state. This may happen due to a radar beeing detected or other
3277 * external influences.
3278 */
3279 EVENT_DFS_CAC_ABORTED,
3280
3281 /**
3282 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over
3283 *
3284 * The channel which was previously unavailable is now available again.
3285 */
0185007c
MK
3286 EVENT_DFS_NOP_FINISHED,
3287
3288 /*
3289 * EVENT_SURVEY - Received survey data
3290 *
3291 * This event gets triggered when a driver query is issued for survey
3292 * data and the requested data becomes available. The returned data is
3293 * stored in struct survey_results. The results provide at most one
3294 * survey entry for each frequency and at minimum will provide one survey
3295 * entry for one frequency. The survey data can be os_malloc()'d and
3296 * then os_free()'d, so the event callback must only copy data.
3297 */
3298 EVENT_SURVEY
9646a8ab 3299};
6fc6879b
JM
3300
3301
0185007c
MK
3302/**
3303 * struct freq_survey - Channel survey info
3304 *
3305 * @ifidx: Interface index in which this survey was observed
3306 * @freq: Center of frequency of the surveyed channel
3307 * @nf: Channel noise floor in dBm
3308 * @channel_time: Amount of time in ms the radio spent on the channel
3309 * @channel_time_busy: Amount of time in ms the radio detected some signal
3310 * that indicated to the radio the channel was not clear
3311 * @channel_time_rx: Amount of time the radio spent receiving data
3312 * @channel_time_tx: Amount of time the radio spent transmitting data
3313 * @filled: bitmask indicating which fields have been reported, see
3314 * SURVEY_HAS_* defines.
3315 * @list: Internal list pointers
3316 */
3317struct freq_survey {
3318 u32 ifidx;
3319 unsigned int freq;
3320 s8 nf;
3321 u64 channel_time;
3322 u64 channel_time_busy;
3323 u64 channel_time_rx;
3324 u64 channel_time_tx;
3325 unsigned int filled;
3326 struct dl_list list;
3327};
3328
3329#define SURVEY_HAS_NF BIT(0)
3330#define SURVEY_HAS_CHAN_TIME BIT(1)
3331#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
3332#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
3333#define SURVEY_HAS_CHAN_TIME_TX BIT(4)
3334
3335
6fc6879b
JM
3336/**
3337 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
3338 */
3339union wpa_event_data {
3340 /**
3341 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
3342 *
3343 * This structure is optional for EVENT_ASSOC calls and required for
3344 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
3345 * driver interface does not need to generate separate EVENT_ASSOCINFO
3346 * calls.
3347 */
3348 struct assoc_info {
39b08b5f
SP
3349 /**
3350 * reassoc - Flag to indicate association or reassociation
3351 */
3352 int reassoc;
3353
6fc6879b
JM
3354 /**
3355 * req_ies - (Re)Association Request IEs
3356 *
3357 * If the driver generates WPA/RSN IE, this event data must be
3358 * returned for WPA handshake to have needed information. If
3359 * wpa_supplicant-generated WPA/RSN IE is used, this
3360 * information event is optional.
3361 *
3362 * This should start with the first IE (fixed fields before IEs
3363 * are not included).
3364 */
1d041bec 3365 const u8 *req_ies;
6fc6879b
JM
3366
3367 /**
3368 * req_ies_len - Length of req_ies in bytes
3369 */
3370 size_t req_ies_len;
3371
3372 /**
3373 * resp_ies - (Re)Association Response IEs
3374 *
3375 * Optional association data from the driver. This data is not
3376 * required WPA, but may be useful for some protocols and as
3377 * such, should be reported if this is available to the driver
3378 * interface.
3379 *
3380 * This should start with the first IE (fixed fields before IEs
3381 * are not included).
3382 */
1d041bec 3383 const u8 *resp_ies;
6fc6879b
JM
3384
3385 /**
3386 * resp_ies_len - Length of resp_ies in bytes
3387 */
3388 size_t resp_ies_len;
3389
3390 /**
3391 * beacon_ies - Beacon or Probe Response IEs
3392 *
3393 * Optional Beacon/ProbeResp data: IEs included in Beacon or
3394 * Probe Response frames from the current AP (i.e., the one
3395 * that the client just associated with). This information is
3396 * used to update WPA/RSN IE for the AP. If this field is not
3397 * set, the results from previous scan will be used. If no
3398 * data for the new AP is found, scan results will be requested
3399 * again (without scan request). At this point, the driver is
3400 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
3401 * used).
3402 *
3403 * This should start with the first IE (fixed fields before IEs
3404 * are not included).
3405 */
1d041bec 3406 const u8 *beacon_ies;
6fc6879b
JM
3407
3408 /**
3409 * beacon_ies_len - Length of beacon_ies */
3410 size_t beacon_ies_len;
4832ecd7
JM
3411
3412 /**
3413 * freq - Frequency of the operational channel in MHz
3414 */
3415 unsigned int freq;
1d041bec
JM
3416
3417 /**
3418 * addr - Station address (for AP mode)
3419 */
3420 const u8 *addr;
6fc6879b
JM
3421 } assoc_info;
3422
1d041bec
JM
3423 /**
3424 * struct disassoc_info - Data for EVENT_DISASSOC events
3425 */
3426 struct disassoc_info {
3427 /**
3428 * addr - Station address (for AP mode)
3429 */
3430 const u8 *addr;
0544b242
JM
3431
3432 /**
3433 * reason_code - Reason Code (host byte order) used in
3434 * Deauthentication frame
3435 */
3436 u16 reason_code;
75bde05d
JM
3437
3438 /**
3439 * ie - Optional IE(s) in Disassociation frame
3440 */
3441 const u8 *ie;
3442
3443 /**
3444 * ie_len - Length of ie buffer in octets
3445 */
3446 size_t ie_len;
3d9975d5
JM
3447
3448 /**
3449 * locally_generated - Whether the frame was locally generated
3450 */
3451 int locally_generated;
1d041bec
JM
3452 } disassoc_info;
3453
3454 /**
3455 * struct deauth_info - Data for EVENT_DEAUTH events
3456 */
3457 struct deauth_info {
3458 /**
3459 * addr - Station address (for AP mode)
3460 */
3461 const u8 *addr;
0544b242
JM
3462
3463 /**
3464 * reason_code - Reason Code (host byte order) used in
3465 * Deauthentication frame
3466 */
3467 u16 reason_code;
75bde05d
JM
3468
3469 /**
3470 * ie - Optional IE(s) in Deauthentication frame
3471 */
3472 const u8 *ie;
3473
3474 /**
3475 * ie_len - Length of ie buffer in octets
3476 */
3477 size_t ie_len;
3d9975d5
JM
3478
3479 /**
3480 * locally_generated - Whether the frame was locally generated
3481 */
3482 int locally_generated;
1d041bec
JM
3483 } deauth_info;
3484
6fc6879b
JM
3485 /**
3486 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
3487 */
3488 struct michael_mic_failure {
3489 int unicast;
ad1e68e6 3490 const u8 *src;
6fc6879b
JM
3491 } michael_mic_failure;
3492
3493 /**
3494 * struct interface_status - Data for EVENT_INTERFACE_STATUS
3495 */
3496 struct interface_status {
3497 char ifname[100];
3498 enum {
3499 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
3500 } ievent;
3501 } interface_status;
3502
3503 /**
3504 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
3505 */
3506 struct pmkid_candidate {
3507 /** BSSID of the PMKID candidate */
3508 u8 bssid[ETH_ALEN];
3509 /** Smaller the index, higher the priority */
3510 int index;
3511 /** Whether RSN IE includes pre-authenticate flag */
3512 int preauth;
3513 } pmkid_candidate;
3514
3515 /**
3516 * struct stkstart - Data for EVENT_STKSTART
3517 */
3518 struct stkstart {
3519 u8 peer[ETH_ALEN];
3520 } stkstart;
3521
281ff0aa
GP
3522 /**
3523 * struct tdls - Data for EVENT_TDLS
3524 */
3525 struct tdls {
3526 u8 peer[ETH_ALEN];
3527 enum {
3528 TDLS_REQUEST_SETUP,
3529 TDLS_REQUEST_TEARDOWN
3530 } oper;
3531 u16 reason_code; /* for teardown */
3532 } tdls;
3533
a884be9d
XC
3534 /**
3535 * struct wnm - Data for EVENT_WNM
3536 */
3537 struct wnm {
3538 u8 addr[ETH_ALEN];
3539 enum {
3540 WNM_OPER_SLEEP,
3541 } oper;
3542 enum {
3543 WNM_SLEEP_ENTER,
3544 WNM_SLEEP_EXIT
3545 } sleep_action;
3546 int sleep_intval;
3547 u16 reason_code;
3548 u8 *buf;
3549 u16 buf_len;
3550 } wnm;
3551
6fc6879b
JM
3552 /**
3553 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
3554 *
3555 * During FT (IEEE 802.11r) authentication sequence, the driver is
3556 * expected to use this event to report received FT IEs (MDIE, FTIE,
3557 * RSN IE, TIE, possible resource request) to the supplicant. The FT
3558 * IEs for the next message will be delivered through the
3559 * struct wpa_driver_ops::update_ft_ies() callback.
3560 */
3561 struct ft_ies {
3562 const u8 *ies;
3563 size_t ies_len;
3564 int ft_action;
3565 u8 target_ap[ETH_ALEN];
babfbf15
JM
3566 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
3567 const u8 *ric_ies;
3568 /** Length of ric_ies buffer in octets */
3569 size_t ric_ies_len;
6fc6879b 3570 } ft_ies;
11ef8d35
JM
3571
3572 /**
3573 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
3574 */
3575 struct ibss_rsn_start {
3576 u8 peer[ETH_ALEN];
3577 } ibss_rsn_start;
c2a04078
JM
3578
3579 /**
3580 * struct auth_info - Data for EVENT_AUTH events
3581 */
3582 struct auth_info {
3583 u8 peer[ETH_ALEN];
a52eba0f 3584 u8 bssid[ETH_ALEN];
c2a04078 3585 u16 auth_type;
a52eba0f 3586 u16 auth_transaction;
c2a04078
JM
3587 u16 status_code;
3588 const u8 *ies;
3589 size_t ies_len;
3590 } auth;
efa46078
JM
3591
3592 /**
3593 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
3594 */
3595 struct assoc_reject {
59ddf221
JM
3596 /**
3597 * bssid - BSSID of the AP that rejected association
3598 */
3599 const u8 *bssid;
3600
efa46078
JM
3601 /**
3602 * resp_ies - (Re)Association Response IEs
3603 *
3604 * Optional association data from the driver. This data is not
3605 * required WPA, but may be useful for some protocols and as
3606 * such, should be reported if this is available to the driver
3607 * interface.
3608 *
3609 * This should start with the first IE (fixed fields before IEs
3610 * are not included).
3611 */
59ddf221 3612 const u8 *resp_ies;
efa46078
JM
3613
3614 /**
3615 * resp_ies_len - Length of resp_ies in bytes
3616 */
3617 size_t resp_ies_len;
3618
3619 /**
3620 * status_code - Status Code from (Re)association Response
3621 */
3622 u16 status_code;
3623 } assoc_reject;
da1fb17c
JM
3624
3625 struct timeout_event {
3626 u8 addr[ETH_ALEN];
3627 } timeout_event;
08fd8c15
JM
3628
3629 /**
3630 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
3631 */
3632 struct ft_rrb_rx {
3633 const u8 *src;
3634 const u8 *data;
3635 size_t data_len;
3636 } ft_rrb_rx;
f8b1f695
JM
3637
3638 /**
3639 * struct tx_status - Data for EVENT_TX_STATUS events
3640 */
3641 struct tx_status {
3642 u16 type;
3643 u16 stype;
3644 const u8 *dst;
3645 const u8 *data;
3646 size_t data_len;
3647 int ack;
3648 } tx_status;
3649
3650 /**
3651 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
3652 */
3653 struct rx_from_unknown {
9b90955e
JB
3654 const u8 *bssid;
3655 const u8 *addr;
3656 int wds;
f8b1f695
JM
3657 } rx_from_unknown;
3658
3659 /**
3660 * struct rx_mgmt - Data for EVENT_RX_MGMT events
3661 */
3662 struct rx_mgmt {
b57e086c 3663 const u8 *frame;
f8b1f695 3664 size_t frame_len;
2a8b7416 3665 u32 datarate;
baf513d6 3666 int ssi_signal; /* dBm */
f8b1f695 3667 } rx_mgmt;
8d923a4a 3668
55777702
JM
3669 /**
3670 * struct rx_action - Data for EVENT_RX_ACTION events
3671 */
3672 struct rx_action {
e8828999
JM
3673 /**
3674 * da - Destination address of the received Action frame
3675 */
3676 const u8 *da;
3677
55777702
JM
3678 /**
3679 * sa - Source address of the received Action frame
3680 */
3681 const u8 *sa;
3682
e8828999
JM
3683 /**
3684 * bssid - Address 3 of the received Action frame
3685 */
3686 const u8 *bssid;
3687
55777702
JM
3688 /**
3689 * category - Action frame category
3690 */
3691 u8 category;
3692
3693 /**
3694 * data - Action frame body after category field
3695 */
3696 const u8 *data;
3697
3698 /**
3699 * len - Length of data in octets
3700 */
3701 size_t len;
3702
3703 /**
3704 * freq - Frequency (in MHz) on which the frame was received
3705 */
3706 int freq;
3707 } rx_action;
3708
3709 /**
3710 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
3711 *
3712 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
3713 */
3714 struct remain_on_channel {
3715 /**
3716 * freq - Channel frequency in MHz
3717 */
3718 unsigned int freq;
3719
3720 /**
3721 * duration - Duration to remain on the channel in milliseconds
3722 */
3723 unsigned int duration;
3724 } remain_on_channel;
3725
8d923a4a
JM
3726 /**
3727 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
3728 * @aborted: Whether the scan was aborted
3729 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
3730 * @num_freqs: Number of entries in freqs array
3731 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
3732 * SSID)
3733 * @num_ssids: Number of entries in ssids array
3734 */
3735 struct scan_info {
3736 int aborted;
3737 const int *freqs;
3738 size_t num_freqs;
3739 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
3740 size_t num_ssids;
3741 } scan_info;
245519e0
JM
3742
3743 /**
3744 * struct mlme_rx - Data for EVENT_MLME_RX events
3745 */
3746 struct mlme_rx {
3747 const u8 *buf;
3748 size_t len;
3749 int freq;
3750 int channel;
3751 int ssi;
3752 } mlme_rx;
a0e0d3bb
JM
3753
3754 /**
3755 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
3756 */
3757 struct rx_probe_req {
3758 /**
3759 * sa - Source address of the received Probe Request frame
3760 */
3761 const u8 *sa;
3762
04a85e44
JM
3763 /**
3764 * da - Destination address of the received Probe Request frame
3765 * or %NULL if not available
3766 */
3767 const u8 *da;
3768
3769 /**
3770 * bssid - BSSID of the received Probe Request frame or %NULL
3771 * if not available
3772 */
3773 const u8 *bssid;
3774
a0e0d3bb
JM
3775 /**
3776 * ie - IEs from the Probe Request body
3777 */
3778 const u8 *ie;
3779
3780 /**
3781 * ie_len - Length of ie buffer in octets
3782 */
3783 size_t ie_len;
baf513d6
JB
3784
3785 /**
3786 * signal - signal strength in dBm (or 0 if not available)
3787 */
3788 int ssi_signal;
a0e0d3bb 3789 } rx_probe_req;
a70a5d6d
JM
3790
3791 /**
3792 * struct new_sta - Data for EVENT_NEW_STA events
3793 */
3794 struct new_sta {
3795 const u8 *addr;
3796 } new_sta;
a8e0505b
JM
3797
3798 /**
3799 * struct eapol_rx - Data for EVENT_EAPOL_RX events
3800 */
3801 struct eapol_rx {
3802 const u8 *src;
3803 const u8 *data;
3804 size_t data_len;
3805 } eapol_rx;
b625473c
JM
3806
3807 /**
1c5c7273 3808 * signal_change - Data for EVENT_SIGNAL_CHANGE events
b625473c 3809 */
1c5c7273 3810 struct wpa_signal_info signal_change;
7cfc4ac3
AGS
3811
3812 /**
3813 * struct best_channel - Data for EVENT_BEST_CHANNEL events
3814 * @freq_24: Best 2.4 GHz band channel frequency in MHz
3815 * @freq_5: Best 5 GHz band channel frequency in MHz
3816 * @freq_overall: Best channel frequency in MHz
3817 *
3818 * 0 can be used to indicate no preference in either band.
3819 */
3820 struct best_channel {
3821 int freq_24;
3822 int freq_5;
3823 int freq_overall;
3824 } best_chan;
7d878ca7
JM
3825
3826 struct unprot_deauth {
3827 const u8 *sa;
3828 const u8 *da;
3829 u16 reason_code;
3830 } unprot_deauth;
3831
3832 struct unprot_disassoc {
3833 const u8 *sa;
3834 const u8 *da;
3835 u16 reason_code;
3836 } unprot_disassoc;
0d7e5a3a
JB
3837
3838 /**
3839 * struct low_ack - Data for EVENT_STATION_LOW_ACK events
3840 * @addr: station address
3841 */
3842 struct low_ack {
3843 u8 addr[ETH_ALEN];
3844 } low_ack;
3ac17eba
JM
3845
3846 /**
3847 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND
3848 */
3849 struct p2p_dev_found {
3850 const u8 *addr;
3851 const u8 *dev_addr;
3852 const u8 *pri_dev_type;
3853 const char *dev_name;
3854 u16 config_methods;
3855 u8 dev_capab;
3856 u8 group_capab;
3857 } p2p_dev_found;
3858
3859 /**
3860 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX
3861 */
3862 struct p2p_go_neg_req_rx {
3863 const u8 *src;
3864 u16 dev_passwd_id;
3865 } p2p_go_neg_req_rx;
3866
3867 /**
3868 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED
3869 */
3870 struct p2p_go_neg_completed {
3871 struct p2p_go_neg_results *res;
3872 } p2p_go_neg_completed;
3873
3874 struct p2p_prov_disc_req {
3875 const u8 *peer;
3876 u16 config_methods;
3877 const u8 *dev_addr;
3878 const u8 *pri_dev_type;
3879 const char *dev_name;
3880 u16 supp_config_methods;
3881 u8 dev_capab;
3882 u8 group_capab;
3883 } p2p_prov_disc_req;
3884
3885 struct p2p_prov_disc_resp {
3886 const u8 *peer;
3887 u16 config_methods;
3888 } p2p_prov_disc_resp;
3889
3890 struct p2p_sd_req {
3891 int freq;
3892 const u8 *sa;
3893 u8 dialog_token;
3894 u16 update_indic;
3895 const u8 *tlvs;
3896 size_t tlvs_len;
3897 } p2p_sd_req;
3898
3899 struct p2p_sd_resp {
3900 const u8 *sa;
3901 u16 update_indic;
3902 const u8 *tlvs;
3903 size_t tlvs_len;
3904 } p2p_sd_resp;
ea244d21
XC
3905
3906 /**
3907 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
3908 */
3909 struct ibss_peer_lost {
3910 u8 peer[ETH_ALEN];
3911 } ibss_peer_lost;
b14a210c
JB
3912
3913 /**
3914 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
3915 */
3916 struct driver_gtk_rekey {
3917 const u8 *bssid;
3918 const u8 *replay_ctr;
3919 } driver_gtk_rekey;
bcf24348
JB
3920
3921 /**
3922 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
3923 * @addr: station address
3924 */
3925 struct client_poll {
3926 u8 addr[ETH_ALEN];
3927 } client_poll;
dd840f79
JB
3928
3929 /**
3930 * struct eapol_tx_status
3931 * @dst: Original destination
3932 * @data: Data starting with IEEE 802.1X header (!)
3933 * @data_len: Length of data
3934 * @ack: Indicates ack or lost frame
3935 *
3936 * This corresponds to hapd_send_eapol if the frame sent
3937 * there isn't just reported as EVENT_TX_STATUS.
3938 */
3939 struct eapol_tx_status {
3940 const u8 *dst;
3941 const u8 *data;
3942 int data_len;
3943 int ack;
3944 } eapol_tx_status;
1b487b8b
TP
3945
3946 /**
3947 * struct ch_switch
3948 * @freq: Frequency of new channel in MHz
3949 * @ht_enabled: Whether this is an HT channel
3950 * @ch_offset: Secondary channel offset
3951 */
3952 struct ch_switch {
3953 int freq;
3954 int ht_enabled;
3955 int ch_offset;
3956 } ch_switch;
3140803b
RM
3957
3958 /**
3959 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
3960 * @addr: Remote client address
3961 * @code: Reason code for connection failure
3962 */
3963 struct connect_failed_reason {
3964 u8 addr[ETH_ALEN];
3965 enum {
3966 MAX_CLIENT_REACHED,
3967 BLOCKED_CLIENT
3968 } code;
3969 } connect_failed_reason;
04be54fa
SW
3970
3971 /**
3972 * struct dfs_event - Data for radar detected events
3973 * @freq: Frequency of the channel in MHz
3974 */
3975 struct dfs_event {
3976 int freq;
846de15d
JD
3977 int ht_enabled;
3978 int chan_offset;
3979 enum chan_width chan_width;
3980 int cf1;
3981 int cf2;
04be54fa 3982 } dfs_event;
0185007c
MK
3983
3984 /**
3985 * survey_results - Survey result data for EVENT_SURVEY
3986 * @freq_filter: Requested frequency survey filter, 0 if request
3987 * was for all survey data
3988 * @survey_list: Linked list of survey data
3989 */
3990 struct survey_results {
3991 unsigned int freq_filter;
3992 struct dl_list survey_list; /* struct freq_survey */
3993 } survey_results;
6fc6879b
JM
3994};
3995
3996/**
3997 * wpa_supplicant_event - Report a driver event for wpa_supplicant
3998 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
3999 * with struct wpa_driver_ops::init()
4000 * @event: event type (defined above)
4001 * @data: possible extra data for the event
4002 *
4003 * Driver wrapper code should call this function whenever an event is received
4004 * from the driver.
4005 */
9646a8ab 4006void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
6fc6879b
JM
4007 union wpa_event_data *data);
4008
c5121837 4009
1d041bec
JM
4010/*
4011 * The following inline functions are provided for convenience to simplify
4012 * event indication for some of the common events.
4013 */
4014
4015static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie,
39b08b5f 4016 size_t ielen, int reassoc)
1d041bec
JM
4017{
4018 union wpa_event_data event;
4019 os_memset(&event, 0, sizeof(event));
39b08b5f 4020 event.assoc_info.reassoc = reassoc;
1d041bec
JM
4021 event.assoc_info.req_ies = ie;
4022 event.assoc_info.req_ies_len = ielen;
4023 event.assoc_info.addr = addr;
4024 wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
4025}
4026
4027static inline void drv_event_disassoc(void *ctx, const u8 *addr)
4028{
4029 union wpa_event_data event;
4030 os_memset(&event, 0, sizeof(event));
4031 event.disassoc_info.addr = addr;
4032 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
4033}
c5121837 4034
baac6490
JM
4035static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
4036 size_t data_len)
4037{
4038 union wpa_event_data event;
4039 os_memset(&event, 0, sizeof(event));
4040 event.eapol_rx.src = src;
4041 event.eapol_rx.data = data;
4042 event.eapol_rx.data_len = data_len;
4043 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
4044}
4045
aea855d7
JM
4046/* driver_common.c */
4047void wpa_scan_results_free(struct wpa_scan_results *res);
9e0e6902 4048
6c3771d7
BG
4049/* Convert wpa_event_type to a string for logging */
4050const char * event_to_string(enum wpa_event_type event);
4051
6fc6879b 4052#endif /* DRIVER_H */