driver.h revision 8bae4138a0356709720a96f3e50b4d734e532c12
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 unsigned int max_acl_mac_addrs; 910 911 /** 912 * extended_capa - extended capabilities in driver/device 913 * 914 * Must be allocated and freed by driver and the pointers must be 915 * valid for the lifetime of the driver, i.e., freed in deinit() 916 */ 917 const u8 *extended_capa, *extended_capa_mask; 918 unsigned int extended_capa_len; 919}; 920 921 922struct hostapd_data; 923 924struct hostap_sta_driver_data { 925 unsigned long rx_packets, tx_packets, rx_bytes, tx_bytes; 926 unsigned long current_tx_rate; 927 unsigned long inactive_msec; 928 unsigned long flags; 929 unsigned long num_ps_buf_frames; 930 unsigned long tx_retry_failed; 931 unsigned long tx_retry_count; 932 int last_rssi; 933 int last_ack_rssi; 934}; 935 936struct hostapd_sta_add_params { 937 const u8 *addr; 938 u16 aid; 939 u16 capability; 940 const u8 *supp_rates; 941 size_t supp_rates_len; 942 u16 listen_interval; 943 const struct ieee80211_ht_capabilities *ht_capabilities; 944 const struct ieee80211_vht_capabilities *vht_capabilities; 945 u32 flags; /* bitmask of WPA_STA_* flags */ 946 int set; /* Set STA parameters instead of add */ 947 u8 qosinfo; 948 const u8 *ext_capab; 949 size_t ext_capab_len; 950}; 951 952struct hostapd_freq_params { 953 int mode; 954 int freq; 955 int channel; 956 /* for HT */ 957 int ht_enabled; 958 int sec_channel_offset; /* 0 = HT40 disabled, -1 = HT40 enabled, 959 * secondary channel below primary, 1 = HT40 960 * enabled, secondary channel above primary */ 961 962 /* for VHT */ 963 int vht_enabled; 964 965 /* valid for both HT and VHT, center_freq2 is non-zero 966 * only for bandwidth 80 and an 80+80 channel */ 967 int center_freq1, center_freq2; 968 int bandwidth; 969}; 970 971struct mac_address { 972 u8 addr[ETH_ALEN]; 973}; 974 975struct hostapd_acl_params { 976 u8 acl_policy; 977 unsigned int num_mac_acl; 978 struct mac_address mac_acl[0]; 979}; 980 981enum wpa_driver_if_type { 982 /** 983 * WPA_IF_STATION - Station mode interface 984 */ 985 WPA_IF_STATION, 986 987 /** 988 * WPA_IF_AP_VLAN - AP mode VLAN interface 989 * 990 * This interface shares its address and Beacon frame with the main 991 * BSS. 992 */ 993 WPA_IF_AP_VLAN, 994 995 /** 996 * WPA_IF_AP_BSS - AP mode BSS interface 997 * 998 * This interface has its own address and Beacon frame. 999 */ 1000 WPA_IF_AP_BSS, 1001 1002 /** 1003 * WPA_IF_P2P_GO - P2P Group Owner 1004 */ 1005 WPA_IF_P2P_GO, 1006 1007 /** 1008 * WPA_IF_P2P_CLIENT - P2P Client 1009 */ 1010 WPA_IF_P2P_CLIENT, 1011 1012 /** 1013 * WPA_IF_P2P_GROUP - P2P Group interface (will become either 1014 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known) 1015 */ 1016 WPA_IF_P2P_GROUP 1017}; 1018 1019struct wpa_init_params { 1020 void *global_priv; 1021 const u8 *bssid; 1022 const char *ifname; 1023 const u8 *ssid; 1024 size_t ssid_len; 1025 const char *test_socket; 1026 int use_pae_group_addr; 1027 char **bridge; 1028 size_t num_bridge; 1029 1030 u8 *own_addr; /* buffer for writing own MAC address */ 1031}; 1032 1033 1034struct wpa_bss_params { 1035 /** Interface name (for multi-SSID/VLAN support) */ 1036 const char *ifname; 1037 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */ 1038 int enabled; 1039 1040 int wpa; 1041 int ieee802_1x; 1042 int wpa_group; 1043 int wpa_pairwise; 1044 int wpa_key_mgmt; 1045 int rsn_preauth; 1046 enum mfp_options ieee80211w; 1047}; 1048 1049#define WPA_STA_AUTHORIZED BIT(0) 1050#define WPA_STA_WMM BIT(1) 1051#define WPA_STA_SHORT_PREAMBLE BIT(2) 1052#define WPA_STA_MFP BIT(3) 1053#define WPA_STA_TDLS_PEER BIT(4) 1054 1055/** 1056 * struct p2p_params - P2P parameters for driver-based P2P management 1057 */ 1058struct p2p_params { 1059 const char *dev_name; 1060 u8 pri_dev_type[8]; 1061#define DRV_MAX_SEC_DEV_TYPES 5 1062 u8 sec_dev_type[DRV_MAX_SEC_DEV_TYPES][8]; 1063 size_t num_sec_dev_types; 1064}; 1065 1066enum tdls_oper { 1067 TDLS_DISCOVERY_REQ, 1068 TDLS_SETUP, 1069 TDLS_TEARDOWN, 1070 TDLS_ENABLE_LINK, 1071 TDLS_DISABLE_LINK, 1072 TDLS_ENABLE, 1073 TDLS_DISABLE 1074}; 1075 1076enum wnm_oper { 1077 WNM_SLEEP_ENTER_CONFIRM, 1078 WNM_SLEEP_ENTER_FAIL, 1079 WNM_SLEEP_EXIT_CONFIRM, 1080 WNM_SLEEP_EXIT_FAIL, 1081 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */ 1082 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */ 1083 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for 1084 * a STA */ 1085 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE 1086 * for a STA */ 1087 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */ 1088 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE 1089 * for a STA */ 1090 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */ 1091}; 1092 1093/** 1094 * struct wpa_signal_info - Information about channel signal quality 1095 */ 1096struct wpa_signal_info { 1097 u32 frequency; 1098 int above_threshold; 1099 int current_signal; 1100 int current_noise; 1101 int current_txrate; 1102}; 1103 1104/** 1105 * struct wpa_driver_ops - Driver interface API definition 1106 * 1107 * This structure defines the API that each driver interface needs to implement 1108 * for core wpa_supplicant code. All driver specific functionality is captured 1109 * in this wrapper. 1110 */ 1111struct wpa_driver_ops { 1112 /** Name of the driver interface */ 1113 const char *name; 1114 /** One line description of the driver interface */ 1115 const char *desc; 1116 1117 /** 1118 * get_bssid - Get the current BSSID 1119 * @priv: private driver interface data 1120 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes) 1121 * 1122 * Returns: 0 on success, -1 on failure 1123 * 1124 * Query kernel driver for the current BSSID and copy it to bssid. 1125 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not 1126 * associated. 1127 */ 1128 int (*get_bssid)(void *priv, u8 *bssid); 1129 1130 /** 1131 * get_ssid - Get the current SSID 1132 * @priv: private driver interface data 1133 * @ssid: buffer for SSID (at least 32 bytes) 1134 * 1135 * Returns: Length of the SSID on success, -1 on failure 1136 * 1137 * Query kernel driver for the current SSID and copy it to ssid. 1138 * Returning zero is recommended if the STA is not associated. 1139 * 1140 * Note: SSID is an array of octets, i.e., it is not nul terminated and 1141 * can, at least in theory, contain control characters (including nul) 1142 * and as such, should be processed as binary data, not a printable 1143 * string. 1144 */ 1145 int (*get_ssid)(void *priv, u8 *ssid); 1146 1147 /** 1148 * set_key - Configure encryption key 1149 * @ifname: Interface name (for multi-SSID/VLAN support) 1150 * @priv: private driver interface data 1151 * @alg: encryption algorithm (%WPA_ALG_NONE, %WPA_ALG_WEP, 1152 * %WPA_ALG_TKIP, %WPA_ALG_CCMP, %WPA_ALG_IGTK, %WPA_ALG_PMK, 1153 * %WPA_ALG_GCMP); 1154 * %WPA_ALG_NONE clears the key. 1155 * @addr: Address of the peer STA (BSSID of the current AP when setting 1156 * pairwise key in station mode), ff:ff:ff:ff:ff:ff for 1157 * broadcast keys, %NULL for default keys that are used both for 1158 * broadcast and unicast; when clearing keys, %NULL is used to 1159 * indicate that both the broadcast-only and default key of the 1160 * specified key index is to be cleared 1161 * @key_idx: key index (0..3), usually 0 for unicast keys; 0..4095 for 1162 * IGTK 1163 * @set_tx: configure this key as the default Tx key (only used when 1164 * driver does not support separate unicast/individual key 1165 * @seq: sequence number/packet number, seq_len octets, the next 1166 * packet number to be used for in replay protection; configured 1167 * for Rx keys (in most cases, this is only used with broadcast 1168 * keys and set to zero for unicast keys); %NULL if not set 1169 * @seq_len: length of the seq, depends on the algorithm: 1170 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets 1171 * @key: key buffer; TKIP: 16-byte temporal key, 8-byte Tx Mic key, 1172 * 8-byte Rx Mic Key 1173 * @key_len: length of the key buffer in octets (WEP: 5 or 13, 1174 * TKIP: 32, CCMP/GCMP: 16, IGTK: 16) 1175 * 1176 * Returns: 0 on success, -1 on failure 1177 * 1178 * Configure the given key for the kernel driver. If the driver 1179 * supports separate individual keys (4 default keys + 1 individual), 1180 * addr can be used to determine whether the key is default or 1181 * individual. If only 4 keys are supported, the default key with key 1182 * index 0 is used as the individual key. STA must be configured to use 1183 * it as the default Tx key (set_tx is set) and accept Rx for all the 1184 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for 1185 * broadcast keys, so key index 0 is available for this kind of 1186 * configuration. 1187 * 1188 * Please note that TKIP keys include separate TX and RX MIC keys and 1189 * some drivers may expect them in different order than wpa_supplicant 1190 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets 1191 * will trigger Michael MIC errors. This can be fixed by changing the 1192 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key 1193 * in driver_*.c set_key() implementation, see driver_ndis.c for an 1194 * example on how this can be done. 1195 */ 1196 int (*set_key)(const char *ifname, void *priv, enum wpa_alg alg, 1197 const u8 *addr, int key_idx, int set_tx, 1198 const u8 *seq, size_t seq_len, 1199 const u8 *key, size_t key_len); 1200 1201 /** 1202 * init - Initialize driver interface 1203 * @ctx: context to be used when calling wpa_supplicant functions, 1204 * e.g., wpa_supplicant_event() 1205 * @ifname: interface name, e.g., wlan0 1206 * 1207 * Returns: Pointer to private data, %NULL on failure 1208 * 1209 * Initialize driver interface, including event processing for kernel 1210 * driver events (e.g., associated, scan results, Michael MIC failure). 1211 * This function can allocate a private configuration data area for 1212 * @ctx, file descriptor, interface name, etc. information that may be 1213 * needed in future driver operations. If this is not used, non-NULL 1214 * value will need to be returned because %NULL is used to indicate 1215 * failure. The returned value will be used as 'void *priv' data for 1216 * all other driver_ops functions. 1217 * 1218 * The main event loop (eloop.c) of wpa_supplicant can be used to 1219 * register callback for read sockets (eloop_register_read_sock()). 1220 * 1221 * See below for more information about events and 1222 * wpa_supplicant_event() function. 1223 */ 1224 void * (*init)(void *ctx, const char *ifname); 1225 1226 /** 1227 * deinit - Deinitialize driver interface 1228 * @priv: private driver interface data from init() 1229 * 1230 * Shut down driver interface and processing of driver events. Free 1231 * private data buffer if one was allocated in init() handler. 1232 */ 1233 void (*deinit)(void *priv); 1234 1235 /** 1236 * set_param - Set driver configuration parameters 1237 * @priv: private driver interface data from init() 1238 * @param: driver specific configuration parameters 1239 * 1240 * Returns: 0 on success, -1 on failure 1241 * 1242 * Optional handler for notifying driver interface about configuration 1243 * parameters (driver_param). 1244 */ 1245 int (*set_param)(void *priv, const char *param); 1246 1247 /** 1248 * set_countermeasures - Enable/disable TKIP countermeasures 1249 * @priv: private driver interface data 1250 * @enabled: 1 = countermeasures enabled, 0 = disabled 1251 * 1252 * Returns: 0 on success, -1 on failure 1253 * 1254 * Configure TKIP countermeasures. When these are enabled, the driver 1255 * should drop all received and queued frames that are using TKIP. 1256 */ 1257 int (*set_countermeasures)(void *priv, int enabled); 1258 1259 /** 1260 * deauthenticate - Request driver to deauthenticate 1261 * @priv: private driver interface data 1262 * @addr: peer address (BSSID of the AP) 1263 * @reason_code: 16-bit reason code to be sent in the deauthentication 1264 * frame 1265 * 1266 * Returns: 0 on success, -1 on failure 1267 */ 1268 int (*deauthenticate)(void *priv, const u8 *addr, int reason_code); 1269 1270 /** 1271 * associate - Request driver to associate 1272 * @priv: private driver interface data 1273 * @params: association parameters 1274 * 1275 * Returns: 0 on success, -1 on failure 1276 */ 1277 int (*associate)(void *priv, 1278 struct wpa_driver_associate_params *params); 1279 1280 /** 1281 * add_pmkid - Add PMKSA cache entry to the driver 1282 * @priv: private driver interface data 1283 * @bssid: BSSID for the PMKSA cache entry 1284 * @pmkid: PMKID for the PMKSA cache entry 1285 * 1286 * Returns: 0 on success, -1 on failure 1287 * 1288 * This function is called when a new PMK is received, as a result of 1289 * either normal authentication or RSN pre-authentication. 1290 * 1291 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 1292 * associate(), add_pmkid() can be used to add new PMKSA cache entries 1293 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this 1294 * driver_ops function does not need to be implemented. Likewise, if 1295 * the driver does not support WPA, this function is not needed. 1296 */ 1297 int (*add_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid); 1298 1299 /** 1300 * remove_pmkid - Remove PMKSA cache entry to the driver 1301 * @priv: private driver interface data 1302 * @bssid: BSSID for the PMKSA cache entry 1303 * @pmkid: PMKID for the PMKSA cache entry 1304 * 1305 * Returns: 0 on success, -1 on failure 1306 * 1307 * This function is called when the supplicant drops a PMKSA cache 1308 * entry for any reason. 1309 * 1310 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 1311 * associate(), remove_pmkid() can be used to synchronize PMKSA caches 1312 * between the driver and wpa_supplicant. If the driver uses wpa_ie 1313 * from wpa_supplicant, this driver_ops function does not need to be 1314 * implemented. Likewise, if the driver does not support WPA, this 1315 * function is not needed. 1316 */ 1317 int (*remove_pmkid)(void *priv, const u8 *bssid, const u8 *pmkid); 1318 1319 /** 1320 * flush_pmkid - Flush PMKSA cache 1321 * @priv: private driver interface data 1322 * 1323 * Returns: 0 on success, -1 on failure 1324 * 1325 * This function is called when the supplicant drops all PMKSA cache 1326 * entries for any reason. 1327 * 1328 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 1329 * associate(), remove_pmkid() can be used to synchronize PMKSA caches 1330 * between the driver and wpa_supplicant. If the driver uses wpa_ie 1331 * from wpa_supplicant, this driver_ops function does not need to be 1332 * implemented. Likewise, if the driver does not support WPA, this 1333 * function is not needed. 1334 */ 1335 int (*flush_pmkid)(void *priv); 1336 1337 /** 1338 * get_capa - Get driver capabilities 1339 * @priv: private driver interface data 1340 * 1341 * Returns: 0 on success, -1 on failure 1342 * 1343 * Get driver/firmware/hardware capabilities. 1344 */ 1345 int (*get_capa)(void *priv, struct wpa_driver_capa *capa); 1346 1347 /** 1348 * poll - Poll driver for association information 1349 * @priv: private driver interface data 1350 * 1351 * This is an option callback that can be used when the driver does not 1352 * provide event mechanism for association events. This is called when 1353 * receiving WPA EAPOL-Key messages that require association 1354 * information. The driver interface is supposed to generate associnfo 1355 * event before returning from this callback function. In addition, the 1356 * driver interface should generate an association event after having 1357 * sent out associnfo. 1358 */ 1359 void (*poll)(void *priv); 1360 1361 /** 1362 * get_ifname - Get interface name 1363 * @priv: private driver interface data 1364 * 1365 * Returns: Pointer to the interface name. This can differ from the 1366 * interface name used in init() call. Init() is called first. 1367 * 1368 * This optional function can be used to allow the driver interface to 1369 * replace the interface name with something else, e.g., based on an 1370 * interface mapping from a more descriptive name. 1371 */ 1372 const char * (*get_ifname)(void *priv); 1373 1374 /** 1375 * get_mac_addr - Get own MAC address 1376 * @priv: private driver interface data 1377 * 1378 * Returns: Pointer to own MAC address or %NULL on failure 1379 * 1380 * This optional function can be used to get the own MAC address of the 1381 * device from the driver interface code. This is only needed if the 1382 * l2_packet implementation for the OS does not provide easy access to 1383 * a MAC address. */ 1384 const u8 * (*get_mac_addr)(void *priv); 1385 1386 /** 1387 * send_eapol - Optional function for sending EAPOL packets 1388 * @priv: private driver interface data 1389 * @dest: Destination MAC address 1390 * @proto: Ethertype 1391 * @data: EAPOL packet starting with IEEE 802.1X header 1392 * @data_len: Size of the EAPOL packet 1393 * 1394 * Returns: 0 on success, -1 on failure 1395 * 1396 * This optional function can be used to override l2_packet operations 1397 * with driver specific functionality. If this function pointer is set, 1398 * l2_packet module is not used at all and the driver interface code is 1399 * responsible for receiving and sending all EAPOL packets. The 1400 * received EAPOL packets are sent to core code with EVENT_EAPOL_RX 1401 * event. The driver interface is required to implement get_mac_addr() 1402 * handler if send_eapol() is used. 1403 */ 1404 int (*send_eapol)(void *priv, const u8 *dest, u16 proto, 1405 const u8 *data, size_t data_len); 1406 1407 /** 1408 * set_operstate - Sets device operating state to DORMANT or UP 1409 * @priv: private driver interface data 1410 * @state: 0 = dormant, 1 = up 1411 * Returns: 0 on success, -1 on failure 1412 * 1413 * This is an optional function that can be used on operating systems 1414 * that support a concept of controlling network device state from user 1415 * space applications. This function, if set, gets called with 1416 * state = 1 when authentication has been completed and with state = 0 1417 * when connection is lost. 1418 */ 1419 int (*set_operstate)(void *priv, int state); 1420 1421 /** 1422 * mlme_setprotection - MLME-SETPROTECTION.request primitive 1423 * @priv: Private driver interface data 1424 * @addr: Address of the station for which to set protection (may be 1425 * %NULL for group keys) 1426 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_* 1427 * @key_type: MLME_SETPROTECTION_KEY_TYPE_* 1428 * Returns: 0 on success, -1 on failure 1429 * 1430 * This is an optional function that can be used to set the driver to 1431 * require protection for Tx and/or Rx frames. This uses the layer 1432 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1 1433 * (MLME-SETPROTECTION.request). Many drivers do not use explicit 1434 * set protection operation; instead, they set protection implicitly 1435 * based on configured keys. 1436 */ 1437 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type, 1438 int key_type); 1439 1440 /** 1441 * get_hw_feature_data - Get hardware support data (channels and rates) 1442 * @priv: Private driver interface data 1443 * @num_modes: Variable for returning the number of returned modes 1444 * flags: Variable for returning hardware feature flags 1445 * Returns: Pointer to allocated hardware data on success or %NULL on 1446 * failure. Caller is responsible for freeing this. 1447 */ 1448 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv, 1449 u16 *num_modes, 1450 u16 *flags); 1451 1452 /** 1453 * send_mlme - Send management frame from MLME 1454 * @priv: Private driver interface data 1455 * @data: IEEE 802.11 management frame with IEEE 802.11 header 1456 * @data_len: Size of the management frame 1457 * @noack: Do not wait for this frame to be acked (disable retries) 1458 * Returns: 0 on success, -1 on failure 1459 */ 1460 int (*send_mlme)(void *priv, const u8 *data, size_t data_len, 1461 int noack); 1462 1463 /** 1464 * update_ft_ies - Update FT (IEEE 802.11r) IEs 1465 * @priv: Private driver interface data 1466 * @md: Mobility domain (2 octets) (also included inside ies) 1467 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs 1468 * @ies_len: Length of FT IEs in bytes 1469 * Returns: 0 on success, -1 on failure 1470 * 1471 * The supplicant uses this callback to let the driver know that keying 1472 * material for FT is available and that the driver can use the 1473 * provided IEs in the next message in FT authentication sequence. 1474 * 1475 * This function is only needed for driver that support IEEE 802.11r 1476 * (Fast BSS Transition). 1477 */ 1478 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies, 1479 size_t ies_len); 1480 1481 /** 1482 * send_ft_action - Send FT Action frame (IEEE 802.11r) 1483 * @priv: Private driver interface data 1484 * @action: Action field value 1485 * @target_ap: Target AP address 1486 * @ies: FT IEs (MDIE, FTIE, ...) (FT Request action frame body) 1487 * @ies_len: Length of FT IEs in bytes 1488 * Returns: 0 on success, -1 on failure 1489 * 1490 * The supplicant uses this callback to request the driver to transmit 1491 * an FT Action frame (action category 6) for over-the-DS fast BSS 1492 * transition. 1493 */ 1494 int (*send_ft_action)(void *priv, u8 action, const u8 *target_ap, 1495 const u8 *ies, size_t ies_len); 1496 1497 /** 1498 * get_scan_results2 - Fetch the latest scan results 1499 * @priv: private driver interface data 1500 * 1501 * Returns: Allocated buffer of scan results (caller is responsible for 1502 * freeing the data structure) on success, NULL on failure 1503 */ 1504 struct wpa_scan_results * (*get_scan_results2)(void *priv); 1505 1506 /** 1507 * set_country - Set country 1508 * @priv: Private driver interface data 1509 * @alpha2: country to which to switch to 1510 * Returns: 0 on success, -1 on failure 1511 * 1512 * This function is for drivers which support some form 1513 * of setting a regulatory domain. 1514 */ 1515 int (*set_country)(void *priv, const char *alpha2); 1516 1517 /** 1518 * global_init - Global driver initialization 1519 * Returns: Pointer to private data (global), %NULL on failure 1520 * 1521 * This optional function is called to initialize the driver wrapper 1522 * for global data, i.e., data that applies to all interfaces. If this 1523 * function is implemented, global_deinit() will also need to be 1524 * implemented to free the private data. The driver will also likely 1525 * use init2() function instead of init() to get the pointer to global 1526 * data available to per-interface initializer. 1527 */ 1528 void * (*global_init)(void); 1529 1530 /** 1531 * global_deinit - Global driver deinitialization 1532 * @priv: private driver global data from global_init() 1533 * 1534 * Terminate any global driver related functionality and free the 1535 * global data structure. 1536 */ 1537 void (*global_deinit)(void *priv); 1538 1539 /** 1540 * init2 - Initialize driver interface (with global data) 1541 * @ctx: context to be used when calling wpa_supplicant functions, 1542 * e.g., wpa_supplicant_event() 1543 * @ifname: interface name, e.g., wlan0 1544 * @global_priv: private driver global data from global_init() 1545 * Returns: Pointer to private data, %NULL on failure 1546 * 1547 * This function can be used instead of init() if the driver wrapper 1548 * uses global data. 1549 */ 1550 void * (*init2)(void *ctx, const char *ifname, void *global_priv); 1551 1552 /** 1553 * get_interfaces - Get information about available interfaces 1554 * @global_priv: private driver global data from global_init() 1555 * Returns: Allocated buffer of interface information (caller is 1556 * responsible for freeing the data structure) on success, NULL on 1557 * failure 1558 */ 1559 struct wpa_interface_info * (*get_interfaces)(void *global_priv); 1560 1561 /** 1562 * scan2 - Request the driver to initiate scan 1563 * @priv: private driver interface data 1564 * @params: Scan parameters 1565 * 1566 * Returns: 0 on success, -1 on failure 1567 * 1568 * Once the scan results are ready, the driver should report scan 1569 * results event for wpa_supplicant which will eventually request the 1570 * results with wpa_driver_get_scan_results2(). 1571 */ 1572 int (*scan2)(void *priv, struct wpa_driver_scan_params *params); 1573 1574 /** 1575 * authenticate - Request driver to authenticate 1576 * @priv: private driver interface data 1577 * @params: authentication parameters 1578 * Returns: 0 on success, -1 on failure 1579 * 1580 * This is an optional function that can be used with drivers that 1581 * support separate authentication and association steps, i.e., when 1582 * wpa_supplicant can act as the SME. If not implemented, associate() 1583 * function is expected to take care of IEEE 802.11 authentication, 1584 * too. 1585 */ 1586 int (*authenticate)(void *priv, 1587 struct wpa_driver_auth_params *params); 1588 1589 /** 1590 * set_ap - Set Beacon and Probe Response information for AP mode 1591 * @priv: Private driver interface data 1592 * @params: Parameters to use in AP mode 1593 * 1594 * This function is used to configure Beacon template and/or extra IEs 1595 * to add for Beacon and Probe Response frames for the driver in 1596 * AP mode. The driver is responsible for building the full Beacon 1597 * frame by concatenating the head part with TIM IE generated by the 1598 * driver/firmware and finishing with the tail part. Depending on the 1599 * driver architectue, this can be done either by using the full 1600 * template or the set of additional IEs (e.g., WPS and P2P IE). 1601 * Similarly, Probe Response processing depends on the driver design. 1602 * If the driver (or firmware) takes care of replying to Probe Request 1603 * frames, the extra IEs provided here needs to be added to the Probe 1604 * Response frames. 1605 * 1606 * Returns: 0 on success, -1 on failure 1607 */ 1608 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params); 1609 1610 /** 1611 * set_acl - Set ACL in AP mode 1612 * @priv: Private driver interface data 1613 * @params: Parameters to configure ACL 1614 * Returns: 0 on success, -1 on failure 1615 * 1616 * This is used only for the drivers which support MAC address ACL. 1617 */ 1618 int (*set_acl)(void *priv, struct hostapd_acl_params *params); 1619 1620 /** 1621 * hapd_init - Initialize driver interface (hostapd only) 1622 * @hapd: Pointer to hostapd context 1623 * @params: Configuration for the driver wrapper 1624 * Returns: Pointer to private data, %NULL on failure 1625 * 1626 * This function is used instead of init() or init2() when the driver 1627 * wrapper is used with hostapd. 1628 */ 1629 void * (*hapd_init)(struct hostapd_data *hapd, 1630 struct wpa_init_params *params); 1631 1632 /** 1633 * hapd_deinit - Deinitialize driver interface (hostapd only) 1634 * @priv: Private driver interface data from hapd_init() 1635 */ 1636 void (*hapd_deinit)(void *priv); 1637 1638 /** 1639 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only) 1640 * @priv: Private driver interface data 1641 * @params: BSS parameters 1642 * Returns: 0 on success, -1 on failure 1643 * 1644 * This is an optional function to configure the kernel driver to 1645 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This 1646 * can be left undefined (set to %NULL) if IEEE 802.1X support is 1647 * always enabled and the driver uses set_ap() to set WPA/RSN IE 1648 * for Beacon frames. 1649 * 1650 * DEPRECATED - use set_ap() instead 1651 */ 1652 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params); 1653 1654 /** 1655 * set_privacy - Enable/disable privacy (AP only) 1656 * @priv: Private driver interface data 1657 * @enabled: 1 = privacy enabled, 0 = disabled 1658 * Returns: 0 on success, -1 on failure 1659 * 1660 * This is an optional function to configure privacy field in the 1661 * kernel driver for Beacon frames. This can be left undefined (set to 1662 * %NULL) if the driver uses the Beacon template from set_ap(). 1663 * 1664 * DEPRECATED - use set_ap() instead 1665 */ 1666 int (*set_privacy)(void *priv, int enabled); 1667 1668 /** 1669 * get_seqnum - Fetch the current TSC/packet number (AP only) 1670 * @ifname: The interface name (main or virtual) 1671 * @priv: Private driver interface data 1672 * @addr: MAC address of the station or %NULL for group keys 1673 * @idx: Key index 1674 * @seq: Buffer for returning the latest used TSC/packet number 1675 * Returns: 0 on success, -1 on failure 1676 * 1677 * This function is used to fetch the last used TSC/packet number for 1678 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group 1679 * keys, so there is no strict requirement on implementing support for 1680 * unicast keys (i.e., addr != %NULL). 1681 */ 1682 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr, 1683 int idx, u8 *seq); 1684 1685 /** 1686 * flush - Flush all association stations (AP only) 1687 * @priv: Private driver interface data 1688 * Returns: 0 on success, -1 on failure 1689 * 1690 * This function requests the driver to disassociate all associated 1691 * stations. This function does not need to be implemented if the 1692 * driver does not process association frames internally. 1693 */ 1694 int (*flush)(void *priv); 1695 1696 /** 1697 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP) 1698 * @priv: Private driver interface data 1699 * @elem: Information elements 1700 * @elem_len: Length of the elem buffer in octets 1701 * Returns: 0 on success, -1 on failure 1702 * 1703 * This is an optional function to add information elements in the 1704 * kernel driver for Beacon and Probe Response frames. This can be left 1705 * undefined (set to %NULL) if the driver uses the Beacon template from 1706 * set_ap(). 1707 * 1708 * DEPRECATED - use set_ap() instead 1709 */ 1710 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len); 1711 1712 /** 1713 * read_sta_data - Fetch station data 1714 * @priv: Private driver interface data 1715 * @data: Buffer for returning station information 1716 * @addr: MAC address of the station 1717 * Returns: 0 on success, -1 on failure 1718 */ 1719 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data, 1720 const u8 *addr); 1721 1722 /** 1723 * hapd_send_eapol - Send an EAPOL packet (AP only) 1724 * @priv: private driver interface data 1725 * @addr: Destination MAC address 1726 * @data: EAPOL packet starting with IEEE 802.1X header 1727 * @data_len: Length of the EAPOL packet in octets 1728 * @encrypt: Whether the frame should be encrypted 1729 * @own_addr: Source MAC address 1730 * @flags: WPA_STA_* flags for the destination station 1731 * 1732 * Returns: 0 on success, -1 on failure 1733 */ 1734 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data, 1735 size_t data_len, int encrypt, 1736 const u8 *own_addr, u32 flags); 1737 1738 /** 1739 * sta_deauth - Deauthenticate a station (AP only) 1740 * @priv: Private driver interface data 1741 * @own_addr: Source address and BSSID for the Deauthentication frame 1742 * @addr: MAC address of the station to deauthenticate 1743 * @reason: Reason code for the Deauthentiation frame 1744 * Returns: 0 on success, -1 on failure 1745 * 1746 * This function requests a specific station to be deauthenticated and 1747 * a Deauthentication frame to be sent to it. 1748 */ 1749 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr, 1750 int reason); 1751 1752 /** 1753 * sta_disassoc - Disassociate a station (AP only) 1754 * @priv: Private driver interface data 1755 * @own_addr: Source address and BSSID for the Disassociation frame 1756 * @addr: MAC address of the station to disassociate 1757 * @reason: Reason code for the Disassociation frame 1758 * Returns: 0 on success, -1 on failure 1759 * 1760 * This function requests a specific station to be disassociated and 1761 * a Disassociation frame to be sent to it. 1762 */ 1763 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr, 1764 int reason); 1765 1766 /** 1767 * sta_remove - Remove a station entry (AP only) 1768 * @priv: Private driver interface data 1769 * @addr: MAC address of the station to be removed 1770 * Returns: 0 on success, -1 on failure 1771 */ 1772 int (*sta_remove)(void *priv, const u8 *addr); 1773 1774 /** 1775 * hapd_get_ssid - Get the current SSID (AP only) 1776 * @priv: Private driver interface data 1777 * @buf: Buffer for returning the SSID 1778 * @len: Maximum length of the buffer 1779 * Returns: Length of the SSID on success, -1 on failure 1780 * 1781 * This function need not be implemented if the driver uses Beacon 1782 * template from set_ap() and does not reply to Probe Request frames. 1783 */ 1784 int (*hapd_get_ssid)(void *priv, u8 *buf, int len); 1785 1786 /** 1787 * hapd_set_ssid - Set SSID (AP only) 1788 * @priv: Private driver interface data 1789 * @buf: SSID 1790 * @len: Length of the SSID in octets 1791 * Returns: 0 on success, -1 on failure 1792 * 1793 * DEPRECATED - use set_ap() instead 1794 */ 1795 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len); 1796 1797 /** 1798 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP) 1799 * @priv: Private driver interface data 1800 * @enabled: 1 = countermeasures enabled, 0 = disabled 1801 * Returns: 0 on success, -1 on failure 1802 * 1803 * This need not be implemented if the driver does not take care of 1804 * association processing. 1805 */ 1806 int (*hapd_set_countermeasures)(void *priv, int enabled); 1807 1808 /** 1809 * sta_add - Add a station entry 1810 * @priv: Private driver interface data 1811 * @params: Station parameters 1812 * Returns: 0 on success, -1 on failure 1813 * 1814 * This function is used to add a station entry to the driver once the 1815 * station has completed association. This is only used if the driver 1816 * does not take care of association processing. 1817 * 1818 * With TDLS, this function is also used to add or set (params->set 1) 1819 * TDLS peer entries. 1820 */ 1821 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params); 1822 1823 /** 1824 * get_inact_sec - Get station inactivity duration (AP only) 1825 * @priv: Private driver interface data 1826 * @addr: Station address 1827 * Returns: Number of seconds station has been inactive, -1 on failure 1828 */ 1829 int (*get_inact_sec)(void *priv, const u8 *addr); 1830 1831 /** 1832 * sta_clear_stats - Clear station statistics (AP only) 1833 * @priv: Private driver interface data 1834 * @addr: Station address 1835 * Returns: 0 on success, -1 on failure 1836 */ 1837 int (*sta_clear_stats)(void *priv, const u8 *addr); 1838 1839 /** 1840 * set_freq - Set channel/frequency (AP only) 1841 * @priv: Private driver interface data 1842 * @freq: Channel parameters 1843 * Returns: 0 on success, -1 on failure 1844 */ 1845 int (*set_freq)(void *priv, struct hostapd_freq_params *freq); 1846 1847 /** 1848 * set_rts - Set RTS threshold 1849 * @priv: Private driver interface data 1850 * @rts: RTS threshold in octets 1851 * Returns: 0 on success, -1 on failure 1852 */ 1853 int (*set_rts)(void *priv, int rts); 1854 1855 /** 1856 * set_frag - Set fragmentation threshold 1857 * @priv: Private driver interface data 1858 * @frag: Fragmentation threshold in octets 1859 * Returns: 0 on success, -1 on failure 1860 */ 1861 int (*set_frag)(void *priv, int frag); 1862 1863 /** 1864 * sta_set_flags - Set station flags (AP only) 1865 * @priv: Private driver interface data 1866 * @addr: Station address 1867 * @total_flags: Bitmap of all WPA_STA_* flags currently set 1868 * @flags_or: Bitmap of WPA_STA_* flags to add 1869 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask 1870 * Returns: 0 on success, -1 on failure 1871 */ 1872 int (*sta_set_flags)(void *priv, const u8 *addr, 1873 int total_flags, int flags_or, int flags_and); 1874 1875 /** 1876 * set_tx_queue_params - Set TX queue parameters 1877 * @priv: Private driver interface data 1878 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK) 1879 * @aifs: AIFS 1880 * @cw_min: cwMin 1881 * @cw_max: cwMax 1882 * @burst_time: Maximum length for bursting in 0.1 msec units 1883 */ 1884 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min, 1885 int cw_max, int burst_time); 1886 1887 /** 1888 * if_add - Add a virtual interface 1889 * @priv: Private driver interface data 1890 * @type: Interface type 1891 * @ifname: Interface name for the new virtual interface 1892 * @addr: Local address to use for the interface or %NULL to use the 1893 * parent interface address 1894 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces 1895 * @drv_priv: Pointer for overwriting the driver context or %NULL if 1896 * not allowed (applies only to %WPA_IF_AP_BSS type) 1897 * @force_ifname: Buffer for returning an interface name that the 1898 * driver ended up using if it differs from the requested ifname 1899 * @if_addr: Buffer for returning the allocated interface address 1900 * (this may differ from the requested addr if the driver cannot 1901 * change interface address) 1902 * @bridge: Bridge interface to use or %NULL if no bridge configured 1903 * Returns: 0 on success, -1 on failure 1904 */ 1905 int (*if_add)(void *priv, enum wpa_driver_if_type type, 1906 const char *ifname, const u8 *addr, void *bss_ctx, 1907 void **drv_priv, char *force_ifname, u8 *if_addr, 1908 const char *bridge); 1909 1910 /** 1911 * if_remove - Remove a virtual interface 1912 * @priv: Private driver interface data 1913 * @type: Interface type 1914 * @ifname: Interface name of the virtual interface to be removed 1915 * Returns: 0 on success, -1 on failure 1916 */ 1917 int (*if_remove)(void *priv, enum wpa_driver_if_type type, 1918 const char *ifname); 1919 1920 /** 1921 * set_sta_vlan - Bind a station into a specific interface (AP only) 1922 * @priv: Private driver interface data 1923 * @ifname: Interface (main or virtual BSS or VLAN) 1924 * @addr: MAC address of the associated station 1925 * @vlan_id: VLAN ID 1926 * Returns: 0 on success, -1 on failure 1927 * 1928 * This function is used to bind a station to a specific virtual 1929 * interface. It is only used if when virtual interfaces are supported, 1930 * e.g., to assign stations to different VLAN interfaces based on 1931 * information from a RADIUS server. This allows separate broadcast 1932 * domains to be used with a single BSS. 1933 */ 1934 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname, 1935 int vlan_id); 1936 1937 /** 1938 * commit - Optional commit changes handler (AP only) 1939 * @priv: driver private data 1940 * Returns: 0 on success, -1 on failure 1941 * 1942 * This optional handler function can be registered if the driver 1943 * interface implementation needs to commit changes (e.g., by setting 1944 * network interface up) at the end of initial configuration. If set, 1945 * this handler will be called after initial setup has been completed. 1946 */ 1947 int (*commit)(void *priv); 1948 1949 /** 1950 * send_ether - Send an ethernet packet (AP only) 1951 * @priv: private driver interface data 1952 * @dst: Destination MAC address 1953 * @src: Source MAC address 1954 * @proto: Ethertype 1955 * @data: EAPOL packet starting with IEEE 802.1X header 1956 * @data_len: Length of the EAPOL packet in octets 1957 * Returns: 0 on success, -1 on failure 1958 */ 1959 int (*send_ether)(void *priv, const u8 *dst, const u8 *src, u16 proto, 1960 const u8 *data, size_t data_len); 1961 1962 /** 1963 * set_radius_acl_auth - Notification of RADIUS ACL change 1964 * @priv: Private driver interface data 1965 * @mac: MAC address of the station 1966 * @accepted: Whether the station was accepted 1967 * @session_timeout: Session timeout for the station 1968 * Returns: 0 on success, -1 on failure 1969 */ 1970 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted, 1971 u32 session_timeout); 1972 1973 /** 1974 * set_radius_acl_expire - Notification of RADIUS ACL expiration 1975 * @priv: Private driver interface data 1976 * @mac: MAC address of the station 1977 * Returns: 0 on success, -1 on failure 1978 */ 1979 int (*set_radius_acl_expire)(void *priv, const u8 *mac); 1980 1981 /** 1982 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP) 1983 * @priv: Private driver interface data 1984 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s) 1985 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove 1986 * extra IE(s) 1987 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL 1988 * to remove extra IE(s) 1989 * Returns: 0 on success, -1 on failure 1990 * 1991 * This is an optional function to add WPS IE in the kernel driver for 1992 * Beacon and Probe Response frames. This can be left undefined (set 1993 * to %NULL) if the driver uses the Beacon template from set_ap() 1994 * and does not process Probe Request frames. If the driver takes care 1995 * of (Re)Association frame processing, the assocresp buffer includes 1996 * WPS IE(s) that need to be added to (Re)Association Response frames 1997 * whenever a (Re)Association Request frame indicated use of WPS. 1998 * 1999 * This will also be used to add P2P IE(s) into Beacon/Probe Response 2000 * frames when operating as a GO. The driver is responsible for adding 2001 * timing related attributes (e.g., NoA) in addition to the IEs 2002 * included here by appending them after these buffers. This call is 2003 * also used to provide Probe Response IEs for P2P Listen state 2004 * operations for drivers that generate the Probe Response frames 2005 * internally. 2006 * 2007 * DEPRECATED - use set_ap() instead 2008 */ 2009 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon, 2010 const struct wpabuf *proberesp, 2011 const struct wpabuf *assocresp); 2012 2013 /** 2014 * set_supp_port - Set IEEE 802.1X Supplicant Port status 2015 * @priv: Private driver interface data 2016 * @authorized: Whether the port is authorized 2017 * Returns: 0 on success, -1 on failure 2018 */ 2019 int (*set_supp_port)(void *priv, int authorized); 2020 2021 /** 2022 * set_wds_sta - Bind a station into a 4-address WDS (AP only) 2023 * @priv: Private driver interface data 2024 * @addr: MAC address of the associated station 2025 * @aid: Association ID 2026 * @val: 1 = bind to 4-address WDS; 0 = unbind 2027 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL 2028 * to indicate that bridge is not to be used 2029 * Returns: 0 on success, -1 on failure 2030 */ 2031 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val, 2032 const char *bridge_ifname); 2033 2034 /** 2035 * send_action - Transmit an Action frame 2036 * @priv: Private driver interface data 2037 * @freq: Frequency (in MHz) of the channel 2038 * @wait: Time to wait off-channel for a response (in ms), or zero 2039 * @dst: Destination MAC address (Address 1) 2040 * @src: Source MAC address (Address 2) 2041 * @bssid: BSSID (Address 3) 2042 * @data: Frame body 2043 * @data_len: data length in octets 2044 @ @no_cck: Whether CCK rates must not be used to transmit this frame 2045 * Returns: 0 on success, -1 on failure 2046 * 2047 * This command can be used to request the driver to transmit an action 2048 * frame to the specified destination. 2049 * 2050 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will 2051 * be transmitted on the given channel and the device will wait for a 2052 * response on that channel for the given wait time. 2053 * 2054 * If the flag is not set, the wait time will be ignored. In this case, 2055 * if a remain-on-channel duration is in progress, the frame must be 2056 * transmitted on that channel; alternatively the frame may be sent on 2057 * the current operational channel (if in associated state in station 2058 * mode or while operating as an AP.) 2059 */ 2060 int (*send_action)(void *priv, unsigned int freq, unsigned int wait, 2061 const u8 *dst, const u8 *src, const u8 *bssid, 2062 const u8 *data, size_t data_len, int no_cck); 2063 2064 /** 2065 * send_action_cancel_wait - Cancel action frame TX wait 2066 * @priv: Private driver interface data 2067 * 2068 * This command cancels the wait time associated with sending an action 2069 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is 2070 * set in the driver flags. 2071 */ 2072 void (*send_action_cancel_wait)(void *priv); 2073 2074 /** 2075 * remain_on_channel - Remain awake on a channel 2076 * @priv: Private driver interface data 2077 * @freq: Frequency (in MHz) of the channel 2078 * @duration: Duration in milliseconds 2079 * Returns: 0 on success, -1 on failure 2080 * 2081 * This command is used to request the driver to remain awake on the 2082 * specified channel for the specified duration and report received 2083 * Action frames with EVENT_RX_ACTION events. Optionally, received 2084 * Probe Request frames may also be requested to be reported by calling 2085 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ. 2086 * 2087 * The driver may not be at the requested channel when this function 2088 * returns, i.e., the return code is only indicating whether the 2089 * request was accepted. The caller will need to wait until the 2090 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has 2091 * completed the channel change. This may take some time due to other 2092 * need for the radio and the caller should be prepared to timing out 2093 * its wait since there are no guarantees on when this request can be 2094 * executed. 2095 */ 2096 int (*remain_on_channel)(void *priv, unsigned int freq, 2097 unsigned int duration); 2098 2099 /** 2100 * cancel_remain_on_channel - Cancel remain-on-channel operation 2101 * @priv: Private driver interface data 2102 * 2103 * This command can be used to cancel a remain-on-channel operation 2104 * before its originally requested duration has passed. This could be 2105 * used, e.g., when remain_on_channel() is used to request extra time 2106 * to receive a response to an Action frame and the response is 2107 * received when there is still unneeded time remaining on the 2108 * remain-on-channel operation. 2109 */ 2110 int (*cancel_remain_on_channel)(void *priv); 2111 2112 /** 2113 * probe_req_report - Request Probe Request frames to be indicated 2114 * @priv: Private driver interface data 2115 * @report: Whether to report received Probe Request frames 2116 * Returns: 0 on success, -1 on failure (or if not supported) 2117 * 2118 * This command can be used to request the driver to indicate when 2119 * Probe Request frames are received with EVENT_RX_PROBE_REQ events. 2120 * Since this operation may require extra resources, e.g., due to less 2121 * optimal hardware/firmware RX filtering, many drivers may disable 2122 * Probe Request reporting at least in station mode. This command is 2123 * used to notify the driver when the Probe Request frames need to be 2124 * reported, e.g., during remain-on-channel operations. 2125 */ 2126 int (*probe_req_report)(void *priv, int report); 2127 2128 /** 2129 * deinit_ap - Deinitialize AP mode 2130 * @priv: Private driver interface data 2131 * Returns: 0 on success, -1 on failure (or if not supported) 2132 * 2133 * This optional function can be used to disable AP mode related 2134 * configuration and change the driver mode to station mode to allow 2135 * normal station operations like scanning to be completed. 2136 */ 2137 int (*deinit_ap)(void *priv); 2138 2139 /** 2140 * deinit_p2p_cli - Deinitialize P2P client mode 2141 * @priv: Private driver interface data 2142 * Returns: 0 on success, -1 on failure (or if not supported) 2143 * 2144 * This optional function can be used to disable P2P client mode. It 2145 * can be used to change the interface type back to station mode. 2146 */ 2147 int (*deinit_p2p_cli)(void *priv); 2148 2149 /** 2150 * suspend - Notification on system suspend/hibernate event 2151 * @priv: Private driver interface data 2152 */ 2153 void (*suspend)(void *priv); 2154 2155 /** 2156 * resume - Notification on system resume/thaw event 2157 * @priv: Private driver interface data 2158 */ 2159 void (*resume)(void *priv); 2160 2161 /** 2162 * signal_monitor - Set signal monitoring parameters 2163 * @priv: Private driver interface data 2164 * @threshold: Threshold value for signal change events; 0 = disabled 2165 * @hysteresis: Minimum change in signal strength before indicating a 2166 * new event 2167 * Returns: 0 on success, -1 on failure (or if not supported) 2168 * 2169 * This function can be used to configure monitoring of signal strength 2170 * with the current AP. Whenever signal strength drops below the 2171 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event 2172 * should be generated assuming the signal strength has changed at 2173 * least %hysteresis from the previously indicated signal change event. 2174 */ 2175 int (*signal_monitor)(void *priv, int threshold, int hysteresis); 2176 2177 /** 2178 * send_frame - Send IEEE 802.11 frame (testing use only) 2179 * @priv: Private driver interface data 2180 * @data: IEEE 802.11 frame with IEEE 802.11 header 2181 * @data_len: Size of the frame 2182 * @encrypt: Whether to encrypt the frame (if keys are set) 2183 * Returns: 0 on success, -1 on failure 2184 * 2185 * This function is only used for debugging purposes and is not 2186 * required to be implemented for normal operations. 2187 */ 2188 int (*send_frame)(void *priv, const u8 *data, size_t data_len, 2189 int encrypt); 2190 2191 /** 2192 * shared_freq - Get operating frequency of shared interface(s) 2193 * @priv: Private driver interface data 2194 * Returns: Operating frequency in MHz, 0 if no shared operation in 2195 * use, or -1 on failure 2196 * 2197 * This command can be used to request the current operating frequency 2198 * of any virtual interface that shares the same radio to provide 2199 * information for channel selection for other virtual interfaces. 2200 */ 2201 int (*shared_freq)(void *priv); 2202 2203 /** 2204 * get_noa - Get current Notice of Absence attribute payload 2205 * @priv: Private driver interface data 2206 * @buf: Buffer for returning NoA 2207 * @buf_len: Buffer length in octets 2208 * Returns: Number of octets used in buf, 0 to indicate no NoA is being 2209 * advertized, or -1 on failure 2210 * 2211 * This function is used to fetch the current Notice of Absence 2212 * attribute value from GO. 2213 */ 2214 int (*get_noa)(void *priv, u8 *buf, size_t buf_len); 2215 2216 /** 2217 * set_noa - Set Notice of Absence parameters for GO (testing) 2218 * @priv: Private driver interface data 2219 * @count: Count 2220 * @start: Start time in ms from next TBTT 2221 * @duration: Duration in ms 2222 * Returns: 0 on success or -1 on failure 2223 * 2224 * This function is used to set Notice of Absence parameters for GO. It 2225 * is used only for testing. To disable NoA, all parameters are set to 2226 * 0. 2227 */ 2228 int (*set_noa)(void *priv, u8 count, int start, int duration); 2229 2230 /** 2231 * set_p2p_powersave - Set P2P power save options 2232 * @priv: Private driver interface data 2233 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change 2234 * @opp_ps: 0 = disable, 1 = enable, -1 = no change 2235 * @ctwindow: 0.. = change (msec), -1 = no change 2236 * Returns: 0 on success or -1 on failure 2237 */ 2238 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps, 2239 int ctwindow); 2240 2241 /** 2242 * ampdu - Enable/disable aggregation 2243 * @priv: Private driver interface data 2244 * @ampdu: 1/0 = enable/disable A-MPDU aggregation 2245 * Returns: 0 on success or -1 on failure 2246 */ 2247 int (*ampdu)(void *priv, int ampdu); 2248 2249 /** 2250 * get_radio_name - Get physical radio name for the device 2251 * @priv: Private driver interface data 2252 * Returns: Radio name or %NULL if not known 2253 * 2254 * The returned data must not be modified by the caller. It is assumed 2255 * that any interface that has the same radio name as another is 2256 * sharing the same physical radio. This information can be used to 2257 * share scan results etc. information between the virtual interfaces 2258 * to speed up various operations. 2259 */ 2260 const char * (*get_radio_name)(void *priv); 2261 2262 /** 2263 * p2p_find - Start P2P Device Discovery 2264 * @priv: Private driver interface data 2265 * @timeout: Timeout for find operation in seconds or 0 for no timeout 2266 * @type: Device Discovery type (enum p2p_discovery_type) 2267 * Returns: 0 on success, -1 on failure 2268 * 2269 * This function is only used if the driver implements P2P management, 2270 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2271 * struct wpa_driver_capa. 2272 */ 2273 int (*p2p_find)(void *priv, unsigned int timeout, int type); 2274 2275 /** 2276 * p2p_stop_find - Stop P2P Device Discovery 2277 * @priv: Private driver interface data 2278 * Returns: 0 on success, -1 on failure 2279 * 2280 * This function is only used if the driver implements P2P management, 2281 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2282 * struct wpa_driver_capa. 2283 */ 2284 int (*p2p_stop_find)(void *priv); 2285 2286 /** 2287 * p2p_listen - Start P2P Listen state for specified duration 2288 * @priv: Private driver interface data 2289 * @timeout: Listen state duration in milliseconds 2290 * Returns: 0 on success, -1 on failure 2291 * 2292 * This function can be used to request the P2P module to keep the 2293 * device discoverable on the listen channel for an extended set of 2294 * time. At least in its current form, this is mainly used for testing 2295 * purposes and may not be of much use for normal P2P operations. 2296 * 2297 * This function is only used if the driver implements P2P management, 2298 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2299 * struct wpa_driver_capa. 2300 */ 2301 int (*p2p_listen)(void *priv, unsigned int timeout); 2302 2303 /** 2304 * p2p_connect - Start P2P group formation (GO negotiation) 2305 * @priv: Private driver interface data 2306 * @peer_addr: MAC address of the peer P2P client 2307 * @wps_method: enum p2p_wps_method value indicating config method 2308 * @go_intent: Local GO intent value (1..15) 2309 * @own_interface_addr: Intended interface address to use with the 2310 * group 2311 * @force_freq: The only allowed channel frequency in MHz or 0 2312 * @persistent_group: Whether to create persistent group 2313 * Returns: 0 on success, -1 on failure 2314 * 2315 * This function is only used if the driver implements P2P management, 2316 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2317 * struct wpa_driver_capa. 2318 */ 2319 int (*p2p_connect)(void *priv, const u8 *peer_addr, int wps_method, 2320 int go_intent, const u8 *own_interface_addr, 2321 unsigned int force_freq, int persistent_group); 2322 2323 /** 2324 * wps_success_cb - Report successfully completed WPS provisioning 2325 * @priv: Private driver interface data 2326 * @peer_addr: Peer address 2327 * Returns: 0 on success, -1 on failure 2328 * 2329 * This function is used to report successfully completed WPS 2330 * provisioning during group formation in both GO/Registrar and 2331 * client/Enrollee roles. 2332 * 2333 * This function is only used if the driver implements P2P management, 2334 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2335 * struct wpa_driver_capa. 2336 */ 2337 int (*wps_success_cb)(void *priv, const u8 *peer_addr); 2338 2339 /** 2340 * p2p_group_formation_failed - Report failed WPS provisioning 2341 * @priv: Private driver interface data 2342 * Returns: 0 on success, -1 on failure 2343 * 2344 * This function is used to report failed group formation. This can 2345 * happen either due to failed WPS provisioning or due to 15 second 2346 * timeout during the provisioning phase. 2347 * 2348 * This function is only used if the driver implements P2P management, 2349 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2350 * struct wpa_driver_capa. 2351 */ 2352 int (*p2p_group_formation_failed)(void *priv); 2353 2354 /** 2355 * p2p_set_params - Set P2P parameters 2356 * @priv: Private driver interface data 2357 * @params: P2P parameters 2358 * Returns: 0 on success, -1 on failure 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_set_params)(void *priv, const struct p2p_params *params); 2365 2366 /** 2367 * p2p_prov_disc_req - Send Provision Discovery Request 2368 * @priv: Private driver interface data 2369 * @peer_addr: MAC address of the peer P2P client 2370 * @config_methods: WPS Config Methods value (only one bit set) 2371 * Returns: 0 on success, -1 on failure 2372 * 2373 * This function can be used to request a discovered P2P peer to 2374 * display a PIN (config_methods = WPS_CONFIG_DISPLAY) or be prepared 2375 * to enter a PIN from us (config_methods = WPS_CONFIG_KEYPAD). The 2376 * Provision Discovery Request frame is transmitted once immediately 2377 * and if no response is received, the frame will be sent again 2378 * whenever the target device is discovered during device dsicovery 2379 * (start with a p2p_find() call). Response from the peer is indicated 2380 * with the EVENT_P2P_PROV_DISC_RESPONSE event. 2381 * 2382 * This function is only used if the driver implements P2P management, 2383 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2384 * struct wpa_driver_capa. 2385 */ 2386 int (*p2p_prov_disc_req)(void *priv, const u8 *peer_addr, 2387 u16 config_methods, int join); 2388 2389 /** 2390 * p2p_sd_request - Schedule a service discovery query 2391 * @priv: Private driver interface data 2392 * @dst: Destination peer or %NULL to apply for all peers 2393 * @tlvs: P2P Service Query TLV(s) 2394 * Returns: Reference to the query or 0 on failure 2395 * 2396 * Response to the query is indicated with the 2397 * EVENT_P2P_SD_RESPONSE driver event. 2398 * 2399 * This function is only used if the driver implements P2P management, 2400 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2401 * struct wpa_driver_capa. 2402 */ 2403 u64 (*p2p_sd_request)(void *priv, const u8 *dst, 2404 const struct wpabuf *tlvs); 2405 2406 /** 2407 * p2p_sd_cancel_request - Cancel a pending service discovery query 2408 * @priv: Private driver interface data 2409 * @req: Query reference from p2p_sd_request() 2410 * Returns: 0 on success, -1 on failure 2411 * 2412 * This function is only used if the driver implements P2P management, 2413 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2414 * struct wpa_driver_capa. 2415 */ 2416 int (*p2p_sd_cancel_request)(void *priv, u64 req); 2417 2418 /** 2419 * p2p_sd_response - Send response to a service discovery query 2420 * @priv: Private driver interface data 2421 * @freq: Frequency from EVENT_P2P_SD_REQUEST event 2422 * @dst: Destination address from EVENT_P2P_SD_REQUEST event 2423 * @dialog_token: Dialog token from EVENT_P2P_SD_REQUEST event 2424 * @resp_tlvs: P2P Service Response TLV(s) 2425 * Returns: 0 on success, -1 on failure 2426 * 2427 * This function is called as a response to the request indicated with 2428 * the EVENT_P2P_SD_REQUEST driver event. 2429 * 2430 * This function is only used if the driver implements P2P management, 2431 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2432 * struct wpa_driver_capa. 2433 */ 2434 int (*p2p_sd_response)(void *priv, int freq, const u8 *dst, 2435 u8 dialog_token, 2436 const struct wpabuf *resp_tlvs); 2437 2438 /** 2439 * p2p_service_update - Indicate a change in local services 2440 * @priv: Private driver interface data 2441 * Returns: 0 on success, -1 on failure 2442 * 2443 * This function needs to be called whenever there is a change in 2444 * availability of the local services. This will increment the 2445 * Service Update Indicator value which will be used in SD Request and 2446 * Response frames. 2447 * 2448 * This function is only used if the driver implements P2P management, 2449 * i.e., if it sets WPA_DRIVER_FLAGS_P2P_MGMT in 2450 * struct wpa_driver_capa. 2451 */ 2452 int (*p2p_service_update)(void *priv); 2453 2454 /** 2455 * p2p_reject - Reject peer device (explicitly block connections) 2456 * @priv: Private driver interface data 2457 * @addr: MAC address of the peer 2458 * Returns: 0 on success, -1 on failure 2459 */ 2460 int (*p2p_reject)(void *priv, const u8 *addr); 2461 2462 /** 2463 * p2p_invite - Invite a P2P Device into a group 2464 * @priv: Private driver interface data 2465 * @peer: Device Address of the peer P2P Device 2466 * @role: Local role in the group 2467 * @bssid: Group BSSID or %NULL if not known 2468 * @ssid: Group SSID 2469 * @ssid_len: Length of ssid in octets 2470 * @go_dev_addr: Forced GO Device Address or %NULL if none 2471 * @persistent_group: Whether this is to reinvoke a persistent group 2472 * Returns: 0 on success, -1 on failure 2473 */ 2474 int (*p2p_invite)(void *priv, const u8 *peer, int role, 2475 const u8 *bssid, const u8 *ssid, size_t ssid_len, 2476 const u8 *go_dev_addr, int persistent_group); 2477 2478 /** 2479 * send_tdls_mgmt - for sending TDLS management packets 2480 * @priv: private driver interface data 2481 * @dst: Destination (peer) MAC address 2482 * @action_code: TDLS action code for the mssage 2483 * @dialog_token: Dialog Token to use in the message (if needed) 2484 * @status_code: Status Code or Reason Code to use (if needed) 2485 * @buf: TDLS IEs to add to the message 2486 * @len: Length of buf in octets 2487 * Returns: 0 on success, negative (<0) on failure 2488 * 2489 * This optional function can be used to send packet to driver which is 2490 * responsible for receiving and sending all TDLS packets. 2491 */ 2492 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code, 2493 u8 dialog_token, u16 status_code, 2494 const u8 *buf, size_t len); 2495 2496 /** 2497 * tdls_oper - Ask the driver to perform high-level TDLS operations 2498 * @priv: Private driver interface data 2499 * @oper: TDLS high-level operation. See %enum tdls_oper 2500 * @peer: Destination (peer) MAC address 2501 * Returns: 0 on success, negative (<0) on failure 2502 * 2503 * This optional function can be used to send high-level TDLS commands 2504 * to the driver. 2505 */ 2506 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer); 2507 2508 /** 2509 * wnm_oper - Notify driver of the WNM frame reception 2510 * @priv: Private driver interface data 2511 * @oper: WNM operation. See %enum wnm_oper 2512 * @peer: Destination (peer) MAC address 2513 * @buf: Buffer for the driver to fill in (for getting IE) 2514 * @buf_len: Return the len of buf 2515 * Returns: 0 on success, negative (<0) on failure 2516 */ 2517 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer, 2518 u8 *buf, u16 *buf_len); 2519 2520 /** 2521 * signal_poll - Get current connection information 2522 * @priv: Private driver interface data 2523 * @signal_info: Connection info structure 2524 */ 2525 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info); 2526 2527 /** 2528 * set_authmode - Set authentication algorithm(s) for static WEP 2529 * @priv: Private driver interface data 2530 * @authmode: 1=Open System, 2=Shared Key, 3=both 2531 * Returns: 0 on success, -1 on failure 2532 * 2533 * This function can be used to set authentication algorithms for AP 2534 * mode when static WEP is used. If the driver uses user space MLME/SME 2535 * implementation, there is no need to implement this function. 2536 * 2537 * DEPRECATED - use set_ap() instead 2538 */ 2539 int (*set_authmode)(void *priv, int authmode); 2540#ifdef ANDROID 2541 /** 2542 * driver_cmd - execute driver-specific command 2543 * @priv: private driver interface data 2544 * @cmd: command to execute 2545 * @buf: return buffer 2546 * @buf_len: buffer length 2547 * 2548 * Returns: 0 on success, -1 on failure 2549 */ 2550 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len); 2551#endif 2552 /** 2553 * set_rekey_info - Set rekey information 2554 * @priv: Private driver interface data 2555 * @kek: Current KEK 2556 * @kck: Current KCK 2557 * @replay_ctr: Current EAPOL-Key Replay Counter 2558 * 2559 * This optional function can be used to provide information for the 2560 * driver/firmware to process EAPOL-Key frames in Group Key Handshake 2561 * while the host (including wpa_supplicant) is sleeping. 2562 */ 2563 void (*set_rekey_info)(void *priv, const u8 *kek, const u8 *kck, 2564 const u8 *replay_ctr); 2565 2566 /** 2567 * sta_assoc - Station association indication 2568 * @priv: Private driver interface data 2569 * @own_addr: Source address and BSSID for association frame 2570 * @addr: MAC address of the station to associate 2571 * @reassoc: flag to indicate re-association 2572 * @status: association response status code 2573 * @ie: assoc response ie buffer 2574 * @len: ie buffer length 2575 * Returns: 0 on success, -1 on failure 2576 * 2577 * This function indicates the driver to send (Re)Association 2578 * Response frame to the station. 2579 */ 2580 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr, 2581 int reassoc, u16 status, const u8 *ie, size_t len); 2582 2583 /** 2584 * sta_auth - Station authentication indication 2585 * @priv: Private driver interface data 2586 * @own_addr: Source address and BSSID for authentication frame 2587 * @addr: MAC address of the station to associate 2588 * @seq: authentication sequence number 2589 * @status: authentication response status code 2590 * @ie: authentication frame ie buffer 2591 * @len: ie buffer length 2592 * 2593 * This function indicates the driver to send Authentication frame 2594 * to the station. 2595 */ 2596 int (*sta_auth)(void *priv, const u8 *own_addr, const u8 *addr, 2597 u16 seq, u16 status, const u8 *ie, size_t len); 2598 2599 /** 2600 * add_tspec - Add traffic stream 2601 * @priv: Private driver interface data 2602 * @addr: MAC address of the station to associate 2603 * @tspec_ie: tspec ie buffer 2604 * @tspec_ielen: tspec ie length 2605 * Returns: 0 on success, -1 on failure 2606 * 2607 * This function adds the traffic steam for the station 2608 * and fills the medium_time in tspec_ie. 2609 */ 2610 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie, 2611 size_t tspec_ielen); 2612 2613 /** 2614 * add_sta_node - Add a station node in the driver 2615 * @priv: Private driver interface data 2616 * @addr: MAC address of the station to add 2617 * @auth_alg: authentication algorithm used by the station 2618 * Returns: 0 on success, -1 on failure 2619 * 2620 * This function adds the station node in the driver, when 2621 * the station gets added by FT-over-DS. 2622 */ 2623 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg); 2624 2625 /** 2626 * sched_scan - Request the driver to initiate scheduled scan 2627 * @priv: Private driver interface data 2628 * @params: Scan parameters 2629 * @interval: Interval between scan cycles in milliseconds 2630 * Returns: 0 on success, -1 on failure 2631 * 2632 * This operation should be used for scheduled scan offload to 2633 * the hardware. Every time scan results are available, the 2634 * driver should report scan results event for wpa_supplicant 2635 * which will eventually request the results with 2636 * wpa_driver_get_scan_results2(). This operation is optional 2637 * and if not provided or if it returns -1, we fall back to 2638 * normal host-scheduled scans. 2639 */ 2640 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params, 2641 u32 interval); 2642 2643 /** 2644 * stop_sched_scan - Request the driver to stop a scheduled scan 2645 * @priv: Private driver interface data 2646 * Returns: 0 on success, -1 on failure 2647 * 2648 * This should cause the scheduled scan to be stopped and 2649 * results should stop being sent. Must be supported if 2650 * sched_scan is supported. 2651 */ 2652 int (*stop_sched_scan)(void *priv); 2653 2654 /** 2655 * poll_client - Probe (null data or such) the given station 2656 * @priv: Private driver interface data 2657 * @own_addr: MAC address of sending interface 2658 * @addr: MAC address of the station to probe 2659 * @qos: Indicates whether station is QoS station 2660 * 2661 * This function is used to verify whether an associated station is 2662 * still present. This function does not need to be implemented if the 2663 * driver provides such inactivity polling mechanism. 2664 */ 2665 void (*poll_client)(void *priv, const u8 *own_addr, 2666 const u8 *addr, int qos); 2667 2668 /** 2669 * radio_disable - Disable/enable radio 2670 * @priv: Private driver interface data 2671 * @disabled: 1=disable 0=enable radio 2672 * Returns: 0 on success, -1 on failure 2673 * 2674 * This optional command is for testing purposes. It can be used to 2675 * disable the radio on a testbed device to simulate out-of-radio-range 2676 * conditions. 2677 */ 2678 int (*radio_disable)(void *priv, int disabled); 2679 2680 /** 2681 * switch_channel - Announce channel switch and migrate the GO to the 2682 * given frequency 2683 * @priv: Private driver interface data 2684 * @freq: Frequency in MHz 2685 * Returns: 0 on success, -1 on failure 2686 * 2687 * This function is used to move the GO to the legacy STA channel to 2688 * avoid frequency conflict in single channel concurrency. 2689 */ 2690 int (*switch_channel)(void *priv, unsigned int freq); 2691 2692 /** 2693 * start_dfs_cac - Listen for radar interference on the channel 2694 * @priv: Private driver interface data 2695 * @freq: Frequency (in MHz) of the channel 2696 * Returns: 0 on success, -1 on failure 2697 */ 2698 int (*start_dfs_cac)(void *priv, int freq); 2699 2700 /** 2701 * stop_ap - Removes beacon from AP 2702 * @priv: Private driver interface data 2703 * Returns: 0 on success, -1 on failure (or if not supported) 2704 * 2705 * This optional function can be used to disable AP mode related 2706 * configuration. Unlike deinit_ap, it does not change to station 2707 * mode. 2708 */ 2709 int (*stop_ap)(void *priv); 2710}; 2711 2712 2713/** 2714 * enum wpa_event_type - Event type for wpa_supplicant_event() calls 2715 */ 2716enum wpa_event_type { 2717 /** 2718 * EVENT_ASSOC - Association completed 2719 * 2720 * This event needs to be delivered when the driver completes IEEE 2721 * 802.11 association or reassociation successfully. 2722 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID 2723 * after this event has been generated. In addition, optional 2724 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide 2725 * more information about the association. If the driver interface gets 2726 * both of these events at the same time, it can also include the 2727 * assoc_info data in EVENT_ASSOC call. 2728 */ 2729 EVENT_ASSOC, 2730 2731 /** 2732 * EVENT_DISASSOC - Association lost 2733 * 2734 * This event should be called when association is lost either due to 2735 * receiving deauthenticate or disassociate frame from the AP or when 2736 * sending either of these frames to the current AP. If the driver 2737 * supports separate deauthentication event, EVENT_DISASSOC should only 2738 * be used for disassociation and EVENT_DEAUTH for deauthentication. 2739 * In AP mode, union wpa_event_data::disassoc_info is required. 2740 */ 2741 EVENT_DISASSOC, 2742 2743 /** 2744 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected 2745 * 2746 * This event must be delivered when a Michael MIC error is detected by 2747 * the local driver. Additional data for event processing is 2748 * provided with union wpa_event_data::michael_mic_failure. This 2749 * information is used to request new encyption key and to initiate 2750 * TKIP countermeasures if needed. 2751 */ 2752 EVENT_MICHAEL_MIC_FAILURE, 2753 2754 /** 2755 * EVENT_SCAN_RESULTS - Scan results available 2756 * 2757 * This event must be called whenever scan results are available to be 2758 * fetched with struct wpa_driver_ops::get_scan_results(). This event 2759 * is expected to be used some time after struct wpa_driver_ops::scan() 2760 * is called. If the driver provides an unsolicited event when the scan 2761 * has been completed, this event can be used to trigger 2762 * EVENT_SCAN_RESULTS call. If such event is not available from the 2763 * driver, the driver wrapper code is expected to use a registered 2764 * timeout to generate EVENT_SCAN_RESULTS call after the time that the 2765 * scan is expected to be completed. Optional information about 2766 * completed scan can be provided with union wpa_event_data::scan_info. 2767 */ 2768 EVENT_SCAN_RESULTS, 2769 2770 /** 2771 * EVENT_ASSOCINFO - Report optional extra information for association 2772 * 2773 * This event can be used to report extra association information for 2774 * EVENT_ASSOC processing. This extra information includes IEs from 2775 * association frames and Beacon/Probe Response frames in union 2776 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before 2777 * EVENT_ASSOC. Alternatively, the driver interface can include 2778 * assoc_info data in the EVENT_ASSOC call if it has all the 2779 * information available at the same point. 2780 */ 2781 EVENT_ASSOCINFO, 2782 2783 /** 2784 * EVENT_INTERFACE_STATUS - Report interface status changes 2785 * 2786 * This optional event can be used to report changes in interface 2787 * status (interface added/removed) using union 2788 * wpa_event_data::interface_status. This can be used to trigger 2789 * wpa_supplicant to stop and re-start processing for the interface, 2790 * e.g., when a cardbus card is ejected/inserted. 2791 */ 2792 EVENT_INTERFACE_STATUS, 2793 2794 /** 2795 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication 2796 * 2797 * This event can be used to inform wpa_supplicant about candidates for 2798 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible 2799 * for scan request (ap_scan=2 mode), this event is required for 2800 * pre-authentication. If wpa_supplicant is performing scan request 2801 * (ap_scan=1), this event is optional since scan results can be used 2802 * to add pre-authentication candidates. union 2803 * wpa_event_data::pmkid_candidate is used to report the BSSID of the 2804 * candidate and priority of the candidate, e.g., based on the signal 2805 * strength, in order to try to pre-authenticate first with candidates 2806 * that are most likely targets for re-association. 2807 * 2808 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates 2809 * on the candidate list. In addition, it can be called for the current 2810 * AP and APs that have existing PMKSA cache entries. wpa_supplicant 2811 * will automatically skip pre-authentication in cases where a valid 2812 * PMKSA exists. When more than one candidate exists, this event should 2813 * be generated once for each candidate. 2814 * 2815 * Driver will be notified about successful pre-authentication with 2816 * struct wpa_driver_ops::add_pmkid() calls. 2817 */ 2818 EVENT_PMKID_CANDIDATE, 2819 2820 /** 2821 * EVENT_STKSTART - Request STK handshake (MLME-STKSTART.request) 2822 * 2823 * This event can be used to inform wpa_supplicant about desire to set 2824 * up secure direct link connection between two stations as defined in 2825 * IEEE 802.11e with a new PeerKey mechanism that replaced the original 2826 * STAKey negotiation. The caller will need to set peer address for the 2827 * event. 2828 */ 2829 EVENT_STKSTART, 2830 2831 /** 2832 * EVENT_TDLS - Request TDLS operation 2833 * 2834 * This event can be used to request a TDLS operation to be performed. 2835 */ 2836 EVENT_TDLS, 2837 2838 /** 2839 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs 2840 * 2841 * The driver is expected to report the received FT IEs from 2842 * FT authentication sequence from the AP. The FT IEs are included in 2843 * the extra information in union wpa_event_data::ft_ies. 2844 */ 2845 EVENT_FT_RESPONSE, 2846 2847 /** 2848 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS 2849 * 2850 * The driver can use this event to inform wpa_supplicant about a STA 2851 * in an IBSS with which protected frames could be exchanged. This 2852 * event starts RSN authentication with the other STA to authenticate 2853 * the STA and set up encryption keys with it. 2854 */ 2855 EVENT_IBSS_RSN_START, 2856 2857 /** 2858 * EVENT_AUTH - Authentication result 2859 * 2860 * This event should be called when authentication attempt has been 2861 * completed. This is only used if the driver supports separate 2862 * authentication step (struct wpa_driver_ops::authenticate). 2863 * Information about authentication result is included in 2864 * union wpa_event_data::auth. 2865 */ 2866 EVENT_AUTH, 2867 2868 /** 2869 * EVENT_DEAUTH - Authentication lost 2870 * 2871 * This event should be called when authentication is lost either due 2872 * to receiving deauthenticate frame from the AP or when sending that 2873 * frame to the current AP. 2874 * In AP mode, union wpa_event_data::deauth_info is required. 2875 */ 2876 EVENT_DEAUTH, 2877 2878 /** 2879 * EVENT_ASSOC_REJECT - Association rejected 2880 * 2881 * This event should be called when (re)association attempt has been 2882 * rejected by the AP. Information about the association response is 2883 * included in union wpa_event_data::assoc_reject. 2884 */ 2885 EVENT_ASSOC_REJECT, 2886 2887 /** 2888 * EVENT_AUTH_TIMED_OUT - Authentication timed out 2889 */ 2890 EVENT_AUTH_TIMED_OUT, 2891 2892 /** 2893 * EVENT_ASSOC_TIMED_OUT - Association timed out 2894 */ 2895 EVENT_ASSOC_TIMED_OUT, 2896 2897 /** 2898 * EVENT_FT_RRB_RX - FT (IEEE 802.11r) RRB frame received 2899 */ 2900 EVENT_FT_RRB_RX, 2901 2902 /** 2903 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS 2904 */ 2905 EVENT_WPS_BUTTON_PUSHED, 2906 2907 /** 2908 * EVENT_TX_STATUS - Report TX status 2909 */ 2910 EVENT_TX_STATUS, 2911 2912 /** 2913 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA 2914 */ 2915 EVENT_RX_FROM_UNKNOWN, 2916 2917 /** 2918 * EVENT_RX_MGMT - Report RX of a management frame 2919 */ 2920 EVENT_RX_MGMT, 2921 2922 /** 2923 * EVENT_RX_ACTION - Action frame received 2924 * 2925 * This event is used to indicate when an Action frame has been 2926 * received. Information about the received frame is included in 2927 * union wpa_event_data::rx_action. 2928 */ 2929 EVENT_RX_ACTION, 2930 2931 /** 2932 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started 2933 * 2934 * This event is used to indicate when the driver has started the 2935 * requested remain-on-channel duration. Information about the 2936 * operation is included in union wpa_event_data::remain_on_channel. 2937 */ 2938 EVENT_REMAIN_ON_CHANNEL, 2939 2940 /** 2941 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out 2942 * 2943 * This event is used to indicate when the driver has completed 2944 * remain-on-channel duration, i.e., may noot be available on the 2945 * requested channel anymore. Information about the 2946 * operation is included in union wpa_event_data::remain_on_channel. 2947 */ 2948 EVENT_CANCEL_REMAIN_ON_CHANNEL, 2949 2950 /** 2951 * EVENT_MLME_RX - Report reception of frame for MLME (test use only) 2952 * 2953 * This event is used only by driver_test.c and userspace MLME. 2954 */ 2955 EVENT_MLME_RX, 2956 2957 /** 2958 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame 2959 * 2960 * This event is used to indicate when a Probe Request frame has been 2961 * received. Information about the received frame is included in 2962 * union wpa_event_data::rx_probe_req. The driver is required to report 2963 * these events only after successfully completed probe_req_report() 2964 * commands to request the events (i.e., report parameter is non-zero) 2965 * in station mode. In AP mode, Probe Request frames should always be 2966 * reported. 2967 */ 2968 EVENT_RX_PROBE_REQ, 2969 2970 /** 2971 * EVENT_NEW_STA - New wired device noticed 2972 * 2973 * This event is used to indicate that a new device has been detected 2974 * in a network that does not use association-like functionality (i.e., 2975 * mainly wired Ethernet). This can be used to start EAPOL 2976 * authenticator when receiving a frame from a device. The address of 2977 * the device is included in union wpa_event_data::new_sta. 2978 */ 2979 EVENT_NEW_STA, 2980 2981 /** 2982 * EVENT_EAPOL_RX - Report received EAPOL frame 2983 * 2984 * When in AP mode with hostapd, this event is required to be used to 2985 * deliver the receive EAPOL frames from the driver. With 2986 * %wpa_supplicant, this event is used only if the send_eapol() handler 2987 * is used to override the use of l2_packet for EAPOL frame TX. 2988 */ 2989 EVENT_EAPOL_RX, 2990 2991 /** 2992 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength 2993 * 2994 * This event is used to indicate changes in the signal strength 2995 * observed in frames received from the current AP if signal strength 2996 * monitoring has been enabled with signal_monitor(). 2997 */ 2998 EVENT_SIGNAL_CHANGE, 2999 3000 /** 3001 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled 3002 * 3003 * This event is used to indicate that the interface was enabled after 3004 * having been previously disabled, e.g., due to rfkill. 3005 */ 3006 EVENT_INTERFACE_ENABLED, 3007 3008 /** 3009 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled 3010 * 3011 * This event is used to indicate that the interface was disabled, 3012 * e.g., due to rfkill. 3013 */ 3014 EVENT_INTERFACE_DISABLED, 3015 3016 /** 3017 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed 3018 * 3019 * This event is used to indicate that the channel list has changed, 3020 * e.g., because of a regulatory domain change triggered by scan 3021 * results including an AP advertising a country code. 3022 */ 3023 EVENT_CHANNEL_LIST_CHANGED, 3024 3025 /** 3026 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable 3027 * 3028 * This event is used to indicate that the driver cannot maintain this 3029 * interface in its operation mode anymore. The most likely use for 3030 * this is to indicate that AP mode operation is not available due to 3031 * operating channel would need to be changed to a DFS channel when 3032 * the driver does not support radar detection and another virtual 3033 * interfaces caused the operating channel to change. Other similar 3034 * resource conflicts could also trigger this for station mode 3035 * interfaces. 3036 */ 3037 EVENT_INTERFACE_UNAVAILABLE, 3038 3039 /** 3040 * EVENT_BEST_CHANNEL 3041 * 3042 * Driver generates this event whenever it detects a better channel 3043 * (e.g., based on RSSI or channel use). This information can be used 3044 * to improve channel selection for a new AP/P2P group. 3045 */ 3046 EVENT_BEST_CHANNEL, 3047 3048 /** 3049 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received 3050 * 3051 * This event should be called when a Deauthentication frame is dropped 3052 * due to it not being protected (MFP/IEEE 802.11w). 3053 * union wpa_event_data::unprot_deauth is required to provide more 3054 * details of the frame. 3055 */ 3056 EVENT_UNPROT_DEAUTH, 3057 3058 /** 3059 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received 3060 * 3061 * This event should be called when a Disassociation frame is dropped 3062 * due to it not being protected (MFP/IEEE 802.11w). 3063 * union wpa_event_data::unprot_disassoc is required to provide more 3064 * details of the frame. 3065 */ 3066 EVENT_UNPROT_DISASSOC, 3067 3068 /** 3069 * EVENT_STATION_LOW_ACK 3070 * 3071 * Driver generates this event whenever it detected that a particular 3072 * station was lost. Detection can be through massive transmission 3073 * failures for example. 3074 */ 3075 EVENT_STATION_LOW_ACK, 3076 3077 /** 3078 * EVENT_P2P_DEV_FOUND - Report a discovered P2P device 3079 * 3080 * This event is used only if the driver implements P2P management 3081 * internally. Event data is stored in 3082 * union wpa_event_data::p2p_dev_found. 3083 */ 3084 EVENT_P2P_DEV_FOUND, 3085 3086 /** 3087 * EVENT_P2P_GO_NEG_REQ_RX - Report reception of GO Negotiation Request 3088 * 3089 * This event is used only if the driver implements P2P management 3090 * internally. Event data is stored in 3091 * union wpa_event_data::p2p_go_neg_req_rx. 3092 */ 3093 EVENT_P2P_GO_NEG_REQ_RX, 3094 3095 /** 3096 * EVENT_P2P_GO_NEG_COMPLETED - Report completion of GO Negotiation 3097 * 3098 * This event is used only if the driver implements P2P management 3099 * internally. Event data is stored in 3100 * union wpa_event_data::p2p_go_neg_completed. 3101 */ 3102 EVENT_P2P_GO_NEG_COMPLETED, 3103 3104 EVENT_P2P_PROV_DISC_REQUEST, 3105 EVENT_P2P_PROV_DISC_RESPONSE, 3106 EVENT_P2P_SD_REQUEST, 3107 EVENT_P2P_SD_RESPONSE, 3108 3109 /** 3110 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore 3111 */ 3112 EVENT_IBSS_PEER_LOST, 3113 3114 /** 3115 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey 3116 * 3117 * This event carries the new replay counter to notify wpa_supplicant 3118 * of the current EAPOL-Key Replay Counter in case the driver/firmware 3119 * completed Group Key Handshake while the host (including 3120 * wpa_supplicant was sleeping). 3121 */ 3122 EVENT_DRIVER_GTK_REKEY, 3123 3124 /** 3125 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped 3126 */ 3127 EVENT_SCHED_SCAN_STOPPED, 3128 3129 /** 3130 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll 3131 * 3132 * This event indicates that the station responded to the poll 3133 * initiated with @poll_client. 3134 */ 3135 EVENT_DRIVER_CLIENT_POLL_OK, 3136 3137 /** 3138 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status 3139 */ 3140 EVENT_EAPOL_TX_STATUS, 3141 3142 /** 3143 * EVENT_CH_SWITCH - AP or GO decided to switch channels 3144 * 3145 * Described in wpa_event_data.ch_switch 3146 * */ 3147 EVENT_CH_SWITCH, 3148 3149 /** 3150 * EVENT_WNM - Request WNM operation 3151 * 3152 * This event can be used to request a WNM operation to be performed. 3153 */ 3154 EVENT_WNM, 3155 3156 /** 3157 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode 3158 * 3159 * This event indicates that the driver reported a connection failure 3160 * with the specified client (for example, max client reached, etc.) in 3161 * AP mode. 3162 */ 3163 EVENT_CONNECT_FAILED_REASON, 3164 3165 /** 3166 * EVENT_RADAR_DETECTED - Notify of radar detection 3167 * 3168 * A radar has been detected on the supplied frequency, hostapd should 3169 * react accordingly (e.g., change channel). 3170 */ 3171 EVENT_DFS_RADAR_DETECTED, 3172 3173 /** 3174 * EVENT_CAC_FINISHED - Notify that channel availability check has been completed 3175 * 3176 * After a successful CAC, the channel can be marked clear and used. 3177 */ 3178 EVENT_DFS_CAC_FINISHED, 3179 3180 /** 3181 * EVENT_CAC_ABORTED - Notify that channel availability check has been aborted 3182 * 3183 * The CAC was not successful, and the channel remains in the previous 3184 * state. This may happen due to a radar beeing detected or other 3185 * external influences. 3186 */ 3187 EVENT_DFS_CAC_ABORTED, 3188 3189 /** 3190 * EVENT_DFS_CAC_NOP_FINISHED - Notify that non-occupancy period is over 3191 * 3192 * The channel which was previously unavailable is now available again. 3193 */ 3194 EVENT_DFS_NOP_FINISHED 3195}; 3196 3197 3198/** 3199 * union wpa_event_data - Additional data for wpa_supplicant_event() calls 3200 */ 3201union wpa_event_data { 3202 /** 3203 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events 3204 * 3205 * This structure is optional for EVENT_ASSOC calls and required for 3206 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the 3207 * driver interface does not need to generate separate EVENT_ASSOCINFO 3208 * calls. 3209 */ 3210 struct assoc_info { 3211 /** 3212 * reassoc - Flag to indicate association or reassociation 3213 */ 3214 int reassoc; 3215 3216 /** 3217 * req_ies - (Re)Association Request IEs 3218 * 3219 * If the driver generates WPA/RSN IE, this event data must be 3220 * returned for WPA handshake to have needed information. If 3221 * wpa_supplicant-generated WPA/RSN IE is used, this 3222 * information event is optional. 3223 * 3224 * This should start with the first IE (fixed fields before IEs 3225 * are not included). 3226 */ 3227 const u8 *req_ies; 3228 3229 /** 3230 * req_ies_len - Length of req_ies in bytes 3231 */ 3232 size_t req_ies_len; 3233 3234 /** 3235 * resp_ies - (Re)Association Response IEs 3236 * 3237 * Optional association data from the driver. This data is not 3238 * required WPA, but may be useful for some protocols and as 3239 * such, should be reported if this is available to the driver 3240 * interface. 3241 * 3242 * This should start with the first IE (fixed fields before IEs 3243 * are not included). 3244 */ 3245 const u8 *resp_ies; 3246 3247 /** 3248 * resp_ies_len - Length of resp_ies in bytes 3249 */ 3250 size_t resp_ies_len; 3251 3252 /** 3253 * beacon_ies - Beacon or Probe Response IEs 3254 * 3255 * Optional Beacon/ProbeResp data: IEs included in Beacon or 3256 * Probe Response frames from the current AP (i.e., the one 3257 * that the client just associated with). This information is 3258 * used to update WPA/RSN IE for the AP. If this field is not 3259 * set, the results from previous scan will be used. If no 3260 * data for the new AP is found, scan results will be requested 3261 * again (without scan request). At this point, the driver is 3262 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is 3263 * used). 3264 * 3265 * This should start with the first IE (fixed fields before IEs 3266 * are not included). 3267 */ 3268 const u8 *beacon_ies; 3269 3270 /** 3271 * beacon_ies_len - Length of beacon_ies */ 3272 size_t beacon_ies_len; 3273 3274 /** 3275 * freq - Frequency of the operational channel in MHz 3276 */ 3277 unsigned int freq; 3278 3279 /** 3280 * addr - Station address (for AP mode) 3281 */ 3282 const u8 *addr; 3283 } assoc_info; 3284 3285 /** 3286 * struct disassoc_info - Data for EVENT_DISASSOC events 3287 */ 3288 struct disassoc_info { 3289 /** 3290 * addr - Station address (for AP mode) 3291 */ 3292 const u8 *addr; 3293 3294 /** 3295 * reason_code - Reason Code (host byte order) used in 3296 * Deauthentication frame 3297 */ 3298 u16 reason_code; 3299 3300 /** 3301 * ie - Optional IE(s) in Disassociation frame 3302 */ 3303 const u8 *ie; 3304 3305 /** 3306 * ie_len - Length of ie buffer in octets 3307 */ 3308 size_t ie_len; 3309 3310 /** 3311 * locally_generated - Whether the frame was locally generated 3312 */ 3313 int locally_generated; 3314 } disassoc_info; 3315 3316 /** 3317 * struct deauth_info - Data for EVENT_DEAUTH events 3318 */ 3319 struct deauth_info { 3320 /** 3321 * addr - Station address (for AP mode) 3322 */ 3323 const u8 *addr; 3324 3325 /** 3326 * reason_code - Reason Code (host byte order) used in 3327 * Deauthentication frame 3328 */ 3329 u16 reason_code; 3330 3331 /** 3332 * ie - Optional IE(s) in Deauthentication frame 3333 */ 3334 const u8 *ie; 3335 3336 /** 3337 * ie_len - Length of ie buffer in octets 3338 */ 3339 size_t ie_len; 3340 3341 /** 3342 * locally_generated - Whether the frame was locally generated 3343 */ 3344 int locally_generated; 3345 } deauth_info; 3346 3347 /** 3348 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE 3349 */ 3350 struct michael_mic_failure { 3351 int unicast; 3352 const u8 *src; 3353 } michael_mic_failure; 3354 3355 /** 3356 * struct interface_status - Data for EVENT_INTERFACE_STATUS 3357 */ 3358 struct interface_status { 3359 char ifname[100]; 3360 enum { 3361 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED 3362 } ievent; 3363 } interface_status; 3364 3365 /** 3366 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE 3367 */ 3368 struct pmkid_candidate { 3369 /** BSSID of the PMKID candidate */ 3370 u8 bssid[ETH_ALEN]; 3371 /** Smaller the index, higher the priority */ 3372 int index; 3373 /** Whether RSN IE includes pre-authenticate flag */ 3374 int preauth; 3375 } pmkid_candidate; 3376 3377 /** 3378 * struct stkstart - Data for EVENT_STKSTART 3379 */ 3380 struct stkstart { 3381 u8 peer[ETH_ALEN]; 3382 } stkstart; 3383 3384 /** 3385 * struct tdls - Data for EVENT_TDLS 3386 */ 3387 struct tdls { 3388 u8 peer[ETH_ALEN]; 3389 enum { 3390 TDLS_REQUEST_SETUP, 3391 TDLS_REQUEST_TEARDOWN 3392 } oper; 3393 u16 reason_code; /* for teardown */ 3394 } tdls; 3395 3396 /** 3397 * struct wnm - Data for EVENT_WNM 3398 */ 3399 struct wnm { 3400 u8 addr[ETH_ALEN]; 3401 enum { 3402 WNM_OPER_SLEEP, 3403 } oper; 3404 enum { 3405 WNM_SLEEP_ENTER, 3406 WNM_SLEEP_EXIT 3407 } sleep_action; 3408 int sleep_intval; 3409 u16 reason_code; 3410 u8 *buf; 3411 u16 buf_len; 3412 } wnm; 3413 3414 /** 3415 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE) 3416 * 3417 * During FT (IEEE 802.11r) authentication sequence, the driver is 3418 * expected to use this event to report received FT IEs (MDIE, FTIE, 3419 * RSN IE, TIE, possible resource request) to the supplicant. The FT 3420 * IEs for the next message will be delivered through the 3421 * struct wpa_driver_ops::update_ft_ies() callback. 3422 */ 3423 struct ft_ies { 3424 const u8 *ies; 3425 size_t ies_len; 3426 int ft_action; 3427 u8 target_ap[ETH_ALEN]; 3428 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */ 3429 const u8 *ric_ies; 3430 /** Length of ric_ies buffer in octets */ 3431 size_t ric_ies_len; 3432 } ft_ies; 3433 3434 /** 3435 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START 3436 */ 3437 struct ibss_rsn_start { 3438 u8 peer[ETH_ALEN]; 3439 } ibss_rsn_start; 3440 3441 /** 3442 * struct auth_info - Data for EVENT_AUTH events 3443 */ 3444 struct auth_info { 3445 u8 peer[ETH_ALEN]; 3446 u8 bssid[ETH_ALEN]; 3447 u16 auth_type; 3448 u16 auth_transaction; 3449 u16 status_code; 3450 const u8 *ies; 3451 size_t ies_len; 3452 } auth; 3453 3454 /** 3455 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events 3456 */ 3457 struct assoc_reject { 3458 /** 3459 * bssid - BSSID of the AP that rejected association 3460 */ 3461 const u8 *bssid; 3462 3463 /** 3464 * resp_ies - (Re)Association Response IEs 3465 * 3466 * Optional association data from the driver. This data is not 3467 * required WPA, but may be useful for some protocols and as 3468 * such, should be reported if this is available to the driver 3469 * interface. 3470 * 3471 * This should start with the first IE (fixed fields before IEs 3472 * are not included). 3473 */ 3474 const u8 *resp_ies; 3475 3476 /** 3477 * resp_ies_len - Length of resp_ies in bytes 3478 */ 3479 size_t resp_ies_len; 3480 3481 /** 3482 * status_code - Status Code from (Re)association Response 3483 */ 3484 u16 status_code; 3485 } assoc_reject; 3486 3487 struct timeout_event { 3488 u8 addr[ETH_ALEN]; 3489 } timeout_event; 3490 3491 /** 3492 * struct ft_rrb_rx - Data for EVENT_FT_RRB_RX events 3493 */ 3494 struct ft_rrb_rx { 3495 const u8 *src; 3496 const u8 *data; 3497 size_t data_len; 3498 } ft_rrb_rx; 3499 3500 /** 3501 * struct tx_status - Data for EVENT_TX_STATUS events 3502 */ 3503 struct tx_status { 3504 u16 type; 3505 u16 stype; 3506 const u8 *dst; 3507 const u8 *data; 3508 size_t data_len; 3509 int ack; 3510 } tx_status; 3511 3512 /** 3513 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events 3514 */ 3515 struct rx_from_unknown { 3516 const u8 *bssid; 3517 const u8 *addr; 3518 int wds; 3519 } rx_from_unknown; 3520 3521 /** 3522 * struct rx_mgmt - Data for EVENT_RX_MGMT events 3523 */ 3524 struct rx_mgmt { 3525 const u8 *frame; 3526 size_t frame_len; 3527 u32 datarate; 3528 int ssi_signal; /* dBm */ 3529 } rx_mgmt; 3530 3531 /** 3532 * struct rx_action - Data for EVENT_RX_ACTION events 3533 */ 3534 struct rx_action { 3535 /** 3536 * da - Destination address of the received Action frame 3537 */ 3538 const u8 *da; 3539 3540 /** 3541 * sa - Source address of the received Action frame 3542 */ 3543 const u8 *sa; 3544 3545 /** 3546 * bssid - Address 3 of the received Action frame 3547 */ 3548 const u8 *bssid; 3549 3550 /** 3551 * category - Action frame category 3552 */ 3553 u8 category; 3554 3555 /** 3556 * data - Action frame body after category field 3557 */ 3558 const u8 *data; 3559 3560 /** 3561 * len - Length of data in octets 3562 */ 3563 size_t len; 3564 3565 /** 3566 * freq - Frequency (in MHz) on which the frame was received 3567 */ 3568 int freq; 3569 } rx_action; 3570 3571 /** 3572 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events 3573 * 3574 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events. 3575 */ 3576 struct remain_on_channel { 3577 /** 3578 * freq - Channel frequency in MHz 3579 */ 3580 unsigned int freq; 3581 3582 /** 3583 * duration - Duration to remain on the channel in milliseconds 3584 */ 3585 unsigned int duration; 3586 } remain_on_channel; 3587 3588 /** 3589 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events 3590 * @aborted: Whether the scan was aborted 3591 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned) 3592 * @num_freqs: Number of entries in freqs array 3593 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard 3594 * SSID) 3595 * @num_ssids: Number of entries in ssids array 3596 */ 3597 struct scan_info { 3598 int aborted; 3599 const int *freqs; 3600 size_t num_freqs; 3601 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS]; 3602 size_t num_ssids; 3603 } scan_info; 3604 3605 /** 3606 * struct mlme_rx - Data for EVENT_MLME_RX events 3607 */ 3608 struct mlme_rx { 3609 const u8 *buf; 3610 size_t len; 3611 int freq; 3612 int channel; 3613 int ssi; 3614 } mlme_rx; 3615 3616 /** 3617 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events 3618 */ 3619 struct rx_probe_req { 3620 /** 3621 * sa - Source address of the received Probe Request frame 3622 */ 3623 const u8 *sa; 3624 3625 /** 3626 * da - Destination address of the received Probe Request frame 3627 * or %NULL if not available 3628 */ 3629 const u8 *da; 3630 3631 /** 3632 * bssid - BSSID of the received Probe Request frame or %NULL 3633 * if not available 3634 */ 3635 const u8 *bssid; 3636 3637 /** 3638 * ie - IEs from the Probe Request body 3639 */ 3640 const u8 *ie; 3641 3642 /** 3643 * ie_len - Length of ie buffer in octets 3644 */ 3645 size_t ie_len; 3646 3647 /** 3648 * signal - signal strength in dBm (or 0 if not available) 3649 */ 3650 int ssi_signal; 3651 } rx_probe_req; 3652 3653 /** 3654 * struct new_sta - Data for EVENT_NEW_STA events 3655 */ 3656 struct new_sta { 3657 const u8 *addr; 3658 } new_sta; 3659 3660 /** 3661 * struct eapol_rx - Data for EVENT_EAPOL_RX events 3662 */ 3663 struct eapol_rx { 3664 const u8 *src; 3665 const u8 *data; 3666 size_t data_len; 3667 } eapol_rx; 3668 3669 /** 3670 * signal_change - Data for EVENT_SIGNAL_CHANGE events 3671 */ 3672 struct wpa_signal_info signal_change; 3673 3674 /** 3675 * struct best_channel - Data for EVENT_BEST_CHANNEL events 3676 * @freq_24: Best 2.4 GHz band channel frequency in MHz 3677 * @freq_5: Best 5 GHz band channel frequency in MHz 3678 * @freq_overall: Best channel frequency in MHz 3679 * 3680 * 0 can be used to indicate no preference in either band. 3681 */ 3682 struct best_channel { 3683 int freq_24; 3684 int freq_5; 3685 int freq_overall; 3686 } best_chan; 3687 3688 struct unprot_deauth { 3689 const u8 *sa; 3690 const u8 *da; 3691 u16 reason_code; 3692 } unprot_deauth; 3693 3694 struct unprot_disassoc { 3695 const u8 *sa; 3696 const u8 *da; 3697 u16 reason_code; 3698 } unprot_disassoc; 3699 3700 /** 3701 * struct low_ack - Data for EVENT_STATION_LOW_ACK events 3702 * @addr: station address 3703 */ 3704 struct low_ack { 3705 u8 addr[ETH_ALEN]; 3706 } low_ack; 3707 3708 /** 3709 * struct p2p_dev_found - Data for EVENT_P2P_DEV_FOUND 3710 */ 3711 struct p2p_dev_found { 3712 const u8 *addr; 3713 const u8 *dev_addr; 3714 const u8 *pri_dev_type; 3715 const char *dev_name; 3716 u16 config_methods; 3717 u8 dev_capab; 3718 u8 group_capab; 3719 } p2p_dev_found; 3720 3721 /** 3722 * struct p2p_go_neg_req_rx - Data for EVENT_P2P_GO_NEG_REQ_RX 3723 */ 3724 struct p2p_go_neg_req_rx { 3725 const u8 *src; 3726 u16 dev_passwd_id; 3727 } p2p_go_neg_req_rx; 3728 3729 /** 3730 * struct p2p_go_neg_completed - Data for EVENT_P2P_GO_NEG_COMPLETED 3731 */ 3732 struct p2p_go_neg_completed { 3733 struct p2p_go_neg_results *res; 3734 } p2p_go_neg_completed; 3735 3736 struct p2p_prov_disc_req { 3737 const u8 *peer; 3738 u16 config_methods; 3739 const u8 *dev_addr; 3740 const u8 *pri_dev_type; 3741 const char *dev_name; 3742 u16 supp_config_methods; 3743 u8 dev_capab; 3744 u8 group_capab; 3745 } p2p_prov_disc_req; 3746 3747 struct p2p_prov_disc_resp { 3748 const u8 *peer; 3749 u16 config_methods; 3750 } p2p_prov_disc_resp; 3751 3752 struct p2p_sd_req { 3753 int freq; 3754 const u8 *sa; 3755 u8 dialog_token; 3756 u16 update_indic; 3757 const u8 *tlvs; 3758 size_t tlvs_len; 3759 } p2p_sd_req; 3760 3761 struct p2p_sd_resp { 3762 const u8 *sa; 3763 u16 update_indic; 3764 const u8 *tlvs; 3765 size_t tlvs_len; 3766 } p2p_sd_resp; 3767 3768 /** 3769 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST 3770 */ 3771 struct ibss_peer_lost { 3772 u8 peer[ETH_ALEN]; 3773 } ibss_peer_lost; 3774 3775 /** 3776 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY 3777 */ 3778 struct driver_gtk_rekey { 3779 const u8 *bssid; 3780 const u8 *replay_ctr; 3781 } driver_gtk_rekey; 3782 3783 /** 3784 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events 3785 * @addr: station address 3786 */ 3787 struct client_poll { 3788 u8 addr[ETH_ALEN]; 3789 } client_poll; 3790 3791 /** 3792 * struct eapol_tx_status 3793 * @dst: Original destination 3794 * @data: Data starting with IEEE 802.1X header (!) 3795 * @data_len: Length of data 3796 * @ack: Indicates ack or lost frame 3797 * 3798 * This corresponds to hapd_send_eapol if the frame sent 3799 * there isn't just reported as EVENT_TX_STATUS. 3800 */ 3801 struct eapol_tx_status { 3802 const u8 *dst; 3803 const u8 *data; 3804 int data_len; 3805 int ack; 3806 } eapol_tx_status; 3807 3808 /** 3809 * struct ch_switch 3810 * @freq: Frequency of new channel in MHz 3811 * @ht_enabled: Whether this is an HT channel 3812 * @ch_offset: Secondary channel offset 3813 */ 3814 struct ch_switch { 3815 int freq; 3816 int ht_enabled; 3817 int ch_offset; 3818 } ch_switch; 3819 3820 /** 3821 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON 3822 * @addr: Remote client address 3823 * @code: Reason code for connection failure 3824 */ 3825 struct connect_failed_reason { 3826 u8 addr[ETH_ALEN]; 3827 enum { 3828 MAX_CLIENT_REACHED, 3829 BLOCKED_CLIENT 3830 } code; 3831 } connect_failed_reason; 3832 3833 /** 3834 * struct dfs_event - Data for radar detected events 3835 * @freq: Frequency of the channel in MHz 3836 */ 3837 struct dfs_event { 3838 int freq; 3839 } dfs_event; 3840}; 3841 3842/** 3843 * wpa_supplicant_event - Report a driver event for wpa_supplicant 3844 * @ctx: Context pointer (wpa_s); this is the ctx variable registered 3845 * with struct wpa_driver_ops::init() 3846 * @event: event type (defined above) 3847 * @data: possible extra data for the event 3848 * 3849 * Driver wrapper code should call this function whenever an event is received 3850 * from the driver. 3851 */ 3852void wpa_supplicant_event(void *ctx, enum wpa_event_type event, 3853 union wpa_event_data *data); 3854 3855 3856/* 3857 * The following inline functions are provided for convenience to simplify 3858 * event indication for some of the common events. 3859 */ 3860 3861static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie, 3862 size_t ielen, int reassoc) 3863{ 3864 union wpa_event_data event; 3865 os_memset(&event, 0, sizeof(event)); 3866 event.assoc_info.reassoc = reassoc; 3867 event.assoc_info.req_ies = ie; 3868 event.assoc_info.req_ies_len = ielen; 3869 event.assoc_info.addr = addr; 3870 wpa_supplicant_event(ctx, EVENT_ASSOC, &event); 3871} 3872 3873static inline void drv_event_disassoc(void *ctx, const u8 *addr) 3874{ 3875 union wpa_event_data event; 3876 os_memset(&event, 0, sizeof(event)); 3877 event.disassoc_info.addr = addr; 3878 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event); 3879} 3880 3881static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data, 3882 size_t data_len) 3883{ 3884 union wpa_event_data event; 3885 os_memset(&event, 0, sizeof(event)); 3886 event.eapol_rx.src = src; 3887 event.eapol_rx.data = data; 3888 event.eapol_rx.data_len = data_len; 3889 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event); 3890} 3891 3892/* driver_common.c */ 3893void wpa_scan_results_free(struct wpa_scan_results *res); 3894 3895/* Convert wpa_event_type to a string for logging */ 3896const char * event_to_string(enum wpa_event_type event); 3897 3898#endif /* DRIVER_H */ 3899