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