/src/hostap/src/drivers/driver.h

Source
/*
 * Driver interface definition
 * Copyright (c) 2003-2017, Jouni Malinen <j@w1.fi>
 *
 * This software may be distributed under the terms of the BSD license.
 * See README for more details.
 *
 * This file defines a driver interface used by both %wpa_supplicant and
 * hostapd. The first part of the file defines data structures used in various
 * driver operations. This is followed by the struct wpa_driver_ops that each
 * driver wrapper will beed to define with callback functions for requesting
 * driver operations. After this, there are definitions for driver event
 * reporting with wpa_supplicant_event() and some convenience helper functions
 * that can be used to report events.
 */

#ifndef DRIVER_H
#define DRIVER_H

#define WPA_SUPPLICANT_DRIVER_VERSION 4

#include "common/defs.h"
#include "common/ieee802_11_defs.h"
#include "common/wpa_common.h"
#include "common/nan_defs.h"
#ifdef CONFIG_MACSEC
#include "pae/ieee802_1x_kay.h"
#endif /* CONFIG_MACSEC */
#include "utils/list.h"

struct nan_subscribe_params;
struct nan_publish_params;

#define HOSTAPD_CHAN_DISABLED 0x00000001
#define HOSTAPD_CHAN_NO_IR 0x00000002
#define HOSTAPD_CHAN_RADAR 0x00000008
#define HOSTAPD_CHAN_HT40PLUS 0x00000010
#define HOSTAPD_CHAN_HT40MINUS 0x00000020
#define HOSTAPD_CHAN_HT40 0x00000040
#define HOSTAPD_CHAN_SURVEY_LIST_INITIALIZED 0x00000080

#define HOSTAPD_CHAN_DFS_UNKNOWN 0x00000000
#define HOSTAPD_CHAN_DFS_USABLE 0x00000100
#define HOSTAPD_CHAN_DFS_UNAVAILABLE 0x00000200
#define HOSTAPD_CHAN_DFS_AVAILABLE 0x00000300
#define HOSTAPD_CHAN_DFS_MASK 0x00000300

#define HOSTAPD_CHAN_VHT_80MHZ_SUBCHANNEL 0x00000800
#define HOSTAPD_CHAN_VHT_160MHZ_SUBCHANNEL 0x00001000
#define HOSTAPD_CHAN_EHT_320MHZ_SUBCHANNEL 0x00002000

#define HOSTAPD_CHAN_INDOOR_ONLY 0x00010000
#define HOSTAPD_CHAN_GO_CONCURRENT 0x00020000
#define HOSTAPD_CHAN_AUTO_BW 0x00040000

/* Allowed bandwidth mask */
enum hostapd_chan_width_attr {
  HOSTAPD_CHAN_WIDTH_10   = BIT(0),
  HOSTAPD_CHAN_WIDTH_20   = BIT(1),
  HOSTAPD_CHAN_WIDTH_40P  = BIT(2),
  HOSTAPD_CHAN_WIDTH_40M  = BIT(3),
  HOSTAPD_CHAN_WIDTH_80   = BIT(4),
  HOSTAPD_CHAN_WIDTH_160  = BIT(5),
  HOSTAPD_CHAN_WIDTH_320  = BIT(6),
};

/* Filter gratuitous ARP */
#define WPA_DATA_FRAME_FILTER_FLAG_ARP BIT(0)
/* Filter unsolicited Neighbor Advertisement */
#define WPA_DATA_FRAME_FILTER_FLAG_NA BIT(1)
/* Filter unicast IP packets encrypted using the GTK */
#define WPA_DATA_FRAME_FILTER_FLAG_GTK BIT(2)

#define HOSTAPD_DFS_REGION_FCC  1
#define HOSTAPD_DFS_REGION_ETSI 2
#define HOSTAPD_DFS_REGION_JP 3

/**
 * enum reg_change_initiator - Regulatory change initiator
 */
enum reg_change_initiator {
  REGDOM_SET_BY_CORE,
  REGDOM_SET_BY_USER,
  REGDOM_SET_BY_DRIVER,
  REGDOM_SET_BY_COUNTRY_IE,
  REGDOM_BEACON_HINT,
};

/**
 * enum reg_type - Regulatory change types
 */
enum reg_type {
  REGDOM_TYPE_UNKNOWN,
  REGDOM_TYPE_COUNTRY,
  REGDOM_TYPE_WORLD,
  REGDOM_TYPE_CUSTOM_WORLD,
  REGDOM_TYPE_INTERSECTION,
};

/**
 * struct hostapd_wmm_rule - WMM regulatory rule
 * @min_cwmin: Lower bound of CW_min value
 * @min_cwmax: Lower bound of CW_max value
 * @min_aifs: Lower bound of AIFS value
 * @max_txop: Upper bound of TXOP, value in units of 32 usec
 */
struct hostapd_wmm_rule {
  int min_cwmin;
  int min_cwmax;
  int min_aifs;
  int max_txop;
};

/**
 * struct hostapd_channel_data - Channel information
 */
struct hostapd_channel_data {
  /**
   * chan - Channel number (IEEE 802.11)
   */
  short chan;

  /**
   * freq - Frequency in MHz
   */
  int freq;

  /**
   * flag - Channel flags (HOSTAPD_CHAN_*)
   */
  int flag;

  /**
   * allowed_bw - Allowed channel width bitmask
   *
   * See enum hostapd_chan_width_attr.
   */
  u32 allowed_bw;

  /**
   * max_tx_power - Regulatory transmit power limit in dBm
   */
  u8 max_tx_power;

  /**
   * survey_list - Linked list of surveys (struct freq_survey)
   */
  struct dl_list survey_list;

  /**
   * min_nf - Minimum observed noise floor, in dBm, based on all
   * surveyed channel data
   */
  s8 min_nf;

#ifdef CONFIG_ACS
  /**
   * interference_factor - Computed interference factor on this
   * channel (used internally in src/ap/acs.c; driver wrappers do not
   * need to set this)
   */
  long double interference_factor;

  /**
   * interference_bss_based - Indicates whether the interference was
   * calculated from number of BSSs
   */
  bool interference_bss_based;
#endif /* CONFIG_ACS */

  /**
   * dfs_cac_ms - DFS CAC time in milliseconds
   */
  unsigned int dfs_cac_ms;

  /**
   * wmm_rules_valid - Indicates wmm_rules state
   */
  int wmm_rules_valid;

  /**
   * wmm_rules - WMM regulatory rules
   */
  struct hostapd_wmm_rule wmm_rules[WMM_AC_NUM];

  /**
   * punct_bitmap - RU puncturing bitmap
   */
  u16 punct_bitmap;
};

#define HE_MAC_CAPAB_0    0
#define HE_MAX_MAC_CAPAB_SIZE 6
#define HE_MAX_PHY_CAPAB_SIZE 11
#define HE_MAX_MCS_CAPAB_SIZE 12
#define HE_MAX_PPET_CAPAB_SIZE  25

/**
 * struct he_capabilities - IEEE 802.11ax HE capabilities
 */
struct he_capabilities {
  u8 he_supported;
  u8 phy_cap[HE_MAX_PHY_CAPAB_SIZE];
  u8 mac_cap[HE_MAX_MAC_CAPAB_SIZE];
  u8 mcs[HE_MAX_MCS_CAPAB_SIZE];
  u8 ppet[HE_MAX_PPET_CAPAB_SIZE];
  u16 he_6ghz_capa;
};

/* struct eht_capabilities - IEEE 802.11be EHT capabilities */
struct eht_capabilities {
  bool eht_supported;
  u16 mac_cap;
  u8 phy_cap[EHT_PHY_CAPAB_LEN];
  u8 mcs[EHT_MCS_NSS_CAPAB_LEN];
  u8 ppet[EHT_PPE_THRESH_CAPAB_LEN];
};

#define HOSTAPD_MODE_FLAG_HT_INFO_KNOWN BIT(0)
#define HOSTAPD_MODE_FLAG_VHT_INFO_KNOWN BIT(1)
#define HOSTAPD_MODE_FLAG_HE_INFO_KNOWN BIT(2)
#define HOSTAPD_MODE_FLAG_EHT_INFO_KNOWN BIT(3)


enum ieee80211_op_mode {
  IEEE80211_MODE_INFRA = 0,
  IEEE80211_MODE_IBSS = 1,
  IEEE80211_MODE_AP = 2,
  IEEE80211_MODE_MESH = 5,

  /* only add new entries before IEEE80211_MODE_NUM */
  IEEE80211_MODE_NUM
};

/**
 * struct ieee80211_edmg_config - EDMG configuration
 *
 * This structure describes most essential parameters needed
 * for IEEE 802.11ay EDMG configuration
 *
 * @channels: Bitmap that indicates the 2.16 GHz channel(s)
 *  that are allowed to be used for transmissions.
 *  Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
 *  Set to 0 to indicate EDMG not supported.
 * @bw_config: Channel BW Configuration subfield encodes
 *  the allowed channel bandwidth configurations
 */
struct ieee80211_edmg_config {
  u8 channels;
  enum edmg_bw_config bw_config;
};

/**
 * struct hostapd_hw_modes - Supported hardware mode information
 */
struct hostapd_hw_modes {
  /**
   * mode - Hardware mode
   */
  enum hostapd_hw_mode mode;

  /**
   * is_6ghz - Whether the mode information is for the 6 GHz band
   */
  bool is_6ghz;

  /**
   * num_channels - Number of entries in the channels array
   */
  int num_channels;

  /**
   * channels - Array of supported channels
   */
  struct hostapd_channel_data *channels;

  /**
   * num_rates - Number of entries in the rates array
   */
  int num_rates;

  /**
   * rates - Array of supported rates in 100 kbps units
   */
  int *rates;

  /**
   * ht_capab - HT (IEEE 802.11n) capabilities
   */
  u16 ht_capab;

  /**
   * mcs_set - MCS (IEEE 802.11n) rate parameters
   */
  u8 mcs_set[16];

  /**
   * a_mpdu_params - A-MPDU (IEEE 802.11n) parameters
   */
  u8 a_mpdu_params;

  /**
   * vht_capab - VHT (IEEE 802.11ac) capabilities
   */
  u32 vht_capab;

  /**
   * vht_mcs_set - VHT MCS (IEEE 802.11ac) rate parameters
   */
  u8 vht_mcs_set[8];

  unsigned int flags; /* HOSTAPD_MODE_FLAG_* */

  /**
   * he_capab - HE (IEEE 802.11ax) capabilities
   */
  struct he_capabilities he_capab[IEEE80211_MODE_NUM];

  /**
   * This structure describes the most essential parameters needed
   * for IEEE 802.11ay EDMG configuration.
   */
  struct ieee80211_edmg_config edmg;

  /**
   * eht_capab - EHT (IEEE 802.11be) capabilities
   */
  struct eht_capabilities eht_capab[IEEE80211_MODE_NUM];
};


/**
 * struct hostapd_multi_hw_info: Supported multiple underlying hardware info
 */
struct hostapd_multi_hw_info {
  /**
   * hw_idx - Hardware index
   */
  u8 hw_idx;

  /**
   * start_freq - Frequency range start in MHz
   */
  int start_freq;

  /**
   * end_freq - Frequency range end in MHz
   */
  int end_freq;
};


#define IEEE80211_CAP_ESS 0x0001
#define IEEE80211_CAP_IBSS  0x0002
#define IEEE80211_CAP_PRIVACY 0x0010
#define IEEE80211_CAP_RRM 0x1000

/* DMG (60 GHz) IEEE 802.11ad */
/* type - bits 0..1 */
#define IEEE80211_CAP_DMG_MASK  0x0003
#define IEEE80211_CAP_DMG_IBSS  0x0001 /* Tx by: STA */
#define IEEE80211_CAP_DMG_PBSS  0x0002 /* Tx by: PCP */
#define IEEE80211_CAP_DMG_AP  0x0003 /* Tx by: AP */

#define WPA_SCAN_QUAL_INVALID   BIT(0)
#define WPA_SCAN_NOISE_INVALID    BIT(1)
#define WPA_SCAN_LEVEL_INVALID    BIT(2)
#define WPA_SCAN_LEVEL_DBM    BIT(3)
#define WPA_SCAN_ASSOCIATED   BIT(5)

/**
 * struct wpa_scan_res - Scan result for an BSS/IBSS
 * @flags: information flags about the BSS/IBSS (WPA_SCAN_*)
 * @bssid: BSSID
 * @freq: frequency of the channel in MHz (e.g., 2412 = channel 1)
 * @max_cw: the max channel width of the connection (calculated during scan
 * result processing)
 * @beacon_int: beacon interval in TUs (host byte order)
 * @caps: capability information field in host byte order
 * @qual: signal quality
 * @noise: noise level
 * @level: signal level
 * @tsf: Timestamp
 * @age: Age of the information in milliseconds (i.e., how many milliseconds
 * ago the last Beacon or Probe Response frame was received)
 * @est_throughput: Estimated throughput in kbps (this is calculated during
 * scan result processing if left zero by the driver wrapper)
 * @snr: Signal-to-noise ratio in dB (calculated during scan result processing)
 * @parent_tsf: Time when the Beacon/Probe Response frame was received in terms
 * of TSF of the BSS specified by %tsf_bssid.
 * @tsf_bssid: The BSS that %parent_tsf TSF time refers to.
 * @beacon_newer: Whether the Beacon frame data is known to be newer
 * @mlo_tput_accumulated: Whether the scan result throughput is accumulated
 * (used during scan result processing)
 * @ie_len: length of the following IE field in octets
 * @beacon_ie_len: length of the following Beacon IE field in octets
 *
 * This structure is used as a generic format for scan results from the
 * driver. Each driver interface implementation is responsible for converting
 * the driver or OS specific scan results into this format.
 *
 * If the driver does not support reporting all IEs, the IE data structure is
 * constructed of the IEs that are available. This field will also need to
 * include SSID in IE format. All drivers are encouraged to be extended to
 * report all IEs to make it easier to support future additions.
 *
 * This structure data is followed by ie_len octets of IEs from Probe Response
 * frame (or if the driver does not indicate source of IEs, these may also be
 * from Beacon frame). After the first set of IEs, another set of IEs may follow
 * (with beacon_ie_len octets of data) if the driver provides both IE sets.
 */
struct wpa_scan_res {
  unsigned int flags;
  u8 bssid[ETH_ALEN];
  int freq;
  enum chan_width max_cw;
  u16 beacon_int;
  u16 caps;
  int qual;
  int noise;
  int level;
  u64 tsf;
  unsigned int age;
  unsigned int est_throughput;
  int snr;
  u64 parent_tsf;
  u8 tsf_bssid[ETH_ALEN];
  bool beacon_newer;
  bool mlo_tput_accumulated;
  size_t ie_len;
  size_t beacon_ie_len;
  /* Followed by ie_len + beacon_ie_len octets of IE data */
};

/**
 * struct wpa_scan_results - Scan results
 * @res: Array of pointers to allocated variable length scan result entries
 * @num: Number of entries in the scan result array
 * @fetch_time: Time when the results were fetched from the driver
 */
struct wpa_scan_results {
  struct wpa_scan_res **res;
  size_t num;
  struct os_reltime fetch_time;
};

/**
 * struct wpa_interface_info - Network interface information
 * @next: Pointer to the next interface or NULL if this is the last one
 * @ifname: Interface name that can be used with init() or init2()
 * @desc: Human readable adapter description (e.g., vendor/model) or NULL if
 *  not available
 * @drv_name: struct wpa_driver_ops::name (note: unlike other strings, this one
 *  is not an allocated copy, i.e., get_interfaces() caller will not free
 *  this)
 */
struct wpa_interface_info {
  struct wpa_interface_info *next;
  char *ifname;
  char *desc;
  const char *drv_name;
};

#define WPAS_MAX_SCAN_SSIDS 16

/**
 * struct wpa_driver_scan_ssid - SSIDs to scan for
 * @ssid - specific SSID to scan for (ProbeReq)
 *  %NULL or zero-length SSID is used to indicate active scan
 *  with wildcard SSID.
 * @ssid_len - Length of the SSID in octets
 */
struct wpa_driver_scan_ssid {
  const u8 *ssid;
  size_t ssid_len;
};

struct t2lm_mapping {
  /**
   * downlink - Bitmap of TIDs mapped with a link in downlink direction
   */
  u8 downlink;

  /**
   * uplink - Bitmap of TIDs mapped with a link in uplink direction
   */
  u8 uplink;
};

/**
 * struct wpa_driver_scan_params - Scan parameters
 * Data for struct wpa_driver_ops::scan2().
 */
struct wpa_driver_scan_params {
  /**
   * ssids - SSIDs to scan for
   */
  struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];

  /**
   * num_ssids - Number of entries in ssids array
   * Zero indicates a request for a passive scan.
   */
  size_t num_ssids;

  /**
   * extra_ies - Extra IE(s) to add into Probe Request or %NULL
   */
  const u8 *extra_ies;

  /**
   * extra_ies_len - Length of extra_ies in octets
   */
  size_t extra_ies_len;

  /**
   * freqs - Array of frequencies to scan or %NULL for all frequencies
   *
   * The frequency is set in MHz. The array is zero-terminated.
   */
  int *freqs;

  /**
   * filter_ssids - Filter for reporting SSIDs
   *
   * This optional parameter can be used to request the driver wrapper to
   * filter scan results to include only the specified SSIDs. %NULL
   * indicates that no filtering is to be done. This can be used to
   * reduce memory needs for scan results in environments that have large
   * number of APs with different SSIDs.
   *
   * The driver wrapper is allowed to take this allocated buffer into its
   * own use by setting the pointer to %NULL. In that case, the driver
   * wrapper is responsible for freeing the buffer with os_free() once it
   * is not needed anymore.
   */
  struct wpa_driver_scan_filter {
    u8 ssid[SSID_MAX_LEN];
    size_t ssid_len;
  } *filter_ssids;

  /**
   * num_filter_ssids - Number of entries in filter_ssids array
   */
  size_t num_filter_ssids;

  /**
   * filter_rssi - Filter by RSSI
   *
   * The driver may filter scan results in firmware to reduce host
   * wakeups and thereby save power. Specify the RSSI threshold in s32
   * dBm.
   */
  s32 filter_rssi;

  /**
   * p2p_probe - Used to disable CCK (802.11b) rates for P2P probes
   *
   * When set, the driver is expected to remove rates 1, 2, 5.5, and 11
   * Mbps from the support rates element(s) in the Probe Request frames
   * and not to transmit the frames at any of those rates.
   */
  unsigned int p2p_probe:1;

  /**
   * only_new_results - Request driver to report only new results
   *
   * This is used to request the driver to report only BSSes that have
   * been detected after this scan request has been started, i.e., to
   * flush old cached BSS entries.
   */
  unsigned int only_new_results:1;

  /**
   * low_priority - Requests driver to use a lower scan priority
   *
   * This is used to request the driver to use a lower scan priority
   * if it supports such a thing.
   */
  unsigned int low_priority:1;

  /**
   * mac_addr_rand - Requests driver to randomize MAC address
   */
  unsigned int mac_addr_rand:1;

  /**
   * mac_addr - MAC address used with randomization. The address cannot be
   * a multicast one, i.e., bit 0 of byte 0 should not be set.
   */
  u8 *mac_addr;

  /**
   * mac_addr_mask - MAC address mask used with randomization.
   *
   * Bits that are 0 in the mask should be randomized. Bits that are 1 in
   * the mask should be taken as is from mac_addr. The mask should not
   * allow the generation of a multicast address, i.e., bit 0 of byte 0
   * must be set.
   */
  const u8 *mac_addr_mask;

  /**
   * sched_scan_plans - Scan plans for scheduled scan
   *
   * Each scan plan consists of the number of iterations to scan and the
   * interval between scans. When a scan plan finishes (i.e., it was run
   * for the specified number of iterations), the next scan plan is
   * executed. The scan plans are executed in the order they appear in
   * the array (lower index first). The last scan plan will run infinitely
   * (until requested to stop), thus must not specify the number of
   * iterations. All other scan plans must specify the number of
   * iterations.
   */
  struct sched_scan_plan {
     u32 interval; /* In seconds */
     u32 iterations; /* Zero to run infinitely */
   } *sched_scan_plans;

  /**
   * sched_scan_plans_num - Number of scan plans in sched_scan_plans array
   */
   unsigned int sched_scan_plans_num;

  /**
   * sched_scan_start_delay - Delay to use before starting the first scan
   *
   * Delay (in seconds) before scheduling first scan plan cycle. The
   * driver may ignore this parameter and start immediately (or at any
   * other time), if this feature is not supported.
   */
   u32 sched_scan_start_delay;

  /**
   * bssid - Specific BSSID to scan for
   *
   * This optional parameter can be used to replace the default wildcard
   * BSSID with a specific BSSID to scan for if results are needed from
   * only a single BSS.
   */
  const u8 *bssid;

  /**
   * scan_cookie - Unique identification representing the scan request
   *
   * This scan_cookie carries a unique identification representing the
   * scan request if the host driver/kernel supports concurrent scan
   * requests. This cookie is returned from the corresponding driver
   * interface.
   *
   * Note: Unlike other parameters in this structure, scan_cookie is used
   * only to return information instead of setting parameters for the
   * scan.
   */
  u64 scan_cookie;

   /**
    * duration - Dwell time on each channel
    *
    * This optional parameter can be used to set the dwell time on each
    * channel. In TUs.
    */
   u16 duration;

   /**
    * duration_mandatory - Whether the specified duration is mandatory
    *
    * If this is set, the duration specified by the %duration field is
    * mandatory (and the driver should reject the scan request if it is
    * unable to comply with the specified duration), otherwise it is the
    * maximum duration and the actual duration may be shorter.
    */
   unsigned int duration_mandatory:1;

  /**
   * relative_rssi_set - Whether relative RSSI parameters are set
   */
  unsigned int relative_rssi_set:1;

  /**
   * relative_rssi - Relative RSSI for reporting better BSSs
   *
   * Amount of RSSI by which a BSS should be better than the current
   * connected BSS to report the new BSS to user space.
   */
  s8 relative_rssi;

  /**
   * relative_adjust_band - Band to which RSSI should be adjusted
   *
   * The relative_adjust_rssi should be added to the band specified
   * by relative_adjust_band.
   */
  enum set_band relative_adjust_band;

  /**
   * relative_adjust_rssi - RSSI to be added to relative_adjust_band
   *
   * An amount of relative_band_rssi should be added to the BSSs that
   * belong to the band specified by relative_adjust_band while comparing
   * with other bands for BSS reporting.
   */
  s8 relative_adjust_rssi;

  /**
   * oce_scan
   *
   * Enable the following OCE scan features: (WFA OCE TechSpec v1.0)
   * - Accept broadcast Probe Response frame.
   * - Probe Request frame deferral and suppression.
   * - Max Channel Time - driver fills FILS request params IE with
   *   Maximum Channel Time.
   * - Send 1st Probe Request frame in rate of minimum 5.5 Mbps.
   */
  unsigned int oce_scan:1;

  /**
   * p2p_include_6ghz - Include 6 GHz channels for P2P full scan
   *
   */
  unsigned int p2p_include_6ghz:1;

  /**
   * non_coloc_6ghz - Force scanning of non-PSC 6 GHz channels
   *
   * If this is set, the driver should scan non-PSC channels from the
   * scan request even if neighbor reports from 2.4/5 GHz APs did not
   * report a co-located AP on these channels. The default is to scan
   * non-PSC channels only if a co-located AP was reported on the channel.
   */
  unsigned int non_coloc_6ghz:1;

  /**
   * min_probe_req_content - Minimize probe request content to only have
   * minimal requirement elements, e.g., supported rates etc., and no
   * additional elements other then those provided by user space.
   */
  unsigned int min_probe_req_content:1;

  /**
   * link_id - Specify the link that is requesting the scan on an MLD
   *
   * This is set when operating as an AP MLD and doing an OBSS scan.
   * -1 indicates that no particular link ID is set.
   */
  s8 link_id;

  /*
   * NOTE: Whenever adding new parameters here, please make sure
   * wpa_scan_clone_params() and wpa_scan_free_params() get updated with
   * matching changes.
   */
};

/**
 * struct wpa_driver_auth_params - Authentication parameters
 * Data for struct wpa_driver_ops::authenticate().
 */
struct wpa_driver_auth_params {
  int freq;
  const u8 *bssid;
  const u8 *ssid;
  size_t ssid_len;
  int auth_alg;
  const u8 *ie;
  size_t ie_len;
  const u8 *wep_key[4];
  size_t wep_key_len[4];
  int wep_tx_keyidx;
  int local_state_change;

  /**
   * p2p - Whether this connection is a P2P group
   */
  int p2p;

  /**
   * auth_data - Additional elements for Authentication frame
   *
   * This buffer starts with the Authentication transaction sequence
   * number field. If no special handling of such elements is needed, this
   * pointer is %NULL. This is used with SAE and FILS.
   */
  const u8 *auth_data;

  /**
   * auth_data_len - Length of auth_data buffer in octets
   */
  size_t auth_data_len;

  /**
   * mld - Establish an MLD connection
   */
  bool mld;

  /**
   * mld_link_id - The link ID of the MLD AP to which we are associating
   */
  u8 mld_link_id;

  /**
   * The MLD AP address
   */
  const u8 *ap_mld_addr;
};

/**
 * enum wps_mode - WPS mode
 */
enum wps_mode {
  /**
   * WPS_MODE_NONE - No WPS provisioning being used
   */
  WPS_MODE_NONE,

  /**
   * WPS_MODE_OPEN - WPS provisioning with AP that is in open mode
   */
  WPS_MODE_OPEN,

  /**
   * WPS_MODE_PRIVACY - WPS provisioning with AP that is using protection
   */
  WPS_MODE_PRIVACY
};

/**
 * struct hostapd_freq_params - Channel parameters
 */
struct hostapd_freq_params {
  /**
   * mode - Mode/band (HOSTAPD_MODE_IEEE80211A, ..)
   */
  enum hostapd_hw_mode mode;

  /**
   * freq - Primary channel center frequency in MHz
   */
  int freq;

  /**
   * channel - Channel number
   */
  int channel;

  /**
   * ht_enabled - Whether HT is enabled
   */
  int ht_enabled;

  /**
   * sec_channel_offset - Secondary channel offset for HT40
   *
   * 0 = HT40 disabled,
   * -1 = HT40 enabled, secondary channel below primary,
   * 1 = HT40 enabled, secondary channel above primary
   */
  int sec_channel_offset;

  /**
   * vht_enabled - Whether VHT is enabled
   */
  int vht_enabled;

  /**
   * he_enabled - Whether HE is enabled
   */
  int he_enabled;

  /**
   * center_freq1 - Segment 0 center frequency in MHz
   *
   * Valid for both HT and VHT.
   */
  int center_freq1;

  /**
   * center_freq2 - Segment 1 center frequency in MHz
   *
   * Non-zero only for bandwidth 80 and an 80+80 channel
   */
  int center_freq2;

  /**
   * bandwidth - Channel bandwidth in MHz (20, 40, 80, 160)
   */
  int bandwidth;

  /**
   * This structure describes the most essential parameters needed
   * for IEEE 802.11ay EDMG configuration.
   */
  struct ieee80211_edmg_config edmg;

  /**
   * radar_background - Whether radar/CAC background is requested
   */
  bool radar_background;

  /**
   * eht_enabled - Whether EHT is enabled
   */
  bool eht_enabled;

  /**
   * punct_bitmap - Preamble puncturing bitmap
   * Each bit corresponds to a 20 MHz subchannel, the lowest bit for the
   * channel with the lowest frequency. A bit set to 1 indicates that the
   * subchannel is punctured, otherwise active.
   */
  u16 punct_bitmap;

  /**
   * link_id: If >=0 indicates the link of the AP MLD to configure
   */
  int link_id;
};

/**
 * struct wpa_driver_sta_auth_params - Authentication parameters
 * Data for struct wpa_driver_ops::sta_auth().
 */
struct wpa_driver_sta_auth_params {

  /**
   * own_addr - Source address and BSSID for authentication frame
   */
  const u8 *own_addr;

  /**
   * addr - MAC address of the station to associate
   */
  const u8 *addr;

  /**
   * seq - authentication sequence number
   */
  u16 seq;

  /**
   * status - authentication response status code
   */
  u16 status;

  /**
   * ie - authentication frame ie buffer
   */
  const u8 *ie;

  /**
   * len - ie buffer length
   */
  size_t len;

  /**
   * fils_auth - Indicates whether FILS authentication is being performed
   */
  int fils_auth;

  /**
   * fils_anonce - ANonce (required for FILS)
   */
  u8 fils_anonce[WPA_NONCE_LEN];

  /**
   * fils_snonce - SNonce (required for FILS)
  */
  u8 fils_snonce[WPA_NONCE_LEN];

  /**
   * fils_kek - key for encryption (required for FILS)
   */
  u8 fils_kek[WPA_KEK_MAX_LEN];

  /**
   * fils_kek_len - Length of the fils_kek in octets (required for FILS)
   */
  size_t fils_kek_len;
};

struct wpa_driver_mld_params {
  /**
   * mld_addr - AP's MLD address
   */
  const u8 *mld_addr;

  /**
   * valid_links - The valid links including the association link
   */
  u16 valid_links;

  /**
   * assoc_link_id - The link on which the association is performed
   */
  u8 assoc_link_id;

  /**
   * mld_links - Link information
   *
   * Should include information on all the requested links for association
   * including the link on which the association should take place.
   * For the association link, the ies and ies_len should be NULL and
   * 0 respectively.
   */
  struct {
    int freq;
    const u8 *bssid;
    const u8 *ies;
    size_t ies_len;
    int error;
    bool disabled;
  } mld_links[MAX_NUM_MLD_LINKS];
};

/**
 * struct wpa_driver_associate_params - Association parameters
 * Data for struct wpa_driver_ops::associate().
 */
struct wpa_driver_associate_params {
  /**
   * bssid - BSSID of the selected AP
   * This can be %NULL, if ap_scan=2 mode is used and the driver is
   * responsible for selecting with which BSS to associate. */
  const u8 *bssid;

  /**
   * bssid_hint - BSSID of a proposed AP
   *
   * This indicates which BSS has been found a suitable candidate for
   * initial association for drivers that use driver/firmwate-based BSS
   * selection. Unlike the @bssid parameter, @bssid_hint does not limit
   * the driver from selecting other BSSes in the ESS.
   */
  const u8 *bssid_hint;

  /**
   * ssid - The selected SSID
   */
  const u8 *ssid;

  /**
   * ssid_len - Length of the SSID (1..32)
   */
  size_t ssid_len;

  /**
   * freq - channel parameters
   */
  struct hostapd_freq_params freq;

  /**
   * freq_hint - Frequency of the channel the proposed AP is using
   *
   * This provides a channel on which a suitable BSS has been found as a
   * hint for the driver. Unlike the @freq parameter, @freq_hint does not
   * limit the driver from selecting other channels for
   * driver/firmware-based BSS selection.
   */
  int freq_hint;

  /**
   * bg_scan_period - Background scan period in seconds, 0 to disable
   * background scan, or -1 to indicate no change to default driver
   * configuration
   */
  int bg_scan_period;

  /**
   * beacon_int - Beacon interval for IBSS or 0 to use driver default
   */
  int beacon_int;

