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 4
20 #include "common/defs.h"
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;
59 #define AUTH_ALG_OPEN_SYSTEM 0x01
60 #define AUTH_ALG_SHARED_KEY 0x02
61 #define AUTH_ALG_LEAP 0x04
62 #define AUTH_ALG_FT 0x08
64 #define IEEE80211_MODE_INFRA 0
65 #define IEEE80211_MODE_IBSS 1
66 #define IEEE80211_MODE_AP 2
68 #define IEEE80211_CAP_ESS 0x0001
69 #define IEEE80211_CAP_IBSS 0x0002
70 #define IEEE80211_CAP_PRIVACY 0x0010
72 #define WPA_SCAN_QUAL_INVALID BIT(0)
73 #define WPA_SCAN_NOISE_INVALID BIT(1)
74 #define WPA_SCAN_LEVEL_INVALID BIT(2)
75 #define WPA_SCAN_LEVEL_DBM BIT(3)
76 #define WPA_SCAN_AUTHENTICATED BIT(4)
77 #define WPA_SCAN_ASSOCIATED BIT(5)
80 * struct wpa_scan_res - Scan result for an BSS/IBSS
81 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
83 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
84 * @beacon_int: beacon interval in TUs (host byte order)
85 * @caps: capability information field in host byte order
86 * @qual: signal quality
88 * @level: signal level
90 * @age: Age of the information in milliseconds (i.e., how many milliseconds
91 * ago the last Beacon or Probe Response frame was received)
92 * @ie_len: length of the following IE field in octets
94 * This structure is used as a generic format for scan results from the
95 * driver. Each driver interface implementation is responsible for converting
96 * the driver or OS specific scan results into this format.
98 * If the driver does not support reporting all IEs, the IE data structure is
99 * constructed of the IEs that are available. This field will also need to
100 * include SSID in IE format. All drivers are encouraged to be extended to
101 * report all IEs to make it easier to support future additions.
103 struct wpa_scan_res {
115 /* followed by ie_len octets of IEs */
119 * struct wpa_scan_results - Scan results
120 * @res: Array of pointers to allocated variable length scan result entries
121 * @num: Number of entries in the scan result array
123 struct wpa_scan_results {
124 struct wpa_scan_res **res;
129 * struct wpa_interface_info - Network interface information
130 * @next: Pointer to the next interface or NULL if this is the last one
131 * @ifname: Interface name that can be used with init() or init2()
132 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
134 * @drv_bame: struct wpa_driver_ops::name (note: unlike other strings, this one
135 * is not an allocated copy, i.e., get_interfaces() caller will not free
138 struct wpa_interface_info {
139 struct wpa_interface_info *next;
142 const char *drv_name;
145 #define WPAS_MAX_SCAN_SSIDS 4
148 * struct wpa_driver_scan_params - Scan parameters
149 * Data for struct wpa_driver_ops::scan2().
151 struct wpa_driver_scan_params {
153 * ssids - SSIDs to scan for
155 struct wpa_driver_scan_ssid {
157 * ssid - specific SSID to scan for (ProbeReq)
158 * %NULL or zero-length SSID is used to indicate active scan
159 * with wildcard SSID.
163 * ssid_len: Length of the SSID in octets
166 } ssids[WPAS_MAX_SCAN_SSIDS];
169 * num_ssids - Number of entries in ssids array
170 * Zero indicates a request for a passive scan.
175 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
180 * extra_ies_len - Length of extra_ies in octets
182 size_t extra_ies_len;
185 * freqs - Array of frequencies to scan or %NULL for all frequencies
187 * The frequency is set in MHz. The array is zero-terminated.
193 * struct wpa_driver_auth_params - Authentication parameters
194 * Data for struct wpa_driver_ops::authenticate().
196 struct wpa_driver_auth_params {
204 const u8 *wep_key[4];
205 size_t wep_key_len[4];
210 * struct wpa_driver_associate_params - Association parameters
211 * Data for struct wpa_driver_ops::associate().
213 struct wpa_driver_associate_params {
215 * bssid - BSSID of the selected AP
216 * This can be %NULL, if ap_scan=2 mode is used and the driver is
217 * responsible for selecting with which BSS to associate. */
221 * ssid - The selected SSID
227 * freq - Frequency of the channel the selected AP is using
228 * Frequency that the selected AP is using (in MHz as
229 * reported in the scan results)
234 * wpa_ie - WPA information element for (Re)Association Request
235 * WPA information element to be included in (Re)Association
236 * Request (including information element id and length). Use
237 * of this WPA IE is optional. If the driver generates the WPA
238 * IE, it can use pairwise_suite, group_suite, and
239 * key_mgmt_suite to select proper algorithms. In this case,
240 * the driver has to notify wpa_supplicant about the used WPA
241 * IE by generating an event that the interface code will
242 * convert into EVENT_ASSOCINFO data (see below).
244 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
245 * instead. The driver can determine which version is used by
246 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
249 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
253 * wpa_ie_len - length of the wpa_ie
257 /* The selected pairwise/group cipher and key management
258 * suites. These are usually ignored if @wpa_ie is used. */
259 wpa_cipher pairwise_suite;
260 wpa_cipher group_suite;
261 wpa_key_mgmt key_mgmt_suite;
264 * auth_alg - Allowed authentication algorithms
265 * Bit field of AUTH_ALG_*
270 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
275 * wep_key - WEP keys for static WEP configuration
277 const u8 *wep_key[4];
280 * wep_key_len - WEP key length for static WEP configuration
282 size_t wep_key_len[4];
285 * wep_tx_keyidx - WEP TX key index for static WEP configuration
290 * mgmt_frame_protection - IEEE 802.11w management frame protection
293 NO_MGMT_FRAME_PROTECTION,
294 MGMT_FRAME_PROTECTION_OPTIONAL,
295 MGMT_FRAME_PROTECTION_REQUIRED
296 } mgmt_frame_protection;
299 * ft_ies - IEEE 802.11r / FT information elements
300 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
301 * for fast transition, this parameter is set to include the IEs that
302 * are to be sent in the next FT Authentication Request message.
303 * update_ft_ies() handler is called to update the IEs for further
304 * FT messages in the sequence.
306 * The driver should use these IEs only if the target AP is advertising
307 * the same mobility domain as the one included in the MDIE here.
309 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
310 * AP after the initial association. These IEs can only be used if the
311 * target AP is advertising support for FT and is using the same MDIE
312 * and SSID as the current AP.
314 * The driver is responsible for reporting the FT IEs received from the
315 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
316 * type. update_ft_ies() handler will then be called with the FT IEs to
317 * include in the next frame in the authentication sequence.
322 * ft_ies_len - Length of ft_ies in bytes
327 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
329 * This value is provided to allow the driver interface easier access
330 * to the current mobility domain. This value is set to %NULL if no
331 * mobility domain is currently active.
336 * passphrase - RSN passphrase for PSK
338 * This value is made available only for WPA/WPA2-Personal (PSK) and
339 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
340 * the 8..63 character ASCII passphrase, if available. Please note that
341 * this can be %NULL if passphrase was not used to generate the PSK. In
342 * that case, the psk field must be used to fetch the PSK.
344 const char *passphrase;
347 * psk - RSN PSK (alternative for passphrase for PSK)
349 * This value is made available only for WPA/WPA2-Personal (PSK) and
350 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
351 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
352 * be prepared to handle %NULL value as an error.
357 * drop_unencrypted - Enable/disable unencrypted frame filtering
359 * Configure the driver to drop all non-EAPOL frames (both receive and
360 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
361 * still be allowed for key negotiation.
363 int drop_unencrypted;
366 * prev_bssid - Previously used BSSID in this ESS
368 * When not %NULL, this is a request to use reassociation instead of
371 const u8 *prev_bssid;
375 * struct wpa_driver_capa - Driver capability information
377 struct wpa_driver_capa {
378 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
379 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
380 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
381 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
382 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
383 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
384 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
385 unsigned int key_mgmt;
387 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
388 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
389 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
390 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
393 #define WPA_DRIVER_AUTH_OPEN 0x00000001
394 #define WPA_DRIVER_AUTH_SHARED 0x00000002
395 #define WPA_DRIVER_AUTH_LEAP 0x00000004
398 /* Driver generated WPA/RSN IE */
399 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
400 /* Driver needs static WEP key setup after association command */
401 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
402 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
403 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
404 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
405 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
406 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
407 /* Driver provides separate commands for authentication and association (SME in
408 * wpa_supplicant). */
409 #define WPA_DRIVER_FLAGS_SME 0x00000020
410 /* Driver supports AP mode */
411 #define WPA_DRIVER_FLAGS_AP 0x00000040
412 /* Driver needs static WEP key setup after association has been completed */
413 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
420 struct ieee80211_rx_status {
428 struct hostap_sta_driver_data {
429 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
430 unsigned long current_tx_rate;
431 unsigned long inactive_msec;
433 unsigned long num_ps_buf_frames;
434 unsigned long tx_retry_failed;
435 unsigned long tx_retry_count;
440 struct hostapd_sta_add_params {
444 const u8 *supp_rates;
445 size_t supp_rates_len;
448 const struct ieee80211_ht_capabilities *ht_capabilities;
451 struct hostapd_freq_params {
456 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
457 * secondary channel below primary, 1 = HT40
458 * enabled, secondary channel above primary */
461 enum hostapd_driver_if_type {
465 struct wpa_init_params {
470 const char *test_socket;
471 int use_pae_group_addr;
475 u8 *own_addr; /* buffer for writing own MAC address */
480 * struct wpa_driver_ops - Driver interface API definition
482 * This structure defines the API that each driver interface needs to implement
483 * for core wpa_supplicant code. All driver specific functionality is captured
486 struct wpa_driver_ops {
487 /** Name of the driver interface */
489 /** One line description of the driver interface */
493 * get_bssid - Get the current BSSID
494 * @priv: private driver interface data
495 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
497 * Returns: 0 on success, -1 on failure
499 * Query kernel driver for the current BSSID and copy it to bssid.
500 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
503 int (*get_bssid)(void *priv, u8 *bssid);
506 * get_ssid - Get the current SSID
507 * @priv: private driver interface data
508 * @ssid: buffer for SSID (at least 32 bytes)
510 * Returns: Length of the SSID on success, -1 on failure
512 * Query kernel driver for the current SSID and copy it to ssid.
513 * Returning zero is recommended if the STA is not associated.
515 * Note: SSID is an array of octets, i.e., it is not nul terminated and
516 * can, at least in theory, contain control characters (including nul)
517 * and as such, should be processed as binary data, not a printable
520 int (*get_ssid)(void *priv, u8 *ssid);
523 * set_key - Configure encryption key
524 * @ifname: Interface name (for multi-SSID/VLAN support)
525 * @priv: private driver interface data
526 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
527 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
528 * %WPA_ALG_NONE clears the key.
529 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
530 * broadcast/default keys
531 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
533 * @set_tx: configure this key as the default Tx key (only used when
534 * driver does not support separate unicast/individual key
535 * @seq: sequence number/packet number, seq_len octets, the next
536 * packet number to be used for in replay protection; configured
537 * for Rx keys (in most cases, this is only used with broadcast
538 * keys and set to zero for unicast keys)
539 * @seq_len: length of the seq, depends on the algorithm:
540 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
541 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
543 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
544 * TKIP: 32, CCMP: 16, IGTK: 16)
546 * Returns: 0 on success, -1 on failure
548 * Configure the given key for the kernel driver. If the driver
549 * supports separate individual keys (4 default keys + 1 individual),
550 * addr can be used to determine whether the key is default or
551 * individual. If only 4 keys are supported, the default key with key
552 * index 0 is used as the individual key. STA must be configured to use
553 * it as the default Tx key (set_tx is set) and accept Rx for all the
554 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
555 * broadcast keys, so key index 0 is available for this kind of
558 * Please note that TKIP keys include separate TX and RX MIC keys and
559 * some drivers may expect them in different order than wpa_supplicant
560 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
561 * will tricker Michael MIC errors. This can be fixed by changing the
562 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
563 * in driver_*.c set_key() implementation, see driver_ndis.c for an
564 * example on how this can be done.
566 int (*set_key)(const char *ifname, void *priv, wpa_alg alg,
567 const u8 *addr, int key_idx, int set_tx,
568 const u8 *seq, size_t seq_len,
569 const u8 *key, size_t key_len);
572 * init - Initialize driver interface
573 * @ctx: context to be used when calling wpa_supplicant functions,
574 * e.g., wpa_supplicant_event()
575 * @ifname: interface name, e.g., wlan0
577 * Returns: Pointer to private data, %NULL on failure
579 * Initialize driver interface, including event processing for kernel
580 * driver events (e.g., associated, scan results, Michael MIC failure).
581 * This function can allocate a private configuration data area for
582 * @ctx, file descriptor, interface name, etc. information that may be
583 * needed in future driver operations. If this is not used, non-NULL
584 * value will need to be returned because %NULL is used to indicate
585 * failure. The returned value will be used as 'void *priv' data for
586 * all other driver_ops functions.
588 * The main event loop (eloop.c) of wpa_supplicant can be used to
589 * register callback for read sockets (eloop_register_read_sock()).
591 * See below for more information about events and
592 * wpa_supplicant_event() function.
594 void * (*init)(void *ctx, const char *ifname);
597 * deinit - Deinitialize driver interface
598 * @priv: private driver interface data from init()
600 * Shut down driver interface and processing of driver events. Free
601 * private data buffer if one was allocated in init() handler.
603 void (*deinit)(void *priv);
606 * set_param - Set driver configuration parameters
607 * @priv: private driver interface data from init()
608 * @param: driver specific configuration parameters
610 * Returns: 0 on success, -1 on failure
612 * Optional handler for notifying driver interface about configuration
613 * parameters (driver_param).
615 int (*set_param)(void *priv, const char *param);
618 * set_countermeasures - Enable/disable TKIP countermeasures
619 * @priv: private driver interface data
620 * @enabled: 1 = countermeasures enabled, 0 = disabled
622 * Returns: 0 on success, -1 on failure
624 * Configure TKIP countermeasures. When these are enabled, the driver
625 * should drop all received and queued frames that are using TKIP.
627 int (*set_countermeasures)(void *priv, int enabled);
630 * deauthenticate - Request driver to deauthenticate
631 * @priv: private driver interface data
632 * @addr: peer address (BSSID of the AP)
633 * @reason_code: 16-bit reason code to be sent in the deauthentication
636 * Returns: 0 on success, -1 on failure
638 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
641 * disassociate - Request driver to disassociate
642 * @priv: private driver interface data
643 * @addr: peer address (BSSID of the AP)
644 * @reason_code: 16-bit reason code to be sent in the disassociation
647 * Returns: 0 on success, -1 on failure
649 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
652 * associate - Request driver to associate
653 * @priv: private driver interface data
654 * @params: association parameters
656 * Returns: 0 on success, -1 on failure
658 int (*associate)(void *priv,
659 struct wpa_driver_associate_params *params);
662 * add_pmkid - Add PMKSA cache entry to the driver
663 * @priv: private driver interface data
664 * @bssid: BSSID for the PMKSA cache entry
665 * @pmkid: PMKID for the PMKSA cache entry
667 * Returns: 0 on success, -1 on failure
669 * This function is called when a new PMK is received, as a result of
670 * either normal authentication or RSN pre-authentication.
672 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
673 * associate(), add_pmkid() can be used to add new PMKSA cache entries
674 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
675 * driver_ops function does not need to be implemented. Likewise, if
676 * the driver does not support WPA, this function is not needed.
678 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
681 * remove_pmkid - Remove PMKSA cache entry to the driver
682 * @priv: private driver interface data
683 * @bssid: BSSID for the PMKSA cache entry
684 * @pmkid: PMKID for the PMKSA cache entry
686 * Returns: 0 on success, -1 on failure
688 * This function is called when the supplicant drops a PMKSA cache
689 * entry for any reason.
691 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
692 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
693 * between the driver and wpa_supplicant. If the driver uses wpa_ie
694 * from wpa_supplicant, this driver_ops function does not need to be
695 * implemented. Likewise, if the driver does not support WPA, this
696 * function is not needed.
698 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
701 * flush_pmkid - Flush PMKSA cache
702 * @priv: private driver interface data
704 * Returns: 0 on success, -1 on failure
706 * This function is called when the supplicant drops all PMKSA cache
707 * entries for any reason.
709 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
710 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
711 * between the driver and wpa_supplicant. If the driver uses wpa_ie
712 * from wpa_supplicant, this driver_ops function does not need to be
713 * implemented. Likewise, if the driver does not support WPA, this
714 * function is not needed.
716 int (*flush_pmkid)(void *priv);
719 * get_capa - Get driver capabilities
720 * @priv: private driver interface data
722 * Returns: 0 on success, -1 on failure
724 * Get driver/firmware/hardware capabilities.
726 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
729 * poll - Poll driver for association information
730 * @priv: private driver interface data
732 * This is an option callback that can be used when the driver does not
733 * provide event mechanism for association events. This is called when
734 * receiving WPA EAPOL-Key messages that require association
735 * information. The driver interface is supposed to generate associnfo
736 * event before returning from this callback function. In addition, the
737 * driver interface should generate an association event after having
738 * sent out associnfo.
740 void (*poll)(void *priv);
743 * get_ifname - Get interface name
744 * @priv: private driver interface data
746 * Returns: Pointer to the interface name. This can differ from the
747 * interface name used in init() call. Init() is called first.
749 * This optional function can be used to allow the driver interface to
750 * replace the interface name with something else, e.g., based on an
751 * interface mapping from a more descriptive name.
753 const char * (*get_ifname)(void *priv);
756 * get_mac_addr - Get own MAC address
757 * @priv: private driver interface data
759 * Returns: Pointer to own MAC address or %NULL on failure
761 * This optional function can be used to get the own MAC address of the
762 * device from the driver interface code. This is only needed if the
763 * l2_packet implementation for the OS does not provide easy access to
765 const u8 * (*get_mac_addr)(void *priv);
768 * send_eapol - Optional function for sending EAPOL packets
769 * @priv: private driver interface data
770 * @dest: Destination MAC address
772 * @data: EAPOL packet starting with IEEE 802.1X header
773 * @data_len: Size of the EAPOL packet
775 * Returns: 0 on success, -1 on failure
777 * This optional function can be used to override l2_packet operations
778 * with driver specific functionality. If this function pointer is set,
779 * l2_packet module is not used at all and the driver interface code is
780 * responsible for receiving and sending all EAPOL packets. The
781 * received EAPOL packets are sent to core code by calling
782 * wpa_supplicant_rx_eapol(). The driver interface is required to
783 * implement get_mac_addr() handler if send_eapol() is used.
785 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
786 const u8 *data, size_t data_len);
789 * set_operstate - Sets device operating state to DORMANT or UP
790 * @priv: private driver interface data
791 * @state: 0 = dormant, 1 = up
792 * Returns: 0 on success, -1 on failure
794 * This is an optional function that can be used on operating systems
795 * that support a concept of controlling network device state from user
796 * space applications. This function, if set, gets called with
797 * state = 1 when authentication has been completed and with state = 0
798 * when connection is lost.
800 int (*set_operstate)(void *priv, int state);
803 * mlme_setprotection - MLME-SETPROTECTION.request primitive
804 * @priv: Private driver interface data
805 * @addr: Address of the station for which to set protection (may be
806 * %NULL for group keys)
807 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
808 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
809 * Returns: 0 on success, -1 on failure
811 * This is an optional function that can be used to set the driver to
812 * require protection for Tx and/or Rx frames. This uses the layer
813 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
814 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
815 * set protection operation; instead, they set protection implicitly
816 * based on configured keys.
818 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
822 * get_hw_feature_data - Get hardware support data (channels and rates)
823 * @priv: Private driver interface data
824 * @num_modes: Variable for returning the number of returned modes
825 * flags: Variable for returning hardware feature flags
826 * Returns: Pointer to allocated hardware data on success or %NULL on
827 * failure. Caller is responsible for freeing this.
829 * This function is only needed for drivers that export MLME
830 * (management frame processing) to wpa_supplicant.
832 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
837 * set_channel - Set channel
838 * @priv: Private driver interface data
839 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
840 * @chan: IEEE 802.11 channel number
841 * @freq: Frequency of the channel in MHz
842 * Returns: 0 on success, -1 on failure
844 * This function is only needed for drivers that export MLME
845 * (management frame processing) to wpa_supplicant.
847 int (*set_channel)(void *priv, hostapd_hw_mode phymode, int chan,
851 * set_ssid - Set SSID
852 * @priv: Private driver interface data
854 * @ssid_len: SSID length
855 * Returns: 0 on success, -1 on failure
857 * This function is only needed for drivers that export MLME
858 * (management frame processing) to wpa_supplicant.
860 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
863 * set_bssid - Set BSSID
864 * @priv: Private driver interface data
866 * Returns: 0 on success, -1 on failure
868 * This function is only needed for drivers that export MLME
869 * (management frame processing) to wpa_supplicant.
871 int (*set_bssid)(void *priv, const u8 *bssid);
874 * send_mlme - Send management frame from MLME
875 * @priv: Private driver interface data
876 * @data: IEEE 802.11 management frame with IEEE 802.11 header
877 * @data_len: Size of the management frame
878 * Returns: 0 on success, -1 on failure
880 * This function is only needed for drivers that export MLME
881 * (management frame processing) to wpa_supplicant.
883 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
886 * mlme_add_sta - Add a STA entry into the driver/netstack
887 * @priv: Private driver interface data
888 * @addr: MAC address of the STA (e.g., BSSID of the AP)
889 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
890 * format (one octet per rate, 1 = 0.5 Mbps)
891 * @supp_rates_len: Number of entries in supp_rates
892 * Returns: 0 on success, -1 on failure
894 * This function is only needed for drivers that export MLME
895 * (management frame processing) to wpa_supplicant. When the MLME code
896 * completes association with an AP, this function is called to
897 * configure the driver/netstack with a STA entry for data frame
898 * processing (TX rate control, encryption/decryption).
900 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
901 size_t supp_rates_len);
904 * mlme_remove_sta - Remove a STA entry from the driver/netstack
905 * @priv: Private driver interface data
906 * @addr: MAC address of the STA (e.g., BSSID of the AP)
907 * Returns: 0 on success, -1 on failure
909 * This function is only needed for drivers that export MLME
910 * (management frame processing) to wpa_supplicant.
912 int (*mlme_remove_sta)(void *priv, const u8 *addr);
915 * update_ft_ies - Update FT (IEEE 802.11r) IEs
916 * @priv: Private driver interface data
917 * @md: Mobility domain (2 octets) (also included inside ies)
918 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
919 * @ies_len: Length of FT IEs in bytes
920 * Returns: 0 on success, -1 on failure
922 * The supplicant uses this callback to let the driver know that keying
923 * material for FT is available and that the driver can use the
924 * provided IEs in the next message in FT authentication sequence.
926 * This function is only needed for driver that support IEEE 802.11r
927 * (Fast BSS Transition).
929 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
933 * send_ft_action - Send FT Action frame (IEEE 802.11r)
934 * @priv: Private driver interface data
935 * @action: Action field value
936 * @target_ap: Target AP address
937 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
938 * @ies_len: Length of FT IEs in bytes
939 * Returns: 0 on success, -1 on failure
941 * The supplicant uses this callback to request the driver to transmit
942 * an FT Action frame (action category 6) for over-the-DS fast BSS
945 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
946 const u8 *ies, size_t ies_len);
949 * get_scan_results2 - Fetch the latest scan results
950 * @priv: private driver interface data
952 * Returns: Allocated buffer of scan results (caller is responsible for
953 * freeing the data structure) on success, NULL on failure
955 struct wpa_scan_results * (*get_scan_results2)(void *priv);
958 * set_country - Set country
959 * @priv: Private driver interface data
960 * @alpha2: country to which to switch to
961 * Returns: 0 on success, -1 on failure
963 * This function is for drivers which support some form
964 * of setting a regulatory domain.
966 int (*set_country)(void *priv, const char *alpha2);
969 * global_init - Global driver initialization
970 * Returns: Pointer to private data (global), %NULL on failure
972 * This optional function is called to initialize the driver wrapper
973 * for global data, i.e., data that applies to all interfaces. If this
974 * function is implemented, global_deinit() will also need to be
975 * implemented to free the private data. The driver will also likely
976 * use init2() function instead of init() to get the pointer to global
977 * data available to per-interface initializer.
979 void * (*global_init)(void);
982 * global_deinit - Global driver deinitialization
983 * @priv: private driver global data from global_init()
985 * Terminate any global driver related functionality and free the
986 * global data structure.
988 void (*global_deinit)(void *priv);
991 * init2 - Initialize driver interface (with global data)
992 * @ctx: context to be used when calling wpa_supplicant functions,
993 * e.g., wpa_supplicant_event()
994 * @ifname: interface name, e.g., wlan0
995 * @global_priv: private driver global data from global_init()
996 * Returns: Pointer to private data, %NULL on failure
998 * This function can be used instead of init() if the driver wrapper
1001 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1004 * get_interfaces - Get information about available interfaces
1005 * @global_priv: private driver global data from global_init()
1006 * Returns: Allocated buffer of interface information (caller is
1007 * responsible for freeing the data structure) on success, NULL on
1010 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1013 * scan2 - Request the driver to initiate scan
1014 * @priv: private driver interface data
1015 * @params: Scan parameters
1017 * Returns: 0 on success, -1 on failure
1019 * Once the scan results are ready, the driver should report scan
1020 * results event for wpa_supplicant which will eventually request the
1021 * results with wpa_driver_get_scan_results2().
1023 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1026 * authenticate - Request driver to authenticate
1027 * @priv: private driver interface data
1028 * @params: authentication parameters
1029 * Returns: 0 on success, -1 on failure
1031 * This is an optional function that can be used with drivers that
1032 * support separate authentication and association steps, i.e., when
1033 * wpa_supplicant can act as the SME. If not implemented, associate()
1034 * function is expected to take care of IEEE 802.11 authentication,
1037 int (*authenticate)(void *priv,
1038 struct wpa_driver_auth_params *params);
1040 int (*set_beacon)(const char *ifname, void *priv,
1041 const u8 *head, size_t head_len,
1042 const u8 *tail, size_t tail_len, int dtim_period,
1045 void * (*hapd_init)(struct hostapd_data *hapd,
1046 struct wpa_init_params *params);
1047 void (*hapd_deinit)(void *priv);
1050 * set_8021x - enable/disable IEEE 802.1X support
1051 * @ifname: Interface name (for multi-SSID/VLAN support)
1052 * @priv: driver private data
1053 * @enabled: 1 = enable, 0 = disable
1055 * Returns: 0 on success, -1 on failure
1057 * Configure the kernel driver to enable/disable 802.1X support.
1058 * This may be an empty function if 802.1X support is always enabled.
1060 int (*set_ieee8021x)(const char *ifname, void *priv, int enabled);
1063 * set_privacy - enable/disable privacy
1064 * @priv: driver private data
1065 * @enabled: 1 = privacy enabled, 0 = disabled
1067 * Return: 0 on success, -1 on failure
1069 * Configure privacy.
1071 int (*set_privacy)(const char *ifname, void *priv, int enabled);
1073 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1075 int (*get_seqnum_igtk)(const char *ifname, void *priv, const u8 *addr,
1077 int (*flush)(void *priv);
1078 int (*set_generic_elem)(const char *ifname, void *priv, const u8 *elem,
1081 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1083 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1084 size_t data_len, int encrypt,
1085 const u8 *own_addr);
1086 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1088 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1090 int (*sta_remove)(void *priv, const u8 *addr);
1091 int (*hapd_get_ssid)(const char *ifname, void *priv, u8 *buf, int len);
1092 int (*hapd_set_ssid)(const char *ifname, void *priv, const u8 *buf,
1094 int (*hapd_set_countermeasures)(void *priv, int enabled);
1095 int (*sta_add)(const char *ifname, void *priv,
1096 struct hostapd_sta_add_params *params);
1097 int (*get_inact_sec)(void *priv, const u8 *addr);
1098 int (*sta_clear_stats)(void *priv, const u8 *addr);
1100 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1101 int (*set_rts)(void *priv, int rts);
1102 int (*set_frag)(void *priv, int frag);
1104 int (*sta_set_flags)(void *priv, const u8 *addr,
1105 int total_flags, int flags_or, int flags_and);
1106 int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
1109 /* Configure internal bridge:
1110 * 0 = disabled, i.e., client separation is enabled (no bridging of
1111 * packets between associated STAs
1112 * 1 = enabled, i.e., bridge packets between associated STAs (default)
1114 int (*set_internal_bridge)(void *priv, int value);
1115 int (*set_cts_protect)(void *priv, int value);
1116 int (*set_preamble)(void *priv, int value);
1117 int (*set_short_slot_time)(void *priv, int value);
1118 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1119 int cw_max, int burst_time);
1120 int (*bss_add)(void *priv, const char *ifname, const u8 *bssid);
1121 int (*bss_remove)(void *priv, const char *ifname);
1122 int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
1123 int (*if_add)(const char *iface, void *priv,
1124 enum hostapd_driver_if_type type, char *ifname,
1126 int (*if_update)(void *priv, enum hostapd_driver_if_type type,
1127 char *ifname, const u8 *addr);
1128 int (*if_remove)(void *priv, enum hostapd_driver_if_type type,
1129 const char *ifname, const u8 *addr);
1130 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1133 * commit - Optional commit changes handler
1134 * @priv: driver private data
1135 * Returns: 0 on success, -1 on failure
1137 * This optional handler function can be registered if the driver
1138 * interface implementation needs to commit changes (e.g., by setting
1139 * network interface up) at the end of initial configuration. If set,
1140 * this handler will be called after initial setup has been completed.
1142 int (*commit)(void *priv);
1144 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1145 const u8 *data, size_t data_len);
1147 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1148 u32 session_timeout);
1149 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1151 int (*set_ht_params)(const char *ifname, void *priv,
1152 const u8 *ht_capab, size_t ht_capab_len,
1153 const u8 *ht_oper, size_t ht_oper_len);
1155 int (*set_wps_beacon_ie)(const char *ifname, void *priv,
1156 const u8 *ie, size_t len);
1157 int (*set_wps_probe_resp_ie)(const char *ifname, void *priv,
1158 const u8 *ie, size_t len);
1161 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1162 * @priv: Private driver interface data
1163 * @authorized: Whether the port is authorized
1164 * Returns: 0 on success, -1 on failure
1166 int (*set_supp_port)(void *priv, int authorized);
1170 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1172 typedef enum wpa_event_type {
1174 * EVENT_ASSOC - Association completed
1176 * This event needs to be delivered when the driver completes IEEE
1177 * 802.11 association or reassociation successfully.
1178 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1179 * after this event has been generated. In addition, optional
1180 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1181 * more information about the association. If the driver interface gets
1182 * both of these events at the same time, it can also include the
1183 * assoc_info data in EVENT_ASSOC call.
1188 * EVENT_DISASSOC - Association lost
1190 * This event should be called when association is lost either due to
1191 * receiving deauthenticate or disassociate frame from the AP or when
1192 * sending either of these frames to the current AP. If the driver
1193 * supports separate deauthentication event, EVENT_DISASSOC should only
1194 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1199 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1201 * This event must be delivered when a Michael MIC error is detected by
1202 * the local driver. Additional data for event processing is
1203 * provided with union wpa_event_data::michael_mic_failure. This
1204 * information is used to request new encyption key and to initiate
1205 * TKIP countermeasures if needed.
1207 EVENT_MICHAEL_MIC_FAILURE,
1210 * EVENT_SCAN_RESULTS - Scan results available
1212 * This event must be called whenever scan results are available to be
1213 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1214 * is expected to be used some time after struct wpa_driver_ops::scan()
1215 * is called. If the driver provides an unsolicited event when the scan
1216 * has been completed, this event can be used to trigger
1217 * EVENT_SCAN_RESULTS call. If such event is not available from the
1218 * driver, the driver wrapper code is expected to use a registered
1219 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1220 * scan is expected to be completed.
1225 * EVENT_ASSOCINFO - Report optional extra information for association
1227 * This event can be used to report extra association information for
1228 * EVENT_ASSOC processing. This extra information includes IEs from
1229 * association frames and Beacon/Probe Response frames in union
1230 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1231 * EVENT_ASSOC. Alternatively, the driver interface can include
1232 * assoc_info data in the EVENT_ASSOC call if it has all the
1233 * information available at the same point.
1238 * EVENT_INTERFACE_STATUS - Report interface status changes
1240 * This optional event can be used to report changes in interface
1241 * status (interface added/removed) using union
1242 * wpa_event_data::interface_status. This can be used to trigger
1243 * wpa_supplicant to stop and re-start processing for the interface,
1244 * e.g., when a cardbus card is ejected/inserted.
1246 EVENT_INTERFACE_STATUS,
1249 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1251 * This event can be used to inform wpa_supplicant about candidates for
1252 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1253 * for scan request (ap_scan=2 mode), this event is required for
1254 * pre-authentication. If wpa_supplicant is performing scan request
1255 * (ap_scan=1), this event is optional since scan results can be used
1256 * to add pre-authentication candidates. union
1257 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1258 * candidate and priority of the candidate, e.g., based on the signal
1259 * strength, in order to try to pre-authenticate first with candidates
1260 * that are most likely targets for re-association.
1262 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1263 * on the candidate list. In addition, it can be called for the current
1264 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1265 * will automatically skip pre-authentication in cases where a valid
1266 * PMKSA exists. When more than one candidate exists, this event should
1267 * be generated once for each candidate.
1269 * Driver will be notified about successful pre-authentication with
1270 * struct wpa_driver_ops::add_pmkid() calls.
1272 EVENT_PMKID_CANDIDATE,
1275 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1277 * This event can be used to inform wpa_supplicant about desire to set
1278 * up secure direct link connection between two stations as defined in
1279 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1280 * STAKey negotiation. The caller will need to set peer address for the
1286 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1288 * The driver is expected to report the received FT IEs from
1289 * FT authentication sequence from the AP. The FT IEs are included in
1290 * the extra information in union wpa_event_data::ft_ies.
1295 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
1297 * The driver can use this event to inform wpa_supplicant about a STA
1298 * in an IBSS with which protected frames could be exchanged. This
1299 * event starts RSN authentication with the other STA to authenticate
1300 * the STA and set up encryption keys with it.
1302 EVENT_IBSS_RSN_START,
1305 * EVENT_AUTH - Authentication result
1307 * This event should be called when authentication attempt has been
1308 * completed. This is only used if the driver supports separate
1309 * authentication step (struct wpa_driver_ops::authenticate).
1310 * Information about authentication result is included in
1311 * union wpa_event_data::auth.
1316 * EVENT_DEAUTH - Authentication lost
1318 * This event should be called when authentication is lost either due
1319 * to receiving deauthenticate frame from the AP or when sending that
1320 * frame to the current AP.
1325 * EVENT_ASSOC_REJECT - Association rejected
1327 * This event should be called when (re)association attempt has been
1328 * rejected by the AP. Information about authentication result is
1329 * included in union wpa_event_data::assoc_reject.
1334 * EVENT_AUTH_TIMED_OUT - Authentication timed out
1336 EVENT_AUTH_TIMED_OUT,
1339 * EVENT_ASSOC_TIMED_OUT - Association timed out
1341 EVENT_ASSOC_TIMED_OUT
1346 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
1348 union wpa_event_data {
1350 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
1352 * This structure is optional for EVENT_ASSOC calls and required for
1353 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
1354 * driver interface does not need to generate separate EVENT_ASSOCINFO
1359 * req_ies - (Re)Association Request IEs
1361 * If the driver generates WPA/RSN IE, this event data must be
1362 * returned for WPA handshake to have needed information. If
1363 * wpa_supplicant-generated WPA/RSN IE is used, this
1364 * information event is optional.
1366 * This should start with the first IE (fixed fields before IEs
1367 * are not included).
1372 * req_ies_len - Length of req_ies in bytes
1377 * resp_ies - (Re)Association Response IEs
1379 * Optional association data from the driver. This data is not
1380 * required WPA, but may be useful for some protocols and as
1381 * such, should be reported if this is available to the driver
1384 * This should start with the first IE (fixed fields before IEs
1385 * are not included).
1390 * resp_ies_len - Length of resp_ies in bytes
1392 size_t resp_ies_len;
1395 * beacon_ies - Beacon or Probe Response IEs
1397 * Optional Beacon/ProbeResp data: IEs included in Beacon or
1398 * Probe Response frames from the current AP (i.e., the one
1399 * that the client just associated with). This information is
1400 * used to update WPA/RSN IE for the AP. If this field is not
1401 * set, the results from previous scan will be used. If no
1402 * data for the new AP is found, scan results will be requested
1403 * again (without scan request). At this point, the driver is
1404 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
1407 * This should start with the first IE (fixed fields before IEs
1408 * are not included).
1413 * beacon_ies_len - Length of beacon_ies */
1414 size_t beacon_ies_len;
1418 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
1420 struct michael_mic_failure {
1423 } michael_mic_failure;
1426 * struct interface_status - Data for EVENT_INTERFACE_STATUS
1428 struct interface_status {
1431 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
1436 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
1438 struct pmkid_candidate {
1439 /** BSSID of the PMKID candidate */
1441 /** Smaller the index, higher the priority */
1443 /** Whether RSN IE includes pre-authenticate flag */
1448 * struct stkstart - Data for EVENT_STKSTART
1455 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
1457 * During FT (IEEE 802.11r) authentication sequence, the driver is
1458 * expected to use this event to report received FT IEs (MDIE, FTIE,
1459 * RSN IE, TIE, possible resource request) to the supplicant. The FT
1460 * IEs for the next message will be delivered through the
1461 * struct wpa_driver_ops::update_ft_ies() callback.
1467 u8 target_ap[ETH_ALEN];
1468 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
1470 /** Length of ric_ies buffer in octets */
1475 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
1477 struct ibss_rsn_start {
1482 * struct auth_info - Data for EVENT_AUTH events
1493 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
1495 struct assoc_reject {
1497 * resp_ies - (Re)Association Response IEs
1499 * Optional association data from the driver. This data is not
1500 * required WPA, but may be useful for some protocols and as
1501 * such, should be reported if this is available to the driver
1504 * This should start with the first IE (fixed fields before IEs
1505 * are not included).
1510 * resp_ies_len - Length of resp_ies in bytes
1512 size_t resp_ies_len;
1515 * status_code - Status Code from (Re)association Response
1520 struct timeout_event {
1526 * wpa_supplicant_event - Report a driver event for wpa_supplicant
1527 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1528 * with struct wpa_driver_ops::init()
1529 * @event: event type (defined above)
1530 * @data: possible extra data for the event
1532 * Driver wrapper code should call this function whenever an event is received
1535 void wpa_supplicant_event(void *ctx, wpa_event_type event,
1536 union wpa_event_data *data);
1539 * wpa_supplicant_rx_eapol - Deliver a received EAPOL frame to wpa_supplicant
1540 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1541 * with struct wpa_driver_ops::init()
1542 * @src_addr: Source address of the EAPOL frame
1543 * @buf: EAPOL data starting from the EAPOL header (i.e., no Ethernet header)
1544 * @len: Length of the EAPOL data
1546 * This function is called for each received EAPOL frame. Most driver
1547 * interfaces rely on more generic OS mechanism for receiving frames through
1548 * l2_packet, but if such a mechanism is not available, the driver wrapper may
1549 * take care of received EAPOL frames and deliver them to the core supplicant
1550 * code by calling this function.
1552 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
1553 const u8 *buf, size_t len);
1555 void wpa_supplicant_sta_rx(void *ctx, const u8 *buf, size_t len,
1556 struct ieee80211_rx_status *rx_status);
1558 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie);
1559 #define WPA_IE_VENDOR_TYPE 0x0050f201
1560 #define WPS_IE_VENDOR_TYPE 0x0050f204
1561 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
1563 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
1565 int wpa_scan_get_max_rate(const struct wpa_scan_res *res);
1566 void wpa_scan_results_free(struct wpa_scan_results *res);
1567 void wpa_scan_sort_results(struct wpa_scan_results *res);
1569 /* hostapd functions for driver wrappers */
1572 struct ieee80211_hdr;
1574 void hostapd_new_assoc_sta(struct hostapd_data *hapd, struct sta_info *sta,
1576 void hostapd_tx_status(struct hostapd_data *hapd, const u8 *addr,
1577 const u8 *buf, size_t len, int ack);
1578 void hostapd_rx_from_unknown_sta(struct hostapd_data *hapd,
1579 const struct ieee80211_hdr *hdr, size_t len);
1580 int hostapd_notif_assoc(struct hostapd_data *hapd, const u8 *addr,
1581 const u8 *ie, size_t ielen);
1582 void hostapd_notif_disassoc(struct hostapd_data *hapd, const u8 *addr);
1583 void hostapd_eapol_receive(struct hostapd_data *hapd, const u8 *sa,
1584 const u8 *buf, size_t len);
1586 struct hostapd_frame_info {
1592 void hostapd_mgmt_rx(struct hostapd_data *hapd, u8 *buf, size_t len,
1593 u16 stype, struct hostapd_frame_info *fi);
1594 void hostapd_mgmt_tx_cb(struct hostapd_data *hapd, u8 *buf, size_t len,
1596 void hostapd_michael_mic_failure(struct hostapd_data *hapd, const u8 *addr);
1597 struct hostapd_data * hostapd_sta_get_bss(struct hostapd_data *hapd,
1599 void hostapd_probe_req_rx(struct hostapd_data *hapd, const u8 *sa,
1600 const u8 *ie, size_t ie_len);
1601 void hostapd_button_pushed(struct hostapd_data *hapd);
1603 #endif /* DRIVER_H */