1/* 2 * Driver interface definition 3 * Copyright (c) 2003-2017, 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 "common/ieee802_11_defs.h" 24#include "common/wpa_common.h" 25#ifdef CONFIG_MACSEC 26#include "pae/ieee802_1x_kay.h" 27#endif /* CONFIG_MACSEC */ 28#include "utils/list.h" 29 30#define HOSTAPD_CHAN_DISABLED 0x00000001 31#define HOSTAPD_CHAN_NO_IR 0x00000002 32#define HOSTAPD_CHAN_RADAR 0x00000008 33#define HOSTAPD_CHAN_HT40PLUS 0x00000010 34#define HOSTAPD_CHAN_HT40MINUS 0x00000020 35#define HOSTAPD_CHAN_HT40 0x00000040 36#define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080 37 38#define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000 39#define HOSTAPD_CHAN_DFS_USABLE 0x00000100 40#define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200 41#define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300 42#define HOSTAPD_CHAN_DFS_MASK 0x00000300 43 44#define HOSTAPD_CHAN_VHT_10_70 0x00000800 45#define HOSTAPD_CHAN_VHT_30_50 0x00001000 46#define HOSTAPD_CHAN_VHT_50_30 0x00002000 47#define HOSTAPD_CHAN_VHT_70_10 0x00004000 48 49#define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000 50#define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000 51 52#define HOSTAPD_CHAN_VHT_10_150 0x00100000 53#define HOSTAPD_CHAN_VHT_30_130 0x00200000 54#define HOSTAPD_CHAN_VHT_50_110 0x00400000 55#define HOSTAPD_CHAN_VHT_70_90 0x00800000 56#define HOSTAPD_CHAN_VHT_90_70 0x01000000 57#define HOSTAPD_CHAN_VHT_110_50 0x02000000 58#define HOSTAPD_CHAN_VHT_130_30 0x04000000 59#define HOSTAPD_CHAN_VHT_150_10 0x08000000 60 61/* Allowed bandwidth mask */ 62enum hostapd_chan_width_attr { 63 HOSTAPD_CHAN_WIDTH_10 = BIT(0), 64 HOSTAPD_CHAN_WIDTH_20 = BIT(1), 65 HOSTAPD_CHAN_WIDTH_40P = BIT(2), 66 HOSTAPD_CHAN_WIDTH_40M = BIT(3), 67 HOSTAPD_CHAN_WIDTH_80 = BIT(4), 68 HOSTAPD_CHAN_WIDTH_160 = BIT(5), 69}; 70 71/* Filter gratuitous ARP */ 72#define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0) 73/* Filter unsolicited Neighbor Advertisement */ 74#define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1) 75/* Filter unicast IP packets encrypted using the GTK */ 76#define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2) 77 78#define HOSTAPD_DFS_REGION_FCC 1 79#define HOSTAPD_DFS_REGION_ETSI 2 80#define HOSTAPD_DFS_REGION_JP 3 81 82/** 83 * enum reg_change_initiator - Regulatory change initiator 84 */ 85enum reg_change_initiator { 86 REGDOM_SET_BY_CORE, 87 REGDOM_SET_BY_USER, 88 REGDOM_SET_BY_DRIVER, 89 REGDOM_SET_BY_COUNTRY_IE, 90 REGDOM_BEACON_HINT, 91}; 92 93/** 94 * enum reg_type - Regulatory change types 95 */ 96enum reg_type { 97 REGDOM_TYPE_UNKNOWN, 98 REGDOM_TYPE_COUNTRY, 99 REGDOM_TYPE_WORLD, 100 REGDOM_TYPE_CUSTOM_WORLD, 101 REGDOM_TYPE_INTERSECTION, 102}; 103 104/** 105 * struct hostapd_wmm_rule - WMM regulatory rule 106 * @min_cwmin: Lower bound of CW_min value 107 * @min_cwmax: Lower bound of CW_max value 108 * @min_aifs: Lower bound of AIFS value 109 * @max_txop: Upper bound of TXOP, value in units of 32 usec 110 */ 111struct hostapd_wmm_rule { 112 int min_cwmin; 113 int min_cwmax; 114 int min_aifs; 115 int max_txop; 116}; 117 118/** 119 * struct hostapd_channel_data - Channel information 120 */ 121struct hostapd_channel_data { 122 /** 123 * chan - Channel number (IEEE 802.11) 124 */ 125 short chan; 126 127 /** 128 * freq - Frequency in MHz 129 */ 130 int freq; 131 132 /** 133 * flag - Channel flags (HOSTAPD_CHAN_*) 134 */ 135 int flag; 136 137 /** 138 * allowed_bw - Allowed channel width bitmask 139 * 140 * See enum hostapd_chan_width_attr. 141 */ 142 u32 allowed_bw; 143 144 /** 145 * max_tx_power - Regulatory transmit power limit in dBm 146 */ 147 u8 max_tx_power; 148 149 /** 150 * survey_list - Linked list of surveys (struct freq_survey) 151 */ 152 struct dl_list survey_list; 153 154 /** 155 * min_nf - Minimum observed noise floor, in dBm, based on all 156 * surveyed channel data 157 */ 158 s8 min_nf; 159 160#ifdef CONFIG_ACS 161 /** 162 * interference_factor - Computed interference factor on this 163 * channel (used internally in src/ap/acs.c; driver wrappers do not 164 * need to set this) 165 */ 166 long double interference_factor; 167#endif /* CONFIG_ACS */ 168 169 /** 170 * dfs_cac_ms - DFS CAC time in milliseconds 171 */ 172 unsigned int dfs_cac_ms; 173 174 /** 175 * wmm_rules_valid - Indicates wmm_rules state 176 */ 177 int wmm_rules_valid; 178 179 /** 180 * wmm_rules - WMM regulatory rules 181 */ 182 struct hostapd_wmm_rule wmm_rules[WMM_AC_NUM]; 183}; 184 185#define HE_MAC_CAPAB_0 0 186#define HE_MAX_MAC_CAPAB_SIZE 6 187#define HE_MAX_PHY_CAPAB_SIZE 11 188#define HE_MAX_MCS_CAPAB_SIZE 12 189#define HE_MAX_PPET_CAPAB_SIZE 25 190 191/** 192 * struct he_capabilities - IEEE 802.11ax HE capabilities 193 */ 194struct he_capabilities { 195 u8 he_supported; 196 u8 phy_cap[HE_MAX_PHY_CAPAB_SIZE]; 197 u8 mac_cap[HE_MAX_MAC_CAPAB_SIZE]; 198 u8 mcs[HE_MAX_MCS_CAPAB_SIZE]; 199 u8 ppet[HE_MAX_PPET_CAPAB_SIZE]; 200 u16 he_6ghz_capa; 201}; 202 203#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0) 204#define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1) 205 206 207enum ieee80211_op_mode { 208 IEEE80211_MODE_INFRA = 0, 209 IEEE80211_MODE_IBSS = 1, 210 IEEE80211_MODE_AP = 2, 211 IEEE80211_MODE_MESH = 5, 212 213 /* only add new entries before IEEE80211_MODE_NUM */ 214 IEEE80211_MODE_NUM 215}; 216 217/** 218 * struct ieee80211_edmg_config - EDMG configuration 219 * 220 * This structure describes most essential parameters needed 221 * for IEEE 802.11ay EDMG configuration 222 * 223 * @channels: Bitmap that indicates the 2.16 GHz channel(s) 224 * that are allowed to be used for transmissions. 225 * Bit 0 indicates channel 1, bit 1 indicates channel 2, etc. 226 * Set to 0 to indicate EDMG not supported. 227 * @bw_config: Channel BW Configuration subfield encodes 228 * the allowed channel bandwidth configurations 229 */ 230struct ieee80211_edmg_config { 231 u8 channels; 232 enum edmg_bw_config bw_config; 233}; 234 235/** 236 * struct hostapd_hw_modes - Supported hardware mode information 237 */ 238struct hostapd_hw_modes { 239 /** 240 * mode - Hardware mode 241 */ 242 enum hostapd_hw_mode mode; 243 244 /** 245 * num_channels - Number of entries in the channels array 246 */ 247 int num_channels; 248 249 /** 250 * channels - Array of supported channels 251 */ 252 struct hostapd_channel_data *channels; 253 254 /** 255 * num_rates - Number of entries in the rates array 256 */ 257 int num_rates; 258 259 /** 260 * rates - Array of supported rates in 100 kbps units 261 */ 262 int *rates; 263 264 /** 265 * ht_capab - HT (IEEE 802.11n) capabilities 266 */ 267 u16 ht_capab; 268 269 /** 270 * mcs_set - MCS (IEEE 802.11n) rate parameters 271 */ 272 u8 mcs_set[16]; 273 274 /** 275 * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters 276 */ 277 u8 a_mpdu_params; 278 279 /** 280 * vht_capab - VHT (IEEE 802.11ac) capabilities 281 */ 282 u32 vht_capab; 283 284 /** 285 * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters 286 */ 287 u8 vht_mcs_set[8]; 288 289 unsigned int flags; /* HOSTAPD_MODE_FLAG_* */ 290 291 /** 292 * he_capab - HE (IEEE 802.11ax) capabilities 293 */ 294 struct he_capabilities he_capab[IEEE80211_MODE_NUM]; 295 296 /** 297 * This structure describes the most essential parameters needed 298 * for IEEE 802.11ay EDMG configuration. 299 */ 300 struct ieee80211_edmg_config edmg; 301}; 302 303 304#define IEEE80211_CAP_ESS 0x0001 305#define IEEE80211_CAP_IBSS 0x0002 306#define IEEE80211_CAP_PRIVACY 0x0010 307#define IEEE80211_CAP_RRM 0x1000 308 309/* DMG (60 GHz) IEEE 802.11ad */ 310/* type - bits 0..1 */ 311#define IEEE80211_CAP_DMG_MASK 0x0003 312#define IEEE80211_CAP_DMG_IBSS 0x0001 /* Tx by: STA */ 313#define IEEE80211_CAP_DMG_PBSS 0x0002 /* Tx by: PCP */ 314#define IEEE80211_CAP_DMG_AP 0x0003 /* Tx by: AP */ 315 316#define WPA_SCAN_QUAL_INVALID BIT(0) 317#define WPA_SCAN_NOISE_INVALID BIT(1) 318#define WPA_SCAN_LEVEL_INVALID BIT(2) 319#define WPA_SCAN_LEVEL_DBM BIT(3) 320#define WPA_SCAN_ASSOCIATED BIT(5) 321 322/** 323 * struct wpa_scan_res - Scan result for an BSS/IBSS 324 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*) 325 * @bssid: BSSID 326 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1) 327 * @beacon_int: beacon interval in TUs (host byte order) 328 * @caps: capability information field in host byte order 329 * @qual: signal quality 330 * @noise: noise level 331 * @level: signal level 332 * @tsf: Timestamp 333 * @age: Age of the information in milliseconds (i.e., how many milliseconds 334 * ago the last Beacon or Probe Response frame was received) 335 * @est_throughput: Estimated throughput in kbps (this is calculated during 336 * scan result processing if left zero by the driver wrapper) 337 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing) 338 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms 339 * of TSF of the BSS specified by %tsf_bssid. 340 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to. 341 * @ie_len: length of the following IE field in octets 342 * @beacon_ie_len: length of the following Beacon IE field in octets 343 * 344 * This structure is used as a generic format for scan results from the 345 * driver. Each driver interface implementation is responsible for converting 346 * the driver or OS specific scan results into this format. 347 * 348 * If the driver does not support reporting all IEs, the IE data structure is 349 * constructed of the IEs that are available. This field will also need to 350 * include SSID in IE format. All drivers are encouraged to be extended to 351 * report all IEs to make it easier to support future additions. 352 * 353 * This structure data is followed by ie_len octets of IEs from Probe Response 354 * frame (or if the driver does not indicate source of IEs, these may also be 355 * from Beacon frame). After the first set of IEs, another set of IEs may follow 356 * (with beacon_ie_len octets of data) if the driver provides both IE sets. 357 */ 358struct wpa_scan_res { 359 unsigned int flags; 360 u8 bssid[ETH_ALEN]; 361 int freq; 362 u16 beacon_int; 363 u16 caps; 364 int qual; 365 int noise; 366 int level; 367 u64 tsf; 368 unsigned int age; 369 unsigned int est_throughput; 370 int snr; 371 u64 parent_tsf; 372 u8 tsf_bssid[ETH_ALEN]; 373 size_t ie_len; 374 size_t beacon_ie_len; 375 /* Followed by ie_len + beacon_ie_len octets of IE data */ 376}; 377 378/** 379 * struct wpa_scan_results - Scan results 380 * @res: Array of pointers to allocated variable length scan result entries 381 * @num: Number of entries in the scan result array 382 * @fetch_time: Time when the results were fetched from the driver 383 */ 384struct wpa_scan_results { 385 struct wpa_scan_res **res; 386 size_t num; 387 struct os_reltime fetch_time; 388}; 389 390/** 391 * struct wpa_interface_info - Network interface information 392 * @next: Pointer to the next interface or NULL if this is the last one 393 * @ifname: Interface name that can be used with init() or init2() 394 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if 395 * not available 396 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one 397 * is not an allocated copy, i.e., get_interfaces() caller will not free 398 * this) 399 */ 400struct wpa_interface_info { 401 struct wpa_interface_info *next; 402 char *ifname; 403 char *desc; 404 const char *drv_name; 405}; 406 407#define WPAS_MAX_SCAN_SSIDS 16 408 409/** 410 * struct wpa_driver_scan_ssid - SSIDs to scan for 411 * @ssid - specific SSID to scan for (ProbeReq) 412 * %NULL or zero-length SSID is used to indicate active scan 413 * with wildcard SSID. 414 * @ssid_len - Length of the SSID in octets 415 */ 416struct wpa_driver_scan_ssid { 417 const u8 *ssid; 418 size_t ssid_len; 419}; 420 421/** 422 * struct wpa_driver_scan_params - Scan parameters 423 * Data for struct wpa_driver_ops::scan2(). 424 */ 425struct wpa_driver_scan_params { 426 /** 427 * ssids - SSIDs to scan for 428 */ 429 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS]; 430 431 /** 432 * num_ssids - Number of entries in ssids array 433 * Zero indicates a request for a passive scan. 434 */ 435 size_t num_ssids; 436 437 /** 438 * extra_ies - Extra IE(s) to add into Probe Request or %NULL 439 */ 440 const u8 *extra_ies; 441 442 /** 443 * extra_ies_len - Length of extra_ies in octets 444 */ 445 size_t extra_ies_len; 446 447 /** 448 * freqs - Array of frequencies to scan or %NULL for all frequencies 449 * 450 * The frequency is set in MHz. The array is zero-terminated. 451 */ 452 int *freqs; 453 454 /** 455 * filter_ssids - Filter for reporting SSIDs 456 * 457 * This optional parameter can be used to request the driver wrapper to 458 * filter scan results to include only the specified SSIDs. %NULL 459 * indicates that no filtering is to be done. This can be used to 460 * reduce memory needs for scan results in environments that have large 461 * number of APs with different SSIDs. 462 * 463 * The driver wrapper is allowed to take this allocated buffer into its 464 * own use by setting the pointer to %NULL. In that case, the driver 465 * wrapper is responsible for freeing the buffer with os_free() once it 466 * is not needed anymore. 467 */ 468 struct wpa_driver_scan_filter { 469 u8 ssid[SSID_MAX_LEN]; 470 size_t ssid_len; 471 } *filter_ssids; 472 473 /** 474 * num_filter_ssids - Number of entries in filter_ssids array 475 */ 476 size_t num_filter_ssids; 477 478 /** 479 * filter_rssi - Filter by RSSI 480 * 481 * The driver may filter scan results in firmware to reduce host 482 * wakeups and thereby save power. Specify the RSSI threshold in s32 483 * dBm. 484 */ 485 s32 filter_rssi; 486 487 /** 488 * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes 489 * 490 * When set, the driver is expected to remove rates 1, 2, 5.5, and 11 491 * Mbps from the support rates element(s) in the Probe Request frames 492 * and not to transmit the frames at any of those rates. 493 */ 494 unsigned int p2p_probe:1; 495 496 /** 497 * only_new_results - Request driver to report only new results 498 * 499 * This is used to request the driver to report only BSSes that have 500 * been detected after this scan request has been started, i.e., to 501 * flush old cached BSS entries. 502 */ 503 unsigned int only_new_results:1; 504 505 /** 506 * low_priority - Requests driver to use a lower scan priority 507 * 508 * This is used to request the driver to use a lower scan priority 509 * if it supports such a thing. 510 */ 511 unsigned int low_priority:1; 512 513 /** 514 * mac_addr_rand - Requests driver to randomize MAC address 515 */ 516 unsigned int mac_addr_rand:1; 517 518 /** 519 * mac_addr - MAC address used with randomization. The address cannot be 520 * a multicast one, i.e., bit 0 of byte 0 should not be set. 521 */ 522 u8 *mac_addr; 523 524 /** 525 * mac_addr_mask - MAC address mask used with randomization. 526 * 527 * Bits that are 0 in the mask should be randomized. Bits that are 1 in 528 * the mask should be taken as is from mac_addr. The mask should not 529 * allow the generation of a multicast address, i.e., bit 0 of byte 0 530 * must be set. 531 */ 532 const u8 *mac_addr_mask; 533 534 /** 535 * sched_scan_plans - Scan plans for scheduled scan 536 * 537 * Each scan plan consists of the number of iterations to scan and the 538 * interval between scans. When a scan plan finishes (i.e., it was run 539 * for the specified number of iterations), the next scan plan is 540 * executed. The scan plans are executed in the order they appear in 541 * the array (lower index first). The last scan plan will run infinitely 542 * (until requested to stop), thus must not specify the number of 543 * iterations. All other scan plans must specify the number of 544 * iterations. 545 */ 546 struct sched_scan_plan { 547 u32 interval; /* In seconds */ 548 u32 iterations; /* Zero to run infinitely */ 549 } *sched_scan_plans; 550 551 /** 552 * sched_scan_plans_num - Number of scan plans in sched_scan_plans array 553 */ 554 unsigned int sched_scan_plans_num; 555 556 /** 557 * sched_scan_start_delay - Delay to use before starting the first scan 558 * 559 * Delay (in seconds) before scheduling first scan plan cycle. The 560 * driver may ignore this parameter and start immediately (or at any 561 * other time), if this feature is not supported. 562 */ 563 u32 sched_scan_start_delay; 564 565 /** 566 * bssid - Specific BSSID to scan for 567 * 568 * This optional parameter can be used to replace the default wildcard 569 * BSSID with a specific BSSID to scan for if results are needed from 570 * only a single BSS. 571 */ 572 const u8 *bssid; 573 574 /** 575 * scan_cookie - Unique identification representing the scan request 576 * 577 * This scan_cookie carries a unique identification representing the 578 * scan request if the host driver/kernel supports concurrent scan 579 * requests. This cookie is returned from the corresponding driver 580 * interface. 581 * 582 * Note: Unlike other parameters in this structure, scan_cookie is used 583 * only to return information instead of setting parameters for the 584 * scan. 585 */ 586 u64 scan_cookie; 587 588 /** 589 * duration - Dwell time on each channel 590 * 591 * This optional parameter can be used to set the dwell time on each 592 * channel. In TUs. 593 */ 594 u16 duration; 595 596 /** 597 * duration_mandatory - Whether the specified duration is mandatory 598 * 599 * If this is set, the duration specified by the %duration field is 600 * mandatory (and the driver should reject the scan request if it is 601 * unable to comply with the specified duration), otherwise it is the 602 * maximum duration and the actual duration may be shorter. 603 */ 604 unsigned int duration_mandatory:1; 605 606 /** 607 * relative_rssi_set - Whether relative RSSI parameters are set 608 */ 609 unsigned int relative_rssi_set:1; 610 611 /** 612 * relative_rssi - Relative RSSI for reporting better BSSs 613 * 614 * Amount of RSSI by which a BSS should be better than the current 615 * connected BSS to report the new BSS to user space. 616 */ 617 s8 relative_rssi; 618 619 /** 620 * relative_adjust_band - Band to which RSSI should be adjusted 621 * 622 * The relative_adjust_rssi should be added to the band specified 623 * by relative_adjust_band. 624 */ 625 enum set_band relative_adjust_band; 626 627 /** 628 * relative_adjust_rssi - RSSI to be added to relative_adjust_band 629 * 630 * An amount of relative_band_rssi should be added to the BSSs that 631 * belong to the band specified by relative_adjust_band while comparing 632 * with other bands for BSS reporting. 633 */ 634 s8 relative_adjust_rssi; 635 636 /** 637 * oce_scan 638 * 639 * Enable the following OCE scan features: (WFA OCE TechSpec v1.0) 640 * - Accept broadcast Probe Response frame. 641 * - Probe Request frame deferral and suppression. 642 * - Max Channel Time - driver fills FILS request params IE with 643 * Maximum Channel Time. 644 * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps. 645 */ 646 unsigned int oce_scan:1; 647 648 /** 649 * p2p_include_6ghz - Include 6 GHz channels for P2P full scan 650 * 651 */ 652 unsigned int p2p_include_6ghz:1; 653 654 /* 655 * NOTE: Whenever adding new parameters here, please make sure 656 * wpa_scan_clone_params() and wpa_scan_free_params() get updated with 657 * matching changes. 658 */ 659}; 660 661/** 662 * struct wpa_driver_auth_params - Authentication parameters 663 * Data for struct wpa_driver_ops::authenticate(). 664 */ 665struct wpa_driver_auth_params { 666 int freq; 667 const u8 *bssid; 668 const u8 *ssid; 669 size_t ssid_len; 670 int auth_alg; 671 const u8 *ie; 672 size_t ie_len; 673 const u8 *wep_key[4]; 674 size_t wep_key_len[4]; 675 int wep_tx_keyidx; 676 int local_state_change; 677 678 /** 679 * p2p - Whether this connection is a P2P group 680 */ 681 int p2p; 682 683 /** 684 * auth_data - Additional elements for Authentication frame 685 * 686 * This buffer starts with the Authentication transaction sequence 687 * number field. If no special handling of such elements is needed, this 688 * pointer is %NULL. This is used with SAE and FILS. 689 */ 690 const u8 *auth_data; 691 692 /** 693 * auth_data_len - Length of auth_data buffer in octets 694 */ 695 size_t auth_data_len; 696}; 697 698/** 699 * enum wps_mode - WPS mode 700 */ 701enum wps_mode { 702 /** 703 * WPS_MODE_NONE - No WPS provisioning being used 704 */ 705 WPS_MODE_NONE, 706 707 /** 708 * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode 709 */ 710 WPS_MODE_OPEN, 711 712 /** 713 * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection 714 */ 715 WPS_MODE_PRIVACY 716}; 717 718/** 719 * struct hostapd_freq_params - Channel parameters 720 */ 721struct hostapd_freq_params { 722 /** 723 * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..) 724 */ 725 enum hostapd_hw_mode mode; 726 727 /** 728 * freq - Primary channel center frequency in MHz 729 */ 730 int freq; 731 732 /** 733 * channel - Channel number 734 */ 735 int channel; 736 737 /** 738 * ht_enabled - Whether HT is enabled 739 */ 740 int ht_enabled; 741 742 /** 743 * sec_channel_offset - Secondary channel offset for HT40 744 * 745 * 0 = HT40 disabled, 746 * -1 = HT40 enabled, secondary channel below primary, 747 * 1 = HT40 enabled, secondary channel above primary 748 */ 749 int sec_channel_offset; 750 751 /** 752 * vht_enabled - Whether VHT is enabled 753 */ 754 int vht_enabled; 755 756 /** 757 * he_enabled - Whether HE is enabled 758 */ 759 int he_enabled; 760 761 /** 762 * center_freq1 - Segment 0 center frequency in MHz 763 * 764 * Valid for both HT and VHT. 765 */ 766 int center_freq1; 767 768 /** 769 * center_freq2 - Segment 1 center frequency in MHz 770 * 771 * Non-zero only for bandwidth 80 and an 80+80 channel 772 */ 773 int center_freq2; 774 775 /** 776 * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160) 777 */ 778 int bandwidth; 779 780 /** 781 * This structure describes the most essential parameters needed 782 * for IEEE 802.11ay EDMG configuration. 783 */ 784 struct ieee80211_edmg_config edmg; 785}; 786 787/** 788 * struct wpa_driver_sta_auth_params - Authentication parameters 789 * Data for struct wpa_driver_ops::sta_auth(). 790 */ 791struct wpa_driver_sta_auth_params { 792 793 /** 794 * own_addr - Source address and BSSID for authentication frame 795 */ 796 const u8 *own_addr; 797 798 /** 799 * addr - MAC address of the station to associate 800 */ 801 const u8 *addr; 802 803 /** 804 * seq - authentication sequence number 805 */ 806 u16 seq; 807 808 /** 809 * status - authentication response status code 810 */ 811 u16 status; 812 813 /** 814 * ie - authentication frame ie buffer 815 */ 816 const u8 *ie; 817 818 /** 819 * len - ie buffer length 820 */ 821 size_t len; 822 823 /** 824 * fils_auth - Indicates whether FILS authentication is being performed 825 */ 826 int fils_auth; 827 828 /** 829 * fils_anonce - ANonce (required for FILS) 830 */ 831 u8 fils_anonce[WPA_NONCE_LEN]; 832 833 /** 834 * fils_snonce - SNonce (required for FILS) 835 */ 836 u8 fils_snonce[WPA_NONCE_LEN]; 837 838 /** 839 * fils_kek - key for encryption (required for FILS) 840 */ 841 u8 fils_kek[WPA_KEK_MAX_LEN]; 842 843 /** 844 * fils_kek_len - Length of the fils_kek in octets (required for FILS) 845 */ 846 size_t fils_kek_len; 847}; 848 849/** 850 * struct wpa_driver_associate_params - Association parameters 851 * Data for struct wpa_driver_ops::associate(). 852 */ 853struct wpa_driver_associate_params { 854 /** 855 * bssid - BSSID of the selected AP 856 * This can be %NULL, if ap_scan=2 mode is used and the driver is 857 * responsible for selecting with which BSS to associate. */ 858 const u8 *bssid; 859 860 /** 861 * bssid_hint - BSSID of a proposed AP 862 * 863 * This indicates which BSS has been found a suitable candidate for 864 * initial association for drivers that use driver/firmwate-based BSS 865 * selection. Unlike the @bssid parameter, @bssid_hint does not limit 866 * the driver from selecting other BSSes in the ESS. 867 */ 868 const u8 *bssid_hint; 869 870 /** 871 * ssid - The selected SSID 872 */ 873 const u8 *ssid; 874 875 /** 876 * ssid_len - Length of the SSID (1..32) 877 */ 878 size_t ssid_len; 879 880 /** 881 * freq - channel parameters 882 */ 883 struct hostapd_freq_params freq; 884 885 /** 886 * freq_hint - Frequency of the channel the proposed AP is using 887 * 888 * This provides a channel on which a suitable BSS has been found as a 889 * hint for the driver. Unlike the @freq parameter, @freq_hint does not 890 * limit the driver from selecting other channels for 891 * driver/firmware-based BSS selection. 892 */ 893 int freq_hint; 894 895 /** 896 * bg_scan_period - Background scan period in seconds, 0 to disable 897 * background scan, or -1 to indicate no change to default driver 898 * configuration 899 */ 900 int bg_scan_period; 901 902 /** 903 * beacon_int - Beacon interval for IBSS or 0 to use driver default 904 */ 905 int beacon_int; 906 907 /** 908 * wpa_ie - WPA information element for (Re)Association Request 909 * WPA information element to be included in (Re)Association 910 * Request (including information element id and length). Use 911 * of this WPA IE is optional. If the driver generates the WPA 912 * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and 913 * key_mgmt_suite to select proper algorithms. In this case, 914 * the driver has to notify wpa_supplicant about the used WPA 915 * IE by generating an event that the interface code will 916 * convert into EVENT_ASSOCINFO data (see below). 917 * 918 * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE 919 * instead. The driver can determine which version is used by 920 * looking at the first byte of the IE (0xdd for WPA, 0x30 for 921 * WPA2/RSN). 922 * 923 * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE. 924 */ 925 const u8 *wpa_ie; 926 927 /** 928 * wpa_ie_len - length of the wpa_ie 929 */ 930 size_t wpa_ie_len; 931 932 /** 933 * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2 934 */ 935 unsigned int wpa_proto; 936 937 /** 938 * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*) 939 * 940 * This is usually ignored if @wpa_ie is used. 941 */ 942 unsigned int pairwise_suite; 943 944 /** 945 * group_suite - Selected group cipher suite (WPA_CIPHER_*) 946 * 947 * This is usually ignored if @wpa_ie is used. 948 */ 949 unsigned int group_suite; 950 951 /** 952 * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*) 953 * 954 * This is usually ignored if @wpa_ie is used. 955 */ 956 unsigned int mgmt_group_suite; 957 958 /** 959 * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*) 960 * 961 * This is usually ignored if @wpa_ie is used. 962 */ 963 unsigned int key_mgmt_suite; 964 965 /** 966 * auth_alg - Allowed authentication algorithms 967 * Bit field of WPA_AUTH_ALG_* 968 */ 969 int auth_alg; 970 971 /** 972 * mode - Operation mode (infra/ibss) IEEE80211_MODE_* 973 */ 974 int mode; 975 976 /** 977 * wep_key - WEP keys for static WEP configuration 978 */ 979 const u8 *wep_key[4]; 980 981 /** 982 * wep_key_len - WEP key length for static WEP configuration 983 */ 984 size_t wep_key_len[4]; 985 986 /** 987 * wep_tx_keyidx - WEP TX key index for static WEP configuration 988 */ 989 int wep_tx_keyidx; 990 991 /** 992 * mgmt_frame_protection - IEEE 802.11w management frame protection 993 */ 994 enum mfp_options mgmt_frame_protection; 995 996 /** 997 * passphrase - RSN passphrase for PSK 998 * 999 * This value is made available only for WPA/WPA2-Personal (PSK) and 1000 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This 1001 * is the 8..63 character ASCII passphrase, if available. Please note 1002 * that this can be %NULL if passphrase was not used to generate the 1003 * PSK. In that case, the psk field must be used to fetch the PSK. 1004 */ 1005 const char *passphrase; 1006 1007 /** 1008 * psk - RSN PSK (alternative for passphrase for PSK) 1009 * 1010 * This value is made available only for WPA/WPA2-Personal (PSK) and 1011 * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This 1012 * is the 32-octet (256-bit) PSK, if available. The driver wrapper 1013 * should be prepared to handle %NULL value as an error. 1014 */ 1015 const u8 *psk; 1016 1017 /** 1018 * drop_unencrypted - Enable/disable unencrypted frame filtering 1019 * 1020 * Configure the driver to drop all non-EAPOL frames (both receive and 1021 * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must 1022 * still be allowed for key negotiation. 1023 */ 1024 int drop_unencrypted; 1025 1026 /** 1027 * prev_bssid - Previously used BSSID in this ESS 1028 * 1029 * When not %NULL, this is a request to use reassociation instead of 1030 * association. 1031 */ 1032 const u8 *prev_bssid; 1033 1034 /** 1035 * wps - WPS mode 1036 * 1037 * If the driver needs to do special configuration for WPS association, 1038 * this variable provides more information on what type of association 1039 * is being requested. Most drivers should not need ot use this. 1040 */ 1041 enum wps_mode wps; 1042 1043 /** 1044 * p2p - Whether this connection is a P2P group 1045 */ 1046 int p2p; 1047 1048 /** 1049 * uapsd - UAPSD parameters for the network 1050 * -1 = do not change defaults 1051 * AP mode: 1 = enabled, 0 = disabled 1052 * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE 1053 */ 1054 int uapsd; 1055 1056 /** 1057 * fixed_bssid - Whether to force this BSSID in IBSS mode 1058 * 1 = Fix this BSSID and prevent merges. 1059 * 0 = Do not fix BSSID. 1060 */ 1061 int fixed_bssid; 1062 1063 /** 1064 * fixed_freq - Fix control channel in IBSS mode 1065 * 0 = don't fix control channel (default) 1066 * 1 = fix control channel; this prevents IBSS merging with another 1067 * channel 1068 */ 1069 int fixed_freq; 1070 1071 /** 1072 * disable_ht - Disable HT (IEEE 802.11n) for this connection 1073 */ 1074 int disable_ht; 1075 1076 /** 1077 * htcaps - HT Capabilities over-rides 1078 * 1079 * Only bits set in the mask will be used, and not all values are used 1080 * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used. 1081 * 1082 * Pointer to struct ieee80211_ht_capabilities. 1083 */ 1084 const u8 *htcaps; 1085 1086 /** 1087 * htcaps_mask - HT Capabilities over-rides mask 1088 * 1089 * Pointer to struct ieee80211_ht_capabilities. 1090 */ 1091 const u8 *htcaps_mask; 1092 1093#ifdef CONFIG_VHT_OVERRIDES 1094 /** 1095 * disable_vht - Disable VHT for this connection 1096 */ 1097 int disable_vht; 1098 1099 /** 1100 * VHT capability overrides. 1101 */ 1102 const struct ieee80211_vht_capabilities *vhtcaps; 1103 const struct ieee80211_vht_capabilities *vhtcaps_mask; 1104#endif /* CONFIG_VHT_OVERRIDES */ 1105 1106#ifdef CONFIG_HE_OVERRIDES 1107 /** 1108 * disable_he - Disable HE for this connection 1109 */ 1110 int disable_he; 1111#endif /* CONFIG_HE_OVERRIDES */ 1112 1113 /** 1114 * req_key_mgmt_offload - Request key management offload for connection 1115 * 1116 * Request key management offload for this connection if the device 1117 * supports it. 1118 */ 1119 int req_key_mgmt_offload; 1120 1121 /** 1122 * req_handshake_offload - Request EAPOL handshake offload 1123 * 1124 * Request EAPOL handshake offload for this connection if the device 1125 * supports it. 1126 */ 1127 int req_handshake_offload; 1128 1129 /** 1130 * Flag for indicating whether this association includes support for 1131 * RRM (Radio Resource Measurements) 1132 */ 1133 int rrm_used; 1134 1135 /** 1136 * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an 1137 * AP as usual. Valid for DMG network only. 1138 */ 1139 int pbss; 1140 1141 /** 1142 * fils_kek - KEK for FILS association frame protection (AES-SIV) 1143 */ 1144 const u8 *fils_kek; 1145 1146 /** 1147 * fils_kek_len: Length of fils_kek in bytes 1148 */ 1149 size_t fils_kek_len; 1150 1151 /** 1152 * fils_nonces - Nonces for FILS association frame protection 1153 * (AES-SIV AAD) 1154 */ 1155 const u8 *fils_nonces; 1156 1157 /** 1158 * fils_nonces_len: Length of fils_nonce in bytes 1159 */ 1160 size_t fils_nonces_len; 1161 1162 /** 1163 * fils_erp_username - Username part of keyName-NAI 1164 */ 1165 const u8 *fils_erp_username; 1166 1167 /** 1168 * fils_erp_username_len - Length of fils_erp_username in bytes 1169 */ 1170 size_t fils_erp_username_len; 1171 1172 /** 1173 * fils_erp_realm - Realm/domain name to use in FILS ERP 1174 */ 1175 const u8 *fils_erp_realm; 1176 1177 /** 1178 * fils_erp_realm_len - Length of fils_erp_realm in bytes 1179 */ 1180 size_t fils_erp_realm_len; 1181 1182 /** 1183 * fils_erp_next_seq_num - The next sequence number to use in FILS ERP 1184 * messages 1185 */ 1186 u16 fils_erp_next_seq_num; 1187 1188 /** 1189 * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI 1190 * specified by fils_erp_username@fils_erp_realm. 1191 */ 1192 const u8 *fils_erp_rrk; 1193 1194 /** 1195 * fils_erp_rrk_len - Length of fils_erp_rrk in bytes 1196 */ 1197 size_t fils_erp_rrk_len; 1198 1199 /** 1200 * sae_pwe - SAE mechanism for PWE derivation 1201 * 0 = hunting-and-pecking loop only 1202 * 1 = hash-to-element only 1203 * 2 = both hunting-and-pecking loop and hash-to-element enabled 1204 */ 1205 int sae_pwe; 1206}; 1207 1208enum hide_ssid { 1209 NO_SSID_HIDING, 1210 HIDDEN_SSID_ZERO_LEN, 1211 HIDDEN_SSID_ZERO_CONTENTS 1212}; 1213 1214enum ch_switch_state { 1215 CH_SW_STARTED, 1216 CH_SW_FINISHED 1217}; 1218 1219struct wowlan_triggers { 1220 u8 any; 1221 u8 disconnect; 1222 u8 magic_pkt; 1223 u8 gtk_rekey_failure; 1224 u8 eap_identity_req; 1225 u8 four_way_handshake; 1226 u8 rfkill_release; 1227}; 1228 1229struct wpa_driver_ap_params { 1230 /** 1231 * head - Beacon head from IEEE 802.11 header to IEs before TIM IE 1232 */ 1233 u8 *head; 1234 1235 /** 1236 * head_len - Length of the head buffer in octets 1237 */ 1238 size_t head_len; 1239 1240 /** 1241 * tail - Beacon tail following TIM IE 1242 */ 1243 u8 *tail; 1244 1245 /** 1246 * tail_len - Length of the tail buffer in octets 1247 */ 1248 size_t tail_len; 1249 1250 /** 1251 * dtim_period - DTIM period 1252 */ 1253 int dtim_period; 1254 1255 /** 1256 * beacon_int - Beacon interval 1257 */ 1258 int beacon_int; 1259 1260 /** 1261 * basic_rates: -1 terminated array of basic rates in 100 kbps 1262 * 1263 * This parameter can be used to set a specific basic rate set for the 1264 * BSS. If %NULL, default basic rate set is used. 1265 */ 1266 int *basic_rates; 1267 1268 /** 1269 * beacon_rate: Beacon frame data rate 1270 * 1271 * This parameter can be used to set a specific Beacon frame data rate 1272 * for the BSS. The interpretation of this value depends on the 1273 * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS, 1274 * HE: HE-MCS). If beacon_rate == 0 and rate_type == 0 1275 * (BEACON_RATE_LEGACY), the default Beacon frame data rate is used. 1276 */ 1277 unsigned int beacon_rate; 1278 1279 /** 1280 * beacon_rate_type: Beacon data rate type (legacy/HT/VHT/HE) 1281 */ 1282 enum beacon_rate_type rate_type; 1283 1284 /** 1285 * proberesp - Probe Response template 1286 * 1287 * This is used by drivers that reply to Probe Requests internally in 1288 * AP mode and require the full Probe Response template. 1289 */ 1290 u8 *proberesp; 1291 1292 /** 1293 * proberesp_len - Length of the proberesp buffer in octets 1294 */ 1295 size_t proberesp_len; 1296 1297 /** 1298 * ssid - The SSID to use in Beacon/Probe Response frames 1299 */ 1300 const u8 *ssid; 1301 1302 /** 1303 * ssid_len - Length of the SSID (1..32) 1304 */ 1305 size_t ssid_len; 1306 1307 /** 1308 * hide_ssid - Whether to hide the SSID 1309 */ 1310 enum hide_ssid hide_ssid; 1311 1312 /** 1313 * pairwise_ciphers - WPA_CIPHER_* bitfield 1314 */ 1315 unsigned int pairwise_ciphers; 1316 1317 /** 1318 * group_cipher - WPA_CIPHER_* 1319 */ 1320 unsigned int group_cipher; 1321 1322 /** 1323 * key_mgmt_suites - WPA_KEY_MGMT_* bitfield 1324 */ 1325 unsigned int key_mgmt_suites; 1326 1327 /** 1328 * auth_algs - WPA_AUTH_ALG_* bitfield 1329 */ 1330 unsigned int auth_algs; 1331 1332 /** 1333 * wpa_version - WPA_PROTO_* bitfield 1334 */ 1335 unsigned int wpa_version; 1336 1337 /** 1338 * privacy - Whether privacy is used in the BSS 1339 */ 1340 int privacy; 1341 1342 /** 1343 * beacon_ies - WPS/P2P IE(s) for Beacon frames 1344 * 1345 * This is used to add IEs like WPS IE and P2P IE by drivers that do 1346 * not use the full Beacon template. 1347 */ 1348 const struct wpabuf *beacon_ies; 1349 1350 /** 1351 * proberesp_ies - P2P/WPS IE(s) for Probe Response frames 1352 * 1353 * This is used to add IEs like WPS IE and P2P IE by drivers that 1354 * reply to Probe Request frames internally. 1355 */ 1356 const struct wpabuf *proberesp_ies; 1357 1358 /** 1359 * assocresp_ies - WPS IE(s) for (Re)Association Response frames 1360 * 1361 * This is used to add IEs like WPS IE by drivers that reply to 1362 * (Re)Association Request frames internally. 1363 */ 1364 const struct wpabuf *assocresp_ies; 1365 1366 /** 1367 * isolate - Whether to isolate frames between associated stations 1368 * 1369 * If this is non-zero, the AP is requested to disable forwarding of 1370 * frames between associated stations. 1371 */ 1372 int isolate; 1373 1374 /** 1375 * cts_protect - Whether CTS protection is enabled 1376 */ 1377 int cts_protect; 1378 1379 /** 1380 * preamble - Whether short preamble is enabled 1381 */ 1382 int preamble; 1383 1384 /** 1385 * short_slot_time - Whether short slot time is enabled 1386 * 1387 * 0 = short slot time disable, 1 = short slot time enabled, -1 = do 1388 * not set (e.g., when 802.11g mode is not in use) 1389 */ 1390 int short_slot_time; 1391 1392 /** 1393 * ht_opmode - HT operation mode or -1 if HT not in use 1394 */ 1395 int ht_opmode; 1396 1397 /** 1398 * interworking - Whether Interworking is enabled 1399 */ 1400 int interworking; 1401 1402 /** 1403 * hessid - Homogeneous ESS identifier or %NULL if not set 1404 */ 1405 const u8 *hessid; 1406 1407 /** 1408 * access_network_type - Access Network Type (0..15) 1409 * 1410 * This is used for filtering Probe Request frames when Interworking is 1411 * enabled. 1412 */ 1413 u8 access_network_type; 1414 1415 /** 1416 * ap_max_inactivity - Timeout in seconds to detect STA's inactivity 1417 * 1418 * This is used by driver which advertises this capability. 1419 */ 1420 int ap_max_inactivity; 1421 1422 /** 1423 * ctwindow - Client Traffic Window (in TUs) 1424 */ 1425 u8 p2p_go_ctwindow; 1426 1427 /** 1428 * disable_dgaf - Whether group-addressed frames are disabled 1429 */ 1430 int disable_dgaf; 1431 1432 /** 1433 * osen - Whether OSEN security is enabled 1434 */ 1435 int osen; 1436 1437 /** 1438 * freq - Channel parameters for dynamic bandwidth changes 1439 */ 1440 struct hostapd_freq_params *freq; 1441 1442 /** 1443 * reenable - Whether this is to re-enable beaconing 1444 */ 1445 int reenable; 1446 1447 /** 1448 * pbss - Whether to start a PCP (in PBSS) instead of an AP in 1449 * infrastructure BSS. Valid only for DMG network. 1450 */ 1451 int pbss; 1452 1453 /** 1454 * multicast_to_unicast - Whether to use multicast_to_unicast 1455 * 1456 * If this is non-zero, the AP is requested to perform multicast to 1457 * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within 1458 * 802.1Q). If enabled, such frames are to be sent to each station 1459 * separately, with the DA replaced by their own MAC address rather 1460 * than the group address. 1461 * 1462 * Note that this may break certain expectations of the receiver, such 1463 * as the ability to drop unicast IP packets received within multicast 1464 * L2 frames, or the ability to not send ICMP destination unreachable 1465 * messages for packets received in L2 multicast (which is required, 1466 * but the receiver can't tell the difference if this new option is 1467 * enabled.) 1468 * 1469 * This also doesn't implement the 802.11 DMS (directed multicast 1470 * service). 1471 */ 1472 int multicast_to_unicast; 1473 1474 /** 1475 * ftm_responder - Whether FTM responder is enabled 1476 */ 1477 int ftm_responder; 1478 1479 /** 1480 * lci - Binary data, the content of an LCI report IE with type 8 as 1481 * defined in IEEE Std 802.11-2016, 9.4.2.22.10 1482 */ 1483 const struct wpabuf *lci; 1484 1485 /** 1486 * civic - Binary data, the content of a measurement report IE with 1487 * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13 1488 */ 1489 const struct wpabuf *civic; 1490 1491 /** 1492 * he_spr_ctrl - Spatial Reuse control field of SPR element 1493 */ 1494 u8 he_spr_ctrl; 1495 1496 /** 1497 * he_spr_non_srg_obss_pd_max_offset - Non-SRG Maximum TX power offset 1498 */ 1499 u8 he_spr_non_srg_obss_pd_max_offset; 1500 1501 /** 1502 * he_spr_srg_obss_pd_min_offset - Minimum TX power offset 1503 */ 1504 u8 he_spr_srg_obss_pd_min_offset; 1505 1506 /** 1507 * he_spr_srg_obss_pd_max_offset - Maximum TX power offset 1508 */ 1509 u8 he_spr_srg_obss_pd_max_offset; 1510 1511 /** 1512 * he_spr_bss_color_bitmap - BSS color values used by members of the 1513 * SRG. 1514 */ 1515 u8 he_spr_bss_color_bitmap[8]; 1516 1517 /** 1518 * he_spr_partial_bssid_bitmap - Partial BSSID values used by members 1519 * of the SRG. 1520 */ 1521 u8 he_spr_partial_bssid_bitmap[8]; 1522 1523 /** 1524 * he_bss_color - Whether the BSS Color is disabled 1525 */ 1526 int he_bss_color_disabled; 1527 1528 /** 1529 * he_bss_color_partial - The BSS Color AID equation 1530 */ 1531 int he_bss_color_partial; 1532 1533 /** 1534 * he_bss_color - The BSS Color of the AP 1535 */ 1536 int he_bss_color; 1537 1538 /** 1539 * twt_responder - Whether Target Wait Time responder is enabled 1540 */ 1541 int twt_responder; 1542 1543 /** 1544 * sae_pwe - SAE mechanism for PWE derivation 1545 * 0 = hunting-and-pecking loop only 1546 * 1 = hash-to-element only 1547 * 2 = both hunting-and-pecking loop and hash-to-element enabled 1548 */ 1549 int sae_pwe; 1550 1551 /** 1552 * FILS Discovery frame minimum interval in TUs 1553 */ 1554 u32 fd_min_int; 1555 1556 /** 1557 * FILS Discovery frame maximum interval in TUs (0 = FD frame disabled) 1558 */ 1559 u32 fd_max_int; 1560 1561 /** 1562 * FILS Discovery frame template data 1563 */ 1564 u8 *fd_frame_tmpl; 1565 1566 /** 1567 * FILS Discovery frame template length 1568 */ 1569 size_t fd_frame_tmpl_len; 1570 1571 /** 1572 * Unsolicited broadcast Probe Response interval in TUs 1573 */ 1574 unsigned int unsol_bcast_probe_resp_interval; 1575 1576 /** 1577 * Unsolicited broadcast Probe Response template data 1578 */ 1579 u8 *unsol_bcast_probe_resp_tmpl; 1580 1581 /** 1582 * Unsolicited broadcast Probe Response template length 1583 */ 1584 size_t unsol_bcast_probe_resp_tmpl_len; 1585}; 1586 1587struct wpa_driver_mesh_bss_params { 1588#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS 0x00000001 1589#define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002 1590#define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS 0x00000004 1591#define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE 0x00000008 1592#define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD 0x00000010 1593#define WPA_DRIVER_MESH_CONF_FLAG_FORWARDING 0x00000020 1594 /* 1595 * TODO: Other mesh configuration parameters would go here. 1596 * See NL80211_MESHCONF_* for all the mesh config parameters. 1597 */ 1598 unsigned int flags; 1599 int auto_plinks; 1600 int peer_link_timeout; 1601 int max_peer_links; 1602 int rssi_threshold; 1603 int forwarding; 1604 u16 ht_opmode; 1605}; 1606 1607struct wpa_driver_mesh_join_params { 1608 const u8 *meshid; 1609 int meshid_len; 1610 const int *basic_rates; 1611 const u8 *ies; 1612 int ie_len; 1613 struct hostapd_freq_params freq; 1614 int beacon_int; 1615 int dtim_period; 1616 struct wpa_driver_mesh_bss_params conf; 1617#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001 1618#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002 1619#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004 1620#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008 1621 unsigned int flags; 1622 bool handle_dfs; 1623}; 1624 1625struct wpa_driver_set_key_params { 1626 /** 1627 * ifname - Interface name (for multi-SSID/VLAN support) */ 1628 const char *ifname; 1629 1630 /** 1631 * alg - Encryption algorithm 1632 * 1633 * (%WPA_ALG_NONE, %WPA_ALG_WEP, %WPA_ALG_TKIP, %WPA_ALG_CCMP, 1634 * %WPA_ALG_BIP_AES_CMAC_128, %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, 1635 * %WPA_ALG_CCMP_256, %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256, 1636 * %WPA_ALG_BIP_CMAC_256); 1637 * %WPA_ALG_NONE clears the key. */ 1638 enum wpa_alg alg; 1639 1640 /** 1641 * addr - Address of the peer STA 1642 * 1643 * (BSSID of the current AP when setting pairwise key in station mode), 1644 * ff:ff:ff:ff:ff:ff for broadcast keys, %NULL for default keys that 1645 * are used both for broadcast and unicast; when clearing keys, %NULL 1646 * is used to indicate that both the broadcast-only and default key of 1647 * the specified key index is to be cleared */ 1648 const u8 *addr; 1649 1650 /** 1651 * key_idx - Key index 1652 * 1653 * (0..3), usually 0 for unicast keys; 4..5 for IGTK; 6..7 for BIGTK */ 1654 int key_idx; 1655 1656 /** 1657 * set_tx - Configure this key as the default Tx key 1658 * 1659 * Only used when driver does not support separate unicast/individual 1660 * key */ 1661 int set_tx; 1662 1663 /** 1664 * seq - Sequence number/packet number 1665 * 1666 * seq_len octets, the next packet number to be used for in replay 1667 * protection; configured for Rx keys (in most cases, this is only used 1668 * with broadcast keys and set to zero for unicast keys); %NULL if not 1669 * set */ 1670 const u8 *seq; 1671 1672 /** 1673 * seq_len - Length of the seq, depends on the algorithm 1674 * 1675 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets */ 1676 size_t seq_len; 1677 1678 /** 1679 * key - Key buffer 1680 * 1681 * TKIP: 16-byte temporal key, 8-byte Tx Mic key, 8-byte Rx Mic Key */ 1682 const u8 *key; 1683 1684 /** 1685 * key_len - Length of the key buffer in octets 1686 * 1687 * WEP: 5 or 13, TKIP: 32, CCMP/GCMP: 16, IGTK: 16 */ 1688 size_t key_len; 1689 1690 /** 1691 * vlan_id - VLAN index (0..4095) for VLAN offload cases */ 1692 int vlan_id; 1693 1694 /** 1695 * key_flag - Additional key flags 1696 * 1697 * %KEY_FLAG_MODIFY 1698 * Set when an already installed key must be updated. 1699 * So far the only use-case is changing RX/TX status for 1700 * pairwise keys. Must not be set when deleting a key. 1701 * %KEY_FLAG_DEFAULT 1702 * Set when the key is also a default key. Must not be set when 1703 * deleting a key. 1704 * %KEY_FLAG_RX 1705 * The key is valid for RX. Must not be set when deleting a key. 1706 * %KEY_FLAG_TX 1707 * The key is valid for TX. Must not be set when deleting a key. 1708 * %KEY_FLAG_GROUP 1709 * The key is a broadcast or group key. 1710 * %KEY_FLAG_PAIRWISE 1711 * The key is a pairwise key. 1712 * %KEY_FLAG_PMK 1713 * The key is a Pairwise Master Key (PMK). 1714 * 1715 * Valid and pre-defined combinations are: 1716 * %KEY_FLAG_GROUP_RX_TX 1717 * WEP key not to be installed as default key. 1718 * %KEY_FLAG_GROUP_RX_TX_DEFAULT 1719 * Default WEP or WPA-NONE key. 1720 * %KEY_FLAG_GROUP_RX 1721 * GTK key valid for RX only. 1722 * %KEY_FLAG_GROUP_TX_DEFAULT 1723 * GTK key valid for TX only, immediately taking over TX. 1724 * %KEY_FLAG_PAIRWISE_RX_TX 1725 * Pairwise key immediately becoming the active pairwise key. 1726 * %KEY_FLAG_PAIRWISE_RX 1727 * Pairwise key not yet valid for TX. (Only usable when Extended 1728 * Key ID is supported by the driver.) 1729 * %KEY_FLAG_PAIRWISE_RX_TX_MODIFY 1730 * Enable TX for a pairwise key installed with 1731 * KEY_FLAG_PAIRWISE_RX. 1732 * 1733 * Not a valid standalone key type but pre-defined to be combined 1734 * with other key_flags: 1735 * %KEY_FLAG_RX_TX 1736 * RX/TX key. */ 1737 enum key_flag key_flag; 1738}; 1739 1740enum wpa_driver_if_type { 1741 /** 1742 * WPA_IF_STATION - Station mode interface 1743 */ 1744 WPA_IF_STATION, 1745 1746 /** 1747 * WPA_IF_AP_VLAN - AP mode VLAN interface 1748 * 1749 * This interface shares its address and Beacon frame with the main 1750 * BSS. 1751 */ 1752 WPA_IF_AP_VLAN, 1753 1754 /** 1755 * WPA_IF_AP_BSS - AP mode BSS interface 1756 * 1757 * This interface has its own address and Beacon frame. 1758 */ 1759 WPA_IF_AP_BSS, 1760 1761 /** 1762 * WPA_IF_P2P_GO - P2P Group Owner 1763 */ 1764 WPA_IF_P2P_GO, 1765 1766 /** 1767 * WPA_IF_P2P_CLIENT - P2P Client 1768 */ 1769 WPA_IF_P2P_CLIENT, 1770 1771 /** 1772 * WPA_IF_P2P_GROUP - P2P Group interface (will become either 1773 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known) 1774 */ 1775 WPA_IF_P2P_GROUP, 1776 1777 /** 1778 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the 1779 * abstracted P2P Device function in the driver 1780 */ 1781 WPA_IF_P2P_DEVICE, 1782 1783 /* 1784 * WPA_IF_MESH - Mesh interface 1785 */ 1786 WPA_IF_MESH, 1787 1788 /* 1789 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only) 1790 */ 1791 WPA_IF_TDLS, 1792 1793 /* 1794 * WPA_IF_IBSS - IBSS interface (used for pref freq only) 1795 */ 1796 WPA_IF_IBSS, 1797 1798 /* 1799 * WPA_IF_NAN - NAN Device 1800 */ 1801 WPA_IF_NAN, 1802 1803 /* keep last */ 1804 WPA_IF_MAX 1805}; 1806 1807/** 1808 * struct wpa_driver_capa - Driver capability information 1809 */ 1810struct wpa_driver_capa { 1811#define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001 1812#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002 1813#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004 1814#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008 1815#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010 1816#define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020 1817#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040 1818#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080 1819#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100 1820#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200 1821#define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400 1822#define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800 1823#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000 1824#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000 1825#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000 1826#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000 1827#define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000 1828#define WPA_DRIVER_CAPA_KEY_MGMT_802_1X_SHA256 0x00020000 1829#define WPA_DRIVER_CAPA_KEY_MGMT_PSK_SHA256 0x00040000 1830#define WPA_DRIVER_CAPA_KEY_MGMT_TPK_HANDSHAKE 0x00080000 1831#define WPA_DRIVER_CAPA_KEY_MGMT_FT_SAE 0x00100000 1832#define WPA_DRIVER_CAPA_KEY_MGMT_FT_802_1X_SHA384 0x00200000 1833#define WPA_DRIVER_CAPA_KEY_MGMT_CCKM 0x00400000 1834#define WPA_DRIVER_CAPA_KEY_MGMT_OSEN 0x00800000 1835 /** Bitfield of supported key management suites */ 1836 unsigned int key_mgmt; 1837 unsigned int key_mgmt_iftype[WPA_IF_MAX]; 1838 1839#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001 1840#define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002 1841#define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004 1842#define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008 1843#define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010 1844#define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020 1845#define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040 1846#define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080 1847#define WPA_DRIVER_CAPA_ENC_BIP 0x00000100 1848#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200 1849#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400 1850#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800 1851#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000 1852 /** Bitfield of supported cipher suites */ 1853 unsigned int enc; 1854 1855#define WPA_DRIVER_AUTH_OPEN 0x00000001 1856#define WPA_DRIVER_AUTH_SHARED 0x00000002 1857#define WPA_DRIVER_AUTH_LEAP 0x00000004 1858 /** Bitfield of supported IEEE 802.11 authentication algorithms */ 1859 unsigned int auth; 1860 1861/** Driver generated WPA/RSN IE */ 1862#define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001 1863/** Driver needs static WEP key setup after association command */ 1864#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002 1865/** Driver takes care of all DFS operations */ 1866#define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004 1867/** Driver takes care of RSN 4-way handshake internally; PMK is configured with 1868 * struct wpa_driver_ops::set_key using key_flag = KEY_FLAG_PMK */ 1869#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008 1870/** Driver is for a wired Ethernet interface */ 1871#define WPA_DRIVER_FLAGS_WIRED 0x00000010 1872/** Driver provides separate commands for authentication and association (SME in 1873 * wpa_supplicant). */ 1874#define WPA_DRIVER_FLAGS_SME 0x00000020 1875/** Driver supports AP mode */ 1876#define WPA_DRIVER_FLAGS_AP 0x00000040 1877/** Driver needs static WEP key setup after association has been completed */ 1878#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080 1879/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */ 1880#define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100 1881/** Driver supports concurrent P2P operations */ 1882#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200 1883/** 1884 * Driver uses the initial interface as a dedicated management interface, i.e., 1885 * it cannot be used for P2P group operations or non-P2P purposes. 1886 */ 1887#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400 1888/** This interface is P2P capable (P2P GO or P2P Client) */ 1889#define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800 1890/** Driver supports station and key removal when stopping an AP */ 1891#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000 1892/** 1893 * Driver uses the initial interface for P2P management interface and non-P2P 1894 * purposes (e.g., connect to infra AP), but this interface cannot be used for 1895 * P2P group operations. 1896 */ 1897#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000 1898/** 1899 * Driver is known to use valid error codes, i.e., when it indicates that 1900 * something (e.g., association) fails, there was indeed a failure and the 1901 * operation does not end up getting completed successfully later. 1902 */ 1903#define WPA_DRIVER_FLAGS_VALID_ERROR_CODES 0x00004000 1904/** Driver supports off-channel TX */ 1905#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000 1906/** Driver indicates TX status events for EAPOL Data frames */ 1907#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000 1908/** Driver indicates TX status events for Deauth/Disassoc frames */ 1909#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000 1910/** Driver supports roaming (BSS selection) in firmware */ 1911#define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000 1912/** Driver supports operating as a TDLS peer */ 1913#define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000 1914/** Driver requires external TDLS setup/teardown/discovery */ 1915#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000 1916/** Driver indicates support for Probe Response offloading in AP mode */ 1917#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000 1918/** Driver supports U-APSD in AP mode */ 1919#define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000 1920/** Driver supports inactivity timer in AP mode */ 1921#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000 1922/** Driver expects user space implementation of MLME in AP mode */ 1923#define WPA_DRIVER_FLAGS_AP_MLME 0x01000000 1924/** Driver supports SAE with user space SME */ 1925#define WPA_DRIVER_FLAGS_SAE 0x02000000 1926/** Driver makes use of OBSS scan mechanism in wpa_supplicant */ 1927#define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000 1928/** Driver supports IBSS (Ad-hoc) mode */ 1929#define WPA_DRIVER_FLAGS_IBSS 0x08000000 1930/** Driver supports radar detection */ 1931#define WPA_DRIVER_FLAGS_RADAR 0x10000000 1932/** Driver supports a dedicated interface for P2P Device */ 1933#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000 1934/** Driver supports QoS Mapping */ 1935#define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000 1936/** Driver supports CSA in AP mode */ 1937#define WPA_DRIVER_FLAGS_AP_CSA 0x80000000 1938/** Driver supports mesh */ 1939#define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL 1940/** Driver support ACS offload */ 1941#define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL 1942/** Driver supports key management offload */ 1943#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL 1944/** Driver supports TDLS channel switching */ 1945#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL 1946/** Driver supports IBSS with HT datarates */ 1947#define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL 1948/** Driver supports IBSS with VHT datarates */ 1949#define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL 1950/** Driver supports automatic band selection */ 1951#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL 1952/** Driver supports simultaneous off-channel operations */ 1953#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL 1954/** Driver supports full AP client state */ 1955#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL 1956/** Driver supports P2P Listen offload */ 1957#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL 1958/** Driver supports FILS */ 1959#define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL 1960/** Driver supports Beacon frame TX rate configuration (legacy rates) */ 1961#define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL 1962/** Driver supports Beacon frame TX rate configuration (HT rates) */ 1963#define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL 1964/** Driver supports Beacon frame TX rate configuration (VHT rates) */ 1965#define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL 1966/** Driver supports mgmt_tx with random TX address in non-connected state */ 1967#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL 1968/** Driver supports mgmt_tx with random TX addr in connected state */ 1969#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL 1970/** Driver supports better BSS reporting with sched_scan in connected mode */ 1971#define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL 1972/** Driver supports HE capabilities */ 1973#define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL 1974/** Driver supports FILS shared key offload */ 1975#define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL 1976/** Driver supports all OCE STA specific mandatory features */ 1977#define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL 1978/** Driver supports all OCE AP specific mandatory features */ 1979#define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL 1980/** 1981 * Driver supports all OCE STA-CFON specific mandatory features only. 1982 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the 1983 * userspace shall assume that this driver may not support all OCE AP 1984 * functionality but can support only OCE STA-CFON functionality. 1985 */ 1986#define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL 1987/** Driver supports MFP-optional in the connect command */ 1988#define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL 1989/** Driver is a self-managed regulatory device */ 1990#define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL 1991/** Driver supports FTM responder functionality */ 1992#define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL 1993/** Driver support 4-way handshake offload for WPA-Personal */ 1994#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL 1995/** Driver supports a separate control port TX for EAPOL frames */ 1996#define WPA_DRIVER_FLAGS_CONTROL_PORT 0x0400000000000000ULL 1997/** Driver supports VLAN offload */ 1998#define WPA_DRIVER_FLAGS_VLAN_OFFLOAD 0x0800000000000000ULL 1999/** Driver supports UPDATE_FT_IES command */ 2000#define WPA_DRIVER_FLAGS_UPDATE_FT_IES 0x1000000000000000ULL 2001/** Driver can correctly rekey PTKs without Extended Key ID */ 2002#define WPA_DRIVER_FLAGS_SAFE_PTK0_REKEYS 0x2000000000000000ULL 2003/** Driver supports Beacon protection */ 2004#define WPA_DRIVER_FLAGS_BEACON_PROTECTION 0x4000000000000000ULL 2005/** Driver supports Extended Key ID */ 2006#define WPA_DRIVER_FLAGS_EXTENDED_KEY_ID 0x8000000000000000ULL 2007 u64 flags; 2008 2009/** Driver supports a separate control port RX for EAPOL frames */ 2010#define WPA_DRIVER_FLAGS2_CONTROL_PORT_RX 0x0000000000000001ULL 2011/** Driver supports TX status reports for EAPOL frames through control port */ 2012#define WPA_DRIVER_FLAGS2_CONTROL_PORT_TX_STATUS 0x0000000000000002ULL 2013/** Driver supports secure LTF */ 2014#define WPA_DRIVER_FLAGS2_SEC_LTF 0x0000000000000004ULL 2015/** Driver supports secure RTT measurement exchange */ 2016#define WPA_DRIVER_FLAGS2_SEC_RTT 0x0000000000000008ULL 2017/** 2018 * Driver supports protection of range negotiation and measurement management 2019 * frames 2020 */ 2021#define WPA_DRIVER_FLAGS2_PROT_RANGE_NEG 0x0000000000000010ULL 2022/** Driver supports Beacon frame TX rate configuration (HE rates) */ 2023#define WPA_DRIVER_FLAGS2_BEACON_RATE_HE 0x0000000000000020ULL 2024/** Driver supports Beacon protection only in client mode */ 2025#define WPA_DRIVER_FLAGS2_BEACON_PROTECTION_CLIENT 0x0000000000000040ULL 2026/** Driver supports Operating Channel Validation */ 2027#define WPA_DRIVER_FLAGS2_OCV 0x0000000000000080ULL 2028/** Driver expects user space implementation of SME in AP mode */ 2029#define WPA_DRIVER_FLAGS2_AP_SME 0x0000000000000100ULL 2030 u64 flags2; 2031 2032#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \ 2033 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE) 2034 2035 unsigned int wmm_ac_supported:1; 2036 2037 unsigned int mac_addr_rand_scan_supported:1; 2038 unsigned int mac_addr_rand_sched_scan_supported:1; 2039 2040 /** Maximum number of supported active probe SSIDs */ 2041 int max_scan_ssids; 2042 2043 /** Maximum number of supported active probe SSIDs for sched_scan */ 2044 int max_sched_scan_ssids; 2045 2046 /** Maximum number of supported scan plans for scheduled scan */ 2047 unsigned int max_sched_scan_plans; 2048 2049 /** Maximum interval in a scan plan. In seconds */ 2050 u32 max_sched_scan_plan_interval; 2051 2052 /** Maximum number of iterations in a single scan plan */ 2053 u32 max_sched_scan_plan_iterations; 2054 2055 /** Whether sched_scan (offloaded scanning) is supported */ 2056 int sched_scan_supported; 2057 2058 /** Maximum number of supported match sets for sched_scan */ 2059 int max_match_sets; 2060 2061 /** 2062 * max_remain_on_chan - Maximum remain-on-channel duration in msec 2063 */ 2064 unsigned int max_remain_on_chan; 2065 2066 /** 2067 * max_stations - Maximum number of associated stations the driver 2068 * supports in AP mode 2069 */ 2070 unsigned int max_stations; 2071 2072 /** 2073 * probe_resp_offloads - Bitmap of supported protocols by the driver 2074 * for Probe Response offloading. 2075 */ 2076/** Driver Probe Response offloading support for WPS ver. 1 */ 2077#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001 2078/** Driver Probe Response offloading support for WPS ver. 2 */ 2079#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002 2080/** Driver Probe Response offloading support for P2P */ 2081#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004 2082/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */ 2083#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008 2084 unsigned int probe_resp_offloads; 2085 2086 unsigned int max_acl_mac_addrs; 2087 2088 /** 2089 * Number of supported concurrent channels 2090 */ 2091 unsigned int num_multichan_concurrent; 2092 2093 /** 2094 * extended_capa - extended capabilities in driver/device 2095 * 2096 * Must be allocated and freed by driver and the pointers must be 2097 * valid for the lifetime of the driver, i.e., freed in deinit() 2098 */ 2099 const u8 *extended_capa, *extended_capa_mask; 2100 unsigned int extended_capa_len; 2101 2102 struct wowlan_triggers wowlan_triggers; 2103 2104/** Driver adds the DS Params Set IE in Probe Request frames */ 2105#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001 2106/** Driver adds the WFA TPC IE in Probe Request frames */ 2107#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002 2108/** Driver handles quiet period requests */ 2109#define WPA_DRIVER_FLAGS_QUIET 0x00000004 2110/** 2111 * Driver is capable of inserting the current TX power value into the body of 2112 * transmitted frames. 2113 * Background: Some Action frames include a TPC Report IE. This IE contains a 2114 * TX power field, which has to be updated by lower layers. One such Action 2115 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part 2116 * of spectrum management). Note that this insertion takes place at a fixed 2117 * offset, namely the 6th byte in the Action frame body. 2118 */ 2119#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008 2120/** 2121 * Driver supports RRM. With this support, the driver will accept to use RRM in 2122 * (Re)Association Request frames, without supporting quiet period. 2123 */ 2124#define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010 2125 2126/** Driver supports setting the scan dwell time */ 2127#define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020 2128/** Driver supports Beacon Report Measurement */ 2129#define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040 2130 2131 u32 rrm_flags; 2132 2133 /* Driver concurrency capabilities */ 2134 unsigned int conc_capab; 2135 /* Maximum number of concurrent channels on 2.4 GHz */ 2136 unsigned int max_conc_chan_2_4; 2137 /* Maximum number of concurrent channels on 5 GHz */ 2138 unsigned int max_conc_chan_5_0; 2139 2140 /* Maximum number of supported CSA counters */ 2141 u16 max_csa_counters; 2142}; 2143 2144 2145struct hostapd_data; 2146 2147#define STA_DRV_DATA_TX_MCS BIT(0) 2148#define STA_DRV_DATA_RX_MCS BIT(1) 2149#define STA_DRV_DATA_TX_VHT_MCS BIT(2) 2150#define STA_DRV_DATA_RX_VHT_MCS BIT(3) 2151#define STA_DRV_DATA_TX_VHT_NSS BIT(4) 2152#define STA_DRV_DATA_RX_VHT_NSS BIT(5) 2153#define STA_DRV_DATA_TX_SHORT_GI BIT(6) 2154#define STA_DRV_DATA_RX_SHORT_GI BIT(7) 2155#define STA_DRV_DATA_LAST_ACK_RSSI BIT(8) 2156#define STA_DRV_DATA_CONN_TIME BIT(9) 2157 2158struct hostap_sta_driver_data { 2159 unsigned long rx_packets, tx_packets; 2160 unsigned long long rx_bytes, tx_bytes; 2161 unsigned long long rx_airtime, tx_airtime; 2162 int bytes_64bit; /* whether 64-bit byte counters are supported */ 2163 unsigned long current_tx_rate; 2164 unsigned long current_rx_rate; 2165 unsigned long inactive_msec; 2166 unsigned long connected_sec; 2167 unsigned long flags; /* bitfield of STA_DRV_DATA_* */ 2168 unsigned long num_ps_buf_frames; 2169 unsigned long tx_retry_failed; 2170 unsigned long tx_retry_count; 2171 s8 last_ack_rssi; 2172 unsigned long backlog_packets; 2173 unsigned long backlog_bytes; 2174 s8 signal; 2175 u8 rx_vhtmcs; 2176 u8 tx_vhtmcs; 2177 u8 rx_mcs; 2178 u8 tx_mcs; 2179 u8 rx_vht_nss; 2180 u8 tx_vht_nss; 2181}; 2182 2183struct hostapd_sta_add_params { 2184 const u8 *addr; 2185 u16 aid; 2186 u16 capability; 2187 const u8 *supp_rates; 2188 size_t supp_rates_len; 2189 u16 listen_interval; 2190 const struct ieee80211_ht_capabilities *ht_capabilities; 2191 const struct ieee80211_vht_capabilities *vht_capabilities; 2192 int vht_opmode_enabled; 2193 u8 vht_opmode; 2194 const struct ieee80211_he_capabilities *he_capab; 2195 size_t he_capab_len; 2196 const struct ieee80211_he_6ghz_band_cap *he_6ghz_capab; 2197 u32 flags; /* bitmask of WPA_STA_* flags */ 2198 u32 flags_mask; /* unset bits in flags */ 2199#ifdef CONFIG_MESH 2200 enum mesh_plink_state plink_state; 2201 u16 peer_aid; 2202#endif /* CONFIG_MESH */ 2203 int set; /* Set STA parameters instead of add */ 2204 u8 qosinfo; 2205 const u8 *ext_capab; 2206 size_t ext_capab_len; 2207 const u8 *supp_channels; 2208 size_t supp_channels_len; 2209 const u8 *supp_oper_classes; 2210 size_t supp_oper_classes_len; 2211 int support_p2p_ps; 2212}; 2213 2214struct mac_address { 2215 u8 addr[ETH_ALEN]; 2216}; 2217 2218struct hostapd_acl_params { 2219 u8 acl_policy; 2220 unsigned int num_mac_acl; 2221 struct mac_address mac_acl[0]; 2222}; 2223 2224struct wpa_init_params { 2225 void *global_priv; 2226 const u8 *bssid; 2227 const char *ifname; 2228 const char *driver_params; 2229 int use_pae_group_addr; 2230 char **bridge; 2231 size_t num_bridge; 2232 2233 u8 *own_addr; /* buffer for writing own MAC address */ 2234}; 2235 2236 2237struct wpa_bss_params { 2238 /** Interface name (for multi-SSID/VLAN support) */ 2239 const char *ifname; 2240 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */ 2241 int enabled; 2242 2243 int wpa; 2244 int ieee802_1x; 2245 int wpa_group; 2246 int wpa_pairwise; 2247 int wpa_key_mgmt; 2248 int rsn_preauth; 2249 enum mfp_options ieee80211w; 2250}; 2251 2252#define WPA_STA_AUTHORIZED BIT(0) 2253#define WPA_STA_WMM BIT(1) 2254#define WPA_STA_SHORT_PREAMBLE BIT(2) 2255#define WPA_STA_MFP BIT(3) 2256#define WPA_STA_TDLS_PEER BIT(4) 2257#define WPA_STA_AUTHENTICATED BIT(5) 2258#define WPA_STA_ASSOCIATED BIT(6) 2259 2260enum tdls_oper { 2261 TDLS_DISCOVERY_REQ, 2262 TDLS_SETUP, 2263 TDLS_TEARDOWN, 2264 TDLS_ENABLE_LINK, 2265 TDLS_DISABLE_LINK, 2266 TDLS_ENABLE, 2267 TDLS_DISABLE 2268}; 2269 2270enum wnm_oper { 2271 WNM_SLEEP_ENTER_CONFIRM, 2272 WNM_SLEEP_ENTER_FAIL, 2273 WNM_SLEEP_EXIT_CONFIRM, 2274 WNM_SLEEP_EXIT_FAIL, 2275 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */ 2276 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */ 2277 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for 2278 * a STA */ 2279 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE 2280 * for a STA */ 2281 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */ 2282 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE 2283 * for a STA */ 2284 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */ 2285}; 2286 2287/* enum smps_mode - SMPS mode definitions */ 2288enum smps_mode { 2289 SMPS_AUTOMATIC, 2290 SMPS_OFF, 2291 SMPS_DYNAMIC, 2292 SMPS_STATIC, 2293 2294 /* Keep last */ 2295 SMPS_INVALID, 2296}; 2297 2298#define WPA_INVALID_NOISE 9999 2299 2300/** 2301 * struct wpa_signal_info - Information about channel signal quality 2302 * @frequency: control frequency 2303 * @above_threshold: true if the above threshold was crossed 2304 * (relevant for a CQM event) 2305 * @current_signal: in dBm 2306 * @avg_signal: in dBm 2307 * @avg_beacon_signal: in dBm 2308 * @current_noise: %WPA_INVALID_NOISE if not supported 2309 * @current_txrate: current TX rate 2310 * @chanwidth: channel width 2311 * @center_frq1: center frequency for the first segment 2312 * @center_frq2: center frequency for the second segment (if relevant) 2313 */ 2314struct wpa_signal_info { 2315 u32 frequency; 2316 int above_threshold; 2317 int current_signal; 2318 int avg_signal; 2319 int avg_beacon_signal; 2320 int current_noise; 2321 int current_txrate; 2322 enum chan_width chanwidth; 2323 int center_frq1; 2324 int center_frq2; 2325}; 2326 2327/** 2328 * struct wpa_channel_info - Information about the current channel 2329 * @frequency: Center frequency of the primary 20 MHz channel 2330 * @chanwidth: Width of the current operating channel 2331 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1). 2332 * This field is only filled in when using a 40 MHz channel. 2333 * @center_frq1: Center frequency of frequency segment 0 2334 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels) 2335 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is 2336 * derived from center_frq2 for convenience. 2337 */ 2338struct wpa_channel_info { 2339 u32 frequency; 2340 enum chan_width chanwidth; 2341 int sec_channel; 2342 int center_frq1; 2343 int center_frq2; 2344 u8 seg1_idx; 2345}; 2346 2347/** 2348 * struct beacon_data - Beacon data 2349 * @head: Head portion of Beacon frame (before TIM IE) 2350 * @tail: Tail portion of Beacon frame (after TIM IE) 2351 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL 2352 * @proberesp_ies: Extra information element(s) to add into Probe Response 2353 * frames or %NULL 2354 * @assocresp_ies: Extra information element(s) to add into (Re)Association 2355 * Response frames or %NULL 2356 * @probe_resp: Probe Response frame template 2357 * @head_len: Length of @head 2358 * @tail_len: Length of @tail 2359 * @beacon_ies_len: Length of beacon_ies in octets 2360 * @proberesp_ies_len: Length of proberesp_ies in octets 2361 * @proberesp_ies_len: Length of proberesp_ies in octets 2362 * @probe_resp_len: Length of probe response template (@probe_resp) 2363 */ 2364struct beacon_data { 2365 u8 *head, *tail; 2366 u8 *beacon_ies; 2367 u8 *proberesp_ies; 2368 u8 *assocresp_ies; 2369 u8 *probe_resp; 2370 2371 size_t head_len, tail_len; 2372 size_t beacon_ies_len; 2373 size_t proberesp_ies_len; 2374 size_t assocresp_ies_len; 2375 size_t probe_resp_len; 2376}; 2377 2378/** 2379 * struct csa_settings - Settings for channel switch command 2380 * @cs_count: Count in Beacon frames (TBTT) to perform the switch 2381 * @block_tx: 1 - block transmission for CSA period 2382 * @freq_params: Next channel frequency parameter 2383 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period 2384 * @beacon_after: Next beacon/probe resp/asooc resp info 2385 * @counter_offset_beacon: Offset to the count field in beacon's tail 2386 * @counter_offset_presp: Offset to the count field in probe resp. 2387 */ 2388struct csa_settings { 2389 u8 cs_count; 2390 u8 block_tx; 2391 2392 struct hostapd_freq_params freq_params; 2393 struct beacon_data beacon_csa; 2394 struct beacon_data beacon_after; 2395 2396 u16 counter_offset_beacon[2]; 2397 u16 counter_offset_presp[2]; 2398}; 2399 2400/* TDLS peer capabilities for send_tdls_mgmt() */ 2401enum tdls_peer_capability { 2402 TDLS_PEER_HT = BIT(0), 2403 TDLS_PEER_VHT = BIT(1), 2404 TDLS_PEER_WMM = BIT(2), 2405 TDLS_PEER_HE = BIT(3), 2406}; 2407 2408/* valid info in the wmm_params struct */ 2409enum wmm_params_valid_info { 2410 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0), 2411}; 2412 2413/** 2414 * struct wmm_params - WMM parameterss configured for this association 2415 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields 2416 * of the struct contain valid information. 2417 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if 2418 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set) 2419 */ 2420struct wmm_params { 2421 u8 info_bitmap; 2422 u8 uapsd_queues; 2423}; 2424 2425#ifdef CONFIG_MACSEC 2426struct macsec_init_params { 2427 bool always_include_sci; 2428 bool use_es; 2429 bool use_scb; 2430}; 2431#endif /* CONFIG_MACSEC */ 2432 2433enum drv_br_port_attr { 2434 DRV_BR_PORT_ATTR_PROXYARP, 2435 DRV_BR_PORT_ATTR_HAIRPIN_MODE, 2436}; 2437 2438enum drv_br_net_param { 2439 DRV_BR_NET_PARAM_GARP_ACCEPT, 2440 DRV_BR_MULTICAST_SNOOPING, 2441}; 2442 2443struct drv_acs_params { 2444 /* Selected mode (HOSTAPD_MODE_*) */ 2445 enum hostapd_hw_mode hw_mode; 2446 2447 /* Indicates whether HT is enabled */ 2448 int ht_enabled; 2449 2450 /* Indicates whether HT40 is enabled */ 2451 int ht40_enabled; 2452 2453 /* Indicates whether VHT is enabled */ 2454 int vht_enabled; 2455 2456 /* Configured ACS channel width */ 2457 u16 ch_width; 2458 2459 /* ACS frequency list info */ 2460 const int *freq_list; 2461 2462 /* Indicates whether EDMG is enabled */ 2463 int edmg_enabled; 2464}; 2465 2466struct wpa_bss_trans_info { 2467 u8 mbo_transition_reason; 2468 u8 n_candidates; 2469 u8 *bssid; 2470}; 2471 2472struct wpa_bss_candidate_info { 2473 u8 num; 2474 struct candidate_list { 2475 u8 bssid[ETH_ALEN]; 2476 u8 is_accept; 2477 u32 reject_reason; 2478 } *candidates; 2479}; 2480 2481struct wpa_pmkid_params { 2482 const u8 *bssid; 2483 const u8 *ssid; 2484 size_t ssid_len; 2485 const u8 *fils_cache_id; 2486 const u8 *pmkid; 2487 const u8 *pmk; 2488 size_t pmk_len; 2489 u32 pmk_lifetime; 2490 u8 pmk_reauth_threshold; 2491}; 2492 2493/* Mask used to specify which connection parameters have to be updated */ 2494enum wpa_drv_update_connect_params_mask { 2495 WPA_DRV_UPDATE_ASSOC_IES = BIT(0), 2496 WPA_DRV_UPDATE_FILS_ERP_INFO = BIT(1), 2497 WPA_DRV_UPDATE_AUTH_TYPE = BIT(2), 2498}; 2499 2500/** 2501 * struct external_auth - External authentication trigger parameters 2502 * 2503 * These are used across the external authentication request and event 2504 * interfaces. 2505 * @action: Action type / trigger for external authentication. Only significant 2506 * for the event interface. 2507 * @bssid: BSSID of the peer with which the authentication has to happen. Used 2508 * by both the request and event interface. 2509 * @ssid: SSID of the AP. Used by both the request and event interface. 2510 * @ssid_len: SSID length in octets. 2511 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for 2512 * the request interface. 2513 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication, 2514 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give 2515 * the real status code for failures. Used only for the request interface 2516 * from user space to the driver. 2517 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE). 2518 */ 2519struct external_auth { 2520 enum { 2521 EXT_AUTH_START, 2522 EXT_AUTH_ABORT, 2523 } action; 2524 const u8 *bssid; 2525 const u8 *ssid; 2526 size_t ssid_len; 2527 unsigned int key_mgmt_suite; 2528 u16 status; 2529 const u8 *pmkid; 2530}; 2531 2532/* enum nested_attr - Used to specify if subcommand uses nested attributes */ 2533enum nested_attr { 2534 NESTED_ATTR_NOT_USED = 0, 2535 NESTED_ATTR_USED = 1, 2536 NESTED_ATTR_UNSPECIFIED = 2, 2537}; 2538 2539/** 2540 * struct wpa_driver_ops - Driver interface API definition 2541 * 2542 * This structure defines the API that each driver interface needs to implement 2543 * for core wpa_supplicant code. All driver specific functionality is captured 2544 * in this wrapper. 2545 */ 2546struct wpa_driver_ops { 2547 /** Name of the driver interface */ 2548 const char *name; 2549 /** One line description of the driver interface */ 2550 const char *desc; 2551 2552 /** 2553 * get_bssid - Get the current BSSID 2554 * @priv: private driver interface data 2555 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes) 2556 * 2557 * Returns: 0 on success, -1 on failure 2558 * 2559 * Query kernel driver for the current BSSID and copy it to bssid. 2560 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not 2561 * associated. 2562 */ 2563 int (*get_bssid)(void *priv, u8 *bssid); 2564 2565 /** 2566 * get_ssid - Get the current SSID 2567 * @priv: private driver interface data 2568 * @ssid: buffer for SSID (at least 32 bytes) 2569 * 2570 * Returns: Length of the SSID on success, -1 on failure 2571 * 2572 * Query kernel driver for the current SSID and copy it to ssid. 2573 * Returning zero is recommended if the STA is not associated. 2574 * 2575 * Note: SSID is an array of octets, i.e., it is not nul terminated and 2576 * can, at least in theory, contain control characters (including nul) 2577 * and as such, should be processed as binary data, not a printable 2578 * string. 2579 */ 2580 int (*get_ssid)(void *priv, u8 *ssid); 2581 2582 /** 2583 * set_key - Configure encryption key 2584 * @priv: private driver interface data 2585 * @params: Key parameters 2586 * Returns: 0 on success, -1 on failure 2587 * 2588 * Configure the given key for the kernel driver. If the driver 2589 * supports separate individual keys (4 default keys + 1 individual), 2590 * addr can be used to determine whether the key is default or 2591 * individual. If only 4 keys are supported, the default key with key 2592 * index 0 is used as the individual key. STA must be configured to use 2593 * it as the default Tx key (set_tx is set) and accept Rx for all the 2594 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for 2595 * broadcast keys, so key index 0 is available for this kind of 2596 * configuration. 2597 * 2598 * Please note that TKIP keys include separate TX and RX MIC keys and 2599 * some drivers may expect them in different order than wpa_supplicant 2600 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets 2601 * will trigger Michael MIC errors. This can be fixed by changing the 2602 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key 2603 * in driver_*.c set_key() implementation, see driver_ndis.c for an 2604 * example on how this can be done. 2605 */ 2606 int (*set_key)(void *priv, struct wpa_driver_set_key_params *params); 2607 2608 /** 2609 * init - Initialize driver interface 2610 * @ctx: context to be used when calling wpa_supplicant functions, 2611 * e.g., wpa_supplicant_event() 2612 * @ifname: interface name, e.g., wlan0 2613 * 2614 * Returns: Pointer to private data, %NULL on failure 2615 * 2616 * Initialize driver interface, including event processing for kernel 2617 * driver events (e.g., associated, scan results, Michael MIC failure). 2618 * This function can allocate a private configuration data area for 2619 * @ctx, file descriptor, interface name, etc. information that may be 2620 * needed in future driver operations. If this is not used, non-NULL 2621 * value will need to be returned because %NULL is used to indicate 2622 * failure. The returned value will be used as 'void *priv' data for 2623 * all other driver_ops functions. 2624 * 2625 * The main event loop (eloop.c) of wpa_supplicant can be used to 2626 * register callback for read sockets (eloop_register_read_sock()). 2627 * 2628 * See below for more information about events and 2629 * wpa_supplicant_event() function. 2630 */ 2631 void * (*init)(void *ctx, const char *ifname); 2632 2633 /** 2634 * deinit - Deinitialize driver interface 2635 * @priv: private driver interface data from init() 2636 * 2637 * Shut down driver interface and processing of driver events. Free 2638 * private data buffer if one was allocated in init() handler. 2639 */ 2640 void (*deinit)(void *priv); 2641 2642 /** 2643 * set_param - Set driver configuration parameters 2644 * @priv: private driver interface data from init() 2645 * @param: driver specific configuration parameters 2646 * 2647 * Returns: 0 on success, -1 on failure 2648 * 2649 * Optional handler for notifying driver interface about configuration 2650 * parameters (driver_param). 2651 */ 2652 int (*set_param)(void *priv, const char *param); 2653 2654 /** 2655 * set_countermeasures - Enable/disable TKIP countermeasures 2656 * @priv: private driver interface data 2657 * @enabled: 1 = countermeasures enabled, 0 = disabled 2658 * 2659 * Returns: 0 on success, -1 on failure 2660 * 2661 * Configure TKIP countermeasures. When these are enabled, the driver 2662 * should drop all received and queued frames that are using TKIP. 2663 */ 2664 int (*set_countermeasures)(void *priv, int enabled); 2665 2666 /** 2667 * deauthenticate - Request driver to deauthenticate 2668 * @priv: private driver interface data 2669 * @addr: peer address (BSSID of the AP) 2670 * @reason_code: 16-bit reason code to be sent in the deauthentication 2671 * frame 2672 * 2673 * Returns: 0 on success, -1 on failure 2674 */ 2675 int (*deauthenticate)(void *priv, const u8 *addr, u16 reason_code); 2676 2677 /** 2678 * associate - Request driver to associate 2679 * @priv: private driver interface data 2680 * @params: association parameters 2681 * 2682 * Returns: 0 on success, -1 on failure 2683 */ 2684 int (*associate)(void *priv, 2685 struct wpa_driver_associate_params *params); 2686 2687 /** 2688 * add_pmkid - Add PMKSA cache entry to the driver 2689 * @priv: private driver interface data 2690 * @params: PMKSA parameters 2691 * 2692 * Returns: 0 on success, -1 on failure 2693 * 2694 * This function is called when a new PMK is received, as a result of 2695 * either normal authentication or RSN pre-authentication. The PMKSA 2696 * parameters are either a set of bssid, pmkid, and pmk; or a set of 2697 * ssid, fils_cache_id, pmkid, and pmk. 2698 * 2699 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 2700 * associate(), add_pmkid() can be used to add new PMKSA cache entries 2701 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this 2702 * driver_ops function does not need to be implemented. Likewise, if 2703 * the driver does not support WPA, this function is not needed. 2704 */ 2705 int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params); 2706 2707 /** 2708 * remove_pmkid - Remove PMKSA cache entry to the driver 2709 * @priv: private driver interface data 2710 * @params: PMKSA parameters 2711 * 2712 * Returns: 0 on success, -1 on failure 2713 * 2714 * This function is called when the supplicant drops a PMKSA cache 2715 * entry for any reason. The PMKSA parameters are either a set of 2716 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid. 2717 * 2718 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 2719 * associate(), remove_pmkid() can be used to synchronize PMKSA caches 2720 * between the driver and wpa_supplicant. If the driver uses wpa_ie 2721 * from wpa_supplicant, this driver_ops function does not need to be 2722 * implemented. Likewise, if the driver does not support WPA, this 2723 * function is not needed. 2724 */ 2725 int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params); 2726 2727 /** 2728 * flush_pmkid - Flush PMKSA cache 2729 * @priv: private driver interface data 2730 * 2731 * Returns: 0 on success, -1 on failure 2732 * 2733 * This function is called when the supplicant drops all PMKSA cache 2734 * entries for any reason. 2735 * 2736 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 2737 * associate(), remove_pmkid() can be used to synchronize PMKSA caches 2738 * between the driver and wpa_supplicant. If the driver uses wpa_ie 2739 * from wpa_supplicant, this driver_ops function does not need to be 2740 * implemented. Likewise, if the driver does not support WPA, this 2741 * function is not needed. 2742 */ 2743 int (*flush_pmkid)(void *priv); 2744 2745 /** 2746 * get_capa - Get driver capabilities 2747 * @priv: private driver interface data 2748 * 2749 * Returns: 0 on success, -1 on failure 2750 * 2751 * Get driver/firmware/hardware capabilities. 2752 */ 2753 int (*get_capa)(void *priv, struct wpa_driver_capa *capa); 2754 2755 /** 2756 * poll - Poll driver for association information 2757 * @priv: private driver interface data 2758 * 2759 * This is an option callback that can be used when the driver does not 2760 * provide event mechanism for association events. This is called when 2761 * receiving WPA EAPOL-Key messages that require association 2762 * information. The driver interface is supposed to generate associnfo 2763 * event before returning from this callback function. In addition, the 2764 * driver interface should generate an association event after having 2765 * sent out associnfo. 2766 */ 2767 void (*poll)(void *priv); 2768 2769 /** 2770 * get_ifindex - Get interface index 2771 * @priv: private driver interface data 2772 * 2773 * Returns: Interface index 2774 */ 2775 unsigned int (*get_ifindex)(void *priv); 2776 2777 /** 2778 * get_ifname - Get interface name 2779 * @priv: private driver interface data 2780 * 2781 * Returns: Pointer to the interface name. This can differ from the 2782 * interface name used in init() call. Init() is called first. 2783 * 2784 * This optional function can be used to allow the driver interface to 2785 * replace the interface name with something else, e.g., based on an 2786 * interface mapping from a more descriptive name. 2787 */ 2788 const char * (*get_ifname)(void *priv); 2789 2790 /** 2791 * get_mac_addr - Get own MAC address 2792 * @priv: private driver interface data 2793 * 2794 * Returns: Pointer to own MAC address or %NULL on failure 2795 * 2796 * This optional function can be used to get the own MAC address of the 2797 * device from the driver interface code. This is only needed if the 2798 * l2_packet implementation for the OS does not provide easy access to 2799 * a MAC address. */ 2800 const u8 * (*get_mac_addr)(void *priv); 2801 2802 /** 2803 * set_operstate - Sets device operating state to DORMANT or UP 2804 * @priv: private driver interface data 2805 * @state: 0 = dormant, 1 = up 2806 * Returns: 0 on success, -1 on failure 2807 * 2808 * This is an optional function that can be used on operating systems 2809 * that support a concept of controlling network device state from user 2810 * space applications. This function, if set, gets called with 2811 * state = 1 when authentication has been completed and with state = 0 2812 * when connection is lost. 2813 */ 2814 int (*set_operstate)(void *priv, int state); 2815 2816 /** 2817 * mlme_setprotection - MLME-SETPROTECTION.request primitive 2818 * @priv: Private driver interface data 2819 * @addr: Address of the station for which to set protection (may be 2820 * %NULL for group keys) 2821 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_* 2822 * @key_type: MLME_SETPROTECTION_KEY_TYPE_* 2823 * Returns: 0 on success, -1 on failure 2824 * 2825 * This is an optional function that can be used to set the driver to 2826 * require protection for Tx and/or Rx frames. This uses the layer 2827 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1 2828 * (MLME-SETPROTECTION.request). Many drivers do not use explicit 2829 * set protection operation; instead, they set protection implicitly 2830 * based on configured keys. 2831 */ 2832 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type, 2833 int key_type); 2834 2835 /** 2836 * get_hw_feature_data - Get hardware support data (channels and rates) 2837 * @priv: Private driver interface data 2838 * @num_modes: Variable for returning the number of returned modes 2839 * flags: Variable for returning hardware feature flags 2840 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*) 2841 * Returns: Pointer to allocated hardware data on success or %NULL on 2842 * failure. Caller is responsible for freeing this. 2843 */ 2844 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv, 2845 u16 *num_modes, 2846 u16 *flags, u8 *dfs); 2847 2848 /** 2849 * send_mlme - Send management frame from MLME 2850 * @priv: Private driver interface data 2851 * @data: IEEE 802.11 management frame with IEEE 802.11 header 2852 * @data_len: Size of the management frame 2853 * @noack: Do not wait for this frame to be acked (disable retries) 2854 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the 2855 * driver decide 2856 * @csa_offs: Array of CSA offsets or %NULL 2857 * @csa_offs_len: Number of elements in csa_offs 2858 * @no_encrypt: Do not encrypt frame even if appropriate key exists 2859 * (used only for testing purposes) 2860 * @wait: Time to wait off-channel for a response (in ms), or zero 2861 * Returns: 0 on success, -1 on failure 2862 */ 2863 int (*send_mlme)(void *priv, const u8 *data, size_t data_len, 2864 int noack, unsigned int freq, const u16 *csa_offs, 2865 size_t csa_offs_len, int no_encrypt, 2866 unsigned int wait); 2867 2868 /** 2869 * update_ft_ies - Update FT (IEEE 802.11r) IEs 2870 * @priv: Private driver interface data 2871 * @md: Mobility domain (2 octets) (also included inside ies) 2872 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs 2873 * @ies_len: Length of FT IEs in bytes 2874 * Returns: 0 on success, -1 on failure 2875 * 2876 * The supplicant uses this callback to let the driver know that keying 2877 * material for FT is available and that the driver can use the 2878 * provided IEs in the next message in FT authentication sequence. 2879 * 2880 * This function is only needed for driver that support IEEE 802.11r 2881 * (Fast BSS Transition). 2882 */ 2883 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies, 2884 size_t ies_len); 2885 2886 /** 2887 * get_scan_results2 - Fetch the latest scan results 2888 * @priv: private driver interface data 2889 * 2890 * Returns: Allocated buffer of scan results (caller is responsible for 2891 * freeing the data structure) on success, NULL on failure 2892 */ 2893 struct wpa_scan_results * (*get_scan_results2)(void *priv); 2894 2895 /** 2896 * set_country - Set country 2897 * @priv: Private driver interface data 2898 * @alpha2: country to which to switch to 2899 * Returns: 0 on success, -1 on failure 2900 * 2901 * This function is for drivers which support some form 2902 * of setting a regulatory domain. 2903 */ 2904 int (*set_country)(void *priv, const char *alpha2); 2905 2906 /** 2907 * get_country - Get country 2908 * @priv: Private driver interface data 2909 * @alpha2: Buffer for returning country code (at least 3 octets) 2910 * Returns: 0 on success, -1 on failure 2911 */ 2912 int (*get_country)(void *priv, char *alpha2); 2913 2914 /** 2915 * global_init - Global driver initialization 2916 * @ctx: wpa_global pointer 2917 * Returns: Pointer to private data (global), %NULL on failure 2918 * 2919 * This optional function is called to initialize the driver wrapper 2920 * for global data, i.e., data that applies to all interfaces. If this 2921 * function is implemented, global_deinit() will also need to be 2922 * implemented to free the private data. The driver will also likely 2923 * use init2() function instead of init() to get the pointer to global 2924 * data available to per-interface initializer. 2925 */ 2926 void * (*global_init)(void *ctx); 2927 2928 /** 2929 * global_deinit - Global driver deinitialization 2930 * @priv: private driver global data from global_init() 2931 * 2932 * Terminate any global driver related functionality and free the 2933 * global data structure. 2934 */ 2935 void (*global_deinit)(void *priv); 2936 2937 /** 2938 * init2 - Initialize driver interface (with global data) 2939 * @ctx: context to be used when calling wpa_supplicant functions, 2940 * e.g., wpa_supplicant_event() 2941 * @ifname: interface name, e.g., wlan0 2942 * @global_priv: private driver global data from global_init() 2943 * Returns: Pointer to private data, %NULL on failure 2944 * 2945 * This function can be used instead of init() if the driver wrapper 2946 * uses global data. 2947 */ 2948 void * (*init2)(void *ctx, const char *ifname, void *global_priv); 2949 2950 /** 2951 * get_interfaces - Get information about available interfaces 2952 * @global_priv: private driver global data from global_init() 2953 * Returns: Allocated buffer of interface information (caller is 2954 * responsible for freeing the data structure) on success, NULL on 2955 * failure 2956 */ 2957 struct wpa_interface_info * (*get_interfaces)(void *global_priv); 2958 2959 /** 2960 * scan2 - Request the driver to initiate scan 2961 * @priv: private driver interface data 2962 * @params: Scan parameters 2963 * 2964 * Returns: 0 on success, -1 on failure 2965 * 2966 * Once the scan results are ready, the driver should report scan 2967 * results event for wpa_supplicant which will eventually request the 2968 * results with wpa_driver_get_scan_results2(). 2969 */ 2970 int (*scan2)(void *priv, struct wpa_driver_scan_params *params); 2971 2972 /** 2973 * authenticate - Request driver to authenticate 2974 * @priv: private driver interface data 2975 * @params: authentication parameters 2976 * Returns: 0 on success, -1 on failure 2977 * 2978 * This is an optional function that can be used with drivers that 2979 * support separate authentication and association steps, i.e., when 2980 * wpa_supplicant can act as the SME. If not implemented, associate() 2981 * function is expected to take care of IEEE 802.11 authentication, 2982 * too. 2983 */ 2984 int (*authenticate)(void *priv, 2985 struct wpa_driver_auth_params *params); 2986 2987 /** 2988 * set_ap - Set Beacon and Probe Response information for AP mode 2989 * @priv: Private driver interface data 2990 * @params: Parameters to use in AP mode 2991 * 2992 * This function is used to configure Beacon template and/or extra IEs 2993 * to add for Beacon and Probe Response frames for the driver in 2994 * AP mode. The driver is responsible for building the full Beacon 2995 * frame by concatenating the head part with TIM IE generated by the 2996 * driver/firmware and finishing with the tail part. Depending on the 2997 * driver architectue, this can be done either by using the full 2998 * template or the set of additional IEs (e.g., WPS and P2P IE). 2999 * Similarly, Probe Response processing depends on the driver design. 3000 * If the driver (or firmware) takes care of replying to Probe Request 3001 * frames, the extra IEs provided here needs to be added to the Probe 3002 * Response frames. 3003 * 3004 * Returns: 0 on success, -1 on failure 3005 */ 3006 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params); 3007 3008 /** 3009 * set_acl - Set ACL in AP mode 3010 * @priv: Private driver interface data 3011 * @params: Parameters to configure ACL 3012 * Returns: 0 on success, -1 on failure 3013 * 3014 * This is used only for the drivers which support MAC address ACL. 3015 */ 3016 int (*set_acl)(void *priv, struct hostapd_acl_params *params); 3017 3018 /** 3019 * hapd_init - Initialize driver interface (hostapd only) 3020 * @hapd: Pointer to hostapd context 3021 * @params: Configuration for the driver wrapper 3022 * Returns: Pointer to private data, %NULL on failure 3023 * 3024 * This function is used instead of init() or init2() when the driver 3025 * wrapper is used with hostapd. 3026 */ 3027 void * (*hapd_init)(struct hostapd_data *hapd, 3028 struct wpa_init_params *params); 3029 3030 /** 3031 * hapd_deinit - Deinitialize driver interface (hostapd only) 3032 * @priv: Private driver interface data from hapd_init() 3033 */ 3034 void (*hapd_deinit)(void *priv); 3035 3036 /** 3037 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only) 3038 * @priv: Private driver interface data 3039 * @params: BSS parameters 3040 * Returns: 0 on success, -1 on failure 3041 * 3042 * This is an optional function to configure the kernel driver to 3043 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This 3044 * can be left undefined (set to %NULL) if IEEE 802.1X support is 3045 * always enabled and the driver uses set_ap() to set WPA/RSN IE 3046 * for Beacon frames. 3047 * 3048 * DEPRECATED - use set_ap() instead 3049 */ 3050 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params); 3051 3052 /** 3053 * set_privacy - Enable/disable privacy (AP only) 3054 * @priv: Private driver interface data 3055 * @enabled: 1 = privacy enabled, 0 = disabled 3056 * Returns: 0 on success, -1 on failure 3057 * 3058 * This is an optional function to configure privacy field in the 3059 * kernel driver for Beacon frames. This can be left undefined (set to 3060 * %NULL) if the driver uses the Beacon template from set_ap(). 3061 * 3062 * DEPRECATED - use set_ap() instead 3063 */ 3064 int (*set_privacy)(void *priv, int enabled); 3065 3066 /** 3067 * get_seqnum - Fetch the current TSC/packet number (AP only) 3068 * @ifname: The interface name (main or virtual) 3069 * @priv: Private driver interface data 3070 * @addr: MAC address of the station or %NULL for group keys 3071 * @idx: Key index 3072 * @seq: Buffer for returning the latest used TSC/packet number 3073 * Returns: 0 on success, -1 on failure 3074 * 3075 * This function is used to fetch the last used TSC/packet number for 3076 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group 3077 * keys, so there is no strict requirement on implementing support for 3078 * unicast keys (i.e., addr != %NULL). 3079 */ 3080 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr, 3081 int idx, u8 *seq); 3082 3083 /** 3084 * flush - Flush all association stations (AP only) 3085 * @priv: Private driver interface data 3086 * Returns: 0 on success, -1 on failure 3087 * 3088 * This function requests the driver to disassociate all associated 3089 * stations. This function does not need to be implemented if the 3090 * driver does not process association frames internally. 3091 */ 3092 int (*flush)(void *priv); 3093 3094 /** 3095 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP) 3096 * @priv: Private driver interface data 3097 * @elem: Information elements 3098 * @elem_len: Length of the elem buffer in octets 3099 * Returns: 0 on success, -1 on failure 3100 * 3101 * This is an optional function to add information elements in the 3102 * kernel driver for Beacon and Probe Response frames. This can be left 3103 * undefined (set to %NULL) if the driver uses the Beacon template from 3104 * set_ap(). 3105 * 3106 * DEPRECATED - use set_ap() instead 3107 */ 3108 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len); 3109 3110 /** 3111 * read_sta_data - Fetch station data 3112 * @priv: Private driver interface data 3113 * @data: Buffer for returning station information 3114 * @addr: MAC address of the station 3115 * Returns: 0 on success, -1 on failure 3116 */ 3117 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data, 3118 const u8 *addr); 3119 3120 /** 3121 * tx_control_port - Send a frame over the 802.1X controlled port 3122 * @priv: Private driver interface data 3123 * @dest: Destination MAC address 3124 * @proto: Ethertype in host byte order 3125 * @buf: Frame payload starting from IEEE 802.1X header 3126 * @len: Frame payload length 3127 * @no_encrypt: Do not encrypt frame 3128 * 3129 * Returns 0 on success, else an error 3130 * 3131 * This is like a normal Ethernet send except that the driver is aware 3132 * (by other means than the Ethertype) that this frame is special, 3133 * and more importantly it gains an ordering between the transmission of 3134 * the frame and other driver management operations such as key 3135 * installations. This can be used to work around known limitations in 3136 * IEEE 802.11 protocols such as race conditions between rekeying 4-way 3137 * handshake message 4/4 and a PTK being overwritten. 3138 * 3139 * This function is only used for a given interface if the driver 3140 * instance reports WPA_DRIVER_FLAGS_CONTROL_PORT capability. Otherwise, 3141 * API users will fall back to sending the frame via a normal socket. 3142 */ 3143 int (*tx_control_port)(void *priv, const u8 *dest, 3144 u16 proto, const u8 *buf, size_t len, 3145 int no_encrypt); 3146 3147 /** 3148 * hapd_send_eapol - Send an EAPOL packet (AP only) 3149 * @priv: private driver interface data 3150 * @addr: Destination MAC address 3151 * @data: EAPOL packet starting with IEEE 802.1X header 3152 * @data_len: Length of the EAPOL packet in octets 3153 * @encrypt: Whether the frame should be encrypted 3154 * @own_addr: Source MAC address 3155 * @flags: WPA_STA_* flags for the destination station 3156 * 3157 * Returns: 0 on success, -1 on failure 3158 */ 3159 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data, 3160 size_t data_len, int encrypt, 3161 const u8 *own_addr, u32 flags); 3162 3163 /** 3164 * sta_deauth - Deauthenticate a station (AP only) 3165 * @priv: Private driver interface data 3166 * @own_addr: Source address and BSSID for the Deauthentication frame 3167 * @addr: MAC address of the station to deauthenticate 3168 * @reason: Reason code for the Deauthentiation frame 3169 * Returns: 0 on success, -1 on failure 3170 * 3171 * This function requests a specific station to be deauthenticated and 3172 * a Deauthentication frame to be sent to it. 3173 */ 3174 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr, 3175 u16 reason); 3176 3177 /** 3178 * sta_disassoc - Disassociate a station (AP only) 3179 * @priv: Private driver interface data 3180 * @own_addr: Source address and BSSID for the Disassociation frame 3181 * @addr: MAC address of the station to disassociate 3182 * @reason: Reason code for the Disassociation frame 3183 * Returns: 0 on success, -1 on failure 3184 * 3185 * This function requests a specific station to be disassociated and 3186 * a Disassociation frame to be sent to it. 3187 */ 3188 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr, 3189 u16 reason); 3190 3191 /** 3192 * sta_remove - Remove a station entry (AP only) 3193 * @priv: Private driver interface data 3194 * @addr: MAC address of the station to be removed 3195 * Returns: 0 on success, -1 on failure 3196 */ 3197 int (*sta_remove)(void *priv, const u8 *addr); 3198 3199 /** 3200 * hapd_get_ssid - Get the current SSID (AP only) 3201 * @priv: Private driver interface data 3202 * @buf: Buffer for returning the SSID 3203 * @len: Maximum length of the buffer 3204 * Returns: Length of the SSID on success, -1 on failure 3205 * 3206 * This function need not be implemented if the driver uses Beacon 3207 * template from set_ap() and does not reply to Probe Request frames. 3208 */ 3209 int (*hapd_get_ssid)(void *priv, u8 *buf, int len); 3210 3211 /** 3212 * hapd_set_ssid - Set SSID (AP only) 3213 * @priv: Private driver interface data 3214 * @buf: SSID 3215 * @len: Length of the SSID in octets 3216 * Returns: 0 on success, -1 on failure 3217 * 3218 * DEPRECATED - use set_ap() instead 3219 */ 3220 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len); 3221 3222 /** 3223 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP) 3224 * @priv: Private driver interface data 3225 * @enabled: 1 = countermeasures enabled, 0 = disabled 3226 * Returns: 0 on success, -1 on failure 3227 * 3228 * This need not be implemented if the driver does not take care of 3229 * association processing. 3230 */ 3231 int (*hapd_set_countermeasures)(void *priv, int enabled); 3232 3233 /** 3234 * sta_add - Add a station entry 3235 * @priv: Private driver interface data 3236 * @params: Station parameters 3237 * Returns: 0 on success, -1 on failure 3238 * 3239 * This function is used to add or set (params->set 1) a station 3240 * entry in the driver. Adding STA entries is used only if the driver 3241 * does not take care of association processing. 3242 * 3243 * With drivers that don't support full AP client state, this function 3244 * is used to add a station entry to the driver once the station has 3245 * completed association. 3246 * 3247 * With TDLS, this function is used to add or set (params->set 1) 3248 * TDLS peer entries (even with drivers that do not support full AP 3249 * client state). 3250 */ 3251 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params); 3252 3253 /** 3254 * get_inact_sec - Get station inactivity duration (AP only) 3255 * @priv: Private driver interface data 3256 * @addr: Station address 3257 * Returns: Number of seconds station has been inactive, -1 on failure 3258 */ 3259 int (*get_inact_sec)(void *priv, const u8 *addr); 3260 3261 /** 3262 * sta_clear_stats - Clear station statistics (AP only) 3263 * @priv: Private driver interface data 3264 * @addr: Station address 3265 * Returns: 0 on success, -1 on failure 3266 */ 3267 int (*sta_clear_stats)(void *priv, const u8 *addr); 3268 3269 /** 3270 * set_freq - Set channel/frequency (AP only) 3271 * @priv: Private driver interface data 3272 * @freq: Channel parameters 3273 * Returns: 0 on success, -1 on failure 3274 */ 3275 int (*set_freq)(void *priv, struct hostapd_freq_params *freq); 3276 3277 /** 3278 * set_rts - Set RTS threshold 3279 * @priv: Private driver interface data 3280 * @rts: RTS threshold in octets 3281 * Returns: 0 on success, -1 on failure 3282 */ 3283 int (*set_rts)(void *priv, int rts); 3284 3285 /** 3286 * set_frag - Set fragmentation threshold 3287 * @priv: Private driver interface data 3288 * @frag: Fragmentation threshold in octets 3289 * Returns: 0 on success, -1 on failure 3290 */ 3291 int (*set_frag)(void *priv, int frag); 3292 3293 /** 3294 * sta_set_flags - Set station flags (AP only) 3295 * @priv: Private driver interface data 3296 * @addr: Station address 3297 * @total_flags: Bitmap of all WPA_STA_* flags currently set 3298 * @flags_or: Bitmap of WPA_STA_* flags to add 3299 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask 3300 * Returns: 0 on success, -1 on failure 3301 */ 3302 int (*sta_set_flags)(void *priv, const u8 *addr, 3303 unsigned int total_flags, unsigned int flags_or, 3304 unsigned int flags_and); 3305 3306 /** 3307 * sta_set_airtime_weight - Set station airtime weight (AP only) 3308 * @priv: Private driver interface data 3309 * @addr: Station address 3310 * @weight: New weight for station airtime assignment 3311 * Returns: 0 on success, -1 on failure 3312 */ 3313 int (*sta_set_airtime_weight)(void *priv, const u8 *addr, 3314 unsigned int weight); 3315 3316 /** 3317 * set_tx_queue_params - Set TX queue parameters 3318 * @priv: Private driver interface data 3319 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK) 3320 * @aifs: AIFS 3321 * @cw_min: cwMin 3322 * @cw_max: cwMax 3323 * @burst_time: Maximum length for bursting in 0.1 msec units 3324 */ 3325 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min, 3326 int cw_max, int burst_time); 3327 3328 /** 3329 * if_add - Add a virtual interface 3330 * @priv: Private driver interface data 3331 * @type: Interface type 3332 * @ifname: Interface name for the new virtual interface 3333 * @addr: Local address to use for the interface or %NULL to use the 3334 * parent interface address 3335 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces 3336 * @drv_priv: Pointer for overwriting the driver context or %NULL if 3337 * not allowed (applies only to %WPA_IF_AP_BSS type) 3338 * @force_ifname: Buffer for returning an interface name that the 3339 * driver ended up using if it differs from the requested ifname 3340 * @if_addr: Buffer for returning the allocated interface address 3341 * (this may differ from the requested addr if the driver cannot 3342 * change interface address) 3343 * @bridge: Bridge interface to use or %NULL if no bridge configured 3344 * @use_existing: Whether to allow existing interface to be used 3345 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces 3346 * Returns: 0 on success, -1 on failure 3347 */ 3348 int (*if_add)(void *priv, enum wpa_driver_if_type type, 3349 const char *ifname, const u8 *addr, void *bss_ctx, 3350 void **drv_priv, char *force_ifname, u8 *if_addr, 3351 const char *bridge, int use_existing, int setup_ap); 3352 3353 /** 3354 * if_remove - Remove a virtual interface 3355 * @priv: Private driver interface data 3356 * @type: Interface type 3357 * @ifname: Interface name of the virtual interface to be removed 3358 * Returns: 0 on success, -1 on failure 3359 */ 3360 int (*if_remove)(void *priv, enum wpa_driver_if_type type, 3361 const char *ifname); 3362 3363 /** 3364 * set_sta_vlan - Bind a station into a specific interface (AP only) 3365 * @priv: Private driver interface data 3366 * @ifname: Interface (main or virtual BSS or VLAN) 3367 * @addr: MAC address of the associated station 3368 * @vlan_id: VLAN ID 3369 * Returns: 0 on success, -1 on failure 3370 * 3371 * This function is used to bind a station to a specific virtual 3372 * interface. It is only used if when virtual interfaces are supported, 3373 * e.g., to assign stations to different VLAN interfaces based on 3374 * information from a RADIUS server. This allows separate broadcast 3375 * domains to be used with a single BSS. 3376 */ 3377 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname, 3378 int vlan_id); 3379 3380 /** 3381 * commit - Optional commit changes handler (AP only) 3382 * @priv: driver private data 3383 * Returns: 0 on success, -1 on failure 3384 * 3385 * This optional handler function can be registered if the driver 3386 * interface implementation needs to commit changes (e.g., by setting 3387 * network interface up) at the end of initial configuration. If set, 3388 * this handler will be called after initial setup has been completed. 3389 */ 3390 int (*commit)(void *priv); 3391 3392 /** 3393 * set_radius_acl_auth - Notification of RADIUS ACL change 3394 * @priv: Private driver interface data 3395 * @mac: MAC address of the station 3396 * @accepted: Whether the station was accepted 3397 * @session_timeout: Session timeout for the station 3398 * Returns: 0 on success, -1 on failure 3399 */ 3400 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted, 3401 u32 session_timeout); 3402 3403 /** 3404 * set_radius_acl_expire - Notification of RADIUS ACL expiration 3405 * @priv: Private driver interface data 3406 * @mac: MAC address of the station 3407 * Returns: 0 on success, -1 on failure 3408 */ 3409 int (*set_radius_acl_expire)(void *priv, const u8 *mac); 3410 3411 /** 3412 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP) 3413 * @priv: Private driver interface data 3414 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s) 3415 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove 3416 * extra IE(s) 3417 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL 3418 * to remove extra IE(s) 3419 * Returns: 0 on success, -1 on failure 3420 * 3421 * This is an optional function to add WPS IE in the kernel driver for 3422 * Beacon and Probe Response frames. This can be left undefined (set 3423 * to %NULL) if the driver uses the Beacon template from set_ap() 3424 * and does not process Probe Request frames. If the driver takes care 3425 * of (Re)Association frame processing, the assocresp buffer includes 3426 * WPS IE(s) that need to be added to (Re)Association Response frames 3427 * whenever a (Re)Association Request frame indicated use of WPS. 3428 * 3429 * This will also be used to add P2P IE(s) into Beacon/Probe Response 3430 * frames when operating as a GO. The driver is responsible for adding 3431 * timing related attributes (e.g., NoA) in addition to the IEs 3432 * included here by appending them after these buffers. This call is 3433 * also used to provide Probe Response IEs for P2P Listen state 3434 * operations for drivers that generate the Probe Response frames 3435 * internally. 3436 * 3437 * DEPRECATED - use set_ap() instead 3438 */ 3439 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon, 3440 const struct wpabuf *proberesp, 3441 const struct wpabuf *assocresp); 3442 3443 /** 3444 * set_supp_port - Set IEEE 802.1X Supplicant Port status 3445 * @priv: Private driver interface data 3446 * @authorized: Whether the port is authorized 3447 * Returns: 0 on success, -1 on failure 3448 */ 3449 int (*set_supp_port)(void *priv, int authorized); 3450 3451 /** 3452 * set_wds_sta - Bind a station into a 4-address WDS (AP only) 3453 * @priv: Private driver interface data 3454 * @addr: MAC address of the associated station 3455 * @aid: Association ID 3456 * @val: 1 = bind to 4-address WDS; 0 = unbind 3457 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL 3458 * to indicate that bridge is not to be used 3459 * @ifname_wds: Buffer to return the interface name for the new WDS 3460 * station or %NULL to indicate name is not returned. 3461 * Returns: 0 on success, -1 on failure 3462 */ 3463 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val, 3464 const char *bridge_ifname, char *ifname_wds); 3465 3466 /** 3467 * send_action - Transmit an Action frame 3468 * @priv: Private driver interface data 3469 * @freq: Frequency (in MHz) of the channel 3470 * @wait: Time to wait off-channel for a response (in ms), or zero 3471 * @dst: Destination MAC address (Address 1) 3472 * @src: Source MAC address (Address 2) 3473 * @bssid: BSSID (Address 3) 3474 * @data: Frame body 3475 * @data_len: data length in octets 3476 @ @no_cck: Whether CCK rates must not be used to transmit this frame 3477 * Returns: 0 on success, -1 on failure 3478 * 3479 * This command can be used to request the driver to transmit an action 3480 * frame to the specified destination. 3481 * 3482 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will 3483 * be transmitted on the given channel and the device will wait for a 3484 * response on that channel for the given wait time. 3485 * 3486 * If the flag is not set, the wait time will be ignored. In this case, 3487 * if a remain-on-channel duration is in progress, the frame must be 3488 * transmitted on that channel; alternatively the frame may be sent on 3489 * the current operational channel (if in associated state in station 3490 * mode or while operating as an AP.) 3491 * 3492 * If @src differs from the device MAC address, use of a random 3493 * transmitter address is requested for this message exchange. 3494 */ 3495 int (*send_action)(void *priv, unsigned int freq, unsigned int wait, 3496 const u8 *dst, const u8 *src, const u8 *bssid, 3497 const u8 *data, size_t data_len, int no_cck); 3498 3499 /** 3500 * send_action_cancel_wait - Cancel action frame TX wait 3501 * @priv: Private driver interface data 3502 * 3503 * This command cancels the wait time associated with sending an action 3504 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is 3505 * set in the driver flags. 3506 */ 3507 void (*send_action_cancel_wait)(void *priv); 3508 3509 /** 3510 * remain_on_channel - Remain awake on a channel 3511 * @priv: Private driver interface data 3512 * @freq: Frequency (in MHz) of the channel 3513 * @duration: Duration in milliseconds 3514 * Returns: 0 on success, -1 on failure 3515 * 3516 * This command is used to request the driver to remain awake on the 3517 * specified channel for the specified duration and report received 3518 * Action frames with EVENT_RX_MGMT events. Optionally, received 3519 * Probe Request frames may also be requested to be reported by calling 3520 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ. 3521 * 3522 * The driver may not be at the requested channel when this function 3523 * returns, i.e., the return code is only indicating whether the 3524 * request was accepted. The caller will need to wait until the 3525 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has 3526 * completed the channel change. This may take some time due to other 3527 * need for the radio and the caller should be prepared to timing out 3528 * its wait since there are no guarantees on when this request can be 3529 * executed. 3530 */ 3531 int (*remain_on_channel)(void *priv, unsigned int freq, 3532 unsigned int duration); 3533 3534 /** 3535 * cancel_remain_on_channel - Cancel remain-on-channel operation 3536 * @priv: Private driver interface data 3537 * 3538 * This command can be used to cancel a remain-on-channel operation 3539 * before its originally requested duration has passed. This could be 3540 * used, e.g., when remain_on_channel() is used to request extra time 3541 * to receive a response to an Action frame and the response is 3542 * received when there is still unneeded time remaining on the 3543 * remain-on-channel operation. 3544 */ 3545 int (*cancel_remain_on_channel)(void *priv); 3546 3547 /** 3548 * probe_req_report - Request Probe Request frames to be indicated 3549 * @priv: Private driver interface data 3550 * @report: Whether to report received Probe Request frames 3551 * Returns: 0 on success, -1 on failure (or if not supported) 3552 * 3553 * This command can be used to request the driver to indicate when 3554 * Probe Request frames are received with EVENT_RX_PROBE_REQ events. 3555 * Since this operation may require extra resources, e.g., due to less 3556 * optimal hardware/firmware RX filtering, many drivers may disable 3557 * Probe Request reporting at least in station mode. This command is 3558 * used to notify the driver when the Probe Request frames need to be 3559 * reported, e.g., during remain-on-channel operations. 3560 */ 3561 int (*probe_req_report)(void *priv, int report); 3562 3563 /** 3564 * deinit_ap - Deinitialize AP mode 3565 * @priv: Private driver interface data 3566 * Returns: 0 on success, -1 on failure (or if not supported) 3567 * 3568 * This optional function can be used to disable AP mode related 3569 * configuration. If the interface was not dynamically added, 3570 * change the driver mode to station mode to allow normal station 3571 * operations like scanning to be completed. 3572 */ 3573 int (*deinit_ap)(void *priv); 3574 3575 /** 3576 * deinit_p2p_cli - Deinitialize P2P client mode 3577 * @priv: Private driver interface data 3578 * Returns: 0 on success, -1 on failure (or if not supported) 3579 * 3580 * This optional function can be used to disable P2P client mode. If the 3581 * interface was not dynamically added, change the interface type back 3582 * to station mode. 3583 */ 3584 int (*deinit_p2p_cli)(void *priv); 3585 3586 /** 3587 * suspend - Notification on system suspend/hibernate event 3588 * @priv: Private driver interface data 3589 */ 3590 void (*suspend)(void *priv); 3591 3592 /** 3593 * resume - Notification on system resume/thaw event 3594 * @priv: Private driver interface data 3595 */ 3596 void (*resume)(void *priv); 3597 3598 /** 3599 * signal_monitor - Set signal monitoring parameters 3600 * @priv: Private driver interface data 3601 * @threshold: Threshold value for signal change events; 0 = disabled 3602 * @hysteresis: Minimum change in signal strength before indicating a 3603 * new event 3604 * Returns: 0 on success, -1 on failure (or if not supported) 3605 * 3606 * This function can be used to configure monitoring of signal strength 3607 * with the current AP. Whenever signal strength drops below the 3608 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event 3609 * should be generated assuming the signal strength has changed at 3610 * least %hysteresis from the previously indicated signal change event. 3611 */ 3612 int (*signal_monitor)(void *priv, int threshold, int hysteresis); 3613 3614 /** 3615 * get_noa - Get current Notice of Absence attribute payload 3616 * @priv: Private driver interface data 3617 * @buf: Buffer for returning NoA 3618 * @buf_len: Buffer length in octets 3619 * Returns: Number of octets used in buf, 0 to indicate no NoA is being 3620 * advertized, or -1 on failure 3621 * 3622 * This function is used to fetch the current Notice of Absence 3623 * attribute value from GO. 3624 */ 3625 int (*get_noa)(void *priv, u8 *buf, size_t buf_len); 3626 3627 /** 3628 * set_noa - Set Notice of Absence parameters for GO (testing) 3629 * @priv: Private driver interface data 3630 * @count: Count 3631 * @start: Start time in ms from next TBTT 3632 * @duration: Duration in ms 3633 * Returns: 0 on success or -1 on failure 3634 * 3635 * This function is used to set Notice of Absence parameters for GO. It 3636 * is used only for testing. To disable NoA, all parameters are set to 3637 * 0. 3638 */ 3639 int (*set_noa)(void *priv, u8 count, int start, int duration); 3640 3641 /** 3642 * set_p2p_powersave - Set P2P power save options 3643 * @priv: Private driver interface data 3644 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change 3645 * @opp_ps: 0 = disable, 1 = enable, -1 = no change 3646 * @ctwindow: 0.. = change (msec), -1 = no change 3647 * Returns: 0 on success or -1 on failure 3648 */ 3649 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps, 3650 int ctwindow); 3651 3652 /** 3653 * ampdu - Enable/disable aggregation 3654 * @priv: Private driver interface data 3655 * @ampdu: 1/0 = enable/disable A-MPDU aggregation 3656 * Returns: 0 on success or -1 on failure 3657 */ 3658 int (*ampdu)(void *priv, int ampdu); 3659 3660 /** 3661 * get_radio_name - Get physical radio name for the device 3662 * @priv: Private driver interface data 3663 * Returns: Radio name or %NULL if not known 3664 * 3665 * The returned data must not be modified by the caller. It is assumed 3666 * that any interface that has the same radio name as another is 3667 * sharing the same physical radio. This information can be used to 3668 * share scan results etc. information between the virtual interfaces 3669 * to speed up various operations. 3670 */ 3671 const char * (*get_radio_name)(void *priv); 3672 3673 /** 3674 * send_tdls_mgmt - for sending TDLS management packets 3675 * @priv: private driver interface data 3676 * @dst: Destination (peer) MAC address 3677 * @action_code: TDLS action code for the mssage 3678 * @dialog_token: Dialog Token to use in the message (if needed) 3679 * @status_code: Status Code or Reason Code to use (if needed) 3680 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield) 3681 * @initiator: Is the current end the TDLS link initiator 3682 * @buf: TDLS IEs to add to the message 3683 * @len: Length of buf in octets 3684 * Returns: 0 on success, negative (<0) on failure 3685 * 3686 * This optional function can be used to send packet to driver which is 3687 * responsible for receiving and sending all TDLS packets. 3688 */ 3689 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code, 3690 u8 dialog_token, u16 status_code, u32 peer_capab, 3691 int initiator, const u8 *buf, size_t len); 3692 3693 /** 3694 * tdls_oper - Ask the driver to perform high-level TDLS operations 3695 * @priv: Private driver interface data 3696 * @oper: TDLS high-level operation. See %enum tdls_oper 3697 * @peer: Destination (peer) MAC address 3698 * Returns: 0 on success, negative (<0) on failure 3699 * 3700 * This optional function can be used to send high-level TDLS commands 3701 * to the driver. 3702 */ 3703 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer); 3704 3705 /** 3706 * wnm_oper - Notify driver of the WNM frame reception 3707 * @priv: Private driver interface data 3708 * @oper: WNM operation. See %enum wnm_oper 3709 * @peer: Destination (peer) MAC address 3710 * @buf: Buffer for the driver to fill in (for getting IE) 3711 * @buf_len: Return the len of buf 3712 * Returns: 0 on success, negative (<0) on failure 3713 */ 3714 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer, 3715 u8 *buf, u16 *buf_len); 3716 3717 /** 3718 * set_qos_map - Set QoS Map 3719 * @priv: Private driver interface data 3720 * @qos_map_set: QoS Map 3721 * @qos_map_set_len: Length of QoS Map 3722 */ 3723 int (*set_qos_map)(void *priv, const u8 *qos_map_set, 3724 u8 qos_map_set_len); 3725 3726 /** 3727 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table 3728 * @priv: Private driver interface data 3729 * @version: IP version of the IP address, 4 or 6 3730 * @ipaddr: IP address for the neigh entry 3731 * @prefixlen: IP address prefix length 3732 * @addr: Corresponding MAC address 3733 * Returns: 0 on success, negative (<0) on failure 3734 */ 3735 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr, 3736 int prefixlen, const u8 *addr); 3737 3738 /** 3739 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table 3740 * @priv: Private driver interface data 3741 * @version: IP version of the IP address, 4 or 6 3742 * @ipaddr: IP address for the neigh entry 3743 * Returns: 0 on success, negative (<0) on failure 3744 */ 3745 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr); 3746 3747 /** 3748 * br_port_set_attr - Set a bridge port attribute 3749 * @attr: Bridge port attribute to set 3750 * @val: Value to be set 3751 * Returns: 0 on success, negative (<0) on failure 3752 */ 3753 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr, 3754 unsigned int val); 3755 3756 /** 3757 * br_port_set_attr - Set a bridge network parameter 3758 * @param: Bridge parameter to set 3759 * @val: Value to be set 3760 * Returns: 0 on success, negative (<0) on failure 3761 */ 3762 int (*br_set_net_param)(void *priv, enum drv_br_net_param param, 3763 unsigned int val); 3764 3765 /** 3766 * get_wowlan - Get wake-on-wireless status 3767 * @priv: Private driver interface data 3768 */ 3769 int (*get_wowlan)(void *priv); 3770 3771 /** 3772 * set_wowlan - Set wake-on-wireless triggers 3773 * @priv: Private driver interface data 3774 * @triggers: wowlan triggers 3775 */ 3776 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers); 3777 3778 /** 3779 * signal_poll - Get current connection information 3780 * @priv: Private driver interface data 3781 * @signal_info: Connection info structure 3782 */ 3783 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info); 3784 3785 /** 3786 * channel_info - Get parameters of the current operating channel 3787 * @priv: Private driver interface data 3788 * @channel_info: Channel info structure 3789 * Returns: 0 on success, negative (<0) on failure 3790 */ 3791 int (*channel_info)(void *priv, struct wpa_channel_info *channel_info); 3792 3793 /** 3794 * set_authmode - Set authentication algorithm(s) for static WEP 3795 * @priv: Private driver interface data 3796 * @authmode: 1=Open System, 2=Shared Key, 3=both 3797 * Returns: 0 on success, -1 on failure 3798 * 3799 * This function can be used to set authentication algorithms for AP 3800 * mode when static WEP is used. If the driver uses user space MLME/SME 3801 * implementation, there is no need to implement this function. 3802 * 3803 * DEPRECATED - use set_ap() instead 3804 */ 3805 int (*set_authmode)(void *priv, int authmode); 3806 3807#ifdef ANDROID 3808 /** 3809 * driver_cmd - Execute driver-specific command 3810 * @priv: Private driver interface data 3811 * @cmd: Command to execute 3812 * @buf: Return buffer 3813 * @buf_len: Buffer length 3814 * Returns: 0 on success, -1 on failure 3815 */ 3816 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len); 3817#endif /* ANDROID */ 3818 3819 /** 3820 * vendor_cmd - Execute vendor specific command 3821 * @priv: Private driver interface data 3822 * @vendor_id: Vendor id 3823 * @subcmd: Vendor command id 3824 * @nested_attr_flag: Specifies if vendor subcommand uses nested 3825 * attributes or not 3826 * @data: Vendor command parameters (%NULL if no parameters) 3827 * @data_len: Data length 3828 * @buf: Return buffer (%NULL to ignore reply) 3829 * Returns: 0 on success, negative (<0) on failure 3830 * 3831 * This function handles vendor specific commands that are passed to 3832 * the driver/device. The command is identified by vendor id and 3833 * command id. The nested_attr_flag specifies whether the subcommand 3834 * uses nested attributes or not. Parameters can be passed 3835 * as argument to the command in the data buffer. Reply (if any) will be 3836 * filled in the supplied return buffer. 3837 * 3838 * The exact driver behavior is driver interface and vendor specific. As 3839 * an example, this will be converted to a vendor specific cfg80211 3840 * command in case of the nl80211 driver interface. 3841 */ 3842 int (*vendor_cmd)(void *priv, unsigned int vendor_id, 3843 unsigned int subcmd, const u8 *data, size_t data_len, 3844 enum nested_attr nested_attr_flag, 3845 struct wpabuf *buf); 3846 3847 /** 3848 * set_rekey_info - Set rekey information 3849 * @priv: Private driver interface data 3850 * @kek: Current KEK 3851 * @kek_len: KEK length in octets 3852 * @kck: Current KCK 3853 * @kck_len: KCK length in octets 3854 * @replay_ctr: Current EAPOL-Key Replay Counter 3855 * 3856 * This optional function can be used to provide information for the 3857 * driver/firmware to process EAPOL-Key frames in Group Key Handshake 3858 * while the host (including wpa_supplicant) is sleeping. 3859 */ 3860 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len, 3861 const u8 *kck, size_t kck_len, 3862 const u8 *replay_ctr); 3863 3864 /** 3865 * sta_assoc - Station association indication 3866 * @priv: Private driver interface data 3867 * @own_addr: Source address and BSSID for association frame 3868 * @addr: MAC address of the station to associate 3869 * @reassoc: flag to indicate re-association 3870 * @status: association response status code 3871 * @ie: assoc response ie buffer 3872 * @len: ie buffer length 3873 * Returns: 0 on success, -1 on failure 3874 * 3875 * This function indicates the driver to send (Re)Association 3876 * Response frame to the station. 3877 */ 3878 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr, 3879 int reassoc, u16 status, const u8 *ie, size_t len); 3880 3881 /** 3882 * sta_auth - Station authentication indication 3883 * @priv: private driver interface data 3884 * @params: Station authentication parameters 3885 * 3886 * Returns: 0 on success, -1 on failure 3887 */ 3888 int (*sta_auth)(void *priv, 3889 struct wpa_driver_sta_auth_params *params); 3890 3891 /** 3892 * add_tspec - Add traffic stream 3893 * @priv: Private driver interface data 3894 * @addr: MAC address of the station to associate 3895 * @tspec_ie: tspec ie buffer 3896 * @tspec_ielen: tspec ie length 3897 * Returns: 0 on success, -1 on failure 3898 * 3899 * This function adds the traffic steam for the station 3900 * and fills the medium_time in tspec_ie. 3901 */ 3902 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie, 3903 size_t tspec_ielen); 3904 3905 /** 3906 * add_sta_node - Add a station node in the driver 3907 * @priv: Private driver interface data 3908 * @addr: MAC address of the station to add 3909 * @auth_alg: authentication algorithm used by the station 3910 * Returns: 0 on success, -1 on failure 3911 * 3912 * This function adds the station node in the driver, when 3913 * the station gets added by FT-over-DS. 3914 */ 3915 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg); 3916 3917 /** 3918 * sched_scan - Request the driver to initiate scheduled scan 3919 * @priv: Private driver interface data 3920 * @params: Scan parameters 3921 * Returns: 0 on success, -1 on failure 3922 * 3923 * This operation should be used for scheduled scan offload to 3924 * the hardware. Every time scan results are available, the 3925 * driver should report scan results event for wpa_supplicant 3926 * which will eventually request the results with 3927 * wpa_driver_get_scan_results2(). This operation is optional 3928 * and if not provided or if it returns -1, we fall back to 3929 * normal host-scheduled scans. 3930 */ 3931 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params); 3932 3933 /** 3934 * stop_sched_scan - Request the driver to stop a scheduled scan 3935 * @priv: Private driver interface data 3936 * Returns: 0 on success, -1 on failure 3937 * 3938 * This should cause the scheduled scan to be stopped and 3939 * results should stop being sent. Must be supported if 3940 * sched_scan is supported. 3941 */ 3942 int (*stop_sched_scan)(void *priv); 3943 3944 /** 3945 * poll_client - Probe (null data or such) the given station 3946 * @priv: Private driver interface data 3947 * @own_addr: MAC address of sending interface 3948 * @addr: MAC address of the station to probe 3949 * @qos: Indicates whether station is QoS station 3950 * 3951 * This function is used to verify whether an associated station is 3952 * still present. This function does not need to be implemented if the 3953 * driver provides such inactivity polling mechanism. 3954 */ 3955 void (*poll_client)(void *priv, const u8 *own_addr, 3956 const u8 *addr, int qos); 3957 3958 /** 3959 * radio_disable - Disable/enable radio 3960 * @priv: Private driver interface data 3961 * @disabled: 1=disable 0=enable radio 3962 * Returns: 0 on success, -1 on failure 3963 * 3964 * This optional command is for testing purposes. It can be used to 3965 * disable the radio on a testbed device to simulate out-of-radio-range 3966 * conditions. 3967 */ 3968 int (*radio_disable)(void *priv, int disabled); 3969 3970 /** 3971 * switch_channel - Announce channel switch and migrate the GO to the 3972 * given frequency 3973 * @priv: Private driver interface data 3974 * @settings: Settings for CSA period and new channel 3975 * Returns: 0 on success, -1 on failure 3976 * 3977 * This function is used to move the GO to the legacy STA channel to 3978 * avoid frequency conflict in single channel concurrency. 3979 */ 3980 int (*switch_channel)(void *priv, struct csa_settings *settings); 3981 3982 /** 3983 * add_tx_ts - Add traffic stream 3984 * @priv: Private driver interface data 3985 * @tsid: Traffic stream ID 3986 * @addr: Receiver address 3987 * @user_prio: User priority of the traffic stream 3988 * @admitted_time: Admitted time for this TS in units of 3989 * 32 microsecond periods (per second). 3990 * Returns: 0 on success, -1 on failure 3991 */ 3992 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio, 3993 u16 admitted_time); 3994 3995 /** 3996 * del_tx_ts - Delete traffic stream 3997 * @priv: Private driver interface data 3998 * @tsid: Traffic stream ID 3999 * @addr: Receiver address 4000 * Returns: 0 on success, -1 on failure 4001 */ 4002 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr); 4003 4004 /** 4005 * Enable channel-switching with TDLS peer 4006 * @priv: Private driver interface data 4007 * @addr: MAC address of the TDLS peer 4008 * @oper_class: Operating class of the switch channel 4009 * @params: Channel specification 4010 * Returns: 0 on success, -1 on failure 4011 * 4012 * The function indicates to driver that it can start switching to a 4013 * different channel with a specified TDLS peer. The switching is 4014 * assumed on until canceled with tdls_disable_channel_switch(). 4015 */ 4016 int (*tdls_enable_channel_switch)( 4017 void *priv, const u8 *addr, u8 oper_class, 4018 const struct hostapd_freq_params *params); 4019 4020 /** 4021 * Disable channel switching with TDLS peer 4022 * @priv: Private driver interface data 4023 * @addr: MAC address of the TDLS peer 4024 * Returns: 0 on success, -1 on failure 4025 * 4026 * This function indicates to the driver that it should stop switching 4027 * with a given TDLS peer. 4028 */ 4029 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr); 4030 4031 /** 4032 * start_dfs_cac - Listen for radar interference on the channel 4033 * @priv: Private driver interface data 4034 * @freq: Channel parameters 4035 * Returns: 0 on success, -1 on failure 4036 */ 4037 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq); 4038 4039 /** 4040 * stop_ap - Removes beacon from AP 4041 * @priv: Private driver interface data 4042 * Returns: 0 on success, -1 on failure (or if not supported) 4043 * 4044 * This optional function can be used to disable AP mode related 4045 * configuration. Unlike deinit_ap, it does not change to station 4046 * mode. 4047 */ 4048 int (*stop_ap)(void *priv); 4049 4050 /** 4051 * get_survey - Retrieve survey data 4052 * @priv: Private driver interface data 4053 * @freq: If set, survey data for the specified frequency is only 4054 * being requested. If not set, all survey data is requested. 4055 * Returns: 0 on success, -1 on failure 4056 * 4057 * Use this to retrieve: 4058 * 4059 * - the observed channel noise floor 4060 * - the amount of time we have spent on the channel 4061 * - the amount of time during which we have spent on the channel that 4062 * the radio has determined the medium is busy and we cannot 4063 * transmit 4064 * - the amount of time we have spent receiving data 4065 * - the amount of time we have spent transmitting data 4066 * 4067 * This data can be used for spectrum heuristics. One example is 4068 * Automatic Channel Selection (ACS). The channel survey data is 4069 * kept on a linked list on the channel data, one entry is added 4070 * for each survey. The min_nf of the channel is updated for each 4071 * survey. 4072 */ 4073 int (*get_survey)(void *priv, unsigned int freq); 4074 4075 /** 4076 * status - Get driver interface status information 4077 * @priv: Private driver interface data 4078 * @buf: Buffer for printing the status information 4079 * @buflen: Maximum length of the buffer 4080 * Returns: Length of written status information or -1 on failure 4081 */ 4082 int (*status)(void *priv, char *buf, size_t buflen); 4083 4084 /** 4085 * roaming - Set roaming policy for driver-based BSS selection 4086 * @priv: Private driver interface data 4087 * @allowed: Whether roaming within ESS is allowed 4088 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set 4089 * Returns: Length of written status information or -1 on failure 4090 * 4091 * This optional callback can be used to update roaming policy from the 4092 * associate() command (bssid being set there indicates that the driver 4093 * should not roam before getting this roaming() call to allow roaming. 4094 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION 4095 * capability, roaming policy is handled within wpa_supplicant and there 4096 * is no need to implement or react to this callback. 4097 */ 4098 int (*roaming)(void *priv, int allowed, const u8 *bssid); 4099 4100 /** 4101 * disable_fils - Enable/disable FILS feature 4102 * @priv: Private driver interface data 4103 * @disable: 0-enable and 1-disable FILS feature 4104 * Returns: 0 on success, -1 on failure 4105 * 4106 * This callback can be used to configure driver and below layers to 4107 * enable/disable all FILS features. 4108 */ 4109 int (*disable_fils)(void *priv, int disable); 4110 4111 /** 4112 * set_mac_addr - Set MAC address 4113 * @priv: Private driver interface data 4114 * @addr: MAC address to use or %NULL for setting back to permanent 4115 * Returns: 0 on success, -1 on failure 4116 */ 4117 int (*set_mac_addr)(void *priv, const u8 *addr); 4118 4119#ifdef CONFIG_MACSEC 4120 int (*macsec_init)(void *priv, struct macsec_init_params *params); 4121 4122 int (*macsec_deinit)(void *priv); 4123 4124 /** 4125 * macsec_get_capability - Inform MKA of this driver's capability 4126 * @priv: Private driver interface data 4127 * @cap: Driver's capability 4128 * Returns: 0 on success, -1 on failure 4129 */ 4130 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap); 4131 4132 /** 4133 * enable_protect_frames - Set protect frames status 4134 * @priv: Private driver interface data 4135 * @enabled: true = protect frames enabled 4136 * false = protect frames disabled 4137 * Returns: 0 on success, -1 on failure (or if not supported) 4138 */ 4139 int (*enable_protect_frames)(void *priv, bool enabled); 4140 4141 /** 4142 * enable_encrypt - Set encryption status 4143 * @priv: Private driver interface data 4144 * @enabled: true = encrypt outgoing traffic 4145 * false = integrity-only protection on outgoing traffic 4146 * Returns: 0 on success, -1 on failure (or if not supported) 4147 */ 4148 int (*enable_encrypt)(void *priv, bool enabled); 4149 4150 /** 4151 * set_replay_protect - Set replay protect status and window size 4152 * @priv: Private driver interface data 4153 * @enabled: true = replay protect enabled 4154 * false = replay protect disabled 4155 * @window: replay window size, valid only when replay protect enabled 4156 * Returns: 0 on success, -1 on failure (or if not supported) 4157 */ 4158 int (*set_replay_protect)(void *priv, bool enabled, u32 window); 4159 4160 /** 4161 * set_current_cipher_suite - Set current cipher suite 4162 * @priv: Private driver interface data 4163 * @cs: EUI64 identifier 4164 * Returns: 0 on success, -1 on failure (or if not supported) 4165 */ 4166 int (*set_current_cipher_suite)(void *priv, u64 cs); 4167 4168 /** 4169 * enable_controlled_port - Set controlled port status 4170 * @priv: Private driver interface data 4171 * @enabled: true = controlled port enabled 4172 * false = controlled port disabled 4173 * Returns: 0 on success, -1 on failure (or if not supported) 4174 */ 4175 int (*enable_controlled_port)(void *priv, bool enabled); 4176 4177 /** 4178 * get_receive_lowest_pn - Get receive lowest pn 4179 * @priv: Private driver interface data 4180 * @sa: secure association 4181 * Returns: 0 on success, -1 on failure (or if not supported) 4182 */ 4183 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa); 4184 4185 /** 4186 * get_transmit_next_pn - Get transmit next pn 4187 * @priv: Private driver interface data 4188 * @sa: secure association 4189 * Returns: 0 on success, -1 on failure (or if not supported) 4190 */ 4191 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa); 4192 4193 /** 4194 * set_transmit_next_pn - Set transmit next pn 4195 * @priv: Private driver interface data 4196 * @sa: secure association 4197 * Returns: 0 on success, -1 on failure (or if not supported) 4198 */ 4199 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa); 4200 4201 /** 4202 * set_receive_lowest_pn - Set receive lowest PN 4203 * @priv: Private driver interface data 4204 * @sa: secure association 4205 * Returns: 0 on success, -1 on failure (or if not supported) 4206 */ 4207 int (*set_receive_lowest_pn)(void *priv, struct receive_sa *sa); 4208 4209 /** 4210 * create_receive_sc - create secure channel for receiving 4211 * @priv: Private driver interface data 4212 * @sc: secure channel 4213 * @conf_offset: confidentiality offset (0, 30, or 50) 4214 * @validation: frame validation policy (0 = Disabled, 1 = Checked, 4215 * 2 = Strict) 4216 * Returns: 0 on success, -1 on failure (or if not supported) 4217 */ 4218 int (*create_receive_sc)(void *priv, struct receive_sc *sc, 4219 unsigned int conf_offset, 4220 int validation); 4221 4222 /** 4223 * delete_receive_sc - delete secure connection for receiving 4224 * @priv: private driver interface data from init() 4225 * @sc: secure channel 4226 * Returns: 0 on success, -1 on failure 4227 */ 4228 int (*delete_receive_sc)(void *priv, struct receive_sc *sc); 4229 4230 /** 4231 * create_receive_sa - create secure association for receive 4232 * @priv: private driver interface data from init() 4233 * @sa: secure association 4234 * Returns: 0 on success, -1 on failure 4235 */ 4236 int (*create_receive_sa)(void *priv, struct receive_sa *sa); 4237 4238 /** 4239 * delete_receive_sa - Delete secure association for receive 4240 * @priv: Private driver interface data from init() 4241 * @sa: Secure association 4242 * Returns: 0 on success, -1 on failure 4243 */ 4244 int (*delete_receive_sa)(void *priv, struct receive_sa *sa); 4245 4246 /** 4247 * enable_receive_sa - enable the SA for receive 4248 * @priv: private driver interface data from init() 4249 * @sa: secure association 4250 * Returns: 0 on success, -1 on failure 4251 */ 4252 int (*enable_receive_sa)(void *priv, struct receive_sa *sa); 4253 4254 /** 4255 * disable_receive_sa - disable SA for receive 4256 * @priv: private driver interface data from init() 4257 * @sa: secure association 4258 * Returns: 0 on success, -1 on failure 4259 */ 4260 int (*disable_receive_sa)(void *priv, struct receive_sa *sa); 4261 4262 /** 4263 * create_transmit_sc - create secure connection for transmit 4264 * @priv: private driver interface data from init() 4265 * @sc: secure channel 4266 * @conf_offset: confidentiality offset (0, 30, or 50) 4267 * Returns: 0 on success, -1 on failure 4268 */ 4269 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc, 4270 unsigned int conf_offset); 4271 4272 /** 4273 * delete_transmit_sc - delete secure connection for transmit 4274 * @priv: private driver interface data from init() 4275 * @sc: secure channel 4276 * Returns: 0 on success, -1 on failure 4277 */ 4278 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc); 4279 4280 /** 4281 * create_transmit_sa - create secure association for transmit 4282 * @priv: private driver interface data from init() 4283 * @sa: secure association 4284 * Returns: 0 on success, -1 on failure 4285 */ 4286 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa); 4287 4288 /** 4289 * delete_transmit_sa - Delete secure association for transmit 4290 * @priv: Private driver interface data from init() 4291 * @sa: Secure association 4292 * Returns: 0 on success, -1 on failure 4293 */ 4294 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa); 4295 4296 /** 4297 * enable_transmit_sa - enable SA for transmit 4298 * @priv: private driver interface data from init() 4299 * @sa: secure association 4300 * Returns: 0 on success, -1 on failure 4301 */ 4302 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa); 4303 4304 /** 4305 * disable_transmit_sa - disable SA for transmit 4306 * @priv: private driver interface data from init() 4307 * @sa: secure association 4308 * Returns: 0 on success, -1 on failure 4309 */ 4310 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa); 4311#endif /* CONFIG_MACSEC */ 4312 4313 /** 4314 * init_mesh - Driver specific initialization for mesh 4315 * @priv: Private driver interface data 4316 * Returns: 0 on success, -1 on failure 4317 */ 4318 int (*init_mesh)(void *priv); 4319 4320 /** 4321 * join_mesh - Join a mesh network 4322 * @priv: Private driver interface data 4323 * @params: Mesh configuration parameters 4324 * Returns: 0 on success, -1 on failure 4325 */ 4326 int (*join_mesh)(void *priv, 4327 struct wpa_driver_mesh_join_params *params); 4328 4329 /** 4330 * leave_mesh - Leave a mesh network 4331 * @priv: Private driver interface data 4332 * Returns 0 on success, -1 on failure 4333 */ 4334 int (*leave_mesh)(void *priv); 4335 4336 /** 4337 * probe_mesh_link - Inject a frame over direct mesh link to a given 4338 * peer skipping the next_hop lookup from mpath table. 4339 * @priv: Private driver interface data 4340 * @addr: Peer MAC address 4341 * @eth: Ethernet frame to be sent 4342 * @len: Ethernet frame lengtn in bytes 4343 * Returns 0 on success, -1 on failure 4344 */ 4345 int (*probe_mesh_link)(void *priv, const u8 *addr, const u8 *eth, 4346 size_t len); 4347 4348 /** 4349 * do_acs - Automatically select channel 4350 * @priv: Private driver interface data 4351 * @params: Parameters for ACS 4352 * Returns 0 on success, -1 on failure 4353 * 4354 * This command can be used to offload ACS to the driver if the driver 4355 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD). 4356 */ 4357 int (*do_acs)(void *priv, struct drv_acs_params *params); 4358 4359 /** 4360 * set_band - Notify driver of band(s) selection 4361 * @priv: Private driver interface data 4362 * @band_mask: The selected band(s) bit mask (from enum set_band) 4363 * Returns 0 on success, -1 on failure 4364 */ 4365 int (*set_band)(void *priv, u32 band_mask); 4366 4367 /** 4368 * get_pref_freq_list - Get preferred frequency list for an interface 4369 * @priv: Private driver interface data 4370 * @if_type: Interface type 4371 * @num: Number of channels 4372 * @freq_list: Preferred channel frequency list encoded in MHz values 4373 * Returns 0 on success, -1 on failure 4374 * 4375 * This command can be used to query the preferred frequency list from 4376 * the driver specific to a particular interface type. 4377 */ 4378 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type, 4379 unsigned int *num, unsigned int *freq_list); 4380 4381 /** 4382 * set_prob_oper_freq - Indicate probable P2P operating channel 4383 * @priv: Private driver interface data 4384 * @freq: Channel frequency in MHz 4385 * Returns 0 on success, -1 on failure 4386 * 4387 * This command can be used to inform the driver of the operating 4388 * frequency that an ongoing P2P group formation is likely to come up 4389 * on. Local device is assuming P2P Client role. 4390 */ 4391 int (*set_prob_oper_freq)(void *priv, unsigned int freq); 4392 4393 /** 4394 * abort_scan - Request the driver to abort an ongoing scan 4395 * @priv: Private driver interface data 4396 * @scan_cookie: Cookie identifying the scan request. This is used only 4397 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN 4398 * was used to trigger scan. Otherwise, 0 is used. 4399 * Returns 0 on success, -1 on failure 4400 */ 4401 int (*abort_scan)(void *priv, u64 scan_cookie); 4402 4403 /** 4404 * configure_data_frame_filters - Request to configure frame filters 4405 * @priv: Private driver interface data 4406 * @filter_flags: The type of frames to filter (bitfield of 4407 * WPA_DATA_FRAME_FILTER_FLAG_*) 4408 * Returns: 0 on success or -1 on failure 4409 */ 4410 int (*configure_data_frame_filters)(void *priv, u32 filter_flags); 4411 4412 /** 4413 * get_ext_capab - Get extended capabilities for the specified interface 4414 * @priv: Private driver interface data 4415 * @type: Interface type for which to get extended capabilities 4416 * @ext_capab: Extended capabilities fetched 4417 * @ext_capab_mask: Extended capabilities mask 4418 * @ext_capab_len: Length of the extended capabilities 4419 * Returns: 0 on success or -1 on failure 4420 */ 4421 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type, 4422 const u8 **ext_capab, const u8 **ext_capab_mask, 4423 unsigned int *ext_capab_len); 4424 4425 /** 4426 * p2p_lo_start - Start offloading P2P listen to device 4427 * @priv: Private driver interface data 4428 * @freq: Listening frequency (MHz) for P2P listen 4429 * @period: Length of the listen operation in milliseconds 4430 * @interval: Interval for running the listen operation in milliseconds 4431 * @count: Number of times to run the listen operation 4432 * @device_types: Device primary and secondary types 4433 * @dev_types_len: Number of bytes for device_types 4434 * @ies: P2P IE and WSC IE for Probe Response frames 4435 * @ies_len: Length of ies in bytes 4436 * Returns: 0 on success or -1 on failure 4437 */ 4438 int (*p2p_lo_start)(void *priv, unsigned int freq, 4439 unsigned int period, unsigned int interval, 4440 unsigned int count, 4441 const u8 *device_types, size_t dev_types_len, 4442 const u8 *ies, size_t ies_len); 4443 4444 /** 4445 * p2p_lo_stop - Stop P2P listen offload 4446 * @priv: Private driver interface data 4447 * Returns: 0 on success or -1 on failure 4448 */ 4449 int (*p2p_lo_stop)(void *priv); 4450 4451 /** 4452 * set_default_scan_ies - Set default scan IEs 4453 * @priv: Private driver interface data 4454 * @ies: Scan default IEs buffer 4455 * @ies_len: Length of IEs in bytes 4456 * Returns: 0 on success or -1 on failure 4457 * 4458 * The driver can use these by default when there are no scan IEs coming 4459 * in the subsequent scan requests. Also in case of one or more of IEs 4460 * given in set_default_scan_ies() are missing in the subsequent scan 4461 * request, the driver should merge the missing scan IEs in the scan 4462 * request from the IEs set by set_default_scan_ies() in the Probe 4463 * Request frames sent. 4464 */ 4465 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len); 4466 4467 /** 4468 * set_tdls_mode - Set TDLS trigger mode to the host driver 4469 * @priv: Private driver interface data 4470 * @tdls_external_control: Represents if TDLS external trigger control 4471 * mode is enabled/disabled. 4472 * 4473 * This optional callback can be used to configure the TDLS external 4474 * trigger control mode to the host driver. 4475 */ 4476 int (*set_tdls_mode)(void *priv, int tdls_external_control); 4477 4478 /** 4479 * get_bss_transition_status - Get candidate BSS's transition status 4480 * @priv: Private driver interface data 4481 * @params: Candidate BSS list 4482 * 4483 * Get the accept or reject reason code for a list of BSS transition 4484 * candidates. 4485 */ 4486 struct wpa_bss_candidate_info * 4487 (*get_bss_transition_status)(void *priv, 4488 struct wpa_bss_trans_info *params); 4489 /** 4490 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow 4491 * @priv: Private driver interface data 4492 * @ignore_disallow: 0 to not ignore, 1 to ignore 4493 * Returns: 0 on success, -1 on failure 4494 */ 4495 int (*ignore_assoc_disallow)(void *priv, int ignore_disallow); 4496 4497 /** 4498 * set_bssid_tmp_disallow - Set disallowed BSSIDs to the driver 4499 * @priv: Private driver interface data 4500 * @num_bssid: Number of temporarily disallowed BSSIDs 4501 * @bssids: List of temporarily disallowed BSSIDs 4502 */ 4503 int (*set_bssid_tmp_disallow)(void *priv, unsigned int num_bssid, 4504 const u8 *bssid); 4505 4506 /** 4507 * update_connect_params - Update the connection parameters 4508 * @priv: Private driver interface data 4509 * @params: Association parameters 4510 * @mask: Bit mask indicating which parameters in @params have to be 4511 * updated 4512 * Returns: 0 on success, -1 on failure 4513 * 4514 * Update the connection parameters when in connected state so that the 4515 * driver uses the updated parameters for subsequent roaming. This is 4516 * used only with drivers that implement internal BSS selection and 4517 * roaming. 4518 */ 4519 int (*update_connect_params)( 4520 void *priv, struct wpa_driver_associate_params *params, 4521 enum wpa_drv_update_connect_params_mask mask); 4522 4523 /** 4524 * send_external_auth_status - Indicate the status of external 4525 * authentication processing to the host driver. 4526 * @priv: Private driver interface data 4527 * @params: Status of authentication processing. 4528 * Returns: 0 on success, -1 on failure 4529 */ 4530 int (*send_external_auth_status)(void *priv, 4531 struct external_auth *params); 4532 4533 /** 4534 * set_4addr_mode - Set 4-address mode 4535 * @priv: Private driver interface data 4536 * @bridge_ifname: Bridge interface name 4537 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode 4538 * Returns: 0 on success, < 0 on failure 4539 */ 4540 int (*set_4addr_mode)(void *priv, const char *bridge_ifname, int val); 4541 4542 /** 4543 * update_dh_ie - Update DH IE 4544 * @priv: Private driver interface data 4545 * @peer_mac: Peer MAC address 4546 * @reason_code: Reacon code 4547 * @ie: DH IE 4548 * @ie_len: DH IE length in bytes 4549 * Returns: 0 on success, -1 on failure 4550 * 4551 * This callback is used to let the driver know the DH processing result 4552 * and DH IE for a pending association. 4553 */ 4554 int (*update_dh_ie)(void *priv, const u8 *peer_mac, u16 reason_code, 4555 const u8 *ie, size_t ie_len); 4556 4557 /** 4558 * dpp_listen - Notify driver about start/stop of DPP listen 4559 * @priv: Private driver interface data 4560 * @enable: Whether listen state is enabled (or disabled) 4561 * Returns: 0 on success, -1 on failure 4562 * 4563 * This optional callback can be used to update RX frame filtering to 4564 * explicitly allow reception of broadcast Public Action frames. 4565 */ 4566 int (*dpp_listen)(void *priv, bool enable); 4567 4568#ifdef CONFIG_TESTING_OPTIONS 4569 int (*register_frame)(void *priv, u16 type, 4570 const u8 *match, size_t match_len, 4571 bool multicast); 4572#endif /* CONFIG_TESTING_OPTIONS */ 4573}; 4574 4575/** 4576 * enum wpa_event_type - Event type for wpa_supplicant_event() calls 4577 */ 4578enum wpa_event_type { 4579 /** 4580 * EVENT_ASSOC - Association completed 4581 * 4582 * This event needs to be delivered when the driver completes IEEE 4583 * 802.11 association or reassociation successfully. 4584 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID 4585 * after this event has been generated. In addition, optional 4586 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide 4587 * more information about the association. If the driver interface gets 4588 * both of these events at the same time, it can also include the 4589 * assoc_info data in EVENT_ASSOC call. 4590 */ 4591 EVENT_ASSOC, 4592 4593 /** 4594 * EVENT_DISASSOC - Association lost 4595 * 4596 * This event should be called when association is lost either due to 4597 * receiving deauthenticate or disassociate frame from the AP or when 4598 * sending either of these frames to the current AP. If the driver 4599 * supports separate deauthentication event, EVENT_DISASSOC should only 4600 * be used for disassociation and EVENT_DEAUTH for deauthentication. 4601 * In AP mode, union wpa_event_data::disassoc_info is required. 4602 */ 4603 EVENT_DISASSOC, 4604 4605 /** 4606 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected 4607 * 4608 * This event must be delivered when a Michael MIC error is detected by 4609 * the local driver. Additional data for event processing is 4610 * provided with union wpa_event_data::michael_mic_failure. This 4611 * information is used to request new encyption key and to initiate 4612 * TKIP countermeasures if needed. 4613 */ 4614 EVENT_MICHAEL_MIC_FAILURE, 4615 4616 /** 4617 * EVENT_SCAN_RESULTS - Scan results available 4618 * 4619 * This event must be called whenever scan results are available to be 4620 * fetched with struct wpa_driver_ops::get_scan_results(). This event 4621 * is expected to be used some time after struct wpa_driver_ops::scan() 4622 * is called. If the driver provides an unsolicited event when the scan 4623 * has been completed, this event can be used to trigger 4624 * EVENT_SCAN_RESULTS call. If such event is not available from the 4625 * driver, the driver wrapper code is expected to use a registered 4626 * timeout to generate EVENT_SCAN_RESULTS call after the time that the 4627 * scan is expected to be completed. Optional information about 4628 * completed scan can be provided with union wpa_event_data::scan_info. 4629 */ 4630 EVENT_SCAN_RESULTS, 4631 4632 /** 4633 * EVENT_ASSOCINFO - Report optional extra information for association 4634 * 4635 * This event can be used to report extra association information for 4636 * EVENT_ASSOC processing. This extra information includes IEs from 4637 * association frames and Beacon/Probe Response frames in union 4638 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before 4639 * EVENT_ASSOC. Alternatively, the driver interface can include 4640 * assoc_info data in the EVENT_ASSOC call if it has all the 4641 * information available at the same point. 4642 */ 4643 EVENT_ASSOCINFO, 4644 4645 /** 4646 * EVENT_INTERFACE_STATUS - Report interface status changes 4647 * 4648 * This optional event can be used to report changes in interface 4649 * status (interface added/removed) using union 4650 * wpa_event_data::interface_status. This can be used to trigger 4651 * wpa_supplicant to stop and re-start processing for the interface, 4652 * e.g., when a cardbus card is ejected/inserted. 4653 */ 4654 EVENT_INTERFACE_STATUS, 4655 4656 /** 4657 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication 4658 * 4659 * This event can be used to inform wpa_supplicant about candidates for 4660 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible 4661 * for scan request (ap_scan=2 mode), this event is required for 4662 * pre-authentication. If wpa_supplicant is performing scan request 4663 * (ap_scan=1), this event is optional since scan results can be used 4664 * to add pre-authentication candidates. union 4665 * wpa_event_data::pmkid_candidate is used to report the BSSID of the 4666 * candidate and priority of the candidate, e.g., based on the signal 4667 * strength, in order to try to pre-authenticate first with candidates 4668 * that are most likely targets for re-association. 4669 * 4670 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates 4671 * on the candidate list. In addition, it can be called for the current 4672 * AP and APs that have existing PMKSA cache entries. wpa_supplicant 4673 * will automatically skip pre-authentication in cases where a valid 4674 * PMKSA exists. When more than one candidate exists, this event should 4675 * be generated once for each candidate. 4676 * 4677 * Driver will be notified about successful pre-authentication with 4678 * struct wpa_driver_ops::add_pmkid() calls. 4679 */ 4680 EVENT_PMKID_CANDIDATE, 4681 4682 /** 4683 * EVENT_TDLS - Request TDLS operation 4684 * 4685 * This event can be used to request a TDLS operation to be performed. 4686 */ 4687 EVENT_TDLS, 4688 4689 /** 4690 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs 4691 * 4692 * The driver is expected to report the received FT IEs from 4693 * FT authentication sequence from the AP. The FT IEs are included in 4694 * the extra information in union wpa_event_data::ft_ies. 4695 */ 4696 EVENT_FT_RESPONSE, 4697 4698 /** 4699 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS 4700 * 4701 * The driver can use this event to inform wpa_supplicant about a STA 4702 * in an IBSS with which protected frames could be exchanged. This 4703 * event starts RSN authentication with the other STA to authenticate 4704 * the STA and set up encryption keys with it. 4705 */ 4706 EVENT_IBSS_RSN_START, 4707 4708 /** 4709 * EVENT_AUTH - Authentication result 4710 * 4711 * This event should be called when authentication attempt has been 4712 * completed. This is only used if the driver supports separate 4713 * authentication step (struct wpa_driver_ops::authenticate). 4714 * Information about authentication result is included in 4715 * union wpa_event_data::auth. 4716 */ 4717 EVENT_AUTH, 4718 4719 /** 4720 * EVENT_DEAUTH - Authentication lost 4721 * 4722 * This event should be called when authentication is lost either due 4723 * to receiving deauthenticate frame from the AP or when sending that 4724 * frame to the current AP. 4725 * In AP mode, union wpa_event_data::deauth_info is required. 4726 */ 4727 EVENT_DEAUTH, 4728 4729 /** 4730 * EVENT_ASSOC_REJECT - Association rejected 4731 * 4732 * This event should be called when (re)association attempt has been 4733 * rejected by the AP. Information about the association response is 4734 * included in union wpa_event_data::assoc_reject. 4735 */ 4736 EVENT_ASSOC_REJECT, 4737 4738 /** 4739 * EVENT_AUTH_TIMED_OUT - Authentication timed out 4740 */ 4741 EVENT_AUTH_TIMED_OUT, 4742 4743 /** 4744 * EVENT_ASSOC_TIMED_OUT - Association timed out 4745 */ 4746 EVENT_ASSOC_TIMED_OUT, 4747 4748 /** 4749 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS 4750 */ 4751 EVENT_WPS_BUTTON_PUSHED, 4752 4753 /** 4754 * EVENT_TX_STATUS - Report TX status 4755 */ 4756 EVENT_TX_STATUS, 4757 4758 /** 4759 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA 4760 */ 4761 EVENT_RX_FROM_UNKNOWN, 4762 4763 /** 4764 * EVENT_RX_MGMT - Report RX of a management frame 4765 */ 4766 EVENT_RX_MGMT, 4767 4768 /** 4769 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started 4770 * 4771 * This event is used to indicate when the driver has started the 4772 * requested remain-on-channel duration. Information about the 4773 * operation is included in union wpa_event_data::remain_on_channel. 4774 */ 4775 EVENT_REMAIN_ON_CHANNEL, 4776 4777 /** 4778 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out 4779 * 4780 * This event is used to indicate when the driver has completed 4781 * remain-on-channel duration, i.e., may noot be available on the 4782 * requested channel anymore. Information about the 4783 * operation is included in union wpa_event_data::remain_on_channel. 4784 */ 4785 EVENT_CANCEL_REMAIN_ON_CHANNEL, 4786 4787 /** 4788 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame 4789 * 4790 * This event is used to indicate when a Probe Request frame has been 4791 * received. Information about the received frame is included in 4792 * union wpa_event_data::rx_probe_req. The driver is required to report 4793 * these events only after successfully completed probe_req_report() 4794 * commands to request the events (i.e., report parameter is non-zero) 4795 * in station mode. In AP mode, Probe Request frames should always be 4796 * reported. 4797 */ 4798 EVENT_RX_PROBE_REQ, 4799 4800 /** 4801 * EVENT_NEW_STA - New wired device noticed 4802 * 4803 * This event is used to indicate that a new device has been detected 4804 * in a network that does not use association-like functionality (i.e., 4805 * mainly wired Ethernet). This can be used to start EAPOL 4806 * authenticator when receiving a frame from a device. The address of 4807 * the device is included in union wpa_event_data::new_sta. 4808 */ 4809 EVENT_NEW_STA, 4810 4811 /** 4812 * EVENT_EAPOL_RX - Report received EAPOL frame 4813 * 4814 * When in AP mode with hostapd, this event is required to be used to 4815 * deliver the receive EAPOL frames from the driver. 4816 */ 4817 EVENT_EAPOL_RX, 4818 4819 /** 4820 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength 4821 * 4822 * This event is used to indicate changes in the signal strength 4823 * observed in frames received from the current AP if signal strength 4824 * monitoring has been enabled with signal_monitor(). 4825 */ 4826 EVENT_SIGNAL_CHANGE, 4827 4828 /** 4829 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled 4830 * 4831 * This event is used to indicate that the interface was enabled after 4832 * having been previously disabled, e.g., due to rfkill. 4833 */ 4834 EVENT_INTERFACE_ENABLED, 4835 4836 /** 4837 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled 4838 * 4839 * This event is used to indicate that the interface was disabled, 4840 * e.g., due to rfkill. 4841 */ 4842 EVENT_INTERFACE_DISABLED, 4843 4844 /** 4845 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed 4846 * 4847 * This event is used to indicate that the channel list has changed, 4848 * e.g., because of a regulatory domain change triggered by scan 4849 * results including an AP advertising a country code. 4850 */ 4851 EVENT_CHANNEL_LIST_CHANGED, 4852 4853 /** 4854 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable 4855 * 4856 * This event is used to indicate that the driver cannot maintain this 4857 * interface in its operation mode anymore. The most likely use for 4858 * this is to indicate that AP mode operation is not available due to 4859 * operating channel would need to be changed to a DFS channel when 4860 * the driver does not support radar detection and another virtual 4861 * interfaces caused the operating channel to change. Other similar 4862 * resource conflicts could also trigger this for station mode 4863 * interfaces. This event can be propagated when channel switching 4864 * fails. 4865 */ 4866 EVENT_INTERFACE_UNAVAILABLE, 4867 4868 /** 4869 * EVENT_BEST_CHANNEL 4870 * 4871 * Driver generates this event whenever it detects a better channel 4872 * (e.g., based on RSSI or channel use). This information can be used 4873 * to improve channel selection for a new AP/P2P group. 4874 */ 4875 EVENT_BEST_CHANNEL, 4876 4877 /** 4878 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received 4879 * 4880 * This event should be called when a Deauthentication frame is dropped 4881 * due to it not being protected (MFP/IEEE 802.11w). 4882 * union wpa_event_data::unprot_deauth is required to provide more 4883 * details of the frame. 4884 */ 4885 EVENT_UNPROT_DEAUTH, 4886 4887 /** 4888 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received 4889 * 4890 * This event should be called when a Disassociation frame is dropped 4891 * due to it not being protected (MFP/IEEE 802.11w). 4892 * union wpa_event_data::unprot_disassoc is required to provide more 4893 * details of the frame. 4894 */ 4895 EVENT_UNPROT_DISASSOC, 4896 4897 /** 4898 * EVENT_STATION_LOW_ACK 4899 * 4900 * Driver generates this event whenever it detected that a particular 4901 * station was lost. Detection can be through massive transmission 4902 * failures for example. 4903 */ 4904 EVENT_STATION_LOW_ACK, 4905 4906 /** 4907 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore 4908 */ 4909 EVENT_IBSS_PEER_LOST, 4910 4911 /** 4912 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey 4913 * 4914 * This event carries the new replay counter to notify wpa_supplicant 4915 * of the current EAPOL-Key Replay Counter in case the driver/firmware 4916 * completed Group Key Handshake while the host (including 4917 * wpa_supplicant was sleeping). 4918 */ 4919 EVENT_DRIVER_GTK_REKEY, 4920 4921 /** 4922 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped 4923 */ 4924 EVENT_SCHED_SCAN_STOPPED, 4925 4926 /** 4927 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll 4928 * 4929 * This event indicates that the station responded to the poll 4930 * initiated with @poll_client. 4931 */ 4932 EVENT_DRIVER_CLIENT_POLL_OK, 4933 4934 /** 4935 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status 4936 */ 4937 EVENT_EAPOL_TX_STATUS, 4938 4939 /** 4940 * EVENT_CH_SWITCH - AP or GO decided to switch channels 4941 * 4942 * Described in wpa_event_data.ch_switch 4943 * */ 4944 EVENT_CH_SWITCH, 4945 4946 /** 4947 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels 4948 * 4949 * This is a pre-switch event indicating the shortly following switch 4950 * of operating channels. 4951 * 4952 * Described in wpa_event_data.ch_switch 4953 */ 4954 EVENT_CH_SWITCH_STARTED, 4955 /** 4956 * EVENT_WNM - Request WNM operation 4957 * 4958 * This event can be used to request a WNM operation to be performed. 4959 */ 4960 EVENT_WNM, 4961 4962 /** 4963 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode 4964 * 4965 * This event indicates that the driver reported a connection failure 4966 * with the specified client (for example, max client reached, etc.) in 4967 * AP mode. 4968 */ 4969 EVENT_CONNECT_FAILED_REASON, 4970 4971 /** 4972 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection 4973 * 4974 * A radar has been detected on the supplied frequency, hostapd should 4975 * react accordingly (e.g., change channel). 4976 */ 4977 EVENT_DFS_RADAR_DETECTED, 4978 4979 /** 4980 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed 4981 * 4982 * After a successful CAC, the channel can be marked clear and used. 4983 */ 4984 EVENT_DFS_CAC_FINISHED, 4985 4986 /** 4987 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted 4988 * 4989 * The CAC was not successful, and the channel remains in the previous 4990 * state. This may happen due to a radar being detected or other 4991 * external influences. 4992 */ 4993 EVENT_DFS_CAC_ABORTED, 4994 4995 /** 4996 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over 4997 * 4998 * The channel which was previously unavailable is now available again. 4999 */ 5000 EVENT_DFS_NOP_FINISHED, 5001 5002 /** 5003 * EVENT_SURVEY - Received survey data 5004 * 5005 * This event gets triggered when a driver query is issued for survey 5006 * data and the requested data becomes available. The returned data is 5007 * stored in struct survey_results. The results provide at most one 5008 * survey entry for each frequency and at minimum will provide one 5009 * survey entry for one frequency. The survey data can be os_malloc()'d 5010 * and then os_free()'d, so the event callback must only copy data. 5011 */ 5012 EVENT_SURVEY, 5013 5014 /** 5015 * EVENT_SCAN_STARTED - Scan started 5016 * 5017 * This indicates that driver has started a scan operation either based 5018 * on a request from wpa_supplicant/hostapd or from another application. 5019 * EVENT_SCAN_RESULTS is used to indicate when the scan has been 5020 * completed (either successfully or by getting cancelled). 5021 */ 5022 EVENT_SCAN_STARTED, 5023 5024 /** 5025 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range 5026 * 5027 * This event indicates a set of frequency ranges that should be avoided 5028 * to reduce issues due to interference or internal co-existence 5029 * information in the driver. 5030 */ 5031 EVENT_AVOID_FREQUENCIES, 5032 5033 /** 5034 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification 5035 */ 5036 EVENT_NEW_PEER_CANDIDATE, 5037 5038 /** 5039 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS 5040 * 5041 * Indicates a pair of primary and secondary channels chosen by ACS 5042 * in device. 5043 */ 5044 EVENT_ACS_CHANNEL_SELECTED, 5045 5046 /** 5047 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has 5048 * been started. 5049 * 5050 * This event indicates that channel availability check has been started 5051 * on a DFS frequency by a driver that supports DFS Offload. 5052 */ 5053 EVENT_DFS_CAC_STARTED, 5054 5055 /** 5056 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped 5057 */ 5058 EVENT_P2P_LO_STOP, 5059 5060 /** 5061 * EVENT_BEACON_LOSS - Beacon loss detected 5062 * 5063 * This event indicates that no Beacon frames has been received from 5064 * the current AP. This may indicate that the AP is not anymore in 5065 * range. 5066 */ 5067 EVENT_BEACON_LOSS, 5068 5069 /** 5070 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check 5071 * done previously (Pre-CAC) on the channel has expired. This would 5072 * normally be on a non-ETSI DFS regulatory domain. DFS state of the 5073 * channel will be moved from available to usable. A new CAC has to be 5074 * performed before start operating on this channel. 5075 */ 5076 EVENT_DFS_PRE_CAC_EXPIRED, 5077 5078 /** 5079 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers 5080 * that do not define separate commands for authentication and 5081 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11 5082 * authentication to wpa_supplicant. This event carries all the 5083 * necessary information from the host driver for the authentication to 5084 * happen. 5085 */ 5086 EVENT_EXTERNAL_AUTH, 5087 5088 /** 5089 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized 5090 * 5091 * This event should be indicated when the driver completes the 4-way 5092 * handshake. This event should be preceded by an EVENT_ASSOC that 5093 * indicates the completion of IEEE 802.11 association. 5094 */ 5095 EVENT_PORT_AUTHORIZED, 5096 5097 /** 5098 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode 5099 * change event. 5100 */ 5101 EVENT_STATION_OPMODE_CHANGED, 5102 5103 /** 5104 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed 5105 * 5106 * This event is emitted when the MAC changes while the interface is 5107 * enabled. When an interface was disabled and becomes enabled, it 5108 * must be always assumed that the MAC possibly changed. 5109 */ 5110 EVENT_INTERFACE_MAC_CHANGED, 5111 5112 /** 5113 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status 5114 * 5115 * This event is emitted when an interface is added/removed for WDS STA. 5116 */ 5117 EVENT_WDS_STA_INTERFACE_STATUS, 5118 5119 /** 5120 * EVENT_UPDATE_DH - Notification of updated DH information 5121 */ 5122 EVENT_UPDATE_DH, 5123 5124 /** 5125 * EVENT_UNPROT_BEACON - Unprotected Beacon frame received 5126 * 5127 * This event should be called when a Beacon frame is dropped due to it 5128 * not being protected correctly. union wpa_event_data::unprot_beacon 5129 * is required to provide more details of the frame. 5130 */ 5131 EVENT_UNPROT_BEACON, 5132}; 5133 5134 5135/** 5136 * struct freq_survey - Channel survey info 5137 * 5138 * @ifidx: Interface index in which this survey was observed 5139 * @freq: Center of frequency of the surveyed channel 5140 * @nf: Channel noise floor in dBm 5141 * @channel_time: Amount of time in ms the radio spent on the channel 5142 * @channel_time_busy: Amount of time in ms the radio detected some signal 5143 * that indicated to the radio the channel was not clear 5144 * @channel_time_rx: Amount of time the radio spent receiving data 5145 * @channel_time_tx: Amount of time the radio spent transmitting data 5146 * @filled: bitmask indicating which fields have been reported, see 5147 * SURVEY_HAS_* defines. 5148 * @list: Internal list pointers 5149 */ 5150struct freq_survey { 5151 u32 ifidx; 5152 unsigned int freq; 5153 s8 nf; 5154 u64 channel_time; 5155 u64 channel_time_busy; 5156 u64 channel_time_rx; 5157 u64 channel_time_tx; 5158 unsigned int filled; 5159 struct dl_list list; 5160}; 5161 5162#define SURVEY_HAS_NF BIT(0) 5163#define SURVEY_HAS_CHAN_TIME BIT(1) 5164#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2) 5165#define SURVEY_HAS_CHAN_TIME_RX BIT(3) 5166#define SURVEY_HAS_CHAN_TIME_TX BIT(4) 5167 5168/** 5169 * enum sta_connect_fail_reason_codes - STA connect failure reason code values 5170 * @STA_CONNECT_FAIL_REASON_UNSPECIFIED: No reason code specified for 5171 * connection failure. 5172 * @STA_CONNECT_FAIL_REASON_NO_BSS_FOUND: No Probe Response frame received 5173 * for unicast Probe Request frame. 5174 * @STA_CONNECT_FAIL_REASON_AUTH_TX_FAIL: STA failed to send auth request. 5175 * @STA_CONNECT_FAIL_REASON_AUTH_NO_ACK_RECEIVED: AP didn't send ACK for 5176 * auth request. 5177 * @STA_CONNECT_FAIL_REASON_AUTH_NO_RESP_RECEIVED: Auth response is not 5178 * received from AP. 5179 * @STA_CONNECT_FAIL_REASON_ASSOC_REQ_TX_FAIL: STA failed to send 5180 * Association Request frame. 5181 * @STA_CONNECT_FAIL_REASON_ASSOC_NO_ACK_RECEIVED: AP didn't send ACK for 5182 * Association Request frame. 5183 * @STA_CONNECT_FAIL_REASON_ASSOC_NO_RESP_RECEIVED: Association Response 5184 * frame is not received from AP. 5185 */ 5186enum sta_connect_fail_reason_codes { 5187 STA_CONNECT_FAIL_REASON_UNSPECIFIED = 0, 5188 STA_CONNECT_FAIL_REASON_NO_BSS_FOUND = 1, 5189 STA_CONNECT_FAIL_REASON_AUTH_TX_FAIL = 2, 5190 STA_CONNECT_FAIL_REASON_AUTH_NO_ACK_RECEIVED = 3, 5191 STA_CONNECT_FAIL_REASON_AUTH_NO_RESP_RECEIVED = 4, 5192 STA_CONNECT_FAIL_REASON_ASSOC_REQ_TX_FAIL = 5, 5193 STA_CONNECT_FAIL_REASON_ASSOC_NO_ACK_RECEIVED = 6, 5194 STA_CONNECT_FAIL_REASON_ASSOC_NO_RESP_RECEIVED = 7, 5195}; 5196 5197/** 5198 * union wpa_event_data - Additional data for wpa_supplicant_event() calls 5199 */ 5200union wpa_event_data { 5201 /** 5202 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events 5203 * 5204 * This structure is optional for EVENT_ASSOC calls and required for 5205 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the 5206 * driver interface does not need to generate separate EVENT_ASSOCINFO 5207 * calls. 5208 */ 5209 struct assoc_info { 5210 /** 5211 * reassoc - Flag to indicate association or reassociation 5212 */ 5213 int reassoc; 5214 5215 /** 5216 * req_ies - (Re)Association Request IEs 5217 * 5218 * If the driver generates WPA/RSN IE, this event data must be 5219 * returned for WPA handshake to have needed information. If 5220 * wpa_supplicant-generated WPA/RSN IE is used, this 5221 * information event is optional. 5222 * 5223 * This should start with the first IE (fixed fields before IEs 5224 * are not included). 5225 */ 5226 const u8 *req_ies; 5227 5228 /** 5229 * req_ies_len - Length of req_ies in bytes 5230 */ 5231 size_t req_ies_len; 5232 5233 /** 5234 * resp_ies - (Re)Association Response IEs 5235 * 5236 * Optional association data from the driver. This data is not 5237 * required WPA, but may be useful for some protocols and as 5238 * such, should be reported if this is available to the driver 5239 * interface. 5240 * 5241 * This should start with the first IE (fixed fields before IEs 5242 * are not included). 5243 */ 5244 const u8 *resp_ies; 5245 5246 /** 5247 * resp_ies_len - Length of resp_ies in bytes 5248 */ 5249 size_t resp_ies_len; 5250 5251 /** 5252 * resp_frame - (Re)Association Response frame 5253 */ 5254 const u8 *resp_frame; 5255 5256 /** 5257 * resp_frame_len - (Re)Association Response frame length 5258 */ 5259 size_t resp_frame_len; 5260 5261 /** 5262 * beacon_ies - Beacon or Probe Response IEs 5263 * 5264 * Optional Beacon/ProbeResp data: IEs included in Beacon or 5265 * Probe Response frames from the current AP (i.e., the one 5266 * that the client just associated with). This information is 5267 * used to update WPA/RSN IE for the AP. If this field is not 5268 * set, the results from previous scan will be used. If no 5269 * data for the new AP is found, scan results will be requested 5270 * again (without scan request). At this point, the driver is 5271 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is 5272 * used). 5273 * 5274 * This should start with the first IE (fixed fields before IEs 5275 * are not included). 5276 */ 5277 const u8 *beacon_ies; 5278 5279 /** 5280 * beacon_ies_len - Length of beacon_ies */ 5281 size_t beacon_ies_len; 5282 5283 /** 5284 * freq - Frequency of the operational channel in MHz 5285 */ 5286 unsigned int freq; 5287 5288 /** 5289 * wmm_params - WMM parameters used in this association. 5290 */ 5291 struct wmm_params wmm_params; 5292 5293 /** 5294 * addr - Station address (for AP mode) 5295 */ 5296 const u8 *addr; 5297 5298 /** 5299 * The following is the key management offload information 5300 * @authorized 5301 * @key_replay_ctr 5302 * @key_replay_ctr_len 5303 * @ptk_kck 5304 * @ptk_kek_len 5305 * @ptk_kek 5306 * @ptk_kek_len 5307 */ 5308 5309 /** 5310 * authorized - Status of key management offload, 5311 * 1 = successful 5312 */ 5313 int authorized; 5314 5315 /** 5316 * key_replay_ctr - Key replay counter value last used 5317 * in a valid EAPOL-Key frame 5318 */ 5319 const u8 *key_replay_ctr; 5320 5321 /** 5322 * key_replay_ctr_len - The length of key_replay_ctr 5323 */ 5324 size_t key_replay_ctr_len; 5325 5326 /** 5327 * ptk_kck - The derived PTK KCK 5328 */ 5329 const u8 *ptk_kck; 5330 5331 /** 5332 * ptk_kek_len - The length of ptk_kck 5333 */ 5334 size_t ptk_kck_len; 5335 5336 /** 5337 * ptk_kek - The derived PTK KEK 5338 * This is used in key management offload and also in FILS SK 5339 * offload. 5340 */ 5341 const u8 *ptk_kek; 5342 5343 /** 5344 * ptk_kek_len - The length of ptk_kek 5345 */ 5346 size_t ptk_kek_len; 5347 5348 /** 5349 * subnet_status - The subnet status: 5350 * 0 = unknown, 1 = unchanged, 2 = changed 5351 */ 5352 u8 subnet_status; 5353 5354 /** 5355 * The following information is used in FILS SK offload 5356 * @fils_erp_next_seq_num 5357 * @fils_pmk 5358 * @fils_pmk_len 5359 * @fils_pmkid 5360 */ 5361 5362 /** 5363 * fils_erp_next_seq_num - The next sequence number to use in 5364 * FILS ERP messages 5365 */ 5366 u16 fils_erp_next_seq_num; 5367 5368 /** 5369 * fils_pmk - A new PMK if generated in case of FILS 5370 * authentication 5371 */ 5372 const u8 *fils_pmk; 5373 5374 /** 5375 * fils_pmk_len - Length of fils_pmk 5376 */ 5377 size_t fils_pmk_len; 5378 5379 /** 5380 * fils_pmkid - PMKID used or generated in FILS authentication 5381 */ 5382 const u8 *fils_pmkid; 5383 } assoc_info; 5384 5385 /** 5386 * struct disassoc_info - Data for EVENT_DISASSOC events 5387 */ 5388 struct disassoc_info { 5389 /** 5390 * addr - Station address (for AP mode) 5391 */ 5392 const u8 *addr; 5393 5394 /** 5395 * reason_code - Reason Code (host byte order) used in 5396 * Deauthentication frame 5397 */ 5398 u16 reason_code; 5399 5400 /** 5401 * ie - Optional IE(s) in Disassociation frame 5402 */ 5403 const u8 *ie; 5404 5405 /** 5406 * ie_len - Length of ie buffer in octets 5407 */ 5408 size_t ie_len; 5409 5410 /** 5411 * locally_generated - Whether the frame was locally generated 5412 */ 5413 int locally_generated; 5414 } disassoc_info; 5415 5416 /** 5417 * struct deauth_info - Data for EVENT_DEAUTH events 5418 */ 5419 struct deauth_info { 5420 /** 5421 * addr - Station address (for AP mode) 5422 */ 5423 const u8 *addr; 5424 5425 /** 5426 * reason_code - Reason Code (host byte order) used in 5427 * Deauthentication frame 5428 */ 5429 u16 reason_code; 5430 5431 /** 5432 * ie - Optional IE(s) in Deauthentication frame 5433 */ 5434 const u8 *ie; 5435 5436 /** 5437 * ie_len - Length of ie buffer in octets 5438 */ 5439 size_t ie_len; 5440 5441 /** 5442 * locally_generated - Whether the frame was locally generated 5443 */ 5444 int locally_generated; 5445 } deauth_info; 5446 5447 /** 5448 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE 5449 */ 5450 struct michael_mic_failure { 5451 int unicast; 5452 const u8 *src; 5453 } michael_mic_failure; 5454 5455 /** 5456 * struct interface_status - Data for EVENT_INTERFACE_STATUS 5457 */ 5458 struct interface_status { 5459 unsigned int ifindex; 5460 char ifname[100]; 5461 enum { 5462 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED 5463 } ievent; 5464 } interface_status; 5465 5466 /** 5467 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE 5468 */ 5469 struct pmkid_candidate { 5470 /** BSSID of the PMKID candidate */ 5471 u8 bssid[ETH_ALEN]; 5472 /** Smaller the index, higher the priority */ 5473 int index; 5474 /** Whether RSN IE includes pre-authenticate flag */ 5475 int preauth; 5476 } pmkid_candidate; 5477 5478 /** 5479 * struct tdls - Data for EVENT_TDLS 5480 */ 5481 struct tdls { 5482 u8 peer[ETH_ALEN]; 5483 enum { 5484 TDLS_REQUEST_SETUP, 5485 TDLS_REQUEST_TEARDOWN, 5486 TDLS_REQUEST_DISCOVER, 5487 } oper; 5488 u16 reason_code; /* for teardown */ 5489 } tdls; 5490 5491 /** 5492 * struct wnm - Data for EVENT_WNM 5493 */ 5494 struct wnm { 5495 u8 addr[ETH_ALEN]; 5496 enum { 5497 WNM_OPER_SLEEP, 5498 } oper; 5499 enum { 5500 WNM_SLEEP_ENTER, 5501 WNM_SLEEP_EXIT 5502 } sleep_action; 5503 int sleep_intval; 5504 u16 reason_code; 5505 u8 *buf; 5506 u16 buf_len; 5507 } wnm; 5508 5509 /** 5510 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE) 5511 * 5512 * During FT (IEEE 802.11r) authentication sequence, the driver is 5513 * expected to use this event to report received FT IEs (MDIE, FTIE, 5514 * RSN IE, TIE, possible resource request) to the supplicant. The FT 5515 * IEs for the next message will be delivered through the 5516 * struct wpa_driver_ops::update_ft_ies() callback. 5517 */ 5518 struct ft_ies { 5519 const u8 *ies; 5520 size_t ies_len; 5521 int ft_action; 5522 u8 target_ap[ETH_ALEN]; 5523 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */ 5524 const u8 *ric_ies; 5525 /** Length of ric_ies buffer in octets */ 5526 size_t ric_ies_len; 5527 } ft_ies; 5528 5529 /** 5530 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START 5531 */ 5532 struct ibss_rsn_start { 5533 u8 peer[ETH_ALEN]; 5534 } ibss_rsn_start; 5535 5536 /** 5537 * struct auth_info - Data for EVENT_AUTH events 5538 */ 5539 struct auth_info { 5540 u8 peer[ETH_ALEN]; 5541 u8 bssid[ETH_ALEN]; 5542 u16 auth_type; 5543 u16 auth_transaction; 5544 u16 status_code; 5545 const u8 *ies; 5546 size_t ies_len; 5547 } auth; 5548 5549 /** 5550 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events 5551 */ 5552 struct assoc_reject { 5553 /** 5554 * bssid - BSSID of the AP that rejected association 5555 */ 5556 const u8 *bssid; 5557 5558 /** 5559 * resp_ies - (Re)Association Response IEs 5560 * 5561 * Optional association data from the driver. This data is not 5562 * required WPA, but may be useful for some protocols and as 5563 * such, should be reported if this is available to the driver 5564 * interface. 5565 * 5566 * This should start with the first IE (fixed fields before IEs 5567 * are not included). 5568 */ 5569 const u8 *resp_ies; 5570 5571 /** 5572 * resp_ies_len - Length of resp_ies in bytes 5573 */ 5574 size_t resp_ies_len; 5575 5576 /** 5577 * status_code - Status Code from (Re)association Response 5578 */ 5579 u16 status_code; 5580 5581 /** 5582 * timed_out - Whether failure is due to timeout (etc.) rather 5583 * than explicit rejection response from the AP. 5584 */ 5585 int timed_out; 5586 5587 /** 5588 * timeout_reason - Reason for the timeout 5589 */ 5590 const char *timeout_reason; 5591 5592 /** 5593 * fils_erp_next_seq_num - The next sequence number to use in 5594 * FILS ERP messages 5595 */ 5596 u16 fils_erp_next_seq_num; 5597 5598 /** 5599 * reason_code - Connection failure reason code from the driver 5600 */ 5601 enum sta_connect_fail_reason_codes reason_code; 5602 } assoc_reject; 5603 5604 struct timeout_event { 5605 u8 addr[ETH_ALEN]; 5606 } timeout_event; 5607 5608 /** 5609 * struct tx_status - Data for EVENT_TX_STATUS events 5610 */ 5611 struct tx_status { 5612 u16 type; 5613 u16 stype; 5614 const u8 *dst; 5615 const u8 *data; 5616 size_t data_len; 5617 int ack; 5618 } tx_status; 5619 5620 /** 5621 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events 5622 */ 5623 struct rx_from_unknown { 5624 const u8 *bssid; 5625 const u8 *addr; 5626 int wds; 5627 } rx_from_unknown; 5628 5629 /** 5630 * struct rx_mgmt - Data for EVENT_RX_MGMT events 5631 */ 5632 struct rx_mgmt { 5633 const u8 *frame; 5634 size_t frame_len; 5635 u32 datarate; 5636 5637 /** 5638 * drv_priv - Pointer to store driver private BSS information 5639 * 5640 * If not set to NULL, this is used for comparison with 5641 * hostapd_data->drv_priv to determine which BSS should process 5642 * the frame. 5643 */ 5644 void *drv_priv; 5645 5646 /** 5647 * freq - Frequency (in MHz) on which the frame was received 5648 */ 5649 int freq; 5650 5651 /** 5652 * ssi_signal - Signal strength in dBm (or 0 if not available) 5653 */ 5654 int ssi_signal; 5655 } rx_mgmt; 5656 5657 /** 5658 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events 5659 * 5660 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events. 5661 */ 5662 struct remain_on_channel { 5663 /** 5664 * freq - Channel frequency in MHz 5665 */ 5666 unsigned int freq; 5667 5668 /** 5669 * duration - Duration to remain on the channel in milliseconds 5670 */ 5671 unsigned int duration; 5672 } remain_on_channel; 5673 5674 /** 5675 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events 5676 * @aborted: Whether the scan was aborted 5677 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned) 5678 * @num_freqs: Number of entries in freqs array 5679 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard 5680 * SSID) 5681 * @num_ssids: Number of entries in ssids array 5682 * @external_scan: Whether the scan info is for an external scan 5683 * @nl_scan_event: 1 if the source of this scan event is a normal scan, 5684 * 0 if the source of the scan event is a vendor scan 5685 * @scan_start_tsf: Time when the scan started in terms of TSF of the 5686 * BSS that the interface that requested the scan is connected to 5687 * (if available). 5688 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf 5689 * is set. 5690 */ 5691 struct scan_info { 5692 int aborted; 5693 const int *freqs; 5694 size_t num_freqs; 5695 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS]; 5696 size_t num_ssids; 5697 int external_scan; 5698 int nl_scan_event; 5699 u64 scan_start_tsf; 5700 u8 scan_start_tsf_bssid[ETH_ALEN]; 5701 } scan_info; 5702 5703 /** 5704 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events 5705 */ 5706 struct rx_probe_req { 5707 /** 5708 * sa - Source address of the received Probe Request frame 5709 */ 5710 const u8 *sa; 5711 5712 /** 5713 * da - Destination address of the received Probe Request frame 5714 * or %NULL if not available 5715 */ 5716 const u8 *da; 5717 5718 /** 5719 * bssid - BSSID of the received Probe Request frame or %NULL 5720 * if not available 5721 */ 5722 const u8 *bssid; 5723 5724 /** 5725 * ie - IEs from the Probe Request body 5726 */ 5727 const u8 *ie; 5728 5729 /** 5730 * ie_len - Length of ie buffer in octets 5731 */ 5732 size_t ie_len; 5733 5734 /** 5735 * signal - signal strength in dBm (or 0 if not available) 5736 */ 5737 int ssi_signal; 5738 } rx_probe_req; 5739 5740 /** 5741 * struct new_sta - Data for EVENT_NEW_STA events 5742 */ 5743 struct new_sta { 5744 const u8 *addr; 5745 } new_sta; 5746 5747 /** 5748 * struct eapol_rx - Data for EVENT_EAPOL_RX events 5749 */ 5750 struct eapol_rx { 5751 const u8 *src; 5752 const u8 *data; 5753 size_t data_len; 5754 } eapol_rx; 5755 5756 /** 5757 * signal_change - Data for EVENT_SIGNAL_CHANGE events 5758 */ 5759 struct wpa_signal_info signal_change; 5760 5761 /** 5762 * struct best_channel - Data for EVENT_BEST_CHANNEL events 5763 * @freq_24: Best 2.4 GHz band channel frequency in MHz 5764 * @freq_5: Best 5 GHz band channel frequency in MHz 5765 * @freq_overall: Best channel frequency in MHz 5766 * 5767 * 0 can be used to indicate no preference in either band. 5768 */ 5769 struct best_channel { 5770 int freq_24; 5771 int freq_5; 5772 int freq_overall; 5773 } best_chan; 5774 5775 struct unprot_deauth { 5776 const u8 *sa; 5777 const u8 *da; 5778 u16 reason_code; 5779 } unprot_deauth; 5780 5781 struct unprot_disassoc { 5782 const u8 *sa; 5783 const u8 *da; 5784 u16 reason_code; 5785 } unprot_disassoc; 5786 5787 /** 5788 * struct low_ack - Data for EVENT_STATION_LOW_ACK events 5789 * @addr: station address 5790 * @num_packets: Number of packets lost (consecutive packets not 5791 * acknowledged) 5792 */ 5793 struct low_ack { 5794 u8 addr[ETH_ALEN]; 5795 u32 num_packets; 5796 } low_ack; 5797 5798 /** 5799 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST 5800 */ 5801 struct ibss_peer_lost { 5802 u8 peer[ETH_ALEN]; 5803 } ibss_peer_lost; 5804 5805 /** 5806 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY 5807 */ 5808 struct driver_gtk_rekey { 5809 const u8 *bssid; 5810 const u8 *replay_ctr; 5811 } driver_gtk_rekey; 5812 5813 /** 5814 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events 5815 * @addr: station address 5816 */ 5817 struct client_poll { 5818 u8 addr[ETH_ALEN]; 5819 } client_poll; 5820 5821 /** 5822 * struct eapol_tx_status 5823 * @dst: Original destination 5824 * @data: Data starting with IEEE 802.1X header (!) 5825 * @data_len: Length of data 5826 * @ack: Indicates ack or lost frame 5827 * 5828 * This corresponds to hapd_send_eapol if the frame sent 5829 * there isn't just reported as EVENT_TX_STATUS. 5830 */ 5831 struct eapol_tx_status { 5832 const u8 *dst; 5833 const u8 *data; 5834 int data_len; 5835 int ack; 5836 } eapol_tx_status; 5837 5838 /** 5839 * struct ch_switch 5840 * @freq: Frequency of new channel in MHz 5841 * @ht_enabled: Whether this is an HT channel 5842 * @ch_offset: Secondary channel offset 5843 * @ch_width: Channel width 5844 * @cf1: Center frequency 1 5845 * @cf2: Center frequency 2 5846 */ 5847 struct ch_switch { 5848 int freq; 5849 int ht_enabled; 5850 int ch_offset; 5851 enum chan_width ch_width; 5852 int cf1; 5853 int cf2; 5854 } ch_switch; 5855 5856 /** 5857 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON 5858 * @addr: Remote client address 5859 * @code: Reason code for connection failure 5860 */ 5861 struct connect_failed_reason { 5862 u8 addr[ETH_ALEN]; 5863 enum { 5864 MAX_CLIENT_REACHED, 5865 BLOCKED_CLIENT 5866 } code; 5867 } connect_failed_reason; 5868 5869 /** 5870 * struct dfs_event - Data for radar detected events 5871 * @freq: Frequency of the channel in MHz 5872 */ 5873 struct dfs_event { 5874 int freq; 5875 int ht_enabled; 5876 int chan_offset; 5877 enum chan_width chan_width; 5878 int cf1; 5879 int cf2; 5880 } dfs_event; 5881 5882 /** 5883 * survey_results - Survey result data for EVENT_SURVEY 5884 * @freq_filter: Requested frequency survey filter, 0 if request 5885 * was for all survey data 5886 * @survey_list: Linked list of survey data (struct freq_survey) 5887 */ 5888 struct survey_results { 5889 unsigned int freq_filter; 5890 struct dl_list survey_list; /* struct freq_survey */ 5891 } survey_results; 5892 5893 /** 5894 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED 5895 * @initiator: Initiator of the regulatory change 5896 * @type: Regulatory change type 5897 * @alpha2: Country code (or "" if not available) 5898 */ 5899 struct channel_list_changed { 5900 enum reg_change_initiator initiator; 5901 enum reg_type type; 5902 char alpha2[3]; 5903 } channel_list_changed; 5904 5905 /** 5906 * freq_range - List of frequency ranges 5907 * 5908 * This is used as the data with EVENT_AVOID_FREQUENCIES. 5909 */ 5910 struct wpa_freq_range_list freq_range; 5911 5912 /** 5913 * struct mesh_peer 5914 * 5915 * @peer: Peer address 5916 * @ies: Beacon IEs 5917 * @ie_len: Length of @ies 5918 * 5919 * Notification of new candidate mesh peer. 5920 */ 5921 struct mesh_peer { 5922 const u8 *peer; 5923 const u8 *ies; 5924 size_t ie_len; 5925 } mesh_peer; 5926 5927 /** 5928 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED 5929 * @pri_freq: Selected primary frequency 5930 * @sec_freq: Selected secondary frequency 5931 * @edmg_channel: Selected EDMG channel 5932 * @vht_seg0_center_ch: VHT mode Segment0 center channel 5933 * The value is the index of the channel center frequency for 5934 * 20 MHz, 40 MHz, and 80 MHz channels. The value is the center 5935 * frequency index of the primary 80 MHz segment for 160 MHz and 5936 * 80+80 MHz channels. 5937 * @vht_seg1_center_ch: VHT mode Segment1 center channel 5938 * The value is zero for 20 MHz, 40 MHz, and 80 MHz channels. The 5939 * value is the index of the channel center frequency for 160 MHz 5940 * channels and the center frequency index of the secondary 80 MHz 5941 * segment for 80+80 MHz channels. 5942 * @ch_width: Selected Channel width by driver. Driver may choose to 5943 * change hostapd configured ACS channel width due driver internal 5944 * channel restrictions. 5945 * hw_mode: Selected band (used with hw_mode=any) 5946 */ 5947 struct acs_selected_channels { 5948 unsigned int pri_freq; 5949 unsigned int sec_freq; 5950 u8 edmg_channel; 5951 u8 vht_seg0_center_ch; 5952 u8 vht_seg1_center_ch; 5953 u16 ch_width; 5954 enum hostapd_hw_mode hw_mode; 5955 } acs_selected_channels; 5956 5957 /** 5958 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event 5959 * @reason_code: Reason for stopping offload 5960 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as 5961 * scheduled. 5962 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to 5963 * be stopped. 5964 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload 5965 * parameters. 5966 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not 5967 * supported by device. 5968 */ 5969 struct p2p_lo_stop { 5970 enum { 5971 P2P_LO_STOPPED_REASON_COMPLETE = 0, 5972 P2P_LO_STOPPED_REASON_RECV_STOP_CMD, 5973 P2P_LO_STOPPED_REASON_INVALID_PARAM, 5974 P2P_LO_STOPPED_REASON_NOT_SUPPORTED, 5975 } reason_code; 5976 } p2p_lo_stop; 5977 5978 /* For EVENT_EXTERNAL_AUTH */ 5979 struct external_auth external_auth; 5980 5981 /** 5982 * struct sta_opmode - Station's operation mode change event 5983 * @addr: The station MAC address 5984 * @smps_mode: SMPS mode of the station 5985 * @chan_width: Channel width of the station 5986 * @rx_nss: RX_NSS of the station 5987 * 5988 * This is used as data with EVENT_STATION_OPMODE_CHANGED. 5989 */ 5990 struct sta_opmode { 5991 const u8 *addr; 5992 enum smps_mode smps_mode; 5993 enum chan_width chan_width; 5994 u8 rx_nss; 5995 } sta_opmode; 5996 5997 /** 5998 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS. 5999 */ 6000 struct wds_sta_interface { 6001 const u8 *sta_addr; 6002 const char *ifname; 6003 enum { 6004 INTERFACE_ADDED, 6005 INTERFACE_REMOVED 6006 } istatus; 6007 } wds_sta_interface; 6008 6009 /** 6010 * struct update_dh - Data for EVENT_UPDATE_DH 6011 */ 6012 struct update_dh { 6013 const u8 *peer; 6014 const u8 *ie; 6015 size_t ie_len; 6016 } update_dh; 6017 6018 /** 6019 * struct unprot_beacon - Data for EVENT_UNPROT_BEACON 6020 */ 6021 struct unprot_beacon { 6022 const u8 *sa; 6023 } unprot_beacon; 6024}; 6025 6026/** 6027 * wpa_supplicant_event - Report a driver event for wpa_supplicant 6028 * @ctx: Context pointer (wpa_s); this is the ctx variable registered 6029 * with struct wpa_driver_ops::init() 6030 * @event: event type (defined above) 6031 * @data: possible extra data for the event 6032 * 6033 * Driver wrapper code should call this function whenever an event is received 6034 * from the driver. 6035 */ 6036void wpa_supplicant_event(void *ctx, enum wpa_event_type event, 6037 union wpa_event_data *data); 6038 6039/** 6040 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant 6041 * @ctx: Context pointer (wpa_s); this is the ctx variable registered 6042 * with struct wpa_driver_ops::init() 6043 * @event: event type (defined above) 6044 * @data: possible extra data for the event 6045 * 6046 * Same as wpa_supplicant_event(), but we search for the interface in 6047 * wpa_global. 6048 */ 6049void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event, 6050 union wpa_event_data *data); 6051 6052/* 6053 * The following inline functions are provided for convenience to simplify 6054 * event indication for some of the common events. 6055 */ 6056 6057static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie, 6058 size_t ielen, int reassoc) 6059{ 6060 union wpa_event_data event; 6061 os_memset(&event, 0, sizeof(event)); 6062 event.assoc_info.reassoc = reassoc; 6063 event.assoc_info.req_ies = ie; 6064 event.assoc_info.req_ies_len = ielen; 6065 event.assoc_info.addr = addr; 6066 wpa_supplicant_event(ctx, EVENT_ASSOC, &event); 6067} 6068 6069static inline void drv_event_disassoc(void *ctx, const u8 *addr) 6070{ 6071 union wpa_event_data event; 6072 os_memset(&event, 0, sizeof(event)); 6073 event.disassoc_info.addr = addr; 6074 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event); 6075} 6076 6077static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data, 6078 size_t data_len) 6079{ 6080 union wpa_event_data event; 6081 os_memset(&event, 0, sizeof(event)); 6082 event.eapol_rx.src = src; 6083 event.eapol_rx.data = data; 6084 event.eapol_rx.data_len = data_len; 6085 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event); 6086} 6087 6088/* driver_common.c */ 6089void wpa_scan_results_free(struct wpa_scan_results *res); 6090 6091/* Convert wpa_event_type to a string for logging */ 6092const char * event_to_string(enum wpa_event_type event); 6093 6094/* Convert chan_width to a string for logging and control interfaces */ 6095const char * channel_width_to_string(enum chan_width width); 6096 6097int channel_width_to_int(enum chan_width width); 6098 6099int ht_supported(const struct hostapd_hw_modes *mode); 6100int vht_supported(const struct hostapd_hw_modes *mode); 6101 6102struct wowlan_triggers * 6103wpa_get_wowlan_triggers(const char *wowlan_triggers, 6104 const struct wpa_driver_capa *capa); 6105/* Convert driver flag to string */ 6106const char * driver_flag_to_string(u64 flag); 6107const char * driver_flag2_to_string(u64 flag2); 6108 6109/* NULL terminated array of linked in driver wrappers */ 6110extern const struct wpa_driver_ops *const wpa_drivers[]; 6111 6112 6113/* Available drivers */ 6114 6115#ifdef CONFIG_DRIVER_WEXT 6116extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */ 6117#endif /* CONFIG_DRIVER_WEXT */ 6118#ifdef CONFIG_DRIVER_NL80211 6119/* driver_nl80211.c */ 6120extern const struct wpa_driver_ops wpa_driver_nl80211_ops; 6121#endif /* CONFIG_DRIVER_NL80211 */ 6122#ifdef CONFIG_DRIVER_HOSTAP 6123extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */ 6124#endif /* CONFIG_DRIVER_HOSTAP */ 6125#ifdef CONFIG_DRIVER_BSD 6126extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */ 6127#endif /* CONFIG_DRIVER_BSD */ 6128#ifdef CONFIG_DRIVER_OPENBSD 6129/* driver_openbsd.c */ 6130extern const struct wpa_driver_ops wpa_driver_openbsd_ops; 6131#endif /* CONFIG_DRIVER_OPENBSD */ 6132#ifdef CONFIG_DRIVER_NDIS 6133extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */ 6134#endif /* CONFIG_DRIVER_NDIS */ 6135#ifdef CONFIG_DRIVER_WIRED 6136extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */ 6137#endif /* CONFIG_DRIVER_WIRED */ 6138#ifdef CONFIG_DRIVER_MACSEC_QCA 6139/* driver_macsec_qca.c */ 6140extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops; 6141#endif /* CONFIG_DRIVER_MACSEC_QCA */ 6142#ifdef CONFIG_DRIVER_MACSEC_LINUX 6143/* driver_macsec_linux.c */ 6144extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops; 6145#endif /* CONFIG_DRIVER_MACSEC_LINUX */ 6146#ifdef CONFIG_DRIVER_ROBOSWITCH 6147/* driver_roboswitch.c */ 6148extern const struct wpa_driver_ops wpa_driver_roboswitch_ops; 6149#endif /* CONFIG_DRIVER_ROBOSWITCH */ 6150#ifdef CONFIG_DRIVER_ATHEROS 6151/* driver_atheros.c */ 6152extern const struct wpa_driver_ops wpa_driver_atheros_ops; 6153#endif /* CONFIG_DRIVER_ATHEROS */ 6154#ifdef CONFIG_DRIVER_NONE 6155extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */ 6156#endif /* CONFIG_DRIVER_NONE */ 6157 6158#endif /* DRIVER_H */ 6159