  /**
   * wpa_ie - WPA information element for (Re)Association Request
   * WPA information element to be included in (Re)Association
   * Request (including information element id and length). Use
   * of this WPA IE is optional. If the driver generates the WPA
   * IE, it can use pairwise_suite, group_suite, group_mgmt_suite, and
   * key_mgmt_suite to select proper algorithms. In this case,
   * the driver has to notify wpa_supplicant about the used WPA
   * IE by generating an event that the interface code will
   * convert into EVENT_ASSOCINFO data (see below).
   *
   * When using WPA2/IEEE 802.11i, wpa_ie is used for RSN IE
   * instead. The driver can determine which version is used by
   * looking at the first byte of the IE (0xdd for WPA, 0x30 for
   * WPA2/RSN).
   *
   * When using WPS, wpa_ie is used for WPS IE instead of WPA/RSN IE.
   */
  const u8 *wpa_ie;

  /**
   * wpa_ie_len - length of the wpa_ie
   */
  size_t wpa_ie_len;

  /**
   * wpa_proto - Bitfield of WPA_PROTO_* values to indicate WPA/WPA2
   */
  unsigned int wpa_proto;

  /**
   * pairwise_suite - Selected pairwise cipher suite (WPA_CIPHER_*)
   *
   * This is usually ignored if @wpa_ie is used.
   */
  unsigned int pairwise_suite;

  /**
   * group_suite - Selected group cipher suite (WPA_CIPHER_*)
   *
   * This is usually ignored if @wpa_ie is used.
   */
  unsigned int group_suite;

  /**
   * mgmt_group_suite - Selected group management cipher suite (WPA_CIPHER_*)
   *
   * This is usually ignored if @wpa_ie is used.
   */
  unsigned int mgmt_group_suite;

  /**
   * key_mgmt_suite - Selected key management suite (WPA_KEY_MGMT_*)
   *
   * This is usually ignored if @wpa_ie is used.
   */
  unsigned int key_mgmt_suite;

  /**
   * allowed_key_mgmts - Bitfield of allowed key management suites
   * (WPA_KEY_MGMT_*) other than @key_mgmt_suite for the current
   * connection
   *
   * SME in the driver may choose key_mgmt from this list for the initial
   * connection or roaming. The driver which doesn't support this
   * ignores this parameter.
   */
  unsigned int allowed_key_mgmts;

  /**
   * auth_alg - Allowed authentication algorithms
   * Bit field of WPA_AUTH_ALG_*
   */
  int auth_alg;

  /**
   * mode - Operation mode (infra/ibss) IEEE80211_MODE_*
   */
  int mode;

  /**
   * wep_key - WEP keys for static WEP configuration
   */
  const u8 *wep_key[4];

  /**
   * wep_key_len - WEP key length for static WEP configuration
   */
  size_t wep_key_len[4];

  /**
   * wep_tx_keyidx - WEP TX key index for static WEP configuration
   */
  int wep_tx_keyidx;

  /**
   * mgmt_frame_protection - IEEE 802.11w management frame protection
   */
  enum mfp_options mgmt_frame_protection;

  /**
   * passphrase - RSN passphrase for PSK
   *
   * This value is made available only for WPA/WPA2-Personal (PSK) and
   * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
   * is the 8..63 character ASCII passphrase, if available. Please note
   * that this can be %NULL if passphrase was not used to generate the
   * PSK. In that case, the psk field must be used to fetch the PSK.
   */
  const char *passphrase;

  /**
   * psk - RSN PSK (alternative for passphrase for PSK)
   *
   * This value is made available only for WPA/WPA2-Personal (PSK) and
   * only for drivers that set WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK. This
   * is the 32-octet (256-bit) PSK, if available. The driver wrapper
   * should be prepared to handle %NULL value as an error.
   */
  const u8 *psk;

  /**
   * sae_password - Password for SAE authentication
   *
   * This value is made available only for WPA3-Personal (SAE) and only
   * for drivers that set WPA_DRIVER_FLAGS2_SAE_OFFLOAD.
   */
  const char *sae_password;

  /**
   * sae_password_id - Password Identifier for SAE authentication
   *
   * This value is made available only for WPA3-Personal (SAE) and only
   * for drivers that set WPA_DRIVER_FLAGS2_SAE_OFFLOAD. If %NULL, SAE
   * password identifier is not used.
   */
  const char *sae_password_id;

  /**
   * drop_unencrypted - Enable/disable unencrypted frame filtering
   *
   * Configure the driver to drop all non-EAPOL frames (both receive and
   * transmit paths). Unencrypted EAPOL frames (ethertype 0x888e) must
   * still be allowed for key negotiation.
   */
  int drop_unencrypted;

  /**
   * prev_bssid - Previously used BSSID in this ESS
   *
   * When not %NULL, this is a request to use reassociation instead of
   * association.
   */
  const u8 *prev_bssid;

  /**
   * wps - WPS mode
   *
   * If the driver needs to do special configuration for WPS association,
   * this variable provides more information on what type of association
   * is being requested. Most drivers should not need to use this.
   */
  enum wps_mode wps;

  /**
   * p2p - Whether this connection is a P2P group
   */
  int p2p;

  /**
   * uapsd - UAPSD parameters for the network
   * -1 = do not change defaults
   * AP mode: 1 = enabled, 0 = disabled
   * STA mode: bits 0..3 UAPSD enabled for VO,VI,BK,BE
   */
  int uapsd;

  /**
   * fixed_bssid - Whether to force this BSSID in IBSS mode
   * 1 = Fix this BSSID and prevent merges.
   * 0 = Do not fix BSSID.
   */
  int fixed_bssid;

  /**
   * fixed_freq - Fix control channel in IBSS mode
   * 0 = don't fix control channel (default)
   * 1 = fix control channel; this prevents IBSS merging with another
   *  channel
   */
  int fixed_freq;

  /**
   * disable_ht - Disable HT (IEEE 802.11n) for this connection
   */
  int disable_ht;

  /**
   * htcaps - HT Capabilities over-rides
   *
   * Only bits set in the mask will be used, and not all values are used
   * by the kernel anyway. Currently, MCS, MPDU and MSDU fields are used.
   *
   * Pointer to struct ieee80211_ht_capabilities.
   */
  const u8 *htcaps;

  /**
   * htcaps_mask - HT Capabilities over-rides mask
   *
   * Pointer to struct ieee80211_ht_capabilities.
   */
  const u8 *htcaps_mask;

#ifdef CONFIG_VHT_OVERRIDES
  /**
   * disable_vht - Disable VHT for this connection
   */
  int disable_vht;

  /**
   * VHT capability overrides.
   */
  const struct ieee80211_vht_capabilities *vhtcaps;
  const struct ieee80211_vht_capabilities *vhtcaps_mask;
#endif /* CONFIG_VHT_OVERRIDES */

#ifdef CONFIG_HE_OVERRIDES
  /**
   * disable_he - Disable HE for this connection
   */
  int disable_he;
#endif /* CONFIG_HE_OVERRIDES */

  /**
   * req_key_mgmt_offload - Request key management offload for connection
   *
   * Request key management offload for this connection if the device
   * supports it.
   */
  int req_key_mgmt_offload;

  /**
   * req_handshake_offload - Request EAPOL handshake offload
   *
   * Request EAPOL handshake offload for this connection if the device
   * supports it.
   */
  int req_handshake_offload;

  /**
   * Flag for indicating whether this association includes support for
   * RRM (Radio Resource Measurements)
   */
  int rrm_used;

  /**
   * pbss - If set, connect to a PCP in a PBSS. Otherwise, connect to an
   * AP as usual. Valid for DMG network only.
   */
  int pbss;

  /**
   * fils_kek - KEK for FILS association frame protection (AES-SIV)
   */
  const u8 *fils_kek;

  /**
   * fils_kek_len: Length of fils_kek in bytes
   */
  size_t fils_kek_len;

  /**
   * fils_nonces - Nonces for FILS association frame protection
   * (AES-SIV AAD)
   */
  const u8 *fils_nonces;

  /**
   * fils_nonces_len: Length of fils_nonce in bytes
   */
  size_t fils_nonces_len;

  /**
   * fils_erp_username - Username part of keyName-NAI
   */
  const u8 *fils_erp_username;

  /**
   * fils_erp_username_len - Length of fils_erp_username in bytes
   */
  size_t fils_erp_username_len;

  /**
   * fils_erp_realm - Realm/domain name to use in FILS ERP
   */
  const u8 *fils_erp_realm;

  /**
   * fils_erp_realm_len - Length of fils_erp_realm in bytes
   */
  size_t fils_erp_realm_len;

  /**
   * fils_erp_next_seq_num - The next sequence number to use in FILS ERP
   * messages
   */
  u16 fils_erp_next_seq_num;

  /**
   * fils_erp_rrk - Re-authentication root key (rRK) for the keyName-NAI
   * specified by fils_erp_username@fils_erp_realm.
   */
  const u8 *fils_erp_rrk;

  /**
   * fils_erp_rrk_len - Length of fils_erp_rrk in bytes
   */
  size_t fils_erp_rrk_len;

  /**
   * sae_pwe - SAE mechanism for PWE derivation
   * 0 = hunting-and-pecking loop only
   * 1 = hash-to-element only
   * 2 = both hunting-and-pecking loop and hash-to-element enabled
   */
  enum sae_pwe sae_pwe;

  /**
   * disable_eht - Disable EHT for this connection
   */
  int disable_eht;

  /*
   * mld_params - MLD association parameters
   */
  struct wpa_driver_mld_params mld_params;

  /**
   * rsn_overriding - wpa_supplicant RSN overriding support
   */
  bool rsn_overriding;

  /**
   * spp_amsdu - SPP A-MSDU used on this connection
   */
  bool spp_amsdu;

  /**
   * bssid_filter - Allowed BSSIDs for the current association
   * This can be %NULL to indicate no constraint. */
  const u8 *bssid_filter;

  /**
   * bssid_filter_count - Number of allowed BSSIDs
   */
  unsigned int bssid_filter_count;

  /**
   * p2p_mode - P2P R1 only, P2P R2 only, or PCC mode
   */
  enum wpa_p2p_mode p2p_mode;
};

enum hide_ssid {
  NO_SSID_HIDING,
  HIDDEN_SSID_ZERO_LEN,
  HIDDEN_SSID_ZERO_CONTENTS
};

enum ch_switch_state {
  CH_SW_STARTED,
  CH_SW_FINISHED
};

struct wowlan_triggers {
  u8 any;
  u8 disconnect;
  u8 magic_pkt;
  u8 gtk_rekey_failure;
  u8 eap_identity_req;
  u8 four_way_handshake;
  u8 rfkill_release;
};

struct unsol_bcast_probe_resp {
  /**
   * Unsolicited broadcast Probe Response interval in TUs
   */
  unsigned int unsol_bcast_probe_resp_interval;

  /**
   * Unsolicited broadcast Probe Response template data
   */
  u8 *unsol_bcast_probe_resp_tmpl;

  /**
   * Unsolicited broadcast Probe Response template length
   */
  size_t unsol_bcast_probe_resp_tmpl_len;
};

struct mbssid_data {
  /**
   * mbssid_tx_iface - Transmitting interface of the MBSSID set
   */
  const char *mbssid_tx_iface;

  /**
   * mbssid_tx_iface_linkid - Link ID of the transmitting interface if
   * it is part of an MLD. Otherwise, -1.
   */
  int mbssid_tx_iface_linkid;

  /**
   * mbssid_index - The index of this BSS in the MBSSID set
   */
  unsigned int mbssid_index;

  /**
   * mbssid_elem - Buffer containing all MBSSID elements
   */
  u8 *mbssid_elem;

  /**
   * mbssid_elem_len - Total length of all MBSSID elements
   */
  size_t mbssid_elem_len;

  /**
   * mbssid_elem_count - The number of MBSSID elements
   */
  u8 mbssid_elem_count;

  /**
   * mbssid_elem_offset - Offsets to elements in mbssid_elem.
   * Kernel will use these offsets to generate multiple BSSID beacons.
   */
  u8 **mbssid_elem_offset;

  /**
   * ema - Enhanced MBSSID advertisements support.
   */
  bool ema;

  /**
   * rnr_elem - This buffer contains all of reduced neighbor report (RNR)
   * elements
   */
  u8 *rnr_elem;

  /**
   * rnr_elem_len - Length of rnr_elem buffer
   */
  size_t rnr_elem_len;

  /**
   * rnr_elem_count - Number of RNR elements
   */
  u8 rnr_elem_count;

  /**
   * rnr_elem_offset - The offsets to the elements in rnr_elem.
   * The driver will use these to include RNR elements in EMA beacons.
   */
  u8 **rnr_elem_offset;
};

struct wpa_driver_ap_params {
  /**
   * head - Beacon head from IEEE 802.11 header to IEs before TIM IE
   */
  u8 *head;

  /**
   * head_len - Length of the head buffer in octets
   */
  size_t head_len;

  /**
   * tail - Beacon tail following TIM IE
   */
  u8 *tail;

  /**
   * tail_len - Length of the tail buffer in octets
   */
  size_t tail_len;

  /**
   * dtim_period - DTIM period
   */
  int dtim_period;

  /**
   * beacon_int - Beacon interval
   */
  int beacon_int;

  /**
   * basic_rates: -1 terminated array of basic rates in 100 kbps
   *
   * This parameter can be used to set a specific basic rate set for the
   * BSS. If %NULL, default basic rate set is used.
   */
  int *basic_rates;

  /**
   * beacon_rate: Beacon frame data rate
   *
   * This parameter can be used to set a specific Beacon frame data rate
   * for the BSS. The interpretation of this value depends on the
   * rate_type (legacy: in 100 kbps units, HT: HT-MCS, VHT: VHT-MCS,
   * HE: HE-MCS). If beacon_rate == 0 and rate_type == 0
   * (BEACON_RATE_LEGACY), the default Beacon frame data rate is used.
   */
  unsigned int beacon_rate;

  /**
   * beacon_rate_type: Beacon data rate type (legacy/HT/VHT/HE)
   */
  enum beacon_rate_type rate_type;

  /**
   * proberesp - Probe Response template
   *
   * This is used by drivers that reply to Probe Requests internally in
   * AP mode and require the full Probe Response template.
   */
  u8 *proberesp;

  /**
   * proberesp_len - Length of the proberesp buffer in octets
   */
  size_t proberesp_len;

  /**
   * ssid - The SSID to use in Beacon/Probe Response frames
   */
  const u8 *ssid;

  /**
   * ssid_len - Length of the SSID (1..32)
   */
  size_t ssid_len;

  /**
   * hide_ssid - Whether to hide the SSID
   */
  enum hide_ssid hide_ssid;

  /**
   * pairwise_ciphers - WPA_CIPHER_* bitfield
   */
  unsigned int pairwise_ciphers;

  /**
   * group_cipher - WPA_CIPHER_*
   */
  unsigned int group_cipher;

  /**
   * key_mgmt_suites - WPA_KEY_MGMT_* bitfield
   */
  unsigned int key_mgmt_suites;

  /**
   * auth_algs - WPA_AUTH_ALG_* bitfield
   */
  unsigned int auth_algs;

  /**
   * wpa_version - WPA_PROTO_* bitfield
   */
  unsigned int wpa_version;

  /**
   * privacy - Whether privacy is used in the BSS
   */
  int privacy;

  /**
   * beacon_ies - WPS/P2P IE(s) for Beacon frames
   *
   * This is used to add IEs like WPS IE and P2P IE by drivers that do
   * not use the full Beacon template.
   */
  const struct wpabuf *beacon_ies;

  /**
   * proberesp_ies - P2P/WPS IE(s) for Probe Response frames
   *
   * This is used to add IEs like WPS IE and P2P IE by drivers that
   * reply to Probe Request frames internally.
   */
  const struct wpabuf *proberesp_ies;

  /**
   * assocresp_ies - WPS IE(s) for (Re)Association Response frames
   *
   * This is used to add IEs like WPS IE by drivers that reply to
   * (Re)Association Request frames internally.
   */
  const struct wpabuf *assocresp_ies;

  /**
   * isolate - Whether to isolate frames between associated stations
   *
   * If this is non-zero, the AP is requested to disable forwarding of
   * frames between associated stations.
   */
  int isolate;

  /**
   * cts_protect - Whether CTS protection is enabled
   */
  int cts_protect;

  /**
   * preamble - Whether short preamble is enabled
   */
  int preamble;

  /**
   * short_slot_time - Whether short slot time is enabled
   *
   * 0 = short slot time disable, 1 = short slot time enabled, -1 = do
   * not set (e.g., when 802.11g mode is not in use)
   */
  int short_slot_time;

  /**
   * ht_opmode - HT operation mode or -1 if HT not in use
   */
  int ht_opmode;

  /**
   * interworking - Whether Interworking is enabled
   */
  int interworking;

  /**
   * hessid - Homogeneous ESS identifier or %NULL if not set
   */
  const u8 *hessid;

  /**
   * access_network_type - Access Network Type (0..15)
   *
   * This is used for filtering Probe Request frames when Interworking is
   * enabled.
   */
  u8 access_network_type;

  /**
   * ap_max_inactivity - Timeout in seconds to detect STA's inactivity
   *
   * This is used by driver which advertises this capability.
   */
  int ap_max_inactivity;

  /**
   * ctwindow - Client Traffic Window (in TUs)
   */
  u8 p2p_go_ctwindow;

  /**
   * disable_dgaf - Whether group-addressed frames are disabled
   */
  int disable_dgaf;

  /**
   * freq - Channel parameters for dynamic bandwidth changes
   */
  struct hostapd_freq_params *freq;

  /**
   * reenable - Whether this is to re-enable beaconing
   */
  int reenable;

  /**
   * pbss - Whether to start a PCP (in PBSS) instead of an AP in
   * infrastructure BSS. Valid only for DMG network.
   */
  int pbss;

  /**
   * multicast_to_unicast - Whether to use multicast_to_unicast
   *
   * If this is non-zero, the AP is requested to perform multicast to
   * unicast conversion for ARP, IPv4, and IPv6 frames (possibly within
   * 802.1Q). If enabled, such frames are to be sent to each station
   * separately, with the DA replaced by their own MAC address rather
   * than the group address.
   *
   * Note that this may break certain expectations of the receiver, such
   * as the ability to drop unicast IP packets received within multicast
   * L2 frames, or the ability to not send ICMP destination unreachable
   * messages for packets received in L2 multicast (which is required,
   * but the receiver can't tell the difference if this new option is
   * enabled.)
   *
   * This also doesn't implement the 802.11 DMS (directed multicast
   * service).
   */
  int multicast_to_unicast;

  /**
   * ftm_responder - Whether FTM responder is enabled
   */
  int ftm_responder;

  /**
   * lci - Binary data, the content of an LCI report IE with type 8 as
   * defined in IEEE Std 802.11-2016, 9.4.2.22.10
   */
  const struct wpabuf *lci;

  /**
   * civic - Binary data, the content of a measurement report IE with
   * type 11 as defined in IEEE Std 802.11-2016, 9.4.2.22.13
   */
  const struct wpabuf *civic;

  /**
   * he_spr_ctrl - Spatial Reuse control field of SPR element
   */
  u8 he_spr_ctrl;

  /**
   * he_spr_non_srg_obss_pd_max_offset - Non-SRG Maximum TX power offset
   */
  u8 he_spr_non_srg_obss_pd_max_offset;

  /**
   * he_spr_srg_obss_pd_min_offset - Minimum TX power offset
   */
  u8 he_spr_srg_obss_pd_min_offset;

  /**
   * he_spr_srg_obss_pd_max_offset - Maximum TX power offset
   */
  u8 he_spr_srg_obss_pd_max_offset;

  /**
   * he_spr_bss_color_bitmap - BSS color values used by members of the
   * SRG.
   */
  u8 he_spr_bss_color_bitmap[8];

  /**
   * he_spr_partial_bssid_bitmap - Partial BSSID values used by members
   * of the SRG.
   */
  u8 he_spr_partial_bssid_bitmap[8];

  /**
   * he_bss_color - Whether the BSS Color is disabled
   */
  int he_bss_color_disabled;

  /**
   * he_bss_color_partial - The BSS Color AID equation
   */
  int he_bss_color_partial;

  /**
   * he_bss_color - The BSS Color of the AP
   */
  int he_bss_color;

  /**
   * twt_responder - Whether Target Wait Time responder is enabled
   */
  int twt_responder;

  /**
   * sae_pwe - SAE mechanism for PWE derivation
   * 0 = hunting-and-pecking loop only
   * 1 = hash-to-element only
   * 2 = both hunting-and-pecking loop and hash-to-element enabled
   */
  enum sae_pwe sae_pwe;

  /**
   * FILS Discovery frame minimum interval in TUs
   */
  u32 fd_min_int;

  /**
   * FILS Discovery frame maximum interval in TUs (0 = FD frame disabled)
   */
  u32 fd_max_int;

  /**
   * FILS Discovery frame template data
   */
  u8 *fd_frame_tmpl;

  /**
   * FILS Discovery frame template length
   */
  size_t fd_frame_tmpl_len;

  /**
   * mbssid - MBSSID element related params for Beacon frames
   *
   * This is used to add MBSSID element in beacon data.
   */
  struct mbssid_data mbssid;

  /**
   * punct_bitmap - Preamble puncturing bitmap
   * Each bit corresponds to a 20 MHz subchannel, the lowest bit for the
   * channel with the lowest frequency. A bit set to 1 indicates that the
   * subchannel is punctured, otherwise active.
   */
  u16 punct_bitmap;


  /* Unsolicited broadcast Probe Response data */
  struct unsol_bcast_probe_resp ubpr;

  /**
   * allowed_freqs - List of allowed 20 MHz channel center frequencies in
   * MHz for AP operation. Drivers which support this parameter will
   * generate a new list based on this provided list by filtering out
   * channels that cannot be used at that time due to regulatory or other
   * constraints. The resulting list is used as the list of all allowed
   * channels whenever performing operations like ACS and DFS.
   */
  int *allowed_freqs;

  /*
   * mld_ap - Whether operating as an AP MLD
   */
  bool mld_ap;

  /**
   * mld_link_id - Link id for MLD BSS's
   */
  u8 mld_link_id;

  /**
   * psk - PSK passed to the driver for 4-way handshake offload
   */
  u8 psk[PMK_LEN];

  /**
   * psk_len - PSK length in bytes (0 = not set)
   */
  size_t psk_len;

  /**
   * sae_password - SAE password for SAE offload
   */
  const char *sae_password;
};

struct wpa_driver_mesh_bss_params {
#define WPA_DRIVER_MESH_CONF_FLAG_AUTO_PLINKS   0x00000001
#define WPA_DRIVER_MESH_CONF_FLAG_PEER_LINK_TIMEOUT 0x00000002
#define WPA_DRIVER_MESH_CONF_FLAG_MAX_PEER_LINKS  0x00000004
#define WPA_DRIVER_MESH_CONF_FLAG_HT_OP_MODE    0x00000008
#define WPA_DRIVER_MESH_CONF_FLAG_RSSI_THRESHOLD  0x00000010
#define WPA_DRIVER_MESH_CONF_FLAG_FORWARDING    0x00000020
  /*
   * TODO: Other mesh configuration parameters would go here.
   * See NL80211_MESHCONF_* for all the mesh config parameters.
   */
  unsigned int flags;
  int auto_plinks;
  int peer_link_timeout;
  int max_peer_links;
  int rssi_threshold;
  int forwarding;
  u16 ht_opmode;
};

struct wpa_driver_mesh_join_params {
  const u8 *meshid;
  int meshid_len;
  const int *basic_rates;
  const u8 *ies;
  int ie_len;
  struct hostapd_freq_params freq;
  int beacon_int;
  int dtim_period;
  struct wpa_driver_mesh_bss_params conf;
#define WPA_DRIVER_MESH_FLAG_USER_MPM 0x00000001
#define WPA_DRIVER_MESH_FLAG_DRIVER_MPM 0x00000002
#define WPA_DRIVER_MESH_FLAG_SAE_AUTH 0x00000004
#define WPA_DRIVER_MESH_FLAG_AMPE 0x00000008
  unsigned int flags;
  bool handle_dfs;
};

struct wpa_driver_set_key_params {
  /**
   * ifname - Interface name (for multi-SSID/VLAN support) */
  const char *ifname;

  /**
   * alg - Encryption algorithm
   *
   * (%WPA_ALG_NONE, %WPA_ALG_WEP, %WPA_ALG_TKIP, %WPA_ALG_CCMP,
   * %WPA_ALG_BIP_AES_CMAC_128, %WPA_ALG_GCMP, %WPA_ALG_GCMP_256,
   * %WPA_ALG_CCMP_256, %WPA_ALG_BIP_GMAC_128, %WPA_ALG_BIP_GMAC_256,
   * %WPA_ALG_BIP_CMAC_256);
   * %WPA_ALG_NONE clears the key. */
  enum wpa_alg alg;

  /**
   * addr - Address of the peer STA
   *
   * (BSSID of the current AP when setting pairwise key in station mode),
   * ff:ff:ff:ff:ff:ff for broadcast keys, %NULL for default keys that
   * are used both for broadcast and unicast; when clearing keys, %NULL
   * is used to indicate that both the broadcast-only and default key of
   * the specified key index is to be cleared */
  const u8 *addr;

  /**
   * key_idx - Key index
   *
   * (0..3), usually 0 for unicast keys; 4..5 for IGTK; 6..7 for BIGTK */
  int key_idx;

  /**
   * set_tx - Configure this key as the default Tx key
   *
   * Only used when driver does not support separate unicast/individual
   * key */
  int set_tx;

  /**
   * seq - Sequence number/packet number
   *
   * seq_len octets, the next packet number to be used for in replay
   * protection; configured for Rx keys (in most cases, this is only used
   * with broadcast keys and set to zero for unicast keys); %NULL if not
   * set */
  const u8 *seq;

  /**
   * seq_len - Length of the seq, depends on the algorithm
   *
   * TKIP: 6 octets, CCMP/GCMP: 6 octets, IGTK: 6 octets */
  size_t seq_len;

  /**
   * key - Key buffer
   *
   * TKIP: 16-byte temporal key, 8-byte Tx Mic key, 8-byte Rx Mic Key */
  const u8 *key;

  /**
   * key_len - Length of the key buffer in octets
   *
   * WEP: 5 or 13, TKIP: 32, CCMP/GCMP: 16, IGTK: 16 */
  size_t key_len;

  /**
   * vlan_id - VLAN index (0..4095) for VLAN offload cases */
  int vlan_id;

  /**
   * key_flag - Additional key flags
   *
   * %KEY_FLAG_MODIFY
   *  Set when an already installed key must be updated.
   *  So far the only use-case is changing RX/TX status for
   *  pairwise keys. Must not be set when deleting a key.
   * %KEY_FLAG_DEFAULT
   *  Set when the key is also a default key. Must not be set when
   *  deleting a key.
   * %KEY_FLAG_RX
   *  The key is valid for RX. Must not be set when deleting a key.
   * %KEY_FLAG_TX
   *  The key is valid for TX. Must not be set when deleting a key.
   * %KEY_FLAG_GROUP
   *  The key is a broadcast or group key.
   * %KEY_FLAG_PAIRWISE
   *  The key is a pairwise key.
   * %KEY_FLAG_PMK
   *  The key is a Pairwise Master Key (PMK).
   *
   * Valid and pre-defined combinations are:
   * %KEY_FLAG_GROUP_RX_TX
   *  WEP key not to be installed as default key.
   * %KEY_FLAG_GROUP_RX_TX_DEFAULT
   *  Default WEP or WPA-NONE key.
   * %KEY_FLAG_GROUP_RX
   *  GTK key valid for RX only.
   * %KEY_FLAG_GROUP_TX_DEFAULT
   *  GTK key valid for TX only, immediately taking over TX.
   * %KEY_FLAG_PAIRWISE_RX_TX
   *  Pairwise key immediately becoming the active pairwise key. If this
   *  key was previously set as an alternative RX-only key with
   *  %KEY_FLAG_PAIRWISE_RX | %KEY_FLAG_NEXT, the alternative RX-only key
   *  is taken into use for both TX and RX without changing the RX counter
   *  values.
   * %KEY_FLAG_PAIRWISE_RX
   *  Pairwise key not yet valid for TX. (Only usable when Extended
   *  Key ID is supported by the driver or when configuring the next TK
   *  for RX-only with %KEY_FLAG_NEXT in which case the new TK can be used
   *  as an alternative key for decrypting received frames without
   *  replacing the possibly already configured old TK.)
   * %KEY_FLAG_PAIRWISE_RX_TX_MODIFY
   *  Enable TX for a pairwise key installed with
   *  KEY_FLAG_PAIRWISE_RX.
   *
   * Not a valid standalone key type but pre-defined to be combined
   * with other key_flags:
   * %KEY_FLAG_RX_TX
   *  RX/TX key. */
  enum key_flag key_flag;

  /**
   * link_id - MLO Link ID
   *
   * Set to a valid Link ID (0-14) when applicable, otherwise -1. */
  int link_id;
};

enum wpa_driver_if_type {
  /**
   * WPA_IF_STATION - Station mode interface
   */
  WPA_IF_STATION,

  /**
   * WPA_IF_AP_VLAN - AP mode VLAN interface
   *
   * This interface shares its address and Beacon frame with the main
   * BSS.
   */
  WPA_IF_AP_VLAN,

  /**
   * WPA_IF_AP_BSS - AP mode BSS interface
   *
   * This interface has its own address and Beacon frame.
   */
  WPA_IF_AP_BSS,

  /**
   * WPA_IF_P2P_GO - P2P Group Owner
   */
  WPA_IF_P2P_GO,

  /**
   * WPA_IF_P2P_CLIENT - P2P Client
   */
  WPA_IF_P2P_CLIENT,

  /**
   * WPA_IF_P2P_GROUP - P2P Group interface (will become either
   * WPA_IF_P2P_GO or WPA_IF_P2P_CLIENT, but the role is not yet known)
   */
  WPA_IF_P2P_GROUP,

  /**
   * WPA_IF_P2P_DEVICE - P2P Device interface is used to identify the
   * abstracted P2P Device function in the driver
   */
  WPA_IF_P2P_DEVICE,

  /*
   * WPA_IF_MESH - Mesh interface
   */
  WPA_IF_MESH,

  /*
   * WPA_IF_TDLS - TDLS offchannel interface (used for pref freq only)
   */
  WPA_IF_TDLS,

  /*
   * WPA_IF_IBSS - IBSS interface (used for pref freq only)
   */
  WPA_IF_IBSS,

  /*
   * WPA_IF_NAN - NAN Device
   */
  WPA_IF_NAN,

  /* keep last */
  WPA_IF_MAX
};

/**
 * struct wpa_driver_capa - Driver capability information
 */
