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 */ 62 enum 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 */ 85 enum 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 */ 96 enum 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 */ 111 struct 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 */ 121 struct 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 */ 194 struct 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 207 enum 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 */ 230 struct 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 */ 238 struct 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 */ 358 struct 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 */ 384 struct 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 */ 400 struct 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 */ 416 struct 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 */ 425 struct 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 */ 665 struct 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 */ 701 enum 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 */ 721 struct 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 */ 791 struct 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 */ 853 struct 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 1208 enum hide_ssid { 1209 NO_SSID_HIDING, 1210 HIDDEN_SSID_ZERO_LEN, 1211 HIDDEN_SSID_ZERO_CONTENTS 1212 }; 1213 1214 enum ch_switch_state { 1215 CH_SW_STARTED, 1216 CH_SW_FINISHED 1217 }; 1218 1219 struct 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 1229 struct 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 1587 struct 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 /* 1594 * TODO: Other mesh configuration parameters would go here. 1595 * See NL80211_MESHCONF_* for all the mesh config parameters. 1596 */ 1597 unsigned int flags; 1598 int auto_plinks; 1599 int peer_link_timeout; 1600 int max_peer_links; 1601 int rssi_threshold; 1602 u16 ht_opmode; 1603 }; 1604 1605 struct wpa_driver_mesh_join_params { 1606 const u8 *meshid; 1607 int meshid_len; 1608 const int *basic_rates; 1609 const u8 *ies; 1610 int ie_len; 1611 struct hostapd_freq_params freq; 1612 int beacon_int; 1613 int dtim_period; 1614 struct wpa_driver_mesh_bss_params conf; 1615 #define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001 1616 #define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002 1617 #define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004 1618 #define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008 1619 unsigned int flags; 1620 bool handle_dfs; 1621 }; 1622 1623 struct wpa_driver_set_key_params { 1624 /** 1625 * ifname - Interface name (for multi-SSID/VLAN support) */ 1626 const char *ifname; 1627 1628 /** 1629 * alg - Encryption algorithm 1630 * 1631 * (%WPA_ALG_NONE, %WPA_ALG_WEP, %WPA_ALG_TKIP, %WPA_ALG_CCMP, 1632 * %WPA_ALG_BIP_AES_CMAC_128, %WPA_ALG_GCMP, %WPA_ALG_GCMP_256, 1633 * %WPA_ALG_CCMP_256, %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256, 1634 * %WPA_ALG_BIP_CMAC_256); 1635 * %WPA_ALG_NONE clears the key. */ 1636 enum wpa_alg alg; 1637 1638 /** 1639 * addr - Address of the peer STA 1640 * 1641 * (BSSID of the current AP when setting pairwise key in station mode), 1642 * ff:ff:ff:ff:ff:ff for broadcast keys, %NULL for default keys that 1643 * are used both for broadcast and unicast; when clearing keys, %NULL 1644 * is used to indicate that both the broadcast-only and default key of 1645 * the specified key index is to be cleared */ 1646 const u8 *addr; 1647 1648 /** 1649 * key_idx - Key index 1650 * 1651 * (0..3), usually 0 for unicast keys; 4..5 for IGTK; 6..7 for BIGTK */ 1652 int key_idx; 1653 1654 /** 1655 * set_tx - Configure this key as the default Tx key 1656 * 1657 * Only used when driver does not support separate unicast/individual 1658 * key */ 1659 int set_tx; 1660 1661 /** 1662 * seq - Sequence number/packet number 1663 * 1664 * seq_len octets, the next packet number to be used for in replay 1665 * protection; configured for Rx keys (in most cases, this is only used 1666 * with broadcast keys and set to zero for unicast keys); %NULL if not 1667 * set */ 1668 const u8 *seq; 1669 1670 /** 1671 * seq_len - Length of the seq, depends on the algorithm 1672 * 1673 * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets */ 1674 size_t seq_len; 1675 1676 /** 1677 * key - Key buffer 1678 * 1679 * TKIP: 16-byte temporal key, 8-byte Tx Mic key, 8-byte Rx Mic Key */ 1680 const u8 *key; 1681 1682 /** 1683 * key_len - Length of the key buffer in octets 1684 * 1685 * WEP: 5 or 13, TKIP: 32, CCMP/GCMP: 16, IGTK: 16 */ 1686 size_t key_len; 1687 1688 /** 1689 * vlan_id - VLAN index (0..4095) for VLAN offload cases */ 1690 int vlan_id; 1691 1692 /** 1693 * key_flag - Additional key flags 1694 * 1695 * %KEY_FLAG_MODIFY 1696 * Set when an already installed key must be updated. 1697 * So far the only use-case is changing RX/TX status for 1698 * pairwise keys. Must not be set when deleting a key. 1699 * %KEY_FLAG_DEFAULT 1700 * Set when the key is also a default key. Must not be set when 1701 * deleting a key. 1702 * %KEY_FLAG_RX 1703 * The key is valid for RX. Must not be set when deleting a key. 1704 * %KEY_FLAG_TX 1705 * The key is valid for TX. Must not be set when deleting a key. 1706 * %KEY_FLAG_GROUP 1707 * The key is a broadcast or group key. 1708 * %KEY_FLAG_PAIRWISE 1709 * The key is a pairwise key. 1710 * %KEY_FLAG_PMK 1711 * The key is a Pairwise Master Key (PMK). 1712 * 1713 * Valid and pre-defined combinations are: 1714 * %KEY_FLAG_GROUP_RX_TX 1715 * WEP key not to be installed as default key. 1716 * %KEY_FLAG_GROUP_RX_TX_DEFAULT 1717 * Default WEP or WPA-NONE key. 1718 * %KEY_FLAG_GROUP_RX 1719 * GTK key valid for RX only. 1720 * %KEY_FLAG_GROUP_TX_DEFAULT 1721 * GTK key valid for TX only, immediately taking over TX. 1722 * %KEY_FLAG_PAIRWISE_RX_TX 1723 * Pairwise key immediately becoming the active pairwise key. 1724 * %KEY_FLAG_PAIRWISE_RX 1725 * Pairwise key not yet valid for TX. (Only usable when Extended 1726 * Key ID is supported by the driver.) 1727 * %KEY_FLAG_PAIRWISE_RX_TX_MODIFY 1728 * Enable TX for a pairwise key installed with 1729 * KEY_FLAG_PAIRWISE_RX. 1730 * 1731 * Not a valid standalone key type but pre-defined to be combined 1732 * with other key_flags: 1733 * %KEY_FLAG_RX_TX 1734 * RX/TX key. */ 1735 enum key_flag key_flag; 1736 }; 1737 1738 enum wpa_driver_if_type { 1739 /** 1740 * WPA_IF_STATION - Station mode interface 1741 */ 1742 WPA_IF_STATION, 1743 1744 /** 1745 * WPA_IF_AP_VLAN - AP mode VLAN interface 1746 * 1747 * This interface shares its address and Beacon frame with the main 1748 * BSS. 1749 */ 1750 WPA_IF_AP_VLAN, 1751 1752 /** 1753 * WPA_IF_AP_BSS - AP mode BSS interface 1754 * 1755 * This interface has its own address and Beacon frame. 1756 */ 1757 WPA_IF_AP_BSS, 1758 1759 /** 1760 * WPA_IF_P2P_GO - P2P Group Owner 1761 */ 1762 WPA_IF_P2P_GO, 1763 1764 /** 1765 * WPA_IF_P2P_CLIENT - P2P Client 1766 */ 1767 WPA_IF_P2P_CLIENT, 1768 1769 /** 1770 * WPA_IF_P2P_GROUP - P2P Group interface (will become either 1771 * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known) 1772 */ 1773 WPA_IF_P2P_GROUP, 1774 1775 /** 1776 * WPA_IF_P2P_DEVICE - P2P Device interface is used to indentify the 1777 * abstracted P2P Device function in the driver 1778 */ 1779 WPA_IF_P2P_DEVICE, 1780 1781 /* 1782 * WPA_IF_MESH - Mesh interface 1783 */ 1784 WPA_IF_MESH, 1785 1786 /* 1787 * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only) 1788 */ 1789 WPA_IF_TDLS, 1790 1791 /* 1792 * WPA_IF_IBSS - IBSS interface (used for pref freq only) 1793 */ 1794 WPA_IF_IBSS, 1795 1796 /* 1797 * WPA_IF_NAN - NAN Device 1798 */ 1799 WPA_IF_NAN, 1800 1801 /* keep last */ 1802 WPA_IF_MAX 1803 }; 1804 1805 /** 1806 * struct wpa_driver_capa - Driver capability information 1807 */ 1808 struct wpa_driver_capa { 1809 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA 0x00000001 1810 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2 0x00000002 1811 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK 0x00000004 1812 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008 1813 #define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010 1814 #define WPA_DRIVER_CAPA_KEY_MGMT_FT 0x00000020 1815 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK 0x00000040 1816 #define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080 1817 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B 0x00000100 1818 #define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192 0x00000200 1819 #define WPA_DRIVER_CAPA_KEY_MGMT_OWE 0x00000400 1820 #define WPA_DRIVER_CAPA_KEY_MGMT_DPP 0x00000800 1821 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256 0x00001000 1822 #define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384 0x00002000 1823 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000 1824 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000 1825 #define WPA_DRIVER_CAPA_KEY_MGMT_SAE 0x00010000 1826 #define WPA_DRIVER_CAPA_KEY_MGMT_802_1X_SHA256 0x00020000 1827 #define WPA_DRIVER_CAPA_KEY_MGMT_PSK_SHA256 0x00040000 1828 #define WPA_DRIVER_CAPA_KEY_MGMT_TPK_HANDSHAKE 0x00080000 1829 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_SAE 0x00100000 1830 #define WPA_DRIVER_CAPA_KEY_MGMT_FT_802_1X_SHA384 0x00200000 1831 #define WPA_DRIVER_CAPA_KEY_MGMT_CCKM 0x00400000 1832 #define WPA_DRIVER_CAPA_KEY_MGMT_OSEN 0x00800000 1833 /** Bitfield of supported key management suites */ 1834 unsigned int key_mgmt; 1835 unsigned int key_mgmt_iftype[WPA_IF_MAX]; 1836 1837 #define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001 1838 #define WPA_DRIVER_CAPA_ENC_WEP104 0x00000002 1839 #define WPA_DRIVER_CAPA_ENC_TKIP 0x00000004 1840 #define WPA_DRIVER_CAPA_ENC_CCMP 0x00000008 1841 #define WPA_DRIVER_CAPA_ENC_WEP128 0x00000010 1842 #define WPA_DRIVER_CAPA_ENC_GCMP 0x00000020 1843 #define WPA_DRIVER_CAPA_ENC_GCMP_256 0x00000040 1844 #define WPA_DRIVER_CAPA_ENC_CCMP_256 0x00000080 1845 #define WPA_DRIVER_CAPA_ENC_BIP 0x00000100 1846 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128 0x00000200 1847 #define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256 0x00000400 1848 #define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256 0x00000800 1849 #define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED 0x00001000 1850 /** Bitfield of supported cipher suites */ 1851 unsigned int enc; 1852 1853 #define WPA_DRIVER_AUTH_OPEN 0x00000001 1854 #define WPA_DRIVER_AUTH_SHARED 0x00000002 1855 #define WPA_DRIVER_AUTH_LEAP 0x00000004 1856 /** Bitfield of supported IEEE 802.11 authentication algorithms */ 1857 unsigned int auth; 1858 1859 /** Driver generated WPA/RSN IE */ 1860 #define WPA_DRIVER_FLAGS_DRIVER_IE 0x00000001 1861 /** Driver needs static WEP key setup after association command */ 1862 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002 1863 /** Driver takes care of all DFS operations */ 1864 #define WPA_DRIVER_FLAGS_DFS_OFFLOAD 0x00000004 1865 /** Driver takes care of RSN 4-way handshake internally; PMK is configured with 1866 * struct wpa_driver_ops::set_key using key_flag = KEY_FLAG_PMK */ 1867 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X 0x00000008 1868 /** Driver is for a wired Ethernet interface */ 1869 #define WPA_DRIVER_FLAGS_WIRED 0x00000010 1870 /** Driver provides separate commands for authentication and association (SME in 1871 * wpa_supplicant). */ 1872 #define WPA_DRIVER_FLAGS_SME 0x00000020 1873 /** Driver supports AP mode */ 1874 #define WPA_DRIVER_FLAGS_AP 0x00000040 1875 /** Driver needs static WEP key setup after association has been completed */ 1876 #define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE 0x00000080 1877 /** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */ 1878 #define WPA_DRIVER_FLAGS_HT_2040_COEX 0x00000100 1879 /** Driver supports concurrent P2P operations */ 1880 #define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200 1881 /** 1882 * Driver uses the initial interface as a dedicated management interface, i.e., 1883 * it cannot be used for P2P group operations or non-P2P purposes. 1884 */ 1885 #define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE 0x00000400 1886 /** This interface is P2P capable (P2P GO or P2P Client) */ 1887 #define WPA_DRIVER_FLAGS_P2P_CAPABLE 0x00000800 1888 /** Driver supports station and key removal when stopping an AP */ 1889 #define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT 0x00001000 1890 /** 1891 * Driver uses the initial interface for P2P management interface and non-P2P 1892 * purposes (e.g., connect to infra AP), but this interface cannot be used for 1893 * P2P group operations. 1894 */ 1895 #define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P 0x00002000 1896 /** 1897 * Driver is known to use sane error codes, i.e., when it indicates that 1898 * something (e.g., association) fails, there was indeed a failure and the 1899 * operation does not end up getting completed successfully later. 1900 */ 1901 #define WPA_DRIVER_FLAGS_SANE_ERROR_CODES 0x00004000 1902 /** Driver supports off-channel TX */ 1903 #define WPA_DRIVER_FLAGS_OFFCHANNEL_TX 0x00008000 1904 /** Driver indicates TX status events for EAPOL Data frames */ 1905 #define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS 0x00010000 1906 /** Driver indicates TX status events for Deauth/Disassoc frames */ 1907 #define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS 0x00020000 1908 /** Driver supports roaming (BSS selection) in firmware */ 1909 #define WPA_DRIVER_FLAGS_BSS_SELECTION 0x00040000 1910 /** Driver supports operating as a TDLS peer */ 1911 #define WPA_DRIVER_FLAGS_TDLS_SUPPORT 0x00080000 1912 /** Driver requires external TDLS setup/teardown/discovery */ 1913 #define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP 0x00100000 1914 /** Driver indicates support for Probe Response offloading in AP mode */ 1915 #define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD 0x00200000 1916 /** Driver supports U-APSD in AP mode */ 1917 #define WPA_DRIVER_FLAGS_AP_UAPSD 0x00400000 1918 /** Driver supports inactivity timer in AP mode */ 1919 #define WPA_DRIVER_FLAGS_INACTIVITY_TIMER 0x00800000 1920 /** Driver expects user space implementation of MLME in AP mode */ 1921 #define WPA_DRIVER_FLAGS_AP_MLME 0x01000000 1922 /** Driver supports SAE with user space SME */ 1923 #define WPA_DRIVER_FLAGS_SAE 0x02000000 1924 /** Driver makes use of OBSS scan mechanism in wpa_supplicant */ 1925 #define WPA_DRIVER_FLAGS_OBSS_SCAN 0x04000000 1926 /** Driver supports IBSS (Ad-hoc) mode */ 1927 #define WPA_DRIVER_FLAGS_IBSS 0x08000000 1928 /** Driver supports radar detection */ 1929 #define WPA_DRIVER_FLAGS_RADAR 0x10000000 1930 /** Driver supports a dedicated interface for P2P Device */ 1931 #define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE 0x20000000 1932 /** Driver supports QoS Mapping */ 1933 #define WPA_DRIVER_FLAGS_QOS_MAPPING 0x40000000 1934 /** Driver supports CSA in AP mode */ 1935 #define WPA_DRIVER_FLAGS_AP_CSA 0x80000000 1936 /** Driver supports mesh */ 1937 #define WPA_DRIVER_FLAGS_MESH 0x0000000100000000ULL 1938 /** Driver support ACS offload */ 1939 #define WPA_DRIVER_FLAGS_ACS_OFFLOAD 0x0000000200000000ULL 1940 /** Driver supports key management offload */ 1941 #define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL 1942 /** Driver supports TDLS channel switching */ 1943 #define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH 0x0000000800000000ULL 1944 /** Driver supports IBSS with HT datarates */ 1945 #define WPA_DRIVER_FLAGS_HT_IBSS 0x0000001000000000ULL 1946 /** Driver supports IBSS with VHT datarates */ 1947 #define WPA_DRIVER_FLAGS_VHT_IBSS 0x0000002000000000ULL 1948 /** Driver supports automatic band selection */ 1949 #define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY 0x0000004000000000ULL 1950 /** Driver supports simultaneous off-channel operations */ 1951 #define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS 0x0000008000000000ULL 1952 /** Driver supports full AP client state */ 1953 #define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL 1954 /** Driver supports P2P Listen offload */ 1955 #define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD 0x0000020000000000ULL 1956 /** Driver supports FILS */ 1957 #define WPA_DRIVER_FLAGS_SUPPORT_FILS 0x0000040000000000ULL 1958 /** Driver supports Beacon frame TX rate configuration (legacy rates) */ 1959 #define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL 1960 /** Driver supports Beacon frame TX rate configuration (HT rates) */ 1961 #define WPA_DRIVER_FLAGS_BEACON_RATE_HT 0x0000100000000000ULL 1962 /** Driver supports Beacon frame TX rate configuration (VHT rates) */ 1963 #define WPA_DRIVER_FLAGS_BEACON_RATE_VHT 0x0000200000000000ULL 1964 /** Driver supports mgmt_tx with random TX address in non-connected state */ 1965 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA 0x0000400000000000ULL 1966 /** Driver supports mgmt_tx with random TX addr in connected state */ 1967 #define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED 0x0000800000000000ULL 1968 /** Driver supports better BSS reporting with sched_scan in connected mode */ 1969 #define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL 1970 /** Driver supports HE capabilities */ 1971 #define WPA_DRIVER_FLAGS_HE_CAPABILITIES 0x0002000000000000ULL 1972 /** Driver supports FILS shared key offload */ 1973 #define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD 0x0004000000000000ULL 1974 /** Driver supports all OCE STA specific mandatory features */ 1975 #define WPA_DRIVER_FLAGS_OCE_STA 0x0008000000000000ULL 1976 /** Driver supports all OCE AP specific mandatory features */ 1977 #define WPA_DRIVER_FLAGS_OCE_AP 0x0010000000000000ULL 1978 /** 1979 * Driver supports all OCE STA-CFON specific mandatory features only. 1980 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the 1981 * userspace shall assume that this driver may not support all OCE AP 1982 * functionality but can support only OCE STA-CFON functionality. 1983 */ 1984 #define WPA_DRIVER_FLAGS_OCE_STA_CFON 0x0020000000000000ULL 1985 /** Driver supports MFP-optional in the connect command */ 1986 #define WPA_DRIVER_FLAGS_MFP_OPTIONAL 0x0040000000000000ULL 1987 /** Driver is a self-managed regulatory device */ 1988 #define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY 0x0080000000000000ULL 1989 /** Driver supports FTM responder functionality */ 1990 #define WPA_DRIVER_FLAGS_FTM_RESPONDER 0x0100000000000000ULL 1991 /** Driver support 4-way handshake offload for WPA-Personal */ 1992 #define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL 1993 /** Driver supports a separate control port TX for EAPOL frames */ 1994 #define WPA_DRIVER_FLAGS_CONTROL_PORT 0x0400000000000000ULL 1995 /** Driver supports VLAN offload */ 1996 #define WPA_DRIVER_FLAGS_VLAN_OFFLOAD 0x0800000000000000ULL 1997 /** Driver supports UPDATE_FT_IES command */ 1998 #define WPA_DRIVER_FLAGS_UPDATE_FT_IES 0x1000000000000000ULL 1999 /** Driver can correctly rekey PTKs without Extended Key ID */ 2000 #define WPA_DRIVER_FLAGS_SAFE_PTK0_REKEYS 0x2000000000000000ULL 2001 /** Driver supports Beacon protection */ 2002 #define WPA_DRIVER_FLAGS_BEACON_PROTECTION 0x4000000000000000ULL 2003 /** Driver supports Extended Key ID */ 2004 #define WPA_DRIVER_FLAGS_EXTENDED_KEY_ID 0x8000000000000000ULL 2005 u64 flags; 2006 2007 /** Driver supports a separate control port RX for EAPOL frames */ 2008 #define WPA_DRIVER_FLAGS2_CONTROL_PORT_RX 0x0000000000000001ULL 2009 /** Driver supports TX status reports for EAPOL frames through control port */ 2010 #define WPA_DRIVER_FLAGS2_CONTROL_PORT_TX_STATUS 0x0000000000000002ULL 2011 /** Driver supports secure LTF */ 2012 #define WPA_DRIVER_FLAGS2_SEC_LTF 0x0000000000000004ULL 2013 /** Driver supports secure RTT measurement exchange */ 2014 #define WPA_DRIVER_FLAGS2_SEC_RTT 0x0000000000000008ULL 2015 /** 2016 * Driver supports protection of range negotiation and measurement management 2017 * frames 2018 */ 2019 #define WPA_DRIVER_FLAGS2_PROT_RANGE_NEG 0x0000000000000010ULL 2020 /** Driver supports Beacon frame TX rate configuration (HE rates) */ 2021 #define WPA_DRIVER_FLAGS2_BEACON_RATE_HE 0x0000000000000020ULL 2022 /** Driver supports Beacon protection only in client mode */ 2023 #define WPA_DRIVER_FLAGS2_BEACON_PROTECTION_CLIENT 0x0000000000000040ULL 2024 /** Driver supports Operating Channel Validation */ 2025 #define WPA_DRIVER_FLAGS2_OCV 0x0000000000000080ULL 2026 /** Driver expects user space implementation of SME in AP mode */ 2027 #define WPA_DRIVER_FLAGS2_AP_SME 0x0000000000000100ULL 2028 u64 flags2; 2029 2030 #define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \ 2031 (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE) 2032 2033 unsigned int wmm_ac_supported:1; 2034 2035 unsigned int mac_addr_rand_scan_supported:1; 2036 unsigned int mac_addr_rand_sched_scan_supported:1; 2037 2038 /** Maximum number of supported active probe SSIDs */ 2039 int max_scan_ssids; 2040 2041 /** Maximum number of supported active probe SSIDs for sched_scan */ 2042 int max_sched_scan_ssids; 2043 2044 /** Maximum number of supported scan plans for scheduled scan */ 2045 unsigned int max_sched_scan_plans; 2046 2047 /** Maximum interval in a scan plan. In seconds */ 2048 u32 max_sched_scan_plan_interval; 2049 2050 /** Maximum number of iterations in a single scan plan */ 2051 u32 max_sched_scan_plan_iterations; 2052 2053 /** Whether sched_scan (offloaded scanning) is supported */ 2054 int sched_scan_supported; 2055 2056 /** Maximum number of supported match sets for sched_scan */ 2057 int max_match_sets; 2058 2059 /** 2060 * max_remain_on_chan - Maximum remain-on-channel duration in msec 2061 */ 2062 unsigned int max_remain_on_chan; 2063 2064 /** 2065 * max_stations - Maximum number of associated stations the driver 2066 * supports in AP mode 2067 */ 2068 unsigned int max_stations; 2069 2070 /** 2071 * probe_resp_offloads - Bitmap of supported protocols by the driver 2072 * for Probe Response offloading. 2073 */ 2074 /** Driver Probe Response offloading support for WPS ver. 1 */ 2075 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS 0x00000001 2076 /** Driver Probe Response offloading support for WPS ver. 2 */ 2077 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2 0x00000002 2078 /** Driver Probe Response offloading support for P2P */ 2079 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P 0x00000004 2080 /** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */ 2081 #define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING 0x00000008 2082 unsigned int probe_resp_offloads; 2083 2084 unsigned int max_acl_mac_addrs; 2085 2086 /** 2087 * Number of supported concurrent channels 2088 */ 2089 unsigned int num_multichan_concurrent; 2090 2091 /** 2092 * extended_capa - extended capabilities in driver/device 2093 * 2094 * Must be allocated and freed by driver and the pointers must be 2095 * valid for the lifetime of the driver, i.e., freed in deinit() 2096 */ 2097 const u8 *extended_capa, *extended_capa_mask; 2098 unsigned int extended_capa_len; 2099 2100 struct wowlan_triggers wowlan_triggers; 2101 2102 /** Driver adds the DS Params Set IE in Probe Request frames */ 2103 #define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES 0x00000001 2104 /** Driver adds the WFA TPC IE in Probe Request frames */ 2105 #define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES 0x00000002 2106 /** Driver handles quiet period requests */ 2107 #define WPA_DRIVER_FLAGS_QUIET 0x00000004 2108 /** 2109 * Driver is capable of inserting the current TX power value into the body of 2110 * transmitted frames. 2111 * Background: Some Action frames include a TPC Report IE. This IE contains a 2112 * TX power field, which has to be updated by lower layers. One such Action 2113 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part 2114 * of spectrum management). Note that this insertion takes place at a fixed 2115 * offset, namely the 6th byte in the Action frame body. 2116 */ 2117 #define WPA_DRIVER_FLAGS_TX_POWER_INSERTION 0x00000008 2118 /** 2119 * Driver supports RRM. With this support, the driver will accept to use RRM in 2120 * (Re)Association Request frames, without supporting quiet period. 2121 */ 2122 #define WPA_DRIVER_FLAGS_SUPPORT_RRM 0x00000010 2123 2124 /** Driver supports setting the scan dwell time */ 2125 #define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL 0x00000020 2126 /** Driver supports Beacon Report Measurement */ 2127 #define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT 0x00000040 2128 2129 u32 rrm_flags; 2130 2131 /* Driver concurrency capabilities */ 2132 unsigned int conc_capab; 2133 /* Maximum number of concurrent channels on 2.4 GHz */ 2134 unsigned int max_conc_chan_2_4; 2135 /* Maximum number of concurrent channels on 5 GHz */ 2136 unsigned int max_conc_chan_5_0; 2137 2138 /* Maximum number of supported CSA counters */ 2139 u16 max_csa_counters; 2140 }; 2141 2142 2143 struct hostapd_data; 2144 2145 #define STA_DRV_DATA_TX_MCS BIT(0) 2146 #define STA_DRV_DATA_RX_MCS BIT(1) 2147 #define STA_DRV_DATA_TX_VHT_MCS BIT(2) 2148 #define STA_DRV_DATA_RX_VHT_MCS BIT(3) 2149 #define STA_DRV_DATA_TX_VHT_NSS BIT(4) 2150 #define STA_DRV_DATA_RX_VHT_NSS BIT(5) 2151 #define STA_DRV_DATA_TX_SHORT_GI BIT(6) 2152 #define STA_DRV_DATA_RX_SHORT_GI BIT(7) 2153 #define STA_DRV_DATA_LAST_ACK_RSSI BIT(8) 2154 2155 struct hostap_sta_driver_data { 2156 unsigned long rx_packets, tx_packets; 2157 unsigned long long rx_bytes, tx_bytes; 2158 unsigned long long rx_airtime, tx_airtime; 2159 int bytes_64bit; /* whether 64-bit byte counters are supported */ 2160 unsigned long current_tx_rate; 2161 unsigned long current_rx_rate; 2162 unsigned long inactive_msec; 2163 unsigned long flags; /* bitfield of STA_DRV_DATA_* */ 2164 unsigned long num_ps_buf_frames; 2165 unsigned long tx_retry_failed; 2166 unsigned long tx_retry_count; 2167 s8 last_ack_rssi; 2168 unsigned long backlog_packets; 2169 unsigned long backlog_bytes; 2170 s8 signal; 2171 u8 rx_vhtmcs; 2172 u8 tx_vhtmcs; 2173 u8 rx_mcs; 2174 u8 tx_mcs; 2175 u8 rx_vht_nss; 2176 u8 tx_vht_nss; 2177 }; 2178 2179 struct hostapd_sta_add_params { 2180 const u8 *addr; 2181 u16 aid; 2182 u16 capability; 2183 const u8 *supp_rates; 2184 size_t supp_rates_len; 2185 u16 listen_interval; 2186 const struct ieee80211_ht_capabilities *ht_capabilities; 2187 const struct ieee80211_vht_capabilities *vht_capabilities; 2188 int vht_opmode_enabled; 2189 u8 vht_opmode; 2190 const struct ieee80211_he_capabilities *he_capab; 2191 size_t he_capab_len; 2192 const struct ieee80211_he_6ghz_band_cap *he_6ghz_capab; 2193 u32 flags; /* bitmask of WPA_STA_* flags */ 2194 u32 flags_mask; /* unset bits in flags */ 2195 #ifdef CONFIG_MESH 2196 enum mesh_plink_state plink_state; 2197 u16 peer_aid; 2198 #endif /* CONFIG_MESH */ 2199 int set; /* Set STA parameters instead of add */ 2200 u8 qosinfo; 2201 const u8 *ext_capab; 2202 size_t ext_capab_len; 2203 const u8 *supp_channels; 2204 size_t supp_channels_len; 2205 const u8 *supp_oper_classes; 2206 size_t supp_oper_classes_len; 2207 int support_p2p_ps; 2208 }; 2209 2210 struct mac_address { 2211 u8 addr[ETH_ALEN]; 2212 }; 2213 2214 struct hostapd_acl_params { 2215 u8 acl_policy; 2216 unsigned int num_mac_acl; 2217 struct mac_address mac_acl[0]; 2218 }; 2219 2220 struct wpa_init_params { 2221 void *global_priv; 2222 const u8 *bssid; 2223 const char *ifname; 2224 const char *driver_params; 2225 int use_pae_group_addr; 2226 char **bridge; 2227 size_t num_bridge; 2228 2229 u8 *own_addr; /* buffer for writing own MAC address */ 2230 }; 2231 2232 2233 struct wpa_bss_params { 2234 /** Interface name (for multi-SSID/VLAN support) */ 2235 const char *ifname; 2236 /** Whether IEEE 802.1X or WPA/WPA2 is enabled */ 2237 int enabled; 2238 2239 int wpa; 2240 int ieee802_1x; 2241 int wpa_group; 2242 int wpa_pairwise; 2243 int wpa_key_mgmt; 2244 int rsn_preauth; 2245 enum mfp_options ieee80211w; 2246 }; 2247 2248 #define WPA_STA_AUTHORIZED BIT(0) 2249 #define WPA_STA_WMM BIT(1) 2250 #define WPA_STA_SHORT_PREAMBLE BIT(2) 2251 #define WPA_STA_MFP BIT(3) 2252 #define WPA_STA_TDLS_PEER BIT(4) 2253 #define WPA_STA_AUTHENTICATED BIT(5) 2254 #define WPA_STA_ASSOCIATED BIT(6) 2255 2256 enum tdls_oper { 2257 TDLS_DISCOVERY_REQ, 2258 TDLS_SETUP, 2259 TDLS_TEARDOWN, 2260 TDLS_ENABLE_LINK, 2261 TDLS_DISABLE_LINK, 2262 TDLS_ENABLE, 2263 TDLS_DISABLE 2264 }; 2265 2266 enum wnm_oper { 2267 WNM_SLEEP_ENTER_CONFIRM, 2268 WNM_SLEEP_ENTER_FAIL, 2269 WNM_SLEEP_EXIT_CONFIRM, 2270 WNM_SLEEP_EXIT_FAIL, 2271 WNM_SLEEP_TFS_REQ_IE_ADD, /* STA requests driver to add TFS req IE */ 2272 WNM_SLEEP_TFS_REQ_IE_NONE, /* STA requests empty TFS req IE */ 2273 WNM_SLEEP_TFS_REQ_IE_SET, /* AP requests driver to set TFS req IE for 2274 * a STA */ 2275 WNM_SLEEP_TFS_RESP_IE_ADD, /* AP requests driver to add TFS resp IE 2276 * for a STA */ 2277 WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */ 2278 WNM_SLEEP_TFS_RESP_IE_SET, /* AP requests driver to set TFS resp IE 2279 * for a STA */ 2280 WNM_SLEEP_TFS_IE_DEL /* AP delete the TFS IE */ 2281 }; 2282 2283 /* enum smps_mode - SMPS mode definitions */ 2284 enum smps_mode { 2285 SMPS_AUTOMATIC, 2286 SMPS_OFF, 2287 SMPS_DYNAMIC, 2288 SMPS_STATIC, 2289 2290 /* Keep last */ 2291 SMPS_INVALID, 2292 }; 2293 2294 #define WPA_INVALID_NOISE 9999 2295 2296 /** 2297 * struct wpa_signal_info - Information about channel signal quality 2298 * @frequency: control frequency 2299 * @above_threshold: true if the above threshold was crossed 2300 * (relevant for a CQM event) 2301 * @current_signal: in dBm 2302 * @avg_signal: in dBm 2303 * @avg_beacon_signal: in dBm 2304 * @current_noise: %WPA_INVALID_NOISE if not supported 2305 * @current_txrate: current TX rate 2306 * @chanwidth: channel width 2307 * @center_frq1: center frequency for the first segment 2308 * @center_frq2: center frequency for the second segment (if relevant) 2309 */ 2310 struct wpa_signal_info { 2311 u32 frequency; 2312 int above_threshold; 2313 int current_signal; 2314 int avg_signal; 2315 int avg_beacon_signal; 2316 int current_noise; 2317 int current_txrate; 2318 enum chan_width chanwidth; 2319 int center_frq1; 2320 int center_frq2; 2321 }; 2322 2323 /** 2324 * struct wpa_channel_info - Information about the current channel 2325 * @frequency: Center frequency of the primary 20 MHz channel 2326 * @chanwidth: Width of the current operating channel 2327 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1). 2328 * This field is only filled in when using a 40 MHz channel. 2329 * @center_frq1: Center frequency of frequency segment 0 2330 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels) 2331 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is 2332 * derived from center_frq2 for convenience. 2333 */ 2334 struct wpa_channel_info { 2335 u32 frequency; 2336 enum chan_width chanwidth; 2337 int sec_channel; 2338 int center_frq1; 2339 int center_frq2; 2340 u8 seg1_idx; 2341 }; 2342 2343 /** 2344 * struct beacon_data - Beacon data 2345 * @head: Head portion of Beacon frame (before TIM IE) 2346 * @tail: Tail portion of Beacon frame (after TIM IE) 2347 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL 2348 * @proberesp_ies: Extra information element(s) to add into Probe Response 2349 * frames or %NULL 2350 * @assocresp_ies: Extra information element(s) to add into (Re)Association 2351 * Response frames or %NULL 2352 * @probe_resp: Probe Response frame template 2353 * @head_len: Length of @head 2354 * @tail_len: Length of @tail 2355 * @beacon_ies_len: Length of beacon_ies in octets 2356 * @proberesp_ies_len: Length of proberesp_ies in octets 2357 * @proberesp_ies_len: Length of proberesp_ies in octets 2358 * @probe_resp_len: Length of probe response template (@probe_resp) 2359 */ 2360 struct beacon_data { 2361 u8 *head, *tail; 2362 u8 *beacon_ies; 2363 u8 *proberesp_ies; 2364 u8 *assocresp_ies; 2365 u8 *probe_resp; 2366 2367 size_t head_len, tail_len; 2368 size_t beacon_ies_len; 2369 size_t proberesp_ies_len; 2370 size_t assocresp_ies_len; 2371 size_t probe_resp_len; 2372 }; 2373 2374 /** 2375 * struct csa_settings - Settings for channel switch command 2376 * @cs_count: Count in Beacon frames (TBTT) to perform the switch 2377 * @block_tx: 1 - block transmission for CSA period 2378 * @freq_params: Next channel frequency parameter 2379 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period 2380 * @beacon_after: Next beacon/probe resp/asooc resp info 2381 * @counter_offset_beacon: Offset to the count field in beacon's tail 2382 * @counter_offset_presp: Offset to the count field in probe resp. 2383 */ 2384 struct csa_settings { 2385 u8 cs_count; 2386 u8 block_tx; 2387 2388 struct hostapd_freq_params freq_params; 2389 struct beacon_data beacon_csa; 2390 struct beacon_data beacon_after; 2391 2392 u16 counter_offset_beacon[2]; 2393 u16 counter_offset_presp[2]; 2394 }; 2395 2396 /* TDLS peer capabilities for send_tdls_mgmt() */ 2397 enum tdls_peer_capability { 2398 TDLS_PEER_HT = BIT(0), 2399 TDLS_PEER_VHT = BIT(1), 2400 TDLS_PEER_WMM = BIT(2), 2401 TDLS_PEER_HE = BIT(3), 2402 }; 2403 2404 /* valid info in the wmm_params struct */ 2405 enum wmm_params_valid_info { 2406 WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0), 2407 }; 2408 2409 /** 2410 * struct wmm_params - WMM parameterss configured for this association 2411 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields 2412 * of the struct contain valid information. 2413 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if 2414 * %WMM_PARAMS_UAPSD_QUEUES_INFO is set) 2415 */ 2416 struct wmm_params { 2417 u8 info_bitmap; 2418 u8 uapsd_queues; 2419 }; 2420 2421 #ifdef CONFIG_MACSEC 2422 struct macsec_init_params { 2423 bool always_include_sci; 2424 bool use_es; 2425 bool use_scb; 2426 }; 2427 #endif /* CONFIG_MACSEC */ 2428 2429 enum drv_br_port_attr { 2430 DRV_BR_PORT_ATTR_PROXYARP, 2431 DRV_BR_PORT_ATTR_HAIRPIN_MODE, 2432 }; 2433 2434 enum drv_br_net_param { 2435 DRV_BR_NET_PARAM_GARP_ACCEPT, 2436 DRV_BR_MULTICAST_SNOOPING, 2437 }; 2438 2439 struct drv_acs_params { 2440 /* Selected mode (HOSTAPD_MODE_*) */ 2441 enum hostapd_hw_mode hw_mode; 2442 2443 /* Indicates whether HT is enabled */ 2444 int ht_enabled; 2445 2446 /* Indicates whether HT40 is enabled */ 2447 int ht40_enabled; 2448 2449 /* Indicates whether VHT is enabled */ 2450 int vht_enabled; 2451 2452 /* Configured ACS channel width */ 2453 u16 ch_width; 2454 2455 /* ACS frequency list info */ 2456 const int *freq_list; 2457 2458 /* Indicates whether EDMG is enabled */ 2459 int edmg_enabled; 2460 }; 2461 2462 struct wpa_bss_trans_info { 2463 u8 mbo_transition_reason; 2464 u8 n_candidates; 2465 u8 *bssid; 2466 }; 2467 2468 struct wpa_bss_candidate_info { 2469 u8 num; 2470 struct candidate_list { 2471 u8 bssid[ETH_ALEN]; 2472 u8 is_accept; 2473 u32 reject_reason; 2474 } *candidates; 2475 }; 2476 2477 struct wpa_pmkid_params { 2478 const u8 *bssid; 2479 const u8 *ssid; 2480 size_t ssid_len; 2481 const u8 *fils_cache_id; 2482 const u8 *pmkid; 2483 const u8 *pmk; 2484 size_t pmk_len; 2485 u32 pmk_lifetime; 2486 u8 pmk_reauth_threshold; 2487 }; 2488 2489 /* Mask used to specify which connection parameters have to be updated */ 2490 enum wpa_drv_update_connect_params_mask { 2491 WPA_DRV_UPDATE_ASSOC_IES = BIT(0), 2492 WPA_DRV_UPDATE_FILS_ERP_INFO = BIT(1), 2493 WPA_DRV_UPDATE_AUTH_TYPE = BIT(2), 2494 }; 2495 2496 /** 2497 * struct external_auth - External authentication trigger parameters 2498 * 2499 * These are used across the external authentication request and event 2500 * interfaces. 2501 * @action: Action type / trigger for external authentication. Only significant 2502 * for the event interface. 2503 * @bssid: BSSID of the peer with which the authentication has to happen. Used 2504 * by both the request and event interface. 2505 * @ssid: SSID of the AP. Used by both the request and event interface. 2506 * @ssid_len: SSID length in octets. 2507 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for 2508 * the request interface. 2509 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication, 2510 * use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give 2511 * the real status code for failures. Used only for the request interface 2512 * from user space to the driver. 2513 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE). 2514 */ 2515 struct external_auth { 2516 enum { 2517 EXT_AUTH_START, 2518 EXT_AUTH_ABORT, 2519 } action; 2520 const u8 *bssid; 2521 const u8 *ssid; 2522 size_t ssid_len; 2523 unsigned int key_mgmt_suite; 2524 u16 status; 2525 const u8 *pmkid; 2526 }; 2527 2528 /* enum nested_attr - Used to specify if subcommand uses nested attributes */ 2529 enum nested_attr { 2530 NESTED_ATTR_NOT_USED = 0, 2531 NESTED_ATTR_USED = 1, 2532 NESTED_ATTR_UNSPECIFIED = 2, 2533 }; 2534 2535 /** 2536 * struct wpa_driver_ops - Driver interface API definition 2537 * 2538 * This structure defines the API that each driver interface needs to implement 2539 * for core wpa_supplicant code. All driver specific functionality is captured 2540 * in this wrapper. 2541 */ 2542 struct wpa_driver_ops { 2543 /** Name of the driver interface */ 2544 const char *name; 2545 /** One line description of the driver interface */ 2546 const char *desc; 2547 2548 /** 2549 * get_bssid - Get the current BSSID 2550 * @priv: private driver interface data 2551 * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes) 2552 * 2553 * Returns: 0 on success, -1 on failure 2554 * 2555 * Query kernel driver for the current BSSID and copy it to bssid. 2556 * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not 2557 * associated. 2558 */ 2559 int (*get_bssid)(void *priv, u8 *bssid); 2560 2561 /** 2562 * get_ssid - Get the current SSID 2563 * @priv: private driver interface data 2564 * @ssid: buffer for SSID (at least 32 bytes) 2565 * 2566 * Returns: Length of the SSID on success, -1 on failure 2567 * 2568 * Query kernel driver for the current SSID and copy it to ssid. 2569 * Returning zero is recommended if the STA is not associated. 2570 * 2571 * Note: SSID is an array of octets, i.e., it is not nul terminated and 2572 * can, at least in theory, contain control characters (including nul) 2573 * and as such, should be processed as binary data, not a printable 2574 * string. 2575 */ 2576 int (*get_ssid)(void *priv, u8 *ssid); 2577 2578 /** 2579 * set_key - Configure encryption key 2580 * @priv: private driver interface data 2581 * @params: Key parameters 2582 * Returns: 0 on success, -1 on failure 2583 * 2584 * Configure the given key for the kernel driver. If the driver 2585 * supports separate individual keys (4 default keys + 1 individual), 2586 * addr can be used to determine whether the key is default or 2587 * individual. If only 4 keys are supported, the default key with key 2588 * index 0 is used as the individual key. STA must be configured to use 2589 * it as the default Tx key (set_tx is set) and accept Rx for all the 2590 * key indexes. In most cases, WPA uses only key indexes 1 and 2 for 2591 * broadcast keys, so key index 0 is available for this kind of 2592 * configuration. 2593 * 2594 * Please note that TKIP keys include separate TX and RX MIC keys and 2595 * some drivers may expect them in different order than wpa_supplicant 2596 * is using. If the TX/RX keys are swapped, all TKIP encrypted packets 2597 * will trigger Michael MIC errors. This can be fixed by changing the 2598 * order of MIC keys by swapping te bytes 16..23 and 24..31 of the key 2599 * in driver_*.c set_key() implementation, see driver_ndis.c for an 2600 * example on how this can be done. 2601 */ 2602 int (*set_key)(void *priv, struct wpa_driver_set_key_params *params); 2603 2604 /** 2605 * init - Initialize driver interface 2606 * @ctx: context to be used when calling wpa_supplicant functions, 2607 * e.g., wpa_supplicant_event() 2608 * @ifname: interface name, e.g., wlan0 2609 * 2610 * Returns: Pointer to private data, %NULL on failure 2611 * 2612 * Initialize driver interface, including event processing for kernel 2613 * driver events (e.g., associated, scan results, Michael MIC failure). 2614 * This function can allocate a private configuration data area for 2615 * @ctx, file descriptor, interface name, etc. information that may be 2616 * needed in future driver operations. If this is not used, non-NULL 2617 * value will need to be returned because %NULL is used to indicate 2618 * failure. The returned value will be used as 'void *priv' data for 2619 * all other driver_ops functions. 2620 * 2621 * The main event loop (eloop.c) of wpa_supplicant can be used to 2622 * register callback for read sockets (eloop_register_read_sock()). 2623 * 2624 * See below for more information about events and 2625 * wpa_supplicant_event() function. 2626 */ 2627 void * (*init)(void *ctx, const char *ifname); 2628 2629 /** 2630 * deinit - Deinitialize driver interface 2631 * @priv: private driver interface data from init() 2632 * 2633 * Shut down driver interface and processing of driver events. Free 2634 * private data buffer if one was allocated in init() handler. 2635 */ 2636 void (*deinit)(void *priv); 2637 2638 /** 2639 * set_param - Set driver configuration parameters 2640 * @priv: private driver interface data from init() 2641 * @param: driver specific configuration parameters 2642 * 2643 * Returns: 0 on success, -1 on failure 2644 * 2645 * Optional handler for notifying driver interface about configuration 2646 * parameters (driver_param). 2647 */ 2648 int (*set_param)(void *priv, const char *param); 2649 2650 /** 2651 * set_countermeasures - Enable/disable TKIP countermeasures 2652 * @priv: private driver interface data 2653 * @enabled: 1 = countermeasures enabled, 0 = disabled 2654 * 2655 * Returns: 0 on success, -1 on failure 2656 * 2657 * Configure TKIP countermeasures. When these are enabled, the driver 2658 * should drop all received and queued frames that are using TKIP. 2659 */ 2660 int (*set_countermeasures)(void *priv, int enabled); 2661 2662 /** 2663 * deauthenticate - Request driver to deauthenticate 2664 * @priv: private driver interface data 2665 * @addr: peer address (BSSID of the AP) 2666 * @reason_code: 16-bit reason code to be sent in the deauthentication 2667 * frame 2668 * 2669 * Returns: 0 on success, -1 on failure 2670 */ 2671 int (*deauthenticate)(void *priv, const u8 *addr, u16 reason_code); 2672 2673 /** 2674 * associate - Request driver to associate 2675 * @priv: private driver interface data 2676 * @params: association parameters 2677 * 2678 * Returns: 0 on success, -1 on failure 2679 */ 2680 int (*associate)(void *priv, 2681 struct wpa_driver_associate_params *params); 2682 2683 /** 2684 * add_pmkid - Add PMKSA cache entry to the driver 2685 * @priv: private driver interface data 2686 * @params: PMKSA parameters 2687 * 2688 * Returns: 0 on success, -1 on failure 2689 * 2690 * This function is called when a new PMK is received, as a result of 2691 * either normal authentication or RSN pre-authentication. The PMKSA 2692 * parameters are either a set of bssid, pmkid, and pmk; or a set of 2693 * ssid, fils_cache_id, pmkid, and pmk. 2694 * 2695 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 2696 * associate(), add_pmkid() can be used to add new PMKSA cache entries 2697 * in the driver. If the driver uses wpa_ie from wpa_supplicant, this 2698 * driver_ops function does not need to be implemented. Likewise, if 2699 * the driver does not support WPA, this function is not needed. 2700 */ 2701 int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params); 2702 2703 /** 2704 * remove_pmkid - Remove PMKSA cache entry to the driver 2705 * @priv: private driver interface data 2706 * @params: PMKSA parameters 2707 * 2708 * Returns: 0 on success, -1 on failure 2709 * 2710 * This function is called when the supplicant drops a PMKSA cache 2711 * entry for any reason. The PMKSA parameters are either a set of 2712 * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid. 2713 * 2714 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 2715 * associate(), remove_pmkid() can be used to synchronize PMKSA caches 2716 * between the driver and wpa_supplicant. If the driver uses wpa_ie 2717 * from wpa_supplicant, this driver_ops function does not need to be 2718 * implemented. Likewise, if the driver does not support WPA, this 2719 * function is not needed. 2720 */ 2721 int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params); 2722 2723 /** 2724 * flush_pmkid - Flush PMKSA cache 2725 * @priv: private driver interface data 2726 * 2727 * Returns: 0 on success, -1 on failure 2728 * 2729 * This function is called when the supplicant drops all PMKSA cache 2730 * entries for any reason. 2731 * 2732 * If the driver generates RSN IE, i.e., it does not use wpa_ie in 2733 * associate(), remove_pmkid() can be used to synchronize PMKSA caches 2734 * between the driver and wpa_supplicant. If the driver uses wpa_ie 2735 * from wpa_supplicant, this driver_ops function does not need to be 2736 * implemented. Likewise, if the driver does not support WPA, this 2737 * function is not needed. 2738 */ 2739 int (*flush_pmkid)(void *priv); 2740 2741 /** 2742 * get_capa - Get driver capabilities 2743 * @priv: private driver interface data 2744 * 2745 * Returns: 0 on success, -1 on failure 2746 * 2747 * Get driver/firmware/hardware capabilities. 2748 */ 2749 int (*get_capa)(void *priv, struct wpa_driver_capa *capa); 2750 2751 /** 2752 * poll - Poll driver for association information 2753 * @priv: private driver interface data 2754 * 2755 * This is an option callback that can be used when the driver does not 2756 * provide event mechanism for association events. This is called when 2757 * receiving WPA EAPOL-Key messages that require association 2758 * information. The driver interface is supposed to generate associnfo 2759 * event before returning from this callback function. In addition, the 2760 * driver interface should generate an association event after having 2761 * sent out associnfo. 2762 */ 2763 void (*poll)(void *priv); 2764 2765 /** 2766 * get_ifindex - Get interface index 2767 * @priv: private driver interface data 2768 * 2769 * Returns: Interface index 2770 */ 2771 unsigned int (*get_ifindex)(void *priv); 2772 2773 /** 2774 * get_ifname - Get interface name 2775 * @priv: private driver interface data 2776 * 2777 * Returns: Pointer to the interface name. This can differ from the 2778 * interface name used in init() call. Init() is called first. 2779 * 2780 * This optional function can be used to allow the driver interface to 2781 * replace the interface name with something else, e.g., based on an 2782 * interface mapping from a more descriptive name. 2783 */ 2784 const char * (*get_ifname)(void *priv); 2785 2786 /** 2787 * get_mac_addr - Get own MAC address 2788 * @priv: private driver interface data 2789 * 2790 * Returns: Pointer to own MAC address or %NULL on failure 2791 * 2792 * This optional function can be used to get the own MAC address of the 2793 * device from the driver interface code. This is only needed if the 2794 * l2_packet implementation for the OS does not provide easy access to 2795 * a MAC address. */ 2796 const u8 * (*get_mac_addr)(void *priv); 2797 2798 /** 2799 * set_operstate - Sets device operating state to DORMANT or UP 2800 * @priv: private driver interface data 2801 * @state: 0 = dormant, 1 = up 2802 * Returns: 0 on success, -1 on failure 2803 * 2804 * This is an optional function that can be used on operating systems 2805 * that support a concept of controlling network device state from user 2806 * space applications. This function, if set, gets called with 2807 * state = 1 when authentication has been completed and with state = 0 2808 * when connection is lost. 2809 */ 2810 int (*set_operstate)(void *priv, int state); 2811 2812 /** 2813 * mlme_setprotection - MLME-SETPROTECTION.request primitive 2814 * @priv: Private driver interface data 2815 * @addr: Address of the station for which to set protection (may be 2816 * %NULL for group keys) 2817 * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_* 2818 * @key_type: MLME_SETPROTECTION_KEY_TYPE_* 2819 * Returns: 0 on success, -1 on failure 2820 * 2821 * This is an optional function that can be used to set the driver to 2822 * require protection for Tx and/or Rx frames. This uses the layer 2823 * interface defined in IEEE 802.11i-2004 clause 10.3.22.1 2824 * (MLME-SETPROTECTION.request). Many drivers do not use explicit 2825 * set protection operation; instead, they set protection implicitly 2826 * based on configured keys. 2827 */ 2828 int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type, 2829 int key_type); 2830 2831 /** 2832 * get_hw_feature_data - Get hardware support data (channels and rates) 2833 * @priv: Private driver interface data 2834 * @num_modes: Variable for returning the number of returned modes 2835 * flags: Variable for returning hardware feature flags 2836 * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*) 2837 * Returns: Pointer to allocated hardware data on success or %NULL on 2838 * failure. Caller is responsible for freeing this. 2839 */ 2840 struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv, 2841 u16 *num_modes, 2842 u16 *flags, u8 *dfs); 2843 2844 /** 2845 * send_mlme - Send management frame from MLME 2846 * @priv: Private driver interface data 2847 * @data: IEEE 802.11 management frame with IEEE 802.11 header 2848 * @data_len: Size of the management frame 2849 * @noack: Do not wait for this frame to be acked (disable retries) 2850 * @freq: Frequency (in MHz) to send the frame on, or 0 to let the 2851 * driver decide 2852 * @csa_offs: Array of CSA offsets or %NULL 2853 * @csa_offs_len: Number of elements in csa_offs 2854 * @no_encrypt: Do not encrypt frame even if appropriate key exists 2855 * (used only for testing purposes) 2856 * @wait: Time to wait off-channel for a response (in ms), or zero 2857 * Returns: 0 on success, -1 on failure 2858 */ 2859 int (*send_mlme)(void *priv, const u8 *data, size_t data_len, 2860 int noack, unsigned int freq, const u16 *csa_offs, 2861 size_t csa_offs_len, int no_encrypt, 2862 unsigned int wait); 2863 2864 /** 2865 * update_ft_ies - Update FT (IEEE 802.11r) IEs 2866 * @priv: Private driver interface data 2867 * @md: Mobility domain (2 octets) (also included inside ies) 2868 * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs 2869 * @ies_len: Length of FT IEs in bytes 2870 * Returns: 0 on success, -1 on failure 2871 * 2872 * The supplicant uses this callback to let the driver know that keying 2873 * material for FT is available and that the driver can use the 2874 * provided IEs in the next message in FT authentication sequence. 2875 * 2876 * This function is only needed for driver that support IEEE 802.11r 2877 * (Fast BSS Transition). 2878 */ 2879 int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies, 2880 size_t ies_len); 2881 2882 /** 2883 * get_scan_results2 - Fetch the latest scan results 2884 * @priv: private driver interface data 2885 * 2886 * Returns: Allocated buffer of scan results (caller is responsible for 2887 * freeing the data structure) on success, NULL on failure 2888 */ 2889 struct wpa_scan_results * (*get_scan_results2)(void *priv); 2890 2891 /** 2892 * set_country - Set country 2893 * @priv: Private driver interface data 2894 * @alpha2: country to which to switch to 2895 * Returns: 0 on success, -1 on failure 2896 * 2897 * This function is for drivers which support some form 2898 * of setting a regulatory domain. 2899 */ 2900 int (*set_country)(void *priv, const char *alpha2); 2901 2902 /** 2903 * get_country - Get country 2904 * @priv: Private driver interface data 2905 * @alpha2: Buffer for returning country code (at least 3 octets) 2906 * Returns: 0 on success, -1 on failure 2907 */ 2908 int (*get_country)(void *priv, char *alpha2); 2909 2910 /** 2911 * global_init - Global driver initialization 2912 * @ctx: wpa_global pointer 2913 * Returns: Pointer to private data (global), %NULL on failure 2914 * 2915 * This optional function is called to initialize the driver wrapper 2916 * for global data, i.e., data that applies to all interfaces. If this 2917 * function is implemented, global_deinit() will also need to be 2918 * implemented to free the private data. The driver will also likely 2919 * use init2() function instead of init() to get the pointer to global 2920 * data available to per-interface initializer. 2921 */ 2922 void * (*global_init)(void *ctx); 2923 2924 /** 2925 * global_deinit - Global driver deinitialization 2926 * @priv: private driver global data from global_init() 2927 * 2928 * Terminate any global driver related functionality and free the 2929 * global data structure. 2930 */ 2931 void (*global_deinit)(void *priv); 2932 2933 /** 2934 * init2 - Initialize driver interface (with global data) 2935 * @ctx: context to be used when calling wpa_supplicant functions, 2936 * e.g., wpa_supplicant_event() 2937 * @ifname: interface name, e.g., wlan0 2938 * @global_priv: private driver global data from global_init() 2939 * Returns: Pointer to private data, %NULL on failure 2940 * 2941 * This function can be used instead of init() if the driver wrapper 2942 * uses global data. 2943 */ 2944 void * (*init2)(void *ctx, const char *ifname, void *global_priv); 2945 2946 /** 2947 * get_interfaces - Get information about available interfaces 2948 * @global_priv: private driver global data from global_init() 2949 * Returns: Allocated buffer of interface information (caller is 2950 * responsible for freeing the data structure) on success, NULL on 2951 * failure 2952 */ 2953 struct wpa_interface_info * (*get_interfaces)(void *global_priv); 2954 2955 /** 2956 * scan2 - Request the driver to initiate scan 2957 * @priv: private driver interface data 2958 * @params: Scan parameters 2959 * 2960 * Returns: 0 on success, -1 on failure 2961 * 2962 * Once the scan results are ready, the driver should report scan 2963 * results event for wpa_supplicant which will eventually request the 2964 * results with wpa_driver_get_scan_results2(). 2965 */ 2966 int (*scan2)(void *priv, struct wpa_driver_scan_params *params); 2967 2968 /** 2969 * authenticate - Request driver to authenticate 2970 * @priv: private driver interface data 2971 * @params: authentication parameters 2972 * Returns: 0 on success, -1 on failure 2973 * 2974 * This is an optional function that can be used with drivers that 2975 * support separate authentication and association steps, i.e., when 2976 * wpa_supplicant can act as the SME. If not implemented, associate() 2977 * function is expected to take care of IEEE 802.11 authentication, 2978 * too. 2979 */ 2980 int (*authenticate)(void *priv, 2981 struct wpa_driver_auth_params *params); 2982 2983 /** 2984 * set_ap - Set Beacon and Probe Response information for AP mode 2985 * @priv: Private driver interface data 2986 * @params: Parameters to use in AP mode 2987 * 2988 * This function is used to configure Beacon template and/or extra IEs 2989 * to add for Beacon and Probe Response frames for the driver in 2990 * AP mode. The driver is responsible for building the full Beacon 2991 * frame by concatenating the head part with TIM IE generated by the 2992 * driver/firmware and finishing with the tail part. Depending on the 2993 * driver architectue, this can be done either by using the full 2994 * template or the set of additional IEs (e.g., WPS and P2P IE). 2995 * Similarly, Probe Response processing depends on the driver design. 2996 * If the driver (or firmware) takes care of replying to Probe Request 2997 * frames, the extra IEs provided here needs to be added to the Probe 2998 * Response frames. 2999 * 3000 * Returns: 0 on success, -1 on failure 3001 */ 3002 int (*set_ap)(void *priv, struct wpa_driver_ap_params *params); 3003 3004 /** 3005 * set_acl - Set ACL in AP mode 3006 * @priv: Private driver interface data 3007 * @params: Parameters to configure ACL 3008 * Returns: 0 on success, -1 on failure 3009 * 3010 * This is used only for the drivers which support MAC address ACL. 3011 */ 3012 int (*set_acl)(void *priv, struct hostapd_acl_params *params); 3013 3014 /** 3015 * hapd_init - Initialize driver interface (hostapd only) 3016 * @hapd: Pointer to hostapd context 3017 * @params: Configuration for the driver wrapper 3018 * Returns: Pointer to private data, %NULL on failure 3019 * 3020 * This function is used instead of init() or init2() when the driver 3021 * wrapper is used with hostapd. 3022 */ 3023 void * (*hapd_init)(struct hostapd_data *hapd, 3024 struct wpa_init_params *params); 3025 3026 /** 3027 * hapd_deinit - Deinitialize driver interface (hostapd only) 3028 * @priv: Private driver interface data from hapd_init() 3029 */ 3030 void (*hapd_deinit)(void *priv); 3031 3032 /** 3033 * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only) 3034 * @priv: Private driver interface data 3035 * @params: BSS parameters 3036 * Returns: 0 on success, -1 on failure 3037 * 3038 * This is an optional function to configure the kernel driver to 3039 * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This 3040 * can be left undefined (set to %NULL) if IEEE 802.1X support is 3041 * always enabled and the driver uses set_ap() to set WPA/RSN IE 3042 * for Beacon frames. 3043 * 3044 * DEPRECATED - use set_ap() instead 3045 */ 3046 int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params); 3047 3048 /** 3049 * set_privacy - Enable/disable privacy (AP only) 3050 * @priv: Private driver interface data 3051 * @enabled: 1 = privacy enabled, 0 = disabled 3052 * Returns: 0 on success, -1 on failure 3053 * 3054 * This is an optional function to configure privacy field in the 3055 * kernel driver for Beacon frames. This can be left undefined (set to 3056 * %NULL) if the driver uses the Beacon template from set_ap(). 3057 * 3058 * DEPRECATED - use set_ap() instead 3059 */ 3060 int (*set_privacy)(void *priv, int enabled); 3061 3062 /** 3063 * get_seqnum - Fetch the current TSC/packet number (AP only) 3064 * @ifname: The interface name (main or virtual) 3065 * @priv: Private driver interface data 3066 * @addr: MAC address of the station or %NULL for group keys 3067 * @idx: Key index 3068 * @seq: Buffer for returning the latest used TSC/packet number 3069 * Returns: 0 on success, -1 on failure 3070 * 3071 * This function is used to fetch the last used TSC/packet number for 3072 * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group 3073 * keys, so there is no strict requirement on implementing support for 3074 * unicast keys (i.e., addr != %NULL). 3075 */ 3076 int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr, 3077 int idx, u8 *seq); 3078 3079 /** 3080 * flush - Flush all association stations (AP only) 3081 * @priv: Private driver interface data 3082 * Returns: 0 on success, -1 on failure 3083 * 3084 * This function requests the driver to disassociate all associated 3085 * stations. This function does not need to be implemented if the 3086 * driver does not process association frames internally. 3087 */ 3088 int (*flush)(void *priv); 3089 3090 /** 3091 * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP) 3092 * @priv: Private driver interface data 3093 * @elem: Information elements 3094 * @elem_len: Length of the elem buffer in octets 3095 * Returns: 0 on success, -1 on failure 3096 * 3097 * This is an optional function to add information elements in the 3098 * kernel driver for Beacon and Probe Response frames. This can be left 3099 * undefined (set to %NULL) if the driver uses the Beacon template from 3100 * set_ap(). 3101 * 3102 * DEPRECATED - use set_ap() instead 3103 */ 3104 int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len); 3105 3106 /** 3107 * read_sta_data - Fetch station data 3108 * @priv: Private driver interface data 3109 * @data: Buffer for returning station information 3110 * @addr: MAC address of the station 3111 * Returns: 0 on success, -1 on failure 3112 */ 3113 int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data, 3114 const u8 *addr); 3115 3116 /** 3117 * tx_control_port - Send a frame over the 802.1X controlled port 3118 * @priv: Private driver interface data 3119 * @dest: Destination MAC address 3120 * @proto: Ethertype in host byte order 3121 * @buf: Frame payload starting from IEEE 802.1X header 3122 * @len: Frame payload length 3123 * @no_encrypt: Do not encrypt frame 3124 * 3125 * Returns 0 on success, else an error 3126 * 3127 * This is like a normal Ethernet send except that the driver is aware 3128 * (by other means than the Ethertype) that this frame is special, 3129 * and more importantly it gains an ordering between the transmission of 3130 * the frame and other driver management operations such as key 3131 * installations. This can be used to work around known limitations in 3132 * IEEE 802.11 protocols such as race conditions between rekeying 4-way 3133 * handshake message 4/4 and a PTK being overwritten. 3134 * 3135 * This function is only used for a given interface if the driver 3136 * instance reports WPA_DRIVER_FLAGS_CONTROL_PORT capability. Otherwise, 3137 * API users will fall back to sending the frame via a normal socket. 3138 */ 3139 int (*tx_control_port)(void *priv, const u8 *dest, 3140 u16 proto, const u8 *buf, size_t len, 3141 int no_encrypt); 3142 3143 /** 3144 * hapd_send_eapol - Send an EAPOL packet (AP only) 3145 * @priv: private driver interface data 3146 * @addr: Destination MAC address 3147 * @data: EAPOL packet starting with IEEE 802.1X header 3148 * @data_len: Length of the EAPOL packet in octets 3149 * @encrypt: Whether the frame should be encrypted 3150 * @own_addr: Source MAC address 3151 * @flags: WPA_STA_* flags for the destination station 3152 * 3153 * Returns: 0 on success, -1 on failure 3154 */ 3155 int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data, 3156 size_t data_len, int encrypt, 3157 const u8 *own_addr, u32 flags); 3158 3159 /** 3160 * sta_deauth - Deauthenticate a station (AP only) 3161 * @priv: Private driver interface data 3162 * @own_addr: Source address and BSSID for the Deauthentication frame 3163 * @addr: MAC address of the station to deauthenticate 3164 * @reason: Reason code for the Deauthentiation frame 3165 * Returns: 0 on success, -1 on failure 3166 * 3167 * This function requests a specific station to be deauthenticated and 3168 * a Deauthentication frame to be sent to it. 3169 */ 3170 int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr, 3171 u16 reason); 3172 3173 /** 3174 * sta_disassoc - Disassociate a station (AP only) 3175 * @priv: Private driver interface data 3176 * @own_addr: Source address and BSSID for the Disassociation frame 3177 * @addr: MAC address of the station to disassociate 3178 * @reason: Reason code for the Disassociation frame 3179 * Returns: 0 on success, -1 on failure 3180 * 3181 * This function requests a specific station to be disassociated and 3182 * a Disassociation frame to be sent to it. 3183 */ 3184 int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr, 3185 u16 reason); 3186 3187 /** 3188 * sta_remove - Remove a station entry (AP only) 3189 * @priv: Private driver interface data 3190 * @addr: MAC address of the station to be removed 3191 * Returns: 0 on success, -1 on failure 3192 */ 3193 int (*sta_remove)(void *priv, const u8 *addr); 3194 3195 /** 3196 * hapd_get_ssid - Get the current SSID (AP only) 3197 * @priv: Private driver interface data 3198 * @buf: Buffer for returning the SSID 3199 * @len: Maximum length of the buffer 3200 * Returns: Length of the SSID on success, -1 on failure 3201 * 3202 * This function need not be implemented if the driver uses Beacon 3203 * template from set_ap() and does not reply to Probe Request frames. 3204 */ 3205 int (*hapd_get_ssid)(void *priv, u8 *buf, int len); 3206 3207 /** 3208 * hapd_set_ssid - Set SSID (AP only) 3209 * @priv: Private driver interface data 3210 * @buf: SSID 3211 * @len: Length of the SSID in octets 3212 * Returns: 0 on success, -1 on failure 3213 * 3214 * DEPRECATED - use set_ap() instead 3215 */ 3216 int (*hapd_set_ssid)(void *priv, const u8 *buf, int len); 3217 3218 /** 3219 * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP) 3220 * @priv: Private driver interface data 3221 * @enabled: 1 = countermeasures enabled, 0 = disabled 3222 * Returns: 0 on success, -1 on failure 3223 * 3224 * This need not be implemented if the driver does not take care of 3225 * association processing. 3226 */ 3227 int (*hapd_set_countermeasures)(void *priv, int enabled); 3228 3229 /** 3230 * sta_add - Add a station entry 3231 * @priv: Private driver interface data 3232 * @params: Station parameters 3233 * Returns: 0 on success, -1 on failure 3234 * 3235 * This function is used to add or set (params->set 1) a station 3236 * entry in the driver. Adding STA entries is used only if the driver 3237 * does not take care of association processing. 3238 * 3239 * With drivers that don't support full AP client state, this function 3240 * is used to add a station entry to the driver once the station has 3241 * completed association. 3242 * 3243 * With TDLS, this function is used to add or set (params->set 1) 3244 * TDLS peer entries (even with drivers that do not support full AP 3245 * client state). 3246 */ 3247 int (*sta_add)(void *priv, struct hostapd_sta_add_params *params); 3248 3249 /** 3250 * get_inact_sec - Get station inactivity duration (AP only) 3251 * @priv: Private driver interface data 3252 * @addr: Station address 3253 * Returns: Number of seconds station has been inactive, -1 on failure 3254 */ 3255 int (*get_inact_sec)(void *priv, const u8 *addr); 3256 3257 /** 3258 * sta_clear_stats - Clear station statistics (AP only) 3259 * @priv: Private driver interface data 3260 * @addr: Station address 3261 * Returns: 0 on success, -1 on failure 3262 */ 3263 int (*sta_clear_stats)(void *priv, const u8 *addr); 3264 3265 /** 3266 * set_freq - Set channel/frequency (AP only) 3267 * @priv: Private driver interface data 3268 * @freq: Channel parameters 3269 * Returns: 0 on success, -1 on failure 3270 */ 3271 int (*set_freq)(void *priv, struct hostapd_freq_params *freq); 3272 3273 /** 3274 * set_rts - Set RTS threshold 3275 * @priv: Private driver interface data 3276 * @rts: RTS threshold in octets 3277 * Returns: 0 on success, -1 on failure 3278 */ 3279 int (*set_rts)(void *priv, int rts); 3280 3281 /** 3282 * set_frag - Set fragmentation threshold 3283 * @priv: Private driver interface data 3284 * @frag: Fragmentation threshold in octets 3285 * Returns: 0 on success, -1 on failure 3286 */ 3287 int (*set_frag)(void *priv, int frag); 3288 3289 /** 3290 * sta_set_flags - Set station flags (AP only) 3291 * @priv: Private driver interface data 3292 * @addr: Station address 3293 * @total_flags: Bitmap of all WPA_STA_* flags currently set 3294 * @flags_or: Bitmap of WPA_STA_* flags to add 3295 * @flags_and: Bitmap of WPA_STA_* flags to us as a mask 3296 * Returns: 0 on success, -1 on failure 3297 */ 3298 int (*sta_set_flags)(void *priv, const u8 *addr, 3299 unsigned int total_flags, unsigned int flags_or, 3300 unsigned int flags_and); 3301 3302 /** 3303 * sta_set_airtime_weight - Set station airtime weight (AP only) 3304 * @priv: Private driver interface data 3305 * @addr: Station address 3306 * @weight: New weight for station airtime assignment 3307 * Returns: 0 on success, -1 on failure 3308 */ 3309 int (*sta_set_airtime_weight)(void *priv, const u8 *addr, 3310 unsigned int weight); 3311 3312 /** 3313 * set_tx_queue_params - Set TX queue parameters 3314 * @priv: Private driver interface data 3315 * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK) 3316 * @aifs: AIFS 3317 * @cw_min: cwMin 3318 * @cw_max: cwMax 3319 * @burst_time: Maximum length for bursting in 0.1 msec units 3320 */ 3321 int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min, 3322 int cw_max, int burst_time); 3323 3324 /** 3325 * if_add - Add a virtual interface 3326 * @priv: Private driver interface data 3327 * @type: Interface type 3328 * @ifname: Interface name for the new virtual interface 3329 * @addr: Local address to use for the interface or %NULL to use the 3330 * parent interface address 3331 * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces 3332 * @drv_priv: Pointer for overwriting the driver context or %NULL if 3333 * not allowed (applies only to %WPA_IF_AP_BSS type) 3334 * @force_ifname: Buffer for returning an interface name that the 3335 * driver ended up using if it differs from the requested ifname 3336 * @if_addr: Buffer for returning the allocated interface address 3337 * (this may differ from the requested addr if the driver cannot 3338 * change interface address) 3339 * @bridge: Bridge interface to use or %NULL if no bridge configured 3340 * @use_existing: Whether to allow existing interface to be used 3341 * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces 3342 * Returns: 0 on success, -1 on failure 3343 */ 3344 int (*if_add)(void *priv, enum wpa_driver_if_type type, 3345 const char *ifname, const u8 *addr, void *bss_ctx, 3346 void **drv_priv, char *force_ifname, u8 *if_addr, 3347 const char *bridge, int use_existing, int setup_ap); 3348 3349 /** 3350 * if_remove - Remove a virtual interface 3351 * @priv: Private driver interface data 3352 * @type: Interface type 3353 * @ifname: Interface name of the virtual interface to be removed 3354 * Returns: 0 on success, -1 on failure 3355 */ 3356 int (*if_remove)(void *priv, enum wpa_driver_if_type type, 3357 const char *ifname); 3358 3359 /** 3360 * set_sta_vlan - Bind a station into a specific interface (AP only) 3361 * @priv: Private driver interface data 3362 * @ifname: Interface (main or virtual BSS or VLAN) 3363 * @addr: MAC address of the associated station 3364 * @vlan_id: VLAN ID 3365 * Returns: 0 on success, -1 on failure 3366 * 3367 * This function is used to bind a station to a specific virtual 3368 * interface. It is only used if when virtual interfaces are supported, 3369 * e.g., to assign stations to different VLAN interfaces based on 3370 * information from a RADIUS server. This allows separate broadcast 3371 * domains to be used with a single BSS. 3372 */ 3373 int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname, 3374 int vlan_id); 3375 3376 /** 3377 * commit - Optional commit changes handler (AP only) 3378 * @priv: driver private data 3379 * Returns: 0 on success, -1 on failure 3380 * 3381 * This optional handler function can be registered if the driver 3382 * interface implementation needs to commit changes (e.g., by setting 3383 * network interface up) at the end of initial configuration. If set, 3384 * this handler will be called after initial setup has been completed. 3385 */ 3386 int (*commit)(void *priv); 3387 3388 /** 3389 * set_radius_acl_auth - Notification of RADIUS ACL change 3390 * @priv: Private driver interface data 3391 * @mac: MAC address of the station 3392 * @accepted: Whether the station was accepted 3393 * @session_timeout: Session timeout for the station 3394 * Returns: 0 on success, -1 on failure 3395 */ 3396 int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted, 3397 u32 session_timeout); 3398 3399 /** 3400 * set_radius_acl_expire - Notification of RADIUS ACL expiration 3401 * @priv: Private driver interface data 3402 * @mac: MAC address of the station 3403 * Returns: 0 on success, -1 on failure 3404 */ 3405 int (*set_radius_acl_expire)(void *priv, const u8 *mac); 3406 3407 /** 3408 * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP) 3409 * @priv: Private driver interface data 3410 * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s) 3411 * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove 3412 * extra IE(s) 3413 * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL 3414 * to remove extra IE(s) 3415 * Returns: 0 on success, -1 on failure 3416 * 3417 * This is an optional function to add WPS IE in the kernel driver for 3418 * Beacon and Probe Response frames. This can be left undefined (set 3419 * to %NULL) if the driver uses the Beacon template from set_ap() 3420 * and does not process Probe Request frames. If the driver takes care 3421 * of (Re)Association frame processing, the assocresp buffer includes 3422 * WPS IE(s) that need to be added to (Re)Association Response frames 3423 * whenever a (Re)Association Request frame indicated use of WPS. 3424 * 3425 * This will also be used to add P2P IE(s) into Beacon/Probe Response 3426 * frames when operating as a GO. The driver is responsible for adding 3427 * timing related attributes (e.g., NoA) in addition to the IEs 3428 * included here by appending them after these buffers. This call is 3429 * also used to provide Probe Response IEs for P2P Listen state 3430 * operations for drivers that generate the Probe Response frames 3431 * internally. 3432 * 3433 * DEPRECATED - use set_ap() instead 3434 */ 3435 int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon, 3436 const struct wpabuf *proberesp, 3437 const struct wpabuf *assocresp); 3438 3439 /** 3440 * set_supp_port - Set IEEE 802.1X Supplicant Port status 3441 * @priv: Private driver interface data 3442 * @authorized: Whether the port is authorized 3443 * Returns: 0 on success, -1 on failure 3444 */ 3445 int (*set_supp_port)(void *priv, int authorized); 3446 3447 /** 3448 * set_wds_sta - Bind a station into a 4-address WDS (AP only) 3449 * @priv: Private driver interface data 3450 * @addr: MAC address of the associated station 3451 * @aid: Association ID 3452 * @val: 1 = bind to 4-address WDS; 0 = unbind 3453 * @bridge_ifname: Bridge interface to use for the WDS station or %NULL 3454 * to indicate that bridge is not to be used 3455 * @ifname_wds: Buffer to return the interface name for the new WDS 3456 * station or %NULL to indicate name is not returned. 3457 * Returns: 0 on success, -1 on failure 3458 */ 3459 int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val, 3460 const char *bridge_ifname, char *ifname_wds); 3461 3462 /** 3463 * send_action - Transmit an Action frame 3464 * @priv: Private driver interface data 3465 * @freq: Frequency (in MHz) of the channel 3466 * @wait: Time to wait off-channel for a response (in ms), or zero 3467 * @dst: Destination MAC address (Address 1) 3468 * @src: Source MAC address (Address 2) 3469 * @bssid: BSSID (Address 3) 3470 * @data: Frame body 3471 * @data_len: data length in octets 3472 @ @no_cck: Whether CCK rates must not be used to transmit this frame 3473 * Returns: 0 on success, -1 on failure 3474 * 3475 * This command can be used to request the driver to transmit an action 3476 * frame to the specified destination. 3477 * 3478 * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will 3479 * be transmitted on the given channel and the device will wait for a 3480 * response on that channel for the given wait time. 3481 * 3482 * If the flag is not set, the wait time will be ignored. In this case, 3483 * if a remain-on-channel duration is in progress, the frame must be 3484 * transmitted on that channel; alternatively the frame may be sent on 3485 * the current operational channel (if in associated state in station 3486 * mode or while operating as an AP.) 3487 * 3488 * If @src differs from the device MAC address, use of a random 3489 * transmitter address is requested for this message exchange. 3490 */ 3491 int (*send_action)(void *priv, unsigned int freq, unsigned int wait, 3492 const u8 *dst, const u8 *src, const u8 *bssid, 3493 const u8 *data, size_t data_len, int no_cck); 3494 3495 /** 3496 * send_action_cancel_wait - Cancel action frame TX wait 3497 * @priv: Private driver interface data 3498 * 3499 * This command cancels the wait time associated with sending an action 3500 * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is 3501 * set in the driver flags. 3502 */ 3503 void (*send_action_cancel_wait)(void *priv); 3504 3505 /** 3506 * remain_on_channel - Remain awake on a channel 3507 * @priv: Private driver interface data 3508 * @freq: Frequency (in MHz) of the channel 3509 * @duration: Duration in milliseconds 3510 * Returns: 0 on success, -1 on failure 3511 * 3512 * This command is used to request the driver to remain awake on the 3513 * specified channel for the specified duration and report received 3514 * Action frames with EVENT_RX_MGMT events. Optionally, received 3515 * Probe Request frames may also be requested to be reported by calling 3516 * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ. 3517 * 3518 * The driver may not be at the requested channel when this function 3519 * returns, i.e., the return code is only indicating whether the 3520 * request was accepted. The caller will need to wait until the 3521 * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has 3522 * completed the channel change. This may take some time due to other 3523 * need for the radio and the caller should be prepared to timing out 3524 * its wait since there are no guarantees on when this request can be 3525 * executed. 3526 */ 3527 int (*remain_on_channel)(void *priv, unsigned int freq, 3528 unsigned int duration); 3529 3530 /** 3531 * cancel_remain_on_channel - Cancel remain-on-channel operation 3532 * @priv: Private driver interface data 3533 * 3534 * This command can be used to cancel a remain-on-channel operation 3535 * before its originally requested duration has passed. This could be 3536 * used, e.g., when remain_on_channel() is used to request extra time 3537 * to receive a response to an Action frame and the response is 3538 * received when there is still unneeded time remaining on the 3539 * remain-on-channel operation. 3540 */ 3541 int (*cancel_remain_on_channel)(void *priv); 3542 3543 /** 3544 * probe_req_report - Request Probe Request frames to be indicated 3545 * @priv: Private driver interface data 3546 * @report: Whether to report received Probe Request frames 3547 * Returns: 0 on success, -1 on failure (or if not supported) 3548 * 3549 * This command can be used to request the driver to indicate when 3550 * Probe Request frames are received with EVENT_RX_PROBE_REQ events. 3551 * Since this operation may require extra resources, e.g., due to less 3552 * optimal hardware/firmware RX filtering, many drivers may disable 3553 * Probe Request reporting at least in station mode. This command is 3554 * used to notify the driver when the Probe Request frames need to be 3555 * reported, e.g., during remain-on-channel operations. 3556 */ 3557 int (*probe_req_report)(void *priv, int report); 3558 3559 /** 3560 * deinit_ap - Deinitialize AP mode 3561 * @priv: Private driver interface data 3562 * Returns: 0 on success, -1 on failure (or if not supported) 3563 * 3564 * This optional function can be used to disable AP mode related 3565 * configuration. If the interface was not dynamically added, 3566 * change the driver mode to station mode to allow normal station 3567 * operations like scanning to be completed. 3568 */ 3569 int (*deinit_ap)(void *priv); 3570 3571 /** 3572 * deinit_p2p_cli - Deinitialize P2P client mode 3573 * @priv: Private driver interface data 3574 * Returns: 0 on success, -1 on failure (or if not supported) 3575 * 3576 * This optional function can be used to disable P2P client mode. If the 3577 * interface was not dynamically added, change the interface type back 3578 * to station mode. 3579 */ 3580 int (*deinit_p2p_cli)(void *priv); 3581 3582 /** 3583 * suspend - Notification on system suspend/hibernate event 3584 * @priv: Private driver interface data 3585 */ 3586 void (*suspend)(void *priv); 3587 3588 /** 3589 * resume - Notification on system resume/thaw event 3590 * @priv: Private driver interface data 3591 */ 3592 void (*resume)(void *priv); 3593 3594 /** 3595 * signal_monitor - Set signal monitoring parameters 3596 * @priv: Private driver interface data 3597 * @threshold: Threshold value for signal change events; 0 = disabled 3598 * @hysteresis: Minimum change in signal strength before indicating a 3599 * new event 3600 * Returns: 0 on success, -1 on failure (or if not supported) 3601 * 3602 * This function can be used to configure monitoring of signal strength 3603 * with the current AP. Whenever signal strength drops below the 3604 * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event 3605 * should be generated assuming the signal strength has changed at 3606 * least %hysteresis from the previously indicated signal change event. 3607 */ 3608 int (*signal_monitor)(void *priv, int threshold, int hysteresis); 3609 3610 /** 3611 * get_noa - Get current Notice of Absence attribute payload 3612 * @priv: Private driver interface data 3613 * @buf: Buffer for returning NoA 3614 * @buf_len: Buffer length in octets 3615 * Returns: Number of octets used in buf, 0 to indicate no NoA is being 3616 * advertized, or -1 on failure 3617 * 3618 * This function is used to fetch the current Notice of Absence 3619 * attribute value from GO. 3620 */ 3621 int (*get_noa)(void *priv, u8 *buf, size_t buf_len); 3622 3623 /** 3624 * set_noa - Set Notice of Absence parameters for GO (testing) 3625 * @priv: Private driver interface data 3626 * @count: Count 3627 * @start: Start time in ms from next TBTT 3628 * @duration: Duration in ms 3629 * Returns: 0 on success or -1 on failure 3630 * 3631 * This function is used to set Notice of Absence parameters for GO. It 3632 * is used only for testing. To disable NoA, all parameters are set to 3633 * 0. 3634 */ 3635 int (*set_noa)(void *priv, u8 count, int start, int duration); 3636 3637 /** 3638 * set_p2p_powersave - Set P2P power save options 3639 * @priv: Private driver interface data 3640 * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change 3641 * @opp_ps: 0 = disable, 1 = enable, -1 = no change 3642 * @ctwindow: 0.. = change (msec), -1 = no change 3643 * Returns: 0 on success or -1 on failure 3644 */ 3645 int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps, 3646 int ctwindow); 3647 3648 /** 3649 * ampdu - Enable/disable aggregation 3650 * @priv: Private driver interface data 3651 * @ampdu: 1/0 = enable/disable A-MPDU aggregation 3652 * Returns: 0 on success or -1 on failure 3653 */ 3654 int (*ampdu)(void *priv, int ampdu); 3655 3656 /** 3657 * get_radio_name - Get physical radio name for the device 3658 * @priv: Private driver interface data 3659 * Returns: Radio name or %NULL if not known 3660 * 3661 * The returned data must not be modified by the caller. It is assumed 3662 * that any interface that has the same radio name as another is 3663 * sharing the same physical radio. This information can be used to 3664 * share scan results etc. information between the virtual interfaces 3665 * to speed up various operations. 3666 */ 3667 const char * (*get_radio_name)(void *priv); 3668 3669 /** 3670 * send_tdls_mgmt - for sending TDLS management packets 3671 * @priv: private driver interface data 3672 * @dst: Destination (peer) MAC address 3673 * @action_code: TDLS action code for the mssage 3674 * @dialog_token: Dialog Token to use in the message (if needed) 3675 * @status_code: Status Code or Reason Code to use (if needed) 3676 * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield) 3677 * @initiator: Is the current end the TDLS link initiator 3678 * @buf: TDLS IEs to add to the message 3679 * @len: Length of buf in octets 3680 * Returns: 0 on success, negative (<0) on failure 3681 * 3682 * This optional function can be used to send packet to driver which is 3683 * responsible for receiving and sending all TDLS packets. 3684 */ 3685 int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code, 3686 u8 dialog_token, u16 status_code, u32 peer_capab, 3687 int initiator, const u8 *buf, size_t len); 3688 3689 /** 3690 * tdls_oper - Ask the driver to perform high-level TDLS operations 3691 * @priv: Private driver interface data 3692 * @oper: TDLS high-level operation. See %enum tdls_oper 3693 * @peer: Destination (peer) MAC address 3694 * Returns: 0 on success, negative (<0) on failure 3695 * 3696 * This optional function can be used to send high-level TDLS commands 3697 * to the driver. 3698 */ 3699 int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer); 3700 3701 /** 3702 * wnm_oper - Notify driver of the WNM frame reception 3703 * @priv: Private driver interface data 3704 * @oper: WNM operation. See %enum wnm_oper 3705 * @peer: Destination (peer) MAC address 3706 * @buf: Buffer for the driver to fill in (for getting IE) 3707 * @buf_len: Return the len of buf 3708 * Returns: 0 on success, negative (<0) on failure 3709 */ 3710 int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer, 3711 u8 *buf, u16 *buf_len); 3712 3713 /** 3714 * set_qos_map - Set QoS Map 3715 * @priv: Private driver interface data 3716 * @qos_map_set: QoS Map 3717 * @qos_map_set_len: Length of QoS Map 3718 */ 3719 int (*set_qos_map)(void *priv, const u8 *qos_map_set, 3720 u8 qos_map_set_len); 3721 3722 /** 3723 * br_add_ip_neigh - Add a neigh to the bridge ip neigh table 3724 * @priv: Private driver interface data 3725 * @version: IP version of the IP address, 4 or 6 3726 * @ipaddr: IP address for the neigh entry 3727 * @prefixlen: IP address prefix length 3728 * @addr: Corresponding MAC address 3729 * Returns: 0 on success, negative (<0) on failure 3730 */ 3731 int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr, 3732 int prefixlen, const u8 *addr); 3733 3734 /** 3735 * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table 3736 * @priv: Private driver interface data 3737 * @version: IP version of the IP address, 4 or 6 3738 * @ipaddr: IP address for the neigh entry 3739 * Returns: 0 on success, negative (<0) on failure 3740 */ 3741 int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr); 3742 3743 /** 3744 * br_port_set_attr - Set a bridge port attribute 3745 * @attr: Bridge port attribute to set 3746 * @val: Value to be set 3747 * Returns: 0 on success, negative (<0) on failure 3748 */ 3749 int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr, 3750 unsigned int val); 3751 3752 /** 3753 * br_port_set_attr - Set a bridge network parameter 3754 * @param: Bridge parameter to set 3755 * @val: Value to be set 3756 * Returns: 0 on success, negative (<0) on failure 3757 */ 3758 int (*br_set_net_param)(void *priv, enum drv_br_net_param param, 3759 unsigned int val); 3760 3761 /** 3762 * get_wowlan - Get wake-on-wireless status 3763 * @priv: Private driver interface data 3764 */ 3765 int (*get_wowlan)(void *priv); 3766 3767 /** 3768 * set_wowlan - Set wake-on-wireless triggers 3769 * @priv: Private driver interface data 3770 * @triggers: wowlan triggers 3771 */ 3772 int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers); 3773 3774 /** 3775 * signal_poll - Get current connection information 3776 * @priv: Private driver interface data 3777 * @signal_info: Connection info structure 3778 */ 3779 int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info); 3780 3781 /** 3782 * channel_info - Get parameters of the current operating channel 3783 * @priv: Private driver interface data 3784 * @channel_info: Channel info structure 3785 * Returns: 0 on success, negative (<0) on failure 3786 */ 3787 int (*channel_info)(void *priv, struct wpa_channel_info *channel_info); 3788 3789 /** 3790 * set_authmode - Set authentication algorithm(s) for static WEP 3791 * @priv: Private driver interface data 3792 * @authmode: 1=Open System, 2=Shared Key, 3=both 3793 * Returns: 0 on success, -1 on failure 3794 * 3795 * This function can be used to set authentication algorithms for AP 3796 * mode when static WEP is used. If the driver uses user space MLME/SME 3797 * implementation, there is no need to implement this function. 3798 * 3799 * DEPRECATED - use set_ap() instead 3800 */ 3801 int (*set_authmode)(void *priv, int authmode); 3802 3803 #ifdef ANDROID 3804 /** 3805 * driver_cmd - Execute driver-specific command 3806 * @priv: Private driver interface data 3807 * @cmd: Command to execute 3808 * @buf: Return buffer 3809 * @buf_len: Buffer length 3810 * Returns: 0 on success, -1 on failure 3811 */ 3812 int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len); 3813 #endif /* ANDROID */ 3814 3815 /** 3816 * vendor_cmd - Execute vendor specific command 3817 * @priv: Private driver interface data 3818 * @vendor_id: Vendor id 3819 * @subcmd: Vendor command id 3820 * @nested_attr_flag: Specifies if vendor subcommand uses nested 3821 * attributes or not 3822 * @data: Vendor command parameters (%NULL if no parameters) 3823 * @data_len: Data length 3824 * @buf: Return buffer (%NULL to ignore reply) 3825 * Returns: 0 on success, negative (<0) on failure 3826 * 3827 * This function handles vendor specific commands that are passed to 3828 * the driver/device. The command is identified by vendor id and 3829 * command id. The nested_attr_flag specifies whether the subcommand 3830 * uses nested attributes or not. Parameters can be passed 3831 * as argument to the command in the data buffer. Reply (if any) will be 3832 * filled in the supplied return buffer. 3833 * 3834 * The exact driver behavior is driver interface and vendor specific. As 3835 * an example, this will be converted to a vendor specific cfg80211 3836 * command in case of the nl80211 driver interface. 3837 */ 3838 int (*vendor_cmd)(void *priv, unsigned int vendor_id, 3839 unsigned int subcmd, const u8 *data, size_t data_len, 3840 enum nested_attr nested_attr_flag, 3841 struct wpabuf *buf); 3842 3843 /** 3844 * set_rekey_info - Set rekey information 3845 * @priv: Private driver interface data 3846 * @kek: Current KEK 3847 * @kek_len: KEK length in octets 3848 * @kck: Current KCK 3849 * @kck_len: KCK length in octets 3850 * @replay_ctr: Current EAPOL-Key Replay Counter 3851 * 3852 * This optional function can be used to provide information for the 3853 * driver/firmware to process EAPOL-Key frames in Group Key Handshake 3854 * while the host (including wpa_supplicant) is sleeping. 3855 */ 3856 void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len, 3857 const u8 *kck, size_t kck_len, 3858 const u8 *replay_ctr); 3859 3860 /** 3861 * sta_assoc - Station association indication 3862 * @priv: Private driver interface data 3863 * @own_addr: Source address and BSSID for association frame 3864 * @addr: MAC address of the station to associate 3865 * @reassoc: flag to indicate re-association 3866 * @status: association response status code 3867 * @ie: assoc response ie buffer 3868 * @len: ie buffer length 3869 * Returns: 0 on success, -1 on failure 3870 * 3871 * This function indicates the driver to send (Re)Association 3872 * Response frame to the station. 3873 */ 3874 int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr, 3875 int reassoc, u16 status, const u8 *ie, size_t len); 3876 3877 /** 3878 * sta_auth - Station authentication indication 3879 * @priv: private driver interface data 3880 * @params: Station authentication parameters 3881 * 3882 * Returns: 0 on success, -1 on failure 3883 */ 3884 int (*sta_auth)(void *priv, 3885 struct wpa_driver_sta_auth_params *params); 3886 3887 /** 3888 * add_tspec - Add traffic stream 3889 * @priv: Private driver interface data 3890 * @addr: MAC address of the station to associate 3891 * @tspec_ie: tspec ie buffer 3892 * @tspec_ielen: tspec ie length 3893 * Returns: 0 on success, -1 on failure 3894 * 3895 * This function adds the traffic steam for the station 3896 * and fills the medium_time in tspec_ie. 3897 */ 3898 int (*add_tspec)(void *priv, const u8 *addr, u8 *tspec_ie, 3899 size_t tspec_ielen); 3900 3901 /** 3902 * add_sta_node - Add a station node in the driver 3903 * @priv: Private driver interface data 3904 * @addr: MAC address of the station to add 3905 * @auth_alg: authentication algorithm used by the station 3906 * Returns: 0 on success, -1 on failure 3907 * 3908 * This function adds the station node in the driver, when 3909 * the station gets added by FT-over-DS. 3910 */ 3911 int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg); 3912 3913 /** 3914 * sched_scan - Request the driver to initiate scheduled scan 3915 * @priv: Private driver interface data 3916 * @params: Scan parameters 3917 * Returns: 0 on success, -1 on failure 3918 * 3919 * This operation should be used for scheduled scan offload to 3920 * the hardware. Every time scan results are available, the 3921 * driver should report scan results event for wpa_supplicant 3922 * which will eventually request the results with 3923 * wpa_driver_get_scan_results2(). This operation is optional 3924 * and if not provided or if it returns -1, we fall back to 3925 * normal host-scheduled scans. 3926 */ 3927 int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params); 3928 3929 /** 3930 * stop_sched_scan - Request the driver to stop a scheduled scan 3931 * @priv: Private driver interface data 3932 * Returns: 0 on success, -1 on failure 3933 * 3934 * This should cause the scheduled scan to be stopped and 3935 * results should stop being sent. Must be supported if 3936 * sched_scan is supported. 3937 */ 3938 int (*stop_sched_scan)(void *priv); 3939 3940 /** 3941 * poll_client - Probe (null data or such) the given station 3942 * @priv: Private driver interface data 3943 * @own_addr: MAC address of sending interface 3944 * @addr: MAC address of the station to probe 3945 * @qos: Indicates whether station is QoS station 3946 * 3947 * This function is used to verify whether an associated station is 3948 * still present. This function does not need to be implemented if the 3949 * driver provides such inactivity polling mechanism. 3950 */ 3951 void (*poll_client)(void *priv, const u8 *own_addr, 3952 const u8 *addr, int qos); 3953 3954 /** 3955 * radio_disable - Disable/enable radio 3956 * @priv: Private driver interface data 3957 * @disabled: 1=disable 0=enable radio 3958 * Returns: 0 on success, -1 on failure 3959 * 3960 * This optional command is for testing purposes. It can be used to 3961 * disable the radio on a testbed device to simulate out-of-radio-range 3962 * conditions. 3963 */ 3964 int (*radio_disable)(void *priv, int disabled); 3965 3966 /** 3967 * switch_channel - Announce channel switch and migrate the GO to the 3968 * given frequency 3969 * @priv: Private driver interface data 3970 * @settings: Settings for CSA period and new channel 3971 * Returns: 0 on success, -1 on failure 3972 * 3973 * This function is used to move the GO to the legacy STA channel to 3974 * avoid frequency conflict in single channel concurrency. 3975 */ 3976 int (*switch_channel)(void *priv, struct csa_settings *settings); 3977 3978 /** 3979 * add_tx_ts - Add traffic stream 3980 * @priv: Private driver interface data 3981 * @tsid: Traffic stream ID 3982 * @addr: Receiver address 3983 * @user_prio: User priority of the traffic stream 3984 * @admitted_time: Admitted time for this TS in units of 3985 * 32 microsecond periods (per second). 3986 * Returns: 0 on success, -1 on failure 3987 */ 3988 int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio, 3989 u16 admitted_time); 3990 3991 /** 3992 * del_tx_ts - Delete traffic stream 3993 * @priv: Private driver interface data 3994 * @tsid: Traffic stream ID 3995 * @addr: Receiver address 3996 * Returns: 0 on success, -1 on failure 3997 */ 3998 int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr); 3999 4000 /** 4001 * Enable channel-switching with TDLS peer 4002 * @priv: Private driver interface data 4003 * @addr: MAC address of the TDLS peer 4004 * @oper_class: Operating class of the switch channel 4005 * @params: Channel specification 4006 * Returns: 0 on success, -1 on failure 4007 * 4008 * The function indicates to driver that it can start switching to a 4009 * different channel with a specified TDLS peer. The switching is 4010 * assumed on until canceled with tdls_disable_channel_switch(). 4011 */ 4012 int (*tdls_enable_channel_switch)( 4013 void *priv, const u8 *addr, u8 oper_class, 4014 const struct hostapd_freq_params *params); 4015 4016 /** 4017 * Disable channel switching with TDLS peer 4018 * @priv: Private driver interface data 4019 * @addr: MAC address of the TDLS peer 4020 * Returns: 0 on success, -1 on failure 4021 * 4022 * This function indicates to the driver that it should stop switching 4023 * with a given TDLS peer. 4024 */ 4025 int (*tdls_disable_channel_switch)(void *priv, const u8 *addr); 4026 4027 /** 4028 * start_dfs_cac - Listen for radar interference on the channel 4029 * @priv: Private driver interface data 4030 * @freq: Channel parameters 4031 * Returns: 0 on success, -1 on failure 4032 */ 4033 int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq); 4034 4035 /** 4036 * stop_ap - Removes beacon from AP 4037 * @priv: Private driver interface data 4038 * Returns: 0 on success, -1 on failure (or if not supported) 4039 * 4040 * This optional function can be used to disable AP mode related 4041 * configuration. Unlike deinit_ap, it does not change to station 4042 * mode. 4043 */ 4044 int (*stop_ap)(void *priv); 4045 4046 /** 4047 * get_survey - Retrieve survey data 4048 * @priv: Private driver interface data 4049 * @freq: If set, survey data for the specified frequency is only 4050 * being requested. If not set, all survey data is requested. 4051 * Returns: 0 on success, -1 on failure 4052 * 4053 * Use this to retrieve: 4054 * 4055 * - the observed channel noise floor 4056 * - the amount of time we have spent on the channel 4057 * - the amount of time during which we have spent on the channel that 4058 * the radio has determined the medium is busy and we cannot 4059 * transmit 4060 * - the amount of time we have spent receiving data 4061 * - the amount of time we have spent transmitting data 4062 * 4063 * This data can be used for spectrum heuristics. One example is 4064 * Automatic Channel Selection (ACS). The channel survey data is 4065 * kept on a linked list on the channel data, one entry is added 4066 * for each survey. The min_nf of the channel is updated for each 4067 * survey. 4068 */ 4069 int (*get_survey)(void *priv, unsigned int freq); 4070 4071 /** 4072 * status - Get driver interface status information 4073 * @priv: Private driver interface data 4074 * @buf: Buffer for printing the status information 4075 * @buflen: Maximum length of the buffer 4076 * Returns: Length of written status information or -1 on failure 4077 */ 4078 int (*status)(void *priv, char *buf, size_t buflen); 4079 4080 /** 4081 * roaming - Set roaming policy for driver-based BSS selection 4082 * @priv: Private driver interface data 4083 * @allowed: Whether roaming within ESS is allowed 4084 * @bssid: Forced BSSID if roaming is disabled or %NULL if not set 4085 * Returns: Length of written status information or -1 on failure 4086 * 4087 * This optional callback can be used to update roaming policy from the 4088 * associate() command (bssid being set there indicates that the driver 4089 * should not roam before getting this roaming() call to allow roaming. 4090 * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION 4091 * capability, roaming policy is handled within wpa_supplicant and there 4092 * is no need to implement or react to this callback. 4093 */ 4094 int (*roaming)(void *priv, int allowed, const u8 *bssid); 4095 4096 /** 4097 * disable_fils - Enable/disable FILS feature 4098 * @priv: Private driver interface data 4099 * @disable: 0-enable and 1-disable FILS feature 4100 * Returns: 0 on success, -1 on failure 4101 * 4102 * This callback can be used to configure driver and below layers to 4103 * enable/disable all FILS features. 4104 */ 4105 int (*disable_fils)(void *priv, int disable); 4106 4107 /** 4108 * set_mac_addr - Set MAC address 4109 * @priv: Private driver interface data 4110 * @addr: MAC address to use or %NULL for setting back to permanent 4111 * Returns: 0 on success, -1 on failure 4112 */ 4113 int (*set_mac_addr)(void *priv, const u8 *addr); 4114 4115 #ifdef CONFIG_MACSEC 4116 int (*macsec_init)(void *priv, struct macsec_init_params *params); 4117 4118 int (*macsec_deinit)(void *priv); 4119 4120 /** 4121 * macsec_get_capability - Inform MKA of this driver's capability 4122 * @priv: Private driver interface data 4123 * @cap: Driver's capability 4124 * Returns: 0 on success, -1 on failure 4125 */ 4126 int (*macsec_get_capability)(void *priv, enum macsec_cap *cap); 4127 4128 /** 4129 * enable_protect_frames - Set protect frames status 4130 * @priv: Private driver interface data 4131 * @enabled: true = protect frames enabled 4132 * false = protect frames disabled 4133 * Returns: 0 on success, -1 on failure (or if not supported) 4134 */ 4135 int (*enable_protect_frames)(void *priv, bool enabled); 4136 4137 /** 4138 * enable_encrypt - Set encryption status 4139 * @priv: Private driver interface data 4140 * @enabled: true = encrypt outgoing traffic 4141 * false = integrity-only protection on outgoing traffic 4142 * Returns: 0 on success, -1 on failure (or if not supported) 4143 */ 4144 int (*enable_encrypt)(void *priv, bool enabled); 4145 4146 /** 4147 * set_replay_protect - Set replay protect status and window size 4148 * @priv: Private driver interface data 4149 * @enabled: true = replay protect enabled 4150 * false = replay protect disabled 4151 * @window: replay window size, valid only when replay protect enabled 4152 * Returns: 0 on success, -1 on failure (or if not supported) 4153 */ 4154 int (*set_replay_protect)(void *priv, bool enabled, u32 window); 4155 4156 /** 4157 * set_current_cipher_suite - Set current cipher suite 4158 * @priv: Private driver interface data 4159 * @cs: EUI64 identifier 4160 * Returns: 0 on success, -1 on failure (or if not supported) 4161 */ 4162 int (*set_current_cipher_suite)(void *priv, u64 cs); 4163 4164 /** 4165 * enable_controlled_port - Set controlled port status 4166 * @priv: Private driver interface data 4167 * @enabled: true = controlled port enabled 4168 * false = controlled port disabled 4169 * Returns: 0 on success, -1 on failure (or if not supported) 4170 */ 4171 int (*enable_controlled_port)(void *priv, bool enabled); 4172 4173 /** 4174 * get_receive_lowest_pn - Get receive lowest pn 4175 * @priv: Private driver interface data 4176 * @sa: secure association 4177 * Returns: 0 on success, -1 on failure (or if not supported) 4178 */ 4179 int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa); 4180 4181 /** 4182 * get_transmit_next_pn - Get transmit next pn 4183 * @priv: Private driver interface data 4184 * @sa: secure association 4185 * Returns: 0 on success, -1 on failure (or if not supported) 4186 */ 4187 int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa); 4188 4189 /** 4190 * set_transmit_next_pn - Set transmit next pn 4191 * @priv: Private driver interface data 4192 * @sa: secure association 4193 * Returns: 0 on success, -1 on failure (or if not supported) 4194 */ 4195 int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa); 4196 4197 /** 4198 * set_receive_lowest_pn - Set receive lowest PN 4199 * @priv: Private driver interface data 4200 * @sa: secure association 4201 * Returns: 0 on success, -1 on failure (or if not supported) 4202 */ 4203 int (*set_receive_lowest_pn)(void *priv, struct receive_sa *sa); 4204 4205 /** 4206 * create_receive_sc - create secure channel for receiving 4207 * @priv: Private driver interface data 4208 * @sc: secure channel 4209 * @conf_offset: confidentiality offset (0, 30, or 50) 4210 * @validation: frame validation policy (0 = Disabled, 1 = Checked, 4211 * 2 = Strict) 4212 * Returns: 0 on success, -1 on failure (or if not supported) 4213 */ 4214 int (*create_receive_sc)(void *priv, struct receive_sc *sc, 4215 unsigned int conf_offset, 4216 int validation); 4217 4218 /** 4219 * delete_receive_sc - delete secure connection for receiving 4220 * @priv: private driver interface data from init() 4221 * @sc: secure channel 4222 * Returns: 0 on success, -1 on failure 4223 */ 4224 int (*delete_receive_sc)(void *priv, struct receive_sc *sc); 4225 4226 /** 4227 * create_receive_sa - create secure association for receive 4228 * @priv: private driver interface data from init() 4229 * @sa: secure association 4230 * Returns: 0 on success, -1 on failure 4231 */ 4232 int (*create_receive_sa)(void *priv, struct receive_sa *sa); 4233 4234 /** 4235 * delete_receive_sa - Delete secure association for receive 4236 * @priv: Private driver interface data from init() 4237 * @sa: Secure association 4238 * Returns: 0 on success, -1 on failure 4239 */ 4240 int (*delete_receive_sa)(void *priv, struct receive_sa *sa); 4241 4242 /** 4243 * enable_receive_sa - enable the SA for receive 4244 * @priv: private driver interface data from init() 4245 * @sa: secure association 4246 * Returns: 0 on success, -1 on failure 4247 */ 4248 int (*enable_receive_sa)(void *priv, struct receive_sa *sa); 4249 4250 /** 4251 * disable_receive_sa - disable SA for receive 4252 * @priv: private driver interface data from init() 4253 * @sa: secure association 4254 * Returns: 0 on success, -1 on failure 4255 */ 4256 int (*disable_receive_sa)(void *priv, struct receive_sa *sa); 4257 4258 /** 4259 * create_transmit_sc - create secure connection for transmit 4260 * @priv: private driver interface data from init() 4261 * @sc: secure channel 4262 * @conf_offset: confidentiality offset (0, 30, or 50) 4263 * Returns: 0 on success, -1 on failure 4264 */ 4265 int (*create_transmit_sc)(void *priv, struct transmit_sc *sc, 4266 unsigned int conf_offset); 4267 4268 /** 4269 * delete_transmit_sc - delete secure connection for transmit 4270 * @priv: private driver interface data from init() 4271 * @sc: secure channel 4272 * Returns: 0 on success, -1 on failure 4273 */ 4274 int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc); 4275 4276 /** 4277 * create_transmit_sa - create secure association for transmit 4278 * @priv: private driver interface data from init() 4279 * @sa: secure association 4280 * Returns: 0 on success, -1 on failure 4281 */ 4282 int (*create_transmit_sa)(void *priv, struct transmit_sa *sa); 4283 4284 /** 4285 * delete_transmit_sa - Delete secure association for transmit 4286 * @priv: Private driver interface data from init() 4287 * @sa: Secure association 4288 * Returns: 0 on success, -1 on failure 4289 */ 4290 int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa); 4291 4292 /** 4293 * enable_transmit_sa - enable SA for transmit 4294 * @priv: private driver interface data from init() 4295 * @sa: secure association 4296 * Returns: 0 on success, -1 on failure 4297 */ 4298 int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa); 4299 4300 /** 4301 * disable_transmit_sa - disable SA for transmit 4302 * @priv: private driver interface data from init() 4303 * @sa: secure association 4304 * Returns: 0 on success, -1 on failure 4305 */ 4306 int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa); 4307 #endif /* CONFIG_MACSEC */ 4308 4309 /** 4310 * init_mesh - Driver specific initialization for mesh 4311 * @priv: Private driver interface data 4312 * Returns: 0 on success, -1 on failure 4313 */ 4314 int (*init_mesh)(void *priv); 4315 4316 /** 4317 * join_mesh - Join a mesh network 4318 * @priv: Private driver interface data 4319 * @params: Mesh configuration parameters 4320 * Returns: 0 on success, -1 on failure 4321 */ 4322 int (*join_mesh)(void *priv, 4323 struct wpa_driver_mesh_join_params *params); 4324 4325 /** 4326 * leave_mesh - Leave a mesh network 4327 * @priv: Private driver interface data 4328 * Returns 0 on success, -1 on failure 4329 */ 4330 int (*leave_mesh)(void *priv); 4331 4332 /** 4333 * probe_mesh_link - Inject a frame over direct mesh link to a given 4334 * peer skipping the next_hop lookup from mpath table. 4335 * @priv: Private driver interface data 4336 * @addr: Peer MAC address 4337 * @eth: Ethernet frame to be sent 4338 * @len: Ethernet frame lengtn in bytes 4339 * Returns 0 on success, -1 on failure 4340 */ 4341 int (*probe_mesh_link)(void *priv, const u8 *addr, const u8 *eth, 4342 size_t len); 4343 4344 /** 4345 * do_acs - Automatically select channel 4346 * @priv: Private driver interface data 4347 * @params: Parameters for ACS 4348 * Returns 0 on success, -1 on failure 4349 * 4350 * This command can be used to offload ACS to the driver if the driver 4351 * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD). 4352 */ 4353 int (*do_acs)(void *priv, struct drv_acs_params *params); 4354 4355 /** 4356 * set_band - Notify driver of band(s) selection 4357 * @priv: Private driver interface data 4358 * @band_mask: The selected band(s) bit mask (from enum set_band) 4359 * Returns 0 on success, -1 on failure 4360 */ 4361 int (*set_band)(void *priv, u32 band_mask); 4362 4363 /** 4364 * get_pref_freq_list - Get preferred frequency list for an interface 4365 * @priv: Private driver interface data 4366 * @if_type: Interface type 4367 * @num: Number of channels 4368 * @freq_list: Preferred channel frequency list encoded in MHz values 4369 * Returns 0 on success, -1 on failure 4370 * 4371 * This command can be used to query the preferred frequency list from 4372 * the driver specific to a particular interface type. 4373 */ 4374 int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type, 4375 unsigned int *num, unsigned int *freq_list); 4376 4377 /** 4378 * set_prob_oper_freq - Indicate probable P2P operating channel 4379 * @priv: Private driver interface data 4380 * @freq: Channel frequency in MHz 4381 * Returns 0 on success, -1 on failure 4382 * 4383 * This command can be used to inform the driver of the operating 4384 * frequency that an ongoing P2P group formation is likely to come up 4385 * on. Local device is assuming P2P Client role. 4386 */ 4387 int (*set_prob_oper_freq)(void *priv, unsigned int freq); 4388 4389 /** 4390 * abort_scan - Request the driver to abort an ongoing scan 4391 * @priv: Private driver interface data 4392 * @scan_cookie: Cookie identifying the scan request. This is used only 4393 * when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN 4394 * was used to trigger scan. Otherwise, 0 is used. 4395 * Returns 0 on success, -1 on failure 4396 */ 4397 int (*abort_scan)(void *priv, u64 scan_cookie); 4398 4399 /** 4400 * configure_data_frame_filters - Request to configure frame filters 4401 * @priv: Private driver interface data 4402 * @filter_flags: The type of frames to filter (bitfield of 4403 * WPA_DATA_FRAME_FILTER_FLAG_*) 4404 * Returns: 0 on success or -1 on failure 4405 */ 4406 int (*configure_data_frame_filters)(void *priv, u32 filter_flags); 4407 4408 /** 4409 * get_ext_capab - Get extended capabilities for the specified interface 4410 * @priv: Private driver interface data 4411 * @type: Interface type for which to get extended capabilities 4412 * @ext_capab: Extended capabilities fetched 4413 * @ext_capab_mask: Extended capabilities mask 4414 * @ext_capab_len: Length of the extended capabilities 4415 * Returns: 0 on success or -1 on failure 4416 */ 4417 int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type, 4418 const u8 **ext_capab, const u8 **ext_capab_mask, 4419 unsigned int *ext_capab_len); 4420 4421 /** 4422 * p2p_lo_start - Start offloading P2P listen to device 4423 * @priv: Private driver interface data 4424 * @freq: Listening frequency (MHz) for P2P listen 4425 * @period: Length of the listen operation in milliseconds 4426 * @interval: Interval for running the listen operation in milliseconds 4427 * @count: Number of times to run the listen operation 4428 * @device_types: Device primary and secondary types 4429 * @dev_types_len: Number of bytes for device_types 4430 * @ies: P2P IE and WSC IE for Probe Response frames 4431 * @ies_len: Length of ies in bytes 4432 * Returns: 0 on success or -1 on failure 4433 */ 4434 int (*p2p_lo_start)(void *priv, unsigned int freq, 4435 unsigned int period, unsigned int interval, 4436 unsigned int count, 4437 const u8 *device_types, size_t dev_types_len, 4438 const u8 *ies, size_t ies_len); 4439 4440 /** 4441 * p2p_lo_stop - Stop P2P listen offload 4442 * @priv: Private driver interface data 4443 * Returns: 0 on success or -1 on failure 4444 */ 4445 int (*p2p_lo_stop)(void *priv); 4446 4447 /** 4448 * set_default_scan_ies - Set default scan IEs 4449 * @priv: Private driver interface data 4450 * @ies: Scan default IEs buffer 4451 * @ies_len: Length of IEs in bytes 4452 * Returns: 0 on success or -1 on failure 4453 * 4454 * The driver can use these by default when there are no scan IEs coming 4455 * in the subsequent scan requests. Also in case of one or more of IEs 4456 * given in set_default_scan_ies() are missing in the subsequent scan 4457 * request, the driver should merge the missing scan IEs in the scan 4458 * request from the IEs set by set_default_scan_ies() in the Probe 4459 * Request frames sent. 4460 */ 4461 int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len); 4462 4463 /** 4464 * set_tdls_mode - Set TDLS trigger mode to the host driver 4465 * @priv: Private driver interface data 4466 * @tdls_external_control: Represents if TDLS external trigger control 4467 * mode is enabled/disabled. 4468 * 4469 * This optional callback can be used to configure the TDLS external 4470 * trigger control mode to the host driver. 4471 */ 4472 int (*set_tdls_mode)(void *priv, int tdls_external_control); 4473 4474 /** 4475 * get_bss_transition_status - Get candidate BSS's transition status 4476 * @priv: Private driver interface data 4477 * @params: Candidate BSS list 4478 * 4479 * Get the accept or reject reason code for a list of BSS transition 4480 * candidates. 4481 */ 4482 struct wpa_bss_candidate_info * 4483 (*get_bss_transition_status)(void *priv, 4484 struct wpa_bss_trans_info *params); 4485 /** 4486 * ignore_assoc_disallow - Configure driver to ignore assoc_disallow 4487 * @priv: Private driver interface data 4488 * @ignore_disallow: 0 to not ignore, 1 to ignore 4489 * Returns: 0 on success, -1 on failure 4490 */ 4491 int (*ignore_assoc_disallow)(void *priv, int ignore_disallow); 4492 4493 /** 4494 * set_bssid_tmp_disallow - Set disallowed BSSIDs to the driver 4495 * @priv: Private driver interface data 4496 * @num_bssid: Number of temporarily disallowed BSSIDs 4497 * @bssids: List of temporarily disallowed BSSIDs 4498 */ 4499 int (*set_bssid_tmp_disallow)(void *priv, unsigned int num_bssid, 4500 const u8 *bssid); 4501 4502 /** 4503 * update_connect_params - Update the connection parameters 4504 * @priv: Private driver interface data 4505 * @params: Association parameters 4506 * @mask: Bit mask indicating which parameters in @params have to be 4507 * updated 4508 * Returns: 0 on success, -1 on failure 4509 * 4510 * Update the connection parameters when in connected state so that the 4511 * driver uses the updated parameters for subsequent roaming. This is 4512 * used only with drivers that implement internal BSS selection and 4513 * roaming. 4514 */ 4515 int (*update_connect_params)( 4516 void *priv, struct wpa_driver_associate_params *params, 4517 enum wpa_drv_update_connect_params_mask mask); 4518 4519 /** 4520 * send_external_auth_status - Indicate the status of external 4521 * authentication processing to the host driver. 4522 * @priv: Private driver interface data 4523 * @params: Status of authentication processing. 4524 * Returns: 0 on success, -1 on failure 4525 */ 4526 int (*send_external_auth_status)(void *priv, 4527 struct external_auth *params); 4528 4529 /** 4530 * set_4addr_mode - Set 4-address mode 4531 * @priv: Private driver interface data 4532 * @bridge_ifname: Bridge interface name 4533 * @val: 0 - disable 4addr mode, 1 - enable 4addr mode 4534 * Returns: 0 on success, < 0 on failure 4535 */ 4536 int (*set_4addr_mode)(void *priv, const char *bridge_ifname, int val); 4537 4538 /** 4539 * update_dh_ie - Update DH IE 4540 * @priv: Private driver interface data 4541 * @peer_mac: Peer MAC address 4542 * @reason_code: Reacon code 4543 * @ie: DH IE 4544 * @ie_len: DH IE length in bytes 4545 * Returns: 0 on success, -1 on failure 4546 * 4547 * This callback is used to let the driver know the DH processing result 4548 * and DH IE for a pending association. 4549 */ 4550 int (*update_dh_ie)(void *priv, const u8 *peer_mac, u16 reason_code, 4551 const u8 *ie, size_t ie_len); 4552 4553 /** 4554 * dpp_listen - Notify driver about start/stop of DPP listen 4555 * @priv: Private driver interface data 4556 * @enable: Whether listen state is enabled (or disabled) 4557 * Returns: 0 on success, -1 on failure 4558 * 4559 * This optional callback can be used to update RX frame filtering to 4560 * explicitly allow reception of broadcast Public Action frames. 4561 */ 4562 int (*dpp_listen)(void *priv, bool enable); 4563 4564 #ifdef CONFIG_TESTING_OPTIONS 4565 int (*register_frame)(void *priv, u16 type, 4566 const u8 *match, size_t match_len, 4567 bool multicast); 4568 #endif /* CONFIG_TESTING_OPTIONS */ 4569 }; 4570 4571 /** 4572 * enum wpa_event_type - Event type for wpa_supplicant_event() calls 4573 */ 4574 enum wpa_event_type { 4575 /** 4576 * EVENT_ASSOC - Association completed 4577 * 4578 * This event needs to be delivered when the driver completes IEEE 4579 * 802.11 association or reassociation successfully. 4580 * wpa_driver_ops::get_bssid() is expected to provide the current BSSID 4581 * after this event has been generated. In addition, optional 4582 * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide 4583 * more information about the association. If the driver interface gets 4584 * both of these events at the same time, it can also include the 4585 * assoc_info data in EVENT_ASSOC call. 4586 */ 4587 EVENT_ASSOC, 4588 4589 /** 4590 * EVENT_DISASSOC - Association lost 4591 * 4592 * This event should be called when association is lost either due to 4593 * receiving deauthenticate or disassociate frame from the AP or when 4594 * sending either of these frames to the current AP. If the driver 4595 * supports separate deauthentication event, EVENT_DISASSOC should only 4596 * be used for disassociation and EVENT_DEAUTH for deauthentication. 4597 * In AP mode, union wpa_event_data::disassoc_info is required. 4598 */ 4599 EVENT_DISASSOC, 4600 4601 /** 4602 * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected 4603 * 4604 * This event must be delivered when a Michael MIC error is detected by 4605 * the local driver. Additional data for event processing is 4606 * provided with union wpa_event_data::michael_mic_failure. This 4607 * information is used to request new encyption key and to initiate 4608 * TKIP countermeasures if needed. 4609 */ 4610 EVENT_MICHAEL_MIC_FAILURE, 4611 4612 /** 4613 * EVENT_SCAN_RESULTS - Scan results available 4614 * 4615 * This event must be called whenever scan results are available to be 4616 * fetched with struct wpa_driver_ops::get_scan_results(). This event 4617 * is expected to be used some time after struct wpa_driver_ops::scan() 4618 * is called. If the driver provides an unsolicited event when the scan 4619 * has been completed, this event can be used to trigger 4620 * EVENT_SCAN_RESULTS call. If such event is not available from the 4621 * driver, the driver wrapper code is expected to use a registered 4622 * timeout to generate EVENT_SCAN_RESULTS call after the time that the 4623 * scan is expected to be completed. Optional information about 4624 * completed scan can be provided with union wpa_event_data::scan_info. 4625 */ 4626 EVENT_SCAN_RESULTS, 4627 4628 /** 4629 * EVENT_ASSOCINFO - Report optional extra information for association 4630 * 4631 * This event can be used to report extra association information for 4632 * EVENT_ASSOC processing. This extra information includes IEs from 4633 * association frames and Beacon/Probe Response frames in union 4634 * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before 4635 * EVENT_ASSOC. Alternatively, the driver interface can include 4636 * assoc_info data in the EVENT_ASSOC call if it has all the 4637 * information available at the same point. 4638 */ 4639 EVENT_ASSOCINFO, 4640 4641 /** 4642 * EVENT_INTERFACE_STATUS - Report interface status changes 4643 * 4644 * This optional event can be used to report changes in interface 4645 * status (interface added/removed) using union 4646 * wpa_event_data::interface_status. This can be used to trigger 4647 * wpa_supplicant to stop and re-start processing for the interface, 4648 * e.g., when a cardbus card is ejected/inserted. 4649 */ 4650 EVENT_INTERFACE_STATUS, 4651 4652 /** 4653 * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication 4654 * 4655 * This event can be used to inform wpa_supplicant about candidates for 4656 * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible 4657 * for scan request (ap_scan=2 mode), this event is required for 4658 * pre-authentication. If wpa_supplicant is performing scan request 4659 * (ap_scan=1), this event is optional since scan results can be used 4660 * to add pre-authentication candidates. union 4661 * wpa_event_data::pmkid_candidate is used to report the BSSID of the 4662 * candidate and priority of the candidate, e.g., based on the signal 4663 * strength, in order to try to pre-authenticate first with candidates 4664 * that are most likely targets for re-association. 4665 * 4666 * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates 4667 * on the candidate list. In addition, it can be called for the current 4668 * AP and APs that have existing PMKSA cache entries. wpa_supplicant 4669 * will automatically skip pre-authentication in cases where a valid 4670 * PMKSA exists. When more than one candidate exists, this event should 4671 * be generated once for each candidate. 4672 * 4673 * Driver will be notified about successful pre-authentication with 4674 * struct wpa_driver_ops::add_pmkid() calls. 4675 */ 4676 EVENT_PMKID_CANDIDATE, 4677 4678 /** 4679 * EVENT_TDLS - Request TDLS operation 4680 * 4681 * This event can be used to request a TDLS operation to be performed. 4682 */ 4683 EVENT_TDLS, 4684 4685 /** 4686 * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs 4687 * 4688 * The driver is expected to report the received FT IEs from 4689 * FT authentication sequence from the AP. The FT IEs are included in 4690 * the extra information in union wpa_event_data::ft_ies. 4691 */ 4692 EVENT_FT_RESPONSE, 4693 4694 /** 4695 * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS 4696 * 4697 * The driver can use this event to inform wpa_supplicant about a STA 4698 * in an IBSS with which protected frames could be exchanged. This 4699 * event starts RSN authentication with the other STA to authenticate 4700 * the STA and set up encryption keys with it. 4701 */ 4702 EVENT_IBSS_RSN_START, 4703 4704 /** 4705 * EVENT_AUTH - Authentication result 4706 * 4707 * This event should be called when authentication attempt has been 4708 * completed. This is only used if the driver supports separate 4709 * authentication step (struct wpa_driver_ops::authenticate). 4710 * Information about authentication result is included in 4711 * union wpa_event_data::auth. 4712 */ 4713 EVENT_AUTH, 4714 4715 /** 4716 * EVENT_DEAUTH - Authentication lost 4717 * 4718 * This event should be called when authentication is lost either due 4719 * to receiving deauthenticate frame from the AP or when sending that 4720 * frame to the current AP. 4721 * In AP mode, union wpa_event_data::deauth_info is required. 4722 */ 4723 EVENT_DEAUTH, 4724 4725 /** 4726 * EVENT_ASSOC_REJECT - Association rejected 4727 * 4728 * This event should be called when (re)association attempt has been 4729 * rejected by the AP. Information about the association response is 4730 * included in union wpa_event_data::assoc_reject. 4731 */ 4732 EVENT_ASSOC_REJECT, 4733 4734 /** 4735 * EVENT_AUTH_TIMED_OUT - Authentication timed out 4736 */ 4737 EVENT_AUTH_TIMED_OUT, 4738 4739 /** 4740 * EVENT_ASSOC_TIMED_OUT - Association timed out 4741 */ 4742 EVENT_ASSOC_TIMED_OUT, 4743 4744 /** 4745 * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS 4746 */ 4747 EVENT_WPS_BUTTON_PUSHED, 4748 4749 /** 4750 * EVENT_TX_STATUS - Report TX status 4751 */ 4752 EVENT_TX_STATUS, 4753 4754 /** 4755 * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA 4756 */ 4757 EVENT_RX_FROM_UNKNOWN, 4758 4759 /** 4760 * EVENT_RX_MGMT - Report RX of a management frame 4761 */ 4762 EVENT_RX_MGMT, 4763 4764 /** 4765 * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started 4766 * 4767 * This event is used to indicate when the driver has started the 4768 * requested remain-on-channel duration. Information about the 4769 * operation is included in union wpa_event_data::remain_on_channel. 4770 */ 4771 EVENT_REMAIN_ON_CHANNEL, 4772 4773 /** 4774 * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out 4775 * 4776 * This event is used to indicate when the driver has completed 4777 * remain-on-channel duration, i.e., may noot be available on the 4778 * requested channel anymore. Information about the 4779 * operation is included in union wpa_event_data::remain_on_channel. 4780 */ 4781 EVENT_CANCEL_REMAIN_ON_CHANNEL, 4782 4783 /** 4784 * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame 4785 * 4786 * This event is used to indicate when a Probe Request frame has been 4787 * received. Information about the received frame is included in 4788 * union wpa_event_data::rx_probe_req. The driver is required to report 4789 * these events only after successfully completed probe_req_report() 4790 * commands to request the events (i.e., report parameter is non-zero) 4791 * in station mode. In AP mode, Probe Request frames should always be 4792 * reported. 4793 */ 4794 EVENT_RX_PROBE_REQ, 4795 4796 /** 4797 * EVENT_NEW_STA - New wired device noticed 4798 * 4799 * This event is used to indicate that a new device has been detected 4800 * in a network that does not use association-like functionality (i.e., 4801 * mainly wired Ethernet). This can be used to start EAPOL 4802 * authenticator when receiving a frame from a device. The address of 4803 * the device is included in union wpa_event_data::new_sta. 4804 */ 4805 EVENT_NEW_STA, 4806 4807 /** 4808 * EVENT_EAPOL_RX - Report received EAPOL frame 4809 * 4810 * When in AP mode with hostapd, this event is required to be used to 4811 * deliver the receive EAPOL frames from the driver. 4812 */ 4813 EVENT_EAPOL_RX, 4814 4815 /** 4816 * EVENT_SIGNAL_CHANGE - Indicate change in signal strength 4817 * 4818 * This event is used to indicate changes in the signal strength 4819 * observed in frames received from the current AP if signal strength 4820 * monitoring has been enabled with signal_monitor(). 4821 */ 4822 EVENT_SIGNAL_CHANGE, 4823 4824 /** 4825 * EVENT_INTERFACE_ENABLED - Notify that interface was enabled 4826 * 4827 * This event is used to indicate that the interface was enabled after 4828 * having been previously disabled, e.g., due to rfkill. 4829 */ 4830 EVENT_INTERFACE_ENABLED, 4831 4832 /** 4833 * EVENT_INTERFACE_DISABLED - Notify that interface was disabled 4834 * 4835 * This event is used to indicate that the interface was disabled, 4836 * e.g., due to rfkill. 4837 */ 4838 EVENT_INTERFACE_DISABLED, 4839 4840 /** 4841 * EVENT_CHANNEL_LIST_CHANGED - Channel list changed 4842 * 4843 * This event is used to indicate that the channel list has changed, 4844 * e.g., because of a regulatory domain change triggered by scan 4845 * results including an AP advertising a country code. 4846 */ 4847 EVENT_CHANNEL_LIST_CHANGED, 4848 4849 /** 4850 * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable 4851 * 4852 * This event is used to indicate that the driver cannot maintain this 4853 * interface in its operation mode anymore. The most likely use for 4854 * this is to indicate that AP mode operation is not available due to 4855 * operating channel would need to be changed to a DFS channel when 4856 * the driver does not support radar detection and another virtual 4857 * interfaces caused the operating channel to change. Other similar 4858 * resource conflicts could also trigger this for station mode 4859 * interfaces. This event can be propagated when channel switching 4860 * fails. 4861 */ 4862 EVENT_INTERFACE_UNAVAILABLE, 4863 4864 /** 4865 * EVENT_BEST_CHANNEL 4866 * 4867 * Driver generates this event whenever it detects a better channel 4868 * (e.g., based on RSSI or channel use). This information can be used 4869 * to improve channel selection for a new AP/P2P group. 4870 */ 4871 EVENT_BEST_CHANNEL, 4872 4873 /** 4874 * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received 4875 * 4876 * This event should be called when a Deauthentication frame is dropped 4877 * due to it not being protected (MFP/IEEE 802.11w). 4878 * union wpa_event_data::unprot_deauth is required to provide more 4879 * details of the frame. 4880 */ 4881 EVENT_UNPROT_DEAUTH, 4882 4883 /** 4884 * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received 4885 * 4886 * This event should be called when a Disassociation frame is dropped 4887 * due to it not being protected (MFP/IEEE 802.11w). 4888 * union wpa_event_data::unprot_disassoc is required to provide more 4889 * details of the frame. 4890 */ 4891 EVENT_UNPROT_DISASSOC, 4892 4893 /** 4894 * EVENT_STATION_LOW_ACK 4895 * 4896 * Driver generates this event whenever it detected that a particular 4897 * station was lost. Detection can be through massive transmission 4898 * failures for example. 4899 */ 4900 EVENT_STATION_LOW_ACK, 4901 4902 /** 4903 * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore 4904 */ 4905 EVENT_IBSS_PEER_LOST, 4906 4907 /** 4908 * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey 4909 * 4910 * This event carries the new replay counter to notify wpa_supplicant 4911 * of the current EAPOL-Key Replay Counter in case the driver/firmware 4912 * completed Group Key Handshake while the host (including 4913 * wpa_supplicant was sleeping). 4914 */ 4915 EVENT_DRIVER_GTK_REKEY, 4916 4917 /** 4918 * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped 4919 */ 4920 EVENT_SCHED_SCAN_STOPPED, 4921 4922 /** 4923 * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll 4924 * 4925 * This event indicates that the station responded to the poll 4926 * initiated with @poll_client. 4927 */ 4928 EVENT_DRIVER_CLIENT_POLL_OK, 4929 4930 /** 4931 * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status 4932 */ 4933 EVENT_EAPOL_TX_STATUS, 4934 4935 /** 4936 * EVENT_CH_SWITCH - AP or GO decided to switch channels 4937 * 4938 * Described in wpa_event_data.ch_switch 4939 * */ 4940 EVENT_CH_SWITCH, 4941 4942 /** 4943 * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels 4944 * 4945 * This is a pre-switch event indicating the shortly following switch 4946 * of operating channels. 4947 * 4948 * Described in wpa_event_data.ch_switch 4949 */ 4950 EVENT_CH_SWITCH_STARTED, 4951 /** 4952 * EVENT_WNM - Request WNM operation 4953 * 4954 * This event can be used to request a WNM operation to be performed. 4955 */ 4956 EVENT_WNM, 4957 4958 /** 4959 * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode 4960 * 4961 * This event indicates that the driver reported a connection failure 4962 * with the specified client (for example, max client reached, etc.) in 4963 * AP mode. 4964 */ 4965 EVENT_CONNECT_FAILED_REASON, 4966 4967 /** 4968 * EVENT_DFS_RADAR_DETECTED - Notify of radar detection 4969 * 4970 * A radar has been detected on the supplied frequency, hostapd should 4971 * react accordingly (e.g., change channel). 4972 */ 4973 EVENT_DFS_RADAR_DETECTED, 4974 4975 /** 4976 * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed 4977 * 4978 * After a successful CAC, the channel can be marked clear and used. 4979 */ 4980 EVENT_DFS_CAC_FINISHED, 4981 4982 /** 4983 * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted 4984 * 4985 * The CAC was not successful, and the channel remains in the previous 4986 * state. This may happen due to a radar being detected or other 4987 * external influences. 4988 */ 4989 EVENT_DFS_CAC_ABORTED, 4990 4991 /** 4992 * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over 4993 * 4994 * The channel which was previously unavailable is now available again. 4995 */ 4996 EVENT_DFS_NOP_FINISHED, 4997 4998 /** 4999 * EVENT_SURVEY - Received survey data 5000 * 5001 * This event gets triggered when a driver query is issued for survey 5002 * data and the requested data becomes available. The returned data is 5003 * stored in struct survey_results. The results provide at most one 5004 * survey entry for each frequency and at minimum will provide one 5005 * survey entry for one frequency. The survey data can be os_malloc()'d 5006 * and then os_free()'d, so the event callback must only copy data. 5007 */ 5008 EVENT_SURVEY, 5009 5010 /** 5011 * EVENT_SCAN_STARTED - Scan started 5012 * 5013 * This indicates that driver has started a scan operation either based 5014 * on a request from wpa_supplicant/hostapd or from another application. 5015 * EVENT_SCAN_RESULTS is used to indicate when the scan has been 5016 * completed (either successfully or by getting cancelled). 5017 */ 5018 EVENT_SCAN_STARTED, 5019 5020 /** 5021 * EVENT_AVOID_FREQUENCIES - Received avoid frequency range 5022 * 5023 * This event indicates a set of frequency ranges that should be avoided 5024 * to reduce issues due to interference or internal co-existence 5025 * information in the driver. 5026 */ 5027 EVENT_AVOID_FREQUENCIES, 5028 5029 /** 5030 * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification 5031 */ 5032 EVENT_NEW_PEER_CANDIDATE, 5033 5034 /** 5035 * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS 5036 * 5037 * Indicates a pair of primary and secondary channels chosen by ACS 5038 * in device. 5039 */ 5040 EVENT_ACS_CHANNEL_SELECTED, 5041 5042 /** 5043 * EVENT_DFS_CAC_STARTED - Notify that channel availability check has 5044 * been started. 5045 * 5046 * This event indicates that channel availability check has been started 5047 * on a DFS frequency by a driver that supports DFS Offload. 5048 */ 5049 EVENT_DFS_CAC_STARTED, 5050 5051 /** 5052 * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped 5053 */ 5054 EVENT_P2P_LO_STOP, 5055 5056 /** 5057 * EVENT_BEACON_LOSS - Beacon loss detected 5058 * 5059 * This event indicates that no Beacon frames has been received from 5060 * the current AP. This may indicate that the AP is not anymore in 5061 * range. 5062 */ 5063 EVENT_BEACON_LOSS, 5064 5065 /** 5066 * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check 5067 * done previously (Pre-CAC) on the channel has expired. This would 5068 * normally be on a non-ETSI DFS regulatory domain. DFS state of the 5069 * channel will be moved from available to usable. A new CAC has to be 5070 * performed before start operating on this channel. 5071 */ 5072 EVENT_DFS_PRE_CAC_EXPIRED, 5073 5074 /** 5075 * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers 5076 * that do not define separate commands for authentication and 5077 * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11 5078 * authentication to wpa_supplicant. This event carries all the 5079 * necessary information from the host driver for the authentication to 5080 * happen. 5081 */ 5082 EVENT_EXTERNAL_AUTH, 5083 5084 /** 5085 * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized 5086 * 5087 * This event should be indicated when the driver completes the 4-way 5088 * handshake. This event should be preceded by an EVENT_ASSOC that 5089 * indicates the completion of IEEE 802.11 association. 5090 */ 5091 EVENT_PORT_AUTHORIZED, 5092 5093 /** 5094 * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode 5095 * change event. 5096 */ 5097 EVENT_STATION_OPMODE_CHANGED, 5098 5099 /** 5100 * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed 5101 * 5102 * This event is emitted when the MAC changes while the interface is 5103 * enabled. When an interface was disabled and becomes enabled, it 5104 * must be always assumed that the MAC possibly changed. 5105 */ 5106 EVENT_INTERFACE_MAC_CHANGED, 5107 5108 /** 5109 * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status 5110 * 5111 * This event is emitted when an interface is added/removed for WDS STA. 5112 */ 5113 EVENT_WDS_STA_INTERFACE_STATUS, 5114 5115 /** 5116 * EVENT_UPDATE_DH - Notification of updated DH information 5117 */ 5118 EVENT_UPDATE_DH, 5119 5120 /** 5121 * EVENT_UNPROT_BEACON - Unprotected Beacon frame received 5122 * 5123 * This event should be called when a Beacon frame is dropped due to it 5124 * not being protected correctly. union wpa_event_data::unprot_beacon 5125 * is required to provide more details of the frame. 5126 */ 5127 EVENT_UNPROT_BEACON, 5128 }; 5129 5130 5131 /** 5132 * struct freq_survey - Channel survey info 5133 * 5134 * @ifidx: Interface index in which this survey was observed 5135 * @freq: Center of frequency of the surveyed channel 5136 * @nf: Channel noise floor in dBm 5137 * @channel_time: Amount of time in ms the radio spent on the channel 5138 * @channel_time_busy: Amount of time in ms the radio detected some signal 5139 * that indicated to the radio the channel was not clear 5140 * @channel_time_rx: Amount of time the radio spent receiving data 5141 * @channel_time_tx: Amount of time the radio spent transmitting data 5142 * @filled: bitmask indicating which fields have been reported, see 5143 * SURVEY_HAS_* defines. 5144 * @list: Internal list pointers 5145 */ 5146 struct freq_survey { 5147 u32 ifidx; 5148 unsigned int freq; 5149 s8 nf; 5150 u64 channel_time; 5151 u64 channel_time_busy; 5152 u64 channel_time_rx; 5153 u64 channel_time_tx; 5154 unsigned int filled; 5155 struct dl_list list; 5156 }; 5157 5158 #define SURVEY_HAS_NF BIT(0) 5159 #define SURVEY_HAS_CHAN_TIME BIT(1) 5160 #define SURVEY_HAS_CHAN_TIME_BUSY BIT(2) 5161 #define SURVEY_HAS_CHAN_TIME_RX BIT(3) 5162 #define SURVEY_HAS_CHAN_TIME_TX BIT(4) 5163 5164 /** 5165 * enum sta_connect_fail_reason_codes - STA connect failure reason code values 5166 * @STA_CONNECT_FAIL_REASON_UNSPECIFIED: No reason code specified for 5167 * connection failure. 5168 * @STA_CONNECT_FAIL_REASON_NO_BSS_FOUND: No Probe Response frame received 5169 * for unicast Probe Request frame. 5170 * @STA_CONNECT_FAIL_REASON_AUTH_TX_FAIL: STA failed to send auth request. 5171 * @STA_CONNECT_FAIL_REASON_AUTH_NO_ACK_RECEIVED: AP didn't send ACK for 5172 * auth request. 5173 * @STA_CONNECT_FAIL_REASON_AUTH_NO_RESP_RECEIVED: Auth response is not 5174 * received from AP. 5175 * @STA_CONNECT_FAIL_REASON_ASSOC_REQ_TX_FAIL: STA failed to send 5176 * Association Request frame. 5177 * @STA_CONNECT_FAIL_REASON_ASSOC_NO_ACK_RECEIVED: AP didn't send ACK for 5178 * Association Request frame. 5179 * @STA_CONNECT_FAIL_REASON_ASSOC_NO_RESP_RECEIVED: Association Response 5180 * frame is not received from AP. 5181 */ 5182 enum sta_connect_fail_reason_codes { 5183 STA_CONNECT_FAIL_REASON_UNSPECIFIED = 0, 5184 STA_CONNECT_FAIL_REASON_NO_BSS_FOUND = 1, 5185 STA_CONNECT_FAIL_REASON_AUTH_TX_FAIL = 2, 5186 STA_CONNECT_FAIL_REASON_AUTH_NO_ACK_RECEIVED = 3, 5187 STA_CONNECT_FAIL_REASON_AUTH_NO_RESP_RECEIVED = 4, 5188 STA_CONNECT_FAIL_REASON_ASSOC_REQ_TX_FAIL = 5, 5189 STA_CONNECT_FAIL_REASON_ASSOC_NO_ACK_RECEIVED = 6, 5190 STA_CONNECT_FAIL_REASON_ASSOC_NO_RESP_RECEIVED = 7, 5191 }; 5192 5193 /** 5194 * union wpa_event_data - Additional data for wpa_supplicant_event() calls 5195 */ 5196 union wpa_event_data { 5197 /** 5198 * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events 5199 * 5200 * This structure is optional for EVENT_ASSOC calls and required for 5201 * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the 5202 * driver interface does not need to generate separate EVENT_ASSOCINFO 5203 * calls. 5204 */ 5205 struct assoc_info { 5206 /** 5207 * reassoc - Flag to indicate association or reassociation 5208 */ 5209 int reassoc; 5210 5211 /** 5212 * req_ies - (Re)Association Request IEs 5213 * 5214 * If the driver generates WPA/RSN IE, this event data must be 5215 * returned for WPA handshake to have needed information. If 5216 * wpa_supplicant-generated WPA/RSN IE is used, this 5217 * information event is optional. 5218 * 5219 * This should start with the first IE (fixed fields before IEs 5220 * are not included). 5221 */ 5222 const u8 *req_ies; 5223 5224 /** 5225 * req_ies_len - Length of req_ies in bytes 5226 */ 5227 size_t req_ies_len; 5228 5229 /** 5230 * resp_ies - (Re)Association Response IEs 5231 * 5232 * Optional association data from the driver. This data is not 5233 * required WPA, but may be useful for some protocols and as 5234 * such, should be reported if this is available to the driver 5235 * interface. 5236 * 5237 * This should start with the first IE (fixed fields before IEs 5238 * are not included). 5239 */ 5240 const u8 *resp_ies; 5241 5242 /** 5243 * resp_ies_len - Length of resp_ies in bytes 5244 */ 5245 size_t resp_ies_len; 5246 5247 /** 5248 * resp_frame - (Re)Association Response frame 5249 */ 5250 const u8 *resp_frame; 5251 5252 /** 5253 * resp_frame_len - (Re)Association Response frame length 5254 */ 5255 size_t resp_frame_len; 5256 5257 /** 5258 * beacon_ies - Beacon or Probe Response IEs 5259 * 5260 * Optional Beacon/ProbeResp data: IEs included in Beacon or 5261 * Probe Response frames from the current AP (i.e., the one 5262 * that the client just associated with). This information is 5263 * used to update WPA/RSN IE for the AP. If this field is not 5264 * set, the results from previous scan will be used. If no 5265 * data for the new AP is found, scan results will be requested 5266 * again (without scan request). At this point, the driver is 5267 * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is 5268 * used). 5269 * 5270 * This should start with the first IE (fixed fields before IEs 5271 * are not included). 5272 */ 5273 const u8 *beacon_ies; 5274 5275 /** 5276 * beacon_ies_len - Length of beacon_ies */ 5277 size_t beacon_ies_len; 5278 5279 /** 5280 * freq - Frequency of the operational channel in MHz 5281 */ 5282 unsigned int freq; 5283 5284 /** 5285 * wmm_params - WMM parameters used in this association. 5286 */ 5287 struct wmm_params wmm_params; 5288 5289 /** 5290 * addr - Station address (for AP mode) 5291 */ 5292 const u8 *addr; 5293 5294 /** 5295 * The following is the key management offload information 5296 * @authorized 5297 * @key_replay_ctr 5298 * @key_replay_ctr_len 5299 * @ptk_kck 5300 * @ptk_kek_len 5301 * @ptk_kek 5302 * @ptk_kek_len 5303 */ 5304 5305 /** 5306 * authorized - Status of key management offload, 5307 * 1 = successful 5308 */ 5309 int authorized; 5310 5311 /** 5312 * key_replay_ctr - Key replay counter value last used 5313 * in a valid EAPOL-Key frame 5314 */ 5315 const u8 *key_replay_ctr; 5316 5317 /** 5318 * key_replay_ctr_len - The length of key_replay_ctr 5319 */ 5320 size_t key_replay_ctr_len; 5321 5322 /** 5323 * ptk_kck - The derived PTK KCK 5324 */ 5325 const u8 *ptk_kck; 5326 5327 /** 5328 * ptk_kek_len - The length of ptk_kck 5329 */ 5330 size_t ptk_kck_len; 5331 5332 /** 5333 * ptk_kek - The derived PTK KEK 5334 * This is used in key management offload and also in FILS SK 5335 * offload. 5336 */ 5337 const u8 *ptk_kek; 5338 5339 /** 5340 * ptk_kek_len - The length of ptk_kek 5341 */ 5342 size_t ptk_kek_len; 5343 5344 /** 5345 * subnet_status - The subnet status: 5346 * 0 = unknown, 1 = unchanged, 2 = changed 5347 */ 5348 u8 subnet_status; 5349 5350 /** 5351 * The following information is used in FILS SK offload 5352 * @fils_erp_next_seq_num 5353 * @fils_pmk 5354 * @fils_pmk_len 5355 * @fils_pmkid 5356 */ 5357 5358 /** 5359 * fils_erp_next_seq_num - The next sequence number to use in 5360 * FILS ERP messages 5361 */ 5362 u16 fils_erp_next_seq_num; 5363 5364 /** 5365 * fils_pmk - A new PMK if generated in case of FILS 5366 * authentication 5367 */ 5368 const u8 *fils_pmk; 5369 5370 /** 5371 * fils_pmk_len - Length of fils_pmk 5372 */ 5373 size_t fils_pmk_len; 5374 5375 /** 5376 * fils_pmkid - PMKID used or generated in FILS authentication 5377 */ 5378 const u8 *fils_pmkid; 5379 } assoc_info; 5380 5381 /** 5382 * struct disassoc_info - Data for EVENT_DISASSOC events 5383 */ 5384 struct disassoc_info { 5385 /** 5386 * addr - Station address (for AP mode) 5387 */ 5388 const u8 *addr; 5389 5390 /** 5391 * reason_code - Reason Code (host byte order) used in 5392 * Deauthentication frame 5393 */ 5394 u16 reason_code; 5395 5396 /** 5397 * ie - Optional IE(s) in Disassociation frame 5398 */ 5399 const u8 *ie; 5400 5401 /** 5402 * ie_len - Length of ie buffer in octets 5403 */ 5404 size_t ie_len; 5405 5406 /** 5407 * locally_generated - Whether the frame was locally generated 5408 */ 5409 int locally_generated; 5410 } disassoc_info; 5411 5412 /** 5413 * struct deauth_info - Data for EVENT_DEAUTH events 5414 */ 5415 struct deauth_info { 5416 /** 5417 * addr - Station address (for AP mode) 5418 */ 5419 const u8 *addr; 5420 5421 /** 5422 * reason_code - Reason Code (host byte order) used in 5423 * Deauthentication frame 5424 */ 5425 u16 reason_code; 5426 5427 /** 5428 * ie - Optional IE(s) in Deauthentication frame 5429 */ 5430 const u8 *ie; 5431 5432 /** 5433 * ie_len - Length of ie buffer in octets 5434 */ 5435 size_t ie_len; 5436 5437 /** 5438 * locally_generated - Whether the frame was locally generated 5439 */ 5440 int locally_generated; 5441 } deauth_info; 5442 5443 /** 5444 * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE 5445 */ 5446 struct michael_mic_failure { 5447 int unicast; 5448 const u8 *src; 5449 } michael_mic_failure; 5450 5451 /** 5452 * struct interface_status - Data for EVENT_INTERFACE_STATUS 5453 */ 5454 struct interface_status { 5455 unsigned int ifindex; 5456 char ifname[100]; 5457 enum { 5458 EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED 5459 } ievent; 5460 } interface_status; 5461 5462 /** 5463 * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE 5464 */ 5465 struct pmkid_candidate { 5466 /** BSSID of the PMKID candidate */ 5467 u8 bssid[ETH_ALEN]; 5468 /** Smaller the index, higher the priority */ 5469 int index; 5470 /** Whether RSN IE includes pre-authenticate flag */ 5471 int preauth; 5472 } pmkid_candidate; 5473 5474 /** 5475 * struct tdls - Data for EVENT_TDLS 5476 */ 5477 struct tdls { 5478 u8 peer[ETH_ALEN]; 5479 enum { 5480 TDLS_REQUEST_SETUP, 5481 TDLS_REQUEST_TEARDOWN, 5482 TDLS_REQUEST_DISCOVER, 5483 } oper; 5484 u16 reason_code; /* for teardown */ 5485 } tdls; 5486 5487 /** 5488 * struct wnm - Data for EVENT_WNM 5489 */ 5490 struct wnm { 5491 u8 addr[ETH_ALEN]; 5492 enum { 5493 WNM_OPER_SLEEP, 5494 } oper; 5495 enum { 5496 WNM_SLEEP_ENTER, 5497 WNM_SLEEP_EXIT 5498 } sleep_action; 5499 int sleep_intval; 5500 u16 reason_code; 5501 u8 *buf; 5502 u16 buf_len; 5503 } wnm; 5504 5505 /** 5506 * struct ft_ies - FT information elements (EVENT_FT_RESPONSE) 5507 * 5508 * During FT (IEEE 802.11r) authentication sequence, the driver is 5509 * expected to use this event to report received FT IEs (MDIE, FTIE, 5510 * RSN IE, TIE, possible resource request) to the supplicant. The FT 5511 * IEs for the next message will be delivered through the 5512 * struct wpa_driver_ops::update_ft_ies() callback. 5513 */ 5514 struct ft_ies { 5515 const u8 *ies; 5516 size_t ies_len; 5517 int ft_action; 5518 u8 target_ap[ETH_ALEN]; 5519 /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */ 5520 const u8 *ric_ies; 5521 /** Length of ric_ies buffer in octets */ 5522 size_t ric_ies_len; 5523 } ft_ies; 5524 5525 /** 5526 * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START 5527 */ 5528 struct ibss_rsn_start { 5529 u8 peer[ETH_ALEN]; 5530 } ibss_rsn_start; 5531 5532 /** 5533 * struct auth_info - Data for EVENT_AUTH events 5534 */ 5535 struct auth_info { 5536 u8 peer[ETH_ALEN]; 5537 u8 bssid[ETH_ALEN]; 5538 u16 auth_type; 5539 u16 auth_transaction; 5540 u16 status_code; 5541 const u8 *ies; 5542 size_t ies_len; 5543 } auth; 5544 5545 /** 5546 * struct assoc_reject - Data for EVENT_ASSOC_REJECT events 5547 */ 5548 struct assoc_reject { 5549 /** 5550 * bssid - BSSID of the AP that rejected association 5551 */ 5552 const u8 *bssid; 5553 5554 /** 5555 * resp_ies - (Re)Association Response IEs 5556 * 5557 * Optional association data from the driver. This data is not 5558 * required WPA, but may be useful for some protocols and as 5559 * such, should be reported if this is available to the driver 5560 * interface. 5561 * 5562 * This should start with the first IE (fixed fields before IEs 5563 * are not included). 5564 */ 5565 const u8 *resp_ies; 5566 5567 /** 5568 * resp_ies_len - Length of resp_ies in bytes 5569 */ 5570 size_t resp_ies_len; 5571 5572 /** 5573 * status_code - Status Code from (Re)association Response 5574 */ 5575 u16 status_code; 5576 5577 /** 5578 * timed_out - Whether failure is due to timeout (etc.) rather 5579 * than explicit rejection response from the AP. 5580 */ 5581 int timed_out; 5582 5583 /** 5584 * timeout_reason - Reason for the timeout 5585 */ 5586 const char *timeout_reason; 5587 5588 /** 5589 * fils_erp_next_seq_num - The next sequence number to use in 5590 * FILS ERP messages 5591 */ 5592 u16 fils_erp_next_seq_num; 5593 5594 /** 5595 * reason_code - Connection failure reason code from the driver 5596 */ 5597 enum sta_connect_fail_reason_codes reason_code; 5598 } assoc_reject; 5599 5600 struct timeout_event { 5601 u8 addr[ETH_ALEN]; 5602 } timeout_event; 5603 5604 /** 5605 * struct tx_status - Data for EVENT_TX_STATUS events 5606 */ 5607 struct tx_status { 5608 u16 type; 5609 u16 stype; 5610 const u8 *dst; 5611 const u8 *data; 5612 size_t data_len; 5613 int ack; 5614 } tx_status; 5615 5616 /** 5617 * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events 5618 */ 5619 struct rx_from_unknown { 5620 const u8 *bssid; 5621 const u8 *addr; 5622 int wds; 5623 } rx_from_unknown; 5624 5625 /** 5626 * struct rx_mgmt - Data for EVENT_RX_MGMT events 5627 */ 5628 struct rx_mgmt { 5629 const u8 *frame; 5630 size_t frame_len; 5631 u32 datarate; 5632 5633 /** 5634 * drv_priv - Pointer to store driver private BSS information 5635 * 5636 * If not set to NULL, this is used for comparison with 5637 * hostapd_data->drv_priv to determine which BSS should process 5638 * the frame. 5639 */ 5640 void *drv_priv; 5641 5642 /** 5643 * freq - Frequency (in MHz) on which the frame was received 5644 */ 5645 int freq; 5646 5647 /** 5648 * ssi_signal - Signal strength in dBm (or 0 if not available) 5649 */ 5650 int ssi_signal; 5651 } rx_mgmt; 5652 5653 /** 5654 * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events 5655 * 5656 * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events. 5657 */ 5658 struct remain_on_channel { 5659 /** 5660 * freq - Channel frequency in MHz 5661 */ 5662 unsigned int freq; 5663 5664 /** 5665 * duration - Duration to remain on the channel in milliseconds 5666 */ 5667 unsigned int duration; 5668 } remain_on_channel; 5669 5670 /** 5671 * struct scan_info - Optional data for EVENT_SCAN_RESULTS events 5672 * @aborted: Whether the scan was aborted 5673 * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned) 5674 * @num_freqs: Number of entries in freqs array 5675 * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard 5676 * SSID) 5677 * @num_ssids: Number of entries in ssids array 5678 * @external_scan: Whether the scan info is for an external scan 5679 * @nl_scan_event: 1 if the source of this scan event is a normal scan, 5680 * 0 if the source of the scan event is a vendor scan 5681 * @scan_start_tsf: Time when the scan started in terms of TSF of the 5682 * BSS that the interface that requested the scan is connected to 5683 * (if available). 5684 * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf 5685 * is set. 5686 */ 5687 struct scan_info { 5688 int aborted; 5689 const int *freqs; 5690 size_t num_freqs; 5691 struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS]; 5692 size_t num_ssids; 5693 int external_scan; 5694 int nl_scan_event; 5695 u64 scan_start_tsf; 5696 u8 scan_start_tsf_bssid[ETH_ALEN]; 5697 } scan_info; 5698 5699 /** 5700 * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events 5701 */ 5702 struct rx_probe_req { 5703 /** 5704 * sa - Source address of the received Probe Request frame 5705 */ 5706 const u8 *sa; 5707 5708 /** 5709 * da - Destination address of the received Probe Request frame 5710 * or %NULL if not available 5711 */ 5712 const u8 *da; 5713 5714 /** 5715 * bssid - BSSID of the received Probe Request frame or %NULL 5716 * if not available 5717 */ 5718 const u8 *bssid; 5719 5720 /** 5721 * ie - IEs from the Probe Request body 5722 */ 5723 const u8 *ie; 5724 5725 /** 5726 * ie_len - Length of ie buffer in octets 5727 */ 5728 size_t ie_len; 5729 5730 /** 5731 * signal - signal strength in dBm (or 0 if not available) 5732 */ 5733 int ssi_signal; 5734 } rx_probe_req; 5735 5736 /** 5737 * struct new_sta - Data for EVENT_NEW_STA events 5738 */ 5739 struct new_sta { 5740 const u8 *addr; 5741 } new_sta; 5742 5743 /** 5744 * struct eapol_rx - Data for EVENT_EAPOL_RX events 5745 */ 5746 struct eapol_rx { 5747 const u8 *src; 5748 const u8 *data; 5749 size_t data_len; 5750 } eapol_rx; 5751 5752 /** 5753 * signal_change - Data for EVENT_SIGNAL_CHANGE events 5754 */ 5755 struct wpa_signal_info signal_change; 5756 5757 /** 5758 * struct best_channel - Data for EVENT_BEST_CHANNEL events 5759 * @freq_24: Best 2.4 GHz band channel frequency in MHz 5760 * @freq_5: Best 5 GHz band channel frequency in MHz 5761 * @freq_overall: Best channel frequency in MHz 5762 * 5763 * 0 can be used to indicate no preference in either band. 5764 */ 5765 struct best_channel { 5766 int freq_24; 5767 int freq_5; 5768 int freq_overall; 5769 } best_chan; 5770 5771 struct unprot_deauth { 5772 const u8 *sa; 5773 const u8 *da; 5774 u16 reason_code; 5775 } unprot_deauth; 5776 5777 struct unprot_disassoc { 5778 const u8 *sa; 5779 const u8 *da; 5780 u16 reason_code; 5781 } unprot_disassoc; 5782 5783 /** 5784 * struct low_ack - Data for EVENT_STATION_LOW_ACK events 5785 * @addr: station address 5786 * @num_packets: Number of packets lost (consecutive packets not 5787 * acknowledged) 5788 */ 5789 struct low_ack { 5790 u8 addr[ETH_ALEN]; 5791 u32 num_packets; 5792 } low_ack; 5793 5794 /** 5795 * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST 5796 */ 5797 struct ibss_peer_lost { 5798 u8 peer[ETH_ALEN]; 5799 } ibss_peer_lost; 5800 5801 /** 5802 * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY 5803 */ 5804 struct driver_gtk_rekey { 5805 const u8 *bssid; 5806 const u8 *replay_ctr; 5807 } driver_gtk_rekey; 5808 5809 /** 5810 * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events 5811 * @addr: station address 5812 */ 5813 struct client_poll { 5814 u8 addr[ETH_ALEN]; 5815 } client_poll; 5816 5817 /** 5818 * struct eapol_tx_status 5819 * @dst: Original destination 5820 * @data: Data starting with IEEE 802.1X header (!) 5821 * @data_len: Length of data 5822 * @ack: Indicates ack or lost frame 5823 * 5824 * This corresponds to hapd_send_eapol if the frame sent 5825 * there isn't just reported as EVENT_TX_STATUS. 5826 */ 5827 struct eapol_tx_status { 5828 const u8 *dst; 5829 const u8 *data; 5830 int data_len; 5831 int ack; 5832 } eapol_tx_status; 5833 5834 /** 5835 * struct ch_switch 5836 * @freq: Frequency of new channel in MHz 5837 * @ht_enabled: Whether this is an HT channel 5838 * @ch_offset: Secondary channel offset 5839 * @ch_width: Channel width 5840 * @cf1: Center frequency 1 5841 * @cf2: Center frequency 2 5842 */ 5843 struct ch_switch { 5844 int freq; 5845 int ht_enabled; 5846 int ch_offset; 5847 enum chan_width ch_width; 5848 int cf1; 5849 int cf2; 5850 } ch_switch; 5851 5852 /** 5853 * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON 5854 * @addr: Remote client address 5855 * @code: Reason code for connection failure 5856 */ 5857 struct connect_failed_reason { 5858 u8 addr[ETH_ALEN]; 5859 enum { 5860 MAX_CLIENT_REACHED, 5861 BLOCKED_CLIENT 5862 } code; 5863 } connect_failed_reason; 5864 5865 /** 5866 * struct dfs_event - Data for radar detected events 5867 * @freq: Frequency of the channel in MHz 5868 */ 5869 struct dfs_event { 5870 int freq; 5871 int ht_enabled; 5872 int chan_offset; 5873 enum chan_width chan_width; 5874 int cf1; 5875 int cf2; 5876 } dfs_event; 5877 5878 /** 5879 * survey_results - Survey result data for EVENT_SURVEY 5880 * @freq_filter: Requested frequency survey filter, 0 if request 5881 * was for all survey data 5882 * @survey_list: Linked list of survey data (struct freq_survey) 5883 */ 5884 struct survey_results { 5885 unsigned int freq_filter; 5886 struct dl_list survey_list; /* struct freq_survey */ 5887 } survey_results; 5888 5889 /** 5890 * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED 5891 * @initiator: Initiator of the regulatory change 5892 * @type: Regulatory change type 5893 * @alpha2: Country code (or "" if not available) 5894 */ 5895 struct channel_list_changed { 5896 enum reg_change_initiator initiator; 5897 enum reg_type type; 5898 char alpha2[3]; 5899 } channel_list_changed; 5900 5901 /** 5902 * freq_range - List of frequency ranges 5903 * 5904 * This is used as the data with EVENT_AVOID_FREQUENCIES. 5905 */ 5906 struct wpa_freq_range_list freq_range; 5907 5908 /** 5909 * struct mesh_peer 5910 * 5911 * @peer: Peer address 5912 * @ies: Beacon IEs 5913 * @ie_len: Length of @ies 5914 * 5915 * Notification of new candidate mesh peer. 5916 */ 5917 struct mesh_peer { 5918 const u8 *peer; 5919 const u8 *ies; 5920 size_t ie_len; 5921 } mesh_peer; 5922 5923 /** 5924 * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED 5925 * @pri_freq: Selected primary frequency 5926 * @sec_freq: Selected secondary frequency 5927 * @edmg_channel: Selected EDMG channel 5928 * @vht_seg0_center_ch: VHT mode Segment0 center channel 5929 * The value is the index of the channel center frequency for 5930 * 20 MHz, 40 MHz, and 80 MHz channels. The value is the center 5931 * frequency index of the primary 80 MHz segment for 160 MHz and 5932 * 80+80 MHz channels. 5933 * @vht_seg1_center_ch: VHT mode Segment1 center channel 5934 * The value is zero for 20 MHz, 40 MHz, and 80 MHz channels. The 5935 * value is the index of the channel center frequency for 160 MHz 5936 * channels and the center frequency index of the secondary 80 MHz 5937 * segment for 80+80 MHz channels. 5938 * @ch_width: Selected Channel width by driver. Driver may choose to 5939 * change hostapd configured ACS channel width due driver internal 5940 * channel restrictions. 5941 * hw_mode: Selected band (used with hw_mode=any) 5942 */ 5943 struct acs_selected_channels { 5944 unsigned int pri_freq; 5945 unsigned int sec_freq; 5946 u8 edmg_channel; 5947 u8 vht_seg0_center_ch; 5948 u8 vht_seg1_center_ch; 5949 u16 ch_width; 5950 enum hostapd_hw_mode hw_mode; 5951 } acs_selected_channels; 5952 5953 /** 5954 * struct p2p_lo_stop - Reason code for P2P Listen offload stop event 5955 * @reason_code: Reason for stopping offload 5956 * P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as 5957 * scheduled. 5958 * P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to 5959 * be stopped. 5960 * P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload 5961 * parameters. 5962 * P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not 5963 * supported by device. 5964 */ 5965 struct p2p_lo_stop { 5966 enum { 5967 P2P_LO_STOPPED_REASON_COMPLETE = 0, 5968 P2P_LO_STOPPED_REASON_RECV_STOP_CMD, 5969 P2P_LO_STOPPED_REASON_INVALID_PARAM, 5970 P2P_LO_STOPPED_REASON_NOT_SUPPORTED, 5971 } reason_code; 5972 } p2p_lo_stop; 5973 5974 /* For EVENT_EXTERNAL_AUTH */ 5975 struct external_auth external_auth; 5976 5977 /** 5978 * struct sta_opmode - Station's operation mode change event 5979 * @addr: The station MAC address 5980 * @smps_mode: SMPS mode of the station 5981 * @chan_width: Channel width of the station 5982 * @rx_nss: RX_NSS of the station 5983 * 5984 * This is used as data with EVENT_STATION_OPMODE_CHANGED. 5985 */ 5986 struct sta_opmode { 5987 const u8 *addr; 5988 enum smps_mode smps_mode; 5989 enum chan_width chan_width; 5990 u8 rx_nss; 5991 } sta_opmode; 5992 5993 /** 5994 * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS. 5995 */ 5996 struct wds_sta_interface { 5997 const u8 *sta_addr; 5998 const char *ifname; 5999 enum { 6000 INTERFACE_ADDED, 6001 INTERFACE_REMOVED 6002 } istatus; 6003 } wds_sta_interface; 6004 6005 /** 6006 * struct update_dh - Data for EVENT_UPDATE_DH 6007 */ 6008 struct update_dh { 6009 const u8 *peer; 6010 const u8 *ie; 6011 size_t ie_len; 6012 } update_dh; 6013 6014 /** 6015 * struct unprot_beacon - Data for EVENT_UNPROT_BEACON 6016 */ 6017 struct unprot_beacon { 6018 const u8 *sa; 6019 } unprot_beacon; 6020 }; 6021 6022 /** 6023 * wpa_supplicant_event - Report a driver event for wpa_supplicant 6024 * @ctx: Context pointer (wpa_s); this is the ctx variable registered 6025 * with struct wpa_driver_ops::init() 6026 * @event: event type (defined above) 6027 * @data: possible extra data for the event 6028 * 6029 * Driver wrapper code should call this function whenever an event is received 6030 * from the driver. 6031 */ 6032 void wpa_supplicant_event(void *ctx, enum wpa_event_type event, 6033 union wpa_event_data *data); 6034 6035 /** 6036 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant 6037 * @ctx: Context pointer (wpa_s); this is the ctx variable registered 6038 * with struct wpa_driver_ops::init() 6039 * @event: event type (defined above) 6040 * @data: possible extra data for the event 6041 * 6042 * Same as wpa_supplicant_event(), but we search for the interface in 6043 * wpa_global. 6044 */ 6045 void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event, 6046 union wpa_event_data *data); 6047 6048 /* 6049 * The following inline functions are provided for convenience to simplify 6050 * event indication for some of the common events. 6051 */ 6052 6053 static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *ie, 6054 size_t ielen, int reassoc) 6055 { 6056 union wpa_event_data event; 6057 os_memset(&event, 0, sizeof(event)); 6058 event.assoc_info.reassoc = reassoc; 6059 event.assoc_info.req_ies = ie; 6060 event.assoc_info.req_ies_len = ielen; 6061 event.assoc_info.addr = addr; 6062 wpa_supplicant_event(ctx, EVENT_ASSOC, &event); 6063 } 6064 6065 static inline void drv_event_disassoc(void *ctx, const u8 *addr) 6066 { 6067 union wpa_event_data event; 6068 os_memset(&event, 0, sizeof(event)); 6069 event.disassoc_info.addr = addr; 6070 wpa_supplicant_event(ctx, EVENT_DISASSOC, &event); 6071 } 6072 6073 static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data, 6074 size_t data_len) 6075 { 6076 union wpa_event_data event; 6077 os_memset(&event, 0, sizeof(event)); 6078 event.eapol_rx.src = src; 6079 event.eapol_rx.data = data; 6080 event.eapol_rx.data_len = data_len; 6081 wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event); 6082 } 6083 6084 /* driver_common.c */ 6085 void wpa_scan_results_free(struct wpa_scan_results *res); 6086 6087 /* Convert wpa_event_type to a string for logging */ 6088 const char * event_to_string(enum wpa_event_type event); 6089 6090 /* Convert chan_width to a string for logging and control interfaces */ 6091 const char * channel_width_to_string(enum chan_width width); 6092 6093 int channel_width_to_int(enum chan_width width); 6094 6095 int ht_supported(const struct hostapd_hw_modes *mode); 6096 int vht_supported(const struct hostapd_hw_modes *mode); 6097 6098 struct wowlan_triggers * 6099 wpa_get_wowlan_triggers(const char *wowlan_triggers, 6100 const struct wpa_driver_capa *capa); 6101 /* Convert driver flag to string */ 6102 const char * driver_flag_to_string(u64 flag); 6103 const char * driver_flag2_to_string(u64 flag2); 6104 6105 /* NULL terminated array of linked in driver wrappers */ 6106 extern const struct wpa_driver_ops *const wpa_drivers[]; 6107 6108 6109 /* Available drivers */ 6110 6111 #ifdef CONFIG_DRIVER_WEXT 6112 extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */ 6113 #endif /* CONFIG_DRIVER_WEXT */ 6114 #ifdef CONFIG_DRIVER_NL80211 6115 /* driver_nl80211.c */ 6116 extern const struct wpa_driver_ops wpa_driver_nl80211_ops; 6117 #endif /* CONFIG_DRIVER_NL80211 */ 6118 #ifdef CONFIG_DRIVER_HOSTAP 6119 extern const struct wpa_driver_ops wpa_driver_hostap_ops; /* driver_hostap.c */ 6120 #endif /* CONFIG_DRIVER_HOSTAP */ 6121 #ifdef CONFIG_DRIVER_BSD 6122 extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */ 6123 #endif /* CONFIG_DRIVER_BSD */ 6124 #ifdef CONFIG_DRIVER_OPENBSD 6125 /* driver_openbsd.c */ 6126 extern const struct wpa_driver_ops wpa_driver_openbsd_ops; 6127 #endif /* CONFIG_DRIVER_OPENBSD */ 6128 #ifdef CONFIG_DRIVER_NDIS 6129 extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */ 6130 #endif /* CONFIG_DRIVER_NDIS */ 6131 #ifdef CONFIG_DRIVER_WIRED 6132 extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */ 6133 #endif /* CONFIG_DRIVER_WIRED */ 6134 #ifdef CONFIG_DRIVER_MACSEC_QCA 6135 /* driver_macsec_qca.c */ 6136 extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops; 6137 #endif /* CONFIG_DRIVER_MACSEC_QCA */ 6138 #ifdef CONFIG_DRIVER_MACSEC_LINUX 6139 /* driver_macsec_linux.c */ 6140 extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops; 6141 #endif /* CONFIG_DRIVER_MACSEC_LINUX */ 6142 #ifdef CONFIG_DRIVER_ROBOSWITCH 6143 /* driver_roboswitch.c */ 6144 extern const struct wpa_driver_ops wpa_driver_roboswitch_ops; 6145 #endif /* CONFIG_DRIVER_ROBOSWITCH */ 6146 #ifdef CONFIG_DRIVER_ATHEROS 6147 /* driver_atheros.c */ 6148 extern const struct wpa_driver_ops wpa_driver_atheros_ops; 6149 #endif /* CONFIG_DRIVER_ATHEROS */ 6150 #ifdef CONFIG_DRIVER_NONE 6151 extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */ 6152 #endif /* CONFIG_DRIVER_NONE */ 6153 6154 #endif /* DRIVER_H */ 6155