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)
78 * struct wpa_scan_res - Scan result for an BSS/IBSS
79 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
81 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
82 * @beacon_int: beacon interval in TUs (host byte order)
83 * @caps: capability information field in host byte order
84 * @qual: signal quality
86 * @level: signal level
88 * @age: Age of the information in milliseconds (i.e., how many milliseconds
89 * ago the last Beacon or Probe Response frame was received)
90 * @ie_len: length of the following IE field in octets
92 * This structure is used as a generic format for scan results from the
93 * driver. Each driver interface implementation is responsible for converting
94 * the driver or OS specific scan results into this format.
96 * If the driver does not support reporting all IEs, the IE data structure is
97 * constructed of the IEs that are available. This field will also need to
98 * include SSID in IE format. All drivers are encouraged to be extended to
99 * report all IEs to make it easier to support future additions.
101 struct wpa_scan_res {
113 /* followed by ie_len octets of IEs */
117 * struct wpa_scan_results - Scan results
118 * @res: Array of pointers to allocated variable length scan result entries
119 * @num: Number of entries in the scan result array
121 struct wpa_scan_results {
122 struct wpa_scan_res **res;
127 * struct wpa_interface_info - Network interface information
128 * @next: Pointer to the next interface or NULL if this is the last one
129 * @ifname: Interface name that can be used with init() or init2()
130 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
132 * @drv_bame: struct wpa_driver_ops::name (note: unlike other strings, this one
133 * is not an allocated copy, i.e., get_interfaces() caller will not free
136 struct wpa_interface_info {
137 struct wpa_interface_info *next;
140 const char *drv_name;
143 #define WPAS_MAX_SCAN_SSIDS 4
146 * struct wpa_driver_scan_params - Scan parameters
147 * Data for struct wpa_driver_ops::scan2().
149 struct wpa_driver_scan_params {
151 * ssids - SSIDs to scan for
153 struct wpa_driver_scan_ssid {
155 * ssid - specific SSID to scan for (ProbeReq)
156 * %NULL or zero-length SSID is used to indicate active scan
157 * with wildcard SSID.
161 * ssid_len: Length of the SSID in octets
164 } ssids[WPAS_MAX_SCAN_SSIDS];
167 * num_ssids - Number of entries in ssids array
168 * Zero indicates a request for a passive scan.
173 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
178 * extra_ies_len - Length of extra_ies in octets
180 size_t extra_ies_len;
183 * freqs - Array of frequencies to scan or %NULL for all frequencies
185 * The frequency is set in MHz. The array is zero-terminated.
191 * struct wpa_driver_auth_params - Authentication parameters
192 * Data for struct wpa_driver_ops::authenticate().
194 struct wpa_driver_auth_params {
202 const u8 *wep_key[4];
203 size_t wep_key_len[4];
208 * struct wpa_driver_associate_params - Association parameters
209 * Data for struct wpa_driver_ops::associate().
211 struct wpa_driver_associate_params {
213 * bssid - BSSID of the selected AP
214 * This can be %NULL, if ap_scan=2 mode is used and the driver is
215 * responsible for selecting with which BSS to associate. */
219 * ssid - The selected SSID
225 * freq - Frequency of the channel the selected AP is using
226 * Frequency that the selected AP is using (in MHz as
227 * reported in the scan results)
232 * wpa_ie - WPA information element for (Re)Association Request
233 * WPA information element to be included in (Re)Association
234 * Request (including information element id and length). Use
235 * of this WPA IE is optional. If the driver generates the WPA
236 * IE, it can use pairwise_suite, group_suite, and
237 * key_mgmt_suite to select proper algorithms. In this case,
238 * the driver has to notify wpa_supplicant about the used WPA
239 * IE by generating an event that the interface code will
240 * convert into EVENT_ASSOCINFO data (see below).
242 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
243 * instead. The driver can determine which version is used by
244 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
247 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
251 * wpa_ie_len - length of the wpa_ie
255 /* The selected pairwise/group cipher and key management
256 * suites. These are usually ignored if @wpa_ie is used. */
257 wpa_cipher pairwise_suite;
258 wpa_cipher group_suite;
259 wpa_key_mgmt key_mgmt_suite;
262 * auth_alg - Allowed authentication algorithms
263 * Bit field of AUTH_ALG_*
268 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
273 * wep_key - WEP keys for static WEP configuration
275 const u8 *wep_key[4];
278 * wep_key_len - WEP key length for static WEP configuration
280 size_t wep_key_len[4];
283 * wep_tx_keyidx - WEP TX key index for static WEP configuration
288 * mgmt_frame_protection - IEEE 802.11w management frame protection
291 NO_MGMT_FRAME_PROTECTION,
292 MGMT_FRAME_PROTECTION_OPTIONAL,
293 MGMT_FRAME_PROTECTION_REQUIRED
294 } mgmt_frame_protection;
297 * ft_ies - IEEE 802.11r / FT information elements
298 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
299 * for fast transition, this parameter is set to include the IEs that
300 * are to be sent in the next FT Authentication Request message.
301 * update_ft_ies() handler is called to update the IEs for further
302 * FT messages in the sequence.
304 * The driver should use these IEs only if the target AP is advertising
305 * the same mobility domain as the one included in the MDIE here.
307 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
308 * AP after the initial association. These IEs can only be used if the
309 * target AP is advertising support for FT and is using the same MDIE
310 * and SSID as the current AP.
312 * The driver is responsible for reporting the FT IEs received from the
313 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
314 * type. update_ft_ies() handler will then be called with the FT IEs to
315 * include in the next frame in the authentication sequence.
320 * ft_ies_len - Length of ft_ies in bytes
325 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
327 * This value is provided to allow the driver interface easier access
328 * to the current mobility domain. This value is set to %NULL if no
329 * mobility domain is currently active.
334 * passphrase - RSN passphrase for PSK
336 * This value is made available only for WPA/WPA2-Personal (PSK) and
337 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
338 * the 8..63 character ASCII passphrase, if available. Please note that
339 * this can be %NULL if passphrase was not used to generate the PSK. In
340 * that case, the psk field must be used to fetch the PSK.
342 const char *passphrase;
345 * psk - RSN PSK (alternative for passphrase for PSK)
347 * This value is made available only for WPA/WPA2-Personal (PSK) and
348 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
349 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
350 * be prepared to handle %NULL value as an error.
355 * drop_unencrypted - Enable/disable unencrypted frame filtering
357 * Configure the driver to drop all non-EAPOL frames (both receive and
358 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
359 * still be allowed for key negotiation.
361 int drop_unencrypted;
364 * prev_bssid - Previously used BSSID in this ESS
366 * When not %NULL, this is a request to use reassociation instead of
369 const u8 *prev_bssid;
373 * struct wpa_driver_capa - Driver capability information
375 struct wpa_driver_capa {
376 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
377 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
378 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
379 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
380 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
381 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
382 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
383 unsigned int key_mgmt;
385 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
386 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
387 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
388 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
391 #define WPA_DRIVER_AUTH_OPEN 0x00000001
392 #define WPA_DRIVER_AUTH_SHARED 0x00000002
393 #define WPA_DRIVER_AUTH_LEAP 0x00000004
396 /* Driver generated WPA/RSN IE */
397 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
398 /* Driver needs static WEP key setup after association command */
399 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
400 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
401 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
402 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
403 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
404 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
405 /* Driver provides separate commands for authentication and association (SME in
406 * wpa_supplicant). */
407 #define WPA_DRIVER_FLAGS_SME 0x00000020
408 /* Driver supports AP mode */
409 #define WPA_DRIVER_FLAGS_AP 0x00000040
410 /* Driver needs static WEP key setup after association has been completed */
411 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
418 struct ieee80211_rx_status {
426 struct hostap_sta_driver_data {
427 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
428 unsigned long current_tx_rate;
429 unsigned long inactive_msec;
431 unsigned long num_ps_buf_frames;
432 unsigned long tx_retry_failed;
433 unsigned long tx_retry_count;
438 struct hostapd_sta_add_params {
442 const u8 *supp_rates;
443 size_t supp_rates_len;
446 const struct ieee80211_ht_capabilities *ht_capabilities;
449 struct hostapd_freq_params {
454 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
455 * secondary channel below primary, 1 = HT40
456 * enabled, secondary channel above primary */
459 enum hostapd_driver_if_type {
463 struct wpa_init_params {
468 const char *test_socket;
469 int use_pae_group_addr;
473 u8 *own_addr; /* buffer for writing own MAC address */
478 * struct wpa_driver_ops - Driver interface API definition
480 * This structure defines the API that each driver interface needs to implement
481 * for core wpa_supplicant code. All driver specific functionality is captured
484 struct wpa_driver_ops {
485 /** Name of the driver interface */
487 /** One line description of the driver interface */
491 * get_bssid - Get the current BSSID
492 * @priv: private driver interface data
493 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
495 * Returns: 0 on success, -1 on failure
497 * Query kernel driver for the current BSSID and copy it to bssid.
498 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
501 int (*get_bssid)(void *priv, u8 *bssid);
504 * get_ssid - Get the current SSID
505 * @priv: private driver interface data
506 * @ssid: buffer for SSID (at least 32 bytes)
508 * Returns: Length of the SSID on success, -1 on failure
510 * Query kernel driver for the current SSID and copy it to ssid.
511 * Returning zero is recommended if the STA is not associated.
513 * Note: SSID is an array of octets, i.e., it is not nul terminated and
514 * can, at least in theory, contain control characters (including nul)
515 * and as such, should be processed as binary data, not a printable
518 int (*get_ssid)(void *priv, u8 *ssid);
521 * set_key - Configure encryption key
522 * @ifname: Interface name (for multi-SSID/VLAN support)
523 * @priv: private driver interface data
524 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
525 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
526 * %WPA_ALG_NONE clears the key.
527 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
528 * broadcast/default keys
529 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
531 * @set_tx: configure this key as the default Tx key (only used when
532 * driver does not support separate unicast/individual key
533 * @seq: sequence number/packet number, seq_len octets, the next
534 * packet number to be used for in replay protection; configured
535 * for Rx keys (in most cases, this is only used with broadcast
536 * keys and set to zero for unicast keys)
537 * @seq_len: length of the seq, depends on the algorithm:
538 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
539 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
541 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
542 * TKIP: 32, CCMP: 16, IGTK: 16)
544 * Returns: 0 on success, -1 on failure
546 * Configure the given key for the kernel driver. If the driver
547 * supports separate individual keys (4 default keys + 1 individual),
548 * addr can be used to determine whether the key is default or
549 * individual. If only 4 keys are supported, the default key with key
550 * index 0 is used as the individual key. STA must be configured to use
551 * it as the default Tx key (set_tx is set) and accept Rx for all the
552 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
553 * broadcast keys, so key index 0 is available for this kind of
556 * Please note that TKIP keys include separate TX and RX MIC keys and
557 * some drivers may expect them in different order than wpa_supplicant
558 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
559 * will tricker Michael MIC errors. This can be fixed by changing the
560 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
561 * in driver_*.c set_key() implementation, see driver_ndis.c for an
562 * example on how this can be done.
564 int (*set_key)(const char *ifname, void *priv, wpa_alg alg,
565 const u8 *addr, int key_idx, int set_tx,
566 const u8 *seq, size_t seq_len,
567 const u8 *key, size_t key_len);
570 * init - Initialize driver interface
571 * @ctx: context to be used when calling wpa_supplicant functions,
572 * e.g., wpa_supplicant_event()
573 * @ifname: interface name, e.g., wlan0
575 * Returns: Pointer to private data, %NULL on failure
577 * Initialize driver interface, including event processing for kernel
578 * driver events (e.g., associated, scan results, Michael MIC failure).
579 * This function can allocate a private configuration data area for
580 * @ctx, file descriptor, interface name, etc. information that may be
581 * needed in future driver operations. If this is not used, non-NULL
582 * value will need to be returned because %NULL is used to indicate
583 * failure. The returned value will be used as 'void *priv' data for
584 * all other driver_ops functions.
586 * The main event loop (eloop.c) of wpa_supplicant can be used to
587 * register callback for read sockets (eloop_register_read_sock()).
589 * See below for more information about events and
590 * wpa_supplicant_event() function.
592 void * (*init)(void *ctx, const char *ifname);
595 * deinit - Deinitialize driver interface
596 * @priv: private driver interface data from init()
598 * Shut down driver interface and processing of driver events. Free
599 * private data buffer if one was allocated in init() handler.
601 void (*deinit)(void *priv);
604 * set_param - Set driver configuration parameters
605 * @priv: private driver interface data from init()
606 * @param: driver specific configuration parameters
608 * Returns: 0 on success, -1 on failure
610 * Optional handler for notifying driver interface about configuration
611 * parameters (driver_param).
613 int (*set_param)(void *priv, const char *param);
616 * set_countermeasures - Enable/disable TKIP countermeasures
617 * @priv: private driver interface data
618 * @enabled: 1 = countermeasures enabled, 0 = disabled
620 * Returns: 0 on success, -1 on failure
622 * Configure TKIP countermeasures. When these are enabled, the driver
623 * should drop all received and queued frames that are using TKIP.
625 int (*set_countermeasures)(void *priv, int enabled);
628 * deauthenticate - Request driver to deauthenticate
629 * @priv: private driver interface data
630 * @addr: peer address (BSSID of the AP)
631 * @reason_code: 16-bit reason code to be sent in the deauthentication
634 * Returns: 0 on success, -1 on failure
636 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
639 * disassociate - Request driver to disassociate
640 * @priv: private driver interface data
641 * @addr: peer address (BSSID of the AP)
642 * @reason_code: 16-bit reason code to be sent in the disassociation
645 * Returns: 0 on success, -1 on failure
647 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
650 * associate - Request driver to associate
651 * @priv: private driver interface data
652 * @params: association parameters
654 * Returns: 0 on success, -1 on failure
656 int (*associate)(void *priv,
657 struct wpa_driver_associate_params *params);
660 * add_pmkid - Add PMKSA cache entry to the driver
661 * @priv: private driver interface data
662 * @bssid: BSSID for the PMKSA cache entry
663 * @pmkid: PMKID for the PMKSA cache entry
665 * Returns: 0 on success, -1 on failure
667 * This function is called when a new PMK is received, as a result of
668 * either normal authentication or RSN pre-authentication.
670 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
671 * associate(), add_pmkid() can be used to add new PMKSA cache entries
672 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
673 * driver_ops function does not need to be implemented. Likewise, if
674 * the driver does not support WPA, this function is not needed.
676 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
679 * remove_pmkid - Remove PMKSA cache entry to the driver
680 * @priv: private driver interface data
681 * @bssid: BSSID for the PMKSA cache entry
682 * @pmkid: PMKID for the PMKSA cache entry
684 * Returns: 0 on success, -1 on failure
686 * This function is called when the supplicant drops a PMKSA cache
687 * entry for any reason.
689 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
690 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
691 * between the driver and wpa_supplicant. If the driver uses wpa_ie
692 * from wpa_supplicant, this driver_ops function does not need to be
693 * implemented. Likewise, if the driver does not support WPA, this
694 * function is not needed.
696 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
699 * flush_pmkid - Flush PMKSA cache
700 * @priv: private driver interface data
702 * Returns: 0 on success, -1 on failure
704 * This function is called when the supplicant drops all PMKSA cache
705 * entries for any reason.
707 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
708 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
709 * between the driver and wpa_supplicant. If the driver uses wpa_ie
710 * from wpa_supplicant, this driver_ops function does not need to be
711 * implemented. Likewise, if the driver does not support WPA, this
712 * function is not needed.
714 int (*flush_pmkid)(void *priv);
717 * get_capa - Get driver capabilities
718 * @priv: private driver interface data
720 * Returns: 0 on success, -1 on failure
722 * Get driver/firmware/hardware capabilities.
724 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
727 * poll - Poll driver for association information
728 * @priv: private driver interface data
730 * This is an option callback that can be used when the driver does not
731 * provide event mechanism for association events. This is called when
732 * receiving WPA EAPOL-Key messages that require association
733 * information. The driver interface is supposed to generate associnfo
734 * event before returning from this callback function. In addition, the
735 * driver interface should generate an association event after having
736 * sent out associnfo.
738 void (*poll)(void *priv);
741 * get_ifname - Get interface name
742 * @priv: private driver interface data
744 * Returns: Pointer to the interface name. This can differ from the
745 * interface name used in init() call. Init() is called first.
747 * This optional function can be used to allow the driver interface to
748 * replace the interface name with something else, e.g., based on an
749 * interface mapping from a more descriptive name.
751 const char * (*get_ifname)(void *priv);
754 * get_mac_addr - Get own MAC address
755 * @priv: private driver interface data
757 * Returns: Pointer to own MAC address or %NULL on failure
759 * This optional function can be used to get the own MAC address of the
760 * device from the driver interface code. This is only needed if the
761 * l2_packet implementation for the OS does not provide easy access to
763 const u8 * (*get_mac_addr)(void *priv);
766 * send_eapol - Optional function for sending EAPOL packets
767 * @priv: private driver interface data
768 * @dest: Destination MAC address
770 * @data: EAPOL packet starting with IEEE 802.1X header
771 * @data_len: Size of the EAPOL packet
773 * Returns: 0 on success, -1 on failure
775 * This optional function can be used to override l2_packet operations
776 * with driver specific functionality. If this function pointer is set,
777 * l2_packet module is not used at all and the driver interface code is
778 * responsible for receiving and sending all EAPOL packets. The
779 * received EAPOL packets are sent to core code by calling
780 * wpa_supplicant_rx_eapol(). The driver interface is required to
781 * implement get_mac_addr() handler if send_eapol() is used.
783 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
784 const u8 *data, size_t data_len);
787 * set_operstate - Sets device operating state to DORMANT or UP
788 * @priv: private driver interface data
789 * @state: 0 = dormant, 1 = up
790 * Returns: 0 on success, -1 on failure
792 * This is an optional function that can be used on operating systems
793 * that support a concept of controlling network device state from user
794 * space applications. This function, if set, gets called with
795 * state = 1 when authentication has been completed and with state = 0
796 * when connection is lost.
798 int (*set_operstate)(void *priv, int state);
801 * mlme_setprotection - MLME-SETPROTECTION.request primitive
802 * @priv: Private driver interface data
803 * @addr: Address of the station for which to set protection (may be
804 * %NULL for group keys)
805 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
806 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
807 * Returns: 0 on success, -1 on failure
809 * This is an optional function that can be used to set the driver to
810 * require protection for Tx and/or Rx frames. This uses the layer
811 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
812 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
813 * set protection operation; instead, they set protection implicitly
814 * based on configured keys.
816 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
820 * get_hw_feature_data - Get hardware support data (channels and rates)
821 * @priv: Private driver interface data
822 * @num_modes: Variable for returning the number of returned modes
823 * flags: Variable for returning hardware feature flags
824 * Returns: Pointer to allocated hardware data on success or %NULL on
825 * failure. Caller is responsible for freeing this.
827 * This function is only needed for drivers that export MLME
828 * (management frame processing) to wpa_supplicant.
830 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
835 * set_channel - Set channel
836 * @priv: Private driver interface data
837 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
838 * @chan: IEEE 802.11 channel number
839 * @freq: Frequency of the channel in MHz
840 * Returns: 0 on success, -1 on failure
842 * This function is only needed for drivers that export MLME
843 * (management frame processing) to wpa_supplicant.
845 int (*set_channel)(void *priv, hostapd_hw_mode phymode, int chan,
849 * set_ssid - Set SSID
850 * @priv: Private driver interface data
852 * @ssid_len: SSID length
853 * Returns: 0 on success, -1 on failure
855 * This function is only needed for drivers that export MLME
856 * (management frame processing) to wpa_supplicant.
858 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
861 * set_bssid - Set BSSID
862 * @priv: Private driver interface data
864 * Returns: 0 on success, -1 on failure
866 * This function is only needed for drivers that export MLME
867 * (management frame processing) to wpa_supplicant.
869 int (*set_bssid)(void *priv, const u8 *bssid);
872 * send_mlme - Send management frame from MLME
873 * @priv: Private driver interface data
874 * @data: IEEE 802.11 management frame with IEEE 802.11 header
875 * @data_len: Size of the management frame
876 * Returns: 0 on success, -1 on failure
878 * This function is only needed for drivers that export MLME
879 * (management frame processing) to wpa_supplicant.
881 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
884 * mlme_add_sta - Add a STA entry into the driver/netstack
885 * @priv: Private driver interface data
886 * @addr: MAC address of the STA (e.g., BSSID of the AP)
887 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
888 * format (one octet per rate, 1 = 0.5 Mbps)
889 * @supp_rates_len: Number of entries in supp_rates
890 * Returns: 0 on success, -1 on failure
892 * This function is only needed for drivers that export MLME
893 * (management frame processing) to wpa_supplicant. When the MLME code
894 * completes association with an AP, this function is called to
895 * configure the driver/netstack with a STA entry for data frame
896 * processing (TX rate control, encryption/decryption).
898 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
899 size_t supp_rates_len);
902 * mlme_remove_sta - Remove a STA entry from the driver/netstack
903 * @priv: Private driver interface data
904 * @addr: MAC address of the STA (e.g., BSSID of the AP)
905 * Returns: 0 on success, -1 on failure
907 * This function is only needed for drivers that export MLME
908 * (management frame processing) to wpa_supplicant.
910 int (*mlme_remove_sta)(void *priv, const u8 *addr);
913 * update_ft_ies - Update FT (IEEE 802.11r) IEs
914 * @priv: Private driver interface data
915 * @md: Mobility domain (2 octets) (also included inside ies)
916 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
917 * @ies_len: Length of FT IEs in bytes
918 * Returns: 0 on success, -1 on failure
920 * The supplicant uses this callback to let the driver know that keying
921 * material for FT is available and that the driver can use the
922 * provided IEs in the next message in FT authentication sequence.
924 * This function is only needed for driver that support IEEE 802.11r
925 * (Fast BSS Transition).
927 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
931 * send_ft_action - Send FT Action frame (IEEE 802.11r)
932 * @priv: Private driver interface data
933 * @action: Action field value
934 * @target_ap: Target AP address
935 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
936 * @ies_len: Length of FT IEs in bytes
937 * Returns: 0 on success, -1 on failure
939 * The supplicant uses this callback to request the driver to transmit
940 * an FT Action frame (action category 6) for over-the-DS fast BSS
943 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
944 const u8 *ies, size_t ies_len);
947 * get_scan_results2 - Fetch the latest scan results
948 * @priv: private driver interface data
950 * Returns: Allocated buffer of scan results (caller is responsible for
951 * freeing the data structure) on success, NULL on failure
953 struct wpa_scan_results * (*get_scan_results2)(void *priv);
956 * set_country - Set country
957 * @priv: Private driver interface data
958 * @alpha2: country to which to switch to
959 * Returns: 0 on success, -1 on failure
961 * This function is for drivers which support some form
962 * of setting a regulatory domain.
964 int (*set_country)(void *priv, const char *alpha2);
967 * global_init - Global driver initialization
968 * Returns: Pointer to private data (global), %NULL on failure
970 * This optional function is called to initialize the driver wrapper
971 * for global data, i.e., data that applies to all interfaces. If this
972 * function is implemented, global_deinit() will also need to be
973 * implemented to free the private data. The driver will also likely
974 * use init2() function instead of init() to get the pointer to global
975 * data available to per-interface initializer.
977 void * (*global_init)(void);
980 * global_deinit - Global driver deinitialization
981 * @priv: private driver global data from global_init()
983 * Terminate any global driver related functionality and free the
984 * global data structure.
986 void (*global_deinit)(void *priv);
989 * init2 - Initialize driver interface (with global data)
990 * @ctx: context to be used when calling wpa_supplicant functions,
991 * e.g., wpa_supplicant_event()
992 * @ifname: interface name, e.g., wlan0
993 * @global_priv: private driver global data from global_init()
994 * Returns: Pointer to private data, %NULL on failure
996 * This function can be used instead of init() if the driver wrapper
999 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1002 * get_interfaces - Get information about available interfaces
1003 * @global_priv: private driver global data from global_init()
1004 * Returns: Allocated buffer of interface information (caller is
1005 * responsible for freeing the data structure) on success, NULL on
1008 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1011 * scan2 - Request the driver to initiate scan
1012 * @priv: private driver interface data
1013 * @params: Scan parameters
1015 * Returns: 0 on success, -1 on failure
1017 * Once the scan results are ready, the driver should report scan
1018 * results event for wpa_supplicant which will eventually request the
1019 * results with wpa_driver_get_scan_results2().
1021 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1024 * authenticate - Request driver to authenticate
1025 * @priv: private driver interface data
1026 * @params: authentication parameters
1027 * Returns: 0 on success, -1 on failure
1029 * This is an optional function that can be used with drivers that
1030 * support separate authentication and association steps, i.e., when
1031 * wpa_supplicant can act as the SME. If not implemented, associate()
1032 * function is expected to take care of IEEE 802.11 authentication,
1035 int (*authenticate)(void *priv,
1036 struct wpa_driver_auth_params *params);
1038 int (*set_beacon)(const char *ifname, void *priv,
1039 const u8 *head, size_t head_len,
1040 const u8 *tail, size_t tail_len, int dtim_period,
1043 void * (*hapd_init)(struct hostapd_data *hapd,
1044 struct wpa_init_params *params);
1045 void (*hapd_deinit)(void *priv);
1048 * set_8021x - enable/disable IEEE 802.1X support
1049 * @ifname: Interface name (for multi-SSID/VLAN support)
1050 * @priv: driver private data
1051 * @enabled: 1 = enable, 0 = disable
1053 * Returns: 0 on success, -1 on failure
1055 * Configure the kernel driver to enable/disable 802.1X support.
1056 * This may be an empty function if 802.1X support is always enabled.
1058 int (*set_ieee8021x)(const char *ifname, void *priv, int enabled);
1061 * set_privacy - enable/disable privacy
1062 * @priv: driver private data
1063 * @enabled: 1 = privacy enabled, 0 = disabled
1065 * Return: 0 on success, -1 on failure
1067 * Configure privacy.
1069 int (*set_privacy)(const char *ifname, void *priv, int enabled);
1071 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1073 int (*get_seqnum_igtk)(const char *ifname, void *priv, const u8 *addr,
1075 int (*flush)(void *priv);
1076 int (*set_generic_elem)(const char *ifname, void *priv, const u8 *elem,
1079 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1081 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1082 size_t data_len, int encrypt,
1083 const u8 *own_addr);
1084 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1086 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1088 int (*sta_remove)(void *priv, const u8 *addr);
1089 int (*hapd_get_ssid)(const char *ifname, void *priv, u8 *buf, int len);
1090 int (*hapd_set_ssid)(const char *ifname, void *priv, const u8 *buf,
1092 int (*hapd_set_countermeasures)(void *priv, int enabled);
1093 int (*sta_add)(const char *ifname, void *priv,
1094 struct hostapd_sta_add_params *params);
1095 int (*get_inact_sec)(void *priv, const u8 *addr);
1096 int (*sta_clear_stats)(void *priv, const u8 *addr);
1098 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1099 int (*set_rts)(void *priv, int rts);
1100 int (*set_frag)(void *priv, int frag);
1102 int (*sta_set_flags)(void *priv, const u8 *addr,
1103 int total_flags, int flags_or, int flags_and);
1104 int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
1107 /* Configure internal bridge:
1108 * 0 = disabled, i.e., client separation is enabled (no bridging of
1109 * packets between associated STAs
1110 * 1 = enabled, i.e., bridge packets between associated STAs (default)
1112 int (*set_internal_bridge)(void *priv, int value);
1113 int (*set_cts_protect)(void *priv, int value);
1114 int (*set_preamble)(void *priv, int value);
1115 int (*set_short_slot_time)(void *priv, int value);
1116 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1117 int cw_max, int burst_time);
1118 int (*bss_add)(void *priv, const char *ifname, const u8 *bssid);
1119 int (*bss_remove)(void *priv, const char *ifname);
1120 int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
1121 int (*if_add)(const char *iface, void *priv,
1122 enum hostapd_driver_if_type type, char *ifname,
1124 int (*if_update)(void *priv, enum hostapd_driver_if_type type,
1125 char *ifname, const u8 *addr);
1126 int (*if_remove)(void *priv, enum hostapd_driver_if_type type,
1127 const char *ifname, const u8 *addr);
1128 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1131 * commit - Optional commit changes handler
1132 * @priv: driver private data
1133 * Returns: 0 on success, -1 on failure
1135 * This optional handler function can be registered if the driver
1136 * interface implementation needs to commit changes (e.g., by setting
1137 * network interface up) at the end of initial configuration. If set,
1138 * this handler will be called after initial setup has been completed.
1140 int (*commit)(void *priv);
1142 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1143 const u8 *data, size_t data_len);
1145 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1146 u32 session_timeout);
1147 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1149 int (*set_ht_params)(const char *ifname, void *priv,
1150 const u8 *ht_capab, size_t ht_capab_len,
1151 const u8 *ht_oper, size_t ht_oper_len);
1153 int (*set_wps_beacon_ie)(const char *ifname, void *priv,
1154 const u8 *ie, size_t len);
1155 int (*set_wps_probe_resp_ie)(const char *ifname, void *priv,
1156 const u8 *ie, size_t len);
1159 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1160 * @priv: Private driver interface data
1161 * @authorized: Whether the port is authorized
1162 * Returns: 0 on success, -1 on failure
1164 int (*set_supp_port)(void *priv, int authorized);
1168 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1170 typedef enum wpa_event_type {
1172 * EVENT_ASSOC - Association completed
1174 * This event needs to be delivered when the driver completes IEEE
1175 * 802.11 association or reassociation successfully.
1176 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1177 * after this event has been generated. In addition, optional
1178 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1179 * more information about the association. If the driver interface gets
1180 * both of these events at the same time, it can also include the
1181 * assoc_info data in EVENT_ASSOC call.
1186 * EVENT_DISASSOC - Association lost
1188 * This event should be called when association is lost either due to
1189 * receiving deauthenticate or disassociate frame from the AP or when
1190 * sending either of these frames to the current AP. If the driver
1191 * supports separate deauthentication event, EVENT_DISASSOC should only
1192 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1197 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1199 * This event must be delivered when a Michael MIC error is detected by
1200 * the local driver. Additional data for event processing is
1201 * provided with union wpa_event_data::michael_mic_failure. This
1202 * information is used to request new encyption key and to initiate
1203 * TKIP countermeasures if needed.
1205 EVENT_MICHAEL_MIC_FAILURE,
1208 * EVENT_SCAN_RESULTS - Scan results available
1210 * This event must be called whenever scan results are available to be
1211 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1212 * is expected to be used some time after struct wpa_driver_ops::scan()
1213 * is called. If the driver provides an unsolicited event when the scan
1214 * has been completed, this event can be used to trigger
1215 * EVENT_SCAN_RESULTS call. If such event is not available from the
1216 * driver, the driver wrapper code is expected to use a registered
1217 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1218 * scan is expected to be completed.
1223 * EVENT_ASSOCINFO - Report optional extra information for association
1225 * This event can be used to report extra association information for
1226 * EVENT_ASSOC processing. This extra information includes IEs from
1227 * association frames and Beacon/Probe Response frames in union
1228 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1229 * EVENT_ASSOC. Alternatively, the driver interface can include
1230 * assoc_info data in the EVENT_ASSOC call if it has all the
1231 * information available at the same point.
1236 * EVENT_INTERFACE_STATUS - Report interface status changes
1238 * This optional event can be used to report changes in interface
1239 * status (interface added/removed) using union
1240 * wpa_event_data::interface_status. This can be used to trigger
1241 * wpa_supplicant to stop and re-start processing for the interface,
1242 * e.g., when a cardbus card is ejected/inserted.
1244 EVENT_INTERFACE_STATUS,
1247 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1249 * This event can be used to inform wpa_supplicant about candidates for
1250 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1251 * for scan request (ap_scan=2 mode), this event is required for
1252 * pre-authentication. If wpa_supplicant is performing scan request
1253 * (ap_scan=1), this event is optional since scan results can be used
1254 * to add pre-authentication candidates. union
1255 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1256 * candidate and priority of the candidate, e.g., based on the signal
1257 * strength, in order to try to pre-authenticate first with candidates
1258 * that are most likely targets for re-association.
1260 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1261 * on the candidate list. In addition, it can be called for the current
1262 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1263 * will automatically skip pre-authentication in cases where a valid
1264 * PMKSA exists. When more than one candidate exists, this event should
1265 * be generated once for each candidate.
1267 * Driver will be notified about successful pre-authentication with
1268 * struct wpa_driver_ops::add_pmkid() calls.
1270 EVENT_PMKID_CANDIDATE,
1273 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1275 * This event can be used to inform wpa_supplicant about desire to set
1276 * up secure direct link connection between two stations as defined in
1277 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1278 * STAKey negotiation. The caller will need to set peer address for the
1284 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1286 * The driver is expected to report the received FT IEs from
1287 * FT authentication sequence from the AP. The FT IEs are included in
1288 * the extra information in union wpa_event_data::ft_ies.
1293 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
1295 * The driver can use this event to inform wpa_supplicant about a STA
1296 * in an IBSS with which protected frames could be exchanged. This
1297 * event starts RSN authentication with the other STA to authenticate
1298 * the STA and set up encryption keys with it.
1300 EVENT_IBSS_RSN_START,
1303 * EVENT_AUTH - Authentication result
1305 * This event should be called when authentication attempt has been
1306 * completed. This is only used if the driver supports separate
1307 * authentication step (struct wpa_driver_ops::authenticate).
1308 * Information about authentication result is included in
1309 * union wpa_event_data::auth.
1314 * EVENT_DEAUTH - Authentication lost
1316 * This event should be called when authentication is lost either due
1317 * to receiving deauthenticate frame from the AP or when sending that
1318 * frame to the current AP.
1323 * EVENT_ASSOC_REJECT - Association rejected
1325 * This event should be called when (re)association attempt has been
1326 * rejected by the AP. Information about authentication result is
1327 * included in union wpa_event_data::assoc_reject.
1332 * EVENT_AUTH_TIMED_OUT - Authentication timed out
1334 EVENT_AUTH_TIMED_OUT,
1337 * EVENT_ASSOC_TIMED_OUT - Association timed out
1339 EVENT_ASSOC_TIMED_OUT
1344 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
1346 union wpa_event_data {
1348 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
1350 * This structure is optional for EVENT_ASSOC calls and required for
1351 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
1352 * driver interface does not need to generate separate EVENT_ASSOCINFO
1357 * req_ies - (Re)Association Request IEs
1359 * If the driver generates WPA/RSN IE, this event data must be
1360 * returned for WPA handshake to have needed information. If
1361 * wpa_supplicant-generated WPA/RSN IE is used, this
1362 * information event is optional.
1364 * This should start with the first IE (fixed fields before IEs
1365 * are not included).
1370 * req_ies_len - Length of req_ies in bytes
1375 * resp_ies - (Re)Association Response IEs
1377 * Optional association data from the driver. This data is not
1378 * required WPA, but may be useful for some protocols and as
1379 * such, should be reported if this is available to the driver
1382 * This should start with the first IE (fixed fields before IEs
1383 * are not included).
1388 * resp_ies_len - Length of resp_ies in bytes
1390 size_t resp_ies_len;
1393 * beacon_ies - Beacon or Probe Response IEs
1395 * Optional Beacon/ProbeResp data: IEs included in Beacon or
1396 * Probe Response frames from the current AP (i.e., the one
1397 * that the client just associated with). This information is
1398 * used to update WPA/RSN IE for the AP. If this field is not
1399 * set, the results from previous scan will be used. If no
1400 * data for the new AP is found, scan results will be requested
1401 * again (without scan request). At this point, the driver is
1402 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
1405 * This should start with the first IE (fixed fields before IEs
1406 * are not included).
1411 * beacon_ies_len - Length of beacon_ies */
1412 size_t beacon_ies_len;
1416 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
1418 struct michael_mic_failure {
1421 } michael_mic_failure;
1424 * struct interface_status - Data for EVENT_INTERFACE_STATUS
1426 struct interface_status {
1429 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
1434 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
1436 struct pmkid_candidate {
1437 /** BSSID of the PMKID candidate */
1439 /** Smaller the index, higher the priority */
1441 /** Whether RSN IE includes pre-authenticate flag */
1446 * struct stkstart - Data for EVENT_STKSTART
1453 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
1455 * During FT (IEEE 802.11r) authentication sequence, the driver is
1456 * expected to use this event to report received FT IEs (MDIE, FTIE,
1457 * RSN IE, TIE, possible resource request) to the supplicant. The FT
1458 * IEs for the next message will be delivered through the
1459 * struct wpa_driver_ops::update_ft_ies() callback.
1465 u8 target_ap[ETH_ALEN];
1466 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
1468 /** Length of ric_ies buffer in octets */
1473 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
1475 struct ibss_rsn_start {
1480 * struct auth_info - Data for EVENT_AUTH events
1491 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
1493 struct assoc_reject {
1495 * resp_ies - (Re)Association Response IEs
1497 * Optional association data from the driver. This data is not
1498 * required WPA, but may be useful for some protocols and as
1499 * such, should be reported if this is available to the driver
1502 * This should start with the first IE (fixed fields before IEs
1503 * are not included).
1508 * resp_ies_len - Length of resp_ies in bytes
1510 size_t resp_ies_len;
1513 * status_code - Status Code from (Re)association Response
1518 struct timeout_event {
1524 * wpa_supplicant_event - Report a driver event for wpa_supplicant
1525 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1526 * with struct wpa_driver_ops::init()
1527 * @event: event type (defined above)
1528 * @data: possible extra data for the event
1530 * Driver wrapper code should call this function whenever an event is received
1533 void wpa_supplicant_event(void *ctx, wpa_event_type event,
1534 union wpa_event_data *data);
1537 * wpa_supplicant_rx_eapol - Deliver a received EAPOL frame to wpa_supplicant
1538 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1539 * with struct wpa_driver_ops::init()
1540 * @src_addr: Source address of the EAPOL frame
1541 * @buf: EAPOL data starting from the EAPOL header (i.e., no Ethernet header)
1542 * @len: Length of the EAPOL data
1544 * This function is called for each received EAPOL frame. Most driver
1545 * interfaces rely on more generic OS mechanism for receiving frames through
1546 * l2_packet, but if such a mechanism is not available, the driver wrapper may
1547 * take care of received EAPOL frames and deliver them to the core supplicant
1548 * code by calling this function.
1550 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
1551 const u8 *buf, size_t len);
1553 void wpa_supplicant_sta_rx(void *ctx, const u8 *buf, size_t len,
1554 struct ieee80211_rx_status *rx_status);
1556 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie);
1557 #define WPA_IE_VENDOR_TYPE 0x0050f201
1558 #define WPS_IE_VENDOR_TYPE 0x0050f204
1559 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
1561 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
1563 int wpa_scan_get_max_rate(const struct wpa_scan_res *res);
1564 void wpa_scan_results_free(struct wpa_scan_results *res);
1565 void wpa_scan_sort_results(struct wpa_scan_results *res);
1567 /* hostapd functions for driver wrappers */
1570 struct ieee80211_hdr;
1572 void hostapd_new_assoc_sta(struct hostapd_data *hapd, struct sta_info *sta,
1574 void hostapd_tx_status(struct hostapd_data *hapd, const u8 *addr,
1575 const u8 *buf, size_t len, int ack);
1576 void hostapd_rx_from_unknown_sta(struct hostapd_data *hapd,
1577 const struct ieee80211_hdr *hdr, size_t len);
1578 int hostapd_notif_assoc(struct hostapd_data *hapd, const u8 *addr,
1579 const u8 *ie, size_t ielen);
1580 void hostapd_notif_disassoc(struct hostapd_data *hapd, const u8 *addr);
1581 void hostapd_eapol_receive(struct hostapd_data *hapd, const u8 *sa,
1582 const u8 *buf, size_t len);
1584 struct hostapd_frame_info {
1591 void hostapd_mgmt_rx(struct hostapd_data *hapd, u8 *buf, size_t len,
1592 u16 stype, struct hostapd_frame_info *fi);
1593 void hostapd_mgmt_tx_cb(struct hostapd_data *hapd, u8 *buf, size_t len,
1595 void hostapd_michael_mic_failure(struct hostapd_data *hapd, const u8 *addr);
1596 struct hostapd_data * hostapd_sta_get_bss(struct hostapd_data *hapd,
1598 void hostapd_probe_req_rx(struct hostapd_data *hapd, const u8 *sa,
1599 const u8 *ie, size_t ie_len);
1600 void hostapd_button_pushed(struct hostapd_data *hapd);
1602 #endif /* DRIVER_H */