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 struct hostapd_hw_modes {
37 struct hostapd_channel_data *channels;
39 int *rates; /* array of rates in 100 kbps units */
46 #define AUTH_ALG_OPEN_SYSTEM 0x01
47 #define AUTH_ALG_SHARED_KEY 0x02
48 #define AUTH_ALG_LEAP 0x04
49 #define AUTH_ALG_FT 0x08
51 #define IEEE80211_MODE_INFRA 0
52 #define IEEE80211_MODE_IBSS 1
53 #define IEEE80211_MODE_AP 2
55 #define IEEE80211_CAP_ESS 0x0001
56 #define IEEE80211_CAP_IBSS 0x0002
57 #define IEEE80211_CAP_PRIVACY 0x0010
59 #define WPA_SCAN_QUAL_INVALID BIT(0)
60 #define WPA_SCAN_NOISE_INVALID BIT(1)
61 #define WPA_SCAN_LEVEL_INVALID BIT(2)
62 #define WPA_SCAN_LEVEL_DBM BIT(3)
63 #define WPA_SCAN_AUTHENTICATED BIT(4)
64 #define WPA_SCAN_ASSOCIATED BIT(5)
67 * struct wpa_scan_res - Scan result for an BSS/IBSS
68 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
70 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
71 * @beacon_int: beacon interval in TUs (host byte order)
72 * @caps: capability information field in host byte order
73 * @qual: signal quality
75 * @level: signal level
77 * @age: Age of the information in milliseconds (i.e., how many milliseconds
78 * ago the last Beacon or Probe Response frame was received)
79 * @ie_len: length of the following IE field in octets
81 * This structure is used as a generic format for scan results from the
82 * driver. Each driver interface implementation is responsible for converting
83 * the driver or OS specific scan results into this format.
85 * If the driver does not support reporting all IEs, the IE data structure is
86 * constructed of the IEs that are available. This field will also need to
87 * include SSID in IE format. All drivers are encouraged to be extended to
88 * report all IEs to make it easier to support future additions.
102 /* followed by ie_len octets of IEs */
106 * struct wpa_scan_results - Scan results
107 * @res: Array of pointers to allocated variable length scan result entries
108 * @num: Number of entries in the scan result array
110 struct wpa_scan_results {
111 struct wpa_scan_res **res;
116 * struct wpa_interface_info - Network interface information
117 * @next: Pointer to the next interface or NULL if this is the last one
118 * @ifname: Interface name that can be used with init() or init2()
119 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
121 * @drv_bame: struct wpa_driver_ops::name (note: unlike other strings, this one
122 * is not an allocated copy, i.e., get_interfaces() caller will not free
125 struct wpa_interface_info {
126 struct wpa_interface_info *next;
129 const char *drv_name;
132 #define WPAS_MAX_SCAN_SSIDS 4
135 * struct wpa_driver_scan_params - Scan parameters
136 * Data for struct wpa_driver_ops::scan2().
138 struct wpa_driver_scan_params {
140 * ssids - SSIDs to scan for
142 struct wpa_driver_scan_ssid {
144 * ssid - specific SSID to scan for (ProbeReq)
145 * %NULL or zero-length SSID is used to indicate active scan
146 * with wildcard SSID.
150 * ssid_len: Length of the SSID in octets
153 } ssids[WPAS_MAX_SCAN_SSIDS];
156 * num_ssids - Number of entries in ssids array
157 * Zero indicates a request for a passive scan.
162 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
167 * extra_ies_len - Length of extra_ies in octets
169 size_t extra_ies_len;
172 * freqs - Array of frequencies to scan or %NULL for all frequencies
174 * The frequency is set in MHz. The array is zero-terminated.
180 * struct wpa_driver_auth_params - Authentication parameters
181 * Data for struct wpa_driver_ops::authenticate().
183 struct wpa_driver_auth_params {
191 const u8 *wep_key[4];
192 size_t wep_key_len[4];
197 * struct wpa_driver_associate_params - Association parameters
198 * Data for struct wpa_driver_ops::associate().
200 struct wpa_driver_associate_params {
202 * bssid - BSSID of the selected AP
203 * This can be %NULL, if ap_scan=2 mode is used and the driver is
204 * responsible for selecting with which BSS to associate. */
208 * ssid - The selected SSID
214 * freq - Frequency of the channel the selected AP is using
215 * Frequency that the selected AP is using (in MHz as
216 * reported in the scan results)
221 * wpa_ie - WPA information element for (Re)Association Request
222 * WPA information element to be included in (Re)Association
223 * Request (including information element id and length). Use
224 * of this WPA IE is optional. If the driver generates the WPA
225 * IE, it can use pairwise_suite, group_suite, and
226 * key_mgmt_suite to select proper algorithms. In this case,
227 * the driver has to notify wpa_supplicant about the used WPA
228 * IE by generating an event that the interface code will
229 * convert into EVENT_ASSOCINFO data (see below).
231 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
232 * instead. The driver can determine which version is used by
233 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
236 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
240 * wpa_ie_len - length of the wpa_ie
244 /* The selected pairwise/group cipher and key management
245 * suites. These are usually ignored if @wpa_ie is used. */
246 wpa_cipher pairwise_suite;
247 wpa_cipher group_suite;
248 wpa_key_mgmt key_mgmt_suite;
251 * auth_alg - Allowed authentication algorithms
252 * Bit field of AUTH_ALG_*
257 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
262 * wep_key - WEP keys for static WEP configuration
264 const u8 *wep_key[4];
267 * wep_key_len - WEP key length for static WEP configuration
269 size_t wep_key_len[4];
272 * wep_tx_keyidx - WEP TX key index for static WEP configuration
277 * mgmt_frame_protection - IEEE 802.11w management frame protection
280 NO_MGMT_FRAME_PROTECTION,
281 MGMT_FRAME_PROTECTION_OPTIONAL,
282 MGMT_FRAME_PROTECTION_REQUIRED
283 } mgmt_frame_protection;
286 * ft_ies - IEEE 802.11r / FT information elements
287 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
288 * for fast transition, this parameter is set to include the IEs that
289 * are to be sent in the next FT Authentication Request message.
290 * update_ft_ies() handler is called to update the IEs for further
291 * FT messages in the sequence.
293 * The driver should use these IEs only if the target AP is advertising
294 * the same mobility domain as the one included in the MDIE here.
296 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
297 * AP after the initial association. These IEs can only be used if the
298 * target AP is advertising support for FT and is using the same MDIE
299 * and SSID as the current AP.
301 * The driver is responsible for reporting the FT IEs received from the
302 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
303 * type. update_ft_ies() handler will then be called with the FT IEs to
304 * include in the next frame in the authentication sequence.
309 * ft_ies_len - Length of ft_ies in bytes
314 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
316 * This value is provided to allow the driver interface easier access
317 * to the current mobility domain. This value is set to %NULL if no
318 * mobility domain is currently active.
323 * passphrase - RSN passphrase for PSK
325 * This value is made available only for WPA/WPA2-Personal (PSK) and
326 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
327 * the 8..63 character ASCII passphrase, if available. Please note that
328 * this can be %NULL if passphrase was not used to generate the PSK. In
329 * that case, the psk field must be used to fetch the PSK.
331 const char *passphrase;
334 * psk - RSN PSK (alternative for 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 32-octet (256-bit) PSK, if available. The driver wrapper should
339 * be prepared to handle %NULL value as an error.
344 * drop_unencrypted - Enable/disable unencrypted frame filtering
346 * Configure the driver to drop all non-EAPOL frames (both receive and
347 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
348 * still be allowed for key negotiation.
350 int drop_unencrypted;
353 * prev_bssid - Previously used BSSID in this ESS
355 * When not %NULL, this is a request to use reassociation instead of
358 const u8 *prev_bssid;
362 * struct wpa_driver_capa - Driver capability information
364 struct wpa_driver_capa {
365 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
366 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
367 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
368 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
369 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
370 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
371 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
372 unsigned int key_mgmt;
374 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
375 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
376 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
377 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
380 #define WPA_DRIVER_AUTH_OPEN 0x00000001
381 #define WPA_DRIVER_AUTH_SHARED 0x00000002
382 #define WPA_DRIVER_AUTH_LEAP 0x00000004
385 /* Driver generated WPA/RSN IE */
386 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
387 /* Driver needs static WEP key setup after association command */
388 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
389 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
390 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
391 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
392 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
393 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
394 /* Driver provides separate commands for authentication and association (SME in
395 * wpa_supplicant). */
396 #define WPA_DRIVER_FLAGS_SME 0x00000020
397 /* Driver supports AP mode */
398 #define WPA_DRIVER_FLAGS_AP 0x00000040
399 /* Driver needs static WEP key setup after association has been completed */
400 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
407 struct ieee80211_rx_status {
415 struct hostap_sta_driver_data {
416 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes;
417 unsigned long current_tx_rate;
418 unsigned long inactive_msec;
420 unsigned long num_ps_buf_frames;
421 unsigned long tx_retry_failed;
422 unsigned long tx_retry_count;
427 struct hostapd_sta_add_params {
431 const u8 *supp_rates;
432 size_t supp_rates_len;
435 const struct ieee80211_ht_capabilities *ht_capabilities;
438 struct hostapd_freq_params {
443 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled,
444 * secondary channel below primary, 1 = HT40
445 * enabled, secondary channel above primary */
448 enum wpa_driver_if_type {
450 * WPA_IF_STATION - Station mode interface
455 * WPA_IF_AP_VLAN - AP mode VLAN interface
457 * This interface shares its address and Beacon frame with the main
463 * WPA_IF_AP_BSS - AP mode BSS interface
465 * This interface has its own address and Beacon frame.
470 struct wpa_init_params {
475 const char *test_socket;
476 int use_pae_group_addr;
480 u8 *own_addr; /* buffer for writing own MAC address */
485 * struct wpa_driver_ops - Driver interface API definition
487 * This structure defines the API that each driver interface needs to implement
488 * for core wpa_supplicant code. All driver specific functionality is captured
491 struct wpa_driver_ops {
492 /** Name of the driver interface */
494 /** One line description of the driver interface */
498 * get_bssid - Get the current BSSID
499 * @priv: private driver interface data
500 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
502 * Returns: 0 on success, -1 on failure
504 * Query kernel driver for the current BSSID and copy it to bssid.
505 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
508 int (*get_bssid)(void *priv, u8 *bssid);
511 * get_ssid - Get the current SSID
512 * @priv: private driver interface data
513 * @ssid: buffer for SSID (at least 32 bytes)
515 * Returns: Length of the SSID on success, -1 on failure
517 * Query kernel driver for the current SSID and copy it to ssid.
518 * Returning zero is recommended if the STA is not associated.
520 * Note: SSID is an array of octets, i.e., it is not nul terminated and
521 * can, at least in theory, contain control characters (including nul)
522 * and as such, should be processed as binary data, not a printable
525 int (*get_ssid)(void *priv, u8 *ssid);
528 * set_key - Configure encryption key
529 * @ifname: Interface name (for multi-SSID/VLAN support)
530 * @priv: private driver interface data
531 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
532 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
533 * %WPA_ALG_NONE clears the key.
534 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
535 * broadcast/default keys
536 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
538 * @set_tx: configure this key as the default Tx key (only used when
539 * driver does not support separate unicast/individual key
540 * @seq: sequence number/packet number, seq_len octets, the next
541 * packet number to be used for in replay protection; configured
542 * for Rx keys (in most cases, this is only used with broadcast
543 * keys and set to zero for unicast keys)
544 * @seq_len: length of the seq, depends on the algorithm:
545 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
546 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
548 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
549 * TKIP: 32, CCMP: 16, IGTK: 16)
551 * Returns: 0 on success, -1 on failure
553 * Configure the given key for the kernel driver. If the driver
554 * supports separate individual keys (4 default keys + 1 individual),
555 * addr can be used to determine whether the key is default or
556 * individual. If only 4 keys are supported, the default key with key
557 * index 0 is used as the individual key. STA must be configured to use
558 * it as the default Tx key (set_tx is set) and accept Rx for all the
559 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
560 * broadcast keys, so key index 0 is available for this kind of
563 * Please note that TKIP keys include separate TX and RX MIC keys and
564 * some drivers may expect them in different order than wpa_supplicant
565 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
566 * will tricker Michael MIC errors. This can be fixed by changing the
567 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
568 * in driver_*.c set_key() implementation, see driver_ndis.c for an
569 * example on how this can be done.
571 int (*set_key)(const char *ifname, void *priv, wpa_alg alg,
572 const u8 *addr, int key_idx, int set_tx,
573 const u8 *seq, size_t seq_len,
574 const u8 *key, size_t key_len);
577 * init - Initialize driver interface
578 * @ctx: context to be used when calling wpa_supplicant functions,
579 * e.g., wpa_supplicant_event()
580 * @ifname: interface name, e.g., wlan0
582 * Returns: Pointer to private data, %NULL on failure
584 * Initialize driver interface, including event processing for kernel
585 * driver events (e.g., associated, scan results, Michael MIC failure).
586 * This function can allocate a private configuration data area for
587 * @ctx, file descriptor, interface name, etc. information that may be
588 * needed in future driver operations. If this is not used, non-NULL
589 * value will need to be returned because %NULL is used to indicate
590 * failure. The returned value will be used as 'void *priv' data for
591 * all other driver_ops functions.
593 * The main event loop (eloop.c) of wpa_supplicant can be used to
594 * register callback for read sockets (eloop_register_read_sock()).
596 * See below for more information about events and
597 * wpa_supplicant_event() function.
599 void * (*init)(void *ctx, const char *ifname);
602 * deinit - Deinitialize driver interface
603 * @priv: private driver interface data from init()
605 * Shut down driver interface and processing of driver events. Free
606 * private data buffer if one was allocated in init() handler.
608 void (*deinit)(void *priv);
611 * set_param - Set driver configuration parameters
612 * @priv: private driver interface data from init()
613 * @param: driver specific configuration parameters
615 * Returns: 0 on success, -1 on failure
617 * Optional handler for notifying driver interface about configuration
618 * parameters (driver_param).
620 int (*set_param)(void *priv, const char *param);
623 * set_countermeasures - Enable/disable TKIP countermeasures
624 * @priv: private driver interface data
625 * @enabled: 1 = countermeasures enabled, 0 = disabled
627 * Returns: 0 on success, -1 on failure
629 * Configure TKIP countermeasures. When these are enabled, the driver
630 * should drop all received and queued frames that are using TKIP.
632 int (*set_countermeasures)(void *priv, int enabled);
635 * deauthenticate - Request driver to deauthenticate
636 * @priv: private driver interface data
637 * @addr: peer address (BSSID of the AP)
638 * @reason_code: 16-bit reason code to be sent in the deauthentication
641 * Returns: 0 on success, -1 on failure
643 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
646 * disassociate - Request driver to disassociate
647 * @priv: private driver interface data
648 * @addr: peer address (BSSID of the AP)
649 * @reason_code: 16-bit reason code to be sent in the disassociation
652 * Returns: 0 on success, -1 on failure
654 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
657 * associate - Request driver to associate
658 * @priv: private driver interface data
659 * @params: association parameters
661 * Returns: 0 on success, -1 on failure
663 int (*associate)(void *priv,
664 struct wpa_driver_associate_params *params);
667 * add_pmkid - Add PMKSA cache entry to the driver
668 * @priv: private driver interface data
669 * @bssid: BSSID for the PMKSA cache entry
670 * @pmkid: PMKID for the PMKSA cache entry
672 * Returns: 0 on success, -1 on failure
674 * This function is called when a new PMK is received, as a result of
675 * either normal authentication or RSN pre-authentication.
677 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
678 * associate(), add_pmkid() can be used to add new PMKSA cache entries
679 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
680 * driver_ops function does not need to be implemented. Likewise, if
681 * the driver does not support WPA, this function is not needed.
683 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
686 * remove_pmkid - Remove PMKSA cache entry to the driver
687 * @priv: private driver interface data
688 * @bssid: BSSID for the PMKSA cache entry
689 * @pmkid: PMKID for the PMKSA cache entry
691 * Returns: 0 on success, -1 on failure
693 * This function is called when the supplicant drops a PMKSA cache
694 * entry for any reason.
696 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
697 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
698 * between the driver and wpa_supplicant. If the driver uses wpa_ie
699 * from wpa_supplicant, this driver_ops function does not need to be
700 * implemented. Likewise, if the driver does not support WPA, this
701 * function is not needed.
703 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
706 * flush_pmkid - Flush PMKSA cache
707 * @priv: private driver interface data
709 * Returns: 0 on success, -1 on failure
711 * This function is called when the supplicant drops all PMKSA cache
712 * entries for any reason.
714 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
715 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
716 * between the driver and wpa_supplicant. If the driver uses wpa_ie
717 * from wpa_supplicant, this driver_ops function does not need to be
718 * implemented. Likewise, if the driver does not support WPA, this
719 * function is not needed.
721 int (*flush_pmkid)(void *priv);
724 * get_capa - Get driver capabilities
725 * @priv: private driver interface data
727 * Returns: 0 on success, -1 on failure
729 * Get driver/firmware/hardware capabilities.
731 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
734 * poll - Poll driver for association information
735 * @priv: private driver interface data
737 * This is an option callback that can be used when the driver does not
738 * provide event mechanism for association events. This is called when
739 * receiving WPA EAPOL-Key messages that require association
740 * information. The driver interface is supposed to generate associnfo
741 * event before returning from this callback function. In addition, the
742 * driver interface should generate an association event after having
743 * sent out associnfo.
745 void (*poll)(void *priv);
748 * get_ifname - Get interface name
749 * @priv: private driver interface data
751 * Returns: Pointer to the interface name. This can differ from the
752 * interface name used in init() call. Init() is called first.
754 * This optional function can be used to allow the driver interface to
755 * replace the interface name with something else, e.g., based on an
756 * interface mapping from a more descriptive name.
758 const char * (*get_ifname)(void *priv);
761 * get_mac_addr - Get own MAC address
762 * @priv: private driver interface data
764 * Returns: Pointer to own MAC address or %NULL on failure
766 * This optional function can be used to get the own MAC address of the
767 * device from the driver interface code. This is only needed if the
768 * l2_packet implementation for the OS does not provide easy access to
770 const u8 * (*get_mac_addr)(void *priv);
773 * send_eapol - Optional function for sending EAPOL packets
774 * @priv: private driver interface data
775 * @dest: Destination MAC address
777 * @data: EAPOL packet starting with IEEE 802.1X header
778 * @data_len: Size of the EAPOL packet
780 * Returns: 0 on success, -1 on failure
782 * This optional function can be used to override l2_packet operations
783 * with driver specific functionality. If this function pointer is set,
784 * l2_packet module is not used at all and the driver interface code is
785 * responsible for receiving and sending all EAPOL packets. The
786 * received EAPOL packets are sent to core code by calling
787 * wpa_supplicant_rx_eapol(). The driver interface is required to
788 * implement get_mac_addr() handler if send_eapol() is used.
790 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
791 const u8 *data, size_t data_len);
794 * set_operstate - Sets device operating state to DORMANT or UP
795 * @priv: private driver interface data
796 * @state: 0 = dormant, 1 = up
797 * Returns: 0 on success, -1 on failure
799 * This is an optional function that can be used on operating systems
800 * that support a concept of controlling network device state from user
801 * space applications. This function, if set, gets called with
802 * state = 1 when authentication has been completed and with state = 0
803 * when connection is lost.
805 int (*set_operstate)(void *priv, int state);
808 * mlme_setprotection - MLME-SETPROTECTION.request primitive
809 * @priv: Private driver interface data
810 * @addr: Address of the station for which to set protection (may be
811 * %NULL for group keys)
812 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
813 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
814 * Returns: 0 on success, -1 on failure
816 * This is an optional function that can be used to set the driver to
817 * require protection for Tx and/or Rx frames. This uses the layer
818 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
819 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
820 * set protection operation; instead, they set protection implicitly
821 * based on configured keys.
823 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
827 * get_hw_feature_data - Get hardware support data (channels and rates)
828 * @priv: Private driver interface data
829 * @num_modes: Variable for returning the number of returned modes
830 * flags: Variable for returning hardware feature flags
831 * Returns: Pointer to allocated hardware data on success or %NULL on
832 * failure. Caller is responsible for freeing this.
834 * This function is only needed for drivers that export MLME
835 * (management frame processing) to wpa_supplicant.
837 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
842 * set_channel - Set channel
843 * @priv: Private driver interface data
844 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
845 * @chan: IEEE 802.11 channel number
846 * @freq: Frequency of the channel in MHz
847 * Returns: 0 on success, -1 on failure
849 * This function is only needed for drivers that export MLME
850 * (management frame processing) to wpa_supplicant.
852 int (*set_channel)(void *priv, hostapd_hw_mode phymode, int chan,
856 * set_ssid - Set SSID
857 * @priv: Private driver interface data
859 * @ssid_len: SSID length
860 * Returns: 0 on success, -1 on failure
862 * This function is only needed for drivers that export MLME
863 * (management frame processing) to wpa_supplicant.
865 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
868 * set_bssid - Set BSSID
869 * @priv: Private driver interface data
871 * Returns: 0 on success, -1 on failure
873 * This function is only needed for drivers that export MLME
874 * (management frame processing) to wpa_supplicant.
876 int (*set_bssid)(void *priv, const u8 *bssid);
879 * send_mlme - Send management frame from MLME
880 * @priv: Private driver interface data
881 * @data: IEEE 802.11 management frame with IEEE 802.11 header
882 * @data_len: Size of the management frame
883 * Returns: 0 on success, -1 on failure
885 * This function is only needed for drivers that export MLME
886 * (management frame processing) to wpa_supplicant.
888 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
891 * mlme_add_sta - Add a STA entry into the driver/netstack
892 * @priv: Private driver interface data
893 * @addr: MAC address of the STA (e.g., BSSID of the AP)
894 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
895 * format (one octet per rate, 1 = 0.5 Mbps)
896 * @supp_rates_len: Number of entries in supp_rates
897 * Returns: 0 on success, -1 on failure
899 * This function is only needed for drivers that export MLME
900 * (management frame processing) to wpa_supplicant. When the MLME code
901 * completes association with an AP, this function is called to
902 * configure the driver/netstack with a STA entry for data frame
903 * processing (TX rate control, encryption/decryption).
905 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
906 size_t supp_rates_len);
909 * mlme_remove_sta - Remove a STA entry from the driver/netstack
910 * @priv: Private driver interface data
911 * @addr: MAC address of the STA (e.g., BSSID of the AP)
912 * Returns: 0 on success, -1 on failure
914 * This function is only needed for drivers that export MLME
915 * (management frame processing) to wpa_supplicant.
917 int (*mlme_remove_sta)(void *priv, const u8 *addr);
920 * update_ft_ies - Update FT (IEEE 802.11r) IEs
921 * @priv: Private driver interface data
922 * @md: Mobility domain (2 octets) (also included inside ies)
923 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
924 * @ies_len: Length of FT IEs in bytes
925 * Returns: 0 on success, -1 on failure
927 * The supplicant uses this callback to let the driver know that keying
928 * material for FT is available and that the driver can use the
929 * provided IEs in the next message in FT authentication sequence.
931 * This function is only needed for driver that support IEEE 802.11r
932 * (Fast BSS Transition).
934 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
938 * send_ft_action - Send FT Action frame (IEEE 802.11r)
939 * @priv: Private driver interface data
940 * @action: Action field value
941 * @target_ap: Target AP address
942 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
943 * @ies_len: Length of FT IEs in bytes
944 * Returns: 0 on success, -1 on failure
946 * The supplicant uses this callback to request the driver to transmit
947 * an FT Action frame (action category 6) for over-the-DS fast BSS
950 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
951 const u8 *ies, size_t ies_len);
954 * get_scan_results2 - Fetch the latest scan results
955 * @priv: private driver interface data
957 * Returns: Allocated buffer of scan results (caller is responsible for
958 * freeing the data structure) on success, NULL on failure
960 struct wpa_scan_results * (*get_scan_results2)(void *priv);
963 * set_country - Set country
964 * @priv: Private driver interface data
965 * @alpha2: country to which to switch to
966 * Returns: 0 on success, -1 on failure
968 * This function is for drivers which support some form
969 * of setting a regulatory domain.
971 int (*set_country)(void *priv, const char *alpha2);
974 * global_init - Global driver initialization
975 * Returns: Pointer to private data (global), %NULL on failure
977 * This optional function is called to initialize the driver wrapper
978 * for global data, i.e., data that applies to all interfaces. If this
979 * function is implemented, global_deinit() will also need to be
980 * implemented to free the private data. The driver will also likely
981 * use init2() function instead of init() to get the pointer to global
982 * data available to per-interface initializer.
984 void * (*global_init)(void);
987 * global_deinit - Global driver deinitialization
988 * @priv: private driver global data from global_init()
990 * Terminate any global driver related functionality and free the
991 * global data structure.
993 void (*global_deinit)(void *priv);
996 * init2 - Initialize driver interface (with global data)
997 * @ctx: context to be used when calling wpa_supplicant functions,
998 * e.g., wpa_supplicant_event()
999 * @ifname: interface name, e.g., wlan0
1000 * @global_priv: private driver global data from global_init()
1001 * Returns: Pointer to private data, %NULL on failure
1003 * This function can be used instead of init() if the driver wrapper
1006 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1009 * get_interfaces - Get information about available interfaces
1010 * @global_priv: private driver global data from global_init()
1011 * Returns: Allocated buffer of interface information (caller is
1012 * responsible for freeing the data structure) on success, NULL on
1015 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1018 * scan2 - Request the driver to initiate scan
1019 * @priv: private driver interface data
1020 * @params: Scan parameters
1022 * Returns: 0 on success, -1 on failure
1024 * Once the scan results are ready, the driver should report scan
1025 * results event for wpa_supplicant which will eventually request the
1026 * results with wpa_driver_get_scan_results2().
1028 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1031 * authenticate - Request driver to authenticate
1032 * @priv: private driver interface data
1033 * @params: authentication parameters
1034 * Returns: 0 on success, -1 on failure
1036 * This is an optional function that can be used with drivers that
1037 * support separate authentication and association steps, i.e., when
1038 * wpa_supplicant can act as the SME. If not implemented, associate()
1039 * function is expected to take care of IEEE 802.11 authentication,
1042 int (*authenticate)(void *priv,
1043 struct wpa_driver_auth_params *params);
1046 * set_beacon - Set Beacon frame template
1047 * @iface: Interface name (main interface or virtual BSS)
1048 * @priv: Private driver interface data
1049 * @head: Beacon head from IEEE 802.11 header to IEs before TIM IE
1050 * @head_len: Length of the head buffer in octets
1051 * @tail: Beacon tail following TIM IE
1052 * @tail_len: Length of the tail buffer in octets
1053 * @dtim_period: DTIM period
1054 * @beacon_int: Beacon interval
1055 * Returns: 0 on success, -1 on failure
1057 * This function is used to configure Beacon template for the driver in
1058 * AP mode. The driver is responsible for building the full Beacon
1059 * frame by concatenating the head part with TIM IE generated by the
1060 * driver/firmware and finishing with the tail part.
1062 int (*set_beacon)(const char *ifname, void *priv,
1063 const u8 *head, size_t head_len,
1064 const u8 *tail, size_t tail_len, int dtim_period,
1068 * hapd_init - Initialize driver interface (hostapd only)
1069 * @hapd: Pointer to hostapd context
1070 * @params: Configuration for the driver wrapper
1071 * Returns: Pointer to private data, %NULL on failure
1073 * This function is used instead of init() or init2() when the driver
1074 * wrapper is used withh hostapd.
1076 void * (*hapd_init)(struct hostapd_data *hapd,
1077 struct wpa_init_params *params);
1080 * hapd_deinit - Deinitialize driver interface (hostapd only)
1081 * @priv: Private driver interface data from hapd_init()
1083 void (*hapd_deinit)(void *priv);
1086 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1087 * @ifname: Interface name (for multi-SSID/VLAN support)
1088 * @priv: Private driver interface data
1089 * @enabled: 1 = enable, 0 = disable
1090 * Returns: 0 on success, -1 on failure
1092 * This is an optional function to configure the kernel driver to
1093 * enable/disable 802.1X support. This can be left undefined (set to
1094 * %NULL) if IEEE 802.1X support is always enabled.
1096 int (*set_ieee8021x)(const char *ifname, void *priv, int enabled);
1099 * set_privacy - Enable/disable privacy (AP only)
1100 * @priv: Private driver interface data
1101 * @enabled: 1 = privacy enabled, 0 = disabled
1102 * Returns: 0 on success, -1 on failure
1104 * This is an optional function to configure privacy field in the
1105 * kernel driver for Beacon frames. This can be left undefined (set to
1106 * %NULL) if the driver uses the Beacon template from set_beacon().
1108 int (*set_privacy)(const char *ifname, void *priv, int enabled);
1111 * get_seqnum - Fetch the current TSC/packet number (AP only)
1112 * @ifname: The interface name (main or virtual)
1113 * @priv: Private driver interface data
1114 * @addr: MAC address of the station or %NULL for group keys
1116 * @seq: Buffer for returning the latest used TSC/packet number
1117 * Returns: 0 on success, -1 on failure
1119 * This function is used to fetch the last used TSC/packet number for
1120 * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
1121 * there is no strict requirement on implementing support for unicast
1122 * keys (i.e., addr != %NULL).
1124 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1128 * flush - Flush all association stations (AP only)
1129 * @priv: Private driver interface data
1130 * Returns: 0 on success, -1 on failure
1132 * This function requests the driver to disassociate all associated
1133 * stations. This function does not need to be implemented if the
1134 * driver does not process association frames internally.
1136 int (*flush)(void *priv);
1139 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1140 * @ifname: The interface name (main or virtual BSS)
1141 * @priv: Private driver interface data
1142 * @elem: Information elements
1143 * @elem_len: Length of the elem buffer in octets
1144 * Returns: 0 on success, -1 on failure
1146 * This is an optional function to add information elements in the
1147 * kernel driver for Beacon and Probe Response frames. This can be left
1148 * undefined (set to %NULL) if the driver uses the Beacon template from
1151 int (*set_generic_elem)(const char *ifname, void *priv, const u8 *elem,
1155 * read_sta_data - Fetch station data (AP only)
1156 * @priv: Private driver interface data
1157 * @data: Buffer for returning station information
1158 * @addr: MAC address of the station
1159 * Returns: 0 on success, -1 on failure
1161 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1165 * hapd_send_eapol - Send an EAPOL packet (AP only)
1166 * @priv: private driver interface data
1167 * @addr: Destination MAC address
1168 * @data: EAPOL packet starting with IEEE 802.1X header
1169 * @data_len: Length of the EAPOL packet in octets
1170 * @encrypt: Whether the frame should be encrypted
1171 * @own_addr: Source MAC address
1173 * Returns: 0 on success, -1 on failure
1175 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1176 size_t data_len, int encrypt,
1177 const u8 *own_addr);
1180 * sta_deauth - Deauthenticate a station (AP only)
1181 * @priv: Private driver interface data
1182 * @own_addr: Source address and BSSID for the Deauthentication frame
1183 * @addr: MAC address of the station to deauthenticate
1184 * @reason: Reason code for the Deauthentiation frame
1185 * Returns: 0 on success, -1 on failure
1187 * This function requests a specific station to be deauthenticated and
1188 * a Deauthentication frame to be sent to it.
1190 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1194 * sta_disassoc - Disassociate a station (AP only)
1195 * @priv: Private driver interface data
1196 * @own_addr: Source address and BSSID for the Disassociation frame
1197 * @addr: MAC address of the station to disassociate
1198 * @reason: Reason code for the Disassociation frame
1199 * Returns: 0 on success, -1 on failure
1201 * This function requests a specific station to be disassociated and
1202 * a Disassociation frame to be sent to it.
1204 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1208 * sta_remove - Remove a station entry (AP only)
1209 * @priv: Private driver interface data
1210 * @addr: MAC address of the station to be removed
1211 * Returns: 0 on success, -1 on failure
1213 int (*sta_remove)(void *priv, const u8 *addr);
1216 * hapd_get_ssid - Get the current SSID (AP only)
1217 * @ifname: Interface (master or virtual BSS)
1218 * @priv: Private driver interface data
1219 * @buf: Buffer for returning the SSID
1220 * @len: Maximum length of the buffer
1221 * Returns: Length of the SSID on success, -1 on failure
1223 * This function need not be implemented if the driver uses Beacon
1224 * template from set_beacon() and does not reply to Probe Request
1227 int (*hapd_get_ssid)(const char *ifname, void *priv, u8 *buf, int len);
1230 * hapd_set_ssid - Set SSID (AP only)
1231 * @ifname: Interface (master or virtual BSS)
1232 * @priv: Private driver interface data
1234 * @len: Length of the SSID in octets
1235 * Returns: 0 on success, -1 on failure
1237 int (*hapd_set_ssid)(const char *ifname, void *priv, const u8 *buf,
1240 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1241 * @priv: Private driver interface data
1242 * @enabled: 1 = countermeasures enabled, 0 = disabled
1243 * Returns: 0 on success, -1 on failure
1245 * This need not be implemented if the driver does not take care of
1246 * association processing.
1248 int (*hapd_set_countermeasures)(void *priv, int enabled);
1251 * sta_add - Add a station entry
1252 * @ifname: Interface (master or virtual)
1253 * @priv: Private driver interface data
1254 * @params: Station parameters
1255 * Returns: 0 on success, -1 on failure
1257 * This function is used to add a station entry to the driver once the
1258 * station has completed association. This is only used if the driver
1259 * does not take care of association processing.
1261 int (*sta_add)(const char *ifname, void *priv,
1262 struct hostapd_sta_add_params *params);
1265 * get_inact_sec - Get station inactivity duration (AP only)
1266 * @priv: Private driver interface data
1267 * @addr: Station address
1268 * Returns: Number of seconds station has been inactive, -1 on failure
1270 int (*get_inact_sec)(void *priv, const u8 *addr);
1273 * sta_clear_stats - Clear station statistics (AP only)
1274 * @priv: Private driver interface data
1275 * @addr: Station address
1276 * Returns: 0 on success, -1 on failure
1278 int (*sta_clear_stats)(void *priv, const u8 *addr);
1281 * set_freq - Set channel/frequency (AP only)
1282 * @priv: Private driver interface data
1283 * @freq: Channel parameters
1284 * Returns: 0 on success, -1 on failure
1286 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1289 * set_rts - Set RTS threshold
1290 * @priv: Private driver interface data
1291 * @rts: RTS threshold in octets
1292 * Returns: 0 on success, -1 on failure
1294 int (*set_rts)(void *priv, int rts);
1297 * set_frag - Set fragmentation threshold
1298 * @priv: Private driver interface data
1299 * @frag: Fragmentation threshold in octets
1300 * Returns: 0 on success, -1 on failure
1302 int (*set_frag)(void *priv, int frag);
1305 * sta_set_flags - Set station flags (AP only)
1306 * @priv: Private driver interface data
1307 * @addr: Station address
1308 * @total_flags: Bitmap of all WLAN_STA_* flags currently set
1309 * @flags_or: Bitmap of WLAN_STA_* flags to add
1310 * @flags_and: Bitmap of WLAN_STA_* flags to us as a mask
1311 * Returns: 0 on success, -1 on failure
1313 int (*sta_set_flags)(void *priv, const u8 *addr,
1314 int total_flags, int flags_or, int flags_and);
1317 * set_rate_sets - Set supported and basic rate sets (AP only)
1318 * @priv: Private driver interface data
1319 * @supp_rates: -1 terminated array of supported rates in 100 kbps
1320 * @basic_rates: -1 terminated array of basic rates in 100 kbps
1321 * @mode: hardware mode (HOSTAPD_MODE_*)
1322 * Returns: 0 on success, -1 on failure
1324 int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
1328 * set_cts_protect - Set CTS protection mode (AP only)
1329 * @priv: Private driver interface data
1330 * @value: Whether CTS protection is enabled
1331 * Returns: 0 on success, -1 on failure
1333 int (*set_cts_protect)(void *priv, int value);
1336 * set_preamble - Set preamble mode (AP only)
1337 * @priv: Private driver interface data
1338 * @value: Whether short preamble is enabled
1339 * Returns: 0 on success, -1 on failure
1341 int (*set_preamble)(void *priv, int value);
1344 * set_short_slot_time - Set short slot time (AP only)
1345 * @priv: Private driver interface data
1346 * @value: Whether short slot time is enabled
1347 * Returns: 0 on success, -1 on failure
1349 int (*set_short_slot_time)(void *priv, int value);
1352 * set_tx_queue_params - Set TX queue parameters
1353 * @priv: Private driver interface data
1354 * @queue: Queue number
1358 * @burst_time: Maximum length for bursting in 0.1 msec units
1360 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1361 int cw_max, int burst_time);
1364 * valid_bss_mask - Validate BSSID mask
1365 * @priv: Private driver interface data
1368 * Returns: 0 if mask is valid, -1 if mask is not valid, 1 if mask can
1369 * be used, but the main interface address must be the first address in
1370 * the block if mask is applied
1372 int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
1375 * if_add - Add a virtual interface
1376 * @iface: Parent interface name
1377 * @priv: Private driver interface data
1378 * @type: Interface type
1379 * @ifname: Interface name for the new virtual interface
1380 * @addr: Local address to use for the interface or %NULL to use the
1381 * parent interface address
1382 * Returns: 0 on success, -1 on failure
1384 int (*if_add)(const char *iface, void *priv,
1385 enum wpa_driver_if_type type, const char *ifname,
1389 * if_remove - Remove a virtual interface
1390 * @priv: Private driver interface data
1391 * @type: Interface type
1392 * @ifname: Interface name of the virtual interface to be removed
1393 * Returns: 0 on success, -1 on failure
1395 int (*if_remove)(void *priv, enum wpa_driver_if_type type,
1396 const char *ifname);
1399 * set_sta_vlan - Bind a station into a specific interface (AP only)
1400 * @priv: Private driver interface data
1401 * @ifname: Interface (main or virtual BSS or VLAN)
1402 * @addr: MAC address of the associated station
1404 * Returns: 0 on success, -1 on failure
1406 * This function is used to bind a station to a specific virtual
1407 * interface. It is only used if when virtual interfaces are supported,
1408 * e.g., to assign stations to different VLAN interfaces based on
1409 * information from a RADIUS server. This allows separate broadcast
1410 * domains to be used with a single BSS.
1412 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1416 * commit - Optional commit changes handler (AP only)
1417 * @priv: driver private data
1418 * Returns: 0 on success, -1 on failure
1420 * This optional handler function can be registered if the driver
1421 * interface implementation needs to commit changes (e.g., by setting
1422 * network interface up) at the end of initial configuration. If set,
1423 * this handler will be called after initial setup has been completed.
1425 int (*commit)(void *priv);
1428 * send_ether - Send an ethernet packet (AP only)
1429 * @priv: private driver interface data
1430 * @dst: Destination MAC address
1431 * @src: Source MAC address
1433 * @data: EAPOL packet starting with IEEE 802.1X header
1434 * @data_len: Length of the EAPOL packet in octets
1435 * Returns: 0 on success, -1 on failure
1437 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1438 const u8 *data, size_t data_len);
1441 * set_radius_acl_auth - Notification of RADIUS ACL change
1442 * @priv: Private driver interface data
1443 * @mac: MAC address of the station
1444 * @accepted: Whether the station was accepted
1445 * @session_timeout: Session timeout for the station
1446 * Returns: 0 on success, -1 on failure
1448 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1449 u32 session_timeout);
1452 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1453 * @priv: Private driver interface data
1454 * @mac: MAC address of the station
1455 * Returns: 0 on success, -1 on failure
1457 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1460 * set_ht_params - Set HT parameters (AP only)
1461 * @ifname: The interface name (main or virtual BSS)
1462 * @priv: Private driver interface data
1463 * @ht_capab: HT Capabilities IE
1464 * @ht_capab_len: Length of ht_capab in octets
1465 * @ht_oper: HT Operation IE
1466 * @ht_oper_len: Length of ht_oper in octets
1467 * Returns: 0 on success, -1 on failure
1469 int (*set_ht_params)(const char *ifname, void *priv,
1470 const u8 *ht_capab, size_t ht_capab_len,
1471 const u8 *ht_oper, size_t ht_oper_len);
1474 * set_wps_beacon_ie - Add WPS IE into Beacon frames (AP only)
1475 * @ifname: The interface name (main or virtual BSS)
1476 * @priv: Private driver interface data
1478 * @len: Length of the ie buffer in octets
1479 * Returns: 0 on success, -1 on failure
1481 * This is an optional function to add WPS IE in the kernel driver for
1482 * Beacon frames. This can be left undefined (set to %NULL) if the
1483 * driver uses the Beacon template from set_beacon().
1485 int (*set_wps_beacon_ie)(const char *ifname, void *priv,
1486 const u8 *ie, size_t len);
1489 * set_wps_probe_resp_ie - Add WPS IE into Probe Response frames (AP)
1490 * @ifname: The interface name (main or virtual BSS)
1491 * @priv: Private driver interface data
1493 * @len: Length of the ie buffer in octets
1494 * Returns: 0 on success, -1 on failure
1496 * This is an optional function to add WPS IE in the kernel driver for
1497 * Beacon frames. This can be left undefined (set to %NULL) if the
1498 * driver does process Probe Request frames.
1500 int (*set_wps_probe_resp_ie)(const char *ifname, void *priv,
1501 const u8 *ie, size_t len);
1504 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1505 * @priv: Private driver interface data
1506 * @authorized: Whether the port is authorized
1507 * Returns: 0 on success, -1 on failure
1509 int (*set_supp_port)(void *priv, int authorized);
1513 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1515 typedef enum wpa_event_type {
1517 * EVENT_ASSOC - Association completed
1519 * This event needs to be delivered when the driver completes IEEE
1520 * 802.11 association or reassociation successfully.
1521 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1522 * after this event has been generated. In addition, optional
1523 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1524 * more information about the association. If the driver interface gets
1525 * both of these events at the same time, it can also include the
1526 * assoc_info data in EVENT_ASSOC call.
1531 * EVENT_DISASSOC - Association lost
1533 * This event should be called when association is lost either due to
1534 * receiving deauthenticate or disassociate frame from the AP or when
1535 * sending either of these frames to the current AP. If the driver
1536 * supports separate deauthentication event, EVENT_DISASSOC should only
1537 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1542 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1544 * This event must be delivered when a Michael MIC error is detected by
1545 * the local driver. Additional data for event processing is
1546 * provided with union wpa_event_data::michael_mic_failure. This
1547 * information is used to request new encyption key and to initiate
1548 * TKIP countermeasures if needed.
1550 EVENT_MICHAEL_MIC_FAILURE,
1553 * EVENT_SCAN_RESULTS - Scan results available
1555 * This event must be called whenever scan results are available to be
1556 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1557 * is expected to be used some time after struct wpa_driver_ops::scan()
1558 * is called. If the driver provides an unsolicited event when the scan
1559 * has been completed, this event can be used to trigger
1560 * EVENT_SCAN_RESULTS call. If such event is not available from the
1561 * driver, the driver wrapper code is expected to use a registered
1562 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1563 * scan is expected to be completed.
1568 * EVENT_ASSOCINFO - Report optional extra information for association
1570 * This event can be used to report extra association information for
1571 * EVENT_ASSOC processing. This extra information includes IEs from
1572 * association frames and Beacon/Probe Response frames in union
1573 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1574 * EVENT_ASSOC. Alternatively, the driver interface can include
1575 * assoc_info data in the EVENT_ASSOC call if it has all the
1576 * information available at the same point.
1581 * EVENT_INTERFACE_STATUS - Report interface status changes
1583 * This optional event can be used to report changes in interface
1584 * status (interface added/removed) using union
1585 * wpa_event_data::interface_status. This can be used to trigger
1586 * wpa_supplicant to stop and re-start processing for the interface,
1587 * e.g., when a cardbus card is ejected/inserted.
1589 EVENT_INTERFACE_STATUS,
1592 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1594 * This event can be used to inform wpa_supplicant about candidates for
1595 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1596 * for scan request (ap_scan=2 mode), this event is required for
1597 * pre-authentication. If wpa_supplicant is performing scan request
1598 * (ap_scan=1), this event is optional since scan results can be used
1599 * to add pre-authentication candidates. union
1600 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1601 * candidate and priority of the candidate, e.g., based on the signal
1602 * strength, in order to try to pre-authenticate first with candidates
1603 * that are most likely targets for re-association.
1605 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1606 * on the candidate list. In addition, it can be called for the current
1607 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1608 * will automatically skip pre-authentication in cases where a valid
1609 * PMKSA exists. When more than one candidate exists, this event should
1610 * be generated once for each candidate.
1612 * Driver will be notified about successful pre-authentication with
1613 * struct wpa_driver_ops::add_pmkid() calls.
1615 EVENT_PMKID_CANDIDATE,
1618 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1620 * This event can be used to inform wpa_supplicant about desire to set
1621 * up secure direct link connection between two stations as defined in
1622 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1623 * STAKey negotiation. The caller will need to set peer address for the
1629 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1631 * The driver is expected to report the received FT IEs from
1632 * FT authentication sequence from the AP. The FT IEs are included in
1633 * the extra information in union wpa_event_data::ft_ies.
1638 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
1640 * The driver can use this event to inform wpa_supplicant about a STA
1641 * in an IBSS with which protected frames could be exchanged. This
1642 * event starts RSN authentication with the other STA to authenticate
1643 * the STA and set up encryption keys with it.
1645 EVENT_IBSS_RSN_START,
1648 * EVENT_AUTH - Authentication result
1650 * This event should be called when authentication attempt has been
1651 * completed. This is only used if the driver supports separate
1652 * authentication step (struct wpa_driver_ops::authenticate).
1653 * Information about authentication result is included in
1654 * union wpa_event_data::auth.
1659 * EVENT_DEAUTH - Authentication lost
1661 * This event should be called when authentication is lost either due
1662 * to receiving deauthenticate frame from the AP or when sending that
1663 * frame to the current AP.
1668 * EVENT_ASSOC_REJECT - Association rejected
1670 * This event should be called when (re)association attempt has been
1671 * rejected by the AP. Information about authentication result is
1672 * included in union wpa_event_data::assoc_reject.
1677 * EVENT_AUTH_TIMED_OUT - Authentication timed out
1679 EVENT_AUTH_TIMED_OUT,
1682 * EVENT_ASSOC_TIMED_OUT - Association timed out
1684 EVENT_ASSOC_TIMED_OUT
1689 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
1691 union wpa_event_data {
1693 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
1695 * This structure is optional for EVENT_ASSOC calls and required for
1696 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
1697 * driver interface does not need to generate separate EVENT_ASSOCINFO
1702 * req_ies - (Re)Association Request IEs
1704 * If the driver generates WPA/RSN IE, this event data must be
1705 * returned for WPA handshake to have needed information. If
1706 * wpa_supplicant-generated WPA/RSN IE is used, this
1707 * information event is optional.
1709 * This should start with the first IE (fixed fields before IEs
1710 * are not included).
1715 * req_ies_len - Length of req_ies in bytes
1720 * resp_ies - (Re)Association Response IEs
1722 * Optional association data from the driver. This data is not
1723 * required WPA, but may be useful for some protocols and as
1724 * such, should be reported if this is available to the driver
1727 * This should start with the first IE (fixed fields before IEs
1728 * are not included).
1733 * resp_ies_len - Length of resp_ies in bytes
1735 size_t resp_ies_len;
1738 * beacon_ies - Beacon or Probe Response IEs
1740 * Optional Beacon/ProbeResp data: IEs included in Beacon or
1741 * Probe Response frames from the current AP (i.e., the one
1742 * that the client just associated with). This information is
1743 * used to update WPA/RSN IE for the AP. If this field is not
1744 * set, the results from previous scan will be used. If no
1745 * data for the new AP is found, scan results will be requested
1746 * again (without scan request). At this point, the driver is
1747 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
1750 * This should start with the first IE (fixed fields before IEs
1751 * are not included).
1756 * beacon_ies_len - Length of beacon_ies */
1757 size_t beacon_ies_len;
1761 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
1763 struct michael_mic_failure {
1766 } michael_mic_failure;
1769 * struct interface_status - Data for EVENT_INTERFACE_STATUS
1771 struct interface_status {
1774 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
1779 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
1781 struct pmkid_candidate {
1782 /** BSSID of the PMKID candidate */
1784 /** Smaller the index, higher the priority */
1786 /** Whether RSN IE includes pre-authenticate flag */
1791 * struct stkstart - Data for EVENT_STKSTART
1798 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
1800 * During FT (IEEE 802.11r) authentication sequence, the driver is
1801 * expected to use this event to report received FT IEs (MDIE, FTIE,
1802 * RSN IE, TIE, possible resource request) to the supplicant. The FT
1803 * IEs for the next message will be delivered through the
1804 * struct wpa_driver_ops::update_ft_ies() callback.
1810 u8 target_ap[ETH_ALEN];
1811 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
1813 /** Length of ric_ies buffer in octets */
1818 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
1820 struct ibss_rsn_start {
1825 * struct auth_info - Data for EVENT_AUTH events
1836 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
1838 struct assoc_reject {
1840 * resp_ies - (Re)Association Response IEs
1842 * Optional association data from the driver. This data is not
1843 * required WPA, but may be useful for some protocols and as
1844 * such, should be reported if this is available to the driver
1847 * This should start with the first IE (fixed fields before IEs
1848 * are not included).
1853 * resp_ies_len - Length of resp_ies in bytes
1855 size_t resp_ies_len;
1858 * status_code - Status Code from (Re)association Response
1863 struct timeout_event {
1869 * wpa_supplicant_event - Report a driver event for wpa_supplicant
1870 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1871 * with struct wpa_driver_ops::init()
1872 * @event: event type (defined above)
1873 * @data: possible extra data for the event
1875 * Driver wrapper code should call this function whenever an event is received
1878 void wpa_supplicant_event(void *ctx, wpa_event_type event,
1879 union wpa_event_data *data);
1882 * wpa_supplicant_rx_eapol - Deliver a received EAPOL frame to wpa_supplicant
1883 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1884 * with struct wpa_driver_ops::init()
1885 * @src_addr: Source address of the EAPOL frame
1886 * @buf: EAPOL data starting from the EAPOL header (i.e., no Ethernet header)
1887 * @len: Length of the EAPOL data
1889 * This function is called for each received EAPOL frame. Most driver
1890 * interfaces rely on more generic OS mechanism for receiving frames through
1891 * l2_packet, but if such a mechanism is not available, the driver wrapper may
1892 * take care of received EAPOL frames and deliver them to the core supplicant
1893 * code by calling this function.
1895 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
1896 const u8 *buf, size_t len);
1898 void wpa_supplicant_sta_rx(void *ctx, const u8 *buf, size_t len,
1899 struct ieee80211_rx_status *rx_status);
1901 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie);
1902 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
1904 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
1906 int wpa_scan_get_max_rate(const struct wpa_scan_res *res);
1907 void wpa_scan_results_free(struct wpa_scan_results *res);
1908 void wpa_scan_sort_results(struct wpa_scan_results *res);
1910 /* hostapd functions for driver wrappers */
1913 struct ieee80211_hdr;
1915 void hostapd_new_assoc_sta(struct hostapd_data *hapd, struct sta_info *sta,
1917 void hostapd_tx_status(struct hostapd_data *hapd, const u8 *addr,
1918 const u8 *buf, size_t len, int ack);
1919 void hostapd_rx_from_unknown_sta(struct hostapd_data *hapd,
1920 const struct ieee80211_hdr *hdr, size_t len);
1921 int hostapd_notif_new_sta(struct hostapd_data *hapd, const u8 *addr);
1922 int hostapd_notif_assoc(struct hostapd_data *hapd, const u8 *addr,
1923 const u8 *ie, size_t ielen);
1924 void hostapd_notif_disassoc(struct hostapd_data *hapd, const u8 *addr);
1925 void hostapd_eapol_receive(struct hostapd_data *hapd, const u8 *sa,
1926 const u8 *buf, size_t len);
1928 struct hostapd_frame_info {
1934 void hostapd_mgmt_rx(struct hostapd_data *hapd, u8 *buf, size_t len,
1935 u16 stype, struct hostapd_frame_info *fi);
1936 void hostapd_mgmt_tx_cb(struct hostapd_data *hapd, u8 *buf, size_t len,
1938 void hostapd_michael_mic_failure(struct hostapd_data *hapd, const u8 *addr);
1939 struct hostapd_data * hostapd_sta_get_bss(struct hostapd_data *hapd,
1941 void hostapd_probe_req_rx(struct hostapd_data *hapd, const u8 *sa,
1942 const u8 *ie, size_t ie_len);
1943 void hostapd_button_pushed(struct hostapd_data *hapd);
1945 #endif /* DRIVER_H */