2 * WPA Supplicant - driver interface definition
3 * Copyright (c) 2003-2009, Jouni Malinen <j@w1.fi>
5 * This program is free software; you can redistribute it and/or modify
6 * it under the terms of the GNU General Public License version 2 as
7 * published by the Free Software Foundation.
9 * Alternatively, this software may be distributed under the terms of BSD
12 * See README and COPYING for more details.
18 #define WPA_SUPPLICANT_DRIVER_VERSION 4
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
;
58 #define AUTH_ALG_OPEN_SYSTEM 0x01
59 #define AUTH_ALG_SHARED_KEY 0x02
60 #define AUTH_ALG_LEAP 0x04
61 #define AUTH_ALG_FT 0x08
63 #define IEEE80211_MODE_INFRA 0
64 #define IEEE80211_MODE_IBSS 1
65 #define IEEE80211_MODE_AP 2
67 #define IEEE80211_CAP_ESS 0x0001
68 #define IEEE80211_CAP_IBSS 0x0002
69 #define IEEE80211_CAP_PRIVACY 0x0010
71 #define SSID_MAX_WPA_IE_LEN 40
73 * struct wpa_scan_result - Scan results (old structure)
76 * @ssid_len: length of the ssid
78 * @wpa_ie_len: length of the wpa_ie
80 * @rsn_ie_len: length of the RSN IE
81 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
82 * @caps: capability information field in host byte order
83 * @qual: signal quality
85 * @level: signal level
86 * @maxrate: maximum supported rate
87 * @mdie_present: Whether MDIE was included in Beacon/ProbeRsp frame
88 * @mdie: Mobility domain identifier IE (IEEE 802.11r MDIE) (starting from
92 * This structure is used as a generic format for scan results from the
93 * driver. Each driver interface implementation is responsible for converting
94 * the driver or OS specific scan results into this format.
96 * This structure is the old data structure used for scan results. It is
97 * obsoleted by the new struct wpa_scan_res structure and the old version is
98 * only included for backwards compatibility with existing driver wrapper
99 * implementations. New implementations are encouraged to implement for struct
100 * wpa_scan_res. The old structure will be removed at some point.
102 struct wpa_scan_result
{
106 u8 wpa_ie
[SSID_MAX_WPA_IE_LEN
];
108 u8 rsn_ie
[SSID_MAX_WPA_IE_LEN
];
122 #define WPA_SCAN_QUAL_INVALID BIT(0)
123 #define WPA_SCAN_NOISE_INVALID BIT(1)
124 #define WPA_SCAN_LEVEL_INVALID BIT(2)
125 #define WPA_SCAN_LEVEL_DBM BIT(3)
128 * struct wpa_scan_res - Scan result for an BSS/IBSS
129 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
131 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
132 * @beacon_int: beacon interval in TUs (host byte order)
133 * @caps: capability information field in host byte order
134 * @qual: signal quality
135 * @noise: noise level
136 * @level: signal level
138 * @age: Age of the information in milliseconds (i.e., how many milliseconds
139 * ago the last Beacon or Probe Response frame was received)
140 * @ie_len: length of the following IE field in octets
142 * This structure is used as a generic format for scan results from the
143 * driver. Each driver interface implementation is responsible for converting
144 * the driver or OS specific scan results into this format.
146 * If the driver does not support reporting all IEs, the IE data structure is
147 * constructed of the IEs that are available. This field will also need to
148 * include SSID in IE format. All drivers are encouraged to be extended to
149 * report all IEs to make it easier to support future additions.
151 struct wpa_scan_res
{
163 /* followed by ie_len octets of IEs */
167 * struct wpa_scan_results - Scan results
168 * @res: Array of pointers to allocated variable length scan result entries
169 * @num: Number of entries in the scan result array
171 struct wpa_scan_results
{
172 struct wpa_scan_res
**res
;
177 * struct wpa_interface_info - Network interface information
178 * @next: Pointer to the next interface or NULL if this is the last one
179 * @ifname: Interface name that can be used with init() or init2()
180 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
182 * @drv_bame: struct wpa_driver_ops::name (note: unlike other strings, this one
183 * is not an allocated copy, i.e., get_interfaces() caller will not free
186 struct wpa_interface_info
{
187 struct wpa_interface_info
*next
;
190 const char *drv_name
;
193 #define WPAS_MAX_SCAN_SSIDS 4
196 * struct wpa_driver_scan_params - Scan parameters
197 * Data for struct wpa_driver_ops::scan2().
199 struct wpa_driver_scan_params
{
201 * ssids - SSIDs to scan for
203 struct wpa_driver_scan_ssid
{
205 * ssid - specific SSID to scan for (ProbeReq)
206 * %NULL or zero-length SSID is used to indicate active scan
207 * with wildcard SSID.
211 * ssid_len: Length of the SSID in octets
214 } ssids
[WPAS_MAX_SCAN_SSIDS
];
217 * num_ssids - Number of entries in ssids array
218 * Zero indicates a request for a passive scan.
223 * extra_ies - Extra IE(s) to add into Probe Request or %NULL
228 * extra_ies_len - Length of extra_ies in octets
230 size_t extra_ies_len
;
233 * freqs - Array of frequencies to scan or %NULL for all frequencies
235 * The frequency is set in MHz. The array is zero-terminated.
241 * struct wpa_driver_auth_params - Authentication parameters
242 * Data for struct wpa_driver_ops::authenticate().
244 struct wpa_driver_auth_params
{
252 const u8
*wep_key
[4];
253 size_t wep_key_len
[4];
258 * struct wpa_driver_associate_params - Association parameters
259 * Data for struct wpa_driver_ops::associate().
261 struct wpa_driver_associate_params
{
263 * bssid - BSSID of the selected AP
264 * This can be %NULL, if ap_scan=2 mode is used and the driver is
265 * responsible for selecting with which BSS to associate. */
269 * ssid - The selected SSID
275 * freq - Frequency of the channel the selected AP is using
276 * Frequency that the selected AP is using (in MHz as
277 * reported in the scan results)
282 * wpa_ie - WPA information element for (Re)Association Request
283 * WPA information element to be included in (Re)Association
284 * Request (including information element id and length). Use
285 * of this WPA IE is optional. If the driver generates the WPA
286 * IE, it can use pairwise_suite, group_suite, and
287 * key_mgmt_suite to select proper algorithms. In this case,
288 * the driver has to notify wpa_supplicant about the used WPA
289 * IE by generating an event that the interface code will
290 * convert into EVENT_ASSOCINFO data (see below).
292 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
293 * instead. The driver can determine which version is used by
294 * looking at the first byte of the IE (0xdd for WPA, 0x30 for
297 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
301 * wpa_ie_len - length of the wpa_ie
305 /* The selected pairwise/group cipher and key management
306 * suites. These are usually ignored if @wpa_ie is used. */
307 wpa_cipher pairwise_suite
;
308 wpa_cipher group_suite
;
309 wpa_key_mgmt key_mgmt_suite
;
312 * auth_alg - Allowed authentication algorithms
313 * Bit field of AUTH_ALG_*
318 * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
323 * wep_key - WEP keys for static WEP configuration
325 const u8
*wep_key
[4];
328 * wep_key_len - WEP key length for static WEP configuration
330 size_t wep_key_len
[4];
333 * wep_tx_keyidx - WEP TX key index for static WEP configuration
338 * mgmt_frame_protection - IEEE 802.11w management frame protection
341 NO_MGMT_FRAME_PROTECTION
,
342 MGMT_FRAME_PROTECTION_OPTIONAL
,
343 MGMT_FRAME_PROTECTION_REQUIRED
344 } mgmt_frame_protection
;
347 * ft_ies - IEEE 802.11r / FT information elements
348 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys
349 * for fast transition, this parameter is set to include the IEs that
350 * are to be sent in the next FT Authentication Request message.
351 * update_ft_ies() handler is called to update the IEs for further
352 * FT messages in the sequence.
354 * The driver should use these IEs only if the target AP is advertising
355 * the same mobility domain as the one included in the MDIE here.
357 * In ap_scan=2 mode, the driver can use these IEs when moving to a new
358 * AP after the initial association. These IEs can only be used if the
359 * target AP is advertising support for FT and is using the same MDIE
360 * and SSID as the current AP.
362 * The driver is responsible for reporting the FT IEs received from the
363 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE
364 * type. update_ft_ies() handler will then be called with the FT IEs to
365 * include in the next frame in the authentication sequence.
370 * ft_ies_len - Length of ft_ies in bytes
375 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies)
377 * This value is provided to allow the driver interface easier access
378 * to the current mobility domain. This value is set to %NULL if no
379 * mobility domain is currently active.
384 * passphrase - RSN passphrase for PSK
386 * This value is made available only for WPA/WPA2-Personal (PSK) and
387 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
388 * the 8..63 character ASCII passphrase, if available. Please note that
389 * this can be %NULL if passphrase was not used to generate the PSK. In
390 * that case, the psk field must be used to fetch the PSK.
392 const char *passphrase
;
395 * psk - RSN PSK (alternative for passphrase for PSK)
397 * This value is made available only for WPA/WPA2-Personal (PSK) and
398 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is
399 * the 32-octet (256-bit) PSK, if available. The driver wrapper should
400 * be prepared to handle %NULL value as an error.
405 * drop_unencrypted - Enable/disable unencrypted frame filtering
407 * Configure the driver to drop all non-EAPOL frames (both receive and
408 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
409 * still be allowed for key negotiation.
411 int drop_unencrypted
;
414 * prev_bssid - Previously used BSSID in this ESS
416 * When not %NULL, this is a request to use reassociation instead of
419 const u8
*prev_bssid
;
423 * struct wpa_driver_capa - Driver capability information
425 struct wpa_driver_capa
{
426 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001
427 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002
428 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004
429 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
430 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
431 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020
432 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040
433 unsigned int key_mgmt
;
435 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
436 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002
437 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004
438 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008
441 #define WPA_DRIVER_AUTH_OPEN 0x00000001
442 #define WPA_DRIVER_AUTH_SHARED 0x00000002
443 #define WPA_DRIVER_AUTH_LEAP 0x00000004
446 /* Driver generated WPA/RSN IE */
447 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001
448 /* Driver needs static WEP key setup after association command */
449 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
450 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004
451 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with
452 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */
453 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008
454 #define WPA_DRIVER_FLAGS_WIRED 0x00000010
455 /* Driver provides separate commands for authentication and association (SME in
456 * wpa_supplicant). */
457 #define WPA_DRIVER_FLAGS_SME 0x00000020
458 /* Driver supports AP mode */
459 #define WPA_DRIVER_FLAGS_AP 0x00000040
460 /* Driver needs static WEP key setup after association has been completed */
461 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080
468 struct ieee80211_rx_status
{
476 struct hostap_sta_driver_data
{
477 unsigned long rx_packets
, tx_packets
, rx_bytes
, tx_bytes
;
478 unsigned long current_tx_rate
;
479 unsigned long inactive_msec
;
481 unsigned long num_ps_buf_frames
;
482 unsigned long tx_retry_failed
;
483 unsigned long tx_retry_count
;
488 struct hostapd_sta_add_params
{
492 const u8
*supp_rates
;
493 size_t supp_rates_len
;
496 const struct ht_cap_ie
*ht_capabilities
;
499 struct hostapd_freq_params
{
504 int sec_channel_offset
; /* 0 = HT40 disabled, -1 = HT40 enabled,
505 * secondary channel below primary, 1 = HT40
506 * enabled, secondary channel above primary */
509 enum hostapd_driver_if_type
{
513 struct wpa_init_params
{
518 const char *test_socket
;
519 int use_pae_group_addr
;
523 u8
*own_addr
; /* buffer for writing own MAC address */
528 * struct wpa_driver_ops - Driver interface API definition
530 * This structure defines the API that each driver interface needs to implement
531 * for core wpa_supplicant code. All driver specific functionality is captured
534 struct wpa_driver_ops
{
535 /** Name of the driver interface */
537 /** One line description of the driver interface */
541 * get_bssid - Get the current BSSID
542 * @priv: private driver interface data
543 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
545 * Returns: 0 on success, -1 on failure
547 * Query kernel driver for the current BSSID and copy it to bssid.
548 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
551 int (*get_bssid
)(void *priv
, u8
*bssid
);
554 * get_ssid - Get the current SSID
555 * @priv: private driver interface data
556 * @ssid: buffer for SSID (at least 32 bytes)
558 * Returns: Length of the SSID on success, -1 on failure
560 * Query kernel driver for the current SSID and copy it to ssid.
561 * Returning zero is recommended if the STA is not associated.
563 * Note: SSID is an array of octets, i.e., it is not nul terminated and
564 * can, at least in theory, contain control characters (including nul)
565 * and as such, should be processed as binary data, not a printable
568 int (*get_ssid
)(void *priv
, u8
*ssid
);
571 * set_key - Configure encryption key
572 * @ifname: Interface name (for multi-SSID/VLAN support)
573 * @priv: private driver interface data
574 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
575 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
576 * %WPA_ALG_NONE clears the key.
577 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
578 * broadcast/default keys
579 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
581 * @set_tx: configure this key as the default Tx key (only used when
582 * driver does not support separate unicast/individual key
583 * @seq: sequence number/packet number, seq_len octets, the next
584 * packet number to be used for in replay protection; configured
585 * for Rx keys (in most cases, this is only used with broadcast
586 * keys and set to zero for unicast keys)
587 * @seq_len: length of the seq, depends on the algorithm:
588 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
589 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
591 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
592 * TKIP: 32, CCMP: 16, IGTK: 16)
594 * Returns: 0 on success, -1 on failure
596 * Configure the given key for the kernel driver. If the driver
597 * supports separate individual keys (4 default keys + 1 individual),
598 * addr can be used to determine whether the key is default or
599 * individual. If only 4 keys are supported, the default key with key
600 * index 0 is used as the individual key. STA must be configured to use
601 * it as the default Tx key (set_tx is set) and accept Rx for all the
602 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
603 * broadcast keys, so key index 0 is available for this kind of
606 * Please note that TKIP keys include separate TX and RX MIC keys and
607 * some drivers may expect them in different order than wpa_supplicant
608 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
609 * will tricker Michael MIC errors. This can be fixed by changing the
610 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
611 * in driver_*.c set_key() implementation, see driver_ndis.c for an
612 * example on how this can be done.
614 int (*set_key
)(const char *ifname
, void *priv
, wpa_alg alg
,
615 const u8
*addr
, int key_idx
, int set_tx
,
616 const u8
*seq
, size_t seq_len
,
617 const u8
*key
, size_t key_len
);
620 * init - Initialize driver interface
621 * @ctx: context to be used when calling wpa_supplicant functions,
622 * e.g., wpa_supplicant_event()
623 * @ifname: interface name, e.g., wlan0
625 * Returns: Pointer to private data, %NULL on failure
627 * Initialize driver interface, including event processing for kernel
628 * driver events (e.g., associated, scan results, Michael MIC failure).
629 * This function can allocate a private configuration data area for
630 * @ctx, file descriptor, interface name, etc. information that may be
631 * needed in future driver operations. If this is not used, non-NULL
632 * value will need to be returned because %NULL is used to indicate
633 * failure. The returned value will be used as 'void *priv' data for
634 * all other driver_ops functions.
636 * The main event loop (eloop.c) of wpa_supplicant can be used to
637 * register callback for read sockets (eloop_register_read_sock()).
639 * See below for more information about events and
640 * wpa_supplicant_event() function.
642 void * (*init
)(void *ctx
, const char *ifname
);
645 * deinit - Deinitialize driver interface
646 * @priv: private driver interface data from init()
648 * Shut down driver interface and processing of driver events. Free
649 * private data buffer if one was allocated in init() handler.
651 void (*deinit
)(void *priv
);
654 * set_param - Set driver configuration parameters
655 * @priv: private driver interface data from init()
656 * @param: driver specific configuration parameters
658 * Returns: 0 on success, -1 on failure
660 * Optional handler for notifying driver interface about configuration
661 * parameters (driver_param).
663 int (*set_param
)(void *priv
, const char *param
);
666 * set_countermeasures - Enable/disable TKIP countermeasures
667 * @priv: private driver interface data
668 * @enabled: 1 = countermeasures enabled, 0 = disabled
670 * Returns: 0 on success, -1 on failure
672 * Configure TKIP countermeasures. When these are enabled, the driver
673 * should drop all received and queued frames that are using TKIP.
675 int (*set_countermeasures
)(void *priv
, int enabled
);
678 * scan - Request the driver to initiate scan (old version)
679 * @priv: private driver interface data
680 * @ssid: specific SSID to scan for (ProbeReq) or %NULL to scan for
681 * all SSIDs (either active scan with wildcard SSID or passive
683 * @ssid_len: length of the SSID
685 * Returns: 0 on success, -1 on failure
687 * Once the scan results are ready, the driver should report scan
688 * results event for wpa_supplicant which will eventually request the
689 * results with wpa_driver_get_scan_results().
691 * This function is deprecated. New driver wrapper implementations
692 * should implement support for scan2().
694 int (*scan
)(void *priv
, const u8
*ssid
, size_t ssid_len
);
697 * get_scan_results - Fetch the latest scan results (old version)
698 * @priv: private driver interface data
699 * @results: pointer to buffer for scan results
700 * @max_size: maximum number of entries (buffer size)
702 * Returns: Number of scan result entries used on success, -1 on
705 * If scan results include more than max_size BSSes, max_size will be
706 * returned and the remaining entries will not be included in the
709 * This function is deprecated. New driver wrapper implementations
710 * should implement support for get_scan_results2().
712 int (*get_scan_results
)(void *priv
,
713 struct wpa_scan_result
*results
,
717 * deauthenticate - Request driver to deauthenticate
718 * @priv: private driver interface data
719 * @addr: peer address (BSSID of the AP)
720 * @reason_code: 16-bit reason code to be sent in the deauthentication
723 * Returns: 0 on success, -1 on failure
725 int (*deauthenticate
)(void *priv
, const u8
*addr
, int reason_code
);
728 * disassociate - Request driver to disassociate
729 * @priv: private driver interface data
730 * @addr: peer address (BSSID of the AP)
731 * @reason_code: 16-bit reason code to be sent in the disassociation
734 * Returns: 0 on success, -1 on failure
736 int (*disassociate
)(void *priv
, const u8
*addr
, int reason_code
);
739 * associate - Request driver to associate
740 * @priv: private driver interface data
741 * @params: association parameters
743 * Returns: 0 on success, -1 on failure
745 int (*associate
)(void *priv
,
746 struct wpa_driver_associate_params
*params
);
749 * add_pmkid - Add PMKSA cache entry to the driver
750 * @priv: private driver interface data
751 * @bssid: BSSID for the PMKSA cache entry
752 * @pmkid: PMKID for the PMKSA cache entry
754 * Returns: 0 on success, -1 on failure
756 * This function is called when a new PMK is received, as a result of
757 * either normal authentication or RSN pre-authentication.
759 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
760 * associate(), add_pmkid() can be used to add new PMKSA cache entries
761 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
762 * driver_ops function does not need to be implemented. Likewise, if
763 * the driver does not support WPA, this function is not needed.
765 int (*add_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
768 * remove_pmkid - Remove PMKSA cache entry to the driver
769 * @priv: private driver interface data
770 * @bssid: BSSID for the PMKSA cache entry
771 * @pmkid: PMKID for the PMKSA cache entry
773 * Returns: 0 on success, -1 on failure
775 * This function is called when the supplicant drops a PMKSA cache
776 * entry for any reason.
778 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
779 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
780 * between the driver and wpa_supplicant. If the driver uses wpa_ie
781 * from wpa_supplicant, this driver_ops function does not need to be
782 * implemented. Likewise, if the driver does not support WPA, this
783 * function is not needed.
785 int (*remove_pmkid
)(void *priv
, const u8
*bssid
, const u8
*pmkid
);
788 * flush_pmkid - Flush PMKSA cache
789 * @priv: private driver interface data
791 * Returns: 0 on success, -1 on failure
793 * This function is called when the supplicant drops all PMKSA cache
794 * entries for any reason.
796 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
797 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
798 * between the driver and wpa_supplicant. If the driver uses wpa_ie
799 * from wpa_supplicant, this driver_ops function does not need to be
800 * implemented. Likewise, if the driver does not support WPA, this
801 * function is not needed.
803 int (*flush_pmkid
)(void *priv
);
806 * get_capa - Get driver capabilities
807 * @priv: private driver interface data
809 * Returns: 0 on success, -1 on failure
811 * Get driver/firmware/hardware capabilities.
813 int (*get_capa
)(void *priv
, struct wpa_driver_capa
*capa
);
816 * poll - Poll driver for association information
817 * @priv: private driver interface data
819 * This is an option callback that can be used when the driver does not
820 * provide event mechanism for association events. This is called when
821 * receiving WPA EAPOL-Key messages that require association
822 * information. The driver interface is supposed to generate associnfo
823 * event before returning from this callback function. In addition, the
824 * driver interface should generate an association event after having
825 * sent out associnfo.
827 void (*poll
)(void *priv
);
830 * get_ifname - Get interface name
831 * @priv: private driver interface data
833 * Returns: Pointer to the interface name. This can differ from the
834 * interface name used in init() call. Init() is called first.
836 * This optional function can be used to allow the driver interface to
837 * replace the interface name with something else, e.g., based on an
838 * interface mapping from a more descriptive name.
840 const char * (*get_ifname
)(void *priv
);
843 * get_mac_addr - Get own MAC address
844 * @priv: private driver interface data
846 * Returns: Pointer to own MAC address or %NULL on failure
848 * This optional function can be used to get the own MAC address of the
849 * device from the driver interface code. This is only needed if the
850 * l2_packet implementation for the OS does not provide easy access to
852 const u8
* (*get_mac_addr
)(void *priv
);
855 * send_eapol - Optional function for sending EAPOL packets
856 * @priv: private driver interface data
857 * @dest: Destination MAC address
859 * @data: EAPOL packet starting with IEEE 802.1X header
860 * @data_len: Size of the EAPOL packet
862 * Returns: 0 on success, -1 on failure
864 * This optional function can be used to override l2_packet operations
865 * with driver specific functionality. If this function pointer is set,
866 * l2_packet module is not used at all and the driver interface code is
867 * responsible for receiving and sending all EAPOL packets. The
868 * received EAPOL packets are sent to core code by calling
869 * wpa_supplicant_rx_eapol(). The driver interface is required to
870 * implement get_mac_addr() handler if send_eapol() is used.
872 int (*send_eapol
)(void *priv
, const u8
*dest
, u16 proto
,
873 const u8
*data
, size_t data_len
);
876 * set_operstate - Sets device operating state to DORMANT or UP
877 * @priv: private driver interface data
878 * @state: 0 = dormant, 1 = up
879 * Returns: 0 on success, -1 on failure
881 * This is an optional function that can be used on operating systems
882 * that support a concept of controlling network device state from user
883 * space applications. This function, if set, gets called with
884 * state = 1 when authentication has been completed and with state = 0
885 * when connection is lost.
887 int (*set_operstate
)(void *priv
, int state
);
890 * mlme_setprotection - MLME-SETPROTECTION.request primitive
891 * @priv: Private driver interface data
892 * @addr: Address of the station for which to set protection (may be
893 * %NULL for group keys)
894 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
895 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
896 * Returns: 0 on success, -1 on failure
898 * This is an optional function that can be used to set the driver to
899 * require protection for Tx and/or Rx frames. This uses the layer
900 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
901 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
902 * set protection operation; instead, they set protection implicitly
903 * based on configured keys.
905 int (*mlme_setprotection
)(void *priv
, const u8
*addr
, int protect_type
,
909 * get_hw_feature_data - Get hardware support data (channels and rates)
910 * @priv: Private driver interface data
911 * @num_modes: Variable for returning the number of returned modes
912 * flags: Variable for returning hardware feature flags
913 * Returns: Pointer to allocated hardware data on success or %NULL on
914 * failure. Caller is responsible for freeing this.
916 * This function is only needed for drivers that export MLME
917 * (management frame processing) to wpa_supplicant.
919 struct hostapd_hw_modes
* (*get_hw_feature_data
)(void *priv
,
924 * set_channel - Set channel
925 * @priv: Private driver interface data
926 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
927 * @chan: IEEE 802.11 channel number
928 * @freq: Frequency of the channel in MHz
929 * Returns: 0 on success, -1 on failure
931 * This function is only needed for drivers that export MLME
932 * (management frame processing) to wpa_supplicant.
934 int (*set_channel
)(void *priv
, hostapd_hw_mode phymode
, int chan
,
938 * set_ssid - Set SSID
939 * @priv: Private driver interface data
941 * @ssid_len: SSID length
942 * Returns: 0 on success, -1 on failure
944 * This function is only needed for drivers that export MLME
945 * (management frame processing) to wpa_supplicant.
947 int (*set_ssid
)(void *priv
, const u8
*ssid
, size_t ssid_len
);
950 * set_bssid - Set BSSID
951 * @priv: Private driver interface data
953 * Returns: 0 on success, -1 on failure
955 * This function is only needed for drivers that export MLME
956 * (management frame processing) to wpa_supplicant.
958 int (*set_bssid
)(void *priv
, const u8
*bssid
);
961 * send_mlme - Send management frame from MLME
962 * @priv: Private driver interface data
963 * @data: IEEE 802.11 management frame with IEEE 802.11 header
964 * @data_len: Size of the management frame
965 * Returns: 0 on success, -1 on failure
967 * This function is only needed for drivers that export MLME
968 * (management frame processing) to wpa_supplicant.
970 int (*send_mlme
)(void *priv
, const u8
*data
, size_t data_len
);
973 * mlme_add_sta - Add a STA entry into the driver/netstack
974 * @priv: Private driver interface data
975 * @addr: MAC address of the STA (e.g., BSSID of the AP)
976 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
977 * format (one octet per rate, 1 = 0.5 Mbps)
978 * @supp_rates_len: Number of entries in supp_rates
979 * Returns: 0 on success, -1 on failure
981 * This function is only needed for drivers that export MLME
982 * (management frame processing) to wpa_supplicant. When the MLME code
983 * completes association with an AP, this function is called to
984 * configure the driver/netstack with a STA entry for data frame
985 * processing (TX rate control, encryption/decryption).
987 int (*mlme_add_sta
)(void *priv
, const u8
*addr
, const u8
*supp_rates
,
988 size_t supp_rates_len
);
991 * mlme_remove_sta - Remove a STA entry from the driver/netstack
992 * @priv: Private driver interface data
993 * @addr: MAC address of the STA (e.g., BSSID of the AP)
994 * Returns: 0 on success, -1 on failure
996 * This function is only needed for drivers that export MLME
997 * (management frame processing) to wpa_supplicant.
999 int (*mlme_remove_sta
)(void *priv
, const u8
*addr
);
1002 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1003 * @priv: Private driver interface data
1004 * @md: Mobility domain (2 octets) (also included inside ies)
1005 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1006 * @ies_len: Length of FT IEs in bytes
1007 * Returns: 0 on success, -1 on failure
1009 * The supplicant uses this callback to let the driver know that keying
1010 * material for FT is available and that the driver can use the
1011 * provided IEs in the next message in FT authentication sequence.
1013 * This function is only needed for driver that support IEEE 802.11r
1014 * (Fast BSS Transition).
1016 int (*update_ft_ies
)(void *priv
, const u8
*md
, const u8
*ies
,
1020 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1021 * @priv: Private driver interface data
1022 * @action: Action field value
1023 * @target_ap: Target AP address
1024 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1025 * @ies_len: Length of FT IEs in bytes
1026 * Returns: 0 on success, -1 on failure
1028 * The supplicant uses this callback to request the driver to transmit
1029 * an FT Action frame (action category 6) for over-the-DS fast BSS
1032 int (*send_ft_action
)(void *priv
, u8 action
, const u8
*target_ap
,
1033 const u8
*ies
, size_t ies_len
);
1036 * get_scan_results2 - Fetch the latest scan results
1037 * @priv: private driver interface data
1039 * Returns: Allocated buffer of scan results (caller is responsible for
1040 * freeing the data structure) on success, NULL on failure
1042 struct wpa_scan_results
* (*get_scan_results2
)(void *priv
);
1045 * set_probe_req_ie - Set information element(s) for Probe Request
1046 * @priv: private driver interface data
1047 * @ies: Information elements to append or %NULL to remove extra IEs
1048 * @ies_len: Length of the IE buffer in octets
1049 * Returns: 0 on success, -1 on failure
1051 int (*set_probe_req_ie
)(void *priv
, const u8
*ies
, size_t ies_len
);
1054 * set_country - Set country
1055 * @priv: Private driver interface data
1056 * @alpha2: country to which to switch to
1057 * Returns: 0 on success, -1 on failure
1059 * This function is for drivers which support some form
1060 * of setting a regulatory domain.
1062 int (*set_country
)(void *priv
, const char *alpha2
);
1065 * global_init - Global driver initialization
1066 * Returns: Pointer to private data (global), %NULL on failure
1068 * This optional function is called to initialize the driver wrapper
1069 * for global data, i.e., data that applies to all interfaces. If this
1070 * function is implemented, global_deinit() will also need to be
1071 * implemented to free the private data. The driver will also likely
1072 * use init2() function instead of init() to get the pointer to global
1073 * data available to per-interface initializer.
1075 void * (*global_init
)(void);
1078 * global_deinit - Global driver deinitialization
1079 * @priv: private driver global data from global_init()
1081 * Terminate any global driver related functionality and free the
1082 * global data structure.
1084 void (*global_deinit
)(void *priv
);
1087 * init2 - Initialize driver interface (with global data)
1088 * @ctx: context to be used when calling wpa_supplicant functions,
1089 * e.g., wpa_supplicant_event()
1090 * @ifname: interface name, e.g., wlan0
1091 * @global_priv: private driver global data from global_init()
1092 * Returns: Pointer to private data, %NULL on failure
1094 * This function can be used instead of init() if the driver wrapper
1097 void * (*init2
)(void *ctx
, const char *ifname
, void *global_priv
);
1100 * get_interfaces - Get information about available interfaces
1101 * @global_priv: private driver global data from global_init()
1102 * Returns: Allocated buffer of interface information (caller is
1103 * responsible for freeing the data structure) on success, NULL on
1106 struct wpa_interface_info
* (*get_interfaces
)(void *global_priv
);
1109 * scan2 - Request the driver to initiate scan
1110 * @priv: private driver interface data
1111 * @params: Scan parameters
1113 * Returns: 0 on success, -1 on failure
1115 * Once the scan results are ready, the driver should report scan
1116 * results event for wpa_supplicant which will eventually request the
1117 * results with wpa_driver_get_scan_results2().
1119 int (*scan2
)(void *priv
, struct wpa_driver_scan_params
*params
);
1122 * authenticate - Request driver to authenticate
1123 * @priv: private driver interface data
1124 * @params: authentication parameters
1125 * Returns: 0 on success, -1 on failure
1127 * This is an optional function that can be used with drivers that
1128 * support separate authentication and association steps, i.e., when
1129 * wpa_supplicant can act as the SME. If not implemented, associate()
1130 * function is expected to take care of IEEE 802.11 authentication,
1133 int (*authenticate
)(void *priv
,
1134 struct wpa_driver_auth_params
*params
);
1136 int (*set_beacon
)(const char *ifname
, void *priv
,
1137 const u8
*head
, size_t head_len
,
1138 const u8
*tail
, size_t tail_len
, int dtim_period
,
1141 void * (*hapd_init
)(struct hostapd_data
*hapd
,
1142 struct wpa_init_params
*params
);
1143 void (*hapd_deinit
)(void *priv
);
1146 * set_8021x - enable/disable IEEE 802.1X support
1147 * @ifname: Interface name (for multi-SSID/VLAN support)
1148 * @priv: driver private data
1149 * @enabled: 1 = enable, 0 = disable
1151 * Returns: 0 on success, -1 on failure
1153 * Configure the kernel driver to enable/disable 802.1X support.
1154 * This may be an empty function if 802.1X support is always enabled.
1156 int (*set_ieee8021x
)(const char *ifname
, void *priv
, int enabled
);
1159 * set_privacy - enable/disable privacy
1160 * @priv: driver private data
1161 * @enabled: 1 = privacy enabled, 0 = disabled
1163 * Return: 0 on success, -1 on failure
1165 * Configure privacy.
1167 int (*set_privacy
)(const char *ifname
, void *priv
, int enabled
);
1169 int (*get_seqnum
)(const char *ifname
, void *priv
, const u8
*addr
,
1171 int (*get_seqnum_igtk
)(const char *ifname
, void *priv
, const u8
*addr
,
1173 int (*flush
)(void *priv
);
1174 int (*set_generic_elem
)(const char *ifname
, void *priv
, const u8
*elem
,
1177 int (*read_sta_data
)(void *priv
, struct hostap_sta_driver_data
*data
,
1179 int (*hapd_send_eapol
)(void *priv
, const u8
*addr
, const u8
*data
,
1180 size_t data_len
, int encrypt
,
1181 const u8
*own_addr
);
1182 int (*sta_deauth
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
1184 int (*sta_disassoc
)(void *priv
, const u8
*own_addr
, const u8
*addr
,
1186 int (*sta_remove
)(void *priv
, const u8
*addr
);
1187 int (*hapd_get_ssid
)(const char *ifname
, void *priv
, u8
*buf
, int len
);
1188 int (*hapd_set_ssid
)(const char *ifname
, void *priv
, const u8
*buf
,
1190 int (*hapd_set_countermeasures
)(void *priv
, int enabled
);
1191 int (*sta_add
)(const char *ifname
, void *priv
,
1192 struct hostapd_sta_add_params
*params
);
1193 int (*get_inact_sec
)(void *priv
, const u8
*addr
);
1194 int (*sta_clear_stats
)(void *priv
, const u8
*addr
);
1196 int (*set_freq
)(void *priv
, struct hostapd_freq_params
*freq
);
1197 int (*set_rts
)(void *priv
, int rts
);
1198 int (*set_frag
)(void *priv
, int frag
);
1200 int (*sta_set_flags
)(void *priv
, const u8
*addr
,
1201 int total_flags
, int flags_or
, int flags_and
);
1202 int (*set_rate_sets
)(void *priv
, int *supp_rates
, int *basic_rates
,
1205 /* Configure internal bridge:
1206 * 0 = disabled, i.e., client separation is enabled (no bridging of
1207 * packets between associated STAs
1208 * 1 = enabled, i.e., bridge packets between associated STAs (default)
1210 int (*set_internal_bridge
)(void *priv
, int value
);
1211 int (*set_cts_protect
)(void *priv
, int value
);
1212 int (*set_preamble
)(void *priv
, int value
);
1213 int (*set_short_slot_time
)(void *priv
, int value
);
1214 int (*set_tx_queue_params
)(void *priv
, int queue
, int aifs
, int cw_min
,
1215 int cw_max
, int burst_time
);
1216 int (*bss_add
)(void *priv
, const char *ifname
, const u8
*bssid
);
1217 int (*bss_remove
)(void *priv
, const char *ifname
);
1218 int (*valid_bss_mask
)(void *priv
, const u8
*addr
, const u8
*mask
);
1219 int (*if_add
)(const char *iface
, void *priv
,
1220 enum hostapd_driver_if_type type
, char *ifname
,
1222 int (*if_update
)(void *priv
, enum hostapd_driver_if_type type
,
1223 char *ifname
, const u8
*addr
);
1224 int (*if_remove
)(void *priv
, enum hostapd_driver_if_type type
,
1225 const char *ifname
, const u8
*addr
);
1226 int (*set_sta_vlan
)(void *priv
, const u8
*addr
, const char *ifname
,
1229 * commit - Optional commit changes handler
1230 * @priv: driver private data
1231 * Returns: 0 on success, -1 on failure
1233 * This optional handler function can be registered if the driver
1234 * interface implementation needs to commit changes (e.g., by setting
1235 * network interface up) at the end of initial configuration. If set,
1236 * this handler will be called after initial setup has been completed.
1238 int (*commit
)(void *priv
);
1240 int (*send_ether
)(void *priv
, const u8
*dst
, const u8
*src
, u16 proto
,
1241 const u8
*data
, size_t data_len
);
1243 int (*set_radius_acl_auth
)(void *priv
, const u8
*mac
, int accepted
,
1244 u32 session_timeout
);
1245 int (*set_radius_acl_expire
)(void *priv
, const u8
*mac
);
1247 int (*set_ht_params
)(const char *ifname
, void *priv
,
1248 const u8
*ht_capab
, size_t ht_capab_len
,
1249 const u8
*ht_oper
, size_t ht_oper_len
);
1251 int (*set_wps_beacon_ie
)(const char *ifname
, void *priv
,
1252 const u8
*ie
, size_t len
);
1253 int (*set_wps_probe_resp_ie
)(const char *ifname
, void *priv
,
1254 const u8
*ie
, size_t len
);
1257 * set_supp_port - Set IEEE 802.1X Supplicant Port status
1258 * @priv: Private driver interface data
1259 * @authorized: Whether the port is authorized
1260 * Returns: 0 on success, -1 on failure
1262 int (*set_supp_port
)(void *priv
, int authorized
);
1266 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1268 typedef enum wpa_event_type
{
1270 * EVENT_ASSOC - Association completed
1272 * This event needs to be delivered when the driver completes IEEE
1273 * 802.11 association or reassociation successfully.
1274 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1275 * after this event has been generated. In addition, optional
1276 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1277 * more information about the association. If the driver interface gets
1278 * both of these events at the same time, it can also include the
1279 * assoc_info data in EVENT_ASSOC call.
1284 * EVENT_DISASSOC - Association lost
1286 * This event should be called when association is lost either due to
1287 * receiving deauthenticate or disassociate frame from the AP or when
1288 * sending either of these frames to the current AP. If the driver
1289 * supports separate deauthentication event, EVENT_DISASSOC should only
1290 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1295 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1297 * This event must be delivered when a Michael MIC error is detected by
1298 * the local driver. Additional data for event processing is
1299 * provided with union wpa_event_data::michael_mic_failure. This
1300 * information is used to request new encyption key and to initiate
1301 * TKIP countermeasures if needed.
1303 EVENT_MICHAEL_MIC_FAILURE
,
1306 * EVENT_SCAN_RESULTS - Scan results available
1308 * This event must be called whenever scan results are available to be
1309 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1310 * is expected to be used some time after struct wpa_driver_ops::scan()
1311 * is called. If the driver provides an unsolicited event when the scan
1312 * has been completed, this event can be used to trigger
1313 * EVENT_SCAN_RESULTS call. If such event is not available from the
1314 * driver, the driver wrapper code is expected to use a registered
1315 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1316 * scan is expected to be completed.
1321 * EVENT_ASSOCINFO - Report optional extra information for association
1323 * This event can be used to report extra association information for
1324 * EVENT_ASSOC processing. This extra information includes IEs from
1325 * association frames and Beacon/Probe Response frames in union
1326 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1327 * EVENT_ASSOC. Alternatively, the driver interface can include
1328 * assoc_info data in the EVENT_ASSOC call if it has all the
1329 * information available at the same point.
1334 * EVENT_INTERFACE_STATUS - Report interface status changes
1336 * This optional event can be used to report changes in interface
1337 * status (interface added/removed) using union
1338 * wpa_event_data::interface_status. This can be used to trigger
1339 * wpa_supplicant to stop and re-start processing for the interface,
1340 * e.g., when a cardbus card is ejected/inserted.
1342 EVENT_INTERFACE_STATUS
,
1345 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1347 * This event can be used to inform wpa_supplicant about candidates for
1348 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1349 * for scan request (ap_scan=2 mode), this event is required for
1350 * pre-authentication. If wpa_supplicant is performing scan request
1351 * (ap_scan=1), this event is optional since scan results can be used
1352 * to add pre-authentication candidates. union
1353 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1354 * candidate and priority of the candidate, e.g., based on the signal
1355 * strength, in order to try to pre-authenticate first with candidates
1356 * that are most likely targets for re-association.
1358 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1359 * on the candidate list. In addition, it can be called for the current
1360 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1361 * will automatically skip pre-authentication in cases where a valid
1362 * PMKSA exists. When more than one candidate exists, this event should
1363 * be generated once for each candidate.
1365 * Driver will be notified about successful pre-authentication with
1366 * struct wpa_driver_ops::add_pmkid() calls.
1368 EVENT_PMKID_CANDIDATE
,
1371 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1373 * This event can be used to inform wpa_supplicant about desire to set
1374 * up secure direct link connection between two stations as defined in
1375 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1376 * STAKey negotiation. The caller will need to set peer address for the
1382 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1384 * The driver is expected to report the received FT IEs from
1385 * FT authentication sequence from the AP. The FT IEs are included in
1386 * the extra information in union wpa_event_data::ft_ies.
1391 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
1393 * The driver can use this event to inform wpa_supplicant about a STA
1394 * in an IBSS with which protected frames could be exchanged. This
1395 * event starts RSN authentication with the other STA to authenticate
1396 * the STA and set up encryption keys with it.
1398 EVENT_IBSS_RSN_START
,
1401 * EVENT_AUTH - Authentication result
1403 * This event should be called when authentication attempt has been
1404 * completed. This is only used if the driver supports separate
1405 * authentication step (struct wpa_driver_ops::authenticate).
1406 * Information about authentication result is included in
1407 * union wpa_event_data::auth.
1412 * EVENT_DEAUTH - Authentication lost
1414 * This event should be called when authentication is lost either due
1415 * to receiving deauthenticate frame from the AP or when sending that
1416 * frame to the current AP.
1421 * EVENT_ASSOC_REJECT - Association rejected
1423 * This event should be called when (re)association attempt has been
1424 * rejected by the AP. Information about authentication result is
1425 * included in union wpa_event_data::assoc_reject.
1430 * EVENT_AUTH_TIMED_OUT - Authentication timed out
1432 EVENT_AUTH_TIMED_OUT
,
1435 * EVENT_ASSOC_TIMED_OUT - Association timed out
1437 EVENT_ASSOC_TIMED_OUT
1442 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
1444 union wpa_event_data
{
1446 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
1448 * This structure is optional for EVENT_ASSOC calls and required for
1449 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
1450 * driver interface does not need to generate separate EVENT_ASSOCINFO
1455 * req_ies - (Re)Association Request IEs
1457 * If the driver generates WPA/RSN IE, this event data must be
1458 * returned for WPA handshake to have needed information. If
1459 * wpa_supplicant-generated WPA/RSN IE is used, this
1460 * information event is optional.
1462 * This should start with the first IE (fixed fields before IEs
1463 * are not included).
1468 * req_ies_len - Length of req_ies in bytes
1473 * resp_ies - (Re)Association Response IEs
1475 * Optional association data from the driver. This data is not
1476 * required WPA, but may be useful for some protocols and as
1477 * such, should be reported if this is available to the driver
1480 * This should start with the first IE (fixed fields before IEs
1481 * are not included).
1486 * resp_ies_len - Length of resp_ies in bytes
1488 size_t resp_ies_len
;
1491 * beacon_ies - Beacon or Probe Response IEs
1493 * Optional Beacon/ProbeResp data: IEs included in Beacon or
1494 * Probe Response frames from the current AP (i.e., the one
1495 * that the client just associated with). This information is
1496 * used to update WPA/RSN IE for the AP. If this field is not
1497 * set, the results from previous scan will be used. If no
1498 * data for the new AP is found, scan results will be requested
1499 * again (without scan request). At this point, the driver is
1500 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
1503 * This should start with the first IE (fixed fields before IEs
1504 * are not included).
1509 * beacon_ies_len - Length of beacon_ies */
1510 size_t beacon_ies_len
;
1514 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
1516 struct michael_mic_failure
{
1519 } michael_mic_failure
;
1522 * struct interface_status - Data for EVENT_INTERFACE_STATUS
1524 struct interface_status
{
1527 EVENT_INTERFACE_ADDED
, EVENT_INTERFACE_REMOVED
1532 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
1534 struct pmkid_candidate
{
1535 /** BSSID of the PMKID candidate */
1537 /** Smaller the index, higher the priority */
1539 /** Whether RSN IE includes pre-authenticate flag */
1544 * struct stkstart - Data for EVENT_STKSTART
1551 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
1553 * During FT (IEEE 802.11r) authentication sequence, the driver is
1554 * expected to use this event to report received FT IEs (MDIE, FTIE,
1555 * RSN IE, TIE, possible resource request) to the supplicant. The FT
1556 * IEs for the next message will be delivered through the
1557 * struct wpa_driver_ops::update_ft_ies() callback.
1563 u8 target_ap
[ETH_ALEN
];
1564 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
1566 /** Length of ric_ies buffer in octets */
1571 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
1573 struct ibss_rsn_start
{
1578 * struct auth_info - Data for EVENT_AUTH events
1589 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
1591 struct assoc_reject
{
1593 * resp_ies - (Re)Association Response IEs
1595 * Optional association data from the driver. This data is not
1596 * required WPA, but may be useful for some protocols and as
1597 * such, should be reported if this is available to the driver
1600 * This should start with the first IE (fixed fields before IEs
1601 * are not included).
1606 * resp_ies_len - Length of resp_ies in bytes
1608 size_t resp_ies_len
;
1611 * status_code - Status Code from (Re)association Response
1616 struct timeout_event
{
1622 * wpa_supplicant_event - Report a driver event for wpa_supplicant
1623 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1624 * with struct wpa_driver_ops::init()
1625 * @event: event type (defined above)
1626 * @data: possible extra data for the event
1628 * Driver wrapper code should call this function whenever an event is received
1631 void wpa_supplicant_event(void *ctx
, wpa_event_type event
,
1632 union wpa_event_data
*data
);
1635 * wpa_supplicant_rx_eapol - Deliver a received EAPOL frame to wpa_supplicant
1636 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1637 * with struct wpa_driver_ops::init()
1638 * @src_addr: Source address of the EAPOL frame
1639 * @buf: EAPOL data starting from the EAPOL header (i.e., no Ethernet header)
1640 * @len: Length of the EAPOL data
1642 * This function is called for each received EAPOL frame. Most driver
1643 * interfaces rely on more generic OS mechanism for receiving frames through
1644 * l2_packet, but if such a mechanism is not available, the driver wrapper may
1645 * take care of received EAPOL frames and deliver them to the core supplicant
1646 * code by calling this function.
1648 void wpa_supplicant_rx_eapol(void *ctx
, const u8
*src_addr
,
1649 const u8
*buf
, size_t len
);
1651 void wpa_supplicant_sta_rx(void *ctx
, const u8
*buf
, size_t len
,
1652 struct ieee80211_rx_status
*rx_status
);
1654 const u8
* wpa_scan_get_ie(const struct wpa_scan_res
*res
, u8 ie
);
1655 #define WPA_IE_VENDOR_TYPE 0x0050f201
1656 #define WPS_IE_VENDOR_TYPE 0x0050f204
1657 const u8
* wpa_scan_get_vendor_ie(const struct wpa_scan_res
*res
,
1659 struct wpabuf
* wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res
*res
,
1661 int wpa_scan_get_max_rate(const struct wpa_scan_res
*res
);
1662 void wpa_scan_results_free(struct wpa_scan_results
*res
);
1663 void wpa_scan_sort_results(struct wpa_scan_results
*res
);
1665 /* hostapd functions for driver wrappers */
1668 struct ieee80211_hdr
;
1670 void hostapd_new_assoc_sta(struct hostapd_data
*hapd
, struct sta_info
*sta
,
1672 void hostapd_tx_status(struct hostapd_data
*hapd
, const u8
*addr
,
1673 const u8
*buf
, size_t len
, int ack
);
1674 void hostapd_rx_from_unknown_sta(struct hostapd_data
*hapd
,
1675 const struct ieee80211_hdr
*hdr
, size_t len
);
1676 int hostapd_notif_assoc(struct hostapd_data
*hapd
, const u8
*addr
,
1677 const u8
*ie
, size_t ielen
);
1678 void hostapd_notif_disassoc(struct hostapd_data
*hapd
, const u8
*addr
);
1679 void hostapd_eapol_receive(struct hostapd_data
*hapd
, const u8
*sa
,
1680 const u8
*buf
, size_t len
);
1682 struct hostapd_frame_info
{
1689 void hostapd_mgmt_rx(struct hostapd_data
*hapd
, u8
*buf
, size_t len
,
1690 u16 stype
, struct hostapd_frame_info
*fi
);
1691 void hostapd_mgmt_tx_cb(struct hostapd_data
*hapd
, u8
*buf
, size_t len
,
1693 void hostapd_michael_mic_failure(struct hostapd_data
*hapd
, const u8
*addr
);
1694 struct hostapd_data
* hostapd_sta_get_bss(struct hostapd_data
*hapd
,
1696 void hostapd_probe_req_rx(struct hostapd_data
*hapd
, const u8
*sa
,
1697 const u8
*ie
, size_t ie_len
);
1699 #endif /* DRIVER_H */