root/include/net/cfg80211.h

/* [<][>][^][v][top][bottom][index][help] */

INCLUDED FROM


DEFINITIONS

This source file includes following definitions.
  1. ieee80211_get_sband_iftype_data
  2. ieee80211_get_he_iftype_cap
  3. ieee80211_get_he_sta_cap
  4. wiphy_read_of_freq_limits
  5. cfg80211_get_chandef_type
  6. cfg80211_chandef_identical
  7. cfg80211_chandef_is_edmg
  8. ieee80211_chandef_rate_flags
  9. ieee80211_chandef_max_power
  10. cfg80211_get_station
  11. get_random_mask_addr
  12. ieee80211_bss_get_ie
  13. wiphy_net
  14. wiphy_net_set
  15. wiphy_priv
  16. priv_to_wiphy
  17. set_wiphy_dev
  18. wiphy_dev
  19. wiphy_name
  20. wiphy_new
  21. wdev_address
  22. wdev_running
  23. wdev_priv
  24. ieee80211_data_to_8023
  25. cfg80211_find_ie_match
  26. cfg80211_find_elem
  27. cfg80211_find_ie
  28. cfg80211_find_ext_elem
  29. cfg80211_find_ext_ie
  30. cfg80211_find_vendor_ie
  31. cfg80211_inform_bss_width_frame
  32. cfg80211_inform_bss_frame
  33. cfg80211_gen_new_bssid
  34. cfg80211_inform_bss_width
  35. cfg80211_inform_bss
  36. cfg80211_get_ibss
  37. cfg80211_chandef_to_scan_width
  38. cfg80211_vendor_cmd_alloc_reply_skb
  39. cfg80211_vendor_event_alloc
  40. cfg80211_vendor_event_alloc_ucast
  41. cfg80211_vendor_event
  42. cfg80211_testmode_alloc_reply_skb
  43. cfg80211_testmode_reply
  44. cfg80211_testmode_alloc_event_skb
  45. cfg80211_testmode_event
  46. cfg80211_connect_bss
  47. cfg80211_connect_result
  48. cfg80211_connect_timeout
  49. cfg80211_sinfo_release_content
  50. cfg80211_del_sta
  51. ieee80211_ie_split
  52. wiphy_ext_feature_set
  53. wiphy_ext_feature_isset

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 #ifndef __NET_CFG80211_H
   3 #define __NET_CFG80211_H
   4 /*
   5  * 802.11 device and configuration interface
   6  *
   7  * Copyright 2006-2010  Johannes Berg <johannes@sipsolutions.net>
   8  * Copyright 2013-2014 Intel Mobile Communications GmbH
   9  * Copyright 2015-2017  Intel Deutschland GmbH
  10  * Copyright (C) 2018-2019 Intel Corporation
  11  */
  12 
  13 #include <linux/netdevice.h>
  14 #include <linux/debugfs.h>
  15 #include <linux/list.h>
  16 #include <linux/bug.h>
  17 #include <linux/netlink.h>
  18 #include <linux/skbuff.h>
  19 #include <linux/nl80211.h>
  20 #include <linux/if_ether.h>
  21 #include <linux/ieee80211.h>
  22 #include <linux/net.h>
  23 #include <net/regulatory.h>
  24 
  25 /**
  26  * DOC: Introduction
  27  *
  28  * cfg80211 is the configuration API for 802.11 devices in Linux. It bridges
  29  * userspace and drivers, and offers some utility functionality associated
  30  * with 802.11. cfg80211 must, directly or indirectly via mac80211, be used
  31  * by all modern wireless drivers in Linux, so that they offer a consistent
  32  * API through nl80211. For backward compatibility, cfg80211 also offers
  33  * wireless extensions to userspace, but hides them from drivers completely.
  34  *
  35  * Additionally, cfg80211 contains code to help enforce regulatory spectrum
  36  * use restrictions.
  37  */
  38 
  39 
  40 /**
  41  * DOC: Device registration
  42  *
  43  * In order for a driver to use cfg80211, it must register the hardware device
  44  * with cfg80211. This happens through a number of hardware capability structs
  45  * described below.
  46  *
  47  * The fundamental structure for each device is the 'wiphy', of which each
  48  * instance describes a physical wireless device connected to the system. Each
  49  * such wiphy can have zero, one, or many virtual interfaces associated with
  50  * it, which need to be identified as such by pointing the network interface's
  51  * @ieee80211_ptr pointer to a &struct wireless_dev which further describes
  52  * the wireless part of the interface, normally this struct is embedded in the
  53  * network interface's private data area. Drivers can optionally allow creating
  54  * or destroying virtual interfaces on the fly, but without at least one or the
  55  * ability to create some the wireless device isn't useful.
  56  *
  57  * Each wiphy structure contains device capability information, and also has
  58  * a pointer to the various operations the driver offers. The definitions and
  59  * structures here describe these capabilities in detail.
  60  */
  61 
  62 struct wiphy;
  63 
  64 /*
  65  * wireless hardware capability structures
  66  */
  67 
  68 /**
  69  * enum ieee80211_channel_flags - channel flags
  70  *
  71  * Channel flags set by the regulatory control code.
  72  *
  73  * @IEEE80211_CHAN_DISABLED: This channel is disabled.
  74  * @IEEE80211_CHAN_NO_IR: do not initiate radiation, this includes
  75  *      sending probe requests or beaconing.
  76  * @IEEE80211_CHAN_RADAR: Radar detection is required on this channel.
  77  * @IEEE80211_CHAN_NO_HT40PLUS: extension channel above this channel
  78  *      is not permitted.
  79  * @IEEE80211_CHAN_NO_HT40MINUS: extension channel below this channel
  80  *      is not permitted.
  81  * @IEEE80211_CHAN_NO_OFDM: OFDM is not allowed on this channel.
  82  * @IEEE80211_CHAN_NO_80MHZ: If the driver supports 80 MHz on the band,
  83  *      this flag indicates that an 80 MHz channel cannot use this
  84  *      channel as the control or any of the secondary channels.
  85  *      This may be due to the driver or due to regulatory bandwidth
  86  *      restrictions.
  87  * @IEEE80211_CHAN_NO_160MHZ: If the driver supports 160 MHz on the band,
  88  *      this flag indicates that an 160 MHz channel cannot use this
  89  *      channel as the control or any of the secondary channels.
  90  *      This may be due to the driver or due to regulatory bandwidth
  91  *      restrictions.
  92  * @IEEE80211_CHAN_INDOOR_ONLY: see %NL80211_FREQUENCY_ATTR_INDOOR_ONLY
  93  * @IEEE80211_CHAN_IR_CONCURRENT: see %NL80211_FREQUENCY_ATTR_IR_CONCURRENT
  94  * @IEEE80211_CHAN_NO_20MHZ: 20 MHz bandwidth is not permitted
  95  *      on this channel.
  96  * @IEEE80211_CHAN_NO_10MHZ: 10 MHz bandwidth is not permitted
  97  *      on this channel.
  98  *
  99  */
 100 enum ieee80211_channel_flags {
 101         IEEE80211_CHAN_DISABLED         = 1<<0,
 102         IEEE80211_CHAN_NO_IR            = 1<<1,
 103         /* hole at 1<<2 */
 104         IEEE80211_CHAN_RADAR            = 1<<3,
 105         IEEE80211_CHAN_NO_HT40PLUS      = 1<<4,
 106         IEEE80211_CHAN_NO_HT40MINUS     = 1<<5,
 107         IEEE80211_CHAN_NO_OFDM          = 1<<6,
 108         IEEE80211_CHAN_NO_80MHZ         = 1<<7,
 109         IEEE80211_CHAN_NO_160MHZ        = 1<<8,
 110         IEEE80211_CHAN_INDOOR_ONLY      = 1<<9,
 111         IEEE80211_CHAN_IR_CONCURRENT    = 1<<10,
 112         IEEE80211_CHAN_NO_20MHZ         = 1<<11,
 113         IEEE80211_CHAN_NO_10MHZ         = 1<<12,
 114 };
 115 
 116 #define IEEE80211_CHAN_NO_HT40 \
 117         (IEEE80211_CHAN_NO_HT40PLUS | IEEE80211_CHAN_NO_HT40MINUS)
 118 
 119 #define IEEE80211_DFS_MIN_CAC_TIME_MS           60000
 120 #define IEEE80211_DFS_MIN_NOP_TIME_MS           (30 * 60 * 1000)
 121 
 122 /**
 123  * struct ieee80211_channel - channel definition
 124  *
 125  * This structure describes a single channel for use
 126  * with cfg80211.
 127  *
 128  * @center_freq: center frequency in MHz
 129  * @hw_value: hardware-specific value for the channel
 130  * @flags: channel flags from &enum ieee80211_channel_flags.
 131  * @orig_flags: channel flags at registration time, used by regulatory
 132  *      code to support devices with additional restrictions
 133  * @band: band this channel belongs to.
 134  * @max_antenna_gain: maximum antenna gain in dBi
 135  * @max_power: maximum transmission power (in dBm)
 136  * @max_reg_power: maximum regulatory transmission power (in dBm)
 137  * @beacon_found: helper to regulatory code to indicate when a beacon
 138  *      has been found on this channel. Use regulatory_hint_found_beacon()
 139  *      to enable this, this is useful only on 5 GHz band.
 140  * @orig_mag: internal use
 141  * @orig_mpwr: internal use
 142  * @dfs_state: current state of this channel. Only relevant if radar is required
 143  *      on this channel.
 144  * @dfs_state_entered: timestamp (jiffies) when the dfs state was entered.
 145  * @dfs_cac_ms: DFS CAC time in milliseconds, this is valid for DFS channels.
 146  */
 147 struct ieee80211_channel {
 148         enum nl80211_band band;
 149         u32 center_freq;
 150         u16 hw_value;
 151         u32 flags;
 152         int max_antenna_gain;
 153         int max_power;
 154         int max_reg_power;
 155         bool beacon_found;
 156         u32 orig_flags;
 157         int orig_mag, orig_mpwr;
 158         enum nl80211_dfs_state dfs_state;
 159         unsigned long dfs_state_entered;
 160         unsigned int dfs_cac_ms;
 161 };
 162 
 163 /**
 164  * enum ieee80211_rate_flags - rate flags
 165  *
 166  * Hardware/specification flags for rates. These are structured
 167  * in a way that allows using the same bitrate structure for
 168  * different bands/PHY modes.
 169  *
 170  * @IEEE80211_RATE_SHORT_PREAMBLE: Hardware can send with short
 171  *      preamble on this bitrate; only relevant in 2.4GHz band and
 172  *      with CCK rates.
 173  * @IEEE80211_RATE_MANDATORY_A: This bitrate is a mandatory rate
 174  *      when used with 802.11a (on the 5 GHz band); filled by the
 175  *      core code when registering the wiphy.
 176  * @IEEE80211_RATE_MANDATORY_B: This bitrate is a mandatory rate
 177  *      when used with 802.11b (on the 2.4 GHz band); filled by the
 178  *      core code when registering the wiphy.
 179  * @IEEE80211_RATE_MANDATORY_G: This bitrate is a mandatory rate
 180  *      when used with 802.11g (on the 2.4 GHz band); filled by the
 181  *      core code when registering the wiphy.
 182  * @IEEE80211_RATE_ERP_G: This is an ERP rate in 802.11g mode.
 183  * @IEEE80211_RATE_SUPPORTS_5MHZ: Rate can be used in 5 MHz mode
 184  * @IEEE80211_RATE_SUPPORTS_10MHZ: Rate can be used in 10 MHz mode
 185  */
 186 enum ieee80211_rate_flags {
 187         IEEE80211_RATE_SHORT_PREAMBLE   = 1<<0,
 188         IEEE80211_RATE_MANDATORY_A      = 1<<1,
 189         IEEE80211_RATE_MANDATORY_B      = 1<<2,
 190         IEEE80211_RATE_MANDATORY_G      = 1<<3,
 191         IEEE80211_RATE_ERP_G            = 1<<4,
 192         IEEE80211_RATE_SUPPORTS_5MHZ    = 1<<5,
 193         IEEE80211_RATE_SUPPORTS_10MHZ   = 1<<6,
 194 };
 195 
 196 /**
 197  * enum ieee80211_bss_type - BSS type filter
 198  *
 199  * @IEEE80211_BSS_TYPE_ESS: Infrastructure BSS
 200  * @IEEE80211_BSS_TYPE_PBSS: Personal BSS
 201  * @IEEE80211_BSS_TYPE_IBSS: Independent BSS
 202  * @IEEE80211_BSS_TYPE_MBSS: Mesh BSS
 203  * @IEEE80211_BSS_TYPE_ANY: Wildcard value for matching any BSS type
 204  */
 205 enum ieee80211_bss_type {
 206         IEEE80211_BSS_TYPE_ESS,
 207         IEEE80211_BSS_TYPE_PBSS,
 208         IEEE80211_BSS_TYPE_IBSS,
 209         IEEE80211_BSS_TYPE_MBSS,
 210         IEEE80211_BSS_TYPE_ANY
 211 };
 212 
 213 /**
 214  * enum ieee80211_privacy - BSS privacy filter
 215  *
 216  * @IEEE80211_PRIVACY_ON: privacy bit set
 217  * @IEEE80211_PRIVACY_OFF: privacy bit clear
 218  * @IEEE80211_PRIVACY_ANY: Wildcard value for matching any privacy setting
 219  */
 220 enum ieee80211_privacy {
 221         IEEE80211_PRIVACY_ON,
 222         IEEE80211_PRIVACY_OFF,
 223         IEEE80211_PRIVACY_ANY
 224 };
 225 
 226 #define IEEE80211_PRIVACY(x)    \
 227         ((x) ? IEEE80211_PRIVACY_ON : IEEE80211_PRIVACY_OFF)
 228 
 229 /**
 230  * struct ieee80211_rate - bitrate definition
 231  *
 232  * This structure describes a bitrate that an 802.11 PHY can
 233  * operate with. The two values @hw_value and @hw_value_short
 234  * are only for driver use when pointers to this structure are
 235  * passed around.
 236  *
 237  * @flags: rate-specific flags
 238  * @bitrate: bitrate in units of 100 Kbps
 239  * @hw_value: driver/hardware value for this rate
 240  * @hw_value_short: driver/hardware value for this rate when
 241  *      short preamble is used
 242  */
 243 struct ieee80211_rate {
 244         u32 flags;
 245         u16 bitrate;
 246         u16 hw_value, hw_value_short;
 247 };
 248 
 249 /**
 250  * struct ieee80211_he_obss_pd - AP settings for spatial reuse
 251  *
 252  * @enable: is the feature enabled.
 253  * @min_offset: minimal tx power offset an associated station shall use
 254  * @max_offset: maximum tx power offset an associated station shall use
 255  */
 256 struct ieee80211_he_obss_pd {
 257         bool enable;
 258         u8 min_offset;
 259         u8 max_offset;
 260 };
 261 
 262 /**
 263  * struct ieee80211_sta_ht_cap - STA's HT capabilities
 264  *
 265  * This structure describes most essential parameters needed
 266  * to describe 802.11n HT capabilities for an STA.
 267  *
 268  * @ht_supported: is HT supported by the STA
 269  * @cap: HT capabilities map as described in 802.11n spec
 270  * @ampdu_factor: Maximum A-MPDU length factor
 271  * @ampdu_density: Minimum A-MPDU spacing
 272  * @mcs: Supported MCS rates
 273  */
 274 struct ieee80211_sta_ht_cap {
 275         u16 cap; /* use IEEE80211_HT_CAP_ */
 276         bool ht_supported;
 277         u8 ampdu_factor;
 278         u8 ampdu_density;
 279         struct ieee80211_mcs_info mcs;
 280 };
 281 
 282 /**
 283  * struct ieee80211_sta_vht_cap - STA's VHT capabilities
 284  *
 285  * This structure describes most essential parameters needed
 286  * to describe 802.11ac VHT capabilities for an STA.
 287  *
 288  * @vht_supported: is VHT supported by the STA
 289  * @cap: VHT capabilities map as described in 802.11ac spec
 290  * @vht_mcs: Supported VHT MCS rates
 291  */
 292 struct ieee80211_sta_vht_cap {
 293         bool vht_supported;
 294         u32 cap; /* use IEEE80211_VHT_CAP_ */
 295         struct ieee80211_vht_mcs_info vht_mcs;
 296 };
 297 
 298 #define IEEE80211_HE_PPE_THRES_MAX_LEN          25
 299 
 300 /**
 301  * struct ieee80211_sta_he_cap - STA's HE capabilities
 302  *
 303  * This structure describes most essential parameters needed
 304  * to describe 802.11ax HE capabilities for a STA.
 305  *
 306  * @has_he: true iff HE data is valid.
 307  * @he_cap_elem: Fixed portion of the HE capabilities element.
 308  * @he_mcs_nss_supp: The supported NSS/MCS combinations.
 309  * @ppe_thres: Holds the PPE Thresholds data.
 310  */
 311 struct ieee80211_sta_he_cap {
 312         bool has_he;
 313         struct ieee80211_he_cap_elem he_cap_elem;
 314         struct ieee80211_he_mcs_nss_supp he_mcs_nss_supp;
 315         u8 ppe_thres[IEEE80211_HE_PPE_THRES_MAX_LEN];
 316 };
 317 
 318 /**
 319  * struct ieee80211_sband_iftype_data
 320  *
 321  * This structure encapsulates sband data that is relevant for the
 322  * interface types defined in @types_mask.  Each type in the
 323  * @types_mask must be unique across all instances of iftype_data.
 324  *
 325  * @types_mask: interface types mask
 326  * @he_cap: holds the HE capabilities
 327  */
 328 struct ieee80211_sband_iftype_data {
 329         u16 types_mask;
 330         struct ieee80211_sta_he_cap he_cap;
 331 };
 332 
 333 /**
 334  * enum ieee80211_edmg_bw_config - allowed channel bandwidth configurations
 335  *
 336  * @IEEE80211_EDMG_BW_CONFIG_4: 2.16GHz
 337  * @IEEE80211_EDMG_BW_CONFIG_5: 2.16GHz and 4.32GHz
 338  * @IEEE80211_EDMG_BW_CONFIG_6: 2.16GHz, 4.32GHz and 6.48GHz
 339  * @IEEE80211_EDMG_BW_CONFIG_7: 2.16GHz, 4.32GHz, 6.48GHz and 8.64GHz
 340  * @IEEE80211_EDMG_BW_CONFIG_8: 2.16GHz and 2.16GHz + 2.16GHz
 341  * @IEEE80211_EDMG_BW_CONFIG_9: 2.16GHz, 4.32GHz and 2.16GHz + 2.16GHz
 342  * @IEEE80211_EDMG_BW_CONFIG_10: 2.16GHz, 4.32GHz, 6.48GHz and 2.16GHz+2.16GHz
 343  * @IEEE80211_EDMG_BW_CONFIG_11: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz and
 344  *      2.16GHz+2.16GHz
 345  * @IEEE80211_EDMG_BW_CONFIG_12: 2.16GHz, 2.16GHz + 2.16GHz and
 346  *      4.32GHz + 4.32GHz
 347  * @IEEE80211_EDMG_BW_CONFIG_13: 2.16GHz, 4.32GHz, 2.16GHz + 2.16GHz and
 348  *      4.32GHz + 4.32GHz
 349  * @IEEE80211_EDMG_BW_CONFIG_14: 2.16GHz, 4.32GHz, 6.48GHz, 2.16GHz + 2.16GHz
 350  *      and 4.32GHz + 4.32GHz
 351  * @IEEE80211_EDMG_BW_CONFIG_15: 2.16GHz, 4.32GHz, 6.48GHz, 8.64GHz,
 352  *      2.16GHz + 2.16GHz and 4.32GHz + 4.32GHz
 353  */
 354 enum ieee80211_edmg_bw_config {
 355         IEEE80211_EDMG_BW_CONFIG_4      = 4,
 356         IEEE80211_EDMG_BW_CONFIG_5      = 5,
 357         IEEE80211_EDMG_BW_CONFIG_6      = 6,
 358         IEEE80211_EDMG_BW_CONFIG_7      = 7,
 359         IEEE80211_EDMG_BW_CONFIG_8      = 8,
 360         IEEE80211_EDMG_BW_CONFIG_9      = 9,
 361         IEEE80211_EDMG_BW_CONFIG_10     = 10,
 362         IEEE80211_EDMG_BW_CONFIG_11     = 11,
 363         IEEE80211_EDMG_BW_CONFIG_12     = 12,
 364         IEEE80211_EDMG_BW_CONFIG_13     = 13,
 365         IEEE80211_EDMG_BW_CONFIG_14     = 14,
 366         IEEE80211_EDMG_BW_CONFIG_15     = 15,
 367 };
 368 
 369 /**
 370  * struct ieee80211_edmg - EDMG configuration
 371  *
 372  * This structure describes most essential parameters needed
 373  * to describe 802.11ay EDMG configuration
 374  *
 375  * @channels: bitmap that indicates the 2.16 GHz channel(s)
 376  *      that are allowed to be used for transmissions.
 377  *      Bit 0 indicates channel 1, bit 1 indicates channel 2, etc.
 378  *      Set to 0 indicate EDMG not supported.
 379  * @bw_config: Channel BW Configuration subfield encodes
 380  *      the allowed channel bandwidth configurations
 381  */
 382 struct ieee80211_edmg {
 383         u8 channels;
 384         enum ieee80211_edmg_bw_config bw_config;
 385 };
 386 
 387 /**
 388  * struct ieee80211_supported_band - frequency band definition
 389  *
 390  * This structure describes a frequency band a wiphy
 391  * is able to operate in.
 392  *
 393  * @channels: Array of channels the hardware can operate in
 394  *      in this band.
 395  * @band: the band this structure represents
 396  * @n_channels: Number of channels in @channels
 397  * @bitrates: Array of bitrates the hardware can operate with
 398  *      in this band. Must be sorted to give a valid "supported
 399  *      rates" IE, i.e. CCK rates first, then OFDM.
 400  * @n_bitrates: Number of bitrates in @bitrates
 401  * @ht_cap: HT capabilities in this band
 402  * @vht_cap: VHT capabilities in this band
 403  * @edmg_cap: EDMG capabilities in this band
 404  * @n_iftype_data: number of iftype data entries
 405  * @iftype_data: interface type data entries.  Note that the bits in
 406  *      @types_mask inside this structure cannot overlap (i.e. only
 407  *      one occurrence of each type is allowed across all instances of
 408  *      iftype_data).
 409  */
 410 struct ieee80211_supported_band {
 411         struct ieee80211_channel *channels;
 412         struct ieee80211_rate *bitrates;
 413         enum nl80211_band band;
 414         int n_channels;
 415         int n_bitrates;
 416         struct ieee80211_sta_ht_cap ht_cap;
 417         struct ieee80211_sta_vht_cap vht_cap;
 418         struct ieee80211_edmg edmg_cap;
 419         u16 n_iftype_data;
 420         const struct ieee80211_sband_iftype_data *iftype_data;
 421 };
 422 
 423 /**
 424  * ieee80211_get_sband_iftype_data - return sband data for a given iftype
 425  * @sband: the sband to search for the STA on
 426  * @iftype: enum nl80211_iftype
 427  *
 428  * Return: pointer to struct ieee80211_sband_iftype_data, or NULL is none found
 429  */
 430 static inline const struct ieee80211_sband_iftype_data *
 431 ieee80211_get_sband_iftype_data(const struct ieee80211_supported_band *sband,
 432                                 u8 iftype)
 433 {
 434         int i;
 435 
 436         if (WARN_ON(iftype >= NL80211_IFTYPE_MAX))
 437                 return NULL;
 438 
 439         for (i = 0; i < sband->n_iftype_data; i++)  {
 440                 const struct ieee80211_sband_iftype_data *data =
 441                         &sband->iftype_data[i];
 442 
 443                 if (data->types_mask & BIT(iftype))
 444                         return data;
 445         }
 446 
 447         return NULL;
 448 }
 449 
 450 /**
 451  * ieee80211_get_he_iftype_cap - return HE capabilities for an sband's iftype
 452  * @sband: the sband to search for the iftype on
 453  * @iftype: enum nl80211_iftype
 454  *
 455  * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
 456  */
 457 static inline const struct ieee80211_sta_he_cap *
 458 ieee80211_get_he_iftype_cap(const struct ieee80211_supported_band *sband,
 459                             u8 iftype)
 460 {
 461         const struct ieee80211_sband_iftype_data *data =
 462                 ieee80211_get_sband_iftype_data(sband, iftype);
 463 
 464         if (data && data->he_cap.has_he)
 465                 return &data->he_cap;
 466 
 467         return NULL;
 468 }
 469 
 470 /**
 471  * ieee80211_get_he_sta_cap - return HE capabilities for an sband's STA
 472  * @sband: the sband to search for the STA on
 473  *
 474  * Return: pointer to the struct ieee80211_sta_he_cap, or NULL is none found
 475  */
 476 static inline const struct ieee80211_sta_he_cap *
 477 ieee80211_get_he_sta_cap(const struct ieee80211_supported_band *sband)
 478 {
 479         return ieee80211_get_he_iftype_cap(sband, NL80211_IFTYPE_STATION);
 480 }
 481 
 482 /**
 483  * wiphy_read_of_freq_limits - read frequency limits from device tree
 484  *
 485  * @wiphy: the wireless device to get extra limits for
 486  *
 487  * Some devices may have extra limitations specified in DT. This may be useful
 488  * for chipsets that normally support more bands but are limited due to board
 489  * design (e.g. by antennas or external power amplifier).
 490  *
 491  * This function reads info from DT and uses it to *modify* channels (disable
 492  * unavailable ones). It's usually a *bad* idea to use it in drivers with
 493  * shared channel data as DT limitations are device specific. You should make
 494  * sure to call it only if channels in wiphy are copied and can be modified
 495  * without affecting other devices.
 496  *
 497  * As this function access device node it has to be called after set_wiphy_dev.
 498  * It also modifies channels so they have to be set first.
 499  * If using this helper, call it before wiphy_register().
 500  */
 501 #ifdef CONFIG_OF
 502 void wiphy_read_of_freq_limits(struct wiphy *wiphy);
 503 #else /* CONFIG_OF */
 504 static inline void wiphy_read_of_freq_limits(struct wiphy *wiphy)
 505 {
 506 }
 507 #endif /* !CONFIG_OF */
 508 
 509 
 510 /*
 511  * Wireless hardware/device configuration structures and methods
 512  */
 513 
 514 /**
 515  * DOC: Actions and configuration
 516  *
 517  * Each wireless device and each virtual interface offer a set of configuration
 518  * operations and other actions that are invoked by userspace. Each of these
 519  * actions is described in the operations structure, and the parameters these
 520  * operations use are described separately.
 521  *
 522  * Additionally, some operations are asynchronous and expect to get status
 523  * information via some functions that drivers need to call.
 524  *
 525  * Scanning and BSS list handling with its associated functionality is described
 526  * in a separate chapter.
 527  */
 528 
 529 #define VHT_MUMIMO_GROUPS_DATA_LEN (WLAN_MEMBERSHIP_LEN +\
 530                                     WLAN_USER_POSITION_LEN)
 531 
 532 /**
 533  * struct vif_params - describes virtual interface parameters
 534  * @flags: monitor interface flags, unchanged if 0, otherwise
 535  *      %MONITOR_FLAG_CHANGED will be set
 536  * @use_4addr: use 4-address frames
 537  * @macaddr: address to use for this virtual interface.
 538  *      If this parameter is set to zero address the driver may
 539  *      determine the address as needed.
 540  *      This feature is only fully supported by drivers that enable the
 541  *      %NL80211_FEATURE_MAC_ON_CREATE flag.  Others may support creating
 542  **     only p2p devices with specified MAC.
 543  * @vht_mumimo_groups: MU-MIMO groupID, used for monitoring MU-MIMO packets
 544  *      belonging to that MU-MIMO groupID; %NULL if not changed
 545  * @vht_mumimo_follow_addr: MU-MIMO follow address, used for monitoring
 546  *      MU-MIMO packets going to the specified station; %NULL if not changed
 547  */
 548 struct vif_params {
 549         u32 flags;
 550         int use_4addr;
 551         u8 macaddr[ETH_ALEN];
 552         const u8 *vht_mumimo_groups;
 553         const u8 *vht_mumimo_follow_addr;
 554 };
 555 
 556 /**
 557  * struct key_params - key information
 558  *
 559  * Information about a key
 560  *
 561  * @key: key material
 562  * @key_len: length of key material
 563  * @cipher: cipher suite selector
 564  * @seq: sequence counter (IV/PN) for TKIP and CCMP keys, only used
 565  *      with the get_key() callback, must be in little endian,
 566  *      length given by @seq_len.
 567  * @seq_len: length of @seq.
 568  * @mode: key install mode (RX_TX, NO_TX or SET_TX)
 569  */
 570 struct key_params {
 571         const u8 *key;
 572         const u8 *seq;
 573         int key_len;
 574         int seq_len;
 575         u32 cipher;
 576         enum nl80211_key_mode mode;
 577 };
 578 
 579 /**
 580  * struct cfg80211_chan_def - channel definition
 581  * @chan: the (control) channel
 582  * @width: channel width
 583  * @center_freq1: center frequency of first segment
 584  * @center_freq2: center frequency of second segment
 585  *      (only with 80+80 MHz)
 586  * @edmg: define the EDMG channels configuration.
 587  *      If edmg is requested (i.e. the .channels member is non-zero),
 588  *      chan will define the primary channel and all other
 589  *      parameters are ignored.
 590  */
 591 struct cfg80211_chan_def {
 592         struct ieee80211_channel *chan;
 593         enum nl80211_chan_width width;
 594         u32 center_freq1;
 595         u32 center_freq2;
 596         struct ieee80211_edmg edmg;
 597 };
 598 
 599 /**
 600  * cfg80211_get_chandef_type - return old channel type from chandef
 601  * @chandef: the channel definition
 602  *
 603  * Return: The old channel type (NOHT, HT20, HT40+/-) from a given
 604  * chandef, which must have a bandwidth allowing this conversion.
 605  */
 606 static inline enum nl80211_channel_type
 607 cfg80211_get_chandef_type(const struct cfg80211_chan_def *chandef)
 608 {
 609         switch (chandef->width) {
 610         case NL80211_CHAN_WIDTH_20_NOHT:
 611                 return NL80211_CHAN_NO_HT;
 612         case NL80211_CHAN_WIDTH_20:
 613                 return NL80211_CHAN_HT20;
 614         case NL80211_CHAN_WIDTH_40:
 615                 if (chandef->center_freq1 > chandef->chan->center_freq)
 616                         return NL80211_CHAN_HT40PLUS;
 617                 return NL80211_CHAN_HT40MINUS;
 618         default:
 619                 WARN_ON(1);
 620                 return NL80211_CHAN_NO_HT;
 621         }
 622 }
 623 
 624 /**
 625  * cfg80211_chandef_create - create channel definition using channel type
 626  * @chandef: the channel definition struct to fill
 627  * @channel: the control channel
 628  * @chantype: the channel type
 629  *
 630  * Given a channel type, create a channel definition.
 631  */
 632 void cfg80211_chandef_create(struct cfg80211_chan_def *chandef,
 633                              struct ieee80211_channel *channel,
 634                              enum nl80211_channel_type chantype);
 635 
 636 /**
 637  * cfg80211_chandef_identical - check if two channel definitions are identical
 638  * @chandef1: first channel definition
 639  * @chandef2: second channel definition
 640  *
 641  * Return: %true if the channels defined by the channel definitions are
 642  * identical, %false otherwise.
 643  */
 644 static inline bool
 645 cfg80211_chandef_identical(const struct cfg80211_chan_def *chandef1,
 646                            const struct cfg80211_chan_def *chandef2)
 647 {
 648         return (chandef1->chan == chandef2->chan &&
 649                 chandef1->width == chandef2->width &&
 650                 chandef1->center_freq1 == chandef2->center_freq1 &&
 651                 chandef1->center_freq2 == chandef2->center_freq2);
 652 }
 653 
 654 /**
 655  * cfg80211_chandef_is_edmg - check if chandef represents an EDMG channel
 656  *
 657  * @chandef: the channel definition
 658  *
 659  * Return: %true if EDMG defined, %false otherwise.
 660  */
 661 static inline bool
 662 cfg80211_chandef_is_edmg(const struct cfg80211_chan_def *chandef)
 663 {
 664         return chandef->edmg.channels || chandef->edmg.bw_config;
 665 }
 666 
 667 /**
 668  * cfg80211_chandef_compatible - check if two channel definitions are compatible
 669  * @chandef1: first channel definition
 670  * @chandef2: second channel definition
 671  *
 672  * Return: %NULL if the given channel definitions are incompatible,
 673  * chandef1 or chandef2 otherwise.
 674  */
 675 const struct cfg80211_chan_def *
 676 cfg80211_chandef_compatible(const struct cfg80211_chan_def *chandef1,
 677                             const struct cfg80211_chan_def *chandef2);
 678 
 679 /**
 680  * cfg80211_chandef_valid - check if a channel definition is valid
 681  * @chandef: the channel definition to check
 682  * Return: %true if the channel definition is valid. %false otherwise.
 683  */
 684 bool cfg80211_chandef_valid(const struct cfg80211_chan_def *chandef);
 685 
 686 /**
 687  * cfg80211_chandef_usable - check if secondary channels can be used
 688  * @wiphy: the wiphy to validate against
 689  * @chandef: the channel definition to check
 690  * @prohibited_flags: the regulatory channel flags that must not be set
 691  * Return: %true if secondary channels are usable. %false otherwise.
 692  */
 693 bool cfg80211_chandef_usable(struct wiphy *wiphy,
 694                              const struct cfg80211_chan_def *chandef,
 695                              u32 prohibited_flags);
 696 
 697 /**
 698  * cfg80211_chandef_dfs_required - checks if radar detection is required
 699  * @wiphy: the wiphy to validate against
 700  * @chandef: the channel definition to check
 701  * @iftype: the interface type as specified in &enum nl80211_iftype
 702  * Returns:
 703  *      1 if radar detection is required, 0 if it is not, < 0 on error
 704  */
 705 int cfg80211_chandef_dfs_required(struct wiphy *wiphy,
 706                                   const struct cfg80211_chan_def *chandef,
 707                                   enum nl80211_iftype iftype);
 708 
 709 /**
 710  * ieee80211_chandef_rate_flags - returns rate flags for a channel
 711  *
 712  * In some channel types, not all rates may be used - for example CCK
 713  * rates may not be used in 5/10 MHz channels.
 714  *
 715  * @chandef: channel definition for the channel
 716  *
 717  * Returns: rate flags which apply for this channel
 718  */
 719 static inline enum ieee80211_rate_flags
 720 ieee80211_chandef_rate_flags(struct cfg80211_chan_def *chandef)
 721 {
 722         switch (chandef->width) {
 723         case NL80211_CHAN_WIDTH_5:
 724                 return IEEE80211_RATE_SUPPORTS_5MHZ;
 725         case NL80211_CHAN_WIDTH_10:
 726                 return IEEE80211_RATE_SUPPORTS_10MHZ;
 727         default:
 728                 break;
 729         }
 730         return 0;
 731 }
 732 
 733 /**
 734  * ieee80211_chandef_max_power - maximum transmission power for the chandef
 735  *
 736  * In some regulations, the transmit power may depend on the configured channel
 737  * bandwidth which may be defined as dBm/MHz. This function returns the actual
 738  * max_power for non-standard (20 MHz) channels.
 739  *
 740  * @chandef: channel definition for the channel
 741  *
 742  * Returns: maximum allowed transmission power in dBm for the chandef
 743  */
 744 static inline int
 745 ieee80211_chandef_max_power(struct cfg80211_chan_def *chandef)
 746 {
 747         switch (chandef->width) {
 748         case NL80211_CHAN_WIDTH_5:
 749                 return min(chandef->chan->max_reg_power - 6,
 750                            chandef->chan->max_power);
 751         case NL80211_CHAN_WIDTH_10:
 752                 return min(chandef->chan->max_reg_power - 3,
 753                            chandef->chan->max_power);
 754         default:
 755                 break;
 756         }
 757         return chandef->chan->max_power;
 758 }
 759 
 760 /**
 761  * enum survey_info_flags - survey information flags
 762  *
 763  * @SURVEY_INFO_NOISE_DBM: noise (in dBm) was filled in
 764  * @SURVEY_INFO_IN_USE: channel is currently being used
 765  * @SURVEY_INFO_TIME: active time (in ms) was filled in
 766  * @SURVEY_INFO_TIME_BUSY: busy time was filled in
 767  * @SURVEY_INFO_TIME_EXT_BUSY: extension channel busy time was filled in
 768  * @SURVEY_INFO_TIME_RX: receive time was filled in
 769  * @SURVEY_INFO_TIME_TX: transmit time was filled in
 770  * @SURVEY_INFO_TIME_SCAN: scan time was filled in
 771  * @SURVEY_INFO_TIME_BSS_RX: local BSS receive time was filled in
 772  *
 773  * Used by the driver to indicate which info in &struct survey_info
 774  * it has filled in during the get_survey().
 775  */
 776 enum survey_info_flags {
 777         SURVEY_INFO_NOISE_DBM           = BIT(0),
 778         SURVEY_INFO_IN_USE              = BIT(1),
 779         SURVEY_INFO_TIME                = BIT(2),
 780         SURVEY_INFO_TIME_BUSY           = BIT(3),
 781         SURVEY_INFO_TIME_EXT_BUSY       = BIT(4),
 782         SURVEY_INFO_TIME_RX             = BIT(5),
 783         SURVEY_INFO_TIME_TX             = BIT(6),
 784         SURVEY_INFO_TIME_SCAN           = BIT(7),
 785         SURVEY_INFO_TIME_BSS_RX         = BIT(8),
 786 };
 787 
 788 /**
 789  * struct survey_info - channel survey response
 790  *
 791  * @channel: the channel this survey record reports, may be %NULL for a single
 792  *      record to report global statistics
 793  * @filled: bitflag of flags from &enum survey_info_flags
 794  * @noise: channel noise in dBm. This and all following fields are
 795  *      optional
 796  * @time: amount of time in ms the radio was turn on (on the channel)
 797  * @time_busy: amount of time the primary channel was sensed busy
 798  * @time_ext_busy: amount of time the extension channel was sensed busy
 799  * @time_rx: amount of time the radio spent receiving data
 800  * @time_tx: amount of time the radio spent transmitting data
 801  * @time_scan: amount of time the radio spent for scanning
 802  * @time_bss_rx: amount of time the radio spent receiving data on a local BSS
 803  *
 804  * Used by dump_survey() to report back per-channel survey information.
 805  *
 806  * This structure can later be expanded with things like
 807  * channel duty cycle etc.
 808  */
 809 struct survey_info {
 810         struct ieee80211_channel *channel;
 811         u64 time;
 812         u64 time_busy;
 813         u64 time_ext_busy;
 814         u64 time_rx;
 815         u64 time_tx;
 816         u64 time_scan;
 817         u64 time_bss_rx;
 818         u32 filled;
 819         s8 noise;
 820 };
 821 
 822 #define CFG80211_MAX_WEP_KEYS   4
 823 
 824 /**
 825  * struct cfg80211_crypto_settings - Crypto settings
 826  * @wpa_versions: indicates which, if any, WPA versions are enabled
 827  *      (from enum nl80211_wpa_versions)
 828  * @cipher_group: group key cipher suite (or 0 if unset)
 829  * @n_ciphers_pairwise: number of AP supported unicast ciphers
 830  * @ciphers_pairwise: unicast key cipher suites
 831  * @n_akm_suites: number of AKM suites
 832  * @akm_suites: AKM suites
 833  * @control_port: Whether user space controls IEEE 802.1X port, i.e.,
 834  *      sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
 835  *      required to assume that the port is unauthorized until authorized by
 836  *      user space. Otherwise, port is marked authorized by default.
 837  * @control_port_ethertype: the control port protocol that should be
 838  *      allowed through even on unauthorized ports
 839  * @control_port_no_encrypt: TRUE to prevent encryption of control port
 840  *      protocol frames.
 841  * @control_port_over_nl80211: TRUE if userspace expects to exchange control
 842  *      port frames over NL80211 instead of the network interface.
 843  * @wep_keys: static WEP keys, if not NULL points to an array of
 844  *      CFG80211_MAX_WEP_KEYS WEP keys
 845  * @wep_tx_key: key index (0..3) of the default TX static WEP key
 846  * @psk: PSK (for devices supporting 4-way-handshake offload)
 847  * @sae_pwd: password for SAE authentication (for devices supporting SAE
 848  *      offload)
 849  * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
 850  */
 851 struct cfg80211_crypto_settings {
 852         u32 wpa_versions;
 853         u32 cipher_group;
 854         int n_ciphers_pairwise;
 855         u32 ciphers_pairwise[NL80211_MAX_NR_CIPHER_SUITES];
 856         int n_akm_suites;
 857         u32 akm_suites[NL80211_MAX_NR_AKM_SUITES];
 858         bool control_port;
 859         __be16 control_port_ethertype;
 860         bool control_port_no_encrypt;
 861         bool control_port_over_nl80211;
 862         struct key_params *wep_keys;
 863         int wep_tx_key;
 864         const u8 *psk;
 865         const u8 *sae_pwd;
 866         u8 sae_pwd_len;
 867 };
 868 
 869 /**
 870  * struct cfg80211_beacon_data - beacon data
 871  * @head: head portion of beacon (before TIM IE)
 872  *      or %NULL if not changed
 873  * @tail: tail portion of beacon (after TIM IE)
 874  *      or %NULL if not changed
 875  * @head_len: length of @head
 876  * @tail_len: length of @tail
 877  * @beacon_ies: extra information element(s) to add into Beacon frames or %NULL
 878  * @beacon_ies_len: length of beacon_ies in octets
 879  * @proberesp_ies: extra information element(s) to add into Probe Response
 880  *      frames or %NULL
 881  * @proberesp_ies_len: length of proberesp_ies in octets
 882  * @assocresp_ies: extra information element(s) to add into (Re)Association
 883  *      Response frames or %NULL
 884  * @assocresp_ies_len: length of assocresp_ies in octets
 885  * @probe_resp_len: length of probe response template (@probe_resp)
 886  * @probe_resp: probe response template (AP mode only)
 887  * @ftm_responder: enable FTM responder functionality; -1 for no change
 888  *      (which also implies no change in LCI/civic location data)
 889  * @lci: Measurement Report element content, starting with Measurement Token
 890  *      (measurement type 8)
 891  * @civicloc: Measurement Report element content, starting with Measurement
 892  *      Token (measurement type 11)
 893  * @lci_len: LCI data length
 894  * @civicloc_len: Civic location data length
 895  */
 896 struct cfg80211_beacon_data {
 897         const u8 *head, *tail;
 898         const u8 *beacon_ies;
 899         const u8 *proberesp_ies;
 900         const u8 *assocresp_ies;
 901         const u8 *probe_resp;
 902         const u8 *lci;
 903         const u8 *civicloc;
 904         s8 ftm_responder;
 905 
 906         size_t head_len, tail_len;
 907         size_t beacon_ies_len;
 908         size_t proberesp_ies_len;
 909         size_t assocresp_ies_len;
 910         size_t probe_resp_len;
 911         size_t lci_len;
 912         size_t civicloc_len;
 913 };
 914 
 915 struct mac_address {
 916         u8 addr[ETH_ALEN];
 917 };
 918 
 919 /**
 920  * struct cfg80211_acl_data - Access control list data
 921  *
 922  * @acl_policy: ACL policy to be applied on the station's
 923  *      entry specified by mac_addr
 924  * @n_acl_entries: Number of MAC address entries passed
 925  * @mac_addrs: List of MAC addresses of stations to be used for ACL
 926  */
 927 struct cfg80211_acl_data {
 928         enum nl80211_acl_policy acl_policy;
 929         int n_acl_entries;
 930 
 931         /* Keep it last */
 932         struct mac_address mac_addrs[];
 933 };
 934 
 935 /*
 936  * cfg80211_bitrate_mask - masks for bitrate control
 937  */
 938 struct cfg80211_bitrate_mask {
 939         struct {
 940                 u32 legacy;
 941                 u8 ht_mcs[IEEE80211_HT_MCS_MASK_LEN];
 942                 u16 vht_mcs[NL80211_VHT_NSS_MAX];
 943                 enum nl80211_txrate_gi gi;
 944         } control[NUM_NL80211_BANDS];
 945 };
 946 
 947 /**
 948  * enum cfg80211_ap_settings_flags - AP settings flags
 949  *
 950  * Used by cfg80211_ap_settings
 951  *
 952  * @AP_SETTINGS_EXTERNAL_AUTH_SUPPORT: AP supports external authentication
 953  */
 954 enum cfg80211_ap_settings_flags {
 955         AP_SETTINGS_EXTERNAL_AUTH_SUPPORT = BIT(0),
 956 };
 957 
 958 /**
 959  * struct cfg80211_ap_settings - AP configuration
 960  *
 961  * Used to configure an AP interface.
 962  *
 963  * @chandef: defines the channel to use
 964  * @beacon: beacon data
 965  * @beacon_interval: beacon interval
 966  * @dtim_period: DTIM period
 967  * @ssid: SSID to be used in the BSS (note: may be %NULL if not provided from
 968  *      user space)
 969  * @ssid_len: length of @ssid
 970  * @hidden_ssid: whether to hide the SSID in Beacon/Probe Response frames
 971  * @crypto: crypto settings
 972  * @privacy: the BSS uses privacy
 973  * @auth_type: Authentication type (algorithm)
 974  * @smps_mode: SMPS mode
 975  * @inactivity_timeout: time in seconds to determine station's inactivity.
 976  * @p2p_ctwindow: P2P CT Window
 977  * @p2p_opp_ps: P2P opportunistic PS
 978  * @acl: ACL configuration used by the drivers which has support for
 979  *      MAC address based access control
 980  * @pbss: If set, start as a PCP instead of AP. Relevant for DMG
 981  *      networks.
 982  * @beacon_rate: bitrate to be used for beacons
 983  * @ht_cap: HT capabilities (or %NULL if HT isn't enabled)
 984  * @vht_cap: VHT capabilities (or %NULL if VHT isn't enabled)
 985  * @he_cap: HE capabilities (or %NULL if HE isn't enabled)
 986  * @ht_required: stations must support HT
 987  * @vht_required: stations must support VHT
 988  * @twt_responder: Enable Target Wait Time
 989  * @flags: flags, as defined in enum cfg80211_ap_settings_flags
 990  * @he_obss_pd: OBSS Packet Detection settings
 991  */
 992 struct cfg80211_ap_settings {
 993         struct cfg80211_chan_def chandef;
 994 
 995         struct cfg80211_beacon_data beacon;
 996 
 997         int beacon_interval, dtim_period;
 998         const u8 *ssid;
 999         size_t ssid_len;
1000         enum nl80211_hidden_ssid hidden_ssid;
1001         struct cfg80211_crypto_settings crypto;
1002         bool privacy;
1003         enum nl80211_auth_type auth_type;
1004         enum nl80211_smps_mode smps_mode;
1005         int inactivity_timeout;
1006         u8 p2p_ctwindow;
1007         bool p2p_opp_ps;
1008         const struct cfg80211_acl_data *acl;
1009         bool pbss;
1010         struct cfg80211_bitrate_mask beacon_rate;
1011 
1012         const struct ieee80211_ht_cap *ht_cap;
1013         const struct ieee80211_vht_cap *vht_cap;
1014         const struct ieee80211_he_cap_elem *he_cap;
1015         bool ht_required, vht_required;
1016         bool twt_responder;
1017         u32 flags;
1018         struct ieee80211_he_obss_pd he_obss_pd;
1019 };
1020 
1021 /**
1022  * struct cfg80211_csa_settings - channel switch settings
1023  *
1024  * Used for channel switch
1025  *
1026  * @chandef: defines the channel to use after the switch
1027  * @beacon_csa: beacon data while performing the switch
1028  * @counter_offsets_beacon: offsets of the counters within the beacon (tail)
1029  * @counter_offsets_presp: offsets of the counters within the probe response
1030  * @n_counter_offsets_beacon: number of csa counters the beacon (tail)
1031  * @n_counter_offsets_presp: number of csa counters in the probe response
1032  * @beacon_after: beacon data to be used on the new channel
1033  * @radar_required: whether radar detection is required on the new channel
1034  * @block_tx: whether transmissions should be blocked while changing
1035  * @count: number of beacons until switch
1036  */
1037 struct cfg80211_csa_settings {
1038         struct cfg80211_chan_def chandef;
1039         struct cfg80211_beacon_data beacon_csa;
1040         const u16 *counter_offsets_beacon;
1041         const u16 *counter_offsets_presp;
1042         unsigned int n_counter_offsets_beacon;
1043         unsigned int n_counter_offsets_presp;
1044         struct cfg80211_beacon_data beacon_after;
1045         bool radar_required;
1046         bool block_tx;
1047         u8 count;
1048 };
1049 
1050 #define CFG80211_MAX_NUM_DIFFERENT_CHANNELS 10
1051 
1052 /**
1053  * struct iface_combination_params - input parameters for interface combinations
1054  *
1055  * Used to pass interface combination parameters
1056  *
1057  * @num_different_channels: the number of different channels we want
1058  *      to use for verification
1059  * @radar_detect: a bitmap where each bit corresponds to a channel
1060  *      width where radar detection is needed, as in the definition of
1061  *      &struct ieee80211_iface_combination.@radar_detect_widths
1062  * @iftype_num: array with the number of interfaces of each interface
1063  *      type.  The index is the interface type as specified in &enum
1064  *      nl80211_iftype.
1065  * @new_beacon_int: set this to the beacon interval of a new interface
1066  *      that's not operating yet, if such is to be checked as part of
1067  *      the verification
1068  */
1069 struct iface_combination_params {
1070         int num_different_channels;
1071         u8 radar_detect;
1072         int iftype_num[NUM_NL80211_IFTYPES];
1073         u32 new_beacon_int;
1074 };
1075 
1076 /**
1077  * enum station_parameters_apply_mask - station parameter values to apply
1078  * @STATION_PARAM_APPLY_UAPSD: apply new uAPSD parameters (uapsd_queues, max_sp)
1079  * @STATION_PARAM_APPLY_CAPABILITY: apply new capability
1080  * @STATION_PARAM_APPLY_PLINK_STATE: apply new plink state
1081  *
1082  * Not all station parameters have in-band "no change" signalling,
1083  * for those that don't these flags will are used.
1084  */
1085 enum station_parameters_apply_mask {
1086         STATION_PARAM_APPLY_UAPSD = BIT(0),
1087         STATION_PARAM_APPLY_CAPABILITY = BIT(1),
1088         STATION_PARAM_APPLY_PLINK_STATE = BIT(2),
1089         STATION_PARAM_APPLY_STA_TXPOWER = BIT(3),
1090 };
1091 
1092 /**
1093  * struct sta_txpwr - station txpower configuration
1094  *
1095  * Used to configure txpower for station.
1096  *
1097  * @power: tx power (in dBm) to be used for sending data traffic. If tx power
1098  *      is not provided, the default per-interface tx power setting will be
1099  *      overriding. Driver should be picking up the lowest tx power, either tx
1100  *      power per-interface or per-station.
1101  * @type: In particular if TPC %type is NL80211_TX_POWER_LIMITED then tx power
1102  *      will be less than or equal to specified from userspace, whereas if TPC
1103  *      %type is NL80211_TX_POWER_AUTOMATIC then it indicates default tx power.
1104  *      NL80211_TX_POWER_FIXED is not a valid configuration option for
1105  *      per peer TPC.
1106  */
1107 struct sta_txpwr {
1108         s16 power;
1109         enum nl80211_tx_power_setting type;
1110 };
1111 
1112 /**
1113  * struct station_parameters - station parameters
1114  *
1115  * Used to change and create a new station.
1116  *
1117  * @vlan: vlan interface station should belong to
1118  * @supported_rates: supported rates in IEEE 802.11 format
1119  *      (or NULL for no change)
1120  * @supported_rates_len: number of supported rates
1121  * @sta_flags_mask: station flags that changed
1122  *      (bitmask of BIT(%NL80211_STA_FLAG_...))
1123  * @sta_flags_set: station flags values
1124  *      (bitmask of BIT(%NL80211_STA_FLAG_...))
1125  * @listen_interval: listen interval or -1 for no change
1126  * @aid: AID or zero for no change
1127  * @peer_aid: mesh peer AID or zero for no change
1128  * @plink_action: plink action to take
1129  * @plink_state: set the peer link state for a station
1130  * @ht_capa: HT capabilities of station
1131  * @vht_capa: VHT capabilities of station
1132  * @uapsd_queues: bitmap of queues configured for uapsd. same format
1133  *      as the AC bitmap in the QoS info field
1134  * @max_sp: max Service Period. same format as the MAX_SP in the
1135  *      QoS info field (but already shifted down)
1136  * @sta_modify_mask: bitmap indicating which parameters changed
1137  *      (for those that don't have a natural "no change" value),
1138  *      see &enum station_parameters_apply_mask
1139  * @local_pm: local link-specific mesh power save mode (no change when set
1140  *      to unknown)
1141  * @capability: station capability
1142  * @ext_capab: extended capabilities of the station
1143  * @ext_capab_len: number of extended capabilities
1144  * @supported_channels: supported channels in IEEE 802.11 format
1145  * @supported_channels_len: number of supported channels
1146  * @supported_oper_classes: supported oper classes in IEEE 802.11 format
1147  * @supported_oper_classes_len: number of supported operating classes
1148  * @opmode_notif: operating mode field from Operating Mode Notification
1149  * @opmode_notif_used: information if operating mode field is used
1150  * @support_p2p_ps: information if station supports P2P PS mechanism
1151  * @he_capa: HE capabilities of station
1152  * @he_capa_len: the length of the HE capabilities
1153  * @airtime_weight: airtime scheduler weight for this station
1154  */
1155 struct station_parameters {
1156         const u8 *supported_rates;
1157         struct net_device *vlan;
1158         u32 sta_flags_mask, sta_flags_set;
1159         u32 sta_modify_mask;
1160         int listen_interval;
1161         u16 aid;
1162         u16 peer_aid;
1163         u8 supported_rates_len;
1164         u8 plink_action;
1165         u8 plink_state;
1166         const struct ieee80211_ht_cap *ht_capa;
1167         const struct ieee80211_vht_cap *vht_capa;
1168         u8 uapsd_queues;
1169         u8 max_sp;
1170         enum nl80211_mesh_power_mode local_pm;
1171         u16 capability;
1172         const u8 *ext_capab;
1173         u8 ext_capab_len;
1174         const u8 *supported_channels;
1175         u8 supported_channels_len;
1176         const u8 *supported_oper_classes;
1177         u8 supported_oper_classes_len;
1178         u8 opmode_notif;
1179         bool opmode_notif_used;
1180         int support_p2p_ps;
1181         const struct ieee80211_he_cap_elem *he_capa;
1182         u8 he_capa_len;
1183         u16 airtime_weight;
1184         struct sta_txpwr txpwr;
1185 };
1186 
1187 /**
1188  * struct station_del_parameters - station deletion parameters
1189  *
1190  * Used to delete a station entry (or all stations).
1191  *
1192  * @mac: MAC address of the station to remove or NULL to remove all stations
1193  * @subtype: Management frame subtype to use for indicating removal
1194  *      (10 = Disassociation, 12 = Deauthentication)
1195  * @reason_code: Reason code for the Disassociation/Deauthentication frame
1196  */
1197 struct station_del_parameters {
1198         const u8 *mac;
1199         u8 subtype;
1200         u16 reason_code;
1201 };
1202 
1203 /**
1204  * enum cfg80211_station_type - the type of station being modified
1205  * @CFG80211_STA_AP_CLIENT: client of an AP interface
1206  * @CFG80211_STA_AP_CLIENT_UNASSOC: client of an AP interface that is still
1207  *      unassociated (update properties for this type of client is permitted)
1208  * @CFG80211_STA_AP_MLME_CLIENT: client of an AP interface that has
1209  *      the AP MLME in the device
1210  * @CFG80211_STA_AP_STA: AP station on managed interface
1211  * @CFG80211_STA_IBSS: IBSS station
1212  * @CFG80211_STA_TDLS_PEER_SETUP: TDLS peer on managed interface (dummy entry
1213  *      while TDLS setup is in progress, it moves out of this state when
1214  *      being marked authorized; use this only if TDLS with external setup is
1215  *      supported/used)
1216  * @CFG80211_STA_TDLS_PEER_ACTIVE: TDLS peer on managed interface (active
1217  *      entry that is operating, has been marked authorized by userspace)
1218  * @CFG80211_STA_MESH_PEER_KERNEL: peer on mesh interface (kernel managed)
1219  * @CFG80211_STA_MESH_PEER_USER: peer on mesh interface (user managed)
1220  */
1221 enum cfg80211_station_type {
1222         CFG80211_STA_AP_CLIENT,
1223         CFG80211_STA_AP_CLIENT_UNASSOC,
1224         CFG80211_STA_AP_MLME_CLIENT,
1225         CFG80211_STA_AP_STA,
1226         CFG80211_STA_IBSS,
1227         CFG80211_STA_TDLS_PEER_SETUP,
1228         CFG80211_STA_TDLS_PEER_ACTIVE,
1229         CFG80211_STA_MESH_PEER_KERNEL,
1230         CFG80211_STA_MESH_PEER_USER,
1231 };
1232 
1233 /**
1234  * cfg80211_check_station_change - validate parameter changes
1235  * @wiphy: the wiphy this operates on
1236  * @params: the new parameters for a station
1237  * @statype: the type of station being modified
1238  *
1239  * Utility function for the @change_station driver method. Call this function
1240  * with the appropriate station type looking up the station (and checking that
1241  * it exists). It will verify whether the station change is acceptable, and if
1242  * not will return an error code. Note that it may modify the parameters for
1243  * backward compatibility reasons, so don't use them before calling this.
1244  */
1245 int cfg80211_check_station_change(struct wiphy *wiphy,
1246                                   struct station_parameters *params,
1247                                   enum cfg80211_station_type statype);
1248 
1249 /**
1250  * enum station_info_rate_flags - bitrate info flags
1251  *
1252  * Used by the driver to indicate the specific rate transmission
1253  * type for 802.11n transmissions.
1254  *
1255  * @RATE_INFO_FLAGS_MCS: mcs field filled with HT MCS
1256  * @RATE_INFO_FLAGS_VHT_MCS: mcs field filled with VHT MCS
1257  * @RATE_INFO_FLAGS_SHORT_GI: 400ns guard interval
1258  * @RATE_INFO_FLAGS_DMG: 60GHz MCS
1259  * @RATE_INFO_FLAGS_HE_MCS: HE MCS information
1260  * @RATE_INFO_FLAGS_EDMG: 60GHz MCS in EDMG mode
1261  */
1262 enum rate_info_flags {
1263         RATE_INFO_FLAGS_MCS                     = BIT(0),
1264         RATE_INFO_FLAGS_VHT_MCS                 = BIT(1),
1265         RATE_INFO_FLAGS_SHORT_GI                = BIT(2),
1266         RATE_INFO_FLAGS_DMG                     = BIT(3),
1267         RATE_INFO_FLAGS_HE_MCS                  = BIT(4),
1268         RATE_INFO_FLAGS_EDMG                    = BIT(5),
1269 };
1270 
1271 /**
1272  * enum rate_info_bw - rate bandwidth information
1273  *
1274  * Used by the driver to indicate the rate bandwidth.
1275  *
1276  * @RATE_INFO_BW_5: 5 MHz bandwidth
1277  * @RATE_INFO_BW_10: 10 MHz bandwidth
1278  * @RATE_INFO_BW_20: 20 MHz bandwidth
1279  * @RATE_INFO_BW_40: 40 MHz bandwidth
1280  * @RATE_INFO_BW_80: 80 MHz bandwidth
1281  * @RATE_INFO_BW_160: 160 MHz bandwidth
1282  * @RATE_INFO_BW_HE_RU: bandwidth determined by HE RU allocation
1283  */
1284 enum rate_info_bw {
1285         RATE_INFO_BW_20 = 0,
1286         RATE_INFO_BW_5,
1287         RATE_INFO_BW_10,
1288         RATE_INFO_BW_40,
1289         RATE_INFO_BW_80,
1290         RATE_INFO_BW_160,
1291         RATE_INFO_BW_HE_RU,
1292 };
1293 
1294 /**
1295  * struct rate_info - bitrate information
1296  *
1297  * Information about a receiving or transmitting bitrate
1298  *
1299  * @flags: bitflag of flags from &enum rate_info_flags
1300  * @mcs: mcs index if struct describes an HT/VHT/HE rate
1301  * @legacy: bitrate in 100kbit/s for 802.11abg
1302  * @nss: number of streams (VHT & HE only)
1303  * @bw: bandwidth (from &enum rate_info_bw)
1304  * @he_gi: HE guard interval (from &enum nl80211_he_gi)
1305  * @he_dcm: HE DCM value
1306  * @he_ru_alloc: HE RU allocation (from &enum nl80211_he_ru_alloc,
1307  *      only valid if bw is %RATE_INFO_BW_HE_RU)
1308  * @n_bonded_ch: In case of EDMG the number of bonded channels (1-4)
1309  */
1310 struct rate_info {
1311         u8 flags;
1312         u8 mcs;
1313         u16 legacy;
1314         u8 nss;
1315         u8 bw;
1316         u8 he_gi;
1317         u8 he_dcm;
1318         u8 he_ru_alloc;
1319         u8 n_bonded_ch;
1320 };
1321 
1322 /**
1323  * enum station_info_rate_flags - bitrate info flags
1324  *
1325  * Used by the driver to indicate the specific rate transmission
1326  * type for 802.11n transmissions.
1327  *
1328  * @BSS_PARAM_FLAGS_CTS_PROT: whether CTS protection is enabled
1329  * @BSS_PARAM_FLAGS_SHORT_PREAMBLE: whether short preamble is enabled
1330  * @BSS_PARAM_FLAGS_SHORT_SLOT_TIME: whether short slot time is enabled
1331  */
1332 enum bss_param_flags {
1333         BSS_PARAM_FLAGS_CTS_PROT        = 1<<0,
1334         BSS_PARAM_FLAGS_SHORT_PREAMBLE  = 1<<1,
1335         BSS_PARAM_FLAGS_SHORT_SLOT_TIME = 1<<2,
1336 };
1337 
1338 /**
1339  * struct sta_bss_parameters - BSS parameters for the attached station
1340  *
1341  * Information about the currently associated BSS
1342  *
1343  * @flags: bitflag of flags from &enum bss_param_flags
1344  * @dtim_period: DTIM period for the BSS
1345  * @beacon_interval: beacon interval
1346  */
1347 struct sta_bss_parameters {
1348         u8 flags;
1349         u8 dtim_period;
1350         u16 beacon_interval;
1351 };
1352 
1353 /**
1354  * struct cfg80211_txq_stats - TXQ statistics for this TID
1355  * @filled: bitmap of flags using the bits of &enum nl80211_txq_stats to
1356  *      indicate the relevant values in this struct are filled
1357  * @backlog_bytes: total number of bytes currently backlogged
1358  * @backlog_packets: total number of packets currently backlogged
1359  * @flows: number of new flows seen
1360  * @drops: total number of packets dropped
1361  * @ecn_marks: total number of packets marked with ECN CE
1362  * @overlimit: number of drops due to queue space overflow
1363  * @overmemory: number of drops due to memory limit overflow
1364  * @collisions: number of hash collisions
1365  * @tx_bytes: total number of bytes dequeued
1366  * @tx_packets: total number of packets dequeued
1367  * @max_flows: maximum number of flows supported
1368  */
1369 struct cfg80211_txq_stats {
1370         u32 filled;
1371         u32 backlog_bytes;
1372         u32 backlog_packets;
1373         u32 flows;
1374         u32 drops;
1375         u32 ecn_marks;
1376         u32 overlimit;
1377         u32 overmemory;
1378         u32 collisions;
1379         u32 tx_bytes;
1380         u32 tx_packets;
1381         u32 max_flows;
1382 };
1383 
1384 /**
1385  * struct cfg80211_tid_stats - per-TID statistics
1386  * @filled: bitmap of flags using the bits of &enum nl80211_tid_stats to
1387  *      indicate the relevant values in this struct are filled
1388  * @rx_msdu: number of received MSDUs
1389  * @tx_msdu: number of (attempted) transmitted MSDUs
1390  * @tx_msdu_retries: number of retries (not counting the first) for
1391  *      transmitted MSDUs
1392  * @tx_msdu_failed: number of failed transmitted MSDUs
1393  * @txq_stats: TXQ statistics
1394  */
1395 struct cfg80211_tid_stats {
1396         u32 filled;
1397         u64 rx_msdu;
1398         u64 tx_msdu;
1399         u64 tx_msdu_retries;
1400         u64 tx_msdu_failed;
1401         struct cfg80211_txq_stats txq_stats;
1402 };
1403 
1404 #define IEEE80211_MAX_CHAINS    4
1405 
1406 /**
1407  * struct station_info - station information
1408  *
1409  * Station information filled by driver for get_station() and dump_station.
1410  *
1411  * @filled: bitflag of flags using the bits of &enum nl80211_sta_info to
1412  *      indicate the relevant values in this struct for them
1413  * @connected_time: time(in secs) since a station is last connected
1414  * @inactive_time: time since last station activity (tx/rx) in milliseconds
1415  * @assoc_at: bootime (ns) of the last association
1416  * @rx_bytes: bytes (size of MPDUs) received from this station
1417  * @tx_bytes: bytes (size of MPDUs) transmitted to this station
1418  * @llid: mesh local link id
1419  * @plid: mesh peer link id
1420  * @plink_state: mesh peer link state
1421  * @signal: The signal strength, type depends on the wiphy's signal_type.
1422  *      For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1423  * @signal_avg: Average signal strength, type depends on the wiphy's signal_type.
1424  *      For CFG80211_SIGNAL_TYPE_MBM, value is expressed in _dBm_.
1425  * @chains: bitmask for filled values in @chain_signal, @chain_signal_avg
1426  * @chain_signal: per-chain signal strength of last received packet in dBm
1427  * @chain_signal_avg: per-chain signal strength average in dBm
1428  * @txrate: current unicast bitrate from this station
1429  * @rxrate: current unicast bitrate to this station
1430  * @rx_packets: packets (MSDUs & MMPDUs) received from this station
1431  * @tx_packets: packets (MSDUs & MMPDUs) transmitted to this station
1432  * @tx_retries: cumulative retry counts (MPDUs)
1433  * @tx_failed: number of failed transmissions (MPDUs) (retries exceeded, no ACK)
1434  * @rx_dropped_misc:  Dropped for un-specified reason.
1435  * @bss_param: current BSS parameters
1436  * @generation: generation number for nl80211 dumps.
1437  *      This number should increase every time the list of stations
1438  *      changes, i.e. when a station is added or removed, so that
1439  *      userspace can tell whether it got a consistent snapshot.
1440  * @assoc_req_ies: IEs from (Re)Association Request.
1441  *      This is used only when in AP mode with drivers that do not use
1442  *      user space MLME/SME implementation. The information is provided for
1443  *      the cfg80211_new_sta() calls to notify user space of the IEs.
1444  * @assoc_req_ies_len: Length of assoc_req_ies buffer in octets.
1445  * @sta_flags: station flags mask & values
1446  * @beacon_loss_count: Number of times beacon loss event has triggered.
1447  * @t_offset: Time offset of the station relative to this host.
1448  * @local_pm: local mesh STA power save mode
1449  * @peer_pm: peer mesh STA power save mode
1450  * @nonpeer_pm: non-peer mesh STA power save mode
1451  * @expected_throughput: expected throughput in kbps (including 802.11 headers)
1452  *      towards this station.
1453  * @rx_beacon: number of beacons received from this peer
1454  * @rx_beacon_signal_avg: signal strength average (in dBm) for beacons received
1455  *      from this peer
1456  * @connected_to_gate: true if mesh STA has a path to mesh gate
1457  * @rx_duration: aggregate PPDU duration(usecs) for all the frames from a peer
1458  * @tx_duration: aggregate PPDU duration(usecs) for all the frames to a peer
1459  * @airtime_weight: current airtime scheduling weight
1460  * @pertid: per-TID statistics, see &struct cfg80211_tid_stats, using the last
1461  *      (IEEE80211_NUM_TIDS) index for MSDUs not encapsulated in QoS-MPDUs.
1462  *      Note that this doesn't use the @filled bit, but is used if non-NULL.
1463  * @ack_signal: signal strength (in dBm) of the last ACK frame.
1464  * @avg_ack_signal: average rssi value of ack packet for the no of msdu's has
1465  *      been sent.
1466  * @rx_mpdu_count: number of MPDUs received from this station
1467  * @fcs_err_count: number of packets (MPDUs) received from this station with
1468  *      an FCS error. This counter should be incremented only when TA of the
1469  *      received packet with an FCS error matches the peer MAC address.
1470  * @airtime_link_metric: mesh airtime link metric.
1471  */
1472 struct station_info {
1473         u64 filled;
1474         u32 connected_time;
1475         u32 inactive_time;
1476         u64 assoc_at;
1477         u64 rx_bytes;
1478         u64 tx_bytes;
1479         u16 llid;
1480         u16 plid;
1481         u8 plink_state;
1482         s8 signal;
1483         s8 signal_avg;
1484 
1485         u8 chains;
1486         s8 chain_signal[IEEE80211_MAX_CHAINS];
1487         s8 chain_signal_avg[IEEE80211_MAX_CHAINS];
1488 
1489         struct rate_info txrate;
1490         struct rate_info rxrate;
1491         u32 rx_packets;
1492         u32 tx_packets;
1493         u32 tx_retries;
1494         u32 tx_failed;
1495         u32 rx_dropped_misc;
1496         struct sta_bss_parameters bss_param;
1497         struct nl80211_sta_flag_update sta_flags;
1498 
1499         int generation;
1500 
1501         const u8 *assoc_req_ies;
1502         size_t assoc_req_ies_len;
1503 
1504         u32 beacon_loss_count;
1505         s64 t_offset;
1506         enum nl80211_mesh_power_mode local_pm;
1507         enum nl80211_mesh_power_mode peer_pm;
1508         enum nl80211_mesh_power_mode nonpeer_pm;
1509 
1510         u32 expected_throughput;
1511 
1512         u64 tx_duration;
1513         u64 rx_duration;
1514         u64 rx_beacon;
1515         u8 rx_beacon_signal_avg;
1516         u8 connected_to_gate;
1517 
1518         struct cfg80211_tid_stats *pertid;
1519         s8 ack_signal;
1520         s8 avg_ack_signal;
1521 
1522         u16 airtime_weight;
1523 
1524         u32 rx_mpdu_count;
1525         u32 fcs_err_count;
1526 
1527         u32 airtime_link_metric;
1528 };
1529 
1530 #if IS_ENABLED(CONFIG_CFG80211)
1531 /**
1532  * cfg80211_get_station - retrieve information about a given station
1533  * @dev: the device where the station is supposed to be connected to
1534  * @mac_addr: the mac address of the station of interest
1535  * @sinfo: pointer to the structure to fill with the information
1536  *
1537  * Returns 0 on success and sinfo is filled with the available information
1538  * otherwise returns a negative error code and the content of sinfo has to be
1539  * considered undefined.
1540  */
1541 int cfg80211_get_station(struct net_device *dev, const u8 *mac_addr,
1542                          struct station_info *sinfo);
1543 #else
1544 static inline int cfg80211_get_station(struct net_device *dev,
1545                                        const u8 *mac_addr,
1546                                        struct station_info *sinfo)
1547 {
1548         return -ENOENT;
1549 }
1550 #endif
1551 
1552 /**
1553  * enum monitor_flags - monitor flags
1554  *
1555  * Monitor interface configuration flags. Note that these must be the bits
1556  * according to the nl80211 flags.
1557  *
1558  * @MONITOR_FLAG_CHANGED: set if the flags were changed
1559  * @MONITOR_FLAG_FCSFAIL: pass frames with bad FCS
1560  * @MONITOR_FLAG_PLCPFAIL: pass frames with bad PLCP
1561  * @MONITOR_FLAG_CONTROL: pass control frames
1562  * @MONITOR_FLAG_OTHER_BSS: disable BSSID filtering
1563  * @MONITOR_FLAG_COOK_FRAMES: report frames after processing
1564  * @MONITOR_FLAG_ACTIVE: active monitor, ACKs frames on its MAC address
1565  */
1566 enum monitor_flags {
1567         MONITOR_FLAG_CHANGED            = 1<<__NL80211_MNTR_FLAG_INVALID,
1568         MONITOR_FLAG_FCSFAIL            = 1<<NL80211_MNTR_FLAG_FCSFAIL,
1569         MONITOR_FLAG_PLCPFAIL           = 1<<NL80211_MNTR_FLAG_PLCPFAIL,
1570         MONITOR_FLAG_CONTROL            = 1<<NL80211_MNTR_FLAG_CONTROL,
1571         MONITOR_FLAG_OTHER_BSS          = 1<<NL80211_MNTR_FLAG_OTHER_BSS,
1572         MONITOR_FLAG_COOK_FRAMES        = 1<<NL80211_MNTR_FLAG_COOK_FRAMES,
1573         MONITOR_FLAG_ACTIVE             = 1<<NL80211_MNTR_FLAG_ACTIVE,
1574 };
1575 
1576 /**
1577  * enum mpath_info_flags -  mesh path information flags
1578  *
1579  * Used by the driver to indicate which info in &struct mpath_info it has filled
1580  * in during get_station() or dump_station().
1581  *
1582  * @MPATH_INFO_FRAME_QLEN: @frame_qlen filled
1583  * @MPATH_INFO_SN: @sn filled
1584  * @MPATH_INFO_METRIC: @metric filled
1585  * @MPATH_INFO_EXPTIME: @exptime filled
1586  * @MPATH_INFO_DISCOVERY_TIMEOUT: @discovery_timeout filled
1587  * @MPATH_INFO_DISCOVERY_RETRIES: @discovery_retries filled
1588  * @MPATH_INFO_FLAGS: @flags filled
1589  * @MPATH_INFO_HOP_COUNT: @hop_count filled
1590  * @MPATH_INFO_PATH_CHANGE: @path_change_count filled
1591  */
1592 enum mpath_info_flags {
1593         MPATH_INFO_FRAME_QLEN           = BIT(0),
1594         MPATH_INFO_SN                   = BIT(1),
1595         MPATH_INFO_METRIC               = BIT(2),
1596         MPATH_INFO_EXPTIME              = BIT(3),
1597         MPATH_INFO_DISCOVERY_TIMEOUT    = BIT(4),
1598         MPATH_INFO_DISCOVERY_RETRIES    = BIT(5),
1599         MPATH_INFO_FLAGS                = BIT(6),
1600         MPATH_INFO_HOP_COUNT            = BIT(7),
1601         MPATH_INFO_PATH_CHANGE          = BIT(8),
1602 };
1603 
1604 /**
1605  * struct mpath_info - mesh path information
1606  *
1607  * Mesh path information filled by driver for get_mpath() and dump_mpath().
1608  *
1609  * @filled: bitfield of flags from &enum mpath_info_flags
1610  * @frame_qlen: number of queued frames for this destination
1611  * @sn: target sequence number
1612  * @metric: metric (cost) of this mesh path
1613  * @exptime: expiration time for the mesh path from now, in msecs
1614  * @flags: mesh path flags
1615  * @discovery_timeout: total mesh path discovery timeout, in msecs
1616  * @discovery_retries: mesh path discovery retries
1617  * @generation: generation number for nl80211 dumps.
1618  *      This number should increase every time the list of mesh paths
1619  *      changes, i.e. when a station is added or removed, so that
1620  *      userspace can tell whether it got a consistent snapshot.
1621  * @hop_count: hops to destination
1622  * @path_change_count: total number of path changes to destination
1623  */
1624 struct mpath_info {
1625         u32 filled;
1626         u32 frame_qlen;
1627         u32 sn;
1628         u32 metric;
1629         u32 exptime;
1630         u32 discovery_timeout;
1631         u8 discovery_retries;
1632         u8 flags;
1633         u8 hop_count;
1634         u32 path_change_count;
1635 
1636         int generation;
1637 };
1638 
1639 /**
1640  * struct bss_parameters - BSS parameters
1641  *
1642  * Used to change BSS parameters (mainly for AP mode).
1643  *
1644  * @use_cts_prot: Whether to use CTS protection
1645  *      (0 = no, 1 = yes, -1 = do not change)
1646  * @use_short_preamble: Whether the use of short preambles is allowed
1647  *      (0 = no, 1 = yes, -1 = do not change)
1648  * @use_short_slot_time: Whether the use of short slot time is allowed
1649  *      (0 = no, 1 = yes, -1 = do not change)
1650  * @basic_rates: basic rates in IEEE 802.11 format
1651  *      (or NULL for no change)
1652  * @basic_rates_len: number of basic rates
1653  * @ap_isolate: do not forward packets between connected stations
1654  * @ht_opmode: HT Operation mode
1655  *      (u16 = opmode, -1 = do not change)
1656  * @p2p_ctwindow: P2P CT Window (-1 = no change)
1657  * @p2p_opp_ps: P2P opportunistic PS (-1 = no change)
1658  */
1659 struct bss_parameters {
1660         int use_cts_prot;
1661         int use_short_preamble;
1662         int use_short_slot_time;
1663         const u8 *basic_rates;
1664         u8 basic_rates_len;
1665         int ap_isolate;
1666         int ht_opmode;
1667         s8 p2p_ctwindow, p2p_opp_ps;
1668 };
1669 
1670 /**
1671  * struct mesh_config - 802.11s mesh configuration
1672  *
1673  * These parameters can be changed while the mesh is active.
1674  *
1675  * @dot11MeshRetryTimeout: the initial retry timeout in millisecond units used
1676  *      by the Mesh Peering Open message
1677  * @dot11MeshConfirmTimeout: the initial retry timeout in millisecond units
1678  *      used by the Mesh Peering Open message
1679  * @dot11MeshHoldingTimeout: the confirm timeout in millisecond units used by
1680  *      the mesh peering management to close a mesh peering
1681  * @dot11MeshMaxPeerLinks: the maximum number of peer links allowed on this
1682  *      mesh interface
1683  * @dot11MeshMaxRetries: the maximum number of peer link open retries that can
1684  *      be sent to establish a new peer link instance in a mesh
1685  * @dot11MeshTTL: the value of TTL field set at a source mesh STA
1686  * @element_ttl: the value of TTL field set at a mesh STA for path selection
1687  *      elements
1688  * @auto_open_plinks: whether we should automatically open peer links when we
1689  *      detect compatible mesh peers
1690  * @dot11MeshNbrOffsetMaxNeighbor: the maximum number of neighbors to
1691  *      synchronize to for 11s default synchronization method
1692  * @dot11MeshHWMPmaxPREQretries: the number of action frames containing a PREQ
1693  *      that an originator mesh STA can send to a particular path target
1694  * @path_refresh_time: how frequently to refresh mesh paths in milliseconds
1695  * @min_discovery_timeout: the minimum length of time to wait until giving up on
1696  *      a path discovery in milliseconds
1697  * @dot11MeshHWMPactivePathTimeout: the time (in TUs) for which mesh STAs
1698  *      receiving a PREQ shall consider the forwarding information from the
1699  *      root to be valid. (TU = time unit)
1700  * @dot11MeshHWMPpreqMinInterval: the minimum interval of time (in TUs) during
1701  *      which a mesh STA can send only one action frame containing a PREQ
1702  *      element
1703  * @dot11MeshHWMPperrMinInterval: the minimum interval of time (in TUs) during
1704  *      which a mesh STA can send only one Action frame containing a PERR
1705  *      element
1706  * @dot11MeshHWMPnetDiameterTraversalTime: the interval of time (in TUs) that
1707  *      it takes for an HWMP information element to propagate across the mesh
1708  * @dot11MeshHWMPRootMode: the configuration of a mesh STA as root mesh STA
1709  * @dot11MeshHWMPRannInterval: the interval of time (in TUs) between root
1710  *      announcements are transmitted
1711  * @dot11MeshGateAnnouncementProtocol: whether to advertise that this mesh
1712  *      station has access to a broader network beyond the MBSS. (This is
1713  *      missnamed in draft 12.0: dot11MeshGateAnnouncementProtocol set to true
1714  *      only means that the station will announce others it's a mesh gate, but
1715  *      not necessarily using the gate announcement protocol. Still keeping the
1716  *      same nomenclature to be in sync with the spec)
1717  * @dot11MeshForwarding: whether the Mesh STA is forwarding or non-forwarding
1718  *      entity (default is TRUE - forwarding entity)
1719  * @rssi_threshold: the threshold for average signal strength of candidate
1720  *      station to establish a peer link
1721  * @ht_opmode: mesh HT protection mode
1722  *
1723  * @dot11MeshHWMPactivePathToRootTimeout: The time (in TUs) for which mesh STAs
1724  *      receiving a proactive PREQ shall consider the forwarding information to
1725  *      the root mesh STA to be valid.
1726  *
1727  * @dot11MeshHWMProotInterval: The interval of time (in TUs) between proactive
1728  *      PREQs are transmitted.
1729  * @dot11MeshHWMPconfirmationInterval: The minimum interval of time (in TUs)
1730  *      during which a mesh STA can send only one Action frame containing
1731  *      a PREQ element for root path confirmation.
1732  * @power_mode: The default mesh power save mode which will be the initial
1733  *      setting for new peer links.
1734  * @dot11MeshAwakeWindowDuration: The duration in TUs the STA will remain awake
1735  *      after transmitting its beacon.
1736  * @plink_timeout: If no tx activity is seen from a STA we've established
1737  *      peering with for longer than this time (in seconds), then remove it
1738  *      from the STA's list of peers.  Default is 30 minutes.
1739  * @dot11MeshConnectedToMeshGate: if set to true, advertise that this STA is
1740  *      connected to a mesh gate in mesh formation info.  If false, the
1741  *      value in mesh formation is determined by the presence of root paths
1742  *      in the mesh path table
1743  */
1744 struct mesh_config {
1745         u16 dot11MeshRetryTimeout;
1746         u16 dot11MeshConfirmTimeout;
1747         u16 dot11MeshHoldingTimeout;
1748         u16 dot11MeshMaxPeerLinks;
1749         u8 dot11MeshMaxRetries;
1750         u8 dot11MeshTTL;
1751         u8 element_ttl;
1752         bool auto_open_plinks;
1753         u32 dot11MeshNbrOffsetMaxNeighbor;
1754         u8 dot11MeshHWMPmaxPREQretries;
1755         u32 path_refresh_time;
1756         u16 min_discovery_timeout;
1757         u32 dot11MeshHWMPactivePathTimeout;
1758         u16 dot11MeshHWMPpreqMinInterval;
1759         u16 dot11MeshHWMPperrMinInterval;
1760         u16 dot11MeshHWMPnetDiameterTraversalTime;
1761         u8 dot11MeshHWMPRootMode;
1762         bool dot11MeshConnectedToMeshGate;
1763         u16 dot11MeshHWMPRannInterval;
1764         bool dot11MeshGateAnnouncementProtocol;
1765         bool dot11MeshForwarding;
1766         s32 rssi_threshold;
1767         u16 ht_opmode;
1768         u32 dot11MeshHWMPactivePathToRootTimeout;
1769         u16 dot11MeshHWMProotInterval;
1770         u16 dot11MeshHWMPconfirmationInterval;
1771         enum nl80211_mesh_power_mode power_mode;
1772         u16 dot11MeshAwakeWindowDuration;
1773         u32 plink_timeout;
1774 };
1775 
1776 /**
1777  * struct mesh_setup - 802.11s mesh setup configuration
1778  * @chandef: defines the channel to use
1779  * @mesh_id: the mesh ID
1780  * @mesh_id_len: length of the mesh ID, at least 1 and at most 32 bytes
1781  * @sync_method: which synchronization method to use
1782  * @path_sel_proto: which path selection protocol to use
1783  * @path_metric: which metric to use
1784  * @auth_id: which authentication method this mesh is using
1785  * @ie: vendor information elements (optional)
1786  * @ie_len: length of vendor information elements
1787  * @is_authenticated: this mesh requires authentication
1788  * @is_secure: this mesh uses security
1789  * @user_mpm: userspace handles all MPM functions
1790  * @dtim_period: DTIM period to use
1791  * @beacon_interval: beacon interval to use
1792  * @mcast_rate: multicat rate for Mesh Node [6Mbps is the default for 802.11a]
1793  * @basic_rates: basic rates to use when creating the mesh
1794  * @beacon_rate: bitrate to be used for beacons
1795  * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
1796  *      changes the channel when a radar is detected. This is required
1797  *      to operate on DFS channels.
1798  * @control_port_over_nl80211: TRUE if userspace expects to exchange control
1799  *      port frames over NL80211 instead of the network interface.
1800  *
1801  * These parameters are fixed when the mesh is created.
1802  */
1803 struct mesh_setup {
1804         struct cfg80211_chan_def chandef;
1805         const u8 *mesh_id;
1806         u8 mesh_id_len;
1807         u8 sync_method;
1808         u8 path_sel_proto;
1809         u8 path_metric;
1810         u8 auth_id;
1811         const u8 *ie;
1812         u8 ie_len;
1813         bool is_authenticated;
1814         bool is_secure;
1815         bool user_mpm;
1816         u8 dtim_period;
1817         u16 beacon_interval;
1818         int mcast_rate[NUM_NL80211_BANDS];
1819         u32 basic_rates;
1820         struct cfg80211_bitrate_mask beacon_rate;
1821         bool userspace_handles_dfs;
1822         bool control_port_over_nl80211;
1823 };
1824 
1825 /**
1826  * struct ocb_setup - 802.11p OCB mode setup configuration
1827  * @chandef: defines the channel to use
1828  *
1829  * These parameters are fixed when connecting to the network
1830  */
1831 struct ocb_setup {
1832         struct cfg80211_chan_def chandef;
1833 };
1834 
1835 /**
1836  * struct ieee80211_txq_params - TX queue parameters
1837  * @ac: AC identifier
1838  * @txop: Maximum burst time in units of 32 usecs, 0 meaning disabled
1839  * @cwmin: Minimum contention window [a value of the form 2^n-1 in the range
1840  *      1..32767]
1841  * @cwmax: Maximum contention window [a value of the form 2^n-1 in the range
1842  *      1..32767]
1843  * @aifs: Arbitration interframe space [0..255]
1844  */
1845 struct ieee80211_txq_params {
1846         enum nl80211_ac ac;
1847         u16 txop;
1848         u16 cwmin;
1849         u16 cwmax;
1850         u8 aifs;
1851 };
1852 
1853 /**
1854  * DOC: Scanning and BSS list handling
1855  *
1856  * The scanning process itself is fairly simple, but cfg80211 offers quite
1857  * a bit of helper functionality. To start a scan, the scan operation will
1858  * be invoked with a scan definition. This scan definition contains the
1859  * channels to scan, and the SSIDs to send probe requests for (including the
1860  * wildcard, if desired). A passive scan is indicated by having no SSIDs to
1861  * probe. Additionally, a scan request may contain extra information elements
1862  * that should be added to the probe request. The IEs are guaranteed to be
1863  * well-formed, and will not exceed the maximum length the driver advertised
1864  * in the wiphy structure.
1865  *
1866  * When scanning finds a BSS, cfg80211 needs to be notified of that, because
1867  * it is responsible for maintaining the BSS list; the driver should not
1868  * maintain a list itself. For this notification, various functions exist.
1869  *
1870  * Since drivers do not maintain a BSS list, there are also a number of
1871  * functions to search for a BSS and obtain information about it from the
1872  * BSS structure cfg80211 maintains. The BSS list is also made available
1873  * to userspace.
1874  */
1875 
1876 /**
1877  * struct cfg80211_ssid - SSID description
1878  * @ssid: the SSID
1879  * @ssid_len: length of the ssid
1880  */
1881 struct cfg80211_ssid {
1882         u8 ssid[IEEE80211_MAX_SSID_LEN];
1883         u8 ssid_len;
1884 };
1885 
1886 /**
1887  * struct cfg80211_scan_info - information about completed scan
1888  * @scan_start_tsf: scan start time in terms of the TSF of the BSS that the
1889  *      wireless device that requested the scan is connected to. If this
1890  *      information is not available, this field is left zero.
1891  * @tsf_bssid: the BSSID according to which %scan_start_tsf is set.
1892  * @aborted: set to true if the scan was aborted for any reason,
1893  *      userspace will be notified of that
1894  */
1895 struct cfg80211_scan_info {
1896         u64 scan_start_tsf;
1897         u8 tsf_bssid[ETH_ALEN] __aligned(2);
1898         bool aborted;
1899 };
1900 
1901 /**
1902  * struct cfg80211_scan_request - scan request description
1903  *
1904  * @ssids: SSIDs to scan for (active scan only)
1905  * @n_ssids: number of SSIDs
1906  * @channels: channels to scan on.
1907  * @n_channels: total number of channels to scan
1908  * @scan_width: channel width for scanning
1909  * @ie: optional information element(s) to add into Probe Request or %NULL
1910  * @ie_len: length of ie in octets
1911  * @duration: how long to listen on each channel, in TUs. If
1912  *      %duration_mandatory is not set, this is the maximum dwell time and
1913  *      the actual dwell time may be shorter.
1914  * @duration_mandatory: if set, the scan duration must be as specified by the
1915  *      %duration field.
1916  * @flags: bit field of flags controlling operation
1917  * @rates: bitmap of rates to advertise for each band
1918  * @wiphy: the wiphy this was for
1919  * @scan_start: time (in jiffies) when the scan started
1920  * @wdev: the wireless device to scan for
1921  * @info: (internal) information about completed scan
1922  * @notified: (internal) scan request was notified as done or aborted
1923  * @no_cck: used to send probe requests at non CCK rate in 2GHz band
1924  * @mac_addr: MAC address used with randomisation
1925  * @mac_addr_mask: MAC address mask used with randomisation, bits that
1926  *      are 0 in the mask should be randomised, bits that are 1 should
1927  *      be taken from the @mac_addr
1928  * @bssid: BSSID to scan for (most commonly, the wildcard BSSID)
1929  */
1930 struct cfg80211_scan_request {
1931         struct cfg80211_ssid *ssids;
1932         int n_ssids;
1933         u32 n_channels;
1934         enum nl80211_bss_scan_width scan_width;
1935         const u8 *ie;
1936         size_t ie_len;
1937         u16 duration;
1938         bool duration_mandatory;
1939         u32 flags;
1940 
1941         u32 rates[NUM_NL80211_BANDS];
1942 
1943         struct wireless_dev *wdev;
1944 
1945         u8 mac_addr[ETH_ALEN] __aligned(2);
1946         u8 mac_addr_mask[ETH_ALEN] __aligned(2);
1947         u8 bssid[ETH_ALEN] __aligned(2);
1948 
1949         /* internal */
1950         struct wiphy *wiphy;
1951         unsigned long scan_start;
1952         struct cfg80211_scan_info info;
1953         bool notified;
1954         bool no_cck;
1955 
1956         /* keep last */
1957         struct ieee80211_channel *channels[0];
1958 };
1959 
1960 static inline void get_random_mask_addr(u8 *buf, const u8 *addr, const u8 *mask)
1961 {
1962         int i;
1963 
1964         get_random_bytes(buf, ETH_ALEN);
1965         for (i = 0; i < ETH_ALEN; i++) {
1966                 buf[i] &= ~mask[i];
1967                 buf[i] |= addr[i] & mask[i];
1968         }
1969 }
1970 
1971 /**
1972  * struct cfg80211_match_set - sets of attributes to match
1973  *
1974  * @ssid: SSID to be matched; may be zero-length in case of BSSID match
1975  *      or no match (RSSI only)
1976  * @bssid: BSSID to be matched; may be all-zero BSSID in case of SSID match
1977  *      or no match (RSSI only)
1978  * @rssi_thold: don't report scan results below this threshold (in s32 dBm)
1979  * @per_band_rssi_thold: Minimum rssi threshold for each band to be applied
1980  *      for filtering out scan results received. Drivers advertize this support
1981  *      of band specific rssi based filtering through the feature capability
1982  *      %NL80211_EXT_FEATURE_SCHED_SCAN_BAND_SPECIFIC_RSSI_THOLD. These band
1983  *      specific rssi thresholds take precedence over rssi_thold, if specified.
1984  *      If not specified for any band, it will be assigned with rssi_thold of
1985  *      corresponding matchset.
1986  */
1987 struct cfg80211_match_set {
1988         struct cfg80211_ssid ssid;
1989         u8 bssid[ETH_ALEN];
1990         s32 rssi_thold;
1991         s32 per_band_rssi_thold[NUM_NL80211_BANDS];
1992 };
1993 
1994 /**
1995  * struct cfg80211_sched_scan_plan - scan plan for scheduled scan
1996  *
1997  * @interval: interval between scheduled scan iterations. In seconds.
1998  * @iterations: number of scan iterations in this scan plan. Zero means
1999  *      infinite loop.
2000  *      The last scan plan will always have this parameter set to zero,
2001  *      all other scan plans will have a finite number of iterations.
2002  */
2003 struct cfg80211_sched_scan_plan {
2004         u32 interval;
2005         u32 iterations;
2006 };
2007 
2008 /**
2009  * struct cfg80211_bss_select_adjust - BSS selection with RSSI adjustment.
2010  *
2011  * @band: band of BSS which should match for RSSI level adjustment.
2012  * @delta: value of RSSI level adjustment.
2013  */
2014 struct cfg80211_bss_select_adjust {
2015         enum nl80211_band band;
2016         s8 delta;
2017 };
2018 
2019 /**
2020  * struct cfg80211_sched_scan_request - scheduled scan request description
2021  *
2022  * @reqid: identifies this request.
2023  * @ssids: SSIDs to scan for (passed in the probe_reqs in active scans)
2024  * @n_ssids: number of SSIDs
2025  * @n_channels: total number of channels to scan
2026  * @scan_width: channel width for scanning
2027  * @ie: optional information element(s) to add into Probe Request or %NULL
2028  * @ie_len: length of ie in octets
2029  * @flags: bit field of flags controlling operation
2030  * @match_sets: sets of parameters to be matched for a scan result
2031  *      entry to be considered valid and to be passed to the host
2032  *      (others are filtered out).
2033  *      If ommited, all results are passed.
2034  * @n_match_sets: number of match sets
2035  * @report_results: indicates that results were reported for this request
2036  * @wiphy: the wiphy this was for
2037  * @dev: the interface
2038  * @scan_start: start time of the scheduled scan
2039  * @channels: channels to scan
2040  * @min_rssi_thold: for drivers only supporting a single threshold, this
2041  *      contains the minimum over all matchsets
2042  * @mac_addr: MAC address used with randomisation
2043  * @mac_addr_mask: MAC address mask used with randomisation, bits that
2044  *      are 0 in the mask should be randomised, bits that are 1 should
2045  *      be taken from the @mac_addr
2046  * @scan_plans: scan plans to be executed in this scheduled scan. Lowest
2047  *      index must be executed first.
2048  * @n_scan_plans: number of scan plans, at least 1.
2049  * @rcu_head: RCU callback used to free the struct
2050  * @owner_nlportid: netlink portid of owner (if this should is a request
2051  *      owned by a particular socket)
2052  * @nl_owner_dead: netlink owner socket was closed - this request be freed
2053  * @list: for keeping list of requests.
2054  * @delay: delay in seconds to use before starting the first scan
2055  *      cycle.  The driver may ignore this parameter and start
2056  *      immediately (or at any other time), if this feature is not
2057  *      supported.
2058  * @relative_rssi_set: Indicates whether @relative_rssi is set or not.
2059  * @relative_rssi: Relative RSSI threshold in dB to restrict scan result
2060  *      reporting in connected state to cases where a matching BSS is determined
2061  *      to have better or slightly worse RSSI than the current connected BSS.
2062  *      The relative RSSI threshold values are ignored in disconnected state.
2063  * @rssi_adjust: delta dB of RSSI preference to be given to the BSSs that belong
2064  *      to the specified band while deciding whether a better BSS is reported
2065  *      using @relative_rssi. If delta is a negative number, the BSSs that
2066  *      belong to the specified band will be penalized by delta dB in relative
2067  *      comparisions.
2068  */
2069 struct cfg80211_sched_scan_request {
2070         u64 reqid;
2071         struct cfg80211_ssid *ssids;
2072         int n_ssids;
2073         u32 n_channels;
2074         enum nl80211_bss_scan_width scan_width;
2075         const u8 *ie;
2076         size_t ie_len;
2077         u32 flags;
2078         struct cfg80211_match_set *match_sets;
2079         int n_match_sets;
2080         s32 min_rssi_thold;
2081         u32 delay;
2082         struct cfg80211_sched_scan_plan *scan_plans;
2083         int n_scan_plans;
2084 
2085         u8 mac_addr[ETH_ALEN] __aligned(2);
2086         u8 mac_addr_mask[ETH_ALEN] __aligned(2);
2087 
2088         bool relative_rssi_set;
2089         s8 relative_rssi;
2090         struct cfg80211_bss_select_adjust rssi_adjust;
2091 
2092         /* internal */
2093         struct wiphy *wiphy;
2094         struct net_device *dev;
2095         unsigned long scan_start;
2096         bool report_results;
2097         struct rcu_head rcu_head;
2098         u32 owner_nlportid;
2099         bool nl_owner_dead;
2100         struct list_head list;
2101 
2102         /* keep last */
2103         struct ieee80211_channel *channels[0];
2104 };
2105 
2106 /**
2107  * enum cfg80211_signal_type - signal type
2108  *
2109  * @CFG80211_SIGNAL_TYPE_NONE: no signal strength information available
2110  * @CFG80211_SIGNAL_TYPE_MBM: signal strength in mBm (100*dBm)
2111  * @CFG80211_SIGNAL_TYPE_UNSPEC: signal strength, increasing from 0 through 100
2112  */
2113 enum cfg80211_signal_type {
2114         CFG80211_SIGNAL_TYPE_NONE,
2115         CFG80211_SIGNAL_TYPE_MBM,
2116         CFG80211_SIGNAL_TYPE_UNSPEC,
2117 };
2118 
2119 /**
2120  * struct cfg80211_inform_bss - BSS inform data
2121  * @chan: channel the frame was received on
2122  * @scan_width: scan width that was used
2123  * @signal: signal strength value, according to the wiphy's
2124  *      signal type
2125  * @boottime_ns: timestamp (CLOCK_BOOTTIME) when the information was
2126  *      received; should match the time when the frame was actually
2127  *      received by the device (not just by the host, in case it was
2128  *      buffered on the device) and be accurate to about 10ms.
2129  *      If the frame isn't buffered, just passing the return value of
2130  *      ktime_get_boottime_ns() is likely appropriate.
2131  * @parent_tsf: the time at the start of reception of the first octet of the
2132  *      timestamp field of the frame. The time is the TSF of the BSS specified
2133  *      by %parent_bssid.
2134  * @parent_bssid: the BSS according to which %parent_tsf is set. This is set to
2135  *      the BSS that requested the scan in which the beacon/probe was received.
2136  * @chains: bitmask for filled values in @chain_signal.
2137  * @chain_signal: per-chain signal strength of last received BSS in dBm.
2138  */
2139 struct cfg80211_inform_bss {
2140         struct ieee80211_channel *chan;
2141         enum nl80211_bss_scan_width scan_width;
2142         s32 signal;
2143         u64 boottime_ns;
2144         u64 parent_tsf;
2145         u8 parent_bssid[ETH_ALEN] __aligned(2);
2146         u8 chains;
2147         s8 chain_signal[IEEE80211_MAX_CHAINS];
2148 };
2149 
2150 /**
2151  * struct cfg80211_bss_ies - BSS entry IE data
2152  * @tsf: TSF contained in the frame that carried these IEs
2153  * @rcu_head: internal use, for freeing
2154  * @len: length of the IEs
2155  * @from_beacon: these IEs are known to come from a beacon
2156  * @data: IE data
2157  */
2158 struct cfg80211_bss_ies {
2159         u64 tsf;
2160         struct rcu_head rcu_head;
2161         int len;
2162         bool from_beacon;
2163         u8 data[];
2164 };
2165 
2166 /**
2167  * struct cfg80211_bss - BSS description
2168  *
2169  * This structure describes a BSS (which may also be a mesh network)
2170  * for use in scan results and similar.
2171  *
2172  * @channel: channel this BSS is on
2173  * @scan_width: width of the control channel
2174  * @bssid: BSSID of the BSS
2175  * @beacon_interval: the beacon interval as from the frame
2176  * @capability: the capability field in host byte order
2177  * @ies: the information elements (Note that there is no guarantee that these
2178  *      are well-formed!); this is a pointer to either the beacon_ies or
2179  *      proberesp_ies depending on whether Probe Response frame has been
2180  *      received. It is always non-%NULL.
2181  * @beacon_ies: the information elements from the last Beacon frame
2182  *      (implementation note: if @hidden_beacon_bss is set this struct doesn't
2183  *      own the beacon_ies, but they're just pointers to the ones from the
2184  *      @hidden_beacon_bss struct)
2185  * @proberesp_ies: the information elements from the last Probe Response frame
2186  * @hidden_beacon_bss: in case this BSS struct represents a probe response from
2187  *      a BSS that hides the SSID in its beacon, this points to the BSS struct
2188  *      that holds the beacon data. @beacon_ies is still valid, of course, and
2189  *      points to the same data as hidden_beacon_bss->beacon_ies in that case.
2190  * @transmitted_bss: pointer to the transmitted BSS, if this is a
2191  *      non-transmitted one (multi-BSSID support)
2192  * @nontrans_list: list of non-transmitted BSS, if this is a transmitted one
2193  *      (multi-BSSID support)
2194  * @signal: signal strength value (type depends on the wiphy's signal_type)
2195  * @chains: bitmask for filled values in @chain_signal.
2196  * @chain_signal: per-chain signal strength of last received BSS in dBm.
2197  * @bssid_index: index in the multiple BSS set
2198  * @max_bssid_indicator: max number of members in the BSS set
2199  * @priv: private area for driver use, has at least wiphy->bss_priv_size bytes
2200  */
2201 struct cfg80211_bss {
2202         struct ieee80211_channel *channel;
2203         enum nl80211_bss_scan_width scan_width;
2204 
2205         const struct cfg80211_bss_ies __rcu *ies;
2206         const struct cfg80211_bss_ies __rcu *beacon_ies;
2207         const struct cfg80211_bss_ies __rcu *proberesp_ies;
2208 
2209         struct cfg80211_bss *hidden_beacon_bss;
2210         struct cfg80211_bss *transmitted_bss;
2211         struct list_head nontrans_list;
2212 
2213         s32 signal;
2214 
2215         u16 beacon_interval;
2216         u16 capability;
2217 
2218         u8 bssid[ETH_ALEN];
2219         u8 chains;
2220         s8 chain_signal[IEEE80211_MAX_CHAINS];
2221 
2222         u8 bssid_index;
2223         u8 max_bssid_indicator;
2224 
2225         u8 priv[0] __aligned(sizeof(void *));
2226 };
2227 
2228 /**
2229  * ieee80211_bss_get_elem - find element with given ID
2230  * @bss: the bss to search
2231  * @id: the element ID
2232  *
2233  * Note that the return value is an RCU-protected pointer, so
2234  * rcu_read_lock() must be held when calling this function.
2235  * Return: %NULL if not found.
2236  */
2237 const struct element *ieee80211_bss_get_elem(struct cfg80211_bss *bss, u8 id);
2238 
2239 /**
2240  * ieee80211_bss_get_ie - find IE with given ID
2241  * @bss: the bss to search
2242  * @id: the element ID
2243  *
2244  * Note that the return value is an RCU-protected pointer, so
2245  * rcu_read_lock() must be held when calling this function.
2246  * Return: %NULL if not found.
2247  */
2248 static inline const u8 *ieee80211_bss_get_ie(struct cfg80211_bss *bss, u8 id)
2249 {
2250         return (void *)ieee80211_bss_get_elem(bss, id);
2251 }
2252 
2253 
2254 /**
2255  * struct cfg80211_auth_request - Authentication request data
2256  *
2257  * This structure provides information needed to complete IEEE 802.11
2258  * authentication.
2259  *
2260  * @bss: The BSS to authenticate with, the callee must obtain a reference
2261  *      to it if it needs to keep it.
2262  * @auth_type: Authentication type (algorithm)
2263  * @ie: Extra IEs to add to Authentication frame or %NULL
2264  * @ie_len: Length of ie buffer in octets
2265  * @key_len: length of WEP key for shared key authentication
2266  * @key_idx: index of WEP key for shared key authentication
2267  * @key: WEP key for shared key authentication
2268  * @auth_data: Fields and elements in Authentication frames. This contains
2269  *      the authentication frame body (non-IE and IE data), excluding the
2270  *      Authentication algorithm number, i.e., starting at the Authentication
2271  *      transaction sequence number field.
2272  * @auth_data_len: Length of auth_data buffer in octets
2273  */
2274 struct cfg80211_auth_request {
2275         struct cfg80211_bss *bss;
2276         const u8 *ie;
2277         size_t ie_len;
2278         enum nl80211_auth_type auth_type;
2279         const u8 *key;
2280         u8 key_len, key_idx;
2281         const u8 *auth_data;
2282         size_t auth_data_len;
2283 };
2284 
2285 /**
2286  * enum cfg80211_assoc_req_flags - Over-ride default behaviour in association.
2287  *
2288  * @ASSOC_REQ_DISABLE_HT:  Disable HT (802.11n)
2289  * @ASSOC_REQ_DISABLE_VHT:  Disable VHT
2290  * @ASSOC_REQ_USE_RRM: Declare RRM capability in this association
2291  * @CONNECT_REQ_EXTERNAL_AUTH_SUPPORT: User space indicates external
2292  *      authentication capability. Drivers can offload authentication to
2293  *      userspace if this flag is set. Only applicable for cfg80211_connect()
2294  *      request (connect callback).
2295  */
2296 enum cfg80211_assoc_req_flags {
2297         ASSOC_REQ_DISABLE_HT                    = BIT(0),
2298         ASSOC_REQ_DISABLE_VHT                   = BIT(1),
2299         ASSOC_REQ_USE_RRM                       = BIT(2),
2300         CONNECT_REQ_EXTERNAL_AUTH_SUPPORT       = BIT(3),
2301 };
2302 
2303 /**
2304  * struct cfg80211_assoc_request - (Re)Association request data
2305  *
2306  * This structure provides information needed to complete IEEE 802.11
2307  * (re)association.
2308  * @bss: The BSS to associate with. If the call is successful the driver is
2309  *      given a reference that it must give back to cfg80211_send_rx_assoc()
2310  *      or to cfg80211_assoc_timeout(). To ensure proper refcounting, new
2311  *      association requests while already associating must be rejected.
2312  * @ie: Extra IEs to add to (Re)Association Request frame or %NULL
2313  * @ie_len: Length of ie buffer in octets
2314  * @use_mfp: Use management frame protection (IEEE 802.11w) in this association
2315  * @crypto: crypto settings
2316  * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2317  *      to indicate a request to reassociate within the ESS instead of a request
2318  *      do the initial association with the ESS. When included, this is set to
2319  *      the BSSID of the current association, i.e., to the value that is
2320  *      included in the Current AP address field of the Reassociation Request
2321  *      frame.
2322  * @flags:  See &enum cfg80211_assoc_req_flags
2323  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
2324  *      will be used in ht_capa.  Un-supported values will be ignored.
2325  * @ht_capa_mask:  The bits of ht_capa which are to be used.
2326  * @vht_capa: VHT capability override
2327  * @vht_capa_mask: VHT capability mask indicating which fields to use
2328  * @fils_kek: FILS KEK for protecting (Re)Association Request/Response frame or
2329  *      %NULL if FILS is not used.
2330  * @fils_kek_len: Length of fils_kek in octets
2331  * @fils_nonces: FILS nonces (part of AAD) for protecting (Re)Association
2332  *      Request/Response frame or %NULL if FILS is not used. This field starts
2333  *      with 16 octets of STA Nonce followed by 16 octets of AP Nonce.
2334  */
2335 struct cfg80211_assoc_request {
2336         struct cfg80211_bss *bss;
2337         const u8 *ie, *prev_bssid;
2338         size_t ie_len;
2339         struct cfg80211_crypto_settings crypto;
2340         bool use_mfp;
2341         u32 flags;
2342         struct ieee80211_ht_cap ht_capa;
2343         struct ieee80211_ht_cap ht_capa_mask;
2344         struct ieee80211_vht_cap vht_capa, vht_capa_mask;
2345         const u8 *fils_kek;
2346         size_t fils_kek_len;
2347         const u8 *fils_nonces;
2348 };
2349 
2350 /**
2351  * struct cfg80211_deauth_request - Deauthentication request data
2352  *
2353  * This structure provides information needed to complete IEEE 802.11
2354  * deauthentication.
2355  *
2356  * @bssid: the BSSID of the BSS to deauthenticate from
2357  * @ie: Extra IEs to add to Deauthentication frame or %NULL
2358  * @ie_len: Length of ie buffer in octets
2359  * @reason_code: The reason code for the deauthentication
2360  * @local_state_change: if set, change local state only and
2361  *      do not set a deauth frame
2362  */
2363 struct cfg80211_deauth_request {
2364         const u8 *bssid;
2365         const u8 *ie;
2366         size_t ie_len;
2367         u16 reason_code;
2368         bool local_state_change;
2369 };
2370 
2371 /**
2372  * struct cfg80211_disassoc_request - Disassociation request data
2373  *
2374  * This structure provides information needed to complete IEEE 802.11
2375  * disassociation.
2376  *
2377  * @bss: the BSS to disassociate from
2378  * @ie: Extra IEs to add to Disassociation frame or %NULL
2379  * @ie_len: Length of ie buffer in octets
2380  * @reason_code: The reason code for the disassociation
2381  * @local_state_change: This is a request for a local state only, i.e., no
2382  *      Disassociation frame is to be transmitted.
2383  */
2384 struct cfg80211_disassoc_request {
2385         struct cfg80211_bss *bss;
2386         const u8 *ie;
2387         size_t ie_len;
2388         u16 reason_code;
2389         bool local_state_change;
2390 };
2391 
2392 /**
2393  * struct cfg80211_ibss_params - IBSS parameters
2394  *
2395  * This structure defines the IBSS parameters for the join_ibss()
2396  * method.
2397  *
2398  * @ssid: The SSID, will always be non-null.
2399  * @ssid_len: The length of the SSID, will always be non-zero.
2400  * @bssid: Fixed BSSID requested, maybe be %NULL, if set do not
2401  *      search for IBSSs with a different BSSID.
2402  * @chandef: defines the channel to use if no other IBSS to join can be found
2403  * @channel_fixed: The channel should be fixed -- do not search for
2404  *      IBSSs to join on other channels.
2405  * @ie: information element(s) to include in the beacon
2406  * @ie_len: length of that
2407  * @beacon_interval: beacon interval to use
2408  * @privacy: this is a protected network, keys will be configured
2409  *      after joining
2410  * @control_port: whether user space controls IEEE 802.1X port, i.e.,
2411  *      sets/clears %NL80211_STA_FLAG_AUTHORIZED. If true, the driver is
2412  *      required to assume that the port is unauthorized until authorized by
2413  *      user space. Otherwise, port is marked authorized by default.
2414  * @control_port_over_nl80211: TRUE if userspace expects to exchange control
2415  *      port frames over NL80211 instead of the network interface.
2416  * @userspace_handles_dfs: whether user space controls DFS operation, i.e.
2417  *      changes the channel when a radar is detected. This is required
2418  *      to operate on DFS channels.
2419  * @basic_rates: bitmap of basic rates to use when creating the IBSS
2420  * @mcast_rate: per-band multicast rate index + 1 (0: disabled)
2421  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
2422  *      will be used in ht_capa.  Un-supported values will be ignored.
2423  * @ht_capa_mask:  The bits of ht_capa which are to be used.
2424  * @wep_keys: static WEP keys, if not NULL points to an array of
2425  *      CFG80211_MAX_WEP_KEYS WEP keys
2426  * @wep_tx_key: key index (0..3) of the default TX static WEP key
2427  */
2428 struct cfg80211_ibss_params {
2429         const u8 *ssid;
2430         const u8 *bssid;
2431         struct cfg80211_chan_def chandef;
2432         const u8 *ie;
2433         u8 ssid_len, ie_len;
2434         u16 beacon_interval;
2435         u32 basic_rates;
2436         bool channel_fixed;
2437         bool privacy;
2438         bool control_port;
2439         bool control_port_over_nl80211;
2440         bool userspace_handles_dfs;
2441         int mcast_rate[NUM_NL80211_BANDS];
2442         struct ieee80211_ht_cap ht_capa;
2443         struct ieee80211_ht_cap ht_capa_mask;
2444         struct key_params *wep_keys;
2445         int wep_tx_key;
2446 };
2447 
2448 /**
2449  * struct cfg80211_bss_selection - connection parameters for BSS selection.
2450  *
2451  * @behaviour: requested BSS selection behaviour.
2452  * @param: parameters for requestion behaviour.
2453  * @band_pref: preferred band for %NL80211_BSS_SELECT_ATTR_BAND_PREF.
2454  * @adjust: parameters for %NL80211_BSS_SELECT_ATTR_RSSI_ADJUST.
2455  */
2456 struct cfg80211_bss_selection {
2457         enum nl80211_bss_select_attr behaviour;
2458         union {
2459                 enum nl80211_band band_pref;
2460                 struct cfg80211_bss_select_adjust adjust;
2461         } param;
2462 };
2463 
2464 /**
2465  * struct cfg80211_connect_params - Connection parameters
2466  *
2467  * This structure provides information needed to complete IEEE 802.11
2468  * authentication and association.
2469  *
2470  * @channel: The channel to use or %NULL if not specified (auto-select based
2471  *      on scan results)
2472  * @channel_hint: The channel of the recommended BSS for initial connection or
2473  *      %NULL if not specified
2474  * @bssid: The AP BSSID or %NULL if not specified (auto-select based on scan
2475  *      results)
2476  * @bssid_hint: The recommended AP BSSID for initial connection to the BSS or
2477  *      %NULL if not specified. Unlike the @bssid parameter, the driver is
2478  *      allowed to ignore this @bssid_hint if it has knowledge of a better BSS
2479  *      to use.
2480  * @ssid: SSID
2481  * @ssid_len: Length of ssid in octets
2482  * @auth_type: Authentication type (algorithm)
2483  * @ie: IEs for association request
2484  * @ie_len: Length of assoc_ie in octets
2485  * @privacy: indicates whether privacy-enabled APs should be used
2486  * @mfp: indicate whether management frame protection is used
2487  * @crypto: crypto settings
2488  * @key_len: length of WEP key for shared key authentication
2489  * @key_idx: index of WEP key for shared key authentication
2490  * @key: WEP key for shared key authentication
2491  * @flags:  See &enum cfg80211_assoc_req_flags
2492  * @bg_scan_period:  Background scan period in seconds
2493  *      or -1 to indicate that default value is to be used.
2494  * @ht_capa:  HT Capabilities over-rides.  Values set in ht_capa_mask
2495  *      will be used in ht_capa.  Un-supported values will be ignored.
2496  * @ht_capa_mask:  The bits of ht_capa which are to be used.
2497  * @vht_capa:  VHT Capability overrides
2498  * @vht_capa_mask: The bits of vht_capa which are to be used.
2499  * @pbss: if set, connect to a PCP instead of AP. Valid for DMG
2500  *      networks.
2501  * @bss_select: criteria to be used for BSS selection.
2502  * @prev_bssid: previous BSSID, if not %NULL use reassociate frame. This is used
2503  *      to indicate a request to reassociate within the ESS instead of a request
2504  *      do the initial association with the ESS. When included, this is set to
2505  *      the BSSID of the current association, i.e., to the value that is
2506  *      included in the Current AP address field of the Reassociation Request
2507  *      frame.
2508  * @fils_erp_username: EAP re-authentication protocol (ERP) username part of the
2509  *      NAI or %NULL if not specified. This is used to construct FILS wrapped
2510  *      data IE.
2511  * @fils_erp_username_len: Length of @fils_erp_username in octets.
2512  * @fils_erp_realm: EAP re-authentication protocol (ERP) realm part of NAI or
2513  *      %NULL if not specified. This specifies the domain name of ER server and
2514  *      is used to construct FILS wrapped data IE.
2515  * @fils_erp_realm_len: Length of @fils_erp_realm in octets.
2516  * @fils_erp_next_seq_num: The next sequence number to use in the FILS ERP
2517  *      messages. This is also used to construct FILS wrapped data IE.
2518  * @fils_erp_rrk: ERP re-authentication Root Key (rRK) used to derive additional
2519  *      keys in FILS or %NULL if not specified.
2520  * @fils_erp_rrk_len: Length of @fils_erp_rrk in octets.
2521  * @want_1x: indicates user-space supports and wants to use 802.1X driver
2522  *      offload of 4-way handshake.
2523  * @edmg: define the EDMG channels.
2524  *      This may specify multiple channels and bonding options for the driver
2525  *      to choose from, based on BSS configuration.
2526  */
2527 struct cfg80211_connect_params {
2528         struct ieee80211_channel *channel;
2529         struct ieee80211_channel *channel_hint;
2530         const u8 *bssid;
2531         const u8 *bssid_hint;
2532         const u8 *ssid;
2533         size_t ssid_len;
2534         enum nl80211_auth_type auth_type;
2535         const u8 *ie;
2536         size_t ie_len;
2537         bool privacy;
2538         enum nl80211_mfp mfp;
2539         struct cfg80211_crypto_settings crypto;
2540         const u8 *key;
2541         u8 key_len, key_idx;
2542         u32 flags;
2543         int bg_scan_period;
2544         struct ieee80211_ht_cap ht_capa;
2545         struct ieee80211_ht_cap ht_capa_mask;
2546         struct ieee80211_vht_cap vht_capa;
2547         struct ieee80211_vht_cap vht_capa_mask;
2548         bool pbss;
2549         struct cfg80211_bss_selection bss_select;
2550         const u8 *prev_bssid;
2551         const u8 *fils_erp_username;
2552         size_t fils_erp_username_len;
2553         const u8 *fils_erp_realm;
2554         size_t fils_erp_realm_len;
2555         u16 fils_erp_next_seq_num;
2556         const u8 *fils_erp_rrk;
2557         size_t fils_erp_rrk_len;
2558         bool want_1x;
2559         struct ieee80211_edmg edmg;
2560 };
2561 
2562 /**
2563  * enum cfg80211_connect_params_changed - Connection parameters being updated
2564  *
2565  * This enum provides information of all connect parameters that
2566  * have to be updated as part of update_connect_params() call.
2567  *
2568  * @UPDATE_ASSOC_IES: Indicates whether association request IEs are updated
2569  * @UPDATE_FILS_ERP_INFO: Indicates that FILS connection parameters (realm,
2570  *      username, erp sequence number and rrk) are updated
2571  * @UPDATE_AUTH_TYPE: Indicates that authentication type is updated
2572  */
2573 enum cfg80211_connect_params_changed {
2574         UPDATE_ASSOC_IES                = BIT(0),
2575         UPDATE_FILS_ERP_INFO            = BIT(1),
2576         UPDATE_AUTH_TYPE                = BIT(2),
2577 };
2578 
2579 /**
2580  * enum wiphy_params_flags - set_wiphy_params bitfield values
2581  * @WIPHY_PARAM_RETRY_SHORT: wiphy->retry_short has changed
2582  * @WIPHY_PARAM_RETRY_LONG: wiphy->retry_long has changed
2583  * @WIPHY_PARAM_FRAG_THRESHOLD: wiphy->frag_threshold has changed
2584  * @WIPHY_PARAM_RTS_THRESHOLD: wiphy->rts_threshold has changed
2585  * @WIPHY_PARAM_COVERAGE_CLASS: coverage class changed
2586  * @WIPHY_PARAM_DYN_ACK: dynack has been enabled
2587  * @WIPHY_PARAM_TXQ_LIMIT: TXQ packet limit has been changed
2588  * @WIPHY_PARAM_TXQ_MEMORY_LIMIT: TXQ memory limit has been changed
2589  * @WIPHY_PARAM_TXQ_QUANTUM: TXQ scheduler quantum
2590  */
2591 enum wiphy_params_flags {
2592         WIPHY_PARAM_RETRY_SHORT         = 1 << 0,
2593         WIPHY_PARAM_RETRY_LONG          = 1 << 1,
2594         WIPHY_PARAM_FRAG_THRESHOLD      = 1 << 2,
2595         WIPHY_PARAM_RTS_THRESHOLD       = 1 << 3,
2596         WIPHY_PARAM_COVERAGE_CLASS      = 1 << 4,
2597         WIPHY_PARAM_DYN_ACK             = 1 << 5,
2598         WIPHY_PARAM_TXQ_LIMIT           = 1 << 6,
2599         WIPHY_PARAM_TXQ_MEMORY_LIMIT    = 1 << 7,
2600         WIPHY_PARAM_TXQ_QUANTUM         = 1 << 8,
2601 };
2602 
2603 #define IEEE80211_DEFAULT_AIRTIME_WEIGHT        256
2604 
2605 /**
2606  * struct cfg80211_pmksa - PMK Security Association
2607  *
2608  * This structure is passed to the set/del_pmksa() method for PMKSA
2609  * caching.
2610  *
2611  * @bssid: The AP's BSSID (may be %NULL).
2612  * @pmkid: The identifier to refer a PMKSA.
2613  * @pmk: The PMK for the PMKSA identified by @pmkid. This is used for key
2614  *      derivation by a FILS STA. Otherwise, %NULL.
2615  * @pmk_len: Length of the @pmk. The length of @pmk can differ depending on
2616  *      the hash algorithm used to generate this.
2617  * @ssid: SSID to specify the ESS within which a PMKSA is valid when using FILS
2618  *      cache identifier (may be %NULL).
2619  * @ssid_len: Length of the @ssid in octets.
2620  * @cache_id: 2-octet cache identifier advertized by a FILS AP identifying the
2621  *      scope of PMKSA. This is valid only if @ssid_len is non-zero (may be
2622  *      %NULL).
2623  */
2624 struct cfg80211_pmksa {
2625         const u8 *bssid;
2626         const u8 *pmkid;
2627         const u8 *pmk;
2628         size_t pmk_len;
2629         const u8 *ssid;
2630         size_t ssid_len;
2631         const u8 *cache_id;
2632 };
2633 
2634 /**
2635  * struct cfg80211_pkt_pattern - packet pattern
2636  * @mask: bitmask where to match pattern and where to ignore bytes,
2637  *      one bit per byte, in same format as nl80211
2638  * @pattern: bytes to match where bitmask is 1
2639  * @pattern_len: length of pattern (in bytes)
2640  * @pkt_offset: packet offset (in bytes)
2641  *
2642  * Internal note: @mask and @pattern are allocated in one chunk of
2643  * memory, free @mask only!
2644  */
2645 struct cfg80211_pkt_pattern {
2646         const u8 *mask, *pattern;
2647         int pattern_len;
2648         int pkt_offset;
2649 };
2650 
2651 /**
2652  * struct cfg80211_wowlan_tcp - TCP connection parameters
2653  *
2654  * @sock: (internal) socket for source port allocation
2655  * @src: source IP address
2656  * @dst: destination IP address
2657  * @dst_mac: destination MAC address
2658  * @src_port: source port
2659  * @dst_port: destination port
2660  * @payload_len: data payload length
2661  * @payload: data payload buffer
2662  * @payload_seq: payload sequence stamping configuration
2663  * @data_interval: interval at which to send data packets
2664  * @wake_len: wakeup payload match length
2665  * @wake_data: wakeup payload match data
2666  * @wake_mask: wakeup payload match mask
2667  * @tokens_size: length of the tokens buffer
2668  * @payload_tok: payload token usage configuration
2669  */
2670 struct cfg80211_wowlan_tcp {
2671         struct socket *sock;
2672         __be32 src, dst;
2673         u16 src_port, dst_port;
2674         u8 dst_mac[ETH_ALEN];
2675         int payload_len;
2676         const u8 *payload;
2677         struct nl80211_wowlan_tcp_data_seq payload_seq;
2678         u32 data_interval;
2679         u32 wake_len;
2680         const u8 *wake_data, *wake_mask;
2681         u32 tokens_size;
2682         /* must be last, variable member */
2683         struct nl80211_wowlan_tcp_data_token payload_tok;
2684 };
2685 
2686 /**
2687  * struct cfg80211_wowlan - Wake on Wireless-LAN support info
2688  *
2689  * This structure defines the enabled WoWLAN triggers for the device.
2690  * @any: wake up on any activity -- special trigger if device continues
2691  *      operating as normal during suspend
2692  * @disconnect: wake up if getting disconnected
2693  * @magic_pkt: wake up on receiving magic packet
2694  * @patterns: wake up on receiving packet matching a pattern
2695  * @n_patterns: number of patterns
2696  * @gtk_rekey_failure: wake up on GTK rekey failure
2697  * @eap_identity_req: wake up on EAP identity request packet
2698  * @four_way_handshake: wake up on 4-way handshake
2699  * @rfkill_release: wake up when rfkill is released
2700  * @tcp: TCP connection establishment/wakeup parameters, see nl80211.h.
2701  *      NULL if not configured.
2702  * @nd_config: configuration for the scan to be used for net detect wake.
2703  */
2704 struct cfg80211_wowlan {
2705         bool any, disconnect, magic_pkt, gtk_rekey_failure,
2706              eap_identity_req, four_way_handshake,
2707              rfkill_release;
2708         struct cfg80211_pkt_pattern *patterns;
2709         struct cfg80211_wowlan_tcp *tcp;
2710         int n_patterns;
2711         struct cfg80211_sched_scan_request *nd_config;
2712 };
2713 
2714 /**
2715  * struct cfg80211_coalesce_rules - Coalesce rule parameters
2716  *
2717  * This structure defines coalesce rule for the device.
2718  * @delay: maximum coalescing delay in msecs.
2719  * @condition: condition for packet coalescence.
2720  *      see &enum nl80211_coalesce_condition.
2721  * @patterns: array of packet patterns
2722  * @n_patterns: number of patterns
2723  */
2724 struct cfg80211_coalesce_rules {
2725         int delay;
2726         enum nl80211_coalesce_condition condition;
2727         struct cfg80211_pkt_pattern *patterns;
2728         int n_patterns;
2729 };
2730 
2731 /**
2732  * struct cfg80211_coalesce - Packet coalescing settings
2733  *
2734  * This structure defines coalescing settings.
2735  * @rules: array of coalesce rules
2736  * @n_rules: number of rules
2737  */
2738 struct cfg80211_coalesce {
2739         struct cfg80211_coalesce_rules *rules;
2740         int n_rules;
2741 };
2742 
2743 /**
2744  * struct cfg80211_wowlan_nd_match - information about the match
2745  *
2746  * @ssid: SSID of the match that triggered the wake up
2747  * @n_channels: Number of channels where the match occurred.  This
2748  *      value may be zero if the driver can't report the channels.
2749  * @channels: center frequencies of the channels where a match
2750  *      occurred (in MHz)
2751  */
2752 struct cfg80211_wowlan_nd_match {
2753         struct cfg80211_ssid ssid;
2754         int n_channels;
2755         u32 channels[];
2756 };
2757 
2758 /**
2759  * struct cfg80211_wowlan_nd_info - net detect wake up information
2760  *
2761  * @n_matches: Number of match information instances provided in
2762  *      @matches.  This value may be zero if the driver can't provide
2763  *      match information.
2764  * @matches: Array of pointers to matches containing information about
2765  *      the matches that triggered the wake up.
2766  */
2767 struct cfg80211_wowlan_nd_info {
2768         int n_matches;
2769         struct cfg80211_wowlan_nd_match *matches[];
2770 };
2771 
2772 /**
2773  * struct cfg80211_wowlan_wakeup - wakeup report
2774  * @disconnect: woke up by getting disconnected
2775  * @magic_pkt: woke up by receiving magic packet
2776  * @gtk_rekey_failure: woke up by GTK rekey failure
2777  * @eap_identity_req: woke up by EAP identity request packet
2778  * @four_way_handshake: woke up by 4-way handshake
2779  * @rfkill_release: woke up by rfkill being released
2780  * @pattern_idx: pattern that caused wakeup, -1 if not due to pattern
2781  * @packet_present_len: copied wakeup packet data
2782  * @packet_len: original wakeup packet length
2783  * @packet: The packet causing the wakeup, if any.
2784  * @packet_80211:  For pattern match, magic packet and other data
2785  *      frame triggers an 802.3 frame should be reported, for
2786  *      disconnect due to deauth 802.11 frame. This indicates which
2787  *      it is.
2788  * @tcp_match: TCP wakeup packet received
2789  * @tcp_connlost: TCP connection lost or failed to establish
2790  * @tcp_nomoretokens: TCP data ran out of tokens
2791  * @net_detect: if not %NULL, woke up because of net detect
2792  */
2793 struct cfg80211_wowlan_wakeup {
2794         bool disconnect, magic_pkt, gtk_rekey_failure,
2795              eap_identity_req, four_way_handshake,
2796              rfkill_release, packet_80211,
2797              tcp_match, tcp_connlost, tcp_nomoretokens;
2798         s32 pattern_idx;
2799         u32 packet_present_len, packet_len;
2800         const void *packet;
2801         struct cfg80211_wowlan_nd_info *net_detect;
2802 };
2803 
2804 /**
2805  * struct cfg80211_gtk_rekey_data - rekey data
2806  * @kek: key encryption key (NL80211_KEK_LEN bytes)
2807  * @kck: key confirmation key (NL80211_KCK_LEN bytes)
2808  * @replay_ctr: replay counter (NL80211_REPLAY_CTR_LEN bytes)
2809  */
2810 struct cfg80211_gtk_rekey_data {
2811         const u8 *kek, *kck, *replay_ctr;
2812 };
2813 
2814 /**
2815  * struct cfg80211_update_ft_ies_params - FT IE Information
2816  *
2817  * This structure provides information needed to update the fast transition IE
2818  *
2819  * @md: The Mobility Domain ID, 2 Octet value
2820  * @ie: Fast Transition IEs
2821  * @ie_len: Length of ft_ie in octets
2822  */
2823 struct cfg80211_update_ft_ies_params {
2824         u16 md;
2825         const u8 *ie;
2826         size_t ie_len;
2827 };
2828 
2829 /**
2830  * struct cfg80211_mgmt_tx_params - mgmt tx parameters
2831  *
2832  * This structure provides information needed to transmit a mgmt frame
2833  *
2834  * @chan: channel to use
2835  * @offchan: indicates wether off channel operation is required
2836  * @wait: duration for ROC
2837  * @buf: buffer to transmit
2838  * @len: buffer length
2839  * @no_cck: don't use cck rates for this frame
2840  * @dont_wait_for_ack: tells the low level not to wait for an ack
2841  * @n_csa_offsets: length of csa_offsets array
2842  * @csa_offsets: array of all the csa offsets in the frame
2843  */
2844 struct cfg80211_mgmt_tx_params {
2845         struct ieee80211_channel *chan;
2846         bool offchan;
2847         unsigned int wait;
2848         const u8 *buf;
2849         size_t len;
2850         bool no_cck;
2851         bool dont_wait_for_ack;
2852         int n_csa_offsets;
2853         const u16 *csa_offsets;
2854 };
2855 
2856 /**
2857  * struct cfg80211_dscp_exception - DSCP exception
2858  *
2859  * @dscp: DSCP value that does not adhere to the user priority range definition
2860  * @up: user priority value to which the corresponding DSCP value belongs
2861  */
2862 struct cfg80211_dscp_exception {
2863         u8 dscp;
2864         u8 up;
2865 };
2866 
2867 /**
2868  * struct cfg80211_dscp_range - DSCP range definition for user priority
2869  *
2870  * @low: lowest DSCP value of this user priority range, inclusive
2871  * @high: highest DSCP value of this user priority range, inclusive
2872  */
2873 struct cfg80211_dscp_range {
2874         u8 low;
2875         u8 high;
2876 };
2877 
2878 /* QoS Map Set element length defined in IEEE Std 802.11-2012, 8.4.2.97 */
2879 #define IEEE80211_QOS_MAP_MAX_EX        21
2880 #define IEEE80211_QOS_MAP_LEN_MIN       16
2881 #define IEEE80211_QOS_MAP_LEN_MAX \
2882         (IEEE80211_QOS_MAP_LEN_MIN + 2 * IEEE80211_QOS_MAP_MAX_EX)
2883 
2884 /**
2885  * struct cfg80211_qos_map - QoS Map Information
2886  *
2887  * This struct defines the Interworking QoS map setting for DSCP values
2888  *
2889  * @num_des: number of DSCP exceptions (0..21)
2890  * @dscp_exception: optionally up to maximum of 21 DSCP exceptions from
2891  *      the user priority DSCP range definition
2892  * @up: DSCP range definition for a particular user priority
2893  */
2894 struct cfg80211_qos_map {
2895         u8 num_des;
2896         struct cfg80211_dscp_exception dscp_exception[IEEE80211_QOS_MAP_MAX_EX];
2897         struct cfg80211_dscp_range up[8];
2898 };
2899 
2900 /**
2901  * struct cfg80211_nan_conf - NAN configuration
2902  *
2903  * This struct defines NAN configuration parameters
2904  *
2905  * @master_pref: master preference (1 - 255)
2906  * @bands: operating bands, a bitmap of &enum nl80211_band values.
2907  *      For instance, for NL80211_BAND_2GHZ, bit 0 would be set
2908  *      (i.e. BIT(NL80211_BAND_2GHZ)).
2909  */
2910 struct cfg80211_nan_conf {
2911         u8 master_pref;
2912         u8 bands;
2913 };
2914 
2915 /**
2916  * enum cfg80211_nan_conf_changes - indicates changed fields in NAN
2917  * configuration
2918  *
2919  * @CFG80211_NAN_CONF_CHANGED_PREF: master preference
2920  * @CFG80211_NAN_CONF_CHANGED_BANDS: operating bands
2921  */
2922 enum cfg80211_nan_conf_changes {
2923         CFG80211_NAN_CONF_CHANGED_PREF = BIT(0),
2924         CFG80211_NAN_CONF_CHANGED_BANDS = BIT(1),
2925 };
2926 
2927 /**
2928  * struct cfg80211_nan_func_filter - a NAN function Rx / Tx filter
2929  *
2930  * @filter: the content of the filter
2931  * @len: the length of the filter
2932  */
2933 struct cfg80211_nan_func_filter {
2934         const u8 *filter;
2935         u8 len;
2936 };
2937 
2938 /**
2939  * struct cfg80211_nan_func - a NAN function
2940  *
2941  * @type: &enum nl80211_nan_function_type
2942  * @service_id: the service ID of the function
2943  * @publish_type: &nl80211_nan_publish_type
2944  * @close_range: if true, the range should be limited. Threshold is
2945  *      implementation specific.
2946  * @publish_bcast: if true, the solicited publish should be broadcasted
2947  * @subscribe_active: if true, the subscribe is active
2948  * @followup_id: the instance ID for follow up
2949  * @followup_reqid: the requestor instance ID for follow up
2950  * @followup_dest: MAC address of the recipient of the follow up
2951  * @ttl: time to live counter in DW.
2952  * @serv_spec_info: Service Specific Info
2953  * @serv_spec_info_len: Service Specific Info length
2954  * @srf_include: if true, SRF is inclusive
2955  * @srf_bf: Bloom Filter
2956  * @srf_bf_len: Bloom Filter length
2957  * @srf_bf_idx: Bloom Filter index
2958  * @srf_macs: SRF MAC addresses
2959  * @srf_num_macs: number of MAC addresses in SRF
2960  * @rx_filters: rx filters that are matched with corresponding peer's tx_filter
2961  * @tx_filters: filters that should be transmitted in the SDF.
2962  * @num_rx_filters: length of &rx_filters.
2963  * @num_tx_filters: length of &tx_filters.
2964  * @instance_id: driver allocated id of the function.
2965  * @cookie: unique NAN function identifier.
2966  */
2967 struct cfg80211_nan_func {
2968         enum nl80211_nan_function_type type;
2969         u8 service_id[NL80211_NAN_FUNC_SERVICE_ID_LEN];
2970         u8 publish_type;
2971         bool close_range;
2972         bool publish_bcast;
2973         bool subscribe_active;
2974         u8 followup_id;
2975         u8 followup_reqid;
2976         struct mac_address followup_dest;
2977         u32 ttl;
2978         const u8 *serv_spec_info;
2979         u8 serv_spec_info_len;
2980         bool srf_include;
2981         const u8 *srf_bf;
2982         u8 srf_bf_len;
2983         u8 srf_bf_idx;
2984         struct mac_address *srf_macs;
2985         int srf_num_macs;
2986         struct cfg80211_nan_func_filter *rx_filters;
2987         struct cfg80211_nan_func_filter *tx_filters;
2988         u8 num_tx_filters;
2989         u8 num_rx_filters;
2990         u8 instance_id;
2991         u64 cookie;
2992 };
2993 
2994 /**
2995  * struct cfg80211_pmk_conf - PMK configuration
2996  *
2997  * @aa: authenticator address
2998  * @pmk_len: PMK length in bytes.
2999  * @pmk: the PMK material
3000  * @pmk_r0_name: PMK-R0 Name. NULL if not applicable (i.e., the PMK
3001  *      is not PMK-R0). When pmk_r0_name is not NULL, the pmk field
3002  *      holds PMK-R0.
3003  */
3004 struct cfg80211_pmk_conf {
3005         const u8 *aa;
3006         u8 pmk_len;
3007         const u8 *pmk;
3008         const u8 *pmk_r0_name;
3009 };
3010 
3011 /**
3012  * struct cfg80211_external_auth_params - Trigger External authentication.
3013  *
3014  * Commonly used across the external auth request and event interfaces.
3015  *
3016  * @action: action type / trigger for external authentication. Only significant
3017  *      for the authentication request event interface (driver to user space).
3018  * @bssid: BSSID of the peer with which the authentication has
3019  *      to happen. Used by both the authentication request event and
3020  *      authentication response command interface.
3021  * @ssid: SSID of the AP.  Used by both the authentication request event and
3022  *      authentication response command interface.
3023  * @key_mgmt_suite: AKM suite of the respective authentication. Used by the
3024  *      authentication request event interface.
3025  * @status: status code, %WLAN_STATUS_SUCCESS for successful authentication,
3026  *      use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space cannot give you
3027  *      the real status code for failures. Used only for the authentication
3028  *      response command interface (user space to driver).
3029  * @pmkid: The identifier to refer a PMKSA.
3030  */
3031 struct cfg80211_external_auth_params {
3032         enum nl80211_external_auth_action action;
3033         u8 bssid[ETH_ALEN] __aligned(2);
3034         struct cfg80211_ssid ssid;
3035         unsigned int key_mgmt_suite;
3036         u16 status;
3037         const u8 *pmkid;
3038 };
3039 
3040 /**
3041  * struct cfg80211_ftm_responder_stats - FTM responder statistics
3042  *
3043  * @filled: bitflag of flags using the bits of &enum nl80211_ftm_stats to
3044  *      indicate the relevant values in this struct for them
3045  * @success_num: number of FTM sessions in which all frames were successfully
3046  *      answered
3047  * @partial_num: number of FTM sessions in which part of frames were
3048  *      successfully answered
3049  * @failed_num: number of failed FTM sessions
3050  * @asap_num: number of ASAP FTM sessions
3051  * @non_asap_num: number of  non-ASAP FTM sessions
3052  * @total_duration_ms: total sessions durations - gives an indication
3053  *      of how much time the responder was busy
3054  * @unknown_triggers_num: number of unknown FTM triggers - triggers from
3055  *      initiators that didn't finish successfully the negotiation phase with
3056  *      the responder
3057  * @reschedule_requests_num: number of FTM reschedule requests - initiator asks
3058  *      for a new scheduling although it already has scheduled FTM slot
3059  * @out_of_window_triggers_num: total FTM triggers out of scheduled window
3060  */
3061 struct cfg80211_ftm_responder_stats {
3062         u32 filled;
3063         u32 success_num;
3064         u32 partial_num;
3065         u32 failed_num;
3066         u32 asap_num;
3067         u32 non_asap_num;
3068         u64 total_duration_ms;
3069         u32 unknown_triggers_num;
3070         u32 reschedule_requests_num;
3071         u32 out_of_window_triggers_num;
3072 };
3073 
3074 /**
3075  * struct cfg80211_pmsr_ftm_result - FTM result
3076  * @failure_reason: if this measurement failed (PMSR status is
3077  *      %NL80211_PMSR_STATUS_FAILURE), this gives a more precise
3078  *      reason than just "failure"
3079  * @burst_index: if reporting partial results, this is the index
3080  *      in [0 .. num_bursts-1] of the burst that's being reported
3081  * @num_ftmr_attempts: number of FTM request frames transmitted
3082  * @num_ftmr_successes: number of FTM request frames acked
3083  * @busy_retry_time: if failure_reason is %NL80211_PMSR_FTM_FAILURE_PEER_BUSY,
3084  *      fill this to indicate in how many seconds a retry is deemed possible
3085  *      by the responder
3086  * @num_bursts_exp: actual number of bursts exponent negotiated
3087  * @burst_duration: actual burst duration negotiated
3088  * @ftms_per_burst: actual FTMs per burst negotiated
3089  * @lci_len: length of LCI information (if present)
3090  * @civicloc_len: length of civic location information (if present)
3091  * @lci: LCI data (may be %NULL)
3092  * @civicloc: civic location data (may be %NULL)
3093  * @rssi_avg: average RSSI over FTM action frames reported
3094  * @rssi_spread: spread of the RSSI over FTM action frames reported
3095  * @tx_rate: bitrate for transmitted FTM action frame response
3096  * @rx_rate: bitrate of received FTM action frame
3097  * @rtt_avg: average of RTTs measured (must have either this or @dist_avg)
3098  * @rtt_variance: variance of RTTs measured (note that standard deviation is
3099  *      the square root of the variance)
3100  * @rtt_spread: spread of the RTTs measured
3101  * @dist_avg: average of distances (mm) measured
3102  *      (must have either this or @rtt_avg)
3103  * @dist_variance: variance of distances measured (see also @rtt_variance)
3104  * @dist_spread: spread of distances measured (see also @rtt_spread)
3105  * @num_ftmr_attempts_valid: @num_ftmr_attempts is valid
3106  * @num_ftmr_successes_valid: @num_ftmr_successes is valid
3107  * @rssi_avg_valid: @rssi_avg is valid
3108  * @rssi_spread_valid: @rssi_spread is valid
3109  * @tx_rate_valid: @tx_rate is valid
3110  * @rx_rate_valid: @rx_rate is valid
3111  * @rtt_avg_valid: @rtt_avg is valid
3112  * @rtt_variance_valid: @rtt_variance is valid
3113  * @rtt_spread_valid: @rtt_spread is valid
3114  * @dist_avg_valid: @dist_avg is valid
3115  * @dist_variance_valid: @dist_variance is valid
3116  * @dist_spread_valid: @dist_spread is valid
3117  */
3118 struct cfg80211_pmsr_ftm_result {
3119         const u8 *lci;
3120         const u8 *civicloc;
3121         unsigned int lci_len;
3122         unsigned int civicloc_len;
3123         enum nl80211_peer_measurement_ftm_failure_reasons failure_reason;
3124         u32 num_ftmr_attempts, num_ftmr_successes;
3125         s16 burst_index;
3126         u8 busy_retry_time;
3127         u8 num_bursts_exp;
3128         u8 burst_duration;
3129         u8 ftms_per_burst;
3130         s32 rssi_avg;
3131         s32 rssi_spread;
3132         struct rate_info tx_rate, rx_rate;
3133         s64 rtt_avg;
3134         s64 rtt_variance;
3135         s64 rtt_spread;
3136         s64 dist_avg;
3137         s64 dist_variance;
3138         s64 dist_spread;
3139 
3140         u16 num_ftmr_attempts_valid:1,
3141             num_ftmr_successes_valid:1,
3142             rssi_avg_valid:1,
3143             rssi_spread_valid:1,
3144             tx_rate_valid:1,
3145             rx_rate_valid:1,
3146             rtt_avg_valid:1,
3147             rtt_variance_valid:1,
3148             rtt_spread_valid:1,
3149             dist_avg_valid:1,
3150             dist_variance_valid:1,
3151             dist_spread_valid:1;
3152 };
3153 
3154 /**
3155  * struct cfg80211_pmsr_result - peer measurement result
3156  * @addr: address of the peer
3157  * @host_time: host time (use ktime_get_boottime() adjust to the time when the
3158  *      measurement was made)
3159  * @ap_tsf: AP's TSF at measurement time
3160  * @status: status of the measurement
3161  * @final: if reporting partial results, mark this as the last one; if not
3162  *      reporting partial results always set this flag
3163  * @ap_tsf_valid: indicates the @ap_tsf value is valid
3164  * @type: type of the measurement reported, note that we only support reporting
3165  *      one type at a time, but you can report multiple results separately and
3166  *      they're all aggregated for userspace.
3167  */
3168 struct cfg80211_pmsr_result {
3169         u64 host_time, ap_tsf;
3170         enum nl80211_peer_measurement_status status;
3171 
3172         u8 addr[ETH_ALEN];
3173 
3174         u8 final:1,
3175            ap_tsf_valid:1;
3176 
3177         enum nl80211_peer_measurement_type type;
3178 
3179         union {
3180                 struct cfg80211_pmsr_ftm_result ftm;
3181         };
3182 };
3183 
3184 /**
3185  * struct cfg80211_pmsr_ftm_request_peer - FTM request data
3186  * @requested: indicates FTM is requested
3187  * @preamble: frame preamble to use
3188  * @burst_period: burst period to use
3189  * @asap: indicates to use ASAP mode
3190  * @num_bursts_exp: number of bursts exponent
3191  * @burst_duration: burst duration
3192  * @ftms_per_burst: number of FTMs per burst
3193  * @ftmr_retries: number of retries for FTM request
3194  * @request_lci: request LCI information
3195  * @request_civicloc: request civic location information
3196  *
3197  * See also nl80211 for the respective attribute documentation.
3198  */
3199 struct cfg80211_pmsr_ftm_request_peer {
3200         enum nl80211_preamble preamble;
3201         u16 burst_period;
3202         u8 requested:1,
3203            asap:1,
3204            request_lci:1,
3205            request_civicloc:1;
3206         u8 num_bursts_exp;
3207         u8 burst_duration;
3208         u8 ftms_per_burst;
3209         u8 ftmr_retries;
3210 };
3211 
3212 /**
3213  * struct cfg80211_pmsr_request_peer - peer data for a peer measurement request
3214  * @addr: MAC address
3215  * @chandef: channel to use
3216  * @report_ap_tsf: report the associated AP's TSF
3217  * @ftm: FTM data, see &struct cfg80211_pmsr_ftm_request_peer
3218  */
3219 struct cfg80211_pmsr_request_peer {
3220         u8 addr[ETH_ALEN];
3221         struct cfg80211_chan_def chandef;
3222         u8 report_ap_tsf:1;
3223         struct cfg80211_pmsr_ftm_request_peer ftm;
3224 };
3225 
3226 /**
3227  * struct cfg80211_pmsr_request - peer measurement request
3228  * @cookie: cookie, set by cfg80211
3229  * @nl_portid: netlink portid - used by cfg80211
3230  * @drv_data: driver data for this request, if required for aborting,
3231  *      not otherwise freed or anything by cfg80211
3232  * @mac_addr: MAC address used for (randomised) request
3233  * @mac_addr_mask: MAC address mask used for randomisation, bits that
3234  *      are 0 in the mask should be randomised, bits that are 1 should
3235  *      be taken from the @mac_addr
3236  * @list: used by cfg80211 to hold on to the request
3237  * @timeout: timeout (in milliseconds) for the whole operation, if
3238  *      zero it means there's no timeout
3239  * @n_peers: number of peers to do measurements with
3240  * @peers: per-peer measurement request data
3241  */
3242 struct cfg80211_pmsr_request {
3243         u64 cookie;
3244         void *drv_data;
3245         u32 n_peers;
3246         u32 nl_portid;
3247 
3248         u32 timeout;
3249 
3250         u8 mac_addr[ETH_ALEN] __aligned(2);
3251         u8 mac_addr_mask[ETH_ALEN] __aligned(2);
3252 
3253         struct list_head list;
3254 
3255         struct cfg80211_pmsr_request_peer peers[];
3256 };
3257 
3258 /**
3259  * struct cfg80211_update_owe_info - OWE Information
3260  *
3261  * This structure provides information needed for the drivers to offload OWE
3262  * (Opportunistic Wireless Encryption) processing to the user space.
3263  *
3264  * Commonly used across update_owe_info request and event interfaces.
3265  *
3266  * @peer: MAC address of the peer device for which the OWE processing
3267  *      has to be done.
3268  * @status: status code, %WLAN_STATUS_SUCCESS for successful OWE info
3269  *      processing, use %WLAN_STATUS_UNSPECIFIED_FAILURE if user space
3270  *      cannot give you the real status code for failures. Used only for
3271  *      OWE update request command interface (user space to driver).
3272  * @ie: IEs obtained from the peer or constructed by the user space. These are
3273  *      the IEs of the remote peer in the event from the host driver and
3274  *      the constructed IEs by the user space in the request interface.
3275  * @ie_len: Length of IEs in octets.
3276  */
3277 struct cfg80211_update_owe_info {
3278         u8 peer[ETH_ALEN] __aligned(2);
3279         u16 status;
3280         const u8 *ie;
3281         size_t ie_len;
3282 };
3283 
3284 /**
3285  * struct cfg80211_ops - backend description for wireless configuration
3286  *
3287  * This struct is registered by fullmac card drivers and/or wireless stacks
3288  * in order to handle configuration requests on their interfaces.
3289  *
3290  * All callbacks except where otherwise noted should return 0
3291  * on success or a negative error code.
3292  *
3293  * All operations are currently invoked under rtnl for consistency with the
3294  * wireless extensions but this is subject to reevaluation as soon as this
3295  * code is used more widely and we have a first user without wext.
3296  *
3297  * @suspend: wiphy device needs to be suspended. The variable @wow will
3298  *      be %NULL or contain the enabled Wake-on-Wireless triggers that are
3299  *      configured for the device.
3300  * @resume: wiphy device needs to be resumed
3301  * @set_wakeup: Called when WoWLAN is enabled/disabled, use this callback
3302  *      to call device_set_wakeup_enable() to enable/disable wakeup from
3303  *      the device.
3304  *
3305  * @add_virtual_intf: create a new virtual interface with the given name,
3306  *      must set the struct wireless_dev's iftype. Beware: You must create
3307  *      the new netdev in the wiphy's network namespace! Returns the struct
3308  *      wireless_dev, or an ERR_PTR. For P2P device wdevs, the driver must
3309  *      also set the address member in the wdev.
3310  *
3311  * @del_virtual_intf: remove the virtual interface
3312  *
3313  * @change_virtual_intf: change type/configuration of virtual interface,
3314  *      keep the struct wireless_dev's iftype updated.
3315  *
3316  * @add_key: add a key with the given parameters. @mac_addr will be %NULL
3317  *      when adding a group key.
3318  *
3319  * @get_key: get information about the key with the given parameters.
3320  *      @mac_addr will be %NULL when requesting information for a group
3321  *      key. All pointers given to the @callback function need not be valid
3322  *      after it returns. This function should return an error if it is
3323  *      not possible to retrieve the key, -ENOENT if it doesn't exist.
3324  *
3325  * @del_key: remove a key given the @mac_addr (%NULL for a group key)
3326  *      and @key_index, return -ENOENT if the key doesn't exist.
3327  *
3328  * @set_default_key: set the default key on an interface
3329  *
3330  * @set_default_mgmt_key: set the default management frame key on an interface
3331  *
3332  * @set_rekey_data: give the data necessary for GTK rekeying to the driver
3333  *
3334  * @start_ap: Start acting in AP mode defined by the parameters.
3335  * @change_beacon: Change the beacon parameters for an access point mode
3336  *      interface. This should reject the call when AP mode wasn't started.
3337  * @stop_ap: Stop being an AP, including stopping beaconing.
3338  *
3339  * @add_station: Add a new station.
3340  * @del_station: Remove a station
3341  * @change_station: Modify a given station. Note that flags changes are not much
3342  *      validated in cfg80211, in particular the auth/assoc/authorized flags
3343  *      might come to the driver in invalid combinations -- make sure to check
3344  *      them, also against the existing state! Drivers must call
3345  *      cfg80211_check_station_change() to validate the information.
3346  * @get_station: get station information for the station identified by @mac
3347  * @dump_station: dump station callback -- resume dump at index @idx
3348  *
3349  * @add_mpath: add a fixed mesh path
3350  * @del_mpath: delete a given mesh path
3351  * @change_mpath: change a given mesh path
3352  * @get_mpath: get a mesh path for the given parameters
3353  * @dump_mpath: dump mesh path callback -- resume dump at index @idx
3354  * @get_mpp: get a mesh proxy path for the given parameters
3355  * @dump_mpp: dump mesh proxy path callback -- resume dump at index @idx
3356  * @join_mesh: join the mesh network with the specified parameters
3357  *      (invoked with the wireless_dev mutex held)
3358  * @leave_mesh: leave the current mesh network
3359  *      (invoked with the wireless_dev mutex held)
3360  *
3361  * @get_mesh_config: Get the current mesh configuration
3362  *
3363  * @update_mesh_config: Update mesh parameters on a running mesh.
3364  *      The mask is a bitfield which tells us which parameters to
3365  *      set, and which to leave alone.
3366  *
3367  * @change_bss: Modify parameters for a given BSS.
3368  *
3369  * @set_txq_params: Set TX queue parameters
3370  *
3371  * @libertas_set_mesh_channel: Only for backward compatibility for libertas,
3372  *      as it doesn't implement join_mesh and needs to set the channel to
3373  *      join the mesh instead.
3374  *
3375  * @set_monitor_channel: Set the monitor mode channel for the device. If other
3376  *      interfaces are active this callback should reject the configuration.
3377  *      If no interfaces are active or the device is down, the channel should
3378  *      be stored for when a monitor interface becomes active.
3379  *
3380  * @scan: Request to do a scan. If returning zero, the scan request is given
3381  *      the driver, and will be valid until passed to cfg80211_scan_done().
3382  *      For scan results, call cfg80211_inform_bss(); you can call this outside
3383  *      the scan/scan_done bracket too.
3384  * @abort_scan: Tell the driver to abort an ongoing scan. The driver shall
3385  *      indicate the status of the scan through cfg80211_scan_done().
3386  *
3387  * @auth: Request to authenticate with the specified peer
3388  *      (invoked with the wireless_dev mutex held)
3389  * @assoc: Request to (re)associate with the specified peer
3390  *      (invoked with the wireless_dev mutex held)
3391  * @deauth: Request to deauthenticate from the specified peer
3392  *      (invoked with the wireless_dev mutex held)
3393  * @disassoc: Request to disassociate from the specified peer
3394  *      (invoked with the wireless_dev mutex held)
3395  *
3396  * @connect: Connect to the ESS with the specified parameters. When connected,
3397  *      call cfg80211_connect_result()/cfg80211_connect_bss() with status code
3398  *      %WLAN_STATUS_SUCCESS. If the connection fails for some reason, call
3399  *      cfg80211_connect_result()/cfg80211_connect_bss() with the status code
3400  *      from the AP or cfg80211_connect_timeout() if no frame with status code
3401  *      was received.
3402  *      The driver is allowed to roam to other BSSes within the ESS when the
3403  *      other BSS matches the connect parameters. When such roaming is initiated
3404  *      by the driver, the driver is expected to verify that the target matches
3405  *      the configured security parameters and to use Reassociation Request
3406  *      frame instead of Association Request frame.
3407  *      The connect function can also be used to request the driver to perform a
3408  *      specific roam when connected to an ESS. In that case, the prev_bssid
3409  *      parameter is set to the BSSID of the currently associated BSS as an
3410  *      indication of requesting reassociation.
3411  *      In both the driver-initiated and new connect() call initiated roaming
3412  *      cases, the result of roaming is indicated with a call to
3413  *      cfg80211_roamed(). (invoked with the wireless_dev mutex held)
3414  * @update_connect_params: Update the connect parameters while connected to a
3415  *      BSS. The updated parameters can be used by driver/firmware for
3416  *      subsequent BSS selection (roaming) decisions and to form the
3417  *      Authentication/(Re)Association Request frames. This call does not
3418  *      request an immediate disassociation or reassociation with the current
3419  *      BSS, i.e., this impacts only subsequent (re)associations. The bits in
3420  *      changed are defined in &enum cfg80211_connect_params_changed.
3421  *      (invoked with the wireless_dev mutex held)
3422  * @disconnect: Disconnect from the BSS/ESS or stop connection attempts if
3423  *      connection is in progress. Once done, call cfg80211_disconnected() in
3424  *      case connection was already established (invoked with the
3425  *      wireless_dev mutex held), otherwise call cfg80211_connect_timeout().
3426  *
3427  * @join_ibss: Join the specified IBSS (or create if necessary). Once done, call
3428  *      cfg80211_ibss_joined(), also call that function when changing BSSID due
3429  *      to a merge.
3430  *      (invoked with the wireless_dev mutex held)
3431  * @leave_ibss: Leave the IBSS.
3432  *      (invoked with the wireless_dev mutex held)
3433  *
3434  * @set_mcast_rate: Set the specified multicast rate (only if vif is in ADHOC or
3435  *      MESH mode)
3436  *
3437  * @set_wiphy_params: Notify that wiphy parameters have changed;
3438  *      @changed bitfield (see &enum wiphy_params_flags) describes which values
3439  *      have changed. The actual parameter values are available in
3440  *      struct wiphy. If returning an error, no value should be changed.
3441  *
3442  * @set_tx_power: set the transmit power according to the parameters,
3443  *      the power passed is in mBm, to get dBm use MBM_TO_DBM(). The
3444  *      wdev may be %NULL if power was set for the wiphy, and will
3445  *      always be %NULL unless the driver supports per-vif TX power
3446  *      (as advertised by the nl80211 feature flag.)
3447  * @get_tx_power: store the current TX power into the dbm variable;
3448  *      return 0 if successful
3449  *
3450  * @set_wds_peer: set the WDS peer for a WDS interface
3451  *
3452  * @rfkill_poll: polls the hw rfkill line, use cfg80211 reporting
3453  *      functions to adjust rfkill hw state
3454  *
3455  * @dump_survey: get site survey information.
3456  *
3457  * @remain_on_channel: Request the driver to remain awake on the specified
3458  *      channel for the specified duration to complete an off-channel
3459  *      operation (e.g., public action frame exchange). When the driver is
3460  *      ready on the requested channel, it must indicate this with an event
3461  *      notification by calling cfg80211_ready_on_channel().
3462  * @cancel_remain_on_channel: Cancel an on-going remain-on-channel operation.
3463  *      This allows the operation to be terminated prior to timeout based on
3464  *      the duration value.
3465  * @mgmt_tx: Transmit a management frame.
3466  * @mgmt_tx_cancel_wait: Cancel the wait time from transmitting a management
3467  *      frame on another channel
3468  *
3469  * @testmode_cmd: run a test mode command; @wdev may be %NULL
3470  * @testmode_dump: Implement a test mode dump. The cb->args[2] and up may be
3471  *      used by the function, but 0 and 1 must not be touched. Additionally,
3472  *      return error codes other than -ENOBUFS and -ENOENT will terminate the
3473  *      dump and return to userspace with an error, so be careful. If any data
3474  *      was passed in from userspace then the data/len arguments will be present
3475  *      and point to the data contained in %NL80211_ATTR_TESTDATA.
3476  *
3477  * @set_bitrate_mask: set the bitrate mask configuration
3478  *
3479  * @set_pmksa: Cache a PMKID for a BSSID. This is mostly useful for fullmac
3480  *      devices running firmwares capable of generating the (re) association
3481  *      RSN IE. It allows for faster roaming between WPA2 BSSIDs.
3482  * @del_pmksa: Delete a cached PMKID.
3483  * @flush_pmksa: Flush all cached PMKIDs.
3484  * @set_power_mgmt: Configure WLAN power management. A timeout value of -1
3485  *      allows the driver to adjust the dynamic ps timeout value.
3486  * @set_cqm_rssi_config: Configure connection quality monitor RSSI threshold.
3487  *      After configuration, the driver should (soon) send an event indicating
3488  *      the current level is above/below the configured threshold; this may
3489  *      need some care when the configuration is changed (without first being
3490  *      disabled.)
3491  * @set_cqm_rssi_range_config: Configure two RSSI thresholds in the
3492  *      connection quality monitor.  An event is to be sent only when the
3493  *      signal level is found to be outside the two values.  The driver should
3494  *      set %NL80211_EXT_FEATURE_CQM_RSSI_LIST if this method is implemented.
3495  *      If it is provided then there's no point providing @set_cqm_rssi_config.
3496  * @set_cqm_txe_config: Configure connection quality monitor TX error
3497  *      thresholds.
3498  * @sched_scan_start: Tell the driver to start a scheduled scan.
3499  * @sched_scan_stop: Tell the driver to stop an ongoing scheduled scan with
3500  *      given request id. This call must stop the scheduled scan and be ready
3501  *      for starting a new one before it returns, i.e. @sched_scan_start may be
3502  *      called immediately after that again and should not fail in that case.
3503  *      The driver should not call cfg80211_sched_scan_stopped() for a requested
3504  *      stop (when this method returns 0).
3505  *
3506  * @mgmt_frame_register: Notify driver that a management frame type was
3507  *      registered. The callback is allowed to sleep.
3508  *
3509  * @set_antenna: Set antenna configuration (tx_ant, rx_ant) on the device.
3510  *      Parameters are bitmaps of allowed antennas to use for TX/RX. Drivers may
3511  *      reject TX/RX mask combinations they cannot support by returning -EINVAL
3512  *      (also see nl80211.h @NL80211_ATTR_WIPHY_ANTENNA_TX).
3513  *
3514  * @get_antenna: Get current antenna configuration from device (tx_ant, rx_ant).
3515  *
3516  * @tdls_mgmt: Transmit a TDLS management frame.
3517  * @tdls_oper: Perform a high-level TDLS operation (e.g. TDLS link setup).
3518  *
3519  * @probe_client: probe an associated client, must return a cookie that it
3520  *      later passes to cfg80211_probe_status().
3521  *
3522  * @set_noack_map: Set the NoAck Map for the TIDs.
3523  *
3524  * @get_channel: Get the current operating channel for the virtual interface.
3525  *      For monitor interfaces, it should return %NULL unless there's a single
3526  *      current monitoring channel.
3527  *
3528  * @start_p2p_device: Start the given P2P device.
3529  * @stop_p2p_device: Stop the given P2P device.
3530  *
3531  * @set_mac_acl: Sets MAC address control list in AP and P2P GO mode.
3532  *      Parameters include ACL policy, an array of MAC address of stations
3533  *      and the number of MAC addresses. If there is already a list in driver
3534  *      this new list replaces the existing one. Driver has to clear its ACL
3535  *      when number of MAC addresses entries is passed as 0. Drivers which
3536  *      advertise the support for MAC based ACL have to implement this callback.
3537  *
3538  * @start_radar_detection: Start radar detection in the driver.
3539  *
3540  * @end_cac: End running CAC, probably because a related CAC
3541  *      was finished on another phy.
3542  *
3543  * @update_ft_ies: Provide updated Fast BSS Transition information to the
3544  *      driver. If the SME is in the driver/firmware, this information can be
3545  *      used in building Authentication and Reassociation Request frames.
3546  *
3547  * @crit_proto_start: Indicates a critical protocol needs more link reliability
3548  *      for a given duration (milliseconds). The protocol is provided so the
3549  *      driver can take the most appropriate actions.
3550  * @crit_proto_stop: Indicates critical protocol no longer needs increased link
3551  *      reliability. This operation can not fail.
3552  * @set_coalesce: Set coalesce parameters.
3553  *
3554  * @channel_switch: initiate channel-switch procedure (with CSA). Driver is
3555  *      responsible for veryfing if the switch is possible. Since this is
3556  *      inherently tricky driver may decide to disconnect an interface later
3557  *      with cfg80211_stop_iface(). This doesn't mean driver can accept
3558  *      everything. It should do it's best to verify requests and reject them
3559  *      as soon as possible.
3560  *
3561  * @set_qos_map: Set QoS mapping information to the driver
3562  *
3563  * @set_ap_chanwidth: Set the AP (including P2P GO) mode channel width for the
3564  *      given interface This is used e.g. for dynamic HT 20/40 MHz channel width
3565  *      changes during the lifetime of the BSS.
3566  *
3567  * @add_tx_ts: validate (if admitted_time is 0) or add a TX TS to the device
3568  *      with the given parameters; action frame exchange has been handled by
3569  *      userspace so this just has to modify the TX path to take the TS into
3570  *      account.
3571  *      If the admitted time is 0 just validate the parameters to make sure
3572  *      the session can be created at all; it is valid to just always return
3573  *      success for that but that may result in inefficient behaviour (handshake
3574  *      with the peer followed by immediate teardown when the addition is later
3575  *      rejected)
3576  * @del_tx_ts: remove an existing TX TS
3577  *
3578  * @join_ocb: join the OCB network with the specified parameters
3579  *      (invoked with the wireless_dev mutex held)
3580  * @leave_ocb: leave the current OCB network
3581  *      (invoked with the wireless_dev mutex held)
3582  *
3583  * @tdls_channel_switch: Start channel-switching with a TDLS peer. The driver
3584  *      is responsible for continually initiating channel-switching operations
3585  *      and returning to the base channel for communication with the AP.
3586  * @tdls_cancel_channel_switch: Stop channel-switching with a TDLS peer. Both
3587  *      peers must be on the base channel when the call completes.
3588  * @start_nan: Start the NAN interface.
3589  * @stop_nan: Stop the NAN interface.
3590  * @add_nan_func: Add a NAN function. Returns negative value on failure.
3591  *      On success @nan_func ownership is transferred to the driver and
3592  *      it may access it outside of the scope of this function. The driver
3593  *      should free the @nan_func when no longer needed by calling
3594  *      cfg80211_free_nan_func().
3595  *      On success the driver should assign an instance_id in the
3596  *      provided @nan_func.
3597  * @del_nan_func: Delete a NAN function.
3598  * @nan_change_conf: changes NAN configuration. The changed parameters must
3599  *      be specified in @changes (using &enum cfg80211_nan_conf_changes);
3600  *      All other parameters must be ignored.
3601  *
3602  * @set_multicast_to_unicast: configure multicast to unicast conversion for BSS
3603  *
3604  * @get_txq_stats: Get TXQ stats for interface or phy. If wdev is %NULL, this
3605  *      function should return phy stats, and interface stats otherwise.
3606  *
3607  * @set_pmk: configure the PMK to be used for offloaded 802.1X 4-Way handshake.
3608  *      If not deleted through @del_pmk the PMK remains valid until disconnect
3609  *      upon which the driver should clear it.
3610  *      (invoked with the wireless_dev mutex held)
3611  * @del_pmk: delete the previously configured PMK for the given authenticator.
3612  *      (invoked with the wireless_dev mutex held)
3613  *
3614  * @external_auth: indicates result of offloaded authentication processing from
3615  *     user space
3616  *
3617  * @tx_control_port: TX a control port frame (EAPoL).  The noencrypt parameter
3618  *      tells the driver that the frame should not be encrypted.
3619  *
3620  * @get_ftm_responder_stats: Retrieve FTM responder statistics, if available.
3621  *      Statistics should be cumulative, currently no way to reset is provided.
3622  * @start_pmsr: start peer measurement (e.g. FTM)
3623  * @abort_pmsr: abort peer measurement
3624  *
3625  * @update_owe_info: Provide updated OWE info to driver. Driver implementing SME
3626  *      but offloading OWE processing to the user space will get the updated
3627  *      DH IE through this interface.
3628  *
3629  * @probe_mesh_link: Probe direct Mesh peer's link quality by sending data frame
3630  *      and overrule HWMP path selection algorithm.
3631  */
3632 struct cfg80211_ops {
3633         int     (*suspend)(struct wiphy *wiphy, struct cfg80211_wowlan *wow);
3634         int     (*resume)(struct wiphy *wiphy);
3635         void    (*set_wakeup)(struct wiphy *wiphy, bool enabled);
3636 
3637         struct wireless_dev * (*add_virtual_intf)(struct wiphy *wiphy,
3638                                                   const char *name,
3639                                                   unsigned char name_assign_type,
3640                                                   enum nl80211_iftype type,
3641                                                   struct vif_params *params);
3642         int     (*del_virtual_intf)(struct wiphy *wiphy,
3643                                     struct wireless_dev *wdev);
3644         int     (*change_virtual_intf)(struct wiphy *wiphy,
3645                                        struct net_device *dev,
3646                                        enum nl80211_iftype type,
3647                                        struct vif_params *params);
3648 
3649         int     (*add_key)(struct wiphy *wiphy, struct net_device *netdev,
3650                            u8 key_index, bool pairwise, const u8 *mac_addr,
3651                            struct key_params *params);
3652         int     (*get_key)(struct wiphy *wiphy, struct net_device *netdev,
3653                            u8 key_index, bool pairwise, const u8 *mac_addr,
3654                            void *cookie,
3655                            void (*callback)(void *cookie, struct key_params*));
3656         int     (*del_key)(struct wiphy *wiphy, struct net_device *netdev,
3657                            u8 key_index, bool pairwise, const u8 *mac_addr);
3658         int     (*set_default_key)(struct wiphy *wiphy,
3659                                    struct net_device *netdev,
3660                                    u8 key_index, bool unicast, bool multicast);
3661         int     (*set_default_mgmt_key)(struct wiphy *wiphy,
3662                                         struct net_device *netdev,
3663                                         u8 key_index);
3664 
3665         int     (*start_ap)(struct wiphy *wiphy, struct net_device *dev,
3666                             struct cfg80211_ap_settings *settings);
3667         int     (*change_beacon)(struct wiphy *wiphy, struct net_device *dev,
3668                                  struct cfg80211_beacon_data *info);
3669         int     (*stop_ap)(struct wiphy *wiphy, struct net_device *dev);
3670 
3671 
3672         int     (*add_station)(struct wiphy *wiphy, struct net_device *dev,
3673                                const u8 *mac,
3674                                struct station_parameters *params);
3675         int     (*del_station)(struct wiphy *wiphy, struct net_device *dev,
3676                                struct station_del_parameters *params);
3677         int     (*change_station)(struct wiphy *wiphy, struct net_device *dev,
3678                                   const u8 *mac,
3679                                   struct station_parameters *params);
3680         int     (*get_station)(struct wiphy *wiphy, struct net_device *dev,
3681                                const u8 *mac, struct station_info *sinfo);
3682         int     (*dump_station)(struct wiphy *wiphy, struct net_device *dev,
3683                                 int idx, u8 *mac, struct station_info *sinfo);
3684 
3685         int     (*add_mpath)(struct wiphy *wiphy, struct net_device *dev,
3686                                const u8 *dst, const u8 *next_hop);
3687         int     (*del_mpath)(struct wiphy *wiphy, struct net_device *dev,
3688                                const u8 *dst);
3689         int     (*change_mpath)(struct wiphy *wiphy, struct net_device *dev,
3690                                   const u8 *dst, const u8 *next_hop);
3691         int     (*get_mpath)(struct wiphy *wiphy, struct net_device *dev,
3692                              u8 *dst, u8 *next_hop, struct mpath_info *pinfo);
3693         int     (*dump_mpath)(struct wiphy *wiphy, struct net_device *dev,
3694                               int idx, u8 *dst, u8 *next_hop,
3695                               struct mpath_info *pinfo);
3696         int     (*get_mpp)(struct wiphy *wiphy, struct net_device *dev,
3697                            u8 *dst, u8 *mpp, struct mpath_info *pinfo);
3698         int     (*dump_mpp)(struct wiphy *wiphy, struct net_device *dev,
3699                             int idx, u8 *dst, u8 *mpp,
3700                             struct mpath_info *pinfo);
3701         int     (*get_mesh_config)(struct wiphy *wiphy,
3702                                 struct net_device *dev,
3703                                 struct mesh_config *conf);
3704         int     (*update_mesh_config)(struct wiphy *wiphy,
3705                                       struct net_device *dev, u32 mask,
3706                                       const struct mesh_config *nconf);
3707         int     (*join_mesh)(struct wiphy *wiphy, struct net_device *dev,
3708                              const struct mesh_config *conf,
3709                              const struct mesh_setup *setup);
3710         int     (*leave_mesh)(struct wiphy *wiphy, struct net_device *dev);
3711 
3712         int     (*join_ocb)(struct wiphy *wiphy, struct net_device *dev,
3713                             struct ocb_setup *setup);
3714         int     (*leave_ocb)(struct wiphy *wiphy, struct net_device *dev);
3715 
3716         int     (*change_bss)(struct wiphy *wiphy, struct net_device *dev,
3717                               struct bss_parameters *params);
3718 
3719         int     (*set_txq_params)(struct wiphy *wiphy, struct net_device *dev,
3720                                   struct ieee80211_txq_params *params);
3721 
3722         int     (*libertas_set_mesh_channel)(struct wiphy *wiphy,
3723                                              struct net_device *dev,
3724                                              struct ieee80211_channel *chan);
3725 
3726         int     (*set_monitor_channel)(struct wiphy *wiphy,
3727                                        struct cfg80211_chan_def *chandef);
3728 
3729         int     (*scan)(struct wiphy *wiphy,
3730                         struct cfg80211_scan_request *request);
3731         void    (*abort_scan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3732 
3733         int     (*auth)(struct wiphy *wiphy, struct net_device *dev,
3734                         struct cfg80211_auth_request *req);
3735         int     (*assoc)(struct wiphy *wiphy, struct net_device *dev,
3736                          struct cfg80211_assoc_request *req);
3737         int     (*deauth)(struct wiphy *wiphy, struct net_device *dev,
3738                           struct cfg80211_deauth_request *req);
3739         int     (*disassoc)(struct wiphy *wiphy, struct net_device *dev,
3740                             struct cfg80211_disassoc_request *req);
3741 
3742         int     (*connect)(struct wiphy *wiphy, struct net_device *dev,
3743                            struct cfg80211_connect_params *sme);
3744         int     (*update_connect_params)(struct wiphy *wiphy,
3745                                          struct net_device *dev,
3746                                          struct cfg80211_connect_params *sme,
3747                                          u32 changed);
3748         int     (*disconnect)(struct wiphy *wiphy, struct net_device *dev,
3749                               u16 reason_code);
3750 
3751         int     (*join_ibss)(struct wiphy *wiphy, struct net_device *dev,
3752                              struct cfg80211_ibss_params *params);
3753         int     (*leave_ibss)(struct wiphy *wiphy, struct net_device *dev);
3754 
3755         int     (*set_mcast_rate)(struct wiphy *wiphy, struct net_device *dev,
3756                                   int rate[NUM_NL80211_BANDS]);
3757 
3758         int     (*set_wiphy_params)(struct wiphy *wiphy, u32 changed);
3759 
3760         int     (*set_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3761                                 enum nl80211_tx_power_setting type, int mbm);
3762         int     (*get_tx_power)(struct wiphy *wiphy, struct wireless_dev *wdev,
3763                                 int *dbm);
3764 
3765         int     (*set_wds_peer)(struct wiphy *wiphy, struct net_device *dev,
3766                                 const u8 *addr);
3767 
3768         void    (*rfkill_poll)(struct wiphy *wiphy);
3769 
3770 #ifdef CONFIG_NL80211_TESTMODE
3771         int     (*testmode_cmd)(struct wiphy *wiphy, struct wireless_dev *wdev,
3772                                 void *data, int len);
3773         int     (*testmode_dump)(struct wiphy *wiphy, struct sk_buff *skb,
3774                                  struct netlink_callback *cb,
3775                                  void *data, int len);
3776 #endif
3777 
3778         int     (*set_bitrate_mask)(struct wiphy *wiphy,
3779                                     struct net_device *dev,
3780                                     const u8 *peer,
3781                                     const struct cfg80211_bitrate_mask *mask);
3782 
3783         int     (*dump_survey)(struct wiphy *wiphy, struct net_device *netdev,
3784                         int idx, struct survey_info *info);
3785 
3786         int     (*set_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3787                              struct cfg80211_pmksa *pmksa);
3788         int     (*del_pmksa)(struct wiphy *wiphy, struct net_device *netdev,
3789                              struct cfg80211_pmksa *pmksa);
3790         int     (*flush_pmksa)(struct wiphy *wiphy, struct net_device *netdev);
3791 
3792         int     (*remain_on_channel)(struct wiphy *wiphy,
3793                                      struct wireless_dev *wdev,
3794                                      struct ieee80211_channel *chan,
3795                                      unsigned int duration,
3796                                      u64 *cookie);
3797         int     (*cancel_remain_on_channel)(struct wiphy *wiphy,
3798                                             struct wireless_dev *wdev,
3799                                             u64 cookie);
3800 
3801         int     (*mgmt_tx)(struct wiphy *wiphy, struct wireless_dev *wdev,
3802                            struct cfg80211_mgmt_tx_params *params,
3803                            u64 *cookie);
3804         int     (*mgmt_tx_cancel_wait)(struct wiphy *wiphy,
3805                                        struct wireless_dev *wdev,
3806                                        u64 cookie);
3807 
3808         int     (*set_power_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3809                                   bool enabled, int timeout);
3810 
3811         int     (*set_cqm_rssi_config)(struct wiphy *wiphy,
3812                                        struct net_device *dev,
3813                                        s32 rssi_thold, u32 rssi_hyst);
3814 
3815         int     (*set_cqm_rssi_range_config)(struct wiphy *wiphy,
3816                                              struct net_device *dev,
3817                                              s32 rssi_low, s32 rssi_high);
3818 
3819         int     (*set_cqm_txe_config)(struct wiphy *wiphy,
3820                                       struct net_device *dev,
3821                                       u32 rate, u32 pkts, u32 intvl);
3822 
3823         void    (*mgmt_frame_register)(struct wiphy *wiphy,
3824                                        struct wireless_dev *wdev,
3825                                        u16 frame_type, bool reg);
3826 
3827         int     (*set_antenna)(struct wiphy *wiphy, u32 tx_ant, u32 rx_ant);
3828         int     (*get_antenna)(struct wiphy *wiphy, u32 *tx_ant, u32 *rx_ant);
3829 
3830         int     (*sched_scan_start)(struct wiphy *wiphy,
3831                                 struct net_device *dev,
3832                                 struct cfg80211_sched_scan_request *request);
3833         int     (*sched_scan_stop)(struct wiphy *wiphy, struct net_device *dev,
3834                                    u64 reqid);
3835 
3836         int     (*set_rekey_data)(struct wiphy *wiphy, struct net_device *dev,
3837                                   struct cfg80211_gtk_rekey_data *data);
3838 
3839         int     (*tdls_mgmt)(struct wiphy *wiphy, struct net_device *dev,
3840                              const u8 *peer, u8 action_code,  u8 dialog_token,
3841                              u16 status_code, u32 peer_capability,
3842                              bool initiator, const u8 *buf, size_t len);
3843         int     (*tdls_oper)(struct wiphy *wiphy, struct net_device *dev,
3844                              const u8 *peer, enum nl80211_tdls_operation oper);
3845 
3846         int     (*probe_client)(struct wiphy *wiphy, struct net_device *dev,
3847                                 const u8 *peer, u64 *cookie);
3848 
3849         int     (*set_noack_map)(struct wiphy *wiphy,
3850                                   struct net_device *dev,
3851                                   u16 noack_map);
3852 
3853         int     (*get_channel)(struct wiphy *wiphy,
3854                                struct wireless_dev *wdev,
3855                                struct cfg80211_chan_def *chandef);
3856 
3857         int     (*start_p2p_device)(struct wiphy *wiphy,
3858                                     struct wireless_dev *wdev);
3859         void    (*stop_p2p_device)(struct wiphy *wiphy,
3860                                    struct wireless_dev *wdev);
3861 
3862         int     (*set_mac_acl)(struct wiphy *wiphy, struct net_device *dev,
3863                                const struct cfg80211_acl_data *params);
3864 
3865         int     (*start_radar_detection)(struct wiphy *wiphy,
3866                                          struct net_device *dev,
3867                                          struct cfg80211_chan_def *chandef,
3868                                          u32 cac_time_ms);
3869         void    (*end_cac)(struct wiphy *wiphy,
3870                                 struct net_device *dev);
3871         int     (*update_ft_ies)(struct wiphy *wiphy, struct net_device *dev,
3872                                  struct cfg80211_update_ft_ies_params *ftie);
3873         int     (*crit_proto_start)(struct wiphy *wiphy,
3874                                     struct wireless_dev *wdev,
3875                                     enum nl80211_crit_proto_id protocol,
3876                                     u16 duration);
3877         void    (*crit_proto_stop)(struct wiphy *wiphy,
3878                                    struct wireless_dev *wdev);
3879         int     (*set_coalesce)(struct wiphy *wiphy,
3880                                 struct cfg80211_coalesce *coalesce);
3881 
3882         int     (*channel_switch)(struct wiphy *wiphy,
3883                                   struct net_device *dev,
3884                                   struct cfg80211_csa_settings *params);
3885 
3886         int     (*set_qos_map)(struct wiphy *wiphy,
3887                                struct net_device *dev,
3888                                struct cfg80211_qos_map *qos_map);
3889 
3890         int     (*set_ap_chanwidth)(struct wiphy *wiphy, struct net_device *dev,
3891                                     struct cfg80211_chan_def *chandef);
3892 
3893         int     (*add_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3894                              u8 tsid, const u8 *peer, u8 user_prio,
3895                              u16 admitted_time);
3896         int     (*del_tx_ts)(struct wiphy *wiphy, struct net_device *dev,
3897                              u8 tsid, const u8 *peer);
3898 
3899         int     (*tdls_channel_switch)(struct wiphy *wiphy,
3900                                        struct net_device *dev,
3901                                        const u8 *addr, u8 oper_class,
3902                                        struct cfg80211_chan_def *chandef);
3903         void    (*tdls_cancel_channel_switch)(struct wiphy *wiphy,
3904                                               struct net_device *dev,
3905                                               const u8 *addr);
3906         int     (*start_nan)(struct wiphy *wiphy, struct wireless_dev *wdev,
3907                              struct cfg80211_nan_conf *conf);
3908         void    (*stop_nan)(struct wiphy *wiphy, struct wireless_dev *wdev);
3909         int     (*add_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3910                                 struct cfg80211_nan_func *nan_func);
3911         void    (*del_nan_func)(struct wiphy *wiphy, struct wireless_dev *wdev,
3912                                u64 cookie);
3913         int     (*nan_change_conf)(struct wiphy *wiphy,
3914                                    struct wireless_dev *wdev,
3915                                    struct cfg80211_nan_conf *conf,
3916                                    u32 changes);
3917 
3918         int     (*set_multicast_to_unicast)(struct wiphy *wiphy,
3919                                             struct net_device *dev,
3920                                             const bool enabled);
3921 
3922         int     (*get_txq_stats)(struct wiphy *wiphy,
3923                                  struct wireless_dev *wdev,
3924                                  struct cfg80211_txq_stats *txqstats);
3925 
3926         int     (*set_pmk)(struct wiphy *wiphy, struct net_device *dev,
3927                            const struct cfg80211_pmk_conf *conf);
3928         int     (*del_pmk)(struct wiphy *wiphy, struct net_device *dev,
3929                            const u8 *aa);
3930         int     (*external_auth)(struct wiphy *wiphy, struct net_device *dev,
3931                                  struct cfg80211_external_auth_params *params);
3932 
3933         int     (*tx_control_port)(struct wiphy *wiphy,
3934                                    struct net_device *dev,
3935                                    const u8 *buf, size_t len,
3936                                    const u8 *dest, const __be16 proto,
3937                                    const bool noencrypt);
3938 
3939         int     (*get_ftm_responder_stats)(struct wiphy *wiphy,
3940                                 struct net_device *dev,
3941                                 struct cfg80211_ftm_responder_stats *ftm_stats);
3942 
3943         int     (*start_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
3944                               struct cfg80211_pmsr_request *request);
3945         void    (*abort_pmsr)(struct wiphy *wiphy, struct wireless_dev *wdev,
3946                               struct cfg80211_pmsr_request *request);
3947         int     (*update_owe_info)(struct wiphy *wiphy, struct net_device *dev,
3948                                    struct cfg80211_update_owe_info *owe_info);
3949         int     (*probe_mesh_link)(struct wiphy *wiphy, struct net_device *dev,
3950                                    const u8 *buf, size_t len);
3951 };
3952 
3953 /*
3954  * wireless hardware and networking interfaces structures
3955  * and registration/helper functions
3956  */
3957 
3958 /**
3959  * enum wiphy_flags - wiphy capability flags
3960  *
3961  * @WIPHY_FLAG_NETNS_OK: if not set, do not allow changing the netns of this
3962  *      wiphy at all
3963  * @WIPHY_FLAG_PS_ON_BY_DEFAULT: if set to true, powersave will be enabled
3964  *      by default -- this flag will be set depending on the kernel's default
3965  *      on wiphy_new(), but can be changed by the driver if it has a good
3966  *      reason to override the default
3967  * @WIPHY_FLAG_4ADDR_AP: supports 4addr mode even on AP (with a single station
3968  *      on a VLAN interface). This flag also serves an extra purpose of
3969  *      supporting 4ADDR AP mode on devices which do not support AP/VLAN iftype.
3970  * @WIPHY_FLAG_4ADDR_STATION: supports 4addr mode even as a station
3971  * @WIPHY_FLAG_CONTROL_PORT_PROTOCOL: This device supports setting the
3972  *      control port protocol ethertype. The device also honours the
3973  *      control_port_no_encrypt flag.
3974  * @WIPHY_FLAG_IBSS_RSN: The device supports IBSS RSN.
3975  * @WIPHY_FLAG_MESH_AUTH: The device supports mesh authentication by routing
3976  *      auth frames to userspace. See @NL80211_MESH_SETUP_USERSPACE_AUTH.
3977  * @WIPHY_FLAG_SUPPORTS_FW_ROAM: The device supports roaming feature in the
3978  *      firmware.
3979  * @WIPHY_FLAG_AP_UAPSD: The device supports uapsd on AP.
3980  * @WIPHY_FLAG_SUPPORTS_TDLS: The device supports TDLS (802.11z) operation.
3981  * @WIPHY_FLAG_TDLS_EXTERNAL_SETUP: The device does not handle TDLS (802.11z)
3982  *      link setup/discovery operations internally. Setup, discovery and
3983  *      teardown packets should be sent through the @NL80211_CMD_TDLS_MGMT
3984  *      command. When this flag is not set, @NL80211_CMD_TDLS_OPER should be
3985  *      used for asking the driver/firmware to perform a TDLS operation.
3986  * @WIPHY_FLAG_HAVE_AP_SME: device integrates AP SME
3987  * @WIPHY_FLAG_REPORTS_OBSS: the device will report beacons from other BSSes
3988  *      when there are virtual interfaces in AP mode by calling
3989  *      cfg80211_report_obss_beacon().
3990  * @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD: When operating as an AP, the device
3991  *      responds to probe-requests in hardware.
3992  * @WIPHY_FLAG_OFFCHAN_TX: Device supports direct off-channel TX.
3993  * @WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL: Device supports remain-on-channel call.
3994  * @WIPHY_FLAG_SUPPORTS_5_10_MHZ: Device supports 5 MHz and 10 MHz channels.
3995  * @WIPHY_FLAG_HAS_CHANNEL_SWITCH: Device supports channel switch in
3996  *      beaconing mode (AP, IBSS, Mesh, ...).
3997  * @WIPHY_FLAG_HAS_STATIC_WEP: The device supports static WEP key installation
3998  *      before connection.
3999  */
4000 enum wiphy_flags {
4001         /* use hole at 0 */
4002         /* use hole at 1 */
4003         /* use hole at 2 */
4004         WIPHY_FLAG_NETNS_OK                     = BIT(3),
4005         WIPHY_FLAG_PS_ON_BY_DEFAULT             = BIT(4),
4006         WIPHY_FLAG_4ADDR_AP                     = BIT(5),
4007         WIPHY_FLAG_4ADDR_STATION                = BIT(6),
4008         WIPHY_FLAG_CONTROL_PORT_PROTOCOL        = BIT(7),
4009         WIPHY_FLAG_IBSS_RSN                     = BIT(8),
4010         WIPHY_FLAG_MESH_AUTH                    = BIT(10),
4011         /* use hole at 11 */
4012         /* use hole at 12 */
4013         WIPHY_FLAG_SUPPORTS_FW_ROAM             = BIT(13),
4014         WIPHY_FLAG_AP_UAPSD                     = BIT(14),
4015         WIPHY_FLAG_SUPPORTS_TDLS                = BIT(15),
4016         WIPHY_FLAG_TDLS_EXTERNAL_SETUP          = BIT(16),
4017         WIPHY_FLAG_HAVE_AP_SME                  = BIT(17),
4018         WIPHY_FLAG_REPORTS_OBSS                 = BIT(18),
4019         WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD        = BIT(19),
4020         WIPHY_FLAG_OFFCHAN_TX                   = BIT(20),
4021         WIPHY_FLAG_HAS_REMAIN_ON_CHANNEL        = BIT(21),
4022         WIPHY_FLAG_SUPPORTS_5_10_MHZ            = BIT(22),
4023         WIPHY_FLAG_HAS_CHANNEL_SWITCH           = BIT(23),
4024         WIPHY_FLAG_HAS_STATIC_WEP               = BIT(24),
4025 };
4026 
4027 /**
4028  * struct ieee80211_iface_limit - limit on certain interface types
4029  * @max: maximum number of interfaces of these types
4030  * @types: interface types (bits)
4031  */
4032 struct ieee80211_iface_limit {
4033         u16 max;
4034         u16 types;
4035 };
4036 
4037 /**
4038  * struct ieee80211_iface_combination - possible interface combination
4039  *
4040  * With this structure the driver can describe which interface
4041  * combinations it supports concurrently.
4042  *
4043  * Examples:
4044  *
4045  * 1. Allow #STA <= 1, #AP <= 1, matching BI, channels = 1, 2 total:
4046  *
4047  *    .. code-block:: c
4048  *
4049  *      struct ieee80211_iface_limit limits1[] = {
4050  *              { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4051  *              { .max = 1, .types = BIT(NL80211_IFTYPE_AP}, },
4052  *      };
4053  *      struct ieee80211_iface_combination combination1 = {
4054  *              .limits = limits1,
4055  *              .n_limits = ARRAY_SIZE(limits1),
4056  *              .max_interfaces = 2,
4057  *              .beacon_int_infra_match = true,
4058  *      };
4059  *
4060  *
4061  * 2. Allow #{AP, P2P-GO} <= 8, channels = 1, 8 total:
4062  *
4063  *    .. code-block:: c
4064  *
4065  *      struct ieee80211_iface_limit limits2[] = {
4066  *              { .max = 8, .types = BIT(NL80211_IFTYPE_AP) |
4067  *                                   BIT(NL80211_IFTYPE_P2P_GO), },
4068  *      };
4069  *      struct ieee80211_iface_combination combination2 = {
4070  *              .limits = limits2,
4071  *              .n_limits = ARRAY_SIZE(limits2),
4072  *              .max_interfaces = 8,
4073  *              .num_different_channels = 1,
4074  *      };
4075  *
4076  *
4077  * 3. Allow #STA <= 1, #{P2P-client,P2P-GO} <= 3 on two channels, 4 total.
4078  *
4079  *    This allows for an infrastructure connection and three P2P connections.
4080  *
4081  *    .. code-block:: c
4082  *
4083  *      struct ieee80211_iface_limit limits3[] = {
4084  *              { .max = 1, .types = BIT(NL80211_IFTYPE_STATION), },
4085  *              { .max = 3, .types = BIT(NL80211_IFTYPE_P2P_GO) |
4086  *                                   BIT(NL80211_IFTYPE_P2P_CLIENT), },
4087  *      };
4088  *      struct ieee80211_iface_combination combination3 = {
4089  *              .limits = limits3,
4090  *              .n_limits = ARRAY_SIZE(limits3),
4091  *              .max_interfaces = 4,
4092  *              .num_different_channels = 2,
4093  *      };
4094  *
4095  */
4096 struct ieee80211_iface_combination {
4097         /**
4098          * @limits:
4099          * limits for the given interface types
4100          */
4101         const struct ieee80211_iface_limit *limits;
4102 
4103         /**
4104          * @num_different_channels:
4105          * can use up to this many different channels
4106          */
4107         u32 num_different_channels;
4108 
4109         /**
4110          * @max_interfaces:
4111          * maximum number of interfaces in total allowed in this group
4112          */
4113         u16 max_interfaces;
4114 
4115         /**
4116          * @n_limits:
4117          * number of limitations
4118          */
4119         u8 n_limits;
4120 
4121         /**
4122          * @beacon_int_infra_match:
4123          * In this combination, the beacon intervals between infrastructure
4124          * and AP types must match. This is required only in special cases.
4125          */
4126         bool beacon_int_infra_match;
4127 
4128         /**
4129          * @radar_detect_widths:
4130          * bitmap of channel widths supported for radar detection
4131          */
4132         u8 radar_detect_widths;
4133 
4134         /**
4135          * @radar_detect_regions:
4136          * bitmap of regions supported for radar detection
4137          */
4138         u8 radar_detect_regions;
4139 
4140         /**
4141          * @beacon_int_min_gcd:
4142          * This interface combination supports different beacon intervals.
4143          *
4144          * = 0
4145          *   all beacon intervals for different interface must be same.
4146          * > 0
4147          *   any beacon interval for the interface part of this combination AND
4148          *   GCD of all beacon intervals from beaconing interfaces of this
4149          *   combination must be greater or equal to this value.
4150          */
4151         u32 beacon_int_min_gcd;
4152 };
4153 
4154 struct ieee80211_txrx_stypes {
4155         u16 tx, rx;
4156 };
4157 
4158 /**
4159  * enum wiphy_wowlan_support_flags - WoWLAN support flags
4160  * @WIPHY_WOWLAN_ANY: supports wakeup for the special "any"
4161  *      trigger that keeps the device operating as-is and
4162  *      wakes up the host on any activity, for example a
4163  *      received packet that passed filtering; note that the
4164  *      packet should be preserved in that case
4165  * @WIPHY_WOWLAN_MAGIC_PKT: supports wakeup on magic packet
4166  *      (see nl80211.h)
4167  * @WIPHY_WOWLAN_DISCONNECT: supports wakeup on disconnect
4168  * @WIPHY_WOWLAN_SUPPORTS_GTK_REKEY: supports GTK rekeying while asleep
4169  * @WIPHY_WOWLAN_GTK_REKEY_FAILURE: supports wakeup on GTK rekey failure
4170  * @WIPHY_WOWLAN_EAP_IDENTITY_REQ: supports wakeup on EAP identity request
4171  * @WIPHY_WOWLAN_4WAY_HANDSHAKE: supports wakeup on 4-way handshake failure
4172  * @WIPHY_WOWLAN_RFKILL_RELEASE: supports wakeup on RF-kill release
4173  * @WIPHY_WOWLAN_NET_DETECT: supports wakeup on network detection
4174  */
4175 enum wiphy_wowlan_support_flags {
4176         WIPHY_WOWLAN_ANY                = BIT(0),
4177         WIPHY_WOWLAN_MAGIC_PKT          = BIT(1),
4178         WIPHY_WOWLAN_DISCONNECT         = BIT(2),
4179         WIPHY_WOWLAN_SUPPORTS_GTK_REKEY = BIT(3),
4180         WIPHY_WOWLAN_GTK_REKEY_FAILURE  = BIT(4),
4181         WIPHY_WOWLAN_EAP_IDENTITY_REQ   = BIT(5),
4182         WIPHY_WOWLAN_4WAY_HANDSHAKE     = BIT(6),
4183         WIPHY_WOWLAN_RFKILL_RELEASE     = BIT(7),
4184         WIPHY_WOWLAN_NET_DETECT         = BIT(8),
4185 };
4186 
4187 struct wiphy_wowlan_tcp_support {
4188         const struct nl80211_wowlan_tcp_data_token_feature *tok;
4189         u32 data_payload_max;
4190         u32 data_interval_max;
4191         u32 wake_payload_max;
4192         bool seq;
4193 };
4194 
4195 /**
4196  * struct wiphy_wowlan_support - WoWLAN support data
4197  * @flags: see &enum wiphy_wowlan_support_flags
4198  * @n_patterns: number of supported wakeup patterns
4199  *      (see nl80211.h for the pattern definition)
4200  * @pattern_max_len: maximum length of each pattern
4201  * @pattern_min_len: minimum length of each pattern
4202  * @max_pkt_offset: maximum Rx packet offset
4203  * @max_nd_match_sets: maximum number of matchsets for net-detect,
4204  *      similar, but not necessarily identical, to max_match_sets for
4205  *      scheduled scans.
4206  *      See &struct cfg80211_sched_scan_request.@match_sets for more
4207  *      details.
4208  * @tcp: TCP wakeup support information
4209  */
4210 struct wiphy_wowlan_support {
4211         u32 flags;
4212         int n_patterns;
4213         int pattern_max_len;
4214         int pattern_min_len;
4215         int max_pkt_offset;
4216         int max_nd_match_sets;
4217         const struct wiphy_wowlan_tcp_support *tcp;
4218 };
4219 
4220 /**
4221  * struct wiphy_coalesce_support - coalesce support data
4222  * @n_rules: maximum number of coalesce rules
4223  * @max_delay: maximum supported coalescing delay in msecs
4224  * @n_patterns: number of supported patterns in a rule
4225  *      (see nl80211.h for the pattern definition)
4226  * @pattern_max_len: maximum length of each pattern
4227  * @pattern_min_len: minimum length of each pattern
4228  * @max_pkt_offset: maximum Rx packet offset
4229  */
4230 struct wiphy_coalesce_support {
4231         int n_rules;
4232         int max_delay;
4233         int n_patterns;
4234         int pattern_max_len;
4235         int pattern_min_len;
4236         int max_pkt_offset;
4237 };
4238 
4239 /**
4240  * enum wiphy_vendor_command_flags - validation flags for vendor commands
4241  * @WIPHY_VENDOR_CMD_NEED_WDEV: vendor command requires wdev
4242  * @WIPHY_VENDOR_CMD_NEED_NETDEV: vendor command requires netdev
4243  * @WIPHY_VENDOR_CMD_NEED_RUNNING: interface/wdev must be up & running
4244  *      (must be combined with %_WDEV or %_NETDEV)
4245  */
4246 enum wiphy_vendor_command_flags {
4247         WIPHY_VENDOR_CMD_NEED_WDEV = BIT(0),
4248         WIPHY_VENDOR_CMD_NEED_NETDEV = BIT(1),
4249         WIPHY_VENDOR_CMD_NEED_RUNNING = BIT(2),
4250 };
4251 
4252 /**
4253  * enum wiphy_opmode_flag - Station's ht/vht operation mode information flags
4254  *
4255  * @STA_OPMODE_MAX_BW_CHANGED: Max Bandwidth changed
4256  * @STA_OPMODE_SMPS_MODE_CHANGED: SMPS mode changed
4257  * @STA_OPMODE_N_SS_CHANGED: max N_SS (number of spatial streams) changed
4258  *
4259  */
4260 enum wiphy_opmode_flag {
4261         STA_OPMODE_MAX_BW_CHANGED       = BIT(0),
4262         STA_OPMODE_SMPS_MODE_CHANGED    = BIT(1),
4263         STA_OPMODE_N_SS_CHANGED         = BIT(2),
4264 };
4265 
4266 /**
4267  * struct sta_opmode_info - Station's ht/vht operation mode information
4268  * @changed: contains value from &enum wiphy_opmode_flag
4269  * @smps_mode: New SMPS mode value from &enum nl80211_smps_mode of a station
4270  * @bw: new max bandwidth value from &enum nl80211_chan_width of a station
4271  * @rx_nss: new rx_nss value of a station
4272  */
4273 
4274 struct sta_opmode_info {
4275         u32 changed;
4276         enum nl80211_smps_mode smps_mode;
4277         enum nl80211_chan_width bw;
4278         u8 rx_nss;
4279 };
4280 
4281 #define VENDOR_CMD_RAW_DATA ((const struct nla_policy *)(long)(-ENODATA))
4282 
4283 /**
4284  * struct wiphy_vendor_command - vendor command definition
4285  * @info: vendor command identifying information, as used in nl80211
4286  * @flags: flags, see &enum wiphy_vendor_command_flags
4287  * @doit: callback for the operation, note that wdev is %NULL if the
4288  *      flags didn't ask for a wdev and non-%NULL otherwise; the data
4289  *      pointer may be %NULL if userspace provided no data at all
4290  * @dumpit: dump callback, for transferring bigger/multiple items. The
4291  *      @storage points to cb->args[5], ie. is preserved over the multiple
4292  *      dumpit calls.
4293  * @policy: policy pointer for attributes within %NL80211_ATTR_VENDOR_DATA.
4294  *      Set this to %VENDOR_CMD_RAW_DATA if no policy can be given and the
4295  *      attribute is just raw data (e.g. a firmware command).
4296  * @maxattr: highest attribute number in policy
4297  * It's recommended to not have the same sub command with both @doit and
4298  * @dumpit, so that userspace can assume certain ones are get and others
4299  * are used with dump requests.
4300  */
4301 struct wiphy_vendor_command {
4302         struct nl80211_vendor_cmd_info info;
4303         u32 flags;
4304         int (*doit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4305                     const void *data, int data_len);
4306         int (*dumpit)(struct wiphy *wiphy, struct wireless_dev *wdev,
4307                       struct sk_buff *skb, const void *data, int data_len,
4308                       unsigned long *storage);
4309         const struct nla_policy *policy;
4310         unsigned int maxattr;
4311 };
4312 
4313 /**
4314  * struct wiphy_iftype_ext_capab - extended capabilities per interface type
4315  * @iftype: interface type
4316  * @extended_capabilities: extended capabilities supported by the driver,
4317  *      additional capabilities might be supported by userspace; these are the
4318  *      802.11 extended capabilities ("Extended Capabilities element") and are
4319  *      in the same format as in the information element. See IEEE Std
4320  *      802.11-2012 8.4.2.29 for the defined fields.
4321  * @extended_capabilities_mask: mask of the valid values
4322  * @extended_capabilities_len: length of the extended capabilities
4323  */
4324 struct wiphy_iftype_ext_capab {
4325         enum nl80211_iftype iftype;
4326         const u8 *extended_capabilities;
4327         const u8 *extended_capabilities_mask;
4328         u8 extended_capabilities_len;
4329 };
4330 
4331 /**
4332  * struct cfg80211_pmsr_capabilities - cfg80211 peer measurement capabilities
4333  * @max_peers: maximum number of peers in a single measurement
4334  * @report_ap_tsf: can report assoc AP's TSF for radio resource measurement
4335  * @randomize_mac_addr: can randomize MAC address for measurement
4336  * @ftm.supported: FTM measurement is supported
4337  * @ftm.asap: ASAP-mode is supported
4338  * @ftm.non_asap: non-ASAP-mode is supported
4339  * @ftm.request_lci: can request LCI data
4340  * @ftm.request_civicloc: can request civic location data
4341  * @ftm.preambles: bitmap of preambles supported (&enum nl80211_preamble)
4342  * @ftm.bandwidths: bitmap of bandwidths supported (&enum nl80211_chan_width)
4343  * @ftm.max_bursts_exponent: maximum burst exponent supported
4344  *      (set to -1 if not limited; note that setting this will necessarily
4345  *      forbid using the value 15 to let the responder pick)
4346  * @ftm.max_ftms_per_burst: maximum FTMs per burst supported (set to 0 if
4347  *      not limited)
4348  */
4349 struct cfg80211_pmsr_capabilities {
4350         unsigned int max_peers;
4351         u8 report_ap_tsf:1,
4352            randomize_mac_addr:1;
4353 
4354         struct {
4355                 u32 preambles;
4356                 u32 bandwidths;
4357                 s8 max_bursts_exponent;
4358                 u8 max_ftms_per_burst;
4359                 u8 supported:1,
4360                    asap:1,
4361                    non_asap:1,
4362                    request_lci:1,
4363                    request_civicloc:1;
4364         } ftm;
4365 };
4366 
4367 /**
4368  * struct wiphy - wireless hardware description
4369  * @reg_notifier: the driver's regulatory notification callback,
4370  *      note that if your driver uses wiphy_apply_custom_regulatory()
4371  *      the reg_notifier's request can be passed as NULL
4372  * @regd: the driver's regulatory domain, if one was requested via
4373  *      the regulatory_hint() API. This can be used by the driver
4374  *      on the reg_notifier() if it chooses to ignore future
4375  *      regulatory domain changes caused by other drivers.
4376  * @signal_type: signal type reported in &struct cfg80211_bss.
4377  * @cipher_suites: supported cipher suites
4378  * @n_cipher_suites: number of supported cipher suites
4379  * @akm_suites: supported AKM suites
4380  * @n_akm_suites: number of supported AKM suites
4381  * @retry_short: Retry limit for short frames (dot11ShortRetryLimit)
4382  * @retry_long: Retry limit for long frames (dot11LongRetryLimit)
4383  * @frag_threshold: Fragmentation threshold (dot11FragmentationThreshold);
4384  *      -1 = fragmentation disabled, only odd values >= 256 used
4385  * @rts_threshold: RTS threshold (dot11RTSThreshold); -1 = RTS/CTS disabled
4386  * @_net: the network namespace this wiphy currently lives in
4387  * @perm_addr: permanent MAC address of this device
4388  * @addr_mask: If the device supports multiple MAC addresses by masking,
4389  *      set this to a mask with variable bits set to 1, e.g. if the last
4390  *      four bits are variable then set it to 00-00-00-00-00-0f. The actual
4391  *      variable bits shall be determined by the interfaces added, with
4392  *      interfaces not matching the mask being rejected to be brought up.
4393  * @n_addresses: number of addresses in @addresses.
4394  * @addresses: If the device has more than one address, set this pointer
4395  *      to a list of addresses (6 bytes each). The first one will be used
4396  *      by default for perm_addr. In this case, the mask should be set to
4397  *      all-zeroes. In this case it is assumed that the device can handle
4398  *      the same number of arbitrary MAC addresses.
4399  * @registered: protects ->resume and ->suspend sysfs callbacks against
4400  *      unregister hardware
4401  * @debugfsdir: debugfs directory used for this wiphy, will be renamed
4402  *      automatically on wiphy renames
4403  * @dev: (virtual) struct device for this wiphy
4404  * @registered: helps synchronize suspend/resume with wiphy unregister
4405  * @wext: wireless extension handlers
4406  * @priv: driver private data (sized according to wiphy_new() parameter)
4407  * @interface_modes: bitmask of interfaces types valid for this wiphy,
4408  *      must be set by driver
4409  * @iface_combinations: Valid interface combinations array, should not
4410  *      list single interface types.
4411  * @n_iface_combinations: number of entries in @iface_combinations array.
4412  * @software_iftypes: bitmask of software interface types, these are not
4413  *      subject to any restrictions since they are purely managed in SW.
4414  * @flags: wiphy flags, see &enum wiphy_flags
4415  * @regulatory_flags: wiphy regulatory flags, see
4416  *      &enum ieee80211_regulatory_flags
4417  * @features: features advertised to nl80211, see &enum nl80211_feature_flags.
4418  * @ext_features: extended features advertised to nl80211, see
4419  *      &enum nl80211_ext_feature_index.
4420  * @bss_priv_size: each BSS struct has private data allocated with it,
4421  *      this variable determines its size
4422  * @max_scan_ssids: maximum number of SSIDs the device can scan for in
4423  *      any given scan
4424  * @max_sched_scan_reqs: maximum number of scheduled scan requests that
4425  *      the device can run concurrently.
4426  * @max_sched_scan_ssids: maximum number of SSIDs the device can scan
4427  *      for in any given scheduled scan
4428  * @max_match_sets: maximum number of match sets the device can handle
4429  *      when performing a scheduled scan, 0 if filtering is not
4430  *      supported.
4431  * @max_scan_ie_len: maximum length of user-controlled IEs device can
4432  *      add to probe request frames transmitted during a scan, must not
4433  *      include fixed IEs like supported rates
4434  * @max_sched_scan_ie_len: same as max_scan_ie_len, but for scheduled
4435  *      scans
4436  * @max_sched_scan_plans: maximum number of scan plans (scan interval and number
4437  *      of iterations) for scheduled scan supported by the device.
4438  * @max_sched_scan_plan_interval: maximum interval (in seconds) for a
4439  *      single scan plan supported by the device.
4440  * @max_sched_scan_plan_iterations: maximum number of iterations for a single
4441  *      scan plan supported by the device.
4442  * @coverage_class: current coverage class
4443  * @fw_version: firmware version for ethtool reporting
4444  * @hw_version: hardware version for ethtool reporting
4445  * @max_num_pmkids: maximum number of PMKIDs supported by device
4446  * @privid: a pointer that drivers can use to identify if an arbitrary
4447  *      wiphy is theirs, e.g. in global notifiers
4448  * @bands: information about bands/channels supported by this device
4449  *
4450  * @mgmt_stypes: bitmasks of frame subtypes that can be subscribed to or
4451  *      transmitted through nl80211, points to an array indexed by interface
4452  *      type
4453  *
4454  * @available_antennas_tx: bitmap of antennas which are available to be
4455  *      configured as TX antennas. Antenna configuration commands will be
4456  *      rejected unless this or @available_antennas_rx is set.
4457  *
4458  * @available_antennas_rx: bitmap of antennas which are available to be
4459  *      configured as RX antennas. Antenna configuration commands will be
4460  *      rejected unless this or @available_antennas_tx is set.
4461  *
4462  * @probe_resp_offload:
4463  *       Bitmap of supported protocols for probe response offloading.
4464  *       See &enum nl80211_probe_resp_offload_support_attr. Only valid
4465  *       when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4466  *
4467  * @max_remain_on_channel_duration: Maximum time a remain-on-channel operation
4468  *      may request, if implemented.
4469  *
4470  * @wowlan: WoWLAN support information
4471  * @wowlan_config: current WoWLAN configuration; this should usually not be
4472  *      used since access to it is necessarily racy, use the parameter passed
4473  *      to the suspend() operation instead.
4474  *
4475  * @ap_sme_capa: AP SME capabilities, flags from &enum nl80211_ap_sme_features.
4476  * @ht_capa_mod_mask:  Specify what ht_cap values can be over-ridden.
4477  *      If null, then none can be over-ridden.
4478  * @vht_capa_mod_mask:  Specify what VHT capabilities can be over-ridden.
4479  *      If null, then none can be over-ridden.
4480  *
4481  * @wdev_list: the list of associated (virtual) interfaces; this list must
4482  *      not be modified by the driver, but can be read with RTNL/RCU protection.
4483  *
4484  * @max_acl_mac_addrs: Maximum number of MAC addresses that the device
4485  *      supports for ACL.
4486  *
4487  * @extended_capabilities: extended capabilities supported by the driver,
4488  *      additional capabilities might be supported by userspace; these are
4489  *      the 802.11 extended capabilities ("Extended Capabilities element")
4490  *      and are in the same format as in the information element. See
4491  *      802.11-2012 8.4.2.29 for the defined fields. These are the default
4492  *      extended capabilities to be used if the capabilities are not specified
4493  *      for a specific interface type in iftype_ext_capab.
4494  * @extended_capabilities_mask: mask of the valid values
4495  * @extended_capabilities_len: length of the extended capabilities
4496  * @iftype_ext_capab: array of extended capabilities per interface type
4497  * @num_iftype_ext_capab: number of interface types for which extended
4498  *      capabilities are specified separately.
4499  * @coalesce: packet coalescing support information
4500  *
4501  * @vendor_commands: array of vendor commands supported by the hardware
4502  * @n_vendor_commands: number of vendor commands
4503  * @vendor_events: array of vendor events supported by the hardware
4504  * @n_vendor_events: number of vendor events
4505  *
4506  * @max_ap_assoc_sta: maximum number of associated stations supported in AP mode
4507  *      (including P2P GO) or 0 to indicate no such limit is advertised. The
4508  *      driver is allowed to advertise a theoretical limit that it can reach in
4509  *      some cases, but may not always reach.
4510  *
4511  * @max_num_csa_counters: Number of supported csa_counters in beacons
4512  *      and probe responses.  This value should be set if the driver
4513  *      wishes to limit the number of csa counters. Default (0) means
4514  *      infinite.
4515  * @max_adj_channel_rssi_comp: max offset of between the channel on which the
4516  *      frame was sent and the channel on which the frame was heard for which
4517  *      the reported rssi is still valid. If a driver is able to compensate the
4518  *      low rssi when a frame is heard on different channel, then it should set
4519  *      this variable to the maximal offset for which it can compensate.
4520  *      This value should be set in MHz.
4521  * @bss_select_support: bitmask indicating the BSS selection criteria supported
4522  *      by the driver in the .connect() callback. The bit position maps to the
4523  *      attribute indices defined in &enum nl80211_bss_select_attr.
4524  *
4525  * @nan_supported_bands: bands supported by the device in NAN mode, a
4526  *      bitmap of &enum nl80211_band values.  For instance, for
4527  *      NL80211_BAND_2GHZ, bit 0 would be set
4528  *      (i.e. BIT(NL80211_BAND_2GHZ)).
4529  *
4530  * @txq_limit: configuration of internal TX queue frame limit
4531  * @txq_memory_limit: configuration internal TX queue memory limit
4532  * @txq_quantum: configuration of internal TX queue scheduler quantum
4533  *
4534  * @support_mbssid: can HW support association with nontransmitted AP
4535  * @support_only_he_mbssid: don't parse MBSSID elements if it is not
4536  *      HE AP, in order to avoid compatibility issues.
4537  *      @support_mbssid must be set for this to have any effect.
4538  *
4539  * @pmsr_capa: peer measurement capabilities
4540  */
4541 struct wiphy {
4542         /* assign these fields before you register the wiphy */
4543 
4544         /* permanent MAC address(es) */
4545         u8 perm_addr[ETH_ALEN];
4546         u8 addr_mask[ETH_ALEN];
4547 
4548         struct mac_address *addresses;
4549 
4550         const struct ieee80211_txrx_stypes *mgmt_stypes;
4551 
4552         const struct ieee80211_iface_combination *iface_combinations;
4553         int n_iface_combinations;
4554         u16 software_iftypes;
4555 
4556         u16 n_addresses;
4557 
4558         /* Supported interface modes, OR together BIT(NL80211_IFTYPE_...) */
4559         u16 interface_modes;
4560 
4561         u16 max_acl_mac_addrs;
4562 
4563         u32 flags, regulatory_flags, features;
4564         u8 ext_features[DIV_ROUND_UP(NUM_NL80211_EXT_FEATURES, 8)];
4565 
4566         u32 ap_sme_capa;
4567 
4568         enum cfg80211_signal_type signal_type;
4569 
4570         int bss_priv_size;
4571         u8 max_scan_ssids;
4572         u8 max_sched_scan_reqs;
4573         u8 max_sched_scan_ssids;
4574         u8 max_match_sets;
4575         u16 max_scan_ie_len;
4576         u16 max_sched_scan_ie_len;
4577         u32 max_sched_scan_plans;
4578         u32 max_sched_scan_plan_interval;
4579         u32 max_sched_scan_plan_iterations;
4580 
4581         int n_cipher_suites;
4582         const u32 *cipher_suites;
4583 
4584         int n_akm_suites;
4585         const u32 *akm_suites;
4586 
4587         u8 retry_short;
4588         u8 retry_long;
4589         u32 frag_threshold;
4590         u32 rts_threshold;
4591         u8 coverage_class;
4592 
4593         char fw_version[ETHTOOL_FWVERS_LEN];
4594         u32 hw_version;
4595 
4596 #ifdef CONFIG_PM
4597         const struct wiphy_wowlan_support *wowlan;
4598         struct cfg80211_wowlan *wowlan_config;
4599 #endif
4600 
4601         u16 max_remain_on_channel_duration;
4602 
4603         u8 max_num_pmkids;
4604 
4605         u32 available_antennas_tx;
4606         u32 available_antennas_rx;
4607 
4608         /*
4609          * Bitmap of supported protocols for probe response offloading
4610          * see &enum nl80211_probe_resp_offload_support_attr. Only valid
4611          * when the wiphy flag @WIPHY_FLAG_AP_PROBE_RESP_OFFLOAD is set.
4612          */
4613         u32 probe_resp_offload;
4614 
4615         const u8 *extended_capabilities, *extended_capabilities_mask;
4616         u8 extended_capabilities_len;
4617 
4618         const struct wiphy_iftype_ext_capab *iftype_ext_capab;
4619         unsigned int num_iftype_ext_capab;
4620 
4621         /* If multiple wiphys are registered and you're handed e.g.
4622          * a regular netdev with assigned ieee80211_ptr, you won't
4623          * know whether it points to a wiphy your driver has registered
4624          * or not. Assign this to something global to your driver to
4625          * help determine whether you own this wiphy or not. */
4626         const void *privid;
4627 
4628         struct ieee80211_supported_band *bands[NUM_NL80211_BANDS];
4629 
4630         /* Lets us get back the wiphy on the callback */
4631         void (*reg_notifier)(struct wiphy *wiphy,
4632                              struct regulatory_request *request);
4633 
4634         /* fields below are read-only, assigned by cfg80211 */
4635 
4636         const struct ieee80211_regdomain __rcu *regd;
4637 
4638         /* the item in /sys/class/ieee80211/ points to this,
4639          * you need use set_wiphy_dev() (see below) */
4640         struct device dev;
4641 
4642         /* protects ->resume, ->suspend sysfs callbacks against unregister hw */
4643         bool registered;
4644 
4645         /* dir in debugfs: ieee80211/<wiphyname> */
4646         struct dentry *debugfsdir;
4647 
4648         const struct ieee80211_ht_cap *ht_capa_mod_mask;
4649         const struct ieee80211_vht_cap *vht_capa_mod_mask;
4650 
4651         struct list_head wdev_list;
4652 
4653         /* the network namespace this phy lives in currently */
4654         possible_net_t _net;
4655 
4656 #ifdef CONFIG_CFG80211_WEXT
4657         const struct iw_handler_def *wext;
4658 #endif
4659 
4660         const struct wiphy_coalesce_support *coalesce;
4661 
4662         const struct wiphy_vendor_command *vendor_commands;
4663         const struct nl80211_vendor_cmd_info *vendor_events;
4664         int n_vendor_commands, n_vendor_events;
4665 
4666         u16 max_ap_assoc_sta;
4667 
4668         u8 max_num_csa_counters;
4669         u8 max_adj_channel_rssi_comp;
4670 
4671         u32 bss_select_support;
4672 
4673         u8 nan_supported_bands;
4674 
4675         u32 txq_limit;
4676         u32 txq_memory_limit;
4677         u32 txq_quantum;
4678 
4679         u8 support_mbssid:1,
4680            support_only_he_mbssid:1;
4681 
4682         const struct cfg80211_pmsr_capabilities *pmsr_capa;
4683 
4684         char priv[0] __aligned(NETDEV_ALIGN);
4685 };
4686 
4687 static inline struct net *wiphy_net(struct wiphy *wiphy)
4688 {
4689         return read_pnet(&wiphy->_net);
4690 }
4691 
4692 static inline void wiphy_net_set(struct wiphy *wiphy, struct net *net)
4693 {
4694         write_pnet(&wiphy->_net, net);
4695 }
4696 
4697 /**
4698  * wiphy_priv - return priv from wiphy
4699  *
4700  * @wiphy: the wiphy whose priv pointer to return
4701  * Return: The priv of @wiphy.
4702  */
4703 static inline void *wiphy_priv(struct wiphy *wiphy)
4704 {
4705         BUG_ON(!wiphy);
4706         return &wiphy->priv;
4707 }
4708 
4709 /**
4710  * priv_to_wiphy - return the wiphy containing the priv
4711  *
4712  * @priv: a pointer previously returned by wiphy_priv
4713  * Return: The wiphy of @priv.
4714  */
4715 static inline struct wiphy *priv_to_wiphy(void *priv)
4716 {
4717         BUG_ON(!priv);
4718         return container_of(priv, struct wiphy, priv);
4719 }
4720 
4721 /**
4722  * set_wiphy_dev - set device pointer for wiphy
4723  *
4724  * @wiphy: The wiphy whose device to bind
4725  * @dev: The device to parent it to
4726  */
4727 static inline void set_wiphy_dev(struct wiphy *wiphy, struct device *dev)
4728 {
4729         wiphy->dev.parent = dev;
4730 }
4731 
4732 /**
4733  * wiphy_dev - get wiphy dev pointer
4734  *
4735  * @wiphy: The wiphy whose device struct to look up
4736  * Return: The dev of @wiphy.
4737  */
4738 static inline struct device *wiphy_dev(struct wiphy *wiphy)
4739 {
4740         return wiphy->dev.parent;
4741 }
4742 
4743 /**
4744  * wiphy_name - get wiphy name
4745  *
4746  * @wiphy: The wiphy whose name to return
4747  * Return: The name of @wiphy.
4748  */
4749 static inline const char *wiphy_name(const struct wiphy *wiphy)
4750 {
4751         return dev_name(&wiphy->dev);
4752 }
4753 
4754 /**
4755  * wiphy_new_nm - create a new wiphy for use with cfg80211
4756  *
4757  * @ops: The configuration operations for this device
4758  * @sizeof_priv: The size of the private area to allocate
4759  * @requested_name: Request a particular name.
4760  *      NULL is valid value, and means use the default phy%d naming.
4761  *
4762  * Create a new wiphy and associate the given operations with it.
4763  * @sizeof_priv bytes are allocated for private use.
4764  *
4765  * Return: A pointer to the new wiphy. This pointer must be
4766  * assigned to each netdev's ieee80211_ptr for proper operation.
4767  */
4768 struct wiphy *wiphy_new_nm(const struct cfg80211_ops *ops, int sizeof_priv,
4769                            const char *requested_name);
4770 
4771 /**
4772  * wiphy_new - create a new wiphy for use with cfg80211
4773  *
4774  * @ops: The configuration operations for this device
4775  * @sizeof_priv: The size of the private area to allocate
4776  *
4777  * Create a new wiphy and associate the given operations with it.
4778  * @sizeof_priv bytes are allocated for private use.
4779  *
4780  * Return: A pointer to the new wiphy. This pointer must be
4781  * assigned to each netdev's ieee80211_ptr for proper operation.
4782  */
4783 static inline struct wiphy *wiphy_new(const struct cfg80211_ops *ops,
4784                                       int sizeof_priv)
4785 {
4786         return wiphy_new_nm(ops, sizeof_priv, NULL);
4787 }
4788 
4789 /**
4790  * wiphy_register - register a wiphy with cfg80211
4791  *
4792  * @wiphy: The wiphy to register.
4793  *
4794  * Return: A non-negative wiphy index or a negative error code.
4795  */
4796 int wiphy_register(struct wiphy *wiphy);
4797 
4798 /**
4799  * wiphy_unregister - deregister a wiphy from cfg80211
4800  *
4801  * @wiphy: The wiphy to unregister.
4802  *
4803  * After this call, no more requests can be made with this priv
4804  * pointer, but the call may sleep to wait for an outstanding
4805  * request that is being handled.
4806  */
4807 void wiphy_unregister(struct wiphy *wiphy);
4808 
4809 /**
4810  * wiphy_free - free wiphy
4811  *
4812  * @wiphy: The wiphy to free
4813  */
4814 void wiphy_free(struct wiphy *wiphy);
4815 
4816 /* internal structs */
4817 struct cfg80211_conn;
4818 struct cfg80211_internal_bss;
4819 struct cfg80211_cached_keys;
4820 struct cfg80211_cqm_config;
4821 
4822 /**
4823  * struct wireless_dev - wireless device state
4824  *
4825  * For netdevs, this structure must be allocated by the driver
4826  * that uses the ieee80211_ptr field in struct net_device (this
4827  * is intentional so it can be allocated along with the netdev.)
4828  * It need not be registered then as netdev registration will
4829  * be intercepted by cfg80211 to see the new wireless device.
4830  *
4831  * For non-netdev uses, it must also be allocated by the driver
4832  * in response to the cfg80211 callbacks that require it, as
4833  * there's no netdev registration in that case it may not be
4834  * allocated outside of callback operations that return it.
4835  *
4836  * @wiphy: pointer to hardware description
4837  * @iftype: interface type
4838  * @list: (private) Used to collect the interfaces
4839  * @netdev: (private) Used to reference back to the netdev, may be %NULL
4840  * @identifier: (private) Identifier used in nl80211 to identify this
4841  *      wireless device if it has no netdev
4842  * @current_bss: (private) Used by the internal configuration code
4843  * @chandef: (private) Used by the internal configuration code to track
4844  *      the user-set channel definition.
4845  * @preset_chandef: (private) Used by the internal configuration code to
4846  *      track the channel to be used for AP later
4847  * @bssid: (private) Used by the internal configuration code
4848  * @ssid: (private) Used by the internal configuration code
4849  * @ssid_len: (private) Used by the internal configuration code
4850  * @mesh_id_len: (private) Used by the internal configuration code
4851  * @mesh_id_up_len: (private) Used by the internal configuration code
4852  * @wext: (private) Used by the internal wireless extensions compat code
4853  * @wext.ibss: (private) IBSS data part of wext handling
4854  * @wext.connect: (private) connection handling data
4855  * @wext.keys: (private) (WEP) key data
4856  * @wext.ie: (private) extra elements for association
4857  * @wext.ie_len: (private) length of extra elements
4858  * @wext.bssid: (private) selected network BSSID
4859  * @wext.ssid: (private) selected network SSID
4860  * @wext.default_key: (private) selected default key index
4861  * @wext.default_mgmt_key: (private) selected default management key index
4862  * @wext.prev_bssid: (private) previous BSSID for reassociation
4863  * @wext.prev_bssid_valid: (private) previous BSSID validity
4864  * @use_4addr: indicates 4addr mode is used on this interface, must be
4865  *      set by driver (if supported) on add_interface BEFORE registering the
4866  *      netdev and may otherwise be used by driver read-only, will be update
4867  *      by cfg80211 on change_interface
4868  * @mgmt_registrations: list of registrations for management frames
4869  * @mgmt_registrations_lock: lock for the list
4870  * @mtx: mutex used to lock data in this struct, may be used by drivers
4871  *      and some API functions require it held
4872  * @beacon_interval: beacon interval used on this device for transmitting
4873  *      beacons, 0 when not valid
4874  * @address: The address for this device, valid only if @netdev is %NULL
4875  * @is_running: true if this is a non-netdev device that has been started, e.g.
4876  *      the P2P Device.
4877  * @cac_started: true if DFS channel availability check has been started
4878  * @cac_start_time: timestamp (jiffies) when the dfs state was entered.
4879  * @cac_time_ms: CAC time in ms
4880  * @ps: powersave mode is enabled
4881  * @ps_timeout: dynamic powersave timeout
4882  * @ap_unexpected_nlportid: (private) netlink port ID of application
4883  *      registered for unexpected class 3 frames (AP mode)
4884  * @conn: (private) cfg80211 software SME connection state machine data
4885  * @connect_keys: (private) keys to set after connection is established
4886  * @conn_bss_type: connecting/connected BSS type
4887  * @conn_owner_nlportid: (private) connection owner socket port ID
4888  * @disconnect_wk: (private) auto-disconnect work
4889  * @disconnect_bssid: (private) the BSSID to use for auto-disconnect
4890  * @ibss_fixed: (private) IBSS is using fixed BSSID
4891  * @ibss_dfs_possible: (private) IBSS may change to a DFS channel
4892  * @event_list: (private) list for internal event processing
4893  * @event_lock: (private) lock for event list
4894  * @owner_nlportid: (private) owner socket port ID
4895  * @nl_owner_dead: (private) owner socket went away
4896  * @cqm_config: (private) nl80211 RSSI monitor state
4897  * @pmsr_list: (private) peer measurement requests
4898  * @pmsr_lock: (private) peer measurements requests/results lock
4899  * @pmsr_free_wk: (private) peer measurements cleanup work
4900  */
4901 struct wireless_dev {
4902         struct wiphy *wiphy;
4903         enum nl80211_iftype iftype;
4904 
4905         /* the remainder of this struct should be private to cfg80211 */
4906         struct list_head list;
4907         struct net_device *netdev;
4908 
4909         u32 identifier;
4910 
4911         struct list_head mgmt_registrations;
4912         spinlock_t mgmt_registrations_lock;
4913 
4914         struct mutex mtx;
4915 
4916         bool use_4addr, is_running;
4917 
4918         u8 address[ETH_ALEN] __aligned(sizeof(u16));
4919 
4920         /* currently used for IBSS and SME - might be rearranged later */
4921         u8 ssid[IEEE80211_MAX_SSID_LEN];
4922         u8 ssid_len, mesh_id_len, mesh_id_up_len;
4923         struct cfg80211_conn *conn;
4924         struct cfg80211_cached_keys *connect_keys;
4925         enum ieee80211_bss_type conn_bss_type;
4926         u32 conn_owner_nlportid;
4927 
4928         struct work_struct disconnect_wk;
4929         u8 disconnect_bssid[ETH_ALEN];
4930 
4931         struct list_head event_list;
4932         spinlock_t event_lock;
4933 
4934         struct cfg80211_internal_bss *current_bss; /* associated / joined */
4935         struct cfg80211_chan_def preset_chandef;
4936         struct cfg80211_chan_def chandef;
4937 
4938         bool ibss_fixed;
4939         bool ibss_dfs_possible;
4940 
4941         bool ps;
4942         int ps_timeout;
4943 
4944         int beacon_interval;
4945 
4946         u32 ap_unexpected_nlportid;
4947 
4948         u32 owner_nlportid;
4949         bool nl_owner_dead;
4950 
4951         bool cac_started;
4952         unsigned long cac_start_time;
4953         unsigned int cac_time_ms;
4954 
4955 #ifdef CONFIG_CFG80211_WEXT
4956         /* wext data */
4957         struct {
4958                 struct cfg80211_ibss_params ibss;
4959                 struct cfg80211_connect_params connect;
4960                 struct cfg80211_cached_keys *keys;
4961                 const u8 *ie;
4962                 size_t ie_len;
4963                 u8 bssid[ETH_ALEN];
4964                 u8 prev_bssid[ETH_ALEN];
4965                 u8 ssid[IEEE80211_MAX_SSID_LEN];
4966                 s8 default_key, default_mgmt_key;
4967                 bool prev_bssid_valid;
4968         } wext;
4969 #endif
4970 
4971         struct cfg80211_cqm_config *cqm_config;
4972 
4973         struct list_head pmsr_list;
4974         spinlock_t pmsr_lock;
4975         struct work_struct pmsr_free_wk;
4976 };
4977 
4978 static inline u8 *wdev_address(struct wireless_dev *wdev)
4979 {
4980         if (wdev->netdev)
4981                 return wdev->netdev->dev_addr;
4982         return wdev->address;
4983 }
4984 
4985 static inline bool wdev_running(struct wireless_dev *wdev)
4986 {
4987         if (wdev->netdev)
4988                 return netif_running(wdev->netdev);
4989         return wdev->is_running;
4990 }
4991 
4992 /**
4993  * wdev_priv - return wiphy priv from wireless_dev
4994  *
4995  * @wdev: The wireless device whose wiphy's priv pointer to return
4996  * Return: The wiphy priv of @wdev.
4997  */
4998 static inline void *wdev_priv(struct wireless_dev *wdev)
4999 {
5000         BUG_ON(!wdev);
5001         return wiphy_priv(wdev->wiphy);
5002 }
5003 
5004 /**
5005  * DOC: Utility functions
5006  *
5007  * cfg80211 offers a number of utility functions that can be useful.
5008  */
5009 
5010 /**
5011  * ieee80211_channel_to_frequency - convert channel number to frequency
5012  * @chan: channel number
5013  * @band: band, necessary due to channel number overlap
5014  * Return: The corresponding frequency (in MHz), or 0 if the conversion failed.
5015  */
5016 int ieee80211_channel_to_frequency(int chan, enum nl80211_band band);
5017 
5018 /**
5019  * ieee80211_frequency_to_channel - convert frequency to channel number
5020  * @freq: center frequency
5021  * Return: The corresponding channel, or 0 if the conversion failed.
5022  */
5023 int ieee80211_frequency_to_channel(int freq);
5024 
5025 /**
5026  * ieee80211_get_channel - get channel struct from wiphy for specified frequency
5027  *
5028  * @wiphy: the struct wiphy to get the channel for
5029  * @freq: the center frequency of the channel
5030  *
5031  * Return: The channel struct from @wiphy at @freq.
5032  */
5033 struct ieee80211_channel *ieee80211_get_channel(struct wiphy *wiphy, int freq);
5034 
5035 /**
5036  * ieee80211_get_response_rate - get basic rate for a given rate
5037  *
5038  * @sband: the band to look for rates in
5039  * @basic_rates: bitmap of basic rates
5040  * @bitrate: the bitrate for which to find the basic rate
5041  *
5042  * Return: The basic rate corresponding to a given bitrate, that
5043  * is the next lower bitrate contained in the basic rate map,
5044  * which is, for this function, given as a bitmap of indices of
5045  * rates in the band's bitrate table.
5046  */
5047 struct ieee80211_rate *
5048 ieee80211_get_response_rate(struct ieee80211_supported_band *sband,
5049                             u32 basic_rates, int bitrate);
5050 
5051 /**
5052  * ieee80211_mandatory_rates - get mandatory rates for a given band
5053  * @sband: the band to look for rates in
5054  * @scan_width: width of the control channel
5055  *
5056  * This function returns a bitmap of the mandatory rates for the given
5057  * band, bits are set according to the rate position in the bitrates array.
5058  */
5059 u32 ieee80211_mandatory_rates(struct ieee80211_supported_band *sband,
5060                               enum nl80211_bss_scan_width scan_width);
5061 
5062 /*
5063  * Radiotap parsing functions -- for controlled injection support
5064  *
5065  * Implemented in net/wireless/radiotap.c
5066  * Documentation in Documentation/networking/radiotap-headers.txt
5067  */
5068 
5069 struct radiotap_align_size {
5070         uint8_t align:4, size:4;
5071 };
5072 
5073 struct ieee80211_radiotap_namespace {
5074         const struct radiotap_align_size *align_size;
5075         int n_bits;
5076         uint32_t oui;
5077         uint8_t subns;
5078 };
5079 
5080 struct ieee80211_radiotap_vendor_namespaces {
5081         const struct ieee80211_radiotap_namespace *ns;
5082         int n_ns;
5083 };
5084 
5085 /**
5086  * struct ieee80211_radiotap_iterator - tracks walk thru present radiotap args
5087  * @this_arg_index: index of current arg, valid after each successful call
5088  *      to ieee80211_radiotap_iterator_next()
5089  * @this_arg: pointer to current radiotap arg; it is valid after each
5090  *      call to ieee80211_radiotap_iterator_next() but also after
5091  *      ieee80211_radiotap_iterator_init() where it will point to
5092  *      the beginning of the actual data portion
5093  * @this_arg_size: length of the current arg, for convenience
5094  * @current_namespace: pointer to the current namespace definition
5095  *      (or internally %NULL if the current namespace is unknown)
5096  * @is_radiotap_ns: indicates whether the current namespace is the default
5097  *      radiotap namespace or not
5098  *
5099  * @_rtheader: pointer to the radiotap header we are walking through
5100  * @_max_length: length of radiotap header in cpu byte ordering
5101  * @_arg_index: next argument index
5102  * @_arg: next argument pointer
5103  * @_next_bitmap: internal pointer to next present u32
5104  * @_bitmap_shifter: internal shifter for curr u32 bitmap, b0 set == arg present
5105  * @_vns: vendor namespace definitions
5106  * @_next_ns_data: beginning of the next namespace's data
5107  * @_reset_on_ext: internal; reset the arg index to 0 when going to the
5108  *      next bitmap word
5109  *
5110  * Describes the radiotap parser state. Fields prefixed with an underscore
5111  * must not be used by users of the parser, only by the parser internally.
5112  */
5113 
5114 struct ieee80211_radiotap_iterator {
5115         struct ieee80211_radiotap_header *_rtheader;
5116         const struct ieee80211_radiotap_vendor_namespaces *_vns;
5117         const struct ieee80211_radiotap_namespace *current_namespace;
5118 
5119         unsigned char *_arg, *_next_ns_data;
5120         __le32 *_next_bitmap;
5121 
5122         unsigned char *this_arg;
5123         int this_arg_index;
5124         int this_arg_size;
5125 
5126         int is_radiotap_ns;
5127 
5128         int _max_length;
5129         int _arg_index;
5130         uint32_t _bitmap_shifter;
5131         int _reset_on_ext;
5132 };
5133 
5134 int
5135 ieee80211_radiotap_iterator_init(struct ieee80211_radiotap_iterator *iterator,
5136                                  struct ieee80211_radiotap_header *radiotap_header,
5137                                  int max_length,
5138                                  const struct ieee80211_radiotap_vendor_namespaces *vns);
5139 
5140 int
5141 ieee80211_radiotap_iterator_next(struct ieee80211_radiotap_iterator *iterator);
5142 
5143 
5144 extern const unsigned char rfc1042_header[6];
5145 extern const unsigned char bridge_tunnel_header[6];
5146 
5147 /**
5148  * ieee80211_get_hdrlen_from_skb - get header length from data
5149  *
5150  * @skb: the frame
5151  *
5152  * Given an skb with a raw 802.11 header at the data pointer this function
5153  * returns the 802.11 header length.
5154  *
5155  * Return: The 802.11 header length in bytes (not including encryption
5156  * headers). Or 0 if the data in the sk_buff is too short to contain a valid
5157  * 802.11 header.
5158  */
5159 unsigned int ieee80211_get_hdrlen_from_skb(const struct sk_buff *skb);
5160 
5161 /**
5162  * ieee80211_hdrlen - get header length in bytes from frame control
5163  * @fc: frame control field in little-endian format
5164  * Return: The header length in bytes.
5165  */
5166 unsigned int __attribute_const__ ieee80211_hdrlen(__le16 fc);
5167 
5168 /**
5169  * ieee80211_get_mesh_hdrlen - get mesh extension header length
5170  * @meshhdr: the mesh extension header, only the flags field
5171  *      (first byte) will be accessed
5172  * Return: The length of the extension header, which is always at
5173  * least 6 bytes and at most 18 if address 5 and 6 are present.
5174  */
5175 unsigned int ieee80211_get_mesh_hdrlen(struct ieee80211s_hdr *meshhdr);
5176 
5177 /**
5178  * DOC: Data path helpers
5179  *
5180  * In addition to generic utilities, cfg80211 also offers
5181  * functions that help implement the data path for devices
5182  * that do not do the 802.11/802.3 conversion on the device.
5183  */
5184 
5185 /**
5186  * ieee80211_data_to_8023_exthdr - convert an 802.11 data frame to 802.3
5187  * @skb: the 802.11 data frame
5188  * @ehdr: pointer to a &struct ethhdr that will get the header, instead
5189  *      of it being pushed into the SKB
5190  * @addr: the device MAC address
5191  * @iftype: the virtual interface type
5192  * @data_offset: offset of payload after the 802.11 header
5193  * Return: 0 on success. Non-zero on error.
5194  */
5195 int ieee80211_data_to_8023_exthdr(struct sk_buff *skb, struct ethhdr *ehdr,
5196                                   const u8 *addr, enum nl80211_iftype iftype,
5197                                   u8 data_offset);
5198 
5199 /**
5200  * ieee80211_data_to_8023 - convert an 802.11 data frame to 802.3
5201  * @skb: the 802.11 data frame
5202  * @addr: the device MAC address
5203  * @iftype: the virtual interface type
5204  * Return: 0 on success. Non-zero on error.
5205  */
5206 static inline int ieee80211_data_to_8023(struct sk_buff *skb, const u8 *addr,
5207                                          enum nl80211_iftype iftype)
5208 {
5209         return ieee80211_data_to_8023_exthdr(skb, NULL, addr, iftype, 0);
5210 }
5211 
5212 /**
5213  * ieee80211_amsdu_to_8023s - decode an IEEE 802.11n A-MSDU frame
5214  *
5215  * Decode an IEEE 802.11 A-MSDU and convert it to a list of 802.3 frames.
5216  * The @list will be empty if the decode fails. The @skb must be fully
5217  * header-less before being passed in here; it is freed in this function.
5218  *
5219  * @skb: The input A-MSDU frame without any headers.
5220  * @list: The output list of 802.3 frames. It must be allocated and
5221  *      initialized by by the caller.
5222  * @addr: The device MAC address.
5223  * @iftype: The device interface type.
5224  * @extra_headroom: The hardware extra headroom for SKBs in the @list.
5225  * @check_da: DA to check in the inner ethernet header, or NULL
5226  * @check_sa: SA to check in the inner ethernet header, or NULL
5227  */
5228 void ieee80211_amsdu_to_8023s(struct sk_buff *skb, struct sk_buff_head *list,
5229                               const u8 *addr, enum nl80211_iftype iftype,
5230                               const unsigned int extra_headroom,
5231                               const u8 *check_da, const u8 *check_sa);
5232 
5233 /**
5234  * cfg80211_classify8021d - determine the 802.1p/1d tag for a data frame
5235  * @skb: the data frame
5236  * @qos_map: Interworking QoS mapping or %NULL if not in use
5237  * Return: The 802.1p/1d tag.
5238  */
5239 unsigned int cfg80211_classify8021d(struct sk_buff *skb,
5240                                     struct cfg80211_qos_map *qos_map);
5241 
5242 /**
5243  * cfg80211_find_elem_match - match information element and byte array in data
5244  *
5245  * @eid: element ID
5246  * @ies: data consisting of IEs
5247  * @len: length of data
5248  * @match: byte array to match
5249  * @match_len: number of bytes in the match array
5250  * @match_offset: offset in the IE data where the byte array should match.
5251  *      Note the difference to cfg80211_find_ie_match() which considers
5252  *      the offset to start from the element ID byte, but here we take
5253  *      the data portion instead.
5254  *
5255  * Return: %NULL if the element ID could not be found or if
5256  * the element is invalid (claims to be longer than the given
5257  * data) or if the byte array doesn't match; otherwise return the
5258  * requested element struct.
5259  *
5260  * Note: There are no checks on the element length other than
5261  * having to fit into the given data and being large enough for the
5262  * byte array to match.
5263  */
5264 const struct element *
5265 cfg80211_find_elem_match(u8 eid, const u8 *ies, unsigned int len,
5266                          const u8 *match, unsigned int match_len,
5267                          unsigned int match_offset);
5268 
5269 /**
5270  * cfg80211_find_ie_match - match information element and byte array in data
5271  *
5272  * @eid: element ID
5273  * @ies: data consisting of IEs
5274  * @len: length of data
5275  * @match: byte array to match
5276  * @match_len: number of bytes in the match array
5277  * @match_offset: offset in the IE where the byte array should match.
5278  *      If match_len is zero, this must also be set to zero.
5279  *      Otherwise this must be set to 2 or more, because the first
5280  *      byte is the element id, which is already compared to eid, and
5281  *      the second byte is the IE length.
5282  *
5283  * Return: %NULL if the element ID could not be found or if
5284  * the element is invalid (claims to be longer than the given
5285  * data) or if the byte array doesn't match, or a pointer to the first
5286  * byte of the requested element, that is the byte containing the
5287  * element ID.
5288  *
5289  * Note: There are no checks on the element length other than
5290  * having to fit into the given data and being large enough for the
5291  * byte array to match.
5292  */
5293 static inline const u8 *
5294 cfg80211_find_ie_match(u8 eid, const u8 *ies, unsigned int len,
5295                        const u8 *match, unsigned int match_len,
5296                        unsigned int match_offset)
5297 {
5298         /* match_offset can't be smaller than 2, unless match_len is
5299          * zero, in which case match_offset must be zero as well.
5300          */
5301         if (WARN_ON((match_len && match_offset < 2) ||
5302                     (!match_len && match_offset)))
5303                 return NULL;
5304 
5305         return (void *)cfg80211_find_elem_match(eid, ies, len,
5306                                                 match, match_len,
5307                                                 match_offset ?
5308                                                         match_offset - 2 : 0);
5309 }
5310 
5311 /**
5312  * cfg80211_find_elem - find information element in data
5313  *
5314  * @eid: element ID
5315  * @ies: data consisting of IEs
5316  * @len: length of data
5317  *
5318  * Return: %NULL if the element ID could not be found or if
5319  * the element is invalid (claims to be longer than the given
5320  * data) or if the byte array doesn't match; otherwise return the
5321  * requested element struct.
5322  *
5323  * Note: There are no checks on the element length other than
5324  * having to fit into the given data.
5325  */
5326 static inline const struct element *
5327 cfg80211_find_elem(u8 eid, const u8 *ies, int len)
5328 {
5329         return cfg80211_find_elem_match(eid, ies, len, NULL, 0, 0);
5330 }
5331 
5332 /**
5333  * cfg80211_find_ie - find information element in data
5334  *
5335  * @eid: element ID
5336  * @ies: data consisting of IEs
5337  * @len: length of data
5338  *
5339  * Return: %NULL if the element ID could not be found or if
5340  * the element is invalid (claims to be longer than the given
5341  * data), or a pointer to the first byte of the requested
5342  * element, that is the byte containing the element ID.
5343  *
5344  * Note: There are no checks on the element length other than
5345  * having to fit into the given data.
5346  */
5347 static inline const u8 *cfg80211_find_ie(u8 eid, const u8 *ies, int len)
5348 {
5349         return cfg80211_find_ie_match(eid, ies, len, NULL, 0, 0);
5350 }
5351 
5352 /**
5353  * cfg80211_find_ext_elem - find information element with EID Extension in data
5354  *
5355  * @ext_eid: element ID Extension
5356  * @ies: data consisting of IEs
5357  * @len: length of data
5358  *
5359  * Return: %NULL if the etended element could not be found or if
5360  * the element is invalid (claims to be longer than the given
5361  * data) or if the byte array doesn't match; otherwise return the
5362  * requested element struct.
5363  *
5364  * Note: There are no checks on the element length other than
5365  * having to fit into the given data.
5366  */
5367 static inline const struct element *
5368 cfg80211_find_ext_elem(u8 ext_eid, const u8 *ies, int len)
5369 {
5370         return cfg80211_find_elem_match(WLAN_EID_EXTENSION, ies, len,
5371                                         &ext_eid, 1, 0);
5372 }
5373 
5374 /**
5375  * cfg80211_find_ext_ie - find information element with EID Extension in data
5376  *
5377  * @ext_eid: element ID Extension
5378  * @ies: data consisting of IEs
5379  * @len: length of data
5380  *
5381  * Return: %NULL if the extended element ID could not be found or if
5382  * the element is invalid (claims to be longer than the given
5383  * data), or a pointer to the first byte of the requested
5384  * element, that is the byte containing the element ID.
5385  *
5386  * Note: There are no checks on the element length other than
5387  * having to fit into the given data.
5388  */
5389 static inline const u8 *cfg80211_find_ext_ie(u8 ext_eid, const u8 *ies, int len)
5390 {
5391         return cfg80211_find_ie_match(WLAN_EID_EXTENSION, ies, len,
5392                                       &ext_eid, 1, 2);
5393 }
5394 
5395 /**
5396  * cfg80211_find_vendor_elem - find vendor specific information element in data
5397  *
5398  * @oui: vendor OUI
5399  * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5400  * @ies: data consisting of IEs
5401  * @len: length of data
5402  *
5403  * Return: %NULL if the vendor specific element ID could not be found or if the
5404  * element is invalid (claims to be longer than the given data); otherwise
5405  * return the element structure for the requested element.
5406  *
5407  * Note: There are no checks on the element length other than having to fit into
5408  * the given data.
5409  */
5410 const struct element *cfg80211_find_vendor_elem(unsigned int oui, int oui_type,
5411                                                 const u8 *ies,
5412                                                 unsigned int len);
5413 
5414 /**
5415  * cfg80211_find_vendor_ie - find vendor specific information element in data
5416  *
5417  * @oui: vendor OUI
5418  * @oui_type: vendor-specific OUI type (must be < 0xff), negative means any
5419  * @ies: data consisting of IEs
5420  * @len: length of data
5421  *
5422  * Return: %NULL if the vendor specific element ID could not be found or if the
5423  * element is invalid (claims to be longer than the given data), or a pointer to
5424  * the first byte of the requested element, that is the byte containing the
5425  * element ID.
5426  *
5427  * Note: There are no checks on the element length other than having to fit into
5428  * the given data.
5429  */
5430 static inline const u8 *
5431 cfg80211_find_vendor_ie(unsigned int oui, int oui_type,
5432                         const u8 *ies, unsigned int len)
5433 {
5434         return (void *)cfg80211_find_vendor_elem(oui, oui_type, ies, len);
5435 }
5436 
5437 /**
5438  * cfg80211_send_layer2_update - send layer 2 update frame
5439  *
5440  * @dev: network device
5441  * @addr: STA MAC address
5442  *
5443  * Wireless drivers can use this function to update forwarding tables in bridge
5444  * devices upon STA association.
5445  */
5446 void cfg80211_send_layer2_update(struct net_device *dev, const u8 *addr);
5447 
5448 /**
5449  * DOC: Regulatory enforcement infrastructure
5450  *
5451  * TODO
5452  */
5453 
5454 /**
5455  * regulatory_hint - driver hint to the wireless core a regulatory domain
5456  * @wiphy: the wireless device giving the hint (used only for reporting
5457  *      conflicts)
5458  * @alpha2: the ISO/IEC 3166 alpha2 the driver claims its regulatory domain
5459  *      should be in. If @rd is set this should be NULL. Note that if you
5460  *      set this to NULL you should still set rd->alpha2 to some accepted
5461  *      alpha2.
5462  *
5463  * Wireless drivers can use this function to hint to the wireless core
5464  * what it believes should be the current regulatory domain by
5465  * giving it an ISO/IEC 3166 alpha2 country code it knows its regulatory
5466  * domain should be in or by providing a completely build regulatory domain.
5467  * If the driver provides an ISO/IEC 3166 alpha2 userspace will be queried
5468  * for a regulatory domain structure for the respective country.
5469  *
5470  * The wiphy must have been registered to cfg80211 prior to this call.
5471  * For cfg80211 drivers this means you must first use wiphy_register(),
5472  * for mac80211 drivers you must first use ieee80211_register_hw().
5473  *
5474  * Drivers should check the return value, its possible you can get
5475  * an -ENOMEM.
5476  *
5477  * Return: 0 on success. -ENOMEM.
5478  */
5479 int regulatory_hint(struct wiphy *wiphy, const char *alpha2);
5480 
5481 /**
5482  * regulatory_set_wiphy_regd - set regdom info for self managed drivers
5483  * @wiphy: the wireless device we want to process the regulatory domain on
5484  * @rd: the regulatory domain informatoin to use for this wiphy
5485  *
5486  * Set the regulatory domain information for self-managed wiphys, only they
5487  * may use this function. See %REGULATORY_WIPHY_SELF_MANAGED for more
5488  * information.
5489  *
5490  * Return: 0 on success. -EINVAL, -EPERM
5491  */
5492 int regulatory_set_wiphy_regd(struct wiphy *wiphy,
5493                               struct ieee80211_regdomain *rd);
5494 
5495 /**
5496  * regulatory_set_wiphy_regd_sync_rtnl - set regdom for self-managed drivers
5497  * @wiphy: the wireless device we want to process the regulatory domain on
5498  * @rd: the regulatory domain information to use for this wiphy
5499  *
5500  * This functions requires the RTNL to be held and applies the new regdomain
5501  * synchronously to this wiphy. For more details see
5502  * regulatory_set_wiphy_regd().
5503  *
5504  * Return: 0 on success. -EINVAL, -EPERM
5505  */
5506 int regulatory_set_wiphy_regd_sync_rtnl(struct wiphy *wiphy,
5507                                         struct ieee80211_regdomain *rd);
5508 
5509 /**
5510  * wiphy_apply_custom_regulatory - apply a custom driver regulatory domain
5511  * @wiphy: the wireless device we want to process the regulatory domain on
5512  * @regd: the custom regulatory domain to use for this wiphy
5513  *
5514  * Drivers can sometimes have custom regulatory domains which do not apply
5515  * to a specific country. Drivers can use this to apply such custom regulatory
5516  * domains. This routine must be called prior to wiphy registration. The
5517  * custom regulatory domain will be trusted completely and as such previous
5518  * default channel settings will be disregarded. If no rule is found for a
5519  * channel on the regulatory domain the channel will be disabled.
5520  * Drivers using this for a wiphy should also set the wiphy flag
5521  * REGULATORY_CUSTOM_REG or cfg80211 will set it for the wiphy
5522  * that called this helper.
5523  */
5524 void wiphy_apply_custom_regulatory(struct wiphy *wiphy,
5525                                    const struct ieee80211_regdomain *regd);
5526 
5527 /**
5528  * freq_reg_info - get regulatory information for the given frequency
5529  * @wiphy: the wiphy for which we want to process this rule for
5530  * @center_freq: Frequency in KHz for which we want regulatory information for
5531  *
5532  * Use this function to get the regulatory rule for a specific frequency on
5533  * a given wireless device. If the device has a specific regulatory domain
5534  * it wants to follow we respect that unless a country IE has been received
5535  * and processed already.
5536  *
5537  * Return: A valid pointer, or, when an error occurs, for example if no rule
5538  * can be found, the return value is encoded using ERR_PTR(). Use IS_ERR() to
5539  * check and PTR_ERR() to obtain the numeric return value. The numeric return
5540  * value will be -ERANGE if we determine the given center_freq does not even
5541  * have a regulatory rule for a frequency range in the center_freq's band.
5542  * See freq_in_rule_band() for our current definition of a band -- this is
5543  * purely subjective and right now it's 802.11 specific.
5544  */
5545 const struct ieee80211_reg_rule *freq_reg_info(struct wiphy *wiphy,
5546                                                u32 center_freq);
5547 
5548 /**
5549  * reg_initiator_name - map regulatory request initiator enum to name
5550  * @initiator: the regulatory request initiator
5551  *
5552  * You can use this to map the regulatory request initiator enum to a
5553  * proper string representation.
5554  */
5555 const char *reg_initiator_name(enum nl80211_reg_initiator initiator);
5556 
5557 /**
5558  * regulatory_pre_cac_allowed - check if pre-CAC allowed in the current regdom
5559  * @wiphy: wiphy for which pre-CAC capability is checked.
5560  *
5561  * Pre-CAC is allowed only in some regdomains (notable ETSI).
5562  */
5563 bool regulatory_pre_cac_allowed(struct wiphy *wiphy);
5564 
5565 /**
5566  * DOC: Internal regulatory db functions
5567  *
5568  */
5569 
5570 /**
5571  * reg_query_regdb_wmm -  Query internal regulatory db for wmm rule
5572  * Regulatory self-managed driver can use it to proactively
5573  *
5574  * @alpha2: the ISO/IEC 3166 alpha2 wmm rule to be queried.
5575  * @freq: the freqency(in MHz) to be queried.
5576  * @rule: pointer to store the wmm rule from the regulatory db.
5577  *
5578  * Self-managed wireless drivers can use this function to  query
5579  * the internal regulatory database to check whether the given
5580  * ISO/IEC 3166 alpha2 country and freq have wmm rule limitations.
5581  *
5582  * Drivers should check the return value, its possible you can get
5583  * an -ENODATA.
5584  *
5585  * Return: 0 on success. -ENODATA.
5586  */
5587 int reg_query_regdb_wmm(char *alpha2, int freq,
5588                         struct ieee80211_reg_rule *rule);
5589 
5590 /*
5591  * callbacks for asynchronous cfg80211 methods, notification
5592  * functions and BSS handling helpers
5593  */
5594 
5595 /**
5596  * cfg80211_scan_done - notify that scan finished
5597  *
5598  * @request: the corresponding scan request
5599  * @info: information about the completed scan
5600  */
5601 void cfg80211_scan_done(struct cfg80211_scan_request *request,
5602                         struct cfg80211_scan_info *info);
5603 
5604 /**
5605  * cfg80211_sched_scan_results - notify that new scan results are available
5606  *
5607  * @wiphy: the wiphy which got scheduled scan results
5608  * @reqid: identifier for the related scheduled scan request
5609  */
5610 void cfg80211_sched_scan_results(struct wiphy *wiphy, u64 reqid);
5611 
5612 /**
5613  * cfg80211_sched_scan_stopped - notify that the scheduled scan has stopped
5614  *
5615  * @wiphy: the wiphy on which the scheduled scan stopped
5616  * @reqid: identifier for the related scheduled scan request
5617  *
5618  * The driver can call this function to inform cfg80211 that the
5619  * scheduled scan had to be stopped, for whatever reason.  The driver
5620  * is then called back via the sched_scan_stop operation when done.
5621  */
5622 void cfg80211_sched_scan_stopped(struct wiphy *wiphy, u64 reqid);
5623 
5624 /**
5625  * cfg80211_sched_scan_stopped_rtnl - notify that the scheduled scan has stopped
5626  *
5627  * @wiphy: the wiphy on which the scheduled scan stopped
5628  * @reqid: identifier for the related scheduled scan request
5629  *
5630  * The driver can call this function to inform cfg80211 that the
5631  * scheduled scan had to be stopped, for whatever reason.  The driver
5632  * is then called back via the sched_scan_stop operation when done.
5633  * This function should be called with rtnl locked.
5634  */
5635 void cfg80211_sched_scan_stopped_rtnl(struct wiphy *wiphy, u64 reqid);
5636 
5637 /**
5638  * cfg80211_inform_bss_frame_data - inform cfg80211 of a received BSS frame
5639  * @wiphy: the wiphy reporting the BSS
5640  * @data: the BSS metadata
5641  * @mgmt: the management frame (probe response or beacon)
5642  * @len: length of the management frame
5643  * @gfp: context flags
5644  *
5645  * This informs cfg80211 that BSS information was found and
5646  * the BSS should be updated/added.
5647  *
5648  * Return: A referenced struct, must be released with cfg80211_put_bss()!
5649  * Or %NULL on error.
5650  */
5651 struct cfg80211_bss * __must_check
5652 cfg80211_inform_bss_frame_data(struct wiphy *wiphy,
5653                                struct cfg80211_inform_bss *data,
5654                                struct ieee80211_mgmt *mgmt, size_t len,
5655                                gfp_t gfp);
5656 
5657 static inline struct cfg80211_bss * __must_check
5658 cfg80211_inform_bss_width_frame(struct wiphy *wiphy,
5659                                 struct ieee80211_channel *rx_channel,
5660                                 enum nl80211_bss_scan_width scan_width,
5661                                 struct ieee80211_mgmt *mgmt, size_t len,
5662                                 s32 signal, gfp_t gfp)
5663 {
5664         struct cfg80211_inform_bss data = {
5665                 .chan = rx_channel,
5666                 .scan_width = scan_width,
5667                 .signal = signal,
5668         };
5669 
5670         return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
5671 }
5672 
5673 static inline struct cfg80211_bss * __must_check
5674 cfg80211_inform_bss_frame(struct wiphy *wiphy,
5675                           struct ieee80211_channel *rx_channel,
5676                           struct ieee80211_mgmt *mgmt, size_t len,
5677                           s32 signal, gfp_t gfp)
5678 {
5679         struct cfg80211_inform_bss data = {
5680                 .chan = rx_channel,
5681                 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
5682                 .signal = signal,
5683         };
5684 
5685         return cfg80211_inform_bss_frame_data(wiphy, &data, mgmt, len, gfp);
5686 }
5687 
5688 /**
5689  * cfg80211_gen_new_bssid - generate a nontransmitted BSSID for multi-BSSID
5690  * @bssid: transmitter BSSID
5691  * @max_bssid: max BSSID indicator, taken from Multiple BSSID element
5692  * @mbssid_index: BSSID index, taken from Multiple BSSID index element
5693  * @new_bssid: calculated nontransmitted BSSID
5694  */
5695 static inline void cfg80211_gen_new_bssid(const u8 *bssid, u8 max_bssid,
5696                                           u8 mbssid_index, u8 *new_bssid)
5697 {
5698         u64 bssid_u64 = ether_addr_to_u64(bssid);
5699         u64 mask = GENMASK_ULL(max_bssid - 1, 0);
5700         u64 new_bssid_u64;
5701 
5702         new_bssid_u64 = bssid_u64 & ~mask;
5703 
5704         new_bssid_u64 |= ((bssid_u64 & mask) + mbssid_index) & mask;
5705 
5706         u64_to_ether_addr(new_bssid_u64, new_bssid);
5707 }
5708 
5709 /**
5710  * cfg80211_is_element_inherited - returns if element ID should be inherited
5711  * @element: element to check
5712  * @non_inherit_element: non inheritance element
5713  */
5714 bool cfg80211_is_element_inherited(const struct element *element,
5715                                    const struct element *non_inherit_element);
5716 
5717 /**
5718  * cfg80211_merge_profile - merges a MBSSID profile if it is split between IEs
5719  * @ie: ies
5720  * @ielen: length of IEs
5721  * @mbssid_elem: current MBSSID element
5722  * @sub_elem: current MBSSID subelement (profile)
5723  * @merged_ie: location of the merged profile
5724  * @max_copy_len: max merged profile length
5725  */
5726 size_t cfg80211_merge_profile(const u8 *ie, size_t ielen,
5727                               const struct element *mbssid_elem,
5728                               const struct element *sub_elem,
5729                               u8 *merged_ie, size_t max_copy_len);
5730 
5731 /**
5732  * enum cfg80211_bss_frame_type - frame type that the BSS data came from
5733  * @CFG80211_BSS_FTYPE_UNKNOWN: driver doesn't know whether the data is
5734  *      from a beacon or probe response
5735  * @CFG80211_BSS_FTYPE_BEACON: data comes from a beacon
5736  * @CFG80211_BSS_FTYPE_PRESP: data comes from a probe response
5737  */
5738 enum cfg80211_bss_frame_type {
5739         CFG80211_BSS_FTYPE_UNKNOWN,
5740         CFG80211_BSS_FTYPE_BEACON,
5741         CFG80211_BSS_FTYPE_PRESP,
5742 };
5743 
5744 /**
5745  * cfg80211_inform_bss_data - inform cfg80211 of a new BSS
5746  *
5747  * @wiphy: the wiphy reporting the BSS
5748  * @data: the BSS metadata
5749  * @ftype: frame type (if known)
5750  * @bssid: the BSSID of the BSS
5751  * @tsf: the TSF sent by the peer in the beacon/probe response (or 0)
5752  * @capability: the capability field sent by the peer
5753  * @beacon_interval: the beacon interval announced by the peer
5754  * @ie: additional IEs sent by the peer
5755  * @ielen: length of the additional IEs
5756  * @gfp: context flags
5757  *
5758  * This informs cfg80211 that BSS information was found and
5759  * the BSS should be updated/added.
5760  *
5761  * Return: A referenced struct, must be released with cfg80211_put_bss()!
5762  * Or %NULL on error.
5763  */
5764 struct cfg80211_bss * __must_check
5765 cfg80211_inform_bss_data(struct wiphy *wiphy,
5766                          struct cfg80211_inform_bss *data,
5767                          enum cfg80211_bss_frame_type ftype,
5768                          const u8 *bssid, u64 tsf, u16 capability,
5769                          u16 beacon_interval, const u8 *ie, size_t ielen,
5770                          gfp_t gfp);
5771 
5772 static inline struct cfg80211_bss * __must_check
5773 cfg80211_inform_bss_width(struct wiphy *wiphy,
5774                           struct ieee80211_channel *rx_channel,
5775                           enum nl80211_bss_scan_width scan_width,
5776                           enum cfg80211_bss_frame_type ftype,
5777                           const u8 *bssid, u64 tsf, u16 capability,
5778                           u16 beacon_interval, const u8 *ie, size_t ielen,
5779                           s32 signal, gfp_t gfp)
5780 {
5781         struct cfg80211_inform_bss data = {
5782                 .chan = rx_channel,
5783                 .scan_width = scan_width,
5784                 .signal = signal,
5785         };
5786 
5787         return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
5788                                         capability, beacon_interval, ie, ielen,
5789                                         gfp);
5790 }
5791 
5792 static inline struct cfg80211_bss * __must_check
5793 cfg80211_inform_bss(struct wiphy *wiphy,
5794                     struct ieee80211_channel *rx_channel,
5795                     enum cfg80211_bss_frame_type ftype,
5796                     const u8 *bssid, u64 tsf, u16 capability,
5797                     u16 beacon_interval, const u8 *ie, size_t ielen,
5798                     s32 signal, gfp_t gfp)
5799 {
5800         struct cfg80211_inform_bss data = {
5801                 .chan = rx_channel,
5802                 .scan_width = NL80211_BSS_CHAN_WIDTH_20,
5803                 .signal = signal,
5804         };
5805 
5806         return cfg80211_inform_bss_data(wiphy, &data, ftype, bssid, tsf,
5807                                         capability, beacon_interval, ie, ielen,
5808                                         gfp);
5809 }
5810 
5811 /**
5812  * cfg80211_get_bss - get a BSS reference
5813  * @wiphy: the wiphy this BSS struct belongs to
5814  * @channel: the channel to search on (or %NULL)
5815  * @bssid: the desired BSSID (or %NULL)
5816  * @ssid: the desired SSID (or %NULL)
5817  * @ssid_len: length of the SSID (or 0)
5818  * @bss_type: type of BSS, see &enum ieee80211_bss_type
5819  * @privacy: privacy filter, see &enum ieee80211_privacy
5820  */
5821 struct cfg80211_bss *cfg80211_get_bss(struct wiphy *wiphy,
5822                                       struct ieee80211_channel *channel,
5823                                       const u8 *bssid,
5824                                       const u8 *ssid, size_t ssid_len,
5825                                       enum ieee80211_bss_type bss_type,
5826                                       enum ieee80211_privacy privacy);
5827 static inline struct cfg80211_bss *
5828 cfg80211_get_ibss(struct wiphy *wiphy,
5829                   struct ieee80211_channel *channel,
5830                   const u8 *ssid, size_t ssid_len)
5831 {
5832         return cfg80211_get_bss(wiphy, channel, NULL, ssid, ssid_len,
5833                                 IEEE80211_BSS_TYPE_IBSS,
5834                                 IEEE80211_PRIVACY_ANY);
5835 }
5836 
5837 /**
5838  * cfg80211_ref_bss - reference BSS struct
5839  * @wiphy: the wiphy this BSS struct belongs to
5840  * @bss: the BSS struct to reference
5841  *
5842  * Increments the refcount of the given BSS struct.
5843  */
5844 void cfg80211_ref_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5845 
5846 /**
5847  * cfg80211_put_bss - unref BSS struct
5848  * @wiphy: the wiphy this BSS struct belongs to
5849  * @bss: the BSS struct
5850  *
5851  * Decrements the refcount of the given BSS struct.
5852  */
5853 void cfg80211_put_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5854 
5855 /**
5856  * cfg80211_unlink_bss - unlink BSS from internal data structures
5857  * @wiphy: the wiphy
5858  * @bss: the bss to remove
5859  *
5860  * This function removes the given BSS from the internal data structures
5861  * thereby making it no longer show up in scan results etc. Use this
5862  * function when you detect a BSS is gone. Normally BSSes will also time
5863  * out, so it is not necessary to use this function at all.
5864  */
5865 void cfg80211_unlink_bss(struct wiphy *wiphy, struct cfg80211_bss *bss);
5866 
5867 /**
5868  * cfg80211_bss_iter - iterate all BSS entries
5869  *
5870  * This function iterates over the BSS entries associated with the given wiphy
5871  * and calls the callback for the iterated BSS. The iterator function is not
5872  * allowed to call functions that might modify the internal state of the BSS DB.
5873  *
5874  * @wiphy: the wiphy
5875  * @chandef: if given, the iterator function will be called only if the channel
5876  *     of the currently iterated BSS is a subset of the given channel.
5877  * @iter: the iterator function to call
5878  * @iter_data: an argument to the iterator function
5879  */
5880 void cfg80211_bss_iter(struct wiphy *wiphy,
5881                        struct cfg80211_chan_def *chandef,
5882                        void (*iter)(struct wiphy *wiphy,
5883                                     struct cfg80211_bss *bss,
5884                                     void *data),
5885                        void *iter_data);
5886 
5887 static inline enum nl80211_bss_scan_width
5888 cfg80211_chandef_to_scan_width(const struct cfg80211_chan_def *chandef)
5889 {
5890         switch (chandef->width) {
5891         case NL80211_CHAN_WIDTH_5:
5892                 return NL80211_BSS_CHAN_WIDTH_5;
5893         case NL80211_CHAN_WIDTH_10:
5894                 return NL80211_BSS_CHAN_WIDTH_10;
5895         default:
5896                 return NL80211_BSS_CHAN_WIDTH_20;
5897         }
5898 }
5899 
5900 /**
5901  * cfg80211_rx_mlme_mgmt - notification of processed MLME management frame
5902  * @dev: network device
5903  * @buf: authentication frame (header + body)
5904  * @len: length of the frame data
5905  *
5906  * This function is called whenever an authentication, disassociation or
5907  * deauthentication frame has been received and processed in station mode.
5908  * After being asked to authenticate via cfg80211_ops::auth() the driver must
5909  * call either this function or cfg80211_auth_timeout().
5910  * After being asked to associate via cfg80211_ops::assoc() the driver must
5911  * call either this function or cfg80211_auth_timeout().
5912  * While connected, the driver must calls this for received and processed
5913  * disassociation and deauthentication frames. If the frame couldn't be used
5914  * because it was unprotected, the driver must call the function
5915  * cfg80211_rx_unprot_mlme_mgmt() instead.
5916  *
5917  * This function may sleep. The caller must hold the corresponding wdev's mutex.
5918  */
5919 void cfg80211_rx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
5920 
5921 /**
5922  * cfg80211_auth_timeout - notification of timed out authentication
5923  * @dev: network device
5924  * @addr: The MAC address of the device with which the authentication timed out
5925  *
5926  * This function may sleep. The caller must hold the corresponding wdev's
5927  * mutex.
5928  */
5929 void cfg80211_auth_timeout(struct net_device *dev, const u8 *addr);
5930 
5931 /**
5932  * cfg80211_rx_assoc_resp - notification of processed association response
5933  * @dev: network device
5934  * @bss: the BSS that association was requested with, ownership of the pointer
5935  *      moves to cfg80211 in this call
5936  * @buf: (Re)Association Response frame (header + body)
5937  * @len: length of the frame data
5938  * @uapsd_queues: bitmap of queues configured for uapsd. Same format
5939  *      as the AC bitmap in the QoS info field
5940  * @req_ies: information elements from the (Re)Association Request frame
5941  * @req_ies_len: length of req_ies data
5942  *
5943  * After being asked to associate via cfg80211_ops::assoc() the driver must
5944  * call either this function or cfg80211_auth_timeout().
5945  *
5946  * This function may sleep. The caller must hold the corresponding wdev's mutex.
5947  */
5948 void cfg80211_rx_assoc_resp(struct net_device *dev,
5949                             struct cfg80211_bss *bss,
5950                             const u8 *buf, size_t len,
5951                             int uapsd_queues,
5952                             const u8 *req_ies, size_t req_ies_len);
5953 
5954 /**
5955  * cfg80211_assoc_timeout - notification of timed out association
5956  * @dev: network device
5957  * @bss: The BSS entry with which association timed out.
5958  *
5959  * This function may sleep. The caller must hold the corresponding wdev's mutex.
5960  */
5961 void cfg80211_assoc_timeout(struct net_device *dev, struct cfg80211_bss *bss);
5962 
5963 /**
5964  * cfg80211_abandon_assoc - notify cfg80211 of abandoned association attempt
5965  * @dev: network device
5966  * @bss: The BSS entry with which association was abandoned.
5967  *
5968  * Call this whenever - for reasons reported through other API, like deauth RX,
5969  * an association attempt was abandoned.
5970  * This function may sleep. The caller must hold the corresponding wdev's mutex.
5971  */
5972 void cfg80211_abandon_assoc(struct net_device *dev, struct cfg80211_bss *bss);
5973 
5974 /**
5975  * cfg80211_tx_mlme_mgmt - notification of transmitted deauth/disassoc frame
5976  * @dev: network device
5977  * @buf: 802.11 frame (header + body)
5978  * @len: length of the frame data
5979  *
5980  * This function is called whenever deauthentication has been processed in
5981  * station mode. This includes both received deauthentication frames and
5982  * locally generated ones. This function may sleep. The caller must hold the
5983  * corresponding wdev's mutex.
5984  */
5985 void cfg80211_tx_mlme_mgmt(struct net_device *dev, const u8 *buf, size_t len);
5986 
5987 /**
5988  * cfg80211_rx_unprot_mlme_mgmt - notification of unprotected mlme mgmt frame
5989  * @dev: network device
5990  * @buf: deauthentication frame (header + body)
5991  * @len: length of the frame data
5992  *
5993  * This function is called whenever a received deauthentication or dissassoc
5994  * frame has been dropped in station mode because of MFP being used but the
5995  * frame was not protected. This function may sleep.
5996  */
5997 void cfg80211_rx_unprot_mlme_mgmt(struct net_device *dev,
5998                                   const u8 *buf, size_t len);
5999 
6000 /**
6001  * cfg80211_michael_mic_failure - notification of Michael MIC failure (TKIP)
6002  * @dev: network device
6003  * @addr: The source MAC address of the frame
6004  * @key_type: The key type that the received frame used
6005  * @key_id: Key identifier (0..3). Can be -1 if missing.
6006  * @tsc: The TSC value of the frame that generated the MIC failure (6 octets)
6007  * @gfp: allocation flags
6008  *
6009  * This function is called whenever the local MAC detects a MIC failure in a
6010  * received frame. This matches with MLME-MICHAELMICFAILURE.indication()
6011  * primitive.
6012  */
6013 void cfg80211_michael_mic_failure(struct net_device *dev, const u8 *addr,
6014                                   enum nl80211_key_type key_type, int key_id,
6015                                   const u8 *tsc, gfp_t gfp);
6016 
6017 /**
6018  * cfg80211_ibss_joined - notify cfg80211 that device joined an IBSS
6019  *
6020  * @dev: network device
6021  * @bssid: the BSSID of the IBSS joined
6022  * @channel: the channel of the IBSS joined
6023  * @gfp: allocation flags
6024  *
6025  * This function notifies cfg80211 that the device joined an IBSS or
6026  * switched to a different BSSID. Before this function can be called,
6027  * either a beacon has to have been received from the IBSS, or one of
6028  * the cfg80211_inform_bss{,_frame} functions must have been called
6029  * with the locally generated beacon -- this guarantees that there is
6030  * always a scan result for this IBSS. cfg80211 will handle the rest.
6031  */
6032 void cfg80211_ibss_joined(struct net_device *dev, const u8 *bssid,
6033                           struct ieee80211_channel *channel, gfp_t gfp);
6034 
6035 /**
6036  * cfg80211_notify_new_candidate - notify cfg80211 of a new mesh peer candidate
6037  *
6038  * @dev: network device
6039  * @macaddr: the MAC address of the new candidate
6040  * @ie: information elements advertised by the peer candidate
6041  * @ie_len: length of the information elements buffer
6042  * @gfp: allocation flags
6043  *
6044  * This function notifies cfg80211 that the mesh peer candidate has been
6045  * detected, most likely via a beacon or, less likely, via a probe response.
6046  * cfg80211 then sends a notification to userspace.
6047  */
6048 void cfg80211_notify_new_peer_candidate(struct net_device *dev,
6049                 const u8 *macaddr, const u8 *ie, u8 ie_len,
6050                 int sig_dbm, gfp_t gfp);
6051 
6052 /**
6053  * DOC: RFkill integration
6054  *
6055  * RFkill integration in cfg80211 is almost invisible to drivers,
6056  * as cfg80211 automatically registers an rfkill instance for each
6057  * wireless device it knows about. Soft kill is also translated
6058  * into disconnecting and turning all interfaces off, drivers are
6059  * expected to turn off the device when all interfaces are down.
6060  *
6061  * However, devices may have a hard RFkill line, in which case they
6062  * also need to interact with the rfkill subsystem, via cfg80211.
6063  * They can do this with a few helper functions documented here.
6064  */
6065 
6066 /**
6067  * wiphy_rfkill_set_hw_state - notify cfg80211 about hw block state
6068  * @wiphy: the wiphy
6069  * @blocked: block status
6070  */
6071 void wiphy_rfkill_set_hw_state(struct wiphy *wiphy, bool blocked);
6072 
6073 /**
6074  * wiphy_rfkill_start_polling - start polling rfkill
6075  * @wiphy: the wiphy
6076  */
6077 void wiphy_rfkill_start_polling(struct wiphy *wiphy);
6078 
6079 /**
6080  * wiphy_rfkill_stop_polling - stop polling rfkill
6081  * @wiphy: the wiphy
6082  */
6083 void wiphy_rfkill_stop_polling(struct wiphy *wiphy);
6084 
6085 /**
6086  * DOC: Vendor commands
6087  *
6088  * Occasionally, there are special protocol or firmware features that
6089  * can't be implemented very openly. For this and similar cases, the
6090  * vendor command functionality allows implementing the features with
6091  * (typically closed-source) userspace and firmware, using nl80211 as
6092  * the configuration mechanism.
6093  *
6094  * A driver supporting vendor commands must register them as an array
6095  * in struct wiphy, with handlers for each one, each command has an
6096  * OUI and sub command ID to identify it.
6097  *
6098  * Note that this feature should not be (ab)used to implement protocol
6099  * features that could openly be shared across drivers. In particular,
6100  * it must never be required to use vendor commands to implement any
6101  * "normal" functionality that higher-level userspace like connection
6102  * managers etc. need.
6103  */
6104 
6105 struct sk_buff *__cfg80211_alloc_reply_skb(struct wiphy *wiphy,
6106                                            enum nl80211_commands cmd,
6107                                            enum nl80211_attrs attr,
6108                                            int approxlen);
6109 
6110 struct sk_buff *__cfg80211_alloc_event_skb(struct wiphy *wiphy,
6111                                            struct wireless_dev *wdev,
6112                                            enum nl80211_commands cmd,
6113                                            enum nl80211_attrs attr,
6114                                            unsigned int portid,
6115                                            int vendor_event_idx,
6116                                            int approxlen, gfp_t gfp);
6117 
6118 void __cfg80211_send_event_skb(struct sk_buff *skb, gfp_t gfp);
6119 
6120 /**
6121  * cfg80211_vendor_cmd_alloc_reply_skb - allocate vendor command reply
6122  * @wiphy: the wiphy
6123  * @approxlen: an upper bound of the length of the data that will
6124  *      be put into the skb
6125  *
6126  * This function allocates and pre-fills an skb for a reply to
6127  * a vendor command. Since it is intended for a reply, calling
6128  * it outside of a vendor command's doit() operation is invalid.
6129  *
6130  * The returned skb is pre-filled with some identifying data in
6131  * a way that any data that is put into the skb (with skb_put(),
6132  * nla_put() or similar) will end up being within the
6133  * %NL80211_ATTR_VENDOR_DATA attribute, so all that needs to be done
6134  * with the skb is adding data for the corresponding userspace tool
6135  * which can then read that data out of the vendor data attribute.
6136  * You must not modify the skb in any other way.
6137  *
6138  * When done, call cfg80211_vendor_cmd_reply() with the skb and return
6139  * its error code as the result of the doit() operation.
6140  *
6141  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6142  */
6143 static inline struct sk_buff *
6144 cfg80211_vendor_cmd_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6145 {
6146         return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_VENDOR,
6147                                           NL80211_ATTR_VENDOR_DATA, approxlen);
6148 }
6149 
6150 /**
6151  * cfg80211_vendor_cmd_reply - send the reply skb
6152  * @skb: The skb, must have been allocated with
6153  *      cfg80211_vendor_cmd_alloc_reply_skb()
6154  *
6155  * Since calling this function will usually be the last thing
6156  * before returning from the vendor command doit() you should
6157  * return the error code.  Note that this function consumes the
6158  * skb regardless of the return value.
6159  *
6160  * Return: An error code or 0 on success.
6161  */
6162 int cfg80211_vendor_cmd_reply(struct sk_buff *skb);
6163 
6164 /**
6165  * cfg80211_vendor_cmd_get_sender
6166  * @wiphy: the wiphy
6167  *
6168  * Return the current netlink port ID in a vendor command handler.
6169  * Valid to call only there.
6170  */
6171 unsigned int cfg80211_vendor_cmd_get_sender(struct wiphy *wiphy);
6172 
6173 /**
6174  * cfg80211_vendor_event_alloc - allocate vendor-specific event skb
6175  * @wiphy: the wiphy
6176  * @wdev: the wireless device
6177  * @event_idx: index of the vendor event in the wiphy's vendor_events
6178  * @approxlen: an upper bound of the length of the data that will
6179  *      be put into the skb
6180  * @gfp: allocation flags
6181  *
6182  * This function allocates and pre-fills an skb for an event on the
6183  * vendor-specific multicast group.
6184  *
6185  * If wdev != NULL, both the ifindex and identifier of the specified
6186  * wireless device are added to the event message before the vendor data
6187  * attribute.
6188  *
6189  * When done filling the skb, call cfg80211_vendor_event() with the
6190  * skb to send the event.
6191  *
6192  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6193  */
6194 static inline struct sk_buff *
6195 cfg80211_vendor_event_alloc(struct wiphy *wiphy, struct wireless_dev *wdev,
6196                              int approxlen, int event_idx, gfp_t gfp)
6197 {
6198         return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6199                                           NL80211_ATTR_VENDOR_DATA,
6200                                           0, event_idx, approxlen, gfp);
6201 }
6202 
6203 /**
6204  * cfg80211_vendor_event_alloc_ucast - alloc unicast vendor-specific event skb
6205  * @wiphy: the wiphy
6206  * @wdev: the wireless device
6207  * @event_idx: index of the vendor event in the wiphy's vendor_events
6208  * @portid: port ID of the receiver
6209  * @approxlen: an upper bound of the length of the data that will
6210  *      be put into the skb
6211  * @gfp: allocation flags
6212  *
6213  * This function allocates and pre-fills an skb for an event to send to
6214  * a specific (userland) socket. This socket would previously have been
6215  * obtained by cfg80211_vendor_cmd_get_sender(), and the caller MUST take
6216  * care to register a netlink notifier to see when the socket closes.
6217  *
6218  * If wdev != NULL, both the ifindex and identifier of the specified
6219  * wireless device are added to the event message before the vendor data
6220  * attribute.
6221  *
6222  * When done filling the skb, call cfg80211_vendor_event() with the
6223  * skb to send the event.
6224  *
6225  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6226  */
6227 static inline struct sk_buff *
6228 cfg80211_vendor_event_alloc_ucast(struct wiphy *wiphy,
6229                                   struct wireless_dev *wdev,
6230                                   unsigned int portid, int approxlen,
6231                                   int event_idx, gfp_t gfp)
6232 {
6233         return __cfg80211_alloc_event_skb(wiphy, wdev, NL80211_CMD_VENDOR,
6234                                           NL80211_ATTR_VENDOR_DATA,
6235                                           portid, event_idx, approxlen, gfp);
6236 }
6237 
6238 /**
6239  * cfg80211_vendor_event - send the event
6240  * @skb: The skb, must have been allocated with cfg80211_vendor_event_alloc()
6241  * @gfp: allocation flags
6242  *
6243  * This function sends the given @skb, which must have been allocated
6244  * by cfg80211_vendor_event_alloc(), as an event. It always consumes it.
6245  */
6246 static inline void cfg80211_vendor_event(struct sk_buff *skb, gfp_t gfp)
6247 {
6248         __cfg80211_send_event_skb(skb, gfp);
6249 }
6250 
6251 #ifdef CONFIG_NL80211_TESTMODE
6252 /**
6253  * DOC: Test mode
6254  *
6255  * Test mode is a set of utility functions to allow drivers to
6256  * interact with driver-specific tools to aid, for instance,
6257  * factory programming.
6258  *
6259  * This chapter describes how drivers interact with it, for more
6260  * information see the nl80211 book's chapter on it.
6261  */
6262 
6263 /**
6264  * cfg80211_testmode_alloc_reply_skb - allocate testmode reply
6265  * @wiphy: the wiphy
6266  * @approxlen: an upper bound of the length of the data that will
6267  *      be put into the skb
6268  *
6269  * This function allocates and pre-fills an skb for a reply to
6270  * the testmode command. Since it is intended for a reply, calling
6271  * it outside of the @testmode_cmd operation is invalid.
6272  *
6273  * The returned skb is pre-filled with the wiphy index and set up in
6274  * a way that any data that is put into the skb (with skb_put(),
6275  * nla_put() or similar) will end up being within the
6276  * %NL80211_ATTR_TESTDATA attribute, so all that needs to be done
6277  * with the skb is adding data for the corresponding userspace tool
6278  * which can then read that data out of the testdata attribute. You
6279  * must not modify the skb in any other way.
6280  *
6281  * When done, call cfg80211_testmode_reply() with the skb and return
6282  * its error code as the result of the @testmode_cmd operation.
6283  *
6284  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6285  */
6286 static inline struct sk_buff *
6287 cfg80211_testmode_alloc_reply_skb(struct wiphy *wiphy, int approxlen)
6288 {
6289         return __cfg80211_alloc_reply_skb(wiphy, NL80211_CMD_TESTMODE,
6290                                           NL80211_ATTR_TESTDATA, approxlen);
6291 }
6292 
6293 /**
6294  * cfg80211_testmode_reply - send the reply skb
6295  * @skb: The skb, must have been allocated with
6296  *      cfg80211_testmode_alloc_reply_skb()
6297  *
6298  * Since calling this function will usually be the last thing
6299  * before returning from the @testmode_cmd you should return
6300  * the error code.  Note that this function consumes the skb
6301  * regardless of the return value.
6302  *
6303  * Return: An error code or 0 on success.
6304  */
6305 static inline int cfg80211_testmode_reply(struct sk_buff *skb)
6306 {
6307         return cfg80211_vendor_cmd_reply(skb);
6308 }
6309 
6310 /**
6311  * cfg80211_testmode_alloc_event_skb - allocate testmode event
6312  * @wiphy: the wiphy
6313  * @approxlen: an upper bound of the length of the data that will
6314  *      be put into the skb
6315  * @gfp: allocation flags
6316  *
6317  * This function allocates and pre-fills an skb for an event on the
6318  * testmode multicast group.
6319  *
6320  * The returned skb is set up in the same way as with
6321  * cfg80211_testmode_alloc_reply_skb() but prepared for an event. As
6322  * there, you should simply add data to it that will then end up in the
6323  * %NL80211_ATTR_TESTDATA attribute. Again, you must not modify the skb
6324  * in any other way.
6325  *
6326  * When done filling the skb, call cfg80211_testmode_event() with the
6327  * skb to send the event.
6328  *
6329  * Return: An allocated and pre-filled skb. %NULL if any errors happen.
6330  */
6331 static inline struct sk_buff *
6332 cfg80211_testmode_alloc_event_skb(struct wiphy *wiphy, int approxlen, gfp_t gfp)
6333 {
6334         return __cfg80211_alloc_event_skb(wiphy, NULL, NL80211_CMD_TESTMODE,
6335                                           NL80211_ATTR_TESTDATA, 0, -1,
6336                                           approxlen, gfp);
6337 }
6338 
6339 /**
6340  * cfg80211_testmode_event - send the event
6341  * @skb: The skb, must have been allocated with
6342  *      cfg80211_testmode_alloc_event_skb()
6343  * @gfp: allocation flags
6344  *
6345  * This function sends the given @skb, which must have been allocated
6346  * by cfg80211_testmode_alloc_event_skb(), as an event. It always
6347  * consumes it.
6348  */
6349 static inline void cfg80211_testmode_event(struct sk_buff *skb, gfp_t gfp)
6350 {
6351         __cfg80211_send_event_skb(skb, gfp);
6352 }
6353 
6354 #define CFG80211_TESTMODE_CMD(cmd)      .testmode_cmd = (cmd),
6355 #define CFG80211_TESTMODE_DUMP(cmd)     .testmode_dump = (cmd),
6356 #else
6357 #define CFG80211_TESTMODE_CMD(cmd)
6358 #define CFG80211_TESTMODE_DUMP(cmd)
6359 #endif
6360 
6361 /**
6362  * struct cfg80211_fils_resp_params - FILS connection response params
6363  * @kek: KEK derived from a successful FILS connection (may be %NULL)
6364  * @kek_len: Length of @fils_kek in octets
6365  * @update_erp_next_seq_num: Boolean value to specify whether the value in
6366  *      @erp_next_seq_num is valid.
6367  * @erp_next_seq_num: The next sequence number to use in ERP message in
6368  *      FILS Authentication. This value should be specified irrespective of the
6369  *      status for a FILS connection.
6370  * @pmk: A new PMK if derived from a successful FILS connection (may be %NULL).
6371  * @pmk_len: Length of @pmk in octets
6372  * @pmkid: A new PMKID if derived from a successful FILS connection or the PMKID
6373  *      used for this FILS connection (may be %NULL).
6374  */
6375 struct cfg80211_fils_resp_params {
6376         const u8 *kek;
6377         size_t kek_len;
6378         bool update_erp_next_seq_num;
6379         u16 erp_next_seq_num;
6380         const u8 *pmk;
6381         size_t pmk_len;
6382         const u8 *pmkid;
6383 };
6384 
6385 /**
6386  * struct cfg80211_connect_resp_params - Connection response params
6387  * @status: Status code, %WLAN_STATUS_SUCCESS for successful connection, use
6388  *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6389  *      the real status code for failures. If this call is used to report a
6390  *      failure due to a timeout (e.g., not receiving an Authentication frame
6391  *      from the AP) instead of an explicit rejection by the AP, -1 is used to
6392  *      indicate that this is a failure, but without a status code.
6393  *      @timeout_reason is used to report the reason for the timeout in that
6394  *      case.
6395  * @bssid: The BSSID of the AP (may be %NULL)
6396  * @bss: Entry of bss to which STA got connected to, can be obtained through
6397  *      cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6398  *      bss from the connect_request and hold a reference to it and return
6399  *      through this param to avoid a warning if the bss is expired during the
6400  *      connection, esp. for those drivers implementing connect op.
6401  *      Only one parameter among @bssid and @bss needs to be specified.
6402  * @req_ie: Association request IEs (may be %NULL)
6403  * @req_ie_len: Association request IEs length
6404  * @resp_ie: Association response IEs (may be %NULL)
6405  * @resp_ie_len: Association response IEs length
6406  * @fils: FILS connection response parameters.
6407  * @timeout_reason: Reason for connection timeout. This is used when the
6408  *      connection fails due to a timeout instead of an explicit rejection from
6409  *      the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6410  *      not known. This value is used only if @status < 0 to indicate that the
6411  *      failure is due to a timeout and not due to explicit rejection by the AP.
6412  *      This value is ignored in other cases (@status >= 0).
6413  */
6414 struct cfg80211_connect_resp_params {
6415         int status;
6416         const u8 *bssid;
6417         struct cfg80211_bss *bss;
6418         const u8 *req_ie;
6419         size_t req_ie_len;
6420         const u8 *resp_ie;
6421         size_t resp_ie_len;
6422         struct cfg80211_fils_resp_params fils;
6423         enum nl80211_timeout_reason timeout_reason;
6424 };
6425 
6426 /**
6427  * cfg80211_connect_done - notify cfg80211 of connection result
6428  *
6429  * @dev: network device
6430  * @params: connection response parameters
6431  * @gfp: allocation flags
6432  *
6433  * It should be called by the underlying driver once execution of the connection
6434  * request from connect() has been completed. This is similar to
6435  * cfg80211_connect_bss(), but takes a structure pointer for connection response
6436  * parameters. Only one of the functions among cfg80211_connect_bss(),
6437  * cfg80211_connect_result(), cfg80211_connect_timeout(),
6438  * and cfg80211_connect_done() should be called.
6439  */
6440 void cfg80211_connect_done(struct net_device *dev,
6441                            struct cfg80211_connect_resp_params *params,
6442                            gfp_t gfp);
6443 
6444 /**
6445  * cfg80211_connect_bss - notify cfg80211 of connection result
6446  *
6447  * @dev: network device
6448  * @bssid: the BSSID of the AP
6449  * @bss: Entry of bss to which STA got connected to, can be obtained through
6450  *      cfg80211_get_bss() (may be %NULL). But it is recommended to store the
6451  *      bss from the connect_request and hold a reference to it and return
6452  *      through this param to avoid a warning if the bss is expired during the
6453  *      connection, esp. for those drivers implementing connect op.
6454  *      Only one parameter among @bssid and @bss needs to be specified.
6455  * @req_ie: association request IEs (maybe be %NULL)
6456  * @req_ie_len: association request IEs length
6457  * @resp_ie: association response IEs (may be %NULL)
6458  * @resp_ie_len: assoc response IEs length
6459  * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6460  *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6461  *      the real status code for failures. If this call is used to report a
6462  *      failure due to a timeout (e.g., not receiving an Authentication frame
6463  *      from the AP) instead of an explicit rejection by the AP, -1 is used to
6464  *      indicate that this is a failure, but without a status code.
6465  *      @timeout_reason is used to report the reason for the timeout in that
6466  *      case.
6467  * @gfp: allocation flags
6468  * @timeout_reason: reason for connection timeout. This is used when the
6469  *      connection fails due to a timeout instead of an explicit rejection from
6470  *      the AP. %NL80211_TIMEOUT_UNSPECIFIED is used when the timeout reason is
6471  *      not known. This value is used only if @status < 0 to indicate that the
6472  *      failure is due to a timeout and not due to explicit rejection by the AP.
6473  *      This value is ignored in other cases (@status >= 0).
6474  *
6475  * It should be called by the underlying driver once execution of the connection
6476  * request from connect() has been completed. This is similar to
6477  * cfg80211_connect_result(), but with the option of identifying the exact bss
6478  * entry for the connection. Only one of the functions among
6479  * cfg80211_connect_bss(), cfg80211_connect_result(),
6480  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6481  */
6482 static inline void
6483 cfg80211_connect_bss(struct net_device *dev, const u8 *bssid,
6484                      struct cfg80211_bss *bss, const u8 *req_ie,
6485                      size_t req_ie_len, const u8 *resp_ie,
6486                      size_t resp_ie_len, int status, gfp_t gfp,
6487                      enum nl80211_timeout_reason timeout_reason)
6488 {
6489         struct cfg80211_connect_resp_params params;
6490 
6491         memset(&params, 0, sizeof(params));
6492         params.status = status;
6493         params.bssid = bssid;
6494         params.bss = bss;
6495         params.req_ie = req_ie;
6496         params.req_ie_len = req_ie_len;
6497         params.resp_ie = resp_ie;
6498         params.resp_ie_len = resp_ie_len;
6499         params.timeout_reason = timeout_reason;
6500 
6501         cfg80211_connect_done(dev, &params, gfp);
6502 }
6503 
6504 /**
6505  * cfg80211_connect_result - notify cfg80211 of connection result
6506  *
6507  * @dev: network device
6508  * @bssid: the BSSID of the AP
6509  * @req_ie: association request IEs (maybe be %NULL)
6510  * @req_ie_len: association request IEs length
6511  * @resp_ie: association response IEs (may be %NULL)
6512  * @resp_ie_len: assoc response IEs length
6513  * @status: status code, %WLAN_STATUS_SUCCESS for successful connection, use
6514  *      %WLAN_STATUS_UNSPECIFIED_FAILURE if your device cannot give you
6515  *      the real status code for failures.
6516  * @gfp: allocation flags
6517  *
6518  * It should be called by the underlying driver once execution of the connection
6519  * request from connect() has been completed. This is similar to
6520  * cfg80211_connect_bss() which allows the exact bss entry to be specified. Only
6521  * one of the functions among cfg80211_connect_bss(), cfg80211_connect_result(),
6522  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6523  */
6524 static inline void
6525 cfg80211_connect_result(struct net_device *dev, const u8 *bssid,
6526                         const u8 *req_ie, size_t req_ie_len,
6527                         const u8 *resp_ie, size_t resp_ie_len,
6528                         u16 status, gfp_t gfp)
6529 {
6530         cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, resp_ie,
6531                              resp_ie_len, status, gfp,
6532                              NL80211_TIMEOUT_UNSPECIFIED);
6533 }
6534 
6535 /**
6536  * cfg80211_connect_timeout - notify cfg80211 of connection timeout
6537  *
6538  * @dev: network device
6539  * @bssid: the BSSID of the AP
6540  * @req_ie: association request IEs (maybe be %NULL)
6541  * @req_ie_len: association request IEs length
6542  * @gfp: allocation flags
6543  * @timeout_reason: reason for connection timeout.
6544  *
6545  * It should be called by the underlying driver whenever connect() has failed
6546  * in a sequence where no explicit authentication/association rejection was
6547  * received from the AP. This could happen, e.g., due to not being able to send
6548  * out the Authentication or Association Request frame or timing out while
6549  * waiting for the response. Only one of the functions among
6550  * cfg80211_connect_bss(), cfg80211_connect_result(),
6551  * cfg80211_connect_timeout(), and cfg80211_connect_done() should be called.
6552  */
6553 static inline void
6554 cfg80211_connect_timeout(struct net_device *dev, const u8 *bssid,
6555                          const u8 *req_ie, size_t req_ie_len, gfp_t gfp,
6556                          enum nl80211_timeout_reason timeout_reason)
6557 {
6558         cfg80211_connect_bss(dev, bssid, NULL, req_ie, req_ie_len, NULL, 0, -1,
6559                              gfp, timeout_reason);
6560 }
6561 
6562 /**
6563  * struct cfg80211_roam_info - driver initiated roaming information
6564  *
6565  * @channel: the channel of the new AP
6566  * @bss: entry of bss to which STA got roamed (may be %NULL if %bssid is set)
6567  * @bssid: the BSSID of the new AP (may be %NULL if %bss is set)
6568  * @req_ie: association request IEs (maybe be %NULL)
6569  * @req_ie_len: association request IEs length
6570  * @resp_ie: association response IEs (may be %NULL)
6571  * @resp_ie_len: assoc response IEs length
6572  * @fils: FILS related roaming information.
6573  */
6574 struct cfg80211_roam_info {
6575         struct ieee80211_channel *channel;
6576         struct cfg80211_bss *bss;
6577         const u8 *bssid;
6578         const u8 *req_ie;
6579         size_t req_ie_len;
6580         const u8 *resp_ie;
6581         size_t resp_ie_len;
6582         struct cfg80211_fils_resp_params fils;
6583 };
6584 
6585 /**
6586  * cfg80211_roamed - notify cfg80211 of roaming
6587  *
6588  * @dev: network device
6589  * @info: information about the new BSS. struct &cfg80211_roam_info.
6590  * @gfp: allocation flags
6591  *
6592  * This function may be called with the driver passing either the BSSID of the
6593  * new AP or passing the bss entry to avoid a race in timeout of the bss entry.
6594  * It should be called by the underlying driver whenever it roamed from one AP
6595  * to another while connected. Drivers which have roaming implemented in
6596  * firmware should pass the bss entry to avoid a race in bss entry timeout where
6597  * the bss entry of the new AP is seen in the driver, but gets timed out by the
6598  * time it is accessed in __cfg80211_roamed() due to delay in scheduling
6599  * rdev->event_work. In case of any failures, the reference is released
6600  * either in cfg80211_roamed() or in __cfg80211_romed(), Otherwise, it will be
6601  * released while diconneting from the current bss.
6602  */
6603 void cfg80211_roamed(struct net_device *dev, struct cfg80211_roam_info *info,
6604                      gfp_t gfp);
6605 
6606 /**
6607  * cfg80211_port_authorized - notify cfg80211 of successful security association
6608  *
6609  * @dev: network device
6610  * @bssid: the BSSID of the AP
6611  * @gfp: allocation flags
6612  *
6613  * This function should be called by a driver that supports 4 way handshake
6614  * offload after a security association was successfully established (i.e.,
6615  * the 4 way handshake was completed successfully). The call to this function
6616  * should be preceded with a call to cfg80211_connect_result(),
6617  * cfg80211_connect_done(), cfg80211_connect_bss() or cfg80211_roamed() to
6618  * indicate the 802.11 association.
6619  */
6620 void cfg80211_port_authorized(struct net_device *dev, const u8 *bssid,
6621                               gfp_t gfp);
6622 
6623 /**
6624  * cfg80211_disconnected - notify cfg80211 that connection was dropped
6625  *
6626  * @dev: network device
6627  * @ie: information elements of the deauth/disassoc frame (may be %NULL)
6628  * @ie_len: length of IEs
6629  * @reason: reason code for the disconnection, set it to 0 if unknown
6630  * @locally_generated: disconnection was requested locally
6631  * @gfp: allocation flags
6632  *
6633  * After it calls this function, the driver should enter an idle state
6634  * and not try to connect to any AP any more.
6635  */
6636 void cfg80211_disconnected(struct net_device *dev, u16 reason,
6637                            const u8 *ie, size_t ie_len,
6638                            bool locally_generated, gfp_t gfp);
6639 
6640 /**
6641  * cfg80211_ready_on_channel - notification of remain_on_channel start
6642  * @wdev: wireless device
6643  * @cookie: the request cookie
6644  * @chan: The current channel (from remain_on_channel request)
6645  * @duration: Duration in milliseconds that the driver intents to remain on the
6646  *      channel
6647  * @gfp: allocation flags
6648  */
6649 void cfg80211_ready_on_channel(struct wireless_dev *wdev, u64 cookie,
6650                                struct ieee80211_channel *chan,
6651                                unsigned int duration, gfp_t gfp);
6652 
6653 /**
6654  * cfg80211_remain_on_channel_expired - remain_on_channel duration expired
6655  * @wdev: wireless device
6656  * @cookie: the request cookie
6657  * @chan: The current channel (from remain_on_channel request)
6658  * @gfp: allocation flags
6659  */
6660 void cfg80211_remain_on_channel_expired(struct wireless_dev *wdev, u64 cookie,
6661                                         struct ieee80211_channel *chan,
6662                                         gfp_t gfp);
6663 
6664 /**
6665  * cfg80211_tx_mgmt_expired - tx_mgmt duration expired
6666  * @wdev: wireless device
6667  * @cookie: the requested cookie
6668  * @chan: The current channel (from tx_mgmt request)
6669  * @gfp: allocation flags
6670  */
6671 void cfg80211_tx_mgmt_expired(struct wireless_dev *wdev, u64 cookie,
6672                               struct ieee80211_channel *chan, gfp_t gfp);
6673 
6674 /**
6675  * cfg80211_sinfo_alloc_tid_stats - allocate per-tid statistics.
6676  *
6677  * @sinfo: the station information
6678  * @gfp: allocation flags
6679  */
6680 int cfg80211_sinfo_alloc_tid_stats(struct station_info *sinfo, gfp_t gfp);
6681 
6682 /**
6683  * cfg80211_sinfo_release_content - release contents of station info
6684  * @sinfo: the station information
6685  *
6686  * Releases any potentially allocated sub-information of the station
6687  * information, but not the struct itself (since it's typically on
6688  * the stack.)
6689  */
6690 static inline void cfg80211_sinfo_release_content(struct station_info *sinfo)
6691 {
6692         kfree(sinfo->pertid);
6693 }
6694 
6695 /**
6696  * cfg80211_new_sta - notify userspace about station
6697  *
6698  * @dev: the netdev
6699  * @mac_addr: the station's address
6700  * @sinfo: the station information
6701  * @gfp: allocation flags
6702  */
6703 void cfg80211_new_sta(struct net_device *dev, const u8 *mac_addr,
6704                       struct station_info *sinfo, gfp_t gfp);
6705 
6706 /**
6707  * cfg80211_del_sta_sinfo - notify userspace about deletion of a station
6708  * @dev: the netdev
6709  * @mac_addr: the station's address
6710  * @sinfo: the station information/statistics
6711  * @gfp: allocation flags
6712  */
6713 void cfg80211_del_sta_sinfo(struct net_device *dev, const u8 *mac_addr,
6714                             struct station_info *sinfo, gfp_t gfp);
6715 
6716 /**
6717  * cfg80211_del_sta - notify userspace about deletion of a station
6718  *
6719  * @dev: the netdev
6720  * @mac_addr: the station's address
6721  * @gfp: allocation flags
6722  */
6723 static inline void cfg80211_del_sta(struct net_device *dev,
6724                                     const u8 *mac_addr, gfp_t gfp)
6725 {
6726         cfg80211_del_sta_sinfo(dev, mac_addr, NULL, gfp);
6727 }
6728 
6729 /**
6730  * cfg80211_conn_failed - connection request failed notification
6731  *
6732  * @dev: the netdev
6733  * @mac_addr: the station's address
6734  * @reason: the reason for connection failure
6735  * @gfp: allocation flags
6736  *
6737  * Whenever a station tries to connect to an AP and if the station
6738  * could not connect to the AP as the AP has rejected the connection
6739  * for some reasons, this function is called.
6740  *
6741  * The reason for connection failure can be any of the value from
6742  * nl80211_connect_failed_reason enum
6743  */
6744 void cfg80211_conn_failed(struct net_device *dev, const u8 *mac_addr,
6745                           enum nl80211_connect_failed_reason reason,
6746                           gfp_t gfp);
6747 
6748 /**
6749  * cfg80211_rx_mgmt - notification of received, unprocessed management frame
6750  * @wdev: wireless device receiving the frame
6751  * @freq: Frequency on which the frame was received in MHz
6752  * @sig_dbm: signal strength in dBm, or 0 if unknown
6753  * @buf: Management frame (header + body)
6754  * @len: length of the frame data
6755  * @flags: flags, as defined in enum nl80211_rxmgmt_flags
6756  *
6757  * This function is called whenever an Action frame is received for a station
6758  * mode interface, but is not processed in kernel.
6759  *
6760  * Return: %true if a user space application has registered for this frame.
6761  * For action frames, that makes it responsible for rejecting unrecognized
6762  * action frames; %false otherwise, in which case for action frames the
6763  * driver is responsible for rejecting the frame.
6764  */
6765 bool cfg80211_rx_mgmt(struct wireless_dev *wdev, int freq, int sig_dbm,
6766                       const u8 *buf, size_t len, u32 flags);
6767 
6768 /**
6769  * cfg80211_mgmt_tx_status - notification of TX status for management frame
6770  * @wdev: wireless device receiving the frame
6771  * @cookie: Cookie returned by cfg80211_ops::mgmt_tx()
6772  * @buf: Management frame (header + body)
6773  * @len: length of the frame data
6774  * @ack: Whether frame was acknowledged
6775  * @gfp: context flags
6776  *
6777  * This function is called whenever a management frame was requested to be
6778  * transmitted with cfg80211_ops::mgmt_tx() to report the TX status of the
6779  * transmission attempt.
6780  */
6781 void cfg80211_mgmt_tx_status(struct wireless_dev *wdev, u64 cookie,
6782                              const u8 *buf, size_t len, bool ack, gfp_t gfp);
6783 
6784 
6785 /**
6786  * cfg80211_rx_control_port - notification about a received control port frame
6787  * @dev: The device the frame matched to
6788  * @skb: The skbuf with the control port frame.  It is assumed that the skbuf
6789  *      is 802.3 formatted (with 802.3 header).  The skb can be non-linear.
6790  *      This function does not take ownership of the skb, so the caller is
6791  *      responsible for any cleanup.  The caller must also ensure that
6792  *      skb->protocol is set appropriately.
6793  * @unencrypted: Whether the frame was received unencrypted
6794  *
6795  * This function is used to inform userspace about a received control port
6796  * frame.  It should only be used if userspace indicated it wants to receive
6797  * control port frames over nl80211.
6798  *
6799  * The frame is the data portion of the 802.3 or 802.11 data frame with all
6800  * network layer headers removed (e.g. the raw EAPoL frame).
6801  *
6802  * Return: %true if the frame was passed to userspace
6803  */
6804 bool cfg80211_rx_control_port(struct net_device *dev,
6805                               struct sk_buff *skb, bool unencrypted);
6806 
6807 /**
6808  * cfg80211_cqm_rssi_notify - connection quality monitoring rssi event
6809  * @dev: network device
6810  * @rssi_event: the triggered RSSI event
6811  * @rssi_level: new RSSI level value or 0 if not available
6812  * @gfp: context flags
6813  *
6814  * This function is called when a configured connection quality monitoring
6815  * rssi threshold reached event occurs.
6816  */
6817 void cfg80211_cqm_rssi_notify(struct net_device *dev,
6818                               enum nl80211_cqm_rssi_threshold_event rssi_event,
6819                               s32 rssi_level, gfp_t gfp);
6820 
6821 /**
6822  * cfg80211_cqm_pktloss_notify - notify userspace about packetloss to peer
6823  * @dev: network device
6824  * @peer: peer's MAC address
6825  * @num_packets: how many packets were lost -- should be a fixed threshold
6826  *      but probably no less than maybe 50, or maybe a throughput dependent
6827  *      threshold (to account for temporary interference)
6828  * @gfp: context flags
6829  */
6830 void cfg80211_cqm_pktloss_notify(struct net_device *dev,
6831                                  const u8 *peer, u32 num_packets, gfp_t gfp);
6832 
6833 /**
6834  * cfg80211_cqm_txe_notify - TX error rate event
6835  * @dev: network device
6836  * @peer: peer's MAC address
6837  * @num_packets: how many packets were lost
6838  * @rate: % of packets which failed transmission
6839  * @intvl: interval (in s) over which the TX failure threshold was breached.
6840  * @gfp: context flags
6841  *
6842  * Notify userspace when configured % TX failures over number of packets in a
6843  * given interval is exceeded.
6844  */
6845 void cfg80211_cqm_txe_notify(struct net_device *dev, const u8 *peer,
6846                              u32 num_packets, u32 rate, u32 intvl, gfp_t gfp);
6847 
6848 /**
6849  * cfg80211_cqm_beacon_loss_notify - beacon loss event
6850  * @dev: network device
6851  * @gfp: context flags
6852  *
6853  * Notify userspace about beacon loss from the connected AP.
6854  */
6855 void cfg80211_cqm_beacon_loss_notify(struct net_device *dev, gfp_t gfp);
6856 
6857 /**
6858  * cfg80211_radar_event - radar detection event
6859  * @wiphy: the wiphy
6860  * @chandef: chandef for the current channel
6861  * @gfp: context flags
6862  *
6863  * This function is called when a radar is detected on the current chanenl.
6864  */
6865 void cfg80211_radar_event(struct wiphy *wiphy,
6866                           struct cfg80211_chan_def *chandef, gfp_t gfp);
6867 
6868 /**
6869  * cfg80211_sta_opmode_change_notify - STA's ht/vht operation mode change event
6870  * @dev: network device
6871  * @mac: MAC address of a station which opmode got modified
6872  * @sta_opmode: station's current opmode value
6873  * @gfp: context flags
6874  *
6875  * Driver should call this function when station's opmode modified via action
6876  * frame.
6877  */
6878 void cfg80211_sta_opmode_change_notify(struct net_device *dev, const u8 *mac,
6879                                        struct sta_opmode_info *sta_opmode,
6880                                        gfp_t gfp);
6881 
6882 /**
6883  * cfg80211_cac_event - Channel availability check (CAC) event
6884  * @netdev: network device
6885  * @chandef: chandef for the current channel
6886  * @event: type of event
6887  * @gfp: context flags
6888  *
6889  * This function is called when a Channel availability check (CAC) is finished
6890  * or aborted. This must be called to notify the completion of a CAC process,
6891  * also by full-MAC drivers.
6892  */
6893 void cfg80211_cac_event(struct net_device *netdev,
6894                         const struct cfg80211_chan_def *chandef,
6895                         enum nl80211_radar_event event, gfp_t gfp);
6896 
6897 
6898 /**
6899  * cfg80211_gtk_rekey_notify - notify userspace about driver rekeying
6900  * @dev: network device
6901  * @bssid: BSSID of AP (to avoid races)
6902  * @replay_ctr: new replay counter
6903  * @gfp: allocation flags
6904  */
6905 void cfg80211_gtk_rekey_notify(struct net_device *dev, const u8 *bssid,
6906                                const u8 *replay_ctr, gfp_t gfp);
6907 
6908 /**
6909  * cfg80211_pmksa_candidate_notify - notify about PMKSA caching candidate
6910  * @dev: network device
6911  * @index: candidate index (the smaller the index, the higher the priority)
6912  * @bssid: BSSID of AP
6913  * @preauth: Whether AP advertises support for RSN pre-authentication
6914  * @gfp: allocation flags
6915  */
6916 void cfg80211_pmksa_candidate_notify(struct net_device *dev, int index,
6917                                      const u8 *bssid, bool preauth, gfp_t gfp);
6918 
6919 /**
6920  * cfg80211_rx_spurious_frame - inform userspace about a spurious frame
6921  * @dev: The device the frame matched to
6922  * @addr: the transmitter address
6923  * @gfp: context flags
6924  *
6925  * This function is used in AP mode (only!) to inform userspace that
6926  * a spurious class 3 frame was received, to be able to deauth the
6927  * sender.
6928  * Return: %true if the frame was passed to userspace (or this failed
6929  * for a reason other than not having a subscription.)
6930  */
6931 bool cfg80211_rx_spurious_frame(struct net_device *dev,
6932                                 const u8 *addr, gfp_t gfp);
6933 
6934 /**
6935  * cfg80211_rx_unexpected_4addr_frame - inform about unexpected WDS frame
6936  * @dev: The device the frame matched to
6937  * @addr: the transmitter address
6938  * @gfp: context flags
6939  *
6940  * This function is used in AP mode (only!) to inform userspace that
6941  * an associated station sent a 4addr frame but that wasn't expected.
6942  * It is allowed and desirable to send this event only once for each
6943  * station to avoid event flooding.
6944  * Return: %true if the frame was passed to userspace (or this failed
6945  * for a reason other than not having a subscription.)
6946  */
6947 bool cfg80211_rx_unexpected_4addr_frame(struct net_device *dev,
6948                                         const u8 *addr, gfp_t gfp);
6949 
6950 /**
6951  * cfg80211_probe_status - notify userspace about probe status
6952  * @dev: the device the probe was sent on
6953  * @addr: the address of the peer
6954  * @cookie: the cookie filled in @probe_client previously
6955  * @acked: indicates whether probe was acked or not
6956  * @ack_signal: signal strength (in dBm) of the ACK frame.
6957  * @is_valid_ack_signal: indicates the ack_signal is valid or not.
6958  * @gfp: allocation flags
6959  */
6960 void cfg80211_probe_status(struct net_device *dev, const u8 *addr,
6961                            u64 cookie, bool acked, s32 ack_signal,
6962                            bool is_valid_ack_signal, gfp_t gfp);
6963 
6964 /**
6965  * cfg80211_report_obss_beacon - report beacon from other APs
6966  * @wiphy: The wiphy that received the beacon
6967  * @frame: the frame
6968  * @len: length of the frame
6969  * @freq: frequency the frame was received on
6970  * @sig_dbm: signal strength in dBm, or 0 if unknown
6971  *
6972  * Use this function to report to userspace when a beacon was
6973  * received. It is not useful to call this when there is no
6974  * netdev that is in AP/GO mode.
6975  */
6976 void cfg80211_report_obss_beacon(struct wiphy *wiphy,
6977                                  const u8 *frame, size_t len,
6978                                  int freq, int sig_dbm);
6979 
6980 /**
6981  * cfg80211_reg_can_beacon - check if beaconing is allowed
6982  * @wiphy: the wiphy
6983  * @chandef: the channel definition
6984  * @iftype: interface type
6985  *
6986  * Return: %true if there is no secondary channel or the secondary channel(s)
6987  * can be used for beaconing (i.e. is not a radar channel etc.)
6988  */
6989 bool cfg80211_reg_can_beacon(struct wiphy *wiphy,
6990                              struct cfg80211_chan_def *chandef,
6991                              enum nl80211_iftype iftype);
6992 
6993 /**
6994  * cfg80211_reg_can_beacon_relax - check if beaconing is allowed with relaxation
6995  * @wiphy: the wiphy
6996  * @chandef: the channel definition
6997  * @iftype: interface type
6998  *
6999  * Return: %true if there is no secondary channel or the secondary channel(s)
7000  * can be used for beaconing (i.e. is not a radar channel etc.). This version
7001  * also checks if IR-relaxation conditions apply, to allow beaconing under
7002  * more permissive conditions.
7003  *
7004  * Requires the RTNL to be held.
7005  */
7006 bool cfg80211_reg_can_beacon_relax(struct wiphy *wiphy,
7007                                    struct cfg80211_chan_def *chandef,
7008                                    enum nl80211_iftype iftype);
7009 
7010 /*
7011  * cfg80211_ch_switch_notify - update wdev channel and notify userspace
7012  * @dev: the device which switched channels
7013  * @chandef: the new channel definition
7014  *
7015  * Caller must acquire wdev_lock, therefore must only be called from sleepable
7016  * driver context!
7017  */
7018 void cfg80211_ch_switch_notify(struct net_device *dev,
7019                                struct cfg80211_chan_def *chandef);
7020 
7021 /*
7022  * cfg80211_ch_switch_started_notify - notify channel switch start
7023  * @dev: the device on which the channel switch started
7024  * @chandef: the future channel definition
7025  * @count: the number of TBTTs until the channel switch happens
7026  *
7027  * Inform the userspace about the channel switch that has just
7028  * started, so that it can take appropriate actions (eg. starting
7029  * channel switch on other vifs), if necessary.
7030  */
7031 void cfg80211_ch_switch_started_notify(struct net_device *dev,
7032                                        struct cfg80211_chan_def *chandef,
7033                                        u8 count);
7034 
7035 /**
7036  * ieee80211_operating_class_to_band - convert operating class to band
7037  *
7038  * @operating_class: the operating class to convert
7039  * @band: band pointer to fill
7040  *
7041  * Returns %true if the conversion was successful, %false otherwise.
7042  */
7043 bool ieee80211_operating_class_to_band(u8 operating_class,
7044                                        enum nl80211_band *band);
7045 
7046 /**
7047  * ieee80211_chandef_to_operating_class - convert chandef to operation class
7048  *
7049  * @chandef: the chandef to convert
7050  * @op_class: a pointer to the resulting operating class
7051  *
7052  * Returns %true if the conversion was successful, %false otherwise.
7053  */
7054 bool ieee80211_chandef_to_operating_class(struct cfg80211_chan_def *chandef,
7055                                           u8 *op_class);
7056 
7057 /*
7058  * cfg80211_tdls_oper_request - request userspace to perform TDLS operation
7059  * @dev: the device on which the operation is requested
7060  * @peer: the MAC address of the peer device
7061  * @oper: the requested TDLS operation (NL80211_TDLS_SETUP or
7062  *      NL80211_TDLS_TEARDOWN)
7063  * @reason_code: the reason code for teardown request
7064  * @gfp: allocation flags
7065  *
7066  * This function is used to request userspace to perform TDLS operation that
7067  * requires knowledge of keys, i.e., link setup or teardown when the AP
7068  * connection uses encryption. This is optional mechanism for the driver to use
7069  * if it can automatically determine when a TDLS link could be useful (e.g.,
7070  * based on traffic and signal strength for a peer).
7071  */
7072 void cfg80211_tdls_oper_request(struct net_device *dev, const u8 *peer,
7073                                 enum nl80211_tdls_operation oper,
7074                                 u16 reason_code, gfp_t gfp);
7075 
7076 /*
7077  * cfg80211_calculate_bitrate - calculate actual bitrate (in 100Kbps units)
7078  * @rate: given rate_info to calculate bitrate from
7079  *
7080  * return 0 if MCS index >= 32
7081  */
7082 u32 cfg80211_calculate_bitrate(struct rate_info *rate);
7083 
7084 /**
7085  * cfg80211_unregister_wdev - remove the given wdev
7086  * @wdev: struct wireless_dev to remove
7087  *
7088  * Call this function only for wdevs that have no netdev assigned,
7089  * e.g. P2P Devices. It removes the device from the list so that
7090  * it can no longer be used. It is necessary to call this function
7091  * even when cfg80211 requests the removal of the interface by
7092  * calling the del_virtual_intf() callback. The function must also
7093  * be called when the driver wishes to unregister the wdev, e.g.
7094  * when the device is unbound from the driver.
7095  *
7096  * Requires the RTNL to be held.
7097  */
7098 void cfg80211_unregister_wdev(struct wireless_dev *wdev);
7099 
7100 /**
7101  * struct cfg80211_ft_event - FT Information Elements
7102  * @ies: FT IEs
7103  * @ies_len: length of the FT IE in bytes
7104  * @target_ap: target AP's MAC address
7105  * @ric_ies: RIC IE
7106  * @ric_ies_len: length of the RIC IE in bytes
7107  */
7108 struct cfg80211_ft_event_params {
7109         const u8 *ies;
7110         size_t ies_len;
7111         const u8 *target_ap;
7112         const u8 *ric_ies;
7113         size_t ric_ies_len;
7114 };
7115 
7116 /**
7117  * cfg80211_ft_event - notify userspace about FT IE and RIC IE
7118  * @netdev: network device
7119  * @ft_event: IE information
7120  */
7121 void cfg80211_ft_event(struct net_device *netdev,
7122                        struct cfg80211_ft_event_params *ft_event);
7123 
7124 /**
7125  * cfg80211_get_p2p_attr - find and copy a P2P attribute from IE buffer
7126  * @ies: the input IE buffer
7127  * @len: the input length
7128  * @attr: the attribute ID to find
7129  * @buf: output buffer, can be %NULL if the data isn't needed, e.g.
7130  *      if the function is only called to get the needed buffer size
7131  * @bufsize: size of the output buffer
7132  *
7133  * The function finds a given P2P attribute in the (vendor) IEs and
7134  * copies its contents to the given buffer.
7135  *
7136  * Return: A negative error code (-%EILSEQ or -%ENOENT) if the data is
7137  * malformed or the attribute can't be found (respectively), or the
7138  * length of the found attribute (which can be zero).
7139  */
7140 int cfg80211_get_p2p_attr(const u8 *ies, unsigned int len,
7141                           enum ieee80211_p2p_attr_id attr,
7142                           u8 *buf, unsigned int bufsize);
7143 
7144 /**
7145  * ieee80211_ie_split_ric - split an IE buffer according to ordering (with RIC)
7146  * @ies: the IE buffer
7147  * @ielen: the length of the IE buffer
7148  * @ids: an array with element IDs that are allowed before
7149  *      the split. A WLAN_EID_EXTENSION value means that the next
7150  *      EID in the list is a sub-element of the EXTENSION IE.
7151  * @n_ids: the size of the element ID array
7152  * @after_ric: array IE types that come after the RIC element
7153  * @n_after_ric: size of the @after_ric array
7154  * @offset: offset where to start splitting in the buffer
7155  *
7156  * This function splits an IE buffer by updating the @offset
7157  * variable to point to the location where the buffer should be
7158  * split.
7159  *
7160  * It assumes that the given IE buffer is well-formed, this
7161  * has to be guaranteed by the caller!
7162  *
7163  * It also assumes that the IEs in the buffer are ordered
7164  * correctly, if not the result of using this function will not
7165  * be ordered correctly either, i.e. it does no reordering.
7166  *
7167  * The function returns the offset where the next part of the
7168  * buffer starts, which may be @ielen if the entire (remainder)
7169  * of the buffer should be used.
7170  */
7171 size_t ieee80211_ie_split_ric(const u8 *ies, size_t ielen,
7172                               const u8 *ids, int n_ids,
7173                               const u8 *after_ric, int n_after_ric,
7174                               size_t offset);
7175 
7176 /**
7177  * ieee80211_ie_split - split an IE buffer according to ordering
7178  * @ies: the IE buffer
7179  * @ielen: the length of the IE buffer
7180  * @ids: an array with element IDs that are allowed before
7181  *      the split. A WLAN_EID_EXTENSION value means that the next
7182  *      EID in the list is a sub-element of the EXTENSION IE.
7183  * @n_ids: the size of the element ID array
7184  * @offset: offset where to start splitting in the buffer
7185  *
7186  * This function splits an IE buffer by updating the @offset
7187  * variable to point to the location where the buffer should be
7188  * split.
7189  *
7190  * It assumes that the given IE buffer is well-formed, this
7191  * has to be guaranteed by the caller!
7192  *
7193  * It also assumes that the IEs in the buffer are ordered
7194  * correctly, if not the result of using this function will not
7195  * be ordered correctly either, i.e. it does no reordering.
7196  *
7197  * The function returns the offset where the next part of the
7198  * buffer starts, which may be @ielen if the entire (remainder)
7199  * of the buffer should be used.
7200  */
7201 static inline size_t ieee80211_ie_split(const u8 *ies, size_t ielen,
7202                                         const u8 *ids, int n_ids, size_t offset)
7203 {
7204         return ieee80211_ie_split_ric(ies, ielen, ids, n_ids, NULL, 0, offset);
7205 }
7206 
7207 /**
7208  * cfg80211_report_wowlan_wakeup - report wakeup from WoWLAN
7209  * @wdev: the wireless device reporting the wakeup
7210  * @wakeup: the wakeup report
7211  * @gfp: allocation flags
7212  *
7213  * This function reports that the given device woke up. If it
7214  * caused the wakeup, report the reason(s), otherwise you may
7215  * pass %NULL as the @wakeup parameter to advertise that something
7216  * else caused the wakeup.
7217  */
7218 void cfg80211_report_wowlan_wakeup(struct wireless_dev *wdev,
7219                                    struct cfg80211_wowlan_wakeup *wakeup,
7220                                    gfp_t gfp);
7221 
7222 /**
7223  * cfg80211_crit_proto_stopped() - indicate critical protocol stopped by driver.
7224  *
7225  * @wdev: the wireless device for which critical protocol is stopped.
7226  * @gfp: allocation flags
7227  *
7228  * This function can be called by the driver to indicate it has reverted
7229  * operation back to normal. One reason could be that the duration given
7230  * by .crit_proto_start() has expired.
7231  */
7232 void cfg80211_crit_proto_stopped(struct wireless_dev *wdev, gfp_t gfp);
7233 
7234 /**
7235  * ieee80211_get_num_supported_channels - get number of channels device has
7236  * @wiphy: the wiphy
7237  *
7238  * Return: the number of channels supported by the device.
7239  */
7240 unsigned int ieee80211_get_num_supported_channels(struct wiphy *wiphy);
7241 
7242 /**
7243  * cfg80211_check_combinations - check interface combinations
7244  *
7245  * @wiphy: the wiphy
7246  * @params: the interface combinations parameter
7247  *
7248  * This function can be called by the driver to check whether a
7249  * combination of interfaces and their types are allowed according to
7250  * the interface combinations.
7251  */
7252 int cfg80211_check_combinations(struct wiphy *wiphy,
7253                                 struct iface_combination_params *params);
7254 
7255 /**
7256  * cfg80211_iter_combinations - iterate over matching combinations
7257  *
7258  * @wiphy: the wiphy
7259  * @params: the interface combinations parameter
7260  * @iter: function to call for each matching combination
7261  * @data: pointer to pass to iter function
7262  *
7263  * This function can be called by the driver to check what possible
7264  * combinations it fits in at a given moment, e.g. for channel switching
7265  * purposes.
7266  */
7267 int cfg80211_iter_combinations(struct wiphy *wiphy,
7268                                struct iface_combination_params *params,
7269                                void (*iter)(const struct ieee80211_iface_combination *c,
7270                                             void *data),
7271                                void *data);
7272 
7273 /*
7274  * cfg80211_stop_iface - trigger interface disconnection
7275  *
7276  * @wiphy: the wiphy
7277  * @wdev: wireless device
7278  * @gfp: context flags
7279  *
7280  * Trigger interface to be stopped as if AP was stopped, IBSS/mesh left, STA
7281  * disconnected.
7282  *
7283  * Note: This doesn't need any locks and is asynchronous.
7284  */
7285 void cfg80211_stop_iface(struct wiphy *wiphy, struct wireless_dev *wdev,
7286                          gfp_t gfp);
7287 
7288 /**
7289  * cfg80211_shutdown_all_interfaces - shut down all interfaces for a wiphy
7290  * @wiphy: the wiphy to shut down
7291  *
7292  * This function shuts down all interfaces belonging to this wiphy by
7293  * calling dev_close() (and treating non-netdev interfaces as needed).
7294  * It shouldn't really be used unless there are some fatal device errors
7295  * that really can't be recovered in any other way.
7296  *
7297  * Callers must hold the RTNL and be able to deal with callbacks into
7298  * the driver while the function is running.
7299  */
7300 void cfg80211_shutdown_all_interfaces(struct wiphy *wiphy);
7301 
7302 /**
7303  * wiphy_ext_feature_set - set the extended feature flag
7304  *
7305  * @wiphy: the wiphy to modify.
7306  * @ftidx: extended feature bit index.
7307  *
7308  * The extended features are flagged in multiple bytes (see
7309  * &struct wiphy.@ext_features)
7310  */
7311 static inline void wiphy_ext_feature_set(struct wiphy *wiphy,
7312                                          enum nl80211_ext_feature_index ftidx)
7313 {
7314         u8 *ft_byte;
7315 
7316         ft_byte = &wiphy->ext_features[ftidx / 8];
7317         *ft_byte |= BIT(ftidx % 8);
7318 }
7319 
7320 /**
7321  * wiphy_ext_feature_isset - check the extended feature flag
7322  *
7323  * @wiphy: the wiphy to modify.
7324  * @ftidx: extended feature bit index.
7325  *
7326  * The extended features are flagged in multiple bytes (see
7327  * &struct wiphy.@ext_features)
7328  */
7329 static inline bool
7330 wiphy_ext_feature_isset(struct wiphy *wiphy,
7331                         enum nl80211_ext_feature_index ftidx)
7332 {
7333         u8 ft_byte;
7334 
7335         ft_byte = wiphy->ext_features[ftidx / 8];
7336         return (ft_byte & BIT(ftidx % 8)) != 0;
7337 }
7338 
7339 /**
7340  * cfg80211_free_nan_func - free NAN function
7341  * @f: NAN function that should be freed
7342  *
7343  * Frees all the NAN function and all it's allocated members.
7344  */
7345 void cfg80211_free_nan_func(struct cfg80211_nan_func *f);
7346 
7347 /**
7348  * struct cfg80211_nan_match_params - NAN match parameters
7349  * @type: the type of the function that triggered a match. If it is
7350  *       %NL80211_NAN_FUNC_SUBSCRIBE it means that we replied to a subscriber.
7351  *       If it is %NL80211_NAN_FUNC_PUBLISH, it means that we got a discovery
7352  *       result.
7353  *       If it is %NL80211_NAN_FUNC_FOLLOW_UP, we received a follow up.
7354  * @inst_id: the local instance id
7355  * @peer_inst_id: the instance id of the peer's function
7356  * @addr: the MAC address of the peer
7357  * @info_len: the length of the &info
7358  * @info: the Service Specific Info from the peer (if any)
7359  * @cookie: unique identifier of the corresponding function
7360  */
7361 struct cfg80211_nan_match_params {
7362         enum nl80211_nan_function_type type;
7363         u8 inst_id;
7364         u8 peer_inst_id;
7365         const u8 *addr;
7366         u8 info_len;
7367         const u8 *info;
7368         u64 cookie;
7369 };
7370 
7371 /**
7372  * cfg80211_nan_match - report a match for a NAN function.
7373  * @wdev: the wireless device reporting the match
7374  * @match: match notification parameters
7375  * @gfp: allocation flags
7376  *
7377  * This function reports that the a NAN function had a match. This
7378  * can be a subscribe that had a match or a solicited publish that
7379  * was sent. It can also be a follow up that was received.
7380  */
7381 void cfg80211_nan_match(struct wireless_dev *wdev,
7382                         struct cfg80211_nan_match_params *match, gfp_t gfp);
7383 
7384 /**
7385  * cfg80211_nan_func_terminated - notify about NAN function termination.
7386  *
7387  * @wdev: the wireless device reporting the match
7388  * @inst_id: the local instance id
7389  * @reason: termination reason (one of the NL80211_NAN_FUNC_TERM_REASON_*)
7390  * @cookie: unique NAN function identifier
7391  * @gfp: allocation flags
7392  *
7393  * This function reports that the a NAN function is terminated.
7394  */
7395 void cfg80211_nan_func_terminated(struct wireless_dev *wdev,
7396                                   u8 inst_id,
7397                                   enum nl80211_nan_func_term_reason reason,
7398                                   u64 cookie, gfp_t gfp);
7399 
7400 /* ethtool helper */
7401 void cfg80211_get_drvinfo(struct net_device *dev, struct ethtool_drvinfo *info);
7402 
7403 /**
7404  * cfg80211_external_auth_request - userspace request for authentication
7405  * @netdev: network device
7406  * @params: External authentication parameters
7407  * @gfp: allocation flags
7408  * Returns: 0 on success, < 0 on error
7409  */
7410 int cfg80211_external_auth_request(struct net_device *netdev,
7411                                    struct cfg80211_external_auth_params *params,
7412                                    gfp_t gfp);
7413 
7414 /**
7415  * cfg80211_pmsr_report - report peer measurement result data
7416  * @wdev: the wireless device reporting the measurement
7417  * @req: the original measurement request
7418  * @result: the result data
7419  * @gfp: allocation flags
7420  */
7421 void cfg80211_pmsr_report(struct wireless_dev *wdev,
7422                           struct cfg80211_pmsr_request *req,
7423                           struct cfg80211_pmsr_result *result,
7424                           gfp_t gfp);
7425 
7426 /**
7427  * cfg80211_pmsr_complete - report peer measurement completed
7428  * @wdev: the wireless device reporting the measurement
7429  * @req: the original measurement request
7430  * @gfp: allocation flags
7431  *
7432  * Report that the entire measurement completed, after this
7433  * the request pointer will no longer be valid.
7434  */
7435 void cfg80211_pmsr_complete(struct wireless_dev *wdev,
7436                             struct cfg80211_pmsr_request *req,
7437                             gfp_t gfp);
7438 
7439 /**
7440  * cfg80211_iftype_allowed - check whether the interface can be allowed
7441  * @wiphy: the wiphy
7442  * @iftype: interface type
7443  * @is_4addr: use_4addr flag, must be '0' when check_swif is '1'
7444  * @check_swif: check iftype against software interfaces
7445  *
7446  * Check whether the interface is allowed to operate; additionally, this API
7447  * can be used to check iftype against the software interfaces when
7448  * check_swif is '1'.
7449  */
7450 bool cfg80211_iftype_allowed(struct wiphy *wiphy, enum nl80211_iftype iftype,
7451                              bool is_4addr, u8 check_swif);
7452 
7453 
7454 /* Logging, debugging and troubleshooting/diagnostic helpers. */
7455 
7456 /* wiphy_printk helpers, similar to dev_printk */
7457 
7458 #define wiphy_printk(level, wiphy, format, args...)             \
7459         dev_printk(level, &(wiphy)->dev, format, ##args)
7460 #define wiphy_emerg(wiphy, format, args...)                     \
7461         dev_emerg(&(wiphy)->dev, format, ##args)
7462 #define wiphy_alert(wiphy, format, args...)                     \
7463         dev_alert(&(wiphy)->dev, format, ##args)
7464 #define wiphy_crit(wiphy, format, args...)                      \
7465         dev_crit(&(wiphy)->dev, format, ##args)
7466 #define wiphy_err(wiphy, format, args...)                       \
7467         dev_err(&(wiphy)->dev, format, ##args)
7468 #define wiphy_warn(wiphy, format, args...)                      \
7469         dev_warn(&(wiphy)->dev, format, ##args)
7470 #define wiphy_notice(wiphy, format, args...)                    \
7471         dev_notice(&(wiphy)->dev, format, ##args)
7472 #define wiphy_info(wiphy, format, args...)                      \
7473         dev_info(&(wiphy)->dev, format, ##args)
7474 
7475 #define wiphy_err_ratelimited(wiphy, format, args...)           \
7476         dev_err_ratelimited(&(wiphy)->dev, format, ##args)
7477 #define wiphy_warn_ratelimited(wiphy, format, args...)          \
7478         dev_warn_ratelimited(&(wiphy)->dev, format, ##args)
7479 
7480 #define wiphy_debug(wiphy, format, args...)                     \
7481         wiphy_printk(KERN_DEBUG, wiphy, format, ##args)
7482 
7483 #define wiphy_dbg(wiphy, format, args...)                       \
7484         dev_dbg(&(wiphy)->dev, format, ##args)
7485 
7486 #if defined(VERBOSE_DEBUG)
7487 #define wiphy_vdbg      wiphy_dbg
7488 #else
7489 #define wiphy_vdbg(wiphy, format, args...)                              \
7490 ({                                                                      \
7491         if (0)                                                          \
7492                 wiphy_printk(KERN_DEBUG, wiphy, format, ##args);        \
7493         0;                                                              \
7494 })
7495 #endif
7496 
7497 /*
7498  * wiphy_WARN() acts like wiphy_printk(), but with the key difference
7499  * of using a WARN/WARN_ON to get the message out, including the
7500  * file/line information and a backtrace.
7501  */
7502 #define wiphy_WARN(wiphy, format, args...)                      \
7503         WARN(1, "wiphy: %s\n" format, wiphy_name(wiphy), ##args);
7504 
7505 /**
7506  * cfg80211_update_owe_info_event - Notify the peer's OWE info to user space
7507  * @netdev: network device
7508  * @owe_info: peer's owe info
7509  * @gfp: allocation flags
7510  */
7511 void cfg80211_update_owe_info_event(struct net_device *netdev,
7512                                     struct cfg80211_update_owe_info *owe_info,
7513                                     gfp_t gfp);
7514 
7515 #endif /* __NET_CFG80211_H */

/* [<][>][^][v][top][bottom][index][help] */