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