2 * WPA Supplicant - driver interface definition
3 * Copyright (c) 2003-2009, 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 HOSTAPD_CHAN_DISABLED 0x00000001
23 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
24 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
25 #define HOSTAPD_CHAN_RADAR 0x00000008
27 struct hostapd_channel_data {
28 short chan; /* channel number (IEEE 802.11) */
29 short freq; /* frequency in MHz */
30 int flag; /* flag for hostapd use (HOSTAPD_CHAN_*) */
31 u8 max_tx_power; /* maximum transmit power in dBm */
34 #define HOSTAPD_RATE_ERP 0x00000001
35 #define HOSTAPD_RATE_BASIC 0x00000002
36 #define HOSTAPD_RATE_PREAMBLE2 0x00000004
37 #define HOSTAPD_RATE_SUPPORTED 0x00000010
38 #define HOSTAPD_RATE_OFDM 0x00000020
39 #define HOSTAPD_RATE_CCK 0x00000040
40 #define HOSTAPD_RATE_MANDATORY 0x00000100
42 struct hostapd_rate_data {
43 int rate; /* rate in 100 kbps */
44 int flags; /* HOSTAPD_RATE_ flags */
47 struct hostapd_hw_modes {
50 struct hostapd_channel_data *channels;
52 struct hostapd_rate_data *rates;
58 #define AUTH_ALG_OPEN_SYSTEM 0x01
59 #define AUTH_ALG_SHARED_KEY 0x02
60 #define AUTH_ALG_LEAP 0x04
61 #define AUTH_ALG_FT 0x08
63 #define IEEE80211_MODE_INFRA 0
64 #define IEEE80211_MODE_IBSS 1
65 #define IEEE80211_MODE_AP 2
67 #define IEEE80211_CAP_ESS 0x0001
68 #define IEEE80211_CAP_IBSS 0x0002
69 #define IEEE80211_CAP_PRIVACY 0x0010
71 #define SSID_MAX_WPA_IE_LEN 40
73 * struct wpa_scan_result - Scan results (old structure)
76 * @ssid_len: length of the ssid
78 * @wpa_ie_len: length of the wpa_ie
80 * @rsn_ie_len: length of the RSN IE
81 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
82 * @caps: capability information field in host byte order
83 * @qual: signal quality
85 * @level: signal level
86 * @maxrate: maximum supported rate
87 * @mdie_present: Whether MDIE was included in Beacon/ProbeRsp frame
88 * @mdie: Mobility domain identifier IE (IEEE 802.11r MDIE) (starting from
92 * This structure is used as a generic format for scan results from the
93 * driver. Each driver interface implementation is responsible for converting
94 * the driver or OS specific scan results into this format.
96 * This structure is the old data structure used for scan results. It is
97 * obsoleted by the new struct wpa_scan_res structure and the old version is
98 * only included for backwards compatibility with existing driver wrapper
99 * implementations. New implementations are encouraged to implement for struct
100 * wpa_scan_res. The old structure will be removed at some point.
102 struct wpa_scan_result {
106 u8 wpa_ie[SSID_MAX_WPA_IE_LEN];
108 u8 rsn_ie[SSID_MAX_WPA_IE_LEN];
122 #define WPA_SCAN_QUAL_INVALID BIT(0)
123 #define WPA_SCAN_NOISE_INVALID BIT(1)
124 #define WPA_SCAN_LEVEL_INVALID BIT(2)
125 #define WPA_SCAN_LEVEL_DBM BIT(3)
128 * struct wpa_scan_res - Scan result for an BSS/IBSS
129 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
131 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
132 * @beacon_int: beacon interval in TUs (host byte order)
133 * @caps: capability information field in host byte order
134 * @qual: signal quality
135 * @noise: noise level
136 * @level: signal level
138 * @age: Age of the information in milliseconds (i.e., how many milliseconds
139 * ago the last Beacon or Probe Response frame was received)
140 * @ie_len: length of the following IE field in octets
142 * This structure is used as a generic format for scan results from the
143 * driver. Each driver interface implementation is responsible for converting
144 * the driver or OS specific scan results into this format.
146 * If the driver does not support reporting all IEs, the IE data structure is
147 * constructed of the IEs that are available. This field will also need to
148 * include SSID in IE format. All drivers are encouraged to be extended to
149 * report all IEs to make it easier to support future additions.
151 struct wpa_scan_res {
163 /* followed by ie_len octets of IEs */
167 * struct wpa_scan_results - Scan results
168 * @res: Array of pointers to allocated variable length scan result entries
169 * @num: Number of entries in the scan result array
171 struct wpa_scan_results {
172 struct wpa_scan_res **res;
177 * struct wpa_interface_info - Network interface information
178 * @next: Pointer to the next interface or NULL if this is the last one
179 * @ifname: Interface name that can be used with init() or init2()
180 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
182 * @drv_bame: struct wpa_driver_ops::name (note: unlike other strings, this one
183 * is not an allocated copy, i.e., get_interfaces() caller will not free
186 struct wpa_interface_info {
187 struct wpa_interface_info *next;
190 const char *drv_name;
193 #define WPAS_MAX_SCAN_SSIDS 4
196 * struct wpa_driver_scan_params - Scan parameters
197 * Data for struct wpa_driver_ops::scan2().
199 struct wpa_driver_scan_params {
201 * ssids - SSIDs to scan for
203 struct wpa_driver_scan_ssid {
205 * ssid - specific SSID to scan for (ProbeReq)
206 * %NULL or zero-length SSID is used to indicate active scan
207 * with wildcard SSID.
211 * ssid_len: Length of the SSID in octets
214 } ssids[WPAS_MAX_SCAN_SSIDS];
217 * num_ssids - Number of entries in ssids array
218 * Zero indicates a request for a passive scan.
223 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
228 * extra_ies_len - Length of extra_ies in octets
230 size_t extra_ies_len;
233 * freqs - Array of frequencies to scan or %NULL for all frequencies
235 * The frequency is set in MHz. The array is zero-terminated.
241 * struct wpa_driver_auth_params - Authentication parameters
242 * Data for struct wpa_driver_ops::authenticate().
244 struct wpa_driver_auth_params {
252 const u8 *wep_key[4];
253 size_t wep_key_len[4];
258 * struct wpa_driver_associate_params - Association parameters
259 * Data for struct wpa_driver_ops::associate().
261 struct wpa_driver_associate_params {
263 * bssid - BSSID of the selected AP
264 * This can be %NULL, if ap_scan=2 mode is used and the driver is
265 * responsible for selecting with which BSS to associate. */
269 * ssid - The selected SSID
275 * freq - Frequency of the channel the selected AP is using
276 * Frequency that the selected AP is using (in MHz as
277 * reported in the scan results)
282 * wpa_ie - WPA information element for (Re)Association Request
283 * WPA information element to be included in (Re)Association
284 * Request (including information element id and length). Use
285 * of this WPA IE is optional. If the driver generates the WPA
286 * IE, it can use pairwise_suite, group_suite, and
287 * key_mgmt_suite to select proper algorithms. In this case,
288 * the driver has to notify wpa_supplicant about the used WPA
289 * IE by generating an event that the interface code will
290 * convert into EVENT_ASSOCINFO data (see below).
292 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
293 * instead. The driver can determine which version is used by
294 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
297 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
301 * wpa_ie_len - length of the wpa_ie
305 /* The selected pairwise/group cipher and key management
306 * suites. These are usually ignored if @wpa_ie is used. */
307 wpa_cipher pairwise_suite;
308 wpa_cipher group_suite;
309 wpa_key_mgmt key_mgmt_suite;
312 * auth_alg - Allowed authentication algorithms
313 * Bit field of AUTH_ALG_*
318 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
323 * wep_key - WEP keys for static WEP configuration
325 const u8 *wep_key[4];
328 * wep_key_len - WEP key length for static WEP configuration
330 size_t wep_key_len[4];
333 * wep_tx_keyidx - WEP TX key index for static WEP configuration
338 * mgmt_frame_protection - IEEE 802.11w management frame protection
341 NO_MGMT_FRAME_PROTECTION,
342 MGMT_FRAME_PROTECTION_OPTIONAL,
343 MGMT_FRAME_PROTECTION_REQUIRED
344 } mgmt_frame_protection;
347 * ft_ies - IEEE 802.11r / FT information elements
348 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
349 * for fast transition, this parameter is set to include the IEs that
350 * are to be sent in the next FT Authentication Request message.
351 * update_ft_ies() handler is called to update the IEs for further
352 * FT messages in the sequence.
354 * The driver should use these IEs only if the target AP is advertising
355 * the same mobility domain as the one included in the MDIE here.
357 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
358 * AP after the initial association. These IEs can only be used if the
359 * target AP is advertising support for FT and is using the same MDIE
360 * and SSID as the current AP.
362 * The driver is responsible for reporting the FT IEs received from the
363 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
364 * type. update_ft_ies() handler will then be called with the FT IEs to
365 * include in the next frame in the authentication sequence.
370 * ft_ies_len - Length of ft_ies in bytes
375 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
377 * This value is provided to allow the driver interface easier access
378 * to the current mobility domain. This value is set to %NULL if no
379 * mobility domain is currently active.
384 * passphrase - RSN passphrase for PSK
386 * This value is made available only for WPA/WPA2-Personal (PSK) and
387 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
388 * the 8..63 character ASCII passphrase, if available. Please note that
389 * this can be %NULL if passphrase was not used to generate the PSK. In
390 * that case, the psk field must be used to fetch the PSK.
392 const char *passphrase;
395 * psk - RSN PSK (alternative for passphrase for PSK)
397 * This value is made available only for WPA/WPA2-Personal (PSK) and
398 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
399 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
400 * be prepared to handle %NULL value as an error.
405 * drop_unencrypted - Enable/disable unencrypted frame filtering
407 * Configure the driver to drop all non-EAPOL frames (both receive and
408 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
409 * still be allowed for key negotiation.
411 int drop_unencrypted;
414 * prev_bssid - Previously used BSSID in this ESS
416 * When not %NULL, this is a request to use reassociation instead of
419 const u8 *prev_bssid;
423 * struct wpa_driver_capa - Driver capability information
425 struct wpa_driver_capa {
426 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
427 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
428 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
429 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
430 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
431 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
432 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
433 unsigned int key_mgmt;
435 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
436 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
437 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
438 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
441 #define WPA_DRIVER_AUTH_OPEN 0x00000001
442 #define WPA_DRIVER_AUTH_SHARED 0x00000002
443 #define WPA_DRIVER_AUTH_LEAP 0x00000004
446 /* Driver generated WPA/RSN IE */
447 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
448 /* Driver needs static WEP key setup after association command */
449 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
450 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
451 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
452 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
453 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
454 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
455 /* Driver provides separate commands for authentication and association (SME in
456 * wpa_supplicant). */
457 #define WPA_DRIVER_FLAGS_SME 0x00000020
458 /* Driver supports AP mode */
459 #define WPA_DRIVER_FLAGS_AP 0x00000040
460 /* Driver needs static WEP key setup after association has been completed */
461 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
468 struct ieee80211_rx_status {
476 struct hostap_sta_driver_data {
477 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
478 unsigned long current_tx_rate;
479 unsigned long inactive_msec;
481 unsigned long num_ps_buf_frames;
482 unsigned long tx_retry_failed;
483 unsigned long tx_retry_count;
488 struct hostapd_sta_add_params {
492 const u8 *supp_rates;
493 size_t supp_rates_len;
496 const struct ht_cap_ie *ht_capabilities;
499 struct hostapd_freq_params {
504 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
505 * secondary channel below primary, 1 = HT40
506 * enabled, secondary channel above primary */
509 enum hostapd_driver_if_type {
513 struct wpa_init_params {
518 const char *test_socket;
519 int use_pae_group_addr;
523 u8 *own_addr; /* buffer for writing own MAC address */
528 * struct wpa_driver_ops - Driver interface API definition
530 * This structure defines the API that each driver interface needs to implement
531 * for core wpa_supplicant code. All driver specific functionality is captured
534 struct wpa_driver_ops {
535 /** Name of the driver interface */
537 /** One line description of the driver interface */
541 * get_bssid - Get the current BSSID
542 * @priv: private driver interface data
543 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
545 * Returns: 0 on success, -1 on failure
547 * Query kernel driver for the current BSSID and copy it to bssid.
548 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
551 int (*get_bssid)(void *priv, u8 *bssid);
554 * get_ssid - Get the current SSID
555 * @priv: private driver interface data
556 * @ssid: buffer for SSID (at least 32 bytes)
558 * Returns: Length of the SSID on success, -1 on failure
560 * Query kernel driver for the current SSID and copy it to ssid.
561 * Returning zero is recommended if the STA is not associated.
563 * Note: SSID is an array of octets, i.e., it is not nul terminated and
564 * can, at least in theory, contain control characters (including nul)
565 * and as such, should be processed as binary data, not a printable
568 int (*get_ssid)(void *priv, u8 *ssid);
571 * set_wpa - Enable/disable WPA support (OBSOLETE)
572 * @priv: private driver interface data
573 * @enabled: 1 = enable, 0 = disable
575 * Returns: 0 on success, -1 on failure
577 * Note: This function is included for backwards compatibility. This is
578 * called only just after init and just before deinit, so these
579 * functions can be used to implement same functionality and the driver
580 * interface need not define this function.
582 * Configure the kernel driver to enable/disable WPA support. This may
583 * be empty function, if WPA support is always enabled. Common
584 * configuration items are WPA IE (clearing it when WPA support is
585 * disabled), Privacy flag configuration for capability field (note:
586 * this the value need to set in associate handler to allow plaintext
587 * mode to be used) when trying to associate with, roaming mode (can
588 * allow wpa_supplicant to control roaming if ap_scan=1 is used;
589 * however, drivers can also implement roaming if desired, especially
590 * ap_scan=2 mode is used for this).
592 int (*set_wpa)(void *priv, int enabled);
595 * set_key - Configure encryption key
596 * @priv: private driver interface data
597 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
598 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
599 * %WPA_ALG_NONE clears the key.
600 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
601 * broadcast/default keys
602 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
604 * @set_tx: configure this key as the default Tx key (only used when
605 * driver does not support separate unicast/individual key
606 * @seq: sequence number/packet number, seq_len octets, the next
607 * packet number to be used for in replay protection; configured
608 * for Rx keys (in most cases, this is only used with broadcast
609 * keys and set to zero for unicast keys)
610 * @seq_len: length of the seq, depends on the algorithm:
611 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
612 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
614 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
615 * TKIP: 32, CCMP: 16, IGTK: 16)
617 * Returns: 0 on success, -1 on failure
619 * Configure the given key for the kernel driver. If the driver
620 * supports separate individual keys (4 default keys + 1 individual),
621 * addr can be used to determine whether the key is default or
622 * individual. If only 4 keys are supported, the default key with key
623 * index 0 is used as the individual key. STA must be configured to use
624 * it as the default Tx key (set_tx is set) and accept Rx for all the
625 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
626 * broadcast keys, so key index 0 is available for this kind of
629 * Please note that TKIP keys include separate TX and RX MIC keys and
630 * some drivers may expect them in different order than wpa_supplicant
631 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
632 * will tricker Michael MIC errors. This can be fixed by changing the
633 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
634 * in driver_*.c set_key() implementation, see driver_ndis.c for an
635 * example on how this can be done.
637 int (*set_key)(void *priv, wpa_alg alg, const u8 *addr,
638 int key_idx, int set_tx, const u8 *seq, size_t seq_len,
639 const u8 *key, size_t key_len);
642 * init - Initialize driver interface
643 * @ctx: context to be used when calling wpa_supplicant functions,
644 * e.g., wpa_supplicant_event()
645 * @ifname: interface name, e.g., wlan0
647 * Returns: Pointer to private data, %NULL on failure
649 * Initialize driver interface, including event processing for kernel
650 * driver events (e.g., associated, scan results, Michael MIC failure).
651 * This function can allocate a private configuration data area for
652 * @ctx, file descriptor, interface name, etc. information that may be
653 * needed in future driver operations. If this is not used, non-NULL
654 * value will need to be returned because %NULL is used to indicate
655 * failure. The returned value will be used as 'void *priv' data for
656 * all other driver_ops functions.
658 * The main event loop (eloop.c) of wpa_supplicant can be used to
659 * register callback for read sockets (eloop_register_read_sock()).
661 * See below for more information about events and
662 * wpa_supplicant_event() function.
664 void * (*init)(void *ctx, const char *ifname);
667 * deinit - Deinitialize driver interface
668 * @priv: private driver interface data from init()
670 * Shut down driver interface and processing of driver events. Free
671 * private data buffer if one was allocated in init() handler.
673 void (*deinit)(void *priv);
676 * set_param - Set driver configuration parameters
677 * @priv: private driver interface data from init()
678 * @param: driver specific configuration parameters
680 * Returns: 0 on success, -1 on failure
682 * Optional handler for notifying driver interface about configuration
683 * parameters (driver_param).
685 int (*set_param)(void *priv, const char *param);
688 * set_countermeasures - Enable/disable TKIP countermeasures
689 * @priv: private driver interface data
690 * @enabled: 1 = countermeasures enabled, 0 = disabled
692 * Returns: 0 on success, -1 on failure
694 * Configure TKIP countermeasures. When these are enabled, the driver
695 * should drop all received and queued frames that are using TKIP.
697 int (*set_countermeasures)(void *priv, int enabled);
700 * set_drop_unencrypted - Enable/disable unencrypted frame filtering
701 * @priv: private driver interface data
702 * @enabled: 1 = unencrypted Tx/Rx frames will be dropped, 0 = disabled
704 * Returns: 0 on success, -1 on failure
706 * Configure the driver to drop all non-EAPOL frames (both receive and
707 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
708 * still be allowed for key negotiation.
710 * This function is deprecated. New driver wrapper implementations
711 * should use associate() parameter drop_unencrypted instead.
713 int (*set_drop_unencrypted)(void *priv, int enabled);
716 * scan - Request the driver to initiate scan (old version)
717 * @priv: private driver interface data
718 * @ssid: specific SSID to scan for (ProbeReq) or %NULL to scan for
719 * all SSIDs (either active scan with wildcard SSID or passive
721 * @ssid_len: length of the SSID
723 * Returns: 0 on success, -1 on failure
725 * Once the scan results are ready, the driver should report scan
726 * results event for wpa_supplicant which will eventually request the
727 * results with wpa_driver_get_scan_results().
729 * This function is deprecated. New driver wrapper implementations
730 * should implement support for scan2().
732 int (*scan)(void *priv, const u8 *ssid, size_t ssid_len);
735 * get_scan_results - Fetch the latest scan results (old version)
736 * @priv: private driver interface data
737 * @results: pointer to buffer for scan results
738 * @max_size: maximum number of entries (buffer size)
740 * Returns: Number of scan result entries used on success, -1 on
743 * If scan results include more than max_size BSSes, max_size will be
744 * returned and the remaining entries will not be included in the
747 * This function is deprecated. New driver wrapper implementations
748 * should implement support for get_scan_results2().
750 int (*get_scan_results)(void *priv,
751 struct wpa_scan_result *results,
755 * deauthenticate - Request driver to deauthenticate
756 * @priv: private driver interface data
757 * @addr: peer address (BSSID of the AP)
758 * @reason_code: 16-bit reason code to be sent in the deauthentication
761 * Returns: 0 on success, -1 on failure
763 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
766 * disassociate - Request driver to disassociate
767 * @priv: private driver interface data
768 * @addr: peer address (BSSID of the AP)
769 * @reason_code: 16-bit reason code to be sent in the disassociation
772 * Returns: 0 on success, -1 on failure
774 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
777 * associate - Request driver to associate
778 * @priv: private driver interface data
779 * @params: association parameters
781 * Returns: 0 on success, -1 on failure
783 int (*associate)(void *priv,
784 struct wpa_driver_associate_params *params);
787 * set_auth_alg - Set IEEE 802.11 authentication algorithm
788 * @priv: private driver interface data
789 * @auth_alg: bit field of AUTH_ALG_*
791 * If the driver supports more than one authentication algorithm at the
792 * same time, it should configure all supported algorithms. If not, one
793 * algorithm needs to be selected arbitrarily. Open System
794 * authentication should be ok for most cases and it is recommended to
795 * be used if other options are not supported. Static WEP configuration
796 * may also use Shared Key authentication and LEAP requires its own
797 * algorithm number. For LEAP, user can make sure that only one
798 * algorithm is used at a time by configuring LEAP as the only
799 * supported EAP method. This information is also available in
800 * associate() params, so set_auth_alg may not be needed in case of
803 * This function is deprecated. New driver wrapper implementations
804 * should use associate() parameter auth_alg instead.
806 * Returns: 0 on success, -1 on failure
808 int (*set_auth_alg)(void *priv, int auth_alg);
811 * add_pmkid - Add PMKSA cache entry to the driver
812 * @priv: private driver interface data
813 * @bssid: BSSID for the PMKSA cache entry
814 * @pmkid: PMKID for the PMKSA cache entry
816 * Returns: 0 on success, -1 on failure
818 * This function is called when a new PMK is received, as a result of
819 * either normal authentication or RSN pre-authentication.
821 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
822 * associate(), add_pmkid() can be used to add new PMKSA cache entries
823 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
824 * driver_ops function does not need to be implemented. Likewise, if
825 * the driver does not support WPA, this function is not needed.
827 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
830 * remove_pmkid - Remove PMKSA cache entry to the driver
831 * @priv: private driver interface data
832 * @bssid: BSSID for the PMKSA cache entry
833 * @pmkid: PMKID for the PMKSA cache entry
835 * Returns: 0 on success, -1 on failure
837 * This function is called when the supplicant drops a PMKSA cache
838 * entry for any reason.
840 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
841 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
842 * between the driver and wpa_supplicant. If the driver uses wpa_ie
843 * from wpa_supplicant, this driver_ops function does not need to be
844 * implemented. Likewise, if the driver does not support WPA, this
845 * function is not needed.
847 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
850 * flush_pmkid - Flush PMKSA cache
851 * @priv: private driver interface data
853 * Returns: 0 on success, -1 on failure
855 * This function is called when the supplicant drops all PMKSA cache
856 * entries for any reason.
858 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
859 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
860 * between the driver and wpa_supplicant. If the driver uses wpa_ie
861 * from wpa_supplicant, this driver_ops function does not need to be
862 * implemented. Likewise, if the driver does not support WPA, this
863 * function is not needed.
865 int (*flush_pmkid)(void *priv);
868 * get_capa - Get driver capabilities
869 * @priv: private driver interface data
871 * Returns: 0 on success, -1 on failure
873 * Get driver/firmware/hardware capabilities.
875 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
878 * poll - Poll driver for association information
879 * @priv: private driver interface data
881 * This is an option callback that can be used when the driver does not
882 * provide event mechanism for association events. This is called when
883 * receiving WPA EAPOL-Key messages that require association
884 * information. The driver interface is supposed to generate associnfo
885 * event before returning from this callback function. In addition, the
886 * driver interface should generate an association event after having
887 * sent out associnfo.
889 void (*poll)(void *priv);
892 * get_ifname - Get interface name
893 * @priv: private driver interface data
895 * Returns: Pointer to the interface name. This can differ from the
896 * interface name used in init() call. Init() is called first.
898 * This optional function can be used to allow the driver interface to
899 * replace the interface name with something else, e.g., based on an
900 * interface mapping from a more descriptive name.
902 const char * (*get_ifname)(void *priv);
905 * get_mac_addr - Get own MAC address
906 * @priv: private driver interface data
908 * Returns: Pointer to own MAC address or %NULL on failure
910 * This optional function can be used to get the own MAC address of the
911 * device from the driver interface code. This is only needed if the
912 * l2_packet implementation for the OS does not provide easy access to
914 const u8 * (*get_mac_addr)(void *priv);
917 * send_eapol - Optional function for sending EAPOL packets
918 * @priv: private driver interface data
919 * @dest: Destination MAC address
921 * @data: EAPOL packet starting with IEEE 802.1X header
922 * @data_len: Size of the EAPOL packet
924 * Returns: 0 on success, -1 on failure
926 * This optional function can be used to override l2_packet operations
927 * with driver specific functionality. If this function pointer is set,
928 * l2_packet module is not used at all and the driver interface code is
929 * responsible for receiving and sending all EAPOL packets. The
930 * received EAPOL packets are sent to core code by calling
931 * wpa_supplicant_rx_eapol(). The driver interface is required to
932 * implement get_mac_addr() handler if send_eapol() is used.
934 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
935 const u8 *data, size_t data_len);
938 * set_operstate - Sets device operating state to DORMANT or UP
939 * @priv: private driver interface data
940 * @state: 0 = dormant, 1 = up
941 * Returns: 0 on success, -1 on failure
943 * This is an optional function that can be used on operating systems
944 * that support a concept of controlling network device state from user
945 * space applications. This function, if set, gets called with
946 * state = 1 when authentication has been completed and with state = 0
947 * when connection is lost.
949 int (*set_operstate)(void *priv, int state);
952 * mlme_setprotection - MLME-SETPROTECTION.request primitive
953 * @priv: Private driver interface data
954 * @addr: Address of the station for which to set protection (may be
955 * %NULL for group keys)
956 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
957 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
958 * Returns: 0 on success, -1 on failure
960 * This is an optional function that can be used to set the driver to
961 * require protection for Tx and/or Rx frames. This uses the layer
962 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
963 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
964 * set protection operation; instead, they set protection implicitly
965 * based on configured keys.
967 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
971 * get_hw_feature_data - Get hardware support data (channels and rates)
972 * @priv: Private driver interface data
973 * @num_modes: Variable for returning the number of returned modes
974 * flags: Variable for returning hardware feature flags
975 * Returns: Pointer to allocated hardware data on success or %NULL on
976 * failure. Caller is responsible for freeing this.
978 * This function is only needed for drivers that export MLME
979 * (management frame processing) to wpa_supplicant.
981 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
986 * set_channel - Set channel
987 * @priv: Private driver interface data
988 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
989 * @chan: IEEE 802.11 channel number
990 * @freq: Frequency of the channel in MHz
991 * Returns: 0 on success, -1 on failure
993 * This function is only needed for drivers that export MLME
994 * (management frame processing) to wpa_supplicant.
996 int (*set_channel)(void *priv, hostapd_hw_mode phymode, int chan,
1000 * set_ssid - Set SSID
1001 * @priv: Private driver interface data
1003 * @ssid_len: SSID length
1004 * Returns: 0 on success, -1 on failure
1006 * This function is only needed for drivers that export MLME
1007 * (management frame processing) to wpa_supplicant.
1009 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
1012 * set_bssid - Set BSSID
1013 * @priv: Private driver interface data
1015 * Returns: 0 on success, -1 on failure
1017 * This function is only needed for drivers that export MLME
1018 * (management frame processing) to wpa_supplicant.
1020 int (*set_bssid)(void *priv, const u8 *bssid);
1023 * send_mlme - Send management frame from MLME
1024 * @priv: Private driver interface data
1025 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1026 * @data_len: Size of the management frame
1027 * Returns: 0 on success, -1 on failure
1029 * This function is only needed for drivers that export MLME
1030 * (management frame processing) to wpa_supplicant.
1032 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
1035 * mlme_add_sta - Add a STA entry into the driver/netstack
1036 * @priv: Private driver interface data
1037 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1038 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
1039 * format (one octet per rate, 1 = 0.5 Mbps)
1040 * @supp_rates_len: Number of entries in supp_rates
1041 * Returns: 0 on success, -1 on failure
1043 * This function is only needed for drivers that export MLME
1044 * (management frame processing) to wpa_supplicant. When the MLME code
1045 * completes association with an AP, this function is called to
1046 * configure the driver/netstack with a STA entry for data frame
1047 * processing (TX rate control, encryption/decryption).
1049 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
1050 size_t supp_rates_len);
1053 * mlme_remove_sta - Remove a STA entry from the driver/netstack
1054 * @priv: Private driver interface data
1055 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1056 * Returns: 0 on success, -1 on failure
1058 * This function is only needed for drivers that export MLME
1059 * (management frame processing) to wpa_supplicant.
1061 int (*mlme_remove_sta)(void *priv, const u8 *addr);
1064 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1065 * @priv: Private driver interface data
1066 * @md: Mobility domain (2 octets) (also included inside ies)
1067 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1068 * @ies_len: Length of FT IEs in bytes
1069 * Returns: 0 on success, -1 on failure
1071 * The supplicant uses this callback to let the driver know that keying
1072 * material for FT is available and that the driver can use the
1073 * provided IEs in the next message in FT authentication sequence.
1075 * This function is only needed for driver that support IEEE 802.11r
1076 * (Fast BSS Transition).
1078 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1082 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1083 * @priv: Private driver interface data
1084 * @action: Action field value
1085 * @target_ap: Target AP address
1086 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1087 * @ies_len: Length of FT IEs in bytes
1088 * Returns: 0 on success, -1 on failure
1090 * The supplicant uses this callback to request the driver to transmit
1091 * an FT Action frame (action category 6) for over-the-DS fast BSS
1094 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1095 const u8 *ies, size_t ies_len);
1098 * get_scan_results2 - Fetch the latest scan results
1099 * @priv: private driver interface data
1101 * Returns: Allocated buffer of scan results (caller is responsible for
1102 * freeing the data structure) on success, NULL on failure
1104 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1107 * set_probe_req_ie - Set information element(s) for Probe Request
1108 * @priv: private driver interface data
1109 * @ies: Information elements to append or %NULL to remove extra IEs
1110 * @ies_len: Length of the IE buffer in octets
1111 * Returns: 0 on success, -1 on failure
1113 int (*set_probe_req_ie)(void *priv, const u8 *ies, size_t ies_len);
1116 * set_mode - Request driver to set the operating mode
1117 * @priv: private driver interface data
1118 * @mode: Operation mode (infra/ibss) IEEE80211_MODE_*
1120 * This handler will be called before any key configuration and call to
1121 * associate() handler in order to allow the operation mode to be
1122 * configured as early as possible. This information is also available
1123 * in associate() params and as such, driver wrappers may not need
1124 * to implement set_mode() handler.
1126 * This function is deprecated. New driver wrapper implementations
1127 * should use associate() parameter mode instead.
1129 * Returns: 0 on success, -1 on failure
1131 int (*set_mode)(void *priv, int mode);
1134 * set_country - Set country
1135 * @priv: Private driver interface data
1136 * @alpha2: country to which to switch to
1137 * Returns: 0 on success, -1 on failure
1139 * This function is for drivers which support some form
1140 * of setting a regulatory domain.
1142 int (*set_country)(void *priv, const char *alpha2);
1145 * global_init - Global driver initialization
1146 * Returns: Pointer to private data (global), %NULL on failure
1148 * This optional function is called to initialize the driver wrapper
1149 * for global data, i.e., data that applies to all interfaces. If this
1150 * function is implemented, global_deinit() will also need to be
1151 * implemented to free the private data. The driver will also likely
1152 * use init2() function instead of init() to get the pointer to global
1153 * data available to per-interface initializer.
1155 void * (*global_init)(void);
1158 * global_deinit - Global driver deinitialization
1159 * @priv: private driver global data from global_init()
1161 * Terminate any global driver related functionality and free the
1162 * global data structure.
1164 void (*global_deinit)(void *priv);
1167 * init2 - Initialize driver interface (with global data)
1168 * @ctx: context to be used when calling wpa_supplicant functions,
1169 * e.g., wpa_supplicant_event()
1170 * @ifname: interface name, e.g., wlan0
1171 * @global_priv: private driver global data from global_init()
1172 * Returns: Pointer to private data, %NULL on failure
1174 * This function can be used instead of init() if the driver wrapper
1177 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1180 * get_interfaces - Get information about available interfaces
1181 * @global_priv: private driver global data from global_init()
1182 * Returns: Allocated buffer of interface information (caller is
1183 * responsible for freeing the data structure) on success, NULL on
1186 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1189 * scan2 - Request the driver to initiate scan
1190 * @priv: private driver interface data
1191 * @params: Scan parameters
1193 * Returns: 0 on success, -1 on failure
1195 * Once the scan results are ready, the driver should report scan
1196 * results event for wpa_supplicant which will eventually request the
1197 * results with wpa_driver_get_scan_results2().
1199 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1202 * authenticate - Request driver to authenticate
1203 * @priv: private driver interface data
1204 * @params: authentication parameters
1205 * Returns: 0 on success, -1 on failure
1207 * This is an optional function that can be used with drivers that
1208 * support separate authentication and association steps, i.e., when
1209 * wpa_supplicant can act as the SME. If not implemented, associate()
1210 * function is expected to take care of IEEE 802.11 authentication,
1213 int (*authenticate)(void *priv,
1214 struct wpa_driver_auth_params *params);
1216 int (*set_beacon)(void *priv, const u8 *head, size_t head_len,
1217 const u8 *tail, size_t tail_len, int dtim_period);
1219 int (*set_beacon_int)(void *priv, int value);
1221 void * (*hapd_init)(struct hostapd_data *hapd,
1222 struct wpa_init_params *params);
1223 void (*hapd_deinit)(void *priv);
1226 * set_8021x - enable/disable IEEE 802.1X support
1227 * @ifname: Interface name (for multi-SSID/VLAN support)
1228 * @priv: driver private data
1229 * @enabled: 1 = enable, 0 = disable
1231 * Returns: 0 on success, -1 on failure
1233 * Configure the kernel driver to enable/disable 802.1X support.
1234 * This may be an empty function if 802.1X support is always enabled.
1236 int (*set_ieee8021x)(const char *ifname, void *priv, int enabled);
1239 * set_privacy - enable/disable privacy
1240 * @priv: driver private data
1241 * @enabled: 1 = privacy enabled, 0 = disabled
1243 * Return: 0 on success, -1 on failure
1245 * Configure privacy.
1247 int (*set_privacy)(const char *ifname, void *priv, int enabled);
1249 int (*hapd_set_key)(const char *ifname, void *priv, wpa_alg alg,
1250 const u8 *addr, int key_idx, int set_tx,
1251 const u8 *seq, size_t seq_len,
1252 const u8 *key, size_t key_len);
1253 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1255 int (*get_seqnum_igtk)(const char *ifname, void *priv, const u8 *addr,
1257 int (*flush)(void *priv);
1258 int (*set_generic_elem)(const char *ifname, void *priv, const u8 *elem,
1261 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1263 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1264 size_t data_len, int encrypt,
1265 const u8 *own_addr);
1266 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1268 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1270 int (*sta_remove)(void *priv, const u8 *addr);
1271 int (*hapd_get_ssid)(const char *ifname, void *priv, u8 *buf, int len);
1272 int (*hapd_set_ssid)(const char *ifname, void *priv, const u8 *buf,
1274 int (*hapd_set_countermeasures)(void *priv, int enabled);
1275 int (*sta_add)(const char *ifname, void *priv,
1276 struct hostapd_sta_add_params *params);
1277 int (*get_inact_sec)(void *priv, const u8 *addr);
1278 int (*sta_clear_stats)(void *priv, const u8 *addr);
1280 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1281 int (*set_rts)(void *priv, int rts);
1282 int (*set_frag)(void *priv, int frag);
1284 int (*sta_set_flags)(void *priv, const u8 *addr,
1285 int total_flags, int flags_or, int flags_and);
1286 int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
1288 int (*hapd_set_beacon)(const char *ifname, void *priv,
1289 const u8 *head, size_t head_len,
1290 const u8 *tail, size_t tail_len,
1293 /* Configure internal bridge:
1294 * 0 = disabled, i.e., client separation is enabled (no bridging of
1295 * packets between associated STAs
1296 * 1 = enabled, i.e., bridge packets between associated STAs (default)
1298 int (*set_internal_bridge)(void *priv, int value);
1299 int (*set_cts_protect)(void *priv, int value);
1300 int (*set_preamble)(void *priv, int value);
1301 int (*set_short_slot_time)(void *priv, int value);
1302 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1303 int cw_max, int burst_time);
1304 int (*bss_add)(void *priv, const char *ifname, const u8 *bssid);
1305 int (*bss_remove)(void *priv, const char *ifname);
1306 int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
1307 int (*if_add)(const char *iface, void *priv,
1308 enum hostapd_driver_if_type type, char *ifname,
1310 int (*if_update)(void *priv, enum hostapd_driver_if_type type,
1311 char *ifname, const u8 *addr);
1312 int (*if_remove)(void *priv, enum hostapd_driver_if_type type,
1313 const char *ifname, const u8 *addr);
1314 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1317 * commit - Optional commit changes handler
1318 * @priv: driver private data
1319 * Returns: 0 on success, -1 on failure
1321 * This optional handler function can be registered if the driver
1322 * interface implementation needs to commit changes (e.g., by setting
1323 * network interface up) at the end of initial configuration. If set,
1324 * this handler will be called after initial setup has been completed.
1326 int (*commit)(void *priv);
1328 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1329 const u8 *data, size_t data_len);
1331 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1332 u32 session_timeout);
1333 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1335 int (*set_ht_params)(const char *ifname, void *priv,
1336 const u8 *ht_capab, size_t ht_capab_len,
1337 const u8 *ht_oper, size_t ht_oper_len);
1339 int (*set_wps_beacon_ie)(const char *ifname, void *priv,
1340 const u8 *ie, size_t len);
1341 int (*set_wps_probe_resp_ie)(const char *ifname, void *priv,
1342 const u8 *ie, size_t len);
1345 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1346 * @priv: Private driver interface data
1347 * @authorized: Whether the port is authorized
1348 * Returns: 0 on success, -1 on failure
1350 int (*set_supp_port)(void *priv, int authorized);
1354 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1356 typedef enum wpa_event_type {
1358 * EVENT_ASSOC - Association completed
1360 * This event needs to be delivered when the driver completes IEEE
1361 * 802.11 association or reassociation successfully.
1362 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1363 * after this event has been generated. In addition, optional
1364 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1365 * more information about the association. If the driver interface gets
1366 * both of these events at the same time, it can also include the
1367 * assoc_info data in EVENT_ASSOC call.
1372 * EVENT_DISASSOC - Association lost
1374 * This event should be called when association is lost either due to
1375 * receiving deauthenticate or disassociate frame from the AP or when
1376 * sending either of these frames to the current AP. If the driver
1377 * supports separate deauthentication event, EVENT_DISASSOC should only
1378 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1383 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1385 * This event must be delivered when a Michael MIC error is detected by
1386 * the local driver. Additional data for event processing is
1387 * provided with union wpa_event_data::michael_mic_failure. This
1388 * information is used to request new encyption key and to initiate
1389 * TKIP countermeasures if needed.
1391 EVENT_MICHAEL_MIC_FAILURE,
1394 * EVENT_SCAN_RESULTS - Scan results available
1396 * This event must be called whenever scan results are available to be
1397 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1398 * is expected to be used some time after struct wpa_driver_ops::scan()
1399 * is called. If the driver provides an unsolicited event when the scan
1400 * has been completed, this event can be used to trigger
1401 * EVENT_SCAN_RESULTS call. If such event is not available from the
1402 * driver, the driver wrapper code is expected to use a registered
1403 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1404 * scan is expected to be completed.
1409 * EVENT_ASSOCINFO - Report optional extra information for association
1411 * This event can be used to report extra association information for
1412 * EVENT_ASSOC processing. This extra information includes IEs from
1413 * association frames and Beacon/Probe Response frames in union
1414 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1415 * EVENT_ASSOC. Alternatively, the driver interface can include
1416 * assoc_info data in the EVENT_ASSOC call if it has all the
1417 * information available at the same point.
1422 * EVENT_INTERFACE_STATUS - Report interface status changes
1424 * This optional event can be used to report changes in interface
1425 * status (interface added/removed) using union
1426 * wpa_event_data::interface_status. This can be used to trigger
1427 * wpa_supplicant to stop and re-start processing for the interface,
1428 * e.g., when a cardbus card is ejected/inserted.
1430 EVENT_INTERFACE_STATUS,
1433 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1435 * This event can be used to inform wpa_supplicant about candidates for
1436 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1437 * for scan request (ap_scan=2 mode), this event is required for
1438 * pre-authentication. If wpa_supplicant is performing scan request
1439 * (ap_scan=1), this event is optional since scan results can be used
1440 * to add pre-authentication candidates. union
1441 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1442 * candidate and priority of the candidate, e.g., based on the signal
1443 * strength, in order to try to pre-authenticate first with candidates
1444 * that are most likely targets for re-association.
1446 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1447 * on the candidate list. In addition, it can be called for the current
1448 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1449 * will automatically skip pre-authentication in cases where a valid
1450 * PMKSA exists. When more than one candidate exists, this event should
1451 * be generated once for each candidate.
1453 * Driver will be notified about successful pre-authentication with
1454 * struct wpa_driver_ops::add_pmkid() calls.
1456 EVENT_PMKID_CANDIDATE,
1459 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1461 * This event can be used to inform wpa_supplicant about desire to set
1462 * up secure direct link connection between two stations as defined in
1463 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1464 * STAKey negotiation. The caller will need to set peer address for the
1470 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1472 * The driver is expected to report the received FT IEs from
1473 * FT authentication sequence from the AP. The FT IEs are included in
1474 * the extra information in union wpa_event_data::ft_ies.
1479 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
1481 * The driver can use this event to inform wpa_supplicant about a STA
1482 * in an IBSS with which protected frames could be exchanged. This
1483 * event starts RSN authentication with the other STA to authenticate
1484 * the STA and set up encryption keys with it.
1486 EVENT_IBSS_RSN_START,
1489 * EVENT_AUTH - Authentication result
1491 * This event should be called when authentication attempt has been
1492 * completed. This is only used if the driver supports separate
1493 * authentication step (struct wpa_driver_ops::authenticate).
1494 * Information about authentication result is included in
1495 * union wpa_event_data::auth.
1500 * EVENT_DEAUTH - Authentication lost
1502 * This event should be called when authentication is lost either due
1503 * to receiving deauthenticate frame from the AP or when sending that
1504 * frame to the current AP.
1509 * EVENT_ASSOC_REJECT - Association rejected
1511 * This event should be called when (re)association attempt has been
1512 * rejected by the AP. Information about authentication result is
1513 * included in union wpa_event_data::assoc_reject.
1518 * EVENT_AUTH_TIMED_OUT - Authentication timed out
1520 EVENT_AUTH_TIMED_OUT,
1523 * EVENT_ASSOC_TIMED_OUT - Association timed out
1525 EVENT_ASSOC_TIMED_OUT
1530 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
1532 union wpa_event_data {
1534 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
1536 * This structure is optional for EVENT_ASSOC calls and required for
1537 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
1538 * driver interface does not need to generate separate EVENT_ASSOCINFO
1543 * req_ies - (Re)Association Request IEs
1545 * If the driver generates WPA/RSN IE, this event data must be
1546 * returned for WPA handshake to have needed information. If
1547 * wpa_supplicant-generated WPA/RSN IE is used, this
1548 * information event is optional.
1550 * This should start with the first IE (fixed fields before IEs
1551 * are not included).
1556 * req_ies_len - Length of req_ies in bytes
1561 * resp_ies - (Re)Association Response IEs
1563 * Optional association data from the driver. This data is not
1564 * required WPA, but may be useful for some protocols and as
1565 * such, should be reported if this is available to the driver
1568 * This should start with the first IE (fixed fields before IEs
1569 * are not included).
1574 * resp_ies_len - Length of resp_ies in bytes
1576 size_t resp_ies_len;
1579 * beacon_ies - Beacon or Probe Response IEs
1581 * Optional Beacon/ProbeResp data: IEs included in Beacon or
1582 * Probe Response frames from the current AP (i.e., the one
1583 * that the client just associated with). This information is
1584 * used to update WPA/RSN IE for the AP. If this field is not
1585 * set, the results from previous scan will be used. If no
1586 * data for the new AP is found, scan results will be requested
1587 * again (without scan request). At this point, the driver is
1588 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
1591 * This should start with the first IE (fixed fields before IEs
1592 * are not included).
1597 * beacon_ies_len - Length of beacon_ies */
1598 size_t beacon_ies_len;
1602 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
1604 struct michael_mic_failure {
1607 } michael_mic_failure;
1610 * struct interface_status - Data for EVENT_INTERFACE_STATUS
1612 struct interface_status {
1615 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
1620 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
1622 struct pmkid_candidate {
1623 /** BSSID of the PMKID candidate */
1625 /** Smaller the index, higher the priority */
1627 /** Whether RSN IE includes pre-authenticate flag */
1632 * struct stkstart - Data for EVENT_STKSTART
1639 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
1641 * During FT (IEEE 802.11r) authentication sequence, the driver is
1642 * expected to use this event to report received FT IEs (MDIE, FTIE,
1643 * RSN IE, TIE, possible resource request) to the supplicant. The FT
1644 * IEs for the next message will be delivered through the
1645 * struct wpa_driver_ops::update_ft_ies() callback.
1651 u8 target_ap[ETH_ALEN];
1652 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
1654 /** Length of ric_ies buffer in octets */
1659 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
1661 struct ibss_rsn_start {
1666 * struct auth_info - Data for EVENT_AUTH events
1677 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
1679 struct assoc_reject {
1681 * resp_ies - (Re)Association Response IEs
1683 * Optional association data from the driver. This data is not
1684 * required WPA, but may be useful for some protocols and as
1685 * such, should be reported if this is available to the driver
1688 * This should start with the first IE (fixed fields before IEs
1689 * are not included).
1694 * resp_ies_len - Length of resp_ies in bytes
1696 size_t resp_ies_len;
1699 * status_code - Status Code from (Re)association Response
1704 struct timeout_event {
1710 * wpa_supplicant_event - Report a driver event for wpa_supplicant
1711 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1712 * with struct wpa_driver_ops::init()
1713 * @event: event type (defined above)
1714 * @data: possible extra data for the event
1716 * Driver wrapper code should call this function whenever an event is received
1719 void wpa_supplicant_event(void *ctx, wpa_event_type event,
1720 union wpa_event_data *data);
1723 * wpa_supplicant_rx_eapol - Deliver a received EAPOL frame to wpa_supplicant
1724 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1725 * with struct wpa_driver_ops::init()
1726 * @src_addr: Source address of the EAPOL frame
1727 * @buf: EAPOL data starting from the EAPOL header (i.e., no Ethernet header)
1728 * @len: Length of the EAPOL data
1730 * This function is called for each received EAPOL frame. Most driver
1731 * interfaces rely on more generic OS mechanism for receiving frames through
1732 * l2_packet, but if such a mechanism is not available, the driver wrapper may
1733 * take care of received EAPOL frames and deliver them to the core supplicant
1734 * code by calling this function.
1736 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
1737 const u8 *buf, size_t len);
1739 void wpa_supplicant_sta_rx(void *ctx, const u8 *buf, size_t len,
1740 struct ieee80211_rx_status *rx_status);
1742 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie);
1743 #define WPA_IE_VENDOR_TYPE 0x0050f201
1744 #define WPS_IE_VENDOR_TYPE 0x0050f204
1745 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
1747 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
1749 int wpa_scan_get_max_rate(const struct wpa_scan_res *res);
1750 void wpa_scan_results_free(struct wpa_scan_results *res);
1751 void wpa_scan_sort_results(struct wpa_scan_results *res);
1753 /* hostapd functions for driver wrappers */
1756 struct ieee80211_hdr;
1758 void hostapd_new_assoc_sta(struct hostapd_data *hapd, struct sta_info *sta,
1760 void hostapd_tx_status(struct hostapd_data *hapd, const u8 *addr,
1761 const u8 *buf, size_t len, int ack);
1762 void hostapd_rx_from_unknown_sta(struct hostapd_data *hapd,
1763 const struct ieee80211_hdr *hdr, size_t len);
1764 int hostapd_notif_assoc(struct hostapd_data *hapd, const u8 *addr,
1765 const u8 *ie, size_t ielen);
1766 void hostapd_notif_disassoc(struct hostapd_data *hapd, const u8 *addr);
1767 void hostapd_eapol_receive(struct hostapd_data *hapd, const u8 *sa,
1768 const u8 *buf, size_t len);
1770 struct hostapd_frame_info {
1777 void hostapd_mgmt_rx(struct hostapd_data *hapd, u8 *buf, size_t len,
1778 u16 stype, struct hostapd_frame_info *fi);
1779 void hostapd_mgmt_tx_cb(struct hostapd_data *hapd, u8 *buf, size_t len,
1781 void hostapd_michael_mic_failure(struct hostapd_data *hapd, const u8 *addr);
1782 struct hostapd_data * hostapd_sta_get_bss(struct hostapd_data *hapd,
1784 void hostapd_probe_req_rx(struct hostapd_data *hapd, const u8 *sa,
1785 const u8 *ie, size_t ie_len);
1787 #endif /* DRIVER_H */