2 * Driver interface definition
3 * Copyright (c) 2003-2010, 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.
14 * This file defines a driver interface used by both %wpa_supplicant and
15 * hostapd. The first part of the file defines data structures used in various
16 * driver operations. This is followed by the struct wpa_driver_ops that each
17 * driver wrapper will beed to define with callback functions for requesting
18 * driver operations. After this, there are definitions for driver event
19 * reporting with wpa_supplicant_event() and some convenience helper functions
20 * that can be used to report events.
26 #define WPA_SUPPLICANT_DRIVER_VERSION 4
28 #include "common/defs.h"
30 #define HOSTAPD_CHAN_DISABLED 0x00000001
31 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
32 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
33 #define HOSTAPD_CHAN_RADAR 0x00000008
36 * struct hostapd_channel_data - Channel information
38 struct hostapd_channel_data
{
40 * chan - Channel number (IEEE 802.11)
45 * freq - Frequency in MHz
50 * flag - Channel flags (HOSTAPD_CHAN_*)
55 * max_tx_power - maximum transmit power in dBm
61 * struct hostapd_hw_modes - Supported hardware mode information
63 struct hostapd_hw_modes
{
65 * mode - Hardware mode
67 enum hostapd_hw_mode mode
;
70 * num_channels - Number of entries in the channels array
75 * channels - Array of supported channels
77 struct hostapd_channel_data
*channels
;
80 * num_rates - Number of entries in the rates array
85 * rates - Array of supported rates in 100 kbps units
90 * ht_capab - HT (IEEE 802.11n) capabilities
95 * mcs_set - MCS (IEEE 802.11n) rate parameters
100 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
106 #define IEEE80211_MODE_INFRA 0
107 #define IEEE80211_MODE_IBSS 1
108 #define IEEE80211_MODE_AP 2
110 #define IEEE80211_CAP_ESS 0x0001
111 #define IEEE80211_CAP_IBSS 0x0002
112 #define IEEE80211_CAP_PRIVACY 0x0010
114 #define WPA_SCAN_QUAL_INVALID BIT(0)
115 #define WPA_SCAN_NOISE_INVALID BIT(1)
116 #define WPA_SCAN_LEVEL_INVALID BIT(2)
117 #define WPA_SCAN_LEVEL_DBM BIT(3)
118 #define WPA_SCAN_AUTHENTICATED BIT(4)
119 #define WPA_SCAN_ASSOCIATED BIT(5)
122 * struct wpa_scan_res - Scan result for an BSS/IBSS
123 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
125 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
126 * @beacon_int: beacon interval in TUs (host byte order)
127 * @caps: capability information field in host byte order
128 * @qual: signal quality
129 * @noise: noise level
130 * @level: signal level
132 * @age: Age of the information in milliseconds (i.e., how many milliseconds
133 * ago the last Beacon or Probe Response frame was received)
134 * @ie_len: length of the following IE field in octets
135 * @beacon_ie_len: length of the following Beacon IE field in octets
137 * This structure is used as a generic format for scan results from the
138 * driver. Each driver interface implementation is responsible for converting
139 * the driver or OS specific scan results into this format.
141 * If the driver does not support reporting all IEs, the IE data structure is
142 * constructed of the IEs that are available. This field will also need to
143 * include SSID in IE format. All drivers are encouraged to be extended to
144 * report all IEs to make it easier to support future additions.
146 struct wpa_scan_res
{
158 size_t beacon_ie_len
;
160 * Followed by ie_len octets of IEs from Probe Response frame (or if
161 * the driver does not indicate source of IEs, these may also be from
162 * Beacon frame). After the first set of IEs, another set of IEs may
163 * follow (with beacon_ie_len octets of data) if the driver provides
169 * struct wpa_scan_results - Scan results
170 * @res: Array of pointers to allocated variable length scan result entries
171 * @num: Number of entries in the scan result array
173 struct wpa_scan_results
{
174 struct wpa_scan_res
**res
;
179 * struct wpa_interface_info - Network interface information
180 * @next: Pointer to the next interface or NULL if this is the last one
181 * @ifname: Interface name that can be used with init() or init2()
182 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
184 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
185 * is not an allocated copy, i.e., get_interfaces() caller will not free
188 struct wpa_interface_info
{
189 struct wpa_interface_info
*next
;
192 const char *drv_name
;
195 #define WPAS_MAX_SCAN_SSIDS 4
198 * struct wpa_driver_scan_params - Scan parameters
199 * Data for struct wpa_driver_ops::scan2().
201 struct wpa_driver_scan_params
{
203 * ssids - SSIDs to scan for
205 struct wpa_driver_scan_ssid
{
207 * ssid - specific SSID to scan for (ProbeReq)
208 * %NULL or zero-length SSID is used to indicate active scan
209 * with wildcard SSID.
213 * ssid_len: Length of the SSID in octets
216 } ssids
[WPAS_MAX_SCAN_SSIDS
];
219 * num_ssids - Number of entries in ssids array
220 * Zero indicates a request for a passive scan.
225 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
230 * extra_ies_len - Length of extra_ies in octets
232 size_t extra_ies_len
;
235 * freqs - Array of frequencies to scan or %NULL for all frequencies
237 * The frequency is set in MHz. The array is zero-terminated.
242 * filter_ssids - Filter for reporting SSIDs
244 * This optional parameter can be used to request the driver wrapper to
245 * filter scan results to include only the specified SSIDs. %NULL
246 * indicates that no filtering is to be done. This can be used to
247 * reduce memory needs for scan results in environments that have large
248 * number of APs with different SSIDs.
250 * The driver wrapper is allowed to take this allocated buffer into its
251 * own use by setting the pointer to %NULL. In that case, the driver
252 * wrapper is responsible for freeing the buffer with os_free() once it
253 * is not needed anymore.
255 struct wpa_driver_scan_filter
{
261 * num_filter_ssids - Number of entries in filter_ssids array
263 size_t num_filter_ssids
;
267 * struct wpa_driver_auth_params - Authentication parameters
268 * Data for struct wpa_driver_ops::authenticate().
270 struct wpa_driver_auth_params
{
278 const u8
*wep_key
[4];
279 size_t wep_key_len
[4];
284 * struct wpa_driver_associate_params - Association parameters
285 * Data for struct wpa_driver_ops::associate().
287 struct wpa_driver_associate_params
{
289 * bssid - BSSID of the selected AP
290 * This can be %NULL, if ap_scan=2 mode is used and the driver is
291 * responsible for selecting with which BSS to associate. */
295 * ssid - The selected SSID
300 * ssid_len - Length of the SSID (1..32)
305 * freq - Frequency of the channel the selected AP is using
306 * Frequency that the selected AP is using (in MHz as
307 * reported in the scan results)
312 * wpa_ie - WPA information element for (Re)Association Request
313 * WPA information element to be included in (Re)Association
314 * Request (including information element id and length). Use
315 * of this WPA IE is optional. If the driver generates the WPA
316 * IE, it can use pairwise_suite, group_suite, and
317 * key_mgmt_suite to select proper algorithms. In this case,
318 * the driver has to notify wpa_supplicant about the used WPA
319 * IE by generating an event that the interface code will
320 * convert into EVENT_ASSOCINFO data (see below).
322 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
323 * instead. The driver can determine which version is used by
324 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
327 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
332 * wpa_ie_len - length of the wpa_ie
337 * pairwise_suite - Selected pairwise cipher suite
339 * This is usually ignored if @wpa_ie is used.
341 enum wpa_cipher pairwise_suite
;
344 * group_suite - Selected group cipher suite
346 * This is usually ignored if @wpa_ie is used.
348 enum wpa_cipher group_suite
;
351 * key_mgmt_suite - Selected key management suite
353 * This is usually ignored if @wpa_ie is used.
355 enum wpa_key_mgmt key_mgmt_suite
;
358 * auth_alg - Allowed authentication algorithms
359 * Bit field of WPA_AUTH_ALG_*
364 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
369 * wep_key - WEP keys for static WEP configuration
371 const u8
*wep_key
[4];
374 * wep_key_len - WEP key length for static WEP configuration
376 size_t wep_key_len
[4];
379 * wep_tx_keyidx - WEP TX key index for static WEP configuration
384 * mgmt_frame_protection - IEEE 802.11w management frame protection
386 enum mfp_options mgmt_frame_protection
;
389 * ft_ies - IEEE 802.11r / FT information elements
390 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
391 * for fast transition, this parameter is set to include the IEs that
392 * are to be sent in the next FT Authentication Request message.
393 * update_ft_ies() handler is called to update the IEs for further
394 * FT messages in the sequence.
396 * The driver should use these IEs only if the target AP is advertising
397 * the same mobility domain as the one included in the MDIE here.
399 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
400 * AP after the initial association. These IEs can only be used if the
401 * target AP is advertising support for FT and is using the same MDIE
402 * and SSID as the current AP.
404 * The driver is responsible for reporting the FT IEs received from the
405 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
406 * type. update_ft_ies() handler will then be called with the FT IEs to
407 * include in the next frame in the authentication sequence.
412 * ft_ies_len - Length of ft_ies in bytes
417 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
419 * This value is provided to allow the driver interface easier access
420 * to the current mobility domain. This value is set to %NULL if no
421 * mobility domain is currently active.
426 * passphrase - RSN passphrase for PSK
428 * This value is made available only for WPA/WPA2-Personal (PSK) and
429 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
430 * the 8..63 character ASCII passphrase, if available. Please note that
431 * this can be %NULL if passphrase was not used to generate the PSK. In
432 * that case, the psk field must be used to fetch the PSK.
434 const char *passphrase
;
437 * psk - RSN PSK (alternative for passphrase for PSK)
439 * This value is made available only for WPA/WPA2-Personal (PSK) and
440 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
441 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
442 * be prepared to handle %NULL value as an error.
447 * drop_unencrypted - Enable/disable unencrypted frame filtering
449 * Configure the driver to drop all non-EAPOL frames (both receive and
450 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
451 * still be allowed for key negotiation.
453 int drop_unencrypted
;
456 * prev_bssid - Previously used BSSID in this ESS
458 * When not %NULL, this is a request to use reassociation instead of
461 const u8
*prev_bssid
;
465 * struct wpa_driver_capa - Driver capability information
467 struct wpa_driver_capa
{
468 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
469 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
470 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
471 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
472 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
473 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
474 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
475 unsigned int key_mgmt
;
477 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
478 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
479 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
480 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
483 #define WPA_DRIVER_AUTH_OPEN 0x00000001
484 #define WPA_DRIVER_AUTH_SHARED 0x00000002
485 #define WPA_DRIVER_AUTH_LEAP 0x00000004
488 /* Driver generated WPA/RSN IE */
489 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
490 /* Driver needs static WEP key setup after association command */
491 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
492 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
493 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
494 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
495 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
496 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
497 /* Driver provides separate commands for authentication and association (SME in
498 * wpa_supplicant). */
499 #define WPA_DRIVER_FLAGS_SME 0x00000020
500 /* Driver supports AP mode */
501 #define WPA_DRIVER_FLAGS_AP 0x00000040
502 /* Driver needs static WEP key setup after association has been completed */
503 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
512 struct hostap_sta_driver_data
{
513 unsigned long rx_packets
, tx_packets
, rx_bytes
, tx_bytes
;
514 unsigned long current_tx_rate
;
515 unsigned long inactive_msec
;
517 unsigned long num_ps_buf_frames
;
518 unsigned long tx_retry_failed
;
519 unsigned long tx_retry_count
;
524 struct hostapd_sta_add_params
{
528 const u8
*supp_rates
;
529 size_t supp_rates_len
;
531 const struct ieee80211_ht_capabilities
*ht_capabilities
;
534 struct hostapd_freq_params
{
539 int sec_channel_offset
; /* 0 = HT40 disabled, -1 = HT40 enabled,
540 * secondary channel below primary, 1 = HT40
541 * enabled, secondary channel above primary */
544 enum wpa_driver_if_type
{
546 * WPA_IF_STATION - Station mode interface
551 * WPA_IF_AP_VLAN - AP mode VLAN interface
553 * This interface shares its address and Beacon frame with the main
559 * WPA_IF_AP_BSS - AP mode BSS interface
561 * This interface has its own address and Beacon frame.
566 struct wpa_init_params
{
571 const char *test_socket
;
572 int use_pae_group_addr
;
576 u8
*own_addr
; /* buffer for writing own MAC address */
580 struct wpa_bss_params
{
581 /** Interface name (for multi-SSID/VLAN support) */
583 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
594 #define WPA_STA_AUTHORIZED BIT(0)
595 #define WPA_STA_WMM BIT(1)
596 #define WPA_STA_SHORT_PREAMBLE BIT(2)
597 #define WPA_STA_MFP BIT(3)
600 * struct wpa_driver_ops - Driver interface API definition
602 * This structure defines the API that each driver interface needs to implement
603 * for core wpa_supplicant code. All driver specific functionality is captured
606 struct wpa_driver_ops
{
607 /** Name of the driver interface */
609 /** One line description of the driver interface */
613 * get_bssid - Get the current BSSID
614 * @priv: private driver interface data
615 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
617 * Returns: 0 on success, -1 on failure
619 * Query kernel driver for the current BSSID and copy it to bssid.
620 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
623 int (*get_bssid
)(void *priv
, u8
*bssid
);
626 * get_ssid - Get the current SSID
627 * @priv: private driver interface data
628 * @ssid: buffer for SSID (at least 32 bytes)
630 * Returns: Length of the SSID on success, -1 on failure
632 * Query kernel driver for the current SSID and copy it to ssid.
633 * Returning zero is recommended if the STA is not associated.
635 * Note: SSID is an array of octets, i.e., it is not nul terminated and
636 * can, at least in theory, contain control characters (including nul)
637 * and as such, should be processed as binary data, not a printable
640 int (*get_ssid
)(void *priv
, u8
*ssid
);
643 * set_key - Configure encryption key
644 * @ifname: Interface name (for multi-SSID/VLAN support)
645 * @priv: private driver interface data
646 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
647 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
648 * %WPA_ALG_NONE clears the key.
649 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
650 * broadcast/default keys
651 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
653 * @set_tx: configure this key as the default Tx key (only used when
654 * driver does not support separate unicast/individual key
655 * @seq: sequence number/packet number, seq_len octets, the next
656 * packet number to be used for in replay protection; configured
657 * for Rx keys (in most cases, this is only used with broadcast
658 * keys and set to zero for unicast keys)
659 * @seq_len: length of the seq, depends on the algorithm:
660 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
661 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
663 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
664 * TKIP: 32, CCMP: 16, IGTK: 16)
666 * Returns: 0 on success, -1 on failure
668 * Configure the given key for the kernel driver. If the driver
669 * supports separate individual keys (4 default keys + 1 individual),
670 * addr can be used to determine whether the key is default or
671 * individual. If only 4 keys are supported, the default key with key
672 * index 0 is used as the individual key. STA must be configured to use
673 * it as the default Tx key (set_tx is set) and accept Rx for all the
674 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
675 * broadcast keys, so key index 0 is available for this kind of
678 * Please note that TKIP keys include separate TX and RX MIC keys and
679 * some drivers may expect them in different order than wpa_supplicant
680 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
681 * will tricker Michael MIC errors. This can be fixed by changing the
682 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
683 * in driver_*.c set_key() implementation, see driver_ndis.c for an
684 * example on how this can be done.
686 int (*set_key
)(const char *ifname
, void *priv
, enum wpa_alg alg
,
687 const u8
*addr
, int key_idx
, int set_tx
,
688 const u8
*seq
, size_t seq_len
,
689 const u8
*key
, size_t key_len
);
692 * init - Initialize driver interface
693 * @ctx: context to be used when calling wpa_supplicant functions,
694 * e.g., wpa_supplicant_event()
695 * @ifname: interface name, e.g., wlan0
697 * Returns: Pointer to private data, %NULL on failure
699 * Initialize driver interface, including event processing for kernel
700 * driver events (e.g., associated, scan results, Michael MIC failure).
701 * This function can allocate a private configuration data area for
702 * @ctx, file descriptor, interface name, etc. information that may be
703 * needed in future driver operations. If this is not used, non-NULL
704 * value will need to be returned because %NULL is used to indicate
705 * failure. The returned value will be used as 'void *priv' data for
706 * all other driver_ops functions.
708 * The main event loop (eloop.c) of wpa_supplicant can be used to
709 * register callback for read sockets (eloop_register_read_sock()).
711 * See below for more information about events and
712 * wpa_supplicant_event() function.
714 void * (*init
)(void *ctx
, const char *ifname
);
717 * deinit - Deinitialize driver interface
718 * @priv: private driver interface data from init()
720 * Shut down driver interface and processing of driver events. Free
721 * private data buffer if one was allocated in init() handler.
723 void (*deinit
)(void *priv
);
726 * set_param - Set driver configuration parameters
727 * @priv: private driver interface data from init()
728 * @param: driver specific configuration parameters
730 * Returns: 0 on success, -1 on failure
732 * Optional handler for notifying driver interface about configuration
733 * parameters (driver_param).
735 int (*set_param
)(void *priv
, const char *param
);
738 * set_countermeasures - Enable/disable TKIP countermeasures
739 * @priv: private driver interface data
740 * @enabled: 1 = countermeasures enabled, 0 = disabled
742 * Returns: 0 on success, -1 on failure
744 * Configure TKIP countermeasures. When these are enabled, the driver
745 * should drop all received and queued frames that are using TKIP.
747 int (*set_countermeasures
)(void *priv
, int enabled
);
750 * deauthenticate - Request driver to deauthenticate
751 * @priv: private driver interface data
752 * @addr: peer address (BSSID of the AP)
753 * @reason_code: 16-bit reason code to be sent in the deauthentication
756 * Returns: 0 on success, -1 on failure
758 int (*deauthenticate
)(void *priv
, const u8
*addr
, int reason_code
);
761 * disassociate - Request driver to disassociate
762 * @priv: private driver interface data
763 * @addr: peer address (BSSID of the AP)
764 * @reason_code: 16-bit reason code to be sent in the disassociation
767 * Returns: 0 on success, -1 on failure
769 int (*disassociate
)(void *priv
, const u8
*addr
, int reason_code
);
772 * associate - Request driver to associate
773 * @priv: private driver interface data
774 * @params: association parameters
776 * Returns: 0 on success, -1 on failure
778 int (*associate
)(void *priv
,
779 struct wpa_driver_associate_params
*params
);
782 * add_pmkid - Add PMKSA cache entry to the driver
783 * @priv: private driver interface data
784 * @bssid: BSSID for the PMKSA cache entry
785 * @pmkid: PMKID for the PMKSA cache entry
787 * Returns: 0 on success, -1 on failure
789 * This function is called when a new PMK is received, as a result of
790 * either normal authentication or RSN pre-authentication.
792 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
793 * associate(), add_pmkid() can be used to add new PMKSA cache entries
794 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
795 * driver_ops function does not need to be implemented. Likewise, if
796 * the driver does not support WPA, this function is not needed.
798 int (*add_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
801 * remove_pmkid - Remove PMKSA cache entry to the driver
802 * @priv: private driver interface data
803 * @bssid: BSSID for the PMKSA cache entry
804 * @pmkid: PMKID for the PMKSA cache entry
806 * Returns: 0 on success, -1 on failure
808 * This function is called when the supplicant drops a PMKSA cache
809 * entry for any reason.
811 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
812 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
813 * between the driver and wpa_supplicant. If the driver uses wpa_ie
814 * from wpa_supplicant, this driver_ops function does not need to be
815 * implemented. Likewise, if the driver does not support WPA, this
816 * function is not needed.
818 int (*remove_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
821 * flush_pmkid - Flush PMKSA cache
822 * @priv: private driver interface data
824 * Returns: 0 on success, -1 on failure
826 * This function is called when the supplicant drops all PMKSA cache
827 * entries for any reason.
829 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
830 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
831 * between the driver and wpa_supplicant. If the driver uses wpa_ie
832 * from wpa_supplicant, this driver_ops function does not need to be
833 * implemented. Likewise, if the driver does not support WPA, this
834 * function is not needed.
836 int (*flush_pmkid
)(void *priv
);
839 * get_capa - Get driver capabilities
840 * @priv: private driver interface data
842 * Returns: 0 on success, -1 on failure
844 * Get driver/firmware/hardware capabilities.
846 int (*get_capa
)(void *priv
, struct wpa_driver_capa
*capa
);
849 * poll - Poll driver for association information
850 * @priv: private driver interface data
852 * This is an option callback that can be used when the driver does not
853 * provide event mechanism for association events. This is called when
854 * receiving WPA EAPOL-Key messages that require association
855 * information. The driver interface is supposed to generate associnfo
856 * event before returning from this callback function. In addition, the
857 * driver interface should generate an association event after having
858 * sent out associnfo.
860 void (*poll
)(void *priv
);
863 * get_ifname - Get interface name
864 * @priv: private driver interface data
866 * Returns: Pointer to the interface name. This can differ from the
867 * interface name used in init() call. Init() is called first.
869 * This optional function can be used to allow the driver interface to
870 * replace the interface name with something else, e.g., based on an
871 * interface mapping from a more descriptive name.
873 const char * (*get_ifname
)(void *priv
);
876 * get_mac_addr - Get own MAC address
877 * @priv: private driver interface data
879 * Returns: Pointer to own MAC address or %NULL on failure
881 * This optional function can be used to get the own MAC address of the
882 * device from the driver interface code. This is only needed if the
883 * l2_packet implementation for the OS does not provide easy access to
885 const u8
* (*get_mac_addr
)(void *priv
);
888 * send_eapol - Optional function for sending EAPOL packets
889 * @priv: private driver interface data
890 * @dest: Destination MAC address
892 * @data: EAPOL packet starting with IEEE 802.1X header
893 * @data_len: Size of the EAPOL packet
895 * Returns: 0 on success, -1 on failure
897 * This optional function can be used to override l2_packet operations
898 * with driver specific functionality. If this function pointer is set,
899 * l2_packet module is not used at all and the driver interface code is
900 * responsible for receiving and sending all EAPOL packets. The
901 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX
902 * event. The driver interface is required to implement get_mac_addr()
903 * handler if send_eapol() is used.
905 int (*send_eapol
)(void *priv
, const u8
*dest
, u16 proto
,
906 const u8
*data
, size_t data_len
);
909 * set_operstate - Sets device operating state to DORMANT or UP
910 * @priv: private driver interface data
911 * @state: 0 = dormant, 1 = up
912 * Returns: 0 on success, -1 on failure
914 * This is an optional function that can be used on operating systems
915 * that support a concept of controlling network device state from user
916 * space applications. This function, if set, gets called with
917 * state = 1 when authentication has been completed and with state = 0
918 * when connection is lost.
920 int (*set_operstate
)(void *priv
, int state
);
923 * mlme_setprotection - MLME-SETPROTECTION.request primitive
924 * @priv: Private driver interface data
925 * @addr: Address of the station for which to set protection (may be
926 * %NULL for group keys)
927 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
928 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
929 * Returns: 0 on success, -1 on failure
931 * This is an optional function that can be used to set the driver to
932 * require protection for Tx and/or Rx frames. This uses the layer
933 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
934 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
935 * set protection operation; instead, they set protection implicitly
936 * based on configured keys.
938 int (*mlme_setprotection
)(void *priv
, const u8
*addr
, int protect_type
,
942 * get_hw_feature_data - Get hardware support data (channels and rates)
943 * @priv: Private driver interface data
944 * @num_modes: Variable for returning the number of returned modes
945 * flags: Variable for returning hardware feature flags
946 * Returns: Pointer to allocated hardware data on success or %NULL on
947 * failure. Caller is responsible for freeing this.
949 * This function is only needed for drivers that export MLME
950 * (management frame processing) to %wpa_supplicant or hostapd.
952 struct hostapd_hw_modes
* (*get_hw_feature_data
)(void *priv
,
957 * set_channel - Set channel
958 * @priv: Private driver interface data
959 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
960 * @chan: IEEE 802.11 channel number
961 * @freq: Frequency of the channel in MHz
962 * Returns: 0 on success, -1 on failure
964 * This function is only needed for drivers that export MLME
965 * (management frame processing) to wpa_supplicant.
967 int (*set_channel
)(void *priv
, enum hostapd_hw_mode phymode
, int chan
,
971 * set_ssid - Set SSID
972 * @priv: Private driver interface data
974 * @ssid_len: SSID length
975 * Returns: 0 on success, -1 on failure
977 * This function is only needed for drivers that export MLME
978 * (management frame processing) to wpa_supplicant.
980 int (*set_ssid
)(void *priv
, const u8
*ssid
, size_t ssid_len
);
983 * set_bssid - Set BSSID
984 * @priv: Private driver interface data
986 * Returns: 0 on success, -1 on failure
988 * This function is only needed for drivers that export MLME
989 * (management frame processing) to wpa_supplicant.
991 int (*set_bssid
)(void *priv
, const u8
*bssid
);
994 * send_mlme - Send management frame from MLME
995 * @priv: Private driver interface data
996 * @data: IEEE 802.11 management frame with IEEE 802.11 header
997 * @data_len: Size of the management frame
998 * Returns: 0 on success, -1 on failure
1000 * This function is only needed for drivers that export MLME
1001 * (management frame processing) to wpa_supplicant.
1003 int (*send_mlme
)(void *priv
, const u8
*data
, size_t data_len
);
1006 * mlme_add_sta - Add a STA entry into the driver/netstack
1007 * @priv: Private driver interface data
1008 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1009 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
1010 * format (one octet per rate, 1 = 0.5 Mbps)
1011 * @supp_rates_len: Number of entries in supp_rates
1012 * Returns: 0 on success, -1 on failure
1014 * This function is only needed for drivers that export MLME
1015 * (management frame processing) to wpa_supplicant. When the MLME code
1016 * completes association with an AP, this function is called to
1017 * configure the driver/netstack with a STA entry for data frame
1018 * processing (TX rate control, encryption/decryption).
1020 int (*mlme_add_sta
)(void *priv
, const u8
*addr
, const u8
*supp_rates
,
1021 size_t supp_rates_len
);
1024 * mlme_remove_sta - Remove a STA entry from the driver/netstack
1025 * @priv: Private driver interface data
1026 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1027 * Returns: 0 on success, -1 on failure
1029 * This function is only needed for drivers that export MLME
1030 * (management frame processing) to wpa_supplicant.
1032 int (*mlme_remove_sta
)(void *priv
, const u8
*addr
);
1035 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1036 * @priv: Private driver interface data
1037 * @md: Mobility domain (2 octets) (also included inside ies)
1038 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1039 * @ies_len: Length of FT IEs in bytes
1040 * Returns: 0 on success, -1 on failure
1042 * The supplicant uses this callback to let the driver know that keying
1043 * material for FT is available and that the driver can use the
1044 * provided IEs in the next message in FT authentication sequence.
1046 * This function is only needed for driver that support IEEE 802.11r
1047 * (Fast BSS Transition).
1049 int (*update_ft_ies
)(void *priv
, const u8
*md
, const u8
*ies
,
1053 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1054 * @priv: Private driver interface data
1055 * @action: Action field value
1056 * @target_ap: Target AP address
1057 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1058 * @ies_len: Length of FT IEs in bytes
1059 * Returns: 0 on success, -1 on failure
1061 * The supplicant uses this callback to request the driver to transmit
1062 * an FT Action frame (action category 6) for over-the-DS fast BSS
1065 int (*send_ft_action
)(void *priv
, u8 action
, const u8
*target_ap
,
1066 const u8
*ies
, size_t ies_len
);
1069 * get_scan_results2 - Fetch the latest scan results
1070 * @priv: private driver interface data
1072 * Returns: Allocated buffer of scan results (caller is responsible for
1073 * freeing the data structure) on success, NULL on failure
1075 struct wpa_scan_results
* (*get_scan_results2
)(void *priv
);
1078 * set_country - Set country
1079 * @priv: Private driver interface data
1080 * @alpha2: country to which to switch to
1081 * Returns: 0 on success, -1 on failure
1083 * This function is for drivers which support some form
1084 * of setting a regulatory domain.
1086 int (*set_country
)(void *priv
, const char *alpha2
);
1089 * global_init - Global driver initialization
1090 * Returns: Pointer to private data (global), %NULL on failure
1092 * This optional function is called to initialize the driver wrapper
1093 * for global data, i.e., data that applies to all interfaces. If this
1094 * function is implemented, global_deinit() will also need to be
1095 * implemented to free the private data. The driver will also likely
1096 * use init2() function instead of init() to get the pointer to global
1097 * data available to per-interface initializer.
1099 void * (*global_init
)(void);
1102 * global_deinit - Global driver deinitialization
1103 * @priv: private driver global data from global_init()
1105 * Terminate any global driver related functionality and free the
1106 * global data structure.
1108 void (*global_deinit
)(void *priv
);
1111 * init2 - Initialize driver interface (with global data)
1112 * @ctx: context to be used when calling wpa_supplicant functions,
1113 * e.g., wpa_supplicant_event()
1114 * @ifname: interface name, e.g., wlan0
1115 * @global_priv: private driver global data from global_init()
1116 * Returns: Pointer to private data, %NULL on failure
1118 * This function can be used instead of init() if the driver wrapper
1121 void * (*init2
)(void *ctx
, const char *ifname
, void *global_priv
);
1124 * get_interfaces - Get information about available interfaces
1125 * @global_priv: private driver global data from global_init()
1126 * Returns: Allocated buffer of interface information (caller is
1127 * responsible for freeing the data structure) on success, NULL on
1130 struct wpa_interface_info
* (*get_interfaces
)(void *global_priv
);
1133 * scan2 - Request the driver to initiate scan
1134 * @priv: private driver interface data
1135 * @params: Scan parameters
1137 * Returns: 0 on success, -1 on failure
1139 * Once the scan results are ready, the driver should report scan
1140 * results event for wpa_supplicant which will eventually request the
1141 * results with wpa_driver_get_scan_results2().
1143 int (*scan2
)(void *priv
, struct wpa_driver_scan_params
*params
);
1146 * authenticate - Request driver to authenticate
1147 * @priv: private driver interface data
1148 * @params: authentication parameters
1149 * Returns: 0 on success, -1 on failure
1151 * This is an optional function that can be used with drivers that
1152 * support separate authentication and association steps, i.e., when
1153 * wpa_supplicant can act as the SME. If not implemented, associate()
1154 * function is expected to take care of IEEE 802.11 authentication,
1157 int (*authenticate
)(void *priv
,
1158 struct wpa_driver_auth_params
*params
);
1161 * set_beacon - Set Beacon frame template
1162 * @priv: Private driver interface data
1163 * @head: Beacon head from IEEE 802.11 header to IEs before TIM IE
1164 * @head_len: Length of the head buffer in octets
1165 * @tail: Beacon tail following TIM IE
1166 * @tail_len: Length of the tail buffer in octets
1167 * @dtim_period: DTIM period
1168 * @beacon_int: Beacon interval
1169 * Returns: 0 on success, -1 on failure
1171 * This function is used to configure Beacon template for the driver in
1172 * AP mode. The driver is responsible for building the full Beacon
1173 * frame by concatenating the head part with TIM IE generated by the
1174 * driver/firmware and finishing with the tail part.
1176 int (*set_beacon
)(void *priv
, const u8
*head
, size_t head_len
,
1177 const u8
*tail
, size_t tail_len
, int dtim_period
,
1181 * hapd_init - Initialize driver interface (hostapd only)
1182 * @hapd: Pointer to hostapd context
1183 * @params: Configuration for the driver wrapper
1184 * Returns: Pointer to private data, %NULL on failure
1186 * This function is used instead of init() or init2() when the driver
1187 * wrapper is used withh hostapd.
1189 void * (*hapd_init
)(struct hostapd_data
*hapd
,
1190 struct wpa_init_params
*params
);
1193 * hapd_deinit - Deinitialize driver interface (hostapd only)
1194 * @priv: Private driver interface data from hapd_init()
1196 void (*hapd_deinit
)(void *priv
);
1199 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
1200 * @priv: Private driver interface data
1201 * @params: BSS parameters
1202 * Returns: 0 on success, -1 on failure
1204 * This is an optional function to configure the kernel driver to
1205 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
1206 * can be left undefined (set to %NULL) if IEEE 802.1X support is
1207 * always enabled and the driver uses set_beacon() to set WPA/RSN IE
1208 * for Beacon frames.
1210 int (*set_ieee8021x
)(void *priv
, struct wpa_bss_params
*params
);
1213 * set_privacy - Enable/disable privacy (AP only)
1214 * @priv: Private driver interface data
1215 * @enabled: 1 = privacy enabled, 0 = disabled
1216 * Returns: 0 on success, -1 on failure
1218 * This is an optional function to configure privacy field in the
1219 * kernel driver for Beacon frames. This can be left undefined (set to
1220 * %NULL) if the driver uses the Beacon template from set_beacon().
1222 int (*set_privacy
)(const char *ifname
, void *priv
, int enabled
);
1225 * get_seqnum - Fetch the current TSC/packet number (AP only)
1226 * @ifname: The interface name (main or virtual)
1227 * @priv: Private driver interface data
1228 * @addr: MAC address of the station or %NULL for group keys
1230 * @seq: Buffer for returning the latest used TSC/packet number
1231 * Returns: 0 on success, -1 on failure
1233 * This function is used to fetch the last used TSC/packet number for
1234 * a TKIP, CCMP, or BIP/IGTK key. It is mainly used with group keys, so
1235 * there is no strict requirement on implementing support for unicast
1236 * keys (i.e., addr != %NULL).
1238 int (*get_seqnum
)(const char *ifname
, void *priv
, const u8
*addr
,
1242 * flush - Flush all association stations (AP only)
1243 * @priv: Private driver interface data
1244 * Returns: 0 on success, -1 on failure
1246 * This function requests the driver to disassociate all associated
1247 * stations. This function does not need to be implemented if the
1248 * driver does not process association frames internally.
1250 int (*flush
)(void *priv
);
1253 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
1254 * @ifname: The interface name (main or virtual BSS)
1255 * @priv: Private driver interface data
1256 * @elem: Information elements
1257 * @elem_len: Length of the elem buffer in octets
1258 * Returns: 0 on success, -1 on failure
1260 * This is an optional function to add information elements in the
1261 * kernel driver for Beacon and Probe Response frames. This can be left
1262 * undefined (set to %NULL) if the driver uses the Beacon template from
1265 int (*set_generic_elem
)(const char *ifname
, void *priv
, const u8
*elem
,
1269 * read_sta_data - Fetch station data (AP only)
1270 * @priv: Private driver interface data
1271 * @data: Buffer for returning station information
1272 * @addr: MAC address of the station
1273 * Returns: 0 on success, -1 on failure
1275 int (*read_sta_data
)(void *priv
, struct hostap_sta_driver_data
*data
,
1279 * hapd_send_eapol - Send an EAPOL packet (AP only)
1280 * @priv: private driver interface data
1281 * @addr: Destination MAC address
1282 * @data: EAPOL packet starting with IEEE 802.1X header
1283 * @data_len: Length of the EAPOL packet in octets
1284 * @encrypt: Whether the frame should be encrypted
1285 * @own_addr: Source MAC address
1287 * Returns: 0 on success, -1 on failure
1289 int (*hapd_send_eapol
)(void *priv
, const u8
*addr
, const u8
*data
,
1290 size_t data_len
, int encrypt
,
1291 const u8
*own_addr
);
1294 * sta_deauth - Deauthenticate a station (AP only)
1295 * @priv: Private driver interface data
1296 * @own_addr: Source address and BSSID for the Deauthentication frame
1297 * @addr: MAC address of the station to deauthenticate
1298 * @reason: Reason code for the Deauthentiation frame
1299 * Returns: 0 on success, -1 on failure
1301 * This function requests a specific station to be deauthenticated and
1302 * a Deauthentication frame to be sent to it.
1304 int (*sta_deauth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
1308 * sta_disassoc - Disassociate a station (AP only)
1309 * @priv: Private driver interface data
1310 * @own_addr: Source address and BSSID for the Disassociation frame
1311 * @addr: MAC address of the station to disassociate
1312 * @reason: Reason code for the Disassociation frame
1313 * Returns: 0 on success, -1 on failure
1315 * This function requests a specific station to be disassociated and
1316 * a Disassociation frame to be sent to it.
1318 int (*sta_disassoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
1322 * sta_remove - Remove a station entry (AP only)
1323 * @priv: Private driver interface data
1324 * @addr: MAC address of the station to be removed
1325 * Returns: 0 on success, -1 on failure
1327 int (*sta_remove
)(void *priv
, const u8
*addr
);
1330 * hapd_get_ssid - Get the current SSID (AP only)
1331 * @ifname: Interface (master or virtual BSS)
1332 * @priv: Private driver interface data
1333 * @buf: Buffer for returning the SSID
1334 * @len: Maximum length of the buffer
1335 * Returns: Length of the SSID on success, -1 on failure
1337 * This function need not be implemented if the driver uses Beacon
1338 * template from set_beacon() and does not reply to Probe Request
1341 int (*hapd_get_ssid
)(const char *ifname
, void *priv
, u8
*buf
, int len
);
1344 * hapd_set_ssid - Set SSID (AP only)
1345 * @ifname: Interface (master or virtual BSS)
1346 * @priv: Private driver interface data
1348 * @len: Length of the SSID in octets
1349 * Returns: 0 on success, -1 on failure
1351 int (*hapd_set_ssid
)(const char *ifname
, void *priv
, const u8
*buf
,
1354 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
1355 * @priv: Private driver interface data
1356 * @enabled: 1 = countermeasures enabled, 0 = disabled
1357 * Returns: 0 on success, -1 on failure
1359 * This need not be implemented if the driver does not take care of
1360 * association processing.
1362 int (*hapd_set_countermeasures
)(void *priv
, int enabled
);
1365 * sta_add - Add a station entry
1366 * @ifname: Interface (master or virtual)
1367 * @priv: Private driver interface data
1368 * @params: Station parameters
1369 * Returns: 0 on success, -1 on failure
1371 * This function is used to add a station entry to the driver once the
1372 * station has completed association. This is only used if the driver
1373 * does not take care of association processing.
1375 int (*sta_add
)(const char *ifname
, void *priv
,
1376 struct hostapd_sta_add_params
*params
);
1379 * get_inact_sec - Get station inactivity duration (AP only)
1380 * @priv: Private driver interface data
1381 * @addr: Station address
1382 * Returns: Number of seconds station has been inactive, -1 on failure
1384 int (*get_inact_sec
)(void *priv
, const u8
*addr
);
1387 * sta_clear_stats - Clear station statistics (AP only)
1388 * @priv: Private driver interface data
1389 * @addr: Station address
1390 * Returns: 0 on success, -1 on failure
1392 int (*sta_clear_stats
)(void *priv
, const u8
*addr
);
1395 * set_freq - Set channel/frequency (AP only)
1396 * @priv: Private driver interface data
1397 * @freq: Channel parameters
1398 * Returns: 0 on success, -1 on failure
1400 int (*set_freq
)(void *priv
, struct hostapd_freq_params
*freq
);
1403 * set_rts - Set RTS threshold
1404 * @priv: Private driver interface data
1405 * @rts: RTS threshold in octets
1406 * Returns: 0 on success, -1 on failure
1408 int (*set_rts
)(void *priv
, int rts
);
1411 * set_frag - Set fragmentation threshold
1412 * @priv: Private driver interface data
1413 * @frag: Fragmentation threshold in octets
1414 * Returns: 0 on success, -1 on failure
1416 int (*set_frag
)(void *priv
, int frag
);
1419 * sta_set_flags - Set station flags (AP only)
1420 * @ifname: Interface name (for multi-SSID/VLAN support)
1421 * @priv: Private driver interface data
1422 * @addr: Station address
1423 * @total_flags: Bitmap of all WPA_STA_* flags currently set
1424 * @flags_or: Bitmap of WPA_STA_* flags to add
1425 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
1426 * Returns: 0 on success, -1 on failure
1428 int (*sta_set_flags
)(const char *ifname
, void *priv
, const u8
*addr
,
1429 int total_flags
, int flags_or
, int flags_and
);
1432 * set_rate_sets - Set supported and basic rate sets (AP only)
1433 * @priv: Private driver interface data
1434 * @supp_rates: -1 terminated array of supported rates in 100 kbps
1435 * @basic_rates: -1 terminated array of basic rates in 100 kbps
1436 * @mode: hardware mode (HOSTAPD_MODE_*)
1437 * Returns: 0 on success, -1 on failure
1439 int (*set_rate_sets
)(void *priv
, int *supp_rates
, int *basic_rates
,
1443 * set_cts_protect - Set CTS protection mode (AP only)
1444 * @priv: Private driver interface data
1445 * @value: Whether CTS protection is enabled
1446 * Returns: 0 on success, -1 on failure
1448 int (*set_cts_protect
)(void *priv
, int value
);
1451 * set_preamble - Set preamble mode (AP only)
1452 * @priv: Private driver interface data
1453 * @value: Whether short preamble is enabled
1454 * Returns: 0 on success, -1 on failure
1456 int (*set_preamble
)(void *priv
, int value
);
1459 * set_short_slot_time - Set short slot time (AP only)
1460 * @priv: Private driver interface data
1461 * @value: Whether short slot time is enabled
1462 * Returns: 0 on success, -1 on failure
1464 int (*set_short_slot_time
)(void *priv
, int value
);
1467 * set_tx_queue_params - Set TX queue parameters
1468 * @priv: Private driver interface data
1469 * @queue: Queue number
1473 * @burst_time: Maximum length for bursting in 0.1 msec units
1475 int (*set_tx_queue_params
)(void *priv
, int queue
, int aifs
, int cw_min
,
1476 int cw_max
, int burst_time
);
1479 * valid_bss_mask - Validate BSSID mask
1480 * @priv: Private driver interface data
1483 * Returns: 0 if mask is valid, -1 if mask is not valid, 1 if mask can
1484 * be used, but the main interface address must be the first address in
1485 * the block if mask is applied
1487 int (*valid_bss_mask
)(void *priv
, const u8
*addr
, const u8
*mask
);
1490 * if_add - Add a virtual interface
1491 * @priv: Private driver interface data
1492 * @type: Interface type
1493 * @ifname: Interface name for the new virtual interface
1494 * @addr: Local address to use for the interface or %NULL to use the
1495 * parent interface address
1496 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
1497 * @drv_priv: Pointer for overwriting the driver context or %NULL if
1498 * not allowed (applies only to %WPA_IF_AP_BSS type)
1499 * Returns: 0 on success, -1 on failure
1501 int (*if_add
)(void *priv
, enum wpa_driver_if_type type
,
1502 const char *ifname
, const u8
*addr
, void *bss_ctx
,
1506 * if_remove - Remove a virtual interface
1507 * @priv: Private driver interface data
1508 * @type: Interface type
1509 * @ifname: Interface name of the virtual interface to be removed
1510 * Returns: 0 on success, -1 on failure
1512 int (*if_remove
)(void *priv
, enum wpa_driver_if_type type
,
1513 const char *ifname
);
1516 * set_sta_vlan - Bind a station into a specific interface (AP only)
1517 * @priv: Private driver interface data
1518 * @ifname: Interface (main or virtual BSS or VLAN)
1519 * @addr: MAC address of the associated station
1521 * Returns: 0 on success, -1 on failure
1523 * This function is used to bind a station to a specific virtual
1524 * interface. It is only used if when virtual interfaces are supported,
1525 * e.g., to assign stations to different VLAN interfaces based on
1526 * information from a RADIUS server. This allows separate broadcast
1527 * domains to be used with a single BSS.
1529 int (*set_sta_vlan
)(void *priv
, const u8
*addr
, const char *ifname
,
1533 * commit - Optional commit changes handler (AP only)
1534 * @priv: driver private data
1535 * Returns: 0 on success, -1 on failure
1537 * This optional handler function can be registered if the driver
1538 * interface implementation needs to commit changes (e.g., by setting
1539 * network interface up) at the end of initial configuration. If set,
1540 * this handler will be called after initial setup has been completed.
1542 int (*commit
)(void *priv
);
1545 * send_ether - Send an ethernet packet (AP only)
1546 * @priv: private driver interface data
1547 * @dst: Destination MAC address
1548 * @src: Source MAC address
1550 * @data: EAPOL packet starting with IEEE 802.1X header
1551 * @data_len: Length of the EAPOL packet in octets
1552 * Returns: 0 on success, -1 on failure
1554 int (*send_ether
)(void *priv
, const u8
*dst
, const u8
*src
, u16 proto
,
1555 const u8
*data
, size_t data_len
);
1558 * set_radius_acl_auth - Notification of RADIUS ACL change
1559 * @priv: Private driver interface data
1560 * @mac: MAC address of the station
1561 * @accepted: Whether the station was accepted
1562 * @session_timeout: Session timeout for the station
1563 * Returns: 0 on success, -1 on failure
1565 int (*set_radius_acl_auth
)(void *priv
, const u8
*mac
, int accepted
,
1566 u32 session_timeout
);
1569 * set_radius_acl_expire - Notification of RADIUS ACL expiration
1570 * @priv: Private driver interface data
1571 * @mac: MAC address of the station
1572 * Returns: 0 on success, -1 on failure
1574 int (*set_radius_acl_expire
)(void *priv
, const u8
*mac
);
1577 * set_ht_params - Set HT parameters (AP only)
1578 * @ifname: The interface name (main or virtual BSS)
1579 * @priv: Private driver interface data
1580 * @ht_capab: HT Capabilities IE
1581 * @ht_capab_len: Length of ht_capab in octets
1582 * @ht_oper: HT Operation IE
1583 * @ht_oper_len: Length of ht_oper in octets
1584 * Returns: 0 on success, -1 on failure
1586 int (*set_ht_params
)(const char *ifname
, void *priv
,
1587 const u8
*ht_capab
, size_t ht_capab_len
,
1588 const u8
*ht_oper
, size_t ht_oper_len
);
1591 * set_ap_wps_ie - Add WPS IE into Beacon/Probe Response frames (AP)
1592 * @ifname: The interface name (main or virtual BSS)
1593 * @priv: Private driver interface data
1594 * @beacon: WPS IE for Beacon frames
1595 * @proberesp: WPS IE for Probe Response frames
1596 * Returns: 0 on success, -1 on failure
1598 * This is an optional function to add WPS IE in the kernel driver for
1599 * Beacon and Probe Response frames. This can be left undefined (set
1600 * to %NULL) if the driver uses the Beacon template from set_beacon()
1601 * and does not process Probe Request frames.
1603 int (*set_ap_wps_ie
)(const char *ifname
, void *priv
,
1604 const struct wpabuf
*beacon
,
1605 const struct wpabuf
*proberesp
);
1608 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1609 * @priv: Private driver interface data
1610 * @authorized: Whether the port is authorized
1611 * Returns: 0 on success, -1 on failure
1613 int (*set_supp_port
)(void *priv
, int authorized
);
1616 * set_wds_sta - Bind a station into a 4-address WDS (AP only)
1617 * @priv: Private driver interface data
1618 * @addr: MAC address of the associated station
1619 * @aid: Association ID
1620 * @val: 1 = bind to 4-address WDS; 0 = unbind
1621 * Returns: 0 on success, -1 on failure
1623 int (*set_wds_sta
)(void *priv
, const u8
*addr
, int aid
, int val
);
1626 * send_action - Transmit an Action frame
1627 * @priv: Private driver interface data
1628 * @freq: Frequency (in MHz) of the channel
1629 * @dst: Destination MAC address (Address 1)
1630 * @src: Source MAC address (Address 2)
1631 * @bssid: BSSID (Address 3)
1633 * @data_len: data length in octets
1634 * Returns: 0 on success, -1 on failure
1636 * This command can be used to request the driver to transmit an action
1637 * frame to the specified destination. If a remain-on-channel duration
1638 * is in progress, the frame is transmitted on that channel. Otherwise,
1639 * the frame is transmitted on the current operational channel if in
1640 * associated state in station mode or if operating as an AP. If none
1641 * of these conditions is in effect, send_action() cannot be used.
1643 int (*send_action
)(void *priv
, unsigned int freq
,
1644 const u8
*dst
, const u8
*src
, const u8
*bssid
,
1645 const u8
*data
, size_t data_len
);
1648 * alloc_interface_addr - Allocate a virtual interface address
1649 * @priv: Private driver interface data
1650 * @addr: Buffer for returning the address
1651 * @ifname: Buffer for returning interface name (if needed)
1652 * Returns: 0 on success, -1 on failure
1654 * This command pre-allocates an interface address for a new virtual
1655 * interface. This can be used before creating a virtual interface if
1656 * the interface mode (e.g., AP vs. station) is not yet known, but the
1657 * address of the virtual interface is already needed. This helps with
1658 * drivers that cannot change interface mode without destroying and
1659 * re-creating the interface. If the driver requires a specific
1660 * interface name to be used, the ifname buffer (up to IFNAMSIZ
1661 * characters) will be used to indicate which name must be used for
1662 * this virtual interface.
1664 * The allocated address can be used in a if_add() call to request a
1667 int (*alloc_interface_addr
)(void *priv
, u8
*addr
, char *ifname
);
1670 * release_interface_addr - Release a virtual interface address
1671 * @priv: Private driver interface data
1672 * @addr: Address to be freed from alloc_interface_addr()
1674 * This command is used to release a virtual interface address that was
1675 * allocated with alloc_interface_addr(), but has not yet been used
1676 * with if_add() to actually create the interface. This allows the
1677 * driver to release the pending allocation for a new interface.
1679 void (*release_interface_addr
)(void *priv
, const u8
*addr
);
1682 * remain_on_channel - Remain awake on a channel
1683 * @priv: Private driver interface data
1684 * @freq: Frequency (in MHz) of the channel
1685 * @duration: Duration in milliseconds
1686 * Returns: 0 on success, -1 on failure
1688 * This command is used to request the driver to remain awake on the
1689 * specified channel for the specified duration and report received
1690 * Action frames with EVENT_RX_ACTION events. Optionally, received
1691 * Probe Request frames may also be requested to be reported by calling
1692 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
1694 * The driver may not be at the requested channel when this function
1695 * returns, i.e., the return code is only indicating whether the
1696 * request was accepted. The caller will need to wait until the
1697 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
1698 * completed the channel change. This may take some time due to other
1699 * need for the radio and the caller should be prepared to timing out
1700 * its wait since there are no guarantees on when this request can be
1703 int (*remain_on_channel
)(void *priv
, unsigned int freq
,
1704 unsigned int duration
);
1707 * cancel_remain_on_channel - Cancel remain-on-channel operation
1708 * @priv: Private driver interface data
1710 * This command can be used to cancel a remain-on-channel operation
1711 * before its originally requested duration has passed. This could be
1712 * used, e.g., when remain_on_channel() is used to request extra time
1713 * to receive a response to an Action frame and the response is
1714 * received when there is still unneeded time remaining on the
1715 * remain-on-channel operation.
1717 int (*cancel_remain_on_channel
)(void *priv
);
1720 * probe_req_report - Request Probe Request frames to be indicated
1721 * @priv: Private driver interface data
1722 * @report: Whether to report received Probe Request frames
1723 * Returns: 0 on success, -1 on failure (or if not supported)
1725 * This command can be used to request the driver to indicate when
1726 * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
1727 * Since this operation may require extra resources, e.g., due to less
1728 * optimal hardware/firmware RX filtering, many drivers may disable
1729 * Probe Request reporting at least in station mode. This command is
1730 * used to notify the driver when the Probe Request frames need to be
1731 * reported, e.g., during remain-on-channel operations.
1733 int (*probe_req_report
)(void *priv
, int report
);
1736 * disable_11b_rates - Set whether IEEE 802.11b rates are used for TX
1737 * @priv: Private driver interface data
1738 * @disabled: Whether IEEE 802.11b rates are disabled
1739 * Returns: 0 on success, -1 on failure (or if not supported)
1741 * This command is used to disable IEEE 802.11b rates (1, 2, 5.5, and
1742 * 11 Mbps) as TX rates for data and management frames. This can be
1743 * used to optimize channel use when there is no need to support IEEE
1744 * 802.11b-only devices.
1746 int (*disable_11b_rates
)(void *priv
, int disabled
);
1749 * deinit_ap - Deinitialize AP mode
1750 * @priv: Private driver interface data
1751 * Returns: 0 on success, -1 on failure (or if not supported)
1753 * This optional function can be used to disable AP mode related
1754 * configuration and change the driver mode to station mode to allow
1755 * normal station operations like scanning to be completed.
1757 int (*deinit_ap
)(void *priv
);
1760 * suspend - Notification on system suspend/hibernate event
1761 * @priv: Private driver interface data
1763 void (*suspend
)(void *priv
);
1766 * resume - Notification on system resume/thaw event
1767 * @priv: Private driver interface data
1769 void (*resume
)(void *priv
);
1774 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1776 enum wpa_event_type
{
1778 * EVENT_ASSOC - Association completed
1780 * This event needs to be delivered when the driver completes IEEE
1781 * 802.11 association or reassociation successfully.
1782 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1783 * after this event has been generated. In addition, optional
1784 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1785 * more information about the association. If the driver interface gets
1786 * both of these events at the same time, it can also include the
1787 * assoc_info data in EVENT_ASSOC call.
1792 * EVENT_DISASSOC - Association lost
1794 * This event should be called when association is lost either due to
1795 * receiving deauthenticate or disassociate frame from the AP or when
1796 * sending either of these frames to the current AP. If the driver
1797 * supports separate deauthentication event, EVENT_DISASSOC should only
1798 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1799 * In AP mode, union wpa_event_data::disassoc_info is required.
1804 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1806 * This event must be delivered when a Michael MIC error is detected by
1807 * the local driver. Additional data for event processing is
1808 * provided with union wpa_event_data::michael_mic_failure. This
1809 * information is used to request new encyption key and to initiate
1810 * TKIP countermeasures if needed.
1812 EVENT_MICHAEL_MIC_FAILURE
,
1815 * EVENT_SCAN_RESULTS - Scan results available
1817 * This event must be called whenever scan results are available to be
1818 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1819 * is expected to be used some time after struct wpa_driver_ops::scan()
1820 * is called. If the driver provides an unsolicited event when the scan
1821 * has been completed, this event can be used to trigger
1822 * EVENT_SCAN_RESULTS call. If such event is not available from the
1823 * driver, the driver wrapper code is expected to use a registered
1824 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1825 * scan is expected to be completed. Optional information about
1826 * completed scan can be provided with union wpa_event_data::scan_info.
1831 * EVENT_ASSOCINFO - Report optional extra information for association
1833 * This event can be used to report extra association information for
1834 * EVENT_ASSOC processing. This extra information includes IEs from
1835 * association frames and Beacon/Probe Response frames in union
1836 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1837 * EVENT_ASSOC. Alternatively, the driver interface can include
1838 * assoc_info data in the EVENT_ASSOC call if it has all the
1839 * information available at the same point.
1844 * EVENT_INTERFACE_STATUS - Report interface status changes
1846 * This optional event can be used to report changes in interface
1847 * status (interface added/removed) using union
1848 * wpa_event_data::interface_status. This can be used to trigger
1849 * wpa_supplicant to stop and re-start processing for the interface,
1850 * e.g., when a cardbus card is ejected/inserted.
1852 EVENT_INTERFACE_STATUS
,
1855 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1857 * This event can be used to inform wpa_supplicant about candidates for
1858 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1859 * for scan request (ap_scan=2 mode), this event is required for
1860 * pre-authentication. If wpa_supplicant is performing scan request
1861 * (ap_scan=1), this event is optional since scan results can be used
1862 * to add pre-authentication candidates. union
1863 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1864 * candidate and priority of the candidate, e.g., based on the signal
1865 * strength, in order to try to pre-authenticate first with candidates
1866 * that are most likely targets for re-association.
1868 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1869 * on the candidate list. In addition, it can be called for the current
1870 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1871 * will automatically skip pre-authentication in cases where a valid
1872 * PMKSA exists. When more than one candidate exists, this event should
1873 * be generated once for each candidate.
1875 * Driver will be notified about successful pre-authentication with
1876 * struct wpa_driver_ops::add_pmkid() calls.
1878 EVENT_PMKID_CANDIDATE
,
1881 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1883 * This event can be used to inform wpa_supplicant about desire to set
1884 * up secure direct link connection between two stations as defined in
1885 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1886 * STAKey negotiation. The caller will need to set peer address for the
1892 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1894 * The driver is expected to report the received FT IEs from
1895 * FT authentication sequence from the AP. The FT IEs are included in
1896 * the extra information in union wpa_event_data::ft_ies.
1901 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
1903 * The driver can use this event to inform wpa_supplicant about a STA
1904 * in an IBSS with which protected frames could be exchanged. This
1905 * event starts RSN authentication with the other STA to authenticate
1906 * the STA and set up encryption keys with it.
1908 EVENT_IBSS_RSN_START
,
1911 * EVENT_AUTH - Authentication result
1913 * This event should be called when authentication attempt has been
1914 * completed. This is only used if the driver supports separate
1915 * authentication step (struct wpa_driver_ops::authenticate).
1916 * Information about authentication result is included in
1917 * union wpa_event_data::auth.
1922 * EVENT_DEAUTH - Authentication lost
1924 * This event should be called when authentication is lost either due
1925 * to receiving deauthenticate frame from the AP or when sending that
1926 * frame to the current AP.
1927 * In AP mode, union wpa_event_data::deauth_info is required.
1932 * EVENT_ASSOC_REJECT - Association rejected
1934 * This event should be called when (re)association attempt has been
1935 * rejected by the AP. Information about authentication result is
1936 * included in union wpa_event_data::assoc_reject.
1941 * EVENT_AUTH_TIMED_OUT - Authentication timed out
1943 EVENT_AUTH_TIMED_OUT
,
1946 * EVENT_ASSOC_TIMED_OUT - Association timed out
1948 EVENT_ASSOC_TIMED_OUT
,
1951 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received
1956 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
1958 EVENT_WPS_BUTTON_PUSHED
,
1961 * EVENT_TX_STATUS - Report TX status
1966 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
1968 EVENT_RX_FROM_UNKNOWN
,
1971 * EVENT_RX_MGMT - Report RX of a management frame
1976 * EVENT_RX_ACTION - Action frame received
1978 * This event is used to indicate when an Action frame has been
1979 * received. Information about the received frame is included in
1980 * union wpa_event_data::rx_action.
1985 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
1987 * This event is used to indicate when the driver has started the
1988 * requested remain-on-channel duration. Information about the
1989 * operation is included in union wpa_event_data::remain_on_channel.
1991 EVENT_REMAIN_ON_CHANNEL
,
1994 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
1996 * This event is used to indicate when the driver has completed
1997 * remain-on-channel duration, i.e., may noot be available on the
1998 * requested channel anymore. Information about the
1999 * operation is included in union wpa_event_data::remain_on_channel.
2001 EVENT_CANCEL_REMAIN_ON_CHANNEL
,
2004 * EVENT_MLME_RX - Report reception of frame for MLME (test use only)
2006 * This event is used only by driver_test.c and userspace MLME.
2011 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
2013 * This event is used to indicate when a Probe Request frame has been
2014 * received. Information about the received frame is included in
2015 * union wpa_event_data::rx_probe_req. The driver is required to report
2016 * these events only after successfully completed probe_req_report()
2017 * commands to request the events (i.e., report parameter is non-zero)
2018 * in station mode. In AP mode, Probe Request frames should always be
2024 * EVENT_NEW_STA - New wired device noticed
2026 * This event is used to indicate that a new device has been detected
2027 * in a network that does not use association-like functionality (i.e.,
2028 * mainly wired Ethernet). This can be used to start EAPOL
2029 * authenticator when receiving a frame from a device. The address of
2030 * the device is included in union wpa_event_data::new_sta.
2035 * EVENT_EAPOL_RX - Report received EAPOL frame
2037 * When in AP mode with hostapd, this event is required to be used to
2038 * deliver the receive EAPOL frames from the driver. With
2039 * %wpa_supplicant, this event is used only if the send_eapol() handler
2040 * is used to override the use of l2_packet for EAPOL frame TX.
2047 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
2049 union wpa_event_data
{
2051 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
2053 * This structure is optional for EVENT_ASSOC calls and required for
2054 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
2055 * driver interface does not need to generate separate EVENT_ASSOCINFO
2060 * req_ies - (Re)Association Request IEs
2062 * If the driver generates WPA/RSN IE, this event data must be
2063 * returned for WPA handshake to have needed information. If
2064 * wpa_supplicant-generated WPA/RSN IE is used, this
2065 * information event is optional.
2067 * This should start with the first IE (fixed fields before IEs
2068 * are not included).
2073 * req_ies_len - Length of req_ies in bytes
2078 * resp_ies - (Re)Association Response IEs
2080 * Optional association data from the driver. This data is not
2081 * required WPA, but may be useful for some protocols and as
2082 * such, should be reported if this is available to the driver
2085 * This should start with the first IE (fixed fields before IEs
2086 * are not included).
2091 * resp_ies_len - Length of resp_ies in bytes
2093 size_t resp_ies_len
;
2096 * beacon_ies - Beacon or Probe Response IEs
2098 * Optional Beacon/ProbeResp data: IEs included in Beacon or
2099 * Probe Response frames from the current AP (i.e., the one
2100 * that the client just associated with). This information is
2101 * used to update WPA/RSN IE for the AP. If this field is not
2102 * set, the results from previous scan will be used. If no
2103 * data for the new AP is found, scan results will be requested
2104 * again (without scan request). At this point, the driver is
2105 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
2108 * This should start with the first IE (fixed fields before IEs
2109 * are not included).
2111 const u8
*beacon_ies
;
2114 * beacon_ies_len - Length of beacon_ies */
2115 size_t beacon_ies_len
;
2118 * freq - Frequency of the operational channel in MHz
2123 * addr - Station address (for AP mode)
2129 * struct disassoc_info - Data for EVENT_DISASSOC events
2131 struct disassoc_info
{
2133 * addr - Station address (for AP mode)
2139 * struct deauth_info - Data for EVENT_DEAUTH events
2141 struct deauth_info
{
2143 * addr - Station address (for AP mode)
2149 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
2151 struct michael_mic_failure
{
2154 } michael_mic_failure
;
2157 * struct interface_status - Data for EVENT_INTERFACE_STATUS
2159 struct interface_status
{
2162 EVENT_INTERFACE_ADDED
, EVENT_INTERFACE_REMOVED
2167 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
2169 struct pmkid_candidate
{
2170 /** BSSID of the PMKID candidate */
2172 /** Smaller the index, higher the priority */
2174 /** Whether RSN IE includes pre-authenticate flag */
2179 * struct stkstart - Data for EVENT_STKSTART
2186 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
2188 * During FT (IEEE 802.11r) authentication sequence, the driver is
2189 * expected to use this event to report received FT IEs (MDIE, FTIE,
2190 * RSN IE, TIE, possible resource request) to the supplicant. The FT
2191 * IEs for the next message will be delivered through the
2192 * struct wpa_driver_ops::update_ft_ies() callback.
2198 u8 target_ap
[ETH_ALEN
];
2199 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
2201 /** Length of ric_ies buffer in octets */
2206 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
2208 struct ibss_rsn_start
{
2213 * struct auth_info - Data for EVENT_AUTH events
2224 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
2226 struct assoc_reject
{
2228 * resp_ies - (Re)Association Response IEs
2230 * Optional association data from the driver. This data is not
2231 * required WPA, but may be useful for some protocols and as
2232 * such, should be reported if this is available to the driver
2235 * This should start with the first IE (fixed fields before IEs
2236 * are not included).
2241 * resp_ies_len - Length of resp_ies in bytes
2243 size_t resp_ies_len
;
2246 * status_code - Status Code from (Re)association Response
2251 struct timeout_event
{
2256 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events
2265 * struct tx_status - Data for EVENT_TX_STATUS events
2277 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
2279 struct rx_from_unknown
{
2285 * struct rx_mgmt - Data for EVENT_RX_MGMT events
2295 * struct rx_action - Data for EVENT_RX_ACTION events
2299 * da - Destination address of the received Action frame
2304 * sa - Source address of the received Action frame
2309 * bssid - Address 3 of the received Action frame
2314 * category - Action frame category
2319 * data - Action frame body after category field
2324 * len - Length of data in octets
2329 * freq - Frequency (in MHz) on which the frame was received
2335 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
2337 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
2339 struct remain_on_channel
{
2341 * freq - Channel frequency in MHz
2346 * duration - Duration to remain on the channel in milliseconds
2348 unsigned int duration
;
2349 } remain_on_channel
;
2352 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
2353 * @aborted: Whether the scan was aborted
2354 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
2355 * @num_freqs: Number of entries in freqs array
2356 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
2358 * @num_ssids: Number of entries in ssids array
2364 struct wpa_driver_scan_ssid ssids
[WPAS_MAX_SCAN_SSIDS
];
2369 * struct mlme_rx - Data for EVENT_MLME_RX events
2380 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
2382 struct rx_probe_req
{
2384 * sa - Source address of the received Probe Request frame
2389 * ie - IEs from the Probe Request body
2394 * ie_len - Length of ie buffer in octets
2400 * struct new_sta - Data for EVENT_NEW_STA events
2407 * struct eapol_rx - Data for EVENT_EAPOL_RX events
2417 * wpa_supplicant_event - Report a driver event for wpa_supplicant
2418 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
2419 * with struct wpa_driver_ops::init()
2420 * @event: event type (defined above)
2421 * @data: possible extra data for the event
2423 * Driver wrapper code should call this function whenever an event is received
2426 void wpa_supplicant_event(void *ctx
, enum wpa_event_type event
,
2427 union wpa_event_data
*data
);
2431 * The following inline functions are provided for convenience to simplify
2432 * event indication for some of the common events.
2435 static inline void drv_event_assoc(void *ctx
, const u8
*addr
, const u8
*ie
,
2438 union wpa_event_data event
;
2439 os_memset(&event
, 0, sizeof(event
));
2440 event
.assoc_info
.req_ies
= ie
;
2441 event
.assoc_info
.req_ies_len
= ielen
;
2442 event
.assoc_info
.addr
= addr
;
2443 wpa_supplicant_event(ctx
, EVENT_ASSOC
, &event
);
2446 static inline void drv_event_disassoc(void *ctx
, const u8
*addr
)
2448 union wpa_event_data event
;
2449 os_memset(&event
, 0, sizeof(event
));
2450 event
.disassoc_info
.addr
= addr
;
2451 wpa_supplicant_event(ctx
, EVENT_DISASSOC
, &event
);
2454 static inline void drv_event_eapol_rx(void *ctx
, const u8
*src
, const u8
*data
,
2457 union wpa_event_data event
;
2458 os_memset(&event
, 0, sizeof(event
));
2459 event
.eapol_rx
.src
= src
;
2460 event
.eapol_rx
.data
= data
;
2461 event
.eapol_rx
.data_len
= data_len
;
2462 wpa_supplicant_event(ctx
, EVENT_EAPOL_RX
, &event
);
2465 #endif /* DRIVER_H */