1 /*
2 * WPA Supplicant - driver interface definition
3 * Copyright (c) 2003-2008, Jouni Malinen <j@w1.fi>
4 *
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
8 *
9 * Alternatively, this software may be distributed under the terms of BSD
10 * license.
11 *
12 * See README and COPYING for more details.
13 */
14
15 #ifndef DRIVER_H
16 #define DRIVER_H
17
18 #define WPA_SUPPLICANT_DRIVER_VERSION 3
19
20 #include "defs.h"
21
22 #define AUTH_ALG_OPEN_SYSTEM 0x01
23 #define AUTH_ALG_SHARED_KEY 0x02
24 #define AUTH_ALG_LEAP 0x04
25
26 #define IEEE80211_MODE_INFRA 0
27 #define IEEE80211_MODE_IBSS 1
28
29 #define IEEE80211_CAP_ESS 0x0001
30 #define IEEE80211_CAP_IBSS 0x0002
31 #define IEEE80211_CAP_PRIVACY 0x0010
32
33 #define SSID_MAX_WPA_IE_LEN 40
34 /**
35 * struct wpa_scan_result - Scan results (old structure)
36 * @bssid: BSSID
37 * @ssid: SSID
38 * @ssid_len: length of the ssid
39 * @wpa_ie: WPA IE
40 * @wpa_ie_len: length of the wpa_ie
41 * @rsn_ie: RSN IE
42 * @rsn_ie_len: length of the RSN IE
43 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
44 * @caps: capability information field in host byte order
45 * @qual: signal quality
46 * @noise: noise level
47 * @level: signal level
48 * @maxrate: maximum supported rate
49 * @mdie_present: Whether MDIE was included in Beacon/ProbeRsp frame
50 * @mdie: Mobility domain identifier IE (IEEE 802.11r MDIE) (starting from
51 * IE type field)
52 * @tsf: Timestamp
53 *
54 * This structure is used as a generic format for scan results from the
55 * driver. Each driver interface implementation is responsible for converting
56 * the driver or OS specific scan results into this format.
57 *
58 * This structure is the old data structure used for scan results. It is
59 * obsoleted by the new struct wpa_scan_res structure and the old version is
60 * only included for backwards compatibility with existing driver wrapper
61 * implementations. New implementations are encouraged to implement for struct
62 * wpa_scan_res. The old structure will be removed at some point.
63 */
64 struct wpa_scan_result {
65 u8 bssid[ETH_ALEN];
66 u8 ssid[32];
67 size_t ssid_len;
68 u8 wpa_ie[SSID_MAX_WPA_IE_LEN];
69 size_t wpa_ie_len;
70 u8 rsn_ie[SSID_MAX_WPA_IE_LEN];
71 size_t rsn_ie_len;
72 int freq;
73 u16 caps;
74 int qual;
75 int noise;
76 int level;
77 int maxrate;
78 int mdie_present;
79 u8 mdie[5];
80 u64 tsf;
81 };
82
83
84 /**
85 * struct wpa_scan_res - Scan result for an BSS/IBSS
86 * @bssid: BSSID
87 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
88 * @beacon_int: beacon interval in TUs (host byte order)
89 * @caps: capability information field in host byte order
90 * @qual: signal quality
91 * @noise: noise level
92 * @level: signal level
93 * @tsf: Timestamp
94 * @ie_len: length of the following IE field in octets
95 *
96 * This structure is used as a generic format for scan results from the
97 * driver. Each driver interface implementation is responsible for converting
98 * the driver or OS specific scan results into this format.
99 *
100 * If the driver does not support reporting all IEs, the IE data structure is
101 * constructed of the IEs that are available. This field will also need to
102 * include SSID in IE format. All drivers are encouraged to be extended to
103 * report all IEs to make it easier to support future additions.
104 */
105 struct wpa_scan_res {
106 u8 bssid[ETH_ALEN];
107 int freq;
108 u16 beacon_int;
109 u16 caps;
110 int qual;
111 int noise;
112 int level;
113 u64 tsf;
114 size_t ie_len;
115 /* followed by ie_len octets of IEs */
116 };
117
118 /**
119 * struct wpa_scan_results - Scan results
120 * @res: Array of pointers to allocated variable length scan result entries
121 * @num: Number of entries in the scan result array
122 */
123 struct wpa_scan_results {
124 struct wpa_scan_res **res;
125 size_t num;
126 };
127
128 /**
129 * struct wpa_interface_info - Network interface information
130 * @next: Pointer to the next interface or NULL if this is the last one
131 * @ifname: Interface name that can be used with init() or init2()
132 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
133 * not available
134 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
135 * is not an allocated copy, i.e., get_interfaces() caller will not free
136 * this)
137 */
138 struct wpa_interface_info {
139 struct wpa_interface_info *next;
140 char *ifname;
141 char *desc;
142 const char *drv_name;
143 };
144
145 /**
146 * struct wpa_driver_associate_params - Association parameters
147 * Data for struct wpa_driver_ops::associate().
148 */
149 struct wpa_driver_associate_params {
150 /**
151 * bssid - BSSID of the selected AP
152 * This can be %NULL, if ap_scan=2 mode is used and the driver is
153 * responsible for selecting with which BSS to associate. */
154 const u8 *bssid;
155
156 /**
157 * ssid - The selected SSID
158 */
159 const u8 *ssid;
160 size_t ssid_len;
161
162 /**
163 * freq - Frequency of the channel the selected AP is using
164 * Frequency that the selected AP is using (in MHz as
165 * reported in the scan results)
166 */
167 int freq;
168
169 /**
170 * wpa_ie - WPA information element for (Re)Association Request
171 * WPA information element to be included in (Re)Association
172 * Request (including information element id and length). Use
173 * of this WPA IE is optional. If the driver generates the WPA
174 * IE, it can use pairwise_suite, group_suite, and
175 * key_mgmt_suite to select proper algorithms. In this case,
176 * the driver has to notify wpa_supplicant about the used WPA
177 * IE by generating an event that the interface code will
178 * convert into EVENT_ASSOCINFO data (see below).
179 *
180 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
181 * instead. The driver can determine which version is used by
182 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
183 * WPA2/RSN).
184 *
185 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
186 */
187 const u8 *wpa_ie;
188 /**
189 * wpa_ie_len - length of the wpa_ie
190 */
191 size_t wpa_ie_len;
192
193 /* The selected pairwise/group cipher and key management
194 * suites. These are usually ignored if @wpa_ie is used. */
195 wpa_cipher pairwise_suite;
196 wpa_cipher group_suite;
197 wpa_key_mgmt key_mgmt_suite;
198
199 /**
200 * auth_alg - Allowed authentication algorithms
201 * Bit field of AUTH_ALG_*
202 */
203 int auth_alg;
204
205 /**
206 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
207 */
208 int mode;
209
210 /**
211 * wep_key - WEP keys for static WEP configuration
212 */
213 const u8 *wep_key[4];
214
215 /**
216 * wep_key_len - WEP key length for static WEP configuration
217 */
218 size_t wep_key_len[4];
219
220 /**
221 * wep_tx_keyidx - WEP TX key index for static WEP configuration
222 */
223 int wep_tx_keyidx;
224
225 /**
226 * mgmt_frame_protection - IEEE 802.11w management frame protection
227 */
228 enum {
229 NO_MGMT_FRAME_PROTECTION,
230 MGMT_FRAME_PROTECTION_OPTIONAL,
231 MGMT_FRAME_PROTECTION_REQUIRED
232 } mgmt_frame_protection;
233
234 /**
235 * ft_ies - IEEE 802.11r / FT information elements
236 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
237 * for fast transition, this parameter is set to include the IEs that
238 * are to be sent in the next FT Authentication Request message.
239 * update_ft_ies() handler is called to update the IEs for further
240 * FT messages in the sequence.
241 *
242 * The driver should use these IEs only if the target AP is advertising
243 * the same mobility domain as the one included in the MDIE here.
244 *
245 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
246 * AP after the initial association. These IEs can only be used if the
247 * target AP is advertising support for FT and is using the same MDIE
248 * and SSID as the current AP.
249 *
250 * The driver is responsible for reporting the FT IEs received from the
251 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
252 * type. update_ft_ies() handler will then be called with the FT IEs to
253 * include in the next frame in the authentication sequence.
254 */
255 const u8 *ft_ies;
256
257 /**
258 * ft_ies_len - Length of ft_ies in bytes
259 */
260 size_t ft_ies_len;
261
262 /**
263 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
264 *
265 * This value is provided to allow the driver interface easier access
266 * to the current mobility domain. This value is set to %NULL if no
267 * mobility domain is currently active.
268 */
269 const u8 *ft_md;
270
271 /**
272 * passphrase - RSN passphrase for PSK
273 *
274 * This value is made available only for WPA/WPA2-Personal (PSK) and
275 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
276 * the 8..63 character ASCII passphrase, if available. Please note that
277 * this can be %NULL if passphrase was not used to generate the PSK. In
278 * that case, the psk field must be used to fetch the PSK.
279 */
280 const char *passphrase;
281
282 /**
283 * psk - RSN PSK (alternative for passphrase for PSK)
284 *
285 * This value is made available only for WPA/WPA2-Personal (PSK) and
286 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
287 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
288 * be prepared to handle %NULL value as an error.
289 */
290 const u8 *psk;
291 };
292
293 /**
294 * struct wpa_driver_capa - Driver capability information
295 */
296 struct wpa_driver_capa {
297 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
298 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
299 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
300 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
301 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
302 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
303 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
304 unsigned int key_mgmt;
305
306 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
307 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
308 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
309 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
310 unsigned int enc;
311
312 #define WPA_DRIVER_AUTH_OPEN 0x00000001
313 #define WPA_DRIVER_AUTH_SHARED 0x00000002
314 #define WPA_DRIVER_AUTH_LEAP 0x00000004
315 unsigned int auth;
316
317 /* Driver generated WPA/RSN IE */
318 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
319 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
320 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
321 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
322 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
323 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
324 unsigned int flags;
325 };
326
327
328 #define WPA_CHAN_W_SCAN 0x00000001
329 #define WPA_CHAN_W_ACTIVE_SCAN 0x00000002
330 #define WPA_CHAN_W_IBSS 0x00000004
331
332 struct wpa_channel_data {
333 short chan; /* channel number (IEEE 802.11) */
334 short freq; /* frequency in MHz */
335 int flag; /* flag for user space use (WPA_CHAN_*) */
336 };
337
338 #define WPA_RATE_ERP 0x00000001
339 #define WPA_RATE_BASIC 0x00000002
340 #define WPA_RATE_PREAMBLE2 0x00000004
341 #define WPA_RATE_SUPPORTED 0x00000010
342 #define WPA_RATE_OFDM 0x00000020
343 #define WPA_RATE_CCK 0x00000040
344 #define WPA_RATE_MANDATORY 0x00000100
345
346 struct wpa_rate_data {
347 int rate; /* rate in 100 kbps */
348 int flags; /* WPA_RATE_ flags */
349 };
350
351 typedef enum {
352 WPA_MODE_IEEE80211B,
353 WPA_MODE_IEEE80211G,
354 WPA_MODE_IEEE80211A,
355 NUM_WPA_MODES
356 } wpa_hw_mode;
357
358 struct wpa_hw_modes {
359 wpa_hw_mode mode;
360 int num_channels;
361 struct wpa_channel_data *channels;
362 int num_rates;
363 struct wpa_rate_data *rates;
364 };
365
366
367 struct ieee80211_rx_status {
368 int channel;
369 int ssi;
370 };
371
372 struct wpa_ssid;
373
374 /**
375 * struct wpa_driver_ops - Driver interface API definition
376 *
377 * This structure defines the API that each driver interface needs to implement
378 * for core wpa_supplicant code. All driver specific functionality is captured
379 * in this wrapper.
380 */
381 struct wpa_driver_ops {
382 /** Name of the driver interface */
383 const char *name;
384 /** One line description of the driver interface */
385 const char *desc;
386
387 /**
388 * get_bssid - Get the current BSSID
389 * @priv: private driver interface data
390 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
391 *
392 * Returns: 0 on success, -1 on failure
393 *
394 * Query kernel driver for the current BSSID and copy it to bssid.
395 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
396 * associated.
397 */
398 int (*get_bssid)(void *priv, u8 *bssid);
399
400 /**
401 * get_ssid - Get the current SSID
402 * @priv: private driver interface data
403 * @ssid: buffer for SSID (at least 32 bytes)
404 *
405 * Returns: Length of the SSID on success, -1 on failure
406 *
407 * Query kernel driver for the current SSID and copy it to ssid.
408 * Returning zero is recommended if the STA is not associated.
409 *
410 * Note: SSID is an array of octets, i.e., it is not nul terminated and
411 * can, at least in theory, contain control characters (including nul)
412 * and as such, should be processed as binary data, not a printable
413 * string.
414 */
415 int (*get_ssid)(void *priv, u8 *ssid);
416
417 /**
418 * set_wpa - Enable/disable WPA support (OBSOLETE)
419 * @priv: private driver interface data
420 * @enabled: 1 = enable, 0 = disable
421 *
422 * Returns: 0 on success, -1 on failure
423 *
424 * Note: This function is included for backwards compatibility. This is
425 * called only just after init and just before deinit, so these
426 * functions can be used to implement same functionality and the driver
427 * interface need not define this function.
428 *
429 * Configure the kernel driver to enable/disable WPA support. This may
430 * be empty function, if WPA support is always enabled. Common
431 * configuration items are WPA IE (clearing it when WPA support is
432 * disabled), Privacy flag configuration for capability field (note:
433 * this the value need to set in associate handler to allow plaintext
434 * mode to be used) when trying to associate with, roaming mode (can
435 * allow wpa_supplicant to control roaming if ap_scan=1 is used;
436 * however, drivers can also implement roaming if desired, especially
437 * ap_scan=2 mode is used for this).
438 */
439 int (*set_wpa)(void *priv, int enabled);
440
441 /**
442 * set_key - Configure encryption key
443 * @priv: private driver interface data
444 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
445 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
446 * %WPA_ALG_NONE clears the key.
447 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
448 * broadcast/default keys
449 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
450 * IGTK
451 * @set_tx: configure this key as the default Tx key (only used when
452 * driver does not support separate unicast/individual key
453 * @seq: sequence number/packet number, seq_len octets, the next
454 * packet number to be used for in replay protection; configured
455 * for Rx keys (in most cases, this is only used with broadcast
456 * keys and set to zero for unicast keys)
457 * @seq_len: length of the seq, depends on the algorithm:
458 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
459 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
460 * 8-byte Rx Mic Key
461 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
462 * TKIP: 32, CCMP: 16, IGTK: 16)
463 *
464 * Returns: 0 on success, -1 on failure
465 *
466 * Configure the given key for the kernel driver. If the driver
467 * supports separate individual keys (4 default keys + 1 individual),
468 * addr can be used to determine whether the key is default or
469 * individual. If only 4 keys are supported, the default key with key
470 * index 0 is used as the individual key. STA must be configured to use
471 * it as the default Tx key (set_tx is set) and accept Rx for all the
472 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
473 * broadcast keys, so key index 0 is available for this kind of
474 * configuration.
475 *
476 * Please note that TKIP keys include separate TX and RX MIC keys and
477 * some drivers may expect them in different order than wpa_supplicant
478 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
479 * will tricker Michael MIC errors. This can be fixed by changing the
480 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
481 * in driver_*.c set_key() implementation, see driver_ndis.c for an
482 * example on how this can be done.
483 */
484 int (*set_key)(void *priv, wpa_alg alg, const u8 *addr,
485 int key_idx, int set_tx, const u8 *seq, size_t seq_len,
486 const u8 *key, size_t key_len);
487
488 /**
489 * init - Initialize driver interface
490 * @ctx: context to be used when calling wpa_supplicant functions,
491 * e.g., wpa_supplicant_event()
492 * @ifname: interface name, e.g., wlan0
493 *
494 * Returns: Pointer to private data, %NULL on failure
495 *
496 * Initialize driver interface, including event processing for kernel
497 * driver events (e.g., associated, scan results, Michael MIC failure).
498 * This function can allocate a private configuration data area for
499 * @ctx, file descriptor, interface name, etc. information that may be
500 * needed in future driver operations. If this is not used, non-NULL
501 * value will need to be returned because %NULL is used to indicate
502 * failure. The returned value will be used as 'void *priv' data for
503 * all other driver_ops functions.
504 *
505 * The main event loop (eloop.c) of wpa_supplicant can be used to
506 * register callback for read sockets (eloop_register_read_sock()).
507 *
508 * See below for more information about events and
509 * wpa_supplicant_event() function.
510 */
511 void * (*init)(void *ctx, const char *ifname);
512
513 /**
514 * deinit - Deinitialize driver interface
515 * @priv: private driver interface data from init()
516 *
517 * Shut down driver interface and processing of driver events. Free
518 * private data buffer if one was allocated in init() handler.
519 */
520 void (*deinit)(void *priv);
521
522 /**
523 * set_param - Set driver configuration parameters
524 * @priv: private driver interface data from init()
525 * @param: driver specific configuration parameters
526 *
527 * Returns: 0 on success, -1 on failure
528 *
529 * Optional handler for notifying driver interface about configuration
530 * parameters (driver_param).
531 */
532 int (*set_param)(void *priv, const char *param);
533
534 /**
535 * set_countermeasures - Enable/disable TKIP countermeasures
536 * @priv: private driver interface data
537 * @enabled: 1 = countermeasures enabled, 0 = disabled
538 *
539 * Returns: 0 on success, -1 on failure
540 *
541 * Configure TKIP countermeasures. When these are enabled, the driver
542 * should drop all received and queued frames that are using TKIP.
543 */
544 int (*set_countermeasures)(void *priv, int enabled);
545
546 /**
547 * set_drop_unencrypted - Enable/disable unencrypted frame filtering
548 * @priv: private driver interface data
549 * @enabled: 1 = unencrypted Tx/Rx frames will be dropped, 0 = disabled
550 *
551 * Returns: 0 on success, -1 on failure
552 *
553 * Configure the driver to drop all non-EAPOL frames (both receive and
554 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
555 * still be allowed for key negotiation.
556 */
557 int (*set_drop_unencrypted)(void *priv, int enabled);
558
559 /**
560 * scan - Request the driver to initiate scan
561 * @priv: private driver interface data
562 * @ssid: specific SSID to scan for (ProbeReq) or %NULL to scan for
563 * all SSIDs (either active scan with broadcast SSID or passive
564 * scan
565 * @ssid_len: length of the SSID
566 *
567 * Returns: 0 on success, -1 on failure
568 *
569 * Once the scan results are ready, the driver should report scan
570 * results event for wpa_supplicant which will eventually request the
571 * results with wpa_driver_get_scan_results().
572 */
573 int (*scan)(void *priv, const u8 *ssid, size_t ssid_len);
574
575 /**
576 * combo_scan - Request the driver to initiate combo scan
577 * @priv: private driver interface data
578 * @ssid_ptr: specific SSID to scan for (ProbeReq) or %NULL to scan for
579 * all SSIDs (either active scan with broadcast SSID or passive
580 * scan
581 * @ssid_conf: SSID list from configuration
582 *
583 * Returns: 0 on success, -1 on failure
584 *
585 * Once the scan results are ready, the driver should report scan
586 * results event for wpa_supplicant which will eventually request the
587 * results with wpa_driver_get_scan_results().
588 */
589 int (*combo_scan)(void *priv, struct wpa_ssid **ssid_prt,
590 struct wpa_ssid *ssid_conf);
591
592 /**
593 * get_scan_results - Fetch the latest scan results (old version)
594 * @priv: private driver interface data
595 * @results: pointer to buffer for scan results
596 * @max_size: maximum number of entries (buffer size)
597 *
598 * Returns: Number of scan result entries used on success, -1 on
599 * failure
600 *
601 * If scan results include more than max_size BSSes, max_size will be
602 * returned and the remaining entries will not be included in the
603 * buffer.
604 *
605 * This function is depracated. New driver wrapper implementations
606 * should implement support for get_scan_results2().
607 */
608 int (*get_scan_results)(void *priv,
609 struct wpa_scan_result *results,
610 size_t max_size);
611
612 /**
613 * deauthenticate - Request driver to deauthenticate
614 * @priv: private driver interface data
615 * @addr: peer address (BSSID of the AP)
616 * @reason_code: 16-bit reason code to be sent in the deauthentication
617 * frame
618 *
619 * Returns: 0 on success, -1 on failure
620 */
621 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
622
623 /**
624 * disassociate - Request driver to disassociate
625 * @priv: private driver interface data
626 * @addr: peer address (BSSID of the AP)
627 * @reason_code: 16-bit reason code to be sent in the disassociation
628 * frame
629 *
630 * Returns: 0 on success, -1 on failure
631 */
632 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
633
634 /**
635 * associate - Request driver to associate
636 * @priv: private driver interface data
637 * @params: association parameters
638 *
639 * Returns: 0 on success, -1 on failure
640 */
641 int (*associate)(void *priv,
642 struct wpa_driver_associate_params *params);
643
644 /**
645 * set_auth_alg - Set IEEE 802.11 authentication algorithm
646 * @priv: private driver interface data
647 * @auth_alg: bit field of AUTH_ALG_*
648 *
649 * If the driver supports more than one authentication algorithm at the
650 * same time, it should configure all supported algorithms. If not, one
651 * algorithm needs to be selected arbitrarily. Open System
652 * authentication should be ok for most cases and it is recommended to
653 * be used if other options are not supported. Static WEP configuration
654 * may also use Shared Key authentication and LEAP requires its own
655 * algorithm number. For LEAP, user can make sure that only one
656 * algorithm is used at a time by configuring LEAP as the only
657 * supported EAP method. This information is also available in
658 * associate() params, so set_auth_alg may not be needed in case of
659 * most drivers.
660 *
661 * Returns: 0 on success, -1 on failure
662 */
663 int (*set_auth_alg)(void *priv, int auth_alg);
664
665 /**
666 * add_pmkid - Add PMKSA cache entry to the driver
667 * @priv: private driver interface data
668 * @bssid: BSSID for the PMKSA cache entry
669 * @pmkid: PMKID for the PMKSA cache entry
670 *
671 * Returns: 0 on success, -1 on failure
672 *
673 * This function is called when a new PMK is received, as a result of
674 * either normal authentication or RSN pre-authentication.
675 *
676 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
677 * associate(), add_pmkid() can be used to add new PMKSA cache entries
678 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
679 * driver_ops function does not need to be implemented. Likewise, if
680 * the driver does not support WPA, this function is not needed.
681 */
682 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
683
684 /**
685 * remove_pmkid - Remove PMKSA cache entry to the driver
686 * @priv: private driver interface data
687 * @bssid: BSSID for the PMKSA cache entry
688 * @pmkid: PMKID for the PMKSA cache entry
689 *
690 * Returns: 0 on success, -1 on failure
691 *
692 * This function is called when the supplicant drops a PMKSA cache
693 * entry for any reason.
694 *
695 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
696 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
697 * between the driver and wpa_supplicant. If the driver uses wpa_ie
698 * from wpa_supplicant, this driver_ops function does not need to be
699 * implemented. Likewise, if the driver does not support WPA, this
700 * function is not needed.
701 */
702 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
703
704 /**
705 * flush_pmkid - Flush PMKSA cache
706 * @priv: private driver interface data
707 *
708 * Returns: 0 on success, -1 on failure
709 *
710 * This function is called when the supplicant drops all PMKSA cache
711 * entries for any reason.
712 *
713 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
714 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
715 * between the driver and wpa_supplicant. If the driver uses wpa_ie
716 * from wpa_supplicant, this driver_ops function does not need to be
717 * implemented. Likewise, if the driver does not support WPA, this
718 * function is not needed.
719 */
720 int (*flush_pmkid)(void *priv);
721
722 /**
723 * get_capa - Get driver capabilities
724 * @priv: private driver interface data
725 *
726 * Returns: 0 on success, -1 on failure
727 *
728 * Get driver/firmware/hardware capabilities.
729 */
730 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
731
732 /**
733 * poll - Poll driver for association information
734 * @priv: private driver interface data
735 *
736 * This is an option callback that can be used when the driver does not
737 * provide event mechanism for association events. This is called when
738 * receiving WPA EAPOL-Key messages that require association
739 * information. The driver interface is supposed to generate associnfo
740 * event before returning from this callback function. In addition, the
741 * driver interface should generate an association event after having
742 * sent out associnfo.
743 */
744 void (*poll)(void *priv);
745
746 /**
747 * get_ifname - Get interface name
748 * @priv: private driver interface data
749 *
750 * Returns: Pointer to the interface name. This can differ from the
751 * interface name used in init() call. Init() is called first.
752 *
753 * This optional function can be used to allow the driver interface to
754 * replace the interface name with something else, e.g., based on an
755 * interface mapping from a more descriptive name.
756 */
757 const char * (*get_ifname)(void *priv);
758
759 /**
760 * get_mac_addr - Get own MAC address
761 * @priv: private driver interface data
762 *
763 * Returns: Pointer to own MAC address or %NULL on failure
764 *
765 * This optional function can be used to get the own MAC address of the
766 * device from the driver interface code. This is only needed if the
767 * l2_packet implementation for the OS does not provide easy access to
768 * a MAC address. */
769 const u8 * (*get_mac_addr)(void *priv);
770
771 /**
772 * send_eapol - Optional function for sending EAPOL packets
773 * @priv: private driver interface data
774 * @dest: Destination MAC address
775 * @proto: Ethertype
776 * @data: EAPOL packet starting with IEEE 802.1X header
777 * @data_len: Size of the EAPOL packet
778 *
779 * Returns: 0 on success, -1 on failure
780 *
781 * This optional function can be used to override l2_packet operations
782 * with driver specific functionality. If this function pointer is set,
783 * l2_packet module is not used at all and the driver interface code is
784 * responsible for receiving and sending all EAPOL packets. The
785 * received EAPOL packets are sent to core code by calling
786 * wpa_supplicant_rx_eapol(). The driver interface is required to
787 * implement get_mac_addr() handler if send_eapol() is used.
788 */
789 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
790 const u8 *data, size_t data_len);
791
792 /**
793 * set_operstate - Sets device operating state to DORMANT or UP
794 * @priv: private driver interface data
795 * @state: 0 = dormant, 1 = up
796 * Returns: 0 on success, -1 on failure
797 *
798 * This is an optional function that can be used on operating systems
799 * that support a concept of controlling network device state from user
800 * space applications. This function, if set, gets called with
801 * state = 1 when authentication has been completed and with state = 0
802 * when connection is lost.
803 */
804 int (*set_operstate)(void *priv, int state);
805
806 /**
807 * mlme_setprotection - MLME-SETPROTECTION.request primitive
808 * @priv: Private driver interface data
809 * @addr: Address of the station for which to set protection (may be
810 * %NULL for group keys)
811 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
812 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
813 * Returns: 0 on success, -1 on failure
814 *
815 * This is an optional function that can be used to set the driver to
816 * require protection for Tx and/or Rx frames. This uses the layer
817 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
818 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
819 * set protection operation; instead, they set protection implicitly
820 * based on configured keys.
821 */
822 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
823 int key_type);
824
825 /**
826 * get_hw_feature_data - Get hardware support data (channels and rates)
827 * @priv: Private driver interface data
828 * @num_modes: Variable for returning the number of returned modes
829 * flags: Variable for returning hardware feature flags
830 * Returns: Pointer to allocated hardware data on success or %NULL on
831 * failure. Caller is responsible for freeing this.
832 *
833 * This function is only needed for drivers that export MLME
834 * (management frame processing) to wpa_supplicant.
835 */
836 struct wpa_hw_modes * (*get_hw_feature_data)(void *priv,
837 u16 *num_modes,
838 u16 *flags);
839
840 /**
841 * set_channel - Set channel
842 * @priv: Private driver interface data
843 * @phymode: WPA_MODE_IEEE80211B, ..
844 * @chan: IEEE 802.11 channel number
845 * @freq: Frequency of the channel in MHz
846 * Returns: 0 on success, -1 on failure
847 *
848 * This function is only needed for drivers that export MLME
849 * (management frame processing) to wpa_supplicant.
850 */
851 int (*set_channel)(void *priv, wpa_hw_mode phymode, int chan,
852 int freq);
853
854 /**
855 * set_ssid - Set SSID
856 * @priv: Private driver interface data
857 * @ssid: SSID
858 * @ssid_len: SSID length
859 * Returns: 0 on success, -1 on failure
860 *
861 * This function is only needed for drivers that export MLME
862 * (management frame processing) to wpa_supplicant.
863 */
864 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
865
866 /**
867 * set_bssid - Set BSSID
868 * @priv: Private driver interface data
869 * @bssid: BSSID
870 * Returns: 0 on success, -1 on failure
871 *
872 * This function is only needed for drivers that export MLME
873 * (management frame processing) to wpa_supplicant.
874 */
875 int (*set_bssid)(void *priv, const u8 *bssid);
876
877 /**
878 * send_mlme - Send management frame from MLME
879 * @priv: Private driver interface data
880 * @data: IEEE 802.11 management frame with IEEE 802.11 header
881 * @data_len: Size of the management frame
882 * Returns: 0 on success, -1 on failure
883 *
884 * This function is only needed for drivers that export MLME
885 * (management frame processing) to wpa_supplicant.
886 */
887 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
888
889 /**
890 * mlme_add_sta - Add a STA entry into the driver/netstack
891 * @priv: Private driver interface data
892 * @addr: MAC address of the STA (e.g., BSSID of the AP)
893 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
894 * format (one octet per rate, 1 = 0.5 Mbps)
895 * @supp_rates_len: Number of entries in supp_rates
896 * Returns: 0 on success, -1 on failure
897 *
898 * This function is only needed for drivers that export MLME
899 * (management frame processing) to wpa_supplicant. When the MLME code
900 * completes association with an AP, this function is called to
901 * configure the driver/netstack with a STA entry for data frame
902 * processing (TX rate control, encryption/decryption).
903 */
904 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
905 size_t supp_rates_len);
906
907 /**
908 * mlme_remove_sta - Remove a STA entry from the driver/netstack
909 * @priv: Private driver interface data
910 * @addr: MAC address of the STA (e.g., BSSID of the AP)
911 * Returns: 0 on success, -1 on failure
912 *
913 * This function is only needed for drivers that export MLME
914 * (management frame processing) to wpa_supplicant.
915 */
916 int (*mlme_remove_sta)(void *priv, const u8 *addr);
917
918 /**
919 * update_ft_ies - Update FT (IEEE 802.11r) IEs
920 * @priv: Private driver interface data
921 * @md: Mobility domain (2 octets) (also included inside ies)
922 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
923 * @ies_len: Length of FT IEs in bytes
924 * Returns: 0 on success, -1 on failure
925 *
926 * The supplicant uses this callback to let the driver know that keying
927 * material for FT is available and that the driver can use the
928 * provided IEs in the next message in FT authentication sequence.
929 *
930 * This function is only needed for driver that support IEEE 802.11r
931 * (Fast BSS Transition).
932 */
933 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
934 size_t ies_len);
935
936 /**
937 * send_ft_action - Send FT Action frame (IEEE 802.11r)
938 * @priv: Private driver interface data
939 * @action: Action field value
940 * @target_ap: Target AP address
941 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
942 * @ies_len: Length of FT IEs in bytes
943 * Returns: 0 on success, -1 on failure
944 *
945 * The supplicant uses this callback to request the driver to transmit
946 * an FT Action frame (action category 6) for over-the-DS fast BSS
947 * transition.
948 */
949 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
950 const u8 *ies, size_t ies_len);
951
952 /**
953 * get_scan_results2 - Fetch the latest scan results
954 * @priv: private driver interface data
955 *
956 * Returns: Allocated buffer of scan results (caller is responsible for
957 * freeing the data structure) on success, NULL on failure
958 */
959 struct wpa_scan_results * (*get_scan_results2)(void *priv);
960
961 /**
962 * set_probe_req_ie - Set information element(s) for Probe Request
963 * @priv: private driver interface data
964 * @ies: Information elements to append or %NULL to remove extra IEs
965 * @ies_len: Length of the IE buffer in octets
966 * Returns: 0 on success, -1 on failure
967 */
968 int (*set_probe_req_ie)(void *priv, const u8 *ies, size_t ies_len);
969
970 /**
971 * set_mode - Request driver to set the operating mode
972 * @priv: private driver interface data
973 * @mode: Operation mode (infra/ibss) IEEE80211_MODE_*
974 *
975 * This handler will be called before any key configuration and call to
976 * associate() handler in order to allow the operation mode to be
977 * configured as early as possible. This information is also available
978 * in associate() params and as such, some driver wrappers may not need
979 * to implement set_mode() handler.
980 * Returns: 0 on success, -1 on failure
981 */
982 int (*set_mode)(void *priv, int mode);
983
984 /**
985 * set_country - Set country
986 * @priv: Private driver interface data
987 * @alpha2: country to which to switch to
988 * Returns: 0 on success, -1 on failure
989 *
990 * This function is for drivers which support some form
991 * of setting a regulatory domain.
992 */
993 int (*set_country)(void *priv, const char *alpha2);
994
995 /**
996 * global_init - Global driver initialization
997 * Returns: Pointer to private data (global), %NULL on failure
998 *
999 * This optional function is called to initialize the driver wrapper
1000 * for global data, i.e., data that applies to all interfaces. If this
1001 * function is implemented, global_deinit() will also need to be
1002 * implemented to free the private data. The driver will also likely
1003 * use init2() function instead of init() to get the pointer to global
1004 * data available to per-interface initializer.
1005 */
1006 void * (*global_init)(void);
1007
1008 /**
1009 * global_deinit - Global driver deinitialization
1010 * @priv: private driver global data from global_init()
1011 *
1012 * Terminate any global driver related functionality and free the
1013 * global data structure.
1014 */
1015 void (*global_deinit)(void *priv);
1016
1017 /**
1018 * init2 - Initialize driver interface (with global data)
1019 * @ctx: context to be used when calling wpa_supplicant functions,
1020 * e.g., wpa_supplicant_event()
1021 * @ifname: interface name, e.g., wlan0
1022 * @global_priv: private driver global data from global_init()
1023 * Returns: Pointer to private data, %NULL on failure
1024 *
1025 * This function can be used instead of init() if the driver wrapper
1026 * uses global data.
1027 */
1028 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1029
1030 /**
1031 * get_interfaces - Get information about available interfaces
1032 * @global_priv: private driver global data from global_init()
1033 * Returns: Allocated buffer of interface information (caller is
1034 * responsible for freeing the data structure) on success, NULL on
1035 * failure
1036 */
1037 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1038
1039 #ifdef ANDROID
1040 /**
1041 * driver_cmd - execute driver-specific command
1042 * @priv: private driver interface data from init()
1043 * @cmd: command to execute
1044 * @buf: return buffer
1045 * @buf_len: buffer length
1046 *
1047 * Returns: 0 on success, -1 on failure
1048 *
1049 */
1050 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
1051 #endif
1052 };
1053
1054 /* Function to check whether a driver is for wired connections */
IS_WIRED(const struct wpa_driver_ops * drv)1055 static inline int IS_WIRED(const struct wpa_driver_ops *drv)
1056 {
1057 return os_strcmp(drv->name, "wired") == 0 ||
1058 os_strcmp(drv->name, "roboswitch") == 0;
1059 }
1060
1061 /**
1062 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1063 */
1064 typedef enum wpa_event_type {
1065 /**
1066 * EVENT_ASSOC - Association completed
1067 *
1068 * This event needs to be delivered when the driver completes IEEE
1069 * 802.11 association or reassociation successfully.
1070 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1071 * after this event has been generated. In addition, optional
1072 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1073 * more information about the association. If the driver interface gets
1074 * both of these events at the same time, it can also include the
1075 * assoc_info data in EVENT_ASSOC call.
1076 */
1077 EVENT_ASSOC,
1078
1079 /**
1080 * EVENT_DISASSOC - Association lost
1081 *
1082 * This event should be called when association is lost either due to
1083 * receiving deauthenticate or disassociate frame from the AP or when
1084 * sending either of these frames to the current AP.
1085 */
1086 EVENT_DISASSOC,
1087
1088 /**
1089 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1090 *
1091 * This event must be delivered when a Michael MIC error is detected by
1092 * the local driver. Additional data for event processing is
1093 * provided with union wpa_event_data::michael_mic_failure. This
1094 * information is used to request new encyption key and to initiate
1095 * TKIP countermeasures if needed.
1096 */
1097 EVENT_MICHAEL_MIC_FAILURE,
1098
1099 /**
1100 * EVENT_SCAN_RESULTS - Scan results available
1101 *
1102 * This event must be called whenever scan results are available to be
1103 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1104 * is expected to be used some time after struct wpa_driver_ops::scan()
1105 * is called. If the driver provides an unsolicited event when the scan
1106 * has been completed, this event can be used to trigger
1107 * EVENT_SCAN_RESULTS call. If such event is not available from the
1108 * driver, the driver wrapper code is expected to use a registered
1109 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1110 * scan is expected to be completed.
1111 */
1112 EVENT_SCAN_RESULTS,
1113
1114 /**
1115 * EVENT_ASSOCINFO - Report optional extra information for association
1116 *
1117 * This event can be used to report extra association information for
1118 * EVENT_ASSOC processing. This extra information includes IEs from
1119 * association frames and Beacon/Probe Response frames in union
1120 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1121 * EVENT_ASSOC. Alternatively, the driver interface can include
1122 * assoc_info data in the EVENT_ASSOC call if it has all the
1123 * information available at the same point.
1124 */
1125 EVENT_ASSOCINFO,
1126
1127 /**
1128 * EVENT_INTERFACE_STATUS - Report interface status changes
1129 *
1130 * This optional event can be used to report changes in interface
1131 * status (interface added/removed) using union
1132 * wpa_event_data::interface_status. This can be used to trigger
1133 * wpa_supplicant to stop and re-start processing for the interface,
1134 * e.g., when a cardbus card is ejected/inserted.
1135 */
1136 EVENT_INTERFACE_STATUS,
1137
1138 /**
1139 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1140 *
1141 * This event can be used to inform wpa_supplicant about candidates for
1142 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1143 * for scan request (ap_scan=2 mode), this event is required for
1144 * pre-authentication. If wpa_supplicant is performing scan request
1145 * (ap_scan=1), this event is optional since scan results can be used
1146 * to add pre-authentication candidates. union
1147 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1148 * candidate and priority of the candidate, e.g., based on the signal
1149 * strength, in order to try to pre-authenticate first with candidates
1150 * that are most likely targets for re-association.
1151 *
1152 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1153 * on the candidate list. In addition, it can be called for the current
1154 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1155 * will automatically skip pre-authentication in cases where a valid
1156 * PMKSA exists. When more than one candidate exists, this event should
1157 * be generated once for each candidate.
1158 *
1159 * Driver will be notified about successful pre-authentication with
1160 * struct wpa_driver_ops::add_pmkid() calls.
1161 */
1162 EVENT_PMKID_CANDIDATE,
1163
1164 /**
1165 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1166 *
1167 * This event can be used to inform wpa_supplicant about desire to set
1168 * up secure direct link connection between two stations as defined in
1169 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1170 * STAKey negotiation. The caller will need to set peer address for the
1171 * event.
1172 */
1173 EVENT_STKSTART,
1174
1175 /**
1176 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1177 *
1178 * The driver is expected to report the received FT IEs from
1179 * FT authentication sequence from the AP. The FT IEs are included in
1180 * the extra information in union wpa_event_data::ft_ies.
1181 */
1182 EVENT_FT_RESPONSE
1183 } wpa_event_type;
1184
1185
1186 /**
1187 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
1188 */
1189 union wpa_event_data {
1190 /**
1191 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
1192 *
1193 * This structure is optional for EVENT_ASSOC calls and required for
1194 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
1195 * driver interface does not need to generate separate EVENT_ASSOCINFO
1196 * calls.
1197 */
1198 struct assoc_info {
1199 /**
1200 * req_ies - (Re)Association Request IEs
1201 *
1202 * If the driver generates WPA/RSN IE, this event data must be
1203 * returned for WPA handshake to have needed information. If
1204 * wpa_supplicant-generated WPA/RSN IE is used, this
1205 * information event is optional.
1206 *
1207 * This should start with the first IE (fixed fields before IEs
1208 * are not included).
1209 */
1210 u8 *req_ies;
1211
1212 /**
1213 * req_ies_len - Length of req_ies in bytes
1214 */
1215 size_t req_ies_len;
1216
1217 /**
1218 * resp_ies - (Re)Association Response IEs
1219 *
1220 * Optional association data from the driver. This data is not
1221 * required WPA, but may be useful for some protocols and as
1222 * such, should be reported if this is available to the driver
1223 * interface.
1224 *
1225 * This should start with the first IE (fixed fields before IEs
1226 * are not included).
1227 */
1228 u8 *resp_ies;
1229
1230 /**
1231 * resp_ies_len - Length of resp_ies in bytes
1232 */
1233 size_t resp_ies_len;
1234
1235 /**
1236 * beacon_ies - Beacon or Probe Response IEs
1237 *
1238 * Optional Beacon/ProbeResp data: IEs included in Beacon or
1239 * Probe Response frames from the current AP (i.e., the one
1240 * that the client just associated with). This information is
1241 * used to update WPA/RSN IE for the AP. If this field is not
1242 * set, the results from previous scan will be used. If no
1243 * data for the new AP is found, scan results will be requested
1244 * again (without scan request). At this point, the driver is
1245 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
1246 * used).
1247 *
1248 * This should start with the first IE (fixed fields before IEs
1249 * are not included).
1250 */
1251 u8 *beacon_ies;
1252
1253 /**
1254 * beacon_ies_len - Length of beacon_ies */
1255 size_t beacon_ies_len;
1256 } assoc_info;
1257
1258 /**
1259 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
1260 */
1261 struct michael_mic_failure {
1262 int unicast;
1263 } michael_mic_failure;
1264
1265 /**
1266 * struct interface_status - Data for EVENT_INTERFACE_STATUS
1267 */
1268 struct interface_status {
1269 char ifname[100];
1270 enum {
1271 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
1272 } ievent;
1273 } interface_status;
1274
1275 /**
1276 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
1277 */
1278 struct pmkid_candidate {
1279 /** BSSID of the PMKID candidate */
1280 u8 bssid[ETH_ALEN];
1281 /** Smaller the index, higher the priority */
1282 int index;
1283 /** Whether RSN IE includes pre-authenticate flag */
1284 int preauth;
1285 } pmkid_candidate;
1286
1287 /**
1288 * struct stkstart - Data for EVENT_STKSTART
1289 */
1290 struct stkstart {
1291 u8 peer[ETH_ALEN];
1292 } stkstart;
1293
1294 /**
1295 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
1296 *
1297 * During FT (IEEE 802.11r) authentication sequence, the driver is
1298 * expected to use this event to report received FT IEs (MDIE, FTIE,
1299 * RSN IE, TIE, possible resource request) to the supplicant. The FT
1300 * IEs for the next message will be delivered through the
1301 * struct wpa_driver_ops::update_ft_ies() callback.
1302 */
1303 struct ft_ies {
1304 const u8 *ies;
1305 size_t ies_len;
1306 int ft_action;
1307 u8 target_ap[ETH_ALEN];
1308 } ft_ies;
1309 };
1310
1311 /**
1312 * wpa_supplicant_event - Report a driver event for wpa_supplicant
1313 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1314 * with struct wpa_driver_ops::init()
1315 * @event: event type (defined above)
1316 * @data: possible extra data for the event
1317 *
1318 * Driver wrapper code should call this function whenever an event is received
1319 * from the driver.
1320 */
1321 void wpa_supplicant_event(void *ctx, wpa_event_type event,
1322 union wpa_event_data *data);
1323
1324 /**
1325 * wpa_supplicant_rx_eapol - Deliver a received EAPOL frame to wpa_supplicant
1326 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1327 * with struct wpa_driver_ops::init()
1328 * @src_addr: Source address of the EAPOL frame
1329 * @buf: EAPOL data starting from the EAPOL header (i.e., no Ethernet header)
1330 * @len: Length of the EAPOL data
1331 *
1332 * This function is called for each received EAPOL frame. Most driver
1333 * interfaces rely on more generic OS mechanism for receiving frames through
1334 * l2_packet, but if such a mechanism is not available, the driver wrapper may
1335 * take care of received EAPOL frames and deliver them to the core supplicant
1336 * code by calling this function.
1337 */
1338 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
1339 const u8 *buf, size_t len);
1340
1341 void wpa_supplicant_sta_rx(void *ctx, const u8 *buf, size_t len,
1342 struct ieee80211_rx_status *rx_status);
1343 void wpa_supplicant_sta_free_hw_features(struct wpa_hw_modes *hw_features,
1344 size_t num_hw_features);
1345
1346 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie);
1347 #define WPA_IE_VENDOR_TYPE 0x0050f201
1348 #define WPS_IE_VENDOR_TYPE 0x0050f204
1349 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
1350 u32 vendor_type);
1351 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
1352 u32 vendor_type);
1353 int wpa_scan_get_max_rate(const struct wpa_scan_res *res);
1354 void wpa_scan_results_free(struct wpa_scan_results *res);
1355 void wpa_scan_sort_results(struct wpa_scan_results *res);
1356
1357 #endif /* DRIVER_H */
1358