1 /* 2 * WPA Supplicant - driver interface definition 3 * Copyright (c) 2003-2008, Jouni Malinen <j (at) w1.fi> 4 * 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. 8 * 9 * Alternatively, this software may be distributed under the terms of BSD 10 * license. 11 * 12 * See README and COPYING for more details. 13 */ 14 15 #ifndef DRIVER_H 16 #define DRIVER_H 17 18 #define WPA_SUPPLICANT_DRIVER_VERSION 3 19 20 #include "defs.h" 21 22 #define AUTH_ALG_OPEN_SYSTEM 0x01 23 #define AUTH_ALG_SHARED_KEY 0x02 24 #define AUTH_ALG_LEAP 0x04 25 26 #define IEEE80211_MODE_INFRA 0 27 #define IEEE80211_MODE_IBSS 1 28 29 #define IEEE80211_CAP_ESS 0x0001 30 #define IEEE80211_CAP_IBSS 0x0002 31 #define IEEE80211_CAP_PRIVACY 0x0010 32 33 #define SSID_MAX_WPA_IE_LEN 40 34 /** 35 * struct wpa_scan_result - Scan results (old structure) 36 * @bssid: BSSID 37 * @ssid: SSID 38 * @ssid_len: length of the ssid 39 * @wpa_ie: WPA IE 40 * @wpa_ie_len: length of the wpa_ie 41 * @rsn_ie: RSN IE 42 * @rsn_ie_len: length of the RSN IE 43 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1) 44 * @caps: capability information field in host byte order 45 * @qual: signal quality 46 * @noise: noise level 47 * @level: signal level 48 * @maxrate: maximum supported rate 49 * @mdie_present: Whether MDIE was included in Beacon/ProbeRsp frame 50 * @mdie: Mobility domain identifier IE (IEEE 802.11r MDIE) (starting from 51 * IE type field) 52 * @tsf: Timestamp 53 * 54 * This structure is used as a generic format for scan results from the 55 * driver. Each driver interface implementation is responsible for converting 56 * the driver or OS specific scan results into this format. 57 * 58 * This structure is the old data structure used for scan results. It is 59 * obsoleted by the new struct wpa_scan_res structure and the old version is 60 * only included for backwards compatibility with existing driver wrapper 61 * implementations. New implementations are encouraged to implement for struct 62 * wpa_scan_res. The old structure will be removed at some point. 63 */ 64 struct wpa_scan_result { 65 u8 bssid[ETH_ALEN]; 66 u8 ssid[32]; 67 size_t ssid_len; 68 u8 wpa_ie[SSID_MAX_WPA_IE_LEN]; 69 size_t wpa_ie_len; 70 u8 rsn_ie[SSID_MAX_WPA_IE_LEN]; 71 size_t rsn_ie_len; 72 int freq; 73 u16 caps; 74 int qual; 75 int noise; 76 int level; 77 int maxrate; 78 int mdie_present; 79 u8 mdie[5]; 80 u64 tsf; 81 }; 82 83 84 /** 85 * struct wpa_scan_res - Scan result for an BSS/IBSS 86 * @bssid: BSSID 87 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1) 88 * @beacon_int: beacon interval in TUs (host byte order) 89 * @caps: capability information field in host byte order 90 * @qual: signal quality 91 * @noise: noise level 92 * @level: signal level 93 * @tsf: Timestamp 94 * @ie_len: length of the following IE field in octets 95 * 96 * This structure is used as a generic format for scan results from the 97 * driver. Each driver interface implementation is responsible for converting 98 * the driver or OS specific scan results into this format. 99 * 100 * If the driver does not support reporting all IEs, the IE data structure is 101 * constructed of the IEs that are available. This field will also need to 102 * include SSID in IE format. All drivers are encouraged to be extended to 103 * report all IEs to make it easier to support future additions. 104 */ 105 struct wpa_scan_res { 106 u8 bssid[ETH_ALEN]; 107 int freq; 108 u16 beacon_int; 109 u16 caps; 110 int qual; 111 int noise; 112 int level; 113 u64 tsf; 114 size_t ie_len; 115 /* followed by ie_len octets of IEs */ 116 }; 117 118 /** 119 * struct wpa_scan_results - Scan results 120 * @res: Array of pointers to allocated variable length scan result entries 121 * @num: Number of entries in the scan result array 122 */ 123 struct wpa_scan_results { 124 struct wpa_scan_res **res; 125 size_t num; 126 }; 127 128 /** 129 * struct wpa_interface_info - Network interface information 130 * @next: Pointer to the next interface or NULL if this is the last one 131 * @ifname: Interface name that can be used with init() or init2() 132 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if 133 * not available 134 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one 135 * is not an allocated copy, i.e., get_interfaces() caller will not free 136 * this) 137 */ 138 struct wpa_interface_info { 139 struct wpa_interface_info *next; 140 char *ifname; 141 char *desc; 142 const char *drv_name; 143 }; 144 145 /** 146 * struct wpa_driver_associate_params - Association parameters 147 * Data for struct wpa_driver_ops::associate(). 148 */ 149 struct wpa_driver_associate_params { 150 /** 151 * bssid - BSSID of the selected AP 152 * This can be %NULL, if ap_scan=2 mode is used and the driver is 153 * responsible for selecting with which BSS to associate. */ 154 const u8 *bssid; 155 156 /** 157 * ssid - The selected SSID 158 */ 159 const u8 *ssid; 160 size_t ssid_len; 161 162 /** 163 * freq - Frequency of the channel the selected AP is using 164 * Frequency that the selected AP is using (in MHz as 165 * reported in the scan results) 166 */ 167 int freq; 168 169 /** 170 * wpa_ie - WPA information element for (Re)Association Request 171 * WPA information element to be included in (Re)Association 172 * Request (including information element id and length). Use 173 * of this WPA IE is optional. If the driver generates the WPA 174 * IE, it can use pairwise_suite, group_suite, and 175 * key_mgmt_suite to select proper algorithms. In this case, 176 * the driver has to notify wpa_supplicant about the used WPA 177 * IE by generating an event that the interface code will 178 * convert into EVENT_ASSOCINFO data (see below). 179 * 180 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE 181 * instead. The driver can determine which version is used by 182 * looking at the first byte of the IE (0xdd for WPA, 0x30 for 183 * WPA2/RSN). 184 * 185 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE. 186 */ 187 const u8 *wpa_ie; 188 /** 189 * wpa_ie_len - length of the wpa_ie 190 */ 191 size_t wpa_ie_len; 192 193 /* The selected pairwise/group cipher and key management 194 * suites. These are usually ignored if @wpa_ie is used. */ 195 wpa_cipher pairwise_suite; 196 wpa_cipher group_suite; 197 wpa_key_mgmt key_mgmt_suite; 198 199 /** 200 * auth_alg - Allowed authentication algorithms 201 * Bit field of AUTH_ALG_* 202 */ 203 int auth_alg; 204 205 /** 206 * mode - Operation mode (infra/ibss) IEEE80211_MODE_* 207 */ 208 int mode; 209 210 /** 211 * wep_key - WEP keys for static WEP configuration 212 */ 213 const u8 *wep_key[4]; 214 215 /** 216 * wep_key_len - WEP key length for static WEP configuration 217 */ 218 size_t wep_key_len[4]; 219 220 /** 221 * wep_tx_keyidx - WEP TX key index for static WEP configuration 222 */ 223 int wep_tx_keyidx; 224 225 /** 226 * mgmt_frame_protection - IEEE 802.11w management frame protection 227 */ 228 enum { 229 NO_MGMT_FRAME_PROTECTION, 230 MGMT_FRAME_PROTECTION_OPTIONAL, 231 MGMT_FRAME_PROTECTION_REQUIRED 232 } mgmt_frame_protection; 233 234 /** 235 * ft_ies - IEEE 802.11r / FT information elements 236 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys 237 * for fast transition, this parameter is set to include the IEs that 238 * are to be sent in the next FT Authentication Request message. 239 * update_ft_ies() handler is called to update the IEs for further 240 * FT messages in the sequence. 241 * 242 * The driver should use these IEs only if the target AP is advertising 243 * the same mobility domain as the one included in the MDIE here. 244 * 245 * In ap_scan=2 mode, the driver can use these IEs when moving to a new 246 * AP after the initial association. These IEs can only be used if the 247 * target AP is advertising support for FT and is using the same MDIE 248 * and SSID as the current AP. 249 * 250 * The driver is responsible for reporting the FT IEs received from the 251 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE 252 * type. update_ft_ies() handler will then be called with the FT IEs to 253 * include in the next frame in the authentication sequence. 254 */ 255 const u8 *ft_ies; 256 257 /** 258 * ft_ies_len - Length of ft_ies in bytes 259 */ 260 size_t ft_ies_len; 261 262 /** 263 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies) 264 * 265 * This value is provided to allow the driver interface easier access 266 * to the current mobility domain. This value is set to %NULL if no 267 * mobility domain is currently active. 268 */ 269 const u8 *ft_md; 270 271 /** 272 * passphrase - RSN passphrase for PSK 273 * 274 * This value is made available only for WPA/WPA2-Personal (PSK) and 275 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is 276 * the 8..63 character ASCII passphrase, if available. Please note that 277 * this can be %NULL if passphrase was not used to generate the PSK. In 278 * that case, the psk field must be used to fetch the PSK. 279 */ 280 const char *passphrase; 281 282 /** 283 * psk - RSN PSK (alternative for passphrase for PSK) 284 * 285 * This value is made available only for WPA/WPA2-Personal (PSK) and 286 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is 287 * the 32-octet (256-bit) PSK, if available. The driver wrapper should 288 * be prepared to handle %NULL value as an error. 289 */ 290 const u8 *psk; 291 }; 292 293 /** 294 * struct wpa_driver_capa - Driver capability information 295 */ 296 struct wpa_driver_capa { 297 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001 298 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002 299 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004 300 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008 301 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010 302 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020 303 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040 304 unsigned int key_mgmt; 305 306 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001 307 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002 308 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004 309 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008 310 unsigned int enc; 311 312 #define WPA_DRIVER_AUTH_OPEN 0x00000001 313 #define WPA_DRIVER_AUTH_SHARED 0x00000002 314 #define WPA_DRIVER_AUTH_LEAP 0x00000004 315 unsigned int auth; 316 317 /* Driver generated WPA/RSN IE */ 318 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001 319 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002 320 #define WPA_DRIVER_FLAGS_USER_SPACE_MLME 0x00000004 321 /* Driver takes care of RSN 4-way handshake internally; PMK is configured with 322 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */ 323 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008 324 unsigned int flags; 325 }; 326 327 328 #define WPA_CHAN_W_SCAN 0x00000001 329 #define WPA_CHAN_W_ACTIVE_SCAN 0x00000002 330 #define WPA_CHAN_W_IBSS 0x00000004 331 332 struct wpa_channel_data { 333 short chan; /* channel number (IEEE 802.11) */ 334 short freq; /* frequency in MHz */ 335 int flag; /* flag for user space use (WPA_CHAN_*) */ 336 }; 337 338 #define WPA_RATE_ERP 0x00000001 339 #define WPA_RATE_BASIC 0x00000002 340 #define WPA_RATE_PREAMBLE2 0x00000004 341 #define WPA_RATE_SUPPORTED 0x00000010 342 #define WPA_RATE_OFDM 0x00000020 343 #define WPA_RATE_CCK 0x00000040 344 #define WPA_RATE_MANDATORY 0x00000100 345 346 struct wpa_rate_data { 347 int rate; /* rate in 100 kbps */ 348 int flags; /* WPA_RATE_ flags */ 349 }; 350 351 typedef enum { 352 WPA_MODE_IEEE80211B, 353 WPA_MODE_IEEE80211G, 354 WPA_MODE_IEEE80211A, 355 NUM_WPA_MODES 356 } wpa_hw_mode; 357 358 struct wpa_hw_modes { 359 wpa_hw_mode mode; 360 int num_channels; 361 struct wpa_channel_data *channels; 362 int num_rates; 363 struct wpa_rate_data *rates; 364 }; 365 366 367 struct ieee80211_rx_status { 368 int channel; 369 int ssi; 370 }; 371 372 373 /** 374 * struct wpa_driver_ops - Driver interface API definition 375 * 376 * This structure defines the API that each driver interface needs to implement 377 * for core wpa_supplicant code. All driver specific functionality is captured 378 * in this wrapper. 379 */ 380 struct wpa_driver_ops { 381 /** Name of the driver interface */ 382 const char *name; 383 /** One line description of the driver interface */ 384 const char *desc; 385 386 /** 387 * get_bssid - Get the current BSSID 388 * @priv: private driver interface data 389 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes) 390 * 391 * Returns: 0 on success, -1 on failure 392 * 393 * Query kernel driver for the current BSSID and copy it to bssid. 394 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not 395 * associated. 396 */ 397 int (*get_bssid)(void *priv, u8 *bssid); 398 399 /** 400 * get_ssid - Get the current SSID 401 * @priv: private driver interface data 402 * @ssid: buffer for SSID (at least 32 bytes) 403 * 404 * Returns: Length of the SSID on success, -1 on failure 405 * 406 * Query kernel driver for the current SSID and copy it to ssid. 407 * Returning zero is recommended if the STA is not associated. 408 * 409 * Note: SSID is an array of octets, i.e., it is not nul terminated and 410 * can, at least in theory, contain control characters (including nul) 411 * and as such, should be processed as binary data, not a printable 412 * string. 413 */ 414 int (*get_ssid)(void *priv, u8 *ssid); 415 416 /** 417 * set_wpa - Enable/disable WPA support (OBSOLETE) 418 * @priv: private driver interface data 419 * @enabled: 1 = enable, 0 = disable 420 * 421 * Returns: 0 on success, -1 on failure 422 * 423 * Note: This function is included for backwards compatibility. This is 424 * called only just after init and just before deinit, so these 425 * functions can be used to implement same functionality and the driver 426 * interface need not define this function. 427 * 428 * Configure the kernel driver to enable/disable WPA support. This may 429 * be empty function, if WPA support is always enabled. Common 430 * configuration items are WPA IE (clearing it when WPA support is 431 * disabled), Privacy flag configuration for capability field (note: 432 * this the value need to set in associate handler to allow plaintext 433 * mode to be used) when trying to associate with, roaming mode (can 434 * allow wpa_supplicant to control roaming if ap_scan=1 is used; 435 * however, drivers can also implement roaming if desired, especially 436 * ap_scan=2 mode is used for this). 437 */ 438 int (*set_wpa)(void *priv, int enabled); 439 440 /** 441 * set_key - Configure encryption key 442 * @priv: private driver interface data 443 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP, 444 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK); 445 * %WPA_ALG_NONE clears the key. 446 * @addr: address of the peer STA or ff:ff:ff:ff:ff:ff for 447 * broadcast/default keys 448 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for 449 * IGTK 450 * @set_tx: configure this key as the default Tx key (only used when 451 * driver does not support separate unicast/individual key 452 * @seq: sequence number/packet number, seq_len octets, the next 453 * packet number to be used for in replay protection; configured 454 * for Rx keys (in most cases, this is only used with broadcast 455 * keys and set to zero for unicast keys) 456 * @seq_len: length of the seq, depends on the algorithm: 457 * TKIP: 6 octets, CCMP: 6 octets, IGTK: 6 octets 458 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key, 459 * 8-byte Rx Mic Key 460 * @key_len: length of the key buffer in octets (WEP: 5 or 13, 461 * TKIP: 32, CCMP: 16, IGTK: 16) 462 * 463 * Returns: 0 on success, -1 on failure 464 * 465 * Configure the given key for the kernel driver. If the driver 466 * supports separate individual keys (4 default keys + 1 individual), 467 * addr can be used to determine whether the key is default or 468 * individual. If only 4 keys are supported, the default key with key 469 * index 0 is used as the individual key. STA must be configured to use 470 * it as the default Tx key (set_tx is set) and accept Rx for all the 471 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for 472 * broadcast keys, so key index 0 is available for this kind of 473 * configuration. 474 * 475 * Please note that TKIP keys include separate TX and RX MIC keys and 476 * some drivers may expect them in different order than wpa_supplicant 477 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets 478 * will tricker Michael MIC errors. This can be fixed by changing the 479 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key 480 * in driver_*.c set_key() implementation, see driver_ndis.c for an 481 * example on how this can be done. 482 */ 483 int (*set_key)(void *priv, wpa_alg alg, const u8 *addr, 484 int key_idx, int set_tx, const u8 *seq, size_t seq_len, 485 const u8 *key, size_t key_len); 486 487 /** 488 * init - Initialize driver interface 489 * @ctx: context to be used when calling wpa_supplicant functions, 490 * e.g., wpa_supplicant_event() 491 * @ifname: interface name, e.g., wlan0 492 * 493 * Returns: Pointer to private data, %NULL on failure 494 * 495 * Initialize driver interface, including event processing for kernel 496 * driver events (e.g., associated, scan results, Michael MIC failure). 497 * This function can allocate a private configuration data area for 498 * @ctx, file descriptor, interface name, etc. information that may be 499 * needed in future driver operations. If this is not used, non-NULL 500 * value will need to be returned because %NULL is used to indicate 501 * failure. The returned value will be used as 'void *priv' data for 502 * all other driver_ops functions. 503 * 504 * The main event loop (eloop.c) of wpa_supplicant can be used to 505 * register callback for read sockets (eloop_register_read_sock()). 506 * 507 * See below for more information about events and 508 * wpa_supplicant_event() function. 509 */ 510 void * (*init)(void *ctx, const char *ifname); 511 512 /** 513 * deinit - Deinitialize driver interface 514 * @priv: private driver interface data from init() 515 * 516 * Shut down driver interface and processing of driver events. Free 517 * private data buffer if one was allocated in init() handler. 518 */ 519 void (*deinit)(void *priv); 520 521 /** 522 * set_param - Set driver configuration parameters 523 * @priv: private driver interface data from init() 524 * @param: driver specific configuration parameters 525 * 526 * Returns: 0 on success, -1 on failure 527 * 528 * Optional handler for notifying driver interface about configuration 529 * parameters (driver_param). 530 */ 531 int (*set_param)(void *priv, const char *param); 532 533 /** 534 * set_countermeasures - Enable/disable TKIP countermeasures 535 * @priv: private driver interface data 536 * @enabled: 1 = countermeasures enabled, 0 = disabled 537 * 538 * Returns: 0 on success, -1 on failure 539 * 540 * Configure TKIP countermeasures. When these are enabled, the driver 541 * should drop all received and queued frames that are using TKIP. 542 */ 543 int (*set_countermeasures)(void *priv, int enabled); 544 545 /** 546 * set_drop_unencrypted - Enable/disable unencrypted frame filtering 547 * @priv: private driver interface data 548 * @enabled: 1 = unencrypted Tx/Rx frames will be dropped, 0 = disabled 549 * 550 * Returns: 0 on success, -1 on failure 551 * 552 * Configure the driver to drop all non-EAPOL frames (both receive and 553 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must 554 * still be allowed for key negotiation. 555 */ 556 int (*set_drop_unencrypted)(void *priv, int enabled); 557 558 /** 559 * scan - Request the driver to initiate scan 560 * @priv: private driver interface data 561 * @ssid: specific SSID to scan for (ProbeReq) or %NULL to scan for 562 * all SSIDs (either active scan with broadcast SSID or passive 563 * scan 564 * @ssid_len: length of the SSID 565 * 566 * Returns: 0 on success, -1 on failure 567 * 568 * Once the scan results are ready, the driver should report scan 569 * results event for wpa_supplicant which will eventually request the 570 * results with wpa_driver_get_scan_results(). 571 */ 572 int (*scan)(void *priv, const u8 *ssid, size_t ssid_len); 573 574 /** 575 * get_scan_results - Fetch the latest scan results (old version) 576 * @priv: private driver interface data 577 * @results: pointer to buffer for scan results 578 * @max_size: maximum number of entries (buffer size) 579 * 580 * Returns: Number of scan result entries used on success, -1 on 581 * failure 582 * 583 * If scan results include more than max_size BSSes, max_size will be 584 * returned and the remaining entries will not be included in the 585 * buffer. 586 * 587 * This function is depracated. New driver wrapper implementations 588 * should implement support for get_scan_results2(). 589 */ 590 int (*get_scan_results)(void *priv, 591 struct wpa_scan_result *results, 592 size_t max_size); 593 594 /** 595 * deauthenticate - Request driver to deauthenticate 596 * @priv: private driver interface data 597 * @addr: peer address (BSSID of the AP) 598 * @reason_code: 16-bit reason code to be sent in the deauthentication 599 * frame 600 * 601 * Returns: 0 on success, -1 on failure 602 */ 603 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code); 604 605 /** 606 * disassociate - Request driver to disassociate 607 * @priv: private driver interface data 608 * @addr: peer address (BSSID of the AP) 609 * @reason_code: 16-bit reason code to be sent in the disassociation 610 * frame 611 * 612 * Returns: 0 on success, -1 on failure 613 */ 614 int (*disassociate)(void *priv, const u8 *addr, int reason_code); 615 616 /** 617 * associate - Request driver to associate 618 * @priv: private driver interface data 619 * @params: association parameters 620 * 621 * Returns: 0 on success, -1 on failure 622 */ 623 int (*associate)(void *priv, 624 struct wpa_driver_associate_params *params); 625 626 /** 627 * set_auth_alg - Set IEEE 802.11 authentication algorithm 628 * @priv: private driver interface data 629 * @auth_alg: bit field of AUTH_ALG_* 630 * 631 * If the driver supports more than one authentication algorithm at the 632 * same time, it should configure all supported algorithms. If not, one 633 * algorithm needs to be selected arbitrarily. Open System 634 * authentication should be ok for most cases and it is recommended to 635 * be used if other options are not supported. Static WEP configuration 636 * may also use Shared Key authentication and LEAP requires its own 637 * algorithm number. For LEAP, user can make sure that only one 638 * algorithm is used at a time by configuring LEAP as the only 639 * supported EAP method. This information is also available in 640 * associate() params, so set_auth_alg may not be needed in case of 641 * most drivers. 642 * 643 * Returns: 0 on success, -1 on failure 644 */ 645 int (*set_auth_alg)(void *priv, int auth_alg); 646 647 /** 648 * add_pmkid - Add PMKSA cache entry to the driver 649 * @priv: private driver interface data 650 * @bssid: BSSID for the PMKSA cache entry 651 * @pmkid: PMKID for the PMKSA cache entry 652 * 653 * Returns: 0 on success, -1 on failure 654 * 655 * This function is called when a new PMK is received, as a result of 656 * either normal authentication or RSN pre-authentication. 657 * 658 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 659 * associate(), add_pmkid() can be used to add new PMKSA cache entries 660 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this 661 * driver_ops function does not need to be implemented. Likewise, if 662 * the driver does not support WPA, this function is not needed. 663 */ 664 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid); 665 666 /** 667 * remove_pmkid - Remove PMKSA cache entry to the driver 668 * @priv: private driver interface data 669 * @bssid: BSSID for the PMKSA cache entry 670 * @pmkid: PMKID for the PMKSA cache entry 671 * 672 * Returns: 0 on success, -1 on failure 673 * 674 * This function is called when the supplicant drops a PMKSA cache 675 * entry for any reason. 676 * 677 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 678 * associate(), remove_pmkid() can be used to synchronize PMKSA caches 679 * between the driver and wpa_supplicant. If the driver uses wpa_ie 680 * from wpa_supplicant, this driver_ops function does not need to be 681 * implemented. Likewise, if the driver does not support WPA, this 682 * function is not needed. 683 */ 684 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid); 685 686 /** 687 * flush_pmkid - Flush PMKSA cache 688 * @priv: private driver interface data 689 * 690 * Returns: 0 on success, -1 on failure 691 * 692 * This function is called when the supplicant drops all PMKSA cache 693 * entries for any reason. 694 * 695 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 696 * associate(), remove_pmkid() can be used to synchronize PMKSA caches 697 * between the driver and wpa_supplicant. If the driver uses wpa_ie 698 * from wpa_supplicant, this driver_ops function does not need to be 699 * implemented. Likewise, if the driver does not support WPA, this 700 * function is not needed. 701 */ 702 int (*flush_pmkid)(void *priv); 703 704 /** 705 * get_capa - Get driver capabilities 706 * @priv: private driver interface data 707 * 708 * Returns: 0 on success, -1 on failure 709 * 710 * Get driver/firmware/hardware capabilities. 711 */ 712 int (*get_capa)(void *priv, struct wpa_driver_capa *capa); 713 714 /** 715 * poll - Poll driver for association information 716 * @priv: private driver interface data 717 * 718 * This is an option callback that can be used when the driver does not 719 * provide event mechanism for association events. This is called when 720 * receiving WPA EAPOL-Key messages that require association 721 * information. The driver interface is supposed to generate associnfo 722 * event before returning from this callback function. In addition, the 723 * driver interface should generate an association event after having 724 * sent out associnfo. 725 */ 726 void (*poll)(void *priv); 727 728 /** 729 * get_ifname - Get interface name 730 * @priv: private driver interface data 731 * 732 * Returns: Pointer to the interface name. This can differ from the 733 * interface name used in init() call. Init() is called first. 734 * 735 * This optional function can be used to allow the driver interface to 736 * replace the interface name with something else, e.g., based on an 737 * interface mapping from a more descriptive name. 738 */ 739 const char * (*get_ifname)(void *priv); 740 741 /** 742 * get_mac_addr - Get own MAC address 743 * @priv: private driver interface data 744 * 745 * Returns: Pointer to own MAC address or %NULL on failure 746 * 747 * This optional function can be used to get the own MAC address of the 748 * device from the driver interface code. This is only needed if the 749 * l2_packet implementation for the OS does not provide easy access to 750 * a MAC address. */ 751 const u8 * (*get_mac_addr)(void *priv); 752 753 /** 754 * send_eapol - Optional function for sending EAPOL packets 755 * @priv: private driver interface data 756 * @dest: Destination MAC address 757 * @proto: Ethertype 758 * @data: EAPOL packet starting with IEEE 802.1X header 759 * @data_len: Size of the EAPOL packet 760 * 761 * Returns: 0 on success, -1 on failure 762 * 763 * This optional function can be used to override l2_packet operations 764 * with driver specific functionality. If this function pointer is set, 765 * l2_packet module is not used at all and the driver interface code is 766 * responsible for receiving and sending all EAPOL packets. The 767 * received EAPOL packets are sent to core code by calling 768 * wpa_supplicant_rx_eapol(). The driver interface is required to 769 * implement get_mac_addr() handler if send_eapol() is used. 770 */ 771 int (*send_eapol)(void *priv, const u8 *dest, u16 proto, 772 const u8 *data, size_t data_len); 773 774 /** 775 * set_operstate - Sets device operating state to DORMANT or UP 776 * @priv: private driver interface data 777 * @state: 0 = dormant, 1 = up 778 * Returns: 0 on success, -1 on failure 779 * 780 * This is an optional function that can be used on operating systems 781 * that support a concept of controlling network device state from user 782 * space applications. This function, if set, gets called with 783 * state = 1 when authentication has been completed and with state = 0 784 * when connection is lost. 785 */ 786 int (*set_operstate)(void *priv, int state); 787 788 /** 789 * mlme_setprotection - MLME-SETPROTECTION.request primitive 790 * @priv: Private driver interface data 791 * @addr: Address of the station for which to set protection (may be 792 * %NULL for group keys) 793 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_* 794 * @key_type: MLME_SETPROTECTION_KEY_TYPE_* 795 * Returns: 0 on success, -1 on failure 796 * 797 * This is an optional function that can be used to set the driver to 798 * require protection for Tx and/or Rx frames. This uses the layer 799 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1 800 * (MLME-SETPROTECTION.request). Many drivers do not use explicit 801 * set protection operation; instead, they set protection implicitly 802 * based on configured keys. 803 */ 804 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type, 805 int key_type); 806 807 /** 808 * get_hw_feature_data - Get hardware support data (channels and rates) 809 * @priv: Private driver interface data 810 * @num_modes: Variable for returning the number of returned modes 811 * flags: Variable for returning hardware feature flags 812 * Returns: Pointer to allocated hardware data on success or %NULL on 813 * failure. Caller is responsible for freeing this. 814 * 815 * This function is only needed for drivers that export MLME 816 * (management frame processing) to wpa_supplicant. 817 */ 818 struct wpa_hw_modes * (*get_hw_feature_data)(void *priv, 819 u16 *num_modes, 820 u16 *flags); 821 822 /** 823 * set_channel - Set channel 824 * @priv: Private driver interface data 825 * @phymode: WPA_MODE_IEEE80211B, .. 826 * @chan: IEEE 802.11 channel number 827 * @freq: Frequency of the channel in MHz 828 * Returns: 0 on success, -1 on failure 829 * 830 * This function is only needed for drivers that export MLME 831 * (management frame processing) to wpa_supplicant. 832 */ 833 int (*set_channel)(void *priv, wpa_hw_mode phymode, int chan, 834 int freq); 835 836 /** 837 * set_ssid - Set SSID 838 * @priv: Private driver interface data 839 * @ssid: SSID 840 * @ssid_len: SSID length 841 * Returns: 0 on success, -1 on failure 842 * 843 * This function is only needed for drivers that export MLME 844 * (management frame processing) to wpa_supplicant. 845 */ 846 int (*set_ssid)(void *priv, const u8 *ssid, size_t ssid_len); 847 848 /** 849 * set_bssid - Set BSSID 850 * @priv: Private driver interface data 851 * @bssid: BSSID 852 * Returns: 0 on success, -1 on failure 853 * 854 * This function is only needed for drivers that export MLME 855 * (management frame processing) to wpa_supplicant. 856 */ 857 int (*set_bssid)(void *priv, const u8 *bssid); 858 859 /** 860 * send_mlme - Send management frame from MLME 861 * @priv: Private driver interface data 862 * @data: IEEE 802.11 management frame with IEEE 802.11 header 863 * @data_len: Size of the management frame 864 * Returns: 0 on success, -1 on failure 865 * 866 * This function is only needed for drivers that export MLME 867 * (management frame processing) to wpa_supplicant. 868 */ 869 int (*send_mlme)(void *priv, const u8 *data, size_t data_len); 870 871 /** 872 * mlme_add_sta - Add a STA entry into the driver/netstack 873 * @priv: Private driver interface data 874 * @addr: MAC address of the STA (e.g., BSSID of the AP) 875 * @supp_rates: Supported rate set (from (Re)AssocResp); in IEEE 802.11 876 * format (one octet per rate, 1 = 0.5 Mbps) 877 * @supp_rates_len: Number of entries in supp_rates 878 * Returns: 0 on success, -1 on failure 879 * 880 * This function is only needed for drivers that export MLME 881 * (management frame processing) to wpa_supplicant. When the MLME code 882 * completes association with an AP, this function is called to 883 * configure the driver/netstack with a STA entry for data frame 884 * processing (TX rate control, encryption/decryption). 885 */ 886 int (*mlme_add_sta)(void *priv, const u8 *addr, const u8 *supp_rates, 887 size_t supp_rates_len); 888 889 /** 890 * mlme_remove_sta - Remove a STA entry from the driver/netstack 891 * @priv: Private driver interface data 892 * @addr: MAC address of the STA (e.g., BSSID of the AP) 893 * Returns: 0 on success, -1 on failure 894 * 895 * This function is only needed for drivers that export MLME 896 * (management frame processing) to wpa_supplicant. 897 */ 898 int (*mlme_remove_sta)(void *priv, const u8 *addr); 899 900 /** 901 * update_ft_ies - Update FT (IEEE 802.11r) IEs 902 * @priv: Private driver interface data 903 * @md: Mobility domain (2 octets) (also included inside ies) 904 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs 905 * @ies_len: Length of FT IEs in bytes 906 * Returns: 0 on success, -1 on failure 907 * 908 * The supplicant uses this callback to let the driver know that keying 909 * material for FT is available and that the driver can use the 910 * provided IEs in the next message in FT authentication sequence. 911 * 912 * This function is only needed for driver that support IEEE 802.11r 913 * (Fast BSS Transition). 914 */ 915 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies, 916 size_t ies_len); 917 918 /** 919 * send_ft_action - Send FT Action frame (IEEE 802.11r) 920 * @priv: Private driver interface data 921 * @action: Action field value 922 * @target_ap: Target AP address 923 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body) 924 * @ies_len: Length of FT IEs in bytes 925 * Returns: 0 on success, -1 on failure 926 * 927 * The supplicant uses this callback to request the driver to transmit 928 * an FT Action frame (action category 6) for over-the-DS fast BSS 929 * transition. 930 */ 931 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap, 932 const u8 *ies, size_t ies_len); 933 934 /** 935 * get_scan_results2 - Fetch the latest scan results 936 * @priv: private driver interface data 937 * 938 * Returns: Allocated buffer of scan results (caller is responsible for 939 * freeing the data structure) on success, NULL on failure 940 */ 941 struct wpa_scan_results * (*get_scan_results2)(void *priv); 942 943 /** 944 * set_probe_req_ie - Set information element(s) for Probe Request 945 * @priv: private driver interface data 946 * @ies: Information elements to append or %NULL to remove extra IEs 947 * @ies_len: Length of the IE buffer in octets 948 * Returns: 0 on success, -1 on failure 949 */ 950 int (*set_probe_req_ie)(void *priv, const u8 *ies, size_t ies_len); 951 952 /** 953 * set_mode - Request driver to set the operating mode 954 * @priv: private driver interface data 955 * @mode: Operation mode (infra/ibss) IEEE80211_MODE_* 956 * 957 * This handler will be called before any key configuration and call to 958 * associate() handler in order to allow the operation mode to be 959 * configured as early as possible. This information is also available 960 * in associate() params and as such, some driver wrappers may not need 961 * to implement set_mode() handler. 962 * Returns: 0 on success, -1 on failure 963 */ 964 int (*set_mode)(void *priv, int mode); 965 966 /** 967 * set_country - Set country 968 * @priv: Private driver interface data 969 * @alpha2: country to which to switch to 970 * Returns: 0 on success, -1 on failure 971 * 972 * This function is for drivers which support some form 973 * of setting a regulatory domain. 974 */ 975 int (*set_country)(void *priv, const char *alpha2); 976 977 /** 978 * global_init - Global driver initialization 979 * Returns: Pointer to private data (global), %NULL on failure 980 * 981 * This optional function is called to initialize the driver wrapper 982 * for global data, i.e., data that applies to all interfaces. If this 983 * function is implemented, global_deinit() will also need to be 984 * implemented to free the private data. The driver will also likely 985 * use init2() function instead of init() to get the pointer to global 986 * data available to per-interface initializer. 987 */ 988 void * (*global_init)(void); 989 990 /** 991 * global_deinit - Global driver deinitialization 992 * @priv: private driver global data from global_init() 993 * 994 * Terminate any global driver related functionality and free the 995 * global data structure. 996 */ 997 void (*global_deinit)(void *priv); 998 999 /** 1000 * init2 - Initialize driver interface (with global data) 1001 * @ctx: context to be used when calling wpa_supplicant functions, 1002 * e.g., wpa_supplicant_event() 1003 * @ifname: interface name, e.g., wlan0 1004 * @global_priv: private driver global data from global_init() 1005 * Returns: Pointer to private data, %NULL on failure 1006 * 1007 * This function can be used instead of init() if the driver wrapper 1008 * uses global data. 1009 */ 1010 void * (*init2)(void *ctx, const char *ifname, void *global_priv); 1011 1012 /** 1013 * get_interfaces - Get information about available interfaces 1014 * @global_priv: private driver global data from global_init() 1015 * Returns: Allocated buffer of interface information (caller is 1016 * responsible for freeing the data structure) on success, NULL on 1017 * failure 1018 */ 1019 struct wpa_interface_info * (*get_interfaces)(void *global_priv); 1020 1021 #ifdef ANDROID 1022 /** 1023 * driver_cmd - execute driver-specific command 1024 * @priv: private driver interface data from init() 1025 * @cmd: command to execute 1026 * @buf: return buffer 1027 * @buf_len: buffer length 1028 * 1029 * Returns: 0 on success, -1 on failure 1030 * 1031 */ 1032 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len); 1033 #endif 1034 }; 1035 1036 /* Function to check whether a driver is for wired connections */ 1037 static inline int IS_WIRED(const struct wpa_driver_ops *drv) 1038 { 1039 return os_strcmp(drv->name, "wired") == 0 || 1040 os_strcmp(drv->name, "roboswitch") == 0; 1041 } 1042 1043 /** 1044 * enum wpa_event_type - Event type for wpa_supplicant_event() calls 1045 */ 1046 typedef enum wpa_event_type { 1047 /** 1048 * EVENT_ASSOC - Association completed 1049 * 1050 * This event needs to be delivered when the driver completes IEEE 1051 * 802.11 association or reassociation successfully. 1052 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID 1053 * after this event has been generated. In addition, optional 1054 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide 1055 * more information about the association. If the driver interface gets 1056 * both of these events at the same time, it can also include the 1057 * assoc_info data in EVENT_ASSOC call. 1058 */ 1059 EVENT_ASSOC, 1060 1061 /** 1062 * EVENT_DISASSOC - Association lost 1063 * 1064 * This event should be called when association is lost either due to 1065 * receiving deauthenticate or disassociate frame from the AP or when 1066 * sending either of these frames to the current AP. 1067 */ 1068 EVENT_DISASSOC, 1069 1070 /** 1071 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected 1072 * 1073 * This event must be delivered when a Michael MIC error is detected by 1074 * the local driver. Additional data for event processing is 1075 * provided with union wpa_event_data::michael_mic_failure. This 1076 * information is used to request new encyption key and to initiate 1077 * TKIP countermeasures if needed. 1078 */ 1079 EVENT_MICHAEL_MIC_FAILURE, 1080 1081 /** 1082 * EVENT_SCAN_RESULTS - Scan results available 1083 * 1084 * This event must be called whenever scan results are available to be 1085 * fetched with struct wpa_driver_ops::get_scan_results(). This event 1086 * is expected to be used some time after struct wpa_driver_ops::scan() 1087 * is called. If the driver provides an unsolicited event when the scan 1088 * has been completed, this event can be used to trigger 1089 * EVENT_SCAN_RESULTS call. If such event is not available from the 1090 * driver, the driver wrapper code is expected to use a registered 1091 * timeout to generate EVENT_SCAN_RESULTS call after the time that the 1092 * scan is expected to be completed. 1093 */ 1094 EVENT_SCAN_RESULTS, 1095 1096 /** 1097 * EVENT_ASSOCINFO - Report optional extra information for association 1098 * 1099 * This event can be used to report extra association information for 1100 * EVENT_ASSOC processing. This extra information includes IEs from 1101 * association frames and Beacon/Probe Response frames in union 1102 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before 1103 * EVENT_ASSOC. Alternatively, the driver interface can include 1104 * assoc_info data in the EVENT_ASSOC call if it has all the 1105 * information available at the same point. 1106 */ 1107 EVENT_ASSOCINFO, 1108 1109 /** 1110 * EVENT_INTERFACE_STATUS - Report interface status changes 1111 * 1112 * This optional event can be used to report changes in interface 1113 * status (interface added/removed) using union 1114 * wpa_event_data::interface_status. This can be used to trigger 1115 * wpa_supplicant to stop and re-start processing for the interface, 1116 * e.g., when a cardbus card is ejected/inserted. 1117 */ 1118 EVENT_INTERFACE_STATUS, 1119 1120 /** 1121 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication 1122 * 1123 * This event can be used to inform wpa_supplicant about candidates for 1124 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible 1125 * for scan request (ap_scan=2 mode), this event is required for 1126 * pre-authentication. If wpa_supplicant is performing scan request 1127 * (ap_scan=1), this event is optional since scan results can be used 1128 * to add pre-authentication candidates. union 1129 * wpa_event_data::pmkid_candidate is used to report the BSSID of the 1130 * candidate and priority of the candidate, e.g., based on the signal 1131 * strength, in order to try to pre-authenticate first with candidates 1132 * that are most likely targets for re-association. 1133 * 1134 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates 1135 * on the candidate list. In addition, it can be called for the current 1136 * AP and APs that have existing PMKSA cache entries. wpa_supplicant 1137 * will automatically skip pre-authentication in cases where a valid 1138 * PMKSA exists. When more than one candidate exists, this event should 1139 * be generated once for each candidate. 1140 * 1141 * Driver will be notified about successful pre-authentication with 1142 * struct wpa_driver_ops::add_pmkid() calls. 1143 */ 1144 EVENT_PMKID_CANDIDATE, 1145 1146 /** 1147 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request) 1148 * 1149 * This event can be used to inform wpa_supplicant about desire to set 1150 * up secure direct link connection between two stations as defined in 1151 * IEEE 802.11e with a new PeerKey mechanism that replaced the original 1152 * STAKey negotiation. The caller will need to set peer address for the 1153 * event. 1154 */ 1155 EVENT_STKSTART, 1156 1157 /** 1158 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs 1159 * 1160 * The driver is expected to report the received FT IEs from 1161 * FT authentication sequence from the AP. The FT IEs are included in 1162 * the extra information in union wpa_event_data::ft_ies. 1163 */ 1164 EVENT_FT_RESPONSE 1165 } wpa_event_type; 1166 1167 1168 /** 1169 * union wpa_event_data - Additional data for wpa_supplicant_event() calls 1170 */ 1171 union wpa_event_data { 1172 /** 1173 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events 1174 * 1175 * This structure is optional for EVENT_ASSOC calls and required for 1176 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the 1177 * driver interface does not need to generate separate EVENT_ASSOCINFO 1178 * calls. 1179 */ 1180 struct assoc_info { 1181 /** 1182 * req_ies - (Re)Association Request IEs 1183 * 1184 * If the driver generates WPA/RSN IE, this event data must be 1185 * returned for WPA handshake to have needed information. If 1186 * wpa_supplicant-generated WPA/RSN IE is used, this 1187 * information event is optional. 1188 * 1189 * This should start with the first IE (fixed fields before IEs 1190 * are not included). 1191 */ 1192 u8 *req_ies; 1193 1194 /** 1195 * req_ies_len - Length of req_ies in bytes 1196 */ 1197 size_t req_ies_len; 1198 1199 /** 1200 * resp_ies - (Re)Association Response IEs 1201 * 1202 * Optional association data from the driver. This data is not 1203 * required WPA, but may be useful for some protocols and as 1204 * such, should be reported if this is available to the driver 1205 * interface. 1206 * 1207 * This should start with the first IE (fixed fields before IEs 1208 * are not included). 1209 */ 1210 u8 *resp_ies; 1211 1212 /** 1213 * resp_ies_len - Length of resp_ies in bytes 1214 */ 1215 size_t resp_ies_len; 1216 1217 /** 1218 * beacon_ies - Beacon or Probe Response IEs 1219 * 1220 * Optional Beacon/ProbeResp data: IEs included in Beacon or 1221 * Probe Response frames from the current AP (i.e., the one 1222 * that the client just associated with). This information is 1223 * used to update WPA/RSN IE for the AP. If this field is not 1224 * set, the results from previous scan will be used. If no 1225 * data for the new AP is found, scan results will be requested 1226 * again (without scan request). At this point, the driver is 1227 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is 1228 * used). 1229 * 1230 * This should start with the first IE (fixed fields before IEs 1231 * are not included). 1232 */ 1233 u8 *beacon_ies; 1234 1235 /** 1236 * beacon_ies_len - Length of beacon_ies */ 1237 size_t beacon_ies_len; 1238 } assoc_info; 1239 1240 /** 1241 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE 1242 */ 1243 struct michael_mic_failure { 1244 int unicast; 1245 } michael_mic_failure; 1246 1247 /** 1248 * struct interface_status - Data for EVENT_INTERFACE_STATUS 1249 */ 1250 struct interface_status { 1251 char ifname[100]; 1252 enum { 1253 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED 1254 } ievent; 1255 } interface_status; 1256 1257 /** 1258 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE 1259 */ 1260 struct pmkid_candidate { 1261 /** BSSID of the PMKID candidate */ 1262 u8 bssid[ETH_ALEN]; 1263 /** Smaller the index, higher the priority */ 1264 int index; 1265 /** Whether RSN IE includes pre-authenticate flag */ 1266 int preauth; 1267 } pmkid_candidate; 1268 1269 /** 1270 * struct stkstart - Data for EVENT_STKSTART 1271 */ 1272 struct stkstart { 1273 u8 peer[ETH_ALEN]; 1274 } stkstart; 1275 1276 /** 1277 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE) 1278 * 1279 * During FT (IEEE 802.11r) authentication sequence, the driver is 1280 * expected to use this event to report received FT IEs (MDIE, FTIE, 1281 * RSN IE, TIE, possible resource request) to the supplicant. The FT 1282 * IEs for the next message will be delivered through the 1283 * struct wpa_driver_ops::update_ft_ies() callback. 1284 */ 1285 struct ft_ies { 1286 const u8 *ies; 1287 size_t ies_len; 1288 int ft_action; 1289 u8 target_ap[ETH_ALEN]; 1290 } ft_ies; 1291 }; 1292 1293 /** 1294 * wpa_supplicant_event - Report a driver event for wpa_supplicant 1295 * @ctx: Context pointer (wpa_s); this is the ctx variable registered 1296 * with struct wpa_driver_ops::init() 1297 * @event: event type (defined above) 1298 * @data: possible extra data for the event 1299 * 1300 * Driver wrapper code should call this function whenever an event is received 1301 * from the driver. 1302 */ 1303 void wpa_supplicant_event(void *ctx, wpa_event_type event, 1304 union wpa_event_data *data); 1305 1306 /** 1307 * wpa_supplicant_rx_eapol - Deliver a received EAPOL frame to wpa_supplicant 1308 * @ctx: Context pointer (wpa_s); this is the ctx variable registered 1309 * with struct wpa_driver_ops::init() 1310 * @src_addr: Source address of the EAPOL frame 1311 * @buf: EAPOL data starting from the EAPOL header (i.e., no Ethernet header) 1312 * @len: Length of the EAPOL data 1313 * 1314 * This function is called for each received EAPOL frame. Most driver 1315 * interfaces rely on more generic OS mechanism for receiving frames through 1316 * l2_packet, but if such a mechanism is not available, the driver wrapper may 1317 * take care of received EAPOL frames and deliver them to the core supplicant 1318 * code by calling this function. 1319 */ 1320 void wpa_supplicant_rx_eapol(void *ctx, const u8 *src_addr, 1321 const u8 *buf, size_t len); 1322 1323 void wpa_supplicant_sta_rx(void *ctx, const u8 *buf, size_t len, 1324 struct ieee80211_rx_status *rx_status); 1325 void wpa_supplicant_sta_free_hw_features(struct wpa_hw_modes *hw_features, 1326 size_t num_hw_features); 1327 1328 const u8 * wpa_scan_get_ie(const struct wpa_scan_res *res, u8 ie); 1329 #define WPA_IE_VENDOR_TYPE 0x0050f201 1330 #define WPS_IE_VENDOR_TYPE 0x0050f204 1331 const u8 * wpa_scan_get_vendor_ie(const struct wpa_scan_res *res, 1332 u32 vendor_type); 1333 struct wpabuf * wpa_scan_get_vendor_ie_multi(const struct wpa_scan_res *res, 1334 u32 vendor_type); 1335 int wpa_scan_get_max_rate(const struct wpa_scan_res *res); 1336 void wpa_scan_results_free(struct wpa_scan_results *res); 1337 void wpa_scan_sort_results(struct wpa_scan_results *res); 1338 1339 #endif /* DRIVER_H */ 1340