struct wpa_driver_capa {
#define WPA_DRIVER_CAPA_KEY_MGMT_WPA    0x00000001
#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2   0x00000002
#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_PSK  0x00000004
#define WPA_DRIVER_CAPA_KEY_MGMT_WPA2_PSK 0x00000008
#define WPA_DRIVER_CAPA_KEY_MGMT_WPA_NONE 0x00000010
#define WPA_DRIVER_CAPA_KEY_MGMT_FT   0x00000020
#define WPA_DRIVER_CAPA_KEY_MGMT_FT_PSK   0x00000040
#define WPA_DRIVER_CAPA_KEY_MGMT_WAPI_PSK 0x00000080
#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B  0x00000100
#define WPA_DRIVER_CAPA_KEY_MGMT_SUITE_B_192  0x00000200
#define WPA_DRIVER_CAPA_KEY_MGMT_OWE    0x00000400
#define WPA_DRIVER_CAPA_KEY_MGMT_DPP    0x00000800
#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA256    0x00001000
#define WPA_DRIVER_CAPA_KEY_MGMT_FILS_SHA384    0x00002000
#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA256 0x00004000
#define WPA_DRIVER_CAPA_KEY_MGMT_FT_FILS_SHA384 0x00008000
#define WPA_DRIVER_CAPA_KEY_MGMT_SAE    0x00010000
#define WPA_DRIVER_CAPA_KEY_MGMT_802_1X_SHA256  0x00020000
#define WPA_DRIVER_CAPA_KEY_MGMT_PSK_SHA256 0x00040000
#define WPA_DRIVER_CAPA_KEY_MGMT_TPK_HANDSHAKE  0x00080000
#define WPA_DRIVER_CAPA_KEY_MGMT_FT_SAE   0x00100000
#define WPA_DRIVER_CAPA_KEY_MGMT_FT_802_1X_SHA384 0x00200000
#define WPA_DRIVER_CAPA_KEY_MGMT_CCKM   0x00400000
#define WPA_DRIVER_CAPA_KEY_MGMT_SAE_EXT_KEY  0x01000000
#define WPA_DRIVER_CAPA_KEY_MGMT_FT_SAE_EXT_KEY 0x02000000
  /** Bitfield of supported key management suites */
  unsigned int key_mgmt;
  unsigned int key_mgmt_iftype[WPA_IF_MAX];

#define WPA_DRIVER_CAPA_ENC_WEP40 0x00000001
#define WPA_DRIVER_CAPA_ENC_WEP104  0x00000002
#define WPA_DRIVER_CAPA_ENC_TKIP  0x00000004
#define WPA_DRIVER_CAPA_ENC_CCMP  0x00000008
#define WPA_DRIVER_CAPA_ENC_WEP128  0x00000010
#define WPA_DRIVER_CAPA_ENC_GCMP  0x00000020
#define WPA_DRIVER_CAPA_ENC_GCMP_256  0x00000040
#define WPA_DRIVER_CAPA_ENC_CCMP_256  0x00000080
#define WPA_DRIVER_CAPA_ENC_BIP   0x00000100
#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_128  0x00000200
#define WPA_DRIVER_CAPA_ENC_BIP_GMAC_256  0x00000400
#define WPA_DRIVER_CAPA_ENC_BIP_CMAC_256  0x00000800
#define WPA_DRIVER_CAPA_ENC_GTK_NOT_USED  0x00001000
  /** Bitfield of supported cipher suites */
  unsigned int enc;

#define WPA_DRIVER_AUTH_OPEN    0x00000001
#define WPA_DRIVER_AUTH_SHARED    0x00000002
#define WPA_DRIVER_AUTH_LEAP    0x00000004
  /** Bitfield of supported IEEE 802.11 authentication algorithms */
  unsigned int auth;

/** Driver generated WPA/RSN IE */
#define WPA_DRIVER_FLAGS_DRIVER_IE  0x00000001
/** Driver needs static WEP key setup after association command */
#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC 0x00000002
/** Driver takes care of all DFS operations */
#define WPA_DRIVER_FLAGS_DFS_OFFLOAD      0x00000004
/** Driver takes care of RSN 4-way handshake internally; PMK is configured with
 * struct wpa_driver_ops::set_key using key_flag = KEY_FLAG_PMK */
#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_8021X   0x00000008
/** Driver is for a wired Ethernet interface */
#define WPA_DRIVER_FLAGS_WIRED    0x00000010
/** Driver provides separate commands for authentication and association (SME in
 * wpa_supplicant). */
#define WPA_DRIVER_FLAGS_SME    0x00000020
/** Driver supports AP mode */
#define WPA_DRIVER_FLAGS_AP   0x00000040
/** Driver needs static WEP key setup after association has been completed */
#define WPA_DRIVER_FLAGS_SET_KEYS_AFTER_ASSOC_DONE  0x00000080
/** Driver supports dynamic HT 20/40 MHz channel changes during BSS lifetime */
#define WPA_DRIVER_FLAGS_HT_2040_COEX     0x00000100
/** Driver supports concurrent P2P operations */
#define WPA_DRIVER_FLAGS_P2P_CONCURRENT 0x00000200
/**
 * Driver uses the initial interface as a dedicated management interface, i.e.,
 * it cannot be used for P2P group operations or non-P2P purposes.
 */
#define WPA_DRIVER_FLAGS_P2P_DEDICATED_INTERFACE  0x00000400
/** This interface is P2P capable (P2P GO or P2P Client) */
#define WPA_DRIVER_FLAGS_P2P_CAPABLE  0x00000800
/** Driver supports station and key removal when stopping an AP */
#define WPA_DRIVER_FLAGS_AP_TEARDOWN_SUPPORT    0x00001000
/**
 * Driver uses the initial interface for P2P management interface and non-P2P
 * purposes (e.g., connect to infra AP), but this interface cannot be used for
 * P2P group operations.
 */
#define WPA_DRIVER_FLAGS_P2P_MGMT_AND_NON_P2P   0x00002000
/**
 * Driver is known to use valid error codes, i.e., when it indicates that
 * something (e.g., association) fails, there was indeed a failure and the
 * operation does not end up getting completed successfully later.
 */
#define WPA_DRIVER_FLAGS_VALID_ERROR_CODES    0x00004000
/** Driver supports off-channel TX */
#define WPA_DRIVER_FLAGS_OFFCHANNEL_TX      0x00008000
/** Driver indicates TX status events for EAPOL Data frames */
#define WPA_DRIVER_FLAGS_EAPOL_TX_STATUS    0x00010000
/** Driver indicates TX status events for Deauth/Disassoc frames */
#define WPA_DRIVER_FLAGS_DEAUTH_TX_STATUS   0x00020000
/** Driver supports roaming (BSS selection) in firmware */
#define WPA_DRIVER_FLAGS_BSS_SELECTION      0x00040000
/** Driver supports operating as a TDLS peer */
#define WPA_DRIVER_FLAGS_TDLS_SUPPORT     0x00080000
/** Driver requires external TDLS setup/teardown/discovery */
#define WPA_DRIVER_FLAGS_TDLS_EXTERNAL_SETUP    0x00100000
/** Driver indicates support for Probe Response offloading in AP mode */
#define WPA_DRIVER_FLAGS_PROBE_RESP_OFFLOAD   0x00200000
/** Driver supports U-APSD in AP mode */
#define WPA_DRIVER_FLAGS_AP_UAPSD     0x00400000
/** Driver supports inactivity timer in AP mode */
#define WPA_DRIVER_FLAGS_INACTIVITY_TIMER   0x00800000
/** Driver expects user space implementation of MLME in AP mode */
#define WPA_DRIVER_FLAGS_AP_MLME      0x01000000
/** Driver supports SAE with user space SME */
#define WPA_DRIVER_FLAGS_SAE        0x02000000
/** Driver makes use of OBSS scan mechanism in wpa_supplicant */
#define WPA_DRIVER_FLAGS_OBSS_SCAN      0x04000000
/** Driver supports IBSS (Ad-hoc) mode */
#define WPA_DRIVER_FLAGS_IBSS       0x08000000
/** Driver supports radar detection */
#define WPA_DRIVER_FLAGS_RADAR        0x10000000
/** Driver supports a dedicated interface for P2P Device */
#define WPA_DRIVER_FLAGS_DEDICATED_P2P_DEVICE   0x20000000
/** Driver supports QoS Mapping */
#define WPA_DRIVER_FLAGS_QOS_MAPPING      0x40000000
/** Driver supports CSA in AP mode */
#define WPA_DRIVER_FLAGS_AP_CSA       0x80000000
/** Driver supports mesh */
#define WPA_DRIVER_FLAGS_MESH     0x0000000100000000ULL
/** Driver support ACS offload */
#define WPA_DRIVER_FLAGS_ACS_OFFLOAD    0x0000000200000000ULL
/** Driver supports key management offload */
#define WPA_DRIVER_FLAGS_KEY_MGMT_OFFLOAD 0x0000000400000000ULL
/** Driver supports TDLS channel switching */
#define WPA_DRIVER_FLAGS_TDLS_CHANNEL_SWITCH  0x0000000800000000ULL
/** Driver supports IBSS with HT datarates */
#define WPA_DRIVER_FLAGS_HT_IBSS    0x0000001000000000ULL
/** Driver supports IBSS with VHT datarates */
#define WPA_DRIVER_FLAGS_VHT_IBSS   0x0000002000000000ULL
/** Driver supports automatic band selection */
#define WPA_DRIVER_FLAGS_SUPPORT_HW_MODE_ANY  0x0000004000000000ULL
/** Driver supports simultaneous off-channel operations */
#define WPA_DRIVER_FLAGS_OFFCHANNEL_SIMULTANEOUS  0x0000008000000000ULL
/** Driver supports full AP client state */
#define WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE 0x0000010000000000ULL
/** Driver supports P2P Listen offload */
#define WPA_DRIVER_FLAGS_P2P_LISTEN_OFFLOAD     0x0000020000000000ULL
/** Driver supports FILS */
#define WPA_DRIVER_FLAGS_SUPPORT_FILS   0x0000040000000000ULL
/** Driver supports Beacon frame TX rate configuration (legacy rates) */
#define WPA_DRIVER_FLAGS_BEACON_RATE_LEGACY 0x0000080000000000ULL
/** Driver supports Beacon frame TX rate configuration (HT rates) */
#define WPA_DRIVER_FLAGS_BEACON_RATE_HT   0x0000100000000000ULL
/** Driver supports Beacon frame TX rate configuration (VHT rates) */
#define WPA_DRIVER_FLAGS_BEACON_RATE_VHT  0x0000200000000000ULL
/** Driver supports mgmt_tx with random TX address in non-connected state */
#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA  0x0000400000000000ULL
/** Driver supports mgmt_tx with random TX addr in connected state */
#define WPA_DRIVER_FLAGS_MGMT_TX_RANDOM_TA_CONNECTED  0x0000800000000000ULL
/** Driver supports better BSS reporting with sched_scan in connected mode */
#define WPA_DRIVER_FLAGS_SCHED_SCAN_RELATIVE_RSSI 0x0001000000000000ULL
/** Driver supports HE capabilities */
#define WPA_DRIVER_FLAGS_HE_CAPABILITIES  0x0002000000000000ULL
/** Driver supports FILS shared key offload */
#define WPA_DRIVER_FLAGS_FILS_SK_OFFLOAD  0x0004000000000000ULL
/** Driver supports all OCE STA specific mandatory features */
#define WPA_DRIVER_FLAGS_OCE_STA    0x0008000000000000ULL
/** Driver supports all OCE AP specific mandatory features */
#define WPA_DRIVER_FLAGS_OCE_AP     0x0010000000000000ULL
/**
 * Driver supports all OCE STA-CFON specific mandatory features only.
 * If a driver sets this bit but not the %WPA_DRIVER_FLAGS_OCE_AP, the
 * userspace shall assume that this driver may not support all OCE AP
 * functionality but can support only OCE STA-CFON functionality.
 */
#define WPA_DRIVER_FLAGS_OCE_STA_CFON   0x0020000000000000ULL
/** Driver supports MFP-optional in the connect command */
#define WPA_DRIVER_FLAGS_MFP_OPTIONAL   0x0040000000000000ULL
/** Driver is a self-managed regulatory device */
#define WPA_DRIVER_FLAGS_SELF_MANAGED_REGULATORY       0x0080000000000000ULL
/** Driver supports FTM responder functionality */
#define WPA_DRIVER_FLAGS_FTM_RESPONDER    0x0100000000000000ULL
/** Driver support 4-way handshake offload for WPA-Personal */
#define WPA_DRIVER_FLAGS_4WAY_HANDSHAKE_PSK 0x0200000000000000ULL
/** Driver supports a separate control port TX for EAPOL frames */
#define WPA_DRIVER_FLAGS_CONTROL_PORT   0x0400000000000000ULL
/** Driver supports VLAN offload */
#define WPA_DRIVER_FLAGS_VLAN_OFFLOAD   0x0800000000000000ULL
/** Driver supports UPDATE_FT_IES command */
#define WPA_DRIVER_FLAGS_UPDATE_FT_IES    0x1000000000000000ULL
/** Driver can correctly rekey PTKs without Extended Key ID */
#define WPA_DRIVER_FLAGS_SAFE_PTK0_REKEYS 0x2000000000000000ULL
/** Driver supports Beacon protection */
#define WPA_DRIVER_FLAGS_BEACON_PROTECTION  0x4000000000000000ULL
/** Driver supports Extended Key ID */
#define WPA_DRIVER_FLAGS_EXTENDED_KEY_ID  0x8000000000000000ULL
  u64 flags;

/** Driver supports a separate control port RX for EAPOL frames */
#define WPA_DRIVER_FLAGS2_CONTROL_PORT_RX 0x0000000000000001ULL
/** Driver supports TX status reports for EAPOL frames through control port */
#define WPA_DRIVER_FLAGS2_CONTROL_PORT_TX_STATUS 0x0000000000000002ULL
/** Driver supports secure LTF in AP mode */
#define WPA_DRIVER_FLAGS2_SEC_LTF_AP    0x0000000000000004ULL
/** Driver supports secure RTT measurement exchange in AP mode */
#define WPA_DRIVER_FLAGS2_SEC_RTT_AP    0x0000000000000008ULL
/**
 * Driver supports protection of range negotiation and measurement management
 * frames in AP mode
 */
#define WPA_DRIVER_FLAGS2_PROT_RANGE_NEG_AP 0x0000000000000010ULL
/** Driver supports Beacon frame TX rate configuration (HE rates) */
#define WPA_DRIVER_FLAGS2_BEACON_RATE_HE  0x0000000000000020ULL
/** Driver supports Beacon protection only in client mode */
#define WPA_DRIVER_FLAGS2_BEACON_PROTECTION_CLIENT 0x0000000000000040ULL
/** Driver supports Operating Channel Validation */
#define WPA_DRIVER_FLAGS2_OCV     0x0000000000000080ULL
/** Driver expects user space implementation of SME in AP mode */
#define WPA_DRIVER_FLAGS2_AP_SME    0x0000000000000100ULL
/** Driver handles SA Query procedures in AP mode */
#define WPA_DRIVER_FLAGS2_SA_QUERY_OFFLOAD_AP 0x0000000000000200ULL
/** Driver supports background radar/CAC detection */
#define WPA_DRIVER_FLAGS2_RADAR_BACKGROUND  0x0000000000000400ULL
/** Driver supports secure LTF in STA mode */
#define WPA_DRIVER_FLAGS2_SEC_LTF_STA   0x0000000000000800ULL
/** Driver supports secure RTT measurement exchange in STA mode */
#define WPA_DRIVER_FLAGS2_SEC_RTT_STA   0x0000000000001000ULL
/**
 * Driver supports protection of range negotiation and measurement management
 * frames in STA mode
 */
#define WPA_DRIVER_FLAGS2_PROT_RANGE_NEG_STA  0x0000000000002000ULL
/** Driver supports MLO in station/AP mode */
#define WPA_DRIVER_FLAGS2_MLO     0x0000000000004000ULL
/** Driver supports minimal scan request probe content  */
#define WPA_DRIVER_FLAGS2_SCAN_MIN_PREQ         0x0000000000008000ULL
/** Driver supports SAE authentication offload in STA mode */
#define WPA_DRIVER_FLAGS2_SAE_OFFLOAD_STA 0x0000000000010000ULL
/** Driver support AP_PSK authentication offload */
#define WPA_DRIVER_FLAGS2_4WAY_HANDSHAKE_AP_PSK 0x0000000000020000ULL
/** Driver supports OWE STA offload */
#define WPA_DRIVER_FLAGS2_OWE_OFFLOAD_STA 0x0000000000040000ULL
/** Driver supports OWE AP offload */
#define WPA_DRIVER_FLAGS2_OWE_OFFLOAD_AP  0x0000000000080000ULL
/** Driver support AP SAE authentication offload */
#define WPA_DRIVER_FLAGS2_SAE_OFFLOAD_AP  0x0000000000100000ULL
/** Driver supports TWT responder in HT and VHT modes */
#define WPA_DRIVER_FLAGS2_HT_VHT_TWT_RESPONDER  0x0000000000200000ULL
/** Driver supports RSN override elements */
#define WPA_DRIVER_FLAGS2_RSN_OVERRIDE_STA  0x0000000000400000ULL
/** Driver supports NAN USD offload */
#define WPA_DRIVER_FLAGS2_NAN_USD_OFFLOAD 0x0000000000800000ULL
/** Driver/device supports SPP A-MSDUs */
#define WPA_DRIVER_FLAGS2_SPP_AMSDU   0x0000000001000000ULL
/** Driver supports P2P V2 */
#define WPA_DRIVER_FLAGS2_P2P_FEATURE_V2  0x0000000002000000ULL
/** Driver supports P2P PCC mode */
#define WPA_DRIVER_FLAGS2_P2P_FEATURE_PCC_MODE  0x0000000004000000ULL
/** Driver supports arbitrary channel width changes in AP mode */
#define WPA_DRIVER_FLAGS2_AP_CHANWIDTH_CHANGE 0x0000000008000000ULL
/** Driver supports FTM initiator functionality */
#define WPA_DRIVER_FLAGS2_FTM_INITIATOR   0x0000000010000000ULL
/** Driver supports non-trigger based ranging responder functionality */
#define WPA_DRIVER_FLAGS2_NON_TRIGGER_BASED_RESPONDER   0x0000000020000000ULL
/** Driver supports non-trigger based ranging initiator functionality */
#define WPA_DRIVER_FLAGS2_NON_TRIGGER_BASED_INITIATOR 0x0000000040000000ULL
/** Driver supports NAN Device interface and NAN Synchronization */
#define WPA_DRIVER_FLAGS2_SUPPORT_NAN     0x0000000080000000ULL
/** Driver supports P2P assisted DFS */
#define WPA_DRIVER_FLAGS2_P2P_ASSISTED_DFS    0x0000000100000000ULL
/** Driver supports (Re)Association Request/Response frame encryption */
#define WPA_DRIVER_FLAGS2_ASSOCIATION_FRAME_ENCRYPTION  0x0000000200000000ULL
/** Driver supports EPPKE authentication */
#define WPA_DRIVER_FLAGS2_EPPKE       0x0000000400000000ULL
  u64 flags2;

#define FULL_AP_CLIENT_STATE_SUPP(drv_flags) \
  (drv_flags & WPA_DRIVER_FLAGS_FULL_AP_CLIENT_STATE)

  unsigned int wmm_ac_supported:1;

  unsigned int mac_addr_rand_scan_supported:1;
  unsigned int mac_addr_rand_sched_scan_supported:1;

  /** Maximum number of supported active probe SSIDs */
  int max_scan_ssids;

  /** Maximum number of supported active probe SSIDs for sched_scan */
  int max_sched_scan_ssids;

  /** Maximum number of supported scan plans for scheduled scan */
  unsigned int max_sched_scan_plans;

  /** Maximum interval in a scan plan. In seconds */
  u32 max_sched_scan_plan_interval;

  /** Maximum number of iterations in a single scan plan */
  u32 max_sched_scan_plan_iterations;

  /** Whether sched_scan (offloaded scanning) is supported */
  int sched_scan_supported;

  /** Maximum number of supported match sets for sched_scan */
  int max_match_sets;

  /**
   * max_remain_on_chan - Maximum remain-on-channel duration in msec
   */
  unsigned int max_remain_on_chan;

  /**
   * max_stations - Maximum number of associated stations the driver
   * supports in AP mode
   */
  unsigned int max_stations;

  /**
   * probe_resp_offloads - Bitmap of supported protocols by the driver
   * for Probe Response offloading.
   */
/** Driver Probe Response offloading support for WPS ver. 1 */
#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS   0x00000001
/** Driver Probe Response offloading support for WPS ver. 2 */
#define WPA_DRIVER_PROBE_RESP_OFFLOAD_WPS2    0x00000002
/** Driver Probe Response offloading support for P2P */
#define WPA_DRIVER_PROBE_RESP_OFFLOAD_P2P   0x00000004
/** Driver Probe Response offloading support for IEEE 802.11u (Interworking) */
#define WPA_DRIVER_PROBE_RESP_OFFLOAD_INTERWORKING  0x00000008
  unsigned int probe_resp_offloads;

  unsigned int max_acl_mac_addrs;

  /**
   * Number of supported concurrent channels
   */
  unsigned int num_multichan_concurrent;

  /**
   * extended_capa - extended capabilities in driver/device
   *
   * Must be allocated and freed by driver and the pointers must be
   * valid for the lifetime of the driver, i.e., freed in deinit()
   */
  const u8 *extended_capa, *extended_capa_mask;
  unsigned int extended_capa_len;

  struct wowlan_triggers wowlan_triggers;

/** Driver adds the DS Params Set IE in Probe Request frames */
#define WPA_DRIVER_FLAGS_DS_PARAM_SET_IE_IN_PROBES  0x00000001
/** Driver adds the WFA TPC IE in Probe Request frames */
#define WPA_DRIVER_FLAGS_WFA_TPC_IE_IN_PROBES   0x00000002
/** Driver handles quiet period requests */
#define WPA_DRIVER_FLAGS_QUIET        0x00000004
/**
 * Driver is capable of inserting the current TX power value into the body of
 * transmitted frames.
 * Background: Some Action frames include a TPC Report IE. This IE contains a
 * TX power field, which has to be updated by lower layers. One such Action
 * frame is Link Measurement Report (part of RRM). Another is TPC Report (part
 * of spectrum management). Note that this insertion takes place at a fixed
 * offset, namely the 6th byte in the Action frame body.
 */
#define WPA_DRIVER_FLAGS_TX_POWER_INSERTION   0x00000008
/**
 * Driver supports RRM. With this support, the driver will accept to use RRM in
 * (Re)Association Request frames, without supporting quiet period.
 */
#define WPA_DRIVER_FLAGS_SUPPORT_RRM      0x00000010

/** Driver supports setting the scan dwell time */
#define WPA_DRIVER_FLAGS_SUPPORT_SET_SCAN_DWELL   0x00000020
/** Driver supports Beacon Report Measurement */
#define WPA_DRIVER_FLAGS_SUPPORT_BEACON_REPORT    0x00000040

  u32 rrm_flags;

  /* Driver concurrency capabilities */
  unsigned int conc_capab;
  /* Maximum number of concurrent channels on 2.4 GHz */
  unsigned int max_conc_chan_2_4;
  /* Maximum number of concurrent channels on 5 GHz */
  unsigned int max_conc_chan_5_0;

  /* Maximum number of supported CSA counters */
  u16 max_csa_counters;

  /* Maximum number of supported AKM suites in commands */
  unsigned int max_num_akms;

  /* Maximum number of interfaces supported for MBSSID advertisement */
  unsigned int mbssid_max_interfaces;
  /* Maximum profile periodicity for enhanced MBSSID advertisement */
  unsigned int ema_max_periodicity;

  /* Maximum number of bytes of extra IE(s) that can be added to Probe
   * Request frames */
  size_t max_probe_req_ie_len;

  /* EDCA based ranging capabilities */
  u8 edca_format_and_bw;
  u8 max_tx_antenna;
  u8 max_rx_antenna;

  /* NTB based ranging capabilities */
  u8 ntb_format_and_bw;
  u8 max_tx_ltf_repetations;
  u8 max_rx_ltf_repetations;
  u8 max_tx_ltf_total;
  u8 max_rx_ltf_total;
  u8 max_rx_sts_le_80;
  u8 max_rx_sts_gt_80;
  u8 max_tx_sts_le_80;
  u8 max_tx_sts_gt_80;

#ifdef CONFIG_NAN
/* Driver supports dual band NAN operation */
#define WPA_DRIVER_FLAGS_NAN_SUPPORT_DUAL_BAND    0x00000001
/* Driver supports NAN synchronization configuration */
#define WPA_DRIVER_FLAGS_NAN_SUPPORT_SYNC_CONFIG  0x00000002
/* Driver supports DW notifications and SDF TX/RX over NAN device interface */
#define WPA_DRIVER_FLAGS_NAN_SUPPORT_USERSPACE_DE 0x00000004
  u32 nan_flags;
#endif /* CONFIG_NAN */
};


struct hostapd_data;

enum guard_interval {
  GUARD_INTERVAL_0_4 = 1,
  GUARD_INTERVAL_0_8 = 2,
  GUARD_INTERVAL_1_6 = 3,
  GUARD_INTERVAL_3_2 = 4,
};

#define STA_DRV_DATA_TX_MCS BIT(0)
#define STA_DRV_DATA_RX_MCS BIT(1)
#define STA_DRV_DATA_TX_VHT_MCS BIT(2)
#define STA_DRV_DATA_RX_VHT_MCS BIT(3)
#define STA_DRV_DATA_TX_VHT_NSS BIT(4)
#define STA_DRV_DATA_RX_VHT_NSS BIT(5)
#define STA_DRV_DATA_TX_SHORT_GI BIT(6)
#define STA_DRV_DATA_RX_SHORT_GI BIT(7)
#define STA_DRV_DATA_LAST_ACK_RSSI BIT(8)
#define STA_DRV_DATA_CONN_TIME BIT(9)
#define STA_DRV_DATA_TX_HE_MCS BIT(10)
#define STA_DRV_DATA_RX_HE_MCS BIT(11)
#define STA_DRV_DATA_TX_HE_NSS BIT(12)
#define STA_DRV_DATA_RX_HE_NSS BIT(13)
#define STA_DRV_DATA_TX_HE_DCM BIT(14)
#define STA_DRV_DATA_RX_HE_DCM BIT(15)
#define STA_DRV_DATA_TX_HE_GI BIT(16)
#define STA_DRV_DATA_RX_HE_GI BIT(17)

struct hostap_sta_driver_data {
  unsigned long rx_packets, tx_packets;
  unsigned long long rx_bytes, tx_bytes;
  unsigned long long rx_airtime, tx_airtime;
  unsigned long long beacons_count;
  int bytes_64bit; /* whether 64-bit byte counters are supported */
  unsigned long current_tx_rate; /* in kbps */
  unsigned long current_rx_rate; /* in kbps */
  unsigned long inactive_msec;
  unsigned long connected_sec;
  unsigned long flags; /* bitfield of STA_DRV_DATA_* */
  unsigned long num_ps_buf_frames;
  unsigned long tx_retry_failed;
  unsigned long tx_retry_count;
  s8 last_ack_rssi;
  unsigned long backlog_packets;
  unsigned long backlog_bytes;
  unsigned long fcs_error_count;
  unsigned long beacon_loss_count;
  unsigned long expected_throughput;
  unsigned long rx_drop_misc;
  unsigned long rx_mpdus;
  int signal; /* dBm; or -WPA_INVALID_NOISE */
  u8 rx_hemcs;
  u8 tx_hemcs;
  u8 rx_vhtmcs;
  u8 tx_vhtmcs;
  u8 rx_mcs;
  u8 tx_mcs;
  u8 rx_he_nss;
  u8 tx_he_nss;
  u8 rx_vht_nss;
  u8 tx_vht_nss;
  s8 avg_signal; /* dBm */
  s8 avg_beacon_signal; /* dBm */
  s8 avg_ack_signal; /* dBm */
  enum guard_interval rx_guard_interval, tx_guard_interval;
  u8 rx_dcm, tx_dcm;
};

struct hostapd_sta_add_params {
  const u8 *addr;
  u16 aid;
  u16 capability;
  const u8 *supp_rates;
  size_t supp_rates_len;
  u16 listen_interval;
  const struct ieee80211_ht_capabilities *ht_capabilities;
  const struct ieee80211_vht_capabilities *vht_capabilities;
  int vht_opmode_enabled;
  u8 vht_opmode;
  const struct ieee80211_he_capabilities *he_capab;
  size_t he_capab_len;
  const struct ieee80211_he_6ghz_band_cap *he_6ghz_capab;
  const struct ieee80211_eht_capabilities *eht_capab;
  size_t eht_capab_len;
  u32 flags; /* bitmask of WPA_STA_* flags */
  u32 flags_mask; /* unset bits in flags */
#ifdef CONFIG_ENC_ASSOC
  bool epp_sta;
#endif /* CONFIG_ENC_ASSOC */
#ifdef CONFIG_MESH
  enum mesh_plink_state plink_state;
  u16 peer_aid;
#endif /* CONFIG_MESH */
  int set; /* Set STA parameters instead of add */
  u8 qosinfo;
  const u8 *ext_capab;
  size_t ext_capab_len;
  const u8 *supp_channels;
  size_t supp_channels_len;
  const u8 *supp_oper_classes;
  size_t supp_oper_classes_len;
  int support_p2p_ps;

  bool mld_link_sta;
  s8 mld_link_id;
  const u8 *mld_link_addr;
  u16 eml_cap;
};

struct mac_address {
  u8 addr[ETH_ALEN];
};

struct hostapd_acl_params {
  u8 acl_policy;
  unsigned int num_mac_acl;
  struct mac_address mac_acl[0];
};

struct wpa_init_params {
  void *global_priv;
  const u8 *bssid;
  const char *ifname;
  const char *driver_params;
  int use_pae_group_addr;
  char **bridge;
  size_t num_bridge;

  u8 *own_addr; /* buffer for writing own MAC address */
};


struct wpa_bss_params {
  /** Interface name (for multi-SSID/VLAN support) */
  const char *ifname;
  /** Whether IEEE 802.1X or WPA/WPA2 is enabled */
  int enabled;

  int wpa;
  int ieee802_1x;
  int wpa_group;
  int wpa_pairwise;
  int wpa_key_mgmt;
  int rsn_preauth;
  enum mfp_options ieee80211w;
};

#define WPA_STA_AUTHORIZED BIT(0)
#define WPA_STA_WMM BIT(1)
#define WPA_STA_SHORT_PREAMBLE BIT(2)
#define WPA_STA_MFP BIT(3)
#define WPA_STA_TDLS_PEER BIT(4)
#define WPA_STA_AUTHENTICATED BIT(5)
#define WPA_STA_ASSOCIATED BIT(6)
#define WPA_STA_SPP_AMSDU BIT(7)

enum tdls_oper {
  TDLS_DISCOVERY_REQ,
  TDLS_SETUP,
  TDLS_TEARDOWN,
  TDLS_ENABLE_LINK,
  TDLS_DISABLE_LINK,
  TDLS_ENABLE,
  TDLS_DISABLE
};

enum wnm_oper {
  WNM_SLEEP_ENTER_CONFIRM,
  WNM_SLEEP_ENTER_FAIL,
  WNM_SLEEP_EXIT_CONFIRM,
  WNM_SLEEP_EXIT_FAIL,
  WNM_SLEEP_TFS_REQ_IE_ADD,   /* STA requests driver to add TFS req IE */
  WNM_SLEEP_TFS_REQ_IE_NONE,  /* STA requests empty TFS req IE */
  WNM_SLEEP_TFS_REQ_IE_SET,   /* AP requests driver to set TFS req IE for
             * a STA */
  WNM_SLEEP_TFS_RESP_IE_ADD,  /* AP requests driver to add TFS resp IE
             * for a STA */
  WNM_SLEEP_TFS_RESP_IE_NONE, /* AP requests empty TFS resp IE */
  WNM_SLEEP_TFS_RESP_IE_SET,  /* AP requests driver to set TFS resp IE
             * for a STA */
  WNM_SLEEP_TFS_IE_DEL        /* AP delete the TFS IE */
};

/* enum smps_mode - SMPS mode definitions */
enum smps_mode {
  SMPS_AUTOMATIC,
  SMPS_OFF,
  SMPS_DYNAMIC,
  SMPS_STATIC,

  /* Keep last */
  SMPS_INVALID,
};

#define WPA_INVALID_NOISE 9999

/**
 * struct wpa_signal_info - Information about channel signal quality
 * @frequency: control frequency
 * @above_threshold: true if the above threshold was crossed
 *  (relevant for a CQM event)
 * @data: STA information
 * @current_noise: %WPA_INVALID_NOISE if not supported
 * @chanwidth: channel width
 * @center_frq1: center frequency for the first segment
 * @center_frq2: center frequency for the second segment (if relevant)
 */
