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;
57 #define AUTH_ALG_OPEN_SYSTEM 0x01
58 #define AUTH_ALG_SHARED_KEY 0x02
59 #define AUTH_ALG_LEAP 0x04
60 #define AUTH_ALG_FT 0x08
62 #define IEEE80211_MODE_INFRA 0
63 #define IEEE80211_MODE_IBSS 1
65 #define IEEE80211_CAP_ESS 0x0001
66 #define IEEE80211_CAP_IBSS 0x0002
67 #define IEEE80211_CAP_PRIVACY 0x0010
69 #define SSID_MAX_WPA_IE_LEN 40
71 * struct wpa_scan_result - Scan results (old structure)
74 * @ssid_len: length of the ssid
76 * @wpa_ie_len: length of the wpa_ie
78 * @rsn_ie_len: length of the RSN IE
79 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
80 * @caps: capability information field in host byte order
81 * @qual: signal quality
83 * @level: signal level
84 * @maxrate: maximum supported rate
85 * @mdie_present: Whether MDIE was included in Beacon/ProbeRsp frame
86 * @mdie: Mobility domain identifier IE (IEEE 802.11r MDIE) (starting from
90 * This structure is used as a generic format for scan results from the
91 * driver. Each driver interface implementation is responsible for converting
92 * the driver or OS specific scan results into this format.
94 * This structure is the old data structure used for scan results. It is
95 * obsoleted by the new struct wpa_scan_res structure and the old version is
96 * only included for backwards compatibility with existing driver wrapper
97 * implementations. New implementations are encouraged to implement for struct
98 * wpa_scan_res. The old structure will be removed at some point.
100 struct wpa_scan_result {
104 u8 wpa_ie[SSID_MAX_WPA_IE_LEN];
106 u8 rsn_ie[SSID_MAX_WPA_IE_LEN];
120 #define WPA_SCAN_QUAL_INVALID BIT(0)
121 #define WPA_SCAN_NOISE_INVALID BIT(1)
122 #define WPA_SCAN_LEVEL_INVALID BIT(2)
123 #define WPA_SCAN_LEVEL_DBM BIT(3)
126 * struct wpa_scan_res - Scan result for an BSS/IBSS
127 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
129 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
130 * @beacon_int: beacon interval in TUs (host byte order)
131 * @caps: capability information field in host byte order
132 * @qual: signal quality
133 * @noise: noise level
134 * @level: signal level
136 * @ie_len: length of the following IE field in octets
138 * This structure is used as a generic format for scan results from the
139 * driver. Each driver interface implementation is responsible for converting
140 * the driver or OS specific scan results into this format.
142 * If the driver does not support reporting all IEs, the IE data structure is
143 * constructed of the IEs that are available. This field will also need to
144 * include SSID in IE format. All drivers are encouraged to be extended to
145 * report all IEs to make it easier to support future additions.
147 struct wpa_scan_res {
158 /* followed by ie_len octets of IEs */
162 * struct wpa_scan_results - Scan results
163 * @res: Array of pointers to allocated variable length scan result entries
164 * @num: Number of entries in the scan result array
166 struct wpa_scan_results {
167 struct wpa_scan_res **res;
172 * struct wpa_interface_info - Network interface information
173 * @next: Pointer to the next interface or NULL if this is the last one
174 * @ifname: Interface name that can be used with init() or init2()
175 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
177 * @drv_bame: struct wpa_driver_ops::name (note: unlike other strings, this one
178 * is not an allocated copy, i.e., get_interfaces() caller will not free
181 struct wpa_interface_info {
182 struct wpa_interface_info *next;
185 const char *drv_name;
188 #define WPAS_MAX_SCAN_SSIDS 4
191 * struct wpa_driver_scan_params - Scan parameters
192 * Data for struct wpa_driver_ops::scan2().
194 struct wpa_driver_scan_params {
196 * ssids - SSIDs to scan for
198 struct wpa_driver_scan_ssid {
200 * ssid - specific SSID to scan for (ProbeReq)
201 * %NULL or zero-length SSID is used to indicate active scan
202 * with wildcard SSID.
206 * ssid_len: Length of the SSID in octets
209 } ssids[WPAS_MAX_SCAN_SSIDS];
212 * num_ssids - Number of entries in ssids array
213 * Zero indicates a request for a passive scan.
218 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
223 * extra_ies_len - Length of extra_ies in octets
225 size_t extra_ies_len;
228 * freqs - Array of frequencies to scan or %NULL for all frequencies
230 * The frequency is set in MHz. The array is zero-terminated.
236 * struct wpa_driver_auth_params - Authentication parameters
237 * Data for struct wpa_driver_ops::authenticate().
239 struct wpa_driver_auth_params {
247 const u8 *wep_key[4];
248 size_t wep_key_len[4];
253 * struct wpa_driver_associate_params - Association parameters
254 * Data for struct wpa_driver_ops::associate().
256 struct wpa_driver_associate_params {
258 * bssid - BSSID of the selected AP
259 * This can be %NULL, if ap_scan=2 mode is used and the driver is
260 * responsible for selecting with which BSS to associate. */
264 * ssid - The selected SSID
270 * freq - Frequency of the channel the selected AP is using
271 * Frequency that the selected AP is using (in MHz as
272 * reported in the scan results)
277 * wpa_ie - WPA information element for (Re)Association Request
278 * WPA information element to be included in (Re)Association
279 * Request (including information element id and length). Use
280 * of this WPA IE is optional. If the driver generates the WPA
281 * IE, it can use pairwise_suite, group_suite, and
282 * key_mgmt_suite to select proper algorithms. In this case,
283 * the driver has to notify wpa_supplicant about the used WPA
284 * IE by generating an event that the interface code will
285 * convert into EVENT_ASSOCINFO data (see below).
287 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
288 * instead. The driver can determine which version is used by
289 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
292 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
296 * wpa_ie_len - length of the wpa_ie
300 /* The selected pairwise/group cipher and key management
301 * suites. These are usually ignored if @wpa_ie is used. */
302 wpa_cipher pairwise_suite;
303 wpa_cipher group_suite;
304 wpa_key_mgmt key_mgmt_suite;
307 * auth_alg - Allowed authentication algorithms
308 * Bit field of AUTH_ALG_*
313 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
318 * wep_key - WEP keys for static WEP configuration
320 const u8 *wep_key[4];
323 * wep_key_len - WEP key length for static WEP configuration
325 size_t wep_key_len[4];
328 * wep_tx_keyidx - WEP TX key index for static WEP configuration
333 * mgmt_frame_protection - IEEE 802.11w management frame protection
336 NO_MGMT_FRAME_PROTECTION,
337 MGMT_FRAME_PROTECTION_OPTIONAL,
338 MGMT_FRAME_PROTECTION_REQUIRED
339 } mgmt_frame_protection;
342 * ft_ies - IEEE 802.11r / FT information elements
343 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
344 * for fast transition, this parameter is set to include the IEs that
345 * are to be sent in the next FT Authentication Request message.
346 * update_ft_ies() handler is called to update the IEs for further
347 * FT messages in the sequence.
349 * The driver should use these IEs only if the target AP is advertising
350 * the same mobility domain as the one included in the MDIE here.
352 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
353 * AP after the initial association. These IEs can only be used if the
354 * target AP is advertising support for FT and is using the same MDIE
355 * and SSID as the current AP.
357 * The driver is responsible for reporting the FT IEs received from the
358 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
359 * type. update_ft_ies() handler will then be called with the FT IEs to
360 * include in the next frame in the authentication sequence.
365 * ft_ies_len - Length of ft_ies in bytes
370 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
372 * This value is provided to allow the driver interface easier access
373 * to the current mobility domain. This value is set to %NULL if no
374 * mobility domain is currently active.
379 * passphrase - RSN passphrase for PSK
381 * This value is made available only for WPA/WPA2-Personal (PSK) and
382 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
383 * the 8..63 character ASCII passphrase, if available. Please note that
384 * this can be %NULL if passphrase was not used to generate the PSK. In
385 * that case, the psk field must be used to fetch the PSK.
387 const char *passphrase;
390 * psk - RSN PSK (alternative for passphrase for PSK)
392 * This value is made available only for WPA/WPA2-Personal (PSK) and
393 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
394 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
395 * be prepared to handle %NULL value as an error.
400 * drop_unencrypted - Enable/disable unencrypted frame filtering
402 * Configure the driver to drop all non-EAPOL frames (both receive and
403 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
404 * still be allowed for key negotiation.
406 int drop_unencrypted;
410 * struct wpa_driver_capa - Driver capability information
412 struct wpa_driver_capa {
413 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
414 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
415 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
416 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
417 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
418 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
419 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
420 unsigned int key_mgmt;
422 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
423 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
424 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
425 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
428 #define WPA_DRIVER_AUTH_OPEN 0x00000001
429 #define WPA_DRIVER_AUTH_SHARED 0x00000002
430 #define WPA_DRIVER_AUTH_LEAP 0x00000004
433 /* Driver generated WPA/RSN IE */
434 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
435 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
436 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
437 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
438 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
439 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
440 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
441 /* Driver provides separate commands for authentication and association (SME in
442 * wpa_supplicant). */
443 #define WPA_DRIVER_FLAGS_SME 0x00000020
444 /* Driver supports AP mode */
445 #define WPA_DRIVER_FLAGS_AP 0x00000040
452 struct ieee80211_rx_status {
460 struct hostap_sta_driver_data {
461 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
462 unsigned long current_tx_rate;
463 unsigned long inactive_msec;
465 unsigned long num_ps_buf_frames;
466 unsigned long tx_retry_failed;
467 unsigned long tx_retry_count;
472 struct hostapd_sta_add_params {
476 const u8 *supp_rates;
477 size_t supp_rates_len;
480 const struct ht_cap_ie *ht_capabilities;
483 struct hostapd_freq_params {
488 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
489 * secondary channel below primary, 1 = HT40
490 * enabled, secondary channel above primary */
493 enum hostapd_driver_if_type {
494 HOSTAPD_IF_VLAN, HOSTAPD_IF_WDS
497 struct hostapd_neighbor_bss {
502 int sec_chan; /* 0 for 20 MHz channels */
507 * struct wpa_driver_ops - Driver interface API definition
509 * This structure defines the API that each driver interface needs to implement
510 * for core wpa_supplicant code. All driver specific functionality is captured
513 struct wpa_driver_ops {
514 /** Name of the driver interface */
516 /** One line description of the driver interface */
520 * get_bssid - Get the current BSSID
521 * @priv: private driver interface data
522 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
524 * Returns: 0 on success, -1 on failure
526 * Query kernel driver for the current BSSID and copy it to bssid.
527 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
530 int (*get_bssid)(void *priv, u8 *bssid);
533 * get_ssid - Get the current SSID
534 * @priv: private driver interface data
535 * @ssid: buffer for SSID (at least 32 bytes)
537 * Returns: Length of the SSID on success, -1 on failure
539 * Query kernel driver for the current SSID and copy it to ssid.
540 * Returning zero is recommended if the STA is not associated.
542 * Note: SSID is an array of octets, i.e., it is not nul terminated and
543 * can, at least in theory, contain control characters (including nul)
544 * and as such, should be processed as binary data, not a printable
547 int (*get_ssid)(void *priv, u8 *ssid);
550 * set_wpa - Enable/disable WPA support (OBSOLETE)
551 * @priv: private driver interface data
552 * @enabled: 1 = enable, 0 = disable
554 * Returns: 0 on success, -1 on failure
556 * Note: This function is included for backwards compatibility. This is
557 * called only just after init and just before deinit, so these
558 * functions can be used to implement same functionality and the driver
559 * interface need not define this function.
561 * Configure the kernel driver to enable/disable WPA support. This may
562 * be empty function, if WPA support is always enabled. Common
563 * configuration items are WPA IE (clearing it when WPA support is
564 * disabled), Privacy flag configuration for capability field (note:
565 * this the value need to set in associate handler to allow plaintext
566 * mode to be used) when trying to associate with, roaming mode (can
567 * allow wpa_supplicant to control roaming if ap_scan=1 is used;
568 * however, drivers can also implement roaming if desired, especially
569 * ap_scan=2 mode is used for this).
571 int (*set_wpa)(void *priv, int enabled);
574 * set_key - Configure encryption key
575 * @priv: private driver interface data
576 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
577 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
578 * %WPA_ALG_NONE clears the key.
579 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
580 * broadcast/default keys
581 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
583 * @set_tx: configure this key as the default Tx key (only used when
584 * driver does not support separate unicast/individual key
585 * @seq: sequence number/packet number, seq_len octets, the next
586 * packet number to be used for in replay protection; configured
587 * for Rx keys (in most cases, this is only used with broadcast
588 * keys and set to zero for unicast keys)
589 * @seq_len: length of the seq, depends on the algorithm:
590 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
591 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
593 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
594 * TKIP: 32, CCMP: 16, IGTK: 16)
596 * Returns: 0 on success, -1 on failure
598 * Configure the given key for the kernel driver. If the driver
599 * supports separate individual keys (4 default keys + 1 individual),
600 * addr can be used to determine whether the key is default or
601 * individual. If only 4 keys are supported, the default key with key
602 * index 0 is used as the individual key. STA must be configured to use
603 * it as the default Tx key (set_tx is set) and accept Rx for all the
604 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
605 * broadcast keys, so key index 0 is available for this kind of
608 * Please note that TKIP keys include separate TX and RX MIC keys and
609 * some drivers may expect them in different order than wpa_supplicant
610 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
611 * will tricker Michael MIC errors. This can be fixed by changing the
612 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
613 * in driver_*.c set_key() implementation, see driver_ndis.c for an
614 * example on how this can be done.
616 int (*set_key)(void *priv, wpa_alg alg, const u8 *addr,
617 int key_idx, int set_tx, const u8 *seq, size_t seq_len,
618 const u8 *key, size_t key_len);
621 * init - Initialize driver interface
622 * @ctx: context to be used when calling wpa_supplicant functions,
623 * e.g., wpa_supplicant_event()
624 * @ifname: interface name, e.g., wlan0
626 * Returns: Pointer to private data, %NULL on failure
628 * Initialize driver interface, including event processing for kernel
629 * driver events (e.g., associated, scan results, Michael MIC failure).
630 * This function can allocate a private configuration data area for
631 * @ctx, file descriptor, interface name, etc. information that may be
632 * needed in future driver operations. If this is not used, non-NULL
633 * value will need to be returned because %NULL is used to indicate
634 * failure. The returned value will be used as 'void *priv' data for
635 * all other driver_ops functions.
637 * The main event loop (eloop.c) of wpa_supplicant can be used to
638 * register callback for read sockets (eloop_register_read_sock()).
640 * See below for more information about events and
641 * wpa_supplicant_event() function.
643 void * (*init)(void *ctx, const char *ifname);
646 * deinit - Deinitialize driver interface
647 * @priv: private driver interface data from init()
649 * Shut down driver interface and processing of driver events. Free
650 * private data buffer if one was allocated in init() handler.
652 void (*deinit)(void *priv);
655 * set_param - Set driver configuration parameters
656 * @priv: private driver interface data from init()
657 * @param: driver specific configuration parameters
659 * Returns: 0 on success, -1 on failure
661 * Optional handler for notifying driver interface about configuration
662 * parameters (driver_param).
664 int (*set_param)(void *priv, const char *param);
667 * set_countermeasures - Enable/disable TKIP countermeasures
668 * @priv: private driver interface data
669 * @enabled: 1 = countermeasures enabled, 0 = disabled
671 * Returns: 0 on success, -1 on failure
673 * Configure TKIP countermeasures. When these are enabled, the driver
674 * should drop all received and queued frames that are using TKIP.
676 int (*set_countermeasures)(void *priv, int enabled);
679 * set_drop_unencrypted - Enable/disable unencrypted frame filtering
680 * @priv: private driver interface data
681 * @enabled: 1 = unencrypted Tx/Rx frames will be dropped, 0 = disabled
683 * Returns: 0 on success, -1 on failure
685 * Configure the driver to drop all non-EAPOL frames (both receive and
686 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
687 * still be allowed for key negotiation.
689 * This function is deprecated. New driver wrapper implementations
690 * should use associate() parameter drop_unencrypted instead.
692 int (*set_drop_unencrypted)(void *priv, int enabled);
695 * scan - Request the driver to initiate scan (old version)
696 * @priv: private driver interface data
697 * @ssid: specific SSID to scan for (ProbeReq) or %NULL to scan for
698 * all SSIDs (either active scan with wildcard SSID or passive
700 * @ssid_len: length of the SSID
702 * Returns: 0 on success, -1 on failure
704 * Once the scan results are ready, the driver should report scan
705 * results event for wpa_supplicant which will eventually request the
706 * results with wpa_driver_get_scan_results().
708 * This function is deprecated. New driver wrapper implementations
709 * should implement support for scan2().
711 int (*scan)(void *priv, const u8 *ssid, size_t ssid_len);
714 * get_scan_results - Fetch the latest scan results (old version)
715 * @priv: private driver interface data
716 * @results: pointer to buffer for scan results
717 * @max_size: maximum number of entries (buffer size)
719 * Returns: Number of scan result entries used on success, -1 on
722 * If scan results include more than max_size BSSes, max_size will be
723 * returned and the remaining entries will not be included in the
726 * This function is deprecated. New driver wrapper implementations
727 * should implement support for get_scan_results2().
729 int (*get_scan_results)(void *priv,
730 struct wpa_scan_result *results,
734 * deauthenticate - Request driver to deauthenticate
735 * @priv: private driver interface data
736 * @addr: peer address (BSSID of the AP)
737 * @reason_code: 16-bit reason code to be sent in the deauthentication
740 * Returns: 0 on success, -1 on failure
742 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
745 * disassociate - Request driver to disassociate
746 * @priv: private driver interface data
747 * @addr: peer address (BSSID of the AP)
748 * @reason_code: 16-bit reason code to be sent in the disassociation
751 * Returns: 0 on success, -1 on failure
753 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
756 * associate - Request driver to associate
757 * @priv: private driver interface data
758 * @params: association parameters
760 * Returns: 0 on success, -1 on failure
762 int (*associate)(void *priv,
763 struct wpa_driver_associate_params *params);
766 * set_auth_alg - Set IEEE 802.11 authentication algorithm
767 * @priv: private driver interface data
768 * @auth_alg: bit field of AUTH_ALG_*
770 * If the driver supports more than one authentication algorithm at the
771 * same time, it should configure all supported algorithms. If not, one
772 * algorithm needs to be selected arbitrarily. Open System
773 * authentication should be ok for most cases and it is recommended to
774 * be used if other options are not supported. Static WEP configuration
775 * may also use Shared Key authentication and LEAP requires its own
776 * algorithm number. For LEAP, user can make sure that only one
777 * algorithm is used at a time by configuring LEAP as the only
778 * supported EAP method. This information is also available in
779 * associate() params, so set_auth_alg may not be needed in case of
782 * This function is deprecated. New driver wrapper implementations
783 * should use associate() parameter auth_alg instead.
785 * Returns: 0 on success, -1 on failure
787 int (*set_auth_alg)(void *priv, int auth_alg);
790 * add_pmkid - Add PMKSA cache entry to the driver
791 * @priv: private driver interface data
792 * @bssid: BSSID for the PMKSA cache entry
793 * @pmkid: PMKID for the PMKSA cache entry
795 * Returns: 0 on success, -1 on failure
797 * This function is called when a new PMK is received, as a result of
798 * either normal authentication or RSN pre-authentication.
800 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
801 * associate(), add_pmkid() can be used to add new PMKSA cache entries
802 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
803 * driver_ops function does not need to be implemented. Likewise, if
804 * the driver does not support WPA, this function is not needed.
806 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
809 * remove_pmkid - Remove PMKSA cache entry to the driver
810 * @priv: private driver interface data
811 * @bssid: BSSID for the PMKSA cache entry
812 * @pmkid: PMKID for the PMKSA cache entry
814 * Returns: 0 on success, -1 on failure
816 * This function is called when the supplicant drops a PMKSA cache
817 * entry for any reason.
819 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
820 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
821 * between the driver and wpa_supplicant. If the driver uses wpa_ie
822 * from wpa_supplicant, this driver_ops function does not need to be
823 * implemented. Likewise, if the driver does not support WPA, this
824 * function is not needed.
826 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
829 * flush_pmkid - Flush PMKSA cache
830 * @priv: private driver interface data
832 * Returns: 0 on success, -1 on failure
834 * This function is called when the supplicant drops all PMKSA cache
835 * entries for any reason.
837 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
838 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
839 * between the driver and wpa_supplicant. If the driver uses wpa_ie
840 * from wpa_supplicant, this driver_ops function does not need to be
841 * implemented. Likewise, if the driver does not support WPA, this
842 * function is not needed.
844 int (*flush_pmkid)(void *priv);
847 * get_capa - Get driver capabilities
848 * @priv: private driver interface data
850 * Returns: 0 on success, -1 on failure
852 * Get driver/firmware/hardware capabilities.
854 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
857 * poll - Poll driver for association information
858 * @priv: private driver interface data
860 * This is an option callback that can be used when the driver does not
861 * provide event mechanism for association events. This is called when
862 * receiving WPA EAPOL-Key messages that require association
863 * information. The driver interface is supposed to generate associnfo
864 * event before returning from this callback function. In addition, the
865 * driver interface should generate an association event after having
866 * sent out associnfo.
868 void (*poll)(void *priv);
871 * get_ifname - Get interface name
872 * @priv: private driver interface data
874 * Returns: Pointer to the interface name. This can differ from the
875 * interface name used in init() call. Init() is called first.
877 * This optional function can be used to allow the driver interface to
878 * replace the interface name with something else, e.g., based on an
879 * interface mapping from a more descriptive name.
881 const char * (*get_ifname)(void *priv);
884 * get_mac_addr - Get own MAC address
885 * @priv: private driver interface data
887 * Returns: Pointer to own MAC address or %NULL on failure
889 * This optional function can be used to get the own MAC address of the
890 * device from the driver interface code. This is only needed if the
891 * l2_packet implementation for the OS does not provide easy access to
893 const u8 * (*get_mac_addr)(void *priv);
896 * send_eapol - Optional function for sending EAPOL packets
897 * @priv: private driver interface data
898 * @dest: Destination MAC address
900 * @data: EAPOL packet starting with IEEE 802.1X header
901 * @data_len: Size of the EAPOL packet
903 * Returns: 0 on success, -1 on failure
905 * This optional function can be used to override l2_packet operations
906 * with driver specific functionality. If this function pointer is set,
907 * l2_packet module is not used at all and the driver interface code is
908 * responsible for receiving and sending all EAPOL packets. The
909 * received EAPOL packets are sent to core code by calling
910 * wpa_supplicant_rx_eapol(). The driver interface is required to
911 * implement get_mac_addr() handler if send_eapol() is used.
913 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
914 const u8 *data, size_t data_len);
917 * set_operstate - Sets device operating state to DORMANT or UP
918 * @priv: private driver interface data
919 * @state: 0 = dormant, 1 = up
920 * Returns: 0 on success, -1 on failure
922 * This is an optional function that can be used on operating systems
923 * that support a concept of controlling network device state from user
924 * space applications. This function, if set, gets called with
925 * state = 1 when authentication has been completed and with state = 0
926 * when connection is lost.
928 int (*set_operstate)(void *priv, int state);
931 * mlme_setprotection - MLME-SETPROTECTION.request primitive
932 * @priv: Private driver interface data
933 * @addr: Address of the station for which to set protection (may be
934 * %NULL for group keys)
935 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
936 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
937 * Returns: 0 on success, -1 on failure
939 * This is an optional function that can be used to set the driver to
940 * require protection for Tx and/or Rx frames. This uses the layer
941 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
942 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
943 * set protection operation; instead, they set protection implicitly
944 * based on configured keys.
946 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
950 * get_hw_feature_data - Get hardware support data (channels and rates)
951 * @priv: Private driver interface data
952 * @num_modes: Variable for returning the number of returned modes
953 * flags: Variable for returning hardware feature flags
954 * Returns: Pointer to allocated hardware data on success or %NULL on
955 * failure. Caller is responsible for freeing this.
957 * This function is only needed for drivers that export MLME
958 * (management frame processing) to wpa_supplicant.
960 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
965 * set_channel - Set channel
966 * @priv: Private driver interface data
967 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
968 * @chan: IEEE 802.11 channel number
969 * @freq: Frequency of the channel in MHz
970 * Returns: 0 on success, -1 on failure
972 * This function is only needed for drivers that export MLME
973 * (management frame processing) to wpa_supplicant.
975 int (*set_channel)(void *priv, hostapd_hw_mode phymode, int chan,
979 * set_ssid - Set SSID
980 * @priv: Private driver interface data
982 * @ssid_len: SSID length
983 * Returns: 0 on success, -1 on failure
985 * This function is only needed for drivers that export MLME
986 * (management frame processing) to wpa_supplicant.
988 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
991 * set_bssid - Set BSSID
992 * @priv: Private driver interface data
994 * Returns: 0 on success, -1 on failure
996 * This function is only needed for drivers that export MLME
997 * (management frame processing) to wpa_supplicant.
999 int (*set_bssid)(void *priv, const u8 *bssid);
1002 * send_mlme - Send management frame from MLME
1003 * @priv: Private driver interface data
1004 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1005 * @data_len: Size of the management frame
1006 * Returns: 0 on success, -1 on failure
1008 * This function is only needed for drivers that export MLME
1009 * (management frame processing) to wpa_supplicant.
1011 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
1014 * mlme_add_sta - Add a STA entry into the driver/netstack
1015 * @priv: Private driver interface data
1016 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1017 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
1018 * format (one octet per rate, 1 = 0.5 Mbps)
1019 * @supp_rates_len: Number of entries in supp_rates
1020 * Returns: 0 on success, -1 on failure
1022 * This function is only needed for drivers that export MLME
1023 * (management frame processing) to wpa_supplicant. When the MLME code
1024 * completes association with an AP, this function is called to
1025 * configure the driver/netstack with a STA entry for data frame
1026 * processing (TX rate control, encryption/decryption).
1028 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
1029 size_t supp_rates_len);
1032 * mlme_remove_sta - Remove a STA entry from the driver/netstack
1033 * @priv: Private driver interface data
1034 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1035 * Returns: 0 on success, -1 on failure
1037 * This function is only needed for drivers that export MLME
1038 * (management frame processing) to wpa_supplicant.
1040 int (*mlme_remove_sta)(void *priv, const u8 *addr);
1043 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1044 * @priv: Private driver interface data
1045 * @md: Mobility domain (2 octets) (also included inside ies)
1046 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1047 * @ies_len: Length of FT IEs in bytes
1048 * Returns: 0 on success, -1 on failure
1050 * The supplicant uses this callback to let the driver know that keying
1051 * material for FT is available and that the driver can use the
1052 * provided IEs in the next message in FT authentication sequence.
1054 * This function is only needed for driver that support IEEE 802.11r
1055 * (Fast BSS Transition).
1057 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1061 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1062 * @priv: Private driver interface data
1063 * @action: Action field value
1064 * @target_ap: Target AP address
1065 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1066 * @ies_len: Length of FT IEs in bytes
1067 * Returns: 0 on success, -1 on failure
1069 * The supplicant uses this callback to request the driver to transmit
1070 * an FT Action frame (action category 6) for over-the-DS fast BSS
1073 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1074 const u8 *ies, size_t ies_len);
1077 * get_scan_results2 - Fetch the latest scan results
1078 * @priv: private driver interface data
1080 * Returns: Allocated buffer of scan results (caller is responsible for
1081 * freeing the data structure) on success, NULL on failure
1083 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1086 * set_probe_req_ie - Set information element(s) for Probe Request
1087 * @priv: private driver interface data
1088 * @ies: Information elements to append or %NULL to remove extra IEs
1089 * @ies_len: Length of the IE buffer in octets
1090 * Returns: 0 on success, -1 on failure
1092 int (*set_probe_req_ie)(void *priv, const u8 *ies, size_t ies_len);
1095 * set_mode - Request driver to set the operating mode
1096 * @priv: private driver interface data
1097 * @mode: Operation mode (infra/ibss) IEEE80211_MODE_*
1099 * This handler will be called before any key configuration and call to
1100 * associate() handler in order to allow the operation mode to be
1101 * configured as early as possible. This information is also available
1102 * in associate() params and as such, driver wrappers may not need
1103 * to implement set_mode() handler.
1105 * This function is deprecated. New driver wrapper implementations
1106 * should use associate() parameter mode instead.
1108 * Returns: 0 on success, -1 on failure
1110 int (*set_mode)(void *priv, int mode);
1113 * set_country - Set country
1114 * @priv: Private driver interface data
1115 * @alpha2: country to which to switch to
1116 * Returns: 0 on success, -1 on failure
1118 * This function is for drivers which support some form
1119 * of setting a regulatory domain.
1121 int (*set_country)(void *priv, const char *alpha2);
1124 * global_init - Global driver initialization
1125 * Returns: Pointer to private data (global), %NULL on failure
1127 * This optional function is called to initialize the driver wrapper
1128 * for global data, i.e., data that applies to all interfaces. If this
1129 * function is implemented, global_deinit() will also need to be
1130 * implemented to free the private data. The driver will also likely
1131 * use init2() function instead of init() to get the pointer to global
1132 * data available to per-interface initializer.
1134 void * (*global_init)(void);
1137 * global_deinit - Global driver deinitialization
1138 * @priv: private driver global data from global_init()
1140 * Terminate any global driver related functionality and free the
1141 * global data structure.
1143 void (*global_deinit)(void *priv);
1146 * init2 - Initialize driver interface (with global data)
1147 * @ctx: context to be used when calling wpa_supplicant functions,
1148 * e.g., wpa_supplicant_event()
1149 * @ifname: interface name, e.g., wlan0
1150 * @global_priv: private driver global data from global_init()
1151 * Returns: Pointer to private data, %NULL on failure
1153 * This function can be used instead of init() if the driver wrapper
1156 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1159 * get_interfaces - Get information about available interfaces
1160 * @global_priv: private driver global data from global_init()
1161 * Returns: Allocated buffer of interface information (caller is
1162 * responsible for freeing the data structure) on success, NULL on
1165 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1168 * scan2 - Request the driver to initiate scan
1169 * @priv: private driver interface data
1170 * @params: Scan parameters
1172 * Returns: 0 on success, -1 on failure
1174 * Once the scan results are ready, the driver should report scan
1175 * results event for wpa_supplicant which will eventually request the
1176 * results with wpa_driver_get_scan_results2().
1178 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1181 * authenticate - Request driver to authenticate
1182 * @priv: private driver interface data
1183 * @params: authentication parameters
1184 * Returns: 0 on success, -1 on failure
1186 * This is an optional function that can be used with drivers that
1187 * support separate authentication and association steps, i.e., when
1188 * wpa_supplicant can act as the SME. If not implemented, associate()
1189 * function is expected to take care of IEEE 802.11 authentication,
1192 int (*authenticate)(void *priv,
1193 struct wpa_driver_auth_params *params);
1195 int (*set_beacon)(void *priv, const u8 *head, size_t head_len,
1196 const u8 *tail, size_t tail_len, int dtim_period);
1198 int (*set_beacon_int)(void *priv, int value);
1200 void * (*hapd_init)(struct hostapd_data *hapd);
1201 void * (*init_bssid)(struct hostapd_data *hapd, const u8 *bssid);
1202 void (*hapd_deinit)(void *priv);
1205 * set_8021x - enable/disable IEEE 802.1X support
1206 * @ifname: Interface name (for multi-SSID/VLAN support)
1207 * @priv: driver private data
1208 * @enabled: 1 = enable, 0 = disable
1210 * Returns: 0 on success, -1 on failure
1212 * Configure the kernel driver to enable/disable 802.1X support.
1213 * This may be an empty function if 802.1X support is always enabled.
1215 int (*set_ieee8021x)(const char *ifname, void *priv, int enabled);
1218 * set_privacy - enable/disable privacy
1219 * @priv: driver private data
1220 * @enabled: 1 = privacy enabled, 0 = disabled
1222 * Return: 0 on success, -1 on failure
1224 * Configure privacy.
1226 int (*set_privacy)(const char *ifname, void *priv, int enabled);
1228 int (*hapd_set_key)(const char *ifname, void *priv, wpa_alg alg,
1229 const u8 *addr, int key_idx, int set_tx,
1230 const u8 *seq, size_t seq_len,
1231 const u8 *key, size_t key_len);
1232 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1234 int (*get_seqnum_igtk)(const char *ifname, void *priv, const u8 *addr,
1236 int (*flush)(void *priv);
1237 int (*set_generic_elem)(const char *ifname, void *priv, const u8 *elem,
1240 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1242 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1243 size_t data_len, int encrypt,
1244 const u8 *own_addr);
1245 int (*sta_deauth)(void *priv, const u8 *addr, int reason);
1246 int (*sta_disassoc)(void *priv, const u8 *addr, int reason);
1247 int (*sta_remove)(void *priv, const u8 *addr);
1248 int (*hapd_get_ssid)(const char *ifname, void *priv, u8 *buf, int len);
1249 int (*hapd_set_ssid)(const char *ifname, void *priv, const u8 *buf,
1251 int (*hapd_set_countermeasures)(void *priv, int enabled);
1252 int (*send_mgmt_frame)(void *priv, const void *msg, size_t len,
1254 int (*sta_add)(const char *ifname, void *priv,
1255 struct hostapd_sta_add_params *params);
1256 int (*get_inact_sec)(void *priv, const u8 *addr);
1257 int (*sta_clear_stats)(void *priv, const u8 *addr);
1259 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1260 int (*set_rts)(void *priv, int rts);
1261 int (*set_frag)(void *priv, int frag);
1262 int (*set_retry)(void *priv, int short_retry, int long_retry);
1264 int (*sta_set_flags)(void *priv, const u8 *addr,
1265 int total_flags, int flags_or, int flags_and);
1266 int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
1268 int (*hapd_set_country)(void *priv, const char *country);
1269 int (*set_ieee80211d)(void *priv, int enabled);
1270 int (*hapd_set_beacon)(const char *ifname, void *priv,
1271 const u8 *head, size_t head_len,
1272 const u8 *tail, size_t tail_len,
1275 /* Configure internal bridge:
1276 * 0 = disabled, i.e., client separation is enabled (no bridging of
1277 * packets between associated STAs
1278 * 1 = enabled, i.e., bridge packets between associated STAs (default)
1280 int (*set_internal_bridge)(void *priv, int value);
1281 int (*hapd_set_beacon_int)(void *priv, int value);
1282 /* Configure broadcast SSID mode:
1283 * 0 = include SSID in Beacon frames and reply to Probe Request frames
1284 * that use broadcast SSID
1285 * 1 = hide SSID from Beacon frames and ignore Probe Request frames for
1288 int (*set_broadcast_ssid)(void *priv, int value);
1289 int (*set_cts_protect)(void *priv, int value);
1290 int (*set_preamble)(void *priv, int value);
1291 int (*set_short_slot_time)(void *priv, int value);
1292 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1293 int cw_max, int burst_time);
1294 int (*bss_add)(void *priv, const char *ifname, const u8 *bssid);
1295 int (*bss_remove)(void *priv, const char *ifname);
1296 int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
1297 int (*passive_scan)(void *priv, int now, int our_mode_only,
1298 int interval, int _listen, int *channel,
1300 int (*if_add)(const char *iface, void *priv,
1301 enum hostapd_driver_if_type type, char *ifname,
1303 int (*if_update)(void *priv, enum hostapd_driver_if_type type,
1304 char *ifname, const u8 *addr);
1305 int (*if_remove)(void *priv, enum hostapd_driver_if_type type,
1306 const char *ifname, const u8 *addr);
1307 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1310 * commit - Optional commit changes handler
1311 * @priv: driver private data
1312 * Returns: 0 on success, -1 on failure
1314 * This optional handler function can be registered if the driver
1315 * interface implementation needs to commit changes (e.g., by setting
1316 * network interface up) at the end of initial configuration. If set,
1317 * this handler will be called after initial setup has been completed.
1319 int (*commit)(void *priv);
1321 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1322 const u8 *data, size_t data_len);
1324 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1325 u32 session_timeout);
1326 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1328 int (*set_ht_params)(const char *ifname, void *priv,
1329 const u8 *ht_capab, size_t ht_capab_len,
1330 const u8 *ht_oper, size_t ht_oper_len);
1332 int (*set_wps_beacon_ie)(const char *ifname, void *priv,
1333 const u8 *ie, size_t len);
1334 int (*set_wps_probe_resp_ie)(const char *ifname, void *priv,
1335 const u8 *ie, size_t len);
1337 const struct hostapd_neighbor_bss *
1338 (*get_neighbor_bss)(void *priv, size_t *num);
1342 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1344 typedef enum wpa_event_type {
1346 * EVENT_ASSOC - Association completed
1348 * This event needs to be delivered when the driver completes IEEE
1349 * 802.11 association or reassociation successfully.
1350 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1351 * after this event has been generated. In addition, optional
1352 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1353 * more information about the association. If the driver interface gets
1354 * both of these events at the same time, it can also include the
1355 * assoc_info data in EVENT_ASSOC call.
1360 * EVENT_DISASSOC - Association lost
1362 * This event should be called when association is lost either due to
1363 * receiving deauthenticate or disassociate frame from the AP or when
1364 * sending either of these frames to the current AP. If the driver
1365 * supports separate deauthentication event, EVENT_DISASSOC should only
1366 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1371 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1373 * This event must be delivered when a Michael MIC error is detected by
1374 * the local driver. Additional data for event processing is
1375 * provided with union wpa_event_data::michael_mic_failure. This
1376 * information is used to request new encyption key and to initiate
1377 * TKIP countermeasures if needed.
1379 EVENT_MICHAEL_MIC_FAILURE,
1382 * EVENT_SCAN_RESULTS - Scan results available
1384 * This event must be called whenever scan results are available to be
1385 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1386 * is expected to be used some time after struct wpa_driver_ops::scan()
1387 * is called. If the driver provides an unsolicited event when the scan
1388 * has been completed, this event can be used to trigger
1389 * EVENT_SCAN_RESULTS call. If such event is not available from the
1390 * driver, the driver wrapper code is expected to use a registered
1391 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1392 * scan is expected to be completed.
1397 * EVENT_ASSOCINFO - Report optional extra information for association
1399 * This event can be used to report extra association information for
1400 * EVENT_ASSOC processing. This extra information includes IEs from
1401 * association frames and Beacon/Probe Response frames in union
1402 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1403 * EVENT_ASSOC. Alternatively, the driver interface can include
1404 * assoc_info data in the EVENT_ASSOC call if it has all the
1405 * information available at the same point.
1410 * EVENT_INTERFACE_STATUS - Report interface status changes
1412 * This optional event can be used to report changes in interface
1413 * status (interface added/removed) using union
1414 * wpa_event_data::interface_status. This can be used to trigger
1415 * wpa_supplicant to stop and re-start processing for the interface,
1416 * e.g., when a cardbus card is ejected/inserted.
1418 EVENT_INTERFACE_STATUS,
1421 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1423 * This event can be used to inform wpa_supplicant about candidates for
1424 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1425 * for scan request (ap_scan=2 mode), this event is required for
1426 * pre-authentication. If wpa_supplicant is performing scan request
1427 * (ap_scan=1), this event is optional since scan results can be used
1428 * to add pre-authentication candidates. union
1429 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1430 * candidate and priority of the candidate, e.g., based on the signal
1431 * strength, in order to try to pre-authenticate first with candidates
1432 * that are most likely targets for re-association.
1434 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1435 * on the candidate list. In addition, it can be called for the current
1436 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1437 * will automatically skip pre-authentication in cases where a valid
1438 * PMKSA exists. When more than one candidate exists, this event should
1439 * be generated once for each candidate.
1441 * Driver will be notified about successful pre-authentication with
1442 * struct wpa_driver_ops::add_pmkid() calls.
1444 EVENT_PMKID_CANDIDATE,
1447 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1449 * This event can be used to inform wpa_supplicant about desire to set
1450 * up secure direct link connection between two stations as defined in
1451 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1452 * STAKey negotiation. The caller will need to set peer address for the
1458 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1460 * The driver is expected to report the received FT IEs from
1461 * FT authentication sequence from the AP. The FT IEs are included in
1462 * the extra information in union wpa_event_data::ft_ies.
1467 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
1469 * The driver can use this event to inform wpa_supplicant about a STA
1470 * in an IBSS with which protected frames could be exchanged. This
1471 * event starts RSN authentication with the other STA to authenticate
1472 * the STA and set up encryption keys with it.
1474 EVENT_IBSS_RSN_START,
1477 * EVENT_AUTH - Authentication result
1479 * This event should be called when authentication attempt has been
1480 * completed. This is only used if the driver supports separate
1481 * authentication step (struct wpa_driver_ops::authenticate).
1482 * Information about authentication result is included in
1483 * union wpa_event_data::auth.
1488 * EVENT_DEAUTH - Authentication lost
1490 * This event should be called when authentication is lost either due
1491 * to receiving deauthenticate frame from the AP or when sending that
1492 * frame to the current AP.
1497 * EVENT_ASSOC_REJECT - Association rejected
1499 * This event should be called when (re)association attempt has been
1500 * rejected by the AP. Information about authentication result is
1501 * included in union wpa_event_data::assoc_reject.
1508 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
1510 union wpa_event_data {
1512 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
1514 * This structure is optional for EVENT_ASSOC calls and required for
1515 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
1516 * driver interface does not need to generate separate EVENT_ASSOCINFO
1521 * req_ies - (Re)Association Request IEs
1523 * If the driver generates WPA/RSN IE, this event data must be
1524 * returned for WPA handshake to have needed information. If
1525 * wpa_supplicant-generated WPA/RSN IE is used, this
1526 * information event is optional.
1528 * This should start with the first IE (fixed fields before IEs
1529 * are not included).
1534 * req_ies_len - Length of req_ies in bytes
1539 * resp_ies - (Re)Association Response IEs
1541 * Optional association data from the driver. This data is not
1542 * required WPA, but may be useful for some protocols and as
1543 * such, should be reported if this is available to the driver
1546 * This should start with the first IE (fixed fields before IEs
1547 * are not included).
1552 * resp_ies_len - Length of resp_ies in bytes
1554 size_t resp_ies_len;
1557 * beacon_ies - Beacon or Probe Response IEs
1559 * Optional Beacon/ProbeResp data: IEs included in Beacon or
1560 * Probe Response frames from the current AP (i.e., the one
1561 * that the client just associated with). This information is
1562 * used to update WPA/RSN IE for the AP. If this field is not
1563 * set, the results from previous scan will be used. If no
1564 * data for the new AP is found, scan results will be requested
1565 * again (without scan request). At this point, the driver is
1566 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
1569 * This should start with the first IE (fixed fields before IEs
1570 * are not included).
1575 * beacon_ies_len - Length of beacon_ies */
1576 size_t beacon_ies_len;
1580 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
1582 struct michael_mic_failure {
1584 } michael_mic_failure;
1587 * struct interface_status - Data for EVENT_INTERFACE_STATUS
1589 struct interface_status {
1592 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
1597 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
1599 struct pmkid_candidate {
1600 /** BSSID of the PMKID candidate */
1602 /** Smaller the index, higher the priority */
1604 /** Whether RSN IE includes pre-authenticate flag */
1609 * struct stkstart - Data for EVENT_STKSTART
1616 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
1618 * During FT (IEEE 802.11r) authentication sequence, the driver is
1619 * expected to use this event to report received FT IEs (MDIE, FTIE,
1620 * RSN IE, TIE, possible resource request) to the supplicant. The FT
1621 * IEs for the next message will be delivered through the
1622 * struct wpa_driver_ops::update_ft_ies() callback.
1628 u8 target_ap[ETH_ALEN];
1629 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
1631 /** Length of ric_ies buffer in octets */
1636 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
1638 struct ibss_rsn_start {
1643 * struct auth_info - Data for EVENT_AUTH events
1654 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
1656 struct assoc_reject {
1658 * resp_ies - (Re)Association Response IEs
1660 * Optional association data from the driver. This data is not
1661 * required WPA, but may be useful for some protocols and as
1662 * such, should be reported if this is available to the driver
1665 * This should start with the first IE (fixed fields before IEs
1666 * are not included).
1671 * resp_ies_len - Length of resp_ies in bytes
1673 size_t resp_ies_len;
1676 * status_code - Status Code from (Re)association Response
1683 * wpa_supplicant_event - Report a driver event for wpa_supplicant
1684 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1685 * with struct wpa_driver_ops::init()
1686 * @event: event type (defined above)
1687 * @data: possible extra data for the event
1689 * Driver wrapper code should call this function whenever an event is received
1692 void wpa_supplicant_event(void *ctx, wpa_event_type event,
1693 union wpa_event_data *data);
1696 * wpa_supplicant_rx_eapol - Deliver a received EAPOL frame to wpa_supplicant
1697 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1698 * with struct wpa_driver_ops::init()
1699 * @src_addr: Source address of the EAPOL frame
1700 * @buf: EAPOL data starting from the EAPOL header (i.e., no Ethernet header)
1701 * @len: Length of the EAPOL data
1703 * This function is called for each received EAPOL frame. Most driver
1704 * interfaces rely on more generic OS mechanism for receiving frames through
1705 * l2_packet, but if such a mechanism is not available, the driver wrapper may
1706 * take care of received EAPOL frames and deliver them to the core supplicant
1707 * code by calling this function.
1709 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
1710 const u8 *buf, size_t len);
1712 void wpa_supplicant_sta_rx(void *ctx, const u8 *buf, size_t len,
1713 struct ieee80211_rx_status *rx_status);
1715 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie);
1716 #define WPA_IE_VENDOR_TYPE 0x0050f201
1717 #define WPS_IE_VENDOR_TYPE 0x0050f204
1718 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
1720 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
1722 int wpa_scan_get_max_rate(const struct wpa_scan_res *res);
1723 void wpa_scan_results_free(struct wpa_scan_results *res);
1724 void wpa_scan_sort_results(struct wpa_scan_results *res);
1726 /* hostapd functions for driver wrappers */
1730 void hostapd_new_assoc_sta(struct hostapd_data *hapd, struct sta_info *sta,
1732 void hostapd_tx_status(struct hostapd_data *hapd, const u8 *addr,
1733 const u8 *buf, size_t len, int ack);
1734 void hostapd_rx_from_unknown_sta(struct hostapd_data *hapd, const u8 *addr);
1735 int hostapd_notif_assoc(struct hostapd_data *hapd, const u8 *addr,
1736 const u8 *ie, size_t ielen);
1737 void hostapd_notif_disassoc(struct hostapd_data *hapd, const u8 *addr);
1738 void hostapd_eapol_receive(struct hostapd_data *hapd, const u8 *sa,
1739 const u8 *buf, size_t len);
1741 struct hostapd_frame_info {
1747 unsigned int passive_scan:1;
1750 void hostapd_mgmt_rx(struct hostapd_data *hapd, u8 *buf, size_t len,
1751 u16 stype, struct hostapd_frame_info *fi);
1752 void hostapd_mgmt_tx_cb(struct hostapd_data *hapd, u8 *buf, size_t len,
1754 void hostapd_michael_mic_failure(struct hostapd_data *hapd, const u8 *addr);
1755 struct hostapd_data * hostapd_sta_get_bss(struct hostapd_data *hapd,
1758 #endif /* DRIVER_H */