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