struct wpa_signal_info {
  u32 frequency;
  int above_threshold;
  struct hostap_sta_driver_data data;
  int current_noise;
  enum chan_width chanwidth;
  int center_frq1;
  int center_frq2;
};

struct wpa_mlo_signal_info {
  u16 valid_links;
  struct wpa_signal_info links[MAX_NUM_MLD_LINKS];
};

/**
 * struct wpa_mlo_reconfig_info - Information about user-requested add and/or
 * remove setup links for the current MLO association.
 *
 * @add_links: Bitmask of links to be added
 * @add_link_bssid: Array of BSSIDs for the links to be added
 * @add_link_freq: Array of frequencies for the links to be added
 * @delete_links: Bitmask of links to be removed
 */
struct wpa_mlo_reconfig_info {
  u16 add_links;
  u8 add_link_bssid[MAX_NUM_MLD_LINKS][ETH_ALEN];
  int add_link_freq[MAX_NUM_MLD_LINKS];
  u16 delete_links;
};

/**
 * struct wpa_channel_info - Information about the current channel
 * @frequency: Center frequency of the primary 20 MHz channel
 * @chanwidth: Width of the current operating channel
 * @sec_channel: Location of the secondary 20 MHz channel (either +1 or -1).
 *  This field is only filled in when using a 40 MHz channel.
 * @center_frq1: Center frequency of frequency segment 0
 * @center_frq2: Center frequency of frequency segment 1 (for 80+80 channels)
 * @seg1_idx: Frequency segment 1 index when using a 80+80 channel. This is
 *  derived from center_frq2 for convenience.
 */
struct wpa_channel_info {
  u32 frequency;
  enum chan_width chanwidth;
  int sec_channel;
  int center_frq1;
  int center_frq2;
  u8 seg1_idx;
};

/**
 * struct beacon_data - Beacon data
 * @head: Head portion of Beacon frame (before TIM IE)
 * @tail: Tail portion of Beacon frame (after TIM IE)
 * @beacon_ies: Extra information element(s) to add into Beacon frames or %NULL
 * @proberesp_ies: Extra information element(s) to add into Probe Response
 *  frames or %NULL
 * @assocresp_ies: Extra information element(s) to add into (Re)Association
 *  Response frames or %NULL
 * @probe_resp: Probe Response frame template
 * @head_len: Length of @head
 * @tail_len: Length of @tail
 * @beacon_ies_len: Length of beacon_ies in octets
 * @proberesp_ies_len: Length of proberesp_ies in octets
 * @proberesp_ies_len: Length of proberesp_ies in octets
 * @probe_resp_len: Length of probe response template (@probe_resp)
 * @mbssid: MBSSID element(s) to add into Beacon frames
 */
struct beacon_data {
  u8 *head, *tail;
  u8 *beacon_ies;
  u8 *proberesp_ies;
  u8 *assocresp_ies;
  u8 *probe_resp;

  size_t head_len, tail_len;
  size_t beacon_ies_len;
  size_t proberesp_ies_len;
  size_t assocresp_ies_len;
  size_t probe_resp_len;

  struct mbssid_data mbssid;
};

/**
 * struct csa_settings - Settings for channel switch command
 * @cs_count: Count in Beacon frames (TBTT) to perform the switch
 * @block_tx: 1 - block transmission for CSA period
 * @freq_params: Next channel frequency parameter
 * @beacon_csa: Beacon/probe resp/asooc resp info for CSA period
 * @beacon_after: Next beacon/probe resp/asooc resp info
 * @counter_offset_beacon: Offset to the count field in beacon's tail
 * @counter_offset_presp: Offset to the count field in probe resp.
 * @link_id: Link ID to determine the link for MLD; -1 for non-MLD
 * @ubpr: Unsolicited broadcast Probe Response frame data
 */
struct csa_settings {
  u8 cs_count;
  u8 block_tx;

  struct hostapd_freq_params freq_params;
  struct beacon_data beacon_csa;
  struct beacon_data beacon_after;

  u16 counter_offset_beacon[2];
  u16 counter_offset_presp[2];

  int link_id;

  struct unsol_bcast_probe_resp ubpr;
};

/**
 * struct cca_settings - Settings for color switch command
 * @cca_count: Count in Beacon frames (TBTT) to perform the switch
 * @cca_color: The new color that we are switching to
 * @beacon_cca: Beacon/Probe Response/(Re)Association Response frame info for
 * color switch period
 * @beacon_after: Next Beacon/Probe Response/(Re)Association Response frame info
 * @counter_offset_beacon: Offset to the count field in Beacon frame tail
 * @counter_offset_presp: Offset to the count field in Probe Response frame
 * @ubpr: Unsolicited broadcast Probe Response frame data
 * @link_id: If >= 0 indicates the link of the AP MLD to configure
 */
struct cca_settings {
  u8 cca_count;
  u8 cca_color;

  struct beacon_data beacon_cca;
  struct beacon_data beacon_after;

  u16 counter_offset_beacon;
  u16 counter_offset_presp;

  struct unsol_bcast_probe_resp ubpr;

  int link_id;
};

/* TDLS peer capabilities for send_tdls_mgmt() */
enum tdls_peer_capability {
  TDLS_PEER_HT = BIT(0),
  TDLS_PEER_VHT = BIT(1),
  TDLS_PEER_WMM = BIT(2),
  TDLS_PEER_HE = BIT(3),
};

/* valid info in the wmm_params struct */
enum wmm_params_valid_info {
  WMM_PARAMS_UAPSD_QUEUES_INFO = BIT(0),
};

/**
 * struct wmm_params - WMM parameterss configured for this association
 * @info_bitmap: Bitmap of valid wmm_params info; indicates what fields
 *  of the struct contain valid information.
 * @uapsd_queues: Bitmap of ACs configured for uapsd (valid only if
 *  %WMM_PARAMS_UAPSD_QUEUES_INFO is set)
 */
struct wmm_params {
  u8 info_bitmap;
  u8 uapsd_queues;
};

#ifdef CONFIG_MACSEC
struct macsec_init_params {
  bool always_include_sci;
  bool use_es;
  bool use_scb;
};
#endif /* CONFIG_MACSEC */

enum drv_br_port_attr {
  DRV_BR_PORT_ATTR_PROXYARP,
  DRV_BR_PORT_ATTR_HAIRPIN_MODE,
  DRV_BR_PORT_ATTR_MCAST2UCAST,
};

enum drv_br_net_param {
  DRV_BR_NET_PARAM_GARP_ACCEPT,
  DRV_BR_MULTICAST_SNOOPING,
};

struct drv_acs_params {
  /* Selected mode (HOSTAPD_MODE_*) */
  enum hostapd_hw_mode hw_mode;

  /* Indicates whether HT is enabled */
  int ht_enabled;

  /* Indicates whether HT40 is enabled */
  int ht40_enabled;

  /* Indicates whether VHT is enabled */
  int vht_enabled;

  /* Configured ACS channel width */
  u16 ch_width;

  /* ACS frequency list info */
  const int *freq_list;

  /* Indicates whether EDMG is enabled */
  int edmg_enabled;

  /* Indicates whether EHT is enabled */
  bool eht_enabled;

  /* Indicates the link if MLO case; -1 otherwise */
  int link_id;
};

struct wpa_bss_trans_info {
  u8 mbo_transition_reason;
  u8 n_candidates;
  u8 *bssid;
};

struct wpa_bss_candidate_info {
  u8 num;
  struct candidate_list {
    u8 bssid[ETH_ALEN];
    u8 is_accept;
    u32 reject_reason;
  } *candidates;
};

struct wpa_pmkid_params {
  const u8 *bssid;
  const u8 *ssid;
  size_t ssid_len;
  const u8 *fils_cache_id;
  const u8 *pmkid;
  const u8 *pmk;
  size_t pmk_len;
  u32 pmk_lifetime;
  u8 pmk_reauth_threshold;
};

/* Mask used to specify which connection parameters have to be updated */
enum wpa_drv_update_connect_params_mask {
  WPA_DRV_UPDATE_ASSOC_IES  = BIT(0),
  WPA_DRV_UPDATE_FILS_ERP_INFO  = BIT(1),
  WPA_DRV_UPDATE_AUTH_TYPE  = BIT(2),
};

/**
 * struct external_auth - External authentication trigger parameters
 *
 * These are used across the external authentication request and event
 * interfaces.
 * @action: Action type / trigger for external authentication. Only significant
 *  for the event interface.
 * @bssid: BSSID of the peer with which the authentication has to happen. Used
 *  by both the request and event interface.
 * @ssid: SSID of the AP. Used by both the request and event interface.
 * @ssid_len: SSID length in octets.
 * @key_mgmt_suite: AKM suite of the respective authentication. Optional for
 *  the request interface.
 * @status: Status code, %WLAN_STATUS_SUCCESS for successful authentication,
 *  use %WLAN_STATUS_UNSPECIFIED_FAILURE if wpa_supplicant cannot give
 *  the real status code for failures. Used only for the request interface
 *  from user space to the driver.
 * @pmkid: Generated PMKID as part of external auth exchange (e.g., SAE).
 * @mld_addr: AP's MLD address or %NULL if MLO is not used
 */
struct external_auth {
  enum {
    EXT_AUTH_START,
    EXT_AUTH_ABORT,
  } action;
  const u8 *bssid;
  const u8 *ssid;
  size_t ssid_len;
  unsigned int key_mgmt_suite;
  u16 status;
  const u8 *pmkid;
  const u8 *mld_addr;
};

#define WPAS_MAX_PASN_PEERS 10

enum pasn_status {
  PASN_STATUS_SUCCESS = 0,
  PASN_STATUS_FAILURE = 1,
};

/**
 * struct pasn_peer - PASN peer parameters
 *
 * Used to process the PASN authentication event from the driver to
 * userspace and to send a response back.
 * @own_addr: Own MAC address specified by the driver to use for PASN
 *  handshake.
 * @peer_addr: MAC address of the peer with which PASN authentication is to be
 *  performed.
 * @network_id: Unique id for the network.
 *  This identifier is used as a unique identifier for each network
 *  block when using the control interface. Each network is allocated an
 *  id when it is being created, either when reading the configuration
 *  file or when a new network is added through the control interface.
 * @akmp: Authentication key management protocol type supported.
 * @cipher: Cipher suite.
 * @group: Finite cyclic group. Default group used is 19 (ECC).
 * @temporary_network: Indicates if a temporary network was created to perform
 *  PASN authentication.
 * @password: Password of user requested network.
 * @comeback_len: Length of the comeback cookie data.
 * @comeback: Comeback cookie data that may be present in case a temporary
 * rejection is received from the AP.
 * @comeback_after: The time after which the STA can try for PASN handshake in
 * case of temporary rejection.
 * @ltf_keyseed_required: Indicates whether LTF keyseed generation is required
 * @status: PASN response status, %PASN_STATUS_SUCCESS for successful
 *  authentication, use %PASN_STATUS_FAILURE if PASN authentication
 *  fails or if wpa_supplicant fails to set the security ranging context to
 *  the driver
 */
struct pasn_peer {
  u8 own_addr[ETH_ALEN];
  u8 peer_addr[ETH_ALEN];
  int network_id;
  int akmp;
  int cipher;
  int group;
  bool temporary_network;
  char *password;
  size_t comeback_len;
  u8 *comeback;
  u16 comeback_after;
  bool ltf_keyseed_required;
  enum pasn_status status;
};

/**
 * struct pasn_auth - PASN authentication trigger parameters
 *
 * These are used across the PASN authentication event from the driver to
 * userspace and to send a response to it.
 * @action: Action type. Only significant for the event interface.
 * @num_peers: The number of peers for which the PASN handshake is requested
 *  for.
 * @peer: Holds the peer details.
 */
struct pasn_auth {
  enum {
    PASN_ACTION_AUTH,
    PASN_ACTION_DELETE_SECURE_RANGING_CONTEXT,
  } action;
  unsigned int num_peers;
  struct pasn_peer peer[WPAS_MAX_PASN_PEERS];
};

/**
 * struct secure_ranging_params - Parameters required to set secure ranging
 *  context for a peer.
 *
 * @action: Add or delete a security context to the driver.
 * @own_addr: Own MAC address used during key derivation.
 * @peer_addr: Address of the peer device.
 * @cipher: Cipher suite.
 * @tk_len: Length of temporal key.
 * @tk: Temporal key buffer.
 * @ltf_keyseed_len: Length of LTF keyseed.
 * @ltf_keyeed: LTF keyseed buffer.
 */
struct secure_ranging_params {
  u32 action;
  const u8 *own_addr;
  const u8 *peer_addr;
  u32 cipher;
  u8 tk_len;
  const u8 *tk;
  u8 ltf_keyseed_len;
  const u8 *ltf_keyseed;
};

/* enum nested_attr - Used to specify if subcommand uses nested attributes */
enum nested_attr {
  NESTED_ATTR_NOT_USED = 0,
  NESTED_ATTR_USED = 1,
  NESTED_ATTR_UNSPECIFIED = 2,
};

/* Preferred channel list information */

/* GO role */
#define WEIGHTED_PCL_GO BIT(0)
/* P2P Client role */
#define WEIGHTED_PCL_CLI BIT(1)
/* Must be considered for operating channel */
#define WEIGHTED_PCL_MUST_CONSIDER BIT(2)
/* Should be excluded in GO negotiation */
#define WEIGHTED_PCL_EXCLUDE BIT(3)

/* Preferred channel list with weight */
struct weighted_pcl {
  u32 freq; /* MHz */
  u8 weight;
  u32 flag; /* bitmap for WEIGHTED_PCL_* */
};

struct driver_sta_mlo_info {
  bool default_map;
  u16 req_links; /* bitmap of requested link IDs */
  u16 valid_links; /* bitmap of accepted link IDs */
  u8 assoc_link_id;
  u8 ap_mld_addr[ETH_ALEN];
  struct {
    u8 addr[ETH_ALEN];
    u8 bssid[ETH_ALEN];
    unsigned int freq;
    struct t2lm_mapping t2lmap;
  } links[MAX_NUM_MLD_LINKS];
};

/**
 * struct nan_band_config - NAN band specific configuration
 *
 * For details on NAN band configuration, see the Wi-Fi Aware Specification
 *
 * @frequency: Frequency in MHz for the band
 * @rssi_close: RSSI close threshold used for NAN state transition algorithm
 * @rssi_middle: RSSI middle threshold used for NAN state transition algorithm
 * @awake_dw_interval: Committed DW information
 * @disable_scan: Disable scan for this band
 */
struct nan_band_config {
  u16 frequency;
  s8 rssi_close;
  s8 rssi_middle;
  u8 awake_dw_interval;
  bool disable_scan;
};

/**
 * struct nan_cluster_config - NAN cluster configuration
 *
 * @master_pref: Master preference for the cluster
 * @dual_band: Dual band operation enabled
 * @enable_dw_notif: Enable discovery window notifications
 * @cluster_id: Cluster ID for the NAN cluster
 * @scan_period: Period for NAN scan in seconds
 * @scan_dwell_time: Dwell time for NAN scan in TUs per channel
 * @discovery_beacon_interval: Interval for discovery beacon in TUs
 * @low_band_cfg: Configuration for low band NAN operation
 * @high_band_cfg: Configuration for high band NAN operation
 * @extra_nan_attrs: Extra NAN attributes to be included in NAN beacons
 * @extra_nan_attrs_len: Length of the extra NAN attributes
 * @vendor_elems: Vendor specific elements to be included in NAN beacons
 * @vendor_elems_len: Length of the vendor specific elements
 */
struct nan_cluster_config {
  u8 master_pref;
  u8 dual_band;
  bool enable_dw_notif;

  u8 cluster_id[ETH_ALEN];
  u16 scan_period;
  u16 scan_dwell_time;
  u8 discovery_beacon_interval;
  struct nan_band_config low_band_cfg;
  struct nan_band_config high_band_cfg;
  const u8 *extra_nan_attrs;
  size_t extra_nan_attrs_len;
  const u8 *vendor_elems;
  size_t vendor_elems_len;
};

/**
 * struct wpa_driver_ops - Driver interface API definition
 *
 * This structure defines the API that each driver interface needs to implement
 * for core wpa_supplicant code. All driver specific functionality is captured
 * in this wrapper.
 */
struct wpa_driver_ops {
  /** Name of the driver interface */
  const char *name;
  /** One line description of the driver interface */
  const char *desc;

  /**
   * get_bssid - Get the current BSSID
   * @priv: private driver interface data
   * @bssid: buffer for BSSID (ETH_ALEN = 6 bytes)
   *
   * Returns: 0 on success, -1 on failure
   *
   * Query kernel driver for the current BSSID and copy it to bssid.
   * Setting bssid to 00:00:00:00:00:00 is recommended if the STA is not
   * associated.
   */
  int (*get_bssid)(void *priv, u8 *bssid);

  /**
   * get_ssid - Get the current SSID
   * @priv: private driver interface data
   * @ssid: buffer for SSID (at least 32 bytes)
   *
   * Returns: Length of the SSID on success, -1 on failure
   *
   * Query kernel driver for the current SSID and copy it to ssid.
   * Returning zero is recommended if the STA is not associated.
   *
   * Note: SSID is an array of octets, i.e., it is not nul terminated and
   * can, at least in theory, contain control characters (including nul)
   * and as such, should be processed as binary data, not a printable
   * string.
   */
  int (*get_ssid)(void *priv, u8 *ssid);

  /**
   * set_key - Configure encryption key
   * @priv: private driver interface data
   * @params: Key parameters
   * Returns: 0 on success, -1 on failure
   *
   * Configure the given key for the kernel driver. If the driver
   * supports separate individual keys (4 default keys + 1 individual),
   * addr can be used to determine whether the key is default or
   * individual. If only 4 keys are supported, the default key with key
   * index 0 is used as the individual key. STA must be configured to use
   * it as the default Tx key (set_tx is set) and accept Rx for all the
   * key indexes. In most cases, WPA uses only key indexes 1 and 2 for
   * broadcast keys, so key index 0 is available for this kind of
   * configuration.
   *
   * For pairwise keys, there are potential race conditions between
   * enabling a new TK on each end of the connection and sending the first
   * protected frame. Drivers have multiple options on which style of key
   * configuration to support with the simplest option not providing any
   * protection for the race condition while the more complex options do
   * provide partial or full protection.
   *
   * Option 1: Do not support extended key IDs (i.e., use only Key ID 0
   * for pairwise keys) and do not support configuration of the next TK
   * as an alternative RX key. This provides no protection, but is simple
   * to support. The driver needs to ignore set_key() calls with
   * KEY_FLAG_NEXT.
   *
   * Option 2: Do not support extended key IDs (i.e., use only Key ID 0
   * for pairwise keys), but support configuration of the next TK as an
   * alternative RX key for the initial 4-way handshake. This provides
   * protection for the initial key setup at the beginning of an
   * association. The driver needs to configure the initial TK for RX-only
   * when receiving a set_key() call with KEY_FLAG_NEXT. This RX-only key
   * is ready for receiving protected Data frames from the peer before the
   * local device has enabled the key for TX. Unprotected EAPOL frames
   * need to be allowed even when this next TK is configured as RX-only
   * key. The same key is then set with KEY_FLAG_PAIRWISE_RX_TX to enable
   * its use for both TX and RX. The driver ignores set_key() calls with
   * KEY_FLAG_NEXT when a TK has been configured. When fully enabling the
   * TK for TX and RX, the RX counters associated with the TK must not be
   * cleared.
   *
   * Option 3: Same as option 2, but the driver supports multiple RX keys
   * in parallel during PTK rekeying. The driver processed set_key() calls
   * with KEY_FLAG_NEXT also when a TK has been configured. At that point
   * in the rekeying sequence the driver uses the previously configured TK
   * for TX and decrypts received frames with either the previously
   * configured TK or the next TK (RX-only).
   *
   * Option 4: The driver supports extended Key IDs and they are used for
   * an association but does not support KEY_FLAG_NEXT (options 2 and 3).
   * The next TK is configured as RX-only with KEY_FLAG_PAIRWISE_RX and
   * it is enabled for TX and RX with KEY_FLAG_PAIRWISE_RX_TX_MODIFY. When
   * extended key ID is not used for an association, the driver behaves
   * like in option 1.
   *
   * Option 5 and 6: Like option 4 but with support for KEY_FLAG_NEXT as
   * described above for options 2 and 3, respectively. Option 4 is used
   * for cases where extended key IDs are used for an association. Option
   * 2 or 3 is used for cases where extended key IDs are not used.
   *
   * Please note that TKIP keys include separate TX and RX MIC keys and
   * some drivers may expect them in different order than wpa_supplicant
   * is using. If the TX/RX keys are swapped, all TKIP encrypted packets
   * will trigger Michael MIC errors. This can be fixed by changing the
   * order of MIC keys by swapping the bytes 16..23 and 24..31 of the key
   * in driver_*.c set_key() implementation, see driver_ndis.c for an
   * example on how this can be done.
   */
  int (*set_key)(void *priv, struct wpa_driver_set_key_params *params);

  /**
   * init - Initialize driver interface
   * @ctx: context to be used when calling wpa_supplicant functions,
   * e.g., wpa_supplicant_event()
   * @ifname: interface name, e.g., wlan0
   *
   * Returns: Pointer to private data, %NULL on failure
   *
   * Initialize driver interface, including event processing for kernel
   * driver events (e.g., associated, scan results, Michael MIC failure).
   * This function can allocate a private configuration data area for
   * @ctx, file descriptor, interface name, etc. information that may be
   * needed in future driver operations. If this is not used, non-NULL
   * value will need to be returned because %NULL is used to indicate
   * failure. The returned value will be used as 'void *priv' data for
   * all other driver_ops functions.
   *
   * The main event loop (eloop.c) of wpa_supplicant can be used to
   * register callback for read sockets (eloop_register_read_sock()).
   *
   * See below for more information about events and
   * wpa_supplicant_event() function.
   */
  void * (*init)(void *ctx, const char *ifname);

  /**
   * deinit - Deinitialize driver interface
   * @priv: private driver interface data from init()
   *
   * Shut down driver interface and processing of driver events. Free
   * private data buffer if one was allocated in init() handler.
   */
  void (*deinit)(void *priv);

  /**
   * set_param - Set driver configuration parameters
   * @priv: private driver interface data from init()
   * @param: driver specific configuration parameters
   *
   * Returns: 0 on success, -1 on failure
   *
   * Optional handler for notifying driver interface about configuration
   * parameters (driver_param).
   */
  int (*set_param)(void *priv, const char *param);

  /**
   * set_countermeasures - Enable/disable TKIP countermeasures
   * @priv: private driver interface data
   * @enabled: 1 = countermeasures enabled, 0 = disabled
   *
   * Returns: 0 on success, -1 on failure
   *
   * Configure TKIP countermeasures. When these are enabled, the driver
   * should drop all received and queued frames that are using TKIP.
   */
  int (*set_countermeasures)(void *priv, int enabled);

  /**
   * deauthenticate - Request driver to deauthenticate
   * @priv: private driver interface data
   * @addr: peer address (BSSID of the AP)
   * @reason_code: 16-bit reason code to be sent in the deauthentication
   *  frame
   *
   * Returns: 0 on success, -1 on failure
   */
  int (*deauthenticate)(void *priv, const u8 *addr, u16 reason_code);

  /**
   * associate - Request driver to associate
   * @priv: private driver interface data
   * @params: association parameters
   *
   * Returns: 0 on success, -1 on failure
   */
  int (*associate)(void *priv,
       struct wpa_driver_associate_params *params);

  /**
   * add_pmkid - Add PMKSA cache entry to the driver
   * @priv: private driver interface data
   * @params: PMKSA parameters
   *
   * Returns: 0 on success, -1 on failure
   *
   * This function is called when a new PMK is received, as a result of
   * either normal authentication or RSN pre-authentication. The PMKSA
   * parameters are either a set of bssid, pmkid, and pmk; or a set of
   * ssid, fils_cache_id, pmkid, and pmk.
   *
   * If the driver generates RSN IE, i.e., it does not use wpa_ie in
   * associate(), add_pmkid() can be used to add new PMKSA cache entries
   * in the driver. If the driver uses wpa_ie from wpa_supplicant, this
   * driver_ops function does not need to be implemented. Likewise, if
   * the driver does not support WPA, this function is not needed.
   */
  int (*add_pmkid)(void *priv, struct wpa_pmkid_params *params);

  /**
   * remove_pmkid - Remove PMKSA cache entry to the driver
   * @priv: private driver interface data
   * @params: PMKSA parameters
   *
   * Returns: 0 on success, -1 on failure
   *
   * This function is called when the supplicant drops a PMKSA cache
   * entry for any reason. The PMKSA parameters are either a set of
   * bssid and pmkid; or a set of ssid, fils_cache_id, and pmkid.
   *
   * If the driver generates RSN IE, i.e., it does not use wpa_ie in
   * associate(), remove_pmkid() can be used to synchronize PMKSA caches
   * between the driver and wpa_supplicant. If the driver uses wpa_ie
   * from wpa_supplicant, this driver_ops function does not need to be
   * implemented. Likewise, if the driver does not support WPA, this
   * function is not needed.
   */
  int (*remove_pmkid)(void *priv, struct wpa_pmkid_params *params);

  /**
   * flush_pmkid - Flush PMKSA cache
   * @priv: private driver interface data
   *
   * Returns: 0 on success, -1 on failure
   *
   * This function is called when the supplicant drops all PMKSA cache
   * entries for any reason.
   *
   * If the driver generates RSN IE, i.e., it does not use wpa_ie in
   * associate(), remove_pmkid() can be used to synchronize PMKSA caches
   * between the driver and wpa_supplicant. If the driver uses wpa_ie
   * from wpa_supplicant, this driver_ops function does not need to be
   * implemented. Likewise, if the driver does not support WPA, this
   * function is not needed.
   */
  int (*flush_pmkid)(void *priv);

  /**
   * get_capa - Get driver capabilities
   * @priv: private driver interface data
   *
   * Returns: 0 on success, -1 on failure
   *
   * Get driver/firmware/hardware capabilities.
   */
  int (*get_capa)(void *priv, struct wpa_driver_capa *capa);

  /**
   * poll - Poll driver for association information
   * @priv: private driver interface data
   *
   * This is an optional callback that can be used when the driver does
   * not provide event mechanism for association events. This is called
   * when receiving WPA/RSN EAPOL-Key messages that require association
   * information. The driver interface is supposed to generate associnfo
   * event before returning from this callback function. In addition, the
   * driver interface should generate an association event after having
   * sent out associnfo.
   */
  void (*poll)(void *priv);

  /**
   * get_ifindex - Get interface index
   * @priv: private driver interface data
   *
   * Returns: Interface index
   */
  unsigned int (*get_ifindex)(void *priv);

  /**
   * get_ifname - Get interface name
   * @priv: private driver interface data
   *
   * Returns: Pointer to the interface name. This can differ from the
   * interface name used in init() call. Init() is called first.
   *
   * This optional function can be used to allow the driver interface to
   * replace the interface name with something else, e.g., based on an
   * interface mapping from a more descriptive name.
   */
  const char * (*get_ifname)(void *priv);

  /**
   * get_mac_addr - Get own MAC address
   * @priv: private driver interface data
   *
   * Returns: Pointer to own MAC address or %NULL on failure
   *
   * This optional function can be used to get the own MAC address of the
   * device from the driver interface code. This is only needed if the
   * l2_packet implementation for the OS does not provide easy access to
   * a MAC address. */
  const u8 * (*get_mac_addr)(void *priv);

  /**
   * set_operstate - Sets device operating state to DORMANT or UP
   * @priv: private driver interface data
   * @state: 0 = dormant, 1 = up
   * Returns: 0 on success, -1 on failure
   *
   * This is an optional function that can be used on operating systems
   * that support a concept of controlling network device state from user
   * space applications. This function, if set, gets called with
   * state = 1 when authentication has been completed and with state = 0
   * when connection is lost.
   */
  int (*set_operstate)(void *priv, int state);

  /**
   * mlme_setprotection - MLME-SETPROTECTION.request primitive
   * @priv: Private driver interface data
   * @addr: Address of the station for which to set protection (may be
   * %NULL for group keys)
   * @protect_type: MLME_SETPROTECTION_PROTECT_TYPE_*
   * @key_type: MLME_SETPROTECTION_KEY_TYPE_*
   * Returns: 0 on success, -1 on failure
   *
   * This is an optional function that can be used to set the driver to
   * require protection for Tx and/or Rx frames. This uses the layer
   * interface defined in IEEE 802.11i-2004 clause 10.3.22.1
   * (MLME-SETPROTECTION.request). Many drivers do not use explicit
   * set protection operation; instead, they set protection implicitly
   * based on configured keys.
   */
  int (*mlme_setprotection)(void *priv, const u8 *addr, int protect_type,
          int key_type);

  /**
   * get_hw_feature_data - Get hardware support data (channels and rates)
   * @priv: Private driver interface data
   * @num_modes: Variable for returning the number of returned modes
   * flags: Variable for returning hardware feature flags
   * @dfs: Variable for returning DFS region (HOSTAPD_DFS_REGION_*)
   * Returns: Pointer to allocated hardware data on success or %NULL on
   * failure. Caller is responsible for freeing this.
   */
  struct hostapd_hw_modes * (*get_hw_feature_data)(void *priv,
               u16 *num_modes,
               u16 *flags, u8 *dfs);

  /**
   * send_mlme - Send management frame from MLME
   * @priv: Private driver interface data
   * @data: IEEE 802.11 management frame with IEEE 802.11 header
   * @data_len: Size of the management frame
   * @noack: Do not wait for this frame to be acked (disable retries)
   * @freq: Frequency (in MHz) to send the frame on, or 0 to let the
   * driver decide
   * @csa_offs: Array of CSA offsets or %NULL
   * @csa_offs_len: Number of elements in csa_offs
   * @no_encrypt: Do not encrypt frame even if appropriate key exists
   *  (used only for testing purposes)
   * @wait: Time to wait off-channel for a response (in ms), or zero
   * @link_id: Link ID to use for TX, or -1 if not set
   * Returns: 0 on success, -1 on failure
   */
  int (*send_mlme)(void *priv, const u8 *data, size_t data_len,
       int noack, unsigned int freq, const u16 *csa_offs,
       size_t csa_offs_len, int no_encrypt,
       unsigned int wait, int link_id);

  /**
   * update_ft_ies - Update FT (IEEE 802.11r) IEs
   * @priv: Private driver interface data
   * @md: Mobility domain (2 octets) (also included inside ies)
   * @ies: FT IEs (MDIE, FTIE, ...) or %NULL to remove IEs
   * @ies_len: Length of FT IEs in bytes
   * Returns: 0 on success, -1 on failure
   *
   * The supplicant uses this callback to let the driver know that keying
   * material for FT is available and that the driver can use the
   * provided IEs in the next message in FT authentication sequence.
   *
   * This function is only needed for driver that support IEEE 802.11r
   * (Fast BSS Transition).
   */
  int (*update_ft_ies)(void *priv, const u8 *md, const u8 *ies,
           size_t ies_len);

  /**
   * get_scan_results - Fetch the latest scan results
   * @priv: Private driver interface data
   * @bssid: Return results only for the specified BSSID, %NULL for all
   *
   * Returns: Allocated buffer of scan results (caller is responsible for
   * freeing the data structure) on success, NULL on failure
   */
  struct wpa_scan_results * (*get_scan_results)(void *priv,
                  const u8 *bssid);

