2 * WPA Supplicant - driver interface definition
3 * Copyright (c) 2003-2008, Jouni Malinen <j@w1.fi>
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.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
18 #define WPA_SUPPLICANT_DRIVER_VERSION 3
22 #define AUTH_ALG_OPEN_SYSTEM 0x01
23 #define AUTH_ALG_SHARED_KEY 0x02
24 #define AUTH_ALG_LEAP 0x04
26 #define IEEE80211_MODE_INFRA 0
27 #define IEEE80211_MODE_IBSS 1
29 #define IEEE80211_CAP_ESS 0x0001
30 #define IEEE80211_CAP_IBSS 0x0002
31 #define IEEE80211_CAP_PRIVACY 0x0010
33 #define SSID_MAX_WPA_IE_LEN 40
35 * struct wpa_scan_result - Scan results (old structure)
38 * @ssid_len: length of the ssid
40 * @wpa_ie_len: length of the wpa_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
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
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.
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.
64 struct wpa_scan_result {
68 u8 wpa_ie[SSID_MAX_WPA_IE_LEN];
70 u8 rsn_ie[SSID_MAX_WPA_IE_LEN];
85 * struct wpa_scan_res - Scan result for an BSS/IBSS
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
92 * @level: signal level
94 * @ie_len: length of the following IE field in octets
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.
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.
105 struct wpa_scan_res {
115 /* followed by ie_len octets of IEs */
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
123 struct wpa_scan_results {
124 struct wpa_scan_res **res;
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
134 * @drv_bame: 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
138 struct wpa_interface_info {
139 struct wpa_interface_info *next;
142 const char *drv_name;
145 #define WPAS_MAX_SCAN_SSIDS 4
148 * struct wpa_driver_scan_params - Scan parameters
149 * Data for struct wpa_driver_ops::scan2().
151 struct wpa_driver_scan_params {
153 * ssids - SSIDs to scan for
155 struct wpa_driver_scan_ssid {
157 * ssid - specific SSID to scan for (ProbeReq)
158 * %NULL or zero-length SSID is used to indicate active scan
159 * with broadcast SSID.
163 * ssid_len: Length of the SSID in octets
166 } ssids[WPAS_MAX_SCAN_SSIDS];
169 * num_ssids - Number of entries in ssids array
170 * Zero indicates a request for a passive scan.
175 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
180 * extra_ies_len - Length of extra_ies in octets
182 size_t extra_ies_len;
186 * struct wpa_driver_associate_params - Association parameters
187 * Data for struct wpa_driver_ops::associate().
189 struct wpa_driver_associate_params {
191 * bssid - BSSID of the selected AP
192 * This can be %NULL, if ap_scan=2 mode is used and the driver is
193 * responsible for selecting with which BSS to associate. */
197 * ssid - The selected SSID
203 * freq - Frequency of the channel the selected AP is using
204 * Frequency that the selected AP is using (in MHz as
205 * reported in the scan results)
210 * wpa_ie - WPA information element for (Re)Association Request
211 * WPA information element to be included in (Re)Association
212 * Request (including information element id and length). Use
213 * of this WPA IE is optional. If the driver generates the WPA
214 * IE, it can use pairwise_suite, group_suite, and
215 * key_mgmt_suite to select proper algorithms. In this case,
216 * the driver has to notify wpa_supplicant about the used WPA
217 * IE by generating an event that the interface code will
218 * convert into EVENT_ASSOCINFO data (see below).
220 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
221 * instead. The driver can determine which version is used by
222 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
225 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
229 * wpa_ie_len - length of the wpa_ie
233 /* The selected pairwise/group cipher and key management
234 * suites. These are usually ignored if @wpa_ie is used. */
235 wpa_cipher pairwise_suite;
236 wpa_cipher group_suite;
237 wpa_key_mgmt key_mgmt_suite;
240 * auth_alg - Allowed authentication algorithms
241 * Bit field of AUTH_ALG_*
246 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
251 * wep_key - WEP keys for static WEP configuration
253 const u8 *wep_key[4];
256 * wep_key_len - WEP key length for static WEP configuration
258 size_t wep_key_len[4];
261 * wep_tx_keyidx - WEP TX key index for static WEP configuration
266 * mgmt_frame_protection - IEEE 802.11w management frame protection
269 NO_MGMT_FRAME_PROTECTION,
270 MGMT_FRAME_PROTECTION_OPTIONAL,
271 MGMT_FRAME_PROTECTION_REQUIRED
272 } mgmt_frame_protection;
275 * ft_ies - IEEE 802.11r / FT information elements
276 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
277 * for fast transition, this parameter is set to include the IEs that
278 * are to be sent in the next FT Authentication Request message.
279 * update_ft_ies() handler is called to update the IEs for further
280 * FT messages in the sequence.
282 * The driver should use these IEs only if the target AP is advertising
283 * the same mobility domain as the one included in the MDIE here.
285 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
286 * AP after the initial association. These IEs can only be used if the
287 * target AP is advertising support for FT and is using the same MDIE
288 * and SSID as the current AP.
290 * The driver is responsible for reporting the FT IEs received from the
291 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
292 * type. update_ft_ies() handler will then be called with the FT IEs to
293 * include in the next frame in the authentication sequence.
298 * ft_ies_len - Length of ft_ies in bytes
303 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
305 * This value is provided to allow the driver interface easier access
306 * to the current mobility domain. This value is set to %NULL if no
307 * mobility domain is currently active.
312 * passphrase - RSN passphrase for PSK
314 * This value is made available only for WPA/WPA2-Personal (PSK) and
315 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
316 * the 8..63 character ASCII passphrase, if available. Please note that
317 * this can be %NULL if passphrase was not used to generate the PSK. In
318 * that case, the psk field must be used to fetch the PSK.
320 const char *passphrase;
323 * psk - RSN PSK (alternative for passphrase for PSK)
325 * This value is made available only for WPA/WPA2-Personal (PSK) and
326 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
327 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
328 * be prepared to handle %NULL value as an error.
334 * struct wpa_driver_capa - Driver capability information
336 struct wpa_driver_capa {
337 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
338 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
339 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
340 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
341 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
342 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
343 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
344 unsigned int key_mgmt;
346 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
347 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
348 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
349 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
352 #define WPA_DRIVER_AUTH_OPEN 0x00000001
353 #define WPA_DRIVER_AUTH_SHARED 0x00000002
354 #define WPA_DRIVER_AUTH_LEAP 0x00000004
357 /* Driver generated WPA/RSN IE */
358 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
359 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
360 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
361 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
362 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
363 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
370 #define WPA_CHAN_W_SCAN 0x00000001
371 #define WPA_CHAN_W_ACTIVE_SCAN 0x00000002
372 #define WPA_CHAN_W_IBSS 0x00000004
374 struct wpa_channel_data {
375 short chan; /* channel number (IEEE 802.11) */
376 short freq; /* frequency in MHz */
377 int flag; /* flag for user space use (WPA_CHAN_*) */
380 #define WPA_RATE_ERP 0x00000001
381 #define WPA_RATE_BASIC 0x00000002
382 #define WPA_RATE_PREAMBLE2 0x00000004
383 #define WPA_RATE_SUPPORTED 0x00000010
384 #define WPA_RATE_OFDM 0x00000020
385 #define WPA_RATE_CCK 0x00000040
386 #define WPA_RATE_MANDATORY 0x00000100
388 struct wpa_rate_data {
389 int rate; /* rate in 100 kbps */
390 int flags; /* WPA_RATE_ flags */
400 struct wpa_hw_modes {
403 struct wpa_channel_data *channels;
405 struct wpa_rate_data *rates;
409 struct ieee80211_rx_status {
416 * struct wpa_driver_ops - Driver interface API definition
418 * This structure defines the API that each driver interface needs to implement
419 * for core wpa_supplicant code. All driver specific functionality is captured
422 struct wpa_driver_ops {
423 /** Name of the driver interface */
425 /** One line description of the driver interface */
429 * get_bssid - Get the current BSSID
430 * @priv: private driver interface data
431 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
433 * Returns: 0 on success, -1 on failure
435 * Query kernel driver for the current BSSID and copy it to bssid.
436 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
439 int (*get_bssid)(void *priv, u8 *bssid);
442 * get_ssid - Get the current SSID
443 * @priv: private driver interface data
444 * @ssid: buffer for SSID (at least 32 bytes)
446 * Returns: Length of the SSID on success, -1 on failure
448 * Query kernel driver for the current SSID and copy it to ssid.
449 * Returning zero is recommended if the STA is not associated.
451 * Note: SSID is an array of octets, i.e., it is not nul terminated and
452 * can, at least in theory, contain control characters (including nul)
453 * and as such, should be processed as binary data, not a printable
456 int (*get_ssid)(void *priv, u8 *ssid);
459 * set_wpa - Enable/disable WPA support (OBSOLETE)
460 * @priv: private driver interface data
461 * @enabled: 1 = enable, 0 = disable
463 * Returns: 0 on success, -1 on failure
465 * Note: This function is included for backwards compatibility. This is
466 * called only just after init and just before deinit, so these
467 * functions can be used to implement same functionality and the driver
468 * interface need not define this function.
470 * Configure the kernel driver to enable/disable WPA support. This may
471 * be empty function, if WPA support is always enabled. Common
472 * configuration items are WPA IE (clearing it when WPA support is
473 * disabled), Privacy flag configuration for capability field (note:
474 * this the value need to set in associate handler to allow plaintext
475 * mode to be used) when trying to associate with, roaming mode (can
476 * allow wpa_supplicant to control roaming if ap_scan=1 is used;
477 * however, drivers can also implement roaming if desired, especially
478 * ap_scan=2 mode is used for this).
480 int (*set_wpa)(void *priv, int enabled);
483 * set_key - Configure encryption key
484 * @priv: private driver interface data
485 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
486 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
487 * %WPA_ALG_NONE clears the key.
488 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
489 * broadcast/default keys
490 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
492 * @set_tx: configure this key as the default Tx key (only used when
493 * driver does not support separate unicast/individual key
494 * @seq: sequence number/packet number, seq_len octets, the next
495 * packet number to be used for in replay protection; configured
496 * for Rx keys (in most cases, this is only used with broadcast
497 * keys and set to zero for unicast keys)
498 * @seq_len: length of the seq, depends on the algorithm:
499 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
500 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
502 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
503 * TKIP: 32, CCMP: 16, IGTK: 16)
505 * Returns: 0 on success, -1 on failure
507 * Configure the given key for the kernel driver. If the driver
508 * supports separate individual keys (4 default keys + 1 individual),
509 * addr can be used to determine whether the key is default or
510 * individual. If only 4 keys are supported, the default key with key
511 * index 0 is used as the individual key. STA must be configured to use
512 * it as the default Tx key (set_tx is set) and accept Rx for all the
513 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
514 * broadcast keys, so key index 0 is available for this kind of
517 * Please note that TKIP keys include separate TX and RX MIC keys and
518 * some drivers may expect them in different order than wpa_supplicant
519 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
520 * will tricker Michael MIC errors. This can be fixed by changing the
521 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
522 * in driver_*.c set_key() implementation, see driver_ndis.c for an
523 * example on how this can be done.
525 int (*set_key)(void *priv, wpa_alg alg, const u8 *addr,
526 int key_idx, int set_tx, const u8 *seq, size_t seq_len,
527 const u8 *key, size_t key_len);
530 * init - Initialize driver interface
531 * @ctx: context to be used when calling wpa_supplicant functions,
532 * e.g., wpa_supplicant_event()
533 * @ifname: interface name, e.g., wlan0
535 * Returns: Pointer to private data, %NULL on failure
537 * Initialize driver interface, including event processing for kernel
538 * driver events (e.g., associated, scan results, Michael MIC failure).
539 * This function can allocate a private configuration data area for
540 * @ctx, file descriptor, interface name, etc. information that may be
541 * needed in future driver operations. If this is not used, non-NULL
542 * value will need to be returned because %NULL is used to indicate
543 * failure. The returned value will be used as 'void *priv' data for
544 * all other driver_ops functions.
546 * The main event loop (eloop.c) of wpa_supplicant can be used to
547 * register callback for read sockets (eloop_register_read_sock()).
549 * See below for more information about events and
550 * wpa_supplicant_event() function.
552 void * (*init)(void *ctx, const char *ifname);
555 * deinit - Deinitialize driver interface
556 * @priv: private driver interface data from init()
558 * Shut down driver interface and processing of driver events. Free
559 * private data buffer if one was allocated in init() handler.
561 void (*deinit)(void *priv);
564 * set_param - Set driver configuration parameters
565 * @priv: private driver interface data from init()
566 * @param: driver specific configuration parameters
568 * Returns: 0 on success, -1 on failure
570 * Optional handler for notifying driver interface about configuration
571 * parameters (driver_param).
573 int (*set_param)(void *priv, const char *param);
576 * set_countermeasures - Enable/disable TKIP countermeasures
577 * @priv: private driver interface data
578 * @enabled: 1 = countermeasures enabled, 0 = disabled
580 * Returns: 0 on success, -1 on failure
582 * Configure TKIP countermeasures. When these are enabled, the driver
583 * should drop all received and queued frames that are using TKIP.
585 int (*set_countermeasures)(void *priv, int enabled);
588 * set_drop_unencrypted - Enable/disable unencrypted frame filtering
589 * @priv: private driver interface data
590 * @enabled: 1 = unencrypted Tx/Rx frames will be dropped, 0 = disabled
592 * Returns: 0 on success, -1 on failure
594 * Configure the driver to drop all non-EAPOL frames (both receive and
595 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
596 * still be allowed for key negotiation.
598 int (*set_drop_unencrypted)(void *priv, int enabled);
601 * scan - Request the driver to initiate scan (old version)
602 * @priv: private driver interface data
603 * @ssid: specific SSID to scan for (ProbeReq) or %NULL to scan for
604 * all SSIDs (either active scan with broadcast SSID or passive
606 * @ssid_len: length of the SSID
608 * Returns: 0 on success, -1 on failure
610 * Once the scan results are ready, the driver should report scan
611 * results event for wpa_supplicant which will eventually request the
612 * results with wpa_driver_get_scan_results().
614 * This function is depracated. New driver wrapper implementations
615 * should implement support for scan2().
617 int (*scan)(void *priv, const u8 *ssid, size_t ssid_len);
620 * get_scan_results - Fetch the latest scan results (old version)
621 * @priv: private driver interface data
622 * @results: pointer to buffer for scan results
623 * @max_size: maximum number of entries (buffer size)
625 * Returns: Number of scan result entries used on success, -1 on
628 * If scan results include more than max_size BSSes, max_size will be
629 * returned and the remaining entries will not be included in the
632 * This function is depracated. New driver wrapper implementations
633 * should implement support for get_scan_results2().
635 int (*get_scan_results)(void *priv,
636 struct wpa_scan_result *results,
640 * deauthenticate - Request driver to deauthenticate
641 * @priv: private driver interface data
642 * @addr: peer address (BSSID of the AP)
643 * @reason_code: 16-bit reason code to be sent in the deauthentication
646 * Returns: 0 on success, -1 on failure
648 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
651 * disassociate - Request driver to disassociate
652 * @priv: private driver interface data
653 * @addr: peer address (BSSID of the AP)
654 * @reason_code: 16-bit reason code to be sent in the disassociation
657 * Returns: 0 on success, -1 on failure
659 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
662 * associate - Request driver to associate
663 * @priv: private driver interface data
664 * @params: association parameters
666 * Returns: 0 on success, -1 on failure
668 int (*associate)(void *priv,
669 struct wpa_driver_associate_params *params);
672 * set_auth_alg - Set IEEE 802.11 authentication algorithm
673 * @priv: private driver interface data
674 * @auth_alg: bit field of AUTH_ALG_*
676 * If the driver supports more than one authentication algorithm at the
677 * same time, it should configure all supported algorithms. If not, one
678 * algorithm needs to be selected arbitrarily. Open System
679 * authentication should be ok for most cases and it is recommended to
680 * be used if other options are not supported. Static WEP configuration
681 * may also use Shared Key authentication and LEAP requires its own
682 * algorithm number. For LEAP, user can make sure that only one
683 * algorithm is used at a time by configuring LEAP as the only
684 * supported EAP method. This information is also available in
685 * associate() params, so set_auth_alg may not be needed in case of
688 * Returns: 0 on success, -1 on failure
690 int (*set_auth_alg)(void *priv, int auth_alg);
693 * add_pmkid - Add PMKSA cache entry to the driver
694 * @priv: private driver interface data
695 * @bssid: BSSID for the PMKSA cache entry
696 * @pmkid: PMKID for the PMKSA cache entry
698 * Returns: 0 on success, -1 on failure
700 * This function is called when a new PMK is received, as a result of
701 * either normal authentication or RSN pre-authentication.
703 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
704 * associate(), add_pmkid() can be used to add new PMKSA cache entries
705 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
706 * driver_ops function does not need to be implemented. Likewise, if
707 * the driver does not support WPA, this function is not needed.
709 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
712 * remove_pmkid - Remove PMKSA cache entry to the driver
713 * @priv: private driver interface data
714 * @bssid: BSSID for the PMKSA cache entry
715 * @pmkid: PMKID for the PMKSA cache entry
717 * Returns: 0 on success, -1 on failure
719 * This function is called when the supplicant drops a PMKSA cache
720 * entry for any reason.
722 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
723 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
724 * between the driver and wpa_supplicant. If the driver uses wpa_ie
725 * from wpa_supplicant, this driver_ops function does not need to be
726 * implemented. Likewise, if the driver does not support WPA, this
727 * function is not needed.
729 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
732 * flush_pmkid - Flush PMKSA cache
733 * @priv: private driver interface data
735 * Returns: 0 on success, -1 on failure
737 * This function is called when the supplicant drops all PMKSA cache
738 * entries for any reason.
740 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
741 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
742 * between the driver and wpa_supplicant. If the driver uses wpa_ie
743 * from wpa_supplicant, this driver_ops function does not need to be
744 * implemented. Likewise, if the driver does not support WPA, this
745 * function is not needed.
747 int (*flush_pmkid)(void *priv);
750 * flush_pmkid - Flush PMKSA cache
751 * @priv: private driver interface data
753 * Returns: 0 on success, -1 on failure
755 * Get driver/firmware/hardware capabilities.
757 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
760 * poll - Poll driver for association information
761 * @priv: private driver interface data
763 * This is an option callback that can be used when the driver does not
764 * provide event mechanism for association events. This is called when
765 * receiving WPA EAPOL-Key messages that require association
766 * information. The driver interface is supposed to generate associnfo
767 * event before returning from this callback function. In addition, the
768 * driver interface should generate an association event after having
769 * sent out associnfo.
771 void (*poll)(void *priv);
774 * get_ifname - Get interface name
775 * @priv: private driver interface data
777 * Returns: Pointer to the interface name. This can differ from the
778 * interface name used in init() call. Init() is called first.
780 * This optional function can be used to allow the driver interface to
781 * replace the interface name with something else, e.g., based on an
782 * interface mapping from a more descriptive name.
784 const char * (*get_ifname)(void *priv);
787 * get_mac_addr - Get own MAC address
788 * @priv: private driver interface data
790 * Returns: Pointer to own MAC address or %NULL on failure
792 * This optional function can be used to get the own MAC address of the
793 * device from the driver interface code. This is only needed if the
794 * l2_packet implementation for the OS does not provide easy access to
796 const u8 * (*get_mac_addr)(void *priv);
799 * send_eapol - Optional function for sending EAPOL packets
800 * @priv: private driver interface data
801 * @dest: Destination MAC address
803 * @data: EAPOL packet starting with IEEE 802.1X header
804 * @data_len: Size of the EAPOL packet
806 * Returns: 0 on success, -1 on failure
808 * This optional function can be used to override l2_packet operations
809 * with driver specific functionality. If this function pointer is set,
810 * l2_packet module is not used at all and the driver interface code is
811 * responsible for receiving and sending all EAPOL packets. The
812 * received EAPOL packets are sent to core code by calling
813 * wpa_supplicant_rx_eapol(). The driver interface is required to
814 * implement get_mac_addr() handler if send_eapol() is used.
816 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
817 const u8 *data, size_t data_len);
820 * set_operstate - Sets device operating state to DORMANT or UP
821 * @priv: private driver interface data
822 * @state: 0 = dormant, 1 = up
823 * Returns: 0 on success, -1 on failure
825 * This is an optional function that can be used on operating systems
826 * that support a concept of controlling network device state from user
827 * space applications. This function, if set, gets called with
828 * state = 1 when authentication has been completed and with state = 0
829 * when connection is lost.
831 int (*set_operstate)(void *priv, int state);
834 * mlme_setprotection - MLME-SETPROTECTION.request primitive
835 * @priv: Private driver interface data
836 * @addr: Address of the station for which to set protection (may be
837 * %NULL for group keys)
838 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
839 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
840 * Returns: 0 on success, -1 on failure
842 * This is an optional function that can be used to set the driver to
843 * require protection for Tx and/or Rx frames. This uses the layer
844 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
845 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
846 * set protection operation; instead, they set protection implicitly
847 * based on configured keys.
849 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
853 * get_hw_feature_data - Get hardware support data (channels and rates)
854 * @priv: Private driver interface data
855 * @num_modes: Variable for returning the number of returned modes
856 * flags: Variable for returning hardware feature flags
857 * Returns: Pointer to allocated hardware data on success or %NULL on
858 * failure. Caller is responsible for freeing this.
860 * This function is only needed for drivers that export MLME
861 * (management frame processing) to wpa_supplicant.
863 struct wpa_hw_modes * (*get_hw_feature_data)(void *priv,
868 * set_channel - Set channel
869 * @priv: Private driver interface data
870 * @phymode: WPA_MODE_IEEE80211B, ..
871 * @chan: IEEE 802.11 channel number
872 * @freq: Frequency of the channel in MHz
873 * Returns: 0 on success, -1 on failure
875 * This function is only needed for drivers that export MLME
876 * (management frame processing) to wpa_supplicant.
878 int (*set_channel)(void *priv, wpa_hw_mode phymode, int chan,
882 * set_ssid - Set SSID
883 * @priv: Private driver interface data
885 * @ssid_len: SSID length
886 * Returns: 0 on success, -1 on failure
888 * This function is only needed for drivers that export MLME
889 * (management frame processing) to wpa_supplicant.
891 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
894 * set_bssid - Set BSSID
895 * @priv: Private driver interface data
897 * Returns: 0 on success, -1 on failure
899 * This function is only needed for drivers that export MLME
900 * (management frame processing) to wpa_supplicant.
902 int (*set_bssid)(void *priv, const u8 *bssid);
905 * send_mlme - Send management frame from MLME
906 * @priv: Private driver interface data
907 * @data: IEEE 802.11 management frame with IEEE 802.11 header
908 * @data_len: Size of the management frame
909 * Returns: 0 on success, -1 on failure
911 * This function is only needed for drivers that export MLME
912 * (management frame processing) to wpa_supplicant.
914 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
917 * mlme_add_sta - Add a STA entry into the driver/netstack
918 * @priv: Private driver interface data
919 * @addr: MAC address of the STA (e.g., BSSID of the AP)
920 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
921 * format (one octet per rate, 1 = 0.5 Mbps)
922 * @supp_rates_len: Number of entries in supp_rates
923 * Returns: 0 on success, -1 on failure
925 * This function is only needed for drivers that export MLME
926 * (management frame processing) to wpa_supplicant. When the MLME code
927 * completes association with an AP, this function is called to
928 * configure the driver/netstack with a STA entry for data frame
929 * processing (TX rate control, encryption/decryption).
931 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
932 size_t supp_rates_len);
935 * mlme_remove_sta - Remove a STA entry from the driver/netstack
936 * @priv: Private driver interface data
937 * @addr: MAC address of the STA (e.g., BSSID of the AP)
938 * Returns: 0 on success, -1 on failure
940 * This function is only needed for drivers that export MLME
941 * (management frame processing) to wpa_supplicant.
943 int (*mlme_remove_sta)(void *priv, const u8 *addr);
946 * update_ft_ies - Update FT (IEEE 802.11r) IEs
947 * @priv: Private driver interface data
948 * @md: Mobility domain (2 octets) (also included inside ies)
949 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
950 * @ies_len: Length of FT IEs in bytes
951 * Returns: 0 on success, -1 on failure
953 * The supplicant uses this callback to let the driver know that keying
954 * material for FT is available and that the driver can use the
955 * provided IEs in the next message in FT authentication sequence.
957 * This function is only needed for driver that support IEEE 802.11r
958 * (Fast BSS Transition).
960 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
964 * send_ft_action - Send FT Action frame (IEEE 802.11r)
965 * @priv: Private driver interface data
966 * @action: Action field value
967 * @target_ap: Target AP address
968 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
969 * @ies_len: Length of FT IEs in bytes
970 * Returns: 0 on success, -1 on failure
972 * The supplicant uses this callback to request the driver to transmit
973 * an FT Action frame (action category 6) for over-the-DS fast BSS
976 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
977 const u8 *ies, size_t ies_len);
980 * get_scan_results2 - Fetch the latest scan results
981 * @priv: private driver interface data
983 * Returns: Allocated buffer of scan results (caller is responsible for
984 * freeing the data structure) on success, NULL on failure
986 struct wpa_scan_results * (*get_scan_results2)(void *priv);
989 * set_probe_req_ie - Set information element(s) for Probe Request
990 * @priv: private driver interface data
991 * @ies: Information elements to append or %NULL to remove extra IEs
992 * @ies_len: Length of the IE buffer in octets
993 * Returns: 0 on success, -1 on failure
995 int (*set_probe_req_ie)(void *priv, const u8 *ies, size_t ies_len);
998 * set_mode - Request driver to set the operating mode
999 * @priv: private driver interface data
1000 * @mode: Operation mode (infra/ibss) IEEE80211_MODE_*
1002 * This handler will be called before any key configuration and call to
1003 * associate() handler in order to allow the operation mode to be
1004 * configured as early as possible. This information is also available
1005 * in associate() params and as such, some driver wrappers may not need
1006 * to implement set_mode() handler.
1007 * Returns: 0 on success, -1 on failure
1009 int (*set_mode)(void *priv, int mode);
1012 * set_country - Set country
1013 * @priv: Private driver interface data
1014 * @alpha2: country to which to switch to
1015 * Returns: 0 on success, -1 on failure
1017 * This function is for drivers which support some form
1018 * of setting a regulatory domain.
1020 int (*set_country)(void *priv, const char *alpha2);
1023 * global_init - Global driver initialization
1024 * Returns: Pointer to private data (global), %NULL on failure
1026 * This optional function is called to initialize the driver wrapper
1027 * for global data, i.e., data that applies to all interfaces. If this
1028 * function is implemented, global_deinit() will also need to be
1029 * implemented to free the private data. The driver will also likely
1030 * use init2() function instead of init() to get the pointer to global
1031 * data available to per-interface initializer.
1033 void * (*global_init)(void);
1036 * global_deinit - Global driver deinitialization
1037 * @priv: private driver global data from global_init()
1039 * Terminate any global driver related functionality and free the
1040 * global data structure.
1042 void (*global_deinit)(void *priv);
1045 * init2 - Initialize driver interface (with global data)
1046 * @ctx: context to be used when calling wpa_supplicant functions,
1047 * e.g., wpa_supplicant_event()
1048 * @ifname: interface name, e.g., wlan0
1049 * @global_priv: private driver global data from global_init()
1050 * Returns: Pointer to private data, %NULL on failure
1052 * This function can be used instead of init() if the driver wrapper
1055 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1058 * get_interfaces - Get information about available interfaces
1059 * @global_priv: private driver global data from global_init()
1060 * Returns: Allocated buffer of interface information (caller is
1061 * responsible for freeing the data structure) on success, NULL on
1064 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1067 * scan2 - Request the driver to initiate scan
1068 * @priv: private driver interface data
1069 * @params: Scan parameters
1071 * Returns: 0 on success, -1 on failure
1073 * Once the scan results are ready, the driver should report scan
1074 * results event for wpa_supplicant which will eventually request the
1075 * results with wpa_driver_get_scan_results2().
1077 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1080 /* Function to check whether a driver is for wired connections */
1081 static inline int IS_WIRED(const struct wpa_driver_ops *drv)
1083 return os_strcmp(drv->name, "wired") == 0 ||
1084 os_strcmp(drv->name, "roboswitch") == 0;
1088 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1090 typedef enum wpa_event_type {
1092 * EVENT_ASSOC - Association completed
1094 * This event needs to be delivered when the driver completes IEEE
1095 * 802.11 association or reassociation successfully.
1096 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1097 * after this event has been generated. In addition, optional
1098 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1099 * more information about the association. If the driver interface gets
1100 * both of these events at the same time, it can also include the
1101 * assoc_info data in EVENT_ASSOC call.
1106 * EVENT_DISASSOC - Association lost
1108 * This event should be called when association is lost either due to
1109 * receiving deauthenticate or disassociate frame from the AP or when
1110 * sending either of these frames to the current AP.
1115 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1117 * This event must be delivered when a Michael MIC error is detected by
1118 * the local driver. Additional data for event processing is
1119 * provided with union wpa_event_data::michael_mic_failure. This
1120 * information is used to request new encyption key and to initiate
1121 * TKIP countermeasures if needed.
1123 EVENT_MICHAEL_MIC_FAILURE,
1126 * EVENT_SCAN_RESULTS - Scan results available
1128 * This event must be called whenever scan results are available to be
1129 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1130 * is expected to be used some time after struct wpa_driver_ops::scan()
1131 * is called. If the driver provides an unsolicited event when the scan
1132 * has been completed, this event can be used to trigger
1133 * EVENT_SCAN_RESULTS call. If such event is not available from the
1134 * driver, the driver wrapper code is expected to use a registered
1135 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1136 * scan is expected to be completed.
1141 * EVENT_ASSOCINFO - Report optional extra information for association
1143 * This event can be used to report extra association information for
1144 * EVENT_ASSOC processing. This extra information includes IEs from
1145 * association frames and Beacon/Probe Response frames in union
1146 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1147 * EVENT_ASSOC. Alternatively, the driver interface can include
1148 * assoc_info data in the EVENT_ASSOC call if it has all the
1149 * information available at the same point.
1154 * EVENT_INTERFACE_STATUS - Report interface status changes
1156 * This optional event can be used to report changes in interface
1157 * status (interface added/removed) using union
1158 * wpa_event_data::interface_status. This can be used to trigger
1159 * wpa_supplicant to stop and re-start processing for the interface,
1160 * e.g., when a cardbus card is ejected/inserted.
1162 EVENT_INTERFACE_STATUS,
1165 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1167 * This event can be used to inform wpa_supplicant about candidates for
1168 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1169 * for scan request (ap_scan=2 mode), this event is required for
1170 * pre-authentication. If wpa_supplicant is performing scan request
1171 * (ap_scan=1), this event is optional since scan results can be used
1172 * to add pre-authentication candidates. union
1173 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1174 * candidate and priority of the candidate, e.g., based on the signal
1175 * strength, in order to try to pre-authenticate first with candidates
1176 * that are most likely targets for re-association.
1178 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1179 * on the candidate list. In addition, it can be called for the current
1180 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1181 * will automatically skip pre-authentication in cases where a valid
1182 * PMKSA exists. When more than one candidate exists, this event should
1183 * be generated once for each candidate.
1185 * Driver will be notified about successful pre-authentication with
1186 * struct wpa_driver_ops::add_pmkid() calls.
1188 EVENT_PMKID_CANDIDATE,
1191 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1193 * This event can be used to inform wpa_supplicant about desire to set
1194 * up secure direct link connection between two stations as defined in
1195 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1196 * STAKey negotiation. The caller will need to set peer address for the
1202 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1204 * The driver is expected to report the received FT IEs from
1205 * FT authentication sequence from the AP. The FT IEs are included in
1206 * the extra information in union wpa_event_data::ft_ies.
1211 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
1213 * The driver can use this event to inform wpa_supplicant about a STA
1214 * in an IBSS with which protected frames could be exchanged. This
1215 * event starts RSN authentication with the other STA to authenticate
1216 * the STA and set up encryption keys with it.
1218 EVENT_IBSS_RSN_START
1223 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
1225 union wpa_event_data {
1227 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
1229 * This structure is optional for EVENT_ASSOC calls and required for
1230 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
1231 * driver interface does not need to generate separate EVENT_ASSOCINFO
1236 * req_ies - (Re)Association Request IEs
1238 * If the driver generates WPA/RSN IE, this event data must be
1239 * returned for WPA handshake to have needed information. If
1240 * wpa_supplicant-generated WPA/RSN IE is used, this
1241 * information event is optional.
1243 * This should start with the first IE (fixed fields before IEs
1244 * are not included).
1249 * req_ies_len - Length of req_ies in bytes
1254 * resp_ies - (Re)Association Response IEs
1256 * Optional association data from the driver. This data is not
1257 * required WPA, but may be useful for some protocols and as
1258 * such, should be reported if this is available to the driver
1261 * This should start with the first IE (fixed fields before IEs
1262 * are not included).
1267 * resp_ies_len - Length of resp_ies in bytes
1269 size_t resp_ies_len;
1272 * beacon_ies - Beacon or Probe Response IEs
1274 * Optional Beacon/ProbeResp data: IEs included in Beacon or
1275 * Probe Response frames from the current AP (i.e., the one
1276 * that the client just associated with). This information is
1277 * used to update WPA/RSN IE for the AP. If this field is not
1278 * set, the results from previous scan will be used. If no
1279 * data for the new AP is found, scan results will be requested
1280 * again (without scan request). At this point, the driver is
1281 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
1284 * This should start with the first IE (fixed fields before IEs
1285 * are not included).
1290 * beacon_ies_len - Length of beacon_ies */
1291 size_t beacon_ies_len;
1295 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
1297 struct michael_mic_failure {
1299 } michael_mic_failure;
1302 * struct interface_status - Data for EVENT_INTERFACE_STATUS
1304 struct interface_status {
1307 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
1312 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
1314 struct pmkid_candidate {
1315 /** BSSID of the PMKID candidate */
1317 /** Smaller the index, higher the priority */
1319 /** Whether RSN IE includes pre-authenticate flag */
1324 * struct stkstart - Data for EVENT_STKSTART
1331 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
1333 * During FT (IEEE 802.11r) authentication sequence, the driver is
1334 * expected to use this event to report received FT IEs (MDIE, FTIE,
1335 * RSN IE, TIE, possible resource request) to the supplicant. The FT
1336 * IEs for the next message will be delivered through the
1337 * struct wpa_driver_ops::update_ft_ies() callback.
1343 u8 target_ap[ETH_ALEN];
1347 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
1349 struct ibss_rsn_start {
1355 * wpa_supplicant_event - Report a driver event for wpa_supplicant
1356 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1357 * with struct wpa_driver_ops::init()
1358 * @event: event type (defined above)
1359 * @data: possible extra data for the event
1361 * Driver wrapper code should call this function whenever an event is received
1364 void wpa_supplicant_event(void *ctx, wpa_event_type event,
1365 union wpa_event_data *data);
1368 * wpa_supplicant_rx_eapol - Deliver a received EAPOL frame to wpa_supplicant
1369 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1370 * with struct wpa_driver_ops::init()
1371 * @src_addr: Source address of the EAPOL frame
1372 * @buf: EAPOL data starting from the EAPOL header (i.e., no Ethernet header)
1373 * @len: Length of the EAPOL data
1375 * This function is called for each received EAPOL frame. Most driver
1376 * interfaces rely on more generic OS mechanism for receiving frames through
1377 * l2_packet, but if such a mechanism is not available, the driver wrapper may
1378 * take care of received EAPOL frames and deliver them to the core supplicant
1379 * code by calling this function.
1381 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
1382 const u8 *buf, size_t len);
1384 void wpa_supplicant_sta_rx(void *ctx, const u8 *buf, size_t len,
1385 struct ieee80211_rx_status *rx_status);
1386 void wpa_supplicant_sta_free_hw_features(struct wpa_hw_modes *hw_features,
1387 size_t num_hw_features);
1389 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie);
1390 #define WPA_IE_VENDOR_TYPE 0x0050f201
1391 #define WPS_IE_VENDOR_TYPE 0x0050f204
1392 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
1394 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
1396 int wpa_scan_get_max_rate(const struct wpa_scan_res *res);
1397 void wpa_scan_results_free(struct wpa_scan_results *res);
1398 void wpa_scan_sort_results(struct wpa_scan_results *res);
1400 #endif /* DRIVER_H */