2 * WPA Supplicant - driver interface definition
3 * Copyright (c) 2003-2009, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
18 #define WPA_SUPPLICANT_DRIVER_VERSION 3
22 #define HOSTAPD_CHAN_DISABLED 0x00000001
23 #define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002
24 #define HOSTAPD_CHAN_NO_IBSS 0x00000004
25 #define HOSTAPD_CHAN_RADAR 0x00000008
27 struct hostapd_channel_data
{
28 short chan
; /* channel number (IEEE 802.11) */
29 short freq
; /* frequency in MHz */
30 int flag
; /* flag for hostapd use (HOSTAPD_CHAN_*) */
31 u8 max_tx_power
; /* maximum transmit power in dBm */
34 #define HOSTAPD_RATE_ERP 0x00000001
35 #define HOSTAPD_RATE_BASIC 0x00000002
36 #define HOSTAPD_RATE_PREAMBLE2 0x00000004
37 #define HOSTAPD_RATE_SUPPORTED 0x00000010
38 #define HOSTAPD_RATE_OFDM 0x00000020
39 #define HOSTAPD_RATE_CCK 0x00000040
40 #define HOSTAPD_RATE_MANDATORY 0x00000100
42 struct hostapd_rate_data
{
43 int rate
; /* rate in 100 kbps */
44 int flags
; /* HOSTAPD_RATE_ flags */
47 struct hostapd_hw_modes
{
50 struct hostapd_channel_data
*channels
;
52 struct hostapd_rate_data
*rates
;
57 #define AUTH_ALG_OPEN_SYSTEM 0x01
58 #define AUTH_ALG_SHARED_KEY 0x02
59 #define AUTH_ALG_LEAP 0x04
60 #define AUTH_ALG_FT 0x08
62 #define IEEE80211_MODE_INFRA 0
63 #define IEEE80211_MODE_IBSS 1
64 #define IEEE80211_MODE_AP 2
66 #define IEEE80211_CAP_ESS 0x0001
67 #define IEEE80211_CAP_IBSS 0x0002
68 #define IEEE80211_CAP_PRIVACY 0x0010
70 #define SSID_MAX_WPA_IE_LEN 40
72 * struct wpa_scan_result - Scan results (old structure)
75 * @ssid_len: length of the ssid
77 * @wpa_ie_len: length of the wpa_ie
79 * @rsn_ie_len: length of the RSN IE
80 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
81 * @caps: capability information field in host byte order
82 * @qual: signal quality
84 * @level: signal level
85 * @maxrate: maximum supported rate
86 * @mdie_present: Whether MDIE was included in Beacon/ProbeRsp frame
87 * @mdie: Mobility domain identifier IE (IEEE 802.11r MDIE) (starting from
91 * This structure is used as a generic format for scan results from the
92 * driver. Each driver interface implementation is responsible for converting
93 * the driver or OS specific scan results into this format.
95 * This structure is the old data structure used for scan results. It is
96 * obsoleted by the new struct wpa_scan_res structure and the old version is
97 * only included for backwards compatibility with existing driver wrapper
98 * implementations. New implementations are encouraged to implement for struct
99 * wpa_scan_res. The old structure will be removed at some point.
101 struct wpa_scan_result
{
105 u8 wpa_ie
[SSID_MAX_WPA_IE_LEN
];
107 u8 rsn_ie
[SSID_MAX_WPA_IE_LEN
];
121 #define WPA_SCAN_QUAL_INVALID BIT(0)
122 #define WPA_SCAN_NOISE_INVALID BIT(1)
123 #define WPA_SCAN_LEVEL_INVALID BIT(2)
124 #define WPA_SCAN_LEVEL_DBM BIT(3)
127 * struct wpa_scan_res - Scan result for an BSS/IBSS
128 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
130 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
131 * @beacon_int: beacon interval in TUs (host byte order)
132 * @caps: capability information field in host byte order
133 * @qual: signal quality
134 * @noise: noise level
135 * @level: signal level
137 * @ie_len: length of the following IE field in octets
139 * This structure is used as a generic format for scan results from the
140 * driver. Each driver interface implementation is responsible for converting
141 * the driver or OS specific scan results into this format.
143 * If the driver does not support reporting all IEs, the IE data structure is
144 * constructed of the IEs that are available. This field will also need to
145 * include SSID in IE format. All drivers are encouraged to be extended to
146 * report all IEs to make it easier to support future additions.
148 struct wpa_scan_res
{
159 /* followed by ie_len octets of IEs */
163 * struct wpa_scan_results - Scan results
164 * @res: Array of pointers to allocated variable length scan result entries
165 * @num: Number of entries in the scan result array
167 struct wpa_scan_results
{
168 struct wpa_scan_res
**res
;
173 * struct wpa_interface_info - Network interface information
174 * @next: Pointer to the next interface or NULL if this is the last one
175 * @ifname: Interface name that can be used with init() or init2()
176 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
178 * @drv_bame: struct wpa_driver_ops::name (note: unlike other strings, this one
179 * is not an allocated copy, i.e., get_interfaces() caller will not free
182 struct wpa_interface_info
{
183 struct wpa_interface_info
*next
;
186 const char *drv_name
;
189 #define WPAS_MAX_SCAN_SSIDS 4
192 * struct wpa_driver_scan_params - Scan parameters
193 * Data for struct wpa_driver_ops::scan2().
195 struct wpa_driver_scan_params
{
197 * ssids - SSIDs to scan for
199 struct wpa_driver_scan_ssid
{
201 * ssid - specific SSID to scan for (ProbeReq)
202 * %NULL or zero-length SSID is used to indicate active scan
203 * with wildcard SSID.
207 * ssid_len: Length of the SSID in octets
210 } ssids
[WPAS_MAX_SCAN_SSIDS
];
213 * num_ssids - Number of entries in ssids array
214 * Zero indicates a request for a passive scan.
219 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
224 * extra_ies_len - Length of extra_ies in octets
226 size_t extra_ies_len
;
229 * freqs - Array of frequencies to scan or %NULL for all frequencies
231 * The frequency is set in MHz. The array is zero-terminated.
237 * struct wpa_driver_auth_params - Authentication parameters
238 * Data for struct wpa_driver_ops::authenticate().
240 struct wpa_driver_auth_params
{
248 const u8
*wep_key
[4];
249 size_t wep_key_len
[4];
254 * struct wpa_driver_associate_params - Association parameters
255 * Data for struct wpa_driver_ops::associate().
257 struct wpa_driver_associate_params
{
259 * bssid - BSSID of the selected AP
260 * This can be %NULL, if ap_scan=2 mode is used and the driver is
261 * responsible for selecting with which BSS to associate. */
265 * ssid - The selected SSID
271 * freq - Frequency of the channel the selected AP is using
272 * Frequency that the selected AP is using (in MHz as
273 * reported in the scan results)
278 * wpa_ie - WPA information element for (Re)Association Request
279 * WPA information element to be included in (Re)Association
280 * Request (including information element id and length). Use
281 * of this WPA IE is optional. If the driver generates the WPA
282 * IE, it can use pairwise_suite, group_suite, and
283 * key_mgmt_suite to select proper algorithms. In this case,
284 * the driver has to notify wpa_supplicant about the used WPA
285 * IE by generating an event that the interface code will
286 * convert into EVENT_ASSOCINFO data (see below).
288 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
289 * instead. The driver can determine which version is used by
290 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
293 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
297 * wpa_ie_len - length of the wpa_ie
301 /* The selected pairwise/group cipher and key management
302 * suites. These are usually ignored if @wpa_ie is used. */
303 wpa_cipher pairwise_suite
;
304 wpa_cipher group_suite
;
305 wpa_key_mgmt key_mgmt_suite
;
308 * auth_alg - Allowed authentication algorithms
309 * Bit field of AUTH_ALG_*
314 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
319 * wep_key - WEP keys for static WEP configuration
321 const u8
*wep_key
[4];
324 * wep_key_len - WEP key length for static WEP configuration
326 size_t wep_key_len
[4];
329 * wep_tx_keyidx - WEP TX key index for static WEP configuration
334 * mgmt_frame_protection - IEEE 802.11w management frame protection
337 NO_MGMT_FRAME_PROTECTION
,
338 MGMT_FRAME_PROTECTION_OPTIONAL
,
339 MGMT_FRAME_PROTECTION_REQUIRED
340 } mgmt_frame_protection
;
343 * ft_ies - IEEE 802.11r / FT information elements
344 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
345 * for fast transition, this parameter is set to include the IEs that
346 * are to be sent in the next FT Authentication Request message.
347 * update_ft_ies() handler is called to update the IEs for further
348 * FT messages in the sequence.
350 * The driver should use these IEs only if the target AP is advertising
351 * the same mobility domain as the one included in the MDIE here.
353 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
354 * AP after the initial association. These IEs can only be used if the
355 * target AP is advertising support for FT and is using the same MDIE
356 * and SSID as the current AP.
358 * The driver is responsible for reporting the FT IEs received from the
359 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
360 * type. update_ft_ies() handler will then be called with the FT IEs to
361 * include in the next frame in the authentication sequence.
366 * ft_ies_len - Length of ft_ies in bytes
371 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
373 * This value is provided to allow the driver interface easier access
374 * to the current mobility domain. This value is set to %NULL if no
375 * mobility domain is currently active.
380 * passphrase - RSN passphrase for PSK
382 * This value is made available only for WPA/WPA2-Personal (PSK) and
383 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
384 * the 8..63 character ASCII passphrase, if available. Please note that
385 * this can be %NULL if passphrase was not used to generate the PSK. In
386 * that case, the psk field must be used to fetch the PSK.
388 const char *passphrase
;
391 * psk - RSN PSK (alternative for passphrase for PSK)
393 * This value is made available only for WPA/WPA2-Personal (PSK) and
394 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
395 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
396 * be prepared to handle %NULL value as an error.
401 * drop_unencrypted - Enable/disable unencrypted frame filtering
403 * Configure the driver to drop all non-EAPOL frames (both receive and
404 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
405 * still be allowed for key negotiation.
407 int drop_unencrypted
;
411 * struct wpa_driver_capa - Driver capability information
413 struct wpa_driver_capa
{
414 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
415 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
416 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
417 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
418 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
419 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
420 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
421 unsigned int key_mgmt
;
423 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
424 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
425 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
426 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
429 #define WPA_DRIVER_AUTH_OPEN 0x00000001
430 #define WPA_DRIVER_AUTH_SHARED 0x00000002
431 #define WPA_DRIVER_AUTH_LEAP 0x00000004
434 /* Driver generated WPA/RSN IE */
435 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
436 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
437 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
438 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
439 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
440 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
441 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
442 /* Driver provides separate commands for authentication and association (SME in
443 * wpa_supplicant). */
444 #define WPA_DRIVER_FLAGS_SME 0x00000020
445 /* Driver supports AP mode */
446 #define WPA_DRIVER_FLAGS_AP 0x00000040
453 struct ieee80211_rx_status
{
461 struct hostap_sta_driver_data
{
462 unsigned long rx_packets
, tx_packets
, rx_bytes
, tx_bytes
;
463 unsigned long current_tx_rate
;
464 unsigned long inactive_msec
;
466 unsigned long num_ps_buf_frames
;
467 unsigned long tx_retry_failed
;
468 unsigned long tx_retry_count
;
473 struct hostapd_sta_add_params
{
477 const u8
*supp_rates
;
478 size_t supp_rates_len
;
481 const struct ht_cap_ie
*ht_capabilities
;
484 struct hostapd_freq_params
{
489 int sec_channel_offset
; /* 0 = HT40 disabled, -1 = HT40 enabled,
490 * secondary channel below primary, 1 = HT40
491 * enabled, secondary channel above primary */
494 enum hostapd_driver_if_type
{
498 struct wpa_init_params
{
503 const char *test_socket
;
504 int use_pae_group_addr
;
508 u8
*own_addr
; /* buffer for writing own MAC address */
513 * struct wpa_driver_ops - Driver interface API definition
515 * This structure defines the API that each driver interface needs to implement
516 * for core wpa_supplicant code. All driver specific functionality is captured
519 struct wpa_driver_ops
{
520 /** Name of the driver interface */
522 /** One line description of the driver interface */
526 * get_bssid - Get the current BSSID
527 * @priv: private driver interface data
528 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
530 * Returns: 0 on success, -1 on failure
532 * Query kernel driver for the current BSSID and copy it to bssid.
533 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
536 int (*get_bssid
)(void *priv
, u8
*bssid
);
539 * get_ssid - Get the current SSID
540 * @priv: private driver interface data
541 * @ssid: buffer for SSID (at least 32 bytes)
543 * Returns: Length of the SSID on success, -1 on failure
545 * Query kernel driver for the current SSID and copy it to ssid.
546 * Returning zero is recommended if the STA is not associated.
548 * Note: SSID is an array of octets, i.e., it is not nul terminated and
549 * can, at least in theory, contain control characters (including nul)
550 * and as such, should be processed as binary data, not a printable
553 int (*get_ssid
)(void *priv
, u8
*ssid
);
556 * set_wpa - Enable/disable WPA support (OBSOLETE)
557 * @priv: private driver interface data
558 * @enabled: 1 = enable, 0 = disable
560 * Returns: 0 on success, -1 on failure
562 * Note: This function is included for backwards compatibility. This is
563 * called only just after init and just before deinit, so these
564 * functions can be used to implement same functionality and the driver
565 * interface need not define this function.
567 * Configure the kernel driver to enable/disable WPA support. This may
568 * be empty function, if WPA support is always enabled. Common
569 * configuration items are WPA IE (clearing it when WPA support is
570 * disabled), Privacy flag configuration for capability field (note:
571 * this the value need to set in associate handler to allow plaintext
572 * mode to be used) when trying to associate with, roaming mode (can
573 * allow wpa_supplicant to control roaming if ap_scan=1 is used;
574 * however, drivers can also implement roaming if desired, especially
575 * ap_scan=2 mode is used for this).
577 int (*set_wpa
)(void *priv
, int enabled
);
580 * set_key - Configure encryption key
581 * @priv: private driver interface data
582 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
583 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
584 * %WPA_ALG_NONE clears the key.
585 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
586 * broadcast/default keys
587 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
589 * @set_tx: configure this key as the default Tx key (only used when
590 * driver does not support separate unicast/individual key
591 * @seq: sequence number/packet number, seq_len octets, the next
592 * packet number to be used for in replay protection; configured
593 * for Rx keys (in most cases, this is only used with broadcast
594 * keys and set to zero for unicast keys)
595 * @seq_len: length of the seq, depends on the algorithm:
596 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
597 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
599 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
600 * TKIP: 32, CCMP: 16, IGTK: 16)
602 * Returns: 0 on success, -1 on failure
604 * Configure the given key for the kernel driver. If the driver
605 * supports separate individual keys (4 default keys + 1 individual),
606 * addr can be used to determine whether the key is default or
607 * individual. If only 4 keys are supported, the default key with key
608 * index 0 is used as the individual key. STA must be configured to use
609 * it as the default Tx key (set_tx is set) and accept Rx for all the
610 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
611 * broadcast keys, so key index 0 is available for this kind of
614 * Please note that TKIP keys include separate TX and RX MIC keys and
615 * some drivers may expect them in different order than wpa_supplicant
616 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
617 * will tricker Michael MIC errors. This can be fixed by changing the
618 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
619 * in driver_*.c set_key() implementation, see driver_ndis.c for an
620 * example on how this can be done.
622 int (*set_key
)(void *priv
, wpa_alg alg
, const u8
*addr
,
623 int key_idx
, int set_tx
, const u8
*seq
, size_t seq_len
,
624 const u8
*key
, size_t key_len
);
627 * init - Initialize driver interface
628 * @ctx: context to be used when calling wpa_supplicant functions,
629 * e.g., wpa_supplicant_event()
630 * @ifname: interface name, e.g., wlan0
632 * Returns: Pointer to private data, %NULL on failure
634 * Initialize driver interface, including event processing for kernel
635 * driver events (e.g., associated, scan results, Michael MIC failure).
636 * This function can allocate a private configuration data area for
637 * @ctx, file descriptor, interface name, etc. information that may be
638 * needed in future driver operations. If this is not used, non-NULL
639 * value will need to be returned because %NULL is used to indicate
640 * failure. The returned value will be used as 'void *priv' data for
641 * all other driver_ops functions.
643 * The main event loop (eloop.c) of wpa_supplicant can be used to
644 * register callback for read sockets (eloop_register_read_sock()).
646 * See below for more information about events and
647 * wpa_supplicant_event() function.
649 void * (*init
)(void *ctx
, const char *ifname
);
652 * deinit - Deinitialize driver interface
653 * @priv: private driver interface data from init()
655 * Shut down driver interface and processing of driver events. Free
656 * private data buffer if one was allocated in init() handler.
658 void (*deinit
)(void *priv
);
661 * set_param - Set driver configuration parameters
662 * @priv: private driver interface data from init()
663 * @param: driver specific configuration parameters
665 * Returns: 0 on success, -1 on failure
667 * Optional handler for notifying driver interface about configuration
668 * parameters (driver_param).
670 int (*set_param
)(void *priv
, const char *param
);
673 * set_countermeasures - Enable/disable TKIP countermeasures
674 * @priv: private driver interface data
675 * @enabled: 1 = countermeasures enabled, 0 = disabled
677 * Returns: 0 on success, -1 on failure
679 * Configure TKIP countermeasures. When these are enabled, the driver
680 * should drop all received and queued frames that are using TKIP.
682 int (*set_countermeasures
)(void *priv
, int enabled
);
685 * set_drop_unencrypted - Enable/disable unencrypted frame filtering
686 * @priv: private driver interface data
687 * @enabled: 1 = unencrypted Tx/Rx frames will be dropped, 0 = disabled
689 * Returns: 0 on success, -1 on failure
691 * Configure the driver to drop all non-EAPOL frames (both receive and
692 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
693 * still be allowed for key negotiation.
695 * This function is deprecated. New driver wrapper implementations
696 * should use associate() parameter drop_unencrypted instead.
698 int (*set_drop_unencrypted
)(void *priv
, int enabled
);
701 * scan - Request the driver to initiate scan (old version)
702 * @priv: private driver interface data
703 * @ssid: specific SSID to scan for (ProbeReq) or %NULL to scan for
704 * all SSIDs (either active scan with wildcard SSID or passive
706 * @ssid_len: length of the SSID
708 * Returns: 0 on success, -1 on failure
710 * Once the scan results are ready, the driver should report scan
711 * results event for wpa_supplicant which will eventually request the
712 * results with wpa_driver_get_scan_results().
714 * This function is deprecated. New driver wrapper implementations
715 * should implement support for scan2().
717 int (*scan
)(void *priv
, const u8
*ssid
, size_t ssid_len
);
720 * get_scan_results - Fetch the latest scan results (old version)
721 * @priv: private driver interface data
722 * @results: pointer to buffer for scan results
723 * @max_size: maximum number of entries (buffer size)
725 * Returns: Number of scan result entries used on success, -1 on
728 * If scan results include more than max_size BSSes, max_size will be
729 * returned and the remaining entries will not be included in the
732 * This function is deprecated. New driver wrapper implementations
733 * should implement support for get_scan_results2().
735 int (*get_scan_results
)(void *priv
,
736 struct wpa_scan_result
*results
,
740 * deauthenticate - Request driver to deauthenticate
741 * @priv: private driver interface data
742 * @addr: peer address (BSSID of the AP)
743 * @reason_code: 16-bit reason code to be sent in the deauthentication
746 * Returns: 0 on success, -1 on failure
748 int (*deauthenticate
)(void *priv
, const u8
*addr
, int reason_code
);
751 * disassociate - Request driver to disassociate
752 * @priv: private driver interface data
753 * @addr: peer address (BSSID of the AP)
754 * @reason_code: 16-bit reason code to be sent in the disassociation
757 * Returns: 0 on success, -1 on failure
759 int (*disassociate
)(void *priv
, const u8
*addr
, int reason_code
);
762 * associate - Request driver to associate
763 * @priv: private driver interface data
764 * @params: association parameters
766 * Returns: 0 on success, -1 on failure
768 int (*associate
)(void *priv
,
769 struct wpa_driver_associate_params
*params
);
772 * set_auth_alg - Set IEEE 802.11 authentication algorithm
773 * @priv: private driver interface data
774 * @auth_alg: bit field of AUTH_ALG_*
776 * If the driver supports more than one authentication algorithm at the
777 * same time, it should configure all supported algorithms. If not, one
778 * algorithm needs to be selected arbitrarily. Open System
779 * authentication should be ok for most cases and it is recommended to
780 * be used if other options are not supported. Static WEP configuration
781 * may also use Shared Key authentication and LEAP requires its own
782 * algorithm number. For LEAP, user can make sure that only one
783 * algorithm is used at a time by configuring LEAP as the only
784 * supported EAP method. This information is also available in
785 * associate() params, so set_auth_alg may not be needed in case of
788 * This function is deprecated. New driver wrapper implementations
789 * should use associate() parameter auth_alg instead.
791 * Returns: 0 on success, -1 on failure
793 int (*set_auth_alg
)(void *priv
, int auth_alg
);
796 * add_pmkid - Add PMKSA cache entry to the driver
797 * @priv: private driver interface data
798 * @bssid: BSSID for the PMKSA cache entry
799 * @pmkid: PMKID for the PMKSA cache entry
801 * Returns: 0 on success, -1 on failure
803 * This function is called when a new PMK is received, as a result of
804 * either normal authentication or RSN pre-authentication.
806 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
807 * associate(), add_pmkid() can be used to add new PMKSA cache entries
808 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
809 * driver_ops function does not need to be implemented. Likewise, if
810 * the driver does not support WPA, this function is not needed.
812 int (*add_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
815 * remove_pmkid - Remove PMKSA cache entry to the driver
816 * @priv: private driver interface data
817 * @bssid: BSSID for the PMKSA cache entry
818 * @pmkid: PMKID for the PMKSA cache entry
820 * Returns: 0 on success, -1 on failure
822 * This function is called when the supplicant drops a PMKSA cache
823 * entry for any reason.
825 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
826 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
827 * between the driver and wpa_supplicant. If the driver uses wpa_ie
828 * from wpa_supplicant, this driver_ops function does not need to be
829 * implemented. Likewise, if the driver does not support WPA, this
830 * function is not needed.
832 int (*remove_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
835 * flush_pmkid - Flush PMKSA cache
836 * @priv: private driver interface data
838 * Returns: 0 on success, -1 on failure
840 * This function is called when the supplicant drops all PMKSA cache
841 * entries for any reason.
843 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
844 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
845 * between the driver and wpa_supplicant. If the driver uses wpa_ie
846 * from wpa_supplicant, this driver_ops function does not need to be
847 * implemented. Likewise, if the driver does not support WPA, this
848 * function is not needed.
850 int (*flush_pmkid
)(void *priv
);
853 * get_capa - Get driver capabilities
854 * @priv: private driver interface data
856 * Returns: 0 on success, -1 on failure
858 * Get driver/firmware/hardware capabilities.
860 int (*get_capa
)(void *priv
, struct wpa_driver_capa
*capa
);
863 * poll - Poll driver for association information
864 * @priv: private driver interface data
866 * This is an option callback that can be used when the driver does not
867 * provide event mechanism for association events. This is called when
868 * receiving WPA EAPOL-Key messages that require association
869 * information. The driver interface is supposed to generate associnfo
870 * event before returning from this callback function. In addition, the
871 * driver interface should generate an association event after having
872 * sent out associnfo.
874 void (*poll
)(void *priv
);
877 * get_ifname - Get interface name
878 * @priv: private driver interface data
880 * Returns: Pointer to the interface name. This can differ from the
881 * interface name used in init() call. Init() is called first.
883 * This optional function can be used to allow the driver interface to
884 * replace the interface name with something else, e.g., based on an
885 * interface mapping from a more descriptive name.
887 const char * (*get_ifname
)(void *priv
);
890 * get_mac_addr - Get own MAC address
891 * @priv: private driver interface data
893 * Returns: Pointer to own MAC address or %NULL on failure
895 * This optional function can be used to get the own MAC address of the
896 * device from the driver interface code. This is only needed if the
897 * l2_packet implementation for the OS does not provide easy access to
899 const u8
* (*get_mac_addr
)(void *priv
);
902 * send_eapol - Optional function for sending EAPOL packets
903 * @priv: private driver interface data
904 * @dest: Destination MAC address
906 * @data: EAPOL packet starting with IEEE 802.1X header
907 * @data_len: Size of the EAPOL packet
909 * Returns: 0 on success, -1 on failure
911 * This optional function can be used to override l2_packet operations
912 * with driver specific functionality. If this function pointer is set,
913 * l2_packet module is not used at all and the driver interface code is
914 * responsible for receiving and sending all EAPOL packets. The
915 * received EAPOL packets are sent to core code by calling
916 * wpa_supplicant_rx_eapol(). The driver interface is required to
917 * implement get_mac_addr() handler if send_eapol() is used.
919 int (*send_eapol
)(void *priv
, const u8
*dest
, u16 proto
,
920 const u8
*data
, size_t data_len
);
923 * set_operstate - Sets device operating state to DORMANT or UP
924 * @priv: private driver interface data
925 * @state: 0 = dormant, 1 = up
926 * Returns: 0 on success, -1 on failure
928 * This is an optional function that can be used on operating systems
929 * that support a concept of controlling network device state from user
930 * space applications. This function, if set, gets called with
931 * state = 1 when authentication has been completed and with state = 0
932 * when connection is lost.
934 int (*set_operstate
)(void *priv
, int state
);
937 * mlme_setprotection - MLME-SETPROTECTION.request primitive
938 * @priv: Private driver interface data
939 * @addr: Address of the station for which to set protection (may be
940 * %NULL for group keys)
941 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
942 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
943 * Returns: 0 on success, -1 on failure
945 * This is an optional function that can be used to set the driver to
946 * require protection for Tx and/or Rx frames. This uses the layer
947 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
948 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
949 * set protection operation; instead, they set protection implicitly
950 * based on configured keys.
952 int (*mlme_setprotection
)(void *priv
, const u8
*addr
, int protect_type
,
956 * get_hw_feature_data - Get hardware support data (channels and rates)
957 * @priv: Private driver interface data
958 * @num_modes: Variable for returning the number of returned modes
959 * flags: Variable for returning hardware feature flags
960 * Returns: Pointer to allocated hardware data on success or %NULL on
961 * failure. Caller is responsible for freeing this.
963 * This function is only needed for drivers that export MLME
964 * (management frame processing) to wpa_supplicant.
966 struct hostapd_hw_modes
* (*get_hw_feature_data
)(void *priv
,
971 * set_channel - Set channel
972 * @priv: Private driver interface data
973 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
974 * @chan: IEEE 802.11 channel number
975 * @freq: Frequency of the channel in MHz
976 * Returns: 0 on success, -1 on failure
978 * This function is only needed for drivers that export MLME
979 * (management frame processing) to wpa_supplicant.
981 int (*set_channel
)(void *priv
, hostapd_hw_mode phymode
, int chan
,
985 * set_ssid - Set SSID
986 * @priv: Private driver interface data
988 * @ssid_len: SSID length
989 * Returns: 0 on success, -1 on failure
991 * This function is only needed for drivers that export MLME
992 * (management frame processing) to wpa_supplicant.
994 int (*set_ssid
)(void *priv
, const u8
*ssid
, size_t ssid_len
);
997 * set_bssid - Set BSSID
998 * @priv: Private driver interface data
1000 * Returns: 0 on success, -1 on failure
1002 * This function is only needed for drivers that export MLME
1003 * (management frame processing) to wpa_supplicant.
1005 int (*set_bssid
)(void *priv
, const u8
*bssid
);
1008 * send_mlme - Send management frame from MLME
1009 * @priv: Private driver interface data
1010 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1011 * @data_len: Size of the management frame
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.
1017 int (*send_mlme
)(void *priv
, const u8
*data
, size_t data_len
);
1020 * mlme_add_sta - Add a STA entry into the driver/netstack
1021 * @priv: Private driver interface data
1022 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1023 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
1024 * format (one octet per rate, 1 = 0.5 Mbps)
1025 * @supp_rates_len: Number of entries in supp_rates
1026 * Returns: 0 on success, -1 on failure
1028 * This function is only needed for drivers that export MLME
1029 * (management frame processing) to wpa_supplicant. When the MLME code
1030 * completes association with an AP, this function is called to
1031 * configure the driver/netstack with a STA entry for data frame
1032 * processing (TX rate control, encryption/decryption).
1034 int (*mlme_add_sta
)(void *priv
, const u8
*addr
, const u8
*supp_rates
,
1035 size_t supp_rates_len
);
1038 * mlme_remove_sta - Remove a STA entry from the driver/netstack
1039 * @priv: Private driver interface data
1040 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1041 * Returns: 0 on success, -1 on failure
1043 * This function is only needed for drivers that export MLME
1044 * (management frame processing) to wpa_supplicant.
1046 int (*mlme_remove_sta
)(void *priv
, const u8
*addr
);
1049 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1050 * @priv: Private driver interface data
1051 * @md: Mobility domain (2 octets) (also included inside ies)
1052 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1053 * @ies_len: Length of FT IEs in bytes
1054 * Returns: 0 on success, -1 on failure
1056 * The supplicant uses this callback to let the driver know that keying
1057 * material for FT is available and that the driver can use the
1058 * provided IEs in the next message in FT authentication sequence.
1060 * This function is only needed for driver that support IEEE 802.11r
1061 * (Fast BSS Transition).
1063 int (*update_ft_ies
)(void *priv
, const u8
*md
, const u8
*ies
,
1067 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1068 * @priv: Private driver interface data
1069 * @action: Action field value
1070 * @target_ap: Target AP address
1071 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1072 * @ies_len: Length of FT IEs in bytes
1073 * Returns: 0 on success, -1 on failure
1075 * The supplicant uses this callback to request the driver to transmit
1076 * an FT Action frame (action category 6) for over-the-DS fast BSS
1079 int (*send_ft_action
)(void *priv
, u8 action
, const u8
*target_ap
,
1080 const u8
*ies
, size_t ies_len
);
1083 * get_scan_results2 - Fetch the latest scan results
1084 * @priv: private driver interface data
1086 * Returns: Allocated buffer of scan results (caller is responsible for
1087 * freeing the data structure) on success, NULL on failure
1089 struct wpa_scan_results
* (*get_scan_results2
)(void *priv
);
1092 * set_probe_req_ie - Set information element(s) for Probe Request
1093 * @priv: private driver interface data
1094 * @ies: Information elements to append or %NULL to remove extra IEs
1095 * @ies_len: Length of the IE buffer in octets
1096 * Returns: 0 on success, -1 on failure
1098 int (*set_probe_req_ie
)(void *priv
, const u8
*ies
, size_t ies_len
);
1101 * set_mode - Request driver to set the operating mode
1102 * @priv: private driver interface data
1103 * @mode: Operation mode (infra/ibss) IEEE80211_MODE_*
1105 * This handler will be called before any key configuration and call to
1106 * associate() handler in order to allow the operation mode to be
1107 * configured as early as possible. This information is also available
1108 * in associate() params and as such, driver wrappers may not need
1109 * to implement set_mode() handler.
1111 * This function is deprecated. New driver wrapper implementations
1112 * should use associate() parameter mode instead.
1114 * Returns: 0 on success, -1 on failure
1116 int (*set_mode
)(void *priv
, int mode
);
1119 * set_country - Set country
1120 * @priv: Private driver interface data
1121 * @alpha2: country to which to switch to
1122 * Returns: 0 on success, -1 on failure
1124 * This function is for drivers which support some form
1125 * of setting a regulatory domain.
1127 int (*set_country
)(void *priv
, const char *alpha2
);
1130 * global_init - Global driver initialization
1131 * Returns: Pointer to private data (global), %NULL on failure
1133 * This optional function is called to initialize the driver wrapper
1134 * for global data, i.e., data that applies to all interfaces. If this
1135 * function is implemented, global_deinit() will also need to be
1136 * implemented to free the private data. The driver will also likely
1137 * use init2() function instead of init() to get the pointer to global
1138 * data available to per-interface initializer.
1140 void * (*global_init
)(void);
1143 * global_deinit - Global driver deinitialization
1144 * @priv: private driver global data from global_init()
1146 * Terminate any global driver related functionality and free the
1147 * global data structure.
1149 void (*global_deinit
)(void *priv
);
1152 * init2 - Initialize driver interface (with global data)
1153 * @ctx: context to be used when calling wpa_supplicant functions,
1154 * e.g., wpa_supplicant_event()
1155 * @ifname: interface name, e.g., wlan0
1156 * @global_priv: private driver global data from global_init()
1157 * Returns: Pointer to private data, %NULL on failure
1159 * This function can be used instead of init() if the driver wrapper
1162 void * (*init2
)(void *ctx
, const char *ifname
, void *global_priv
);
1165 * get_interfaces - Get information about available interfaces
1166 * @global_priv: private driver global data from global_init()
1167 * Returns: Allocated buffer of interface information (caller is
1168 * responsible for freeing the data structure) on success, NULL on
1171 struct wpa_interface_info
* (*get_interfaces
)(void *global_priv
);
1174 * scan2 - Request the driver to initiate scan
1175 * @priv: private driver interface data
1176 * @params: Scan parameters
1178 * Returns: 0 on success, -1 on failure
1180 * Once the scan results are ready, the driver should report scan
1181 * results event for wpa_supplicant which will eventually request the
1182 * results with wpa_driver_get_scan_results2().
1184 int (*scan2
)(void *priv
, struct wpa_driver_scan_params
*params
);
1187 * authenticate - Request driver to authenticate
1188 * @priv: private driver interface data
1189 * @params: authentication parameters
1190 * Returns: 0 on success, -1 on failure
1192 * This is an optional function that can be used with drivers that
1193 * support separate authentication and association steps, i.e., when
1194 * wpa_supplicant can act as the SME. If not implemented, associate()
1195 * function is expected to take care of IEEE 802.11 authentication,
1198 int (*authenticate
)(void *priv
,
1199 struct wpa_driver_auth_params
*params
);
1201 int (*set_beacon
)(void *priv
, const u8
*head
, size_t head_len
,
1202 const u8
*tail
, size_t tail_len
, int dtim_period
);
1204 int (*set_beacon_int
)(void *priv
, int value
);
1206 void * (*hapd_init
)(struct hostapd_data
*hapd
,
1207 struct wpa_init_params
*params
);
1208 void (*hapd_deinit
)(void *priv
);
1211 * set_8021x - enable/disable IEEE 802.1X support
1212 * @ifname: Interface name (for multi-SSID/VLAN support)
1213 * @priv: driver private data
1214 * @enabled: 1 = enable, 0 = disable
1216 * Returns: 0 on success, -1 on failure
1218 * Configure the kernel driver to enable/disable 802.1X support.
1219 * This may be an empty function if 802.1X support is always enabled.
1221 int (*set_ieee8021x
)(const char *ifname
, void *priv
, int enabled
);
1224 * set_privacy - enable/disable privacy
1225 * @priv: driver private data
1226 * @enabled: 1 = privacy enabled, 0 = disabled
1228 * Return: 0 on success, -1 on failure
1230 * Configure privacy.
1232 int (*set_privacy
)(const char *ifname
, void *priv
, int enabled
);
1234 int (*hapd_set_key
)(const char *ifname
, void *priv
, wpa_alg alg
,
1235 const u8
*addr
, int key_idx
, int set_tx
,
1236 const u8
*seq
, size_t seq_len
,
1237 const u8
*key
, size_t key_len
);
1238 int (*get_seqnum
)(const char *ifname
, void *priv
, const u8
*addr
,
1240 int (*get_seqnum_igtk
)(const char *ifname
, void *priv
, const u8
*addr
,
1242 int (*flush
)(void *priv
);
1243 int (*set_generic_elem
)(const char *ifname
, void *priv
, const u8
*elem
,
1246 int (*read_sta_data
)(void *priv
, struct hostap_sta_driver_data
*data
,
1248 int (*hapd_send_eapol
)(void *priv
, const u8
*addr
, const u8
*data
,
1249 size_t data_len
, int encrypt
,
1250 const u8
*own_addr
);
1251 int (*sta_deauth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
1253 int (*sta_disassoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
1255 int (*sta_remove
)(void *priv
, const u8
*addr
);
1256 int (*hapd_get_ssid
)(const char *ifname
, void *priv
, u8
*buf
, int len
);
1257 int (*hapd_set_ssid
)(const char *ifname
, void *priv
, const u8
*buf
,
1259 int (*hapd_set_countermeasures
)(void *priv
, int enabled
);
1260 int (*sta_add
)(const char *ifname
, void *priv
,
1261 struct hostapd_sta_add_params
*params
);
1262 int (*get_inact_sec
)(void *priv
, const u8
*addr
);
1263 int (*sta_clear_stats
)(void *priv
, const u8
*addr
);
1265 int (*set_freq
)(void *priv
, struct hostapd_freq_params
*freq
);
1266 int (*set_rts
)(void *priv
, int rts
);
1267 int (*set_frag
)(void *priv
, int frag
);
1269 int (*sta_set_flags
)(void *priv
, const u8
*addr
,
1270 int total_flags
, int flags_or
, int flags_and
);
1271 int (*set_rate_sets
)(void *priv
, int *supp_rates
, int *basic_rates
,
1273 int (*hapd_set_beacon
)(const char *ifname
, void *priv
,
1274 const u8
*head
, size_t head_len
,
1275 const u8
*tail
, size_t tail_len
,
1278 /* Configure internal bridge:
1279 * 0 = disabled, i.e., client separation is enabled (no bridging of
1280 * packets between associated STAs
1281 * 1 = enabled, i.e., bridge packets between associated STAs (default)
1283 int (*set_internal_bridge
)(void *priv
, int value
);
1284 int (*set_cts_protect
)(void *priv
, int value
);
1285 int (*set_preamble
)(void *priv
, int value
);
1286 int (*set_short_slot_time
)(void *priv
, int value
);
1287 int (*set_tx_queue_params
)(void *priv
, int queue
, int aifs
, int cw_min
,
1288 int cw_max
, int burst_time
);
1289 int (*bss_add
)(void *priv
, const char *ifname
, const u8
*bssid
);
1290 int (*bss_remove
)(void *priv
, const char *ifname
);
1291 int (*valid_bss_mask
)(void *priv
, const u8
*addr
, const u8
*mask
);
1292 int (*if_add
)(const char *iface
, void *priv
,
1293 enum hostapd_driver_if_type type
, char *ifname
,
1295 int (*if_update
)(void *priv
, enum hostapd_driver_if_type type
,
1296 char *ifname
, const u8
*addr
);
1297 int (*if_remove
)(void *priv
, enum hostapd_driver_if_type type
,
1298 const char *ifname
, const u8
*addr
);
1299 int (*set_sta_vlan
)(void *priv
, const u8
*addr
, const char *ifname
,
1302 * commit - Optional commit changes handler
1303 * @priv: driver private data
1304 * Returns: 0 on success, -1 on failure
1306 * This optional handler function can be registered if the driver
1307 * interface implementation needs to commit changes (e.g., by setting
1308 * network interface up) at the end of initial configuration. If set,
1309 * this handler will be called after initial setup has been completed.
1311 int (*commit
)(void *priv
);
1313 int (*send_ether
)(void *priv
, const u8
*dst
, const u8
*src
, u16 proto
,
1314 const u8
*data
, size_t data_len
);
1316 int (*set_radius_acl_auth
)(void *priv
, const u8
*mac
, int accepted
,
1317 u32 session_timeout
);
1318 int (*set_radius_acl_expire
)(void *priv
, const u8
*mac
);
1320 int (*set_ht_params
)(const char *ifname
, void *priv
,
1321 const u8
*ht_capab
, size_t ht_capab_len
,
1322 const u8
*ht_oper
, size_t ht_oper_len
);
1324 int (*set_wps_beacon_ie
)(const char *ifname
, void *priv
,
1325 const u8
*ie
, size_t len
);
1326 int (*set_wps_probe_resp_ie
)(const char *ifname
, void *priv
,
1327 const u8
*ie
, size_t len
);
1330 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1331 * @priv: Private driver interface data
1332 * @authorized: Whether the port is authorized
1333 * Returns: 0 on success, -1 on failure
1335 int (*set_supp_port
)(void *priv
, int authorized
);
1339 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1341 typedef enum wpa_event_type
{
1343 * EVENT_ASSOC - Association completed
1345 * This event needs to be delivered when the driver completes IEEE
1346 * 802.11 association or reassociation successfully.
1347 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1348 * after this event has been generated. In addition, optional
1349 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1350 * more information about the association. If the driver interface gets
1351 * both of these events at the same time, it can also include the
1352 * assoc_info data in EVENT_ASSOC call.
1357 * EVENT_DISASSOC - Association lost
1359 * This event should be called when association is lost either due to
1360 * receiving deauthenticate or disassociate frame from the AP or when
1361 * sending either of these frames to the current AP. If the driver
1362 * supports separate deauthentication event, EVENT_DISASSOC should only
1363 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1368 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1370 * This event must be delivered when a Michael MIC error is detected by
1371 * the local driver. Additional data for event processing is
1372 * provided with union wpa_event_data::michael_mic_failure. This
1373 * information is used to request new encyption key and to initiate
1374 * TKIP countermeasures if needed.
1376 EVENT_MICHAEL_MIC_FAILURE
,
1379 * EVENT_SCAN_RESULTS - Scan results available
1381 * This event must be called whenever scan results are available to be
1382 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1383 * is expected to be used some time after struct wpa_driver_ops::scan()
1384 * is called. If the driver provides an unsolicited event when the scan
1385 * has been completed, this event can be used to trigger
1386 * EVENT_SCAN_RESULTS call. If such event is not available from the
1387 * driver, the driver wrapper code is expected to use a registered
1388 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1389 * scan is expected to be completed.
1394 * EVENT_ASSOCINFO - Report optional extra information for association
1396 * This event can be used to report extra association information for
1397 * EVENT_ASSOC processing. This extra information includes IEs from
1398 * association frames and Beacon/Probe Response frames in union
1399 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1400 * EVENT_ASSOC. Alternatively, the driver interface can include
1401 * assoc_info data in the EVENT_ASSOC call if it has all the
1402 * information available at the same point.
1407 * EVENT_INTERFACE_STATUS - Report interface status changes
1409 * This optional event can be used to report changes in interface
1410 * status (interface added/removed) using union
1411 * wpa_event_data::interface_status. This can be used to trigger
1412 * wpa_supplicant to stop and re-start processing for the interface,
1413 * e.g., when a cardbus card is ejected/inserted.
1415 EVENT_INTERFACE_STATUS
,
1418 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1420 * This event can be used to inform wpa_supplicant about candidates for
1421 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1422 * for scan request (ap_scan=2 mode), this event is required for
1423 * pre-authentication. If wpa_supplicant is performing scan request
1424 * (ap_scan=1), this event is optional since scan results can be used
1425 * to add pre-authentication candidates. union
1426 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1427 * candidate and priority of the candidate, e.g., based on the signal
1428 * strength, in order to try to pre-authenticate first with candidates
1429 * that are most likely targets for re-association.
1431 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1432 * on the candidate list. In addition, it can be called for the current
1433 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1434 * will automatically skip pre-authentication in cases where a valid
1435 * PMKSA exists. When more than one candidate exists, this event should
1436 * be generated once for each candidate.
1438 * Driver will be notified about successful pre-authentication with
1439 * struct wpa_driver_ops::add_pmkid() calls.
1441 EVENT_PMKID_CANDIDATE
,
1444 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1446 * This event can be used to inform wpa_supplicant about desire to set
1447 * up secure direct link connection between two stations as defined in
1448 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1449 * STAKey negotiation. The caller will need to set peer address for the
1455 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1457 * The driver is expected to report the received FT IEs from
1458 * FT authentication sequence from the AP. The FT IEs are included in
1459 * the extra information in union wpa_event_data::ft_ies.
1464 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
1466 * The driver can use this event to inform wpa_supplicant about a STA
1467 * in an IBSS with which protected frames could be exchanged. This
1468 * event starts RSN authentication with the other STA to authenticate
1469 * the STA and set up encryption keys with it.
1471 EVENT_IBSS_RSN_START
,
1474 * EVENT_AUTH - Authentication result
1476 * This event should be called when authentication attempt has been
1477 * completed. This is only used if the driver supports separate
1478 * authentication step (struct wpa_driver_ops::authenticate).
1479 * Information about authentication result is included in
1480 * union wpa_event_data::auth.
1485 * EVENT_DEAUTH - Authentication lost
1487 * This event should be called when authentication is lost either due
1488 * to receiving deauthenticate frame from the AP or when sending that
1489 * frame to the current AP.
1494 * EVENT_ASSOC_REJECT - Association rejected
1496 * This event should be called when (re)association attempt has been
1497 * rejected by the AP. Information about authentication result is
1498 * included in union wpa_event_data::assoc_reject.
1503 * EVENT_AUTH_TIMED_OUT - Authentication timed out
1505 EVENT_AUTH_TIMED_OUT
,
1508 * EVENT_ASSOC_TIMED_OUT - Association timed out
1510 EVENT_ASSOC_TIMED_OUT
1515 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
1517 union wpa_event_data
{
1519 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
1521 * This structure is optional for EVENT_ASSOC calls and required for
1522 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
1523 * driver interface does not need to generate separate EVENT_ASSOCINFO
1528 * req_ies - (Re)Association Request IEs
1530 * If the driver generates WPA/RSN IE, this event data must be
1531 * returned for WPA handshake to have needed information. If
1532 * wpa_supplicant-generated WPA/RSN IE is used, this
1533 * information event is optional.
1535 * This should start with the first IE (fixed fields before IEs
1536 * are not included).
1541 * req_ies_len - Length of req_ies in bytes
1546 * resp_ies - (Re)Association Response IEs
1548 * Optional association data from the driver. This data is not
1549 * required WPA, but may be useful for some protocols and as
1550 * such, should be reported if this is available to the driver
1553 * This should start with the first IE (fixed fields before IEs
1554 * are not included).
1559 * resp_ies_len - Length of resp_ies in bytes
1561 size_t resp_ies_len
;
1564 * beacon_ies - Beacon or Probe Response IEs
1566 * Optional Beacon/ProbeResp data: IEs included in Beacon or
1567 * Probe Response frames from the current AP (i.e., the one
1568 * that the client just associated with). This information is
1569 * used to update WPA/RSN IE for the AP. If this field is not
1570 * set, the results from previous scan will be used. If no
1571 * data for the new AP is found, scan results will be requested
1572 * again (without scan request). At this point, the driver is
1573 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
1576 * This should start with the first IE (fixed fields before IEs
1577 * are not included).
1582 * beacon_ies_len - Length of beacon_ies */
1583 size_t beacon_ies_len
;
1587 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
1589 struct michael_mic_failure
{
1592 } michael_mic_failure
;
1595 * struct interface_status - Data for EVENT_INTERFACE_STATUS
1597 struct interface_status
{
1600 EVENT_INTERFACE_ADDED
, EVENT_INTERFACE_REMOVED
1605 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
1607 struct pmkid_candidate
{
1608 /** BSSID of the PMKID candidate */
1610 /** Smaller the index, higher the priority */
1612 /** Whether RSN IE includes pre-authenticate flag */
1617 * struct stkstart - Data for EVENT_STKSTART
1624 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
1626 * During FT (IEEE 802.11r) authentication sequence, the driver is
1627 * expected to use this event to report received FT IEs (MDIE, FTIE,
1628 * RSN IE, TIE, possible resource request) to the supplicant. The FT
1629 * IEs for the next message will be delivered through the
1630 * struct wpa_driver_ops::update_ft_ies() callback.
1636 u8 target_ap
[ETH_ALEN
];
1637 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
1639 /** Length of ric_ies buffer in octets */
1644 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
1646 struct ibss_rsn_start
{
1651 * struct auth_info - Data for EVENT_AUTH events
1662 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
1664 struct assoc_reject
{
1666 * resp_ies - (Re)Association Response IEs
1668 * Optional association data from the driver. This data is not
1669 * required WPA, but may be useful for some protocols and as
1670 * such, should be reported if this is available to the driver
1673 * This should start with the first IE (fixed fields before IEs
1674 * are not included).
1679 * resp_ies_len - Length of resp_ies in bytes
1681 size_t resp_ies_len
;
1684 * status_code - Status Code from (Re)association Response
1689 struct timeout_event
{
1695 * wpa_supplicant_event - Report a driver event for wpa_supplicant
1696 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1697 * with struct wpa_driver_ops::init()
1698 * @event: event type (defined above)
1699 * @data: possible extra data for the event
1701 * Driver wrapper code should call this function whenever an event is received
1704 void wpa_supplicant_event(void *ctx
, wpa_event_type event
,
1705 union wpa_event_data
*data
);
1708 * wpa_supplicant_rx_eapol - Deliver a received EAPOL frame to wpa_supplicant
1709 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1710 * with struct wpa_driver_ops::init()
1711 * @src_addr: Source address of the EAPOL frame
1712 * @buf: EAPOL data starting from the EAPOL header (i.e., no Ethernet header)
1713 * @len: Length of the EAPOL data
1715 * This function is called for each received EAPOL frame. Most driver
1716 * interfaces rely on more generic OS mechanism for receiving frames through
1717 * l2_packet, but if such a mechanism is not available, the driver wrapper may
1718 * take care of received EAPOL frames and deliver them to the core supplicant
1719 * code by calling this function.
1721 void wpa_supplicant_rx_eapol(void *ctx
, const u8
*src_addr
,
1722 const u8
*buf
, size_t len
);
1724 void wpa_supplicant_sta_rx(void *ctx
, const u8
*buf
, size_t len
,
1725 struct ieee80211_rx_status
*rx_status
);
1727 const u8
* wpa_scan_get_ie(const struct wpa_scan_res
*res
, u8 ie
);
1728 #define WPA_IE_VENDOR_TYPE 0x0050f201
1729 #define WPS_IE_VENDOR_TYPE 0x0050f204
1730 const u8
* wpa_scan_get_vendor_ie(const struct wpa_scan_res
*res
,
1732 struct wpabuf
* wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res
*res
,
1734 int wpa_scan_get_max_rate(const struct wpa_scan_res
*res
);
1735 void wpa_scan_results_free(struct wpa_scan_results
*res
);
1736 void wpa_scan_sort_results(struct wpa_scan_results
*res
);
1738 /* hostapd functions for driver wrappers */
1741 struct ieee80211_hdr
;
1743 void hostapd_new_assoc_sta(struct hostapd_data
*hapd
, struct sta_info
*sta
,
1745 void hostapd_tx_status(struct hostapd_data
*hapd
, const u8
*addr
,
1746 const u8
*buf
, size_t len
, int ack
);
1747 void hostapd_rx_from_unknown_sta(struct hostapd_data
*hapd
,
1748 const struct ieee80211_hdr
*hdr
, size_t len
);
1749 int hostapd_notif_assoc(struct hostapd_data
*hapd
, const u8
*addr
,
1750 const u8
*ie
, size_t ielen
);
1751 void hostapd_notif_disassoc(struct hostapd_data
*hapd
, const u8
*addr
);
1752 void hostapd_eapol_receive(struct hostapd_data
*hapd
, const u8
*sa
,
1753 const u8
*buf
, size_t len
);
1755 struct hostapd_frame_info
{
1762 void hostapd_mgmt_rx(struct hostapd_data
*hapd
, u8
*buf
, size_t len
,
1763 u16 stype
, struct hostapd_frame_info
*fi
);
1764 void hostapd_mgmt_tx_cb(struct hostapd_data
*hapd
, u8
*buf
, size_t len
,
1766 void hostapd_michael_mic_failure(struct hostapd_data
*hapd
, const u8
*addr
);
1767 struct hostapd_data
* hostapd_sta_get_bss(struct hostapd_data
*hapd
,
1770 #endif /* DRIVER_H */