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