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