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