driver.h revision ea69e84a6f4455c59348485895d3d5e3af77a65b
1/* 2 * Driver interface definition 3 * Copyright (c) 2003-2012, Jouni Malinen <j@w1.fi> 4 * 5 * This software may be distributed under the terms of the BSD license. 6 * See README for more details. 7 * 8 * This file defines a driver interface used by both %wpa_supplicant and 9 * hostapd. The first part of the file defines data structures used in various 10 * driver operations. This is followed by the struct wpa_driver_ops that each 11 * driver wrapper will beed to define with callback functions for requesting 12 * driver operations. After this, there are definitions for driver event 13 * reporting with wpa_supplicant_event() and some convenience helper functions 14 * that can be used to report events. 15 */ 16 17#ifndef DRIVER_H 18#define DRIVER_H 19 20#define WPA_SUPPLICANT_DRIVER_VERSION 4 21 22#include "common/defs.h" 23 24#define HOSTAPD_CHAN_DISABLED 0x00000001 25#define HOSTAPD_CHAN_PASSIVE_SCAN 0x00000002 26#define HOSTAPD_CHAN_NO_IBSS 0x00000004 27#define HOSTAPD_CHAN_RADAR 0x00000008 28#define HOSTAPD_CHAN_HT40PLUS 0x00000010 29#define HOSTAPD_CHAN_HT40MINUS 0x00000020 30#define HOSTAPD_CHAN_HT40 0x00000040 31 32#define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000 33#define HOSTAPD_CHAN_DFS_USABLE 0x00000100 34#define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200 35#define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300 36#define HOSTAPD_CHAN_DFS_MASK 0x00000300 37 38/** 39 * struct hostapd_channel_data - Channel information 40 */ 41struct hostapd_channel_data { 42 /** 43 * chan - Channel number (IEEE 802.11) 44 */ 45 short chan; 46 47 /** 48 * freq - Frequency in MHz 49 */ 50 int freq; 51 52 /** 53 * flag - Channel flags (HOSTAPD_CHAN_*) 54 */ 55 int flag; 56 57 /** 58 * max_tx_power - maximum transmit power in dBm 59 */ 60 u8 max_tx_power; 61}; 62 63#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0) 64 65/** 66 * struct hostapd_hw_modes - Supported hardware mode information 67 */ 68struct hostapd_hw_modes { 69 /** 70 * mode - Hardware mode 71 */ 72 enum hostapd_hw_mode mode; 73 74 /** 75 * num_channels - Number of entries in the channels array 76 */ 77 int num_channels; 78 79 /** 80 * channels - Array of supported channels 81 */ 82 struct hostapd_channel_data *channels; 83 84 /** 85 * num_rates - Number of entries in the rates array 86 */ 87 int num_rates; 88 89 /** 90 * rates - Array of supported rates in 100 kbps units 91 */ 92 int *rates; 93 94 /** 95 * ht_capab - HT (IEEE 802.11n) capabilities 96 */ 97 u16 ht_capab; 98 99 /** 100 * mcs_set - MCS (IEEE 802.11n) rate parameters 101 */ 102 u8 mcs_set[16]; 103 104 /** 105 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters 106 */ 107 u8 a_mpdu_params; 108 109 /** 110 * vht_capab - VHT (IEEE 802.11ac) capabilities 111 */ 112 u32 vht_capab; 113 114 /** 115 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters 116 */ 117 u8 vht_mcs_set[8]; 118 119 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */ 120}; 121 122 123#define IEEE80211_MODE_INFRA 0 124#define IEEE80211_MODE_IBSS 1 125#define IEEE80211_MODE_AP 2 126 127#define IEEE80211_CAP_ESS 0x0001 128#define IEEE80211_CAP_IBSS 0x0002 129#define IEEE80211_CAP_PRIVACY 0x0010 130 131/* DMG (60 GHz) IEEE 802.11ad */ 132/* type - bits 0..1 */ 133#define IEEE80211_CAP_DMG_MASK 0x0003 134#define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */ 135#define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */ 136#define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */ 137 138#define WPA_SCAN_QUAL_INVALID BIT(0) 139#define WPA_SCAN_NOISE_INVALID BIT(1) 140#define WPA_SCAN_LEVEL_INVALID BIT(2) 141#define WPA_SCAN_LEVEL_DBM BIT(3) 142#define WPA_SCAN_AUTHENTICATED BIT(4) 143#define WPA_SCAN_ASSOCIATED BIT(5) 144 145/** 146 * struct wpa_scan_res - Scan result for an BSS/IBSS 147 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*) 148 * @bssid: BSSID 149 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1) 150 * @beacon_int: beacon interval in TUs (host byte order) 151 * @caps: capability information field in host byte order 152 * @qual: signal quality 153 * @noise: noise level 154 * @level: signal level 155 * @tsf: Timestamp 156 * @age: Age of the information in milliseconds (i.e., how many milliseconds 157 * ago the last Beacon or Probe Response frame was received) 158 * @ie_len: length of the following IE field in octets 159 * @beacon_ie_len: length of the following Beacon IE field in octets 160 * 161 * This structure is used as a generic format for scan results from the 162 * driver. Each driver interface implementation is responsible for converting 163 * the driver or OS specific scan results into this format. 164 * 165 * If the driver does not support reporting all IEs, the IE data structure is 166 * constructed of the IEs that are available. This field will also need to 167 * include SSID in IE format. All drivers are encouraged to be extended to 168 * report all IEs to make it easier to support future additions. 169 */ 170struct wpa_scan_res { 171 unsigned int flags; 172 u8 bssid[ETH_ALEN]; 173 int freq; 174 u16 beacon_int; 175 u16 caps; 176 int qual; 177 int noise; 178 int level; 179 u64 tsf; 180 unsigned int age; 181 size_t ie_len; 182 size_t beacon_ie_len; 183 /* 184 * Followed by ie_len octets of IEs from Probe Response frame (or if 185 * the driver does not indicate source of IEs, these may also be from 186 * Beacon frame). After the first set of IEs, another set of IEs may 187 * follow (with beacon_ie_len octets of data) if the driver provides 188 * both IE sets. 189 */ 190}; 191 192/** 193 * struct wpa_scan_results - Scan results 194 * @res: Array of pointers to allocated variable length scan result entries 195 * @num: Number of entries in the scan result array 196 * @fetch_time: Time when the results were fetched from the driver 197 */ 198struct wpa_scan_results { 199 struct wpa_scan_res **res; 200 size_t num; 201 struct os_time fetch_time; 202}; 203 204/** 205 * struct wpa_interface_info - Network interface information 206 * @next: Pointer to the next interface or NULL if this is the last one 207 * @ifname: Interface name that can be used with init() or init2() 208 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if 209 * not available 210 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one 211 * is not an allocated copy, i.e., get_interfaces() caller will not free 212 * this) 213 */ 214struct wpa_interface_info { 215 struct wpa_interface_info *next; 216 char *ifname; 217 char *desc; 218 const char *drv_name; 219}; 220 221#define WPAS_MAX_SCAN_SSIDS 16 222 223/** 224 * struct wpa_driver_scan_params - Scan parameters 225 * Data for struct wpa_driver_ops::scan2(). 226 */ 227struct wpa_driver_scan_params { 228 /** 229 * ssids - SSIDs to scan for 230 */ 231 struct wpa_driver_scan_ssid { 232 /** 233 * ssid - specific SSID to scan for (ProbeReq) 234 * %NULL or zero-length SSID is used to indicate active scan 235 * with wildcard SSID. 236 */ 237 const u8 *ssid; 238 /** 239 * ssid_len: Length of the SSID in octets 240 */ 241 size_t ssid_len; 242 } ssids[WPAS_MAX_SCAN_SSIDS]; 243 244 /** 245 * num_ssids - Number of entries in ssids array 246 * Zero indicates a request for a passive scan. 247 */ 248 size_t num_ssids; 249 250 /** 251 * extra_ies - Extra IE(s) to add into Probe Request or %NULL 252 */ 253 const u8 *extra_ies; 254 255 /** 256 * extra_ies_len - Length of extra_ies in octets 257 */ 258 size_t extra_ies_len; 259 260 /** 261 * freqs - Array of frequencies to scan or %NULL for all frequencies 262 * 263 * The frequency is set in MHz. The array is zero-terminated. 264 */ 265 int *freqs; 266 267 /** 268 * filter_ssids - Filter for reporting SSIDs 269 * 270 * This optional parameter can be used to request the driver wrapper to 271 * filter scan results to include only the specified SSIDs. %NULL 272 * indicates that no filtering is to be done. This can be used to 273 * reduce memory needs for scan results in environments that have large 274 * number of APs with different SSIDs. 275 * 276 * The driver wrapper is allowed to take this allocated buffer into its 277 * own use by setting the pointer to %NULL. In that case, the driver 278 * wrapper is responsible for freeing the buffer with os_free() once it 279 * is not needed anymore. 280 */ 281 struct wpa_driver_scan_filter { 282 u8 ssid[32]; 283 size_t ssid_len; 284 } *filter_ssids; 285 286 /** 287 * num_filter_ssids - Number of entries in filter_ssids array 288 */ 289 size_t num_filter_ssids; 290 291 /** 292 * filter_rssi - Filter by RSSI 293 * 294 * The driver may filter scan results in firmware to reduce host 295 * wakeups and thereby save power. Specify the RSSI threshold in s32 296 * dBm. 297 */ 298 s32 filter_rssi; 299 300 /** 301 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes 302 * 303 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11 304 * Mbps from the support rates element(s) in the Probe Request frames 305 * and not to transmit the frames at any of those rates. 306 */ 307 u8 p2p_probe; 308}; 309 310/** 311 * struct wpa_driver_auth_params - Authentication parameters 312 * Data for struct wpa_driver_ops::authenticate(). 313 */ 314struct wpa_driver_auth_params { 315 int freq; 316 const u8 *bssid; 317 const u8 *ssid; 318 size_t ssid_len; 319 int auth_alg; 320 const u8 *ie; 321 size_t ie_len; 322 const u8 *wep_key[4]; 323 size_t wep_key_len[4]; 324 int wep_tx_keyidx; 325 int local_state_change; 326 327 /** 328 * p2p - Whether this connection is a P2P group 329 */ 330 int p2p; 331 332 const u8 *sae_data; 333 size_t sae_data_len; 334 335}; 336 337enum wps_mode { 338 WPS_MODE_NONE /* no WPS provisioning being used */, 339 WPS_MODE_OPEN /* WPS provisioning with AP that is in open mode */, 340 WPS_MODE_PRIVACY /* WPS provisioning with AP that is using protection 341 */ 342}; 343 344/** 345 * struct wpa_driver_associate_params - Association parameters 346 * Data for struct wpa_driver_ops::associate(). 347 */ 348struct wpa_driver_associate_params { 349 /** 350 * bssid - BSSID of the selected AP 351 * This can be %NULL, if ap_scan=2 mode is used and the driver is 352 * responsible for selecting with which BSS to associate. */ 353 const u8 *bssid; 354 355 /** 356 * ssid - The selected SSID 357 */ 358 const u8 *ssid; 359 360 /** 361 * ssid_len - Length of the SSID (1..32) 362 */ 363 size_t ssid_len; 364 365 /** 366 * freq - Frequency of the channel the selected AP is using 367 * Frequency that the selected AP is using (in MHz as 368 * reported in the scan results) 369 */ 370 int freq; 371 372 /** 373 * bg_scan_period - Background scan period in seconds, 0 to disable 374 * background scan, or -1 to indicate no change to default driver 375 * configuration 376 */ 377 int bg_scan_period; 378 379 /** 380 * wpa_ie - WPA information element for (Re)Association Request 381 * WPA information element to be included in (Re)Association 382 * Request (including information element id and length). Use 383 * of this WPA IE is optional. If the driver generates the WPA 384 * IE, it can use pairwise_suite, group_suite, and 385 * key_mgmt_suite to select proper algorithms. In this case, 386 * the driver has to notify wpa_supplicant about the used WPA 387 * IE by generating an event that the interface code will 388 * convert into EVENT_ASSOCINFO data (see below). 389 * 390 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE 391 * instead. The driver can determine which version is used by 392 * looking at the first byte of the IE (0xdd for WPA, 0x30 for 393 * WPA2/RSN). 394 * 395 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE. 396 */ 397 const u8 *wpa_ie; 398 399 /** 400 * wpa_ie_len - length of the wpa_ie 401 */ 402 size_t wpa_ie_len; 403 404 /** 405 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2 406 */ 407 unsigned int wpa_proto; 408 409 /** 410 * pairwise_suite - Selected pairwise cipher suite 411 * 412 * This is usually ignored if @wpa_ie is used. 413 */ 414 enum wpa_cipher pairwise_suite; 415 416 /** 417 * group_suite - Selected group cipher suite 418 * 419 * This is usually ignored if @wpa_ie is used. 420 */ 421 enum wpa_cipher group_suite; 422 423 /** 424 * key_mgmt_suite - Selected key management suite 425 * 426 * This is usually ignored if @wpa_ie is used. 427 */ 428 enum wpa_key_mgmt key_mgmt_suite; 429 430 /** 431 * auth_alg - Allowed authentication algorithms 432 * Bit field of WPA_AUTH_ALG_* 433 */ 434 int auth_alg; 435 436 /** 437 * mode - Operation mode (infra/ibss) IEEE80211_MODE_* 438 */ 439 int mode; 440 441 /** 442 * wep_key - WEP keys for static WEP configuration 443 */ 444 const u8 *wep_key[4]; 445 446 /** 447 * wep_key_len - WEP key length for static WEP configuration 448 */ 449 size_t wep_key_len[4]; 450 451 /** 452 * wep_tx_keyidx - WEP TX key index for static WEP configuration 453 */ 454 int wep_tx_keyidx; 455 456 /** 457 * mgmt_frame_protection - IEEE 802.11w management frame protection 458 */ 459 enum mfp_options mgmt_frame_protection; 460 461 /** 462 * ft_ies - IEEE 802.11r / FT information elements 463 * If the supplicant is using IEEE 802.11r (FT) and has the needed keys 464 * for fast transition, this parameter is set to include the IEs that 465 * are to be sent in the next FT Authentication Request message. 466 * update_ft_ies() handler is called to update the IEs for further 467 * FT messages in the sequence. 468 * 469 * The driver should use these IEs only if the target AP is advertising 470 * the same mobility domain as the one included in the MDIE here. 471 * 472 * In ap_scan=2 mode, the driver can use these IEs when moving to a new 473 * AP after the initial association. These IEs can only be used if the 474 * target AP is advertising support for FT and is using the same MDIE 475 * and SSID as the current AP. 476 * 477 * The driver is responsible for reporting the FT IEs received from the 478 * AP's response using wpa_supplicant_event() with EVENT_FT_RESPONSE 479 * type. update_ft_ies() handler will then be called with the FT IEs to 480 * include in the next frame in the authentication sequence. 481 */ 482 const u8 *ft_ies; 483 484 /** 485 * ft_ies_len - Length of ft_ies in bytes 486 */ 487 size_t ft_ies_len; 488 489 /** 490 * ft_md - FT Mobility domain (6 octets) (also included inside ft_ies) 491 * 492 * This value is provided to allow the driver interface easier access 493 * to the current mobility domain. This value is set to %NULL if no 494 * mobility domain is currently active. 495 */ 496 const u8 *ft_md; 497 498 /** 499 * passphrase - RSN passphrase for PSK 500 * 501 * This value is made available only for WPA/WPA2-Personal (PSK) and 502 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is 503 * the 8..63 character ASCII passphrase, if available. Please note that 504 * this can be %NULL if passphrase was not used to generate the PSK. In 505 * that case, the psk field must be used to fetch the PSK. 506 */ 507 const char *passphrase; 508 509 /** 510 * psk - RSN PSK (alternative for passphrase for PSK) 511 * 512 * This value is made available only for WPA/WPA2-Personal (PSK) and 513 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE. This is 514 * the 32-octet (256-bit) PSK, if available. The driver wrapper should 515 * be prepared to handle %NULL value as an error. 516 */ 517 const u8 *psk; 518 519 /** 520 * drop_unencrypted - Enable/disable unencrypted frame filtering 521 * 522 * Configure the driver to drop all non-EAPOL frames (both receive and 523 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must 524 * still be allowed for key negotiation. 525 */ 526 int drop_unencrypted; 527 528 /** 529 * prev_bssid - Previously used BSSID in this ESS 530 * 531 * When not %NULL, this is a request to use reassociation instead of 532 * association. 533 */ 534 const u8 *prev_bssid; 535 536 /** 537 * wps - WPS mode 538 * 539 * If the driver needs to do special configuration for WPS association, 540 * this variable provides more information on what type of association 541 * is being requested. Most drivers should not need ot use this. 542 */ 543 enum wps_mode wps; 544 545 /** 546 * p2p - Whether this connection is a P2P group 547 */ 548 int p2p; 549 550 /** 551 * uapsd - UAPSD parameters for the network 552 * -1 = do not change defaults 553 * AP mode: 1 = enabled, 0 = disabled 554 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE 555 */ 556 int uapsd; 557 558 /** 559 * fixed_bssid - Whether to force this BSSID in IBSS mode 560 * 1 = Fix this BSSID and prevent merges. 561 * 0 = Do not fix BSSID. 562 */ 563 int fixed_bssid; 564 565 /** 566 * disable_ht - Disable HT (IEEE 802.11n) for this connection 567 */ 568 int disable_ht; 569 570 /** 571 * HT Capabilities over-rides. Only bits set in the mask will be used, 572 * and not all values are used by the kernel anyway. Currently, MCS, 573 * MPDU and MSDU fields are used. 574 */ 575 const u8 *htcaps; /* struct ieee80211_ht_capabilities * */ 576 const u8 *htcaps_mask; /* struct ieee80211_ht_capabilities * */ 577 578#ifdef CONFIG_VHT_OVERRIDES 579 /** 580 * disable_vht - Disable VHT for this connection 581 */ 582 int disable_vht; 583 584 /** 585 * VHT capability overrides. 586 */ 587 const struct ieee80211_vht_capabilities *vhtcaps; 588 const struct ieee80211_vht_capabilities *vhtcaps_mask; 589#endif /* CONFIG_VHT_OVERRIDES */ 590}; 591 592enum hide_ssid { 593 NO_SSID_HIDING, 594 HIDDEN_SSID_ZERO_LEN, 595 HIDDEN_SSID_ZERO_CONTENTS 596}; 597 598struct wpa_driver_ap_params { 599 /** 600 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE 601 */ 602 const u8 *head; 603 604 /** 605 * head_len - Length of the head buffer in octets 606 */ 607 size_t head_len; 608 609 /** 610 * tail - Beacon tail following TIM IE 611 */ 612 const u8 *tail; 613 614 /** 615 * tail_len - Length of the tail buffer in octets 616 */ 617 size_t tail_len; 618 619 /** 620 * dtim_period - DTIM period 621 */ 622 int dtim_period; 623 624 /** 625 * beacon_int - Beacon interval 626 */ 627 int beacon_int; 628 629 /** 630 * basic_rates: -1 terminated array of basic rates in 100 kbps 631 * 632 * This parameter can be used to set a specific basic rate set for the 633 * BSS. If %NULL, default basic rate set is used. 634 */ 635 int *basic_rates; 636 637 /** 638 * proberesp - Probe Response template 639 * 640 * This is used by drivers that reply to Probe Requests internally in 641 * AP mode and require the full Probe Response template. 642 */ 643 const u8 *proberesp; 644 645 /** 646 * proberesp_len - Length of the proberesp buffer in octets 647 */ 648 size_t proberesp_len; 649 650 /** 651 * ssid - The SSID to use in Beacon/Probe Response frames 652 */ 653 const u8 *ssid; 654 655 /** 656 * ssid_len - Length of the SSID (1..32) 657 */ 658 size_t ssid_len; 659 660 /** 661 * hide_ssid - Whether to hide the SSID 662 */ 663 enum hide_ssid hide_ssid; 664 665 /** 666 * pairwise_ciphers - WPA_CIPHER_* bitfield 667 */ 668 unsigned int pairwise_ciphers; 669 670 /** 671 * group_cipher - WPA_CIPHER_* 672 */ 673 unsigned int group_cipher; 674 675 /** 676 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield 677 */ 678 unsigned int key_mgmt_suites; 679 680 /** 681 * auth_algs - WPA_AUTH_ALG_* bitfield 682 */ 683 unsigned int auth_algs; 684 685 /** 686 * wpa_version - WPA_PROTO_* bitfield 687 */ 688 unsigned int wpa_version; 689 690 /** 691 * privacy - Whether privacy is used in the BSS 692 */ 693 int privacy; 694 695 /** 696 * beacon_ies - WPS/P2P IE(s) for Beacon frames 697 * 698 * This is used to add IEs like WPS IE and P2P IE by drivers that do 699 * not use the full Beacon template. 700 */ 701 const struct wpabuf *beacon_ies; 702 703 /** 704 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames 705 * 706 * This is used to add IEs like WPS IE and P2P IE by drivers that 707 * reply to Probe Request frames internally. 708 */ 709 const struct wpabuf *proberesp_ies; 710 711 /** 712 * assocresp_ies - WPS IE(s) for (Re)Association Response frames 713 * 714 * This is used to add IEs like WPS IE by drivers that reply to 715 * (Re)Association Request frames internally. 716 */ 717 const struct wpabuf *assocresp_ies; 718 719 /** 720 * isolate - Whether to isolate frames between associated stations 721 * 722 * If this is non-zero, the AP is requested to disable forwarding of 723 * frames between associated stations. 724 */ 725 int isolate; 726 727 /** 728 * cts_protect - Whether CTS protection is enabled 729 */ 730 int cts_protect; 731 732 /** 733 * preamble - Whether short preamble is enabled 734 */ 735 int preamble; 736 737 /** 738 * short_slot_time - Whether short slot time is enabled 739 * 740 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do 741 * not set (e.g., when 802.11g mode is not in use) 742 */ 743 int short_slot_time; 744 745 /** 746 * ht_opmode - HT operation mode or -1 if HT not in use 747 */ 748 int ht_opmode; 749 750 /** 751 * interworking - Whether Interworking is enabled 752 */ 753 int interworking; 754 755 /** 756 * hessid - Homogeneous ESS identifier or %NULL if not set 757 */ 758 const u8 *hessid; 759 760 /** 761 * access_network_type - Access Network Type (0..15) 762 * 763 * This is used for filtering Probe Request frames when Interworking is 764 * enabled. 765 */ 766 u8 access_network_type; 767 768 /** 769 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity 770 * 771 * This is used by driver which advertises this capability. 772 */ 773 int ap_max_inactivity; 774 775 /** 776 * disable_dgaf - Whether group-addressed frames are disabled 777 */ 778 int disable_dgaf; 779}; 780 781/** 782 * struct wpa_driver_capa - Driver capability information 783 */ 784struct wpa_driver_capa { 785#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001 786#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002 787#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004 788#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008 789#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010 790#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020 791#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040 792#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080 793 unsigned int key_mgmt; 794 795#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001 796#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002 797#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004 798#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008 799#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010 800#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020 801 unsigned int enc; 802 803#define WPA_DRIVER_AUTH_OPEN 0x00000001 804#define WPA_DRIVER_AUTH_SHARED 0x00000002 805#define WPA_DRIVER_AUTH_LEAP 0x00000004 806 unsigned int auth; 807 808/* Driver generated WPA/RSN IE */ 809#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001 810/* Driver needs static WEP key setup after association command */ 811#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002 812/* unused: 0x00000004 */ 813/* Driver takes care of RSN 4-way handshake internally; PMK is configured with 814 * struct wpa_driver_ops::set_key using alg = WPA_ALG_PMK */ 815#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE 0x00000008 816#define WPA_DRIVER_FLAGS_WIRED 0x00000010 817/* Driver provides separate commands for authentication and association (SME in 818 * wpa_supplicant). */ 819#define WPA_DRIVER_FLAGS_SME 0x00000020 820/* Driver supports AP mode */ 821#define WPA_DRIVER_FLAGS_AP 0x00000040 822/* Driver needs static WEP key setup after association has been completed */ 823#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080 824/* Driver takes care of P2P management operations */ 825#define WPA_DRIVER_FLAGS_P2P_MGMT 0x00000100 826/* Driver supports concurrent P2P operations */ 827#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200 828/* 829 * Driver uses the initial interface as a dedicated management interface, i.e., 830 * it cannot be used for P2P group operations or non-P2P purposes. 831 */ 832#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400 833/* This interface is P2P capable (P2P Device, GO, or P2P Client */ 834#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800 835/* Driver supports concurrent operations on multiple channels */ 836#define WPA_DRIVER_FLAGS_MULTI_CHANNEL_CONCURRENT 0x00001000 837/* 838 * Driver uses the initial interface for P2P management interface and non-P2P 839 * purposes (e.g., connect to infra AP), but this interface cannot be used for 840 * P2P group operations. 841 */ 842#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000 843/* 844 * Driver is known to use sane error codes, i.e., when it indicates that 845 * something (e.g., association) fails, there was indeed a failure and the 846 * operation does not end up getting completed successfully later. 847 */ 848#define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000 849/* Driver supports off-channel TX */ 850#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000 851/* Driver indicates TX status events for EAPOL Data frames */ 852#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000 853/* Driver indicates TX status events for Deauth/Disassoc frames */ 854#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000 855/* Driver supports roaming (BSS selection) in firmware */ 856#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000 857/* Driver supports operating as a TDLS peer */ 858#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000 859/* Driver requires external TDLS setup/teardown/discovery */ 860#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000 861/* Driver indicates support for Probe Response offloading in AP mode */ 862#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000 863/* Driver supports U-APSD in AP mode */ 864#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000 865/* Driver supports inactivity timer in AP mode */ 866#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000 867/* Driver expects user space implementation of MLME in AP mode */ 868#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000 869/* Driver supports SAE with user space SME */ 870#define WPA_DRIVER_FLAGS_SAE 0x02000000 871/* Driver makes use of OBSS scan mechanism in wpa_supplicant */ 872#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000 873/* Driver supports IBSS (Ad-hoc) mode */ 874#define WPA_DRIVER_FLAGS_IBSS 0x08000000 875/* Driver supports radar detection */ 876#define WPA_DRIVER_FLAGS_RADAR 0x10000000 877 unsigned int flags; 878 879 int max_scan_ssids; 880 int max_sched_scan_ssids; 881 int sched_scan_supported; 882 int max_match_sets; 883 884 /** 885 * max_remain_on_chan - Maximum remain-on-channel duration in msec 886 */ 887 unsigned int max_remain_on_chan; 888 889 /** 890 * max_stations - Maximum number of associated stations the driver 891 * supports in AP mode 892 */ 893 unsigned int max_stations; 894 895 /** 896 * probe_resp_offloads - Bitmap of supported protocols by the driver 897 * for Probe Response offloading. 898 */ 899/* Driver Probe Response offloading support for WPS ver. 1 */ 900#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001 901/* Driver Probe Response offloading support for WPS ver. 2 */ 902#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002 903/* Driver Probe Response offloading support for P2P */ 904#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004 905/* Driver Probe Response offloading support for IEEE 802.11u (Interworking) */ 906#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008 907 unsigned int probe_resp_offloads; 908 909 /** 910 * extended_capa - extended capabilities in driver/device 911 * 912 * Must be allocated and freed by driver and the pointers must be 913 * valid for the lifetime of the driver, i.e., freed in deinit() 914 */ 915 const u8 *extended_capa, *extended_capa_mask; 916 unsigned int extended_capa_len; 917}; 918 919 920struct hostapd_data; 921 922struct hostap_sta_driver_data { 923 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes; 924 unsigned long current_tx_rate; 925 unsigned long inactive_msec; 926 unsigned long flags; 927 unsigned long num_ps_buf_frames; 928 unsigned long tx_retry_failed; 929 unsigned long tx_retry_count; 930 int last_rssi; 931 int last_ack_rssi; 932}; 933 934struct hostapd_sta_add_params { 935 const u8 *addr; 936 u16 aid; 937 u16 capability; 938 const u8 *supp_rates; 939 size_t supp_rates_len; 940 u16 listen_interval; 941 const struct ieee80211_ht_capabilities *ht_capabilities; 942 const struct ieee80211_vht_capabilities *vht_capabilities; 943 u32 flags; /* bitmask of WPA_STA_* flags */ 944 int set; /* Set STA parameters instead of add */ 945 u8 qosinfo; 946 const u8 *ext_capab; 947 size_t ext_capab_len; 948}; 949 950struct hostapd_freq_params { 951 int mode; 952 int freq; 953 int channel; 954 /* for HT */ 955 int ht_enabled; 956 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled, 957 * secondary channel below primary, 1 = HT40 958 * enabled, secondary channel above primary */ 959 960 /* for VHT */ 961 int vht_enabled; 962 963 /* valid for both HT and VHT, center_freq2 is non-zero 964 * only for bandwidth 80 and an 80+80 channel */ 965 int center_freq1, center_freq2; 966 int bandwidth; 967}; 968 969enum wpa_driver_if_type { 970 /** 971 * WPA_IF_STATION - Station mode interface 972 */ 973 WPA_IF_STATION, 974 975 /** 976 * WPA_IF_AP_VLAN - AP mode VLAN interface 977 * 978 * This interface shares its address and Beacon frame with the main 979 * BSS. 980 */ 981 WPA_IF_AP_VLAN, 982 983 /** 984 * WPA_IF_AP_BSS - AP mode BSS interface 985 * 986 * This interface has its own address and Beacon frame. 987 */ 988 WPA_IF_AP_BSS, 989 990 /** 991 * WPA_IF_P2P_GO - P2P Group Owner 992 */ 993 WPA_IF_P2P_GO, 994 995 /** 996 * WPA_IF_P2P_CLIENT - P2P Client 997 */ 998 WPA_IF_P2P_CLIENT, 999 1000 /** 1001 * WPA_IF_P2P_GROUP - P2P Group interface (will become either 1002 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known) 1003 */ 1004 WPA_IF_P2P_GROUP 1005}; 1006 1007struct wpa_init_params { 1008 void *global_priv; 1009 const u8 *bssid; 1010 const char *ifname; 1011 const u8 *ssid; 1012 size_t ssid_len; 1013 const char *test_socket; 1014 int use_pae_group_addr; 1015 char **bridge; 1016 size_t num_bridge; 1017 1018 u8 *own_addr; /* buffer for writing own MAC address */ 1019}; 1020 1021 1022struct wpa_bss_params { 1023 /** Interface name (for multi-SSID/VLAN support) */ 1024 const char *ifname; 1025 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */ 1026 int enabled; 1027 1028 int wpa; 1029 int ieee802_1x; 1030 int wpa_group; 1031 int wpa_pairwise; 1032 int wpa_key_mgmt; 1033 int rsn_preauth; 1034 enum mfp_options ieee80211w; 1035}; 1036 1037#define WPA_STA_AUTHORIZED BIT(0) 1038#define WPA_STA_WMM BIT(1) 1039#define WPA_STA_SHORT_PREAMBLE BIT(2) 1040#define WPA_STA_MFP BIT(3) 1041#define WPA_STA_TDLS_PEER BIT(4) 1042 1043/** 1044 * struct p2p_params - P2P parameters for driver-based P2P management 1045 */ 1046struct p2p_params { 1047 const char *dev_name; 1048 u8 pri_dev_type[8]; 1049#define DRV_MAX_SEC_DEV_TYPES 5 1050 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8]; 1051 size_t num_sec_dev_types; 1052}; 1053 1054enum tdls_oper { 1055 TDLS_DISCOVERY_REQ, 1056 TDLS_SETUP, 1057 TDLS_TEARDOWN, 1058 TDLS_ENABLE_LINK, 1059 TDLS_DISABLE_LINK, 1060 TDLS_ENABLE, 1061 TDLS_DISABLE 1062}; 1063 1064enum wnm_oper { 1065 WNM_SLEEP_ENTER_CONFIRM, 1066 WNM_SLEEP_ENTER_FAIL, 1067 WNM_SLEEP_EXIT_CONFIRM, 1068 WNM_SLEEP_EXIT_FAIL, 1069 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */ 1070 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */ 1071 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for 1072 * a STA */ 1073 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE 1074 * for a STA */ 1075 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */ 1076 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE 1077 * for a STA */ 1078 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */ 1079}; 1080 1081/** 1082 * struct wpa_signal_info - Information about channel signal quality 1083 */ 1084struct wpa_signal_info { 1085 u32 frequency; 1086 int above_threshold; 1087 int current_signal; 1088 int current_noise; 1089 int current_txrate; 1090}; 1091 1092/** 1093 * struct wpa_driver_ops - Driver interface API definition 1094 * 1095 * This structure defines the API that each driver interface needs to implement 1096 * for core wpa_supplicant code. All driver specific functionality is captured 1097 * in this wrapper. 1098 */ 1099struct wpa_driver_ops { 1100 /** Name of the driver interface */ 1101 const char *name; 1102 /** One line description of the driver interface */ 1103 const char *desc; 1104 1105 /** 1106 * get_bssid - Get the current BSSID 1107 * @priv: private driver interface data 1108 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes) 1109 * 1110 * Returns: 0 on success, -1 on failure 1111 * 1112 * Query kernel driver for the current BSSID and copy it to bssid. 1113 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not 1114 * associated. 1115 */ 1116 int (*get_bssid)(void *priv, u8 *bssid); 1117 1118 /** 1119 * get_ssid - Get the current SSID 1120 * @priv: private driver interface data 1121 * @ssid: buffer for SSID (at least 32 bytes) 1122 * 1123 * Returns: Length of the SSID on success, -1 on failure 1124 * 1125 * Query kernel driver for the current SSID and copy it to ssid. 1126 * Returning zero is recommended if the STA is not associated. 1127 * 1128 * Note: SSID is an array of octets, i.e., it is not nul terminated and 1129 * can, at least in theory, contain control characters (including nul) 1130 * and as such, should be processed as binary data, not a printable 1131 * string. 1132 */ 1133 int (*get_ssid)(void *priv, u8 *ssid); 1134 1135 /** 1136 * set_key - Configure encryption key 1137 * @ifname: Interface name (for multi-SSID/VLAN support) 1138 * @priv: private driver interface data 1139 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP, 1140 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK, 1141 * %WPA_ALG_GCMP); 1142 * %WPA_ALG_NONE clears the key. 1143 * @addr: Address of the peer STA (BSSID of the current AP when setting 1144 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for 1145 * broadcast keys, %NULL for default keys that are used both for 1146 * broadcast and unicast; when clearing keys, %NULL is used to 1147 * indicate that both the broadcast-only and default key of the 1148 * specified key index is to be cleared 1149 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for 1150 * IGTK 1151 * @set_tx: configure this key as the default Tx key (only used when 1152 * driver does not support separate unicast/individual key 1153 * @seq: sequence number/packet number, seq_len octets, the next 1154 * packet number to be used for in replay protection; configured 1155 * for Rx keys (in most cases, this is only used with broadcast 1156 * keys and set to zero for unicast keys); %NULL if not set 1157 * @seq_len: length of the seq, depends on the algorithm: 1158 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets 1159 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key, 1160 * 8-byte Rx Mic Key 1161 * @key_len: length of the key buffer in octets (WEP: 5 or 13, 1162 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16) 1163 * 1164 * Returns: 0 on success, -1 on failure 1165 * 1166 * Configure the given key for the kernel driver. If the driver 1167 * supports separate individual keys (4 default keys + 1 individual), 1168 * addr can be used to determine whether the key is default or 1169 * individual. If only 4 keys are supported, the default key with key 1170 * index 0 is used as the individual key. STA must be configured to use 1171 * it as the default Tx key (set_tx is set) and accept Rx for all the 1172 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for 1173 * broadcast keys, so key index 0 is available for this kind of 1174 * configuration. 1175 * 1176 * Please note that TKIP keys include separate TX and RX MIC keys and 1177 * some drivers may expect them in different order than wpa_supplicant 1178 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets 1179 * will trigger Michael MIC errors. This can be fixed by changing the 1180 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key 1181 * in driver_*.c set_key() implementation, see driver_ndis.c for an 1182 * example on how this can be done. 1183 */ 1184 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg, 1185 const u8 *addr, int key_idx, int set_tx, 1186 const u8 *seq, size_t seq_len, 1187 const u8 *key, size_t key_len); 1188 1189 /** 1190 * init - Initialize driver interface 1191 * @ctx: context to be used when calling wpa_supplicant functions, 1192 * e.g., wpa_supplicant_event() 1193 * @ifname: interface name, e.g., wlan0 1194 * 1195 * Returns: Pointer to private data, %NULL on failure 1196 * 1197 * Initialize driver interface, including event processing for kernel 1198 * driver events (e.g., associated, scan results, Michael MIC failure). 1199 * This function can allocate a private configuration data area for 1200 * @ctx, file descriptor, interface name, etc. information that may be 1201 * needed in future driver operations. If this is not used, non-NULL 1202 * value will need to be returned because %NULL is used to indicate 1203 * failure. The returned value will be used as 'void *priv' data for 1204 * all other driver_ops functions. 1205 * 1206 * The main event loop (eloop.c) of wpa_supplicant can be used to 1207 * register callback for read sockets (eloop_register_read_sock()). 1208 * 1209 * See below for more information about events and 1210 * wpa_supplicant_event() function. 1211 */ 1212 void * (*init)(void *ctx, const char *ifname); 1213 1214 /** 1215 * deinit - Deinitialize driver interface 1216 * @priv: private driver interface data from init() 1217 * 1218 * Shut down driver interface and processing of driver events. Free 1219 * private data buffer if one was allocated in init() handler. 1220 */ 1221 void (*deinit)(void *priv); 1222 1223 /** 1224 * set_param - Set driver configuration parameters 1225 * @priv: private driver interface data from init() 1226 * @param: driver specific configuration parameters 1227 * 1228 * Returns: 0 on success, -1 on failure 1229 * 1230 * Optional handler for notifying driver interface about configuration 1231 * parameters (driver_param). 1232 */ 1233 int (*set_param)(void *priv, const char *param); 1234 1235 /** 1236 * set_countermeasures - Enable/disable TKIP countermeasures 1237 * @priv: private driver interface data 1238 * @enabled: 1 = countermeasures enabled, 0 = disabled 1239 * 1240 * Returns: 0 on success, -1 on failure 1241 * 1242 * Configure TKIP countermeasures. When these are enabled, the driver 1243 * should drop all received and queued frames that are using TKIP. 1244 */ 1245 int (*set_countermeasures)(void *priv, int enabled); 1246 1247 /** 1248 * deauthenticate - Request driver to deauthenticate 1249 * @priv: private driver interface data 1250 * @addr: peer address (BSSID of the AP) 1251 * @reason_code: 16-bit reason code to be sent in the deauthentication 1252 * frame 1253 * 1254 * Returns: 0 on success, -1 on failure 1255 */ 1256 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code); 1257 1258 /** 1259 * associate - Request driver to associate 1260 * @priv: private driver interface data 1261 * @params: association parameters 1262 * 1263 * Returns: 0 on success, -1 on failure 1264 */ 1265 int (*associate)(void *priv, 1266 struct wpa_driver_associate_params *params); 1267 1268 /** 1269 * add_pmkid - Add PMKSA cache entry to the driver 1270 * @priv: private driver interface data 1271 * @bssid: BSSID for the PMKSA cache entry 1272 * @pmkid: PMKID for the PMKSA cache entry 1273 * 1274 * Returns: 0 on success, -1 on failure 1275 * 1276 * This function is called when a new PMK is received, as a result of 1277 * either normal authentication or RSN pre-authentication. 1278 * 1279 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 1280 * associate(), add_pmkid() can be used to add new PMKSA cache entries 1281 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this 1282 * driver_ops function does not need to be implemented. Likewise, if 1283 * the driver does not support WPA, this function is not needed. 1284 */ 1285 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid); 1286 1287 /** 1288 * remove_pmkid - Remove PMKSA cache entry to the driver 1289 * @priv: private driver interface data 1290 * @bssid: BSSID for the PMKSA cache entry 1291 * @pmkid: PMKID for the PMKSA cache entry 1292 * 1293 * Returns: 0 on success, -1 on failure 1294 * 1295 * This function is called when the supplicant drops a PMKSA cache 1296 * entry for any reason. 1297 * 1298 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 1299 * associate(), remove_pmkid() can be used to synchronize PMKSA caches 1300 * between the driver and wpa_supplicant. If the driver uses wpa_ie 1301 * from wpa_supplicant, this driver_ops function does not need to be 1302 * implemented. Likewise, if the driver does not support WPA, this 1303 * function is not needed. 1304 */ 1305 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid); 1306 1307 /** 1308 * flush_pmkid - Flush PMKSA cache 1309 * @priv: private driver interface data 1310 * 1311 * Returns: 0 on success, -1 on failure 1312 * 1313 * This function is called when the supplicant drops all PMKSA cache 1314 * entries for any reason. 1315 * 1316 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 1317 * associate(), remove_pmkid() can be used to synchronize PMKSA caches 1318 * between the driver and wpa_supplicant. If the driver uses wpa_ie 1319 * from wpa_supplicant, this driver_ops function does not need to be 1320 * implemented. Likewise, if the driver does not support WPA, this 1321 * function is not needed. 1322 */ 1323 int (*flush_pmkid)(void *priv); 1324 1325 /** 1326 * get_capa - Get driver capabilities 1327 * @priv: private driver interface data 1328 * 1329 * Returns: 0 on success, -1 on failure 1330 * 1331 * Get driver/firmware/hardware capabilities. 1332 */ 1333 int (*get_capa)(void *priv, struct wpa_driver_capa *capa); 1334 1335 /** 1336 * poll - Poll driver for association information 1337 * @priv: private driver interface data 1338 * 1339 * This is an option callback that can be used when the driver does not 1340 * provide event mechanism for association events. This is called when 1341 * receiving WPA EAPOL-Key messages that require association 1342 * information. The driver interface is supposed to generate associnfo 1343 * event before returning from this callback function. In addition, the 1344 * driver interface should generate an association event after having 1345 * sent out associnfo. 1346 */ 1347 void (*poll)(void *priv); 1348 1349 /** 1350 * get_ifname - Get interface name 1351 * @priv: private driver interface data 1352 * 1353 * Returns: Pointer to the interface name. This can differ from the 1354 * interface name used in init() call. Init() is called first. 1355 * 1356 * This optional function can be used to allow the driver interface to 1357 * replace the interface name with something else, e.g., based on an 1358 * interface mapping from a more descriptive name. 1359 */ 1360 const char * (*get_ifname)(void *priv); 1361 1362 /** 1363 * get_mac_addr - Get own MAC address 1364 * @priv: private driver interface data 1365 * 1366 * Returns: Pointer to own MAC address or %NULL on failure 1367 * 1368 * This optional function can be used to get the own MAC address of the 1369 * device from the driver interface code. This is only needed if the 1370 * l2_packet implementation for the OS does not provide easy access to 1371 * a MAC address. */ 1372 const u8 * (*get_mac_addr)(void *priv); 1373 1374 /** 1375 * send_eapol - Optional function for sending EAPOL packets 1376 * @priv: private driver interface data 1377 * @dest: Destination MAC address 1378 * @proto: Ethertype 1379 * @data: EAPOL packet starting with IEEE 802.1X header 1380 * @data_len: Size of the EAPOL packet 1381 * 1382 * Returns: 0 on success, -1 on failure 1383 * 1384 * This optional function can be used to override l2_packet operations 1385 * with driver specific functionality. If this function pointer is set, 1386 * l2_packet module is not used at all and the driver interface code is 1387 * responsible for receiving and sending all EAPOL packets. The 1388 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX 1389 * event. The driver interface is required to implement get_mac_addr() 1390 * handler if send_eapol() is used. 1391 */ 1392 int (*send_eapol)(void *priv, const u8 *dest, u16 proto, 1393 const u8 *data, size_t data_len); 1394 1395 /** 1396 * set_operstate - Sets device operating state to DORMANT or UP 1397 * @priv: private driver interface data 1398 * @state: 0 = dormant, 1 = up 1399 * Returns: 0 on success, -1 on failure 1400 * 1401 * This is an optional function that can be used on operating systems 1402 * that support a concept of controlling network device state from user 1403 * space applications. This function, if set, gets called with 1404 * state = 1 when authentication has been completed and with state = 0 1405 * when connection is lost. 1406 */ 1407 int (*set_operstate)(void *priv, int state); 1408 1409 /** 1410 * mlme_setprotection - MLME-SETPROTECTION.request primitive 1411 * @priv: Private driver interface data 1412 * @addr: Address of the station for which to set protection (may be 1413 * %NULL for group keys) 1414 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_* 1415 * @key_type: MLME_SETPROTECTION_KEY_TYPE_* 1416 * Returns: 0 on success, -1 on failure 1417 * 1418 * This is an optional function that can be used to set the driver to 1419 * require protection for Tx and/or Rx frames. This uses the layer 1420 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1 1421 * (MLME-SETPROTECTION.request). Many drivers do not use explicit 1422 * set protection operation; instead, they set protection implicitly 1423 * based on configured keys. 1424 */ 1425 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type, 1426 int key_type); 1427 1428 /** 1429 * get_hw_feature_data - Get hardware support data (channels and rates) 1430 * @priv: Private driver interface data 1431 * @num_modes: Variable for returning the number of returned modes 1432 * flags: Variable for returning hardware feature flags 1433 * Returns: Pointer to allocated hardware data on success or %NULL on 1434 * failure. Caller is responsible for freeing this. 1435 */ 1436 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv, 1437 u16 *num_modes, 1438 u16 *flags); 1439 1440 /** 1441 * send_mlme - Send management frame from MLME 1442 * @priv: Private driver interface data 1443 * @data: IEEE 802.11 management frame with IEEE 802.11 header 1444 * @data_len: Size of the management frame 1445 * @noack: Do not wait for this frame to be acked (disable retries) 1446 * Returns: 0 on success, -1 on failure 1447 */ 1448 int (*send_mlme)(void *priv, const u8 *data, size_t data_len, 1449 int noack); 1450 1451 /** 1452 * update_ft_ies - Update FT (IEEE 802.11r) IEs 1453 * @priv: Private driver interface data 1454 * @md: Mobility domain (2 octets) (also included inside ies) 1455 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs 1456 * @ies_len: Length of FT IEs in bytes 1457 * Returns: 0 on success, -1 on failure 1458 * 1459 * The supplicant uses this callback to let the driver know that keying 1460 * material for FT is available and that the driver can use the 1461 * provided IEs in the next message in FT authentication sequence. 1462 * 1463 * This function is only needed for driver that support IEEE 802.11r 1464 * (Fast BSS Transition). 1465 */ 1466 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies, 1467 size_t ies_len); 1468 1469 /** 1470 * send_ft_action - Send FT Action frame (IEEE 802.11r) 1471 * @priv: Private driver interface data 1472 * @action: Action field value 1473 * @target_ap: Target AP address 1474 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body) 1475 * @ies_len: Length of FT IEs in bytes 1476 * Returns: 0 on success, -1 on failure 1477 * 1478 * The supplicant uses this callback to request the driver to transmit 1479 * an FT Action frame (action category 6) for over-the-DS fast BSS 1480 * transition. 1481 */ 1482 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap, 1483 const u8 *ies, size_t ies_len); 1484 1485 /** 1486 * get_scan_results2 - Fetch the latest scan results 1487 * @priv: private driver interface data 1488 * 1489 * Returns: Allocated buffer of scan results (caller is responsible for 1490 * freeing the data structure) on success, NULL on failure 1491 */ 1492 struct wpa_scan_results * (*get_scan_results2)(void *priv); 1493 1494 /** 1495 * set_country - Set country 1496 * @priv: Private driver interface data 1497 * @alpha2: country to which to switch to 1498 * Returns: 0 on success, -1 on failure 1499 * 1500 * This function is for drivers which support some form 1501 * of setting a regulatory domain. 1502 */ 1503 int (*set_country)(void *priv, const char *alpha2); 1504 1505 /** 1506 * global_init - Global driver initialization 1507 * Returns: Pointer to private data (global), %NULL on failure 1508 * 1509 * This optional function is called to initialize the driver wrapper 1510 * for global data, i.e., data that applies to all interfaces. If this 1511 * function is implemented, global_deinit() will also need to be 1512 * implemented to free the private data. The driver will also likely 1513 * use init2() function instead of init() to get the pointer to global 1514 * data available to per-interface initializer. 1515 */ 1516 void * (*global_init)(void); 1517 1518 /** 1519 * global_deinit - Global driver deinitialization 1520 * @priv: private driver global data from global_init() 1521 * 1522 * Terminate any global driver related functionality and free the 1523 * global data structure. 1524 */ 1525 void (*global_deinit)(void *priv); 1526 1527 /** 1528 * init2 - Initialize driver interface (with global data) 1529 * @ctx: context to be used when calling wpa_supplicant functions, 1530 * e.g., wpa_supplicant_event() 1531 * @ifname: interface name, e.g., wlan0 1532 * @global_priv: private driver global data from global_init() 1533 * Returns: Pointer to private data, %NULL on failure 1534 * 1535 * This function can be used instead of init() if the driver wrapper 1536 * uses global data. 1537 */ 1538 void * (*init2)(void *ctx, const char *ifname, void *global_priv); 1539 1540 /** 1541 * get_interfaces - Get information about available interfaces 1542 * @global_priv: private driver global data from global_init() 1543 * Returns: Allocated buffer of interface information (caller is 1544 * responsible for freeing the data structure) on success, NULL on 1545 * failure 1546 */ 1547 struct wpa_interface_info * (*get_interfaces)(void *global_priv); 1548 1549 /** 1550 * scan2 - Request the driver to initiate scan 1551 * @priv: private driver interface data 1552 * @params: Scan parameters 1553 * 1554 * Returns: 0 on success, -1 on failure 1555 * 1556 * Once the scan results are ready, the driver should report scan 1557 * results event for wpa_supplicant which will eventually request the 1558 * results with wpa_driver_get_scan_results2(). 1559 */ 1560 int (*scan2)(void *priv, struct wpa_driver_scan_params *params); 1561 1562 /** 1563 * authenticate - Request driver to authenticate 1564 * @priv: private driver interface data 1565 * @params: authentication parameters 1566 * Returns: 0 on success, -1 on failure 1567 * 1568 * This is an optional function that can be used with drivers that 1569 * support separate authentication and association steps, i.e., when 1570 * wpa_supplicant can act as the SME. If not implemented, associate() 1571 * function is expected to take care of IEEE 802.11 authentication, 1572 * too. 1573 */ 1574 int (*authenticate)(void *priv, 1575 struct wpa_driver_auth_params *params); 1576 1577 /** 1578 * set_ap - Set Beacon and Probe Response information for AP mode 1579 * @priv: Private driver interface data 1580 * @params: Parameters to use in AP mode 1581 * 1582 * This function is used to configure Beacon template and/or extra IEs 1583 * to add for Beacon and Probe Response frames for the driver in 1584 * AP mode. The driver is responsible for building the full Beacon 1585 * frame by concatenating the head part with TIM IE generated by the 1586 * driver/firmware and finishing with the tail part. Depending on the 1587 * driver architectue, this can be done either by using the full 1588 * template or the set of additional IEs (e.g., WPS and P2P IE). 1589 * Similarly, Probe Response processing depends on the driver design. 1590 * If the driver (or firmware) takes care of replying to Probe Request 1591 * frames, the extra IEs provided here needs to be added to the Probe 1592 * Response frames. 1593 * 1594 * Returns: 0 on success, -1 on failure 1595 */ 1596 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params); 1597 1598 /** 1599 * hapd_init - Initialize driver interface (hostapd only) 1600 * @hapd: Pointer to hostapd context 1601 * @params: Configuration for the driver wrapper 1602 * Returns: Pointer to private data, %NULL on failure 1603 * 1604 * This function is used instead of init() or init2() when the driver 1605 * wrapper is used with hostapd. 1606 */ 1607 void * (*hapd_init)(struct hostapd_data *hapd, 1608 struct wpa_init_params *params); 1609 1610 /** 1611 * hapd_deinit - Deinitialize driver interface (hostapd only) 1612 * @priv: Private driver interface data from hapd_init() 1613 */ 1614 void (*hapd_deinit)(void *priv); 1615 1616 /** 1617 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only) 1618 * @priv: Private driver interface data 1619 * @params: BSS parameters 1620 * Returns: 0 on success, -1 on failure 1621 * 1622 * This is an optional function to configure the kernel driver to 1623 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This 1624 * can be left undefined (set to %NULL) if IEEE 802.1X support is 1625 * always enabled and the driver uses set_ap() to set WPA/RSN IE 1626 * for Beacon frames. 1627 * 1628 * DEPRECATED - use set_ap() instead 1629 */ 1630 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params); 1631 1632 /** 1633 * set_privacy - Enable/disable privacy (AP only) 1634 * @priv: Private driver interface data 1635 * @enabled: 1 = privacy enabled, 0 = disabled 1636 * Returns: 0 on success, -1 on failure 1637 * 1638 * This is an optional function to configure privacy field in the 1639 * kernel driver for Beacon frames. This can be left undefined (set to 1640 * %NULL) if the driver uses the Beacon template from set_ap(). 1641 * 1642 * DEPRECATED - use set_ap() instead 1643 */ 1644 int (*set_privacy)(void *priv, int enabled); 1645 1646 /** 1647 * get_seqnum - Fetch the current TSC/packet number (AP only) 1648 * @ifname: The interface name (main or virtual) 1649 * @priv: Private driver interface data 1650 * @addr: MAC address of the station or %NULL for group keys 1651 * @idx: Key index 1652 * @seq: Buffer for returning the latest used TSC/packet number 1653 * Returns: 0 on success, -1 on failure 1654 * 1655 * This function is used to fetch the last used TSC/packet number for 1656 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group 1657 * keys, so there is no strict requirement on implementing support for 1658 * unicast keys (i.e., addr != %NULL). 1659 */ 1660 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr, 1661 int idx, u8 *seq); 1662 1663 /** 1664 * flush - Flush all association stations (AP only) 1665 * @priv: Private driver interface data 1666 * Returns: 0 on success, -1 on failure 1667 * 1668 * This function requests the driver to disassociate all associated 1669 * stations. This function does not need to be implemented if the 1670 * driver does not process association frames internally. 1671 */ 1672 int (*flush)(void *priv); 1673 1674 /** 1675 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP) 1676 * @priv: Private driver interface data 1677 * @elem: Information elements 1678 * @elem_len: Length of the elem buffer in octets 1679 * Returns: 0 on success, -1 on failure 1680 * 1681 * This is an optional function to add information elements in the 1682 * kernel driver for Beacon and Probe Response frames. This can be left 1683 * undefined (set to %NULL) if the driver uses the Beacon template from 1684 * set_ap(). 1685 * 1686 * DEPRECATED - use set_ap() instead 1687 */ 1688 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len); 1689 1690 /** 1691 * read_sta_data - Fetch station data 1692 * @priv: Private driver interface data 1693 * @data: Buffer for returning station information 1694 * @addr: MAC address of the station 1695 * Returns: 0 on success, -1 on failure 1696 */ 1697 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data, 1698 const u8 *addr); 1699 1700 /** 1701 * hapd_send_eapol - Send an EAPOL packet (AP only) 1702 * @priv: private driver interface data 1703 * @addr: Destination MAC address 1704 * @data: EAPOL packet starting with IEEE 802.1X header 1705 * @data_len: Length of the EAPOL packet in octets 1706 * @encrypt: Whether the frame should be encrypted 1707 * @own_addr: Source MAC address 1708 * @flags: WPA_STA_* flags for the destination station 1709 * 1710 * Returns: 0 on success, -1 on failure 1711 */ 1712 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data, 1713 size_t data_len, int encrypt, 1714 const u8 *own_addr, u32 flags); 1715 1716 /** 1717 * sta_deauth - Deauthenticate a station (AP only) 1718 * @priv: Private driver interface data 1719 * @own_addr: Source address and BSSID for the Deauthentication frame 1720 * @addr: MAC address of the station to deauthenticate 1721 * @reason: Reason code for the Deauthentiation frame 1722 * Returns: 0 on success, -1 on failure 1723 * 1724 * This function requests a specific station to be deauthenticated and 1725 * a Deauthentication frame to be sent to it. 1726 */ 1727 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr, 1728 int reason); 1729 1730 /** 1731 * sta_disassoc - Disassociate a station (AP only) 1732 * @priv: Private driver interface data 1733 * @own_addr: Source address and BSSID for the Disassociation frame 1734 * @addr: MAC address of the station to disassociate 1735 * @reason: Reason code for the Disassociation frame 1736 * Returns: 0 on success, -1 on failure 1737 * 1738 * This function requests a specific station to be disassociated and 1739 * a Disassociation frame to be sent to it. 1740 */ 1741 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr, 1742 int reason); 1743 1744 /** 1745 * sta_remove - Remove a station entry (AP only) 1746 * @priv: Private driver interface data 1747 * @addr: MAC address of the station to be removed 1748 * Returns: 0 on success, -1 on failure 1749 */ 1750 int (*sta_remove)(void *priv, const u8 *addr); 1751 1752 /** 1753 * hapd_get_ssid - Get the current SSID (AP only) 1754 * @priv: Private driver interface data 1755 * @buf: Buffer for returning the SSID 1756 * @len: Maximum length of the buffer 1757 * Returns: Length of the SSID on success, -1 on failure 1758 * 1759 * This function need not be implemented if the driver uses Beacon 1760 * template from set_ap() and does not reply to Probe Request frames. 1761 */ 1762 int (*hapd_get_ssid)(void *priv, u8 *buf, int len); 1763 1764 /** 1765 * hapd_set_ssid - Set SSID (AP only) 1766 * @priv: Private driver interface data 1767 * @buf: SSID 1768 * @len: Length of the SSID in octets 1769 * Returns: 0 on success, -1 on failure 1770 * 1771 * DEPRECATED - use set_ap() instead 1772 */ 1773 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len); 1774 1775 /** 1776 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP) 1777 * @priv: Private driver interface data 1778 * @enabled: 1 = countermeasures enabled, 0 = disabled 1779 * Returns: 0 on success, -1 on failure 1780 * 1781 * This need not be implemented if the driver does not take care of 1782 * association processing. 1783 */ 1784 int (*hapd_set_countermeasures)(void *priv, int enabled); 1785 1786 /** 1787 * sta_add - Add a station entry 1788 * @priv: Private driver interface data 1789 * @params: Station parameters 1790 * Returns: 0 on success, -1 on failure 1791 * 1792 * This function is used to add a station entry to the driver once the 1793 * station has completed association. This is only used if the driver 1794 * does not take care of association processing. 1795 * 1796 * With TDLS, this function is also used to add or set (params->set 1) 1797 * TDLS peer entries. 1798 */ 1799 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params); 1800 1801 /** 1802 * get_inact_sec - Get station inactivity duration (AP only) 1803 * @priv: Private driver interface data 1804 * @addr: Station address 1805 * Returns: Number of seconds station has been inactive, -1 on failure 1806 */ 1807 int (*get_inact_sec)(void *priv, const u8 *addr); 1808 1809 /** 1810 * sta_clear_stats - Clear station statistics (AP only) 1811 * @priv: Private driver interface data 1812 * @addr: Station address 1813 * Returns: 0 on success, -1 on failure 1814 */ 1815 int (*sta_clear_stats)(void *priv, const u8 *addr); 1816 1817 /** 1818 * set_freq - Set channel/frequency (AP only) 1819 * @priv: Private driver interface data 1820 * @freq: Channel parameters 1821 * Returns: 0 on success, -1 on failure 1822 */ 1823 int (*set_freq)(void *priv, struct hostapd_freq_params *freq); 1824 1825 /** 1826 * set_rts - Set RTS threshold 1827 * @priv: Private driver interface data 1828 * @rts: RTS threshold in octets 1829 * Returns: 0 on success, -1 on failure 1830 */ 1831 int (*set_rts)(void *priv, int rts); 1832 1833 /** 1834 * set_frag - Set fragmentation threshold 1835 * @priv: Private driver interface data 1836 * @frag: Fragmentation threshold in octets 1837 * Returns: 0 on success, -1 on failure 1838 */ 1839 int (*set_frag)(void *priv, int frag); 1840 1841 /** 1842 * sta_set_flags - Set station flags (AP only) 1843 * @priv: Private driver interface data 1844 * @addr: Station address 1845 * @total_flags: Bitmap of all WPA_STA_* flags currently set 1846 * @flags_or: Bitmap of WPA_STA_* flags to add 1847 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask 1848 * Returns: 0 on success, -1 on failure 1849 */ 1850 int (*sta_set_flags)(void *priv, const u8 *addr, 1851 int total_flags, int flags_or, int flags_and); 1852 1853 /** 1854 * set_tx_queue_params - Set TX queue parameters 1855 * @priv: Private driver interface data 1856 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK) 1857 * @aifs: AIFS 1858 * @cw_min: cwMin 1859 * @cw_max: cwMax 1860 * @burst_time: Maximum length for bursting in 0.1 msec units 1861 */ 1862 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min, 1863 int cw_max, int burst_time); 1864 1865 /** 1866 * if_add - Add a virtual interface 1867 * @priv: Private driver interface data 1868 * @type: Interface type 1869 * @ifname: Interface name for the new virtual interface 1870 * @addr: Local address to use for the interface or %NULL to use the 1871 * parent interface address 1872 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces 1873 * @drv_priv: Pointer for overwriting the driver context or %NULL if 1874 * not allowed (applies only to %WPA_IF_AP_BSS type) 1875 * @force_ifname: Buffer for returning an interface name that the 1876 * driver ended up using if it differs from the requested ifname 1877 * @if_addr: Buffer for returning the allocated interface address 1878 * (this may differ from the requested addr if the driver cannot 1879 * change interface address) 1880 * @bridge: Bridge interface to use or %NULL if no bridge configured 1881 * Returns: 0 on success, -1 on failure 1882 */ 1883 int (*if_add)(void *priv, enum wpa_driver_if_type type, 1884 const char *ifname, const u8 *addr, void *bss_ctx, 1885 void **drv_priv, char *force_ifname, u8 *if_addr, 1886 const char *bridge); 1887 1888 /** 1889 * if_remove - Remove a virtual interface 1890 * @priv: Private driver interface data 1891 * @type: Interface type 1892 * @ifname: Interface name of the virtual interface to be removed 1893 * Returns: 0 on success, -1 on failure 1894 */ 1895 int (*if_remove)(void *priv, enum wpa_driver_if_type type, 1896 const char *ifname); 1897 1898 /** 1899 * set_sta_vlan - Bind a station into a specific interface (AP only) 1900 * @priv: Private driver interface data 1901 * @ifname: Interface (main or virtual BSS or VLAN) 1902 * @addr: MAC address of the associated station 1903 * @vlan_id: VLAN ID 1904 * Returns: 0 on success, -1 on failure 1905 * 1906 * This function is used to bind a station to a specific virtual 1907 * interface. It is only used if when virtual interfaces are supported, 1908 * e.g., to assign stations to different VLAN interfaces based on 1909 * information from a RADIUS server. This allows separate broadcast 1910 * domains to be used with a single BSS. 1911 */ 1912 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname, 1913 int vlan_id); 1914 1915 /** 1916 * commit - Optional commit changes handler (AP only) 1917 * @priv: driver private data 1918 * Returns: 0 on success, -1 on failure 1919 * 1920 * This optional handler function can be registered if the driver 1921 * interface implementation needs to commit changes (e.g., by setting 1922 * network interface up) at the end of initial configuration. If set, 1923 * this handler will be called after initial setup has been completed. 1924 */ 1925 int (*commit)(void *priv); 1926 1927 /** 1928 * send_ether - Send an ethernet packet (AP only) 1929 * @priv: private driver interface data 1930 * @dst: Destination MAC address 1931 * @src: Source MAC address 1932 * @proto: Ethertype 1933 * @data: EAPOL packet starting with IEEE 802.1X header 1934 * @data_len: Length of the EAPOL packet in octets 1935 * Returns: 0 on success, -1 on failure 1936 */ 1937 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto, 1938 const u8 *data, size_t data_len); 1939 1940 /** 1941 * set_radius_acl_auth - Notification of RADIUS ACL change 1942 * @priv: Private driver interface data 1943 * @mac: MAC address of the station 1944 * @accepted: Whether the station was accepted 1945 * @session_timeout: Session timeout for the station 1946 * Returns: 0 on success, -1 on failure 1947 */ 1948 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted, 1949 u32 session_timeout); 1950 1951 /** 1952 * set_radius_acl_expire - Notification of RADIUS ACL expiration 1953 * @priv: Private driver interface data 1954 * @mac: MAC address of the station 1955 * Returns: 0 on success, -1 on failure 1956 */ 1957 int (*set_radius_acl_expire)(void *priv, const u8 *mac); 1958 1959 /** 1960 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP) 1961 * @priv: Private driver interface data 1962 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s) 1963 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove 1964 * extra IE(s) 1965 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL 1966 * to remove extra IE(s) 1967 * Returns: 0 on success, -1 on failure 1968 * 1969 * This is an optional function to add WPS IE in the kernel driver for 1970 * Beacon and Probe Response frames. This can be left undefined (set 1971 * to %NULL) if the driver uses the Beacon template from set_ap() 1972 * and does not process Probe Request frames. If the driver takes care 1973 * of (Re)Association frame processing, the assocresp buffer includes 1974 * WPS IE(s) that need to be added to (Re)Association Response frames 1975 * whenever a (Re)Association Request frame indicated use of WPS. 1976 * 1977 * This will also be used to add P2P IE(s) into Beacon/Probe Response 1978 * frames when operating as a GO. The driver is responsible for adding 1979 * timing related attributes (e.g., NoA) in addition to the IEs 1980 * included here by appending them after these buffers. This call is 1981 * also used to provide Probe Response IEs for P2P Listen state 1982 * operations for drivers that generate the Probe Response frames 1983 * internally. 1984 * 1985 * DEPRECATED - use set_ap() instead 1986 */ 1987 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon, 1988 const struct wpabuf *proberesp, 1989 const struct wpabuf *assocresp); 1990 1991 /** 1992 * set_supp_port - Set IEEE 802.1X Supplicant Port status 1993 * @priv: Private driver interface data 1994 * @authorized: Whether the port is authorized 1995 * Returns: 0 on success, -1 on failure 1996 */ 1997 int (*set_supp_port)(void *priv, int authorized); 1998 1999 /** 2000 * set_wds_sta - Bind a station into a 4-address WDS (AP only) 2001 * @priv: Private driver interface data 2002 * @addr: MAC address of the associated station 2003 * @aid: Association ID 2004 * @val: 1 = bind to 4-address WDS; 0 = unbind 2005 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL 2006 * to indicate that bridge is not to be used 2007 * Returns: 0 on success, -1 on failure 2008 */ 2009 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val, 2010 const char *bridge_ifname); 2011 2012 /** 2013 * send_action - Transmit an Action frame 2014 * @priv: Private driver interface data 2015 * @freq: Frequency (in MHz) of the channel 2016 * @wait: Time to wait off-channel for a response (in ms), or zero 2017 * @dst: Destination MAC address (Address 1) 2018 * @src: Source MAC address (Address 2) 2019 * @bssid: BSSID (Address 3) 2020 * @data: Frame body 2021 * @data_len: data length in octets 2022 @ @no_cck: Whether CCK rates must not be used to transmit this frame 2023 * Returns: 0 on success, -1 on failure 2024 * 2025 * This command can be used to request the driver to transmit an action 2026 * frame to the specified destination. 2027 * 2028 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will 2029 * be transmitted on the given channel and the device will wait for a 2030 * response on that channel for the given wait time. 2031 * 2032 * If the flag is not set, the wait time will be ignored. In this case, 2033 * if a remain-on-channel duration is in progress, the frame must be 2034 * transmitted on that channel; alternatively the frame may be sent on 2035 * the current operational channel (if in associated state in station 2036 * mode or while operating as an AP.) 2037 */ 2038 int (*send_action)(void *priv, unsigned int freq, unsigned int wait, 2039 const u8 *dst, const u8 *src, const u8 *bssid, 2040 const u8 *data, size_t data_len, int no_cck); 2041 2042 /** 2043 * send_action_cancel_wait - Cancel action frame TX wait 2044 * @priv: Private driver interface data 2045 * 2046 * This command cancels the wait time associated with sending an action 2047 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is 2048 * set in the driver flags. 2049 */ 2050 void (*send_action_cancel_wait)(void *priv); 2051 2052 /** 2053 * remain_on_channel - Remain awake on a channel 2054 * @priv: Private driver interface data 2055 * @freq: Frequency (in MHz) of the channel 2056 * @duration: Duration in milliseconds 2057 * Returns: 0 on success, -1 on failure 2058 * 2059 * This command is used to request the driver to remain awake on the 2060 * specified channel for the specified duration and report received 2061 * Action frames with EVENT_RX_ACTION events. Optionally, received 2062 * Probe Request frames may also be requested to be reported by calling 2063 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ. 2064 * 2065 * The driver may not be at the requested channel when this function 2066 * returns, i.e., the return code is only indicating whether the 2067 * request was accepted. The caller will need to wait until the 2068 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has 2069 * completed the channel change. This may take some time due to other 2070 * need for the radio and the caller should be prepared to timing out 2071 * its wait since there are no guarantees on when this request can be 2072 * executed. 2073 */ 2074 int (*remain_on_channel)(void *priv, unsigned int freq, 2075 unsigned int duration); 2076 2077 /** 2078 * cancel_remain_on_channel - Cancel remain-on-channel operation 2079 * @priv: Private driver interface data 2080 * 2081 * This command can be used to cancel a remain-on-channel operation 2082 * before its originally requested duration has passed. This could be 2083 * used, e.g., when remain_on_channel() is used to request extra time 2084 * to receive a response to an Action frame and the response is 2085 * received when there is still unneeded time remaining on the 2086 * remain-on-channel operation. 2087 */ 2088 int (*cancel_remain_on_channel)(void *priv); 2089 2090 /** 2091 * probe_req_report - Request Probe Request frames to be indicated 2092 * @priv: Private driver interface data 2093 * @report: Whether to report received Probe Request frames 2094 * Returns: 0 on success, -1 on failure (or if not supported) 2095 * 2096 * This command can be used to request the driver to indicate when 2097 * Probe Request frames are received with EVENT_RX_PROBE_REQ events. 2098 * Since this operation may require extra resources, e.g., due to less 2099 * optimal hardware/firmware RX filtering, many drivers may disable 2100 * Probe Request reporting at least in station mode. This command is 2101 * used to notify the driver when the Probe Request frames need to be 2102 * reported, e.g., during remain-on-channel operations. 2103 */ 2104 int (*probe_req_report)(void *priv, int report); 2105 2106 /** 2107 * deinit_ap - Deinitialize AP mode 2108 * @priv: Private driver interface data 2109 * Returns: 0 on success, -1 on failure (or if not supported) 2110 * 2111 * This optional function can be used to disable AP mode related 2112 * configuration and change the driver mode to station mode to allow 2113 * normal station operations like scanning to be completed. 2114 */ 2115 int (*deinit_ap)(void *priv); 2116 2117 /** 2118 * deinit_p2p_cli - Deinitialize P2P client mode 2119 * @priv: Private driver interface data 2120 * Returns: 0 on success, -1 on failure (or if not supported) 2121 * 2122 * This optional function can be used to disable P2P client mode. It 2123 * can be used to change the interface type back to station mode. 2124 */ 2125 int (*deinit_p2p_cli)(void *priv); 2126 2127 /** 2128 * suspend - Notification on system suspend/hibernate event 2129 * @priv: Private driver interface data 2130 */ 2131 void (*suspend)(void *priv); 2132 2133 /** 2134 * resume - Notification on system resume/thaw event 2135 * @priv: Private driver interface data 2136 */ 2137 void (*resume)(void *priv); 2138 2139 /** 2140 * signal_monitor - Set signal monitoring parameters 2141 * @priv: Private driver interface data 2142 * @threshold: Threshold value for signal change events; 0 = disabled 2143 * @hysteresis: Minimum change in signal strength before indicating a 2144 * new event 2145 * Returns: 0 on success, -1 on failure (or if not supported) 2146 * 2147 * This function can be used to configure monitoring of signal strength 2148 * with the current AP. Whenever signal strength drops below the 2149 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event 2150 * should be generated assuming the signal strength has changed at 2151 * least %hysteresis from the previously indicated signal change event. 2152 */ 2153 int (*signal_monitor)(void *priv, int threshold, int hysteresis); 2154 2155 /** 2156 * send_frame - Send IEEE 802.11 frame (testing use only) 2157 * @priv: Private driver interface data 2158 * @data: IEEE 802.11 frame with IEEE 802.11 header 2159 * @data_len: Size of the frame 2160 * @encrypt: Whether to encrypt the frame (if keys are set) 2161 * Returns: 0 on success, -1 on failure 2162 * 2163 * This function is only used for debugging purposes and is not 2164 * required to be implemented for normal operations. 2165 */ 2166 int (*send_frame)(void *priv, const u8 *data, size_t data_len, 2167 int encrypt); 2168 2169 /** 2170 * shared_freq - Get operating frequency of shared interface(s) 2171 * @priv: Private driver interface data 2172 * Returns: Operating frequency in MHz, 0 if no shared operation in 2173 * use, or -1 on failure 2174 * 2175 * This command can be used to request the current operating frequency 2176 * of any virtual interface that shares the same radio to provide 2177 * information for channel selection for other virtual interfaces. 2178 */ 2179 int (*shared_freq)(void *priv); 2180 2181 /** 2182 * get_noa - Get current Notice of Absence attribute payload 2183 * @priv: Private driver interface data 2184 * @buf: Buffer for returning NoA 2185 * @buf_len: Buffer length in octets 2186 * Returns: Number of octets used in buf, 0 to indicate no NoA is being 2187 * advertized, or -1 on failure 2188 * 2189 * This function is used to fetch the current Notice of Absence 2190 * attribute value from GO. 2191 */ 2192 int (*get_noa)(void *priv, u8 *buf, size_t buf_len); 2193 2194 /** 2195 * set_noa - Set Notice of Absence parameters for GO (testing) 2196 * @priv: Private driver interface data 2197 * @count: Count 2198 * @start: Start time in ms from next TBTT 2199 * @duration: Duration in ms 2200 * Returns: 0 on success or -1 on failure 2201 * 2202 * This function is used to set Notice of Absence parameters for GO. It 2203 * is used only for testing. To disable NoA, all parameters are set to 2204 * 0. 2205 */ 2206 int (*set_noa)(void *priv, u8 count, int start, int duration); 2207 2208 /** 2209 * set_p2p_powersave - Set P2P power save options 2210 * @priv: Private driver interface data 2211 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change 2212 * @opp_ps: 0 = disable, 1 = enable, -1 = no change 2213 * @ctwindow: 0.. = change (msec), -1 = no change 2214 * Returns: 0 on success or -1 on failure 2215 */ 2216 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps, 2217 int ctwindow); 2218 2219 /** 2220 * ampdu - Enable/disable aggregation 2221 * @priv: Private driver interface data 2222 * @ampdu: 1/0 = enable/disable A-MPDU aggregation 2223 * Returns: 0 on success or -1 on failure 2224 */ 2225 int (*ampdu)(void *priv, int ampdu); 2226 2227 /** 2228 * get_radio_name - Get physical radio name for the device 2229 * @priv: Private driver interface data 2230 * Returns: Radio name or %NULL if not known 2231 * 2232 * The returned data must not be modified by the caller. It is assumed 2233 * that any interface that has the same radio name as another is 2234 * sharing the same physical radio. This information can be used to 2235 * share scan results etc. information between the virtual interfaces 2236 * to speed up various operations. 2237 */ 2238 const char * (*get_radio_name)(void *priv); 2239 2240 /** 2241 * p2p_find - Start P2P Device Discovery 2242 * @priv: Private driver interface data 2243 * @timeout: Timeout for find operation in seconds or 0 for no timeout 2244 * @type: Device Discovery type (enum p2p_discovery_type) 2245 * Returns: 0 on success, -1 on failure 2246 * 2247 * This function is only used if the driver implements P2P management, 2248 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2249 * struct wpa_driver_capa. 2250 */ 2251 int (*p2p_find)(void *priv, unsigned int timeout, int type); 2252 2253 /** 2254 * p2p_stop_find - Stop P2P Device Discovery 2255 * @priv: Private driver interface data 2256 * Returns: 0 on success, -1 on failure 2257 * 2258 * This function is only used if the driver implements P2P management, 2259 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2260 * struct wpa_driver_capa. 2261 */ 2262 int (*p2p_stop_find)(void *priv); 2263 2264 /** 2265 * p2p_listen - Start P2P Listen state for specified duration 2266 * @priv: Private driver interface data 2267 * @timeout: Listen state duration in milliseconds 2268 * Returns: 0 on success, -1 on failure 2269 * 2270 * This function can be used to request the P2P module to keep the 2271 * device discoverable on the listen channel for an extended set of 2272 * time. At least in its current form, this is mainly used for testing 2273 * purposes and may not be of much use for normal P2P operations. 2274 * 2275 * This function is only used if the driver implements P2P management, 2276 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2277 * struct wpa_driver_capa. 2278 */ 2279 int (*p2p_listen)(void *priv, unsigned int timeout); 2280 2281 /** 2282 * p2p_connect - Start P2P group formation (GO negotiation) 2283 * @priv: Private driver interface data 2284 * @peer_addr: MAC address of the peer P2P client 2285 * @wps_method: enum p2p_wps_method value indicating config method 2286 * @go_intent: Local GO intent value (1..15) 2287 * @own_interface_addr: Intended interface address to use with the 2288 * group 2289 * @force_freq: The only allowed channel frequency in MHz or 0 2290 * @persistent_group: Whether to create persistent group 2291 * Returns: 0 on success, -1 on failure 2292 * 2293 * This function is only used if the driver implements P2P management, 2294 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2295 * struct wpa_driver_capa. 2296 */ 2297 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method, 2298 int go_intent, const u8 *own_interface_addr, 2299 unsigned int force_freq, int persistent_group); 2300 2301 /** 2302 * wps_success_cb - Report successfully completed WPS provisioning 2303 * @priv: Private driver interface data 2304 * @peer_addr: Peer address 2305 * Returns: 0 on success, -1 on failure 2306 * 2307 * This function is used to report successfully completed WPS 2308 * provisioning during group formation in both GO/Registrar and 2309 * client/Enrollee roles. 2310 * 2311 * This function is only used if the driver implements P2P management, 2312 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2313 * struct wpa_driver_capa. 2314 */ 2315 int (*wps_success_cb)(void *priv, const u8 *peer_addr); 2316 2317 /** 2318 * p2p_group_formation_failed - Report failed WPS provisioning 2319 * @priv: Private driver interface data 2320 * Returns: 0 on success, -1 on failure 2321 * 2322 * This function is used to report failed group formation. This can 2323 * happen either due to failed WPS provisioning or due to 15 second 2324 * timeout during the provisioning phase. 2325 * 2326 * This function is only used if the driver implements P2P management, 2327 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2328 * struct wpa_driver_capa. 2329 */ 2330 int (*p2p_group_formation_failed)(void *priv); 2331 2332 /** 2333 * p2p_set_params - Set P2P parameters 2334 * @priv: Private driver interface data 2335 * @params: P2P parameters 2336 * Returns: 0 on success, -1 on failure 2337 * 2338 * This function is only used if the driver implements P2P management, 2339 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2340 * struct wpa_driver_capa. 2341 */ 2342 int (*p2p_set_params)(void *priv, const struct p2p_params *params); 2343 2344 /** 2345 * p2p_prov_disc_req - Send Provision Discovery Request 2346 * @priv: Private driver interface data 2347 * @peer_addr: MAC address of the peer P2P client 2348 * @config_methods: WPS Config Methods value (only one bit set) 2349 * Returns: 0 on success, -1 on failure 2350 * 2351 * This function can be used to request a discovered P2P peer to 2352 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared 2353 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The 2354 * Provision Discovery Request frame is transmitted once immediately 2355 * and if no response is received, the frame will be sent again 2356 * whenever the target device is discovered during device dsicovery 2357 * (start with a p2p_find() call). Response from the peer is indicated 2358 * with the EVENT_P2P_PROV_DISC_RESPONSE event. 2359 * 2360 * This function is only used if the driver implements P2P management, 2361 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2362 * struct wpa_driver_capa. 2363 */ 2364 int (*p2p_prov_disc_req)(void *priv, const u8 *peer_addr, 2365 u16 config_methods, int join); 2366 2367 /** 2368 * p2p_sd_request - Schedule a service discovery query 2369 * @priv: Private driver interface data 2370 * @dst: Destination peer or %NULL to apply for all peers 2371 * @tlvs: P2P Service Query TLV(s) 2372 * Returns: Reference to the query or 0 on failure 2373 * 2374 * Response to the query is indicated with the 2375 * EVENT_P2P_SD_RESPONSE driver event. 2376 * 2377 * This function is only used if the driver implements P2P management, 2378 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2379 * struct wpa_driver_capa. 2380 */ 2381 u64 (*p2p_sd_request)(void *priv, const u8 *dst, 2382 const struct wpabuf *tlvs); 2383 2384 /** 2385 * p2p_sd_cancel_request - Cancel a pending service discovery query 2386 * @priv: Private driver interface data 2387 * @req: Query reference from p2p_sd_request() 2388 * Returns: 0 on success, -1 on failure 2389 * 2390 * This function is only used if the driver implements P2P management, 2391 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2392 * struct wpa_driver_capa. 2393 */ 2394 int (*p2p_sd_cancel_request)(void *priv, u64 req); 2395 2396 /** 2397 * p2p_sd_response - Send response to a service discovery query 2398 * @priv: Private driver interface data 2399 * @freq: Frequency from EVENT_P2P_SD_REQUEST event 2400 * @dst: Destination address from EVENT_P2P_SD_REQUEST event 2401 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event 2402 * @resp_tlvs: P2P Service Response TLV(s) 2403 * Returns: 0 on success, -1 on failure 2404 * 2405 * This function is called as a response to the request indicated with 2406 * the EVENT_P2P_SD_REQUEST driver event. 2407 * 2408 * This function is only used if the driver implements P2P management, 2409 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2410 * struct wpa_driver_capa. 2411 */ 2412 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst, 2413 u8 dialog_token, 2414 const struct wpabuf *resp_tlvs); 2415 2416 /** 2417 * p2p_service_update - Indicate a change in local services 2418 * @priv: Private driver interface data 2419 * Returns: 0 on success, -1 on failure 2420 * 2421 * This function needs to be called whenever there is a change in 2422 * availability of the local services. This will increment the 2423 * Service Update Indicator value which will be used in SD Request and 2424 * Response frames. 2425 * 2426 * This function is only used if the driver implements P2P management, 2427 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2428 * struct wpa_driver_capa. 2429 */ 2430 int (*p2p_service_update)(void *priv); 2431 2432 /** 2433 * p2p_reject - Reject peer device (explicitly block connections) 2434 * @priv: Private driver interface data 2435 * @addr: MAC address of the peer 2436 * Returns: 0 on success, -1 on failure 2437 */ 2438 int (*p2p_reject)(void *priv, const u8 *addr); 2439 2440 /** 2441 * p2p_invite - Invite a P2P Device into a group 2442 * @priv: Private driver interface data 2443 * @peer: Device Address of the peer P2P Device 2444 * @role: Local role in the group 2445 * @bssid: Group BSSID or %NULL if not known 2446 * @ssid: Group SSID 2447 * @ssid_len: Length of ssid in octets 2448 * @go_dev_addr: Forced GO Device Address or %NULL if none 2449 * @persistent_group: Whether this is to reinvoke a persistent group 2450 * Returns: 0 on success, -1 on failure 2451 */ 2452 int (*p2p_invite)(void *priv, const u8 *peer, int role, 2453 const u8 *bssid, const u8 *ssid, size_t ssid_len, 2454 const u8 *go_dev_addr, int persistent_group); 2455 2456 /** 2457 * send_tdls_mgmt - for sending TDLS management packets 2458 * @priv: private driver interface data 2459 * @dst: Destination (peer) MAC address 2460 * @action_code: TDLS action code for the mssage 2461 * @dialog_token: Dialog Token to use in the message (if needed) 2462 * @status_code: Status Code or Reason Code to use (if needed) 2463 * @buf: TDLS IEs to add to the message 2464 * @len: Length of buf in octets 2465 * Returns: 0 on success, negative (<0) on failure 2466 * 2467 * This optional function can be used to send packet to driver which is 2468 * responsible for receiving and sending all TDLS packets. 2469 */ 2470 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code, 2471 u8 dialog_token, u16 status_code, 2472 const u8 *buf, size_t len); 2473 2474 /** 2475 * tdls_oper - Ask the driver to perform high-level TDLS operations 2476 * @priv: Private driver interface data 2477 * @oper: TDLS high-level operation. See %enum tdls_oper 2478 * @peer: Destination (peer) MAC address 2479 * Returns: 0 on success, negative (<0) on failure 2480 * 2481 * This optional function can be used to send high-level TDLS commands 2482 * to the driver. 2483 */ 2484 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer); 2485 2486 /** 2487 * wnm_oper - Notify driver of the WNM frame reception 2488 * @priv: Private driver interface data 2489 * @oper: WNM operation. See %enum wnm_oper 2490 * @peer: Destination (peer) MAC address 2491 * @buf: Buffer for the driver to fill in (for getting IE) 2492 * @buf_len: Return the len of buf 2493 * Returns: 0 on success, negative (<0) on failure 2494 */ 2495 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer, 2496 u8 *buf, u16 *buf_len); 2497 2498 /** 2499 * signal_poll - Get current connection information 2500 * @priv: Private driver interface data 2501 * @signal_info: Connection info structure 2502 */ 2503 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info); 2504 2505 /** 2506 * set_authmode - Set authentication algorithm(s) for static WEP 2507 * @priv: Private driver interface data 2508 * @authmode: 1=Open System, 2=Shared Key, 3=both 2509 * Returns: 0 on success, -1 on failure 2510 * 2511 * This function can be used to set authentication algorithms for AP 2512 * mode when static WEP is used. If the driver uses user space MLME/SME 2513 * implementation, there is no need to implement this function. 2514 * 2515 * DEPRECATED - use set_ap() instead 2516 */ 2517 int (*set_authmode)(void *priv, int authmode); 2518#ifdef ANDROID 2519 /** 2520 * driver_cmd - execute driver-specific command 2521 * @priv: private driver interface data 2522 * @cmd: command to execute 2523 * @buf: return buffer 2524 * @buf_len: buffer length 2525 * 2526 * Returns: 0 on success, -1 on failure 2527 */ 2528 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len); 2529#endif 2530 /** 2531 * set_rekey_info - Set rekey information 2532 * @priv: Private driver interface data 2533 * @kek: Current KEK 2534 * @kck: Current KCK 2535 * @replay_ctr: Current EAPOL-Key Replay Counter 2536 * 2537 * This optional function can be used to provide information for the 2538 * driver/firmware to process EAPOL-Key frames in Group Key Handshake 2539 * while the host (including wpa_supplicant) is sleeping. 2540 */ 2541 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck, 2542 const u8 *replay_ctr); 2543 2544 /** 2545 * sta_assoc - Station association indication 2546 * @priv: Private driver interface data 2547 * @own_addr: Source address and BSSID for association frame 2548 * @addr: MAC address of the station to associate 2549 * @reassoc: flag to indicate re-association 2550 * @status: association response status code 2551 * @ie: assoc response ie buffer 2552 * @len: ie buffer length 2553 * Returns: 0 on success, -1 on failure 2554 * 2555 * This function indicates the driver to send (Re)Association 2556 * Response frame to the station. 2557 */ 2558 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr, 2559 int reassoc, u16 status, const u8 *ie, size_t len); 2560 2561 /** 2562 * sta_auth - Station authentication indication 2563 * @priv: Private driver interface data 2564 * @own_addr: Source address and BSSID for authentication frame 2565 * @addr: MAC address of the station to associate 2566 * @seq: authentication sequence number 2567 * @status: authentication response status code 2568 * @ie: authentication frame ie buffer 2569 * @len: ie buffer length 2570 * 2571 * This function indicates the driver to send Authentication frame 2572 * to the station. 2573 */ 2574 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr, 2575 u16 seq, u16 status, const u8 *ie, size_t len); 2576 2577 /** 2578 * add_tspec - Add traffic stream 2579 * @priv: Private driver interface data 2580 * @addr: MAC address of the station to associate 2581 * @tspec_ie: tspec ie buffer 2582 * @tspec_ielen: tspec ie length 2583 * Returns: 0 on success, -1 on failure 2584 * 2585 * This function adds the traffic steam for the station 2586 * and fills the medium_time in tspec_ie. 2587 */ 2588 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie, 2589 size_t tspec_ielen); 2590 2591 /** 2592 * add_sta_node - Add a station node in the driver 2593 * @priv: Private driver interface data 2594 * @addr: MAC address of the station to add 2595 * @auth_alg: authentication algorithm used by the station 2596 * Returns: 0 on success, -1 on failure 2597 * 2598 * This function adds the station node in the driver, when 2599 * the station gets added by FT-over-DS. 2600 */ 2601 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg); 2602 2603 /** 2604 * sched_scan - Request the driver to initiate scheduled scan 2605 * @priv: Private driver interface data 2606 * @params: Scan parameters 2607 * @interval: Interval between scan cycles in milliseconds 2608 * Returns: 0 on success, -1 on failure 2609 * 2610 * This operation should be used for scheduled scan offload to 2611 * the hardware. Every time scan results are available, the 2612 * driver should report scan results event for wpa_supplicant 2613 * which will eventually request the results with 2614 * wpa_driver_get_scan_results2(). This operation is optional 2615 * and if not provided or if it returns -1, we fall back to 2616 * normal host-scheduled scans. 2617 */ 2618 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params, 2619 u32 interval); 2620 2621 /** 2622 * stop_sched_scan - Request the driver to stop a scheduled scan 2623 * @priv: Private driver interface data 2624 * Returns: 0 on success, -1 on failure 2625 * 2626 * This should cause the scheduled scan to be stopped and 2627 * results should stop being sent. Must be supported if 2628 * sched_scan is supported. 2629 */ 2630 int (*stop_sched_scan)(void *priv); 2631 2632 /** 2633 * poll_client - Probe (null data or such) the given station 2634 * @priv: Private driver interface data 2635 * @own_addr: MAC address of sending interface 2636 * @addr: MAC address of the station to probe 2637 * @qos: Indicates whether station is QoS station 2638 * 2639 * This function is used to verify whether an associated station is 2640 * still present. This function does not need to be implemented if the 2641 * driver provides such inactivity polling mechanism. 2642 */ 2643 void (*poll_client)(void *priv, const u8 *own_addr, 2644 const u8 *addr, int qos); 2645 2646 /** 2647 * radio_disable - Disable/enable radio 2648 * @priv: Private driver interface data 2649 * @disabled: 1=disable 0=enable radio 2650 * Returns: 0 on success, -1 on failure 2651 * 2652 * This optional command is for testing purposes. It can be used to 2653 * disable the radio on a testbed device to simulate out-of-radio-range 2654 * conditions. 2655 */ 2656 int (*radio_disable)(void *priv, int disabled); 2657 2658 /** 2659 * switch_channel - Announce channel switch and migrate the GO to the 2660 * given frequency 2661 * @priv: Private driver interface data 2662 * @freq: Frequency in MHz 2663 * Returns: 0 on success, -1 on failure 2664 * 2665 * This function is used to move the GO to the legacy STA channel to 2666 * avoid frequency conflict in single channel concurrency. 2667 */ 2668 int (*switch_channel)(void *priv, unsigned int freq); 2669 2670 /** 2671 * start_dfs_cac - Listen for radar interference on the channel 2672 * @priv: Private driver interface data 2673 * @freq: Frequency (in MHz) of the channel 2674 * Returns: 0 on success, -1 on failure 2675 */ 2676 int (*start_dfs_cac)(void *priv, int freq); 2677 2678 /** 2679 * stop_ap - Removes beacon from AP 2680 * @priv: Private driver interface data 2681 * Returns: 0 on success, -1 on failure (or if not supported) 2682 * 2683 * This optional function can be used to disable AP mode related 2684 * configuration. Unlike deinit_ap, it does not change to station 2685 * mode. 2686 */ 2687 int (*stop_ap)(void *priv); 2688}; 2689 2690 2691/** 2692 * enum wpa_event_type - Event type for wpa_supplicant_event() calls 2693 */ 2694enum wpa_event_type { 2695 /** 2696 * EVENT_ASSOC - Association completed 2697 * 2698 * This event needs to be delivered when the driver completes IEEE 2699 * 802.11 association or reassociation successfully. 2700 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID 2701 * after this event has been generated. In addition, optional 2702 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide 2703 * more information about the association. If the driver interface gets 2704 * both of these events at the same time, it can also include the 2705 * assoc_info data in EVENT_ASSOC call. 2706 */ 2707 EVENT_ASSOC, 2708 2709 /** 2710 * EVENT_DISASSOC - Association lost 2711 * 2712 * This event should be called when association is lost either due to 2713 * receiving deauthenticate or disassociate frame from the AP or when 2714 * sending either of these frames to the current AP. If the driver 2715 * supports separate deauthentication event, EVENT_DISASSOC should only 2716 * be used for disassociation and EVENT_DEAUTH for deauthentication. 2717 * In AP mode, union wpa_event_data::disassoc_info is required. 2718 */ 2719 EVENT_DISASSOC, 2720 2721 /** 2722 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected 2723 * 2724 * This event must be delivered when a Michael MIC error is detected by 2725 * the local driver. Additional data for event processing is 2726 * provided with union wpa_event_data::michael_mic_failure. This 2727 * information is used to request new encyption key and to initiate 2728 * TKIP countermeasures if needed. 2729 */ 2730 EVENT_MICHAEL_MIC_FAILURE, 2731 2732 /** 2733 * EVENT_SCAN_RESULTS - Scan results available 2734 * 2735 * This event must be called whenever scan results are available to be 2736 * fetched with struct wpa_driver_ops::get_scan_results(). This event 2737 * is expected to be used some time after struct wpa_driver_ops::scan() 2738 * is called. If the driver provides an unsolicited event when the scan 2739 * has been completed, this event can be used to trigger 2740 * EVENT_SCAN_RESULTS call. If such event is not available from the 2741 * driver, the driver wrapper code is expected to use a registered 2742 * timeout to generate EVENT_SCAN_RESULTS call after the time that the 2743 * scan is expected to be completed. Optional information about 2744 * completed scan can be provided with union wpa_event_data::scan_info. 2745 */ 2746 EVENT_SCAN_RESULTS, 2747 2748 /** 2749 * EVENT_ASSOCINFO - Report optional extra information for association 2750 * 2751 * This event can be used to report extra association information for 2752 * EVENT_ASSOC processing. This extra information includes IEs from 2753 * association frames and Beacon/Probe Response frames in union 2754 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before 2755 * EVENT_ASSOC. Alternatively, the driver interface can include 2756 * assoc_info data in the EVENT_ASSOC call if it has all the 2757 * information available at the same point. 2758 */ 2759 EVENT_ASSOCINFO, 2760 2761 /** 2762 * EVENT_INTERFACE_STATUS - Report interface status changes 2763 * 2764 * This optional event can be used to report changes in interface 2765 * status (interface added/removed) using union 2766 * wpa_event_data::interface_status. This can be used to trigger 2767 * wpa_supplicant to stop and re-start processing for the interface, 2768 * e.g., when a cardbus card is ejected/inserted. 2769 */ 2770 EVENT_INTERFACE_STATUS, 2771 2772 /** 2773 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication 2774 * 2775 * This event can be used to inform wpa_supplicant about candidates for 2776 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible 2777 * for scan request (ap_scan=2 mode), this event is required for 2778 * pre-authentication. If wpa_supplicant is performing scan request 2779 * (ap_scan=1), this event is optional since scan results can be used 2780 * to add pre-authentication candidates. union 2781 * wpa_event_data::pmkid_candidate is used to report the BSSID of the 2782 * candidate and priority of the candidate, e.g., based on the signal 2783 * strength, in order to try to pre-authenticate first with candidates 2784 * that are most likely targets for re-association. 2785 * 2786 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates 2787 * on the candidate list. In addition, it can be called for the current 2788 * AP and APs that have existing PMKSA cache entries. wpa_supplicant 2789 * will automatically skip pre-authentication in cases where a valid 2790 * PMKSA exists. When more than one candidate exists, this event should 2791 * be generated once for each candidate. 2792 * 2793 * Driver will be notified about successful pre-authentication with 2794 * struct wpa_driver_ops::add_pmkid() calls. 2795 */ 2796 EVENT_PMKID_CANDIDATE, 2797 2798 /** 2799 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request) 2800 * 2801 * This event can be used to inform wpa_supplicant about desire to set 2802 * up secure direct link connection between two stations as defined in 2803 * IEEE 802.11e with a new PeerKey mechanism that replaced the original 2804 * STAKey negotiation. The caller will need to set peer address for the 2805 * event. 2806 */ 2807 EVENT_STKSTART, 2808 2809 /** 2810 * EVENT_TDLS - Request TDLS operation 2811 * 2812 * This event can be used to request a TDLS operation to be performed. 2813 */ 2814 EVENT_TDLS, 2815 2816 /** 2817 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs 2818 * 2819 * The driver is expected to report the received FT IEs from 2820 * FT authentication sequence from the AP. The FT IEs are included in 2821 * the extra information in union wpa_event_data::ft_ies. 2822 */ 2823 EVENT_FT_RESPONSE, 2824 2825 /** 2826 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS 2827 * 2828 * The driver can use this event to inform wpa_supplicant about a STA 2829 * in an IBSS with which protected frames could be exchanged. This 2830 * event starts RSN authentication with the other STA to authenticate 2831 * the STA and set up encryption keys with it. 2832 */ 2833 EVENT_IBSS_RSN_START, 2834 2835 /** 2836 * EVENT_AUTH - Authentication result 2837 * 2838 * This event should be called when authentication attempt has been 2839 * completed. This is only used if the driver supports separate 2840 * authentication step (struct wpa_driver_ops::authenticate). 2841 * Information about authentication result is included in 2842 * union wpa_event_data::auth. 2843 */ 2844 EVENT_AUTH, 2845 2846 /** 2847 * EVENT_DEAUTH - Authentication lost 2848 * 2849 * This event should be called when authentication is lost either due 2850 * to receiving deauthenticate frame from the AP or when sending that 2851 * frame to the current AP. 2852 * In AP mode, union wpa_event_data::deauth_info is required. 2853 */ 2854 EVENT_DEAUTH, 2855 2856 /** 2857 * EVENT_ASSOC_REJECT - Association rejected 2858 * 2859 * This event should be called when (re)association attempt has been 2860 * rejected by the AP. Information about the association response is 2861 * included in union wpa_event_data::assoc_reject. 2862 */ 2863 EVENT_ASSOC_REJECT, 2864 2865 /** 2866 * EVENT_AUTH_TIMED_OUT - Authentication timed out 2867 */ 2868 EVENT_AUTH_TIMED_OUT, 2869 2870 /** 2871 * EVENT_ASSOC_TIMED_OUT - Association timed out 2872 */ 2873 EVENT_ASSOC_TIMED_OUT, 2874 2875 /** 2876 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received 2877 */ 2878 EVENT_FT_RRB_RX, 2879 2880 /** 2881 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS 2882 */ 2883 EVENT_WPS_BUTTON_PUSHED, 2884 2885 /** 2886 * EVENT_TX_STATUS - Report TX status 2887 */ 2888 EVENT_TX_STATUS, 2889 2890 /** 2891 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA 2892 */ 2893 EVENT_RX_FROM_UNKNOWN, 2894 2895 /** 2896 * EVENT_RX_MGMT - Report RX of a management frame 2897 */ 2898 EVENT_RX_MGMT, 2899 2900 /** 2901 * EVENT_RX_ACTION - Action frame received 2902 * 2903 * This event is used to indicate when an Action frame has been 2904 * received. Information about the received frame is included in 2905 * union wpa_event_data::rx_action. 2906 */ 2907 EVENT_RX_ACTION, 2908 2909 /** 2910 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started 2911 * 2912 * This event is used to indicate when the driver has started the 2913 * requested remain-on-channel duration. Information about the 2914 * operation is included in union wpa_event_data::remain_on_channel. 2915 */ 2916 EVENT_REMAIN_ON_CHANNEL, 2917 2918 /** 2919 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out 2920 * 2921 * This event is used to indicate when the driver has completed 2922 * remain-on-channel duration, i.e., may noot be available on the 2923 * requested channel anymore. Information about the 2924 * operation is included in union wpa_event_data::remain_on_channel. 2925 */ 2926 EVENT_CANCEL_REMAIN_ON_CHANNEL, 2927 2928 /** 2929 * EVENT_MLME_RX - Report reception of frame for MLME (test use only) 2930 * 2931 * This event is used only by driver_test.c and userspace MLME. 2932 */ 2933 EVENT_MLME_RX, 2934 2935 /** 2936 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame 2937 * 2938 * This event is used to indicate when a Probe Request frame has been 2939 * received. Information about the received frame is included in 2940 * union wpa_event_data::rx_probe_req. The driver is required to report 2941 * these events only after successfully completed probe_req_report() 2942 * commands to request the events (i.e., report parameter is non-zero) 2943 * in station mode. In AP mode, Probe Request frames should always be 2944 * reported. 2945 */ 2946 EVENT_RX_PROBE_REQ, 2947 2948 /** 2949 * EVENT_NEW_STA - New wired device noticed 2950 * 2951 * This event is used to indicate that a new device has been detected 2952 * in a network that does not use association-like functionality (i.e., 2953 * mainly wired Ethernet). This can be used to start EAPOL 2954 * authenticator when receiving a frame from a device. The address of 2955 * the device is included in union wpa_event_data::new_sta. 2956 */ 2957 EVENT_NEW_STA, 2958 2959 /** 2960 * EVENT_EAPOL_RX - Report received EAPOL frame 2961 * 2962 * When in AP mode with hostapd, this event is required to be used to 2963 * deliver the receive EAPOL frames from the driver. With 2964 * %wpa_supplicant, this event is used only if the send_eapol() handler 2965 * is used to override the use of l2_packet for EAPOL frame TX. 2966 */ 2967 EVENT_EAPOL_RX, 2968 2969 /** 2970 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength 2971 * 2972 * This event is used to indicate changes in the signal strength 2973 * observed in frames received from the current AP if signal strength 2974 * monitoring has been enabled with signal_monitor(). 2975 */ 2976 EVENT_SIGNAL_CHANGE, 2977 2978 /** 2979 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled 2980 * 2981 * This event is used to indicate that the interface was enabled after 2982 * having been previously disabled, e.g., due to rfkill. 2983 */ 2984 EVENT_INTERFACE_ENABLED, 2985 2986 /** 2987 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled 2988 * 2989 * This event is used to indicate that the interface was disabled, 2990 * e.g., due to rfkill. 2991 */ 2992 EVENT_INTERFACE_DISABLED, 2993 2994 /** 2995 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed 2996 * 2997 * This event is used to indicate that the channel list has changed, 2998 * e.g., because of a regulatory domain change triggered by scan 2999 * results including an AP advertising a country code. 3000 */ 3001 EVENT_CHANNEL_LIST_CHANGED, 3002 3003 /** 3004 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable 3005 * 3006 * This event is used to indicate that the driver cannot maintain this 3007 * interface in its operation mode anymore. The most likely use for 3008 * this is to indicate that AP mode operation is not available due to 3009 * operating channel would need to be changed to a DFS channel when 3010 * the driver does not support radar detection and another virtual 3011 * interfaces caused the operating channel to change. Other similar 3012 * resource conflicts could also trigger this for station mode 3013 * interfaces. 3014 */ 3015 EVENT_INTERFACE_UNAVAILABLE, 3016 3017 /** 3018 * EVENT_BEST_CHANNEL 3019 * 3020 * Driver generates this event whenever it detects a better channel 3021 * (e.g., based on RSSI or channel use). This information can be used 3022 * to improve channel selection for a new AP/P2P group. 3023 */ 3024 EVENT_BEST_CHANNEL, 3025 3026 /** 3027 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received 3028 * 3029 * This event should be called when a Deauthentication frame is dropped 3030 * due to it not being protected (MFP/IEEE 802.11w). 3031 * union wpa_event_data::unprot_deauth is required to provide more 3032 * details of the frame. 3033 */ 3034 EVENT_UNPROT_DEAUTH, 3035 3036 /** 3037 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received 3038 * 3039 * This event should be called when a Disassociation frame is dropped 3040 * due to it not being protected (MFP/IEEE 802.11w). 3041 * union wpa_event_data::unprot_disassoc is required to provide more 3042 * details of the frame. 3043 */ 3044 EVENT_UNPROT_DISASSOC, 3045 3046 /** 3047 * EVENT_STATION_LOW_ACK 3048 * 3049 * Driver generates this event whenever it detected that a particular 3050 * station was lost. Detection can be through massive transmission 3051 * failures for example. 3052 */ 3053 EVENT_STATION_LOW_ACK, 3054 3055 /** 3056 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device 3057 * 3058 * This event is used only if the driver implements P2P management 3059 * internally. Event data is stored in 3060 * union wpa_event_data::p2p_dev_found. 3061 */ 3062 EVENT_P2P_DEV_FOUND, 3063 3064 /** 3065 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request 3066 * 3067 * This event is used only if the driver implements P2P management 3068 * internally. Event data is stored in 3069 * union wpa_event_data::p2p_go_neg_req_rx. 3070 */ 3071 EVENT_P2P_GO_NEG_REQ_RX, 3072 3073 /** 3074 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation 3075 * 3076 * This event is used only if the driver implements P2P management 3077 * internally. Event data is stored in 3078 * union wpa_event_data::p2p_go_neg_completed. 3079 */ 3080 EVENT_P2P_GO_NEG_COMPLETED, 3081 3082 EVENT_P2P_PROV_DISC_REQUEST, 3083 EVENT_P2P_PROV_DISC_RESPONSE, 3084 EVENT_P2P_SD_REQUEST, 3085 EVENT_P2P_SD_RESPONSE, 3086 3087 /** 3088 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore 3089 */ 3090 EVENT_IBSS_PEER_LOST, 3091 3092 /** 3093 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey 3094 * 3095 * This event carries the new replay counter to notify wpa_supplicant 3096 * of the current EAPOL-Key Replay Counter in case the driver/firmware 3097 * completed Group Key Handshake while the host (including 3098 * wpa_supplicant was sleeping). 3099 */ 3100 EVENT_DRIVER_GTK_REKEY, 3101 3102 /** 3103 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped 3104 */ 3105 EVENT_SCHED_SCAN_STOPPED, 3106 3107 /** 3108 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll 3109 * 3110 * This event indicates that the station responded to the poll 3111 * initiated with @poll_client. 3112 */ 3113 EVENT_DRIVER_CLIENT_POLL_OK, 3114 3115 /** 3116 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status 3117 */ 3118 EVENT_EAPOL_TX_STATUS, 3119 3120 /** 3121 * EVENT_CH_SWITCH - AP or GO decided to switch channels 3122 * 3123 * Described in wpa_event_data.ch_switch 3124 * */ 3125 EVENT_CH_SWITCH, 3126 3127 /** 3128 * EVENT_WNM - Request WNM operation 3129 * 3130 * This event can be used to request a WNM operation to be performed. 3131 */ 3132 EVENT_WNM, 3133 3134 /** 3135 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode 3136 * 3137 * This event indicates that the driver reported a connection failure 3138 * with the specified client (for example, max client reached, etc.) in 3139 * AP mode. 3140 */ 3141 EVENT_CONNECT_FAILED_REASON, 3142 3143 /** 3144 * EVENT_RADAR_DETECTED - Notify of radar detection 3145 * 3146 * A radar has been detected on the supplied frequency, hostapd should 3147 * react accordingly (e.g., change channel). 3148 */ 3149 EVENT_DFS_RADAR_DETECTED, 3150 3151 /** 3152 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed 3153 * 3154 * After a successful CAC, the channel can be marked clear and used. 3155 */ 3156 EVENT_DFS_CAC_FINISHED, 3157 3158 /** 3159 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted 3160 * 3161 * The CAC was not successful, and the channel remains in the previous 3162 * state. This may happen due to a radar beeing detected or other 3163 * external influences. 3164 */ 3165 EVENT_DFS_CAC_ABORTED, 3166 3167 /** 3168 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over 3169 * 3170 * The channel which was previously unavailable is now available again. 3171 */ 3172 EVENT_DFS_NOP_FINISHED 3173}; 3174 3175 3176/** 3177 * union wpa_event_data - Additional data for wpa_supplicant_event() calls 3178 */ 3179union wpa_event_data { 3180 /** 3181 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events 3182 * 3183 * This structure is optional for EVENT_ASSOC calls and required for 3184 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the 3185 * driver interface does not need to generate separate EVENT_ASSOCINFO 3186 * calls. 3187 */ 3188 struct assoc_info { 3189 /** 3190 * reassoc - Flag to indicate association or reassociation 3191 */ 3192 int reassoc; 3193 3194 /** 3195 * req_ies - (Re)Association Request IEs 3196 * 3197 * If the driver generates WPA/RSN IE, this event data must be 3198 * returned for WPA handshake to have needed information. If 3199 * wpa_supplicant-generated WPA/RSN IE is used, this 3200 * information event is optional. 3201 * 3202 * This should start with the first IE (fixed fields before IEs 3203 * are not included). 3204 */ 3205 const u8 *req_ies; 3206 3207 /** 3208 * req_ies_len - Length of req_ies in bytes 3209 */ 3210 size_t req_ies_len; 3211 3212 /** 3213 * resp_ies - (Re)Association Response IEs 3214 * 3215 * Optional association data from the driver. This data is not 3216 * required WPA, but may be useful for some protocols and as 3217 * such, should be reported if this is available to the driver 3218 * interface. 3219 * 3220 * This should start with the first IE (fixed fields before IEs 3221 * are not included). 3222 */ 3223 const u8 *resp_ies; 3224 3225 /** 3226 * resp_ies_len - Length of resp_ies in bytes 3227 */ 3228 size_t resp_ies_len; 3229 3230 /** 3231 * beacon_ies - Beacon or Probe Response IEs 3232 * 3233 * Optional Beacon/ProbeResp data: IEs included in Beacon or 3234 * Probe Response frames from the current AP (i.e., the one 3235 * that the client just associated with). This information is 3236 * used to update WPA/RSN IE for the AP. If this field is not 3237 * set, the results from previous scan will be used. If no 3238 * data for the new AP is found, scan results will be requested 3239 * again (without scan request). At this point, the driver is 3240 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is 3241 * used). 3242 * 3243 * This should start with the first IE (fixed fields before IEs 3244 * are not included). 3245 */ 3246 const u8 *beacon_ies; 3247 3248 /** 3249 * beacon_ies_len - Length of beacon_ies */ 3250 size_t beacon_ies_len; 3251 3252 /** 3253 * freq - Frequency of the operational channel in MHz 3254 */ 3255 unsigned int freq; 3256 3257 /** 3258 * addr - Station address (for AP mode) 3259 */ 3260 const u8 *addr; 3261 } assoc_info; 3262 3263 /** 3264 * struct disassoc_info - Data for EVENT_DISASSOC events 3265 */ 3266 struct disassoc_info { 3267 /** 3268 * addr - Station address (for AP mode) 3269 */ 3270 const u8 *addr; 3271 3272 /** 3273 * reason_code - Reason Code (host byte order) used in 3274 * Deauthentication frame 3275 */ 3276 u16 reason_code; 3277 3278 /** 3279 * ie - Optional IE(s) in Disassociation frame 3280 */ 3281 const u8 *ie; 3282 3283 /** 3284 * ie_len - Length of ie buffer in octets 3285 */ 3286 size_t ie_len; 3287 3288 /** 3289 * locally_generated - Whether the frame was locally generated 3290 */ 3291 int locally_generated; 3292 } disassoc_info; 3293 3294 /** 3295 * struct deauth_info - Data for EVENT_DEAUTH events 3296 */ 3297 struct deauth_info { 3298 /** 3299 * addr - Station address (for AP mode) 3300 */ 3301 const u8 *addr; 3302 3303 /** 3304 * reason_code - Reason Code (host byte order) used in 3305 * Deauthentication frame 3306 */ 3307 u16 reason_code; 3308 3309 /** 3310 * ie - Optional IE(s) in Deauthentication frame 3311 */ 3312 const u8 *ie; 3313 3314 /** 3315 * ie_len - Length of ie buffer in octets 3316 */ 3317 size_t ie_len; 3318 3319 /** 3320 * locally_generated - Whether the frame was locally generated 3321 */ 3322 int locally_generated; 3323 } deauth_info; 3324 3325 /** 3326 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE 3327 */ 3328 struct michael_mic_failure { 3329 int unicast; 3330 const u8 *src; 3331 } michael_mic_failure; 3332 3333 /** 3334 * struct interface_status - Data for EVENT_INTERFACE_STATUS 3335 */ 3336 struct interface_status { 3337 char ifname[100]; 3338 enum { 3339 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED 3340 } ievent; 3341 } interface_status; 3342 3343 /** 3344 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE 3345 */ 3346 struct pmkid_candidate { 3347 /** BSSID of the PMKID candidate */ 3348 u8 bssid[ETH_ALEN]; 3349 /** Smaller the index, higher the priority */ 3350 int index; 3351 /** Whether RSN IE includes pre-authenticate flag */ 3352 int preauth; 3353 } pmkid_candidate; 3354 3355 /** 3356 * struct stkstart - Data for EVENT_STKSTART 3357 */ 3358 struct stkstart { 3359 u8 peer[ETH_ALEN]; 3360 } stkstart; 3361 3362 /** 3363 * struct tdls - Data for EVENT_TDLS 3364 */ 3365 struct tdls { 3366 u8 peer[ETH_ALEN]; 3367 enum { 3368 TDLS_REQUEST_SETUP, 3369 TDLS_REQUEST_TEARDOWN 3370 } oper; 3371 u16 reason_code; /* for teardown */ 3372 } tdls; 3373 3374 /** 3375 * struct wnm - Data for EVENT_WNM 3376 */ 3377 struct wnm { 3378 u8 addr[ETH_ALEN]; 3379 enum { 3380 WNM_OPER_SLEEP, 3381 } oper; 3382 enum { 3383 WNM_SLEEP_ENTER, 3384 WNM_SLEEP_EXIT 3385 } sleep_action; 3386 int sleep_intval; 3387 u16 reason_code; 3388 u8 *buf; 3389 u16 buf_len; 3390 } wnm; 3391 3392 /** 3393 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE) 3394 * 3395 * During FT (IEEE 802.11r) authentication sequence, the driver is 3396 * expected to use this event to report received FT IEs (MDIE, FTIE, 3397 * RSN IE, TIE, possible resource request) to the supplicant. The FT 3398 * IEs for the next message will be delivered through the 3399 * struct wpa_driver_ops::update_ft_ies() callback. 3400 */ 3401 struct ft_ies { 3402 const u8 *ies; 3403 size_t ies_len; 3404 int ft_action; 3405 u8 target_ap[ETH_ALEN]; 3406 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */ 3407 const u8 *ric_ies; 3408 /** Length of ric_ies buffer in octets */ 3409 size_t ric_ies_len; 3410 } ft_ies; 3411 3412 /** 3413 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START 3414 */ 3415 struct ibss_rsn_start { 3416 u8 peer[ETH_ALEN]; 3417 } ibss_rsn_start; 3418 3419 /** 3420 * struct auth_info - Data for EVENT_AUTH events 3421 */ 3422 struct auth_info { 3423 u8 peer[ETH_ALEN]; 3424 u8 bssid[ETH_ALEN]; 3425 u16 auth_type; 3426 u16 auth_transaction; 3427 u16 status_code; 3428 const u8 *ies; 3429 size_t ies_len; 3430 } auth; 3431 3432 /** 3433 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events 3434 */ 3435 struct assoc_reject { 3436 /** 3437 * bssid - BSSID of the AP that rejected association 3438 */ 3439 const u8 *bssid; 3440 3441 /** 3442 * resp_ies - (Re)Association Response IEs 3443 * 3444 * Optional association data from the driver. This data is not 3445 * required WPA, but may be useful for some protocols and as 3446 * such, should be reported if this is available to the driver 3447 * interface. 3448 * 3449 * This should start with the first IE (fixed fields before IEs 3450 * are not included). 3451 */ 3452 const u8 *resp_ies; 3453 3454 /** 3455 * resp_ies_len - Length of resp_ies in bytes 3456 */ 3457 size_t resp_ies_len; 3458 3459 /** 3460 * status_code - Status Code from (Re)association Response 3461 */ 3462 u16 status_code; 3463 } assoc_reject; 3464 3465 struct timeout_event { 3466 u8 addr[ETH_ALEN]; 3467 } timeout_event; 3468 3469 /** 3470 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events 3471 */ 3472 struct ft_rrb_rx { 3473 const u8 *src; 3474 const u8 *data; 3475 size_t data_len; 3476 } ft_rrb_rx; 3477 3478 /** 3479 * struct tx_status - Data for EVENT_TX_STATUS events 3480 */ 3481 struct tx_status { 3482 u16 type; 3483 u16 stype; 3484 const u8 *dst; 3485 const u8 *data; 3486 size_t data_len; 3487 int ack; 3488 } tx_status; 3489 3490 /** 3491 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events 3492 */ 3493 struct rx_from_unknown { 3494 const u8 *bssid; 3495 const u8 *addr; 3496 int wds; 3497 } rx_from_unknown; 3498 3499 /** 3500 * struct rx_mgmt - Data for EVENT_RX_MGMT events 3501 */ 3502 struct rx_mgmt { 3503 const u8 *frame; 3504 size_t frame_len; 3505 u32 datarate; 3506 int ssi_signal; /* dBm */ 3507 } rx_mgmt; 3508 3509 /** 3510 * struct rx_action - Data for EVENT_RX_ACTION events 3511 */ 3512 struct rx_action { 3513 /** 3514 * da - Destination address of the received Action frame 3515 */ 3516 const u8 *da; 3517 3518 /** 3519 * sa - Source address of the received Action frame 3520 */ 3521 const u8 *sa; 3522 3523 /** 3524 * bssid - Address 3 of the received Action frame 3525 */ 3526 const u8 *bssid; 3527 3528 /** 3529 * category - Action frame category 3530 */ 3531 u8 category; 3532 3533 /** 3534 * data - Action frame body after category field 3535 */ 3536 const u8 *data; 3537 3538 /** 3539 * len - Length of data in octets 3540 */ 3541 size_t len; 3542 3543 /** 3544 * freq - Frequency (in MHz) on which the frame was received 3545 */ 3546 int freq; 3547 } rx_action; 3548 3549 /** 3550 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events 3551 * 3552 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events. 3553 */ 3554 struct remain_on_channel { 3555 /** 3556 * freq - Channel frequency in MHz 3557 */ 3558 unsigned int freq; 3559 3560 /** 3561 * duration - Duration to remain on the channel in milliseconds 3562 */ 3563 unsigned int duration; 3564 } remain_on_channel; 3565 3566 /** 3567 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events 3568 * @aborted: Whether the scan was aborted 3569 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned) 3570 * @num_freqs: Number of entries in freqs array 3571 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard 3572 * SSID) 3573 * @num_ssids: Number of entries in ssids array 3574 */ 3575 struct scan_info { 3576 int aborted; 3577 const int *freqs; 3578 size_t num_freqs; 3579 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS]; 3580 size_t num_ssids; 3581 } scan_info; 3582 3583 /** 3584 * struct mlme_rx - Data for EVENT_MLME_RX events 3585 */ 3586 struct mlme_rx { 3587 const u8 *buf; 3588 size_t len; 3589 int freq; 3590 int channel; 3591 int ssi; 3592 } mlme_rx; 3593 3594 /** 3595 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events 3596 */ 3597 struct rx_probe_req { 3598 /** 3599 * sa - Source address of the received Probe Request frame 3600 */ 3601 const u8 *sa; 3602 3603 /** 3604 * da - Destination address of the received Probe Request frame 3605 * or %NULL if not available 3606 */ 3607 const u8 *da; 3608 3609 /** 3610 * bssid - BSSID of the received Probe Request frame or %NULL 3611 * if not available 3612 */ 3613 const u8 *bssid; 3614 3615 /** 3616 * ie - IEs from the Probe Request body 3617 */ 3618 const u8 *ie; 3619 3620 /** 3621 * ie_len - Length of ie buffer in octets 3622 */ 3623 size_t ie_len; 3624 3625 /** 3626 * signal - signal strength in dBm (or 0 if not available) 3627 */ 3628 int ssi_signal; 3629 } rx_probe_req; 3630 3631 /** 3632 * struct new_sta - Data for EVENT_NEW_STA events 3633 */ 3634 struct new_sta { 3635 const u8 *addr; 3636 } new_sta; 3637 3638 /** 3639 * struct eapol_rx - Data for EVENT_EAPOL_RX events 3640 */ 3641 struct eapol_rx { 3642 const u8 *src; 3643 const u8 *data; 3644 size_t data_len; 3645 } eapol_rx; 3646 3647 /** 3648 * signal_change - Data for EVENT_SIGNAL_CHANGE events 3649 */ 3650 struct wpa_signal_info signal_change; 3651 3652 /** 3653 * struct best_channel - Data for EVENT_BEST_CHANNEL events 3654 * @freq_24: Best 2.4 GHz band channel frequency in MHz 3655 * @freq_5: Best 5 GHz band channel frequency in MHz 3656 * @freq_overall: Best channel frequency in MHz 3657 * 3658 * 0 can be used to indicate no preference in either band. 3659 */ 3660 struct best_channel { 3661 int freq_24; 3662 int freq_5; 3663 int freq_overall; 3664 } best_chan; 3665 3666 struct unprot_deauth { 3667 const u8 *sa; 3668 const u8 *da; 3669 u16 reason_code; 3670 } unprot_deauth; 3671 3672 struct unprot_disassoc { 3673 const u8 *sa; 3674 const u8 *da; 3675 u16 reason_code; 3676 } unprot_disassoc; 3677 3678 /** 3679 * struct low_ack - Data for EVENT_STATION_LOW_ACK events 3680 * @addr: station address 3681 */ 3682 struct low_ack { 3683 u8 addr[ETH_ALEN]; 3684 } low_ack; 3685 3686 /** 3687 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND 3688 */ 3689 struct p2p_dev_found { 3690 const u8 *addr; 3691 const u8 *dev_addr; 3692 const u8 *pri_dev_type; 3693 const char *dev_name; 3694 u16 config_methods; 3695 u8 dev_capab; 3696 u8 group_capab; 3697 } p2p_dev_found; 3698 3699 /** 3700 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX 3701 */ 3702 struct p2p_go_neg_req_rx { 3703 const u8 *src; 3704 u16 dev_passwd_id; 3705 } p2p_go_neg_req_rx; 3706 3707 /** 3708 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED 3709 */ 3710 struct p2p_go_neg_completed { 3711 struct p2p_go_neg_results *res; 3712 } p2p_go_neg_completed; 3713 3714 struct p2p_prov_disc_req { 3715 const u8 *peer; 3716 u16 config_methods; 3717 const u8 *dev_addr; 3718 const u8 *pri_dev_type; 3719 const char *dev_name; 3720 u16 supp_config_methods; 3721 u8 dev_capab; 3722 u8 group_capab; 3723 } p2p_prov_disc_req; 3724 3725 struct p2p_prov_disc_resp { 3726 const u8 *peer; 3727 u16 config_methods; 3728 } p2p_prov_disc_resp; 3729 3730 struct p2p_sd_req { 3731 int freq; 3732 const u8 *sa; 3733 u8 dialog_token; 3734 u16 update_indic; 3735 const u8 *tlvs; 3736 size_t tlvs_len; 3737 } p2p_sd_req; 3738 3739 struct p2p_sd_resp { 3740 const u8 *sa; 3741 u16 update_indic; 3742 const u8 *tlvs; 3743 size_t tlvs_len; 3744 } p2p_sd_resp; 3745 3746 /** 3747 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST 3748 */ 3749 struct ibss_peer_lost { 3750 u8 peer[ETH_ALEN]; 3751 } ibss_peer_lost; 3752 3753 /** 3754 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY 3755 */ 3756 struct driver_gtk_rekey { 3757 const u8 *bssid; 3758 const u8 *replay_ctr; 3759 } driver_gtk_rekey; 3760 3761 /** 3762 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events 3763 * @addr: station address 3764 */ 3765 struct client_poll { 3766 u8 addr[ETH_ALEN]; 3767 } client_poll; 3768 3769 /** 3770 * struct eapol_tx_status 3771 * @dst: Original destination 3772 * @data: Data starting with IEEE 802.1X header (!) 3773 * @data_len: Length of data 3774 * @ack: Indicates ack or lost frame 3775 * 3776 * This corresponds to hapd_send_eapol if the frame sent 3777 * there isn't just reported as EVENT_TX_STATUS. 3778 */ 3779 struct eapol_tx_status { 3780 const u8 *dst; 3781 const u8 *data; 3782 int data_len; 3783 int ack; 3784 } eapol_tx_status; 3785 3786 /** 3787 * struct ch_switch 3788 * @freq: Frequency of new channel in MHz 3789 * @ht_enabled: Whether this is an HT channel 3790 * @ch_offset: Secondary channel offset 3791 */ 3792 struct ch_switch { 3793 int freq; 3794 int ht_enabled; 3795 int ch_offset; 3796 } ch_switch; 3797 3798 /** 3799 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON 3800 * @addr: Remote client address 3801 * @code: Reason code for connection failure 3802 */ 3803 struct connect_failed_reason { 3804 u8 addr[ETH_ALEN]; 3805 enum { 3806 MAX_CLIENT_REACHED, 3807 BLOCKED_CLIENT 3808 } code; 3809 } connect_failed_reason; 3810 3811 /** 3812 * struct dfs_event - Data for radar detected events 3813 * @freq: Frequency of the channel in MHz 3814 */ 3815 struct dfs_event { 3816 int freq; 3817 } dfs_event; 3818}; 3819 3820/** 3821 * wpa_supplicant_event - Report a driver event for wpa_supplicant 3822 * @ctx: Context pointer (wpa_s); this is the ctx variable registered 3823 * with struct wpa_driver_ops::init() 3824 * @event: event type (defined above) 3825 * @data: possible extra data for the event 3826 * 3827 * Driver wrapper code should call this function whenever an event is received 3828 * from the driver. 3829 */ 3830void wpa_supplicant_event(void *ctx, enum wpa_event_type event, 3831 union wpa_event_data *data); 3832 3833 3834/* 3835 * The following inline functions are provided for convenience to simplify 3836 * event indication for some of the common events. 3837 */ 3838 3839static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie, 3840 size_t ielen, int reassoc) 3841{ 3842 union wpa_event_data event; 3843 os_memset(&event, 0, sizeof(event)); 3844 event.assoc_info.reassoc = reassoc; 3845 event.assoc_info.req_ies = ie; 3846 event.assoc_info.req_ies_len = ielen; 3847 event.assoc_info.addr = addr; 3848 wpa_supplicant_event(ctx, EVENT_ASSOC, &event); 3849} 3850 3851static inline void drv_event_disassoc(void *ctx, const u8 *addr) 3852{ 3853 union wpa_event_data event; 3854 os_memset(&event, 0, sizeof(event)); 3855 event.disassoc_info.addr = addr; 3856 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event); 3857} 3858 3859static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data, 3860 size_t data_len) 3861{ 3862 union wpa_event_data event; 3863 os_memset(&event, 0, sizeof(event)); 3864 event.eapol_rx.src = src; 3865 event.eapol_rx.data = data; 3866 event.eapol_rx.data_len = data_len; 3867 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event); 3868} 3869 3870/* driver_common.c */ 3871void wpa_scan_results_free(struct wpa_scan_results *res); 3872 3873/* Convert wpa_event_type to a string for logging */ 3874const char * event_to_string(enum wpa_event_type event); 3875 3876#endif /* DRIVER_H */ 3877