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