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