  /**
   * get_scan_results2 - Fetch the latest scan results
   * @priv: private driver interface data
   *
   * Returns: Allocated buffer of scan results (caller is responsible for
   * freeing the data structure) on success, NULL on failure
   */
   struct wpa_scan_results * (*get_scan_results2)(void *priv);

  /**
   * set_country - Set country
   * @priv: Private driver interface data
   * @alpha2: country to which to switch to
   * Returns: 0 on success, -1 on failure
   *
   * This function is for drivers which support some form
   * of setting a regulatory domain.
   */
  int (*set_country)(void *priv, const char *alpha2);

  /**
   * get_country - Get country
   * @priv: Private driver interface data
   * @alpha2: Buffer for returning country code (at least 3 octets)
   * Returns: 0 on success, -1 on failure
   */
  int (*get_country)(void *priv, char *alpha2);

  /**
   * global_init - Global driver initialization
   * @ctx: wpa_global pointer
   * Returns: Pointer to private data (global), %NULL on failure
   *
   * This optional function is called to initialize the driver wrapper
   * for global data, i.e., data that applies to all interfaces. If this
   * function is implemented, global_deinit() will also need to be
   * implemented to free the private data. The driver will also likely
   * use init2() function instead of init() to get the pointer to global
   * data available to per-interface initializer.
   */
  void * (*global_init)(void *ctx);

  /**
   * global_deinit - Global driver deinitialization
   * @priv: private driver global data from global_init()
   *
   * Terminate any global driver related functionality and free the
   * global data structure.
   */
  void (*global_deinit)(void *priv);

  /**
   * init2 - Initialize driver interface (with global data)
   * @ctx: context to be used when calling wpa_supplicant functions,
   * e.g., wpa_supplicant_event()
   * @ifname: interface name, e.g., wlan0
   * @global_priv: private driver global data from global_init()
   * @p2p_mode: P2P mode for a GO (not applicable for other interface
   *  types)
   * Returns: Pointer to private data, %NULL on failure
   *
   * This function can be used instead of init() if the driver wrapper
   * uses global data.
   */
  void * (*init2)(void *ctx, const char *ifname, void *global_priv,
      enum wpa_p2p_mode p2p_mode);

  /**
   * get_interfaces - Get information about available interfaces
   * @global_priv: private driver global data from global_init()
   * Returns: Allocated buffer of interface information (caller is
   * responsible for freeing the data structure) on success, NULL on
   * failure
   */
  struct wpa_interface_info * (*get_interfaces)(void *global_priv);

  /**
   * scan2 - Request the driver to initiate scan
   * @priv: private driver interface data
   * @params: Scan parameters
   *
   * Returns: 0 on success, -1 on failure
   *
   * Once the scan results are ready, the driver should report scan
   * results event for wpa_supplicant which will eventually request the
   * results with wpa_driver_get_scan_results2().
   */
  int (*scan2)(void *priv, struct wpa_driver_scan_params *params);

  /**
   * authenticate - Request driver to authenticate
   * @priv: private driver interface data
   * @params: authentication parameters
   * Returns: 0 on success, -1 on failure
   *
   * This is an optional function that can be used with drivers that
   * support separate authentication and association steps, i.e., when
   * wpa_supplicant can act as the SME. If not implemented, associate()
   * function is expected to take care of IEEE 802.11 authentication,
   * too.
   */
  int (*authenticate)(void *priv,
          struct wpa_driver_auth_params *params);

  /**
   * set_ap - Set Beacon and Probe Response information for AP mode
   * @priv: Private driver interface data
   * @params: Parameters to use in AP mode
   *
   * This function is used to configure Beacon template and/or extra IEs
   * to add for Beacon and Probe Response frames for the driver in
   * AP mode. The driver is responsible for building the full Beacon
   * frame by concatenating the head part with TIM IE generated by the
   * driver/firmware and finishing with the tail part. Depending on the
   * driver architectue, this can be done either by using the full
   * template or the set of additional IEs (e.g., WPS and P2P IE).
   * Similarly, Probe Response processing depends on the driver design.
   * If the driver (or firmware) takes care of replying to Probe Request
   * frames, the extra IEs provided here needs to be added to the Probe
   * Response frames.
   *
   * Returns: 0 on success, -1 on failure
   */
  int (*set_ap)(void *priv, struct wpa_driver_ap_params *params);

  /**
   * set_acl - Set ACL in AP mode
   * @priv: Private driver interface data
   * @params: Parameters to configure ACL
   * Returns: 0 on success, -1 on failure
   *
   * This is used only for the drivers which support MAC address ACL.
   */
  int (*set_acl)(void *priv, struct hostapd_acl_params *params);

  /**
   * hapd_init - Initialize driver interface (hostapd only)
   * @hapd: Pointer to hostapd context
   * @params: Configuration for the driver wrapper
   * Returns: Pointer to private data, %NULL on failure
   *
   * This function is used instead of init() or init2() when the driver
   * wrapper is used with hostapd.
   */
  void * (*hapd_init)(struct hostapd_data *hapd,
          struct wpa_init_params *params);

  /**
   * hapd_deinit - Deinitialize driver interface (hostapd only)
   * @priv: Private driver interface data from hapd_init()
   */
  void (*hapd_deinit)(void *priv);

  /**
   * set_ieee8021x - Enable/disable IEEE 802.1X support (AP only)
   * @priv: Private driver interface data
   * @params: BSS parameters
   * Returns: 0 on success, -1 on failure
   *
   * This is an optional function to configure the kernel driver to
   * enable/disable IEEE 802.1X support and set WPA/WPA2 parameters. This
   * can be left undefined (set to %NULL) if IEEE 802.1X support is
   * always enabled and the driver uses set_ap() to set WPA/RSN IE
   * for Beacon frames.
   *
   * DEPRECATED - use set_ap() instead
   */
  int (*set_ieee8021x)(void *priv, struct wpa_bss_params *params);

  /**
   * set_privacy - Enable/disable privacy (AP only)
   * @priv: Private driver interface data
   * @enabled: 1 = privacy enabled, 0 = disabled
   * Returns: 0 on success, -1 on failure
   *
   * This is an optional function to configure privacy field in the
   * kernel driver for Beacon frames. This can be left undefined (set to
   * %NULL) if the driver uses the Beacon template from set_ap().
   *
   * DEPRECATED - use set_ap() instead
   */
  int (*set_privacy)(void *priv, int enabled);

  /**
   * get_seqnum - Fetch the current TSC/packet number (AP only)
   * @ifname: The interface name (main or virtual)
   * @priv: Private driver interface data
   * @addr: MAC address of the station or %NULL for group keys
   * @idx: Key index
   * @link_id: Link ID for a group key, or -1 if not set
   * @seq: Buffer for returning the latest used TSC/packet number
   * Returns: 0 on success, -1 on failure
   *
   * This function is used to fetch the last used TSC/packet number for
   * a TKIP, CCMP, GCMP, or BIP/IGTK key. It is mainly used with group
   * keys, so there is no strict requirement on implementing support for
   * unicast keys (i.e., addr != %NULL).
   */
  int (*get_seqnum)(const char *ifname, void *priv, const u8 *addr,
        int idx, int link_id, u8 *seq);

  /**
   * flush - Flush all association stations (AP only)
   * @priv: Private driver interface data
   * @link_id: In case of MLO, valid link ID on which all associated
   *  stations will be flushed, -1 otherwise.
   * Returns: 0 on success, -1 on failure
   *
   * This function requests the driver to disassociate all associated
   * stations. This function does not need to be implemented if the
   * driver does not process association frames internally.
   */
  int (*flush)(void *priv, int link_id);

  /**
   * set_generic_elem - Add IEs into Beacon/Probe Response frames (AP)
   * @priv: Private driver interface data
   * @elem: Information elements
   * @elem_len: Length of the elem buffer in octets
   * Returns: 0 on success, -1 on failure
   *
   * This is an optional function to add information elements in the
   * kernel driver for Beacon and Probe Response frames. This can be left
   * undefined (set to %NULL) if the driver uses the Beacon template from
   * set_ap().
   *
   * DEPRECATED - use set_ap() instead
   */
  int (*set_generic_elem)(void *priv, const u8 *elem, size_t elem_len);

  /**
   * read_sta_data - Fetch station data
   * @priv: Private driver interface data
   * @data: Buffer for returning station information
   * @addr: MAC address of the station
   * Returns: 0 on success, -1 on failure
   */
  int (*read_sta_data)(void *priv, struct hostap_sta_driver_data *data,
           const u8 *addr);

  /**
   * tx_control_port - Send a frame over the 802.1X controlled port
   * @priv: Private driver interface data
   * @dest: Destination MAC address
   * @proto: Ethertype in host byte order
   * @buf: Frame payload starting from IEEE 802.1X header
   * @len: Frame payload length
   * @no_encrypt: Do not encrypt frame
   * @link_id: Link ID to use for TX, or -1 if not set
   *
   * Returns 0 on success, else an error
   *
   * This is like a normal Ethernet send except that the driver is aware
   * (by other means than the Ethertype) that this frame is special,
   * and more importantly it gains an ordering between the transmission of
   * the frame and other driver management operations such as key
   * installations. This can be used to work around known limitations in
   * IEEE 802.11 protocols such as race conditions between rekeying 4-way
   * handshake message 4/4 and a PTK being overwritten.
   *
   * This function is only used for a given interface if the driver
   * instance reports WPA_DRIVER_FLAGS_CONTROL_PORT capability. Otherwise,
   * API users will fall back to sending the frame via a normal socket.
   */
  int (*tx_control_port)(void *priv, const u8 *dest,
             u16 proto, const u8 *buf, size_t len,
             int no_encrypt, int link_id);

  /**
   * hapd_send_eapol - Send an EAPOL packet (AP only)
   * @priv: private driver interface data
   * @addr: Destination MAC address
   * @data: EAPOL packet starting with IEEE 802.1X header
   * @data_len: Length of the EAPOL packet in octets
   * @encrypt: Whether the frame should be encrypted
   * @own_addr: Source MAC address
   * @flags: WPA_STA_* flags for the destination station
   * @link_id: Link ID to use for TX, or -1 if not set
   *
   * Returns: 0 on success, -1 on failure
   */
  int (*hapd_send_eapol)(void *priv, const u8 *addr, const u8 *data,
             size_t data_len, int encrypt,
             const u8 *own_addr, u32 flags, int link_id);

  /**
   * sta_deauth - Deauthenticate a station (AP only)
   * @priv: Private driver interface data
   * @own_addr: Source address and BSSID for the Deauthentication frame
   * @addr: MAC address of the station to deauthenticate
   * @reason: Reason code for the Deauthentication frame
   * @link_id: Link ID to use for Deauthentication frame, or -1 if not set
   * Returns: 0 on success, -1 on failure
   *
   * This function requests a specific station to be deauthenticated and
   * a Deauthentication frame to be sent to it.
   */
  int (*sta_deauth)(void *priv, const u8 *own_addr, const u8 *addr,
        u16 reason, int link_id);

  /**
   * sta_disassoc - Disassociate a station (AP only)
   * @priv: Private driver interface data
   * @own_addr: Source address and BSSID for the Disassociation frame
   * @addr: MAC address of the station to disassociate
   * @reason: Reason code for the Disassociation frame
   * @link_id: Link ID to use for Disassociation frame, or -1 if not set
   * Returns: 0 on success, -1 on failure
   *
   * This function requests a specific station to be disassociated and
   * a Disassociation frame to be sent to it.
   */
  int (*sta_disassoc)(void *priv, const u8 *own_addr, const u8 *addr,
          u16 reason, int link_id);

  /**
   * sta_remove - Remove a station entry (AP only)
   * @priv: Private driver interface data
   * @addr: MAC address of the station to be removed
   * Returns: 0 on success, -1 on failure
   */
  int (*sta_remove)(void *priv, const u8 *addr);

  /**
   * hapd_get_ssid - Get the current SSID (AP only)
   * @priv: Private driver interface data
   * @buf: Buffer for returning the SSID
   * @len: Maximum length of the buffer
   * Returns: Length of the SSID on success, -1 on failure
   *
   * This function need not be implemented if the driver uses Beacon
   * template from set_ap() and does not reply to Probe Request frames.
   */
  int (*hapd_get_ssid)(void *priv, u8 *buf, int len);

  /**
   * hapd_set_ssid - Set SSID (AP only)
   * @priv: Private driver interface data
   * @buf: SSID
   * @len: Length of the SSID in octets
   * Returns: 0 on success, -1 on failure
   *
   * DEPRECATED - use set_ap() instead
   */
  int (*hapd_set_ssid)(void *priv, const u8 *buf, int len);

  /**
   * hapd_set_countermeasures - Enable/disable TKIP countermeasures (AP)
   * @priv: Private driver interface data
   * @enabled: 1 = countermeasures enabled, 0 = disabled
   * Returns: 0 on success, -1 on failure
   *
   * This need not be implemented if the driver does not take care of
   * association processing.
   */
  int (*hapd_set_countermeasures)(void *priv, int enabled);

  /**
   * sta_add - Add a station entry
   * @priv: Private driver interface data
   * @params: Station parameters
   * Returns: 0 on success, -1 on failure
   *
   * This function is used to add or set (params->set 1) a station
   * entry in the driver. Adding STA entries is used only if the driver
   * does not take care of association processing.
   *
   * With drivers that don't support full AP client state, this function
   * is used to add a station entry to the driver once the station has
   * completed association.
   *
   * With TDLS, this function is used to add or set (params->set 1)
   * TDLS peer entries (even with drivers that do not support full AP
   * client state).
   */
  int (*sta_add)(void *priv, struct hostapd_sta_add_params *params);

  /**
   * get_inact_sec - Get station inactivity duration (AP only)
   * @priv: Private driver interface data
   * @addr: Station address
   * Returns: Number of seconds station has been inactive, -1 on failure
   */
  int (*get_inact_sec)(void *priv, const u8 *addr);

  /**
   * sta_clear_stats - Clear station statistics (AP only)
   * @priv: Private driver interface data
   * @addr: Station address
   * Returns: 0 on success, -1 on failure
   */
  int (*sta_clear_stats)(void *priv, const u8 *addr);

  /**
   * set_freq - Set channel/frequency (AP only)
   * @priv: Private driver interface data
   * @freq: Channel parameters
   * Returns: 0 on success, -1 on failure
   */
  int (*set_freq)(void *priv, struct hostapd_freq_params *freq);

  /**
   * set_rts - Set RTS threshold
   * @priv: Private driver interface data
   * @rts: RTS threshold in octets
   * Returns: 0 on success, -1 on failure
   */
  int (*set_rts)(void *priv, int rts);

  /**
   * set_frag - Set fragmentation threshold
   * @priv: Private driver interface data
   * @frag: Fragmentation threshold in octets
   * Returns: 0 on success, -1 on failure
   */
  int (*set_frag)(void *priv, int frag);

  /**
   * sta_set_flags - Set station flags (AP only)
   * @priv: Private driver interface data
   * @addr: Station address
   * @total_flags: Bitmap of all WPA_STA_* flags currently set
   * @flags_or: Bitmap of WPA_STA_* flags to add
   * @flags_and: Bitmap of WPA_STA_* flags to us as a mask
   * Returns: 0 on success, -1 on failure
   */
  int (*sta_set_flags)(void *priv, const u8 *addr,
           unsigned int total_flags, unsigned int flags_or,
           unsigned int flags_and);

  /**
   * sta_set_airtime_weight - Set station airtime weight (AP only)
   * @priv: Private driver interface data
   * @addr: Station address
   * @weight: New weight for station airtime assignment
   * Returns: 0 on success, -1 on failure
   */
  int (*sta_set_airtime_weight)(void *priv, const u8 *addr,
              unsigned int weight);

  /**
   * set_tx_queue_params - Set TX queue parameters
   * @priv: Private driver interface data
   * @queue: Queue number (0 = VO, 1 = VI, 2 = BE, 3 = BK)
   * @aifs: AIFS
   * @cw_min: cwMin
   * @cw_max: cwMax
   * @burst_time: Maximum length for bursting in 0.1 msec units
   * @link_id: Link ID to use, or -1 for non MLD.
   */
  int (*set_tx_queue_params)(void *priv, int queue, int aifs, int cw_min,
           int cw_max, int burst_time, int link_id);

  /**
   * if_add - Add a virtual interface
   * @priv: Private driver interface data
   * @type: Interface type
   * @ifname: Interface name for the new virtual interface
   * @addr: Local address to use for the interface or %NULL to use the
   *  parent interface address
   * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
   * @drv_priv: Pointer for overwriting the driver context or %NULL if
   *  not allowed (applies only to %WPA_IF_AP_BSS type)
   * @force_ifname: Buffer for returning an interface name that the
   *  driver ended up using if it differs from the requested ifname
   * @if_addr: Buffer for returning the allocated interface address
   *  (this may differ from the requested addr if the driver cannot
   *  change interface address)
   * @bridge: Bridge interface to use or %NULL if no bridge configured
   * @use_existing: Whether to allow existing interface to be used
   * @setup_ap: Whether to setup AP for %WPA_IF_AP_BSS interfaces
   * Returns: 0 on success, -1 on failure
   */
  int (*if_add)(void *priv, enum wpa_driver_if_type type,
          const char *ifname, const u8 *addr, void *bss_ctx,
          void **drv_priv, char *force_ifname, u8 *if_addr,
          const char *bridge, int use_existing, int setup_ap);

  /**
   * if_remove - Remove a virtual interface
   * @priv: Private driver interface data
   * @type: Interface type
   * @ifname: Interface name of the virtual interface to be removed
   * Returns: 0 on success, -1 on failure
   */
  int (*if_remove)(void *priv, enum wpa_driver_if_type type,
       const char *ifname);

  /**
   * set_sta_vlan - Bind a station into a specific interface (AP only)
   * @priv: Private driver interface data
   * @ifname: Interface (main or virtual BSS or VLAN)
   * @addr: MAC address of the associated station
   * @vlan_id: VLAN ID
   * @link_id: The link ID or -1 for non-MLO
   * Returns: 0 on success, -1 on failure
   *
   * This function is used to bind a station to a specific virtual
   * interface. It is only used if when virtual interfaces are supported,
   * e.g., to assign stations to different VLAN interfaces based on
   * information from a RADIUS server. This allows separate broadcast
   * domains to be used with a single BSS.
   */
  int (*set_sta_vlan)(void *priv, const u8 *addr, const char *ifname,
          int vlan_id, int link_id);

  /**
   * set_radius_acl_auth - Notification of RADIUS ACL change
   * @priv: Private driver interface data
   * @mac: MAC address of the station
   * @accepted: Whether the station was accepted
   * @session_timeout: Session timeout for the station
   * Returns: 0 on success, -1 on failure
   */
  int (*set_radius_acl_auth)(void *priv, const u8 *mac, int accepted,
           u32 session_timeout);

  /**
   * set_radius_acl_expire - Notification of RADIUS ACL expiration
   * @priv: Private driver interface data
   * @mac: MAC address of the station
   * Returns: 0 on success, -1 on failure
   */
  int (*set_radius_acl_expire)(void *priv, const u8 *mac);

  /**
   * set_ap_wps_ie - Add WPS IE(s) into Beacon/Probe Response frames (AP)
   * @priv: Private driver interface data
   * @beacon: WPS IE(s) for Beacon frames or %NULL to remove extra IE(s)
   * @proberesp: WPS IE(s) for Probe Response frames or %NULL to remove
   *  extra IE(s)
   * @assocresp: WPS IE(s) for (Re)Association Response frames or %NULL
   *  to remove extra IE(s)
   * Returns: 0 on success, -1 on failure
   *
   * This is an optional function to add WPS IE in the kernel driver for
   * Beacon and Probe Response frames. This can be left undefined (set
   * to %NULL) if the driver uses the Beacon template from set_ap()
   * and does not process Probe Request frames. If the driver takes care
   * of (Re)Association frame processing, the assocresp buffer includes
   * WPS IE(s) that need to be added to (Re)Association Response frames
   * whenever a (Re)Association Request frame indicated use of WPS.
   *
   * This will also be used to add P2P IE(s) into Beacon/Probe Response
   * frames when operating as a GO. The driver is responsible for adding
   * timing related attributes (e.g., NoA) in addition to the IEs
   * included here by appending them after these buffers. This call is
   * also used to provide Probe Response IEs for P2P Listen state
   * operations for drivers that generate the Probe Response frames
   * internally.
   *
   * DEPRECATED - use set_ap() instead
   */
  int (*set_ap_wps_ie)(void *priv, const struct wpabuf *beacon,
           const struct wpabuf *proberesp,
           const struct wpabuf *assocresp);

  /**
   * set_supp_port - Set IEEE 802.1X Supplicant Port status
   * @priv: Private driver interface data
   * @authorized: Whether the port is authorized
   * Returns: 0 on success, -1 on failure
   */
  int (*set_supp_port)(void *priv, int authorized);

  /**
   * set_wds_sta - Bind a station into a 4-address WDS (AP only)
   * @priv: Private driver interface data
   * @addr: MAC address of the associated station
   * @aid: Association ID
   * @val: 1 = bind to 4-address WDS; 0 = unbind
   * @bridge_ifname: Bridge interface to use for the WDS station or %NULL
   *  to indicate that bridge is not to be used
   * @ifname_wds: Buffer to return the interface name for the new WDS
   *  station or %NULL to indicate name is not returned.
   * Returns: 0 on success, -1 on failure
   */
  int (*set_wds_sta)(void *priv, const u8 *addr, int aid, int val,
         const char *bridge_ifname, char *ifname_wds);

  /**
   * send_action - Transmit an Action frame
   * @priv: Private driver interface data
   * @freq: Frequency (in MHz) of the channel
   * @wait: Time to wait off-channel for a response (in ms), or zero
   * @dst: Destination MAC address (Address 1)
   * @src: Source MAC address (Address 2)
   * @bssid: BSSID (Address 3)
   * @data: Frame body
   * @data_len: data length in octets
   * @no_cck: Whether CCK rates must not be used to transmit this frame
   * @link_id: Link ID of the specified link; -1 for non-MLO cases and for
   *  frames that target the MLD instead of a specific link in MLO
   *  cases
   * Returns: 0 on success, -1 on failure
   *
   * This command can be used to request the driver to transmit an action
   * frame to the specified destination.
   *
   * If the %WPA_DRIVER_FLAGS_OFFCHANNEL_TX flag is set, the frame will
   * be transmitted on the given channel and the device will wait for a
   * response on that channel for the given wait time.
   *
   * If the flag is not set, the wait time will be ignored. In this case,
   * if a remain-on-channel duration is in progress, the frame must be
   * transmitted on that channel; alternatively the frame may be sent on
   * the current operational channel (if in associated state in station
   * mode or while operating as an AP.)
   *
   * If @src differs from the device MAC address, use of a random
   * transmitter address is requested for this message exchange.
   */
  int (*send_action)(void *priv, unsigned int freq, unsigned int wait,
         const u8 *dst, const u8 *src, const u8 *bssid,
         const u8 *data, size_t data_len, int no_cck,
         int link_id);

  /**
   * send_action_cancel_wait - Cancel action frame TX wait
   * @priv: Private driver interface data
   *
   * This command cancels the wait time associated with sending an action
   * frame. It is only available when %WPA_DRIVER_FLAGS_OFFCHANNEL_TX is
   * set in the driver flags.
   */
  void (*send_action_cancel_wait)(void *priv);

  /**
   * remain_on_channel - Remain awake on a channel
   * @priv: Private driver interface data
   * @freq: Frequency (in MHz) of the channel
   * @duration: Duration in milliseconds
   * Returns: 0 on success, -1 on failure
   *
   * This command is used to request the driver to remain awake on the
   * specified channel for the specified duration and report received
   * Action frames with EVENT_RX_MGMT events. Optionally, received
   * Probe Request frames may also be requested to be reported by calling
   * probe_req_report(). These will be reported with EVENT_RX_PROBE_REQ.
   *
   * The driver may not be at the requested channel when this function
   * returns, i.e., the return code is only indicating whether the
   * request was accepted. The caller will need to wait until the
   * EVENT_REMAIN_ON_CHANNEL event indicates that the driver has
   * completed the channel change. This may take some time due to other
   * need for the radio and the caller should be prepared to timing out
   * its wait since there are no guarantees on when this request can be
   * executed.
   */
  int (*remain_on_channel)(void *priv, unsigned int freq,
         unsigned int duration);

  /**
   * cancel_remain_on_channel - Cancel remain-on-channel operation
   * @priv: Private driver interface data
   *
   * This command can be used to cancel a remain-on-channel operation
   * before its originally requested duration has passed. This could be
   * used, e.g., when remain_on_channel() is used to request extra time
   * to receive a response to an Action frame and the response is
   * received when there is still unneeded time remaining on the
   * remain-on-channel operation.
   */
  int (*cancel_remain_on_channel)(void *priv);

  /**
   * probe_req_report - Request Probe Request frames to be indicated
   * @priv: Private driver interface data
   * @report: Whether to report received Probe Request frames
   * Returns: 0 on success, -1 on failure (or if not supported)
   *
   * This command can be used to request the driver to indicate when
   * Probe Request frames are received with EVENT_RX_PROBE_REQ events.
   * Since this operation may require extra resources, e.g., due to less
   * optimal hardware/firmware RX filtering, many drivers may disable
   * Probe Request reporting at least in station mode. This command is
   * used to notify the driver when the Probe Request frames need to be
   * reported, e.g., during remain-on-channel operations.
   */
  int (*probe_req_report)(void *priv, int report);

  /**
   * deinit_ap - Deinitialize AP mode
   * @priv: Private driver interface data
   * Returns: 0 on success, -1 on failure (or if not supported)
   *
   * This optional function can be used to disable AP mode related
   * configuration. If the interface was not dynamically added,
   * change the driver mode to station mode to allow normal station
   * operations like scanning to be completed.
   */
  int (*deinit_ap)(void *priv);

  /**
   * deinit_p2p_cli - Deinitialize P2P client mode
   * @priv: Private driver interface data
   * Returns: 0 on success, -1 on failure (or if not supported)
   *
   * This optional function can be used to disable P2P client mode. If the
   * interface was not dynamically added, change the interface type back
   * to station mode.
   */
  int (*deinit_p2p_cli)(void *priv);

  /**
   * suspend - Notification on system suspend/hibernate event
   * @priv: Private driver interface data
   */
  void (*suspend)(void *priv);

  /**
   * resume - Notification on system resume/thaw event
   * @priv: Private driver interface data
   */
  void (*resume)(void *priv);

  /**
   * signal_monitor - Set signal monitoring parameters
   * @priv: Private driver interface data
   * @threshold: Threshold value for signal change events; 0 = disabled
   * @hysteresis: Minimum change in signal strength before indicating a
   *  new event
   * Returns: 0 on success, -1 on failure (or if not supported)
   *
   * This function can be used to configure monitoring of signal strength
   * with the current AP. Whenever signal strength drops below the
   * %threshold value or increases above it, EVENT_SIGNAL_CHANGE event
   * should be generated assuming the signal strength has changed at
   * least %hysteresis from the previously indicated signal change event.
   */
  int (*signal_monitor)(void *priv, int threshold, int hysteresis);

  /**
   * get_noa - Get current Notice of Absence attribute payload
   * @priv: Private driver interface data
   * @buf: Buffer for returning NoA
   * @buf_len: Buffer length in octets
   * Returns: Number of octets used in buf, 0 to indicate no NoA is being
   * advertized, or -1 on failure
   *
   * This function is used to fetch the current Notice of Absence
   * attribute value from GO.
   */
  int (*get_noa)(void *priv, u8 *buf, size_t buf_len);

  /**
   * set_noa - Set Notice of Absence parameters for GO (testing)
   * @priv: Private driver interface data
   * @count: Count
   * @start: Start time in ms from next TBTT
   * @duration: Duration in ms
   * Returns: 0 on success or -1 on failure
   *
   * This function is used to set Notice of Absence parameters for GO. It
   * is used only for testing. To disable NoA, all parameters are set to
   * 0.
   */
  int (*set_noa)(void *priv, u8 count, int start, int duration);

  /**
   * set_p2p_powersave - Set P2P power save options
   * @priv: Private driver interface data
   * @legacy_ps: 0 = disable, 1 = enable, 2 = maximum PS, -1 = no change
   * @opp_ps: 0 = disable, 1 = enable, -1 = no change
   * @ctwindow: 0.. = change (msec), -1 = no change
   * Returns: 0 on success or -1 on failure
   */
  int (*set_p2p_powersave)(void *priv, int legacy_ps, int opp_ps,
         int ctwindow);

  /**
   * ampdu - Enable/disable aggregation
   * @priv: Private driver interface data
   * @ampdu: 1/0 = enable/disable A-MPDU aggregation
   * Returns: 0 on success or -1 on failure
   */
  int (*ampdu)(void *priv, int ampdu);

  /**
   * get_radio_name - Get physical radio name for the device
   * @priv: Private driver interface data
   * Returns: Radio name or %NULL if not known
   *
   * The returned data must not be modified by the caller. It is assumed
   * that any interface that has the same radio name as another is
   * sharing the same physical radio. This information can be used to
   * share scan results etc. information between the virtual interfaces
   * to speed up various operations.
   */
  const char * (*get_radio_name)(void *priv);

  /**
   * send_tdls_mgmt - for sending TDLS management packets
   * @priv: private driver interface data
   * @dst: Destination (peer) MAC address
   * @action_code: TDLS action code for the mssage
   * @dialog_token: Dialog Token to use in the message (if needed)
   * @status_code: Status Code or Reason Code to use (if needed)
   * @peer_capab: TDLS peer capability (TDLS_PEER_* bitfield)
   * @initiator: Is the current end the TDLS link initiator
   * @buf: TDLS IEs to add to the message
   * @len: Length of buf in octets
   * @link_id: If >= 0 indicates the link of the AP MLD to specify the
   * operating channel on which to send a TDLS Discovery Response frame.
   * Returns: 0 on success, negative (<0) on failure
   *
   * This optional function can be used to send packet to driver which is
   * responsible for receiving and sending all TDLS packets.
   */
  int (*send_tdls_mgmt)(void *priv, const u8 *dst, u8 action_code,
            u8 dialog_token, u16 status_code, u32 peer_capab,
            int initiator, const u8 *buf, size_t len,
            int link_id);

  /**
   * tdls_oper - Ask the driver to perform high-level TDLS operations
   * @priv: Private driver interface data
   * @oper: TDLS high-level operation. See %enum tdls_oper
   * @peer: Destination (peer) MAC address
   * Returns: 0 on success, negative (<0) on failure
   *
   * This optional function can be used to send high-level TDLS commands
   * to the driver.
   */
  int (*tdls_oper)(void *priv, enum tdls_oper oper, const u8 *peer);

  /**
   * wnm_oper - Notify driver of the WNM frame reception
   * @priv: Private driver interface data
   * @oper: WNM operation. See %enum wnm_oper
   * @peer: Destination (peer) MAC address
   * @buf: Buffer for the driver to fill in (for getting IE)
   * @buf_len: Return the len of buf
   * Returns: 0 on success, negative (<0) on failure
   */
  int (*wnm_oper)(void *priv, enum wnm_oper oper, const u8 *peer,
      u8 *buf, u16 *buf_len);

  /**
   * set_qos_map - Set QoS Map
   * @priv: Private driver interface data
   * @qos_map_set: QoS Map
   * @qos_map_set_len: Length of QoS Map
   */
  int (*set_qos_map)(void *priv, const u8 *qos_map_set,
         u8 qos_map_set_len);

