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;
511 * struct wpa_driver_ops - Driver interface API definition
513 * This structure defines the API that each driver interface needs to implement
514 * for core wpa_supplicant code. All driver specific functionality is captured
517 struct wpa_driver_ops {
518 /** Name of the driver interface */
520 /** One line description of the driver interface */
524 * get_bssid - Get the current BSSID
525 * @priv: private driver interface data
526 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
528 * Returns: 0 on success, -1 on failure
530 * Query kernel driver for the current BSSID and copy it to bssid.
531 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
534 int (*get_bssid)(void *priv, u8 *bssid);
537 * get_ssid - Get the current SSID
538 * @priv: private driver interface data
539 * @ssid: buffer for SSID (at least 32 bytes)
541 * Returns: Length of the SSID on success, -1 on failure
543 * Query kernel driver for the current SSID and copy it to ssid.
544 * Returning zero is recommended if the STA is not associated.
546 * Note: SSID is an array of octets, i.e., it is not nul terminated and
547 * can, at least in theory, contain control characters (including nul)
548 * and as such, should be processed as binary data, not a printable
551 int (*get_ssid)(void *priv, u8 *ssid);
554 * set_wpa - Enable/disable WPA support (OBSOLETE)
555 * @priv: private driver interface data
556 * @enabled: 1 = enable, 0 = disable
558 * Returns: 0 on success, -1 on failure
560 * Note: This function is included for backwards compatibility. This is
561 * called only just after init and just before deinit, so these
562 * functions can be used to implement same functionality and the driver
563 * interface need not define this function.
565 * Configure the kernel driver to enable/disable WPA support. This may
566 * be empty function, if WPA support is always enabled. Common
567 * configuration items are WPA IE (clearing it when WPA support is
568 * disabled), Privacy flag configuration for capability field (note:
569 * this the value need to set in associate handler to allow plaintext
570 * mode to be used) when trying to associate with, roaming mode (can
571 * allow wpa_supplicant to control roaming if ap_scan=1 is used;
572 * however, drivers can also implement roaming if desired, especially
573 * ap_scan=2 mode is used for this).
575 int (*set_wpa)(void *priv, int enabled);
578 * set_key - Configure encryption key
579 * @priv: private driver interface data
580 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP,
581 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK);
582 * %WPA_ALG_NONE clears the key.
583 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for
584 * broadcast/default keys
585 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for
587 * @set_tx: configure this key as the default Tx key (only used when
588 * driver does not support separate unicast/individual key
589 * @seq: sequence number/packet number, seq_len octets, the next
590 * packet number to be used for in replay protection; configured
591 * for Rx keys (in most cases, this is only used with broadcast
592 * keys and set to zero for unicast keys)
593 * @seq_len: length of the seq, depends on the algorithm:
594 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets
595 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key,
597 * @key_len: length of the key buffer in octets (WEP: 5 or 13,
598 * TKIP: 32, CCMP: 16, IGTK: 16)
600 * Returns: 0 on success, -1 on failure
602 * Configure the given key for the kernel driver. If the driver
603 * supports separate individual keys (4 default keys + 1 individual),
604 * addr can be used to determine whether the key is default or
605 * individual. If only 4 keys are supported, the default key with key
606 * index 0 is used as the individual key. STA must be configured to use
607 * it as the default Tx key (set_tx is set) and accept Rx for all the
608 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
609 * broadcast keys, so key index 0 is available for this kind of
612 * Please note that TKIP keys include separate TX and RX MIC keys and
613 * some drivers may expect them in different order than wpa_supplicant
614 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
615 * will tricker Michael MIC errors. This can be fixed by changing the
616 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key
617 * in driver_*.c set_key() implementation, see driver_ndis.c for an
618 * example on how this can be done.
620 int (*set_key)(void *priv, wpa_alg alg, const u8 *addr,
621 int key_idx, int set_tx, const u8 *seq, size_t seq_len,
622 const u8 *key, size_t key_len);
625 * init - Initialize driver interface
626 * @ctx: context to be used when calling wpa_supplicant functions,
627 * e.g., wpa_supplicant_event()
628 * @ifname: interface name, e.g., wlan0
630 * Returns: Pointer to private data, %NULL on failure
632 * Initialize driver interface, including event processing for kernel
633 * driver events (e.g., associated, scan results, Michael MIC failure).
634 * This function can allocate a private configuration data area for
635 * @ctx, file descriptor, interface name, etc. information that may be
636 * needed in future driver operations. If this is not used, non-NULL
637 * value will need to be returned because %NULL is used to indicate
638 * failure. The returned value will be used as 'void *priv' data for
639 * all other driver_ops functions.
641 * The main event loop (eloop.c) of wpa_supplicant can be used to
642 * register callback for read sockets (eloop_register_read_sock()).
644 * See below for more information about events and
645 * wpa_supplicant_event() function.
647 void * (*init)(void *ctx, const char *ifname);
650 * deinit - Deinitialize driver interface
651 * @priv: private driver interface data from init()
653 * Shut down driver interface and processing of driver events. Free
654 * private data buffer if one was allocated in init() handler.
656 void (*deinit)(void *priv);
659 * set_param - Set driver configuration parameters
660 * @priv: private driver interface data from init()
661 * @param: driver specific configuration parameters
663 * Returns: 0 on success, -1 on failure
665 * Optional handler for notifying driver interface about configuration
666 * parameters (driver_param).
668 int (*set_param)(void *priv, const char *param);
671 * set_countermeasures - Enable/disable TKIP countermeasures
672 * @priv: private driver interface data
673 * @enabled: 1 = countermeasures enabled, 0 = disabled
675 * Returns: 0 on success, -1 on failure
677 * Configure TKIP countermeasures. When these are enabled, the driver
678 * should drop all received and queued frames that are using TKIP.
680 int (*set_countermeasures)(void *priv, int enabled);
683 * set_drop_unencrypted - Enable/disable unencrypted frame filtering
684 * @priv: private driver interface data
685 * @enabled: 1 = unencrypted Tx/Rx frames will be dropped, 0 = disabled
687 * Returns: 0 on success, -1 on failure
689 * Configure the driver to drop all non-EAPOL frames (both receive and
690 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
691 * still be allowed for key negotiation.
693 * This function is deprecated. New driver wrapper implementations
694 * should use associate() parameter drop_unencrypted instead.
696 int (*set_drop_unencrypted)(void *priv, int enabled);
699 * scan - Request the driver to initiate scan (old version)
700 * @priv: private driver interface data
701 * @ssid: specific SSID to scan for (ProbeReq) or %NULL to scan for
702 * all SSIDs (either active scan with wildcard SSID or passive
704 * @ssid_len: length of the SSID
706 * Returns: 0 on success, -1 on failure
708 * Once the scan results are ready, the driver should report scan
709 * results event for wpa_supplicant which will eventually request the
710 * results with wpa_driver_get_scan_results().
712 * This function is deprecated. New driver wrapper implementations
713 * should implement support for scan2().
715 int (*scan)(void *priv, const u8 *ssid, size_t ssid_len);
718 * get_scan_results - Fetch the latest scan results (old version)
719 * @priv: private driver interface data
720 * @results: pointer to buffer for scan results
721 * @max_size: maximum number of entries (buffer size)
723 * Returns: Number of scan result entries used on success, -1 on
726 * If scan results include more than max_size BSSes, max_size will be
727 * returned and the remaining entries will not be included in the
730 * This function is deprecated. New driver wrapper implementations
731 * should implement support for get_scan_results2().
733 int (*get_scan_results)(void *priv,
734 struct wpa_scan_result *results,
738 * deauthenticate - Request driver to deauthenticate
739 * @priv: private driver interface data
740 * @addr: peer address (BSSID of the AP)
741 * @reason_code: 16-bit reason code to be sent in the deauthentication
744 * Returns: 0 on success, -1 on failure
746 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code);
749 * disassociate - Request driver to disassociate
750 * @priv: private driver interface data
751 * @addr: peer address (BSSID of the AP)
752 * @reason_code: 16-bit reason code to be sent in the disassociation
755 * Returns: 0 on success, -1 on failure
757 int (*disassociate)(void *priv, const u8 *addr, int reason_code);
760 * associate - Request driver to associate
761 * @priv: private driver interface data
762 * @params: association parameters
764 * Returns: 0 on success, -1 on failure
766 int (*associate)(void *priv,
767 struct wpa_driver_associate_params *params);
770 * set_auth_alg - Set IEEE 802.11 authentication algorithm
771 * @priv: private driver interface data
772 * @auth_alg: bit field of AUTH_ALG_*
774 * If the driver supports more than one authentication algorithm at the
775 * same time, it should configure all supported algorithms. If not, one
776 * algorithm needs to be selected arbitrarily. Open System
777 * authentication should be ok for most cases and it is recommended to
778 * be used if other options are not supported. Static WEP configuration
779 * may also use Shared Key authentication and LEAP requires its own
780 * algorithm number. For LEAP, user can make sure that only one
781 * algorithm is used at a time by configuring LEAP as the only
782 * supported EAP method. This information is also available in
783 * associate() params, so set_auth_alg may not be needed in case of
786 * This function is deprecated. New driver wrapper implementations
787 * should use associate() parameter auth_alg instead.
789 * Returns: 0 on success, -1 on failure
791 int (*set_auth_alg)(void *priv, int auth_alg);
794 * add_pmkid - Add PMKSA cache entry to the driver
795 * @priv: private driver interface data
796 * @bssid: BSSID for the PMKSA cache entry
797 * @pmkid: PMKID for the PMKSA cache entry
799 * Returns: 0 on success, -1 on failure
801 * This function is called when a new PMK is received, as a result of
802 * either normal authentication or RSN pre-authentication.
804 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
805 * associate(), add_pmkid() can be used to add new PMKSA cache entries
806 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
807 * driver_ops function does not need to be implemented. Likewise, if
808 * the driver does not support WPA, this function is not needed.
810 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
813 * remove_pmkid - Remove PMKSA cache entry to the driver
814 * @priv: private driver interface data
815 * @bssid: BSSID for the PMKSA cache entry
816 * @pmkid: PMKID for the PMKSA cache entry
818 * Returns: 0 on success, -1 on failure
820 * This function is called when the supplicant drops a PMKSA cache
821 * entry for any reason.
823 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
824 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
825 * between the driver and wpa_supplicant. If the driver uses wpa_ie
826 * from wpa_supplicant, this driver_ops function does not need to be
827 * implemented. Likewise, if the driver does not support WPA, this
828 * function is not needed.
830 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid);
833 * flush_pmkid - Flush PMKSA cache
834 * @priv: private driver interface data
836 * Returns: 0 on success, -1 on failure
838 * This function is called when the supplicant drops all PMKSA cache
839 * entries for any reason.
841 * If the driver generates RSN IE, i.e., it does not use wpa_ie in
842 * associate(), remove_pmkid() can be used to synchronize PMKSA caches
843 * between the driver and wpa_supplicant. If the driver uses wpa_ie
844 * from wpa_supplicant, this driver_ops function does not need to be
845 * implemented. Likewise, if the driver does not support WPA, this
846 * function is not needed.
848 int (*flush_pmkid)(void *priv);
851 * get_capa - Get driver capabilities
852 * @priv: private driver interface data
854 * Returns: 0 on success, -1 on failure
856 * Get driver/firmware/hardware capabilities.
858 int (*get_capa)(void *priv, struct wpa_driver_capa *capa);
861 * poll - Poll driver for association information
862 * @priv: private driver interface data
864 * This is an option callback that can be used when the driver does not
865 * provide event mechanism for association events. This is called when
866 * receiving WPA EAPOL-Key messages that require association
867 * information. The driver interface is supposed to generate associnfo
868 * event before returning from this callback function. In addition, the
869 * driver interface should generate an association event after having
870 * sent out associnfo.
872 void (*poll)(void *priv);
875 * get_ifname - Get interface name
876 * @priv: private driver interface data
878 * Returns: Pointer to the interface name. This can differ from the
879 * interface name used in init() call. Init() is called first.
881 * This optional function can be used to allow the driver interface to
882 * replace the interface name with something else, e.g., based on an
883 * interface mapping from a more descriptive name.
885 const char * (*get_ifname)(void *priv);
888 * get_mac_addr - Get own MAC address
889 * @priv: private driver interface data
891 * Returns: Pointer to own MAC address or %NULL on failure
893 * This optional function can be used to get the own MAC address of the
894 * device from the driver interface code. This is only needed if the
895 * l2_packet implementation for the OS does not provide easy access to
897 const u8 * (*get_mac_addr)(void *priv);
900 * send_eapol - Optional function for sending EAPOL packets
901 * @priv: private driver interface data
902 * @dest: Destination MAC address
904 * @data: EAPOL packet starting with IEEE 802.1X header
905 * @data_len: Size of the EAPOL packet
907 * Returns: 0 on success, -1 on failure
909 * This optional function can be used to override l2_packet operations
910 * with driver specific functionality. If this function pointer is set,
911 * l2_packet module is not used at all and the driver interface code is
912 * responsible for receiving and sending all EAPOL packets. The
913 * received EAPOL packets are sent to core code by calling
914 * wpa_supplicant_rx_eapol(). The driver interface is required to
915 * implement get_mac_addr() handler if send_eapol() is used.
917 int (*send_eapol)(void *priv, const u8 *dest, u16 proto,
918 const u8 *data, size_t data_len);
921 * set_operstate - Sets device operating state to DORMANT or UP
922 * @priv: private driver interface data
923 * @state: 0 = dormant, 1 = up
924 * Returns: 0 on success, -1 on failure
926 * This is an optional function that can be used on operating systems
927 * that support a concept of controlling network device state from user
928 * space applications. This function, if set, gets called with
929 * state = 1 when authentication has been completed and with state = 0
930 * when connection is lost.
932 int (*set_operstate)(void *priv, int state);
935 * mlme_setprotection - MLME-SETPROTECTION.request primitive
936 * @priv: Private driver interface data
937 * @addr: Address of the station for which to set protection (may be
938 * %NULL for group keys)
939 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
940 * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
941 * Returns: 0 on success, -1 on failure
943 * This is an optional function that can be used to set the driver to
944 * require protection for Tx and/or Rx frames. This uses the layer
945 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
946 * (MLME-SETPROTECTION.request). Many drivers do not use explicit
947 * set protection operation; instead, they set protection implicitly
948 * based on configured keys.
950 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
954 * get_hw_feature_data - Get hardware support data (channels and rates)
955 * @priv: Private driver interface data
956 * @num_modes: Variable for returning the number of returned modes
957 * flags: Variable for returning hardware feature flags
958 * Returns: Pointer to allocated hardware data on success or %NULL on
959 * failure. Caller is responsible for freeing this.
961 * This function is only needed for drivers that export MLME
962 * (management frame processing) to wpa_supplicant.
964 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
969 * set_channel - Set channel
970 * @priv: Private driver interface data
971 * @phymode: HOSTAPD_MODE_IEEE80211B, ..
972 * @chan: IEEE 802.11 channel number
973 * @freq: Frequency of the channel in MHz
974 * Returns: 0 on success, -1 on failure
976 * This function is only needed for drivers that export MLME
977 * (management frame processing) to wpa_supplicant.
979 int (*set_channel)(void *priv, hostapd_hw_mode phymode, int chan,
983 * set_ssid - Set SSID
984 * @priv: Private driver interface data
986 * @ssid_len: SSID length
987 * Returns: 0 on success, -1 on failure
989 * This function is only needed for drivers that export MLME
990 * (management frame processing) to wpa_supplicant.
992 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len);
995 * set_bssid - Set BSSID
996 * @priv: Private driver interface data
998 * Returns: 0 on success, -1 on failure
1000 * This function is only needed for drivers that export MLME
1001 * (management frame processing) to wpa_supplicant.
1003 int (*set_bssid)(void *priv, const u8 *bssid);
1006 * send_mlme - Send management frame from MLME
1007 * @priv: Private driver interface data
1008 * @data: IEEE 802.11 management frame with IEEE 802.11 header
1009 * @data_len: Size of the management frame
1010 * Returns: 0 on success, -1 on failure
1012 * This function is only needed for drivers that export MLME
1013 * (management frame processing) to wpa_supplicant.
1015 int (*send_mlme)(void *priv, const u8 *data, size_t data_len);
1018 * mlme_add_sta - Add a STA entry into the driver/netstack
1019 * @priv: Private driver interface data
1020 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1021 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11
1022 * format (one octet per rate, 1 = 0.5 Mbps)
1023 * @supp_rates_len: Number of entries in supp_rates
1024 * Returns: 0 on success, -1 on failure
1026 * This function is only needed for drivers that export MLME
1027 * (management frame processing) to wpa_supplicant. When the MLME code
1028 * completes association with an AP, this function is called to
1029 * configure the driver/netstack with a STA entry for data frame
1030 * processing (TX rate control, encryption/decryption).
1032 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates,
1033 size_t supp_rates_len);
1036 * mlme_remove_sta - Remove a STA entry from the driver/netstack
1037 * @priv: Private driver interface data
1038 * @addr: MAC address of the STA (e.g., BSSID of the AP)
1039 * Returns: 0 on success, -1 on failure
1041 * This function is only needed for drivers that export MLME
1042 * (management frame processing) to wpa_supplicant.
1044 int (*mlme_remove_sta)(void *priv, const u8 *addr);
1047 * update_ft_ies - Update FT (IEEE 802.11r) IEs
1048 * @priv: Private driver interface data
1049 * @md: Mobility domain (2 octets) (also included inside ies)
1050 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
1051 * @ies_len: Length of FT IEs in bytes
1052 * Returns: 0 on success, -1 on failure
1054 * The supplicant uses this callback to let the driver know that keying
1055 * material for FT is available and that the driver can use the
1056 * provided IEs in the next message in FT authentication sequence.
1058 * This function is only needed for driver that support IEEE 802.11r
1059 * (Fast BSS Transition).
1061 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
1065 * send_ft_action - Send FT Action frame (IEEE 802.11r)
1066 * @priv: Private driver interface data
1067 * @action: Action field value
1068 * @target_ap: Target AP address
1069 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body)
1070 * @ies_len: Length of FT IEs in bytes
1071 * Returns: 0 on success, -1 on failure
1073 * The supplicant uses this callback to request the driver to transmit
1074 * an FT Action frame (action category 6) for over-the-DS fast BSS
1077 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap,
1078 const u8 *ies, size_t ies_len);
1081 * get_scan_results2 - Fetch the latest scan results
1082 * @priv: private driver interface data
1084 * Returns: Allocated buffer of scan results (caller is responsible for
1085 * freeing the data structure) on success, NULL on failure
1087 struct wpa_scan_results * (*get_scan_results2)(void *priv);
1090 * set_probe_req_ie - Set information element(s) for Probe Request
1091 * @priv: private driver interface data
1092 * @ies: Information elements to append or %NULL to remove extra IEs
1093 * @ies_len: Length of the IE buffer in octets
1094 * Returns: 0 on success, -1 on failure
1096 int (*set_probe_req_ie)(void *priv, const u8 *ies, size_t ies_len);
1099 * set_mode - Request driver to set the operating mode
1100 * @priv: private driver interface data
1101 * @mode: Operation mode (infra/ibss) IEEE80211_MODE_*
1103 * This handler will be called before any key configuration and call to
1104 * associate() handler in order to allow the operation mode to be
1105 * configured as early as possible. This information is also available
1106 * in associate() params and as such, driver wrappers may not need
1107 * to implement set_mode() handler.
1109 * This function is deprecated. New driver wrapper implementations
1110 * should use associate() parameter mode instead.
1112 * Returns: 0 on success, -1 on failure
1114 int (*set_mode)(void *priv, int mode);
1117 * set_country - Set country
1118 * @priv: Private driver interface data
1119 * @alpha2: country to which to switch to
1120 * Returns: 0 on success, -1 on failure
1122 * This function is for drivers which support some form
1123 * of setting a regulatory domain.
1125 int (*set_country)(void *priv, const char *alpha2);
1128 * global_init - Global driver initialization
1129 * Returns: Pointer to private data (global), %NULL on failure
1131 * This optional function is called to initialize the driver wrapper
1132 * for global data, i.e., data that applies to all interfaces. If this
1133 * function is implemented, global_deinit() will also need to be
1134 * implemented to free the private data. The driver will also likely
1135 * use init2() function instead of init() to get the pointer to global
1136 * data available to per-interface initializer.
1138 void * (*global_init)(void);
1141 * global_deinit - Global driver deinitialization
1142 * @priv: private driver global data from global_init()
1144 * Terminate any global driver related functionality and free the
1145 * global data structure.
1147 void (*global_deinit)(void *priv);
1150 * init2 - Initialize driver interface (with global data)
1151 * @ctx: context to be used when calling wpa_supplicant functions,
1152 * e.g., wpa_supplicant_event()
1153 * @ifname: interface name, e.g., wlan0
1154 * @global_priv: private driver global data from global_init()
1155 * Returns: Pointer to private data, %NULL on failure
1157 * This function can be used instead of init() if the driver wrapper
1160 void * (*init2)(void *ctx, const char *ifname, void *global_priv);
1163 * get_interfaces - Get information about available interfaces
1164 * @global_priv: private driver global data from global_init()
1165 * Returns: Allocated buffer of interface information (caller is
1166 * responsible for freeing the data structure) on success, NULL on
1169 struct wpa_interface_info * (*get_interfaces)(void *global_priv);
1172 * scan2 - Request the driver to initiate scan
1173 * @priv: private driver interface data
1174 * @params: Scan parameters
1176 * Returns: 0 on success, -1 on failure
1178 * Once the scan results are ready, the driver should report scan
1179 * results event for wpa_supplicant which will eventually request the
1180 * results with wpa_driver_get_scan_results2().
1182 int (*scan2)(void *priv, struct wpa_driver_scan_params *params);
1185 * authenticate - Request driver to authenticate
1186 * @priv: private driver interface data
1187 * @params: authentication parameters
1188 * Returns: 0 on success, -1 on failure
1190 * This is an optional function that can be used with drivers that
1191 * support separate authentication and association steps, i.e., when
1192 * wpa_supplicant can act as the SME. If not implemented, associate()
1193 * function is expected to take care of IEEE 802.11 authentication,
1196 int (*authenticate)(void *priv,
1197 struct wpa_driver_auth_params *params);
1199 int (*set_beacon)(void *priv, const u8 *head, size_t head_len,
1200 const u8 *tail, size_t tail_len, int dtim_period);
1202 int (*set_beacon_int)(void *priv, int value);
1204 void * (*hapd_init)(struct hostapd_data *hapd,
1205 struct wpa_init_params *params);
1206 void (*hapd_deinit)(void *priv);
1209 * set_8021x - enable/disable IEEE 802.1X support
1210 * @ifname: Interface name (for multi-SSID/VLAN support)
1211 * @priv: driver private data
1212 * @enabled: 1 = enable, 0 = disable
1214 * Returns: 0 on success, -1 on failure
1216 * Configure the kernel driver to enable/disable 802.1X support.
1217 * This may be an empty function if 802.1X support is always enabled.
1219 int (*set_ieee8021x)(const char *ifname, void *priv, int enabled);
1222 * set_privacy - enable/disable privacy
1223 * @priv: driver private data
1224 * @enabled: 1 = privacy enabled, 0 = disabled
1226 * Return: 0 on success, -1 on failure
1228 * Configure privacy.
1230 int (*set_privacy)(const char *ifname, void *priv, int enabled);
1232 int (*hapd_set_key)(const char *ifname, void *priv, wpa_alg alg,
1233 const u8 *addr, int key_idx, int set_tx,
1234 const u8 *seq, size_t seq_len,
1235 const u8 *key, size_t key_len);
1236 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
1238 int (*get_seqnum_igtk)(const char *ifname, void *priv, const u8 *addr,
1240 int (*flush)(void *priv);
1241 int (*set_generic_elem)(const char *ifname, void *priv, const u8 *elem,
1244 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
1246 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
1247 size_t data_len, int encrypt,
1248 const u8 *own_addr);
1249 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
1251 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
1253 int (*sta_remove)(void *priv, const u8 *addr);
1254 int (*hapd_get_ssid)(const char *ifname, void *priv, u8 *buf, int len);
1255 int (*hapd_set_ssid)(const char *ifname, void *priv, const u8 *buf,
1257 int (*hapd_set_countermeasures)(void *priv, int enabled);
1258 int (*sta_add)(const char *ifname, void *priv,
1259 struct hostapd_sta_add_params *params);
1260 int (*get_inact_sec)(void *priv, const u8 *addr);
1261 int (*sta_clear_stats)(void *priv, const u8 *addr);
1263 int (*set_freq)(void *priv, struct hostapd_freq_params *freq);
1264 int (*set_rts)(void *priv, int rts);
1265 int (*set_frag)(void *priv, int frag);
1266 int (*set_retry)(void *priv, int short_retry, int long_retry);
1268 int (*sta_set_flags)(void *priv, const u8 *addr,
1269 int total_flags, int flags_or, int flags_and);
1270 int (*set_rate_sets)(void *priv, int *supp_rates, int *basic_rates,
1272 int (*set_ieee80211d)(void *priv, int enabled);
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 /* Configure broadcast SSID mode:
1285 * 0 = include SSID in Beacon frames and reply to Probe Request frames
1286 * that use broadcast SSID
1287 * 1 = hide SSID from Beacon frames and ignore Probe Request frames for
1290 int (*set_broadcast_ssid)(void *priv, int value);
1291 int (*set_cts_protect)(void *priv, int value);
1292 int (*set_preamble)(void *priv, int value);
1293 int (*set_short_slot_time)(void *priv, int value);
1294 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
1295 int cw_max, int burst_time);
1296 int (*bss_add)(void *priv, const char *ifname, const u8 *bssid);
1297 int (*bss_remove)(void *priv, const char *ifname);
1298 int (*valid_bss_mask)(void *priv, const u8 *addr, const u8 *mask);
1299 int (*passive_scan)(void *priv, int now, int our_mode_only,
1300 int interval, int _listen, int *channel,
1302 int (*if_add)(const char *iface, void *priv,
1303 enum hostapd_driver_if_type type, char *ifname,
1305 int (*if_update)(void *priv, enum hostapd_driver_if_type type,
1306 char *ifname, const u8 *addr);
1307 int (*if_remove)(void *priv, enum hostapd_driver_if_type type,
1308 const char *ifname, const u8 *addr);
1309 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
1312 * commit - Optional commit changes handler
1313 * @priv: driver private data
1314 * Returns: 0 on success, -1 on failure
1316 * This optional handler function can be registered if the driver
1317 * interface implementation needs to commit changes (e.g., by setting
1318 * network interface up) at the end of initial configuration. If set,
1319 * this handler will be called after initial setup has been completed.
1321 int (*commit)(void *priv);
1323 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto,
1324 const u8 *data, size_t data_len);
1326 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
1327 u32 session_timeout);
1328 int (*set_radius_acl_expire)(void *priv, const u8 *mac);
1330 int (*set_ht_params)(const char *ifname, void *priv,
1331 const u8 *ht_capab, size_t ht_capab_len,
1332 const u8 *ht_oper, size_t ht_oper_len);
1334 int (*set_wps_beacon_ie)(const char *ifname, void *priv,
1335 const u8 *ie, size_t len);
1336 int (*set_wps_probe_resp_ie)(const char *ifname, void *priv,
1337 const u8 *ie, size_t len);
1341 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
1343 typedef enum wpa_event_type {
1345 * EVENT_ASSOC - Association completed
1347 * This event needs to be delivered when the driver completes IEEE
1348 * 802.11 association or reassociation successfully.
1349 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
1350 * after this event has been generated. In addition, optional
1351 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
1352 * more information about the association. If the driver interface gets
1353 * both of these events at the same time, it can also include the
1354 * assoc_info data in EVENT_ASSOC call.
1359 * EVENT_DISASSOC - Association lost
1361 * This event should be called when association is lost either due to
1362 * receiving deauthenticate or disassociate frame from the AP or when
1363 * sending either of these frames to the current AP. If the driver
1364 * supports separate deauthentication event, EVENT_DISASSOC should only
1365 * be used for disassociation and EVENT_DEAUTH for deauthentication.
1370 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
1372 * This event must be delivered when a Michael MIC error is detected by
1373 * the local driver. Additional data for event processing is
1374 * provided with union wpa_event_data::michael_mic_failure. This
1375 * information is used to request new encyption key and to initiate
1376 * TKIP countermeasures if needed.
1378 EVENT_MICHAEL_MIC_FAILURE,
1381 * EVENT_SCAN_RESULTS - Scan results available
1383 * This event must be called whenever scan results are available to be
1384 * fetched with struct wpa_driver_ops::get_scan_results(). This event
1385 * is expected to be used some time after struct wpa_driver_ops::scan()
1386 * is called. If the driver provides an unsolicited event when the scan
1387 * has been completed, this event can be used to trigger
1388 * EVENT_SCAN_RESULTS call. If such event is not available from the
1389 * driver, the driver wrapper code is expected to use a registered
1390 * timeout to generate EVENT_SCAN_RESULTS call after the time that the
1391 * scan is expected to be completed.
1396 * EVENT_ASSOCINFO - Report optional extra information for association
1398 * This event can be used to report extra association information for
1399 * EVENT_ASSOC processing. This extra information includes IEs from
1400 * association frames and Beacon/Probe Response frames in union
1401 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
1402 * EVENT_ASSOC. Alternatively, the driver interface can include
1403 * assoc_info data in the EVENT_ASSOC call if it has all the
1404 * information available at the same point.
1409 * EVENT_INTERFACE_STATUS - Report interface status changes
1411 * This optional event can be used to report changes in interface
1412 * status (interface added/removed) using union
1413 * wpa_event_data::interface_status. This can be used to trigger
1414 * wpa_supplicant to stop and re-start processing for the interface,
1415 * e.g., when a cardbus card is ejected/inserted.
1417 EVENT_INTERFACE_STATUS,
1420 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
1422 * This event can be used to inform wpa_supplicant about candidates for
1423 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
1424 * for scan request (ap_scan=2 mode), this event is required for
1425 * pre-authentication. If wpa_supplicant is performing scan request
1426 * (ap_scan=1), this event is optional since scan results can be used
1427 * to add pre-authentication candidates. union
1428 * wpa_event_data::pmkid_candidate is used to report the BSSID of the
1429 * candidate and priority of the candidate, e.g., based on the signal
1430 * strength, in order to try to pre-authenticate first with candidates
1431 * that are most likely targets for re-association.
1433 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
1434 * on the candidate list. In addition, it can be called for the current
1435 * AP and APs that have existing PMKSA cache entries. wpa_supplicant
1436 * will automatically skip pre-authentication in cases where a valid
1437 * PMKSA exists. When more than one candidate exists, this event should
1438 * be generated once for each candidate.
1440 * Driver will be notified about successful pre-authentication with
1441 * struct wpa_driver_ops::add_pmkid() calls.
1443 EVENT_PMKID_CANDIDATE,
1446 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request)
1448 * This event can be used to inform wpa_supplicant about desire to set
1449 * up secure direct link connection between two stations as defined in
1450 * IEEE 802.11e with a new PeerKey mechanism that replaced the original
1451 * STAKey negotiation. The caller will need to set peer address for the
1457 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
1459 * The driver is expected to report the received FT IEs from
1460 * FT authentication sequence from the AP. The FT IEs are included in
1461 * the extra information in union wpa_event_data::ft_ies.
1466 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
1468 * The driver can use this event to inform wpa_supplicant about a STA
1469 * in an IBSS with which protected frames could be exchanged. This
1470 * event starts RSN authentication with the other STA to authenticate
1471 * the STA and set up encryption keys with it.
1473 EVENT_IBSS_RSN_START,
1476 * EVENT_AUTH - Authentication result
1478 * This event should be called when authentication attempt has been
1479 * completed. This is only used if the driver supports separate
1480 * authentication step (struct wpa_driver_ops::authenticate).
1481 * Information about authentication result is included in
1482 * union wpa_event_data::auth.
1487 * EVENT_DEAUTH - Authentication lost
1489 * This event should be called when authentication is lost either due
1490 * to receiving deauthenticate frame from the AP or when sending that
1491 * frame to the current AP.
1496 * EVENT_ASSOC_REJECT - Association rejected
1498 * This event should be called when (re)association attempt has been
1499 * rejected by the AP. Information about authentication result is
1500 * included in union wpa_event_data::assoc_reject.
1507 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
1509 union wpa_event_data {
1511 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
1513 * This structure is optional for EVENT_ASSOC calls and required for
1514 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
1515 * driver interface does not need to generate separate EVENT_ASSOCINFO
1520 * req_ies - (Re)Association Request IEs
1522 * If the driver generates WPA/RSN IE, this event data must be
1523 * returned for WPA handshake to have needed information. If
1524 * wpa_supplicant-generated WPA/RSN IE is used, this
1525 * information event is optional.
1527 * This should start with the first IE (fixed fields before IEs
1528 * are not included).
1533 * req_ies_len - Length of req_ies in bytes
1538 * resp_ies - (Re)Association Response IEs
1540 * Optional association data from the driver. This data is not
1541 * required WPA, but may be useful for some protocols and as
1542 * such, should be reported if this is available to the driver
1545 * This should start with the first IE (fixed fields before IEs
1546 * are not included).
1551 * resp_ies_len - Length of resp_ies in bytes
1553 size_t resp_ies_len;
1556 * beacon_ies - Beacon or Probe Response IEs
1558 * Optional Beacon/ProbeResp data: IEs included in Beacon or
1559 * Probe Response frames from the current AP (i.e., the one
1560 * that the client just associated with). This information is
1561 * used to update WPA/RSN IE for the AP. If this field is not
1562 * set, the results from previous scan will be used. If no
1563 * data for the new AP is found, scan results will be requested
1564 * again (without scan request). At this point, the driver is
1565 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
1568 * This should start with the first IE (fixed fields before IEs
1569 * are not included).
1574 * beacon_ies_len - Length of beacon_ies */
1575 size_t beacon_ies_len;
1579 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
1581 struct michael_mic_failure {
1584 } michael_mic_failure;
1587 * struct interface_status - Data for EVENT_INTERFACE_STATUS
1589 struct interface_status {
1592 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
1597 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
1599 struct pmkid_candidate {
1600 /** BSSID of the PMKID candidate */
1602 /** Smaller the index, higher the priority */
1604 /** Whether RSN IE includes pre-authenticate flag */
1609 * struct stkstart - Data for EVENT_STKSTART
1616 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
1618 * During FT (IEEE 802.11r) authentication sequence, the driver is
1619 * expected to use this event to report received FT IEs (MDIE, FTIE,
1620 * RSN IE, TIE, possible resource request) to the supplicant. The FT
1621 * IEs for the next message will be delivered through the
1622 * struct wpa_driver_ops::update_ft_ies() callback.
1628 u8 target_ap[ETH_ALEN];
1629 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
1631 /** Length of ric_ies buffer in octets */
1636 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
1638 struct ibss_rsn_start {
1643 * struct auth_info - Data for EVENT_AUTH events
1654 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
1656 struct assoc_reject {
1658 * resp_ies - (Re)Association Response IEs
1660 * Optional association data from the driver. This data is not
1661 * required WPA, but may be useful for some protocols and as
1662 * such, should be reported if this is available to the driver
1665 * This should start with the first IE (fixed fields before IEs
1666 * are not included).
1671 * resp_ies_len - Length of resp_ies in bytes
1673 size_t resp_ies_len;
1676 * status_code - Status Code from (Re)association Response
1683 * wpa_supplicant_event - Report a driver event for wpa_supplicant
1684 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1685 * with struct wpa_driver_ops::init()
1686 * @event: event type (defined above)
1687 * @data: possible extra data for the event
1689 * Driver wrapper code should call this function whenever an event is received
1692 void wpa_supplicant_event(void *ctx, wpa_event_type event,
1693 union wpa_event_data *data);
1696 * wpa_supplicant_rx_eapol - Deliver a received EAPOL frame to wpa_supplicant
1697 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
1698 * with struct wpa_driver_ops::init()
1699 * @src_addr: Source address of the EAPOL frame
1700 * @buf: EAPOL data starting from the EAPOL header (i.e., no Ethernet header)
1701 * @len: Length of the EAPOL data
1703 * This function is called for each received EAPOL frame. Most driver
1704 * interfaces rely on more generic OS mechanism for receiving frames through
1705 * l2_packet, but if such a mechanism is not available, the driver wrapper may
1706 * take care of received EAPOL frames and deliver them to the core supplicant
1707 * code by calling this function.
1709 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr,
1710 const u8 *buf, size_t len);
1712 void wpa_supplicant_sta_rx(void *ctx, const u8 *buf, size_t len,
1713 struct ieee80211_rx_status *rx_status);
1715 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie);
1716 #define WPA_IE_VENDOR_TYPE 0x0050f201
1717 #define WPS_IE_VENDOR_TYPE 0x0050f204
1718 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res,
1720 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res,
1722 int wpa_scan_get_max_rate(const struct wpa_scan_res *res);
1723 void wpa_scan_results_free(struct wpa_scan_results *res);
1724 void wpa_scan_sort_results(struct wpa_scan_results *res);
1726 /* hostapd functions for driver wrappers */
1730 void hostapd_new_assoc_sta(struct hostapd_data *hapd, struct sta_info *sta,
1732 void hostapd_tx_status(struct hostapd_data *hapd, const u8 *addr,
1733 const u8 *buf, size_t len, int ack);
1734 void hostapd_rx_from_unknown_sta(struct hostapd_data *hapd, const u8 *addr);
1735 int hostapd_notif_assoc(struct hostapd_data *hapd, const u8 *addr,
1736 const u8 *ie, size_t ielen);
1737 void hostapd_notif_disassoc(struct hostapd_data *hapd, const u8 *addr);
1738 void hostapd_eapol_receive(struct hostapd_data *hapd, const u8 *sa,
1739 const u8 *buf, size_t len);
1741 struct hostapd_frame_info {
1747 unsigned int passive_scan:1;
1750 void hostapd_mgmt_rx(struct hostapd_data *hapd, u8 *buf, size_t len,
1751 u16 stype, struct hostapd_frame_info *fi);
1752 void hostapd_mgmt_tx_cb(struct hostapd_data *hapd, u8 *buf, size_t len,
1754 void hostapd_michael_mic_failure(struct hostapd_data *hapd, const u8 *addr);
1755 struct hostapd_data * hostapd_sta_get_bss(struct hostapd_data *hapd,
1758 #endif /* DRIVER_H */