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