  /**
   * br_add_ip_neigh - Add a neigh to the bridge ip neigh table
   * @priv: Private driver interface data
   * @version: IP version of the IP address, 4 or 6
   * @ipaddr: IP address for the neigh entry
   * @prefixlen: IP address prefix length
   * @addr: Corresponding MAC address
   * Returns: 0 on success, negative (<0) on failure
   */
  int (*br_add_ip_neigh)(void *priv, u8 version, const u8 *ipaddr,
             int prefixlen, const u8 *addr);

  /**
   * br_delete_ip_neigh - Remove a neigh from the bridge ip neigh table
   * @priv: Private driver interface data
   * @version: IP version of the IP address, 4 or 6
   * @ipaddr: IP address for the neigh entry
   * Returns: 0 on success, negative (<0) on failure
   */
  int (*br_delete_ip_neigh)(void *priv, u8 version, const u8 *ipaddr);

  /**
   * br_port_set_attr - Set a bridge port attribute
   * @attr: Bridge port attribute to set
   * @val: Value to be set
   * Returns: 0 on success, negative (<0) on failure
   */
  int (*br_port_set_attr)(void *priv, enum drv_br_port_attr attr,
        unsigned int val);

  /**
   * br_port_set_attr - Set a bridge network parameter
   * @param: Bridge parameter to set
   * @val: Value to be set
   * Returns: 0 on success, negative (<0) on failure
   */
  int (*br_set_net_param)(void *priv, enum drv_br_net_param param,
        unsigned int val);

  /**
   * get_wowlan - Get wake-on-wireless status
   * @priv: Private driver interface data
   */
  int (*get_wowlan)(void *priv);

  /**
   * set_wowlan - Set wake-on-wireless triggers
   * @priv: Private driver interface data
   * @triggers: wowlan triggers
   */
  int (*set_wowlan)(void *priv, const struct wowlan_triggers *triggers);

  /**
   * signal_poll - Get current connection information
   * @priv: Private driver interface data
   * @signal_info: Connection info structure
   */
  int (*signal_poll)(void *priv, struct wpa_signal_info *signal_info);

  /**
   * mlo_signal_poll - Get current MLO connection information
   * @priv: Private driver interface data
   * @mlo_signal_info: MLO connection info structure
   */
  int (*mlo_signal_poll)(void *priv,
             struct wpa_mlo_signal_info *mlo_signal_info);

  /**
   * setup_link_reconfig - Used to initiate Link Reconfiguration request
   * for the current MLO association.
   * @priv: Private driver interface data
   * @info: Link reconfiguration request info
   */
  int (*setup_link_reconfig)(void *priv,
           struct wpa_mlo_reconfig_info *info);

  /**
   * channel_info - Get parameters of the current operating channel
   * @priv: Private driver interface data
   * @channel_info: Channel info structure
   * Returns: 0 on success, negative (<0) on failure
   */
  int (*channel_info)(void *priv, struct wpa_channel_info *channel_info);

#ifdef ANDROID
  /**
   * driver_cmd - Execute driver-specific command
   * @priv: Private driver interface data
   * @cmd: Command to execute
   * @buf: Return buffer
   * @buf_len: Buffer length
   * Returns: 0 on success, -1 on failure
   */
  int (*driver_cmd)(void *priv, char *cmd, char *buf, size_t buf_len);
#endif /* ANDROID */

  /**
   * vendor_cmd - Execute vendor specific command
   * @priv: Private driver interface data
   * @vendor_id: Vendor id
   * @subcmd: Vendor command id
   * @nested_attr_flag: Specifies if vendor subcommand uses nested
   *  attributes or not
   * @data: Vendor command parameters (%NULL if no parameters)
   * @data_len: Data length
   * @buf: Return buffer (%NULL to ignore reply)
   * Returns: 0 on success, negative (<0) on failure
   *
   * This function handles vendor specific commands that are passed to
   * the driver/device. The command is identified by vendor id and
   * command id. The nested_attr_flag specifies whether the subcommand
   * uses nested attributes or not. Parameters can be passed
   * as argument to the command in the data buffer. Reply (if any) will be
   * filled in the supplied return buffer.
   *
   * The exact driver behavior is driver interface and vendor specific. As
   * an example, this will be converted to a vendor specific cfg80211
   * command in case of the nl80211 driver interface.
   */
  int (*vendor_cmd)(void *priv, unsigned int vendor_id,
        unsigned int subcmd, const u8 *data, size_t data_len,
        enum nested_attr nested_attr_flag,
        struct wpabuf *buf);

  /**
   * set_rekey_info - Set rekey information
   * @priv: Private driver interface data
   * @kek: Current KEK
   * @kek_len: KEK length in octets
   * @kck: Current KCK
   * @kck_len: KCK length in octets
   * @replay_ctr: Current EAPOL-Key Replay Counter
   *
   * This optional function can be used to provide information for the
   * driver/firmware to process EAPOL-Key frames in Group Key Handshake
   * while the host (including wpa_supplicant) is sleeping.
   */
  void (*set_rekey_info)(void *priv, const u8 *kek, size_t kek_len,
             const u8 *kck, size_t kck_len,
             const u8 *replay_ctr);

  /**
   * sta_assoc - Station association indication
   * @priv: Private driver interface data
   * @own_addr: Source address and BSSID for association frame
   * @addr: MAC address of the station to associate
   * @reassoc: flag to indicate re-association
   * @status: association response status code
   * @ie: assoc response ie buffer
   * @len: ie buffer length
   * Returns: 0 on success, -1 on failure
   *
   * This function indicates the driver to send (Re)Association
   * Response frame to the station.
   */
   int (*sta_assoc)(void *priv, const u8 *own_addr, const u8 *addr,
        int reassoc, u16 status, const u8 *ie, size_t len);

  /**
   * sta_auth - Station authentication indication
   * @priv: private driver interface data
   * @params: Station authentication parameters
   *
   * Returns: 0 on success, -1 on failure
   */
   int (*sta_auth)(void *priv,
       struct wpa_driver_sta_auth_params *params);

  /**
   * add_sta_node - Add a station node in the driver
   * @priv: Private driver interface data
   * @addr: MAC address of the station to add
   * @auth_alg: authentication algorithm used by the station
   * Returns: 0 on success, -1 on failure
   *
   * This function adds the station node in the driver, when
   * the station gets added by FT-over-DS.
   */
  int (*add_sta_node)(void *priv, const u8 *addr, u16 auth_alg);

  /**
   * sched_scan - Request the driver to initiate scheduled scan
   * @priv: Private driver interface data
   * @params: Scan parameters
   * Returns: 0 on success, -1 on failure
   *
   * This operation should be used for scheduled scan offload to
   * the hardware. Every time scan results are available, the
   * driver should report scan results event for wpa_supplicant
   * which will eventually request the results with
   * wpa_driver_get_scan_results2(). This operation is optional
   * and if not provided or if it returns -1, we fall back to
   * normal host-scheduled scans.
   */
  int (*sched_scan)(void *priv, struct wpa_driver_scan_params *params);

  /**
   * stop_sched_scan - Request the driver to stop a scheduled scan
   * @priv: Private driver interface data
   * Returns: 0 on success, -1 on failure
   *
   * This should cause the scheduled scan to be stopped and
   * results should stop being sent. Must be supported if
   * sched_scan is supported.
   */
  int (*stop_sched_scan)(void *priv);

  /**
   * poll_client - Probe (null data or such) the given station
   * @priv: Private driver interface data
   * @own_addr: MAC address of sending interface
   * @addr: MAC address of the station to probe
   * @qos: Indicates whether station is QoS station
   *
   * This function is used to verify whether an associated station is
   * still present. This function does not need to be implemented if the
   * driver provides such inactivity polling mechanism.
   */
  void (*poll_client)(void *priv, const u8 *own_addr,
          const u8 *addr, int qos);

  /**
   * radio_disable - Disable/enable radio
   * @priv: Private driver interface data
   * @disabled: 1=disable 0=enable radio
   * Returns: 0 on success, -1 on failure
   *
   * This optional command is for testing purposes. It can be used to
   * disable the radio on a testbed device to simulate out-of-radio-range
   * conditions.
   */
  int (*radio_disable)(void *priv, int disabled);

  /**
   * switch_channel - Announce channel switch and migrate the GO to the
   * given frequency
   * @priv: Private driver interface data
   * @settings: Settings for CSA period and new channel
   * Returns: 0 on success, -1 on failure
   *
   * This function is used to move the GO to the legacy STA channel to
   * avoid frequency conflict in single channel concurrency.
   */
  int (*switch_channel)(void *priv, struct csa_settings *settings);

  /**
   * switch_color - Announce color switch and migrate the BSS to the
   * given color
   * @priv: Private driver interface data
   * @settings: Settings for CCA period and new color
   * Returns: 0 on success, -1 on failure
   *
   * This function is used to move the BSS to its new color.
   */
  int (*switch_color)(void *priv, struct cca_settings *settings);

  /**
   * add_tx_ts - Add traffic stream
   * @priv: Private driver interface data
   * @tsid: Traffic stream ID
   * @addr: Receiver address
   * @user_prio: User priority of the traffic stream
   * @admitted_time: Admitted time for this TS in units of
   *  32 microsecond periods (per second).
   * Returns: 0 on success, -1 on failure
   */
  int (*add_tx_ts)(void *priv, u8 tsid, const u8 *addr, u8 user_prio,
       u16 admitted_time);

  /**
   * del_tx_ts - Delete traffic stream
   * @priv: Private driver interface data
   * @tsid: Traffic stream ID
   * @addr: Receiver address
   * Returns: 0 on success, -1 on failure
   */
  int (*del_tx_ts)(void *priv, u8 tsid, const u8 *addr);

  /**
   * Enable channel-switching with TDLS peer
   * @priv: Private driver interface data
   * @addr: MAC address of the TDLS peer
   * @oper_class: Operating class of the switch channel
   * @params: Channel specification
   * Returns: 0 on success, -1 on failure
   *
   * The function indicates to driver that it can start switching to a
   * different channel with a specified TDLS peer. The switching is
   * assumed on until canceled with tdls_disable_channel_switch().
   */
  int (*tdls_enable_channel_switch)(
    void *priv, const u8 *addr, u8 oper_class,
    const struct hostapd_freq_params *params);

  /**
   * Disable channel switching with TDLS peer
   * @priv: Private driver interface data
   * @addr: MAC address of the TDLS peer
   * Returns: 0 on success, -1 on failure
   *
   * This function indicates to the driver that it should stop switching
   * with a given TDLS peer.
   */
  int (*tdls_disable_channel_switch)(void *priv, const u8 *addr);

  /**
   * start_dfs_cac - Listen for radar interference on the channel
   * @priv: Private driver interface data
   * @freq: Channel parameters
   * Returns: 0 on success, -1 on failure
   */
  int (*start_dfs_cac)(void *priv, struct hostapd_freq_params *freq);

  /**
   * stop_ap - Removes beacon from AP
   * @priv: Private driver interface data
   * @link_id: Link ID of the specified link; -1 for non-MLD
   * Returns: 0 on success, -1 on failure (or if not supported)
   *
   * This optional function can be used to disable AP mode related
   * configuration. Unlike deinit_ap, it does not change to station
   * mode.
   */
  int (*stop_ap)(void *priv, int link_id);

  /**
   * get_survey - Retrieve survey data
   * @priv: Private driver interface data
   * @freq: If set, survey data for the specified frequency is only
   *  being requested. If not set, all survey data is requested.
   * Returns: 0 on success, -1 on failure
   *
   * Use this to retrieve:
   *
   * - the observed channel noise floor
   * - the amount of time we have spent on the channel
   * - the amount of time during which we have spent on the channel that
   *   the radio has determined the medium is busy and we cannot
   *   transmit
   * - the amount of time we have spent receiving data
   * - the amount of time we have spent transmitting data
   *
   * This data can be used for spectrum heuristics. One example is
   * Automatic Channel Selection (ACS). The channel survey data is
   * kept on a linked list on the channel data, one entry is added
   * for each survey. The min_nf of the channel is updated for each
   * survey.
   */
  int (*get_survey)(void *priv, unsigned int freq);

  /**
   * status - Get driver interface status information
   * @priv: Private driver interface data
   * @buf: Buffer for printing the status information
   * @buflen: Maximum length of the buffer
   * Returns: Length of written status information or -1 on failure
   */
  int (*status)(void *priv, char *buf, size_t buflen);

  /**
   * roaming - Set roaming policy for driver-based BSS selection
   * @priv: Private driver interface data
   * @allowed: Whether roaming within ESS is allowed
   * @bssid: Forced BSSID if roaming is disabled or %NULL if not set
   * Returns: Length of written status information or -1 on failure
   *
   * This optional callback can be used to update roaming policy from the
   * associate() command (bssid being set there indicates that the driver
   * should not roam before getting this roaming() call to allow roaming.
   * If the driver does not indicate WPA_DRIVER_FLAGS_BSS_SELECTION
   * capability, roaming policy is handled within wpa_supplicant and there
   * is no need to implement or react to this callback.
   */
  int (*roaming)(void *priv, int allowed, const u8 *bssid);

  /**
   * disable_fils - Enable/disable FILS feature
   * @priv: Private driver interface data
   * @disable: 0-enable and 1-disable FILS feature
   * Returns: 0 on success, -1 on failure
   *
   * This callback can be used to configure driver and below layers to
   * enable/disable all FILS features.
   */
  int (*disable_fils)(void *priv, int disable);

  /**
   * set_mac_addr - Set MAC address
   * @priv: Private driver interface data
   * @addr: MAC address to use or %NULL for setting back to permanent
   * Returns: 0 on success, -1 on failure
   */
  int (*set_mac_addr)(void *priv, const u8 *addr);

#ifdef CONFIG_MACSEC
  int (*macsec_init)(void *priv, struct macsec_init_params *params);

  int (*macsec_deinit)(void *priv);

  /**
   * macsec_get_capability - Inform MKA of this driver's capability
   * @priv: Private driver interface data
   * @cap: Driver's capability
   * Returns: 0 on success, -1 on failure
   */
  int (*macsec_get_capability)(void *priv, enum macsec_cap *cap);

  /**
   * enable_protect_frames - Set protect frames status
   * @priv: Private driver interface data
   * @enabled: true = protect frames enabled
   *           false = protect frames disabled
   * Returns: 0 on success, -1 on failure (or if not supported)
   */
  int (*enable_protect_frames)(void *priv, bool enabled);

  /**
   * enable_encrypt - Set encryption status
   * @priv: Private driver interface data
   * @enabled: true = encrypt outgoing traffic
   *           false = integrity-only protection on outgoing traffic
   * Returns: 0 on success, -1 on failure (or if not supported)
   */
  int (*enable_encrypt)(void *priv, bool enabled);

  /**
   * set_replay_protect - Set replay protect status and window size
   * @priv: Private driver interface data
   * @enabled: true = replay protect enabled
   *           false = replay protect disabled
   * @window: replay window size, valid only when replay protect enabled
   * Returns: 0 on success, -1 on failure (or if not supported)
   */
  int (*set_replay_protect)(void *priv, bool enabled, u32 window);

  /**
   * set_offload - Set MACsec hardware offload
   * @priv: Private driver interface data
   * @offload: 0 = MACSEC_OFFLOAD_OFF
   *           1 = MACSEC_OFFLOAD_PHY
   *           2 = MACSEC_OFFLOAD_MAC
   * Returns: 0 on success, -1 on failure (or if not supported)
   */
  int (*set_offload)(void *priv, u8 offload);

  /**
   * set_current_cipher_suite - Set current cipher suite
   * @priv: Private driver interface data
   * @cs: EUI64 identifier
   * Returns: 0 on success, -1 on failure (or if not supported)
   */
  int (*set_current_cipher_suite)(void *priv, u64 cs);

  /**
   * enable_controlled_port - Set controlled port status
   * @priv: Private driver interface data
   * @enabled: true = controlled port enabled
   *           false = controlled port disabled
   * Returns: 0 on success, -1 on failure (or if not supported)
   */
  int (*enable_controlled_port)(void *priv, bool enabled);

  /**
   * get_receive_lowest_pn - Get receive lowest pn
   * @priv: Private driver interface data
   * @sa: secure association
   * Returns: 0 on success, -1 on failure (or if not supported)
   */
  int (*get_receive_lowest_pn)(void *priv, struct receive_sa *sa);

  /**
   * get_transmit_next_pn - Get transmit next pn
   * @priv: Private driver interface data
   * @sa: secure association
   * Returns: 0 on success, -1 on failure (or if not supported)
   */
  int (*get_transmit_next_pn)(void *priv, struct transmit_sa *sa);

  /**
   * set_transmit_next_pn - Set transmit next pn
   * @priv: Private driver interface data
   * @sa: secure association
   * Returns: 0 on success, -1 on failure (or if not supported)
   */
  int (*set_transmit_next_pn)(void *priv, struct transmit_sa *sa);

  /**
   * set_receive_lowest_pn - Set receive lowest PN
   * @priv: Private driver interface data
   * @sa: secure association
   * Returns: 0 on success, -1 on failure (or if not supported)
   */
  int (*set_receive_lowest_pn)(void *priv, struct receive_sa *sa);

  /**
   * create_receive_sc - create secure channel for receiving
   * @priv: Private driver interface data
   * @sc: secure channel
   * @conf_offset: confidentiality offset (0, 30, or 50)
   * @validation: frame validation policy (0 = Disabled, 1 = Checked,
   *  2 = Strict)
   * Returns: 0 on success, -1 on failure (or if not supported)
   */
  int (*create_receive_sc)(void *priv, struct receive_sc *sc,
         unsigned int conf_offset,
         int validation);

  /**
   * delete_receive_sc - delete secure connection for receiving
   * @priv: private driver interface data from init()
   * @sc: secure channel
   * Returns: 0 on success, -1 on failure
   */
  int (*delete_receive_sc)(void *priv, struct receive_sc *sc);

  /**
   * create_receive_sa - create secure association for receive
   * @priv: private driver interface data from init()
   * @sa: secure association
   * Returns: 0 on success, -1 on failure
   */
  int (*create_receive_sa)(void *priv, struct receive_sa *sa);

  /**
   * delete_receive_sa - Delete secure association for receive
   * @priv: Private driver interface data from init()
   * @sa: Secure association
   * Returns: 0 on success, -1 on failure
   */
  int (*delete_receive_sa)(void *priv, struct receive_sa *sa);

  /**
   * enable_receive_sa - enable the SA for receive
   * @priv: private driver interface data from init()
   * @sa: secure association
   * Returns: 0 on success, -1 on failure
   */
  int (*enable_receive_sa)(void *priv, struct receive_sa *sa);

  /**
   * disable_receive_sa - disable SA for receive
   * @priv: private driver interface data from init()
   * @sa: secure association
   * Returns: 0 on success, -1 on failure
   */
  int (*disable_receive_sa)(void *priv, struct receive_sa *sa);

  /**
   * create_transmit_sc - create secure connection for transmit
   * @priv: private driver interface data from init()
   * @sc: secure channel
   * @conf_offset: confidentiality offset (0, 30, or 50)
   * Returns: 0 on success, -1 on failure
   */
  int (*create_transmit_sc)(void *priv, struct transmit_sc *sc,
          unsigned int conf_offset);

  /**
   * delete_transmit_sc - delete secure connection for transmit
   * @priv: private driver interface data from init()
   * @sc: secure channel
   * Returns: 0 on success, -1 on failure
   */
  int (*delete_transmit_sc)(void *priv, struct transmit_sc *sc);

  /**
   * create_transmit_sa - create secure association for transmit
   * @priv: private driver interface data from init()
   * @sa: secure association
   * Returns: 0 on success, -1 on failure
   */
  int (*create_transmit_sa)(void *priv, struct transmit_sa *sa);

  /**
   * delete_transmit_sa - Delete secure association for transmit
   * @priv: Private driver interface data from init()
   * @sa: Secure association
   * Returns: 0 on success, -1 on failure
   */
  int (*delete_transmit_sa)(void *priv, struct transmit_sa *sa);

  /**
   * enable_transmit_sa - enable SA for transmit
   * @priv: private driver interface data from init()
   * @sa: secure association
   * Returns: 0 on success, -1 on failure
   */
  int (*enable_transmit_sa)(void *priv, struct transmit_sa *sa);

  /**
   * disable_transmit_sa - disable SA for transmit
   * @priv: private driver interface data from init()
   * @sa: secure association
   * Returns: 0 on success, -1 on failure
   */
  int (*disable_transmit_sa)(void *priv, struct transmit_sa *sa);
#endif /* CONFIG_MACSEC */

  /**
   * init_mesh - Driver specific initialization for mesh
   * @priv: Private driver interface data
   * Returns: 0 on success, -1 on failure
   */
  int (*init_mesh)(void *priv);

  /**
   * join_mesh - Join a mesh network
   * @priv: Private driver interface data
   * @params: Mesh configuration parameters
   * Returns: 0 on success, -1 on failure
   */
  int (*join_mesh)(void *priv,
       struct wpa_driver_mesh_join_params *params);

  /**
   * leave_mesh - Leave a mesh network
   * @priv: Private driver interface data
   * Returns 0 on success, -1 on failure
   */
  int (*leave_mesh)(void *priv);

  /**
   * probe_mesh_link - Inject a frame over direct mesh link to a given
   *  peer skipping the next_hop lookup from mpath table.
   * @priv: Private driver interface data
   * @addr: Peer MAC address
   * @eth: Ethernet frame to be sent
   * @len: Ethernet frame lengtn in bytes
   * Returns 0 on success, -1 on failure
   */
  int (*probe_mesh_link)(void *priv, const u8 *addr, const u8 *eth,
             size_t len);

  /**
   * do_acs - Automatically select channel
   * @priv: Private driver interface data
   * @params: Parameters for ACS
   * Returns 0 on success, -1 on failure
   *
   * This command can be used to offload ACS to the driver if the driver
   * indicates support for such offloading (WPA_DRIVER_FLAGS_ACS_OFFLOAD).
   */
  int (*do_acs)(void *priv, struct drv_acs_params *params);

  /**
   * set_band - Notify driver of band(s) selection
   * @priv: Private driver interface data
   * @band_mask: The selected band(s) bit mask (from enum set_band)
   * Returns 0 on success, -1 on failure
   */
  int (*set_band)(void *priv, u32 band_mask);

  /**
   * get_pref_freq_list - Get preferred frequency list for an interface
   * @priv: Private driver interface data
   * @if_type: Interface type
   * @num: Number of channels
   * @freq_list: Weighted preferred channel list
   * Returns 0 on success, -1 on failure
   *
   * This command can be used to query the preferred frequency list from
   * the driver specific to a particular interface type. The freq_list
   * array needs to have room for *num entries. *num will be updated to
   * indicate the number of entries fetched from the driver.
   */
  int (*get_pref_freq_list)(void *priv, enum wpa_driver_if_type if_type,
          unsigned int *num,
          struct weighted_pcl *freq_list);

  /**
   * set_prob_oper_freq - Indicate probable P2P operating channel
   * @priv: Private driver interface data
   * @freq: Channel frequency in MHz
   * Returns 0 on success, -1 on failure
   *
   * This command can be used to inform the driver of the operating
   * frequency that an ongoing P2P group formation is likely to come up
   * on. Local device is assuming P2P Client role.
   */
  int (*set_prob_oper_freq)(void *priv, unsigned int freq);

  /**
   * abort_scan - Request the driver to abort an ongoing scan
   * @priv: Private driver interface data
   * @scan_cookie: Cookie identifying the scan request. This is used only
   *  when the vendor interface QCA_NL80211_VENDOR_SUBCMD_TRIGGER_SCAN
   *  was used to trigger scan. Otherwise, 0 is used.
   * Returns 0 on success, -1 on failure
   */
  int (*abort_scan)(void *priv, u64 scan_cookie);

  /**
   * configure_data_frame_filters - Request to configure frame filters
   * @priv: Private driver interface data
   * @filter_flags: The type of frames to filter (bitfield of
   * WPA_DATA_FRAME_FILTER_FLAG_*)
   * Returns: 0 on success or -1 on failure
   */
  int (*configure_data_frame_filters)(void *priv, u32 filter_flags);

  /**
   * get_ext_capab - Get extended capabilities for the specified interface
   * @priv: Private driver interface data
   * @type: Interface type for which to get extended capabilities
   * @ext_capab: Extended capabilities fetched
   * @ext_capab_mask: Extended capabilities mask
   * @ext_capab_len: Length of the extended capabilities
   * Returns: 0 on success or -1 on failure
   */
  int (*get_ext_capab)(void *priv, enum wpa_driver_if_type type,
           const u8 **ext_capab, const u8 **ext_capab_mask,
           unsigned int *ext_capab_len);

  /**
   * get_mld_capab - Get MLD capabilities for the specified interface
   * @priv: Private driver interface data
   * @type: Interface type for which to get MLD capabilities
   * @eml_capa: EML capabilities
   * @mld_capa_and_ops: MLD Capabilities and Operations
   * Returns: 0 on success or -1 on failure
   */
  int (*get_mld_capab)(void *priv, enum wpa_driver_if_type type,
           u16 *eml_capa, u16 *mld_capa_and_ops);

  /**
   * p2p_lo_start - Start offloading P2P listen to device
   * @priv: Private driver interface data
   * @freq: Listening frequency (MHz) for P2P listen
   * @period: Length of the listen operation in milliseconds
   * @interval: Interval for running the listen operation in milliseconds
   * @count: Number of times to run the listen operation
   * @device_types: Device primary and secondary types
   * @dev_types_len: Number of bytes for device_types
   * @ies: P2P IE and WSC IE for Probe Response frames
   * @ies_len: Length of ies in bytes
   * Returns: 0 on success or -1 on failure
   */
  int (*p2p_lo_start)(void *priv, unsigned int freq,
          unsigned int period, unsigned int interval,
          unsigned int count,
          const u8 *device_types, size_t dev_types_len,
          const u8 *ies, size_t ies_len);

  /**
   * p2p_lo_stop - Stop P2P listen offload
   * @priv: Private driver interface data
   * Returns: 0 on success or -1 on failure
   */
  int (*p2p_lo_stop)(void *priv);

  /**
   * set_default_scan_ies - Set default scan IEs
   * @priv: Private driver interface data
   * @ies: Scan default IEs buffer
   * @ies_len: Length of IEs in bytes
   * Returns: 0 on success or -1 on failure
   *
   * The driver can use these by default when there are no scan IEs coming
   * in the subsequent scan requests. Also in case of one or more of IEs
   * given in set_default_scan_ies() are missing in the subsequent scan
   * request, the driver should merge the missing scan IEs in the scan
   * request from the IEs set by set_default_scan_ies() in the Probe
   * Request frames sent.
   */
  int (*set_default_scan_ies)(void *priv, const u8 *ies, size_t ies_len);

  /**
   * set_tdls_mode - Set TDLS trigger mode to the host driver
   * @priv: Private driver interface data
   * @tdls_external_control: Represents if TDLS external trigger control
   *  mode is enabled/disabled.
   *
   * This optional callback can be used to configure the TDLS external
   * trigger control mode to the host driver.
   */
  int (*set_tdls_mode)(void *priv, int tdls_external_control);

  /**
   * get_bss_transition_status - Get candidate BSS's transition status
   * @priv: Private driver interface data
   * @params: Candidate BSS list
   *
   * Get the accept or reject reason code for a list of BSS transition
   * candidates.
   */
  struct wpa_bss_candidate_info *
  (*get_bss_transition_status)(void *priv,
             struct wpa_bss_trans_info *params);
  /**
   * ignore_assoc_disallow - Configure driver to ignore assoc_disallow
   * @priv: Private driver interface data
   * @ignore_disallow: 0 to not ignore, 1 to ignore
   * Returns: 0 on success, -1 on failure
   */
  int (*ignore_assoc_disallow)(void *priv, int ignore_disallow);

  /**
   * set_bssid_tmp_disallow - Set disallowed BSSIDs to the driver
   * @priv: Private driver interface data
   * @num_bssid: Number of temporarily disallowed BSSIDs
   * @bssids: List of temporarily disallowed BSSIDs
   */
  int (*set_bssid_tmp_disallow)(void *priv, unsigned int num_bssid,
              const u8 *bssid);

  /**
   * update_connect_params - Update the connection parameters
   * @priv: Private driver interface data
   * @params: Association parameters
   * @mask: Bit mask indicating which parameters in @params have to be
   *  updated
   * Returns: 0 on success, -1 on failure
   *
   * Update the connection parameters when in connected state so that the
   * driver uses the updated parameters for subsequent roaming. This is
   * used only with drivers that implement internal BSS selection and
   * roaming.
   */
  int (*update_connect_params)(
    void *priv, struct wpa_driver_associate_params *params,
    enum wpa_drv_update_connect_params_mask mask);

  /**
   * send_external_auth_status - Indicate the status of external
   * authentication processing to the host driver.
   * @priv: Private driver interface data
   * @params: Status of authentication processing.
   * Returns: 0 on success, -1 on failure
   */
  int (*send_external_auth_status)(void *priv,
           struct external_auth *params);

  /**
   * set_4addr_mode - Set 4-address mode
   * @priv: Private driver interface data
   * @bridge_ifname: Bridge interface name
   * @val: 0 - disable 4addr mode, 1 - enable 4addr mode
   * Returns: 0 on success, < 0 on failure
   */
  int (*set_4addr_mode)(void *priv, const char *bridge_ifname, int val);

  /**
   * update_dh_ie - Update DH IE
   * @priv: Private driver interface data
   * @peer_mac: Peer MAC address
   * @reason_code: Reacon code
   * @ie: DH IE
   * @ie_len: DH IE length in bytes
   * Returns: 0 on success, -1 on failure
   *
   * This callback is used to let the driver know the DH processing result
   * and DH IE for a pending association.
   */
  int (*update_dh_ie)(void *priv, const u8 *peer_mac, u16 reason_code,
          const u8 *ie, size_t ie_len);

  /**
   * dpp_listen - Notify driver about start/stop of DPP listen
   * @priv: Private driver interface data
   * @enable: Whether listen state is enabled (or disabled)
   * Returns: 0 on success, -1 on failure
   *
   * This optional callback can be used to update RX frame filtering to
   * explicitly allow reception of broadcast Public Action frames.
   */
  int (*dpp_listen)(void *priv, bool enable);

  /**
   * set_secure_ranging_ctx - Add or delete secure ranging parameters of
   * the specified peer to the driver.
   * @priv: Private driver interface data
   * @params: Secure ranging parameters
   * Returns: 0 on success, -1 on failure
   *
   */
  int (*set_secure_ranging_ctx)(void *priv,
              struct secure_ranging_params *params);

  /**
   * send_pasn_resp - Send PASN response for a set of peers to the
   * driver.
   * @priv: Private driver interface data
   * @params: Parameters holding peers and respective status.
   * Returns: 0 on success, -1 on failure
   */
  int (*send_pasn_resp)(void *priv, struct pasn_auth *params);

  /**
   * get_sta_mlo_info - Get the current multi-link association info
   * @priv: Private driver interface data
   * @mlo: Pointer to fill multi-link association info
   * Returns: 0 on success, -1 on failure
   *
   * This callback is used to fetch multi-link of the current association.
   */
  int (*get_sta_mlo_info)(void *priv,
        struct driver_sta_mlo_info *mlo_info);

  /**
   * link_add - Add a link to the AP MLD interface
   * @priv: Private driver interface data
   * @link_id: The link ID
   * @addr: The MAC address to use for the link
   * @bss_ctx: BSS context for %WPA_IF_AP_BSS interfaces
   * Returns: 0 on success, negative value on failure
   */
  int (*link_add)(void *priv, u8 link_id, const u8 *addr, void *bss_ctx);

