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
64 #define IEEE80211_MODE_AP 2
66 #define IEEE80211_CAP_ESS 0x0001
67 #define IEEE80211_CAP_IBSS 0x0002
68 #define IEEE80211_CAP_PRIVACY 0x0010
70 #define SSID_MAX_WPA_IE_LEN 40
72 * struct wpa_scan_result - Scan results (old structure)
75 * @ssid_len: length of the ssid
77 * @wpa_ie_len: length of the wpa_ie
79 * @rsn_ie_len: length of the RSN IE
80 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
81 * @caps: capability information field in host byte order
82 * @qual: signal quality
84 * @level: signal level
85 * @maxrate: maximum supported rate
86 * @mdie_present: Whether MDIE was included in Beacon/ProbeRsp frame
87 * @mdie: Mobility domain identifier IE (IEEE 802.11r MDIE) (starting from
91 * This structure is used as a generic format for scan results from the
92 * driver. Each driver interface implementation is responsible for converting
93 * the driver or OS specific scan results into this format.
95 * This structure is the old data structure used for scan results. It is
96 * obsoleted by the new struct wpa_scan_res structure and the old version is
97 * only included for backwards compatibility with existing driver wrapper
98 * implementations. New implementations are encouraged to implement for struct
99 * wpa_scan_res. The old structure will be removed at some point.
101 struct wpa_scan_result {
105 u8 wpa_ie[SSID_MAX_WPA_IE_LEN];
107 u8 rsn_ie[SSID_MAX_WPA_IE_LEN];
121 #define WPA_SCAN_QUAL_INVALID BIT(0)
122 #define WPA_SCAN_NOISE_INVALID BIT(1)
123 #define WPA_SCAN_LEVEL_INVALID BIT(2)
124 #define WPA_SCAN_LEVEL_DBM BIT(3)
127 * struct wpa_scan_res - Scan result for an BSS/IBSS
128 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
130 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
131 * @beacon_int: beacon interval in TUs (host byte order)
132 * @caps: capability information field in host byte order
133 * @qual: signal quality
134 * @noise: noise level
135 * @level: signal level
137 * @ie_len: length of the following IE field in octets
139 * This structure is used as a generic format for scan results from the
140 * driver. Each driver interface implementation is responsible for converting
141 * the driver or OS specific scan results into this format.
143 * If the driver does not support reporting all IEs, the IE data structure is
144 * constructed of the IEs that are available. This field will also need to
145 * include SSID in IE format. All drivers are encouraged to be extended to
146 * report all IEs to make it easier to support future additions.
148 struct wpa_scan_res {
159 /* followed by ie_len octets of IEs */
163 * struct wpa_scan_results - Scan results
164 * @res: Array of pointers to allocated variable length scan result entries
165 * @num: Number of entries in the scan result array
167 struct wpa_scan_results {
168 struct wpa_scan_res **res;
173 * struct wpa_interface_info - Network interface information
174 * @next: Pointer to the next interface or NULL if this is the last one
175 * @ifname: Interface name that can be used with init() or init2()
176 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
178 * @drv_bame: struct wpa_driver_ops::name (note: unlike other strings, this one
179 * is not an allocated copy, i.e., get_interfaces() caller will not free
182 struct wpa_interface_info {
183 struct wpa_interface_info *next;
186 const char *drv_name;
189 #define WPAS_MAX_SCAN_SSIDS 4
192 * struct wpa_driver_scan_params - Scan parameters
193 * Data for struct wpa_driver_ops::scan2().
195 struct wpa_driver_scan_params {
197 * ssids - SSIDs to scan for
199 struct wpa_driver_scan_ssid {
201 * ssid - specific SSID to scan for (ProbeReq)
202 * %NULL or zero-length SSID is used to indicate active scan
203 * with wildcard SSID.
207 * ssid_len: Length of the SSID in octets
210 } ssids[WPAS_MAX_SCAN_SSIDS];
213 * num_ssids - Number of entries in ssids array
214 * Zero indicates a request for a passive scan.
219 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
224 * extra_ies_len - Length of extra_ies in octets
226 size_t extra_ies_len;
229 * freqs - Array of frequencies to scan or %NULL for all frequencies
231 * The frequency is set in MHz. The array is zero-terminated.
237 * struct wpa_driver_auth_params - Authentication parameters
238 * Data for struct wpa_driver_ops::authenticate().
240 struct wpa_driver_auth_params {
248 const u8 *wep_key[4];
249 size_t wep_key_len[4];
254 * struct wpa_driver_associate_params - Association parameters
255 * Data for struct wpa_driver_ops::associate().
257 struct wpa_driver_associate_params {
259 * bssid - BSSID of the selected AP
260 * This can be %NULL, if ap_scan=2 mode is used and the driver is
261 * responsible for selecting with which BSS to associate. */
265 * ssid - The selected SSID
271 * freq - Frequency of the channel the selected AP is using
272 * Frequency that the selected AP is using (in MHz as
273 * reported in the scan results)
278 * wpa_ie - WPA information element for (Re)Association Request
279 * WPA information element to be included in (Re)Association
280 * Request (including information element id and length). Use
281 * of this WPA IE is optional. If the driver generates the WPA
282 * IE, it can use pairwise_suite, group_suite, and
283 * key_mgmt_suite to select proper algorithms. In this case,
284 * the driver has to notify wpa_supplicant about the used WPA
285 * IE by generating an event that the interface code will
286 * convert into EVENT_ASSOCINFO data (see below).
288 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
289 * instead. The driver can determine which version is used by
290 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
293 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
297 * wpa_ie_len - length of the wpa_ie
301 /* The selected pairwise/group cipher and key management
302 * suites. These are usually ignored if @wpa_ie is used. */
303 wpa_cipher pairwise_suite;
304 wpa_cipher group_suite;
305 wpa_key_mgmt key_mgmt_suite;
308 * auth_alg - Allowed authentication algorithms
309 * Bit field of AUTH_ALG_*
314 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
319 * wep_key - WEP keys for static WEP configuration
321 const u8 *wep_key[4];
324 * wep_key_len - WEP key length for static WEP configuration
326 size_t wep_key_len[4];
329 * wep_tx_keyidx - WEP TX key index for static WEP configuration
334 * mgmt_frame_protection - IEEE 802.11w management frame protection
337 NO_MGMT_FRAME_PROTECTION,
338 MGMT_FRAME_PROTECTION_OPTIONAL,
339 MGMT_FRAME_PROTECTION_REQUIRED
340 } mgmt_frame_protection;
343 * ft_ies - IEEE 802.11r / FT information elements
344 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
345 * for fast transition, this parameter is set to include the IEs that
346 * are to be sent in the next FT Authentication Request message.
347 * update_ft_ies() handler is called to update the IEs for further
348 * FT messages in the sequence.
350 * The driver should use these IEs only if the target AP is advertising
351 * the same mobility domain as the one included in the MDIE here.
353 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
354 * AP after the initial association. These IEs can only be used if the
355 * target AP is advertising support for FT and is using the same MDIE
356 * and SSID as the current AP.
358 * The driver is responsible for reporting the FT IEs received from the
359 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
360 * type. update_ft_ies() handler will then be called with the FT IEs to
361 * include in the next frame in the authentication sequence.
366 * ft_ies_len - Length of ft_ies in bytes
371 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
373 * This value is provided to allow the driver interface easier access
374 * to the current mobility domain. This value is set to %NULL if no
375 * mobility domain is currently active.
380 * passphrase - RSN passphrase for PSK
382 * This value is made available only for WPA/WPA2-Personal (PSK) and
383 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
384 * the 8..63 character ASCII passphrase, if available. Please note that
385 * this can be %NULL if passphrase was not used to generate the PSK. In
386 * that case, the psk field must be used to fetch the PSK.
388 const char *passphrase;
391 * psk - RSN PSK (alternative for passphrase for PSK)
393 * This value is made available only for WPA/WPA2-Personal (PSK) and
394 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
395 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
396 * be prepared to handle %NULL value as an error.
401 * drop_unencrypted - Enable/disable unencrypted frame filtering
403 * Configure the driver to drop all non-EAPOL frames (both receive and
404 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
405 * still be allowed for key negotiation.
407 int drop_unencrypted;
411 * struct wpa_driver_capa - Driver capability information
413 struct wpa_driver_capa {
414 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
415 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
416 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
417 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
418 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
419 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
420 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
421 unsigned int key_mgmt;
423 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
424 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
425 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
426 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
429 #define WPA_DRIVER_AUTH_OPEN 0x00000001
430 #define WPA_DRIVER_AUTH_SHARED 0x00000002
431 #define WPA_DRIVER_AUTH_LEAP 0x00000004
434 /* Driver generated WPA/RSN IE */
435 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
436 /* Driver needs static WEP key setup after association command */
437 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
438 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
439 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
440 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
441 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
442 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
443 /* Driver provides separate commands for authentication and association (SME in
444 * wpa_supplicant). */
445 #define WPA_DRIVER_FLAGS_SME 0x00000020
446 /* Driver supports AP mode */
447 #define WPA_DRIVER_FLAGS_AP 0x00000040
448 /* Driver needs static WEP key setup after association has been completed */
449 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
456 struct ieee80211_rx_status {
464 struct hostap_sta_driver_data {
465 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
466 unsigned long current_tx_rate;
467 unsigned long inactive_msec;
469 unsigned long num_ps_buf_frames;
470 unsigned long tx_retry_failed;
471 unsigned long tx_retry_count;
476 struct hostapd_sta_add_params {
480 const u8 *supp_rates;
481 size_t supp_rates_len;
484 const struct ht_cap_ie *ht_capabilities;
487 struct hostapd_freq_params {
492 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
493 * secondary channel below primary, 1 = HT40
494 * enabled, secondary channel above primary */
497 enum hostapd_driver_if_type {
501 struct wpa_init_params {
506 const char *test_socket;
507 int use_pae_group_addr;
511 u8 *own_addr; /* buffer for writing own MAC address */
516 * struct wpa_driver_ops - Driver interface API definition
518 * This structure defines the API that each driver interface needs to implement
519 * for core wpa_supplicant code. All driver specific functionality is captured
522 struct wpa_driver_ops {
523 /** Name of the driver interface */
525 /** One line description of the driver interface */
529 * get_bssid - Get the current BSSID
530 * @priv: private driver interface data
531 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
533 * Returns: 0 on success, -1 on failure
535 * Query kernel driver for the current BSSID and copy it to bssid.
536 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
539 int (*get_bssid)(void *priv, u8 *bssid);
542 * get_ssid - Get the current SSID
543 * @priv: private driver interface data
544 * @ssid: buffer for SSID (at least 32 bytes)
546 * Returns: Length of the SSID on success, -1 on failure
548 * Query kernel driver for the current SSID and copy it to ssid.
549 * Returning zero is recommended if the STA is not associated.
551 * Note: SSID is an array of octets, i.e., it is not nul terminated and
552 * can, at least in theory, contain control characters (including nul)
553 * and as such, should be processed as binary data, not a printable
556 int (*get_ssid)(void *priv, u8 *ssid);
559 * set_wpa - Enable/disable WPA support (OBSOLETE)
560 * @priv: private driver interface data
561 * @enabled: 1 = enable, 0 = disable
563 * Returns: 0 on success, -1 on failure
565 * Note: This function is included for backwards compatibility. This is
566 * called only just after init and just before deinit, so these
567 * functions can be used to implement same functionality and the driver
568 * interface need not define this function.
570 * Configure the kernel driver to enable/disable WPA support. This may
571 * be empty function, if WPA support is always enabled. Common
572 * configuration items are WPA IE (clearing it when WPA support is
573 * disabled), Privacy flag configuration for capability field (note:
574 * this the value need to set in associate handler to allow plaintext
575 * mode to be used) when trying to associate with, roaming mode (can
576 * allow wpa_supplicant to control roaming if ap_scan=1 is used;
577 * however, drivers can also implement roaming if desired, especially
578 * ap_scan=2 mode is used for this).
580 int (*set_wpa)(void *priv, int enabled);
583 * set_key - Configure encryption key
584 * @priv: private driver interface data
585 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
586 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
587 * %WPA_ALG_NONE clears the key.
588 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
589 * broadcast/default keys
590 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
592 * @set_tx: configure this key as the default Tx key (only used when
593 * driver does not support separate unicast/individual key
594 * @seq: sequence number/packet number, seq_len octets, the next
595 * packet number to be used for in replay protection; configured
596 * for Rx keys (in most cases, this is only used with broadcast
597 * keys and set to zero for unicast keys)
598 * @seq_len: length of the seq, depends on the algorithm:
599 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
600 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
602 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
603 * TKIP: 32, CCMP: 16, IGTK: 16)
605 * Returns: 0 on success, -1 on failure
607 * Configure the given key for the kernel driver. If the driver
608 * supports separate individual keys (4 default keys + 1 individual),
609 * addr can be used to determine whether the key is default or
610 * individual. If only 4 keys are supported, the default key with key
611 * index 0 is used as the individual key. STA must be configured to use
612 * it as the default Tx key (set_tx is set) and accept Rx for all the
613 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
614 * broadcast keys, so key index 0 is available for this kind of
617 * Please note that TKIP keys include separate TX and RX MIC keys and
618 * some drivers may expect them in different order than wpa_supplicant
619 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
620 * will tricker Michael MIC errors. This can be fixed by changing the
621 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
622 * in driver_*.c set_key() implementation, see driver_ndis.c for an
623 * example on how this can be done.
625 int (*set_key)(void *priv, wpa_alg alg, const u8 *addr,
626 int key_idx, int set_tx, const u8 *seq, size_t seq_len,
627 const u8 *key, size_t key_len);
630 * init - Initialize driver interface
631 * @ctx: context to be used when calling wpa_supplicant functions,
632 * e.g., wpa_supplicant_event()
633 * @ifname: interface name, e.g., wlan0
635 * Returns: Pointer to private data, %NULL on failure
637 * Initialize driver interface, including event processing for kernel
638 * driver events (e.g., associated, scan results, Michael MIC failure).
639 * This function can allocate a private configuration data area for
640 * @ctx, file descriptor, interface name, etc. information that may be
641 * needed in future driver operations. If this is not used, non-NULL
642 * value will need to be returned because %NULL is used to indicate
643 * failure. The returned value will be used as 'void *priv' data for
644 * all other driver_ops functions.
646 * The main event loop (eloop.c) of wpa_supplicant can be used to
647 * register callback for read sockets (eloop_register_read_sock()).
649 * See below for more information about events and
650 * wpa_supplicant_event() function.
652 void * (*init)(void *ctx, const char *ifname);
655 * deinit - Deinitialize driver interface
656 * @priv: private driver interface data from init()
658 * Shut down driver interface and processing of driver events. Free
659 * private data buffer if one was allocated in init() handler.
661 void (*deinit)(void *priv);
664 * set_param - Set driver configuration parameters
665 * @priv: private driver interface data from init()
666 * @param: driver specific configuration parameters
668 * Returns: 0 on success, -1 on failure
670 * Optional handler for notifying driver interface about configuration
671 * parameters (driver_param).
673 int (*set_param)(void *priv, const char *param);
676 * set_countermeasures - Enable/disable TKIP countermeasures
677 * @priv: private driver interface data
678 * @enabled: 1 = countermeasures enabled, 0 = disabled
680 * Returns: 0 on success, -1 on failure
682 * Configure TKIP countermeasures. When these are enabled, the driver
683 * should drop all received and queued frames that are using TKIP.
685 int (*set_countermeasures)(void *priv, int enabled);
688 * set_drop_unencrypted - Enable/disable unencrypted frame filtering
689 * @priv: private driver interface data
690 * @enabled: 1 = unencrypted Tx/Rx frames will be dropped, 0 = disabled
692 * Returns: 0 on success, -1 on failure
694 * Configure the driver to drop all non-EAPOL frames (both receive and
695 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
696 * still be allowed for key negotiation.
698 * This function is deprecated. New driver wrapper implementations
699 * should use associate() parameter drop_unencrypted instead.
701 int (*set_drop_unencrypted)(void *priv, int enabled);
704 * scan - Request the driver to initiate scan (old version)
705 * @priv: private driver interface data
706 * @ssid: specific SSID to scan for (ProbeReq) or %NULL to scan for
707 * all SSIDs (either active scan with wildcard SSID or passive
709 * @ssid_len: length of the SSID
711 * Returns: 0 on success, -1 on failure
713 * Once the scan results are ready, the driver should report scan
714 * results event for wpa_supplicant which will eventually request the
715 * results with wpa_driver_get_scan_results().
717 * This function is deprecated. New driver wrapper implementations
718 * should implement support for scan2().
720 int (*scan)(void *priv, const u8 *ssid, size_t ssid_len);
723 * get_scan_results - Fetch the latest scan results (old version)
724 * @priv: private driver interface data
725 * @results: pointer to buffer for scan results
726 * @max_size: maximum number of entries (buffer size)
728 * Returns: Number of scan result entries used on success, -1 on
731 * If scan results include more than max_size BSSes, max_size will be
732 * returned and the remaining entries will not be included in the
735 * This function is deprecated. New driver wrapper implementations
736 * should implement support for get_scan_results2().
738 int (*get_scan_results)(void *priv,
739 struct wpa_scan_result *results,
743 * deauthenticate - Request driver to deauthenticate
744 * @priv: private driver interface data
745 * @addr: peer address (BSSID of the AP)
746 * @reason_code: 16-bit reason code to be sent in the deauthentication
749 * Returns: 0 on success, -1 on failure
751 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
754 * disassociate - Request driver to disassociate
755 * @priv: private driver interface data
756 * @addr: peer address (BSSID of the AP)
757 * @reason_code: 16-bit reason code to be sent in the disassociation
760 * Returns: 0 on success, -1 on failure
762 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
765 * associate - Request driver to associate
766 * @priv: private driver interface data
767 * @params: association parameters
769 * Returns: 0 on success, -1 on failure
771 int (*associate)(void *priv,
772 struct wpa_driver_associate_params *params);
775 * set_auth_alg - Set IEEE 802.11 authentication algorithm
776 * @priv: private driver interface data
777 * @auth_alg: bit field of AUTH_ALG_*
779 * If the driver supports more than one authentication algorithm at the
780 * same time, it should configure all supported algorithms. If not, one
781 * algorithm needs to be selected arbitrarily. Open System
782 * authentication should be ok for most cases and it is recommended to
783 * be used if other options are not supported. Static WEP configuration
784 * may also use Shared Key authentication and LEAP requires its own
785 * algorithm number. For LEAP, user can make sure that only one
786 * algorithm is used at a time by configuring LEAP as the only
787 * supported EAP method. This information is also available in
788 * associate() params, so set_auth_alg may not be needed in case of
791 * This function is deprecated. New driver wrapper implementations
792 * should use associate() parameter auth_alg instead.
794 * Returns: 0 on success, -1 on failure
796 int (*set_auth_alg)(void *priv, int auth_alg);
799 * add_pmkid - Add PMKSA cache entry to the driver
800 * @priv: private driver interface data
801 * @bssid: BSSID for the PMKSA cache entry
802 * @pmkid: PMKID for the PMKSA cache entry
804 * Returns: 0 on success, -1 on failure
806 * This function is called when a new PMK is received, as a result of
807 * either normal authentication or RSN pre-authentication.
809 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
810 * associate(), add_pmkid() can be used to add new PMKSA cache entries
811 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
812 * driver_ops function does not need to be implemented. Likewise, if
813 * the driver does not support WPA, this function is not needed.
815 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
818 * remove_pmkid - Remove PMKSA cache entry to the driver
819 * @priv: private driver interface data
820 * @bssid: BSSID for the PMKSA cache entry
821 * @pmkid: PMKID for the PMKSA cache entry
823 * Returns: 0 on success, -1 on failure
825 * This function is called when the supplicant drops a PMKSA cache
826 * entry for any reason.
828 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
829 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
830 * between the driver and wpa_supplicant. If the driver uses wpa_ie
831 * from wpa_supplicant, this driver_ops function does not need to be
832 * implemented. Likewise, if the driver does not support WPA, this
833 * function is not needed.
835 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
838 * flush_pmkid - Flush PMKSA cache
839 * @priv: private driver interface data
841 * Returns: 0 on success, -1 on failure
843 * This function is called when the supplicant drops all PMKSA cache
844 * entries for any reason.
846 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
847 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
848 * between the driver and wpa_supplicant. If the driver uses wpa_ie
849 * from wpa_supplicant, this driver_ops function does not need to be
850 * implemented. Likewise, if the driver does not support WPA, this
851 * function is not needed.
853 int (*flush_pmkid)(void *priv);
856 * get_capa - Get driver capabilities
857 * @priv: private driver interface data
859 * Returns: 0 on success, -1 on failure
861 * Get driver/firmware/hardware capabilities.
863 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
866 * poll - Poll driver for association information
867 * @priv: private driver interface data
869 * This is an option callback that can be used when the driver does not
870 * provide event mechanism for association events. This is called when
871 * receiving WPA EAPOL-Key messages that require association
872 * information. The driver interface is supposed to generate associnfo
873 * event before returning from this callback function. In addition, the
874 * driver interface should generate an association event after having
875 * sent out associnfo.
877 void (*poll)(void *priv);
880 * get_ifname - Get interface name
881 * @priv: private driver interface data
883 * Returns: Pointer to the interface name. This can differ from the
884 * interface name used in init() call. Init() is called first.
886 * This optional function can be used to allow the driver interface to
887 * replace the interface name with something else, e.g., based on an
888 * interface mapping from a more descriptive name.
890 const char * (*get_ifname)(void *priv);
893 * get_mac_addr - Get own MAC address
894 * @priv: private driver interface data
896 * Returns: Pointer to own MAC address or %NULL on failure
898 * This optional function can be used to get the own MAC address of the
899 * device from the driver interface code. This is only needed if the
900 * l2_packet implementation for the OS does not provide easy access to
902 const u8 * (*get_mac_addr)(void *priv);
905 * send_eapol - Optional function for sending EAPOL packets
906 * @priv: private driver interface data
907 * @dest: Destination MAC address
909 * @data: EAPOL packet starting with IEEE 802.1X header
910 * @data_len: Size of the EAPOL packet
912 * Returns: 0 on success, -1 on failure
914 * This optional function can be used to override l2_packet operations
915 * with driver specific functionality. If this function pointer is set,
916 * l2_packet module is not used at all and the driver interface code is
917 * responsible for receiving and sending all EAPOL packets. The
918 * received EAPOL packets are sent to core code by calling
919 * wpa_supplicant_rx_eapol(). The driver interface is required to
920 * implement get_mac_addr() handler if send_eapol() is used.
922 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
923 const u8 *data, size_t data_len);
926 * set_operstate - Sets device operating state to DORMANT or UP
927 * @priv: private driver interface data
928 * @state: 0 = dormant, 1 = up
929 * Returns: 0 on success, -1 on failure
931 * This is an optional function that can be used on operating systems
932 * that support a concept of controlling network device state from user
933 * space applications. This function, if set, gets called with
934 * state = 1 when authentication has been completed and with state = 0
935 * when connection is lost.
937 int (*set_operstate)(void *priv, int state);
940 * mlme_setprotection - MLME-SETPROTECTION.request primitive
941 * @priv: Private driver interface data
942 * @addr: Address of the station for which to set protection (may be
943 * %NULL for group keys)
944 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
945 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
946 * Returns: 0 on success, -1 on failure
948 * This is an optional function that can be used to set the driver to
949 * require protection for Tx and/or Rx frames. This uses the layer
950 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
951 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
952 * set protection operation; instead, they set protection implicitly
953 * based on configured keys.
955 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
959 * get_hw_feature_data - Get hardware support data (channels and rates)
960 * @priv: Private driver interface data
961 * @num_modes: Variable for returning the number of returned modes
962 * flags: Variable for returning hardware feature flags
963 * Returns: Pointer to allocated hardware data on success or %NULL on
964 * failure. Caller is responsible for freeing this.
966 * This function is only needed for drivers that export MLME
967 * (management frame processing) to wpa_supplicant.
969 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
974 * set_channel - Set channel
975 * @priv: Private driver interface data
976 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
977 * @chan: IEEE 802.11 channel number
978 * @freq: Frequency of the channel in MHz
979 * Returns: 0 on success, -1 on failure
981 * This function is only needed for drivers that export MLME
982 * (management frame processing) to wpa_supplicant.
984 int (*set_channel)(void *priv, hostapd_hw_mode phymode, int chan,
988 * set_ssid - Set SSID
989 * @priv: Private driver interface data
991 * @ssid_len: SSID length
992 * Returns: 0 on success, -1 on failure
994 * This function is only needed for drivers that export MLME
995 * (management frame processing) to wpa_supplicant.
997 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
1000 * set_bssid - Set BSSID
1001 * @priv: Private driver interface data
1003 * Returns: 0 on success, -1 on failure
1005 * This function is only needed for drivers that export MLME
1006 * (management frame processing) to wpa_supplicant.
1008 int (*set_bssid)(void *priv, const u8 *bssid);
1011 * send_mlme - Send management frame from MLME
1012 * @priv: Private driver interface data
1013 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1014 * @data_len: Size of the management frame
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 (*send_mlme)(void *priv, const u8 *data, size_t data_len);
1023 * mlme_add_sta - Add a STA entry into the driver/netstack
1024 * @priv: Private driver interface data
1025 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1026 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
1027 * format (one octet per rate, 1 = 0.5 Mbps)
1028 * @supp_rates_len: Number of entries in supp_rates
1029 * Returns: 0 on success, -1 on failure
1031 * This function is only needed for drivers that export MLME
1032 * (management frame processing) to wpa_supplicant. When the MLME code
1033 * completes association with an AP, this function is called to
1034 * configure the driver/netstack with a STA entry for data frame
1035 * processing (TX rate control, encryption/decryption).
1037 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
1038 size_t supp_rates_len);
1041 * mlme_remove_sta - Remove a STA entry from the driver/netstack
1042 * @priv: Private driver interface data
1043 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1044 * Returns: 0 on success, -1 on failure
1046 * This function is only needed for drivers that export MLME
1047 * (management frame processing) to wpa_supplicant.
1049 int (*mlme_remove_sta)(void *priv, const u8 *addr);
1052 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1053 * @priv: Private driver interface data
1054 * @md: Mobility domain (2 octets) (also included inside ies)
1055 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1056 * @ies_len: Length of FT IEs in bytes
1057 * Returns: 0 on success, -1 on failure
1059 * The supplicant uses this callback to let the driver know that keying
1060 * material for FT is available and that the driver can use the
1061 * provided IEs in the next message in FT authentication sequence.
1063 * This function is only needed for driver that support IEEE 802.11r
1064 * (Fast BSS Transition).
1066 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1070 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1071 * @priv: Private driver interface data
1072 * @action: Action field value
1073 * @target_ap: Target AP address
1074 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1075 * @ies_len: Length of FT IEs in bytes
1076 * Returns: 0 on success, -1 on failure
1078 * The supplicant uses this callback to request the driver to transmit
1079 * an FT Action frame (action category 6) for over-the-DS fast BSS
1082 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1083 const u8 *ies, size_t ies_len);
1086 * get_scan_results2 - Fetch the latest scan results
1087 * @priv: private driver interface data
1089 * Returns: Allocated buffer of scan results (caller is responsible for
1090 * freeing the data structure) on success, NULL on failure
1092 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1095 * set_probe_req_ie - Set information element(s) for Probe Request
1096 * @priv: private driver interface data
1097 * @ies: Information elements to append or %NULL to remove extra IEs
1098 * @ies_len: Length of the IE buffer in octets
1099 * Returns: 0 on success, -1 on failure
1101 int (*set_probe_req_ie)(void *priv, const u8 *ies, size_t ies_len);
1104 * set_mode - Request driver to set the operating mode
1105 * @priv: private driver interface data
1106 * @mode: Operation mode (infra/ibss) IEEE80211_MODE_*
1108 * This handler will be called before any key configuration and call to
1109 * associate() handler in order to allow the operation mode to be
1110 * configured as early as possible. This information is also available
1111 * in associate() params and as such, driver wrappers may not need
1112 * to implement set_mode() handler.
1114 * This function is deprecated. New driver wrapper implementations
1115 * should use associate() parameter mode instead.
1117 * Returns: 0 on success, -1 on failure
1119 int (*set_mode)(void *priv, int mode);
1122 * set_country - Set country
1123 * @priv: Private driver interface data
1124 * @alpha2: country to which to switch to
1125 * Returns: 0 on success, -1 on failure
1127 * This function is for drivers which support some form
1128 * of setting a regulatory domain.
1130 int (*set_country)(void *priv, const char *alpha2);
1133 * global_init - Global driver initialization
1134 * Returns: Pointer to private data (global), %NULL on failure
1136 * This optional function is called to initialize the driver wrapper
1137 * for global data, i.e., data that applies to all interfaces. If this
1138 * function is implemented, global_deinit() will also need to be
1139 * implemented to free the private data. The driver will also likely
1140 * use init2() function instead of init() to get the pointer to global
1141 * data available to per-interface initializer.
1143 void * (*global_init)(void);
1146 * global_deinit - Global driver deinitialization
1147 * @priv: private driver global data from global_init()
1149 * Terminate any global driver related functionality and free the
1150 * global data structure.
1152 void (*global_deinit)(void *priv);
1155 * init2 - Initialize driver interface (with global data)
1156 * @ctx: context to be used when calling wpa_supplicant functions,
1157 * e.g., wpa_supplicant_event()
1158 * @ifname: interface name, e.g., wlan0
1159 * @global_priv: private driver global data from global_init()
1160 * Returns: Pointer to private data, %NULL on failure
1162 * This function can be used instead of init() if the driver wrapper
1165 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1168 * get_interfaces - Get information about available interfaces
1169 * @global_priv: private driver global data from global_init()
1170 * Returns: Allocated buffer of interface information (caller is
1171 * responsible for freeing the data structure) on success, NULL on
1174 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1177 * scan2 - Request the driver to initiate scan
1178 * @priv: private driver interface data
1179 * @params: Scan parameters
1181 * Returns: 0 on success, -1 on failure
1183 * Once the scan results are ready, the driver should report scan
1184 * results event for wpa_supplicant which will eventually request the
1185 * results with wpa_driver_get_scan_results2().
1187 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1190 * authenticate - Request driver to authenticate
1191 * @priv: private driver interface data
1192 * @params: authentication parameters
1193 * Returns: 0 on success, -1 on failure
1195 * This is an optional function that can be used with drivers that
1196 * support separate authentication and association steps, i.e., when
1197 * wpa_supplicant can act as the SME. If not implemented, associate()
1198 * function is expected to take care of IEEE 802.11 authentication,
1201 int (*authenticate)(void *priv,
1202 struct wpa_driver_auth_params *params);
1204 int (*set_beacon)(void *priv, const u8 *head, size_t head_len,
1205 const u8 *tail, size_t tail_len, int dtim_period);
1207 int (*set_beacon_int)(void *priv, int value);
1209 void * (*hapd_init)(struct hostapd_data *hapd,
1210 struct wpa_init_params *params);
1211 void (*hapd_deinit)(void *priv);
1214 * set_8021x - enable/disable IEEE 802.1X support
1215 * @ifname: Interface name (for multi-SSID/VLAN support)
1216 * @priv: driver private data
1217 * @enabled: 1 = enable, 0 = disable
1219 * Returns: 0 on success, -1 on failure
1221 * Configure the kernel driver to enable/disable 802.1X support.
1222 * This may be an empty function if 802.1X support is always enabled.
1224 int (*set_ieee8021x)(const char *ifname, void *priv, int enabled);
1227 * set_privacy - enable/disable privacy
1228 * @priv: driver private data
1229 * @enabled: 1 = privacy enabled, 0 = disabled
1231 * Return: 0 on success, -1 on failure
1233 * Configure privacy.
1235 int (*set_privacy)(const char *ifname, void *priv, int enabled);
1237 int (*hapd_set_key)(const char *ifname, void *priv, wpa_alg alg,
1238 const u8 *addr, int key_idx, int set_tx,
1239 const u8 *seq, size_t seq_len,
1240 const u8 *key, size_t key_len);
1241 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1243 int (*get_seqnum_igtk)(const char *ifname, void *priv, const u8 *addr,
1245 int (*flush)(void *priv);
1246 int (*set_generic_elem)(const char *ifname, void *priv, const u8 *elem,
1249 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1251 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1252 size_t data_len, int encrypt,
1253 const u8 *own_addr);
1254 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1256 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1258 int (*sta_remove)(void *priv, const u8 *addr);
1259 int (*hapd_get_ssid)(const char *ifname, void *priv, u8 *buf, int len);
1260 int (*hapd_set_ssid)(const char *ifname, void *priv, const u8 *buf,
1262 int (*hapd_set_countermeasures)(void *priv, int enabled);
1263 int (*sta_add)(const char *ifname, void *priv,
1264 struct hostapd_sta_add_params *params);
1265 int (*get_inact_sec)(void *priv, const u8 *addr);
1266 int (*sta_clear_stats)(void *priv, const u8 *addr);
1268 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1269 int (*set_rts)(void *priv, int rts);
1270 int (*set_frag)(void *priv, int frag);
1272 int (*sta_set_flags)(void *priv, const u8 *addr,
1273 int total_flags, int flags_or, int flags_and);
1274 int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
1276 int (*hapd_set_beacon)(const char *ifname, void *priv,
1277 const u8 *head, size_t head_len,
1278 const u8 *tail, size_t tail_len,
1281 /* Configure internal bridge:
1282 * 0 = disabled, i.e., client separation is enabled (no bridging of
1283 * packets between associated STAs
1284 * 1 = enabled, i.e., bridge packets between associated STAs (default)
1286 int (*set_internal_bridge)(void *priv, int value);
1287 int (*set_cts_protect)(void *priv, int value);
1288 int (*set_preamble)(void *priv, int value);
1289 int (*set_short_slot_time)(void *priv, int value);
1290 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1291 int cw_max, int burst_time);
1292 int (*bss_add)(void *priv, const char *ifname, const u8 *bssid);
1293 int (*bss_remove)(void *priv, const char *ifname);
1294 int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
1295 int (*if_add)(const char *iface, void *priv,
1296 enum hostapd_driver_if_type type, char *ifname,
1298 int (*if_update)(void *priv, enum hostapd_driver_if_type type,
1299 char *ifname, const u8 *addr);
1300 int (*if_remove)(void *priv, enum hostapd_driver_if_type type,
1301 const char *ifname, const u8 *addr);
1302 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1305 * commit - Optional commit changes handler
1306 * @priv: driver private data
1307 * Returns: 0 on success, -1 on failure
1309 * This optional handler function can be registered if the driver
1310 * interface implementation needs to commit changes (e.g., by setting
1311 * network interface up) at the end of initial configuration. If set,
1312 * this handler will be called after initial setup has been completed.
1314 int (*commit)(void *priv);
1316 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1317 const u8 *data, size_t data_len);
1319 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1320 u32 session_timeout);
1321 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1323 int (*set_ht_params)(const char *ifname, void *priv,
1324 const u8 *ht_capab, size_t ht_capab_len,
1325 const u8 *ht_oper, size_t ht_oper_len);
1327 int (*set_wps_beacon_ie)(const char *ifname, void *priv,
1328 const u8 *ie, size_t len);
1329 int (*set_wps_probe_resp_ie)(const char *ifname, void *priv,
1330 const u8 *ie, size_t len);
1333 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1334 * @priv: Private driver interface data
1335 * @authorized: Whether the port is authorized
1336 * Returns: 0 on success, -1 on failure
1338 int (*set_supp_port)(void *priv, int authorized);
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.
1506 * EVENT_AUTH_TIMED_OUT - Authentication timed out
1508 EVENT_AUTH_TIMED_OUT,
1511 * EVENT_ASSOC_TIMED_OUT - Association timed out
1513 EVENT_ASSOC_TIMED_OUT
1518 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
1520 union wpa_event_data {
1522 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
1524 * This structure is optional for EVENT_ASSOC calls and required for
1525 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
1526 * driver interface does not need to generate separate EVENT_ASSOCINFO
1531 * req_ies - (Re)Association Request IEs
1533 * If the driver generates WPA/RSN IE, this event data must be
1534 * returned for WPA handshake to have needed information. If
1535 * wpa_supplicant-generated WPA/RSN IE is used, this
1536 * information event is optional.
1538 * This should start with the first IE (fixed fields before IEs
1539 * are not included).
1544 * req_ies_len - Length of req_ies in bytes
1549 * resp_ies - (Re)Association Response IEs
1551 * Optional association data from the driver. This data is not
1552 * required WPA, but may be useful for some protocols and as
1553 * such, should be reported if this is available to the driver
1556 * This should start with the first IE (fixed fields before IEs
1557 * are not included).
1562 * resp_ies_len - Length of resp_ies in bytes
1564 size_t resp_ies_len;
1567 * beacon_ies - Beacon or Probe Response IEs
1569 * Optional Beacon/ProbeResp data: IEs included in Beacon or
1570 * Probe Response frames from the current AP (i.e., the one
1571 * that the client just associated with). This information is
1572 * used to update WPA/RSN IE for the AP. If this field is not
1573 * set, the results from previous scan will be used. If no
1574 * data for the new AP is found, scan results will be requested
1575 * again (without scan request). At this point, the driver is
1576 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
1579 * This should start with the first IE (fixed fields before IEs
1580 * are not included).
1585 * beacon_ies_len - Length of beacon_ies */
1586 size_t beacon_ies_len;
1590 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
1592 struct michael_mic_failure {
1595 } michael_mic_failure;
1598 * struct interface_status - Data for EVENT_INTERFACE_STATUS
1600 struct interface_status {
1603 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
1608 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
1610 struct pmkid_candidate {
1611 /** BSSID of the PMKID candidate */
1613 /** Smaller the index, higher the priority */
1615 /** Whether RSN IE includes pre-authenticate flag */
1620 * struct stkstart - Data for EVENT_STKSTART
1627 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
1629 * During FT (IEEE 802.11r) authentication sequence, the driver is
1630 * expected to use this event to report received FT IEs (MDIE, FTIE,
1631 * RSN IE, TIE, possible resource request) to the supplicant. The FT
1632 * IEs for the next message will be delivered through the
1633 * struct wpa_driver_ops::update_ft_ies() callback.
1639 u8 target_ap[ETH_ALEN];
1640 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
1642 /** Length of ric_ies buffer in octets */
1647 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
1649 struct ibss_rsn_start {
1654 * struct auth_info - Data for EVENT_AUTH events
1665 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
1667 struct assoc_reject {
1669 * resp_ies - (Re)Association Response IEs
1671 * Optional association data from the driver. This data is not
1672 * required WPA, but may be useful for some protocols and as
1673 * such, should be reported if this is available to the driver
1676 * This should start with the first IE (fixed fields before IEs
1677 * are not included).
1682 * resp_ies_len - Length of resp_ies in bytes
1684 size_t resp_ies_len;
1687 * status_code - Status Code from (Re)association Response
1692 struct timeout_event {
1698 * wpa_supplicant_event - Report a driver event for wpa_supplicant
1699 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1700 * with struct wpa_driver_ops::init()
1701 * @event: event type (defined above)
1702 * @data: possible extra data for the event
1704 * Driver wrapper code should call this function whenever an event is received
1707 void wpa_supplicant_event(void *ctx, wpa_event_type event,
1708 union wpa_event_data *data);
1711 * wpa_supplicant_rx_eapol - Deliver a received EAPOL frame to wpa_supplicant
1712 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1713 * with struct wpa_driver_ops::init()
1714 * @src_addr: Source address of the EAPOL frame
1715 * @buf: EAPOL data starting from the EAPOL header (i.e., no Ethernet header)
1716 * @len: Length of the EAPOL data
1718 * This function is called for each received EAPOL frame. Most driver
1719 * interfaces rely on more generic OS mechanism for receiving frames through
1720 * l2_packet, but if such a mechanism is not available, the driver wrapper may
1721 * take care of received EAPOL frames and deliver them to the core supplicant
1722 * code by calling this function.
1724 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
1725 const u8 *buf, size_t len);
1727 void wpa_supplicant_sta_rx(void *ctx, const u8 *buf, size_t len,
1728 struct ieee80211_rx_status *rx_status);
1730 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie);
1731 #define WPA_IE_VENDOR_TYPE 0x0050f201
1732 #define WPS_IE_VENDOR_TYPE 0x0050f204
1733 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
1735 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
1737 int wpa_scan_get_max_rate(const struct wpa_scan_res *res);
1738 void wpa_scan_results_free(struct wpa_scan_results *res);
1739 void wpa_scan_sort_results(struct wpa_scan_results *res);
1741 /* hostapd functions for driver wrappers */
1744 struct ieee80211_hdr;
1746 void hostapd_new_assoc_sta(struct hostapd_data *hapd, struct sta_info *sta,
1748 void hostapd_tx_status(struct hostapd_data *hapd, const u8 *addr,
1749 const u8 *buf, size_t len, int ack);
1750 void hostapd_rx_from_unknown_sta(struct hostapd_data *hapd,
1751 const struct ieee80211_hdr *hdr, size_t len);
1752 int hostapd_notif_assoc(struct hostapd_data *hapd, const u8 *addr,
1753 const u8 *ie, size_t ielen);
1754 void hostapd_notif_disassoc(struct hostapd_data *hapd, const u8 *addr);
1755 void hostapd_eapol_receive(struct hostapd_data *hapd, const u8 *sa,
1756 const u8 *buf, size_t len);
1758 struct hostapd_frame_info {
1765 void hostapd_mgmt_rx(struct hostapd_data *hapd, u8 *buf, size_t len,
1766 u16 stype, struct hostapd_frame_info *fi);
1767 void hostapd_mgmt_tx_cb(struct hostapd_data *hapd, u8 *buf, size_t len,
1769 void hostapd_michael_mic_failure(struct hostapd_data *hapd, const u8 *addr);
1770 struct hostapd_data * hostapd_sta_get_bss(struct hostapd_data *hapd,
1772 void hostapd_probe_req_rx(struct hostapd_data *hapd, const u8 *sa,
1773 const u8 *ie, size_t ie_len);
1775 #endif /* DRIVER_H */