  /**
   * link_remove - Remove a link from the AP MLD interface
   * @priv: Private driver interface data
   * @type: Interface type
   * @ifname: Interface name of the virtual interface from where the link
   *  is to be removed.
   * @link_id: Valid link ID to remove
   * Returns: 0 on success, -1 on failure
   */
  int (*link_remove)(void *priv, enum wpa_driver_if_type type,
         const char *ifname, u8 link_id);

  /**
   * is_drv_shared - Check whether the driver interface is shared
   * @priv: Private driver interface data from init()
   * @link_id: Link ID to match
   * Returns: true if it is being used or else false.
   *
   * Checks whether the driver interface is being used by other partner
   * BSS(s) or not. This is used to decide whether the driver interface
   * needs to be deinitilized when one interface is getting deinitialized.
   *
   * NOTE: @link_id will be used only when there is only one BSS
   * present and if that single link is active. In that case, the
   * link ID is matched with the active link_id to decide whether the
   * driver interface is being used by other partner BSS(s).
   */
  bool (*is_drv_shared)(void *priv, int link_id);

  /**
   * link_sta_remove - Remove a link STA from an MLD STA
   * @priv: Private driver interface data
   * @link_id: The link ID which the link STA is using
   * @addr: The MLD MAC address of the MLD STA
   * Returns: 0 on success, negative value on failure
   */
  int (*link_sta_remove)(void *priv, u8 link_id, const u8 *addr);

  /**
   * nan_flush - Flush all NAN offload services
   * @priv: Private driver interface data
   * Returns: 0 on success, negative value on failure
   */
  int (*nan_flush)(void *priv);

  /**
   * nan_publish - NAN offload for Publish()
   * @priv: Private driver interface data
   * @src: Source P2P device addr
   * @publish_id: Publish instance to add
   * @service_name: Service name
   * @service_id: Service ID (6 octet value derived from service name)
   * @srv_proto_type: Service protocol type
   * @ssi: Service specific information or %NULL
   * @elems: Information elements for Element Container attribute or %NULL
   * @params: Configuration parameters
   * Returns: 0 on success, negative value on failure
   */
  int (*nan_publish)(void *priv, const u8 *src, int publish_id,
         const char *service_name, const u8 *service_id,
         enum nan_service_protocol_type srv_proto_type,
         const struct wpabuf *ssi, const struct wpabuf *elems,
         struct nan_publish_params *params);

  /**
   * nan_cancel_publish - NAN offload for CancelPublish()
   * @priv: Private driver interface data
   * @publish_id: Publish instance to cancel
   * Returns: 0 on success, negative value on failure
   */
  int (*nan_cancel_publish)(void *priv, int publish_id);

  /**
   * nan_update_publish - NAN offload for UpdatePublish()
   * @priv: Private driver interface data
   * @ssi: Service specific information or %NULL
   * Returns: 0 on success, negative value on failure
   */
  int (*nan_update_publish)(void *priv, int publish_id,
          const struct wpabuf *ssi);

  /**
   * nan_subscribe - NAN offload for Subscribe()
   * @priv: Private driver interface data
   * @src: Source P2P device addr
   * @subscribe_id: Subscribe instance to add
   * @service_name: Service name
   * @service_id: Service ID (6 octet value derived from service name)
   * @srv_proto_type: Service protocol type
   * @ssi: Service specific information or %NULL
   * @elems: Information elements for Element Container attribute or %NULL
   * @params: Configuration parameters
   * Returns: 0 on success, negative value on failure
   */
  int (*nan_subscribe)(void *priv, const u8 *src, int subscribe_id,
           const char *service_name, const u8 *service_id,
           enum nan_service_protocol_type srv_proto_type,
           const struct wpabuf *ssi,
           const struct wpabuf *elems,
           struct nan_subscribe_params *params);

  /**
   * nan_cancel_subscribe - NAN offload for CancelSubscribe()
   * @priv: Private driver interface data
   * @subscribe_id: Subscribe instance to cancel
   * Returns: 0 on success, negative value on failure
   */
  int (*nan_cancel_subscribe)(void *priv, int subscribe_id);

  /**
   * can_share_drv - Check whether driver interface can be shared
   * @ctx: Pointer to hostapd context
   * @params: Configuration for the driver wrapper
   * @hapd: Pointer for overwriting the hapd context or %NULL
   *  if can't find a shared drv
   *
   * Checks whether the driver interface with same phy name is
   * already present under the global driver which can be shared
   * instead of creating a new driver interface instance. If present,
   * @hapd will be overwritten with the hapd pointer which this shared
   * drv's first BSS is using. This will help the caller to later call
   * if_add().
   *
   * Returns: true if it can be shared or else false.
   */
  bool (*can_share_drv)(void *ctx, struct wpa_init_params *params,
            void **hapd);

#ifdef CONFIG_TESTING_OPTIONS
  int (*register_frame)(void *priv, u16 type,
            const u8 *match, size_t match_len,
            bool multicast);
#endif /* CONFIG_TESTING_OPTIONS */

  /**
   * get_multi_hw_info - Get multiple underlying hardware information
   *           (hardware IDx and supported frequency range)
   * @priv: Private driver interface data
   * @num_multi_hws: Variable for returning the number of returned
   *  hardware info data
   * Returns: Pointer to allocated multiple hardware data on success
   * or %NULL on failure. Caller is responsible for freeing this.
   */
  struct hostapd_multi_hw_info *
  (*get_multi_hw_info)(void *priv, unsigned int *num_multi_hws);

#ifdef CONFIG_NAN
  /**
   * nan_start - Start NAN operation
   * @priv: Private driver interface data
   * @conf: NAN configuration parameters
   * Returns: 0 on success, -1 on failure
   *
   * This command joins an existing NAN cluster or starts a new one.
   */
  int (*nan_start)(void *priv, const struct nan_cluster_config *conf);

  /**
   * nan_change_config - Update the NAN cluster configuration
   * @priv: Private driver interface data
   * @conf: NAN configuration parameters
   * Returns: 0 on success, -1 on failure
   *
   * This command modifies the NAN cluster configuration.
   */
  int (*nan_change_config)(void *priv,
         const struct nan_cluster_config *conf);

  /**
   * nan_stop - Stop NAN operation
   * @priv: Private driver interface data
   */
  void (*nan_stop)(void *priv);
#endif /* CONFIG_NAN */
};

/**
 * enum wpa_event_type - Event type for wpa_supplicant_event() calls
 */
enum wpa_event_type {
  /**
   * EVENT_ASSOC - Association completed
   *
   * This event needs to be delivered when the driver completes IEEE
   * 802.11 association or reassociation successfully.
   * wpa_driver_ops::get_bssid() is expected to provide the current BSSID
   * after this event has been generated. In addition, optional
   * EVENT_ASSOCINFO may be generated just before EVENT_ASSOC to provide
   * more information about the association. If the driver interface gets
   * both of these events at the same time, it can also include the
   * assoc_info data in EVENT_ASSOC call.
   */
  EVENT_ASSOC,

  /**
   * EVENT_DISASSOC - Association lost
   *
   * This event should be called when association is lost either due to
   * receiving deauthenticate or disassociate frame from the AP or when
   * sending either of these frames to the current AP. If the driver
   * supports separate deauthentication event, EVENT_DISASSOC should only
   * be used for disassociation and EVENT_DEAUTH for deauthentication.
   * In AP mode, union wpa_event_data::disassoc_info is required.
   */
  EVENT_DISASSOC,

  /**
   * EVENT_MICHAEL_MIC_FAILURE - Michael MIC (TKIP) detected
   *
   * This event must be delivered when a Michael MIC error is detected by
   * the local driver. Additional data for event processing is
   * provided with union wpa_event_data::michael_mic_failure. This
   * information is used to request new encryption key and to initiate
   * TKIP countermeasures if needed.
   */
  EVENT_MICHAEL_MIC_FAILURE,

  /**
   * EVENT_SCAN_RESULTS - Scan results available
   *
   * This event must be called whenever scan results are available to be
   * fetched with struct wpa_driver_ops::get_scan_results(). This event
   * is expected to be used some time after struct wpa_driver_ops::scan()
   * is called. If the driver provides an unsolicited event when the scan
   * has been completed, this event can be used to trigger
   * EVENT_SCAN_RESULTS call. If such event is not available from the
   * driver, the driver wrapper code is expected to use a registered
   * timeout to generate EVENT_SCAN_RESULTS call after the time that the
   * scan is expected to be completed. Optional information about
   * completed scan can be provided with union wpa_event_data::scan_info.
   */
  EVENT_SCAN_RESULTS,

  /**
   * EVENT_ASSOCINFO - Report optional extra information for association
   *
   * This event can be used to report extra association information for
   * EVENT_ASSOC processing. This extra information includes IEs from
   * association frames and Beacon/Probe Response frames in union
   * wpa_event_data::assoc_info. EVENT_ASSOCINFO must be send just before
   * EVENT_ASSOC. Alternatively, the driver interface can include
   * assoc_info data in the EVENT_ASSOC call if it has all the
   * information available at the same point.
   */
  EVENT_ASSOCINFO,

  /**
   * EVENT_INTERFACE_STATUS - Report interface status changes
   *
   * This optional event can be used to report changes in interface
   * status (interface added/removed) using union
   * wpa_event_data::interface_status. This can be used to trigger
   * wpa_supplicant to stop and re-start processing for the interface,
   * e.g., when a cardbus card is ejected/inserted.
   */
  EVENT_INTERFACE_STATUS,

  /**
   * EVENT_PMKID_CANDIDATE - Report a candidate AP for pre-authentication
   *
   * This event can be used to inform wpa_supplicant about candidates for
   * RSN (WPA2) pre-authentication. If wpa_supplicant is not responsible
   * for scan request (ap_scan=2 mode), this event is required for
   * pre-authentication. If wpa_supplicant is performing scan request
   * (ap_scan=1), this event is optional since scan results can be used
   * to add pre-authentication candidates. union
   * wpa_event_data::pmkid_candidate is used to report the BSSID of the
   * candidate and priority of the candidate, e.g., based on the signal
   * strength, in order to try to pre-authenticate first with candidates
   * that are most likely targets for re-association.
   *
   * EVENT_PMKID_CANDIDATE can be called whenever the driver has updates
   * on the candidate list. In addition, it can be called for the current
   * AP and APs that have existing PMKSA cache entries. wpa_supplicant
   * will automatically skip pre-authentication in cases where a valid
   * PMKSA exists. When more than one candidate exists, this event should
   * be generated once for each candidate.
   *
   * Driver will be notified about successful pre-authentication with
   * struct wpa_driver_ops::add_pmkid() calls.
   */
  EVENT_PMKID_CANDIDATE,

  /**
   * EVENT_TDLS - Request TDLS operation
   *
   * This event can be used to request a TDLS operation to be performed.
   */
  EVENT_TDLS,

  /**
   * EVENT_FT_RESPONSE - Report FT (IEEE 802.11r) response IEs
   *
   * The driver is expected to report the received FT IEs from
   * FT authentication sequence from the AP. The FT IEs are included in
   * the extra information in union wpa_event_data::ft_ies.
   */
  EVENT_FT_RESPONSE,

  /**
   * EVENT_IBSS_RSN_START - Request RSN authentication in IBSS
   *
   * The driver can use this event to inform wpa_supplicant about a STA
   * in an IBSS with which protected frames could be exchanged. This
   * event starts RSN authentication with the other STA to authenticate
   * the STA and set up encryption keys with it.
   */
  EVENT_IBSS_RSN_START,

  /**
   * EVENT_AUTH - Authentication result
   *
   * This event should be called when authentication attempt has been
   * completed. This is only used if the driver supports separate
   * authentication step (struct wpa_driver_ops::authenticate).
   * Information about authentication result is included in
   * union wpa_event_data::auth.
   */
  EVENT_AUTH,

  /**
   * EVENT_DEAUTH - Authentication lost
   *
   * This event should be called when authentication is lost either due
   * to receiving deauthenticate frame from the AP or when sending that
   * frame to the current AP.
   * In AP mode, union wpa_event_data::deauth_info is required.
   */
  EVENT_DEAUTH,

  /**
   * EVENT_ASSOC_REJECT - Association rejected
   *
   * This event should be called when (re)association attempt has been
   * rejected by the AP. Information about the association response is
   * included in union wpa_event_data::assoc_reject.
   */
  EVENT_ASSOC_REJECT,

  /**
   * EVENT_AUTH_TIMED_OUT - Authentication timed out
   */
  EVENT_AUTH_TIMED_OUT,

  /**
   * EVENT_ASSOC_TIMED_OUT - Association timed out
   */
  EVENT_ASSOC_TIMED_OUT,

  /**
   * EVENT_WPS_BUTTON_PUSHED - Report hardware push button press for WPS
   */
  EVENT_WPS_BUTTON_PUSHED,

  /**
   * EVENT_TX_STATUS - Report TX status
   */
  EVENT_TX_STATUS,

  /**
   * EVENT_RX_FROM_UNKNOWN - Report RX from unknown STA
   */
  EVENT_RX_FROM_UNKNOWN,

  /**
   * EVENT_RX_MGMT - Report RX of a management frame
   */
  EVENT_RX_MGMT,

  /**
   * EVENT_REMAIN_ON_CHANNEL - Remain-on-channel duration started
   *
   * This event is used to indicate when the driver has started the
   * requested remain-on-channel duration. Information about the
   * operation is included in union wpa_event_data::remain_on_channel.
   */
  EVENT_REMAIN_ON_CHANNEL,

  /**
   * EVENT_CANCEL_REMAIN_ON_CHANNEL - Remain-on-channel timed out
   *
   * This event is used to indicate when the driver has completed
   * remain-on-channel duration, i.e., may noot be available on the
   * requested channel anymore. Information about the
   * operation is included in union wpa_event_data::remain_on_channel.
   */
  EVENT_CANCEL_REMAIN_ON_CHANNEL,

  /**
   * EVENT_RX_PROBE_REQ - Indicate received Probe Request frame
   *
   * This event is used to indicate when a Probe Request frame has been
   * received. Information about the received frame is included in
   * union wpa_event_data::rx_probe_req. The driver is required to report
   * these events only after successfully completed probe_req_report()
   * commands to request the events (i.e., report parameter is non-zero)
   * in station mode. In AP mode, Probe Request frames should always be
   * reported.
   */
  EVENT_RX_PROBE_REQ,

  /**
   * EVENT_NEW_STA - New wired device noticed
   *
   * This event is used to indicate that a new device has been detected
   * in a network that does not use association-like functionality (i.e.,
   * mainly wired Ethernet). This can be used to start EAPOL
   * authenticator when receiving a frame from a device. The address of
   * the device is included in union wpa_event_data::new_sta.
   */
  EVENT_NEW_STA,

  /**
   * EVENT_EAPOL_RX - Report received EAPOL frame
   *
   * When in AP mode with hostapd, this event is required to be used to
   * deliver the receive EAPOL frames from the driver.
   */
  EVENT_EAPOL_RX,

  /**
   * EVENT_SIGNAL_CHANGE - Indicate change in signal strength
   *
   * This event is used to indicate changes in the signal strength
   * observed in frames received from the current AP if signal strength
   * monitoring has been enabled with signal_monitor().
   */
  EVENT_SIGNAL_CHANGE,

  /**
   * EVENT_INTERFACE_ENABLED - Notify that interface was enabled
   *
   * This event is used to indicate that the interface was enabled after
   * having been previously disabled, e.g., due to rfkill.
   */
  EVENT_INTERFACE_ENABLED,

  /**
   * EVENT_INTERFACE_DISABLED - Notify that interface was disabled
   *
   * This event is used to indicate that the interface was disabled,
   * e.g., due to rfkill.
   */
  EVENT_INTERFACE_DISABLED,

  /**
   * EVENT_CHANNEL_LIST_CHANGED - Channel list changed
   *
   * This event is used to indicate that the channel list has changed,
   * e.g., because of a regulatory domain change triggered by scan
   * results including an AP advertising a country code.
   */
  EVENT_CHANNEL_LIST_CHANGED,

  /**
   * EVENT_INTERFACE_UNAVAILABLE - Notify that interface is unavailable
   *
   * This event is used to indicate that the driver cannot maintain this
   * interface in its operation mode anymore. The most likely use for
   * this is to indicate that AP mode operation is not available due to
   * operating channel would need to be changed to a DFS channel when
   * the driver does not support radar detection and another virtual
   * interfaces caused the operating channel to change. Other similar
   * resource conflicts could also trigger this for station mode
   * interfaces. This event can be propagated when channel switching
   * fails.
   */
  EVENT_INTERFACE_UNAVAILABLE,

  /**
   * EVENT_BEST_CHANNEL
   *
   * Driver generates this event whenever it detects a better channel
   * (e.g., based on RSSI or channel use). This information can be used
   * to improve channel selection for a new AP/P2P group.
   */
  EVENT_BEST_CHANNEL,

  /**
   * EVENT_UNPROT_DEAUTH - Unprotected Deauthentication frame received
   *
   * This event should be called when a Deauthentication frame is dropped
   * due to it not being protected (MFP/IEEE 802.11w).
   * union wpa_event_data::unprot_deauth is required to provide more
   * details of the frame.
   */
  EVENT_UNPROT_DEAUTH,

  /**
   * EVENT_UNPROT_DISASSOC - Unprotected Disassociation frame received
   *
   * This event should be called when a Disassociation frame is dropped
   * due to it not being protected (MFP/IEEE 802.11w).
   * union wpa_event_data::unprot_disassoc is required to provide more
   * details of the frame.
   */
  EVENT_UNPROT_DISASSOC,

  /**
   * EVENT_STATION_LOW_ACK
   *
   * Driver generates this event whenever it detected that a particular
   * station was lost. Detection can be through massive transmission
   * failures for example.
   */
  EVENT_STATION_LOW_ACK,

  /**
   * EVENT_IBSS_PEER_LOST - IBSS peer not reachable anymore
   */
  EVENT_IBSS_PEER_LOST,

  /**
   * EVENT_DRIVER_GTK_REKEY - Device/driver did GTK rekey
   *
   * This event carries the new replay counter to notify wpa_supplicant
   * of the current EAPOL-Key Replay Counter in case the driver/firmware
   * completed Group Key Handshake while the host (including
   * wpa_supplicant was sleeping).
   */
  EVENT_DRIVER_GTK_REKEY,

  /**
   * EVENT_SCHED_SCAN_STOPPED - Scheduled scan was stopped
   */
  EVENT_SCHED_SCAN_STOPPED,

  /**
   * EVENT_DRIVER_CLIENT_POLL_OK - Station responded to poll
   *
   * This event indicates that the station responded to the poll
   * initiated with @poll_client.
   */
  EVENT_DRIVER_CLIENT_POLL_OK,

  /**
   * EVENT_EAPOL_TX_STATUS - notify of EAPOL TX status
   */
  EVENT_EAPOL_TX_STATUS,

  /**
   * EVENT_CH_SWITCH - AP or GO decided to switch channels
   *
   * Described in wpa_event_data.ch_switch
   * */
  EVENT_CH_SWITCH,

  /**
   * EVENT_CH_SWITCH_STARTED - AP or GO started to switch channels
   *
   * This is a pre-switch event indicating the shortly following switch
   * of operating channels.
   *
   * Described in wpa_event_data.ch_switch
   */
  EVENT_CH_SWITCH_STARTED,
  /**
   * EVENT_WNM - Request WNM operation
   *
   * This event can be used to request a WNM operation to be performed.
   */
  EVENT_WNM,

  /**
   * EVENT_CONNECT_FAILED_REASON - Connection failure reason in AP mode
   *
   * This event indicates that the driver reported a connection failure
   * with the specified client (for example, max client reached, etc.) in
   * AP mode.
   */
  EVENT_CONNECT_FAILED_REASON,

  /**
   * EVENT_DFS_RADAR_DETECTED - Notify of radar detection
   *
   * A radar has been detected on the supplied frequency, hostapd should
   * react accordingly (e.g., change channel).
   */
  EVENT_DFS_RADAR_DETECTED,

  /**
   * EVENT_DFS_CAC_FINISHED - Notify that channel availability check has been completed
   *
   * After a successful CAC, the channel can be marked clear and used.
   */
  EVENT_DFS_CAC_FINISHED,

  /**
   * EVENT_DFS_CAC_ABORTED - Notify that channel availability check has been aborted
   *
   * The CAC was not successful, and the channel remains in the previous
   * state. This may happen due to a radar being detected or other
   * external influences.
   */
  EVENT_DFS_CAC_ABORTED,

  /**
   * EVENT_DFS_NOP_FINISHED - Notify that non-occupancy period is over
   *
   * The channel which was previously unavailable is now available again.
   */
  EVENT_DFS_NOP_FINISHED,

  /**
   * EVENT_SURVEY - Received survey data
   *
   * This event gets triggered when a driver query is issued for survey
   * data and the requested data becomes available. The returned data is
   * stored in struct survey_results. The results provide at most one
   * survey entry for each frequency and at minimum will provide one
   * survey entry for one frequency. The survey data can be os_malloc()'d
   * and then os_free()'d, so the event callback must only copy data.
   */
  EVENT_SURVEY,

  /**
   * EVENT_SCAN_STARTED - Scan started
   *
   * This indicates that driver has started a scan operation either based
   * on a request from wpa_supplicant/hostapd or from another application.
   * EVENT_SCAN_RESULTS is used to indicate when the scan has been
   * completed (either successfully or by getting cancelled).
   */
  EVENT_SCAN_STARTED,

  /**
   * EVENT_AVOID_FREQUENCIES - Received avoid frequency range
   *
   * This event indicates a set of frequency ranges that should be avoided
   * to reduce issues due to interference or internal co-existence
   * information in the driver.
   */
  EVENT_AVOID_FREQUENCIES,

  /**
   * EVENT_NEW_PEER_CANDIDATE - new (unknown) mesh peer notification
   */
  EVENT_NEW_PEER_CANDIDATE,

  /**
   * EVENT_ACS_CHANNEL_SELECTED - Received selected channels by ACS
   *
   * Indicates a pair of primary and secondary channels chosen by ACS
   * in device.
   */
  EVENT_ACS_CHANNEL_SELECTED,

  /**
   * EVENT_DFS_CAC_STARTED - Notify that channel availability check has
   * been started.
   *
   * This event indicates that channel availability check has been started
   * on a DFS frequency by a driver that supports DFS Offload.
   */
  EVENT_DFS_CAC_STARTED,

  /**
   * EVENT_P2P_LO_STOP - Notify that P2P listen offload is stopped
   */
  EVENT_P2P_LO_STOP,

  /**
   * EVENT_BEACON_LOSS - Beacon loss detected
   *
   * This event indicates that no Beacon frames has been received from
   * the current AP. This may indicate that the AP is not anymore in
   * range.
   */
  EVENT_BEACON_LOSS,

  /**
   * EVENT_DFS_PRE_CAC_EXPIRED - Notify that channel availability check
   * done previously (Pre-CAC) on the channel has expired. This would
   * normally be on a non-ETSI DFS regulatory domain. DFS state of the
   * channel will be moved from available to usable. A new CAC has to be
   * performed before start operating on this channel.
   */
  EVENT_DFS_PRE_CAC_EXPIRED,

  /**
   * EVENT_EXTERNAL_AUTH - This event interface is used by host drivers
   * that do not define separate commands for authentication and
   * association (~WPA_DRIVER_FLAGS_SME) but offload the 802.11
   * authentication to wpa_supplicant. This event carries all the
   * necessary information from the host driver for the authentication to
   * happen.
   */
  EVENT_EXTERNAL_AUTH,

  /**
   * EVENT_PORT_AUTHORIZED - Notification that a connection is authorized
   *
   * This event should be indicated when the driver completes the 4-way
   * handshake. This event should be preceded by an EVENT_ASSOC that
   * indicates the completion of IEEE 802.11 association.
   */
  EVENT_PORT_AUTHORIZED,

  /**
   * EVENT_STATION_OPMODE_CHANGED - Notify STA's HT/VHT operation mode
   * change event.
   */
  EVENT_STATION_OPMODE_CHANGED,

  /**
   * EVENT_INTERFACE_MAC_CHANGED - Notify that interface MAC changed
   *
   * This event is emitted when the MAC changes while the interface is
   * enabled. When an interface was disabled and becomes enabled, it
   * must be always assumed that the MAC possibly changed.
   */
  EVENT_INTERFACE_MAC_CHANGED,

  /**
   * EVENT_WDS_STA_INTERFACE_STATUS - Notify WDS STA interface status
   *
   * This event is emitted when an interface is added/removed for WDS STA.
   */
  EVENT_WDS_STA_INTERFACE_STATUS,

  /**
    * EVENT_UPDATE_DH - Notification of updated DH information
    */
  EVENT_UPDATE_DH,

  /**
   * EVENT_UNPROT_BEACON - Unprotected Beacon frame received
   *
   * This event should be called when a Beacon frame is dropped due to it
   * not being protected correctly. union wpa_event_data::unprot_beacon
   * is required to provide more details of the frame.
   */
  EVENT_UNPROT_BEACON,

  /**
   * EVENT_TX_WAIT_EXPIRE - TX wait timed out
   *
   * This event is used to indicate when the driver has completed
   * wait for a response frame based on a TX request that specified a
   * non-zero wait time and that has not been explicitly cancelled.
   */
  EVENT_TX_WAIT_EXPIRE,

  /**
    * EVENT_BSS_COLOR_COLLISION - Notification of a BSS color collision
    */
  EVENT_BSS_COLOR_COLLISION,

  /**
   * EVENT_CCA_STARTED_NOTIFY - Notification that CCA has started
   */
  EVENT_CCA_STARTED_NOTIFY,

  /**
   * EVENT_CCA_ABORTED_NOTIFY - Notification that CCA has aborted
   */
  EVENT_CCA_ABORTED_NOTIFY,

  /**
   * EVENT_CCA_NOTIFY - Notification that CCA has completed
   */
  EVENT_CCA_NOTIFY,

  /**
   * EVENT_PASN_AUTH - This event is used by the driver that requests
   * PASN authentication and secure ranging context for multiple peers.
   */
  EVENT_PASN_AUTH,

  /**
   * EVENT_LINK_CH_SWITCH - MLD AP link decided to switch channels
   *
   * Described in wpa_event_data.ch_switch.
   *
   */
  EVENT_LINK_CH_SWITCH,

  /**
   * EVENT_LINK_CH_SWITCH_STARTED - MLD AP link started to switch channels
   *
   * This is a pre-switch event indicating the shortly following switch
   * of operating channels.
   *
   * Described in wpa_event_data.ch_switch.
   */
  EVENT_LINK_CH_SWITCH_STARTED,

  /**
   * EVENT_TID_LINK_MAP - MLD event to set TID-to-link mapping
   *
   * This event is used by the driver to indicate the received TID-to-link
   * mapping response from the associated AP MLD.
   *
   * Described in wpa_event_data.t2l_map_info.
   */
  EVENT_TID_LINK_MAP,

  /**
   * EVENT_LINK_RECONFIG - Notification that AP links removed
   */
  EVENT_LINK_RECONFIG,

  /**
   * EVENT_MLD_INTERFACE_FREED - Notification of AP MLD interface removal
   */
  EVENT_MLD_INTERFACE_FREED,

  /**
   * EVENT_SETUP_LINK_RECONFIG - Notification that new AP links added
   */
  EVENT_SETUP_LINK_RECONFIG,

  /**
   * EVENT_NAN_CLUSTER_JOIN - Notification of a new cluster having been
   * joined or started.
   *
   * This event is used to notify wpa_supplicant that a NAN cluster has
   * been joined or started. The event data includes the NAN cluster ID
   * and a boolean indicating whether a new cluster was started or an
   * existing cluster was joined.
   *
   * Described in wpa_event_data.nan_cluster_join_info.
   */
  EVENT_NAN_CLUSTER_JOIN,

  /**
   * EVENT_NAN_NEXT_DW - Notification of NAN next Discovery Window
   *
   * This event is used to notify wpa_supplicant that the device/driver
   * is ready for the next Discovery Window (DW) frames. It may be used
   * to trigger transmission of multicast SDFs (active subscribe and
   * unsolicited publish).
   * The event data includes the DW frequency.
   */
  EVENT_NAN_NEXT_DW,
};


/**
 * struct freq_survey - Channel survey info
 *
 * @ifidx: Interface index in which this survey was observed
 * @freq: Center of frequency of the surveyed channel
 * @nf: Channel noise floor in dBm
 * @channel_time: Amount of time in ms the radio spent on the channel
 * @channel_time_busy: Amount of time in ms the radio detected some signal
 *     that indicated to the radio the channel was not clear
 * @channel_time_rx: Amount of time the radio spent receiving data
 * @channel_time_tx: Amount of time the radio spent transmitting data
 * @filled: bitmask indicating which fields have been reported, see
 *     SURVEY_HAS_* defines.
 * @list: Internal list pointers
 */
struct freq_survey {
  u32 ifidx;
  unsigned int freq;
  s8 nf;
  u64 channel_time;
  u64 channel_time_busy;
  u64 channel_time_rx;
  u64 channel_time_tx;
  unsigned int filled;
  struct dl_list list;
};

#define SURVEY_HAS_NF BIT(0)
#define SURVEY_HAS_CHAN_TIME BIT(1)
#define SURVEY_HAS_CHAN_TIME_BUSY BIT(2)
#define SURVEY_HAS_CHAN_TIME_RX BIT(3)
#define SURVEY_HAS_CHAN_TIME_TX BIT(4)

/**
 * enum sta_connect_fail_reason_codes - STA connect failure reason code values
 * @STA_CONNECT_FAIL_REASON_UNSPECIFIED: No reason code specified for
 *  connection failure.
 * @STA_CONNECT_FAIL_REASON_NO_BSS_FOUND: No Probe Response frame received
 *  for unicast Probe Request frame.
 * @STA_CONNECT_FAIL_REASON_AUTH_TX_FAIL: STA failed to send auth request.
 * @STA_CONNECT_FAIL_REASON_AUTH_NO_ACK_RECEIVED: AP didn't send ACK for
 *  auth request.
 * @STA_CONNECT_FAIL_REASON_AUTH_NO_RESP_RECEIVED: Auth response is not
 *  received from AP.
 * @STA_CONNECT_FAIL_REASON_ASSOC_REQ_TX_FAIL: STA failed to send
 *  Association Request frame.
 * @STA_CONNECT_FAIL_REASON_ASSOC_NO_ACK_RECEIVED: AP didn't send ACK for
 *  Association Request frame.
 * @STA_CONNECT_FAIL_REASON_ASSOC_NO_RESP_RECEIVED: Association Response
 *  frame is not received from AP.
 */
enum sta_connect_fail_reason_codes {
  STA_CONNECT_FAIL_REASON_UNSPECIFIED = 0,
  STA_CONNECT_FAIL_REASON_NO_BSS_FOUND = 1,
  STA_CONNECT_FAIL_REASON_AUTH_TX_FAIL = 2,
  STA_CONNECT_FAIL_REASON_AUTH_NO_ACK_RECEIVED = 3,
  STA_CONNECT_FAIL_REASON_AUTH_NO_RESP_RECEIVED = 4,
  STA_CONNECT_FAIL_REASON_ASSOC_REQ_TX_FAIL = 5,
  STA_CONNECT_FAIL_REASON_ASSOC_NO_ACK_RECEIVED = 6,
  STA_CONNECT_FAIL_REASON_ASSOC_NO_RESP_RECEIVED = 7,
};

/**
 * union wpa_event_data - Additional data for wpa_supplicant_event() calls
 */
union wpa_event_data {
  /**
   * struct assoc_info - Data for EVENT_ASSOC and EVENT_ASSOCINFO events
   *
   * This structure is optional for EVENT_ASSOC calls and required for
   * EVENT_ASSOCINFO calls. By using EVENT_ASSOC with this data, the
   * driver interface does not need to generate separate EVENT_ASSOCINFO
   * calls.
   */
  struct assoc_info {
    /**
     * reassoc - Flag to indicate association or reassociation
     */
    int reassoc;

    /**
     * req_ies - (Re)Association Request IEs
     *
     * If the driver generates WPA/RSN IE, this event data must be
     * returned for WPA handshake to have needed information. If
     * wpa_supplicant-generated WPA/RSN IE is used, this
     * information event is optional.
     *
     * This should start with the first IE (fixed fields before IEs
     * are not included).
     */
    const u8 *req_ies;

    /**
     * req_ies_len - Length of req_ies in bytes
     */
    size_t req_ies_len;

    /**
     * resp_ies - (Re)Association Response IEs
     *
     * Optional association data from the driver. This data is not
     * required WPA, but may be useful for some protocols and as
     * such, should be reported if this is available to the driver
     * interface.
     *
     * This should start with the first IE (fixed fields before IEs
     * are not included).
     */
    const u8 *resp_ies;

    /**
     * resp_ies_len - Length of resp_ies in bytes
     */
    size_t resp_ies_len;

    /**
     * resp_frame - (Re)Association Response frame
     */
    const u8 *resp_frame;

    /**
     * resp_frame_len - (Re)Association Response frame length
     */
    size_t resp_frame_len;

    /**
     * beacon_ies - Beacon or Probe Response IEs
     *
     * Optional Beacon/ProbeResp data: IEs included in Beacon or
     * Probe Response frames from the current AP (i.e., the one
     * that the client just associated with). This information is
     * used to update WPA/RSN IE for the AP. If this field is not
     * set, the results from previous scan will be used. If no
     * data for the new AP is found, scan results will be requested
     * again (without scan request). At this point, the driver is
     * expected to provide WPA/RSN IE for the AP (if WPA/WPA2 is
     * used).
     *
     * This should start with the first IE (fixed fields before IEs
     * are not included).
     */
    const u8 *beacon_ies;

    /**
     * beacon_ies_len - Length of beacon_ies */
    size_t beacon_ies_len;

    /**
     * freq - Frequency of the operational channel in MHz
     */
    unsigned int freq;

    /**
     * wmm_params - WMM parameters used in this association.
     */
    struct wmm_params wmm_params;

    /**
     * addr - Station address (for AP mode)
     */
    const u8 *addr;

    /**
     * The following is the key management offload information
     * @authorized
     * @key_replay_ctr
     * @key_replay_ctr_len
     * @ptk_kck
     * @ptk_kek_len
     * @ptk_kek
     * @ptk_kek_len
     */

    /**
     * authorized - Status of key management offload,
     * 1 = successful
     */
    int authorized;

    /**
     * key_replay_ctr - Key replay counter value last used
     * in a valid EAPOL-Key frame
     */
    const u8 *key_replay_ctr;

    /**
     * key_replay_ctr_len - The length of key_replay_ctr
     */
    size_t key_replay_ctr_len;

    /**
     * ptk_kck - The derived PTK KCK
     */
    const u8 *ptk_kck;

    /**
     * ptk_kek_len - The length of ptk_kck
     */
    size_t ptk_kck_len;

    /**
     * ptk_kek - The derived PTK KEK
     * This is used in key management offload and also in FILS SK
     * offload.
     */
    const u8 *ptk_kek;

    /**
     * ptk_kek_len - The length of ptk_kek
     */
    size_t ptk_kek_len;

    /**
     * subnet_status - The subnet status:
     * 0 = unknown, 1 = unchanged, 2 = changed
     */
    u8 subnet_status;

    /**
     * The following information is used in FILS SK offload
     * @fils_erp_next_seq_num
     * @fils_pmk
     * @fils_pmk_len
     * @fils_pmkid
     */

    /**
     * fils_erp_next_seq_num - The next sequence number to use in
     * FILS ERP messages
     */
    u16 fils_erp_next_seq_num;

    /**
     * fils_pmk - A new PMK if generated in case of FILS
     * authentication
     */
    const u8 *fils_pmk;

    /**
     * fils_pmk_len - Length of fils_pmk
     */
    size_t fils_pmk_len;

    /**
     * fils_pmkid - PMKID used or generated in FILS authentication
     */
    const u8 *fils_pmkid;

    /**
     * link_addr - Link address of the STA
     */
    const u8 *link_addr;

    /**
     * assoc_link_id - Association link id of the MLO association or
     *  -1 if MLO is not used
     */
    int assoc_link_id;
  } assoc_info;

  /**
   * struct disassoc_info - Data for EVENT_DISASSOC events
   */
  struct disassoc_info {
    /**
     * addr - Station address (for AP mode)
     */
    const u8 *addr;

    /**
     * reason_code - Reason Code (host byte order) used in
     *  Deauthentication frame
     */
    u16 reason_code;

    /**
     * ie - Optional IE(s) in Disassociation frame
     */
    const u8 *ie;

    /**
     * ie_len - Length of ie buffer in octets
     */
    size_t ie_len;

    /**
     * locally_generated - Whether the frame was locally generated
     */
    int locally_generated;
  } disassoc_info;

  /**
   * struct deauth_info - Data for EVENT_DEAUTH events
   */
  struct deauth_info {
    /**
     * addr - Station address (for AP mode)
     */
    const u8 *addr;

    /**
     * reason_code - Reason Code (host byte order) used in
     *  Deauthentication frame
     */
    u16 reason_code;

    /**
     * ie - Optional IE(s) in Deauthentication frame
     */
    const u8 *ie;

    /**
     * ie_len - Length of ie buffer in octets
     */
    size_t ie_len;

    /**
     * locally_generated - Whether the frame was locally generated
     */
    int locally_generated;
  } deauth_info;

  /**
   * struct michael_mic_failure - Data for EVENT_MICHAEL_MIC_FAILURE
   */
  struct michael_mic_failure {
    int unicast;
    const u8 *src;
  } michael_mic_failure;

  /**
   * struct interface_status - Data for EVENT_INTERFACE_STATUS
   */
  struct interface_status {
    unsigned int ifindex;
    char ifname[100];
    enum {
      EVENT_INTERFACE_ADDED, EVENT_INTERFACE_REMOVED
    } ievent;
  } interface_status;

  /**
   * struct pmkid_candidate - Data for EVENT_PMKID_CANDIDATE
   */
  struct pmkid_candidate {
    /** BSSID of the PMKID candidate */
    u8 bssid[ETH_ALEN];
    /** Smaller the index, higher the priority */
    int index;
    /** Whether RSN IE includes pre-authenticate flag */
    int preauth;
  } pmkid_candidate;

  /**
   * struct tdls - Data for EVENT_TDLS
   */
  struct tdls {
    u8 peer[ETH_ALEN];
    enum {
      TDLS_REQUEST_SETUP,
      TDLS_REQUEST_TEARDOWN,
      TDLS_REQUEST_DISCOVER,
    } oper;
    u16 reason_code; /* for teardown */
  } tdls;

  /**
   * struct wnm - Data for EVENT_WNM
   */
  struct wnm {
    u8 addr[ETH_ALEN];
    enum {
      WNM_OPER_SLEEP,
    } oper;
    enum {
      WNM_SLEEP_ENTER,
      WNM_SLEEP_EXIT
    } sleep_action;
    int sleep_intval;
    u16 reason_code;
    u8 *buf;
    u16 buf_len;
  } wnm;

  /**
   * struct ft_ies - FT information elements (EVENT_FT_RESPONSE)
   *
   * During FT (IEEE 802.11r) authentication sequence, the driver is
   * expected to use this event to report received FT IEs (MDIE, FTIE,
   * RSN IE, TIE, possible resource request) to the supplicant. The FT
   * IEs for the next message will be delivered through the
   * struct wpa_driver_ops::update_ft_ies() callback.
   */
  struct ft_ies {
    const u8 *ies;
    size_t ies_len;
    int ft_action;
    u8 target_ap[ETH_ALEN];
    /** Optional IE(s), e.g., WMM TSPEC(s), for RIC-Request */
    const u8 *ric_ies;
    /** Length of ric_ies buffer in octets */
    size_t ric_ies_len;
  } ft_ies;

  /**
   * struct ibss_rsn_start - Data for EVENT_IBSS_RSN_START
   */
  struct ibss_rsn_start {
    u8 peer[ETH_ALEN];
  } ibss_rsn_start;

  /**
   * struct auth_info - Data for EVENT_AUTH events
   */
  struct auth_info {
    u8 peer[ETH_ALEN];
    u8 bssid[ETH_ALEN];
    u16 auth_type;
    u16 auth_transaction;
    u16 status_code;
    const u8 *ies;
    size_t ies_len;
  } auth;

  /**
   * struct assoc_reject - Data for EVENT_ASSOC_REJECT events
   */
  struct assoc_reject {
    /**
     * bssid - BSSID of the AP that rejected association
     */
    const u8 *bssid;

    /**
     * resp_ies - (Re)Association Response IEs
     *
     * Optional association data from the driver. This data is not
     * required WPA, but may be useful for some protocols and as
     * such, should be reported if this is available to the driver
     * interface.
     *
     * This should start with the first IE (fixed fields before IEs
     * are not included).
     */
    const u8 *resp_ies;

    /**
     * resp_ies_len - Length of resp_ies in bytes
     */
    size_t resp_ies_len;

    /**
     * status_code - Status Code from (Re)association Response
     */
    u16 status_code;

    /**
     * timed_out - Whether failure is due to timeout (etc.) rather
     * than explicit rejection response from the AP.
     */
    int timed_out;

    /**
     * timeout_reason - Reason for the timeout
     */
    const char *timeout_reason;

    /**
     * fils_erp_next_seq_num - The next sequence number to use in
     * FILS ERP messages
     */
    u16 fils_erp_next_seq_num;

    /**
     * reason_code - Connection failure reason code from the driver
     */
    enum sta_connect_fail_reason_codes reason_code;
  } assoc_reject;

  struct timeout_event {
    u8 addr[ETH_ALEN];
  } timeout_event;

  /**
   * struct tx_status - Data for EVENT_TX_STATUS events
   */
  struct tx_status {
    u16 type;
    u16 stype;
    const u8 *dst;
    const u8 *data;
    size_t data_len;
    int ack;
    int link_id;
  } tx_status;

  /**
   * struct rx_from_unknown - Data for EVENT_RX_FROM_UNKNOWN events
   */
  struct rx_from_unknown {
    const u8 *bssid;
    const u8 *addr;
    int wds;
    int link_id;
  } rx_from_unknown;

  /**
   * struct rx_mgmt - Data for EVENT_RX_MGMT events
   */
  struct rx_mgmt {
    const u8 *frame;
    size_t frame_len;
    u32 datarate;

    /**
     * drv_priv - Pointer to store driver private BSS information
     *
     * If not set to NULL, this is used for comparison with
     * hostapd_data->drv_priv to determine which BSS should process
     * the frame.
     */
    void *drv_priv;

    /**
     * ctx - Pointer to store ctx of private BSS information
     *
     * If not set to NULL, this is used for forwarding the packet
     * to right link BSS of ML BSS.
     */
    void *ctx;

    /**
     * freq - Frequency (in MHz) on which the frame was received
     */
    int freq;

    /**
     * ssi_signal - Signal strength in dBm (or 0 if not available)
     */
    int ssi_signal;

    /**
     * link_id - MLO link on which the frame was received or -1 for
     * non MLD.
     */
    int link_id;
  } rx_mgmt;

  /**
   * struct remain_on_channel - Data for EVENT_REMAIN_ON_CHANNEL events
   *
   * This is also used with EVENT_CANCEL_REMAIN_ON_CHANNEL events.
   */
  struct remain_on_channel {
    /**
     * freq - Channel frequency in MHz
     */
    unsigned int freq;

    /**
     * duration - Duration to remain on the channel in milliseconds
     */
    unsigned int duration;
  } remain_on_channel;

  /**
   * struct scan_info - Optional data for EVENT_SCAN_RESULTS events
   * @aborted: Whether the scan was aborted
   * @freqs: Scanned frequencies in MHz (%NULL = all channels scanned)
   * @num_freqs: Number of entries in freqs array
   * @ssids: Scanned SSIDs (%NULL or zero-length SSID indicates wildcard
   *  SSID)
   * @num_ssids: Number of entries in ssids array
   * @external_scan: Whether the scan info is for an external scan
   * @nl_scan_event: 1 if the source of this scan event is a normal scan,
   *  0 if the source of the scan event is a vendor scan
   * @scan_start_tsf: Time when the scan started in terms of TSF of the
   *  BSS that the interface that requested the scan is connected to
   *  (if available).
   * @scan_start_tsf_bssid: The BSSID according to which %scan_start_tsf
   *  is set.
   * @scan_cookie: Unique identification representing the corresponding
   *      scan request. 0 if no unique identification is available.
   */
  struct scan_info {
    int aborted;
    const int *freqs;
    size_t num_freqs;
    struct wpa_driver_scan_ssid ssids[WPAS_MAX_SCAN_SSIDS];
    size_t num_ssids;
    int external_scan;
    int nl_scan_event;
    u64 scan_start_tsf;
    u8 scan_start_tsf_bssid[ETH_ALEN];
    u64 scan_cookie;
  } scan_info;

  /**
   * struct rx_probe_req - Data for EVENT_RX_PROBE_REQ events
   */
  struct rx_probe_req {
    /**
     * sa - Source address of the received Probe Request frame
     */
    const u8 *sa;

    /**
     * da - Destination address of the received Probe Request frame
     *  or %NULL if not available
     */
    const u8 *da;

    /**
     * bssid - BSSID of the received Probe Request frame or %NULL
     *  if not available
     */
    const u8 *bssid;

    /**
     * ie - IEs from the Probe Request body
     */
    const u8 *ie;

    /**
     * ie_len - Length of ie buffer in octets
     */
    size_t ie_len;

    /**
     * signal - signal strength in dBm (or 0 if not available)
     */
    int ssi_signal;
  } rx_probe_req;

  /**
   * struct new_sta - Data for EVENT_NEW_STA events
   */
  struct new_sta {
    const u8 *addr;
  } new_sta;

  /**
   * struct eapol_rx - Data for EVENT_EAPOL_RX events
   */
  struct eapol_rx {
    const u8 *src;
    const u8 *data;
    size_t data_len;
    enum frame_encryption encrypted;
    int link_id;
  } eapol_rx;

  /**
   * signal_change - Data for EVENT_SIGNAL_CHANGE events
   */
  struct wpa_signal_info signal_change;

  /**
   * struct best_channel - Data for EVENT_BEST_CHANNEL events
   * @freq_24: Best 2.4 GHz band channel frequency in MHz
   * @freq_5: Best 5 GHz band channel frequency in MHz
   * @freq_overall: Best channel frequency in MHz
   *
   * 0 can be used to indicate no preference in either band.
   */
  struct best_channel {
    int freq_24;
    int freq_5;
    int freq_overall;
  } best_chan;

  struct unprot_deauth {
    const u8 *sa;
    const u8 *da;
    u16 reason_code;
  } unprot_deauth;

  struct unprot_disassoc {
    const u8 *sa;
    const u8 *da;
    u16 reason_code;
  } unprot_disassoc;

  /**
   * struct low_ack - Data for EVENT_STATION_LOW_ACK events
   * @addr: station address
   * @num_packets: Number of packets lost (consecutive packets not
   * acknowledged)
   */
  struct low_ack {
    u8 addr[ETH_ALEN];
    u32 num_packets;
  } low_ack;

  /**
   * struct ibss_peer_lost - Data for EVENT_IBSS_PEER_LOST
   */
  struct ibss_peer_lost {
    u8 peer[ETH_ALEN];
  } ibss_peer_lost;

  /**
   * struct driver_gtk_rekey - Data for EVENT_DRIVER_GTK_REKEY
   */
  struct driver_gtk_rekey {
    const u8 *bssid;
    const u8 *replay_ctr;
  } driver_gtk_rekey;

  /**
   * struct client_poll - Data for EVENT_DRIVER_CLIENT_POLL_OK events
   * @addr: station address
   */
  struct client_poll {
    u8 addr[ETH_ALEN];
  } client_poll;

  /**
   * struct eapol_tx_status
   * @dst: Original destination
   * @data: Data starting with IEEE 802.1X header (!)
   * @data_len: Length of data
   * @ack: Indicates ack or lost frame
   * @link_id: MLD link id used to transmit the frame or -1 for non MLO
   *
   * This corresponds to hapd_send_eapol if the frame sent
   * there isn't just reported as EVENT_TX_STATUS.
   */
  struct eapol_tx_status {
    const u8 *dst;
    const u8 *data;
    int data_len;
    int ack;
    int link_id;
  } eapol_tx_status;

  /**
   * struct ch_switch
   * @freq: Frequency of new channel in MHz
   * @ht_enabled: Whether this is an HT channel
   * @ch_offset: Secondary channel offset
   * @ch_width: Channel width
   * @cf1: Center frequency 1
   * @cf2: Center frequency 2
   * @link_id: Link ID of the MLO link
   * @punct_bitmap: Puncturing bitmap
   */
  struct ch_switch {
    int freq;
    int ht_enabled;
    int ch_offset;
    enum chan_width ch_width;
    int cf1;
    int cf2;
    int link_id;
    u16 punct_bitmap;
  } ch_switch;

  /**
   * struct connect_failed - Data for EVENT_CONNECT_FAILED_REASON
   * @addr: Remote client address
   * @code: Reason code for connection failure
   */
  struct connect_failed_reason {
    u8 addr[ETH_ALEN];
    enum {
      MAX_CLIENT_REACHED,
      BLOCKED_CLIENT
    } code;
  } connect_failed_reason;

  /**
   * struct dfs_event - Data for radar detected events
   * @freq: Frequency of the channel in MHz
   * @link_id: If >= 0, Link ID of the MLO link
   */
  struct dfs_event {
    int freq;
    int ht_enabled;
    int chan_offset;
    enum chan_width chan_width;
    int cf1;
    int cf2;
    int link_id;
  } dfs_event;

  /**
   * survey_results - Survey result data for EVENT_SURVEY
   * @freq_filter: Requested frequency survey filter, 0 if request
   *  was for all survey data
   * @survey_list: Linked list of survey data (struct freq_survey)
   */
  struct survey_results {
    unsigned int freq_filter;
    struct dl_list survey_list; /* struct freq_survey */
  } survey_results;

  /**
   * channel_list_changed - Data for EVENT_CHANNEL_LIST_CHANGED
   * @initiator: Initiator of the regulatory change
   * @type: Regulatory change type
   * @alpha2: Country code (or "" if not available)
   * @beacon_hint_before: Data for frequency attributes before beacon hint
   *  event if initiator == REGDOM_BEACON_HINT
   * @beacon_hint_after: Data for frequency attributes after beacon hint
   *  event if initiator == REGDOM_BEACON_HINT
   */
  struct channel_list_changed {
    enum reg_change_initiator initiator;
    enum reg_type type;
    char alpha2[3];
    struct frequency_attrs {
      unsigned int freq;
      unsigned int max_tx_power;
      bool disabled;
      bool no_ir;
      bool radar;
    } beacon_hint_before, beacon_hint_after;
  } channel_list_changed;

  /**
   * freq_range - List of frequency ranges
   *
   * This is used as the data with EVENT_AVOID_FREQUENCIES.
   */
  struct wpa_freq_range_list freq_range;

  /**
   * struct mesh_peer
   *
   * @peer: Peer address
   * @ies: Beacon IEs
   * @ie_len: Length of @ies
   *
   * Notification of new candidate mesh peer.
   */
  struct mesh_peer {
    const u8 *peer;
    const u8 *ies;
    size_t ie_len;
  } mesh_peer;

  /**
   * struct acs_selected_channels - Data for EVENT_ACS_CHANNEL_SELECTED
   * @pri_freq: Selected primary frequency
   * @sec_freq: Selected secondary frequency
   * @edmg_channel: Selected EDMG channel
   * @vht_seg0_center_ch: VHT mode Segment0 center channel
   *  The value is the index of the channel center frequency for
   *  20 MHz, 40 MHz, and 80 MHz channels. The value is the center
   *  frequency index of the primary 80 MHz segment for 160 MHz and
   *  80+80 MHz channels.
   * @vht_seg1_center_ch: VHT mode Segment1 center channel
   *  The value is zero for 20 MHz, 40 MHz, and 80 MHz channels. The
   *  value is the index of the channel center frequency for 160 MHz
   *  channels and the center frequency index of the secondary 80 MHz
   *  segment for 80+80 MHz channels.
   * @ch_width: Selected Channel width by driver. Driver may choose to
   *  change hostapd configured ACS channel width due driver internal
   *  channel restrictions.
   * @hw_mode: Selected band (used with hw_mode=any)
   * @puncture_bitmap: Indicate the puncturing channels
   * @link_id: Indicate the link id if operating as AP MLD; -1 otherwise
   */
  struct acs_selected_channels {
    unsigned int pri_freq;
    unsigned int sec_freq;
    u8 edmg_channel;
    u8 vht_seg0_center_ch;
    u8 vht_seg1_center_ch;
    u16 ch_width;
    enum hostapd_hw_mode hw_mode;
    u16 puncture_bitmap;
    int link_id;
  } acs_selected_channels;

  /**
   * struct p2p_lo_stop - Reason code for P2P Listen offload stop event
   * @reason_code: Reason for stopping offload
   *  P2P_LO_STOPPED_REASON_COMPLETE: Listen offload finished as
   *  scheduled.
   *  P2P_LO_STOPPED_REASON_RECV_STOP_CMD: Host requested offload to
   *  be stopped.
   *  P2P_LO_STOPPED_REASON_INVALID_PARAM: Invalid listen offload
   *  parameters.
   *  P2P_LO_STOPPED_REASON_NOT_SUPPORTED: Listen offload not
   *  supported by device.
   */
  struct p2p_lo_stop {
    enum {
      P2P_LO_STOPPED_REASON_COMPLETE = 0,
      P2P_LO_STOPPED_REASON_RECV_STOP_CMD,
      P2P_LO_STOPPED_REASON_INVALID_PARAM,
      P2P_LO_STOPPED_REASON_NOT_SUPPORTED,
    } reason_code;
  } p2p_lo_stop;

  /* For EVENT_EXTERNAL_AUTH */
  struct external_auth external_auth;

  /**
   * struct sta_opmode - Station's operation mode change event
   * @addr: The station MAC address
   * @smps_mode: SMPS mode of the station
   * @chan_width: Channel width of the station
   * @rx_nss: RX_NSS of the station
   *
   * This is used as data with EVENT_STATION_OPMODE_CHANGED.
   */
  struct sta_opmode {
    const u8 *addr;
    enum smps_mode smps_mode;
    enum chan_width chan_width;
    u8 rx_nss;
  } sta_opmode;

  /**
   * struct wds_sta_interface - Data for EVENT_WDS_STA_INTERFACE_STATUS.
   */
  struct wds_sta_interface {
    const u8 *sta_addr;
    const char *ifname;
    enum {
      INTERFACE_ADDED,
      INTERFACE_REMOVED
    } istatus;
  } wds_sta_interface;

  /**
   * struct update_dh - Data for EVENT_UPDATE_DH
   */
  struct update_dh {
    const u8 *peer;
    const u8 *ie;
    size_t ie_len;
    int assoc_link_id;
    const u8 *link_addr;
  } update_dh;

  /**
   * struct unprot_beacon - Data for EVENT_UNPROT_BEACON
   */
  struct unprot_beacon {
    const u8 *sa;
  } unprot_beacon;

  /**
   * struct bss_color_collision - Data for EVENT_BSS_COLOR_COLLISION
   */
  struct bss_color_collision {
    u64 bitmap;
    int link_id;
  } bss_color_collision;

  /**
   * struct pasn_auth - Data for EVENT_PASN_AUTH
   */
  struct pasn_auth pasn_auth;

  /**
   * struct port_authorized - Data for EVENT_PORT_AUTHORIZED
   * @td_bitmap: For STA mode, transition disable bitmap, if received in
   *  EAPOL-Key msg 3/4
   * @td_bitmap_len: For STA mode, length of td_bitmap
   * @sta_addr: For AP mode, the MAC address of the associated STA
   *
   * This event is used to indicate that the port is authorized and
   * open for normal data in STA and AP modes when 4-way handshake is
   * offloaded to the driver.
   */
  struct port_authorized {
    const u8 *td_bitmap;
    size_t td_bitmap_len;
    const u8 *sta_addr;
  } port_authorized;

  /**
   * struct tid_link_map_info - Data for EVENT_TID_LINK_MAP
   */
  struct tid_link_map_info {
    bool default_map;
    u8 valid_links;
    struct t2lm_mapping t2lmap[MAX_NUM_MLD_LINKS];
  } t2l_map_info;

  /**
   * struct reconfig_info - Data for EVENT_SETUP_LINK_RECONFIG
   */
  struct reconfig_info {
    u16 added_links;
    u8 count;
    const u8 *status_list;
    const u8 *resp_ie; /* Starting from Group Key Data */
    size_t resp_ie_len;
  } reconfig_info;

  struct nan_cluster_join_info {
    const u8 *bssid;
    bool new_cluster;
  } nan_cluster_join_info;

  struct nan_next_dw_info {
    int freq;
  } nan_next_dw_info;
};

/**
 * wpa_supplicant_event - Report a driver event for wpa_supplicant
 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
 *  with struct wpa_driver_ops::init()
 * @event: event type (defined above)
 * @data: possible extra data for the event
 *
 * Driver wrapper code should call this function whenever an event is received
 * from the driver.
 */
void wpa_supplicant_event(void *ctx, enum wpa_event_type event,
        union wpa_event_data *data);

/**
 * wpa_supplicant_event_global - Report a driver event for wpa_supplicant
 * @ctx: Context pointer (wpa_s); this is the ctx variable registered
 *  with struct wpa_driver_ops::init()
 * @event: event type (defined above)
 * @data: possible extra data for the event
 *
 * Same as wpa_supplicant_event(), but we search for the interface in
 * wpa_global.
 */
void wpa_supplicant_event_global(void *ctx, enum wpa_event_type event,
         union wpa_event_data *data);

/*
 * The following inline functions are provided for convenience to simplify
 * event indication for some of the common events.
 */

static inline void drv_event_assoc(void *ctx, const u8 *addr, const u8 *req_ies,
           size_t req_ielen, const u8 *resp_ies,
           size_t resp_ielen, const u8 *link_addr,
           int assoc_link_id, int reassoc)
{
  union wpa_event_data event;
  os_memset(&event, 0, sizeof(event));
  event.assoc_info.reassoc = reassoc;
  event.assoc_info.req_ies = req_ies;
  event.assoc_info.req_ies_len = req_ielen;
  event.assoc_info.resp_ies = resp_ies;
  event.assoc_info.resp_ies_len = resp_ielen;
  event.assoc_info.addr = addr;
  event.assoc_info.link_addr = link_addr;
  event.assoc_info.assoc_link_id = assoc_link_id;
  wpa_supplicant_event(ctx, EVENT_ASSOC, &event);
}

static inline void drv_event_disassoc(void *ctx, const u8 *addr)
{
  union wpa_event_data event;
  os_memset(&event, 0, sizeof(event));
  event.disassoc_info.addr = addr;
  wpa_supplicant_event(ctx, EVENT_DISASSOC, &event);
}

static inline void drv_event_eapol_rx(void *ctx, const u8 *src, const u8 *data,
              size_t data_len)
{
  union wpa_event_data event;
  os_memset(&event, 0, sizeof(event));
  event.eapol_rx.src = src;
  event.eapol_rx.data = data;
  event.eapol_rx.data_len = data_len;
  event.eapol_rx.encrypted = FRAME_ENCRYPTION_UNKNOWN;
  event.eapol_rx.link_id = -1;
  wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
}

static inline void drv_event_eapol_rx2(void *ctx, const u8 *src, const u8 *data,
               size_t data_len,
               enum frame_encryption encrypted,
               int link_id)
{
  union wpa_event_data event;
  os_memset(&event, 0, sizeof(event));
  event.eapol_rx.src = src;
  event.eapol_rx.data = data;
  event.eapol_rx.data_len = data_len;
  event.eapol_rx.encrypted = encrypted;
  event.eapol_rx.link_id = link_id;
  wpa_supplicant_event(ctx, EVENT_EAPOL_RX, &event);
}

/* driver_common.c */
void wpa_scan_results_free(struct wpa_scan_results *res);

/* Convert wpa_event_type to a string for logging */
const char * event_to_string(enum wpa_event_type event);

/* Convert chan_width to a string for logging and control interfaces */
const char * channel_width_to_string(enum chan_width width);

int channel_width_to_int(enum chan_width width);

int ht_supported(const struct hostapd_hw_modes *mode);
int vht_supported(const struct hostapd_hw_modes *mode);
bool he_supported(const struct hostapd_hw_modes *hw_mode,
      enum ieee80211_op_mode op_mode);
bool eht_supported(const struct hostapd_hw_modes *hw_mode,
       enum ieee80211_op_mode op_mode);

struct wowlan_triggers *
wpa_get_wowlan_triggers(const char *wowlan_triggers,
      const struct wpa_driver_capa *capa);
/* Convert driver flag to string */
const char * driver_flag_to_string(u64 flag);
const char * driver_flag2_to_string(u64 flag2);

/* NULL terminated array of linked in driver wrappers */
extern const struct wpa_driver_ops *const wpa_drivers[];


/* Available drivers */

#ifdef CONFIG_DRIVER_WEXT
extern const struct wpa_driver_ops wpa_driver_wext_ops; /* driver_wext.c */
#endif /* CONFIG_DRIVER_WEXT */
#ifdef CONFIG_DRIVER_NL80211
/* driver_nl80211.c */
extern const struct wpa_driver_ops wpa_driver_nl80211_ops;
#endif /* CONFIG_DRIVER_NL80211 */
#ifdef CONFIG_DRIVER_BSD
extern const struct wpa_driver_ops wpa_driver_bsd_ops; /* driver_bsd.c */
#endif /* CONFIG_DRIVER_BSD */
#ifdef CONFIG_DRIVER_OPENBSD
/* driver_openbsd.c */
extern const struct wpa_driver_ops wpa_driver_openbsd_ops;
#endif /* CONFIG_DRIVER_OPENBSD */
#ifdef CONFIG_DRIVER_NDIS
extern struct wpa_driver_ops wpa_driver_ndis_ops; /* driver_ndis.c */
#endif /* CONFIG_DRIVER_NDIS */
#ifdef CONFIG_DRIVER_WIRED
extern const struct wpa_driver_ops wpa_driver_wired_ops; /* driver_wired.c */
#endif /* CONFIG_DRIVER_WIRED */
#ifdef CONFIG_DRIVER_MACSEC_QCA
/* driver_macsec_qca.c */
extern const struct wpa_driver_ops wpa_driver_macsec_qca_ops;
#endif /* CONFIG_DRIVER_MACSEC_QCA */
#ifdef CONFIG_DRIVER_MACSEC_LINUX
/* driver_macsec_linux.c */
extern const struct wpa_driver_ops wpa_driver_macsec_linux_ops;
#endif /* CONFIG_DRIVER_MACSEC_LINUX */
#ifdef CONFIG_DRIVER_ROBOSWITCH
/* driver_roboswitch.c */
extern const struct wpa_driver_ops wpa_driver_roboswitch_ops;
#endif /* CONFIG_DRIVER_ROBOSWITCH */
#ifdef CONFIG_DRIVER_NONE
extern const struct wpa_driver_ops wpa_driver_none_ops; /* driver_none.c */
#endif /* CONFIG_DRIVER_NONE */

#endif /* DRIVER_H */

Coverage Report

Created: 2026-03-19 06:13